From a92a46767b22c0e1fa478e0256c48320663d9d11 Mon Sep 17 00:00:00 2001 From: Jason Del Ponte Date: Thu, 1 Oct 2020 13:04:13 -0700 Subject: [PATCH] regenerate apis --- .../awsrestjson/api_op_AllQueryStringTypes.go | 30 +- .../awsrestjson/api_op_HttpPayloadTraits.go | 8 +- .../api_op_HttpPayloadTraitsWithMediaType.go | 8 +- ...api_op_HttpRequestWithGreedyLabelInPath.go | 4 +- .../api_op_HttpRequestWithLabels.go | 19 +- ...HttpRequestWithLabelsAndTimestampFormat.go | 10 +- .../awsrestjson/api_op_InlineDocument.go | 8 +- .../api_op_InputAndOutputWithHeaders.go | 56 +- .../awsrestjson/api_op_JsonEnums.go | 8 +- .../awsrestjson/api_op_JsonLists.go | 30 +- .../awsrestjson/api_op_JsonTimestamps.go | 8 +- .../api_op_OmitsNullSerializesEmptyString.go | 4 +- .../api_op_SimpleScalarProperties.go | 32 +- .../awsrestjson/api_op_StreamingTraits.go | 8 +- .../api_op_StreamingTraitsRequireLength.go | 8 +- .../api_op_StreamingTraitsWithMediaType.go | 8 +- .../api_op_TimestampFormatHeaders.go | 20 +- internal/protocoltest/awsrestjson/go.mod | 2 +- .../ec2query/api_op_QueryLists.go | 6 +- .../ec2query/api_op_QueryTimestamps.go | 4 +- .../ec2query/api_op_SimpleInputParams.go | 10 +- .../api_op_SimpleScalarXmlProperties.go | 16 +- .../ec2query/api_op_XmlEmptyLists.go | 18 +- .../protocoltest/ec2query/api_op_XmlEnums.go | 4 +- .../protocoltest/ec2query/api_op_XmlLists.go | 18 +- .../ec2query/api_op_XmlTimestamps.go | 4 +- internal/protocoltest/ec2query/go.mod | 2 +- internal/protocoltest/ec2query/types/types.go | 4 +- .../protocoltest/jsonrpc/api_op_JsonEnums.go | 8 +- .../jsonrpc/api_op_NullOperation.go | 8 +- internal/protocoltest/jsonrpc/go.mod | 2 +- internal/protocoltest/jsonrpc10/go.mod | 2 +- .../protocoltest/query/api_op_QueryLists.go | 8 +- .../protocoltest/query/api_op_QueryMaps.go | 12 +- .../query/api_op_QueryTimestamps.go | 4 +- .../query/api_op_SimpleInputParams.go | 8 +- .../query/api_op_SimpleScalarXmlProperties.go | 16 +- .../query/api_op_XmlEmptyLists.go | 18 +- .../protocoltest/query/api_op_XmlEnums.go | 4 +- .../protocoltest/query/api_op_XmlLists.go | 18 +- .../query/api_op_XmlTimestamps.go | 4 +- internal/protocoltest/query/go.mod | 2 +- internal/protocoltest/query/types/types.go | 4 +- .../restxml/api_op_AllQueryStringTypes.go | 30 +- .../restxml/api_op_HttpPayloadTraits.go | 8 +- .../api_op_HttpPayloadTraitsWithMediaType.go | 8 +- ...api_op_HttpRequestWithGreedyLabelInPath.go | 4 +- .../restxml/api_op_HttpRequestWithLabels.go | 19 +- ...HttpRequestWithLabelsAndTimestampFormat.go | 10 +- .../api_op_InputAndOutputWithHeaders.go | 56 +- .../api_op_OmitsNullSerializesEmptyString.go | 4 +- .../restxml/api_op_SimpleScalarProperties.go | 32 +- .../restxml/api_op_TimestampFormatHeaders.go | 20 +- .../restxml/api_op_XmlAttributes.go | 8 +- .../restxml/api_op_XmlEmptyLists.go | 36 +- .../protocoltest/restxml/api_op_XmlEnums.go | 8 +- .../protocoltest/restxml/api_op_XmlLists.go | 36 +- .../restxml/api_op_XmlTimestamps.go | 8 +- internal/protocoltest/restxml/go.mod | 2 +- internal/protocoltest/restxml/types/types.go | 4 +- .../accessanalyzer/api_op_CreateAnalyzer.go | 6 +- .../api_op_CreateArchiveRule.go | 8 +- .../api_op_ListAnalyzedResources.go | 8 +- .../accessanalyzer/api_op_ListAnalyzers.go | 6 +- .../accessanalyzer/api_op_ListArchiveRules.go | 6 +- service/accessanalyzer/api_op_ListFindings.go | 8 +- .../api_op_UpdateArchiveRule.go | 10 +- .../accessanalyzer/api_op_UpdateFindings.go | 6 +- service/accessanalyzer/go.mod | 2 +- service/accessanalyzer/types/types.go | 224 +- service/acm/api_op_AddTagsToCertificate.go | 10 +- service/acm/api_op_ExportCertificate.go | 8 +- service/acm/api_op_GetCertificate.go | 6 +- service/acm/api_op_ImportCertificate.go | 24 +- service/acm/api_op_ListCertificates.go | 18 +- service/acm/api_op_RequestCertificate.go | 64 +- service/acm/api_op_ResendValidationEmail.go | 34 +- .../acm/api_op_UpdateCertificateOptions.go | 12 +- service/acm/go.mod | 2 +- service/acm/types/types.go | 210 +- .../api_op_CreateCertificateAuthority.go | 24 +- ...p_CreateCertificateAuthorityAuditReport.go | 10 +- service/acmpca/api_op_CreatePermission.go | 18 +- .../api_op_DeleteCertificateAuthority.go | 8 +- service/acmpca/api_op_DeletePermission.go | 6 +- ...DescribeCertificateAuthorityAuditReport.go | 6 +- service/acmpca/api_op_GetCertificate.go | 6 +- ...i_op_GetCertificateAuthorityCertificate.go | 6 +- ...p_ImportCertificateAuthorityCertificate.go | 26 +- service/acmpca/api_op_IssueCertificate.go | 38 +- .../api_op_ListCertificateAuthorities.go | 6 +- service/acmpca/api_op_ListPermissions.go | 30 +- service/acmpca/api_op_ListTags.go | 14 +- service/acmpca/api_op_RevokeCertificate.go | 10 +- .../api_op_UpdateCertificateAuthority.go | 12 +- service/acmpca/go.mod | 2 +- service/acmpca/types/types.go | 128 +- ...pi_op_AssociateDeviceWithNetworkProfile.go | 8 +- .../api_op_AssociateDeviceWithRoom.go | 6 +- .../api_op_AssociateSkillGroupWithRoom.go | 6 +- .../api_op_AssociateSkillWithSkillGroup.go | 6 +- .../api_op_CreateAddressBook.go | 12 +- .../api_op_CreateBusinessReportSchedule.go | 28 +- .../api_op_CreateConferenceProvider.go | 28 +- .../alexaforbusiness/api_op_CreateContact.go | 10 +- .../api_op_CreateGatewayGroup.go | 12 +- .../api_op_CreateNetworkProfile.go | 50 +- .../alexaforbusiness/api_op_CreateProfile.go | 46 +- service/alexaforbusiness/api_op_CreateRoom.go | 10 +- .../api_op_CreateSkillGroup.go | 6 +- service/alexaforbusiness/api_op_CreateUser.go | 12 +- .../api_op_DeleteRoomSkillParameter.go | 8 +- .../api_op_DisassociateSkillGroupFromRoom.go | 6 +- .../api_op_GetInvitationConfiguration.go | 6 +- .../api_op_ListBusinessReportSchedules.go | 6 +- .../api_op_ListConferenceProviders.go | 12 +- .../api_op_ListDeviceEvents.go | 16 +- .../api_op_ListGatewayGroups.go | 12 +- .../alexaforbusiness/api_op_ListGateways.go | 6 +- service/alexaforbusiness/api_op_ListSkills.go | 20 +- .../api_op_ListSkillsStoreSkillsByCategory.go | 12 +- .../api_op_ListSmartHomeAppliances.go | 18 +- service/alexaforbusiness/api_op_ListTags.go | 22 +- .../api_op_PutInvitationConfiguration.go | 8 +- .../api_op_PutRoomSkillParameter.go | 6 +- .../api_op_PutSkillAuthorization.go | 12 +- .../api_op_RegisterAVSDevice.go | 16 +- .../alexaforbusiness/api_op_ResolveRoom.go | 6 +- .../api_op_SearchAddressBooks.go | 24 +- .../alexaforbusiness/api_op_SearchContacts.go | 22 +- .../alexaforbusiness/api_op_SearchDevices.go | 20 +- .../api_op_SearchNetworkProfiles.go | 24 +- .../alexaforbusiness/api_op_SearchProfiles.go | 14 +- .../alexaforbusiness/api_op_SearchRooms.go | 14 +- .../api_op_SearchSkillGroups.go | 22 +- .../alexaforbusiness/api_op_SearchUsers.go | 24 +- .../api_op_SendAnnouncement.go | 16 +- .../api_op_StartDeviceSync.go | 12 +- .../alexaforbusiness/api_op_UntagResource.go | 10 +- .../api_op_UpdateAddressBook.go | 12 +- .../api_op_UpdateBusinessReportSchedule.go | 10 +- .../api_op_UpdateConferenceProvider.go | 12 +- .../alexaforbusiness/api_op_UpdateContact.go | 24 +- .../alexaforbusiness/api_op_UpdateGateway.go | 10 +- .../api_op_UpdateGatewayGroup.go | 6 +- .../api_op_UpdateNetworkProfile.go | 32 +- .../alexaforbusiness/api_op_UpdateProfile.go | 38 +- service/alexaforbusiness/api_op_UpdateRoom.go | 6 +- .../api_op_UpdateSkillGroup.go | 8 +- service/alexaforbusiness/go.mod | 2 +- service/alexaforbusiness/types/types.go | 626 +- service/amplify/api_op_CreateApp.go | 72 +- .../api_op_CreateBackendEnvironment.go | 12 +- service/amplify/api_op_CreateBranch.go | 62 +- service/amplify/api_op_CreateDeployment.go | 16 +- .../amplify/api_op_CreateDomainAssociation.go | 20 +- service/amplify/api_op_CreateWebhook.go | 12 +- .../amplify/api_op_DeleteDomainAssociation.go | 8 +- service/amplify/api_op_DeleteJob.go | 8 +- service/amplify/api_op_GenerateAccessLogs.go | 14 +- service/amplify/api_op_GetArtifactUrl.go | 8 +- service/amplify/api_op_GetBranch.go | 8 +- .../amplify/api_op_GetDomainAssociation.go | 8 +- service/amplify/api_op_GetJob.go | 10 +- service/amplify/api_op_ListApps.go | 10 +- service/amplify/api_op_ListArtifacts.go | 20 +- .../amplify/api_op_ListBackendEnvironments.go | 6 +- service/amplify/api_op_ListBranches.go | 14 +- .../amplify/api_op_ListDomainAssociations.go | 24 +- service/amplify/api_op_ListJobs.go | 8 +- service/amplify/api_op_StartDeployment.go | 16 +- service/amplify/api_op_StartJob.go | 26 +- service/amplify/api_op_StopJob.go | 10 +- service/amplify/api_op_UntagResource.go | 8 +- service/amplify/api_op_UpdateApp.go | 76 +- service/amplify/api_op_UpdateBranch.go | 52 +- .../amplify/api_op_UpdateDomainAssociation.go | 28 +- service/amplify/api_op_UpdateWebhook.go | 10 +- service/amplify/go.mod | 2 +- service/amplify/types/types.go | 422 +- service/apigateway/api_op_CreateApiKey.go | 61 +- service/apigateway/api_op_CreateAuthorizer.go | 135 +- .../api_op_CreateBasePathMapping.go | 31 +- service/apigateway/api_op_CreateDeployment.go | 53 +- .../api_op_CreateDocumentationPart.go | 25 +- .../api_op_CreateDocumentationVersion.go | 27 +- service/apigateway/api_op_CreateDomainName.go | 133 +- service/apigateway/api_op_CreateModel.go | 36 +- .../api_op_CreateRequestValidator.go | 17 +- service/apigateway/api_op_CreateResource.go | 35 +- service/apigateway/api_op_CreateRestApi.go | 85 +- service/apigateway/api_op_CreateStage.go | 127 +- service/apigateway/api_op_CreateUsagePlan.go | 40 +- .../apigateway/api_op_CreateUsagePlanKey.go | 39 +- service/apigateway/api_op_CreateVpcLink.go | 32 +- service/apigateway/api_op_DeleteApiKey.go | 9 +- service/apigateway/api_op_DeleteAuthorizer.go | 7 +- .../api_op_DeleteBasePathMapping.go | 19 +- .../api_op_DeleteClientCertificate.go | 7 +- service/apigateway/api_op_DeleteDeployment.go | 11 +- .../api_op_DeleteDocumentationPart.go | 14 +- .../api_op_DeleteDocumentationVersion.go | 9 +- service/apigateway/api_op_DeleteDomainName.go | 13 +- .../api_op_DeleteGatewayResponse.go | 18 +- .../apigateway/api_op_DeleteIntegration.go | 17 +- .../api_op_DeleteIntegrationResponse.go | 19 +- service/apigateway/api_op_DeleteMethod.go | 23 +- .../apigateway/api_op_DeleteMethodResponse.go | 17 +- service/apigateway/api_op_DeleteModel.go | 16 +- .../api_op_DeleteRequestValidator.go | 17 +- service/apigateway/api_op_DeleteResource.go | 13 +- service/apigateway/api_op_DeleteRestApi.go | 6 +- service/apigateway/api_op_DeleteStage.go | 15 +- service/apigateway/api_op_DeleteUsagePlan.go | 3 +- .../apigateway/api_op_DeleteUsagePlanKey.go | 12 +- service/apigateway/api_op_DeleteVpcLink.go | 15 +- .../api_op_FlushStageAuthorizersCache.go | 15 +- service/apigateway/api_op_FlushStageCache.go | 14 +- .../api_op_GenerateClientCertificate.go | 33 +- service/apigateway/api_op_GetAccount.go | 16 +- service/apigateway/api_op_GetApiKey.go | 40 +- service/apigateway/api_op_GetApiKeys.go | 32 +- service/apigateway/api_op_GetAuthorizer.go | 85 +- service/apigateway/api_op_GetAuthorizers.go | 17 +- .../apigateway/api_op_GetBasePathMapping.go | 20 +- .../apigateway/api_op_GetBasePathMappings.go | 16 +- .../apigateway/api_op_GetClientCertificate.go | 29 +- .../api_op_GetClientCertificates.go | 11 +- service/apigateway/api_op_GetDeployment.go | 37 +- service/apigateway/api_op_GetDeployments.go | 8 +- .../apigateway/api_op_GetDocumentationPart.go | 8 +- .../api_op_GetDocumentationParts.go | 37 +- .../api_op_GetDocumentationVersion.go | 22 +- .../api_op_GetDocumentationVersions.go | 12 +- service/apigateway/api_op_GetDomainName.go | 77 +- service/apigateway/api_op_GetDomainNames.go | 8 +- service/apigateway/api_op_GetExport.go | 42 +- .../apigateway/api_op_GetGatewayResponse.go | 33 +- .../apigateway/api_op_GetGatewayResponses.go | 18 +- service/apigateway/api_op_GetIntegration.go | 262 +- .../api_op_GetIntegrationResponse.go | 56 +- service/apigateway/api_op_GetMethod.go | 145 +- .../apigateway/api_op_GetMethodResponse.go | 30 +- service/apigateway/api_op_GetModel.go | 28 +- service/apigateway/api_op_GetModelTemplate.go | 8 +- service/apigateway/api_op_GetModels.go | 16 +- .../apigateway/api_op_GetRequestValidator.go | 18 +- .../apigateway/api_op_GetRequestValidators.go | 17 +- service/apigateway/api_op_GetResource.go | 36 +- service/apigateway/api_op_GetResources.go | 17 +- service/apigateway/api_op_GetRestApi.go | 69 +- service/apigateway/api_op_GetRestApis.go | 9 +- service/apigateway/api_op_GetSdk.go | 20 +- service/apigateway/api_op_GetSdkType.go | 19 +- service/apigateway/api_op_GetSdkTypes.go | 7 +- service/apigateway/api_op_GetStage.go | 82 +- service/apigateway/api_op_GetStages.go | 14 +- service/apigateway/api_op_GetTags.go | 19 +- service/apigateway/api_op_GetUsage.go | 30 +- service/apigateway/api_op_GetUsagePlan.go | 22 +- service/apigateway/api_op_GetUsagePlanKey.go | 27 +- service/apigateway/api_op_GetUsagePlanKeys.go | 23 +- service/apigateway/api_op_GetUsagePlans.go | 19 +- service/apigateway/api_op_GetVpcLink.go | 23 +- service/apigateway/api_op_GetVpcLinks.go | 15 +- service/apigateway/api_op_ImportApiKeys.go | 11 +- .../api_op_ImportDocumentationParts.go | 15 +- service/apigateway/api_op_ImportRestApi.go | 58 +- .../apigateway/api_op_PutGatewayResponse.go | 42 +- service/apigateway/api_op_PutIntegration.go | 334 +- .../api_op_PutIntegrationResponse.go | 72 +- service/apigateway/api_op_PutMethod.go | 190 +- .../apigateway/api_op_PutMethodResponse.go | 37 +- service/apigateway/api_op_PutRestApi.go | 87 +- service/apigateway/api_op_TagResource.go | 15 +- .../apigateway/api_op_TestInvokeAuthorizer.go | 67 +- service/apigateway/api_op_TestInvokeMethod.go | 46 +- service/apigateway/api_op_UntagResource.go | 17 +- service/apigateway/api_op_UpdateAccount.go | 24 +- service/apigateway/api_op_UpdateApiKey.go | 41 +- service/apigateway/api_op_UpdateAuthorizer.go | 96 +- .../api_op_UpdateBasePathMapping.go | 18 +- .../api_op_UpdateClientCertificate.go | 29 +- service/apigateway/api_op_UpdateDeployment.go | 22 +- .../api_op_UpdateDocumentationPart.go | 15 +- .../api_op_UpdateDocumentationVersion.go | 17 +- service/apigateway/api_op_UpdateDomainName.go | 79 +- .../api_op_UpdateGatewayResponse.go | 41 +- .../apigateway/api_op_UpdateIntegration.go | 260 +- .../api_op_UpdateIntegrationResponse.go | 57 +- service/apigateway/api_op_UpdateMethod.go | 147 +- .../apigateway/api_op_UpdateMethodResponse.go | 31 +- service/apigateway/api_op_UpdateModel.go | 26 +- .../api_op_UpdateRequestValidator.go | 27 +- service/apigateway/api_op_UpdateResource.go | 29 +- service/apigateway/api_op_UpdateRestApi.go | 69 +- service/apigateway/api_op_UpdateStage.go | 89 +- service/apigateway/api_op_UpdateUsage.go | 34 +- service/apigateway/api_op_UpdateUsagePlan.go | 28 +- service/apigateway/api_op_UpdateVpcLink.go | 31 +- service/apigateway/go.mod | 2 +- service/apigateway/types/types.go | 1056 +-- .../api_op_GetConnection.go | 3 +- service/apigatewaymanagementapi/go.mod | 2 +- service/apigatewayv2/api_op_CreateApi.go | 116 +- .../apigatewayv2/api_op_CreateApiMapping.go | 22 +- .../apigatewayv2/api_op_CreateAuthorizer.go | 62 +- .../apigatewayv2/api_op_CreateDeployment.go | 18 +- .../apigatewayv2/api_op_CreateDomainName.go | 14 +- .../apigatewayv2/api_op_CreateIntegration.go | 268 +- .../api_op_CreateIntegrationResponse.go | 56 +- service/apigatewayv2/api_op_CreateModel.go | 26 +- service/apigatewayv2/api_op_CreateRoute.go | 104 +- .../api_op_CreateRouteResponse.go | 36 +- service/apigatewayv2/api_op_CreateStage.go | 92 +- service/apigatewayv2/api_op_CreateVpcLink.go | 30 +- .../api_op_DeleteAccessLogSettings.go | 10 +- .../apigatewayv2/api_op_DeleteApiMapping.go | 8 +- .../api_op_DeleteIntegrationResponse.go | 10 +- service/apigatewayv2/api_op_DeleteModel.go | 8 +- .../api_op_DeleteRouteRequestParameter.go | 8 +- .../api_op_DeleteRouteResponse.go | 10 +- .../api_op_DeleteRouteSettings.go | 10 +- service/apigatewayv2/api_op_DeleteStage.go | 10 +- service/apigatewayv2/api_op_ExportApi.go | 28 +- service/apigatewayv2/api_op_GetApi.go | 66 +- service/apigatewayv2/api_op_GetApiMapping.go | 14 +- service/apigatewayv2/api_op_GetApiMappings.go | 14 +- service/apigatewayv2/api_op_GetApis.go | 6 +- service/apigatewayv2/api_op_GetAuthorizer.go | 42 +- service/apigatewayv2/api_op_GetAuthorizers.go | 16 +- service/apigatewayv2/api_op_GetDeployment.go | 18 +- service/apigatewayv2/api_op_GetDeployments.go | 18 +- service/apigatewayv2/api_op_GetDomainName.go | 14 +- service/apigatewayv2/api_op_GetDomainNames.go | 6 +- service/apigatewayv2/api_op_GetIntegration.go | 158 +- .../api_op_GetIntegrationResponse.go | 34 +- .../api_op_GetIntegrationResponses.go | 20 +- .../apigatewayv2/api_op_GetIntegrations.go | 12 +- service/apigatewayv2/api_op_GetModel.go | 14 +- service/apigatewayv2/api_op_GetModels.go | 10 +- service/apigatewayv2/api_op_GetRoute.go | 52 +- .../apigatewayv2/api_op_GetRouteResponse.go | 16 +- .../apigatewayv2/api_op_GetRouteResponses.go | 14 +- service/apigatewayv2/api_op_GetRoutes.go | 6 +- service/apigatewayv2/api_op_GetStage.go | 40 +- service/apigatewayv2/api_op_GetStages.go | 6 +- service/apigatewayv2/api_op_GetVpcLink.go | 20 +- service/apigatewayv2/api_op_ImportApi.go | 70 +- service/apigatewayv2/api_op_ReimportApi.go | 76 +- service/apigatewayv2/api_op_UntagResource.go | 8 +- service/apigatewayv2/api_op_UpdateApi.go | 98 +- .../apigatewayv2/api_op_UpdateApiMapping.go | 24 +- .../apigatewayv2/api_op_UpdateAuthorizer.go | 106 +- .../apigatewayv2/api_op_UpdateDeployment.go | 26 +- .../apigatewayv2/api_op_UpdateDomainName.go | 16 +- .../apigatewayv2/api_op_UpdateIntegration.go | 210 +- .../api_op_UpdateIntegrationResponse.go | 68 +- service/apigatewayv2/api_op_UpdateModel.go | 26 +- service/apigatewayv2/api_op_UpdateRoute.go | 116 +- .../api_op_UpdateRouteResponse.go | 36 +- service/apigatewayv2/api_op_UpdateStage.go | 86 +- service/apigatewayv2/api_op_UpdateVpcLink.go | 26 +- service/apigatewayv2/go.mod | 2 +- service/apigatewayv2/types/types.go | 550 +- service/appconfig/api_op_CreateApplication.go | 14 +- .../api_op_CreateConfigurationProfile.go | 62 +- .../api_op_CreateDeploymentStrategy.go | 54 +- service/appconfig/api_op_CreateEnvironment.go | 42 +- ...api_op_CreateHostedConfigurationVersion.go | 50 +- service/appconfig/api_op_DeleteEnvironment.go | 8 +- ...api_op_DeleteHostedConfigurationVersion.go | 8 +- service/appconfig/api_op_GetApplication.go | 8 +- service/appconfig/api_op_GetConfiguration.go | 26 +- .../api_op_GetConfigurationProfile.go | 32 +- service/appconfig/api_op_GetDeployment.go | 70 +- .../appconfig/api_op_GetDeploymentStrategy.go | 24 +- service/appconfig/api_op_GetEnvironment.go | 22 +- .../api_op_GetHostedConfigurationVersion.go | 26 +- service/appconfig/api_op_ListApplications.go | 6 +- .../api_op_ListConfigurationProfiles.go | 16 +- .../api_op_ListDeploymentStrategies.go | 12 +- service/appconfig/api_op_ListDeployments.go | 20 +- .../api_op_ListHostedConfigurationVersions.go | 20 +- service/appconfig/api_op_StartDeployment.go | 74 +- service/appconfig/api_op_StopDeployment.go | 68 +- service/appconfig/api_op_UntagResource.go | 8 +- service/appconfig/api_op_UpdateApplication.go | 18 +- .../api_op_UpdateConfigurationProfile.go | 36 +- .../api_op_UpdateDeploymentStrategy.go | 52 +- service/appconfig/api_op_UpdateEnvironment.go | 34 +- service/appconfig/go.mod | 2 +- service/appconfig/types/types.go | 118 +- .../api_op_DeleteScalingPolicy.go | 10 +- .../api_op_DeleteScheduledAction.go | 132 +- .../api_op_DeregisterScalableTarget.go | 122 +- .../api_op_DescribeScalableTargets.go | 12 +- .../api_op_DescribeScalingActivities.go | 40 +- .../api_op_DescribeScalingPolicies.go | 130 +- .../api_op_DescribeScheduledActions.go | 154 +- .../api_op_PutScalingPolicy.go | 48 +- .../api_op_PutScheduledAction.go | 48 +- .../api_op_RegisterScalableTarget.go | 106 +- service/applicationautoscaling/go.mod | 2 +- service/applicationautoscaling/types/types.go | 670 +- .../api_op_DeleteTags.go | 10 +- .../api_op_DescribeAgents.go | 10 +- .../api_op_DescribeContinuousExports.go | 6 +- .../api_op_DescribeExportConfigurations.go | 12 +- .../api_op_DescribeExportTasks.go | 16 +- .../api_op_DescribeImportTasks.go | 18 +- .../api_op_GetDiscoverySummary.go | 20 +- .../api_op_ListConfigurations.go | 32 +- .../api_op_ListServerNeighbors.go | 26 +- .../api_op_StartContinuousExport.go | 14 +- .../api_op_StartExportTask.go | 16 +- .../api_op_StartImportTask.go | 14 +- .../api_op_UpdateApplication.go | 12 +- service/applicationdiscoveryservice/go.mod | 2 +- .../types/types.go | 326 +- .../api_op_CreateApplication.go | 20 +- .../api_op_CreateComponent.go | 10 +- .../api_op_CreateLogPattern.go | 22 +- .../api_op_DeleteComponent.go | 8 +- .../api_op_DeleteLogPattern.go | 8 +- .../api_op_DescribeComponent.go | 8 +- .../api_op_DescribeComponentConfiguration.go | 12 +- ...ibeComponentConfigurationRecommendation.go | 10 +- .../api_op_DescribeLogPattern.go | 8 +- .../api_op_ListApplications.go | 12 +- .../api_op_ListComponents.go | 14 +- .../api_op_ListConfigurationHistory.go | 18 +- .../api_op_ListLogPatternSets.go | 14 +- .../api_op_ListLogPatterns.go | 12 +- .../api_op_ListProblems.go | 26 +- .../api_op_UpdateApplication.go | 16 +- .../api_op_UpdateComponent.go | 12 +- .../api_op_UpdateComponentConfiguration.go | 14 +- .../api_op_UpdateLogPattern.go | 18 +- service/applicationinsights/go.mod | 2 +- service/applicationinsights/types/types.go | 206 +- service/appmesh/api_op_CreateGatewayRoute.go | 22 +- service/appmesh/api_op_CreateMesh.go | 8 +- service/appmesh/api_op_CreateRoute.go | 26 +- .../appmesh/api_op_CreateVirtualGateway.go | 20 +- service/appmesh/api_op_CreateVirtualNode.go | 20 +- service/appmesh/api_op_CreateVirtualRouter.go | 20 +- .../appmesh/api_op_CreateVirtualService.go | 20 +- service/appmesh/api_op_DeleteRoute.go | 8 +- .../appmesh/api_op_DeleteVirtualGateway.go | 8 +- service/appmesh/api_op_DeleteVirtualNode.go | 8 +- service/appmesh/api_op_DeleteVirtualRouter.go | 8 +- .../appmesh/api_op_DeleteVirtualService.go | 8 +- service/appmesh/api_op_DescribeRoute.go | 14 +- .../appmesh/api_op_DescribeVirtualGateway.go | 8 +- service/appmesh/api_op_DescribeVirtualNode.go | 8 +- .../appmesh/api_op_DescribeVirtualRouter.go | 8 +- .../appmesh/api_op_DescribeVirtualService.go | 8 +- service/appmesh/api_op_ListGatewayRoutes.go | 12 +- service/appmesh/api_op_ListMeshes.go | 14 +- service/appmesh/api_op_ListRoutes.go | 12 +- service/appmesh/api_op_ListTagsForResource.go | 12 +- service/appmesh/api_op_ListVirtualGateways.go | 12 +- service/appmesh/api_op_ListVirtualNodes.go | 12 +- service/appmesh/api_op_ListVirtualRouters.go | 12 +- service/appmesh/api_op_ListVirtualServices.go | 12 +- service/appmesh/api_op_UpdateGatewayRoute.go | 8 +- service/appmesh/api_op_UpdateMesh.go | 6 +- service/appmesh/api_op_UpdateRoute.go | 14 +- .../appmesh/api_op_UpdateVirtualGateway.go | 10 +- service/appmesh/api_op_UpdateVirtualNode.go | 10 +- service/appmesh/api_op_UpdateVirtualRouter.go | 10 +- .../appmesh/api_op_UpdateVirtualService.go | 10 +- service/appmesh/go.mod | 2 +- service/appmesh/types/types.go | 588 +- service/appstream/api_op_AssociateFleet.go | 8 +- service/appstream/api_op_CopyImage.go | 16 +- service/appstream/api_op_CreateFleet.go | 158 +- .../appstream/api_op_CreateImageBuilder.go | 62 +- .../api_op_CreateImageBuilderStreamingURL.go | 6 +- service/appstream/api_op_CreateStack.go | 42 +- .../appstream/api_op_CreateStreamingURL.go | 30 +- .../api_op_CreateUsageReportSubscription.go | 6 +- service/appstream/api_op_CreateUser.go | 12 +- .../api_op_DeleteImagePermissions.go | 10 +- service/appstream/api_op_DeleteUser.go | 10 +- .../api_op_DescribeDirectoryConfigs.go | 6 +- service/appstream/api_op_DescribeFleets.go | 6 +- .../appstream/api_op_DescribeImageBuilders.go | 12 +- .../api_op_DescribeImagePermissions.go | 12 +- service/appstream/api_op_DescribeImages.go | 10 +- service/appstream/api_op_DescribeSessions.go | 20 +- service/appstream/api_op_DescribeStacks.go | 6 +- ...api_op_DescribeUsageReportSubscriptions.go | 12 +- .../api_op_DescribeUserStackAssociations.go | 20 +- service/appstream/api_op_DescribeUsers.go | 18 +- .../appstream/api_op_UpdateDirectoryConfig.go | 10 +- service/appstream/api_op_UpdateFleet.go | 86 +- .../api_op_UpdateImagePermissions.go | 8 +- service/appstream/api_op_UpdateStack.go | 44 +- service/appstream/go.mod | 2 +- service/appstream/types/types.go | 634 +- service/appsync/api_op_CreateApiCache.go | 20 +- service/appsync/api_op_CreateApiKey.go | 16 +- service/appsync/api_op_CreateDataSource.go | 38 +- service/appsync/api_op_CreateFunction.go | 26 +- service/appsync/api_op_CreateGraphqlApi.go | 26 +- service/appsync/api_op_CreateResolver.go | 24 +- service/appsync/api_op_CreateType.go | 10 +- service/appsync/api_op_DeleteResolver.go | 8 +- service/appsync/api_op_GetFunction.go | 8 +- .../appsync/api_op_GetIntrospectionSchema.go | 8 +- service/appsync/api_op_GetResolver.go | 8 +- service/appsync/api_op_GetType.go | 10 +- service/appsync/api_op_ListDataSources.go | 14 +- service/appsync/api_op_ListFunctions.go | 8 +- service/appsync/api_op_ListGraphqlApis.go | 6 +- service/appsync/api_op_ListResolvers.go | 22 +- .../appsync/api_op_ListResolversByFunction.go | 20 +- service/appsync/api_op_ListTypes.go | 6 +- service/appsync/api_op_StartSchemaCreation.go | 8 +- service/appsync/api_op_UntagResource.go | 8 +- service/appsync/api_op_UpdateApiCache.go | 30 +- service/appsync/api_op_UpdateApiKey.go | 14 +- service/appsync/api_op_UpdateDataSource.go | 34 +- service/appsync/api_op_UpdateFunction.go | 34 +- service/appsync/api_op_UpdateGraphqlApi.go | 32 +- service/appsync/api_op_UpdateResolver.go | 46 +- service/appsync/api_op_UpdateType.go | 10 +- service/appsync/go.mod | 2 +- service/appsync/types/types.go | 308 +- .../athena/api_op_BatchGetQueryExecution.go | 6 +- service/athena/api_op_CreateDataCatalog.go | 6 +- service/athena/api_op_CreateNamedQuery.go | 34 +- service/athena/api_op_CreateWorkGroup.go | 18 +- service/athena/api_op_DeleteWorkGroup.go | 8 +- service/athena/api_op_GetDatabase.go | 8 +- service/athena/api_op_GetQueryResults.go | 10 +- service/athena/api_op_GetTableMetadata.go | 8 +- service/athena/api_op_ListDataCatalogs.go | 6 +- service/athena/api_op_ListDatabases.go | 6 +- service/athena/api_op_ListNamedQueries.go | 6 +- service/athena/api_op_ListQueryExecutions.go | 12 +- service/athena/api_op_ListTableMetadata.go | 24 +- service/athena/api_op_ListTagsForResource.go | 8 +- service/athena/api_op_ListWorkGroups.go | 6 +- service/athena/api_op_StartQueryExecution.go | 22 +- service/athena/api_op_TagResource.go | 12 +- service/athena/api_op_UntagResource.go | 10 +- service/athena/api_op_UpdateDataCatalog.go | 12 +- service/athena/api_op_UpdateWorkGroup.go | 18 +- service/athena/go.mod | 2 +- service/athena/types/types.go | 278 +- .../autoscaling/api_op_AttachLoadBalancers.go | 8 +- .../api_op_BatchDeleteScheduledAction.go | 8 +- .../api_op_CompleteLifecycleAction.go | 20 +- .../api_op_CreateAutoScalingGroup.go | 196 +- .../api_op_CreateLaunchConfiguration.go | 164 +- .../autoscaling/api_op_DeleteLifecycleHook.go | 8 +- service/autoscaling/api_op_DeletePolicy.go | 6 +- .../api_op_DescribeAccountLimits.go | 12 +- .../api_op_DescribeAutoScalingGroups.go | 18 +- .../api_op_DescribeAutoScalingInstances.go | 10 +- .../api_op_DescribeInstanceRefreshes.go | 12 +- .../api_op_DescribeLaunchConfigurations.go | 8 +- ...api_op_DescribeLoadBalancerTargetGroups.go | 8 +- .../api_op_DescribeLoadBalancers.go | 8 +- .../api_op_DescribeMetricCollectionTypes.go | 6 +- ...i_op_DescribeNotificationConfigurations.go | 20 +- .../autoscaling/api_op_DescribePolicies.go | 14 +- .../api_op_DescribeScalingActivities.go | 8 +- .../api_op_DescribeScheduledActions.go | 28 +- service/autoscaling/api_op_DescribeTags.go | 8 +- service/autoscaling/api_op_DetachInstances.go | 6 +- .../api_op_DetachLoadBalancerTargetGroups.go | 10 +- .../autoscaling/api_op_DetachLoadBalancers.go | 8 +- .../api_op_EnableMetricsCollection.go | 10 +- service/autoscaling/api_op_EnterStandby.go | 6 +- service/autoscaling/api_op_ExecutePolicy.go | 38 +- .../autoscaling/api_op_PutLifecycleHook.go | 52 +- .../api_op_PutNotificationConfiguration.go | 12 +- .../autoscaling/api_op_PutScalingPolicy.go | 122 +- .../api_op_PutScheduledUpdateGroupAction.go | 42 +- .../api_op_RecordLifecycleActionHeartbeat.go | 14 +- service/autoscaling/api_op_ResumeProcesses.go | 10 +- .../autoscaling/api_op_SetDesiredCapacity.go | 18 +- .../autoscaling/api_op_SetInstanceHealth.go | 24 +- .../api_op_SetInstanceProtection.go | 10 +- .../api_op_StartInstanceRefresh.go | 10 +- .../autoscaling/api_op_SuspendProcesses.go | 10 +- .../api_op_UpdateAutoScalingGroup.go | 146 +- service/autoscaling/go.mod | 2 +- service/autoscaling/types/types.go | 916 +-- .../api_op_CreateScalingPlan.go | 12 +- .../api_op_DescribeScalingPlanResources.go | 6 +- .../api_op_DescribeScalingPlans.go | 16 +- ...i_op_GetScalingPlanResourceForecastData.go | 64 +- .../api_op_UpdateScalingPlan.go | 14 +- service/autoscalingplans/go.mod | 2 +- service/autoscalingplans/types/types.go | 308 +- service/backup/api_op_CreateBackupPlan.go | 16 +- .../backup/api_op_CreateBackupSelection.go | 16 +- service/backup/api_op_CreateBackupVault.go | 22 +- service/backup/api_op_DeleteBackupPlan.go | 6 +- service/backup/api_op_DescribeBackupJob.go | 98 +- service/backup/api_op_DescribeBackupVault.go | 18 +- .../api_op_DescribeProtectedResource.go | 8 +- .../backup/api_op_DescribeRecoveryPoint.go | 92 +- service/backup/api_op_DescribeRestoreJob.go | 52 +- service/backup/api_op_GetBackupPlan.go | 38 +- service/backup/api_op_GetBackupSelection.go | 26 +- .../api_op_GetBackupVaultAccessPolicy.go | 6 +- .../api_op_GetBackupVaultNotifications.go | 8 +- .../api_op_GetRecoveryPointRestoreMetadata.go | 10 +- service/backup/api_op_ListBackupJobs.go | 36 +- .../backup/api_op_ListBackupPlanVersions.go | 6 +- service/backup/api_op_ListBackupPlans.go | 14 +- service/backup/api_op_ListBackupSelections.go | 16 +- service/backup/api_op_ListCopyJobs.go | 34 +- .../backup/api_op_ListProtectedResources.go | 6 +- .../api_op_ListRecoveryPointsByBackupVault.go | 34 +- .../api_op_ListRecoveryPointsByResource.go | 14 +- service/backup/api_op_ListRestoreJobs.go | 24 +- service/backup/api_op_ListTags.go | 20 +- .../api_op_PutBackupVaultAccessPolicy.go | 6 +- .../api_op_PutBackupVaultNotifications.go | 12 +- service/backup/api_op_StartBackupJob.go | 62 +- service/backup/api_op_StartCopyJob.go | 30 +- service/backup/api_op_StartRestoreJob.go | 58 +- service/backup/api_op_TagResource.go | 12 +- service/backup/api_op_UntagResource.go | 10 +- service/backup/api_op_UpdateBackupPlan.go | 22 +- .../api_op_UpdateRecoveryPointLifecycle.go | 24 +- service/backup/go.mod | 2 +- service/backup/types/types.go | 538 +- .../batch/api_op_CreateComputeEnvironment.go | 34 +- service/batch/api_op_CreateJobQueue.go | 24 +- .../api_op_DescribeComputeEnvironments.go | 24 +- .../batch/api_op_DescribeJobDefinitions.go | 36 +- service/batch/api_op_DescribeJobQueues.go | 22 +- service/batch/api_op_ListJobs.go | 22 +- service/batch/api_op_RegisterJobDefinition.go | 48 +- service/batch/api_op_SubmitJob.go | 72 +- service/batch/api_op_TerminateJob.go | 10 +- .../batch/api_op_UpdateComputeEnvironment.go | 14 +- service/batch/api_op_UpdateJobQueue.go | 10 +- service/batch/go.mod | 2 +- service/batch/types/types.go | 756 +- service/braket/api_op_CancelQuantumTask.go | 16 +- service/braket/api_op_CreateQuantumTask.go | 24 +- service/braket/api_op_GetDevice.go | 20 +- service/braket/api_op_GetQuantumTask.go | 34 +- service/braket/api_op_SearchDevices.go | 16 +- service/braket/api_op_SearchQuantumTasks.go | 16 +- service/braket/go.mod | 2 +- service/braket/types/types.go | 44 +- service/budgets/api_op_CreateBudget.go | 18 +- service/budgets/api_op_CreateNotification.go | 22 +- service/budgets/api_op_CreateSubscriber.go | 20 +- service/budgets/api_op_DeleteBudget.go | 8 +- service/budgets/api_op_DeleteNotification.go | 12 +- service/budgets/api_op_DeleteSubscriber.go | 10 +- service/budgets/api_op_DescribeBudget.go | 8 +- ...api_op_DescribeBudgetPerformanceHistory.go | 22 +- service/budgets/api_op_DescribeBudgets.go | 14 +- .../api_op_DescribeNotificationsForBudget.go | 10 +- ...i_op_DescribeSubscribersForNotification.go | 16 +- service/budgets/api_op_UpdateBudget.go | 8 +- service/budgets/api_op_UpdateNotification.go | 10 +- service/budgets/api_op_UpdateSubscriber.go | 16 +- service/budgets/go.mod | 2 +- service/budgets/types/types.go | 150 +- .../api_op_AssociatePhoneNumberWithUser.go | 8 +- ...AssociatePhoneNumbersWithVoiceConnector.go | 10 +- ...iatePhoneNumbersWithVoiceConnectorGroup.go | 10 +- ...ssociateSigninDelegateGroupsWithAccount.go | 8 +- .../chime/api_op_BatchCreateRoomMembership.go | 8 +- service/chime/api_op_BatchSuspendUser.go | 8 +- service/chime/api_op_BatchUnsuspendUser.go | 8 +- service/chime/api_op_CreateBot.go | 6 +- service/chime/api_op_CreateMeeting.go | 20 +- .../api_op_CreateMeetingWithAttendees.go | 22 +- service/chime/api_op_CreateProxySession.go | 28 +- service/chime/api_op_CreateRoomMembership.go | 14 +- service/chime/api_op_CreateVoiceConnector.go | 14 +- .../chime/api_op_CreateVoiceConnectorGroup.go | 6 +- service/chime/api_op_DeleteAttendee.go | 8 +- .../chime/api_op_DeleteEventsConfiguration.go | 8 +- service/chime/api_op_DeleteProxySession.go | 8 +- service/chime/api_op_DeleteRoomMembership.go | 8 +- .../api_op_DisassociatePhoneNumberFromUser.go | 8 +- ...iatePhoneNumbersFromVoiceConnectorGroup.go | 8 +- service/chime/api_op_GetBot.go | 8 +- .../chime/api_op_GetPhoneNumberSettings.go | 6 +- service/chime/api_op_GetUser.go | 8 +- service/chime/api_op_InviteUsers.go | 6 +- service/chime/api_op_ListAccounts.go | 16 +- service/chime/api_op_ListAttendees.go | 6 +- service/chime/api_op_ListBots.go | 10 +- service/chime/api_op_ListMeetings.go | 12 +- service/chime/api_op_ListPhoneNumbers.go | 20 +- service/chime/api_op_ListProxySessions.go | 12 +- service/chime/api_op_ListRoomMemberships.go | 10 +- service/chime/api_op_ListRooms.go | 10 +- service/chime/api_op_ListUsers.go | 16 +- .../chime/api_op_ListVoiceConnectorGroups.go | 6 +- service/chime/api_op_ListVoiceConnectors.go | 6 +- .../chime/api_op_PutEventsConfiguration.go | 12 +- service/chime/api_op_PutRetentionSettings.go | 6 +- .../api_op_PutVoiceConnectorOrigination.go | 8 +- .../chime/api_op_PutVoiceConnectorProxy.go | 24 +- ...PutVoiceConnectorStreamingConfiguration.go | 8 +- .../api_op_PutVoiceConnectorTermination.go | 8 +- ...PutVoiceConnectorTerminationCredentials.go | 6 +- .../chime/api_op_RedactConversationMessage.go | 10 +- service/chime/api_op_RedactRoomMessage.go | 10 +- service/chime/api_op_ResetPersonalPIN.go | 8 +- .../api_op_SearchAvailablePhoneNumbers.go | 22 +- service/chime/api_op_TagAttendee.go | 8 +- service/chime/api_op_TagMeeting.go | 8 +- service/chime/api_op_TagResource.go | 8 +- service/chime/api_op_UntagAttendee.go | 10 +- service/chime/api_op_UntagMeeting.go | 8 +- service/chime/api_op_UpdateAccount.go | 6 +- service/chime/api_op_UpdatePhoneNumber.go | 12 +- service/chime/api_op_UpdateProxySession.go | 14 +- service/chime/api_op_UpdateRoomMembership.go | 14 +- service/chime/api_op_UpdateUser.go | 16 +- service/chime/api_op_UpdateUserSettings.go | 10 +- .../chime/api_op_UpdateVoiceConnectorGroup.go | 8 +- service/chime/go.mod | 2 +- service/chime/types/types.go | 492 +- service/cloud9/api_op_CreateEnvironmentEC2.go | 36 +- .../api_op_CreateEnvironmentMembership.go | 10 +- .../api_op_DeleteEnvironmentMembership.go | 10 +- .../api_op_DescribeEnvironmentMemberships.go | 28 +- service/cloud9/api_op_ListEnvironments.go | 12 +- service/cloud9/api_op_TagResource.go | 10 +- .../api_op_UpdateEnvironmentMembership.go | 12 +- service/cloud9/go.mod | 2 +- service/cloud9/types/types.go | 64 +- .../clouddirectory/api_op_AddFacetToObject.go | 18 +- service/clouddirectory/api_op_ApplySchema.go | 12 +- service/clouddirectory/api_op_AttachObject.go | 10 +- service/clouddirectory/api_op_AttachPolicy.go | 8 +- .../clouddirectory/api_op_AttachToIndex.go | 8 +- .../clouddirectory/api_op_AttachTypedLink.go | 18 +- service/clouddirectory/api_op_BatchRead.go | 8 +- .../clouddirectory/api_op_CreateDirectory.go | 20 +- service/clouddirectory/api_op_CreateFacet.go | 16 +- service/clouddirectory/api_op_CreateIndex.go | 24 +- service/clouddirectory/api_op_CreateObject.go | 12 +- .../clouddirectory/api_op_DetachFromIndex.go | 8 +- service/clouddirectory/api_op_DetachObject.go | 10 +- service/clouddirectory/api_op_DetachPolicy.go | 12 +- .../clouddirectory/api_op_DetachTypedLink.go | 10 +- service/clouddirectory/api_op_GetFacet.go | 10 +- .../api_op_GetLinkAttributes.go | 6 +- .../api_op_GetObjectInformation.go | 16 +- .../clouddirectory/api_op_GetSchemaAsJson.go | 6 +- .../api_op_GetTypedLinkFacetInformation.go | 10 +- .../api_op_ListAppliedSchemaArns.go | 20 +- .../api_op_ListAttachedIndices.go | 18 +- .../api_op_ListDevelopmentSchemaArns.go | 6 +- .../clouddirectory/api_op_ListDirectories.go | 16 +- .../api_op_ListFacetAttributes.go | 6 +- .../clouddirectory/api_op_ListFacetNames.go | 16 +- .../api_op_ListIncomingTypedLinks.go | 28 +- service/clouddirectory/api_op_ListIndex.go | 30 +- .../api_op_ListManagedSchemaArns.go | 6 +- .../api_op_ListObjectAttributes.go | 18 +- .../api_op_ListObjectChildren.go | 24 +- .../api_op_ListObjectParentPaths.go | 8 +- .../api_op_ListObjectParents.go | 32 +- .../api_op_ListObjectPolicies.go | 8 +- .../api_op_ListOutgoingTypedLinks.go | 28 +- .../api_op_ListPolicyAttachments.go | 22 +- .../api_op_ListPublishedSchemaArns.go | 6 +- .../api_op_ListTagsForResource.go | 12 +- .../api_op_ListTypedLinkFacetAttributes.go | 12 +- service/clouddirectory/api_op_LookupPolicy.go | 14 +- .../clouddirectory/api_op_PublishSchema.go | 16 +- .../api_op_PutSchemaFromJson.go | 8 +- .../api_op_RemoveFacetFromObject.go | 8 +- service/clouddirectory/api_op_UpdateFacet.go | 14 +- .../api_op_UpdateLinkAttributes.go | 10 +- .../api_op_UpdateObjectAttributes.go | 10 +- service/clouddirectory/api_op_UpdateSchema.go | 10 +- .../api_op_UpdateTypedLinkFacet.go | 10 +- .../api_op_UpgradePublishedSchema.go | 10 +- service/clouddirectory/go.mod | 2 +- service/clouddirectory/types/types.go | 650 +- .../api_op_CancelUpdateStack.go | 10 +- .../api_op_ContinueUpdateRollback.go | 34 +- .../cloudformation/api_op_CreateChangeSet.go | 142 +- service/cloudformation/api_op_CreateStack.go | 142 +- .../api_op_CreateStackInstances.go | 18 +- .../cloudformation/api_op_CreateStackSet.go | 104 +- service/cloudformation/api_op_DeleteStack.go | 24 +- .../api_op_DeleteStackInstances.go | 26 +- .../cloudformation/api_op_DeregisterType.go | 8 +- .../api_op_DescribeAccountLimits.go | 8 +- .../api_op_DescribeChangeSet.go | 84 +- ...pi_op_DescribeStackDriftDetectionStatus.go | 42 +- .../api_op_DescribeStackInstance.go | 12 +- .../api_op_DescribeStackResourceDrifts.go | 28 +- .../api_op_DescribeStackResources.go | 8 +- .../cloudformation/api_op_DescribeStacks.go | 6 +- service/cloudformation/api_op_DescribeType.go | 90 +- .../api_op_DescribeTypeRegistration.go | 8 +- .../cloudformation/api_op_DetectStackDrift.go | 6 +- .../api_op_DetectStackResourceDrift.go | 8 +- .../cloudformation/api_op_ExecuteChangeSet.go | 12 +- service/cloudformation/api_op_GetTemplate.go | 22 +- .../api_op_GetTemplateSummary.go | 70 +- .../cloudformation/api_op_ListChangeSets.go | 8 +- service/cloudformation/api_op_ListImports.go | 6 +- .../api_op_ListStackInstances.go | 22 +- .../api_op_ListStackResources.go | 8 +- .../api_op_ListStackSetOperationResults.go | 30 +- .../api_op_ListStackSetOperations.go | 14 +- .../cloudformation/api_op_ListStackSets.go | 12 +- service/cloudformation/api_op_ListStacks.go | 8 +- .../api_op_ListTypeRegistrations.go | 30 +- .../cloudformation/api_op_ListTypeVersions.go | 24 +- service/cloudformation/api_op_ListTypes.go | 40 +- .../api_op_RecordHandlerProgress.go | 12 +- service/cloudformation/api_op_RegisterType.go | 62 +- .../cloudformation/api_op_SetStackPolicy.go | 10 +- .../api_op_SetTypeDefaultVersion.go | 8 +- .../cloudformation/api_op_SignalResource.go | 12 +- service/cloudformation/api_op_UpdateStack.go | 182 +- .../api_op_UpdateStackInstances.go | 74 +- .../cloudformation/api_op_UpdateStackSet.go | 204 +- .../cloudformation/api_op_ValidateTemplate.go | 34 +- service/cloudformation/go.mod | 2 +- service/cloudformation/types/types.go | 1186 +-- .../cloudfront/api_op_CreateCachePolicy.go | 6 +- ...op_CreateCloudFrontOriginAccessIdentity.go | 6 +- ...api_op_CreateFieldLevelEncryptionConfig.go | 6 +- ...pi_op_CreateFieldLevelEncryptionProfile.go | 6 +- .../cloudfront/api_op_CreateInvalidation.go | 8 +- .../api_op_CreateOriginRequestPolicy.go | 8 +- service/cloudfront/api_op_CreatePublicKey.go | 6 +- .../api_op_CreateStreamingDistribution.go | 6 +- ..._op_CreateStreamingDistributionWithTags.go | 8 +- .../cloudfront/api_op_DeleteCachePolicy.go | 10 +- ...op_DeleteCloudFrontOriginAccessIdentity.go | 8 +- .../cloudfront/api_op_DeleteDistribution.go | 8 +- ...pi_op_DeleteFieldLevelEncryptionProfile.go | 8 +- .../api_op_DeleteStreamingDistribution.go | 8 +- service/cloudfront/api_op_GetCachePolicy.go | 6 +- .../cloudfront/api_op_GetCachePolicyConfig.go | 6 +- service/cloudfront/api_op_GetDistribution.go | 6 +- .../api_op_GetDistributionConfig.go | 6 +- .../api_op_GetFieldLevelEncryption.go | 6 +- .../api_op_GetFieldLevelEncryptionProfile.go | 6 +- ...op_GetFieldLevelEncryptionProfileConfig.go | 6 +- service/cloudfront/api_op_GetInvalidation.go | 8 +- .../api_op_GetOriginRequestPolicy.go | 6 +- .../api_op_GetOriginRequestPolicyConfig.go | 6 +- service/cloudfront/api_op_GetPublicKey.go | 6 +- .../api_op_GetStreamingDistribution.go | 6 +- .../api_op_GetStreamingDistributionConfig.go | 6 +- ...op_ListCloudFrontOriginAccessIdentities.go | 6 +- .../cloudfront/api_op_ListDistributions.go | 6 +- ...api_op_ListDistributionsByCachePolicyId.go | 10 +- ...istDistributionsByOriginRequestPolicyId.go | 12 +- .../api_op_ListDistributionsByWebACLId.go | 14 +- .../cloudfront/api_op_ListInvalidations.go | 12 +- .../api_op_ListOriginRequestPolicies.go | 12 +- service/cloudfront/api_op_ListPublicKeys.go | 6 +- .../api_op_ListStreamingDistributions.go | 6 +- .../cloudfront/api_op_UpdateCachePolicy.go | 20 +- ...op_UpdateCloudFrontOriginAccessIdentity.go | 14 +- ...pi_op_UpdateFieldLevelEncryptionProfile.go | 8 +- .../api_op_UpdateOriginRequestPolicy.go | 14 +- service/cloudfront/api_op_UpdatePublicKey.go | 8 +- .../api_op_UpdateStreamingDistribution.go | 20 +- service/cloudfront/go.mod | 2 +- service/cloudfront/types/types.go | 1826 ++--- service/cloudhsm/api_op_CreateHsm.go | 32 +- service/cloudhsm/api_op_DescribeHapg.go | 22 +- service/cloudhsm/api_op_DescribeHsm.go | 80 +- service/cloudhsm/api_op_DescribeLunaClient.go | 16 +- service/cloudhsm/api_op_GetConfig.go | 16 +- service/cloudhsm/api_op_ListHapgs.go | 8 +- service/cloudhsm/api_op_ListHsms.go | 6 +- service/cloudhsm/api_op_ListLunaClients.go | 8 +- service/cloudhsm/api_op_ModifyHapg.go | 14 +- service/cloudhsm/api_op_ModifyHsm.go | 20 +- service/cloudhsm/api_op_ModifyLunaClient.go | 8 +- .../cloudhsm/api_op_RemoveTagsFromResource.go | 10 +- service/cloudhsm/go.mod | 2 +- service/cloudhsm/types/types.go | 8 +- .../cloudhsmv2/api_op_CopyBackupToRegion.go | 16 +- service/cloudhsmv2/api_op_CreateCluster.go | 24 +- service/cloudhsmv2/api_op_DeleteHsm.go | 16 +- service/cloudhsmv2/api_op_DescribeBackups.go | 30 +- service/cloudhsmv2/api_op_DescribeClusters.go | 14 +- .../cloudhsmv2/api_op_InitializeCluster.go | 18 +- service/cloudhsmv2/api_op_ListTags.go | 16 +- service/cloudhsmv2/go.mod | 2 +- service/cloudhsmv2/types/types.go | 120 +- .../cloudsearch/api_op_DefineIndexField.go | 10 +- .../api_op_DeleteAnalysisScheme.go | 10 +- .../cloudsearch/api_op_DeleteExpression.go | 10 +- .../cloudsearch/api_op_DeleteIndexField.go | 12 +- service/cloudsearch/api_op_DeleteSuggester.go | 10 +- .../api_op_DescribeAvailabilityOptions.go | 8 +- .../cloudsearch/api_op_DescribeExpressions.go | 14 +- .../cloudsearch/api_op_DescribeIndexFields.go | 8 +- .../api_op_UpdateAvailabilityOptions.go | 16 +- .../api_op_UpdateScalingParameters.go | 12 +- .../api_op_UpdateServiceAccessPolicies.go | 10 +- service/cloudsearch/go.mod | 2 +- service/cloudsearch/types/types.go | 410 +- service/cloudsearchdomain/api_op_Search.go | 336 +- service/cloudsearchdomain/api_op_Suggest.go | 12 +- .../api_op_UploadDocuments.go | 24 +- service/cloudsearchdomain/go.mod | 2 +- service/cloudsearchdomain/types/types.go | 70 +- service/cloudtrail/api_op_CreateTrail.go | 162 +- .../cloudtrail/api_op_GetEventSelectors.go | 6 +- service/cloudtrail/api_op_GetTrailStatus.go | 82 +- service/cloudtrail/api_op_ListPublicKeys.go | 6 +- service/cloudtrail/api_op_ListTags.go | 6 +- service/cloudtrail/api_op_ListTrails.go | 6 +- service/cloudtrail/api_op_LookupEvents.go | 32 +- .../cloudtrail/api_op_PutInsightSelectors.go | 12 +- service/cloudtrail/api_op_RemoveTags.go | 6 +- service/cloudtrail/api_op_UpdateTrail.go | 166 +- service/cloudtrail/go.mod | 2 +- service/cloudtrail/types/types.go | 140 +- .../api_op_DeleteAnomalyDetector.go | 6 +- .../cloudwatch/api_op_DescribeAlarmHistory.go | 40 +- service/cloudwatch/api_op_DescribeAlarms.go | 74 +- .../api_op_DescribeAlarmsForMetric.go | 22 +- .../api_op_DescribeAnomalyDetectors.go | 14 +- .../cloudwatch/api_op_DescribeInsightRules.go | 6 +- .../cloudwatch/api_op_GetInsightRuleReport.go | 48 +- service/cloudwatch/api_op_GetMetricData.go | 30 +- .../cloudwatch/api_op_GetMetricStatistics.go | 90 +- service/cloudwatch/api_op_ListDashboards.go | 8 +- service/cloudwatch/api_op_ListMetrics.go | 20 +- .../cloudwatch/api_op_PutAnomalyDetector.go | 20 +- .../cloudwatch/api_op_PutCompositeAlarm.go | 20 +- service/cloudwatch/api_op_PutInsightRule.go | 18 +- service/cloudwatch/api_op_PutMetricAlarm.go | 232 +- service/cloudwatch/api_op_PutMetricData.go | 10 +- service/cloudwatch/api_op_SetAlarmState.go | 20 +- service/cloudwatch/api_op_TagResource.go | 10 +- service/cloudwatch/go.mod | 2 +- service/cloudwatch/types/types.go | 546 +- .../cloudwatchevents/api_op_CreateEventBus.go | 8 +- .../api_op_CreatePartnerEventSource.go | 12 +- service/cloudwatchevents/api_op_DeleteRule.go | 8 +- .../api_op_DescribeEventBus.go | 6 +- .../api_op_DescribeEventSource.go | 14 +- .../cloudwatchevents/api_op_DescribeRule.go | 38 +- .../cloudwatchevents/api_op_DisableRule.go | 8 +- service/cloudwatchevents/api_op_EnableRule.go | 8 +- .../cloudwatchevents/api_op_ListEventBuses.go | 10 +- .../api_op_ListEventSources.go | 14 +- .../api_op_ListPartnerEventSourceAccounts.go | 14 +- .../api_op_ListPartnerEventSources.go | 6 +- .../api_op_ListRuleNamesByTarget.go | 24 +- service/cloudwatchevents/api_op_ListRules.go | 16 +- .../api_op_ListTargetsByRule.go | 14 +- service/cloudwatchevents/api_op_PutEvents.go | 6 +- .../api_op_PutPartnerEvents.go | 8 +- .../cloudwatchevents/api_op_PutPermission.go | 20 +- service/cloudwatchevents/api_op_PutRule.go | 34 +- service/cloudwatchevents/api_op_PutTargets.go | 8 +- .../cloudwatchevents/api_op_RemoveTargets.go | 20 +- service/cloudwatchevents/go.mod | 2 +- service/cloudwatchevents/types/types.go | 286 +- .../cloudwatchlogs/api_op_CreateExportTask.go | 30 +- .../api_op_DeleteSubscriptionFilter.go | 8 +- .../api_op_DescribeDestinations.go | 10 +- .../api_op_DescribeExportTasks.go | 20 +- .../api_op_DescribeLogGroups.go | 12 +- .../api_op_DescribeLogStreams.go | 42 +- .../api_op_DescribeMetricFilters.go | 20 +- .../cloudwatchlogs/api_op_DescribeQueries.go | 14 +- .../api_op_DescribeQueryDefinitions.go | 4 +- .../api_op_DescribeResourcePolicies.go | 6 +- .../api_op_DescribeSubscriptionFilters.go | 16 +- .../cloudwatchlogs/api_op_FilterLogEvents.go | 42 +- service/cloudwatchlogs/api_op_GetLogEvents.go | 42 +- .../api_op_GetLogGroupFields.go | 10 +- .../cloudwatchlogs/api_op_GetQueryResults.go | 10 +- .../cloudwatchlogs/api_op_PutDestination.go | 10 +- .../api_op_PutDestinationPolicy.go | 10 +- service/cloudwatchlogs/api_op_PutLogEvents.go | 16 +- .../cloudwatchlogs/api_op_PutMetricFilter.go | 10 +- .../api_op_PutQueryDefinition.go | 8 +- .../api_op_PutSubscriptionFilter.go | 28 +- service/cloudwatchlogs/api_op_StartQuery.go | 20 +- .../cloudwatchlogs/api_op_TestMetricFilter.go | 10 +- .../cloudwatchlogs/api_op_UntagLogGroup.go | 8 +- service/cloudwatchlogs/go.mod | 2 +- service/cloudwatchlogs/types/types.go | 184 +- .../api_op_AssociateExternalConnection.go | 18 +- .../api_op_CopyPackageVersions.go | 74 +- .../codeartifact/api_op_CreateRepository.go | 10 +- service/codeartifact/api_op_DeleteDomain.go | 8 +- .../api_op_DeleteDomainPermissionsPolicy.go | 8 +- .../api_op_DeletePackageVersions.go | 50 +- .../codeartifact/api_op_DeleteRepository.go | 10 +- ...pi_op_DeleteRepositoryPermissionsPolicy.go | 18 +- .../api_op_DescribePackageVersion.go | 34 +- .../codeartifact/api_op_DescribeRepository.go | 8 +- .../api_op_DisassociateExternalConnection.go | 18 +- .../api_op_DisposePackageVersions.go | 56 +- .../api_op_GetAuthorizationToken.go | 16 +- .../api_op_GetDomainPermissionsPolicy.go | 8 +- .../api_op_GetPackageVersionAsset.go | 50 +- .../api_op_GetPackageVersionReadme.go | 66 +- .../api_op_GetRepositoryEndpoint.go | 8 +- .../api_op_GetRepositoryPermissionsPolicy.go | 8 +- .../api_op_ListPackageVersionAssets.go | 54 +- .../api_op_ListPackageVersionDependencies.go | 70 +- .../api_op_ListPackageVersions.go | 110 +- service/codeartifact/api_op_ListPackages.go | 54 +- .../codeartifact/api_op_ListRepositories.go | 8 +- .../api_op_ListRepositoriesInDomain.go | 20 +- .../api_op_PutDomainPermissionsPolicy.go | 18 +- .../api_op_PutRepositoryPermissionsPolicy.go | 18 +- .../api_op_UpdatePackageVersionsStatus.go | 64 +- .../codeartifact/api_op_UpdateRepository.go | 6 +- service/codeartifact/go.mod | 2 +- service/codeartifact/types/types.go | 234 +- .../codebuild/api_op_BatchGetBuildBatches.go | 6 +- .../codebuild/api_op_BatchGetReportGroups.go | 6 +- service/codebuild/api_op_BatchGetReports.go | 6 +- service/codebuild/api_op_CreateProject.go | 124 +- service/codebuild/api_op_CreateReportGroup.go | 16 +- service/codebuild/api_op_CreateWebhook.go | 18 +- service/codebuild/api_op_DeleteBuildBatch.go | 10 +- .../codebuild/api_op_DescribeCodeCoverages.go | 30 +- service/codebuild/api_op_DescribeTestCases.go | 16 +- .../api_op_ImportSourceCredentials.go | 22 +- service/codebuild/api_op_ListBuildBatches.go | 28 +- .../api_op_ListBuildBatchesForProject.go | 18 +- service/codebuild/api_op_ListBuilds.go | 16 +- .../codebuild/api_op_ListBuildsForProject.go | 28 +- service/codebuild/api_op_ListProjects.go | 16 +- service/codebuild/api_op_ListReportGroups.go | 16 +- service/codebuild/api_op_ListReports.go | 12 +- .../api_op_ListReportsForReportGroup.go | 32 +- .../codebuild/api_op_ListSharedProjects.go | 36 +- .../api_op_ListSharedReportGroups.go | 22 +- service/codebuild/api_op_PutResourcePolicy.go | 12 +- service/codebuild/api_op_RetryBuildBatch.go | 6 +- service/codebuild/api_op_StartBuild.go | 206 +- service/codebuild/api_op_StartBuildBatch.go | 204 +- service/codebuild/api_op_UpdateProject.go | 118 +- service/codebuild/api_op_UpdateReportGroup.go | 10 +- service/codebuild/api_op_UpdateWebhook.go | 10 +- service/codebuild/go.mod | 2 +- service/codebuild/types/types.go | 1176 +-- ...ciateApprovalRuleTemplateWithRepository.go | 8 +- ...ateApprovalRuleTemplateWithRepositories.go | 10 +- .../api_op_BatchDescribeMergeConflicts.go | 60 +- ...ateApprovalRuleTemplateFromRepositories.go | 12 +- service/codecommit/api_op_BatchGetCommits.go | 10 +- .../codecommit/api_op_BatchGetRepositories.go | 6 +- .../api_op_CreateApprovalRuleTemplate.go | 24 +- service/codecommit/api_op_CreateBranch.go | 8 +- service/codecommit/api_op_CreateCommit.go | 44 +- .../codecommit/api_op_CreatePullRequest.go | 16 +- .../api_op_CreatePullRequestApprovalRule.go | 12 +- service/codecommit/api_op_CreateRepository.go | 16 +- .../api_op_CreateUnreferencedMergeCommit.go | 48 +- service/codecommit/api_op_DeleteBranch.go | 8 +- service/codecommit/api_op_DeleteFile.go | 36 +- .../api_op_DeletePullRequestApprovalRule.go | 10 +- .../api_op_DescribeMergeConflicts.go | 50 +- .../api_op_DescribePullRequestEvents.go | 24 +- ...api_op_EvaluatePullRequestApprovalRules.go | 10 +- service/codecommit/api_op_GetBranch.go | 6 +- .../codecommit/api_op_GetCommentReactions.go | 8 +- .../api_op_GetCommentsForComparedCommit.go | 24 +- .../api_op_GetCommentsForPullRequest.go | 22 +- service/codecommit/api_op_GetCommit.go | 8 +- service/codecommit/api_op_GetDifferences.go | 44 +- service/codecommit/api_op_GetFile.go | 22 +- service/codecommit/api_op_GetFolder.go | 20 +- service/codecommit/api_op_GetMergeCommit.go | 48 +- .../codecommit/api_op_GetMergeConflicts.go | 62 +- service/codecommit/api_op_GetMergeOptions.go | 30 +- .../api_op_GetPullRequestApprovalStates.go | 8 +- .../api_op_GetPullRequestOverrideState.go | 8 +- .../api_op_ListApprovalRuleTemplates.go | 8 +- ...iatedApprovalRuleTemplatesForRepository.go | 12 +- service/codecommit/api_op_ListBranches.go | 12 +- service/codecommit/api_op_ListPullRequests.go | 6 +- service/codecommit/api_op_ListRepositories.go | 18 +- ...ListRepositoriesForApprovalRuleTemplate.go | 12 +- .../codecommit/api_op_ListTagsForResource.go | 8 +- .../api_op_MergeBranchesByFastForward.go | 10 +- .../api_op_MergeBranchesBySquash.go | 52 +- .../api_op_MergeBranchesByThreeWay.go | 54 +- .../api_op_MergePullRequestByFastForward.go | 10 +- .../api_op_MergePullRequestBySquash.go | 54 +- .../api_op_MergePullRequestByThreeWay.go | 60 +- ...api_op_OverridePullRequestApprovalRules.go | 16 +- .../api_op_PostCommentForComparedCommit.go | 46 +- .../api_op_PostCommentForPullRequest.go | 50 +- service/codecommit/api_op_PostCommentReply.go | 12 +- service/codecommit/api_op_PutFile.go | 44 +- .../api_op_PutRepositoryTriggers.go | 8 +- service/codecommit/api_op_TagResource.go | 10 +- .../api_op_TestRepositoryTriggers.go | 8 +- ...pi_op_UpdateApprovalRuleTemplateContent.go | 12 +- ...p_UpdateApprovalRuleTemplateDescription.go | 8 +- service/codecommit/api_op_UpdateComment.go | 10 +- .../codecommit/api_op_UpdateDefaultBranch.go | 8 +- ...op_UpdatePullRequestApprovalRuleContent.go | 14 +- .../api_op_UpdatePullRequestApprovalState.go | 10 +- service/codecommit/go.mod | 2 +- service/codecommit/types/types.go | 562 +- .../api_op_BatchGetApplicationRevisions.go | 18 +- .../api_op_BatchGetDeploymentGroups.go | 16 +- .../api_op_BatchGetDeploymentInstances.go | 16 +- .../api_op_BatchGetDeploymentTargets.go | 6 +- .../codedeploy/api_op_CreateApplication.go | 6 +- service/codedeploy/api_op_CreateDeployment.go | 40 +- .../api_op_CreateDeploymentConfig.go | 6 +- .../api_op_CreateDeploymentGroup.go | 108 +- .../api_op_DeleteDeploymentGroup.go | 10 +- .../api_op_GetApplicationRevision.go | 8 +- .../codedeploy/api_op_GetDeploymentGroup.go | 10 +- .../api_op_GetDeploymentInstance.go | 8 +- .../codedeploy/api_op_GetDeploymentTarget.go | 6 +- .../api_op_ListApplicationRevisions.go | 40 +- .../codedeploy/api_op_ListDeploymentGroups.go | 6 +- .../api_op_ListDeploymentInstances.go | 24 +- .../api_op_ListDeploymentTargets.go | 14 +- service/codedeploy/api_op_ListDeployments.go | 20 +- .../api_op_ListOnPremisesInstances.go | 14 +- .../codedeploy/api_op_ListTagsForResource.go | 16 +- ...op_PutLifecycleEventHookExecutionStatus.go | 8 +- .../api_op_RegisterApplicationRevision.go | 12 +- .../api_op_RegisterOnPremisesInstance.go | 10 +- ...pi_op_RemoveTagsFromOnPremisesInstances.go | 8 +- service/codedeploy/api_op_TagResource.go | 10 +- .../api_op_UpdateDeploymentGroup.go | 66 +- service/codedeploy/go.mod | 2 +- service/codedeploy/types/types.go | 748 +- .../codeguruprofiler/api_op_ConfigureAgent.go | 10 +- .../api_op_CreateProfilingGroup.go | 10 +- service/codeguruprofiler/api_op_GetProfile.go | 16 +- .../api_op_ListProfileTimes.go | 42 +- .../api_op_ListProfilingGroups.go | 10 +- .../api_op_PostAgentProfile.go | 6 +- .../api_op_RetrieveTimeSeries.go | 4 +- service/codeguruprofiler/go.mod | 2 +- service/codeguruprofiler/types/types.go | 3 +- .../api_op_DescribeRecommendationFeedback.go | 12 +- .../api_op_ListCodeReviews.go | 24 +- .../api_op_ListRecommendationFeedback.go | 32 +- .../api_op_ListRecommendations.go | 12 +- .../api_op_ListRepositoryAssociations.go | 24 +- .../api_op_PutRecommendationFeedback.go | 12 +- service/codegurureviewer/go.mod | 2 +- service/codegurureviewer/types/types.go | 286 +- service/codepipeline/api_op_AcknowledgeJob.go | 10 +- .../api_op_AcknowledgeThirdPartyJob.go | 10 +- .../api_op_CreateCustomActionType.go | 32 +- service/codepipeline/api_op_CreatePipeline.go | 6 +- .../api_op_DisableStageTransition.go | 28 +- .../api_op_EnableStageTransition.go | 14 +- service/codepipeline/api_op_GetPipeline.go | 8 +- .../api_op_GetPipelineExecution.go | 8 +- .../codepipeline/api_op_GetPipelineState.go | 18 +- .../api_op_GetThirdPartyJobDetails.go | 10 +- .../api_op_ListActionExecutions.go | 16 +- .../api_op_ListPipelineExecutions.go | 6 +- service/codepipeline/api_op_ListPipelines.go | 6 +- .../api_op_ListTagsForResource.go | 10 +- service/codepipeline/api_op_PollForJobs.go | 16 +- .../codepipeline/api_op_PutActionRevision.go | 16 +- .../codepipeline/api_op_PutApprovalResult.go | 14 +- .../api_op_PutJobFailureResult.go | 10 +- .../api_op_PutJobSuccessResult.go | 26 +- .../api_op_PutThirdPartyJobFailureResult.go | 10 +- .../api_op_PutThirdPartyJobSuccessResult.go | 24 +- service/codepipeline/api_op_PutWebhook.go | 6 +- .../api_op_RetryStageExecution.go | 8 +- .../api_op_StopPipelineExecution.go | 10 +- service/codepipeline/api_op_TagResource.go | 8 +- service/codepipeline/api_op_UntagResource.go | 8 +- service/codepipeline/go.mod | 2 +- service/codepipeline/types/types.go | 692 +- .../codestar/api_op_AssociateTeamMember.go | 24 +- service/codestar/api_op_CreateProject.go | 40 +- service/codestar/api_op_CreateUserProfile.go | 18 +- service/codestar/api_op_DeleteProject.go | 18 +- service/codestar/api_op_DescribeProject.go | 30 +- .../codestar/api_op_DescribeUserProfile.go | 20 +- .../codestar/api_op_DisassociateTeamMember.go | 10 +- service/codestar/api_op_ListProjects.go | 6 +- service/codestar/api_op_ListResources.go | 12 +- service/codestar/api_op_ListTagsForProject.go | 18 +- service/codestar/api_op_ListTeamMembers.go | 6 +- service/codestar/api_op_ListUserProfiles.go | 8 +- service/codestar/api_op_UntagProject.go | 8 +- service/codestar/api_op_UpdateProject.go | 6 +- service/codestar/api_op_UpdateTeamMember.go | 12 +- service/codestar/api_op_UpdateUserProfile.go | 26 +- service/codestar/go.mod | 2 +- service/codestar/types/types.go | 76 +- .../api_op_CreateConnection.go | 18 +- .../codestarconnections/api_op_CreateHost.go | 24 +- service/codestarconnections/api_op_GetHost.go | 14 +- .../api_op_ListConnections.go | 20 +- .../codestarconnections/api_op_ListHosts.go | 16 +- .../api_op_UntagResource.go | 8 +- service/codestarconnections/go.mod | 2 +- service/codestarconnections/types/types.go | 52 +- .../api_op_CreateNotificationRule.go | 52 +- .../api_op_DeleteTarget.go | 10 +- .../api_op_DescribeNotificationRule.go | 30 +- .../api_op_ListEventTypes.go | 8 +- .../api_op_ListNotificationRules.go | 16 +- .../api_op_ListTargets.go | 8 +- .../codestarnotifications/api_op_Subscribe.go | 10 +- .../api_op_TagResource.go | 10 +- .../api_op_UntagResource.go | 10 +- .../api_op_UpdateNotificationRule.go | 20 +- service/codestarnotifications/go.mod | 2 +- service/codestarnotifications/types/types.go | 34 +- .../api_op_CreateIdentityPool.go | 76 +- .../api_op_DescribeIdentity.go | 6 +- .../api_op_DescribeIdentityPool.go | 44 +- .../api_op_GetCredentialsForIdentity.go | 18 +- .../api_op_GetIdentityPoolRoles.go | 6 +- .../cognitoidentity/api_op_GetOpenIdToken.go | 16 +- ...i_op_GetOpenIdTokenForDeveloperIdentity.go | 6 +- .../cognitoidentity/api_op_ListIdentities.go | 20 +- .../api_op_ListIdentityPools.go | 6 +- .../api_op_LookupDeveloperIdentity.go | 30 +- .../api_op_MergeDeveloperIdentities.go | 10 +- .../api_op_SetIdentityPoolRoles.go | 10 +- service/cognitoidentity/api_op_TagResource.go | 8 +- .../api_op_UnlinkDeveloperIdentity.go | 16 +- .../cognitoidentity/api_op_UnlinkIdentity.go | 8 +- .../cognitoidentity/api_op_UntagResource.go | 10 +- .../api_op_UpdateIdentityPool.go | 84 +- service/cognitoidentity/go.mod | 2 +- service/cognitoidentity/types/types.go | 36 +- .../api_op_AddCustomAttributes.go | 8 +- .../api_op_AdminAddUserToGroup.go | 8 +- .../api_op_AdminConfirmSignUp.go | 8 +- .../api_op_AdminCreateUser.go | 72 +- .../api_op_AdminEnableUser.go | 8 +- .../api_op_AdminForgetDevice.go | 8 +- .../api_op_AdminGetDevice.go | 10 +- .../api_op_AdminGetUser.go | 40 +- .../api_op_AdminInitiateAuth.go | 72 +- .../api_op_AdminLinkProviderForUser.go | 10 +- .../api_op_AdminListDevices.go | 12 +- .../api_op_AdminListGroupsForUser.go | 12 +- .../api_op_AdminListUserAuthEvents.go | 18 +- .../api_op_AdminRemoveUserFromGroup.go | 8 +- .../api_op_AdminResetUserPassword.go | 10 +- .../api_op_AdminRespondToAuthChallenge.go | 94 +- .../api_op_AdminSetUserMFAPreference.go | 6 +- .../api_op_AdminSetUserPassword.go | 14 +- .../api_op_AdminSetUserSettings.go | 10 +- .../api_op_AdminUpdateAuthEventFeedback.go | 12 +- .../api_op_AdminUpdateDeviceStatus.go | 14 +- .../api_op_AdminUpdateUserAttributes.go | 32 +- .../api_op_AdminUserGlobalSignOut.go | 8 +- .../api_op_AssociateSoftwareToken.go | 6 +- .../api_op_ChangePassword.go | 8 +- .../api_op_ConfirmDevice.go | 6 +- .../api_op_ConfirmForgotPassword.go | 48 +- .../api_op_ConfirmSignUp.go | 52 +- .../api_op_CreateGroup.go | 26 +- .../api_op_CreateIdentityProvider.go | 44 +- .../api_op_CreateResourceServer.go | 6 +- .../api_op_CreateUserImportJob.go | 10 +- .../api_op_CreateUserPool.go | 108 +- .../api_op_CreateUserPoolClient.go | 182 +- .../api_op_DeleteGroup.go | 8 +- .../api_op_DeleteResourceServer.go | 8 +- .../api_op_DescribeRiskConfiguration.go | 6 +- .../api_op_ForgotPassword.go | 24 +- .../api_op_GetDevice.go | 6 +- .../api_op_GetGroup.go | 8 +- .../api_op_GetIdentityProviderByIdentifier.go | 8 +- .../api_op_GetUICustomization.go | 6 +- .../cognitoidentityprovider/api_op_GetUser.go | 18 +- .../api_op_GetUserPoolMfaConfig.go | 12 +- .../api_op_InitiateAuth.go | 132 +- .../api_op_ListDevices.go | 18 +- .../api_op_ListGroups.go | 8 +- .../api_op_ListIdentityProviders.go | 16 +- .../api_op_ListResourceServers.go | 6 +- .../api_op_ListUserImportJobs.go | 16 +- .../api_op_ListUserPools.go | 14 +- .../api_op_ListUsers.go | 28 +- .../api_op_ResendConfirmationCode.go | 30 +- .../api_op_RespondToAuthChallenge.go | 36 +- .../api_op_SetRiskConfiguration.go | 16 +- .../api_op_SetUICustomization.go | 6 +- .../api_op_SetUserMFAPreference.go | 6 +- .../api_op_SetUserPoolMfaConfig.go | 12 +- .../cognitoidentityprovider/api_op_SignUp.go | 32 +- .../api_op_TagResource.go | 8 +- .../api_op_UpdateAuthEventFeedback.go | 16 +- .../api_op_UpdateGroup.go | 6 +- .../api_op_UpdateIdentityProvider.go | 12 +- .../api_op_UpdateResourceServer.go | 8 +- .../api_op_UpdateUserAttributes.go | 22 +- .../api_op_UpdateUserPool.go | 76 +- .../api_op_UpdateUserPoolClient.go | 170 +- .../api_op_UpdateUserPoolDomain.go | 14 +- .../api_op_VerifySoftwareToken.go | 20 +- .../api_op_VerifyUserAttribute.go | 8 +- service/cognitoidentityprovider/go.mod | 2 +- .../cognitoidentityprovider/types/types.go | 900 +-- service/cognitosync/api_op_DeleteDataset.go | 4 +- service/cognitosync/api_op_DescribeDataset.go | 12 +- .../api_op_DescribeIdentityUsage.go | 4 +- .../api_op_GetBulkPublishDetails.go | 20 +- .../api_op_GetIdentityPoolConfiguration.go | 6 +- service/cognitosync/api_op_ListDatasets.go | 14 +- .../api_op_ListIdentityPoolUsage.go | 16 +- service/cognitosync/api_op_ListRecords.go | 48 +- service/cognitosync/api_op_RegisterDevice.go | 10 +- .../api_op_SetIdentityPoolConfiguration.go | 18 +- .../cognitosync/api_op_SubscribeToDataset.go | 8 +- .../api_op_UnsubscribeFromDataset.go | 18 +- service/cognitosync/api_op_UpdateRecords.go | 32 +- service/cognitosync/go.mod | 2 +- service/cognitosync/types/types.go | 70 +- .../api_op_BatchDetectKeyPhrases.go | 16 +- .../comprehend/api_op_BatchDetectSentiment.go | 14 +- .../comprehend/api_op_BatchDetectSyntax.go | 14 +- service/comprehend/api_op_ClassifyDocument.go | 8 +- .../api_op_CreateDocumentClassifier.go | 66 +- service/comprehend/api_op_CreateEndpoint.go | 20 +- .../api_op_CreateEntityRecognizer.go | 56 +- service/comprehend/api_op_DetectEntities.go | 12 +- service/comprehend/api_op_DetectKeyPhrases.go | 12 +- service/comprehend/api_op_DetectSentiment.go | 18 +- service/comprehend/api_op_DetectSyntax.go | 12 +- .../api_op_ListDocumentClassifiers.go | 16 +- ...pi_op_ListDominantLanguageDetectionJobs.go | 12 +- service/comprehend/api_op_ListEndpoints.go | 16 +- .../api_op_ListEntityRecognizers.go | 16 +- .../api_op_ListKeyPhrasesDetectionJobs.go | 12 +- .../api_op_ListSentimentDetectionJobs.go | 12 +- .../comprehend/api_op_ListTagsForResource.go | 8 +- .../api_op_ListTopicsDetectionJobs.go | 12 +- .../api_op_StartDocumentClassificationJob.go | 36 +- ...pi_op_StartDominantLanguageDetectionJob.go | 40 +- .../api_op_StartEntitiesDetectionJob.go | 68 +- .../api_op_StartKeyPhrasesDetectionJob.go | 62 +- .../api_op_StartSentimentDetectionJob.go | 48 +- .../api_op_StartTopicsDetectionJob.go | 46 +- ...api_op_StopDominantLanguageDetectionJob.go | 6 +- .../api_op_StopSentimentDetectionJob.go | 6 +- service/comprehend/api_op_UpdateEndpoint.go | 10 +- service/comprehend/go.mod | 2 +- service/comprehend/types/types.go | 740 +- .../api_op_DetectEntities.go | 18 +- .../api_op_DetectEntitiesV2.go | 14 +- service/comprehendmedical/api_op_DetectPHI.go | 8 +- .../api_op_ListEntitiesDetectionV2Jobs.go | 6 +- .../api_op_ListPHIDetectionJobs.go | 6 +- .../api_op_ListRxNormInferenceJobs.go | 6 +- .../api_op_StartEntitiesDetectionV2Job.go | 42 +- .../api_op_StartICD10CMInferenceJob.go | 34 +- .../api_op_StartPHIDetectionJob.go | 16 +- .../api_op_StartRxNormInferenceJob.go | 28 +- service/comprehendmedical/go.mod | 2 +- service/comprehendmedical/types/types.go | 306 +- ...api_op_DescribeRecommendationExportJobs.go | 6 +- ...p_ExportAutoScalingGroupRecommendations.go | 42 +- ...api_op_ExportEC2InstanceRecommendations.go | 42 +- ...i_op_GetAutoScalingGroupRecommendations.go | 34 +- .../api_op_GetEC2InstanceRecommendations.go | 28 +- ...op_GetEC2RecommendationProjectedMetrics.go | 14 +- .../api_op_GetEnrollmentStatus.go | 10 +- .../api_op_GetRecommendationSummaries.go | 18 +- .../api_op_UpdateEnrollmentStatus.go | 6 +- service/computeoptimizer/go.mod | 2 +- service/computeoptimizer/types/types.go | 190 +- .../api_op_BatchGetAggregateResourceConfig.go | 14 +- .../api_op_DeleteAggregationAuthorization.go | 8 +- .../api_op_DeleteRemediationConfiguration.go | 6 +- .../api_op_DeleteRemediationExceptions.go | 12 +- .../api_op_DeleteResourceConfig.go | 8 +- ...escribeAggregateComplianceByConfigRules.go | 12 +- .../api_op_DescribeComplianceByResource.go | 18 +- ...i_op_DescribeConfigRuleEvaluationStatus.go | 10 +- .../api_op_DescribeConfigRules.go | 8 +- ...ibeConfigurationAggregatorSourcesStatus.go | 26 +- ...api_op_DescribeConfigurationAggregators.go | 8 +- ...pi_op_DescribeConformancePackCompliance.go | 16 +- .../api_op_DescribeConformancePackStatus.go | 6 +- .../api_op_DescribeConformancePacks.go | 6 +- ..._DescribeOrganizationConfigRuleStatuses.go | 14 +- .../api_op_DescribeOrganizationConfigRules.go | 16 +- ...ribeOrganizationConformancePackStatuses.go | 14 +- ...op_DescribeOrganizationConformancePacks.go | 16 +- .../api_op_DescribeRemediationExceptions.go | 16 +- ...i_op_DescribeRemediationExecutionStatus.go | 28 +- ...tAggregateComplianceDetailsByConfigRule.go | 40 +- ...GetAggregateConfigRuleComplianceSummary.go | 18 +- ...op_GetAggregateDiscoveredResourceCounts.go | 28 +- ...api_op_GetComplianceDetailsByConfigRule.go | 18 +- .../api_op_GetComplianceDetailsByResource.go | 14 +- ..._op_GetConformancePackComplianceDetails.go | 20 +- ..._op_GetConformancePackComplianceSummary.go | 18 +- .../api_op_GetDiscoveredResourceCounts.go | 26 +- ...GetOrganizationConfigRuleDetailedStatus.go | 6 +- ...ganizationConformancePackDetailedStatus.go | 12 +- .../api_op_GetResourceConfigHistory.go | 32 +- ...api_op_ListAggregateDiscoveredResources.go | 18 +- .../api_op_ListDiscoveredResources.go | 18 +- .../api_op_ListTagsForResource.go | 24 +- service/configservice/api_op_PutConfigRule.go | 6 +- .../api_op_PutConfigurationAggregator.go | 14 +- .../api_op_PutConformancePack.go | 24 +- .../configservice/api_op_PutEvaluations.go | 10 +- .../api_op_PutOrganizationConfigRule.go | 14 +- .../api_op_PutOrganizationConformancePack.go | 20 +- .../configservice/api_op_PutResourceConfig.go | 30 +- .../api_op_SelectAggregateResourceConfig.go | 28 +- .../api_op_SelectResourceConfig.go | 20 +- .../api_op_StartRemediationExecution.go | 18 +- service/configservice/api_op_UntagResource.go | 10 +- service/configservice/go.mod | 2 +- service/configservice/types/types.go | 988 +-- service/connect/api_op_CreateUser.go | 50 +- .../api_op_DescribeUserHierarchyGroup.go | 8 +- .../connect/api_op_GetCurrentMetricData.go | 44 +- service/connect/api_op_GetMetricData.go | 72 +- service/connect/api_op_ListContactFlows.go | 14 +- .../connect/api_op_ListHoursOfOperations.go | 6 +- service/connect/api_op_ListPhoneNumbers.go | 26 +- service/connect/api_op_ListQueues.go | 12 +- service/connect/api_op_ListRoutingProfiles.go | 8 +- .../connect/api_op_ListUserHierarchyGroups.go | 16 +- service/connect/api_op_StartChatContact.go | 36 +- .../connect/api_op_StartContactRecording.go | 8 +- .../api_op_StartOutboundVoiceContact.go | 40 +- service/connect/api_op_StopContact.go | 8 +- .../connect/api_op_StopContactRecording.go | 10 +- .../connect/api_op_SuspendContactRecording.go | 8 +- service/connect/api_op_TagResource.go | 8 +- .../connect/api_op_UpdateContactAttributes.go | 10 +- service/connect/api_op_UpdateUserHierarchy.go | 12 +- .../connect/api_op_UpdateUserIdentityInfo.go | 10 +- .../connect/api_op_UpdateUserPhoneConfig.go | 8 +- .../api_op_UpdateUserRoutingProfile.go | 10 +- .../api_op_UpdateUserSecurityProfiles.go | 10 +- service/connect/go.mod | 2 +- service/connect/types/types.go | 186 +- .../api_op_DisconnectParticipant.go | 8 +- .../api_op_GetTranscript.go | 30 +- .../connectparticipant/api_op_SendEvent.go | 14 +- .../connectparticipant/api_op_SendMessage.go | 24 +- service/connectparticipant/go.mod | 2 +- service/connectparticipant/types/types.go | 40 +- .../api_op_DescribeReportDefinitions.go | 6 +- .../api_op_ModifyReportDefinition.go | 12 +- service/costandusagereportservice/go.mod | 2 +- .../costandusagereportservice/types/types.go | 50 +- .../api_op_CreateCostCategoryDefinition.go | 14 +- .../costexplorer/api_op_GetCostAndUsage.go | 30 +- .../api_op_GetCostAndUsageWithResources.go | 36 +- .../costexplorer/api_op_GetCostForecast.go | 30 +- .../costexplorer/api_op_GetDimensionValues.go | 50 +- .../api_op_GetReservationCoverage.go | 48 +- ...op_GetReservationPurchaseRecommendation.go | 42 +- .../api_op_GetReservationUtilization.go | 20 +- .../api_op_GetRightsizingRecommendation.go | 30 +- .../api_op_GetSavingsPlansCoverage.go | 22 +- ...p_GetSavingsPlansPurchaseRecommendation.go | 46 +- .../api_op_GetSavingsPlansUtilization.go | 28 +- service/costexplorer/api_op_GetTags.go | 20 +- .../costexplorer/api_op_GetUsageForecast.go | 14 +- .../api_op_ListCostCategoryDefinitions.go | 16 +- .../api_op_UpdateCostCategoryDefinition.go | 20 +- service/costexplorer/go.mod | 2 +- service/costexplorer/types/types.go | 758 +- .../api_op_AddTagsToResource.go | 10 +- .../api_op_ApplyPendingMaintenanceAction.go | 12 +- .../api_op_CreateEndpoint.go | 258 +- .../api_op_CreateEventSubscription.go | 32 +- .../api_op_CreateReplicationInstance.go | 74 +- .../api_op_CreateReplicationSubnetGroup.go | 6 +- .../api_op_CreateReplicationTask.go | 58 +- ...DescribeApplicableIndividualAssessments.go | 42 +- .../api_op_DescribeCertificates.go | 12 +- .../api_op_DescribeEndpointTypes.go | 10 +- .../api_op_DescribeEventSubscriptions.go | 14 +- .../api_op_DescribeEvents.go | 28 +- ...pi_op_DescribePendingMaintenanceActions.go | 16 +- ..._op_DescribeReplicationInstanceTaskLogs.go | 26 +- .../api_op_DescribeReplicationInstances.go | 12 +- .../api_op_DescribeReplicationSubnetGroups.go | 16 +- ...escribeReplicationTaskAssessmentResults.go | 6 +- ...p_DescribeReplicationTaskAssessmentRuns.go | 10 +- ...ibeReplicationTaskIndividualAssessments.go | 16 +- .../api_op_DescribeReplicationTasks.go | 24 +- .../api_op_DescribeSchemas.go | 16 +- .../api_op_DescribeTableStatistics.go | 16 +- .../api_op_ImportCertificate.go | 12 +- .../api_op_ModifyEndpoint.go | 220 +- .../api_op_ModifyEventSubscription.go | 14 +- .../api_op_ModifyReplicationInstance.go | 64 +- .../api_op_ModifyReplicationSubnetGroup.go | 8 +- .../api_op_ModifyReplicationTask.go | 50 +- .../api_op_RefreshSchemas.go | 8 +- .../api_op_RemoveTagsFromResource.go | 10 +- .../api_op_StartReplicationTask.go | 32 +- ...pi_op_StartReplicationTaskAssessmentRun.go | 70 +- service/databasemigrationservice/go.mod | 2 +- .../databasemigrationservice/types/types.go | 1566 ++-- service/dataexchange/api_op_CreateDataSet.go | 54 +- service/dataexchange/api_op_CreateJob.go | 18 +- service/dataexchange/api_op_CreateRevision.go | 32 +- service/dataexchange/api_op_DeleteAsset.go | 10 +- service/dataexchange/api_op_GetAsset.go | 20 +- service/dataexchange/api_op_GetDataSet.go | 40 +- service/dataexchange/api_op_GetJob.go | 20 +- service/dataexchange/api_op_GetRevision.go | 36 +- .../api_op_ListDataSetRevisions.go | 12 +- service/dataexchange/api_op_ListJobs.go | 10 +- .../dataexchange/api_op_ListRevisionAssets.go | 10 +- service/dataexchange/api_op_UntagResource.go | 8 +- service/dataexchange/api_op_UpdateAsset.go | 42 +- service/dataexchange/api_op_UpdateDataSet.go | 50 +- service/dataexchange/api_op_UpdateRevision.go | 34 +- service/dataexchange/go.mod | 2 +- service/dataexchange/types/types.go | 265 +- .../datapipeline/api_op_ActivatePipeline.go | 6 +- service/datapipeline/api_op_CreatePipeline.go | 14 +- .../datapipeline/api_op_DeactivatePipeline.go | 10 +- .../datapipeline/api_op_DescribeObjects.go | 20 +- .../datapipeline/api_op_EvaluateExpression.go | 10 +- .../api_op_GetPipelineDefinition.go | 18 +- service/datapipeline/api_op_ListPipelines.go | 8 +- service/datapipeline/api_op_PollForTask.go | 6 +- .../api_op_PutPipelineDefinition.go | 10 +- service/datapipeline/api_op_QueryObjects.go | 34 +- service/datapipeline/api_op_RemoveTags.go | 8 +- .../datapipeline/api_op_ReportTaskProgress.go | 8 +- .../api_op_ReportTaskRunnerHeartbeat.go | 6 +- service/datapipeline/api_op_SetStatus.go | 12 +- service/datapipeline/api_op_SetTaskStatus.go | 22 +- .../api_op_ValidatePipelineDefinition.go | 16 +- service/datapipeline/go.mod | 2 +- service/datapipeline/types/types.go | 62 +- service/datasync/api_op_CreateAgent.go | 42 +- service/datasync/api_op_CreateLocationEfs.go | 34 +- .../api_op_CreateLocationFsxWindows.go | 28 +- service/datasync/api_op_CreateLocationNfs.go | 16 +- .../api_op_CreateLocationObjectStorage.go | 38 +- service/datasync/api_op_CreateLocationS3.go | 10 +- service/datasync/api_op_CreateLocationSmb.go | 38 +- service/datasync/api_op_CreateTask.go | 34 +- service/datasync/api_op_DescribeAgent.go | 18 +- .../datasync/api_op_DescribeLocationEfs.go | 10 +- .../api_op_DescribeLocationFsxWindows.go | 22 +- .../datasync/api_op_DescribeLocationNfs.go | 12 +- .../api_op_DescribeLocationObjectStorage.go | 14 +- service/datasync/api_op_DescribeLocationS3.go | 18 +- .../datasync/api_op_DescribeLocationSmb.go | 18 +- service/datasync/api_op_DescribeTask.go | 64 +- .../datasync/api_op_DescribeTaskExecution.go | 68 +- service/datasync/api_op_ListLocations.go | 12 +- .../datasync/api_op_ListTagsForResource.go | 6 +- service/datasync/api_op_StartTaskExecution.go | 20 +- service/datasync/api_op_UpdateTask.go | 24 +- service/datasync/go.mod | 2 +- service/datasync/types/types.go | 200 +- service/dax/api_op_CreateCluster.go | 76 +- service/dax/api_op_CreateSubnetGroup.go | 10 +- .../dax/api_op_DecreaseReplicationFactor.go | 14 +- service/dax/api_op_DescribeClusters.go | 16 +- .../dax/api_op_DescribeDefaultParameters.go | 10 +- service/dax/api_op_DescribeEvents.go | 30 +- service/dax/api_op_DescribeParameterGroups.go | 12 +- service/dax/api_op_DescribeParameters.go | 18 +- service/dax/api_op_DescribeSubnetGroups.go | 16 +- .../dax/api_op_IncreaseReplicationFactor.go | 8 +- service/dax/api_op_RebootNode.go | 8 +- service/dax/api_op_TagResource.go | 8 +- service/dax/api_op_UpdateCluster.go | 28 +- service/dax/api_op_UpdateSubnetGroup.go | 10 +- service/dax/go.mod | 2 +- service/dax/types/types.go | 172 +- service/detective/api_op_CreateMembers.go | 28 +- service/detective/api_op_DeleteMembers.go | 10 +- service/detective/api_op_GetMembers.go | 10 +- service/detective/api_op_ListInvitations.go | 10 +- service/detective/api_op_ListMembers.go | 10 +- .../detective/api_op_StartMonitoringMember.go | 10 +- service/detective/go.mod | 2 +- service/detective/types/types.go | 44 +- service/devicefarm/api_op_CreateDevicePool.go | 22 +- .../api_op_CreateInstanceProfile.go | 22 +- .../devicefarm/api_op_CreateNetworkProfile.go | 50 +- service/devicefarm/api_op_CreateProject.go | 10 +- .../api_op_CreateRemoteAccessSession.go | 66 +- .../devicefarm/api_op_CreateTestGridUrl.go | 10 +- service/devicefarm/api_op_CreateUpload.go | 16 +- .../api_op_CreateVPCEConfiguration.go | 20 +- .../api_op_GetDevicePoolCompatibility.go | 16 +- .../devicefarm/api_op_GetOfferingStatus.go | 6 +- .../devicefarm/api_op_GetTestGridSession.go | 6 +- service/devicefarm/api_op_ListArtifacts.go | 8 +- .../devicefarm/api_op_ListDeviceInstances.go | 8 +- service/devicefarm/api_op_ListDevicePools.go | 18 +- service/devicefarm/api_op_ListDevices.go | 14 +- service/devicefarm/api_op_ListJobs.go | 14 +- .../devicefarm/api_op_ListNetworkProfiles.go | 16 +- .../api_op_ListOfferingPromotions.go | 6 +- service/devicefarm/api_op_ListOfferings.go | 6 +- service/devicefarm/api_op_ListProjects.go | 14 +- .../api_op_ListRemoteAccessSessions.go | 16 +- service/devicefarm/api_op_ListSamples.go | 8 +- .../devicefarm/api_op_ListTestGridProjects.go | 12 +- .../api_op_ListTestGridSessionActions.go | 6 +- .../api_op_ListTestGridSessionArtifacts.go | 12 +- .../devicefarm/api_op_ListTestGridSessions.go | 28 +- service/devicefarm/api_op_ListTests.go | 8 +- .../devicefarm/api_op_ListUniqueProblems.go | 18 +- service/devicefarm/api_op_ListUploads.go | 18 +- .../api_op_ListVPCEConfigurations.go | 8 +- service/devicefarm/api_op_PurchaseOffering.go | 6 +- service/devicefarm/api_op_ScheduleRun.go | 28 +- service/devicefarm/api_op_TagResource.go | 14 +- .../devicefarm/api_op_UpdateDeviceInstance.go | 12 +- service/devicefarm/api_op_UpdateDevicePool.go | 30 +- .../api_op_UpdateInstanceProfile.go | 22 +- .../devicefarm/api_op_UpdateNetworkProfile.go | 38 +- service/devicefarm/api_op_UpdateProject.go | 10 +- service/devicefarm/api_op_UpdateUpload.go | 16 +- .../api_op_UpdateVPCEConfiguration.go | 16 +- service/devicefarm/go.mod | 2 +- service/devicefarm/types/types.go | 1264 +-- ...DirectConnectGatewayAssociationProposal.go | 22 +- ...api_op_AllocateConnectionOnInterconnect.go | 80 +- .../api_op_AllocateHostedConnection.go | 90 +- .../api_op_AllocatePrivateVirtualInterface.go | 140 +- .../api_op_AllocatePublicVirtualInterface.go | 140 +- .../api_op_AllocateTransitVirtualInterface.go | 8 +- .../api_op_AssociateConnectionWithLag.go | 68 +- .../api_op_AssociateHostedConnection.go | 60 +- .../api_op_AssociateVirtualInterface.go | 140 +- .../api_op_ConfirmPrivateVirtualInterface.go | 6 +- .../api_op_ConfirmTransitVirtualInterface.go | 8 +- .../directconnect/api_op_CreateConnection.go | 80 +- .../api_op_CreateDirectConnectGateway.go | 10 +- ...p_CreateDirectConnectGatewayAssociation.go | 12 +- ...DirectConnectGatewayAssociationProposal.go | 18 +- .../api_op_CreateInterconnect.go | 50 +- service/directconnect/api_op_CreateLag.go | 96 +- .../api_op_CreatePrivateVirtualInterface.go | 132 +- .../api_op_CreatePublicVirtualInterface.go | 132 +- .../api_op_CreateTransitVirtualInterface.go | 8 +- service/directconnect/api_op_DeleteBGPPeer.go | 12 +- .../directconnect/api_op_DeleteConnection.go | 60 +- ...p_DeleteDirectConnectGatewayAssociation.go | 8 +- service/directconnect/api_op_DeleteLag.go | 54 +- .../api_op_DescribeConnectionLoa.go | 16 +- ...irectConnectGatewayAssociationProposals.go | 16 +- ...escribeDirectConnectGatewayAssociations.go | 18 +- ...DescribeDirectConnectGatewayAttachments.go | 6 +- .../api_op_DescribeInterconnectLoa.go | 8 +- service/directconnect/api_op_DescribeLoa.go | 8 +- .../api_op_DescribeVirtualInterfaces.go | 6 +- .../api_op_DisassociateConnectionFromLag.go | 60 +- .../api_op_ListVirtualInterfaceTestHistory.go | 12 +- .../api_op_StartBgpFailoverTest.go | 8 +- service/directconnect/api_op_TagResource.go | 8 +- service/directconnect/api_op_UntagResource.go | 8 +- ...p_UpdateDirectConnectGatewayAssociation.go | 8 +- service/directconnect/api_op_UpdateLag.go | 64 +- ...api_op_UpdateVirtualInterfaceAttributes.go | 132 +- service/directconnect/go.mod | 2 +- service/directconnect/types/types.go | 710 +- .../api_op_ConnectDirectory.go | 24 +- .../directoryservice/api_op_CreateAlias.go | 10 +- .../directoryservice/api_op_CreateComputer.go | 16 +- .../api_op_CreateDirectory.go | 22 +- .../api_op_CreateMicrosoftAD.go | 24 +- .../directoryservice/api_op_CreateSnapshot.go | 6 +- .../directoryservice/api_op_CreateTrust.go | 18 +- .../directoryservice/api_op_DeleteTrust.go | 6 +- .../api_op_DeregisterCertificate.go | 8 +- .../api_op_DeregisterEventTopic.go | 10 +- .../api_op_DescribeConditionalForwarders.go | 10 +- .../api_op_DescribeDirectories.go | 24 +- .../api_op_DescribeDomainControllers.go | 8 +- .../api_op_DescribeLDAPSSettings.go | 22 +- .../api_op_DescribeSharedDirectories.go | 24 +- .../api_op_DescribeSnapshots.go | 8 +- .../directoryservice/api_op_DescribeTrusts.go | 10 +- service/directoryservice/api_op_DisableSso.go | 20 +- .../directoryservice/api_op_EnableLDAPS.go | 10 +- .../directoryservice/api_op_EnableRadius.go | 8 +- service/directoryservice/api_op_EnableSso.go | 10 +- .../api_op_ListCertificates.go | 18 +- .../directoryservice/api_op_ListIpRoutes.go | 6 +- .../api_op_ListLogSubscriptions.go | 12 +- .../api_op_ListSchemaExtensions.go | 8 +- .../api_op_ListTagsForResource.go | 6 +- .../api_op_RegisterCertificate.go | 8 +- .../api_op_RegisterEventTopic.go | 10 +- .../directoryservice/api_op_RemoveIpRoutes.go | 8 +- .../api_op_ResetUserPassword.go | 10 +- .../directoryservice/api_op_ShareDirectory.go | 14 +- .../api_op_StartSchemaExtension.go | 24 +- .../api_op_UpdateConditionalForwarder.go | 12 +- .../api_op_UpdateNumberOfDomainControllers.go | 10 +- .../directoryservice/api_op_UpdateRadius.go | 10 +- .../directoryservice/api_op_UpdateTrust.go | 6 +- service/directoryservice/go.mod | 2 +- service/directoryservice/types/types.go | 452 +- service/dlm/api_op_CreateLifecyclePolicy.go | 16 +- service/dlm/api_op_GetLifecyclePolicies.go | 14 +- service/dlm/api_op_TagResource.go | 8 +- service/dlm/api_op_UntagResource.go | 8 +- service/dlm/api_op_UpdateLifecyclePolicy.go | 14 +- service/dlm/go.mod | 2 +- service/dlm/types/types.go | 118 +- service/docdb/api_op_AddTagsToResource.go | 10 +- .../api_op_CopyDBClusterParameterGroup.go | 14 +- service/docdb/api_op_CopyDBClusterSnapshot.go | 74 +- service/docdb/api_op_CreateDBCluster.go | 94 +- .../api_op_CreateDBClusterParameterGroup.go | 16 +- .../docdb/api_op_CreateDBClusterSnapshot.go | 6 +- service/docdb/api_op_CreateDBInstance.go | 72 +- service/docdb/api_op_CreateDBSubnetGroup.go | 6 +- service/docdb/api_op_DeleteDBCluster.go | 26 +- service/docdb/api_op_DescribeCertificates.go | 10 +- ...api_op_DescribeDBClusterParameterGroups.go | 12 +- .../api_op_DescribeDBClusterParameters.go | 30 +- .../api_op_DescribeDBClusterSnapshots.go | 44 +- service/docdb/api_op_DescribeDBClusters.go | 26 +- .../docdb/api_op_DescribeDBEngineVersions.go | 54 +- service/docdb/api_op_DescribeDBInstances.go | 32 +- .../docdb/api_op_DescribeDBSubnetGroups.go | 22 +- ..._DescribeEngineDefaultClusterParameters.go | 6 +- service/docdb/api_op_DescribeEvents.go | 46 +- ...i_op_DescribeOrderableDBInstanceOptions.go | 42 +- ...pi_op_DescribePendingMaintenanceActions.go | 28 +- service/docdb/api_op_ListTagsForResource.go | 6 +- service/docdb/api_op_ModifyDBCluster.go | 112 +- .../api_op_ModifyDBClusterParameterGroup.go | 8 +- ...api_op_ModifyDBClusterSnapshotAttribute.go | 16 +- service/docdb/api_op_ModifyDBInstance.go | 80 +- service/docdb/api_op_ModifyDBSubnetGroup.go | 6 +- .../api_op_ResetDBClusterParameterGroup.go | 10 +- .../api_op_RestoreDBClusterFromSnapshot.go | 66 +- .../api_op_RestoreDBClusterToPointInTime.go | 90 +- service/docdb/go.mod | 2 +- service/docdb/types/types.go | 572 +- service/dynamodb/api_op_BatchGetItem.go | 10 +- service/dynamodb/api_op_BatchWriteItem.go | 88 +- service/dynamodb/api_op_CreateBackup.go | 8 +- service/dynamodb/api_op_CreateTable.go | 92 +- service/dynamodb/api_op_DeleteItem.go | 150 +- .../api_op_DescribeContributorInsights.go | 26 +- .../api_op_DescribeGlobalTableSettings.go | 6 +- service/dynamodb/api_op_DescribeLimits.go | 16 +- service/dynamodb/api_op_GetItem.go | 46 +- service/dynamodb/api_op_ListBackups.go | 18 +- .../api_op_ListContributorInsights.go | 12 +- service/dynamodb/api_op_ListTables.go | 22 +- service/dynamodb/api_op_ListTagsOfResource.go | 10 +- service/dynamodb/api_op_PutItem.go | 190 +- service/dynamodb/api_op_Query.go | 298 +- .../dynamodb/api_op_RestoreTableFromBackup.go | 28 +- .../api_op_RestoreTableToPointInTime.go | 38 +- service/dynamodb/api_op_Scan.go | 304 +- service/dynamodb/api_op_TagResource.go | 10 +- .../api_op_UpdateContinuousBackups.go | 8 +- .../api_op_UpdateContributorInsights.go | 6 +- .../api_op_UpdateGlobalTableSettings.go | 34 +- service/dynamodb/api_op_UpdateItem.go | 232 +- service/dynamodb/api_op_UpdateTable.go | 40 +- .../api_op_UpdateTableReplicaAutoScaling.go | 16 +- service/dynamodb/api_op_UpdateTimeToLive.go | 10 +- service/dynamodb/go.mod | 4 +- service/dynamodb/types/types.go | 1238 +-- .../dynamodbstreams/api_op_DescribeStream.go | 6 +- service/dynamodbstreams/api_op_GetRecords.go | 6 +- .../api_op_GetShardIterator.go | 16 +- service/dynamodbstreams/api_op_ListStreams.go | 6 +- service/dynamodbstreams/go.mod | 2 +- service/dynamodbstreams/types/types.go | 154 +- service/ebs/api_op_CompleteSnapshot.go | 20 +- service/ebs/api_op_GetSnapshotBlock.go | 18 +- service/ebs/api_op_ListChangedBlocks.go | 36 +- service/ebs/api_op_ListSnapshotBlocks.go | 28 +- service/ebs/api_op_PutSnapshotBlock.go | 46 +- service/ebs/api_op_StartSnapshot.go | 54 +- service/ebs/go.mod | 2 +- service/ebs/types/types.go | 6 +- ...op_AcceptReservedInstancesExchangeQuote.go | 8 +- .../ec2/api_op_AcceptVpcPeeringConnection.go | 8 +- service/ec2/api_op_AllocateAddress.go | 62 +- service/ec2/api_op_AllocateHosts.go | 46 +- ...ySecurityGroupsToClientVpnTargetNetwork.go | 10 +- service/ec2/api_op_AssignIpv6Addresses.go | 14 +- .../ec2/api_op_AssignPrivateIpAddresses.go | 10 +- service/ec2/api_op_AssociateAddress.go | 26 +- .../api_op_AssociateClientVpnTargetNetwork.go | 20 +- service/ec2/api_op_AssociateDhcpOptions.go | 10 +- .../ec2/api_op_AssociateIamInstanceProfile.go | 8 +- service/ec2/api_op_AssociateRouteTable.go | 24 +- .../ec2/api_op_AssociateSubnetCidrBlock.go | 6 +- ..._AssociateTransitGatewayMulticastDomain.go | 6 +- ...pi_op_AssociateTransitGatewayRouteTable.go | 18 +- service/ec2/api_op_AssociateVpcCidrBlock.go | 38 +- service/ec2/api_op_AttachClassicLinkVpc.go | 12 +- service/ec2/api_op_AttachInternetGateway.go | 12 +- service/ec2/api_op_AttachNetworkInterface.go | 20 +- service/ec2/api_op_AttachVolume.go | 28 +- service/ec2/api_op_AttachVpnGateway.go | 10 +- .../ec2/api_op_AuthorizeClientVpnIngress.go | 26 +- .../api_op_AuthorizeSecurityGroupEgress.go | 40 +- .../api_op_AuthorizeSecurityGroupIngress.go | 76 +- service/ec2/api_op_BundleInstance.go | 18 +- service/ec2/api_op_CancelBundleTask.go | 10 +- .../ec2/api_op_CancelCapacityReservation.go | 10 +- service/ec2/api_op_CancelConversionTask.go | 12 +- service/ec2/api_op_CancelImportTask.go | 14 +- service/ec2/api_op_CancelSpotFleetRequests.go | 12 +- .../ec2/api_op_CancelSpotInstanceRequests.go | 10 +- service/ec2/api_op_ConfirmProductInstance.go | 8 +- service/ec2/api_op_CopyFpgaImage.go | 22 +- service/ec2/api_op_CopyImage.go | 30 +- service/ec2/api_op_CopySnapshot.go | 82 +- .../ec2/api_op_CreateCapacityReservation.go | 100 +- service/ec2/api_op_CreateClientVpnEndpoint.go | 84 +- service/ec2/api_op_CreateClientVpnRoute.go | 18 +- service/ec2/api_op_CreateCustomerGateway.go | 36 +- service/ec2/api_op_CreateDhcpOptions.go | 6 +- service/ec2/api_op_CreateFleet.go | 66 +- service/ec2/api_op_CreateFlowLogs.go | 104 +- service/ec2/api_op_CreateFpgaImage.go | 22 +- service/ec2/api_op_CreateImage.go | 36 +- .../ec2/api_op_CreateInstanceExportTask.go | 16 +- service/ec2/api_op_CreateKeyPair.go | 12 +- service/ec2/api_op_CreateLaunchTemplate.go | 24 +- .../ec2/api_op_CreateLaunchTemplateVersion.go | 44 +- service/ec2/api_op_CreateLocalGatewayRoute.go | 16 +- ...ateLocalGatewayRouteTableVpcAssociation.go | 10 +- service/ec2/api_op_CreateManagedPrefixList.go | 24 +- service/ec2/api_op_CreateNatGateway.go | 22 +- service/ec2/api_op_CreateNetworkAcl.go | 10 +- service/ec2/api_op_CreateNetworkAclEntry.go | 48 +- service/ec2/api_op_CreateNetworkInterface.go | 52 +- ...api_op_CreateNetworkInterfacePermission.go | 20 +- service/ec2/api_op_CreatePlacementGroup.go | 16 +- .../api_op_CreateReservedInstancesListing.go | 20 +- service/ec2/api_op_CreateRoute.go | 52 +- service/ec2/api_op_CreateRouteTable.go | 6 +- service/ec2/api_op_CreateSecurityGroup.go | 12 +- service/ec2/api_op_CreateSnapshot.go | 78 +- service/ec2/api_op_CreateSnapshots.go | 22 +- .../api_op_CreateSpotDatafeedSubscription.go | 6 +- service/ec2/api_op_CreateSubnet.go | 36 +- .../ec2/api_op_CreateTrafficMirrorFilter.go | 12 +- .../api_op_CreateTrafficMirrorFilterRule.go | 66 +- .../ec2/api_op_CreateTrafficMirrorSession.go | 58 +- .../ec2/api_op_CreateTrafficMirrorTarget.go | 26 +- service/ec2/api_op_CreateTransitGateway.go | 8 +- ..._op_CreateTransitGatewayMulticastDomain.go | 10 +- ...p_CreateTransitGatewayPeeringAttachment.go | 22 +- .../ec2/api_op_CreateTransitGatewayRoute.go | 16 +- ...pi_op_CreateTransitGatewayVpcAttachment.go | 32 +- service/ec2/api_op_CreateVolume.go | 146 +- service/ec2/api_op_CreateVpc.go | 36 +- service/ec2/api_op_CreateVpcEndpoint.go | 44 +- ...CreateVpcEndpointConnectionNotification.go | 28 +- ...p_CreateVpcEndpointServiceConfiguration.go | 14 +- .../ec2/api_op_CreateVpcPeeringConnection.go | 28 +- service/ec2/api_op_CreateVpnConnection.go | 18 +- .../ec2/api_op_CreateVpnConnectionRoute.go | 8 +- service/ec2/api_op_CreateVpnGateway.go | 18 +- service/ec2/api_op_DeleteClientVpnRoute.go | 20 +- service/ec2/api_op_DeleteFleets.go | 6 +- service/ec2/api_op_DeleteKeyPair.go | 12 +- service/ec2/api_op_DeleteLaunchTemplate.go | 16 +- .../api_op_DeleteLaunchTemplateVersions.go | 22 +- service/ec2/api_op_DeleteLocalGatewayRoute.go | 10 +- service/ec2/api_op_DeleteNatGateway.go | 10 +- service/ec2/api_op_DeleteNetworkAcl.go | 10 +- service/ec2/api_op_DeleteNetworkAclEntry.go | 14 +- service/ec2/api_op_DeleteNetworkInterface.go | 10 +- ...api_op_DeleteNetworkInterfacePermission.go | 8 +- .../api_op_DeleteQueuedReservedInstances.go | 6 +- service/ec2/api_op_DeleteRoute.go | 24 +- service/ec2/api_op_DeleteSecurityGroup.go | 8 +- service/ec2/api_op_DeleteSnapshot.go | 10 +- service/ec2/api_op_DeleteSubnet.go | 10 +- service/ec2/api_op_DeleteTags.go | 12 +- .../ec2/api_op_DeleteTrafficMirrorFilter.go | 10 +- .../ec2/api_op_DeleteTrafficMirrorSession.go | 10 +- ..._op_DeleteTransitGatewayMulticastDomain.go | 10 +- .../ec2/api_op_DeleteTransitGatewayRoute.go | 10 +- .../api_op_DeleteTransitGatewayRouteTable.go | 10 +- service/ec2/api_op_DeleteVpc.go | 10 +- ...eleteVpcEndpointConnectionNotifications.go | 10 +- .../ec2/api_op_DeleteVpcPeeringConnection.go | 10 +- .../ec2/api_op_DeleteVpnConnectionRoute.go | 8 +- ...sterInstanceEventNotificationAttributes.go | 6 +- ...sterTransitGatewayMulticastGroupSources.go | 16 +- service/ec2/api_op_DescribeAddresses.go | 18 +- .../ec2/api_op_DescribeAvailabilityZones.go | 16 +- service/ec2/api_op_DescribeByoipCidrs.go | 18 +- .../api_op_DescribeCapacityReservations.go | 28 +- .../api_op_DescribeClassicLinkInstances.go | 22 +- ..._op_DescribeClientVpnAuthorizationRules.go | 22 +- .../api_op_DescribeClientVpnConnections.go | 24 +- .../ec2/api_op_DescribeClientVpnEndpoints.go | 10 +- service/ec2/api_op_DescribeClientVpnRoutes.go | 16 +- .../api_op_DescribeClientVpnTargetNetworks.go | 34 +- service/ec2/api_op_DescribeCoipPools.go | 22 +- service/ec2/api_op_DescribeConversionTasks.go | 6 +- .../ec2/api_op_DescribeCustomerGateways.go | 6 +- service/ec2/api_op_DescribeDhcpOptions.go | 24 +- ...i_op_DescribeEgressOnlyInternetGateways.go | 28 +- service/ec2/api_op_DescribeElasticGpus.go | 28 +- .../ec2/api_op_DescribeExportImageTasks.go | 12 +- service/ec2/api_op_DescribeExportTasks.go | 6 +- .../api_op_DescribeFastSnapshotRestores.go | 24 +- service/ec2/api_op_DescribeFleetHistory.go | 32 +- service/ec2/api_op_DescribeFleetInstances.go | 16 +- service/ec2/api_op_DescribeFleets.go | 18 +- service/ec2/api_op_DescribeFlowLogs.go | 20 +- .../ec2/api_op_DescribeFpgaImageAttribute.go | 18 +- service/ec2/api_op_DescribeFpgaImages.go | 32 +- ...api_op_DescribeHostReservationOfferings.go | 30 +- service/ec2/api_op_DescribeHosts.go | 10 +- ..._DescribeIamInstanceProfileAssociations.go | 14 +- .../ec2/api_op_DescribeIdentityIdFormat.go | 10 +- service/ec2/api_op_DescribeImageAttribute.go | 48 +- service/ec2/api_op_DescribeImages.go | 24 +- .../ec2/api_op_DescribeImportImageTasks.go | 18 +- .../ec2/api_op_DescribeImportSnapshotTasks.go | 26 +- .../ec2/api_op_DescribeInstanceAttribute.go | 64 +- ...op_DescribeInstanceCreditSpecifications.go | 22 +- service/ec2/api_op_DescribeInstanceStatus.go | 28 +- .../api_op_DescribeInstanceTypeOfferings.go | 24 +- service/ec2/api_op_DescribeInstanceTypes.go | 34 +- service/ec2/api_op_DescribeInstances.go | 20 +- .../ec2/api_op_DescribeInternetGateways.go | 8 +- service/ec2/api_op_DescribeIpv6Pools.go | 18 +- service/ec2/api_op_DescribeKeyPairs.go | 6 +- .../api_op_DescribeLaunchTemplateVersions.go | 56 +- service/ec2/api_op_DescribeLaunchTemplates.go | 32 +- ...eTableVirtualInterfaceGroupAssociations.go | 20 +- ...beLocalGatewayRouteTableVpcAssociations.go | 20 +- .../api_op_DescribeLocalGatewayRouteTables.go | 14 +- ...cribeLocalGatewayVirtualInterfaceGroups.go | 22 +- ...p_DescribeLocalGatewayVirtualInterfaces.go | 8 +- service/ec2/api_op_DescribeLocalGateways.go | 12 +- .../ec2/api_op_DescribeManagedPrefixLists.go | 6 +- service/ec2/api_op_DescribeMovingAddresses.go | 22 +- service/ec2/api_op_DescribeNatGateways.go | 22 +- service/ec2/api_op_DescribeNetworkAcls.go | 12 +- ...pi_op_DescribeNetworkInterfaceAttribute.go | 14 +- ..._op_DescribeNetworkInterfacePermissions.go | 22 +- .../ec2/api_op_DescribeNetworkInterfaces.go | 26 +- service/ec2/api_op_DescribePlacementGroups.go | 14 +- service/ec2/api_op_DescribePrefixLists.go | 22 +- .../ec2/api_op_DescribePrincipalIdFormat.go | 20 +- service/ec2/api_op_DescribePublicIpv4Pools.go | 12 +- service/ec2/api_op_DescribeRegions.go | 16 +- .../ec2/api_op_DescribeReservedInstances.go | 18 +- ...pi_op_DescribeReservedInstancesListings.go | 6 +- ..._DescribeReservedInstancesModifications.go | 12 +- ...i_op_DescribeReservedInstancesOfferings.go | 86 +- service/ec2/api_op_DescribeRouteTables.go | 12 +- ...p_DescribeScheduledInstanceAvailability.go | 36 +- .../ec2/api_op_DescribeScheduledInstances.go | 30 +- .../api_op_DescribeSecurityGroupReferences.go | 10 +- service/ec2/api_op_DescribeSecurityGroups.go | 52 +- .../ec2/api_op_DescribeSnapshotAttribute.go | 20 +- service/ec2/api_op_DescribeSnapshots.go | 38 +- .../ec2/api_op_DescribeSpotFleetInstances.go | 18 +- .../api_op_DescribeSpotFleetRequestHistory.go | 32 +- .../api_op_DescribeSpotInstanceRequests.go | 30 +- .../ec2/api_op_DescribeSpotPriceHistory.go | 38 +- .../ec2/api_op_DescribeStaleSecurityGroups.go | 22 +- service/ec2/api_op_DescribeSubnets.go | 20 +- service/ec2/api_op_DescribeTags.go | 18 +- .../api_op_DescribeTrafficMirrorFilters.go | 28 +- .../api_op_DescribeTrafficMirrorSessions.go | 20 +- .../api_op_DescribeTrafficMirrorTargets.go | 26 +- ...pi_op_DescribeTransitGatewayAttachments.go | 20 +- ..._DescribeTransitGatewayMulticastDomains.go | 26 +- ...escribeTransitGatewayPeeringAttachments.go | 20 +- ...pi_op_DescribeTransitGatewayRouteTables.go | 28 +- ...op_DescribeTransitGatewayVpcAttachments.go | 20 +- service/ec2/api_op_DescribeTransitGateways.go | 12 +- service/ec2/api_op_DescribeVolumeAttribute.go | 16 +- service/ec2/api_op_DescribeVolumeStatus.go | 24 +- service/ec2/api_op_DescribeVolumes.go | 34 +- .../api_op_DescribeVolumesModifications.go | 24 +- service/ec2/api_op_DescribeVpcAttribute.go | 22 +- service/ec2/api_op_DescribeVpcClassicLink.go | 12 +- ...api_op_DescribeVpcClassicLinkDnsSupport.go | 12 +- ...cribeVpcEndpointConnectionNotifications.go | 18 +- .../api_op_DescribeVpcEndpointConnections.go | 18 +- ...escribeVpcEndpointServiceConfigurations.go | 6 +- ...p_DescribeVpcEndpointServicePermissions.go | 28 +- .../ec2/api_op_DescribeVpcEndpointServices.go | 24 +- service/ec2/api_op_DescribeVpcEndpoints.go | 6 +- .../api_op_DescribeVpcPeeringConnections.go | 14 +- service/ec2/api_op_DescribeVpcs.go | 12 +- service/ec2/api_op_DescribeVpnGateways.go | 8 +- service/ec2/api_op_DetachClassicLinkVpc.go | 10 +- service/ec2/api_op_DetachInternetGateway.go | 12 +- service/ec2/api_op_DetachNetworkInterface.go | 10 +- service/ec2/api_op_DetachVolume.go | 22 +- service/ec2/api_op_DetachVpnGateway.go | 8 +- .../ec2/api_op_DisableFastSnapshotRestores.go | 20 +- ...ableTransitGatewayRouteTablePropagation.go | 12 +- .../ec2/api_op_DisableVgwRoutePropagation.go | 12 +- ...i_op_DisassociateClientVpnTargetNetwork.go | 12 +- ...sassociateTransitGatewayMulticastDomain.go | 8 +- ...op_DisassociateTransitGatewayRouteTable.go | 10 +- .../ec2/api_op_DisassociateVpcCidrBlock.go | 6 +- .../ec2/api_op_EnableFastSnapshotRestores.go | 12 +- ...ableTransitGatewayRouteTablePropagation.go | 18 +- .../ec2/api_op_EnableVgwRoutePropagation.go | 12 +- service/ec2/api_op_EnableVolumeIO.go | 10 +- service/ec2/api_op_EnableVpcClassicLink.go | 10 +- ...lientVpnClientCertificateRevocationList.go | 6 +- service/ec2/api_op_ExportImage.go | 72 +- .../ec2/api_op_ExportTransitGatewayRoutes.go | 10 +- .../ec2/api_op_GetAssociatedIpv6PoolCidrs.go | 18 +- .../ec2/api_op_GetCapacityReservationUsage.go | 36 +- service/ec2/api_op_GetCoipPoolUsage.go | 24 +- service/ec2/api_op_GetConsoleOutput.go | 14 +- service/ec2/api_op_GetConsoleScreenshot.go | 16 +- .../api_op_GetGroupsForCapacityReservation.go | 14 +- ...pi_op_GetHostReservationPurchasePreview.go | 6 +- ...api_op_GetManagedPrefixListAssociations.go | 20 +- .../ec2/api_op_GetManagedPrefixListEntries.go | 22 +- service/ec2/api_op_GetPasswordData.go | 6 +- ...pi_op_GetReservedInstancesExchangeQuote.go | 38 +- ...GetTransitGatewayAttachmentPropagations.go | 18 +- ...ansitGatewayMulticastDomainAssociations.go | 20 +- ...GetTransitGatewayRouteTableAssociations.go | 28 +- ...GetTransitGatewayRouteTablePropagations.go | 14 +- ...lientVpnClientCertificateRevocationList.go | 16 +- service/ec2/api_op_ImportImage.go | 116 +- service/ec2/api_op_ImportInstance.go | 16 +- service/ec2/api_op_ImportKeyPair.go | 22 +- service/ec2/api_op_ImportSnapshot.go | 30 +- service/ec2/api_op_ImportVolume.go | 24 +- .../ec2/api_op_ModifyAvailabilityZoneGroup.go | 10 +- .../ec2/api_op_ModifyCapacityReservation.go | 26 +- service/ec2/api_op_ModifyClientVpnEndpoint.go | 44 +- ...api_op_ModifyDefaultCreditSpecification.go | 12 +- service/ec2/api_op_ModifyFleet.go | 20 +- .../ec2/api_op_ModifyFpgaImageAttribute.go | 26 +- service/ec2/api_op_ModifyHosts.go | 28 +- service/ec2/api_op_ModifyIdFormat.go | 10 +- service/ec2/api_op_ModifyIdentityIdFormat.go | 12 +- service/ec2/api_op_ModifyImageAttribute.go | 36 +- service/ec2/api_op_ModifyInstanceAttribute.go | 108 +- ...fyInstanceCapacityReservationAttributes.go | 8 +- ...pi_op_ModifyInstanceCreditSpecification.go | 10 +- .../api_op_ModifyInstanceEventStartTime.go | 18 +- .../api_op_ModifyInstanceMetadataOptions.go | 36 +- service/ec2/api_op_ModifyInstancePlacement.go | 20 +- service/ec2/api_op_ModifyLaunchTemplate.go | 22 +- service/ec2/api_op_ModifyManagedPrefixList.go | 6 +- .../api_op_ModifyNetworkInterfaceAttribute.go | 38 +- service/ec2/api_op_ModifyReservedInstances.go | 8 +- service/ec2/api_op_ModifySnapshotAttribute.go | 18 +- service/ec2/api_op_ModifySpotFleetRequest.go | 12 +- service/ec2/api_op_ModifySubnetAttribute.go | 8 +- ...odifyTrafficMirrorFilterNetworkServices.go | 6 +- .../api_op_ModifyTrafficMirrorFilterRule.go | 58 +- .../ec2/api_op_ModifyTrafficMirrorSession.go | 40 +- ...pi_op_ModifyTransitGatewayVpcAttachment.go | 12 +- service/ec2/api_op_ModifyVolume.go | 22 +- service/ec2/api_op_ModifyVolumeAttribute.go | 6 +- service/ec2/api_op_ModifyVpcAttribute.go | 18 +- service/ec2/api_op_ModifyVpcEndpoint.go | 42 +- ...ModifyVpcEndpointConnectionNotification.go | 12 +- ...p_ModifyVpcEndpointServiceConfiguration.go | 24 +- ..._op_ModifyVpcEndpointServicePermissions.go | 18 +- ...pi_op_ModifyVpcPeeringConnectionOptions.go | 6 +- service/ec2/api_op_ModifyVpnConnection.go | 16 +- .../ec2/api_op_ModifyVpnTunnelCertificate.go | 10 +- service/ec2/api_op_ModifyVpnTunnelOptions.go | 14 +- service/ec2/api_op_MonitorInstances.go | 10 +- service/ec2/api_op_MoveAddressToVpc.go | 6 +- service/ec2/api_op_ProvisionByoipCidr.go | 36 +- service/ec2/api_op_PurchaseHostReservation.go | 46 +- ...pi_op_PurchaseReservedInstancesOffering.go | 18 +- .../ec2/api_op_PurchaseScheduledInstances.go | 10 +- service/ec2/api_op_RebootInstances.go | 10 +- service/ec2/api_op_RegisterImage.go | 72 +- ...sterTransitGatewayMulticastGroupMembers.go | 14 +- ...sterTransitGatewayMulticastGroupSources.go | 6 +- ...pi_op_RejectTransitGatewayVpcAttachment.go | 10 +- .../api_op_RejectVpcEndpointConnections.go | 10 +- .../ec2/api_op_RejectVpcPeeringConnection.go | 10 +- service/ec2/api_op_ReleaseAddress.go | 6 +- ...op_ReplaceIamInstanceProfileAssociation.go | 8 +- .../api_op_ReplaceNetworkAclAssociation.go | 12 +- service/ec2/api_op_ReplaceNetworkAclEntry.go | 44 +- service/ec2/api_op_ReplaceRoute.go | 42 +- .../api_op_ReplaceRouteTableAssociation.go | 18 +- .../ec2/api_op_ReplaceTransitGatewayRoute.go | 16 +- service/ec2/api_op_ReportInstanceStatus.go | 16 +- service/ec2/api_op_RequestSpotInstances.go | 100 +- service/ec2/api_op_ResetFpgaImageAttribute.go | 12 +- service/ec2/api_op_ResetInstanceAttribute.go | 22 +- .../api_op_ResetNetworkInterfaceAttribute.go | 10 +- service/ec2/api_op_ResetSnapshotAttribute.go | 12 +- service/ec2/api_op_RestoreAddressToClassic.go | 6 +- .../api_op_RestoreManagedPrefixListVersion.go | 10 +- service/ec2/api_op_RevokeClientVpnIngress.go | 6 +- .../ec2/api_op_RevokeSecurityGroupEgress.go | 20 +- .../ec2/api_op_RevokeSecurityGroupIngress.go | 52 +- service/ec2/api_op_RunInstances.go | 310 +- service/ec2/api_op_RunScheduledInstances.go | 18 +- ..._op_SearchTransitGatewayMulticastGroups.go | 26 +- .../ec2/api_op_SearchTransitGatewayRoutes.go | 12 +- service/ec2/api_op_StopInstances.go | 22 +- .../api_op_TerminateClientVpnConnections.go | 12 +- service/ec2/api_op_UnassignIpv6Addresses.go | 8 +- service/ec2/api_op_UnmonitorInstances.go | 10 +- ...dateSecurityGroupRuleDescriptionsEgress.go | 10 +- ...ateSecurityGroupRuleDescriptionsIngress.go | 8 +- service/ec2/api_op_WithdrawByoipCidr.go | 10 +- service/ec2/go.mod | 2 +- service/ec2/types/types.go | 6784 ++++++++--------- .../api_op_SendSSHPublicKey.go | 16 +- service/ec2instanceconnect/go.mod | 2 +- .../ecr/api_op_BatchCheckLayerAvailability.go | 8 +- service/ecr/api_op_BatchDeleteImage.go | 6 +- service/ecr/api_op_BatchGetImage.go | 8 +- service/ecr/api_op_CompleteLayerUpload.go | 28 +- service/ecr/api_op_CreateRepository.go | 30 +- service/ecr/api_op_DeleteLifecyclePolicy.go | 20 +- service/ecr/api_op_DeleteRepository.go | 8 +- service/ecr/api_op_DeleteRepositoryPolicy.go | 10 +- .../ecr/api_op_DescribeImageScanFindings.go | 48 +- service/ecr/api_op_DescribeImages.go | 38 +- service/ecr/api_op_DescribeRepositories.go | 34 +- service/ecr/api_op_GetDownloadUrlForLayer.go | 14 +- service/ecr/api_op_GetLifecyclePolicy.go | 10 +- .../ecr/api_op_GetLifecyclePolicyPreview.go | 26 +- service/ecr/api_op_GetRepositoryPolicy.go | 14 +- service/ecr/api_op_ListImages.go | 34 +- service/ecr/api_op_PutImage.go | 24 +- .../api_op_PutImageScanningConfiguration.go | 12 +- service/ecr/api_op_PutImageTagMutability.go | 6 +- service/ecr/api_op_PutLifecyclePolicy.go | 16 +- service/ecr/api_op_SetRepositoryPolicy.go | 16 +- service/ecr/api_op_StartImageScan.go | 10 +- .../ecr/api_op_StartLifecyclePolicyPreview.go | 18 +- service/ecr/api_op_TagResource.go | 12 +- service/ecr/api_op_UntagResource.go | 10 +- service/ecr/api_op_UploadLayerPart.go | 30 +- service/ecr/go.mod | 2 +- service/ecr/types/types.go | 142 +- service/ecs/api_op_CreateCluster.go | 48 +- service/ecs/api_op_CreateService.go | 224 +- service/ecs/api_op_CreateTaskSet.go | 70 +- service/ecs/api_op_DeleteAccountSetting.go | 14 +- service/ecs/api_op_DeleteAttributes.go | 10 +- service/ecs/api_op_DeleteService.go | 10 +- service/ecs/api_op_DeleteTaskSet.go | 12 +- .../ecs/api_op_DeregisterContainerInstance.go | 10 +- .../ecs/api_op_DescribeCapacityProviders.go | 26 +- service/ecs/api_op_DescribeClusters.go | 14 +- .../ecs/api_op_DescribeContainerInstances.go | 24 +- service/ecs/api_op_DescribeServices.go | 10 +- service/ecs/api_op_DescribeTaskDefinition.go | 6 +- service/ecs/api_op_DescribeTaskSets.go | 18 +- service/ecs/api_op_DescribeTasks.go | 16 +- service/ecs/api_op_ListAccountSettings.go | 32 +- service/ecs/api_op_ListAttributes.go | 38 +- service/ecs/api_op_ListContainerInstances.go | 30 +- service/ecs/api_op_ListServices.go | 16 +- .../ecs/api_op_ListTaskDefinitionFamilies.go | 24 +- service/ecs/api_op_ListTaskDefinitions.go | 36 +- service/ecs/api_op_ListTasks.go | 52 +- service/ecs/api_op_PutAccountSetting.go | 26 +- service/ecs/api_op_PutAttributes.go | 10 +- .../ecs/api_op_PutClusterCapacityProviders.go | 36 +- .../ecs/api_op_RegisterContainerInstance.go | 24 +- service/ecs/api_op_RegisterTaskDefinition.go | 260 +- service/ecs/api_op_RunTask.go | 170 +- service/ecs/api_op_StartTask.go | 56 +- service/ecs/api_op_StopTask.go | 8 +- .../ecs/api_op_SubmitContainerStateChange.go | 26 +- service/ecs/api_op_SubmitTaskStateChange.go | 20 +- service/ecs/api_op_TagResource.go | 14 +- service/ecs/api_op_UntagResource.go | 10 +- .../api_op_UpdateContainerInstancesState.go | 10 +- service/ecs/api_op_UpdateService.go | 114 +- .../ecs/api_op_UpdateServicePrimaryTaskSet.go | 12 +- service/ecs/api_op_UpdateTaskSet.go | 16 +- service/ecs/go.mod | 2 +- service/ecs/types/types.go | 2572 +++---- service/efs/api_op_CreateAccessPoint.go | 56 +- service/efs/api_op_CreateFileSystem.go | 164 +- service/efs/api_op_CreateMountTarget.go | 46 +- service/efs/api_op_DeleteTags.go | 8 +- service/efs/api_op_DescribeAccessPoints.go | 16 +- service/efs/api_op_DescribeFileSystems.go | 16 +- service/efs/api_op_DescribeMountTargets.go | 34 +- service/efs/api_op_DescribeTags.go | 34 +- service/efs/api_op_ListTagsForResource.go | 22 +- .../api_op_ModifyMountTargetSecurityGroups.go | 6 +- service/efs/api_op_PutFileSystemPolicy.go | 16 +- service/efs/api_op_TagResource.go | 8 +- service/efs/api_op_UpdateFileSystem.go | 108 +- service/efs/go.mod | 2 +- service/efs/types/types.go | 162 +- service/eks/api_op_CreateCluster.go | 62 +- service/eks/api_op_CreateFargateProfile.go | 50 +- service/eks/api_op_CreateNodegroup.go | 72 +- service/eks/api_op_DeleteFargateProfile.go | 10 +- service/eks/api_op_DeleteNodegroup.go | 8 +- service/eks/api_op_DescribeFargateProfile.go | 8 +- service/eks/api_op_DescribeNodegroup.go | 8 +- service/eks/api_op_DescribeUpdate.go | 10 +- service/eks/api_op_ListFargateProfiles.go | 6 +- service/eks/api_op_ListNodegroups.go | 18 +- service/eks/api_op_ListUpdates.go | 20 +- service/eks/api_op_TagResource.go | 10 +- service/eks/api_op_UpdateClusterConfig.go | 12 +- service/eks/api_op_UpdateNodegroupConfig.go | 20 +- service/eks/api_op_UpdateNodegroupVersion.go | 42 +- service/eks/go.mod | 2 +- service/eks/types/types.go | 298 +- .../elasticache/api_op_AddTagsToResource.go | 12 +- ...i_op_AuthorizeCacheSecurityGroupIngress.go | 12 +- .../api_op_BatchApplyUpdateAction.go | 18 +- .../api_op_BatchStopUpdateAction.go | 18 +- .../elasticache/api_op_CompleteMigration.go | 10 +- service/elasticache/api_op_CopySnapshot.go | 20 +- .../elasticache/api_op_CreateCacheCluster.go | 262 +- .../api_op_CreateCacheParameterGroup.go | 10 +- .../api_op_CreateCacheSubnetGroup.go | 10 +- .../api_op_CreateReplicationGroup.go | 302 +- service/elasticache/api_op_CreateSnapshot.go | 8 +- ...reaseNodeGroupsInGlobalReplicationGroup.go | 24 +- .../api_op_DecreaseReplicaCount.go | 16 +- .../elasticache/api_op_DeleteCacheCluster.go | 10 +- .../api_op_DeleteReplicationGroup.go | 8 +- .../api_op_DescribeCacheClusters.go | 32 +- .../api_op_DescribeCacheEngineVersions.go | 36 +- .../api_op_DescribeCacheParameterGroups.go | 20 +- .../api_op_DescribeCacheParameters.go | 28 +- .../api_op_DescribeCacheSecurityGroups.go | 14 +- .../api_op_DescribeCacheSubnetGroups.go | 14 +- service/elasticache/api_op_DescribeEvents.go | 30 +- .../api_op_DescribeGlobalReplicationGroups.go | 22 +- .../api_op_DescribeReplicationGroups.go | 24 +- .../api_op_DescribeReservedCacheNodes.go | 62 +- ..._op_DescribeReservedCacheNodesOfferings.go | 28 +- .../api_op_DescribeServiceUpdates.go | 12 +- .../elasticache/api_op_DescribeSnapshots.go | 42 +- .../api_op_DescribeUpdateActions.go | 22 +- ...i_op_DisassociateGlobalReplicationGroup.go | 10 +- .../api_op_FailoverGlobalReplicationGroup.go | 10 +- ...reaseNodeGroupsInGlobalReplicationGroup.go | 18 +- .../api_op_IncreaseReplicaCount.go | 18 +- ...api_op_ListAllowedNodeTypeModifications.go | 28 +- .../elasticache/api_op_ModifyCacheCluster.go | 198 +- .../api_op_ModifyCacheParameterGroup.go | 10 +- .../api_op_ModifyCacheSubnetGroup.go | 6 +- .../api_op_ModifyGlobalReplicationGroup.go | 30 +- .../api_op_ModifyReplicationGroup.go | 158 +- ...odifyReplicationGroupShardConfiguration.go | 28 +- ..._RebalanceSlotsInGlobalReplicationGroup.go | 8 +- .../api_op_ResetCacheParameterGroup.go | 10 +- service/elasticache/go.mod | 2 +- service/elasticache/types/types.go | 1082 +-- .../api_op_ApplyEnvironmentManagedAction.go | 20 +- ...i_op_AssociateEnvironmentOperationsRole.go | 10 +- .../api_op_ComposeEnvironments.go | 12 +- .../api_op_CreateApplication.go | 16 +- .../api_op_CreateApplicationVersion.go | 38 +- .../api_op_CreateConfigurationTemplate.go | 100 +- .../api_op_CreateEnvironment.go | 196 +- .../api_op_CreatePlatformVersion.go | 16 +- .../api_op_DeleteApplicationVersion.go | 10 +- .../api_op_DescribeApplicationVersions.go | 10 +- .../api_op_DescribeConfigurationOptions.go | 28 +- .../api_op_DescribeEnvironmentHealth.go | 42 +- ...DescribeEnvironmentManagedActionHistory.go | 6 +- ...pi_op_DescribeEnvironmentManagedActions.go | 6 +- .../api_op_DescribeEnvironmentResources.go | 10 +- .../api_op_DescribeEnvironments.go | 24 +- .../elasticbeanstalk/api_op_DescribeEvents.go | 60 +- .../api_op_DescribeInstancesHealth.go | 8 +- .../api_op_ListPlatformBranches.go | 12 +- .../api_op_ListPlatformVersions.go | 6 +- .../api_op_RebuildEnvironment.go | 10 +- .../api_op_RequestEnvironmentInfo.go | 12 +- .../api_op_RetrieveEnvironmentInfo.go | 10 +- .../api_op_SwapEnvironmentCNAMEs.go | 16 +- .../api_op_TerminateEnvironment.go | 108 +- .../api_op_UpdateApplication.go | 8 +- ...i_op_UpdateApplicationResourceLifecycle.go | 8 +- .../api_op_UpdateApplicationVersion.go | 6 +- .../api_op_UpdateConfigurationTemplate.go | 50 +- .../api_op_UpdateEnvironment.go | 174 +- .../api_op_UpdateTagsForResource.go | 12 +- .../api_op_ValidateConfigurationSettings.go | 16 +- service/elasticbeanstalk/go.mod | 2 +- service/elasticbeanstalk/types/types.go | 806 +- .../api_op_DescribeAccelerators.go | 6 +- .../elasticinference/api_op_TagResource.go | 8 +- .../elasticinference/api_op_UntagResource.go | 8 +- service/elasticinference/go.mod | 2 +- service/elasticinference/types/types.go | 26 +- .../elasticloadbalancing/api_op_AddTags.go | 8 +- ...pi_op_ApplySecurityGroupsToLoadBalancer.go | 10 +- .../api_op_AttachLoadBalancerToSubnets.go | 10 +- .../api_op_CreateLBCookieStickinessPolicy.go | 10 +- .../api_op_CreateLoadBalancer.go | 40 +- .../api_op_CreateLoadBalancerListeners.go | 8 +- .../api_op_DeleteLoadBalancerListeners.go | 8 +- .../api_op_DeleteLoadBalancerPolicy.go | 8 +- ..._op_DeregisterInstancesFromLoadBalancer.go | 8 +- .../api_op_DescribeAccountLimits.go | 12 +- .../api_op_DescribeLoadBalancers.go | 6 +- ...DisableAvailabilityZonesForLoadBalancer.go | 8 +- .../api_op_ModifyLoadBalancerAttributes.go | 14 +- ...pi_op_RegisterInstancesWithLoadBalancer.go | 8 +- ...p_SetLoadBalancerListenerSSLCertificate.go | 8 +- ...pi_op_SetLoadBalancerPoliciesOfListener.go | 10 +- service/elasticloadbalancing/go.mod | 2 +- service/elasticloadbalancing/types/types.go | 234 +- .../api_op_AddListenerCertificates.go | 10 +- .../elasticloadbalancingv2/api_op_AddTags.go | 8 +- .../api_op_CreateListener.go | 102 +- .../api_op_CreateLoadBalancer.go | 46 +- .../api_op_CreateRule.go | 8 +- .../api_op_CreateTargetGroup.go | 96 +- .../api_op_DeregisterTargets.go | 10 +- .../api_op_DescribeListenerCertificates.go | 10 +- .../api_op_DescribeListeners.go | 12 +- .../api_op_DescribeLoadBalancers.go | 12 +- .../api_op_DescribeRules.go | 12 +- .../api_op_DescribeSSLPolicies.go | 12 +- .../api_op_DescribeTargetGroups.go | 6 +- .../api_op_DescribeTargetHealth.go | 6 +- .../api_op_ModifyListener.go | 76 +- .../api_op_ModifyRule.go | 10 +- .../api_op_ModifyTargetGroup.go | 52 +- .../api_op_ModifyTargetGroupAttributes.go | 8 +- .../api_op_RegisterTargets.go | 10 +- .../api_op_RemoveTags.go | 8 +- .../api_op_SetIpAddressType.go | 10 +- .../api_op_SetSubnets.go | 10 +- service/elasticloadbalancingv2/go.mod | 2 +- service/elasticloadbalancingv2/types/types.go | 420 +- .../api_op_CreateElasticsearchDomain.go | 68 +- ...ateOutboundCrossClusterSearchConnection.go | 24 +- .../api_op_CreatePackage.go | 14 +- ...DescribeElasticsearchInstanceTypeLimits.go | 10 +- ...ibeInboundCrossClusterSearchConnections.go | 24 +- ...beOutboundCrossClusterSearchConnections.go | 24 +- .../api_op_DescribePackages.go | 9 +- ...eReservedElasticsearchInstanceOfferings.go | 14 +- ..._DescribeReservedElasticsearchInstances.go | 8 +- .../api_op_DissociatePackage.go | 10 +- .../api_op_GetUpgradeHistory.go | 6 +- .../api_op_GetUpgradeStatus.go | 26 +- .../api_op_ListDomainsForPackage.go | 17 +- .../api_op_ListElasticsearchInstanceTypes.go | 16 +- .../api_op_ListElasticsearchVersions.go | 6 +- .../api_op_ListPackagesForDomain.go | 6 +- ...seReservedElasticsearchInstanceOffering.go | 18 +- .../api_op_UpdateElasticsearchDomainConfig.go | 58 +- .../api_op_UpgradeElasticsearchDomain.go | 28 +- service/elasticsearchservice/go.mod | 2 +- service/elasticsearchservice/types/types.go | 588 +- service/elastictranscoder/api_op_CreateJob.go | 30 +- .../api_op_CreatePipeline.go | 84 +- .../elastictranscoder/api_op_CreatePreset.go | 22 +- .../api_op_ListJobsByPipeline.go | 14 +- .../api_op_ListJobsByStatus.go | 8 +- .../elastictranscoder/api_op_ListPipelines.go | 6 +- .../elastictranscoder/api_op_ListPresets.go | 14 +- service/elastictranscoder/api_op_TestRole.go | 26 +- .../api_op_UpdatePipeline.go | 188 +- service/elastictranscoder/go.mod | 2 +- service/elastictranscoder/types/types.go | 1520 ++-- service/emr/api_op_AddInstanceFleet.go | 8 +- service/emr/api_op_AddInstanceGroups.go | 16 +- service/emr/api_op_AddTags.go | 12 +- .../emr/api_op_CreateSecurityConfiguration.go | 10 +- service/emr/api_op_DescribeJobFlows.go | 8 +- .../api_op_DescribeSecurityConfiguration.go | 6 +- service/emr/api_op_DescribeStep.go | 8 +- ...pi_op_GetBlockPublicAccessConfiguration.go | 18 +- service/emr/api_op_ListBootstrapActions.go | 12 +- service/emr/api_op_ListClusters.go | 12 +- service/emr/api_op_ListInstanceFleets.go | 6 +- service/emr/api_op_ListInstanceGroups.go | 12 +- service/emr/api_op_ListInstances.go | 24 +- .../emr/api_op_ListSecurityConfigurations.go | 6 +- service/emr/api_op_ListSteps.go | 18 +- service/emr/api_op_PutAutoScalingPolicy.go | 22 +- service/emr/api_op_PutManagedScalingPolicy.go | 8 +- service/emr/api_op_RunJobFlow.go | 220 +- .../emr/api_op_SetTerminationProtection.go | 14 +- service/emr/go.mod | 2 +- service/emr/types/types.go | 1352 ++-- service/eventbridge/api_op_CreateEventBus.go | 8 +- .../api_op_CreatePartnerEventSource.go | 12 +- service/eventbridge/api_op_DeleteRule.go | 8 +- .../eventbridge/api_op_DescribeEventBus.go | 6 +- .../eventbridge/api_op_DescribeEventSource.go | 14 +- service/eventbridge/api_op_DescribeRule.go | 38 +- service/eventbridge/api_op_DisableRule.go | 8 +- service/eventbridge/api_op_EnableRule.go | 8 +- service/eventbridge/api_op_ListEventBuses.go | 10 +- .../eventbridge/api_op_ListEventSources.go | 14 +- .../api_op_ListPartnerEventSourceAccounts.go | 14 +- .../api_op_ListPartnerEventSources.go | 6 +- .../api_op_ListRuleNamesByTarget.go | 24 +- service/eventbridge/api_op_ListRules.go | 16 +- .../eventbridge/api_op_ListTargetsByRule.go | 14 +- service/eventbridge/api_op_PutEvents.go | 6 +- .../eventbridge/api_op_PutPartnerEvents.go | 8 +- service/eventbridge/api_op_PutPermission.go | 20 +- service/eventbridge/api_op_PutRule.go | 34 +- service/eventbridge/api_op_PutTargets.go | 8 +- service/eventbridge/api_op_RemoveTargets.go | 20 +- service/eventbridge/go.mod | 2 +- service/eventbridge/types/types.go | 286 +- .../firehose/api_op_CreateDeliveryStream.go | 46 +- .../firehose/api_op_DescribeDeliveryStream.go | 14 +- .../firehose/api_op_ListDeliveryStreams.go | 18 +- .../api_op_ListTagsForDeliveryStream.go | 22 +- service/firehose/api_op_PutRecord.go | 8 +- service/firehose/api_op_PutRecordBatch.go | 16 +- .../firehose/api_op_UntagDeliveryStream.go | 8 +- service/firehose/api_op_UpdateDestination.go | 36 +- service/firehose/go.mod | 2 +- service/firehose/types/types.go | 1206 +-- service/fms/api_op_DeletePolicy.go | 12 +- service/fms/api_op_GetComplianceDetail.go | 10 +- service/fms/api_op_GetNotificationChannel.go | 6 +- service/fms/api_op_GetProtectionStatus.go | 52 +- service/fms/api_op_GetViolationDetails.go | 8 +- service/fms/api_op_ListAppsLists.go | 20 +- service/fms/api_op_ListComplianceStatus.go | 14 +- service/fms/api_op_ListMemberAccounts.go | 6 +- service/fms/api_op_ListPolicies.go | 6 +- service/fms/api_op_ListProtocolsLists.go | 6 +- service/fms/api_op_PutNotificationChannel.go | 12 +- service/fms/api_op_PutProtocolsList.go | 6 +- service/fms/api_op_TagResource.go | 10 +- service/fms/go.mod | 2 +- service/fms/types/types.go | 342 +- service/forecast/api_op_CreateDataset.go | 84 +- service/forecast/api_op_CreateDatasetGroup.go | 32 +- .../api_op_CreateForecastExportJob.go | 16 +- service/forecast/api_op_CreatePredictor.go | 146 +- service/forecast/api_op_DescribeDataset.go | 58 +- .../forecast/api_op_DescribeDatasetGroup.go | 32 +- .../api_op_DescribeDatasetImportJob.go | 62 +- service/forecast/api_op_DescribeForecast.go | 22 +- .../api_op_DescribeForecastExportJob.go | 22 +- service/forecast/api_op_DescribePredictor.go | 110 +- service/forecast/api_op_ListDatasetGroups.go | 6 +- service/forecast/api_op_ListDatasets.go | 12 +- .../forecast/api_op_ListForecastExportJobs.go | 16 +- service/forecast/api_op_ListForecasts.go | 6 +- service/forecast/api_op_ListPredictors.go | 16 +- service/forecast/api_op_TagResource.go | 14 +- service/forecast/api_op_UntagResource.go | 10 +- service/forecast/go.mod | 2 +- service/forecast/types/types.go | 306 +- service/forecastquery/api_op_QueryForecast.go | 18 +- service/forecastquery/go.mod | 2 +- service/forecastquery/types/types.go | 6 +- .../api_op_BatchCreateVariable.go | 6 +- .../frauddetector/api_op_BatchGetVariable.go | 6 +- .../api_op_CreateDetectorVersion.go | 30 +- service/frauddetector/api_op_CreateModel.go | 6 +- .../api_op_CreateModelVersion.go | 30 +- service/frauddetector/api_op_CreateRule.go | 30 +- .../frauddetector/api_op_CreateVariable.go | 36 +- .../api_op_DeleteDetectorVersion.go | 8 +- .../frauddetector/api_op_DescribeDetector.go | 6 +- .../api_op_DescribeModelVersions.go | 14 +- .../api_op_GetDetectorVersion.go | 54 +- service/frauddetector/api_op_GetDetectors.go | 6 +- .../frauddetector/api_op_GetEntityTypes.go | 12 +- .../api_op_GetEventPrediction.go | 40 +- service/frauddetector/api_op_GetEventTypes.go | 12 +- .../frauddetector/api_op_GetExternalModels.go | 6 +- service/frauddetector/api_op_GetLabels.go | 12 +- .../frauddetector/api_op_GetModelVersion.go | 24 +- service/frauddetector/api_op_GetModels.go | 18 +- service/frauddetector/api_op_GetOutcomes.go | 6 +- service/frauddetector/api_op_GetRules.go | 16 +- service/frauddetector/api_op_GetVariables.go | 12 +- .../api_op_ListTagsForResource.go | 18 +- service/frauddetector/api_op_PutDetector.go | 18 +- service/frauddetector/api_op_PutEventType.go | 24 +- .../frauddetector/api_op_PutExternalModel.go | 22 +- service/frauddetector/api_op_PutLabel.go | 6 +- service/frauddetector/api_op_PutOutcome.go | 10 +- .../api_op_UpdateDetectorVersion.go | 24 +- .../api_op_UpdateDetectorVersionMetadata.go | 8 +- .../api_op_UpdateDetectorVersionStatus.go | 8 +- service/frauddetector/api_op_UpdateModel.go | 8 +- .../api_op_UpdateModelVersion.go | 18 +- .../api_op_UpdateModelVersionStatus.go | 8 +- .../api_op_UpdateRuleMetadata.go | 8 +- .../frauddetector/api_op_UpdateRuleVersion.go | 16 +- .../frauddetector/api_op_UpdateVariable.go | 14 +- service/frauddetector/go.mod | 2 +- service/frauddetector/types/types.go | 318 +- service/fsx/api_op_CreateBackup.go | 18 +- .../fsx/api_op_CreateDataRepositoryTask.go | 36 +- service/fsx/api_op_CreateFileSystem.go | 56 +- .../fsx/api_op_CreateFileSystemFromBackup.go | 34 +- service/fsx/api_op_DeleteBackup.go | 6 +- service/fsx/api_op_DeleteFileSystem.go | 24 +- service/fsx/api_op_DescribeBackups.go | 16 +- .../fsx/api_op_DescribeDataRepositoryTasks.go | 16 +- service/fsx/api_op_ListTagsForResource.go | 10 +- service/fsx/api_op_TagResource.go | 10 +- service/fsx/api_op_UntagResource.go | 10 +- service/fsx/api_op_UpdateFileSystem.go | 18 +- service/fsx/go.mod | 2 +- service/fsx/types/types.go | 820 +- service/gamelift/api_op_AcceptMatch.go | 10 +- service/gamelift/api_op_CreateAlias.go | 18 +- service/gamelift/api_op_CreateBuild.go | 20 +- service/gamelift/api_op_CreateFleet.go | 204 +- .../gamelift/api_op_CreateGameServerGroup.go | 102 +- service/gamelift/api_op_CreateGameSession.go | 16 +- .../gamelift/api_op_CreateGameSessionQueue.go | 32 +- .../api_op_CreateMatchmakingConfiguration.go | 90 +- .../api_op_CreateMatchmakingRuleSet.go | 26 +- .../gamelift/api_op_CreatePlayerSession.go | 8 +- service/gamelift/api_op_CreateScript.go | 28 +- .../api_op_CreateVpcPeeringAuthorization.go | 14 +- .../api_op_CreateVpcPeeringConnection.go | 14 +- .../gamelift/api_op_DeleteGameServerGroup.go | 12 +- .../gamelift/api_op_DeleteScalingPolicy.go | 12 +- .../api_op_DeleteVpcPeeringConnection.go | 14 +- .../gamelift/api_op_DescribeFleetCapacity.go | 8 +- .../gamelift/api_op_DescribeFleetEvents.go | 26 +- .../api_op_DescribeFleetUtilization.go | 22 +- service/gamelift/api_op_DescribeGameServer.go | 10 +- .../api_op_DescribeGameSessionDetails.go | 32 +- .../api_op_DescribeGameSessionQueues.go | 8 +- .../gamelift/api_op_DescribeGameSessions.go | 14 +- service/gamelift/api_op_DescribeInstances.go | 10 +- ...pi_op_DescribeMatchmakingConfigurations.go | 16 +- .../api_op_DescribeMatchmakingRuleSets.go | 8 +- .../gamelift/api_op_DescribePlayerSessions.go | 24 +- .../api_op_DescribeScalingPolicies.go | 6 +- service/gamelift/api_op_ListAliases.go | 32 +- service/gamelift/api_op_ListBuilds.go | 10 +- service/gamelift/api_op_ListFleets.go | 18 +- service/gamelift/api_op_ListGameServers.go | 20 +- service/gamelift/api_op_ListScripts.go | 6 +- service/gamelift/api_op_PutScalingPolicy.go | 96 +- service/gamelift/api_op_RegisterGameServer.go | 56 +- .../api_op_RequestUploadCredentials.go | 6 +- service/gamelift/api_op_ResolveAlias.go | 6 +- .../gamelift/api_op_ResumeGameServerGroup.go | 10 +- service/gamelift/api_op_SearchGameSessions.go | 48 +- .../api_op_StartGameSessionPlacement.go | 50 +- service/gamelift/api_op_StartMatchBackfill.go | 32 +- service/gamelift/api_op_StartMatchmaking.go | 10 +- .../gamelift/api_op_SuspendGameServerGroup.go | 10 +- service/gamelift/api_op_TagResource.go | 18 +- service/gamelift/api_op_UpdateAlias.go | 16 +- service/gamelift/api_op_UpdateBuild.go | 8 +- .../gamelift/api_op_UpdateFleetAttributes.go | 18 +- .../gamelift/api_op_UpdateFleetCapacity.go | 14 +- .../api_op_UpdateFleetPortSettings.go | 12 +- service/gamelift/api_op_UpdateGameServer.go | 30 +- .../gamelift/api_op_UpdateGameServerGroup.go | 40 +- service/gamelift/api_op_UpdateGameSession.go | 32 +- .../gamelift/api_op_UpdateGameSessionQueue.go | 24 +- .../api_op_UpdateMatchmakingConfiguration.go | 88 +- .../api_op_UpdateRuntimeConfiguration.go | 12 +- service/gamelift/api_op_UpdateScript.go | 28 +- service/gamelift/go.mod | 2 +- service/gamelift/types/types.go | 1316 ++-- .../glacier/api_op_AbortMultipartUpload.go | 10 +- service/glacier/api_op_AddTagsToVault.go | 18 +- .../glacier/api_op_CompleteMultipartUpload.go | 6 +- service/glacier/api_op_CompleteVaultLock.go | 18 +- service/glacier/api_op_DeleteArchive.go | 16 +- service/glacier/api_op_DescribeJob.go | 104 +- service/glacier/api_op_DescribeVault.go | 38 +- service/glacier/api_op_GetJobOutput.go | 34 +- .../glacier/api_op_GetVaultAccessPolicy.go | 10 +- service/glacier/api_op_GetVaultLock.go | 14 +- .../glacier/api_op_GetVaultNotifications.go | 10 +- service/glacier/api_op_InitiateJob.go | 16 +- .../glacier/api_op_InitiateMultipartUpload.go | 22 +- service/glacier/api_op_InitiateVaultLock.go | 16 +- service/glacier/api_op_ListJobs.go | 30 +- service/glacier/api_op_ListParts.go | 28 +- service/glacier/api_op_ListVaults.go | 6 +- service/glacier/api_op_RemoveTagsFromVault.go | 16 +- .../glacier/api_op_SetDataRetrievalPolicy.go | 6 +- .../glacier/api_op_SetVaultAccessPolicy.go | 6 +- .../glacier/api_op_SetVaultNotifications.go | 10 +- service/glacier/api_op_UploadArchive.go | 28 +- service/glacier/api_op_UploadMultipartPart.go | 28 +- service/glacier/go.mod | 2 +- service/glacier/types/types.go | 312 +- .../api_op_CreateAccelerator.go | 18 +- .../api_op_CreateEndpointGroup.go | 30 +- .../api_op_CreateListener.go | 44 +- .../api_op_ListByoipCidrs.go | 6 +- .../api_op_ListEndpointGroups.go | 8 +- .../globalaccelerator/api_op_ListListeners.go | 14 +- .../globalaccelerator/api_op_UntagResource.go | 10 +- .../api_op_UpdateAccelerator.go | 16 +- .../api_op_UpdateAcceleratorAttributes.go | 24 +- .../api_op_UpdateEndpointGroup.go | 34 +- .../api_op_UpdateListener.go | 16 +- service/globalaccelerator/go.mod | 2 +- service/globalaccelerator/types/types.go | 162 +- service/glue/api_op_BatchCreatePartition.go | 16 +- service/glue/api_op_BatchDeletePartition.go | 8 +- service/glue/api_op_BatchDeleteTable.go | 10 +- .../glue/api_op_BatchDeleteTableVersion.go | 10 +- service/glue/api_op_BatchGetJobs.go | 6 +- service/glue/api_op_BatchGetPartition.go | 22 +- service/glue/api_op_BatchGetWorkflows.go | 6 +- service/glue/api_op_CancelMLTaskRun.go | 16 +- service/glue/api_op_CreateClassifier.go | 12 +- service/glue/api_op_CreateConnection.go | 8 +- service/glue/api_op_CreateCrawler.go | 50 +- service/glue/api_op_CreateDevEndpoint.go | 170 +- service/glue/api_op_CreateJob.go | 140 +- service/glue/api_op_CreateMLTransform.go | 110 +- service/glue/api_op_CreatePartition.go | 16 +- service/glue/api_op_CreateScript.go | 12 +- .../api_op_CreateSecurityConfiguration.go | 8 +- service/glue/api_op_CreateTable.go | 8 +- service/glue/api_op_CreateTrigger.go | 46 +- service/glue/api_op_CreateWorkflow.go | 8 +- ...i_op_DeleteColumnStatisticsForPartition.go | 18 +- .../api_op_DeleteColumnStatisticsForTable.go | 18 +- service/glue/api_op_DeleteDatabase.go | 8 +- service/glue/api_op_DeletePartition.go | 8 +- service/glue/api_op_DeleteResourcePolicy.go | 6 +- service/glue/api_op_DeleteTable.go | 16 +- service/glue/api_op_DeleteTableVersion.go | 18 +- .../glue/api_op_DeleteUserDefinedFunction.go | 14 +- service/glue/api_op_GetClassifiers.go | 6 +- .../api_op_GetColumnStatisticsForPartition.go | 10 +- .../api_op_GetColumnStatisticsForTable.go | 12 +- service/glue/api_op_GetConnections.go | 24 +- service/glue/api_op_GetCrawlerMetrics.go | 6 +- service/glue/api_op_GetCrawlers.go | 6 +- service/glue/api_op_GetDatabases.go | 14 +- service/glue/api_op_GetJobRun.go | 8 +- service/glue/api_op_GetJobRuns.go | 6 +- service/glue/api_op_GetJobs.go | 6 +- service/glue/api_op_GetMLTaskRun.go | 42 +- service/glue/api_op_GetMLTaskRuns.go | 20 +- service/glue/api_op_GetMLTransform.go | 92 +- service/glue/api_op_GetMLTransforms.go | 6 +- service/glue/api_op_GetMapping.go | 6 +- service/glue/api_op_GetPartition.go | 16 +- service/glue/api_op_GetPartitions.go | 24 +- service/glue/api_op_GetPlan.go | 12 +- service/glue/api_op_GetResourcePolicies.go | 6 +- service/glue/api_op_GetResourcePolicy.go | 10 +- .../glue/api_op_GetSecurityConfigurations.go | 12 +- service/glue/api_op_GetTable.go | 16 +- service/glue/api_op_GetTableVersion.go | 8 +- service/glue/api_op_GetTableVersions.go | 14 +- service/glue/api_op_GetTables.go | 24 +- service/glue/api_op_GetTriggers.go | 6 +- .../glue/api_op_GetUserDefinedFunctions.go | 30 +- service/glue/api_op_GetWorkflow.go | 8 +- service/glue/api_op_GetWorkflowRun.go | 10 +- service/glue/api_op_GetWorkflowRuns.go | 6 +- service/glue/api_op_ListCrawlers.go | 8 +- service/glue/api_op_ListDevEndpoints.go | 6 +- service/glue/api_op_ListJobs.go | 6 +- service/glue/api_op_ListMLTransforms.go | 6 +- service/glue/api_op_ListTriggers.go | 14 +- service/glue/api_op_PutResourcePolicy.go | 18 +- service/glue/api_op_ResetJobBookmark.go | 6 +- service/glue/api_op_ResumeWorkflowRun.go | 10 +- service/glue/api_op_SearchTables.go | 22 +- .../glue/api_op_StartImportLabelsTaskRun.go | 6 +- service/glue/api_op_StartJobRun.go | 34 +- ..._op_StartMLLabelingSetGenerationTaskRun.go | 10 +- service/glue/api_op_StopWorkflowRun.go | 8 +- service/glue/api_op_TagResource.go | 10 +- service/glue/api_op_UntagResource.go | 8 +- service/glue/api_op_UpdateClassifier.go | 10 +- ...i_op_UpdateColumnStatisticsForPartition.go | 16 +- .../api_op_UpdateColumnStatisticsForTable.go | 16 +- service/glue/api_op_UpdateConnection.go | 14 +- service/glue/api_op_UpdateCrawler.go | 40 +- service/glue/api_op_UpdateDatabase.go | 8 +- service/glue/api_op_UpdateDevEndpoint.go | 26 +- service/glue/api_op_UpdateJob.go | 8 +- service/glue/api_op_UpdateMLTransform.go | 54 +- service/glue/api_op_UpdatePartition.go | 26 +- service/glue/api_op_UpdateTable.go | 18 +- service/glue/api_op_UpdateTrigger.go | 8 +- .../glue/api_op_UpdateUserDefinedFunction.go | 16 +- service/glue/api_op_UpdateWorkflow.go | 10 +- service/glue/go.mod | 2 +- service/glue/types/types.go | 1978 ++--- .../api_op_CreateConnectorDefinition.go | 30 +- ...api_op_CreateConnectorDefinitionVersion.go | 24 +- .../greengrass/api_op_CreateCoreDefinition.go | 32 +- .../api_op_CreateCoreDefinitionVersion.go | 16 +- service/greengrass/api_op_CreateDeployment.go | 20 +- .../api_op_CreateDeviceDefinition.go | 24 +- .../api_op_CreateDeviceDefinitionVersion.go | 8 +- .../api_op_CreateFunctionDefinition.go | 28 +- .../api_op_CreateFunctionDefinitionVersion.go | 14 +- service/greengrass/api_op_CreateGroup.go | 28 +- .../greengrass/api_op_CreateGroupVersion.go | 26 +- .../api_op_CreateLoggerDefinition.go | 22 +- .../api_op_CreateLoggerDefinitionVersion.go | 14 +- .../api_op_CreateResourceDefinition.go | 28 +- .../api_op_CreateResourceDefinitionVersion.go | 6 +- .../api_op_CreateSoftwareUpdateJob.go | 34 +- .../api_op_CreateSubscriptionDefinition.go | 34 +- ..._op_CreateSubscriptionDefinitionVersion.go | 6 +- .../greengrass/api_op_GetAssociatedRole.go | 6 +- .../api_op_GetBulkDeploymentStatus.go | 20 +- .../greengrass/api_op_GetConnectivityInfo.go | 6 +- .../api_op_GetConnectorDefinition.go | 20 +- .../api_op_GetConnectorDefinitionVersion.go | 26 +- .../greengrass/api_op_GetCoreDefinition.go | 10 +- .../api_op_GetCoreDefinitionVersion.go | 12 +- .../greengrass/api_op_GetDeploymentStatus.go | 8 +- .../greengrass/api_op_GetDeviceDefinition.go | 18 +- .../api_op_GetDeviceDefinitionVersion.go | 30 +- .../api_op_GetFunctionDefinition.go | 16 +- .../api_op_GetFunctionDefinitionVersion.go | 30 +- service/greengrass/api_op_GetGroup.go | 24 +- .../api_op_GetGroupCertificateAuthority.go | 6 +- ...api_op_GetGroupCertificateConfiguration.go | 6 +- service/greengrass/api_op_GetGroupVersion.go | 12 +- .../greengrass/api_op_GetLoggerDefinition.go | 26 +- .../api_op_GetLoggerDefinitionVersion.go | 26 +- .../api_op_GetResourceDefinition.go | 10 +- .../api_op_GetResourceDefinitionVersion.go | 16 +- .../api_op_GetServiceRoleForAccount.go | 6 +- .../api_op_GetSubscriptionDefinition.go | 22 +- ...api_op_GetSubscriptionDefinitionVersion.go | 20 +- ...pi_op_ListBulkDeploymentDetailedReports.go | 14 +- .../greengrass/api_op_ListBulkDeployments.go | 6 +- .../api_op_ListConnectorDefinitionVersions.go | 8 +- .../api_op_ListConnectorDefinitions.go | 6 +- .../api_op_ListCoreDefinitionVersions.go | 14 +- service/greengrass/api_op_ListDeployments.go | 18 +- .../api_op_ListDeviceDefinitionVersions.go | 12 +- .../api_op_ListDeviceDefinitions.go | 6 +- .../api_op_ListFunctionDefinitionVersions.go | 6 +- .../greengrass/api_op_ListGroupVersions.go | 6 +- service/greengrass/api_op_ListGroups.go | 12 +- .../api_op_ListLoggerDefinitionVersions.go | 14 +- .../api_op_ListLoggerDefinitions.go | 12 +- .../api_op_ListResourceDefinitionVersions.go | 6 +- .../api_op_ListResourceDefinitions.go | 12 +- ...i_op_ListSubscriptionDefinitionVersions.go | 12 +- .../api_op_ListSubscriptionDefinitions.go | 6 +- service/greengrass/api_op_ResetDeployments.go | 12 +- .../greengrass/api_op_StartBulkDeployment.go | 28 +- .../api_op_UpdateConnectivityInfo.go | 12 +- .../api_op_UpdateDeviceDefinition.go | 6 +- service/greengrass/api_op_UpdateGroup.go | 6 +- ..._op_UpdateGroupCertificateConfiguration.go | 12 +- service/greengrass/go.mod | 2 +- service/greengrass/types/types.go | 342 +- .../api_op_CreateMissionProfile.go | 22 +- service/groundstation/api_op_GetConfig.go | 6 +- service/groundstation/api_op_ListContacts.go | 20 +- .../api_op_UpdateMissionProfile.go | 10 +- service/groundstation/go.mod | 2 +- service/guardduty/api_op_CreateDetector.go | 16 +- service/guardduty/api_op_CreateFilter.go | 22 +- service/guardduty/api_op_CreateIPSet.go | 22 +- .../api_op_CreatePublishingDestination.go | 12 +- .../guardduty/api_op_CreateThreatIntelSet.go | 36 +- service/guardduty/api_op_DeleteMembers.go | 10 +- ...pi_op_DescribeOrganizationConfiguration.go | 8 +- .../api_op_DescribePublishingDestination.go | 22 +- service/guardduty/api_op_GetDetector.go | 24 +- service/guardduty/api_op_GetFilter.go | 28 +- service/guardduty/api_op_GetFindings.go | 14 +- service/guardduty/api_op_GetIPSet.go | 20 +- .../guardduty/api_op_GetMemberDetectors.go | 18 +- service/guardduty/api_op_GetMembers.go | 12 +- service/guardduty/api_op_GetThreatIntelSet.go | 28 +- .../guardduty/api_op_GetUsageStatistics.go | 20 +- service/guardduty/api_op_InviteMembers.go | 16 +- service/guardduty/api_op_ListFindings.go | 20 +- service/guardduty/api_op_ListIPSets.go | 16 +- service/guardduty/api_op_ListInvitations.go | 14 +- service/guardduty/api_op_ListMembers.go | 14 +- .../api_op_ListOrganizationAdminAccounts.go | 8 +- .../guardduty/api_op_ListThreatIntelSets.go | 12 +- service/guardduty/api_op_UnarchiveFindings.go | 8 +- service/guardduty/api_op_UntagResource.go | 8 +- service/guardduty/api_op_UpdateDetector.go | 6 +- service/guardduty/api_op_UpdateFilter.go | 22 +- .../api_op_UpdateFindingsFeedback.go | 8 +- service/guardduty/api_op_UpdateIPSet.go | 16 +- .../api_op_UpdateOrganizationConfiguration.go | 8 +- .../api_op_UpdatePublishingDestination.go | 8 +- .../guardduty/api_op_UpdateThreatIntelSet.go | 22 +- service/guardduty/go.mod | 2 +- service/guardduty/types/types.go | 518 +- ...DescribeAffectedAccountsForOrganization.go | 10 +- .../health/api_op_DescribeAffectedEntities.go | 16 +- ...DescribeAffectedEntitiesForOrganization.go | 26 +- .../health/api_op_DescribeEventAggregates.go | 24 +- ..._op_DescribeEventDetailsForOrganization.go | 8 +- service/health/api_op_DescribeEventTypes.go | 20 +- service/health/api_op_DescribeEvents.go | 28 +- .../api_op_DescribeEventsForOrganization.go | 24 +- service/health/go.mod | 2 +- service/health/types/types.go | 254 +- service/honeycode/api_op_GetScreenData.go | 52 +- .../api_op_InvokeScreenAutomation.go | 30 +- service/honeycode/go.mod | 2 +- service/honeycode/types/types.go | 14 +- .../iam/api_op_AddRoleToInstanceProfile.go | 16 +- service/iam/api_op_AddUserToGroup.go | 16 +- service/iam/api_op_AttachGroupPolicy.go | 16 +- service/iam/api_op_AttachUserPolicy.go | 16 +- service/iam/api_op_ChangePassword.go | 10 +- service/iam/api_op_CreateLoginProfile.go | 18 +- .../iam/api_op_CreateOpenIDConnectProvider.go | 22 +- service/iam/api_op_CreatePolicy.go | 36 +- service/iam/api_op_CreatePolicyVersion.go | 18 +- service/iam/api_op_CreateRole.go | 88 +- service/iam/api_op_CreateSAMLProvider.go | 16 +- service/iam/api_op_CreateServiceLinkedRole.go | 6 +- service/iam/api_op_CreateUser.go | 18 +- service/iam/api_op_DeactivateMFADevice.go | 16 +- service/iam/api_op_DeleteAccessKey.go | 12 +- service/iam/api_op_DeleteGroupPolicy.go | 16 +- service/iam/api_op_DeletePolicyVersion.go | 18 +- .../api_op_DeleteServiceSpecificCredential.go | 16 +- .../iam/api_op_DeleteSigningCertificate.go | 12 +- service/iam/api_op_DeleteUserPolicy.go | 16 +- service/iam/api_op_DetachGroupPolicy.go | 18 +- service/iam/api_op_DetachRolePolicy.go | 18 +- service/iam/api_op_EnableMFADevice.go | 18 +- .../iam/api_op_GenerateCredentialReport.go | 6 +- ...pi_op_GenerateOrganizationsAccessReport.go | 10 +- .../api_op_GetAccountAuthorizationDetails.go | 14 +- service/iam/api_op_GetCredentialReport.go | 6 +- service/iam/api_op_GetGroup.go | 26 +- service/iam/api_op_GetGroupPolicy.go | 26 +- .../iam/api_op_GetOpenIDConnectProvider.go | 18 +- .../api_op_GetOrganizationsAccessReport.go | 58 +- service/iam/api_op_GetPolicyVersion.go | 16 +- service/iam/api_op_GetRolePolicy.go | 10 +- service/iam/api_op_GetSAMLProvider.go | 8 +- service/iam/api_op_GetSSHPublicKey.go | 18 +- .../api_op_GetServiceLastAccessedDetails.go | 42 +- ...tServiceLastAccessedDetailsWithEntities.go | 52 +- ...i_op_GetServiceLinkedRoleDeletionStatus.go | 6 +- service/iam/api_op_ListAccessKeys.go | 20 +- service/iam/api_op_ListAccountAliases.go | 24 +- .../iam/api_op_ListAttachedGroupPolicies.go | 36 +- .../iam/api_op_ListAttachedRolePolicies.go | 18 +- .../iam/api_op_ListAttachedUserPolicies.go | 42 +- service/iam/api_op_ListEntitiesForPolicy.go | 74 +- service/iam/api_op_ListGroupPolicies.go | 24 +- service/iam/api_op_ListGroups.go | 26 +- service/iam/api_op_ListGroupsForUser.go | 28 +- service/iam/api_op_ListInstanceProfiles.go | 26 +- .../iam/api_op_ListInstanceProfilesForRole.go | 8 +- service/iam/api_op_ListMFADevices.go | 20 +- service/iam/api_op_ListPolicies.go | 42 +- service/iam/api_op_ListPolicyVersions.go | 26 +- service/iam/api_op_ListRolePolicies.go | 20 +- service/iam/api_op_ListRoleTags.go | 26 +- service/iam/api_op_ListRoles.go | 26 +- service/iam/api_op_ListSSHPublicKeys.go | 12 +- service/iam/api_op_ListServerCertificates.go | 18 +- .../api_op_ListServiceSpecificCredentials.go | 8 +- service/iam/api_op_ListSigningCertificates.go | 28 +- service/iam/api_op_ListUserPolicies.go | 12 +- service/iam/api_op_ListUserTags.go | 18 +- service/iam/api_op_ListUsers.go | 20 +- service/iam/api_op_ListVirtualMFADevices.go | 24 +- service/iam/api_op_PutGroupPolicy.go | 16 +- service/iam/api_op_PutRolePolicy.go | 32 +- .../iam/api_op_PutUserPermissionsBoundary.go | 10 +- service/iam/api_op_PutUserPolicy.go | 32 +- service/iam/api_op_RemoveUserFromGroup.go | 16 +- service/iam/api_op_ResyncMFADevice.go | 28 +- service/iam/api_op_SimulateCustomPolicy.go | 206 +- service/iam/api_op_SimulatePrincipalPolicy.go | 176 +- service/iam/api_op_TagRole.go | 12 +- service/iam/api_op_UntagUser.go | 12 +- service/iam/api_op_UpdateAccessKey.go | 22 +- .../iam/api_op_UpdateAccountPasswordPolicy.go | 64 +- service/iam/api_op_UpdateGroup.go | 16 +- service/iam/api_op_UpdateLoginProfile.go | 16 +- service/iam/api_op_UpdateRole.go | 10 +- service/iam/api_op_UpdateRoleDescription.go | 8 +- service/iam/api_op_UpdateSSHPublicKey.go | 14 +- service/iam/api_op_UpdateServerCertificate.go | 28 +- .../api_op_UpdateServiceSpecificCredential.go | 14 +- .../iam/api_op_UpdateSigningCertificate.go | 22 +- service/iam/api_op_UpdateUser.go | 18 +- service/iam/api_op_UploadSSHPublicKey.go | 16 +- service/iam/api_op_UploadServerCertificate.go | 70 +- service/iam/go.mod | 2 +- service/iam/types/types.go | 932 +-- .../api_op_CancelImageCreation.go | 14 +- .../imagebuilder/api_op_CreateComponent.go | 66 +- .../api_op_CreateDistributionConfiguration.go | 22 +- service/imagebuilder/api_op_CreateImage.go | 32 +- .../api_op_CreateImagePipeline.go | 50 +- .../imagebuilder/api_op_CreateImageRecipe.go | 36 +- ...pi_op_CreateInfrastructureConfiguration.go | 68 +- .../imagebuilder/api_op_DeleteComponent.go | 6 +- .../api_op_DeleteDistributionConfiguration.go | 6 +- service/imagebuilder/api_op_DeleteImage.go | 6 +- ...pi_op_DeleteInfrastructureConfiguration.go | 6 +- .../api_op_GetDistributionConfiguration.go | 6 +- .../imagebuilder/api_op_GetImagePipeline.go | 6 +- service/imagebuilder/api_op_GetImagePolicy.go | 6 +- service/imagebuilder/api_op_GetImageRecipe.go | 6 +- .../api_op_GetImageRecipePolicy.go | 6 +- .../imagebuilder/api_op_ImportComponent.go | 62 +- .../api_op_ListComponentBuildVersions.go | 20 +- service/imagebuilder/api_op_ListComponents.go | 20 +- .../api_op_ListDistributionConfigurations.go | 16 +- .../api_op_ListImageBuildVersions.go | 14 +- .../api_op_ListImagePipelineImages.go | 14 +- .../imagebuilder/api_op_ListImagePipelines.go | 16 +- .../imagebuilder/api_op_ListImageRecipes.go | 22 +- service/imagebuilder/api_op_ListImages.go | 18 +- ...api_op_ListInfrastructureConfigurations.go | 12 +- .../imagebuilder/api_op_PutComponentPolicy.go | 16 +- .../api_op_PutImageRecipePolicy.go | 10 +- .../api_op_StartImagePipelineExecution.go | 6 +- service/imagebuilder/api_op_UntagResource.go | 8 +- .../api_op_UpdateDistributionConfiguration.go | 20 +- .../api_op_UpdateImagePipeline.go | 56 +- ...pi_op_UpdateInfrastructureConfiguration.go | 60 +- service/imagebuilder/go.mod | 2 +- service/imagebuilder/types/types.go | 508 +- .../api_op_AddAttributesToFindings.go | 8 +- .../api_op_CreateAssessmentTarget.go | 10 +- .../api_op_CreateAssessmentTemplate.go | 18 +- .../api_op_DescribeAssessmentTargets.go | 10 +- .../api_op_DescribeCrossAccountAccessRole.go | 10 +- service/inspector/api_op_DescribeFindings.go | 18 +- .../inspector/api_op_DescribeRulesPackages.go | 16 +- .../inspector/api_op_GetAssessmentReport.go | 12 +- .../inspector/api_op_GetExclusionsPreview.go | 26 +- .../api_op_ListAssessmentRunAgents.go | 20 +- .../inspector/api_op_ListAssessmentRuns.go | 20 +- .../inspector/api_op_ListAssessmentTargets.go | 20 +- .../api_op_ListEventSubscriptions.go | 8 +- service/inspector/api_op_ListExclusions.go | 12 +- service/inspector/api_op_ListFindings.go | 30 +- service/inspector/api_op_ListRulesPackages.go | 18 +- service/inspector/api_op_PreviewAgents.go | 10 +- .../api_op_RemoveAttributesFromFindings.go | 8 +- .../inspector/api_op_SetTagsForResource.go | 8 +- service/inspector/api_op_SubscribeToEvent.go | 10 +- .../inspector/api_op_UnsubscribeFromEvent.go | 10 +- .../api_op_UpdateAssessmentTarget.go | 8 +- service/inspector/go.mod | 2 +- service/inspector/types/types.go | 522 +- service/internal/benchmark/go.mod | 4 +- service/internal/benchmark/go.sum | 2 - service/internal/integrationtest/go.mod | 8 +- service/internal/integrationtest/go.sum | 2 - service/iot/api_op_AddThingToBillingGroup.go | 8 +- service/iot/api_op_AddThingToThingGroup.go | 12 +- service/iot/api_op_AssociateTargetsWithJob.go | 6 +- service/iot/api_op_AttachPolicy.go | 10 +- service/iot/api_op_AttachSecurityProfile.go | 8 +- service/iot/api_op_CancelJob.go | 14 +- service/iot/api_op_CancelJobExecution.go | 42 +- service/iot/api_op_CreateAuthorizer.go | 30 +- service/iot/api_op_CreateBillingGroup.go | 18 +- .../iot/api_op_CreateCertificateFromCsr.go | 16 +- service/iot/api_op_CreateDimension.go | 36 +- .../iot/api_op_CreateDomainConfiguration.go | 22 +- service/iot/api_op_CreateDynamicThingGroup.go | 36 +- service/iot/api_op_CreateJob.go | 54 +- .../iot/api_op_CreateKeysAndCertificate.go | 6 +- service/iot/api_op_CreateMitigationAction.go | 20 +- service/iot/api_op_CreateOTAUpdate.go | 54 +- service/iot/api_op_CreatePolicy.go | 26 +- service/iot/api_op_CreatePolicyVersion.go | 22 +- service/iot/api_op_CreateProvisioningClaim.go | 6 +- .../iot/api_op_CreateProvisioningTemplate.go | 42 +- ...pi_op_CreateProvisioningTemplateVersion.go | 18 +- service/iot/api_op_CreateRoleAlias.go | 18 +- service/iot/api_op_CreateScheduledAudit.go | 28 +- service/iot/api_op_CreateSecurityProfile.go | 28 +- service/iot/api_op_CreateStream.go | 26 +- service/iot/api_op_CreateThing.go | 12 +- service/iot/api_op_CreateThingGroup.go | 16 +- service/iot/api_op_CreateThingType.go | 16 +- service/iot/api_op_CreateTopicRule.go | 8 +- service/iot/api_op_DeleteBillingGroup.go | 10 +- service/iot/api_op_DeleteDynamicThingGroup.go | 6 +- service/iot/api_op_DeleteJob.go | 16 +- service/iot/api_op_DeleteJobExecution.go | 26 +- service/iot/api_op_DeleteOTAUpdate.go | 10 +- service/iot/api_op_DeletePolicyVersion.go | 8 +- service/iot/api_op_DeleteSecurityProfile.go | 10 +- service/iot/api_op_DeleteThingGroup.go | 6 +- service/iot/api_op_DeleteV2LoggingLevel.go | 8 +- service/iot/api_op_DeprecateThingType.go | 8 +- ...pi_op_DescribeAccountAuditConfiguration.go | 12 +- ...i_op_DescribeAuditMitigationActionsTask.go | 14 +- service/iot/api_op_DescribeAuditTask.go | 16 +- service/iot/api_op_DescribeBillingGroup.go | 18 +- service/iot/api_op_DescribeCACertificate.go | 6 +- service/iot/api_op_DescribeDimension.go | 18 +- .../iot/api_op_DescribeDomainConfiguration.go | 22 +- .../iot/api_op_DescribeEventConfigurations.go | 8 +- service/iot/api_op_DescribeIndex.go | 6 +- .../iot/api_op_DescribeMitigationAction.go | 20 +- .../api_op_DescribeProvisioningTemplate.go | 30 +- ..._op_DescribeProvisioningTemplateVersion.go | 6 +- service/iot/api_op_DescribeScheduledAudit.go | 16 +- service/iot/api_op_DescribeSecurityProfile.go | 34 +- service/iot/api_op_DescribeThing.go | 26 +- service/iot/api_op_DescribeThingGroup.go | 26 +- .../api_op_DescribeThingRegistrationTask.go | 38 +- service/iot/api_op_DescribeThingType.go | 6 +- service/iot/api_op_DetachPolicy.go | 8 +- service/iot/api_op_DetachPrincipalPolicy.go | 10 +- service/iot/api_op_DetachThingPrincipal.go | 10 +- service/iot/api_op_GetCardinality.go | 6 +- service/iot/api_op_GetEffectivePolicies.go | 6 +- .../iot/api_op_GetIndexingConfiguration.go | 6 +- service/iot/api_op_GetPercentiles.go | 18 +- service/iot/api_op_GetPolicy.go | 16 +- service/iot/api_op_GetPolicyVersion.go | 30 +- service/iot/api_op_GetStatistics.go | 12 +- service/iot/api_op_GetV2LoggingOptions.go | 6 +- service/iot/api_op_ListActiveViolations.go | 6 +- service/iot/api_op_ListAttachedPolicies.go | 20 +- service/iot/api_op_ListAuditFindings.go | 24 +- ...op_ListAuditMitigationActionsExecutions.go | 16 +- .../api_op_ListAuditMitigationActionsTasks.go | 40 +- service/iot/api_op_ListAuditTasks.go | 18 +- service/iot/api_op_ListAuthorizers.go | 8 +- service/iot/api_op_ListBillingGroups.go | 6 +- service/iot/api_op_ListCertificates.go | 12 +- service/iot/api_op_ListCertificatesByCA.go | 26 +- service/iot/api_op_ListDimensions.go | 6 +- .../iot/api_op_ListDomainConfigurations.go | 12 +- service/iot/api_op_ListIndices.go | 6 +- service/iot/api_op_ListJobExecutionsForJob.go | 16 +- .../iot/api_op_ListJobExecutionsForThing.go | 16 +- service/iot/api_op_ListJobs.go | 20 +- service/iot/api_op_ListOTAUpdates.go | 8 +- service/iot/api_op_ListPolicies.go | 16 +- service/iot/api_op_ListPolicyPrincipals.go | 6 +- service/iot/api_op_ListPrincipalPolicies.go | 18 +- ...api_op_ListProvisioningTemplateVersions.go | 6 +- service/iot/api_op_ListRoleAliases.go | 12 +- service/iot/api_op_ListScheduledAudits.go | 6 +- service/iot/api_op_ListSecurityProfiles.go | 10 +- .../api_op_ListSecurityProfilesForTarget.go | 16 +- service/iot/api_op_ListStreams.go | 6 +- service/iot/api_op_ListTagsForResource.go | 12 +- service/iot/api_op_ListTargetsForPolicy.go | 12 +- .../api_op_ListTargetsForSecurityProfile.go | 6 +- service/iot/api_op_ListThingGroups.go | 6 +- service/iot/api_op_ListThingGroupsForThing.go | 6 +- ...api_op_ListThingRegistrationTaskReports.go | 18 +- .../iot/api_op_ListThingRegistrationTasks.go | 6 +- service/iot/api_op_ListThingTypes.go | 14 +- service/iot/api_op_ListThings.go | 10 +- .../iot/api_op_ListThingsInBillingGroup.go | 6 +- service/iot/api_op_ListThingsInThingGroup.go | 18 +- .../iot/api_op_ListTopicRuleDestinations.go | 6 +- service/iot/api_op_ListTopicRules.go | 8 +- service/iot/api_op_ListV2LoggingLevels.go | 6 +- service/iot/api_op_ListViolationEvents.go | 20 +- service/iot/api_op_RegisterCACertificate.go | 18 +- service/iot/api_op_RegisterCertificate.go | 18 +- .../api_op_RegisterCertificateWithoutCA.go | 6 +- service/iot/api_op_RegisterThing.go | 16 +- .../iot/api_op_RejectCertificateTransfer.go | 6 +- .../iot/api_op_RemoveThingFromBillingGroup.go | 12 +- .../iot/api_op_RemoveThingFromThingGroup.go | 8 +- service/iot/api_op_ReplaceTopicRule.go | 8 +- service/iot/api_op_SearchIndex.go | 16 +- service/iot/api_op_SetDefaultAuthorizer.go | 6 +- service/iot/api_op_SetV2LoggingOptions.go | 6 +- .../api_op_StartAuditMitigationActionsTask.go | 12 +- .../iot/api_op_StartThingRegistrationTask.go | 8 +- service/iot/api_op_TagResource.go | 8 +- service/iot/api_op_TestAuthorization.go | 24 +- service/iot/api_op_TestInvokeAuthorizer.go | 38 +- service/iot/api_op_TransferCertificate.go | 6 +- service/iot/api_op_UntagResource.go | 8 +- service/iot/api_op_UpdateAuthorizer.go | 22 +- service/iot/api_op_UpdateBillingGroup.go | 10 +- service/iot/api_op_UpdateCACertificate.go | 14 +- service/iot/api_op_UpdateDimension.go | 22 +- .../iot/api_op_UpdateDomainConfiguration.go | 12 +- .../iot/api_op_UpdateIndexingConfiguration.go | 6 +- service/iot/api_op_UpdateJob.go | 18 +- service/iot/api_op_UpdateMitigationAction.go | 18 +- .../iot/api_op_UpdateProvisioningTemplate.go | 18 +- service/iot/api_op_UpdateRoleAlias.go | 12 +- service/iot/api_op_UpdateScheduledAudit.go | 22 +- service/iot/api_op_UpdateSecurityProfile.go | 66 +- service/iot/api_op_UpdateStream.go | 22 +- service/iot/api_op_UpdateThing.go | 16 +- service/iot/api_op_UpdateThingGroup.go | 8 +- .../iot/api_op_UpdateThingGroupsForThing.go | 6 +- service/iot/go.mod | 2 +- service/iot/types/types.go | 1432 ++-- .../api_op_InvokeDeviceMethod.go | 6 +- .../api_op_ListDeviceEvents.go | 8 +- .../api_op_ListDevices.go | 12 +- .../api_op_UpdateDeviceState.go | 6 +- service/iot1clickdevicesservice/go.mod | 2 +- .../iot1clickdevicesservice/types/types.go | 20 +- .../api_op_AssociateDeviceWithPlacement.go | 22 +- .../api_op_CreatePlacement.go | 8 +- .../api_op_DisassociateDeviceFromPlacement.go | 10 +- .../api_op_GetDevicesInPlacement.go | 8 +- .../api_op_ListPlacements.go | 14 +- .../iot1clickprojects/api_op_ListProjects.go | 8 +- .../iot1clickprojects/api_op_TagResource.go | 10 +- .../iot1clickprojects/api_op_UpdateProject.go | 10 +- service/iot1clickprojects/go.mod | 2 +- service/iot1clickprojects/types/types.go | 58 +- .../iotanalytics/api_op_BatchPutMessage.go | 10 +- service/iotanalytics/api_op_CreateChannel.go | 16 +- service/iotanalytics/api_op_CreateDataset.go | 44 +- .../iotanalytics/api_op_CreateDatastore.go | 20 +- service/iotanalytics/api_op_CreatePipeline.go | 12 +- .../iotanalytics/api_op_DescribeChannel.go | 6 +- .../iotanalytics/api_op_GetDatasetContent.go | 6 +- .../api_op_ListDatasetContents.go | 16 +- service/iotanalytics/api_op_ListDatasets.go | 12 +- service/iotanalytics/api_op_ListDatastores.go | 6 +- service/iotanalytics/api_op_ListPipelines.go | 6 +- .../api_op_RunPipelineActivity.go | 16 +- .../iotanalytics/api_op_SampleChannelData.go | 12 +- .../api_op_StartPipelineReprocessing.go | 6 +- service/iotanalytics/api_op_TagResource.go | 8 +- service/iotanalytics/api_op_UntagResource.go | 8 +- service/iotanalytics/api_op_UpdateChannel.go | 8 +- service/iotanalytics/api_op_UpdateDataset.go | 24 +- service/iotanalytics/api_op_UpdatePipeline.go | 10 +- service/iotanalytics/go.mod | 2 +- service/iotanalytics/types/types.go | 476 +- .../iotdataplane/api_op_DeleteThingShadow.go | 6 +- .../api_op_ListNamedShadowsForThing.go | 6 +- service/iotdataplane/api_op_Publish.go | 6 +- .../iotdataplane/api_op_UpdateThingShadow.go | 6 +- service/iotdataplane/go.mod | 2 +- .../iotevents/api_op_CreateDetectorModel.go | 38 +- service/iotevents/api_op_CreateInput.go | 14 +- .../iotevents/api_op_DescribeDetectorModel.go | 6 +- .../api_op_ListDetectorModelVersions.go | 12 +- .../iotevents/api_op_ListDetectorModels.go | 6 +- service/iotevents/api_op_ListInputs.go | 6 +- service/iotevents/api_op_UntagResource.go | 8 +- .../iotevents/api_op_UpdateDetectorModel.go | 14 +- service/iotevents/api_op_UpdateInput.go | 10 +- service/iotevents/go.mod | 2 +- service/iotevents/types/types.go | 358 +- service/ioteventsdata/api_op_ListDetectors.go | 10 +- service/ioteventsdata/go.mod | 2 +- service/ioteventsdata/types/types.go | 102 +- .../api_op_DescribeJobExecution.go | 8 +- .../api_op_StartNextPendingJobExecution.go | 18 +- .../api_op_UpdateJobExecution.go | 30 +- service/iotjobsdataplane/go.mod | 2 +- service/iotjobsdataplane/types/types.go | 70 +- .../iotsecuretunneling/api_op_ListTunnels.go | 6 +- .../iotsecuretunneling/api_op_OpenTunnel.go | 20 +- .../iotsecuretunneling/api_op_TagResource.go | 8 +- .../api_op_UntagResource.go | 8 +- service/iotsecuretunneling/go.mod | 2 +- service/iotsecuretunneling/types/types.go | 66 +- service/iotsitewise/api_op_AssociateAssets.go | 10 +- .../api_op_BatchDisassociateProjectAssets.go | 8 +- .../iotsitewise/api_op_CreateAccessPolicy.go | 28 +- service/iotsitewise/api_op_CreateAsset.go | 36 +- .../iotsitewise/api_op_CreateAssetModel.go | 42 +- service/iotsitewise/api_op_CreateDashboard.go | 32 +- service/iotsitewise/api_op_CreateGateway.go | 22 +- service/iotsitewise/api_op_CreatePortal.go | 58 +- service/iotsitewise/api_op_CreateProject.go | 26 +- service/iotsitewise/api_op_DeleteAsset.go | 10 +- .../iotsitewise/api_op_DeleteAssetModel.go | 10 +- service/iotsitewise/api_op_DeleteProject.go | 10 +- .../api_op_DescribeAccessPolicy.go | 36 +- service/iotsitewise/api_op_DescribeAsset.go | 36 +- .../iotsitewise/api_op_DescribeAssetModel.go | 40 +- .../api_op_DescribeAssetProperty.go | 16 +- .../iotsitewise/api_op_DescribeDashboard.go | 38 +- service/iotsitewise/api_op_DescribeGateway.go | 32 +- ..._DescribeGatewayCapabilityConfiguration.go | 10 +- service/iotsitewise/api_op_DescribePortal.go | 48 +- service/iotsitewise/api_op_DescribeProject.go | 32 +- .../iotsitewise/api_op_DisassociateAssets.go | 26 +- .../api_op_GetAssetPropertyAggregates.go | 40 +- .../api_op_GetAssetPropertyValueHistory.go | 32 +- .../iotsitewise/api_op_ListAccessPolicies.go | 14 +- service/iotsitewise/api_op_ListAssetModels.go | 6 +- service/iotsitewise/api_op_ListAssets.go | 6 +- .../api_op_ListAssociatedAssets.go | 14 +- service/iotsitewise/api_op_ListDashboards.go | 8 +- service/iotsitewise/api_op_ListGateways.go | 6 +- .../iotsitewise/api_op_ListProjectAssets.go | 14 +- service/iotsitewise/api_op_ListProjects.go | 14 +- service/iotsitewise/api_op_UntagResource.go | 10 +- .../iotsitewise/api_op_UpdateAccessPolicy.go | 28 +- service/iotsitewise/api_op_UpdateAsset.go | 8 +- .../iotsitewise/api_op_UpdateAssetModel.go | 28 +- .../iotsitewise/api_op_UpdateAssetProperty.go | 20 +- service/iotsitewise/api_op_UpdateDashboard.go | 20 +- service/iotsitewise/api_op_UpdateGateway.go | 8 +- ...op_UpdateGatewayCapabilityConfiguration.go | 26 +- service/iotsitewise/api_op_UpdatePortal.go | 42 +- service/iotsitewise/api_op_UpdateProject.go | 14 +- service/iotsitewise/go.mod | 2 +- service/iotsitewise/types/types.go | 476 +- .../api_op_AssociateEntityToThing.go | 16 +- .../api_op_CreateSystemInstance.go | 42 +- .../iotthingsgraph/api_op_DeleteNamespace.go | 6 +- .../api_op_DeploySystemInstance.go | 6 +- .../api_op_DescribeNamespace.go | 16 +- service/iotthingsgraph/api_op_GetEntities.go | 8 +- .../api_op_GetFlowTemplateRevisions.go | 20 +- .../api_op_GetNamespaceDeletionStatus.go | 14 +- .../api_op_GetSystemTemplate.go | 6 +- .../api_op_GetSystemTemplateRevisions.go | 6 +- .../iotthingsgraph/api_op_GetUploadStatus.go | 32 +- .../api_op_ListFlowExecutionMessages.go | 6 +- .../api_op_ListTagsForResource.go | 6 +- .../iotthingsgraph/api_op_SearchEntities.go | 20 +- .../api_op_SearchFlowExecutions.go | 22 +- .../api_op_SearchFlowTemplates.go | 18 +- .../api_op_SearchSystemInstances.go | 10 +- .../api_op_SearchSystemTemplates.go | 8 +- service/iotthingsgraph/api_op_SearchThings.go | 14 +- .../iotthingsgraph/api_op_UntagResource.go | 10 +- .../api_op_UpdateFlowTemplate.go | 10 +- .../api_op_UpdateSystemTemplate.go | 10 +- service/iotthingsgraph/go.mod | 2 +- service/iotthingsgraph/types/types.go | 156 +- service/ivs/api_op_BatchGetChannel.go | 3 +- service/ivs/api_op_BatchGetStreamKey.go | 4 +- service/ivs/api_op_CreateChannel.go | 6 +- service/ivs/api_op_ListChannels.go | 6 +- service/ivs/api_op_ListTagsForResource.go | 17 +- service/ivs/api_op_PutMetadata.go | 10 +- service/ivs/api_op_UpdateChannel.go | 6 +- service/ivs/go.mod | 2 +- service/ivs/types/types.go | 90 +- service/kafka/api_op_CreateCluster.go | 46 +- service/kafka/api_op_CreateConfiguration.go | 20 +- service/kafka/api_op_DeleteCluster.go | 6 +- service/kafka/api_op_DescribeConfiguration.go | 18 +- service/kafka/api_op_GetBootstrapBrokers.go | 6 +- service/kafka/api_op_ListClusterOperations.go | 16 +- service/kafka/api_op_ListClusters.go | 10 +- .../api_op_ListConfigurationRevisions.go | 18 +- service/kafka/api_op_ListConfigurations.go | 14 +- service/kafka/api_op_ListKafkaVersions.go | 4 +- service/kafka/api_op_ListNodes.go | 16 +- service/kafka/api_op_UntagResource.go | 12 +- service/kafka/api_op_UpdateBrokerCount.go | 10 +- service/kafka/api_op_UpdateBrokerStorage.go | 18 +- .../api_op_UpdateClusterConfiguration.go | 16 +- .../kafka/api_op_UpdateClusterKafkaVersion.go | 6 +- service/kafka/api_op_UpdateMonitoring.go | 24 +- service/kafka/go.mod | 2 +- service/kafka/types/types.go | 234 +- service/kendra/api_op_BatchDeleteDocument.go | 10 +- service/kendra/api_op_BatchPutDocument.go | 10 +- service/kendra/api_op_CreateDataSource.go | 40 +- service/kendra/api_op_CreateFaq.go | 24 +- service/kendra/api_op_CreateIndex.go | 34 +- service/kendra/api_op_DeleteFaq.go | 8 +- service/kendra/api_op_DescribeDataSource.go | 50 +- service/kendra/api_op_DescribeFaq.go | 24 +- service/kendra/api_op_DescribeIndex.go | 48 +- .../kendra/api_op_ListDataSourceSyncJobs.go | 8 +- service/kendra/api_op_ListIndices.go | 6 +- service/kendra/api_op_Query.go | 40 +- service/kendra/api_op_SubmitFeedback.go | 6 +- service/kendra/api_op_UpdateDataSource.go | 22 +- service/kendra/api_op_UpdateIndex.go | 18 +- service/kendra/go.mod | 2 +- service/kendra/types/types.go | 672 +- .../api_op_DecreaseStreamRetentionPeriod.go | 10 +- .../api_op_DeregisterStreamConsumer.go | 10 +- service/kinesis/api_op_DescribeStream.go | 14 +- .../kinesis/api_op_DescribeStreamConsumer.go | 6 +- .../api_op_DisableEnhancedMonitoring.go | 16 +- .../api_op_EnableEnhancedMonitoring.go | 16 +- service/kinesis/api_op_GetRecords.go | 20 +- service/kinesis/api_op_GetShardIterator.go | 22 +- service/kinesis/api_op_ListShards.go | 14 +- service/kinesis/api_op_ListStreamConsumers.go | 40 +- service/kinesis/api_op_ListTagsForStream.go | 8 +- service/kinesis/api_op_PutRecord.go | 62 +- service/kinesis/api_op_PutRecords.go | 24 +- .../kinesis/api_op_RegisterStreamConsumer.go | 12 +- .../kinesis/api_op_RemoveTagsFromStream.go | 8 +- .../kinesis/api_op_StartStreamEncryption.go | 10 +- .../kinesis/api_op_StopStreamEncryption.go | 10 +- service/kinesis/api_op_UpdateShardCount.go | 10 +- service/kinesis/go.mod | 2 +- service/kinesis/types/types.go | 288 +- ...p_AddApplicationCloudWatchLoggingOption.go | 10 +- .../api_op_AddApplicationInput.go | 12 +- ...ApplicationInputProcessingConfiguration.go | 12 +- .../api_op_AddApplicationOutput.go | 10 +- ...pi_op_AddApplicationReferenceDataSource.go | 10 +- .../api_op_CreateApplication.go | 54 +- .../api_op_DeleteApplication.go | 8 +- ...eleteApplicationCloudWatchLoggingOption.go | 10 +- .../api_op_DeleteApplicationOutput.go | 10 +- ...op_DeleteApplicationReferenceDataSource.go | 16 +- .../api_op_DiscoverInputSchema.go | 24 +- .../api_op_ListApplications.go | 6 +- .../api_op_StartApplication.go | 10 +- .../kinesisanalytics/api_op_UntagResource.go | 8 +- service/kinesisanalytics/go.mod | 2 +- service/kinesisanalytics/types/types.go | 434 +- ...p_AddApplicationCloudWatchLoggingOption.go | 16 +- .../api_op_AddApplicationInput.go | 18 +- ...ApplicationInputProcessingConfiguration.go | 24 +- .../api_op_AddApplicationOutput.go | 22 +- ...pi_op_AddApplicationReferenceDataSource.go | 22 +- .../api_op_AddApplicationVpcConfiguration.go | 16 +- .../api_op_CreateApplication.go | 12 +- .../api_op_CreateApplicationSnapshot.go | 8 +- .../api_op_DeleteApplication.go | 8 +- ...eleteApplicationCloudWatchLoggingOption.go | 6 +- ...ApplicationInputProcessingConfiguration.go | 18 +- .../api_op_DeleteApplicationOutput.go | 26 +- ...op_DeleteApplicationReferenceDataSource.go | 22 +- .../api_op_DeleteApplicationSnapshot.go | 10 +- ...pi_op_DeleteApplicationVpcConfiguration.go | 10 +- .../api_op_DescribeApplication.go | 8 +- .../api_op_DiscoverInputSchema.go | 20 +- .../api_op_ListApplicationSnapshots.go | 16 +- .../api_op_ListApplications.go | 10 +- .../kinesisanalyticsv2/api_op_TagResource.go | 8 +- .../api_op_UpdateApplication.go | 24 +- service/kinesisanalyticsv2/go.mod | 2 +- service/kinesisanalyticsv2/types/types.go | 690 +- .../api_op_CreateSignalingChannel.go | 10 +- service/kinesisvideo/api_op_CreateStream.go | 34 +- service/kinesisvideo/api_op_DeleteStream.go | 10 +- .../kinesisvideo/api_op_GetDataEndpoint.go | 10 +- .../api_op_GetSignalingChannelEndpoint.go | 8 +- .../api_op_ListSignalingChannels.go | 12 +- .../api_op_ListTagsForResource.go | 6 +- .../kinesisvideo/api_op_ListTagsForStream.go | 10 +- service/kinesisvideo/api_op_TagResource.go | 12 +- service/kinesisvideo/api_op_TagStream.go | 12 +- service/kinesisvideo/api_op_UntagResource.go | 10 +- service/kinesisvideo/api_op_UntagStream.go | 6 +- .../api_op_UpdateDataRetention.go | 6 +- .../api_op_UpdateSignalingChannel.go | 8 +- service/kinesisvideo/api_op_UpdateStream.go | 12 +- service/kinesisvideo/go.mod | 2 +- service/kinesisvideo/types/types.go | 58 +- .../api_op_GetClip.go | 14 +- .../api_op_GetDASHStreamingSessionURL.go | 46 +- .../api_op_GetHLSStreamingSessionURL.go | 62 +- .../api_op_GetMediaForFragmentList.go | 10 +- .../api_op_ListFragments.go | 8 +- service/kinesisvideoarchivedmedia/go.mod | 2 +- .../kinesisvideoarchivedmedia/types/types.go | 90 +- service/kinesisvideomedia/api_op_GetMedia.go | 10 +- service/kinesisvideomedia/go.mod | 2 +- service/kinesisvideomedia/types/types.go | 28 +- .../api_op_GetIceServerConfig.go | 16 +- .../api_op_SendAlexaOfferToMaster.go | 8 +- service/kinesisvideosignaling/go.mod | 2 +- service/kinesisvideosignaling/types/types.go | 6 +- service/kms/api_op_CreateCustomKeyStore.go | 16 +- service/kms/api_op_CreateGrant.go | 64 +- service/kms/api_op_CreateKey.go | 136 +- service/kms/api_op_Decrypt.go | 72 +- service/kms/api_op_DescribeCustomKeyStores.go | 36 +- service/kms/api_op_DescribeKey.go | 10 +- service/kms/api_op_Encrypt.go | 28 +- service/kms/api_op_GenerateDataKey.go | 48 +- service/kms/api_op_GenerateDataKeyPair.go | 40 +- ..._op_GenerateDataKeyPairWithoutPlaintext.go | 6 +- .../api_op_GenerateDataKeyWithoutPlaintext.go | 30 +- service/kms/api_op_GenerateRandom.go | 6 +- service/kms/api_op_GetKeyPolicy.go | 12 +- service/kms/api_op_GetParametersForImport.go | 26 +- service/kms/api_op_GetPublicKey.go | 30 +- service/kms/api_op_ImportKeyMaterial.go | 16 +- service/kms/api_op_ListAliases.go | 16 +- service/kms/api_op_ListGrants.go | 10 +- service/kms/api_op_ListKeyPolicies.go | 22 +- service/kms/api_op_ListKeys.go | 16 +- service/kms/api_op_ListResourceTags.go | 20 +- service/kms/api_op_ListRetirableGrants.go | 24 +- service/kms/api_op_PutKeyPolicy.go | 20 +- service/kms/api_op_ReEncrypt.go | 128 +- service/kms/api_op_RetireGrant.go | 14 +- service/kms/api_op_ScheduleKeyDeletion.go | 6 +- service/kms/api_op_Sign.go | 26 +- service/kms/api_op_UpdateAlias.go | 14 +- service/kms/api_op_UpdateCustomKeyStore.go | 22 +- service/kms/api_op_Verify.go | 60 +- service/kms/go.mod | 2 +- service/kms/types/types.go | 170 +- .../api_op_BatchRevokePermissions.go | 12 +- .../api_op_GetEffectivePermissionsForPath.go | 18 +- .../lakeformation/api_op_GrantPermissions.go | 22 +- .../lakeformation/api_op_ListPermissions.go | 18 +- service/lakeformation/api_op_ListResources.go | 14 +- .../lakeformation/api_op_RevokePermissions.go | 30 +- service/lakeformation/go.mod | 2 +- service/lakeformation/types/types.go | 114 +- .../api_op_AddLayerVersionPermission.go | 22 +- service/lambda/api_op_AddPermission.go | 46 +- service/lambda/api_op_CreateAlias.go | 38 +- .../lambda/api_op_CreateEventSourceMapping.go | 136 +- service/lambda/api_op_CreateFunction.go | 240 +- service/lambda/api_op_DeleteAlias.go | 10 +- .../lambda/api_op_DeleteEventSourceMapping.go | 48 +- .../api_op_DeleteFunctionEventInvokeConfig.go | 6 +- service/lambda/api_op_GetAlias.go | 24 +- .../lambda/api_op_GetEventSourceMapping.go | 48 +- service/lambda/api_op_GetFunction.go | 14 +- .../lambda/api_op_GetFunctionConfiguration.go | 110 +- .../api_op_GetFunctionEventInvokeConfig.go | 18 +- service/lambda/api_op_GetLayerVersion.go | 24 +- service/lambda/api_op_GetLayerVersionByArn.go | 24 +- .../lambda/api_op_GetLayerVersionPolicy.go | 8 +- .../api_op_GetProvisionedConcurrencyConfig.go | 26 +- service/lambda/api_op_Invoke.go | 56 +- service/lambda/api_op_InvokeAsync.go | 10 +- service/lambda/api_op_ListAliases.go | 14 +- .../lambda/api_op_ListEventSourceMappings.go | 38 +- .../api_op_ListFunctionEventInvokeConfigs.go | 12 +- service/lambda/api_op_ListFunctions.go | 10 +- service/lambda/api_op_ListLayerVersions.go | 16 +- service/lambda/api_op_ListLayers.go | 12 +- ...pi_op_ListProvisionedConcurrencyConfigs.go | 20 +- .../lambda/api_op_ListVersionsByFunction.go | 14 +- service/lambda/api_op_PublishLayerVersion.go | 30 +- service/lambda/api_op_PublishVersion.go | 140 +- .../lambda/api_op_PutFunctionConcurrency.go | 10 +- .../api_op_PutFunctionEventInvokeConfig.go | 56 +- .../api_op_PutProvisionedConcurrencyConfig.go | 20 +- .../api_op_RemoveLayerVersionPermission.go | 10 +- service/lambda/api_op_TagResource.go | 8 +- service/lambda/api_op_UntagResource.go | 8 +- service/lambda/api_op_UpdateAlias.go | 62 +- .../lambda/api_op_UpdateEventSourceMapping.go | 80 +- service/lambda/api_op_UpdateFunctionCode.go | 152 +- .../api_op_UpdateFunctionConfiguration.go | 212 +- .../api_op_UpdateFunctionEventInvokeConfig.go | 30 +- service/lambda/go.mod | 2 +- service/lambda/types/types.go | 298 +- .../api_op_CreateBotVersion.go | 62 +- .../api_op_CreateIntentVersion.go | 70 +- .../api_op_CreateSlotTypeVersion.go | 42 +- .../api_op_DeleteBotChannelAssociation.go | 10 +- .../api_op_DeleteBotVersion.go | 10 +- .../api_op_DeleteSlotTypeVersion.go | 10 +- .../lexmodelbuildingservice/api_op_GetBot.go | 80 +- .../api_op_GetBotAlias.go | 20 +- .../api_op_GetBotAliases.go | 24 +- .../api_op_GetBotChannelAssociation.go | 38 +- .../api_op_GetBotChannelAssociations.go | 26 +- .../api_op_GetBotVersions.go | 16 +- .../lexmodelbuildingservice/api_op_GetBots.go | 20 +- .../api_op_GetBuiltinIntent.go | 6 +- .../api_op_GetBuiltinIntents.go | 10 +- .../api_op_GetBuiltinSlotTypes.go | 18 +- .../api_op_GetExport.go | 44 +- .../api_op_GetImport.go | 24 +- .../api_op_GetIntent.go | 58 +- .../api_op_GetIntentVersions.go | 8 +- .../api_op_GetIntents.go | 12 +- .../api_op_GetSlotType.go | 36 +- .../api_op_GetSlotTypeVersions.go | 16 +- .../api_op_GetSlotTypes.go | 22 +- .../api_op_GetUtterancesView.go | 16 +- .../lexmodelbuildingservice/api_op_PutBot.go | 164 +- .../api_op_PutBotAlias.go | 38 +- .../api_op_PutIntent.go | 176 +- .../api_op_PutSlotType.go | 118 +- .../api_op_StartImport.go | 60 +- .../api_op_TagResource.go | 10 +- service/lexmodelbuildingservice/go.mod | 2 +- .../lexmodelbuildingservice/types/types.go | 298 +- .../lexruntimeservice/api_op_DeleteSession.go | 14 +- .../lexruntimeservice/api_op_GetSession.go | 24 +- .../lexruntimeservice/api_op_PostContent.go | 204 +- service/lexruntimeservice/api_op_PostText.go | 164 +- .../lexruntimeservice/api_op_PutSession.go | 138 +- service/lexruntimeservice/go.mod | 2 +- service/lexruntimeservice/types/types.go | 98 +- .../api_op_CreateLicenseConfiguration.go | 32 +- .../api_op_GetLicenseConfiguration.go | 58 +- .../api_op_GetServiceSettings.go | 14 +- ...ListAssociationsForLicenseConfiguration.go | 12 +- ...iluresForLicenseConfigurationOperations.go | 12 +- .../api_op_ListLicenseConfigurations.go | 12 +- ...op_ListLicenseSpecificationsForResource.go | 6 +- .../api_op_ListResourceInventory.go | 18 +- ...api_op_ListUsageForLicenseConfiguration.go | 20 +- service/licensemanager/api_op_TagResource.go | 8 +- .../licensemanager/api_op_UntagResource.go | 8 +- .../api_op_UpdateLicenseConfiguration.go | 26 +- ..._UpdateLicenseSpecificationsForResource.go | 6 +- .../api_op_UpdateServiceSettings.go | 16 +- service/licensemanager/go.mod | 2 +- service/licensemanager/types/types.go | 128 +- service/lightsail/api_op_AttachDisk.go | 10 +- ...api_op_AttachLoadBalancerTlsCertificate.go | 10 +- service/lightsail/api_op_AttachStaticIp.go | 8 +- .../api_op_CloseInstancePublicPorts.go | 8 +- service/lightsail/api_op_CopySnapshot.go | 40 +- service/lightsail/api_op_CreateCertificate.go | 18 +- .../lightsail/api_op_CreateContactMethod.go | 24 +- service/lightsail/api_op_CreateDisk.go | 20 +- .../api_op_CreateDiskFromSnapshot.go | 64 +- .../lightsail/api_op_CreateDiskSnapshot.go | 12 +- .../lightsail/api_op_CreateDistribution.go | 48 +- .../api_op_CreateInstanceSnapshot.go | 10 +- service/lightsail/api_op_CreateInstances.go | 40 +- .../api_op_CreateInstancesFromSnapshot.go | 72 +- service/lightsail/api_op_CreateKeyPair.go | 16 +- .../lightsail/api_op_CreateLoadBalancer.go | 30 +- ...api_op_CreateLoadBalancerTlsCertificate.go | 30 +- .../api_op_CreateRelationalDatabase.go | 108 +- ...op_CreateRelationalDatabaseFromSnapshot.go | 34 +- ...api_op_CreateRelationalDatabaseSnapshot.go | 14 +- .../lightsail/api_op_DeleteAutoSnapshot.go | 12 +- service/lightsail/api_op_DeleteDisk.go | 6 +- service/lightsail/api_op_DeleteDomainEntry.go | 8 +- ...api_op_DeleteLoadBalancerTlsCertificate.go | 18 +- .../api_op_DownloadDefaultKeyPair.go | 6 +- service/lightsail/api_op_GetActiveNames.go | 6 +- service/lightsail/api_op_GetAlarms.go | 14 +- service/lightsail/api_op_GetAutoSnapshots.go | 6 +- service/lightsail/api_op_GetBlueprints.go | 6 +- service/lightsail/api_op_GetBundles.go | 8 +- service/lightsail/api_op_GetCertificates.go | 10 +- .../api_op_GetDistributionLatestCacheReset.go | 6 +- .../api_op_GetDistributionMetricData.go | 68 +- service/lightsail/api_op_GetDistributions.go | 12 +- .../api_op_GetInstanceAccessDetails.go | 6 +- .../lightsail/api_op_GetInstanceMetricData.go | 92 +- .../lightsail/api_op_GetInstanceSnapshots.go | 8 +- .../api_op_GetLoadBalancerMetricData.go | 24 +- service/lightsail/api_op_GetOperations.go | 10 +- .../api_op_GetOperationsForResource.go | 20 +- .../api_op_GetRelationalDatabaseBundles.go | 6 +- .../api_op_GetRelationalDatabaseEvents.go | 24 +- .../api_op_GetRelationalDatabaseLogEvents.go | 40 +- ...GetRelationalDatabaseMasterUserPassword.go | 10 +- .../api_op_GetRelationalDatabaseMetricData.go | 42 +- .../api_op_GetRelationalDatabaseParameters.go | 10 +- .../api_op_GetRelationalDatabases.go | 6 +- service/lightsail/api_op_GetStaticIps.go | 8 +- service/lightsail/api_op_ImportKeyPair.go | 8 +- service/lightsail/api_op_PutAlarm.go | 118 +- .../api_op_StopRelationalDatabase.go | 8 +- service/lightsail/api_op_TagResource.go | 6 +- service/lightsail/api_op_TestAlarm.go | 10 +- .../lightsail/api_op_UpdateDistribution.go | 18 +- .../api_op_UpdateLoadBalancerAttribute.go | 8 +- .../api_op_UpdateRelationalDatabase.go | 66 +- ...i_op_UpdateRelationalDatabaseParameters.go | 8 +- service/lightsail/go.mod | 2 +- service/lightsail/types/types.go | 1788 ++--- service/machinelearning/api_op_AddTags.go | 10 +- .../api_op_CreateBatchPrediction.go | 22 +- .../api_op_CreateDataSourceFromRDS.go | 26 +- .../api_op_CreateDataSourceFromRedshift.go | 18 +- .../api_op_CreateDataSourceFromS3.go | 18 +- .../api_op_CreateEvaluation.go | 10 +- .../machinelearning/api_op_CreateMLModel.go | 58 +- service/machinelearning/api_op_DeleteTags.go | 10 +- .../api_op_DescribeBatchPredictions.go | 100 +- .../api_op_DescribeDataSources.go | 86 +- .../api_op_DescribeEvaluations.go | 76 +- .../api_op_DescribeMLModels.go | 90 +- .../machinelearning/api_op_DescribeTags.go | 8 +- .../api_op_GetBatchPrediction.go | 92 +- .../machinelearning/api_op_GetDataSource.go | 96 +- .../machinelearning/api_op_GetEvaluation.go | 48 +- service/machinelearning/api_op_GetMLModel.go | 160 +- service/machinelearning/api_op_Predict.go | 10 +- .../api_op_UpdateBatchPrediction.go | 8 +- .../api_op_UpdateEvaluation.go | 10 +- .../machinelearning/api_op_UpdateMLModel.go | 16 +- service/machinelearning/go.mod | 2 +- service/machinelearning/types/types.go | 630 +- .../macie/api_op_DisassociateS3Resources.go | 8 +- service/macie/api_op_ListS3Resources.go | 8 +- service/macie/go.mod | 2 +- service/macie/types/types.go | 48 +- .../macie2/api_op_CreateClassificationJob.go | 56 +- .../api_op_CreateCustomDataIdentifier.go | 58 +- service/macie2/api_op_CreateFindingsFilter.go | 50 +- service/macie2/api_op_CreateInvitations.go | 16 +- service/macie2/api_op_CreateMember.go | 10 +- service/macie2/api_op_DescribeBuckets.go | 8 +- .../api_op_DescribeClassificationJob.go | 66 +- .../api_op_EnableOrganizationAdminAccount.go | 8 +- service/macie2/api_op_GetBucketStatistics.go | 30 +- .../macie2/api_op_GetCustomDataIdentifier.go | 46 +- service/macie2/api_op_GetFindingStatistics.go | 12 +- service/macie2/api_op_GetFindings.go | 6 +- service/macie2/api_op_GetFindingsFilter.go | 22 +- service/macie2/api_op_GetMacieSession.go | 26 +- service/macie2/api_op_GetMember.go | 18 +- service/macie2/api_op_GetUsageStatistics.go | 14 +- .../macie2/api_op_ListClassificationJobs.go | 14 +- service/macie2/api_op_ListFindings.go | 10 +- service/macie2/api_op_ListFindingsFilters.go | 6 +- service/macie2/api_op_ListInvitations.go | 6 +- service/macie2/api_op_ListMembers.go | 8 +- service/macie2/api_op_TagResource.go | 12 +- .../macie2/api_op_TestCustomDataIdentifier.go | 12 +- service/macie2/api_op_UpdateFindingsFilter.go | 40 +- service/macie2/api_op_UpdateMemberSession.go | 12 +- service/macie2/go.mod | 2 +- service/macie2/types/types.go | 672 +- .../managedblockchain/api_op_CreateMember.go | 24 +- .../managedblockchain/api_op_CreateNetwork.go | 32 +- .../managedblockchain/api_op_CreateNode.go | 8 +- .../api_op_CreateProposal.go | 20 +- .../managedblockchain/api_op_DeleteMember.go | 8 +- .../managedblockchain/api_op_DeleteNode.go | 10 +- service/managedblockchain/api_op_GetNode.go | 10 +- .../managedblockchain/api_op_GetProposal.go | 8 +- .../managedblockchain/api_op_ListMembers.go | 16 +- .../managedblockchain/api_op_ListNetworks.go | 20 +- service/managedblockchain/api_op_ListNodes.go | 18 +- .../api_op_ListProposalVotes.go | 12 +- .../managedblockchain/api_op_ListProposals.go | 12 +- .../managedblockchain/api_op_UpdateMember.go | 8 +- .../managedblockchain/api_op_UpdateNode.go | 16 +- .../api_op_VoteOnProposal.go | 10 +- service/managedblockchain/go.mod | 2 +- service/managedblockchain/types/types.go | 290 +- .../api_op_CancelChangeSet.go | 16 +- .../api_op_DescribeChangeSet.go | 36 +- .../api_op_DescribeEntity.go | 18 +- .../api_op_ListChangeSets.go | 26 +- .../marketplacecatalog/api_op_ListEntities.go | 20 +- .../api_op_StartChangeSet.go | 16 +- service/marketplacecatalog/go.mod | 2 +- service/marketplacecatalog/types/types.go | 74 +- .../api_op_GenerateDataSet.go | 48 +- .../api_op_StartSupportDataExport.go | 46 +- service/marketplacecommerceanalytics/go.mod | 2 +- .../api_op_GetEntitlements.go | 26 +- service/marketplaceentitlementservice/go.mod | 2 +- .../types/types.go | 24 +- .../marketplacemetering/api_op_MeterUsage.go | 26 +- .../api_op_RegisterUsage.go | 8 +- .../api_op_ResolveCustomer.go | 10 +- service/marketplacemetering/go.mod | 2 +- service/marketplacemetering/types/types.go | 22 +- service/mediaconnect/api_op_AddFlowSources.go | 8 +- .../api_op_AddFlowVpcInterfaces.go | 6 +- service/mediaconnect/api_op_CreateFlow.go | 24 +- service/mediaconnect/api_op_DescribeFlow.go | 6 +- service/mediaconnect/api_op_ListFlows.go | 14 +- .../api_op_RemoveFlowVpcInterface.go | 6 +- .../api_op_RevokeFlowEntitlement.go | 6 +- service/mediaconnect/api_op_TagResource.go | 12 +- service/mediaconnect/api_op_UpdateFlow.go | 6 +- .../api_op_UpdateFlowEntitlement.go | 32 +- .../mediaconnect/api_op_UpdateFlowOutput.go | 46 +- .../mediaconnect/api_op_UpdateFlowSource.go | 46 +- service/mediaconnect/go.mod | 2 +- service/mediaconnect/types/types.go | 440 +- service/mediaconvert/api_op_CreateJob.go | 82 +- .../mediaconvert/api_op_CreateJobTemplate.go | 50 +- service/mediaconvert/api_op_CreatePreset.go | 20 +- service/mediaconvert/api_op_CreateQueue.go | 26 +- .../mediaconvert/api_op_DescribeEndpoints.go | 14 +- .../mediaconvert/api_op_ListJobTemplates.go | 22 +- service/mediaconvert/api_op_ListJobs.go | 24 +- service/mediaconvert/api_op_ListPresets.go | 22 +- service/mediaconvert/api_op_ListQueues.go | 12 +- service/mediaconvert/api_op_TagResource.go | 12 +- .../mediaconvert/api_op_UpdateJobTemplate.go | 46 +- service/mediaconvert/api_op_UpdatePreset.go | 6 +- service/mediaconvert/api_op_UpdateQueue.go | 18 +- service/mediaconvert/go.mod | 2 +- service/mediaconvert/types/types.go | 4470 +++++------ .../medialive/api_op_BatchUpdateSchedule.go | 12 +- service/medialive/api_op_CreateChannel.go | 34 +- service/medialive/api_op_CreateInput.go | 40 +- .../api_op_CreateInputSecurityGroup.go | 6 +- service/medialive/api_op_CreateMultiplex.go | 10 +- service/medialive/api_op_CreateTags.go | 6 +- service/medialive/api_op_DeleteChannel.go | 48 +- service/medialive/api_op_DeleteMultiplex.go | 30 +- .../api_op_DeleteMultiplexProgram.go | 18 +- service/medialive/api_op_DeleteReservation.go | 64 +- service/medialive/api_op_DescribeChannel.go | 50 +- service/medialive/api_op_DescribeInput.go | 62 +- .../medialive/api_op_DescribeInputDevice.go | 30 +- .../api_op_DescribeInputDeviceThumbnail.go | 20 +- .../api_op_DescribeInputSecurityGroup.go | 14 +- service/medialive/api_op_DescribeMultiplex.go | 26 +- .../api_op_DescribeMultiplexProgram.go | 6 +- service/medialive/api_op_DescribeOffering.go | 38 +- .../medialive/api_op_DescribeReservation.go | 56 +- service/medialive/api_op_DescribeSchedule.go | 6 +- service/medialive/api_op_ListChannels.go | 6 +- service/medialive/api_op_ListInputs.go | 6 +- .../medialive/api_op_ListMultiplexPrograms.go | 6 +- service/medialive/api_op_ListOfferings.go | 44 +- service/medialive/api_op_ListReservations.go | 36 +- service/medialive/api_op_PurchaseOffering.go | 22 +- service/medialive/api_op_StartChannel.go | 52 +- service/medialive/api_op_StartMultiplex.go | 32 +- service/medialive/api_op_StopChannel.go | 54 +- service/medialive/api_op_StopMultiplex.go | 26 +- service/medialive/api_op_UpdateChannel.go | 22 +- service/medialive/api_op_UpdateInput.go | 34 +- service/medialive/api_op_UpdateInputDevice.go | 38 +- .../api_op_UpdateInputSecurityGroup.go | 12 +- service/medialive/api_op_UpdateMultiplex.go | 6 +- .../api_op_UpdateMultiplexProgram.go | 10 +- service/medialive/go.mod | 2 +- service/medialive/types/types.go | 3154 ++++---- service/mediapackage/api_op_CreateChannel.go | 14 +- .../mediapackage/api_op_CreateHarvestJob.go | 48 +- .../api_op_CreateOriginEndpoint.go | 118 +- .../mediapackage/api_op_DescribeChannel.go | 14 +- .../mediapackage/api_op_DescribeHarvestJob.go | 36 +- .../api_op_DescribeOriginEndpoint.go | 48 +- service/mediapackage/api_op_ListChannels.go | 6 +- .../mediapackage/api_op_ListHarvestJobs.go | 12 +- .../api_op_ListOriginEndpoints.go | 6 +- .../api_op_RotateChannelCredentials.go | 12 +- .../api_op_RotateIngestEndpointCredentials.go | 12 +- service/mediapackage/api_op_UntagResource.go | 3 +- service/mediapackage/api_op_UpdateChannel.go | 14 +- .../api_op_UpdateOriginEndpoint.go | 94 +- service/mediapackage/go.mod | 2 +- service/mediapackage/types/types.go | 422 +- service/mediapackagevod/api_op_CreateAsset.go | 42 +- .../api_op_CreatePackagingConfiguration.go | 36 +- .../api_op_CreatePackagingGroup.go | 12 +- .../mediapackagevod/api_op_DescribeAsset.go | 26 +- .../api_op_DescribePackagingConfiguration.go | 22 +- .../api_op_DescribePackagingGroup.go | 12 +- service/mediapackagevod/api_op_ListAssets.go | 6 +- .../api_op_ListPackagingConfigurations.go | 8 +- .../api_op_ListPackagingGroups.go | 12 +- .../mediapackagevod/api_op_UntagResource.go | 10 +- .../api_op_UpdatePackagingGroup.go | 10 +- service/mediapackagevod/go.mod | 2 +- service/mediapackagevod/types/types.go | 172 +- service/mediastore/api_op_ListContainers.go | 18 +- .../mediastore/api_op_PutContainerPolicy.go | 10 +- service/mediastore/api_op_PutCorsPolicy.go | 8 +- service/mediastore/go.mod | 2 +- service/mediastore/types/types.go | 72 +- .../mediastoredata/api_op_DescribeObject.go | 16 +- service/mediastoredata/api_op_GetObject.go | 16 +- service/mediastoredata/api_op_ListItems.go | 20 +- service/mediastoredata/api_op_PutObject.go | 42 +- service/mediastoredata/go.mod | 2 +- service/mediastoredata/types/types.go | 18 +- .../api_op_GetPlaybackConfiguration.go | 68 +- .../api_op_ListPlaybackConfigurations.go | 8 +- .../api_op_PutPlaybackConfiguration.go | 114 +- service/mediatailor/api_op_UntagResource.go | 12 +- service/mediatailor/go.mod | 2 +- service/mediatailor/types/types.go | 94 +- .../api_op_AssociateCreatedArtifact.go | 12 +- .../api_op_AssociateDiscoveredResource.go | 8 +- .../api_op_CreateProgressUpdateStream.go | 8 +- .../api_op_DeleteProgressUpdateStream.go | 8 +- .../api_op_DisassociateCreatedArtifact.go | 18 +- .../api_op_DisassociateDiscoveredResource.go | 18 +- .../api_op_ListApplicationStates.go | 20 +- .../api_op_ListCreatedArtifacts.go | 16 +- .../api_op_ListDiscoveredResources.go | 16 +- .../api_op_ListProgressUpdateStreams.go | 6 +- .../api_op_NotifyApplicationState.go | 12 +- .../api_op_NotifyMigrationTaskState.go | 28 +- .../api_op_PutResourceAttributes.go | 10 +- service/migrationhub/go.mod | 2 +- service/migrationhub/types/types.go | 58 +- .../api_op_CreateHomeRegionControl.go | 8 +- .../api_op_DescribeHomeRegionControls.go | 24 +- service/migrationhubconfig/go.mod | 2 +- service/migrationhubconfig/types/types.go | 16 +- service/mobile/api_op_CreateProject.go | 12 +- service/mobile/api_op_ExportBundle.go | 6 +- service/mobile/api_op_ExportProject.go | 8 +- service/mobile/api_op_ListBundles.go | 6 +- service/mobile/api_op_UpdateProject.go | 10 +- service/mobile/go.mod | 2 +- service/mobile/types/types.go | 50 +- service/mq/api_op_CreateBroker.go | 92 +- service/mq/api_op_CreateConfiguration.go | 34 +- service/mq/api_op_CreateTags.go | 6 +- service/mq/api_op_CreateUser.go | 14 +- service/mq/api_op_DescribeBroker.go | 122 +- .../mq/api_op_DescribeBrokerEngineTypes.go | 14 +- .../api_op_DescribeBrokerInstanceOptions.go | 26 +- service/mq/api_op_DescribeConfiguration.go | 40 +- .../api_op_DescribeConfigurationRevision.go | 14 +- service/mq/api_op_DescribeUser.go | 22 +- .../mq/api_op_ListConfigurationRevisions.go | 10 +- service/mq/api_op_ListConfigurations.go | 14 +- service/mq/api_op_ListUsers.go | 16 +- service/mq/api_op_UpdateBroker.go | 78 +- service/mq/api_op_UpdateConfiguration.go | 18 +- service/mq/api_op_UpdateUser.go | 20 +- service/mq/go.mod | 2 +- service/mq/types/types.go | 190 +- .../api_op_AcceptQualificationRequest.go | 8 +- service/mturk/api_op_ApproveAssignment.go | 8 +- ...api_op_AssociateQualificationWithWorker.go | 6 +- ...pi_op_CreateAdditionalAssignmentsForHIT.go | 8 +- service/mturk/api_op_CreateHIT.go | 108 +- service/mturk/api_op_CreateHITType.go | 46 +- service/mturk/api_op_CreateHITWithHITType.go | 78 +- .../mturk/api_op_CreateQualificationType.go | 58 +- service/mturk/api_op_DeleteWorkerBlock.go | 8 +- service/mturk/api_op_GetAccountBalance.go | 4 +- service/mturk/api_op_GetAssignment.go | 6 +- service/mturk/api_op_GetFileUploadURL.go | 10 +- service/mturk/api_op_GetQualificationScore.go | 8 +- service/mturk/api_op_ListAssignmentsForHIT.go | 9 +- service/mturk/api_op_ListBonusPayments.go | 20 +- service/mturk/api_op_ListHITs.go | 10 +- .../api_op_ListHITsForQualificationType.go | 16 +- .../mturk/api_op_ListQualificationRequests.go | 18 +- .../mturk/api_op_ListQualificationTypes.go | 14 +- .../api_op_ListReviewPolicyResultsForHIT.go | 40 +- service/mturk/api_op_ListReviewableHITs.go | 6 +- service/mturk/api_op_ListWorkerBlocks.go | 8 +- ...api_op_ListWorkersWithQualificationType.go | 6 +- service/mturk/api_op_NotifyWorkers.go | 12 +- service/mturk/api_op_SendBonus.go | 14 +- .../mturk/api_op_UpdateExpirationForHIT.go | 8 +- service/mturk/api_op_UpdateHITReviewStatus.go | 10 +- service/mturk/api_op_UpdateHITTypeOfHIT.go | 8 +- .../api_op_UpdateNotificationSettings.go | 10 +- .../mturk/api_op_UpdateQualificationType.go | 38 +- service/mturk/go.mod | 2 +- service/mturk/types/types.go | 420 +- service/neptune/api_op_AddTagsToResource.go | 10 +- .../api_op_CopyDBClusterParameterGroup.go | 14 +- .../neptune/api_op_CopyDBClusterSnapshot.go | 52 +- .../neptune/api_op_CopyDBParameterGroup.go | 20 +- service/neptune/api_op_CreateDBCluster.go | 118 +- .../api_op_CreateDBClusterParameterGroup.go | 16 +- .../neptune/api_op_CreateDBClusterSnapshot.go | 6 +- service/neptune/api_op_CreateDBInstance.go | 304 +- .../neptune/api_op_CreateDBParameterGroup.go | 20 +- service/neptune/api_op_CreateDBSubnetGroup.go | 6 +- .../neptune/api_op_CreateEventSubscription.go | 24 +- service/neptune/api_op_DeleteDBCluster.go | 26 +- service/neptune/api_op_DeleteDBInstance.go | 18 +- ...api_op_DescribeDBClusterParameterGroups.go | 12 +- .../api_op_DescribeDBClusterParameters.go | 30 +- .../api_op_DescribeDBClusterSnapshots.go | 46 +- service/neptune/api_op_DescribeDBClusters.go | 26 +- .../api_op_DescribeDBEngineVersions.go | 52 +- service/neptune/api_op_DescribeDBInstances.go | 32 +- .../api_op_DescribeDBParameterGroups.go | 24 +- .../neptune/api_op_DescribeDBParameters.go | 14 +- .../neptune/api_op_DescribeDBSubnetGroups.go | 22 +- ..._DescribeEngineDefaultClusterParameters.go | 6 +- .../api_op_DescribeEngineDefaultParameters.go | 6 +- .../api_op_DescribeEventSubscriptions.go | 18 +- service/neptune/api_op_DescribeEvents.go | 48 +- ...i_op_DescribeOrderableDBInstanceOptions.go | 46 +- ...pi_op_DescribePendingMaintenanceActions.go | 30 +- service/neptune/api_op_ListTagsForResource.go | 6 +- service/neptune/api_op_ModifyDBCluster.go | 120 +- .../api_op_ModifyDBClusterParameterGroup.go | 8 +- ...api_op_ModifyDBClusterSnapshotAttribute.go | 16 +- service/neptune/api_op_ModifyDBInstance.go | 264 +- .../neptune/api_op_ModifyDBParameterGroup.go | 16 +- service/neptune/api_op_ModifyDBSubnetGroup.go | 6 +- .../neptune/api_op_ModifyEventSubscription.go | 20 +- ..._RemoveSourceIdentifierFromSubscription.go | 12 +- .../api_op_ResetDBClusterParameterGroup.go | 10 +- .../api_op_RestoreDBClusterFromSnapshot.go | 96 +- .../api_op_RestoreDBClusterToPointInTime.go | 120 +- service/neptune/go.mod | 2 +- service/neptune/types/types.go | 880 +-- .../api_op_AssociateCustomerGateway.go | 8 +- .../networkmanager/api_op_AssociateLink.go | 8 +- service/networkmanager/api_op_CreateDevice.go | 34 +- .../api_op_CreateGlobalNetwork.go | 6 +- service/networkmanager/api_op_CreateLink.go | 30 +- service/networkmanager/api_op_CreateSite.go | 18 +- .../api_op_DescribeGlobalNetworks.go | 12 +- .../networkmanager/api_op_DisassociateLink.go | 8 +- .../api_op_GetCustomerGatewayAssociations.go | 12 +- service/networkmanager/api_op_GetDevices.go | 6 +- .../api_op_GetLinkAssociations.go | 18 +- service/networkmanager/api_op_GetLinks.go | 32 +- service/networkmanager/api_op_GetSites.go | 10 +- .../api_op_GetTransitGatewayRegistrations.go | 20 +- .../api_op_RegisterTransitGateway.go | 10 +- service/networkmanager/api_op_TagResource.go | 8 +- .../networkmanager/api_op_UntagResource.go | 8 +- service/networkmanager/api_op_UpdateDevice.go | 38 +- service/networkmanager/api_op_UpdateLink.go | 18 +- service/networkmanager/api_op_UpdateSite.go | 8 +- service/networkmanager/go.mod | 2 +- service/networkmanager/types/types.go | 126 +- .../api_op_AttachElasticLoadBalancer.go | 10 +- service/opsworks/api_op_CloneStack.go | 266 +- service/opsworks/api_op_CreateApp.go | 80 +- service/opsworks/api_op_CreateDeployment.go | 16 +- service/opsworks/api_op_CreateInstance.go | 144 +- service/opsworks/api_op_CreateLayer.go | 104 +- service/opsworks/api_op_CreateStack.go | 288 +- service/opsworks/api_op_CreateUserProfile.go | 14 +- service/opsworks/api_op_DescribeApps.go | 8 +- service/opsworks/api_op_DescribeCommands.go | 10 +- .../opsworks/api_op_DescribeDeployments.go | 8 +- .../opsworks/api_op_DescribeEcsClusters.go | 12 +- service/opsworks/api_op_DescribeElasticIps.go | 14 +- .../api_op_DescribeElasticLoadBalancers.go | 6 +- service/opsworks/api_op_DescribeInstances.go | 8 +- service/opsworks/api_op_DescribeLayers.go | 6 +- service/opsworks/api_op_DescribeRaidArrays.go | 8 +- .../opsworks/api_op_DescribeServiceErrors.go | 8 +- service/opsworks/api_op_DescribeVolumes.go | 16 +- .../api_op_DetachElasticLoadBalancer.go | 8 +- .../opsworks/api_op_GetHostnameSuggestion.go | 6 +- service/opsworks/api_op_ListTags.go | 16 +- service/opsworks/api_op_RegisterInstance.go | 20 +- .../opsworks/api_op_RegisterRdsDbInstance.go | 10 +- .../api_op_SetLoadBasedAutoScaling.go | 16 +- service/opsworks/api_op_SetPermission.go | 6 +- service/opsworks/api_op_UntagResource.go | 8 +- service/opsworks/api_op_UpdateApp.go | 48 +- service/opsworks/api_op_UpdateElasticIp.go | 6 +- service/opsworks/api_op_UpdateInstance.go | 60 +- service/opsworks/api_op_UpdateLayer.go | 94 +- .../opsworks/api_op_UpdateRdsDbInstance.go | 6 +- service/opsworks/api_op_UpdateStack.go | 240 +- service/opsworks/api_op_UpdateUserProfile.go | 22 +- service/opsworks/api_op_UpdateVolume.go | 6 +- service/opsworks/go.mod | 2 +- service/opsworks/types/types.go | 1190 +-- service/opsworkscm/api_op_AssociateNode.go | 8 +- service/opsworkscm/api_op_CreateBackup.go | 6 +- service/opsworkscm/api_op_CreateServer.go | 224 +- service/opsworkscm/api_op_DescribeBackups.go | 8 +- service/opsworkscm/api_op_DescribeEvents.go | 18 +- .../api_op_DescribeNodeAssociationStatus.go | 18 +- service/opsworkscm/api_op_DescribeServers.go | 12 +- service/opsworkscm/api_op_DisassociateNode.go | 10 +- .../opsworkscm/api_op_ListTagsForResource.go | 28 +- service/opsworkscm/api_op_RestoreServer.go | 8 +- service/opsworkscm/api_op_StartMaintenance.go | 10 +- service/opsworkscm/api_op_UntagResource.go | 10 +- service/opsworkscm/api_op_UpdateServer.go | 18 +- service/opsworkscm/go.mod | 2 +- service/opsworkscm/types/types.go | 206 +- service/organizations/api_op_AttachPolicy.go | 18 +- service/organizations/api_op_CreateAccount.go | 48 +- .../api_op_CreateGovCloudAccount.go | 10 +- service/organizations/api_op_CreatePolicy.go | 36 +- .../organizations/api_op_DisablePolicyType.go | 16 +- ..._op_ListAWSServiceAccessForOrganization.go | 22 +- service/organizations/api_op_ListAccounts.go | 12 +- .../api_op_ListCreateAccountStatus.go | 30 +- .../api_op_ListDelegatedAdministrators.go | 12 +- .../api_op_ListDelegatedServicesForAccount.go | 6 +- .../api_op_ListHandshakesForOrganization.go | 8 +- ...api_op_ListOrganizationalUnitsForParent.go | 12 +- service/organizations/api_op_ListParents.go | 18 +- service/organizations/api_op_ListPolicies.go | 12 +- .../api_op_ListPoliciesForTarget.go | 56 +- .../api_op_ListTagsForResource.go | 10 +- .../api_op_ListTargetsForPolicy.go | 24 +- .../api_op_RegisterDelegatedAdministrator.go | 12 +- service/organizations/api_op_TagResource.go | 10 +- service/organizations/api_op_UpdatePolicy.go | 20 +- service/organizations/go.mod | 2 +- service/organizations/types/types.go | 286 +- service/outposts/api_op_CreateOutpost.go | 14 +- .../api_op_GetOutpostInstanceTypes.go | 18 +- service/outposts/api_op_ListOutposts.go | 12 +- service/outposts/api_op_ListSites.go | 12 +- service/outposts/go.mod | 2 +- service/outposts/types/types.go | 24 +- .../api_op_CreateBatchInferenceJob.go | 34 +- service/personalize/api_op_CreateCampaign.go | 10 +- service/personalize/api_op_CreateDataset.go | 22 +- .../personalize/api_op_CreateDatasetGroup.go | 10 +- .../api_op_CreateDatasetImportJob.go | 10 +- .../personalize/api_op_CreateEventTracker.go | 10 +- service/personalize/api_op_CreateFilter.go | 10 +- service/personalize/api_op_CreateSchema.go | 8 +- service/personalize/api_op_CreateSolution.go | 36 +- .../api_op_ListBatchInferenceJobs.go | 6 +- service/personalize/api_op_ListCampaigns.go | 14 +- .../personalize/api_op_ListDatasetGroups.go | 6 +- .../api_op_ListDatasetImportJobs.go | 14 +- service/personalize/api_op_ListDatasets.go | 14 +- .../personalize/api_op_ListEventTrackers.go | 12 +- service/personalize/api_op_ListFilters.go | 6 +- service/personalize/api_op_ListRecipes.go | 8 +- service/personalize/api_op_ListSchemas.go | 6 +- .../api_op_ListSolutionVersions.go | 6 +- service/personalize/api_op_UpdateCampaign.go | 6 +- service/personalize/go.mod | 2 +- service/personalize/types/types.go | 760 +- service/personalizeevents/api_op_PutEvents.go | 12 +- service/personalizeevents/go.mod | 2 +- .../api_op_GetPersonalizedRanking.go | 10 +- .../api_op_GetRecommendations.go | 18 +- service/personalizeruntime/go.mod | 2 +- service/personalizeruntime/types/types.go | 6 +- service/pi/api_op_DescribeDimensionKeys.go | 80 +- service/pi/api_op_GetResourceMetrics.go | 100 +- service/pi/go.mod | 2 +- service/pi/types/types.go | 44 +- .../pinpoint/api_op_CreateEmailTemplate.go | 12 +- service/pinpoint/api_op_CreateExportJob.go | 12 +- service/pinpoint/api_op_CreateSmsTemplate.go | 12 +- service/pinpoint/api_op_DeleteCampaign.go | 10 +- service/pinpoint/api_op_DeleteJourney.go | 10 +- .../pinpoint/api_op_DeleteVoiceTemplate.go | 16 +- .../api_op_GetApplicationDateRangeKpi.go | 50 +- service/pinpoint/api_op_GetApps.go | 8 +- .../pinpoint/api_op_GetCampaignActivities.go | 8 +- .../api_op_GetCampaignDateRangeKpi.go | 40 +- service/pinpoint/api_op_GetCampaignVersion.go | 8 +- .../pinpoint/api_op_GetCampaignVersions.go | 18 +- service/pinpoint/api_op_GetCampaigns.go | 8 +- service/pinpoint/api_op_GetEmailTemplate.go | 16 +- service/pinpoint/api_op_GetImportJob.go | 10 +- service/pinpoint/api_op_GetImportJobs.go | 8 +- service/pinpoint/api_op_GetJourney.go | 10 +- .../pinpoint/api_op_GetJourneyDateRangeKpi.go | 52 +- ...i_op_GetJourneyExecutionActivityMetrics.go | 18 +- .../api_op_GetJourneyExecutionMetrics.go | 18 +- service/pinpoint/api_op_GetPushTemplate.go | 16 +- service/pinpoint/api_op_GetSegment.go | 10 +- .../pinpoint/api_op_GetSegmentExportJobs.go | 8 +- .../pinpoint/api_op_GetSegmentImportJobs.go | 12 +- service/pinpoint/api_op_GetSegmentVersions.go | 8 +- service/pinpoint/api_op_GetSegments.go | 8 +- service/pinpoint/api_op_GetVoiceTemplate.go | 16 +- .../pinpoint/api_op_ListTemplateVersions.go | 16 +- service/pinpoint/api_op_ListTemplates.go | 18 +- service/pinpoint/api_op_PutEventStream.go | 12 +- service/pinpoint/api_op_RemoveAttributes.go | 12 +- service/pinpoint/api_op_SendUsersMessages.go | 12 +- service/pinpoint/api_op_TagResource.go | 10 +- .../api_op_UpdateApnsVoipSandboxChannel.go | 12 +- .../api_op_UpdateApplicationSettings.go | 10 +- service/pinpoint/api_op_UpdateCampaign.go | 10 +- .../pinpoint/api_op_UpdateEmailTemplate.go | 16 +- service/pinpoint/api_op_UpdateEndpoint.go | 8 +- service/pinpoint/api_op_UpdateGcmChannel.go | 12 +- service/pinpoint/api_op_UpdateJourney.go | 10 +- service/pinpoint/api_op_UpdateJourneyState.go | 10 +- service/pinpoint/api_op_UpdatePushTemplate.go | 46 +- .../api_op_UpdateRecommenderConfiguration.go | 12 +- service/pinpoint/api_op_UpdateSegment.go | 10 +- service/pinpoint/api_op_UpdateSmsChannel.go | 10 +- service/pinpoint/api_op_UpdateSmsTemplate.go | 28 +- .../api_op_UpdateTemplateActiveVersion.go | 12 +- service/pinpoint/api_op_UpdateVoiceChannel.go | 10 +- .../pinpoint/api_op_UpdateVoiceTemplate.go | 28 +- service/pinpoint/go.mod | 2 +- service/pinpoint/types/types.go | 4138 +++++----- .../api_op_CreateConfigurationSet.go | 22 +- .../api_op_CreateDeliverabilityTestReport.go | 10 +- .../api_op_CreateEmailIdentity.go | 12 +- service/pinpointemail/api_op_GetAccount.go | 42 +- .../api_op_GetConfigurationSet.go | 22 +- .../pinpointemail/api_op_GetDedicatedIps.go | 16 +- ...pi_op_GetDeliverabilityDashboardOptions.go | 32 +- .../api_op_GetDeliverabilityTestReport.go | 16 +- .../pinpointemail/api_op_GetEmailIdentity.go | 22 +- .../api_op_ListConfigurationSets.go | 8 +- .../api_op_ListDedicatedIpPools.go | 8 +- ...pi_op_ListDomainDeliverabilityCampaigns.go | 22 +- ...i_op_PutConfigurationSetDeliveryOptions.go | 12 +- ...i_op_PutConfigurationSetTrackingOptions.go | 6 +- .../api_op_PutDedicatedIpInPool.go | 12 +- ...api_op_PutDeliverabilityDashboardOption.go | 8 +- ...i_op_PutEmailIdentityFeedbackAttributes.go | 12 +- service/pinpointemail/api_op_SendEmail.go | 36 +- service/pinpointemail/api_op_TagResource.go | 12 +- service/pinpointemail/go.mod | 2 +- service/pinpointemail/types/types.go | 344 +- .../api_op_ListConfigurationSets.go | 6 +- .../api_op_SendVoiceMessage.go | 10 +- ..._UpdateConfigurationSetEventDestination.go | 12 +- service/pinpointsmsvoice/go.mod | 2 +- service/pinpointsmsvoice/types/types.go | 52 +- service/polly/api_op_DescribeVoices.go | 22 +- service/polly/api_op_GetLexicon.go | 6 +- .../polly/api_op_ListSpeechSynthesisTasks.go | 8 +- .../polly/api_op_StartSpeechSynthesisTask.go | 70 +- service/polly/api_op_SynthesizeSpeech.go | 22 +- service/polly/go.mod | 2 +- service/polly/types/types.go | 118 +- service/pricing/api_op_DescribeServices.go | 20 +- service/pricing/api_op_GetAttributeValues.go | 20 +- service/pricing/api_op_GetProducts.go | 18 +- service/pricing/go.mod | 2 +- service/pricing/types/types.go | 34 +- .../qldb/api_op_CancelJournalKinesisStream.go | 8 +- service/qldb/api_op_CreateLedger.go | 18 +- .../api_op_DescribeJournalKinesisStream.go | 8 +- .../qldb/api_op_DescribeJournalS3Export.go | 8 +- service/qldb/api_op_DescribeLedger.go | 14 +- service/qldb/api_op_ExportJournalToS3.go | 26 +- service/qldb/api_op_GetBlock.go | 10 +- service/qldb/api_op_GetRevision.go | 24 +- ...i_op_ListJournalKinesisStreamsForLedger.go | 18 +- service/qldb/api_op_ListLedgers.go | 16 +- service/qldb/api_op_StreamJournalToKinesis.go | 38 +- service/qldb/api_op_UpdateLedger.go | 6 +- service/qldb/go.mod | 2 +- service/qldb/types/types.go | 122 +- service/qldbsession/api_op_SendCommand.go | 38 +- service/qldbsession/go.mod | 2 +- service/qldbsession/types/types.go | 28 +- service/quicksight/api_op_CancelIngestion.go | 16 +- .../api_op_CreateAccountCustomization.go | 16 +- service/quicksight/api_op_CreateDashboard.go | 66 +- service/quicksight/api_op_CreateDataSet.go | 66 +- service/quicksight/api_op_CreateDataSource.go | 58 +- service/quicksight/api_op_CreateGroup.go | 12 +- .../api_op_CreateGroupMembership.go | 18 +- .../api_op_CreateIAMPolicyAssignment.go | 38 +- service/quicksight/api_op_CreateIngestion.go | 20 +- service/quicksight/api_op_CreateNamespace.go | 34 +- service/quicksight/api_op_CreateTemplate.go | 36 +- .../quicksight/api_op_CreateTemplateAlias.go | 16 +- service/quicksight/api_op_CreateTheme.go | 42 +- service/quicksight/api_op_CreateThemeAlias.go | 14 +- service/quicksight/api_op_DeleteDashboard.go | 14 +- service/quicksight/api_op_DeleteDataSet.go | 6 +- service/quicksight/api_op_DeleteDataSource.go | 6 +- service/quicksight/api_op_DeleteGroup.go | 10 +- .../api_op_DeleteGroupMembership.go | 10 +- .../api_op_DeleteIAMPolicyAssignment.go | 16 +- service/quicksight/api_op_DeleteNamespace.go | 10 +- service/quicksight/api_op_DeleteTemplate.go | 14 +- .../quicksight/api_op_DeleteTemplateAlias.go | 14 +- service/quicksight/api_op_DeleteTheme.go | 16 +- service/quicksight/api_op_DeleteThemeAlias.go | 18 +- service/quicksight/api_op_DeleteUser.go | 12 +- .../api_op_DeleteUserByPrincipalId.go | 10 +- .../api_op_DescribeAccountCustomization.go | 20 +- .../quicksight/api_op_DescribeDashboard.go | 16 +- .../api_op_DescribeDashboardPermissions.go | 16 +- .../api_op_DescribeDataSetPermissions.go | 12 +- .../quicksight/api_op_DescribeDataSource.go | 6 +- .../api_op_DescribeDataSourcePermissions.go | 22 +- service/quicksight/api_op_DescribeGroup.go | 12 +- .../api_op_DescribeIAMPolicyAssignment.go | 16 +- .../quicksight/api_op_DescribeIngestion.go | 8 +- .../quicksight/api_op_DescribeNamespace.go | 10 +- service/quicksight/api_op_DescribeTemplate.go | 16 +- .../api_op_DescribeTemplatePermissions.go | 16 +- service/quicksight/api_op_DescribeTheme.go | 10 +- .../quicksight/api_op_DescribeThemeAlias.go | 16 +- .../api_op_DescribeThemePermissions.go | 8 +- service/quicksight/api_op_DescribeUser.go | 12 +- .../quicksight/api_op_GetDashboardEmbedUrl.go | 26 +- .../quicksight/api_op_GetSessionEmbedUrl.go | 14 +- .../api_op_ListDashboardVersions.go | 12 +- service/quicksight/api_op_ListDashboards.go | 6 +- service/quicksight/api_op_ListDataSets.go | 12 +- service/quicksight/api_op_ListDataSources.go | 16 +- .../quicksight/api_op_ListGroupMemberships.go | 28 +- service/quicksight/api_op_ListGroups.go | 12 +- .../api_op_ListIAMPolicyAssignments.go | 26 +- .../api_op_ListIAMPolicyAssignmentsForUser.go | 12 +- service/quicksight/api_op_ListIngestions.go | 12 +- service/quicksight/api_op_ListNamespaces.go | 6 +- .../quicksight/api_op_ListTemplateAliases.go | 26 +- .../quicksight/api_op_ListTemplateVersions.go | 18 +- service/quicksight/api_op_ListTemplates.go | 12 +- service/quicksight/api_op_ListThemeAliases.go | 18 +- .../quicksight/api_op_ListThemeVersions.go | 16 +- service/quicksight/api_op_ListThemes.go | 6 +- service/quicksight/api_op_ListUserGroups.go | 28 +- service/quicksight/api_op_ListUsers.go | 28 +- service/quicksight/api_op_RegisterUser.go | 60 +- service/quicksight/api_op_SearchDashboards.go | 12 +- service/quicksight/api_op_UntagResource.go | 10 +- .../api_op_UpdateAccountCustomization.go | 16 +- .../api_op_UpdateAccountSettings.go | 6 +- service/quicksight/api_op_UpdateDashboard.go | 60 +- .../api_op_UpdateDashboardPermissions.go | 6 +- .../api_op_UpdateDashboardPublishedVersion.go | 10 +- service/quicksight/api_op_UpdateDataSet.go | 46 +- .../api_op_UpdateDataSetPermissions.go | 6 +- service/quicksight/api_op_UpdateDataSource.go | 24 +- .../api_op_UpdateDataSourcePermissions.go | 18 +- service/quicksight/api_op_UpdateGroup.go | 16 +- .../api_op_UpdateIAMPolicyAssignment.go | 52 +- service/quicksight/api_op_UpdateTemplate.go | 34 +- .../quicksight/api_op_UpdateTemplateAlias.go | 20 +- .../api_op_UpdateTemplatePermissions.go | 24 +- service/quicksight/api_op_UpdateTheme.go | 42 +- service/quicksight/api_op_UpdateThemeAlias.go | 16 +- .../api_op_UpdateThemePermissions.go | 22 +- service/quicksight/api_op_UpdateUser.go | 50 +- service/quicksight/go.mod | 2 +- service/quicksight/types/types.go | 964 +-- .../api_op_AcceptResourceShareInvitation.go | 8 +- service/ram/api_op_AssociateResourceShare.go | 16 +- ...api_op_AssociateResourceSharePermission.go | 16 +- service/ram/api_op_CreateResourceShare.go | 32 +- service/ram/api_op_DeleteResourceShare.go | 14 +- .../ram/api_op_DisassociateResourceShare.go | 10 +- ..._op_DisassociateResourceSharePermission.go | 6 +- service/ram/api_op_GetResourcePolicies.go | 12 +- .../api_op_GetResourceShareAssociations.go | 30 +- .../ram/api_op_GetResourceShareInvitations.go | 12 +- service/ram/api_op_GetResourceShares.go | 30 +- .../api_op_ListPendingInvitationResources.go | 14 +- service/ram/api_op_ListPermissions.go | 12 +- service/ram/api_op_ListPrincipals.go | 18 +- .../api_op_ListResourceSharePermissions.go | 6 +- service/ram/api_op_ListResourceTypes.go | 12 +- service/ram/api_op_ListResources.go | 34 +- .../api_op_RejectResourceShareInvitation.go | 6 +- service/ram/api_op_UpdateResourceShare.go | 24 +- service/ram/go.mod | 2 +- service/ram/types/types.go | 160 +- service/rds/api_op_AddRoleToDBInstance.go | 10 +- .../api_op_ApplyPendingMaintenanceAction.go | 16 +- .../api_op_AuthorizeDBSecurityGroupIngress.go | 30 +- service/rds/api_op_BacktrackDBCluster.go | 22 +- service/rds/api_op_CancelExportTask.go | 86 +- .../rds/api_op_CopyDBClusterParameterGroup.go | 42 +- service/rds/api_op_CopyDBClusterSnapshot.go | 86 +- service/rds/api_op_CopyDBParameterGroup.go | 16 +- service/rds/api_op_CopyDBSnapshot.go | 58 +- service/rds/api_op_CopyOptionGroup.go | 48 +- .../api_op_CreateCustomAvailabilityZone.go | 18 +- service/rds/api_op_CreateDBCluster.go | 326 +- service/rds/api_op_CreateDBClusterEndpoint.go | 52 +- .../api_op_CreateDBClusterParameterGroup.go | 26 +- service/rds/api_op_CreateDBClusterSnapshot.go | 22 +- service/rds/api_op_CreateDBInstance.go | 630 +- .../rds/api_op_CreateDBInstanceReadReplica.go | 434 +- service/rds/api_op_CreateDBParameterGroup.go | 6 +- service/rds/api_op_CreateDBProxy.go | 52 +- service/rds/api_op_CreateDBSecurityGroup.go | 6 +- service/rds/api_op_CreateDBSnapshot.go | 10 +- service/rds/api_op_CreateDBSubnetGroup.go | 10 +- service/rds/api_op_CreateEventSubscription.go | 44 +- service/rds/api_op_CreateGlobalCluster.go | 10 +- service/rds/api_op_CreateOptionGroup.go | 34 +- service/rds/api_op_DeleteDBCluster.go | 16 +- service/rds/api_op_DeleteDBClusterEndpoint.go | 30 +- service/rds/api_op_DeleteDBInstance.go | 20 +- service/rds/api_op_DeleteInstallationMedia.go | 24 +- .../rds/api_op_DeregisterDBProxyTargets.go | 12 +- service/rds/api_op_DescribeCertificates.go | 12 +- .../api_op_DescribeCustomAvailabilityZones.go | 22 +- .../rds/api_op_DescribeDBClusterBacktracks.go | 68 +- .../rds/api_op_DescribeDBClusterEndpoints.go | 20 +- ...api_op_DescribeDBClusterParameterGroups.go | 26 +- .../rds/api_op_DescribeDBClusterParameters.go | 30 +- .../rds/api_op_DescribeDBClusterSnapshots.go | 84 +- service/rds/api_op_DescribeDBClusters.go | 24 +- .../rds/api_op_DescribeDBEngineVersions.go | 50 +- ...i_op_DescribeDBInstanceAutomatedBackups.go | 16 +- service/rds/api_op_DescribeDBInstances.go | 18 +- service/rds/api_op_DescribeDBLogFiles.go | 42 +- .../rds/api_op_DescribeDBParameterGroups.go | 16 +- service/rds/api_op_DescribeDBParameters.go | 32 +- service/rds/api_op_DescribeDBProxies.go | 6 +- .../rds/api_op_DescribeDBProxyTargetGroups.go | 20 +- service/rds/api_op_DescribeDBProxyTargets.go | 22 +- .../rds/api_op_DescribeDBSecurityGroups.go | 12 +- service/rds/api_op_DescribeDBSnapshots.go | 128 +- service/rds/api_op_DescribeDBSubnetGroups.go | 20 +- ..._DescribeEngineDefaultClusterParameters.go | 18 +- .../api_op_DescribeEngineDefaultParameters.go | 6 +- .../rds/api_op_DescribeEventSubscriptions.go | 20 +- service/rds/api_op_DescribeEvents.go | 42 +- service/rds/api_op_DescribeExportTasks.go | 38 +- service/rds/api_op_DescribeGlobalClusters.go | 28 +- .../rds/api_op_DescribeInstallationMedia.go | 16 +- .../rds/api_op_DescribeOptionGroupOptions.go | 24 +- service/rds/api_op_DescribeOptionGroups.go | 30 +- ...i_op_DescribeOrderableDBInstanceOptions.go | 44 +- ...pi_op_DescribePendingMaintenanceActions.go | 28 +- .../rds/api_op_DescribeReservedDBInstances.go | 54 +- ...op_DescribeReservedDBInstancesOfferings.go | 50 +- service/rds/api_op_DescribeSourceRegions.go | 20 +- .../rds/api_op_DownloadDBLogFilePortion.go | 34 +- service/rds/api_op_FailoverDBCluster.go | 10 +- service/rds/api_op_ImportInstallationMedia.go | 60 +- service/rds/api_op_ListTagsForResource.go | 6 +- service/rds/api_op_ModifyCertificates.go | 10 +- .../api_op_ModifyCurrentDBClusterCapacity.go | 40 +- service/rds/api_op_ModifyDBCluster.go | 218 +- service/rds/api_op_ModifyDBClusterEndpoint.go | 42 +- .../api_op_ModifyDBClusterParameterGroup.go | 8 +- ...api_op_ModifyDBClusterSnapshotAttribute.go | 26 +- service/rds/api_op_ModifyDBInstance.go | 534 +- service/rds/api_op_ModifyDBParameterGroup.go | 16 +- service/rds/api_op_ModifyDBProxy.go | 42 +- .../rds/api_op_ModifyDBProxyTargetGroup.go | 8 +- .../rds/api_op_ModifyDBSnapshotAttribute.go | 30 +- service/rds/api_op_ModifyEventSubscription.go | 20 +- service/rds/api_op_PromoteReadReplica.go | 22 +- ..._op_PurchaseReservedDBInstancesOffering.go | 18 +- service/rds/api_op_RegisterDBProxyTargets.go | 12 +- service/rds/api_op_RemoveFromGlobalCluster.go | 6 +- service/rds/api_op_RemoveRoleFromDBCluster.go | 10 +- .../rds/api_op_RemoveRoleFromDBInstance.go | 12 +- service/rds/api_op_RemoveTagsFromResource.go | 10 +- .../api_op_ResetDBClusterParameterGroup.go | 10 +- service/rds/api_op_ResetDBParameterGroup.go | 10 +- service/rds/api_op_RestoreDBClusterFromS3.go | 306 +- .../api_op_RestoreDBClusterFromSnapshot.go | 198 +- .../api_op_RestoreDBClusterToPointInTime.go | 192 +- .../api_op_RestoreDBInstanceFromDBSnapshot.go | 216 +- service/rds/api_op_RestoreDBInstanceFromS3.go | 348 +- .../api_op_RestoreDBInstanceToPointInTime.go | 246 +- .../api_op_RevokeDBSecurityGroupIngress.go | 10 +- service/rds/api_op_StartActivityStream.go | 28 +- service/rds/api_op_StartExportTask.go | 134 +- service/rds/api_op_StopActivityStream.go | 16 +- service/rds/go.mod | 2 +- service/rds/types/types.go | 2298 +++--- .../rdsdata/api_op_BatchExecuteStatement.go | 30 +- service/rdsdata/api_op_BeginTransaction.go | 12 +- service/rdsdata/api_op_ExecuteSql.go | 12 +- service/rdsdata/api_op_ExecuteStatement.go | 30 +- service/rdsdata/go.mod | 2 +- .../api_op_AcceptReservedNodeExchange.go | 12 +- .../api_op_AuthorizeSnapshotAccess.go | 10 +- .../api_op_BatchDeleteClusterSnapshots.go | 6 +- .../api_op_BatchModifyClusterSnapshots.go | 18 +- service/redshift/api_op_CancelResize.go | 76 +- .../redshift/api_op_CopyClusterSnapshot.go | 26 +- service/redshift/api_op_CreateCluster.go | 318 +- .../api_op_CreateClusterParameterGroup.go | 34 +- .../api_op_CreateClusterSecurityGroup.go | 16 +- .../redshift/api_op_CreateClusterSnapshot.go | 16 +- .../api_op_CreateClusterSubnetGroup.go | 18 +- .../api_op_CreateEventSubscription.go | 42 +- .../api_op_CreateHsmClientCertificate.go | 6 +- .../redshift/api_op_CreateHsmConfiguration.go | 30 +- .../redshift/api_op_CreateScheduledAction.go | 72 +- .../api_op_CreateSnapshotCopyGrant.go | 6 +- .../redshift/api_op_CreateSnapshotSchedule.go | 34 +- service/redshift/api_op_CreateUsageLimit.go | 62 +- service/redshift/api_op_DeleteCluster.go | 14 +- .../redshift/api_op_DeleteClusterSnapshot.go | 12 +- service/redshift/api_op_DeleteTags.go | 10 +- .../api_op_DescribeClusterDbRevisions.go | 10 +- .../api_op_DescribeClusterParameterGroups.go | 30 +- .../api_op_DescribeClusterParameters.go | 26 +- .../api_op_DescribeClusterSecurityGroups.go | 42 +- .../api_op_DescribeClusterSnapshots.go | 90 +- .../api_op_DescribeClusterSubnetGroups.go | 40 +- .../redshift/api_op_DescribeClusterTracks.go | 12 +- .../api_op_DescribeClusterVersions.go | 16 +- service/redshift/api_op_DescribeClusters.go | 34 +- .../api_op_DescribeEventSubscriptions.go | 26 +- service/redshift/api_op_DescribeEvents.go | 34 +- .../api_op_DescribeHsmClientCertificates.go | 38 +- .../api_op_DescribeHsmConfigurations.go | 26 +- .../redshift/api_op_DescribeLoggingStatus.go | 16 +- ...api_op_DescribeNodeConfigurationOptions.go | 24 +- .../api_op_DescribeOrderableClusterOptions.go | 16 +- .../api_op_DescribeReservedNodeOfferings.go | 22 +- .../redshift/api_op_DescribeReservedNodes.go | 12 +- service/redshift/api_op_DescribeResize.go | 76 +- .../api_op_DescribeScheduledActions.go | 30 +- .../api_op_DescribeSnapshotCopyGrants.go | 34 +- .../api_op_DescribeSnapshotSchedules.go | 32 +- service/redshift/api_op_DescribeStorage.go | 6 +- .../api_op_DescribeTableRestoreStatus.go | 22 +- service/redshift/api_op_DescribeTags.go | 40 +- .../redshift/api_op_DescribeUsageLimits.go | 26 +- service/redshift/api_op_DisableLogging.go | 16 +- service/redshift/api_op_EnableLogging.go | 50 +- service/redshift/api_op_EnableSnapshotCopy.go | 22 +- .../redshift/api_op_GetClusterCredentials.go | 86 +- ...api_op_GetReservedNodeExchangeOfferings.go | 14 +- service/redshift/api_op_ModifyCluster.go | 204 +- .../api_op_ModifyClusterDbRevision.go | 12 +- .../api_op_ModifyClusterMaintenance.go | 20 +- .../api_op_ModifyClusterParameterGroup.go | 16 +- .../redshift/api_op_ModifyClusterSnapshot.go | 18 +- .../api_op_ModifyClusterSnapshotSchedule.go | 8 +- .../api_op_ModifyClusterSubnetGroup.go | 6 +- .../api_op_ModifyEventSubscription.go | 36 +- .../redshift/api_op_ModifyScheduledAction.go | 66 +- .../redshift/api_op_ModifySnapshotSchedule.go | 30 +- service/redshift/api_op_ModifyUsageLimit.go | 32 +- .../api_op_ResetClusterParameterGroup.go | 14 +- service/redshift/api_op_ResizeCluster.go | 22 +- .../api_op_RestoreFromClusterSnapshot.go | 206 +- .../api_op_RestoreTableFromClusterSnapshot.go | 32 +- ...pi_op_RevokeClusterSecurityGroupIngress.go | 12 +- .../redshift/api_op_RevokeSnapshotAccess.go | 10 +- service/redshift/go.mod | 2 +- service/redshift/types/types.go | 1166 +-- service/rekognition/api_op_CompareFaces.go | 50 +- .../rekognition/api_op_CreateCollection.go | 8 +- .../api_op_CreateProjectVersion.go | 14 +- .../api_op_CreateStreamProcessor.go | 16 +- .../rekognition/api_op_DescribeCollection.go | 12 +- .../api_op_DescribeProjectVersions.go | 18 +- .../rekognition/api_op_DescribeProjects.go | 18 +- .../api_op_DescribeStreamProcessor.go | 30 +- .../rekognition/api_op_DetectCustomLabels.go | 22 +- service/rekognition/api_op_DetectFaces.go | 24 +- service/rekognition/api_op_DetectLabels.go | 20 +- .../api_op_DetectModerationLabels.go | 8 +- service/rekognition/api_op_DetectText.go | 14 +- .../api_op_GetCelebrityRecognition.go | 24 +- .../api_op_GetContentModeration.go | 24 +- .../rekognition/api_op_GetFaceDetection.go | 26 +- service/rekognition/api_op_GetFaceSearch.go | 32 +- .../rekognition/api_op_GetLabelDetection.go | 24 +- .../rekognition/api_op_GetPersonTracking.go | 18 +- .../rekognition/api_op_GetSegmentDetection.go | 24 +- .../rekognition/api_op_GetTextDetection.go | 22 +- service/rekognition/api_op_IndexFaces.go | 62 +- service/rekognition/api_op_ListCollections.go | 14 +- service/rekognition/api_op_ListFaces.go | 8 +- .../api_op_ListStreamProcessors.go | 8 +- .../api_op_RecognizeCelebrities.go | 10 +- service/rekognition/api_op_SearchFaces.go | 26 +- .../rekognition/api_op_SearchFacesByImage.go | 40 +- .../api_op_StartCelebrityRecognition.go | 18 +- .../api_op_StartContentModeration.go | 30 +- .../rekognition/api_op_StartFaceDetection.go | 24 +- service/rekognition/api_op_StartFaceSearch.go | 18 +- .../rekognition/api_op_StartLabelDetection.go | 24 +- .../rekognition/api_op_StartPersonTracking.go | 12 +- .../rekognition/api_op_StartProjectVersion.go | 10 +- .../api_op_StartSegmentDetection.go | 22 +- .../rekognition/api_op_StartTextDetection.go | 18 +- service/rekognition/go.mod | 2 +- service/rekognition/types/types.go | 458 +- service/resourcegroups/api_op_CreateGroup.go | 28 +- service/resourcegroups/api_op_DeleteGroup.go | 6 +- service/resourcegroups/api_op_GetGroup.go | 6 +- .../resourcegroups/api_op_GetGroupQuery.go | 6 +- .../resourcegroups/api_op_GroupResources.go | 8 +- .../api_op_ListGroupResources.go | 22 +- service/resourcegroups/api_op_ListGroups.go | 42 +- .../resourcegroups/api_op_SearchResources.go | 10 +- .../resourcegroups/api_op_UngroupResources.go | 8 +- service/resourcegroups/api_op_Untag.go | 16 +- service/resourcegroups/api_op_UpdateGroup.go | 6 +- .../resourcegroups/api_op_UpdateGroupQuery.go | 6 +- service/resourcegroups/go.mod | 2 +- service/resourcegroups/types/types.go | 42 +- .../api_op_DescribeReportCreation.go | 6 +- .../api_op_GetComplianceSummary.go | 42 +- .../api_op_GetResources.go | 114 +- .../api_op_GetTagValues.go | 10 +- .../api_op_TagResources.go | 12 +- .../api_op_UntagResources.go | 10 +- service/resourcegroupstaggingapi/go.mod | 2 +- .../resourcegroupstaggingapi/types/types.go | 48 +- .../robomaker/api_op_CreateDeploymentJob.go | 42 +- service/robomaker/api_op_CreateFleet.go | 12 +- service/robomaker/api_op_CreateRobot.go | 24 +- .../api_op_CreateRobotApplication.go | 32 +- .../api_op_CreateRobotApplicationVersion.go | 12 +- .../api_op_CreateSimulationApplication.go | 58 +- ...i_op_CreateSimulationApplicationVersion.go | 36 +- .../robomaker/api_op_CreateSimulationJob.go | 126 +- .../api_op_DeleteRobotApplication.go | 6 +- service/robomaker/api_op_DeregisterRobot.go | 6 +- .../robomaker/api_op_DescribeDeploymentJob.go | 30 +- service/robomaker/api_op_DescribeFleet.go | 20 +- service/robomaker/api_op_DescribeRobot.go | 28 +- .../api_op_DescribeRobotApplication.go | 28 +- .../api_op_DescribeSimulationApplication.go | 38 +- .../robomaker/api_op_DescribeSimulationJob.go | 106 +- .../api_op_DescribeSimulationJobBatch.go | 46 +- service/robomaker/api_op_ListFleets.go | 6 +- .../robomaker/api_op_ListRobotApplications.go | 12 +- service/robomaker/api_op_ListRobots.go | 18 +- .../api_op_ListSimulationJobBatches.go | 12 +- .../robomaker/api_op_ListSimulationJobs.go | 26 +- service/robomaker/api_op_RegisterRobot.go | 8 +- .../api_op_StartSimulationJobBatch.go | 44 +- service/robomaker/api_op_SyncDeploymentJob.go | 24 +- service/robomaker/api_op_TagResource.go | 8 +- .../api_op_UpdateRobotApplication.go | 36 +- .../api_op_UpdateSimulationApplication.go | 46 +- service/robomaker/go.mod | 2 +- service/robomaker/types/types.go | 440 +- .../api_op_AssociateVPCWithHostedZone.go | 6 +- .../route53/api_op_ChangeTagsForResource.go | 8 +- service/route53/api_op_CreateHealthCheck.go | 18 +- service/route53/api_op_CreateHostedZone.go | 60 +- .../api_op_CreateQueryLoggingConfig.go | 10 +- .../api_op_CreateReusableDelegationSet.go | 16 +- service/route53/api_op_CreateTrafficPolicy.go | 10 +- .../api_op_CreateTrafficPolicyInstance.go | 20 +- .../api_op_CreateTrafficPolicyVersion.go | 8 +- ...pi_op_CreateVPCAssociationAuthorization.go | 20 +- ...pi_op_DeleteVPCAssociationAuthorization.go | 12 +- .../api_op_DisassociateVPCFromHostedZone.go | 12 +- service/route53/api_op_GetGeoLocation.go | 8 +- service/route53/api_op_GetHostedZone.go | 8 +- service/route53/api_op_GetHostedZoneLimit.go | 14 +- .../api_op_GetReusableDelegationSetLimit.go | 12 +- service/route53/api_op_GetTrafficPolicy.go | 8 +- service/route53/api_op_ListGeoLocations.go | 42 +- service/route53/api_op_ListHealthChecks.go | 24 +- service/route53/api_op_ListHostedZones.go | 24 +- .../route53/api_op_ListHostedZonesByName.go | 66 +- .../route53/api_op_ListHostedZonesByVPC.go | 36 +- .../route53/api_op_ListQueryLoggingConfigs.go | 14 +- .../route53/api_op_ListResourceRecordSets.go | 26 +- .../api_op_ListReusableDelegationSets.go | 24 +- .../route53/api_op_ListTagsForResources.go | 12 +- service/route53/api_op_ListTrafficPolicies.go | 26 +- .../api_op_ListTrafficPolicyInstances.go | 74 +- ..._ListTrafficPolicyInstancesByHostedZone.go | 18 +- ...i_op_ListTrafficPolicyInstancesByPolicy.go | 84 +- .../api_op_ListTrafficPolicyVersions.go | 34 +- ...api_op_ListVPCAssociationAuthorizations.go | 24 +- service/route53/api_op_TestDNSAnswer.go | 50 +- service/route53/api_op_UpdateHealthCheck.go | 222 +- .../api_op_UpdateTrafficPolicyComment.go | 12 +- .../api_op_UpdateTrafficPolicyInstance.go | 10 +- service/route53/go.mod | 2 +- service/route53/types/types.go | 1164 +-- .../api_op_CheckDomainAvailability.go | 6 +- .../api_op_CheckDomainTransferability.go | 10 +- .../api_op_DeleteTagsForDomain.go | 8 +- .../api_op_GetContactReachabilityStatus.go | 6 +- .../route53domains/api_op_GetDomainDetail.go | 106 +- .../api_op_GetDomainSuggestions.go | 28 +- .../api_op_GetOperationDetail.go | 16 +- service/route53domains/api_op_ListDomains.go | 8 +- .../route53domains/api_op_ListOperations.go | 10 +- .../route53domains/api_op_RegisterDomain.go | 94 +- service/route53domains/api_op_RenewDomain.go | 10 +- .../api_op_ResendContactReachabilityEmail.go | 12 +- .../route53domains/api_op_TransferDomain.go | 86 +- .../api_op_UpdateDomainContact.go | 10 +- .../api_op_UpdateDomainContactPrivacy.go | 18 +- .../api_op_UpdateDomainNameservers.go | 6 +- service/route53domains/api_op_ViewBilling.go | 6 +- service/route53domains/go.mod | 2 +- service/route53domains/types/types.go | 120 +- .../api_op_AssociateResolverRule.go | 8 +- .../api_op_CreateResolverEndpoint.go | 44 +- .../api_op_CreateResolverRule.go | 28 +- ...p_DisassociateResolverEndpointIpAddress.go | 10 +- .../api_op_ListResolverEndpointIpAddresses.go | 28 +- .../api_op_ListResolverEndpoints.go | 12 +- .../api_op_ListResolverRuleAssociations.go | 18 +- .../api_op_ListResolverRules.go | 28 +- service/route53resolver/api_op_TagResource.go | 10 +- service/route53resolver/go.mod | 2 +- service/route53resolver/types/types.go | 162 +- service/s3/api_op_AbortMultipartUpload.go | 20 +- service/s3/api_op_CompleteMultipartUpload.go | 58 +- service/s3/api_op_CopyObject.go | 228 +- service/s3/api_op_CreateBucket.go | 34 +- service/s3/api_op_CreateMultipartUpload.go | 206 +- ...i_op_DeleteBucketInventoryConfiguration.go | 8 +- service/s3/api_op_DeleteObject.go | 58 +- service/s3/api_op_DeleteObjectTagging.go | 16 +- service/s3/api_op_DeleteObjects.go | 44 +- .../api_op_GetBucketInventoryConfiguration.go | 8 +- service/s3/api_op_GetBucketWebsite.go | 8 +- service/s3/api_op_GetObject.go | 250 +- service/s3/api_op_GetObjectAcl.go | 42 +- service/s3/api_op_GetObjectLegalHold.go | 10 +- service/s3/api_op_GetObjectRetention.go | 22 +- service/s3/api_op_GetObjectTagging.go | 6 +- service/s3/api_op_GetObjectTorrent.go | 16 +- service/s3/api_op_HeadObject.go | 248 +- ...pi_op_ListBucketAnalyticsConfigurations.go | 16 +- ...pi_op_ListBucketInventoryConfigurations.go | 26 +- .../api_op_ListBucketMetricsConfigurations.go | 28 +- service/s3/api_op_ListMultipartUploads.go | 102 +- service/s3/api_op_ListObjectVersions.go | 112 +- service/s3/api_op_ListObjects.go | 88 +- service/s3/api_op_ListObjectsV2.go | 108 +- service/s3/api_op_ListParts.go | 126 +- ...api_op_PutBucketAccelerateConfiguration.go | 8 +- service/s3/api_op_PutBucketAcl.go | 34 +- .../api_op_PutBucketAnalyticsConfiguration.go | 10 +- service/s3/api_op_PutBucketCors.go | 10 +- service/s3/api_op_PutBucketEncryption.go | 20 +- .../api_op_PutBucketInventoryConfiguration.go | 10 +- service/s3/api_op_PutBucketLogging.go | 10 +- .../api_op_PutBucketMetricsConfiguration.go | 8 +- ...i_op_PutBucketNotificationConfiguration.go | 10 +- service/s3/api_op_PutBucketRequestPayment.go | 10 +- service/s3/api_op_PutBucketTagging.go | 12 +- service/s3/api_op_PutBucketVersioning.go | 16 +- service/s3/api_op_PutBucketWebsite.go | 10 +- service/s3/api_op_PutObject.go | 238 +- service/s3/api_op_PutObjectAcl.go | 76 +- service/s3/api_op_PutObjectLegalHold.go | 42 +- .../s3/api_op_PutObjectLockConfiguration.go | 6 +- service/s3/api_op_PutObjectRetention.go | 32 +- service/s3/api_op_PutObjectTagging.go | 14 +- service/s3/api_op_PutPublicAccessBlock.go | 6 +- service/s3/api_op_RestoreObject.go | 28 +- service/s3/api_op_UploadPart.go | 98 +- service/s3/api_op_UploadPartCopy.go | 138 +- service/s3/go.mod | 4 +- service/s3/internal/configtesting/go.mod | 8 +- service/s3/internal/configtesting/go.sum | 1 - service/s3/types/types.go | 706 +- service/s3control/api_op_CreateAccessPoint.go | 38 +- service/s3control/api_op_CreateBucket.go | 48 +- service/s3control/api_op_CreateJob.go | 36 +- service/s3control/api_op_DeleteBucket.go | 10 +- service/s3control/api_op_DeleteJobTagging.go | 8 +- service/s3control/api_op_DescribeJob.go | 8 +- service/s3control/api_op_GetAccessPoint.go | 24 +- .../s3control/api_op_GetAccessPointPolicy.go | 10 +- .../api_op_GetAccessPointPolicyStatus.go | 8 +- service/s3control/api_op_GetBucket.go | 6 +- .../api_op_GetBucketLifecycleConfiguration.go | 10 +- service/s3control/api_op_GetBucketTagging.go | 10 +- service/s3control/api_op_GetJobTagging.go | 8 +- service/s3control/api_op_ListAccessPoints.go | 18 +- service/s3control/api_op_ListJobs.go | 10 +- .../s3control/api_op_ListRegionalBuckets.go | 6 +- .../s3control/api_op_PutAccessPointPolicy.go | 12 +- .../api_op_PutBucketLifecycleConfiguration.go | 8 +- service/s3control/api_op_PutBucketPolicy.go | 10 +- service/s3control/api_op_PutBucketTagging.go | 10 +- service/s3control/api_op_PutJobTagging.go | 8 +- .../s3control/api_op_PutPublicAccessBlock.go | 12 +- service/s3control/api_op_UpdateJobPriority.go | 8 +- service/s3control/api_op_UpdateJobStatus.go | 16 +- service/s3control/go.mod | 2 +- service/s3control/types/types.go | 398 +- service/sagemaker/api_op_AddTags.go | 10 +- .../api_op_AssociateTrialComponent.go | 6 +- service/sagemaker/api_op_CreateAlgorithm.go | 22 +- service/sagemaker/api_op_CreateApp.go | 8 +- service/sagemaker/api_op_CreateAutoMLJob.go | 26 +- .../sagemaker/api_op_CreateCodeRepository.go | 12 +- .../sagemaker/api_op_CreateCompilationJob.go | 26 +- service/sagemaker/api_op_CreateDomain.go | 26 +- service/sagemaker/api_op_CreateEndpoint.go | 20 +- .../sagemaker/api_op_CreateEndpointConfig.go | 30 +- service/sagemaker/api_op_CreateExperiment.go | 6 +- .../sagemaker/api_op_CreateFlowDefinition.go | 36 +- service/sagemaker/api_op_CreateHumanTaskUi.go | 10 +- .../api_op_CreateHyperParameterTuningJob.go | 36 +- service/sagemaker/api_op_CreateLabelingJob.go | 68 +- service/sagemaker/api_op_CreateModel.go | 48 +- .../sagemaker/api_op_CreateModelPackage.go | 30 +- .../api_op_CreateMonitoringSchedule.go | 12 +- .../api_op_CreateNotebookInstance.go | 108 +- ...p_CreateNotebookInstanceLifecycleConfig.go | 10 +- .../api_op_CreatePresignedDomainUrl.go | 8 +- .../sagemaker/api_op_CreateProcessingJob.go | 52 +- service/sagemaker/api_op_CreateTrainingJob.go | 178 +- .../sagemaker/api_op_CreateTransformJob.go | 84 +- service/sagemaker/api_op_CreateTrial.go | 8 +- .../sagemaker/api_op_CreateTrialComponent.go | 48 +- service/sagemaker/api_op_CreateUserProfile.go | 26 +- service/sagemaker/api_op_CreateWorkforce.go | 24 +- service/sagemaker/api_op_CreateWorkteam.go | 20 +- service/sagemaker/api_op_DeleteApp.go | 16 +- service/sagemaker/api_op_DeleteDomain.go | 10 +- service/sagemaker/api_op_DeleteTags.go | 8 +- service/sagemaker/api_op_DeleteUserProfile.go | 8 +- service/sagemaker/api_op_DescribeAlgorithm.go | 46 +- service/sagemaker/api_op_DescribeApp.go | 50 +- service/sagemaker/api_op_DescribeAutoMLJob.go | 92 +- .../api_op_DescribeCodeRepository.go | 12 +- .../api_op_DescribeCompilationJob.go | 56 +- service/sagemaker/api_op_DescribeDomain.go | 46 +- service/sagemaker/api_op_DescribeEndpoint.go | 52 +- .../api_op_DescribeEndpointConfig.go | 26 +- .../sagemaker/api_op_DescribeExperiment.go | 28 +- .../api_op_DescribeFlowDefinition.go | 46 +- .../sagemaker/api_op_DescribeHumanTaskUi.go | 8 +- .../api_op_DescribeHyperParameterTuningJob.go | 90 +- .../sagemaker/api_op_DescribeLabelingJob.go | 96 +- service/sagemaker/api_op_DescribeModel.go | 34 +- .../sagemaker/api_op_DescribeModelPackage.go | 38 +- .../api_op_DescribeMonitoringSchedule.go | 42 +- .../api_op_DescribeNotebookInstance.go | 124 +- ...DescribeNotebookInstanceLifecycleConfig.go | 16 +- .../sagemaker/api_op_DescribeProcessingJob.go | 100 +- .../sagemaker/api_op_DescribeTrainingJob.go | 214 +- .../sagemaker/api_op_DescribeTransformJob.go | 116 +- service/sagemaker/api_op_DescribeTrial.go | 28 +- .../api_op_DescribeTrialComponent.go | 54 +- .../sagemaker/api_op_DescribeUserProfile.go | 40 +- .../api_op_DisassociateTrialComponent.go | 14 +- .../sagemaker/api_op_GetSearchSuggestions.go | 6 +- service/sagemaker/api_op_ListAlgorithms.go | 28 +- service/sagemaker/api_op_ListApps.go | 24 +- service/sagemaker/api_op_ListAutoMLJobs.go | 26 +- .../api_op_ListCandidatesForAutoMLJob.go | 28 +- .../sagemaker/api_op_ListCodeRepositories.go | 42 +- .../sagemaker/api_op_ListCompilationJobs.go | 32 +- .../sagemaker/api_op_ListEndpointConfigs.go | 22 +- service/sagemaker/api_op_ListEndpoints.go | 40 +- service/sagemaker/api_op_ListExperiments.go | 26 +- .../sagemaker/api_op_ListFlowDefinitions.go | 26 +- service/sagemaker/api_op_ListHumanTaskUis.go | 20 +- .../api_op_ListHyperParameterTuningJobs.go | 38 +- service/sagemaker/api_op_ListLabelingJobs.go | 44 +- .../api_op_ListLabelingJobsForWorkteam.go | 36 +- service/sagemaker/api_op_ListModelPackages.go | 24 +- service/sagemaker/api_op_ListModels.go | 26 +- .../api_op_ListMonitoringExecutions.go | 44 +- .../api_op_ListMonitoringSchedules.go | 42 +- ...op_ListNotebookInstanceLifecycleConfigs.go | 34 +- .../sagemaker/api_op_ListNotebookInstances.go | 66 +- .../sagemaker/api_op_ListProcessingJobs.go | 38 +- .../api_op_ListSubscribedWorkteams.go | 12 +- service/sagemaker/api_op_ListTrainingJobs.go | 38 +- ...tTrainingJobsForHyperParameterTuningJob.go | 18 +- service/sagemaker/api_op_ListTransformJobs.go | 46 +- .../sagemaker/api_op_ListTrialComponents.go | 34 +- service/sagemaker/api_op_ListTrials.go | 18 +- service/sagemaker/api_op_ListUserProfiles.go | 22 +- service/sagemaker/api_op_ListWorkforces.go | 18 +- service/sagemaker/api_op_ListWorkteams.go | 14 +- service/sagemaker/api_op_RenderUiTemplate.go | 34 +- service/sagemaker/api_op_Search.go | 26 +- service/sagemaker/api_op_UpdateEndpoint.go | 22 +- ...i_op_UpdateEndpointWeightsAndCapacities.go | 8 +- service/sagemaker/api_op_UpdateExperiment.go | 6 +- .../api_op_UpdateMonitoringSchedule.go | 12 +- .../api_op_UpdateNotebookInstance.go | 90 +- ...p_UpdateNotebookInstanceLifecycleConfig.go | 16 +- .../sagemaker/api_op_UpdateTrialComponent.go | 36 +- service/sagemaker/api_op_UpdateWorkforce.go | 8 +- service/sagemaker/api_op_UpdateWorkteam.go | 6 +- service/sagemaker/go.mod | 2 +- service/sagemaker/types/types.go | 3176 ++++---- .../api_op_DescribeHumanLoop.go | 36 +- .../api_op_ListHumanLoops.go | 16 +- service/sagemakera2iruntime/go.mod | 2 +- service/sagemakera2iruntime/types/types.go | 18 +- .../sagemakerruntime/api_op_InvokeEndpoint.go | 12 +- service/sagemakerruntime/go.mod | 2 +- .../savingsplans/api_op_CreateSavingsPlan.go | 22 +- .../api_op_DescribeSavingsPlanRates.go | 20 +- .../api_op_DescribeSavingsPlans.go | 12 +- ...pi_op_DescribeSavingsPlansOfferingRates.go | 42 +- .../api_op_DescribeSavingsPlansOfferings.go | 42 +- service/savingsplans/api_op_TagResource.go | 8 +- service/savingsplans/api_op_UntagResource.go | 8 +- service/savingsplans/go.mod | 2 +- service/savingsplans/types/types.go | 184 +- service/schemas/api_op_CreateDiscoverer.go | 16 +- service/schemas/api_op_CreateRegistry.go | 18 +- service/schemas/api_op_CreateSchema.go | 36 +- service/schemas/api_op_DeleteSchemaVersion.go | 8 +- service/schemas/api_op_DescribeCodeBinding.go | 20 +- service/schemas/api_op_DescribeDiscoverer.go | 12 +- service/schemas/api_op_DescribeRegistry.go | 6 +- service/schemas/api_op_DescribeSchema.go | 36 +- .../schemas/api_op_GetCodeBindingSource.go | 8 +- service/schemas/api_op_GetResourcePolicy.go | 6 +- service/schemas/api_op_ListDiscoverers.go | 3 +- service/schemas/api_op_ListRegistries.go | 9 +- service/schemas/api_op_ListSchemaVersions.go | 4 +- service/schemas/api_op_ListSchemas.go | 20 +- service/schemas/api_op_PutCodeBinding.go | 16 +- service/schemas/api_op_PutResourcePolicy.go | 12 +- service/schemas/api_op_SearchSchemas.go | 4 +- service/schemas/api_op_StartDiscoverer.go | 6 +- service/schemas/api_op_StopDiscoverer.go | 6 +- service/schemas/api_op_UpdateDiscoverer.go | 20 +- service/schemas/api_op_UpdateRegistry.go | 12 +- service/schemas/api_op_UpdateSchema.go | 18 +- service/schemas/go.mod | 2 +- service/schemas/types/types.go | 56 +- .../api_op_CancelRotateSecret.go | 12 +- service/secretsmanager/api_op_CreateSecret.go | 72 +- .../api_op_DeleteResourcePolicy.go | 6 +- service/secretsmanager/api_op_DeleteSecret.go | 32 +- .../secretsmanager/api_op_DescribeSecret.go | 74 +- .../api_op_GetRandomPassword.go | 26 +- .../api_op_GetResourcePolicy.go | 8 +- .../secretsmanager/api_op_GetSecretValue.go | 10 +- .../api_op_ListSecretVersionIds.go | 32 +- .../api_op_PutResourcePolicy.go | 14 +- .../secretsmanager/api_op_PutSecretValue.go | 66 +- service/secretsmanager/api_op_RotateSecret.go | 52 +- .../secretsmanager/api_op_UntagResource.go | 22 +- service/secretsmanager/api_op_UpdateSecret.go | 90 +- .../api_op_UpdateSecretVersionStage.go | 22 +- .../api_op_ValidateResourcePolicy.go | 10 +- service/secretsmanager/go.mod | 2 +- service/secretsmanager/types/types.go | 92 +- .../securityhub/api_op_AcceptInvitation.go | 8 +- .../securityhub/api_op_BatchImportFindings.go | 6 +- .../securityhub/api_op_BatchUpdateFindings.go | 62 +- .../securityhub/api_op_CreateActionTarget.go | 8 +- service/securityhub/api_op_CreateInsight.go | 10 +- .../api_op_DescribeActionTargets.go | 12 +- .../securityhub/api_op_DescribeStandards.go | 6 +- .../api_op_DescribeStandardsControls.go | 6 +- .../securityhub/api_op_EnableSecurityHub.go | 6 +- .../securityhub/api_op_GetEnabledStandards.go | 12 +- service/securityhub/api_op_GetFindings.go | 12 +- service/securityhub/api_op_GetInsights.go | 6 +- .../api_op_ListEnabledProductsForImport.go | 12 +- service/securityhub/api_op_ListInvitations.go | 12 +- service/securityhub/api_op_ListMembers.go | 18 +- service/securityhub/api_op_UntagResource.go | 8 +- service/securityhub/api_op_UpdateFindings.go | 12 +- service/securityhub/api_op_UpdateInsight.go | 12 +- .../api_op_UpdateStandardsControl.go | 10 +- service/securityhub/go.mod | 2 +- service/securityhub/types/types.go | 1826 ++--- .../api_op_CreateApplication.go | 128 +- .../api_op_CreateApplicationVersion.go | 60 +- .../api_op_CreateCloudFormationChangeSet.go | 88 +- .../api_op_CreateCloudFormationTemplate.go | 20 +- .../api_op_GetApplication.go | 66 +- .../api_op_GetCloudFormationTemplate.go | 22 +- .../api_op_ListApplicationDependencies.go | 6 +- .../api_op_ListApplicationVersions.go | 6 +- .../api_op_ListApplications.go | 6 +- .../api_op_PutApplicationPolicy.go | 8 +- .../api_op_UnshareApplication.go | 8 +- .../api_op_UpdateApplication.go | 64 +- .../serverlessapplicationrepository/go.mod | 2 +- .../types/types.go | 154 +- .../api_op_AcceptPortfolioShare.go | 10 +- .../api_op_AssociatePrincipalWithPortfolio.go | 14 +- .../api_op_AssociateProductWithPortfolio.go | 14 +- ...teServiceActionWithProvisioningArtifact.go | 26 +- .../api_op_AssociateTagOptionWithResource.go | 8 +- ...teServiceActionFromProvisioningArtifact.go | 12 +- service/servicecatalog/api_op_CopyProduct.go | 26 +- .../servicecatalog/api_op_CreateConstraint.go | 44 +- .../servicecatalog/api_op_CreatePortfolio.go | 28 +- .../api_op_CreatePortfolioShare.go | 24 +- .../servicecatalog/api_op_CreateProduct.go | 66 +- .../api_op_CreateProvisionedProductPlan.go | 62 +- .../api_op_CreateProvisioningArtifact.go | 10 +- .../api_op_CreateServiceAction.go | 38 +- .../servicecatalog/api_op_CreateTagOption.go | 8 +- .../servicecatalog/api_op_DeleteConstraint.go | 10 +- .../servicecatalog/api_op_DeletePortfolio.go | 10 +- .../api_op_DeletePortfolioShare.go | 12 +- .../servicecatalog/api_op_DeleteProduct.go | 10 +- .../api_op_DeleteProvisionedProductPlan.go | 14 +- .../api_op_DeleteProvisioningArtifact.go | 10 +- .../api_op_DescribeConstraint.go | 16 +- .../api_op_DescribeCopyProductStatus.go | 6 +- .../api_op_DescribePortfolio.go | 16 +- .../api_op_DescribePortfolioShareStatus.go | 6 +- .../servicecatalog/api_op_DescribeProduct.go | 24 +- .../api_op_DescribeProductAsAdmin.go | 22 +- .../api_op_DescribeProductView.go | 16 +- .../api_op_DescribeProvisionedProductPlan.go | 26 +- .../api_op_DescribeProvisioningArtifact.go | 16 +- .../api_op_DescribeProvisioningParameters.go | 30 +- .../servicecatalog/api_op_DescribeRecord.go | 24 +- ...escribeServiceActionExecutionParameters.go | 10 +- ...i_op_DisassociatePrincipalFromPortfolio.go | 20 +- ...teServiceActionFromProvisioningArtifact.go | 10 +- ...pi_op_DisassociateTagOptionFromResource.go | 8 +- .../api_op_ExecuteProvisionedProductPlan.go | 10 +- ..._ExecuteProvisionedProductServiceAction.go | 24 +- .../api_op_ListAcceptedPortfolioShares.go | 14 +- .../api_op_ListBudgetsForResource.go | 16 +- .../api_op_ListConstraintsForPortfolio.go | 16 +- .../servicecatalog/api_op_ListLaunchPaths.go | 12 +- .../api_op_ListOrganizationPortfolioAccess.go | 14 +- .../api_op_ListPortfolioAccess.go | 12 +- .../servicecatalog/api_op_ListPortfolios.go | 14 +- .../api_op_ListPortfoliosForProduct.go | 16 +- .../api_op_ListPrincipalsForPortfolio.go | 14 +- .../api_op_ListProvisionedProductPlans.go | 12 +- ...stProvisioningArtifactsForServiceAction.go | 14 +- .../api_op_ListRecordHistory.go | 24 +- .../api_op_ListServiceActions.go | 22 +- ...stServiceActionsForProvisioningArtifact.go | 16 +- ...ListStackInstancesForProvisionedProduct.go | 20 +- .../servicecatalog/api_op_ListTagOptions.go | 6 +- .../servicecatalog/api_op_ProvisionProduct.go | 58 +- .../api_op_RejectPortfolioShare.go | 20 +- .../api_op_ScanProvisionedProducts.go | 14 +- .../servicecatalog/api_op_SearchProducts.go | 32 +- .../api_op_SearchProductsAsAdmin.go | 44 +- .../api_op_SearchProvisionedProducts.go | 40 +- .../api_op_TerminateProvisionedProduct.go | 8 +- .../servicecatalog/api_op_UpdateConstraint.go | 36 +- .../servicecatalog/api_op_UpdatePortfolio.go | 22 +- .../servicecatalog/api_op_UpdateProduct.go | 32 +- .../api_op_UpdateProvisionedProduct.go | 62 +- ...i_op_UpdateProvisionedProductProperties.go | 36 +- .../api_op_UpdateProvisioningArtifact.go | 46 +- .../api_op_UpdateServiceAction.go | 18 +- service/servicecatalog/go.mod | 2 +- service/servicecatalog/types/types.go | 710 +- .../api_op_CreateHttpNamespace.go | 16 +- .../api_op_CreatePrivateDnsNamespace.go | 12 +- .../api_op_CreatePublicDnsNamespace.go | 16 +- .../servicediscovery/api_op_CreateService.go | 50 +- .../api_op_DiscoverInstances.go | 14 +- .../servicediscovery/api_op_GetInstance.go | 8 +- .../api_op_GetInstancesHealthStatus.go | 18 +- .../servicediscovery/api_op_ListInstances.go | 10 +- .../servicediscovery/api_op_ListNamespaces.go | 18 +- .../servicediscovery/api_op_ListOperations.go | 12 +- .../servicediscovery/api_op_ListServices.go | 10 +- .../api_op_RegisterInstance.go | 16 +- .../servicediscovery/api_op_TagResource.go | 12 +- .../servicediscovery/api_op_UntagResource.go | 10 +- ...api_op_UpdateInstanceCustomHealthStatus.go | 8 +- .../servicediscovery/api_op_UpdateService.go | 8 +- service/servicediscovery/go.mod | 2 +- service/servicediscovery/types/types.go | 446 +- ...ServiceQuotaIncreaseRequestFromTemplate.go | 10 +- .../servicequotas/api_op_GetServiceQuota.go | 8 +- ...ServiceQuotaIncreaseRequestFromTemplate.go | 8 +- .../api_op_ListAWSDefaultServiceQuotas.go | 16 +- ..._ListRequestedServiceQuotaChangeHistory.go | 24 +- ...questedServiceQuotaChangeHistoryByQuota.go | 14 +- ...tServiceQuotaIncreaseRequestsInTemplate.go | 6 +- .../servicequotas/api_op_ListServiceQuotas.go | 12 +- service/servicequotas/api_op_ListServices.go | 18 +- ...ServiceQuotaIncreaseRequestIntoTemplate.go | 14 +- .../api_op_RequestServiceQuotaIncrease.go | 8 +- service/servicequotas/go.mod | 2 +- service/servicequotas/types/types.go | 134 +- service/ses/api_op_CloneReceiptRuleSet.go | 10 +- ..._CreateConfigurationSetEventDestination.go | 12 +- ...p_CreateCustomVerificationEmailTemplate.go | 34 +- service/ses/api_op_CreateReceiptRule.go | 10 +- .../ses/api_op_DescribeConfigurationSet.go | 20 +- ...i_op_GetCustomVerificationEmailTemplate.go | 12 +- service/ses/api_op_GetIdentityPolicies.go | 14 +- service/ses/api_op_GetSendQuota.go | 6 +- service/ses/api_op_ListConfigurationSets.go | 6 +- ...op_ListCustomVerificationEmailTemplates.go | 8 +- service/ses/api_op_ListIdentities.go | 12 +- service/ses/api_op_ListReceiptRuleSets.go | 8 +- service/ses/api_op_ListTemplates.go | 16 +- ...i_op_PutConfigurationSetDeliveryOptions.go | 8 +- service/ses/api_op_PutIdentityPolicy.go | 16 +- service/ses/api_op_ReorderReceiptRuleSet.go | 10 +- service/ses/api_op_SendBounce.go | 24 +- service/ses/api_op_SendBulkTemplatedEmail.go | 96 +- .../ses/api_op_SendCustomVerificationEmail.go | 6 +- service/ses/api_op_SendEmail.go | 56 +- service/ses/api_op_SendRawEmail.go | 76 +- service/ses/api_op_SendTemplatedEmail.go | 58 +- service/ses/api_op_SetIdentityDkimEnabled.go | 10 +- ...op_SetIdentityFeedbackForwardingEnabled.go | 12 +- ...etIdentityHeadersInNotificationsEnabled.go | 10 +- .../api_op_SetIdentityNotificationTopic.go | 18 +- service/ses/api_op_SetReceiptRulePosition.go | 6 +- service/ses/api_op_TestRenderTemplate.go | 10 +- ..._UpdateConfigurationSetEventDestination.go | 12 +- ...op_UpdateConfigurationSetSendingEnabled.go | 10 +- ...p_UpdateConfigurationSetTrackingOptions.go | 12 +- ...p_UpdateCustomVerificationEmailTemplate.go | 32 +- service/ses/api_op_UpdateReceiptRule.go | 8 +- service/ses/go.mod | 2 +- service/ses/types/types.go | 424 +- .../sesv2/api_op_CreateConfigurationSet.go | 26 +- ...p_CreateCustomVerificationEmailTemplate.go | 32 +- .../api_op_CreateDeliverabilityTestReport.go | 10 +- service/sesv2/api_op_CreateEmailIdentity.go | 22 +- service/sesv2/api_op_CreateEmailTemplate.go | 10 +- service/sesv2/api_op_GetAccount.go | 50 +- service/sesv2/api_op_GetConfigurationSet.go | 28 +- ...i_op_GetCustomVerificationEmailTemplate.go | 14 +- service/sesv2/api_op_GetDedicatedIps.go | 14 +- ...pi_op_GetDeliverabilityDashboardOptions.go | 32 +- .../api_op_GetDeliverabilityTestReport.go | 16 +- service/sesv2/api_op_GetEmailIdentity.go | 22 +- service/sesv2/api_op_GetEmailTemplate.go | 10 +- service/sesv2/api_op_ListConfigurationSets.go | 8 +- ...op_ListCustomVerificationEmailTemplates.go | 8 +- service/sesv2/api_op_ListDedicatedIpPools.go | 8 +- ...pi_op_ListDomainDeliverabilityCampaigns.go | 22 +- .../api_op_ListSuppressedDestinations.go | 8 +- service/sesv2/api_op_PutAccountDetails.go | 36 +- ...i_op_PutConfigurationSetDeliveryOptions.go | 12 +- ...p_PutConfigurationSetSuppressionOptions.go | 12 +- ...i_op_PutConfigurationSetTrackingOptions.go | 6 +- service/sesv2/api_op_PutDedicatedIpInPool.go | 12 +- ...api_op_PutDeliverabilityDashboardOption.go | 8 +- ...p_PutEmailIdentityDkimSigningAttributes.go | 36 +- ...i_op_PutEmailIdentityFeedbackAttributes.go | 12 +- service/sesv2/api_op_SendBulkEmail.go | 56 +- .../api_op_SendCustomVerificationEmail.go | 6 +- service/sesv2/api_op_SendEmail.go | 66 +- service/sesv2/api_op_TagResource.go | 12 +- ...p_UpdateCustomVerificationEmailTemplate.go | 30 +- .../sesv2/api_op_UpdateEmailIdentityPolicy.go | 12 +- service/sesv2/api_op_UpdateEmailTemplate.go | 10 +- service/sesv2/go.mod | 2 +- service/sesv2/types/types.go | 456 +- service/sfn/api_op_CreateActivity.go | 20 +- service/sfn/api_op_CreateStateMachine.go | 52 +- service/sfn/api_op_DescribeActivity.go | 10 +- service/sfn/api_op_DescribeExecution.go | 36 +- service/sfn/api_op_DescribeStateMachine.go | 44 +- ...api_op_DescribeStateMachineForExecution.go | 28 +- service/sfn/api_op_GetActivityTask.go | 6 +- service/sfn/api_op_GetExecutionHistory.go | 20 +- service/sfn/api_op_ListActivities.go | 14 +- service/sfn/api_op_ListExecutions.go | 24 +- service/sfn/api_op_ListStateMachines.go | 17 +- service/sfn/api_op_SendTaskFailure.go | 6 +- service/sfn/api_op_SendTaskSuccess.go | 10 +- service/sfn/api_op_StartExecution.go | 28 +- service/sfn/api_op_StopExecution.go | 10 +- service/sfn/api_op_TagResource.go | 10 +- service/sfn/api_op_UpdateStateMachine.go | 10 +- service/sfn/go.mod | 2 +- service/sfn/types/types.go | 360 +- service/shield/api_op_CreateProtection.go | 10 +- service/shield/api_op_DescribeDRTAccess.go | 6 +- service/shield/api_op_DescribeProtection.go | 10 +- service/shield/api_op_ListAttacks.go | 22 +- service/shield/api_op_ListProtections.go | 8 +- service/shield/go.mod | 2 +- service/shield/types/types.go | 130 +- service/signer/api_op_DescribeSigningJob.go | 40 +- service/signer/api_op_GetSigningPlatform.go | 20 +- service/signer/api_op_GetSigningProfile.go | 24 +- service/signer/api_op_ListSigningJobs.go | 14 +- service/signer/api_op_ListSigningPlatforms.go | 12 +- service/signer/api_op_ListSigningProfiles.go | 12 +- service/signer/api_op_PutSigningProfile.go | 24 +- service/signer/api_op_StartSigningJob.go | 16 +- service/signer/api_op_TagResource.go | 8 +- service/signer/go.mod | 2 +- service/signer/types/types.go | 86 +- service/sms/api_op_CreateApp.go | 14 +- service/sms/api_op_CreateReplicationJob.go | 36 +- service/sms/api_op_DeleteApp.go | 10 +- service/sms/api_op_GenerateChangeSet.go | 6 +- service/sms/api_op_GenerateTemplate.go | 6 +- service/sms/api_op_GetApp.go | 6 +- .../sms/api_op_GetAppLaunchConfiguration.go | 8 +- service/sms/api_op_GetConnectors.go | 12 +- service/sms/api_op_GetReplicationJobs.go | 12 +- service/sms/api_op_GetReplicationRuns.go | 14 +- service/sms/api_op_GetServers.go | 16 +- service/sms/api_op_ListApps.go | 6 +- .../sms/api_op_PutAppLaunchConfiguration.go | 8 +- .../api_op_PutAppReplicationConfiguration.go | 6 +- service/sms/api_op_UpdateApp.go | 20 +- service/sms/api_op_UpdateReplicationJob.go | 38 +- service/sms/go.mod | 2 +- service/sms/types/types.go | 294 +- service/snowball/api_op_CreateCluster.go | 54 +- service/snowball/api_op_CreateJob.go | 94 +- service/snowball/api_op_DescribeAddresses.go | 6 +- service/snowball/api_op_ListClusterJobs.go | 18 +- service/snowball/api_op_ListClusters.go | 8 +- service/snowball/api_op_ListJobs.go | 6 +- service/snowball/api_op_UpdateCluster.go | 26 +- service/snowball/api_op_UpdateJob.go | 30 +- service/snowball/go.mod | 2 +- service/snowball/types/types.go | 282 +- service/sns/api_op_AddPermission.go | 22 +- service/sns/api_op_ConfirmSubscription.go | 10 +- .../sns/api_op_CreatePlatformApplication.go | 14 +- service/sns/api_op_CreatePlatformEndpoint.go | 16 +- service/sns/api_op_CreateTopic.go | 20 +- ...i_op_ListEndpointsByPlatformApplication.go | 6 +- .../sns/api_op_ListSubscriptionsByTopic.go | 6 +- service/sns/api_op_ListTopics.go | 6 +- service/sns/api_op_Publish.go | 34 +- service/sns/api_op_RemovePermission.go | 8 +- service/sns/api_op_SetEndpointAttributes.go | 10 +- ...api_op_SetPlatformApplicationAttributes.go | 10 +- .../sns/api_op_SetSubscriptionAttributes.go | 10 +- service/sns/api_op_SetTopicAttributes.go | 16 +- service/sns/api_op_Subscribe.go | 60 +- service/sns/api_op_TagResource.go | 10 +- service/sns/api_op_UntagResource.go | 8 +- service/sns/go.mod | 2 +- service/sns/types/types.go | 20 +- service/sqs/api_op_AddPermission.go | 26 +- service/sqs/api_op_ChangeMessageVisibility.go | 12 +- .../api_op_ChangeMessageVisibilityBatch.go | 8 +- service/sqs/api_op_CreateQueue.go | 42 +- service/sqs/api_op_DeleteMessage.go | 10 +- service/sqs/api_op_GetQueueUrl.go | 6 +- .../sqs/api_op_ListDeadLetterSourceQueues.go | 6 +- service/sqs/api_op_ListQueues.go | 6 +- service/sqs/api_op_ReceiveMessage.go | 82 +- service/sqs/api_op_RemovePermission.go | 12 +- service/sqs/api_op_SendMessage.go | 118 +- service/sqs/api_op_SendMessageBatch.go | 10 +- service/sqs/api_op_SetQueueAttributes.go | 12 +- service/sqs/api_op_TagQueue.go | 8 +- service/sqs/go.mod | 2 +- service/sqs/types/types.go | 192 +- service/ssm/api_op_AddTagsToResource.go | 20 +- service/ssm/api_op_CancelCommand.go | 10 +- service/ssm/api_op_CreateActivation.go | 44 +- service/ssm/api_op_CreateAssociation.go | 108 +- service/ssm/api_op_CreateAssociationBatch.go | 6 +- service/ssm/api_op_CreateDocument.go | 82 +- service/ssm/api_op_CreateMaintenanceWindow.go | 94 +- service/ssm/api_op_CreateOpsItem.go | 38 +- service/ssm/api_op_CreatePatchBaseline.go | 58 +- service/ssm/api_op_CreateResourceDataSync.go | 24 +- service/ssm/api_op_DeleteAssociation.go | 6 +- service/ssm/api_op_DeleteDocument.go | 18 +- service/ssm/api_op_DeleteInventory.go | 20 +- service/ssm/api_op_DeleteResourceDataSync.go | 6 +- ...op_DeregisterPatchBaselineForPatchGroup.go | 8 +- ...p_DeregisterTargetFromMaintenanceWindow.go | 10 +- service/ssm/api_op_DescribeAssociation.go | 6 +- ..._op_DescribeAssociationExecutionTargets.go | 24 +- .../api_op_DescribeAssociationExecutions.go | 14 +- .../api_op_DescribeAutomationExecutions.go | 16 +- ...api_op_DescribeAutomationStepExecutions.go | 8 +- .../ssm/api_op_DescribeAvailablePatches.go | 10 +- service/ssm/api_op_DescribeDocument.go | 10 +- ...p_DescribeEffectiveInstanceAssociations.go | 8 +- ...escribeEffectivePatchesForPatchBaseline.go | 12 +- ...i_op_DescribeInstanceAssociationsStatus.go | 8 +- .../ssm/api_op_DescribeInstanceInformation.go | 22 +- .../ssm/api_op_DescribeInstancePatchStates.go | 14 +- ...escribeInstancePatchStatesForPatchGroup.go | 6 +- service/ssm/api_op_DescribeInstancePatches.go | 6 +- .../ssm/api_op_DescribeInventoryDeletions.go | 6 +- ...intenanceWindowExecutionTaskInvocations.go | 24 +- ...DescribeMaintenanceWindowExecutionTasks.go | 18 +- ...pi_op_DescribeMaintenanceWindowSchedule.go | 28 +- ...api_op_DescribeMaintenanceWindowTargets.go | 16 +- .../api_op_DescribeMaintenanceWindowTasks.go | 16 +- ..._op_DescribeMaintenanceWindowsForTarget.go | 20 +- service/ssm/api_op_DescribeOpsItems.go | 6 +- service/ssm/api_op_DescribeParameters.go | 16 +- service/ssm/api_op_DescribePatchBaselines.go | 6 +- service/ssm/api_op_DescribePatchGroupState.go | 24 +- service/ssm/api_op_DescribePatchGroups.go | 14 +- service/ssm/api_op_DescribePatchProperties.go | 20 +- service/ssm/api_op_DescribeSessions.go | 12 +- service/ssm/api_op_GetCalendarState.go | 20 +- service/ssm/api_op_GetCommandInvocation.go | 114 +- service/ssm/api_op_GetDefaultPatchBaseline.go | 6 +- ...p_GetDeployablePatchSnapshotForInstance.go | 6 +- service/ssm/api_op_GetDocument.go | 50 +- service/ssm/api_op_GetInventory.go | 14 +- service/ssm/api_op_GetInventorySchema.go | 24 +- service/ssm/api_op_GetMaintenanceWindow.go | 64 +- .../api_op_GetMaintenanceWindowExecution.go | 16 +- ...pi_op_GetMaintenanceWindowExecutionTask.go | 44 +- ...aintenanceWindowExecutionTaskInvocation.go | 32 +- .../ssm/api_op_GetMaintenanceWindowTask.go | 62 +- service/ssm/api_op_GetOpsSummary.go | 14 +- service/ssm/api_op_GetParameter.go | 8 +- service/ssm/api_op_GetParameterHistory.go | 14 +- service/ssm/api_op_GetParameters.go | 8 +- service/ssm/api_op_GetParametersByPath.go | 26 +- service/ssm/api_op_GetPatchBaseline.go | 60 +- .../api_op_GetPatchBaselineForPatchGroup.go | 6 +- service/ssm/api_op_LabelParameterVersion.go | 16 +- service/ssm/api_op_ListAssociationVersions.go | 6 +- service/ssm/api_op_ListAssociations.go | 14 +- service/ssm/api_op_ListCommandInvocations.go | 24 +- service/ssm/api_op_ListCommands.go | 24 +- service/ssm/api_op_ListComplianceItems.go | 14 +- service/ssm/api_op_ListComplianceSummaries.go | 8 +- service/ssm/api_op_ListDocumentVersions.go | 14 +- service/ssm/api_op_ListDocuments.go | 8 +- service/ssm/api_op_ListInventoryEntries.go | 42 +- .../api_op_ListResourceComplianceSummaries.go | 6 +- service/ssm/api_op_ListResourceDataSync.go | 6 +- service/ssm/api_op_ListTagsForResource.go | 8 +- .../ssm/api_op_ModifyDocumentPermission.go | 8 +- service/ssm/api_op_PutComplianceItems.go | 40 +- service/ssm/api_op_PutInventory.go | 8 +- service/ssm/api_op_PutParameter.go | 176 +- ...i_op_RegisterPatchBaselineForPatchGroup.go | 8 +- ..._op_RegisterTargetWithMaintenanceWindow.go | 28 +- ...pi_op_RegisterTaskWithMaintenanceWindow.go | 90 +- service/ssm/api_op_RemoveTagsFromResource.go | 10 +- service/ssm/api_op_SendAutomationSignal.go | 10 +- service/ssm/api_op_SendCommand.go | 100 +- .../ssm/api_op_StartAutomationExecution.go | 78 +- service/ssm/api_op_StartSession.go | 16 +- service/ssm/api_op_UpdateAssociation.go | 88 +- service/ssm/api_op_UpdateAssociationStatus.go | 10 +- service/ssm/api_op_UpdateDocument.go | 24 +- service/ssm/api_op_UpdateMaintenanceWindow.go | 114 +- .../api_op_UpdateMaintenanceWindowTarget.go | 46 +- .../ssm/api_op_UpdateMaintenanceWindowTask.go | 120 +- .../ssm/api_op_UpdateManagedInstanceRole.go | 8 +- service/ssm/api_op_UpdateOpsItem.go | 40 +- service/ssm/api_op_UpdatePatchBaseline.go | 114 +- service/ssm/api_op_UpdateResourceDataSync.go | 10 +- service/ssm/go.mod | 2 +- service/ssm/types/types.go | 2526 +++--- service/sso/api_op_GetRoleCredentials.go | 10 +- service/sso/api_op_ListAccountRoles.go | 8 +- service/sso/go.mod | 2 +- service/sso/types/types.go | 24 +- service/ssooidc/api_op_CreateToken.go | 52 +- service/ssooidc/api_op_RegisterClient.go | 28 +- .../api_op_StartDeviceAuthorization.go | 38 +- service/ssooidc/go.mod | 2 +- .../storagegateway/api_op_ActivateGateway.go | 60 +- .../api_op_AddTagsToResource.go | 10 +- .../storagegateway/api_op_AddUploadBuffer.go | 12 +- .../api_op_AddWorkingStorage.go | 12 +- service/storagegateway/api_op_AttachVolume.go | 44 +- .../storagegateway/api_op_CancelRetrieval.go | 12 +- .../api_op_CreateCachediSCSIVolume.go | 78 +- .../api_op_CreateNFSFileShare.go | 106 +- .../api_op_CreateSMBFileShare.go | 130 +- .../storagegateway/api_op_CreateSnapshot.go | 12 +- ...p_CreateSnapshotFromVolumeRecoveryPoint.go | 20 +- .../api_op_CreateStorediSCSIVolume.go | 84 +- .../api_op_CreateTapeWithBarcode.go | 40 +- service/storagegateway/api_op_CreateTapes.go | 58 +- .../api_op_DeleteBandwidthRateLimit.go | 12 +- .../api_op_DeleteChapCredentials.go | 16 +- .../storagegateway/api_op_DeleteFileShare.go | 10 +- .../api_op_DescribeAvailabilityMonitorTest.go | 8 +- .../api_op_DescribeBandwidthRateLimit.go | 8 +- .../storagegateway/api_op_DescribeCache.go | 32 +- .../api_op_DescribeGatewayInformation.go | 72 +- .../api_op_DescribeMaintenanceStartTime.go | 18 +- .../api_op_DescribeSMBSettings.go | 12 +- .../api_op_DescribeSnapshotSchedule.go | 24 +- .../api_op_DescribeTapeRecoveryPoints.go | 20 +- .../storagegateway/api_op_DescribeTapes.go | 24 +- .../api_op_DescribeUploadBuffer.go | 6 +- .../api_op_DescribeVTLDevices.go | 30 +- .../api_op_DescribeWorkingStorage.go | 8 +- service/storagegateway/api_op_JoinDomain.go | 40 +- .../storagegateway/api_op_ListFileShares.go | 6 +- service/storagegateway/api_op_ListGateways.go | 14 +- .../api_op_ListTagsForResource.go | 22 +- service/storagegateway/api_op_ListTapes.go | 18 +- service/storagegateway/api_op_ListVolumes.go | 10 +- service/storagegateway/api_op_RefreshCache.go | 6 +- .../api_op_SetLocalConsolePassword.go | 10 +- .../api_op_UpdateBandwidthRateLimit.go | 6 +- .../api_op_UpdateChapCredentials.go | 30 +- .../api_op_UpdateGatewayInformation.go | 20 +- .../api_op_UpdateMaintenanceStartTime.go | 20 +- .../api_op_UpdateNFSFileShare.go | 60 +- .../api_op_UpdateSMBFileShare.go | 88 +- .../api_op_UpdateSMBSecurityStrategy.go | 12 +- .../api_op_UpdateSnapshotSchedule.go | 18 +- .../api_op_UpdateVTLDeviceType.go | 10 +- service/storagegateway/go.mod | 2 +- service/storagegateway/types/types.go | 646 +- service/sts/api_op_AssumeRole.go | 186 +- service/sts/api_op_AssumeRoleWithSAML.go | 134 +- .../sts/api_op_AssumeRoleWithWebIdentity.go | 92 +- service/sts/api_op_GetCallerIdentity.go | 6 +- service/sts/api_op_GetFederationToken.go | 88 +- service/sts/api_op_GetSessionToken.go | 18 +- service/sts/go.mod | 2 +- service/sts/types/types.go | 22 +- .../support/api_op_AddCommunicationToCase.go | 14 +- service/support/api_op_CreateCase.go | 64 +- service/support/api_op_DescribeCases.go | 32 +- .../support/api_op_DescribeCommunications.go | 6 +- service/support/api_op_ResolveCase.go | 6 +- service/support/go.mod | 2 +- service/support/types/types.go | 234 +- .../api_op_CountClosedWorkflowExecutions.go | 38 +- .../swf/api_op_CountOpenWorkflowExecutions.go | 24 +- .../swf/api_op_CountPendingActivityTasks.go | 16 +- .../swf/api_op_CountPendingDecisionTasks.go | 8 +- service/swf/api_op_DescribeActivityType.go | 20 +- service/swf/api_op_DescribeDomain.go | 10 +- .../swf/api_op_DescribeWorkflowExecution.go | 18 +- .../swf/api_op_GetWorkflowExecutionHistory.go | 24 +- service/swf/api_op_ListActivityTypes.go | 38 +- .../api_op_ListClosedWorkflowExecutions.go | 64 +- .../swf/api_op_ListOpenWorkflowExecutions.go | 34 +- service/swf/api_op_ListWorkflowTypes.go | 26 +- service/swf/api_op_PollForActivityTask.go | 22 +- service/swf/api_op_PollForDecisionTask.go | 70 +- service/swf/api_op_RegisterActivityType.go | 100 +- service/swf/api_op_RegisterDomain.go | 26 +- service/swf/api_op_RegisterWorkflowType.go | 68 +- .../swf/api_op_RespondActivityTaskFailed.go | 6 +- .../api_op_RespondDecisionTaskCompleted.go | 8 +- service/swf/api_op_SignalWorkflowExecution.go | 10 +- service/swf/api_op_StartWorkflowExecution.go | 102 +- .../swf/api_op_TerminateWorkflowExecution.go | 20 +- service/swf/go.mod | 2 +- service/swf/types/types.go | 1904 ++--- service/synthetics/api_op_CreateCanary.go | 100 +- .../api_op_DescribeCanariesLastRun.go | 8 +- .../api_op_DescribeRuntimeVersions.go | 10 +- service/synthetics/api_op_GetCanaryRuns.go | 8 +- service/synthetics/api_op_TagResource.go | 10 +- service/synthetics/api_op_UpdateCanary.go | 28 +- service/synthetics/go.mod | 2 +- service/synthetics/types/types.go | 182 +- service/textract/api_op_AnalyzeDocument.go | 20 +- service/textract/api_op_DetectDocumentText.go | 6 +- .../textract/api_op_GetDocumentAnalysis.go | 26 +- .../api_op_GetDocumentTextDetection.go | 32 +- .../textract/api_op_StartDocumentAnalysis.go | 36 +- .../api_op_StartDocumentTextDetection.go | 12 +- service/textract/go.mod | 2 +- service/textract/types/types.go | 192 +- .../api_op_CreateMedicalVocabulary.go | 30 +- service/transcribe/api_op_CreateVocabulary.go | 24 +- .../api_op_CreateVocabularyFilter.go | 36 +- .../transcribe/api_op_GetMedicalVocabulary.go | 18 +- service/transcribe/api_op_GetVocabulary.go | 22 +- .../transcribe/api_op_GetVocabularyFilter.go | 12 +- .../api_op_ListMedicalTranscriptionJobs.go | 24 +- .../api_op_ListMedicalVocabularies.go | 22 +- .../api_op_ListTranscriptionJobs.go | 16 +- service/transcribe/api_op_ListVocabularies.go | 22 +- .../api_op_ListVocabularyFilters.go | 12 +- .../api_op_StartMedicalTranscriptionJob.go | 28 +- .../api_op_StartTranscriptionJob.go | 50 +- .../api_op_UpdateMedicalVocabulary.go | 30 +- service/transcribe/api_op_UpdateVocabulary.go | 14 +- .../api_op_UpdateVocabularyFilter.go | 8 +- service/transcribe/go.mod | 2 +- service/transcribe/types/types.go | 300 +- service/transfer/api_op_CreateServer.go | 74 +- service/transfer/api_op_CreateUser.go | 84 +- service/transfer/api_op_DeleteSshPublicKey.go | 10 +- service/transfer/api_op_DescribeUser.go | 12 +- service/transfer/api_op_ImportSshPublicKey.go | 16 +- service/transfer/api_op_ListServers.go | 8 +- .../transfer/api_op_ListTagsForResource.go | 14 +- service/transfer/api_op_ListUsers.go | 20 +- service/transfer/api_op_TagResource.go | 12 +- .../transfer/api_op_TestIdentityProvider.go | 36 +- service/transfer/api_op_UpdateServer.go | 72 +- service/transfer/api_op_UpdateUser.go | 66 +- service/transfer/go.mod | 2 +- service/transfer/types/types.go | 234 +- service/translate/api_op_GetTerminology.go | 14 +- service/translate/api_op_ImportTerminology.go | 24 +- service/translate/api_op_ListTerminologies.go | 6 +- .../api_op_ListTextTranslationJobs.go | 12 +- .../api_op_StartTextTranslationJob.go | 14 +- .../api_op_StopTextTranslationJob.go | 6 +- service/translate/api_op_TranslateText.go | 12 +- service/translate/go.mod | 2 +- service/translate/types/types.go | 128 +- service/waf/api_op_CreateByteMatchSet.go | 6 +- service/waf/api_op_CreateIPSet.go | 16 +- service/waf/api_op_CreateRateBasedRule.go | 36 +- service/waf/api_op_CreateRegexPatternSet.go | 16 +- service/waf/api_op_CreateRule.go | 16 +- service/waf/api_op_CreateRuleGroup.go | 8 +- service/waf/api_op_CreateSizeConstraintSet.go | 16 +- service/waf/api_op_CreateWebACL.go | 28 +- .../waf/api_op_CreateWebACLMigrationStack.go | 14 +- service/waf/api_op_CreateXssMatchSet.go | 10 +- service/waf/api_op_DeleteIPSet.go | 10 +- service/waf/api_op_DeleteRateBasedRule.go | 10 +- service/waf/api_op_DeleteRegexMatchSet.go | 10 +- service/waf/api_op_DeleteRuleGroup.go | 10 +- service/waf/api_op_DeleteSizeConstraintSet.go | 10 +- .../waf/api_op_DeleteSqlInjectionMatchSet.go | 10 +- .../waf/api_op_GetRateBasedRuleManagedKeys.go | 6 +- service/waf/api_op_GetSampledRequests.go | 52 +- .../api_op_ListActivatedRulesInRuleGroup.go | 8 +- service/waf/api_op_ListByteMatchSets.go | 18 +- service/waf/api_op_ListGeoMatchSets.go | 18 +- service/waf/api_op_ListIPSets.go | 12 +- .../waf/api_op_ListLoggingConfigurations.go | 12 +- service/waf/api_op_ListRegexMatchSets.go | 12 +- service/waf/api_op_ListRegexPatternSets.go | 12 +- service/waf/api_op_ListRuleGroups.go | 18 +- service/waf/api_op_ListRules.go | 16 +- service/waf/api_op_ListSizeConstraintSets.go | 18 +- .../waf/api_op_ListSqlInjectionMatchSets.go | 18 +- service/waf/api_op_ListTagsForResource.go | 10 +- service/waf/api_op_ListWebACLs.go | 6 +- service/waf/api_op_ListXssMatchSets.go | 12 +- service/waf/api_op_TagResource.go | 4 +- service/waf/api_op_UntagResource.go | 4 +- service/waf/api_op_UpdateByteMatchSet.go | 22 +- service/waf/api_op_UpdateGeoMatchSet.go | 22 +- service/waf/api_op_UpdateIPSet.go | 10 +- service/waf/api_op_UpdateRateBasedRule.go | 10 +- service/waf/api_op_UpdateRegexMatchSet.go | 10 +- service/waf/api_op_UpdateRegexPatternSet.go | 10 +- service/waf/api_op_UpdateRule.go | 22 +- service/waf/api_op_UpdateRuleGroup.go | 16 +- service/waf/api_op_UpdateSizeConstraintSet.go | 10 +- .../waf/api_op_UpdateSqlInjectionMatchSet.go | 10 +- service/waf/api_op_UpdateWebACL.go | 10 +- service/waf/api_op_UpdateXssMatchSet.go | 10 +- service/waf/go.mod | 2 +- service/waf/types/types.go | 758 +- service/wafregional/api_op_AssociateWebACL.go | 10 +- .../wafregional/api_op_CreateByteMatchSet.go | 6 +- service/wafregional/api_op_CreateIPSet.go | 16 +- .../wafregional/api_op_CreateRateBasedRule.go | 36 +- .../api_op_CreateRegexPatternSet.go | 16 +- service/wafregional/api_op_CreateRule.go | 16 +- service/wafregional/api_op_CreateRuleGroup.go | 8 +- .../api_op_CreateSizeConstraintSet.go | 16 +- service/wafregional/api_op_CreateWebACL.go | 28 +- .../api_op_CreateWebACLMigrationStack.go | 14 +- .../wafregional/api_op_CreateXssMatchSet.go | 10 +- service/wafregional/api_op_DeleteIPSet.go | 10 +- .../wafregional/api_op_DeleteRateBasedRule.go | 10 +- .../wafregional/api_op_DeleteRegexMatchSet.go | 10 +- service/wafregional/api_op_DeleteRuleGroup.go | 10 +- .../api_op_DeleteSizeConstraintSet.go | 10 +- .../api_op_DeleteSqlInjectionMatchSet.go | 10 +- .../api_op_GetRateBasedRuleManagedKeys.go | 6 +- .../wafregional/api_op_GetSampledRequests.go | 52 +- .../api_op_ListActivatedRulesInRuleGroup.go | 8 +- .../wafregional/api_op_ListByteMatchSets.go | 18 +- .../wafregional/api_op_ListGeoMatchSets.go | 18 +- service/wafregional/api_op_ListIPSets.go | 12 +- .../api_op_ListLoggingConfigurations.go | 12 +- .../wafregional/api_op_ListRegexMatchSets.go | 12 +- .../api_op_ListRegexPatternSets.go | 12 +- service/wafregional/api_op_ListRuleGroups.go | 18 +- service/wafregional/api_op_ListRules.go | 16 +- .../api_op_ListSizeConstraintSets.go | 18 +- .../api_op_ListSqlInjectionMatchSets.go | 18 +- .../wafregional/api_op_ListTagsForResource.go | 10 +- service/wafregional/api_op_ListWebACLs.go | 6 +- .../wafregional/api_op_ListXssMatchSets.go | 12 +- service/wafregional/api_op_TagResource.go | 4 +- service/wafregional/api_op_UntagResource.go | 4 +- .../wafregional/api_op_UpdateByteMatchSet.go | 22 +- .../wafregional/api_op_UpdateGeoMatchSet.go | 22 +- service/wafregional/api_op_UpdateIPSet.go | 10 +- .../wafregional/api_op_UpdateRateBasedRule.go | 10 +- .../wafregional/api_op_UpdateRegexMatchSet.go | 10 +- .../api_op_UpdateRegexPatternSet.go | 10 +- service/wafregional/api_op_UpdateRule.go | 22 +- service/wafregional/api_op_UpdateRuleGroup.go | 16 +- .../api_op_UpdateSizeConstraintSet.go | 10 +- .../api_op_UpdateSqlInjectionMatchSet.go | 10 +- service/wafregional/api_op_UpdateWebACL.go | 10 +- .../wafregional/api_op_UpdateXssMatchSet.go | 10 +- service/wafregional/go.mod | 2 +- service/wafregional/types/types.go | 758 +- service/wafv2/api_op_AssociateWebACL.go | 12 +- service/wafv2/api_op_CreateIPSet.go | 52 +- service/wafv2/api_op_CreateRegexPatternSet.go | 6 +- service/wafv2/api_op_CreateRuleGroup.go | 52 +- service/wafv2/api_op_CreateWebACL.go | 34 +- service/wafv2/api_op_DeleteIPSet.go | 24 +- service/wafv2/api_op_DeleteRegexPatternSet.go | 34 +- service/wafv2/api_op_DeleteRuleGroup.go | 34 +- service/wafv2/api_op_DeleteWebACL.go | 12 +- ...api_op_GetRateBasedStatementManagedKeys.go | 6 +- service/wafv2/api_op_GetRegexPatternSet.go | 22 +- service/wafv2/api_op_GetRuleGroup.go | 6 +- service/wafv2/api_op_GetSampledRequests.go | 44 +- service/wafv2/api_op_GetWebACL.go | 12 +- service/wafv2/api_op_ListIPSets.go | 22 +- .../wafv2/api_op_ListLoggingConfigurations.go | 6 +- service/wafv2/api_op_ListRuleGroups.go | 10 +- service/wafv2/api_op_ListTagsForResource.go | 16 +- service/wafv2/api_op_ListWebACLs.go | 28 +- service/wafv2/api_op_PutPermissionPolicy.go | 12 +- service/wafv2/api_op_TagResource.go | 8 +- service/wafv2/api_op_UpdateIPSet.go | 52 +- service/wafv2/api_op_UpdateRegexPatternSet.go | 28 +- service/wafv2/api_op_UpdateRuleGroup.go | 44 +- service/wafv2/api_op_UpdateWebACL.go | 40 +- service/wafv2/go.mod | 2 +- service/wafv2/types/types.go | 725 +- service/workdocs/api_op_ActivateUser.go | 8 +- .../workdocs/api_op_AddResourcePermissions.go | 20 +- service/workdocs/api_op_CreateComment.go | 42 +- .../workdocs/api_op_CreateCustomMetadata.go | 10 +- service/workdocs/api_op_CreateFolder.go | 10 +- service/workdocs/api_op_CreateLabels.go | 8 +- .../api_op_CreateNotificationSubscription.go | 20 +- service/workdocs/api_op_CreateUser.go | 26 +- service/workdocs/api_op_DeleteComment.go | 8 +- .../workdocs/api_op_DeleteCustomMetadata.go | 20 +- service/workdocs/api_op_DeleteLabels.go | 12 +- .../api_op_DeleteNotificationSubscription.go | 8 +- service/workdocs/api_op_DescribeActivities.go | 42 +- service/workdocs/api_op_DescribeComments.go | 20 +- .../api_op_DescribeDocumentVersions.go | 32 +- .../workdocs/api_op_DescribeFolderContents.go | 24 +- service/workdocs/api_op_DescribeGroups.go | 18 +- ...pi_op_DescribeNotificationSubscriptions.go | 14 +- .../api_op_DescribeResourcePermissions.go | 12 +- .../workdocs/api_op_DescribeRootFolders.go | 12 +- service/workdocs/api_op_DescribeUsers.go | 34 +- service/workdocs/api_op_GetDocument.go | 8 +- service/workdocs/api_op_GetDocumentPath.go | 16 +- service/workdocs/api_op_GetDocumentVersion.go | 20 +- service/workdocs/api_op_GetFolder.go | 6 +- service/workdocs/api_op_GetFolderPath.go | 16 +- service/workdocs/api_op_GetResources.go | 22 +- .../api_op_InitiateDocumentVersionUpload.go | 26 +- .../api_op_RemoveAllResourcePermissions.go | 8 +- .../api_op_RemoveResourcePermission.go | 14 +- service/workdocs/api_op_UpdateDocument.go | 16 +- .../workdocs/api_op_UpdateDocumentVersion.go | 8 +- service/workdocs/api_op_UpdateFolder.go | 16 +- service/workdocs/api_op_UpdateUser.go | 24 +- service/workdocs/go.mod | 2 +- service/workdocs/types/types.go | 298 +- service/worklink/api_op_AssociateDomain.go | 10 +- ...p_AssociateWebsiteAuthorizationProvider.go | 10 +- service/worklink/api_op_CreateFleet.go | 6 +- ..._op_DescribeCompanyNetworkConfiguration.go | 6 +- service/worklink/api_op_DescribeDevice.go | 36 +- service/worklink/api_op_DescribeDomain.go | 22 +- .../worklink/api_op_DescribeFleetMetadata.go | 12 +- ...p_DescribeIdentityProviderConfiguration.go | 8 +- ..._op_DescribeWebsiteCertificateAuthority.go | 14 +- service/worklink/api_op_DisassociateDomain.go | 8 +- ...isassociateWebsiteAuthorizationProvider.go | 8 +- ...DisassociateWebsiteCertificateAuthority.go | 8 +- service/worklink/api_op_ListDevices.go | 16 +- service/worklink/api_op_ListDomains.go | 20 +- ...pi_op_ListWebsiteAuthorizationProviders.go | 6 +- ...pi_op_ListWebsiteCertificateAuthorities.go | 6 +- service/worklink/api_op_RevokeDomainAccess.go | 8 +- ...pi_op_UpdateCompanyNetworkConfiguration.go | 8 +- .../worklink/api_op_UpdateFleetMetadata.go | 6 +- service/worklink/go.mod | 2 +- service/worklink/types/types.go | 54 +- .../api_op_AssociateDelegateToResource.go | 8 +- .../workmail/api_op_AssociateMemberToGroup.go | 8 +- service/workmail/api_op_CreateAlias.go | 8 +- service/workmail/api_op_CreateResource.go | 10 +- service/workmail/api_op_CreateUser.go | 12 +- service/workmail/api_op_DeleteAlias.go | 10 +- service/workmail/api_op_DeleteGroup.go | 8 +- .../api_op_DeleteMailboxPermissions.go | 12 +- service/workmail/api_op_DeleteResource.go | 10 +- service/workmail/api_op_DeleteUser.go | 8 +- .../workmail/api_op_DeregisterFromWorkMail.go | 10 +- service/workmail/api_op_DescribeGroup.go | 14 +- .../workmail/api_op_DescribeOrganization.go | 26 +- service/workmail/api_op_DescribeResource.go | 28 +- service/workmail/api_op_DescribeUser.go | 30 +- ...api_op_DisassociateDelegateFromResource.go | 12 +- .../api_op_DisassociateMemberFromGroup.go | 10 +- service/workmail/api_op_GetMailboxDetails.go | 16 +- service/workmail/api_op_ListAliases.go | 16 +- service/workmail/api_op_ListGroups.go | 14 +- .../workmail/api_op_ListMailboxPermissions.go | 16 +- .../workmail/api_op_ListResourceDelegates.go | 12 +- service/workmail/api_op_ListResources.go | 16 +- service/workmail/api_op_ListUsers.go | 14 +- .../workmail/api_op_PutMailboxPermissions.go | 18 +- service/workmail/api_op_RegisterToWorkMail.go | 10 +- service/workmail/api_op_ResetPassword.go | 8 +- service/workmail/api_op_UpdateMailboxQuota.go | 8 +- .../api_op_UpdatePrimaryEmailAddress.go | 10 +- service/workmail/api_op_UpdateResource.go | 14 +- service/workmail/go.mod | 2 +- service/workmail/types/types.go | 118 +- service/workmailmessageflow/go.mod | 2 +- .../workspaces/api_op_AssociateIpGroups.go | 8 +- service/workspaces/api_op_AuthorizeIpRules.go | 8 +- .../workspaces/api_op_CopyWorkspaceImage.go | 6 +- service/workspaces/api_op_CreateIpGroup.go | 10 +- service/workspaces/api_op_CreateTags.go | 14 +- service/workspaces/api_op_CreateWorkspaces.go | 6 +- service/workspaces/api_op_DeleteTags.go | 10 +- .../api_op_DescribeWorkspaceBundles.go | 8 +- .../api_op_DescribeWorkspaceDirectories.go | 14 +- ...pi_op_DescribeWorkspaceImagePermissions.go | 16 +- .../api_op_DescribeWorkspaceImages.go | 12 +- .../workspaces/api_op_DescribeWorkspaces.go | 30 +- ...i_op_DescribeWorkspacesConnectionStatus.go | 6 +- .../workspaces/api_op_DisassociateIpGroups.go | 8 +- .../workspaces/api_op_ImportWorkspaceImage.go | 12 +- ...pi_op_ListAvailableManagementCidrRanges.go | 12 +- service/workspaces/api_op_MigrateWorkspace.go | 14 +- service/workspaces/api_op_ModifyAccount.go | 6 +- .../api_op_ModifySelfservicePermissions.go | 8 +- ...pi_op_ModifyWorkspaceCreationProperties.go | 8 +- .../workspaces/api_op_ModifyWorkspaceState.go | 8 +- .../api_op_RegisterWorkspaceDirectory.go | 26 +- .../workspaces/api_op_UpdateRulesOfIpGroup.go | 8 +- .../api_op_UpdateWorkspaceImagePermission.go | 8 +- service/workspaces/go.mod | 2 +- service/workspaces/types/types.go | 360 +- service/xray/api_op_BatchGetTraces.go | 12 +- service/xray/api_op_DeleteGroup.go | 6 +- service/xray/api_op_GetGroup.go | 6 +- service/xray/api_op_GetSamplingRules.go | 6 +- .../api_op_GetSamplingStatisticSummaries.go | 6 +- service/xray/api_op_GetSamplingTargets.go | 6 +- service/xray/api_op_GetServiceGraph.go | 26 +- .../api_op_GetTimeSeriesServiceStatistics.go | 40 +- service/xray/api_op_GetTraceGraph.go | 6 +- service/xray/api_op_GetTraceSummaries.go | 34 +- service/xray/api_op_PutEncryptionConfig.go | 12 +- service/xray/api_op_UpdateGroup.go | 6 +- service/xray/go.mod | 2 +- service/xray/types/types.go | 468 +- 5676 files changed, 121824 insertions(+), 121756 deletions(-) diff --git a/internal/protocoltest/awsrestjson/api_op_AllQueryStringTypes.go b/internal/protocoltest/awsrestjson/api_op_AllQueryStringTypes.go index 277b3bcf897..bbe893ffa18 100644 --- a/internal/protocoltest/awsrestjson/api_op_AllQueryStringTypes.go +++ b/internal/protocoltest/awsrestjson/api_op_AllQueryStringTypes.go @@ -53,15 +53,21 @@ func (c *Client) AllQueryStringTypes(ctx context.Context, params *AllQueryString } type AllQueryStringTypesInput struct { - QueryString *string - - QueryStringList []*string + QueryBoolean *bool - QueryStringSet []*string + QueryBooleanList []*bool QueryByte *int8 - QueryShort *int16 + QueryDouble *float64 + + QueryDoubleList []*float64 + + QueryEnum types.FooEnum + + QueryEnumList []types.FooEnum + + QueryFloat *float32 QueryInteger *int32 @@ -71,23 +77,17 @@ type AllQueryStringTypesInput struct { QueryLong *int64 - QueryFloat *float32 - - QueryDouble *float64 + QueryShort *int16 - QueryDoubleList []*float64 + QueryString *string - QueryBoolean *bool + QueryStringList []*string - QueryBooleanList []*bool + QueryStringSet []*string QueryTimestamp *time.Time QueryTimestampList []*time.Time - - QueryEnum types.FooEnum - - QueryEnumList []types.FooEnum } type AllQueryStringTypesOutput struct { diff --git a/internal/protocoltest/awsrestjson/api_op_HttpPayloadTraits.go b/internal/protocoltest/awsrestjson/api_op_HttpPayloadTraits.go index c21c59e305c..be43b60470c 100644 --- a/internal/protocoltest/awsrestjson/api_op_HttpPayloadTraits.go +++ b/internal/protocoltest/awsrestjson/api_op_HttpPayloadTraits.go @@ -52,16 +52,16 @@ func (c *Client) HttpPayloadTraits(ctx context.Context, params *HttpPayloadTrait } type HttpPayloadTraitsInput struct { - Foo *string - Blob []byte -} -type HttpPayloadTraitsOutput struct { Foo *string +} +type HttpPayloadTraitsOutput struct { Blob []byte + Foo *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/awsrestjson/api_op_HttpPayloadTraitsWithMediaType.go b/internal/protocoltest/awsrestjson/api_op_HttpPayloadTraitsWithMediaType.go index 099bbba8199..970f976db4a 100644 --- a/internal/protocoltest/awsrestjson/api_op_HttpPayloadTraitsWithMediaType.go +++ b/internal/protocoltest/awsrestjson/api_op_HttpPayloadTraitsWithMediaType.go @@ -52,16 +52,16 @@ func (c *Client) HttpPayloadTraitsWithMediaType(ctx context.Context, params *Htt } type HttpPayloadTraitsWithMediaTypeInput struct { - Foo *string - Blob []byte -} -type HttpPayloadTraitsWithMediaTypeOutput struct { Foo *string +} +type HttpPayloadTraitsWithMediaTypeOutput struct { Blob []byte + Foo *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/awsrestjson/api_op_HttpRequestWithGreedyLabelInPath.go b/internal/protocoltest/awsrestjson/api_op_HttpRequestWithGreedyLabelInPath.go index bbc82a21c99..fb8f8a32848 100644 --- a/internal/protocoltest/awsrestjson/api_op_HttpRequestWithGreedyLabelInPath.go +++ b/internal/protocoltest/awsrestjson/api_op_HttpRequestWithGreedyLabelInPath.go @@ -51,9 +51,9 @@ func (c *Client) HttpRequestWithGreedyLabelInPath(ctx context.Context, params *H } type HttpRequestWithGreedyLabelInPathInput struct { - Foo *string - Baz *string + + Foo *string } type HttpRequestWithGreedyLabelInPathOutput struct { diff --git a/internal/protocoltest/awsrestjson/api_op_HttpRequestWithLabels.go b/internal/protocoltest/awsrestjson/api_op_HttpRequestWithLabels.go index 0cfdf1eb81b..2450bf98581 100644 --- a/internal/protocoltest/awsrestjson/api_op_HttpRequestWithLabels.go +++ b/internal/protocoltest/awsrestjson/api_op_HttpRequestWithLabels.go @@ -54,22 +54,23 @@ func (c *Client) HttpRequestWithLabels(ctx context.Context, params *HttpRequestW } type HttpRequestWithLabelsInput struct { - String_ *string - Short *int16 + // Serialized in the path as true or false. + // + // This member is required. + Boolean *bool + + Double *float64 + + Float *float32 Integer *int32 Long *int64 - Float *float32 - - Double *float64 + Short *int16 - // Serialized in the path as true or false. - // - // This member is required. - Boolean *bool + String_ *string // Note that this member has no format, so it's serialized as an RFC 3399 // date-time. diff --git a/internal/protocoltest/awsrestjson/api_op_HttpRequestWithLabelsAndTimestampFormat.go b/internal/protocoltest/awsrestjson/api_op_HttpRequestWithLabelsAndTimestampFormat.go index 29ecc4b86ce..1f7dbda5e59 100644 --- a/internal/protocoltest/awsrestjson/api_op_HttpRequestWithLabelsAndTimestampFormat.go +++ b/internal/protocoltest/awsrestjson/api_op_HttpRequestWithLabelsAndTimestampFormat.go @@ -54,19 +54,19 @@ func (c *Client) HttpRequestWithLabelsAndTimestampFormat(ctx context.Context, pa } type HttpRequestWithLabelsAndTimestampFormatInput struct { + DefaultFormat *time.Time + + MemberDateTime *time.Time + MemberEpochSeconds *time.Time MemberHttpDate *time.Time - MemberDateTime *time.Time - - DefaultFormat *time.Time + TargetDateTime *time.Time TargetEpochSeconds *time.Time TargetHttpDate *time.Time - - TargetDateTime *time.Time } type HttpRequestWithLabelsAndTimestampFormatOutput struct { diff --git a/internal/protocoltest/awsrestjson/api_op_InlineDocument.go b/internal/protocoltest/awsrestjson/api_op_InlineDocument.go index cc95c80b02b..68bfb06612f 100644 --- a/internal/protocoltest/awsrestjson/api_op_InlineDocument.go +++ b/internal/protocoltest/awsrestjson/api_op_InlineDocument.go @@ -51,16 +51,16 @@ func (c *Client) InlineDocument(ctx context.Context, params *InlineDocumentInput } type InlineDocumentInput struct { - StringValue *string - DocumentValue smithy.Document -} -type InlineDocumentOutput struct { StringValue *string +} +type InlineDocumentOutput struct { DocumentValue smithy.Document + StringValue *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/awsrestjson/api_op_InputAndOutputWithHeaders.go b/internal/protocoltest/awsrestjson/api_op_InputAndOutputWithHeaders.go index 6ec6fcbb79b..de1e0f238a1 100644 --- a/internal/protocoltest/awsrestjson/api_op_InputAndOutputWithHeaders.go +++ b/internal/protocoltest/awsrestjson/api_op_InputAndOutputWithHeaders.go @@ -54,71 +54,71 @@ func (c *Client) InputAndOutputWithHeaders(ctx context.Context, params *InputAnd } type InputAndOutputWithHeadersInput struct { - HeaderString *string + HeaderBooleanList []*bool HeaderByte *int8 - HeaderShort *int16 + HeaderDouble *float64 - HeaderInteger *int32 + HeaderEnum types.FooEnum - HeaderLong *int64 + HeaderEnumList []types.FooEnum + + HeaderFalseBool *bool HeaderFloat *float32 - HeaderDouble *float64 + HeaderInteger *int32 - HeaderTrueBool *bool + HeaderIntegerList []*int32 - HeaderFalseBool *bool + HeaderLong *int64 - HeaderStringList []*string + HeaderShort *int16 - HeaderStringSet []*string + HeaderString *string - HeaderIntegerList []*int32 + HeaderStringList []*string - HeaderBooleanList []*bool + HeaderStringSet []*string HeaderTimestampList []*time.Time - HeaderEnum types.FooEnum - - HeaderEnumList []types.FooEnum + HeaderTrueBool *bool } type InputAndOutputWithHeadersOutput struct { - HeaderString *string + HeaderBooleanList []*bool HeaderByte *int8 - HeaderShort *int16 + HeaderDouble *float64 - HeaderInteger *int32 + HeaderEnum types.FooEnum - HeaderLong *int64 + HeaderEnumList []types.FooEnum + + HeaderFalseBool *bool HeaderFloat *float32 - HeaderDouble *float64 + HeaderInteger *int32 - HeaderTrueBool *bool + HeaderIntegerList []*int32 - HeaderFalseBool *bool + HeaderLong *int64 - HeaderStringList []*string + HeaderShort *int16 - HeaderStringSet []*string + HeaderString *string - HeaderIntegerList []*int32 + HeaderStringList []*string - HeaderBooleanList []*bool + HeaderStringSet []*string HeaderTimestampList []*time.Time - HeaderEnum types.FooEnum - - HeaderEnumList []types.FooEnum + HeaderTrueBool *bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/internal/protocoltest/awsrestjson/api_op_JsonEnums.go b/internal/protocoltest/awsrestjson/api_op_JsonEnums.go index 75974ea3844..2b124ac09bf 100644 --- a/internal/protocoltest/awsrestjson/api_op_JsonEnums.go +++ b/internal/protocoltest/awsrestjson/api_op_JsonEnums.go @@ -60,9 +60,9 @@ type JsonEnumsInput struct { FooEnumList []types.FooEnum - FooEnumSet []types.FooEnum - FooEnumMap map[string]types.FooEnum + + FooEnumSet []types.FooEnum } type JsonEnumsOutput struct { @@ -74,10 +74,10 @@ type JsonEnumsOutput struct { FooEnumList []types.FooEnum - FooEnumSet []types.FooEnum - FooEnumMap map[string]types.FooEnum + FooEnumSet []types.FooEnum + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/awsrestjson/api_op_JsonLists.go b/internal/protocoltest/awsrestjson/api_op_JsonLists.go index b5211526e79..670df36ac14 100644 --- a/internal/protocoltest/awsrestjson/api_op_JsonLists.go +++ b/internal/protocoltest/awsrestjson/api_op_JsonLists.go @@ -63,42 +63,42 @@ func (c *Client) JsonLists(ctx context.Context, params *JsonListsInput, optFns . } type JsonListsInput struct { - StringList []*string - - StringSet []*string - - IntegerList []*int32 - BooleanList []*bool - TimestampList []*time.Time - EnumList []types.FooEnum + IntegerList []*int32 + // A list of lists of strings. NestedStringList [][]*string - StructureList []*types.StructureListMember -} - -type JsonListsOutput struct { StringList []*string StringSet []*string - IntegerList []*int32 - - BooleanList []*bool + StructureList []*types.StructureListMember TimestampList []*time.Time +} + +type JsonListsOutput struct { + BooleanList []*bool EnumList []types.FooEnum + IntegerList []*int32 + // A list of lists of strings. NestedStringList [][]*string + StringList []*string + + StringSet []*string + StructureList []*types.StructureListMember + TimestampList []*time.Time + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/awsrestjson/api_op_JsonTimestamps.go b/internal/protocoltest/awsrestjson/api_op_JsonTimestamps.go index 198aa77cd02..6069ddebc76 100644 --- a/internal/protocoltest/awsrestjson/api_op_JsonTimestamps.go +++ b/internal/protocoltest/awsrestjson/api_op_JsonTimestamps.go @@ -53,24 +53,24 @@ func (c *Client) JsonTimestamps(ctx context.Context, params *JsonTimestampsInput } type JsonTimestampsInput struct { - Normal *time.Time - DateTime *time.Time EpochSeconds *time.Time HttpDate *time.Time -} -type JsonTimestampsOutput struct { Normal *time.Time +} +type JsonTimestampsOutput struct { DateTime *time.Time EpochSeconds *time.Time HttpDate *time.Time + Normal *time.Time + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/awsrestjson/api_op_OmitsNullSerializesEmptyString.go b/internal/protocoltest/awsrestjson/api_op_OmitsNullSerializesEmptyString.go index 253d346fdd0..93dd2ff2206 100644 --- a/internal/protocoltest/awsrestjson/api_op_OmitsNullSerializesEmptyString.go +++ b/internal/protocoltest/awsrestjson/api_op_OmitsNullSerializesEmptyString.go @@ -51,9 +51,9 @@ func (c *Client) OmitsNullSerializesEmptyString(ctx context.Context, params *Omi } type OmitsNullSerializesEmptyStringInput struct { - NullValue *string - EmptyString *string + + NullValue *string } type OmitsNullSerializesEmptyStringOutput struct { diff --git a/internal/protocoltest/awsrestjson/api_op_SimpleScalarProperties.go b/internal/protocoltest/awsrestjson/api_op_SimpleScalarProperties.go index 68cd8d288d1..3305176c847 100644 --- a/internal/protocoltest/awsrestjson/api_op_SimpleScalarProperties.go +++ b/internal/protocoltest/awsrestjson/api_op_SimpleScalarProperties.go @@ -50,47 +50,47 @@ func (c *Client) SimpleScalarProperties(ctx context.Context, params *SimpleScala } type SimpleScalarPropertiesInput struct { - Foo *string - - StringValue *string + ByteValue *int8 - TrueBooleanValue *bool + DoubleValue *float64 FalseBooleanValue *bool - ByteValue *int8 + FloatValue *float32 - ShortValue *int16 + Foo *string IntegerValue *int32 LongValue *int64 - FloatValue *float32 + ShortValue *int16 - DoubleValue *float64 + StringValue *string + + TrueBooleanValue *bool } type SimpleScalarPropertiesOutput struct { - Foo *string - - StringValue *string + ByteValue *int8 - TrueBooleanValue *bool + DoubleValue *float64 FalseBooleanValue *bool - ByteValue *int8 + FloatValue *float32 - ShortValue *int16 + Foo *string IntegerValue *int32 LongValue *int64 - FloatValue *float32 + ShortValue *int16 - DoubleValue *float64 + StringValue *string + + TrueBooleanValue *bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/internal/protocoltest/awsrestjson/api_op_StreamingTraits.go b/internal/protocoltest/awsrestjson/api_op_StreamingTraits.go index cc7818ebb1c..a8bba904d2d 100644 --- a/internal/protocoltest/awsrestjson/api_op_StreamingTraits.go +++ b/internal/protocoltest/awsrestjson/api_op_StreamingTraits.go @@ -53,16 +53,16 @@ func (c *Client) StreamingTraits(ctx context.Context, params *StreamingTraitsInp } type StreamingTraitsInput struct { - Foo *string - Blob io.Reader -} -type StreamingTraitsOutput struct { Foo *string +} +type StreamingTraitsOutput struct { Blob io.ReadCloser + Foo *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/awsrestjson/api_op_StreamingTraitsRequireLength.go b/internal/protocoltest/awsrestjson/api_op_StreamingTraitsRequireLength.go index db8fd90e504..c7d644cb182 100644 --- a/internal/protocoltest/awsrestjson/api_op_StreamingTraitsRequireLength.go +++ b/internal/protocoltest/awsrestjson/api_op_StreamingTraitsRequireLength.go @@ -53,16 +53,16 @@ func (c *Client) StreamingTraitsRequireLength(ctx context.Context, params *Strea } type StreamingTraitsRequireLengthInput struct { - Foo *string - Blob io.Reader -} -type StreamingTraitsRequireLengthOutput struct { Foo *string +} +type StreamingTraitsRequireLengthOutput struct { Blob io.ReadCloser + Foo *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/awsrestjson/api_op_StreamingTraitsWithMediaType.go b/internal/protocoltest/awsrestjson/api_op_StreamingTraitsWithMediaType.go index 173c3db4492..561aa20076d 100644 --- a/internal/protocoltest/awsrestjson/api_op_StreamingTraitsWithMediaType.go +++ b/internal/protocoltest/awsrestjson/api_op_StreamingTraitsWithMediaType.go @@ -53,16 +53,16 @@ func (c *Client) StreamingTraitsWithMediaType(ctx context.Context, params *Strea } type StreamingTraitsWithMediaTypeInput struct { - Foo *string - Blob io.Reader -} -type StreamingTraitsWithMediaTypeOutput struct { Foo *string +} +type StreamingTraitsWithMediaTypeOutput struct { Blob io.ReadCloser + Foo *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/awsrestjson/api_op_TimestampFormatHeaders.go b/internal/protocoltest/awsrestjson/api_op_TimestampFormatHeaders.go index e2b9aa88f32..69e151849fb 100644 --- a/internal/protocoltest/awsrestjson/api_op_TimestampFormatHeaders.go +++ b/internal/protocoltest/awsrestjson/api_op_TimestampFormatHeaders.go @@ -52,36 +52,36 @@ func (c *Client) TimestampFormatHeaders(ctx context.Context, params *TimestampFo } type TimestampFormatHeadersInput struct { + DefaultFormat *time.Time + + MemberDateTime *time.Time + MemberEpochSeconds *time.Time MemberHttpDate *time.Time - MemberDateTime *time.Time - - DefaultFormat *time.Time + TargetDateTime *time.Time TargetEpochSeconds *time.Time TargetHttpDate *time.Time - - TargetDateTime *time.Time } type TimestampFormatHeadersOutput struct { + DefaultFormat *time.Time + + MemberDateTime *time.Time + MemberEpochSeconds *time.Time MemberHttpDate *time.Time - MemberDateTime *time.Time - - DefaultFormat *time.Time + TargetDateTime *time.Time TargetEpochSeconds *time.Time TargetHttpDate *time.Time - TargetDateTime *time.Time - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/awsrestjson/go.mod b/internal/protocoltest/awsrestjson/go.mod index 55b6485c423..4f78e88c18d 100644 --- a/internal/protocoltest/awsrestjson/go.mod +++ b/internal/protocoltest/awsrestjson/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/internal/protocoltest/awsrestjson go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 github.com/google/go-cmp v0.4.1 ) diff --git a/internal/protocoltest/ec2query/api_op_QueryLists.go b/internal/protocoltest/ec2query/api_op_QueryLists.go index aef811717de..7a0cbadf3a9 100644 --- a/internal/protocoltest/ec2query/api_op_QueryLists.go +++ b/internal/protocoltest/ec2query/api_op_QueryLists.go @@ -52,13 +52,13 @@ func (c *Client) QueryLists(ctx context.Context, params *QueryListsInput, optFns } type QueryListsInput struct { - ListArg []*string - ComplexListArg []*types.GreetingStruct - ListArgWithXmlNameMember []*string + ListArg []*string ListArgWithXmlName []*string + + ListArgWithXmlNameMember []*string } type QueryListsOutput struct { diff --git a/internal/protocoltest/ec2query/api_op_QueryTimestamps.go b/internal/protocoltest/ec2query/api_op_QueryTimestamps.go index 5225b43d7ae..f93b7992c33 100644 --- a/internal/protocoltest/ec2query/api_op_QueryTimestamps.go +++ b/internal/protocoltest/ec2query/api_op_QueryTimestamps.go @@ -61,11 +61,11 @@ func (c *Client) QueryTimestamps(ctx context.Context, params *QueryTimestampsInp } type QueryTimestampsInput struct { - NormalFormat *time.Time - EpochMember *time.Time EpochTarget *time.Time + + NormalFormat *time.Time } type QueryTimestampsOutput struct { diff --git a/internal/protocoltest/ec2query/api_op_SimpleInputParams.go b/internal/protocoltest/ec2query/api_op_SimpleInputParams.go index 37b7abc2143..942f5480af0 100644 --- a/internal/protocoltest/ec2query/api_op_SimpleInputParams.go +++ b/internal/protocoltest/ec2query/api_op_SimpleInputParams.go @@ -52,23 +52,23 @@ func (c *Client) SimpleInputParams(ctx context.Context, params *SimpleInputParam } type SimpleInputParamsInput struct { - Foo *string + Bam *int32 Bar *string Baz *bool - Bam *int32 - Boo *float64 - Qux []byte + Foo *string FooEnum types.FooEnum + HasQueryAndXmlName *string + HasQueryName *string - HasQueryAndXmlName *string + Qux []byte UsesXmlName *string } diff --git a/internal/protocoltest/ec2query/api_op_SimpleScalarXmlProperties.go b/internal/protocoltest/ec2query/api_op_SimpleScalarXmlProperties.go index f03ab96ef0c..2f9a667b665 100644 --- a/internal/protocoltest/ec2query/api_op_SimpleScalarXmlProperties.go +++ b/internal/protocoltest/ec2query/api_op_SimpleScalarXmlProperties.go @@ -53,25 +53,25 @@ type SimpleScalarXmlPropertiesInput struct { } type SimpleScalarXmlPropertiesOutput struct { - StringValue *string + ByteValue *int8 - EmptyStringValue *string + DoubleValue *float64 - TrueBooleanValue *bool + EmptyStringValue *string FalseBooleanValue *bool - ByteValue *int8 - - ShortValue *int16 + FloatValue *float32 IntegerValue *int32 LongValue *int64 - FloatValue *float32 + ShortValue *int16 - DoubleValue *float64 + StringValue *string + + TrueBooleanValue *bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/internal/protocoltest/ec2query/api_op_XmlEmptyLists.go b/internal/protocoltest/ec2query/api_op_XmlEmptyLists.go index a0eedad10a6..9b1a238c103 100644 --- a/internal/protocoltest/ec2query/api_op_XmlEmptyLists.go +++ b/internal/protocoltest/ec2query/api_op_XmlEmptyLists.go @@ -55,29 +55,29 @@ type XmlEmptyListsInput struct { } type XmlEmptyListsOutput struct { - StringList []*string - - StringSet []*string + BooleanList []*bool - IntegerList []*int32 + EnumList []types.FooEnum - BooleanList []*bool + FlattenedList []*string - TimestampList []*time.Time + FlattenedList2 []*string - EnumList []types.FooEnum + IntegerList []*int32 // A list of lists of strings. NestedStringList [][]*string RenamedListMembers []*string - FlattenedList []*string + StringList []*string - FlattenedList2 []*string + StringSet []*string StructureList []*types.StructureListMember + TimestampList []*time.Time + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/ec2query/api_op_XmlEnums.go b/internal/protocoltest/ec2query/api_op_XmlEnums.go index 4ba7304bd72..c8e0bf0b7c2 100644 --- a/internal/protocoltest/ec2query/api_op_XmlEnums.go +++ b/internal/protocoltest/ec2query/api_op_XmlEnums.go @@ -63,10 +63,10 @@ type XmlEnumsOutput struct { FooEnumList []types.FooEnum - FooEnumSet []types.FooEnum - FooEnumMap map[string]types.FooEnum + FooEnumSet []types.FooEnum + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/ec2query/api_op_XmlLists.go b/internal/protocoltest/ec2query/api_op_XmlLists.go index 7abb10fe006..a2c982b3945 100644 --- a/internal/protocoltest/ec2query/api_op_XmlLists.go +++ b/internal/protocoltest/ec2query/api_op_XmlLists.go @@ -73,29 +73,29 @@ type XmlListsInput struct { } type XmlListsOutput struct { - StringList []*string - - StringSet []*string + BooleanList []*bool - IntegerList []*int32 + EnumList []types.FooEnum - BooleanList []*bool + FlattenedList []*string - TimestampList []*time.Time + FlattenedList2 []*string - EnumList []types.FooEnum + IntegerList []*int32 // A list of lists of strings. NestedStringList [][]*string RenamedListMembers []*string - FlattenedList []*string + StringList []*string - FlattenedList2 []*string + StringSet []*string StructureList []*types.StructureListMember + TimestampList []*time.Time + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/ec2query/api_op_XmlTimestamps.go b/internal/protocoltest/ec2query/api_op_XmlTimestamps.go index d1f148a0348..fb052cfeeff 100644 --- a/internal/protocoltest/ec2query/api_op_XmlTimestamps.go +++ b/internal/protocoltest/ec2query/api_op_XmlTimestamps.go @@ -56,14 +56,14 @@ type XmlTimestampsInput struct { } type XmlTimestampsOutput struct { - Normal *time.Time - DateTime *time.Time EpochSeconds *time.Time HttpDate *time.Time + Normal *time.Time + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/ec2query/go.mod b/internal/protocoltest/ec2query/go.mod index c60d394711e..dd63b6f1167 100644 --- a/internal/protocoltest/ec2query/go.mod +++ b/internal/protocoltest/ec2query/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/internal/protocoltest/ec2query go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 github.com/google/go-cmp v0.4.1 ) diff --git a/internal/protocoltest/ec2query/types/types.go b/internal/protocoltest/ec2query/types/types.go index d1680595383..9f0b8aa8bec 100644 --- a/internal/protocoltest/ec2query/types/types.go +++ b/internal/protocoltest/ec2query/types/types.go @@ -19,11 +19,11 @@ type RecursiveXmlShapesOutputNested2 struct { } type StructArg struct { - StringArg *string - OtherArg *bool RecursiveArg *StructArg + + StringArg *string } type StructureListMember struct { diff --git a/internal/protocoltest/jsonrpc/api_op_JsonEnums.go b/internal/protocoltest/jsonrpc/api_op_JsonEnums.go index 2191cb6cbfb..006fea037be 100644 --- a/internal/protocoltest/jsonrpc/api_op_JsonEnums.go +++ b/internal/protocoltest/jsonrpc/api_op_JsonEnums.go @@ -63,9 +63,9 @@ type JsonEnumsInput struct { FooEnumList []types.FooEnum - FooEnumSet []types.FooEnum - FooEnumMap map[string]types.FooEnum + + FooEnumSet []types.FooEnum } type JsonEnumsOutput struct { @@ -77,10 +77,10 @@ type JsonEnumsOutput struct { FooEnumList []types.FooEnum - FooEnumSet []types.FooEnum - FooEnumMap map[string]types.FooEnum + FooEnumSet []types.FooEnum + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/jsonrpc/api_op_NullOperation.go b/internal/protocoltest/jsonrpc/api_op_NullOperation.go index 247df53b6cd..32953317768 100644 --- a/internal/protocoltest/jsonrpc/api_op_NullOperation.go +++ b/internal/protocoltest/jsonrpc/api_op_NullOperation.go @@ -53,20 +53,20 @@ func (c *Client) NullOperation(ctx context.Context, params *NullOperationInput, } type NullOperationInput struct { - String_ *string - StringList []*string StringMap map[string]*string -} -type NullOperationOutput struct { String_ *string +} +type NullOperationOutput struct { StringList []*string StringMap map[string]*string + String_ *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/jsonrpc/go.mod b/internal/protocoltest/jsonrpc/go.mod index 0677ebf2411..2d1adbb15e8 100644 --- a/internal/protocoltest/jsonrpc/go.mod +++ b/internal/protocoltest/jsonrpc/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/internal/protocoltest/jsonrpc go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 github.com/google/go-cmp v0.4.1 ) diff --git a/internal/protocoltest/jsonrpc10/go.mod b/internal/protocoltest/jsonrpc10/go.mod index 91d17dea7b2..5842a7468ac 100644 --- a/internal/protocoltest/jsonrpc10/go.mod +++ b/internal/protocoltest/jsonrpc10/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/internal/protocoltest/jsonrpc10 go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 github.com/google/go-cmp v0.4.1 ) diff --git a/internal/protocoltest/query/api_op_QueryLists.go b/internal/protocoltest/query/api_op_QueryLists.go index b23b058d48c..9ada648b388 100644 --- a/internal/protocoltest/query/api_op_QueryLists.go +++ b/internal/protocoltest/query/api_op_QueryLists.go @@ -52,15 +52,15 @@ func (c *Client) QueryLists(ctx context.Context, params *QueryListsInput, optFns } type QueryListsInput struct { - ListArg []*string - ComplexListArg []*types.GreetingStruct FlattenedListArg []*string - ListArgWithXmlNameMember []*string - FlattenedListArgWithXmlName []*string + + ListArg []*string + + ListArgWithXmlNameMember []*string } type QueryListsOutput struct { diff --git a/internal/protocoltest/query/api_op_QueryMaps.go b/internal/protocoltest/query/api_op_QueryMaps.go index 1c0d68d2355..1d571966215 100644 --- a/internal/protocoltest/query/api_op_QueryMaps.go +++ b/internal/protocoltest/query/api_op_QueryMaps.go @@ -52,19 +52,19 @@ func (c *Client) QueryMaps(ctx context.Context, params *QueryMapsInput, optFns . } type QueryMapsInput struct { - MapArg map[string]*string - - RenamedMapArg map[string]*string - ComplexMapArg map[string]*types.GreetingStruct - MapWithXmlMemberName map[string]*string - FlattenedMap map[string]*string FlattenedMapWithXmlName map[string]*string + MapArg map[string]*string + MapOfLists map[string][]*string + + MapWithXmlMemberName map[string]*string + + RenamedMapArg map[string]*string } type QueryMapsOutput struct { diff --git a/internal/protocoltest/query/api_op_QueryTimestamps.go b/internal/protocoltest/query/api_op_QueryTimestamps.go index de3d1f205ca..4ffb9770427 100644 --- a/internal/protocoltest/query/api_op_QueryTimestamps.go +++ b/internal/protocoltest/query/api_op_QueryTimestamps.go @@ -61,11 +61,11 @@ func (c *Client) QueryTimestamps(ctx context.Context, params *QueryTimestampsInp } type QueryTimestampsInput struct { - NormalFormat *time.Time - EpochMember *time.Time EpochTarget *time.Time + + NormalFormat *time.Time } type QueryTimestampsOutput struct { diff --git a/internal/protocoltest/query/api_op_SimpleInputParams.go b/internal/protocoltest/query/api_op_SimpleInputParams.go index 11acf46c9da..fd565c1efa7 100644 --- a/internal/protocoltest/query/api_op_SimpleInputParams.go +++ b/internal/protocoltest/query/api_op_SimpleInputParams.go @@ -52,19 +52,19 @@ func (c *Client) SimpleInputParams(ctx context.Context, params *SimpleInputParam } type SimpleInputParamsInput struct { - Foo *string + Bam *int32 Bar *string Baz *bool - Bam *int32 - Boo *float64 - Qux []byte + Foo *string FooEnum types.FooEnum + + Qux []byte } type SimpleInputParamsOutput struct { diff --git a/internal/protocoltest/query/api_op_SimpleScalarXmlProperties.go b/internal/protocoltest/query/api_op_SimpleScalarXmlProperties.go index 47e30c60541..59bcbe84d85 100644 --- a/internal/protocoltest/query/api_op_SimpleScalarXmlProperties.go +++ b/internal/protocoltest/query/api_op_SimpleScalarXmlProperties.go @@ -53,25 +53,25 @@ type SimpleScalarXmlPropertiesInput struct { } type SimpleScalarXmlPropertiesOutput struct { - StringValue *string + ByteValue *int8 - EmptyStringValue *string + DoubleValue *float64 - TrueBooleanValue *bool + EmptyStringValue *string FalseBooleanValue *bool - ByteValue *int8 - - ShortValue *int16 + FloatValue *float32 IntegerValue *int32 LongValue *int64 - FloatValue *float32 + ShortValue *int16 - DoubleValue *float64 + StringValue *string + + TrueBooleanValue *bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/internal/protocoltest/query/api_op_XmlEmptyLists.go b/internal/protocoltest/query/api_op_XmlEmptyLists.go index 68d862ba8ae..41ae2a92457 100644 --- a/internal/protocoltest/query/api_op_XmlEmptyLists.go +++ b/internal/protocoltest/query/api_op_XmlEmptyLists.go @@ -55,29 +55,29 @@ type XmlEmptyListsInput struct { } type XmlEmptyListsOutput struct { - StringList []*string - - StringSet []*string + BooleanList []*bool - IntegerList []*int32 + EnumList []types.FooEnum - BooleanList []*bool + FlattenedList []*string - TimestampList []*time.Time + FlattenedList2 []*string - EnumList []types.FooEnum + IntegerList []*int32 // A list of lists of strings. NestedStringList [][]*string RenamedListMembers []*string - FlattenedList []*string + StringList []*string - FlattenedList2 []*string + StringSet []*string StructureList []*types.StructureListMember + TimestampList []*time.Time + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/query/api_op_XmlEnums.go b/internal/protocoltest/query/api_op_XmlEnums.go index 16213532ac2..2571560e20b 100644 --- a/internal/protocoltest/query/api_op_XmlEnums.go +++ b/internal/protocoltest/query/api_op_XmlEnums.go @@ -63,10 +63,10 @@ type XmlEnumsOutput struct { FooEnumList []types.FooEnum - FooEnumSet []types.FooEnum - FooEnumMap map[string]types.FooEnum + FooEnumSet []types.FooEnum + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/query/api_op_XmlLists.go b/internal/protocoltest/query/api_op_XmlLists.go index d64761e7e27..17ec2222370 100644 --- a/internal/protocoltest/query/api_op_XmlLists.go +++ b/internal/protocoltest/query/api_op_XmlLists.go @@ -73,29 +73,29 @@ type XmlListsInput struct { } type XmlListsOutput struct { - StringList []*string - - StringSet []*string + BooleanList []*bool - IntegerList []*int32 + EnumList []types.FooEnum - BooleanList []*bool + FlattenedList []*string - TimestampList []*time.Time + FlattenedList2 []*string - EnumList []types.FooEnum + IntegerList []*int32 // A list of lists of strings. NestedStringList [][]*string RenamedListMembers []*string - FlattenedList []*string + StringList []*string - FlattenedList2 []*string + StringSet []*string StructureList []*types.StructureListMember + TimestampList []*time.Time + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/query/api_op_XmlTimestamps.go b/internal/protocoltest/query/api_op_XmlTimestamps.go index 154cea48c88..33935350573 100644 --- a/internal/protocoltest/query/api_op_XmlTimestamps.go +++ b/internal/protocoltest/query/api_op_XmlTimestamps.go @@ -56,14 +56,14 @@ type XmlTimestampsInput struct { } type XmlTimestampsOutput struct { - Normal *time.Time - DateTime *time.Time EpochSeconds *time.Time HttpDate *time.Time + Normal *time.Time + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/query/go.mod b/internal/protocoltest/query/go.mod index 3fcacafbf63..302ac30f331 100644 --- a/internal/protocoltest/query/go.mod +++ b/internal/protocoltest/query/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/internal/protocoltest/query go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 github.com/google/go-cmp v0.4.1 ) diff --git a/internal/protocoltest/query/types/types.go b/internal/protocoltest/query/types/types.go index d1680595383..9f0b8aa8bec 100644 --- a/internal/protocoltest/query/types/types.go +++ b/internal/protocoltest/query/types/types.go @@ -19,11 +19,11 @@ type RecursiveXmlShapesOutputNested2 struct { } type StructArg struct { - StringArg *string - OtherArg *bool RecursiveArg *StructArg + + StringArg *string } type StructureListMember struct { diff --git a/internal/protocoltest/restxml/api_op_AllQueryStringTypes.go b/internal/protocoltest/restxml/api_op_AllQueryStringTypes.go index 21476ccd253..c59cedd2059 100644 --- a/internal/protocoltest/restxml/api_op_AllQueryStringTypes.go +++ b/internal/protocoltest/restxml/api_op_AllQueryStringTypes.go @@ -53,15 +53,21 @@ func (c *Client) AllQueryStringTypes(ctx context.Context, params *AllQueryString } type AllQueryStringTypesInput struct { - QueryString *string - - QueryStringList []*string + QueryBoolean *bool - QueryStringSet []*string + QueryBooleanList []*bool QueryByte *int8 - QueryShort *int16 + QueryDouble *float64 + + QueryDoubleList []*float64 + + QueryEnum types.FooEnum + + QueryEnumList []types.FooEnum + + QueryFloat *float32 QueryInteger *int32 @@ -71,23 +77,17 @@ type AllQueryStringTypesInput struct { QueryLong *int64 - QueryFloat *float32 - - QueryDouble *float64 + QueryShort *int16 - QueryDoubleList []*float64 + QueryString *string - QueryBoolean *bool + QueryStringList []*string - QueryBooleanList []*bool + QueryStringSet []*string QueryTimestamp *time.Time QueryTimestampList []*time.Time - - QueryEnum types.FooEnum - - QueryEnumList []types.FooEnum } type AllQueryStringTypesOutput struct { diff --git a/internal/protocoltest/restxml/api_op_HttpPayloadTraits.go b/internal/protocoltest/restxml/api_op_HttpPayloadTraits.go index 283d145f5fb..3635fe31f1a 100644 --- a/internal/protocoltest/restxml/api_op_HttpPayloadTraits.go +++ b/internal/protocoltest/restxml/api_op_HttpPayloadTraits.go @@ -52,16 +52,16 @@ func (c *Client) HttpPayloadTraits(ctx context.Context, params *HttpPayloadTrait } type HttpPayloadTraitsInput struct { - Foo *string - Blob []byte -} -type HttpPayloadTraitsOutput struct { Foo *string +} +type HttpPayloadTraitsOutput struct { Blob []byte + Foo *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/restxml/api_op_HttpPayloadTraitsWithMediaType.go b/internal/protocoltest/restxml/api_op_HttpPayloadTraitsWithMediaType.go index fa9f4977dc6..bb58ddbc7b3 100644 --- a/internal/protocoltest/restxml/api_op_HttpPayloadTraitsWithMediaType.go +++ b/internal/protocoltest/restxml/api_op_HttpPayloadTraitsWithMediaType.go @@ -52,16 +52,16 @@ func (c *Client) HttpPayloadTraitsWithMediaType(ctx context.Context, params *Htt } type HttpPayloadTraitsWithMediaTypeInput struct { - Foo *string - Blob []byte -} -type HttpPayloadTraitsWithMediaTypeOutput struct { Foo *string +} +type HttpPayloadTraitsWithMediaTypeOutput struct { Blob []byte + Foo *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/restxml/api_op_HttpRequestWithGreedyLabelInPath.go b/internal/protocoltest/restxml/api_op_HttpRequestWithGreedyLabelInPath.go index 24e613d69f7..781ea13ebe0 100644 --- a/internal/protocoltest/restxml/api_op_HttpRequestWithGreedyLabelInPath.go +++ b/internal/protocoltest/restxml/api_op_HttpRequestWithGreedyLabelInPath.go @@ -51,9 +51,9 @@ func (c *Client) HttpRequestWithGreedyLabelInPath(ctx context.Context, params *H } type HttpRequestWithGreedyLabelInPathInput struct { - Foo *string - Baz *string + + Foo *string } type HttpRequestWithGreedyLabelInPathOutput struct { diff --git a/internal/protocoltest/restxml/api_op_HttpRequestWithLabels.go b/internal/protocoltest/restxml/api_op_HttpRequestWithLabels.go index 2d2529155e6..022f1a33176 100644 --- a/internal/protocoltest/restxml/api_op_HttpRequestWithLabels.go +++ b/internal/protocoltest/restxml/api_op_HttpRequestWithLabels.go @@ -54,22 +54,23 @@ func (c *Client) HttpRequestWithLabels(ctx context.Context, params *HttpRequestW } type HttpRequestWithLabelsInput struct { - String_ *string - Short *int16 + // Serialized in the path as true or false. + // + // This member is required. + Boolean *bool + + Double *float64 + + Float *float32 Integer *int32 Long *int64 - Float *float32 - - Double *float64 + Short *int16 - // Serialized in the path as true or false. - // - // This member is required. - Boolean *bool + String_ *string // Note that this member has no format, so it's serialized as an RFC 3399 // date-time. diff --git a/internal/protocoltest/restxml/api_op_HttpRequestWithLabelsAndTimestampFormat.go b/internal/protocoltest/restxml/api_op_HttpRequestWithLabelsAndTimestampFormat.go index 9f445b66f56..33a2e6a6f4c 100644 --- a/internal/protocoltest/restxml/api_op_HttpRequestWithLabelsAndTimestampFormat.go +++ b/internal/protocoltest/restxml/api_op_HttpRequestWithLabelsAndTimestampFormat.go @@ -54,19 +54,19 @@ func (c *Client) HttpRequestWithLabelsAndTimestampFormat(ctx context.Context, pa } type HttpRequestWithLabelsAndTimestampFormatInput struct { + DefaultFormat *time.Time + + MemberDateTime *time.Time + MemberEpochSeconds *time.Time MemberHttpDate *time.Time - MemberDateTime *time.Time - - DefaultFormat *time.Time + TargetDateTime *time.Time TargetEpochSeconds *time.Time TargetHttpDate *time.Time - - TargetDateTime *time.Time } type HttpRequestWithLabelsAndTimestampFormatOutput struct { diff --git a/internal/protocoltest/restxml/api_op_InputAndOutputWithHeaders.go b/internal/protocoltest/restxml/api_op_InputAndOutputWithHeaders.go index 841a38408dc..f21f4126b4a 100644 --- a/internal/protocoltest/restxml/api_op_InputAndOutputWithHeaders.go +++ b/internal/protocoltest/restxml/api_op_InputAndOutputWithHeaders.go @@ -54,71 +54,71 @@ func (c *Client) InputAndOutputWithHeaders(ctx context.Context, params *InputAnd } type InputAndOutputWithHeadersInput struct { - HeaderString *string + HeaderBooleanList []*bool HeaderByte *int8 - HeaderShort *int16 + HeaderDouble *float64 - HeaderInteger *int32 + HeaderEnum types.FooEnum - HeaderLong *int64 + HeaderEnumList []types.FooEnum + + HeaderFalseBool *bool HeaderFloat *float32 - HeaderDouble *float64 + HeaderInteger *int32 - HeaderTrueBool *bool + HeaderIntegerList []*int32 - HeaderFalseBool *bool + HeaderLong *int64 - HeaderStringList []*string + HeaderShort *int16 - HeaderStringSet []*string + HeaderString *string - HeaderIntegerList []*int32 + HeaderStringList []*string - HeaderBooleanList []*bool + HeaderStringSet []*string HeaderTimestampList []*time.Time - HeaderEnum types.FooEnum - - HeaderEnumList []types.FooEnum + HeaderTrueBool *bool } type InputAndOutputWithHeadersOutput struct { - HeaderString *string + HeaderBooleanList []*bool HeaderByte *int8 - HeaderShort *int16 + HeaderDouble *float64 - HeaderInteger *int32 + HeaderEnum types.FooEnum - HeaderLong *int64 + HeaderEnumList []types.FooEnum + + HeaderFalseBool *bool HeaderFloat *float32 - HeaderDouble *float64 + HeaderInteger *int32 - HeaderTrueBool *bool + HeaderIntegerList []*int32 - HeaderFalseBool *bool + HeaderLong *int64 - HeaderStringList []*string + HeaderShort *int16 - HeaderStringSet []*string + HeaderString *string - HeaderIntegerList []*int32 + HeaderStringList []*string - HeaderBooleanList []*bool + HeaderStringSet []*string HeaderTimestampList []*time.Time - HeaderEnum types.FooEnum - - HeaderEnumList []types.FooEnum + HeaderTrueBool *bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/internal/protocoltest/restxml/api_op_OmitsNullSerializesEmptyString.go b/internal/protocoltest/restxml/api_op_OmitsNullSerializesEmptyString.go index 51d3159e645..df78d99ce49 100644 --- a/internal/protocoltest/restxml/api_op_OmitsNullSerializesEmptyString.go +++ b/internal/protocoltest/restxml/api_op_OmitsNullSerializesEmptyString.go @@ -51,9 +51,9 @@ func (c *Client) OmitsNullSerializesEmptyString(ctx context.Context, params *Omi } type OmitsNullSerializesEmptyStringInput struct { - NullValue *string - EmptyString *string + + NullValue *string } type OmitsNullSerializesEmptyStringOutput struct { diff --git a/internal/protocoltest/restxml/api_op_SimpleScalarProperties.go b/internal/protocoltest/restxml/api_op_SimpleScalarProperties.go index 710e6a89580..8f5d0225920 100644 --- a/internal/protocoltest/restxml/api_op_SimpleScalarProperties.go +++ b/internal/protocoltest/restxml/api_op_SimpleScalarProperties.go @@ -50,47 +50,47 @@ func (c *Client) SimpleScalarProperties(ctx context.Context, params *SimpleScala } type SimpleScalarPropertiesInput struct { - Foo *string - - StringValue *string + ByteValue *int8 - TrueBooleanValue *bool + DoubleValue *float64 FalseBooleanValue *bool - ByteValue *int8 + FloatValue *float32 - ShortValue *int16 + Foo *string IntegerValue *int32 LongValue *int64 - FloatValue *float32 + ShortValue *int16 - DoubleValue *float64 + StringValue *string + + TrueBooleanValue *bool } type SimpleScalarPropertiesOutput struct { - Foo *string - - StringValue *string + ByteValue *int8 - TrueBooleanValue *bool + DoubleValue *float64 FalseBooleanValue *bool - ByteValue *int8 + FloatValue *float32 - ShortValue *int16 + Foo *string IntegerValue *int32 LongValue *int64 - FloatValue *float32 + ShortValue *int16 - DoubleValue *float64 + StringValue *string + + TrueBooleanValue *bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/internal/protocoltest/restxml/api_op_TimestampFormatHeaders.go b/internal/protocoltest/restxml/api_op_TimestampFormatHeaders.go index 3958cb24b15..2fe14e5a746 100644 --- a/internal/protocoltest/restxml/api_op_TimestampFormatHeaders.go +++ b/internal/protocoltest/restxml/api_op_TimestampFormatHeaders.go @@ -52,36 +52,36 @@ func (c *Client) TimestampFormatHeaders(ctx context.Context, params *TimestampFo } type TimestampFormatHeadersInput struct { + DefaultFormat *time.Time + + MemberDateTime *time.Time + MemberEpochSeconds *time.Time MemberHttpDate *time.Time - MemberDateTime *time.Time - - DefaultFormat *time.Time + TargetDateTime *time.Time TargetEpochSeconds *time.Time TargetHttpDate *time.Time - - TargetDateTime *time.Time } type TimestampFormatHeadersOutput struct { + DefaultFormat *time.Time + + MemberDateTime *time.Time + MemberEpochSeconds *time.Time MemberHttpDate *time.Time - MemberDateTime *time.Time - - DefaultFormat *time.Time + TargetDateTime *time.Time TargetEpochSeconds *time.Time TargetHttpDate *time.Time - TargetDateTime *time.Time - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/restxml/api_op_XmlAttributes.go b/internal/protocoltest/restxml/api_op_XmlAttributes.go index eada483ef0f..8a9498b52de 100644 --- a/internal/protocoltest/restxml/api_op_XmlAttributes.go +++ b/internal/protocoltest/restxml/api_op_XmlAttributes.go @@ -51,16 +51,16 @@ func (c *Client) XmlAttributes(ctx context.Context, params *XmlAttributesInput, } type XmlAttributesInput struct { - Foo *string - Attr *string -} -type XmlAttributesOutput struct { Foo *string +} +type XmlAttributesOutput struct { Attr *string + Foo *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/restxml/api_op_XmlEmptyLists.go b/internal/protocoltest/restxml/api_op_XmlEmptyLists.go index 3e49f2c5082..c07516fde70 100644 --- a/internal/protocoltest/restxml/api_op_XmlEmptyLists.go +++ b/internal/protocoltest/restxml/api_op_XmlEmptyLists.go @@ -52,54 +52,54 @@ func (c *Client) XmlEmptyLists(ctx context.Context, params *XmlEmptyListsInput, } type XmlEmptyListsInput struct { - StringList []*string - - StringSet []*string + BooleanList []*bool - IntegerList []*int32 + EnumList []types.FooEnum - BooleanList []*bool + FlattenedList []*string - TimestampList []*time.Time + FlattenedList2 []*string - EnumList []types.FooEnum + IntegerList []*int32 // A list of lists of strings. NestedStringList [][]*string RenamedListMembers []*string - FlattenedList []*string + StringList []*string - FlattenedList2 []*string + StringSet []*string StructureList []*types.StructureListMember + + TimestampList []*time.Time } type XmlEmptyListsOutput struct { - StringList []*string - - StringSet []*string + BooleanList []*bool - IntegerList []*int32 + EnumList []types.FooEnum - BooleanList []*bool + FlattenedList []*string - TimestampList []*time.Time + FlattenedList2 []*string - EnumList []types.FooEnum + IntegerList []*int32 // A list of lists of strings. NestedStringList [][]*string RenamedListMembers []*string - FlattenedList []*string + StringList []*string - FlattenedList2 []*string + StringSet []*string StructureList []*types.StructureListMember + TimestampList []*time.Time + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/restxml/api_op_XmlEnums.go b/internal/protocoltest/restxml/api_op_XmlEnums.go index 826cc24d201..00b5cef123d 100644 --- a/internal/protocoltest/restxml/api_op_XmlEnums.go +++ b/internal/protocoltest/restxml/api_op_XmlEnums.go @@ -60,9 +60,9 @@ type XmlEnumsInput struct { FooEnumList []types.FooEnum - FooEnumSet []types.FooEnum - FooEnumMap map[string]types.FooEnum + + FooEnumSet []types.FooEnum } type XmlEnumsOutput struct { @@ -74,10 +74,10 @@ type XmlEnumsOutput struct { FooEnumList []types.FooEnum - FooEnumSet []types.FooEnum - FooEnumMap map[string]types.FooEnum + FooEnumSet []types.FooEnum + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/restxml/api_op_XmlLists.go b/internal/protocoltest/restxml/api_op_XmlLists.go index 772d5d8f350..bfbf3985941 100644 --- a/internal/protocoltest/restxml/api_op_XmlLists.go +++ b/internal/protocoltest/restxml/api_op_XmlLists.go @@ -70,54 +70,54 @@ func (c *Client) XmlLists(ctx context.Context, params *XmlListsInput, optFns ... } type XmlListsInput struct { - StringList []*string - - StringSet []*string + BooleanList []*bool - IntegerList []*int32 + EnumList []types.FooEnum - BooleanList []*bool + FlattenedList []*string - TimestampList []*time.Time + FlattenedList2 []*string - EnumList []types.FooEnum + IntegerList []*int32 // A list of lists of strings. NestedStringList [][]*string RenamedListMembers []*string - FlattenedList []*string + StringList []*string - FlattenedList2 []*string + StringSet []*string StructureList []*types.StructureListMember + + TimestampList []*time.Time } type XmlListsOutput struct { - StringList []*string - - StringSet []*string + BooleanList []*bool - IntegerList []*int32 + EnumList []types.FooEnum - BooleanList []*bool + FlattenedList []*string - TimestampList []*time.Time + FlattenedList2 []*string - EnumList []types.FooEnum + IntegerList []*int32 // A list of lists of strings. NestedStringList [][]*string RenamedListMembers []*string - FlattenedList []*string + StringList []*string - FlattenedList2 []*string + StringSet []*string StructureList []*types.StructureListMember + TimestampList []*time.Time + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/restxml/api_op_XmlTimestamps.go b/internal/protocoltest/restxml/api_op_XmlTimestamps.go index 6b84219aea4..3e922941281 100644 --- a/internal/protocoltest/restxml/api_op_XmlTimestamps.go +++ b/internal/protocoltest/restxml/api_op_XmlTimestamps.go @@ -53,24 +53,24 @@ func (c *Client) XmlTimestamps(ctx context.Context, params *XmlTimestampsInput, } type XmlTimestampsInput struct { - Normal *time.Time - DateTime *time.Time EpochSeconds *time.Time HttpDate *time.Time -} -type XmlTimestampsOutput struct { Normal *time.Time +} +type XmlTimestampsOutput struct { DateTime *time.Time EpochSeconds *time.Time HttpDate *time.Time + Normal *time.Time + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/internal/protocoltest/restxml/go.mod b/internal/protocoltest/restxml/go.mod index 10dd50323a8..6d27f4ae2ac 100644 --- a/internal/protocoltest/restxml/go.mod +++ b/internal/protocoltest/restxml/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/internal/protocoltest/restxml go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 github.com/google/go-cmp v0.4.1 ) diff --git a/internal/protocoltest/restxml/types/types.go b/internal/protocoltest/restxml/types/types.go index 48539b0f3c4..eda4c972736 100644 --- a/internal/protocoltest/restxml/types/types.go +++ b/internal/protocoltest/restxml/types/types.go @@ -43,9 +43,9 @@ type StructureListMember struct { } type XmlAttributesInputOutput struct { - Foo *string - Attr *string + + Foo *string } type XmlNamespaceNested struct { diff --git a/service/accessanalyzer/api_op_CreateAnalyzer.go b/service/accessanalyzer/api_op_CreateAnalyzer.go index e6fb7438aa6..96bf3f1c473 100644 --- a/service/accessanalyzer/api_op_CreateAnalyzer.go +++ b/service/accessanalyzer/api_op_CreateAnalyzer.go @@ -72,11 +72,11 @@ type CreateAnalyzerInput struct { // archive findings that meet the criteria you define for the rule. ArchiveRules []*types.InlineArchiveRule - // The tags to apply to the analyzer. - Tags map[string]*string - // A client token. ClientToken *string + + // The tags to apply to the analyzer. + Tags map[string]*string } // The response to the request to create an analyzer. diff --git a/service/accessanalyzer/api_op_CreateArchiveRule.go b/service/accessanalyzer/api_op_CreateArchiveRule.go index 603ff5eb648..c073327b62f 100644 --- a/service/accessanalyzer/api_op_CreateArchiveRule.go +++ b/service/accessanalyzer/api_op_CreateArchiveRule.go @@ -63,15 +63,15 @@ type CreateArchiveRuleInput struct { // This member is required. AnalyzerName *string - // The name of the rule to create. + // The criteria for the rule. // // This member is required. - RuleName *string + Filter map[string]*types.Criterion - // The criteria for the rule. + // The name of the rule to create. // // This member is required. - Filter map[string]*types.Criterion + RuleName *string // A client token. ClientToken *string diff --git a/service/accessanalyzer/api_op_ListAnalyzedResources.go b/service/accessanalyzer/api_op_ListAnalyzedResources.go index f52eb8c0ca5..a50fe573ca2 100644 --- a/service/accessanalyzer/api_op_ListAnalyzedResources.go +++ b/service/accessanalyzer/api_op_ListAnalyzedResources.go @@ -64,14 +64,14 @@ type ListAnalyzedResourcesInput struct { // This member is required. AnalyzerArn *string - // The type of resource. - ResourceType types.ResourceType + // The maximum number of results to return in the response. + MaxResults *int32 // A token used for pagination of results returned. NextToken *string - // The maximum number of results to return in the response. - MaxResults *int32 + // The type of resource. + ResourceType types.ResourceType } // The response to the request. diff --git a/service/accessanalyzer/api_op_ListAnalyzers.go b/service/accessanalyzer/api_op_ListAnalyzers.go index 75b4e76b2d6..39f692991ef 100644 --- a/service/accessanalyzer/api_op_ListAnalyzers.go +++ b/service/accessanalyzer/api_op_ListAnalyzers.go @@ -56,12 +56,12 @@ func (c *Client) ListAnalyzers(ctx context.Context, params *ListAnalyzersInput, // Retrieves a list of analyzers. type ListAnalyzersInput struct { - // A token used for pagination of results returned. - NextToken *string - // The maximum number of results to return in the response. MaxResults *int32 + // A token used for pagination of results returned. + NextToken *string + // The type of analyzer. Type types.Type } diff --git a/service/accessanalyzer/api_op_ListArchiveRules.go b/service/accessanalyzer/api_op_ListArchiveRules.go index 14491f1510e..ff71f7304e9 100644 --- a/service/accessanalyzer/api_op_ListArchiveRules.go +++ b/service/accessanalyzer/api_op_ListArchiveRules.go @@ -62,11 +62,11 @@ type ListArchiveRulesInput struct { // This member is required. AnalyzerName *string - // A token used for pagination of results returned. - NextToken *string - // The maximum number of results to return in the request. MaxResults *int32 + + // A token used for pagination of results returned. + NextToken *string } // The response to the request. diff --git a/service/accessanalyzer/api_op_ListFindings.go b/service/accessanalyzer/api_op_ListFindings.go index e8e0d397bf9..76ab40772a4 100644 --- a/service/accessanalyzer/api_op_ListFindings.go +++ b/service/accessanalyzer/api_op_ListFindings.go @@ -66,14 +66,14 @@ type ListFindingsInput struct { // A filter to match for the findings to return. Filter map[string]*types.Criterion - // The sort order for the findings returned. - Sort *types.SortCriteria + // The maximum number of results to return in the response. + MaxResults *int32 // A token used for pagination of results returned. NextToken *string - // The maximum number of results to return in the response. - MaxResults *int32 + // The sort order for the findings returned. + Sort *types.SortCriteria } // The response to the request. diff --git a/service/accessanalyzer/api_op_UpdateArchiveRule.go b/service/accessanalyzer/api_op_UpdateArchiveRule.go index f0c3434d6a2..11699b06731 100644 --- a/service/accessanalyzer/api_op_UpdateArchiveRule.go +++ b/service/accessanalyzer/api_op_UpdateArchiveRule.go @@ -62,17 +62,17 @@ type UpdateArchiveRuleInput struct { // This member is required. AnalyzerName *string - // The name of the rule to update. - // - // This member is required. - RuleName *string - // A filter to match for the rules to update. Only rules that match the filter are // updated. // // This member is required. Filter map[string]*types.Criterion + // The name of the rule to update. + // + // This member is required. + RuleName *string + // A client token. ClientToken *string } diff --git a/service/accessanalyzer/api_op_UpdateFindings.go b/service/accessanalyzer/api_op_UpdateFindings.go index f0ba5af18cd..e3cf48b45d1 100644 --- a/service/accessanalyzer/api_op_UpdateFindings.go +++ b/service/accessanalyzer/api_op_UpdateFindings.go @@ -72,14 +72,14 @@ type UpdateFindingsInput struct { // This member is required. Status types.FindingStatusUpdate + // A client token. + ClientToken *string + // The IDs of the findings to update. Ids []*string // The ARN of the resource identified in the finding. ResourceArn *string - - // A client token. - ClientToken *string } type UpdateFindingsOutput struct { diff --git a/service/accessanalyzer/go.mod b/service/accessanalyzer/go.mod index 65e1a0fa036..93a77cd38c7 100644 --- a/service/accessanalyzer/go.mod +++ b/service/accessanalyzer/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/accessanalyzer go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/accessanalyzer/types/types.go b/service/accessanalyzer/types/types.go index ed9dc82a128..cca85488d63 100644 --- a/service/accessanalyzer/types/types.go +++ b/service/accessanalyzer/types/types.go @@ -9,55 +9,55 @@ import ( // Contains details about the analyzed resource. type AnalyzedResource struct { - // The ARN of the resource that was analyzed. + // The time at which the resource was analyzed. // // This member is required. - ResourceArn *string + AnalyzedAt *time.Time - // The type of the resource that was analyzed. + // The time at which the finding was created. // // This member is required. - ResourceType ResourceType + CreatedAt *time.Time - // The time at which the finding was created. + // Indicates whether the policy that generated the finding grants public access to + // the resource. // // This member is required. - CreatedAt *time.Time + IsPublic *bool - // The time at which the resource was analyzed. + // The ARN of the resource that was analyzed. // // This member is required. - AnalyzedAt *time.Time + ResourceArn *string - // The time at which the finding was updated. + // The AWS account ID that owns the resource. // // This member is required. - UpdatedAt *time.Time + ResourceOwnerAccount *string - // Indicates whether the policy that generated the finding grants public access to - // the resource. + // The type of the resource that was analyzed. // // This member is required. - IsPublic *bool + ResourceType ResourceType + + // The time at which the finding was updated. + // + // This member is required. + UpdatedAt *time.Time // The actions that an external principal is granted permission to use by the // policy that generated the finding. Actions []*string + // An error message. + Error *string + // Indicates how the access that generated the finding is granted. This is // populated for Amazon S3 bucket findings. SharedVia []*string // The current status of the finding generated from the analyzed resource. Status FindingStatus - - // The AWS account ID that owns the resource. - // - // This member is required. - ResourceOwnerAccount *string - - // An error message. - Error *string } // Contains the ARN of the analyzed resource. @@ -87,21 +87,31 @@ type AnalyzerSummary struct { // This member is required. Arn *string + // A timestamp for the time at which the analyzer was created. + // + // This member is required. + CreatedAt *time.Time + // The name of the analyzer. // // This member is required. Name *string - // The type of analyzer, which corresponds to the zone of trust chosen for the - // analyzer. + // The status of the analyzer. An Active analyzer successfully monitors supported + // resources and generates new findings. The analyzer is Disabled when a user + // action, such as removing trusted access for IAM Access Analyzer from AWS + // Organizations, causes the analyzer to stop generating new findings. The status + // is Creating when the analyzer creation is in progress and Failed when the + // analyzer creation has failed. // // This member is required. - Type Type + Status AnalyzerStatus - // A timestamp for the time at which the analyzer was created. + // The type of analyzer, which corresponds to the zone of trust chosen for the + // analyzer. // // This member is required. - CreatedAt *time.Time + Type Type // The resource that was most recently analyzed by the analyzer. LastResourceAnalyzed *string @@ -109,44 +119,34 @@ type AnalyzerSummary struct { // The time at which the most recently analyzed resource was analyzed. LastResourceAnalyzedAt *time.Time - // The tags added to the analyzer. - Tags map[string]*string - - // The status of the analyzer. An Active analyzer successfully monitors supported - // resources and generates new findings. The analyzer is Disabled when a user - // action, such as removing trusted access for IAM Access Analyzer from AWS - // Organizations, causes the analyzer to stop generating new findings. The status - // is Creating when the analyzer creation is in progress and Failed when the - // analyzer creation has failed. - // - // This member is required. - Status AnalyzerStatus - // The statusReason provides more details about the current status of the analyzer. // For example, if the creation for the analyzer fails, a Failed status is // displayed. For an analyzer with organization as the type, this failure can be // due to an issue with creating the service-linked roles required in the member // accounts of the AWS organization. StatusReason *StatusReason + + // The tags added to the analyzer. + Tags map[string]*string } // Contains information about an archive rule. type ArchiveRuleSummary struct { - // The name of the archive rule. + // The time at which the archive rule was created. // // This member is required. - RuleName *string + CreatedAt *time.Time // A filter used to define the archive rule. // // This member is required. Filter map[string]*Criterion - // The time at which the archive rule was created. + // The name of the archive rule. // // This member is required. - CreatedAt *time.Time + RuleName *string // The time at which the archive rule was last updated. // @@ -157,45 +157,26 @@ type ArchiveRuleSummary struct { // The criteria to use in the filter that defines the archive rule. type Criterion struct { - // An "equals" operator to match for the filter used to create the rule. - Eq []*string - - // A "not equals" operator to match for the filter used to create the rule. - Neq []*string - // A "contains" operator to match for the filter used to create the rule. Contains []*string + // An "equals" operator to match for the filter used to create the rule. + Eq []*string + // An "exists" operator to match for the filter used to create the rule. Exists *bool + + // A "not equals" operator to match for the filter used to create the rule. + Neq []*string } // Contains information about a finding. type Finding struct { - // The ID of the finding. - // - // This member is required. - Id *string - - // The external principal that access to a resource within the zone of trust. - Principal map[string]*string - - // The action in the analyzed policy statement that an external principal has - // permission to use. - Action []*string - - // The resource that an external principal has access to. - Resource *string - - // Indicates whether the policy that generated the finding allows public access to - // the resource. - IsPublic *bool - - // The type of the resource reported in the finding. + // The time at which the resource was analyzed. // // This member is required. - ResourceType ResourceType + AnalyzedAt *time.Time // The condition in the analyzed policy statement that resulted in a finding. // @@ -207,29 +188,48 @@ type Finding struct { // This member is required. CreatedAt *time.Time - // The time at which the resource was analyzed. + // The ID of the finding. // // This member is required. - AnalyzedAt *time.Time + Id *string - // The time at which the finding was updated. + // The AWS account ID that owns the resource. // // This member is required. - UpdatedAt *time.Time + ResourceOwnerAccount *string + + // The type of the resource reported in the finding. + // + // This member is required. + ResourceType ResourceType // The current status of the finding. // // This member is required. Status FindingStatus - // The AWS account ID that owns the resource. + // The time at which the finding was updated. // // This member is required. - ResourceOwnerAccount *string + UpdatedAt *time.Time + + // The action in the analyzed policy statement that an external principal has + // permission to use. + Action []*string // An error. Error *string + // Indicates whether the policy that generated the finding allows public access to + // the resource. + IsPublic *bool + + // The external principal that access to a resource within the zone of trust. + Principal map[string]*string + + // The resource that an external principal has access to. + Resource *string + // The sources of the finding. This indicates how the access that generated the // finding is granted. It is populated for Amazon S3 bucket findings. Sources []*FindingSource @@ -260,29 +260,11 @@ type FindingSourceDetail struct { // Contains information about a finding. type FindingSummary struct { - // The ID of the finding. - // - // This member is required. - Id *string - - // The external principal that has access to a resource within the zone of trust. - Principal map[string]*string - - // The action in the analyzed policy statement that an external principal has - // permission to use. - Action []*string - - // The resource that the external principal has access to. - Resource *string - - // Indicates whether the finding reports a resource that has a policy that allows - // public access. - IsPublic *bool - - // The type of the resource that the external principal has access to. + // The time at which the resource-based policy that generated the finding was + // analyzed. // // This member is required. - ResourceType ResourceType + AnalyzedAt *time.Time // The condition in the analyzed policy statement that resulted in a finding. // @@ -294,30 +276,48 @@ type FindingSummary struct { // This member is required. CreatedAt *time.Time - // The time at which the resource-based policy that generated the finding was - // analyzed. + // The ID of the finding. // // This member is required. - AnalyzedAt *time.Time + Id *string - // The time at which the finding was most recently updated. + // The AWS account ID that owns the resource. // // This member is required. - UpdatedAt *time.Time + ResourceOwnerAccount *string + + // The type of the resource that the external principal has access to. + // + // This member is required. + ResourceType ResourceType // The status of the finding. // // This member is required. Status FindingStatus - // The AWS account ID that owns the resource. + // The time at which the finding was most recently updated. // // This member is required. - ResourceOwnerAccount *string + UpdatedAt *time.Time + + // The action in the analyzed policy statement that an external principal has + // permission to use. + Action []*string // The error that resulted in an Error finding. Error *string + // Indicates whether the finding reports a resource that has a policy that allows + // public access. + IsPublic *bool + + // The external principal that has access to a resource within the zone of trust. + Principal map[string]*string + + // The resource that the external principal has access to. + Resource *string + // The sources of the finding. This indicates how the access that generated the // finding is granted. It is populated for Amazon S3 bucket findings. Sources []*FindingSource @@ -327,15 +327,15 @@ type FindingSummary struct { // criteria. type InlineArchiveRule struct { - // The name of the rule. + // The condition and values for a criterion. // // This member is required. - RuleName *string + Filter map[string]*Criterion - // The condition and values for a criterion. + // The name of the rule. // // This member is required. - Filter map[string]*Criterion + RuleName *string } // The criteria used to sort. @@ -364,13 +364,13 @@ type StatusReason struct { // Contains information about a validation exception. type ValidationExceptionField struct { - // The name of the validation exception. + // A message about the validation exception. // // This member is required. - Name *string + Message *string - // A message about the validation exception. + // The name of the validation exception. // // This member is required. - Message *string + Name *string } diff --git a/service/acm/api_op_AddTagsToCertificate.go b/service/acm/api_op_AddTagsToCertificate.go index 11983e0da94..1a46f1fca92 100644 --- a/service/acm/api_op_AddTagsToCertificate.go +++ b/service/acm/api_op_AddTagsToCertificate.go @@ -71,11 +71,6 @@ func (c *Client) AddTagsToCertificate(ctx context.Context, params *AddTagsToCert type AddTagsToCertificateInput struct { - // The key-value pair that defines the tag. The tag value is optional. - // - // This member is required. - Tags []*types.Tag - // String that contains the ARN of the ACM certificate to which the tag is to be // applied. This must be of the form:

// arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 @@ -85,6 +80,11 @@ type AddTagsToCertificateInput struct { // // This member is required. CertificateArn *string + + // The key-value pair that defines the tag. The tag value is optional. + // + // This member is required. + Tags []*types.Tag } type AddTagsToCertificateOutput struct { diff --git a/service/acm/api_op_ExportCertificate.go b/service/acm/api_op_ExportCertificate.go index 33be16fd944..083f16111ad 100644 --- a/service/acm/api_op_ExportCertificate.go +++ b/service/acm/api_op_ExportCertificate.go @@ -84,14 +84,14 @@ type ExportCertificateOutput struct { // The base64 PEM-encoded certificate. Certificate *string - // The encrypted private key associated with the public key in the certificate. The - // key is output in PKCS #8 format and is base64 PEM-encoded. - PrivateKey *string - // The base64 PEM-encoded certificate chain. This does not include the certificate // that you are exporting. CertificateChain *string + // The encrypted private key associated with the public key in the certificate. The + // key is output in PKCS #8 format and is base64 PEM-encoded. + PrivateKey *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/acm/api_op_GetCertificate.go b/service/acm/api_op_GetCertificate.go index ff508a29e10..00ad142c07a 100644 --- a/service/acm/api_op_GetCertificate.go +++ b/service/acm/api_op_GetCertificate.go @@ -72,14 +72,14 @@ type GetCertificateInput struct { type GetCertificateOutput struct { + // The ACM-issued certificate corresponding to the ARN specified as input. + Certificate *string + // Certificates forming the requested certificate's chain of trust. The chain // consists of the certificate of the issuing CA and the intermediate certificates // of any other subordinate CAs. CertificateChain *string - // The ACM-issued certificate corresponding to the ARN specified as input. - Certificate *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/acm/api_op_ImportCertificate.go b/service/acm/api_op_ImportCertificate.go index 77ae5fc0903..25f2d8000ad 100644 --- a/service/acm/api_op_ImportCertificate.go +++ b/service/acm/api_op_ImportCertificate.go @@ -97,28 +97,28 @@ func (c *Client) ImportCertificate(ctx context.Context, params *ImportCertificat type ImportCertificateInput struct { + // The certificate to import. + // + // This member is required. + Certificate []byte + + // The private key that matches the public key in the certificate. + // + // This member is required. + PrivateKey []byte + // The Amazon Resource Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // an imported certificate to replace. To import a new certificate, omit this // field. CertificateArn *string - // The private key that matches the public key in the certificate. - // - // This member is required. - PrivateKey []byte + // The PEM encoded certificate chain. + CertificateChain []byte // One or more resource tags to associate with the imported certificate. Note: You // cannot apply tags when reimporting a certificate. Tags []*types.Tag - - // The certificate to import. - // - // This member is required. - Certificate []byte - - // The PEM encoded certificate chain. - CertificateChain []byte } type ImportCertificateOutput struct { diff --git a/service/acm/api_op_ListCertificates.go b/service/acm/api_op_ListCertificates.go index da6d218168c..95064c4af85 100644 --- a/service/acm/api_op_ListCertificates.go +++ b/service/acm/api_op_ListCertificates.go @@ -59,18 +59,18 @@ func (c *Client) ListCertificates(ctx context.Context, params *ListCertificatesI type ListCertificatesInput struct { - // Use this parameter when paginating results to specify the maximum number of - // items to return in the response. If additional items exist beyond the number you - // specify, the NextToken element is sent in the response. Use this NextToken value - // in a subsequent request to retrieve additional items. - MaxItems *int32 - // Filter the certificate list by status value. CertificateStatuses []types.CertificateStatus // Filter the certificate list. For more information, see the Filters () structure. Includes *types.Filters + // Use this parameter when paginating results to specify the maximum number of + // items to return in the response. If additional items exist beyond the number you + // specify, the NextToken element is sent in the response. Use this NextToken value + // in a subsequent request to retrieve additional items. + MaxItems *int32 + // Use this parameter only when paginating results and only in a subsequent request // after you receive a response with truncated results. Set it to the value of // NextToken from the response you just received. @@ -79,13 +79,13 @@ type ListCertificatesInput struct { type ListCertificatesOutput struct { + // A list of ACM certificates. + CertificateSummaryList []*types.CertificateSummary + // When the list is truncated, this value is present and contains the value to use // for the NextToken parameter in a subsequent pagination request. NextToken *string - // A list of ACM certificates. - CertificateSummaryList []*types.CertificateSummary - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/acm/api_op_RequestCertificate.go b/service/acm/api_op_RequestCertificate.go index 31eb196397d..9627d047642 100644 --- a/service/acm/api_op_RequestCertificate.go +++ b/service/acm/api_op_RequestCertificate.go @@ -68,38 +68,6 @@ func (c *Client) RequestCertificate(ctx context.Context, params *RequestCertific type RequestCertificateInput struct { - // The domain name that you want ACM to use to send you emails so that you can - // validate domain ownership. - DomainValidationOptions []*types.DomainValidationOption - - // Customer chosen string that can be used to distinguish between calls to - // RequestCertificate. Idempotency tokens time out after one hour. Therefore, if - // you call RequestCertificate multiple times with the same idempotency token - // within one hour, ACM recognizes that you are requesting only one certificate and - // will issue only one. If you change the idempotency token for each call, ACM - // recognizes that you are requesting multiple certificates. - IdempotencyToken *string - - // The method you want to use if you are requesting a public certificate to - // validate that you own or control domain. You can validate with DNS - // (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html) or - // validate with email - // (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html). - // We recommend that you use DNS validation. - ValidationMethod types.ValidationMethod - - // Currently, you can use this parameter to specify whether to add the certificate - // to a certificate transparency log. Certificate transparency makes it possible to - // detect SSL/TLS certificates that have been mistakenly or maliciously issued. - // Certificates that have not been logged typically produce an error message in a - // browser. For more information, see Opting Out of Certificate Transparency - // Logging - // (https://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency). - Options *types.CertificateOptions - - // One or more resource tags to associate with the certificate. - Tags []*types.Tag - // Fully qualified domain name (FQDN), such as www.example.com, that you want to // secure with an ACM certificate. Use an asterisk (*) to create a wildcard // certificate that protects several sites in the same domain. For example, @@ -122,6 +90,27 @@ type RequestCertificateInput struct { //

CertificateAuthorityArn *string + // The domain name that you want ACM to use to send you emails so that you can + // validate domain ownership. + DomainValidationOptions []*types.DomainValidationOption + + // Customer chosen string that can be used to distinguish between calls to + // RequestCertificate. Idempotency tokens time out after one hour. Therefore, if + // you call RequestCertificate multiple times with the same idempotency token + // within one hour, ACM recognizes that you are requesting only one certificate and + // will issue only one. If you change the idempotency token for each call, ACM + // recognizes that you are requesting multiple certificates. + IdempotencyToken *string + + // Currently, you can use this parameter to specify whether to add the certificate + // to a certificate transparency log. Certificate transparency makes it possible to + // detect SSL/TLS certificates that have been mistakenly or maliciously issued. + // Certificates that have not been logged typically produce an error message in a + // browser. For more information, see Opting Out of Certificate Transparency + // Logging + // (https://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency). + Options *types.CertificateOptions + // Additional FQDNs to be included in the Subject Alternative Name extension of the // ACM certificate. For example, add the name www.example.net to a certificate for // which the DomainName field is www.example.com if users can reach your site by @@ -140,6 +129,17 @@ type RequestCertificateInput struct { // octets).(62 octets) is not legal because the total length of the DNS name // (63+1+63+1+63+1+62) exceeds 253 octets.

SubjectAlternativeNames []*string + + // One or more resource tags to associate with the certificate. + Tags []*types.Tag + + // The method you want to use if you are requesting a public certificate to + // validate that you own or control domain. You can validate with DNS + // (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html) or + // validate with email + // (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html). + // We recommend that you use DNS validation. + ValidationMethod types.ValidationMethod } type RequestCertificateOutput struct { diff --git a/service/acm/api_op_ResendValidationEmail.go b/service/acm/api_op_ResendValidationEmail.go index 339ed33486e..74a71c9e70f 100644 --- a/service/acm/api_op_ResendValidationEmail.go +++ b/service/acm/api_op_ResendValidationEmail.go @@ -66,6 +66,23 @@ func (c *Client) ResendValidationEmail(ctx context.Context, params *ResendValida type ResendValidationEmailInput struct { + // String that contains the ARN of the requested certificate. The certificate ARN + // is generated and returned by the RequestCertificate () action as soon as the + // request is made. By default, using this parameter causes email to be sent to all + // top-level domains you specified in the certificate request. The ARN must be of + // the form:

+ // arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012 + //

+ // + // This member is required. + CertificateArn *string + + // The fully qualified domain name (FQDN) of the certificate that needs to be + // validated. + // + // This member is required. + Domain *string + // The base validation domain that will act as the suffix of the email addresses // that are used to send the emails. This must be the same as the Domain value or a // superdomain of the Domain value. For example, if you requested a certificate for @@ -88,23 +105,6 @@ type ResendValidationEmailInput struct { // // This member is required. ValidationDomain *string - - // String that contains the ARN of the requested certificate. The certificate ARN - // is generated and returned by the RequestCertificate () action as soon as the - // request is made. By default, using this parameter causes email to be sent to all - // top-level domains you specified in the certificate request. The ARN must be of - // the form:

- // arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012 - //

- // - // This member is required. - CertificateArn *string - - // The fully qualified domain name (FQDN) of the certificate that needs to be - // validated. - // - // This member is required. - Domain *string } type ResendValidationEmailOutput struct { diff --git a/service/acm/api_op_UpdateCertificateOptions.go b/service/acm/api_op_UpdateCertificateOptions.go index 8781ee1d7cf..daa50f5ea03 100644 --- a/service/acm/api_op_UpdateCertificateOptions.go +++ b/service/acm/api_op_UpdateCertificateOptions.go @@ -60,6 +60,12 @@ func (c *Client) UpdateCertificateOptions(ctx context.Context, params *UpdateCer type UpdateCertificateOptionsInput struct { + // ARN of the requested certificate to update. This must be of the form: + // arn:aws:acm:us-east-1:account:certificate/12345678-1234-1234-1234-123456789012 + // + // This member is required. + CertificateArn *string + // Use to update the options for your certificate. Currently, you can specify // whether to add your certificate to a transparency log. Certificate transparency // makes it possible to detect SSL/TLS certificates that have been mistakenly or @@ -68,12 +74,6 @@ type UpdateCertificateOptionsInput struct { // // This member is required. Options *types.CertificateOptions - - // ARN of the requested certificate to update. This must be of the form: - // arn:aws:acm:us-east-1:account:certificate/12345678-1234-1234-1234-123456789012 - // - // This member is required. - CertificateArn *string } type UpdateCertificateOptionsOutput struct { diff --git a/service/acm/go.mod b/service/acm/go.mod index 055ad9a0ab7..25363b91bbc 100644 --- a/service/acm/go.mod +++ b/service/acm/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/acm go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/acm/types/types.go b/service/acm/types/types.go index 582e1c606ef..7d1b3a61d96 100644 --- a/service/acm/types/types.go +++ b/service/acm/types/types.go @@ -10,110 +10,117 @@ import ( // response to a DescribeCertificate () request. type CertificateDetail struct { - // Specifies whether the certificate is eligible for renewal. At this time, only - // exported private certificates can be renewed with the RenewCertificate () - // command. - RenewalEligibility RenewalEligibility - - // The algorithm that was used to sign the certificate. - SignatureAlgorithm *string - - // A list of ARNs for the AWS resources that are using the certificate. A - // certificate can be used by multiple AWS resources. - InUseBy []*string - - // The time at which the certificate was revoked. This value exists only when the - // certificate status is REVOKED. - RevokedAt *time.Time - - // Value that specifies whether to add the certificate to a transparency log. - // Certificate transparency makes it possible to detect SSL certificates that have - // been mistakenly or maliciously issued. A browser might respond to certificate - // that has not been logged by showing an error message. The logs are - // cryptographically secure. - Options *CertificateOptions - - // The date and time at which the certificate was imported. This value exists only - // when the certificate type is IMPORTED. - ImportedAt *time.Time + // The Amazon Resource Name (ARN) of the certificate. For more information about + // ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in + // the AWS General Reference. + CertificateArn *string // The Amazon Resource Name (ARN) of the ACM PCA private certificate authority (CA) // that issued the certificate. This has the following format: // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 CertificateAuthorityArn *string - // The serial number of the certificate. - Serial *string - - // The name of the certificate authority that issued and signed the certificate. - Issuer *string - // The time at which the certificate was requested. This value exists only when the // certificate type is AMAZON_ISSUED. CreatedAt *time.Time + // The fully qualified domain name for the certificate, such as www.example.com or + // example.com. + DomainName *string + // Contains information about the initial validation of each domain name that // occurs as a result of the RequestCertificate () request. This field exists only // when the certificate type is AMAZON_ISSUED. DomainValidationOptions []*DomainValidation - // The name of the entity that is associated with the public key contained in the - // certificate. - Subject *string + // Contains a list of Extended Key Usage X.509 v3 extension objects. Each object + // specifies a purpose for which the certificate public key can be used and + // consists of a name and an object identifier (OID). + ExtendedKeyUsages []*ExtendedKeyUsage - // The reason the certificate was revoked. This value exists only when the - // certificate status is REVOKED. - RevocationReason RevocationReason + // The reason the certificate request failed. This value exists only when the + // certificate status is FAILED. For more information, see Certificate Request + // Failed + // (https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting.html#troubleshooting-failed) + // in the AWS Certificate Manager User Guide. + FailureReason FailureReason - // One or more domain names (subject alternative names) included in the - // certificate. This list contains the domain names that are bound to the public - // key that is contained in the certificate. The subject alternative names include - // the canonical domain name (CN) of the certificate and additional domain names - // that can be used to connect to the website. - SubjectAlternativeNames []*string + // The date and time at which the certificate was imported. This value exists only + // when the certificate type is IMPORTED. + ImportedAt *time.Time + + // A list of ARNs for the AWS resources that are using the certificate. A + // certificate can be used by multiple AWS resources. + InUseBy []*string // The time at which the certificate was issued. This value exists only when the // certificate type is AMAZON_ISSUED. IssuedAt *time.Time + // The name of the certificate authority that issued and signed the certificate. + Issuer *string + // The algorithm that was used to generate the public-private key pair. KeyAlgorithm KeyAlgorithm - // The fully qualified domain name for the certificate, such as www.example.com or - // example.com. - DomainName *string - // A list of Key Usage X.509 v3 extension objects. Each object is a string value // that identifies the purpose of the public key contained in the certificate. // Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, // NON_REPUDIATION, and more. KeyUsages []*KeyUsage - // The Amazon Resource Name (ARN) of the certificate. For more information about - // ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference. - CertificateArn *string + // The time after which the certificate is not valid. + NotAfter *time.Time // The time before which the certificate is not valid. NotBefore *time.Time - // Contains a list of Extended Key Usage X.509 v3 extension objects. Each object - // specifies a purpose for which the certificate public key can be used and - // consists of a name and an object identifier (OID). - ExtendedKeyUsages []*ExtendedKeyUsage - - // The time after which the certificate is not valid. - NotAfter *time.Time + // Value that specifies whether to add the certificate to a transparency log. + // Certificate transparency makes it possible to detect SSL certificates that have + // been mistakenly or maliciously issued. A browser might respond to certificate + // that has not been logged by showing an error message. The logs are + // cryptographically secure. + Options *CertificateOptions - // The status of the certificate. - Status CertificateStatus + // Specifies whether the certificate is eligible for renewal. At this time, only + // exported private certificates can be renewed with the RenewCertificate () + // command. + RenewalEligibility RenewalEligibility // Contains information about the status of ACM's managed renewal // (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html) for the // certificate. This field exists only when the certificate type is AMAZON_ISSUED. RenewalSummary *RenewalSummary + // The reason the certificate was revoked. This value exists only when the + // certificate status is REVOKED. + RevocationReason RevocationReason + + // The time at which the certificate was revoked. This value exists only when the + // certificate status is REVOKED. + RevokedAt *time.Time + + // The serial number of the certificate. + Serial *string + + // The algorithm that was used to sign the certificate. + SignatureAlgorithm *string + + // The status of the certificate. + Status CertificateStatus + + // The name of the entity that is associated with the public key contained in the + // certificate. + Subject *string + + // One or more domain names (subject alternative names) included in the + // certificate. This list contains the domain names that are bound to the public + // key that is contained in the certificate. The subject alternative names include + // the canonical domain name (CN) of the certificate and additional domain names + // that can be used to connect to the website. + SubjectAlternativeNames []*string + // The source of the certificate. For certificates provided by ACM, this value is // AMAZON_ISSUED. For certificates that you imported with ImportCertificate (), // this value is IMPORTED. ACM does not provide managed renewal @@ -123,13 +130,6 @@ type CertificateDetail struct { // (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in // the AWS Certificate Manager User Guide. Type CertificateType - - // The reason the certificate request failed. This value exists only when the - // certificate status is FAILED. For more information, see Certificate Request - // Failed - // (https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting.html#troubleshooting-failed) - // in the AWS Certificate Manager User Guide. - FailureReason FailureReason } // Structure that contains options for your certificate. Currently, you can use @@ -166,6 +166,12 @@ type CertificateSummary struct { // certificate. type DomainValidation struct { + // A fully qualified domain name (FQDN) in the certificate. For example, + // www.example.com or example.com. + // + // This member is required. + DomainName *string + // Contains the CNAME record that you add to your DNS database for domain // validation. For more information, see Use DNS to Validate Domain Ownership // (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html). @@ -176,21 +182,15 @@ type DomainValidation struct { // "_a79865eb4cd1a6ab990a45779b4e0b96" must be used. ResourceRecord *ResourceRecord - // A fully qualified domain name (FQDN) in the certificate. For example, - // www.example.com or example.com. - // - // This member is required. - DomainName *string - // The domain name that ACM used to send domain validation emails. ValidationDomain *string - // Specifies the domain validation method. - ValidationMethod ValidationMethod - // A list of email addresses that ACM used to send domain validation emails. ValidationEmails []*string + // Specifies the domain validation method. + ValidationMethod ValidationMethod + // The validation status of the domain name. This can be one of the following // values: @@ -201,6 +201,11 @@ type DomainValidation struct { // emails that enable you to validate domain ownership. type DomainValidationOption struct { + // A fully qualified domain name (FQDN) in the certificate request. + // + // This member is required. + DomainName *string + // The domain name that you want ACM to use to send you validation emails. This // domain name is the suffix of the email addresses that you want ACM to use. This // must be the same as the DomainName value or a superdomain of the DomainName @@ -222,11 +227,6 @@ type DomainValidationOption struct { // // This member is required. ValidationDomain *string - - // A fully qualified domain name (FQDN) in the certificate request. - // - // This member is required. - DomainName *string } // The Extended Key Usage X.509 v3 extension defines one or more purposes for which @@ -256,8 +256,8 @@ type ExtendedKeyUsage struct { // output of the certificate list. type Filters struct { - // Specify one or more KeyUsage () extension values. - KeyUsage []KeyUsageName + // Specify one or more ExtendedKeyUsage () extension values. + ExtendedKeyUsage []ExtendedKeyUsageName // Specify one or more algorithms that can be used to generate key pairs. Default // filtering returns only RSA_2048 certificates. To return other certificate types, @@ -266,8 +266,8 @@ type Filters struct { // certificates. KeyTypes []KeyAlgorithm - // Specify one or more ExtendedKeyUsage () extension values. - ExtendedKeyUsage []ExtendedKeyUsageName + // Specify one or more KeyUsage () extension values. + KeyUsage []KeyUsageName } // The Key Usage X.509 v3 extension defines the purpose of the public key contained @@ -284,16 +284,6 @@ type KeyUsage struct { // AMAZON_ISSUED. type RenewalSummary struct { - // The reason that a renewal request was unsuccessful. - RenewalStatusReason FailureReason - - // The status of ACM's managed renewal - // (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html) of the - // certificate. - // - // This member is required. - RenewalStatus RenewalStatus - // Contains information about the validation of each domain name in the // certificate, as it pertains to ACM's managed renewal // (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html). This is @@ -304,41 +294,51 @@ type RenewalSummary struct { // This member is required. DomainValidationOptions []*DomainValidation + // The status of ACM's managed renewal + // (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html) of the + // certificate. + // + // This member is required. + RenewalStatus RenewalStatus + // The time at which the renewal summary was last updated. // // This member is required. UpdatedAt *time.Time + + // The reason that a renewal request was unsuccessful. + RenewalStatusReason FailureReason } // Contains a DNS record value that you can use to can use to validate ownership or // control of a domain. This is used by the DescribeCertificate () action. type ResourceRecord struct { - // The value of the CNAME record to add to your DNS database. This is supplied by - // ACM. + // The name of the DNS record to create in your domain. This is supplied by ACM. // // This member is required. - Value *string + Name *string // The type of DNS record. Currently this can be CNAME. // // This member is required. Type RecordType - // The name of the DNS record to create in your domain. This is supplied by ACM. + // The value of the CNAME record to add to your DNS database. This is supplied by + // ACM. // // This member is required. - Name *string + Value *string } // A key-value pair that identifies or specifies metadata about an ACM resource. type Tag struct { - // The value of the tag. - Value *string - // The key of the tag. // // This member is required. Key *string + + // The value of the tag. + Value *string } diff --git a/service/acmpca/api_op_CreateCertificateAuthority.go b/service/acmpca/api_op_CreateCertificateAuthority.go index 88da31adcab..8d4eab9c3a0 100644 --- a/service/acmpca/api_op_CreateCertificateAuthority.go +++ b/service/acmpca/api_op_CreateCertificateAuthority.go @@ -66,24 +66,17 @@ func (c *Client) CreateCertificateAuthority(ctx context.Context, params *CreateC type CreateCertificateAuthorityInput struct { - // Contains a Boolean value that you can use to enable a certification revocation - // list (CRL) for the CA, the name of the S3 bucket to which ACM Private CA will - // write the CRL, and an optional CNAME alias that you can use to hide the name of - // your bucket in the CRL Distribution Points extension of your CA certificate. For - // more information, see the CrlConfiguration () structure. - RevocationConfiguration *types.RevocationConfiguration - - // The type of the certificate authority. - // - // This member is required. - CertificateAuthorityType types.CertificateAuthorityType - // Name and bit size of the private key algorithm, the name of the signing // algorithm, and X.500 certificate subject information. // // This member is required. CertificateAuthorityConfiguration *types.CertificateAuthorityConfiguration + // The type of the certificate authority. + // + // This member is required. + CertificateAuthorityType types.CertificateAuthorityType + // Alphanumeric string that can be used to distinguish between calls to // CreateCertificateAuthority. Idempotency tokens time out after five minutes. // Therefore, if you call CreateCertificateAuthority multiple times with the same @@ -93,6 +86,13 @@ type CreateCertificateAuthorityInput struct { // recognizes that you are requesting multiple certificates. IdempotencyToken *string + // Contains a Boolean value that you can use to enable a certification revocation + // list (CRL) for the CA, the name of the S3 bucket to which ACM Private CA will + // write the CRL, and an optional CNAME alias that you can use to hide the name of + // your bucket in the CRL Distribution Points extension of your CA certificate. For + // more information, see the CrlConfiguration () structure. + RevocationConfiguration *types.RevocationConfiguration + // Key-value pairs that will be attached to the new private CA. You can associate // up to 50 tags with a private CA. For information using tags with IAM to manage // permissions, see Controlling Access Using IAM Tags diff --git a/service/acmpca/api_op_CreateCertificateAuthorityAuditReport.go b/service/acmpca/api_op_CreateCertificateAuthorityAuditReport.go index 72df2884192..88d571a274b 100644 --- a/service/acmpca/api_op_CreateCertificateAuthorityAuditReport.go +++ b/service/acmpca/api_op_CreateCertificateAuthorityAuditReport.go @@ -59,6 +59,11 @@ func (c *Client) CreateCertificateAuthorityAuditReport(ctx context.Context, para type CreateCertificateAuthorityAuditReportInput struct { + // The format in which to create the report. This can be either JSON or CSV. + // + // This member is required. + AuditReportResponseFormat types.AuditReportResponseFormat + // The Amazon Resource Name (ARN) of the CA to be audited. This is of the form: // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // . @@ -66,11 +71,6 @@ type CreateCertificateAuthorityAuditReportInput struct { // This member is required. CertificateAuthorityArn *string - // The format in which to create the report. This can be either JSON or CSV. - // - // This member is required. - AuditReportResponseFormat types.AuditReportResponseFormat - // The name of the S3 bucket that will contain the audit report. // // This member is required. diff --git a/service/acmpca/api_op_CreatePermission.go b/service/acmpca/api_op_CreatePermission.go index 0d8419ae800..42c91963e88 100644 --- a/service/acmpca/api_op_CreatePermission.go +++ b/service/acmpca/api_op_CreatePermission.go @@ -70,15 +70,6 @@ type CreatePermissionInput struct { // This member is required. Actions []types.ActionType - // The AWS service or identity that receives the permission. At this time, the only - // valid principal is acm.amazonaws.com. - // - // This member is required. - Principal *string - - // The ID of the calling account. - SourceAccount *string - // The Amazon Resource Name (ARN) of the CA that grants the permissions. You can // find the ARN by calling the ListCertificateAuthorities () action. This must have // the following form: @@ -87,6 +78,15 @@ type CreatePermissionInput struct { // // This member is required. CertificateAuthorityArn *string + + // The AWS service or identity that receives the permission. At this time, the only + // valid principal is acm.amazonaws.com. + // + // This member is required. + Principal *string + + // The ID of the calling account. + SourceAccount *string } type CreatePermissionOutput struct { diff --git a/service/acmpca/api_op_DeleteCertificateAuthority.go b/service/acmpca/api_op_DeleteCertificateAuthority.go index f853cf1bc7d..774be00d24a 100644 --- a/service/acmpca/api_op_DeleteCertificateAuthority.go +++ b/service/acmpca/api_op_DeleteCertificateAuthority.go @@ -73,10 +73,6 @@ func (c *Client) DeleteCertificateAuthority(ctx context.Context, params *DeleteC type DeleteCertificateAuthorityInput struct { - // The number of days to make a CA restorable after it has been deleted. This can - // be anywhere from 7 to 30 days, with 30 being the default. - PermanentDeletionTimeInDays *int32 - // The Amazon Resource Name (ARN) that was returned when you called // CreateCertificateAuthority (). This must have the following form: // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 @@ -84,6 +80,10 @@ type DeleteCertificateAuthorityInput struct { // // This member is required. CertificateAuthorityArn *string + + // The number of days to make a CA restorable after it has been deleted. This can + // be anywhere from 7 to 30 days, with 30 being the default. + PermanentDeletionTimeInDays *int32 } type DeleteCertificateAuthorityOutput struct { diff --git a/service/acmpca/api_op_DeletePermission.go b/service/acmpca/api_op_DeletePermission.go index 6c5cc0c1412..9c741350241 100644 --- a/service/acmpca/api_op_DeletePermission.go +++ b/service/acmpca/api_op_DeletePermission.go @@ -67,14 +67,14 @@ type DeletePermissionInput struct { // This member is required. CertificateAuthorityArn *string - // The AWS account that calls this action. - SourceAccount *string - // The AWS service or identity that will have its CA permissions revoked. At this // time, the only valid service principal is acm.amazonaws.com // // This member is required. Principal *string + + // The AWS account that calls this action. + SourceAccount *string } type DeletePermissionOutput struct { diff --git a/service/acmpca/api_op_DescribeCertificateAuthorityAuditReport.go b/service/acmpca/api_op_DescribeCertificateAuthorityAuditReport.go index 36e342c3026..4e44198f789 100644 --- a/service/acmpca/api_op_DescribeCertificateAuthorityAuditReport.go +++ b/service/acmpca/api_op_DescribeCertificateAuthorityAuditReport.go @@ -81,15 +81,15 @@ type DescribeCertificateAuthorityAuditReportOutput struct { // Specifies whether report creation is in progress, has succeeded, or has failed. AuditReportStatus types.AuditReportStatus + // The date and time at which the report was created. + CreatedAt *time.Time + // Name of the S3 bucket that contains the report. S3BucketName *string // S3 key that uniquely identifies the report file in your S3 bucket. S3Key *string - // The date and time at which the report was created. - CreatedAt *time.Time - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/acmpca/api_op_GetCertificate.go b/service/acmpca/api_op_GetCertificate.go index 74b7451d625..ab542aa73f2 100644 --- a/service/acmpca/api_op_GetCertificate.go +++ b/service/acmpca/api_op_GetCertificate.go @@ -80,13 +80,13 @@ type GetCertificateInput struct { type GetCertificateOutput struct { + // The base64 PEM-encoded certificate specified by the CertificateArn parameter. + Certificate *string + // The base64 PEM-encoded certificate chain that chains up to the on-premises root // CA certificate that you used to sign your private CA certificate. CertificateChain *string - // The base64 PEM-encoded certificate specified by the CertificateArn parameter. - Certificate *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/acmpca/api_op_GetCertificateAuthorityCertificate.go b/service/acmpca/api_op_GetCertificateAuthorityCertificate.go index f0d7ecbf897..2d6dc0303ac 100644 --- a/service/acmpca/api_op_GetCertificateAuthorityCertificate.go +++ b/service/acmpca/api_op_GetCertificateAuthorityCertificate.go @@ -69,15 +69,15 @@ type GetCertificateAuthorityCertificateInput struct { type GetCertificateAuthorityCertificateOutput struct { + // Base64-encoded certificate authority (CA) certificate. + Certificate *string + // Base64-encoded certificate chain that includes any intermediate certificates and // chains up to root on-premises certificate that you used to sign your private CA // certificate. The chain does not include your private CA certificate. If this is // a root CA, the value will be null. CertificateChain *string - // Base64-encoded certificate authority (CA) certificate. - Certificate *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/acmpca/api_op_ImportCertificateAuthorityCertificate.go b/service/acmpca/api_op_ImportCertificateAuthorityCertificate.go index 4dff14c0f3c..7cdcbc64f85 100644 --- a/service/acmpca/api_op_ImportCertificateAuthorityCertificate.go +++ b/service/acmpca/api_op_ImportCertificateAuthorityCertificate.go @@ -75,13 +75,12 @@ func (c *Client) ImportCertificateAuthorityCertificate(ctx context.Context, para type ImportCertificateAuthorityCertificateInput struct { - // A PEM-encoded file that contains all of your certificates, other than the - // certificate you're importing, chaining up to your root CA. Your ACM Private - // CA-hosted or on-premises root certificate is the last in the chain, and each - // certificate in the chain signs the one preceding. This parameter must be - // supplied when you import a subordinate CA. When you import a root CA, there is - // no chain. - CertificateChain []byte + // The PEM-encoded certificate for a private CA. This may be a self-signed + // certificate in the case of a root CA, or it may be signed by another CA that you + // control. + // + // This member is required. + Certificate []byte // The Amazon Resource Name (ARN) that was returned when you called // CreateCertificateAuthority (). This must be of the form: @@ -90,12 +89,13 @@ type ImportCertificateAuthorityCertificateInput struct { // This member is required. CertificateAuthorityArn *string - // The PEM-encoded certificate for a private CA. This may be a self-signed - // certificate in the case of a root CA, or it may be signed by another CA that you - // control. - // - // This member is required. - Certificate []byte + // A PEM-encoded file that contains all of your certificates, other than the + // certificate you're importing, chaining up to your root CA. Your ACM Private + // CA-hosted or on-premises root certificate is the last in the chain, and each + // certificate in the chain signs the one preceding. This parameter must be + // supplied when you import a subordinate CA. When you import a root CA, there is + // no chain. + CertificateChain []byte } type ImportCertificateAuthorityCertificateOutput struct { diff --git a/service/acmpca/api_op_IssueCertificate.go b/service/acmpca/api_op_IssueCertificate.go index 82487c1cdd1..e14ba17c4cb 100644 --- a/service/acmpca/api_op_IssueCertificate.go +++ b/service/acmpca/api_op_IssueCertificate.go @@ -80,6 +80,25 @@ type IssueCertificateInput struct { // This member is required. Csr []byte + // The name of the algorithm that will be used to sign the certificate to be + // issued. + // + // This member is required. + SigningAlgorithm types.SigningAlgorithm + + // The type of the validity period. + // + // This member is required. + Validity *types.Validity + + // Custom string that can be used to distinguish between calls to the + // IssueCertificate action. Idempotency tokens time out after one hour. Therefore, + // if you call IssueCertificate multiple times with the same idempotency token + // within 5 minutes, ACM Private CA recognizes that you are requesting only one + // certificate and will issue only one. If you change the idempotency token for + // each call, PCA recognizes that you are requesting multiple certificates. + IdempotencyToken *string + // Specifies a custom configuration template to use when issuing a certificate. If // this parameter is not provided, ACM Private CA defaults to the // EndEntityCertificate/V1 template. The following service-owned TemplateArn values @@ -107,25 +126,6 @@ type IssueCertificateInput struct { // Templates // (https://docs.aws.amazon.com/acm-pca/latest/userguide/UsingTemplates.html). TemplateArn *string - - // The type of the validity period. - // - // This member is required. - Validity *types.Validity - - // Custom string that can be used to distinguish between calls to the - // IssueCertificate action. Idempotency tokens time out after one hour. Therefore, - // if you call IssueCertificate multiple times with the same idempotency token - // within 5 minutes, ACM Private CA recognizes that you are requesting only one - // certificate and will issue only one. If you change the idempotency token for - // each call, PCA recognizes that you are requesting multiple certificates. - IdempotencyToken *string - - // The name of the algorithm that will be used to sign the certificate to be - // issued. - // - // This member is required. - SigningAlgorithm types.SigningAlgorithm } type IssueCertificateOutput struct { diff --git a/service/acmpca/api_op_ListCertificateAuthorities.go b/service/acmpca/api_op_ListCertificateAuthorities.go index 957734ca338..e8d1f92ad99 100644 --- a/service/acmpca/api_op_ListCertificateAuthorities.go +++ b/service/acmpca/api_op_ListCertificateAuthorities.go @@ -71,13 +71,13 @@ type ListCertificateAuthoritiesInput struct { type ListCertificateAuthoritiesOutput struct { + // Summary information about each certificate authority you have created. + CertificateAuthorities []*types.CertificateAuthority + // When the list is truncated, this value is present and should be used for the // NextToken parameter in a subsequent pagination request. NextToken *string - // Summary information about each certificate authority you have created. - CertificateAuthorities []*types.CertificateAuthority - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/acmpca/api_op_ListPermissions.go b/service/acmpca/api_op_ListPermissions.go index fe473a99dc5..551282ad362 100644 --- a/service/acmpca/api_op_ListPermissions.go +++ b/service/acmpca/api_op_ListPermissions.go @@ -59,17 +59,6 @@ func (c *Client) ListPermissions(ctx context.Context, params *ListPermissionsInp type ListPermissionsInput struct { - // When paginating results, use this parameter in a subsequent request after you - // receive a response with truncated results. Set it to the value of NextToken from - // the response you just received. - NextToken *string - - // When paginating results, use this parameter to specify the maximum number of - // items to return in the response. If additional items exist beyond the number you - // specify, the NextToken element is sent in the response. Use this NextToken value - // in a subsequent request to retrieve additional items. - MaxResults *int32 - // The Amazon Resource Number (ARN) of the private CA to inspect. You can find the // ARN by calling the ListCertificateAuthorities () action. This must be of the // form: @@ -79,18 +68,29 @@ type ListPermissionsInput struct { // // This member is required. CertificateAuthorityArn *string + + // When paginating results, use this parameter to specify the maximum number of + // items to return in the response. If additional items exist beyond the number you + // specify, the NextToken element is sent in the response. Use this NextToken value + // in a subsequent request to retrieve additional items. + MaxResults *int32 + + // When paginating results, use this parameter in a subsequent request after you + // receive a response with truncated results. Set it to the value of NextToken from + // the response you just received. + NextToken *string } type ListPermissionsOutput struct { - // Summary information about each permission assigned by the specified private CA, - // including the action enabled, the policy provided, and the time of creation. - Permissions []*types.Permission - // When the list is truncated, this value is present and should be used for the // NextToken parameter in a subsequent pagination request. NextToken *string + // Summary information about each permission assigned by the specified private CA, + // including the action enabled, the policy provided, and the time of creation. + Permissions []*types.Permission + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/acmpca/api_op_ListTags.go b/service/acmpca/api_op_ListTags.go index ecf9d118561..19002b7ede5 100644 --- a/service/acmpca/api_op_ListTags.go +++ b/service/acmpca/api_op_ListTags.go @@ -61,6 +61,13 @@ func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ... type ListTagsInput struct { + // The Amazon Resource Name (ARN) that was returned when you called the + // CreateCertificateAuthority () action. This must be of the form: + // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + // + // This member is required. + CertificateAuthorityArn *string + // Use this parameter when paginating results to specify the maximum number of // items to return in the response. If additional items exist beyond the number you // specify, the NextToken element is sent in the response. Use this NextToken value @@ -71,13 +78,6 @@ type ListTagsInput struct { // receive a response with truncated results. Set it to the value of NextToken from // the response you just received. NextToken *string - - // The Amazon Resource Name (ARN) that was returned when you called the - // CreateCertificateAuthority () action. This must be of the form: - // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 - // - // This member is required. - CertificateAuthorityArn *string } type ListTagsOutput struct { diff --git a/service/acmpca/api_op_RevokeCertificate.go b/service/acmpca/api_op_RevokeCertificate.go index 5d535c5ddad..42de0da63e6 100644 --- a/service/acmpca/api_op_RevokeCertificate.go +++ b/service/acmpca/api_op_RevokeCertificate.go @@ -71,11 +71,6 @@ type RevokeCertificateInput struct { // This member is required. CertificateAuthorityArn *string - // Specifies why you revoked the certificate. - // - // This member is required. - RevocationReason types.RevocationReason - // Serial number of the certificate to be revoked. This must be in hexadecimal // format. You can retrieve the serial number by calling GetCertificate () with the // Amazon Resource Name (ARN) of the certificate you want and the ARN of your @@ -89,6 +84,11 @@ type RevokeCertificateInput struct { // // This member is required. CertificateSerial *string + + // Specifies why you revoked the certificate. + // + // This member is required. + RevocationReason types.RevocationReason } type RevokeCertificateOutput struct { diff --git a/service/acmpca/api_op_UpdateCertificateAuthority.go b/service/acmpca/api_op_UpdateCertificateAuthority.go index 617b2975450..6b45c5ab59b 100644 --- a/service/acmpca/api_op_UpdateCertificateAuthority.go +++ b/service/acmpca/api_op_UpdateCertificateAuthority.go @@ -60,18 +60,18 @@ func (c *Client) UpdateCertificateAuthority(ctx context.Context, params *UpdateC type UpdateCertificateAuthorityInput struct { - // Status of your private CA. - Status types.CertificateAuthorityStatus - - // Revocation information for your private CA. - RevocationConfiguration *types.RevocationConfiguration - // Amazon Resource Name (ARN) of the private CA that issued the certificate to be // revoked. This must be of the form: // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // // This member is required. CertificateAuthorityArn *string + + // Revocation information for your private CA. + RevocationConfiguration *types.RevocationConfiguration + + // Status of your private CA. + Status types.CertificateAuthorityStatus } type UpdateCertificateAuthorityOutput struct { diff --git a/service/acmpca/go.mod b/service/acmpca/go.mod index 396cd86a204..b89b826bece 100644 --- a/service/acmpca/go.mod +++ b/service/acmpca/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/acmpca go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/acmpca/types/types.go b/service/acmpca/types/types.go index 2203f7b01c7..54d33f1dc8b 100644 --- a/service/acmpca/types/types.go +++ b/service/acmpca/types/types.go @@ -20,53 +20,53 @@ type ASN1Subject struct { // Fully qualified domain name (FQDN) associated with the certificate subject. CommonName *string - // Concatenation that typically contains the first letter of the GivenName, the - // first letter of the middle name if one exists, and the first letter of the - // SurName. - Initials *string + // Two-digit code that specifies the country in which the certificate subject + // located. + Country *string - // A title such as Mr. or Ms., which is pre-pended to the name to refer formally to - // the certificate subject. - Title *string + // Disambiguating information for the certificate subject. + DistinguishedNameQualifier *string + + // Typically a qualifier appended to the name of an individual. Examples include + // Jr. for junior, Sr. for senior, and III for third. + GenerationQualifier *string // First name. GivenName *string - // State in which the subject of the certificate is located. - State *string - - // Family name. In the US and the UK, for example, the surname of an individual is - // ordered last. In Asian cultures the surname is typically ordered first. - Surname *string - - // The certificate serial number. - SerialNumber *string + // Concatenation that typically contains the first letter of the GivenName, the + // first letter of the middle name if one exists, and the first letter of the + // SurName. + Initials *string - // Two-digit code that specifies the country in which the certificate subject + // The locality (such as a city or town) in which the certificate subject is // located. - Country *string + Locality *string // Legal name of the organization with which the certificate subject is affiliated. Organization *string + // A subdivision or unit of the organization (such as sales or finance) with which + // the certificate subject is affiliated. + OrganizationalUnit *string + // Typically a shortened version of a longer GivenName. For example, Jonathan is // often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza. Pseudonym *string - // A subdivision or unit of the organization (such as sales or finance) with which - // the certificate subject is affiliated. - OrganizationalUnit *string + // The certificate serial number. + SerialNumber *string - // Disambiguating information for the certificate subject. - DistinguishedNameQualifier *string + // State in which the subject of the certificate is located. + State *string - // The locality (such as a city or town) in which the certificate subject is - // located. - Locality *string + // Family name. In the US and the UK, for example, the surname of an individual is + // ordered last. In Asian cultures the surname is typically ordered first. + Surname *string - // Typically a qualifier appended to the name of an individual. Examples include - // Jr. for junior, Sr. for senior, and III for third. - GenerationQualifier *string + // A title such as Mr. or Ms., which is pre-pended to the name to refer formally to + // the certificate subject. + Title *string } // Contains information about your private certificate authority (CA). Your private @@ -81,45 +81,45 @@ type ASN1Subject struct { // into AWS Certificate Manager (ACM). type CertificateAuthority struct { - // Status of your private CA. - Status CertificateAuthorityStatus + // Amazon Resource Name (ARN) for your private certificate authority (CA). The + // format is 12345678-1234-1234-1234-123456789012 . + Arn *string + + // Your private CA configuration. + CertificateAuthorityConfiguration *CertificateAuthorityConfiguration // Date and time at which your private CA was created. CreatedAt *time.Time - // Amazon Resource Name (ARN) for your private certificate authority (CA). The - // format is 12345678-1234-1234-1234-123456789012 . - Arn *string + // Reason the request to create your private CA failed. + FailureReason FailureReason + + // Date and time at which your private CA was last updated. + LastStateChangeAt *time.Time // Date and time after which your private CA certificate is not valid. NotAfter *time.Time - // Serial number of your private CA. - Serial *string + // Date and time before which your private CA certificate is not valid. + NotBefore *time.Time // The period during which a deleted CA can be restored. For more information, see // the PermanentDeletionTimeInDays parameter of the // DeleteCertificateAuthorityRequest () action. RestorableUntil *time.Time - // Date and time at which your private CA was last updated. - LastStateChangeAt *time.Time - - // Reason the request to create your private CA failed. - FailureReason FailureReason - // Information about the certificate revocation list (CRL) created and maintained // by your private CA. RevocationConfiguration *RevocationConfiguration - // Date and time before which your private CA certificate is not valid. - NotBefore *time.Time + // Serial number of your private CA. + Serial *string + + // Status of your private CA. + Status CertificateAuthorityStatus // Type of your private CA. Type CertificateAuthorityType - - // Your private CA configuration. - CertificateAuthorityConfiguration *CertificateAuthorityConfiguration } // Contains configuration information for your private certificate authority (CA). @@ -215,14 +215,6 @@ type CertificateAuthorityConfiguration struct { // -text -in crl_path -noout type CrlConfiguration struct { - // Name inserted into the certificate CRL Distribution Points extension that - // enables the use of an alias for the CRL distribution point. Use this value if - // you don't want the name of your S3 bucket to be public. - CustomCname *string - - // Number of days until a certificate expires. - ExpirationInDays *int32 - // Boolean value that specifies whether certificate revocation lists (CRLs) are // enabled. You can use this value to enable certificate revocation for a new CA // when you call the CreateCertificateAuthority () action or for an existing CA @@ -231,6 +223,14 @@ type CrlConfiguration struct { // This member is required. Enabled *bool + // Name inserted into the certificate CRL Distribution Points extension that + // enables the use of an alias for the CRL distribution point. Use this value if + // you don't want the name of your S3 bucket to be public. + CustomCname *string + + // Number of days until a certificate expires. + ExpirationInDays *int32 + // Name of the S3 bucket that contains the CRL. If you do not provide a value for // the CustomCname argument, the name of your S3 bucket is placed into the CRL // Distribution Points extension of the issued certificate. You can change the name @@ -248,9 +248,8 @@ type CrlConfiguration struct { // () action, and listed with the ListPermissions () action. type Permission struct { - // The AWS service or entity that holds the permission. At this time, the only - // valid principal is acm.amazonaws.com. - Principal *string + // The private CA actions that can be performed by the designated AWS service. + Actions []ActionType // The Amazon Resource Number (ARN) of the private CA from which the permission was // issued. @@ -259,14 +258,15 @@ type Permission struct { // The time at which the permission was created. CreatedAt *time.Time - // The ID of the account that assigned the permission. - SourceAccount *string - - // The private CA actions that can be performed by the designated AWS service. - Actions []ActionType - // The name of the policy that is associated with the permission. Policy *string + + // The AWS service or entity that holds the permission. At this time, the only + // valid principal is acm.amazonaws.com. + Principal *string + + // The ID of the account that assigned the permission. + SourceAccount *string } // Certificate revocation information used by the CreateCertificateAuthority () and diff --git a/service/alexaforbusiness/api_op_AssociateDeviceWithNetworkProfile.go b/service/alexaforbusiness/api_op_AssociateDeviceWithNetworkProfile.go index 0899305d5c7..56e0a61cef6 100644 --- a/service/alexaforbusiness/api_op_AssociateDeviceWithNetworkProfile.go +++ b/service/alexaforbusiness/api_op_AssociateDeviceWithNetworkProfile.go @@ -56,15 +56,15 @@ func (c *Client) AssociateDeviceWithNetworkProfile(ctx context.Context, params * type AssociateDeviceWithNetworkProfileInput struct { - // The ARN of the network profile to associate with a device. + // The device ARN. // // This member is required. - NetworkProfileArn *string + DeviceArn *string - // The device ARN. + // The ARN of the network profile to associate with a device. // // This member is required. - DeviceArn *string + NetworkProfileArn *string } type AssociateDeviceWithNetworkProfileOutput struct { diff --git a/service/alexaforbusiness/api_op_AssociateDeviceWithRoom.go b/service/alexaforbusiness/api_op_AssociateDeviceWithRoom.go index bcae04bba77..24e54509463 100644 --- a/service/alexaforbusiness/api_op_AssociateDeviceWithRoom.go +++ b/service/alexaforbusiness/api_op_AssociateDeviceWithRoom.go @@ -58,11 +58,11 @@ func (c *Client) AssociateDeviceWithRoom(ctx context.Context, params *AssociateD type AssociateDeviceWithRoomInput struct { - // The ARN of the room with which to associate the device. Required. - RoomArn *string - // The ARN of the device to associate to a room. Required. DeviceArn *string + + // The ARN of the room with which to associate the device. Required. + RoomArn *string } type AssociateDeviceWithRoomOutput struct { diff --git a/service/alexaforbusiness/api_op_AssociateSkillGroupWithRoom.go b/service/alexaforbusiness/api_op_AssociateSkillGroupWithRoom.go index 208dc902fa9..e63b9258b3c 100644 --- a/service/alexaforbusiness/api_op_AssociateSkillGroupWithRoom.go +++ b/service/alexaforbusiness/api_op_AssociateSkillGroupWithRoom.go @@ -56,11 +56,11 @@ func (c *Client) AssociateSkillGroupWithRoom(ctx context.Context, params *Associ type AssociateSkillGroupWithRoomInput struct { - // The ARN of the skill group to associate with a room. Required. - SkillGroupArn *string - // The ARN of the room with which to associate the skill group. Required. RoomArn *string + + // The ARN of the skill group to associate with a room. Required. + SkillGroupArn *string } type AssociateSkillGroupWithRoomOutput struct { diff --git a/service/alexaforbusiness/api_op_AssociateSkillWithSkillGroup.go b/service/alexaforbusiness/api_op_AssociateSkillWithSkillGroup.go index e3496b24530..43536dc4abf 100644 --- a/service/alexaforbusiness/api_op_AssociateSkillWithSkillGroup.go +++ b/service/alexaforbusiness/api_op_AssociateSkillWithSkillGroup.go @@ -56,13 +56,13 @@ func (c *Client) AssociateSkillWithSkillGroup(ctx context.Context, params *Assoc type AssociateSkillWithSkillGroupInput struct { - // The ARN of the skill group to associate the skill to. Required. - SkillGroupArn *string - // The unique identifier of the skill. // // This member is required. SkillId *string + + // The ARN of the skill group to associate the skill to. Required. + SkillGroupArn *string } type AssociateSkillWithSkillGroupOutput struct { diff --git a/service/alexaforbusiness/api_op_CreateAddressBook.go b/service/alexaforbusiness/api_op_CreateAddressBook.go index 0fa5ea590cd..68309576d07 100644 --- a/service/alexaforbusiness/api_op_CreateAddressBook.go +++ b/service/alexaforbusiness/api_op_CreateAddressBook.go @@ -58,16 +58,16 @@ func (c *Client) CreateAddressBook(ctx context.Context, params *CreateAddressBoo type CreateAddressBookInput struct { - // The description of the address book. - Description *string - - // A unique, user-specified identifier for the request that ensures idempotency. - ClientRequestToken *string - // The name of the address book. // // This member is required. Name *string + + // A unique, user-specified identifier for the request that ensures idempotency. + ClientRequestToken *string + + // The description of the address book. + Description *string } type CreateAddressBookOutput struct { diff --git a/service/alexaforbusiness/api_op_CreateBusinessReportSchedule.go b/service/alexaforbusiness/api_op_CreateBusinessReportSchedule.go index 3cf4c2acb56..dd75d487b07 100644 --- a/service/alexaforbusiness/api_op_CreateBusinessReportSchedule.go +++ b/service/alexaforbusiness/api_op_CreateBusinessReportSchedule.go @@ -60,18 +60,17 @@ func (c *Client) CreateBusinessReportSchedule(ctx context.Context, params *Creat type CreateBusinessReportScheduleInput struct { - // The S3 key where the report is delivered. - S3KeyPrefix *string - - // The S3 bucket name of the output reports. If this isn't specified, the report - // can be retrieved from a download link by calling ListBusinessReportSchedule. - S3BucketName *string - // The content range of the reports. // // This member is required. ContentRange *types.BusinessReportContentRange + // The format of the generated report (individual CSV files or zipped files of + // individual files). + // + // This member is required. + Format types.BusinessReportFormat + // The client request token. ClientRequestToken *string @@ -79,17 +78,18 @@ type CreateBusinessReportScheduleInput struct { // delivered one time when the API is called. Recurrence *types.BusinessReportRecurrence - // The tags for the business report schedule. - Tags []*types.Tag + // The S3 bucket name of the output reports. If this isn't specified, the report + // can be retrieved from a download link by calling ListBusinessReportSchedule. + S3BucketName *string + + // The S3 key where the report is delivered. + S3KeyPrefix *string // The name identifier of the schedule. ScheduleName *string - // The format of the generated report (individual CSV files or zipped files of - // individual files). - // - // This member is required. - Format types.BusinessReportFormat + // The tags for the business report schedule. + Tags []*types.Tag } type CreateBusinessReportScheduleOutput struct { diff --git a/service/alexaforbusiness/api_op_CreateConferenceProvider.go b/service/alexaforbusiness/api_op_CreateConferenceProvider.go index 7b301040a7d..e2476648c92 100644 --- a/service/alexaforbusiness/api_op_CreateConferenceProvider.go +++ b/service/alexaforbusiness/api_op_CreateConferenceProvider.go @@ -59,20 +59,6 @@ func (c *Client) CreateConferenceProvider(ctx context.Context, params *CreateCon type CreateConferenceProviderInput struct { - // The IP endpoint and protocol for calling. - IPDialIn *types.IPDialIn - - // The request token of the client. - ClientRequestToken *string - - // The information for PSTN conferencing. - PSTNDialIn *types.PSTNDialIn - - // The meeting settings for the conference provider. - // - // This member is required. - MeetingSetting *types.MeetingSetting - // The name of the conference provider. // // This member is required. @@ -82,6 +68,20 @@ type CreateConferenceProviderInput struct { // // This member is required. ConferenceProviderType types.ConferenceProviderType + + // The meeting settings for the conference provider. + // + // This member is required. + MeetingSetting *types.MeetingSetting + + // The request token of the client. + ClientRequestToken *string + + // The IP endpoint and protocol for calling. + IPDialIn *types.IPDialIn + + // The information for PSTN conferencing. + PSTNDialIn *types.PSTNDialIn } type CreateConferenceProviderOutput struct { diff --git a/service/alexaforbusiness/api_op_CreateContact.go b/service/alexaforbusiness/api_op_CreateContact.go index 1c01a17e43d..a6f07b82320 100644 --- a/service/alexaforbusiness/api_op_CreateContact.go +++ b/service/alexaforbusiness/api_op_CreateContact.go @@ -67,20 +67,20 @@ type CreateContactInput struct { // A unique, user-specified identifier for this request that ensures idempotency. ClientRequestToken *string - // The list of phone numbers for the contact. - PhoneNumbers []*types.PhoneNumber + // The name of the contact to display on the console. + DisplayName *string // The last name of the contact that is used to call the contact on the device. LastName *string - // The name of the contact to display on the console. - DisplayName *string - // The phone number of the contact in E.164 format. The phone number type defaults // to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use // PhoneNumbers, which lets you specify the phone number type and multiple numbers. PhoneNumber *string + // The list of phone numbers for the contact. + PhoneNumbers []*types.PhoneNumber + // The list of SIP addresses for the contact. SipAddresses []*types.SipAddress } diff --git a/service/alexaforbusiness/api_op_CreateGatewayGroup.go b/service/alexaforbusiness/api_op_CreateGatewayGroup.go index 62b27ba0df8..e668b69a500 100644 --- a/service/alexaforbusiness/api_op_CreateGatewayGroup.go +++ b/service/alexaforbusiness/api_op_CreateGatewayGroup.go @@ -58,18 +58,18 @@ func (c *Client) CreateGatewayGroup(ctx context.Context, params *CreateGatewayGr type CreateGatewayGroupInput struct { - // The description of the gateway group. - Description *string + // A unique, user-specified identifier for the request that ensures idempotency. + // + // This member is required. + ClientRequestToken *string // The name of the gateway group. // // This member is required. Name *string - // A unique, user-specified identifier for the request that ensures idempotency. - // - // This member is required. - ClientRequestToken *string + // The description of the gateway group. + Description *string } type CreateGatewayGroupOutput struct { diff --git a/service/alexaforbusiness/api_op_CreateNetworkProfile.go b/service/alexaforbusiness/api_op_CreateNetworkProfile.go index 45228266f4e..58e1e3bbe39 100644 --- a/service/alexaforbusiness/api_op_CreateNetworkProfile.go +++ b/service/alexaforbusiness/api_op_CreateNetworkProfile.go @@ -59,26 +59,15 @@ func (c *Client) CreateNetworkProfile(ctx context.Context, params *CreateNetwork type CreateNetworkProfileInput struct { - // The authentication standard that is used in the EAP framework. Currently, - // EAP_TLS is supported. - EapMethod types.NetworkEapMethod - - // Detailed information about a device's network profile. - Description *string - - // The root certificates of your authentication server that is installed on your - // devices and used to trust your authentication server during EAP negotiation. - TrustAnchors []*string - - // The next, or subsequent, password of the Wi-Fi network. This password is - // asynchronously transmitted to the device and is used when the password of the - // network changes to NextPassword. - NextPassword *string + // A unique, user-specified identifier for the request that ensures idempotency. + // + // This member is required. + ClientRequestToken *string - // The SSID of the Wi-Fi network. + // The name of the network profile associated with a device. // // This member is required. - Ssid *string + NetworkProfileName *string // The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, // WPA_PSK, WEP, or OPEN. @@ -86,6 +75,11 @@ type CreateNetworkProfileInput struct { // This member is required. SecurityType types.NetworkSecurityType + // The SSID of the Wi-Fi network. + // + // This member is required. + Ssid *string + // The ARN of the Private Certificate Authority (PCA) created in AWS Certificate // Manager (ACM). This is used to issue certificates to the devices. CertificateAuthorityArn *string @@ -93,15 +87,21 @@ type CreateNetworkProfileInput struct { // The current password of the Wi-Fi network. CurrentPassword *string - // The name of the network profile associated with a device. - // - // This member is required. - NetworkProfileName *string + // Detailed information about a device's network profile. + Description *string - // A unique, user-specified identifier for the request that ensures idempotency. - // - // This member is required. - ClientRequestToken *string + // The authentication standard that is used in the EAP framework. Currently, + // EAP_TLS is supported. + EapMethod types.NetworkEapMethod + + // The next, or subsequent, password of the Wi-Fi network. This password is + // asynchronously transmitted to the device and is used when the password of the + // network changes to NextPassword. + NextPassword *string + + // The root certificates of your authentication server that is installed on your + // devices and used to trust your authentication server during EAP negotiation. + TrustAnchors []*string } type CreateNetworkProfileOutput struct { diff --git a/service/alexaforbusiness/api_op_CreateProfile.go b/service/alexaforbusiness/api_op_CreateProfile.go index 8da68448035..cda78c9a46e 100644 --- a/service/alexaforbusiness/api_op_CreateProfile.go +++ b/service/alexaforbusiness/api_op_CreateProfile.go @@ -59,11 +59,15 @@ func (c *Client) CreateProfile(ctx context.Context, params *CreateProfileInput, type CreateProfileInput struct { - // The tags for the profile. - Tags []*types.Tag + // The valid address for the room. + // + // This member is required. + Address *string - // The user-specified token that is used during the creation of a profile. - ClientRequestToken *string + // The distance unit to be used by devices in the profile. + // + // This member is required. + DistanceUnit types.DistanceUnit // The name of a room profile. // @@ -75,21 +79,18 @@ type CreateProfileInput struct { // This member is required. TemperatureUnit types.TemperatureUnit - // The meeting room settings of a room profile. - MeetingRoomConfiguration *types.CreateMeetingRoomConfiguration - - // The valid address for the room. + // The time zone used by a room profile. // // This member is required. - Address *string - - // Whether PSTN calling is enabled. - PSTNEnabled *bool + Timezone *string - // The time zone used by a room profile. + // A wake word for Alexa, Echo, Amazon, or a computer. // // This member is required. - Timezone *string + WakeWord types.WakeWord + + // The user-specified token that is used during the creation of a profile. + ClientRequestToken *string // The locale of the room profile. (This is currently only available to a limited // preview audience.) @@ -98,18 +99,17 @@ type CreateProfileInput struct { // The maximum volume limit for a room profile. MaxVolumeLimit *int32 + // The meeting room settings of a room profile. + MeetingRoomConfiguration *types.CreateMeetingRoomConfiguration + + // Whether PSTN calling is enabled. + PSTNEnabled *bool + // Whether room profile setup is enabled. SetupModeDisabled *bool - // The distance unit to be used by devices in the profile. - // - // This member is required. - DistanceUnit types.DistanceUnit - - // A wake word for Alexa, Echo, Amazon, or a computer. - // - // This member is required. - WakeWord types.WakeWord + // The tags for the profile. + Tags []*types.Tag } type CreateProfileOutput struct { diff --git a/service/alexaforbusiness/api_op_CreateRoom.go b/service/alexaforbusiness/api_op_CreateRoom.go index 80d4cdcfb1c..a675c895d80 100644 --- a/service/alexaforbusiness/api_op_CreateRoom.go +++ b/service/alexaforbusiness/api_op_CreateRoom.go @@ -59,9 +59,6 @@ func (c *Client) CreateRoom(ctx context.Context, params *CreateRoomInput, optFns type CreateRoomInput struct { - // The calendar ARN for the room. - ProviderCalendarId *string - // The name for the room. // // This member is required. @@ -70,11 +67,14 @@ type CreateRoomInput struct { // A unique, user-specified identifier for this request that ensures idempotency. ClientRequestToken *string + // The description for the room. + Description *string + // The profile ARN for the room. This is required. ProfileArn *string - // The description for the room. - Description *string + // The calendar ARN for the room. + ProviderCalendarId *string // The tags for the room. Tags []*types.Tag diff --git a/service/alexaforbusiness/api_op_CreateSkillGroup.go b/service/alexaforbusiness/api_op_CreateSkillGroup.go index ad9334135a1..0939d36a23f 100644 --- a/service/alexaforbusiness/api_op_CreateSkillGroup.go +++ b/service/alexaforbusiness/api_op_CreateSkillGroup.go @@ -59,9 +59,6 @@ func (c *Client) CreateSkillGroup(ctx context.Context, params *CreateSkillGroupI type CreateSkillGroupInput struct { - // The description for the skill group. - Description *string - // The name for the skill group. // // This member is required. @@ -70,6 +67,9 @@ type CreateSkillGroupInput struct { // A unique, user-specified identifier for this request that ensures idempotency. ClientRequestToken *string + // The description for the skill group. + Description *string + // The tags for the skill group. Tags []*types.Tag } diff --git a/service/alexaforbusiness/api_op_CreateUser.go b/service/alexaforbusiness/api_op_CreateUser.go index 58ee74f19fd..44c28a20c4f 100644 --- a/service/alexaforbusiness/api_op_CreateUser.go +++ b/service/alexaforbusiness/api_op_CreateUser.go @@ -64,20 +64,20 @@ type CreateUserInput struct { // This member is required. UserId *string - // The tags for the user. - Tags []*types.Tag - // A unique, user-specified identifier for this request that ensures idempotency. ClientRequestToken *string - // The first name for the user. - FirstName *string - // The email address for the user. Email *string + // The first name for the user. + FirstName *string + // The last name for the user. LastName *string + + // The tags for the user. + Tags []*types.Tag } type CreateUserOutput struct { diff --git a/service/alexaforbusiness/api_op_DeleteRoomSkillParameter.go b/service/alexaforbusiness/api_op_DeleteRoomSkillParameter.go index 83b6c8c956e..0fda2f22af0 100644 --- a/service/alexaforbusiness/api_op_DeleteRoomSkillParameter.go +++ b/service/alexaforbusiness/api_op_DeleteRoomSkillParameter.go @@ -56,15 +56,15 @@ func (c *Client) DeleteRoomSkillParameter(ctx context.Context, params *DeleteRoo type DeleteRoomSkillParameterInput struct { - // The ID of the skill from which to remove the room skill parameter details. + // The room skill parameter key for which to remove details. // // This member is required. - SkillId *string + ParameterKey *string - // The room skill parameter key for which to remove details. + // The ID of the skill from which to remove the room skill parameter details. // // This member is required. - ParameterKey *string + SkillId *string // The ARN of the room from which to remove the room skill parameter details. RoomArn *string diff --git a/service/alexaforbusiness/api_op_DisassociateSkillGroupFromRoom.go b/service/alexaforbusiness/api_op_DisassociateSkillGroupFromRoom.go index 99d7bf90b6c..0a28098255a 100644 --- a/service/alexaforbusiness/api_op_DisassociateSkillGroupFromRoom.go +++ b/service/alexaforbusiness/api_op_DisassociateSkillGroupFromRoom.go @@ -56,11 +56,11 @@ func (c *Client) DisassociateSkillGroupFromRoom(ctx context.Context, params *Dis type DisassociateSkillGroupFromRoomInput struct { - // The ARN of the skill group to disassociate from a room. Required. - SkillGroupArn *string - // The ARN of the room from which the skill group is to be disassociated. Required. RoomArn *string + + // The ARN of the skill group to disassociate from a room. Required. + SkillGroupArn *string } type DisassociateSkillGroupFromRoomOutput struct { diff --git a/service/alexaforbusiness/api_op_GetInvitationConfiguration.go b/service/alexaforbusiness/api_op_GetInvitationConfiguration.go index 41deea65853..6041e510862 100644 --- a/service/alexaforbusiness/api_op_GetInvitationConfiguration.go +++ b/service/alexaforbusiness/api_op_GetInvitationConfiguration.go @@ -63,13 +63,13 @@ type GetInvitationConfigurationOutput struct { // can use. ContactEmail *string + // The name of the organization sending the enrollment invite to a user. + OrganizationName *string + // The list of private skill IDs that you want to recommend to the user to enable // in the invitation. PrivateSkillIds []*string - // The name of the organization sending the enrollment invite to a user. - OrganizationName *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/alexaforbusiness/api_op_ListBusinessReportSchedules.go b/service/alexaforbusiness/api_op_ListBusinessReportSchedules.go index 4ae504f3533..3ed8263a8be 100644 --- a/service/alexaforbusiness/api_op_ListBusinessReportSchedules.go +++ b/service/alexaforbusiness/api_op_ListBusinessReportSchedules.go @@ -58,11 +58,11 @@ func (c *Client) ListBusinessReportSchedules(ctx context.Context, params *ListBu type ListBusinessReportSchedulesInput struct { - // The token used to list the remaining schedules from the previous API call. - NextToken *string - // The maximum number of schedules listed in the call. MaxResults *int32 + + // The token used to list the remaining schedules from the previous API call. + NextToken *string } type ListBusinessReportSchedulesOutput struct { diff --git a/service/alexaforbusiness/api_op_ListConferenceProviders.go b/service/alexaforbusiness/api_op_ListConferenceProviders.go index 7e1bc603044..adfd7a4a8c8 100644 --- a/service/alexaforbusiness/api_op_ListConferenceProviders.go +++ b/service/alexaforbusiness/api_op_ListConferenceProviders.go @@ -56,21 +56,21 @@ func (c *Client) ListConferenceProviders(ctx context.Context, params *ListConfer type ListConferenceProvidersInput struct { - // The tokens used for pagination. - NextToken *string - // The maximum number of conference providers to be returned, per paginated calls. MaxResults *int32 -} - -type ListConferenceProvidersOutput struct { // The tokens used for pagination. NextToken *string +} + +type ListConferenceProvidersOutput struct { // The conference providers. ConferenceProviders []*types.ConferenceProvider + // The tokens used for pagination. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/alexaforbusiness/api_op_ListDeviceEvents.go b/service/alexaforbusiness/api_op_ListDeviceEvents.go index 541755e3690..81461905bd3 100644 --- a/service/alexaforbusiness/api_op_ListDeviceEvents.go +++ b/service/alexaforbusiness/api_op_ListDeviceEvents.go @@ -58,6 +58,11 @@ func (c *Client) ListDeviceEvents(ctx context.Context, params *ListDeviceEventsI type ListDeviceEventsInput struct { + // The ARN of a device. + // + // This member is required. + DeviceArn *string + // The event type to filter device events. If EventType isn't specified, this // returns a list of all device events in reverse chronological order. If EventType // is specified, this returns a list of device events for that EventType in reverse @@ -74,21 +79,16 @@ type ListDeviceEventsInput struct { // includes results beyond the token, up to the value specified by MaxResults. When // the end of results is reached, the response has a value of null. NextToken *string - - // The ARN of a device. - // - // This member is required. - DeviceArn *string } type ListDeviceEventsOutput struct { - // The token returned to indicate that there is more data available. - NextToken *string - // The device events requested for the device ARN. DeviceEvents []*types.DeviceEvent + // The token returned to indicate that there is more data available. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/alexaforbusiness/api_op_ListGatewayGroups.go b/service/alexaforbusiness/api_op_ListGatewayGroups.go index ac39a942dab..b97972054f7 100644 --- a/service/alexaforbusiness/api_op_ListGatewayGroups.go +++ b/service/alexaforbusiness/api_op_ListGatewayGroups.go @@ -57,21 +57,21 @@ func (c *Client) ListGatewayGroups(ctx context.Context, params *ListGatewayGroup type ListGatewayGroupsInput struct { - // The token used to paginate though multiple pages of gateway group summaries. - NextToken *string - // The maximum number of gateway group summaries to return. The default is 50. MaxResults *int32 -} - -type ListGatewayGroupsOutput struct { // The token used to paginate though multiple pages of gateway group summaries. NextToken *string +} + +type ListGatewayGroupsOutput struct { // The gateway groups in the list. GatewayGroups []*types.GatewayGroupSummary + // The token used to paginate though multiple pages of gateway group summaries. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/alexaforbusiness/api_op_ListGateways.go b/service/alexaforbusiness/api_op_ListGateways.go index 9e5f468bdc7..6f44dcc7543 100644 --- a/service/alexaforbusiness/api_op_ListGateways.go +++ b/service/alexaforbusiness/api_op_ListGateways.go @@ -58,14 +58,14 @@ func (c *Client) ListGateways(ctx context.Context, params *ListGatewaysInput, op type ListGatewaysInput struct { - // The token used to paginate though multiple pages of gateway summaries. - NextToken *string - // The gateway group ARN for which to list gateways. GatewayGroupArn *string // The maximum number of gateway summaries to return. The default is 50. MaxResults *int32 + + // The token used to paginate though multiple pages of gateway summaries. + NextToken *string } type ListGatewaysOutput struct { diff --git a/service/alexaforbusiness/api_op_ListSkills.go b/service/alexaforbusiness/api_op_ListSkills.go index a59c53eac7c..16113ef386b 100644 --- a/service/alexaforbusiness/api_op_ListSkills.go +++ b/service/alexaforbusiness/api_op_ListSkills.go @@ -56,24 +56,24 @@ func (c *Client) ListSkills(ctx context.Context, params *ListSkillsInput, optFns type ListSkillsInput struct { - // The ARN of the skill group for which to list enabled skills. - SkillGroupArn *string - - // Whether the skill is publicly available or is a private skill. - SkillType types.SkillTypeFilter - // Whether the skill is enabled under the user's account. EnablementType types.EnablementTypeFilter + // The maximum number of results to include in the response. If more results exist + // than the specified MaxResults value, a token is included in the response so that + // the remaining results can be retrieved. + MaxResults *int32 + // An optional token returned from a prior request. Use this token for pagination // of results from this action. If this parameter is specified, the response // includes only results beyond the token, up to the value specified by MaxResults. NextToken *string - // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. - MaxResults *int32 + // The ARN of the skill group for which to list enabled skills. + SkillGroupArn *string + + // Whether the skill is publicly available or is a private skill. + SkillType types.SkillTypeFilter } type ListSkillsOutput struct { diff --git a/service/alexaforbusiness/api_op_ListSkillsStoreSkillsByCategory.go b/service/alexaforbusiness/api_op_ListSkillsStoreSkillsByCategory.go index 21949785ce6..b8341681817 100644 --- a/service/alexaforbusiness/api_op_ListSkillsStoreSkillsByCategory.go +++ b/service/alexaforbusiness/api_op_ListSkillsStoreSkillsByCategory.go @@ -62,21 +62,21 @@ type ListSkillsStoreSkillsByCategoryInput struct { // This member is required. CategoryId *int64 - // The tokens used for pagination. - NextToken *string - // The maximum number of skills returned per paginated calls. MaxResults *int32 + + // The tokens used for pagination. + NextToken *string } type ListSkillsStoreSkillsByCategoryOutput struct { - // The skill store skills. - SkillsStoreSkills []*types.SkillsStoreSkill - // The tokens used for pagination. NextToken *string + // The skill store skills. + SkillsStoreSkills []*types.SkillsStoreSkill + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/alexaforbusiness/api_op_ListSmartHomeAppliances.go b/service/alexaforbusiness/api_op_ListSmartHomeAppliances.go index f6dc7592e99..667dfbe1e14 100644 --- a/service/alexaforbusiness/api_op_ListSmartHomeAppliances.go +++ b/service/alexaforbusiness/api_op_ListSmartHomeAppliances.go @@ -57,26 +57,26 @@ func (c *Client) ListSmartHomeAppliances(ctx context.Context, params *ListSmartH type ListSmartHomeAppliancesInput struct { - // The tokens used for pagination. - NextToken *string - - // The maximum number of appliances to be returned, per paginated calls. - MaxResults *int32 - // The room that the appliances are associated with. // // This member is required. RoomArn *string + + // The maximum number of appliances to be returned, per paginated calls. + MaxResults *int32 + + // The tokens used for pagination. + NextToken *string } type ListSmartHomeAppliancesOutput struct { - // The smart home appliances. - SmartHomeAppliances []*types.SmartHomeAppliance - // The tokens used for pagination. NextToken *string + // The smart home appliances. + SmartHomeAppliances []*types.SmartHomeAppliance + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/alexaforbusiness/api_op_ListTags.go b/service/alexaforbusiness/api_op_ListTags.go index 68e42320fdc..9dc91b7b49f 100644 --- a/service/alexaforbusiness/api_op_ListTags.go +++ b/service/alexaforbusiness/api_op_ListTags.go @@ -57,30 +57,30 @@ func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ... type ListTagsInput struct { - // An optional token returned from a prior request. Use this token for pagination - // of results from this action. If this parameter is specified, the response - // includes only results beyond the token, up to the value specified by MaxResults. - NextToken *string + // The ARN of the specified resource for which to list tags. + // + // This member is required. + Arn *string // The maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so that // the remaining results can be retrieved. MaxResults *int32 - // The ARN of the specified resource for which to list tags. - // - // This member is required. - Arn *string + // An optional token returned from a prior request. Use this token for pagination + // of results from this action. If this parameter is specified, the response + // includes only results beyond the token, up to the value specified by MaxResults. + NextToken *string } type ListTagsOutput struct { - // The tags requested for the specified resource. - Tags []*types.Tag - // The token returned to indicate that there is more data available. NextToken *string + // The tags requested for the specified resource. + Tags []*types.Tag + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/alexaforbusiness/api_op_PutInvitationConfiguration.go b/service/alexaforbusiness/api_op_PutInvitationConfiguration.go index cc99a8e535c..ad5c770f9f5 100644 --- a/service/alexaforbusiness/api_op_PutInvitationConfiguration.go +++ b/service/alexaforbusiness/api_op_PutInvitationConfiguration.go @@ -62,13 +62,13 @@ type PutInvitationConfigurationInput struct { // This member is required. OrganizationName *string - // The list of private skill IDs that you want to recommend to the user to enable - // in the invitation. - PrivateSkillIds []*string - // The email ID of the organization or individual contact that the enrolled user // can use. ContactEmail *string + + // The list of private skill IDs that you want to recommend to the user to enable + // in the invitation. + PrivateSkillIds []*string } type PutInvitationConfigurationOutput struct { diff --git a/service/alexaforbusiness/api_op_PutRoomSkillParameter.go b/service/alexaforbusiness/api_op_PutRoomSkillParameter.go index 10d22ba2166..65dc03a1e9c 100644 --- a/service/alexaforbusiness/api_op_PutRoomSkillParameter.go +++ b/service/alexaforbusiness/api_op_PutRoomSkillParameter.go @@ -58,9 +58,6 @@ func (c *Client) PutRoomSkillParameter(ctx context.Context, params *PutRoomSkill type PutRoomSkillParameterInput struct { - // The ARN of the room associated with the room skill parameter. Required. - RoomArn *string - // The updated room skill parameter. Required. // // This member is required. @@ -70,6 +67,9 @@ type PutRoomSkillParameterInput struct { // // This member is required. SkillId *string + + // The ARN of the room associated with the room skill parameter. Required. + RoomArn *string } type PutRoomSkillParameterOutput struct { diff --git a/service/alexaforbusiness/api_op_PutSkillAuthorization.go b/service/alexaforbusiness/api_op_PutSkillAuthorization.go index ee91af31de7..44fb6099e16 100644 --- a/service/alexaforbusiness/api_op_PutSkillAuthorization.go +++ b/service/alexaforbusiness/api_op_PutSkillAuthorization.go @@ -58,6 +58,12 @@ func (c *Client) PutSkillAuthorization(ctx context.Context, params *PutSkillAuth type PutSkillAuthorizationInput struct { + // The authorization result specific to OAUTH code grant output. "Code” must be + // populated in the AuthorizationResult map to establish the authorization. + // + // This member is required. + AuthorizationResult map[string]*string + // The unique identifier of a skill. // // This member is required. @@ -65,12 +71,6 @@ type PutSkillAuthorizationInput struct { // The room that the skill is authorized for. RoomArn *string - - // The authorization result specific to OAUTH code grant output. "Code” must be - // populated in the AuthorizationResult map to establish the authorization. - // - // This member is required. - AuthorizationResult map[string]*string } type PutSkillAuthorizationOutput struct { diff --git a/service/alexaforbusiness/api_op_RegisterAVSDevice.go b/service/alexaforbusiness/api_op_RegisterAVSDevice.go index e126a5b4bd4..fd530876e56 100644 --- a/service/alexaforbusiness/api_op_RegisterAVSDevice.go +++ b/service/alexaforbusiness/api_op_RegisterAVSDevice.go @@ -63,8 +63,11 @@ type RegisterAVSDeviceInput struct { // This member is required. AmazonId *string - // The ARN of the room with which to associate your AVS device. - RoomArn *string + // The client ID of the OEM used for code-based linking authorization on an AVS + // device. + // + // This member is required. + ClientId *string // The product ID used to identify your AVS device during authorization. // @@ -78,15 +81,12 @@ type RegisterAVSDeviceInput struct { // This member is required. UserCode *string - // The client ID of the OEM used for code-based linking authorization on an AVS - // device. - // - // This member is required. - ClientId *string - // The key generated by the OEM that uniquely identifies a specified instance of // your AVS device. DeviceSerialNumber *string + + // The ARN of the room with which to associate your AVS device. + RoomArn *string } type RegisterAVSDeviceOutput struct { diff --git a/service/alexaforbusiness/api_op_ResolveRoom.go b/service/alexaforbusiness/api_op_ResolveRoom.go index 00269699fcb..40830eb8870 100644 --- a/service/alexaforbusiness/api_op_ResolveRoom.go +++ b/service/alexaforbusiness/api_op_ResolveRoom.go @@ -71,12 +71,12 @@ type ResolveRoomInput struct { type ResolveRoomOutput struct { - // The name of the room from which the skill request was invoked. - RoomName *string - // The ARN of the room from which the skill request was invoked. RoomArn *string + // The name of the room from which the skill request was invoked. + RoomName *string + // Response to get the room profile request. Required. RoomSkillParameters []*types.RoomSkillParameter diff --git a/service/alexaforbusiness/api_op_SearchAddressBooks.go b/service/alexaforbusiness/api_op_SearchAddressBooks.go index 6a37abe2620..bc0c54790a8 100644 --- a/service/alexaforbusiness/api_op_SearchAddressBooks.go +++ b/service/alexaforbusiness/api_op_SearchAddressBooks.go @@ -58,33 +58,33 @@ func (c *Client) SearchAddressBooks(ctx context.Context, params *SearchAddressBo type SearchAddressBooksInput struct { - // An optional token returned from a prior request. Use this token for pagination - // of results from this action. If this parameter is specified, the response only - // includes results beyond the token, up to the value specified by MaxResults. - NextToken *string - // The filters to use to list a specified set of address books. The supported // filter key is AddressBookName. Filters []*types.Filter - // The sort order to use in listing the specified set of address books. The - // supported sort key is AddressBookName. - SortCriteria []*types.Sort - // The maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so that // the remaining results can be retrieved. MaxResults *int32 + + // An optional token returned from a prior request. Use this token for pagination + // of results from this action. If this parameter is specified, the response only + // includes results beyond the token, up to the value specified by MaxResults. + NextToken *string + + // The sort order to use in listing the specified set of address books. The + // supported sort key is AddressBookName. + SortCriteria []*types.Sort } type SearchAddressBooksOutput struct { - // The token returned to indicate that there is more data available. - NextToken *string - // The address books that meet the specified set of filter criteria, in sort order. AddressBooks []*types.AddressBookData + // The token returned to indicate that there is more data available. + NextToken *string + // The total number of address books returned. TotalCount *int32 diff --git a/service/alexaforbusiness/api_op_SearchContacts.go b/service/alexaforbusiness/api_op_SearchContacts.go index a1a22829f30..dcb2970808d 100644 --- a/service/alexaforbusiness/api_op_SearchContacts.go +++ b/service/alexaforbusiness/api_op_SearchContacts.go @@ -58,23 +58,23 @@ func (c *Client) SearchContacts(ctx context.Context, params *SearchContactsInput type SearchContactsInput struct { - // The sort order to use in listing the specified set of contacts. The supported - // sort keys are DisplayName, FirstName, and LastName. - SortCriteria []*types.Sort - - // An optional token returned from a prior request. Use this token for pagination - // of results from this action. If this parameter is specified, the response only - // includes results beyond the token, up to the value specified by MaxResults. - NextToken *string + // The filters to use to list a specified set of address books. The supported + // filter keys are DisplayName, FirstName, LastName, and AddressBookArns. + Filters []*types.Filter // The maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so that // the remaining results can be retrieved. MaxResults *int32 - // The filters to use to list a specified set of address books. The supported - // filter keys are DisplayName, FirstName, LastName, and AddressBookArns. - Filters []*types.Filter + // An optional token returned from a prior request. Use this token for pagination + // of results from this action. If this parameter is specified, the response only + // includes results beyond the token, up to the value specified by MaxResults. + NextToken *string + + // The sort order to use in listing the specified set of contacts. The supported + // sort keys are DisplayName, FirstName, and LastName. + SortCriteria []*types.Sort } type SearchContactsOutput struct { diff --git a/service/alexaforbusiness/api_op_SearchDevices.go b/service/alexaforbusiness/api_op_SearchDevices.go index fa1bc2e9f02..755412459ea 100644 --- a/service/alexaforbusiness/api_op_SearchDevices.go +++ b/service/alexaforbusiness/api_op_SearchDevices.go @@ -57,11 +57,11 @@ func (c *Client) SearchDevices(ctx context.Context, params *SearchDevicesInput, type SearchDevicesInput struct { - // The sort order to use in listing the specified set of devices. Supported sort - // keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, - // ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and - // FailureCode. - SortCriteria []*types.Sort + // The filters to use to list a specified set of devices. Supported filter keys are + // DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, + // DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), + // NetworkProfileName, NetworkProfileArn, Feature, and FailureCode. + Filters []*types.Filter // The maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so that @@ -73,11 +73,11 @@ type SearchDevicesInput struct { // includes only results beyond the token, up to the value specified by MaxResults. NextToken *string - // The filters to use to list a specified set of devices. Supported filter keys are - // DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, - // DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), - // NetworkProfileName, NetworkProfileArn, Feature, and FailureCode. - Filters []*types.Filter + // The sort order to use in listing the specified set of devices. Supported sort + // keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, + // ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and + // FailureCode. + SortCriteria []*types.Sort } type SearchDevicesOutput struct { diff --git a/service/alexaforbusiness/api_op_SearchNetworkProfiles.go b/service/alexaforbusiness/api_op_SearchNetworkProfiles.go index 8a432002981..6f9bcd5881a 100644 --- a/service/alexaforbusiness/api_op_SearchNetworkProfiles.go +++ b/service/alexaforbusiness/api_op_SearchNetworkProfiles.go @@ -58,27 +58,31 @@ func (c *Client) SearchNetworkProfiles(ctx context.Context, params *SearchNetwor type SearchNetworkProfilesInput struct { - // The sort order to use to list the specified set of network profiles. Valid sort - // criteria includes NetworkProfileName, Ssid, and SecurityType. - SortCriteria []*types.Sort - // The filters to use to list a specified set of network profiles. Valid filters // are NetworkProfileName, Ssid, and SecurityType. Filters []*types.Filter + // The maximum number of results to include in the response. If more results exist + // than the specified MaxResults value, a token is included in the response so that + // the remaining results can be retrieved. + MaxResults *int32 + // An optional token returned from a prior request. Use this token for pagination // of results from this action. If this parameter is specified, the response // includes only results beyond the token, up to the value specified by MaxResults. NextToken *string - // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. - MaxResults *int32 + // The sort order to use to list the specified set of network profiles. Valid sort + // criteria includes NetworkProfileName, Ssid, and SecurityType. + SortCriteria []*types.Sort } type SearchNetworkProfilesOutput struct { + // The network profiles that meet the specified set of filter criteria, in sort + // order. It is a list of NetworkProfileData objects. + NetworkProfiles []*types.NetworkProfileData + // An optional token returned from a prior request. Use this token for pagination // of results from this action. If this parameter is specified, the response // includes only results beyond the token, up to the value specified by MaxResults. @@ -87,10 +91,6 @@ type SearchNetworkProfilesOutput struct { // The total number of network profiles returned. TotalCount *int32 - // The network profiles that meet the specified set of filter criteria, in sort - // order. It is a list of NetworkProfileData objects. - NetworkProfiles []*types.NetworkProfileData - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/alexaforbusiness/api_op_SearchProfiles.go b/service/alexaforbusiness/api_op_SearchProfiles.go index de78294f110..cdb5fed5738 100644 --- a/service/alexaforbusiness/api_op_SearchProfiles.go +++ b/service/alexaforbusiness/api_op_SearchProfiles.go @@ -61,10 +61,6 @@ type SearchProfilesInput struct { // keys are ProfileName and Address. Required. Filters []*types.Filter - // The sort order to use in listing the specified set of room profiles. Supported - // sort keys are ProfileName and Address. - SortCriteria []*types.Sort - // The maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so that // the remaining results can be retrieved. @@ -74,6 +70,10 @@ type SearchProfilesInput struct { // of results from this action. If this parameter is specified, the response // includes only results beyond the token, up to the value specified by MaxResults. NextToken *string + + // The sort order to use in listing the specified set of room profiles. Supported + // sort keys are ProfileName and Address. + SortCriteria []*types.Sort } type SearchProfilesOutput struct { @@ -81,12 +81,12 @@ type SearchProfilesOutput struct { // The token returned to indicate that there is more data available. NextToken *string - // The total number of room profiles returned. - TotalCount *int32 - // The profiles that meet the specified set of filter criteria, in sort order. Profiles []*types.ProfileData + // The total number of room profiles returned. + TotalCount *int32 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/alexaforbusiness/api_op_SearchRooms.go b/service/alexaforbusiness/api_op_SearchRooms.go index 73156820975..01cea132528 100644 --- a/service/alexaforbusiness/api_op_SearchRooms.go +++ b/service/alexaforbusiness/api_op_SearchRooms.go @@ -57,15 +57,15 @@ func (c *Client) SearchRooms(ctx context.Context, params *SearchRoomsInput, optF type SearchRoomsInput struct { + // The filters to use to list a specified set of rooms. The supported filter keys + // are RoomName and ProfileName. + Filters []*types.Filter + // The maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so that // the remaining results can be retrieved. MaxResults *int32 - // The filters to use to list a specified set of rooms. The supported filter keys - // are RoomName and ProfileName. - Filters []*types.Filter - // An optional token returned from a prior request. Use this token for pagination // of results from this action. If this parameter is specified, the response // includes only results beyond the token, up to the value specified by MaxResults. @@ -81,12 +81,12 @@ type SearchRoomsOutput struct { // The token returned to indicate that there is more data available. NextToken *string - // The total number of rooms returned. - TotalCount *int32 - // The rooms that meet the specified set of filter criteria, in sort order. Rooms []*types.RoomData + // The total number of rooms returned. + TotalCount *int32 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/alexaforbusiness/api_op_SearchSkillGroups.go b/service/alexaforbusiness/api_op_SearchSkillGroups.go index 0cfeb50d7e8..7df8f22919b 100644 --- a/service/alexaforbusiness/api_op_SearchSkillGroups.go +++ b/service/alexaforbusiness/api_op_SearchSkillGroups.go @@ -62,9 +62,10 @@ type SearchSkillGroupsInput struct { // key is SkillGroupName. Filters []*types.Filter - // The sort order to use in listing the specified set of skill groups. The - // supported sort key is SkillGroupName. - SortCriteria []*types.Sort + // The maximum number of results to include in the response. If more results exist + // than the specified MaxResults value, a token is included in the response so that + // the remaining results can be retrieved. + MaxResults *int32 // An optional token returned from a prior request. Use this token for pagination // of results from this action. If this parameter is specified, the response @@ -72,22 +73,21 @@ type SearchSkillGroupsInput struct { // Required. NextToken *string - // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. - MaxResults *int32 + // The sort order to use in listing the specified set of skill groups. The + // supported sort key is SkillGroupName. + SortCriteria []*types.Sort } type SearchSkillGroupsOutput struct { - // The total number of skill groups returned. - TotalCount *int32 + // The token returned to indicate that there is more data available. + NextToken *string // The skill groups that meet the filter criteria, in sort order. SkillGroups []*types.SkillGroupData - // The token returned to indicate that there is more data available. - NextToken *string + // The total number of skill groups returned. + TotalCount *int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/alexaforbusiness/api_op_SearchUsers.go b/service/alexaforbusiness/api_op_SearchUsers.go index c178d077e68..05b39f8870f 100644 --- a/service/alexaforbusiness/api_op_SearchUsers.go +++ b/service/alexaforbusiness/api_op_SearchUsers.go @@ -57,6 +57,15 @@ func (c *Client) SearchUsers(ctx context.Context, params *SearchUsersInput, optF type SearchUsersInput struct { + // The filters to use for listing a specific set of users. Required. Supported + // filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus. + Filters []*types.Filter + + // The maximum number of results to include in the response. If more results exist + // than the specified MaxResults value, a token is included in the response so that + // the remaining results can be retrieved. Required. + MaxResults *int32 + // An optional token returned from a prior request. Use this token for pagination // of results from this action. If this parameter is specified, the response // includes only results beyond the token, up to the value specified by MaxResults. @@ -66,28 +75,19 @@ type SearchUsersInput struct { // The sort order to use in listing the filtered set of users. Required. Supported // sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus. SortCriteria []*types.Sort - - // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. Required. - MaxResults *int32 - - // The filters to use for listing a specific set of users. Required. Supported - // filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus. - Filters []*types.Filter } type SearchUsersOutput struct { - // The users that meet the specified set of filter criteria, in sort order. - Users []*types.UserData - // The token returned to indicate that there is more data available. NextToken *string // The total number of users returned. TotalCount *int32 + // The users that meet the specified set of filter criteria, in sort order. + Users []*types.UserData + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/alexaforbusiness/api_op_SendAnnouncement.go b/service/alexaforbusiness/api_op_SendAnnouncement.go index 45c31bd3863..3b810817ce2 100644 --- a/service/alexaforbusiness/api_op_SendAnnouncement.go +++ b/service/alexaforbusiness/api_op_SendAnnouncement.go @@ -60,9 +60,10 @@ func (c *Client) SendAnnouncement(ctx context.Context, params *SendAnnouncementI type SendAnnouncementInput struct { - // The time to live for an announcement. Default is 300. If delivery doesn't occur - // within this time, the announcement is not delivered. - TimeToLiveInSeconds *int32 + // The unique, user-specified identifier for the request that ensures idempotency. + // + // This member is required. + ClientRequestToken *string // The announcement content. This can contain only one of the three possible // announcement types (text, SSML or audio). @@ -70,17 +71,16 @@ type SendAnnouncementInput struct { // This member is required. Content *types.Content - // The unique, user-specified identifier for the request that ensures idempotency. - // - // This member is required. - ClientRequestToken *string - // The filters to use to send an announcement to a specified list of rooms. The // supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To // send to all rooms, specify an empty RoomFilters list. // // This member is required. RoomFilters []*types.Filter + + // The time to live for an announcement. Default is 300. If delivery doesn't occur + // within this time, the announcement is not delivered. + TimeToLiveInSeconds *int32 } type SendAnnouncementOutput struct { diff --git a/service/alexaforbusiness/api_op_StartDeviceSync.go b/service/alexaforbusiness/api_op_StartDeviceSync.go index b51cfc88032..976460758ce 100644 --- a/service/alexaforbusiness/api_op_StartDeviceSync.go +++ b/service/alexaforbusiness/api_op_StartDeviceSync.go @@ -75,16 +75,16 @@ func (c *Client) StartDeviceSync(ctx context.Context, params *StartDeviceSyncInp type StartDeviceSyncInput struct { - // The ARN of the room with which the device to sync is associated. Required. - RoomArn *string - - // The ARN of the device to sync. Required. - DeviceArn *string - // Request structure to start the device sync. Required. // // This member is required. Features []types.Feature + + // The ARN of the device to sync. Required. + DeviceArn *string + + // The ARN of the room with which the device to sync is associated. Required. + RoomArn *string } type StartDeviceSyncOutput struct { diff --git a/service/alexaforbusiness/api_op_UntagResource.go b/service/alexaforbusiness/api_op_UntagResource.go index 7821df2a529..05ebca27474 100644 --- a/service/alexaforbusiness/api_op_UntagResource.go +++ b/service/alexaforbusiness/api_op_UntagResource.go @@ -56,16 +56,16 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The tags to be removed from the specified resource. Do not provide system tags. - // Required. + // The ARN of the resource from which to remove metadata tags. Required. // // This member is required. - TagKeys []*string + Arn *string - // The ARN of the resource from which to remove metadata tags. Required. + // The tags to be removed from the specified resource. Do not provide system tags. + // Required. // // This member is required. - Arn *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/alexaforbusiness/api_op_UpdateAddressBook.go b/service/alexaforbusiness/api_op_UpdateAddressBook.go index cf7b2f80180..134e1fd8a62 100644 --- a/service/alexaforbusiness/api_op_UpdateAddressBook.go +++ b/service/alexaforbusiness/api_op_UpdateAddressBook.go @@ -56,16 +56,16 @@ func (c *Client) UpdateAddressBook(ctx context.Context, params *UpdateAddressBoo type UpdateAddressBookInput struct { - // The updated name of the room. - Name *string - - // The updated description of the room. - Description *string - // The ARN of the room to update. // // This member is required. AddressBookArn *string + + // The updated description of the room. + Description *string + + // The updated name of the room. + Name *string } type UpdateAddressBookOutput struct { diff --git a/service/alexaforbusiness/api_op_UpdateBusinessReportSchedule.go b/service/alexaforbusiness/api_op_UpdateBusinessReportSchedule.go index 32f0f69a827..65217353948 100644 --- a/service/alexaforbusiness/api_op_UpdateBusinessReportSchedule.go +++ b/service/alexaforbusiness/api_op_UpdateBusinessReportSchedule.go @@ -63,19 +63,19 @@ type UpdateBusinessReportScheduleInput struct { // This member is required. ScheduleArn *string - // The recurrence of the reports. - Recurrence *types.BusinessReportRecurrence - // The format of the generated report (individual CSV files or zipped files of // individual files). Format types.BusinessReportFormat - // The S3 key where the report is delivered. - S3KeyPrefix *string + // The recurrence of the reports. + Recurrence *types.BusinessReportRecurrence // The S3 location of the output reports. S3BucketName *string + // The S3 key where the report is delivered. + S3KeyPrefix *string + // The name identifier of the schedule. ScheduleName *string } diff --git a/service/alexaforbusiness/api_op_UpdateConferenceProvider.go b/service/alexaforbusiness/api_op_UpdateConferenceProvider.go index 0a28e85ae7e..4a2fec61fa2 100644 --- a/service/alexaforbusiness/api_op_UpdateConferenceProvider.go +++ b/service/alexaforbusiness/api_op_UpdateConferenceProvider.go @@ -62,18 +62,18 @@ type UpdateConferenceProviderInput struct { // This member is required. ConferenceProviderArn *string - // The IP endpoint and protocol for calling. - IPDialIn *types.IPDialIn + // The type of the conference provider. + // + // This member is required. + ConferenceProviderType types.ConferenceProviderType // The meeting settings for the conference provider. // // This member is required. MeetingSetting *types.MeetingSetting - // The type of the conference provider. - // - // This member is required. - ConferenceProviderType types.ConferenceProviderType + // The IP endpoint and protocol for calling. + IPDialIn *types.IPDialIn // The information for PSTN conferencing. PSTNDialIn *types.PSTNDialIn diff --git a/service/alexaforbusiness/api_op_UpdateContact.go b/service/alexaforbusiness/api_op_UpdateContact.go index 1bc7ab5d7d2..f10fa715284 100644 --- a/service/alexaforbusiness/api_op_UpdateContact.go +++ b/service/alexaforbusiness/api_op_UpdateContact.go @@ -57,30 +57,30 @@ func (c *Client) UpdateContact(ctx context.Context, params *UpdateContactInput, type UpdateContactInput struct { - // The list of SIP addresses for the contact. - SipAddresses []*types.SipAddress + // The ARN of the contact to update. + // + // This member is required. + ContactArn *string + + // The updated display name of the contact. + DisplayName *string // The updated first name of the contact. FirstName *string - // The list of phone numbers for the contact. - PhoneNumbers []*types.PhoneNumber - // The updated last name of the contact. LastName *string - // The updated display name of the contact. - DisplayName *string - // The updated phone number of the contact. The phone number type defaults to WORK. // You can either specify PhoneNumber or PhoneNumbers. We recommend that you use // PhoneNumbers, which lets you specify the phone number type and multiple numbers. PhoneNumber *string - // The ARN of the contact to update. - // - // This member is required. - ContactArn *string + // The list of phone numbers for the contact. + PhoneNumbers []*types.PhoneNumber + + // The list of SIP addresses for the contact. + SipAddresses []*types.SipAddress } type UpdateContactOutput struct { diff --git a/service/alexaforbusiness/api_op_UpdateGateway.go b/service/alexaforbusiness/api_op_UpdateGateway.go index 868a0c4cc8a..005e8ed988f 100644 --- a/service/alexaforbusiness/api_op_UpdateGateway.go +++ b/service/alexaforbusiness/api_op_UpdateGateway.go @@ -62,15 +62,15 @@ type UpdateGatewayInput struct { // This member is required. GatewayArn *string - // The updated software version of the gateway. The gateway automatically updates - // its software version during normal operation. - SoftwareVersion *string + // The updated description of the gateway. + Description *string // The updated name of the gateway. Name *string - // The updated description of the gateway. - Description *string + // The updated software version of the gateway. The gateway automatically updates + // its software version during normal operation. + SoftwareVersion *string } type UpdateGatewayOutput struct { diff --git a/service/alexaforbusiness/api_op_UpdateGatewayGroup.go b/service/alexaforbusiness/api_op_UpdateGatewayGroup.go index 4a54a48dfbb..c025037471c 100644 --- a/service/alexaforbusiness/api_op_UpdateGatewayGroup.go +++ b/service/alexaforbusiness/api_op_UpdateGatewayGroup.go @@ -62,11 +62,11 @@ type UpdateGatewayGroupInput struct { // This member is required. GatewayGroupArn *string - // The updated name of the gateway group. - Name *string - // The updated description of the gateway group. Description *string + + // The updated name of the gateway group. + Name *string } type UpdateGatewayGroupOutput struct { diff --git a/service/alexaforbusiness/api_op_UpdateNetworkProfile.go b/service/alexaforbusiness/api_op_UpdateNetworkProfile.go index 79e15016ba8..23e6e3dfc34 100644 --- a/service/alexaforbusiness/api_op_UpdateNetworkProfile.go +++ b/service/alexaforbusiness/api_op_UpdateNetworkProfile.go @@ -56,22 +56,6 @@ func (c *Client) UpdateNetworkProfile(ctx context.Context, params *UpdateNetwork type UpdateNetworkProfileInput struct { - // The root certificate(s) of your authentication server that will be installed on - // your devices and used to trust your authentication server during EAP - // negotiation. - TrustAnchors []*string - - // The next, or subsequent, password of the Wi-Fi network. This password is - // asynchronously transmitted to the device and is used when the password of the - // network changes to NextPassword. - NextPassword *string - - // Detailed information about a device's network profile. - Description *string - - // The name of the network profile associated with a device. - NetworkProfileName *string - // The ARN of the network profile associated with a device. // // This member is required. @@ -83,6 +67,22 @@ type UpdateNetworkProfileInput struct { // The current password of the Wi-Fi network. CurrentPassword *string + + // Detailed information about a device's network profile. + Description *string + + // The name of the network profile associated with a device. + NetworkProfileName *string + + // The next, or subsequent, password of the Wi-Fi network. This password is + // asynchronously transmitted to the device and is used when the password of the + // network changes to NextPassword. + NextPassword *string + + // The root certificate(s) of your authentication server that will be installed on + // your devices and used to trust your authentication server during EAP + // negotiation. + TrustAnchors []*string } type UpdateNetworkProfileOutput struct { diff --git a/service/alexaforbusiness/api_op_UpdateProfile.go b/service/alexaforbusiness/api_op_UpdateProfile.go index cfde70ed2d1..24262670090 100644 --- a/service/alexaforbusiness/api_op_UpdateProfile.go +++ b/service/alexaforbusiness/api_op_UpdateProfile.go @@ -56,46 +56,46 @@ func (c *Client) UpdateProfile(ctx context.Context, params *UpdateProfileInput, type UpdateProfileInput struct { - // The updated name for the room profile. - ProfileName *string + // The updated address for the room profile. + Address *string // The updated distance unit for the room profile. DistanceUnit types.DistanceUnit - // The updated temperature unit for the room profile. - TemperatureUnit types.TemperatureUnit + // Sets the profile as default if selected. If this is missing, no update is done + // to the default status. + IsDefault *bool // The updated locale for the room profile. (This is currently only available to a // limited preview audience.) Locale *string + // The updated maximum volume limit for the room profile. + MaxVolumeLimit *int32 + // The updated meeting room settings of a room profile. MeetingRoomConfiguration *types.UpdateMeetingRoomConfiguration - // The updated timezone for the room profile. - Timezone *string - - // Sets the profile as default if selected. If this is missing, no update is done - // to the default status. - IsDefault *bool + // Whether the PSTN setting of the room profile is enabled. + PSTNEnabled *bool // The ARN of the room profile to update. Required. ProfileArn *string - // The updated maximum volume limit for the room profile. - MaxVolumeLimit *int32 + // The updated name for the room profile. + ProfileName *string - // The updated address for the room profile. - Address *string + // Whether the setup mode of the profile is enabled. + SetupModeDisabled *bool - // Whether the PSTN setting of the room profile is enabled. - PSTNEnabled *bool + // The updated temperature unit for the room profile. + TemperatureUnit types.TemperatureUnit + + // The updated timezone for the room profile. + Timezone *string // The updated wake word for the room profile. WakeWord types.WakeWord - - // Whether the setup mode of the profile is enabled. - SetupModeDisabled *bool } type UpdateProfileOutput struct { diff --git a/service/alexaforbusiness/api_op_UpdateRoom.go b/service/alexaforbusiness/api_op_UpdateRoom.go index b4d93459759..94cd6e49c54 100644 --- a/service/alexaforbusiness/api_op_UpdateRoom.go +++ b/service/alexaforbusiness/api_op_UpdateRoom.go @@ -61,12 +61,12 @@ type UpdateRoomInput struct { // The updated profile ARN for the room. ProfileArn *string - // The ARN of the room to update. - RoomArn *string - // The updated provider calendar ARN for the room. ProviderCalendarId *string + // The ARN of the room to update. + RoomArn *string + // The updated name for the room. RoomName *string } diff --git a/service/alexaforbusiness/api_op_UpdateSkillGroup.go b/service/alexaforbusiness/api_op_UpdateSkillGroup.go index ede81efeea1..55beee60662 100644 --- a/service/alexaforbusiness/api_op_UpdateSkillGroup.go +++ b/service/alexaforbusiness/api_op_UpdateSkillGroup.go @@ -55,14 +55,14 @@ func (c *Client) UpdateSkillGroup(ctx context.Context, params *UpdateSkillGroupI type UpdateSkillGroupInput struct { - // The updated name for the skill group. - SkillGroupName *string + // The updated description for the skill group. + Description *string // The ARN of the skill group to update. SkillGroupArn *string - // The updated description for the skill group. - Description *string + // The updated name for the skill group. + SkillGroupName *string } type UpdateSkillGroupOutput struct { diff --git a/service/alexaforbusiness/go.mod b/service/alexaforbusiness/go.mod index 9f600706029..6f1f6f7034d 100644 --- a/service/alexaforbusiness/go.mod +++ b/service/alexaforbusiness/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/alexaforbusiness go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/alexaforbusiness/types/types.go b/service/alexaforbusiness/types/types.go index 855a08b9134..18a2db7c799 100644 --- a/service/alexaforbusiness/types/types.go +++ b/service/alexaforbusiness/types/types.go @@ -9,12 +9,12 @@ import ( // An address book with attributes. type AddressBook struct { - // The description of the address book. - Description *string - // The ARN of the address book. AddressBookArn *string + // The description of the address book. + Description *string + // The name of the address book. Name *string } @@ -22,14 +22,14 @@ type AddressBook struct { // Information related to an address book. type AddressBookData struct { + // The ARN of the address book. + AddressBookArn *string + // The description of the address book. Description *string // The name of the address book. Name *string - - // The ARN of the address book. - AddressBookArn *string } // The audio message. There is a 1 MB limit on the audio file input and the only @@ -58,18 +58,18 @@ type Audio struct { // Usage report with specified parameters. type BusinessReport struct { - // The failure code. - FailureCode BusinessReportFailureCode - - // The S3 location of the output reports. - S3Location *BusinessReportS3Location - // The time of report delivery. DeliveryTime *time.Time // The download link where a user can download the report. DownloadUrl *string + // The failure code. + FailureCode BusinessReportFailureCode + + // The S3 location of the output reports. + S3Location *BusinessReportS3Location + // The status of the report generation execution (RUNNING, SUCCEEDED, or FAILED). Status BusinessReportStatus } @@ -103,20 +103,21 @@ type BusinessReportS3Location struct { // The schedule of the usage report. type BusinessReportSchedule struct { - // The name identifier of the schedule. - ScheduleName *string - // The content range of the reports. ContentRange *BusinessReportContentRange - // The S3 bucket name of the output reports. - S3BucketName *string + // The format of the generated report (individual CSV files or zipped files of + // individual files). + Format BusinessReportFormat + + // The details of the last business report delivery for a specified time interval. + LastBusinessReport *BusinessReport // The recurrence of the reports. Recurrence *BusinessReportRecurrence - // The details of the last business report delivery for a specified time interval. - LastBusinessReport *BusinessReport + // The S3 bucket name of the output reports. + S3BucketName *string // The S3 key where the report is delivered. S3KeyPrefix *string @@ -124,9 +125,8 @@ type BusinessReportSchedule struct { // The ARN of the business report schedule. ScheduleArn *string - // The format of the generated report (individual CSV files or zipped files of - // individual files). - Format BusinessReportFormat + // The name identifier of the schedule. + ScheduleName *string } // The skill store category that is shown. Alexa skills are assigned a specific @@ -154,77 +154,77 @@ type ConferencePreference struct { // and Polycom. type ConferenceProvider struct { + // The ARN of the newly created conference provider. + Arn *string + // The IP endpoint and protocol for calling. IPDialIn *IPDialIn - // The type of conference providers. - Type ConferenceProviderType + // The meeting settings for the conference provider. + MeetingSetting *MeetingSetting // The name of the conference provider. Name *string - // The meeting settings for the conference provider. - MeetingSetting *MeetingSetting - // The information for PSTN conferencing. PSTNDialIn *PSTNDialIn - // The ARN of the newly created conference provider. - Arn *string + // The type of conference providers. + Type ConferenceProviderType } // A contact with attributes. type Contact struct { - // The phone number of the contact. The phone number type defaults to WORK. You can - // either specify PhoneNumber or PhoneNumbers. We recommend that you use - // PhoneNumbers, which lets you specify the phone number type and multiple numbers. - PhoneNumber *string - - // The list of SIP addresses for the contact. - SipAddresses []*SipAddress + // The ARN of the contact. + ContactArn *string // The name of the contact to display on the console. DisplayName *string - // The ARN of the contact. - ContactArn *string + // The first name of the contact, used to call the contact on the device. + FirstName *string // The last name of the contact, used to call the contact on the device. LastName *string - // The first name of the contact, used to call the contact on the device. - FirstName *string + // The phone number of the contact. The phone number type defaults to WORK. You can + // either specify PhoneNumber or PhoneNumbers. We recommend that you use + // PhoneNumbers, which lets you specify the phone number type and multiple numbers. + PhoneNumber *string // The list of phone numbers for the contact. PhoneNumbers []*PhoneNumber + + // The list of SIP addresses for the contact. + SipAddresses []*SipAddress } // Information related to a contact. type ContactData struct { - // The phone number of the contact. The phone number type defaults to WORK. You can - // specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, - // which lets you specify the phone number type and multiple numbers. - PhoneNumber *string + // The ARN of the contact. + ContactArn *string // The name of the contact to display on the console. DisplayName *string + // The first name of the contact, used to call the contact on the device. + FirstName *string + // The last name of the contact, used to call the contact on the device. LastName *string - // The list of SIP addresses for the contact. - SipAddresses []*SipAddress - - // The ARN of the contact. - ContactArn *string + // The phone number of the contact. The phone number type defaults to WORK. You can + // specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, + // which lets you specify the phone number type and multiple numbers. + PhoneNumber *string // The list of phone numbers for the contact. PhoneNumbers []*PhoneNumber - // The first name of the contact, used to call the contact on the device. - FirstName *string + // The list of SIP addresses for the contact. + SipAddresses []*SipAddress } // The content definition. This can contain only one text, SSML, or audio list @@ -234,11 +234,11 @@ type Content struct { // The list of audio messages. AudioList []*Audio - // The list of text messages. - TextList []*Text - // The list of SSML messages. SsmlList []*Ssml + + // The list of text messages. + TextList []*Text } // Creates settings for the end of meeting reminder feature that are applied to a @@ -246,20 +246,20 @@ type Content struct { // meeting is ending. type CreateEndOfMeetingReminder struct { - // The type of sound that users hear during the end of meeting reminder. + // Whether an end of meeting reminder is enabled or not. // // This member is required. - ReminderType EndOfMeetingReminderType + Enabled *bool // A range of 3 to 15 minutes that determines when the reminder begins. // // This member is required. ReminderAtMinutes []*int32 - // Whether an end of meeting reminder is enabled or not. + // The type of sound that users hear during the end of meeting reminder. // // This member is required. - Enabled *bool + ReminderType EndOfMeetingReminderType } // Creates settings for the instant booking feature that are applied to a room @@ -282,6 +282,11 @@ type CreateInstantBooking struct { // Creates meeting room settings of a room profile. type CreateMeetingRoomConfiguration struct { + // Creates settings for the end of meeting reminder feature that are applied to a + // room profile. The end of meeting reminder enables Alexa to remind users when a + // meeting is ending. + EndOfMeetingReminder *CreateEndOfMeetingReminder + // Settings to automatically book a room for a configured duration if it's free // when joining a meeting with Alexa. InstantBooking *CreateInstantBooking @@ -294,11 +299,6 @@ type CreateMeetingRoomConfiguration struct { // Whether room utilization metrics are enabled or not. RoomUtilizationMetricsEnabled *bool - - // Creates settings for the end of meeting reminder feature that are applied to a - // room profile. The end of meeting reminder enables Alexa to remind users when a - // meeting is ending. - EndOfMeetingReminder *CreateEndOfMeetingReminder } // Creates settings for the require check in feature that are applied to a room @@ -306,27 +306,27 @@ type CreateMeetingRoomConfiguration struct { // the user to check in; otherwise, the room will be released. type CreateRequireCheckIn struct { - // Duration between 5 and 20 minutes to determine when to release the room if it's - // not checked into. + // Whether require check in is enabled or not. // // This member is required. - ReleaseAfterMinutes *int32 + Enabled *bool - // Whether require check in is enabled or not. + // Duration between 5 and 20 minutes to determine when to release the room if it's + // not checked into. // // This member is required. - Enabled *bool + ReleaseAfterMinutes *int32 } // The details about the developer that published the skill. type DeveloperInfo struct { - // The email of the developer. - Email *string - // The name of the developer. DeveloperName *string + // The email of the developer. + Email *string + // The URL of the privacy policy. PrivacyPolicy *string @@ -340,6 +340,9 @@ type Device struct { // The ARN of a device. DeviceArn *string + // The name of a device. + DeviceName *string + // The serial number of a device. DeviceSerialNumber *string @@ -347,80 +350,77 @@ type Device struct { // value for details. DeviceStatus DeviceStatus - // The name of a device. - DeviceName *string + // Detailed information about a device's status. + DeviceStatusInfo *DeviceStatusInfo + + // The type of a device. + DeviceType *string // The MAC address of a device. MacAddress *string - // Detailed information about a device's status. - DeviceStatusInfo *DeviceStatusInfo + // Detailed information about a device's network profile. + NetworkProfileInfo *DeviceNetworkProfileInfo // The room ARN of a device. RoomArn *string - // The type of a device. - DeviceType *string - // The software version of a device. SoftwareVersion *string - - // Detailed information about a device's network profile. - NetworkProfileInfo *DeviceNetworkProfileInfo } // Device attributes. type DeviceData struct { - // The name of the room associated with a device. - RoomName *string - - // The room ARN associated with a device. - RoomArn *string + // The time (in epoch) when the device data was created. + CreatedTime *time.Time - // Detailed information about a device's status. - DeviceStatusInfo *DeviceStatusInfo + // The ARN of a device. + DeviceArn *string // The name of a device. DeviceName *string + // The serial number of a device. + DeviceSerialNumber *string + // The status of a device. DeviceStatus DeviceStatus - // The ARN of a device. - DeviceArn *string - - // The name of the network profile associated with a device. - NetworkProfileName *string + // Detailed information about a device's status. + DeviceStatusInfo *DeviceStatusInfo // The type of a device. DeviceType *string - // The software version of a device. - SoftwareVersion *string - - // The time (in epoch) when the device data was created. - CreatedTime *time.Time - - // The serial number of a device. - DeviceSerialNumber *string - // The MAC address of a device. MacAddress *string // The ARN of the network profile associated with a device. NetworkProfileArn *string + + // The name of the network profile associated with a device. + NetworkProfileName *string + + // The room ARN associated with a device. + RoomArn *string + + // The name of the room associated with a device. + RoomName *string + + // The software version of a device. + SoftwareVersion *string } // The list of device events. type DeviceEvent struct { - // The type of device event. - Type DeviceEventType - // The time (in epoch) when the event occurred. Timestamp *time.Time + // The type of device event. + Type DeviceEventType + // The value of the event. Value *string } @@ -428,35 +428,35 @@ type DeviceEvent struct { // Detailed information about a device's network profile. type DeviceNetworkProfileInfo struct { - // The ARN of the network profile associated with a device. - NetworkProfileArn *string + // The ARN of the certificate associated with a device. + CertificateArn *string // The time (in epoch) when the certificate expires. CertificateExpirationTime *time.Time - // The ARN of the certificate associated with a device. - CertificateArn *string + // The ARN of the network profile associated with a device. + NetworkProfileArn *string } // Details of a device’s status. type DeviceStatusDetail struct { - // The list of available features on the device. - Feature Feature - // The device status detail code. Code DeviceStatusDetailCode + + // The list of available features on the device. + Feature Feature } // Detailed information about a device's status. type DeviceStatusInfo struct { - // The time (in epoch) when the device connection status changed. - ConnectionStatusUpdatedTime *time.Time - // The latest available information about the connection status of a device. ConnectionStatus ConnectionStatus + // The time (in epoch) when the device connection status changed. + ConnectionStatusUpdatedTime *time.Time + // One or more device status detail descriptions. DeviceStatusDetails []*DeviceStatusDetail } @@ -469,26 +469,26 @@ type EndOfMeetingReminder struct { // Whether an end of meeting reminder is enabled or not. Enabled *bool - // The type of sound that users hear during the end of meeting reminder. - ReminderType EndOfMeetingReminderType - // A range of 3 to 15 minutes that determines when the reminder begins. ReminderAtMinutes []*int32 + + // The type of sound that users hear during the end of meeting reminder. + ReminderType EndOfMeetingReminderType } // A filter name and value pair that is used to return a more specific list of // results. Filters can be used to match a set of resources by various criteria. type Filter struct { - // The values of a filter. + // The key of a filter. // // This member is required. - Values []*string + Key *string - // The key of a filter. + // The values of a filter. // // This member is required. - Key *string + Values []*string } // The details of the gateway. @@ -503,49 +503,49 @@ type Gateway struct { // The ARN of the gateway group that the gateway is associated to. GatewayGroupArn *string + // The name of the gateway. + Name *string + // The software version of the gateway. The gateway automatically updates its // software version during normal operation. SoftwareVersion *string - - // The name of the gateway. - Name *string } // The details of the gateway group. type GatewayGroup struct { + // The ARN of the gateway group. + Arn *string + // The description of the gateway group. Description *string // The name of the gateway group. Name *string - - // The ARN of the gateway group. - Arn *string } // The summary of a gateway group. type GatewayGroupSummary struct { - // The name of the gateway group. - Name *string - // The ARN of the gateway group. Arn *string // The description of the gateway group. Description *string + + // The name of the gateway group. + Name *string } // The summary of a gateway. type GatewaySummary struct { - // The description of the gateway. - Description *string - // The ARN of the gateway. Arn *string + // The description of the gateway. + Description *string + // The ARN of the gateway group that the gateway is associated to. GatewayGroupArn *string @@ -562,48 +562,48 @@ type GatewaySummary struct { // for the configured duration if the room is available. type InstantBooking struct { - // Whether instant booking is enabled or not. - Enabled *bool - // Duration between 15 and 240 minutes at increments of 15 that determines how long // to book an available room when a meeting is started with Alexa. DurationInMinutes *int32 + + // Whether instant booking is enabled or not. + Enabled *bool } // The IP endpoint and protocol for calling. type IPDialIn struct { - // The IP address. + // The protocol, including SIP, SIPS, and H323. // // This member is required. - Endpoint *string + CommsProtocol CommsProtocol - // The protocol, including SIP, SIPS, and H323. + // The IP address. // // This member is required. - CommsProtocol CommsProtocol + Endpoint *string } // Meeting room settings of a room profile. type MeetingRoomConfiguration struct { + // Settings for the end of meeting reminder feature that are applied to a room + // profile. The end of meeting reminder enables Alexa to remind users when a + // meeting is ending. + EndOfMeetingReminder *EndOfMeetingReminder + // Settings to automatically book the room if available for a configured duration // when joining a meeting with Alexa. InstantBooking *InstantBooking - // Whether room utilization metrics are enabled or not. - RoomUtilizationMetricsEnabled *bool - // Settings for requiring a check in when a room is reserved. Alexa can cancel a // room reservation if it's not checked into. This makes the room available for // others. Users can check in by joining the meeting with Alexa or an AVS device, // or by saying “Alexa, check in.” RequireCheckIn *RequireCheckIn - // Settings for the end of meeting reminder feature that are applied to a room - // profile. The end of meeting reminder enables Alexa to remind users when a - // meeting is ending. - EndOfMeetingReminder *EndOfMeetingReminder + // Whether room utilization metrics are enabled or not. + RoomUtilizationMetricsEnabled *bool } // The values that indicate whether a pin is always required (YES), never required @@ -628,30 +628,30 @@ type MeetingSetting struct { // The network profile associated with a device. type NetworkProfile struct { - // The root certificates of your authentication server, which is installed on your - // devices and used to trust your authentication server during EAP negotiation. - TrustAnchors []*string - - // The authentication standard that is used in the EAP framework. Currently, - // EAP_TLS is supported. - EapMethod NetworkEapMethod + // The ARN of the Private Certificate Authority (PCA) created in AWS Certificate + // Manager (ACM). This is used to issue certificates to the devices. + CertificateAuthorityArn *string - // The next, or subsequent, password of the Wi-Fi network. This password is - // asynchronously transmitted to the device and is used when the password of the - // network changes to NextPassword. - NextPassword *string + // The current password of the Wi-Fi network. + CurrentPassword *string // Detailed information about a device's network profile. Description *string - // The current password of the Wi-Fi network. - CurrentPassword *string + // The authentication standard that is used in the EAP framework. Currently, + // EAP_TLS is supported. + EapMethod NetworkEapMethod + + // The ARN of the network profile associated with a device. + NetworkProfileArn *string // The name of the network profile associated with a device. NetworkProfileName *string - // The ARN of the network profile associated with a device. - NetworkProfileArn *string + // The next, or subsequent, password of the Wi-Fi network. This password is + // asynchronously transmitted to the device and is used when the password of the + // network changes to NextPassword. + NextPassword *string // The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, // WPA_PSK, WEP, or OPEN. @@ -660,37 +660,37 @@ type NetworkProfile struct { // The SSID of the Wi-Fi network. Ssid *string - // The ARN of the Private Certificate Authority (PCA) created in AWS Certificate - // Manager (ACM). This is used to issue certificates to the devices. - CertificateAuthorityArn *string + // The root certificates of your authentication server, which is installed on your + // devices and used to trust your authentication server during EAP negotiation. + TrustAnchors []*string } // The data associated with a network profile. type NetworkProfileData struct { - // The SSID of the Wi-Fi network. - Ssid *string + // The ARN of the Private Certificate Authority (PCA) created in AWS Certificate + // Manager (ACM). This is used to issue certificates to the devices. + CertificateAuthorityArn *string - // The ARN of the network profile associated with a device. - NetworkProfileArn *string + // Detailed information about a device's network profile. + Description *string // The authentication standard that is used in the EAP framework. Currently, // EAP_TLS is supported. EapMethod NetworkEapMethod - // Detailed information about a device's network profile. - Description *string + // The ARN of the network profile associated with a device. + NetworkProfileArn *string + + // The name of the network profile associated with a device. + NetworkProfileName *string // The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, // WPA_PSK, WEP, or OPEN. SecurityType NetworkSecurityType - // The ARN of the Private Certificate Authority (PCA) created in AWS Certificate - // Manager (ACM). This is used to issue certificates to the devices. - CertificateAuthorityArn *string - - // The name of the network profile associated with a device. - NetworkProfileName *string + // The SSID of the Wi-Fi network. + Ssid *string } // The phone number for the contact containing the raw number and phone number @@ -711,8 +711,14 @@ type PhoneNumber struct { // A room profile with attributes. type Profile struct { - // The time zone of a room profile. - Timezone *string + // The address of a room profile. + Address *string + + // The ARN of the address book. + AddressBookArn *string + + // The distance unit of a room profile. + DistanceUnit DistanceUnit // Retrieves if the profile is default or not. IsDefault *bool @@ -721,67 +727,61 @@ type Profile struct { // preview audience.) Locale *string - // The wake word of a room profile. - WakeWord WakeWord - - // The ARN of a room profile. - ProfileArn *string - - // The temperature unit of a room profile. - TemperatureUnit TemperatureUnit - - // The name of a room profile. - ProfileName *string - // The max volume limit of a room profile. MaxVolumeLimit *int32 // Meeting room settings of a room profile. MeetingRoomConfiguration *MeetingRoomConfiguration - // The ARN of the address book. - AddressBookArn *string + // The PSTN setting of a room profile. + PSTNEnabled *bool - // The distance unit of a room profile. - DistanceUnit DistanceUnit + // The ARN of a room profile. + ProfileArn *string + + // The name of a room profile. + ProfileName *string // The setup mode of a room profile. SetupModeDisabled *bool - // The address of a room profile. - Address *string + // The temperature unit of a room profile. + TemperatureUnit TemperatureUnit - // The PSTN setting of a room profile. - PSTNEnabled *bool + // The time zone of a room profile. + Timezone *string + + // The wake word of a room profile. + WakeWord WakeWord } // The data of a room profile. type ProfileData struct { - // The name of a room profile. - ProfileName *string + // The address of a room profile. + Address *string - // The ARN of a room profile. - ProfileArn *string + // The distance unit of a room profile. + DistanceUnit DistanceUnit + + // Retrieves if the profile data is default or not. + IsDefault *bool // The locale of a room profile. (This is currently available only to a limited // preview audience.) Locale *string - // The time zone of a room profile. - Timezone *string - - // Retrieves if the profile data is default or not. - IsDefault *bool + // The ARN of a room profile. + ProfileArn *string - // The address of a room profile. - Address *string + // The name of a room profile. + ProfileName *string // The temperature unit of a room profile. TemperatureUnit TemperatureUnit - // The distance unit of a room profile. - DistanceUnit DistanceUnit + // The time zone of a room profile. + Timezone *string // The wake word of a room profile. WakeWord WakeWord @@ -790,18 +790,6 @@ type ProfileData struct { // The information for public switched telephone network (PSTN) conferencing. type PSTNDialIn struct { - // The delay duration before Alexa enters the conference pin with dual-tone - // multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, - // which is how we send data over the telephone network. - // - // This member is required. - OneClickPinDelay *string - - // The phone number to call to join the conference. - // - // This member is required. - PhoneNumber *string - // The zip code. // // This member is required. @@ -813,6 +801,18 @@ type PSTNDialIn struct { // // This member is required. OneClickIdDelay *string + + // The delay duration before Alexa enters the conference pin with dual-tone + // multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, + // which is how we send data over the telephone network. + // + // This member is required. + OneClickPinDelay *string + + // The phone number to call to join the conference. + // + // This member is required. + PhoneNumber *string } // Settings for the require check in feature that are applied to a room profile. @@ -831,18 +831,18 @@ type RequireCheckIn struct { // A room with attributes. type Room struct { - // The ARN of a room. - RoomArn *string - - // The provider calendar ARN of a room. - ProviderCalendarId *string - // The description of a room. Description *string // The profile ARN of a room. ProfileArn *string + // The provider calendar ARN of a room. + ProviderCalendarId *string + + // The ARN of a room. + RoomArn *string + // The name of a room. RoomName *string } @@ -850,23 +850,23 @@ type Room struct { // The data of a room. type RoomData struct { - // The profile name of a room. - ProfileName *string + // The description of a room. + Description *string - // The name of a room. - RoomName *string + // The profile ARN of a room. + ProfileArn *string - // The ARN of a room. - RoomArn *string + // The profile name of a room. + ProfileName *string // The provider calendar ARN of a room. ProviderCalendarId *string - // The description of a room. - Description *string + // The ARN of a room. + RoomArn *string - // The profile ARN of a room. - ProfileArn *string + // The name of a room. + RoomName *string } // A skill parameter associated with a room. @@ -887,15 +887,15 @@ type RoomSkillParameter struct { // The SIP address for the contact containing the URI and SIP address type. type SipAddress struct { - // The URI for the SIP address. + // The type of the SIP address. // // This member is required. - Uri *string + Type SipType - // The type of the SIP address. + // The URI for the SIP address. // // This member is required. - Type SipType + Uri *string } // Granular information about the skill. @@ -904,46 +904,46 @@ type SkillDetails struct { // The details about what the skill supports organized as bullet points. BulletPoints []*string - // The types of skills. - SkillTypes []*string + // The details about the developer that published the skill. + DeveloperInfo *DeveloperInfo - // The updates added in bullet points. - NewInThisVersionBulletPoints []*string + // The URL of the end user license agreement. + EndUserLicenseAgreement *string - // The date when the skill was released. - ReleaseDate *string + // The generic keywords associated with the skill that can be used to find a skill. + GenericKeywords []*string - // The details about the developer that published the skill. - DeveloperInfo *DeveloperInfo + // The phrase used to trigger the skill. + InvocationPhrase *string + + // The updates added in bullet points. + NewInThisVersionBulletPoints []*string // The description of the product. ProductDescription *string + // The date when the skill was released. + ReleaseDate *string + // This member has been deprecated. The list of reviews for the skill, including // Key and Value pair. Reviews map[string]*string - // The phrase used to trigger the skill. - InvocationPhrase *string - - // The generic keywords associated with the skill that can be used to find a skill. - GenericKeywords []*string - - // The URL of the end user license agreement. - EndUserLicenseAgreement *string + // The types of skills. + SkillTypes []*string } // A skill group with attributes. type SkillGroup struct { - // The name of a skill group. - SkillGroupName *string + // The description of a skill group. + Description *string // The ARN of a skill group. SkillGroupArn *string - // The description of a skill group. - Description *string + // The name of a skill group. + SkillGroupName *string } // The attributes of a skill group. @@ -965,55 +965,55 @@ type SkillsStoreSkill struct { // The URL where the skill icon resides. IconUrl *string - // The name of the skill. - SkillName *string - // Sample utterances that interact with the skill. SampleUtterances []*string - // Linking support for a skill. - SupportsLinking *bool - - // The ARN of the skill. - SkillId *string - // Short description about the skill. ShortDescription *string // Information about the skill. SkillDetails *SkillDetails + + // The ARN of the skill. + SkillId *string + + // The name of the skill. + SkillName *string + + // Linking support for a skill. + SupportsLinking *bool } // The summary of skills. type SkillSummary struct { - // The ARN of the skill summary. - SkillId *string - // Whether the skill is enabled under the user's account, or if it requires linking // to be used. EnablementType EnablementType - // Linking support for a skill. - SupportsLinking *bool + // The ARN of the skill summary. + SkillId *string + + // The name of the skill. + SkillName *string // Whether the skill is publicly available or is a private skill. SkillType SkillType - // The name of the skill. - SkillName *string + // Linking support for a skill. + SupportsLinking *bool } // A smart home appliance that can connect to a central system. Any domestic device // can be a smart appliance. type SmartHomeAppliance struct { - // The friendly name of the smart home appliance. - FriendlyName *string - // The description of the smart home appliance. Description *string + // The friendly name of the smart home appliance. + FriendlyName *string + // The name of the manufacturer of the smart home appliance. ManufacturerName *string } @@ -1036,44 +1036,44 @@ type Sort struct { // (https://developer.amazon.com/docs/custom-skills/speech-synthesis-markup-language-ssml-reference.html). type Ssml struct { - // The value of the SSML message in the correct SSML format. The audio tag is not - // supported. + // The locale of the SSML message. Currently, en-US is supported. // // This member is required. - Value *string + Locale Locale - // The locale of the SSML message. Currently, en-US is supported. + // The value of the SSML message in the correct SSML format. The audio tag is not + // supported. // // This member is required. - Locale Locale + Value *string } // A key-value pair that can be associated with a resource. type Tag struct { - // The value of a tag. Tag values are case sensitive and can be null. + // The key of a tag. Tag keys are case-sensitive. // // This member is required. - Value *string + Key *string - // The key of a tag. Tag keys are case-sensitive. + // The value of a tag. Tag values are case sensitive and can be null. // // This member is required. - Key *string + Value *string } // The text message. type Text struct { - // The value of the text message. + // The locale of the text message. Currently, en-US is supported. // // This member is required. - Value *string + Locale Locale - // The locale of the text message. Currently, en-US is supported. + // The value of the text message. // // This member is required. - Locale Locale + Value *string } // Settings for the end of meeting reminder feature that are applied to a room @@ -1081,6 +1081,9 @@ type Text struct { // meeting is ending. type UpdateEndOfMeetingReminder struct { + // Whether an end of meeting reminder is enabled or not. + Enabled *bool + // Updates settings for the end of meeting reminder feature that are applied to a // room profile. The end of meeting reminder enables Alexa to remind users when a // meeting is ending. @@ -1088,9 +1091,6 @@ type UpdateEndOfMeetingReminder struct { // The type of sound that users hear during the end of meeting reminder. ReminderType EndOfMeetingReminderType - - // Whether an end of meeting reminder is enabled or not. - Enabled *bool } // Updates settings for the instant booking feature that are applied to a room @@ -1098,12 +1098,12 @@ type UpdateEndOfMeetingReminder struct { // it is free when a user joins a meeting with Alexa. type UpdateInstantBooking struct { - // Whether instant booking is enabled or not. - Enabled *bool - // Duration between 15 and 240 minutes at increments of 15 that determines how long // to book an available room when a meeting is started with Alexa. DurationInMinutes *int32 + + // Whether instant booking is enabled or not. + Enabled *bool } // Updates meeting room settings of a room profile. @@ -1114,6 +1114,10 @@ type UpdateMeetingRoomConfiguration struct { // meeting is ending. EndOfMeetingReminder *UpdateEndOfMeetingReminder + // Settings to automatically book an available room available for a configured + // duration when joining a meeting with Alexa. + InstantBooking *UpdateInstantBooking + // Settings for requiring a check in when a room is reserved. Alexa can cancel a // room reservation if it's not checked into to make the room available for others. // Users can check in by joining the meeting with Alexa or an AVS device, or by @@ -1122,10 +1126,6 @@ type UpdateMeetingRoomConfiguration struct { // Whether room utilization metrics are enabled or not. RoomUtilizationMetricsEnabled *bool - - // Settings to automatically book an available room available for a configured - // duration when joining a meeting with Alexa. - InstantBooking *UpdateInstantBooking } // Updates settings for the require check in feature that are applied to a room @@ -1133,12 +1133,12 @@ type UpdateMeetingRoomConfiguration struct { // the user to check in; otherwise, the room will be released. type UpdateRequireCheckIn struct { + // Whether require check in is enabled or not. + Enabled *bool + // Duration between 5 and 20 minutes to determine when to release the room if it's // not checked into. ReleaseAfterMinutes *int32 - - // Whether require check in is enabled or not. - Enabled *bool } // Information related to a user. @@ -1150,15 +1150,15 @@ type UserData struct { // The enrollment ARN of a user. EnrollmentId *string + // The enrollment status of a user. + EnrollmentStatus EnrollmentStatus + // The first name of a user. FirstName *string // The last name of a user. LastName *string - // The enrollment status of a user. - EnrollmentStatus EnrollmentStatus - // The ARN of a user. UserArn *string } diff --git a/service/amplify/api_op_CreateApp.go b/service/amplify/api_op_CreateApp.go index 7f0ccdf13b0..17ca7394abe 100644 --- a/service/amplify/api_op_CreateApp.go +++ b/service/amplify/api_op_CreateApp.go @@ -58,67 +58,67 @@ func (c *Client) CreateApp(ctx context.Context, params *CreateAppInput, optFns . // The request structure used to create apps in Amplify. type CreateAppInput struct { - // The tag for an Amplify app. - Tags map[string]*string + // The name for the Amplify app. + // + // This member is required. + Name *string - // The repository for an Amplify app. - Repository *string + // The personal access token for a third-party source control system for an Amplify + // app. The personal access token is used to create a webhook and a read-only + // deploy key. The token is not stored. + AccessToken *string - // Enables the auto building of branches for an Amplify app. - EnableBranchAutoBuild *bool + // The automated branch creation configuration for the Amplify app. + AutoBranchCreationConfig *types.AutoBranchCreationConfig - // Automatically disconnects a branch in the Amplify Console when you delete a - // branch from your Git repository. - EnableBranchAutoDeletion *bool + // The automated branch creation glob patterns for the Amplify app. + AutoBranchCreationPatterns []*string // The credentials for basic authorization for an Amplify app. BasicAuthCredentials *string - // The description for an Amplify app. - Description *string - - // The personal access token for a third-party source control system for an Amplify - // app. The personal access token is used to create a webhook and a read-only - // deploy key. The token is not stored. - AccessToken *string - // The build specification (build spec) for an Amplify app. BuildSpec *string + // The custom rewrite and redirect rules for an Amplify app. + CustomRules []*types.CustomRule + + // The description for an Amplify app. + Description *string + // Enables automated branch creation for the Amplify app. EnableAutoBranchCreation *bool - // The AWS Identity and Access Management (IAM) service role for an Amplify app. - IamServiceRoleArn *string + // Enables basic authorization for an Amplify app. This will apply to all branches + // that are part of this app. + EnableBasicAuth *bool - // The OAuth token for a third-party source control system for an Amplify app. The - // OAuth token is used to create a webhook and a read-only deploy key. The OAuth - // token is not stored. - OauthToken *string + // Enables the auto building of branches for an Amplify app. + EnableBranchAutoBuild *bool - // The automated branch creation glob patterns for the Amplify app. - AutoBranchCreationPatterns []*string + // Automatically disconnects a branch in the Amplify Console when you delete a + // branch from your Git repository. + EnableBranchAutoDeletion *bool // The environment variables map for an Amplify app. EnvironmentVariables map[string]*string - // Enables basic authorization for an Amplify app. This will apply to all branches - // that are part of this app. - EnableBasicAuth *bool + // The AWS Identity and Access Management (IAM) service role for an Amplify app. + IamServiceRoleArn *string - // The name for the Amplify app. - // - // This member is required. - Name *string + // The OAuth token for a third-party source control system for an Amplify app. The + // OAuth token is used to create a webhook and a read-only deploy key. The OAuth + // token is not stored. + OauthToken *string // The platform or framework for an Amplify app. Platform types.Platform - // The automated branch creation configuration for the Amplify app. - AutoBranchCreationConfig *types.AutoBranchCreationConfig + // The repository for an Amplify app. + Repository *string - // The custom rewrite and redirect rules for an Amplify app. - CustomRules []*types.CustomRule + // The tag for an Amplify app. + Tags map[string]*string } type CreateAppOutput struct { diff --git a/service/amplify/api_op_CreateBackendEnvironment.go b/service/amplify/api_op_CreateBackendEnvironment.go index 957b997cb4a..64e8b914e0b 100644 --- a/service/amplify/api_op_CreateBackendEnvironment.go +++ b/service/amplify/api_op_CreateBackendEnvironment.go @@ -58,21 +58,21 @@ func (c *Client) CreateBackendEnvironment(ctx context.Context, params *CreateBac // The request structure for the backend environment create request. type CreateBackendEnvironmentInput struct { - // The AWS CloudFormation stack name of a backend environment. - StackName *string - // The unique ID for an Amplify app. // // This member is required. AppId *string - // The name of deployment artifacts. - DeploymentArtifacts *string - // The name for the backend environment. // // This member is required. EnvironmentName *string + + // The name of deployment artifacts. + DeploymentArtifacts *string + + // The AWS CloudFormation stack name of a backend environment. + StackName *string } // The result structure for the create backend environment request. diff --git a/service/amplify/api_op_CreateBranch.go b/service/amplify/api_op_CreateBranch.go index 80e5102c75e..31d1b244d42 100644 --- a/service/amplify/api_op_CreateBranch.go +++ b/service/amplify/api_op_CreateBranch.go @@ -58,22 +58,19 @@ func (c *Client) CreateBranch(ctx context.Context, params *CreateBranchInput, op // The request structure for the create branch request. type CreateBranchInput struct { - // Enables pull request preview for this branch. - EnablePullRequestPreview *bool - - // Enables basic authorization for the branch. - EnableBasicAuth *bool - // The unique ID for an Amplify app. // // This member is required. AppId *string - // Describes the current stage for the branch. - Stage types.Stage + // The name for the branch. + // + // This member is required. + BranchName *string - // Enables notifications for the branch. - EnableNotification *bool + // The Amazon Resource Name (ARN) for a backend environment that is part of an + // Amplify app. + BackendEnvironmentArn *string // The basic authorization credentials for the branch. BasicAuthCredentials *string @@ -81,38 +78,41 @@ type CreateBranchInput struct { // The build specification (build spec) for the branch. BuildSpec *string - // The content Time To Live (TTL) for the website in seconds. - Ttl *string + // The description for the branch. + Description *string - // The Amplify environment name for the pull request. - PullRequestEnvironmentName *string + // The display name for a branch. This is used as the default domain prefix. + DisplayName *string - // The name for the branch. - // - // This member is required. - BranchName *string + // Enables auto building for the branch. + EnableAutoBuild *bool - // The Amazon Resource Name (ARN) for a backend environment that is part of an - // Amplify app. - BackendEnvironmentArn *string + // Enables basic authorization for the branch. + EnableBasicAuth *bool - // The framework for the branch. - Framework *string + // Enables notifications for the branch. + EnableNotification *bool - // The tag for the branch. - Tags map[string]*string + // Enables pull request preview for this branch. + EnablePullRequestPreview *bool // The environment variables for the branch. EnvironmentVariables map[string]*string - // The display name for a branch. This is used as the default domain prefix. - DisplayName *string + // The framework for the branch. + Framework *string - // The description for the branch. - Description *string + // The Amplify environment name for the pull request. + PullRequestEnvironmentName *string - // Enables auto building for the branch. - EnableAutoBuild *bool + // Describes the current stage for the branch. + Stage types.Stage + + // The tag for the branch. + Tags map[string]*string + + // The content Time To Live (TTL) for the website in seconds. + Ttl *string } // The result structure for create branch request. diff --git a/service/amplify/api_op_CreateDeployment.go b/service/amplify/api_op_CreateDeployment.go index 3c6106ca292..227f7b8055c 100644 --- a/service/amplify/api_op_CreateDeployment.go +++ b/service/amplify/api_op_CreateDeployment.go @@ -63,24 +63,21 @@ type CreateDeploymentInput struct { // This member is required. AppId *string + // The name for the branch, for the job. + // + // This member is required. + BranchName *string + // An optional file map that contains the file name as the key and the file content // md5 hash as the value. If this argument is provided, the service will generate a // unique upload URL per file. Otherwise, the service will only generate a single // upload URL for the zipped files. FileMap map[string]*string - - // The name for the branch, for the job. - // - // This member is required. - BranchName *string } // The result structure for the create a new deployment request. type CreateDeploymentOutput struct { - // The job ID for this deployment. will supply to start deployment api. - JobId *string - // When the fileMap argument is provided in the request, fileUploadUrls will // contain a map of file names to upload URLs. // @@ -93,6 +90,9 @@ type CreateDeploymentOutput struct { // This member is required. ZipUploadUrl *string + // The job ID for this deployment. will supply to start deployment api. + JobId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/amplify/api_op_CreateDomainAssociation.go b/service/amplify/api_op_CreateDomainAssociation.go index 73d9a851083..d5f34809424 100644 --- a/service/amplify/api_op_CreateDomainAssociation.go +++ b/service/amplify/api_op_CreateDomainAssociation.go @@ -59,21 +59,11 @@ func (c *Client) CreateDomainAssociation(ctx context.Context, params *CreateDoma // The request structure for the create domain association request. type CreateDomainAssociationInput struct { - // The required AWS Identity and Access Management (IAM) service role for the - // Amazon Resource Name (ARN) for automatically creating subdomains. - AutoSubDomainIAMRole *string - - // Enables the automated creation of subdomains for branches. - EnableAutoSubDomain *bool - // The unique ID for an Amplify app. // // This member is required. AppId *string - // Sets the branch patterns for automatic subdomain creation. - AutoSubDomainCreationPatterns []*string - // The domain name for the domain association. // // This member is required. @@ -83,6 +73,16 @@ type CreateDomainAssociationInput struct { // // This member is required. SubDomainSettings []*types.SubDomainSetting + + // Sets the branch patterns for automatic subdomain creation. + AutoSubDomainCreationPatterns []*string + + // The required AWS Identity and Access Management (IAM) service role for the + // Amazon Resource Name (ARN) for automatically creating subdomains. + AutoSubDomainIAMRole *string + + // Enables the automated creation of subdomains for branches. + EnableAutoSubDomain *bool } // The result structure for the create domain association request. diff --git a/service/amplify/api_op_CreateWebhook.go b/service/amplify/api_op_CreateWebhook.go index a55d79cf573..fc27563c208 100644 --- a/service/amplify/api_op_CreateWebhook.go +++ b/service/amplify/api_op_CreateWebhook.go @@ -58,18 +58,18 @@ func (c *Client) CreateWebhook(ctx context.Context, params *CreateWebhookInput, // The request structure for the create webhook request. type CreateWebhookInput struct { - // The description for a webhook. - Description *string + // The unique ID for an Amplify app. + // + // This member is required. + AppId *string // The name for a branch that is part of an Amplify app. // // This member is required. BranchName *string - // The unique ID for an Amplify app. - // - // This member is required. - AppId *string + // The description for a webhook. + Description *string } // The result structure for the create webhook request. diff --git a/service/amplify/api_op_DeleteDomainAssociation.go b/service/amplify/api_op_DeleteDomainAssociation.go index 2a840304d4d..c9eee73fa45 100644 --- a/service/amplify/api_op_DeleteDomainAssociation.go +++ b/service/amplify/api_op_DeleteDomainAssociation.go @@ -58,15 +58,15 @@ func (c *Client) DeleteDomainAssociation(ctx context.Context, params *DeleteDoma // The request structure for the delete domain association request. type DeleteDomainAssociationInput struct { - // The name of the domain. + // The unique id for an Amplify app. // // This member is required. - DomainName *string + AppId *string - // The unique id for an Amplify app. + // The name of the domain. // // This member is required. - AppId *string + DomainName *string } type DeleteDomainAssociationOutput struct { diff --git a/service/amplify/api_op_DeleteJob.go b/service/amplify/api_op_DeleteJob.go index 0bb3df1d153..0354e374f96 100644 --- a/service/amplify/api_op_DeleteJob.go +++ b/service/amplify/api_op_DeleteJob.go @@ -58,20 +58,20 @@ func (c *Client) DeleteJob(ctx context.Context, params *DeleteJobInput, optFns . // The request structure for the delete job request. type DeleteJobInput struct { - // The unique ID for the job. + // The unique ID for an Amplify app. // // This member is required. - JobId *string + AppId *string // The name for the branch, for the job. // // This member is required. BranchName *string - // The unique ID for an Amplify app. + // The unique ID for the job. // // This member is required. - AppId *string + JobId *string } // The result structure for the delete job request. diff --git a/service/amplify/api_op_GenerateAccessLogs.go b/service/amplify/api_op_GenerateAccessLogs.go index c020459fa4c..2b43de60443 100644 --- a/service/amplify/api_op_GenerateAccessLogs.go +++ b/service/amplify/api_op_GenerateAccessLogs.go @@ -58,19 +58,19 @@ func (c *Client) GenerateAccessLogs(ctx context.Context, params *GenerateAccessL // The request structure for the generate access logs request. type GenerateAccessLogsInput struct { - // The time at which the logs should end. The time range specified is inclusive of - // the end time. - EndTime *time.Time + // The unique ID for an Amplify app. + // + // This member is required. + AppId *string // The name of the domain. // // This member is required. DomainName *string - // The unique ID for an Amplify app. - // - // This member is required. - AppId *string + // The time at which the logs should end. The time range specified is inclusive of + // the end time. + EndTime *time.Time // The time at which the logs should start. The time range specified is inclusive // of the start time. diff --git a/service/amplify/api_op_GetArtifactUrl.go b/service/amplify/api_op_GetArtifactUrl.go index 34d3e0c90b7..4586b55adb0 100644 --- a/service/amplify/api_op_GetArtifactUrl.go +++ b/service/amplify/api_op_GetArtifactUrl.go @@ -66,15 +66,15 @@ type GetArtifactUrlInput struct { // Returns the result structure for the get artifact request. type GetArtifactUrlOutput struct { - // The presigned URL for the artifact. + // The unique ID for an artifact. // // This member is required. - ArtifactUrl *string + ArtifactId *string - // The unique ID for an artifact. + // The presigned URL for the artifact. // // This member is required. - ArtifactId *string + ArtifactUrl *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/amplify/api_op_GetBranch.go b/service/amplify/api_op_GetBranch.go index b845593129b..6e94e719da0 100644 --- a/service/amplify/api_op_GetBranch.go +++ b/service/amplify/api_op_GetBranch.go @@ -58,15 +58,15 @@ func (c *Client) GetBranch(ctx context.Context, params *GetBranchInput, optFns . // The request structure for the get branch request. type GetBranchInput struct { - // The name for the branch. + // The unique ID for an Amplify app. // // This member is required. - BranchName *string + AppId *string - // The unique ID for an Amplify app. + // The name for the branch. // // This member is required. - AppId *string + BranchName *string } type GetBranchOutput struct { diff --git a/service/amplify/api_op_GetDomainAssociation.go b/service/amplify/api_op_GetDomainAssociation.go index e546f12f9bd..deb258b13c2 100644 --- a/service/amplify/api_op_GetDomainAssociation.go +++ b/service/amplify/api_op_GetDomainAssociation.go @@ -58,15 +58,15 @@ func (c *Client) GetDomainAssociation(ctx context.Context, params *GetDomainAsso // The request structure for the get domain association request. type GetDomainAssociationInput struct { - // The name of the domain. + // The unique id for an Amplify app. // // This member is required. - DomainName *string + AppId *string - // The unique id for an Amplify app. + // The name of the domain. // // This member is required. - AppId *string + DomainName *string } // The result structure for the get domain association request. diff --git a/service/amplify/api_op_GetJob.go b/service/amplify/api_op_GetJob.go index 51996185ad0..805a96e46d6 100644 --- a/service/amplify/api_op_GetJob.go +++ b/service/amplify/api_op_GetJob.go @@ -58,6 +58,11 @@ func (c *Client) GetJob(ctx context.Context, params *GetJobInput, optFns ...func // The request structure for the get job request. type GetJobInput struct { + // The unique ID for an Amplify app. + // + // This member is required. + AppId *string + // The branch name for the job. // // This member is required. @@ -67,11 +72,6 @@ type GetJobInput struct { // // This member is required. JobId *string - - // The unique ID for an Amplify app. - // - // This member is required. - AppId *string } type GetJobOutput struct { diff --git a/service/amplify/api_op_ListApps.go b/service/amplify/api_op_ListApps.go index 77cdb078da7..7e6126ad850 100644 --- a/service/amplify/api_op_ListApps.go +++ b/service/amplify/api_op_ListApps.go @@ -68,16 +68,16 @@ type ListAppsInput struct { // The result structure for an Amplify app list request. type ListAppsOutput struct { - // A pagination token. Set to null to start listing apps from start. If non-null, - // the pagination token is returned in a result. Pass its value in here to list - // more projects. - NextToken *string - // A list of Amplify apps. // // This member is required. Apps []*types.App + // A pagination token. Set to null to start listing apps from start. If non-null, + // the pagination token is returned in a result. Pass its value in here to list + // more projects. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/amplify/api_op_ListArtifacts.go b/service/amplify/api_op_ListArtifacts.go index dfa8c445001..1c527efe7eb 100644 --- a/service/amplify/api_op_ListArtifacts.go +++ b/service/amplify/api_op_ListArtifacts.go @@ -58,11 +58,21 @@ func (c *Client) ListArtifacts(ctx context.Context, params *ListArtifactsInput, // Describes the request structure for the list artifacts request. type ListArtifactsInput struct { + // The unique ID for an Amplify app. + // + // This member is required. + AppId *string + // The name of a branch that is part of an Amplify app. // // This member is required. BranchName *string + // The unique ID for a job. + // + // This member is required. + JobId *string + // The maximum number of records to list in a single response. MaxResults *int32 @@ -70,16 +80,6 @@ type ListArtifactsInput struct { // non-null pagination token is returned in a result, pass its value in here to // list more artifacts. NextToken *string - - // The unique ID for an Amplify app. - // - // This member is required. - AppId *string - - // The unique ID for a job. - // - // This member is required. - JobId *string } // The result structure for the list artifacts request. diff --git a/service/amplify/api_op_ListBackendEnvironments.go b/service/amplify/api_op_ListBackendEnvironments.go index 7d94f9ec77f..3858956c8cc 100644 --- a/service/amplify/api_op_ListBackendEnvironments.go +++ b/service/amplify/api_op_ListBackendEnvironments.go @@ -58,9 +58,6 @@ func (c *Client) ListBackendEnvironments(ctx context.Context, params *ListBacken // The request structure for the list backend environments request. type ListBackendEnvironmentsInput struct { - // The maximum number of records to list in a single response. - MaxResults *int32 - // The unique ID for an Amplify app. // // This member is required. @@ -69,6 +66,9 @@ type ListBackendEnvironmentsInput struct { // The name of the backend environment EnvironmentName *string + // The maximum number of records to list in a single response. + MaxResults *int32 + // A pagination token. Set to null to start listing backend environments from the // start. If a non-null pagination token is returned in a result, pass its value in // here to list more backend environments. diff --git a/service/amplify/api_op_ListBranches.go b/service/amplify/api_op_ListBranches.go index 20cfeefdd3b..9e552757aa8 100644 --- a/service/amplify/api_op_ListBranches.go +++ b/service/amplify/api_op_ListBranches.go @@ -63,27 +63,27 @@ type ListBranchesInput struct { // This member is required. AppId *string + // The maximum number of records to list in a single response. + MaxResults *int32 + // A pagination token. Set to null to start listing branches from the start. If a // non-null pagination token is returned in a result, pass its value in here to // list more branches. NextToken *string - - // The maximum number of records to list in a single response. - MaxResults *int32 } // The result structure for the list branches request. type ListBranchesOutput struct { - // A pagination token. If a non-null pagination token is returned in a result, pass - // its value in another request to retrieve more entries. - NextToken *string - // A list of branches for an Amplify app. // // This member is required. Branches []*types.Branch + // A pagination token. If a non-null pagination token is returned in a result, pass + // its value in another request to retrieve more entries. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/amplify/api_op_ListDomainAssociations.go b/service/amplify/api_op_ListDomainAssociations.go index 594a8caa456..8870663ea53 100644 --- a/service/amplify/api_op_ListDomainAssociations.go +++ b/service/amplify/api_op_ListDomainAssociations.go @@ -58,32 +58,32 @@ func (c *Client) ListDomainAssociations(ctx context.Context, params *ListDomainA // The request structure for the list domain associations request. type ListDomainAssociationsInput struct { - // A pagination token. Set to null to start listing apps from the start. If - // non-null, a pagination token is returned in a result. Pass its value in here to - // list more projects. - NextToken *string - - // The maximum number of records to list in a single response. - MaxResults *int32 - // The unique ID for an Amplify app. // // This member is required. AppId *string + + // The maximum number of records to list in a single response. + MaxResults *int32 + + // A pagination token. Set to null to start listing apps from the start. If + // non-null, a pagination token is returned in a result. Pass its value in here to + // list more projects. + NextToken *string } // The result structure for the list domain association request. type ListDomainAssociationsOutput struct { - // A pagination token. If non-null, a pagination token is returned in a result. - // Pass its value in another request to retrieve more entries. - NextToken *string - // A list of domain associations. // // This member is required. DomainAssociations []*types.DomainAssociation + // A pagination token. If non-null, a pagination token is returned in a result. + // Pass its value in another request to retrieve more entries. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/amplify/api_op_ListJobs.go b/service/amplify/api_op_ListJobs.go index a065e329633..a29a8f00042 100644 --- a/service/amplify/api_op_ListJobs.go +++ b/service/amplify/api_op_ListJobs.go @@ -58,15 +58,15 @@ func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ... // The request structure for the list jobs request. type ListJobsInput struct { - // The name for a branch. + // The unique ID for an Amplify app. // // This member is required. - BranchName *string + AppId *string - // The unique ID for an Amplify app. + // The name for a branch. // // This member is required. - AppId *string + BranchName *string // The maximum number of records to list in a single response. MaxResults *int32 diff --git a/service/amplify/api_op_StartDeployment.go b/service/amplify/api_op_StartDeployment.go index efe43532abb..b1c9729e3cd 100644 --- a/service/amplify/api_op_StartDeployment.go +++ b/service/amplify/api_op_StartDeployment.go @@ -59,14 +59,6 @@ func (c *Client) StartDeployment(ctx context.Context, params *StartDeploymentInp // The request structure for the start a deployment request. type StartDeploymentInput struct { - // The job ID for this deployment, generated by the create deployment request. - JobId *string - - // The source URL for this deployment, used when calling start deployment without - // create deployment. The source URL can be any HTTP GET URL that is publicly - // accessible and downloads a single .zip file. - SourceUrl *string - // The unique ID for an Amplify app. // // This member is required. @@ -76,6 +68,14 @@ type StartDeploymentInput struct { // // This member is required. BranchName *string + + // The job ID for this deployment, generated by the create deployment request. + JobId *string + + // The source URL for this deployment, used when calling start deployment without + // create deployment. The source URL can be any HTTP GET URL that is publicly + // accessible and downloads a single .zip file. + SourceUrl *string } // The result structure for the start a deployment request. diff --git a/service/amplify/api_op_StartJob.go b/service/amplify/api_op_StartJob.go index d671176453b..2ec986b70f2 100644 --- a/service/amplify/api_op_StartJob.go +++ b/service/amplify/api_op_StartJob.go @@ -59,24 +59,11 @@ func (c *Client) StartJob(ctx context.Context, params *StartJobInput, optFns ... // The request structure for the start job request. type StartJobInput struct { - // The unique ID for an existing job. This is required if the value of jobType is - // RETRY. - JobId *string - // The unique ID for an Amplify app. // // This member is required. AppId *string - // A descriptive reason for starting this job. - JobReason *string - - // The commit message from a third-party repository provider for the job. - CommitMessage *string - - // The commit date and time for the job. - CommitTime *time.Time - // The branch name for the job. // // This member is required. @@ -92,6 +79,19 @@ type StartJobInput struct { // The commit ID from a third-party repository provider for the job. CommitId *string + + // The commit message from a third-party repository provider for the job. + CommitMessage *string + + // The commit date and time for the job. + CommitTime *time.Time + + // The unique ID for an existing job. This is required if the value of jobType is + // RETRY. + JobId *string + + // A descriptive reason for starting this job. + JobReason *string } // The result structure for the run job request. diff --git a/service/amplify/api_op_StopJob.go b/service/amplify/api_op_StopJob.go index 56d107e8e85..3e7f866fa95 100644 --- a/service/amplify/api_op_StopJob.go +++ b/service/amplify/api_op_StopJob.go @@ -58,6 +58,11 @@ func (c *Client) StopJob(ctx context.Context, params *StopJobInput, optFns ...fu // The request structure for the stop job request. type StopJobInput struct { + // The unique ID for an Amplify app. + // + // This member is required. + AppId *string + // The name for the branch, for the job. // // This member is required. @@ -67,11 +72,6 @@ type StopJobInput struct { // // This member is required. JobId *string - - // The unique ID for an Amplify app. - // - // This member is required. - AppId *string } // The result structure for the stop job request. diff --git a/service/amplify/api_op_UntagResource.go b/service/amplify/api_op_UntagResource.go index 1cf8827e264..d58c4f475c2 100644 --- a/service/amplify/api_op_UntagResource.go +++ b/service/amplify/api_op_UntagResource.go @@ -57,15 +57,15 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, // The request structure for the untag resource request. type UntagResourceInput struct { - // The tag keys to use to untag a resource. + // The Amazon Resource Name (ARN) to use to untag a resource. // // This member is required. - TagKeys []*string + ResourceArn *string - // The Amazon Resource Name (ARN) to use to untag a resource. + // The tag keys to use to untag a resource. // // This member is required. - ResourceArn *string + TagKeys []*string } // The response for the untag resource request. diff --git a/service/amplify/api_op_UpdateApp.go b/service/amplify/api_op_UpdateApp.go index daf4ca4b8d8..6259f81c72a 100644 --- a/service/amplify/api_op_UpdateApp.go +++ b/service/amplify/api_op_UpdateApp.go @@ -58,66 +58,66 @@ func (c *Client) UpdateApp(ctx context.Context, params *UpdateAppInput, optFns . // The request structure for the update app request. type UpdateAppInput struct { - // Enables branch auto-building for an Amplify app. - EnableBranchAutoBuild *bool - - // The name of the repository for an Amplify app - Repository *string - - // The basic authorization credentials for an Amplify app. - BasicAuthCredentials *string + // The unique ID for an Amplify app. + // + // This member is required. + AppId *string // The personal access token for a third-party source control system for an Amplify // app. The token is used to create webhook and a read-only deploy key. The token // is not stored. AccessToken *string - // Enables automated branch creation for the Amplify app. - EnableAutoBranchCreation *bool + // The automated branch creation configuration for the Amplify app. + AutoBranchCreationConfig *types.AutoBranchCreationConfig + + // Describes the automated branch creation glob patterns for the Amplify app. + AutoBranchCreationPatterns []*string + + // The basic authorization credentials for an Amplify app. + BasicAuthCredentials *string + + // The build specification (build spec) for an Amplify app. + BuildSpec *string + + // The custom redirect and rewrite rules for an Amplify app. + CustomRules []*types.CustomRule // The description for an Amplify app. Description *string + // Enables automated branch creation for the Amplify app. + EnableAutoBranchCreation *bool + // Enables basic authorization for an Amplify app. EnableBasicAuth *bool - // The OAuth token for a third-party source control system for an Amplify app. The - // token is used to create a webhook and a read-only deploy key. The OAuth token is - // not stored. - OauthToken *string - - // The platform for an Amplify app. - Platform types.Platform + // Enables branch auto-building for an Amplify app. + EnableBranchAutoBuild *bool - // The AWS Identity and Access Management (IAM) service role for an Amplify app. - IamServiceRoleArn *string + // Automatically disconnects a branch in the Amplify Console when you delete a + // branch from your Git repository. + EnableBranchAutoDeletion *bool // The environment variables for an Amplify app. EnvironmentVariables map[string]*string - // Describes the automated branch creation glob patterns for the Amplify app. - AutoBranchCreationPatterns []*string - - // The custom redirect and rewrite rules for an Amplify app. - CustomRules []*types.CustomRule - - // The unique ID for an Amplify app. - // - // This member is required. - AppId *string - - // The automated branch creation configuration for the Amplify app. - AutoBranchCreationConfig *types.AutoBranchCreationConfig - - // The build specification (build spec) for an Amplify app. - BuildSpec *string + // The AWS Identity and Access Management (IAM) service role for an Amplify app. + IamServiceRoleArn *string // The name for an Amplify app. Name *string - // Automatically disconnects a branch in the Amplify Console when you delete a - // branch from your Git repository. - EnableBranchAutoDeletion *bool + // The OAuth token for a third-party source control system for an Amplify app. The + // token is used to create a webhook and a read-only deploy key. The OAuth token is + // not stored. + OauthToken *string + + // The platform for an Amplify app. + Platform types.Platform + + // The name of the repository for an Amplify app + Repository *string } // The result structure for an Amplify app update request. diff --git a/service/amplify/api_op_UpdateBranch.go b/service/amplify/api_op_UpdateBranch.go index cd28e01951c..5a8dd1e8455 100644 --- a/service/amplify/api_op_UpdateBranch.go +++ b/service/amplify/api_op_UpdateBranch.go @@ -58,33 +58,19 @@ func (c *Client) UpdateBranch(ctx context.Context, params *UpdateBranchInput, op // The request structure for the update branch request. type UpdateBranchInput struct { - // Enables notifications for the branch. - EnableNotification *bool - - // Enables pull request preview for this branch. - EnablePullRequestPreview *bool - - // Describes the current stage for the branch. - Stage types.Stage - // The unique ID for an Amplify app. // // This member is required. AppId *string - // The display name for a branch. This is used as the default domain prefix. - DisplayName *string - // The name for the branch. // // This member is required. BranchName *string - // The Amplify environment name for the pull request. - PullRequestEnvironmentName *string - - // The content Time to Live (TTL) for the website in seconds. - Ttl *string + // The Amazon Resource Name (ARN) for a backend environment that is part of an + // Amplify app. + BackendEnvironmentArn *string // The basic authorization credentials for the branch. BasicAuthCredentials *string @@ -92,24 +78,38 @@ type UpdateBranchInput struct { // The build specification (build spec) for the branch. BuildSpec *string - // The environment variables for the branch. - EnvironmentVariables map[string]*string + // The description for the branch. + Description *string - // The Amazon Resource Name (ARN) for a backend environment that is part of an - // Amplify app. - BackendEnvironmentArn *string + // The display name for a branch. This is used as the default domain prefix. + DisplayName *string // Enables auto building for the branch. EnableAutoBuild *bool + // Enables basic authorization for the branch. + EnableBasicAuth *bool + + // Enables notifications for the branch. + EnableNotification *bool + + // Enables pull request preview for this branch. + EnablePullRequestPreview *bool + + // The environment variables for the branch. + EnvironmentVariables map[string]*string + // The framework for the branch. Framework *string - // Enables basic authorization for the branch. - EnableBasicAuth *bool + // The Amplify environment name for the pull request. + PullRequestEnvironmentName *string - // The description for the branch. - Description *string + // Describes the current stage for the branch. + Stage types.Stage + + // The content Time to Live (TTL) for the website in seconds. + Ttl *string } // The result structure for the update branch request. diff --git a/service/amplify/api_op_UpdateDomainAssociation.go b/service/amplify/api_op_UpdateDomainAssociation.go index 12b389ea5d0..f3232e7b5b4 100644 --- a/service/amplify/api_op_UpdateDomainAssociation.go +++ b/service/amplify/api_op_UpdateDomainAssociation.go @@ -58,30 +58,30 @@ func (c *Client) UpdateDomainAssociation(ctx context.Context, params *UpdateDoma // The request structure for the update domain association request. type UpdateDomainAssociationInput struct { - // Enables the automated creation of subdomains for branches. - EnableAutoSubDomain *bool - - // Sets the branch patterns for automatic subdomain creation. - AutoSubDomainCreationPatterns []*string - - // The required AWS Identity and Access Management (IAM) service role for the - // Amazon Resource Name (ARN) for automatically creating subdomains. - AutoSubDomainIAMRole *string - // The unique ID for an Amplify app. // // This member is required. AppId *string - // Describes the settings for the subdomain. + // The name of the domain. // // This member is required. - SubDomainSettings []*types.SubDomainSetting + DomainName *string - // The name of the domain. + // Describes the settings for the subdomain. // // This member is required. - DomainName *string + SubDomainSettings []*types.SubDomainSetting + + // Sets the branch patterns for automatic subdomain creation. + AutoSubDomainCreationPatterns []*string + + // The required AWS Identity and Access Management (IAM) service role for the + // Amazon Resource Name (ARN) for automatically creating subdomains. + AutoSubDomainIAMRole *string + + // Enables the automated creation of subdomains for branches. + EnableAutoSubDomain *bool } // The result structure for the update domain association request. diff --git a/service/amplify/api_op_UpdateWebhook.go b/service/amplify/api_op_UpdateWebhook.go index b1f5af4e8d3..6ae37b8620f 100644 --- a/service/amplify/api_op_UpdateWebhook.go +++ b/service/amplify/api_op_UpdateWebhook.go @@ -58,16 +58,16 @@ func (c *Client) UpdateWebhook(ctx context.Context, params *UpdateWebhookInput, // The request structure for the update webhook request. type UpdateWebhookInput struct { + // The unique ID for a webhook. + // + // This member is required. + WebhookId *string + // The name for a branch that is part of an Amplify app. BranchName *string // The description for a webhook. Description *string - - // The unique ID for a webhook. - // - // This member is required. - WebhookId *string } // The result structure for the update webhook request. diff --git a/service/amplify/go.mod b/service/amplify/go.mod index 0ebfcd5a4f0..178bac06881 100644 --- a/service/amplify/go.mod +++ b/service/amplify/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/amplify go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/amplify/types/types.go b/service/amplify/types/types.go index 9c4a8800fbb..abd2c8f6662 100644 --- a/service/amplify/types/types.go +++ b/service/amplify/types/types.go @@ -10,157 +10,160 @@ import ( // hosting an Amplify app. type App struct { - // The platform for the Amplify app. + // The Amazon Resource Name (ARN) of the Amplify app. // // This member is required. - Platform Platform + AppArn *string - // Enables basic authorization for the Amplify app's branches. + // The unique ID of the Amplify app. // // This member is required. - EnableBasicAuth *bool + AppId *string - // The name for the Amplify app. + // Creates a date and time for the Amplify app. // // This member is required. - Name *string + CreateTime *time.Time - // The environment variables for the Amplify app. + // The default domain for the Amplify app. // // This member is required. - EnvironmentVariables map[string]*string - - // Describes the automated branch creation glob patterns for the Amplify app. - AutoBranchCreationPatterns []*string + DefaultDomain *string - // Updates the date and time for the Amplify app. + // The description for the Amplify app. // // This member is required. - UpdateTime *time.Time + Description *string - // The Amazon Resource Name (ARN) of the Amplify app. + // Enables basic authorization for the Amplify app's branches. // // This member is required. - AppArn *string - - // Describes the content of the build specification (build spec) for the Amplify - // app. - BuildSpec *string + EnableBasicAuth *bool - // The default domain for the Amplify app. + // Enables the auto-building of branches for the Amplify app. // // This member is required. - DefaultDomain *string + EnableBranchAutoBuild *bool - // Creates a date and time for the Amplify app. + // The environment variables for the Amplify app. // // This member is required. - CreateTime *time.Time + EnvironmentVariables map[string]*string - // The unique ID of the Amplify app. + // The name for the Amplify app. // // This member is required. - AppId *string - - // Enables automated branch creation for the Amplify app. - EnableAutoBranchCreation *bool - - // The basic authorization credentials for branches for the Amplify app. - BasicAuthCredentials *string - - // Automatically disconnect a branch in the Amplify Console when you delete a - // branch from your Git repository. - EnableBranchAutoDeletion *bool - - // The tag for the Amplify app. - Tags map[string]*string + Name *string - // Enables the auto-building of branches for the Amplify app. + // The platform for the Amplify app. // // This member is required. - EnableBranchAutoBuild *bool + Platform Platform // The repository for the Amplify app. // // This member is required. Repository *string - // The description for the Amplify app. + // Updates the date and time for the Amplify app. // // This member is required. - Description *string - - // Describes the information about a production branch of the Amplify app. - ProductionBranch *ProductionBranch + UpdateTime *time.Time // Describes the automated branch creation configuration for the Amplify app. AutoBranchCreationConfig *AutoBranchCreationConfig + // Describes the automated branch creation glob patterns for the Amplify app. + AutoBranchCreationPatterns []*string + + // The basic authorization credentials for branches for the Amplify app. + BasicAuthCredentials *string + + // Describes the content of the build specification (build spec) for the Amplify + // app. + BuildSpec *string + // Describes the custom redirect and rewrite rules for the Amplify app. CustomRules []*CustomRule + // Enables automated branch creation for the Amplify app. + EnableAutoBranchCreation *bool + + // Automatically disconnect a branch in the Amplify Console when you delete a + // branch from your Git repository. + EnableBranchAutoDeletion *bool + // The AWS Identity and Access Management (IAM) service role for the Amazon // Resource Name (ARN) of the Amplify app. IamServiceRoleArn *string + + // Describes the information about a production branch of the Amplify app. + ProductionBranch *ProductionBranch + + // The tag for the Amplify app. + Tags map[string]*string } // Describes an artifact. type Artifact struct { - // The unique ID for the artifact. + // The file name for the artifact. // // This member is required. - ArtifactId *string + ArtifactFileName *string - // The file name for the artifact. + // The unique ID for the artifact. // // This member is required. - ArtifactFileName *string + ArtifactId *string } // Describes the automated branch creation configuration. type AutoBranchCreationConfig struct { - // The Amplify environment name for the pull request. - PullRequestEnvironmentName *string + // The basic authorization credentials for the autocreated branch. + BasicAuthCredentials *string + + // The build specification (build spec) for the autocreated branch. + BuildSpec *string + + // Enables auto building for the autocreated branch. + EnableAutoBuild *bool // Enables basic authorization for the autocreated branch. EnableBasicAuth *bool - // The framework for the autocreated branch. - Framework *string - // Enables pull request preview for the autocreated branch. EnablePullRequestPreview *bool // The environment variables for the autocreated branch. EnvironmentVariables map[string]*string - // Enables auto building for the autocreated branch. - EnableAutoBuild *bool + // The framework for the autocreated branch. + Framework *string + + // The Amplify environment name for the pull request. + PullRequestEnvironmentName *string // Describes the current stage for the autocreated branch. Stage Stage - - // The basic authorization credentials for the autocreated branch. - BasicAuthCredentials *string - - // The build specification (build spec) for the autocreated branch. - BuildSpec *string } // Describes the backend environment for an Amplify app. type BackendEnvironment struct { - // The name of deployment artifacts. - DeploymentArtifacts *string - // The Amazon Resource Name (ARN) for a backend environment that is part of an // Amplify app. // // This member is required. BackendEnvironmentArn *string + // The creation date and time for a backend environment that is part of an Amplify + // app. + // + // This member is required. + CreateTime *time.Time + // The name for a backend environment that is part of an Amplify app. // // This member is required. @@ -172,11 +175,8 @@ type BackendEnvironment struct { // This member is required. UpdateTime *time.Time - // The creation date and time for a backend environment that is part of an Amplify - // app. - // - // This member is required. - CreateTime *time.Time + // The name of deployment artifacts. + DeploymentArtifacts *string // The AWS CloudFormation stack name of a backend environment. StackName *string @@ -185,29 +185,40 @@ type BackendEnvironment struct { // The branch for an Amplify app, which maps to a third-party repository branch. type Branch struct { + // The ID of the active job for a branch of an Amplify app. + // + // This member is required. + ActiveJobId *string + + // The Amazon Resource Name (ARN) for a branch that is part of an Amplify app. + // + // This member is required. + BranchArn *string + // The name for the branch that is part of an Amplify app. // // This member is required. BranchName *string - // The Amplify environment name for the pull request. - PullRequestEnvironmentName *string - - // The thumbnail URL for the branch of an Amplify app. - ThumbnailUrl *string + // The creation date and time for a branch that is part of an Amplify app. + // + // This member is required. + CreateTime *time.Time - // The tag for the branch of an Amplify app. - Tags map[string]*string + // The custom domains for a branch of an Amplify app. + // + // This member is required. + CustomDomains []*string - // The ID of the active job for a branch of an Amplify app. + // The description for the branch that is part of an Amplify app. // // This member is required. - ActiveJobId *string + Description *string - // The content Time to Live (TTL) for the website in seconds. + // The display name for the branch. This is used as the default domain prefix. // // This member is required. - Ttl *string + DisplayName *string // Enables auto-building on push for a branch of an Amplify app. // @@ -219,84 +230,73 @@ type Branch struct { // This member is required. EnableBasicAuth *bool - // The last updated date and time for a branch that is part of an Amplify app. + // Enables notifications for a branch that is part of an Amplify app. // // This member is required. - UpdateTime *time.Time + EnableNotification *bool + + // Enables pull request preview for the branch. + // + // This member is required. + EnablePullRequestPreview *bool + + // The environment variables specific to a branch of an Amplify app. + // + // This member is required. + EnvironmentVariables map[string]*string // The framework for a branch of an Amplify app. // // This member is required. Framework *string - // The destination branch if the branch is a pull request branch. - DestinationBranch *string - // The current stage for the branch that is part of an Amplify app. // // This member is required. Stage Stage - // The creation date and time for a branch that is part of an Amplify app. + // The total number of jobs that are part of an Amplify app. // // This member is required. - CreateTime *time.Time + TotalNumberOfJobs *string - // The build specification (build spec) content for the branch of an Amplify app. - BuildSpec *string + // The content Time to Live (TTL) for the website in seconds. + // + // This member is required. + Ttl *string - // The basic authorization credentials for a branch of an Amplify app. - BasicAuthCredentials *string + // The last updated date and time for a branch that is part of an Amplify app. + // + // This member is required. + UpdateTime *time.Time // A list of custom resources that are linked to this branch. AssociatedResources []*string - // The description for the branch that is part of an Amplify app. - // - // This member is required. - Description *string - // The Amazon Resource Name (ARN) for a backend environment that is part of an // Amplify app. BackendEnvironmentArn *string - // The display name for the branch. This is used as the default domain prefix. - // - // This member is required. - DisplayName *string + // The basic authorization credentials for a branch of an Amplify app. + BasicAuthCredentials *string - // The environment variables specific to a branch of an Amplify app. - // - // This member is required. - EnvironmentVariables map[string]*string + // The build specification (build spec) content for the branch of an Amplify app. + BuildSpec *string - // Enables pull request preview for the branch. - // - // This member is required. - EnablePullRequestPreview *bool + // The destination branch if the branch is a pull request branch. + DestinationBranch *string - // The total number of jobs that are part of an Amplify app. - // - // This member is required. - TotalNumberOfJobs *string + // The Amplify environment name for the pull request. + PullRequestEnvironmentName *string // The source branch if the branch is a pull request branch. SourceBranch *string - // The Amazon Resource Name (ARN) for a branch that is part of an Amplify app. - // - // This member is required. - BranchArn *string - - // The custom domains for a branch of an Amplify app. - // - // This member is required. - CustomDomains []*string + // The tag for the branch of an Amplify app. + Tags map[string]*string - // Enables notifications for a branch that is part of an Amplify app. - // - // This member is required. - EnableNotification *bool + // The thumbnail URL for the branch of an Amplify app. + ThumbnailUrl *string } // Describes a custom rewrite or redirect rule. @@ -307,22 +307,37 @@ type CustomRule struct { // This member is required. Source *string + // The target pattern for a URL rewrite or redirect rule. + // + // This member is required. + Target *string + // The condition for a URL rewrite or redirect rule, such as a country code. Condition *string // The status code for a URL rewrite or redirect rule. Status *string - - // The target pattern for a URL rewrite or redirect rule. - // - // This member is required. - Target *string } // Describes a domain association that associates a custom domain with an Amplify // app. type DomainAssociation struct { + // The Amazon Resource Name (ARN) for the domain association. + // + // This member is required. + DomainAssociationArn *string + + // The name of the domain. + // + // This member is required. + DomainName *string + + // The current status of the domain association. + // + // This member is required. + DomainStatus DomainStatus + // Enables the automated creation of subdomains for branches. // // This member is required. @@ -333,35 +348,20 @@ type DomainAssociation struct { // This member is required. StatusReason *string - // The DNS record for certificate verification. - CertificateVerificationDNSRecord *string - - // The Amazon Resource Name (ARN) for the domain association. + // The subdomains for the domain association. // // This member is required. - DomainAssociationArn *string + SubDomains []*SubDomain // Sets branch patterns for automatic subdomain creation. AutoSubDomainCreationPatterns []*string - // The current status of the domain association. - // - // This member is required. - DomainStatus DomainStatus - // The required AWS Identity and Access Management (IAM) service role for the // Amazon Resource Name (ARN) for automatically creating subdomains. AutoSubDomainIAMRole *string - // The name of the domain. - // - // This member is required. - DomainName *string - - // The subdomains for the domain association. - // - // This member is required. - SubDomains []*SubDomain + // The DNS record for certificate verification. + CertificateVerificationDNSRecord *string } // Describes an execution job for an Amplify app. @@ -381,112 +381,112 @@ type Job struct { // Describes the summary for an execution job for an Amplify app. type JobSummary struct { - // The start date and time for the job. + // The commit ID from a third-party repository provider for the job. // // This member is required. - StartTime *time.Time + CommitId *string - // The commit ID from a third-party repository provider for the job. + // The commit message from a third-party repository provider for the job. // // This member is required. - CommitId *string + CommitMessage *string - // The type for the job. If the value is RELEASE, the job was manually released - // from its source by using the StartJob API. If the value is RETRY, the job was - // manually retried using the StartJob API. If the value is WEB_HOOK, the job was - // automatically triggered by webhooks. + // The commit date and time for the job. // // This member is required. - JobType JobType + CommitTime *time.Time // The Amazon Resource Name (ARN) for the job. // // This member is required. JobArn *string - // The end date and time for the job. - EndTime *time.Time - - // The current status for the job. + // The unique ID for the job. // // This member is required. - Status JobStatus + JobId *string - // The unique ID for the job. + // The type for the job. If the value is RELEASE, the job was manually released + // from its source by using the StartJob API. If the value is RETRY, the job was + // manually retried using the StartJob API. If the value is WEB_HOOK, the job was + // automatically triggered by webhooks. // // This member is required. - JobId *string + JobType JobType - // The commit message from a third-party repository provider for the job. + // The start date and time for the job. // // This member is required. - CommitMessage *string + StartTime *time.Time - // The commit date and time for the job. + // The current status for the job. // // This member is required. - CommitTime *time.Time + Status JobStatus + + // The end date and time for the job. + EndTime *time.Time } // Describes the information about a production branch for an Amplify app. type ProductionBranch struct { - // The thumbnail URL for the production branch. - ThumbnailUrl *string - - // The status of the production branch. - Status *string + // The branch name for the production branch. + BranchName *string // The last deploy time of the production branch. LastDeployTime *time.Time - // The branch name for the production branch. - BranchName *string + // The status of the production branch. + Status *string + + // The thumbnail URL for the production branch. + ThumbnailUrl *string } // Describes an execution step, for an execution job, for an Amplify app. type Step struct { - // The context for the current step. Includes a build image if the step is build. - Context *string + // The end date and time of the execution step. + // + // This member is required. + EndTime *time.Time // The start date and time of the execution step. // // This member is required. StartTime *time.Time - // The name of the execution step. + // The status of the execution step. // // This member is required. - StepName *string + Status JobStatus - // The end date and time of the execution step. + // The name of the execution step. // // This member is required. - EndTime *time.Time + StepName *string // The URL to the artifact for the execution step. ArtifactsUrl *string - // The reason for the current step status. - StatusReason *string - - // The status of the execution step. - // - // This member is required. - Status JobStatus + // The context for the current step. Includes a build image if the step is build. + Context *string // The URL to the logs for the execution step. LogUrl *string - // The URL to the test configuration for the execution step. - TestConfigUrl *string - // The list of screenshot URLs for the execution step, if relevant. Screenshots map[string]*string + // The reason for the current step status. + StatusReason *string + // The URL to the test artifact for the execution step. TestArtifactsUrl *string + + // The URL to the test configuration for the execution step. + TestConfigUrl *string } // The subdomain for the domain association. @@ -497,63 +497,63 @@ type SubDomain struct { // This member is required. DnsRecord *string - // The verified status of the subdomain + // Describes the settings for the subdomain. // // This member is required. - Verified *bool + SubDomainSetting *SubDomainSetting - // Describes the settings for the subdomain. + // The verified status of the subdomain // // This member is required. - SubDomainSetting *SubDomainSetting + Verified *bool } // Describes the settings for the subdomain. type SubDomainSetting struct { - // The prefix setting for the subdomain. + // The branch name setting for the subdomain. // // This member is required. - Prefix *string + BranchName *string - // The branch name setting for the subdomain. + // The prefix setting for the subdomain. // // This member is required. - BranchName *string + Prefix *string } // Describes a webhook that connects repository events to an Amplify app. type Webhook struct { - // The description for a webhook. + // The name for a branch that is part of an Amplify app. // // This member is required. - Description *string + BranchName *string - // The ID of the webhook. + // The create date and time for a webhook. // // This member is required. - WebhookId *string + CreateTime *time.Time - // The create date and time for a webhook. + // The description for a webhook. // // This member is required. - CreateTime *time.Time + Description *string // Updates the date and time for a webhook. // // This member is required. UpdateTime *time.Time - // The name for a branch that is part of an Amplify app. + // The Amazon Resource Name (ARN) for the webhook. // // This member is required. - BranchName *string + WebhookArn *string - // The Amazon Resource Name (ARN) for the webhook. + // The ID of the webhook. // // This member is required. - WebhookArn *string + WebhookId *string // The URL of the webhook. // diff --git a/service/apigateway/api_op_CreateApiKey.go b/service/apigateway/api_op_CreateApiKey.go index 609c8357b99..c05ed0113cf 100644 --- a/service/apigateway/api_op_CreateApiKey.go +++ b/service/apigateway/api_op_CreateApiKey.go @@ -59,39 +59,40 @@ func (c *Client) CreateApiKey(ctx context.Context, params *CreateApiKeyInput, op // Request to create an ApiKey () resource. type CreateApiKeyInput struct { - TemplateSkipList []*string - - Template *bool - - Title *string - - // The name of the ApiKey (). - Name *string - // DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key. - StageKeys []*types.StageKey + // An AWS Marketplace customer identifier , when integrating with the AWS SaaS + // Marketplace. + CustomerId *string // The description of the ApiKey (). Description *string - // An AWS Marketplace customer identifier , when integrating with the AWS SaaS - // Marketplace. - CustomerId *string + // Specifies whether the ApiKey () can be used by callers. + Enabled *bool // Specifies whether (true) or not (false) the key identifier is distinct from the // created API key value. This parameter is deprecated and should not be used. GenerateDistinctId *bool + // The name of the ApiKey (). + Name *string + + // DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key. + StageKeys []*types.StageKey + // The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The // tag key can be up to 128 characters and must not start with aws:. The tag value // can be up to 256 characters. Tags map[string]*string + Template *bool + + TemplateSkipList []*string + + Title *string + // Specifies a value of the API key. Value *string - - // Specifies whether the ApiKey () can be used by callers. - Enabled *bool } // A resource that can be distributed to callers for executing Method () resources @@ -101,34 +102,34 @@ type CreateApiKeyInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-keys.html) type CreateApiKeyOutput struct { - // The name of the API Key. - Name *string - - // A list of Stage () resources that are associated with the ApiKey () resource. - StageKeys []*string - // The timestamp when the API Key was created. CreatedDate *time.Time - // The identifier of the API Key. - Id *string - // An AWS Marketplace customer identifier , when integrating with the AWS SaaS // Marketplace. CustomerId *string - // The timestamp when the API Key was last updated. - LastUpdatedDate *time.Time + // The description of the API Key. + Description *string // Specifies whether the API Key can be used by callers. Enabled *bool + // The identifier of the API Key. + Id *string + + // The timestamp when the API Key was last updated. + LastUpdatedDate *time.Time + + // The name of the API Key. + Name *string + + // A list of Stage () resources that are associated with the ApiKey () resource. + StageKeys []*string + // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string - // The description of the API Key. - Description *string - // The value of the API Key. Value *string diff --git a/service/apigateway/api_op_CreateAuthorizer.go b/service/apigateway/api_op_CreateAuthorizer.go index 94ed41c2c6a..00d1bf59b9d 100644 --- a/service/apigateway/api_op_CreateAuthorizer.go +++ b/service/apigateway/api_op_CreateAuthorizer.go @@ -59,7 +59,6 @@ func (c *Client) CreateAuthorizer(ctx context.Context, params *CreateAuthorizerI // Request to add a new Authorizer () to an existing RestApi () resource. type CreateAuthorizerInput struct { - Template *bool // [Required] The name of the authorizer. // @@ -71,10 +70,6 @@ type CreateAuthorizerInput struct { // This member is required. RestApiId *string - TemplateSkipList []*string - - Title *string - // [Required] The authorizer type. Valid values are TOKEN for a Lambda function // using a single authorization token submitted in a custom header, REQUEST for a // Lambda function using incoming request parameters, and COGNITO_USER_POOLS for @@ -87,20 +82,29 @@ type CreateAuthorizerInput struct { // functional impact. AuthType *string + // Specifies the required credentials as an IAM role for API Gateway to invoke the + // authorizer. To specify an IAM role for API Gateway to assume, use the role's + // Amazon Resource Name (ARN). To use resource-based permissions on the Lambda + // function, specify null. + AuthorizerCredentials *string + // The TTL in seconds of cached authorizer results. If it equals 0, authorization // caching is disabled. If it is greater than 0, API Gateway will cache authorizer // responses. If this field is not set, the default value is 300. The maximum value // is 3600, or 1 hour. AuthorizerResultTtlInSeconds *int32 - // A validation expression for the incoming identity token. For TOKEN authorizers, - // this value is a regular expression. For COGNITO_USER_POOLS authorizers, API - // Gateway will match the aud field of the incoming token from the client against - // the specified regular expression. It will invoke the authorizer's Lambda - // function when there is a match. Otherwise, it will return a 401 Unauthorized - // response without calling the Lambda function. The validation expression does not - // apply to the REQUEST authorizer. - IdentityValidationExpression *string + // Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or + // REQUEST authorizers, this must be a well-formed Lambda function URI, for + // example, + // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. + // In general, the URI has this form + // arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the + // same as the region hosting the Lambda function, path indicates that the + // remaining substring in the URI should be treated as the path to the resource, + // including the initial /. For Lambda functions, this is usually of the form + // /2015-03-31/functions/[FunctionARN]/invocations. + AuthorizerUri *string // The identity source for which authorization is requested. // @@ -126,29 +130,26 @@ type CreateAuthorizerInput struct { // optional. IdentitySource *string - // Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or - // REQUEST authorizers, this must be a well-formed Lambda function URI, for - // example, - // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. - // In general, the URI has this form - // arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the - // same as the region hosting the Lambda function, path indicates that the - // remaining substring in the URI should be treated as the path to the resource, - // including the initial /. For Lambda functions, this is usually of the form - // /2015-03-31/functions/[FunctionARN]/invocations. - AuthorizerUri *string - - // Specifies the required credentials as an IAM role for API Gateway to invoke the - // authorizer. To specify an IAM role for API Gateway to assume, use the role's - // Amazon Resource Name (ARN). To use resource-based permissions on the Lambda - // function, specify null. - AuthorizerCredentials *string + // A validation expression for the incoming identity token. For TOKEN authorizers, + // this value is a regular expression. For COGNITO_USER_POOLS authorizers, API + // Gateway will match the aud field of the incoming token from the client against + // the specified regular expression. It will invoke the authorizer's Lambda + // function when there is a match. Otherwise, it will return a 401 Unauthorized + // response without calling the Lambda function. The validation expression does not + // apply to the REQUEST authorizer. + IdentityValidationExpression *string // A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS // authorizer. Each element is of this format: // arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN // or REQUEST authorizer, this is not defined. ProviderARNs []*string + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents an authorization layer for methods. If enabled on a method, API @@ -159,8 +160,9 @@ type CreateAuthorizerInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html) type CreateAuthorizerOutput struct { - // [Required] The name of the authorizer. - Name *string + // Optional customer-defined field, used in OpenAPI imports and exports without + // functional impact. + AuthType *string // Specifies the required credentials as an IAM role for API Gateway to invoke the // authorizer. To specify an IAM role for API Gateway to assume, use the role's @@ -168,6 +170,27 @@ type CreateAuthorizerOutput struct { // function, specify null. AuthorizerCredentials *string + // The TTL in seconds of cached authorizer results. If it equals 0, authorization + // caching is disabled. If it is greater than 0, API Gateway will cache authorizer + // responses. If this field is not set, the default value is 300. The maximum value + // is 3600, or 1 hour. + AuthorizerResultTtlInSeconds *int32 + + // Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or + // REQUEST authorizers, this must be a well-formed Lambda function URI, for + // example, + // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. + // In general, the URI has this form + // arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the + // same as the region hosting the Lambda function, path indicates that the + // remaining substring in the URI should be treated as the path to the resource, + // including the initial /. For Lambda functions, this is usually of the form + // /2015-03-31/functions/[FunctionARN]/invocations. + AuthorizerUri *string + + // The identifier for the authorizer resource. + Id *string + // The identity source for which authorization is requested. // // * For a TOKEN or @@ -192,34 +215,6 @@ type CreateAuthorizerOutput struct { // optional. IdentitySource *string - // The authorizer type. Valid values are TOKEN for a Lambda function using a single - // authorization token submitted in a custom header, REQUEST for a Lambda function - // using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon - // Cognito user pool. - Type types.AuthorizerType - - // Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or - // REQUEST authorizers, this must be a well-formed Lambda function URI, for - // example, - // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. - // In general, the URI has this form - // arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the - // same as the region hosting the Lambda function, path indicates that the - // remaining substring in the URI should be treated as the path to the resource, - // including the initial /. For Lambda functions, this is usually of the form - // /2015-03-31/functions/[FunctionARN]/invocations. - AuthorizerUri *string - - // A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS - // authorizer. Each element is of this format: - // arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN - // or REQUEST authorizer, this is not defined. - ProviderARNs []*string - - // Optional customer-defined field, used in OpenAPI imports and exports without - // functional impact. - AuthType *string - // A validation expression for the incoming identity token. For TOKEN authorizers, // this value is a regular expression. For COGNITO_USER_POOLS authorizers, API // Gateway will match the aud field of the incoming token from the client against @@ -229,14 +224,20 @@ type CreateAuthorizerOutput struct { // apply to the REQUEST authorizer. IdentityValidationExpression *string - // The TTL in seconds of cached authorizer results. If it equals 0, authorization - // caching is disabled. If it is greater than 0, API Gateway will cache authorizer - // responses. If this field is not set, the default value is 300. The maximum value - // is 3600, or 1 hour. - AuthorizerResultTtlInSeconds *int32 + // [Required] The name of the authorizer. + Name *string - // The identifier for the authorizer resource. - Id *string + // A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS + // authorizer. Each element is of this format: + // arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN + // or REQUEST authorizer, this is not defined. + ProviderARNs []*string + + // The authorizer type. Valid values are TOKEN for a Lambda function using a single + // authorization token submitted in a custom header, REQUEST for a Lambda function + // using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon + // Cognito user pool. + Type types.AuthorizerType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigateway/api_op_CreateBasePathMapping.go b/service/apigateway/api_op_CreateBasePathMapping.go index 61c0d6df828..ad803319ec1 100644 --- a/service/apigateway/api_op_CreateBasePathMapping.go +++ b/service/apigateway/api_op_CreateBasePathMapping.go @@ -57,24 +57,12 @@ func (c *Client) CreateBasePathMapping(ctx context.Context, params *CreateBasePa // Requests API Gateway to create a new BasePathMapping () resource. type CreateBasePathMappingInput struct { - Name *string // [Required] The domain name of the BasePathMapping () resource to create. // // This member is required. DomainName *string - Title *string - - TemplateSkipList []*string - - Template *bool - - // The name of the API's stage that you want to use for this mapping. Specify - // '(none)' if you want callers to explicitly specify the stage name after any base - // path name. - Stage *string - // [Required] The string identifier of the associated RestApi (). // // This member is required. @@ -85,6 +73,19 @@ type CreateBasePathMappingInput struct { // single API. Specify '(none)' if you do not want callers to specify a base path // name after the domain name. BasePath *string + + Name *string + + // The name of the API's stage that you want to use for this mapping. Specify + // '(none)' if you want callers to explicitly specify the stage name after any base + // path name. + Stage *string + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents the base path that callers of the API must provide as part of the URL @@ -94,9 +95,6 @@ type CreateBasePathMappingInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) type CreateBasePathMappingOutput struct { - // The name of the associated stage. - Stage *string - // The base path name that callers of the API must provide as part of the URL after // the domain name. BasePath *string @@ -104,6 +102,9 @@ type CreateBasePathMappingOutput struct { // The string identifier of the associated RestApi (). RestApiId *string + // The name of the associated stage. + Stage *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_CreateDeployment.go b/service/apigateway/api_op_CreateDeployment.go index 9a98514c422..955d60a5a05 100644 --- a/service/apigateway/api_op_CreateDeployment.go +++ b/service/apigateway/api_op_CreateDeployment.go @@ -60,47 +60,48 @@ func (c *Client) CreateDeployment(ctx context.Context, params *CreateDeploymentI // Requests API Gateway to create a Deployment () resource. type CreateDeploymentInput struct { - Template *bool - - TemplateSkipList []*string - - Title *string - - Name *string // [Required] The string identifier of the associated RestApi (). // // This member is required. RestApiId *string - // Specifies whether active tracing with X-ray is enabled for the Stage (). - TracingEnabled *bool + // Enables a cache cluster for the Stage () resource specified in the input. + CacheClusterEnabled *bool + + // Specifies the cache cluster size for the Stage () resource specified in the + // input, if a cache cluster is enabled. + CacheClusterSize types.CacheClusterSize // The input configuration for the canary deployment when the deployment is a // canary release deployment. CanarySettings *types.DeploymentCanarySettings - // A map that defines the stage variables for the Stage () resource that is - // associated with the new deployment. Variable names can have alphanumeric and - // underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. - Variables map[string]*string + // The description for the Deployment () resource to create. + Description *string - // Specifies the cache cluster size for the Stage () resource specified in the - // input, if a cache cluster is enabled. - CacheClusterSize types.CacheClusterSize + Name *string // The description of the Stage () resource for the Deployment () resource to // create. StageDescription *string - // Enables a cache cluster for the Stage () resource specified in the input. - CacheClusterEnabled *bool - // The name of the Stage () resource for the Deployment () resource to create. StageName *string - // The description for the Deployment () resource to create. - Description *string + Template *bool + + TemplateSkipList []*string + + Title *string + + // Specifies whether active tracing with X-ray is enabled for the Stage (). + TracingEnabled *bool + + // A map that defines the stage variables for the Stage () resource that is + // associated with the new deployment. Variable names can have alphanumeric and + // underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. + Variables map[string]*string } // An immutable representation of a RestApi () resource that can be called by users @@ -114,19 +115,19 @@ type CreateDeploymentInput struct { // AWS SDKs (https://aws.amazon.com/tools/) type CreateDeploymentOutput struct { - // The date and time that the deployment resource was created. - CreatedDate *time.Time - // A summary of the RestApi () at the date and time that the deployment resource // was created. ApiSummary map[string]map[string]*types.MethodSnapshot - // The identifier for the deployment resource. - Id *string + // The date and time that the deployment resource was created. + CreatedDate *time.Time // The description for the deployment resource. Description *string + // The identifier for the deployment resource. + Id *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_CreateDocumentationPart.go b/service/apigateway/api_op_CreateDocumentationPart.go index 88bb51225ae..9f4ff25bd71 100644 --- a/service/apigateway/api_op_CreateDocumentationPart.go +++ b/service/apigateway/api_op_CreateDocumentationPart.go @@ -57,18 +57,12 @@ func (c *Client) CreateDocumentationPart(ctx context.Context, params *CreateDocu // Creates a new documentation part of a given API. type CreateDocumentationPartInput struct { - Name *string - // [Required] The string identifier of the associated RestApi (). + // [Required] The location of the targeted API entity of the to-be-created + // documentation part. // // This member is required. - RestApiId *string - - Template *bool - - TemplateSkipList []*string - - Title *string + Location *types.DocumentationPartLocation // [Required] The new documentation content map of the targeted API entity. // Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value @@ -77,11 +71,18 @@ type CreateDocumentationPartInput struct { // This member is required. Properties *string - // [Required] The location of the targeted API entity of the to-be-created - // documentation part. + // [Required] The string identifier of the associated RestApi (). // // This member is required. - Location *types.DocumentationPartLocation + RestApiId *string + + Name *string + + Template *bool + + TemplateSkipList []*string + + Title *string } // A documentation part for a targeted API entity. A documentation part consists of diff --git a/service/apigateway/api_op_CreateDocumentationVersion.go b/service/apigateway/api_op_CreateDocumentationVersion.go index 180f6792027..60b0f5895fd 100644 --- a/service/apigateway/api_op_CreateDocumentationVersion.go +++ b/service/apigateway/api_op_CreateDocumentationVersion.go @@ -57,29 +57,30 @@ func (c *Client) CreateDocumentationVersion(ctx context.Context, params *CreateD // Creates a new documentation version of a given API. type CreateDocumentationVersionInput struct { - Title *string - Name *string + // [Required] The version identifier of the new snapshot. + // + // This member is required. + DocumentationVersion *string // [Required] The string identifier of the associated RestApi (). // // This member is required. RestApiId *string - TemplateSkipList []*string + // A description about the new documentation snapshot. + Description *string - Template *bool + Name *string // The stage name to be associated with the new documentation snapshot. StageName *string - // [Required] The version identifier of the new snapshot. - // - // This member is required. - DocumentationVersion *string + Template *bool - // A description about the new documentation snapshot. - Description *string + TemplateSkipList []*string + + Title *string } // A snapshot of the documentation of an API. Publishing API documentation involves @@ -89,12 +90,12 @@ type CreateDocumentationVersionInput struct { // DocumentationPart (), DocumentationVersions () type CreateDocumentationVersionOutput struct { - // The description of the API documentation snapshot. - Description *string - // The date when the API documentation snapshot is created. CreatedDate *time.Time + // The description of the API documentation snapshot. + Description *string + // The version identifier of the API documentation snapshot. Version *string diff --git a/service/apigateway/api_op_CreateDomainName.go b/service/apigateway/api_op_CreateDomainName.go index df68fd16b72..38dd288c462 100644 --- a/service/apigateway/api_op_CreateDomainName.go +++ b/service/apigateway/api_op_CreateDomainName.go @@ -59,17 +59,21 @@ func (c *Client) CreateDomainName(ctx context.Context, params *CreateDomainNameI // A request to create a new domain name. type CreateDomainNameInput struct { - Template *bool - - Title *string - Name *string + // [Required] The name of the DomainName () resource. + // + // This member is required. + DomainName *string - TemplateSkipList []*string + // The reference to an AWS-managed certificate that will be used by edge-optimized + // endpoint for this domain name. AWS Certificate Manager is the only supported + // source. + CertificateArn *string - // [Deprecated] Your edge-optimized endpoint's domain name certificate's private - // key. - CertificatePrivateKey *string + // [Deprecated] The body of the server certificate that will be used by + // edge-optimized endpoint for this domain name provided by your certificate + // authority. + CertificateBody *string // [Deprecated] The intermediate certificates and optionally the root certificate, // one after the other without any blank lines, used by an edge-optimized endpoint @@ -80,46 +84,43 @@ type CreateDomainNameInput struct { // chain of trust path. CertificateChain *string - // The user-friendly name of the certificate that will be used by regional endpoint - // for this domain name. - RegionalCertificateName *string - - // The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The - // tag key can be up to 128 characters and must not start with aws:. The tag value - // can be up to 256 characters. - Tags map[string]*string - - // [Deprecated] The body of the server certificate that will be used by - // edge-optimized endpoint for this domain name provided by your certificate - // authority. - CertificateBody *string - // The user-friendly name of the certificate that will be used by edge-optimized // endpoint for this domain name. CertificateName *string - // [Required] The name of the DomainName () resource. - // - // This member is required. - DomainName *string + // [Deprecated] Your edge-optimized endpoint's domain name certificate's private + // key. + CertificatePrivateKey *string // The endpoint configuration of this DomainName () showing the endpoint types of // the domain name. EndpointConfiguration *types.EndpointConfiguration - // The Transport Layer Security (TLS) version + cipher suite for this DomainName - // (). The valid values are TLS_1_0 and TLS_1_2. - SecurityPolicy types.SecurityPolicy - - // The reference to an AWS-managed certificate that will be used by edge-optimized - // endpoint for this domain name. AWS Certificate Manager is the only supported - // source. - CertificateArn *string + Name *string // The reference to an AWS-managed certificate that will be used by regional // endpoint for this domain name. AWS Certificate Manager is the only supported // source. RegionalCertificateArn *string + + // The user-friendly name of the certificate that will be used by regional endpoint + // for this domain name. + RegionalCertificateName *string + + // The Transport Layer Security (TLS) version + cipher suite for this DomainName + // (). The valid values are TLS_1_0 and TLS_1_2. + SecurityPolicy types.SecurityPolicy + + // The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The + // tag key can be up to 128 characters and must not start with aws:. The tag value + // can be up to 256 characters. + Tags map[string]*string + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents a custom domain name as a user-friendly host name of an API (RestApi @@ -135,16 +136,26 @@ type CreateDomainNameInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) type CreateDomainNameOutput struct { - // The domain name associated with the regional endpoint for this custom domain - // name. You set up this association by adding a DNS record that points the custom - // domain name to this regional domain name. The regional domain name is returned - // by API Gateway when you create a regional endpoint. - RegionalDomainName *string + // The reference to an AWS-managed certificate that will be used by edge-optimized + // endpoint for this domain name. AWS Certificate Manager is the only supported + // source. + CertificateArn *string // The name of the certificate that will be used by edge-optimized endpoint for // this domain name. CertificateName *string + // The timestamp when the certificate that was used by edge-optimized endpoint for + // this domain name was uploaded. + CertificateUploadDate *time.Time + + // The domain name of the Amazon CloudFront distribution associated with this + // custom domain name for an edge-optimized endpoint. You set up this association + // when adding a DNS record pointing the custom domain name to this distribution + // name. For more information about CloudFront distributions, see the Amazon + // CloudFront documentation (https://aws.amazon.com/documentation/cloudfront/). + DistributionDomainName *string + // The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized // endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more // information, see Set up a Regional Custom Domain Name @@ -156,34 +167,33 @@ type CreateDomainNameOutput struct { // The custom domain name as an API host name, for example, my-api.example.com. DomainName *string - // The Transport Layer Security (TLS) version + cipher suite for this DomainName - // (). The valid values are TLS_1_0 and TLS_1_2. - SecurityPolicy types.SecurityPolicy + // The status of the DomainName () migration. The valid values are AVAILABLE and + // UPDATING. If the status is UPDATING, the domain cannot be modified further until + // the existing operation is complete. If it is AVAILABLE, the domain can be + // updated. + DomainNameStatus types.DomainNameStatus // An optional text message containing detailed information about status of the // DomainName () migration. DomainNameStatusMessage *string + // The endpoint configuration of this DomainName () showing the endpoint types of + // the domain name. + EndpointConfiguration *types.EndpointConfiguration + // The reference to an AWS-managed certificate that will be used for validating the // regional domain name. AWS Certificate Manager is the only supported source. RegionalCertificateArn *string - // The reference to an AWS-managed certificate that will be used by edge-optimized - // endpoint for this domain name. AWS Certificate Manager is the only supported - // source. - CertificateArn *string - - // The timestamp when the certificate that was used by edge-optimized endpoint for - // this domain name was uploaded. - CertificateUploadDate *time.Time - // The name of the certificate that will be used for validating the regional domain // name. RegionalCertificateName *string - // The endpoint configuration of this DomainName () showing the endpoint types of - // the domain name. - EndpointConfiguration *types.EndpointConfiguration + // The domain name associated with the regional endpoint for this custom domain + // name. You set up this association by adding a DNS record that points the custom + // domain name to this regional domain name. The regional domain name is returned + // by API Gateway when you create a regional endpoint. + RegionalDomainName *string // The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For // more information, see Set up a Regional Custom Domain Name @@ -192,22 +202,13 @@ type CreateDomainNameOutput struct { // (https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region). RegionalHostedZoneId *string - // The domain name of the Amazon CloudFront distribution associated with this - // custom domain name for an edge-optimized endpoint. You set up this association - // when adding a DNS record pointing the custom domain name to this distribution - // name. For more information about CloudFront distributions, see the Amazon - // CloudFront documentation (https://aws.amazon.com/documentation/cloudfront/). - DistributionDomainName *string + // The Transport Layer Security (TLS) version + cipher suite for this DomainName + // (). The valid values are TLS_1_0 and TLS_1_2. + SecurityPolicy types.SecurityPolicy // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string - // The status of the DomainName () migration. The valid values are AVAILABLE and - // UPDATING. If the status is UPDATING, the domain cannot be modified further until - // the existing operation is complete. If it is AVAILABLE, the domain can be - // updated. - DomainNameStatus types.DomainNameStatus - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_CreateModel.go b/service/apigateway/api_op_CreateModel.go index be2b4581382..cc14c373215 100644 --- a/service/apigateway/api_op_CreateModel.go +++ b/service/apigateway/api_op_CreateModel.go @@ -58,33 +58,33 @@ func (c *Client) CreateModel(ctx context.Context, params *CreateModelInput, optF // Request to add a new Model () to an existing RestApi () resource. type CreateModelInput struct { - // [Required] The RestApi () identifier under which the Model () will be created. + // [Required] The content-type for the model. // // This member is required. - RestApiId *string + ContentType *string // [Required] The name of the model. Must be alphanumeric. // // This member is required. Name *string - TemplateSkipList []*string - - Title *string - - Template *bool - - // [Required] The content-type for the model. + // [Required] The RestApi () identifier under which the Model () will be created. // // This member is required. - ContentType *string + RestApiId *string + + // The description of the model. + Description *string // The schema for the model. For application/json models, this should be JSON // schema draft 4 (https://tools.ietf.org/html/draft-zyp-json-schema-04) model. Schema *string - // The description of the model. - Description *string + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents the data structure of a method's request or response payload. A @@ -97,18 +97,18 @@ type CreateModelInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html) type CreateModelOutput struct { - // The identifier for the model resource. - Id *string - - // The name of the model. Must be an alphanumeric string. - Name *string - // The content-type for the model. ContentType *string // The description of the model. Description *string + // The identifier for the model resource. + Id *string + + // The name of the model. Must be an alphanumeric string. + Name *string + // The schema for the model. For application/json models, this should be JSON // schema draft 4 (https://tools.ietf.org/html/draft-zyp-json-schema-04) model. Do // not include "\*/" characters in the description of any properties because such diff --git a/service/apigateway/api_op_CreateRequestValidator.go b/service/apigateway/api_op_CreateRequestValidator.go index 3a392d94b89..2bf194011da 100644 --- a/service/apigateway/api_op_CreateRequestValidator.go +++ b/service/apigateway/api_op_CreateRequestValidator.go @@ -57,20 +57,21 @@ func (c *Client) CreateRequestValidator(ctx context.Context, params *CreateReque // Creates a RequestValidator () of a given RestApi (). type CreateRequestValidatorInput struct { - Template *bool - - Title *string // [Required] The string identifier of the associated RestApi (). // // This member is required. RestApiId *string - TemplateSkipList []*string - // The name of the to-be-created RequestValidator (). Name *string + Template *bool + + TemplateSkipList []*string + + Title *string + // A Boolean flag to indicate whether to validate request body according to the // configured model schema for the method (true) or not (false). ValidateRequestBody *bool @@ -93,6 +94,9 @@ type CreateRequestValidatorOutput struct { // The identifier of this RequestValidator (). Id *string + // The name of this RequestValidator () + Name *string + // A Boolean flag to indicate whether to validate a request body according to the // configured Model () schema. ValidateRequestBody *bool @@ -101,9 +105,6 @@ type CreateRequestValidatorOutput struct { // (false). ValidateRequestParameters *bool - // The name of this RequestValidator () - Name *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_CreateResource.go b/service/apigateway/api_op_CreateResource.go index c5dabf8f66e..afb1766019c 100644 --- a/service/apigateway/api_op_CreateResource.go +++ b/service/apigateway/api_op_CreateResource.go @@ -58,28 +58,29 @@ func (c *Client) CreateResource(ctx context.Context, params *CreateResourceInput // Requests API Gateway to create a Resource () resource. type CreateResourceInput struct { - Template *bool // [Required] The parent resource's identifier. // // This member is required. ParentId *string - Name *string - - Title *string + // The last path segment for this resource. + // + // This member is required. + PathPart *string // [Required] The string identifier of the associated RestApi (). // // This member is required. RestApiId *string + Name *string + + Template *bool + TemplateSkipList []*string - // The last path segment for this resource. - // - // This member is required. - PathPart *string + Title *string } // Represents an API resource. Create an API @@ -89,6 +90,15 @@ type CreateResourceOutput struct { // The resource's identifier. Id *string + // The parent resource's identifier. + ParentId *string + + // The full path for this resource. + Path *string + + // The last path segment for this resource. + PathPart *string + // Gets an API resource's method of a given HTTP verb. The resource methods are a // map of methods indexed by methods' HTTP verbs enabled on the resource. This // method map is included in the 200 OK response of the GET @@ -170,15 +180,6 @@ type CreateResourceOutput struct { // OPTIONS. ResourceMethods map[string]*types.Method - // The parent resource's identifier. - ParentId *string - - // The full path for this resource. - Path *string - - // The last path segment for this resource. - PathPart *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_CreateRestApi.go b/service/apigateway/api_op_CreateRestApi.go index e7fe4aab824..30c87f817f3 100644 --- a/service/apigateway/api_op_CreateRestApi.go +++ b/service/apigateway/api_op_CreateRestApi.go @@ -59,24 +59,12 @@ func (c *Client) CreateRestApi(ctx context.Context, params *CreateRestApiInput, // The POST Request to add a new RestApi () resource to your collection. type CreateRestApiInput struct { - TemplateSkipList []*string // [Required] The name of the RestApi (). // // This member is required. Name *string - Title *string - - Template *bool - - // A version identifier for the API. - Version *string - - // The list of binary media types supported by the RestApi (). By default, the - // RestApi () supports only UTF-8-encoded text payloads. - BinaryMediaTypes []*string - // The source of the API key for metering requests according to a usage plan. Valid // values are: // @@ -87,9 +75,16 @@ type CreateRestApiInput struct { // a custom authorizer. ApiKeySource types.ApiKeySourceType + // The list of binary media types supported by the RestApi (). By default, the + // RestApi () supports only UTF-8-encoded text payloads. + BinaryMediaTypes []*string + // The ID of the RestApi () that you want to clone from. CloneFrom *string + // The description of the RestApi (). + Description *string + // The endpoint configuration of this RestApi () showing the endpoint types of the // API. EndpointConfiguration *types.EndpointConfiguration @@ -101,9 +96,6 @@ type CreateRestApiInput struct { // Setting it to zero allows compression for any payload size. MinimumCompressionSize *int32 - // The description of the RestApi (). - Description *string - // A stringified JSON policy document that applies to this RestApi regardless of // the caller and Method () configuration. Policy *string @@ -112,23 +104,21 @@ type CreateRestApiInput struct { // tag key can be up to 128 characters and must not start with aws:. The tag value // can be up to 256 characters. Tags map[string]*string + + Template *bool + + TemplateSkipList []*string + + Title *string + + // A version identifier for the API. + Version *string } // Represents a REST API. Create an API // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) type CreateRestApiOutput struct { - // The API's description. - Description *string - - // A stringified JSON policy document that applies to this RestApi regardless of - // the caller and Method () configuration. - Policy *string - - // The endpoint configuration of this RestApi () showing the endpoint types of the - // API. - EndpointConfiguration *types.EndpointConfiguration - // The source of the API key for metering requests according to a usage plan. Valid // values are: // @@ -139,30 +129,24 @@ type CreateRestApiOutput struct { // a custom authorizer. ApiKeySource types.ApiKeySourceType - // The API's name. - Name *string - - // A version identifier for the API. - Version *string - - // The collection of tags. Each tag element is associated with a given resource. - Tags map[string]*string - - // The warning messages reported when failonwarnings is turned on during API - // import. - Warnings []*string + // The list of binary media types supported by the RestApi (). By default, the + // RestApi () supports only UTF-8-encoded text payloads. + BinaryMediaTypes []*string // The timestamp when the API was created. CreatedDate *time.Time + // The API's description. + Description *string + + // The endpoint configuration of this RestApi () showing the endpoint types of the + // API. + EndpointConfiguration *types.EndpointConfiguration + // The API's identifier. This identifier is unique across all of your APIs in API // Gateway. Id *string - // The list of binary media types supported by the RestApi (). By default, the - // RestApi () supports only UTF-8-encoded text payloads. - BinaryMediaTypes []*string - // A nullable integer that is used to enable compression (with non-negative between // 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null // value) on an API. When compression is enabled, compression or decompression is @@ -170,6 +154,23 @@ type CreateRestApiOutput struct { // Setting it to zero allows compression for any payload size. MinimumCompressionSize *int32 + // The API's name. + Name *string + + // A stringified JSON policy document that applies to this RestApi regardless of + // the caller and Method () configuration. + Policy *string + + // The collection of tags. Each tag element is associated with a given resource. + Tags map[string]*string + + // A version identifier for the API. + Version *string + + // The warning messages reported when failonwarnings is turned on during API + // import. + Warnings []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_CreateStage.go b/service/apigateway/api_op_CreateStage.go index 2944f704fe0..0fdbca7d3da 100644 --- a/service/apigateway/api_op_CreateStage.go +++ b/service/apigateway/api_op_CreateStage.go @@ -60,21 +60,27 @@ func (c *Client) CreateStage(ctx context.Context, params *CreateStageInput, optF // Requests API Gateway to create a Stage () resource. type CreateStageInput struct { - Template *bool - - Title *string - - Name *string - TemplateSkipList []*string + // [Required] The identifier of the Deployment () resource for the Stage () + // resource. + // + // This member is required. + DeploymentId *string // [Required] The string identifier of the associated RestApi (). // // This member is required. RestApiId *string - // Specifies whether active tracing with X-ray is enabled for the Stage (). - TracingEnabled *bool + // [Required] The name for the Stage () resource. Stage names can only contain + // alphanumeric characters, hyphens, and underscores. Maximum length is 128 + // characters. + // + // This member is required. + StageName *string + + // Whether cache clustering is enabled for the stage. + CacheClusterEnabled *bool // The stage's cache cluster size. CacheClusterSize types.CacheClusterSize @@ -82,37 +88,32 @@ type CreateStageInput struct { // The canary deployment settings of this stage. CanarySettings *types.CanarySettings - // Whether cache clustering is enabled for the stage. - CacheClusterEnabled *bool + // The description of the Stage () resource. + Description *string - // A map that defines the stage variables for the new Stage () resource. Variable - // names can have alphanumeric and underscore characters, and the values must match - // [A-Za-z0-9-._~:/?#&=,]+. - Variables map[string]*string + // The version of the associated API documentation. + DocumentationVersion *string + + Name *string // The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The // tag key can be up to 128 characters and must not start with aws:. The tag value // can be up to 256 characters. Tags map[string]*string - // The description of the Stage () resource. - Description *string + Template *bool - // [Required] The name for the Stage () resource. Stage names can only contain - // alphanumeric characters, hyphens, and underscores. Maximum length is 128 - // characters. - // - // This member is required. - StageName *string + TemplateSkipList []*string - // [Required] The identifier of the Deployment () resource for the Stage () - // resource. - // - // This member is required. - DeploymentId *string + Title *string - // The version of the associated API documentation. - DocumentationVersion *string + // Specifies whether active tracing with X-ray is enabled for the Stage (). + TracingEnabled *bool + + // A map that defines the stage variables for the new Stage () resource. Variable + // names can have alphanumeric and underscore characters, and the values must match + // [A-Za-z0-9-._~:/?#&=,]+. + Variables map[string]*string } // Represents a unique identifier for a version of a deployed RestApi () that is @@ -120,43 +121,32 @@ type CreateStageInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api.html) type CreateStageOutput struct { - // The identifier of the Deployment () that the stage points to. - DeploymentId *string - - // The stage's description. - Description *string + // Settings for logging access in this stage. + AccessLogSettings *types.AccessLogSettings - // The name of the stage is the first path segment in the Uniform Resource - // Identifier (URI) of a call to API Gateway. Stage names can only contain - // alphanumeric characters, hyphens, and underscores. Maximum length is 128 - // characters. - StageName *string + // Specifies whether a cache cluster is enabled for the stage. + CacheClusterEnabled *bool - // The collection of tags. Each tag element is associated with a given resource. - Tags map[string]*string + // The size of the cache cluster for the stage, if enabled. + CacheClusterSize types.CacheClusterSize // The status of the cache cluster for the stage, if enabled. CacheClusterStatus types.CacheClusterStatus - // The identifier of a client certificate for an API stage. - ClientCertificateId *string - - // Specifies whether a cache cluster is enabled for the stage. - CacheClusterEnabled *bool - // Settings for the canary deployment in this stage. CanarySettings *types.CanarySettings - // A map that defines the stage variables for a Stage () resource. Variable names - // can have alphanumeric and underscore characters, and the values must match - // [A-Za-z0-9-._~:/?#&=,]+. - Variables map[string]*string + // The identifier of a client certificate for an API stage. + ClientCertificateId *string - // The size of the cache cluster for the stage, if enabled. - CacheClusterSize types.CacheClusterSize + // The timestamp when the stage was created. + CreatedDate *time.Time - // Settings for logging access in this stage. - AccessLogSettings *types.AccessLogSettings + // The identifier of the Deployment () that the stage points to. + DeploymentId *string + + // The stage's description. + Description *string // The version of the associated API documentation. DocumentationVersion *string @@ -164,21 +154,32 @@ type CreateStageOutput struct { // The timestamp when the stage last updated. LastUpdatedDate *time.Time - // The timestamp when the stage was created. - CreatedDate *time.Time + // A map that defines the method settings for a Stage () resource. Keys (designated + // as /{method_setting_key below) are method paths defined as + // {resource_path}/{http_method} for an individual method override, or /\*/\* for + // overriding all methods in the stage. + MethodSettings map[string]*types.MethodSetting + + // The name of the stage is the first path segment in the Uniform Resource + // Identifier (URI) of a call to API Gateway. Stage names can only contain + // alphanumeric characters, hyphens, and underscores. Maximum length is 128 + // characters. + StageName *string + + // The collection of tags. Each tag element is associated with a given resource. + Tags map[string]*string // Specifies whether active tracing with X-ray is enabled for the Stage (). TracingEnabled *bool + // A map that defines the stage variables for a Stage () resource. Variable names + // can have alphanumeric and underscore characters, and the values must match + // [A-Za-z0-9-._~:/?#&=,]+. + Variables map[string]*string + // The ARN of the WebAcl associated with the Stage (). WebAclArn *string - // A map that defines the method settings for a Stage () resource. Keys (designated - // as /{method_setting_key below) are method paths defined as - // {resource_path}/{http_method} for an individual method override, or /\*/\* for - // overriding all methods in the stage. - MethodSettings map[string]*types.MethodSetting - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_CreateUsagePlan.go b/service/apigateway/api_op_CreateUsagePlan.go index 6cfc9e1be30..e8c71ae4704 100644 --- a/service/apigateway/api_op_CreateUsagePlan.go +++ b/service/apigateway/api_op_CreateUsagePlan.go @@ -67,28 +67,28 @@ type CreateUsagePlanInput struct { // This member is required. Name *string - Title *string - - Template *bool + // The associated API stages of the usage plan. + ApiStages []*types.ApiStage - TemplateSkipList []*string + // The description of the usage plan. + Description *string - // The throttling limits of the usage plan. - Throttle *types.ThrottleSettings + // The quota of the usage plan. + Quota *types.QuotaSettings // The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The // tag key can be up to 128 characters and must not start with aws:. The tag value // can be up to 256 characters. Tags map[string]*string - // The associated API stages of the usage plan. - ApiStages []*types.ApiStage + Template *bool - // The description of the usage plan. - Description *string + TemplateSkipList []*string - // The quota of the usage plan. - Quota *types.QuotaSettings + // The throttling limits of the usage plan. + Throttle *types.ThrottleSettings + + Title *string } // Represents a usage plan than can specify who can assess associated API stages @@ -98,18 +98,18 @@ type CreateUsagePlanInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) type CreateUsagePlanOutput struct { + // The associated API stages of a usage plan. + ApiStages []*types.ApiStage + + // The description of a usage plan. + Description *string + // The identifier of a UsagePlan () resource. Id *string - // The request throttle limits of a usage plan. - Throttle *types.ThrottleSettings - // The name of a usage plan. Name *string - // The associated API stages of a usage plan. - ApiStages []*types.ApiStage - // The AWS Markeplace product identifier to associate with the usage plan as a SaaS // product on AWS Marketplace. ProductCode *string @@ -120,8 +120,8 @@ type CreateUsagePlanOutput struct { // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string - // The description of a usage plan. - Description *string + // The request throttle limits of a usage plan. + Throttle *types.ThrottleSettings // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigateway/api_op_CreateUsagePlanKey.go b/service/apigateway/api_op_CreateUsagePlanKey.go index 0a7fff6b370..8cd9128ac6a 100644 --- a/service/apigateway/api_op_CreateUsagePlanKey.go +++ b/service/apigateway/api_op_CreateUsagePlanKey.go @@ -58,30 +58,31 @@ func (c *Client) CreateUsagePlanKey(ctx context.Context, params *CreateUsagePlan // The POST request to create a usage plan key for adding an existing API key to a // usage plan. type CreateUsagePlanKeyInput struct { - Template *bool - - Name *string - - TemplateSkipList []*string - Title *string - - // [Required] The Id of the UsagePlan () resource representing the usage plan - // containing the to-be-created UsagePlanKey () resource representing a plan - // customer. + // [Required] The identifier of a UsagePlanKey () resource for a plan customer. // // This member is required. - UsagePlanId *string + KeyId *string // [Required] The type of a UsagePlanKey () resource for a plan customer. // // This member is required. KeyType *string - // [Required] The identifier of a UsagePlanKey () resource for a plan customer. + // [Required] The Id of the UsagePlan () resource representing the usage plan + // containing the to-be-created UsagePlanKey () resource representing a plan + // customer. // // This member is required. - KeyId *string + UsagePlanId *string + + Name *string + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents a usage plan key to identify a plan customer. To associate an API @@ -90,18 +91,18 @@ type CreateUsagePlanKeyInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) type CreateUsagePlanKeyOutput struct { - // The name of a usage plan key. - Name *string - - // The value of a usage plan key. - Value *string - // The Id of a usage plan key. Id *string + // The name of a usage plan key. + Name *string + // The type of a usage plan key. Currently, the valid key type is API_KEY. Type *string + // The value of a usage plan key. + Value *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_CreateVpcLink.go b/service/apigateway/api_op_CreateVpcLink.go index 9145406f7db..6987ad1b43f 100644 --- a/service/apigateway/api_op_CreateVpcLink.go +++ b/service/apigateway/api_op_CreateVpcLink.go @@ -70,12 +70,6 @@ type CreateVpcLinkInput struct { // This member is required. Name *string - Template *bool - - Title *string - - TemplateSkipList []*string - // [Required] The ARN of the network load balancer of the VPC targeted by the VPC // link. The network load balancer must be owned by the same AWS account of the API // owner. @@ -90,6 +84,12 @@ type CreateVpcLinkInput struct { // tag key can be up to 128 characters and must not start with aws:. The tag value // can be up to 256 characters. Tags map[string]*string + + Template *bool + + TemplateSkipList []*string + + Title *string } // An API Gateway VPC link for a RestApi () to access resources in an Amazon @@ -102,6 +102,9 @@ type CreateVpcLinkInput struct { // connectionId property to identify the VpcLink () used. type CreateVpcLinkOutput struct { + // The description of the VPC link. + Description *string + // The identifier of the VpcLink (). It is used in an Integration () to reference // this VpcLink (). Id *string @@ -109,24 +112,21 @@ type CreateVpcLinkOutput struct { // The name used to label and identify the VPC link. Name *string - // The description of the VPC link. - Description *string - - // A description about the VPC link status. - StatusMessage *string - - // The ARN of the network load balancer of the VPC targeted by the VPC link. The - // network load balancer must be owned by the same AWS account of the API owner. - TargetArns []*string - // The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, // or FAILED. Deploying an API will wait if the status is PENDING and will fail if // the status is DELETING. Status types.VpcLinkStatus + // A description about the VPC link status. + StatusMessage *string + // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string + // The ARN of the network load balancer of the VPC targeted by the VPC link. The + // network load balancer must be owned by the same AWS account of the API owner. + TargetArns []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_DeleteApiKey.go b/service/apigateway/api_op_DeleteApiKey.go index a8f155e5a28..8bf07bebb26 100644 --- a/service/apigateway/api_op_DeleteApiKey.go +++ b/service/apigateway/api_op_DeleteApiKey.go @@ -57,18 +57,19 @@ func (c *Client) DeleteApiKey(ctx context.Context, params *DeleteApiKeyInput, op // A request to delete the ApiKey () resource. type DeleteApiKeyInput struct { - Name *string - - TemplateSkipList []*string // [Required] The identifier of the ApiKey () resource to be deleted. // // This member is required. ApiKey *string - Title *string + Name *string Template *bool + + TemplateSkipList []*string + + Title *string } type DeleteApiKeyOutput struct { diff --git a/service/apigateway/api_op_DeleteAuthorizer.go b/service/apigateway/api_op_DeleteAuthorizer.go index 688e439d45b..6f5f1af4164 100644 --- a/service/apigateway/api_op_DeleteAuthorizer.go +++ b/service/apigateway/api_op_DeleteAuthorizer.go @@ -58,20 +58,21 @@ func (c *Client) DeleteAuthorizer(ctx context.Context, params *DeleteAuthorizerI // Request to delete an existing Authorizer () resource. type DeleteAuthorizerInput struct { - Template *bool // [Required] The identifier of the Authorizer () resource. // // This member is required. AuthorizerId *string - Name *string - // [Required] The string identifier of the associated RestApi (). // // This member is required. RestApiId *string + Name *string + + Template *bool + TemplateSkipList []*string Title *string diff --git a/service/apigateway/api_op_DeleteBasePathMapping.go b/service/apigateway/api_op_DeleteBasePathMapping.go index e68c0c30f93..51e58db36c9 100644 --- a/service/apigateway/api_op_DeleteBasePathMapping.go +++ b/service/apigateway/api_op_DeleteBasePathMapping.go @@ -57,24 +57,25 @@ func (c *Client) DeleteBasePathMapping(ctx context.Context, params *DeleteBasePa // A request to delete the BasePathMapping () resource. type DeleteBasePathMappingInput struct { - Name *string + + // [Required] The base path name of the BasePathMapping () resource to delete. To + // specify an empty base path, set this parameter to '(none)'. + // + // This member is required. + BasePath *string // [Required] The domain name of the BasePathMapping () resource to delete. // // This member is required. DomainName *string - TemplateSkipList []*string + Name *string - Title *string + Template *bool - // [Required] The base path name of the BasePathMapping () resource to delete. To - // specify an empty base path, set this parameter to '(none)'. - // - // This member is required. - BasePath *string + TemplateSkipList []*string - Template *bool + Title *string } type DeleteBasePathMappingOutput struct { diff --git a/service/apigateway/api_op_DeleteClientCertificate.go b/service/apigateway/api_op_DeleteClientCertificate.go index dd7fd5452e4..f8077c95a4c 100644 --- a/service/apigateway/api_op_DeleteClientCertificate.go +++ b/service/apigateway/api_op_DeleteClientCertificate.go @@ -57,15 +57,16 @@ func (c *Client) DeleteClientCertificate(ctx context.Context, params *DeleteClie // A request to delete the ClientCertificate () resource. type DeleteClientCertificateInput struct { - Template *bool - - Name *string // [Required] The identifier of the ClientCertificate () resource to be deleted. // // This member is required. ClientCertificateId *string + Name *string + + Template *bool + TemplateSkipList []*string Title *string diff --git a/service/apigateway/api_op_DeleteDeployment.go b/service/apigateway/api_op_DeleteDeployment.go index d2be8905b8f..dcae9a62dc3 100644 --- a/service/apigateway/api_op_DeleteDeployment.go +++ b/service/apigateway/api_op_DeleteDeployment.go @@ -58,11 +58,6 @@ func (c *Client) DeleteDeployment(ctx context.Context, params *DeleteDeploymentI // Requests API Gateway to delete a Deployment () resource. type DeleteDeploymentInput struct { - TemplateSkipList []*string - - Title *string - - Name *string // [Required] The identifier of the Deployment () resource to delete. // @@ -74,7 +69,13 @@ type DeleteDeploymentInput struct { // This member is required. RestApiId *string + Name *string + Template *bool + + TemplateSkipList []*string + + Title *string } type DeleteDeploymentOutput struct { diff --git a/service/apigateway/api_op_DeleteDocumentationPart.go b/service/apigateway/api_op_DeleteDocumentationPart.go index 096d6dfdcf3..0e18a3c8dd9 100644 --- a/service/apigateway/api_op_DeleteDocumentationPart.go +++ b/service/apigateway/api_op_DeleteDocumentationPart.go @@ -57,23 +57,23 @@ func (c *Client) DeleteDocumentationPart(ctx context.Context, params *DeleteDocu // Deletes an existing documentation part of an API. type DeleteDocumentationPartInput struct { + // [Required] The identifier of the to-be-deleted documentation part. + // + // This member is required. + DocumentationPartId *string + // [Required] The string identifier of the associated RestApi (). // // This member is required. RestApiId *string + Name *string + Template *bool TemplateSkipList []*string Title *string - - Name *string - - // [Required] The identifier of the to-be-deleted documentation part. - // - // This member is required. - DocumentationPartId *string } type DeleteDocumentationPartOutput struct { diff --git a/service/apigateway/api_op_DeleteDocumentationVersion.go b/service/apigateway/api_op_DeleteDocumentationVersion.go index 9981b8bd559..b034d9ed7f9 100644 --- a/service/apigateway/api_op_DeleteDocumentationVersion.go +++ b/service/apigateway/api_op_DeleteDocumentationVersion.go @@ -56,9 +56,6 @@ func (c *Client) DeleteDocumentationVersion(ctx context.Context, params *DeleteD // Deletes an existing documentation version of an API. type DeleteDocumentationVersionInput struct { - Title *string - - TemplateSkipList []*string // [Required] The version identifier of a to-be-deleted documentation snapshot. // @@ -70,9 +67,13 @@ type DeleteDocumentationVersionInput struct { // This member is required. RestApiId *string + Name *string + Template *bool - Name *string + TemplateSkipList []*string + + Title *string } type DeleteDocumentationVersionOutput struct { diff --git a/service/apigateway/api_op_DeleteDomainName.go b/service/apigateway/api_op_DeleteDomainName.go index 02ced2f78ec..8c57458d7c3 100644 --- a/service/apigateway/api_op_DeleteDomainName.go +++ b/service/apigateway/api_op_DeleteDomainName.go @@ -57,18 +57,19 @@ func (c *Client) DeleteDomainName(ctx context.Context, params *DeleteDomainNameI // A request to delete the DomainName () resource. type DeleteDomainNameInput struct { - Template *bool - Title *string + // [Required] The name of the DomainName () resource to be deleted. + // + // This member is required. + DomainName *string Name *string + Template *bool + TemplateSkipList []*string - // [Required] The name of the DomainName () resource to be deleted. - // - // This member is required. - DomainName *string + Title *string } type DeleteDomainNameOutput struct { diff --git a/service/apigateway/api_op_DeleteGatewayResponse.go b/service/apigateway/api_op_DeleteGatewayResponse.go index 499e537c067..8220c74983e 100644 --- a/service/apigateway/api_op_DeleteGatewayResponse.go +++ b/service/apigateway/api_op_DeleteGatewayResponse.go @@ -61,13 +61,6 @@ func (c *Client) DeleteGatewayResponse(ctx context.Context, params *DeleteGatewa // the given RestApi () and resets it with the default settings. type DeleteGatewayResponseInput struct { - // [Required] The string identifier of the associated RestApi (). - // - // This member is required. - RestApiId *string - - Template *bool - // [Required] The response type of the associated GatewayResponse (). Valid values // are // @@ -121,11 +114,18 @@ type DeleteGatewayResponseInput struct { // This member is required. ResponseType types.GatewayResponseType + // [Required] The string identifier of the associated RestApi (). + // + // This member is required. + RestApiId *string + + Name *string + + Template *bool + TemplateSkipList []*string Title *string - - Name *string } type DeleteGatewayResponseOutput struct { diff --git a/service/apigateway/api_op_DeleteIntegration.go b/service/apigateway/api_op_DeleteIntegration.go index 5828d6d91d7..d3983b5858a 100644 --- a/service/apigateway/api_op_DeleteIntegration.go +++ b/service/apigateway/api_op_DeleteIntegration.go @@ -57,28 +57,29 @@ func (c *Client) DeleteIntegration(ctx context.Context, params *DeleteIntegratio // Represents a delete integration request. type DeleteIntegrationInput struct { - TemplateSkipList []*string - - Title *string // [Required] Specifies a delete integration request's HTTP method. // // This member is required. HttpMethod *string - // [Required] The string identifier of the associated RestApi (). + // [Required] Specifies a delete integration request's resource identifier. // // This member is required. - RestApiId *string + ResourceId *string - // [Required] Specifies a delete integration request's resource identifier. + // [Required] The string identifier of the associated RestApi (). // // This member is required. - ResourceId *string + RestApiId *string + + Name *string Template *bool - Name *string + TemplateSkipList []*string + + Title *string } type DeleteIntegrationOutput struct { diff --git a/service/apigateway/api_op_DeleteIntegrationResponse.go b/service/apigateway/api_op_DeleteIntegrationResponse.go index 4246a51b91c..e844f95dd39 100644 --- a/service/apigateway/api_op_DeleteIntegrationResponse.go +++ b/service/apigateway/api_op_DeleteIntegrationResponse.go @@ -57,7 +57,11 @@ func (c *Client) DeleteIntegrationResponse(ctx context.Context, params *DeleteIn // Represents a delete integration response request. type DeleteIntegrationResponseInput struct { - Template *bool + + // [Required] Specifies a delete integration response request's HTTP method. + // + // This member is required. + HttpMethod *string // [Required] Specifies a delete integration response request's resource // identifier. @@ -65,12 +69,10 @@ type DeleteIntegrationResponseInput struct { // This member is required. ResourceId *string - Title *string - - // [Required] Specifies a delete integration response request's HTTP method. + // [Required] The string identifier of the associated RestApi (). // // This member is required. - HttpMethod *string + RestApiId *string // [Required] Specifies a delete integration response request's status code. // @@ -79,12 +81,11 @@ type DeleteIntegrationResponseInput struct { Name *string + Template *bool + TemplateSkipList []*string - // [Required] The string identifier of the associated RestApi (). - // - // This member is required. - RestApiId *string + Title *string } type DeleteIntegrationResponseOutput struct { diff --git a/service/apigateway/api_op_DeleteMethod.go b/service/apigateway/api_op_DeleteMethod.go index 982695824e0..ddfec3ca756 100644 --- a/service/apigateway/api_op_DeleteMethod.go +++ b/service/apigateway/api_op_DeleteMethod.go @@ -57,28 +57,29 @@ func (c *Client) DeleteMethod(ctx context.Context, params *DeleteMethodInput, op // Request to delete an existing Method () resource. type DeleteMethodInput struct { - Name *string - // [Required] The string identifier of the associated RestApi (). + // [Required] The HTTP verb of the Method () resource. // // This member is required. - RestApiId *string + HttpMethod *string - TemplateSkipList []*string + // [Required] The Resource () identifier for the Method () resource. + // + // This member is required. + ResourceId *string - // [Required] The HTTP verb of the Method () resource. + // [Required] The string identifier of the associated RestApi (). // // This member is required. - HttpMethod *string + RestApiId *string - Title *string + Name *string Template *bool - // [Required] The Resource () identifier for the Method () resource. - // - // This member is required. - ResourceId *string + TemplateSkipList []*string + + Title *string } type DeleteMethodOutput struct { diff --git a/service/apigateway/api_op_DeleteMethodResponse.go b/service/apigateway/api_op_DeleteMethodResponse.go index 2ac3c2dd4bf..fd3d726e866 100644 --- a/service/apigateway/api_op_DeleteMethodResponse.go +++ b/service/apigateway/api_op_DeleteMethodResponse.go @@ -57,33 +57,34 @@ func (c *Client) DeleteMethodResponse(ctx context.Context, params *DeleteMethodR // A request to delete an existing MethodResponse () resource. type DeleteMethodResponseInput struct { - Title *string // [Required] The HTTP verb of the Method () resource. // // This member is required. HttpMethod *string - // [Required] The status code identifier for the MethodResponse () resource. - // - // This member is required. - StatusCode *string - // [Required] The Resource () identifier for the MethodResponse () resource. // // This member is required. ResourceId *string - Template *bool - // [Required] The string identifier of the associated RestApi (). // // This member is required. RestApiId *string + // [Required] The status code identifier for the MethodResponse () resource. + // + // This member is required. + StatusCode *string + Name *string + Template *bool + TemplateSkipList []*string + + Title *string } type DeleteMethodResponseOutput struct { diff --git a/service/apigateway/api_op_DeleteModel.go b/service/apigateway/api_op_DeleteModel.go index e186c25bc1d..f5498ff9d43 100644 --- a/service/apigateway/api_op_DeleteModel.go +++ b/service/apigateway/api_op_DeleteModel.go @@ -58,23 +58,23 @@ func (c *Client) DeleteModel(ctx context.Context, params *DeleteModelInput, optF // Request to delete an existing model in an existing RestApi () resource. type DeleteModelInput struct { - // [Required] The string identifier of the associated RestApi (). - // - // This member is required. - RestApiId *string - // [Required] The name of the model to delete. // // This member is required. ModelName *string - TemplateSkipList []*string - - Title *string + // [Required] The string identifier of the associated RestApi (). + // + // This member is required. + RestApiId *string Name *string Template *bool + + TemplateSkipList []*string + + Title *string } type DeleteModelOutput struct { diff --git a/service/apigateway/api_op_DeleteRequestValidator.go b/service/apigateway/api_op_DeleteRequestValidator.go index 569e680fb4e..8bfe21db663 100644 --- a/service/apigateway/api_op_DeleteRequestValidator.go +++ b/service/apigateway/api_op_DeleteRequestValidator.go @@ -57,23 +57,24 @@ func (c *Client) DeleteRequestValidator(ctx context.Context, params *DeleteReque // Deletes a specified RequestValidator () of a given RestApi (). type DeleteRequestValidatorInput struct { - TemplateSkipList []*string - Template *bool + // [Required] The identifier of the RequestValidator () to be deleted. + // + // This member is required. + RequestValidatorId *string // [Required] The string identifier of the associated RestApi (). // // This member is required. RestApiId *string - Title *string - Name *string - // [Required] The identifier of the RequestValidator () to be deleted. - // - // This member is required. - RequestValidatorId *string + Template *bool + + TemplateSkipList []*string + + Title *string } type DeleteRequestValidatorOutput struct { diff --git a/service/apigateway/api_op_DeleteResource.go b/service/apigateway/api_op_DeleteResource.go index 0238866d07c..507266a9d37 100644 --- a/service/apigateway/api_op_DeleteResource.go +++ b/service/apigateway/api_op_DeleteResource.go @@ -57,9 +57,11 @@ func (c *Client) DeleteResource(ctx context.Context, params *DeleteResourceInput // Request to delete a Resource (). type DeleteResourceInput struct { - Title *string - TemplateSkipList []*string + // [Required] The identifier of the Resource () resource. + // + // This member is required. + ResourceId *string // [Required] The string identifier of the associated RestApi (). // @@ -70,10 +72,9 @@ type DeleteResourceInput struct { Template *bool - // [Required] The identifier of the Resource () resource. - // - // This member is required. - ResourceId *string + TemplateSkipList []*string + + Title *string } type DeleteResourceOutput struct { diff --git a/service/apigateway/api_op_DeleteRestApi.go b/service/apigateway/api_op_DeleteRestApi.go index f1937bfa29d..0a11dad21ba 100644 --- a/service/apigateway/api_op_DeleteRestApi.go +++ b/service/apigateway/api_op_DeleteRestApi.go @@ -63,13 +63,13 @@ type DeleteRestApiInput struct { // This member is required. RestApiId *string - Template *bool + Name *string - Title *string + Template *bool TemplateSkipList []*string - Name *string + Title *string } type DeleteRestApiOutput struct { diff --git a/service/apigateway/api_op_DeleteStage.go b/service/apigateway/api_op_DeleteStage.go index 65564c29791..7d6c5c028d7 100644 --- a/service/apigateway/api_op_DeleteStage.go +++ b/service/apigateway/api_op_DeleteStage.go @@ -57,9 +57,11 @@ func (c *Client) DeleteStage(ctx context.Context, params *DeleteStageInput, optF // Requests API Gateway to delete a Stage () resource. type DeleteStageInput struct { - TemplateSkipList []*string - Title *string + // [Required] The string identifier of the associated RestApi (). + // + // This member is required. + RestApiId *string // [Required] The name of the Stage () resource to delete. // @@ -68,12 +70,11 @@ type DeleteStageInput struct { Name *string - // [Required] The string identifier of the associated RestApi (). - // - // This member is required. - RestApiId *string - Template *bool + + TemplateSkipList []*string + + Title *string } type DeleteStageOutput struct { diff --git a/service/apigateway/api_op_DeleteUsagePlan.go b/service/apigateway/api_op_DeleteUsagePlan.go index 3dc75a3c89a..b15ad6b4b49 100644 --- a/service/apigateway/api_op_DeleteUsagePlan.go +++ b/service/apigateway/api_op_DeleteUsagePlan.go @@ -57,13 +57,14 @@ func (c *Client) DeleteUsagePlan(ctx context.Context, params *DeleteUsagePlanInp // The DELETE request to delete a usage plan of a given plan Id. type DeleteUsagePlanInput struct { - Name *string // [Required] The Id of the to-be-deleted usage plan. // // This member is required. UsagePlanId *string + Name *string + Template *bool TemplateSkipList []*string diff --git a/service/apigateway/api_op_DeleteUsagePlanKey.go b/service/apigateway/api_op_DeleteUsagePlanKey.go index 836a52ce9c6..a473055d9d3 100644 --- a/service/apigateway/api_op_DeleteUsagePlanKey.go +++ b/service/apigateway/api_op_DeleteUsagePlanKey.go @@ -65,12 +65,6 @@ type DeleteUsagePlanKeyInput struct { // This member is required. KeyId *string - Name *string - - Title *string - - TemplateSkipList []*string - // [Required] The Id of the UsagePlan () resource representing the usage plan // containing the to-be-deleted UsagePlanKey () resource representing a plan // customer. @@ -78,7 +72,13 @@ type DeleteUsagePlanKeyInput struct { // This member is required. UsagePlanId *string + Name *string + Template *bool + + TemplateSkipList []*string + + Title *string } type DeleteUsagePlanKeyOutput struct { diff --git a/service/apigateway/api_op_DeleteVpcLink.go b/service/apigateway/api_op_DeleteVpcLink.go index fb73daf40c0..b1937c57844 100644 --- a/service/apigateway/api_op_DeleteVpcLink.go +++ b/service/apigateway/api_op_DeleteVpcLink.go @@ -57,19 +57,20 @@ func (c *Client) DeleteVpcLink(ctx context.Context, params *DeleteVpcLinkInput, // Deletes an existing VpcLink () of a specified identifier. type DeleteVpcLinkInput struct { - Title *string - - Template *bool - - TemplateSkipList []*string - - Name *string // [Required] The identifier of the VpcLink (). It is used in an Integration () to // reference this VpcLink (). // // This member is required. VpcLinkId *string + + Name *string + + Template *bool + + TemplateSkipList []*string + + Title *string } type DeleteVpcLinkOutput struct { diff --git a/service/apigateway/api_op_FlushStageAuthorizersCache.go b/service/apigateway/api_op_FlushStageAuthorizersCache.go index f83714bf340..aaa46a3c0e3 100644 --- a/service/apigateway/api_op_FlushStageAuthorizersCache.go +++ b/service/apigateway/api_op_FlushStageAuthorizersCache.go @@ -57,23 +57,24 @@ func (c *Client) FlushStageAuthorizersCache(ctx context.Context, params *FlushSt // Request to flush authorizer cache entries on a specified stage. type FlushStageAuthorizersCacheInput struct { - Template *bool + + // The string identifier of the associated RestApi (). + // + // This member is required. + RestApiId *string // The name of the stage to flush. // // This member is required. StageName *string - Title *string - Name *string - // The string identifier of the associated RestApi (). - // - // This member is required. - RestApiId *string + Template *bool TemplateSkipList []*string + + Title *string } type FlushStageAuthorizersCacheOutput struct { diff --git a/service/apigateway/api_op_FlushStageCache.go b/service/apigateway/api_op_FlushStageCache.go index b2844f43240..80446f45a4f 100644 --- a/service/apigateway/api_op_FlushStageCache.go +++ b/service/apigateway/api_op_FlushStageCache.go @@ -58,6 +58,11 @@ func (c *Client) FlushStageCache(ctx context.Context, params *FlushStageCacheInp // Requests API Gateway to flush a stage's cache. type FlushStageCacheInput struct { + // [Required] The string identifier of the associated RestApi (). + // + // This member is required. + RestApiId *string + // [Required] The name of the stage to flush its cache. // // This member is required. @@ -65,16 +70,11 @@ type FlushStageCacheInput struct { Name *string - Title *string + Template *bool TemplateSkipList []*string - Template *bool - - // [Required] The string identifier of the associated RestApi (). - // - // This member is required. - RestApiId *string + Title *string } type FlushStageCacheOutput struct { diff --git a/service/apigateway/api_op_GenerateClientCertificate.go b/service/apigateway/api_op_GenerateClientCertificate.go index 6fa8c709955..b4c8b5a88e9 100644 --- a/service/apigateway/api_op_GenerateClientCertificate.go +++ b/service/apigateway/api_op_GenerateClientCertificate.go @@ -57,21 +57,22 @@ func (c *Client) GenerateClientCertificate(ctx context.Context, params *Generate // A request to generate a ClientCertificate () resource. type GenerateClientCertificateInput struct { - Template *bool - - Title *string - - TemplateSkipList []*string - - Name *string // The description of the ClientCertificate (). Description *string + Name *string + // The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The // tag key can be up to 128 characters and must not start with aws:. The tag value // can be up to 256 characters. Tags map[string]*string + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents a client certificate used to configure client-side SSL authentication @@ -82,9 +83,18 @@ type GenerateClientCertificateInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html) type GenerateClientCertificateOutput struct { + // The identifier of the client certificate. + ClientCertificateId *string + // The timestamp when the client certificate was created. CreatedDate *time.Time + // The description of the client certificate. + Description *string + + // The timestamp when the client certificate will expire. + ExpirationDate *time.Time + // The PEM-encoded public key of the client certificate, which can be used to // configure certificate authentication in the integration endpoint . PemEncodedCertificate *string @@ -92,15 +102,6 @@ type GenerateClientCertificateOutput struct { // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string - // The timestamp when the client certificate will expire. - ExpirationDate *time.Time - - // The description of the client certificate. - Description *string - - // The identifier of the client certificate. - ClientCertificateId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_GetAccount.go b/service/apigateway/api_op_GetAccount.go index f2aba59f721..babd02c36f7 100644 --- a/service/apigateway/api_op_GetAccount.go +++ b/service/apigateway/api_op_GetAccount.go @@ -59,11 +59,11 @@ func (c *Client) GetAccount(ctx context.Context, params *GetAccountInput, optFns type GetAccountInput struct { Name *string - Title *string + Template *bool TemplateSkipList []*string - Template *bool + Title *string } // Represents an AWS account that is associated with API Gateway. To view the @@ -114,19 +114,19 @@ type GetAccountInput struct { // (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-account.html) type GetAccountOutput struct { + // The version of the API keys used for the account. + ApiKeyVersion *string + + // The ARN of an Amazon CloudWatch role for the current Account (). + CloudwatchRoleArn *string + // A list of features supported for the account. When usage plans are enabled, the // features list will include an entry of "UsagePlans". Features []*string - // The version of the API keys used for the account. - ApiKeyVersion *string - // Specifies the API request limits configured for the current Account (). ThrottleSettings *types.ThrottleSettings - // The ARN of an Amazon CloudWatch role for the current Account (). - CloudwatchRoleArn *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_GetApiKey.go b/service/apigateway/api_op_GetApiKey.go index c8df488cc2a..d1f5b2fb7d3 100644 --- a/service/apigateway/api_op_GetApiKey.go +++ b/service/apigateway/api_op_GetApiKey.go @@ -64,17 +64,17 @@ type GetApiKeyInput struct { // This member is required. ApiKey *string - TemplateSkipList []*string - - Title *string - - Name *string - // A boolean flag to specify whether (true) or not (false) the result contains the // key value. IncludeValue *bool + Name *string + Template *bool + + TemplateSkipList []*string + + Title *string } // A resource that can be distributed to callers for executing Method () resources @@ -84,34 +84,34 @@ type GetApiKeyInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-keys.html) type GetApiKeyOutput struct { - // The name of the API Key. - Name *string - - // A list of Stage () resources that are associated with the ApiKey () resource. - StageKeys []*string - // The timestamp when the API Key was created. CreatedDate *time.Time - // The identifier of the API Key. - Id *string - // An AWS Marketplace customer identifier , when integrating with the AWS SaaS // Marketplace. CustomerId *string - // The timestamp when the API Key was last updated. - LastUpdatedDate *time.Time + // The description of the API Key. + Description *string // Specifies whether the API Key can be used by callers. Enabled *bool + // The identifier of the API Key. + Id *string + + // The timestamp when the API Key was last updated. + LastUpdatedDate *time.Time + + // The name of the API Key. + Name *string + + // A list of Stage () resources that are associated with the ApiKey () resource. + StageKeys []*string + // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string - // The description of the API Key. - Description *string - // The value of the API Key. Value *string diff --git a/service/apigateway/api_op_GetApiKeys.go b/service/apigateway/api_op_GetApiKeys.go index 14898cf4891..49e1f4dc078 100644 --- a/service/apigateway/api_op_GetApiKeys.go +++ b/service/apigateway/api_op_GetApiKeys.go @@ -58,31 +58,31 @@ func (c *Client) GetApiKeys(ctx context.Context, params *GetApiKeysInput, optFns // A request to get information about the current ApiKeys () resource. type GetApiKeysInput struct { - // The name of queried API keys. - NameQuery *string - - // The current pagination position in the paged result set. - Position *string - // The identifier of a customer in AWS Marketplace or an external system, such as a // developer portal. CustomerId *string - TemplateSkipList []*string - - Template *bool - // A boolean flag to specify whether (true) or not (false) the result contains key // values. IncludeValues *bool - Title *string - // The maximum number of returned results per page. The default value is 25 and the // maximum value is 500. Limit *int32 Name *string + + // The name of queried API keys. + NameQuery *string + + // The current pagination position in the paged result set. + Position *string + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents a collection of API keys as represented by an ApiKeys () resource. @@ -90,16 +90,16 @@ type GetApiKeysInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-keys.html) type GetApiKeysOutput struct { - // A list of warning messages logged during the import of API keys when the - // failOnWarnings option is set to true. - Warnings []*string - // The current page of elements from this collection. Items []*types.ApiKey // The current pagination position in the paged result set. Position *string + // A list of warning messages logged during the import of API keys when the + // failOnWarnings option is set to true. + Warnings []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_GetAuthorizer.go b/service/apigateway/api_op_GetAuthorizer.go index accfb7a1d9f..eb2677df1c2 100644 --- a/service/apigateway/api_op_GetAuthorizer.go +++ b/service/apigateway/api_op_GetAuthorizer.go @@ -59,11 +59,6 @@ func (c *Client) GetAuthorizer(ctx context.Context, params *GetAuthorizerInput, // Request to describe an existing Authorizer () resource. type GetAuthorizerInput struct { - Title *string - - TemplateSkipList []*string - - Template *bool // [Required] The identifier of the Authorizer () resource. // @@ -76,6 +71,12 @@ type GetAuthorizerInput struct { RestApiId *string Name *string + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents an authorization layer for methods. If enabled on a method, API @@ -86,8 +87,9 @@ type GetAuthorizerInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html) type GetAuthorizerOutput struct { - // [Required] The name of the authorizer. - Name *string + // Optional customer-defined field, used in OpenAPI imports and exports without + // functional impact. + AuthType *string // Specifies the required credentials as an IAM role for API Gateway to invoke the // authorizer. To specify an IAM role for API Gateway to assume, use the role's @@ -95,6 +97,27 @@ type GetAuthorizerOutput struct { // function, specify null. AuthorizerCredentials *string + // The TTL in seconds of cached authorizer results. If it equals 0, authorization + // caching is disabled. If it is greater than 0, API Gateway will cache authorizer + // responses. If this field is not set, the default value is 300. The maximum value + // is 3600, or 1 hour. + AuthorizerResultTtlInSeconds *int32 + + // Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or + // REQUEST authorizers, this must be a well-formed Lambda function URI, for + // example, + // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. + // In general, the URI has this form + // arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the + // same as the region hosting the Lambda function, path indicates that the + // remaining substring in the URI should be treated as the path to the resource, + // including the initial /. For Lambda functions, this is usually of the form + // /2015-03-31/functions/[FunctionARN]/invocations. + AuthorizerUri *string + + // The identifier for the authorizer resource. + Id *string + // The identity source for which authorization is requested. // // * For a TOKEN or @@ -119,34 +142,6 @@ type GetAuthorizerOutput struct { // optional. IdentitySource *string - // The authorizer type. Valid values are TOKEN for a Lambda function using a single - // authorization token submitted in a custom header, REQUEST for a Lambda function - // using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon - // Cognito user pool. - Type types.AuthorizerType - - // Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or - // REQUEST authorizers, this must be a well-formed Lambda function URI, for - // example, - // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. - // In general, the URI has this form - // arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the - // same as the region hosting the Lambda function, path indicates that the - // remaining substring in the URI should be treated as the path to the resource, - // including the initial /. For Lambda functions, this is usually of the form - // /2015-03-31/functions/[FunctionARN]/invocations. - AuthorizerUri *string - - // A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS - // authorizer. Each element is of this format: - // arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN - // or REQUEST authorizer, this is not defined. - ProviderARNs []*string - - // Optional customer-defined field, used in OpenAPI imports and exports without - // functional impact. - AuthType *string - // A validation expression for the incoming identity token. For TOKEN authorizers, // this value is a regular expression. For COGNITO_USER_POOLS authorizers, API // Gateway will match the aud field of the incoming token from the client against @@ -156,14 +151,20 @@ type GetAuthorizerOutput struct { // apply to the REQUEST authorizer. IdentityValidationExpression *string - // The TTL in seconds of cached authorizer results. If it equals 0, authorization - // caching is disabled. If it is greater than 0, API Gateway will cache authorizer - // responses. If this field is not set, the default value is 300. The maximum value - // is 3600, or 1 hour. - AuthorizerResultTtlInSeconds *int32 + // [Required] The name of the authorizer. + Name *string - // The identifier for the authorizer resource. - Id *string + // A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS + // authorizer. Each element is of this format: + // arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN + // or REQUEST authorizer, this is not defined. + ProviderARNs []*string + + // The authorizer type. Valid values are TOKEN for a Lambda function using a single + // authorization token submitted in a custom header, REQUEST for a Lambda function + // using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon + // Cognito user pool. + Type types.AuthorizerType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigateway/api_op_GetAuthorizers.go b/service/apigateway/api_op_GetAuthorizers.go index 00b4e90a378..e1962366585 100644 --- a/service/apigateway/api_op_GetAuthorizers.go +++ b/service/apigateway/api_op_GetAuthorizers.go @@ -59,11 +59,11 @@ func (c *Client) GetAuthorizers(ctx context.Context, params *GetAuthorizersInput // Request to describe an existing Authorizers () resource. type GetAuthorizersInput struct { - TemplateSkipList []*string - - Title *string - Template *bool + // [Required] The string identifier of the associated RestApi (). + // + // This member is required. + RestApiId *string // The maximum number of returned results per page. The default value is 25 and the // maximum value is 500. @@ -74,10 +74,11 @@ type GetAuthorizersInput struct { // The current pagination position in the paged result set. Position *string - // [Required] The string identifier of the associated RestApi (). - // - // This member is required. - RestApiId *string + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents a collection of Authorizer () resources. Use Lambda Function as diff --git a/service/apigateway/api_op_GetBasePathMapping.go b/service/apigateway/api_op_GetBasePathMapping.go index fd5b556d16f..c207883b448 100644 --- a/service/apigateway/api_op_GetBasePathMapping.go +++ b/service/apigateway/api_op_GetBasePathMapping.go @@ -58,11 +58,6 @@ func (c *Client) GetBasePathMapping(ctx context.Context, params *GetBasePathMapp // Request to describe a BasePathMapping () resource. type GetBasePathMappingInput struct { - // [Required] The domain name of the BasePathMapping () resource to be described. - // - // This member is required. - DomainName *string - // [Required] The base path name that callers of the API must provide as part of // the URL after the domain name. This value must be unique for all of the mappings // across a single API. Specify '(none)' if you do not want callers to specify any @@ -71,13 +66,18 @@ type GetBasePathMappingInput struct { // This member is required. BasePath *string - Title *string + // [Required] The domain name of the BasePathMapping () resource to be described. + // + // This member is required. + DomainName *string Name *string + Template *bool + TemplateSkipList []*string - Template *bool + Title *string } // Represents the base path that callers of the API must provide as part of the URL @@ -87,9 +87,6 @@ type GetBasePathMappingInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) type GetBasePathMappingOutput struct { - // The name of the associated stage. - Stage *string - // The base path name that callers of the API must provide as part of the URL after // the domain name. BasePath *string @@ -97,6 +94,9 @@ type GetBasePathMappingOutput struct { // The string identifier of the associated RestApi (). RestApiId *string + // The name of the associated stage. + Stage *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_GetBasePathMappings.go b/service/apigateway/api_op_GetBasePathMappings.go index 1eafb41782b..f072cdaffe8 100644 --- a/service/apigateway/api_op_GetBasePathMappings.go +++ b/service/apigateway/api_op_GetBasePathMappings.go @@ -59,25 +59,25 @@ func (c *Client) GetBasePathMappings(ctx context.Context, params *GetBasePathMap // A request to get information about a collection of BasePathMapping () resources. type GetBasePathMappingsInput struct { + // [Required] The domain name of a BasePathMapping () resource. + // + // This member is required. + DomainName *string + // The maximum number of returned results per page. The default value is 25 and the // maximum value is 500. Limit *int32 Name *string - // [Required] The domain name of a BasePathMapping () resource. - // - // This member is required. - DomainName *string + // The current pagination position in the paged result set. + Position *string Template *bool - Title *string - TemplateSkipList []*string - // The current pagination position in the paged result set. - Position *string + Title *string } // Represents a collection of BasePathMapping () resources. Use Custom Domain Names diff --git a/service/apigateway/api_op_GetClientCertificate.go b/service/apigateway/api_op_GetClientCertificate.go index 41ed085085a..6c02e824a3f 100644 --- a/service/apigateway/api_op_GetClientCertificate.go +++ b/service/apigateway/api_op_GetClientCertificate.go @@ -58,18 +58,19 @@ func (c *Client) GetClientCertificate(ctx context.Context, params *GetClientCert // A request to get information about the current ClientCertificate () resource. type GetClientCertificateInput struct { - Name *string - - Title *string - - Template *bool // [Required] The identifier of the ClientCertificate () resource to be described. // // This member is required. ClientCertificateId *string + Name *string + + Template *bool + TemplateSkipList []*string + + Title *string } // Represents a client certificate used to configure client-side SSL authentication @@ -80,9 +81,18 @@ type GetClientCertificateInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html) type GetClientCertificateOutput struct { + // The identifier of the client certificate. + ClientCertificateId *string + // The timestamp when the client certificate was created. CreatedDate *time.Time + // The description of the client certificate. + Description *string + + // The timestamp when the client certificate will expire. + ExpirationDate *time.Time + // The PEM-encoded public key of the client certificate, which can be used to // configure certificate authentication in the integration endpoint . PemEncodedCertificate *string @@ -90,15 +100,6 @@ type GetClientCertificateOutput struct { // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string - // The timestamp when the client certificate will expire. - ExpirationDate *time.Time - - // The description of the client certificate. - Description *string - - // The identifier of the client certificate. - ClientCertificateId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_GetClientCertificates.go b/service/apigateway/api_op_GetClientCertificates.go index ab989754891..f16e6aaa875 100644 --- a/service/apigateway/api_op_GetClientCertificates.go +++ b/service/apigateway/api_op_GetClientCertificates.go @@ -58,20 +58,21 @@ func (c *Client) GetClientCertificates(ctx context.Context, params *GetClientCer // A request to get information about a collection of ClientCertificate () // resources. type GetClientCertificatesInput struct { - Title *string - - Template *bool - - Name *string // The maximum number of returned results per page. The default value is 25 and the // maximum value is 500. Limit *int32 + Name *string + // The current pagination position in the paged result set. Position *string + Template *bool + TemplateSkipList []*string + + Title *string } // Represents a collection of ClientCertificate () resources. Use Client-Side diff --git a/service/apigateway/api_op_GetDeployment.go b/service/apigateway/api_op_GetDeployment.go index 9607f57818c..e6f616cd744 100644 --- a/service/apigateway/api_op_GetDeployment.go +++ b/service/apigateway/api_op_GetDeployment.go @@ -59,11 +59,17 @@ func (c *Client) GetDeployment(ctx context.Context, params *GetDeploymentInput, // Requests API Gateway to get information about a Deployment () resource. type GetDeploymentInput struct { - TemplateSkipList []*string - Title *string + // [Required] The identifier of the Deployment () resource to get information + // about. + // + // This member is required. + DeploymentId *string - Name *string + // [Required] The string identifier of the associated RestApi (). + // + // This member is required. + RestApiId *string // A query parameter to retrieve the specified embedded resources of the returned // Deployment () resource in the response. In a REST API call, this embed parameter @@ -76,18 +82,13 @@ type GetDeploymentInput struct { // /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary. Embed []*string - // [Required] The string identifier of the associated RestApi (). - // - // This member is required. - RestApiId *string - - // [Required] The identifier of the Deployment () resource to get information - // about. - // - // This member is required. - DeploymentId *string + Name *string Template *bool + + TemplateSkipList []*string + + Title *string } // An immutable representation of a RestApi () resource that can be called by users @@ -101,19 +102,19 @@ type GetDeploymentInput struct { // AWS SDKs (https://aws.amazon.com/tools/) type GetDeploymentOutput struct { - // The date and time that the deployment resource was created. - CreatedDate *time.Time - // A summary of the RestApi () at the date and time that the deployment resource // was created. ApiSummary map[string]map[string]*types.MethodSnapshot - // The identifier for the deployment resource. - Id *string + // The date and time that the deployment resource was created. + CreatedDate *time.Time // The description for the deployment resource. Description *string + // The identifier for the deployment resource. + Id *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_GetDeployments.go b/service/apigateway/api_op_GetDeployments.go index e0a07fe5cb6..ca818cb88cb 100644 --- a/service/apigateway/api_op_GetDeployments.go +++ b/service/apigateway/api_op_GetDeployments.go @@ -70,14 +70,14 @@ type GetDeploymentsInput struct { Name *string - Title *string - - Template *bool - // The current pagination position in the paged result set. Position *string + Template *bool + TemplateSkipList []*string + + Title *string } // Represents a collection resource that contains zero or more references to your diff --git a/service/apigateway/api_op_GetDocumentationPart.go b/service/apigateway/api_op_GetDocumentationPart.go index 06de00d4049..cafa65c6d73 100644 --- a/service/apigateway/api_op_GetDocumentationPart.go +++ b/service/apigateway/api_op_GetDocumentationPart.go @@ -63,10 +63,6 @@ type GetDocumentationPartInput struct { // This member is required. DocumentationPartId *string - TemplateSkipList []*string - - Template *bool - // [Required] The string identifier of the associated RestApi (). // // This member is required. @@ -74,6 +70,10 @@ type GetDocumentationPartInput struct { Name *string + Template *bool + + TemplateSkipList []*string + Title *string } diff --git a/service/apigateway/api_op_GetDocumentationParts.go b/service/apigateway/api_op_GetDocumentationParts.go index 8a771b6e17f..9de2e3a1160 100644 --- a/service/apigateway/api_op_GetDocumentationParts.go +++ b/service/apigateway/api_op_GetDocumentationParts.go @@ -58,39 +58,40 @@ func (c *Client) GetDocumentationParts(ctx context.Context, params *GetDocumenta // Gets the documentation parts of an API. The result may be filtered by the type, // name, or path of API entities (targets). type GetDocumentationPartsInput struct { - TemplateSkipList []*string - - // The type of API entities of the to-be-retrieved documentation parts. - Type types.DocumentationPartType - - Title *string - // The name of API entities of the to-be-retrieved documentation parts. - NameQuery *string - - // The current pagination position in the paged result set. - Position *string + // [Required] The string identifier of the associated RestApi (). + // + // This member is required. + RestApiId *string // The maximum number of returned results per page. The default value is 25 and the // maximum value is 500. Limit *int32 - Name *string - // The status of the API documentation parts to retrieve. Valid values are // DOCUMENTED for retrieving DocumentationPart () resources with content and // UNDOCUMENTED for DocumentationPart () resources without content. LocationStatus types.LocationStatusType - Template *bool + Name *string + + // The name of API entities of the to-be-retrieved documentation parts. + NameQuery *string // The path of API entities of the to-be-retrieved documentation parts. Path *string - // [Required] The string identifier of the associated RestApi (). - // - // This member is required. - RestApiId *string + // The current pagination position in the paged result set. + Position *string + + Template *bool + + TemplateSkipList []*string + + Title *string + + // The type of API entities of the to-be-retrieved documentation parts. + Type types.DocumentationPartType } // The collection of documentation parts of an API. Documenting an API diff --git a/service/apigateway/api_op_GetDocumentationVersion.go b/service/apigateway/api_op_GetDocumentationVersion.go index d6d21369364..1c2df8805cf 100644 --- a/service/apigateway/api_op_GetDocumentationVersion.go +++ b/service/apigateway/api_op_GetDocumentationVersion.go @@ -58,23 +58,23 @@ func (c *Client) GetDocumentationVersion(ctx context.Context, params *GetDocumen // Gets a documentation snapshot of an API. type GetDocumentationVersionInput struct { - // [Required] The string identifier of the associated RestApi (). + // [Required] The version identifier of the to-be-retrieved documentation snapshot. // // This member is required. - RestApiId *string - - Template *bool + DocumentationVersion *string - // [Required] The version identifier of the to-be-retrieved documentation snapshot. + // [Required] The string identifier of the associated RestApi (). // // This member is required. - DocumentationVersion *string + RestApiId *string - Title *string + Name *string + + Template *bool TemplateSkipList []*string - Name *string + Title *string } // A snapshot of the documentation of an API. Publishing API documentation involves @@ -84,12 +84,12 @@ type GetDocumentationVersionInput struct { // DocumentationPart (), DocumentationVersions () type GetDocumentationVersionOutput struct { - // The description of the API documentation snapshot. - Description *string - // The date when the API documentation snapshot is created. CreatedDate *time.Time + // The description of the API documentation snapshot. + Description *string + // The version identifier of the API documentation snapshot. Version *string diff --git a/service/apigateway/api_op_GetDocumentationVersions.go b/service/apigateway/api_op_GetDocumentationVersions.go index a4a1a5de834..f3496dc45e1 100644 --- a/service/apigateway/api_op_GetDocumentationVersions.go +++ b/service/apigateway/api_op_GetDocumentationVersions.go @@ -63,20 +63,20 @@ type GetDocumentationVersionsInput struct { // This member is required. RestApiId *string + // The maximum number of returned results per page. The default value is 25 and the + // maximum value is 500. + Limit *int32 + Name *string // The current pagination position in the paged result set. Position *string - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. - Limit *int32 - - Title *string + Template *bool TemplateSkipList []*string - Template *bool + Title *string } // The collection of documentation snapshots of an API. Use the diff --git a/service/apigateway/api_op_GetDomainName.go b/service/apigateway/api_op_GetDomainName.go index d7fbed7b16a..497d797cb41 100644 --- a/service/apigateway/api_op_GetDomainName.go +++ b/service/apigateway/api_op_GetDomainName.go @@ -60,18 +60,19 @@ func (c *Client) GetDomainName(ctx context.Context, params *GetDomainNameInput, // Request to get the name of a DomainName () resource. type GetDomainNameInput struct { - TemplateSkipList []*string - Title *string + // [Required] The name of the DomainName () resource. + // + // This member is required. + DomainName *string Name *string Template *bool - // [Required] The name of the DomainName () resource. - // - // This member is required. - DomainName *string + TemplateSkipList []*string + + Title *string } // Represents a custom domain name as a user-friendly host name of an API (RestApi @@ -87,16 +88,26 @@ type GetDomainNameInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) type GetDomainNameOutput struct { - // The domain name associated with the regional endpoint for this custom domain - // name. You set up this association by adding a DNS record that points the custom - // domain name to this regional domain name. The regional domain name is returned - // by API Gateway when you create a regional endpoint. - RegionalDomainName *string + // The reference to an AWS-managed certificate that will be used by edge-optimized + // endpoint for this domain name. AWS Certificate Manager is the only supported + // source. + CertificateArn *string // The name of the certificate that will be used by edge-optimized endpoint for // this domain name. CertificateName *string + // The timestamp when the certificate that was used by edge-optimized endpoint for + // this domain name was uploaded. + CertificateUploadDate *time.Time + + // The domain name of the Amazon CloudFront distribution associated with this + // custom domain name for an edge-optimized endpoint. You set up this association + // when adding a DNS record pointing the custom domain name to this distribution + // name. For more information about CloudFront distributions, see the Amazon + // CloudFront documentation (https://aws.amazon.com/documentation/cloudfront/). + DistributionDomainName *string + // The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized // endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more // information, see Set up a Regional Custom Domain Name @@ -108,34 +119,33 @@ type GetDomainNameOutput struct { // The custom domain name as an API host name, for example, my-api.example.com. DomainName *string - // The Transport Layer Security (TLS) version + cipher suite for this DomainName - // (). The valid values are TLS_1_0 and TLS_1_2. - SecurityPolicy types.SecurityPolicy + // The status of the DomainName () migration. The valid values are AVAILABLE and + // UPDATING. If the status is UPDATING, the domain cannot be modified further until + // the existing operation is complete. If it is AVAILABLE, the domain can be + // updated. + DomainNameStatus types.DomainNameStatus // An optional text message containing detailed information about status of the // DomainName () migration. DomainNameStatusMessage *string + // The endpoint configuration of this DomainName () showing the endpoint types of + // the domain name. + EndpointConfiguration *types.EndpointConfiguration + // The reference to an AWS-managed certificate that will be used for validating the // regional domain name. AWS Certificate Manager is the only supported source. RegionalCertificateArn *string - // The reference to an AWS-managed certificate that will be used by edge-optimized - // endpoint for this domain name. AWS Certificate Manager is the only supported - // source. - CertificateArn *string - - // The timestamp when the certificate that was used by edge-optimized endpoint for - // this domain name was uploaded. - CertificateUploadDate *time.Time - // The name of the certificate that will be used for validating the regional domain // name. RegionalCertificateName *string - // The endpoint configuration of this DomainName () showing the endpoint types of - // the domain name. - EndpointConfiguration *types.EndpointConfiguration + // The domain name associated with the regional endpoint for this custom domain + // name. You set up this association by adding a DNS record that points the custom + // domain name to this regional domain name. The regional domain name is returned + // by API Gateway when you create a regional endpoint. + RegionalDomainName *string // The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For // more information, see Set up a Regional Custom Domain Name @@ -144,22 +154,13 @@ type GetDomainNameOutput struct { // (https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region). RegionalHostedZoneId *string - // The domain name of the Amazon CloudFront distribution associated with this - // custom domain name for an edge-optimized endpoint. You set up this association - // when adding a DNS record pointing the custom domain name to this distribution - // name. For more information about CloudFront distributions, see the Amazon - // CloudFront documentation (https://aws.amazon.com/documentation/cloudfront/). - DistributionDomainName *string + // The Transport Layer Security (TLS) version + cipher suite for this DomainName + // (). The valid values are TLS_1_0 and TLS_1_2. + SecurityPolicy types.SecurityPolicy // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string - // The status of the DomainName () migration. The valid values are AVAILABLE and - // UPDATING. If the status is UPDATING, the domain cannot be modified further until - // the existing operation is complete. If it is AVAILABLE, the domain can be - // updated. - DomainNameStatus types.DomainNameStatus - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_GetDomainNames.go b/service/apigateway/api_op_GetDomainNames.go index 4ff708661d1..181d01afa6a 100644 --- a/service/apigateway/api_op_GetDomainNames.go +++ b/service/apigateway/api_op_GetDomainNames.go @@ -58,20 +58,20 @@ func (c *Client) GetDomainNames(ctx context.Context, params *GetDomainNamesInput // Request to describe a collection of DomainName () resources. type GetDomainNamesInput struct { - // The current pagination position in the paged result set. - Position *string - // The maximum number of returned results per page. The default value is 25 and the // maximum value is 500. Limit *int32 Name *string - Title *string + // The current pagination position in the paged result set. + Position *string Template *bool TemplateSkipList []*string + + Title *string } // Represents a collection of DomainName () resources. Use Client-Side Certificate diff --git a/service/apigateway/api_op_GetExport.go b/service/apigateway/api_op_GetExport.go index 3f96b336778..e95be01767d 100644 --- a/service/apigateway/api_op_GetExport.go +++ b/service/apigateway/api_op_GetExport.go @@ -58,35 +58,35 @@ func (c *Client) GetExport(ctx context.Context, params *GetExportInput, optFns . // Request a new export of a RestApi () for a particular Stage (). type GetExportInput struct { - // A key-value map of query string parameters that specify properties of the - // export, depending on the requested exportType. For exportTypeoas30 and swagger, - // any combination of the following parameters are supported: - // extensions='integrations' or extensions='apigateway' will export the API with - // x-amazon-apigateway-integration extensions. extensions='authorizers' will export - // the API with x-amazon-apigateway-authorizer extensions. postman will export the - // API with Postman extensions, allowing for import to the Postman tool - Parameters map[string]*string + // [Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x + // and 'swagger' for Swagger/OpenAPI 2.0. + // + // This member is required. + ExportType *string // [Required] The string identifier of the associated RestApi (). // // This member is required. RestApiId *string + // [Required] The name of the Stage () that will be exported. + // + // This member is required. + StageName *string + // The content-type of the export, for example application/json. Currently // application/json and application/yaml are supported for exportType ofoas30 and // swagger. This should be specified in the Accept header for direct API requests. Accepts *string - // [Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x - // and 'swagger' for Swagger/OpenAPI 2.0. - // - // This member is required. - ExportType *string - - // [Required] The name of the Stage () that will be exported. - // - // This member is required. - StageName *string + // A key-value map of query string parameters that specify properties of the + // export, depending on the requested exportType. For exportTypeoas30 and swagger, + // any combination of the following parameters are supported: + // extensions='integrations' or extensions='apigateway' will export the API with + // x-amazon-apigateway-integration extensions. extensions='authorizers' will export + // the API with x-amazon-apigateway-authorizer extensions. postman will export the + // API with Postman extensions, allowing for import to the Postman tool + Parameters map[string]*string } // The binary blob response to GetExport (), which contains the generated SDK. @@ -95,13 +95,13 @@ type GetExportOutput struct { // The binary blob response to GetExport (), which contains the export. Body []byte + // The content-disposition header value in the HTTP response. + ContentDisposition *string + // The content-type header value in the HTTP response. This will correspond to a // valid 'accept' type in the request. ContentType *string - // The content-disposition header value in the HTTP response. - ContentDisposition *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_GetGatewayResponse.go b/service/apigateway/api_op_GetGatewayResponse.go index eedf193430a..6ca1b9b5d62 100644 --- a/service/apigateway/api_op_GetGatewayResponse.go +++ b/service/apigateway/api_op_GetGatewayResponse.go @@ -58,9 +58,6 @@ func (c *Client) GetGatewayResponse(ctx context.Context, params *GetGatewayRespo // Gets a GatewayResponse () of a specified response type on the given RestApi (). type GetGatewayResponseInput struct { - TemplateSkipList []*string - - Template *bool // [Required] The response type of the associated GatewayResponse (). Valid values // are @@ -122,6 +119,10 @@ type GetGatewayResponseInput struct { Name *string + Template *bool + + TemplateSkipList []*string + Title *string } @@ -174,6 +175,19 @@ type GetGatewayResponseInput struct { // Gateway Responses type GetGatewayResponseOutput struct { + // A Boolean flag to indicate whether this GatewayResponse () is the default + // gateway response (true) or not (false). A default gateway response is one + // generated by API Gateway without any customization by an API developer. + DefaultResponse *bool + + // Response parameters (paths, query strings and headers) of the GatewayResponse () + // as a string-to-string map of key-value pairs. + ResponseParameters map[string]*string + + // Response templates of the GatewayResponse () as a string-to-string map of + // key-value pairs. + ResponseTemplates map[string]*string + // The response type of the associated GatewayResponse (). Valid values are // // * @@ -224,19 +238,6 @@ type GetGatewayResponseOutput struct { // * UNSUPPORTED_MEDIA_TYPE ResponseType types.GatewayResponseType - // A Boolean flag to indicate whether this GatewayResponse () is the default - // gateway response (true) or not (false). A default gateway response is one - // generated by API Gateway without any customization by an API developer. - DefaultResponse *bool - - // Response parameters (paths, query strings and headers) of the GatewayResponse () - // as a string-to-string map of key-value pairs. - ResponseParameters map[string]*string - - // Response templates of the GatewayResponse () as a string-to-string map of - // key-value pairs. - ResponseTemplates map[string]*string - // The HTTP status code for this GatewayResponse (). StatusCode *string diff --git a/service/apigateway/api_op_GetGatewayResponses.go b/service/apigateway/api_op_GetGatewayResponses.go index b3444b31d15..940c248136a 100644 --- a/service/apigateway/api_op_GetGatewayResponses.go +++ b/service/apigateway/api_op_GetGatewayResponses.go @@ -65,27 +65,27 @@ func (c *Client) GetGatewayResponses(ctx context.Context, params *GetGatewayResp // supported response types. type GetGatewayResponsesInput struct { - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. The GatewayResponses () collection does not support - // pagination and the limit does not apply here. - Limit *int32 - // [Required] The string identifier of the associated RestApi (). // // This member is required. RestApiId *string - Name *string - - TemplateSkipList []*string + // The maximum number of returned results per page. The default value is 25 and the + // maximum value is 500. The GatewayResponses () collection does not support + // pagination and the limit does not apply here. + Limit *int32 - Title *string + Name *string // The current pagination position in the paged result set. The GatewayResponse () // collection does not support pagination and the position does not apply here. Position *string Template *bool + + TemplateSkipList []*string + + Title *string } // The collection of the GatewayResponse () instances of a RestApi () as a diff --git a/service/apigateway/api_op_GetIntegration.go b/service/apigateway/api_op_GetIntegration.go index 09f0e5eadfd..a7ec4674982 100644 --- a/service/apigateway/api_op_GetIntegration.go +++ b/service/apigateway/api_op_GetIntegration.go @@ -59,28 +59,28 @@ func (c *Client) GetIntegration(ctx context.Context, params *GetIntegrationInput // Represents a request to get the integration configuration. type GetIntegrationInput struct { - // [Required] The string identifier of the associated RestApi (). - // - // This member is required. - RestApiId *string - - Name *string - - Title *string - // [Required] Specifies a get integration request's HTTP method. // // This member is required. HttpMethod *string - TemplateSkipList []*string - // [Required] Specifies a get integration request's resource identifier // // This member is required. ResourceId *string + // [Required] The string identifier of the associated RestApi (). + // + // This member is required. + RestApiId *string + + Name *string + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration. In the API @@ -89,15 +89,135 @@ type GetIntegrationInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) type GetIntegrationOutput struct { + // A list of request parameters whose values API Gateway caches. To be valid values + // for cacheKeyParameters, these parameters must also be specified for Method + // ()requestParameters. + CacheKeyParameters []*string + // Specifies a group of related cached parameters. By default, API Gateway uses the // resource ID as the cacheNamespace. You can specify the same cacheNamespace // across resources to return the same cached data for requests to different // resources. CacheNamespace *string + // The (id + // (https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id)) of + // the VpcLink () used for the integration when connectionType=VPC_LINK and + // undefined, otherwise. + ConnectionId *string + + // The type of the network connection to the integration endpoint. The valid value + // is INTERNET for connections through the public routable internet or VPC_LINK for + // private connections between API Gateway and a network load balancer in a VPC. + // The default value is INTERNET. + ConnectionType types.ConnectionType + + // Specifies how to handle request payload content type conversions. Supported + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following + // behaviors: + // + // * CONVERT_TO_BINARY: Converts a request payload from a + // Base64-encoded string to the corresponding binary blob. + // + // * CONVERT_TO_TEXT: + // Converts a request payload from a binary blob to a Base64-encoded string. + // + // If + // this property is not defined, the request payload will be passed through from + // the method request to integration request without modification, provided that + // the passthroughBehavior is configured to support payload pass-through. + ContentHandling types.ContentHandlingStrategy + + // Specifies the credentials required for the integration, if any. For AWS + // integrations, three options are available. To specify an IAM Role for API + // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that + // the caller's identity be passed through from the request, specify the string + // arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS + // services, specify null. + Credentials *string + // Specifies the integration's HTTP method type. HttpMethod *string + // Specifies the integration's responses. + // Example: Get integration responses of a + // method + // + // Request + // + // GET + // /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 + // HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com + // X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 + // Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, + // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} + // + // Response + // + // The + // successful response returns 200 OK status and a payload as follows: { "_links": + // { "curies": { "href": + // "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", + // "name": "integrationresponse", "templated": true }, "self": { "href": + // "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", + // "title": "200" }, "integrationresponse:delete": { "href": + // "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" + // }, "integrationresponse:update": { "href": + // "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" + // } }, "responseParameters": { "method.response.header.Content-Type": + // "'application/xml'" }, "responseTemplates": { "application/json": + // "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in + // $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" + // }, "statusCode": "200" }Creating an API + // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) + IntegrationResponses map[string]*types.IntegrationResponse + + // Specifies how the method request body of an unmapped content type will be passed + // through the integration request to the back end without transformation. A + // content type is unmapped if no mapping template is defined in the integration or + // the content type does not match any of the mapped content types, as specified in + // requestTemplates. The valid value is one of the following: + // + // * WHEN_NO_MATCH: + // passes the method request body through the integration request to the back end + // without transformation when the method request content type does not match any + // content type associated with the mapping templates defined in the integration + // request. + // + // * WHEN_NO_TEMPLATES: passes the method request body through the + // integration request to the back end without transformation when no mapping + // template is defined in the integration request. If a template is defined when + // this option is selected, the method request of an unmapped content-type will be + // rejected with an HTTP 415 Unsupported Media Type response. + // + // * NEVER: rejects + // the method request with an HTTP 415 Unsupported Media Type response when either + // the method request content type does not match any content type associated with + // the mapping templates defined in the integration request or no mapping template + // is defined in the integration request. + PassthroughBehavior *string + + // A key-value map specifying request parameters that are passed from the method + // request to the back end. The key is an integration request parameter name and + // the associated value is a method request parameter value or static value that + // must be enclosed within single quotes and pre-encoded as required by the back + // end. The method request parameter value must match the pattern of + // method.request.{location}.{name}, where location is querystring, path, or header + // and name must be a valid and unique method request parameter name. + RequestParameters map[string]*string + + // Represents a map of Velocity templates that are applied on the request payload + // based on the value of the Content-Type header sent by the client. The content + // type value is the key in this map, and the template (as a String) is the value. + RequestTemplates map[string]*string + + // Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 + // milliseconds or 29 seconds. + TimeoutInMillis *int32 + + // Specifies the TLS configuration for an integration. + TlsConfig *types.TlsConfig + // Specifies an API method integration type. The valid value is one of the // following: // @@ -132,10 +252,6 @@ type GetIntegrationOutput struct { // connect API Gateway to a network load balancer of a VPC. Type types.IntegrationType - // Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 - // milliseconds or 29 seconds. - TimeoutInMillis *int32 - // Specifies Uniform Resource Identifier (URI) of the integration endpoint. // // * @@ -164,122 +280,6 @@ type GetIntegrationOutput struct { // arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key} Uri *string - // The type of the network connection to the integration endpoint. The valid value - // is INTERNET for connections through the public routable internet or VPC_LINK for - // private connections between API Gateway and a network load balancer in a VPC. - // The default value is INTERNET. - ConnectionType types.ConnectionType - - // A key-value map specifying request parameters that are passed from the method - // request to the back end. The key is an integration request parameter name and - // the associated value is a method request parameter value or static value that - // must be enclosed within single quotes and pre-encoded as required by the back - // end. The method request parameter value must match the pattern of - // method.request.{location}.{name}, where location is querystring, path, or header - // and name must be a valid and unique method request parameter name. - RequestParameters map[string]*string - - // Represents a map of Velocity templates that are applied on the request payload - // based on the value of the Content-Type header sent by the client. The content - // type value is the key in this map, and the template (as a String) is the value. - RequestTemplates map[string]*string - - // A list of request parameters whose values API Gateway caches. To be valid values - // for cacheKeyParameters, these parameters must also be specified for Method - // ()requestParameters. - CacheKeyParameters []*string - - // The (id - // (https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id)) of - // the VpcLink () used for the integration when connectionType=VPC_LINK and - // undefined, otherwise. - ConnectionId *string - - // Specifies how the method request body of an unmapped content type will be passed - // through the integration request to the back end without transformation. A - // content type is unmapped if no mapping template is defined in the integration or - // the content type does not match any of the mapped content types, as specified in - // requestTemplates. The valid value is one of the following: - // - // * WHEN_NO_MATCH: - // passes the method request body through the integration request to the back end - // without transformation when the method request content type does not match any - // content type associated with the mapping templates defined in the integration - // request. - // - // * WHEN_NO_TEMPLATES: passes the method request body through the - // integration request to the back end without transformation when no mapping - // template is defined in the integration request. If a template is defined when - // this option is selected, the method request of an unmapped content-type will be - // rejected with an HTTP 415 Unsupported Media Type response. - // - // * NEVER: rejects - // the method request with an HTTP 415 Unsupported Media Type response when either - // the method request content type does not match any content type associated with - // the mapping templates defined in the integration request or no mapping template - // is defined in the integration request. - PassthroughBehavior *string - - // Specifies the TLS configuration for an integration. - TlsConfig *types.TlsConfig - - // Specifies the credentials required for the integration, if any. For AWS - // integrations, three options are available. To specify an IAM Role for API - // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that - // the caller's identity be passed through from the request, specify the string - // arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS - // services, specify null. - Credentials *string - - // Specifies how to handle request payload content type conversions. Supported - // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following - // behaviors: - // - // * CONVERT_TO_BINARY: Converts a request payload from a - // Base64-encoded string to the corresponding binary blob. - // - // * CONVERT_TO_TEXT: - // Converts a request payload from a binary blob to a Base64-encoded string. - // - // If - // this property is not defined, the request payload will be passed through from - // the method request to integration request without modification, provided that - // the passthroughBehavior is configured to support payload pass-through. - ContentHandling types.ContentHandlingStrategy - - // Specifies the integration's responses. - // Example: Get integration responses of a - // method - // - // Request - // - // GET - // /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 - // HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com - // X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 - // Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, - // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} - // - // Response - // - // The - // successful response returns 200 OK status and a payload as follows: { "_links": - // { "curies": { "href": - // "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", - // "name": "integrationresponse", "templated": true }, "self": { "href": - // "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", - // "title": "200" }, "integrationresponse:delete": { "href": - // "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" - // }, "integrationresponse:update": { "href": - // "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" - // } }, "responseParameters": { "method.response.header.Content-Type": - // "'application/xml'" }, "responseTemplates": { "application/json": - // "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in - // $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" - // }, "statusCode": "200" }Creating an API - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) - IntegrationResponses map[string]*types.IntegrationResponse - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_GetIntegrationResponse.go b/service/apigateway/api_op_GetIntegrationResponse.go index 8888f2d2a82..d52ae3cbf37 100644 --- a/service/apigateway/api_op_GetIntegrationResponse.go +++ b/service/apigateway/api_op_GetIntegrationResponse.go @@ -59,33 +59,33 @@ func (c *Client) GetIntegrationResponse(ctx context.Context, params *GetIntegrat // Represents a get integration response request. type GetIntegrationResponseInput struct { - // [Required] Specifies a get integration response request's status code. + // [Required] Specifies a get integration response request's HTTP method. // // This member is required. - StatusCode *string + HttpMethod *string // [Required] Specifies a get integration response request's resource identifier. // // This member is required. ResourceId *string - Template *bool - - Title *string - // [Required] The string identifier of the associated RestApi (). // // This member is required. RestApiId *string - TemplateSkipList []*string - - // [Required] Specifies a get integration response request's HTTP method. + // [Required] Specifies a get integration response request's status code. // // This member is required. - HttpMethod *string + StatusCode *string Name *string + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents an integration response. The status code must map to an existing @@ -94,6 +94,21 @@ type GetIntegrationResponseInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) type GetIntegrationResponseOutput struct { + // Specifies how to handle response payload content type conversions. Supported + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following + // behaviors: + // + // * CONVERT_TO_BINARY: Converts a response payload from a + // Base64-encoded string to the corresponding binary blob. + // + // * CONVERT_TO_TEXT: + // Converts a response payload from a binary blob to a Base64-encoded string. + // + // If + // this property is not defined, the response payload will be passed through from + // the integration response to the method response without modification. + ContentHandling types.ContentHandlingStrategy + // A key-value map specifying response parameters that are passed to the method // response from the back end. The key is a method response header parameter name // and the mapped value is an integration response header value, a static value @@ -112,10 +127,6 @@ type GetIntegrationResponseOutput struct { // the key and a template as the value. ResponseTemplates map[string]*string - // Specifies the status code that is used to map the integration response to an - // existing MethodResponse (). - StatusCode *string - // Specifies the regular expression (regex) pattern used to choose an integration // response based on the response from the back end. For example, if the success // response returns nothing and the error response returns some string, you could @@ -125,20 +136,9 @@ type GetIntegrationResponseOutput struct { // For all other HTTP and AWS back ends, the HTTP status code is matched. SelectionPattern *string - // Specifies how to handle response payload content type conversions. Supported - // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following - // behaviors: - // - // * CONVERT_TO_BINARY: Converts a response payload from a - // Base64-encoded string to the corresponding binary blob. - // - // * CONVERT_TO_TEXT: - // Converts a response payload from a binary blob to a Base64-encoded string. - // - // If - // this property is not defined, the response payload will be passed through from - // the integration response to the method response without modification. - ContentHandling types.ContentHandlingStrategy + // Specifies the status code that is used to map the integration response to an + // existing MethodResponse (). + StatusCode *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigateway/api_op_GetMethod.go b/service/apigateway/api_op_GetMethod.go index 6be36fc2fb6..9a2cc9716ea 100644 --- a/service/apigateway/api_op_GetMethod.go +++ b/service/apigateway/api_op_GetMethod.go @@ -58,17 +58,17 @@ func (c *Client) GetMethod(ctx context.Context, params *GetMethodInput, optFns . // Request to describe an existing Method () resource. type GetMethodInput struct { - Template *bool + + // [Required] Specifies the method request's HTTP method type. + // + // This member is required. + HttpMethod *string // [Required] The Resource () identifier for the Method () resource. // // This member is required. ResourceId *string - Title *string - - TemplateSkipList []*string - // [Required] The string identifier of the associated RestApi (). // // This member is required. @@ -76,10 +76,11 @@ type GetMethodInput struct { Name *string - // [Required] Specifies the method request's HTTP method type. - // - // This member is required. - HttpMethod *string + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents a client-facing interface by which the client calls the API to access @@ -174,65 +175,32 @@ type GetMethodInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-method-settings.html) type GetMethodOutput struct { - // A key-value map defining required or optional method request parameters that can - // be accepted by API Gateway. A key is a method request parameter name matching - // the pattern of method.request.{location}.{name}, where location is querystring, - // path, or header and name is a valid and unique parameter name. The value - // associated with the key is a Boolean flag indicating whether the parameter is - // required (true) or optional (false). The method request parameter names defined - // here are available in Integration () to be mapped to integration request - // parameters or templates. - RequestParameters map[string]*bool + // A boolean flag specifying whether a valid ApiKey () is required to invoke this + // method. + ApiKeyRequired *bool + + // A list of authorization scopes configured on the method. The scopes are used + // with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The + // authorization works by matching the method scopes against the scopes parsed from + // the access token in the incoming request. The method invocation is authorized if + // any method scopes matches a claimed scope in the access token. Otherwise, the + // invocation is not authorized. When the method scope is configured, the client + // must provide an access token instead of an identity token for authorization + // purposes. + AuthorizationScopes []*string // The method's authorization type. Valid values are NONE for open access, AWS_IAM // for using AWS IAM permissions, CUSTOM for using a custom authorizer, or // COGNITO_USER_POOLS for using a Cognito user pool. AuthorizationType *string - // The method's HTTP verb. - HttpMethod *string - - // Gets a method response associated with a given HTTP status code. The collection - // of method responses are encapsulated in a key-value map, where the key is a - // response's HTTP status code and the value is a MethodResponse () resource that - // specifies the response returned to the caller from the back end through the - // integration response. - // Example: Get a 200 OK response of a GET method - // - // Request - // - // - // GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 - // Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com - // Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 - // Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, - // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} - // - // Response - // - // The - // successful response returns a 200 OK status code and a payload similar to the - // following: { "_links": { "curies": { "href": - // "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", - // "name": "methodresponse", "templated": true }, "self": { "href": - // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": - // "200" }, "methodresponse:delete": { "href": - // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" }, - // "methodresponse:update": { "href": - // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } }, - // "responseModels": { "application/json": "Empty" }, "responseParameters": { - // "method.response.header.operator": false, "method.response.header.operand_2": - // false, "method.response.header.operand_1": false }, "statusCode": "200" }AWS CLI - // (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-method-response.html) - MethodResponses map[string]*types.MethodResponse - - // The identifier of a RequestValidator () for request validation. - RequestValidatorId *string - // The identifier of an Authorizer () to use on this method. The authorizationType // must be CUSTOM. AuthorizerId *string + // The method's HTTP verb. + HttpMethod *string + // Gets the method's integration responsible for passing the client-submitted // request to the back end and performing necessary transformations to make the // request compliant with the back end. @@ -289,30 +257,63 @@ type GetMethodOutput struct { // (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-integration.html) MethodIntegration *types.Integration + // Gets a method response associated with a given HTTP status code. The collection + // of method responses are encapsulated in a key-value map, where the key is a + // response's HTTP status code and the value is a MethodResponse () resource that + // specifies the response returned to the caller from the back end through the + // integration response. + // Example: Get a 200 OK response of a GET method + // + // Request + // + // + // GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 + // Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com + // Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 + // Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, + // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} + // + // Response + // + // The + // successful response returns a 200 OK status code and a payload similar to the + // following: { "_links": { "curies": { "href": + // "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", + // "name": "methodresponse", "templated": true }, "self": { "href": + // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": + // "200" }, "methodresponse:delete": { "href": + // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" }, + // "methodresponse:update": { "href": + // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } }, + // "responseModels": { "application/json": "Empty" }, "responseParameters": { + // "method.response.header.operator": false, "method.response.header.operand_2": + // false, "method.response.header.operand_1": false }, "statusCode": "200" }AWS CLI + // (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-method-response.html) + MethodResponses map[string]*types.MethodResponse + // A human-friendly operation identifier for the method. For example, you can // assign the operationName of ListPets for the GET /pets method in the PetStore // example. OperationName *string - // A boolean flag specifying whether a valid ApiKey () is required to invoke this - // method. - ApiKeyRequired *bool - - // A list of authorization scopes configured on the method. The scopes are used - // with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The - // authorization works by matching the method scopes against the scopes parsed from - // the access token in the incoming request. The method invocation is authorized if - // any method scopes matches a claimed scope in the access token. Otherwise, the - // invocation is not authorized. When the method scope is configured, the client - // must provide an access token instead of an identity token for authorization - // purposes. - AuthorizationScopes []*string - // A key-value map specifying data schemas, represented by Model () resources, (as // the mapped value) of the request payloads of given content types (as the mapping // key). RequestModels map[string]*string + // A key-value map defining required or optional method request parameters that can + // be accepted by API Gateway. A key is a method request parameter name matching + // the pattern of method.request.{location}.{name}, where location is querystring, + // path, or header and name is a valid and unique parameter name. The value + // associated with the key is a Boolean flag indicating whether the parameter is + // required (true) or optional (false). The method request parameter names defined + // here are available in Integration () to be mapped to integration request + // parameters or templates. + RequestParameters map[string]*bool + + // The identifier of a RequestValidator () for request validation. + RequestValidatorId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_GetMethodResponse.go b/service/apigateway/api_op_GetMethodResponse.go index c37fceb16dc..d879a419ccb 100644 --- a/service/apigateway/api_op_GetMethodResponse.go +++ b/service/apigateway/api_op_GetMethodResponse.go @@ -58,33 +58,33 @@ func (c *Client) GetMethodResponse(ctx context.Context, params *GetMethodRespons // Request to describe a MethodResponse () resource. type GetMethodResponseInput struct { + // [Required] The HTTP verb of the Method () resource. + // + // This member is required. + HttpMethod *string + // [Required] The Resource () identifier for the MethodResponse () resource. // // This member is required. ResourceId *string - // [Required] The status code for the MethodResponse () resource. + // [Required] The string identifier of the associated RestApi (). // // This member is required. - StatusCode *string - - Title *string + RestApiId *string - // [Required] The HTTP verb of the Method () resource. + // [Required] The status code for the MethodResponse () resource. // // This member is required. - HttpMethod *string + StatusCode *string Name *string - TemplateSkipList []*string + Template *bool - // [Required] The string identifier of the associated RestApi (). - // - // This member is required. - RestApiId *string + TemplateSkipList []*string - Template *bool + Title *string } // Represents a method response of a given HTTP status code returned to the client. @@ -125,9 +125,6 @@ type GetMethodResponseOutput struct { // Model () name as the value. ResponseModels map[string]*string - // The method response's status code. - StatusCode *string - // A key-value map specifying required or optional response parameters that API // Gateway can send back to the caller. A key defines a method response header and // the value specifies whether the associated method response header is required or @@ -143,6 +140,9 @@ type GetMethodResponseOutput struct { // is a valid JSON expression without the $ prefix.) ResponseParameters map[string]*bool + // The method response's status code. + StatusCode *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_GetModel.go b/service/apigateway/api_op_GetModel.go index e422a5fc4ed..b799df80cbb 100644 --- a/service/apigateway/api_op_GetModel.go +++ b/service/apigateway/api_op_GetModel.go @@ -58,28 +58,28 @@ func (c *Client) GetModel(ctx context.Context, params *GetModelInput, optFns ... // Request to list information about a model in an existing RestApi () resource. type GetModelInput struct { + // [Required] The name of the model as an identifier. + // + // This member is required. + ModelName *string + // [Required] The RestApi () identifier under which the Model () exists. // // This member is required. RestApiId *string - TemplateSkipList []*string - // A query parameter of a Boolean value to resolve (true) all external model // references and returns a flattened model schema or not (false) The default is // false. Flatten *bool - // [Required] The name of the model as an identifier. - // - // This member is required. - ModelName *string + Name *string Template *bool - Title *string + TemplateSkipList []*string - Name *string + Title *string } // Represents the data structure of a method's request or response payload. A @@ -92,18 +92,18 @@ type GetModelInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html) type GetModelOutput struct { - // The identifier for the model resource. - Id *string - - // The name of the model. Must be an alphanumeric string. - Name *string - // The content-type for the model. ContentType *string // The description of the model. Description *string + // The identifier for the model resource. + Id *string + + // The name of the model. Must be an alphanumeric string. + Name *string + // The schema for the model. For application/json models, this should be JSON // schema draft 4 (https://tools.ietf.org/html/draft-zyp-json-schema-04) model. Do // not include "\*/" characters in the description of any properties because such diff --git a/service/apigateway/api_op_GetModelTemplate.go b/service/apigateway/api_op_GetModelTemplate.go index 9a9b5d89075..26d303958f7 100644 --- a/service/apigateway/api_op_GetModelTemplate.go +++ b/service/apigateway/api_op_GetModelTemplate.go @@ -64,18 +64,18 @@ type GetModelTemplateInput struct { // This member is required. ModelName *string - Template *bool - // [Required] The string identifier of the associated RestApi (). // // This member is required. RestApiId *string + Name *string + + Template *bool + TemplateSkipList []*string Title *string - - Name *string } // Represents a mapping template used to transform a payload. Mapping Templates diff --git a/service/apigateway/api_op_GetModels.go b/service/apigateway/api_op_GetModels.go index 1fcda232a55..88960b0f4bd 100644 --- a/service/apigateway/api_op_GetModels.go +++ b/service/apigateway/api_op_GetModels.go @@ -59,25 +59,25 @@ func (c *Client) GetModels(ctx context.Context, params *GetModelsInput, optFns . // Request to list existing Models () defined for a RestApi () resource. type GetModelsInput struct { + // [Required] The string identifier of the associated RestApi (). + // + // This member is required. + RestApiId *string + // The maximum number of returned results per page. The default value is 25 and the // maximum value is 500. Limit *int32 Name *string - TemplateSkipList []*string - - Title *string - // The current pagination position in the paged result set. Position *string Template *bool - // [Required] The string identifier of the associated RestApi (). - // - // This member is required. - RestApiId *string + TemplateSkipList []*string + + Title *string } // Represents a collection of Model () resources. Method (), MethodResponse (), diff --git a/service/apigateway/api_op_GetRequestValidator.go b/service/apigateway/api_op_GetRequestValidator.go index f23f7a84d9b..161811c43b7 100644 --- a/service/apigateway/api_op_GetRequestValidator.go +++ b/service/apigateway/api_op_GetRequestValidator.go @@ -63,18 +63,18 @@ type GetRequestValidatorInput struct { // This member is required. RequestValidatorId *string - Template *bool + // [Required] The string identifier of the associated RestApi (). + // + // This member is required. + RestApiId *string Name *string - Title *string + Template *bool TemplateSkipList []*string - // [Required] The string identifier of the associated RestApi (). - // - // This member is required. - RestApiId *string + Title *string } // A set of validation rules for incoming Method () requests. In OpenAPI, a @@ -90,6 +90,9 @@ type GetRequestValidatorOutput struct { // The identifier of this RequestValidator (). Id *string + // The name of this RequestValidator () + Name *string + // A Boolean flag to indicate whether to validate a request body according to the // configured Model () schema. ValidateRequestBody *bool @@ -98,9 +101,6 @@ type GetRequestValidatorOutput struct { // (false). ValidateRequestParameters *bool - // The name of this RequestValidator () - Name *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_GetRequestValidators.go b/service/apigateway/api_op_GetRequestValidators.go index 2b92d123a7e..2966269db8d 100644 --- a/service/apigateway/api_op_GetRequestValidators.go +++ b/service/apigateway/api_op_GetRequestValidators.go @@ -58,25 +58,26 @@ func (c *Client) GetRequestValidators(ctx context.Context, params *GetRequestVal // Gets the RequestValidators () collection of a given RestApi (). type GetRequestValidatorsInput struct { - Template *bool - - Title *string - Name *string + // [Required] The string identifier of the associated RestApi (). + // + // This member is required. + RestApiId *string // The maximum number of returned results per page. The default value is 25 and the // maximum value is 500. Limit *int32 + Name *string + // The current pagination position in the paged result set. Position *string + Template *bool + TemplateSkipList []*string - // [Required] The string identifier of the associated RestApi (). - // - // This member is required. - RestApiId *string + Title *string } // A collection of RequestValidator () resources of a given RestApi (). In OpenAPI, diff --git a/service/apigateway/api_op_GetResource.go b/service/apigateway/api_op_GetResource.go index 5d56659b62e..a42478423b4 100644 --- a/service/apigateway/api_op_GetResource.go +++ b/service/apigateway/api_op_GetResource.go @@ -59,15 +59,16 @@ func (c *Client) GetResource(ctx context.Context, params *GetResourceInput, optF // Request to list information about a resource. type GetResourceInput struct { + // [Required] The identifier for the Resource () resource. + // + // This member is required. + ResourceId *string + // [Required] The string identifier of the associated RestApi (). // // This member is required. RestApiId *string - Name *string - - Title *string - // A query parameter to retrieve the specified resources embedded in the returned // Resource () representation in the response. This embed parameter value is a list // of comma-separated strings. Currently, the request supports only retrieval of @@ -76,14 +77,13 @@ type GetResourceInput struct { // /restapis/{restapi_id}/resources/{resource_id}?embed=methods. Embed []*string - TemplateSkipList []*string + Name *string Template *bool - // [Required] The identifier for the Resource () resource. - // - // This member is required. - ResourceId *string + TemplateSkipList []*string + + Title *string } // Represents an API resource. Create an API @@ -93,6 +93,15 @@ type GetResourceOutput struct { // The resource's identifier. Id *string + // The parent resource's identifier. + ParentId *string + + // The full path for this resource. + Path *string + + // The last path segment for this resource. + PathPart *string + // Gets an API resource's method of a given HTTP verb. The resource methods are a // map of methods indexed by methods' HTTP verbs enabled on the resource. This // method map is included in the 200 OK response of the GET @@ -174,15 +183,6 @@ type GetResourceOutput struct { // OPTIONS. ResourceMethods map[string]*types.Method - // The parent resource's identifier. - ParentId *string - - // The full path for this resource. - Path *string - - // The last path segment for this resource. - PathPart *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_GetResources.go b/service/apigateway/api_op_GetResources.go index f66f45b01bd..393c534831e 100644 --- a/service/apigateway/api_op_GetResources.go +++ b/service/apigateway/api_op_GetResources.go @@ -58,17 +58,12 @@ func (c *Client) GetResources(ctx context.Context, params *GetResourcesInput, op // Request to list information about a collection of resources. type GetResourcesInput struct { - Template *bool // [Required] The string identifier of the associated RestApi (). // // This member is required. RestApiId *string - TemplateSkipList []*string - - Title *string - // A query parameter used to retrieve the specified resources embedded in the // returned Resources () resource in the response. This embed parameter value is a // list of comma-separated strings. Currently, the request supports only retrieval @@ -77,14 +72,20 @@ type GetResourcesInput struct { // /restapis/{restapi_id}/resources?embed=methods. Embed []*string - // The current pagination position in the paged result set. - Position *string - // The maximum number of returned results per page. The default value is 25 and the // maximum value is 500. Limit *int32 Name *string + + // The current pagination position in the paged result set. + Position *string + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents a collection of Resource () resources. Create an API diff --git a/service/apigateway/api_op_GetRestApi.go b/service/apigateway/api_op_GetRestApi.go index b5dfb19c60b..2718a33a847 100644 --- a/service/apigateway/api_op_GetRestApi.go +++ b/service/apigateway/api_op_GetRestApi.go @@ -59,35 +59,25 @@ func (c *Client) GetRestApi(ctx context.Context, params *GetRestApiInput, optFns // The GET request to list an existing RestApi () defined for your collection. type GetRestApiInput struct { - Name *string - - TemplateSkipList []*string - - Title *string - - Template *bool // [Required] The string identifier of the associated RestApi (). // // This member is required. RestApiId *string + + Name *string + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents a REST API. Create an API // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) type GetRestApiOutput struct { - // The API's description. - Description *string - - // A stringified JSON policy document that applies to this RestApi regardless of - // the caller and Method () configuration. - Policy *string - - // The endpoint configuration of this RestApi () showing the endpoint types of the - // API. - EndpointConfiguration *types.EndpointConfiguration - // The source of the API key for metering requests according to a usage plan. Valid // values are: // @@ -98,30 +88,24 @@ type GetRestApiOutput struct { // a custom authorizer. ApiKeySource types.ApiKeySourceType - // The API's name. - Name *string - - // A version identifier for the API. - Version *string - - // The collection of tags. Each tag element is associated with a given resource. - Tags map[string]*string - - // The warning messages reported when failonwarnings is turned on during API - // import. - Warnings []*string + // The list of binary media types supported by the RestApi (). By default, the + // RestApi () supports only UTF-8-encoded text payloads. + BinaryMediaTypes []*string // The timestamp when the API was created. CreatedDate *time.Time + // The API's description. + Description *string + + // The endpoint configuration of this RestApi () showing the endpoint types of the + // API. + EndpointConfiguration *types.EndpointConfiguration + // The API's identifier. This identifier is unique across all of your APIs in API // Gateway. Id *string - // The list of binary media types supported by the RestApi (). By default, the - // RestApi () supports only UTF-8-encoded text payloads. - BinaryMediaTypes []*string - // A nullable integer that is used to enable compression (with non-negative between // 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null // value) on an API. When compression is enabled, compression or decompression is @@ -129,6 +113,23 @@ type GetRestApiOutput struct { // Setting it to zero allows compression for any payload size. MinimumCompressionSize *int32 + // The API's name. + Name *string + + // A stringified JSON policy document that applies to this RestApi regardless of + // the caller and Method () configuration. + Policy *string + + // The collection of tags. Each tag element is associated with a given resource. + Tags map[string]*string + + // A version identifier for the API. + Version *string + + // The warning messages reported when failonwarnings is turned on during API + // import. + Warnings []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_GetRestApis.go b/service/apigateway/api_op_GetRestApis.go index f0de57411c2..3199cc72aa4 100644 --- a/service/apigateway/api_op_GetRestApis.go +++ b/service/apigateway/api_op_GetRestApis.go @@ -57,20 +57,21 @@ func (c *Client) GetRestApis(ctx context.Context, params *GetRestApisInput, optF // The GET request to list existing RestApis () defined for your collection. type GetRestApisInput struct { - Name *string // The maximum number of returned results per page. The default value is 25 and the // maximum value is 500. Limit *int32 - TemplateSkipList []*string - - Title *string + Name *string // The current pagination position in the paged result set. Position *string Template *bool + + TemplateSkipList []*string + + Title *string } // Contains references to your APIs and links that guide you in how to interact diff --git a/service/apigateway/api_op_GetSdk.go b/service/apigateway/api_op_GetSdk.go index c331673b560..16ef16c29e4 100644 --- a/service/apigateway/api_op_GetSdk.go +++ b/service/apigateway/api_op_GetSdk.go @@ -63,13 +63,6 @@ type GetSdkInput struct { // This member is required. RestApiId *string - // A string-to-string key-value map of query parameters sdkType-dependent - // properties of the SDK. For sdkType of objectivec or swift, a parameter named - // classPrefix is required. For sdkType of android, parameters named groupId, - // artifactId, artifactVersion, and invokerPackage are required. For sdkType of - // java, parameters named serviceName and javaPackageName are required. - Parameters map[string]*string - // [Required] The language for the generated SDK. Currently java, javascript, // android, objectivec (for iOS), swift (for iOS), and ruby are supported. // @@ -80,20 +73,27 @@ type GetSdkInput struct { // // This member is required. StageName *string + + // A string-to-string key-value map of query parameters sdkType-dependent + // properties of the SDK. For sdkType of objectivec or swift, a parameter named + // classPrefix is required. For sdkType of android, parameters named groupId, + // artifactId, artifactVersion, and invokerPackage are required. For sdkType of + // java, parameters named serviceName and javaPackageName are required. + Parameters map[string]*string } // The binary blob response to GetSdk (), which contains the generated SDK. type GetSdkOutput struct { + // The binary blob response to GetSdk (), which contains the generated SDK. + Body []byte + // The content-disposition header value in the HTTP response. ContentDisposition *string // The content-type header value in the HTTP response. ContentType *string - // The binary blob response to GetSdk (), which contains the generated SDK. - Body []byte - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_GetSdkType.go b/service/apigateway/api_op_GetSdkType.go index f0eb50c862e..4e998a3720c 100644 --- a/service/apigateway/api_op_GetSdkType.go +++ b/service/apigateway/api_op_GetSdkType.go @@ -57,31 +57,32 @@ func (c *Client) GetSdkType(ctx context.Context, params *GetSdkTypeInput, optFns // Get an SdkType () instance. type GetSdkTypeInput struct { - Template *bool - - TemplateSkipList []*string // [Required] The identifier of the queried SdkType () instance. // // This member is required. Id *string - Title *string - Name *string + + Template *bool + + TemplateSkipList []*string + + Title *string } // A type of SDK that API Gateway can generate. type GetSdkTypeOutput struct { - // The user-friendly name of an SdkType () instance. - FriendlyName *string + // A list of configuration properties of an SdkType (). + ConfigurationProperties []*types.SdkConfigurationProperty // The description of an SdkType (). Description *string - // A list of configuration properties of an SdkType (). - ConfigurationProperties []*types.SdkConfigurationProperty + // The user-friendly name of an SdkType () instance. + FriendlyName *string // The identifier of an SdkType () instance. Id *string diff --git a/service/apigateway/api_op_GetSdkTypes.go b/service/apigateway/api_op_GetSdkTypes.go index 91bf08d60d2..6c5dfca2fa1 100644 --- a/service/apigateway/api_op_GetSdkTypes.go +++ b/service/apigateway/api_op_GetSdkTypes.go @@ -56,17 +56,18 @@ func (c *Client) GetSdkTypes(ctx context.Context, params *GetSdkTypesInput, optF // Get the SdkTypes () collection. type GetSdkTypesInput struct { - Template *bool - - Name *string // The maximum number of returned results per page. The default value is 25 and the // maximum value is 500. Limit *int32 + Name *string + // The current pagination position in the paged result set. Position *string + Template *bool + TemplateSkipList []*string Title *string diff --git a/service/apigateway/api_op_GetStage.go b/service/apigateway/api_op_GetStage.go index f7ba167a949..c13cafb015b 100644 --- a/service/apigateway/api_op_GetStage.go +++ b/service/apigateway/api_op_GetStage.go @@ -60,23 +60,23 @@ func (c *Client) GetStage(ctx context.Context, params *GetStageInput, optFns ... // Requests API Gateway to get information about a Stage () resource. type GetStageInput struct { + // [Required] The string identifier of the associated RestApi (). + // + // This member is required. + RestApiId *string + // [Required] The name of the Stage () resource to get information about. // // This member is required. StageName *string + Name *string + Template *bool TemplateSkipList []*string Title *string - - Name *string - - // [Required] The string identifier of the associated RestApi (). - // - // This member is required. - RestApiId *string } // Represents a unique identifier for a version of a deployed RestApi () that is @@ -84,43 +84,32 @@ type GetStageInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api.html) type GetStageOutput struct { - // The identifier of the Deployment () that the stage points to. - DeploymentId *string - - // The stage's description. - Description *string + // Settings for logging access in this stage. + AccessLogSettings *types.AccessLogSettings - // The name of the stage is the first path segment in the Uniform Resource - // Identifier (URI) of a call to API Gateway. Stage names can only contain - // alphanumeric characters, hyphens, and underscores. Maximum length is 128 - // characters. - StageName *string + // Specifies whether a cache cluster is enabled for the stage. + CacheClusterEnabled *bool - // The collection of tags. Each tag element is associated with a given resource. - Tags map[string]*string + // The size of the cache cluster for the stage, if enabled. + CacheClusterSize types.CacheClusterSize // The status of the cache cluster for the stage, if enabled. CacheClusterStatus types.CacheClusterStatus - // The identifier of a client certificate for an API stage. - ClientCertificateId *string - - // Specifies whether a cache cluster is enabled for the stage. - CacheClusterEnabled *bool - // Settings for the canary deployment in this stage. CanarySettings *types.CanarySettings - // A map that defines the stage variables for a Stage () resource. Variable names - // can have alphanumeric and underscore characters, and the values must match - // [A-Za-z0-9-._~:/?#&=,]+. - Variables map[string]*string + // The identifier of a client certificate for an API stage. + ClientCertificateId *string - // The size of the cache cluster for the stage, if enabled. - CacheClusterSize types.CacheClusterSize + // The timestamp when the stage was created. + CreatedDate *time.Time - // Settings for logging access in this stage. - AccessLogSettings *types.AccessLogSettings + // The identifier of the Deployment () that the stage points to. + DeploymentId *string + + // The stage's description. + Description *string // The version of the associated API documentation. DocumentationVersion *string @@ -128,21 +117,32 @@ type GetStageOutput struct { // The timestamp when the stage last updated. LastUpdatedDate *time.Time - // The timestamp when the stage was created. - CreatedDate *time.Time + // A map that defines the method settings for a Stage () resource. Keys (designated + // as /{method_setting_key below) are method paths defined as + // {resource_path}/{http_method} for an individual method override, or /\*/\* for + // overriding all methods in the stage. + MethodSettings map[string]*types.MethodSetting + + // The name of the stage is the first path segment in the Uniform Resource + // Identifier (URI) of a call to API Gateway. Stage names can only contain + // alphanumeric characters, hyphens, and underscores. Maximum length is 128 + // characters. + StageName *string + + // The collection of tags. Each tag element is associated with a given resource. + Tags map[string]*string // Specifies whether active tracing with X-ray is enabled for the Stage (). TracingEnabled *bool + // A map that defines the stage variables for a Stage () resource. Variable names + // can have alphanumeric and underscore characters, and the values must match + // [A-Za-z0-9-._~:/?#&=,]+. + Variables map[string]*string + // The ARN of the WebAcl associated with the Stage (). WebAclArn *string - // A map that defines the method settings for a Stage () resource. Keys (designated - // as /{method_setting_key below) are method paths defined as - // {resource_path}/{http_method} for an individual method override, or /\*/\* for - // overriding all methods in the stage. - MethodSettings map[string]*types.MethodSetting - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_GetStages.go b/service/apigateway/api_op_GetStages.go index a39ca9d8696..54ec46c129e 100644 --- a/service/apigateway/api_op_GetStages.go +++ b/service/apigateway/api_op_GetStages.go @@ -59,21 +59,21 @@ func (c *Client) GetStages(ctx context.Context, params *GetStagesInput, optFns . // Requests API Gateway to get information about one or more Stage () resources. type GetStagesInput struct { - // The stages' deployment identifiers. - DeploymentId *string - - TemplateSkipList []*string - // [Required] The string identifier of the associated RestApi (). // // This member is required. RestApiId *string + // The stages' deployment identifiers. + DeploymentId *string + + Name *string + Template *bool - Title *string + TemplateSkipList []*string - Name *string + Title *string } // A list of Stage () resources that are associated with the ApiKey () resource. diff --git a/service/apigateway/api_op_GetTags.go b/service/apigateway/api_op_GetTags.go index 745e839e7ce..b4e3da06f1b 100644 --- a/service/apigateway/api_op_GetTags.go +++ b/service/apigateway/api_op_GetTags.go @@ -57,11 +57,11 @@ func (c *Client) GetTags(ctx context.Context, params *GetTagsInput, optFns ...fu // Gets the Tags () collection for a given resource. type GetTagsInput struct { - Template *bool - - Title *string - TemplateSkipList []*string + // [Required] The ARN of a resource that can be tagged. + // + // This member is required. + ResourceArn *string // (Not currently supported) The maximum number of returned results per page. The // default value is 25 and the maximum value is 500. @@ -69,14 +69,15 @@ type GetTagsInput struct { Name *string - // [Required] The ARN of a resource that can be tagged. - // - // This member is required. - ResourceArn *string - // (Not currently supported) The current pagination position in the paged result // set. Position *string + + Template *bool + + TemplateSkipList []*string + + Title *string } // The collection of tags. Each tag element is associated with a given resource. diff --git a/service/apigateway/api_op_GetUsage.go b/service/apigateway/api_op_GetUsage.go index 959a684904e..9a18cc57581 100644 --- a/service/apigateway/api_op_GetUsage.go +++ b/service/apigateway/api_op_GetUsage.go @@ -59,11 +59,6 @@ func (c *Client) GetUsage(ctx context.Context, params *GetUsageInput, optFns ... // interval. type GetUsageInput struct { - // The current pagination position in the paged result set. - Position *string - - Template *bool - // [Required] The ending date (e.g., 2016-12-31) of the usage data. // // This member is required. @@ -79,10 +74,6 @@ type GetUsageInput struct { // This member is required. UsagePlanId *string - TemplateSkipList []*string - - Title *string - // The Id of the API key associated with the resultant usage data. KeyId *string @@ -91,6 +82,15 @@ type GetUsageInput struct { Limit *int32 Name *string + + // The current pagination position in the paged result set. + Position *string + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents the usage data of a usage plan. Create and Use Usage Plans @@ -102,12 +102,6 @@ type GetUsageOutput struct { // The ending date of the usage data. EndDate *string - // The plan Id associated with this usage data. - UsagePlanId *string - - // The starting date of the usage data. - StartDate *string - // The usage data, as daily logs of used and remaining quotas, over the specified // time interval indexed over the API keys in a usage plan. For example, {..., // "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} @@ -118,6 +112,12 @@ type GetUsageOutput struct { // The current pagination position in the paged result set. Position *string + // The starting date of the usage data. + StartDate *string + + // The plan Id associated with this usage data. + UsagePlanId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_GetUsagePlan.go b/service/apigateway/api_op_GetUsagePlan.go index b7d1787298f..33951d72f4a 100644 --- a/service/apigateway/api_op_GetUsagePlan.go +++ b/service/apigateway/api_op_GetUsagePlan.go @@ -64,13 +64,13 @@ type GetUsagePlanInput struct { // This member is required. UsagePlanId *string - Template *bool - Name *string - Title *string + Template *bool TemplateSkipList []*string + + Title *string } // Represents a usage plan than can specify who can assess associated API stages @@ -80,18 +80,18 @@ type GetUsagePlanInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) type GetUsagePlanOutput struct { + // The associated API stages of a usage plan. + ApiStages []*types.ApiStage + + // The description of a usage plan. + Description *string + // The identifier of a UsagePlan () resource. Id *string - // The request throttle limits of a usage plan. - Throttle *types.ThrottleSettings - // The name of a usage plan. Name *string - // The associated API stages of a usage plan. - ApiStages []*types.ApiStage - // The AWS Markeplace product identifier to associate with the usage plan as a SaaS // product on AWS Marketplace. ProductCode *string @@ -102,8 +102,8 @@ type GetUsagePlanOutput struct { // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string - // The description of a usage plan. - Description *string + // The request throttle limits of a usage plan. + Throttle *types.ThrottleSettings // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigateway/api_op_GetUsagePlanKey.go b/service/apigateway/api_op_GetUsagePlanKey.go index d18485d09fa..a434f758cb2 100644 --- a/service/apigateway/api_op_GetUsagePlanKey.go +++ b/service/apigateway/api_op_GetUsagePlanKey.go @@ -57,9 +57,6 @@ func (c *Client) GetUsagePlanKey(ctx context.Context, params *GetUsagePlanKeyInp // The GET request to get a usage plan key of a given key identifier. type GetUsagePlanKeyInput struct { - Template *bool - - Name *string // [Required] The key Id of the to-be-retrieved UsagePlanKey () resource // representing a plan customer. @@ -67,16 +64,20 @@ type GetUsagePlanKeyInput struct { // This member is required. KeyId *string - TemplateSkipList []*string - - Title *string - // [Required] The Id of the UsagePlan () resource representing the usage plan // containing the to-be-retrieved UsagePlanKey () resource representing a plan // customer. // // This member is required. UsagePlanId *string + + Name *string + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents a usage plan key to identify a plan customer. To associate an API @@ -85,18 +86,18 @@ type GetUsagePlanKeyInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) type GetUsagePlanKeyOutput struct { - // The name of a usage plan key. - Name *string - - // The value of a usage plan key. - Value *string - // The Id of a usage plan key. Id *string + // The name of a usage plan key. + Name *string + // The type of a usage plan key. Currently, the valid key type is API_KEY. Type *string + // The value of a usage plan key. + Value *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_GetUsagePlanKeys.go b/service/apigateway/api_op_GetUsagePlanKeys.go index e4b1b44b6ea..ba50a87ce22 100644 --- a/service/apigateway/api_op_GetUsagePlanKeys.go +++ b/service/apigateway/api_op_GetUsagePlanKeys.go @@ -60,30 +60,31 @@ func (c *Client) GetUsagePlanKeys(ctx context.Context, params *GetUsagePlanKeysI // The GET request to get all the usage plan keys representing the API keys added // to a specified usage plan. type GetUsagePlanKeysInput struct { - Name *string + + // [Required] The Id of the UsagePlan () resource representing the usage plan + // containing the to-be-retrieved UsagePlanKey () resource representing a plan + // customer. + // + // This member is required. + UsagePlanId *string // The maximum number of returned results per page. The default value is 25 and the // maximum value is 500. Limit *int32 + Name *string + // A query parameter specifying the name of the to-be-returned usage plan keys. NameQuery *string - Title *string - // The current pagination position in the paged result set. Position *string - TemplateSkipList []*string + Template *bool - // [Required] The Id of the UsagePlan () resource representing the usage plan - // containing the to-be-retrieved UsagePlanKey () resource representing a plan - // customer. - // - // This member is required. - UsagePlanId *string + TemplateSkipList []*string - Template *bool + Title *string } // Represents the collection of usage plan keys added to usage plans for the diff --git a/service/apigateway/api_op_GetUsagePlans.go b/service/apigateway/api_op_GetUsagePlans.go index c1c4cc4a0b2..db6f3bec49d 100644 --- a/service/apigateway/api_op_GetUsagePlans.go +++ b/service/apigateway/api_op_GetUsagePlans.go @@ -57,23 +57,24 @@ func (c *Client) GetUsagePlans(ctx context.Context, params *GetUsagePlansInput, // The GET request to get all the usage plans of the caller's account. type GetUsagePlansInput struct { - Template *bool - TemplateSkipList []*string + // The identifier of the API key associated with the usage plans. + KeyId *string - Title *string + // The maximum number of returned results per page. The default value is 25 and the + // maximum value is 500. + Limit *int32 + + Name *string // The current pagination position in the paged result set. Position *string - // The identifier of the API key associated with the usage plans. - KeyId *string + Template *bool - Name *string + TemplateSkipList []*string - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. - Limit *int32 + Title *string } // Represents a collection of usage plans for an AWS account. Create and Use Usage diff --git a/service/apigateway/api_op_GetVpcLink.go b/service/apigateway/api_op_GetVpcLink.go index 3ed8a667fa9..93cf015cb24 100644 --- a/service/apigateway/api_op_GetVpcLink.go +++ b/service/apigateway/api_op_GetVpcLink.go @@ -58,7 +58,6 @@ func (c *Client) GetVpcLink(ctx context.Context, params *GetVpcLinkInput, optFns // Gets a specified VPC link under the caller's account in a region. type GetVpcLinkInput struct { - Template *bool // [Required] The identifier of the VpcLink (). It is used in an Integration () to // reference this VpcLink (). @@ -68,6 +67,8 @@ type GetVpcLinkInput struct { Name *string + Template *bool + TemplateSkipList []*string Title *string @@ -83,6 +84,9 @@ type GetVpcLinkInput struct { // connectionId property to identify the VpcLink () used. type GetVpcLinkOutput struct { + // The description of the VPC link. + Description *string + // The identifier of the VpcLink (). It is used in an Integration () to reference // this VpcLink (). Id *string @@ -90,24 +94,21 @@ type GetVpcLinkOutput struct { // The name used to label and identify the VPC link. Name *string - // The description of the VPC link. - Description *string - - // A description about the VPC link status. - StatusMessage *string - - // The ARN of the network load balancer of the VPC targeted by the VPC link. The - // network load balancer must be owned by the same AWS account of the API owner. - TargetArns []*string - // The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, // or FAILED. Deploying an API will wait if the status is PENDING and will fail if // the status is DELETING. Status types.VpcLinkStatus + // A description about the VPC link status. + StatusMessage *string + // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string + // The ARN of the network load balancer of the VPC targeted by the VPC link. The + // network load balancer must be owned by the same AWS account of the API owner. + TargetArns []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_GetVpcLinks.go b/service/apigateway/api_op_GetVpcLinks.go index bcdbc3b4339..9e1dc54ef52 100644 --- a/service/apigateway/api_op_GetVpcLinks.go +++ b/service/apigateway/api_op_GetVpcLinks.go @@ -57,20 +57,21 @@ func (c *Client) GetVpcLinks(ctx context.Context, params *GetVpcLinksInput, optF // Gets the VpcLinks () collection under the caller's account in a selected region. type GetVpcLinksInput struct { - Template *bool - TemplateSkipList []*string + // The maximum number of returned results per page. The default value is 25 and the + // maximum value is 500. + Limit *int32 - Title *string + Name *string // The current pagination position in the paged result set. Position *string - Name *string + Template *bool - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. - Limit *int32 + TemplateSkipList []*string + + Title *string } // The collection of VPC links under the caller's account in a region. Getting diff --git a/service/apigateway/api_op_ImportApiKeys.go b/service/apigateway/api_op_ImportApiKeys.go index 0d47b12a0d5..f6229dc4b53 100644 --- a/service/apigateway/api_op_ImportApiKeys.go +++ b/service/apigateway/api_op_ImportApiKeys.go @@ -59,7 +59,6 @@ func (c *Client) ImportApiKeys(ctx context.Context, params *ImportApiKeysInput, // The POST request to import API keys from an external source, such as a // CSV-formatted file. type ImportApiKeysInput struct { - Name *string // A query parameter to specify the input format to imported API keys. Currently, // only the csv format is supported. @@ -67,14 +66,16 @@ type ImportApiKeysInput struct { // This member is required. Format types.ApiKeysFormat - Template *bool - - TemplateSkipList []*string - // A query parameter to indicate whether to rollback ApiKey () importation (true) // or not (false) when error is encountered. FailOnWarnings *bool + Name *string + + Template *bool + + TemplateSkipList []*string + Title *string } diff --git a/service/apigateway/api_op_ImportDocumentationParts.go b/service/apigateway/api_op_ImportDocumentationParts.go index 66dfa08ec01..41e40565747 100644 --- a/service/apigateway/api_op_ImportDocumentationParts.go +++ b/service/apigateway/api_op_ImportDocumentationParts.go @@ -57,27 +57,28 @@ func (c *Client) ImportDocumentationParts(ctx context.Context, params *ImportDoc // Import documentation parts from an external (e.g., OpenAPI) definition file. type ImportDocumentationPartsInput struct { - Name *string // [Required] The string identifier of the associated RestApi (). // // This member is required. RestApiId *string - Title *string - // A query parameter to specify whether to rollback the documentation importation // (true) or not (false) when a warning is encountered. The default value is false. FailOnWarnings *bool - TemplateSkipList []*string - - Template *bool - // A query parameter to indicate whether to overwrite (OVERWRITE) any existing // DocumentationParts () definition or to merge (MERGE) the new definition into the // existing one. The default value is MERGE. Mode types.PutMode + + Name *string + + Template *bool + + TemplateSkipList []*string + + Title *string } // A collection of the imported DocumentationPart () identifiers. This is used to diff --git a/service/apigateway/api_op_ImportRestApi.go b/service/apigateway/api_op_ImportRestApi.go index 166377e288e..1b8a8c3e22c 100644 --- a/service/apigateway/api_op_ImportRestApi.go +++ b/service/apigateway/api_op_ImportRestApi.go @@ -65,7 +65,7 @@ type ImportRestApiInput struct { // (false) when a warning is encountered. The default value is false. FailOnWarnings *bool - Template *bool + Name *string // A key-value map of context-specific query string parameters specifying the // behavior of different API importing operations. The following shows @@ -83,7 +83,7 @@ type ImportRestApiInput struct { // 'file:///path/to/imported-api-body.json' Parameters map[string]*string - Name *string + Template *bool TemplateSkipList []*string @@ -94,17 +94,6 @@ type ImportRestApiInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) type ImportRestApiOutput struct { - // The API's description. - Description *string - - // A stringified JSON policy document that applies to this RestApi regardless of - // the caller and Method () configuration. - Policy *string - - // The endpoint configuration of this RestApi () showing the endpoint types of the - // API. - EndpointConfiguration *types.EndpointConfiguration - // The source of the API key for metering requests according to a usage plan. Valid // values are: // @@ -115,30 +104,24 @@ type ImportRestApiOutput struct { // a custom authorizer. ApiKeySource types.ApiKeySourceType - // The API's name. - Name *string - - // A version identifier for the API. - Version *string - - // The collection of tags. Each tag element is associated with a given resource. - Tags map[string]*string - - // The warning messages reported when failonwarnings is turned on during API - // import. - Warnings []*string + // The list of binary media types supported by the RestApi (). By default, the + // RestApi () supports only UTF-8-encoded text payloads. + BinaryMediaTypes []*string // The timestamp when the API was created. CreatedDate *time.Time + // The API's description. + Description *string + + // The endpoint configuration of this RestApi () showing the endpoint types of the + // API. + EndpointConfiguration *types.EndpointConfiguration + // The API's identifier. This identifier is unique across all of your APIs in API // Gateway. Id *string - // The list of binary media types supported by the RestApi (). By default, the - // RestApi () supports only UTF-8-encoded text payloads. - BinaryMediaTypes []*string - // A nullable integer that is used to enable compression (with non-negative between // 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null // value) on an API. When compression is enabled, compression or decompression is @@ -146,6 +129,23 @@ type ImportRestApiOutput struct { // Setting it to zero allows compression for any payload size. MinimumCompressionSize *int32 + // The API's name. + Name *string + + // A stringified JSON policy document that applies to this RestApi regardless of + // the caller and Method () configuration. + Policy *string + + // The collection of tags. Each tag element is associated with a given resource. + Tags map[string]*string + + // A version identifier for the API. + Version *string + + // The warning messages reported when failonwarnings is turned on during API + // import. + Warnings []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_PutGatewayResponse.go b/service/apigateway/api_op_PutGatewayResponse.go index 2abfd381a5b..ced5162b038 100644 --- a/service/apigateway/api_op_PutGatewayResponse.go +++ b/service/apigateway/api_op_PutGatewayResponse.go @@ -114,10 +114,6 @@ type PutGatewayResponseInput struct { // This member is required. ResponseType types.GatewayResponseType - TemplateSkipList []*string - - Template *bool - // [Required] The string identifier of the associated RestApi (). // // This member is required. @@ -125,7 +121,9 @@ type PutGatewayResponseInput struct { Name *string - Title *string + // Response parameters (paths, query strings and headers) of the GatewayResponse () + // as a string-to-string map of key-value pairs. + ResponseParameters map[string]*string // Response templates of the GatewayResponse () as a string-to-string map of // key-value pairs. @@ -134,9 +132,11 @@ type PutGatewayResponseInput struct { // The HTTP status code of the GatewayResponse (). StatusCode *string - // Response parameters (paths, query strings and headers) of the GatewayResponse () - // as a string-to-string map of key-value pairs. - ResponseParameters map[string]*string + Template *bool + + TemplateSkipList []*string + + Title *string } // A gateway response of a given response type and status code, with optional @@ -188,6 +188,19 @@ type PutGatewayResponseInput struct { // Gateway Responses type PutGatewayResponseOutput struct { + // A Boolean flag to indicate whether this GatewayResponse () is the default + // gateway response (true) or not (false). A default gateway response is one + // generated by API Gateway without any customization by an API developer. + DefaultResponse *bool + + // Response parameters (paths, query strings and headers) of the GatewayResponse () + // as a string-to-string map of key-value pairs. + ResponseParameters map[string]*string + + // Response templates of the GatewayResponse () as a string-to-string map of + // key-value pairs. + ResponseTemplates map[string]*string + // The response type of the associated GatewayResponse (). Valid values are // // * @@ -238,19 +251,6 @@ type PutGatewayResponseOutput struct { // * UNSUPPORTED_MEDIA_TYPE ResponseType types.GatewayResponseType - // A Boolean flag to indicate whether this GatewayResponse () is the default - // gateway response (true) or not (false). A default gateway response is one - // generated by API Gateway without any customization by an API developer. - DefaultResponse *bool - - // Response parameters (paths, query strings and headers) of the GatewayResponse () - // as a string-to-string map of key-value pairs. - ResponseParameters map[string]*string - - // Response templates of the GatewayResponse () as a string-to-string map of - // key-value pairs. - ResponseTemplates map[string]*string - // The HTTP status code for this GatewayResponse (). StatusCode *string diff --git a/service/apigateway/api_op_PutIntegration.go b/service/apigateway/api_op_PutIntegration.go index f53f2628b04..b1c1b4e0cb8 100644 --- a/service/apigateway/api_op_PutIntegration.go +++ b/service/apigateway/api_op_PutIntegration.go @@ -59,32 +59,48 @@ func (c *Client) PutIntegration(ctx context.Context, params *PutIntegrationInput // Sets up a method's integration. type PutIntegrationInput struct { + // [Required] Specifies a put integration request's HTTP method. + // + // This member is required. + HttpMethod *string + // [Required] Specifies a put integration request's resource ID. // // This member is required. ResourceId *string - Template *bool - - Name *string - // [Required] The string identifier of the associated RestApi (). // // This member is required. RestApiId *string - // [Required] Specifies a put integration request's HTTP method. + // [Required] Specifies a put integration input's type. // // This member is required. - HttpMethod *string + Type types.IntegrationType - TemplateSkipList []*string + // A list of request parameters whose values API Gateway caches. To be valid values + // for cacheKeyParameters, these parameters must also be specified for Method + // ()requestParameters. + CacheKeyParameters []*string - Title *string + // Specifies a group of related cached parameters. By default, API Gateway uses the + // resource ID as the cacheNamespace. You can specify the same cacheNamespace + // across resources to return the same cached data for requests to different + // resources. + CacheNamespace *string - // Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 - // milliseconds or 29 seconds. - TimeoutInMillis *int32 + // The (id + // (https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id)) of + // the VpcLink () used for the integration when connectionType=VPC_LINK and + // undefined, otherwise. + ConnectionId *string + + // The type of the network connection to the integration endpoint. The valid value + // is INTERNET for connections through the public routable internet or VPC_LINK for + // private connections between API Gateway and a network load balancer in a VPC. + // The default value is INTERNET. + ConnectionType types.ConnectionType // Specifies how to handle request payload content type conversions. Supported // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following @@ -102,18 +118,15 @@ type PutIntegrationInput struct { // the passthroughBehavior is configured to support payload pass-through. ContentHandling types.ContentHandlingStrategy - // A key-value map specifying request parameters that are passed from the method - // request to the back end. The key is an integration request parameter name and - // the associated value is a method request parameter value or static value that - // must be enclosed within single quotes and pre-encoded as required by the back - // end. The method request parameter value must match the pattern of - // method.request.{location}.{name}, where location is querystring, path, or header - // and name must be a valid and unique method request parameter name. - RequestParameters map[string]*string - // Specifies whether credentials are required for a put integration. Credentials *string + // Specifies a put integration HTTP method. When the integration type is HTTP or + // AWS, this field is required. + IntegrationHttpMethod *string + + Name *string + // Specifies the pass-through behavior for incoming requests based on the // Content-Type header in the request, and the available mapping templates // specified as the requestTemplates property on the Integration resource. There @@ -132,26 +145,29 @@ type PutIntegrationInput struct { // unmapped content types will be rejected with the same 415 response. PassthroughBehavior *string + // A key-value map specifying request parameters that are passed from the method + // request to the back end. The key is an integration request parameter name and + // the associated value is a method request parameter value or static value that + // must be enclosed within single quotes and pre-encoded as required by the back + // end. The method request parameter value must match the pattern of + // method.request.{location}.{name}, where location is querystring, path, or header + // and name must be a valid and unique method request parameter name. + RequestParameters map[string]*string + // Represents a map of Velocity templates that are applied on the request payload // based on the value of the Content-Type header sent by the client. The content // type value is the key in this map, and the template (as a String) is the value. RequestTemplates map[string]*string - // The (id - // (https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id)) of - // the VpcLink () used for the integration when connectionType=VPC_LINK and - // undefined, otherwise. - ConnectionId *string + Template *bool - // A list of request parameters whose values API Gateway caches. To be valid values - // for cacheKeyParameters, these parameters must also be specified for Method - // ()requestParameters. - CacheKeyParameters []*string + TemplateSkipList []*string - // [Required] Specifies a put integration input's type. - // - // This member is required. - Type types.IntegrationType + // Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 + // milliseconds or 29 seconds. + TimeoutInMillis *int32 + + Title *string TlsConfig *types.TlsConfig @@ -182,10 +198,18 @@ type PutIntegrationInput struct { // arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or // arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key} Uri *string +} - // Specifies a put integration HTTP method. When the integration type is HTTP or - // AWS, this field is required. - IntegrationHttpMethod *string +// Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration. In the API +// Gateway console, the built-in Lambda integration is an AWS integration. Creating +// an API +// (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) +type PutIntegrationOutput struct { + + // A list of request parameters whose values API Gateway caches. To be valid values + // for cacheKeyParameters, these parameters must also be specified for Method + // ()requestParameters. + CacheKeyParameters []*string // Specifies a group of related cached parameters. By default, API Gateway uses the // resource ID as the cacheNamespace. You can specify the same cacheNamespace @@ -193,28 +217,124 @@ type PutIntegrationInput struct { // resources. CacheNamespace *string + // The (id + // (https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id)) of + // the VpcLink () used for the integration when connectionType=VPC_LINK and + // undefined, otherwise. + ConnectionId *string + // The type of the network connection to the integration endpoint. The valid value // is INTERNET for connections through the public routable internet or VPC_LINK for // private connections between API Gateway and a network load balancer in a VPC. // The default value is INTERNET. ConnectionType types.ConnectionType -} -// Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration. In the API -// Gateway console, the built-in Lambda integration is an AWS integration. Creating -// an API -// (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) -type PutIntegrationOutput struct { + // Specifies how to handle request payload content type conversions. Supported + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following + // behaviors: + // + // * CONVERT_TO_BINARY: Converts a request payload from a + // Base64-encoded string to the corresponding binary blob. + // + // * CONVERT_TO_TEXT: + // Converts a request payload from a binary blob to a Base64-encoded string. + // + // If + // this property is not defined, the request payload will be passed through from + // the method request to integration request without modification, provided that + // the passthroughBehavior is configured to support payload pass-through. + ContentHandling types.ContentHandlingStrategy - // Specifies a group of related cached parameters. By default, API Gateway uses the - // resource ID as the cacheNamespace. You can specify the same cacheNamespace - // across resources to return the same cached data for requests to different - // resources. - CacheNamespace *string + // Specifies the credentials required for the integration, if any. For AWS + // integrations, three options are available. To specify an IAM Role for API + // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that + // the caller's identity be passed through from the request, specify the string + // arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS + // services, specify null. + Credentials *string // Specifies the integration's HTTP method type. HttpMethod *string + // Specifies the integration's responses. + // Example: Get integration responses of a + // method + // + // Request + // + // GET + // /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 + // HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com + // X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 + // Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, + // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} + // + // Response + // + // The + // successful response returns 200 OK status and a payload as follows: { "_links": + // { "curies": { "href": + // "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", + // "name": "integrationresponse", "templated": true }, "self": { "href": + // "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", + // "title": "200" }, "integrationresponse:delete": { "href": + // "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" + // }, "integrationresponse:update": { "href": + // "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" + // } }, "responseParameters": { "method.response.header.Content-Type": + // "'application/xml'" }, "responseTemplates": { "application/json": + // "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in + // $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" + // }, "statusCode": "200" }Creating an API + // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) + IntegrationResponses map[string]*types.IntegrationResponse + + // Specifies how the method request body of an unmapped content type will be passed + // through the integration request to the back end without transformation. A + // content type is unmapped if no mapping template is defined in the integration or + // the content type does not match any of the mapped content types, as specified in + // requestTemplates. The valid value is one of the following: + // + // * WHEN_NO_MATCH: + // passes the method request body through the integration request to the back end + // without transformation when the method request content type does not match any + // content type associated with the mapping templates defined in the integration + // request. + // + // * WHEN_NO_TEMPLATES: passes the method request body through the + // integration request to the back end without transformation when no mapping + // template is defined in the integration request. If a template is defined when + // this option is selected, the method request of an unmapped content-type will be + // rejected with an HTTP 415 Unsupported Media Type response. + // + // * NEVER: rejects + // the method request with an HTTP 415 Unsupported Media Type response when either + // the method request content type does not match any content type associated with + // the mapping templates defined in the integration request or no mapping template + // is defined in the integration request. + PassthroughBehavior *string + + // A key-value map specifying request parameters that are passed from the method + // request to the back end. The key is an integration request parameter name and + // the associated value is a method request parameter value or static value that + // must be enclosed within single quotes and pre-encoded as required by the back + // end. The method request parameter value must match the pattern of + // method.request.{location}.{name}, where location is querystring, path, or header + // and name must be a valid and unique method request parameter name. + RequestParameters map[string]*string + + // Represents a map of Velocity templates that are applied on the request payload + // based on the value of the Content-Type header sent by the client. The content + // type value is the key in this map, and the template (as a String) is the value. + RequestTemplates map[string]*string + + // Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 + // milliseconds or 29 seconds. + TimeoutInMillis *int32 + + // Specifies the TLS configuration for an integration. + TlsConfig *types.TlsConfig + // Specifies an API method integration type. The valid value is one of the // following: // @@ -249,10 +369,6 @@ type PutIntegrationOutput struct { // connect API Gateway to a network load balancer of a VPC. Type types.IntegrationType - // Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 - // milliseconds or 29 seconds. - TimeoutInMillis *int32 - // Specifies Uniform Resource Identifier (URI) of the integration endpoint. // // * @@ -281,122 +397,6 @@ type PutIntegrationOutput struct { // arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key} Uri *string - // The type of the network connection to the integration endpoint. The valid value - // is INTERNET for connections through the public routable internet or VPC_LINK for - // private connections between API Gateway and a network load balancer in a VPC. - // The default value is INTERNET. - ConnectionType types.ConnectionType - - // A key-value map specifying request parameters that are passed from the method - // request to the back end. The key is an integration request parameter name and - // the associated value is a method request parameter value or static value that - // must be enclosed within single quotes and pre-encoded as required by the back - // end. The method request parameter value must match the pattern of - // method.request.{location}.{name}, where location is querystring, path, or header - // and name must be a valid and unique method request parameter name. - RequestParameters map[string]*string - - // Represents a map of Velocity templates that are applied on the request payload - // based on the value of the Content-Type header sent by the client. The content - // type value is the key in this map, and the template (as a String) is the value. - RequestTemplates map[string]*string - - // A list of request parameters whose values API Gateway caches. To be valid values - // for cacheKeyParameters, these parameters must also be specified for Method - // ()requestParameters. - CacheKeyParameters []*string - - // The (id - // (https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id)) of - // the VpcLink () used for the integration when connectionType=VPC_LINK and - // undefined, otherwise. - ConnectionId *string - - // Specifies how the method request body of an unmapped content type will be passed - // through the integration request to the back end without transformation. A - // content type is unmapped if no mapping template is defined in the integration or - // the content type does not match any of the mapped content types, as specified in - // requestTemplates. The valid value is one of the following: - // - // * WHEN_NO_MATCH: - // passes the method request body through the integration request to the back end - // without transformation when the method request content type does not match any - // content type associated with the mapping templates defined in the integration - // request. - // - // * WHEN_NO_TEMPLATES: passes the method request body through the - // integration request to the back end without transformation when no mapping - // template is defined in the integration request. If a template is defined when - // this option is selected, the method request of an unmapped content-type will be - // rejected with an HTTP 415 Unsupported Media Type response. - // - // * NEVER: rejects - // the method request with an HTTP 415 Unsupported Media Type response when either - // the method request content type does not match any content type associated with - // the mapping templates defined in the integration request or no mapping template - // is defined in the integration request. - PassthroughBehavior *string - - // Specifies the TLS configuration for an integration. - TlsConfig *types.TlsConfig - - // Specifies the credentials required for the integration, if any. For AWS - // integrations, three options are available. To specify an IAM Role for API - // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that - // the caller's identity be passed through from the request, specify the string - // arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS - // services, specify null. - Credentials *string - - // Specifies how to handle request payload content type conversions. Supported - // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following - // behaviors: - // - // * CONVERT_TO_BINARY: Converts a request payload from a - // Base64-encoded string to the corresponding binary blob. - // - // * CONVERT_TO_TEXT: - // Converts a request payload from a binary blob to a Base64-encoded string. - // - // If - // this property is not defined, the request payload will be passed through from - // the method request to integration request without modification, provided that - // the passthroughBehavior is configured to support payload pass-through. - ContentHandling types.ContentHandlingStrategy - - // Specifies the integration's responses. - // Example: Get integration responses of a - // method - // - // Request - // - // GET - // /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 - // HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com - // X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 - // Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, - // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} - // - // Response - // - // The - // successful response returns 200 OK status and a payload as follows: { "_links": - // { "curies": { "href": - // "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", - // "name": "integrationresponse", "templated": true }, "self": { "href": - // "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", - // "title": "200" }, "integrationresponse:delete": { "href": - // "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" - // }, "integrationresponse:update": { "href": - // "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" - // } }, "responseParameters": { "method.response.header.Content-Type": - // "'application/xml'" }, "responseTemplates": { "application/json": - // "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in - // $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" - // }, "statusCode": "200" }Creating an API - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) - IntegrationResponses map[string]*types.IntegrationResponse - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_PutIntegrationResponse.go b/service/apigateway/api_op_PutIntegrationResponse.go index a48c250a8bb..f73082f21e6 100644 --- a/service/apigateway/api_op_PutIntegrationResponse.go +++ b/service/apigateway/api_op_PutIntegrationResponse.go @@ -59,32 +59,41 @@ func (c *Client) PutIntegrationResponse(ctx context.Context, params *PutIntegrat // Represents a put integration response request. type PutIntegrationResponseInput struct { - // [Required] Specifies the status code that is used to map the integration - // response to an existing MethodResponse (). + // [Required] Specifies a put integration response request's HTTP method. // // This member is required. - StatusCode *string + HttpMethod *string // [Required] Specifies a put integration response request's resource identifier. // // This member is required. ResourceId *string - Template *bool - // [Required] The string identifier of the associated RestApi (). // // This member is required. RestApiId *string - TemplateSkipList []*string - - Title *string - - // [Required] Specifies a put integration response request's HTTP method. + // [Required] Specifies the status code that is used to map the integration + // response to an existing MethodResponse (). // // This member is required. - HttpMethod *string + StatusCode *string + + // Specifies how to handle response payload content type conversions. Supported + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following + // behaviors: + // + // * CONVERT_TO_BINARY: Converts a response payload from a + // Base64-encoded string to the corresponding binary blob. + // + // * CONVERT_TO_TEXT: + // Converts a response payload from a binary blob to a Base64-encoded string. + // + // If + // this property is not defined, the response payload will be passed through from + // the integration response to the method response without modification. + ContentHandling types.ContentHandlingStrategy Name *string @@ -107,6 +116,19 @@ type PutIntegrationResponseInput struct { // Specifies the selection pattern of a put integration response. SelectionPattern *string + Template *bool + + TemplateSkipList []*string + + Title *string +} + +// Represents an integration response. The status code must map to an existing +// MethodResponse (), and parameters and templates can be used to transform the +// back-end response. Creating an API +// (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) +type PutIntegrationResponseOutput struct { + // Specifies how to handle response payload content type conversions. Supported // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following // behaviors: @@ -121,13 +143,6 @@ type PutIntegrationResponseInput struct { // this property is not defined, the response payload will be passed through from // the integration response to the method response without modification. ContentHandling types.ContentHandlingStrategy -} - -// Represents an integration response. The status code must map to an existing -// MethodResponse (), and parameters and templates can be used to transform the -// back-end response. Creating an API -// (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) -type PutIntegrationResponseOutput struct { // A key-value map specifying response parameters that are passed to the method // response from the back end. The key is a method response header parameter name @@ -147,10 +162,6 @@ type PutIntegrationResponseOutput struct { // the key and a template as the value. ResponseTemplates map[string]*string - // Specifies the status code that is used to map the integration response to an - // existing MethodResponse (). - StatusCode *string - // Specifies the regular expression (regex) pattern used to choose an integration // response based on the response from the back end. For example, if the success // response returns nothing and the error response returns some string, you could @@ -160,20 +171,9 @@ type PutIntegrationResponseOutput struct { // For all other HTTP and AWS back ends, the HTTP status code is matched. SelectionPattern *string - // Specifies how to handle response payload content type conversions. Supported - // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following - // behaviors: - // - // * CONVERT_TO_BINARY: Converts a response payload from a - // Base64-encoded string to the corresponding binary blob. - // - // * CONVERT_TO_TEXT: - // Converts a response payload from a binary blob to a Base64-encoded string. - // - // If - // this property is not defined, the response payload will be passed through from - // the integration response to the method response without modification. - ContentHandling types.ContentHandlingStrategy + // Specifies the status code that is used to map the integration response to an + // existing MethodResponse (). + StatusCode *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigateway/api_op_PutMethod.go b/service/apigateway/api_op_PutMethod.go index a0893b998d2..f6a97a7a023 100644 --- a/service/apigateway/api_op_PutMethod.go +++ b/service/apigateway/api_op_PutMethod.go @@ -59,38 +59,30 @@ func (c *Client) PutMethod(ctx context.Context, params *PutMethodInput, optFns . // Request to add a method to an existing Resource () resource. type PutMethodInput struct { - // [Required] The string identifier of the associated RestApi (). + // [Required] The method's authorization type. Valid values are NONE for open + // access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom + // authorizer, or COGNITO_USER_POOLS for using a Cognito user pool. // // This member is required. - RestApiId *string + AuthorizationType *string - Name *string + // [Required] Specifies the method request's HTTP method type. + // + // This member is required. + HttpMethod *string // [Required] The Resource () identifier for the new Method () resource. // // This member is required. ResourceId *string - Template *bool - - // [Required] Specifies the method request's HTTP method type. + // [Required] The string identifier of the associated RestApi (). // // This member is required. - HttpMethod *string - - Title *string - - TemplateSkipList []*string - - // Specifies the Model () resources used for the request's content type. Request - // models are represented as a key/value map, with a content type as the key and a - // Model () name as the value. - RequestModels map[string]*string + RestApiId *string - // A human-friendly operation identifier for the method. For example, you can - // assign the operationName of ListPets for the GET /pets method in the PetStore - // example. - OperationName *string + // Specifies whether the method required a valid ApiKey (). + ApiKeyRequired *bool // A list of authorization scopes configured on the method. The scopes are used // with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The @@ -102,23 +94,22 @@ type PutMethodInput struct { // purposes. AuthorizationScopes []*string - // [Required] The method's authorization type. Valid values are NONE for open - // access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom - // authorizer, or COGNITO_USER_POOLS for using a Cognito user pool. - // - // This member is required. - AuthorizationType *string - - // Specifies whether the method required a valid ApiKey (). - ApiKeyRequired *bool - // Specifies the identifier of an Authorizer () to use on this Method, if the type // is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API // Gateway when you created the authorizer. AuthorizerId *string - // The identifier of a RequestValidator () for validating the method request. - RequestValidatorId *string + Name *string + + // A human-friendly operation identifier for the method. For example, you can + // assign the operationName of ListPets for the GET /pets method in the PetStore + // example. + OperationName *string + + // Specifies the Model () resources used for the request's content type. Request + // models are represented as a key/value map, with a content type as the key and a + // Model () name as the value. + RequestModels map[string]*string // A key-value map defining required or optional method request parameters that can // be accepted by API Gateway. A key defines a method request parameter name @@ -129,6 +120,15 @@ type PutMethodInput struct { // defined here are available in Integration () to be mapped to integration request // parameters or body-mapping templates. RequestParameters map[string]*bool + + // The identifier of a RequestValidator () for validating the method request. + RequestValidatorId *string + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents a client-facing interface by which the client calls the API to access @@ -223,65 +223,32 @@ type PutMethodInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-method-settings.html) type PutMethodOutput struct { - // A key-value map defining required or optional method request parameters that can - // be accepted by API Gateway. A key is a method request parameter name matching - // the pattern of method.request.{location}.{name}, where location is querystring, - // path, or header and name is a valid and unique parameter name. The value - // associated with the key is a Boolean flag indicating whether the parameter is - // required (true) or optional (false). The method request parameter names defined - // here are available in Integration () to be mapped to integration request - // parameters or templates. - RequestParameters map[string]*bool + // A boolean flag specifying whether a valid ApiKey () is required to invoke this + // method. + ApiKeyRequired *bool + + // A list of authorization scopes configured on the method. The scopes are used + // with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The + // authorization works by matching the method scopes against the scopes parsed from + // the access token in the incoming request. The method invocation is authorized if + // any method scopes matches a claimed scope in the access token. Otherwise, the + // invocation is not authorized. When the method scope is configured, the client + // must provide an access token instead of an identity token for authorization + // purposes. + AuthorizationScopes []*string // The method's authorization type. Valid values are NONE for open access, AWS_IAM // for using AWS IAM permissions, CUSTOM for using a custom authorizer, or // COGNITO_USER_POOLS for using a Cognito user pool. AuthorizationType *string - // The method's HTTP verb. - HttpMethod *string - - // Gets a method response associated with a given HTTP status code. The collection - // of method responses are encapsulated in a key-value map, where the key is a - // response's HTTP status code and the value is a MethodResponse () resource that - // specifies the response returned to the caller from the back end through the - // integration response. - // Example: Get a 200 OK response of a GET method - // - // Request - // - // - // GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 - // Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com - // Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 - // Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, - // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} - // - // Response - // - // The - // successful response returns a 200 OK status code and a payload similar to the - // following: { "_links": { "curies": { "href": - // "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", - // "name": "methodresponse", "templated": true }, "self": { "href": - // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": - // "200" }, "methodresponse:delete": { "href": - // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" }, - // "methodresponse:update": { "href": - // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } }, - // "responseModels": { "application/json": "Empty" }, "responseParameters": { - // "method.response.header.operator": false, "method.response.header.operand_2": - // false, "method.response.header.operand_1": false }, "statusCode": "200" }AWS CLI - // (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-method-response.html) - MethodResponses map[string]*types.MethodResponse - - // The identifier of a RequestValidator () for request validation. - RequestValidatorId *string - // The identifier of an Authorizer () to use on this method. The authorizationType // must be CUSTOM. AuthorizerId *string + // The method's HTTP verb. + HttpMethod *string + // Gets the method's integration responsible for passing the client-submitted // request to the back end and performing necessary transformations to make the // request compliant with the back end. @@ -338,30 +305,63 @@ type PutMethodOutput struct { // (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-integration.html) MethodIntegration *types.Integration + // Gets a method response associated with a given HTTP status code. The collection + // of method responses are encapsulated in a key-value map, where the key is a + // response's HTTP status code and the value is a MethodResponse () resource that + // specifies the response returned to the caller from the back end through the + // integration response. + // Example: Get a 200 OK response of a GET method + // + // Request + // + // + // GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 + // Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com + // Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 + // Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, + // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} + // + // Response + // + // The + // successful response returns a 200 OK status code and a payload similar to the + // following: { "_links": { "curies": { "href": + // "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", + // "name": "methodresponse", "templated": true }, "self": { "href": + // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": + // "200" }, "methodresponse:delete": { "href": + // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" }, + // "methodresponse:update": { "href": + // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } }, + // "responseModels": { "application/json": "Empty" }, "responseParameters": { + // "method.response.header.operator": false, "method.response.header.operand_2": + // false, "method.response.header.operand_1": false }, "statusCode": "200" }AWS CLI + // (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-method-response.html) + MethodResponses map[string]*types.MethodResponse + // A human-friendly operation identifier for the method. For example, you can // assign the operationName of ListPets for the GET /pets method in the PetStore // example. OperationName *string - // A boolean flag specifying whether a valid ApiKey () is required to invoke this - // method. - ApiKeyRequired *bool - - // A list of authorization scopes configured on the method. The scopes are used - // with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The - // authorization works by matching the method scopes against the scopes parsed from - // the access token in the incoming request. The method invocation is authorized if - // any method scopes matches a claimed scope in the access token. Otherwise, the - // invocation is not authorized. When the method scope is configured, the client - // must provide an access token instead of an identity token for authorization - // purposes. - AuthorizationScopes []*string - // A key-value map specifying data schemas, represented by Model () resources, (as // the mapped value) of the request payloads of given content types (as the mapping // key). RequestModels map[string]*string + // A key-value map defining required or optional method request parameters that can + // be accepted by API Gateway. A key is a method request parameter name matching + // the pattern of method.request.{location}.{name}, where location is querystring, + // path, or header and name is a valid and unique parameter name. The value + // associated with the key is a Boolean flag indicating whether the parameter is + // required (true) or optional (false). The method request parameter names defined + // here are available in Integration () to be mapped to integration request + // parameters or templates. + RequestParameters map[string]*bool + + // The identifier of a RequestValidator () for request validation. + RequestValidatorId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_PutMethodResponse.go b/service/apigateway/api_op_PutMethodResponse.go index de849feeaf9..15fe7ba1664 100644 --- a/service/apigateway/api_op_PutMethodResponse.go +++ b/service/apigateway/api_op_PutMethodResponse.go @@ -57,33 +57,33 @@ func (c *Client) PutMethodResponse(ctx context.Context, params *PutMethodRespons // Request to add a MethodResponse () to an existing Method () resource. type PutMethodResponseInput struct { - Name *string - // [Required] The string identifier of the associated RestApi (). + // [Required] The HTTP verb of the Method () resource. // // This member is required. - RestApiId *string + HttpMethod *string // [Required] The Resource () identifier for the Method () resource. // // This member is required. ResourceId *string - Template *bool + // [Required] The string identifier of the associated RestApi (). + // + // This member is required. + RestApiId *string // [Required] The method response's status code. // // This member is required. StatusCode *string - Title *string - - TemplateSkipList []*string + Name *string - // [Required] The HTTP verb of the Method () resource. - // - // This member is required. - HttpMethod *string + // Specifies the Model () resources used for the response's content type. Response + // models are represented as a key/value map, with a content type as the key and a + // Model () name as the value. + ResponseModels map[string]*string // A key-value map specifying required or optional response parameters that API // Gateway can send back to the caller. A key defines a method response header name @@ -99,10 +99,11 @@ type PutMethodResponseInput struct { // JSON expression without the $ prefix.) ResponseParameters map[string]*bool - // Specifies the Model () resources used for the response's content type. Response - // models are represented as a key/value map, with a content type as the key and a - // Model () name as the value. - ResponseModels map[string]*string + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents a method response of a given HTTP status code returned to the client. @@ -143,9 +144,6 @@ type PutMethodResponseOutput struct { // Model () name as the value. ResponseModels map[string]*string - // The method response's status code. - StatusCode *string - // A key-value map specifying required or optional response parameters that API // Gateway can send back to the caller. A key defines a method response header and // the value specifies whether the associated method response header is required or @@ -161,6 +159,9 @@ type PutMethodResponseOutput struct { // is a valid JSON expression without the $ prefix.) ResponseParameters map[string]*bool + // The method response's status code. + StatusCode *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_PutRestApi.go b/service/apigateway/api_op_PutRestApi.go index d995f741d29..a925741b5e6 100644 --- a/service/apigateway/api_op_PutRestApi.go +++ b/service/apigateway/api_op_PutRestApi.go @@ -62,7 +62,21 @@ func (c *Client) PutRestApi(ctx context.Context, params *PutRestApiInput, optFns // A PUT request to update an existing API, with external API definitions specified // as the request body. type PutRestApiInput struct { - Title *string + + // [Required] The string identifier of the associated RestApi (). + // + // This member is required. + RestApiId *string + + // A query parameter to indicate whether to rollback the API update (true) or not + // (false) when a warning is encountered. The default value is false. + FailOnWarnings *bool + + // The mode query parameter to specify the update mode. Valid values are "merge" + // and "overwrite". By default, the update mode is "merge". + Mode types.PutMode + + Name *string // Custom header parameters as part of the request. For example, to exclude // DocumentationParts () from an imported API, set ignore=documentation as a @@ -71,41 +85,17 @@ type PutRestApiInput struct { // 'file:///path/to/imported-api-body.json'. Parameters map[string]*string - TemplateSkipList []*string - Template *bool - // The mode query parameter to specify the update mode. Valid values are "merge" - // and "overwrite". By default, the update mode is "merge". - Mode types.PutMode - - // A query parameter to indicate whether to rollback the API update (true) or not - // (false) when a warning is encountered. The default value is false. - FailOnWarnings *bool - - // [Required] The string identifier of the associated RestApi (). - // - // This member is required. - RestApiId *string + TemplateSkipList []*string - Name *string + Title *string } // Represents a REST API. Create an API // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) type PutRestApiOutput struct { - // The API's description. - Description *string - - // A stringified JSON policy document that applies to this RestApi regardless of - // the caller and Method () configuration. - Policy *string - - // The endpoint configuration of this RestApi () showing the endpoint types of the - // API. - EndpointConfiguration *types.EndpointConfiguration - // The source of the API key for metering requests according to a usage plan. Valid // values are: // @@ -116,30 +106,24 @@ type PutRestApiOutput struct { // a custom authorizer. ApiKeySource types.ApiKeySourceType - // The API's name. - Name *string - - // A version identifier for the API. - Version *string - - // The collection of tags. Each tag element is associated with a given resource. - Tags map[string]*string - - // The warning messages reported when failonwarnings is turned on during API - // import. - Warnings []*string + // The list of binary media types supported by the RestApi (). By default, the + // RestApi () supports only UTF-8-encoded text payloads. + BinaryMediaTypes []*string // The timestamp when the API was created. CreatedDate *time.Time + // The API's description. + Description *string + + // The endpoint configuration of this RestApi () showing the endpoint types of the + // API. + EndpointConfiguration *types.EndpointConfiguration + // The API's identifier. This identifier is unique across all of your APIs in API // Gateway. Id *string - // The list of binary media types supported by the RestApi (). By default, the - // RestApi () supports only UTF-8-encoded text payloads. - BinaryMediaTypes []*string - // A nullable integer that is used to enable compression (with non-negative between // 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null // value) on an API. When compression is enabled, compression or decompression is @@ -147,6 +131,23 @@ type PutRestApiOutput struct { // Setting it to zero allows compression for any payload size. MinimumCompressionSize *int32 + // The API's name. + Name *string + + // A stringified JSON policy document that applies to this RestApi regardless of + // the caller and Method () configuration. + Policy *string + + // The collection of tags. Each tag element is associated with a given resource. + Tags map[string]*string + + // A version identifier for the API. + Version *string + + // The warning messages reported when failonwarnings is turned on during API + // import. + Warnings []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_TagResource.go b/service/apigateway/api_op_TagResource.go index 3692246cea6..928eaeb0a74 100644 --- a/service/apigateway/api_op_TagResource.go +++ b/service/apigateway/api_op_TagResource.go @@ -57,25 +57,26 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF // Adds or updates a tag on a given resource. type TagResourceInput struct { - Template *bool - - Title *string - - TemplateSkipList []*string // [Required] The ARN of a resource that can be tagged. // // This member is required. ResourceArn *string - Name *string - // [Required] The key-value map of strings. The valid character set is // [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with // aws:. The tag value can be up to 256 characters. // // This member is required. Tags map[string]*string + + Name *string + + Template *bool + + TemplateSkipList []*string + + Title *string } type TagResourceOutput struct { diff --git a/service/apigateway/api_op_TestInvokeAuthorizer.go b/service/apigateway/api_op_TestInvokeAuthorizer.go index cadc266c5c9..afe8ad595b8 100644 --- a/service/apigateway/api_op_TestInvokeAuthorizer.go +++ b/service/apigateway/api_op_TestInvokeAuthorizer.go @@ -62,68 +62,67 @@ func (c *Client) TestInvokeAuthorizer(ctx context.Context, params *TestInvokeAut // Make a request to simulate the execution of an Authorizer (). type TestInvokeAuthorizerInput struct { + // [Required] Specifies a test invoke authorizer request's Authorizer () ID. + // + // This member is required. + AuthorizerId *string + + // [Required] The string identifier of the associated RestApi (). + // + // This member is required. + RestApiId *string + // [Optional] A key-value map of additional context variables. AdditionalContext map[string]*string - // [Optional] The URI path, including query string, of the simulated invocation - // request. Use this to specify path parameters and query string parameters. - PathWithQueryString *string + // [Optional] The simulated request body of an incoming invocation request. + Body *string // [Required] A key-value map of headers to simulate an incoming invocation // request. This is where the incoming authorization token, or identity source, // should be specified. Headers map[string]*string - // [Optional] The simulated request body of an incoming invocation request. - Body *string - - // A key-value map of stage variables to simulate an invocation on a deployed Stage - // (). - StageVariables map[string]*string - - // [Required] The string identifier of the associated RestApi (). - // - // This member is required. - RestApiId *string - - // [Required] Specifies a test invoke authorizer request's Authorizer () ID. - // - // This member is required. - AuthorizerId *string - // [Optional] The headers as a map from string to list of values to simulate an // incoming invocation request. This is where the incoming authorization token, or // identity source, may be specified. MultiValueHeaders map[string][]*string + + // [Optional] The URI path, including query string, of the simulated invocation + // request. Use this to specify path parameters and query string parameters. + PathWithQueryString *string + + // A key-value map of stage variables to simulate an invocation on a deployed Stage + // (). + StageVariables map[string]*string } // Represents the response of the test invoke request for a custom Authorizer () type TestInvokeAuthorizerOutput struct { - - // The API Gateway execution log for the test authorizer request. - Log *string - Authorization map[string][]*string - // The principal identity returned by the Authorizer () - PrincipalId *string - - // The JSON policy document returned by the Authorizer () - Policy *string - - // The HTTP status code that the client would have received. Value is 0 if the - // authorizer succeeded. - ClientStatus *int32 - // The open identity claims // (https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims), with any // supported custom attributes, returned from the Cognito Your User Pool configured // for the API. Claims map[string]*string + // The HTTP status code that the client would have received. Value is 0 if the + // authorizer succeeded. + ClientStatus *int32 + // The execution latency of the test authorizer request. Latency *int64 + // The API Gateway execution log for the test authorizer request. + Log *string + + // The JSON policy document returned by the Authorizer () + Policy *string + + // The principal identity returned by the Authorizer () + PrincipalId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_TestInvokeMethod.go b/service/apigateway/api_op_TestInvokeMethod.go index 22c3630230d..c80c20021c5 100644 --- a/service/apigateway/api_op_TestInvokeMethod.go +++ b/service/apigateway/api_op_TestInvokeMethod.go @@ -59,23 +59,20 @@ func (c *Client) TestInvokeMethod(ctx context.Context, params *TestInvokeMethodI // Make a request to simulate the execution of a Method (). type TestInvokeMethodInput struct { - // [Required] The string identifier of the associated RestApi (). + // [Required] Specifies a test invoke method request's HTTP method. // // This member is required. - RestApiId *string + HttpMethod *string // [Required] Specifies a test invoke method request's resource ID. // // This member is required. ResourceId *string - // The headers as a map from string to list of values to simulate an incoming - // invocation request. - MultiValueHeaders map[string][]*string - - // A key-value map of stage variables to simulate an invocation on a deployed Stage - // (). - StageVariables map[string]*string + // [Required] The string identifier of the associated RestApi (). + // + // This member is required. + RestApiId *string // The simulated request body of an incoming invocation request. Body *string @@ -85,17 +82,20 @@ type TestInvokeMethodInput struct { // endpoint. ClientCertificateId *string - // [Required] Specifies a test invoke method request's HTTP method. - // - // This member is required. - HttpMethod *string + // A key-value map of headers to simulate an incoming invocation request. + Headers map[string]*string + + // The headers as a map from string to list of values to simulate an incoming + // invocation request. + MultiValueHeaders map[string][]*string // The URI path, including query string, of the simulated invocation request. Use // this to specify path parameters and query string parameters. PathWithQueryString *string - // A key-value map of headers to simulate an incoming invocation request. - Headers map[string]*string + // A key-value map of stage variables to simulate an invocation on a deployed Stage + // (). + StageVariables map[string]*string } // Represents the response of the test invoke request in the HTTP method. Test API @@ -103,23 +103,23 @@ type TestInvokeMethodInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-test-method.html#how-to-test-method-console) type TestInvokeMethodOutput struct { + // The body of the HTTP response. + Body *string + // The headers of the HTTP response. Headers map[string]*string + // The execution latency of the test invoke request. + Latency *int64 + // The API Gateway execution log for the test invoke request. Log *string - // The HTTP status code. - Status *int32 - - // The body of the HTTP response. - Body *string - // The headers of the HTTP response as a map from string to list of values. MultiValueHeaders map[string][]*string - // The execution latency of the test invoke request. - Latency *int64 + // The HTTP status code. + Status *int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigateway/api_op_UntagResource.go b/service/apigateway/api_op_UntagResource.go index 80f64deb050..98d2dfe0015 100644 --- a/service/apigateway/api_op_UntagResource.go +++ b/service/apigateway/api_op_UntagResource.go @@ -57,11 +57,11 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, // Removes a tag from a given resource. type UntagResourceInput struct { - Template *bool - - TemplateSkipList []*string - Title *string + // [Required] The ARN of a resource that can be tagged. + // + // This member is required. + ResourceArn *string // [Required] The Tag keys to delete. // @@ -70,10 +70,11 @@ type UntagResourceInput struct { Name *string - // [Required] The ARN of a resource that can be tagged. - // - // This member is required. - ResourceArn *string + Template *bool + + TemplateSkipList []*string + + Title *string } type UntagResourceOutput struct { diff --git a/service/apigateway/api_op_UpdateAccount.go b/service/apigateway/api_op_UpdateAccount.go index 97d63dc429d..8c965f90bf8 100644 --- a/service/apigateway/api_op_UpdateAccount.go +++ b/service/apigateway/api_op_UpdateAccount.go @@ -58,17 +58,17 @@ func (c *Client) UpdateAccount(ctx context.Context, params *UpdateAccountInput, // Requests API Gateway to change information about the current Account () // resource. type UpdateAccountInput struct { - TemplateSkipList []*string - - Title *string - Name *string - Template *bool - // A list of update operations to be applied to the specified resource and in the // order specified in this list. PatchOperations []*types.PatchOperation + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents an AWS account that is associated with API Gateway. To view the @@ -119,19 +119,19 @@ type UpdateAccountInput struct { // (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-account.html) type UpdateAccountOutput struct { + // The version of the API keys used for the account. + ApiKeyVersion *string + + // The ARN of an Amazon CloudWatch role for the current Account (). + CloudwatchRoleArn *string + // A list of features supported for the account. When usage plans are enabled, the // features list will include an entry of "UsagePlans". Features []*string - // The version of the API keys used for the account. - ApiKeyVersion *string - // Specifies the API request limits configured for the current Account (). ThrottleSettings *types.ThrottleSettings - // The ARN of an Amazon CloudWatch role for the current Account (). - CloudwatchRoleArn *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_UpdateApiKey.go b/service/apigateway/api_op_UpdateApiKey.go index 4abdc74a42b..c5948177917 100644 --- a/service/apigateway/api_op_UpdateApiKey.go +++ b/service/apigateway/api_op_UpdateApiKey.go @@ -59,22 +59,23 @@ func (c *Client) UpdateApiKey(ctx context.Context, params *UpdateApiKeyInput, op // A request to change information about an ApiKey () resource. type UpdateApiKeyInput struct { - Title *string - - Name *string // [Required] The identifier of the ApiKey () resource to be updated. // // This member is required. ApiKey *string - Template *bool - - TemplateSkipList []*string + Name *string // A list of update operations to be applied to the specified resource and in the // order specified in this list. PatchOperations []*types.PatchOperation + + Template *bool + + TemplateSkipList []*string + + Title *string } // A resource that can be distributed to callers for executing Method () resources @@ -84,34 +85,34 @@ type UpdateApiKeyInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-keys.html) type UpdateApiKeyOutput struct { - // The name of the API Key. - Name *string - - // A list of Stage () resources that are associated with the ApiKey () resource. - StageKeys []*string - // The timestamp when the API Key was created. CreatedDate *time.Time - // The identifier of the API Key. - Id *string - // An AWS Marketplace customer identifier , when integrating with the AWS SaaS // Marketplace. CustomerId *string - // The timestamp when the API Key was last updated. - LastUpdatedDate *time.Time + // The description of the API Key. + Description *string // Specifies whether the API Key can be used by callers. Enabled *bool + // The identifier of the API Key. + Id *string + + // The timestamp when the API Key was last updated. + LastUpdatedDate *time.Time + + // The name of the API Key. + Name *string + + // A list of Stage () resources that are associated with the ApiKey () resource. + StageKeys []*string + // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string - // The description of the API Key. - Description *string - // The value of the API Key. Value *string diff --git a/service/apigateway/api_op_UpdateAuthorizer.go b/service/apigateway/api_op_UpdateAuthorizer.go index 1be63aceec7..ca3aff5f918 100644 --- a/service/apigateway/api_op_UpdateAuthorizer.go +++ b/service/apigateway/api_op_UpdateAuthorizer.go @@ -60,27 +60,27 @@ func (c *Client) UpdateAuthorizer(ctx context.Context, params *UpdateAuthorizerI // Request to update an existing Authorizer () resource. type UpdateAuthorizerInput struct { - // [Required] The string identifier of the associated RestApi (). + // [Required] The identifier of the Authorizer () resource. // // This member is required. - RestApiId *string - - Template *bool - - TemplateSkipList []*string - - Name *string + AuthorizerId *string - // [Required] The identifier of the Authorizer () resource. + // [Required] The string identifier of the associated RestApi (). // // This member is required. - AuthorizerId *string + RestApiId *string - Title *string + Name *string // A list of update operations to be applied to the specified resource and in the // order specified in this list. PatchOperations []*types.PatchOperation + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents an authorization layer for methods. If enabled on a method, API @@ -91,8 +91,9 @@ type UpdateAuthorizerInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html) type UpdateAuthorizerOutput struct { - // [Required] The name of the authorizer. - Name *string + // Optional customer-defined field, used in OpenAPI imports and exports without + // functional impact. + AuthType *string // Specifies the required credentials as an IAM role for API Gateway to invoke the // authorizer. To specify an IAM role for API Gateway to assume, use the role's @@ -100,6 +101,27 @@ type UpdateAuthorizerOutput struct { // function, specify null. AuthorizerCredentials *string + // The TTL in seconds of cached authorizer results. If it equals 0, authorization + // caching is disabled. If it is greater than 0, API Gateway will cache authorizer + // responses. If this field is not set, the default value is 300. The maximum value + // is 3600, or 1 hour. + AuthorizerResultTtlInSeconds *int32 + + // Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or + // REQUEST authorizers, this must be a well-formed Lambda function URI, for + // example, + // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. + // In general, the URI has this form + // arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the + // same as the region hosting the Lambda function, path indicates that the + // remaining substring in the URI should be treated as the path to the resource, + // including the initial /. For Lambda functions, this is usually of the form + // /2015-03-31/functions/[FunctionARN]/invocations. + AuthorizerUri *string + + // The identifier for the authorizer resource. + Id *string + // The identity source for which authorization is requested. // // * For a TOKEN or @@ -124,34 +146,6 @@ type UpdateAuthorizerOutput struct { // optional. IdentitySource *string - // The authorizer type. Valid values are TOKEN for a Lambda function using a single - // authorization token submitted in a custom header, REQUEST for a Lambda function - // using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon - // Cognito user pool. - Type types.AuthorizerType - - // Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or - // REQUEST authorizers, this must be a well-formed Lambda function URI, for - // example, - // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. - // In general, the URI has this form - // arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the - // same as the region hosting the Lambda function, path indicates that the - // remaining substring in the URI should be treated as the path to the resource, - // including the initial /. For Lambda functions, this is usually of the form - // /2015-03-31/functions/[FunctionARN]/invocations. - AuthorizerUri *string - - // A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS - // authorizer. Each element is of this format: - // arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN - // or REQUEST authorizer, this is not defined. - ProviderARNs []*string - - // Optional customer-defined field, used in OpenAPI imports and exports without - // functional impact. - AuthType *string - // A validation expression for the incoming identity token. For TOKEN authorizers, // this value is a regular expression. For COGNITO_USER_POOLS authorizers, API // Gateway will match the aud field of the incoming token from the client against @@ -161,14 +155,20 @@ type UpdateAuthorizerOutput struct { // apply to the REQUEST authorizer. IdentityValidationExpression *string - // The TTL in seconds of cached authorizer results. If it equals 0, authorization - // caching is disabled. If it is greater than 0, API Gateway will cache authorizer - // responses. If this field is not set, the default value is 300. The maximum value - // is 3600, or 1 hour. - AuthorizerResultTtlInSeconds *int32 + // [Required] The name of the authorizer. + Name *string - // The identifier for the authorizer resource. - Id *string + // A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS + // authorizer. Each element is of this format: + // arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN + // or REQUEST authorizer, this is not defined. + ProviderARNs []*string + + // The authorizer type. Valid values are TOKEN for a Lambda function using a single + // authorization token submitted in a custom header, REQUEST for a Lambda function + // using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon + // Cognito user pool. + Type types.AuthorizerType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigateway/api_op_UpdateBasePathMapping.go b/service/apigateway/api_op_UpdateBasePathMapping.go index ae3765782ab..5e2a4a64f6f 100644 --- a/service/apigateway/api_op_UpdateBasePathMapping.go +++ b/service/apigateway/api_op_UpdateBasePathMapping.go @@ -65,22 +65,22 @@ type UpdateBasePathMappingInput struct { // This member is required. BasePath *string - TemplateSkipList []*string - - Title *string - // [Required] The domain name of the BasePathMapping () resource to change. // // This member is required. DomainName *string - Template *bool - Name *string // A list of update operations to be applied to the specified resource and in the // order specified in this list. PatchOperations []*types.PatchOperation + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents the base path that callers of the API must provide as part of the URL @@ -90,9 +90,6 @@ type UpdateBasePathMappingInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) type UpdateBasePathMappingOutput struct { - // The name of the associated stage. - Stage *string - // The base path name that callers of the API must provide as part of the URL after // the domain name. BasePath *string @@ -100,6 +97,9 @@ type UpdateBasePathMappingOutput struct { // The string identifier of the associated RestApi (). RestApiId *string + // The name of the associated stage. + Stage *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_UpdateClientCertificate.go b/service/apigateway/api_op_UpdateClientCertificate.go index 961a5d06346..eeeb14a62f6 100644 --- a/service/apigateway/api_op_UpdateClientCertificate.go +++ b/service/apigateway/api_op_UpdateClientCertificate.go @@ -59,7 +59,6 @@ func (c *Client) UpdateClientCertificate(ctx context.Context, params *UpdateClie // A request to change information about an ClientCertificate () resource. type UpdateClientCertificateInput struct { - TemplateSkipList []*string // [Required] The identifier of the ClientCertificate () resource to be updated. // @@ -68,13 +67,15 @@ type UpdateClientCertificateInput struct { Name *string - Title *string - - Template *bool - // A list of update operations to be applied to the specified resource and in the // order specified in this list. PatchOperations []*types.PatchOperation + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents a client certificate used to configure client-side SSL authentication @@ -85,9 +86,18 @@ type UpdateClientCertificateInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html) type UpdateClientCertificateOutput struct { + // The identifier of the client certificate. + ClientCertificateId *string + // The timestamp when the client certificate was created. CreatedDate *time.Time + // The description of the client certificate. + Description *string + + // The timestamp when the client certificate will expire. + ExpirationDate *time.Time + // The PEM-encoded public key of the client certificate, which can be used to // configure certificate authentication in the integration endpoint . PemEncodedCertificate *string @@ -95,15 +105,6 @@ type UpdateClientCertificateOutput struct { // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string - // The timestamp when the client certificate will expire. - ExpirationDate *time.Time - - // The description of the client certificate. - Description *string - - // The identifier of the client certificate. - ClientCertificateId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_UpdateDeployment.go b/service/apigateway/api_op_UpdateDeployment.go index 8e08fea27f1..94b78dfc6e8 100644 --- a/service/apigateway/api_op_UpdateDeployment.go +++ b/service/apigateway/api_op_UpdateDeployment.go @@ -73,15 +73,15 @@ type UpdateDeploymentInput struct { Name *string - Title *string - - TemplateSkipList []*string - - Template *bool - // A list of update operations to be applied to the specified resource and in the // order specified in this list. PatchOperations []*types.PatchOperation + + Template *bool + + TemplateSkipList []*string + + Title *string } // An immutable representation of a RestApi () resource that can be called by users @@ -95,19 +95,19 @@ type UpdateDeploymentInput struct { // AWS SDKs (https://aws.amazon.com/tools/) type UpdateDeploymentOutput struct { - // The date and time that the deployment resource was created. - CreatedDate *time.Time - // A summary of the RestApi () at the date and time that the deployment resource // was created. ApiSummary map[string]map[string]*types.MethodSnapshot - // The identifier for the deployment resource. - Id *string + // The date and time that the deployment resource was created. + CreatedDate *time.Time // The description for the deployment resource. Description *string + // The identifier for the deployment resource. + Id *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_UpdateDocumentationPart.go b/service/apigateway/api_op_UpdateDocumentationPart.go index b8516f9e161..c6d2e946535 100644 --- a/service/apigateway/api_op_UpdateDocumentationPart.go +++ b/service/apigateway/api_op_UpdateDocumentationPart.go @@ -57,27 +57,28 @@ func (c *Client) UpdateDocumentationPart(ctx context.Context, params *UpdateDocu // Updates an existing documentation part of a given API. type UpdateDocumentationPartInput struct { - TemplateSkipList []*string // [Required] The identifier of the to-be-updated documentation part. // // This member is required. DocumentationPartId *string - Title *string - - Name *string - - Template *bool - // [Required] The string identifier of the associated RestApi (). // // This member is required. RestApiId *string + Name *string + // A list of update operations to be applied to the specified resource and in the // order specified in this list. PatchOperations []*types.PatchOperation + + Template *bool + + TemplateSkipList []*string + + Title *string } // A documentation part for a targeted API entity. A documentation part consists of diff --git a/service/apigateway/api_op_UpdateDocumentationVersion.go b/service/apigateway/api_op_UpdateDocumentationVersion.go index a930fa38e95..2a2a611a6e0 100644 --- a/service/apigateway/api_op_UpdateDocumentationVersion.go +++ b/service/apigateway/api_op_UpdateDocumentationVersion.go @@ -58,11 +58,6 @@ func (c *Client) UpdateDocumentationVersion(ctx context.Context, params *UpdateD // Updates an existing documentation version of an API. type UpdateDocumentationVersionInput struct { - TemplateSkipList []*string - - Title *string - - Template *bool // [Required] The version identifier of the to-be-updated documentation version. // @@ -79,6 +74,12 @@ type UpdateDocumentationVersionInput struct { // A list of update operations to be applied to the specified resource and in the // order specified in this list. PatchOperations []*types.PatchOperation + + Template *bool + + TemplateSkipList []*string + + Title *string } // A snapshot of the documentation of an API. Publishing API documentation involves @@ -88,12 +89,12 @@ type UpdateDocumentationVersionInput struct { // DocumentationPart (), DocumentationVersions () type UpdateDocumentationVersionOutput struct { - // The description of the API documentation snapshot. - Description *string - // The date when the API documentation snapshot is created. CreatedDate *time.Time + // The description of the API documentation snapshot. + Description *string + // The version identifier of the API documentation snapshot. Version *string diff --git a/service/apigateway/api_op_UpdateDomainName.go b/service/apigateway/api_op_UpdateDomainName.go index 42e3d5ff6c9..48d3711df38 100644 --- a/service/apigateway/api_op_UpdateDomainName.go +++ b/service/apigateway/api_op_UpdateDomainName.go @@ -59,22 +59,23 @@ func (c *Client) UpdateDomainName(ctx context.Context, params *UpdateDomainNameI // A request to change information about the DomainName () resource. type UpdateDomainNameInput struct { - Name *string - - Title *string - - TemplateSkipList []*string - - Template *bool // [Required] The name of the DomainName () resource to be changed. // // This member is required. DomainName *string + Name *string + // A list of update operations to be applied to the specified resource and in the // order specified in this list. PatchOperations []*types.PatchOperation + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents a custom domain name as a user-friendly host name of an API (RestApi @@ -90,16 +91,26 @@ type UpdateDomainNameInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) type UpdateDomainNameOutput struct { - // The domain name associated with the regional endpoint for this custom domain - // name. You set up this association by adding a DNS record that points the custom - // domain name to this regional domain name. The regional domain name is returned - // by API Gateway when you create a regional endpoint. - RegionalDomainName *string + // The reference to an AWS-managed certificate that will be used by edge-optimized + // endpoint for this domain name. AWS Certificate Manager is the only supported + // source. + CertificateArn *string // The name of the certificate that will be used by edge-optimized endpoint for // this domain name. CertificateName *string + // The timestamp when the certificate that was used by edge-optimized endpoint for + // this domain name was uploaded. + CertificateUploadDate *time.Time + + // The domain name of the Amazon CloudFront distribution associated with this + // custom domain name for an edge-optimized endpoint. You set up this association + // when adding a DNS record pointing the custom domain name to this distribution + // name. For more information about CloudFront distributions, see the Amazon + // CloudFront documentation (https://aws.amazon.com/documentation/cloudfront/). + DistributionDomainName *string + // The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized // endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more // information, see Set up a Regional Custom Domain Name @@ -111,34 +122,33 @@ type UpdateDomainNameOutput struct { // The custom domain name as an API host name, for example, my-api.example.com. DomainName *string - // The Transport Layer Security (TLS) version + cipher suite for this DomainName - // (). The valid values are TLS_1_0 and TLS_1_2. - SecurityPolicy types.SecurityPolicy + // The status of the DomainName () migration. The valid values are AVAILABLE and + // UPDATING. If the status is UPDATING, the domain cannot be modified further until + // the existing operation is complete. If it is AVAILABLE, the domain can be + // updated. + DomainNameStatus types.DomainNameStatus // An optional text message containing detailed information about status of the // DomainName () migration. DomainNameStatusMessage *string + // The endpoint configuration of this DomainName () showing the endpoint types of + // the domain name. + EndpointConfiguration *types.EndpointConfiguration + // The reference to an AWS-managed certificate that will be used for validating the // regional domain name. AWS Certificate Manager is the only supported source. RegionalCertificateArn *string - // The reference to an AWS-managed certificate that will be used by edge-optimized - // endpoint for this domain name. AWS Certificate Manager is the only supported - // source. - CertificateArn *string - - // The timestamp when the certificate that was used by edge-optimized endpoint for - // this domain name was uploaded. - CertificateUploadDate *time.Time - // The name of the certificate that will be used for validating the regional domain // name. RegionalCertificateName *string - // The endpoint configuration of this DomainName () showing the endpoint types of - // the domain name. - EndpointConfiguration *types.EndpointConfiguration + // The domain name associated with the regional endpoint for this custom domain + // name. You set up this association by adding a DNS record that points the custom + // domain name to this regional domain name. The regional domain name is returned + // by API Gateway when you create a regional endpoint. + RegionalDomainName *string // The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For // more information, see Set up a Regional Custom Domain Name @@ -147,22 +157,13 @@ type UpdateDomainNameOutput struct { // (https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region). RegionalHostedZoneId *string - // The domain name of the Amazon CloudFront distribution associated with this - // custom domain name for an edge-optimized endpoint. You set up this association - // when adding a DNS record pointing the custom domain name to this distribution - // name. For more information about CloudFront distributions, see the Amazon - // CloudFront documentation (https://aws.amazon.com/documentation/cloudfront/). - DistributionDomainName *string + // The Transport Layer Security (TLS) version + cipher suite for this DomainName + // (). The valid values are TLS_1_0 and TLS_1_2. + SecurityPolicy types.SecurityPolicy // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string - // The status of the DomainName () migration. The valid values are AVAILABLE and - // UPDATING. If the status is UPDATING, the domain cannot be modified further until - // the existing operation is complete. If it is AVAILABLE, the domain can be - // updated. - DomainNameStatus types.DomainNameStatus - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_UpdateGatewayResponse.go b/service/apigateway/api_op_UpdateGatewayResponse.go index 115af800e15..a927bb520c0 100644 --- a/service/apigateway/api_op_UpdateGatewayResponse.go +++ b/service/apigateway/api_op_UpdateGatewayResponse.go @@ -60,9 +60,6 @@ func (c *Client) UpdateGatewayResponse(ctx context.Context, params *UpdateGatewa // Updates a GatewayResponse () of a specified response type on the given RestApi // (). type UpdateGatewayResponseInput struct { - TemplateSkipList []*string - - Title *string // [Required] The response type of the associated GatewayResponse (). Valid values // are @@ -117,18 +114,22 @@ type UpdateGatewayResponseInput struct { // This member is required. ResponseType types.GatewayResponseType - Name *string - - Template *bool - // [Required] The string identifier of the associated RestApi (). // // This member is required. RestApiId *string + Name *string + // A list of update operations to be applied to the specified resource and in the // order specified in this list. PatchOperations []*types.PatchOperation + + Template *bool + + TemplateSkipList []*string + + Title *string } // A gateway response of a given response type and status code, with optional @@ -180,6 +181,19 @@ type UpdateGatewayResponseInput struct { // Gateway Responses type UpdateGatewayResponseOutput struct { + // A Boolean flag to indicate whether this GatewayResponse () is the default + // gateway response (true) or not (false). A default gateway response is one + // generated by API Gateway without any customization by an API developer. + DefaultResponse *bool + + // Response parameters (paths, query strings and headers) of the GatewayResponse () + // as a string-to-string map of key-value pairs. + ResponseParameters map[string]*string + + // Response templates of the GatewayResponse () as a string-to-string map of + // key-value pairs. + ResponseTemplates map[string]*string + // The response type of the associated GatewayResponse (). Valid values are // // * @@ -230,19 +244,6 @@ type UpdateGatewayResponseOutput struct { // * UNSUPPORTED_MEDIA_TYPE ResponseType types.GatewayResponseType - // A Boolean flag to indicate whether this GatewayResponse () is the default - // gateway response (true) or not (false). A default gateway response is one - // generated by API Gateway without any customization by an API developer. - DefaultResponse *bool - - // Response parameters (paths, query strings and headers) of the GatewayResponse () - // as a string-to-string map of key-value pairs. - ResponseParameters map[string]*string - - // Response templates of the GatewayResponse () as a string-to-string map of - // key-value pairs. - ResponseTemplates map[string]*string - // The HTTP status code for this GatewayResponse (). StatusCode *string diff --git a/service/apigateway/api_op_UpdateIntegration.go b/service/apigateway/api_op_UpdateIntegration.go index 539c03bfe76..b06d2f425f0 100644 --- a/service/apigateway/api_op_UpdateIntegration.go +++ b/service/apigateway/api_op_UpdateIntegration.go @@ -64,27 +64,27 @@ type UpdateIntegrationInput struct { // This member is required. HttpMethod *string - Name *string + // [Required] Represents an update integration request's resource identifier. + // + // This member is required. + ResourceId *string // [Required] The string identifier of the associated RestApi (). // // This member is required. RestApiId *string - Title *string + Name *string - TemplateSkipList []*string + // A list of update operations to be applied to the specified resource and in the + // order specified in this list. + PatchOperations []*types.PatchOperation Template *bool - // [Required] Represents an update integration request's resource identifier. - // - // This member is required. - ResourceId *string + TemplateSkipList []*string - // A list of update operations to be applied to the specified resource and in the - // order specified in this list. - PatchOperations []*types.PatchOperation + Title *string } // Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration. In the API @@ -93,15 +93,135 @@ type UpdateIntegrationInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) type UpdateIntegrationOutput struct { + // A list of request parameters whose values API Gateway caches. To be valid values + // for cacheKeyParameters, these parameters must also be specified for Method + // ()requestParameters. + CacheKeyParameters []*string + // Specifies a group of related cached parameters. By default, API Gateway uses the // resource ID as the cacheNamespace. You can specify the same cacheNamespace // across resources to return the same cached data for requests to different // resources. CacheNamespace *string + // The (id + // (https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id)) of + // the VpcLink () used for the integration when connectionType=VPC_LINK and + // undefined, otherwise. + ConnectionId *string + + // The type of the network connection to the integration endpoint. The valid value + // is INTERNET for connections through the public routable internet or VPC_LINK for + // private connections between API Gateway and a network load balancer in a VPC. + // The default value is INTERNET. + ConnectionType types.ConnectionType + + // Specifies how to handle request payload content type conversions. Supported + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following + // behaviors: + // + // * CONVERT_TO_BINARY: Converts a request payload from a + // Base64-encoded string to the corresponding binary blob. + // + // * CONVERT_TO_TEXT: + // Converts a request payload from a binary blob to a Base64-encoded string. + // + // If + // this property is not defined, the request payload will be passed through from + // the method request to integration request without modification, provided that + // the passthroughBehavior is configured to support payload pass-through. + ContentHandling types.ContentHandlingStrategy + + // Specifies the credentials required for the integration, if any. For AWS + // integrations, three options are available. To specify an IAM Role for API + // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that + // the caller's identity be passed through from the request, specify the string + // arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS + // services, specify null. + Credentials *string + // Specifies the integration's HTTP method type. HttpMethod *string + // Specifies the integration's responses. + // Example: Get integration responses of a + // method + // + // Request + // + // GET + // /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 + // HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com + // X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 + // Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, + // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} + // + // Response + // + // The + // successful response returns 200 OK status and a payload as follows: { "_links": + // { "curies": { "href": + // "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", + // "name": "integrationresponse", "templated": true }, "self": { "href": + // "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", + // "title": "200" }, "integrationresponse:delete": { "href": + // "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" + // }, "integrationresponse:update": { "href": + // "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" + // } }, "responseParameters": { "method.response.header.Content-Type": + // "'application/xml'" }, "responseTemplates": { "application/json": + // "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in + // $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" + // }, "statusCode": "200" }Creating an API + // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) + IntegrationResponses map[string]*types.IntegrationResponse + + // Specifies how the method request body of an unmapped content type will be passed + // through the integration request to the back end without transformation. A + // content type is unmapped if no mapping template is defined in the integration or + // the content type does not match any of the mapped content types, as specified in + // requestTemplates. The valid value is one of the following: + // + // * WHEN_NO_MATCH: + // passes the method request body through the integration request to the back end + // without transformation when the method request content type does not match any + // content type associated with the mapping templates defined in the integration + // request. + // + // * WHEN_NO_TEMPLATES: passes the method request body through the + // integration request to the back end without transformation when no mapping + // template is defined in the integration request. If a template is defined when + // this option is selected, the method request of an unmapped content-type will be + // rejected with an HTTP 415 Unsupported Media Type response. + // + // * NEVER: rejects + // the method request with an HTTP 415 Unsupported Media Type response when either + // the method request content type does not match any content type associated with + // the mapping templates defined in the integration request or no mapping template + // is defined in the integration request. + PassthroughBehavior *string + + // A key-value map specifying request parameters that are passed from the method + // request to the back end. The key is an integration request parameter name and + // the associated value is a method request parameter value or static value that + // must be enclosed within single quotes and pre-encoded as required by the back + // end. The method request parameter value must match the pattern of + // method.request.{location}.{name}, where location is querystring, path, or header + // and name must be a valid and unique method request parameter name. + RequestParameters map[string]*string + + // Represents a map of Velocity templates that are applied on the request payload + // based on the value of the Content-Type header sent by the client. The content + // type value is the key in this map, and the template (as a String) is the value. + RequestTemplates map[string]*string + + // Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 + // milliseconds or 29 seconds. + TimeoutInMillis *int32 + + // Specifies the TLS configuration for an integration. + TlsConfig *types.TlsConfig + // Specifies an API method integration type. The valid value is one of the // following: // @@ -136,10 +256,6 @@ type UpdateIntegrationOutput struct { // connect API Gateway to a network load balancer of a VPC. Type types.IntegrationType - // Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 - // milliseconds or 29 seconds. - TimeoutInMillis *int32 - // Specifies Uniform Resource Identifier (URI) of the integration endpoint. // // * @@ -168,122 +284,6 @@ type UpdateIntegrationOutput struct { // arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key} Uri *string - // The type of the network connection to the integration endpoint. The valid value - // is INTERNET for connections through the public routable internet or VPC_LINK for - // private connections between API Gateway and a network load balancer in a VPC. - // The default value is INTERNET. - ConnectionType types.ConnectionType - - // A key-value map specifying request parameters that are passed from the method - // request to the back end. The key is an integration request parameter name and - // the associated value is a method request parameter value or static value that - // must be enclosed within single quotes and pre-encoded as required by the back - // end. The method request parameter value must match the pattern of - // method.request.{location}.{name}, where location is querystring, path, or header - // and name must be a valid and unique method request parameter name. - RequestParameters map[string]*string - - // Represents a map of Velocity templates that are applied on the request payload - // based on the value of the Content-Type header sent by the client. The content - // type value is the key in this map, and the template (as a String) is the value. - RequestTemplates map[string]*string - - // A list of request parameters whose values API Gateway caches. To be valid values - // for cacheKeyParameters, these parameters must also be specified for Method - // ()requestParameters. - CacheKeyParameters []*string - - // The (id - // (https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id)) of - // the VpcLink () used for the integration when connectionType=VPC_LINK and - // undefined, otherwise. - ConnectionId *string - - // Specifies how the method request body of an unmapped content type will be passed - // through the integration request to the back end without transformation. A - // content type is unmapped if no mapping template is defined in the integration or - // the content type does not match any of the mapped content types, as specified in - // requestTemplates. The valid value is one of the following: - // - // * WHEN_NO_MATCH: - // passes the method request body through the integration request to the back end - // without transformation when the method request content type does not match any - // content type associated with the mapping templates defined in the integration - // request. - // - // * WHEN_NO_TEMPLATES: passes the method request body through the - // integration request to the back end without transformation when no mapping - // template is defined in the integration request. If a template is defined when - // this option is selected, the method request of an unmapped content-type will be - // rejected with an HTTP 415 Unsupported Media Type response. - // - // * NEVER: rejects - // the method request with an HTTP 415 Unsupported Media Type response when either - // the method request content type does not match any content type associated with - // the mapping templates defined in the integration request or no mapping template - // is defined in the integration request. - PassthroughBehavior *string - - // Specifies the TLS configuration for an integration. - TlsConfig *types.TlsConfig - - // Specifies the credentials required for the integration, if any. For AWS - // integrations, three options are available. To specify an IAM Role for API - // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that - // the caller's identity be passed through from the request, specify the string - // arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS - // services, specify null. - Credentials *string - - // Specifies how to handle request payload content type conversions. Supported - // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following - // behaviors: - // - // * CONVERT_TO_BINARY: Converts a request payload from a - // Base64-encoded string to the corresponding binary blob. - // - // * CONVERT_TO_TEXT: - // Converts a request payload from a binary blob to a Base64-encoded string. - // - // If - // this property is not defined, the request payload will be passed through from - // the method request to integration request without modification, provided that - // the passthroughBehavior is configured to support payload pass-through. - ContentHandling types.ContentHandlingStrategy - - // Specifies the integration's responses. - // Example: Get integration responses of a - // method - // - // Request - // - // GET - // /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 - // HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com - // X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 - // Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, - // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} - // - // Response - // - // The - // successful response returns 200 OK status and a payload as follows: { "_links": - // { "curies": { "href": - // "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", - // "name": "integrationresponse", "templated": true }, "self": { "href": - // "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", - // "title": "200" }, "integrationresponse:delete": { "href": - // "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" - // }, "integrationresponse:update": { "href": - // "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" - // } }, "responseParameters": { "method.response.header.Content-Type": - // "'application/xml'" }, "responseTemplates": { "application/json": - // "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in - // $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" - // }, "statusCode": "200" }Creating an API - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) - IntegrationResponses map[string]*types.IntegrationResponse - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_UpdateIntegrationResponse.go b/service/apigateway/api_op_UpdateIntegrationResponse.go index 31458583fb0..f03af9d45b4 100644 --- a/service/apigateway/api_op_UpdateIntegrationResponse.go +++ b/service/apigateway/api_op_UpdateIntegrationResponse.go @@ -58,12 +58,6 @@ func (c *Client) UpdateIntegrationResponse(ctx context.Context, params *UpdateIn // Represents an update integration response request. type UpdateIntegrationResponseInput struct { - Template *bool - - // [Required] Specifies an update integration response request's status code. - // - // This member is required. - StatusCode *string // [Required] Specifies an update integration response request's HTTP method. // @@ -81,15 +75,22 @@ type UpdateIntegrationResponseInput struct { // This member is required. RestApiId *string - Name *string - - Title *string + // [Required] Specifies an update integration response request's status code. + // + // This member is required. + StatusCode *string - TemplateSkipList []*string + Name *string // A list of update operations to be applied to the specified resource and in the // order specified in this list. PatchOperations []*types.PatchOperation + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents an integration response. The status code must map to an existing @@ -98,6 +99,21 @@ type UpdateIntegrationResponseInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) type UpdateIntegrationResponseOutput struct { + // Specifies how to handle response payload content type conversions. Supported + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following + // behaviors: + // + // * CONVERT_TO_BINARY: Converts a response payload from a + // Base64-encoded string to the corresponding binary blob. + // + // * CONVERT_TO_TEXT: + // Converts a response payload from a binary blob to a Base64-encoded string. + // + // If + // this property is not defined, the response payload will be passed through from + // the integration response to the method response without modification. + ContentHandling types.ContentHandlingStrategy + // A key-value map specifying response parameters that are passed to the method // response from the back end. The key is a method response header parameter name // and the mapped value is an integration response header value, a static value @@ -116,10 +132,6 @@ type UpdateIntegrationResponseOutput struct { // the key and a template as the value. ResponseTemplates map[string]*string - // Specifies the status code that is used to map the integration response to an - // existing MethodResponse (). - StatusCode *string - // Specifies the regular expression (regex) pattern used to choose an integration // response based on the response from the back end. For example, if the success // response returns nothing and the error response returns some string, you could @@ -129,20 +141,9 @@ type UpdateIntegrationResponseOutput struct { // For all other HTTP and AWS back ends, the HTTP status code is matched. SelectionPattern *string - // Specifies how to handle response payload content type conversions. Supported - // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following - // behaviors: - // - // * CONVERT_TO_BINARY: Converts a response payload from a - // Base64-encoded string to the corresponding binary blob. - // - // * CONVERT_TO_TEXT: - // Converts a response payload from a binary blob to a Base64-encoded string. - // - // If - // this property is not defined, the response payload will be passed through from - // the integration response to the method response without modification. - ContentHandling types.ContentHandlingStrategy + // Specifies the status code that is used to map the integration response to an + // existing MethodResponse (). + StatusCode *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigateway/api_op_UpdateMethod.go b/service/apigateway/api_op_UpdateMethod.go index 8ff1277c8f5..6f7ef5d407b 100644 --- a/service/apigateway/api_op_UpdateMethod.go +++ b/service/apigateway/api_op_UpdateMethod.go @@ -58,32 +58,33 @@ func (c *Client) UpdateMethod(ctx context.Context, params *UpdateMethodInput, op // Request to update an existing Method () resource. type UpdateMethodInput struct { - TemplateSkipList []*string // [Required] The HTTP verb of the Method () resource. // // This member is required. HttpMethod *string - Title *string - - Name *string - - // [Required] The string identifier of the associated RestApi (). + // [Required] The Resource () identifier for the Method () resource. // // This member is required. - RestApiId *string + ResourceId *string - // [Required] The Resource () identifier for the Method () resource. + // [Required] The string identifier of the associated RestApi (). // // This member is required. - ResourceId *string + RestApiId *string - Template *bool + Name *string // A list of update operations to be applied to the specified resource and in the // order specified in this list. PatchOperations []*types.PatchOperation + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents a client-facing interface by which the client calls the API to access @@ -178,65 +179,32 @@ type UpdateMethodInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-method-settings.html) type UpdateMethodOutput struct { - // A key-value map defining required or optional method request parameters that can - // be accepted by API Gateway. A key is a method request parameter name matching - // the pattern of method.request.{location}.{name}, where location is querystring, - // path, or header and name is a valid and unique parameter name. The value - // associated with the key is a Boolean flag indicating whether the parameter is - // required (true) or optional (false). The method request parameter names defined - // here are available in Integration () to be mapped to integration request - // parameters or templates. - RequestParameters map[string]*bool + // A boolean flag specifying whether a valid ApiKey () is required to invoke this + // method. + ApiKeyRequired *bool + + // A list of authorization scopes configured on the method. The scopes are used + // with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The + // authorization works by matching the method scopes against the scopes parsed from + // the access token in the incoming request. The method invocation is authorized if + // any method scopes matches a claimed scope in the access token. Otherwise, the + // invocation is not authorized. When the method scope is configured, the client + // must provide an access token instead of an identity token for authorization + // purposes. + AuthorizationScopes []*string // The method's authorization type. Valid values are NONE for open access, AWS_IAM // for using AWS IAM permissions, CUSTOM for using a custom authorizer, or // COGNITO_USER_POOLS for using a Cognito user pool. AuthorizationType *string - // The method's HTTP verb. - HttpMethod *string - - // Gets a method response associated with a given HTTP status code. The collection - // of method responses are encapsulated in a key-value map, where the key is a - // response's HTTP status code and the value is a MethodResponse () resource that - // specifies the response returned to the caller from the back end through the - // integration response. - // Example: Get a 200 OK response of a GET method - // - // Request - // - // - // GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 - // Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com - // Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 - // Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, - // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} - // - // Response - // - // The - // successful response returns a 200 OK status code and a payload similar to the - // following: { "_links": { "curies": { "href": - // "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", - // "name": "methodresponse", "templated": true }, "self": { "href": - // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": - // "200" }, "methodresponse:delete": { "href": - // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" }, - // "methodresponse:update": { "href": - // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } }, - // "responseModels": { "application/json": "Empty" }, "responseParameters": { - // "method.response.header.operator": false, "method.response.header.operand_2": - // false, "method.response.header.operand_1": false }, "statusCode": "200" }AWS CLI - // (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-method-response.html) - MethodResponses map[string]*types.MethodResponse - - // The identifier of a RequestValidator () for request validation. - RequestValidatorId *string - // The identifier of an Authorizer () to use on this method. The authorizationType // must be CUSTOM. AuthorizerId *string + // The method's HTTP verb. + HttpMethod *string + // Gets the method's integration responsible for passing the client-submitted // request to the back end and performing necessary transformations to make the // request compliant with the back end. @@ -293,30 +261,63 @@ type UpdateMethodOutput struct { // (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-integration.html) MethodIntegration *types.Integration + // Gets a method response associated with a given HTTP status code. The collection + // of method responses are encapsulated in a key-value map, where the key is a + // response's HTTP status code and the value is a MethodResponse () resource that + // specifies the response returned to the caller from the back end through the + // integration response. + // Example: Get a 200 OK response of a GET method + // + // Request + // + // + // GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 + // Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com + // Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 + // Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, + // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} + // + // Response + // + // The + // successful response returns a 200 OK status code and a payload similar to the + // following: { "_links": { "curies": { "href": + // "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", + // "name": "methodresponse", "templated": true }, "self": { "href": + // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": + // "200" }, "methodresponse:delete": { "href": + // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" }, + // "methodresponse:update": { "href": + // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } }, + // "responseModels": { "application/json": "Empty" }, "responseParameters": { + // "method.response.header.operator": false, "method.response.header.operand_2": + // false, "method.response.header.operand_1": false }, "statusCode": "200" }AWS CLI + // (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-method-response.html) + MethodResponses map[string]*types.MethodResponse + // A human-friendly operation identifier for the method. For example, you can // assign the operationName of ListPets for the GET /pets method in the PetStore // example. OperationName *string - // A boolean flag specifying whether a valid ApiKey () is required to invoke this - // method. - ApiKeyRequired *bool - - // A list of authorization scopes configured on the method. The scopes are used - // with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The - // authorization works by matching the method scopes against the scopes parsed from - // the access token in the incoming request. The method invocation is authorized if - // any method scopes matches a claimed scope in the access token. Otherwise, the - // invocation is not authorized. When the method scope is configured, the client - // must provide an access token instead of an identity token for authorization - // purposes. - AuthorizationScopes []*string - // A key-value map specifying data schemas, represented by Model () resources, (as // the mapped value) of the request payloads of given content types (as the mapping // key). RequestModels map[string]*string + // A key-value map defining required or optional method request parameters that can + // be accepted by API Gateway. A key is a method request parameter name matching + // the pattern of method.request.{location}.{name}, where location is querystring, + // path, or header and name is a valid and unique parameter name. The value + // associated with the key is a Boolean flag indicating whether the parameter is + // required (true) or optional (false). The method request parameter names defined + // here are available in Integration () to be mapped to integration request + // parameters or templates. + RequestParameters map[string]*bool + + // The identifier of a RequestValidator () for request validation. + RequestValidatorId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_UpdateMethodResponse.go b/service/apigateway/api_op_UpdateMethodResponse.go index 7bbe0978532..941eb207d87 100644 --- a/service/apigateway/api_op_UpdateMethodResponse.go +++ b/service/apigateway/api_op_UpdateMethodResponse.go @@ -58,37 +58,38 @@ func (c *Client) UpdateMethodResponse(ctx context.Context, params *UpdateMethodR // A request to update an existing MethodResponse () resource. type UpdateMethodResponseInput struct { - Template *bool - - Title *string - TemplateSkipList []*string + // [Required] The HTTP verb of the Method () resource. + // + // This member is required. + HttpMethod *string // [Required] The Resource () identifier for the MethodResponse () resource. // // This member is required. ResourceId *string - // [Required] The HTTP verb of the Method () resource. + // [Required] The string identifier of the associated RestApi (). // // This member is required. - HttpMethod *string - - Name *string + RestApiId *string // [Required] The status code for the MethodResponse () resource. // // This member is required. StatusCode *string - // [Required] The string identifier of the associated RestApi (). - // - // This member is required. - RestApiId *string + Name *string // A list of update operations to be applied to the specified resource and in the // order specified in this list. PatchOperations []*types.PatchOperation + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents a method response of a given HTTP status code returned to the client. @@ -129,9 +130,6 @@ type UpdateMethodResponseOutput struct { // Model () name as the value. ResponseModels map[string]*string - // The method response's status code. - StatusCode *string - // A key-value map specifying required or optional response parameters that API // Gateway can send back to the caller. A key defines a method response header and // the value specifies whether the associated method response header is required or @@ -147,6 +145,9 @@ type UpdateMethodResponseOutput struct { // is a valid JSON expression without the $ prefix.) ResponseParameters map[string]*bool + // The method response's status code. + StatusCode *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_UpdateModel.go b/service/apigateway/api_op_UpdateModel.go index 10fa94c37ed..520aac8868d 100644 --- a/service/apigateway/api_op_UpdateModel.go +++ b/service/apigateway/api_op_UpdateModel.go @@ -64,22 +64,22 @@ type UpdateModelInput struct { // This member is required. ModelName *string - Title *string - - Name *string - - TemplateSkipList []*string - // [Required] The string identifier of the associated RestApi (). // // This member is required. RestApiId *string - Template *bool + Name *string // A list of update operations to be applied to the specified resource and in the // order specified in this list. PatchOperations []*types.PatchOperation + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents the data structure of a method's request or response payload. A @@ -92,18 +92,18 @@ type UpdateModelInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html) type UpdateModelOutput struct { - // The identifier for the model resource. - Id *string - - // The name of the model. Must be an alphanumeric string. - Name *string - // The content-type for the model. ContentType *string // The description of the model. Description *string + // The identifier for the model resource. + Id *string + + // The name of the model. Must be an alphanumeric string. + Name *string + // The schema for the model. For application/json models, this should be JSON // schema draft 4 (https://tools.ietf.org/html/draft-zyp-json-schema-04) model. Do // not include "\*/" characters in the description of any properties because such diff --git a/service/apigateway/api_op_UpdateRequestValidator.go b/service/apigateway/api_op_UpdateRequestValidator.go index d233625ae93..ef3da708865 100644 --- a/service/apigateway/api_op_UpdateRequestValidator.go +++ b/service/apigateway/api_op_UpdateRequestValidator.go @@ -58,27 +58,28 @@ func (c *Client) UpdateRequestValidator(ctx context.Context, params *UpdateReque // Updates a RequestValidator () of a given RestApi (). type UpdateRequestValidatorInput struct { - Name *string - - TemplateSkipList []*string - // [Required] The string identifier of the associated RestApi (). + // [Required] The identifier of RequestValidator () to be updated. // // This member is required. - RestApiId *string - - Title *string + RequestValidatorId *string - // [Required] The identifier of RequestValidator () to be updated. + // [Required] The string identifier of the associated RestApi (). // // This member is required. - RequestValidatorId *string + RestApiId *string - Template *bool + Name *string // A list of update operations to be applied to the specified resource and in the // order specified in this list. PatchOperations []*types.PatchOperation + + Template *bool + + TemplateSkipList []*string + + Title *string } // A set of validation rules for incoming Method () requests. In OpenAPI, a @@ -94,6 +95,9 @@ type UpdateRequestValidatorOutput struct { // The identifier of this RequestValidator (). Id *string + // The name of this RequestValidator () + Name *string + // A Boolean flag to indicate whether to validate a request body according to the // configured Model () schema. ValidateRequestBody *bool @@ -102,9 +106,6 @@ type UpdateRequestValidatorOutput struct { // (false). ValidateRequestParameters *bool - // The name of this RequestValidator () - Name *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_UpdateResource.go b/service/apigateway/api_op_UpdateResource.go index f7dc23fbda2..e79e42db731 100644 --- a/service/apigateway/api_op_UpdateResource.go +++ b/service/apigateway/api_op_UpdateResource.go @@ -58,11 +58,6 @@ func (c *Client) UpdateResource(ctx context.Context, params *UpdateResourceInput // Request to change information about a Resource () resource. type UpdateResourceInput struct { - TemplateSkipList []*string - - Template *bool - - Title *string // [Required] The identifier of the Resource () resource. // @@ -79,6 +74,12 @@ type UpdateResourceInput struct { // A list of update operations to be applied to the specified resource and in the // order specified in this list. PatchOperations []*types.PatchOperation + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents an API resource. Create an API @@ -88,6 +89,15 @@ type UpdateResourceOutput struct { // The resource's identifier. Id *string + // The parent resource's identifier. + ParentId *string + + // The full path for this resource. + Path *string + + // The last path segment for this resource. + PathPart *string + // Gets an API resource's method of a given HTTP verb. The resource methods are a // map of methods indexed by methods' HTTP verbs enabled on the resource. This // method map is included in the 200 OK response of the GET @@ -169,15 +179,6 @@ type UpdateResourceOutput struct { // OPTIONS. ResourceMethods map[string]*types.Method - // The parent resource's identifier. - ParentId *string - - // The full path for this resource. - Path *string - - // The last path segment for this resource. - PathPart *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_UpdateRestApi.go b/service/apigateway/api_op_UpdateRestApi.go index 442d92e5d69..d166665e382 100644 --- a/service/apigateway/api_op_UpdateRestApi.go +++ b/service/apigateway/api_op_UpdateRestApi.go @@ -59,39 +59,29 @@ func (c *Client) UpdateRestApi(ctx context.Context, params *UpdateRestApiInput, // Request to update an existing RestApi () resource in your collection. type UpdateRestApiInput struct { - Title *string - - TemplateSkipList []*string - - Name *string - - Template *bool // [Required] The string identifier of the associated RestApi (). // // This member is required. RestApiId *string + Name *string + // A list of update operations to be applied to the specified resource and in the // order specified in this list. PatchOperations []*types.PatchOperation + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents a REST API. Create an API // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) type UpdateRestApiOutput struct { - // The API's description. - Description *string - - // A stringified JSON policy document that applies to this RestApi regardless of - // the caller and Method () configuration. - Policy *string - - // The endpoint configuration of this RestApi () showing the endpoint types of the - // API. - EndpointConfiguration *types.EndpointConfiguration - // The source of the API key for metering requests according to a usage plan. Valid // values are: // @@ -102,30 +92,24 @@ type UpdateRestApiOutput struct { // a custom authorizer. ApiKeySource types.ApiKeySourceType - // The API's name. - Name *string - - // A version identifier for the API. - Version *string - - // The collection of tags. Each tag element is associated with a given resource. - Tags map[string]*string - - // The warning messages reported when failonwarnings is turned on during API - // import. - Warnings []*string + // The list of binary media types supported by the RestApi (). By default, the + // RestApi () supports only UTF-8-encoded text payloads. + BinaryMediaTypes []*string // The timestamp when the API was created. CreatedDate *time.Time + // The API's description. + Description *string + + // The endpoint configuration of this RestApi () showing the endpoint types of the + // API. + EndpointConfiguration *types.EndpointConfiguration + // The API's identifier. This identifier is unique across all of your APIs in API // Gateway. Id *string - // The list of binary media types supported by the RestApi (). By default, the - // RestApi () supports only UTF-8-encoded text payloads. - BinaryMediaTypes []*string - // A nullable integer that is used to enable compression (with non-negative between // 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null // value) on an API. When compression is enabled, compression or decompression is @@ -133,6 +117,23 @@ type UpdateRestApiOutput struct { // Setting it to zero allows compression for any payload size. MinimumCompressionSize *int32 + // The API's name. + Name *string + + // A stringified JSON policy document that applies to this RestApi regardless of + // the caller and Method () configuration. + Policy *string + + // The collection of tags. Each tag element is associated with a given resource. + Tags map[string]*string + + // A version identifier for the API. + Version *string + + // The warning messages reported when failonwarnings is turned on during API + // import. + Warnings []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_UpdateStage.go b/service/apigateway/api_op_UpdateStage.go index f6ecf987ec8..4eae2d45f68 100644 --- a/service/apigateway/api_op_UpdateStage.go +++ b/service/apigateway/api_op_UpdateStage.go @@ -59,27 +59,28 @@ func (c *Client) UpdateStage(ctx context.Context, params *UpdateStageInput, optF // Requests API Gateway to change information about a Stage () resource. type UpdateStageInput struct { - Title *string - - TemplateSkipList []*string - Name *string + // [Required] The string identifier of the associated RestApi (). + // + // This member is required. + RestApiId *string // [Required] The name of the Stage () resource to change information about. // // This member is required. StageName *string - Template *bool - - // [Required] The string identifier of the associated RestApi (). - // - // This member is required. - RestApiId *string + Name *string // A list of update operations to be applied to the specified resource and in the // order specified in this list. PatchOperations []*types.PatchOperation + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents a unique identifier for a version of a deployed RestApi () that is @@ -87,43 +88,32 @@ type UpdateStageInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api.html) type UpdateStageOutput struct { - // The identifier of the Deployment () that the stage points to. - DeploymentId *string - - // The stage's description. - Description *string + // Settings for logging access in this stage. + AccessLogSettings *types.AccessLogSettings - // The name of the stage is the first path segment in the Uniform Resource - // Identifier (URI) of a call to API Gateway. Stage names can only contain - // alphanumeric characters, hyphens, and underscores. Maximum length is 128 - // characters. - StageName *string + // Specifies whether a cache cluster is enabled for the stage. + CacheClusterEnabled *bool - // The collection of tags. Each tag element is associated with a given resource. - Tags map[string]*string + // The size of the cache cluster for the stage, if enabled. + CacheClusterSize types.CacheClusterSize // The status of the cache cluster for the stage, if enabled. CacheClusterStatus types.CacheClusterStatus - // The identifier of a client certificate for an API stage. - ClientCertificateId *string - - // Specifies whether a cache cluster is enabled for the stage. - CacheClusterEnabled *bool - // Settings for the canary deployment in this stage. CanarySettings *types.CanarySettings - // A map that defines the stage variables for a Stage () resource. Variable names - // can have alphanumeric and underscore characters, and the values must match - // [A-Za-z0-9-._~:/?#&=,]+. - Variables map[string]*string + // The identifier of a client certificate for an API stage. + ClientCertificateId *string - // The size of the cache cluster for the stage, if enabled. - CacheClusterSize types.CacheClusterSize + // The timestamp when the stage was created. + CreatedDate *time.Time - // Settings for logging access in this stage. - AccessLogSettings *types.AccessLogSettings + // The identifier of the Deployment () that the stage points to. + DeploymentId *string + + // The stage's description. + Description *string // The version of the associated API documentation. DocumentationVersion *string @@ -131,21 +121,32 @@ type UpdateStageOutput struct { // The timestamp when the stage last updated. LastUpdatedDate *time.Time - // The timestamp when the stage was created. - CreatedDate *time.Time + // A map that defines the method settings for a Stage () resource. Keys (designated + // as /{method_setting_key below) are method paths defined as + // {resource_path}/{http_method} for an individual method override, or /\*/\* for + // overriding all methods in the stage. + MethodSettings map[string]*types.MethodSetting + + // The name of the stage is the first path segment in the Uniform Resource + // Identifier (URI) of a call to API Gateway. Stage names can only contain + // alphanumeric characters, hyphens, and underscores. Maximum length is 128 + // characters. + StageName *string + + // The collection of tags. Each tag element is associated with a given resource. + Tags map[string]*string // Specifies whether active tracing with X-ray is enabled for the Stage (). TracingEnabled *bool + // A map that defines the stage variables for a Stage () resource. Variable names + // can have alphanumeric and underscore characters, and the values must match + // [A-Za-z0-9-._~:/?#&=,]+. + Variables map[string]*string + // The ARN of the WebAcl associated with the Stage (). WebAclArn *string - // A map that defines the method settings for a Stage () resource. Keys (designated - // as /{method_setting_key below) are method paths defined as - // {resource_path}/{http_method} for an individual method override, or /\*/\* for - // overriding all methods in the stage. - MethodSettings map[string]*types.MethodSetting - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_UpdateUsage.go b/service/apigateway/api_op_UpdateUsage.go index c498ebfd061..c3580a80ce7 100644 --- a/service/apigateway/api_op_UpdateUsage.go +++ b/service/apigateway/api_op_UpdateUsage.go @@ -61,28 +61,28 @@ func (c *Client) UpdateUsage(ctx context.Context, params *UpdateUsageInput, optF // usage plan associated with a specified API key. type UpdateUsageInput struct { - // [Required] The Id of the usage plan associated with the usage data. - // - // This member is required. - UsagePlanId *string - - TemplateSkipList []*string - - Title *string - // [Required] The identifier of the API key associated with the usage plan in which // a temporary extension is granted to the remaining quota. // // This member is required. KeyId *string - Name *string + // [Required] The Id of the usage plan associated with the usage data. + // + // This member is required. + UsagePlanId *string - Template *bool + Name *string // A list of update operations to be applied to the specified resource and in the // order specified in this list. PatchOperations []*types.PatchOperation + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents the usage data of a usage plan. Create and Use Usage Plans @@ -94,12 +94,6 @@ type UpdateUsageOutput struct { // The ending date of the usage data. EndDate *string - // The plan Id associated with this usage data. - UsagePlanId *string - - // The starting date of the usage data. - StartDate *string - // The usage data, as daily logs of used and remaining quotas, over the specified // time interval indexed over the API keys in a usage plan. For example, {..., // "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} @@ -110,6 +104,12 @@ type UpdateUsageOutput struct { // The current pagination position in the paged result set. Position *string + // The starting date of the usage data. + StartDate *string + + // The plan Id associated with this usage data. + UsagePlanId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/api_op_UpdateUsagePlan.go b/service/apigateway/api_op_UpdateUsagePlan.go index 86cb95a0c5b..fc24b67ffd4 100644 --- a/service/apigateway/api_op_UpdateUsagePlan.go +++ b/service/apigateway/api_op_UpdateUsagePlan.go @@ -64,17 +64,17 @@ type UpdateUsagePlanInput struct { // This member is required. UsagePlanId *string - Title *string - - TemplateSkipList []*string - Name *string - Template *bool - // A list of update operations to be applied to the specified resource and in the // order specified in this list. PatchOperations []*types.PatchOperation + + Template *bool + + TemplateSkipList []*string + + Title *string } // Represents a usage plan than can specify who can assess associated API stages @@ -84,18 +84,18 @@ type UpdateUsagePlanInput struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) type UpdateUsagePlanOutput struct { + // The associated API stages of a usage plan. + ApiStages []*types.ApiStage + + // The description of a usage plan. + Description *string + // The identifier of a UsagePlan () resource. Id *string - // The request throttle limits of a usage plan. - Throttle *types.ThrottleSettings - // The name of a usage plan. Name *string - // The associated API stages of a usage plan. - ApiStages []*types.ApiStage - // The AWS Markeplace product identifier to associate with the usage plan as a SaaS // product on AWS Marketplace. ProductCode *string @@ -106,8 +106,8 @@ type UpdateUsagePlanOutput struct { // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string - // The description of a usage plan. - Description *string + // The request throttle limits of a usage plan. + Throttle *types.ThrottleSettings // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigateway/api_op_UpdateVpcLink.go b/service/apigateway/api_op_UpdateVpcLink.go index 948ae0dacee..5027fd2b68b 100644 --- a/service/apigateway/api_op_UpdateVpcLink.go +++ b/service/apigateway/api_op_UpdateVpcLink.go @@ -58,7 +58,6 @@ func (c *Client) UpdateVpcLink(ctx context.Context, params *UpdateVpcLinkInput, // Updates an existing VpcLink () of a specified identifier. type UpdateVpcLinkInput struct { - Template *bool // [Required] The identifier of the VpcLink (). It is used in an Integration () to // reference this VpcLink (). @@ -66,15 +65,17 @@ type UpdateVpcLinkInput struct { // This member is required. VpcLinkId *string - Title *string - Name *string - TemplateSkipList []*string - // A list of update operations to be applied to the specified resource and in the // order specified in this list. PatchOperations []*types.PatchOperation + + Template *bool + + TemplateSkipList []*string + + Title *string } // An API Gateway VPC link for a RestApi () to access resources in an Amazon @@ -87,6 +88,9 @@ type UpdateVpcLinkInput struct { // connectionId property to identify the VpcLink () used. type UpdateVpcLinkOutput struct { + // The description of the VPC link. + Description *string + // The identifier of the VpcLink (). It is used in an Integration () to reference // this VpcLink (). Id *string @@ -94,24 +98,21 @@ type UpdateVpcLinkOutput struct { // The name used to label and identify the VPC link. Name *string - // The description of the VPC link. - Description *string - - // A description about the VPC link status. - StatusMessage *string - - // The ARN of the network load balancer of the VPC targeted by the VPC link. The - // network load balancer must be owned by the same AWS account of the API owner. - TargetArns []*string - // The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, // or FAILED. Deploying an API will wait if the status is PENDING and will fail if // the status is DELETING. Status types.VpcLinkStatus + // A description about the VPC link status. + StatusMessage *string + // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string + // The ARN of the network load balancer of the VPC targeted by the VPC link. The + // network load balancer must be owned by the same AWS account of the API owner. + TargetArns []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigateway/go.mod b/service/apigateway/go.mod index 90dc5d938a2..365f5dd95f8 100644 --- a/service/apigateway/go.mod +++ b/service/apigateway/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/apigateway go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/apigateway/types/types.go b/service/apigateway/types/types.go index 02565d7088c..523509f0248 100644 --- a/service/apigateway/types/types.go +++ b/service/apigateway/types/types.go @@ -10,16 +10,16 @@ import ( // ARN. type AccessLogSettings struct { + // The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data + // Firehose delivery stream to receive access logs. If you specify a Kinesis Data + // Firehose delivery stream, the stream name must begin with amazon-apigateway-. + DestinationArn *string + // A single line format of the access logs of data, as specified by selected // $context variables // (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). // The format must include at least $context.requestId. Format *string - - // The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data - // Firehose delivery stream to receive access logs. If you specify a Kinesis Data - // Firehose delivery stream, the stream name must begin with amazon-apigateway-. - DestinationArn *string } // A resource that can be distributed to callers for executing Method () resources @@ -29,34 +29,34 @@ type AccessLogSettings struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-keys.html) type ApiKey struct { - // The name of the API Key. - Name *string - - // A list of Stage () resources that are associated with the ApiKey () resource. - StageKeys []*string - // The timestamp when the API Key was created. CreatedDate *time.Time - // The identifier of the API Key. - Id *string - // An AWS Marketplace customer identifier , when integrating with the AWS SaaS // Marketplace. CustomerId *string - // The timestamp when the API Key was last updated. - LastUpdatedDate *time.Time + // The description of the API Key. + Description *string // Specifies whether the API Key can be used by callers. Enabled *bool + // The identifier of the API Key. + Id *string + + // The timestamp when the API Key was last updated. + LastUpdatedDate *time.Time + + // The name of the API Key. + Name *string + + // A list of Stage () resources that are associated with the ApiKey () resource. + StageKeys []*string + // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string - // The description of the API Key. - Description *string - // The value of the API Key. Value *string } @@ -64,15 +64,15 @@ type ApiKey struct { // API stage name of the associated API stage in a usage plan. type ApiStage struct { + // API Id of the associated API stage in a usage plan. + ApiId *string + // API stage name of the associated API stage in a usage plan. Stage *string // Map containing method level throttling information for API stage in a usage // plan. Throttle map[string]*ThrottleSettings - - // API Id of the associated API stage in a usage plan. - ApiId *string } // Represents an authorization layer for methods. If enabled on a method, API @@ -83,8 +83,9 @@ type ApiStage struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html) type Authorizer struct { - // [Required] The name of the authorizer. - Name *string + // Optional customer-defined field, used in OpenAPI imports and exports without + // functional impact. + AuthType *string // Specifies the required credentials as an IAM role for API Gateway to invoke the // authorizer. To specify an IAM role for API Gateway to assume, use the role's @@ -92,6 +93,27 @@ type Authorizer struct { // function, specify null. AuthorizerCredentials *string + // The TTL in seconds of cached authorizer results. If it equals 0, authorization + // caching is disabled. If it is greater than 0, API Gateway will cache authorizer + // responses. If this field is not set, the default value is 300. The maximum value + // is 3600, or 1 hour. + AuthorizerResultTtlInSeconds *int32 + + // Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or + // REQUEST authorizers, this must be a well-formed Lambda function URI, for + // example, + // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. + // In general, the URI has this form + // arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the + // same as the region hosting the Lambda function, path indicates that the + // remaining substring in the URI should be treated as the path to the resource, + // including the initial /. For Lambda functions, this is usually of the form + // /2015-03-31/functions/[FunctionARN]/invocations. + AuthorizerUri *string + + // The identifier for the authorizer resource. + Id *string + // The identity source for which authorization is requested. // // * For a TOKEN or @@ -116,34 +138,6 @@ type Authorizer struct { // optional. IdentitySource *string - // The authorizer type. Valid values are TOKEN for a Lambda function using a single - // authorization token submitted in a custom header, REQUEST for a Lambda function - // using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon - // Cognito user pool. - Type AuthorizerType - - // Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or - // REQUEST authorizers, this must be a well-formed Lambda function URI, for - // example, - // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. - // In general, the URI has this form - // arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the - // same as the region hosting the Lambda function, path indicates that the - // remaining substring in the URI should be treated as the path to the resource, - // including the initial /. For Lambda functions, this is usually of the form - // /2015-03-31/functions/[FunctionARN]/invocations. - AuthorizerUri *string - - // A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS - // authorizer. Each element is of this format: - // arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN - // or REQUEST authorizer, this is not defined. - ProviderARNs []*string - - // Optional customer-defined field, used in OpenAPI imports and exports without - // functional impact. - AuthType *string - // A validation expression for the incoming identity token. For TOKEN authorizers, // this value is a regular expression. For COGNITO_USER_POOLS authorizers, API // Gateway will match the aud field of the incoming token from the client against @@ -153,14 +147,20 @@ type Authorizer struct { // apply to the REQUEST authorizer. IdentityValidationExpression *string - // The TTL in seconds of cached authorizer results. If it equals 0, authorization - // caching is disabled. If it is greater than 0, API Gateway will cache authorizer - // responses. If this field is not set, the default value is 300. The maximum value - // is 3600, or 1 hour. - AuthorizerResultTtlInSeconds *int32 + // [Required] The name of the authorizer. + Name *string - // The identifier for the authorizer resource. - Id *string + // A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS + // authorizer. Each element is of this format: + // arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN + // or REQUEST authorizer, this is not defined. + ProviderARNs []*string + + // The authorizer type. Valid values are TOKEN for a Lambda function using a single + // authorization token submitted in a custom header, REQUEST for a Lambda function + // using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon + // Cognito user pool. + Type AuthorizerType } // Represents the base path that callers of the API must provide as part of the URL @@ -170,20 +170,26 @@ type Authorizer struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) type BasePathMapping struct { - // The name of the associated stage. - Stage *string - // The base path name that callers of the API must provide as part of the URL after // the domain name. BasePath *string // The string identifier of the associated RestApi (). RestApiId *string + + // The name of the associated stage. + Stage *string } // Configuration settings of a canary deployment. type CanarySettings struct { + // The ID of the canary deployment. + DeploymentId *string + + // The percent (0-100) of traffic diverted to a canary deployment. + PercentTraffic *float64 + // Stage variables overridden for a canary release deployment, including new stage // variables introduced in the canary. These stage variables are represented as a // string-to-string map between stage variable names and their values. @@ -192,12 +198,6 @@ type CanarySettings struct { // A Boolean flag to indicate whether the canary deployment uses the stage cache or // not. UseStageCache *bool - - // The percent (0-100) of traffic diverted to a canary deployment. - PercentTraffic *float64 - - // The ID of the canary deployment. - DeploymentId *string } // Represents a client certificate used to configure client-side SSL authentication @@ -208,24 +208,24 @@ type CanarySettings struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html) type ClientCertificate struct { + // The identifier of the client certificate. + ClientCertificateId *string + // The timestamp when the client certificate was created. CreatedDate *time.Time + // The description of the client certificate. + Description *string + + // The timestamp when the client certificate will expire. + ExpirationDate *time.Time + // The PEM-encoded public key of the client certificate, which can be used to // configure certificate authentication in the integration endpoint . PemEncodedCertificate *string // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string - - // The timestamp when the client certificate will expire. - ExpirationDate *time.Time - - // The description of the client certificate. - Description *string - - // The identifier of the client certificate. - ClientCertificateId *string } // An immutable representation of a RestApi () resource that can be called by users @@ -239,23 +239,26 @@ type ClientCertificate struct { // AWS SDKs (https://aws.amazon.com/tools/) type Deployment struct { - // The date and time that the deployment resource was created. - CreatedDate *time.Time - // A summary of the RestApi () at the date and time that the deployment resource // was created. ApiSummary map[string]map[string]*MethodSnapshot - // The identifier for the deployment resource. - Id *string + // The date and time that the deployment resource was created. + CreatedDate *time.Time // The description for the deployment resource. Description *string + + // The identifier for the deployment resource. + Id *string } // The input configuration for a canary deployment. type DeploymentCanarySettings struct { + // The percentage (0.0-100.0) of traffic routed to the canary deployment. + PercentTraffic *float64 + // A stage variable overrides used for the canary release deployment. They can // override existing stage variables or add new stage variables for the canary // release deployment. These stage variables are represented as a string-to-string @@ -265,9 +268,6 @@ type DeploymentCanarySettings struct { // A Boolean flag to indicate whether the canary release deployment uses the stage // cache or not. UseStageCache *bool - - // The percentage (0.0-100.0) of traffic routed to the canary deployment. - PercentTraffic *float64 } // A documentation part for a targeted API entity. A documentation part consists of @@ -307,15 +307,6 @@ type DocumentationPart struct { // Specifies the target API entity to which the documentation applies. type DocumentationPartLocation struct { - // The URL path of the target. It is a valid field for the API entity types of - // RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, - // RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is / for the - // root resource. When an applicable child entity inherits the content of another - // entity of the same type with more general specifications of the other location - // attributes, the child entity's path attribute must match that of the parent - // entity as a prefix. - Path *string - // [Required] The type of API entity to which the documentation content applies. // Valid values are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, // QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and @@ -325,20 +316,6 @@ type DocumentationPartLocation struct { // This member is required. Type DocumentationPartType - // The HTTP status code of a response. It is a valid field for the API entity types - // of RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any - // status code. When an applicable child entity inherits the content of an entity - // of the same type with more general specifications of the other location - // attributes, the child entity's statusCode attribute must match that of the - // parent entity exactly. - StatusCode *string - - // The name of the targeted API entity. It is a valid and required field for the - // API entity types of AUTHORIZER, MODEL, PATH_PARAMETER, QUERY_PARAMETER, - // REQUEST_HEADER, REQUEST_BODY and RESPONSE_HEADER. It is an invalid field for any - // other entity type. - Name *string - // The HTTP verb of a method. It is a valid field for the API entity types of // METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, // RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any method. When @@ -346,6 +323,29 @@ type DocumentationPartLocation struct { // with more general specifications of the other location attributes, the child // entity's method attribute must match that of the parent entity exactly. Method *string + + // The name of the targeted API entity. It is a valid and required field for the + // API entity types of AUTHORIZER, MODEL, PATH_PARAMETER, QUERY_PARAMETER, + // REQUEST_HEADER, REQUEST_BODY and RESPONSE_HEADER. It is an invalid field for any + // other entity type. + Name *string + + // The URL path of the target. It is a valid field for the API entity types of + // RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, + // RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is / for the + // root resource. When an applicable child entity inherits the content of another + // entity of the same type with more general specifications of the other location + // attributes, the child entity's path attribute must match that of the parent + // entity as a prefix. + Path *string + + // The HTTP status code of a response. It is a valid field for the API entity types + // of RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any + // status code. When an applicable child entity inherits the content of an entity + // of the same type with more general specifications of the other location + // attributes, the child entity's statusCode attribute must match that of the + // parent entity exactly. + StatusCode *string } // A snapshot of the documentation of an API. Publishing API documentation involves @@ -355,12 +355,12 @@ type DocumentationPartLocation struct { // DocumentationPart (), DocumentationVersions () type DocumentationVersion struct { - // The description of the API documentation snapshot. - Description *string - // The date when the API documentation snapshot is created. CreatedDate *time.Time + // The description of the API documentation snapshot. + Description *string + // The version identifier of the API documentation snapshot. Version *string } @@ -378,16 +378,26 @@ type DocumentationVersion struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) type DomainName struct { - // The domain name associated with the regional endpoint for this custom domain - // name. You set up this association by adding a DNS record that points the custom - // domain name to this regional domain name. The regional domain name is returned - // by API Gateway when you create a regional endpoint. - RegionalDomainName *string + // The reference to an AWS-managed certificate that will be used by edge-optimized + // endpoint for this domain name. AWS Certificate Manager is the only supported + // source. + CertificateArn *string // The name of the certificate that will be used by edge-optimized endpoint for // this domain name. CertificateName *string + // The timestamp when the certificate that was used by edge-optimized endpoint for + // this domain name was uploaded. + CertificateUploadDate *time.Time + + // The domain name of the Amazon CloudFront distribution associated with this + // custom domain name for an edge-optimized endpoint. You set up this association + // when adding a DNS record pointing the custom domain name to this distribution + // name. For more information about CloudFront distributions, see the Amazon + // CloudFront documentation (https://aws.amazon.com/documentation/cloudfront/). + DistributionDomainName *string + // The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized // endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more // information, see Set up a Regional Custom Domain Name @@ -399,34 +409,33 @@ type DomainName struct { // The custom domain name as an API host name, for example, my-api.example.com. DomainName *string - // The Transport Layer Security (TLS) version + cipher suite for this DomainName - // (). The valid values are TLS_1_0 and TLS_1_2. - SecurityPolicy SecurityPolicy + // The status of the DomainName () migration. The valid values are AVAILABLE and + // UPDATING. If the status is UPDATING, the domain cannot be modified further until + // the existing operation is complete. If it is AVAILABLE, the domain can be + // updated. + DomainNameStatus DomainNameStatus // An optional text message containing detailed information about status of the // DomainName () migration. DomainNameStatusMessage *string + // The endpoint configuration of this DomainName () showing the endpoint types of + // the domain name. + EndpointConfiguration *EndpointConfiguration + // The reference to an AWS-managed certificate that will be used for validating the // regional domain name. AWS Certificate Manager is the only supported source. RegionalCertificateArn *string - // The reference to an AWS-managed certificate that will be used by edge-optimized - // endpoint for this domain name. AWS Certificate Manager is the only supported - // source. - CertificateArn *string - - // The timestamp when the certificate that was used by edge-optimized endpoint for - // this domain name was uploaded. - CertificateUploadDate *time.Time - // The name of the certificate that will be used for validating the regional domain // name. RegionalCertificateName *string - // The endpoint configuration of this DomainName () showing the endpoint types of - // the domain name. - EndpointConfiguration *EndpointConfiguration + // The domain name associated with the regional endpoint for this custom domain + // name. You set up this association by adding a DNS record that points the custom + // domain name to this regional domain name. The regional domain name is returned + // by API Gateway when you create a regional endpoint. + RegionalDomainName *string // The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For // more information, see Set up a Regional Custom Domain Name @@ -435,21 +444,12 @@ type DomainName struct { // (https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region). RegionalHostedZoneId *string - // The domain name of the Amazon CloudFront distribution associated with this - // custom domain name for an edge-optimized endpoint. You set up this association - // when adding a DNS record pointing the custom domain name to this distribution - // name. For more information about CloudFront distributions, see the Amazon - // CloudFront documentation (https://aws.amazon.com/documentation/cloudfront/). - DistributionDomainName *string + // The Transport Layer Security (TLS) version + cipher suite for this DomainName + // (). The valid values are TLS_1_0 and TLS_1_2. + SecurityPolicy SecurityPolicy // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string - - // The status of the DomainName () migration. The valid values are AVAILABLE and - // UPDATING. If the status is UPDATING, the domain cannot be modified further until - // the existing operation is complete. If it is AVAILABLE, the domain can be - // updated. - DomainNameStatus DomainNameStatus } // The endpoint configuration to indicate the types of endpoints an API (RestApi @@ -516,6 +516,19 @@ type EndpointConfiguration struct { // Gateway Responses type GatewayResponse struct { + // A Boolean flag to indicate whether this GatewayResponse () is the default + // gateway response (true) or not (false). A default gateway response is one + // generated by API Gateway without any customization by an API developer. + DefaultResponse *bool + + // Response parameters (paths, query strings and headers) of the GatewayResponse () + // as a string-to-string map of key-value pairs. + ResponseParameters map[string]*string + + // Response templates of the GatewayResponse () as a string-to-string map of + // key-value pairs. + ResponseTemplates map[string]*string + // The response type of the associated GatewayResponse (). Valid values are // // * @@ -566,19 +579,6 @@ type GatewayResponse struct { // * UNSUPPORTED_MEDIA_TYPE ResponseType GatewayResponseType - // A Boolean flag to indicate whether this GatewayResponse () is the default - // gateway response (true) or not (false). A default gateway response is one - // generated by API Gateway without any customization by an API developer. - DefaultResponse *bool - - // Response parameters (paths, query strings and headers) of the GatewayResponse () - // as a string-to-string map of key-value pairs. - ResponseParameters map[string]*string - - // Response templates of the GatewayResponse () as a string-to-string map of - // key-value pairs. - ResponseTemplates map[string]*string - // The HTTP status code for this GatewayResponse (). StatusCode *string } @@ -589,147 +589,28 @@ type GatewayResponse struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) type Integration struct { + // A list of request parameters whose values API Gateway caches. To be valid values + // for cacheKeyParameters, these parameters must also be specified for Method + // ()requestParameters. + CacheKeyParameters []*string + // Specifies a group of related cached parameters. By default, API Gateway uses the // resource ID as the cacheNamespace. You can specify the same cacheNamespace // across resources to return the same cached data for requests to different // resources. CacheNamespace *string - // Specifies the integration's HTTP method type. - HttpMethod *string - - // Specifies an API method integration type. The valid value is one of the - // following: - // - // * AWS: for integrating the API method request with an AWS - // service action, including the Lambda function-invoking action. With the Lambda - // function-invoking action, this is referred to as the Lambda custom integration. - // With any other AWS service action, this is known as AWS integration. - // - // * - // AWS_PROXY: for integrating the API method request with the Lambda - // function-invoking action with the client request passed through as-is. This - // integration is also referred to as the Lambda proxy integration. - // - // * HTTP: - // for integrating the API method request with an HTTP endpoint, including a - // private HTTP endpoint within a VPC. This integration is also referred to as the - // HTTP custom integration. - // - // * HTTP_PROXY: for integrating the API method - // request with an HTTP endpoint, including a private HTTP endpoint within a VPC, - // with the client request passed through as-is. This is also referred to as the - // HTTP proxy integration. - // - // * MOCK: for integrating the API method request with - // API Gateway as a "loop-back" endpoint without invoking any backend. - // - // For the - // HTTP and HTTP proxy integrations, each integration can specify a protocol - // (http/https), port and path. Standard 80 and 443 ports are supported as well as - // custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType - // of VPC_LINK is referred to as a private integration and uses a VpcLink () to - // connect API Gateway to a network load balancer of a VPC. - Type IntegrationType - - // Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 - // milliseconds or 29 seconds. - TimeoutInMillis *int32 - - // Specifies Uniform Resource Identifier (URI) of the integration endpoint. - // - // * - // For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded - // HTTP(S) URL according to the RFC-3986 specification - // (https://en.wikipedia.org/wiki/Uniform_Resource_Identifier), for either standard - // integration, where connectionType is not VPC_LINK, or private integration, where - // connectionType is VPC_LINK. For a private HTTP integration, the URI is not used - // for routing. - // - // * For AWS or AWS_PROXY integrations, the URI is of the form - // arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. - // Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the - // name of the integrated AWS service (e.g., s3); and {subdomain} is a designated - // subdomain supported by certain AWS service for fast host-name lookup. action can - // be used for an AWS service action-based API, using an - // Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} - // refers to a supported action {name} plus any required input parameters. - // Alternatively, path can be used for an AWS service path-based API. The ensuing - // service_api refers to the path to an AWS service resource, including the region - // of the integrated AWS service, if applicable. For example, for integration with - // the S3 API of GetObject - // (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html), the uri - // can be either - // arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or - // arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key} - Uri *string - - // The type of the network connection to the integration endpoint. The valid value - // is INTERNET for connections through the public routable internet or VPC_LINK for - // private connections between API Gateway and a network load balancer in a VPC. - // The default value is INTERNET. - ConnectionType ConnectionType - - // A key-value map specifying request parameters that are passed from the method - // request to the back end. The key is an integration request parameter name and - // the associated value is a method request parameter value or static value that - // must be enclosed within single quotes and pre-encoded as required by the back - // end. The method request parameter value must match the pattern of - // method.request.{location}.{name}, where location is querystring, path, or header - // and name must be a valid and unique method request parameter name. - RequestParameters map[string]*string - - // Represents a map of Velocity templates that are applied on the request payload - // based on the value of the Content-Type header sent by the client. The content - // type value is the key in this map, and the template (as a String) is the value. - RequestTemplates map[string]*string - - // A list of request parameters whose values API Gateway caches. To be valid values - // for cacheKeyParameters, these parameters must also be specified for Method - // ()requestParameters. - CacheKeyParameters []*string - // The (id // (https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id)) of // the VpcLink () used for the integration when connectionType=VPC_LINK and // undefined, otherwise. ConnectionId *string - // Specifies how the method request body of an unmapped content type will be passed - // through the integration request to the back end without transformation. A - // content type is unmapped if no mapping template is defined in the integration or - // the content type does not match any of the mapped content types, as specified in - // requestTemplates. The valid value is one of the following: - // - // * WHEN_NO_MATCH: - // passes the method request body through the integration request to the back end - // without transformation when the method request content type does not match any - // content type associated with the mapping templates defined in the integration - // request. - // - // * WHEN_NO_TEMPLATES: passes the method request body through the - // integration request to the back end without transformation when no mapping - // template is defined in the integration request. If a template is defined when - // this option is selected, the method request of an unmapped content-type will be - // rejected with an HTTP 415 Unsupported Media Type response. - // - // * NEVER: rejects - // the method request with an HTTP 415 Unsupported Media Type response when either - // the method request content type does not match any content type associated with - // the mapping templates defined in the integration request or no mapping template - // is defined in the integration request. - PassthroughBehavior *string - - // Specifies the TLS configuration for an integration. - TlsConfig *TlsConfig - - // Specifies the credentials required for the integration, if any. For AWS - // integrations, three options are available. To specify an IAM Role for API - // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that - // the caller's identity be passed through from the request, specify the string - // arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS - // services, specify null. - Credentials *string + // The type of the network connection to the integration endpoint. The valid value + // is INTERNET for connections through the public routable internet or VPC_LINK for + // private connections between API Gateway and a network load balancer in a VPC. + // The default value is INTERNET. + ConnectionType ConnectionType // Specifies how to handle request payload content type conversions. Supported // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following @@ -747,6 +628,17 @@ type Integration struct { // the passthroughBehavior is configured to support payload pass-through. ContentHandling ContentHandlingStrategy + // Specifies the credentials required for the integration, if any. For AWS + // integrations, three options are available. To specify an IAM Role for API + // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that + // the caller's identity be passed through from the request, specify the string + // arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS + // services, specify null. + Credentials *string + + // Specifies the integration's HTTP method type. + HttpMethod *string + // Specifies the integration's responses. // Example: Get integration responses of a // method @@ -779,6 +671,114 @@ type Integration struct { // }, "statusCode": "200" }Creating an API // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) IntegrationResponses map[string]*IntegrationResponse + + // Specifies how the method request body of an unmapped content type will be passed + // through the integration request to the back end without transformation. A + // content type is unmapped if no mapping template is defined in the integration or + // the content type does not match any of the mapped content types, as specified in + // requestTemplates. The valid value is one of the following: + // + // * WHEN_NO_MATCH: + // passes the method request body through the integration request to the back end + // without transformation when the method request content type does not match any + // content type associated with the mapping templates defined in the integration + // request. + // + // * WHEN_NO_TEMPLATES: passes the method request body through the + // integration request to the back end without transformation when no mapping + // template is defined in the integration request. If a template is defined when + // this option is selected, the method request of an unmapped content-type will be + // rejected with an HTTP 415 Unsupported Media Type response. + // + // * NEVER: rejects + // the method request with an HTTP 415 Unsupported Media Type response when either + // the method request content type does not match any content type associated with + // the mapping templates defined in the integration request or no mapping template + // is defined in the integration request. + PassthroughBehavior *string + + // A key-value map specifying request parameters that are passed from the method + // request to the back end. The key is an integration request parameter name and + // the associated value is a method request parameter value or static value that + // must be enclosed within single quotes and pre-encoded as required by the back + // end. The method request parameter value must match the pattern of + // method.request.{location}.{name}, where location is querystring, path, or header + // and name must be a valid and unique method request parameter name. + RequestParameters map[string]*string + + // Represents a map of Velocity templates that are applied on the request payload + // based on the value of the Content-Type header sent by the client. The content + // type value is the key in this map, and the template (as a String) is the value. + RequestTemplates map[string]*string + + // Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 + // milliseconds or 29 seconds. + TimeoutInMillis *int32 + + // Specifies the TLS configuration for an integration. + TlsConfig *TlsConfig + + // Specifies an API method integration type. The valid value is one of the + // following: + // + // * AWS: for integrating the API method request with an AWS + // service action, including the Lambda function-invoking action. With the Lambda + // function-invoking action, this is referred to as the Lambda custom integration. + // With any other AWS service action, this is known as AWS integration. + // + // * + // AWS_PROXY: for integrating the API method request with the Lambda + // function-invoking action with the client request passed through as-is. This + // integration is also referred to as the Lambda proxy integration. + // + // * HTTP: + // for integrating the API method request with an HTTP endpoint, including a + // private HTTP endpoint within a VPC. This integration is also referred to as the + // HTTP custom integration. + // + // * HTTP_PROXY: for integrating the API method + // request with an HTTP endpoint, including a private HTTP endpoint within a VPC, + // with the client request passed through as-is. This is also referred to as the + // HTTP proxy integration. + // + // * MOCK: for integrating the API method request with + // API Gateway as a "loop-back" endpoint without invoking any backend. + // + // For the + // HTTP and HTTP proxy integrations, each integration can specify a protocol + // (http/https), port and path. Standard 80 and 443 ports are supported as well as + // custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType + // of VPC_LINK is referred to as a private integration and uses a VpcLink () to + // connect API Gateway to a network load balancer of a VPC. + Type IntegrationType + + // Specifies Uniform Resource Identifier (URI) of the integration endpoint. + // + // * + // For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded + // HTTP(S) URL according to the RFC-3986 specification + // (https://en.wikipedia.org/wiki/Uniform_Resource_Identifier), for either standard + // integration, where connectionType is not VPC_LINK, or private integration, where + // connectionType is VPC_LINK. For a private HTTP integration, the URI is not used + // for routing. + // + // * For AWS or AWS_PROXY integrations, the URI is of the form + // arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. + // Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the + // name of the integrated AWS service (e.g., s3); and {subdomain} is a designated + // subdomain supported by certain AWS service for fast host-name lookup. action can + // be used for an AWS service action-based API, using an + // Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} + // refers to a supported action {name} plus any required input parameters. + // Alternatively, path can be used for an AWS service path-based API. The ensuing + // service_api refers to the path to an AWS service resource, including the region + // of the integrated AWS service, if applicable. For example, for integration with + // the S3 API of GetObject + // (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html), the uri + // can be either + // arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or + // arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key} + Uri *string } // Represents an integration response. The status code must map to an existing @@ -787,6 +787,21 @@ type Integration struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) type IntegrationResponse struct { + // Specifies how to handle response payload content type conversions. Supported + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following + // behaviors: + // + // * CONVERT_TO_BINARY: Converts a response payload from a + // Base64-encoded string to the corresponding binary blob. + // + // * CONVERT_TO_TEXT: + // Converts a response payload from a binary blob to a Base64-encoded string. + // + // If + // this property is not defined, the response payload will be passed through from + // the integration response to the method response without modification. + ContentHandling ContentHandlingStrategy + // A key-value map specifying response parameters that are passed to the method // response from the back end. The key is a method response header parameter name // and the mapped value is an integration response header value, a static value @@ -805,10 +820,6 @@ type IntegrationResponse struct { // the key and a template as the value. ResponseTemplates map[string]*string - // Specifies the status code that is used to map the integration response to an - // existing MethodResponse (). - StatusCode *string - // Specifies the regular expression (regex) pattern used to choose an integration // response based on the response from the back end. For example, if the success // response returns nothing and the error response returns some string, you could @@ -818,20 +829,9 @@ type IntegrationResponse struct { // For all other HTTP and AWS back ends, the HTTP status code is matched. SelectionPattern *string - // Specifies how to handle response payload content type conversions. Supported - // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following - // behaviors: - // - // * CONVERT_TO_BINARY: Converts a response payload from a - // Base64-encoded string to the corresponding binary blob. - // - // * CONVERT_TO_TEXT: - // Converts a response payload from a binary blob to a Base64-encoded string. - // - // If - // this property is not defined, the response payload will be passed through from - // the integration response to the method response without modification. - ContentHandling ContentHandlingStrategy + // Specifies the status code that is used to map the integration response to an + // existing MethodResponse (). + StatusCode *string } // Represents a client-facing interface by which the client calls the API to access @@ -926,65 +926,32 @@ type IntegrationResponse struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-method-settings.html) type Method struct { - // A key-value map defining required or optional method request parameters that can - // be accepted by API Gateway. A key is a method request parameter name matching - // the pattern of method.request.{location}.{name}, where location is querystring, - // path, or header and name is a valid and unique parameter name. The value - // associated with the key is a Boolean flag indicating whether the parameter is - // required (true) or optional (false). The method request parameter names defined - // here are available in Integration () to be mapped to integration request - // parameters or templates. - RequestParameters map[string]*bool + // A boolean flag specifying whether a valid ApiKey () is required to invoke this + // method. + ApiKeyRequired *bool + + // A list of authorization scopes configured on the method. The scopes are used + // with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The + // authorization works by matching the method scopes against the scopes parsed from + // the access token in the incoming request. The method invocation is authorized if + // any method scopes matches a claimed scope in the access token. Otherwise, the + // invocation is not authorized. When the method scope is configured, the client + // must provide an access token instead of an identity token for authorization + // purposes. + AuthorizationScopes []*string // The method's authorization type. Valid values are NONE for open access, AWS_IAM // for using AWS IAM permissions, CUSTOM for using a custom authorizer, or // COGNITO_USER_POOLS for using a Cognito user pool. AuthorizationType *string - // The method's HTTP verb. - HttpMethod *string - - // Gets a method response associated with a given HTTP status code. The collection - // of method responses are encapsulated in a key-value map, where the key is a - // response's HTTP status code and the value is a MethodResponse () resource that - // specifies the response returned to the caller from the back end through the - // integration response. - // Example: Get a 200 OK response of a GET method - // - // Request - // - // - // GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 - // Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com - // Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 - // Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, - // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} - // - // Response - // - // The - // successful response returns a 200 OK status code and a payload similar to the - // following: { "_links": { "curies": { "href": - // "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", - // "name": "methodresponse", "templated": true }, "self": { "href": - // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": - // "200" }, "methodresponse:delete": { "href": - // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" }, - // "methodresponse:update": { "href": - // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } }, - // "responseModels": { "application/json": "Empty" }, "responseParameters": { - // "method.response.header.operator": false, "method.response.header.operand_2": - // false, "method.response.header.operand_1": false }, "statusCode": "200" }AWS CLI - // (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-method-response.html) - MethodResponses map[string]*MethodResponse - - // The identifier of a RequestValidator () for request validation. - RequestValidatorId *string - // The identifier of an Authorizer () to use on this method. The authorizationType // must be CUSTOM. AuthorizerId *string + // The method's HTTP verb. + HttpMethod *string + // Gets the method's integration responsible for passing the client-submitted // request to the back end and performing necessary transformations to make the // request compliant with the back end. @@ -1041,29 +1008,62 @@ type Method struct { // (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-integration.html) MethodIntegration *Integration + // Gets a method response associated with a given HTTP status code. The collection + // of method responses are encapsulated in a key-value map, where the key is a + // response's HTTP status code and the value is a MethodResponse () resource that + // specifies the response returned to the caller from the back end through the + // integration response. + // Example: Get a 200 OK response of a GET method + // + // Request + // + // + // GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 + // Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com + // Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 + // Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, + // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} + // + // Response + // + // The + // successful response returns a 200 OK status code and a payload similar to the + // following: { "_links": { "curies": { "href": + // "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", + // "name": "methodresponse", "templated": true }, "self": { "href": + // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": + // "200" }, "methodresponse:delete": { "href": + // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" }, + // "methodresponse:update": { "href": + // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } }, + // "responseModels": { "application/json": "Empty" }, "responseParameters": { + // "method.response.header.operator": false, "method.response.header.operand_2": + // false, "method.response.header.operand_1": false }, "statusCode": "200" }AWS CLI + // (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-method-response.html) + MethodResponses map[string]*MethodResponse + // A human-friendly operation identifier for the method. For example, you can // assign the operationName of ListPets for the GET /pets method in the PetStore // example. OperationName *string - // A boolean flag specifying whether a valid ApiKey () is required to invoke this - // method. - ApiKeyRequired *bool - - // A list of authorization scopes configured on the method. The scopes are used - // with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The - // authorization works by matching the method scopes against the scopes parsed from - // the access token in the incoming request. The method invocation is authorized if - // any method scopes matches a claimed scope in the access token. Otherwise, the - // invocation is not authorized. When the method scope is configured, the client - // must provide an access token instead of an identity token for authorization - // purposes. - AuthorizationScopes []*string - // A key-value map specifying data schemas, represented by Model () resources, (as // the mapped value) of the request payloads of given content types (as the mapping // key). RequestModels map[string]*string + + // A key-value map defining required or optional method request parameters that can + // be accepted by API Gateway. A key is a method request parameter name matching + // the pattern of method.request.{location}.{name}, where location is querystring, + // path, or header and name is a valid and unique parameter name. The value + // associated with the key is a Boolean flag indicating whether the parameter is + // required (true) or optional (false). The method request parameter names defined + // here are available in Integration () to be mapped to integration request + // parameters or templates. + RequestParameters map[string]*bool + + // The identifier of a RequestValidator () for request validation. + RequestValidatorId *string } // Represents a method response of a given HTTP status code returned to the client. @@ -1104,9 +1104,6 @@ type MethodResponse struct { // Model () name as the value. ResponseModels map[string]*string - // The method response's status code. - StatusCode *string - // A key-value map specifying required or optional response parameters that API // Gateway can send back to the caller. A key defines a method response header and // the value specifies whether the associated method response header is required or @@ -1121,54 +1118,57 @@ type MethodResponse struct { // the form of integration.response.body.{JSON-expression}, where JSON-expression // is a valid JSON expression without the $ prefix.) ResponseParameters map[string]*bool + + // The method response's status code. + StatusCode *string } // Specifies the method setting properties. type MethodSetting struct { - // Specifies whether authorization is required for a cache invalidation request. - // The PATCH path for this setting is - // /{method_setting_key}/caching/requireAuthorizationForCacheControl, and the value - // is a Boolean. - RequireAuthorizationForCacheControl *bool - - // Specifies the logging level for this method, which affects the log entries - // pushed to Amazon CloudWatch Logs. The PATCH path for this setting is - // /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, - // and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or - // choose INFO to include all ERROR events as well as extra informational events. - LoggingLevel *string - - // Specifies whether data trace logging is enabled for this method, which affects - // the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this - // setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean. - DataTraceEnabled *bool - // Specifies whether the cached responses are encrypted. The PATCH path for this // setting is /{method_setting_key}/caching/dataEncrypted, and the value is a // Boolean. CacheDataEncrypted *bool + // Specifies the time to live (TTL), in seconds, for cached responses. The higher + // the TTL, the longer the response will be cached. The PATCH path for this setting + // is /{method_setting_key}/caching/ttlInSeconds, and the value is an integer. + CacheTtlInSeconds *int32 + // Specifies whether responses should be cached and returned for requests. A cache // cluster must be enabled on the stage for responses to be cached. The PATCH path // for this setting is /{method_setting_key}/caching/enabled, and the value is a // Boolean. CachingEnabled *bool + // Specifies whether data trace logging is enabled for this method, which affects + // the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this + // setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean. + DataTraceEnabled *bool + + // Specifies the logging level for this method, which affects the log entries + // pushed to Amazon CloudWatch Logs. The PATCH path for this setting is + // /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, + // and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or + // choose INFO to include all ERROR events as well as extra informational events. + LoggingLevel *string + // Specifies whether Amazon CloudWatch metrics are enabled for this method. The // PATCH path for this setting is /{method_setting_key}/metrics/enabled, and the // value is a Boolean. MetricsEnabled *bool + // Specifies whether authorization is required for a cache invalidation request. + // The PATCH path for this setting is + // /{method_setting_key}/caching/requireAuthorizationForCacheControl, and the value + // is a Boolean. + RequireAuthorizationForCacheControl *bool + // Specifies the throttling burst limit. The PATCH path for this setting is // /{method_setting_key}/throttling/burstLimit, and the value is an integer. ThrottlingBurstLimit *int32 - // Specifies the time to live (TTL), in seconds, for cached responses. The higher - // the TTL, the longer the response will be cached. The PATCH path for this setting - // is /{method_setting_key}/caching/ttlInSeconds, and the value is an integer. - CacheTtlInSeconds *int32 - // Specifies the throttling rate limit. The PATCH path for this setting is // /{method_setting_key}/throttling/rateLimit, and the value is a double. ThrottlingRateLimit *float64 @@ -1184,13 +1184,13 @@ type MethodSetting struct { // Represents a summary of a Method () resource, given a particular date and time. type MethodSnapshot struct { + // Specifies whether the method requires a valid ApiKey (). + ApiKeyRequired *bool + // The method's authorization type. Valid values are NONE for open access, AWS_IAM // for using AWS IAM permissions, CUSTOM for using a custom authorizer, or // COGNITO_USER_POOLS for using a Cognito user pool. AuthorizationType *string - - // Specifies whether the method requires a valid ApiKey (). - ApiKeyRequired *bool } // Represents the data structure of a method's request or response payload. A @@ -1203,18 +1203,18 @@ type MethodSnapshot struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html) type Model struct { - // The identifier for the model resource. - Id *string - - // The name of the model. Must be an alphanumeric string. - Name *string - // The content-type for the model. ContentType *string // The description of the model. Description *string + // The identifier for the model resource. + Id *string + + // The name of the model. Must be an alphanumeric string. + Name *string + // The schema for the model. For application/json models, this should be JSON // schema draft 4 (https://tools.ietf.org/html/draft-zyp-json-schema-04) model. Do // not include "\*/" characters in the description of any properties because such @@ -1229,20 +1229,6 @@ type Model struct { // operation is used. type PatchOperation struct { - // The new target value of the update operation. It is applicable for the add or - // replace operation. When using AWS CLI to update a property of a JSON value, - // enclose the JSON object with a pair of single quotes in a Linux shell, e.g., - // '{"a": ...}'. In a Windows shell, see Using JSON for Parameters - // (https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). - Value *string - - // An update operation to be performed with this PATCH request. The valid value can - // be add, remove, replace or copy. Not all valid operations are supported for a - // given resource. Support of the operations depends on specific operational - // contexts. Attempts to apply an unsupported operation on a resource will return - // an error message. - Op Op - // The copy update operation's source as identified by a JSON-Pointer value // referencing the location within the targeted resource to copy the value from. // For example, to promote a canary deployment, you copy the canary deployment ID @@ -1251,6 +1237,13 @@ type PatchOperation struct { // "path":"/deploymentId". From *string + // An update operation to be performed with this PATCH request. The valid value can + // be add, remove, replace or copy. Not all valid operations are supported for a + // given resource. Support of the operations depends on specific operational + // contexts. Attempts to apply an unsupported operation on a resource will return + // an error message. + Op Op + // The op operation's target, as identified by a JSON Pointer // (https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-08) value that // references a location within the targeted resource. For example, if the target @@ -1261,21 +1254,28 @@ type PatchOperation struct { // escaped with "~1", as shown in the example above. Each op operation can have // only one path associated with it. Path *string + + // The new target value of the update operation. It is applicable for the add or + // replace operation. When using AWS CLI to update a property of a JSON value, + // enclose the JSON object with a pair of single quotes in a Linux shell, e.g., + // '{"a": ...}'. In a Windows shell, see Using JSON for Parameters + // (https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). + Value *string } // Quotas configured for a usage plan. type QuotaSettings struct { - // The time period in which the limit applies. Valid values are "DAY", "WEEK" or - // "MONTH". - Period QuotaPeriodType - // The maximum number of requests that can be made in a given time period. Limit *int32 // The number of requests subtracted from the given limit in the initial time // period. Offset *int32 + + // The time period in which the limit applies. Valid values are "DAY", "WEEK" or + // "MONTH". + Period QuotaPeriodType } // A set of validation rules for incoming Method () requests. In OpenAPI, a @@ -1291,6 +1291,9 @@ type RequestValidator struct { // The identifier of this RequestValidator (). Id *string + // The name of this RequestValidator () + Name *string + // A Boolean flag to indicate whether to validate a request body according to the // configured Model () schema. ValidateRequestBody *bool @@ -1298,9 +1301,6 @@ type RequestValidator struct { // A Boolean flag to indicate whether to validate request parameters (true) or not // (false). ValidateRequestParameters *bool - - // The name of this RequestValidator () - Name *string } // Represents an API resource. Create an API @@ -1310,6 +1310,15 @@ type Resource struct { // The resource's identifier. Id *string + // The parent resource's identifier. + ParentId *string + + // The full path for this resource. + Path *string + + // The last path segment for this resource. + PathPart *string + // Gets an API resource's method of a given HTTP verb. The resource methods are a // map of methods indexed by methods' HTTP verbs enabled on the resource. This // method map is included in the 200 OK response of the GET @@ -1390,32 +1399,12 @@ type Resource struct { // method. Just replace the GET of the last path segment in the request URL with // OPTIONS. ResourceMethods map[string]*Method - - // The parent resource's identifier. - ParentId *string - - // The full path for this resource. - Path *string - - // The last path segment for this resource. - PathPart *string } // Represents a REST API. Create an API // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) type RestApi struct { - // The API's description. - Description *string - - // A stringified JSON policy document that applies to this RestApi regardless of - // the caller and Method () configuration. - Policy *string - - // The endpoint configuration of this RestApi () showing the endpoint types of the - // API. - EndpointConfiguration *EndpointConfiguration - // The source of the API key for metering requests according to a usage plan. Valid // values are: // @@ -1426,36 +1415,47 @@ type RestApi struct { // a custom authorizer. ApiKeySource ApiKeySourceType - // The API's name. - Name *string - - // A version identifier for the API. - Version *string - - // The collection of tags. Each tag element is associated with a given resource. - Tags map[string]*string - - // The warning messages reported when failonwarnings is turned on during API - // import. - Warnings []*string + // The list of binary media types supported by the RestApi (). By default, the + // RestApi () supports only UTF-8-encoded text payloads. + BinaryMediaTypes []*string // The timestamp when the API was created. CreatedDate *time.Time + // The API's description. + Description *string + + // The endpoint configuration of this RestApi () showing the endpoint types of the + // API. + EndpointConfiguration *EndpointConfiguration + // The API's identifier. This identifier is unique across all of your APIs in API // Gateway. Id *string - // The list of binary media types supported by the RestApi (). By default, the - // RestApi () supports only UTF-8-encoded text payloads. - BinaryMediaTypes []*string - // A nullable integer that is used to enable compression (with non-negative between // 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null // value) on an API. When compression is enabled, compression or decompression is // not applied on the payload if the payload size is smaller than this value. // Setting it to zero allows compression for any payload size. MinimumCompressionSize *int32 + + // The API's name. + Name *string + + // A stringified JSON policy document that applies to this RestApi regardless of + // the caller and Method () configuration. + Policy *string + + // The collection of tags. Each tag element is associated with a given resource. + Tags map[string]*string + + // A version identifier for the API. + Version *string + + // The warning messages reported when failonwarnings is turned on during API + // import. + Warnings []*string } // A configuration property of an SDK type. @@ -1467,28 +1467,28 @@ type SdkConfigurationProperty struct { // The description of an SdkType () configuration property. Description *string - // A boolean flag of an SdkType () configuration property to indicate if the - // associated SDK configuration property is required (true) or not (false). - Required *bool + // The user-friendly name of an SdkType () configuration property. + FriendlyName *string // The name of a an SdkType () configuration property. Name *string - // The user-friendly name of an SdkType () configuration property. - FriendlyName *string + // A boolean flag of an SdkType () configuration property to indicate if the + // associated SDK configuration property is required (true) or not (false). + Required *bool } // A type of SDK that API Gateway can generate. type SdkType struct { - // The user-friendly name of an SdkType () instance. - FriendlyName *string + // A list of configuration properties of an SdkType (). + ConfigurationProperties []*SdkConfigurationProperty // The description of an SdkType (). Description *string - // A list of configuration properties of an SdkType (). - ConfigurationProperties []*SdkConfigurationProperty + // The user-friendly name of an SdkType () instance. + FriendlyName *string // The identifier of an SdkType () instance. Id *string @@ -1499,43 +1499,32 @@ type SdkType struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api.html) type Stage struct { - // The identifier of the Deployment () that the stage points to. - DeploymentId *string - - // The stage's description. - Description *string + // Settings for logging access in this stage. + AccessLogSettings *AccessLogSettings - // The name of the stage is the first path segment in the Uniform Resource - // Identifier (URI) of a call to API Gateway. Stage names can only contain - // alphanumeric characters, hyphens, and underscores. Maximum length is 128 - // characters. - StageName *string + // Specifies whether a cache cluster is enabled for the stage. + CacheClusterEnabled *bool - // The collection of tags. Each tag element is associated with a given resource. - Tags map[string]*string + // The size of the cache cluster for the stage, if enabled. + CacheClusterSize CacheClusterSize // The status of the cache cluster for the stage, if enabled. CacheClusterStatus CacheClusterStatus - // The identifier of a client certificate for an API stage. - ClientCertificateId *string - - // Specifies whether a cache cluster is enabled for the stage. - CacheClusterEnabled *bool - // Settings for the canary deployment in this stage. CanarySettings *CanarySettings - // A map that defines the stage variables for a Stage () resource. Variable names - // can have alphanumeric and underscore characters, and the values must match - // [A-Za-z0-9-._~:/?#&=,]+. - Variables map[string]*string + // The identifier of a client certificate for an API stage. + ClientCertificateId *string - // The size of the cache cluster for the stage, if enabled. - CacheClusterSize CacheClusterSize + // The timestamp when the stage was created. + CreatedDate *time.Time - // Settings for logging access in this stage. - AccessLogSettings *AccessLogSettings + // The identifier of the Deployment () that the stage points to. + DeploymentId *string + + // The stage's description. + Description *string // The version of the associated API documentation. DocumentationVersion *string @@ -1543,30 +1532,41 @@ type Stage struct { // The timestamp when the stage last updated. LastUpdatedDate *time.Time - // The timestamp when the stage was created. - CreatedDate *time.Time + // A map that defines the method settings for a Stage () resource. Keys (designated + // as /{method_setting_key below) are method paths defined as + // {resource_path}/{http_method} for an individual method override, or /\*/\* for + // overriding all methods in the stage. + MethodSettings map[string]*MethodSetting + + // The name of the stage is the first path segment in the Uniform Resource + // Identifier (URI) of a call to API Gateway. Stage names can only contain + // alphanumeric characters, hyphens, and underscores. Maximum length is 128 + // characters. + StageName *string + + // The collection of tags. Each tag element is associated with a given resource. + Tags map[string]*string // Specifies whether active tracing with X-ray is enabled for the Stage (). TracingEnabled *bool + // A map that defines the stage variables for a Stage () resource. Variable names + // can have alphanumeric and underscore characters, and the values must match + // [A-Za-z0-9-._~:/?#&=,]+. + Variables map[string]*string + // The ARN of the WebAcl associated with the Stage (). WebAclArn *string - - // A map that defines the method settings for a Stage () resource. Keys (designated - // as /{method_setting_key below) are method paths defined as - // {resource_path}/{http_method} for an individual method override, or /\*/\* for - // overriding all methods in the stage. - MethodSettings map[string]*MethodSetting } // A reference to a unique stage identified in the format {restApiId}/{stage}. type StageKey struct { - // The stage name associated with the stage key. - StageName *string - // The string identifier of the associated RestApi (). RestApiId *string + + // The stage name associated with the stage key. + StageName *string } // The API request rate limits. @@ -1601,18 +1601,18 @@ type TlsConfig struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) type UsagePlan struct { + // The associated API stages of a usage plan. + ApiStages []*ApiStage + + // The description of a usage plan. + Description *string + // The identifier of a UsagePlan () resource. Id *string - // The request throttle limits of a usage plan. - Throttle *ThrottleSettings - // The name of a usage plan. Name *string - // The associated API stages of a usage plan. - ApiStages []*ApiStage - // The AWS Markeplace product identifier to associate with the usage plan as a SaaS // product on AWS Marketplace. ProductCode *string @@ -1623,8 +1623,8 @@ type UsagePlan struct { // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string - // The description of a usage plan. - Description *string + // The request throttle limits of a usage plan. + Throttle *ThrottleSettings } // Represents a usage plan key to identify a plan customer. To associate an API @@ -1633,17 +1633,17 @@ type UsagePlan struct { // (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) type UsagePlanKey struct { - // The name of a usage plan key. - Name *string - - // The value of a usage plan key. - Value *string - // The Id of a usage plan key. Id *string + // The name of a usage plan key. + Name *string + // The type of a usage plan key. Currently, the valid key type is API_KEY. Type *string + + // The value of a usage plan key. + Value *string } // An API Gateway VPC link for a RestApi () to access resources in an Amazon @@ -1656,6 +1656,9 @@ type UsagePlanKey struct { // connectionId property to identify the VpcLink () used. type VpcLink struct { + // The description of the VPC link. + Description *string + // The identifier of the VpcLink (). It is used in an Integration () to reference // this VpcLink (). Id *string @@ -1663,21 +1666,18 @@ type VpcLink struct { // The name used to label and identify the VPC link. Name *string - // The description of the VPC link. - Description *string - - // A description about the VPC link status. - StatusMessage *string - - // The ARN of the network load balancer of the VPC targeted by the VPC link. The - // network load balancer must be owned by the same AWS account of the API owner. - TargetArns []*string - // The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, // or FAILED. Deploying an API will wait if the status is PENDING and will fail if // the status is DELETING. Status VpcLinkStatus + // A description about the VPC link status. + StatusMessage *string + // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string + + // The ARN of the network load balancer of the VPC targeted by the VPC link. The + // network load balancer must be owned by the same AWS account of the API owner. + TargetArns []*string } diff --git a/service/apigatewaymanagementapi/api_op_GetConnection.go b/service/apigatewaymanagementapi/api_op_GetConnection.go index 7a8a384404a..c19b9e3cf6b 100644 --- a/service/apigatewaymanagementapi/api_op_GetConnection.go +++ b/service/apigatewaymanagementapi/api_op_GetConnection.go @@ -61,11 +61,12 @@ type GetConnectionInput struct { } type GetConnectionOutput struct { - Identity *types.Identity // The time in ISO 8601 format for when the connection was established. ConnectedAt *time.Time + Identity *types.Identity + // The time in ISO 8601 format for when the connection was last active. LastActiveAt *time.Time diff --git a/service/apigatewaymanagementapi/go.mod b/service/apigatewaymanagementapi/go.mod index 1084aaf3ac4..cb10d2512dd 100644 --- a/service/apigatewaymanagementapi/go.mod +++ b/service/apigatewaymanagementapi/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/apigatewaymanagementapi go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/apigatewayv2/api_op_CreateApi.go b/service/apigatewayv2/api_op_CreateApi.go index 10f8e53bbab..992e4960971 100644 --- a/service/apigatewayv2/api_op_CreateApi.go +++ b/service/apigatewayv2/api_op_CreateApi.go @@ -59,6 +59,21 @@ func (c *Client) CreateApi(ctx context.Context, params *CreateApiInput, optFns . // Creates a new Api resource to represent an API. type CreateApiInput struct { + // The name of the API. + // + // This member is required. + Name *string + + // The API protocol. + // + // This member is required. + ProtocolType types.ProtocolType + + // An API key selection expression. Supported only for WebSocket APIs. See API Key + // Selection Expressions + // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). + ApiKeySelectionExpression *string + // A CORS configuration. Supported only for HTTP APIs. See Configuring CORS // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) // for more information. @@ -73,12 +88,13 @@ type CreateApiInput struct { // HTTP integrations. Supported only for HTTP APIs. CredentialsArn *string - // A version identifier for the API. - Version *string - // The description of the API. Description *string + // Avoid validating models when creating a deployment. Supported only for WebSocket + // APIs. + DisableSchemaValidation *bool + // This property is part of quick create. If you don't specify a routeKey, a // default route of $default is created. The $default route acts as a catch-all for // any request made to your API, for a particular stage. The $default route key @@ -86,6 +102,15 @@ type CreateApiInput struct { // the route keys of additional routes. Supported only for HTTP APIs. RouteKey *string + // The route selection expression for the API. For HTTP APIs, the + // routeSelectionExpression must be ${request.method} ${request.path}. If not + // provided, this will be the default for HTTP APIs. This property is required for + // WebSocket APIs. + RouteSelectionExpression *string + + // The collection of tags. Each tag element is associated with a given resource. + Tags map[string]*string + // This property is part of quick create. Quick create produces an API with an // integration, a default catch-all route, and a default stage which is configured // to automatically deploy changes. For HTTP integrations, specify a fully @@ -94,36 +119,42 @@ type CreateApiInput struct { // HTTP APIs. Target *string - // Avoid validating models when creating a deployment. Supported only for WebSocket - // APIs. - DisableSchemaValidation *bool + // A version identifier for the API. + Version *string +} - // The collection of tags. Each tag element is associated with a given resource. - Tags map[string]*string +type CreateApiOutput struct { - // The name of the API. - // - // This member is required. - Name *string + // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The + // stage name is typically appended to this URI to form a complete path to a + // deployed API stage. + ApiEndpoint *string + + // The API ID. + ApiId *string // An API key selection expression. Supported only for WebSocket APIs. See API Key // Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). ApiKeySelectionExpression *string - // The route selection expression for the API. For HTTP APIs, the - // routeSelectionExpression must be ${request.method} ${request.path}. If not - // provided, this will be the default for HTTP APIs. This property is required for - // WebSocket APIs. - RouteSelectionExpression *string + // A CORS configuration. Supported only for HTTP APIs. + CorsConfiguration *types.Cors - // The API protocol. - // - // This member is required. - ProtocolType types.ProtocolType -} + // The timestamp when the API was created. + CreatedDate *time.Time -type CreateApiOutput struct { + // The description of the API. + Description *string + + // Avoid validating models when creating a deployment. Supported only for WebSocket + // APIs. + DisableSchemaValidation *bool + + // The validation information during API import. This may include particular + // properties of your OpenAPI definition which are ignored during import. Supported + // only for HTTP APIs. + ImportInfo []*string // The name of the API. Name *string @@ -137,47 +168,16 @@ type CreateApiOutput struct { // WebSocket APIs. RouteSelectionExpression *string - // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The - // stage name is typically appended to this URI to form a complete path to a - // deployed API stage. - ApiEndpoint *string - - // Avoid validating models when creating a deployment. Supported only for WebSocket - // APIs. - DisableSchemaValidation *bool - - // The validation information during API import. This may include particular - // properties of your OpenAPI definition which are ignored during import. Supported - // only for HTTP APIs. - ImportInfo []*string + // A collection of tags associated with the API. + Tags map[string]*string - // The description of the API. - Description *string + // A version identifier for the API. + Version *string // The warning messages reported when failonwarnings is turned on during API // import. Warnings []*string - // The API ID. - ApiId *string - - // An API key selection expression. Supported only for WebSocket APIs. See API Key - // Selection Expressions - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). - ApiKeySelectionExpression *string - - // A version identifier for the API. - Version *string - - // A CORS configuration. Supported only for HTTP APIs. - CorsConfiguration *types.Cors - - // A collection of tags associated with the API. - Tags map[string]*string - - // The timestamp when the API was created. - CreatedDate *time.Time - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigatewayv2/api_op_CreateApiMapping.go b/service/apigatewayv2/api_op_CreateApiMapping.go index 9959d4fb976..523109f08a3 100644 --- a/service/apigatewayv2/api_op_CreateApiMapping.go +++ b/service/apigatewayv2/api_op_CreateApiMapping.go @@ -57,23 +57,23 @@ func (c *Client) CreateApiMapping(ctx context.Context, params *CreateApiMappingI // Creates a new ApiMapping resource to represent an API mapping. type CreateApiMappingInput struct { - // The API mapping key. - ApiMappingKey *string - - // The domain name. + // The API identifier. // // This member is required. - DomainName *string + ApiId *string - // The API identifier. + // The domain name. // // This member is required. - ApiId *string + DomainName *string // The API stage. // // This member is required. Stage *string + + // The API mapping key. + ApiMappingKey *string } type CreateApiMappingOutput struct { @@ -81,14 +81,14 @@ type CreateApiMappingOutput struct { // The API identifier. ApiId *string - // The API stage. - Stage *string + // The API mapping identifier. + ApiMappingId *string // The API mapping key. ApiMappingKey *string - // The API mapping identifier. - ApiMappingId *string + // The API stage. + Stage *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigatewayv2/api_op_CreateAuthorizer.go b/service/apigatewayv2/api_op_CreateAuthorizer.go index 5e234d6d261..f8d82fbdbb9 100644 --- a/service/apigatewayv2/api_op_CreateAuthorizer.go +++ b/service/apigatewayv2/api_op_CreateAuthorizer.go @@ -58,6 +58,11 @@ func (c *Client) CreateAuthorizer(ctx context.Context, params *CreateAuthorizerI // Creates a new Authorizer resource to represent an authorizer. type CreateAuthorizerInput struct { + // The API identifier. + // + // This member is required. + ApiId *string + // The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function // using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web // Tokens. @@ -65,14 +70,6 @@ type CreateAuthorizerInput struct { // This member is required. AuthorizerType types.AuthorizerType - // The API identifier. - // - // This member is required. - ApiId *string - - // This parameter is not used. - IdentityValidationExpression *string - // The identity source for which authorization is requested. For a REQUEST // authorizer, this is optional. The value is a set of one or more mapping // expressions of the specified request parameters. Currently, the identity source @@ -92,15 +89,17 @@ type CreateAuthorizerInput struct { // This member is required. IdentitySource []*string - // Represents the configuration of a JWT authorizer. Required for the JWT - // authorizer type. Supported only for HTTP APIs. - JwtConfiguration *types.JWTConfiguration - // The name of the authorizer. // // This member is required. Name *string + // Specifies the required credentials as an IAM role for API Gateway to invoke the + // authorizer. To specify an IAM role for API Gateway to assume, use the role's + // Amazon Resource Name (ARN). To use resource-based permissions on the Lambda + // function, specify null. Supported only for REQUEST authorizers. + AuthorizerCredentialsArn *string + // Authorizer caching is not currently supported. Don't specify this value for // authorizers. AuthorizerResultTtlInSeconds *int32 @@ -117,17 +116,21 @@ type CreateAuthorizerInput struct { // authorizers. AuthorizerUri *string + // This parameter is not used. + IdentityValidationExpression *string + + // Represents the configuration of a JWT authorizer. Required for the JWT + // authorizer type. Supported only for HTTP APIs. + JwtConfiguration *types.JWTConfiguration +} + +type CreateAuthorizerOutput struct { + // Specifies the required credentials as an IAM role for API Gateway to invoke the // authorizer. To specify an IAM role for API Gateway to assume, use the role's // Amazon Resource Name (ARN). To use resource-based permissions on the Lambda // function, specify null. Supported only for REQUEST authorizers. AuthorizerCredentialsArn *string -} - -type CreateAuthorizerOutput struct { - - // The validation expression does not apply to the REQUEST authorizer. - IdentityValidationExpression *string // The authorizer identifier. AuthorizerId *string @@ -136,6 +139,11 @@ type CreateAuthorizerOutput struct { // authorizers. AuthorizerResultTtlInSeconds *int32 + // The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function + // using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web + // Tokens. + AuthorizerType types.AuthorizerType + // The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this // must be a well-formed Lambda function URI, for example, // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. @@ -148,15 +156,6 @@ type CreateAuthorizerOutput struct { // authorizers. AuthorizerUri *string - // Specifies the required credentials as an IAM role for API Gateway to invoke the - // authorizer. To specify an IAM role for API Gateway to assume, use the role's - // Amazon Resource Name (ARN). To use resource-based permissions on the Lambda - // function, specify null. Supported only for REQUEST authorizers. - AuthorizerCredentialsArn *string - - // The name of the authorizer. - Name *string - // The identity source for which authorization is requested. For a REQUEST // authorizer, this is optional. The value is a set of one or more mapping // expressions of the specified request parameters. Currently, the identity source @@ -174,14 +173,15 @@ type CreateAuthorizerOutput struct { // "$request.header.Authorization". IdentitySource []*string + // The validation expression does not apply to the REQUEST authorizer. + IdentityValidationExpression *string + // Represents the configuration of a JWT authorizer. Required for the JWT // authorizer type. Supported only for HTTP APIs. JwtConfiguration *types.JWTConfiguration - // The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function - // using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web - // Tokens. - AuthorizerType types.AuthorizerType + // The name of the authorizer. + Name *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigatewayv2/api_op_CreateDeployment.go b/service/apigatewayv2/api_op_CreateDeployment.go index 280a796d93a..363f847c200 100644 --- a/service/apigatewayv2/api_op_CreateDeployment.go +++ b/service/apigatewayv2/api_op_CreateDeployment.go @@ -59,16 +59,16 @@ func (c *Client) CreateDeployment(ctx context.Context, params *CreateDeploymentI // Creates a new Deployment resource to represent a deployment. type CreateDeploymentInput struct { - // The name of the Stage resource for the Deployment resource to create. - StageName *string - - // The description for the deployment resource. - Description *string - // The API identifier. // // This member is required. ApiId *string + + // The description for the deployment resource. + Description *string + + // The name of the Stage resource for the Deployment resource to create. + StageName *string } type CreateDeploymentOutput struct { @@ -79,15 +79,15 @@ type CreateDeploymentOutput struct { // The date and time when the Deployment resource was created. CreatedDate *time.Time - // May contain additional feedback on the status of an API deployment. - DeploymentStatusMessage *string - // The identifier for the deployment. DeploymentId *string // The status of the deployment: PENDING, FAILED, or SUCCEEDED. DeploymentStatus types.DeploymentStatus + // May contain additional feedback on the status of an API deployment. + DeploymentStatusMessage *string + // The description for the deployment. Description *string diff --git a/service/apigatewayv2/api_op_CreateDomainName.go b/service/apigatewayv2/api_op_CreateDomainName.go index f5991b79d86..e4143d541cb 100644 --- a/service/apigatewayv2/api_op_CreateDomainName.go +++ b/service/apigatewayv2/api_op_CreateDomainName.go @@ -72,17 +72,17 @@ type CreateDomainNameInput struct { type CreateDomainNameOutput struct { - // The collection of tags associated with a domain name. - Tags map[string]*string - - // The domain name configurations. - DomainNameConfigurations []*types.DomainNameConfiguration + // The API mapping selection expression. + ApiMappingSelectionExpression *string // The name of the DomainName resource. DomainName *string - // The API mapping selection expression. - ApiMappingSelectionExpression *string + // The domain name configurations. + DomainNameConfigurations []*types.DomainNameConfiguration + + // The collection of tags associated with a domain name. + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigatewayv2/api_op_CreateIntegration.go b/service/apigatewayv2/api_op_CreateIntegration.go index 170c3c0a59a..e760d083bd7 100644 --- a/service/apigatewayv2/api_op_CreateIntegration.go +++ b/service/apigatewayv2/api_op_CreateIntegration.go @@ -58,42 +58,39 @@ func (c *Client) CreateIntegration(ctx context.Context, params *CreateIntegratio // Creates a new Integration resource to represent an integration. type CreateIntegrationInput struct { - // For a Lambda integration, specify the URI of a Lambda function. For an HTTP - // integration, specify a fully-qualified URL. For an HTTP API private integration, - // specify the ARN of an Application Load Balancer listener, Network Load Balancer - // listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map - // service, API Gateway uses DiscoverInstances to identify resources. You can use - // query parameters to target specific resources. To learn more, see - // DiscoverInstances - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html). - // For private integrations, all resources must be owned by the same AWS account. - IntegrationUri *string - // The API identifier. // // This member is required. ApiId *string + // The integration type of an integration. One of the following: AWS: for + // integrating the route or method request with an AWS service action, including + // the Lambda function-invoking action. With the Lambda function-invoking action, + // this is referred to as the Lambda custom integration. With any other AWS service + // action, this is known as AWS integration. Supported only for WebSocket APIs. + // AWS_PROXY: for integrating the route or method request with the Lambda + // function-invoking action with the client request passed through as-is. This + // integration is also referred to as Lambda proxy integration. HTTP: for + // integrating the route or method request with an HTTP endpoint. This integration + // is also referred to as the HTTP custom integration. Supported only for WebSocket + // APIs. HTTP_PROXY: for integrating the route or method request with an HTTP + // endpoint, with the client request passed through as-is. This is also referred to + // as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY + // integration. MOCK: for integrating the route or method request with API Gateway + // as a "loopback" endpoint without invoking any backend. Supported only for + // WebSocket APIs. + // + // This member is required. + IntegrationType types.IntegrationType + // The ID of the VPC link for a private integration. Supported only for HTTP APIs. ConnectionId *string - // Represents a map of Velocity templates that are applied on the request payload - // based on the value of the Content-Type header sent by the client. The content - // type value is the key in this map, and the template (as a String) is the value. - // Supported only for WebSocket APIs. - RequestTemplates map[string]*string - - // Specifies the credentials required for the integration, if any. For AWS - // integrations, three options are available. To specify an IAM Role for API - // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that - // the caller's identity be passed through from the request, specify the string - // arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS - // services, specify null. - CredentialsArn *string - - // Specifies the format of the payload sent to an integration. Required for HTTP - // APIs. - PayloadFormatVersion *string + // The type of the network connection to the integration endpoint. Specify INTERNET + // for connections through the public routable internet or VPC_LINK for private + // connections between API Gateway and resources in a VPC. The default value is + // INTERNET. + ConnectionType types.ConnectionType // Supported only for WebSocket APIs. Specifies how to handle response payload // content type conversions. Supported values are CONVERT_TO_BINARY and @@ -105,17 +102,30 @@ type CreateIntegrationInput struct { // method response without modification. ContentHandlingStrategy types.ContentHandlingStrategy - // Specifies the integration's HTTP method type. - IntegrationMethod *string + // Specifies the credentials required for the integration, if any. For AWS + // integrations, three options are available. To specify an IAM Role for API + // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that + // the caller's identity be passed through from the request, specify the string + // arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS + // services, specify null. + CredentialsArn *string // The description of the integration. Description *string - // The type of the network connection to the integration endpoint. Specify INTERNET - // for connections through the public routable internet or VPC_LINK for private - // connections between API Gateway and resources in a VPC. The default value is - // INTERNET. - ConnectionType types.ConnectionType + // Specifies the integration's HTTP method type. + IntegrationMethod *string + + // For a Lambda integration, specify the URI of a Lambda function. For an HTTP + // integration, specify a fully-qualified URL. For an HTTP API private integration, + // specify the ARN of an Application Load Balancer listener, Network Load Balancer + // listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map + // service, API Gateway uses DiscoverInstances to identify resources. You can use + // query parameters to target specific resources. To learn more, see + // DiscoverInstances + // (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html). + // For private integrations, all resources must be owned by the same AWS account. + IntegrationUri *string // Specifies the pass-through behavior for incoming requests based on the // Content-Type header in the request, and the available mapping templates @@ -130,38 +140,9 @@ type CreateIntegrationInput struct { // Type response. PassthroughBehavior types.PassthroughBehavior - // The integration type of an integration. One of the following: AWS: for - // integrating the route or method request with an AWS service action, including - // the Lambda function-invoking action. With the Lambda function-invoking action, - // this is referred to as the Lambda custom integration. With any other AWS service - // action, this is known as AWS integration. Supported only for WebSocket APIs. - // AWS_PROXY: for integrating the route or method request with the Lambda - // function-invoking action with the client request passed through as-is. This - // integration is also referred to as Lambda proxy integration. HTTP: for - // integrating the route or method request with an HTTP endpoint. This integration - // is also referred to as the HTTP custom integration. Supported only for WebSocket - // APIs. HTTP_PROXY: for integrating the route or method request with an HTTP - // endpoint, with the client request passed through as-is. This is also referred to - // as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY - // integration. MOCK: for integrating the route or method request with API Gateway - // as a "loopback" endpoint without invoking any backend. Supported only for - // WebSocket APIs. - // - // This member is required. - IntegrationType types.IntegrationType - - // The TLS configuration for a private integration. If you specify a TLS - // configuration, private integration traffic uses the HTTPS protocol. Supported - // only for HTTP APIs. - TlsConfig *types.TlsConfigInput - - // The template selection expression for the integration. - TemplateSelectionExpression *string - - // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between - // 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for - // WebSocket APIs and 30 seconds for HTTP APIs. - TimeoutInMillis *int32 + // Specifies the format of the payload sent to an integration. Required for HTTP + // APIs. + PayloadFormatVersion *string // A key-value map specifying request parameters that are passed from the method // request to the backend. The key is an integration request parameter name and the @@ -172,31 +153,6 @@ type CreateIntegrationInput struct { // header; and {name} must be a valid and unique method request parameter name. // Supported only for WebSocket APIs. RequestParameters map[string]*string -} - -type CreateIntegrationOutput struct { - - // Represents the identifier of an integration. - IntegrationId *string - - // Specifies the credentials required for the integration, if any. For AWS - // integrations, three options are available. To specify an IAM Role for API - // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that - // the caller's identity be passed through from the request, specify the string - // arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS - // services, specify null. - CredentialsArn *string - - // For a Lambda integration, specify the URI of a Lambda function. For an HTTP - // integration, specify a fully-qualified URL. For an HTTP API private integration, - // specify the ARN of an Application Load Balancer listener, Network Load Balancer - // listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map - // service, API Gateway uses DiscoverInstances to identify resources. You can use - // query parameters to target specific resources. To learn more, see - // DiscoverInstances - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html). - // For private integrations, all resources must be owned by the same AWS account. - IntegrationUri *string // Represents a map of Velocity templates that are applied on the request payload // based on the value of the Content-Type header sent by the client. The content @@ -204,10 +160,35 @@ type CreateIntegrationOutput struct { // Supported only for WebSocket APIs. RequestTemplates map[string]*string - // The integration response selection expression for the integration. Supported - // only for WebSocket APIs. See Integration Response Selection Expressions - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions). - IntegrationResponseSelectionExpression *string + // The template selection expression for the integration. + TemplateSelectionExpression *string + + // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between + // 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for + // WebSocket APIs and 30 seconds for HTTP APIs. + TimeoutInMillis *int32 + + // The TLS configuration for a private integration. If you specify a TLS + // configuration, private integration traffic uses the HTTPS protocol. Supported + // only for HTTP APIs. + TlsConfig *types.TlsConfigInput +} + +type CreateIntegrationOutput struct { + + // Specifies whether an integration is managed by API Gateway. If you created an + // API using using quick create, the resulting integration is managed by API + // Gateway. You can update a managed integration, but you can't delete it. + ApiGatewayManaged *bool + + // The ID of the VPC link for a private integration. Supported only for HTTP APIs. + ConnectionId *string + + // The type of the network connection to the integration endpoint. Specify INTERNET + // for connections through the public routable internet or VPC_LINK for private + // connections between API Gateway and resources in a VPC. The default value is + // INTERNET. + ConnectionType types.ConnectionType // Supported only for WebSocket APIs. Specifies how to handle response payload // content type conversions. Supported values are CONVERT_TO_BINARY and @@ -219,13 +200,27 @@ type CreateIntegrationOutput struct { // method response without modification. ContentHandlingStrategy types.ContentHandlingStrategy - // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between - // 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for - // WebSocket APIs and 30 seconds for HTTP APIs. - TimeoutInMillis *int32 + // Specifies the credentials required for the integration, if any. For AWS + // integrations, three options are available. To specify an IAM Role for API + // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that + // the caller's identity be passed through from the request, specify the string + // arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS + // services, specify null. + CredentialsArn *string - // The ID of the VPC link for a private integration. Supported only for HTTP APIs. - ConnectionId *string + // Represents the description of an integration. + Description *string + + // Represents the identifier of an integration. + IntegrationId *string + + // Specifies the integration's HTTP method type. + IntegrationMethod *string + + // The integration response selection expression for the integration. Supported + // only for WebSocket APIs. See Integration Response Selection Expressions + // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions). + IntegrationResponseSelectionExpression *string // The integration type of an integration. One of the following: AWS: for // integrating the route or method request with an AWS service action, including @@ -244,27 +239,29 @@ type CreateIntegrationOutput struct { // Supported only for WebSocket APIs. IntegrationType types.IntegrationType - // The TLS configuration for a private integration. If you specify a TLS - // configuration, private integration traffic uses the HTTPS protocol. Supported - // only for HTTP APIs. - TlsConfig *types.TlsConfig - - // The type of the network connection to the integration endpoint. Specify INTERNET - // for connections through the public routable internet or VPC_LINK for private - // connections between API Gateway and resources in a VPC. The default value is - // INTERNET. - ConnectionType types.ConnectionType - - // Specifies the integration's HTTP method type. - IntegrationMethod *string - - // Represents the description of an integration. - Description *string + // For a Lambda integration, specify the URI of a Lambda function. For an HTTP + // integration, specify a fully-qualified URL. For an HTTP API private integration, + // specify the ARN of an Application Load Balancer listener, Network Load Balancer + // listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map + // service, API Gateway uses DiscoverInstances to identify resources. You can use + // query parameters to target specific resources. To learn more, see + // DiscoverInstances + // (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html). + // For private integrations, all resources must be owned by the same AWS account. + IntegrationUri *string - // Specifies whether an integration is managed by API Gateway. If you created an - // API using using quick create, the resulting integration is managed by API - // Gateway. You can update a managed integration, but you can't delete it. - ApiGatewayManaged *bool + // Specifies the pass-through behavior for incoming requests based on the + // Content-Type header in the request, and the available mapping templates + // specified as the requestTemplates property on the Integration resource. There + // are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported + // only for WebSocket APIs. WHEN_NO_MATCH passes the request body for unmapped + // content types through to the integration backend without transformation. NEVER + // rejects unmapped content types with an HTTP 415 Unsupported Media Type response. + // WHEN_NO_TEMPLATES allows pass-through when the integration has no content types + // mapped to templates. However, if there is at least one content type defined, + // unmapped content types will be rejected with the same HTTP 415 Unsupported Media + // Type response. + PassthroughBehavior types.PassthroughBehavior // Specifies the format of the payload sent to an integration. Required for HTTP // APIs. @@ -280,22 +277,25 @@ type CreateIntegrationOutput struct { // Supported only for WebSocket APIs. RequestParameters map[string]*string + // Represents a map of Velocity templates that are applied on the request payload + // based on the value of the Content-Type header sent by the client. The content + // type value is the key in this map, and the template (as a String) is the value. + // Supported only for WebSocket APIs. + RequestTemplates map[string]*string + // The template selection expression for the integration. Supported only for // WebSocket APIs. TemplateSelectionExpression *string - // Specifies the pass-through behavior for incoming requests based on the - // Content-Type header in the request, and the available mapping templates - // specified as the requestTemplates property on the Integration resource. There - // are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported - // only for WebSocket APIs. WHEN_NO_MATCH passes the request body for unmapped - // content types through to the integration backend without transformation. NEVER - // rejects unmapped content types with an HTTP 415 Unsupported Media Type response. - // WHEN_NO_TEMPLATES allows pass-through when the integration has no content types - // mapped to templates. However, if there is at least one content type defined, - // unmapped content types will be rejected with the same HTTP 415 Unsupported Media - // Type response. - PassthroughBehavior types.PassthroughBehavior + // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between + // 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for + // WebSocket APIs and 30 seconds for HTTP APIs. + TimeoutInMillis *int32 + + // The TLS configuration for a private integration. If you specify a TLS + // configuration, private integration traffic uses the HTTPS protocol. Supported + // only for HTTP APIs. + TlsConfig *types.TlsConfig // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigatewayv2/api_op_CreateIntegrationResponse.go b/service/apigatewayv2/api_op_CreateIntegrationResponse.go index 376dc36d2eb..2178de92500 100644 --- a/service/apigatewayv2/api_op_CreateIntegrationResponse.go +++ b/service/apigatewayv2/api_op_CreateIntegrationResponse.go @@ -58,19 +58,15 @@ func (c *Client) CreateIntegrationResponse(ctx context.Context, params *CreateIn // Creates a new IntegrationResponse resource to represent an integration response. type CreateIntegrationResponseInput struct { - // The template selection expression for the integration response. Supported only - // for WebSocket APIs. - TemplateSelectionExpression *string - // The API identifier. // // This member is required. ApiId *string - // The collection of response templates for the integration response as a - // string-to-string map of key-value pairs. Response templates are represented as a - // key/value map, with a content-type as the key and a template as the value. - ResponseTemplates map[string]*string + // The integration ID. + // + // This member is required. + IntegrationId *string // The integration response key. // @@ -86,11 +82,6 @@ type CreateIntegrationResponseInput struct { // route response or method response without modification. ContentHandlingStrategy types.ContentHandlingStrategy - // The integration ID. - // - // This member is required. - IntegrationId *string - // A key-value map specifying response parameters that are passed to the method // response from the backend. The key is a method response header parameter name // and the mapped value is an integration response header value, a static value @@ -103,16 +94,35 @@ type CreateIntegrationResponseInput struct { // response header name and {JSON-expression} is a valid JSON expression without // the $ prefix. ResponseParameters map[string]*string + + // The collection of response templates for the integration response as a + // string-to-string map of key-value pairs. Response templates are represented as a + // key/value map, with a content-type as the key and a template as the value. + ResponseTemplates map[string]*string + + // The template selection expression for the integration response. Supported only + // for WebSocket APIs. + TemplateSelectionExpression *string } type CreateIntegrationResponseOutput struct { + // Supported only for WebSocket APIs. Specifies how to handle response payload + // content type conversions. Supported values are CONVERT_TO_BINARY and + // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a + // response payload from a Base64-encoded string to the corresponding binary blob. + // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a + // Base64-encoded string. If this property is not defined, the response payload + // will be passed through from the integration response to the route response or + // method response without modification. + ContentHandlingStrategy types.ContentHandlingStrategy + + // The integration response ID. + IntegrationResponseId *string + // The integration response key. IntegrationResponseKey *string - // The template selection expressions for the integration response. - TemplateSelectionExpression *string - // A key-value map specifying response parameters that are passed to the method // response from the backend. The key is a method response header parameter name // and the mapped value is an integration response header value, a static value @@ -126,23 +136,13 @@ type CreateIntegrationResponseOutput struct { // $ prefix. ResponseParameters map[string]*string - // The integration response ID. - IntegrationResponseId *string - // The collection of response templates for the integration response as a // string-to-string map of key-value pairs. Response templates are represented as a // key/value map, with a content-type as the key and a template as the value. ResponseTemplates map[string]*string - // Supported only for WebSocket APIs. Specifies how to handle response payload - // content type conversions. Supported values are CONVERT_TO_BINARY and - // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a - // response payload from a Base64-encoded string to the corresponding binary blob. - // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a - // Base64-encoded string. If this property is not defined, the response payload - // will be passed through from the integration response to the route response or - // method response without modification. - ContentHandlingStrategy types.ContentHandlingStrategy + // The template selection expressions for the integration response. + TemplateSelectionExpression *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigatewayv2/api_op_CreateModel.go b/service/apigatewayv2/api_op_CreateModel.go index e151993115c..61074fc7a8d 100644 --- a/service/apigatewayv2/api_op_CreateModel.go +++ b/service/apigatewayv2/api_op_CreateModel.go @@ -57,18 +57,15 @@ func (c *Client) CreateModel(ctx context.Context, params *CreateModelInput, optF // Creates a new Model. type CreateModelInput struct { - // The name of the model. Must be alphanumeric. - // - // This member is required. - Name *string - // The API identifier. // // This member is required. ApiId *string - // The content-type for the model, for example, "application/json". - ContentType *string + // The name of the model. Must be alphanumeric. + // + // This member is required. + Name *string // The schema for the model. For application/json models, this should be JSON // schema draft 4 model. @@ -76,24 +73,27 @@ type CreateModelInput struct { // This member is required. Schema *string + // The content-type for the model, for example, "application/json". + ContentType *string + // The description of the model. Description *string } type CreateModelOutput struct { - // The name of the model. Must be alphanumeric. - Name *string - - // The model identifier. - ModelId *string - // The content-type for the model, for example, "application/json". ContentType *string // The description of the model. Description *string + // The model identifier. + ModelId *string + + // The name of the model. Must be alphanumeric. + Name *string + // The schema for the model. For application/json models, this should be JSON // schema draft 4 model. Schema *string diff --git a/service/apigatewayv2/api_op_CreateRoute.go b/service/apigatewayv2/api_op_CreateRoute.go index 9260da078ca..44f925fc5d9 100644 --- a/service/apigatewayv2/api_op_CreateRoute.go +++ b/service/apigatewayv2/api_op_CreateRoute.go @@ -58,33 +58,22 @@ func (c *Client) CreateRoute(ctx context.Context, params *CreateRouteInput, optF // Creates a new Route resource to represent a route. type CreateRouteInput struct { - // The route key for the route. - // - // This member is required. - RouteKey *string - - // The operation name for the route. - OperationName *string - // The API identifier. // // This member is required. ApiId *string - // The model selection expression for the route. Supported only for WebSocket APIs. - ModelSelectionExpression *string - - // The identifier of the Authorizer resource to be associated with this route. The - // authorizer identifier is generated by API Gateway when you created the - // authorizer. - AuthorizerId *string - - // The request parameters for the route. Supported only for WebSocket APIs. - RequestParameters map[string]*types.ParameterConstraints + // The route key for the route. + // + // This member is required. + RouteKey *string - // The route response selection expression for the route. Supported only for + // Specifies whether an API key is required for the route. Supported only for // WebSocket APIs. - RouteResponseSelectionExpression *string + ApiKeyRequired *bool + + // The authorization scopes supported by this route. + AuthorizationScopes []*string // The authorization type for the route. For WebSocket APIs, valid values are NONE // for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a @@ -92,47 +81,38 @@ type CreateRouteInput struct { // for using JSON Web Tokens. AuthorizationType types.AuthorizationType - // Specifies whether an API key is required for the route. Supported only for - // WebSocket APIs. - ApiKeyRequired *bool + // The identifier of the Authorizer resource to be associated with this route. The + // authorizer identifier is generated by API Gateway when you created the + // authorizer. + AuthorizerId *string - // The authorization scopes supported by this route. - AuthorizationScopes []*string + // The model selection expression for the route. Supported only for WebSocket APIs. + ModelSelectionExpression *string - // The target for the route. - Target *string + // The operation name for the route. + OperationName *string // The request models for the route. Supported only for WebSocket APIs. RequestModels map[string]*string -} - -type CreateRouteOutput struct { - - // The target for the route. - Target *string // The request parameters for the route. Supported only for WebSocket APIs. RequestParameters map[string]*types.ParameterConstraints - // The identifier of the Authorizer resource to be associated with this route. The - // authorizer identifier is generated by API Gateway when you created the - // authorizer. - AuthorizerId *string + // The route response selection expression for the route. Supported only for + // WebSocket APIs. + RouteResponseSelectionExpression *string - // The route ID. - RouteId *string + // The target for the route. + Target *string +} - // The request models for the route. Supported only for WebSocket APIs. - RequestModels map[string]*string +type CreateRouteOutput struct { // Specifies whether a route is managed by API Gateway. If you created an API using // quick create, the $default route is managed by API Gateway. You can't modify the // $default route key. ApiGatewayManaged *bool - // The operation name for the route. - OperationName *string - // Specifies whether an API key is required for this route. Supported only for // WebSocket APIs. ApiKeyRequired *bool @@ -146,6 +126,32 @@ type CreateRouteOutput struct { // access token instead of an identity token for authorization purposes. AuthorizationScopes []*string + // The authorization type for the route. For WebSocket APIs, valid values are NONE + // for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a + // Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT + // for using JSON Web Tokens. + AuthorizationType types.AuthorizationType + + // The identifier of the Authorizer resource to be associated with this route. The + // authorizer identifier is generated by API Gateway when you created the + // authorizer. + AuthorizerId *string + + // The model selection expression for the route. Supported only for WebSocket APIs. + ModelSelectionExpression *string + + // The operation name for the route. + OperationName *string + + // The request models for the route. Supported only for WebSocket APIs. + RequestModels map[string]*string + + // The request parameters for the route. Supported only for WebSocket APIs. + RequestParameters map[string]*types.ParameterConstraints + + // The route ID. + RouteId *string + // The route key for the route. RouteKey *string @@ -153,14 +159,8 @@ type CreateRouteOutput struct { // WebSocket APIs. RouteResponseSelectionExpression *string - // The model selection expression for the route. Supported only for WebSocket APIs. - ModelSelectionExpression *string - - // The authorization type for the route. For WebSocket APIs, valid values are NONE - // for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a - // Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT - // for using JSON Web Tokens. - AuthorizationType types.AuthorizationType + // The target for the route. + Target *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigatewayv2/api_op_CreateRouteResponse.go b/service/apigatewayv2/api_op_CreateRouteResponse.go index e42fe0e86f2..b07fb0e23e3 100644 --- a/service/apigatewayv2/api_op_CreateRouteResponse.go +++ b/service/apigatewayv2/api_op_CreateRouteResponse.go @@ -58,17 +58,6 @@ func (c *Client) CreateRouteResponse(ctx context.Context, params *CreateRouteRes // Creates a new RouteResponse resource to represent a route response. type CreateRouteResponseInput struct { - // The route response parameters. - ResponseParameters map[string]*types.ParameterConstraints - - // The route response key. - // - // This member is required. - RouteResponseKey *string - - // The response models for the route response. - ResponseModels map[string]*string - // The API identifier. // // This member is required. @@ -79,29 +68,40 @@ type CreateRouteResponseInput struct { // This member is required. RouteId *string + // The route response key. + // + // This member is required. + RouteResponseKey *string + // The model selection expression for the route response. Supported only for // WebSocket APIs. ModelSelectionExpression *string + + // The response models for the route response. + ResponseModels map[string]*string + + // The route response parameters. + ResponseParameters map[string]*types.ParameterConstraints } type CreateRouteResponseOutput struct { + // Represents the model selection expression of a route response. Supported only + // for WebSocket APIs. + ModelSelectionExpression *string + // Represents the response models of a route response. ResponseModels map[string]*string - // Represents the identifier of a route response. - RouteResponseId *string - // Represents the response parameters of a route response. ResponseParameters map[string]*types.ParameterConstraints + // Represents the identifier of a route response. + RouteResponseId *string + // Represents the route response key of a route response. RouteResponseKey *string - // Represents the model selection expression of a route response. Supported only - // for WebSocket APIs. - ModelSelectionExpression *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigatewayv2/api_op_CreateStage.go b/service/apigatewayv2/api_op_CreateStage.go index 9d2e8aecd71..24b1ccb0b5e 100644 --- a/service/apigatewayv2/api_op_CreateStage.go +++ b/service/apigatewayv2/api_op_CreateStage.go @@ -59,62 +59,52 @@ func (c *Client) CreateStage(ctx context.Context, params *CreateStageInput, optF // Creates a new Stage resource to represent a stage. type CreateStageInput struct { - // A map that defines the stage variables for a Stage. Variable names can have - // alphanumeric and underscore characters, and the values must match - // [A-Za-z0-9-._~:/?#&=,]+. - StageVariables map[string]*string - - // The description for the API stage. - Description *string + // The API identifier. + // + // This member is required. + ApiId *string // The name of the stage. // // This member is required. StageName *string - // The deployment identifier of the API stage. - DeploymentId *string - // Settings for logging access in this stage. AccessLogSettings *types.AccessLogSettings - // Route settings for the stage, by routeKey. - RouteSettings map[string]*types.RouteSettings - - // The default route settings for the stage. - DefaultRouteSettings *types.RouteSettings - - // The collection of tags. Each tag element is associated with a given resource. - Tags map[string]*string - // Specifies whether updates to an API automatically trigger a new deployment. The // default value is false. AutoDeploy *bool - // The API identifier. - // - // This member is required. - ApiId *string - // The identifier of a client certificate for a Stage. Supported only for WebSocket // APIs. ClientCertificateId *string -} -type CreateStageOutput struct { + // The default route settings for the stage. + DefaultRouteSettings *types.RouteSettings + + // The deployment identifier of the API stage. + DeploymentId *string + + // The description for the API stage. + Description *string // Route settings for the stage, by routeKey. RouteSettings map[string]*types.RouteSettings - // The timestamp when the stage was created. - CreatedDate *time.Time + // A map that defines the stage variables for a Stage. Variable names can have + // alphanumeric and underscore characters, and the values must match + // [A-Za-z0-9-._~:/?#&=,]+. + StageVariables map[string]*string - // The identifier of the Deployment that the Stage is associated with. Can't be - // updated if autoDeploy is enabled. - DeploymentId *string + // The collection of tags. Each tag element is associated with a given resource. + Tags map[string]*string +} - // The timestamp when the stage was last updated. - LastUpdatedDate *time.Time +type CreateStageOutput struct { + + // Settings for logging access in this stage. + AccessLogSettings *types.AccessLogSettings // Specifies whether a stage is managed by API Gateway. If you created an API using // quick create, the $default stage is managed by API Gateway. You can't modify the @@ -125,18 +115,32 @@ type CreateStageOutput struct { // default value is false. AutoDeploy *bool - // Describes the status of the last deployment of a stage. Supported only for - // stages with autoDeploy enabled. - LastDeploymentStatusMessage *string + // The identifier of a client certificate for a Stage. Supported only for WebSocket + // APIs. + ClientCertificateId *string + + // The timestamp when the stage was created. + CreatedDate *time.Time // Default route settings for the stage. DefaultRouteSettings *types.RouteSettings - // The collection of tags. Each tag element is associated with a given resource. - Tags map[string]*string + // The identifier of the Deployment that the Stage is associated with. Can't be + // updated if autoDeploy is enabled. + DeploymentId *string - // Settings for logging access in this stage. - AccessLogSettings *types.AccessLogSettings + // The description of the stage. + Description *string + + // Describes the status of the last deployment of a stage. Supported only for + // stages with autoDeploy enabled. + LastDeploymentStatusMessage *string + + // The timestamp when the stage was last updated. + LastUpdatedDate *time.Time + + // Route settings for the stage, by routeKey. + RouteSettings map[string]*types.RouteSettings // The name of the stage. StageName *string @@ -146,12 +150,8 @@ type CreateStageOutput struct { // [A-Za-z0-9-._~:/?#&=,]+. StageVariables map[string]*string - // The identifier of a client certificate for a Stage. Supported only for WebSocket - // APIs. - ClientCertificateId *string - - // The description of the stage. - Description *string + // The collection of tags. Each tag element is associated with a given resource. + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigatewayv2/api_op_CreateVpcLink.go b/service/apigatewayv2/api_op_CreateVpcLink.go index 7a463da610b..9f05c56ec4d 100644 --- a/service/apigatewayv2/api_op_CreateVpcLink.go +++ b/service/apigatewayv2/api_op_CreateVpcLink.go @@ -69,29 +69,23 @@ type CreateVpcLinkInput struct { // This member is required. SubnetIds []*string - // A list of tags. - Tags map[string]*string - // A list of security group IDs for the VPC link. SecurityGroupIds []*string + + // A list of tags. + Tags map[string]*string } type CreateVpcLinkOutput struct { - // The status of the VPC link. - VpcLinkStatus types.VpcLinkStatus - - // The version of the VPC link. - VpcLinkVersion types.VpcLinkVersion + // The timestamp when the VPC link was created. + CreatedDate *time.Time // The name of the VPC link. Name *string - // The timestamp when the VPC link was created. - CreatedDate *time.Time - - // The ID of the VPC link. - VpcLinkId *string + // A list of security group IDs for the VPC link. + SecurityGroupIds []*string // A list of subnet IDs to include in the VPC link. SubnetIds []*string @@ -99,12 +93,18 @@ type CreateVpcLinkOutput struct { // Tags for the VPC link. Tags map[string]*string - // A list of security group IDs for the VPC link. - SecurityGroupIds []*string + // The ID of the VPC link. + VpcLinkId *string + + // The status of the VPC link. + VpcLinkStatus types.VpcLinkStatus // A message summarizing the cause of the status of the VPC link. VpcLinkStatusMessage *string + // The version of the VPC link. + VpcLinkVersion types.VpcLinkVersion + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigatewayv2/api_op_DeleteAccessLogSettings.go b/service/apigatewayv2/api_op_DeleteAccessLogSettings.go index 5e7ba0b638c..23c1724e950 100644 --- a/service/apigatewayv2/api_op_DeleteAccessLogSettings.go +++ b/service/apigatewayv2/api_op_DeleteAccessLogSettings.go @@ -57,16 +57,16 @@ func (c *Client) DeleteAccessLogSettings(ctx context.Context, params *DeleteAcce type DeleteAccessLogSettingsInput struct { - // The stage name. Stage names can only contain alphanumeric characters, hyphens, - // and underscores. Maximum length is 128 characters. + // The API identifier. // // This member is required. - StageName *string + ApiId *string - // The API identifier. + // The stage name. Stage names can only contain alphanumeric characters, hyphens, + // and underscores. Maximum length is 128 characters. // // This member is required. - ApiId *string + StageName *string } type DeleteAccessLogSettingsOutput struct { diff --git a/service/apigatewayv2/api_op_DeleteApiMapping.go b/service/apigatewayv2/api_op_DeleteApiMapping.go index 362bdea6f8c..2d84c20a303 100644 --- a/service/apigatewayv2/api_op_DeleteApiMapping.go +++ b/service/apigatewayv2/api_op_DeleteApiMapping.go @@ -56,15 +56,15 @@ func (c *Client) DeleteApiMapping(ctx context.Context, params *DeleteApiMappingI type DeleteApiMappingInput struct { - // The domain name. + // The API mapping identifier. // // This member is required. - DomainName *string + ApiMappingId *string - // The API mapping identifier. + // The domain name. // // This member is required. - ApiMappingId *string + DomainName *string } type DeleteApiMappingOutput struct { diff --git a/service/apigatewayv2/api_op_DeleteIntegrationResponse.go b/service/apigatewayv2/api_op_DeleteIntegrationResponse.go index 405c9357dbc..35657b20a90 100644 --- a/service/apigatewayv2/api_op_DeleteIntegrationResponse.go +++ b/service/apigatewayv2/api_op_DeleteIntegrationResponse.go @@ -56,6 +56,11 @@ func (c *Client) DeleteIntegrationResponse(ctx context.Context, params *DeleteIn type DeleteIntegrationResponseInput struct { + // The API identifier. + // + // This member is required. + ApiId *string + // The integration ID. // // This member is required. @@ -65,11 +70,6 @@ type DeleteIntegrationResponseInput struct { // // This member is required. IntegrationResponseId *string - - // The API identifier. - // - // This member is required. - ApiId *string } type DeleteIntegrationResponseOutput struct { diff --git a/service/apigatewayv2/api_op_DeleteModel.go b/service/apigatewayv2/api_op_DeleteModel.go index 644bcf736c5..9ef9cb27de7 100644 --- a/service/apigatewayv2/api_op_DeleteModel.go +++ b/service/apigatewayv2/api_op_DeleteModel.go @@ -56,15 +56,15 @@ func (c *Client) DeleteModel(ctx context.Context, params *DeleteModelInput, optF type DeleteModelInput struct { - // The model ID. + // The API identifier. // // This member is required. - ModelId *string + ApiId *string - // The API identifier. + // The model ID. // // This member is required. - ApiId *string + ModelId *string } type DeleteModelOutput struct { diff --git a/service/apigatewayv2/api_op_DeleteRouteRequestParameter.go b/service/apigatewayv2/api_op_DeleteRouteRequestParameter.go index c5367a35afe..1ad06d0eddc 100644 --- a/service/apigatewayv2/api_op_DeleteRouteRequestParameter.go +++ b/service/apigatewayv2/api_op_DeleteRouteRequestParameter.go @@ -56,20 +56,20 @@ func (c *Client) DeleteRouteRequestParameter(ctx context.Context, params *Delete type DeleteRouteRequestParameterInput struct { - // The route ID. + // The API identifier. // // This member is required. - RouteId *string + ApiId *string // The route request parameter key. // // This member is required. RequestParameterKey *string - // The API identifier. + // The route ID. // // This member is required. - ApiId *string + RouteId *string } type DeleteRouteRequestParameterOutput struct { diff --git a/service/apigatewayv2/api_op_DeleteRouteResponse.go b/service/apigatewayv2/api_op_DeleteRouteResponse.go index 3445de57e47..94143fd2c22 100644 --- a/service/apigatewayv2/api_op_DeleteRouteResponse.go +++ b/service/apigatewayv2/api_op_DeleteRouteResponse.go @@ -56,11 +56,6 @@ func (c *Client) DeleteRouteResponse(ctx context.Context, params *DeleteRouteRes type DeleteRouteResponseInput struct { - // The route response ID. - // - // This member is required. - RouteResponseId *string - // The API identifier. // // This member is required. @@ -70,6 +65,11 @@ type DeleteRouteResponseInput struct { // // This member is required. RouteId *string + + // The route response ID. + // + // This member is required. + RouteResponseId *string } type DeleteRouteResponseOutput struct { diff --git a/service/apigatewayv2/api_op_DeleteRouteSettings.go b/service/apigatewayv2/api_op_DeleteRouteSettings.go index 59dada671e5..21058fca43e 100644 --- a/service/apigatewayv2/api_op_DeleteRouteSettings.go +++ b/service/apigatewayv2/api_op_DeleteRouteSettings.go @@ -56,6 +56,11 @@ func (c *Client) DeleteRouteSettings(ctx context.Context, params *DeleteRouteSet type DeleteRouteSettingsInput struct { + // The API identifier. + // + // This member is required. + ApiId *string + // The route key. // // This member is required. @@ -66,11 +71,6 @@ type DeleteRouteSettingsInput struct { // // This member is required. StageName *string - - // The API identifier. - // - // This member is required. - ApiId *string } type DeleteRouteSettingsOutput struct { diff --git a/service/apigatewayv2/api_op_DeleteStage.go b/service/apigatewayv2/api_op_DeleteStage.go index 0dae6a6d717..7b5ac20a024 100644 --- a/service/apigatewayv2/api_op_DeleteStage.go +++ b/service/apigatewayv2/api_op_DeleteStage.go @@ -56,16 +56,16 @@ func (c *Client) DeleteStage(ctx context.Context, params *DeleteStageInput, optF type DeleteStageInput struct { - // The stage name. Stage names can only contain alphanumeric characters, hyphens, - // and underscores. Maximum length is 128 characters. + // The API identifier. // // This member is required. - StageName *string + ApiId *string - // The API identifier. + // The stage name. Stage names can only contain alphanumeric characters, hyphens, + // and underscores. Maximum length is 128 characters. // // This member is required. - ApiId *string + StageName *string } type DeleteStageOutput struct { diff --git a/service/apigatewayv2/api_op_ExportApi.go b/service/apigatewayv2/api_op_ExportApi.go index f3d80d3943a..78de1ef0a5f 100644 --- a/service/apigatewayv2/api_op_ExportApi.go +++ b/service/apigatewayv2/api_op_ExportApi.go @@ -55,34 +55,34 @@ func (c *Client) ExportApi(ctx context.Context, params *ExportApiInput, optFns . type ExportApiInput struct { - // The version of the API Gateway export algorithm. API Gateway uses the latest - // version by default. Currently, the only supported version is 1.0. - ExportVersion *string + // The API identifier. + // + // This member is required. + ApiId *string // The output type of the exported definition file. Valid values are JSON and YAML. // // This member is required. OutputType *string - // The name of the API stage to export. If you don't specify this property, a - // representation of the latest API configuration is exported. - StageName *string - - // The API identifier. + // The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only + // supported value. // // This member is required. - ApiId *string + Specification *string + + // The version of the API Gateway export algorithm. API Gateway uses the latest + // version by default. Currently, the only supported version is 1.0. + ExportVersion *string // Specifies whether to include API Gateway extensions // (https://docs.aws.amazon.com//apigateway/latest/developerguide/api-gateway-swagger-extensions.html) // in the exported API definition. API Gateway extensions are included by default. IncludeExtensions *bool - // The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only - // supported value. - // - // This member is required. - Specification *string + // The name of the API stage to export. If you don't specify this property, a + // representation of the latest API configuration is exported. + StageName *string } type ExportApiOutput struct { diff --git a/service/apigatewayv2/api_op_GetApi.go b/service/apigatewayv2/api_op_GetApi.go index de3592c083e..4b628e039cf 100644 --- a/service/apigatewayv2/api_op_GetApi.go +++ b/service/apigatewayv2/api_op_GetApi.go @@ -66,59 +66,59 @@ type GetApiInput struct { type GetApiOutput struct { - // The validation information during API import. This may include particular - // properties of your OpenAPI definition which are ignored during import. Supported - // only for HTTP APIs. - ImportInfo []*string + // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The + // stage name is typically appended to this URI to form a complete path to a + // deployed API stage. + ApiEndpoint *string - // The description of the API. - Description *string + // The API ID. + ApiId *string - // The route selection expression for the API. For HTTP APIs, the - // routeSelectionExpression must be ${request.method} ${request.path}. If not - // provided, this will be the default for HTTP APIs. This property is required for - // WebSocket APIs. - RouteSelectionExpression *string + // An API key selection expression. Supported only for WebSocket APIs. See API Key + // Selection Expressions + // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). + ApiKeySelectionExpression *string - // The API protocol. - ProtocolType types.ProtocolType + // A CORS configuration. Supported only for HTTP APIs. + CorsConfiguration *types.Cors + + // The timestamp when the API was created. + CreatedDate *time.Time + + // The description of the API. + Description *string // Avoid validating models when creating a deployment. Supported only for WebSocket // APIs. DisableSchemaValidation *bool + // The validation information during API import. This may include particular + // properties of your OpenAPI definition which are ignored during import. Supported + // only for HTTP APIs. + ImportInfo []*string + // The name of the API. Name *string - // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The - // stage name is typically appended to this URI to form a complete path to a - // deployed API stage. - ApiEndpoint *string - - // The timestamp when the API was created. - CreatedDate *time.Time - - // A version identifier for the API. - Version *string - - // A CORS configuration. Supported only for HTTP APIs. - CorsConfiguration *types.Cors + // The API protocol. + ProtocolType types.ProtocolType - // The API ID. - ApiId *string + // The route selection expression for the API. For HTTP APIs, the + // routeSelectionExpression must be ${request.method} ${request.path}. If not + // provided, this will be the default for HTTP APIs. This property is required for + // WebSocket APIs. + RouteSelectionExpression *string // A collection of tags associated with the API. Tags map[string]*string + // A version identifier for the API. + Version *string + // The warning messages reported when failonwarnings is turned on during API // import. Warnings []*string - // An API key selection expression. Supported only for WebSocket APIs. See API Key - // Selection Expressions - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). - ApiKeySelectionExpression *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigatewayv2/api_op_GetApiMapping.go b/service/apigatewayv2/api_op_GetApiMapping.go index ea517f2a7df..6f6419ff955 100644 --- a/service/apigatewayv2/api_op_GetApiMapping.go +++ b/service/apigatewayv2/api_op_GetApiMapping.go @@ -56,25 +56,25 @@ func (c *Client) GetApiMapping(ctx context.Context, params *GetApiMappingInput, type GetApiMappingInput struct { - // The domain name. + // The API mapping identifier. // // This member is required. - DomainName *string + ApiMappingId *string - // The API mapping identifier. + // The domain name. // // This member is required. - ApiMappingId *string + DomainName *string } type GetApiMappingOutput struct { - // The API mapping identifier. - ApiMappingId *string - // The API identifier. ApiId *string + // The API mapping identifier. + ApiMappingId *string + // The API mapping key. ApiMappingKey *string diff --git a/service/apigatewayv2/api_op_GetApiMappings.go b/service/apigatewayv2/api_op_GetApiMappings.go index c97b0096c99..38fd8bda437 100644 --- a/service/apigatewayv2/api_op_GetApiMappings.go +++ b/service/apigatewayv2/api_op_GetApiMappings.go @@ -57,17 +57,17 @@ func (c *Client) GetApiMappings(ctx context.Context, params *GetApiMappingsInput type GetApiMappingsInput struct { - // The next page of elements from this collection. Not valid for the last element - // of the collection. - NextToken *string - - // The maximum number of elements to be returned for this resource. - MaxResults *string - // The domain name. // // This member is required. DomainName *string + + // The maximum number of elements to be returned for this resource. + MaxResults *string + + // The next page of elements from this collection. Not valid for the last element + // of the collection. + NextToken *string } type GetApiMappingsOutput struct { diff --git a/service/apigatewayv2/api_op_GetApis.go b/service/apigatewayv2/api_op_GetApis.go index d41f04f580e..3d1e0a97d61 100644 --- a/service/apigatewayv2/api_op_GetApis.go +++ b/service/apigatewayv2/api_op_GetApis.go @@ -56,12 +56,12 @@ func (c *Client) GetApis(ctx context.Context, params *GetApisInput, optFns ...fu type GetApisInput struct { + // The maximum number of elements to be returned for this resource. + MaxResults *string + // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string - - // The maximum number of elements to be returned for this resource. - MaxResults *string } type GetApisOutput struct { diff --git a/service/apigatewayv2/api_op_GetAuthorizer.go b/service/apigatewayv2/api_op_GetAuthorizer.go index 9cf6e2b52d1..4a4d49beca7 100644 --- a/service/apigatewayv2/api_op_GetAuthorizer.go +++ b/service/apigatewayv2/api_op_GetAuthorizer.go @@ -57,28 +57,37 @@ func (c *Client) GetAuthorizer(ctx context.Context, params *GetAuthorizerInput, type GetAuthorizerInput struct { - // The authorizer identifier. + // The API identifier. // // This member is required. - AuthorizerId *string + ApiId *string - // The API identifier. + // The authorizer identifier. // // This member is required. - ApiId *string + AuthorizerId *string } type GetAuthorizerOutput struct { - // The name of the authorizer. - Name *string - // Specifies the required credentials as an IAM role for API Gateway to invoke the // authorizer. To specify an IAM role for API Gateway to assume, use the role's // Amazon Resource Name (ARN). To use resource-based permissions on the Lambda // function, specify null. Supported only for REQUEST authorizers. AuthorizerCredentialsArn *string + // The authorizer identifier. + AuthorizerId *string + + // Authorizer caching is not currently supported. Don't specify this value for + // authorizers. + AuthorizerResultTtlInSeconds *int32 + + // The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function + // using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web + // Tokens. + AuthorizerType types.AuthorizerType + // The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this // must be a well-formed Lambda function URI, for example, // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. @@ -91,16 +100,6 @@ type GetAuthorizerOutput struct { // authorizers. AuthorizerUri *string - // The authorizer identifier. - AuthorizerId *string - - // The validation expression does not apply to the REQUEST authorizer. - IdentityValidationExpression *string - - // Authorizer caching is not currently supported. Don't specify this value for - // authorizers. - AuthorizerResultTtlInSeconds *int32 - // The identity source for which authorization is requested. For a REQUEST // authorizer, this is optional. The value is a set of one or more mapping // expressions of the specified request parameters. Currently, the identity source @@ -118,15 +117,16 @@ type GetAuthorizerOutput struct { // "$request.header.Authorization". IdentitySource []*string - // The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function - // using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web - // Tokens. - AuthorizerType types.AuthorizerType + // The validation expression does not apply to the REQUEST authorizer. + IdentityValidationExpression *string // Represents the configuration of a JWT authorizer. Required for the JWT // authorizer type. Supported only for HTTP APIs. JwtConfiguration *types.JWTConfiguration + // The name of the authorizer. + Name *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigatewayv2/api_op_GetAuthorizers.go b/service/apigatewayv2/api_op_GetAuthorizers.go index a84b83c46c2..de21aebad37 100644 --- a/service/apigatewayv2/api_op_GetAuthorizers.go +++ b/service/apigatewayv2/api_op_GetAuthorizers.go @@ -57,28 +57,28 @@ func (c *Client) GetAuthorizers(ctx context.Context, params *GetAuthorizersInput type GetAuthorizersInput struct { + // The API identifier. + // + // This member is required. + ApiId *string + // The maximum number of elements to be returned for this resource. MaxResults *string // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string - - // The API identifier. - // - // This member is required. - ApiId *string } type GetAuthorizersOutput struct { + // The elements from this collection. + Items []*types.Authorizer + // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string - // The elements from this collection. - Items []*types.Authorizer - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigatewayv2/api_op_GetDeployment.go b/service/apigatewayv2/api_op_GetDeployment.go index af7f811c94b..4dd300e18f6 100644 --- a/service/apigatewayv2/api_op_GetDeployment.go +++ b/service/apigatewayv2/api_op_GetDeployment.go @@ -58,31 +58,31 @@ func (c *Client) GetDeployment(ctx context.Context, params *GetDeploymentInput, type GetDeploymentInput struct { - // The deployment ID. + // The API identifier. // // This member is required. - DeploymentId *string + ApiId *string - // The API identifier. + // The deployment ID. // // This member is required. - ApiId *string + DeploymentId *string } type GetDeploymentOutput struct { - // The identifier for the deployment. - DeploymentId *string + // Specifies whether a deployment was automatically released. + AutoDeployed *bool // The date and time when the Deployment resource was created. CreatedDate *time.Time + // The identifier for the deployment. + DeploymentId *string + // The status of the deployment: PENDING, FAILED, or SUCCEEDED. DeploymentStatus types.DeploymentStatus - // Specifies whether a deployment was automatically released. - AutoDeployed *bool - // May contain additional feedback on the status of an API deployment. DeploymentStatusMessage *string diff --git a/service/apigatewayv2/api_op_GetDeployments.go b/service/apigatewayv2/api_op_GetDeployments.go index 42ec3d019bb..f356695be56 100644 --- a/service/apigatewayv2/api_op_GetDeployments.go +++ b/service/apigatewayv2/api_op_GetDeployments.go @@ -57,28 +57,28 @@ func (c *Client) GetDeployments(ctx context.Context, params *GetDeploymentsInput type GetDeploymentsInput struct { - // The next page of elements from this collection. Not valid for the last element - // of the collection. - NextToken *string - - // The maximum number of elements to be returned for this resource. - MaxResults *string - // The API identifier. // // This member is required. ApiId *string -} -type GetDeploymentsOutput struct { + // The maximum number of elements to be returned for this resource. + MaxResults *string // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string +} + +type GetDeploymentsOutput struct { // The elements from this collection. Items []*types.Deployment + // The next page of elements from this collection. Not valid for the last element + // of the collection. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigatewayv2/api_op_GetDomainName.go b/service/apigatewayv2/api_op_GetDomainName.go index 456bc21ac04..4099a18fad2 100644 --- a/service/apigatewayv2/api_op_GetDomainName.go +++ b/service/apigatewayv2/api_op_GetDomainName.go @@ -65,17 +65,17 @@ type GetDomainNameInput struct { type GetDomainNameOutput struct { - // The collection of tags associated with a domain name. - Tags map[string]*string - - // The domain name configurations. - DomainNameConfigurations []*types.DomainNameConfiguration + // The API mapping selection expression. + ApiMappingSelectionExpression *string // The name of the DomainName resource. DomainName *string - // The API mapping selection expression. - ApiMappingSelectionExpression *string + // The domain name configurations. + DomainNameConfigurations []*types.DomainNameConfiguration + + // The collection of tags associated with a domain name. + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigatewayv2/api_op_GetDomainNames.go b/service/apigatewayv2/api_op_GetDomainNames.go index 5958bf1d6e2..2a93a360694 100644 --- a/service/apigatewayv2/api_op_GetDomainNames.go +++ b/service/apigatewayv2/api_op_GetDomainNames.go @@ -56,12 +56,12 @@ func (c *Client) GetDomainNames(ctx context.Context, params *GetDomainNamesInput type GetDomainNamesInput struct { + // The maximum number of elements to be returned for this resource. + MaxResults *string + // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string - - // The maximum number of elements to be returned for this resource. - MaxResults *string } type GetDomainNamesOutput struct { diff --git a/service/apigatewayv2/api_op_GetIntegration.go b/service/apigatewayv2/api_op_GetIntegration.go index 772c93bef88..82389d05b96 100644 --- a/service/apigatewayv2/api_op_GetIntegration.go +++ b/service/apigatewayv2/api_op_GetIntegration.go @@ -57,19 +57,65 @@ func (c *Client) GetIntegration(ctx context.Context, params *GetIntegrationInput type GetIntegrationInput struct { - // The integration ID. + // The API identifier. // // This member is required. - IntegrationId *string + ApiId *string - // The API identifier. + // The integration ID. // // This member is required. - ApiId *string + IntegrationId *string } type GetIntegrationOutput struct { + // Specifies whether an integration is managed by API Gateway. If you created an + // API using using quick create, the resulting integration is managed by API + // Gateway. You can update a managed integration, but you can't delete it. + ApiGatewayManaged *bool + + // The ID of the VPC link for a private integration. Supported only for HTTP APIs. + ConnectionId *string + + // The type of the network connection to the integration endpoint. Specify INTERNET + // for connections through the public routable internet or VPC_LINK for private + // connections between API Gateway and resources in a VPC. The default value is + // INTERNET. + ConnectionType types.ConnectionType + + // Supported only for WebSocket APIs. Specifies how to handle response payload + // content type conversions. Supported values are CONVERT_TO_BINARY and + // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a + // response payload from a Base64-encoded string to the corresponding binary blob. + // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a + // Base64-encoded string. If this property is not defined, the response payload + // will be passed through from the integration response to the route response or + // method response without modification. + ContentHandlingStrategy types.ContentHandlingStrategy + + // Specifies the credentials required for the integration, if any. For AWS + // integrations, three options are available. To specify an IAM Role for API + // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that + // the caller's identity be passed through from the request, specify the string + // arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS + // services, specify null. + CredentialsArn *string + + // Represents the description of an integration. + Description *string + + // Represents the identifier of an integration. + IntegrationId *string + + // Specifies the integration's HTTP method type. + IntegrationMethod *string + + // The integration response selection expression for the integration. Supported + // only for WebSocket APIs. See Integration Response Selection Expressions + // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions). + IntegrationResponseSelectionExpression *string + // The integration type of an integration. One of the following: AWS: for // integrating the route or method request with an AWS service action, including // the Lambda function-invoking action. With the Lambda function-invoking action, @@ -87,8 +133,16 @@ type GetIntegrationOutput struct { // Supported only for WebSocket APIs. IntegrationType types.IntegrationType - // Represents the description of an integration. - Description *string + // For a Lambda integration, specify the URI of a Lambda function. For an HTTP + // integration, specify a fully-qualified URL. For an HTTP API private integration, + // specify the ARN of an Application Load Balancer listener, Network Load Balancer + // listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map + // service, API Gateway uses DiscoverInstances to identify resources. You can use + // query parameters to target specific resources. To learn more, see + // DiscoverInstances + // (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html). + // For private integrations, all resources must be owned by the same AWS account. + IntegrationUri *string // Specifies the pass-through behavior for incoming requests based on the // Content-Type header in the request, and the available mapping templates @@ -103,94 +157,40 @@ type GetIntegrationOutput struct { // Type response. PassthroughBehavior types.PassthroughBehavior - // Specifies the integration's HTTP method type. - IntegrationMethod *string + // Specifies the format of the payload sent to an integration. Required for HTTP + // APIs. + PayloadFormatVersion *string + + // A key-value map specifying request parameters that are passed from the method + // request to the backend. The key is an integration request parameter name and the + // associated value is a method request parameter value or static value that must + // be enclosed within single quotes and pre-encoded as required by the backend. The + // method request parameter value must match the pattern of + // method.request.{location}.{name} , where {location} is querystring, path, or + // header; and {name} must be a valid and unique method request parameter name. + // Supported only for WebSocket APIs. + RequestParameters map[string]*string + + // Represents a map of Velocity templates that are applied on the request payload + // based on the value of the Content-Type header sent by the client. The content + // type value is the key in this map, and the template (as a String) is the value. + // Supported only for WebSocket APIs. + RequestTemplates map[string]*string // The template selection expression for the integration. Supported only for // WebSocket APIs. TemplateSelectionExpression *string - // The type of the network connection to the integration endpoint. Specify INTERNET - // for connections through the public routable internet or VPC_LINK for private - // connections between API Gateway and resources in a VPC. The default value is - // INTERNET. - ConnectionType types.ConnectionType - - // Specifies whether an integration is managed by API Gateway. If you created an - // API using using quick create, the resulting integration is managed by API - // Gateway. You can update a managed integration, but you can't delete it. - ApiGatewayManaged *bool - // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between // 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for // WebSocket APIs and 30 seconds for HTTP APIs. TimeoutInMillis *int32 - // Supported only for WebSocket APIs. Specifies how to handle response payload - // content type conversions. Supported values are CONVERT_TO_BINARY and - // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a - // response payload from a Base64-encoded string to the corresponding binary blob. - // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a - // Base64-encoded string. If this property is not defined, the response payload - // will be passed through from the integration response to the route response or - // method response without modification. - ContentHandlingStrategy types.ContentHandlingStrategy - // The TLS configuration for a private integration. If you specify a TLS // configuration, private integration traffic uses the HTTPS protocol. Supported // only for HTTP APIs. TlsConfig *types.TlsConfig - // Represents a map of Velocity templates that are applied on the request payload - // based on the value of the Content-Type header sent by the client. The content - // type value is the key in this map, and the template (as a String) is the value. - // Supported only for WebSocket APIs. - RequestTemplates map[string]*string - - // For a Lambda integration, specify the URI of a Lambda function. For an HTTP - // integration, specify a fully-qualified URL. For an HTTP API private integration, - // specify the ARN of an Application Load Balancer listener, Network Load Balancer - // listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map - // service, API Gateway uses DiscoverInstances to identify resources. You can use - // query parameters to target specific resources. To learn more, see - // DiscoverInstances - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html). - // For private integrations, all resources must be owned by the same AWS account. - IntegrationUri *string - - // The ID of the VPC link for a private integration. Supported only for HTTP APIs. - ConnectionId *string - - // Specifies the credentials required for the integration, if any. For AWS - // integrations, three options are available. To specify an IAM Role for API - // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that - // the caller's identity be passed through from the request, specify the string - // arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS - // services, specify null. - CredentialsArn *string - - // The integration response selection expression for the integration. Supported - // only for WebSocket APIs. See Integration Response Selection Expressions - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions). - IntegrationResponseSelectionExpression *string - - // Represents the identifier of an integration. - IntegrationId *string - - // A key-value map specifying request parameters that are passed from the method - // request to the backend. The key is an integration request parameter name and the - // associated value is a method request parameter value or static value that must - // be enclosed within single quotes and pre-encoded as required by the backend. The - // method request parameter value must match the pattern of - // method.request.{location}.{name} , where {location} is querystring, path, or - // header; and {name} must be a valid and unique method request parameter name. - // Supported only for WebSocket APIs. - RequestParameters map[string]*string - - // Specifies the format of the payload sent to an integration. Required for HTTP - // APIs. - PayloadFormatVersion *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigatewayv2/api_op_GetIntegrationResponse.go b/service/apigatewayv2/api_op_GetIntegrationResponse.go index a2585fab682..0d1e10b1e0a 100644 --- a/service/apigatewayv2/api_op_GetIntegrationResponse.go +++ b/service/apigatewayv2/api_op_GetIntegrationResponse.go @@ -75,17 +75,19 @@ type GetIntegrationResponseInput struct { type GetIntegrationResponseOutput struct { + // Supported only for WebSocket APIs. Specifies how to handle response payload + // content type conversions. Supported values are CONVERT_TO_BINARY and + // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a + // response payload from a Base64-encoded string to the corresponding binary blob. + // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a + // Base64-encoded string. If this property is not defined, the response payload + // will be passed through from the integration response to the route response or + // method response without modification. + ContentHandlingStrategy types.ContentHandlingStrategy + // The integration response ID. IntegrationResponseId *string - // The collection of response templates for the integration response as a - // string-to-string map of key-value pairs. Response templates are represented as a - // key/value map, with a content-type as the key and a template as the value. - ResponseTemplates map[string]*string - - // The template selection expressions for the integration response. - TemplateSelectionExpression *string - // The integration response key. IntegrationResponseKey *string @@ -102,15 +104,13 @@ type GetIntegrationResponseOutput struct { // $ prefix. ResponseParameters map[string]*string - // Supported only for WebSocket APIs. Specifies how to handle response payload - // content type conversions. Supported values are CONVERT_TO_BINARY and - // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a - // response payload from a Base64-encoded string to the corresponding binary blob. - // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a - // Base64-encoded string. If this property is not defined, the response payload - // will be passed through from the integration response to the route response or - // method response without modification. - ContentHandlingStrategy types.ContentHandlingStrategy + // The collection of response templates for the integration response as a + // string-to-string map of key-value pairs. Response templates are represented as a + // key/value map, with a content-type as the key and a template as the value. + ResponseTemplates map[string]*string + + // The template selection expressions for the integration response. + TemplateSelectionExpression *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigatewayv2/api_op_GetIntegrationResponses.go b/service/apigatewayv2/api_op_GetIntegrationResponses.go index a7d16f6a901..547b86c8685 100644 --- a/service/apigatewayv2/api_op_GetIntegrationResponses.go +++ b/service/apigatewayv2/api_op_GetIntegrationResponses.go @@ -57,22 +57,22 @@ func (c *Client) GetIntegrationResponses(ctx context.Context, params *GetIntegra type GetIntegrationResponsesInput struct { - // The next page of elements from this collection. Not valid for the last element - // of the collection. - NextToken *string - - // The maximum number of elements to be returned for this resource. - MaxResults *string + // The API identifier. + // + // This member is required. + ApiId *string // The integration ID. // // This member is required. IntegrationId *string - // The API identifier. - // - // This member is required. - ApiId *string + // The maximum number of elements to be returned for this resource. + MaxResults *string + + // The next page of elements from this collection. Not valid for the last element + // of the collection. + NextToken *string } type GetIntegrationResponsesOutput struct { diff --git a/service/apigatewayv2/api_op_GetIntegrations.go b/service/apigatewayv2/api_op_GetIntegrations.go index 194551a9721..af3764868de 100644 --- a/service/apigatewayv2/api_op_GetIntegrations.go +++ b/service/apigatewayv2/api_op_GetIntegrations.go @@ -62,23 +62,23 @@ type GetIntegrationsInput struct { // This member is required. ApiId *string + // The maximum number of elements to be returned for this resource. + MaxResults *string + // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string - - // The maximum number of elements to be returned for this resource. - MaxResults *string } type GetIntegrationsOutput struct { + // The elements from this collection. + Items []*types.Integration + // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string - // The elements from this collection. - Items []*types.Integration - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigatewayv2/api_op_GetModel.go b/service/apigatewayv2/api_op_GetModel.go index cb739c6d8bf..47d8379234e 100644 --- a/service/apigatewayv2/api_op_GetModel.go +++ b/service/apigatewayv2/api_op_GetModel.go @@ -69,22 +69,22 @@ type GetModelInput struct { type GetModelOutput struct { - // The name of the model. Must be alphanumeric. - Name *string + // The content-type for the model, for example, "application/json". + ContentType *string // The description of the model. Description *string - // The content-type for the model, for example, "application/json". - ContentType *string + // The model identifier. + ModelId *string + + // The name of the model. Must be alphanumeric. + Name *string // The schema for the model. For application/json models, this should be JSON // schema draft 4 model. Schema *string - // The model identifier. - ModelId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigatewayv2/api_op_GetModels.go b/service/apigatewayv2/api_op_GetModels.go index 441055c07e7..f8ebdba8e83 100644 --- a/service/apigatewayv2/api_op_GetModels.go +++ b/service/apigatewayv2/api_op_GetModels.go @@ -57,17 +57,17 @@ func (c *Client) GetModels(ctx context.Context, params *GetModelsInput, optFns . type GetModelsInput struct { + // The API identifier. + // + // This member is required. + ApiId *string + // The maximum number of elements to be returned for this resource. MaxResults *string // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string - - // The API identifier. - // - // This member is required. - ApiId *string } type GetModelsOutput struct { diff --git a/service/apigatewayv2/api_op_GetRoute.go b/service/apigatewayv2/api_op_GetRoute.go index f93aa072f8f..a3bcaaf4c77 100644 --- a/service/apigatewayv2/api_op_GetRoute.go +++ b/service/apigatewayv2/api_op_GetRoute.go @@ -75,8 +75,9 @@ type GetRouteOutput struct { // $default route key. ApiGatewayManaged *bool - // The request parameters for the route. Supported only for WebSocket APIs. - RequestParameters map[string]*types.ParameterConstraints + // Specifies whether an API key is required for this route. Supported only for + // WebSocket APIs. + ApiKeyRequired *bool // A list of authorization scopes configured on a route. The scopes are used with a // JWT authorizer to authorize the method invocation. The authorization works by @@ -87,42 +88,41 @@ type GetRouteOutput struct { // access token instead of an identity token for authorization purposes. AuthorizationScopes []*string - // The target for the route. - Target *string - - // The request models for the route. Supported only for WebSocket APIs. - RequestModels map[string]*string - - // The route ID. - RouteId *string - - // The route response selection expression for the route. Supported only for - // WebSocket APIs. - RouteResponseSelectionExpression *string + // The authorization type for the route. For WebSocket APIs, valid values are NONE + // for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a + // Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT + // for using JSON Web Tokens. + AuthorizationType types.AuthorizationType // The identifier of the Authorizer resource to be associated with this route. The // authorizer identifier is generated by API Gateway when you created the // authorizer. AuthorizerId *string - // The route key for the route. - RouteKey *string + // The model selection expression for the route. Supported only for WebSocket APIs. + ModelSelectionExpression *string // The operation name for the route. OperationName *string - // Specifies whether an API key is required for this route. Supported only for - // WebSocket APIs. - ApiKeyRequired *bool + // The request models for the route. Supported only for WebSocket APIs. + RequestModels map[string]*string - // The model selection expression for the route. Supported only for WebSocket APIs. - ModelSelectionExpression *string + // The request parameters for the route. Supported only for WebSocket APIs. + RequestParameters map[string]*types.ParameterConstraints - // The authorization type for the route. For WebSocket APIs, valid values are NONE - // for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a - // Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT - // for using JSON Web Tokens. - AuthorizationType types.AuthorizationType + // The route ID. + RouteId *string + + // The route key for the route. + RouteKey *string + + // The route response selection expression for the route. Supported only for + // WebSocket APIs. + RouteResponseSelectionExpression *string + + // The target for the route. + Target *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigatewayv2/api_op_GetRouteResponse.go b/service/apigatewayv2/api_op_GetRouteResponse.go index 422d74c67d7..09d88179754 100644 --- a/service/apigatewayv2/api_op_GetRouteResponse.go +++ b/service/apigatewayv2/api_op_GetRouteResponse.go @@ -57,20 +57,20 @@ func (c *Client) GetRouteResponse(ctx context.Context, params *GetRouteResponseI type GetRouteResponseInput struct { - // The route response ID. + // The API identifier. // // This member is required. - RouteResponseId *string + ApiId *string // The route ID. // // This member is required. RouteId *string - // The API identifier. + // The route response ID. // // This member is required. - ApiId *string + RouteResponseId *string } type GetRouteResponseOutput struct { @@ -82,14 +82,14 @@ type GetRouteResponseOutput struct { // Represents the response models of a route response. ResponseModels map[string]*string - // Represents the route response key of a route response. - RouteResponseKey *string + // Represents the response parameters of a route response. + ResponseParameters map[string]*types.ParameterConstraints // Represents the identifier of a route response. RouteResponseId *string - // Represents the response parameters of a route response. - ResponseParameters map[string]*types.ParameterConstraints + // Represents the route response key of a route response. + RouteResponseKey *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigatewayv2/api_op_GetRouteResponses.go b/service/apigatewayv2/api_op_GetRouteResponses.go index 58c1e360eb7..874731945fc 100644 --- a/service/apigatewayv2/api_op_GetRouteResponses.go +++ b/service/apigatewayv2/api_op_GetRouteResponses.go @@ -57,22 +57,22 @@ func (c *Client) GetRouteResponses(ctx context.Context, params *GetRouteResponse type GetRouteResponsesInput struct { - // The maximum number of elements to be returned for this resource. - MaxResults *string + // The API identifier. + // + // This member is required. + ApiId *string // The route ID. // // This member is required. RouteId *string + // The maximum number of elements to be returned for this resource. + MaxResults *string + // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string - - // The API identifier. - // - // This member is required. - ApiId *string } type GetRouteResponsesOutput struct { diff --git a/service/apigatewayv2/api_op_GetRoutes.go b/service/apigatewayv2/api_op_GetRoutes.go index 8573ce4f040..a54592498ef 100644 --- a/service/apigatewayv2/api_op_GetRoutes.go +++ b/service/apigatewayv2/api_op_GetRoutes.go @@ -72,13 +72,13 @@ type GetRoutesInput struct { type GetRoutesOutput struct { + // The elements from this collection. + Items []*types.Route + // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string - // The elements from this collection. - Items []*types.Route - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigatewayv2/api_op_GetStage.go b/service/apigatewayv2/api_op_GetStage.go index 689273fffc5..a2f8e48dd6c 100644 --- a/service/apigatewayv2/api_op_GetStage.go +++ b/service/apigatewayv2/api_op_GetStage.go @@ -58,20 +58,23 @@ func (c *Client) GetStage(ctx context.Context, params *GetStageInput, optFns ... type GetStageInput struct { - // The stage name. Stage names can only contain alphanumeric characters, hyphens, - // and underscores. Maximum length is 128 characters. + // The API identifier. // // This member is required. - StageName *string + ApiId *string - // The API identifier. + // The stage name. Stage names can only contain alphanumeric characters, hyphens, + // and underscores. Maximum length is 128 characters. // // This member is required. - ApiId *string + StageName *string } type GetStageOutput struct { + // Settings for logging access in this stage. + AccessLogSettings *types.AccessLogSettings + // Specifies whether a stage is managed by API Gateway. If you created an API using // quick create, the $default stage is managed by API Gateway. You can't modify the // $default stage. @@ -81,11 +84,9 @@ type GetStageOutput struct { // default value is false. AutoDeploy *bool - // The timestamp when the stage was last updated. - LastUpdatedDate *time.Time - - // The description of the stage. - Description *string + // The identifier of a client certificate for a Stage. Supported only for WebSocket + // APIs. + ClientCertificateId *string // The timestamp when the stage was created. CreatedDate *time.Time @@ -97,19 +98,18 @@ type GetStageOutput struct { // updated if autoDeploy is enabled. DeploymentId *string + // The description of the stage. + Description *string + // Describes the status of the last deployment of a stage. Supported only for // stages with autoDeploy enabled. LastDeploymentStatusMessage *string - // Settings for logging access in this stage. - AccessLogSettings *types.AccessLogSettings - - // The collection of tags. Each tag element is associated with a given resource. - Tags map[string]*string + // The timestamp when the stage was last updated. + LastUpdatedDate *time.Time - // The identifier of a client certificate for a Stage. Supported only for WebSocket - // APIs. - ClientCertificateId *string + // Route settings for the stage, by routeKey. + RouteSettings map[string]*types.RouteSettings // The name of the stage. StageName *string @@ -119,8 +119,8 @@ type GetStageOutput struct { // [A-Za-z0-9-._~:/?#&=,]+. StageVariables map[string]*string - // Route settings for the stage, by routeKey. - RouteSettings map[string]*types.RouteSettings + // The collection of tags. Each tag element is associated with a given resource. + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigatewayv2/api_op_GetStages.go b/service/apigatewayv2/api_op_GetStages.go index 544fd16dfc6..320bd2ad4fc 100644 --- a/service/apigatewayv2/api_op_GetStages.go +++ b/service/apigatewayv2/api_op_GetStages.go @@ -72,13 +72,13 @@ type GetStagesInput struct { type GetStagesOutput struct { + // The elements from this collection. + Items []*types.Stage + // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string - // The elements from this collection. - Items []*types.Stage - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigatewayv2/api_op_GetVpcLink.go b/service/apigatewayv2/api_op_GetVpcLink.go index e7c18eca118..4569b7377b3 100644 --- a/service/apigatewayv2/api_op_GetVpcLink.go +++ b/service/apigatewayv2/api_op_GetVpcLink.go @@ -66,29 +66,29 @@ type GetVpcLinkInput struct { type GetVpcLinkOutput struct { + // The timestamp when the VPC link was created. + CreatedDate *time.Time + + // The name of the VPC link. + Name *string + // A list of security group IDs for the VPC link. SecurityGroupIds []*string // A list of subnet IDs to include in the VPC link. SubnetIds []*string - // The name of the VPC link. - Name *string - - // A message summarizing the cause of the status of the VPC link. - VpcLinkStatusMessage *string + // Tags for the VPC link. + Tags map[string]*string // The ID of the VPC link. VpcLinkId *string - // Tags for the VPC link. - Tags map[string]*string - // The status of the VPC link. VpcLinkStatus types.VpcLinkStatus - // The timestamp when the VPC link was created. - CreatedDate *time.Time + // A message summarizing the cause of the status of the VPC link. + VpcLinkStatusMessage *string // The version of the VPC link. VpcLinkVersion types.VpcLinkVersion diff --git a/service/apigatewayv2/api_op_ImportApi.go b/service/apigatewayv2/api_op_ImportApi.go index c95364cb59c..8618fac88b4 100644 --- a/service/apigatewayv2/api_op_ImportApi.go +++ b/service/apigatewayv2/api_op_ImportApi.go @@ -59,6 +59,11 @@ func (c *Client) ImportApi(ctx context.Context, params *ImportApiInput, optFns . // type ImportApiInput struct { + // The OpenAPI definition. Supported only for HTTP APIs. + // + // This member is required. + Body *string + // Specifies how to interpret the base path of the API during import. Valid values // are ignore, prepend, and split. The default value is ignore. To learn more, see // Set the OpenAPI basePath Property @@ -66,11 +71,6 @@ type ImportApiInput struct { // Supported only for HTTP APIs. Basepath *string - // The OpenAPI definition. Supported only for HTTP APIs. - // - // This member is required. - Body *string - // Specifies whether to rollback the API creation when a warning is encountered. By // default, API creation continues if a warning is encountered. FailOnWarnings *bool @@ -78,49 +78,42 @@ type ImportApiInput struct { type ImportApiOutput struct { + // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The + // stage name is typically appended to this URI to form a complete path to a + // deployed API stage. + ApiEndpoint *string + + // The API ID. + ApiId *string + // An API key selection expression. Supported only for WebSocket APIs. See API Key // Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). ApiKeySelectionExpression *string - // The name of the API. - Name *string - - // A version identifier for the API. - Version *string - - // The validation information during API import. This may include particular - // properties of your OpenAPI definition which are ignored during import. Supported - // only for HTTP APIs. - ImportInfo []*string - - // The warning messages reported when failonwarnings is turned on during API - // import. - Warnings []*string - - // The timestamp when the API was created. - CreatedDate *time.Time - // A CORS configuration. Supported only for HTTP APIs. CorsConfiguration *types.Cors - // A collection of tags associated with the API. - Tags map[string]*string + // The timestamp when the API was created. + CreatedDate *time.Time - // The API ID. - ApiId *string + // The description of the API. + Description *string // Avoid validating models when creating a deployment. Supported only for WebSocket // APIs. DisableSchemaValidation *bool - // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The - // stage name is typically appended to this URI to form a complete path to a - // deployed API stage. - ApiEndpoint *string + // The validation information during API import. This may include particular + // properties of your OpenAPI definition which are ignored during import. Supported + // only for HTTP APIs. + ImportInfo []*string - // The description of the API. - Description *string + // The name of the API. + Name *string + + // The API protocol. + ProtocolType types.ProtocolType // The route selection expression for the API. For HTTP APIs, the // routeSelectionExpression must be ${request.method} ${request.path}. If not @@ -128,8 +121,15 @@ type ImportApiOutput struct { // WebSocket APIs. RouteSelectionExpression *string - // The API protocol. - ProtocolType types.ProtocolType + // A collection of tags associated with the API. + Tags map[string]*string + + // A version identifier for the API. + Version *string + + // The warning messages reported when failonwarnings is turned on during API + // import. + Warnings []*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigatewayv2/api_op_ReimportApi.go b/service/apigatewayv2/api_op_ReimportApi.go index 3ad8d62391c..1ef4a808f3a 100644 --- a/service/apigatewayv2/api_op_ReimportApi.go +++ b/service/apigatewayv2/api_op_ReimportApi.go @@ -59,15 +59,16 @@ func (c *Client) ReimportApi(ctx context.Context, params *ReimportApiInput, optF // type ReimportApiInput struct { + // The API identifier. + // + // This member is required. + ApiId *string + // The OpenAPI definition. Supported only for HTTP APIs. // // This member is required. Body *string - // Specifies whether to rollback the API creation when a warning is encountered. By - // default, API creation continues if a warning is encountered. - FailOnWarnings *bool - // Specifies how to interpret the base path of the API during import. Valid values // are ignore, prepend, and split. The default value is ignore. To learn more, see // Set the OpenAPI basePath Property @@ -75,67 +76,66 @@ type ReimportApiInput struct { // Supported only for HTTP APIs. Basepath *string - // The API identifier. - // - // This member is required. - ApiId *string + // Specifies whether to rollback the API creation when a warning is encountered. By + // default, API creation continues if a warning is encountered. + FailOnWarnings *bool } type ReimportApiOutput struct { - // The validation information during API import. This may include particular - // properties of your OpenAPI definition which are ignored during import. Supported - // only for HTTP APIs. - ImportInfo []*string - - // Avoid validating models when creating a deployment. Supported only for WebSocket - // APIs. - DisableSchemaValidation *bool + // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The + // stage name is typically appended to this URI to form a complete path to a + // deployed API stage. + ApiEndpoint *string - // A collection of tags associated with the API. - Tags map[string]*string + // The API ID. + ApiId *string // An API key selection expression. Supported only for WebSocket APIs. See API Key // Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). ApiKeySelectionExpression *string - // The API ID. - ApiId *string + // A CORS configuration. Supported only for HTTP APIs. + CorsConfiguration *types.Cors + + // The timestamp when the API was created. + CreatedDate *time.Time // The description of the API. Description *string + // Avoid validating models when creating a deployment. Supported only for WebSocket + // APIs. + DisableSchemaValidation *bool + + // The validation information during API import. This may include particular + // properties of your OpenAPI definition which are ignored during import. Supported + // only for HTTP APIs. + ImportInfo []*string + + // The name of the API. + Name *string + + // The API protocol. + ProtocolType types.ProtocolType + // The route selection expression for the API. For HTTP APIs, the // routeSelectionExpression must be ${request.method} ${request.path}. If not // provided, this will be the default for HTTP APIs. This property is required for // WebSocket APIs. RouteSelectionExpression *string - // The API protocol. - ProtocolType types.ProtocolType - - // The timestamp when the API was created. - CreatedDate *time.Time + // A collection of tags associated with the API. + Tags map[string]*string - // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The - // stage name is typically appended to this URI to form a complete path to a - // deployed API stage. - ApiEndpoint *string + // A version identifier for the API. + Version *string // The warning messages reported when failonwarnings is turned on during API // import. Warnings []*string - // The name of the API. - Name *string - - // A CORS configuration. Supported only for HTTP APIs. - CorsConfiguration *types.Cors - - // A version identifier for the API. - Version *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigatewayv2/api_op_UntagResource.go b/service/apigatewayv2/api_op_UntagResource.go index ee18cf97ebc..94e75f64059 100644 --- a/service/apigatewayv2/api_op_UntagResource.go +++ b/service/apigatewayv2/api_op_UntagResource.go @@ -56,15 +56,15 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The Tag keys to delete + // The resource ARN for the tag. // // This member is required. - TagKeys []*string + ResourceArn *string - // The resource ARN for the tag. + // The Tag keys to delete // // This member is required. - ResourceArn *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/apigatewayv2/api_op_UpdateApi.go b/service/apigatewayv2/api_op_UpdateApi.go index 650750c6c04..1f2ec79b5ce 100644 --- a/service/apigatewayv2/api_op_UpdateApi.go +++ b/service/apigatewayv2/api_op_UpdateApi.go @@ -59,6 +59,16 @@ func (c *Client) UpdateApi(ctx context.Context, params *UpdateApiInput, optFns . // Updates an Api. type UpdateApiInput struct { + // The API identifier. + // + // This member is required. + ApiId *string + + // An API key selection expression. Supported only for WebSocket APIs. See API Key + // Selection Expressions + // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). + ApiKeySelectionExpression *string + // A CORS configuration. Supported only for HTTP APIs. CorsConfiguration *types.Cors @@ -72,18 +82,28 @@ type UpdateApiInput struct { // with the quick create integration. Supported only for HTTP APIs. CredentialsArn *string - // A version identifier for the API. - Version *string - // The description of the API. Description *string + // Avoid validating models when creating a deployment. Supported only for WebSocket + // APIs. + DisableSchemaValidation *bool + + // The name of the API. + Name *string + // This property is part of quick create. If not specified, the route created using // quick create is kept. Otherwise, this value replaces the route key of the quick // create route. Additional routes may still be added after the API is updated. // Supported only for HTTP APIs. RouteKey *string + // The route selection expression for the API. For HTTP APIs, the + // routeSelectionExpression must be ${request.method} ${request.path}. If not + // provided, this will be the default for HTTP APIs. This property is required for + // WebSocket APIs. + RouteSelectionExpression *string + // This property is part of quick create. For HTTP integrations, specify a fully // qualified URL. For Lambda integrations, specify a function ARN. The type of the // integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided @@ -91,53 +111,45 @@ type UpdateApiInput struct { // target, but you can't remove it from an API. Supported only for HTTP APIs. Target *string - // The route selection expression for the API. For HTTP APIs, the - // routeSelectionExpression must be ${request.method} ${request.path}. If not - // provided, this will be the default for HTTP APIs. This property is required for - // WebSocket APIs. - RouteSelectionExpression *string + // A version identifier for the API. + Version *string +} + +type UpdateApiOutput struct { + + // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The + // stage name is typically appended to this URI to form a complete path to a + // deployed API stage. + ApiEndpoint *string + + // The API ID. + ApiId *string // An API key selection expression. Supported only for WebSocket APIs. See API Key // Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). ApiKeySelectionExpression *string - // The name of the API. - Name *string - - // Avoid validating models when creating a deployment. Supported only for WebSocket - // APIs. - DisableSchemaValidation *bool - - // The API identifier. - // - // This member is required. - ApiId *string -} + // A CORS configuration. Supported only for HTTP APIs. + CorsConfiguration *types.Cors -type UpdateApiOutput struct { + // The timestamp when the API was created. + CreatedDate *time.Time // The description of the API. Description *string - // An API key selection expression. Supported only for WebSocket APIs. See API Key - // Selection Expressions - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). - ApiKeySelectionExpression *string + // Avoid validating models when creating a deployment. Supported only for WebSocket + // APIs. + DisableSchemaValidation *bool // The validation information during API import. This may include particular // properties of your OpenAPI definition which are ignored during import. Supported // only for HTTP APIs. ImportInfo []*string - // Avoid validating models when creating a deployment. Supported only for WebSocket - // APIs. - DisableSchemaValidation *bool - - // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The - // stage name is typically appended to this URI to form a complete path to a - // deployed API stage. - ApiEndpoint *string + // The name of the API. + Name *string // The API protocol. ProtocolType types.ProtocolType @@ -148,28 +160,16 @@ type UpdateApiOutput struct { // WebSocket APIs. RouteSelectionExpression *string - // A CORS configuration. Supported only for HTTP APIs. - CorsConfiguration *types.Cors - - // The warning messages reported when failonwarnings is turned on during API - // import. - Warnings []*string - - // The name of the API. - Name *string - - // The API ID. - ApiId *string - // A collection of tags associated with the API. Tags map[string]*string - // The timestamp when the API was created. - CreatedDate *time.Time - // A version identifier for the API. Version *string + // The warning messages reported when failonwarnings is turned on during API + // import. + Warnings []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigatewayv2/api_op_UpdateApiMapping.go b/service/apigatewayv2/api_op_UpdateApiMapping.go index f78eb7f3491..26f78ea72e0 100644 --- a/service/apigatewayv2/api_op_UpdateApiMapping.go +++ b/service/apigatewayv2/api_op_UpdateApiMapping.go @@ -62,36 +62,36 @@ type UpdateApiMappingInput struct { // This member is required. ApiId *string + // The API mapping identifier. + // + // This member is required. + ApiMappingId *string + // The domain name. // // This member is required. DomainName *string - // The API stage. - Stage *string - // The API mapping key. ApiMappingKey *string - // The API mapping identifier. - // - // This member is required. - ApiMappingId *string + // The API stage. + Stage *string } type UpdateApiMappingOutput struct { - // The API stage. - Stage *string - // The API identifier. ApiId *string + // The API mapping identifier. + ApiMappingId *string + // The API mapping key. ApiMappingKey *string - // The API mapping identifier. - ApiMappingId *string + // The API stage. + Stage *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigatewayv2/api_op_UpdateAuthorizer.go b/service/apigatewayv2/api_op_UpdateAuthorizer.go index 0a856b89682..6eaa82b14af 100644 --- a/service/apigatewayv2/api_op_UpdateAuthorizer.go +++ b/service/apigatewayv2/api_op_UpdateAuthorizer.go @@ -58,6 +58,43 @@ func (c *Client) UpdateAuthorizer(ctx context.Context, params *UpdateAuthorizerI // Updates an Authorizer. type UpdateAuthorizerInput struct { + // The API identifier. + // + // This member is required. + ApiId *string + + // The authorizer identifier. + // + // This member is required. + AuthorizerId *string + + // Specifies the required credentials as an IAM role for API Gateway to invoke the + // authorizer. To specify an IAM role for API Gateway to assume, use the role's + // Amazon Resource Name (ARN). To use resource-based permissions on the Lambda + // function, specify null. + AuthorizerCredentialsArn *string + + // Authorizer caching is not currently supported. Don't specify this value for + // authorizers. + AuthorizerResultTtlInSeconds *int32 + + // The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function + // using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web + // Tokens. + AuthorizerType types.AuthorizerType + + // The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, + // this must be a well-formed Lambda function URI, for example, + // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. + // In general, the URI has this form: + // arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the + // same as the region hosting the Lambda function, path indicates that the + // remaining substring in the URI should be treated as the path to the resource, + // including the initial /. For Lambda functions, this is usually of the form + // /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST + // authorizers. + AuthorizerUri *string + // The identity source for which authorization is requested. For a REQUEST // authorizer, this is optional. The value is a set of one or more mapping // expressions of the specified request parameters. Currently, the identity source @@ -75,43 +112,39 @@ type UpdateAuthorizerInput struct { // "$request.header.Authorization". IdentitySource []*string - // The name of the authorizer. - Name *string + // This parameter is not used. + IdentityValidationExpression *string // Represents the configuration of a JWT authorizer. Required for the JWT // authorizer type. Supported only for HTTP APIs. JwtConfiguration *types.JWTConfiguration - // The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function - // using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web - // Tokens. - AuthorizerType types.AuthorizerType - - // The API identifier. - // - // This member is required. - ApiId *string + // The name of the authorizer. + Name *string +} - // This parameter is not used. - IdentityValidationExpression *string +type UpdateAuthorizerOutput struct { // Specifies the required credentials as an IAM role for API Gateway to invoke the // authorizer. To specify an IAM role for API Gateway to assume, use the role's // Amazon Resource Name (ARN). To use resource-based permissions on the Lambda - // function, specify null. + // function, specify null. Supported only for REQUEST authorizers. AuthorizerCredentialsArn *string // The authorizer identifier. - // - // This member is required. AuthorizerId *string // Authorizer caching is not currently supported. Don't specify this value for // authorizers. AuthorizerResultTtlInSeconds *int32 - // The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, - // this must be a well-formed Lambda function URI, for example, + // The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function + // using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web + // Tokens. + AuthorizerType types.AuthorizerType + + // The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this + // must be a well-formed Lambda function URI, for example, // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. // In general, the URI has this form: // arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the @@ -121,9 +154,6 @@ type UpdateAuthorizerInput struct { // /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST // authorizers. AuthorizerUri *string -} - -type UpdateAuthorizerOutput struct { // The identity source for which authorization is requested. For a REQUEST // authorizer, this is optional. The value is a set of one or more mapping @@ -142,45 +172,15 @@ type UpdateAuthorizerOutput struct { // "$request.header.Authorization". IdentitySource []*string - // The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this - // must be a well-formed Lambda function URI, for example, - // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. - // In general, the URI has this form: - // arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the - // same as the region hosting the Lambda function, path indicates that the - // remaining substring in the URI should be treated as the path to the resource, - // including the initial /. For Lambda functions, this is usually of the form - // /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST - // authorizers. - AuthorizerUri *string - - // The name of the authorizer. - Name *string - // The validation expression does not apply to the REQUEST authorizer. IdentityValidationExpression *string - // Specifies the required credentials as an IAM role for API Gateway to invoke the - // authorizer. To specify an IAM role for API Gateway to assume, use the role's - // Amazon Resource Name (ARN). To use resource-based permissions on the Lambda - // function, specify null. Supported only for REQUEST authorizers. - AuthorizerCredentialsArn *string - - // Authorizer caching is not currently supported. Don't specify this value for - // authorizers. - AuthorizerResultTtlInSeconds *int32 - - // The authorizer identifier. - AuthorizerId *string - // Represents the configuration of a JWT authorizer. Required for the JWT // authorizer type. Supported only for HTTP APIs. JwtConfiguration *types.JWTConfiguration - // The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function - // using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web - // Tokens. - AuthorizerType types.AuthorizerType + // The name of the authorizer. + Name *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigatewayv2/api_op_UpdateDeployment.go b/service/apigatewayv2/api_op_UpdateDeployment.go index d17665566b6..1ba6b8fcd30 100644 --- a/service/apigatewayv2/api_op_UpdateDeployment.go +++ b/service/apigatewayv2/api_op_UpdateDeployment.go @@ -59,15 +59,15 @@ func (c *Client) UpdateDeployment(ctx context.Context, params *UpdateDeploymentI // Updates a Deployment. type UpdateDeploymentInput struct { - // The deployment ID. + // The API identifier. // // This member is required. - DeploymentId *string + ApiId *string - // The API identifier. + // The deployment ID. // // This member is required. - ApiId *string + DeploymentId *string // The description for the deployment resource. Description *string @@ -75,24 +75,24 @@ type UpdateDeploymentInput struct { type UpdateDeploymentOutput struct { - // The identifier for the deployment. - DeploymentId *string - - // The description for the deployment. - Description *string - - // The status of the deployment: PENDING, FAILED, or SUCCEEDED. - DeploymentStatus types.DeploymentStatus - // Specifies whether a deployment was automatically released. AutoDeployed *bool // The date and time when the Deployment resource was created. CreatedDate *time.Time + // The identifier for the deployment. + DeploymentId *string + + // The status of the deployment: PENDING, FAILED, or SUCCEEDED. + DeploymentStatus types.DeploymentStatus + // May contain additional feedback on the status of an API deployment. DeploymentStatusMessage *string + // The description for the deployment. + Description *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigatewayv2/api_op_UpdateDomainName.go b/service/apigatewayv2/api_op_UpdateDomainName.go index f2d49f228f8..20869251073 100644 --- a/service/apigatewayv2/api_op_UpdateDomainName.go +++ b/service/apigatewayv2/api_op_UpdateDomainName.go @@ -58,22 +58,16 @@ func (c *Client) UpdateDomainName(ctx context.Context, params *UpdateDomainNameI // Updates a DomainName. type UpdateDomainNameInput struct { - // The domain name configurations. - DomainNameConfigurations []*types.DomainNameConfiguration - // The domain name. // // This member is required. DomainName *string -} - -type UpdateDomainNameOutput struct { // The domain name configurations. DomainNameConfigurations []*types.DomainNameConfiguration +} - // The collection of tags associated with a domain name. - Tags map[string]*string +type UpdateDomainNameOutput struct { // The API mapping selection expression. ApiMappingSelectionExpression *string @@ -81,6 +75,12 @@ type UpdateDomainNameOutput struct { // The name of the DomainName resource. DomainName *string + // The domain name configurations. + DomainNameConfigurations []*types.DomainNameConfiguration + + // The collection of tags associated with a domain name. + Tags map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigatewayv2/api_op_UpdateIntegration.go b/service/apigatewayv2/api_op_UpdateIntegration.go index 0ff3c96406c..f466be13d9e 100644 --- a/service/apigatewayv2/api_op_UpdateIntegration.go +++ b/service/apigatewayv2/api_op_UpdateIntegration.go @@ -58,59 +58,19 @@ func (c *Client) UpdateIntegration(ctx context.Context, params *UpdateIntegratio // Updates an Integration. type UpdateIntegrationInput struct { - // Specifies the format of the payload sent to an integration. Required for HTTP - // APIs. - PayloadFormatVersion *string - - // The TLS configuration for a private integration. If you specify a TLS - // configuration, private integration traffic uses the HTTPS protocol. Supported - // only for HTTP APIs. - TlsConfig *types.TlsConfigInput - - // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between - // 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for - // WebSocket APIs and 30 seconds for HTTP APIs. - TimeoutInMillis *int32 - - // The description of the integration - Description *string - // The API identifier. // // This member is required. ApiId *string - // The integration type of an integration. One of the following: AWS: for - // integrating the route or method request with an AWS service action, including - // the Lambda function-invoking action. With the Lambda function-invoking action, - // this is referred to as the Lambda custom integration. With any other AWS service - // action, this is known as AWS integration. Supported only for WebSocket APIs. - // AWS_PROXY: for integrating the route or method request with the Lambda - // function-invoking action with the client request passed through as-is. This - // integration is also referred to as Lambda proxy integration. HTTP: for - // integrating the route or method request with an HTTP endpoint. This integration - // is also referred to as the HTTP custom integration. Supported only for WebSocket - // APIs. HTTP_PROXY: for integrating the route or method request with an HTTP - // endpoint, with the client request passed through as-is. This is also referred to - // as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY - // integration. MOCK: for integrating the route or method request with API Gateway - // as a "loopback" endpoint without invoking any backend. Supported only for - // WebSocket APIs. - IntegrationType types.IntegrationType - - // Specifies the credentials required for the integration, if any. For AWS - // integrations, three options are available. To specify an IAM Role for API - // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that - // the caller's identity be passed through from the request, specify the string - // arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS - // services, specify null. - CredentialsArn *string - // The integration ID. // // This member is required. IntegrationId *string + // The ID of the VPC link for a private integration. Supported only for HTTP APIs. + ConnectionId *string + // The type of the network connection to the integration endpoint. Specify INTERNET // for connections through the public routable internet or VPC_LINK for private // connections between API Gateway and resources in a VPC. The default value is @@ -127,18 +87,37 @@ type UpdateIntegrationInput struct { // method response without modification. ContentHandlingStrategy types.ContentHandlingStrategy - // The template selection expression for the integration. - TemplateSelectionExpression *string + // Specifies the credentials required for the integration, if any. For AWS + // integrations, three options are available. To specify an IAM Role for API + // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that + // the caller's identity be passed through from the request, specify the string + // arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS + // services, specify null. + CredentialsArn *string - // A key-value map specifying request parameters that are passed from the method - // request to the backend. The key is an integration request parameter name and the - // associated value is a method request parameter value or static value that must - // be enclosed within single quotes and pre-encoded as required by the backend. The - // method request parameter value must match the pattern of - // method.request.{location}.{name} , where {location} is querystring, path, or - // header; and {name} must be a valid and unique method request parameter name. - // Supported only for WebSocket APIs. - RequestParameters map[string]*string + // The description of the integration + Description *string + + // Specifies the integration's HTTP method type. + IntegrationMethod *string + + // The integration type of an integration. One of the following: AWS: for + // integrating the route or method request with an AWS service action, including + // the Lambda function-invoking action. With the Lambda function-invoking action, + // this is referred to as the Lambda custom integration. With any other AWS service + // action, this is known as AWS integration. Supported only for WebSocket APIs. + // AWS_PROXY: for integrating the route or method request with the Lambda + // function-invoking action with the client request passed through as-is. This + // integration is also referred to as Lambda proxy integration. HTTP: for + // integrating the route or method request with an HTTP endpoint. This integration + // is also referred to as the HTTP custom integration. Supported only for WebSocket + // APIs. HTTP_PROXY: for integrating the route or method request with an HTTP + // endpoint, with the client request passed through as-is. This is also referred to + // as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY + // integration. MOCK: for integrating the route or method request with API Gateway + // as a "loopback" endpoint without invoking any backend. Supported only for + // WebSocket APIs. + IntegrationType types.IntegrationType // For a Lambda integration, specify the URI of a Lambda function. For an HTTP // integration, specify a fully-qualified URL. For an HTTP API private integration, @@ -151,9 +130,6 @@ type UpdateIntegrationInput struct { // For private integrations, all resources must be owned by the same AWS account. IntegrationUri *string - // Specifies the integration's HTTP method type. - IntegrationMethod *string - // Specifies the pass-through behavior for incoming requests based on the // Content-Type header in the request, and the available mapping templates // specified as the requestTemplates property on the Integration resource. There @@ -167,18 +143,56 @@ type UpdateIntegrationInput struct { // Type response. PassthroughBehavior types.PassthroughBehavior + // Specifies the format of the payload sent to an integration. Required for HTTP + // APIs. + PayloadFormatVersion *string + + // A key-value map specifying request parameters that are passed from the method + // request to the backend. The key is an integration request parameter name and the + // associated value is a method request parameter value or static value that must + // be enclosed within single quotes and pre-encoded as required by the backend. The + // method request parameter value must match the pattern of + // method.request.{location}.{name} , where {location} is querystring, path, or + // header; and {name} must be a valid and unique method request parameter name. + // Supported only for WebSocket APIs. + RequestParameters map[string]*string + // Represents a map of Velocity templates that are applied on the request payload // based on the value of the Content-Type header sent by the client. The content // type value is the key in this map, and the template (as a String) is the value. // Supported only for WebSocket APIs. RequestTemplates map[string]*string - // The ID of the VPC link for a private integration. Supported only for HTTP APIs. - ConnectionId *string + // The template selection expression for the integration. + TemplateSelectionExpression *string + + // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between + // 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for + // WebSocket APIs and 30 seconds for HTTP APIs. + TimeoutInMillis *int32 + + // The TLS configuration for a private integration. If you specify a TLS + // configuration, private integration traffic uses the HTTPS protocol. Supported + // only for HTTP APIs. + TlsConfig *types.TlsConfigInput } type UpdateIntegrationOutput struct { + // Specifies whether an integration is managed by API Gateway. If you created an + // API using using quick create, the resulting integration is managed by API + // Gateway. You can update a managed integration, but you can't delete it. + ApiGatewayManaged *bool + + // The ID of the VPC link for a private integration. Supported only for HTTP APIs. + ConnectionId *string + + // The type of the network connection to the integration endpoint. Specify INTERNET + // for connections through the public routable internet or VPC_LINK for private + // connections between API Gateway and resources in a VPC. The default value is + // INTERNET. + ConnectionType types.ConnectionType + // Supported only for WebSocket APIs. Specifies how to handle response payload // content type conversions. Supported values are CONVERT_TO_BINARY and // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a @@ -189,11 +203,6 @@ type UpdateIntegrationOutput struct { // method response without modification. ContentHandlingStrategy types.ContentHandlingStrategy - // Specifies whether an integration is managed by API Gateway. If you created an - // API using using quick create, the resulting integration is managed by API - // Gateway. You can update a managed integration, but you can't delete it. - ApiGatewayManaged *bool - // Specifies the credentials required for the integration, if any. For AWS // integrations, three options are available. To specify an IAM Role for API // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that @@ -202,20 +211,20 @@ type UpdateIntegrationOutput struct { // services, specify null. CredentialsArn *string + // Represents the description of an integration. + Description *string + + // Represents the identifier of an integration. + IntegrationId *string + + // Specifies the integration's HTTP method type. + IntegrationMethod *string + // The integration response selection expression for the integration. Supported // only for WebSocket APIs. See Integration Response Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions). IntegrationResponseSelectionExpression *string - // Represents the description of an integration. - Description *string - - // Represents a map of Velocity templates that are applied on the request payload - // based on the value of the Content-Type header sent by the client. The content - // type value is the key in this map, and the template (as a String) is the value. - // Supported only for WebSocket APIs. - RequestTemplates map[string]*string - // The integration type of an integration. One of the following: AWS: for // integrating the route or method request with an AWS service action, including // the Lambda function-invoking action. With the Lambda function-invoking action, @@ -244,23 +253,6 @@ type UpdateIntegrationOutput struct { // For private integrations, all resources must be owned by the same AWS account. IntegrationUri *string - // The ID of the VPC link for a private integration. Supported only for HTTP APIs. - ConnectionId *string - - // The TLS configuration for a private integration. If you specify a TLS - // configuration, private integration traffic uses the HTTPS protocol. Supported - // only for HTTP APIs. - TlsConfig *types.TlsConfig - - // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between - // 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for - // WebSocket APIs and 30 seconds for HTTP APIs. - TimeoutInMillis *int32 - - // Specifies the format of the payload sent to an integration. Required for HTTP - // APIs. - PayloadFormatVersion *string - // Specifies the pass-through behavior for incoming requests based on the // Content-Type header in the request, and the available mapping templates // specified as the requestTemplates property on the Integration resource. There @@ -274,21 +266,9 @@ type UpdateIntegrationOutput struct { // Type response. PassthroughBehavior types.PassthroughBehavior - // Specifies the integration's HTTP method type. - IntegrationMethod *string - - // The type of the network connection to the integration endpoint. Specify INTERNET - // for connections through the public routable internet or VPC_LINK for private - // connections between API Gateway and resources in a VPC. The default value is - // INTERNET. - ConnectionType types.ConnectionType - - // The template selection expression for the integration. Supported only for - // WebSocket APIs. - TemplateSelectionExpression *string - - // Represents the identifier of an integration. - IntegrationId *string + // Specifies the format of the payload sent to an integration. Required for HTTP + // APIs. + PayloadFormatVersion *string // A key-value map specifying request parameters that are passed from the method // request to the backend. The key is an integration request parameter name and the @@ -300,6 +280,26 @@ type UpdateIntegrationOutput struct { // Supported only for WebSocket APIs. RequestParameters map[string]*string + // Represents a map of Velocity templates that are applied on the request payload + // based on the value of the Content-Type header sent by the client. The content + // type value is the key in this map, and the template (as a String) is the value. + // Supported only for WebSocket APIs. + RequestTemplates map[string]*string + + // The template selection expression for the integration. Supported only for + // WebSocket APIs. + TemplateSelectionExpression *string + + // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between + // 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for + // WebSocket APIs and 30 seconds for HTTP APIs. + TimeoutInMillis *int32 + + // The TLS configuration for a private integration. If you specify a TLS + // configuration, private integration traffic uses the HTTPS protocol. Supported + // only for HTTP APIs. + TlsConfig *types.TlsConfig + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigatewayv2/api_op_UpdateIntegrationResponse.go b/service/apigatewayv2/api_op_UpdateIntegrationResponse.go index 23b62c48d0f..eb14d462191 100644 --- a/service/apigatewayv2/api_op_UpdateIntegrationResponse.go +++ b/service/apigatewayv2/api_op_UpdateIntegrationResponse.go @@ -58,6 +58,34 @@ func (c *Client) UpdateIntegrationResponse(ctx context.Context, params *UpdateIn // Updates an IntegrationResponses. type UpdateIntegrationResponseInput struct { + // The API identifier. + // + // This member is required. + ApiId *string + + // The integration ID. + // + // This member is required. + IntegrationId *string + + // The integration response ID. + // + // This member is required. + IntegrationResponseId *string + + // Supported only for WebSocket APIs. Specifies how to handle response payload + // content type conversions. Supported values are CONVERT_TO_BINARY and + // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a + // response payload from a Base64-encoded string to the corresponding binary blob. + // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a + // Base64-encoded string. If this property is not defined, the response payload + // will be passed through from the integration response to the route response or + // method response without modification. + ContentHandlingStrategy types.ContentHandlingStrategy + + // The integration response key. + IntegrationResponseKey *string + // A key-value map specifying response parameters that are passed to the method // response from the backend. The key is a method response header parameter name // and the mapped value is an integration response header value, a static value @@ -79,16 +107,9 @@ type UpdateIntegrationResponseInput struct { // The template selection expression for the integration response. Supported only // for WebSocket APIs. TemplateSelectionExpression *string +} - // The API identifier. - // - // This member is required. - ApiId *string - - // The integration response ID. - // - // This member is required. - IntegrationResponseId *string +type UpdateIntegrationResponseOutput struct { // Supported only for WebSocket APIs. Specifies how to handle response payload // content type conversions. Supported values are CONVERT_TO_BINARY and @@ -100,19 +121,11 @@ type UpdateIntegrationResponseInput struct { // method response without modification. ContentHandlingStrategy types.ContentHandlingStrategy - // The integration ID. - // - // This member is required. - IntegrationId *string + // The integration response ID. + IntegrationResponseId *string // The integration response key. IntegrationResponseKey *string -} - -type UpdateIntegrationResponseOutput struct { - - // The template selection expressions for the integration response. - TemplateSelectionExpression *string // A key-value map specifying response parameters that are passed to the method // response from the backend. The key is a method response header parameter name @@ -127,26 +140,13 @@ type UpdateIntegrationResponseOutput struct { // $ prefix. ResponseParameters map[string]*string - // The integration response key. - IntegrationResponseKey *string - // The collection of response templates for the integration response as a // string-to-string map of key-value pairs. Response templates are represented as a // key/value map, with a content-type as the key and a template as the value. ResponseTemplates map[string]*string - // The integration response ID. - IntegrationResponseId *string - - // Supported only for WebSocket APIs. Specifies how to handle response payload - // content type conversions. Supported values are CONVERT_TO_BINARY and - // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a - // response payload from a Base64-encoded string to the corresponding binary blob. - // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a - // Base64-encoded string. If this property is not defined, the response payload - // will be passed through from the integration response to the route response or - // method response without modification. - ContentHandlingStrategy types.ContentHandlingStrategy + // The template selection expressions for the integration response. + TemplateSelectionExpression *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigatewayv2/api_op_UpdateModel.go b/service/apigatewayv2/api_op_UpdateModel.go index 201e475d28a..c440b670b65 100644 --- a/service/apigatewayv2/api_op_UpdateModel.go +++ b/service/apigatewayv2/api_op_UpdateModel.go @@ -67,38 +67,38 @@ type UpdateModelInput struct { // This member is required. ModelId *string - // The schema for the model. For application/json models, this should be JSON - // schema draft 4 model. - Schema *string - - // The name of the model. - Name *string - // The content-type for the model, for example, "application/json". ContentType *string // The description of the model. Description *string -} -type UpdateModelOutput struct { + // The name of the model. + Name *string // The schema for the model. For application/json models, this should be JSON // schema draft 4 model. Schema *string +} - // The description of the model. - Description *string +type UpdateModelOutput struct { // The content-type for the model, for example, "application/json". ContentType *string - // The name of the model. Must be alphanumeric. - Name *string + // The description of the model. + Description *string // The model identifier. ModelId *string + // The name of the model. Must be alphanumeric. + Name *string + + // The schema for the model. For application/json models, this should be JSON + // schema draft 4 model. + Schema *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigatewayv2/api_op_UpdateRoute.go b/service/apigatewayv2/api_op_UpdateRoute.go index 25a0c310c73..bc5beb3a658 100644 --- a/service/apigatewayv2/api_op_UpdateRoute.go +++ b/service/apigatewayv2/api_op_UpdateRoute.go @@ -58,11 +58,22 @@ func (c *Client) UpdateRoute(ctx context.Context, params *UpdateRouteInput, optF // Updates a Route. type UpdateRouteInput struct { - // The request models for the route. Supported only for WebSocket APIs. - RequestModels map[string]*string + // The API identifier. + // + // This member is required. + ApiId *string - // The request parameters for the route. Supported only for WebSocket APIs. - RequestParameters map[string]*types.ParameterConstraints + // The route ID. + // + // This member is required. + RouteId *string + + // Specifies whether an API key is required for the route. Supported only for + // WebSocket APIs. + ApiKeyRequired *bool + + // The authorization scopes supported by this route. + AuthorizationScopes []*string // The authorization type for the route. For WebSocket APIs, valid values are NONE // for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a @@ -70,20 +81,25 @@ type UpdateRouteInput struct { // for using JSON Web Tokens. AuthorizationType types.AuthorizationType - // The route ID. - // - // This member is required. - RouteId *string - // The identifier of the Authorizer resource to be associated with this route. The // authorizer identifier is generated by API Gateway when you created the // authorizer. AuthorizerId *string - // The API identifier. - // - // This member is required. - ApiId *string + // The model selection expression for the route. Supported only for WebSocket APIs. + ModelSelectionExpression *string + + // The operation name for the route. + OperationName *string + + // The request models for the route. Supported only for WebSocket APIs. + RequestModels map[string]*string + + // The request parameters for the route. Supported only for WebSocket APIs. + RequestParameters map[string]*types.ParameterConstraints + + // The route key for the route. + RouteKey *string // The route response selection expression for the route. Supported only for // WebSocket APIs. @@ -91,25 +107,27 @@ type UpdateRouteInput struct { // The target for the route. Target *string +} - // The model selection expression for the route. Supported only for WebSocket APIs. - ModelSelectionExpression *string +type UpdateRouteOutput struct { - // The authorization scopes supported by this route. - AuthorizationScopes []*string + // Specifies whether a route is managed by API Gateway. If you created an API using + // quick create, the $default route is managed by API Gateway. You can't modify the + // $default route key. + ApiGatewayManaged *bool - // Specifies whether an API key is required for the route. Supported only for + // Specifies whether an API key is required for this route. Supported only for // WebSocket APIs. ApiKeyRequired *bool - // The route key for the route. - RouteKey *string - - // The operation name for the route. - OperationName *string -} - -type UpdateRouteOutput struct { + // A list of authorization scopes configured on a route. The scopes are used with a + // JWT authorizer to authorize the method invocation. The authorization works by + // matching the route scopes against the scopes parsed from the access token in the + // incoming request. The method invocation is authorized if any route scope matches + // a claimed scope in the access token. Otherwise, the invocation is not + // authorized. When the route scope is configured, the client must provide an + // access token instead of an identity token for authorization purposes. + AuthorizationScopes []*string // The authorization type for the route. For WebSocket APIs, valid values are NONE // for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a @@ -117,53 +135,35 @@ type UpdateRouteOutput struct { // for using JSON Web Tokens. AuthorizationType types.AuthorizationType - // Specifies whether an API key is required for this route. Supported only for - // WebSocket APIs. - ApiKeyRequired *bool - - // The request parameters for the route. Supported only for WebSocket APIs. - RequestParameters map[string]*types.ParameterConstraints - - // The request models for the route. Supported only for WebSocket APIs. - RequestModels map[string]*string - - // The target for the route. - Target *string - // The identifier of the Authorizer resource to be associated with this route. The // authorizer identifier is generated by API Gateway when you created the // authorizer. AuthorizerId *string - // The route ID. - RouteId *string - - // The route response selection expression for the route. Supported only for - // WebSocket APIs. - RouteResponseSelectionExpression *string - // The model selection expression for the route. Supported only for WebSocket APIs. ModelSelectionExpression *string // The operation name for the route. OperationName *string + // The request models for the route. Supported only for WebSocket APIs. + RequestModels map[string]*string + + // The request parameters for the route. Supported only for WebSocket APIs. + RequestParameters map[string]*types.ParameterConstraints + + // The route ID. + RouteId *string + // The route key for the route. RouteKey *string - // Specifies whether a route is managed by API Gateway. If you created an API using - // quick create, the $default route is managed by API Gateway. You can't modify the - // $default route key. - ApiGatewayManaged *bool + // The route response selection expression for the route. Supported only for + // WebSocket APIs. + RouteResponseSelectionExpression *string - // A list of authorization scopes configured on a route. The scopes are used with a - // JWT authorizer to authorize the method invocation. The authorization works by - // matching the route scopes against the scopes parsed from the access token in the - // incoming request. The method invocation is authorized if any route scope matches - // a claimed scope in the access token. Otherwise, the invocation is not - // authorized. When the route scope is configured, the client must provide an - // access token instead of an identity token for authorization purposes. - AuthorizationScopes []*string + // The target for the route. + Target *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigatewayv2/api_op_UpdateRouteResponse.go b/service/apigatewayv2/api_op_UpdateRouteResponse.go index f2c276c9516..5edbfd89167 100644 --- a/service/apigatewayv2/api_op_UpdateRouteResponse.go +++ b/service/apigatewayv2/api_op_UpdateRouteResponse.go @@ -58,22 +58,24 @@ func (c *Client) UpdateRouteResponse(ctx context.Context, params *UpdateRouteRes // Updates a RouteResponse. type UpdateRouteResponseInput struct { - // The model selection expression for the route response. Supported only for - // WebSocket APIs. - ModelSelectionExpression *string - - // The route response key. - RouteResponseKey *string + // The API identifier. + // + // This member is required. + ApiId *string // The route ID. // // This member is required. RouteId *string - // The API identifier. + // The route response ID. // // This member is required. - ApiId *string + RouteResponseId *string + + // The model selection expression for the route response. Supported only for + // WebSocket APIs. + ModelSelectionExpression *string // The response models for the route response. ResponseModels map[string]*string @@ -81,30 +83,28 @@ type UpdateRouteResponseInput struct { // The route response parameters. ResponseParameters map[string]*types.ParameterConstraints - // The route response ID. - // - // This member is required. - RouteResponseId *string + // The route response key. + RouteResponseKey *string } type UpdateRouteResponseOutput struct { - // Represents the response models of a route response. - ResponseModels map[string]*string - // Represents the model selection expression of a route response. Supported only // for WebSocket APIs. ModelSelectionExpression *string + // Represents the response models of a route response. + ResponseModels map[string]*string + // Represents the response parameters of a route response. ResponseParameters map[string]*types.ParameterConstraints - // Represents the route response key of a route response. - RouteResponseKey *string - // Represents the identifier of a route response. RouteResponseId *string + // Represents the route response key of a route response. + RouteResponseKey *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/apigatewayv2/api_op_UpdateStage.go b/service/apigatewayv2/api_op_UpdateStage.go index 76762aa63d9..3e91374aa09 100644 --- a/service/apigatewayv2/api_op_UpdateStage.go +++ b/service/apigatewayv2/api_op_UpdateStage.go @@ -59,11 +59,16 @@ func (c *Client) UpdateStage(ctx context.Context, params *UpdateStageInput, optF // Updates a Stage. type UpdateStageInput struct { - // The identifier of a client certificate for a Stage. - ClientCertificateId *string + // The API identifier. + // + // This member is required. + ApiId *string - // Route settings for the stage. - RouteSettings map[string]*types.RouteSettings + // The stage name. Stage names can only contain alphanumeric characters, hyphens, + // and underscores. Maximum length is 128 characters. + // + // This member is required. + StageName *string // Settings for logging access in this stage. AccessLogSettings *types.AccessLogSettings @@ -72,19 +77,8 @@ type UpdateStageInput struct { // default value is false. AutoDeploy *bool - // The description for the API stage. - Description *string - - // A map that defines the stage variables for a Stage. Variable names can have - // alphanumeric and underscore characters, and the values must match - // [A-Za-z0-9-._~:/?#&=,]+. - StageVariables map[string]*string - - // The stage name. Stage names can only contain alphanumeric characters, hyphens, - // and underscores. Maximum length is 128 characters. - // - // This member is required. - StageName *string + // The identifier of a client certificate for a Stage. + ClientCertificateId *string // The default route settings for the stage. DefaultRouteSettings *types.RouteSettings @@ -93,63 +87,69 @@ type UpdateStageInput struct { // enabled. DeploymentId *string - // The API identifier. - // - // This member is required. - ApiId *string + // The description for the API stage. + Description *string + + // Route settings for the stage. + RouteSettings map[string]*types.RouteSettings + + // A map that defines the stage variables for a Stage. Variable names can have + // alphanumeric and underscore characters, and the values must match + // [A-Za-z0-9-._~:/?#&=,]+. + StageVariables map[string]*string } type UpdateStageOutput struct { + // Settings for logging access in this stage. + AccessLogSettings *types.AccessLogSettings + // Specifies whether a stage is managed by API Gateway. If you created an API using // quick create, the $default stage is managed by API Gateway. You can't modify the // $default stage. ApiGatewayManaged *bool - // Route settings for the stage, by routeKey. - RouteSettings map[string]*types.RouteSettings - // Specifies whether updates to an API automatically trigger a new deployment. The // default value is false. AutoDeploy *bool - // The identifier of the Deployment that the Stage is associated with. Can't be - // updated if autoDeploy is enabled. - DeploymentId *string + // The identifier of a client certificate for a Stage. Supported only for WebSocket + // APIs. + ClientCertificateId *string // The timestamp when the stage was created. CreatedDate *time.Time - // The timestamp when the stage was last updated. - LastUpdatedDate *time.Time + // Default route settings for the stage. + DefaultRouteSettings *types.RouteSettings - // Settings for logging access in this stage. - AccessLogSettings *types.AccessLogSettings + // The identifier of the Deployment that the Stage is associated with. Can't be + // updated if autoDeploy is enabled. + DeploymentId *string + + // The description of the stage. + Description *string // Describes the status of the last deployment of a stage. Supported only for // stages with autoDeploy enabled. LastDeploymentStatusMessage *string - // The collection of tags. Each tag element is associated with a given resource. - Tags map[string]*string - - // Default route settings for the stage. - DefaultRouteSettings *types.RouteSettings + // The timestamp when the stage was last updated. + LastUpdatedDate *time.Time - // The identifier of a client certificate for a Stage. Supported only for WebSocket - // APIs. - ClientCertificateId *string + // Route settings for the stage, by routeKey. + RouteSettings map[string]*types.RouteSettings - // The description of the stage. - Description *string + // The name of the stage. + StageName *string // A map that defines the stage variables for a stage resource. Variable names can // have alphanumeric and underscore characters, and the values must match // [A-Za-z0-9-._~:/?#&=,]+. StageVariables map[string]*string - // The name of the stage. - StageName *string + // The collection of tags. Each tag element is associated with a given resource. + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigatewayv2/api_op_UpdateVpcLink.go b/service/apigatewayv2/api_op_UpdateVpcLink.go index c9dc11df4bc..0bccd2d22fe 100644 --- a/service/apigatewayv2/api_op_UpdateVpcLink.go +++ b/service/apigatewayv2/api_op_UpdateVpcLink.go @@ -70,23 +70,17 @@ type UpdateVpcLinkInput struct { type UpdateVpcLinkOutput struct { - // The name of the VPC link. - Name *string - - // The version of the VPC link. - VpcLinkVersion types.VpcLinkVersion - - // A message summarizing the cause of the status of the VPC link. - VpcLinkStatusMessage *string - // The timestamp when the VPC link was created. CreatedDate *time.Time + // The name of the VPC link. + Name *string + // A list of security group IDs for the VPC link. SecurityGroupIds []*string - // The status of the VPC link. - VpcLinkStatus types.VpcLinkStatus + // A list of subnet IDs to include in the VPC link. + SubnetIds []*string // Tags for the VPC link. Tags map[string]*string @@ -94,8 +88,14 @@ type UpdateVpcLinkOutput struct { // The ID of the VPC link. VpcLinkId *string - // A list of subnet IDs to include in the VPC link. - SubnetIds []*string + // The status of the VPC link. + VpcLinkStatus types.VpcLinkStatus + + // A message summarizing the cause of the status of the VPC link. + VpcLinkStatusMessage *string + + // The version of the VPC link. + VpcLinkVersion types.VpcLinkVersion // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/apigatewayv2/go.mod b/service/apigatewayv2/go.mod index e0b8e7f5c85..25c74a0eb8f 100644 --- a/service/apigatewayv2/go.mod +++ b/service/apigatewayv2/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/apigatewayv2 go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/apigatewayv2/types/types.go b/service/apigatewayv2/types/types.go index 4f55da44b97..12957a13228 100644 --- a/service/apigatewayv2/types/types.go +++ b/service/apigatewayv2/types/types.go @@ -20,64 +20,64 @@ type AccessLogSettings struct { // Represents an API. type Api struct { - // The timestamp when the API was created. - CreatedDate *time.Time - // The name of the API. // // This member is required. Name *string + // The API protocol. + // + // This member is required. + ProtocolType ProtocolType + + // The route selection expression for the API. For HTTP APIs, the + // routeSelectionExpression must be ${request.method} ${request.path}. If not + // provided, this will be the default for HTTP APIs. This property is required for + // WebSocket APIs. + // + // This member is required. + RouteSelectionExpression *string + // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The // stage name is typically appended to this URI to form a complete path to a // deployed API stage. ApiEndpoint *string - // A version identifier for the API. - Version *string - - // The warning messages reported when failonwarnings is turned on during API - // import. - Warnings []*string + // The API ID. + ApiId *string // An API key selection expression. Supported only for WebSocket APIs. See API Key // Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). ApiKeySelectionExpression *string - // The API ID. - ApiId *string - - // The route selection expression for the API. For HTTP APIs, the - // routeSelectionExpression must be ${request.method} ${request.path}. If not - // provided, this will be the default for HTTP APIs. This property is required for - // WebSocket APIs. - // - // This member is required. - RouteSelectionExpression *string + // A CORS configuration. Supported only for HTTP APIs. + CorsConfiguration *Cors - // The API protocol. - // - // This member is required. - ProtocolType ProtocolType + // The timestamp when the API was created. + CreatedDate *time.Time // The description of the API. Description *string + // Avoid validating models when creating a deployment. Supported only for WebSocket + // APIs. + DisableSchemaValidation *bool + // The validation information during API import. This may include particular // properties of your OpenAPI definition which are ignored during import. Supported // only for HTTP APIs. ImportInfo []*string - // Avoid validating models when creating a deployment. Supported only for WebSocket - // APIs. - DisableSchemaValidation *bool - // A collection of tags associated with the API. Tags map[string]*string - // A CORS configuration. Supported only for HTTP APIs. - CorsConfiguration *Cors + // A version identifier for the API. + Version *string + + // The warning messages reported when failonwarnings is turned on during API + // import. + Warnings []*string } // Represents an API mapping. @@ -88,39 +88,25 @@ type ApiMapping struct { // This member is required. ApiId *string + // The API stage. + // + // This member is required. + Stage *string + // The API mapping identifier. ApiMappingId *string // The API mapping key. ApiMappingKey *string - - // The API stage. - // - // This member is required. - Stage *string } // Represents an authorizer. type Authorizer struct { - // The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this - // must be a well-formed Lambda function URI, for example, - // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. - // In general, the URI has this form: - // arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the - // same as the region hosting the Lambda function, path indicates that the - // remaining substring in the URI should be treated as the path to the resource, - // including the initial /. For Lambda functions, this is usually of the form - // /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST - // authorizers. - AuthorizerUri *string - - // The authorizer identifier. - AuthorizerId *string - - // Authorizer caching is not currently supported. Don't specify this value for - // authorizers. - AuthorizerResultTtlInSeconds *int32 + // The name of the authorizer. + // + // This member is required. + Name *string // Specifies the required credentials as an IAM role for API Gateway to invoke the // authorizer. To specify an IAM role for API Gateway to assume, use the role's @@ -128,14 +114,30 @@ type Authorizer struct { // function, specify null. Supported only for REQUEST authorizers. AuthorizerCredentialsArn *string - // The validation expression does not apply to the REQUEST authorizer. - IdentityValidationExpression *string + // The authorizer identifier. + AuthorizerId *string + + // Authorizer caching is not currently supported. Don't specify this value for + // authorizers. + AuthorizerResultTtlInSeconds *int32 // The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function // using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web // Tokens. AuthorizerType AuthorizerType + // The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this + // must be a well-formed Lambda function URI, for example, + // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. + // In general, the URI has this form: + // arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the + // same as the region hosting the Lambda function, path indicates that the + // remaining substring in the URI should be treated as the path to the resource, + // including the initial /. For Lambda functions, this is usually of the form + // /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST + // authorizers. + AuthorizerUri *string + // The identity source for which authorization is requested. For a REQUEST // authorizer, this is optional. The value is a set of one or more mapping // expressions of the specified request parameters. Currently, the identity source @@ -153,14 +155,12 @@ type Authorizer struct { // "$request.header.Authorization". IdentitySource []*string + // The validation expression does not apply to the REQUEST authorizer. + IdentityValidationExpression *string + // Represents the configuration of a JWT authorizer. Required for the JWT // authorizer type. Supported only for HTTP APIs. JwtConfiguration *JWTConfiguration - - // The name of the authorizer. - // - // This member is required. - Name *string } // Represents a CORS configuration. Supported only for HTTP APIs. See Configuring @@ -169,46 +169,46 @@ type Authorizer struct { // for more information. type Cors struct { + // Specifies whether credentials are included in the CORS request. Supported only + // for HTTP APIs. + AllowCredentials *bool + + // Represents a collection of allowed headers. Supported only for HTTP APIs. + AllowHeaders []*string + // Represents a collection of allowed HTTP methods. Supported only for HTTP APIs. AllowMethods []*string - // The number of seconds that the browser should cache preflight request results. - // Supported only for HTTP APIs. - MaxAge *int32 - // Represents a collection of allowed origins. Supported only for HTTP APIs. AllowOrigins []*string // Represents a collection of exposed headers. Supported only for HTTP APIs. ExposeHeaders []*string - // Specifies whether credentials are included in the CORS request. Supported only - // for HTTP APIs. - AllowCredentials *bool - - // Represents a collection of allowed headers. Supported only for HTTP APIs. - AllowHeaders []*string + // The number of seconds that the browser should cache preflight request results. + // Supported only for HTTP APIs. + MaxAge *int32 } // An immutable representation of an API that can be called by users. A Deployment // must be associated with a Stage for it to be callable over the internet. type Deployment struct { - // The status of the deployment: PENDING, FAILED, or SUCCEEDED. - DeploymentStatus DeploymentStatus - // Specifies whether a deployment was automatically released. AutoDeployed *bool + // The date and time when the Deployment resource was created. + CreatedDate *time.Time + // The identifier for the deployment. DeploymentId *string + // The status of the deployment: PENDING, FAILED, or SUCCEEDED. + DeploymentStatus DeploymentStatus + // May contain additional feedback on the status of an API deployment. DeploymentStatusMessage *string - // The date and time when the Deployment resource was created. - CreatedDate *time.Time - // The description for the deployment. Description *string } @@ -216,19 +216,19 @@ type Deployment struct { // Represents a domain name. type DomainName struct { - // The API mapping selection expression. - ApiMappingSelectionExpression *string - // The name of the DomainName resource. // // This member is required. DomainName *string - // The collection of tags associated with a domain name. - Tags map[string]*string + // The API mapping selection expression. + ApiMappingSelectionExpression *string // The domain name configurations. DomainNameConfigurations []*DomainNameConfiguration + + // The collection of tags associated with a domain name. + Tags map[string]*string } // The domain name configuration. @@ -237,27 +237,17 @@ type DomainNameConfiguration struct { // A domain name for the API. ApiGatewayDomainName *string - // The Amazon Route 53 Hosted Zone ID of the endpoint. - HostedZoneId *string - - // The endpoint type. - EndpointType EndpointType - - // The Transport Layer Security (TLS) version of the security policy for this - // domain name. The valid values are TLS_1_0 and TLS_1_2. - SecurityPolicy SecurityPolicy - - // The timestamp when the certificate that was used by edge-optimized endpoint for - // this domain name was uploaded. - CertificateUploadDate *time.Time + // An AWS-managed certificate that will be used by the edge-optimized endpoint for + // this domain name. AWS Certificate Manager is the only supported source. + CertificateArn *string // The user-friendly name of the certificate that will be used by the // edge-optimized endpoint for this domain name. CertificateName *string - // An optional text message containing detailed information about status of the - // domain name migration. - DomainNameStatusMessage *string + // The timestamp when the certificate that was used by edge-optimized endpoint for + // this domain name was uploaded. + CertificateUploadDate *time.Time // The status of the domain name migration. The valid values are AVAILABLE and // UPDATING. If the status is UPDATING, the domain cannot be modified further until @@ -265,27 +255,31 @@ type DomainNameConfiguration struct { // updated. DomainNameStatus DomainNameStatus - // An AWS-managed certificate that will be used by the edge-optimized endpoint for - // this domain name. AWS Certificate Manager is the only supported source. - CertificateArn *string + // An optional text message containing detailed information about status of the + // domain name migration. + DomainNameStatusMessage *string + + // The endpoint type. + EndpointType EndpointType + + // The Amazon Route 53 Hosted Zone ID of the endpoint. + HostedZoneId *string + + // The Transport Layer Security (TLS) version of the security policy for this + // domain name. The valid values are TLS_1_0 and TLS_1_2. + SecurityPolicy SecurityPolicy } // Represents an integration. type Integration struct { - // Specifies the format of the payload sent to an integration. Required for HTTP - // APIs. - PayloadFormatVersion *string - - // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between - // 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for - // WebSocket APIs and 30 seconds for HTTP APIs. - TimeoutInMillis *int32 + // Specifies whether an integration is managed by API Gateway. If you created an + // API using using quick create, the resulting integration is managed by API + // Gateway. You can update a managed integration, but you can't delete it. + ApiGatewayManaged *bool - // The TLS configuration for a private integration. If you specify a TLS - // configuration, private integration traffic uses the HTTPS protocol. Supported - // only for HTTP APIs. - TlsConfig *TlsConfig + // The ID of the VPC link for a private integration. Supported only for HTTP APIs. + ConnectionId *string // The type of the network connection to the integration endpoint. Specify INTERNET // for connections through the public routable internet or VPC_LINK for private @@ -293,8 +287,15 @@ type Integration struct { // INTERNET. ConnectionType ConnectionType - // Represents the description of an integration. - Description *string + // Supported only for WebSocket APIs. Specifies how to handle response payload + // content type conversions. Supported values are CONVERT_TO_BINARY and + // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a + // response payload from a Base64-encoded string to the corresponding binary blob. + // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a + // Base64-encoded string. If this property is not defined, the response payload + // will be passed through from the integration response to the route response or + // method response without modification. + ContentHandlingStrategy ContentHandlingStrategy // Specifies the credentials required for the integration, if any. For AWS // integrations, three options are available. To specify an IAM Role for API @@ -304,9 +305,20 @@ type Integration struct { // services, specify null. CredentialsArn *string + // Represents the description of an integration. + Description *string + // Represents the identifier of an integration. IntegrationId *string + // Specifies the integration's HTTP method type. + IntegrationMethod *string + + // The integration response selection expression for the integration. Supported + // only for WebSocket APIs. See Integration Response Selection Expressions + // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions). + IntegrationResponseSelectionExpression *string + // The integration type of an integration. One of the following: AWS: for // integrating the route or method request with an AWS service action, including // the Lambda function-invoking action. With the Lambda function-invoking action, @@ -324,35 +336,6 @@ type Integration struct { // Supported only for WebSocket APIs. IntegrationType IntegrationType - // The integration response selection expression for the integration. Supported - // only for WebSocket APIs. See Integration Response Selection Expressions - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions). - IntegrationResponseSelectionExpression *string - - // A key-value map specifying request parameters that are passed from the method - // request to the backend. The key is an integration request parameter name and the - // associated value is a method request parameter value or static value that must - // be enclosed within single quotes and pre-encoded as required by the backend. The - // method request parameter value must match the pattern of - // method.request.{location}.{name} , where {location} is querystring, path, or - // header; and {name} must be a valid and unique method request parameter name. - // Supported only for WebSocket APIs. - RequestParameters map[string]*string - - // Supported only for WebSocket APIs. Specifies how to handle response payload - // content type conversions. Supported values are CONVERT_TO_BINARY and - // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a - // response payload from a Base64-encoded string to the corresponding binary blob. - // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a - // Base64-encoded string. If this property is not defined, the response payload - // will be passed through from the integration response to the route response or - // method response without modification. - ContentHandlingStrategy ContentHandlingStrategy - - // The template selection expression for the integration. Supported only for - // WebSocket APIs. - TemplateSelectionExpression *string - // For a Lambda integration, specify the URI of a Lambda function. For an HTTP // integration, specify a fully-qualified URL. For an HTTP API private integration, // specify the ARN of an Application Load Balancer listener, Network Load Balancer @@ -364,8 +347,32 @@ type Integration struct { // For private integrations, all resources must be owned by the same AWS account. IntegrationUri *string - // The ID of the VPC link for a private integration. Supported only for HTTP APIs. - ConnectionId *string + // Specifies the pass-through behavior for incoming requests based on the + // Content-Type header in the request, and the available mapping templates + // specified as the requestTemplates property on the Integration resource. There + // are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported + // only for WebSocket APIs. WHEN_NO_MATCH passes the request body for unmapped + // content types through to the integration backend without transformation. NEVER + // rejects unmapped content types with an HTTP 415 Unsupported Media Type response. + // WHEN_NO_TEMPLATES allows pass-through when the integration has no content types + // mapped to templates. However, if there is at least one content type defined, + // unmapped content types will be rejected with the same HTTP 415 Unsupported Media + // Type response. + PassthroughBehavior PassthroughBehavior + + // Specifies the format of the payload sent to an integration. Required for HTTP + // APIs. + PayloadFormatVersion *string + + // A key-value map specifying request parameters that are passed from the method + // request to the backend. The key is an integration request parameter name and the + // associated value is a method request parameter value or static value that must + // be enclosed within single quotes and pre-encoded as required by the backend. The + // method request parameter value must match the pattern of + // method.request.{location}.{name} , where {location} is querystring, path, or + // header; and {name} must be a valid and unique method request parameter name. + // Supported only for WebSocket APIs. + RequestParameters map[string]*string // Represents a map of Velocity templates that are applied on the request payload // based on the value of the Content-Type header sent by the client. The content @@ -373,35 +380,41 @@ type Integration struct { // Supported only for WebSocket APIs. RequestTemplates map[string]*string - // Specifies the pass-through behavior for incoming requests based on the - // Content-Type header in the request, and the available mapping templates - // specified as the requestTemplates property on the Integration resource. There - // are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported - // only for WebSocket APIs. WHEN_NO_MATCH passes the request body for unmapped - // content types through to the integration backend without transformation. NEVER - // rejects unmapped content types with an HTTP 415 Unsupported Media Type response. - // WHEN_NO_TEMPLATES allows pass-through when the integration has no content types - // mapped to templates. However, if there is at least one content type defined, - // unmapped content types will be rejected with the same HTTP 415 Unsupported Media - // Type response. - PassthroughBehavior PassthroughBehavior + // The template selection expression for the integration. Supported only for + // WebSocket APIs. + TemplateSelectionExpression *string - // Specifies the integration's HTTP method type. - IntegrationMethod *string + // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between + // 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for + // WebSocket APIs and 30 seconds for HTTP APIs. + TimeoutInMillis *int32 - // Specifies whether an integration is managed by API Gateway. If you created an - // API using using quick create, the resulting integration is managed by API - // Gateway. You can update a managed integration, but you can't delete it. - ApiGatewayManaged *bool + // The TLS configuration for a private integration. If you specify a TLS + // configuration, private integration traffic uses the HTTPS protocol. Supported + // only for HTTP APIs. + TlsConfig *TlsConfig } // Represents an integration response. type IntegrationResponse struct { - // The collection of response templates for the integration response as a - // string-to-string map of key-value pairs. Response templates are represented as a - // key/value map, with a content-type as the key and a template as the value. - ResponseTemplates map[string]*string + // The integration response key. + // + // This member is required. + IntegrationResponseKey *string + + // Supported only for WebSocket APIs. Specifies how to handle response payload + // content type conversions. Supported values are CONVERT_TO_BINARY and + // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a + // response payload from a Base64-encoded string to the corresponding binary blob. + // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a + // Base64-encoded string. If this property is not defined, the response payload + // will be passed through from the integration response to the route response or + // method response without modification. + ContentHandlingStrategy ContentHandlingStrategy + + // The integration response ID. + IntegrationResponseId *string // A key-value map specifying response parameters that are passed to the method // response from the backend. The key is a method response header parameter name @@ -416,26 +429,13 @@ type IntegrationResponse struct { // $ prefix. ResponseParameters map[string]*string + // The collection of response templates for the integration response as a + // string-to-string map of key-value pairs. Response templates are represented as a + // key/value map, with a content-type as the key and a template as the value. + ResponseTemplates map[string]*string + // The template selection expressions for the integration response. TemplateSelectionExpression *string - - // Supported only for WebSocket APIs. Specifies how to handle response payload - // content type conversions. Supported values are CONVERT_TO_BINARY and - // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a - // response payload from a Base64-encoded string to the corresponding binary blob. - // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a - // Base64-encoded string. If this property is not defined, the response payload - // will be passed through from the integration response to the route response or - // method response without modification. - ContentHandlingStrategy ContentHandlingStrategy - - // The integration response ID. - IntegrationResponseId *string - - // The integration response key. - // - // This member is required. - IntegrationResponseKey *string } // Represents the configuration of a JWT authorizer. Required for the JWT @@ -465,18 +465,18 @@ type Model struct { // This member is required. Name *string - // The schema for the model. For application/json models, this should be JSON - // schema draft 4 model. - Schema *string - - // The model identifier. - ModelId *string + // The content-type for the model, for example, "application/json". + ContentType *string // The description of the model. Description *string - // The content-type for the model, for example, "application/json". - ContentType *string + // The model identifier. + ModelId *string + + // The schema for the model. For application/json models, this should be JSON + // schema draft 4 model. + Schema *string } // Validation constraints imposed on parameters of a request (path, query string, @@ -495,20 +495,37 @@ type Route struct { // This member is required. RouteKey *string - // The target for the route. - Target *string + // Specifies whether a route is managed by API Gateway. If you created an API using + // quick create, the $default route is managed by API Gateway. You can't modify the + // $default route key. + ApiGatewayManaged *bool // Specifies whether an API key is required for this route. Supported only for // WebSocket APIs. ApiKeyRequired *bool + // A list of authorization scopes configured on a route. The scopes are used with a + // JWT authorizer to authorize the method invocation. The authorization works by + // matching the route scopes against the scopes parsed from the access token in the + // incoming request. The method invocation is authorized if any route scope matches + // a claimed scope in the access token. Otherwise, the invocation is not + // authorized. When the route scope is configured, the client must provide an + // access token instead of an identity token for authorization purposes. + AuthorizationScopes []*string + + // The authorization type for the route. For WebSocket APIs, valid values are NONE + // for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a + // Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT + // for using JSON Web Tokens. + AuthorizationType AuthorizationType + // The identifier of the Authorizer resource to be associated with this route. The // authorizer identifier is generated by API Gateway when you created the // authorizer. AuthorizerId *string - // The route ID. - RouteId *string + // The model selection expression for the route. Supported only for WebSocket APIs. + ModelSelectionExpression *string // The operation name for the route. OperationName *string @@ -519,65 +536,50 @@ type Route struct { // The request parameters for the route. Supported only for WebSocket APIs. RequestParameters map[string]*ParameterConstraints - // The model selection expression for the route. Supported only for WebSocket APIs. - ModelSelectionExpression *string - - // The authorization type for the route. For WebSocket APIs, valid values are NONE - // for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a - // Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT - // for using JSON Web Tokens. - AuthorizationType AuthorizationType + // The route ID. + RouteId *string // The route response selection expression for the route. Supported only for // WebSocket APIs. RouteResponseSelectionExpression *string - // A list of authorization scopes configured on a route. The scopes are used with a - // JWT authorizer to authorize the method invocation. The authorization works by - // matching the route scopes against the scopes parsed from the access token in the - // incoming request. The method invocation is authorized if any route scope matches - // a claimed scope in the access token. Otherwise, the invocation is not - // authorized. When the route scope is configured, the client must provide an - // access token instead of an identity token for authorization purposes. - AuthorizationScopes []*string - - // Specifies whether a route is managed by API Gateway. If you created an API using - // quick create, the $default route is managed by API Gateway. You can't modify the - // $default route key. - ApiGatewayManaged *bool + // The target for the route. + Target *string } // Represents a route response. type RouteResponse struct { - // Represents the identifier of a route response. - RouteResponseId *string + // Represents the route response key of a route response. + // + // This member is required. + RouteResponseKey *string // Represents the model selection expression of a route response. Supported only // for WebSocket APIs. ModelSelectionExpression *string - // Represents the response parameters of a route response. - ResponseParameters map[string]*ParameterConstraints - // Represents the response models of a route response. ResponseModels map[string]*string - // Represents the route response key of a route response. - // - // This member is required. - RouteResponseKey *string + // Represents the response parameters of a route response. + ResponseParameters map[string]*ParameterConstraints + + // Represents the identifier of a route response. + RouteResponseId *string } // Represents a collection of route settings. type RouteSettings struct { + // Specifies whether (true) or not (false) data trace logging is enabled for this + // route. This property affects the log entries pushed to Amazon CloudWatch Logs. + // Supported only for WebSocket APIs. + DataTraceEnabled *bool + // Specifies whether detailed metrics are enabled. DetailedMetricsEnabled *bool - // Specifies the throttling rate limit. - ThrottlingRateLimit *float64 - // Specifies the logging level for this route: INFO, ERROR, or OFF. This property // affects the log entries pushed to Amazon CloudWatch Logs. Supported only for // WebSocket APIs. @@ -586,31 +588,36 @@ type RouteSettings struct { // Specifies the throttling burst limit. ThrottlingBurstLimit *int32 - // Specifies whether (true) or not (false) data trace logging is enabled for this - // route. This property affects the log entries pushed to Amazon CloudWatch Logs. - // Supported only for WebSocket APIs. - DataTraceEnabled *bool + // Specifies the throttling rate limit. + ThrottlingRateLimit *float64 } // Represents an API stage. type Stage struct { - // The description of the stage. - Description *string + // The name of the stage. + // + // This member is required. + StageName *string + + // Settings for logging access in this stage. + AccessLogSettings *AccessLogSettings + + // Specifies whether a stage is managed by API Gateway. If you created an API using + // quick create, the $default stage is managed by API Gateway. You can't modify the + // $default stage. + ApiGatewayManaged *bool + + // Specifies whether updates to an API automatically trigger a new deployment. The + // default value is false. + AutoDeploy *bool // The identifier of a client certificate for a Stage. Supported only for WebSocket // APIs. ClientCertificateId *string - // The timestamp when the stage was last updated. - LastUpdatedDate *time.Time - - // Describes the status of the last deployment of a stage. Supported only for - // stages with autoDeploy enabled. - LastDeploymentStatusMessage *string - - // The collection of tags. Each tag element is associated with a given resource. - Tags map[string]*string + // The timestamp when the stage was created. + CreatedDate *time.Time // Default route settings for the stage. DefaultRouteSettings *RouteSettings @@ -619,33 +626,26 @@ type Stage struct { // updated if autoDeploy is enabled. DeploymentId *string - // The timestamp when the stage was created. - CreatedDate *time.Time + // The description of the stage. + Description *string - // Specifies whether a stage is managed by API Gateway. If you created an API using - // quick create, the $default stage is managed by API Gateway. You can't modify the - // $default stage. - ApiGatewayManaged *bool + // Describes the status of the last deployment of a stage. Supported only for + // stages with autoDeploy enabled. + LastDeploymentStatusMessage *string - // Specifies whether updates to an API automatically trigger a new deployment. The - // default value is false. - AutoDeploy *bool + // The timestamp when the stage was last updated. + LastUpdatedDate *time.Time + + // Route settings for the stage, by routeKey. + RouteSettings map[string]*RouteSettings // A map that defines the stage variables for a stage resource. Variable names can // have alphanumeric and underscore characters, and the values must match // [A-Za-z0-9-._~:/?#&=,]+. StageVariables map[string]*string - // The name of the stage. - // - // This member is required. - StageName *string - - // Route settings for the stage, by routeKey. - RouteSettings map[string]*RouteSettings - - // Settings for logging access in this stage. - AccessLogSettings *AccessLogSettings + // The collection of tags. Each tag element is associated with a given resource. + Tags map[string]*string } // The TLS configuration for a private integration. If you specify a TLS @@ -673,13 +673,10 @@ type TlsConfigInput struct { // Represents a VPC link. type VpcLink struct { - // The ID of the VPC link. + // The name of the VPC link. // // This member is required. - VpcLinkId *string - - // The status of the VPC link. - VpcLinkStatus VpcLinkStatus + Name *string // A list of security group IDs for the VPC link. // @@ -691,20 +688,23 @@ type VpcLink struct { // This member is required. SubnetIds []*string - // The name of the VPC link. + // The ID of the VPC link. // // This member is required. - Name *string + VpcLinkId *string - // A message summarizing the cause of the status of the VPC link. - VpcLinkStatusMessage *string + // The timestamp when the VPC link was created. + CreatedDate *time.Time // Tags for the VPC link. Tags map[string]*string + // The status of the VPC link. + VpcLinkStatus VpcLinkStatus + + // A message summarizing the cause of the status of the VPC link. + VpcLinkStatusMessage *string + // The version of the VPC link. VpcLinkVersion VpcLinkVersion - - // The timestamp when the VPC link was created. - CreatedDate *time.Time } diff --git a/service/appconfig/api_op_CreateApplication.go b/service/appconfig/api_op_CreateApplication.go index 5dc5b0717cb..f7c596861ad 100644 --- a/service/appconfig/api_op_CreateApplication.go +++ b/service/appconfig/api_op_CreateApplication.go @@ -65,25 +65,25 @@ type CreateApplicationInput struct { // This member is required. Name *string + // A description of the application. + Description *string + // Metadata to assign to the application. Tags help organize and categorize your // AppConfig resources. Each tag consists of a key and an optional value, both of // which you define. Tags map[string]*string - - // A description of the application. - Description *string } type CreateApplicationOutput struct { - // The application name. - Name *string + // The description of the application. + Description *string // The application ID. Id *string - // The description of the application. - Description *string + // The application name. + Name *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/appconfig/api_op_CreateConfigurationProfile.go b/service/appconfig/api_op_CreateConfigurationProfile.go index 08918851440..8d75facd863 100644 --- a/service/appconfig/api_op_CreateConfigurationProfile.go +++ b/service/appconfig/api_op_CreateConfigurationProfile.go @@ -74,31 +74,11 @@ func (c *Client) CreateConfigurationProfile(ctx context.Context, params *CreateC type CreateConfigurationProfileInput struct { - // The ARN of an IAM role with permission to access the configuration at the - // specified LocationUri. - RetrievalRoleArn *string - - // A list of methods for validating the configuration. - Validators []*types.Validator - - // A name for the configuration profile. - // - // This member is required. - Name *string - // The application ID. // // This member is required. ApplicationId *string - // Metadata to assign to the configuration profile. Tags help organize and - // categorize your AppConfig resources. Each tag consists of a key and an optional - // value, both of which you define. - Tags map[string]*string - - // A description of the configuration profile. - Description *string - // A URI to locate the configuration. You can specify a Systems Manager (SSM) // document, an SSM Parameter Store parameter, or an Amazon S3 object. For an SSM // document, specify either the document name in the format ssm-document:// or the @@ -109,6 +89,26 @@ type CreateConfigurationProfileInput struct { // // This member is required. LocationUri *string + + // A name for the configuration profile. + // + // This member is required. + Name *string + + // A description of the configuration profile. + Description *string + + // The ARN of an IAM role with permission to access the configuration at the + // specified LocationUri. + RetrievalRoleArn *string + + // Metadata to assign to the configuration profile. Tags help organize and + // categorize your AppConfig resources. Each tag consists of a key and an optional + // value, both of which you define. + Tags map[string]*string + + // A list of methods for validating the configuration. + Validators []*types.Validator } type CreateConfigurationProfileOutput struct { @@ -116,24 +116,24 @@ type CreateConfigurationProfileOutput struct { // The application ID. ApplicationId *string + // The configuration profile description. + Description *string + + // The configuration profile ID. + Id *string + + // The URI location of the configuration. + LocationUri *string + // The name of the configuration profile. Name *string - // A list of methods for validating the configuration. - Validators []*types.Validator - // The ARN of an IAM role with permission to access the configuration at the // specified LocationUri. RetrievalRoleArn *string - // The URI location of the configuration. - LocationUri *string - - // The configuration profile ID. - Id *string - - // The configuration profile description. - Description *string + // A list of methods for validating the configuration. + Validators []*types.Validator // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/appconfig/api_op_CreateDeploymentStrategy.go b/service/appconfig/api_op_CreateDeploymentStrategy.go index 81e48793d78..8cd60b4b6b6 100644 --- a/service/appconfig/api_op_CreateDeploymentStrategy.go +++ b/service/appconfig/api_op_CreateDeploymentStrategy.go @@ -61,21 +61,17 @@ func (c *Client) CreateDeploymentStrategy(ctx context.Context, params *CreateDep type CreateDeploymentStrategyInput struct { + // Total amount of time for a deployment to last. + // + // This member is required. + DeploymentDurationInMinutes *int32 + // The percentage of targets to receive a deployed configuration during each // interval. // // This member is required. GrowthFactor *float32 - // The amount of time AppConfig monitors for alarms before considering the - // deployment to be complete and no longer eligible for automatic roll back. - FinalBakeTimeInMinutes *int32 - - // Metadata to assign to the deployment strategy. Tags help organize and categorize - // your AppConfig resources. Each tag consists of a key and an optional value, both - // of which you define. - Tags map[string]*string - // A name for the deployment strategy. // // This member is required. @@ -86,10 +82,12 @@ type CreateDeploymentStrategyInput struct { // This member is required. ReplicateTo types.ReplicateTo - // Total amount of time for a deployment to last. - // - // This member is required. - DeploymentDurationInMinutes *int32 + // A description of the deployment strategy. + Description *string + + // The amount of time AppConfig monitors for alarms before considering the + // deployment to be complete and no longer eligible for automatic roll back. + FinalBakeTimeInMinutes *int32 // The algorithm used to define how percentage grows over time. AWS AppConfig // supports the following growth types: Linear: For this type, AppConfig processes @@ -110,24 +108,17 @@ type CreateDeploymentStrategyInput struct { // deployed to all targets.

GrowthType types.GrowthType - // A description of the deployment strategy. - Description *string + // Metadata to assign to the deployment strategy. Tags help organize and categorize + // your AppConfig resources. Each tag consists of a key and an optional value, both + // of which you define. + Tags map[string]*string } type CreateDeploymentStrategyOutput struct { - // The algorithm used to define how percentage grew over time. - GrowthType types.GrowthType - // Total amount of time the deployment lasted. DeploymentDurationInMinutes *int32 - // Save the deployment strategy to a Systems Manager (SSM) document. - ReplicateTo types.ReplicateTo - - // The deployment strategy ID. - Id *string - // The description of the deployment strategy. Description *string @@ -135,13 +126,22 @@ type CreateDeploymentStrategyOutput struct { // deployment to be complete and no longer eligible for automatic roll back. FinalBakeTimeInMinutes *int32 - // The name of the deployment strategy. - Name *string - // The percentage of targets that received a deployed configuration during each // interval. GrowthFactor *float32 + // The algorithm used to define how percentage grew over time. + GrowthType types.GrowthType + + // The deployment strategy ID. + Id *string + + // The name of the deployment strategy. + Name *string + + // Save the deployment strategy to a Systems Manager (SSM) document. + ReplicateTo types.ReplicateTo + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/appconfig/api_op_CreateEnvironment.go b/service/appconfig/api_op_CreateEnvironment.go index 8f293995d9f..38abe8be454 100644 --- a/service/appconfig/api_op_CreateEnvironment.go +++ b/service/appconfig/api_op_CreateEnvironment.go @@ -63,49 +63,49 @@ func (c *Client) CreateEnvironment(ctx context.Context, params *CreateEnvironmen type CreateEnvironmentInput struct { - // Metadata to assign to the environment. Tags help organize and categorize your - // AppConfig resources. Each tag consists of a key and an optional value, both of - // which you define. - Tags map[string]*string - - // Amazon CloudWatch alarms to monitor during the deployment process. - Monitors []*types.Monitor - - // A description of the environment. - Description *string + // The application ID. + // + // This member is required. + ApplicationId *string // A name for the environment. // // This member is required. Name *string - // The application ID. - // - // This member is required. - ApplicationId *string + // A description of the environment. + Description *string + + // Amazon CloudWatch alarms to monitor during the deployment process. + Monitors []*types.Monitor + + // Metadata to assign to the environment. Tags help organize and categorize your + // AppConfig resources. Each tag consists of a key and an optional value, both of + // which you define. + Tags map[string]*string } type CreateEnvironmentOutput struct { - // The name of the environment. - Name *string - // The application ID. ApplicationId *string // The description of the environment. Description *string - // The state of the environment. An environment can be in one of the following - // states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK - State types.EnvironmentState - // The environment ID. Id *string // Amazon CloudWatch alarms monitored during the deployment. Monitors []*types.Monitor + // The name of the environment. + Name *string + + // The state of the environment. An environment can be in one of the following + // states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK + State types.EnvironmentState + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/appconfig/api_op_CreateHostedConfigurationVersion.go b/service/appconfig/api_op_CreateHostedConfigurationVersion.go index 6afe0dd52a8..d8fc92c5bb4 100644 --- a/service/appconfig/api_op_CreateHostedConfigurationVersion.go +++ b/service/appconfig/api_op_CreateHostedConfigurationVersion.go @@ -56,20 +56,21 @@ func (c *Client) CreateHostedConfigurationVersion(ctx context.Context, params *C type CreateHostedConfigurationVersionInput struct { - // An optional locking token used to prevent race conditions from overwriting - // configuration updates when creating a new version. To ensure your data is not - // overwritten when creating multiple hosted configuration versions in rapid - // succession, specify the version of the latest hosted configuration version. - LatestVersionNumber *int32 + // The application ID. + // + // This member is required. + ApplicationId *string + + // The configuration profile ID. + // + // This member is required. + ConfigurationProfileId *string // The content of the configuration or the configuration data. // // This member is required. Content []byte - // A description of the configuration. - Description *string - // A standard MIME type describing the format of the configuration content. For // more information, see Content-Type // (https://docs.aws.amazon.com/https:/www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17). @@ -77,19 +78,27 @@ type CreateHostedConfigurationVersionInput struct { // This member is required. ContentType *string - // The configuration profile ID. - // - // This member is required. - ConfigurationProfileId *string + // A description of the configuration. + Description *string - // The application ID. - // - // This member is required. - ApplicationId *string + // An optional locking token used to prevent race conditions from overwriting + // configuration updates when creating a new version. To ensure your data is not + // overwritten when creating multiple hosted configuration versions in rapid + // succession, specify the version of the latest hosted configuration version. + LatestVersionNumber *int32 } type CreateHostedConfigurationVersionOutput struct { + // The application ID. + ApplicationId *string + + // The configuration profile ID. + ConfigurationProfileId *string + + // The content of the configuration or the configuration data. + Content []byte + // A standard MIME type describing the format of the configuration content. For // more information, see Content-Type // (https://docs.aws.amazon.com/https:/www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17). @@ -98,18 +107,9 @@ type CreateHostedConfigurationVersionOutput struct { // A description of the configuration. Description *string - // The configuration profile ID. - ConfigurationProfileId *string - // The configuration version. VersionNumber *int32 - // The application ID. - ApplicationId *string - - // The content of the configuration or the configuration data. - Content []byte - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/appconfig/api_op_DeleteEnvironment.go b/service/appconfig/api_op_DeleteEnvironment.go index be60bac4677..9c86f2b3cdd 100644 --- a/service/appconfig/api_op_DeleteEnvironment.go +++ b/service/appconfig/api_op_DeleteEnvironment.go @@ -57,15 +57,15 @@ func (c *Client) DeleteEnvironment(ctx context.Context, params *DeleteEnvironmen type DeleteEnvironmentInput struct { - // The ID of the environment you want to delete. + // The application ID that includes the environment you want to delete. // // This member is required. - EnvironmentId *string + ApplicationId *string - // The application ID that includes the environment you want to delete. + // The ID of the environment you want to delete. // // This member is required. - ApplicationId *string + EnvironmentId *string } type DeleteEnvironmentOutput struct { diff --git a/service/appconfig/api_op_DeleteHostedConfigurationVersion.go b/service/appconfig/api_op_DeleteHostedConfigurationVersion.go index d0049bcc18e..270ab49213d 100644 --- a/service/appconfig/api_op_DeleteHostedConfigurationVersion.go +++ b/service/appconfig/api_op_DeleteHostedConfigurationVersion.go @@ -61,15 +61,15 @@ type DeleteHostedConfigurationVersionInput struct { // This member is required. ApplicationId *string - // The versions number to delete. + // The configuration profile ID. // // This member is required. - VersionNumber *int32 + ConfigurationProfileId *string - // The configuration profile ID. + // The versions number to delete. // // This member is required. - ConfigurationProfileId *string + VersionNumber *int32 } type DeleteHostedConfigurationVersionOutput struct { diff --git a/service/appconfig/api_op_GetApplication.go b/service/appconfig/api_op_GetApplication.go index 6710774000a..d9ff0b83100 100644 --- a/service/appconfig/api_op_GetApplication.go +++ b/service/appconfig/api_op_GetApplication.go @@ -64,14 +64,14 @@ type GetApplicationInput struct { type GetApplicationOutput struct { - // The application name. - Name *string + // The description of the application. + Description *string // The application ID. Id *string - // The description of the application. - Description *string + // The application name. + Name *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/appconfig/api_op_GetConfiguration.go b/service/appconfig/api_op_GetConfiguration.go index 51ded5540f8..c1c612c3d8f 100644 --- a/service/appconfig/api_op_GetConfiguration.go +++ b/service/appconfig/api_op_GetConfiguration.go @@ -64,17 +64,11 @@ func (c *Client) GetConfiguration(ctx context.Context, params *GetConfigurationI type GetConfigurationInput struct { - // The environment to get. Specify either the environment name or the environment + // The application to get. Specify either the application name or the application // ID. // // This member is required. - Environment *string - - // The configuration to get. Specify either the configuration name or the - // configuration ID. - // - // This member is required. - Configuration *string + Application *string // A unique ID to identify the client for the configuration. This ID enables // AppConfig to deploy the configuration in intervals, as defined in the deployment @@ -83,11 +77,17 @@ type GetConfigurationInput struct { // This member is required. ClientId *string - // The application to get. Specify either the application name or the application + // The configuration to get. Specify either the configuration name or the + // configuration ID. + // + // This member is required. + Configuration *string + + // The environment to get. Specify either the environment name or the environment // ID. // // This member is required. - Application *string + Environment *string // The configuration version returned in the most recent GetConfiguration response. // AWS AppConfig uses the value of the ClientConfigurationVersion parameter to @@ -106,6 +106,9 @@ type GetConfigurationInput struct { type GetConfigurationOutput struct { + // The configuration version. + ConfigurationVersion *string + // The content of the configuration or the configuration data. Content []byte @@ -114,9 +117,6 @@ type GetConfigurationOutput struct { // (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17). ContentType *string - // The configuration version. - ConfigurationVersion *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/appconfig/api_op_GetConfigurationProfile.go b/service/appconfig/api_op_GetConfigurationProfile.go index 4906d0eb27a..0783a539561 100644 --- a/service/appconfig/api_op_GetConfigurationProfile.go +++ b/service/appconfig/api_op_GetConfigurationProfile.go @@ -57,16 +57,16 @@ func (c *Client) GetConfigurationProfile(ctx context.Context, params *GetConfigu type GetConfigurationProfileInput struct { - // The ID of the configuration profile you want to get. - // - // This member is required. - ConfigurationProfileId *string - // The ID of the application that includes the configuration profile you want to // get. // // This member is required. ApplicationId *string + + // The ID of the configuration profile you want to get. + // + // This member is required. + ConfigurationProfileId *string } type GetConfigurationProfileOutput struct { @@ -74,24 +74,24 @@ type GetConfigurationProfileOutput struct { // The application ID. ApplicationId *string + // The configuration profile description. + Description *string + + // The configuration profile ID. + Id *string + + // The URI location of the configuration. + LocationUri *string + // The name of the configuration profile. Name *string - // A list of methods for validating the configuration. - Validators []*types.Validator - // The ARN of an IAM role with permission to access the configuration at the // specified LocationUri. RetrievalRoleArn *string - // The URI location of the configuration. - LocationUri *string - - // The configuration profile ID. - Id *string - - // The configuration profile description. - Description *string + // A list of methods for validating the configuration. + Validators []*types.Validator // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/appconfig/api_op_GetDeployment.go b/service/appconfig/api_op_GetDeployment.go index a4259a9f028..d10e94c8ab9 100644 --- a/service/appconfig/api_op_GetDeployment.go +++ b/service/appconfig/api_op_GetDeployment.go @@ -58,11 +58,6 @@ func (c *Client) GetDeployment(ctx context.Context, params *GetDeploymentInput, type GetDeploymentInput struct { - // The ID of the environment that includes the deployment you want to get. - // - // This member is required. - EnvironmentId *string - // The ID of the application that includes the deployment you want to get. // // This member is required. @@ -72,66 +67,71 @@ type GetDeploymentInput struct { // // This member is required. DeploymentNumber *int32 + + // The ID of the environment that includes the deployment you want to get. + // + // This member is required. + EnvironmentId *string } type GetDeploymentOutput struct { - // The ID of the deployment strategy that was deployed. - DeploymentStrategyId *string - // The ID of the application that was deployed. ApplicationId *string + // The time the deployment completed. + CompletedAt *time.Time + // Information about the source location of the configuration. ConfigurationLocationUri *string - // The algorithm used to define how percentage grew over time. - GrowthType types.GrowthType - - // The percentage of targets for which the deployment is available. - PercentageComplete *float32 - - // The state of the deployment. - State types.DeploymentState + // The name of the configuration. + ConfigurationName *string - // A list containing all events related to a deployment. The most recent events are - // displayed first. - EventLog []*types.DeploymentEvent + // The ID of the configuration profile that was deployed. + ConfigurationProfileId *string // The configuration version that was deployed. ConfigurationVersion *string + // Total amount of time the deployment lasted. + DeploymentDurationInMinutes *int32 + + // The sequence number of the deployment. + DeploymentNumber *int32 + + // The ID of the deployment strategy that was deployed. + DeploymentStrategyId *string + // The description of the deployment. Description *string - // The ID of the configuration profile that was deployed. - ConfigurationProfileId *string + // The ID of the environment that was deployed. + EnvironmentId *string - // Total amount of time the deployment lasted. - DeploymentDurationInMinutes *int32 + // A list containing all events related to a deployment. The most recent events are + // displayed first. + EventLog []*types.DeploymentEvent // The amount of time AppConfig monitored for alarms before considering the // deployment to be complete and no longer eligible for automatic roll back. FinalBakeTimeInMinutes *int32 - // The time the deployment started. - StartedAt *time.Time - - // The sequence number of the deployment. - DeploymentNumber *int32 - // The percentage of targets to receive a deployed configuration during each // interval. GrowthFactor *float32 - // The time the deployment completed. - CompletedAt *time.Time + // The algorithm used to define how percentage grew over time. + GrowthType types.GrowthType - // The name of the configuration. - ConfigurationName *string + // The percentage of targets for which the deployment is available. + PercentageComplete *float32 - // The ID of the environment that was deployed. - EnvironmentId *string + // The time the deployment started. + StartedAt *time.Time + + // The state of the deployment. + State types.DeploymentState // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/appconfig/api_op_GetDeploymentStrategy.go b/service/appconfig/api_op_GetDeploymentStrategy.go index a949d49facc..2e1c903f6fe 100644 --- a/service/appconfig/api_op_GetDeploymentStrategy.go +++ b/service/appconfig/api_op_GetDeploymentStrategy.go @@ -69,18 +69,9 @@ type GetDeploymentStrategyInput struct { type GetDeploymentStrategyOutput struct { - // The algorithm used to define how percentage grew over time. - GrowthType types.GrowthType - // Total amount of time the deployment lasted. DeploymentDurationInMinutes *int32 - // Save the deployment strategy to a Systems Manager (SSM) document. - ReplicateTo types.ReplicateTo - - // The deployment strategy ID. - Id *string - // The description of the deployment strategy. Description *string @@ -88,13 +79,22 @@ type GetDeploymentStrategyOutput struct { // deployment to be complete and no longer eligible for automatic roll back. FinalBakeTimeInMinutes *int32 - // The name of the deployment strategy. - Name *string - // The percentage of targets that received a deployed configuration during each // interval. GrowthFactor *float32 + // The algorithm used to define how percentage grew over time. + GrowthType types.GrowthType + + // The deployment strategy ID. + Id *string + + // The name of the deployment strategy. + Name *string + + // Save the deployment strategy to a Systems Manager (SSM) document. + ReplicateTo types.ReplicateTo + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/appconfig/api_op_GetEnvironment.go b/service/appconfig/api_op_GetEnvironment.go index 3c5e200f44b..1349fd72ab6 100644 --- a/service/appconfig/api_op_GetEnvironment.go +++ b/service/appconfig/api_op_GetEnvironment.go @@ -62,38 +62,38 @@ func (c *Client) GetEnvironment(ctx context.Context, params *GetEnvironmentInput type GetEnvironmentInput struct { - // The ID of the environment you wnat to get. + // The ID of the application that includes the environment you want to get. // // This member is required. - EnvironmentId *string + ApplicationId *string - // The ID of the application that includes the environment you want to get. + // The ID of the environment you wnat to get. // // This member is required. - ApplicationId *string + EnvironmentId *string } type GetEnvironmentOutput struct { - // The name of the environment. - Name *string - // The application ID. ApplicationId *string // The description of the environment. Description *string - // The state of the environment. An environment can be in one of the following - // states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK - State types.EnvironmentState - // The environment ID. Id *string // Amazon CloudWatch alarms monitored during the deployment. Monitors []*types.Monitor + // The name of the environment. + Name *string + + // The state of the environment. An environment can be in one of the following + // states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK + State types.EnvironmentState + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/appconfig/api_op_GetHostedConfigurationVersion.go b/service/appconfig/api_op_GetHostedConfigurationVersion.go index 1fdcee39aed..f9e987a8984 100644 --- a/service/appconfig/api_op_GetHostedConfigurationVersion.go +++ b/service/appconfig/api_op_GetHostedConfigurationVersion.go @@ -56,15 +56,15 @@ func (c *Client) GetHostedConfigurationVersion(ctx context.Context, params *GetH type GetHostedConfigurationVersionInput struct { - // The configuration profile ID. + // The application ID. // // This member is required. - ConfigurationProfileId *string + ApplicationId *string - // The application ID. + // The configuration profile ID. // // This member is required. - ApplicationId *string + ConfigurationProfileId *string // The version. // @@ -74,6 +74,15 @@ type GetHostedConfigurationVersionInput struct { type GetHostedConfigurationVersionOutput struct { + // The application ID. + ApplicationId *string + + // The configuration profile ID. + ConfigurationProfileId *string + + // The content of the configuration or the configuration data. + Content []byte + // A standard MIME type describing the format of the configuration content. For // more information, see Content-Type // (https://docs.aws.amazon.com/https:/www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17). @@ -82,18 +91,9 @@ type GetHostedConfigurationVersionOutput struct { // A description of the configuration. Description *string - // The configuration profile ID. - ConfigurationProfileId *string - // The configuration version. VersionNumber *int32 - // The application ID. - ApplicationId *string - - // The content of the configuration or the configuration data. - Content []byte - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/appconfig/api_op_ListApplications.go b/service/appconfig/api_op_ListApplications.go index bd9decd1730..c039816934e 100644 --- a/service/appconfig/api_op_ListApplications.go +++ b/service/appconfig/api_op_ListApplications.go @@ -66,13 +66,13 @@ type ListApplicationsInput struct { type ListApplicationsOutput struct { + // The elements from this collection. + Items []*types.Application + // The token for the next set of items to return. Use this token to get the next // set of results. NextToken *string - // The elements from this collection. - Items []*types.Application - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/appconfig/api_op_ListConfigurationProfiles.go b/service/appconfig/api_op_ListConfigurationProfiles.go index b5372f2a097..69c6684a159 100644 --- a/service/appconfig/api_op_ListConfigurationProfiles.go +++ b/service/appconfig/api_op_ListConfigurationProfiles.go @@ -57,28 +57,28 @@ func (c *Client) ListConfigurationProfiles(ctx context.Context, params *ListConf type ListConfigurationProfilesInput struct { + // The application ID. + // + // This member is required. + ApplicationId *string + // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 // A token to start the list. Use this token to get the next set of results. NextToken *string - - // The application ID. - // - // This member is required. - ApplicationId *string } type ListConfigurationProfilesOutput struct { + // The elements from this collection. + Items []*types.ConfigurationProfileSummary + // The token for the next set of items to return. Use this token to get the next // set of results. NextToken *string - // The elements from this collection. - Items []*types.ConfigurationProfileSummary - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/appconfig/api_op_ListDeploymentStrategies.go b/service/appconfig/api_op_ListDeploymentStrategies.go index a76bafb0189..2eeeca653b6 100644 --- a/service/appconfig/api_op_ListDeploymentStrategies.go +++ b/service/appconfig/api_op_ListDeploymentStrategies.go @@ -56,23 +56,23 @@ func (c *Client) ListDeploymentStrategies(ctx context.Context, params *ListDeplo type ListDeploymentStrategiesInput struct { - // A token to start the list. Use this token to get the next set of results. - NextToken *string - // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 + + // A token to start the list. Use this token to get the next set of results. + NextToken *string } type ListDeploymentStrategiesOutput struct { + // The elements from this collection. + Items []*types.DeploymentStrategy + // The token for the next set of items to return. Use this token to get the next // set of results. NextToken *string - // The elements from this collection. - Items []*types.DeploymentStrategy - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/appconfig/api_op_ListDeployments.go b/service/appconfig/api_op_ListDeployments.go index 66fdcbef6db..edfc779d283 100644 --- a/service/appconfig/api_op_ListDeployments.go +++ b/service/appconfig/api_op_ListDeployments.go @@ -57,13 +57,6 @@ func (c *Client) ListDeployments(ctx context.Context, params *ListDeploymentsInp type ListDeploymentsInput struct { - // The maximum number of items to return for this call. The call also returns a - // token that you can specify in a subsequent call to get the next set of results. - MaxResults *int32 - - // A token to start the list. Use this token to get the next set of results. - NextToken *string - // The application ID. // // This member is required. @@ -73,17 +66,24 @@ type ListDeploymentsInput struct { // // This member is required. EnvironmentId *string + + // The maximum number of items to return for this call. The call also returns a + // token that you can specify in a subsequent call to get the next set of results. + MaxResults *int32 + + // A token to start the list. Use this token to get the next set of results. + NextToken *string } type ListDeploymentsOutput struct { + // The elements from this collection. + Items []*types.DeploymentSummary + // The token for the next set of items to return. Use this token to get the next // set of results. NextToken *string - // The elements from this collection. - Items []*types.DeploymentSummary - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/appconfig/api_op_ListHostedConfigurationVersions.go b/service/appconfig/api_op_ListHostedConfigurationVersions.go index b7f02f73e4a..8730f430d21 100644 --- a/service/appconfig/api_op_ListHostedConfigurationVersions.go +++ b/service/appconfig/api_op_ListHostedConfigurationVersions.go @@ -58,33 +58,33 @@ func (c *Client) ListHostedConfigurationVersions(ctx context.Context, params *Li type ListHostedConfigurationVersionsInput struct { - // A token to start the list. Use this token to get the next set of results. - NextToken *string - // The application ID. // // This member is required. ApplicationId *string - // The maximum number of items to return for this call. The call also returns a - // token that you can specify in a subsequent call to get the next set of results. - MaxResults *int32 - // The configuration profile ID. // // This member is required. ConfigurationProfileId *string + + // The maximum number of items to return for this call. The call also returns a + // token that you can specify in a subsequent call to get the next set of results. + MaxResults *int32 + + // A token to start the list. Use this token to get the next set of results. + NextToken *string } type ListHostedConfigurationVersionsOutput struct { + // The elements from this collection. + Items []*types.HostedConfigurationVersionSummary + // The token for the next set of items to return. Use this token to get the next // set of results. NextToken *string - // The elements from this collection. - Items []*types.HostedConfigurationVersionSummary - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/appconfig/api_op_StartDeployment.go b/service/appconfig/api_op_StartDeployment.go index ba428595142..4b5bd2c7589 100644 --- a/service/appconfig/api_op_StartDeployment.go +++ b/service/appconfig/api_op_StartDeployment.go @@ -63,6 +63,11 @@ type StartDeploymentInput struct { // This member is required. ApplicationId *string + // The configuration profile ID. + // + // This member is required. + ConfigurationProfileId *string + // The configuration version to deploy. // // This member is required. @@ -73,19 +78,14 @@ type StartDeploymentInput struct { // This member is required. DeploymentStrategyId *string - // The configuration profile ID. + // The environment ID. // // This member is required. - ConfigurationProfileId *string + EnvironmentId *string // A description of the deployment. Description *string - // The environment ID. - // - // This member is required. - EnvironmentId *string - // Metadata to assign to the deployment. Tags help organize and categorize your // AppConfig resources. Each tag consists of a key and an optional value, both of // which you define. @@ -94,62 +94,62 @@ type StartDeploymentInput struct { type StartDeploymentOutput struct { - // The ID of the deployment strategy that was deployed. - DeploymentStrategyId *string - // The ID of the application that was deployed. ApplicationId *string + // The time the deployment completed. + CompletedAt *time.Time + // Information about the source location of the configuration. ConfigurationLocationUri *string - // The algorithm used to define how percentage grew over time. - GrowthType types.GrowthType - - // The percentage of targets for which the deployment is available. - PercentageComplete *float32 - - // The state of the deployment. - State types.DeploymentState + // The name of the configuration. + ConfigurationName *string - // A list containing all events related to a deployment. The most recent events are - // displayed first. - EventLog []*types.DeploymentEvent + // The ID of the configuration profile that was deployed. + ConfigurationProfileId *string // The configuration version that was deployed. ConfigurationVersion *string + // Total amount of time the deployment lasted. + DeploymentDurationInMinutes *int32 + + // The sequence number of the deployment. + DeploymentNumber *int32 + + // The ID of the deployment strategy that was deployed. + DeploymentStrategyId *string + // The description of the deployment. Description *string - // The ID of the configuration profile that was deployed. - ConfigurationProfileId *string + // The ID of the environment that was deployed. + EnvironmentId *string - // Total amount of time the deployment lasted. - DeploymentDurationInMinutes *int32 + // A list containing all events related to a deployment. The most recent events are + // displayed first. + EventLog []*types.DeploymentEvent // The amount of time AppConfig monitored for alarms before considering the // deployment to be complete and no longer eligible for automatic roll back. FinalBakeTimeInMinutes *int32 - // The time the deployment started. - StartedAt *time.Time - - // The sequence number of the deployment. - DeploymentNumber *int32 - // The percentage of targets to receive a deployed configuration during each // interval. GrowthFactor *float32 - // The time the deployment completed. - CompletedAt *time.Time + // The algorithm used to define how percentage grew over time. + GrowthType types.GrowthType - // The name of the configuration. - ConfigurationName *string + // The percentage of targets for which the deployment is available. + PercentageComplete *float32 - // The ID of the environment that was deployed. - EnvironmentId *string + // The time the deployment started. + StartedAt *time.Time + + // The state of the deployment. + State types.DeploymentState // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/appconfig/api_op_StopDeployment.go b/service/appconfig/api_op_StopDeployment.go index ca8cf19b794..5ec666c295b 100644 --- a/service/appconfig/api_op_StopDeployment.go +++ b/service/appconfig/api_op_StopDeployment.go @@ -59,80 +59,80 @@ func (c *Client) StopDeployment(ctx context.Context, params *StopDeploymentInput type StopDeploymentInput struct { - // The environment ID. + // The application ID. // // This member is required. - EnvironmentId *string + ApplicationId *string // The sequence number of the deployment. // // This member is required. DeploymentNumber *int32 - // The application ID. + // The environment ID. // // This member is required. - ApplicationId *string + EnvironmentId *string } type StopDeploymentOutput struct { - // The ID of the deployment strategy that was deployed. - DeploymentStrategyId *string - // The ID of the application that was deployed. ApplicationId *string + // The time the deployment completed. + CompletedAt *time.Time + // Information about the source location of the configuration. ConfigurationLocationUri *string - // The algorithm used to define how percentage grew over time. - GrowthType types.GrowthType - - // The percentage of targets for which the deployment is available. - PercentageComplete *float32 - - // The state of the deployment. - State types.DeploymentState + // The name of the configuration. + ConfigurationName *string - // A list containing all events related to a deployment. The most recent events are - // displayed first. - EventLog []*types.DeploymentEvent + // The ID of the configuration profile that was deployed. + ConfigurationProfileId *string // The configuration version that was deployed. ConfigurationVersion *string + // Total amount of time the deployment lasted. + DeploymentDurationInMinutes *int32 + + // The sequence number of the deployment. + DeploymentNumber *int32 + + // The ID of the deployment strategy that was deployed. + DeploymentStrategyId *string + // The description of the deployment. Description *string - // The ID of the configuration profile that was deployed. - ConfigurationProfileId *string + // The ID of the environment that was deployed. + EnvironmentId *string - // Total amount of time the deployment lasted. - DeploymentDurationInMinutes *int32 + // A list containing all events related to a deployment. The most recent events are + // displayed first. + EventLog []*types.DeploymentEvent // The amount of time AppConfig monitored for alarms before considering the // deployment to be complete and no longer eligible for automatic roll back. FinalBakeTimeInMinutes *int32 - // The time the deployment started. - StartedAt *time.Time - - // The sequence number of the deployment. - DeploymentNumber *int32 - // The percentage of targets to receive a deployed configuration during each // interval. GrowthFactor *float32 - // The time the deployment completed. - CompletedAt *time.Time + // The algorithm used to define how percentage grew over time. + GrowthType types.GrowthType - // The name of the configuration. - ConfigurationName *string + // The percentage of targets for which the deployment is available. + PercentageComplete *float32 - // The ID of the environment that was deployed. - EnvironmentId *string + // The time the deployment started. + StartedAt *time.Time + + // The state of the deployment. + State types.DeploymentState // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/appconfig/api_op_UntagResource.go b/service/appconfig/api_op_UntagResource.go index 70e40d20394..bd8edd55fd5 100644 --- a/service/appconfig/api_op_UntagResource.go +++ b/service/appconfig/api_op_UntagResource.go @@ -56,15 +56,15 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The tag keys to delete. + // The ARN of the resource for which to remove tags. // // This member is required. - TagKeys []*string + ResourceArn *string - // The ARN of the resource for which to remove tags. + // The tag keys to delete. // // This member is required. - ResourceArn *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/appconfig/api_op_UpdateApplication.go b/service/appconfig/api_op_UpdateApplication.go index cf8044130e4..19bea25f394 100644 --- a/service/appconfig/api_op_UpdateApplication.go +++ b/service/appconfig/api_op_UpdateApplication.go @@ -56,28 +56,28 @@ func (c *Client) UpdateApplication(ctx context.Context, params *UpdateApplicatio type UpdateApplicationInput struct { + // The application ID. + // + // This member is required. + ApplicationId *string + // A description of the application. Description *string // The name of the application. Name *string - - // The application ID. - // - // This member is required. - ApplicationId *string } type UpdateApplicationOutput struct { - // The application name. - Name *string + // The description of the application. + Description *string // The application ID. Id *string - // The description of the application. - Description *string + // The application name. + Name *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/appconfig/api_op_UpdateConfigurationProfile.go b/service/appconfig/api_op_UpdateConfigurationProfile.go index 02a9589435e..7f901b818c4 100644 --- a/service/appconfig/api_op_UpdateConfigurationProfile.go +++ b/service/appconfig/api_op_UpdateConfigurationProfile.go @@ -57,13 +57,6 @@ func (c *Client) UpdateConfigurationProfile(ctx context.Context, params *UpdateC type UpdateConfigurationProfileInput struct { - // The name of the configuration profile. - Name *string - - // The ARN of an IAM role with permission to access the configuration at the - // specified LocationUri. - RetrievalRoleArn *string - // The application ID. // // This member is required. @@ -77,6 +70,13 @@ type UpdateConfigurationProfileInput struct { // A description of the configuration profile. Description *string + // The name of the configuration profile. + Name *string + + // The ARN of an IAM role with permission to access the configuration at the + // specified LocationUri. + RetrievalRoleArn *string + // A list of methods for validating the configuration. Validators []*types.Validator } @@ -86,24 +86,24 @@ type UpdateConfigurationProfileOutput struct { // The application ID. ApplicationId *string + // The configuration profile description. + Description *string + + // The configuration profile ID. + Id *string + + // The URI location of the configuration. + LocationUri *string + // The name of the configuration profile. Name *string - // A list of methods for validating the configuration. - Validators []*types.Validator - // The ARN of an IAM role with permission to access the configuration at the // specified LocationUri. RetrievalRoleArn *string - // The URI location of the configuration. - LocationUri *string - - // The configuration profile ID. - Id *string - - // The configuration profile description. - Description *string + // A list of methods for validating the configuration. + Validators []*types.Validator // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/appconfig/api_op_UpdateDeploymentStrategy.go b/service/appconfig/api_op_UpdateDeploymentStrategy.go index f3ef3c9e0e6..7dcb98a8212 100644 --- a/service/appconfig/api_op_UpdateDeploymentStrategy.go +++ b/service/appconfig/api_op_UpdateDeploymentStrategy.go @@ -57,9 +57,25 @@ func (c *Client) UpdateDeploymentStrategy(ctx context.Context, params *UpdateDep type UpdateDeploymentStrategyInput struct { + // The deployment strategy ID. + // + // This member is required. + DeploymentStrategyId *string + + // Total amount of time for a deployment to last. + DeploymentDurationInMinutes *int32 + // A description of the deployment strategy. Description *string + // The amount of time AppConfig monitors for alarms before considering the + // deployment to be complete and no longer eligible for automatic roll back. + FinalBakeTimeInMinutes *int32 + + // The percentage of targets to receive a deployed configuration during each + // interval. + GrowthFactor *float32 + // The algorithm used to define how percentage grows over time. AWS AppConfig // supports the following growth types: Linear: For this type, AppConfig processes // the deployment by increments of the growth factor evenly distributed over the @@ -78,51 +94,35 @@ type UpdateDeploymentStrategyInput struct { // targets, 4% of the targets, 8% of the targets, and continues until the // configuration has been deployed to all targets.

GrowthType types.GrowthType +} - // Total amount of time for a deployment to last. +type UpdateDeploymentStrategyOutput struct { + + // Total amount of time the deployment lasted. DeploymentDurationInMinutes *int32 - // The deployment strategy ID. - // - // This member is required. - DeploymentStrategyId *string + // The description of the deployment strategy. + Description *string - // The amount of time AppConfig monitors for alarms before considering the + // The amount of time AppConfig monitored for alarms before considering the // deployment to be complete and no longer eligible for automatic roll back. FinalBakeTimeInMinutes *int32 - // The percentage of targets to receive a deployed configuration during each + // The percentage of targets that received a deployed configuration during each // interval. GrowthFactor *float32 -} - -type UpdateDeploymentStrategyOutput struct { // The algorithm used to define how percentage grew over time. GrowthType types.GrowthType - // Total amount of time the deployment lasted. - DeploymentDurationInMinutes *int32 - - // Save the deployment strategy to a Systems Manager (SSM) document. - ReplicateTo types.ReplicateTo - // The deployment strategy ID. Id *string - // The description of the deployment strategy. - Description *string - - // The amount of time AppConfig monitored for alarms before considering the - // deployment to be complete and no longer eligible for automatic roll back. - FinalBakeTimeInMinutes *int32 - // The name of the deployment strategy. Name *string - // The percentage of targets that received a deployed configuration during each - // interval. - GrowthFactor *float32 + // Save the deployment strategy to a Systems Manager (SSM) document. + ReplicateTo types.ReplicateTo // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/appconfig/api_op_UpdateEnvironment.go b/service/appconfig/api_op_UpdateEnvironment.go index 6b1a67b1878..5c17d3caa83 100644 --- a/service/appconfig/api_op_UpdateEnvironment.go +++ b/service/appconfig/api_op_UpdateEnvironment.go @@ -57,47 +57,47 @@ func (c *Client) UpdateEnvironment(ctx context.Context, params *UpdateEnvironmen type UpdateEnvironmentInput struct { - // A description of the environment. - Description *string - - // Amazon CloudWatch alarms to monitor during the deployment process. - Monitors []*types.Monitor + // The application ID. + // + // This member is required. + ApplicationId *string // The environment ID. // // This member is required. EnvironmentId *string + // A description of the environment. + Description *string + + // Amazon CloudWatch alarms to monitor during the deployment process. + Monitors []*types.Monitor + // The name of the environment. Name *string - - // The application ID. - // - // This member is required. - ApplicationId *string } type UpdateEnvironmentOutput struct { - // The name of the environment. - Name *string - // The application ID. ApplicationId *string // The description of the environment. Description *string - // The state of the environment. An environment can be in one of the following - // states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK - State types.EnvironmentState - // The environment ID. Id *string // Amazon CloudWatch alarms monitored during the deployment. Monitors []*types.Monitor + // The name of the environment. + Name *string + + // The state of the environment. An environment can be in one of the following + // states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK + State types.EnvironmentState + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/appconfig/go.mod b/service/appconfig/go.mod index e5f726b1235..ac60319f278 100644 --- a/service/appconfig/go.mod +++ b/service/appconfig/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/appconfig go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/appconfig/types/types.go b/service/appconfig/types/types.go index 05c8ce3a48c..73c354938d2 100644 --- a/service/appconfig/types/types.go +++ b/service/appconfig/types/types.go @@ -8,14 +8,14 @@ import ( type Application struct { - // The application name. - Name *string + // The description of the application. + Description *string // The application ID. Id *string - // The description of the application. - Description *string + // The application name. + Name *string } // A summary of a configuration profile. @@ -24,55 +24,46 @@ type ConfigurationProfileSummary struct { // The application ID. ApplicationId *string - // The types of validators in the configuration profile. - ValidatorTypes []ValidatorType - - // The name of the configuration profile. - Name *string + // The ID of the configuration profile. + Id *string // The URI location of the configuration. LocationUri *string - // The ID of the configuration profile. - Id *string + // The name of the configuration profile. + Name *string + + // The types of validators in the configuration profile. + ValidatorTypes []ValidatorType } // An object that describes a deployment event. type DeploymentEvent struct { - // The date and time the event occurred. - OccurredAt *time.Time - // A description of the deployment event. Descriptions include, but are not limited // to, the user account or the CloudWatch alarm ARN that initiated a rollback, the // percentage of hosts that received the deployment, or in the case of an internal // error, a recommendation to attempt a new deployment. Description *string - // The entity that triggered the deployment event. Events can be triggered by a - // user, AWS AppConfig, an Amazon CloudWatch alarm, or an internal error. - TriggeredBy TriggeredBy - // The type of deployment event. Deployment event types include the start, stop, or // completion of a deployment; a percentage update; the start or stop of a bake // period; the start or completion of a rollback. EventType DeploymentEventType + + // The date and time the event occurred. + OccurredAt *time.Time + + // The entity that triggered the deployment event. Events can be triggered by a + // user, AWS AppConfig, an Amazon CloudWatch alarm, or an internal error. + TriggeredBy TriggeredBy } type DeploymentStrategy struct { - // The algorithm used to define how percentage grew over time. - GrowthType GrowthType - // Total amount of time the deployment lasted. DeploymentDurationInMinutes *int32 - // Save the deployment strategy to a Systems Manager (SSM) document. - ReplicateTo ReplicateTo - - // The deployment strategy ID. - Id *string - // The description of the deployment strategy. Description *string @@ -80,17 +71,41 @@ type DeploymentStrategy struct { // deployment to be complete and no longer eligible for automatic roll back. FinalBakeTimeInMinutes *int32 - // The name of the deployment strategy. - Name *string - // The percentage of targets that received a deployed configuration during each // interval. GrowthFactor *float32 + + // The algorithm used to define how percentage grew over time. + GrowthType GrowthType + + // The deployment strategy ID. + Id *string + + // The name of the deployment strategy. + Name *string + + // Save the deployment strategy to a Systems Manager (SSM) document. + ReplicateTo ReplicateTo } // Information about the deployment. type DeploymentSummary struct { + // Time the deployment completed. + CompletedAt *time.Time + + // The name of the configuration. + ConfigurationName *string + + // The version of the configuration. + ConfigurationVersion *string + + // Total amount of time the deployment lasted. + DeploymentDurationInMinutes *int32 + + // The sequence number of the deployment. + DeploymentNumber *int32 + // The amount of time AppConfig monitors for alarms before considering the // deployment to be complete and no longer eligible for automatic roll back. FinalBakeTimeInMinutes *int32 @@ -99,15 +114,6 @@ type DeploymentSummary struct { // interval. GrowthFactor *float32 - // The sequence number of the deployment. - DeploymentNumber *int32 - - // Time the deployment completed. - CompletedAt *time.Time - - // Total amount of time the deployment lasted. - DeploymentDurationInMinutes *int32 - // The algorithm used to define how percentage grows over time. GrowthType GrowthType @@ -117,57 +123,51 @@ type DeploymentSummary struct { // Time the deployment started. StartedAt *time.Time - // The name of the configuration. - ConfigurationName *string - - // The version of the configuration. - ConfigurationVersion *string - // The state of the deployment. State DeploymentState } type Environment struct { - // The name of the environment. - Name *string - // The application ID. ApplicationId *string // The description of the environment. Description *string - // The state of the environment. An environment can be in one of the following - // states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK - State EnvironmentState - // The environment ID. Id *string // Amazon CloudWatch alarms monitored during the deployment. Monitors []*Monitor + + // The name of the environment. + Name *string + + // The state of the environment. An environment can be in one of the following + // states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK + State EnvironmentState } // Information about the configuration. type HostedConfigurationVersionSummary struct { - // A description of the configuration. - Description *string - // The application ID. ApplicationId *string - // The configuration version. - VersionNumber *int32 + // The configuration profile ID. + ConfigurationProfileId *string // A standard MIME type describing the format of the configuration content. For // more information, see Content-Type // (https://docs.aws.amazon.com/https:/www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17). ContentType *string - // The configuration profile ID. - ConfigurationProfileId *string + // A description of the configuration. + Description *string + + // The configuration version. + VersionNumber *int32 } // Amazon CloudWatch alarms to monitor during the deployment process. diff --git a/service/applicationautoscaling/api_op_DeleteScalingPolicy.go b/service/applicationautoscaling/api_op_DeleteScalingPolicy.go index be4cb09fb74..89e9131cd50 100644 --- a/service/applicationautoscaling/api_op_DeleteScalingPolicy.go +++ b/service/applicationautoscaling/api_op_DeleteScalingPolicy.go @@ -65,6 +65,11 @@ func (c *Client) DeleteScalingPolicy(ctx context.Context, params *DeleteScalingP type DeleteScalingPolicyInput struct { + // The name of the scaling policy. + // + // This member is required. + PolicyName *string + // The identifier of the resource associated with the scalable target. This string // consists of the resource type and unique identifier. // @@ -191,11 +196,6 @@ type DeleteScalingPolicyInput struct { // // This member is required. ServiceNamespace types.ServiceNamespace - - // The name of the scaling policy. - // - // This member is required. - PolicyName *string } type DeleteScalingPolicyOutput struct { diff --git a/service/applicationautoscaling/api_op_DeleteScheduledAction.go b/service/applicationautoscaling/api_op_DeleteScheduledAction.go index 12d2d86a87a..d867ab4c85f 100644 --- a/service/applicationautoscaling/api_op_DeleteScheduledAction.go +++ b/service/applicationautoscaling/api_op_DeleteScheduledAction.go @@ -60,72 +60,6 @@ func (c *Client) DeleteScheduledAction(ctx context.Context, params *DeleteSchedu type DeleteScheduledActionInput struct { - // The scalable dimension. This string consists of the service namespace, resource - // type, and scaling property. - // - // * ecs:service:DesiredCount - The desired task - // count of an ECS service. - // - // * ec2:spot-fleet-request:TargetCapacity - The - // target capacity of a Spot Fleet request. - // - // * - // elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR - // Instance Group. - // - // * appstream:fleet:DesiredCapacity - The desired capacity of - // an AppStream 2.0 fleet. - // - // * dynamodb:table:ReadCapacityUnits - The - // provisioned read capacity for a DynamoDB table. - // - // * - // dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a - // DynamoDB table. - // - // * dynamodb:index:ReadCapacityUnits - The provisioned read - // capacity for a DynamoDB global secondary index. - // - // * - // dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a - // DynamoDB global secondary index. - // - // * rds:cluster:ReadReplicaCount - The count - // of Aurora Replicas in an Aurora DB cluster. Available for Aurora - // MySQL-compatible edition and Aurora PostgreSQL-compatible edition. - // - // * - // sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an - // Amazon SageMaker model endpoint variant. - // - // * - // custom-resource:ResourceType:Property - The scalable dimension for a custom - // resource provided by your own application or service. - // - // * - // comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of - // inference units for an Amazon Comprehend document classification endpoint. - // - // - // * lambda:function:ProvisionedConcurrency - The provisioned concurrency for a - // Lambda function. - // - // * cassandra:table:ReadCapacityUnits - The provisioned read - // capacity for an Amazon Keyspaces table. - // - // * - // cassandra:table:WriteCapacityUnits - The provisioned write capacity for an - // Amazon Keyspaces table. - // - // This member is required. - ScalableDimension types.ScalableDimension - - // The namespace of the AWS service that provides the resource. For a resource - // provided by your own application or service, use custom-resource instead. - // - // This member is required. - ServiceNamespace types.ServiceNamespace - // The identifier of the resource associated with the scheduled action. This string // consists of the resource type and unique identifier. // @@ -187,10 +121,76 @@ type DeleteScheduledActionInput struct { // This member is required. ResourceId *string + // The scalable dimension. This string consists of the service namespace, resource + // type, and scaling property. + // + // * ecs:service:DesiredCount - The desired task + // count of an ECS service. + // + // * ec2:spot-fleet-request:TargetCapacity - The + // target capacity of a Spot Fleet request. + // + // * + // elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR + // Instance Group. + // + // * appstream:fleet:DesiredCapacity - The desired capacity of + // an AppStream 2.0 fleet. + // + // * dynamodb:table:ReadCapacityUnits - The + // provisioned read capacity for a DynamoDB table. + // + // * + // dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB table. + // + // * dynamodb:index:ReadCapacityUnits - The provisioned read + // capacity for a DynamoDB global secondary index. + // + // * + // dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB global secondary index. + // + // * rds:cluster:ReadReplicaCount - The count + // of Aurora Replicas in an Aurora DB cluster. Available for Aurora + // MySQL-compatible edition and Aurora PostgreSQL-compatible edition. + // + // * + // sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an + // Amazon SageMaker model endpoint variant. + // + // * + // custom-resource:ResourceType:Property - The scalable dimension for a custom + // resource provided by your own application or service. + // + // * + // comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of + // inference units for an Amazon Comprehend document classification endpoint. + // + // + // * lambda:function:ProvisionedConcurrency - The provisioned concurrency for a + // Lambda function. + // + // * cassandra:table:ReadCapacityUnits - The provisioned read + // capacity for an Amazon Keyspaces table. + // + // * + // cassandra:table:WriteCapacityUnits - The provisioned write capacity for an + // Amazon Keyspaces table. + // + // This member is required. + ScalableDimension types.ScalableDimension + // The name of the scheduled action. // // This member is required. ScheduledActionName *string + + // The namespace of the AWS service that provides the resource. For a resource + // provided by your own application or service, use custom-resource instead. + // + // This member is required. + ServiceNamespace types.ServiceNamespace } type DeleteScheduledActionOutput struct { diff --git a/service/applicationautoscaling/api_op_DeregisterScalableTarget.go b/service/applicationautoscaling/api_op_DeregisterScalableTarget.go index 15d79010ab7..7664e4e7fb6 100644 --- a/service/applicationautoscaling/api_op_DeregisterScalableTarget.go +++ b/service/applicationautoscaling/api_op_DeregisterScalableTarget.go @@ -62,11 +62,66 @@ func (c *Client) DeregisterScalableTarget(ctx context.Context, params *Deregiste type DeregisterScalableTargetInput struct { - // The namespace of the AWS service that provides the resource. For a resource - // provided by your own application or service, use custom-resource instead. + // The identifier of the resource associated with the scalable target. This string + // consists of the resource type and unique identifier. + // + // * ECS service - The + // resource type is service and the unique identifier is the cluster name and + // service name. Example: service/default/sample-webapp. + // + // * Spot Fleet request + // - The resource type is spot-fleet-request and the unique identifier is the Spot + // Fleet request ID. Example: + // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. + // + // * EMR cluster + // - The resource type is instancegroup and the unique identifier is the cluster ID + // and instance group ID. Example: + // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. + // + // * AppStream 2.0 fleet - The + // resource type is fleet and the unique identifier is the fleet name. Example: + // fleet/sample-fleet. + // + // * DynamoDB table - The resource type is table and the + // unique identifier is the table name. Example: table/my-table. + // + // * DynamoDB + // global secondary index - The resource type is index and the unique identifier is + // the index name. Example: table/my-table/index/my-table-index. + // + // * Aurora DB + // cluster - The resource type is cluster and the unique identifier is the cluster + // name. Example: cluster:my-db-cluster. + // + // * Amazon SageMaker endpoint variant - + // The resource type is variant and the unique identifier is the resource ID. + // Example: endpoint/my-end-point/variant/KMeansClustering. + // + // * Custom resources + // are not supported with a resource type. This parameter must specify the + // OutputValue from the CloudFormation template stack used to access the resources. + // The unique identifier is defined by the service provider. More information is + // available in our GitHub repository + // (https://github.com/aws/aws-auto-scaling-custom-resource). + // + // * Amazon + // Comprehend document classification endpoint - The resource type and unique + // identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. + // + // + // * Lambda provisioned concurrency - The resource type is function and the unique + // identifier is the function name with a function version or alias name suffix + // that is not $LATEST. Example: function:my-function:prod or + // function:my-function:1. + // + // * Amazon Keyspaces table - The resource type is + // table and the unique identifier is the table name. Example: + // keyspace/mykeyspace/table/mytable. // // This member is required. - ServiceNamespace types.ServiceNamespace + ResourceId *string // The scalable dimension associated with the scalable target. This string consists // of the service namespace, resource type, and scaling property. @@ -128,66 +183,11 @@ type DeregisterScalableTargetInput struct { // This member is required. ScalableDimension types.ScalableDimension - // The identifier of the resource associated with the scalable target. This string - // consists of the resource type and unique identifier. - // - // * ECS service - The - // resource type is service and the unique identifier is the cluster name and - // service name. Example: service/default/sample-webapp. - // - // * Spot Fleet request - // - The resource type is spot-fleet-request and the unique identifier is the Spot - // Fleet request ID. Example: - // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - // - // * EMR cluster - // - The resource type is instancegroup and the unique identifier is the cluster ID - // and instance group ID. Example: - // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. - // - // * AppStream 2.0 fleet - The - // resource type is fleet and the unique identifier is the fleet name. Example: - // fleet/sample-fleet. - // - // * DynamoDB table - The resource type is table and the - // unique identifier is the table name. Example: table/my-table. - // - // * DynamoDB - // global secondary index - The resource type is index and the unique identifier is - // the index name. Example: table/my-table/index/my-table-index. - // - // * Aurora DB - // cluster - The resource type is cluster and the unique identifier is the cluster - // name. Example: cluster:my-db-cluster. - // - // * Amazon SageMaker endpoint variant - - // The resource type is variant and the unique identifier is the resource ID. - // Example: endpoint/my-end-point/variant/KMeansClustering. - // - // * Custom resources - // are not supported with a resource type. This parameter must specify the - // OutputValue from the CloudFormation template stack used to access the resources. - // The unique identifier is defined by the service provider. More information is - // available in our GitHub repository - // (https://github.com/aws/aws-auto-scaling-custom-resource). - // - // * Amazon - // Comprehend document classification endpoint - The resource type and unique - // identifier are specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. - // - // - // * Lambda provisioned concurrency - The resource type is function and the unique - // identifier is the function name with a function version or alias name suffix - // that is not $LATEST. Example: function:my-function:prod or - // function:my-function:1. - // - // * Amazon Keyspaces table - The resource type is - // table and the unique identifier is the table name. Example: - // keyspace/mykeyspace/table/mytable. + // The namespace of the AWS service that provides the resource. For a resource + // provided by your own application or service, use custom-resource instead. // // This member is required. - ResourceId *string + ServiceNamespace types.ServiceNamespace } type DeregisterScalableTargetOutput struct { diff --git a/service/applicationautoscaling/api_op_DescribeScalableTargets.go b/service/applicationautoscaling/api_op_DescribeScalableTargets.go index b2377ec7f22..c7be3d2c270 100644 --- a/service/applicationautoscaling/api_op_DescribeScalableTargets.go +++ b/service/applicationautoscaling/api_op_DescribeScalableTargets.go @@ -72,6 +72,9 @@ type DescribeScalableTargetsInput struct { // applicable. MaxResults *int32 + // The token for the next set of results. + NextToken *string + // The identifier of the resource associated with the scalable target. This string // consists of the resource type and unique identifier. If you specify a scalable // dimension, you must also specify a resource ID. @@ -132,9 +135,6 @@ type DescribeScalableTargetsInput struct { // keyspace/mykeyspace/table/mytable. ResourceIds []*string - // The token for the next set of results. - NextToken *string - // The scalable dimension associated with the scalable target. This string consists // of the service namespace, resource type, and scaling property. If you specify a // scalable dimension, you must also specify a resource ID. @@ -197,13 +197,13 @@ type DescribeScalableTargetsInput struct { type DescribeScalableTargetsOutput struct { - // The scalable targets that match the request parameters. - ScalableTargets []*types.ScalableTarget - // The token required to get the next set of results. This value is null if there // are no more results to return. NextToken *string + // The scalable targets that match the request parameters. + ScalableTargets []*types.ScalableTarget + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/applicationautoscaling/api_op_DescribeScalingActivities.go b/service/applicationautoscaling/api_op_DescribeScalingActivities.go index 9a0df19d1f1..bf15bd01437 100644 --- a/service/applicationautoscaling/api_op_DescribeScalingActivities.go +++ b/service/applicationautoscaling/api_op_DescribeScalingActivities.go @@ -59,6 +59,23 @@ func (c *Client) DescribeScalingActivities(ctx context.Context, params *Describe type DescribeScalingActivitiesInput struct { + // The namespace of the AWS service that provides the resource. For a resource + // provided by your own application or service, use custom-resource instead. + // + // This member is required. + ServiceNamespace types.ServiceNamespace + + // The maximum number of scalable targets. This value can be between 1 and 50. The + // default value is 50. If this parameter is used, the operation returns up to + // MaxResults results at a time, along with a NextToken value. To get the next set + // of results, include the NextToken value in a subsequent call. If this parameter + // is not used, the operation returns up to 50 results and a NextToken value, if + // applicable. + MaxResults *int32 + + // The token for the next set of results. + NextToken *string + // The identifier of the resource associated with the scaling activity. This string // consists of the resource type and unique identifier. If you specify a scalable // dimension, you must also specify a resource ID. @@ -177,34 +194,17 @@ type DescribeScalingActivitiesInput struct { // cassandra:table:WriteCapacityUnits - The provisioned write capacity for an // Amazon Keyspaces table. ScalableDimension types.ScalableDimension - - // The token for the next set of results. - NextToken *string - - // The namespace of the AWS service that provides the resource. For a resource - // provided by your own application or service, use custom-resource instead. - // - // This member is required. - ServiceNamespace types.ServiceNamespace - - // The maximum number of scalable targets. This value can be between 1 and 50. The - // default value is 50. If this parameter is used, the operation returns up to - // MaxResults results at a time, along with a NextToken value. To get the next set - // of results, include the NextToken value in a subsequent call. If this parameter - // is not used, the operation returns up to 50 results and a NextToken value, if - // applicable. - MaxResults *int32 } type DescribeScalingActivitiesOutput struct { - // A list of scaling activity objects. - ScalingActivities []*types.ScalingActivity - // The token required to get the next set of results. This value is null if there // are no more results to return. NextToken *string + // A list of scaling activity objects. + ScalingActivities []*types.ScalingActivity + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/applicationautoscaling/api_op_DescribeScalingPolicies.go b/service/applicationautoscaling/api_op_DescribeScalingPolicies.go index 6465d7dbe73..743271d506a 100644 --- a/service/applicationautoscaling/api_op_DescribeScalingPolicies.go +++ b/service/applicationautoscaling/api_op_DescribeScalingPolicies.go @@ -64,77 +64,12 @@ func (c *Client) DescribeScalingPolicies(ctx context.Context, params *DescribeSc type DescribeScalingPoliciesInput struct { - // The token for the next set of results. - NextToken *string - // The namespace of the AWS service that provides the resource. For a resource // provided by your own application or service, use custom-resource instead. // // This member is required. ServiceNamespace types.ServiceNamespace - // The scalable dimension. This string consists of the service namespace, resource - // type, and scaling property. If you specify a scalable dimension, you must also - // specify a resource ID. - // - // * ecs:service:DesiredCount - The desired task count - // of an ECS service. - // - // * ec2:spot-fleet-request:TargetCapacity - The target - // capacity of a Spot Fleet request. - // - // * - // elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR - // Instance Group. - // - // * appstream:fleet:DesiredCapacity - The desired capacity of - // an AppStream 2.0 fleet. - // - // * dynamodb:table:ReadCapacityUnits - The - // provisioned read capacity for a DynamoDB table. - // - // * - // dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a - // DynamoDB table. - // - // * dynamodb:index:ReadCapacityUnits - The provisioned read - // capacity for a DynamoDB global secondary index. - // - // * - // dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a - // DynamoDB global secondary index. - // - // * rds:cluster:ReadReplicaCount - The count - // of Aurora Replicas in an Aurora DB cluster. Available for Aurora - // MySQL-compatible edition and Aurora PostgreSQL-compatible edition. - // - // * - // sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an - // Amazon SageMaker model endpoint variant. - // - // * - // custom-resource:ResourceType:Property - The scalable dimension for a custom - // resource provided by your own application or service. - // - // * - // comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of - // inference units for an Amazon Comprehend document classification endpoint. - // - // - // * lambda:function:ProvisionedConcurrency - The provisioned concurrency for a - // Lambda function. - // - // * cassandra:table:ReadCapacityUnits - The provisioned read - // capacity for an Amazon Keyspaces table. - // - // * - // cassandra:table:WriteCapacityUnits - The provisioned write capacity for an - // Amazon Keyspaces table. - ScalableDimension types.ScalableDimension - - // The names of the scaling policies to describe. - PolicyNames []*string - // The maximum number of scalable targets. This value can be between 1 and 50. The // default value is 50. If this parameter is used, the operation returns up to // MaxResults results at a time, along with a NextToken value. To get the next set @@ -143,6 +78,12 @@ type DescribeScalingPoliciesInput struct { // applicable. MaxResults *int32 + // The token for the next set of results. + NextToken *string + + // The names of the scaling policies to describe. + PolicyNames []*string + // The identifier of the resource associated with the scaling policy. This string // consists of the resource type and unique identifier. If you specify a scalable // dimension, you must also specify a resource ID. @@ -202,6 +143,65 @@ type DescribeScalingPoliciesInput struct { // table and the unique identifier is the table name. Example: // keyspace/mykeyspace/table/mytable. ResourceId *string + + // The scalable dimension. This string consists of the service namespace, resource + // type, and scaling property. If you specify a scalable dimension, you must also + // specify a resource ID. + // + // * ecs:service:DesiredCount - The desired task count + // of an ECS service. + // + // * ec2:spot-fleet-request:TargetCapacity - The target + // capacity of a Spot Fleet request. + // + // * + // elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR + // Instance Group. + // + // * appstream:fleet:DesiredCapacity - The desired capacity of + // an AppStream 2.0 fleet. + // + // * dynamodb:table:ReadCapacityUnits - The + // provisioned read capacity for a DynamoDB table. + // + // * + // dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB table. + // + // * dynamodb:index:ReadCapacityUnits - The provisioned read + // capacity for a DynamoDB global secondary index. + // + // * + // dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB global secondary index. + // + // * rds:cluster:ReadReplicaCount - The count + // of Aurora Replicas in an Aurora DB cluster. Available for Aurora + // MySQL-compatible edition and Aurora PostgreSQL-compatible edition. + // + // * + // sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an + // Amazon SageMaker model endpoint variant. + // + // * + // custom-resource:ResourceType:Property - The scalable dimension for a custom + // resource provided by your own application or service. + // + // * + // comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of + // inference units for an Amazon Comprehend document classification endpoint. + // + // + // * lambda:function:ProvisionedConcurrency - The provisioned concurrency for a + // Lambda function. + // + // * cassandra:table:ReadCapacityUnits - The provisioned read + // capacity for an Amazon Keyspaces table. + // + // * + // cassandra:table:WriteCapacityUnits - The provisioned write capacity for an + // Amazon Keyspaces table. + ScalableDimension types.ScalableDimension } type DescribeScalingPoliciesOutput struct { diff --git a/service/applicationautoscaling/api_op_DescribeScheduledActions.go b/service/applicationautoscaling/api_op_DescribeScheduledActions.go index 44b5ee1c791..df6aa88aa5d 100644 --- a/service/applicationautoscaling/api_op_DescribeScheduledActions.go +++ b/service/applicationautoscaling/api_op_DescribeScheduledActions.go @@ -62,67 +62,22 @@ func (c *Client) DescribeScheduledActions(ctx context.Context, params *DescribeS type DescribeScheduledActionsInput struct { - // The names of the scheduled actions to describe. - ScheduledActionNames []*string - - // The scalable dimension. This string consists of the service namespace, resource - // type, and scaling property. If you specify a scalable dimension, you must also - // specify a resource ID. - // - // * ecs:service:DesiredCount - The desired task count - // of an ECS service. - // - // * ec2:spot-fleet-request:TargetCapacity - The target - // capacity of a Spot Fleet request. - // - // * - // elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR - // Instance Group. - // - // * appstream:fleet:DesiredCapacity - The desired capacity of - // an AppStream 2.0 fleet. - // - // * dynamodb:table:ReadCapacityUnits - The - // provisioned read capacity for a DynamoDB table. - // - // * - // dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a - // DynamoDB table. - // - // * dynamodb:index:ReadCapacityUnits - The provisioned read - // capacity for a DynamoDB global secondary index. - // - // * - // dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a - // DynamoDB global secondary index. - // - // * rds:cluster:ReadReplicaCount - The count - // of Aurora Replicas in an Aurora DB cluster. Available for Aurora - // MySQL-compatible edition and Aurora PostgreSQL-compatible edition. - // - // * - // sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an - // Amazon SageMaker model endpoint variant. - // - // * - // custom-resource:ResourceType:Property - The scalable dimension for a custom - // resource provided by your own application or service. - // - // * - // comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of - // inference units for an Amazon Comprehend document classification endpoint. - // - // - // * lambda:function:ProvisionedConcurrency - The provisioned concurrency for a - // Lambda function. - // - // * cassandra:table:ReadCapacityUnits - The provisioned read - // capacity for an Amazon Keyspaces table. + // The namespace of the AWS service that provides the resource. For a resource + // provided by your own application or service, use custom-resource instead. // - // * - // cassandra:table:WriteCapacityUnits - The provisioned write capacity for an - // Amazon Keyspaces table. - ScalableDimension types.ScalableDimension + // This member is required. + ServiceNamespace types.ServiceNamespace + + // The maximum number of scheduled action results. This value can be between 1 and + // 50. The default value is 50. If this parameter is used, the operation returns up + // to MaxResults results at a time, along with a NextToken value. To get the next + // set of results, include the NextToken value in a subsequent call. If this + // parameter is not used, the operation returns up to 50 results and a NextToken + // value, if applicable. + MaxResults *int32 + + // The token for the next set of results. + NextToken *string // The identifier of the resource associated with the scheduled action. This string // consists of the resource type and unique identifier. If you specify a scalable @@ -184,33 +139,78 @@ type DescribeScheduledActionsInput struct { // keyspace/mykeyspace/table/mytable. ResourceId *string - // The token for the next set of results. - NextToken *string - - // The namespace of the AWS service that provides the resource. For a resource - // provided by your own application or service, use custom-resource instead. + // The scalable dimension. This string consists of the service namespace, resource + // type, and scaling property. If you specify a scalable dimension, you must also + // specify a resource ID. // - // This member is required. - ServiceNamespace types.ServiceNamespace + // * ecs:service:DesiredCount - The desired task count + // of an ECS service. + // + // * ec2:spot-fleet-request:TargetCapacity - The target + // capacity of a Spot Fleet request. + // + // * + // elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR + // Instance Group. + // + // * appstream:fleet:DesiredCapacity - The desired capacity of + // an AppStream 2.0 fleet. + // + // * dynamodb:table:ReadCapacityUnits - The + // provisioned read capacity for a DynamoDB table. + // + // * + // dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB table. + // + // * dynamodb:index:ReadCapacityUnits - The provisioned read + // capacity for a DynamoDB global secondary index. + // + // * + // dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB global secondary index. + // + // * rds:cluster:ReadReplicaCount - The count + // of Aurora Replicas in an Aurora DB cluster. Available for Aurora + // MySQL-compatible edition and Aurora PostgreSQL-compatible edition. + // + // * + // sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an + // Amazon SageMaker model endpoint variant. + // + // * + // custom-resource:ResourceType:Property - The scalable dimension for a custom + // resource provided by your own application or service. + // + // * + // comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of + // inference units for an Amazon Comprehend document classification endpoint. + // + // + // * lambda:function:ProvisionedConcurrency - The provisioned concurrency for a + // Lambda function. + // + // * cassandra:table:ReadCapacityUnits - The provisioned read + // capacity for an Amazon Keyspaces table. + // + // * + // cassandra:table:WriteCapacityUnits - The provisioned write capacity for an + // Amazon Keyspaces table. + ScalableDimension types.ScalableDimension - // The maximum number of scheduled action results. This value can be between 1 and - // 50. The default value is 50. If this parameter is used, the operation returns up - // to MaxResults results at a time, along with a NextToken value. To get the next - // set of results, include the NextToken value in a subsequent call. If this - // parameter is not used, the operation returns up to 50 results and a NextToken - // value, if applicable. - MaxResults *int32 + // The names of the scheduled actions to describe. + ScheduledActionNames []*string } type DescribeScheduledActionsOutput struct { - // Information about the scheduled actions. - ScheduledActions []*types.ScheduledAction - // The token required to get the next set of results. This value is null if there // are no more results to return. NextToken *string + // Information about the scheduled actions. + ScheduledActions []*types.ScheduledAction + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/applicationautoscaling/api_op_PutScalingPolicy.go b/service/applicationautoscaling/api_op_PutScalingPolicy.go index 7a48c0a8928..1a94fdff57c 100644 --- a/service/applicationautoscaling/api_op_PutScalingPolicy.go +++ b/service/applicationautoscaling/api_op_PutScalingPolicy.go @@ -84,16 +84,10 @@ func (c *Client) PutScalingPolicy(ctx context.Context, params *PutScalingPolicyI type PutScalingPolicyInput struct { - // The policy type. This parameter is required if you are creating a scaling - // policy. The following policy types are supported: TargetTrackingScaling—Not - // supported for Amazon EMR StepScaling—Not supported for DynamoDB, Amazon - // Comprehend, Lambda, or Amazon Keyspaces (for Apache Cassandra). For more - // information, see Target Tracking Scaling Policies - // (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) - // and Step Scaling Policies - // (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) - // in the Application Auto Scaling User Guide. - PolicyType types.PolicyType + // The name of the scaling policy. + // + // This member is required. + PolicyName *string // The identifier of the resource associated with the scaling policy. This string // consists of the resource type and unique identifier. @@ -156,11 +150,6 @@ type PutScalingPolicyInput struct { // This member is required. ResourceId *string - // A target tracking scaling policy. Includes support for predefined or customized - // metrics. This parameter is required if you are creating a policy and the policy - // type is TargetTrackingScaling. - TargetTrackingScalingPolicyConfiguration *types.TargetTrackingScalingPolicyConfiguration - // The scalable dimension. This string consists of the service namespace, resource // type, and scaling property. // @@ -221,20 +210,31 @@ type PutScalingPolicyInput struct { // This member is required. ScalableDimension types.ScalableDimension - // A step scaling policy. This parameter is required if you are creating a policy - // and the policy type is StepScaling. - StepScalingPolicyConfiguration *types.StepScalingPolicyConfiguration - - // The name of the scaling policy. - // - // This member is required. - PolicyName *string - // The namespace of the AWS service that provides the resource. For a resource // provided by your own application or service, use custom-resource instead. // // This member is required. ServiceNamespace types.ServiceNamespace + + // The policy type. This parameter is required if you are creating a scaling + // policy. The following policy types are supported: TargetTrackingScaling—Not + // supported for Amazon EMR StepScaling—Not supported for DynamoDB, Amazon + // Comprehend, Lambda, or Amazon Keyspaces (for Apache Cassandra). For more + // information, see Target Tracking Scaling Policies + // (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) + // and Step Scaling Policies + // (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) + // in the Application Auto Scaling User Guide. + PolicyType types.PolicyType + + // A step scaling policy. This parameter is required if you are creating a policy + // and the policy type is StepScaling. + StepScalingPolicyConfiguration *types.StepScalingPolicyConfiguration + + // A target tracking scaling policy. Includes support for predefined or customized + // metrics. This parameter is required if you are creating a policy and the policy + // type is TargetTrackingScaling. + TargetTrackingScalingPolicyConfiguration *types.TargetTrackingScalingPolicyConfiguration } type PutScalingPolicyOutput struct { diff --git a/service/applicationautoscaling/api_op_PutScheduledAction.go b/service/applicationautoscaling/api_op_PutScheduledAction.go index 86c1f1dfd82..feab4b653be 100644 --- a/service/applicationautoscaling/api_op_PutScheduledAction.go +++ b/service/applicationautoscaling/api_op_PutScheduledAction.go @@ -133,12 +133,6 @@ type PutScheduledActionInput struct { // This member is required. ResourceId *string - // The date and time for the recurring schedule to end. - EndTime *time.Time - - // The date and time for this scheduled action to start. - StartTime *time.Time - // The scalable dimension. This string consists of the service namespace, resource // type, and scaling property. // @@ -199,6 +193,28 @@ type PutScheduledActionInput struct { // This member is required. ScalableDimension types.ScalableDimension + // The name of the scheduled action. This name must be unique among all other + // scheduled actions on the specified scalable target. + // + // This member is required. + ScheduledActionName *string + + // The namespace of the AWS service that provides the resource. For a resource + // provided by your own application or service, use custom-resource instead. + // + // This member is required. + ServiceNamespace types.ServiceNamespace + + // The date and time for the recurring schedule to end. + EndTime *time.Time + + // The new minimum and maximum capacity. You can set both values or just one. At + // the scheduled time, if the current capacity is below the minimum capacity, + // Application Auto Scaling scales out to the minimum capacity. If the current + // capacity is above the maximum capacity, Application Auto Scaling scales in to + // the maximum capacity. + ScalableTargetAction *types.ScalableTargetAction + // The schedule for this action. The following formats are supported: // // * At @@ -220,24 +236,8 @@ type PutScheduledActionInput struct { // in the Application Auto Scaling User Guide. Schedule *string - // The namespace of the AWS service that provides the resource. For a resource - // provided by your own application or service, use custom-resource instead. - // - // This member is required. - ServiceNamespace types.ServiceNamespace - - // The name of the scheduled action. This name must be unique among all other - // scheduled actions on the specified scalable target. - // - // This member is required. - ScheduledActionName *string - - // The new minimum and maximum capacity. You can set both values or just one. At - // the scheduled time, if the current capacity is below the minimum capacity, - // Application Auto Scaling scales out to the minimum capacity. If the current - // capacity is above the maximum capacity, Application Auto Scaling scales in to - // the maximum capacity. - ScalableTargetAction *types.ScalableTargetAction + // The date and time for this scheduled action to start. + StartTime *time.Time } type PutScheduledActionOutput struct { diff --git a/service/applicationautoscaling/api_op_RegisterScalableTarget.go b/service/applicationautoscaling/api_op_RegisterScalableTarget.go index dcfd1112acf..cc9abb011ec 100644 --- a/service/applicationautoscaling/api_op_RegisterScalableTarget.go +++ b/service/applicationautoscaling/api_op_RegisterScalableTarget.go @@ -76,21 +76,6 @@ func (c *Client) RegisterScalableTarget(ctx context.Context, params *RegisterSca type RegisterScalableTargetInput struct { - // The minimum value that you plan to scale in to. When a scaling policy is in - // effect, Application Auto Scaling can scale in (contract) as needed to the - // minimum capacity limit in response to changing demand. This parameter is - // required if you are registering a scalable target. For certain resources, the - // minimum value allowed is 0. This includes Lambda provisioned concurrency, Spot - // Fleet, ECS services, Aurora DB clusters, EMR clusters, and custom resources. For - // all other resources, the minimum value allowed is 1. - MinCapacity *int32 - - // The maximum value that you plan to scale out to. When a scaling policy is in - // effect, Application Auto Scaling can scale out (expand) as needed to the maximum - // capacity limit in response to changing demand. This parameter is required if you - // are registering a scalable target. - MaxCapacity *int32 - // The identifier of the resource that is associated with the scalable target. This // string consists of the resource type and unique identifier. // @@ -152,44 +137,6 @@ type RegisterScalableTargetInput struct { // This member is required. ResourceId *string - // An embedded object that contains attributes and attribute values that are used - // to suspend and resume automatic scaling. Setting the value of an attribute to - // true suspends the specified scaling activities. Setting it to false (default) - // resumes the specified scaling activities. Suspension Outcomes - // - // * For - // DynamicScalingInSuspended, while a suspension is in effect, all scale-in - // activities that are triggered by a scaling policy are suspended. - // - // * For - // DynamicScalingOutSuspended, while a suspension is in effect, all scale-out - // activities that are triggered by a scaling policy are suspended. - // - // * For - // ScheduledScalingSuspended, while a suspension is in effect, all scaling - // activities that involve scheduled actions are suspended. - // - // For more information, - // see Suspending and Resuming Scaling - // (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html) - // in the Application Auto Scaling User Guide. - SuspendedState *types.SuspendedState - - // This parameter is required for services that do not support service-linked roles - // (such as Amazon EMR), and it must specify the ARN of an IAM role that allows - // Application Auto Scaling to modify the scalable target on your behalf. If the - // service supports service-linked roles, Application Auto Scaling uses a - // service-linked role, which it creates if it does not yet exist. For more - // information, see Application Auto Scaling IAM Roles - // (https://docs.aws.amazon.com/autoscaling/application/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-roles). - RoleARN *string - - // The namespace of the AWS service that provides the resource. For a resource - // provided by your own application or service, use custom-resource instead. - // - // This member is required. - ServiceNamespace types.ServiceNamespace - // The scalable dimension associated with the scalable target. This string consists // of the service namespace, resource type, and scaling property. // @@ -249,6 +196,59 @@ type RegisterScalableTargetInput struct { // // This member is required. ScalableDimension types.ScalableDimension + + // The namespace of the AWS service that provides the resource. For a resource + // provided by your own application or service, use custom-resource instead. + // + // This member is required. + ServiceNamespace types.ServiceNamespace + + // The maximum value that you plan to scale out to. When a scaling policy is in + // effect, Application Auto Scaling can scale out (expand) as needed to the maximum + // capacity limit in response to changing demand. This parameter is required if you + // are registering a scalable target. + MaxCapacity *int32 + + // The minimum value that you plan to scale in to. When a scaling policy is in + // effect, Application Auto Scaling can scale in (contract) as needed to the + // minimum capacity limit in response to changing demand. This parameter is + // required if you are registering a scalable target. For certain resources, the + // minimum value allowed is 0. This includes Lambda provisioned concurrency, Spot + // Fleet, ECS services, Aurora DB clusters, EMR clusters, and custom resources. For + // all other resources, the minimum value allowed is 1. + MinCapacity *int32 + + // This parameter is required for services that do not support service-linked roles + // (such as Amazon EMR), and it must specify the ARN of an IAM role that allows + // Application Auto Scaling to modify the scalable target on your behalf. If the + // service supports service-linked roles, Application Auto Scaling uses a + // service-linked role, which it creates if it does not yet exist. For more + // information, see Application Auto Scaling IAM Roles + // (https://docs.aws.amazon.com/autoscaling/application/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-roles). + RoleARN *string + + // An embedded object that contains attributes and attribute values that are used + // to suspend and resume automatic scaling. Setting the value of an attribute to + // true suspends the specified scaling activities. Setting it to false (default) + // resumes the specified scaling activities. Suspension Outcomes + // + // * For + // DynamicScalingInSuspended, while a suspension is in effect, all scale-in + // activities that are triggered by a scaling policy are suspended. + // + // * For + // DynamicScalingOutSuspended, while a suspension is in effect, all scale-out + // activities that are triggered by a scaling policy are suspended. + // + // * For + // ScheduledScalingSuspended, while a suspension is in effect, all scaling + // activities that involve scheduled actions are suspended. + // + // For more information, + // see Suspending and Resuming Scaling + // (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html) + // in the Application Auto Scaling User Guide. + SuspendedState *types.SuspendedState } type RegisterScalableTargetOutput struct { diff --git a/service/applicationautoscaling/go.mod b/service/applicationautoscaling/go.mod index a4954013e17..af56cc5bdbd 100644 --- a/service/applicationautoscaling/go.mod +++ b/service/applicationautoscaling/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/applicationautoscaling go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/applicationautoscaling/types/types.go b/service/applicationautoscaling/types/types.go index b63439b6d44..0ca63e8c04a 100644 --- a/service/applicationautoscaling/types/types.go +++ b/service/applicationautoscaling/types/types.go @@ -45,6 +45,16 @@ type Alarm struct { // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html). type CustomizedMetricSpecification struct { + // The name of the metric. + // + // This member is required. + MetricName *string + + // The namespace of the metric. + // + // This member is required. + Namespace *string + // The statistic of the metric. // // This member is required. @@ -56,30 +66,20 @@ type CustomizedMetricSpecification struct { // The unit of the metric. Unit *string - - // The name of the metric. - // - // This member is required. - MetricName *string - - // The namespace of the metric. - // - // This member is required. - Namespace *string } // Describes the dimension names and values associated with a metric. type MetricDimension struct { - // The value of the dimension. + // The name of the dimension. // // This member is required. - Value *string + Name *string - // The name of the dimension. + // The value of the dimension. // // This member is required. - Name *string + Value *string } // Represents a predefined metric for a target tracking scaling policy to use with @@ -119,9 +119,87 @@ type PredefinedMetricSpecification struct { // Represents a scalable target. type ScalableTarget struct { - // Specifies whether the scaling activities for a scalable target are in a - // suspended state. - SuspendedState *SuspendedState + // The Unix timestamp for when the scalable target was created. + // + // This member is required. + CreationTime *time.Time + + // The maximum value to scale to in response to a scale-out activity. + // + // This member is required. + MaxCapacity *int32 + + // The minimum value to scale to in response to a scale-in activity. + // + // This member is required. + MinCapacity *int32 + + // The identifier of the resource associated with the scalable target. This string + // consists of the resource type and unique identifier. + // + // * ECS service - The + // resource type is service and the unique identifier is the cluster name and + // service name. Example: service/default/sample-webapp. + // + // * Spot Fleet request + // - The resource type is spot-fleet-request and the unique identifier is the Spot + // Fleet request ID. Example: + // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. + // + // * EMR cluster + // - The resource type is instancegroup and the unique identifier is the cluster ID + // and instance group ID. Example: + // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. + // + // * AppStream 2.0 fleet - The + // resource type is fleet and the unique identifier is the fleet name. Example: + // fleet/sample-fleet. + // + // * DynamoDB table - The resource type is table and the + // unique identifier is the table name. Example: table/my-table. + // + // * DynamoDB + // global secondary index - The resource type is index and the unique identifier is + // the index name. Example: table/my-table/index/my-table-index. + // + // * Aurora DB + // cluster - The resource type is cluster and the unique identifier is the cluster + // name. Example: cluster:my-db-cluster. + // + // * Amazon SageMaker endpoint variant - + // The resource type is variant and the unique identifier is the resource ID. + // Example: endpoint/my-end-point/variant/KMeansClustering. + // + // * Custom resources + // are not supported with a resource type. This parameter must specify the + // OutputValue from the CloudFormation template stack used to access the resources. + // The unique identifier is defined by the service provider. More information is + // available in our GitHub repository + // (https://github.com/aws/aws-auto-scaling-custom-resource). + // + // * Amazon + // Comprehend document classification endpoint - The resource type and unique + // identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. + // + // + // * Lambda provisioned concurrency - The resource type is function and the unique + // identifier is the function name with a function version or alias name suffix + // that is not $LATEST. Example: function:my-function:prod or + // function:my-function:1. + // + // * Amazon Keyspaces table - The resource type is + // table and the unique identifier is the table name. Example: + // keyspace/mykeyspace/table/mytable. + // + // This member is required. + ResourceId *string + + // The ARN of an IAM role that allows Application Auto Scaling to modify the + // scalable target on your behalf. + // + // This member is required. + RoleARN *string // The scalable dimension associated with the scalable target. This string consists // of the service namespace, resource type, and scaling property. @@ -183,18 +261,47 @@ type ScalableTarget struct { // This member is required. ScalableDimension ScalableDimension - // The Unix timestamp for when the scalable target was created. - // - // This member is required. - CreationTime *time.Time - // The namespace of the AWS service that provides the resource, or a // custom-resource. // // This member is required. ServiceNamespace ServiceNamespace - // The identifier of the resource associated with the scalable target. This string + // Specifies whether the scaling activities for a scalable target are in a + // suspended state. + SuspendedState *SuspendedState +} + +// Represents the minimum and maximum capacity for a scheduled action. +type ScalableTargetAction struct { + + // The maximum capacity. + MaxCapacity *int32 + + // The minimum capacity. For Lambda provisioned concurrency, the minimum value + // allowed is 0. For all other resources, the minimum value allowed is 1. + MinCapacity *int32 +} + +// Represents a scaling activity. +type ScalingActivity struct { + + // The unique identifier of the scaling activity. + // + // This member is required. + ActivityId *string + + // A simple description of what caused the scaling activity to happen. + // + // This member is required. + Cause *string + + // A simple description of what action the scaling activity intends to accomplish. + // + // This member is required. + Description *string + + // The identifier of the resource associated with the scaling activity. This string // consists of the resource type and unique identifier. // // * ECS service - The @@ -255,56 +362,6 @@ type ScalableTarget struct { // This member is required. ResourceId *string - // The ARN of an IAM role that allows Application Auto Scaling to modify the - // scalable target on your behalf. - // - // This member is required. - RoleARN *string - - // The minimum value to scale to in response to a scale-in activity. - // - // This member is required. - MinCapacity *int32 - - // The maximum value to scale to in response to a scale-out activity. - // - // This member is required. - MaxCapacity *int32 -} - -// Represents the minimum and maximum capacity for a scheduled action. -type ScalableTargetAction struct { - - // The minimum capacity. For Lambda provisioned concurrency, the minimum value - // allowed is 0. For all other resources, the minimum value allowed is 1. - MinCapacity *int32 - - // The maximum capacity. - MaxCapacity *int32 -} - -// Represents a scaling activity. -type ScalingActivity struct { - - // Indicates the status of the scaling activity. - // - // This member is required. - StatusCode ScalingActivityStatusCode - - // The details about the scaling activity. - Details *string - - // The Unix timestamp for when the scaling activity ended. - EndTime *time.Time - - // A simple description of what action the scaling activity intends to accomplish. - // - // This member is required. - Description *string - - // A simple message about the current status of the scaling activity. - StatusMessage *string - // The scalable dimension. This string consists of the service namespace, resource // type, and scaling property. // @@ -371,7 +428,50 @@ type ScalingActivity struct { // This member is required. ServiceNamespace ServiceNamespace - // The identifier of the resource associated with the scaling activity. This string + // The Unix timestamp for when the scaling activity began. + // + // This member is required. + StartTime *time.Time + + // Indicates the status of the scaling activity. + // + // This member is required. + StatusCode ScalingActivityStatusCode + + // The details about the scaling activity. + Details *string + + // The Unix timestamp for when the scaling activity ended. + EndTime *time.Time + + // A simple message about the current status of the scaling activity. + StatusMessage *string +} + +// Represents a scaling policy to use with Application Auto Scaling. +type ScalingPolicy struct { + + // The Unix timestamp for when the scaling policy was created. + // + // This member is required. + CreationTime *time.Time + + // The Amazon Resource Name (ARN) of the scaling policy. + // + // This member is required. + PolicyARN *string + + // The name of the scaling policy. + // + // This member is required. + PolicyName *string + + // The scaling policy type. + // + // This member is required. + PolicyType PolicyType + + // The identifier of the resource associated with the scaling policy. This string // consists of the resource type and unique identifier. // // * ECS service - The @@ -432,96 +532,8 @@ type ScalingActivity struct { // This member is required. ResourceId *string - // A simple description of what caused the scaling activity to happen. - // - // This member is required. - Cause *string - - // The Unix timestamp for when the scaling activity began. - // - // This member is required. - StartTime *time.Time - - // The unique identifier of the scaling activity. - // - // This member is required. - ActivityId *string -} - -// Represents a scaling policy to use with Application Auto Scaling. -type ScalingPolicy struct { - - // The identifier of the resource associated with the scaling policy. This string - // consists of the resource type and unique identifier. - // - // * ECS service - The - // resource type is service and the unique identifier is the cluster name and - // service name. Example: service/default/sample-webapp. - // - // * Spot Fleet request - // - The resource type is spot-fleet-request and the unique identifier is the Spot - // Fleet request ID. Example: - // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - // - // * EMR cluster - // - The resource type is instancegroup and the unique identifier is the cluster ID - // and instance group ID. Example: - // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. - // - // * AppStream 2.0 fleet - The - // resource type is fleet and the unique identifier is the fleet name. Example: - // fleet/sample-fleet. - // - // * DynamoDB table - The resource type is table and the - // unique identifier is the table name. Example: table/my-table. - // - // * DynamoDB - // global secondary index - The resource type is index and the unique identifier is - // the index name. Example: table/my-table/index/my-table-index. - // - // * Aurora DB - // cluster - The resource type is cluster and the unique identifier is the cluster - // name. Example: cluster:my-db-cluster. - // - // * Amazon SageMaker endpoint variant - - // The resource type is variant and the unique identifier is the resource ID. - // Example: endpoint/my-end-point/variant/KMeansClustering. - // - // * Custom resources - // are not supported with a resource type. This parameter must specify the - // OutputValue from the CloudFormation template stack used to access the resources. - // The unique identifier is defined by the service provider. More information is - // available in our GitHub repository - // (https://github.com/aws/aws-auto-scaling-custom-resource). - // - // * Amazon - // Comprehend document classification endpoint - The resource type and unique - // identifier are specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. - // - // - // * Lambda provisioned concurrency - The resource type is function and the unique - // identifier is the function name with a function version or alias name suffix - // that is not $LATEST. Example: function:my-function:prod or - // function:my-function:1. - // - // * Amazon Keyspaces table - The resource type is - // table and the unique identifier is the table name. Example: - // keyspace/mykeyspace/table/mytable. - // - // This member is required. - ResourceId *string - - // The Amazon Resource Name (ARN) of the scaling policy. - // - // This member is required. - PolicyARN *string - - // A target tracking scaling policy. - TargetTrackingScalingPolicyConfiguration *TargetTrackingScalingPolicyConfiguration - - // The scalable dimension. This string consists of the service namespace, resource - // type, and scaling property. + // The scalable dimension. This string consists of the service namespace, resource + // type, and scaling property. // // * ecs:service:DesiredCount - The desired task // count of an ECS service. @@ -580,10 +592,11 @@ type ScalingPolicy struct { // This member is required. ScalableDimension ScalableDimension - // The scaling policy type. + // The namespace of the AWS service that provides the resource, or a + // custom-resource. // // This member is required. - PolicyType PolicyType + ServiceNamespace ServiceNamespace // The CloudWatch alarms associated with the scaling policy. Alarms []*Alarm @@ -591,36 +604,78 @@ type ScalingPolicy struct { // A step scaling policy. StepScalingPolicyConfiguration *StepScalingPolicyConfiguration - // The name of the scaling policy. - // - // This member is required. - PolicyName *string - - // The namespace of the AWS service that provides the resource, or a - // custom-resource. - // - // This member is required. - ServiceNamespace ServiceNamespace - - // The Unix timestamp for when the scaling policy was created. - // - // This member is required. - CreationTime *time.Time + // A target tracking scaling policy. + TargetTrackingScalingPolicyConfiguration *TargetTrackingScalingPolicyConfiguration } // Represents a scheduled action. type ScheduledAction struct { - // The Amazon Resource Name (ARN) of the scheduled action. + // The date and time that the scheduled action was created. // // This member is required. - ScheduledActionARN *string + CreationTime *time.Time - // The namespace of the AWS service that provides the resource, or a - // custom-resource. + // The identifier of the resource associated with the scaling policy. This string + // consists of the resource type and unique identifier. + // + // * ECS service - The + // resource type is service and the unique identifier is the cluster name and + // service name. Example: service/default/sample-webapp. + // + // * Spot Fleet request + // - The resource type is spot-fleet-request and the unique identifier is the Spot + // Fleet request ID. Example: + // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. + // + // * EMR cluster + // - The resource type is instancegroup and the unique identifier is the cluster ID + // and instance group ID. Example: + // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. + // + // * AppStream 2.0 fleet - The + // resource type is fleet and the unique identifier is the fleet name. Example: + // fleet/sample-fleet. + // + // * DynamoDB table - The resource type is table and the + // unique identifier is the table name. Example: table/my-table. + // + // * DynamoDB + // global secondary index - The resource type is index and the unique identifier is + // the index name. Example: table/my-table/index/my-table-index. + // + // * Aurora DB + // cluster - The resource type is cluster and the unique identifier is the cluster + // name. Example: cluster:my-db-cluster. + // + // * Amazon SageMaker endpoint variant - + // The resource type is variant and the unique identifier is the resource ID. + // Example: endpoint/my-end-point/variant/KMeansClustering. + // + // * Custom resources + // are not supported with a resource type. This parameter must specify the + // OutputValue from the CloudFormation template stack used to access the resources. + // The unique identifier is defined by the service provider. More information is + // available in our GitHub repository + // (https://github.com/aws/aws-auto-scaling-custom-resource). + // + // * Amazon + // Comprehend document classification endpoint - The resource type and unique + // identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. + // + // + // * Lambda provisioned concurrency - The resource type is function and the unique + // identifier is the function name with a function version or alias name suffix + // that is not $LATEST. Example: function:my-function:prod or + // function:my-function:1. + // + // * Amazon Keyspaces table - The resource type is + // table and the unique identifier is the table name. Example: + // keyspace/mykeyspace/table/mytable. // // This member is required. - ServiceNamespace ServiceNamespace + ResourceId *string // The schedule for this action. The following formats are supported: // @@ -645,6 +700,25 @@ type ScheduledAction struct { // This member is required. Schedule *string + // The Amazon Resource Name (ARN) of the scheduled action. + // + // This member is required. + ScheduledActionARN *string + + // The name of the scheduled action. + // + // This member is required. + ScheduledActionName *string + + // The namespace of the AWS service that provides the resource, or a + // custom-resource. + // + // This member is required. + ServiceNamespace ServiceNamespace + + // The date and time that the action is scheduled to end. + EndTime *time.Time + // The scalable dimension. This string consists of the service namespace, resource // type, and scaling property. // @@ -703,16 +777,6 @@ type ScheduledAction struct { // Amazon Keyspaces table. ScalableDimension ScalableDimension - // The name of the scheduled action. - // - // This member is required. - ScheduledActionName *string - - // The date and time that the scheduled action was created. - // - // This member is required. - CreationTime *time.Time - // The new minimum and maximum capacity. You can set both values or just one. At // the scheduled time, if the current capacity is below the minimum capacity, // Application Auto Scaling scales out to the minimum capacity. If the current @@ -720,72 +784,8 @@ type ScheduledAction struct { // the maximum capacity. ScalableTargetAction *ScalableTargetAction - // The date and time that the action is scheduled to end. - EndTime *time.Time - // The date and time that the action is scheduled to begin. StartTime *time.Time - - // The identifier of the resource associated with the scaling policy. This string - // consists of the resource type and unique identifier. - // - // * ECS service - The - // resource type is service and the unique identifier is the cluster name and - // service name. Example: service/default/sample-webapp. - // - // * Spot Fleet request - // - The resource type is spot-fleet-request and the unique identifier is the Spot - // Fleet request ID. Example: - // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - // - // * EMR cluster - // - The resource type is instancegroup and the unique identifier is the cluster ID - // and instance group ID. Example: - // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. - // - // * AppStream 2.0 fleet - The - // resource type is fleet and the unique identifier is the fleet name. Example: - // fleet/sample-fleet. - // - // * DynamoDB table - The resource type is table and the - // unique identifier is the table name. Example: table/my-table. - // - // * DynamoDB - // global secondary index - The resource type is index and the unique identifier is - // the index name. Example: table/my-table/index/my-table-index. - // - // * Aurora DB - // cluster - The resource type is cluster and the unique identifier is the cluster - // name. Example: cluster:my-db-cluster. - // - // * Amazon SageMaker endpoint variant - - // The resource type is variant and the unique identifier is the resource ID. - // Example: endpoint/my-end-point/variant/KMeansClustering. - // - // * Custom resources - // are not supported with a resource type. This parameter must specify the - // OutputValue from the CloudFormation template stack used to access the resources. - // The unique identifier is defined by the service provider. More information is - // available in our GitHub repository - // (https://github.com/aws/aws-auto-scaling-custom-resource). - // - // * Amazon - // Comprehend document classification endpoint - The resource type and unique - // identifier are specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. - // - // - // * Lambda provisioned concurrency - The resource type is function and the unique - // identifier is the function name with a function version or alias name suffix - // that is not $LATEST. Example: function:my-function:prod or - // function:my-function:1. - // - // * Amazon Keyspaces table - The resource type is - // table and the unique identifier is the table name. Example: - // keyspace/mykeyspace/table/mytable. - // - // This member is required. - ResourceId *string } // Represents a step adjustment for a StepScalingPolicyConfiguration @@ -828,14 +828,6 @@ type StepAdjustment struct { // This member is required. ScalingAdjustment *int32 - // The upper bound for the difference between the alarm threshold and the - // CloudWatch metric. If the metric value is above the breach threshold, the upper - // bound is exclusive (the metric must be less than the threshold plus the upper - // bound). Otherwise, it is inclusive (the metric must be less than or equal to the - // threshold plus the upper bound). A null value indicates positive infinity. The - // upper bound must be greater than the lower bound. - MetricIntervalUpperBound *float64 - // The lower bound for the difference between the alarm threshold and the // CloudWatch metric. If the metric value is above the breach threshold, the lower // bound is inclusive (the metric must be greater than or equal to the threshold @@ -843,12 +835,26 @@ type StepAdjustment struct { // than the threshold plus the lower bound). A null value indicates negative // infinity. MetricIntervalLowerBound *float64 + + // The upper bound for the difference between the alarm threshold and the + // CloudWatch metric. If the metric value is above the breach threshold, the upper + // bound is exclusive (the metric must be less than the threshold plus the upper + // bound). Otherwise, it is inclusive (the metric must be less than or equal to the + // threshold plus the upper bound). A null value indicates positive infinity. The + // upper bound must be greater than the lower bound. + MetricIntervalUpperBound *float64 } // Represents a step scaling policy configuration to use with Application Auto // Scaling. type StepScalingPolicyConfiguration struct { + // Specifies whether the ScalingAdjustment value in a StepAdjustment + // (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepAdjustment.html) + // is an absolute number or a percentage of the current capacity. AdjustmentType is + // required if you are adding a new step scaling policy configuration. + AdjustmentType AdjustmentType + // The amount of time, in seconds, to wait for a previous scaling activity to take // effect. With scale-out policies, the intention is to continuously (but not // excessively) scale out. After Application Auto Scaling successfully scales out @@ -901,17 +907,6 @@ type StepScalingPolicyConfiguration struct { // * Amazon Keyspaces tables Cooldown *int32 - // A set of adjustments that enable you to scale based on the size of the alarm - // breach. At least one step adjustment is required if you are adding a new step - // scaling policy configuration. - StepAdjustments []*StepAdjustment - - // Specifies whether the ScalingAdjustment value in a StepAdjustment - // (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepAdjustment.html) - // is an absolute number or a percentage of the current capacity. AdjustmentType is - // required if you are adding a new step scaling policy configuration. - AdjustmentType AdjustmentType - // The aggregation type for the CloudWatch metrics. Valid values are Minimum, // Maximum, and Average. If the aggregation type is null, the value is treated as // Average. @@ -925,6 +920,11 @@ type StepScalingPolicyConfiguration struct { // scales out the service by 2 tasks. Valid only if the adjustment type is // PercentChangeInCapacity. MinAdjustmentMagnitude *int32 + + // A set of adjustments that enable you to scale based on the size of the alarm + // breach. At least one step adjustment is required if you are adding a new step + // scaling policy configuration. + StepAdjustments []*StepAdjustment } // Specifies whether the scaling activities for a scalable target are in a @@ -936,67 +936,38 @@ type SuspendedState struct { // remove capacity when a scaling policy is triggered. The default is false. DynamicScalingInSuspended *bool - // Whether scheduled scaling is suspended. Set the value to true if you don't want - // Application Auto Scaling to add or remove capacity by initiating scheduled - // actions. The default is false. - ScheduledScalingSuspended *bool - // Whether scale out by a target tracking scaling policy or a step scaling policy // is suspended. Set the value to true if you don't want Application Auto Scaling // to add capacity when a scaling policy is triggered. The default is false. DynamicScalingOutSuspended *bool + + // Whether scheduled scaling is suspended. Set the value to true if you don't want + // Application Auto Scaling to add or remove capacity by initiating scheduled + // actions. The default is false. + ScheduledScalingSuspended *bool } // Represents a target tracking scaling policy configuration to use with // Application Auto Scaling. type TargetTrackingScalingPolicyConfiguration struct { - // The amount of time, in seconds, to wait for a previous scale-out activity to - // take effect. With the scale-out cooldown period, the intention is to - // continuously (but not excessively) scale out. After Application Auto Scaling - // successfully scales out using a target tracking scaling policy, it starts to - // calculate the cooldown time. While the scale-out cooldown period is in effect, - // the capacity added by the initiating scale-out activity is calculated as part of - // the desired capacity for the next scale-out activity. Application Auto Scaling - // provides a default value of 300 for the following scalable targets: - // - // * ECS - // services - // - // * Spot Fleet requests - // - // * EMR clusters - // - // * AppStream 2.0 - // fleets - // - // * Aurora DB clusters - // - // * Amazon SageMaker endpoint variants - // - // - // * Custom resources - // - // For all other scalable targets, the default value is 0: - // - // - // * DynamoDB tables - // - // * DynamoDB global secondary indexes - // - // * Amazon - // Comprehend document classification endpoints - // - // * Lambda provisioned - // concurrency + // The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 + // (Base 10) or 2e-360 to 2e360 (Base 2). // - // * Amazon Keyspaces tables - ScaleOutCooldown *int32 + // This member is required. + TargetValue *float64 // A customized metric. You can specify either a predefined metric or a customized // metric. CustomizedMetricSpecification *CustomizedMetricSpecification + // Indicates whether scale in by the target tracking scaling policy is disabled. If + // the value is true, scale in is disabled and the target tracking scaling policy + // won't remove capacity from the scalable target. Otherwise, scale in is enabled + // and the target tracking scaling policy can remove capacity from the scalable + // target. The default value is false. + DisableScaleIn *bool + // A predefined metric. You can specify either a predefined metric or a customized // metric. PredefinedMetricSpecification *PredefinedMetricSpecification @@ -1043,16 +1014,45 @@ type TargetTrackingScalingPolicyConfiguration struct { // * Amazon Keyspaces tables ScaleInCooldown *int32 - // The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 - // (Base 10) or 2e-360 to 2e360 (Base 2). + // The amount of time, in seconds, to wait for a previous scale-out activity to + // take effect. With the scale-out cooldown period, the intention is to + // continuously (but not excessively) scale out. After Application Auto Scaling + // successfully scales out using a target tracking scaling policy, it starts to + // calculate the cooldown time. While the scale-out cooldown period is in effect, + // the capacity added by the initiating scale-out activity is calculated as part of + // the desired capacity for the next scale-out activity. Application Auto Scaling + // provides a default value of 300 for the following scalable targets: // - // This member is required. - TargetValue *float64 - - // Indicates whether scale in by the target tracking scaling policy is disabled. If - // the value is true, scale in is disabled and the target tracking scaling policy - // won't remove capacity from the scalable target. Otherwise, scale in is enabled - // and the target tracking scaling policy can remove capacity from the scalable - // target. The default value is false. - DisableScaleIn *bool + // * ECS + // services + // + // * Spot Fleet requests + // + // * EMR clusters + // + // * AppStream 2.0 + // fleets + // + // * Aurora DB clusters + // + // * Amazon SageMaker endpoint variants + // + // + // * Custom resources + // + // For all other scalable targets, the default value is 0: + // + // + // * DynamoDB tables + // + // * DynamoDB global secondary indexes + // + // * Amazon + // Comprehend document classification endpoints + // + // * Lambda provisioned + // concurrency + // + // * Amazon Keyspaces tables + ScaleOutCooldown *int32 } diff --git a/service/applicationdiscoveryservice/api_op_DeleteTags.go b/service/applicationdiscoveryservice/api_op_DeleteTags.go index 26dc3fe6286..ef674824165 100644 --- a/service/applicationdiscoveryservice/api_op_DeleteTags.go +++ b/service/applicationdiscoveryservice/api_op_DeleteTags.go @@ -58,15 +58,15 @@ func (c *Client) DeleteTags(ctx context.Context, params *DeleteTagsInput, optFns type DeleteTagsInput struct { - // Tags that you want to delete from one or more configuration items. Specify the - // tags that you want to delete in a key-value format. For example: {"key": - // "serverType", "value": "webServer"} - Tags []*types.Tag - // A list of configuration items with tags that you want to delete. // // This member is required. ConfigurationIds []*string + + // Tags that you want to delete from one or more configuration items. Specify the + // tags that you want to delete in a key-value format. For example: {"key": + // "serverType", "value": "webServer"} + Tags []*types.Tag } type DeleteTagsOutput struct { diff --git a/service/applicationdiscoveryservice/api_op_DescribeAgents.go b/service/applicationdiscoveryservice/api_op_DescribeAgents.go index f80126689f2..306f4ead813 100644 --- a/service/applicationdiscoveryservice/api_op_DescribeAgents.go +++ b/service/applicationdiscoveryservice/api_op_DescribeAgents.go @@ -59,6 +59,11 @@ func (c *Client) DescribeAgents(ctx context.Context, params *DescribeAgentsInput type DescribeAgentsInput struct { + // The agent or the Connector IDs for which you want information. If you specify no + // IDs, the system returns information about all agents/Connectors associated with + // your AWS user account. + AgentIds []*string + // You can filter the request using various logical operators and a key-value // format. For example: {"key": "collectionStatus", "value": "STARTED"} Filters []*types.Filter @@ -72,11 +77,6 @@ type DescribeAgentsInput struct { // DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along // with a token. Use that token in this query to get the next set of 10. NextToken *string - - // The agent or the Connector IDs for which you want information. If you specify no - // IDs, the system returns information about all agents/Connectors associated with - // your AWS user account. - AgentIds []*string } type DescribeAgentsOutput struct { diff --git a/service/applicationdiscoveryservice/api_op_DescribeContinuousExports.go b/service/applicationdiscoveryservice/api_op_DescribeContinuousExports.go index 962e5c38caf..61c744c2a83 100644 --- a/service/applicationdiscoveryservice/api_op_DescribeContinuousExports.go +++ b/service/applicationdiscoveryservice/api_op_DescribeContinuousExports.go @@ -58,15 +58,15 @@ func (c *Client) DescribeContinuousExports(ctx context.Context, params *Describe type DescribeContinuousExportsInput struct { - // The token from the previous call to DescribeExportTasks. - NextToken *string - // The unique IDs assigned to the exports. ExportIds []*string // A number between 1 and 100 specifying the maximum number of continuous export // descriptions returned. MaxResults *int32 + + // The token from the previous call to DescribeExportTasks. + NextToken *string } type DescribeContinuousExportsOutput struct { diff --git a/service/applicationdiscoveryservice/api_op_DescribeExportConfigurations.go b/service/applicationdiscoveryservice/api_op_DescribeExportConfigurations.go index d417bd34e44..3fd3a8ca07a 100644 --- a/service/applicationdiscoveryservice/api_op_DescribeExportConfigurations.go +++ b/service/applicationdiscoveryservice/api_op_DescribeExportConfigurations.go @@ -61,22 +61,22 @@ type DescribeExportConfigurationsInput struct { // A list of continuous export IDs to search for. ExportIds []*string - // The token from the previous call to describe-export-tasks. - NextToken *string - // A number between 1 and 100 specifying the maximum number of continuous export // descriptions returned. MaxResults *int32 -} - -type DescribeExportConfigurationsOutput struct { // The token from the previous call to describe-export-tasks. NextToken *string +} + +type DescribeExportConfigurationsOutput struct { // ExportsInfo []*types.ExportInfo + // The token from the previous call to describe-export-tasks. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/applicationdiscoveryservice/api_op_DescribeExportTasks.go b/service/applicationdiscoveryservice/api_op_DescribeExportTasks.go index ee061550a59..e0bec889968 100644 --- a/service/applicationdiscoveryservice/api_op_DescribeExportTasks.go +++ b/service/applicationdiscoveryservice/api_op_DescribeExportTasks.go @@ -58,15 +58,15 @@ func (c *Client) DescribeExportTasks(ctx context.Context, params *DescribeExport type DescribeExportTasksInput struct { + // One or more unique identifiers used to query the status of an export request. + ExportIds []*string + // One or more filters. // // * AgentId - ID of the agent whose collected data will // be exported Filters []*types.ExportFilter - // One or more unique identifiers used to query the status of an export request. - ExportIds []*string - // The maximum number of volume results returned by DescribeExportTasks in // paginated output. When this parameter is used, DescribeExportTasks only returns // maxResults results in a single page along with a nextToken response element. @@ -82,17 +82,17 @@ type DescribeExportTasksInput struct { type DescribeExportTasksOutput struct { + // Contains one or more sets of export request details. When the status of a + // request is SUCCEEDED, the response includes a URL for an Amazon S3 bucket where + // you can view the data in a CSV file. + ExportsInfo []*types.ExportInfo + // The nextToken value to include in a future DescribeExportTasks request. When the // results of a DescribeExportTasks request exceed maxResults, this value can be // used to retrieve the next page of results. This value is null when there are no // more results to return. NextToken *string - // Contains one or more sets of export request details. When the status of a - // request is SUCCEEDED, the response includes a URL for an Amazon S3 bucket where - // you can view the data in a CSV file. - ExportsInfo []*types.ExportInfo - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/applicationdiscoveryservice/api_op_DescribeImportTasks.go b/service/applicationdiscoveryservice/api_op_DescribeImportTasks.go index ebee814776c..1606d2f4e98 100644 --- a/service/applicationdiscoveryservice/api_op_DescribeImportTasks.go +++ b/service/applicationdiscoveryservice/api_op_DescribeImportTasks.go @@ -57,27 +57,27 @@ func (c *Client) DescribeImportTasks(ctx context.Context, params *DescribeImport type DescribeImportTasksInput struct { - // The token to request a specific page of results. - NextToken *string - - // The maximum number of results that you want this request to return, up to 100. - MaxResults *int32 - // An array of name-value pairs that you provide to filter the results for the // DescribeImportTask request to a specific subset of results. Currently, wildcard // values aren't supported for filters. Filters []*types.ImportTaskFilter + + // The maximum number of results that you want this request to return, up to 100. + MaxResults *int32 + + // The token to request a specific page of results. + NextToken *string } type DescribeImportTasksOutput struct { + // The token to request the next page of results. + NextToken *string + // A returned array of import tasks that match any applied filters, up to the // specified number of maximum results. Tasks []*types.ImportTask - // The token to request the next page of results. - NextToken *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/applicationdiscoveryservice/api_op_GetDiscoverySummary.go b/service/applicationdiscoveryservice/api_op_GetDiscoverySummary.go index f2d09c8e4b6..65003dad266 100644 --- a/service/applicationdiscoveryservice/api_op_GetDiscoverySummary.go +++ b/service/applicationdiscoveryservice/api_op_GetDiscoverySummary.go @@ -61,14 +61,8 @@ type GetDiscoverySummaryInput struct { type GetDiscoverySummaryOutput struct { - // The number of servers mapped to tags. - ServersMappedtoTags *int64 - - // The number of servers mapped to applications. - ServersMappedToApplications *int64 - - // The number of servers discovered. - Servers *int64 + // Details about discovered agents, including agent status and health. + AgentSummary *types.CustomerAgentInfo // The number of applications discovered. Applications *int64 @@ -76,8 +70,14 @@ type GetDiscoverySummaryOutput struct { // Details about discovered connectors, including connector status and health. ConnectorSummary *types.CustomerConnectorInfo - // Details about discovered agents, including agent status and health. - AgentSummary *types.CustomerAgentInfo + // The number of servers discovered. + Servers *int64 + + // The number of servers mapped to applications. + ServersMappedToApplications *int64 + + // The number of servers mapped to tags. + ServersMappedtoTags *int64 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/applicationdiscoveryservice/api_op_ListConfigurations.go b/service/applicationdiscoveryservice/api_op_ListConfigurations.go index 4a5d6035f7a..5d111b29e89 100644 --- a/service/applicationdiscoveryservice/api_op_ListConfigurations.go +++ b/service/applicationdiscoveryservice/api_op_ListConfigurations.go @@ -59,22 +59,6 @@ func (c *Client) ListConfigurations(ctx context.Context, params *ListConfigurati type ListConfigurationsInput struct { - // The total number of items to return. The maximum value is 100. - MaxResults *int32 - - // Certain filter criteria return output that can be sorted in ascending or - // descending order. For a list of output characteristics for each filter, see - // Using the ListConfigurations Action - // (https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html#ListConfigurations) - // in the AWS Application Discovery Service User Guide. - OrderBy []*types.OrderByElement - - // Token to retrieve the next set of results. For example, if a previous call to - // ListConfigurations returned 100 items, but you set - // ListConfigurationsRequest$maxResults to 10, you received a set of 10 results - // along with a token. Use that token in this query to get the next set of 10. - NextToken *string - // A valid configuration identified by Application Discovery Service. // // This member is required. @@ -87,6 +71,22 @@ type ListConfigurationsInput struct { // (https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html#ListConfigurations) // in the AWS Application Discovery Service User Guide. Filters []*types.Filter + + // The total number of items to return. The maximum value is 100. + MaxResults *int32 + + // Token to retrieve the next set of results. For example, if a previous call to + // ListConfigurations returned 100 items, but you set + // ListConfigurationsRequest$maxResults to 10, you received a set of 10 results + // along with a token. Use that token in this query to get the next set of 10. + NextToken *string + + // Certain filter criteria return output that can be sorted in ascending or + // descending order. For a list of output characteristics for each filter, see + // Using the ListConfigurations Action + // (https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html#ListConfigurations) + // in the AWS Application Discovery Service User Guide. + OrderBy []*types.OrderByElement } type ListConfigurationsOutput struct { diff --git a/service/applicationdiscoveryservice/api_op_ListServerNeighbors.go b/service/applicationdiscoveryservice/api_op_ListServerNeighbors.go index d2b70967429..950b8786e57 100644 --- a/service/applicationdiscoveryservice/api_op_ListServerNeighbors.go +++ b/service/applicationdiscoveryservice/api_op_ListServerNeighbors.go @@ -58,16 +58,17 @@ func (c *Client) ListServerNeighbors(ctx context.Context, params *ListServerNeig type ListServerNeighborsInput struct { + // Configuration ID of the server for which neighbors are being listed. + // + // This member is required. + ConfigurationId *string + // Maximum number of results to return in a single page of output. MaxResults *int32 // List of configuration IDs to test for one-hop-away. NeighborConfigurationIds []*string - // Flag to indicate if port and protocol information is needed as part of the - // response. - PortInformationNeeded *bool - // Token to retrieve the next set of results. For example, if you previously // specified 100 IDs for ListServerNeighborsRequest$neighborConfigurationIds but // set ListServerNeighborsRequest$maxResults to 10, you received a set of 10 @@ -75,14 +76,18 @@ type ListServerNeighborsInput struct { // 10. NextToken *string - // Configuration ID of the server for which neighbors are being listed. - // - // This member is required. - ConfigurationId *string + // Flag to indicate if port and protocol information is needed as part of the + // response. + PortInformationNeeded *bool } type ListServerNeighborsOutput struct { + // List of distinct servers that are one hop away from the given server. + // + // This member is required. + Neighbors []*types.NeighborConnectionDetail + // Count of distinct servers that are one hop away from the given server. KnownDependencyCount *int64 @@ -93,11 +98,6 @@ type ListServerNeighborsOutput struct { // of 10. NextToken *string - // List of distinct servers that are one hop away from the given server. - // - // This member is required. - Neighbors []*types.NeighborConnectionDetail - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/applicationdiscoveryservice/api_op_StartContinuousExport.go b/service/applicationdiscoveryservice/api_op_StartContinuousExport.go index 2c7e1f3145a..2fb5f6f0467 100644 --- a/service/applicationdiscoveryservice/api_op_StartContinuousExport.go +++ b/service/applicationdiscoveryservice/api_op_StartContinuousExport.go @@ -60,6 +60,13 @@ type StartContinuousExportInput struct { type StartContinuousExportOutput struct { + // The type of data collector used to gather this data (currently only offered for + // AGENT). + DataSource types.DataSource + + // The unique ID assigned to this export. + ExportId *string + // The name of the s3 bucket where the export data parquet files are stored. S3Bucket *string @@ -69,16 +76,9 @@ type StartContinuousExportOutput struct { // name of the Glue database used to store the schema. SchemaStorageConfig map[string]*string - // The type of data collector used to gather this data (currently only offered for - // AGENT). - DataSource types.DataSource - // The timestamp representing when the continuous export was started. StartTime *time.Time - // The unique ID assigned to this export. - ExportId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/applicationdiscoveryservice/api_op_StartExportTask.go b/service/applicationdiscoveryservice/api_op_StartExportTask.go index 5b41d9502a9..c9a0e53a475 100644 --- a/service/applicationdiscoveryservice/api_op_StartExportTask.go +++ b/service/applicationdiscoveryservice/api_op_StartExportTask.go @@ -66,16 +66,15 @@ func (c *Client) StartExportTask(ctx context.Context, params *StartExportTaskInp type StartExportTaskInput struct { - // The start timestamp for exported data from the single Application Discovery - // Agent selected in the filters. If no value is specified, data is exported - // starting from the first data collected by the agent. - StartTime *time.Time - // The end timestamp for exported data from the single Application Discovery Agent // selected in the filters. If no value is specified, exported data includes the // most recent data collected by the agent. EndTime *time.Time + // The file format for the returned export data. Default value is CSV. Note: The + // GRAPHML option has been deprecated. + ExportDataFormat []types.ExportDataFormat + // If a filter is present, it selects the single agentId of the Application // Discovery Agent for which data is exported. The agentId can be found in the // results of the DescribeAgents API or CLI. If no filter is present, startTime and @@ -83,9 +82,10 @@ type StartExportTaskInput struct { // Connector data and summary data from Application Discovery agents. Filters []*types.ExportFilter - // The file format for the returned export data. Default value is CSV. Note: The - // GRAPHML option has been deprecated. - ExportDataFormat []types.ExportDataFormat + // The start timestamp for exported data from the single Application Discovery + // Agent selected in the filters. If no value is specified, data is exported + // starting from the first data collected by the agent. + StartTime *time.Time } type StartExportTaskOutput struct { diff --git a/service/applicationdiscoveryservice/api_op_StartImportTask.go b/service/applicationdiscoveryservice/api_op_StartImportTask.go index 130f4c2a2fc..c41303b5e80 100644 --- a/service/applicationdiscoveryservice/api_op_StartImportTask.go +++ b/service/applicationdiscoveryservice/api_op_StartImportTask.go @@ -87,13 +87,6 @@ type StartImportTaskInput struct { // This member is required. ImportUrl *string - // Optional. A unique token that you can provide to prevent the same import request - // from occurring more than once. If you don't provide a token, a token is - // automatically generated.

Sending more than one StartImportTask - // request with the same client request token will return information about the - // original import task with that client request token.

- ClientRequestToken *string - // A descriptive name for this request. You can use this name to filter future // requests related to this import task, such as identifying applications and // servers that were included in this import task. We recommend that you use a @@ -101,6 +94,13 @@ type StartImportTaskInput struct { // // This member is required. Name *string + + // Optional. A unique token that you can provide to prevent the same import request + // from occurring more than once. If you don't provide a token, a token is + // automatically generated.

Sending more than one StartImportTask + // request with the same client request token will return information about the + // original import task with that client request token.

+ ClientRequestToken *string } type StartImportTaskOutput struct { diff --git a/service/applicationdiscoveryservice/api_op_UpdateApplication.go b/service/applicationdiscoveryservice/api_op_UpdateApplication.go index 1e1b9156845..7a89c9d802e 100644 --- a/service/applicationdiscoveryservice/api_op_UpdateApplication.go +++ b/service/applicationdiscoveryservice/api_op_UpdateApplication.go @@ -56,16 +56,16 @@ func (c *Client) UpdateApplication(ctx context.Context, params *UpdateApplicatio type UpdateApplicationInput struct { - // New name of the application to be updated. - Name *string - - // New description of the application to be updated. - Description *string - // Configuration ID of the application to be updated. // // This member is required. ConfigurationId *string + + // New description of the application to be updated. + Description *string + + // New name of the application to be updated. + Name *string } type UpdateApplicationOutput struct { diff --git a/service/applicationdiscoveryservice/go.mod b/service/applicationdiscoveryservice/go.mod index 2ed07bc08e5..df0cb2ae531 100644 --- a/service/applicationdiscoveryservice/go.mod +++ b/service/applicationdiscoveryservice/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/applicationdiscoveryservice go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/applicationdiscoveryservice/types/types.go b/service/applicationdiscoveryservice/types/types.go index 987a3a97e93..656c85f8240 100644 --- a/service/applicationdiscoveryservice/types/types.go +++ b/service/applicationdiscoveryservice/types/types.go @@ -14,13 +14,13 @@ type AgentConfigurationStatus struct { // The agent/connector ID. AgentId *string + // A description of the operation performed. + Description *string + // Information about the status of the StartDataCollection and StopDataCollection // operations. The system has recorded the data collection operation. The // agent/connector receives this command the next time it polls for a new command. OperationSucceeded *bool - - // A description of the operation performed. - Description *string } // Information about agents or connectors associated with the user’s AWS account. @@ -29,34 +29,34 @@ type AgentConfigurationStatus struct { // connector resides, and agent version for each agent. type AgentInfo struct { - // Time since agent or connector health was reported. - LastHealthPingTime *string - - // The name of the host where the agent or connector resides. The host can be a - // server or virtual machine. - HostName *string - // The agent or connector ID. AgentId *string - // The ID of the connector. - ConnectorId *string + // Network details about the host where the agent or connector resides. + AgentNetworkInfoList []*AgentNetworkInfo + + // Type of agent. + AgentType *string // Status of the collection process for an agent or connector. CollectionStatus *string - // Network details about the host where the agent or connector resides. - AgentNetworkInfoList []*AgentNetworkInfo + // The ID of the connector. + ConnectorId *string // The health of the agent or connector. Health AgentStatus + // The name of the host where the agent or connector resides. The host can be a + // server or virtual machine. + HostName *string + + // Time since agent or connector health was reported. + LastHealthPingTime *string + // Agent's first registration timestamp in UTC. RegisteredTime *string - // Type of agent. - AgentType *string - // The agent or connector version. Version *string } @@ -64,25 +64,25 @@ type AgentInfo struct { // Network details about the host where the agent/connector resides. type AgentNetworkInfo struct { - // The MAC address for the host where the agent/connector resides. - MacAddress *string - // The IP address for the host where the agent/connector resides. IpAddress *string + + // The MAC address for the host where the agent/connector resides. + MacAddress *string } // Error messages returned for each import task that you deleted as a response for // this command. type BatchDeleteImportDataError struct { - // The unique import ID associated with the error that occurred. - ImportTaskId *string + // The type of error that occurred for a specific import task. + ErrorCode BatchDeleteImportDataErrorCode // The description of the error that occurred for a specific import task. ErrorDescription *string - // The type of error that occurred for a specific import task. - ErrorCode BatchDeleteImportDataErrorCode + // The unique import ID associated with the error that occurred. + ImportTaskId *string } // Tags for a configuration item. Tags are metadata that help you categorize IT @@ -93,9 +93,6 @@ type ConfigurationTag struct { // values. ConfigurationId *string - // A value on which to filter. For example key = serverType and value = web server. - Value *string - // A type of IT asset to tag. ConfigurationType ConfigurationItemType @@ -104,6 +101,9 @@ type ConfigurationTag struct { // The time the configuration tag was created in Coordinated Universal Time (UTC). TimeOfCreation *time.Time + + // A value on which to filter. For example key = serverType and value = web server. + Value *string } // A list of continuous export descriptions. @@ -113,11 +113,46 @@ type ContinuousExportDescription struct { // AGENT). DataSource DataSource + // The unique ID assigned to this export. + ExportId *string + + // The name of the s3 bucket where the export data parquet files are stored. + S3Bucket *string + + // An object which describes how the data is stored. + // + // * databaseName - the name + // of the Glue database used to store the schema. + SchemaStorageConfig map[string]*string + // The timestamp representing when the continuous export was started. StartTime *time.Time - // The timestamp that represents when this continuous export was stopped. - StopTime *time.Time + // Describes the status of the export. Can be one of the following values: + // + // * + // START_IN_PROGRESS - setting up resources to start continuous export. + // + // * + // START_FAILED - an error occurred setting up continuous export. To recover, call + // start-continuous-export again. + // + // * ACTIVE - data is being exported to the + // customer bucket. + // + // * ERROR - an error occurred during export. To fix the + // issue, call stop-continuous-export and start-continuous-export. + // + // * + // STOP_IN_PROGRESS - stopping the export. + // + // * STOP_FAILED - an error occurred + // stopping the export. To recover, call stop-continuous-export again. + // + // * + // INACTIVE - the continuous export has been stopped. Data is no longer being + // exported to the customer bucket. + Status ContinuousExportStatus // Contains information about any errors that have occurred. This data type can // have the following values: StatusDetail *string - // The name of the s3 bucket where the export data parquet files are stored. - S3Bucket *string - - // An object which describes how the data is stored. - // - // * databaseName - the name - // of the Glue database used to store the schema. - SchemaStorageConfig map[string]*string - - // Describes the status of the export. Can be one of the following values: - // - // * - // START_IN_PROGRESS - setting up resources to start continuous export. - // - // * - // START_FAILED - an error occurred setting up continuous export. To recover, call - // start-continuous-export again. - // - // * ACTIVE - data is being exported to the - // customer bucket. - // - // * ERROR - an error occurred during export. To fix the - // issue, call stop-continuous-export and start-continuous-export. - // - // * - // STOP_IN_PROGRESS - stopping the export. - // - // * STOP_FAILED - an error occurred - // stopping the export. To recover, call stop-continuous-export again. - // - // * - // INACTIVE - the continuous export has been stopped. Data is no longer being - // exported to the customer bucket. - Status ContinuousExportStatus - - // The unique ID assigned to this export. - ExportId *string + // The timestamp that represents when this continuous export was stopped. + StopTime *time.Time } // Inventory data for installed discovery agents. type CustomerAgentInfo struct { - // Total number of discovery agents. + // Number of active discovery agents. // // This member is required. - TotalAgents *int32 + ActiveAgents *int32 - // Number of active discovery agents. + // Number of blacklisted discovery agents. // // This member is required. - ActiveAgents *int32 + BlackListedAgents *int32 // Number of healthy discovery agents // // This member is required. HealthyAgents *int32 - // Number of blacklisted discovery agents. + // Number of discovery agents with status SHUTDOWN. // // This member is required. - BlackListedAgents *int32 + ShutdownAgents *int32 - // Number of unknown discovery agents. + // Total number of discovery agents. // // This member is required. - UnknownAgents *int32 + TotalAgents *int32 // Number of unhealthy discovery agents. // // This member is required. UnhealthyAgents *int32 - // Number of discovery agents with status SHUTDOWN. + // Number of unknown discovery agents. // // This member is required. - ShutdownAgents *int32 + UnknownAgents *int32 } // Inventory data for installed discovery connectors. type CustomerConnectorInfo struct { + // Number of active discovery connectors. + // + // This member is required. + ActiveConnectors *int32 + // Number of blacklisted discovery connectors. // // This member is required. @@ -244,30 +249,25 @@ type CustomerConnectorInfo struct { // This member is required. HealthyConnectors *int32 - // Total number of discovery connectors. - // - // This member is required. - TotalConnectors *int32 - // Number of discovery connectors with status SHUTDOWN, // // This member is required. ShutdownConnectors *int32 - // Number of active discovery connectors. + // Total number of discovery connectors. // // This member is required. - ActiveConnectors *int32 + TotalConnectors *int32 - // Number of unknown discovery connectors. + // Number of unhealthy discovery connectors. // // This member is required. - UnknownConnectors *int32 + UnhealthyConnectors *int32 - // Number of unhealthy discovery connectors. + // Number of unknown discovery connectors. // // This member is required. - UnhealthyConnectors *int32 + UnknownConnectors *int32 } // Used to select which agent's data is to be exported. A single agent ID may be @@ -276,14 +276,6 @@ type CustomerConnectorInfo struct { // action. type ExportFilter struct { - // A single agentId for a Discovery Agent. An agentId can be found using the - // DescribeAgents - // (http://docs.aws.amazon.com/application-discovery/latest/APIReference/API_DescribeExportTasks.html) - // action. Typically an ADS agentId is in the form o-0123456789abcdef0. - // - // This member is required. - Values []*string - // Supported condition: EQUALS // // This member is required. @@ -293,49 +285,57 @@ type ExportFilter struct { // // This member is required. Name *string + + // A single agentId for a Discovery Agent. An agentId can be found using the + // DescribeAgents + // (http://docs.aws.amazon.com/application-discovery/latest/APIReference/API_DescribeExportTasks.html) + // action. Typically an ADS agentId is in the form o-0123456789abcdef0. + // + // This member is required. + Values []*string } // Information regarding the export status of discovered data. The value is an // array of objects. type ExportInfo struct { - // A URL for an Amazon S3 bucket where you can review the exported data. The URL is - // displayed only if the export succeeded. - ConfigurationsDownloadUrl *string - - // The endTime used in the StartExportTask request. If no endTime was requested, - // this result does not appear in ExportInfo. - RequestedEndTime *time.Time - // A unique identifier used to query an export. // // This member is required. ExportId *string - // A status message provided for API callers. - // - // This member is required. - StatusMessage *string - // The time that the data export was initiated. // // This member is required. ExportRequestTime *time.Time - // The value of startTime parameter in the StartExportTask request. If no startTime - // was requested, this result does not appear in ExportInfo. - RequestedStartTime *time.Time - // The status of the data export job. // // This member is required. ExportStatus ExportStatus + // A status message provided for API callers. + // + // This member is required. + StatusMessage *string + + // A URL for an Amazon S3 bucket where you can review the exported data. The URL is + // displayed only if the export succeeded. + ConfigurationsDownloadUrl *string + // If true, the export of agent information exceeded the size limit for a single // export and the exported data is incomplete for the requested time range. To // address this, select a smaller time range for the export by using startDate and // endDate. IsTruncated *bool + + // The endTime used in the StartExportTask request. If no endTime was requested, + // this result does not appear in ExportInfo. + RequestedEndTime *time.Time + + // The value of startTime parameter in the StartExportTask request. If no startTime + // was requested, this result does not appear in ExportInfo. + RequestedStartTime *time.Time } // A filter that can use conditional operators. For more information about filters, @@ -344,11 +344,6 @@ type ExportInfo struct { // in the AWS Application Discovery Service User Guide. type Filter struct { - // The name of the filter. - // - // This member is required. - Name *string - // A conditional operator. The following operators are valid: EQUALS, NOT_EQUALS, // CONTAINS, NOT_CONTAINS. If you specify multiple filters, the system utilizes all // filters as though concatenated by AND. If you specify multiple values for a @@ -359,6 +354,11 @@ type Filter struct { // This member is required. Condition *string + // The name of the filter. + // + // This member is required. + Name *string + // A string value on which to filter. For example, if you choose the // destinationServer.osVersion filter name, you could specify Ubuntu for the value. // @@ -370,50 +370,19 @@ type Filter struct { // information, times, IDs, the Amazon S3 Object URL for the import file, and more. type ImportTask struct { - // The time that the import task request was deleted, presented in the Unix time - // stamp format. - ImportDeletedTime *time.Time - - // A descriptive name for an import task. You can use this name to filter future - // requests related to this import task, such as identifying applications and - // servers that were included in this import task. We recommend that you use a - // meaningful name for each import task. - Name *string - - // The total number of server records in the import file that failed to be + // The total number of application records in the import file that failed to be // imported. - ServerImportFailure *int32 + ApplicationImportFailure *int32 - // The total number of server records in the import file that were successfully - // imported. - ServerImportSuccess *int32 + // The total number of application records in the import file that were + // successfully imported. + ApplicationImportSuccess *int32 // A unique token used to prevent the same import request from occurring more than // once. If you didn't provide a token, a token was automatically generated when // the import task request was sent. ClientRequestToken *string - // The time that the import task request was made, presented in the Unix time stamp - // format. - ImportRequestTime *time.Time - - // The total number of application records in the import file that were - // successfully imported. - ApplicationImportSuccess *int32 - - // The URL for your import file that you've uploaded to Amazon S3. - ImportUrl *string - - // The status of the import task. An import can have the status of IMPORT_COMPLETE - // and still have some records fail to import from the overall request. More - // information can be found in the downloadable archive defined in the - // errorsAndFailedEntriesZip field, or in the Migration Hub management console. - Status ImportStatus - - // The time that the import task request finished, presented in the Unix time stamp - // format. - ImportCompletionTime *time.Time - // A link to a compressed archive folder (in the ZIP format) that contains an error // log and a file of failed records. You can use these two files to quickly // identify records that failed, why they failed, and correct those records. @@ -426,13 +395,44 @@ type ImportTask struct { // original file and attempt importing it again.

ErrorsAndFailedEntriesZip *string - // The total number of application records in the import file that failed to be - // imported. - ApplicationImportFailure *int32 + // The time that the import task request finished, presented in the Unix time stamp + // format. + ImportCompletionTime *time.Time + + // The time that the import task request was deleted, presented in the Unix time + // stamp format. + ImportDeletedTime *time.Time + + // The time that the import task request was made, presented in the Unix time stamp + // format. + ImportRequestTime *time.Time // The unique ID for a specific import task. These IDs aren't globally unique, but // they are unique within an AWS account. ImportTaskId *string + + // The URL for your import file that you've uploaded to Amazon S3. + ImportUrl *string + + // A descriptive name for an import task. You can use this name to filter future + // requests related to this import task, such as identifying applications and + // servers that were included in this import task. We recommend that you use a + // meaningful name for each import task. + Name *string + + // The total number of server records in the import file that failed to be + // imported. + ServerImportFailure *int32 + + // The total number of server records in the import file that were successfully + // imported. + ServerImportSuccess *int32 + + // The status of the import task. An import can have the status of IMPORT_COMPLETE + // and still have some records fail to import from the overall request. More + // information can be found in the downloadable archive defined in the + // errorsAndFailedEntriesZip field, or in the Migration Hub management console. + Status ImportStatus } // A name-values pair of elements you can use to filter the results when querying @@ -467,11 +467,11 @@ type NeighborConnectionDetail struct { // This member is required. SourceServerId *string - // The network protocol used for the connection. - TransportProtocol *string - // The destination network port for the connection. DestinationPort *int32 + + // The network protocol used for the connection. + TransportProtocol *string } // A field and direction for ordered output. @@ -503,13 +503,13 @@ type Tag struct { // The tag filter. Valid names are: tagKey, tagValue, configurationId. type TagFilter struct { - // Values for the tag filter. + // A name of the tag filter. // // This member is required. - Values []*string + Name *string - // A name of the tag filter. + // Values for the tag filter. // // This member is required. - Name *string + Values []*string } diff --git a/service/applicationinsights/api_op_CreateApplication.go b/service/applicationinsights/api_op_CreateApplication.go index dcaf57f5d57..c1a0344ff49 100644 --- a/service/applicationinsights/api_op_CreateApplication.go +++ b/service/applicationinsights/api_op_CreateApplication.go @@ -57,6 +57,16 @@ func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicatio type CreateApplicationInput struct { + // The name of the resource group. + // + // This member is required. + ResourceGroupName *string + + // Indicates whether Application Insights can listen to CloudWatch events for the + // application resources, such as instance terminated, failed deployment, and + // others. + CWEMonitorEnabled *bool + // When set to true, creates opsItems for any problems detected on an application. OpsCenterEnabled *bool @@ -68,16 +78,6 @@ type CreateApplicationInput struct { // value (Value). The maximum length of a tag key is 128 characters. The maximum // length of a tag value is 256 characters. Tags []*types.Tag - - // The name of the resource group. - // - // This member is required. - ResourceGroupName *string - - // Indicates whether Application Insights can listen to CloudWatch events for the - // application resources, such as instance terminated, failed deployment, and - // others. - CWEMonitorEnabled *bool } type CreateApplicationOutput struct { diff --git a/service/applicationinsights/api_op_CreateComponent.go b/service/applicationinsights/api_op_CreateComponent.go index 6f6200a5e6f..cc21b2b1ec6 100644 --- a/service/applicationinsights/api_op_CreateComponent.go +++ b/service/applicationinsights/api_op_CreateComponent.go @@ -56,11 +56,6 @@ func (c *Client) CreateComponent(ctx context.Context, params *CreateComponentInp type CreateComponentInput struct { - // The list of resource ARNs that belong to the component. - // - // This member is required. - ResourceList []*string - // The name of the component. // // This member is required. @@ -70,6 +65,11 @@ type CreateComponentInput struct { // // This member is required. ResourceGroupName *string + + // The list of resource ARNs that belong to the component. + // + // This member is required. + ResourceList []*string } type CreateComponentOutput struct { diff --git a/service/applicationinsights/api_op_CreateLogPattern.go b/service/applicationinsights/api_op_CreateLogPattern.go index 2abf4d93878..975c1bb58db 100644 --- a/service/applicationinsights/api_op_CreateLogPattern.go +++ b/service/applicationinsights/api_op_CreateLogPattern.go @@ -57,40 +57,40 @@ func (c *Client) CreateLogPattern(ctx context.Context, params *CreateLogPatternI type CreateLogPatternInput struct { - // Rank of the log pattern. + // The log pattern. // // This member is required. - Rank *int32 + Pattern *string // The name of the log pattern. // // This member is required. PatternName *string - // The name of the resource group. + // The name of the log pattern set. // // This member is required. - ResourceGroupName *string + PatternSetName *string - // The name of the log pattern set. + // Rank of the log pattern. // // This member is required. - PatternSetName *string + Rank *int32 - // The log pattern. + // The name of the resource group. // // This member is required. - Pattern *string + ResourceGroupName *string } type CreateLogPatternOutput struct { - // The name of the resource group. - ResourceGroupName *string - // The successfully created log pattern. LogPattern *types.LogPattern + // The name of the resource group. + ResourceGroupName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/applicationinsights/api_op_DeleteComponent.go b/service/applicationinsights/api_op_DeleteComponent.go index 9086005c968..295f360db06 100644 --- a/service/applicationinsights/api_op_DeleteComponent.go +++ b/service/applicationinsights/api_op_DeleteComponent.go @@ -58,15 +58,15 @@ func (c *Client) DeleteComponent(ctx context.Context, params *DeleteComponentInp type DeleteComponentInput struct { - // The name of the resource group. + // The name of the component. // // This member is required. - ResourceGroupName *string + ComponentName *string - // The name of the component. + // The name of the resource group. // // This member is required. - ComponentName *string + ResourceGroupName *string } type DeleteComponentOutput struct { diff --git a/service/applicationinsights/api_op_DeleteLogPattern.go b/service/applicationinsights/api_op_DeleteLogPattern.go index 6d9866e9556..713ba5c9669 100644 --- a/service/applicationinsights/api_op_DeleteLogPattern.go +++ b/service/applicationinsights/api_op_DeleteLogPattern.go @@ -61,15 +61,15 @@ type DeleteLogPatternInput struct { // This member is required. PatternName *string - // The name of the resource group. + // The name of the log pattern set. // // This member is required. - ResourceGroupName *string + PatternSetName *string - // The name of the log pattern set. + // The name of the resource group. // // This member is required. - PatternSetName *string + ResourceGroupName *string } type DeleteLogPatternOutput struct { diff --git a/service/applicationinsights/api_op_DescribeComponent.go b/service/applicationinsights/api_op_DescribeComponent.go index 4e7cb75330d..7440938af65 100644 --- a/service/applicationinsights/api_op_DescribeComponent.go +++ b/service/applicationinsights/api_op_DescribeComponent.go @@ -58,15 +58,15 @@ func (c *Client) DescribeComponent(ctx context.Context, params *DescribeComponen type DescribeComponentInput struct { - // The name of the resource group. + // The name of the component. // // This member is required. - ResourceGroupName *string + ComponentName *string - // The name of the component. + // The name of the resource group. // // This member is required. - ComponentName *string + ResourceGroupName *string } type DescribeComponentOutput struct { diff --git a/service/applicationinsights/api_op_DescribeComponentConfiguration.go b/service/applicationinsights/api_op_DescribeComponentConfiguration.go index f001e26660b..1d57b676eda 100644 --- a/service/applicationinsights/api_op_DescribeComponentConfiguration.go +++ b/service/applicationinsights/api_op_DescribeComponentConfiguration.go @@ -70,16 +70,16 @@ type DescribeComponentConfigurationInput struct { type DescribeComponentConfigurationOutput struct { - // The tier of the application component. Supported tiers include DOT_NET_CORE, - // DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER, and DEFAULT - Tier types.Tier + // The configuration settings of the component. The value is the escaped JSON of + // the configuration. + ComponentConfiguration *string // Indicates whether the application component is monitored. Monitor *bool - // The configuration settings of the component. The value is the escaped JSON of - // the configuration. - ComponentConfiguration *string + // The tier of the application component. Supported tiers include DOT_NET_CORE, + // DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER, and DEFAULT + Tier types.Tier // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/applicationinsights/api_op_DescribeComponentConfigurationRecommendation.go b/service/applicationinsights/api_op_DescribeComponentConfigurationRecommendation.go index 3650ddfefee..a0308b0df37 100644 --- a/service/applicationinsights/api_op_DescribeComponentConfigurationRecommendation.go +++ b/service/applicationinsights/api_op_DescribeComponentConfigurationRecommendation.go @@ -62,16 +62,16 @@ type DescribeComponentConfigurationRecommendationInput struct { // This member is required. ComponentName *string - // The tier of the application component. Supported tiers include DOT_NET_CORE, - // DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER, and DEFAULT. + // The name of the resource group. // // This member is required. - Tier types.Tier + ResourceGroupName *string - // The name of the resource group. + // The tier of the application component. Supported tiers include DOT_NET_CORE, + // DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER, and DEFAULT. // // This member is required. - ResourceGroupName *string + Tier types.Tier } type DescribeComponentConfigurationRecommendationOutput struct { diff --git a/service/applicationinsights/api_op_DescribeLogPattern.go b/service/applicationinsights/api_op_DescribeLogPattern.go index 6bd7f229a5e..2e3ad4410fe 100644 --- a/service/applicationinsights/api_op_DescribeLogPattern.go +++ b/service/applicationinsights/api_op_DescribeLogPattern.go @@ -62,15 +62,15 @@ type DescribeLogPatternInput struct { // This member is required. PatternName *string - // The name of the resource group. + // The name of the log pattern set. // // This member is required. - ResourceGroupName *string + PatternSetName *string - // The name of the log pattern set. + // The name of the resource group. // // This member is required. - PatternSetName *string + ResourceGroupName *string } type DescribeLogPatternOutput struct { diff --git a/service/applicationinsights/api_op_ListApplications.go b/service/applicationinsights/api_op_ListApplications.go index 4adcd83e0d1..1e6e3acf52d 100644 --- a/service/applicationinsights/api_op_ListApplications.go +++ b/service/applicationinsights/api_op_ListApplications.go @@ -56,23 +56,23 @@ func (c *Client) ListApplications(ctx context.Context, params *ListApplicationsI type ListApplicationsInput struct { - // The token to request the next page of results. - NextToken *string - // The maximum number of results to return in a single call. To retrieve the // remaining results, make another call with the returned NextToken value. MaxResults *int32 + + // The token to request the next page of results. + NextToken *string } type ListApplicationsOutput struct { + // The list of applications. + ApplicationInfoList []*types.ApplicationInfo + // The token used to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string - // The list of applications. - ApplicationInfoList []*types.ApplicationInfo - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/applicationinsights/api_op_ListComponents.go b/service/applicationinsights/api_op_ListComponents.go index ec074eb1085..919da12f48c 100644 --- a/service/applicationinsights/api_op_ListComponents.go +++ b/service/applicationinsights/api_op_ListComponents.go @@ -57,27 +57,27 @@ func (c *Client) ListComponents(ctx context.Context, params *ListComponentsInput type ListComponentsInput struct { - // The maximum number of results to return in a single call. To retrieve the - // remaining results, make another call with the returned NextToken value. - MaxResults *int32 - // The name of the resource group. // // This member is required. ResourceGroupName *string + // The maximum number of results to return in a single call. To retrieve the + // remaining results, make another call with the returned NextToken value. + MaxResults *int32 + // The token to request the next page of results. NextToken *string } type ListComponentsOutput struct { - // The token to request the next page of results. - NextToken *string - // The list of application components. ApplicationComponentList []*types.ApplicationComponent + // The token to request the next page of results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/applicationinsights/api_op_ListConfigurationHistory.go b/service/applicationinsights/api_op_ListConfigurationHistory.go index 596eddad683..f0c269f5039 100644 --- a/service/applicationinsights/api_op_ListConfigurationHistory.go +++ b/service/applicationinsights/api_op_ListConfigurationHistory.go @@ -67,6 +67,13 @@ func (c *Client) ListConfigurationHistory(ctx context.Context, params *ListConfi type ListConfigurationHistoryInput struct { + // The end time of the event. + EndTime *time.Time + + // The status of the configuration update event. Possible values include INFO, + // WARN, and ERROR. + EventStatus types.ConfigurationEventStatus + // The maximum number of results returned by ListConfigurationHistory in paginated // output. When this parameter is used, ListConfigurationHistory returns only // MaxResults in a single page along with a NextToken response element. The @@ -75,9 +82,6 @@ type ListConfigurationHistoryInput struct { // parameter is not used, then ListConfigurationHistory returns all results. MaxResults *int32 - // Resource group to which the application belongs. - ResourceGroupName *string - // The NextToken value returned from a previous paginated ListConfigurationHistory // request where MaxResults was used and the results exceeded the value of that // parameter. Pagination continues from the end of the previous results that @@ -85,12 +89,8 @@ type ListConfigurationHistoryInput struct { // to return. NextToken *string - // The status of the configuration update event. Possible values include INFO, - // WARN, and ERROR. - EventStatus types.ConfigurationEventStatus - - // The end time of the event. - EndTime *time.Time + // Resource group to which the application belongs. + ResourceGroupName *string // The start time of the event. StartTime *time.Time diff --git a/service/applicationinsights/api_op_ListLogPatternSets.go b/service/applicationinsights/api_op_ListLogPatternSets.go index d62ed5d59ae..c5317756dbb 100644 --- a/service/applicationinsights/api_op_ListLogPatternSets.go +++ b/service/applicationinsights/api_op_ListLogPatternSets.go @@ -56,24 +56,21 @@ func (c *Client) ListLogPatternSets(ctx context.Context, params *ListLogPatternS type ListLogPatternSetsInput struct { - // The maximum number of results to return in a single call. To retrieve the - // remaining results, make another call with the returned NextToken value. - MaxResults *int32 - // The name of the resource group. // // This member is required. ResourceGroupName *string + // The maximum number of results to return in a single call. To retrieve the + // remaining results, make another call with the returned NextToken value. + MaxResults *int32 + // The token to request the next page of results. NextToken *string } type ListLogPatternSetsOutput struct { - // The name of the resource group. - ResourceGroupName *string - // The list of log pattern sets. LogPatternSets []*string @@ -81,6 +78,9 @@ type ListLogPatternSetsOutput struct { // there are no more results to return. NextToken *string + // The name of the resource group. + ResourceGroupName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/applicationinsights/api_op_ListLogPatterns.go b/service/applicationinsights/api_op_ListLogPatterns.go index 7d423f23ce4..075ace50405 100644 --- a/service/applicationinsights/api_op_ListLogPatterns.go +++ b/service/applicationinsights/api_op_ListLogPatterns.go @@ -66,22 +66,22 @@ type ListLogPatternsInput struct { // remaining results, make another call with the returned NextToken value. MaxResults *int32 - // The name of the log pattern set. - PatternSetName *string - // The token to request the next page of results. NextToken *string + + // The name of the log pattern set. + PatternSetName *string } type ListLogPatternsOutput struct { + // The list of log patterns. + LogPatterns []*types.LogPattern + // The token used to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string - // The list of log patterns. - LogPatterns []*types.LogPattern - // The name of the resource group. ResourceGroupName *string diff --git a/service/applicationinsights/api_op_ListProblems.go b/service/applicationinsights/api_op_ListProblems.go index e6b88220aa3..2925426bba5 100644 --- a/service/applicationinsights/api_op_ListProblems.go +++ b/service/applicationinsights/api_op_ListProblems.go @@ -57,34 +57,34 @@ func (c *Client) ListProblems(ctx context.Context, params *ListProblemsInput, op type ListProblemsInput struct { - // The time when the problem was detected, in epoch seconds. If you don't specify a - // time frame for the request, problems within the past seven days are returned. - StartTime *time.Time - - // The name of the resource group. - ResourceGroupName *string - // The time when the problem ended, in epoch seconds. If not specified, problems // within the past seven days are returned. EndTime *time.Time - // The token to request the next page of results. - NextToken *string - // The maximum number of results to return in a single call. To retrieve the // remaining results, make another call with the returned NextToken value. MaxResults *int32 + + // The token to request the next page of results. + NextToken *string + + // The name of the resource group. + ResourceGroupName *string + + // The time when the problem was detected, in epoch seconds. If you don't specify a + // time frame for the request, problems within the past seven days are returned. + StartTime *time.Time } type ListProblemsOutput struct { - // The list of problems. - ProblemList []*types.Problem - // The token used to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string + // The list of problems. + ProblemList []*types.Problem + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/applicationinsights/api_op_UpdateApplication.go b/service/applicationinsights/api_op_UpdateApplication.go index b548107516c..b68fe7e7dd3 100644 --- a/service/applicationinsights/api_op_UpdateApplication.go +++ b/service/applicationinsights/api_op_UpdateApplication.go @@ -57,25 +57,25 @@ func (c *Client) UpdateApplication(ctx context.Context, params *UpdateApplicatio type UpdateApplicationInput struct { - // Indicates whether Application Insights can listen to CloudWatch events for the - // application resources, such as instance terminated, failed deployment, and - // others. - CWEMonitorEnabled *bool - // The name of the resource group. // // This member is required. ResourceGroupName *string + // Indicates whether Application Insights can listen to CloudWatch events for the + // application resources, such as instance terminated, failed deployment, and + // others. + CWEMonitorEnabled *bool + // When set to true, creates opsItems for any problems detected on an application. OpsCenterEnabled *bool - // Disassociates the SNS topic from the opsItem created for detected problems. - RemoveSNSTopic *bool - // The SNS topic provided to Application Insights that is associated to the created // opsItem. Allows you to receive notifications for updates to the opsItem. OpsItemSNSTopicArn *string + + // Disassociates the SNS topic from the opsItem created for detected problems. + RemoveSNSTopic *bool } type UpdateApplicationOutput struct { diff --git a/service/applicationinsights/api_op_UpdateComponent.go b/service/applicationinsights/api_op_UpdateComponent.go index c7c04bed9b2..df7d5de2437 100644 --- a/service/applicationinsights/api_op_UpdateComponent.go +++ b/service/applicationinsights/api_op_UpdateComponent.go @@ -57,18 +57,18 @@ func (c *Client) UpdateComponent(ctx context.Context, params *UpdateComponentInp type UpdateComponentInput struct { - // The new name of the component. - NewComponentName *string + // The name of the component. + // + // This member is required. + ComponentName *string // The name of the resource group. // // This member is required. ResourceGroupName *string - // The name of the component. - // - // This member is required. - ComponentName *string + // The new name of the component. + NewComponentName *string // The list of resource ARNs that belong to the component. ResourceList []*string diff --git a/service/applicationinsights/api_op_UpdateComponentConfiguration.go b/service/applicationinsights/api_op_UpdateComponentConfiguration.go index 95c57c98319..af81dc01e45 100644 --- a/service/applicationinsights/api_op_UpdateComponentConfiguration.go +++ b/service/applicationinsights/api_op_UpdateComponentConfiguration.go @@ -59,10 +59,6 @@ func (c *Client) UpdateComponentConfiguration(ctx context.Context, params *Updat type UpdateComponentConfigurationInput struct { - // The tier of the application component. Supported tiers include DOT_NET_WORKER, - // DOT_NET_WEB, DOT_NET_CORE, SQL_SERVER, and DEFAULT. - Tier types.Tier - // The name of the component. // // This member is required. @@ -73,9 +69,6 @@ type UpdateComponentConfigurationInput struct { // This member is required. ResourceGroupName *string - // Indicates whether the application component is monitored. - Monitor *bool - // The configuration settings of the component. The value is the escaped JSON of // the configuration. For more information about the JSON format, see Working with // JSON @@ -85,6 +78,13 @@ type UpdateComponentConfigurationInput struct { // component configuration file, see Component Configuration // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/component-config.html). ComponentConfiguration *string + + // Indicates whether the application component is monitored. + Monitor *bool + + // The tier of the application component. Supported tiers include DOT_NET_WORKER, + // DOT_NET_WEB, DOT_NET_CORE, SQL_SERVER, and DEFAULT. + Tier types.Tier } type UpdateComponentConfigurationOutput struct { diff --git a/service/applicationinsights/api_op_UpdateLogPattern.go b/service/applicationinsights/api_op_UpdateLogPattern.go index bc7a15871a3..c22fcf3e21b 100644 --- a/service/applicationinsights/api_op_UpdateLogPattern.go +++ b/service/applicationinsights/api_op_UpdateLogPattern.go @@ -57,8 +57,10 @@ func (c *Client) UpdateLogPattern(ctx context.Context, params *UpdateLogPatternI type UpdateLogPatternInput struct { - // The log pattern. - Pattern *string + // The name of the log pattern. + // + // This member is required. + PatternName *string // The name of the log pattern set. // @@ -70,10 +72,8 @@ type UpdateLogPatternInput struct { // This member is required. ResourceGroupName *string - // The name of the log pattern. - // - // This member is required. - PatternName *string + // The log pattern. + Pattern *string // Rank of the log pattern. Rank *int32 @@ -81,12 +81,12 @@ type UpdateLogPatternInput struct { type UpdateLogPatternOutput struct { - // The name of the resource group. - ResourceGroupName *string - // The successfully created log pattern. LogPattern *types.LogPattern + // The name of the resource group. + ResourceGroupName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/applicationinsights/go.mod b/service/applicationinsights/go.mod index 0cc3cc72316..e978d552e8b 100644 --- a/service/applicationinsights/go.mod +++ b/service/applicationinsights/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/applicationinsights go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/applicationinsights/types/types.go b/service/applicationinsights/types/types.go index 6dda1eb1bd4..61e9898aac3 100644 --- a/service/applicationinsights/types/types.go +++ b/service/applicationinsights/types/types.go @@ -10,16 +10,16 @@ import ( // application is made up of. type ApplicationComponent struct { - // The resource type. Supported resource types include EC2 instances, Auto Scaling - // group, Classic ELB, Application ELB, and SQS Queue. - ResourceType *string - // The name of the component. ComponentName *string // Indicates whether the application component is monitored. Monitor *bool + // The resource type. Supported resource types include EC2 instances, Auto Scaling + // group, Classic ELB, Application ELB, and SQS Queue. + ResourceType *string + // The stack tier of the application component. Tier Tier } @@ -27,20 +27,22 @@ type ApplicationComponent struct { // Describes the status of the application. type ApplicationInfo struct { - // The SNS topic provided to Application Insights that is associated to the created - // opsItems to receive SNS notifications for opsItem updates. - OpsItemSNSTopicArn *string + // Indicates whether Application Insights can listen to CloudWatch events for the + // application resources, such as instance terminated, failed deployment, and + // others. + CWEMonitorEnabled *bool // The lifecycle of the application. LifeCycle *string - // The name of the resource group used for the application. - ResourceGroupName *string - // Indicates whether Application Insights will create opsItems for any problem // detected by Application Insights for an application. OpsCenterEnabled *bool + // The SNS topic provided to Application Insights that is associated to the created + // opsItems to receive SNS notifications for opsItem updates. + OpsItemSNSTopicArn *string + // The issues on the user side that block Application Insights from successfully // monitoring an application. Example remarks include: // @@ -51,10 +53,8 @@ type ApplicationInfo struct { // detected 1 Unconfigured Components” Remarks *string - // Indicates whether Application Insights can listen to CloudWatch events for the - // application resources, such as instance terminated, failed deployment, and - // others. - CWEMonitorEnabled *bool + // The name of the resource group used for the application. + ResourceGroupName *string } // The event information. @@ -63,13 +63,6 @@ type ConfigurationEvent struct { // The details of the event in plain text. EventDetail *string - // The resource monitored by Application Insights. - MonitoredResourceARN *string - - // The status of the configuration update event. Possible values include INFO, - // WARN, and ERROR. - EventStatus ConfigurationEventStatus - // The name of the resource Application Insights attempted to configure. EventResourceName *string @@ -77,21 +70,20 @@ type ConfigurationEvent struct { // CLOUDWATCH_ALARM. EventResourceType ConfigurationEventResourceType + // The status of the configuration update event. Possible values include INFO, + // WARN, and ERROR. + EventStatus ConfigurationEventStatus + // The timestamp of the event. EventTime *time.Time + + // The resource monitored by Application Insights. + MonitoredResourceARN *string } // An object that defines the log patterns that belongs to a LogPatternSet. type LogPattern struct { - // The name of the log pattern. A log pattern name can contains at many as 30 - // characters, and it cannot be empty. The characters can be Unicode letters, - // digits or one of the following symbols: period, dash, underscore. - PatternSetName *string - - // Rank of the log pattern. - Rank *int32 - // A regular expression that defines the log pattern. A log pattern can contains at // many as 50 characters, and it cannot be empty. Pattern *string @@ -100,117 +92,125 @@ type LogPattern struct { // characters, and it cannot be empty. The characters can be Unicode letters, // digits or one of the following symbols: period, dash, underscore. PatternName *string + + // The name of the log pattern. A log pattern name can contains at many as 30 + // characters, and it cannot be empty. The characters can be Unicode letters, + // digits or one of the following symbols: period, dash, underscore. + PatternSetName *string + + // Rank of the log pattern. + Rank *int32 } // Describes an anomaly or error with the application. type Observation struct { - // The source of the CloudWatch Event. - CloudWatchEventSource CloudWatchEventSource - // The detail type of the CloudWatch Event-based observation, for example, EC2 // Instance State-change Notification. CloudWatchEventDetailType *string - // The name of the X-Ray node. - XRayNodeName *string - - // The ID of the observation type. - Id *string + // The ID of the CloudWatch Event-based observation related to the detected + // problem. + CloudWatchEventId *string - // The source resource ARN of the observation. - SourceARN *string + // The source of the CloudWatch Event. + CloudWatchEventSource CloudWatchEventSource // The CodeDeploy application to which the deployment belongs. CodeDeployApplication *string - // The description of the AWS Health event provided by the service, such as Amazon - // EC2. - HealthEventDescription *string - - // The category of the AWS Health event, such as issue. - HealthEventTypeCategory *string - - // The X-Ray request throttle percentage for this node. - XRayThrottlePercent *int32 - - // The value of the source observation metric. - Value *float64 - - // The log filter of the observation. - LogFilter LogFilter - // The deployment group to which the CodeDeploy deployment belongs. CodeDeployDeploymentGroup *string + // The deployment ID of the CodeDeploy-based observation related to the detected + // problem. + CodeDeployDeploymentId *string + // The instance group to which the CodeDeploy instance belongs. CodeDeployInstanceGroupId *string - // The ID of the CloudWatch Event-based observation related to the detected - // problem. - CloudWatchEventId *string + // The status of the CodeDeploy deployment, for example SUCCESS or FAILURE. + CodeDeployState *string - // The unit of the source observation metric. - Unit *string + // The state of the instance, such as STOPPING or TERMINATING. + Ec2State *string // The time when the observation ended, in epoch seconds. EndTime *time.Time - // The log text of the observation. - LogText *string - - // The state of the instance, such as STOPPING or TERMINATING. - Ec2State *string + // The Amazon Resource Name (ARN) of the AWS Health Event-based observation. + HealthEventArn *string - // The log group name. - LogGroup *string + // The description of the AWS Health event provided by the service, such as Amazon + // EC2. + HealthEventDescription *string - // The X-Ray node request average latency for this node. - XRayRequestAverageLatency *int64 + // The category of the AWS Health event, such as issue. + HealthEventTypeCategory *string // The type of the AWS Health event, for example, AWS_EC2_POWER_CONNECTIVITY_ISSUE. HealthEventTypeCode *string - // The deployment ID of the CodeDeploy-based observation related to the detected - // problem. - CodeDeployDeploymentId *string - - // The name of the observation metric. - MetricName *string - // The service to which the AWS Health Event belongs, such as EC2. HealthService *string + // The ID of the observation type. + Id *string + // The timestamp in the CloudWatch Logs that specifies when the matched line // occurred. LineTime *time.Time - // The Amazon Resource Name (ARN) of the AWS Health Event-based observation. - HealthEventArn *string + // The log filter of the observation. + LogFilter LogFilter - // The status of the CodeDeploy deployment, for example SUCCESS or FAILURE. - CodeDeployState *string + // The log group name. + LogGroup *string - // The type of the X-Ray node. - XRayNodeType *string + // The log text of the observation. + LogText *string + + // The name of the observation metric. + MetricName *string + + // The namespace of the observation metric. + MetricNamespace *string + + // The source resource ARN of the observation. + SourceARN *string // The source type of the observation. SourceType *string - // The X-Ray request count for this node. - XRayRequestCount *int32 - // The time when the observation was first detected, in epoch seconds. StartTime *time.Time + // The unit of the source observation metric. + Unit *string + + // The value of the source observation metric. + Value *float64 + // The X-Ray request error percentage for this node. XRayErrorPercent *int32 - // The namespace of the observation metric. - MetricNamespace *string - // The X-Ray request fault percentage for this node. XRayFaultPercent *int32 + + // The name of the X-Ray node. + XRayNodeName *string + + // The type of the X-Ray node. + XRayNodeType *string + + // The X-Ray node request average latency for this node. + XRayRequestAverageLatency *int64 + + // The X-Ray request count for this node. + XRayRequestCount *int32 + + // The X-Ray request throttle percentage for this node. + XRayThrottlePercent *int32 } // Describes a problem that is detected by correlating observations. @@ -219,32 +219,32 @@ type Problem struct { // The resource affected by the problem. AffectedResource *string - // A detailed analysis of the problem using machine learning. - Insights *string - - // Feedback provided by the user about the problem. - Feedback map[string]FeedbackValue - // The time when the problem ended, in epoch seconds. EndTime *time.Time - // The status of the problem. - Status Status + // Feedback provided by the user about the problem. + Feedback map[string]FeedbackValue - // The name of the problem. - Title *string + // The ID of the problem. + Id *string - // The time when the problem started, in epoch seconds. - StartTime *time.Time + // A detailed analysis of the problem using machine learning. + Insights *string // The name of the resource group affected by the problem. ResourceGroupName *string - // The ID of the problem. - Id *string - // A measure of the level of impact of the problem. SeverityLevel SeverityLevel + + // The time when the problem started, in epoch seconds. + StartTime *time.Time + + // The status of the problem. + Status Status + + // The name of the problem. + Title *string } // Describes observations related to the problem. diff --git a/service/appmesh/api_op_CreateGatewayRoute.go b/service/appmesh/api_op_CreateGatewayRoute.go index 5d7eb1e243f..d6d1fbbac7d 100644 --- a/service/appmesh/api_op_CreateGatewayRoute.go +++ b/service/appmesh/api_op_CreateGatewayRoute.go @@ -70,6 +70,11 @@ type CreateGatewayRouteInput struct { // This member is required. MeshName *string + // The gateway route specification to apply. + // + // This member is required. + Spec *types.GatewayRouteSpec + // The name of the virtual gateway to associate the gateway route with. If the // virtual gateway is in a shared mesh, then you must be the owner of the virtual // gateway resource. @@ -77,17 +82,6 @@ type CreateGatewayRouteInput struct { // This member is required. VirtualGatewayName *string - // The gateway route specification to apply. - // - // This member is required. - Spec *types.GatewayRouteSpec - - // Optional metadata that you can apply to the gateway route to assist with - // categorization and organization. Each tag consists of a key and an optional - // value, both of which you define. Tag keys can have a maximum character length of - // 128 characters, and tag values can have a maximum length of 256 characters. - Tags []*types.TagRef - // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. ClientToken *string @@ -98,6 +92,12 @@ type CreateGatewayRouteInput struct { // about mesh sharing, see Working with shared meshes // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). MeshOwner *string + + // Optional metadata that you can apply to the gateway route to assist with + // categorization and organization. Each tag consists of a key and an optional + // value, both of which you define. Tag keys can have a maximum character length of + // 128 characters, and tag values can have a maximum length of 256 characters. + Tags []*types.TagRef } type CreateGatewayRouteOutput struct { diff --git a/service/appmesh/api_op_CreateMesh.go b/service/appmesh/api_op_CreateMesh.go index eff9f394e03..984120cd4f1 100644 --- a/service/appmesh/api_op_CreateMesh.go +++ b/service/appmesh/api_op_CreateMesh.go @@ -67,6 +67,10 @@ type CreateMeshInput struct { // This member is required. MeshName *string + // Unique, case-sensitive identifier that you provide to ensure the idempotency of + // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. + ClientToken *string + // The service mesh specification to apply. Spec *types.MeshSpec @@ -75,10 +79,6 @@ type CreateMeshInput struct { // value, both of which you define. Tag keys can have a maximum character length of // 128 characters, and tag values can have a maximum length of 256 characters. Tags []*types.TagRef - - // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. - ClientToken *string } // diff --git a/service/appmesh/api_op_CreateRoute.go b/service/appmesh/api_op_CreateRoute.go index 9ee9dc0c641..2c7a107b506 100644 --- a/service/appmesh/api_op_CreateRoute.go +++ b/service/appmesh/api_op_CreateRoute.go @@ -60,15 +60,20 @@ func (c *Client) CreateRoute(ctx context.Context, params *CreateRouteInput, optF // type CreateRouteInput struct { + // The name of the service mesh to create the route in. + // + // This member is required. + MeshName *string + // The name to use for the route. // // This member is required. RouteName *string - // The name of the service mesh to create the route in. + // The route specification to apply. // // This member is required. - MeshName *string + Spec *types.RouteSpec // The name of the virtual router in which to create the route. If the virtual // router is in a shared mesh, then you must be the owner of the virtual router @@ -77,17 +82,6 @@ type CreateRouteInput struct { // This member is required. VirtualRouterName *string - // The route specification to apply. - // - // This member is required. - Spec *types.RouteSpec - - // Optional metadata that you can apply to the route to assist with categorization - // and organization. Each tag consists of a key and an optional value, both of - // which you define. Tag keys can have a maximum character length of 128 - // characters, and tag values can have a maximum length of 256 characters. - Tags []*types.TagRef - // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. ClientToken *string @@ -98,6 +92,12 @@ type CreateRouteInput struct { // about mesh sharing, see Working with shared meshes // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). MeshOwner *string + + // Optional metadata that you can apply to the route to assist with categorization + // and organization. Each tag consists of a key and an optional value, both of + // which you define. Tag keys can have a maximum character length of 128 + // characters, and tag values can have a maximum length of 256 characters. + Tags []*types.TagRef } // diff --git a/service/appmesh/api_op_CreateVirtualGateway.go b/service/appmesh/api_op_CreateVirtualGateway.go index ef5873704dc..e8b6e00d1bb 100644 --- a/service/appmesh/api_op_CreateVirtualGateway.go +++ b/service/appmesh/api_op_CreateVirtualGateway.go @@ -63,11 +63,6 @@ func (c *Client) CreateVirtualGateway(ctx context.Context, params *CreateVirtual type CreateVirtualGatewayInput struct { - // The name to use for the virtual gateway. - // - // This member is required. - VirtualGatewayName *string - // The name of the service mesh to create the virtual gateway in. // // This member is required. @@ -78,11 +73,10 @@ type CreateVirtualGatewayInput struct { // This member is required. Spec *types.VirtualGatewaySpec - // Optional metadata that you can apply to the virtual gateway to assist with - // categorization and organization. Each tag consists of a key and an optional - // value, both of which you define. Tag keys can have a maximum character length of - // 128 characters, and tag values can have a maximum length of 256 characters. - Tags []*types.TagRef + // The name to use for the virtual gateway. + // + // This member is required. + VirtualGatewayName *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. @@ -94,6 +88,12 @@ type CreateVirtualGatewayInput struct { // about mesh sharing, see Working with shared meshes // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). MeshOwner *string + + // Optional metadata that you can apply to the virtual gateway to assist with + // categorization and organization. Each tag consists of a key and an optional + // value, both of which you define. Tag keys can have a maximum character length of + // 128 characters, and tag values can have a maximum length of 256 characters. + Tags []*types.TagRef } type CreateVirtualGatewayOutput struct { diff --git a/service/appmesh/api_op_CreateVirtualNode.go b/service/appmesh/api_op_CreateVirtualNode.go index 390b3d41f67..faf17125e75 100644 --- a/service/appmesh/api_op_CreateVirtualNode.go +++ b/service/appmesh/api_op_CreateVirtualNode.go @@ -74,11 +74,6 @@ func (c *Client) CreateVirtualNode(ctx context.Context, params *CreateVirtualNod // type CreateVirtualNodeInput struct { - // The name to use for the virtual node. - // - // This member is required. - VirtualNodeName *string - // The name of the service mesh to create the virtual node in. // // This member is required. @@ -89,11 +84,10 @@ type CreateVirtualNodeInput struct { // This member is required. Spec *types.VirtualNodeSpec - // Optional metadata that you can apply to the virtual node to assist with - // categorization and organization. Each tag consists of a key and an optional - // value, both of which you define. Tag keys can have a maximum character length of - // 128 characters, and tag values can have a maximum length of 256 characters. - Tags []*types.TagRef + // The name to use for the virtual node. + // + // This member is required. + VirtualNodeName *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. @@ -105,6 +99,12 @@ type CreateVirtualNodeInput struct { // about mesh sharing, see Working with shared meshes // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). MeshOwner *string + + // Optional metadata that you can apply to the virtual node to assist with + // categorization and organization. Each tag consists of a key and an optional + // value, both of which you define. Tag keys can have a maximum character length of + // 128 characters, and tag values can have a maximum length of 256 characters. + Tags []*types.TagRef } // diff --git a/service/appmesh/api_op_CreateVirtualRouter.go b/service/appmesh/api_op_CreateVirtualRouter.go index 81f809c005a..aa45d3b4cf7 100644 --- a/service/appmesh/api_op_CreateVirtualRouter.go +++ b/service/appmesh/api_op_CreateVirtualRouter.go @@ -64,11 +64,6 @@ func (c *Client) CreateVirtualRouter(ctx context.Context, params *CreateVirtualR // type CreateVirtualRouterInput struct { - // The name to use for the virtual router. - // - // This member is required. - VirtualRouterName *string - // The name of the service mesh to create the virtual router in. // // This member is required. @@ -79,11 +74,10 @@ type CreateVirtualRouterInput struct { // This member is required. Spec *types.VirtualRouterSpec - // Optional metadata that you can apply to the virtual router to assist with - // categorization and organization. Each tag consists of a key and an optional - // value, both of which you define. Tag keys can have a maximum character length of - // 128 characters, and tag values can have a maximum length of 256 characters. - Tags []*types.TagRef + // The name to use for the virtual router. + // + // This member is required. + VirtualRouterName *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. @@ -95,6 +89,12 @@ type CreateVirtualRouterInput struct { // about mesh sharing, see Working with shared meshes // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). MeshOwner *string + + // Optional metadata that you can apply to the virtual router to assist with + // categorization and organization. Each tag consists of a key and an optional + // value, both of which you define. Tag keys can have a maximum character length of + // 128 characters, and tag values can have a maximum length of 256 characters. + Tags []*types.TagRef } // diff --git a/service/appmesh/api_op_CreateVirtualService.go b/service/appmesh/api_op_CreateVirtualService.go index bb10b70c1cb..9257705c472 100644 --- a/service/appmesh/api_op_CreateVirtualService.go +++ b/service/appmesh/api_op_CreateVirtualService.go @@ -63,11 +63,6 @@ func (c *Client) CreateVirtualService(ctx context.Context, params *CreateVirtual // type CreateVirtualServiceInput struct { - // The name to use for the virtual service. - // - // This member is required. - VirtualServiceName *string - // The name of the service mesh to create the virtual service in. // // This member is required. @@ -78,11 +73,10 @@ type CreateVirtualServiceInput struct { // This member is required. Spec *types.VirtualServiceSpec - // Optional metadata that you can apply to the virtual service to assist with - // categorization and organization. Each tag consists of a key and an optional - // value, both of which you define. Tag keys can have a maximum character length of - // 128 characters, and tag values can have a maximum length of 256 characters. - Tags []*types.TagRef + // The name to use for the virtual service. + // + // This member is required. + VirtualServiceName *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. @@ -94,6 +88,12 @@ type CreateVirtualServiceInput struct { // about mesh sharing, see Working with shared meshes // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). MeshOwner *string + + // Optional metadata that you can apply to the virtual service to assist with + // categorization and organization. Each tag consists of a key and an optional + // value, both of which you define. Tag keys can have a maximum character length of + // 128 characters, and tag values can have a maximum length of 256 characters. + Tags []*types.TagRef } // diff --git a/service/appmesh/api_op_DeleteRoute.go b/service/appmesh/api_op_DeleteRoute.go index 3c833eddec2..479a3d1c8a5 100644 --- a/service/appmesh/api_op_DeleteRoute.go +++ b/service/appmesh/api_op_DeleteRoute.go @@ -57,15 +57,15 @@ func (c *Client) DeleteRoute(ctx context.Context, params *DeleteRouteInput, optF // type DeleteRouteInput struct { - // The name of the route to delete. + // The name of the service mesh to delete the route in. // // This member is required. - RouteName *string + MeshName *string - // The name of the service mesh to delete the route in. + // The name of the route to delete. // // This member is required. - MeshName *string + RouteName *string // The name of the virtual router to delete the route in. // diff --git a/service/appmesh/api_op_DeleteVirtualGateway.go b/service/appmesh/api_op_DeleteVirtualGateway.go index ace3185cb1e..b7cb3aa08f1 100644 --- a/service/appmesh/api_op_DeleteVirtualGateway.go +++ b/service/appmesh/api_op_DeleteVirtualGateway.go @@ -57,15 +57,15 @@ func (c *Client) DeleteVirtualGateway(ctx context.Context, params *DeleteVirtual type DeleteVirtualGatewayInput struct { - // The name of the virtual gateway to delete. + // The name of the service mesh to delete the virtual gateway from. // // This member is required. - VirtualGatewayName *string + MeshName *string - // The name of the service mesh to delete the virtual gateway from. + // The name of the virtual gateway to delete. // // This member is required. - MeshName *string + VirtualGatewayName *string // The AWS IAM account ID of the service mesh owner. If the account ID is not your // own, then it's the ID of the account that shared the mesh with your account. For diff --git a/service/appmesh/api_op_DeleteVirtualNode.go b/service/appmesh/api_op_DeleteVirtualNode.go index 77f56a243ae..b2c33c78b69 100644 --- a/service/appmesh/api_op_DeleteVirtualNode.go +++ b/service/appmesh/api_op_DeleteVirtualNode.go @@ -59,15 +59,15 @@ func (c *Client) DeleteVirtualNode(ctx context.Context, params *DeleteVirtualNod // type DeleteVirtualNodeInput struct { - // The name of the virtual node to delete. + // The name of the service mesh to delete the virtual node in. // // This member is required. - VirtualNodeName *string + MeshName *string - // The name of the service mesh to delete the virtual node in. + // The name of the virtual node to delete. // // This member is required. - MeshName *string + VirtualNodeName *string // The AWS IAM account ID of the service mesh owner. If the account ID is not your // own, then it's the ID of the account that shared the mesh with your account. For diff --git a/service/appmesh/api_op_DeleteVirtualRouter.go b/service/appmesh/api_op_DeleteVirtualRouter.go index ba757b546ba..65b87963586 100644 --- a/service/appmesh/api_op_DeleteVirtualRouter.go +++ b/service/appmesh/api_op_DeleteVirtualRouter.go @@ -58,15 +58,15 @@ func (c *Client) DeleteVirtualRouter(ctx context.Context, params *DeleteVirtualR // type DeleteVirtualRouterInput struct { - // The name of the virtual router to delete. + // The name of the service mesh to delete the virtual router in. // // This member is required. - VirtualRouterName *string + MeshName *string - // The name of the service mesh to delete the virtual router in. + // The name of the virtual router to delete. // // This member is required. - MeshName *string + VirtualRouterName *string // The AWS IAM account ID of the service mesh owner. If the account ID is not your // own, then it's the ID of the account that shared the mesh with your account. For diff --git a/service/appmesh/api_op_DeleteVirtualService.go b/service/appmesh/api_op_DeleteVirtualService.go index b8030337d9a..5b19804ed67 100644 --- a/service/appmesh/api_op_DeleteVirtualService.go +++ b/service/appmesh/api_op_DeleteVirtualService.go @@ -57,15 +57,15 @@ func (c *Client) DeleteVirtualService(ctx context.Context, params *DeleteVirtual // type DeleteVirtualServiceInput struct { - // The name of the virtual service to delete. + // The name of the service mesh to delete the virtual service in. // // This member is required. - VirtualServiceName *string + MeshName *string - // The name of the service mesh to delete the virtual service in. + // The name of the virtual service to delete. // // This member is required. - MeshName *string + VirtualServiceName *string // The AWS IAM account ID of the service mesh owner. If the account ID is not your // own, then it's the ID of the account that shared the mesh with your account. For diff --git a/service/appmesh/api_op_DescribeRoute.go b/service/appmesh/api_op_DescribeRoute.go index c1bde2da2e3..dfa5edf7e42 100644 --- a/service/appmesh/api_op_DescribeRoute.go +++ b/service/appmesh/api_op_DescribeRoute.go @@ -57,26 +57,26 @@ func (c *Client) DescribeRoute(ctx context.Context, params *DescribeRouteInput, // type DescribeRouteInput struct { + // The name of the service mesh that the route resides in. + // + // This member is required. + MeshName *string + // The name of the route to describe. // // This member is required. RouteName *string - // The name of the service mesh that the route resides in. + // The name of the virtual router that the route is associated with. // // This member is required. - MeshName *string + VirtualRouterName *string // The AWS IAM account ID of the service mesh owner. If the account ID is not your // own, then it's the ID of the account that shared the mesh with your account. For // more information about mesh sharing, see Working with shared meshes // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). MeshOwner *string - - // The name of the virtual router that the route is associated with. - // - // This member is required. - VirtualRouterName *string } // diff --git a/service/appmesh/api_op_DescribeVirtualGateway.go b/service/appmesh/api_op_DescribeVirtualGateway.go index 571b502d9be..fd627f9eb0d 100644 --- a/service/appmesh/api_op_DescribeVirtualGateway.go +++ b/service/appmesh/api_op_DescribeVirtualGateway.go @@ -56,15 +56,15 @@ func (c *Client) DescribeVirtualGateway(ctx context.Context, params *DescribeVir type DescribeVirtualGatewayInput struct { - // The name of the virtual gateway to describe. + // The name of the service mesh that the gateway route resides in. // // This member is required. - VirtualGatewayName *string + MeshName *string - // The name of the service mesh that the gateway route resides in. + // The name of the virtual gateway to describe. // // This member is required. - MeshName *string + VirtualGatewayName *string // The AWS IAM account ID of the service mesh owner. If the account ID is not your // own, then it's the ID of the account that shared the mesh with your account. For diff --git a/service/appmesh/api_op_DescribeVirtualNode.go b/service/appmesh/api_op_DescribeVirtualNode.go index 7bd2fd6e55d..720d0b1feba 100644 --- a/service/appmesh/api_op_DescribeVirtualNode.go +++ b/service/appmesh/api_op_DescribeVirtualNode.go @@ -57,15 +57,15 @@ func (c *Client) DescribeVirtualNode(ctx context.Context, params *DescribeVirtua // type DescribeVirtualNodeInput struct { - // The name of the virtual node to describe. + // The name of the service mesh that the virtual node resides in. // // This member is required. - VirtualNodeName *string + MeshName *string - // The name of the service mesh that the virtual node resides in. + // The name of the virtual node to describe. // // This member is required. - MeshName *string + VirtualNodeName *string // The AWS IAM account ID of the service mesh owner. If the account ID is not your // own, then it's the ID of the account that shared the mesh with your account. For diff --git a/service/appmesh/api_op_DescribeVirtualRouter.go b/service/appmesh/api_op_DescribeVirtualRouter.go index 4adead71cb8..43039b1f834 100644 --- a/service/appmesh/api_op_DescribeVirtualRouter.go +++ b/service/appmesh/api_op_DescribeVirtualRouter.go @@ -57,15 +57,15 @@ func (c *Client) DescribeVirtualRouter(ctx context.Context, params *DescribeVirt // type DescribeVirtualRouterInput struct { - // The name of the virtual router to describe. + // The name of the service mesh that the virtual router resides in. // // This member is required. - VirtualRouterName *string + MeshName *string - // The name of the service mesh that the virtual router resides in. + // The name of the virtual router to describe. // // This member is required. - MeshName *string + VirtualRouterName *string // The AWS IAM account ID of the service mesh owner. If the account ID is not your // own, then it's the ID of the account that shared the mesh with your account. For diff --git a/service/appmesh/api_op_DescribeVirtualService.go b/service/appmesh/api_op_DescribeVirtualService.go index 41f71fd7876..6bb716277f4 100644 --- a/service/appmesh/api_op_DescribeVirtualService.go +++ b/service/appmesh/api_op_DescribeVirtualService.go @@ -57,15 +57,15 @@ func (c *Client) DescribeVirtualService(ctx context.Context, params *DescribeVir // type DescribeVirtualServiceInput struct { - // The name of the virtual service to describe. + // The name of the service mesh that the virtual service resides in. // // This member is required. - VirtualServiceName *string + MeshName *string - // The name of the service mesh that the virtual service resides in. + // The name of the virtual service to describe. // // This member is required. - MeshName *string + VirtualServiceName *string // The AWS IAM account ID of the service mesh owner. If the account ID is not your // own, then it's the ID of the account that shared the mesh with your account. For diff --git a/service/appmesh/api_op_ListGatewayRoutes.go b/service/appmesh/api_op_ListGatewayRoutes.go index 210588ee480..b664d98781e 100644 --- a/service/appmesh/api_op_ListGatewayRoutes.go +++ b/service/appmesh/api_op_ListGatewayRoutes.go @@ -67,12 +67,6 @@ type ListGatewayRoutesInput struct { // This member is required. VirtualGatewayName *string - // The nextToken value returned from a previous paginated ListGatewayRoutes request - // where limit was used and the results exceeded the value of that parameter. - // Pagination continues from the end of the previous results that returned the - // nextToken value. - NextToken *string - // The maximum number of results returned by ListGatewayRoutes in paginated output. // When you use this parameter, ListGatewayRoutes returns only limit results in a // single page along with a nextToken response element. You can see the remaining @@ -87,6 +81,12 @@ type ListGatewayRoutesInput struct { // more information about mesh sharing, see Working with shared meshes // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). MeshOwner *string + + // The nextToken value returned from a previous paginated ListGatewayRoutes request + // where limit was used and the results exceeded the value of that parameter. + // Pagination continues from the end of the previous results that returned the + // nextToken value. + NextToken *string } type ListGatewayRoutesOutput struct { diff --git a/service/appmesh/api_op_ListMeshes.go b/service/appmesh/api_op_ListMeshes.go index 0b4f96ce373..f7d10a318f8 100644 --- a/service/appmesh/api_op_ListMeshes.go +++ b/service/appmesh/api_op_ListMeshes.go @@ -56,13 +56,6 @@ func (c *Client) ListMeshes(ctx context.Context, params *ListMeshesInput, optFns // type ListMeshesInput struct { - // The nextToken value returned from a previous paginated ListMeshes request where - // limit was used and the results exceeded the value of that parameter. Pagination - // continues from the end of the previous results that returned the nextToken - // value. This token should be treated as an opaque identifier that is used only to - // retrieve the next items in a list and not for other programmatic purposes. - NextToken *string - // The maximum number of results returned by ListMeshes in paginated output. When // you use this parameter, ListMeshes returns only limit results in a single page // along with a nextToken response element. You can see the remaining results of @@ -71,6 +64,13 @@ type ListMeshesInput struct { // parameter, ListMeshes returns up to 100 results and a nextToken value if // applicable. Limit *int32 + + // The nextToken value returned from a previous paginated ListMeshes request where + // limit was used and the results exceeded the value of that parameter. Pagination + // continues from the end of the previous results that returned the nextToken + // value. This token should be treated as an opaque identifier that is used only to + // retrieve the next items in a list and not for other programmatic purposes. + NextToken *string } // diff --git a/service/appmesh/api_op_ListRoutes.go b/service/appmesh/api_op_ListRoutes.go index d1b09b7978a..5139e2bd5ea 100644 --- a/service/appmesh/api_op_ListRoutes.go +++ b/service/appmesh/api_op_ListRoutes.go @@ -67,12 +67,6 @@ type ListRoutesInput struct { // This member is required. VirtualRouterName *string - // The nextToken value returned from a previous paginated ListRoutes request where - // limit was used and the results exceeded the value of that parameter. Pagination - // continues from the end of the previous results that returned the nextToken - // value. - NextToken *string - // The maximum number of results returned by ListRoutes in paginated output. When // you use this parameter, ListRoutes returns only limit results in a single page // along with a nextToken response element. You can see the remaining results of @@ -87,6 +81,12 @@ type ListRoutesInput struct { // more information about mesh sharing, see Working with shared meshes // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). MeshOwner *string + + // The nextToken value returned from a previous paginated ListRoutes request where + // limit was used and the results exceeded the value of that parameter. Pagination + // continues from the end of the previous results that returned the nextToken + // value. + NextToken *string } // diff --git a/service/appmesh/api_op_ListTagsForResource.go b/service/appmesh/api_op_ListTagsForResource.go index 0756a5e3aa4..3b1f5ca1293 100644 --- a/service/appmesh/api_op_ListTagsForResource.go +++ b/service/appmesh/api_op_ListTagsForResource.go @@ -64,12 +64,6 @@ type ListTagsForResourceInput struct { // This member is required. ResourceArn *string - // The nextToken value returned from a previous paginated ListTagsForResource - // request where limit was used and the results exceeded the value of that - // parameter. Pagination continues from the end of the previous results that - // returned the nextToken value. - NextToken *string - // The maximum number of tag results returned by ListTagsForResource in paginated // output. When this parameter is used, ListTagsForResource returns only limit // results in a single page along with a nextToken response element. You can see @@ -78,6 +72,12 @@ type ListTagsForResourceInput struct { // between 1 and 100. If you don't use this parameter, ListTagsForResource returns // up to 100 results and a nextToken value if applicable. Limit *int32 + + // The nextToken value returned from a previous paginated ListTagsForResource + // request where limit was used and the results exceeded the value of that + // parameter. Pagination continues from the end of the previous results that + // returned the nextToken value. + NextToken *string } // diff --git a/service/appmesh/api_op_ListVirtualGateways.go b/service/appmesh/api_op_ListVirtualGateways.go index 7a34db7466e..a3a1afa28bf 100644 --- a/service/appmesh/api_op_ListVirtualGateways.go +++ b/service/appmesh/api_op_ListVirtualGateways.go @@ -61,12 +61,6 @@ type ListVirtualGatewaysInput struct { // This member is required. MeshName *string - // The nextToken value returned from a previous paginated ListVirtualGateways - // request where limit was used and the results exceeded the value of that - // parameter. Pagination continues from the end of the previous results that - // returned the nextToken value. - NextToken *string - // The maximum number of results returned by ListVirtualGateways in paginated // output. When you use this parameter, ListVirtualGateways returns only limit // results in a single page along with a nextToken response element. You can see @@ -81,6 +75,12 @@ type ListVirtualGatewaysInput struct { // more information about mesh sharing, see Working with shared meshes // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). MeshOwner *string + + // The nextToken value returned from a previous paginated ListVirtualGateways + // request where limit was used and the results exceeded the value of that + // parameter. Pagination continues from the end of the previous results that + // returned the nextToken value. + NextToken *string } type ListVirtualGatewaysOutput struct { diff --git a/service/appmesh/api_op_ListVirtualNodes.go b/service/appmesh/api_op_ListVirtualNodes.go index 2be208bc649..48301522297 100644 --- a/service/appmesh/api_op_ListVirtualNodes.go +++ b/service/appmesh/api_op_ListVirtualNodes.go @@ -62,12 +62,6 @@ type ListVirtualNodesInput struct { // This member is required. MeshName *string - // The nextToken value returned from a previous paginated ListVirtualNodes request - // where limit was used and the results exceeded the value of that parameter. - // Pagination continues from the end of the previous results that returned the - // nextToken value. - NextToken *string - // The maximum number of results returned by ListVirtualNodes in paginated output. // When you use this parameter, ListVirtualNodes returns only limit results in a // single page along with a nextToken response element. You can see the remaining @@ -82,6 +76,12 @@ type ListVirtualNodesInput struct { // more information about mesh sharing, see Working with shared meshes // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). MeshOwner *string + + // The nextToken value returned from a previous paginated ListVirtualNodes request + // where limit was used and the results exceeded the value of that parameter. + // Pagination continues from the end of the previous results that returned the + // nextToken value. + NextToken *string } // diff --git a/service/appmesh/api_op_ListVirtualRouters.go b/service/appmesh/api_op_ListVirtualRouters.go index 6d8e665ee50..cd23feaa817 100644 --- a/service/appmesh/api_op_ListVirtualRouters.go +++ b/service/appmesh/api_op_ListVirtualRouters.go @@ -62,12 +62,6 @@ type ListVirtualRoutersInput struct { // This member is required. MeshName *string - // The nextToken value returned from a previous paginated ListVirtualRouters - // request where limit was used and the results exceeded the value of that - // parameter. Pagination continues from the end of the previous results that - // returned the nextToken value. - NextToken *string - // The maximum number of results returned by ListVirtualRouters in paginated // output. When you use this parameter, ListVirtualRouters returns only limit // results in a single page along with a nextToken response element. You can see @@ -82,6 +76,12 @@ type ListVirtualRoutersInput struct { // more information about mesh sharing, see Working with shared meshes // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). MeshOwner *string + + // The nextToken value returned from a previous paginated ListVirtualRouters + // request where limit was used and the results exceeded the value of that + // parameter. Pagination continues from the end of the previous results that + // returned the nextToken value. + NextToken *string } // diff --git a/service/appmesh/api_op_ListVirtualServices.go b/service/appmesh/api_op_ListVirtualServices.go index 5da97ac419b..1f883a45464 100644 --- a/service/appmesh/api_op_ListVirtualServices.go +++ b/service/appmesh/api_op_ListVirtualServices.go @@ -62,12 +62,6 @@ type ListVirtualServicesInput struct { // This member is required. MeshName *string - // The nextToken value returned from a previous paginated ListVirtualServices - // request where limit was used and the results exceeded the value of that - // parameter. Pagination continues from the end of the previous results that - // returned the nextToken value. - NextToken *string - // The maximum number of results returned by ListVirtualServices in paginated // output. When you use this parameter, ListVirtualServices returns only limit // results in a single page along with a nextToken response element. You can see @@ -82,6 +76,12 @@ type ListVirtualServicesInput struct { // more information about mesh sharing, see Working with shared meshes // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). MeshOwner *string + + // The nextToken value returned from a previous paginated ListVirtualServices + // request where limit was used and the results exceeded the value of that + // parameter. Pagination continues from the end of the previous results that + // returned the nextToken value. + NextToken *string } // diff --git a/service/appmesh/api_op_UpdateGatewayRoute.go b/service/appmesh/api_op_UpdateGatewayRoute.go index e19a786dc6d..9e30ae86fba 100644 --- a/service/appmesh/api_op_UpdateGatewayRoute.go +++ b/service/appmesh/api_op_UpdateGatewayRoute.go @@ -67,15 +67,15 @@ type UpdateGatewayRouteInput struct { // This member is required. MeshName *string - // The name of the virtual gateway that the gateway route is associated with. + // The new gateway route specification to apply. This overwrites the existing data. // // This member is required. - VirtualGatewayName *string + Spec *types.GatewayRouteSpec - // The new gateway route specification to apply. This overwrites the existing data. + // The name of the virtual gateway that the gateway route is associated with. // // This member is required. - Spec *types.GatewayRouteSpec + VirtualGatewayName *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. diff --git a/service/appmesh/api_op_UpdateMesh.go b/service/appmesh/api_op_UpdateMesh.go index af510881e0e..a7863ee9b5e 100644 --- a/service/appmesh/api_op_UpdateMesh.go +++ b/service/appmesh/api_op_UpdateMesh.go @@ -62,12 +62,12 @@ type UpdateMeshInput struct { // This member is required. MeshName *string - // The service mesh specification to apply. - Spec *types.MeshSpec - // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. ClientToken *string + + // The service mesh specification to apply. + Spec *types.MeshSpec } // diff --git a/service/appmesh/api_op_UpdateRoute.go b/service/appmesh/api_op_UpdateRoute.go index dedecd4760e..6a2d4a1531f 100644 --- a/service/appmesh/api_op_UpdateRoute.go +++ b/service/appmesh/api_op_UpdateRoute.go @@ -57,26 +57,26 @@ func (c *Client) UpdateRoute(ctx context.Context, params *UpdateRouteInput, optF // type UpdateRouteInput struct { - // The name of the route to update. - // - // This member is required. - RouteName *string - // The name of the service mesh that the route resides in. // // This member is required. MeshName *string - // The name of the virtual router that the route is associated with. + // The name of the route to update. // // This member is required. - VirtualRouterName *string + RouteName *string // The new route specification to apply. This overwrites the existing data. // // This member is required. Spec *types.RouteSpec + // The name of the virtual router that the route is associated with. + // + // This member is required. + VirtualRouterName *string + // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. ClientToken *string diff --git a/service/appmesh/api_op_UpdateVirtualGateway.go b/service/appmesh/api_op_UpdateVirtualGateway.go index 638dc8fec20..89fc43589f3 100644 --- a/service/appmesh/api_op_UpdateVirtualGateway.go +++ b/service/appmesh/api_op_UpdateVirtualGateway.go @@ -56,11 +56,6 @@ func (c *Client) UpdateVirtualGateway(ctx context.Context, params *UpdateVirtual type UpdateVirtualGatewayInput struct { - // The name of the virtual gateway to update. - // - // This member is required. - VirtualGatewayName *string - // The name of the service mesh that the virtual gateway resides in. // // This member is required. @@ -72,6 +67,11 @@ type UpdateVirtualGatewayInput struct { // This member is required. Spec *types.VirtualGatewaySpec + // The name of the virtual gateway to update. + // + // This member is required. + VirtualGatewayName *string + // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. ClientToken *string diff --git a/service/appmesh/api_op_UpdateVirtualNode.go b/service/appmesh/api_op_UpdateVirtualNode.go index 082fbbe12ab..421afb5b87c 100644 --- a/service/appmesh/api_op_UpdateVirtualNode.go +++ b/service/appmesh/api_op_UpdateVirtualNode.go @@ -57,11 +57,6 @@ func (c *Client) UpdateVirtualNode(ctx context.Context, params *UpdateVirtualNod // type UpdateVirtualNodeInput struct { - // The name of the virtual node to update. - // - // This member is required. - VirtualNodeName *string - // The name of the service mesh that the virtual node resides in. // // This member is required. @@ -72,6 +67,11 @@ type UpdateVirtualNodeInput struct { // This member is required. Spec *types.VirtualNodeSpec + // The name of the virtual node to update. + // + // This member is required. + VirtualNodeName *string + // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. ClientToken *string diff --git a/service/appmesh/api_op_UpdateVirtualRouter.go b/service/appmesh/api_op_UpdateVirtualRouter.go index dceb43a734e..6edca3020b0 100644 --- a/service/appmesh/api_op_UpdateVirtualRouter.go +++ b/service/appmesh/api_op_UpdateVirtualRouter.go @@ -57,11 +57,6 @@ func (c *Client) UpdateVirtualRouter(ctx context.Context, params *UpdateVirtualR // type UpdateVirtualRouterInput struct { - // The name of the virtual router to update. - // - // This member is required. - VirtualRouterName *string - // The name of the service mesh that the virtual router resides in. // // This member is required. @@ -73,6 +68,11 @@ type UpdateVirtualRouterInput struct { // This member is required. Spec *types.VirtualRouterSpec + // The name of the virtual router to update. + // + // This member is required. + VirtualRouterName *string + // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. ClientToken *string diff --git a/service/appmesh/api_op_UpdateVirtualService.go b/service/appmesh/api_op_UpdateVirtualService.go index d184f5f0299..baf77750106 100644 --- a/service/appmesh/api_op_UpdateVirtualService.go +++ b/service/appmesh/api_op_UpdateVirtualService.go @@ -57,11 +57,6 @@ func (c *Client) UpdateVirtualService(ctx context.Context, params *UpdateVirtual // type UpdateVirtualServiceInput struct { - // The name of the virtual service to update. - // - // This member is required. - VirtualServiceName *string - // The name of the service mesh that the virtual service resides in. // // This member is required. @@ -73,6 +68,11 @@ type UpdateVirtualServiceInput struct { // This member is required. Spec *types.VirtualServiceSpec + // The name of the virtual service to update. + // + // This member is required. + VirtualServiceName *string + // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. ClientToken *string diff --git a/service/appmesh/go.mod b/service/appmesh/go.mod index 51dffd60a20..6ec903e2c16 100644 --- a/service/appmesh/go.mod +++ b/service/appmesh/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/appmesh go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/appmesh/types/types.go b/service/appmesh/types/types.go index 965ded1bc55..88c0f74b0e3 100644 --- a/service/appmesh/types/types.go +++ b/service/appmesh/types/types.go @@ -87,16 +87,16 @@ type ClientPolicy struct { // An object that represents a Transport Layer Security (TLS) client policy. type ClientPolicyTls struct { + // A reference to an object that represents a TLS validation context. + // + // This member is required. + Validation *TlsValidationContext + // Whether the policy is enforced. The default is True, if a value isn't specified. Enforce *bool // One or more ports that the policy is enforced for. Ports []*int32 - - // A reference to an object that represents a TLS validation context. - // - // This member is required. - Validation *TlsValidationContext } // An object that represents the DNS service discovery information for your virtual @@ -112,11 +112,11 @@ type DnsServiceDiscovery struct { // An object that represents a duration of time. type Duration struct { - // A number of time units. - Value *int64 - // A unit of time. Unit DurationUnit + + // A number of time units. + Value *int64 } // An object that represents the egress filter rules for a service mesh. @@ -150,54 +150,64 @@ type FileAccessLog struct { // An object that represents a gateway route returned by a describe operation. type GatewayRouteData struct { - // The name of the service mesh that the resource resides in. + // The name of the gateway route. // // This member is required. - MeshName *string + GatewayRouteName *string - // The name of the gateway route. + // The name of the service mesh that the resource resides in. // // This member is required. - GatewayRouteName *string + MeshName *string - // The virtual gateway that the gateway route is associated with. + // An object that represents metadata for a resource. // // This member is required. - VirtualGatewayName *string + Metadata *ResourceMetadata // The specifications of the gateway route. // // This member is required. Spec *GatewayRouteSpec - // An object that represents metadata for a resource. + // The status of the gateway route. // // This member is required. - Metadata *ResourceMetadata + Status *GatewayRouteStatus - // The status of the gateway route. + // The virtual gateway that the gateway route is associated with. // // This member is required. - Status *GatewayRouteStatus + VirtualGatewayName *string } // An object that represents a gateway route returned by a list operation. type GatewayRouteRef struct { - // The name of the service mesh that the resource resides in. + // The full Amazon Resource Name (ARN) for the gateway route. // // This member is required. - MeshName *string + Arn *string + + // The Unix epoch timestamp in seconds for when the resource was created. + // + // This member is required. + CreatedAt *time.Time // The name of the gateway route. // // This member is required. GatewayRouteName *string - // The virtual gateway that the gateway route is associated with. + // The Unix epoch timestamp in seconds for when the resource was last updated. // // This member is required. - VirtualGatewayName *string + LastUpdatedAt *time.Time + + // The name of the service mesh that the resource resides in. + // + // This member is required. + MeshName *string // The AWS IAM account ID of the service mesh owner. If the account ID is not your // own, then it's the ID of the account that shared the mesh with your account. For @@ -215,40 +225,30 @@ type GatewayRouteRef struct { // This member is required. ResourceOwner *string - // The full Amazon Resource Name (ARN) for the gateway route. - // - // This member is required. - Arn *string - // The version of the resource. Resources are created at version 1, and this // version is incremented each time that they're updated. // // This member is required. Version *int64 - // The Unix epoch timestamp in seconds for when the resource was created. - // - // This member is required. - CreatedAt *time.Time - - // The Unix epoch timestamp in seconds for when the resource was last updated. + // The virtual gateway that the gateway route is associated with. // // This member is required. - LastUpdatedAt *time.Time + VirtualGatewayName *string } // An object that represents a gateway route specification. Specify one gateway // route type. type GatewayRouteSpec struct { - // An object that represents the specification of an HTTP gateway route. - HttpRoute *HttpGatewayRoute + // An object that represents the specification of a gRPC gateway route. + GrpcRoute *GrpcGatewayRoute // An object that represents the specification of an HTTP/2 gateway route. Http2Route *HttpGatewayRoute - // An object that represents the specification of a gRPC gateway route. - GrpcRoute *GrpcGatewayRoute + // An object that represents the specification of an HTTP gateway route. + HttpRoute *HttpGatewayRoute } // An object that represents the current status of a gateway route. @@ -281,15 +281,15 @@ type GatewayRouteVirtualService struct { // An object that represents a gRPC gateway route. type GrpcGatewayRoute struct { - // An object that represents the criteria for determining a request match. + // An object that represents the action to take if a match is determined. // // This member is required. - Match *GrpcGatewayRouteMatch + Action *GrpcGatewayRouteAction - // An object that represents the action to take if a match is determined. + // An object that represents the criteria for determining a request match. // // This member is required. - Action *GrpcGatewayRouteAction + Match *GrpcGatewayRouteMatch } // An object that represents the action to take if a match is determined. @@ -314,15 +314,18 @@ type GrpcGatewayRouteMatch struct { // perRetryTimeout. type GrpcRetryPolicy struct { - // An object that represents a duration of time. + // The maximum number of retry attempts. // // This member is required. - PerRetryTimeout *Duration + MaxRetries *int64 - // The maximum number of retry attempts. + // An object that represents a duration of time. // // This member is required. - MaxRetries *int64 + PerRetryTimeout *Duration + + // Specify at least one of the valid values. + GrpcRetryEvents []GrpcRetryPolicyEvent // Specify at least one of the following values. // @@ -340,9 +343,6 @@ type GrpcRetryPolicy struct { // Specify a valid value. TcpRetryEvents []TcpRetryPolicyEvent - - // Specify at least one of the valid values. - GrpcRetryEvents []GrpcRetryPolicyEvent } // An object that represents a gRPC route type. @@ -378,15 +378,15 @@ type GrpcRouteAction struct { // An object that represents the criteria for determining a request match. type GrpcRouteMatch struct { - // The fully qualified domain name for the service to match from the request. - ServiceName *string + // An object that represents the data to match from the request. + Metadata []*GrpcRouteMetadata // The method name to match from the request. If you specify a name, you must also // specify a serviceName. MethodName *string - // An object that represents the data to match from the request. - Metadata []*GrpcRouteMetadata + // The fully qualified domain name for the service to match from the request. + ServiceName *string } // An object that represents the match metadata for the route. @@ -448,6 +448,10 @@ func (*GrpcRouteMetadataMatchMethodMemberSuffix) isGrpcRouteMetadataMatchMethod( // An object that represents types of timeouts. type GrpcTimeout struct { + // An object that represents an idle timeout. An idle timeout bounds the amount of + // time that a connection may be idle. The default value is none. + Idle *Duration + // An object that represents a per request timeout. The default value is 15 // seconds. If you set a higher timeout, then make sure that the higher value is // set for each App Mesh resource in a conversation. For example, if a virtual node @@ -455,10 +459,6 @@ type GrpcTimeout struct { // the timeout should be greater than 15 seconds for the source and destination // virtual node and the route. PerRequest *Duration - - // An object that represents an idle timeout. An idle timeout bounds the amount of - // time that a connection may be idle. The default value is none. - Idle *Duration } // An object that represents the method and value to match with the header value @@ -505,11 +505,11 @@ func (*HeaderMatchMethodMemberSuffix) isHeaderMatchMethod() {} // An object that represents the health check policy for a virtual node's listener. type HealthCheckPolicy struct { - // The amount of time to wait when receiving a response from the health check, in - // milliseconds. + // The number of consecutive successful health checks that must occur before + // declaring listener healthy. // // This member is required. - TimeoutMillis *int64 + HealthyThreshold *int32 // The time period in milliseconds between each health check execution. // @@ -523,40 +523,40 @@ type HealthCheckPolicy struct { // This member is required. Protocol PortProtocol - // The destination port for the health check request. This port must match the port - // defined in the PortMapping () for the listener. - Port *int32 - - // The destination path for the health check request. This value is only used if - // the specified protocol is HTTP or HTTP/2. For any other protocol, this value is - // ignored. - Path *string - - // The number of consecutive successful health checks that must occur before - // declaring listener healthy. + // The amount of time to wait when receiving a response from the health check, in + // milliseconds. // // This member is required. - HealthyThreshold *int32 + TimeoutMillis *int64 // The number of consecutive failed health checks that must occur before declaring // a virtual node unhealthy. // // This member is required. UnhealthyThreshold *int32 + + // The destination path for the health check request. This value is only used if + // the specified protocol is HTTP or HTTP/2. For any other protocol, this value is + // ignored. + Path *string + + // The destination port for the health check request. This port must match the port + // defined in the PortMapping () for the listener. + Port *int32 } // An object that represents an HTTP gateway route. type HttpGatewayRoute struct { - // An object that represents the criteria for determining a request match. + // An object that represents the action to take if a match is determined. // // This member is required. - Match *HttpGatewayRouteMatch + Action *HttpGatewayRouteAction - // An object that represents the action to take if a match is determined. + // An object that represents the criteria for determining a request match. // // This member is required. - Action *HttpGatewayRouteAction + Match *HttpGatewayRouteMatch } // An object that represents the action to take if a match is determined. @@ -587,15 +587,15 @@ type HttpGatewayRouteMatch struct { // perRetryTimeout. type HttpRetryPolicy struct { - // An object that represents a duration of time. + // The maximum number of retry attempts. // // This member is required. - PerRetryTimeout *Duration + MaxRetries *int64 - // The maximum number of retry attempts. + // An object that represents a duration of time. // // This member is required. - MaxRetries *int64 + PerRetryTimeout *Duration // Specify at least one of the following values. // @@ -618,15 +618,15 @@ type HttpRetryPolicy struct { // An object that represents an HTTP or HTTP/2 route type. type HttpRoute struct { - // An object that represents the criteria for determining a request match. + // An object that represents the action to take if a match is determined. // // This member is required. - Match *HttpRouteMatch + Action *HttpRouteAction - // An object that represents the action to take if a match is determined. + // An object that represents the criteria for determining a request match. // // This member is required. - Action *HttpRouteAction + Match *HttpRouteMatch // An object that represents a retry policy. RetryPolicy *HttpRetryPolicy @@ -674,24 +674,24 @@ type HttpRouteMatch struct { // This member is required. Prefix *string + // An object that represents the client request headers to match on. + Headers []*HttpRouteHeader + // The client request method to match on. Specify only one. Method HttpMethod // The client request scheme to match on. Specify only one. Scheme HttpScheme - - // An object that represents the client request headers to match on. - Headers []*HttpRouteHeader } // An object that represents types of timeouts. type HttpTimeout struct { // An object that represents a duration of time. - PerRequest *Duration + Idle *Duration // An object that represents a duration of time. - Idle *Duration + PerRequest *Duration } // An object that represents a listener for a virtual node. @@ -702,15 +702,15 @@ type Listener struct { // This member is required. PortMapping *PortMapping - // A reference to an object that represents the Transport Layer Security (TLS) - // properties for a listener. - Tls *ListenerTls - // The health check information for the listener. HealthCheck *HealthCheckPolicy // An object that represents timeouts for different protocols. Timeout ListenerTimeout + + // A reference to an object that represents the Transport Layer Security (TLS) + // properties for a listener. + Tls *ListenerTls } // An object that represents timeouts for different protocols. @@ -750,6 +750,11 @@ func (*ListenerTimeoutMemberGrpc) isListenerTimeout() {} // listener. type ListenerTls struct { + // A reference to an object that represents a listener's TLS certificate. + // + // This member is required. + Certificate ListenerTlsCertificate + // Specify one of the following modes. // // * STRICT – Listener only accepts @@ -763,11 +768,6 @@ type ListenerTls struct { // // This member is required. Mode ListenerTlsMode - - // A reference to an object that represents a listener's TLS certificate. - // - // This member is required. - Certificate ListenerTlsCertificate } // An object that represents an AWS Certicate Manager (ACM) certificate. @@ -833,15 +833,15 @@ type Logging struct { // example, if the range specified were 1-100, only values 1-99 would be matched. type MatchRange struct { - // The start of the range. + // The end of the range. // // This member is required. - Start *int64 + End *int64 - // The end of the range. + // The start of the range. // // This member is required. - End *int64 + Start *int64 } // An object that represents a service mesh returned by a describe operation. @@ -852,15 +852,15 @@ type MeshData struct { // This member is required. MeshName *string - // The associated specification for the service mesh. + // The associated metadata for the service mesh. // // This member is required. - Spec *MeshSpec + Metadata *ResourceMetadata - // The associated metadata for the service mesh. + // The associated specification for the service mesh. // // This member is required. - Metadata *ResourceMetadata + Spec *MeshSpec // The status of the service mesh. // @@ -871,6 +871,21 @@ type MeshData struct { // An object that represents a service mesh returned by a list operation. type MeshRef struct { + // The full Amazon Resource Name (ARN) of the service mesh. + // + // This member is required. + Arn *string + + // The Unix epoch timestamp in seconds for when the resource was created. + // + // This member is required. + CreatedAt *time.Time + + // The Unix epoch timestamp in seconds for when the resource was last updated. + // + // This member is required. + LastUpdatedAt *time.Time + // The name of the service mesh. // // This member is required. @@ -892,26 +907,11 @@ type MeshRef struct { // This member is required. ResourceOwner *string - // The full Amazon Resource Name (ARN) of the service mesh. - // - // This member is required. - Arn *string - // The version of the resource. Resources are created at version 1, and this // version is incremented each time that they're updated. // // This member is required. Version *int64 - - // The Unix epoch timestamp in seconds for when the resource was created. - // - // This member is required. - CreatedAt *time.Time - - // The Unix epoch timestamp in seconds for when the resource was last updated. - // - // This member is required. - LastUpdatedAt *time.Time } // An object that represents the specification of a service mesh. @@ -950,17 +950,6 @@ type ResourceMetadata struct { // This member is required. Arn *string - // The version of the resource. Resources are created at version 1, and this - // version is incremented each time that they're updated. - // - // This member is required. - Version *int64 - - // The unique identifier for the resource. - // - // This member is required. - Uid *string - // The Unix epoch timestamp in seconds for when the resource was created. // // This member is required. @@ -986,20 +975,31 @@ type ResourceMetadata struct { // // This member is required. ResourceOwner *string -} -// An object that represents a route returned by a describe operation. -type RouteData struct { + // The unique identifier for the resource. + // + // This member is required. + Uid *string + + // The version of the resource. Resources are created at version 1, and this + // version is incremented each time that they're updated. + // + // This member is required. + Version *int64 +} + +// An object that represents a route returned by a describe operation. +type RouteData struct { // The name of the service mesh that the route resides in. // // This member is required. MeshName *string - // The virtual router that the route is associated with. + // The associated metadata for the route. // // This member is required. - VirtualRouterName *string + Metadata *ResourceMetadata // The name of the route. // @@ -1011,34 +1011,39 @@ type RouteData struct { // This member is required. Spec *RouteSpec - // The associated metadata for the route. + // The status of the route. // // This member is required. - Metadata *ResourceMetadata + Status *RouteStatus - // The status of the route. + // The virtual router that the route is associated with. // // This member is required. - Status *RouteStatus + VirtualRouterName *string } // An object that represents a route returned by a list operation. type RouteRef struct { - // The name of the service mesh that the route resides in. + // The full Amazon Resource Name (ARN) for the route. // // This member is required. - MeshName *string + Arn *string - // The virtual router that the route is associated with. + // The Unix epoch timestamp in seconds for when the resource was created. // // This member is required. - VirtualRouterName *string + CreatedAt *time.Time - // The name of the route. + // The Unix epoch timestamp in seconds for when the resource was last updated. // // This member is required. - RouteName *string + LastUpdatedAt *time.Time + + // The name of the service mesh that the route resides in. + // + // This member is required. + MeshName *string // The AWS IAM account ID of the service mesh owner. If the account ID is not your // own, then it's the ID of the account that shared the mesh with your account. For @@ -1056,10 +1061,10 @@ type RouteRef struct { // This member is required. ResourceOwner *string - // The full Amazon Resource Name (ARN) for the route. + // The name of the route. // // This member is required. - Arn *string + RouteName *string // The version of the resource. Resources are created at version 1, and this // version is incremented each time that they're updated. @@ -1067,35 +1072,30 @@ type RouteRef struct { // This member is required. Version *int64 - // The Unix epoch timestamp in seconds for when the resource was created. - // - // This member is required. - CreatedAt *time.Time - - // The Unix epoch timestamp in seconds for when the resource was last updated. + // The virtual router that the route is associated with. // // This member is required. - LastUpdatedAt *time.Time + VirtualRouterName *string } // An object that represents a route specification. Specify one route type. type RouteSpec struct { - // The priority for the route. Routes are matched based on the specified value, - // where 0 is the highest priority. - Priority *int32 + // An object that represents the specification of a gRPC route. + GrpcRoute *GrpcRoute + + // An object that represents the specification of an HTTP/2 route. + Http2Route *HttpRoute // An object that represents the specification of an HTTP route. HttpRoute *HttpRoute + // The priority for the route. Routes are matched based on the specified value, + // where 0 is the highest priority. + Priority *int32 + // An object that represents the specification of a TCP route. TcpRoute *TcpRoute - - // An object that represents the specification of an HTTP/2 route. - Http2Route *HttpRoute - - // An object that represents the specification of a gRPC route. - GrpcRoute *GrpcRoute } // An object that represents the current status of a route. @@ -1253,16 +1253,16 @@ type VirtualGatewayClientPolicy struct { // An object that represents a Transport Layer Security (TLS) client policy. type VirtualGatewayClientPolicyTls struct { + // A reference to an object that represents a TLS validation context. + // + // This member is required. + Validation *VirtualGatewayTlsValidationContext + // Whether the policy is enforced. The default is True, if a value isn't specified. Enforce *bool // One or more ports that the policy is enforced for. Ports []*int32 - - // A reference to an object that represents a TLS validation context. - // - // This member is required. - Validation *VirtualGatewayTlsValidationContext } // An object that represents a virtual gateway returned by a describe operation. @@ -1273,25 +1273,25 @@ type VirtualGatewayData struct { // This member is required. MeshName *string - // The name of the virtual gateway. + // An object that represents metadata for a resource. // // This member is required. - VirtualGatewayName *string + Metadata *ResourceMetadata // The specifications of the virtual gateway. // // This member is required. Spec *VirtualGatewaySpec - // An object that represents metadata for a resource. + // The current status of the virtual gateway. // // This member is required. - Metadata *ResourceMetadata + Status *VirtualGatewayStatus - // The current status of the virtual gateway. + // The name of the virtual gateway. // // This member is required. - Status *VirtualGatewayStatus + VirtualGatewayName *string } // An object that represents an access log file. @@ -1311,11 +1311,11 @@ type VirtualGatewayFileAccessLog struct { // listener. type VirtualGatewayHealthCheckPolicy struct { - // The amount of time to wait when receiving a response from the health check, in - // milliseconds. + // The number of consecutive successful health checks that must occur before + // declaring the listener healthy. // // This member is required. - TimeoutMillis *int64 + HealthyThreshold *int32 // The time period in milliseconds between each health check execution. // @@ -1329,39 +1329,39 @@ type VirtualGatewayHealthCheckPolicy struct { // This member is required. Protocol VirtualGatewayPortProtocol - // The destination port for the health check request. This port must match the port - // defined in the PortMapping () for the listener. - Port *int32 - - // The destination path for the health check request. This value is only used if - // the specified protocol is HTTP or HTTP/2. For any other protocol, this value is - // ignored. - Path *string - - // The number of consecutive successful health checks that must occur before - // declaring the listener healthy. + // The amount of time to wait when receiving a response from the health check, in + // milliseconds. // // This member is required. - HealthyThreshold *int32 + TimeoutMillis *int64 // The number of consecutive failed health checks that must occur before declaring // a virtual gateway unhealthy. // // This member is required. UnhealthyThreshold *int32 + + // The destination path for the health check request. This value is only used if + // the specified protocol is HTTP or HTTP/2. For any other protocol, this value is + // ignored. + Path *string + + // The destination port for the health check request. This port must match the port + // defined in the PortMapping () for the listener. + Port *int32 } // An object that represents a listener for a virtual gateway. type VirtualGatewayListener struct { - // The health check information for the listener. - HealthCheck *VirtualGatewayHealthCheckPolicy - // The port mapping information for the listener. // // This member is required. PortMapping *VirtualGatewayPortMapping + // The health check information for the listener. + HealthCheck *VirtualGatewayHealthCheckPolicy + // A reference to an object that represents the Transport Layer Security (TLS) // properties for the listener. Tls *VirtualGatewayListenerTls @@ -1371,6 +1371,11 @@ type VirtualGatewayListener struct { // listener. type VirtualGatewayListenerTls struct { + // An object that represents a Transport Layer Security (TLS) certificate. + // + // This member is required. + Certificate VirtualGatewayListenerTlsCertificate + // Specify one of the following modes. // // * STRICT – Listener only accepts @@ -1384,11 +1389,6 @@ type VirtualGatewayListenerTls struct { // // This member is required. Mode VirtualGatewayListenerTlsMode - - // An object that represents a Transport Layer Security (TLS) certificate. - // - // This member is required. - Certificate VirtualGatewayListenerTlsCertificate } // An object that represents an AWS Certicate Manager (ACM) certificate. @@ -1466,15 +1466,25 @@ type VirtualGatewayPortMapping struct { // An object that represents a virtual gateway returned by a list operation. type VirtualGatewayRef struct { - // The name of the service mesh that the resource resides in. + // The full Amazon Resource Name (ARN) for the resource. // // This member is required. - MeshName *string + Arn *string - // The name of the resource. + // The Unix epoch timestamp in seconds for when the resource was created. // // This member is required. - VirtualGatewayName *string + CreatedAt *time.Time + + // The Unix epoch timestamp in seconds for when the resource was last updated. + // + // This member is required. + LastUpdatedAt *time.Time + + // The name of the service mesh that the resource resides in. + // + // This member is required. + MeshName *string // The AWS IAM account ID of the service mesh owner. If the account ID is not your // own, then it's the ID of the account that shared the mesh with your account. For @@ -1492,40 +1502,30 @@ type VirtualGatewayRef struct { // This member is required. ResourceOwner *string - // The full Amazon Resource Name (ARN) for the resource. - // - // This member is required. - Arn *string - // The version of the resource. Resources are created at version 1, and this // version is incremented each time that they're updated. // // This member is required. Version *int64 - // The Unix epoch timestamp in seconds for when the resource was created. - // - // This member is required. - CreatedAt *time.Time - - // The Unix epoch timestamp in seconds for when the resource was last updated. + // The name of the resource. // // This member is required. - LastUpdatedAt *time.Time + VirtualGatewayName *string } // An object that represents the specification of a service mesh resource. type VirtualGatewaySpec struct { - // A reference to an object that represents the defaults for backends. - BackendDefaults *VirtualGatewayBackendDefaults - // The listeners that the mesh endpoint is expected to receive inbound traffic // from. You can specify one listener. // // This member is required. Listeners []*VirtualGatewayListener + // A reference to an object that represents the defaults for backends. + BackendDefaults *VirtualGatewayBackendDefaults + // An object that represents logging information. Logging *VirtualGatewayLogging } @@ -1600,39 +1600,49 @@ type VirtualNodeData struct { // This member is required. MeshName *string - // The name of the virtual node. + // The associated metadata for the virtual node. // // This member is required. - VirtualNodeName *string + Metadata *ResourceMetadata // The specifications of the virtual node. // // This member is required. Spec *VirtualNodeSpec - // The associated metadata for the virtual node. + // The current status for the virtual node. // // This member is required. - Metadata *ResourceMetadata + Status *VirtualNodeStatus - // The current status for the virtual node. + // The name of the virtual node. // // This member is required. - Status *VirtualNodeStatus + VirtualNodeName *string } // An object that represents a virtual node returned by a list operation. type VirtualNodeRef struct { - // The name of the service mesh that the virtual node resides in. + // The full Amazon Resource Name (ARN) for the virtual node. // // This member is required. - MeshName *string + Arn *string - // The name of the virtual node. + // The Unix epoch timestamp in seconds for when the resource was created. // // This member is required. - VirtualNodeName *string + CreatedAt *time.Time + + // The Unix epoch timestamp in seconds for when the resource was last updated. + // + // This member is required. + LastUpdatedAt *time.Time + + // The name of the service mesh that the virtual node resides in. + // + // This member is required. + MeshName *string // The AWS IAM account ID of the service mesh owner. If the account ID is not your // own, then it's the ID of the account that shared the mesh with your account. For @@ -1650,26 +1660,16 @@ type VirtualNodeRef struct { // This member is required. ResourceOwner *string - // The full Amazon Resource Name (ARN) for the virtual node. - // - // This member is required. - Arn *string - // The version of the resource. Resources are created at version 1, and this // version is incremented each time that they're updated. // // This member is required. Version *int64 - // The Unix epoch timestamp in seconds for when the resource was created. - // - // This member is required. - CreatedAt *time.Time - - // The Unix epoch timestamp in seconds for when the resource was last updated. + // The name of the virtual node. // // This member is required. - LastUpdatedAt *time.Time + VirtualNodeName *string } // An object that represents a virtual node service provider. @@ -1684,23 +1684,23 @@ type VirtualNodeServiceProvider struct { // An object that represents the specification of a virtual node. type VirtualNodeSpec struct { - // The service discovery information for the virtual node. If your virtual node - // does not expect ingress traffic, you can omit this parameter. If you specify a - // listener, then you must specify service discovery information. - ServiceDiscovery ServiceDiscovery - - // The listener that the virtual node is expected to receive inbound traffic from. - // You can specify one listener. - Listeners []*Listener + // A reference to an object that represents the defaults for backends. + BackendDefaults *BackendDefaults // The backends that the virtual node is expected to send outbound traffic to. Backends []Backend - // A reference to an object that represents the defaults for backends. - BackendDefaults *BackendDefaults + // The listener that the virtual node is expected to receive inbound traffic from. + // You can specify one listener. + Listeners []*Listener // The inbound and outbound access logging information for the virtual node. Logging *Logging + + // The service discovery information for the virtual node. If your virtual node + // does not expect ingress traffic, you can omit this parameter. If you specify a + // listener, then you must specify service discovery information. + ServiceDiscovery ServiceDiscovery } // An object that represents the current status of the virtual node. @@ -1720,25 +1720,25 @@ type VirtualRouterData struct { // This member is required. MeshName *string - // The name of the virtual router. + // The associated metadata for the virtual router. // // This member is required. - VirtualRouterName *string + Metadata *ResourceMetadata // The specifications of the virtual router. // // This member is required. Spec *VirtualRouterSpec - // The associated metadata for the virtual router. + // The current status of the virtual router. // // This member is required. - Metadata *ResourceMetadata + Status *VirtualRouterStatus - // The current status of the virtual router. + // The name of the virtual router. // // This member is required. - Status *VirtualRouterStatus + VirtualRouterName *string } // An object that represents a virtual router listener. @@ -1753,15 +1753,25 @@ type VirtualRouterListener struct { // An object that represents a virtual router returned by a list operation. type VirtualRouterRef struct { - // The name of the service mesh that the virtual router resides in. + // The full Amazon Resource Name (ARN) for the virtual router. // // This member is required. - MeshName *string + Arn *string - // The name of the virtual router. + // The Unix epoch timestamp in seconds for when the resource was created. // // This member is required. - VirtualRouterName *string + CreatedAt *time.Time + + // The Unix epoch timestamp in seconds for when the resource was last updated. + // + // This member is required. + LastUpdatedAt *time.Time + + // The name of the service mesh that the virtual router resides in. + // + // This member is required. + MeshName *string // The AWS IAM account ID of the service mesh owner. If the account ID is not your // own, then it's the ID of the account that shared the mesh with your account. For @@ -1779,26 +1789,16 @@ type VirtualRouterRef struct { // This member is required. ResourceOwner *string - // The full Amazon Resource Name (ARN) for the virtual router. - // - // This member is required. - Arn *string - // The version of the resource. Resources are created at version 1, and this // version is incremented each time that they're updated. // // This member is required. Version *int64 - // The Unix epoch timestamp in seconds for when the resource was created. - // - // This member is required. - CreatedAt *time.Time - - // The Unix epoch timestamp in seconds for when the resource was last updated. + // The name of the virtual router. // // This member is required. - LastUpdatedAt *time.Time + VirtualRouterName *string } // An object that represents a virtual node service provider. @@ -1847,25 +1847,25 @@ type VirtualServiceData struct { // This member is required. MeshName *string - // The name of the virtual service. + // An object that represents metadata for a resource. // // This member is required. - VirtualServiceName *string + Metadata *ResourceMetadata // The specifications of the virtual service. // // This member is required. Spec *VirtualServiceSpec - // An object that represents metadata for a resource. + // The current status of the virtual service. // // This member is required. - Metadata *ResourceMetadata + Status *VirtualServiceStatus - // The current status of the virtual service. + // The name of the virtual service. // // This member is required. - Status *VirtualServiceStatus + VirtualServiceName *string } // An object that represents the provider for a virtual service. @@ -1890,15 +1890,25 @@ func (*VirtualServiceProviderMemberVirtualRouter) isVirtualServiceProvider() {} // An object that represents a virtual service returned by a list operation. type VirtualServiceRef struct { - // The name of the service mesh that the virtual service resides in. + // The full Amazon Resource Name (ARN) for the virtual service. // // This member is required. - MeshName *string + Arn *string - // The name of the virtual service. + // The Unix epoch timestamp in seconds for when the resource was created. // // This member is required. - VirtualServiceName *string + CreatedAt *time.Time + + // The Unix epoch timestamp in seconds for when the resource was last updated. + // + // This member is required. + LastUpdatedAt *time.Time + + // The name of the service mesh that the virtual service resides in. + // + // This member is required. + MeshName *string // The AWS IAM account ID of the service mesh owner. If the account ID is not your // own, then it's the ID of the account that shared the mesh with your account. For @@ -1916,26 +1926,16 @@ type VirtualServiceRef struct { // This member is required. ResourceOwner *string - // The full Amazon Resource Name (ARN) for the virtual service. - // - // This member is required. - Arn *string - // The version of the resource. Resources are created at version 1, and this // version is incremented each time that they're updated. // // This member is required. Version *int64 - // The Unix epoch timestamp in seconds for when the resource was created. - // - // This member is required. - CreatedAt *time.Time - - // The Unix epoch timestamp in seconds for when the resource was last updated. + // The name of the virtual service. // // This member is required. - LastUpdatedAt *time.Time + VirtualServiceName *string } // An object that represents the specification of a virtual service. diff --git a/service/appstream/api_op_AssociateFleet.go b/service/appstream/api_op_AssociateFleet.go index abd3724a7bb..1443b39129e 100644 --- a/service/appstream/api_op_AssociateFleet.go +++ b/service/appstream/api_op_AssociateFleet.go @@ -56,15 +56,15 @@ func (c *Client) AssociateFleet(ctx context.Context, params *AssociateFleetInput type AssociateFleetInput struct { - // The name of the stack. + // The name of the fleet. // // This member is required. - StackName *string + FleetName *string - // The name of the fleet. + // The name of the stack. // // This member is required. - FleetName *string + StackName *string } type AssociateFleetOutput struct { diff --git a/service/appstream/api_op_CopyImage.go b/service/appstream/api_op_CopyImage.go index 95c10b84897..13e4c81e09d 100644 --- a/service/appstream/api_op_CopyImage.go +++ b/service/appstream/api_op_CopyImage.go @@ -57,14 +57,6 @@ func (c *Client) CopyImage(ctx context.Context, params *CopyImageInput, optFns . type CopyImageInput struct { - // The name of the image to copy. - // - // This member is required. - SourceImageName *string - - // The description that the image will have when it is copied to the destination. - DestinationImageDescription *string - // The name that the image will have when it is copied to the destination. // // This member is required. @@ -75,6 +67,14 @@ type CopyImageInput struct { // // This member is required. DestinationRegion *string + + // The name of the image to copy. + // + // This member is required. + SourceImageName *string + + // The description that the image will have when it is copied to the destination. + DestinationImageDescription *string } type CopyImageOutput struct { diff --git a/service/appstream/api_op_CreateFleet.go b/service/appstream/api_op_CreateFleet.go index 38fad7c830e..9bdfe410a93 100644 --- a/service/appstream/api_op_CreateFleet.go +++ b/service/appstream/api_op_CreateFleet.go @@ -58,90 +58,11 @@ func (c *Client) CreateFleet(ctx context.Context, params *CreateFleetInput, optF type CreateFleetInput struct { - // Enables or disables default internet access for the fleet. - EnableDefaultInternetAccess *bool - - // The description to display. - Description *string - // The desired capacity for the fleet. // // This member is required. ComputeCapacity *types.ComputeCapacity - // The VPC configuration for the fleet. - VpcConfig *types.VpcConfig - - // The fleet type. ALWAYS_ON Provides users with instant-on access to their apps. - // You are charged for all running instances in your fleet, even if no users are - // streaming apps. ON_DEMAND Provide users with access to applications after they - // connect, which takes one to two minutes. You are charged for instance streaming - // when users are connected and a small hourly fee for instances that are not - // streaming apps. - FleetType types.FleetType - - // The amount of time that a streaming session remains active after users - // disconnect. If users try to reconnect to the streaming session after a - // disconnection or network interruption within this time interval, they are - // connected to their previous session. Otherwise, they are connected to a new - // session with a new streaming instance. Specify a value between 60 and 360000. - DisconnectTimeoutInSeconds *int32 - - // A unique name for the fleet. - // - // This member is required. - Name *string - - // The name of the directory and organizational unit (OU) to use to join the fleet - // to a Microsoft Active Directory domain. - DomainJoinInfo *types.DomainJoinInfo - - // The name of the image used to create the fleet. - ImageName *string - - // The maximum amount of time that a streaming session can remain active, in - // seconds. If users are still connected to a streaming instance five minutes - // before this limit is reached, they are prompted to save any open documents - // before being disconnected. After this time elapses, the instance is terminated - // and replaced by a new instance. Specify a value between 600 and 360000. - MaxUserDurationInSeconds *int32 - - // The amount of time that users can be idle (inactive) before they are - // disconnected from their streaming session and the DisconnectTimeoutInSeconds - // time interval begins. Users are notified before they are disconnected due to - // inactivity. If they try to reconnect to the streaming session before the time - // interval specified in DisconnectTimeoutInSeconds elapses, they are connected to - // their previous session. Users are considered idle when they stop providing - // keyboard or mouse input during their streaming session. File uploads and - // downloads, audio in, audio out, and pixels changing do not qualify as user - // activity. If users continue to be idle after the time interval in - // IdleDisconnectTimeoutInSeconds elapses, they are disconnected. To prevent users - // from being disconnected due to inactivity, specify a value of 0. Otherwise, - // specify a value between 60 and 3600. The default value is 0. If you enable this - // feature, we recommend that you specify a value that corresponds exactly to a - // whole number of minutes (for example, 60, 120, and 180). If you don't do this, - // the value is rounded to the nearest minute. For example, if you specify a value - // of 70, users are disconnected after 1 minute of inactivity. If you specify a - // value that is at the midpoint between two different minutes, the value is - // rounded up. For example, if you specify a value of 90, users are disconnected - // after 2 minutes of inactivity. - IdleDisconnectTimeoutInSeconds *int32 - - // The fleet name to display. - DisplayName *string - - // The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume - // a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole - // API operation and passes the ARN of the role to use. The operation creates a new - // session with temporary credentials. AppStream 2.0 retrieves the temporary - // credentials and creates the AppStream_Machine_Role credential profile on the - // instance.

For more information, see Using - // an IAM Role to Grant Permissions to Applications and Scripts Running on - // AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 - // Administration Guide.

- IamRoleArn *string - // The instance type to use when launching fleet instances. The following instance // types are available: // @@ -197,9 +118,85 @@ type CreateFleetInput struct { // This member is required. InstanceType *string + // A unique name for the fleet. + // + // This member is required. + Name *string + + // The description to display. + Description *string + + // The amount of time that a streaming session remains active after users + // disconnect. If users try to reconnect to the streaming session after a + // disconnection or network interruption within this time interval, they are + // connected to their previous session. Otherwise, they are connected to a new + // session with a new streaming instance. Specify a value between 60 and 360000. + DisconnectTimeoutInSeconds *int32 + + // The fleet name to display. + DisplayName *string + + // The name of the directory and organizational unit (OU) to use to join the fleet + // to a Microsoft Active Directory domain. + DomainJoinInfo *types.DomainJoinInfo + + // Enables or disables default internet access for the fleet. + EnableDefaultInternetAccess *bool + + // The fleet type. ALWAYS_ON Provides users with instant-on access to their apps. + // You are charged for all running instances in your fleet, even if no users are + // streaming apps. ON_DEMAND Provide users with access to applications after they + // connect, which takes one to two minutes. You are charged for instance streaming + // when users are connected and a small hourly fee for instances that are not + // streaming apps. + FleetType types.FleetType + + // The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume + // a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole + // API operation and passes the ARN of the role to use. The operation creates a new + // session with temporary credentials. AppStream 2.0 retrieves the temporary + // credentials and creates the AppStream_Machine_Role credential profile on the + // instance.

For more information, see Using + // an IAM Role to Grant Permissions to Applications and Scripts Running on + // AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 + // Administration Guide.

+ IamRoleArn *string + + // The amount of time that users can be idle (inactive) before they are + // disconnected from their streaming session and the DisconnectTimeoutInSeconds + // time interval begins. Users are notified before they are disconnected due to + // inactivity. If they try to reconnect to the streaming session before the time + // interval specified in DisconnectTimeoutInSeconds elapses, they are connected to + // their previous session. Users are considered idle when they stop providing + // keyboard or mouse input during their streaming session. File uploads and + // downloads, audio in, audio out, and pixels changing do not qualify as user + // activity. If users continue to be idle after the time interval in + // IdleDisconnectTimeoutInSeconds elapses, they are disconnected. To prevent users + // from being disconnected due to inactivity, specify a value of 0. Otherwise, + // specify a value between 60 and 3600. The default value is 0. If you enable this + // feature, we recommend that you specify a value that corresponds exactly to a + // whole number of minutes (for example, 60, 120, and 180). If you don't do this, + // the value is rounded to the nearest minute. For example, if you specify a value + // of 70, users are disconnected after 1 minute of inactivity. If you specify a + // value that is at the midpoint between two different minutes, the value is + // rounded up. For example, if you specify a value of 90, users are disconnected + // after 2 minutes of inactivity. + IdleDisconnectTimeoutInSeconds *int32 + // The ARN of the public, private, or shared image to use. ImageArn *string + // The name of the image used to create the fleet. + ImageName *string + + // The maximum amount of time that a streaming session can remain active, in + // seconds. If users are still connected to a streaming instance five minutes + // before this limit is reached, they are prompted to save any open documents + // before being disconnected. After this time elapses, the instance is terminated + // and replaced by a new instance. Specify a value between 600 and 360000. + MaxUserDurationInSeconds *int32 + // The tags to associate with the fleet. A tag is a key-value pair, and the value // is optional. For example, Environment=Test. If you do not specify a value, // Environment=.

If you do not specify a value, the value is set to an empty @@ -209,6 +206,9 @@ type CreateFleetInput struct { // href="https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html">Tagging // Your Resources in the Amazon AppStream 2.0 Administration Guide.

Tags map[string]*string + + // The VPC configuration for the fleet. + VpcConfig *types.VpcConfig } type CreateFleetOutput struct { diff --git a/service/appstream/api_op_CreateImageBuilder.go b/service/appstream/api_op_CreateImageBuilder.go index 265f2c054fc..351f4f03e78 100644 --- a/service/appstream/api_op_CreateImageBuilder.go +++ b/service/appstream/api_op_CreateImageBuilder.go @@ -59,9 +59,6 @@ func (c *Client) CreateImageBuilder(ctx context.Context, params *CreateImageBuil type CreateImageBuilderInput struct { - // Enables or disables default internet access for the image builder. - EnableDefaultInternetAccess *bool - // The instance type to use when launching the image builder. The following // instance types are available: // @@ -117,8 +114,31 @@ type CreateImageBuilderInput struct { // This member is required. InstanceType *string - // The VPC configuration for the image builder. You can specify only one subnet. - VpcConfig *types.VpcConfig + // A unique name for the image builder. + // + // This member is required. + Name *string + + // The list of interface VPC endpoint (interface endpoint) objects. Administrators + // can connect to the image builder only through the specified endpoints. + AccessEndpoints []*types.AccessEndpoint + + // The version of the AppStream 2.0 agent to use for this image builder. To use the + // latest version of the AppStream 2.0 agent, specify [LATEST]. + AppstreamAgentVersion *string + + // The description to display. + Description *string + + // The image builder name to display. + DisplayName *string + + // The name of the directory and organizational unit (OU) to use to join the image + // builder to a Microsoft Active Directory domain. + DomainJoinInfo *types.DomainJoinInfo + + // Enables or disables default internet access for the image builder. + EnableDefaultInternetAccess *bool // The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To // assume a role, the image builder calls the AWS Security Token Service (STS) @@ -132,11 +152,11 @@ type CreateImageBuilderInput struct { // Administration Guide.

IamRoleArn *string - // The description to display. - Description *string + // The ARN of the public, private, or shared image to use. + ImageArn *string - // The image builder name to display. - DisplayName *string + // The name of the image used to create the image builder. + ImageName *string // The tags to associate with the image builder. A tag is a key-value pair, and the // value is optional. For example, Environment=Test. If you do not specify a value, @@ -148,28 +168,8 @@ type CreateImageBuilderInput struct { // Your Resources in the Amazon AppStream 2.0 Administration Guide.

Tags map[string]*string - // The name of the image used to create the image builder. - ImageName *string - - // The list of interface VPC endpoint (interface endpoint) objects. Administrators - // can connect to the image builder only through the specified endpoints. - AccessEndpoints []*types.AccessEndpoint - - // The ARN of the public, private, or shared image to use. - ImageArn *string - - // The version of the AppStream 2.0 agent to use for this image builder. To use the - // latest version of the AppStream 2.0 agent, specify [LATEST]. - AppstreamAgentVersion *string - - // The name of the directory and organizational unit (OU) to use to join the image - // builder to a Microsoft Active Directory domain. - DomainJoinInfo *types.DomainJoinInfo - - // A unique name for the image builder. - // - // This member is required. - Name *string + // The VPC configuration for the image builder. You can specify only one subnet. + VpcConfig *types.VpcConfig } type CreateImageBuilderOutput struct { diff --git a/service/appstream/api_op_CreateImageBuilderStreamingURL.go b/service/appstream/api_op_CreateImageBuilderStreamingURL.go index c2ecefced6f..9c38272e48e 100644 --- a/service/appstream/api_op_CreateImageBuilderStreamingURL.go +++ b/service/appstream/api_op_CreateImageBuilderStreamingURL.go @@ -69,12 +69,12 @@ type CreateImageBuilderStreamingURLInput struct { type CreateImageBuilderStreamingURLOutput struct { - // The URL to start the AppStream 2.0 streaming session. - StreamingURL *string - // The elapsed time, in seconds after the Unix epoch, when this URL expires. Expires *time.Time + // The URL to start the AppStream 2.0 streaming session. + StreamingURL *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/appstream/api_op_CreateStack.go b/service/appstream/api_op_CreateStack.go index 1e38139d2b0..be4965d94c6 100644 --- a/service/appstream/api_op_CreateStack.go +++ b/service/appstream/api_op_CreateStack.go @@ -58,42 +58,41 @@ func (c *Client) CreateStack(ctx context.Context, params *CreateStackInput, optF type CreateStackInput struct { - // The URL that users are redirected to after their streaming session ends. - RedirectURL *string - - // The actions that are enabled or disabled for users during their streaming - // sessions. By default, these actions are enabled. - UserSettings []*types.UserSetting - - // The stack name to display. - DisplayName *string + // The name of the stack. + // + // This member is required. + Name *string // The list of interface VPC endpoint (interface endpoint) objects. Users of the // stack can connect to AppStream 2.0 only through the specified endpoints. AccessEndpoints []*types.AccessEndpoint + // The persistent application settings for users of a stack. When these settings + // are enabled, changes that users make to applications and Windows settings are + // automatically saved after each session and applied to the next session. + ApplicationSettings *types.ApplicationSettings + + // The description to display. + Description *string + + // The stack name to display. + DisplayName *string + // The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. // You must approve the domains that you want to host embedded AppStream 2.0 // streaming sessions. EmbedHostDomains []*string - // The name of the stack. - // - // This member is required. - Name *string - // The URL that users are redirected to after they click the Send Feedback link. If // no URL is specified, no Send Feedback link is displayed. FeedbackURL *string + // The URL that users are redirected to after their streaming session ends. + RedirectURL *string + // The storage connectors to enable. StorageConnectors []*types.StorageConnector - // The persistent application settings for users of a stack. When these settings - // are enabled, changes that users make to applications and Windows settings are - // automatically saved after each session and applied to the next session. - ApplicationSettings *types.ApplicationSettings - // The tags to associate with the stack. A tag is a key-value pair, and the value // is optional. For example, Environment=Test. If you do not specify a value, // Environment=.

If you do not specify a value, the value is set to an empty @@ -104,8 +103,9 @@ type CreateStackInput struct { // Your Resources in the Amazon AppStream 2.0 Administration Guide.

Tags map[string]*string - // The description to display. - Description *string + // The actions that are enabled or disabled for users during their streaming + // sessions. By default, these actions are enabled. + UserSettings []*types.UserSetting } type CreateStackOutput struct { diff --git a/service/appstream/api_op_CreateStreamingURL.go b/service/appstream/api_op_CreateStreamingURL.go index 97125ec04b2..fcff3106562 100644 --- a/service/appstream/api_op_CreateStreamingURL.go +++ b/service/appstream/api_op_CreateStreamingURL.go @@ -64,14 +64,10 @@ type CreateStreamingURLInput struct { // This member is required. FleetName *string - // The time that the streaming URL will be valid, in seconds. Specify a value - // between 1 and 604800 seconds. The default is 60 seconds. - Validity *int64 - - // The session context. For more information, see Session Context - // (https://docs.aws.amazon.com/appstream2/latest/developerguide/managing-stacks-fleets.html#managing-stacks-fleets-parameters) - // in the Amazon AppStream 2.0 Administration Guide. - SessionContext *string + // The name of the stack. + // + // This member is required. + StackName *string // The identifier of the user. // @@ -82,20 +78,24 @@ type CreateStreamingURLInput struct { // that you specified as Name in the Image Assistant. ApplicationId *string - // The name of the stack. - // - // This member is required. - StackName *string + // The session context. For more information, see Session Context + // (https://docs.aws.amazon.com/appstream2/latest/developerguide/managing-stacks-fleets.html#managing-stacks-fleets-parameters) + // in the Amazon AppStream 2.0 Administration Guide. + SessionContext *string + + // The time that the streaming URL will be valid, in seconds. Specify a value + // between 1 and 604800 seconds. The default is 60 seconds. + Validity *int64 } type CreateStreamingURLOutput struct { - // The URL to start the AppStream 2.0 streaming session. - StreamingURL *string - // The elapsed time, in seconds after the Unix epoch, when this URL expires. Expires *time.Time + // The URL to start the AppStream 2.0 streaming session. + StreamingURL *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/appstream/api_op_CreateUsageReportSubscription.go b/service/appstream/api_op_CreateUsageReportSubscription.go index da2da50c556..3ca74f59a77 100644 --- a/service/appstream/api_op_CreateUsageReportSubscription.go +++ b/service/appstream/api_op_CreateUsageReportSubscription.go @@ -59,9 +59,6 @@ type CreateUsageReportSubscriptionInput struct { type CreateUsageReportSubscriptionOutput struct { - // The schedule for generating usage reports. - Schedule types.UsageReportSchedule - // The Amazon S3 bucket where generated reports are stored.

If you enabled // on-instance session scripts and Amazon S3 logging for your session script // configuration, AppStream 2.0 created an S3 bucket to store the script output. @@ -71,6 +68,9 @@ type CreateUsageReportSubscriptionOutput struct { // reports, AppStream 2.0 creates a new S3 bucket.

S3BucketName *string + // The schedule for generating usage reports. + Schedule types.UsageReportSchedule + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/appstream/api_op_CreateUser.go b/service/appstream/api_op_CreateUser.go index 96592ad2e5a..176da4ccecc 100644 --- a/service/appstream/api_op_CreateUser.go +++ b/service/appstream/api_op_CreateUser.go @@ -57,8 +57,10 @@ func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns type CreateUserInput struct { - // The first name, or given name, of the user. - FirstName *string + // The authentication type for the user. You must specify USERPOOL. + // + // This member is required. + AuthenticationType types.AuthenticationType // The email address of the user.

Users' email addresses are // case-sensitive. During login, if they specify an email address that doesn't use @@ -68,10 +70,8 @@ type CreateUserInput struct { // This member is required. UserName *string - // The authentication type for the user. You must specify USERPOOL. - // - // This member is required. - AuthenticationType types.AuthenticationType + // The first name, or given name, of the user. + FirstName *string // The last name, or surname, of the user. LastName *string diff --git a/service/appstream/api_op_DeleteImagePermissions.go b/service/appstream/api_op_DeleteImagePermissions.go index 6b4811c4f96..a8673de566b 100644 --- a/service/appstream/api_op_DeleteImagePermissions.go +++ b/service/appstream/api_op_DeleteImagePermissions.go @@ -58,16 +58,16 @@ func (c *Client) DeleteImagePermissions(ctx context.Context, params *DeleteImage type DeleteImagePermissionsInput struct { - // The 12-digit identifier of the AWS account for which to delete image - // permissions. + // The name of the private image. // // This member is required. - SharedAccountId *string + Name *string - // The name of the private image. + // The 12-digit identifier of the AWS account for which to delete image + // permissions. // // This member is required. - Name *string + SharedAccountId *string } type DeleteImagePermissionsOutput struct { diff --git a/service/appstream/api_op_DeleteUser.go b/service/appstream/api_op_DeleteUser.go index b8ef3c67f8f..4cbf4f79b97 100644 --- a/service/appstream/api_op_DeleteUser.go +++ b/service/appstream/api_op_DeleteUser.go @@ -57,16 +57,16 @@ func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns type DeleteUserInput struct { - // The email address of the user.

Users' email addresses are - // case-sensitive.

 + // The authentication type for the user. You must specify USERPOOL. // // This member is required. - UserName *string + AuthenticationType types.AuthenticationType - // The authentication type for the user. You must specify USERPOOL. + // The email address of the user.

Users' email addresses are + // case-sensitive.

 // // This member is required. - AuthenticationType types.AuthenticationType + UserName *string } type DeleteUserOutput struct { diff --git a/service/appstream/api_op_DescribeDirectoryConfigs.go b/service/appstream/api_op_DescribeDirectoryConfigs.go index 1fbc578c793..e74ae42a4b1 100644 --- a/service/appstream/api_op_DescribeDirectoryConfigs.go +++ b/service/appstream/api_op_DescribeDirectoryConfigs.go @@ -65,12 +65,12 @@ type DescribeDirectoryConfigsInput struct { // The directory names. DirectoryNames []*string + // The maximum size of each page of results. + MaxResults *int32 + // The pagination token to use to retrieve the next page of results for this // operation. If this value is null, it retrieves the first page. NextToken *string - - // The maximum size of each page of results. - MaxResults *int32 } type DescribeDirectoryConfigsOutput struct { diff --git a/service/appstream/api_op_DescribeFleets.go b/service/appstream/api_op_DescribeFleets.go index 0539a7429b2..fa5080c3ade 100644 --- a/service/appstream/api_op_DescribeFleets.go +++ b/service/appstream/api_op_DescribeFleets.go @@ -57,12 +57,12 @@ func (c *Client) DescribeFleets(ctx context.Context, params *DescribeFleetsInput type DescribeFleetsInput struct { + // The names of the fleets to describe. + Names []*string + // The pagination token to use to retrieve the next page of results for this // operation. If this value is null, it retrieves the first page. NextToken *string - - // The names of the fleets to describe. - Names []*string } type DescribeFleetsOutput struct { diff --git a/service/appstream/api_op_DescribeImageBuilders.go b/service/appstream/api_op_DescribeImageBuilders.go index 8db11524043..882a9d9b4fc 100644 --- a/service/appstream/api_op_DescribeImageBuilders.go +++ b/service/appstream/api_op_DescribeImageBuilders.go @@ -61,23 +61,23 @@ type DescribeImageBuildersInput struct { // The maximum size of each page of results. MaxResults *int32 + // The names of the image builders to describe. + Names []*string + // The pagination token to use to retrieve the next page of results for this // operation. If this value is null, it retrieves the first page. NextToken *string - - // The names of the image builders to describe. - Names []*string } type DescribeImageBuildersOutput struct { + // Information about the image builders. + ImageBuilders []*types.ImageBuilder + // The pagination token to use to retrieve the next page of results for this // operation. If there are no more pages, this value is null. NextToken *string - // Information about the image builders. - ImageBuilders []*types.ImageBuilder - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/appstream/api_op_DescribeImagePermissions.go b/service/appstream/api_op_DescribeImagePermissions.go index a48889e1484..1d4a5f6f499 100644 --- a/service/appstream/api_op_DescribeImagePermissions.go +++ b/service/appstream/api_op_DescribeImagePermissions.go @@ -64,13 +64,13 @@ type DescribeImagePermissionsInput struct { // This member is required. Name *string + // The maximum size of each page of results. + MaxResults *int32 + // The pagination token to use to retrieve the next page of results for this // operation. If this value is null, it retrieves the first page. NextToken *string - // The maximum size of each page of results. - MaxResults *int32 - // The 12-digit identifier of one or more AWS accounts with which the image is // shared. SharedAwsAccountIds []*string @@ -78,9 +78,6 @@ type DescribeImagePermissionsInput struct { type DescribeImagePermissionsOutput struct { - // The permissions for a private image that you own. - SharedImagePermissionsList []*types.SharedImagePermissions - // The name of the private image. Name *string @@ -88,6 +85,9 @@ type DescribeImagePermissionsOutput struct { // operation. If there are no more pages, this value is null. NextToken *string + // The permissions for a private image that you own. + SharedImagePermissionsList []*types.SharedImagePermissions + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/appstream/api_op_DescribeImages.go b/service/appstream/api_op_DescribeImages.go index 9aafa3792d3..3a5e3169d9b 100644 --- a/service/appstream/api_op_DescribeImages.go +++ b/service/appstream/api_op_DescribeImages.go @@ -60,18 +60,18 @@ type DescribeImagesInput struct { // The ARNs of the public, private, and shared images to describe. Arns []*string - // The type of image (public, private, or shared) to describe. - Type types.VisibilityType + // The maximum size of each page of results. + MaxResults *int32 // The names of the public or private images to describe. Names []*string - // The maximum size of each page of results. - MaxResults *int32 - // The pagination token to use to retrieve the next page of results for this // operation. If this value is null, it retrieves the first page. NextToken *string + + // The type of image (public, private, or shared) to describe. + Type types.VisibilityType } type DescribeImagesOutput struct { diff --git a/service/appstream/api_op_DescribeSessions.go b/service/appstream/api_op_DescribeSessions.go index 78715875ba9..640315f4f33 100644 --- a/service/appstream/api_op_DescribeSessions.go +++ b/service/appstream/api_op_DescribeSessions.go @@ -60,11 +60,6 @@ func (c *Client) DescribeSessions(ctx context.Context, params *DescribeSessionsI type DescribeSessionsInput struct { - // The authentication method. Specify API for a user authenticated using a - // streaming URL or SAML for a SAML federated user. The default is to authenticate - // users using a streaming URL. - AuthenticationType types.AuthenticationType - // The name of the fleet. This value is case-sensitive. // // This member is required. @@ -75,16 +70,21 @@ type DescribeSessionsInput struct { // This member is required. StackName *string - // The user identifier. - UserId *string + // The authentication method. Specify API for a user authenticated using a + // streaming URL or SAML for a SAML federated user. The default is to authenticate + // users using a streaming URL. + AuthenticationType types.AuthenticationType + + // The size of each page of results. The default value is 20 and the maximum value + // is 50. + Limit *int32 // The pagination token to use to retrieve the next page of results for this // operation. If this value is null, it retrieves the first page. NextToken *string - // The size of each page of results. The default value is 20 and the maximum value - // is 50. - Limit *int32 + // The user identifier. + UserId *string } type DescribeSessionsOutput struct { diff --git a/service/appstream/api_op_DescribeStacks.go b/service/appstream/api_op_DescribeStacks.go index dbcdc9e366b..66140abda2c 100644 --- a/service/appstream/api_op_DescribeStacks.go +++ b/service/appstream/api_op_DescribeStacks.go @@ -67,13 +67,13 @@ type DescribeStacksInput struct { type DescribeStacksOutput struct { - // Information about the stacks. - Stacks []*types.Stack - // The pagination token to use to retrieve the next page of results for this // operation. If there are no more pages, this value is null. NextToken *string + // Information about the stacks. + Stacks []*types.Stack + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/appstream/api_op_DescribeUsageReportSubscriptions.go b/service/appstream/api_op_DescribeUsageReportSubscriptions.go index dd431aecaa3..a339fa4083e 100644 --- a/service/appstream/api_op_DescribeUsageReportSubscriptions.go +++ b/service/appstream/api_op_DescribeUsageReportSubscriptions.go @@ -56,23 +56,23 @@ func (c *Client) DescribeUsageReportSubscriptions(ctx context.Context, params *D type DescribeUsageReportSubscriptionsInput struct { + // The maximum size of each page of results. + MaxResults *int32 + // The pagination token to use to retrieve the next page of results for this // operation. If this value is null, it retrieves the first page. NextToken *string - - // The maximum size of each page of results. - MaxResults *int32 } type DescribeUsageReportSubscriptionsOutput struct { - // Information about the usage report subscription. - UsageReportSubscriptions []*types.UsageReportSubscription - // The pagination token to use to retrieve the next page of results for this // operation. If there are no more pages, this value is null. NextToken *string + // Information about the usage report subscription. + UsageReportSubscriptions []*types.UsageReportSubscription + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/appstream/api_op_DescribeUserStackAssociations.go b/service/appstream/api_op_DescribeUserStackAssociations.go index 67bb678dc77..2e11182a1fd 100644 --- a/service/appstream/api_op_DescribeUserStackAssociations.go +++ b/service/appstream/api_op_DescribeUserStackAssociations.go @@ -63,23 +63,23 @@ func (c *Client) DescribeUserStackAssociations(ctx context.Context, params *Desc type DescribeUserStackAssociationsInput struct { - // The pagination token to use to retrieve the next page of results for this - // operation. If this value is null, it retrieves the first page. - NextToken *string - - // The email address of the user who is associated with the stack. - //

Users' email addresses are case-sensitive.

 - UserName *string + // The authentication type for the user who is associated with the stack. You must + // specify USERPOOL. + AuthenticationType types.AuthenticationType // The maximum size of each page of results. MaxResults *int32 + // The pagination token to use to retrieve the next page of results for this + // operation. If this value is null, it retrieves the first page. + NextToken *string + // The name of the stack that is associated with the user. StackName *string - // The authentication type for the user who is associated with the stack. You must - // specify USERPOOL. - AuthenticationType types.AuthenticationType + // The email address of the user who is associated with the stack. + //

Users' email addresses are case-sensitive.

 + UserName *string } type DescribeUserStackAssociationsOutput struct { diff --git a/service/appstream/api_op_DescribeUsers.go b/service/appstream/api_op_DescribeUsers.go index 20204bd031e..1ae3f7d529c 100644 --- a/service/appstream/api_op_DescribeUsers.go +++ b/service/appstream/api_op_DescribeUsers.go @@ -57,29 +57,29 @@ func (c *Client) DescribeUsers(ctx context.Context, params *DescribeUsersInput, type DescribeUsersInput struct { + // The authentication type for the users in the user pool to describe. You must + // specify USERPOOL. + // + // This member is required. + AuthenticationType types.AuthenticationType + // The maximum size of each page of results. MaxResults *int32 // The pagination token to use to retrieve the next page of results for this // operation. If this value is null, it retrieves the first page. NextToken *string - - // The authentication type for the users in the user pool to describe. You must - // specify USERPOOL. - // - // This member is required. - AuthenticationType types.AuthenticationType } type DescribeUsersOutput struct { - // Information about users in the user pool. - Users []*types.User - // The pagination token to use to retrieve the next page of results for this // operation. If there are no more pages, this value is null. NextToken *string + // Information about users in the user pool. + Users []*types.User + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/appstream/api_op_UpdateDirectoryConfig.go b/service/appstream/api_op_UpdateDirectoryConfig.go index fb2247c6a40..d1faf77b6a9 100644 --- a/service/appstream/api_op_UpdateDirectoryConfig.go +++ b/service/appstream/api_op_UpdateDirectoryConfig.go @@ -59,17 +59,17 @@ func (c *Client) UpdateDirectoryConfig(ctx context.Context, params *UpdateDirect type UpdateDirectoryConfigInput struct { + // The name of the Directory Config object. + // + // This member is required. + DirectoryName *string + // The distinguished names of the organizational units for computer accounts. OrganizationalUnitDistinguishedNames []*string // The credentials for the service account used by the fleet or image builder to // connect to the directory. ServiceAccountCredentials *types.ServiceAccountCredentials - - // The name of the Directory Config object. - // - // This member is required. - DirectoryName *string } type UpdateDirectoryConfigOutput struct { diff --git a/service/appstream/api_op_UpdateFleet.go b/service/appstream/api_op_UpdateFleet.go index f2949b2590c..eb468d25d04 100644 --- a/service/appstream/api_op_UpdateFleet.go +++ b/service/appstream/api_op_UpdateFleet.go @@ -61,46 +61,17 @@ func (c *Client) UpdateFleet(ctx context.Context, params *UpdateFleetInput, optF type UpdateFleetInput struct { - // The ARN of the public, private, or shared image to use. - ImageArn *string - - // Enables or disables default internet access for the fleet. - EnableDefaultInternetAccess *bool - - // The VPC configuration for the fleet. - VpcConfig *types.VpcConfig - - // The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume - // a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole - // API operation and passes the ARN of the role to use. The operation creates a new - // session with temporary credentials. AppStream 2.0 retrieves the temporary - // credentials and creates the AppStream_Machine_Role credential profile on the - // instance.

For more information, see Using - // an IAM Role to Grant Permissions to Applications and Scripts Running on - // AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 - // Administration Guide.

- IamRoleArn *string - // The fleet attributes to delete. AttributesToDelete []types.FleetAttribute - // The description to display. - Description *string - - // The name of the directory and organizational unit (OU) to use to join the fleet - // to a Microsoft Active Directory domain. - DomainJoinInfo *types.DomainJoinInfo + // The desired capacity for the fleet. + ComputeCapacity *types.ComputeCapacity - // A unique name for the fleet. - Name *string + // Deletes the VPC association for the specified fleet. + DeleteVpcConfig *bool - // The maximum amount of time that a streaming session can remain active, in - // seconds. If users are still connected to a streaming instance five minutes - // before this limit is reached, they are prompted to save any open documents - // before being disconnected. After this time elapses, the instance is terminated - // and replaced by a new instance. Specify a value between 600 and 360000. - MaxUserDurationInSeconds *int32 + // The description to display. + Description *string // The amount of time that a streaming session remains active after users // disconnect. If users try to reconnect to the streaming session after a @@ -109,14 +80,27 @@ type UpdateFleetInput struct { // session with a new streaming instance. Specify a value between 60 and 360000. DisconnectTimeoutInSeconds *int32 - // Deletes the VPC association for the specified fleet. - DeleteVpcConfig *bool + // The fleet name to display. + DisplayName *string - // The name of the image used to create the fleet. - ImageName *string + // The name of the directory and organizational unit (OU) to use to join the fleet + // to a Microsoft Active Directory domain. + DomainJoinInfo *types.DomainJoinInfo - // The desired capacity for the fleet. - ComputeCapacity *types.ComputeCapacity + // Enables or disables default internet access for the fleet. + EnableDefaultInternetAccess *bool + + // The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume + // a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole + // API operation and passes the ARN of the role to use. The operation creates a new + // session with temporary credentials. AppStream 2.0 retrieves the temporary + // credentials and creates the AppStream_Machine_Role credential profile on the + // instance.

For more information, see Using + // an IAM Role to Grant Permissions to Applications and Scripts Running on + // AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 + // Administration Guide.

+ IamRoleArn *string // The amount of time that users can be idle (inactive) before they are // disconnected from their streaming session and the DisconnectTimeoutInSeconds @@ -139,6 +123,12 @@ type UpdateFleetInput struct { // disconnected after 2 minutes of inactivity.

IdleDisconnectTimeoutInSeconds *int32 + // The ARN of the public, private, or shared image to use. + ImageArn *string + + // The name of the image used to create the fleet. + ImageName *string + // The instance type to use when launching fleet instances. The following instance // types are available: // @@ -192,8 +182,18 @@ type UpdateFleetInput struct { // stream.graphics-pro.16xlarge InstanceType *string - // The fleet name to display. - DisplayName *string + // The maximum amount of time that a streaming session can remain active, in + // seconds. If users are still connected to a streaming instance five minutes + // before this limit is reached, they are prompted to save any open documents + // before being disconnected. After this time elapses, the instance is terminated + // and replaced by a new instance. Specify a value between 600 and 360000. + MaxUserDurationInSeconds *int32 + + // A unique name for the fleet. + Name *string + + // The VPC configuration for the fleet. + VpcConfig *types.VpcConfig } type UpdateFleetOutput struct { diff --git a/service/appstream/api_op_UpdateImagePermissions.go b/service/appstream/api_op_UpdateImagePermissions.go index 300926970e0..7741d489fbb 100644 --- a/service/appstream/api_op_UpdateImagePermissions.go +++ b/service/appstream/api_op_UpdateImagePermissions.go @@ -57,15 +57,15 @@ func (c *Client) UpdateImagePermissions(ctx context.Context, params *UpdateImage type UpdateImagePermissionsInput struct { - // The name of the private image. + // The permissions for the image. // // This member is required. - Name *string + ImagePermissions *types.ImagePermissions - // The permissions for the image. + // The name of the private image. // // This member is required. - ImagePermissions *types.ImagePermissions + Name *string // The 12-digit identifier of the AWS account for which you want add or update // image permissions. diff --git a/service/appstream/api_op_UpdateStack.go b/service/appstream/api_op_UpdateStack.go index b2dc872a71f..688d2972c5d 100644 --- a/service/appstream/api_op_UpdateStack.go +++ b/service/appstream/api_op_UpdateStack.go @@ -57,50 +57,50 @@ func (c *Client) UpdateStack(ctx context.Context, params *UpdateStackInput, optF type UpdateStackInput struct { - // The actions that are enabled or disabled for users during their streaming - // sessions. By default, these actions are enabled. - UserSettings []*types.UserSetting - - // The persistent application settings for users of a stack. When these settings - // are enabled, changes that users make to applications and Windows settings are - // automatically saved after each session and applied to the next session. - ApplicationSettings *types.ApplicationSettings + // The name of the stack. + // + // This member is required. + Name *string // The list of interface VPC endpoint (interface endpoint) objects. Users of the // stack can connect to AppStream 2.0 only through the specified endpoints. AccessEndpoints []*types.AccessEndpoint - // The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. - // You must approve the domains that you want to host embedded AppStream 2.0 - // streaming sessions. - EmbedHostDomains []*string + // The persistent application settings for users of a stack. When these settings + // are enabled, changes that users make to applications and Windows settings are + // automatically saved after each session and applied to the next session. + ApplicationSettings *types.ApplicationSettings // The stack attributes to delete. AttributesToDelete []types.StackAttribute + // Deletes the storage connectors currently enabled for the stack. + DeleteStorageConnectors *bool + // The description to display. Description *string // The stack name to display. DisplayName *string - // The storage connectors to enable. - StorageConnectors []*types.StorageConnector + // The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. + // You must approve the domains that you want to host embedded AppStream 2.0 + // streaming sessions. + EmbedHostDomains []*string // The URL that users are redirected to after they choose the Send Feedback link. // If no URL is specified, no Send Feedback link is displayed. FeedbackURL *string - // Deletes the storage connectors currently enabled for the stack. - DeleteStorageConnectors *bool - - // The name of the stack. - // - // This member is required. - Name *string - // The URL that users are redirected to after their streaming session ends. RedirectURL *string + + // The storage connectors to enable. + StorageConnectors []*types.StorageConnector + + // The actions that are enabled or disabled for users during their streaming + // sessions. By default, these actions are enabled. + UserSettings []*types.UserSetting } type UpdateStackOutput struct { diff --git a/service/appstream/go.mod b/service/appstream/go.mod index 4bfd8b9aa19..08ee3843f46 100644 --- a/service/appstream/go.mod +++ b/service/appstream/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/appstream go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/appstream/types/types.go b/service/appstream/types/types.go index 6525bb295f5..4213eb6577b 100644 --- a/service/appstream/types/types.go +++ b/service/appstream/types/types.go @@ -26,14 +26,17 @@ type AccessEndpoint struct { // Describes an application in the application catalog. type Application struct { - // The arguments that are passed to the application at launch. - LaunchParameters *string - // The application name to display. DisplayName *string - // The name of the application. - Name *string + // If there is a problem, the application can be disabled after image creation. + Enabled *bool + + // The URL for the application icon. This URL might be time-limited. + IconURL *string + + // The arguments that are passed to the application at launch. + LaunchParameters *string // The path to the application executable in the instance. LaunchPath *string @@ -41,11 +44,8 @@ type Application struct { // Additional attributes that describe the application. Metadata map[string]*string - // If there is a problem, the application can be disabled after image creation. - Enabled *bool - - // The URL for the application icon. This URL might be time-limited. - IconURL *string + // The name of the application. + Name *string } // The persistent application settings for users of a stack. @@ -66,9 +66,9 @@ type ApplicationSettings struct { // Describes the persistent application settings for users of a stack. type ApplicationSettingsResponse struct { - // The path prefix for the S3 bucket where users’ persistent application settings - // are stored. - SettingsGroup *string + // Specifies whether persistent application settings are enabled for users during + // their streaming sessions. + Enabled *bool // The S3 bucket where users’ persistent application settings are stored. When // persistent application settings are enabled for the first time for an account in @@ -76,9 +76,9 @@ type ApplicationSettingsResponse struct { // and the Region. S3BucketName *string - // Specifies whether persistent application settings are enabled for users during - // their streaming sessions. - Enabled *bool + // The path prefix for the S3 bucket where users’ persistent application settings + // are stored. + SettingsGroup *string } // Describes the capacity for a fleet. @@ -93,17 +93,17 @@ type ComputeCapacity struct { // Describes the capacity status for a fleet. type ComputeCapacityStatus struct { - // The number of instances in use for streaming. - InUse *int32 - - // The number of currently available instances that can be used to stream sessions. - Available *int32 - // The desired number of streaming instances. // // This member is required. Desired *int32 + // The number of currently available instances that can be used to stream sessions. + Available *int32 + + // The number of instances in use for streaming. + InUse *int32 + // The total number of simultaneous streaming instances that are running. Running *int32 } @@ -112,10 +112,6 @@ type ComputeCapacityStatus struct { // builders to Microsoft Active Directory domains. type DirectoryConfig struct { - // The credentials for the service account used by the fleet or image builder to - // connect to the directory. - ServiceAccountCredentials *ServiceAccountCredentials - // The fully qualified name of the directory (for example, corp.example.com). // // This member is required. @@ -126,6 +122,10 @@ type DirectoryConfig struct { // The distinguished names of the organizational units for computer accounts. OrganizationalUnitDistinguishedNames []*string + + // The credentials for the service account used by the fleet or image builder to + // connect to the directory. + ServiceAccountCredentials *ServiceAccountCredentials } // Describes the configuration information required to join fleets and image @@ -142,106 +142,16 @@ type DomainJoinInfo struct { // Describes a fleet. type Fleet struct { - // The amount of time that a streaming session remains active after users - // disconnect. If they try to reconnect to the streaming session after a - // disconnection or network interruption within this time interval, they are - // connected to their previous session. Otherwise, they are connected to a new - // session with a new streaming instance. Specify a value between 60 and 360000. - DisconnectTimeoutInSeconds *int32 - - // The maximum amount of time that a streaming session can remain active, in - // seconds. If users are still connected to a streaming instance five minutes - // before this limit is reached, they are prompted to save any open documents - // before being disconnected. After this time elapses, the instance is terminated - // and replaced by a new instance. Specify a value between 600 and 360000. - MaxUserDurationInSeconds *int32 - - // The fleet errors. - FleetErrors []*FleetError - - // The fleet name to display. - DisplayName *string - - // The VPC configuration for the fleet. - VpcConfig *VpcConfig - - // The description to display. - Description *string - // The Amazon Resource Name (ARN) for the fleet. // // This member is required. Arn *string - // The name of the image used to create the fleet. - ImageName *string - - // The fleet type. ALWAYS_ON Provides users with instant-on access to their apps. - // You are charged for all running instances in your fleet, even if no users are - // streaming apps. ON_DEMAND Provide users with access to applications after they - // connect, which takes one to two minutes. You are charged for instance streaming - // when users are connected and a small hourly fee for instances that are not - // streaming apps. - FleetType FleetType - - // The current state for the fleet. - // - // This member is required. - State FleetState - - // The ARN of the IAM role that is applied to the fleet. To assume a role, the - // fleet instance calls the AWS Security Token Service (STS) AssumeRole API - // operation and passes the ARN of the role to use. The operation creates a new - // session with temporary credentials. AppStream 2.0 retrieves the temporary - // credentials and creates the AppStream_Machine_Role credential profile on the - // instance.

For more information, see Using - // an IAM Role to Grant Permissions to Applications and Scripts Running on - // AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 - // Administration Guide.

- IamRoleArn *string - // The capacity status for the fleet. // // This member is required. ComputeCapacityStatus *ComputeCapacityStatus - // The ARN for the public, private, or shared image. - ImageArn *string - - // The name of the fleet. - // - // This member is required. - Name *string - - // The name of the directory and organizational unit (OU) to use to join the fleet - // to a Microsoft Active Directory domain. - DomainJoinInfo *DomainJoinInfo - - // The amount of time that users can be idle (inactive) before they are - // disconnected from their streaming session and the DisconnectTimeoutInSeconds - // time interval begins. Users are notified before they are disconnected due to - // inactivity. If users try to reconnect to the streaming session before the time - // interval specified in DisconnectTimeoutInSeconds elapses, they are connected to - // their previous session. Users are considered idle when they stop providing - // keyboard or mouse input during their streaming session. File uploads and - // downloads, audio in, audio out, and pixels changing do not qualify as user - // activity. If users continue to be idle after the time interval in - // IdleDisconnectTimeoutInSeconds elapses, they are disconnected. To prevent users - // from being disconnected due to inactivity, specify a value of 0. Otherwise, - // specify a value between 60 and 3600. The default value is 0.

If you - // enable this feature, we recommend that you specify a value that corresponds - // exactly to a whole number of minutes (for example, 60, 120, and 180). If you - // don't do this, the value is rounded to the nearest minute. For example, if you - // specify a value of 70, users are disconnected after 1 minute of inactivity. If - // you specify a value that is at the midpoint between two different minutes, the - // value is rounded up. For example, if you specify a value of 90, users are - // disconnected after 2 minutes of inactivity.

- IdleDisconnectTimeoutInSeconds *int32 - - // The time the fleet was created. - CreatedTime *time.Time - // The instance type to use when launching fleet instances. The following instance // types are available: // @@ -297,35 +207,127 @@ type Fleet struct { // This member is required. InstanceType *string + // The name of the fleet. + // + // This member is required. + Name *string + + // The current state for the fleet. + // + // This member is required. + State FleetState + + // The time the fleet was created. + CreatedTime *time.Time + + // The description to display. + Description *string + + // The amount of time that a streaming session remains active after users + // disconnect. If they try to reconnect to the streaming session after a + // disconnection or network interruption within this time interval, they are + // connected to their previous session. Otherwise, they are connected to a new + // session with a new streaming instance. Specify a value between 60 and 360000. + DisconnectTimeoutInSeconds *int32 + + // The fleet name to display. + DisplayName *string + + // The name of the directory and organizational unit (OU) to use to join the fleet + // to a Microsoft Active Directory domain. + DomainJoinInfo *DomainJoinInfo + // Indicates whether default internet access is enabled for the fleet. EnableDefaultInternetAccess *bool + + // The fleet errors. + FleetErrors []*FleetError + + // The fleet type. ALWAYS_ON Provides users with instant-on access to their apps. + // You are charged for all running instances in your fleet, even if no users are + // streaming apps. ON_DEMAND Provide users with access to applications after they + // connect, which takes one to two minutes. You are charged for instance streaming + // when users are connected and a small hourly fee for instances that are not + // streaming apps. + FleetType FleetType + + // The ARN of the IAM role that is applied to the fleet. To assume a role, the + // fleet instance calls the AWS Security Token Service (STS) AssumeRole API + // operation and passes the ARN of the role to use. The operation creates a new + // session with temporary credentials. AppStream 2.0 retrieves the temporary + // credentials and creates the AppStream_Machine_Role credential profile on the + // instance.

For more information, see Using + // an IAM Role to Grant Permissions to Applications and Scripts Running on + // AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 + // Administration Guide.

+ IamRoleArn *string + + // The amount of time that users can be idle (inactive) before they are + // disconnected from their streaming session and the DisconnectTimeoutInSeconds + // time interval begins. Users are notified before they are disconnected due to + // inactivity. If users try to reconnect to the streaming session before the time + // interval specified in DisconnectTimeoutInSeconds elapses, they are connected to + // their previous session. Users are considered idle when they stop providing + // keyboard or mouse input during their streaming session. File uploads and + // downloads, audio in, audio out, and pixels changing do not qualify as user + // activity. If users continue to be idle after the time interval in + // IdleDisconnectTimeoutInSeconds elapses, they are disconnected. To prevent users + // from being disconnected due to inactivity, specify a value of 0. Otherwise, + // specify a value between 60 and 3600. The default value is 0.

If you + // enable this feature, we recommend that you specify a value that corresponds + // exactly to a whole number of minutes (for example, 60, 120, and 180). If you + // don't do this, the value is rounded to the nearest minute. For example, if you + // specify a value of 70, users are disconnected after 1 minute of inactivity. If + // you specify a value that is at the midpoint between two different minutes, the + // value is rounded up. For example, if you specify a value of 90, users are + // disconnected after 2 minutes of inactivity.

+ IdleDisconnectTimeoutInSeconds *int32 + + // The ARN for the public, private, or shared image. + ImageArn *string + + // The name of the image used to create the fleet. + ImageName *string + + // The maximum amount of time that a streaming session can remain active, in + // seconds. If users are still connected to a streaming instance five minutes + // before this limit is reached, they are prompted to save any open documents + // before being disconnected. After this time elapses, the instance is terminated + // and replaced by a new instance. Specify a value between 600 and 360000. + MaxUserDurationInSeconds *int32 + + // The VPC configuration for the fleet. + VpcConfig *VpcConfig } // Describes a fleet error. type FleetError struct { - // The error message. - ErrorMessage *string - // The error code. ErrorCode FleetErrorCode + + // The error message. + ErrorMessage *string } // Describes an image. type Image struct { - // The permissions to provide to the destination AWS account for the specified - // image. - ImagePermissions *ImagePermissions + // The name of the image. + // + // This member is required. + Name *string - // Indicates whether the image is public or private. - Visibility VisibilityType + // The applications associated with the image. + Applications []*Application - // The reason why the last state change occurred. - StateChangeReason *ImageStateChangeReason + // The version of the AppStream 2.0 agent to use for instances that are launched + // from this image. + AppstreamAgentVersion *string - // The image name to display. - DisplayName *string + // The ARN of the image. + Arn *string // The ARN of the image from which this image was created. BaseImageArn *string @@ -336,57 +338,91 @@ type Image struct { // The description to display. Description *string - // The operating system platform of the image. - Platform PlatformType - - // The applications associated with the image. - Applications []*Application - - // The ARN of the image. - Arn *string - - // The version of the AppStream 2.0 agent to use for instances that are launched - // from this image. - AppstreamAgentVersion *string - - // The name of the image. - // - // This member is required. - Name *string + // The image name to display. + DisplayName *string // The name of the image builder that was used to create the private image. If the // image is shared, this value is null. ImageBuilderName *string - // The image starts in the PENDING state. If image creation succeeds, the state is - // AVAILABLE. If image creation fails, the state is FAILED. - State ImageState - // Indicates whether an image builder can be launched from this image. ImageBuilderSupported *bool + // The permissions to provide to the destination AWS account for the specified + // image. + ImagePermissions *ImagePermissions + + // The operating system platform of the image. + Platform PlatformType + // The release date of the public base image. For private images, this date is the // release date of the base image from which the image was created. PublicBaseImageReleasedDate *time.Time + + // The image starts in the PENDING state. If image creation succeeds, the state is + // AVAILABLE. If image creation fails, the state is FAILED. + State ImageState + + // The reason why the last state change occurred. + StateChangeReason *ImageStateChangeReason + + // Indicates whether the image is public or private. + Visibility VisibilityType } // Describes a virtual machine that is used to create an image. type ImageBuilder struct { + // The name of the image builder. + // + // This member is required. + Name *string + + // The list of virtual private cloud (VPC) interface endpoint objects. + // Administrators can connect to the image builder only through the specified + // endpoints. + AccessEndpoints []*AccessEndpoint + + // The version of the AppStream 2.0 agent that is currently being used by the image + // builder. + AppstreamAgentVersion *string + // The ARN for the image builder. Arn *string - // The VPC configuration of the image builder. - VpcConfig *VpcConfig + // The time stamp when the image builder was created. + CreatedTime *time.Time - // The image builder errors. - ImageBuilderErrors []*ResourceError + // The description to display. + Description *string + + // The image builder name to display. + DisplayName *string + + // The name of the directory and organizational unit (OU) to use to join the image + // builder to a Microsoft Active Directory domain. + DomainJoinInfo *DomainJoinInfo // Enables or disables default internet access for the image builder. EnableDefaultInternetAccess *bool - // The image builder name to display. - DisplayName *string + // The ARN of the IAM role that is applied to the image builder. To assume a role, + // the image builder calls the AWS Security Token Service (STS) AssumeRole API + // operation and passes the ARN of the role to use. The operation creates a new + // session with temporary credentials. AppStream 2.0 retrieves the temporary + // credentials and creates the AppStream_Machine_Role credential profile on the + // instance.

For more information, see Using + // an IAM Role to Grant Permissions to Applications and Scripts Running on + // AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 + // Administration Guide.

+ IamRoleArn *string + + // The ARN of the image from which this builder was created. + ImageArn *string + + // The image builder errors. + ImageBuilderErrors []*ResourceError // The instance type for the image builder. The following instance types are // available: @@ -441,56 +477,20 @@ type ImageBuilder struct { // stream.graphics-pro.16xlarge InstanceType *string - // The name of the directory and organizational unit (OU) to use to join the image - // builder to a Microsoft Active Directory domain. - DomainJoinInfo *DomainJoinInfo - - // The name of the image builder. - // - // This member is required. - Name *string - - // The operating system platform of the image builder. - Platform PlatformType - - // The time stamp when the image builder was created. - CreatedTime *time.Time - - // Describes the network details of the fleet or image builder instance. - NetworkAccessConfiguration *NetworkAccessConfiguration - - // The reason why the last state change occurred. - StateChangeReason *ImageBuilderStateChangeReason - - // The version of the AppStream 2.0 agent that is currently being used by the image - // builder. - AppstreamAgentVersion *string - - // The ARN of the image from which this builder was created. - ImageArn *string - - // The list of virtual private cloud (VPC) interface endpoint objects. - // Administrators can connect to the image builder only through the specified - // endpoints. - AccessEndpoints []*AccessEndpoint + // Describes the network details of the fleet or image builder instance. + NetworkAccessConfiguration *NetworkAccessConfiguration + + // The operating system platform of the image builder. + Platform PlatformType // The state of the image builder. State ImageBuilderState - // The description to display. - Description *string + // The reason why the last state change occurred. + StateChangeReason *ImageBuilderStateChangeReason - // The ARN of the IAM role that is applied to the image builder. To assume a role, - // the image builder calls the AWS Security Token Service (STS) AssumeRole API - // operation and passes the ARN of the role to use. The operation creates a new - // session with temporary credentials. AppStream 2.0 retrieves the temporary - // credentials and creates the AppStream_Machine_Role credential profile on the - // instance.

For more information, see Using - // an IAM Role to Grant Permissions to Applications and Scripts Running on - // AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 - // Administration Guide.

- IamRoleArn *string + // The VPC configuration of the image builder. + VpcConfig *VpcConfig } // Describes the reason why the last image builder state change occurred. @@ -516,11 +516,11 @@ type ImagePermissions struct { // Describes the reason why the last image state change occurred. type ImageStateChangeReason struct { - // The state change reason message. - Message *string - // The state change reason code. Code ImageStateChangeReasonCode + + // The state change reason message. + Message *string } // Describes the error that is returned when a usage report can't be generated. @@ -538,56 +538,80 @@ type LastReportGenerationExecutionError struct { // Describes the network details of the fleet or image builder instance. type NetworkAccessConfiguration struct { - // The private IP address of the elastic network interface that is attached to - // instances in your VPC. - EniPrivateIpAddress *string - // The resource identifier of the elastic network interface that is attached to // instances in your VPC. All network interfaces have the eni-xxxxxxxx resource // identifier. EniId *string + + // The private IP address of the elastic network interface that is attached to + // instances in your VPC. + EniPrivateIpAddress *string } // Describes a resource error. type ResourceError struct { - // The time the error occurred. - ErrorTimestamp *time.Time + // The error code. + ErrorCode FleetErrorCode // The error message. ErrorMessage *string - // The error code. - ErrorCode FleetErrorCode + // The time the error occurred. + ErrorTimestamp *time.Time } // Describes the credentials for the service account used by the fleet or image // builder to connect to the directory. type ServiceAccountCredentials struct { - // The password for the account. - // - // This member is required. - AccountPassword *string - // The user name of the account. This account must have the following privileges: // create computer objects, join computers to the domain, and change/reset the // password on descendant computer objects for the organizational units specified. // // This member is required. AccountName *string + + // The password for the account. + // + // This member is required. + AccountPassword *string } // Describes a streaming session. type Session struct { + // The name of the fleet for the streaming session. + // + // This member is required. + FleetName *string + + // The identifier of the streaming session. + // + // This member is required. + Id *string + + // The name of the stack for the streaming session. + // + // This member is required. + StackName *string + // The current state of the streaming session. // // This member is required. State SessionState - // The time when a streaming instance is dedicated for the user. - StartTime *time.Time + // The identifier of the user for whom the session was created. + // + // This member is required. + UserId *string + + // The authentication method. The user is authenticated using a streaming URL (API) + // or SAML 2.0 federation (SAML). + AuthenticationType AuthenticationType + + // Specifies whether a user is connected to the streaming session. + ConnectionState SessionConnectionState // The time when the streaming session is set to expire. This time is based on the // MaxUserDurationinSeconds value, which determines the maximum length of time that @@ -601,122 +625,98 @@ type Session struct { // The network details for the streaming session. NetworkAccessConfiguration *NetworkAccessConfiguration - // The identifier of the streaming session. - // - // This member is required. - Id *string - - // Specifies whether a user is connected to the streaming session. - ConnectionState SessionConnectionState - - // The authentication method. The user is authenticated using a streaming URL (API) - // or SAML 2.0 federation (SAML). - AuthenticationType AuthenticationType - - // The identifier of the user for whom the session was created. - // - // This member is required. - UserId *string - - // The name of the stack for the streaming session. - // - // This member is required. - StackName *string - - // The name of the fleet for the streaming session. - // - // This member is required. - FleetName *string + // The time when a streaming instance is dedicated for the user. + StartTime *time.Time } // Describes the permissions that are available to the specified AWS account for a // shared image. type SharedImagePermissions struct { - // The 12-digit identifier of the AWS account with which the image is shared. + // Describes the permissions for a shared image. // // This member is required. - SharedAccountId *string + ImagePermissions *ImagePermissions - // Describes the permissions for a shared image. + // The 12-digit identifier of the AWS account with which the image is shared. // // This member is required. - ImagePermissions *ImagePermissions + SharedAccountId *string } // Describes a stack. type Stack struct { - // The storage connectors to enable. - StorageConnectors []*StorageConnector - - // The time the stack was created. - CreatedTime *time.Time - // The name of the stack. // // This member is required. Name *string + // The list of virtual private cloud (VPC) interface endpoint objects. Users of the + // stack can connect to AppStream 2.0 only through the specified endpoints. + AccessEndpoints []*AccessEndpoint + + // The persistent application settings for users of the stack. + ApplicationSettings *ApplicationSettingsResponse + // The ARN of the stack. Arn *string - // The URL that users are redirected to after they click the Send Feedback link. If - // no URL is specified, no Send Feedback link is displayed. - FeedbackURL *string + // The time the stack was created. + CreatedTime *time.Time // The description to display. Description *string - // The actions that are enabled or disabled for users during their streaming - // sessions. By default these actions are enabled. - UserSettings []*UserSetting - - // The errors for the stack. - StackErrors []*StackError - - // The persistent application settings for users of the stack. - ApplicationSettings *ApplicationSettingsResponse + // The stack name to display. + DisplayName *string // The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. // You must approve the domains that you want to host embedded AppStream 2.0 // streaming sessions. EmbedHostDomains []*string + // The URL that users are redirected to after they click the Send Feedback link. If + // no URL is specified, no Send Feedback link is displayed. + FeedbackURL *string + // The URL that users are redirected to after their streaming session ends. RedirectURL *string - // The list of virtual private cloud (VPC) interface endpoint objects. Users of the - // stack can connect to AppStream 2.0 only through the specified endpoints. - AccessEndpoints []*AccessEndpoint + // The errors for the stack. + StackErrors []*StackError - // The stack name to display. - DisplayName *string + // The storage connectors to enable. + StorageConnectors []*StorageConnector + + // The actions that are enabled or disabled for users during their streaming + // sessions. By default these actions are enabled. + UserSettings []*UserSetting } // Describes a stack error. type StackError struct { - // The error message. - ErrorMessage *string - // The error code. ErrorCode StackErrorCode + + // The error message. + ErrorMessage *string } // Describes a connector that enables persistent storage for users. type StorageConnector struct { + // The type of storage connector. + // + // This member is required. + ConnectorType StorageConnectorType + // The names of the domains for the account. Domains []*string // The ARN of the storage connector. ResourceIdentifier *string - - // The type of storage connector. - // - // This member is required. - ConnectorType StorageConnectorType } // Describes information about the usage report subscription. @@ -725,12 +725,6 @@ type UsageReportSubscription struct { // The time when the last usage report was generated. LastGeneratedReportDate *time.Time - // The schedule for generating usage reports. - Schedule UsageReportSchedule - - // The errors that were returned if usage reports couldn't be generated. - SubscriptionErrors []*LastReportGenerationExecutionError - // The Amazon S3 bucket where generated reports are stored.

If you enabled // on-instance session scripts and Amazon S3 logging for your session script // configuration, AppStream 2.0 created an S3 bucket to store the script output. @@ -739,22 +733,36 @@ type UsageReportSubscription struct { // you haven't already enabled on-instance session scripts, when you enable usage // reports, AppStream 2.0 creates a new S3 bucket.

S3BucketName *string + + // The schedule for generating usage reports. + Schedule UsageReportSchedule + + // The errors that were returned if usage reports couldn't be generated. + SubscriptionErrors []*LastReportGenerationExecutionError } // Describes a user in the user pool. type User struct { - // Specifies whether the user in the user pool is enabled. - Enabled *bool - // The authentication type for the user. // // This member is required. AuthenticationType AuthenticationType - // The email address of the user.

Users' email addresses are - // case-sensitive.

 - UserName *string + // The ARN of the user. + Arn *string + + // The date and time the user was created in the user pool. + CreatedTime *time.Time + + // Specifies whether the user in the user pool is enabled. + Enabled *bool + + // The first name, or given name, of the user. + FirstName *string + + // The last name, or surname, of the user. + LastName *string // The status of the user in the user pool. The status can be one of the // following: @@ -773,65 +781,54 @@ type User struct { // * UNKNOWN – The user status is not known. Status *string - // The first name, or given name, of the user. - FirstName *string - - // The ARN of the user. - Arn *string - - // The date and time the user was created in the user pool. - CreatedTime *time.Time - - // The last name, or surname, of the user. - LastName *string + // The email address of the user.

Users' email addresses are + // case-sensitive.

 + UserName *string } // Describes an action and whether the action is enabled or disabled for users // during their streaming sessions. type UserSetting struct { - // Indicates whether the action is enabled or disabled. + // The action that is enabled or disabled. // // This member is required. - Permission Permission + Action Action - // The action that is enabled or disabled. + // Indicates whether the action is enabled or disabled. // // This member is required. - Action Action + Permission Permission } // Describes a user in the user pool and the associated stack. type UserStackAssociation struct { - // The name of the stack that is associated with the user. - // - // This member is required. - StackName *string - // The authentication type for the user. // // This member is required. AuthenticationType AuthenticationType - // Specifies whether a welcome email is sent to a user after the user is created in - // the user pool. - SendEmailNotification *bool + // The name of the stack that is associated with the user. + // + // This member is required. + StackName *string // The email address of the user who is associated with the stack. //

Users' email addresses are case-sensitive.

 // // This member is required. UserName *string + + // Specifies whether a welcome email is sent to a user after the user is created in + // the user pool. + SendEmailNotification *bool } // Describes the error that is returned when a user can’t be associated with or // disassociated from a stack. type UserStackAssociationError struct { - // Information about the user and associated stack. - UserStackAssociation *UserStackAssociation - // The error code for the error that is returned when a user can’t be associated // with or disassociated from a stack. ErrorCode UserStackAssociationErrorCode @@ -839,6 +836,9 @@ type UserStackAssociationError struct { // The error message for the error that is returned when a user can’t be associated // with or disassociated from a stack. ErrorMessage *string + + // Information about the user and associated stack. + UserStackAssociation *UserStackAssociation } // Describes VPC configuration information for fleets and image builders. diff --git a/service/appsync/api_op_CreateApiCache.go b/service/appsync/api_op_CreateApiCache.go index 0813b3534f3..e2a8f60d2be 100644 --- a/service/appsync/api_op_CreateApiCache.go +++ b/service/appsync/api_op_CreateApiCache.go @@ -68,6 +68,16 @@ type CreateApiCacheInput struct { // This member is required. ApiCachingBehavior types.ApiCachingBehavior + // The GraphQL API Id. + // + // This member is required. + ApiId *string + + // TTL in seconds for cache entries. Valid values are between 1 and 3600 seconds. + // + // This member is required. + Ttl *int64 + // The cache instance type. // // * T2_SMALL: A t2.small instance type. @@ -95,19 +105,9 @@ type CreateApiCacheInput struct { // creation. AtRestEncryptionEnabled *bool - // The GraphQL API Id. - // - // This member is required. - ApiId *string - // Transit encryption flag when connecting to cache. This setting cannot be updated // after creation. TransitEncryptionEnabled *bool - - // TTL in seconds for cache entries. Valid values are between 1 and 3600 seconds. - // - // This member is required. - Ttl *int64 } // Represents the output of a CreateApiCache operation. diff --git a/service/appsync/api_op_CreateApiKey.go b/service/appsync/api_op_CreateApiKey.go index 8b0216caa52..34e274b9e56 100644 --- a/service/appsync/api_op_CreateApiKey.go +++ b/service/appsync/api_op_CreateApiKey.go @@ -58,19 +58,19 @@ func (c *Client) CreateApiKey(ctx context.Context, params *CreateApiKeyInput, op type CreateApiKeyInput struct { + // The ID for your GraphQL API. + // + // This member is required. + ApiId *string + + // A description of the purpose of the API key. + Description *string + // The time from creation time after which the API key expires. The date is // represented as seconds since the epoch, rounded down to the nearest hour. The // default value for this parameter is 7 days from creation time. For more // information, see . Expires *int64 - - // A description of the purpose of the API key. - Description *string - - // The ID for your GraphQL API. - // - // This member is required. - ApiId *string } type CreateApiKeyOutput struct { diff --git a/service/appsync/api_op_CreateDataSource.go b/service/appsync/api_op_CreateDataSource.go index c0af0592a8b..04513c4e598 100644 --- a/service/appsync/api_op_CreateDataSource.go +++ b/service/appsync/api_op_CreateDataSource.go @@ -57,16 +57,20 @@ func (c *Client) CreateDataSource(ctx context.Context, params *CreateDataSourceI type CreateDataSourceInput struct { - // The type of the DataSource. + // The API ID for the GraphQL API for the DataSource. // // This member is required. - Type types.DataSourceType + ApiId *string - // Relational database settings. - RelationalDatabaseConfig *types.RelationalDatabaseDataSourceConfig + // A user-supplied name for the DataSource. + // + // This member is required. + Name *string - // AWS Lambda settings. - LambdaConfig *types.LambdaDataSourceConfig + // The type of the DataSource. + // + // This member is required. + Type types.DataSourceType // A description of the DataSource. Description *string @@ -74,25 +78,21 @@ type CreateDataSourceInput struct { // Amazon DynamoDB settings. DynamodbConfig *types.DynamodbDataSourceConfig - // The AWS IAM service role ARN for the data source. The system assumes this role - // when accessing the data source. - ServiceRoleArn *string + // Amazon Elasticsearch Service settings. + ElasticsearchConfig *types.ElasticsearchDataSourceConfig // HTTP endpoint settings. HttpConfig *types.HttpDataSourceConfig - // The API ID for the GraphQL API for the DataSource. - // - // This member is required. - ApiId *string + // AWS Lambda settings. + LambdaConfig *types.LambdaDataSourceConfig - // A user-supplied name for the DataSource. - // - // This member is required. - Name *string + // Relational database settings. + RelationalDatabaseConfig *types.RelationalDatabaseDataSourceConfig - // Amazon Elasticsearch Service settings. - ElasticsearchConfig *types.ElasticsearchDataSourceConfig + // The AWS IAM service role ARN for the data source. The system assumes this role + // when accessing the data source. + ServiceRoleArn *string } type CreateDataSourceOutput struct { diff --git a/service/appsync/api_op_CreateFunction.go b/service/appsync/api_op_CreateFunction.go index 71b339958dd..c89442c1178 100644 --- a/service/appsync/api_op_CreateFunction.go +++ b/service/appsync/api_op_CreateFunction.go @@ -58,38 +58,38 @@ func (c *Client) CreateFunction(ctx context.Context, params *CreateFunctionInput type CreateFunctionInput struct { - // The Function response mapping template. - ResponseMappingTemplate *string - - // The version of the request mapping template. Currently the supported value is - // 2018-05-29. + // The GraphQL API ID. // // This member is required. - FunctionVersion *string + ApiId *string // The FunctionDataSource name. // // This member is required. DataSourceName *string - // The Function name. The function name does not have to be unique. + // The version of the request mapping template. Currently the supported value is + // 2018-05-29. // // This member is required. - Name *string - - // The Function description. - Description *string + FunctionVersion *string - // The GraphQL API ID. + // The Function name. The function name does not have to be unique. // // This member is required. - ApiId *string + Name *string // The Function request mapping template. Functions support only the 2018-05-29 // version of the request mapping template. // // This member is required. RequestMappingTemplate *string + + // The Function description. + Description *string + + // The Function response mapping template. + ResponseMappingTemplate *string } type CreateFunctionOutput struct { diff --git a/service/appsync/api_op_CreateGraphqlApi.go b/service/appsync/api_op_CreateGraphqlApi.go index fece2bc1fd7..011cce0c127 100644 --- a/service/appsync/api_op_CreateGraphqlApi.go +++ b/service/appsync/api_op_CreateGraphqlApi.go @@ -57,33 +57,33 @@ func (c *Client) CreateGraphqlApi(ctx context.Context, params *CreateGraphqlApiI type CreateGraphqlApiInput struct { - // A TagMap object. - Tags map[string]*string + // The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools. + // + // This member is required. + AuthenticationType types.AuthenticationType // A user-supplied name for the GraphqlApi. // // This member is required. Name *string + // A list of additional authentication providers for the GraphqlApi API. + AdditionalAuthenticationProviders []*types.AdditionalAuthenticationProvider + // The Amazon CloudWatch Logs configuration. LogConfig *types.LogConfig - // The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools. - // - // This member is required. - AuthenticationType types.AuthenticationType + // The OpenID Connect configuration. + OpenIDConnectConfig *types.OpenIDConnectConfig - // A flag indicating whether to enable X-Ray tracing for the GraphqlApi. - XrayEnabled *bool + // A TagMap object. + Tags map[string]*string // The Amazon Cognito user pool configuration. UserPoolConfig *types.UserPoolConfig - // The OpenID Connect configuration. - OpenIDConnectConfig *types.OpenIDConnectConfig - - // A list of additional authentication providers for the GraphqlApi API. - AdditionalAuthenticationProviders []*types.AdditionalAuthenticationProvider + // A flag indicating whether to enable X-Ray tracing for the GraphqlApi. + XrayEnabled *bool } type CreateGraphqlApiOutput struct { diff --git a/service/appsync/api_op_CreateResolver.go b/service/appsync/api_op_CreateResolver.go index 0a001c65769..451dcf26f0d 100644 --- a/service/appsync/api_op_CreateResolver.go +++ b/service/appsync/api_op_CreateResolver.go @@ -64,20 +64,11 @@ type CreateResolverInput struct { // This member is required. ApiId *string - // The name of the data source for which the resolver is being created. - DataSourceName *string - // The name of the field to attach the resolver to. // // This member is required. FieldName *string - // The mapping template to be used for responses from the data source. - ResponseMappingTemplate *string - - // The caching configuration for the resolver. - CachingConfig *types.CachingConfig - // The mapping template to be used for requests. A resolver uses a request mapping // template to convert a GraphQL expression into a format that a data source can // understand. Mapping templates are written in Apache Velocity Template Language @@ -86,14 +77,17 @@ type CreateResolverInput struct { // This member is required. RequestMappingTemplate *string - // The SyncConfig for a resolver attached to a versioned datasource. - SyncConfig *types.SyncConfig - // The name of the Type. // // This member is required. TypeName *string + // The caching configuration for the resolver. + CachingConfig *types.CachingConfig + + // The name of the data source for which the resolver is being created. + DataSourceName *string + // The resolver type. // // * UNIT: A UNIT resolver type. A UNIT resolver is the @@ -108,6 +102,12 @@ type CreateResolverInput struct { // The PipelineConfig. PipelineConfig *types.PipelineConfig + + // The mapping template to be used for responses from the data source. + ResponseMappingTemplate *string + + // The SyncConfig for a resolver attached to a versioned datasource. + SyncConfig *types.SyncConfig } type CreateResolverOutput struct { diff --git a/service/appsync/api_op_CreateType.go b/service/appsync/api_op_CreateType.go index 16c1cd503b3..648037913af 100644 --- a/service/appsync/api_op_CreateType.go +++ b/service/appsync/api_op_CreateType.go @@ -62,17 +62,17 @@ type CreateTypeInput struct { // This member is required. ApiId *string - // The type format: SDL or JSON. - // - // This member is required. - Format types.TypeDefinitionFormat - // The type definition, in GraphQL Schema Definition Language (SDL) format. For // more information, see the GraphQL SDL documentation // (http://graphql.org/learn/schema/). // // This member is required. Definition *string + + // The type format: SDL or JSON. + // + // This member is required. + Format types.TypeDefinitionFormat } type CreateTypeOutput struct { diff --git a/service/appsync/api_op_DeleteResolver.go b/service/appsync/api_op_DeleteResolver.go index 6c94abd2043..b1b63e602c7 100644 --- a/service/appsync/api_op_DeleteResolver.go +++ b/service/appsync/api_op_DeleteResolver.go @@ -56,15 +56,15 @@ func (c *Client) DeleteResolver(ctx context.Context, params *DeleteResolverInput type DeleteResolverInput struct { - // The resolver field name. + // The API ID. // // This member is required. - FieldName *string + ApiId *string - // The API ID. + // The resolver field name. // // This member is required. - ApiId *string + FieldName *string // The name of the resolver type. // diff --git a/service/appsync/api_op_GetFunction.go b/service/appsync/api_op_GetFunction.go index 8299f6ea0e0..aeff557fdd0 100644 --- a/service/appsync/api_op_GetFunction.go +++ b/service/appsync/api_op_GetFunction.go @@ -57,15 +57,15 @@ func (c *Client) GetFunction(ctx context.Context, params *GetFunctionInput, optF type GetFunctionInput struct { - // The Function ID. + // The GraphQL API ID. // // This member is required. - FunctionId *string + ApiId *string - // The GraphQL API ID. + // The Function ID. // // This member is required. - ApiId *string + FunctionId *string } type GetFunctionOutput struct { diff --git a/service/appsync/api_op_GetIntrospectionSchema.go b/service/appsync/api_op_GetIntrospectionSchema.go index b1a39671239..f6be333fbf7 100644 --- a/service/appsync/api_op_GetIntrospectionSchema.go +++ b/service/appsync/api_op_GetIntrospectionSchema.go @@ -57,10 +57,6 @@ func (c *Client) GetIntrospectionSchema(ctx context.Context, params *GetIntrospe type GetIntrospectionSchemaInput struct { - // A flag that specifies whether the schema introspection should contain - // directives. - IncludeDirectives *bool - // The API ID. // // This member is required. @@ -70,6 +66,10 @@ type GetIntrospectionSchemaInput struct { // // This member is required. Format types.OutputType + + // A flag that specifies whether the schema introspection should contain + // directives. + IncludeDirectives *bool } type GetIntrospectionSchemaOutput struct { diff --git a/service/appsync/api_op_GetResolver.go b/service/appsync/api_op_GetResolver.go index ca9d3c293c9..ef942dbb969 100644 --- a/service/appsync/api_op_GetResolver.go +++ b/service/appsync/api_op_GetResolver.go @@ -57,20 +57,20 @@ func (c *Client) GetResolver(ctx context.Context, params *GetResolverInput, optF type GetResolverInput struct { - // The resolver type name. + // The API ID. // // This member is required. - TypeName *string + ApiId *string // The resolver field name. // // This member is required. FieldName *string - // The API ID. + // The resolver type name. // // This member is required. - ApiId *string + TypeName *string } type GetResolverOutput struct { diff --git a/service/appsync/api_op_GetType.go b/service/appsync/api_op_GetType.go index 2f159b1fb68..ad948562ffc 100644 --- a/service/appsync/api_op_GetType.go +++ b/service/appsync/api_op_GetType.go @@ -57,11 +57,6 @@ func (c *Client) GetType(ctx context.Context, params *GetTypeInput, optFns ...fu type GetTypeInput struct { - // The type name. - // - // This member is required. - TypeName *string - // The API ID. // // This member is required. @@ -71,6 +66,11 @@ type GetTypeInput struct { // // This member is required. Format types.TypeDefinitionFormat + + // The type name. + // + // This member is required. + TypeName *string } type GetTypeOutput struct { diff --git a/service/appsync/api_op_ListDataSources.go b/service/appsync/api_op_ListDataSources.go index c3894c710b4..dbe77614d9b 100644 --- a/service/appsync/api_op_ListDataSources.go +++ b/service/appsync/api_op_ListDataSources.go @@ -57,10 +57,6 @@ func (c *Client) ListDataSources(ctx context.Context, params *ListDataSourcesInp type ListDataSourcesInput struct { - // An identifier that was returned from the previous call to this operation, which - // can be used to return the next set of items in the list. - NextToken *string - // The API ID. // // This member is required. @@ -68,17 +64,21 @@ type ListDataSourcesInput struct { // The maximum number of results you want the request to return. MaxResults *int32 + + // An identifier that was returned from the previous call to this operation, which + // can be used to return the next set of items in the list. + NextToken *string } type ListDataSourcesOutput struct { + // The DataSource objects. + DataSources []*types.DataSource + // An identifier to be passed in the next request to this operation to return the // next set of items in the list. NextToken *string - // The DataSource objects. - DataSources []*types.DataSource - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/appsync/api_op_ListFunctions.go b/service/appsync/api_op_ListFunctions.go index dc789df96cc..9b85ec29a69 100644 --- a/service/appsync/api_op_ListFunctions.go +++ b/service/appsync/api_op_ListFunctions.go @@ -57,10 +57,6 @@ func (c *Client) ListFunctions(ctx context.Context, params *ListFunctionsInput, type ListFunctionsInput struct { - // An identifier that was returned from the previous call to this operation, which - // can be used to return the next set of items in the list. - NextToken *string - // The GraphQL API ID. // // This member is required. @@ -68,6 +64,10 @@ type ListFunctionsInput struct { // The maximum number of results you want the request to return. MaxResults *int32 + + // An identifier that was returned from the previous call to this operation, which + // can be used to return the next set of items in the list. + NextToken *string } type ListFunctionsOutput struct { diff --git a/service/appsync/api_op_ListGraphqlApis.go b/service/appsync/api_op_ListGraphqlApis.go index 74318b4219b..7c303392b55 100644 --- a/service/appsync/api_op_ListGraphqlApis.go +++ b/service/appsync/api_op_ListGraphqlApis.go @@ -66,13 +66,13 @@ type ListGraphqlApisInput struct { type ListGraphqlApisOutput struct { + // The GraphqlApi objects. + GraphqlApis []*types.GraphqlApi + // An identifier to be passed in the next request to this operation to return the // next set of items in the list. NextToken *string - // The GraphqlApi objects. - GraphqlApis []*types.GraphqlApi - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/appsync/api_op_ListResolvers.go b/service/appsync/api_op_ListResolvers.go index 0d4b07e82d4..30bd1bbf25d 100644 --- a/service/appsync/api_op_ListResolvers.go +++ b/service/appsync/api_op_ListResolvers.go @@ -57,33 +57,33 @@ func (c *Client) ListResolvers(ctx context.Context, params *ListResolversInput, type ListResolversInput struct { - // An identifier that was returned from the previous call to this operation, which - // can be used to return the next set of items in the list. - NextToken *string - - // The type name. + // The API ID. // // This member is required. - TypeName *string + ApiId *string - // The API ID. + // The type name. // // This member is required. - ApiId *string + TypeName *string // The maximum number of results you want the request to return. MaxResults *int32 + + // An identifier that was returned from the previous call to this operation, which + // can be used to return the next set of items in the list. + NextToken *string } type ListResolversOutput struct { - // The Resolver objects. - Resolvers []*types.Resolver - // An identifier to be passed in the next request to this operation to return the // next set of items in the list. NextToken *string + // The Resolver objects. + Resolvers []*types.Resolver + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/appsync/api_op_ListResolversByFunction.go b/service/appsync/api_op_ListResolversByFunction.go index 9a97c17f2b7..74b2fb10cbc 100644 --- a/service/appsync/api_op_ListResolversByFunction.go +++ b/service/appsync/api_op_ListResolversByFunction.go @@ -57,32 +57,32 @@ func (c *Client) ListResolversByFunction(ctx context.Context, params *ListResolv type ListResolversByFunctionInput struct { - // The Function ID. + // The API ID. // // This member is required. - FunctionId *string + ApiId *string - // The API ID. + // The Function ID. // // This member is required. - ApiId *string + FunctionId *string + + // The maximum number of results you want the request to return. + MaxResults *int32 // An identifier that was returned from the previous call to this operation, which // you can use to return the next set of items in the list. NextToken *string - - // The maximum number of results you want the request to return. - MaxResults *int32 } type ListResolversByFunctionOutput struct { - // The list of resolvers. - Resolvers []*types.Resolver - // An identifier that can be used to return the next set of items in the list. NextToken *string + // The list of resolvers. + Resolvers []*types.Resolver + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/appsync/api_op_ListTypes.go b/service/appsync/api_op_ListTypes.go index 491436548e6..eb398ea3202 100644 --- a/service/appsync/api_op_ListTypes.go +++ b/service/appsync/api_op_ListTypes.go @@ -57,9 +57,6 @@ func (c *Client) ListTypes(ctx context.Context, params *ListTypesInput, optFns . type ListTypesInput struct { - // The maximum number of results you want the request to return. - MaxResults *int32 - // The API ID. // // This member is required. @@ -70,6 +67,9 @@ type ListTypesInput struct { // This member is required. Format types.TypeDefinitionFormat + // The maximum number of results you want the request to return. + MaxResults *int32 + // An identifier that was returned from the previous call to this operation, which // can be used to return the next set of items in the list. NextToken *string diff --git a/service/appsync/api_op_StartSchemaCreation.go b/service/appsync/api_op_StartSchemaCreation.go index c0b149fe8ca..40e16dd77ea 100644 --- a/service/appsync/api_op_StartSchemaCreation.go +++ b/service/appsync/api_op_StartSchemaCreation.go @@ -58,15 +58,15 @@ func (c *Client) StartSchemaCreation(ctx context.Context, params *StartSchemaCre type StartSchemaCreationInput struct { - // The schema definition, in GraphQL schema language format. + // The API ID. // // This member is required. - Definition []byte + ApiId *string - // The API ID. + // The schema definition, in GraphQL schema language format. // // This member is required. - ApiId *string + Definition []byte } type StartSchemaCreationOutput struct { diff --git a/service/appsync/api_op_UntagResource.go b/service/appsync/api_op_UntagResource.go index 3c279772118..bc556b40428 100644 --- a/service/appsync/api_op_UntagResource.go +++ b/service/appsync/api_op_UntagResource.go @@ -56,15 +56,15 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // A list of TagKey objects. + // The GraphqlApi ARN. // // This member is required. - TagKeys []*string + ResourceArn *string - // The GraphqlApi ARN. + // A list of TagKey objects. // // This member is required. - ResourceArn *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/appsync/api_op_UpdateApiCache.go b/service/appsync/api_op_UpdateApiCache.go index 97b96b23e65..84485a53c50 100644 --- a/service/appsync/api_op_UpdateApiCache.go +++ b/service/appsync/api_op_UpdateApiCache.go @@ -58,11 +58,26 @@ func (c *Client) UpdateApiCache(ctx context.Context, params *UpdateApiCacheInput // Represents the input of a UpdateApiCache operation. type UpdateApiCacheInput struct { + // Caching behavior. + // + // * FULL_REQUEST_CACHING: All requests are fully cached. + // + // + // * PER_RESOLVER_CACHING: Individual resovlers that you specify are cached. + // + // This member is required. + ApiCachingBehavior types.ApiCachingBehavior + // The GraphQL API Id. // // This member is required. ApiId *string + // TTL in seconds for cache entries. Valid values are between 1 and 3600 seconds. + // + // This member is required. + Ttl *int64 + // The cache instance type. // // * T2_SMALL: A t2.small instance type. @@ -85,21 +100,6 @@ type UpdateApiCacheInput struct { // // This member is required. Type types.ApiCacheType - - // Caching behavior. - // - // * FULL_REQUEST_CACHING: All requests are fully cached. - // - // - // * PER_RESOLVER_CACHING: Individual resovlers that you specify are cached. - // - // This member is required. - ApiCachingBehavior types.ApiCachingBehavior - - // TTL in seconds for cache entries. Valid values are between 1 and 3600 seconds. - // - // This member is required. - Ttl *int64 } // Represents the output of a UpdateApiCache operation. diff --git a/service/appsync/api_op_UpdateApiKey.go b/service/appsync/api_op_UpdateApiKey.go index 0528f106e43..05fe02ec152 100644 --- a/service/appsync/api_op_UpdateApiKey.go +++ b/service/appsync/api_op_UpdateApiKey.go @@ -57,22 +57,22 @@ func (c *Client) UpdateApiKey(ctx context.Context, params *UpdateApiKeyInput, op type UpdateApiKeyInput struct { - // The time from update time after which the API key expires. The date is - // represented as seconds since the epoch. For more information, see . - Expires *int64 - // The ID for the GraphQL API. // // This member is required. ApiId *string - // A description of the purpose of the API key. - Description *string - // The API key ID. // // This member is required. Id *string + + // A description of the purpose of the API key. + Description *string + + // The time from update time after which the API key expires. The date is + // represented as seconds since the epoch. For more information, see . + Expires *int64 } type UpdateApiKeyOutput struct { diff --git a/service/appsync/api_op_UpdateDataSource.go b/service/appsync/api_op_UpdateDataSource.go index 81822bd4ec9..ffc01908b5b 100644 --- a/service/appsync/api_op_UpdateDataSource.go +++ b/service/appsync/api_op_UpdateDataSource.go @@ -57,41 +57,41 @@ func (c *Client) UpdateDataSource(ctx context.Context, params *UpdateDataSourceI type UpdateDataSourceInput struct { - // The new Amazon DynamoDB configuration. - DynamodbConfig *types.DynamodbDataSourceConfig - // The API ID. // // This member is required. ApiId *string - // The new relational database configuration. - RelationalDatabaseConfig *types.RelationalDatabaseDataSourceConfig + // The new name for the data source. + // + // This member is required. + Name *string // The new data source type. // // This member is required. Type types.DataSourceType - // The new AWS Lambda configuration. - LambdaConfig *types.LambdaDataSourceConfig - - // The new service role ARN for the data source. - ServiceRoleArn *string - // The new description for the data source. Description *string - // The new name for the data source. - // - // This member is required. - Name *string + // The new Amazon DynamoDB configuration. + DynamodbConfig *types.DynamodbDataSourceConfig + + // The new Elasticsearch Service configuration. + ElasticsearchConfig *types.ElasticsearchDataSourceConfig // The new HTTP endpoint configuration. HttpConfig *types.HttpDataSourceConfig - // The new Elasticsearch Service configuration. - ElasticsearchConfig *types.ElasticsearchDataSourceConfig + // The new AWS Lambda configuration. + LambdaConfig *types.LambdaDataSourceConfig + + // The new relational database configuration. + RelationalDatabaseConfig *types.RelationalDatabaseDataSourceConfig + + // The new service role ARN for the data source. + ServiceRoleArn *string } type UpdateDataSourceOutput struct { diff --git a/service/appsync/api_op_UpdateFunction.go b/service/appsync/api_op_UpdateFunction.go index 378bc83b215..e01038d9ce6 100644 --- a/service/appsync/api_op_UpdateFunction.go +++ b/service/appsync/api_op_UpdateFunction.go @@ -62,20 +62,6 @@ type UpdateFunctionInput struct { // This member is required. ApiId *string - // The Function description. - Description *string - - // The Function request mapping template. Functions support only the 2018-05-29 - // version of the request mapping template. - // - // This member is required. - RequestMappingTemplate *string - - // The Function name. - // - // This member is required. - Name *string - // The FunctionDataSource name. // // This member is required. @@ -86,14 +72,28 @@ type UpdateFunctionInput struct { // This member is required. FunctionId *string - // The Function request mapping template. - ResponseMappingTemplate *string - // The version of the request mapping template. Currently the supported value is // 2018-05-29. // // This member is required. FunctionVersion *string + + // The Function name. + // + // This member is required. + Name *string + + // The Function request mapping template. Functions support only the 2018-05-29 + // version of the request mapping template. + // + // This member is required. + RequestMappingTemplate *string + + // The Function description. + Description *string + + // The Function request mapping template. + ResponseMappingTemplate *string } type UpdateFunctionOutput struct { diff --git a/service/appsync/api_op_UpdateGraphqlApi.go b/service/appsync/api_op_UpdateGraphqlApi.go index c0eb9cccffc..f60914619b3 100644 --- a/service/appsync/api_op_UpdateGraphqlApi.go +++ b/service/appsync/api_op_UpdateGraphqlApi.go @@ -57,33 +57,33 @@ func (c *Client) UpdateGraphqlApi(ctx context.Context, params *UpdateGraphqlApiI type UpdateGraphqlApiInput struct { - // The Amazon CloudWatch Logs configuration for the GraphqlApi object. - LogConfig *types.LogConfig + // The API ID. + // + // This member is required. + ApiId *string + + // The new name for the GraphqlApi object. + // + // This member is required. + Name *string // A list of additional authentication providers for the GraphqlApi API. AdditionalAuthenticationProviders []*types.AdditionalAuthenticationProvider - // A flag indicating whether to enable X-Ray tracing for the GraphqlApi. - XrayEnabled *bool - - // The new Amazon Cognito user pool configuration for the GraphqlApi object. - UserPoolConfig *types.UserPoolConfig - // The new authentication type for the GraphqlApi object. AuthenticationType types.AuthenticationType + // The Amazon CloudWatch Logs configuration for the GraphqlApi object. + LogConfig *types.LogConfig + // The OpenID Connect configuration for the GraphqlApi object. OpenIDConnectConfig *types.OpenIDConnectConfig - // The new name for the GraphqlApi object. - // - // This member is required. - Name *string + // The new Amazon Cognito user pool configuration for the GraphqlApi object. + UserPoolConfig *types.UserPoolConfig - // The API ID. - // - // This member is required. - ApiId *string + // A flag indicating whether to enable X-Ray tracing for the GraphqlApi. + XrayEnabled *bool } type UpdateGraphqlApiOutput struct { diff --git a/service/appsync/api_op_UpdateResolver.go b/service/appsync/api_op_UpdateResolver.go index c56df776ff6..e482b1a8f97 100644 --- a/service/appsync/api_op_UpdateResolver.go +++ b/service/appsync/api_op_UpdateResolver.go @@ -57,11 +57,32 @@ func (c *Client) UpdateResolver(ctx context.Context, params *UpdateResolverInput type UpdateResolverInput struct { + // The API ID. + // + // This member is required. + ApiId *string + + // The new field name. + // + // This member is required. + FieldName *string + // The new request mapping template. // // This member is required. RequestMappingTemplate *string + // The new type name. + // + // This member is required. + TypeName *string + + // The caching configuration for the resolver. + CachingConfig *types.CachingConfig + + // The new data source name. + DataSourceName *string + // The resolver type. // // * UNIT: A UNIT resolver type. A UNIT resolver is the @@ -74,35 +95,14 @@ type UpdateResolverInput struct { // multiple data sources. Kind types.ResolverKind - // The new data source name. - DataSourceName *string - // The PipelineConfig. PipelineConfig *types.PipelineConfig - // The SyncConfig for a resolver attached to a versioned datasource. - SyncConfig *types.SyncConfig - - // The new type name. - // - // This member is required. - TypeName *string - - // The API ID. - // - // This member is required. - ApiId *string - // The new response mapping template. ResponseMappingTemplate *string - // The caching configuration for the resolver. - CachingConfig *types.CachingConfig - - // The new field name. - // - // This member is required. - FieldName *string + // The SyncConfig for a resolver attached to a versioned datasource. + SyncConfig *types.SyncConfig } type UpdateResolverOutput struct { diff --git a/service/appsync/api_op_UpdateType.go b/service/appsync/api_op_UpdateType.go index df646ffb242..341f9ac33d1 100644 --- a/service/appsync/api_op_UpdateType.go +++ b/service/appsync/api_op_UpdateType.go @@ -57,6 +57,11 @@ func (c *Client) UpdateType(ctx context.Context, params *UpdateTypeInput, optFns type UpdateTypeInput struct { + // The API ID. + // + // This member is required. + ApiId *string + // The new type format: SDL or JSON. // // This member is required. @@ -67,11 +72,6 @@ type UpdateTypeInput struct { // This member is required. TypeName *string - // The API ID. - // - // This member is required. - ApiId *string - // The new definition. Definition *string } diff --git a/service/appsync/go.mod b/service/appsync/go.mod index c65270e0fa9..3d526530852 100644 --- a/service/appsync/go.mod +++ b/service/appsync/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/appsync go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/appsync/types/types.go b/service/appsync/types/types.go index 010db7d0ae0..d68688e236d 100644 --- a/service/appsync/types/types.go +++ b/service/appsync/types/types.go @@ -5,14 +5,14 @@ package types // Describes an additional authentication provider. type AdditionalAuthenticationProvider struct { - // The Amazon Cognito user pool configuration. - UserPoolConfig *CognitoUserPoolConfig + // The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools. + AuthenticationType AuthenticationType // The OpenID Connect configuration. OpenIDConnectConfig *OpenIDConnectConfig - // The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools. - AuthenticationType AuthenticationType + // The Amazon Cognito user pool configuration. + UserPoolConfig *CognitoUserPoolConfig } // The ApiCache object. @@ -26,6 +26,10 @@ type ApiCache struct { // * PER_RESOLVER_CACHING: Individual resovlers that you specify are cached. ApiCachingBehavior ApiCachingBehavior + // At rest encryption flag for cache. This setting cannot be updated after + // creation. + AtRestEncryptionEnabled *bool + // The cache instance status. // // * AVAILABLE: The instance is available for @@ -42,6 +46,13 @@ type ApiCache struct { // * FAILED: The instance has failed creation. Status ApiCacheStatus + // Transit encryption flag when connecting to cache. This setting cannot be updated + // after creation. + TransitEncryptionEnabled *bool + + // TTL in seconds for cache entries. Valid values are between 1 and 3600 seconds. + Ttl *int64 + // The cache instance type. // // * T2_SMALL: A t2.small instance type. @@ -62,17 +73,6 @@ type ApiCache struct { // * // R4_8XLARGE: A r4.8xlarge instance type. Type ApiCacheType - - // TTL in seconds for cache entries. Valid values are between 1 and 3600 seconds. - Ttl *int64 - - // Transit encryption flag when connecting to cache. This setting cannot be updated - // after creation. - TransitEncryptionEnabled *bool - - // At rest encryption flag for cache. This setting cannot be updated after - // creation. - AtRestEncryptionEnabled *bool } // Describes an API key. Customers invoke AWS AppSync GraphQL API operations with @@ -119,15 +119,15 @@ type ApiCache struct { // seconds. type ApiKey struct { - // The API key ID. - Id *string + // A description of the purpose of the API key. + Description *string // The time after which the API key expires. The date is represented as seconds // since the epoch, rounded down to the nearest hour. Expires *int64 - // A description of the purpose of the API key. - Description *string + // The API key ID. + Id *string } // The authorization config in case the HTTP endpoint requires authorization. @@ -158,23 +158,19 @@ type AwsIamConfig struct { // The caching configuration for a resolver that has caching enabled. type CachingConfig struct { - // The TTL in seconds for a resolver that has caching enabled. Valid values are - // between 1 and 3600 seconds. - Ttl *int64 - // The caching keys for a resolver that has caching enabled. Valid values are // entries from the $context.arguments, $context.source, and $context.identity // maps. CachingKeys []*string + + // The TTL in seconds for a resolver that has caching enabled. Valid values are + // between 1 and 3600 seconds. + Ttl *int64 } // Describes an Amazon Cognito user pool configuration. type CognitoUserPoolConfig struct { - // A regular expression for validating the incoming Amazon Cognito user pool app - // client ID. - AppIdClientRegex *string - // The AWS Region in which the user pool was created. // // This member is required. @@ -184,11 +180,43 @@ type CognitoUserPoolConfig struct { // // This member is required. UserPoolId *string + + // A regular expression for validating the incoming Amazon Cognito user pool app + // client ID. + AppIdClientRegex *string } // Describes a data source. type DataSource struct { + // The data source ARN. + DataSourceArn *string + + // The description of the data source. + Description *string + + // Amazon DynamoDB settings. + DynamodbConfig *DynamodbDataSourceConfig + + // Amazon Elasticsearch Service settings. + ElasticsearchConfig *ElasticsearchDataSourceConfig + + // HTTP endpoint settings. + HttpConfig *HttpDataSourceConfig + + // AWS Lambda settings. + LambdaConfig *LambdaDataSourceConfig + + // The name of the data source. + Name *string + + // Relational database settings. + RelationalDatabaseConfig *RelationalDatabaseDataSourceConfig + + // The AWS IAM service role ARN for the data source. The system assumes this role + // when accessing the data source. + ServiceRoleArn *string + // The type of the data source. // // * AMAZON_DYNAMODB: The data source is an @@ -210,45 +238,17 @@ type DataSource struct { // // * RELATIONAL_DATABASE: The data source is a relational database. Type DataSourceType - - // Relational database settings. - RelationalDatabaseConfig *RelationalDatabaseDataSourceConfig - - // Amazon Elasticsearch Service settings. - ElasticsearchConfig *ElasticsearchDataSourceConfig - - // AWS Lambda settings. - LambdaConfig *LambdaDataSourceConfig - - // The AWS IAM service role ARN for the data source. The system assumes this role - // when accessing the data source. - ServiceRoleArn *string - - // The description of the data source. - Description *string - - // Amazon DynamoDB settings. - DynamodbConfig *DynamodbDataSourceConfig - - // HTTP endpoint settings. - HttpConfig *HttpDataSourceConfig - - // The data source ARN. - DataSourceArn *string - - // The name of the data source. - Name *string } // Describes a Delta Sync configuration. type DeltaSyncConfig struct { - // The Delta Sync table name. - DeltaSyncTableName *string - // The number of minutes an Item is stored in the datasource. BaseTableTTL *int64 + // The Delta Sync table name. + DeltaSyncTableName *string + // The number of minutes a Delta Sync log entry is stored in the Delta Sync table. DeltaSyncTableTTL *int64 } @@ -261,39 +261,48 @@ type DynamodbDataSourceConfig struct { // This member is required. AwsRegion *string + // The table name. + // + // This member is required. + TableName *string + + // The DeltaSyncConfig for a versioned datasource. + DeltaSyncConfig *DeltaSyncConfig + // Set to TRUE to use Amazon Cognito credentials with this data source. UseCallerCredentials *bool // Set to TRUE to use Conflict Detection and Resolution with this data source. Versioned *bool - - // The DeltaSyncConfig for a versioned datasource. - DeltaSyncConfig *DeltaSyncConfig - - // The table name. - // - // This member is required. - TableName *string } // Describes an Elasticsearch data source configuration. type ElasticsearchDataSourceConfig struct { - // The endpoint. + // The AWS Region. // // This member is required. - Endpoint *string + AwsRegion *string - // The AWS Region. + // The endpoint. // // This member is required. - AwsRegion *string + Endpoint *string } // A function is a reusable entity. Multiple functions can be used to compose the // resolver logic. type FunctionConfiguration struct { + // The name of the DataSource. + DataSourceName *string + + // The Function description. + Description *string + + // The ARN of the Function object. + FunctionArn *string + // A unique ID representing the Function object. FunctionId *string @@ -301,46 +310,43 @@ type FunctionConfiguration struct { // version of the template is supported. FunctionVersion *string - // The Function response mapping template. - ResponseMappingTemplate *string - // The name of the Function object. Name *string - // The name of the DataSource. - DataSourceName *string - - // The ARN of the Function object. - FunctionArn *string - // The Function request mapping template. Functions support only the 2018-05-29 // version of the request mapping template. RequestMappingTemplate *string - // The Function description. - Description *string + // The Function response mapping template. + ResponseMappingTemplate *string } // Describes a GraphQL API. type GraphqlApi struct { - // The tags. - Tags map[string]*string + // A list of additional authentication providers for the GraphqlApi API. + AdditionalAuthenticationProviders []*AdditionalAuthenticationProvider - // A flag representing whether X-Ray tracing is enabled for this GraphqlApi. - XrayEnabled *bool + // The API ID. + ApiId *string - // The Amazon CloudWatch Logs configuration. - LogConfig *LogConfig + // The ARN. + Arn *string // The authentication type. AuthenticationType AuthenticationType + // The Amazon CloudWatch Logs configuration. + LogConfig *LogConfig + // The API name. Name *string - // The ARN. - Arn *string + // The OpenID Connect configuration. + OpenIDConnectConfig *OpenIDConnectConfig + + // The tags. + Tags map[string]*string // The URIs. Uris map[string]*string @@ -348,27 +354,21 @@ type GraphqlApi struct { // The Amazon Cognito user pool configuration. UserPoolConfig *UserPoolConfig - // The API ID. - ApiId *string - - // The OpenID Connect configuration. - OpenIDConnectConfig *OpenIDConnectConfig - - // A list of additional authentication providers for the GraphqlApi API. - AdditionalAuthenticationProviders []*AdditionalAuthenticationProvider + // A flag representing whether X-Ray tracing is enabled for this GraphqlApi. + XrayEnabled *bool } // Describes an HTTP data source configuration. type HttpDataSourceConfig struct { + // The authorization config in case the HTTP endpoint requires authorization. + AuthorizationConfig *AuthorizationConfig + // The HTTP URL endpoint. You can either specify the domain name or IP, and port // combination, and the URL scheme must be HTTP or HTTPS. If the port is not // specified, AWS AppSync uses the default port 80 for the HTTP endpoint and port // 443 for HTTPS endpoints. Endpoint *string - - // The authorization config in case the HTTP endpoint requires authorization. - AuthorizationConfig *AuthorizationConfig } // The LambdaConflictHandlerConfig object when configuring LAMBDA as the Conflict @@ -391,6 +391,12 @@ type LambdaDataSourceConfig struct { // The CloudWatch Logs configuration. type LogConfig struct { + // The service role that AWS AppSync will assume to publish to Amazon CloudWatch + // logs in your account. + // + // This member is required. + CloudWatchLogsRoleArn *string + // The field logging level. Values can be NONE, ERROR, or ALL. // // * NONE: No @@ -422,34 +428,28 @@ type LogConfig struct { // Set to TRUE to exclude sections that contain information such as headers, // context, and evaluated mapping templates, regardless of logging level. ExcludeVerboseContent *bool - - // The service role that AWS AppSync will assume to publish to Amazon CloudWatch - // logs in your account. - // - // This member is required. - CloudWatchLogsRoleArn *string } // Describes an OpenID Connect configuration. type OpenIDConnectConfig struct { + // The issuer for the OpenID Connect configuration. The issuer returned by + // discovery must exactly match the value of iss in the ID token. + // + // This member is required. + Issuer *string + // The number of milliseconds a token is valid after being authenticated. AuthTTL *int64 - // The number of milliseconds a token is valid after being issued to a user. - IatTTL *int64 - // The client identifier of the Relying party at the OpenID identity provider. This // identifier is typically obtained when the Relying party is registered with the // OpenID identity provider. You can specify a regular expression so the AWS // AppSync can validate against multiple client identifiers at a time. ClientId *string - // The issuer for the OpenID Connect configuration. The issuer returned by - // discovery must exactly match the value of iss in the ID token. - // - // This member is required. - Issuer *string + // The number of milliseconds a token is valid after being issued to a user. + IatTTL *int64 } // The pipeline configuration for a resolver of kind PIPELINE. @@ -462,20 +462,20 @@ type PipelineConfig struct { // The Amazon RDS HTTP endpoint configuration. type RdsHttpEndpointConfig struct { - // Logical database name. - DatabaseName *string - // AWS Region for RDS HTTP endpoint. AwsRegion *string + // AWS secret store ARN for database credentials. + AwsSecretStoreArn *string + + // Logical database name. + DatabaseName *string + // Amazon RDS cluster ARN. DbClusterIdentifier *string // Logical schema name. Schema *string - - // AWS secret store ARN for database credentials. - AwsSecretStoreArn *string } // Describes a relational database data source configuration. @@ -494,33 +494,15 @@ type RelationalDatabaseDataSourceConfig struct { // Describes a resolver. type Resolver struct { - // The SyncConfig for a resolver attached to a versioned datasource. - SyncConfig *SyncConfig - - // The resolver type name. - TypeName *string - // The caching configuration for the resolver. CachingConfig *CachingConfig // The resolver data source name. DataSourceName *string - // The response mapping template. - ResponseMappingTemplate *string - - // The request mapping template. - RequestMappingTemplate *string - // The resolver field name. FieldName *string - // The resolver ARN. - ResolverArn *string - - // The PipelineConfig. - PipelineConfig *PipelineConfig - // The resolver type. // // * UNIT: A UNIT resolver type. A UNIT resolver is the @@ -532,6 +514,24 @@ type Resolver struct { // manner. You can use a pipeline resolver to execute a GraphQL query against // multiple data sources. Kind ResolverKind + + // The PipelineConfig. + PipelineConfig *PipelineConfig + + // The request mapping template. + RequestMappingTemplate *string + + // The resolver ARN. + ResolverArn *string + + // The response mapping template. + ResponseMappingTemplate *string + + // The SyncConfig for a resolver attached to a versioned datasource. + SyncConfig *SyncConfig + + // The resolver type name. + TypeName *string } // Describes a Sync configuration for a resolver. Contains information on which @@ -539,6 +539,15 @@ type Resolver struct { // resolver is invoked. type SyncConfig struct { + // The Conflict Detection strategy to use. + // + // * VERSION: Detect conflicts based + // on object versions for this resolver. + // + // * NONE: Do not detect conflicts when + // executing this resolver. + ConflictDetection ConflictDetectionType + // The Conflict Resolution strategy to perform in the event of a conflict. // // * @@ -555,20 +564,14 @@ type SyncConfig struct { // The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler. LambdaConflictHandlerConfig *LambdaConflictHandlerConfig - - // The Conflict Detection strategy to use. - // - // * VERSION: Detect conflicts based - // on object versions for this resolver. - // - // * NONE: Do not detect conflicts when - // executing this resolver. - ConflictDetection ConflictDetectionType } // Describes a type. type Type struct { + // The type ARN. + Arn *string + // The type definition. Definition *string @@ -580,18 +583,11 @@ type Type struct { // The type name. Name *string - - // The type ARN. - Arn *string } // Describes an Amazon Cognito user pool configuration. type UserPoolConfig struct { - // A regular expression for validating the incoming Amazon Cognito user pool app - // client ID. - AppIdClientRegex *string - // The AWS Region in which the user pool was created. // // This member is required. @@ -608,4 +604,8 @@ type UserPoolConfig struct { // // This member is required. UserPoolId *string + + // A regular expression for validating the incoming Amazon Cognito user pool app + // client ID. + AppIdClientRegex *string } diff --git a/service/athena/api_op_BatchGetQueryExecution.go b/service/athena/api_op_BatchGetQueryExecution.go index 79f10a922c7..56e03ec8473 100644 --- a/service/athena/api_op_BatchGetQueryExecution.go +++ b/service/athena/api_op_BatchGetQueryExecution.go @@ -70,12 +70,12 @@ type BatchGetQueryExecutionInput struct { type BatchGetQueryExecutionOutput struct { - // Information about the query executions that failed to run. - UnprocessedQueryExecutionIds []*types.UnprocessedQueryExecutionId - // Information about a query execution. QueryExecutions []*types.QueryExecution + // Information about the query executions that failed to run. + UnprocessedQueryExecutionIds []*types.UnprocessedQueryExecutionId + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/athena/api_op_CreateDataCatalog.go b/service/athena/api_op_CreateDataCatalog.go index 22ee717bd8c..6cbe3f3ad7d 100644 --- a/service/athena/api_op_CreateDataCatalog.go +++ b/service/athena/api_op_CreateDataCatalog.go @@ -71,6 +71,9 @@ type CreateDataCatalogInput struct { // This member is required. Type types.DataCatalogType + // A description of the data catalog to be created. + Description *string + // Specifies the Lambda function or functions to use for creating the data catalog. // This is a mapping whose values depend on the catalog type. // @@ -97,9 +100,6 @@ type CreateDataCatalogInput struct { // A list of comma separated tags to add to the data catalog that is created. Tags []*types.Tag - - // A description of the data catalog to be created. - Description *string } type CreateDataCatalogOutput struct { diff --git a/service/athena/api_op_CreateNamedQuery.go b/service/athena/api_op_CreateNamedQuery.go index 64453599cef..3d6937647ad 100644 --- a/service/athena/api_op_CreateNamedQuery.go +++ b/service/athena/api_op_CreateNamedQuery.go @@ -61,11 +61,20 @@ func (c *Client) CreateNamedQuery(ctx context.Context, params *CreateNamedQueryI type CreateNamedQueryInput struct { - // The name of the workgroup in which the named query is being created. - WorkGroup *string + // The database to which the query belongs. + // + // This member is required. + Database *string - // The query description. - Description *string + // The query name. + // + // This member is required. + Name *string + + // The contents of the query with all query statements. + // + // This member is required. + QueryString *string // A unique case-sensitive string used to ensure the request to create the query is // idempotent (executes only once). If another CreateNamedQuery request is @@ -76,20 +85,11 @@ type CreateNamedQueryInput struct { // AWS CLI, you must provide this token or the action will fail. ClientRequestToken *string - // The contents of the query with all query statements. - // - // This member is required. - QueryString *string - - // The database to which the query belongs. - // - // This member is required. - Database *string + // The query description. + Description *string - // The query name. - // - // This member is required. - Name *string + // The name of the workgroup in which the named query is being created. + WorkGroup *string } type CreateNamedQueryOutput struct { diff --git a/service/athena/api_op_CreateWorkGroup.go b/service/athena/api_op_CreateWorkGroup.go index afc5d374475..ff6448dcbac 100644 --- a/service/athena/api_op_CreateWorkGroup.go +++ b/service/athena/api_op_CreateWorkGroup.go @@ -57,11 +57,10 @@ func (c *Client) CreateWorkGroup(ctx context.Context, params *CreateWorkGroupInp type CreateWorkGroupInput struct { - // A list of comma separated tags to add to the workgroup that is created. - Tags []*types.Tag - - // The workgroup description. - Description *string + // The workgroup name. + // + // This member is required. + Name *string // The configuration for the workgroup, which includes the location in Amazon S3 // where query results are stored, the encryption configuration, if any, used for @@ -73,10 +72,11 @@ type CreateWorkGroupInput struct { // (). Configuration *types.WorkGroupConfiguration - // The workgroup name. - // - // This member is required. - Name *string + // The workgroup description. + Description *string + + // A list of comma separated tags to add to the workgroup that is created. + Tags []*types.Tag } type CreateWorkGroupOutput struct { diff --git a/service/athena/api_op_DeleteWorkGroup.go b/service/athena/api_op_DeleteWorkGroup.go index 101f10bcb81..be0c1b8846f 100644 --- a/service/athena/api_op_DeleteWorkGroup.go +++ b/service/athena/api_op_DeleteWorkGroup.go @@ -57,14 +57,14 @@ func (c *Client) DeleteWorkGroup(ctx context.Context, params *DeleteWorkGroupInp type DeleteWorkGroupInput struct { - // The option to delete the workgroup and its contents even if the workgroup - // contains any named queries. - RecursiveDeleteOption *bool - // The unique name of the workgroup to delete. // // This member is required. WorkGroup *string + + // The option to delete the workgroup and its contents even if the workgroup + // contains any named queries. + RecursiveDeleteOption *bool } type DeleteWorkGroupOutput struct { diff --git a/service/athena/api_op_GetDatabase.go b/service/athena/api_op_GetDatabase.go index 6fc5f10ce5a..cf4575bd6e4 100644 --- a/service/athena/api_op_GetDatabase.go +++ b/service/athena/api_op_GetDatabase.go @@ -57,15 +57,15 @@ func (c *Client) GetDatabase(ctx context.Context, params *GetDatabaseInput, optF type GetDatabaseInput struct { - // The name of the database to return. + // The name of the data catalog that contains the database to return. // // This member is required. - DatabaseName *string + CatalogName *string - // The name of the data catalog that contains the database to return. + // The name of the database to return. // // This member is required. - CatalogName *string + DatabaseName *string } type GetDatabaseOutput struct { diff --git a/service/athena/api_op_GetQueryResults.go b/service/athena/api_op_GetQueryResults.go index ef42a8209d7..7a4d6fdc16b 100644 --- a/service/athena/api_op_GetQueryResults.go +++ b/service/athena/api_op_GetQueryResults.go @@ -68,11 +68,6 @@ func (c *Client) GetQueryResults(ctx context.Context, params *GetQueryResultsInp type GetQueryResultsInput struct { - // A token generated by the Athena service that specifies where to continue - // pagination if a previous request was truncated. To obtain the next set of pages, - // pass in the NextToken from the response object of the previous page call. - NextToken *string - // The unique ID of the query execution. // // This member is required. @@ -80,6 +75,11 @@ type GetQueryResultsInput struct { // The maximum number of results (rows) to return in this request. MaxResults *int32 + + // A token generated by the Athena service that specifies where to continue + // pagination if a previous request was truncated. To obtain the next set of pages, + // pass in the NextToken from the response object of the previous page call. + NextToken *string } type GetQueryResultsOutput struct { diff --git a/service/athena/api_op_GetTableMetadata.go b/service/athena/api_op_GetTableMetadata.go index 533d02962b7..c501430491b 100644 --- a/service/athena/api_op_GetTableMetadata.go +++ b/service/athena/api_op_GetTableMetadata.go @@ -63,15 +63,15 @@ type GetTableMetadataInput struct { // This member is required. CatalogName *string - // The name of the table for which metadata is returned. + // The name of the database that contains the table metadata to return. // // This member is required. - TableName *string + DatabaseName *string - // The name of the database that contains the table metadata to return. + // The name of the table for which metadata is returned. // // This member is required. - DatabaseName *string + TableName *string } type GetTableMetadataOutput struct { diff --git a/service/athena/api_op_ListDataCatalogs.go b/service/athena/api_op_ListDataCatalogs.go index 053bb67a30b..e242e7a9eee 100644 --- a/service/athena/api_op_ListDataCatalogs.go +++ b/service/athena/api_op_ListDataCatalogs.go @@ -67,14 +67,14 @@ type ListDataCatalogsInput struct { type ListDataCatalogsOutput struct { + // A summary list of data catalogs. + DataCatalogsSummary []*types.DataCatalogSummary + // A token generated by the Athena service that specifies where to continue // pagination if a previous request was truncated. To obtain the next set of pages, // pass in the NextToken from the response object of the previous page call. NextToken *string - // A summary list of data catalogs. - DataCatalogsSummary []*types.DataCatalogSummary - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/athena/api_op_ListDatabases.go b/service/athena/api_op_ListDatabases.go index 768a9cfd9ec..b394b58d670 100644 --- a/service/athena/api_op_ListDatabases.go +++ b/service/athena/api_op_ListDatabases.go @@ -62,13 +62,13 @@ type ListDatabasesInput struct { // This member is required. CatalogName *string + // Specifies the maximum number of results to return. + MaxResults *int32 + // A token generated by the Athena service that specifies where to continue // pagination if a previous request was truncated. To obtain the next set of pages, // pass in the NextToken from the response object of the previous page call. NextToken *string - - // Specifies the maximum number of results to return. - MaxResults *int32 } type ListDatabasesOutput struct { diff --git a/service/athena/api_op_ListNamedQueries.go b/service/athena/api_op_ListNamedQueries.go index 81604cb74e6..e5571f903ae 100644 --- a/service/athena/api_op_ListNamedQueries.go +++ b/service/athena/api_op_ListNamedQueries.go @@ -60,14 +60,14 @@ func (c *Client) ListNamedQueries(ctx context.Context, params *ListNamedQueriesI type ListNamedQueriesInput struct { + // The maximum number of queries to return in this request. + MaxResults *int32 + // A token generated by the Athena service that specifies where to continue // pagination if a previous request was truncated. To obtain the next set of pages, // pass in the NextToken from the response object of the previous page call. NextToken *string - // The maximum number of queries to return in this request. - MaxResults *int32 - // The name of the workgroup from which the named queries are being returned. If a // workgroup is not specified, the saved queries for the primary workgroup are // returned. diff --git a/service/athena/api_op_ListQueryExecutions.go b/service/athena/api_op_ListQueryExecutions.go index e40c44e9bcb..504802f738b 100644 --- a/service/athena/api_op_ListQueryExecutions.go +++ b/service/athena/api_op_ListQueryExecutions.go @@ -61,6 +61,9 @@ func (c *Client) ListQueryExecutions(ctx context.Context, params *ListQueryExecu type ListQueryExecutionsInput struct { + // The maximum number of query executions to return in this request. + MaxResults *int32 + // A token generated by the Athena service that specifies where to continue // pagination if a previous request was truncated. To obtain the next set of pages, // pass in the NextToken from the response object of the previous page call. @@ -70,19 +73,16 @@ type ListQueryExecutionsInput struct { // is not specified, a list of available query execution IDs for the queries in the // primary workgroup is returned. WorkGroup *string - - // The maximum number of query executions to return in this request. - MaxResults *int32 } type ListQueryExecutionsOutput struct { - // The unique IDs of each query execution as an array of strings. - QueryExecutionIds []*string - // A token to be used by the next request if this request is truncated. NextToken *string + // The unique IDs of each query execution as an array of strings. + QueryExecutionIds []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/athena/api_op_ListTableMetadata.go b/service/athena/api_op_ListTableMetadata.go index c87b60ef640..697e1e7c980 100644 --- a/service/athena/api_op_ListTableMetadata.go +++ b/service/athena/api_op_ListTableMetadata.go @@ -57,27 +57,27 @@ func (c *Client) ListTableMetadata(ctx context.Context, params *ListTableMetadat type ListTableMetadataInput struct { + // The name of the data catalog for which table metadata should be returned. + // + // This member is required. + CatalogName *string + // The name of the database for which table metadata should be returned. // // This member is required. DatabaseName *string - // A token generated by the Athena service that specifies where to continue - // pagination if a previous request was truncated. To obtain the next set of pages, - // pass in the NextToken from the response object of the previous page call. - NextToken *string - - // Specifies the maximum number of results to return. - MaxResults *int32 - // A regex filter that pattern-matches table names. If no expression is supplied, // metadata for all tables are listed. Expression *string - // The name of the data catalog for which table metadata should be returned. - // - // This member is required. - CatalogName *string + // Specifies the maximum number of results to return. + MaxResults *int32 + + // A token generated by the Athena service that specifies where to continue + // pagination if a previous request was truncated. To obtain the next set of pages, + // pass in the NextToken from the response object of the previous page call. + NextToken *string } type ListTableMetadataOutput struct { diff --git a/service/athena/api_op_ListTagsForResource.go b/service/athena/api_op_ListTagsForResource.go index db879ab9cbf..0b40f80da52 100644 --- a/service/athena/api_op_ListTagsForResource.go +++ b/service/athena/api_op_ListTagsForResource.go @@ -57,15 +57,15 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The maximum number of results to be returned per request that lists the tags for - // the resource. - MaxResults *int32 - // Lists the tags for the resource with the specified ARN. // // This member is required. ResourceARN *string + // The maximum number of results to be returned per request that lists the tags for + // the resource. + MaxResults *int32 + // The token for the next set of results, or null if there are no additional // results for this request, where the request lists the tags for the resource with // the specified ARN. diff --git a/service/athena/api_op_ListWorkGroups.go b/service/athena/api_op_ListWorkGroups.go index 6af60590bf6..10456954929 100644 --- a/service/athena/api_op_ListWorkGroups.go +++ b/service/athena/api_op_ListWorkGroups.go @@ -56,13 +56,13 @@ func (c *Client) ListWorkGroups(ctx context.Context, params *ListWorkGroupsInput type ListWorkGroupsInput struct { + // The maximum number of workgroups to return in this request. + MaxResults *int32 + // A token generated by the Athena service that specifies where to continue // pagination if a previous request was truncated. To obtain the next set of pages, // pass in the NextToken from the response object of the previous page call. NextToken *string - - // The maximum number of workgroups to return in this request. - MaxResults *int32 } type ListWorkGroupsOutput struct { diff --git a/service/athena/api_op_StartQueryExecution.go b/service/athena/api_op_StartQueryExecution.go index b083878ebff..6f2fa38fadb 100644 --- a/service/athena/api_op_StartQueryExecution.go +++ b/service/athena/api_op_StartQueryExecution.go @@ -64,17 +64,6 @@ func (c *Client) StartQueryExecution(ctx context.Context, params *StartQueryExec type StartQueryExecutionInput struct { - // The database within which the query executes. - QueryExecutionContext *types.QueryExecutionContext - - // Specifies information about where and how to save the results of the query - // execution. If the query runs in a workgroup, then workgroup's settings may - // override query settings. This affects the query results location. The workgroup - // settings override is specified in EnforceWorkGroupConfiguration (true/false) in - // the WorkGroupConfiguration. See - // WorkGroupConfiguration$EnforceWorkGroupConfiguration (). - ResultConfiguration *types.ResultConfiguration - // The SQL query statements to be executed. // // This member is required. @@ -89,6 +78,17 @@ type StartQueryExecutionInput struct { // AWS CLI, you must provide this token or the action will fail. ClientRequestToken *string + // The database within which the query executes. + QueryExecutionContext *types.QueryExecutionContext + + // Specifies information about where and how to save the results of the query + // execution. If the query runs in a workgroup, then workgroup's settings may + // override query settings. This affects the query results location. The workgroup + // settings override is specified in EnforceWorkGroupConfiguration (true/false) in + // the WorkGroupConfiguration. See + // WorkGroupConfiguration$EnforceWorkGroupConfiguration (). + ResultConfiguration *types.ResultConfiguration + // The name of the workgroup in which the query is being started. WorkGroup *string } diff --git a/service/athena/api_op_TagResource.go b/service/athena/api_op_TagResource.go index 682c7318d8c..edf6704c1d3 100644 --- a/service/athena/api_op_TagResource.go +++ b/service/athena/api_op_TagResource.go @@ -69,17 +69,17 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // A collection of one or more tags, separated by commas, to be added to an Athena - // workgroup or data catalog resource. - // - // This member is required. - Tags []*types.Tag - // Specifies the ARN of the Athena resource (workgroup or data catalog) to which // tags are to be added. // // This member is required. ResourceARN *string + + // A collection of one or more tags, separated by commas, to be added to an Athena + // workgroup or data catalog resource. + // + // This member is required. + Tags []*types.Tag } type TagResourceOutput struct { diff --git a/service/athena/api_op_UntagResource.go b/service/athena/api_op_UntagResource.go index 7dd8ad8099a..0e647f3bdb5 100644 --- a/service/athena/api_op_UntagResource.go +++ b/service/athena/api_op_UntagResource.go @@ -56,16 +56,16 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // A comma-separated list of one or more tag keys whose tags are to be removed from - // the specified resource. + // Specifies the ARN of the resource from which tags are to be removed. // // This member is required. - TagKeys []*string + ResourceARN *string - // Specifies the ARN of the resource from which tags are to be removed. + // A comma-separated list of one or more tag keys whose tags are to be removed from + // the specified resource. // // This member is required. - ResourceARN *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/athena/api_op_UpdateDataCatalog.go b/service/athena/api_op_UpdateDataCatalog.go index 14d33854092..e86ae91a36a 100644 --- a/service/athena/api_op_UpdateDataCatalog.go +++ b/service/athena/api_op_UpdateDataCatalog.go @@ -57,12 +57,6 @@ func (c *Client) UpdateDataCatalog(ctx context.Context, params *UpdateDataCatalo type UpdateDataCatalogInput struct { - // Specifies the type of data catalog to update. Specify LAMBDA for a federated - // catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore. - // - // This member is required. - Type types.DataCatalogType - // The name of the data catalog to update. The catalog name must be unique for the // AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or // hyphen characters. @@ -70,6 +64,12 @@ type UpdateDataCatalogInput struct { // This member is required. Name *string + // Specifies the type of data catalog to update. Specify LAMBDA for a federated + // catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore. + // + // This member is required. + Type types.DataCatalogType + // New or modified text that describes the data catalog. Description *string diff --git a/service/athena/api_op_UpdateWorkGroup.go b/service/athena/api_op_UpdateWorkGroup.go index 6ceaa661d91..02fba1ad78a 100644 --- a/service/athena/api_op_UpdateWorkGroup.go +++ b/service/athena/api_op_UpdateWorkGroup.go @@ -58,19 +58,19 @@ func (c *Client) UpdateWorkGroup(ctx context.Context, params *UpdateWorkGroupInp type UpdateWorkGroupInput struct { - // The workgroup state that will be updated for the given workgroup. - State types.WorkGroupState - - // The workgroup description. - Description *string - - // The workgroup configuration that will be updated for the given workgroup. - ConfigurationUpdates *types.WorkGroupConfigurationUpdates - // The specified workgroup that will be updated. // // This member is required. WorkGroup *string + + // The workgroup configuration that will be updated for the given workgroup. + ConfigurationUpdates *types.WorkGroupConfigurationUpdates + + // The workgroup description. + Description *string + + // The workgroup state that will be updated for the given workgroup. + State types.WorkGroupState } type UpdateWorkGroupOutput struct { diff --git a/service/athena/go.mod b/service/athena/go.mod index 4062172de7c..1bd438cc494 100644 --- a/service/athena/go.mod +++ b/service/athena/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/athena go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/athena/types/types.go b/service/athena/types/types.go index 8a6fe4eab43..c036ec68e8a 100644 --- a/service/athena/types/types.go +++ b/service/athena/types/types.go @@ -9,34 +9,21 @@ import ( // Contains metadata for a column in a table. type Column struct { + // The name of the column. + // + // This member is required. + Name *string + // Optional information about the column. Comment *string // The data type of the column. Type *string - - // The name of the column. - // - // This member is required. - Name *string } // Information about the columns in a query execution result. type ColumnInfo struct { - // For DECIMAL data types, specifies the total number of digits in the fractional - // part of the value. Defaults to 0. - Scale *int32 - - // The table name for the query results. - TableName *string - - // Indicates whether values in the column are case-sensitive. - CaseSensitive *bool - - // The catalog to which the query results belong. - CatalogName *string - // The name of the column. // // This member is required. @@ -47,26 +34,36 @@ type ColumnInfo struct { // This member is required. Type *string - // Indicates the column's nullable status. - Nullable ColumnNullable + // Indicates whether values in the column are case-sensitive. + CaseSensitive *bool + + // The catalog to which the query results belong. + CatalogName *string // A column label. Label *string + // Indicates the column's nullable status. + Nullable ColumnNullable + // For DECIMAL data types, specifies the total number of digits, up to 38. For // performance reasons, we recommend up to 18 digits. Precision *int32 + // For DECIMAL data types, specifies the total number of digits in the fractional + // part of the value. Defaults to 0. + Scale *int32 + // The schema name (database name) to which the query results belong. SchemaName *string + + // The table name for the query results. + TableName *string } // Contains metadata information for a database in a data catalog. type Database struct { - // A set of custom key/value pairs. - Parameters map[string]*string - // The name of the database. // // This member is required. @@ -74,14 +71,14 @@ type Database struct { // An optional description of the database. Description *string + + // A set of custom key/value pairs. + Parameters map[string]*string } // Contains information about a data catalog in an AWS account. type DataCatalog struct { - // An optional description of the data catalog. - Description *string - // The name of the data catalog. The catalog name must be unique for the AWS // account and can use a maximum of 128 alphanumeric, underscore, at sign, or // hyphen characters. @@ -95,6 +92,9 @@ type DataCatalog struct { // This member is required. Type DataCatalogType + // An optional description of the data catalog. + Description *string + // Specifies the Lambda function or functions to use for the data catalog. This is // a mapping whose values depend on the catalog type. // @@ -159,14 +159,16 @@ type EncryptionConfiguration struct { // query. type NamedQuery struct { + // The database to which the query belongs. + // + // This member is required. + Database *string + // The query name. // // This member is required. Name *string - // The unique identifier of the query. - NamedQueryId *string - // The SQL query statements that comprise the query. // // This member is required. @@ -175,10 +177,8 @@ type NamedQuery struct { // The query description. Description *string - // The database to which the query belongs. - // - // This member is required. - Database *string + // The unique identifier of the query. + NamedQueryId *string // The name of the workgroup that contains the named query. WorkGroup *string @@ -187,22 +187,14 @@ type NamedQuery struct { // Information about a single instance of a query execution. type QueryExecution struct { - // Query execution statistics, such as the amount of data scanned, the amount of - // time that the query took to process, and the type of statement that was run. - Statistics *QueryExecutionStatistics - - // The database in which the query execution occurred. - QueryExecutionContext *QueryExecutionContext - // The SQL query statements which the query execution ran. Query *string - // The completion date, current state, submission time, and state change reason (if - // applicable) for the query execution. - Status *QueryExecutionStatus + // The database in which the query execution occurred. + QueryExecutionContext *QueryExecutionContext - // The name of the workgroup in which the query ran. - WorkGroup *string + // The unique identifier for each query execution. + QueryExecutionId *string // The location in Amazon S3 where query results were stored and the encryption // option, if any, used for query results. These are known as "client-side @@ -211,24 +203,32 @@ type QueryExecution struct { // are specified for the workgroup. ResultConfiguration *ResultConfiguration - // The unique identifier for each query execution. - QueryExecutionId *string - // The type of query statement that was run. DDL indicates DDL query statements. // DML indicates DML (Data Manipulation Language) query statements, such as CREATE // TABLE AS SELECT. UTILITY indicates query statements other than DDL and DML, such // as SHOW CREATE TABLE, or DESCRIBE . StatementType StatementType + + // Query execution statistics, such as the amount of data scanned, the amount of + // time that the query took to process, and the type of statement that was run. + Statistics *QueryExecutionStatistics + + // The completion date, current state, submission time, and state change reason (if + // applicable) for the query execution. + Status *QueryExecutionStatus + + // The name of the workgroup in which the query ran. + WorkGroup *string } // The database and data catalog context in which the query execution occurs. type QueryExecutionContext struct { - // The name of the database used in the query execution. - Database *string - // The name of the data catalog used in the query execution. Catalog *string + + // The name of the database used in the query execution. + Database *string } // The amount of data scanned during the query execution and the amount of time @@ -245,6 +245,18 @@ type QueryExecutionStatistics struct { // Athena User Guide. DataManifestLocation *string + // The number of bytes in the data that was queried. + DataScannedInBytes *int64 + + // The number of milliseconds that the query took to execute. + EngineExecutionTimeInMillis *int64 + + // The number of milliseconds that Athena took to plan the query processing flow. + // This includes the time spent retrieving table partitions from the data source. + // Note that because the query engine performs the query planning, query planning + // time is a subset of engine processing time. + QueryPlanningTimeInMillis *int64 + // The number of milliseconds that the query was in your query queue waiting for // resources. Note that if transient errors occur, Athena might automatically add // the query back to the queue. @@ -256,24 +268,15 @@ type QueryExecutionStatistics struct { // The number of milliseconds that Athena took to run the query. TotalExecutionTimeInMillis *int64 - - // The number of milliseconds that Athena took to plan the query processing flow. - // This includes the time spent retrieving table partitions from the data source. - // Note that because the query engine performs the query planning, query planning - // time is a subset of engine processing time. - QueryPlanningTimeInMillis *int64 - - // The number of bytes in the data that was queried. - DataScannedInBytes *int64 - - // The number of milliseconds that the query took to execute. - EngineExecutionTimeInMillis *int64 } // The completion date, current state, submission time, and state change reason (if // applicable) for the query execution. type QueryExecutionStatus struct { + // The date and time that the query completed. + CompletionDateTime *time.Time + // The state of query execution. QUEUED indicates that the query has been submitted // to the service, and Athena will execute the query as soon as resources are // available. RUNNING indicates that the query is in execution phase. SUCCEEDED @@ -284,14 +287,11 @@ type QueryExecutionStatus struct { // state transition from RUNNING or FAILED to QUEUED. State QueryExecutionState - // The date and time that the query completed. - CompletionDateTime *time.Time + // Further detail about the status of the query. + StateChangeReason *string // The date and time that the query was submitted. SubmissionDateTime *time.Time - - // Further detail about the status of the query. - StateChangeReason *string } // The location in Amazon S3 where query results are stored and the encryption @@ -330,15 +330,15 @@ type ResultConfigurationUpdates struct { // The encryption configuration for the query results. EncryptionConfiguration *EncryptionConfiguration - // If set to "true", indicates that the previously-specified query results location - // (also known as a client-side setting) for queries in this workgroup should be - // ignored and set to null. If set to "false" or not set, and a value is present in - // the OutputLocation in ResultConfigurationUpdates (the client-side setting), the - // OutputLocation in the workgroup's ResultConfiguration will be updated with the - // new value. For more information, see Workgroup Settings Override Client-Side - // Settings - // (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). - RemoveOutputLocation *bool + // The location in Amazon S3 where your query results are stored, such as + // s3://path/to/query/bucket/. For more information, see Query Results + // (https://docs.aws.amazon.com/athena/latest/ug/querying.html) If workgroup + // settings override client-side settings, then the query uses the location for the + // query results and the encryption configuration that are specified for the + // workgroup. The "workgroup settings override" is specified in + // EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See + // WorkGroupConfiguration$EnforceWorkGroupConfiguration (). + OutputLocation *string // If set to "true", indicates that the previously-specified encryption // configuration (also known as the client-side setting) for queries in this @@ -350,15 +350,15 @@ type ResultConfigurationUpdates struct { // (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). RemoveEncryptionConfiguration *bool - // The location in Amazon S3 where your query results are stored, such as - // s3://path/to/query/bucket/. For more information, see Query Results - // (https://docs.aws.amazon.com/athena/latest/ug/querying.html) If workgroup - // settings override client-side settings, then the query uses the location for the - // query results and the encryption configuration that are specified for the - // workgroup. The "workgroup settings override" is specified in - // EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See - // WorkGroupConfiguration$EnforceWorkGroupConfiguration (). - OutputLocation *string + // If set to "true", indicates that the previously-specified query results location + // (also known as a client-side setting) for queries in this workgroup should be + // ignored and set to null. If set to "false" or not set, and a value is present in + // the OutputLocation in ResultConfigurationUpdates (the client-side setting), the + // OutputLocation in the workgroup's ResultConfiguration will be updated with the + // new value. For more information, see Workgroup Settings Override Client-Side + // Settings + // (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). + RemoveOutputLocation *bool } // The metadata and rows that comprise a query result set. The metadata describes @@ -392,28 +392,28 @@ type Row struct { // Contains metadata for a table. type TableMetadata struct { - // The type of table. In Athena, only EXTERNAL_TABLE is supported. - TableType *string + // The name of the table. + // + // This member is required. + Name *string - // A list of the partition keys in the table. - PartitionKeys []*Column + // A list of the columns in the table. + Columns []*Column - // A set of custom key/value pairs for table properties. - Parameters map[string]*string + // The time that the table was created. + CreateTime *time.Time // The last time the table was accessed. LastAccessTime *time.Time - // A list of the columns in the table. - Columns []*Column + // A set of custom key/value pairs for table properties. + Parameters map[string]*string - // The name of the table. - // - // This member is required. - Name *string + // A list of the partition keys in the table. + PartitionKeys []*Column - // The time that the table was created. - CreateTime *time.Time + // The type of table. In Athena, only EXTERNAL_TABLE is supported. + TableType *string } // A label that you assign to a resource. In Athena, a resource can be a workgroup @@ -445,14 +445,14 @@ type Tag struct { // Information about a named query ID that could not be processed. type UnprocessedNamedQueryId struct { - // The error message returned when the processing request for the named query - // failed, if applicable. - ErrorMessage *string - // The error code returned when the processing request for the named query failed, // if applicable. ErrorCode *string + // The error message returned when the processing request for the named query + // failed, if applicable. + ErrorMessage *string + // The unique identifier of the named query. NamedQueryId *string } @@ -488,12 +488,6 @@ type WorkGroup struct { // This member is required. Name *string - // The date and time the workgroup was created. - CreationTime *time.Time - - // The state of the workgroup: ENABLED or DISABLED. - State WorkGroupState - // The configuration of the workgroup, which includes the location in Amazon S3 // where query results are stored, the encryption configuration, if any, used for // query results; whether the Amazon CloudWatch Metrics are enabled for the @@ -504,8 +498,14 @@ type WorkGroup struct { // WorkGroupConfiguration$EnforceWorkGroupConfiguration (). Configuration *WorkGroupConfiguration + // The date and time the workgroup was created. + CreationTime *time.Time + // The workgroup description. Description *string + + // The state of the workgroup: ENABLED or DISABLED. + State WorkGroupState } // The configuration of the workgroup, which includes the location in Amazon S3 @@ -522,6 +522,15 @@ type WorkGroupConfiguration struct { // workgroup is allowed to scan. BytesScannedCutoffPerQuery *int64 + // If set to "true", the settings for the workgroup override client-side settings. + // If set to "false", client-side settings are used. For more information, see + // Workgroup Settings Override Client-Side Settings + // (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). + EnforceWorkGroupConfiguration *bool + + // Indicates that the Amazon CloudWatch metrics are enabled for the workgroup. + PublishCloudWatchMetricsEnabled *bool + // If set to true, allows members assigned to a workgroup to reference Amazon S3 // Requester Pays buckets in queries. If set to false, workgroup members cannot // query data from Requester Pays buckets, and queries that retrieve data from @@ -531,15 +540,6 @@ type WorkGroupConfiguration struct { // the Amazon Simple Storage Service Developer Guide. RequesterPaysEnabled *bool - // Indicates that the Amazon CloudWatch metrics are enabled for the workgroup. - PublishCloudWatchMetricsEnabled *bool - - // If set to "true", the settings for the workgroup override client-side settings. - // If set to "false", client-side settings are used. For more information, see - // Workgroup Settings Override Client-Side Settings - // (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). - EnforceWorkGroupConfiguration *bool - // The configuration for the workgroup, which includes the location in Amazon S3 // where query results are stored and the encryption option, if any, used for query // results. To run the query, you must specify the query results location using one @@ -559,14 +559,23 @@ type WorkGroupConfiguration struct { // scanned per query, if it is specified. type WorkGroupConfigurationUpdates struct { + // The upper limit (cutoff) for the amount of bytes a single query in a workgroup + // is allowed to scan. + BytesScannedCutoffPerQuery *int64 + + // If set to "true", the settings for the workgroup override client-side settings. + // If set to "false" client-side settings are used. For more information, see + // Workgroup Settings Override Client-Side Settings + // (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). + EnforceWorkGroupConfiguration *bool + // Indicates whether this workgroup enables publishing metrics to Amazon // CloudWatch. PublishCloudWatchMetricsEnabled *bool - // The result configuration information about the queries in this workgroup that - // will be updated. Includes the updated results location and an updated option for - // encrypting query results. - ResultConfigurationUpdates *ResultConfigurationUpdates + // Indicates that the data usage control limit per query is removed. + // WorkGroupConfiguration$BytesScannedCutoffPerQuery () + RemoveBytesScannedCutoffPerQuery *bool // If set to true, allows members assigned to a workgroup to specify Amazon S3 // Requester Pays buckets in queries. If set to false, workgroup members cannot @@ -577,19 +586,10 @@ type WorkGroupConfigurationUpdates struct { // the Amazon Simple Storage Service Developer Guide. RequesterPaysEnabled *bool - // The upper limit (cutoff) for the amount of bytes a single query in a workgroup - // is allowed to scan. - BytesScannedCutoffPerQuery *int64 - - // If set to "true", the settings for the workgroup override client-side settings. - // If set to "false" client-side settings are used. For more information, see - // Workgroup Settings Override Client-Side Settings - // (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). - EnforceWorkGroupConfiguration *bool - - // Indicates that the data usage control limit per query is removed. - // WorkGroupConfiguration$BytesScannedCutoffPerQuery () - RemoveBytesScannedCutoffPerQuery *bool + // The result configuration information about the queries in this workgroup that + // will be updated. Includes the updated results location and an updated option for + // encrypting query results. + ResultConfigurationUpdates *ResultConfigurationUpdates } // The summary information for the workgroup, which includes its name, state, @@ -599,12 +599,12 @@ type WorkGroupSummary struct { // The workgroup creation date and time. CreationTime *time.Time - // The name of the workgroup. - Name *string - // The workgroup description. Description *string + // The name of the workgroup. + Name *string + // The state of the workgroup. State WorkGroupState } diff --git a/service/autoscaling/api_op_AttachLoadBalancers.go b/service/autoscaling/api_op_AttachLoadBalancers.go index 239b95c3fbd..14637aba165 100644 --- a/service/autoscaling/api_op_AttachLoadBalancers.go +++ b/service/autoscaling/api_op_AttachLoadBalancers.go @@ -65,15 +65,15 @@ func (c *Client) AttachLoadBalancers(ctx context.Context, params *AttachLoadBala type AttachLoadBalancersInput struct { - // The names of the load balancers. You can specify up to 10 load balancers. + // The name of the Auto Scaling group. // // This member is required. - LoadBalancerNames []*string + AutoScalingGroupName *string - // The name of the Auto Scaling group. + // The names of the load balancers. You can specify up to 10 load balancers. // // This member is required. - AutoScalingGroupName *string + LoadBalancerNames []*string } type AttachLoadBalancersOutput struct { diff --git a/service/autoscaling/api_op_BatchDeleteScheduledAction.go b/service/autoscaling/api_op_BatchDeleteScheduledAction.go index 65ea9244abc..edd67117741 100644 --- a/service/autoscaling/api_op_BatchDeleteScheduledAction.go +++ b/service/autoscaling/api_op_BatchDeleteScheduledAction.go @@ -57,15 +57,15 @@ func (c *Client) BatchDeleteScheduledAction(ctx context.Context, params *BatchDe type BatchDeleteScheduledActionInput struct { - // The names of the scheduled actions to delete. The maximum number allowed is 50. + // The name of the Auto Scaling group. // // This member is required. - ScheduledActionNames []*string + AutoScalingGroupName *string - // The name of the Auto Scaling group. + // The names of the scheduled actions to delete. The maximum number allowed is 50. // // This member is required. - AutoScalingGroupName *string + ScheduledActionNames []*string } type BatchDeleteScheduledActionOutput struct { diff --git a/service/autoscaling/api_op_CompleteLifecycleAction.go b/service/autoscaling/api_op_CompleteLifecycleAction.go index 5d0e6e9126c..49efa321b4a 100644 --- a/service/autoscaling/api_op_CompleteLifecycleAction.go +++ b/service/autoscaling/api_op_CompleteLifecycleAction.go @@ -82,16 +82,6 @@ func (c *Client) CompleteLifecycleAction(ctx context.Context, params *CompleteLi type CompleteLifecycleActionInput struct { - // A universally unique identifier (UUID) that identifies a specific lifecycle - // action associated with an instance. Amazon EC2 Auto Scaling sends this token to - // the notification target you specified when you created the lifecycle hook. - LifecycleActionToken *string - - // The name of the lifecycle hook. - // - // This member is required. - LifecycleHookName *string - // The name of the Auto Scaling group. // // This member is required. @@ -103,8 +93,18 @@ type CompleteLifecycleActionInput struct { // This member is required. LifecycleActionResult *string + // The name of the lifecycle hook. + // + // This member is required. + LifecycleHookName *string + // The ID of the instance. InstanceId *string + + // A universally unique identifier (UUID) that identifies a specific lifecycle + // action associated with an instance. Amazon EC2 Auto Scaling sends this token to + // the notification target you specified when you created the lifecycle hook. + LifecycleActionToken *string } type CompleteLifecycleActionOutput struct { diff --git a/service/autoscaling/api_op_CreateAutoScalingGroup.go b/service/autoscaling/api_op_CreateAutoScalingGroup.go index 903a8beae99..b9adb24449b 100644 --- a/service/autoscaling/api_op_CreateAutoScalingGroup.go +++ b/service/autoscaling/api_op_CreateAutoScalingGroup.go @@ -74,55 +74,31 @@ func (c *Client) CreateAutoScalingGroup(ctx context.Context, params *CreateAutoS type CreateAutoScalingGroupInput struct { - // The minimum size of the group. + // The name of the Auto Scaling group. This name must be unique per Region per + // account. // // This member is required. - MinSize *int32 - - // The name of the placement group into which to launch your instances, if any. A - // placement group is a logical grouping of instances within a single Availability - // Zone. You cannot specify multiple Availability Zones and a placement group. For - // more information, see Placement Groups - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in - // the Amazon EC2 User Guide for Linux Instances. - PlacementGroup *string - - // Parameters used to specify the launch template and version to use when an - // instance is launched. For more information, see LaunchTemplateSpecification - // (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_LaunchTemplateSpecification.html) - // in the Amazon EC2 Auto Scaling API Reference. You can alternatively associate a - // launch template to the Auto Scaling group by using the MixedInstancesPolicy - // parameter. You must specify one of the following parameters in your request: - // LaunchConfigurationName, LaunchTemplate, InstanceId, or MixedInstancesPolicy. - LaunchTemplate *types.LaunchTemplateSpecification + AutoScalingGroupName *string - // One or more tags. You can tag your Auto Scaling group and propagate the tags to - // the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS - // volumes. To add tags to Amazon EBS volumes, specify the tags in a launch - // template but use caution. If the launch template specifies an instance tag with - // a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling - // overrides the value of that instance tag with the value specified by the Auto - // Scaling group. For more information, see Tagging Auto Scaling Groups and - // Instances - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html) - // in the Amazon EC2 Auto Scaling User Guide. - Tags []*types.Tag + // The maximum size of the group. With a mixed instances policy that uses instance + // weighting, Amazon EC2 Auto Scaling may need to go above MaxSize to meet your + // capacity requirements. In this event, Amazon EC2 Auto Scaling will never go + // above MaxSize by more than your largest instance weight (weights that define how + // many units each instance contributes to the desired capacity of the group). + // + // This member is required. + MaxSize *int32 - // One or more termination policies used to select the instance to terminate. These - // policies are executed in the order that they are listed. For more information, - // see Controlling Which Instances Auto Scaling Terminates During Scale In - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html) - // in the Amazon EC2 Auto Scaling User Guide. - TerminationPolicies []*string + // The minimum size of the group. + // + // This member is required. + MinSize *int32 - // The service to use for the health checks. The valid values are EC2 and ELB. The - // default value is EC2. If you configure an Auto Scaling group to use ELB health - // checks, it considers the instance unhealthy if it fails either the EC2 status - // checks or the load balancer health checks. For more information, see Health - // Checks for Auto Scaling Instances - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) in the - // Amazon EC2 Auto Scaling User Guide. - HealthCheckType *string + // One or more Availability Zones for the group. This parameter is optional if you + // specify one or more subnets for VPCZoneIdentifier. Conditional: If your account + // supports EC2-Classic and VPC, this parameter is required to launch instances + // into EC2-Classic. + AvailabilityZones []*string // The amount of time, in seconds, after a scaling activity completes before // another scaling activity can start. The default value is 300. This setting @@ -150,33 +126,25 @@ type CreateAutoScalingGroupInput struct { // health check. HealthCheckGracePeriod *int32 - // Indicates whether newly launched instances are protected from termination by - // Amazon EC2 Auto Scaling when scaling in. For more information about preventing - // instances from terminating on scale in, see Instance Protection - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection) - // in the Amazon EC2 Auto Scaling User Guide. - NewInstancesProtectedFromScaleIn *bool - - // The name of the Auto Scaling group. This name must be unique per Region per - // account. - // - // This member is required. - AutoScalingGroupName *string - - // The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling - // group uses to call other AWS services on your behalf. By default, Amazon EC2 - // Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, - // which it creates if it does not exist. For more information, see Service-Linked - // Roles - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) - // in the Amazon EC2 Auto Scaling User Guide. - ServiceLinkedRoleARN *string + // The service to use for the health checks. The valid values are EC2 and ELB. The + // default value is EC2. If you configure an Auto Scaling group to use ELB health + // checks, it considers the instance unhealthy if it fails either the EC2 status + // checks or the load balancer health checks. For more information, see Health + // Checks for Auto Scaling Instances + // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) in the + // Amazon EC2 Auto Scaling User Guide. + HealthCheckType *string - // One or more Availability Zones for the group. This parameter is optional if you - // specify one or more subnets for VPCZoneIdentifier. Conditional: If your account - // supports EC2-Classic and VPC, this parameter is required to launch instances - // into EC2-Classic. - AvailabilityZones []*string + // The ID of the instance used to create a launch configuration for the group. To + // get the instance ID, use the Amazon EC2 DescribeInstances + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html) + // API operation. When you specify an ID of an instance, Amazon EC2 Auto Scaling + // creates a new launch configuration and associates it with the group. This launch + // configuration derives its attributes from the specified instance, except for the + // block device mapping. You must specify one of the following parameters in your + // request: LaunchConfigurationName, LaunchTemplate, InstanceId, or + // MixedInstancesPolicy. + InstanceId *string // The name of the launch configuration to use when an instance is launched. To get // the launch configuration name, use the DescribeLaunchConfigurations () API @@ -186,6 +154,18 @@ type CreateAutoScalingGroupInput struct { // or MixedInstancesPolicy. LaunchConfigurationName *string + // Parameters used to specify the launch template and version to use when an + // instance is launched. For more information, see LaunchTemplateSpecification + // (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_LaunchTemplateSpecification.html) + // in the Amazon EC2 Auto Scaling API Reference. You can alternatively associate a + // launch template to the Auto Scaling group by using the MixedInstancesPolicy + // parameter. You must specify one of the following parameters in your request: + // LaunchConfigurationName, LaunchTemplate, InstanceId, or MixedInstancesPolicy. + LaunchTemplate *types.LaunchTemplateSpecification + + // One or more lifecycle hooks. + LifecycleHookSpecificationList []*types.LifecycleHookSpecification + // A list of Classic Load Balancers associated with this Auto Scaling group. For // Application Load Balancers and Network Load Balancers, specify a list of target // groups using the TargetGroupARNs property instead. For more information, see @@ -194,18 +174,6 @@ type CreateAutoScalingGroupInput struct { // in the Amazon EC2 Auto Scaling User Guide. LoadBalancerNames []*string - // One or more lifecycle hooks. - LifecycleHookSpecificationList []*types.LifecycleHookSpecification - - // The maximum size of the group. With a mixed instances policy that uses instance - // weighting, Amazon EC2 Auto Scaling may need to go above MaxSize to meet your - // capacity requirements. In this event, Amazon EC2 Auto Scaling will never go - // above MaxSize by more than your largest instance weight (weights that define how - // many units each instance contributes to the desired capacity of the group). - // - // This member is required. - MaxSize *int32 - // The maximum amount of time, in seconds, that an instance can be in service. The // default is null. This parameter is optional, but if you specify a value for it, // you must specify a value of at least 604,800 seconds (7 days). To clear a @@ -233,23 +201,41 @@ type CreateAutoScalingGroupInput struct { // MixedInstancesPolicy.

MixedInstancesPolicy *types.MixedInstancesPolicy - // A comma-separated list of subnet IDs for your virtual private cloud (VPC). If - // you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you - // specify for this parameter must reside in those Availability Zones. Conditional: - // If your account supports EC2-Classic and VPC, this parameter is required to - // launch instances into a VPC. - VPCZoneIdentifier *string + // Indicates whether newly launched instances are protected from termination by + // Amazon EC2 Auto Scaling when scaling in. For more information about preventing + // instances from terminating on scale in, see Instance Protection + // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection) + // in the Amazon EC2 Auto Scaling User Guide. + NewInstancesProtectedFromScaleIn *bool - // The ID of the instance used to create a launch configuration for the group. To - // get the instance ID, use the Amazon EC2 DescribeInstances - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html) - // API operation. When you specify an ID of an instance, Amazon EC2 Auto Scaling - // creates a new launch configuration and associates it with the group. This launch - // configuration derives its attributes from the specified instance, except for the - // block device mapping. You must specify one of the following parameters in your - // request: LaunchConfigurationName, LaunchTemplate, InstanceId, or - // MixedInstancesPolicy. - InstanceId *string + // The name of the placement group into which to launch your instances, if any. A + // placement group is a logical grouping of instances within a single Availability + // Zone. You cannot specify multiple Availability Zones and a placement group. For + // more information, see Placement Groups + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in + // the Amazon EC2 User Guide for Linux Instances. + PlacementGroup *string + + // The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling + // group uses to call other AWS services on your behalf. By default, Amazon EC2 + // Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, + // which it creates if it does not exist. For more information, see Service-Linked + // Roles + // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) + // in the Amazon EC2 Auto Scaling User Guide. + ServiceLinkedRoleARN *string + + // One or more tags. You can tag your Auto Scaling group and propagate the tags to + // the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS + // volumes. To add tags to Amazon EBS volumes, specify the tags in a launch + // template but use caution. If the launch template specifies an instance tag with + // a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling + // overrides the value of that instance tag with the value specified by the Auto + // Scaling group. For more information, see Tagging Auto Scaling Groups and + // Instances + // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html) + // in the Amazon EC2 Auto Scaling User Guide. + Tags []*types.Tag // The Amazon Resource Names (ARN) of the target groups to associate with the Auto // Scaling group. Instances are registered as targets in a target group, and @@ -258,6 +244,20 @@ type CreateAutoScalingGroupInput struct { // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) // in the Amazon EC2 Auto Scaling User Guide. TargetGroupARNs []*string + + // One or more termination policies used to select the instance to terminate. These + // policies are executed in the order that they are listed. For more information, + // see Controlling Which Instances Auto Scaling Terminates During Scale In + // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html) + // in the Amazon EC2 Auto Scaling User Guide. + TerminationPolicies []*string + + // A comma-separated list of subnet IDs for your virtual private cloud (VPC). If + // you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you + // specify for this parameter must reside in those Availability Zones. Conditional: + // If your account supports EC2-Classic and VPC, this parameter is required to + // launch instances into a VPC. + VPCZoneIdentifier *string } type CreateAutoScalingGroupOutput struct { diff --git a/service/autoscaling/api_op_CreateLaunchConfiguration.go b/service/autoscaling/api_op_CreateLaunchConfiguration.go index edb085ad4ee..828dac94cde 100644 --- a/service/autoscaling/api_op_CreateLaunchConfiguration.go +++ b/service/autoscaling/api_op_CreateLaunchConfiguration.go @@ -65,16 +65,25 @@ func (c *Client) CreateLaunchConfiguration(ctx context.Context, params *CreateLa type CreateLaunchConfigurationInput struct { - // The name or the Amazon Resource Name (ARN) of the instance profile associated - // with the IAM role for the instance. The instance profile contains the IAM role. - // For more information, see IAM Role for Applications That Run on Amazon EC2 - // Instances - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html) in the - // Amazon EC2 Auto Scaling User Guide. - IamInstanceProfile *string + // The name of the launch configuration. This name must be unique per Region per + // account. + // + // This member is required. + LaunchConfigurationName *string - // The ID of the RAM disk to select. - RamdiskId *string + // For Auto Scaling groups that are running in a virtual private cloud (VPC), + // specifies whether to assign a public IP address to the group's instances. If you + // specify true, each instance in the Auto Scaling group receives a unique public + // IP address. For more information, see Launching Auto Scaling Instances in a VPC + // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html) in the + // Amazon EC2 Auto Scaling User Guide. If you specify this parameter, you must + // specify at least one subnet for VPCZoneIdentifier when you create your group. If + // the instance is launched into a default subnet, the default is to assign a + // public IP address, unless you disabled the option to assign a public IP address + // on the subnet. If the instance is launched into a nondefault subnet, the default + // is not to assign a public IP address, unless you enabled the option to assign a + // public IP address on the subnet. + AssociatePublicIpAddress *bool // A block device mapping, which specifies the block devices for the instance. You // can specify virtual devices and EBS volumes. For more information, see Block @@ -83,14 +92,25 @@ type CreateLaunchConfigurationInput struct { // in the Amazon EC2 User Guide for Linux Instances. BlockDeviceMappings []*types.BlockDeviceMapping - // The ID of the kernel associated with the AMI. - KernelId *string + // The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For + // more information, see ClassicLink + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html) in + // the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances + // to a VPC + // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink) + // in the Amazon EC2 Auto Scaling User Guide. This parameter can only be used if + // you are launching EC2-Classic instances. + ClassicLinkVPCId *string - // The metadata options for the instances. For more information, see Instance - // Metadata and User Data - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) - // in the Amazon EC2 User Guide for Linux Instances. - MetadataOptions *types.InstanceMetadataOptions + // The IDs of one or more security groups for the specified ClassicLink-enabled + // VPC. For more information, see ClassicLink + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html) in + // the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances + // to a VPC + // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink) + // in the Amazon EC2 Auto Scaling User Guide. If you specify the ClassicLinkVPCId + // parameter, you must specify this parameter. + ClassicLinkVPCSecurityGroups []*string // Specifies whether the launch configuration is optimized for EBS I/O (true) or // not (false). The optimization provides dedicated throughput to Amazon EBS and an @@ -103,15 +123,20 @@ type CreateLaunchConfigurationInput struct { // Amazon EC2 User Guide for Linux Instances. The default value is false. EbsOptimized *bool - // The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For - // more information, see ClassicLink - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html) in - // the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances - // to a VPC - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink) - // in the Amazon EC2 Auto Scaling User Guide. This parameter can only be used if - // you are launching EC2-Classic instances. - ClassicLinkVPCId *string + // The name or the Amazon Resource Name (ARN) of the instance profile associated + // with the IAM role for the instance. The instance profile contains the IAM role. + // For more information, see IAM Role for Applications That Run on Amazon EC2 + // Instances + // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html) in the + // Amazon EC2 Auto Scaling User Guide. + IamInstanceProfile *string + + // The ID of the Amazon Machine Image (AMI) that was assigned during registration. + // For more information, see Finding an AMI + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html) in the + // Amazon EC2 User Guide for Linux Instances. If you do not specify InstanceId, you + // must specify ImageId. + ImageId *string // The ID of the instance to use to create the launch configuration. The new launch // configuration derives attributes from the instance, except for the block device @@ -124,29 +149,36 @@ type CreateLaunchConfigurationInput struct { // must specify both ImageId and InstanceType. InstanceId *string - // For Auto Scaling groups that are running in a virtual private cloud (VPC), - // specifies whether to assign a public IP address to the group's instances. If you - // specify true, each instance in the Auto Scaling group receives a unique public - // IP address. For more information, see Launching Auto Scaling Instances in a VPC - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html) in the - // Amazon EC2 Auto Scaling User Guide. If you specify this parameter, you must - // specify at least one subnet for VPCZoneIdentifier when you create your group. If - // the instance is launched into a default subnet, the default is to assign a - // public IP address, unless you disabled the option to assign a public IP address - // on the subnet. If the instance is launched into a nondefault subnet, the default - // is not to assign a public IP address, unless you enabled the option to assign a - // public IP address on the subnet. - AssociatePublicIpAddress *bool + // Controls whether instances in this group are launched with detailed (true) or + // basic (false) monitoring. The default value is true (enabled). When detailed + // monitoring is enabled, Amazon CloudWatch generates metrics every minute and your + // account is charged a fee. When you disable detailed monitoring, CloudWatch + // generates metrics every 5 minutes. For more information, see Configure + // Monitoring for Auto Scaling Instances + // (https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics) + // in the Amazon EC2 Auto Scaling User Guide. + InstanceMonitoring *types.InstanceMonitoring - // The IDs of one or more security groups for the specified ClassicLink-enabled - // VPC. For more information, see ClassicLink - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html) in - // the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances - // to a VPC - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink) - // in the Amazon EC2 Auto Scaling User Guide. If you specify the ClassicLinkVPCId - // parameter, you must specify this parameter. - ClassicLinkVPCSecurityGroups []*string + // Specifies the instance type of the EC2 instance. For information about available + // instance types, see Available Instance Types + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes) + // in the Amazon EC2 User Guide for Linux Instances. If you do not specify + // InstanceId, you must specify InstanceType. + InstanceType *string + + // The ID of the kernel associated with the AMI. + KernelId *string + + // The name of the key pair. For more information, see Amazon EC2 Key Pairs + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) in the + // Amazon EC2 User Guide for Linux Instances. + KeyName *string + + // The metadata options for the instances. For more information, see Instance + // Metadata and User Data + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) + // in the Amazon EC2 User Guide for Linux Instances. + MetadataOptions *types.InstanceMetadataOptions // The tenancy of the instance. An instance with dedicated tenancy runs on // isolated, single-tenant hardware and can only be launched into a VPC. To launch @@ -159,6 +191,9 @@ type CreateLaunchConfigurationInput struct { // in the Amazon EC2 Auto Scaling User Guide. Valid Values: default | dedicated PlacementTenancy *string + // The ID of the RAM disk to select. + RamdiskId *string + // A list that contains the security groups to assign to the instances in the Auto // Scaling group. [EC2-VPC] Specify the security group IDs. For more information, // see Security Groups for Your VPC @@ -170,12 +205,6 @@ type CreateLaunchConfigurationInput struct { // in the Amazon EC2 User Guide for Linux Instances. SecurityGroups []*string - // The name of the launch configuration. This name must be unique per Region per - // account. - // - // This member is required. - LaunchConfigurationName *string - // The maximum hourly price to be paid for any Spot Instance launched to fulfill // the request. Spot Instances are launched when the price you specify exceeds the // current Spot price. For more information, see Launching Spot Instances in Your @@ -192,35 +221,6 @@ type CreateLaunchConfigurationInput struct { // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) // in the Amazon EC2 User Guide for Linux Instances. UserData *string - - // The name of the key pair. For more information, see Amazon EC2 Key Pairs - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) in the - // Amazon EC2 User Guide for Linux Instances. - KeyName *string - - // The ID of the Amazon Machine Image (AMI) that was assigned during registration. - // For more information, see Finding an AMI - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html) in the - // Amazon EC2 User Guide for Linux Instances. If you do not specify InstanceId, you - // must specify ImageId. - ImageId *string - - // Controls whether instances in this group are launched with detailed (true) or - // basic (false) monitoring. The default value is true (enabled). When detailed - // monitoring is enabled, Amazon CloudWatch generates metrics every minute and your - // account is charged a fee. When you disable detailed monitoring, CloudWatch - // generates metrics every 5 minutes. For more information, see Configure - // Monitoring for Auto Scaling Instances - // (https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics) - // in the Amazon EC2 Auto Scaling User Guide. - InstanceMonitoring *types.InstanceMonitoring - - // Specifies the instance type of the EC2 instance. For information about available - // instance types, see Available Instance Types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes) - // in the Amazon EC2 User Guide for Linux Instances. If you do not specify - // InstanceId, you must specify InstanceType. - InstanceType *string } type CreateLaunchConfigurationOutput struct { diff --git a/service/autoscaling/api_op_DeleteLifecycleHook.go b/service/autoscaling/api_op_DeleteLifecycleHook.go index f6eb09d5a50..afb85469812 100644 --- a/service/autoscaling/api_op_DeleteLifecycleHook.go +++ b/service/autoscaling/api_op_DeleteLifecycleHook.go @@ -58,15 +58,15 @@ func (c *Client) DeleteLifecycleHook(ctx context.Context, params *DeleteLifecycl type DeleteLifecycleHookInput struct { - // The name of the lifecycle hook. + // The name of the Auto Scaling group. // // This member is required. - LifecycleHookName *string + AutoScalingGroupName *string - // The name of the Auto Scaling group. + // The name of the lifecycle hook. // // This member is required. - AutoScalingGroupName *string + LifecycleHookName *string } type DeleteLifecycleHookOutput struct { diff --git a/service/autoscaling/api_op_DeletePolicy.go b/service/autoscaling/api_op_DeletePolicy.go index f4a96f1ac2c..725b7e5becb 100644 --- a/service/autoscaling/api_op_DeletePolicy.go +++ b/service/autoscaling/api_op_DeletePolicy.go @@ -61,13 +61,13 @@ func (c *Client) DeletePolicy(ctx context.Context, params *DeletePolicyInput, op type DeletePolicyInput struct { - // The name of the Auto Scaling group. - AutoScalingGroupName *string - // The name or Amazon Resource Name (ARN) of the policy. // // This member is required. PolicyName *string + + // The name of the Auto Scaling group. + AutoScalingGroupName *string } type DeletePolicyOutput struct { diff --git a/service/autoscaling/api_op_DescribeAccountLimits.go b/service/autoscaling/api_op_DescribeAccountLimits.go index ee4526a33fd..19bf9c0a058 100644 --- a/service/autoscaling/api_op_DescribeAccountLimits.go +++ b/service/autoscaling/api_op_DescribeAccountLimits.go @@ -62,12 +62,6 @@ type DescribeAccountLimitsInput struct { type DescribeAccountLimitsOutput struct { - // The current number of groups for your AWS account. - NumberOfAutoScalingGroups *int32 - - // The current number of launch configurations for your AWS account. - NumberOfLaunchConfigurations *int32 - // The maximum number of groups allowed for your AWS account. The default is 200 // groups per AWS Region. MaxNumberOfAutoScalingGroups *int32 @@ -76,6 +70,12 @@ type DescribeAccountLimitsOutput struct { // default is 200 launch configurations per AWS Region. MaxNumberOfLaunchConfigurations *int32 + // The current number of groups for your AWS account. + NumberOfAutoScalingGroups *int32 + + // The current number of launch configurations for your AWS account. + NumberOfLaunchConfigurations *int32 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/autoscaling/api_op_DescribeAutoScalingGroups.go b/service/autoscaling/api_op_DescribeAutoScalingGroups.go index f64eafa09a0..b66ee8ee743 100644 --- a/service/autoscaling/api_op_DescribeAutoScalingGroups.go +++ b/service/autoscaling/api_op_DescribeAutoScalingGroups.go @@ -56,16 +56,16 @@ func (c *Client) DescribeAutoScalingGroups(ctx context.Context, params *Describe type DescribeAutoScalingGroupsInput struct { - // The maximum number of items to return with this call. The default value is 50 - // and the maximum value is 100. - MaxRecords *int32 - // The names of the Auto Scaling groups. Each name can be a maximum of 1600 // characters. By default, you can only specify up to 50 names. You can optionally // increase this limit using the MaxRecords parameter. If you omit this parameter, // all Auto Scaling groups are described. AutoScalingGroupNames []*string + // The maximum number of items to return with this call. The default value is 50 + // and the maximum value is 100. + MaxRecords *int32 + // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string @@ -73,17 +73,17 @@ type DescribeAutoScalingGroupsInput struct { type DescribeAutoScalingGroupsOutput struct { + // The groups. + // + // This member is required. + AutoScalingGroups []*types.AutoScalingGroup + // A string that indicates that the response contains more items than can be // returned in a single response. To receive additional items, specify this string // for the NextToken value when requesting the next set of items. This value is // null when there are no more items to return. NextToken *string - // The groups. - // - // This member is required. - AutoScalingGroups []*types.AutoScalingGroup - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/autoscaling/api_op_DescribeAutoScalingInstances.go b/service/autoscaling/api_op_DescribeAutoScalingInstances.go index 3006ff3449c..4f01246bcc1 100644 --- a/service/autoscaling/api_op_DescribeAutoScalingInstances.go +++ b/service/autoscaling/api_op_DescribeAutoScalingInstances.go @@ -56,6 +56,11 @@ func (c *Client) DescribeAutoScalingInstances(ctx context.Context, params *Descr type DescribeAutoScalingInstancesInput struct { + // The IDs of the instances. You can specify up to MaxRecords IDs. If you omit this + // parameter, all Auto Scaling instances are described. If you specify an ID that + // does not exist, it is ignored with no error. + InstanceIds []*string + // The maximum number of items to return with this call. The default value is 50 // and the maximum value is 50. MaxRecords *int32 @@ -63,11 +68,6 @@ type DescribeAutoScalingInstancesInput struct { // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string - - // The IDs of the instances. You can specify up to MaxRecords IDs. If you omit this - // parameter, all Auto Scaling instances are described. If you specify an ID that - // does not exist, it is ignored with no error. - InstanceIds []*string } type DescribeAutoScalingInstancesOutput struct { diff --git a/service/autoscaling/api_op_DescribeInstanceRefreshes.go b/service/autoscaling/api_op_DescribeInstanceRefreshes.go index cedd735bb93..3c4ffc2f36f 100644 --- a/service/autoscaling/api_op_DescribeInstanceRefreshes.go +++ b/service/autoscaling/api_op_DescribeInstanceRefreshes.go @@ -87,6 +87,9 @@ type DescribeInstanceRefreshesInput struct { // This member is required. AutoScalingGroupName *string + // One or more instance refresh IDs. + InstanceRefreshIds []*string + // The maximum number of items to return with this call. The default value is 50 // and the maximum value is 100. MaxRecords *int32 @@ -94,22 +97,19 @@ type DescribeInstanceRefreshesInput struct { // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string - - // One or more instance refresh IDs. - InstanceRefreshIds []*string } type DescribeInstanceRefreshesOutput struct { + // The instance refreshes for the specified group. + InstanceRefreshes []*types.InstanceRefresh + // A string that indicates that the response contains more items than can be // returned in a single response. To receive additional items, specify this string // for the NextToken value when requesting the next set of items. This value is // null when there are no more items to return. NextToken *string - // The instance refreshes for the specified group. - InstanceRefreshes []*types.InstanceRefresh - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/autoscaling/api_op_DescribeLaunchConfigurations.go b/service/autoscaling/api_op_DescribeLaunchConfigurations.go index bd2df157ec6..81aa8c6c4ce 100644 --- a/service/autoscaling/api_op_DescribeLaunchConfigurations.go +++ b/service/autoscaling/api_op_DescribeLaunchConfigurations.go @@ -56,10 +56,6 @@ func (c *Client) DescribeLaunchConfigurations(ctx context.Context, params *Descr type DescribeLaunchConfigurationsInput struct { - // The token for the next set of items to return. (You received this token from a - // previous call.) - NextToken *string - // The launch configuration names. If you omit this parameter, all launch // configurations are described. LaunchConfigurationNames []*string @@ -67,6 +63,10 @@ type DescribeLaunchConfigurationsInput struct { // The maximum number of items to return with this call. The default value is 50 // and the maximum value is 100. MaxRecords *int32 + + // The token for the next set of items to return. (You received this token from a + // previous call.) + NextToken *string } type DescribeLaunchConfigurationsOutput struct { diff --git a/service/autoscaling/api_op_DescribeLoadBalancerTargetGroups.go b/service/autoscaling/api_op_DescribeLoadBalancerTargetGroups.go index c5a39bdc2f3..c617a776c61 100644 --- a/service/autoscaling/api_op_DescribeLoadBalancerTargetGroups.go +++ b/service/autoscaling/api_op_DescribeLoadBalancerTargetGroups.go @@ -57,10 +57,6 @@ func (c *Client) DescribeLoadBalancerTargetGroups(ctx context.Context, params *D type DescribeLoadBalancerTargetGroupsInput struct { - // The token for the next set of items to return. (You received this token from a - // previous call.) - NextToken *string - // The name of the Auto Scaling group. // // This member is required. @@ -69,6 +65,10 @@ type DescribeLoadBalancerTargetGroupsInput struct { // The maximum number of items to return with this call. The default value is 100 // and the maximum value is 100. MaxRecords *int32 + + // The token for the next set of items to return. (You received this token from a + // previous call.) + NextToken *string } type DescribeLoadBalancerTargetGroupsOutput struct { diff --git a/service/autoscaling/api_op_DescribeLoadBalancers.go b/service/autoscaling/api_op_DescribeLoadBalancers.go index 963c5cfd321..fc5ef2ee9e6 100644 --- a/service/autoscaling/api_op_DescribeLoadBalancers.go +++ b/service/autoscaling/api_op_DescribeLoadBalancers.go @@ -60,10 +60,6 @@ func (c *Client) DescribeLoadBalancers(ctx context.Context, params *DescribeLoad type DescribeLoadBalancersInput struct { - // The token for the next set of items to return. (You received this token from a - // previous call.) - NextToken *string - // The name of the Auto Scaling group. // // This member is required. @@ -72,6 +68,10 @@ type DescribeLoadBalancersInput struct { // The maximum number of items to return with this call. The default value is 100 // and the maximum value is 100. MaxRecords *int32 + + // The token for the next set of items to return. (You received this token from a + // previous call.) + NextToken *string } type DescribeLoadBalancersOutput struct { diff --git a/service/autoscaling/api_op_DescribeMetricCollectionTypes.go b/service/autoscaling/api_op_DescribeMetricCollectionTypes.go index ed1f0929414..cc58b87c3c9 100644 --- a/service/autoscaling/api_op_DescribeMetricCollectionTypes.go +++ b/service/autoscaling/api_op_DescribeMetricCollectionTypes.go @@ -61,12 +61,12 @@ type DescribeMetricCollectionTypesInput struct { type DescribeMetricCollectionTypesOutput struct { - // One or more metrics. - Metrics []*types.MetricCollectionType - // The granularities for the metrics. Granularities []*types.MetricGranularityType + // One or more metrics. + Metrics []*types.MetricCollectionType + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/autoscaling/api_op_DescribeNotificationConfigurations.go b/service/autoscaling/api_op_DescribeNotificationConfigurations.go index 4db71f17c2a..2e138dc5d58 100644 --- a/service/autoscaling/api_op_DescribeNotificationConfigurations.go +++ b/service/autoscaling/api_op_DescribeNotificationConfigurations.go @@ -57,31 +57,31 @@ func (c *Client) DescribeNotificationConfigurations(ctx context.Context, params type DescribeNotificationConfigurationsInput struct { - // The token for the next set of items to return. (You received this token from a - // previous call.) - NextToken *string + // The name of the Auto Scaling group. + AutoScalingGroupNames []*string // The maximum number of items to return with this call. The default value is 50 // and the maximum value is 100. MaxRecords *int32 - // The name of the Auto Scaling group. - AutoScalingGroupNames []*string + // The token for the next set of items to return. (You received this token from a + // previous call.) + NextToken *string } type DescribeNotificationConfigurationsOutput struct { + // The notification configurations. + // + // This member is required. + NotificationConfigurations []*types.NotificationConfiguration + // A string that indicates that the response contains more items than can be // returned in a single response. To receive additional items, specify this string // for the NextToken value when requesting the next set of items. This value is // null when there are no more items to return. NextToken *string - // The notification configurations. - // - // This member is required. - NotificationConfigurations []*types.NotificationConfiguration - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/autoscaling/api_op_DescribePolicies.go b/service/autoscaling/api_op_DescribePolicies.go index 52e03e19e81..54e922cd7c7 100644 --- a/service/autoscaling/api_op_DescribePolicies.go +++ b/service/autoscaling/api_op_DescribePolicies.go @@ -56,23 +56,23 @@ func (c *Client) DescribePolicies(ctx context.Context, params *DescribePoliciesI type DescribePoliciesInput struct { + // The name of the Auto Scaling group. + AutoScalingGroupName *string + + // The maximum number of items to be returned with each call. The default value is + // 50 and the maximum value is 100. + MaxRecords *int32 + // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string - // The name of the Auto Scaling group. - AutoScalingGroupName *string - // The names of one or more policies. If you omit this parameter, all policies are // described. If a group name is provided, the results are limited to that group. // This list is limited to 50 items. If you specify an unknown policy name, it is // ignored with no error. PolicyNames []*string - // The maximum number of items to be returned with each call. The default value is - // 50 and the maximum value is 100. - MaxRecords *int32 - // One or more policy types. The valid values are SimpleScaling, StepScaling, and // TargetTrackingScaling. PolicyTypes []*string diff --git a/service/autoscaling/api_op_DescribeScalingActivities.go b/service/autoscaling/api_op_DescribeScalingActivities.go index df268e3897b..7f5175467eb 100644 --- a/service/autoscaling/api_op_DescribeScalingActivities.go +++ b/service/autoscaling/api_op_DescribeScalingActivities.go @@ -56,10 +56,6 @@ func (c *Client) DescribeScalingActivities(ctx context.Context, params *Describe type DescribeScalingActivitiesInput struct { - // The token for the next set of items to return. (You received this token from a - // previous call.) - NextToken *string - // The activity IDs of the desired scaling activities. You can specify up to 50 // IDs. If you omit this parameter, all activities for the past six weeks are // described. If unknown activities are requested, they are ignored with no error. @@ -72,6 +68,10 @@ type DescribeScalingActivitiesInput struct { // The maximum number of items to return with this call. The default value is 100 // and the maximum value is 100. MaxRecords *int32 + + // The token for the next set of items to return. (You received this token from a + // previous call.) + NextToken *string } type DescribeScalingActivitiesOutput struct { diff --git a/service/autoscaling/api_op_DescribeScheduledActions.go b/service/autoscaling/api_op_DescribeScheduledActions.go index 72aa65ab920..fb52293f08c 100644 --- a/service/autoscaling/api_op_DescribeScheduledActions.go +++ b/service/autoscaling/api_op_DescribeScheduledActions.go @@ -59,29 +59,29 @@ func (c *Client) DescribeScheduledActions(ctx context.Context, params *DescribeS type DescribeScheduledActionsInput struct { - // The names of one or more scheduled actions. You can specify up to 50 actions. If - // you omit this parameter, all scheduled actions are described. If you specify an - // unknown scheduled action, it is ignored with no error. - ScheduledActionNames []*string + // The name of the Auto Scaling group. + AutoScalingGroupName *string - // The token for the next set of items to return. (You received this token from a - // previous call.) - NextToken *string + // The latest scheduled start time to return. If scheduled action names are + // provided, this parameter is ignored. + EndTime *time.Time // The maximum number of items to return with this call. The default value is 50 // and the maximum value is 100. MaxRecords *int32 - // The earliest scheduled start time to return. If scheduled action names are - // provided, this parameter is ignored. - StartTime *time.Time + // The token for the next set of items to return. (You received this token from a + // previous call.) + NextToken *string - // The name of the Auto Scaling group. - AutoScalingGroupName *string + // The names of one or more scheduled actions. You can specify up to 50 actions. If + // you omit this parameter, all scheduled actions are described. If you specify an + // unknown scheduled action, it is ignored with no error. + ScheduledActionNames []*string - // The latest scheduled start time to return. If scheduled action names are + // The earliest scheduled start time to return. If scheduled action names are // provided, this parameter is ignored. - EndTime *time.Time + StartTime *time.Time } type DescribeScheduledActionsOutput struct { diff --git a/service/autoscaling/api_op_DescribeTags.go b/service/autoscaling/api_op_DescribeTags.go index de1abf19194..b7f24bffc50 100644 --- a/service/autoscaling/api_op_DescribeTags.go +++ b/service/autoscaling/api_op_DescribeTags.go @@ -64,6 +64,10 @@ func (c *Client) DescribeTags(ctx context.Context, params *DescribeTagsInput, op type DescribeTagsInput struct { + // One or more filters to scope the tags to return. The maximum number of filters + // per filter type (for example, auto-scaling-group) is 1000. + Filters []*types.Filter + // The maximum number of items to return with this call. The default value is 50 // and the maximum value is 100. MaxRecords *int32 @@ -71,10 +75,6 @@ type DescribeTagsInput struct { // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string - - // One or more filters to scope the tags to return. The maximum number of filters - // per filter type (for example, auto-scaling-group) is 1000. - Filters []*types.Filter } type DescribeTagsOutput struct { diff --git a/service/autoscaling/api_op_DetachInstances.go b/service/autoscaling/api_op_DetachInstances.go index eb0031c6654..03369bd9eb8 100644 --- a/service/autoscaling/api_op_DetachInstances.go +++ b/service/autoscaling/api_op_DetachInstances.go @@ -67,9 +67,6 @@ func (c *Client) DetachInstances(ctx context.Context, params *DetachInstancesInp type DetachInstancesInput struct { - // The IDs of the instances. You can specify up to 20 instances. - InstanceIds []*string - // The name of the Auto Scaling group. // // This member is required. @@ -80,6 +77,9 @@ type DetachInstancesInput struct { // // This member is required. ShouldDecrementDesiredCapacity *bool + + // The IDs of the instances. You can specify up to 20 instances. + InstanceIds []*string } type DetachInstancesOutput struct { diff --git a/service/autoscaling/api_op_DetachLoadBalancerTargetGroups.go b/service/autoscaling/api_op_DetachLoadBalancerTargetGroups.go index 8535062a842..2fd736452f9 100644 --- a/service/autoscaling/api_op_DetachLoadBalancerTargetGroups.go +++ b/service/autoscaling/api_op_DetachLoadBalancerTargetGroups.go @@ -56,16 +56,16 @@ func (c *Client) DetachLoadBalancerTargetGroups(ctx context.Context, params *Det type DetachLoadBalancerTargetGroupsInput struct { - // The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 - // target groups. + // The name of the Auto Scaling group. // // This member is required. - TargetGroupARNs []*string + AutoScalingGroupName *string - // The name of the Auto Scaling group. + // The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 + // target groups. // // This member is required. - AutoScalingGroupName *string + TargetGroupARNs []*string } type DetachLoadBalancerTargetGroupsOutput struct { diff --git a/service/autoscaling/api_op_DetachLoadBalancers.go b/service/autoscaling/api_op_DetachLoadBalancers.go index 28eacbe02d5..172e66ff076 100644 --- a/service/autoscaling/api_op_DetachLoadBalancers.go +++ b/service/autoscaling/api_op_DetachLoadBalancers.go @@ -63,15 +63,15 @@ func (c *Client) DetachLoadBalancers(ctx context.Context, params *DetachLoadBala type DetachLoadBalancersInput struct { - // The names of the load balancers. You can specify up to 10 load balancers. + // The name of the Auto Scaling group. // // This member is required. - LoadBalancerNames []*string + AutoScalingGroupName *string - // The name of the Auto Scaling group. + // The names of the load balancers. You can specify up to 10 load balancers. // // This member is required. - AutoScalingGroupName *string + LoadBalancerNames []*string } type DetachLoadBalancersOutput struct { diff --git a/service/autoscaling/api_op_EnableMetricsCollection.go b/service/autoscaling/api_op_EnableMetricsCollection.go index 873734d2c61..3585bb4bd06 100644 --- a/service/autoscaling/api_op_EnableMetricsCollection.go +++ b/service/autoscaling/api_op_EnableMetricsCollection.go @@ -59,16 +59,16 @@ func (c *Client) EnableMetricsCollection(ctx context.Context, params *EnableMetr type EnableMetricsCollectionInput struct { - // The granularity to associate with the metrics to collect. The only valid value - // is 1Minute. + // The name of the Auto Scaling group. // // This member is required. - Granularity *string + AutoScalingGroupName *string - // The name of the Auto Scaling group. + // The granularity to associate with the metrics to collect. The only valid value + // is 1Minute. // // This member is required. - AutoScalingGroupName *string + Granularity *string // Specifies which group-level metrics to start collecting. You can specify one or // more of the following metrics: diff --git a/service/autoscaling/api_op_EnterStandby.go b/service/autoscaling/api_op_EnterStandby.go index aceb4301374..bbcb60f7e44 100644 --- a/service/autoscaling/api_op_EnterStandby.go +++ b/service/autoscaling/api_op_EnterStandby.go @@ -66,9 +66,6 @@ func (c *Client) EnterStandby(ctx context.Context, params *EnterStandbyInput, op type EnterStandbyInput struct { - // The IDs of the instances. You can specify up to 20 instances. - InstanceIds []*string - // The name of the Auto Scaling group. // // This member is required. @@ -79,6 +76,9 @@ type EnterStandbyInput struct { // // This member is required. ShouldDecrementDesiredCapacity *bool + + // The IDs of the instances. You can specify up to 20 instances. + InstanceIds []*string } type EnterStandbyOutput struct { diff --git a/service/autoscaling/api_op_ExecutePolicy.go b/service/autoscaling/api_op_ExecutePolicy.go index 4edf19d0617..956429a2012 100644 --- a/service/autoscaling/api_op_ExecutePolicy.go +++ b/service/autoscaling/api_op_ExecutePolicy.go @@ -57,33 +57,33 @@ func (c *Client) ExecutePolicy(ctx context.Context, params *ExecutePolicyInput, type ExecutePolicyInput struct { - // The metric value to compare to BreachThreshold. This enables you to execute a - // policy of type StepScaling and determine which step adjustment to use. For - // example, if the breach threshold is 50 and you want to use a step adjustment - // with a lower bound of 0 and an upper bound of 10, you can set the metric value - // to 59. If you specify a metric value that doesn't correspond to a step - // adjustment for the policy, the call returns an error. Required if the policy - // type is StepScaling and not supported otherwise. - MetricValue *float64 - - // Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to - // complete before executing the policy. Valid only if the policy type is - // SimpleScaling. For more information, see Scaling Cooldowns for Amazon EC2 Auto - // Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in - // the Amazon EC2 Auto Scaling User Guide. - HonorCooldown *bool - - // The name of the Auto Scaling group. - AutoScalingGroupName *string - // The name or ARN of the policy. // // This member is required. PolicyName *string + // The name of the Auto Scaling group. + AutoScalingGroupName *string + // The breach threshold for the alarm. Required if the policy type is StepScaling // and not supported otherwise. BreachThreshold *float64 + + // Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to + // complete before executing the policy. Valid only if the policy type is + // SimpleScaling. For more information, see Scaling Cooldowns for Amazon EC2 Auto + // Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in + // the Amazon EC2 Auto Scaling User Guide. + HonorCooldown *bool + + // The metric value to compare to BreachThreshold. This enables you to execute a + // policy of type StepScaling and determine which step adjustment to use. For + // example, if the breach threshold is 50 and you want to use a step adjustment + // with a lower bound of 0 and an upper bound of 10, you can set the metric value + // to 59. If you specify a metric value that doesn't correspond to a step + // adjustment for the policy, the call returns an error. Required if the policy + // type is StepScaling and not supported otherwise. + MetricValue *float64 } type ExecutePolicyOutput struct { diff --git a/service/autoscaling/api_op_PutLifecycleHook.go b/service/autoscaling/api_op_PutLifecycleHook.go index 5a880ef348f..22a2bf9482d 100644 --- a/service/autoscaling/api_op_PutLifecycleHook.go +++ b/service/autoscaling/api_op_PutLifecycleHook.go @@ -89,26 +89,28 @@ func (c *Client) PutLifecycleHook(ctx context.Context, params *PutLifecycleHookI type PutLifecycleHookInput struct { - // The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify - // you when an instance is in the transition state for the lifecycle hook. This - // target can be either an SQS queue or an SNS topic. If you specify an empty - // string, this overrides the current ARN. This operation uses the JSON format when - // sending notifications to an Amazon SQS queue, and an email key-value pair format - // when sending notifications to an Amazon SNS topic. When you specify a - // notification target, Amazon EC2 Auto Scaling sends it a test message. Test - // messages contain the following additional key-value pair: "Event": - // "autoscaling:TEST_NOTIFICATION". - NotificationTargetARN *string + // The name of the Auto Scaling group. + // + // This member is required. + AutoScalingGroupName *string // The name of the lifecycle hook. // // This member is required. LifecycleHookName *string - // The name of the Auto Scaling group. - // - // This member is required. - AutoScalingGroupName *string + // Defines the action the Auto Scaling group should take when the lifecycle hook + // timeout elapses or if an unexpected failure occurs. This parameter can be either + // CONTINUE or ABANDON. The default value is ABANDON. + DefaultResult *string + + // The maximum time, in seconds, that can elapse before the lifecycle hook times + // out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 + // hour). If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the + // action that you specified in the DefaultResult parameter. You can prevent the + // lifecycle hook from timing out by calling the RecordLifecycleActionHeartbeat () + // API. + HeartbeatTimeout *int32 // The instance state to which you want to attach the lifecycle hook. The valid // values are: @@ -122,22 +124,20 @@ type PutLifecycleHookInput struct { // optional when updating existing hooks. LifecycleTransition *string - // The maximum time, in seconds, that can elapse before the lifecycle hook times - // out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 - // hour). If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the - // action that you specified in the DefaultResult parameter. You can prevent the - // lifecycle hook from timing out by calling the RecordLifecycleActionHeartbeat () - // API. - HeartbeatTimeout *int32 - // Additional information that you want to include any time Amazon EC2 Auto Scaling // sends a message to the notification target. NotificationMetadata *string - // Defines the action the Auto Scaling group should take when the lifecycle hook - // timeout elapses or if an unexpected failure occurs. This parameter can be either - // CONTINUE or ABANDON. The default value is ABANDON. - DefaultResult *string + // The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify + // you when an instance is in the transition state for the lifecycle hook. This + // target can be either an SQS queue or an SNS topic. If you specify an empty + // string, this overrides the current ARN. This operation uses the JSON format when + // sending notifications to an Amazon SQS queue, and an email key-value pair format + // when sending notifications to an Amazon SNS topic. When you specify a + // notification target, Amazon EC2 Auto Scaling sends it a test message. Test + // messages contain the following additional key-value pair: "Event": + // "autoscaling:TEST_NOTIFICATION". + NotificationTargetARN *string // The ARN of the IAM role that allows the Auto Scaling group to publish to the // specified notification target, for example, an Amazon SNS topic or an Amazon SQS diff --git a/service/autoscaling/api_op_PutNotificationConfiguration.go b/service/autoscaling/api_op_PutNotificationConfiguration.go index 6460b8bd904..77080122316 100644 --- a/service/autoscaling/api_op_PutNotificationConfiguration.go +++ b/service/autoscaling/api_op_PutNotificationConfiguration.go @@ -67,18 +67,18 @@ type PutNotificationConfigurationInput struct { // This member is required. AutoScalingGroupName *string - // The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon - // SNS) topic. - // - // This member is required. - TopicARN *string - // The type of event that causes the notification to be sent. To query the // notification types supported by Amazon EC2 Auto Scaling, call the // DescribeAutoScalingNotificationTypes () API. // // This member is required. NotificationTypes []*string + + // The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon + // SNS) topic. + // + // This member is required. + TopicARN *string } type PutNotificationConfigurationOutput struct { diff --git a/service/autoscaling/api_op_PutScalingPolicy.go b/service/autoscaling/api_op_PutScalingPolicy.go index 907d2a901cc..40a5e29a180 100644 --- a/service/autoscaling/api_op_PutScalingPolicy.go +++ b/service/autoscaling/api_op_PutScalingPolicy.go @@ -63,6 +63,16 @@ func (c *Client) PutScalingPolicy(ctx context.Context, params *PutScalingPolicyI type PutScalingPolicyInput struct { + // The name of the Auto Scaling group. + // + // This member is required. + AutoScalingGroupName *string + + // The name of the policy. + // + // This member is required. + PolicyName *string + // Specifies how the scaling adjustment is interpreted (for example, an absolute // number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, // and PercentChangeInCapacity. Required if the policy type is StepScaling or @@ -71,20 +81,20 @@ type PutScalingPolicyInput struct { // in the Amazon EC2 Auto Scaling User Guide. AdjustmentType *string - // A set of adjustments that enable you to scale based on the size of the alarm - // breach. Required if the policy type is StepScaling. (Not used with any other - // policy type.) - StepAdjustments []*types.StepAdjustment + // The duration of the policy's cooldown period, in seconds. When a cooldown period + // is specified here, it overrides the default cooldown period defined for the Auto + // Scaling group. Valid only if the policy type is SimpleScaling. For more + // information, see Scaling Cooldowns for Amazon EC2 Auto Scaling + // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in the + // Amazon EC2 Auto Scaling User Guide. + Cooldown *int32 - // One of the following policy types: - // - // * TargetTrackingScaling - // - // * - // StepScaling - // - // * SimpleScaling (default) - PolicyType *string + // Indicates whether the scaling policy is enabled or disabled. The default is + // enabled. For more information, see Disabling a Scaling Policy for an Auto + // Scaling Group + // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enable-disable-scaling-policy.html) + // in the Amazon EC2 Auto Scaling User Guide. + Enabled *bool // The estimated time, in seconds, until a newly launched instance can contribute // to the CloudWatch metrics. If not provided, the default is to use the value from @@ -92,27 +102,50 @@ type PutScalingPolicyInput struct { // type is TargetTrackingScaling or StepScaling. EstimatedInstanceWarmup *int32 - // The name of the Auto Scaling group. - // - // This member is required. - AutoScalingGroupName *string - // The aggregation type for the CloudWatch metrics. The valid values are Minimum, // Maximum, and Average. If the aggregation type is null, the value is treated as // Average. Valid only if the policy type is StepScaling. MetricAggregationType *string - // The duration of the policy's cooldown period, in seconds. When a cooldown period - // is specified here, it overrides the default cooldown period defined for the Auto - // Scaling group. Valid only if the policy type is SimpleScaling. For more - // information, see Scaling Cooldowns for Amazon EC2 Auto Scaling - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in the - // Amazon EC2 Auto Scaling User Guide. - Cooldown *int32 + // The minimum value to scale by when the adjustment type is + // PercentChangeInCapacity. For example, suppose that you create a step scaling + // policy to scale out an Auto Scaling group by 25 percent and you specify a + // MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy + // is performed, 25 percent of 4 is 1. However, because you specified a + // MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 + // instances. Valid only if the policy type is StepScaling or SimpleScaling. For + // more information, see Scaling Adjustment Types + // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment) + // in the Amazon EC2 Auto Scaling User Guide. Some Auto Scaling groups use instance + // weights. In this case, set the MinAdjustmentMagnitude to a value that is at + // least as large as your largest instance weight. + MinAdjustmentMagnitude *int32 // Available for backward compatibility. Use MinAdjustmentMagnitude instead. MinAdjustmentStep *int32 + // One of the following policy types: + // + // * TargetTrackingScaling + // + // * + // StepScaling + // + // * SimpleScaling (default) + PolicyType *string + + // The amount by which to scale, based on the specified adjustment type. A positive + // value adds to the current capacity while a negative number removes from the + // current capacity. For exact capacity, you must specify a positive value. + // Required if the policy type is SimpleScaling. (Not used with any other policy + // type.) + ScalingAdjustment *int32 + + // A set of adjustments that enable you to scale based on the size of the alarm + // breach. Required if the policy type is StepScaling. (Not used with any other + // policy type.) + StepAdjustments []*types.StepAdjustment + // A target tracking scaling policy. Includes support for predefined or customized // metrics. The following predefined metrics are available: // @@ -134,50 +167,17 @@ type PutScalingPolicyInput struct { // in the Amazon EC2 Auto Scaling API Reference. Required if the policy type is // TargetTrackingScaling. TargetTrackingConfiguration *types.TargetTrackingConfiguration - - // The amount by which to scale, based on the specified adjustment type. A positive - // value adds to the current capacity while a negative number removes from the - // current capacity. For exact capacity, you must specify a positive value. - // Required if the policy type is SimpleScaling. (Not used with any other policy - // type.) - ScalingAdjustment *int32 - - // The name of the policy. - // - // This member is required. - PolicyName *string - - // The minimum value to scale by when the adjustment type is - // PercentChangeInCapacity. For example, suppose that you create a step scaling - // policy to scale out an Auto Scaling group by 25 percent and you specify a - // MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy - // is performed, 25 percent of 4 is 1. However, because you specified a - // MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 - // instances. Valid only if the policy type is StepScaling or SimpleScaling. For - // more information, see Scaling Adjustment Types - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment) - // in the Amazon EC2 Auto Scaling User Guide. Some Auto Scaling groups use instance - // weights. In this case, set the MinAdjustmentMagnitude to a value that is at - // least as large as your largest instance weight. - MinAdjustmentMagnitude *int32 - - // Indicates whether the scaling policy is enabled or disabled. The default is - // enabled. For more information, see Disabling a Scaling Policy for an Auto - // Scaling Group - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enable-disable-scaling-policy.html) - // in the Amazon EC2 Auto Scaling User Guide. - Enabled *bool } // Contains the output of PutScalingPolicy. type PutScalingPolicyOutput struct { - // The Amazon Resource Name (ARN) of the policy. - PolicyARN *string - // The CloudWatch alarms created for the target tracking scaling policy. Alarms []*types.Alarm + // The Amazon Resource Name (ARN) of the policy. + PolicyARN *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/autoscaling/api_op_PutScheduledUpdateGroupAction.go b/service/autoscaling/api_op_PutScheduledUpdateGroupAction.go index f509a0ff9f2..13752eefe8f 100644 --- a/service/autoscaling/api_op_PutScheduledUpdateGroupAction.go +++ b/service/autoscaling/api_op_PutScheduledUpdateGroupAction.go @@ -62,13 +62,20 @@ func (c *Client) PutScheduledUpdateGroupAction(ctx context.Context, params *PutS type PutScheduledUpdateGroupActionInput struct { - // The recurring schedule for this action, in Unix cron syntax format. This format - // consists of five fields separated by white spaces: [Minute] [Hour] - // [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for - // example, "30 0 1 1,6,12 *"). For more information about this format, see Crontab - // (http://crontab.org). When StartTime and EndTime are specified with Recurrence, - // they form the boundaries of when the recurring action starts and stops. - Recurrence *string + // The name of the Auto Scaling group. + // + // This member is required. + AutoScalingGroupName *string + + // The name of this scaling action. + // + // This member is required. + ScheduledActionName *string + + // The desired capacity is the initial capacity of the Auto Scaling group after the + // scheduled action runs and the capacity it attempts to maintain. It can scale + // beyond this capacity if you add more scaling conditions. + DesiredCapacity *int32 // The date and time for the recurring schedule to end. Amazon EC2 Auto Scaling // does not perform the action after this time. @@ -80,20 +87,13 @@ type PutScheduledUpdateGroupActionInput struct { // The minimum size of the Auto Scaling group. MinSize *int32 - // The name of this scaling action. - // - // This member is required. - ScheduledActionName *string - - // The name of the Auto Scaling group. - // - // This member is required. - AutoScalingGroupName *string - - // The desired capacity is the initial capacity of the Auto Scaling group after the - // scheduled action runs and the capacity it attempts to maintain. It can scale - // beyond this capacity if you add more scaling conditions. - DesiredCapacity *int32 + // The recurring schedule for this action, in Unix cron syntax format. This format + // consists of five fields separated by white spaces: [Minute] [Hour] + // [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for + // example, "30 0 1 1,6,12 *"). For more information about this format, see Crontab + // (http://crontab.org). When StartTime and EndTime are specified with Recurrence, + // they form the boundaries of when the recurring action starts and stops. + Recurrence *string // The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in // UTC/GMT only and in quotes (for example, "2019-06-01T00:00:00Z"). If you specify diff --git a/service/autoscaling/api_op_RecordLifecycleActionHeartbeat.go b/service/autoscaling/api_op_RecordLifecycleActionHeartbeat.go index d99bac97489..b06851e5b66 100644 --- a/service/autoscaling/api_op_RecordLifecycleActionHeartbeat.go +++ b/service/autoscaling/api_op_RecordLifecycleActionHeartbeat.go @@ -72,23 +72,23 @@ func (c *Client) RecordLifecycleActionHeartbeat(ctx context.Context, params *Rec type RecordLifecycleActionHeartbeatInput struct { - // The ID of the instance. - InstanceId *string + // The name of the Auto Scaling group. + // + // This member is required. + AutoScalingGroupName *string // The name of the lifecycle hook. // // This member is required. LifecycleHookName *string + // The ID of the instance. + InstanceId *string + // A token that uniquely identifies a specific lifecycle action associated with an // instance. Amazon EC2 Auto Scaling sends this token to the notification target // that you specified when you created the lifecycle hook. LifecycleActionToken *string - - // The name of the Auto Scaling group. - // - // This member is required. - AutoScalingGroupName *string } type RecordLifecycleActionHeartbeatOutput struct { diff --git a/service/autoscaling/api_op_ResumeProcesses.go b/service/autoscaling/api_op_ResumeProcesses.go index 3d395909290..bc05bde1ff4 100644 --- a/service/autoscaling/api_op_ResumeProcesses.go +++ b/service/autoscaling/api_op_ResumeProcesses.go @@ -60,6 +60,11 @@ func (c *Client) ResumeProcesses(ctx context.Context, params *ResumeProcessesInp type ResumeProcessesInput struct { + // The name of the Auto Scaling group. + // + // This member is required. + AutoScalingGroupName *string + // One or more of the following processes: // // * Launch @@ -85,11 +90,6 @@ type ResumeProcessesInput struct { // // If you omit this parameter, all processes are specified. ScalingProcesses []*string - - // The name of the Auto Scaling group. - // - // This member is required. - AutoScalingGroupName *string } type ResumeProcessesOutput struct { diff --git a/service/autoscaling/api_op_SetDesiredCapacity.go b/service/autoscaling/api_op_SetDesiredCapacity.go index 72936271c8b..9b485584293 100644 --- a/service/autoscaling/api_op_SetDesiredCapacity.go +++ b/service/autoscaling/api_op_SetDesiredCapacity.go @@ -61,11 +61,10 @@ func (c *Client) SetDesiredCapacity(ctx context.Context, params *SetDesiredCapac type SetDesiredCapacityInput struct { - // Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to - // complete before initiating a scaling activity to set your Auto Scaling group to - // its new capacity. By default, Amazon EC2 Auto Scaling does not honor the - // cooldown period during manual scaling activities. - HonorCooldown *bool + // The name of the Auto Scaling group. + // + // This member is required. + AutoScalingGroupName *string // The desired capacity is the initial capacity of the Auto Scaling group after // this operation completes and the capacity it attempts to maintain. @@ -73,10 +72,11 @@ type SetDesiredCapacityInput struct { // This member is required. DesiredCapacity *int32 - // The name of the Auto Scaling group. - // - // This member is required. - AutoScalingGroupName *string + // Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to + // complete before initiating a scaling activity to set your Auto Scaling group to + // its new capacity. By default, Amazon EC2 Auto Scaling does not honor the + // cooldown period during manual scaling activities. + HonorCooldown *bool } type SetDesiredCapacityOutput struct { diff --git a/service/autoscaling/api_op_SetInstanceHealth.go b/service/autoscaling/api_op_SetInstanceHealth.go index a0be085d030..1769df55110 100644 --- a/service/autoscaling/api_op_SetInstanceHealth.go +++ b/service/autoscaling/api_op_SetInstanceHealth.go @@ -59,6 +59,18 @@ func (c *Client) SetInstanceHealth(ctx context.Context, params *SetInstanceHealt type SetInstanceHealthInput struct { + // The health status of the instance. Set to Healthy to have the instance remain in + // service. Set to Unhealthy to have the instance be out of service. Amazon EC2 + // Auto Scaling terminates and replaces the unhealthy instance. + // + // This member is required. + HealthStatus *string + + // The ID of the instance. + // + // This member is required. + InstanceId *string + // If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod // specified for the group, by default, this call respects the grace period. Set // this to False, to have the call not respect the grace period associated with the @@ -66,18 +78,6 @@ type SetInstanceHealthInput struct { // href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_CreateAutoScalingGroup.html">CreateAutoScalingGroup // in the Amazon EC2 Auto Scaling API Reference.

ShouldRespectGracePeriod *bool - - // The ID of the instance. - // - // This member is required. - InstanceId *string - - // The health status of the instance. Set to Healthy to have the instance remain in - // service. Set to Unhealthy to have the instance be out of service. Amazon EC2 - // Auto Scaling terminates and replaces the unhealthy instance. - // - // This member is required. - HealthStatus *string } type SetInstanceHealthOutput struct { diff --git a/service/autoscaling/api_op_SetInstanceProtection.go b/service/autoscaling/api_op_SetInstanceProtection.go index f93d8f1fe19..651c6237df3 100644 --- a/service/autoscaling/api_op_SetInstanceProtection.go +++ b/service/autoscaling/api_op_SetInstanceProtection.go @@ -65,16 +65,16 @@ type SetInstanceProtectionInput struct { // This member is required. AutoScalingGroupName *string - // Indicates whether the instance is protected from termination by Amazon EC2 Auto - // Scaling when scaling in. + // One or more instance IDs. // // This member is required. - ProtectedFromScaleIn *bool + InstanceIds []*string - // One or more instance IDs. + // Indicates whether the instance is protected from termination by Amazon EC2 Auto + // Scaling when scaling in. // // This member is required. - InstanceIds []*string + ProtectedFromScaleIn *bool } type SetInstanceProtectionOutput struct { diff --git a/service/autoscaling/api_op_StartInstanceRefresh.go b/service/autoscaling/api_op_StartInstanceRefresh.go index 2593b38cf54..24806a7452a 100644 --- a/service/autoscaling/api_op_StartInstanceRefresh.go +++ b/service/autoscaling/api_op_StartInstanceRefresh.go @@ -66,6 +66,11 @@ func (c *Client) StartInstanceRefresh(ctx context.Context, params *StartInstance type StartInstanceRefreshInput struct { + // The name of the Auto Scaling group. + // + // This member is required. + AutoScalingGroupName *string + // Set of preferences associated with the instance refresh request. If not // provided, the default values are used. For MinHealthyPercentage, the default // value is 90. For InstanceWarmup, the default is to use the value specified for @@ -75,11 +80,6 @@ type StartInstanceRefreshInput struct { // in the Amazon EC2 Auto Scaling API Reference. Preferences *types.RefreshPreferences - // The name of the Auto Scaling group. - // - // This member is required. - AutoScalingGroupName *string - // The strategy to use for the instance refresh. The only valid value is Rolling. A // rolling update is an update that is applied to all instances in an Auto Scaling // group until all instances have been updated. A rolling update can fail due to diff --git a/service/autoscaling/api_op_SuspendProcesses.go b/service/autoscaling/api_op_SuspendProcesses.go index 10a485a3804..39faf7e6088 100644 --- a/service/autoscaling/api_op_SuspendProcesses.go +++ b/service/autoscaling/api_op_SuspendProcesses.go @@ -62,6 +62,11 @@ func (c *Client) SuspendProcesses(ctx context.Context, params *SuspendProcessesI type SuspendProcessesInput struct { + // The name of the Auto Scaling group. + // + // This member is required. + AutoScalingGroupName *string + // One or more of the following processes: // // * Launch @@ -87,11 +92,6 @@ type SuspendProcessesInput struct { // // If you omit this parameter, all processes are specified. ScalingProcesses []*string - - // The name of the Auto Scaling group. - // - // This member is required. - AutoScalingGroupName *string } type SuspendProcessesOutput struct { diff --git a/service/autoscaling/api_op_UpdateAutoScalingGroup.go b/service/autoscaling/api_op_UpdateAutoScalingGroup.go index eea93c283a8..bb6a7538c77 100644 --- a/service/autoscaling/api_op_UpdateAutoScalingGroup.go +++ b/service/autoscaling/api_op_UpdateAutoScalingGroup.go @@ -93,73 +93,28 @@ func (c *Client) UpdateAutoScalingGroup(ctx context.Context, params *UpdateAutoS type UpdateAutoScalingGroupInput struct { - // The desired capacity is the initial capacity of the Auto Scaling group after - // this operation completes and the capacity it attempts to maintain. This number - // must be greater than or equal to the minimum size of the group and less than or - // equal to the maximum size of the group. - DesiredCapacity *int32 - - // The name of the placement group into which to launch your instances, if any. A - // placement group is a logical grouping of instances within a single Availability - // Zone. You cannot specify multiple Availability Zones and a placement group. For - // more information, see Placement Groups - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in - // the Amazon EC2 User Guide for Linux Instances. - PlacementGroup *string - - // Indicates whether newly launched instances are protected from termination by - // Amazon EC2 Auto Scaling when scaling in. For more information about preventing - // instances from terminating on scale in, see Instance Protection - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection) - // in the Amazon EC2 Auto Scaling User Guide. - NewInstancesProtectedFromScaleIn *bool - - // The service to use for the health checks. The valid values are EC2 and ELB. If - // you configure an Auto Scaling group to use ELB health checks, it considers the - // instance unhealthy if it fails either the EC2 status checks or the load balancer - // health checks. - HealthCheckType *string - // The name of the Auto Scaling group. // // This member is required. AutoScalingGroupName *string - // The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling - // group uses to call other AWS services on your behalf. For more information, see - // Service-Linked Roles - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) - // in the Amazon EC2 Auto Scaling User Guide. - ServiceLinkedRoleARN *string - - // A standalone termination policy or a list of termination policies used to select - // the instance to terminate. The policies are executed in the order that they are - // listed. For more information, see Controlling Which Instances Auto Scaling - // Terminates During Scale In - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html) - // in the Amazon EC2 Auto Scaling User Guide. - TerminationPolicies []*string - - // The minimum size of the Auto Scaling group. - MinSize *int32 - // One or more Availability Zones for the group. AvailabilityZones []*string - // The name of the launch configuration. If you specify LaunchConfigurationName in - // your update request, you can't specify LaunchTemplate or MixedInstancesPolicy. - LaunchConfigurationName *string + // The amount of time, in seconds, after a scaling activity completes before + // another scaling activity can start. The default value is 300. This setting + // applies when using simple scaling policies, but not when using other scaling + // policies or scheduled scaling. For more information, see Scaling Cooldowns for + // Amazon EC2 Auto Scaling + // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in the + // Amazon EC2 Auto Scaling User Guide. + DefaultCooldown *int32 - // An embedded object that specifies a mixed instances policy. In your call to - // UpdateAutoScalingGroup, you can make changes to the policy that is specified. - // All optional parameters are left unchanged if not specified.

For more - // information, see MixedInstancesPolicy - // in the Amazon EC2 Auto Scaling API Reference and Auto - // Scaling Groups with Multiple Instance Types and Purchase Options in the - // Amazon EC2 Auto Scaling User Guide.

- MixedInstancesPolicy *types.MixedInstancesPolicy + // The desired capacity is the initial capacity of the Auto Scaling group after + // this operation completes and the capacity it attempts to maintain. This number + // must be greater than or equal to the minimum size of the group and less than or + // equal to the maximum size of the group. + DesiredCapacity *int32 // The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before // checking the health status of an EC2 instance that has come into service. The @@ -169,6 +124,23 @@ type UpdateAutoScalingGroupInput struct { // health check. HealthCheckGracePeriod *int32 + // The service to use for the health checks. The valid values are EC2 and ELB. If + // you configure an Auto Scaling group to use ELB health checks, it considers the + // instance unhealthy if it fails either the EC2 status checks or the load balancer + // health checks. + HealthCheckType *string + + // The name of the launch configuration. If you specify LaunchConfigurationName in + // your update request, you can't specify LaunchTemplate or MixedInstancesPolicy. + LaunchConfigurationName *string + + // The launch template and version to use to specify the updates. If you specify + // LaunchTemplate in your update request, you can't specify LaunchConfigurationName + // or MixedInstancesPolicy. For more information, see LaunchTemplateSpecification + // (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_LaunchTemplateSpecification.html) + // in the Amazon EC2 Auto Scaling API Reference. + LaunchTemplate *types.LaunchTemplateSpecification + // The maximum amount of time, in seconds, that an instance can be in service. The // default is null. This parameter is optional, but if you specify a value for it, // you must specify a value of at least 604,800 seconds (7 days). To clear a @@ -186,26 +158,54 @@ type UpdateAutoScalingGroupInput struct { // group). MaxSize *int32 - // The amount of time, in seconds, after a scaling activity completes before - // another scaling activity can start. The default value is 300. This setting - // applies when using simple scaling policies, but not when using other scaling - // policies or scheduled scaling. For more information, see Scaling Cooldowns for - // Amazon EC2 Auto Scaling - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in the - // Amazon EC2 Auto Scaling User Guide. - DefaultCooldown *int32 + // The minimum size of the Auto Scaling group. + MinSize *int32 + + // An embedded object that specifies a mixed instances policy. In your call to + // UpdateAutoScalingGroup, you can make changes to the policy that is specified. + // All optional parameters are left unchanged if not specified.

For more + // information, see MixedInstancesPolicy + // in the Amazon EC2 Auto Scaling API Reference and Auto + // Scaling Groups with Multiple Instance Types and Purchase Options in the + // Amazon EC2 Auto Scaling User Guide.

+ MixedInstancesPolicy *types.MixedInstancesPolicy + + // Indicates whether newly launched instances are protected from termination by + // Amazon EC2 Auto Scaling when scaling in. For more information about preventing + // instances from terminating on scale in, see Instance Protection + // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection) + // in the Amazon EC2 Auto Scaling User Guide. + NewInstancesProtectedFromScaleIn *bool + + // The name of the placement group into which to launch your instances, if any. A + // placement group is a logical grouping of instances within a single Availability + // Zone. You cannot specify multiple Availability Zones and a placement group. For + // more information, see Placement Groups + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in + // the Amazon EC2 User Guide for Linux Instances. + PlacementGroup *string + + // The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling + // group uses to call other AWS services on your behalf. For more information, see + // Service-Linked Roles + // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) + // in the Amazon EC2 Auto Scaling User Guide. + ServiceLinkedRoleARN *string + + // A standalone termination policy or a list of termination policies used to select + // the instance to terminate. The policies are executed in the order that they are + // listed. For more information, see Controlling Which Instances Auto Scaling + // Terminates During Scale In + // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html) + // in the Amazon EC2 Auto Scaling User Guide. + TerminationPolicies []*string // A comma-separated list of subnet IDs for virtual private cloud (VPC). If you // specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify // for this parameter must reside in those Availability Zones. VPCZoneIdentifier *string - - // The launch template and version to use to specify the updates. If you specify - // LaunchTemplate in your update request, you can't specify LaunchConfigurationName - // or MixedInstancesPolicy. For more information, see LaunchTemplateSpecification - // (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_LaunchTemplateSpecification.html) - // in the Amazon EC2 Auto Scaling API Reference. - LaunchTemplate *types.LaunchTemplateSpecification } type UpdateAutoScalingGroupOutput struct { diff --git a/service/autoscaling/go.mod b/service/autoscaling/go.mod index d858f5977a3..2c61638c351 100644 --- a/service/autoscaling/go.mod +++ b/service/autoscaling/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/autoscaling go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/autoscaling/types/types.go b/service/autoscaling/types/types.go index b10a59256af..22d070077c6 100644 --- a/service/autoscaling/types/types.go +++ b/service/autoscaling/types/types.go @@ -11,45 +11,45 @@ import ( // instance. type Activity struct { - // The start time of the activity. + // The ID of the activity. // // This member is required. - StartTime *time.Time - - // The end time of the activity. - EndTime *time.Time - - // A friendly, more verbose description of the activity status. - StatusMessage *string + ActivityId *string - // The current status of the activity. + // The name of the Auto Scaling group. // // This member is required. - StatusCode ScalingActivityStatusCode - - // The details about the activity. - Details *string - - // A value between 0 and 100 that indicates the progress of the activity. - Progress *int32 + AutoScalingGroupName *string // The reason the activity began. // // This member is required. Cause *string - // A friendly, more verbose description of the activity. - Description *string - - // The name of the Auto Scaling group. + // The start time of the activity. // // This member is required. - AutoScalingGroupName *string + StartTime *time.Time - // The ID of the activity. + // The current status of the activity. // // This member is required. - ActivityId *string + StatusCode ScalingActivityStatusCode + + // A friendly, more verbose description of the activity. + Description *string + + // The details about the activity. + Details *string + + // The end time of the activity. + EndTime *time.Time + + // A value between 0 and 100 that indicates the progress of the activity. + Progress *int32 + + // A friendly, more verbose description of the activity status. + StatusMessage *string } // Describes a policy adjustment type. @@ -73,117 +73,121 @@ type Alarm struct { // Describes an Auto Scaling group. type AutoScalingGroup struct { - // The tags for the group. - Tags []*TagDescription - - // The metrics enabled for the group. - EnabledMetrics []*EnabledMetric - - // One or more subnet IDs, if applicable, separated by commas. - VPCZoneIdentifier *string - - // The mixed instances policy for the group. - MixedInstancesPolicy *MixedInstancesPolicy - - // The service to use for the health checks. The valid values are EC2 and ELB. If - // you configure an Auto Scaling group to use ELB health checks, it considers the - // instance unhealthy if it fails either the EC2 status checks or the load balancer - // health checks. + // The name of the Auto Scaling group. // // This member is required. - HealthCheckType *string - - // The maximum amount of time, in seconds, that an instance can be in service. - // Valid Range: Minimum value of 0. - MaxInstanceLifetime *int32 - - // The suspended processes associated with the group. - SuspendedProcesses []*SuspendedProcess + AutoScalingGroupName *string // One or more Availability Zones for the group. // // This member is required. AvailabilityZones []*string - // The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling - // group uses to call other AWS services on your behalf. - ServiceLinkedRoleARN *string - - // Indicates whether newly launched instances are protected from termination by - // Amazon EC2 Auto Scaling when scaling in. - NewInstancesProtectedFromScaleIn *bool - // The date and time the group was created. // // This member is required. CreatedTime *time.Time - // The maximum size of the group. + // The duration of the default cooldown period, in seconds. // // This member is required. - MaxSize *int32 - - // The launch template for the group. - LaunchTemplate *LaunchTemplateSpecification - - // The name of the placement group into which to launch your instances, if any. - PlacementGroup *string + DefaultCooldown *int32 // The desired size of the group. // // This member is required. DesiredCapacity *int32 - // The minimum size of the group. + // The service to use for the health checks. The valid values are EC2 and ELB. If + // you configure an Auto Scaling group to use ELB health checks, it considers the + // instance unhealthy if it fails either the EC2 status checks or the load balancer + // health checks. // // This member is required. - MinSize *int32 + HealthCheckType *string - // The name of the Auto Scaling group. + // The maximum size of the group. // // This member is required. - AutoScalingGroupName *string + MaxSize *int32 - // The termination policies for the group. - TerminationPolicies []*string + // The minimum size of the group. + // + // This member is required. + MinSize *int32 - // The Amazon Resource Names (ARN) of the target groups for your load balancer. - TargetGroupARNs []*string + // The Amazon Resource Name (ARN) of the Auto Scaling group. + AutoScalingGroupARN *string + + // The metrics enabled for the group. + EnabledMetrics []*EnabledMetric + + // The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before + // checking the health status of an EC2 instance that has come into service. + HealthCheckGracePeriod *int32 + + // The EC2 instances associated with the group. + Instances []*Instance // The name of the associated launch configuration. LaunchConfigurationName *string - // The Amazon Resource Name (ARN) of the Auto Scaling group. - AutoScalingGroupARN *string + // The launch template for the group. + LaunchTemplate *LaunchTemplateSpecification // One or more load balancers associated with the group. LoadBalancerNames []*string + // The maximum amount of time, in seconds, that an instance can be in service. + // Valid Range: Minimum value of 0. + MaxInstanceLifetime *int32 + + // The mixed instances policy for the group. + MixedInstancesPolicy *MixedInstancesPolicy + + // Indicates whether newly launched instances are protected from termination by + // Amazon EC2 Auto Scaling when scaling in. + NewInstancesProtectedFromScaleIn *bool + + // The name of the placement group into which to launch your instances, if any. + PlacementGroup *string + + // The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling + // group uses to call other AWS services on your behalf. + ServiceLinkedRoleARN *string + // The current state of the group when the DeleteAutoScalingGroup () operation is // in progress. Status *string - // The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before - // checking the health status of an EC2 instance that has come into service. - HealthCheckGracePeriod *int32 + // The suspended processes associated with the group. + SuspendedProcesses []*SuspendedProcess - // The duration of the default cooldown period, in seconds. - // - // This member is required. - DefaultCooldown *int32 + // The tags for the group. + Tags []*TagDescription - // The EC2 instances associated with the group. - Instances []*Instance + // The Amazon Resource Names (ARN) of the target groups for your load balancer. + TargetGroupARNs []*string + + // The termination policies for the group. + TerminationPolicies []*string + + // One or more subnet IDs, if applicable, separated by commas. + VPCZoneIdentifier *string } // Describes an EC2 instance associated with an Auto Scaling group. type AutoScalingInstanceDetails struct { - // Indicates whether the instance is protected from termination by Amazon EC2 Auto - // Scaling when scaling in. + // The name of the Auto Scaling group for the instance. // // This member is required. - ProtectedFromScaleIn *bool + AutoScalingGroupName *string + + // The Availability Zone for the instance. + // + // This member is required. + AvailabilityZone *string // The last reported health status of this instance. "Healthy" means that the // instance is healthy and should remain in service. "Unhealthy" means that the @@ -203,22 +207,11 @@ type AutoScalingInstanceDetails struct { // This member is required. LifecycleState *string - // The launch template for the instance. - LaunchTemplate *LaunchTemplateSpecification - - // The name of the Auto Scaling group for the instance. - // - // This member is required. - AutoScalingGroupName *string - - // The Availability Zone for the instance. + // Indicates whether the instance is protected from termination by Amazon EC2 Auto + // Scaling when scaling in. // // This member is required. - AvailabilityZone *string - - // The number of capacity units contributed by the instance based on its instance - // type. Valid Range: Minimum value of 1. Maximum value of 999. - WeightedCapacity *string + ProtectedFromScaleIn *bool // The instance type of the EC2 instance. InstanceType *string @@ -226,25 +219,18 @@ type AutoScalingInstanceDetails struct { // The launch configuration used to launch the instance. This value is not // available if you attached the instance to the Auto Scaling group. LaunchConfigurationName *string + + // The launch template for the instance. + LaunchTemplate *LaunchTemplateSpecification + + // The number of capacity units contributed by the instance based on its instance + // type. Valid Range: Minimum value of 1. Maximum value of 999. + WeightedCapacity *string } // Describes a block device mapping. type BlockDeviceMapping struct { - // The name of the virtual device (for example, ephemeral0). You can specify either - // VirtualName or Ebs, but not both. - VirtualName *string - - // Setting this value to true suppresses the specified device included in the block - // device mapping of the AMI. If NoDevice is true for the root device, instances - // might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches - // replacement instances. If you specify NoDevice, you cannot specify Ebs. - NoDevice *bool - - // Parameters used to automatically set up EBS volumes when an instance is - // launched. You can specify either VirtualName or Ebs, but not both. - Ebs *Ebs - // The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh). For // more information, see Device Naming on Linux Instances // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html) in the @@ -252,6 +238,20 @@ type BlockDeviceMapping struct { // // This member is required. DeviceName *string + + // Parameters used to automatically set up EBS volumes when an instance is + // launched. You can specify either VirtualName or Ebs, but not both. + Ebs *Ebs + + // Setting this value to true suppresses the specified device included in the block + // device mapping of the AMI. If NoDevice is true for the root device, instances + // might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches + // replacement instances. If you specify NoDevice, you cannot specify Ebs. + NoDevice *bool + + // The name of the virtual device (for example, ephemeral0). You can specify either + // VirtualName or Ebs, but not both. + VirtualName *string } // Represents a CloudWatch metric of your choosing for a target tracking scaling @@ -275,27 +275,27 @@ type BlockDeviceMapping struct { // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html). type CustomizedMetricSpecification struct { + // The name of the metric. + // + // This member is required. + MetricName *string + // The namespace of the metric. // // This member is required. Namespace *string + // The statistic of the metric. + // + // This member is required. + Statistic MetricStatistic + // The dimensions of the metric. Conditional: If you published your metric with // dimensions, you must specify the same dimensions in your scaling policy. Dimensions []*MetricDimension // The unit of the metric. Unit *string - - // The statistic of the metric. - // - // This member is required. - Statistic MetricStatistic - - // The name of the metric. - // - // This member is required. - MetricName *string } // Describes information used to set up an Amazon EBS volume specified in a block @@ -331,6 +331,18 @@ type Ebs struct { // in the Amazon EC2 Auto Scaling User Guide. Encrypted *bool + // The number of I/O operations per second (IOPS) to provision for the volume. The + // maximum ratio of IOPS to volume size (in GiB) is 50:1. For more information, see + // Amazon EBS Volume Types + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the + // Amazon EC2 User Guide for Linux Instances. Required when the volume type is io1. + // (Not used with standard, gp2, st1, or sc1 volumes.) + Iops *int32 + + // The snapshot ID of the volume to use. You must specify either a VolumeSize or a + // SnapshotId. + SnapshotId *string + // The volume size, in Gibibytes (GiB). This can be a number from 1-1,024 for // standard, 4-16,384 for io1, 1-16,384 for gp2, and 500-16,384 for st1 and sc1. If // you specify a snapshot, the volume size must be equal to or larger than the @@ -347,18 +359,6 @@ type Ebs struct { // Amazon EC2 User Guide for Linux Instances. Valid Values: standard | io1 | gp2 | // st1 | sc1 VolumeType *string - - // The snapshot ID of the volume to use. You must specify either a VolumeSize or a - // SnapshotId. - SnapshotId *string - - // The number of I/O operations per second (IOPS) to provision for the volume. The - // maximum ratio of IOPS to volume size (in GiB) is 50:1. For more information, see - // Amazon EBS Volume Types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the - // Amazon EC2 User Guide for Linux Instances. Required when the volume type is io1. - // (Not used with standard, gp2, st1, or sc1 volumes.) - Iops *int32 } // Describes an enabled metric. @@ -405,14 +405,14 @@ type EnabledMetric struct { // Describes a scheduled action that could not be created, updated, or deleted. type FailedScheduledUpdateGroupActionRequest struct { - // The error code. - ErrorCode *string - // The name of the scheduled action. // // This member is required. ScheduledActionName *string + // The error code. + ErrorCode *string + // The error message accompanying the error code. ErrorMessage *string } @@ -424,22 +424,21 @@ type FailedScheduledUpdateGroupActionRequest struct { // in the Amazon EC2 Auto Scaling User Guide. type Filter struct { - // One or more filter values. Filter values are case-sensitive. - Values []*string - // The name of the filter. The valid values are: auto-scaling-group, key, value, // and propagate-at-launch. Name *string + + // One or more filter values. Filter values are case-sensitive. + Values []*string } // Describes an EC2 instance. type Instance struct { - // Indicates whether the instance is protected from termination by Amazon EC2 Auto - // Scaling when scaling in. + // The Availability Zone in which the instance is running. // // This member is required. - ProtectedFromScaleIn *bool + AvailabilityZone *string // The last reported health status of the instance. "Healthy" means that the // instance is healthy and should remain in service. "Unhealthy" means that the @@ -454,28 +453,29 @@ type Instance struct { // This member is required. InstanceId *string - // The launch template for the instance. - LaunchTemplate *LaunchTemplateSpecification - // A description of the current lifecycle state. The Quarantined state is not used. // // This member is required. LifecycleState LifecycleState - // The Availability Zone in which the instance is running. + // Indicates whether the instance is protected from termination by Amazon EC2 Auto + // Scaling when scaling in. // // This member is required. - AvailabilityZone *string - - // The number of capacity units contributed by the instance based on its instance - // type. Valid Range: Minimum value of 1. Maximum value of 999. - WeightedCapacity *string + ProtectedFromScaleIn *bool // The instance type of the EC2 instance. InstanceType *string // The launch configuration associated with the instance. LaunchConfigurationName *string + + // The launch template for the instance. + LaunchTemplate *LaunchTemplateSpecification + + // The number of capacity units contributed by the instance based on its instance + // type. Valid Range: Minimum value of 1. Maximum value of 999. + WeightedCapacity *string } // The metadata options for the instances. For more information, see Instance @@ -484,6 +484,16 @@ type Instance struct { // in the Amazon EC2 User Guide for Linux Instances. type InstanceMetadataOptions struct { + // This parameter enables or disables the HTTP metadata endpoint on your instances. + // If the parameter is not specified, the default state is enabled. If you specify + // a value of disabled, you will not be able to access your instance metadata. + HttpEndpoint InstanceMetadataEndpointState + + // The desired HTTP PUT response hop limit for instance metadata requests. The + // larger the number, the further instance metadata requests can travel. Default: 1 + // Possible values: Integers from 1 to 64 + HttpPutResponseHopLimit *int32 + // The state of token usage for your instance metadata requests. If the parameter // is not specified in the request, the default state is optional. If the state is // optional, you can choose to retrieve instance metadata with or without a signed @@ -495,16 +505,6 @@ type InstanceMetadataOptions struct { // credentials always returns the version 2.0 credentials; the version 1.0 // credentials are not available. HttpTokens InstanceMetadataHttpTokensState - - // The desired HTTP PUT response hop limit for instance metadata requests. The - // larger the number, the further instance metadata requests can travel. Default: 1 - // Possible values: Integers from 1 to 64 - HttpPutResponseHopLimit *int32 - - // This parameter enables or disables the HTTP metadata endpoint on your instances. - // If the parameter is not specified, the default state is enabled. If you specify - // a value of disabled, you will not be able to access your instance metadata. - HttpEndpoint InstanceMetadataEndpointState } // Describes whether detailed monitoring is enabled for the Auto Scaling instances. @@ -517,9 +517,19 @@ type InstanceMonitoring struct { // Describes an instance refresh for an Auto Scaling group. type InstanceRefresh struct { + // The name of the Auto Scaling group. + AutoScalingGroupName *string + // The date and time at which the instance refresh ended. EndTime *time.Time + // The instance refresh ID. + InstanceRefreshId *string + + // The number of instances remaining to update before the instance refresh is + // complete. + InstancesToUpdate *int32 + // The percentage of the instance refresh that is complete. For each instance // replacement, Amazon EC2 Auto Scaling tracks the instance's health status and // warm-up time. When the instance's health status changes to healthy and the @@ -527,13 +537,6 @@ type InstanceRefresh struct { // the percentage complete. PercentageComplete *int32 - // The number of instances remaining to update before the instance refresh is - // complete. - InstancesToUpdate *int32 - - // The instance refresh ID. - InstanceRefreshId *string - // The date and time at which the instance refresh began. StartTime *time.Time @@ -561,9 +564,6 @@ type InstanceRefresh struct { // Provides more details about the current status of the instance refresh. StatusReason *string - - // The name of the Auto Scaling group. - AutoScalingGroupName *string } // Describes an instances distribution for an Auto Scaling group with a @@ -580,23 +580,15 @@ type InstanceRefresh struct { // termination policies. type InstancesDistribution struct { - // Indicates how to allocate instances across Spot Instance pools. If the - // allocation strategy is lowest-price, the Auto Scaling group launches instances - // using the Spot pools with the lowest price, and evenly allocates your instances - // across the number of Spot pools that you specify. If the allocation strategy is - // capacity-optimized, the Auto Scaling group launches instances using Spot pools - // that are optimally chosen based on the available Spot capacity. The default Spot - // allocation strategy for calls that you make through the API, the AWS CLI, or the - // AWS SDKs is lowest-price. The default Spot allocation strategy for the AWS - // Management Console is capacity-optimized. Valid values: lowest-price | - // capacity-optimized - SpotAllocationStrategy *string - - // The maximum price per unit hour that you are willing to pay for a Spot Instance. - // If you leave the value of this parameter blank (which is the default), the - // maximum Spot price is set at the On-Demand price. To remove a value that you - // previously set, include the parameter but leave the value blank. - SpotMaxPrice *string + // Indicates how to allocate instance types to fulfill On-Demand capacity. The only + // valid value is prioritized, which is also the default value. This strategy uses + // the order of instance type overrides for the LaunchTemplate () to define the + // launch priority of each instance type. The first instance type in the array is + // prioritized higher than the last. If all your On-Demand capacity cannot be + // fulfilled using your highest priority instance, then the Auto Scaling groups + // launches the remaining capacity using the second priority instance type, and so + // on. + OnDemandAllocationStrategy *string // The minimum amount of the Auto Scaling group's capacity that must be fulfilled // by On-Demand Instances. This base portion is provisioned first as your group @@ -618,6 +610,18 @@ type InstancesDistribution struct { // Minimum value of 0. Maximum value of 100. OnDemandPercentageAboveBaseCapacity *int32 + // Indicates how to allocate instances across Spot Instance pools. If the + // allocation strategy is lowest-price, the Auto Scaling group launches instances + // using the Spot pools with the lowest price, and evenly allocates your instances + // across the number of Spot pools that you specify. If the allocation strategy is + // capacity-optimized, the Auto Scaling group launches instances using Spot pools + // that are optimally chosen based on the available Spot capacity. The default Spot + // allocation strategy for calls that you make through the API, the AWS CLI, or the + // AWS SDKs is lowest-price. The default Spot allocation strategy for the AWS + // Management Console is capacity-optimized. Valid values: lowest-price | + // capacity-optimized + SpotAllocationStrategy *string + // The number of Spot Instance pools across which to allocate your Spot Instances. // The Spot pools are determined from the different instance types in the Overrides // array of LaunchTemplate (). Default if not set is 2. Used only when the Spot @@ -625,20 +629,29 @@ type InstancesDistribution struct { // value of 20. SpotInstancePools *int32 - // Indicates how to allocate instance types to fulfill On-Demand capacity. The only - // valid value is prioritized, which is also the default value. This strategy uses - // the order of instance type overrides for the LaunchTemplate () to define the - // launch priority of each instance type. The first instance type in the array is - // prioritized higher than the last. If all your On-Demand capacity cannot be - // fulfilled using your highest priority instance, then the Auto Scaling groups - // launches the remaining capacity using the second priority instance type, and so - // on. - OnDemandAllocationStrategy *string + // The maximum price per unit hour that you are willing to pay for a Spot Instance. + // If you leave the value of this parameter blank (which is the default), the + // maximum Spot price is set at the On-Demand price. To remove a value that you + // previously set, include the parameter but leave the value blank. + SpotMaxPrice *string } // Describes a launch configuration. type LaunchConfiguration struct { + // The creation date and time for the launch configuration. + // + // This member is required. + CreatedTime *time.Time + + // The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. + // For more information, see Finding an AMI + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html) in the + // Amazon EC2 User Guide for Linux Instances. + // + // This member is required. + ImageId *string + // The instance type for the instances. For information about available instance // types, see Available Instance Types // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes) @@ -647,6 +660,33 @@ type LaunchConfiguration struct { // This member is required. InstanceType *string + // The name of the launch configuration. + // + // This member is required. + LaunchConfigurationName *string + + // For Auto Scaling groups that are running in a VPC, specifies whether to assign a + // public IP address to the group's instances. For more information, see Launching + // Auto Scaling Instances in a VPC + // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html) in the + // Amazon EC2 Auto Scaling User Guide. + AssociatePublicIpAddress *bool + + // A block device mapping, which specifies the block devices for the instance. For + // more information, see Block Device Mapping + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) + // in the Amazon EC2 User Guide for Linux Instances. + BlockDeviceMappings []*BlockDeviceMapping + + // The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For + // more information, see ClassicLink + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html) in + // the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances + // to a VPC + // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink) + // in the Amazon EC2 Auto Scaling User Guide. + ClassicLinkVPCId *string + // The IDs of one or more security groups for the VPC specified in // ClassicLinkVPCId. For more information, see ClassicLink // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html) in @@ -656,21 +696,19 @@ type LaunchConfiguration struct { // in the Amazon EC2 Auto Scaling User Guide. ClassicLinkVPCSecurityGroups []*string - // A list that contains the security groups to assign to the instances in the Auto - // Scaling group. For more information, see Security Groups for Your VPC - // (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html) - // in the Amazon Virtual Private Cloud User Guide. - SecurityGroups []*string - - // The Amazon Resource Name (ARN) of the launch configuration. - LaunchConfigurationARN *string + // Specifies whether the launch configuration is optimized for EBS I/O (true) or + // not (false). For more information, see Amazon EBS-Optimized Instances + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html) in the + // Amazon EC2 User Guide for Linux Instances. + EbsOptimized *bool - // For Auto Scaling groups that are running in a VPC, specifies whether to assign a - // public IP address to the group's instances. For more information, see Launching - // Auto Scaling Instances in a VPC - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html) in the + // The name or the Amazon Resource Name (ARN) of the instance profile associated + // with the IAM role for the instance. The instance profile contains the IAM role. + // For more information, see IAM Role for Applications That Run on Amazon EC2 + // Instances + // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html) in the // Amazon EC2 Auto Scaling User Guide. - AssociatePublicIpAddress *bool + IamInstanceProfile *string // Controls whether instances in this group are launched with detailed (true) or // basic (false) monitoring. For more information, see Configure Monitoring for @@ -679,6 +717,23 @@ type LaunchConfiguration struct { // in the Amazon EC2 Auto Scaling User Guide. InstanceMonitoring *InstanceMonitoring + // The ID of the kernel associated with the AMI. + KernelId *string + + // The name of the key pair. For more information, see Amazon EC2 Key Pairs + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) in the + // Amazon EC2 User Guide for Linux Instances. + KeyName *string + + // The Amazon Resource Name (ARN) of the launch configuration. + LaunchConfigurationARN *string + + // The metadata options for the instances. For more information, see Instance + // Metadata and User Data + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) + // in the Amazon EC2 User Guide for Linux Instances. + MetadataOptions *InstanceMetadataOptions + // The tenancy of the instance, either default or dedicated. An instance with // dedicated tenancy runs on isolated, single-tenant hardware and can only be // launched into a VPC. For more information, see Instance Placement Tenancy @@ -686,16 +741,14 @@ type LaunchConfiguration struct { // in the Amazon EC2 Auto Scaling User Guide. PlacementTenancy *string - // The metadata options for the instances. For more information, see Instance - // Metadata and User Data - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) - // in the Amazon EC2 User Guide for Linux Instances. - MetadataOptions *InstanceMetadataOptions + // The ID of the RAM disk associated with the AMI. + RamdiskId *string - // The name of the launch configuration. - // - // This member is required. - LaunchConfigurationName *string + // A list that contains the security groups to assign to the instances in the Auto + // Scaling group. For more information, see Security Groups for Your VPC + // (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html) + // in the Amazon Virtual Private Cloud User Guide. + SecurityGroups []*string // The maximum hourly price to be paid for any Spot Instance launched to fulfill // the request. Spot Instances are launched when the price you specify exceeds the @@ -705,64 +758,11 @@ type LaunchConfiguration struct { // in the Amazon EC2 Auto Scaling User Guide. SpotPrice *string - // The ID of the RAM disk associated with the AMI. - RamdiskId *string - - // The name of the key pair. For more information, see Amazon EC2 Key Pairs - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) in the - // Amazon EC2 User Guide for Linux Instances. - KeyName *string - - // The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. - // For more information, see Finding an AMI - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html) in the - // Amazon EC2 User Guide for Linux Instances. - // - // This member is required. - ImageId *string - - // The name or the Amazon Resource Name (ARN) of the instance profile associated - // with the IAM role for the instance. The instance profile contains the IAM role. - // For more information, see IAM Role for Applications That Run on Amazon EC2 - // Instances - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html) in the - // Amazon EC2 Auto Scaling User Guide. - IamInstanceProfile *string - // The Base64-encoded user data to make available to the launched EC2 instances. // For more information, see Instance Metadata and User Data // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) // in the Amazon EC2 User Guide for Linux Instances. UserData *string - - // The ID of the kernel associated with the AMI. - KernelId *string - - // Specifies whether the launch configuration is optimized for EBS I/O (true) or - // not (false). For more information, see Amazon EBS-Optimized Instances - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html) in the - // Amazon EC2 User Guide for Linux Instances. - EbsOptimized *bool - - // A block device mapping, which specifies the block devices for the instance. For - // more information, see Block Device Mapping - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) - // in the Amazon EC2 User Guide for Linux Instances. - BlockDeviceMappings []*BlockDeviceMapping - - // The creation date and time for the launch configuration. - // - // This member is required. - CreatedTime *time.Time - - // The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For - // more information, see ClassicLink - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html) in - // the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances - // to a VPC - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink) - // in the Amazon EC2 Auto Scaling User Guide. - ClassicLinkVPCId *string } // Describes a launch template and overrides. The overrides are used to override @@ -774,16 +774,16 @@ type LaunchConfiguration struct { // instances according to the group's termination policies. type LaunchTemplate struct { + // The launch template to use. You must specify either the launch template ID or + // launch template name in the request. + LaunchTemplateSpecification *LaunchTemplateSpecification + // Any parameters that you specify override the same parameters in the launch // template. Currently, the only supported override is instance type. You can // specify between 1 and 20 instance types. If not provided, Amazon EC2 Auto // Scaling will use the instance type specified in the launch template to launch // instances. Overrides []*LaunchTemplateOverrides - - // The launch template to use. You must specify either the launch template ID or - // launch template name in the request. - LaunchTemplateSpecification *LaunchTemplateSpecification } // Describes an override for a launch template. Currently, the only supported @@ -791,6 +791,13 @@ type LaunchTemplate struct { // can be associated with an Auto Scaling group is 20. type LaunchTemplateOverrides struct { + // The instance type. You must use an instance type that is supported in your + // requested Region and Availability Zones. For information about available + // instance types, see Available Instance Types + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes) + // in the Amazon Elastic Compute Cloud User Guide. + InstanceType *string + // The number of capacity units, which gives the instance type a proportional // weight to other instance types. For example, larger instance types are generally // weighted more than smaller instance types. These are the same units that you @@ -801,13 +808,6 @@ type LaunchTemplateOverrides struct { // in the Amazon EC2 Auto Scaling User Guide. Valid Range: Minimum value of 1. // Maximum value of 999. WeightedCapacity *string - - // The instance type. You must use an instance type that is supported in your - // requested Region and Availability Zones. For information about available - // instance types, see Available Instance Types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes) - // in the Amazon Elastic Compute Cloud User Guide. - InstanceType *string } // Describes the Amazon EC2 launch template and the launch template version that @@ -828,6 +828,15 @@ type LaunchTemplateSpecification struct { // API. You must specify either a template ID or a template name. LaunchTemplateId *string + // The name of the launch template. To get the template name, use the Amazon EC2 + // DescribeLaunchTemplates + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html) + // API operation. New launch templates can be created using the Amazon EC2 + // CreateLaunchTemplate + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html) + // API. You must specify either a template ID or a template name. + LaunchTemplateName *string + // The version number, $Latest, or $Default. To get the version number, use the // Amazon EC2 DescribeLaunchTemplateVersions // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplateVersions.html) @@ -839,51 +848,32 @@ type LaunchTemplateSpecification struct { // Amazon EC2 Auto Scaling selects the default version of the launch template when // launching instances. The default value is $Default. Version *string - - // The name of the launch template. To get the template name, use the Amazon EC2 - // DescribeLaunchTemplates - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html) - // API operation. New launch templates can be created using the Amazon EC2 - // CreateLaunchTemplate - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html) - // API. You must specify either a template ID or a template name. - LaunchTemplateName *string } // Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to // perform an action whenever it launches instances or terminates instances. type LifecycleHook struct { - // The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when - // an instance is in the transition state for the lifecycle hook. The notification - // target can be either an SQS queue or an SNS topic. - NotificationTargetARN *string - - // The ARN of the IAM role that allows the Auto Scaling group to publish to the - // specified notification target. - RoleARN *string - - // The name of the lifecycle hook. - LifecycleHookName *string + // The name of the Auto Scaling group for the lifecycle hook. + AutoScalingGroupName *string // Defines the action the Auto Scaling group should take when the lifecycle hook // timeout elapses or if an unexpected failure occurs. The possible values are // CONTINUE and ABANDON. DefaultResult *string - // Additional information that is included any time Amazon EC2 Auto Scaling sends a - // message to the notification target. - NotificationMetadata *string + // The maximum time, in seconds, that an instance can remain in a Pending:Wait or + // Terminating:Wait state. The maximum is 172800 seconds (48 hours) or 100 times + // HeartbeatTimeout, whichever is smaller. + GlobalTimeout *int32 // The maximum time, in seconds, that can elapse before the lifecycle hook times // out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the // action that you specified in the DefaultResult parameter. HeartbeatTimeout *int32 - // The maximum time, in seconds, that an instance can remain in a Pending:Wait or - // Terminating:Wait state. The maximum is 172800 seconds (48 hours) or 100 times - // HeartbeatTimeout, whichever is smaller. - GlobalTimeout *int32 + // The name of the lifecycle hook. + LifecycleHookName *string // The state of the EC2 instance to which to attach the lifecycle hook. The // following are possible values: @@ -894,8 +884,18 @@ type LifecycleHook struct { // autoscaling:EC2_INSTANCE_TERMINATING LifecycleTransition *string - // The name of the Auto Scaling group for the lifecycle hook. - AutoScalingGroupName *string + // Additional information that is included any time Amazon EC2 Auto Scaling sends a + // message to the notification target. + NotificationMetadata *string + + // The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when + // an instance is in the transition state for the lifecycle hook. The notification + // target can be either an SQS queue or an SNS topic. + NotificationTargetARN *string + + // The ARN of the IAM role that allows the Auto Scaling group to publish to the + // specified notification target. + RoleARN *string } // Describes information used to specify a lifecycle hook for an Auto Scaling @@ -929,10 +929,10 @@ type LifecycleHook struct { // the Amazon EC2 Auto Scaling User Guide. type LifecycleHookSpecification struct { - // The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when - // an instance is in the transition state for the lifecycle hook. The notification - // target can be either an SQS queue or an SNS topic. - NotificationTargetARN *string + // The name of the lifecycle hook. + // + // This member is required. + LifecycleHookName *string // The state of the EC2 instance to which you want to attach the lifecycle hook. // The valid values are: @@ -945,30 +945,30 @@ type LifecycleHookSpecification struct { // This member is required. LifecycleTransition *string - // Additional information that you want to include any time Amazon EC2 Auto Scaling - // sends a message to the notification target. - NotificationMetadata *string - - // The ARN of the IAM role that allows the Auto Scaling group to publish to the - // specified notification target, for example, an Amazon SNS topic or an Amazon SQS - // queue. - RoleARN *string - // Defines the action the Auto Scaling group should take when the lifecycle hook // timeout elapses or if an unexpected failure occurs. The valid values are // CONTINUE and ABANDON. The default value is ABANDON. DefaultResult *string - // The name of the lifecycle hook. - // - // This member is required. - LifecycleHookName *string - // The maximum time, in seconds, that can elapse before the lifecycle hook times // out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the // action that you specified in the DefaultResult parameter. You can prevent the // lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat (). HeartbeatTimeout *int32 + + // Additional information that you want to include any time Amazon EC2 Auto Scaling + // sends a message to the notification target. + NotificationMetadata *string + + // The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when + // an instance is in the transition state for the lifecycle hook. The notification + // target can be either an SQS queue or an SNS topic. + NotificationTargetARN *string + + // The ARN of the IAM role that allows the Auto Scaling group to publish to the + // specified notification target, for example, an Amazon SNS topic or an Amazon SQS + // queue. + RoleARN *string } // Describes the state of a Classic Load Balancer. If you specify a load balancer @@ -982,6 +982,9 @@ type LifecycleHookSpecification struct { // state. type LoadBalancerState struct { + // The name of the load balancer. + LoadBalancerName *string + // One of the following load balancer states: // // * Adding - The instances in the @@ -1001,9 +1004,6 @@ type LoadBalancerState struct { // * Removed - All // instances in the group are deregistered from the load balancer. State *string - - // The name of the load balancer. - LoadBalancerName *string } // Describes the state of a target group. If you attach a target group to an @@ -1015,6 +1015,9 @@ type LoadBalancerState struct { // state. type LoadBalancerTargetGroupState struct { + // The Amazon Resource Name (ARN) of the target group. + LoadBalancerTargetGroupARN *string + // The state of the target group. // // * Adding - The Auto Scaling instances are @@ -1034,9 +1037,6 @@ type LoadBalancerTargetGroupState struct { // * Removed - All Auto Scaling // instances are deregistered from the target group. State *string - - // The Amazon Resource Name (ARN) of the target group. - LoadBalancerTargetGroupARN *string } // Describes a metric. @@ -1111,13 +1111,13 @@ type MetricGranularityType struct { // CreateAutoScalingGroup () and UpdateAutoScalingGroup (). type MixedInstancesPolicy struct { - // The launch template and instance types (overrides). Required when creating a - // mixed instances policy. - LaunchTemplate *LaunchTemplate - // The instances distribution to use. If you leave this parameter unspecified, the // value for each parameter in InstancesDistribution uses a default value. InstancesDistribution *InstancesDistribution + + // The launch template and instance types (overrides). Required when creating a + // mixed instances policy. + LaunchTemplate *LaunchTemplate } // Describes a notification. @@ -1229,25 +1229,60 @@ type ProcessType struct { // Describes information used to start an instance refresh. type RefreshPreferences struct { - // The amount of capacity in the Auto Scaling group that must remain healthy during - // an instance refresh to allow the operation to continue, as a percentage of the - // desired capacity of the Auto Scaling group (rounded up to the nearest integer). - // The default is 90. - MinHealthyPercentage *int32 - // The number of seconds until a newly launched instance is configured and ready to // use. During this time, Amazon EC2 Auto Scaling does not immediately move on to // the next replacement. The default is to use the value for the health check grace // period defined for the group. InstanceWarmup *int32 + + // The amount of capacity in the Auto Scaling group that must remain healthy during + // an instance refresh to allow the operation to continue, as a percentage of the + // desired capacity of the Auto Scaling group (rounded up to the nearest integer). + // The default is 90. + MinHealthyPercentage *int32 } // Describes a scaling policy. type ScalingPolicy struct { + // Specifies how the scaling adjustment is interpreted (for example, an absolute + // number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, + // and PercentChangeInCapacity. + AdjustmentType *string + // The CloudWatch alarms related to the policy. Alarms []*Alarm + // The name of the Auto Scaling group. + AutoScalingGroupName *string + + // The duration of the policy's cooldown period, in seconds. + Cooldown *int32 + + // Indicates whether the policy is enabled (true) or disabled (false). + Enabled *bool + + // The estimated time, in seconds, until a newly launched instance can contribute + // to the CloudWatch metrics. + EstimatedInstanceWarmup *int32 + + // The aggregation type for the CloudWatch metrics. The valid values are Minimum, + // Maximum, and Average. + MetricAggregationType *string + + // The minimum value to scale by when the adjustment type is + // PercentChangeInCapacity. + MinAdjustmentMagnitude *int32 + + // Available for backward compatibility. Use MinAdjustmentMagnitude instead. + MinAdjustmentStep *int32 + + // The Amazon Resource Name (ARN) of the policy. + PolicyARN *string + + // The name of the scaling policy. + PolicyName *string + // One of the following policy types: // // * TargetTrackingScaling @@ -1265,91 +1300,56 @@ type ScalingPolicy struct { // in the Amazon EC2 Auto Scaling User Guide. PolicyType *string - // A set of adjustments that enable you to scale based on the size of the alarm - // breach. - StepAdjustments []*StepAdjustment - - // The aggregation type for the CloudWatch metrics. The valid values are Minimum, - // Maximum, and Average. - MetricAggregationType *string - - // The duration of the policy's cooldown period, in seconds. - Cooldown *int32 - - // The name of the Auto Scaling group. - AutoScalingGroupName *string - - // A target tracking scaling policy. - TargetTrackingConfiguration *TargetTrackingConfiguration - - // The estimated time, in seconds, until a newly launched instance can contribute - // to the CloudWatch metrics. - EstimatedInstanceWarmup *int32 - - // Specifies how the scaling adjustment is interpreted (for example, an absolute - // number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, - // and PercentChangeInCapacity. - AdjustmentType *string - - // The Amazon Resource Name (ARN) of the policy. - PolicyARN *string - - // The name of the scaling policy. - PolicyName *string - // The amount by which to scale, based on the specified adjustment type. A positive // value adds to the current capacity while a negative number removes from the // current capacity. ScalingAdjustment *int32 - // The minimum value to scale by when the adjustment type is - // PercentChangeInCapacity. - MinAdjustmentMagnitude *int32 - - // Indicates whether the policy is enabled (true) or disabled (false). - Enabled *bool + // A set of adjustments that enable you to scale based on the size of the alarm + // breach. + StepAdjustments []*StepAdjustment - // Available for backward compatibility. Use MinAdjustmentMagnitude instead. - MinAdjustmentStep *int32 + // A target tracking scaling policy. + TargetTrackingConfiguration *TargetTrackingConfiguration } // Describes a scheduled scaling action. type ScheduledUpdateGroupAction struct { + // The name of the Auto Scaling group. + AutoScalingGroupName *string + + // The desired capacity is the initial capacity of the Auto Scaling group after the + // scheduled action runs and the capacity it attempts to maintain. + DesiredCapacity *int32 + + // The date and time in UTC for the recurring schedule to end. For example, + // "2019-06-01T00:00:00Z". + EndTime *time.Time + // The maximum size of the Auto Scaling group. MaxSize *int32 + // The minimum size of the Auto Scaling group. + MinSize *int32 + // The recurring schedule for the action, in Unix cron syntax format. When // StartTime and EndTime are specified with Recurrence, they form the boundaries of // when the recurring action starts and stops. Recurrence *string - // The name of the Auto Scaling group. - AutoScalingGroupName *string - - // The name of the scheduled action. - ScheduledActionName *string - // The Amazon Resource Name (ARN) of the scheduled action. ScheduledActionARN *string - // This parameter is no longer used. - Time *time.Time - - // The desired capacity is the initial capacity of the Auto Scaling group after the - // scheduled action runs and the capacity it attempts to maintain. - DesiredCapacity *int32 - - // The minimum size of the Auto Scaling group. - MinSize *int32 + // The name of the scheduled action. + ScheduledActionName *string // The date and time in UTC for this action to start. For example, // "2019-06-01T00:00:00Z". StartTime *time.Time - // The date and time in UTC for the recurring schedule to end. For example, - // "2019-06-01T00:00:00Z". - EndTime *time.Time + // This parameter is no longer used. + Time *time.Time } // Describes information used for one or more scheduled scaling action updates in a @@ -1357,29 +1357,33 @@ type ScheduledUpdateGroupAction struct { // scaling action, all optional parameters are left unchanged if not specified. type ScheduledUpdateGroupActionRequest struct { - // The recurring schedule for the action, in Unix cron syntax format. This format - // consists of five fields separated by white spaces: [Minute] [Hour] - // [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for - // example, "30 0 1 1,6,12 *"). For more information about this format, see Crontab - // (http://crontab.org). When StartTime and EndTime are specified with Recurrence, - // they form the boundaries of when the recurring action starts and stops. - Recurrence *string - - // The minimum size of the Auto Scaling group. - MinSize *int32 - // The name of the scaling action. // // This member is required. ScheduledActionName *string - // The maximum size of the Auto Scaling group. - MaxSize *int32 + // The desired capacity is the initial capacity of the Auto Scaling group after the + // scheduled action runs and the capacity it attempts to maintain. + DesiredCapacity *int32 // The date and time for the recurring schedule to end. Amazon EC2 Auto Scaling // does not perform the action after this time. EndTime *time.Time + // The maximum size of the Auto Scaling group. + MaxSize *int32 + + // The minimum size of the Auto Scaling group. + MinSize *int32 + + // The recurring schedule for the action, in Unix cron syntax format. This format + // consists of five fields separated by white spaces: [Minute] [Hour] + // [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for + // example, "30 0 1 1,6,12 *"). For more information about this format, see Crontab + // (http://crontab.org). When StartTime and EndTime are specified with Recurrence, + // they form the boundaries of when the recurring action starts and stops. + Recurrence *string + // The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in // UTC/GMT only and in quotes (for example, "2019-06-01T00:00:00Z"). If you specify // Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this @@ -1387,10 +1391,6 @@ type ScheduledUpdateGroupActionRequest struct { // to schedule the action in the past, Amazon EC2 Auto Scaling returns an error // message. StartTime *time.Time - - // The desired capacity is the initial capacity of the Auto Scaling group after the - // scheduled action runs and the capacity it attempts to maintain. - DesiredCapacity *int32 } // Describes information used to create a step adjustment for a step scaling @@ -1427,6 +1427,13 @@ type ScheduledUpdateGroupActionRequest struct { // in the Amazon EC2 Auto Scaling User Guide. type StepAdjustment struct { + // The amount by which to scale, based on the specified adjustment type. A positive + // value adds to the current capacity while a negative number removes from the + // current capacity. + // + // This member is required. + ScalingAdjustment *int32 + // The lower bound for the difference between the alarm threshold and the // CloudWatch metric. If the metric value is above the breach threshold, the lower // bound is inclusive (the metric must be greater than or equal to the threshold @@ -1442,13 +1449,6 @@ type StepAdjustment struct { // threshold plus the upper bound). A null value indicates positive infinity. The // upper bound must be greater than the lower bound. MetricIntervalUpperBound *float64 - - // The amount by which to scale, based on the specified adjustment type. A positive - // value adds to the current capacity while a negative number removes from the - // current capacity. - // - // This member is required. - ScalingAdjustment *int32 } // Describes an automatic scaling process that has been suspended. For more @@ -1457,59 +1457,68 @@ type StepAdjustment struct { // in the Amazon EC2 Auto Scaling User Guide. type SuspendedProcess struct { - // The reason that the process was suspended. - SuspensionReason *string - // The name of the suspended process. ProcessName *string + + // The reason that the process was suspended. + SuspensionReason *string } // Describes a tag for an Auto Scaling group. type Tag struct { - // The tag value. - Value *string - - // The type of resource. The only supported value is auto-scaling-group. - ResourceType *string - - // Determines whether the tag is added to new instances as they are launched in the - // group. - PropagateAtLaunch *bool - // The tag key. // // This member is required. Key *string + // Determines whether the tag is added to new instances as they are launched in the + // group. + PropagateAtLaunch *bool + // The name of the group. ResourceId *string + + // The type of resource. The only supported value is auto-scaling-group. + ResourceType *string + + // The tag value. + Value *string } // Describes a tag for an Auto Scaling group. type TagDescription struct { + // The tag key. + Key *string + // Determines whether the tag is added to new instances as they are launched in the // group. PropagateAtLaunch *bool - // The tag key. - Key *string - // The name of the group. ResourceId *string - // The tag value. - Value *string - // The type of resource. The only supported value is auto-scaling-group. ResourceType *string + + // The tag value. + Value *string } // Represents a target tracking scaling policy configuration to use with Amazon EC2 // Auto Scaling. type TargetTrackingConfiguration struct { + // The target value for the metric. + // + // This member is required. + TargetValue *float64 + + // A customized metric. You must specify either a predefined metric or a customized + // metric. + CustomizedMetricSpecification *CustomizedMetricSpecification + // Indicates whether scaling in by the target tracking scaling policy is disabled. // If scaling in is disabled, the target tracking scaling policy doesn't remove // instances from the Auto Scaling group. Otherwise, the target tracking scaling @@ -1519,13 +1528,4 @@ type TargetTrackingConfiguration struct { // A predefined metric. You must specify either a predefined metric or a customized // metric. PredefinedMetricSpecification *PredefinedMetricSpecification - - // A customized metric. You must specify either a predefined metric or a customized - // metric. - CustomizedMetricSpecification *CustomizedMetricSpecification - - // The target value for the metric. - // - // This member is required. - TargetValue *float64 } diff --git a/service/autoscalingplans/api_op_CreateScalingPlan.go b/service/autoscalingplans/api_op_CreateScalingPlan.go index 1bd2ad46af7..8eea9690b1d 100644 --- a/service/autoscalingplans/api_op_CreateScalingPlan.go +++ b/service/autoscalingplans/api_op_CreateScalingPlan.go @@ -57,22 +57,22 @@ func (c *Client) CreateScalingPlan(ctx context.Context, params *CreateScalingPla type CreateScalingPlanInput struct { - // The name of the scaling plan. Names cannot contain vertical bars, colons, or - // forward slashes. + // A CloudFormation stack or set of tags. You can create one scaling plan per + // application source. // // This member is required. - ScalingPlanName *string + ApplicationSource *types.ApplicationSource // The scaling instructions. // // This member is required. ScalingInstructions []*types.ScalingInstruction - // A CloudFormation stack or set of tags. You can create one scaling plan per - // application source. + // The name of the scaling plan. Names cannot contain vertical bars, colons, or + // forward slashes. // // This member is required. - ApplicationSource *types.ApplicationSource + ScalingPlanName *string } type CreateScalingPlanOutput struct { diff --git a/service/autoscalingplans/api_op_DescribeScalingPlanResources.go b/service/autoscalingplans/api_op_DescribeScalingPlanResources.go index 6a756af08eb..00178c1a1a8 100644 --- a/service/autoscalingplans/api_op_DescribeScalingPlanResources.go +++ b/service/autoscalingplans/api_op_DescribeScalingPlanResources.go @@ -77,13 +77,13 @@ type DescribeScalingPlanResourcesInput struct { type DescribeScalingPlanResourcesOutput struct { - // Information about the scalable resources. - ScalingPlanResources []*types.ScalingPlanResource - // The token required to get the next set of results. This value is null if there // are no more results to return. NextToken *string + // Information about the scalable resources. + ScalingPlanResources []*types.ScalingPlanResource + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/autoscalingplans/api_op_DescribeScalingPlans.go b/service/autoscalingplans/api_op_DescribeScalingPlans.go index c9c0bf82486..bdac548eb8a 100644 --- a/service/autoscalingplans/api_op_DescribeScalingPlans.go +++ b/service/autoscalingplans/api_op_DescribeScalingPlans.go @@ -56,24 +56,24 @@ func (c *Client) DescribeScalingPlans(ctx context.Context, params *DescribeScali type DescribeScalingPlansInput struct { - // The version number of the scaling plan. If you specify a scaling plan version, - // you must also specify a scaling plan name. - ScalingPlanVersion *int64 - // The sources for the applications (up to 10). If you specify scaling plan names, // you cannot specify application sources. ApplicationSources []*types.ApplicationSource - // The names of the scaling plans (up to 10). If you specify application sources, - // you cannot specify scaling plan names. - ScalingPlanNames []*string - // The maximum number of scalable resources to return. This value can be between 1 // and 50. The default value is 50. MaxResults *int32 // The token for the next set of results. NextToken *string + + // The names of the scaling plans (up to 10). If you specify application sources, + // you cannot specify scaling plan names. + ScalingPlanNames []*string + + // The version number of the scaling plan. If you specify a scaling plan version, + // you must also specify a scaling plan name. + ScalingPlanVersion *int64 } type DescribeScalingPlansOutput struct { diff --git a/service/autoscalingplans/api_op_GetScalingPlanResourceForecastData.go b/service/autoscalingplans/api_op_GetScalingPlanResourceForecastData.go index 6aa970b0dd5..4c9246cebb9 100644 --- a/service/autoscalingplans/api_op_GetScalingPlanResourceForecastData.go +++ b/service/autoscalingplans/api_op_GetScalingPlanResourceForecastData.go @@ -61,26 +61,14 @@ func (c *Client) GetScalingPlanResourceForecastData(ctx context.Context, params type GetScalingPlanResourceForecastDataInput struct { - // The name of the scaling plan. - // - // This member is required. - ScalingPlanName *string - - // The scalable dimension for the resource. - // - // This member is required. - ScalableDimension types.ScalableDimension - - // The inclusive start time of the time range for the forecast data to get. The - // date and time can be at most 56 days before the current date and time. - // - // This member is required. - StartTime *time.Time - - // The version number of the scaling plan. + // The exclusive end time of the time range for the forecast data to get. The + // maximum time duration between the start and end time is seven days. Although + // this parameter can accept a date and time that is more than two days in the + // future, the availability of forecast data has limits. AWS Auto Scaling only + // issues forecasts for periods of two days in advance. // // This member is required. - ScalingPlanVersion *int64 + EndTime *time.Time // The type of forecast data to get. // @@ -102,20 +90,6 @@ type GetScalingPlanResourceForecastDataInput struct { // This member is required. ForecastDataType types.ForecastDataType - // The exclusive end time of the time range for the forecast data to get. The - // maximum time duration between the start and end time is seven days. Although - // this parameter can accept a date and time that is more than two days in the - // future, the availability of forecast data has limits. AWS Auto Scaling only - // issues forecasts for periods of two days in advance. - // - // This member is required. - EndTime *time.Time - - // The namespace of the AWS service. - // - // This member is required. - ServiceNamespace types.ServiceNamespace - // The ID of the resource. This string consists of the resource type and unique // identifier. // @@ -145,6 +119,32 @@ type GetScalingPlanResourceForecastDataInput struct { // // This member is required. ResourceId *string + + // The scalable dimension for the resource. + // + // This member is required. + ScalableDimension types.ScalableDimension + + // The name of the scaling plan. + // + // This member is required. + ScalingPlanName *string + + // The version number of the scaling plan. + // + // This member is required. + ScalingPlanVersion *int64 + + // The namespace of the AWS service. + // + // This member is required. + ServiceNamespace types.ServiceNamespace + + // The inclusive start time of the time range for the forecast data to get. The + // date and time can be at most 56 days before the current date and time. + // + // This member is required. + StartTime *time.Time } type GetScalingPlanResourceForecastDataOutput struct { diff --git a/service/autoscalingplans/api_op_UpdateScalingPlan.go b/service/autoscalingplans/api_op_UpdateScalingPlan.go index cbabd067a9d..155c2af3ddb 100644 --- a/service/autoscalingplans/api_op_UpdateScalingPlan.go +++ b/service/autoscalingplans/api_op_UpdateScalingPlan.go @@ -58,21 +58,21 @@ func (c *Client) UpdateScalingPlan(ctx context.Context, params *UpdateScalingPla type UpdateScalingPlanInput struct { - // The scaling instructions. - ScalingInstructions []*types.ScalingInstruction - - // The version number of the scaling plan. + // The name of the scaling plan. // // This member is required. - ScalingPlanVersion *int64 + ScalingPlanName *string - // The name of the scaling plan. + // The version number of the scaling plan. // // This member is required. - ScalingPlanName *string + ScalingPlanVersion *int64 // A CloudFormation stack or set of tags. ApplicationSource *types.ApplicationSource + + // The scaling instructions. + ScalingInstructions []*types.ScalingInstruction } type UpdateScalingPlanOutput struct { diff --git a/service/autoscalingplans/go.mod b/service/autoscalingplans/go.mod index ba0e4fe7b94..b81e0a050d7 100644 --- a/service/autoscalingplans/go.mod +++ b/service/autoscalingplans/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/autoscalingplans go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/autoscalingplans/types/types.go b/service/autoscalingplans/types/types.go index 1e3cf789b66..58bc0dee4d4 100644 --- a/service/autoscalingplans/types/types.go +++ b/service/autoscalingplans/types/types.go @@ -9,11 +9,11 @@ import ( // Represents an application source. type ApplicationSource struct { - // A set of tags (up to 50). - TagFilters []*TagFilter - // The Amazon Resource Name (ARN) of a AWS CloudFormation stack. CloudFormationStackARN *string + + // A set of tags (up to 50). + TagFilters []*TagFilter } // Represents a CloudWatch metric of your choosing that can be used for predictive @@ -35,6 +35,11 @@ type ApplicationSource struct { // in the Amazon CloudWatch User Guide. type CustomizedLoadMetricSpecification struct { + // The name of the metric. + // + // This member is required. + MetricName *string + // The namespace of the metric. // // This member is required. @@ -50,11 +55,6 @@ type CustomizedLoadMetricSpecification struct { // specification. Dimensions []*MetricDimension - // The name of the metric. - // - // This member is required. - MetricName *string - // The unit of the metric. Unit *string } @@ -80,38 +80,38 @@ type CustomizedLoadMetricSpecification struct { // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html). type CustomizedScalingMetricSpecification struct { - // The dimensions of the metric. Conditional: If you published your metric with - // dimensions, you must specify the same dimensions in your customized scaling - // metric specification. - Dimensions []*MetricDimension - - // The unit of the metric. - Unit *string - - // The namespace of the metric. + // The name of the metric. // // This member is required. - Namespace *string + MetricName *string - // The name of the metric. + // The namespace of the metric. // // This member is required. - MetricName *string + Namespace *string // The statistic of the metric. // // This member is required. Statistic MetricStatistic + + // The dimensions of the metric. Conditional: If you published your metric with + // dimensions, you must specify the same dimensions in your customized scaling + // metric specification. + Dimensions []*MetricDimension + + // The unit of the metric. + Unit *string } // Represents a single value in the forecast data used for predictive scaling. type Datapoint struct { - // The value of the data point. - Value *float64 - // The time stamp for the data point in UTC format. Timestamp *time.Time + + // The value of the data point. + Value *float64 } // Represents a dimension for a customized metric. @@ -194,6 +194,12 @@ type PredefinedScalingMetricSpecification struct { // (https://docs.aws.amazon.com/autoscaling/plans/userguide/auto-scaling-getting-started.html). type ScalingInstruction struct { + // The maximum capacity of the resource. The exception to this upper limit is if + // you specify a non-default setting for PredictiveScalingMaxCapacityBehavior. + // + // This member is required. + MaxCapacity *int32 + // The minimum capacity of the resource. // // This member is required. @@ -229,71 +235,6 @@ type ScalingInstruction struct { // This member is required. ResourceId *string - // The amount of time, in seconds, to buffer the run time of scheduled scaling - // actions when scaling out. For example, if the forecast says to add capacity at - // 10:00 AM, and the buffer time is 5 minutes, then the run time of the - // corresponding scheduled scaling action will be 9:55 AM. The intention is to give - // resources time to be provisioned. For example, it can take a few minutes to - // launch an EC2 instance. The actual amount of time required depends on several - // factors, such as the size of the instance and whether there are startup scripts - // to complete. The value must be less than the forecast interval duration of 3600 - // seconds (60 minutes). The default is 300 seconds. Only valid when configuring - // predictive scaling. - ScheduledActionBufferTime *int32 - - // The namespace of the AWS service. - // - // This member is required. - ServiceNamespace ServiceNamespace - - // Defines the behavior that should be applied if the forecast capacity approaches - // or exceeds the maximum capacity specified for the resource. The default value is - // SetForecastCapacityToMaxCapacity. The following are possible values: - // - // * - // SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource - // capacity higher than the maximum capacity. The maximum capacity is enforced as a - // hard limit. - // - // * SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale - // resource capacity higher than the maximum capacity to equal but not exceed - // forecast capacity. - // - // * SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling - // may scale resource capacity higher than the maximum capacity by a specified - // buffer value. The intention is to give the target tracking scaling policy extra - // capacity if unexpected traffic occurs. - // - // Only valid when configuring predictive - // scaling. - PredictiveScalingMaxCapacityBehavior PredictiveScalingMaxCapacityBehavior - - // The customized load metric to use for predictive scaling. This parameter or a - // PredefinedLoadMetricSpecification is required when configuring predictive - // scaling, and cannot be used otherwise. - CustomizedLoadMetricSpecification *CustomizedLoadMetricSpecification - - // Controls whether a resource's externally created scaling policies are kept or - // replaced. The default value is KeepExternalPolicies. If the parameter is set to - // ReplaceExternalPolicies, any scaling policies that are external to AWS Auto - // Scaling are deleted and new target tracking scaling policies created. Only valid - // when configuring dynamic scaling. Condition: The number of existing policies to - // be replaced must be less than or equal to 50. If there are more than 50 policies - // to be replaced, AWS Auto Scaling keeps all existing policies and does not create - // new ones. - ScalingPolicyUpdateBehavior ScalingPolicyUpdateBehavior - - // The structure that defines new target tracking configurations (up to 10). Each - // of these structures includes a specific scaling metric and a target value for - // the metric, along with various parameters to use with dynamic scaling. With - // predictive scaling and dynamic scaling, the resource scales based on the target - // tracking configuration that provides the largest capacity for both scale in and - // scale out. Condition: The scaling metric must be unique across target tracking - // configurations. - // - // This member is required. - TargetTrackingConfigurations []*TargetTrackingConfiguration - // The scalable dimension associated with the resource. // // * @@ -327,11 +268,60 @@ type ScalingInstruction struct { // This member is required. ScalableDimension ScalableDimension + // The namespace of the AWS service. + // + // This member is required. + ServiceNamespace ServiceNamespace + + // The structure that defines new target tracking configurations (up to 10). Each + // of these structures includes a specific scaling metric and a target value for + // the metric, along with various parameters to use with dynamic scaling. With + // predictive scaling and dynamic scaling, the resource scales based on the target + // tracking configuration that provides the largest capacity for both scale in and + // scale out. Condition: The scaling metric must be unique across target tracking + // configurations. + // + // This member is required. + TargetTrackingConfigurations []*TargetTrackingConfiguration + + // The customized load metric to use for predictive scaling. This parameter or a + // PredefinedLoadMetricSpecification is required when configuring predictive + // scaling, and cannot be used otherwise. + CustomizedLoadMetricSpecification *CustomizedLoadMetricSpecification + + // Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic + // scaling is enabled, AWS Auto Scaling creates target tracking scaling policies + // based on the specified target tracking configurations. The default is enabled + // (false). + DisableDynamicScaling *bool + // The predefined load metric to use for predictive scaling. This parameter or a // CustomizedLoadMetricSpecification is required when configuring predictive // scaling, and cannot be used otherwise. PredefinedLoadMetricSpecification *PredefinedLoadMetricSpecification + // Defines the behavior that should be applied if the forecast capacity approaches + // or exceeds the maximum capacity specified for the resource. The default value is + // SetForecastCapacityToMaxCapacity. The following are possible values: + // + // * + // SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource + // capacity higher than the maximum capacity. The maximum capacity is enforced as a + // hard limit. + // + // * SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale + // resource capacity higher than the maximum capacity to equal but not exceed + // forecast capacity. + // + // * SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling + // may scale resource capacity higher than the maximum capacity by a specified + // buffer value. The intention is to give the target tracking scaling policy extra + // capacity if unexpected traffic occurs. + // + // Only valid when configuring predictive + // scaling. + PredictiveScalingMaxCapacityBehavior PredictiveScalingMaxCapacityBehavior + // The size of the capacity buffer to use when the forecast capacity is close to or // exceeds the maximum capacity. The value is specified as a percentage relative to // the forecast capacity. For example, if the buffer is 10, this means a 10 percent @@ -342,46 +332,56 @@ type ScalingInstruction struct { // is 1-100. PredictiveScalingMaxCapacityBuffer *int32 - // Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic - // scaling is enabled, AWS Auto Scaling creates target tracking scaling policies - // based on the specified target tracking configurations. The default is enabled - // (false). - DisableDynamicScaling *bool - // The predictive scaling mode. The default value is ForecastAndScale. Otherwise, // AWS Auto Scaling forecasts capacity but does not create any scheduled scaling // actions based on the capacity forecast. PredictiveScalingMode PredictiveScalingMode - // The maximum capacity of the resource. The exception to this upper limit is if - // you specify a non-default setting for PredictiveScalingMaxCapacityBehavior. - // - // This member is required. - MaxCapacity *int32 + // Controls whether a resource's externally created scaling policies are kept or + // replaced. The default value is KeepExternalPolicies. If the parameter is set to + // ReplaceExternalPolicies, any scaling policies that are external to AWS Auto + // Scaling are deleted and new target tracking scaling policies created. Only valid + // when configuring dynamic scaling. Condition: The number of existing policies to + // be replaced must be less than or equal to 50. If there are more than 50 policies + // to be replaced, AWS Auto Scaling keeps all existing policies and does not create + // new ones. + ScalingPolicyUpdateBehavior ScalingPolicyUpdateBehavior + + // The amount of time, in seconds, to buffer the run time of scheduled scaling + // actions when scaling out. For example, if the forecast says to add capacity at + // 10:00 AM, and the buffer time is 5 minutes, then the run time of the + // corresponding scheduled scaling action will be 9:55 AM. The intention is to give + // resources time to be provisioned. For example, it can take a few minutes to + // launch an EC2 instance. The actual amount of time required depends on several + // factors, such as the size of the instance and whether there are startup scripts + // to complete. The value must be less than the forecast interval duration of 3600 + // seconds (60 minutes). The default is 300 seconds. Only valid when configuring + // predictive scaling. + ScheduledActionBufferTime *int32 } // Represents a scaling plan. type ScalingPlan struct { - // The scaling instructions. + // The application source. // // This member is required. - ScalingInstructions []*ScalingInstruction + ApplicationSource *ApplicationSource - // The version number of the scaling plan. + // The scaling instructions. // // This member is required. - ScalingPlanVersion *int64 + ScalingInstructions []*ScalingInstruction // The name of the scaling plan. // // This member is required. ScalingPlanName *string - // The application source. + // The version number of the scaling plan. // // This member is required. - ApplicationSource *ApplicationSource + ScalingPlanVersion *int64 // The status of the scaling plan. // @@ -411,27 +411,19 @@ type ScalingPlan struct { // This member is required. StatusCode ScalingPlanStatusCode - // The Unix time stamp when the scaling plan entered the current status. - StatusStartTime *time.Time + // The Unix time stamp when the scaling plan was created. + CreationTime *time.Time // A simple message about the current status of the scaling plan. StatusMessage *string - // The Unix time stamp when the scaling plan was created. - CreationTime *time.Time + // The Unix time stamp when the scaling plan entered the current status. + StatusStartTime *time.Time } // Represents a scalable resource. type ScalingPlanResource struct { - // The name of the scaling plan. - // - // This member is required. - ScalingPlanName *string - - // A simple message about the current scaling status of the resource. - ScalingStatusMessage *string - // The ID of the resource. This string consists of the resource type and unique // identifier. // @@ -462,16 +454,6 @@ type ScalingPlanResource struct { // This member is required. ResourceId *string - // The namespace of the AWS service. - // - // This member is required. - ServiceNamespace ServiceNamespace - - // The version number of the scaling plan. - // - // This member is required. - ScalingPlanVersion *int64 - // The scalable dimension for the resource. // // * @@ -505,6 +487,16 @@ type ScalingPlanResource struct { // This member is required. ScalableDimension ScalableDimension + // The name of the scaling plan. + // + // This member is required. + ScalingPlanName *string + + // The version number of the scaling plan. + // + // This member is required. + ScalingPlanVersion *int64 + // The scaling status of the resource. // // * Active - The scaling configuration is @@ -522,17 +514,21 @@ type ScalingPlanResource struct { // This member is required. ScalingStatusCode ScalingStatusCode + // The namespace of the AWS service. + // + // This member is required. + ServiceNamespace ServiceNamespace + // The scaling policies. ScalingPolicies []*ScalingPolicy + + // A simple message about the current scaling status of the resource. + ScalingStatusMessage *string } // Represents a scaling policy. type ScalingPolicy struct { - // The target tracking scaling policy. Includes support for predefined or - // customized metrics. - TargetTrackingConfiguration *TargetTrackingConfiguration - // The name of the scaling policy. // // This member is required. @@ -542,41 +538,36 @@ type ScalingPolicy struct { // // This member is required. PolicyType PolicyType + + // The target tracking scaling policy. Includes support for predefined or + // customized metrics. + TargetTrackingConfiguration *TargetTrackingConfiguration } // Represents a tag. type TagFilter struct { - // The tag values (0 to 20). - Values []*string - // The tag key. Key *string + + // The tag values (0 to 20). + Values []*string } // Describes a target tracking configuration to use with AWS Auto Scaling. Used // with ScalingInstruction () and ScalingPolicy (). type TargetTrackingConfiguration struct { - // The amount of time, in seconds, after a scale-out activity completes before - // another scale-out activity can start. This value is not used if the scalable - // resource is an Auto Scaling group. While the cooldown period is in effect, the - // capacity that has been added by the previous scale-out event that initiated the - // cooldown is calculated as part of the desired capacity for the next scale out. - // The intention is to continuously (but not excessively) scale out. - ScaleOutCooldown *int32 - - // The estimated time, in seconds, until a newly launched instance can contribute - // to the CloudWatch metrics. This value is used only if the resource is an Auto - // Scaling group. - EstimatedInstanceWarmup *int32 - // The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 // (Base 10) or 2e-360 to 2e360 (Base 2). // // This member is required. TargetValue *float64 + // A customized metric. You can specify either a predefined metric or a customized + // metric. + CustomizedScalingMetricSpecification *CustomizedScalingMetricSpecification + // Indicates whether scale in by the target tracking scaling policy is disabled. If // the value is true, scale in is disabled and the target tracking scaling policy // doesn't remove capacity from the scalable resource. Otherwise, scale in is @@ -584,6 +575,15 @@ type TargetTrackingConfiguration struct { // scalable resource. The default value is false. DisableScaleIn *bool + // The estimated time, in seconds, until a newly launched instance can contribute + // to the CloudWatch metrics. This value is used only if the resource is an Auto + // Scaling group. + EstimatedInstanceWarmup *int32 + + // A predefined metric. You can specify either a predefined metric or a customized + // metric. + PredefinedScalingMetricSpecification *PredefinedScalingMetricSpecification + // The amount of time, in seconds, after a scale in activity completes before // another scale in activity can start. This value is not used if the scalable // resource is an Auto Scaling group. The cooldown period is used to block @@ -593,11 +593,11 @@ type TargetTrackingConfiguration struct { // AWS Auto Scaling scales out your scalable target immediately. ScaleInCooldown *int32 - // A customized metric. You can specify either a predefined metric or a customized - // metric. - CustomizedScalingMetricSpecification *CustomizedScalingMetricSpecification - - // A predefined metric. You can specify either a predefined metric or a customized - // metric. - PredefinedScalingMetricSpecification *PredefinedScalingMetricSpecification + // The amount of time, in seconds, after a scale-out activity completes before + // another scale-out activity can start. This value is not used if the scalable + // resource is an Auto Scaling group. While the cooldown period is in effect, the + // capacity that has been added by the previous scale-out event that initiated the + // cooldown is calculated as part of the desired capacity for the next scale out. + // The intention is to continuously (but not excessively) scale out. + ScaleOutCooldown *int32 } diff --git a/service/backup/api_op_CreateBackupPlan.go b/service/backup/api_op_CreateBackupPlan.go index 78c4e865de3..87e4649b7f2 100644 --- a/service/backup/api_op_CreateBackupPlan.go +++ b/service/backup/api_op_CreateBackupPlan.go @@ -81,6 +81,14 @@ type CreateBackupPlanInput struct { type CreateBackupPlanOutput struct { + // An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for + // example, + // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. + BackupPlanArn *string + + // Uniquely identifies a backup plan. + BackupPlanId *string + // The date and time that a backup plan is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 @@ -91,14 +99,6 @@ type CreateBackupPlanOutput struct { // 1,024 bytes long. They cannot be edited. VersionId *string - // Uniquely identifies a backup plan. - BackupPlanId *string - - // An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for - // example, - // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. - BackupPlanArn *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/backup/api_op_CreateBackupSelection.go b/service/backup/api_op_CreateBackupSelection.go index 0d3ac8eaa38..6edde8ab537 100644 --- a/service/backup/api_op_CreateBackupSelection.go +++ b/service/backup/api_op_CreateBackupSelection.go @@ -79,10 +79,6 @@ func (c *Client) CreateBackupSelection(ctx context.Context, params *CreateBackup type CreateBackupSelectionInput struct { - // A unique string that identifies the request and allows failed requests to be - // retried without the risk of executing the operation twice. - CreatorRequestId *string - // Uniquely identifies the backup plan to be associated with the selection of // resources. // @@ -93,14 +89,14 @@ type CreateBackupSelectionInput struct { // // This member is required. BackupSelection *types.BackupSelection + + // A unique string that identifies the request and allows failed requests to be + // retried without the risk of executing the operation twice. + CreatorRequestId *string } type CreateBackupSelectionOutput struct { - // Uniquely identifies the body of a request to assign a set of resources to a - // backup plan. - SelectionId *string - // Uniquely identifies a backup plan. BackupPlanId *string @@ -110,6 +106,10 @@ type CreateBackupSelectionOutput struct { // 12:11:30.087 AM. CreationDate *time.Time + // Uniquely identifies the body of a request to assign a set of resources to a + // backup plan. + SelectionId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/backup/api_op_CreateBackupVault.go b/service/backup/api_op_CreateBackupVault.go index 44c2a219afb..df87a4211a7 100644 --- a/service/backup/api_op_CreateBackupVault.go +++ b/service/backup/api_op_CreateBackupVault.go @@ -68,32 +68,32 @@ type CreateBackupVaultInput struct { // This member is required. BackupVaultName *string - // The server-side encryption key that is used to protect your backups; for - // example, - // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. - EncryptionKeyArn *string + // Metadata that you can assign to help organize the resources that you create. + // Each tag is a key-value pair. + BackupVaultTags map[string]*string // A unique string that identifies the request and allows failed requests to be // retried without the risk of executing the operation twice. CreatorRequestId *string - // Metadata that you can assign to help organize the resources that you create. - // Each tag is a key-value pair. - BackupVaultTags map[string]*string + // The server-side encryption key that is used to protect your backups; for + // example, + // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. + EncryptionKeyArn *string } type CreateBackupVaultOutput struct { + // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for + // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + BackupVaultArn *string + // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Region where they are created. They consist of lowercase letters, numbers, and // hyphens. BackupVaultName *string - // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for - // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. - BackupVaultArn *string - // The date and time a backup vault is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 diff --git a/service/backup/api_op_DeleteBackupPlan.go b/service/backup/api_op_DeleteBackupPlan.go index f2f465fef1e..c8e5e0e52b1 100644 --- a/service/backup/api_op_DeleteBackupPlan.go +++ b/service/backup/api_op_DeleteBackupPlan.go @@ -72,6 +72,9 @@ type DeleteBackupPlanOutput struct { // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. BackupPlanArn *string + // Uniquely identifies a backup plan. + BackupPlanId *string + // The date and time a backup plan is deleted, in Unix format and Coordinated // Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 @@ -82,9 +85,6 @@ type DeleteBackupPlanOutput struct { // 1,024 bytes long. Version Ids cannot be edited. VersionId *string - // Uniquely identifies a backup plan. - BackupPlanId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/backup/api_op_DescribeBackupJob.go b/service/backup/api_op_DescribeBackupJob.go index 11362492de5..f76d5e3a73c 100644 --- a/service/backup/api_op_DescribeBackupJob.go +++ b/service/backup/api_op_DescribeBackupJob.go @@ -66,88 +66,88 @@ type DescribeBackupJobInput struct { type DescribeBackupJobOutput struct { - // An ARN that uniquely identifies a recovery point; for example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. - RecoveryPointArn *string - - // Specifies the time in Unix format and Coordinated Universal Time (UTC) when a - // backup job must be started before it is canceled. The value is calculated by - // adding the start window to the scheduled time. So if the scheduled time were - // 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on - // the date specified. The value of StartBy is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 - // 12:11:30.087 AM. - StartBy *time.Time + // Returns the account ID that owns the backup job. + AccountId *string // Uniquely identifies a request to AWS Backup to back up a resource. BackupJobId *string - // A detailed message explaining the status of the job to back up a resource. - StatusMessage *string - - // The date and time that a job to create a backup job is completed, in Unix format - // and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to - // milliseconds. For example, the value 1516925490.087 represents Friday, January - // 26, 2018 12:11:30.087 AM. - CompletionDate *time.Time - - // An ARN that uniquely identifies a saved resource. The format of the ARN depends - // on the resource type. - ResourceArn *string - - // The date and time that a job to back up resources is expected to be completed, - // in Unix format and Coordinated Universal Time (UTC). The value of - // ExpectedCompletionDate is accurate to milliseconds. For example, the value - // 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. - ExpectedCompletionDate *time.Time - // The size, in bytes, of a backup. BackupSizeInBytes *int64 + // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for + // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + BackupVaultArn *string + // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // AWS Region where they are created. They consist of lowercase letters, numbers, // and hyphens. BackupVaultName *string - // Specifies the IAM role ARN used to create the target recovery point; for - // example, arn:aws:iam::123456789012:role/S3Access. - IamRoleArn *string + // The size in bytes transferred to a backup vault at the time that the job status + // was queried. + BytesTransferred *int64 - // The type of AWS resource to be backed up; for example, an Amazon Elastic Block - // Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) - // database. - ResourceType *string + // The date and time that a job to create a backup job is completed, in Unix format + // and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to + // milliseconds. For example, the value 1516925490.087 represents Friday, January + // 26, 2018 12:11:30.087 AM. + CompletionDate *time.Time // Contains identifying information about the creation of a backup job, including // the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the // backup plan that is used to create it. CreatedBy *types.RecoveryPointCreator - // The size in bytes transferred to a backup vault at the time that the job status - // was queried. - BytesTransferred *int64 - - // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for - // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. - BackupVaultArn *string - - // Returns the account ID that owns the backup job. - AccountId *string - // The date and time that a backup job is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time + // The date and time that a job to back up resources is expected to be completed, + // in Unix format and Coordinated Universal Time (UTC). The value of + // ExpectedCompletionDate is accurate to milliseconds. For example, the value + // 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + ExpectedCompletionDate *time.Time + + // Specifies the IAM role ARN used to create the target recovery point; for + // example, arn:aws:iam::123456789012:role/S3Access. + IamRoleArn *string + // Contains an estimated percentage that is complete of a job at the time the job // status was queried. PercentDone *string + // An ARN that uniquely identifies a recovery point; for example, + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + RecoveryPointArn *string + + // An ARN that uniquely identifies a saved resource. The format of the ARN depends + // on the resource type. + ResourceArn *string + + // The type of AWS resource to be backed up; for example, an Amazon Elastic Block + // Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) + // database. + ResourceType *string + + // Specifies the time in Unix format and Coordinated Universal Time (UTC) when a + // backup job must be started before it is canceled. The value is calculated by + // adding the start window to the scheduled time. So if the scheduled time were + // 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on + // the date specified. The value of StartBy is accurate to milliseconds. For + // example, the value 1516925490.087 represents Friday, January 26, 2018 + // 12:11:30.087 AM. + StartBy *time.Time + // The current state of a resource recovery point. State types.BackupJobState + // A detailed message explaining the status of the job to back up a resource. + StatusMessage *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/backup/api_op_DescribeBackupVault.go b/service/backup/api_op_DescribeBackupVault.go index 4ca37966059..9ef72cc3ab8 100644 --- a/service/backup/api_op_DescribeBackupVault.go +++ b/service/backup/api_op_DescribeBackupVault.go @@ -68,8 +68,9 @@ type DescribeBackupVaultInput struct { type DescribeBackupVaultOutput struct { - // The number of recovery points that are stored in a backup vault. - NumberOfRecoveryPoints *int64 + // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for + // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + BackupVaultArn *string // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the @@ -77,24 +78,23 @@ type DescribeBackupVaultOutput struct { // hyphens. BackupVaultName *string - // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for - // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. - BackupVaultArn *string - // The date and time that a backup vault is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time + // A unique string that identifies the request and allows failed requests to be + // retried without the risk of executing the operation twice. + CreatorRequestId *string + // The server-side encryption key that is used to protect your backups; for // example, // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. EncryptionKeyArn *string - // A unique string that identifies the request and allows failed requests to be - // retried without the risk of executing the operation twice. - CreatorRequestId *string + // The number of recovery points that are stored in a backup vault. + NumberOfRecoveryPoints *int64 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/backup/api_op_DescribeProtectedResource.go b/service/backup/api_op_DescribeProtectedResource.go index 97d3896cb43..d1e36ac19a4 100644 --- a/service/backup/api_op_DescribeProtectedResource.go +++ b/service/backup/api_op_DescribeProtectedResource.go @@ -68,16 +68,16 @@ type DescribeProtectedResourceInput struct { type DescribeProtectedResourceOutput struct { - // An ARN that uniquely identifies a resource. The format of the ARN depends on the - // resource type. - ResourceArn *string - // The date and time that a resource was last backed up, in Unix format and // Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to // milliseconds. For example, the value 1516925490.087 represents Friday, January // 26, 2018 12:11:30.087 AM. LastBackupTime *time.Time + // An ARN that uniquely identifies a resource. The format of the ARN depends on the + // resource type. + ResourceArn *string + // The type of AWS resource saved as a recovery point; for example, an EBS volume // or an Amazon RDS database. ResourceType *string diff --git a/service/backup/api_op_DescribeRecoveryPoint.go b/service/backup/api_op_DescribeRecoveryPoint.go index b8e8cfc0795..5d92d30f914 100644 --- a/service/backup/api_op_DescribeRecoveryPoint.go +++ b/service/backup/api_op_DescribeRecoveryPoint.go @@ -77,15 +77,6 @@ type DescribeRecoveryPointInput struct { type DescribeRecoveryPointOutput struct { - // The lifecycle defines when a protected resource is transitioned to cold storage - // and when it expires. AWS Backup transitions and expires backups automatically - // according to the lifecycle that you define. Backups that are transitioned to - // cold storage must be stored in cold storage for a minimum of 90 days. Therefore, - // the “expire after days” setting must be 90 days greater than the “transition to - // cold after days” setting. The “transition to cold after days” setting cannot be - // changed after a backup has been transitioned to cold. - Lifecycle *types.Lifecycle - // The size, in bytes, of a backup. BackupSizeInBytes *int64 @@ -93,10 +84,26 @@ type DescribeRecoveryPointOutput struct { // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. BackupVaultArn *string - // A status code specifying the state of the recovery point. A partial status - // indicates that the recovery point was not successfully re-created and must be - // retried. - Status types.RecoveryPointStatus + // The name of a logical container where backups are stored. Backup vaults are + // identified by names that are unique to the account used to create them and the + // Region where they are created. They consist of lowercase letters, numbers, and + // hyphens. + BackupVaultName *string + + // A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt + // timestamps. + CalculatedLifecycle *types.CalculatedLifecycle + + // The date and time that a job to create a recovery point is completed, in Unix + // format and Coordinated Universal Time (UTC). The value of CompletionDate is + // accurate to milliseconds. For example, the value 1516925490.087 represents + // Friday, January 26, 2018 12:11:30.087 AM. + CompletionDate *time.Time + + // Contains identifying information about the creation of a recovery point, + // including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId + // of the backup plan used to create it. + CreatedBy *types.RecoveryPointCreator // The date and time that a recovery point is created, in Unix format and // Coordinated Universal Time (UTC). The value of CreationDate is accurate to @@ -108,20 +115,13 @@ type DescribeRecoveryPointOutput struct { // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. EncryptionKeyArn *string - // Specifies the storage class of the recovery point. Valid values are WARM or - // COLD. - StorageClass types.StorageClass - - // Contains identifying information about the creation of a recovery point, - // including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId - // of the backup plan used to create it. - CreatedBy *types.RecoveryPointCreator + // Specifies the IAM role ARN used to create the target recovery point; for + // example, arn:aws:iam::123456789012:role/S3Access. + IamRoleArn *string - // The name of a logical container where backups are stored. Backup vaults are - // identified by names that are unique to the account used to create them and the - // Region where they are created. They consist of lowercase letters, numbers, and - // hyphens. - BackupVaultName *string + // A Boolean value that is returned as TRUE if the specified recovery point is + // encrypted, or FALSE if the recovery point is not encrypted. + IsEncrypted *bool // The date and time that a recovery point was last restored, in Unix format and // Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to @@ -129,20 +129,14 @@ type DescribeRecoveryPointOutput struct { // 26, 2018 12:11:30.087 AM. LastRestoreTime *time.Time - // The date and time that a job to create a recovery point is completed, in Unix - // format and Coordinated Universal Time (UTC). The value of CompletionDate is - // accurate to milliseconds. For example, the value 1516925490.087 represents - // Friday, January 26, 2018 12:11:30.087 AM. - CompletionDate *time.Time - - // Specifies the IAM role ARN used to create the target recovery point; for - // example, arn:aws:iam::123456789012:role/S3Access. - IamRoleArn *string - - // The type of AWS resource to save as a recovery point; for example, an Amazon - // Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service - // (Amazon RDS) database. - ResourceType *string + // The lifecycle defines when a protected resource is transitioned to cold storage + // and when it expires. AWS Backup transitions and expires backups automatically + // according to the lifecycle that you define. Backups that are transitioned to + // cold storage must be stored in cold storage for a minimum of 90 days. Therefore, + // the “expire after days” setting must be 90 days greater than the “transition to + // cold after days” setting. The “transition to cold after days” setting cannot be + // changed after a backup has been transitioned to cold. + Lifecycle *types.Lifecycle // An ARN that uniquely identifies a recovery point; for example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. @@ -152,13 +146,19 @@ type DescribeRecoveryPointOutput struct { // on the resource type. ResourceArn *string - // A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt - // timestamps. - CalculatedLifecycle *types.CalculatedLifecycle + // The type of AWS resource to save as a recovery point; for example, an Amazon + // Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service + // (Amazon RDS) database. + ResourceType *string - // A Boolean value that is returned as TRUE if the specified recovery point is - // encrypted, or FALSE if the recovery point is not encrypted. - IsEncrypted *bool + // A status code specifying the state of the recovery point. A partial status + // indicates that the recovery point was not successfully re-created and must be + // retried. + Status types.RecoveryPointStatus + + // Specifies the storage class of the recovery point. Valid values are WARM or + // COLD. + StorageClass types.StorageClass // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/backup/api_op_DescribeRestoreJob.go b/service/backup/api_op_DescribeRestoreJob.go index cb3549eb7d1..8105b8fb46e 100644 --- a/service/backup/api_op_DescribeRestoreJob.go +++ b/service/backup/api_op_DescribeRestoreJob.go @@ -66,18 +66,11 @@ type DescribeRestoreJobInput struct { type DescribeRestoreJobOutput struct { - // Specifies the IAM role ARN used to create the target recovery point; for - // example, arn:aws:iam::123456789012:role/S3Access. - IamRoleArn *string - - // Returns metadata associated with a restore job listed by resource type. - ResourceType *string + // Returns the account ID that owns the restore job. + AccountId *string - // The date and time that a restore job is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 - // 12:11:30.087 AM. - CreationDate *time.Time + // The size, in bytes, of the restored resource. + BackupSizeInBytes *int64 // The date and time that a job to restore a recovery point is completed, in Unix // format and Coordinated Universal Time (UTC). The value of CompletionDate is @@ -85,39 +78,46 @@ type DescribeRestoreJobOutput struct { // Friday, January 26, 2018 12:11:30.087 AM. CompletionDate *time.Time - // Status code specifying the state of the job that is initiated by AWS Backup to - // restore a recovery point. - Status types.RestoreJobStatus - // An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery // point is being restored. The format of the ARN depends on the resource type of // the backed-up resource. CreatedResourceArn *string - // The size, in bytes, of the restored resource. - BackupSizeInBytes *int64 + // The date and time that a restore job is created, in Unix format and Coordinated + // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For + // example, the value 1516925490.087 represents Friday, January 26, 2018 + // 12:11:30.087 AM. + CreationDate *time.Time - // An ARN that uniquely identifies a recovery point; for example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. - RecoveryPointArn *string + // The amount of time in minutes that a job restoring a recovery point is expected + // to take. + ExpectedCompletionTimeMinutes *int64 + + // Specifies the IAM role ARN used to create the target recovery point; for + // example, arn:aws:iam::123456789012:role/S3Access. + IamRoleArn *string // Contains an estimated percentage that is complete of a job at the time the job // status was queried. PercentDone *string - // Returns the account ID that owns the restore job. - AccountId *string + // An ARN that uniquely identifies a recovery point; for example, + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + RecoveryPointArn *string + + // Returns metadata associated with a restore job listed by resource type. + ResourceType *string // Uniquely identifies the job that restores a recovery point. RestoreJobId *string + // Status code specifying the state of the job that is initiated by AWS Backup to + // restore a recovery point. + Status types.RestoreJobStatus + // A message showing the status of a job to restore a recovery point. StatusMessage *string - // The amount of time in minutes that a job restoring a recovery point is expected - // to take. - ExpectedCompletionTimeMinutes *int64 - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/backup/api_op_GetBackupPlan.go b/service/backup/api_op_GetBackupPlan.go index e4830992c2f..8cbec6a93da 100644 --- a/service/backup/api_op_GetBackupPlan.go +++ b/service/backup/api_op_GetBackupPlan.go @@ -58,35 +58,40 @@ func (c *Client) GetBackupPlan(ctx context.Context, params *GetBackupPlanInput, type GetBackupPlanInput struct { - // Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most - // 1,024 bytes long. Version IDs cannot be edited. - VersionId *string - // Uniquely identifies a backup plan. // // This member is required. BackupPlanId *string + + // Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most + // 1,024 bytes long. Version IDs cannot be edited. + VersionId *string } type GetBackupPlanOutput struct { - // A unique string that identifies the request and allows failed requests to be - // retried without the risk of executing the operation twice. - CreatorRequestId *string + // Specifies the body of a backup plan. Includes a BackupPlanName and one or more + // sets of Rules. + BackupPlan *types.BackupPlan + + // An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for + // example, + // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. + BackupPlanArn *string // Uniquely identifies a backup plan. BackupPlanId *string - // Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most - // 1,024 bytes long. Version IDs cannot be edited. - VersionId *string - // The date and time that a backup plan is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time + // A unique string that identifies the request and allows failed requests to be + // retried without the risk of executing the operation twice. + CreatorRequestId *string + // The date and time that a backup plan is deleted, in Unix format and Coordinated // Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 @@ -99,14 +104,9 @@ type GetBackupPlanOutput struct { // 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. LastExecutionDate *time.Time - // Specifies the body of a backup plan. Includes a BackupPlanName and one or more - // sets of Rules. - BackupPlan *types.BackupPlan - - // An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for - // example, - // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. - BackupPlanArn *string + // Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most + // 1,024 bytes long. Version IDs cannot be edited. + VersionId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/backup/api_op_GetBackupSelection.go b/service/backup/api_op_GetBackupSelection.go index 4a7ff90731a..62302cc8a00 100644 --- a/service/backup/api_op_GetBackupSelection.go +++ b/service/backup/api_op_GetBackupSelection.go @@ -59,19 +59,25 @@ func (c *Client) GetBackupSelection(ctx context.Context, params *GetBackupSelect type GetBackupSelectionInput struct { + // Uniquely identifies a backup plan. + // + // This member is required. + BackupPlanId *string + // Uniquely identifies the body of a request to assign a set of resources to a // backup plan. // // This member is required. SelectionId *string +} + +type GetBackupSelectionOutput struct { // Uniquely identifies a backup plan. - // - // This member is required. BackupPlanId *string -} -type GetBackupSelectionOutput struct { + // Specifies the body of a request to assign a set of resources to a backup plan. + BackupSelection *types.BackupSelection // The date and time a backup selection is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For @@ -79,19 +85,13 @@ type GetBackupSelectionOutput struct { // 12:11:30.087 AM. CreationDate *time.Time - // Uniquely identifies the body of a request to assign a set of resources to a - // backup plan. - SelectionId *string - // A unique string that identifies the request and allows failed requests to be // retried without the risk of executing the operation twice. CreatorRequestId *string - // Uniquely identifies a backup plan. - BackupPlanId *string - - // Specifies the body of a request to assign a set of resources to a backup plan. - BackupSelection *types.BackupSelection + // Uniquely identifies the body of a request to assign a set of resources to a + // backup plan. + SelectionId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/backup/api_op_GetBackupVaultAccessPolicy.go b/service/backup/api_op_GetBackupVaultAccessPolicy.go index a6d644b6e89..850b2961bbf 100644 --- a/service/backup/api_op_GetBackupVaultAccessPolicy.go +++ b/service/backup/api_op_GetBackupVaultAccessPolicy.go @@ -72,15 +72,15 @@ type GetBackupVaultAccessPolicyOutput struct { // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. BackupVaultArn *string - // The backup vault access policy document in JSON format. - Policy *string - // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Region where they are created. They consist of lowercase letters, numbers, and // hyphens. BackupVaultName *string + // The backup vault access policy document in JSON format. + Policy *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/backup/api_op_GetBackupVaultNotifications.go b/service/backup/api_op_GetBackupVaultNotifications.go index a28c34ec655..db1985985a8 100644 --- a/service/backup/api_op_GetBackupVaultNotifications.go +++ b/service/backup/api_op_GetBackupVaultNotifications.go @@ -72,10 +72,6 @@ type GetBackupVaultNotificationsOutput struct { // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. BackupVaultArn *string - // An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon - // SNS) topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic. - SNSTopicArn *string - // An array of events that indicate the status of jobs to back up resources to the // backup vault. BackupVaultEvents []types.BackupVaultEvent @@ -86,6 +82,10 @@ type GetBackupVaultNotificationsOutput struct { // hyphens. BackupVaultName *string + // An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon + // SNS) topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic. + SNSTopicArn *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/backup/api_op_GetRecoveryPointRestoreMetadata.go b/service/backup/api_op_GetRecoveryPointRestoreMetadata.go index ab19ac84e49..146ee6c04c5 100644 --- a/service/backup/api_op_GetRecoveryPointRestoreMetadata.go +++ b/service/backup/api_op_GetRecoveryPointRestoreMetadata.go @@ -74,11 +74,6 @@ type GetRecoveryPointRestoreMetadataInput struct { type GetRecoveryPointRestoreMetadataOutput struct { - // The set of metadata key-value pairs that describes the original configuration of - // the backed-up resource. These values vary depending on the service that is being - // restored. - RestoreMetadata map[string]*string - // An ARN that uniquely identifies a backup vault; for example, // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. BackupVaultArn *string @@ -87,6 +82,11 @@ type GetRecoveryPointRestoreMetadataOutput struct { // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. RecoveryPointArn *string + // The set of metadata key-value pairs that describes the original configuration of + // the backed-up resource. These values vary depending on the service that is being + // restored. + RestoreMetadata map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/backup/api_op_ListBackupJobs.go b/service/backup/api_op_ListBackupJobs.go index 65e8b923856..903f20e70f1 100644 --- a/service/backup/api_op_ListBackupJobs.go +++ b/service/backup/api_op_ListBackupJobs.go @@ -61,25 +61,22 @@ type ListBackupJobsInput struct { // the specified account ID. ByAccountId *string - // The next item following a partial list of returned items. For example, if a - // request is made to return maxResults number of items, NextToken allows you to - // return more items in your list starting at the location pointed to by the next - // token. - NextToken *string + // Returns only backup jobs that will be stored in the specified backup vault. + // Backup vaults are identified by names that are unique to the account used to + // create them and the AWS Region where they are created. They consist of lowercase + // letters, numbers, and hyphens. + ByBackupVaultName *string // Returns only backup jobs that were created after the specified date. ByCreatedAfter *time.Time + // Returns only backup jobs that were created before the specified date. + ByCreatedBefore *time.Time + // Returns only backup jobs that match the specified resource Amazon Resource Name // (ARN). ByResourceArn *string - // Returns only backup jobs that are in the specified state. - ByState types.BackupJobState - - // The maximum number of items to be returned. - MaxResults *int32 - // Returns only backup jobs for the specified resources: // // * DynamoDB for Amazon @@ -98,14 +95,17 @@ type ListBackupJobsInput struct { // * Storage Gateway for AWS Storage Gateway ByResourceType *string - // Returns only backup jobs that were created before the specified date. - ByCreatedBefore *time.Time + // Returns only backup jobs that are in the specified state. + ByState types.BackupJobState - // Returns only backup jobs that will be stored in the specified backup vault. - // Backup vaults are identified by names that are unique to the account used to - // create them and the AWS Region where they are created. They consist of lowercase - // letters, numbers, and hyphens. - ByBackupVaultName *string + // The maximum number of items to be returned. + MaxResults *int32 + + // The next item following a partial list of returned items. For example, if a + // request is made to return maxResults number of items, NextToken allows you to + // return more items in your list starting at the location pointed to by the next + // token. + NextToken *string } type ListBackupJobsOutput struct { diff --git a/service/backup/api_op_ListBackupPlanVersions.go b/service/backup/api_op_ListBackupPlanVersions.go index 14e11d21f37..b49373add16 100644 --- a/service/backup/api_op_ListBackupPlanVersions.go +++ b/service/backup/api_op_ListBackupPlanVersions.go @@ -76,15 +76,15 @@ type ListBackupPlanVersionsInput struct { type ListBackupPlanVersionsOutput struct { + // An array of version list items containing metadata about your backup plans. + BackupPlanVersionsList []*types.BackupPlansListMember + // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string - // An array of version list items containing metadata about your backup plans. - BackupPlanVersionsList []*types.BackupPlansListMember - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/backup/api_op_ListBackupPlans.go b/service/backup/api_op_ListBackupPlans.go index 2c285f94ee2..27a7247ef2f 100644 --- a/service/backup/api_op_ListBackupPlans.go +++ b/service/backup/api_op_ListBackupPlans.go @@ -58,18 +58,18 @@ func (c *Client) ListBackupPlans(ctx context.Context, params *ListBackupPlansInp type ListBackupPlansInput struct { + // A Boolean value with a default value of FALSE that returns deleted backup plans + // when set to TRUE. + IncludeDeleted *bool + + // The maximum number of items to be returned. + MaxResults *int32 + // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string - - // The maximum number of items to be returned. - MaxResults *int32 - - // A Boolean value with a default value of FALSE that returns deleted backup plans - // when set to TRUE. - IncludeDeleted *bool } type ListBackupPlansOutput struct { diff --git a/service/backup/api_op_ListBackupSelections.go b/service/backup/api_op_ListBackupSelections.go index 3837b5020c2..c4e22bb889d 100644 --- a/service/backup/api_op_ListBackupSelections.go +++ b/service/backup/api_op_ListBackupSelections.go @@ -58,19 +58,19 @@ func (c *Client) ListBackupSelections(ctx context.Context, params *ListBackupSel type ListBackupSelectionsInput struct { + // Uniquely identifies a backup plan. + // + // This member is required. + BackupPlanId *string + + // The maximum number of items to be returned. + MaxResults *int32 + // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string - - // The maximum number of items to be returned. - MaxResults *int32 - - // Uniquely identifies a backup plan. - // - // This member is required. - BackupPlanId *string } type ListBackupSelectionsOutput struct { diff --git a/service/backup/api_op_ListCopyJobs.go b/service/backup/api_op_ListCopyJobs.go index 205379ae866..24f66ac0062 100644 --- a/service/backup/api_op_ListCopyJobs.go +++ b/service/backup/api_op_ListCopyJobs.go @@ -61,18 +61,20 @@ type ListCopyJobsInput struct { // specified account ID. ByAccountId *string - // Returns only copy jobs that match the specified resource Amazon Resource Name - // (ARN). - ByResourceArn *string + // Returns only copy jobs that were created after the specified date. + ByCreatedAfter *time.Time - // The maximum number of items to be returned. - MaxResults *int32 + // Returns only copy jobs that were created before the specified date. + ByCreatedBefore *time.Time - // Returns only copy jobs that are in the specified state. - ByState types.CopyJobState + // An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to + // copy from; for example, + // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + ByDestinationVaultArn *string - // Returns only copy jobs that were created after the specified date. - ByCreatedAfter *time.Time + // Returns only copy jobs that match the specified resource Amazon Resource Name + // (ARN). + ByResourceArn *string // Returns only backup jobs for the specified resources: // @@ -92,19 +94,17 @@ type ListCopyJobsInput struct { // * Storage Gateway for AWS Storage Gateway ByResourceType *string + // Returns only copy jobs that are in the specified state. + ByState types.CopyJobState + + // The maximum number of items to be returned. + MaxResults *int32 + // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string - - // Returns only copy jobs that were created before the specified date. - ByCreatedBefore *time.Time - - // An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to - // copy from; for example, - // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. - ByDestinationVaultArn *string } type ListCopyJobsOutput struct { diff --git a/service/backup/api_op_ListProtectedResources.go b/service/backup/api_op_ListProtectedResources.go index dccb026397e..038c2641697 100644 --- a/service/backup/api_op_ListProtectedResources.go +++ b/service/backup/api_op_ListProtectedResources.go @@ -58,14 +58,14 @@ func (c *Client) ListProtectedResources(ctx context.Context, params *ListProtect type ListProtectedResourcesInput struct { + // The maximum number of items to be returned. + MaxResults *int32 + // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string - - // The maximum number of items to be returned. - MaxResults *int32 } type ListProtectedResourcesOutput struct { diff --git a/service/backup/api_op_ListRecoveryPointsByBackupVault.go b/service/backup/api_op_ListRecoveryPointsByBackupVault.go index 63f1ead332c..478e0f75c67 100644 --- a/service/backup/api_op_ListRecoveryPointsByBackupVault.go +++ b/service/backup/api_op_ListRecoveryPointsByBackupVault.go @@ -58,12 +58,6 @@ func (c *Client) ListRecoveryPointsByBackupVault(ctx context.Context, params *Li type ListRecoveryPointsByBackupVaultInput struct { - // The next item following a partial list of returned items. For example, if a - // request is made to return maxResults number of items, NextToken allows you to - // return more items in your list starting at the location pointed to by the next - // token. - NextToken *string - // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // AWS Region where they are created. They consist of lowercase letters, numbers, @@ -72,38 +66,44 @@ type ListRecoveryPointsByBackupVaultInput struct { // This member is required. BackupVaultName *string - // Returns only recovery points that match the specified resource Amazon Resource - // Name (ARN). - ByResourceArn *string - // Returns only recovery points that match the specified backup plan ID. ByBackupPlanId *string - // The maximum number of items to be returned. - MaxResults *int32 - // Returns only recovery points that were created after the specified timestamp. ByCreatedAfter *time.Time // Returns only recovery points that were created before the specified timestamp. ByCreatedBefore *time.Time + // Returns only recovery points that match the specified resource Amazon Resource + // Name (ARN). + ByResourceArn *string + // Returns only recovery points that match the specified resource type. ByResourceType *string + + // The maximum number of items to be returned. + MaxResults *int32 + + // The next item following a partial list of returned items. For example, if a + // request is made to return maxResults number of items, NextToken allows you to + // return more items in your list starting at the location pointed to by the next + // token. + NextToken *string } type ListRecoveryPointsByBackupVaultOutput struct { - // An array of objects that contain detailed information about recovery points - // saved in a backup vault. - RecoveryPoints []*types.RecoveryPointByBackupVault - // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string + // An array of objects that contain detailed information about recovery points + // saved in a backup vault. + RecoveryPoints []*types.RecoveryPointByBackupVault + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/backup/api_op_ListRecoveryPointsByResource.go b/service/backup/api_op_ListRecoveryPointsByResource.go index b98ba78704d..342f90e58df 100644 --- a/service/backup/api_op_ListRecoveryPointsByResource.go +++ b/service/backup/api_op_ListRecoveryPointsByResource.go @@ -58,15 +58,15 @@ func (c *Client) ListRecoveryPointsByResource(ctx context.Context, params *ListR type ListRecoveryPointsByResourceInput struct { - // The maximum number of items to be returned. - MaxResults *int32 - // An ARN that uniquely identifies a resource. The format of the ARN depends on the // resource type. // // This member is required. ResourceArn *string + // The maximum number of items to be returned. + MaxResults *int32 + // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next @@ -76,16 +76,16 @@ type ListRecoveryPointsByResourceInput struct { type ListRecoveryPointsByResourceOutput struct { - // An array of objects that contain detailed information about recovery points of - // the specified resource type. - RecoveryPoints []*types.RecoveryPointByResource - // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string + // An array of objects that contain detailed information about recovery points of + // the specified resource type. + RecoveryPoints []*types.RecoveryPointByResource + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/backup/api_op_ListRestoreJobs.go b/service/backup/api_op_ListRestoreJobs.go index 0f00f80c33b..3fb9481a0f7 100644 --- a/service/backup/api_op_ListRestoreJobs.go +++ b/service/backup/api_op_ListRestoreJobs.go @@ -58,12 +58,6 @@ func (c *Client) ListRestoreJobs(ctx context.Context, params *ListRestoreJobsInp type ListRestoreJobsInput struct { - // The next item following a partial list of returned items. For example, if a - // request is made to return maxResults number of items, NextToken allows you to - // return more items in your list starting at the location pointed to by the next - // token. - NextToken *string - // The account ID to list the jobs from. Returns only restore jobs associated with // the specified account ID. ByAccountId *string @@ -71,28 +65,34 @@ type ListRestoreJobsInput struct { // Returns only restore jobs that were created after the specified date. ByCreatedAfter *time.Time + // Returns only restore jobs that were created before the specified date. + ByCreatedBefore *time.Time + // Returns only restore jobs associated with the specified job status. ByStatus types.RestoreJobStatus // The maximum number of items to be returned. MaxResults *int32 - // Returns only restore jobs that were created before the specified date. - ByCreatedBefore *time.Time + // The next item following a partial list of returned items. For example, if a + // request is made to return maxResults number of items, NextToken allows you to + // return more items in your list starting at the location pointed to by the next + // token. + NextToken *string } type ListRestoreJobsOutput struct { - // An array of objects that contain detailed information about jobs to restore - // saved resources. - RestoreJobs []*types.RestoreJobsListMember - // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string + // An array of objects that contain detailed information about jobs to restore + // saved resources. + RestoreJobs []*types.RestoreJobsListMember + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/backup/api_op_ListTags.go b/service/backup/api_op_ListTags.go index de08865d61d..c1efdc642dd 100644 --- a/service/backup/api_op_ListTags.go +++ b/service/backup/api_op_ListTags.go @@ -58,12 +58,6 @@ func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ... type ListTagsInput struct { - // The next item following a partial list of returned items. For example, if a - // request is made to return maxResults number of items, NextToken allows you to - // return more items in your list starting at the location pointed to by the next - // token. - NextToken *string - // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of // the ARN depends on the type of resource. Valid targets for ListTags are recovery // points, backup plans, and backup vaults. @@ -73,20 +67,26 @@ type ListTagsInput struct { // The maximum number of items to be returned. MaxResults *int32 + + // The next item following a partial list of returned items. For example, if a + // request is made to return maxResults number of items, NextToken allows you to + // return more items in your list starting at the location pointed to by the next + // token. + NextToken *string } type ListTagsOutput struct { - // To help organize your resources, you can assign your own metadata to the - // resources you create. Each tag is a key-value pair. - Tags map[string]*string - // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string + // To help organize your resources, you can assign your own metadata to the + // resources you create. Each tag is a key-value pair. + Tags map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/backup/api_op_PutBackupVaultAccessPolicy.go b/service/backup/api_op_PutBackupVaultAccessPolicy.go index efa8d6d04cb..8a2f5af29ab 100644 --- a/service/backup/api_op_PutBackupVaultAccessPolicy.go +++ b/service/backup/api_op_PutBackupVaultAccessPolicy.go @@ -58,9 +58,6 @@ func (c *Client) PutBackupVaultAccessPolicy(ctx context.Context, params *PutBack type PutBackupVaultAccessPolicyInput struct { - // The backup vault access policy document in JSON format. - Policy *string - // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // AWS Region where they are created. They consist of lowercase letters, numbers, @@ -68,6 +65,9 @@ type PutBackupVaultAccessPolicyInput struct { // // This member is required. BackupVaultName *string + + // The backup vault access policy document in JSON format. + Policy *string } type PutBackupVaultAccessPolicyOutput struct { diff --git a/service/backup/api_op_PutBackupVaultNotifications.go b/service/backup/api_op_PutBackupVaultNotifications.go index a94ed8d8e32..0377f8ec4f9 100644 --- a/service/backup/api_op_PutBackupVaultNotifications.go +++ b/service/backup/api_op_PutBackupVaultNotifications.go @@ -63,12 +63,6 @@ type PutBackupVaultNotificationsInput struct { // This member is required. BackupVaultEvents []types.BackupVaultEvent - // The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s - // events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic. - // - // This member is required. - SNSTopicArn *string - // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // AWS Region where they are created. They consist of lowercase letters, numbers, @@ -76,6 +70,12 @@ type PutBackupVaultNotificationsInput struct { // // This member is required. BackupVaultName *string + + // The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s + // events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic. + // + // This member is required. + SNSTopicArn *string } type PutBackupVaultNotificationsOutput struct { diff --git a/service/backup/api_op_StartBackupJob.go b/service/backup/api_op_StartBackupJob.go index 131673c1de2..21d8d5dc301 100644 --- a/service/backup/api_op_StartBackupJob.go +++ b/service/backup/api_op_StartBackupJob.go @@ -58,33 +58,6 @@ func (c *Client) StartBackupJob(ctx context.Context, params *StartBackupJobInput type StartBackupJobInput struct { - // The lifecycle defines when a protected resource is transitioned to cold storage - // and when it expires. AWS Backup will transition and expire backups automatically - // according to the lifecycle that you define. Backups transitioned to cold storage - // must be stored in cold storage for a minimum of 90 days. Therefore, the “expire - // after days” setting must be 90 days greater than the “transition to cold after - // days” setting. The “transition to cold after days” setting cannot be changed - // after a backup has been transitioned to cold. - Lifecycle *types.Lifecycle - - // A value in minutes after a backup is scheduled before a job will be canceled if - // it doesn't start successfully. This value is optional. - StartWindowMinutes *int64 - - // A value in minutes after a backup job is successfully started before it must be - // completed or it will be canceled by AWS Backup. This value is optional. - CompleteWindowMinutes *int64 - - // Specifies the IAM role ARN used to create the target recovery point; for - // example, arn:aws:iam::123456789012:role/S3Access. - // - // This member is required. - IamRoleArn *string - - // To help organize your resources, you can assign your own metadata to the - // resources that you create. Each tag is a key-value pair. - RecoveryPointTags map[string]*string - // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // AWS Region where they are created. They consist of lowercase letters, numbers, @@ -93,23 +66,46 @@ type StartBackupJobInput struct { // This member is required. BackupVaultName *string + // Specifies the IAM role ARN used to create the target recovery point; for + // example, arn:aws:iam::123456789012:role/S3Access. + // + // This member is required. + IamRoleArn *string + // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of // the ARN depends on the resource type. // // This member is required. ResourceArn *string + // A value in minutes after a backup job is successfully started before it must be + // completed or it will be canceled by AWS Backup. This value is optional. + CompleteWindowMinutes *int64 + // A customer chosen string that can be used to distinguish between calls to // StartBackupJob. IdempotencyToken *string + + // The lifecycle defines when a protected resource is transitioned to cold storage + // and when it expires. AWS Backup will transition and expire backups automatically + // according to the lifecycle that you define. Backups transitioned to cold storage + // must be stored in cold storage for a minimum of 90 days. Therefore, the “expire + // after days” setting must be 90 days greater than the “transition to cold after + // days” setting. The “transition to cold after days” setting cannot be changed + // after a backup has been transitioned to cold. + Lifecycle *types.Lifecycle + + // To help organize your resources, you can assign your own metadata to the + // resources that you create. Each tag is a key-value pair. + RecoveryPointTags map[string]*string + + // A value in minutes after a backup is scheduled before a job will be canceled if + // it doesn't start successfully. This value is optional. + StartWindowMinutes *int64 } type StartBackupJobOutput struct { - // An ARN that uniquely identifies a recovery point; for example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. - RecoveryPointArn *string - // Uniquely identifies a request to AWS Backup to back up a resource. BackupJobId *string @@ -119,6 +115,10 @@ type StartBackupJobOutput struct { // 12:11:30.087 AM. CreationDate *time.Time + // An ARN that uniquely identifies a recovery point; for example, + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + RecoveryPointArn *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/backup/api_op_StartCopyJob.go b/service/backup/api_op_StartCopyJob.go index 850ed60c885..e110f809024 100644 --- a/service/backup/api_op_StartCopyJob.go +++ b/service/backup/api_op_StartCopyJob.go @@ -58,18 +58,6 @@ func (c *Client) StartCopyJob(ctx context.Context, params *StartCopyJobInput, op type StartCopyJobInput struct { - // The name of a logical source container where backups are stored. Backup vaults - // are identified by names that are unique to the account used to create them and - // the AWS Region where they are created. They consist of lowercase letters, - // numbers, and hyphens. - // - // This member is required. - SourceBackupVaultName *string - - // A customer chosen string that can be used to distinguish between calls to - // StartCopyJob. - IdempotencyToken *string - // An Amazon Resource Name (ARN) that uniquely identifies a destination backup // vault to copy to; for example, // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. @@ -90,6 +78,18 @@ type StartCopyJobInput struct { // This member is required. RecoveryPointArn *string + // The name of a logical source container where backups are stored. Backup vaults + // are identified by names that are unique to the account used to create them and + // the AWS Region where they are created. They consist of lowercase letters, + // numbers, and hyphens. + // + // This member is required. + SourceBackupVaultName *string + + // A customer chosen string that can be used to distinguish between calls to + // StartCopyJob. + IdempotencyToken *string + // Contains an array of Transition objects specifying how long in days before a // recovery point transitions to cold storage or is deleted. Backups transitioned // to cold storage must be stored in cold storage for a minimum of 90 days. @@ -102,15 +102,15 @@ type StartCopyJobInput struct { type StartCopyJobOutput struct { + // Uniquely identifies a copy job. + CopyJobId *string + // The date and time that a copy job is started, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time - // Uniquely identifies a copy job. - CopyJobId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/backup/api_op_StartRestoreJob.go b/service/backup/api_op_StartRestoreJob.go index 5b8eb12b69a..7c57baec2e8 100644 --- a/service/backup/api_op_StartRestoreJob.go +++ b/service/backup/api_op_StartRestoreJob.go @@ -59,41 +59,12 @@ func (c *Client) StartRestoreJob(ctx context.Context, params *StartRestoreJobInp type StartRestoreJobInput struct { - // An ARN that uniquely identifies a recovery point; for example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. - // - // This member is required. - RecoveryPointArn *string - - // Starts a job to restore a recovery point for one of the following resources: - // - // - // * DynamoDB for Amazon DynamoDB - // - // * EBS for Amazon Elastic Block Store - // - // * - // EC2 for Amazon Elastic Compute Cloud - // - // * EFS for Amazon Elastic File System - // - // - // * RDS for Amazon Relational Database Service - // - // * Storage Gateway for AWS - // Storage Gateway - ResourceType *string - // The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create // the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access. // // This member is required. IamRoleArn *string - // A customer chosen string that can be used to distinguish between calls to - // StartRestoreJob. - IdempotencyToken *string - // A set of metadata key-value pairs. Contains information, such as a resource // name, required to restore a recovery point. You can get configuration metadata // about a resource at the time it was backed up by calling @@ -126,6 +97,35 @@ type StartRestoreJobInput struct { // // This member is required. Metadata map[string]*string + + // An ARN that uniquely identifies a recovery point; for example, + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + // + // This member is required. + RecoveryPointArn *string + + // A customer chosen string that can be used to distinguish between calls to + // StartRestoreJob. + IdempotencyToken *string + + // Starts a job to restore a recovery point for one of the following resources: + // + // + // * DynamoDB for Amazon DynamoDB + // + // * EBS for Amazon Elastic Block Store + // + // * + // EC2 for Amazon Elastic Compute Cloud + // + // * EFS for Amazon Elastic File System + // + // + // * RDS for Amazon Relational Database Service + // + // * Storage Gateway for AWS + // Storage Gateway + ResourceType *string } type StartRestoreJobOutput struct { diff --git a/service/backup/api_op_TagResource.go b/service/backup/api_op_TagResource.go index 4dfa02ec075..bc6218b7af9 100644 --- a/service/backup/api_op_TagResource.go +++ b/service/backup/api_op_TagResource.go @@ -57,17 +57,17 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // Key-value pairs that are used to help organize your resources. You can assign - // your own metadata to the resources you create. - // - // This member is required. - Tags map[string]*string - // An ARN that uniquely identifies a resource. The format of the ARN depends on the // type of the tagged resource. // // This member is required. ResourceArn *string + + // Key-value pairs that are used to help organize your resources. You can assign + // your own metadata to the resources you create. + // + // This member is required. + Tags map[string]*string } type TagResourceOutput struct { diff --git a/service/backup/api_op_UntagResource.go b/service/backup/api_op_UntagResource.go index cafecd64a6f..b35544bd815 100644 --- a/service/backup/api_op_UntagResource.go +++ b/service/backup/api_op_UntagResource.go @@ -57,16 +57,16 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // A list of keys to identify which key-value tags to remove from a resource. - // - // This member is required. - TagKeyList []*string - // An ARN that uniquely identifies a resource. The format of the ARN depends on the // type of the tagged resource. // // This member is required. ResourceArn *string + + // A list of keys to identify which key-value tags to remove from a resource. + // + // This member is required. + TagKeyList []*string } type UntagResourceOutput struct { diff --git a/service/backup/api_op_UpdateBackupPlan.go b/service/backup/api_op_UpdateBackupPlan.go index d121146159e..763c1dc0c02 100644 --- a/service/backup/api_op_UpdateBackupPlan.go +++ b/service/backup/api_op_UpdateBackupPlan.go @@ -60,31 +60,27 @@ func (c *Client) UpdateBackupPlan(ctx context.Context, params *UpdateBackupPlanI type UpdateBackupPlanInput struct { - // Uniquely identifies a backup plan. - // - // This member is required. - BackupPlanId *string - // Specifies the body of a backup plan. Includes a BackupPlanName and one or more // sets of Rules. // // This member is required. BackupPlan *types.BackupPlanInput -} - -type UpdateBackupPlanOutput struct { // Uniquely identifies a backup plan. + // + // This member is required. BackupPlanId *string +} + +type UpdateBackupPlanOutput struct { // An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for // example, // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. BackupPlanArn *string - // Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most - // 1,024 bytes long. Version Ids cannot be edited. - VersionId *string + // Uniquely identifies a backup plan. + BackupPlanId *string // The date and time a backup plan is updated, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For @@ -92,6 +88,10 @@ type UpdateBackupPlanOutput struct { // 12:11:30.087 AM. CreationDate *time.Time + // Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most + // 1,024 bytes long. Version Ids cannot be edited. + VersionId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/backup/api_op_UpdateRecoveryPointLifecycle.go b/service/backup/api_op_UpdateRecoveryPointLifecycle.go index 915de3b9d59..0374b62dd98 100644 --- a/service/backup/api_op_UpdateRecoveryPointLifecycle.go +++ b/service/backup/api_op_UpdateRecoveryPointLifecycle.go @@ -64,6 +64,14 @@ func (c *Client) UpdateRecoveryPointLifecycle(ctx context.Context, params *Updat type UpdateRecoveryPointLifecycleInput struct { + // The name of a logical container where backups are stored. Backup vaults are + // identified by names that are unique to the account used to create them and the + // AWS Region where they are created. They consist of lowercase letters, numbers, + // and hyphens. + // + // This member is required. + BackupVaultName *string + // An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for // example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. @@ -79,18 +87,14 @@ type UpdateRecoveryPointLifecycleInput struct { // days” setting. The “transition to cold after days” setting cannot be changed // after a backup has been transitioned to cold. Lifecycle *types.Lifecycle - - // The name of a logical container where backups are stored. Backup vaults are - // identified by names that are unique to the account used to create them and the - // AWS Region where they are created. They consist of lowercase letters, numbers, - // and hyphens. - // - // This member is required. - BackupVaultName *string } type UpdateRecoveryPointLifecycleOutput struct { + // An ARN that uniquely identifies a backup vault; for example, + // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + BackupVaultArn *string + // A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt // timestamps. CalculatedLifecycle *types.CalculatedLifecycle @@ -104,10 +108,6 @@ type UpdateRecoveryPointLifecycleOutput struct { // after a backup has been transitioned to cold. Lifecycle *types.Lifecycle - // An ARN that uniquely identifies a backup vault; for example, - // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. - BackupVaultArn *string - // An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for // example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. diff --git a/service/backup/go.mod b/service/backup/go.mod index c0bf055cb1d..9067e81ca1f 100644 --- a/service/backup/go.mod +++ b/service/backup/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/backup go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/backup/types/types.go b/service/backup/types/types.go index 90c7169fa44..563f669b202 100644 --- a/service/backup/types/types.go +++ b/service/backup/types/types.go @@ -9,11 +9,18 @@ import ( // Contains detailed information about a backup job. type BackupJob struct { - // The date and time a job to create a backup job is completed, in Unix format and - // Coordinated Universal Time (UTC). The value of CompletionDate is accurate to - // milliseconds. For example, the value 1516925490.087 represents Friday, January - // 26, 2018 12:11:30.087 AM. - CompletionDate *time.Time + // The account ID that owns the backup job. + AccountId *string + + // Uniquely identifies a request to AWS Backup to back up a resource. + BackupJobId *string + + // The size, in bytes, of a backup. + BackupSizeInBytes *int64 + + // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for + // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + BackupVaultArn *string // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the @@ -21,21 +28,20 @@ type BackupJob struct { // and hyphens. BackupVaultName *string - // Specifies the time in Unix format and Coordinated Universal Time (UTC) when a - // backup job must be started before it is canceled. The value is calculated by - // adding the start window to the scheduled time. So if the scheduled time were - // 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on - // the date specified. The value of StartBy is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 - // 12:11:30.087 AM. - StartBy *time.Time + // The size in bytes transferred to a backup vault at the time that the job status + // was queried. + BytesTransferred *int64 - // Specifies the IAM role ARN used to create the target recovery point; for - // example, arn:aws:iam::123456789012:role/S3Access. - IamRoleArn *string + // The date and time a job to create a backup job is completed, in Unix format and + // Coordinated Universal Time (UTC). The value of CompletionDate is accurate to + // milliseconds. For example, the value 1516925490.087 represents Friday, January + // 26, 2018 12:11:30.087 AM. + CompletionDate *time.Time - // The current state of a resource recovery point. - State BackupJobState + // Contains identifying information about the creation of a backup job, including + // the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the + // backup plan used to create it. + CreatedBy *RecoveryPointCreator // The date and time a backup job is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For @@ -43,53 +49,47 @@ type BackupJob struct { // 12:11:30.087 AM. CreationDate *time.Time - // Contains identifying information about the creation of a backup job, including - // the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the - // backup plan used to create it. - CreatedBy *RecoveryPointCreator - - // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for - // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. - BackupVaultArn *string - - // A detailed message explaining the status of the job to back up a resource. - StatusMessage *string - - // The size in bytes transferred to a backup vault at the time that the job status - // was queried. - BytesTransferred *int64 - - // Uniquely identifies a request to AWS Backup to back up a resource. - BackupJobId *string - // The date and time a job to back up resources is expected to be completed, in // Unix format and Coordinated Universal Time (UTC). The value of // ExpectedCompletionDate is accurate to milliseconds. For example, the value // 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. ExpectedCompletionDate *time.Time + // Specifies the IAM role ARN used to create the target recovery point; for + // example, arn:aws:iam::123456789012:role/S3Access. + IamRoleArn *string + // Contains an estimated percentage complete of a job at the time the job status // was queried. PercentDone *string - // The account ID that owns the backup job. - AccountId *string + // An ARN that uniquely identifies a recovery point; for example, + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + RecoveryPointArn *string + + // An ARN that uniquely identifies a resource. The format of the ARN depends on the + // resource type. + ResourceArn *string // The type of AWS resource to be backed up; for example, an Amazon Elastic Block // Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) // database. ResourceType *string - // An ARN that uniquely identifies a resource. The format of the ARN depends on the - // resource type. - ResourceArn *string + // Specifies the time in Unix format and Coordinated Universal Time (UTC) when a + // backup job must be started before it is canceled. The value is calculated by + // adding the start window to the scheduled time. So if the scheduled time were + // 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on + // the date specified. The value of StartBy is accurate to milliseconds. For + // example, the value 1516925490.087 represents Friday, January 26, 2018 + // 12:11:30.087 AM. + StartBy *time.Time - // The size, in bytes, of a backup. - BackupSizeInBytes *int64 + // The current state of a resource recovery point. + State BackupJobState - // An ARN that uniquely identifies a recovery point; for example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. - RecoveryPointArn *string + // A detailed message explaining the status of the job to back up a resource. + StatusMessage *string } // Contains an optional backup plan display name and an array of BackupRule @@ -114,24 +114,31 @@ type BackupPlan struct { // separate scheduled task and can back up a different selection of AWS resources. type BackupPlanInput struct { - // An array of BackupRule objects, each of which specifies a scheduled task that is - // used to back up a selection of resources. + // The optional display name of a backup plan. // // This member is required. - Rules []*BackupRuleInput + BackupPlanName *string - // The optional display name of a backup plan. + // An array of BackupRule objects, each of which specifies a scheduled task that is + // used to back up a selection of resources. // // This member is required. - BackupPlanName *string + Rules []*BackupRuleInput } // Contains metadata about a backup plan. type BackupPlansListMember struct { - // Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most - // 1,024 bytes long. Version IDs cannot be edited. - VersionId *string + // An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for + // example, + // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. + BackupPlanArn *string + + // Uniquely identifies a backup plan. + BackupPlanId *string + + // The display name of a saved backup plan. + BackupPlanName *string // The date and time a resource backup plan is created, in Unix format and // Coordinated Universal Time (UTC). The value of CreationDate is accurate to @@ -139,19 +146,9 @@ type BackupPlansListMember struct { // 26, 2018 12:11:30.087 AM. CreationDate *time.Time - // The display name of a saved backup plan. - BackupPlanName *string - - // An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for - // example, - // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. - BackupPlanArn *string - - // The last time a job to back up resources was executed with this rule. A date and - // time, in Unix format and Coordinated Universal Time (UTC). The value of - // LastExecutionDate is accurate to milliseconds. For example, the value - // 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. - LastExecutionDate *time.Time + // A unique string that identifies the request and allows failed requests to be + // retried without the risk of executing the operation twice. + CreatorRequestId *string // The date and time a backup plan is deleted, in Unix format and Coordinated // Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For @@ -159,12 +156,15 @@ type BackupPlansListMember struct { // 12:11:30.087 AM. DeletionDate *time.Time - // Uniquely identifies a backup plan. - BackupPlanId *string + // The last time a job to back up resources was executed with this rule. A date and + // time, in Unix format and Coordinated Universal Time (UTC). The value of + // LastExecutionDate is accurate to milliseconds. For example, the value + // 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + LastExecutionDate *time.Time - // A unique string that identifies the request and allows failed requests to be - // retried without the risk of executing the operation twice. - CreatorRequestId *string + // Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most + // 1,024 bytes long. Version IDs cannot be edited. + VersionId *string } // An object specifying metadata associated with a backup plan template. @@ -180,6 +180,11 @@ type BackupPlanTemplatesListMember struct { // Specifies a scheduled task used to back up a selection of resources. type BackupRule struct { + // An optional display name for a backup rule. + // + // This member is required. + RuleName *string + // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // AWS Region where they are created. They consist of lowercase letters, numbers, @@ -192,8 +197,9 @@ type BackupRule struct { // completed or it will be canceled by AWS Backup. This value is optional. CompletionWindowMinutes *int64 - // A CRON expression specifying when AWS Backup initiates a backup job. - ScheduleExpression *string + // An array of CopyAction objects, which contains the details of the copy + // operation. + CopyActions []*CopyAction // The lifecycle defines when a protected resource is transitioned to cold storage // and when it expires. AWS Backup transitions and expires backups automatically @@ -204,55 +210,46 @@ type BackupRule struct { // after a backup has been transitioned to cold. Lifecycle *Lifecycle + // An array of key-value pair strings that are assigned to resources that are + // associated with this rule when restored from backup. + RecoveryPointTags map[string]*string + // Uniquely identifies a rule that is used to schedule the backup of a selection of // resources. RuleId *string - // An array of key-value pair strings that are assigned to resources that are - // associated with this rule when restored from backup. - RecoveryPointTags map[string]*string + // A CRON expression specifying when AWS Backup initiates a backup job. + ScheduleExpression *string // A value in minutes after a backup is scheduled before a job will be canceled if // it doesn't start successfully. This value is optional. StartWindowMinutes *int64 - - // An optional display name for a backup rule. - // - // This member is required. - RuleName *string - - // An array of CopyAction objects, which contains the details of the copy - // operation. - CopyActions []*CopyAction } // Specifies a scheduled task used to back up a selection of resources. type BackupRuleInput struct { - // To help organize your resources, you can assign your own metadata to the - // resources that you create. Each tag is a key-value pair. - RecoveryPointTags map[string]*string - // An optional display name for a backup rule. // // This member is required. RuleName *string - // A value in minutes after a backup is scheduled before a job will be canceled if - // it doesn't start successfully. This value is optional. - StartWindowMinutes *int64 + // The name of a logical container where backups are stored. Backup vaults are + // identified by names that are unique to the account used to create them and the + // AWS Region where they are created. They consist of lowercase letters, numbers, + // and hyphens. + // + // This member is required. + TargetBackupVaultName *string - // A CRON expression specifying when AWS Backup initiates a backup job. - ScheduleExpression *string + // A value in minutes after a backup job is successfully started before it must be + // completed or it will be canceled by AWS Backup. This value is optional. + CompletionWindowMinutes *int64 // An array of CopyAction objects, which contains the details of the copy // operation. CopyActions []*CopyAction - // A value in minutes after a backup job is successfully started before it must be - // completed or it will be canceled by AWS Backup. This value is optional. - CompletionWindowMinutes *int64 - // The lifecycle defines when a protected resource is transitioned to cold storage // and when it expires. AWS Backup will transition and expire backups automatically // according to the lifecycle that you define. Backups transitioned to cold storage @@ -262,26 +259,21 @@ type BackupRuleInput struct { // after a backup has been transitioned to cold. Lifecycle *Lifecycle - // The name of a logical container where backups are stored. Backup vaults are - // identified by names that are unique to the account used to create them and the - // AWS Region where they are created. They consist of lowercase letters, numbers, - // and hyphens. - // - // This member is required. - TargetBackupVaultName *string + // To help organize your resources, you can assign your own metadata to the + // resources that you create. Each tag is a key-value pair. + RecoveryPointTags map[string]*string + + // A CRON expression specifying when AWS Backup initiates a backup job. + ScheduleExpression *string + + // A value in minutes after a backup is scheduled before a job will be canceled if + // it doesn't start successfully. This value is optional. + StartWindowMinutes *int64 } // Used to specify a set of resources to a backup plan. type BackupSelection struct { - // An array of conditions used to specify a set of resources to assign to a backup - // plan; for example, "STRINGEQUALS": {"ec2:ResourceTag/Department": "accounting". - ListOfTags []*Condition - - // An array of strings that contain Amazon Resource Names (ARNs) of resources to - // assign to a backup plan. - Resources []*string - // The ARN of the IAM role that AWS Backup uses to authenticate when restoring the // target resource; for example, arn:aws:iam::123456789012:role/S3Access. // @@ -292,6 +284,14 @@ type BackupSelection struct { // // This member is required. SelectionName *string + + // An array of conditions used to specify a set of resources to assign to a backup + // plan; for example, "STRINGEQUALS": {"ec2:ResourceTag/Department": "accounting". + ListOfTags []*Condition + + // An array of strings that contain Amazon Resource Names (ARNs) of resources to + // assign to a backup plan. + Resources []*string } // Contains metadata about a BackupSelection object. @@ -300,29 +300,45 @@ type BackupSelectionsListMember struct { // Uniquely identifies a backup plan. BackupPlanId *string + // The date and time a backup plan is created, in Unix format and Coordinated + // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For + // example, the value 1516925490.087 represents Friday, January 26, 2018 + // 12:11:30.087 AM. + CreationDate *time.Time + // A unique string that identifies the request and allows failed requests to be // retried without the risk of executing the operation twice. CreatorRequestId *string + // Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery + // point; for example, arn:aws:iam::123456789012:role/S3Access. + IamRoleArn *string + // Uniquely identifies a request to assign a set of resources to a backup plan. SelectionId *string // The display name of a resource selection document. SelectionName *string +} - // Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery - // point; for example, arn:aws:iam::123456789012:role/S3Access. - IamRoleArn *string +// Contains metadata about a backup vault. +type BackupVaultListMember struct { - // The date and time a backup plan is created, in Unix format and Coordinated + // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for + // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + BackupVaultArn *string + + // The name of a logical container where backups are stored. Backup vaults are + // identified by names that are unique to the account used to create them and the + // AWS Region where they are created. They consist of lowercase letters, numbers, + // and hyphens. + BackupVaultName *string + + // The date and time a resource backup is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time -} - -// Contains metadata about a backup vault. -type BackupVaultListMember struct { // A unique string that identifies the request and allows failed requests to be // retried without the risk of executing the operation twice. @@ -333,24 +349,8 @@ type BackupVaultListMember struct { // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. EncryptionKeyArn *string - // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for - // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. - BackupVaultArn *string - - // The date and time a resource backup is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 - // 12:11:30.087 AM. - CreationDate *time.Time - // The number of recovery points that are stored in a backup vault. NumberOfRecoveryPoints *int64 - - // The name of a logical container where backups are stored. Backup vaults are - // identified by names that are unique to the account used to create them and the - // AWS Region where they are created. They consist of lowercase letters, numbers, - // and hyphens. - BackupVaultName *string } // Contains DeleteAt and MoveToColdStorageAt timestamps, which are used to specify @@ -362,13 +362,13 @@ type BackupVaultListMember struct { // days greater than the “transition to cold after days” setting. The “transition // to cold after days” setting cannot be changed after a backup has been // transitioned to cold. -type CalculatedLifecycle struct { - - // A timestamp that specifies when to transition a recovery point to cold storage. - MoveToColdStorageAt *time.Time +type CalculatedLifecycle struct { // A timestamp that specifies when to delete a recovery point. DeleteAt *time.Time + + // A timestamp that specifies when to transition a recovery point to cold storage. + MoveToColdStorageAt *time.Time } // Contains an array of triplets made up of a condition type (such as @@ -376,6 +376,12 @@ type CalculatedLifecycle struct { // selection that is assigned to a backup plan. type Condition struct { + // The key in a key-value pair. For example, in "ec2:ResourceTag/Department": + // "accounting", "ec2:ResourceTag/Department" is the key. + // + // This member is required. + ConditionKey *string + // An operation, such as STRINGEQUALS, that is applied to a key-value pair used to // filter resources in a selection. // @@ -387,12 +393,6 @@ type Condition struct { // // This member is required. ConditionValue *string - - // The key in a key-value pair. For example, in "ec2:ResourceTag/Department": - // "accounting", "ec2:ResourceTag/Department" is the key. - // - // This member is required. - ConditionKey *string } // The details of the copy operation. @@ -418,26 +418,24 @@ type CopyAction struct { // Contains detailed information about a copy job. type CopyJob struct { + // The account ID that owns the copy job. + AccountId *string + + // The size, in bytes, of a copy job. + BackupSizeInBytes *int64 + // The date and time a copy job is completed, in Unix format and Coordinated // Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CompletionDate *time.Time - // The current state of a copy job. - State CopyJobState - - // An ARN that uniquely identifies a source recovery point; for example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. - SourceRecoveryPointArn *string - - // An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; - // for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. - DestinationBackupVaultArn *string + // Uniquely identifies a copy job. + CopyJobId *string - // An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for - // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. - SourceBackupVaultArn *string + // Contains information about the backup plan and rule that AWS Backup used to + // initiate the recovery point backup. + CreatedBy *RecoveryPointCreator // The date and time a copy job is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For @@ -445,29 +443,17 @@ type CopyJob struct { // 12:11:30.087 AM. CreationDate *time.Time - // Specifies the IAM role ARN used to copy the target recovery point; for example, - // arn:aws:iam::123456789012:role/S3Access. - IamRoleArn *string - - // Contains information about the backup plan and rule that AWS Backup used to - // initiate the recovery point backup. - CreatedBy *RecoveryPointCreator + // An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; + // for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + DestinationBackupVaultArn *string // An ARN that uniquely identifies a destination recovery point; for example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. DestinationRecoveryPointArn *string - // The account ID that owns the copy job. - AccountId *string - - // The size, in bytes, of a copy job. - BackupSizeInBytes *int64 - - // Uniquely identifies a copy job. - CopyJobId *string - - // A detailed message explaining the status of the job to copy a resource. - StatusMessage *string + // Specifies the IAM role ARN used to copy the target recovery point; for example, + // arn:aws:iam::123456789012:role/S3Access. + IamRoleArn *string // The AWS resource to be copied; for example, an Amazon Elastic Block Store // (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) @@ -478,6 +464,20 @@ type CopyJob struct { // Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) // database. ResourceType *string + + // An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for + // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + SourceBackupVaultArn *string + + // An ARN that uniquely identifies a source recovery point; for example, + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + SourceRecoveryPointArn *string + + // The current state of a copy job. + State CopyJobState + + // A detailed message explaining the status of the job to copy a resource. + StatusMessage *string } // Contains an array of Transition objects specifying how long in days before a @@ -501,10 +501,6 @@ type Lifecycle struct { // A structure that contains information about a backed-up resource. type ProtectedResource struct { - // The type of AWS resource; for example, an Amazon Elastic Block Store (Amazon - // EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. - ResourceType *string - // The date and time a resource was last backed up, in Unix format and Coordinated // Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. // For example, the value 1516925490.087 represents Friday, January 26, 2018 @@ -514,6 +510,10 @@ type ProtectedResource struct { // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of // the ARN depends on the resource type. ResourceArn *string + + // The type of AWS resource; for example, an Amazon Elastic Block Store (Amazon + // EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. + ResourceType *string } // Contains detailed information about the recovery points stored in a backup @@ -527,10 +527,15 @@ type RecoveryPointByBackupVault struct { // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. BackupVaultArn *string - // An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for - // example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. - RecoveryPointArn *string + // The name of a logical container where backups are stored. Backup vaults are + // identified by names that are unique to the account used to create them and the + // AWS Region where they are created. They consist of lowercase letters, numbers, + // and hyphens. + BackupVaultName *string + + // A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt + // timestamps. + CalculatedLifecycle *CalculatedLifecycle // The date and time a job to restore a recovery point is completed, in Unix format // and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to @@ -538,19 +543,16 @@ type RecoveryPointByBackupVault struct { // 26, 2018 12:11:30.087 AM. CompletionDate *time.Time - // The type of AWS resource saved as a recovery point; for example, an Amazon - // Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service - // (Amazon RDS) database. - ResourceType *string - - // The name of a logical container where backups are stored. Backup vaults are - // identified by names that are unique to the account used to create them and the - // AWS Region where they are created. They consist of lowercase letters, numbers, - // and hyphens. - BackupVaultName *string + // Contains identifying information about the creation of a recovery point, + // including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId + // of the backup plan that is used to create it. + CreatedBy *RecoveryPointCreator - // A status code specifying the state of the recovery point. - Status RecoveryPointStatus + // The date and time a recovery point is created, in Unix format and Coordinated + // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For + // example, the value 1516925490.087 represents Friday, January 26, 2018 + // 12:11:30.087 AM. + CreationDate *time.Time // The server-side encryption key that is used to protect your backups; for // example, @@ -561,13 +563,9 @@ type RecoveryPointByBackupVault struct { // example, arn:aws:iam::123456789012:role/S3Access. IamRoleArn *string - // An ARN that uniquely identifies a resource. The format of the ARN depends on the - // resource type. - ResourceArn *string - - // A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt - // timestamps. - CalculatedLifecycle *CalculatedLifecycle + // A Boolean value that is returned as TRUE if the specified recovery point is + // encrypted, or FALSE if the recovery point is not encrypted. + IsEncrypted *bool // The date and time a recovery point was last restored, in Unix format and // Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to @@ -575,21 +573,6 @@ type RecoveryPointByBackupVault struct { // 26, 2018 12:11:30.087 AM. LastRestoreTime *time.Time - // A Boolean value that is returned as TRUE if the specified recovery point is - // encrypted, or FALSE if the recovery point is not encrypted. - IsEncrypted *bool - - // Contains identifying information about the creation of a recovery point, - // including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId - // of the backup plan that is used to create it. - CreatedBy *RecoveryPointCreator - - // The date and time a recovery point is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 - // 12:11:30.087 AM. - CreationDate *time.Time - // The lifecycle defines when a protected resource is transitioned to cold storage // and when it expires. AWS Backup transitions and expires backups automatically // according to the lifecycle that you define. Backups transitioned to cold storage @@ -598,19 +581,30 @@ type RecoveryPointByBackupVault struct { // days” setting. The “transition to cold after days” setting cannot be changed // after a backup has been transitioned to cold. Lifecycle *Lifecycle -} -// Contains detailed information about a saved recovery point. -type RecoveryPointByResource struct { + // An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for + // example, + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + RecoveryPointArn *string + + // An ARN that uniquely identifies a resource. The format of the ARN depends on the + // resource type. + ResourceArn *string + + // The type of AWS resource saved as a recovery point; for example, an Amazon + // Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service + // (Amazon RDS) database. + ResourceType *string // A status code specifying the state of the recovery point. Status RecoveryPointStatus +} - // The date and time a recovery point is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 - // 12:11:30.087 AM. - CreationDate *time.Time +// Contains detailed information about a saved recovery point. +type RecoveryPointByResource struct { + + // The size, in bytes, of a backup. + BackupSizeBytes *int64 // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the @@ -618,6 +612,12 @@ type RecoveryPointByResource struct { // and hyphens. BackupVaultName *string + // The date and time a recovery point is created, in Unix format and Coordinated + // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For + // example, the value 1516925490.087 represents Friday, January 26, 2018 + // 12:11:30.087 AM. + CreationDate *time.Time + // The server-side encryption key that is used to protect your backups; for // example, // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. @@ -628,42 +628,49 @@ type RecoveryPointByResource struct { // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. RecoveryPointArn *string - // The size, in bytes, of a backup. - BackupSizeBytes *int64 + // A status code specifying the state of the recovery point. + Status RecoveryPointStatus } // Contains information about the backup plan and rule that AWS Backup used to // initiate the recovery point backup. type RecoveryPointCreator struct { - // Uniquely identifies a rule used to schedule the backup of a selection of - // resources. - BackupRuleId *string - // An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for // example, // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. BackupPlanArn *string + // Uniquely identifies a backup plan. + BackupPlanId *string + // Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that // are at most 1,024 bytes long. They cannot be edited. BackupPlanVersion *string - // Uniquely identifies a backup plan. - BackupPlanId *string + // Uniquely identifies a rule used to schedule the backup of a selection of + // resources. + BackupRuleId *string } // Contains metadata about a restore job. type RestoreJobsListMember struct { - // Specifies the IAM role ARN used to create the target recovery point; for - // example, arn:aws:iam::123456789012:role/S3Access. - IamRoleArn *string + // The account ID that owns the restore job. + AccountId *string - // The resource type of the listed restore jobs; for example, an Amazon Elastic - // Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon - // RDS) database. - ResourceType *string + // The size, in bytes, of the restored resource. + BackupSizeInBytes *int64 + + // The date and time a job to restore a recovery point is completed, in Unix format + // and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to + // milliseconds. For example, the value 1516925490.087 represents Friday, January + // 26, 2018 12:11:30.087 AM. + CompletionDate *time.Time + + // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of + // the ARN depends on the resource type. + CreatedResourceArn *string // The date and time a restore job is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For @@ -671,41 +678,34 @@ type RestoreJobsListMember struct { // 12:11:30.087 AM. CreationDate *time.Time - // A status code specifying the state of the job initiated by AWS Backup to restore - // a recovery point. - Status RestoreJobStatus + // The amount of time in minutes that a job restoring a recovery point is expected + // to take. + ExpectedCompletionTimeMinutes *int64 - // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of - // the ARN depends on the resource type. - CreatedResourceArn *string + // Specifies the IAM role ARN used to create the target recovery point; for + // example, arn:aws:iam::123456789012:role/S3Access. + IamRoleArn *string - // The date and time a job to restore a recovery point is completed, in Unix format - // and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to - // milliseconds. For example, the value 1516925490.087 represents Friday, January - // 26, 2018 12:11:30.087 AM. - CompletionDate *time.Time + // Contains an estimated percentage complete of a job at the time the job status + // was queried. + PercentDone *string // An ARN that uniquely identifies a recovery point; for example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. RecoveryPointArn *string - // The size, in bytes, of the restored resource. - BackupSizeInBytes *int64 - - // The amount of time in minutes that a job restoring a recovery point is expected - // to take. - ExpectedCompletionTimeMinutes *int64 - - // The account ID that owns the restore job. - AccountId *string + // The resource type of the listed restore jobs; for example, an Amazon Elastic + // Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon + // RDS) database. + ResourceType *string // Uniquely identifies the job that restores a recovery point. RestoreJobId *string + // A status code specifying the state of the job initiated by AWS Backup to restore + // a recovery point. + Status RestoreJobStatus + // A detailed message explaining the status of the job to restore a recovery point. StatusMessage *string - - // Contains an estimated percentage complete of a job at the time the job status - // was queried. - PercentDone *string } diff --git a/service/batch/api_op_CreateComputeEnvironment.go b/service/batch/api_op_CreateComputeEnvironment.go index dc43a27cbb4..015778bb8f5 100644 --- a/service/batch/api_op_CreateComputeEnvironment.go +++ b/service/batch/api_op_CreateComputeEnvironment.go @@ -95,10 +95,11 @@ func (c *Client) CreateComputeEnvironment(ctx context.Context, params *CreateCom type CreateComputeEnvironmentInput struct { - // The state of the compute environment. If the state is ENABLED, then the compute - // environment accepts jobs from a queue and can scale out automatically based on - // queues. - State types.CEState + // The name for your compute environment. Up to 128 letters (uppercase and + // lowercase), numbers, hyphens, and underscores are allowed. + // + // This member is required. + ComputeEnvironmentName *string // The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to // make calls to other AWS services on your behalf. If your specified role has a @@ -113,19 +114,6 @@ type CreateComputeEnvironmentInput struct { // This member is required. ServiceRole *string - // Details of the compute resources managed by the compute environment. This - // parameter is required for managed compute environments. For more information, - // see Compute Environments - // (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) - // in the AWS Batch User Guide. - ComputeResources *types.ComputeResource - - // The name for your compute environment. Up to 128 letters (uppercase and - // lowercase), numbers, hyphens, and underscores are allowed. - // - // This member is required. - ComputeEnvironmentName *string - // The type of the compute environment. For more information, see Compute // Environments // (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) @@ -133,6 +121,18 @@ type CreateComputeEnvironmentInput struct { // // This member is required. Type types.CEType + + // Details of the compute resources managed by the compute environment. This + // parameter is required for managed compute environments. For more information, + // see Compute Environments + // (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) + // in the AWS Batch User Guide. + ComputeResources *types.ComputeResource + + // The state of the compute environment. If the state is ENABLED, then the compute + // environment accepts jobs from a queue and can scale out automatically based on + // queues. + State types.CEState } type CreateComputeEnvironmentOutput struct { diff --git a/service/batch/api_op_CreateJobQueue.go b/service/batch/api_op_CreateJobQueue.go index aada9248f27..b49e376ac3b 100644 --- a/service/batch/api_op_CreateJobQueue.go +++ b/service/batch/api_op_CreateJobQueue.go @@ -63,11 +63,6 @@ func (c *Client) CreateJobQueue(ctx context.Context, params *CreateJobQueueInput type CreateJobQueueInput struct { - // The name of the job queue. - // - // This member is required. - JobQueueName *string - // The set of compute environments mapped to a job queue and their order relative // to each other. The job scheduler uses this parameter to determine which compute // environment should execute a given job. Compute environments must be in the @@ -77,9 +72,10 @@ type CreateJobQueueInput struct { // This member is required. ComputeEnvironmentOrder []*types.ComputeEnvironmentOrder - // The state of the job queue. If the job queue state is ENABLED, it is able to - // accept jobs. - State types.JQState + // The name of the job queue. + // + // This member is required. + JobQueueName *string // The priority of the job queue. Job queues with a higher priority (or a higher // integer value for the priority parameter) are evaluated first when associated @@ -89,19 +85,23 @@ type CreateJobQueueInput struct { // // This member is required. Priority *int32 + + // The state of the job queue. If the job queue state is ENABLED, it is able to + // accept jobs. + State types.JQState } type CreateJobQueueOutput struct { - // The name of the job queue. + // The Amazon Resource Name (ARN) of the job queue. // // This member is required. - JobQueueName *string + JobQueueArn *string - // The Amazon Resource Name (ARN) of the job queue. + // The name of the job queue. // // This member is required. - JobQueueArn *string + JobQueueName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/batch/api_op_DescribeComputeEnvironments.go b/service/batch/api_op_DescribeComputeEnvironments.go index 8941425e36c..403ad9f3ef2 100644 --- a/service/batch/api_op_DescribeComputeEnvironments.go +++ b/service/batch/api_op_DescribeComputeEnvironments.go @@ -63,15 +63,6 @@ type DescribeComputeEnvironmentsInput struct { // entries. ComputeEnvironments []*string - // The nextToken value returned from a previous paginated - // DescribeComputeEnvironments request where maxResults was used and the results - // exceeded the value of that parameter. Pagination continues from the end of the - // previous results that returned the nextToken value. This value is null when - // there are no more results to return. This token should be treated as an opaque - // identifier that is only used to retrieve the next items in a list and not for - // other programmatic purposes. - NextToken *string - // The maximum number of cluster results returned by DescribeComputeEnvironments in // paginated output. When this parameter is used, DescribeComputeEnvironments only // returns maxResults results in a single page along with a nextToken response @@ -81,19 +72,28 @@ type DescribeComputeEnvironmentsInput struct { // DescribeComputeEnvironments returns up to 100 results and a nextToken value if // applicable. MaxResults *int32 + + // The nextToken value returned from a previous paginated + // DescribeComputeEnvironments request where maxResults was used and the results + // exceeded the value of that parameter. Pagination continues from the end of the + // previous results that returned the nextToken value. This value is null when + // there are no more results to return. This token should be treated as an opaque + // identifier that is only used to retrieve the next items in a list and not for + // other programmatic purposes. + NextToken *string } type DescribeComputeEnvironmentsOutput struct { + // The list of compute environments. + ComputeEnvironments []*types.ComputeEnvironmentDetail + // The nextToken value to include in a future DescribeComputeEnvironments request. // When the results of a DescribeJobDefinitions request exceed maxResults, this // value can be used to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string - // The list of compute environments. - ComputeEnvironments []*types.ComputeEnvironmentDetail - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/batch/api_op_DescribeJobDefinitions.go b/service/batch/api_op_DescribeJobDefinitions.go index 7e91d18d1c3..c1b440f9374 100644 --- a/service/batch/api_op_DescribeJobDefinitions.go +++ b/service/batch/api_op_DescribeJobDefinitions.go @@ -57,17 +57,12 @@ func (c *Client) DescribeJobDefinitions(ctx context.Context, params *DescribeJob type DescribeJobDefinitionsInput struct { - // The status with which to filter job definitions. - Status *string + // The name of the job definition to describe. + JobDefinitionName *string - // The nextToken value returned from a previous paginated DescribeJobDefinitions - // request where maxResults was used and the results exceeded the value of that - // parameter. Pagination continues from the end of the previous results that - // returned the nextToken value. This value is null when there are no more results - // to return. This token should be treated as an opaque identifier that is only - // used to retrieve the next items in a list and not for other programmatic - // purposes. - NextToken *string + // A list of up to 100 job definition names or full Amazon Resource Name (ARN) + // entries. + JobDefinitions []*string // The maximum number of results returned by DescribeJobDefinitions in paginated // output. When this parameter is used, DescribeJobDefinitions only returns @@ -78,25 +73,30 @@ type DescribeJobDefinitionsInput struct { // returns up to 100 results and a nextToken value if applicable. MaxResults *int32 - // A list of up to 100 job definition names or full Amazon Resource Name (ARN) - // entries. - JobDefinitions []*string + // The nextToken value returned from a previous paginated DescribeJobDefinitions + // request where maxResults was used and the results exceeded the value of that + // parameter. Pagination continues from the end of the previous results that + // returned the nextToken value. This value is null when there are no more results + // to return. This token should be treated as an opaque identifier that is only + // used to retrieve the next items in a list and not for other programmatic + // purposes. + NextToken *string - // The name of the job definition to describe. - JobDefinitionName *string + // The status with which to filter job definitions. + Status *string } type DescribeJobDefinitionsOutput struct { + // The list of job definitions. + JobDefinitions []*types.JobDefinition + // The nextToken value to include in a future DescribeJobDefinitions request. When // the results of a DescribeJobDefinitions request exceed maxResults, this value // can be used to retrieve the next page of results. This value is null when there // are no more results to return. NextToken *string - // The list of job definitions. - JobDefinitions []*types.JobDefinition - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/batch/api_op_DescribeJobQueues.go b/service/batch/api_op_DescribeJobQueues.go index 27df4b906a7..879236f64ec 100644 --- a/service/batch/api_op_DescribeJobQueues.go +++ b/service/batch/api_op_DescribeJobQueues.go @@ -56,14 +56,6 @@ func (c *Client) DescribeJobQueues(ctx context.Context, params *DescribeJobQueue type DescribeJobQueuesInput struct { - // The nextToken value returned from a previous paginated DescribeJobQueues request - // where maxResults was used and the results exceeded the value of that parameter. - // Pagination continues from the end of the previous results that returned the - // nextToken value. This value is null when there are no more results to return. - // This token should be treated as an opaque identifier that is only used to - // retrieve the next items in a list and not for other programmatic purposes. - NextToken *string - // A list of up to 100 queue names or full queue Amazon Resource Name (ARN) // entries. JobQueues []*string @@ -76,19 +68,27 @@ type DescribeJobQueuesInput struct { // parameter is not used, then DescribeJobQueues returns up to 100 results and a // nextToken value if applicable. MaxResults *int32 + + // The nextToken value returned from a previous paginated DescribeJobQueues request + // where maxResults was used and the results exceeded the value of that parameter. + // Pagination continues from the end of the previous results that returned the + // nextToken value. This value is null when there are no more results to return. + // This token should be treated as an opaque identifier that is only used to + // retrieve the next items in a list and not for other programmatic purposes. + NextToken *string } type DescribeJobQueuesOutput struct { + // The list of job queues. + JobQueues []*types.JobQueueDetail + // The nextToken value to include in a future DescribeJobQueues request. When the // results of a DescribeJobQueues request exceed maxResults, this value can be used // to retrieve the next page of results. This value is null when there are no more // results to return. NextToken *string - // The list of job queues. - JobQueues []*types.JobQueueDetail - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/batch/api_op_ListJobs.go b/service/batch/api_op_ListJobs.go index 54a8a6f3239..f6fb460f6b0 100644 --- a/service/batch/api_op_ListJobs.go +++ b/service/batch/api_op_ListJobs.go @@ -73,10 +73,13 @@ type ListJobsInput struct { // lists all child jobs from within the specified array. ArrayJobId *string - // The job ID for a multi-node parallel job. Specifying a multi-node parallel job - // ID with this parameter lists all nodes that are associated with the specified - // job. - MultiNodeJobId *string + // The name or full Amazon Resource Name (ARN) of the job queue with which to list + // jobs. + JobQueue *string + + // The job status with which to filter jobs in the specified queue. If you do not + // specify a status, only RUNNING jobs are returned. + JobStatus types.JobStatus // The maximum number of results returned by ListJobs in paginated output. When // this parameter is used, ListJobs only returns maxResults results in a single @@ -87,13 +90,10 @@ type ListJobsInput struct { // applicable. MaxResults *int32 - // The job status with which to filter jobs in the specified queue. If you do not - // specify a status, only RUNNING jobs are returned. - JobStatus types.JobStatus - - // The name or full Amazon Resource Name (ARN) of the job queue with which to list - // jobs. - JobQueue *string + // The job ID for a multi-node parallel job. Specifying a multi-node parallel job + // ID with this parameter lists all nodes that are associated with the specified + // job. + MultiNodeJobId *string // The nextToken value returned from a previous paginated ListJobs request where // maxResults was used and the results exceeded the value of that parameter. diff --git a/service/batch/api_op_RegisterJobDefinition.go b/service/batch/api_op_RegisterJobDefinition.go index 2a9eb634543..45da5de438c 100644 --- a/service/batch/api_op_RegisterJobDefinition.go +++ b/service/batch/api_op_RegisterJobDefinition.go @@ -57,6 +57,22 @@ func (c *Client) RegisterJobDefinition(ctx context.Context, params *RegisterJobD type RegisterJobDefinitionInput struct { + // The name of the job definition to register. Up to 128 letters (uppercase and + // lowercase), numbers, hyphens, and underscores are allowed. + // + // This member is required. + JobDefinitionName *string + + // The type of job definition. + // + // This member is required. + Type types.JobDefinitionType + + // An object with various properties specific to single-node container-based jobs. + // If the job definition's type parameter is container, then you must specify + // either containerProperties or nodeProperties. + ContainerProperties *types.ContainerProperties + // An object with various properties specific to multi-node parallel jobs. If you // specify node properties for a job, it becomes a multi-node parallel job. For // more information, see Multi-node Parallel Jobs @@ -65,10 +81,10 @@ type RegisterJobDefinitionInput struct { // container, then you must specify either containerProperties or nodeProperties. NodeProperties *types.NodeProperties - // An object with various properties specific to single-node container-based jobs. - // If the job definition's type parameter is container, then you must specify - // either containerProperties or nodeProperties. - ContainerProperties *types.ContainerProperties + // Default parameter substitution placeholders to set in the job definition. + // Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob + // request override any corresponding parameter defaults from the job definition. + Parameters map[string]*string // The retry strategy to use for failed jobs that are submitted with this job // definition. Any retry strategy that is specified during a SubmitJob () operation @@ -76,22 +92,6 @@ type RegisterJobDefinitionInput struct { // timeout, it is not retried. RetryStrategy *types.RetryStrategy - // The type of job definition. - // - // This member is required. - Type types.JobDefinitionType - - // Default parameter substitution placeholders to set in the job definition. - // Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob - // request override any corresponding parameter defaults from the job definition. - Parameters map[string]*string - - // The name of the job definition to register. Up to 128 letters (uppercase and - // lowercase), numbers, hyphens, and underscores are allowed. - // - // This member is required. - JobDefinitionName *string - // The timeout configuration for jobs that are submitted with this job definition, // after which AWS Batch terminates your jobs if they have not finished. If a job // is terminated due to a timeout, it is not retried. The minimum value for the @@ -105,20 +105,20 @@ type RegisterJobDefinitionInput struct { type RegisterJobDefinitionOutput struct { - // The revision of the job definition. + // The Amazon Resource Name (ARN) of the job definition. // // This member is required. - Revision *int32 + JobDefinitionArn *string // The name of the job definition. // // This member is required. JobDefinitionName *string - // The Amazon Resource Name (ARN) of the job definition. + // The revision of the job definition. // // This member is required. - JobDefinitionArn *string + Revision *int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/batch/api_op_SubmitJob.go b/service/batch/api_op_SubmitJob.go index 77fcbb2a3ae..40ee74715ed 100644 --- a/service/batch/api_op_SubmitJob.go +++ b/service/batch/api_op_SubmitJob.go @@ -58,6 +58,26 @@ func (c *Client) SubmitJob(ctx context.Context, params *SubmitJobInput, optFns . type SubmitJobInput struct { + // The job definition used by this job. This value can be one of name, + // name:revision, or the Amazon Resource Name (ARN) for the job definition. If name + // is specified without a revision then the latest active revision is used. + // + // This member is required. + JobDefinition *string + + // The name of the job. The first character must be alphanumeric, and up to 128 + // letters (uppercase and lowercase), numbers, hyphens, and underscores are + // allowed. + // + // This member is required. + JobName *string + + // The job queue into which the job is submitted. You can specify either the name + // or the Amazon Resource Name (ARN) of the queue. + // + // This member is required. + JobQueue *string + // The array properties for the submitted job, such as the size of the array. The // array size can be between 2 and 10,000. If you specify array properties for a // job, it becomes an array job. For more information, see Array Jobs @@ -65,10 +85,14 @@ type SubmitJobInput struct { // Batch User Guide. ArrayProperties *types.ArrayProperties - // The retry strategy to use for failed jobs from this SubmitJob () operation. When - // a retry strategy is specified here, it overrides the retry strategy defined in - // the job definition. - RetryStrategy *types.RetryStrategy + // A list of container overrides in JSON format that specify the name of a + // container in the specified job definition and the overrides it should receive. + // You can override the default command for a container (that is specified in the + // job definition or the Docker image) with a command override. You can also + // override existing environment variables (that are specified in the job + // definition or Docker image) on a container or add new environment variables to + // it with an environment override. + ContainerOverrides *types.ContainerOverrides // A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. // You can specify a SEQUENTIAL type dependency without specifying a job ID for @@ -78,37 +102,20 @@ type SubmitJobInput struct { // index child of each dependency to complete before it can begin. DependsOn []*types.JobDependency + // A list of node overrides in JSON format that specify the node range to target + // and the container overrides for that node range. + NodeOverrides *types.NodeOverrides + // Additional parameters passed to the job that replace parameter substitution // placeholders that are set in the job definition. Parameters are specified as a // key and value pair mapping. Parameters in a SubmitJob request override any // corresponding parameter defaults from the job definition. Parameters map[string]*string - // A list of container overrides in JSON format that specify the name of a - // container in the specified job definition and the overrides it should receive. - // You can override the default command for a container (that is specified in the - // job definition or the Docker image) with a command override. You can also - // override existing environment variables (that are specified in the job - // definition or Docker image) on a container or add new environment variables to - // it with an environment override. - ContainerOverrides *types.ContainerOverrides - - // A list of node overrides in JSON format that specify the node range to target - // and the container overrides for that node range. - NodeOverrides *types.NodeOverrides - - // The job queue into which the job is submitted. You can specify either the name - // or the Amazon Resource Name (ARN) of the queue. - // - // This member is required. - JobQueue *string - - // The name of the job. The first character must be alphanumeric, and up to 128 - // letters (uppercase and lowercase), numbers, hyphens, and underscores are - // allowed. - // - // This member is required. - JobName *string + // The retry strategy to use for failed jobs from this SubmitJob () operation. When + // a retry strategy is specified here, it overrides the retry strategy defined in + // the job definition. + RetryStrategy *types.RetryStrategy // The timeout configuration for this SubmitJob () operation. You can specify a // timeout duration after which AWS Batch terminates your jobs if they have not @@ -120,13 +127,6 @@ type SubmitJobInput struct { // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html) // in the Amazon Elastic Container Service Developer Guide. Timeout *types.JobTimeout - - // The job definition used by this job. This value can be one of name, - // name:revision, or the Amazon Resource Name (ARN) for the job definition. If name - // is specified without a revision then the latest active revision is used. - // - // This member is required. - JobDefinition *string } type SubmitJobOutput struct { diff --git a/service/batch/api_op_TerminateJob.go b/service/batch/api_op_TerminateJob.go index 73bc77f09fa..0ddb5319096 100644 --- a/service/batch/api_op_TerminateJob.go +++ b/service/batch/api_op_TerminateJob.go @@ -58,17 +58,17 @@ func (c *Client) TerminateJob(ctx context.Context, params *TerminateJobInput, op type TerminateJobInput struct { + // The AWS Batch job ID of the job to terminate. + // + // This member is required. + JobId *string + // A message to attach to the job that explains the reason for canceling it. This // message is returned by future DescribeJobs () operations on the job. This // message is also recorded in the AWS Batch activity logs. // // This member is required. Reason *string - - // The AWS Batch job ID of the job to terminate. - // - // This member is required. - JobId *string } type TerminateJobOutput struct { diff --git a/service/batch/api_op_UpdateComputeEnvironment.go b/service/batch/api_op_UpdateComputeEnvironment.go index c46f2966ad6..d51f7eab666 100644 --- a/service/batch/api_op_UpdateComputeEnvironment.go +++ b/service/batch/api_op_UpdateComputeEnvironment.go @@ -57,16 +57,16 @@ func (c *Client) UpdateComputeEnvironment(ctx context.Context, params *UpdateCom type UpdateComputeEnvironmentInput struct { - // Details of the compute resources managed by the compute environment. Required - // for a managed compute environment. - ComputeResources *types.ComputeResourceUpdate - // The name or full Amazon Resource Name (ARN) of the compute environment to // update. // // This member is required. ComputeEnvironment *string + // Details of the compute resources managed by the compute environment. Required + // for a managed compute environment. + ComputeResources *types.ComputeResourceUpdate + // The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to // make calls to other AWS services on your behalf. If your specified role has a // path other than /, then you must either specify the full role ARN (this is @@ -86,12 +86,12 @@ type UpdateComputeEnvironmentInput struct { type UpdateComputeEnvironmentOutput struct { - // The name of the compute environment. - ComputeEnvironmentName *string - // The Amazon Resource Name (ARN) of the compute environment. ComputeEnvironmentArn *string + // The name of the compute environment. + ComputeEnvironmentName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/batch/api_op_UpdateJobQueue.go b/service/batch/api_op_UpdateJobQueue.go index 4f3c43d9aec..0c12a84466b 100644 --- a/service/batch/api_op_UpdateJobQueue.go +++ b/service/batch/api_op_UpdateJobQueue.go @@ -57,6 +57,11 @@ func (c *Client) UpdateJobQueue(ctx context.Context, params *UpdateJobQueueInput type UpdateJobQueueInput struct { + // The name or the Amazon Resource Name (ARN) of the job queue. + // + // This member is required. + JobQueue *string + // Details the set of compute environments mapped to a job queue and their order // relative to each other. This is one of the parameters used by the job scheduler // to determine which compute environment should execute a given job. @@ -69,11 +74,6 @@ type UpdateJobQueueInput struct { // preference over a job queue with a priority value of 1. Priority *int32 - // The name or the Amazon Resource Name (ARN) of the job queue. - // - // This member is required. - JobQueue *string - // Describes the queue's ability to accept new jobs. State types.JQState } diff --git a/service/batch/go.mod b/service/batch/go.mod index 4c33e0f4515..5be7a0164a7 100644 --- a/service/batch/go.mod +++ b/service/batch/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/batch go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/batch/types/types.go b/service/batch/types/types.go index 43a3388e71a..c0227aff4ec 100644 --- a/service/batch/types/types.go +++ b/service/batch/types/types.go @@ -16,12 +16,12 @@ type ArrayPropertiesDetail struct { // is returned for array job children. Index *int32 + // The size of the array job. This parameter is returned for parent array jobs. + Size *int32 + // A summary of the number of array job children in each available job status. This // parameter is returned for parent array jobs. StatusSummary map[string]*int32 - - // The size of the array job. This parameter is returned for parent array jobs. - Size *int32 } // An object representing the array properties of a job. @@ -42,30 +42,33 @@ type AttemptContainerDetail struct { // the job attempt. ContainerInstanceArn *string - // The network interfaces associated with the job attempt. - NetworkInterfaces []*NetworkInterface - // The exit code for the job attempt. A non-zero exit code is considered a failure. ExitCode *int32 - // The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with - // the job attempt. Each container attempt receives a task ARN when they reach the - // STARTING status. - TaskArn *string + // The name of the CloudWatch Logs log stream associated with the container. The + // log group for AWS Batch jobs is /aws/batch/job. Each container attempt receives + // a log stream name when they reach the RUNNING status. + LogStreamName *string + + // The network interfaces associated with the job attempt. + NetworkInterfaces []*NetworkInterface // A short (255 max characters) human-readable string to provide additional details // about a running or stopped container. Reason *string - // The name of the CloudWatch Logs log stream associated with the container. The - // log group for AWS Batch jobs is /aws/batch/job. Each container attempt receives - // a log stream name when they reach the RUNNING status. - LogStreamName *string + // The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with + // the job attempt. Each container attempt receives a task ARN when they reach the + // STARTING status. + TaskArn *string } // An object representing a job attempt. type AttemptDetail struct { + // Details about the container in this job attempt. + Container *AttemptContainerDetail + // The Unix timestamp (in seconds and milliseconds) for when the attempt was // started (when the attempt transitioned from the STARTING state to the RUNNING // state). @@ -75,9 +78,6 @@ type AttemptDetail struct { // status of the job attempt. StatusReason *string - // Details about the container in this job attempt. - Container *AttemptContainerDetail - // The Unix timestamp (in seconds and milliseconds) for when the attempt was // stopped (when the attempt transitioned from the RUNNING state to a terminal // state, such as SUCCEEDED or FAILED). @@ -87,6 +87,29 @@ type AttemptDetail struct { // An object representing an AWS Batch compute environment. type ComputeEnvironmentDetail struct { + // The Amazon Resource Name (ARN) of the compute environment. + // + // This member is required. + ComputeEnvironmentArn *string + + // The name of the compute environment. + // + // This member is required. + ComputeEnvironmentName *string + + // The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the + // compute environment. + // + // This member is required. + EcsClusterArn *string + + // The compute resources defined for the compute environment. + ComputeResources *ComputeResource + + // The service role associated with the compute environment that allows AWS Batch + // to make calls to AWS API operations on your behalf. + ServiceRole *string + // The state of the compute environment. The valid values are ENABLED or DISABLED. // If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs // from an associated job queue on the compute resources within the environment. If @@ -98,38 +121,15 @@ type ComputeEnvironmentDetail struct { // minvCpus value after instances become idle. State CEState - // The compute resources defined for the compute environment. - ComputeResources *ComputeResource - - // The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the - // compute environment. - // - // This member is required. - EcsClusterArn *string - - // The type of the compute environment. - Type CEType - // The current status of the compute environment (for example, CREATING or VALID). Status CEStatus - // The name of the compute environment. - // - // This member is required. - ComputeEnvironmentName *string - - // The service role associated with the compute environment that allows AWS Batch - // to make calls to AWS API operations on your behalf. - ServiceRole *string - // A short, human-readable string to provide additional details about the current // status of the compute environment. StatusReason *string - // The Amazon Resource Name (ARN) of the compute environment. - // - // This member is required. - ComputeEnvironmentArn *string + // The type of the compute environment. + Type CEType } // The order in which compute environments are tried for job placement within a @@ -138,42 +138,30 @@ type ComputeEnvironmentDetail struct { // with a lower order integer value is tried for job placement first. type ComputeEnvironmentOrder struct { - // The order of the compute environment. + // The Amazon Resource Name (ARN) of the compute environment. // // This member is required. - Order *int32 + ComputeEnvironment *string - // The Amazon Resource Name (ARN) of the compute environment. + // The order of the compute environment. // // This member is required. - ComputeEnvironment *string + Order *int32 } // An object representing an AWS Batch compute resource. type ComputeResource struct { - // The Amazon EC2 security groups associated with instances launched in the compute - // environment. One or more security groups must be specified, either in - // securityGroupIds or using a launch template referenced in launchTemplate. If - // security groups are specified using both securityGroupIds and launchTemplate, - // the values in securityGroupIds will be used. - SecurityGroupIds []*string - - // The VPC subnets into which the compute resources are launched. For more - // information, see VPCs and Subnets - // (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) in the - // Amazon VPC User Guide. + // The Amazon ECS instance profile applied to Amazon EC2 instances in a compute + // environment. You can specify the short name or full Amazon Resource Name (ARN) + // of an instance profile. For example, ecsInstanceRole or + // arn:aws:iam:::instance-profile/ecsInstanceRole . For more information, see + // Amazon ECS Instance Role + // (https://docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html) in + // the AWS Batch User Guide. // // This member is required. - Subnets []*string - - // The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to - // a SPOT compute environment. This role is required if the allocation strategy set - // to BEST_FIT or if the allocation strategy is not specified. For more - // information, see Amazon EC2 Spot Fleet Role - // (https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html) in - // the AWS Batch User Guide. - SpotIamFleetRole *string + InstanceRole *string // The instances types that may be launched. You can specify instance families to // launch any instance type within those families (for example, c5 or p3), or you @@ -184,52 +172,30 @@ type ComputeResource struct { // This member is required. InstanceTypes []*string - // The desired number of Amazon EC2 vCPUS in the compute environment. - DesiredvCpus *int32 - - // The launch template to use for your compute resources. Any other compute - // resource parameters that you specify in a CreateComputeEnvironment () API - // operation override the same parameters in the launch template. You must specify - // either the launch template ID or launch template name in the request, but not - // both. For more information, see Launch Template Support - // (https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) in - // the AWS Batch User Guide. - LaunchTemplate *LaunchTemplateSpecification - // The maximum number of Amazon EC2 vCPUs that an environment can reach. // // This member is required. MaxvCpus *int32 - // The Amazon EC2 key pair that is used for instances launched in the compute - // environment. - Ec2KeyPair *string - - // The Amazon Machine Image (AMI) ID used for instances launched in the compute - // environment. - ImageId *string + // The minimum number of Amazon EC2 vCPUs that an environment should maintain (even + // if the compute environment is DISABLED). + // + // This member is required. + MinvCpus *int32 - // The Amazon EC2 placement group to associate with your compute resources. If you - // intend to submit multi-node parallel jobs to your compute environment, you - // should consider creating a cluster placement group and associate it with your - // compute resources. This keeps your multi-node parallel job on a logical grouping - // of instances within a single Availability Zone with high network flow potential. - // For more information, see Placement Groups - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in - // the Amazon EC2 User Guide for Linux Instances. - PlacementGroup *string + // The VPC subnets into which the compute resources are launched. For more + // information, see VPCs and Subnets + // (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) in the + // Amazon VPC User Guide. + // + // This member is required. + Subnets []*string // The type of compute environment: EC2 or SPOT. // // This member is required. Type CRType - // Key-value pair tags to be applied to resources that are launched in the compute - // environment. For AWS Batch, these take the form of "String1": "String2", where - // String1 is the tag key and String2 is the tag value—for example, { "Name": "AWS - // Batch Instance - C4OnDemand" }. - Tags map[string]*string - // The allocation strategy to use for the compute resource in case not enough // instances of the best fitting instance type can be allocated. This could be due // to availability of the instance type in the region or Amazon EC2 service limits @@ -249,12 +215,6 @@ type ComputeResource struct { // in the AWS Batch User Guide. AllocationStrategy CRAllocationStrategy - // The minimum number of Amazon EC2 vCPUs that an environment should maintain (even - // if the compute environment is DISABLED). - // - // This member is required. - MinvCpus *int32 - // The maximum percentage that a Spot Instance price can be when compared with the // On-Demand price for that instance type before instances are launched. For // example, if your maximum percentage is 20%, then the Spot price must be below @@ -263,107 +223,147 @@ type ComputeResource struct { // leave this field empty, the default value is 100% of the On-Demand price. BidPercentage *int32 - // The Amazon ECS instance profile applied to Amazon EC2 instances in a compute - // environment. You can specify the short name or full Amazon Resource Name (ARN) - // of an instance profile. For example, ecsInstanceRole or - // arn:aws:iam:::instance-profile/ecsInstanceRole . For more information, see - // Amazon ECS Instance Role - // (https://docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html) in + // The desired number of Amazon EC2 vCPUS in the compute environment. + DesiredvCpus *int32 + + // The Amazon EC2 key pair that is used for instances launched in the compute + // environment. + Ec2KeyPair *string + + // The Amazon Machine Image (AMI) ID used for instances launched in the compute + // environment. + ImageId *string + + // The launch template to use for your compute resources. Any other compute + // resource parameters that you specify in a CreateComputeEnvironment () API + // operation override the same parameters in the launch template. You must specify + // either the launch template ID or launch template name in the request, but not + // both. For more information, see Launch Template Support + // (https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) in // the AWS Batch User Guide. - // - // This member is required. - InstanceRole *string + LaunchTemplate *LaunchTemplateSpecification + + // The Amazon EC2 placement group to associate with your compute resources. If you + // intend to submit multi-node parallel jobs to your compute environment, you + // should consider creating a cluster placement group and associate it with your + // compute resources. This keeps your multi-node parallel job on a logical grouping + // of instances within a single Availability Zone with high network flow potential. + // For more information, see Placement Groups + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in + // the Amazon EC2 User Guide for Linux Instances. + PlacementGroup *string + + // The Amazon EC2 security groups associated with instances launched in the compute + // environment. One or more security groups must be specified, either in + // securityGroupIds or using a launch template referenced in launchTemplate. If + // security groups are specified using both securityGroupIds and launchTemplate, + // the values in securityGroupIds will be used. + SecurityGroupIds []*string + + // The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to + // a SPOT compute environment. This role is required if the allocation strategy set + // to BEST_FIT or if the allocation strategy is not specified. For more + // information, see Amazon EC2 Spot Fleet Role + // (https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html) in + // the AWS Batch User Guide. + SpotIamFleetRole *string + + // Key-value pair tags to be applied to resources that are launched in the compute + // environment. For AWS Batch, these take the form of "String1": "String2", where + // String1 is the tag key and String2 is the tag value—for example, { "Name": "AWS + // Batch Instance - C4OnDemand" }. + Tags map[string]*string } // An object representing the attributes of a compute environment that can be // updated. type ComputeResourceUpdate struct { + // The desired number of Amazon EC2 vCPUS in the compute environment. + DesiredvCpus *int32 + // The maximum number of Amazon EC2 vCPUs that an environment can reach. MaxvCpus *int32 // The minimum number of Amazon EC2 vCPUs that an environment should maintain. MinvCpus *int32 - - // The desired number of Amazon EC2 vCPUS in the compute environment. - DesiredvCpus *int32 } // An object representing the details of a container that is part of a job. type ContainerDetail struct { - // The Amazon Resource Name (ARN) associated with the job upon execution. - JobRoleArn *string + // The command that is passed to the container. + Command []*string + + // The Amazon Resource Name (ARN) of the container instance on which the container + // is running. + ContainerInstanceArn *string + + // The environment variables to pass to a container. Environment variables must not + // start with AWS_BATCH; this naming convention is reserved for variables that are + // set by the AWS Batch service. + Environment []*KeyValuePair // The exit code to return upon completion. ExitCode *int32 - // The mount points for data volumes in your container. - MountPoints []*MountPoint + // The image used to start the container. + Image *string - // The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with - // the container job. Each container attempt receives a task ARN when they reach - // the STARTING status. - TaskArn *string + // The instance type of the underlying host infrastructure of a multi-node parallel + // job. + InstanceType *string - // The user name to use inside the container. - User *string + // The Amazon Resource Name (ARN) associated with the job upon execution. + JobRoleArn *string // Linux-specific modifications that are applied to the container, such as details // for device mappings. LinuxParameters *LinuxParameters + // The name of the CloudWatch Logs log stream associated with the container. The + // log group for AWS Batch jobs is /aws/batch/job. Each container attempt receives + // a log stream name when they reach the RUNNING status. + LogStreamName *string + // The number of MiB of memory reserved for the job. Memory *int32 - // The image used to start the container. - Image *string + // The mount points for data volumes in your container. + MountPoints []*MountPoint - // The environment variables to pass to a container. Environment variables must not - // start with AWS_BATCH; this naming convention is reserved for variables that are - // set by the AWS Batch service. - Environment []*KeyValuePair + // The network interfaces associated with the job. + NetworkInterfaces []*NetworkInterface // When this parameter is true, the container is given elevated privileges on the // host container instance (similar to the root user). Privileged *bool - // The name of the CloudWatch Logs log stream associated with the container. The - // log group for AWS Batch jobs is /aws/batch/job. Each container attempt receives - // a log stream name when they reach the RUNNING status. - LogStreamName *string - - // The instance type of the underlying host infrastructure of a multi-node parallel - // job. - InstanceType *string - - // The Amazon Resource Name (ARN) of the container instance on which the container - // is running. - ContainerInstanceArn *string - - // The command that is passed to the container. - Command []*string + // When this parameter is true, the container is given read-only access to its root + // file system. + ReadonlyRootFilesystem *bool - // The network interfaces associated with the job. - NetworkInterfaces []*NetworkInterface + // A short (255 max characters) human-readable string to provide additional details + // about a running or stopped container. + Reason *string // The type and amount of a resource to assign to a container. Currently, the only // supported resource is GPU. ResourceRequirements []*ResourceRequirement - // The number of VCPUs allocated for the job. - Vcpus *int32 + // The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with + // the container job. Each container attempt receives a task ARN when they reach + // the STARTING status. + TaskArn *string // A list of ulimit values to set in the container. Ulimits []*Ulimit - // A short (255 max characters) human-readable string to provide additional details - // about a running or stopped container. - Reason *string + // The user name to use inside the container. + User *string - // When this parameter is true, the container is given read-only access to its root - // file system. - ReadonlyRootFilesystem *bool + // The number of VCPUs allocated for the job. + Vcpus *int32 // A list of volumes associated with the job. Volumes []*Volume @@ -376,74 +376,54 @@ type ContainerOverrides struct { // Docker image or the job definition. Command []*string + // The environment variables to send to the container. You can add new environment + // variables, which are added to the container at launch, or you can override the + // existing environment variables from the Docker image or the job definition. + // Environment variables must not start with AWS_BATCH; this naming convention is + // reserved for variables that are set by the AWS Batch service. + Environment []*KeyValuePair + // The instance type to use for a multi-node parallel job. This parameter is not // valid for single-node container jobs. InstanceType *string - // The number of vCPUs to reserve for the container. This value overrides the value + // The number of MiB of memory reserved for the job. This value overrides the value // set in the job definition. - Vcpus *int32 + Memory *int32 // The type and amount of a resource to assign to a container. This value overrides // the value set in the job definition. Currently, the only supported resource is // GPU. ResourceRequirements []*ResourceRequirement - // The environment variables to send to the container. You can add new environment - // variables, which are added to the container at launch, or you can override the - // existing environment variables from the Docker image or the job definition. - // Environment variables must not start with AWS_BATCH; this naming convention is - // reserved for variables that are set by the AWS Batch service. - Environment []*KeyValuePair - - // The number of MiB of memory reserved for the job. This value overrides the value + // The number of vCPUs to reserve for the container. This value overrides the value // set in the job definition. - Memory *int32 + Vcpus *int32 } // Container properties are used in job definitions to describe the container that // is launched as part of a job. type ContainerProperties struct { - // The Amazon Resource Name (ARN) of the IAM role that the container can assume for - // AWS permissions. - JobRoleArn *string - - // Linux-specific modifications that are applied to the container, such as details - // for device mappings. - LinuxParameters *LinuxParameters - - // The number of vCPUs reserved for the container. This parameter maps to CpuShares - // in the Create a container - // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the - // --cpu-shares option to docker run - // (https://docs.docker.com/engine/reference/run/). Each vCPU is equivalent to - // 1,024 CPU shares. You must specify at least one vCPU. - Vcpus *int32 - - // The user name to use inside the container. This parameter maps to User in the + // The command that is passed to the container. This parameter maps to Cmd in the // Create a container // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the --user - // option to docker run (https://docs.docker.com/engine/reference/run/). - User *string - - // The mount points for data volumes in your container. This parameter maps to - // Volumes in the Create a container - // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the --volume - // option to docker run (https://docs.docker.com/engine/reference/run/). - MountPoints []*MountPoint + // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the COMMAND + // parameter to docker run (https://docs.docker.com/engine/reference/run/). For + // more information, see https://docs.docker.com/engine/reference/builder/#cmd + // (https://docs.docker.com/engine/reference/builder/#cmd). + Command []*string - // When this parameter is true, the container is given elevated privileges on the - // host container instance (similar to the root user). This parameter maps to - // Privileged in the Create a container + // The environment variables to pass to a container. This parameter maps to Env in + // the Create a container // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the - // --privileged option to docker run - // (https://docs.docker.com/engine/reference/run/). - Privileged *bool + // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the --env + // option to docker run (https://docs.docker.com/engine/reference/run/). We do not + // recommend using plaintext environment variables for sensitive information, such + // as credential data. Environment variables must not start with AWS_BATCH; this + // naming convention is reserved for variables that are set by the AWS Batch + // service. + Environment []*KeyValuePair // The image used to start a container. This string is passed directly to the // Docker daemon. Images in the Docker Hub registry are available by default. Other @@ -471,40 +451,47 @@ type ContainerProperties struct { // quay.io/assemblyline/ubuntu). Image *string - // The environment variables to pass to a container. This parameter maps to Env in - // the Create a container - // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the --env - // option to docker run (https://docs.docker.com/engine/reference/run/). We do not - // recommend using plaintext environment variables for sensitive information, such - // as credential data. Environment variables must not start with AWS_BATCH; this - // naming convention is reserved for variables that are set by the AWS Batch - // service. - Environment []*KeyValuePair - // The instance type to use for a multi-node parallel job. Currently all node // groups in a multi-node parallel job must use the same instance type. This // parameter is not valid for single-node container jobs. InstanceType *string - // A list of data volumes used in a job. - Volumes []*Volume + // The Amazon Resource Name (ARN) of the IAM role that the container can assume for + // AWS permissions. + JobRoleArn *string - // The command that is passed to the container. This parameter maps to Cmd in the - // Create a container + // Linux-specific modifications that are applied to the container, such as details + // for device mappings. + LinuxParameters *LinuxParameters + + // The hard limit (in MiB) of memory to present to the container. If your container + // attempts to exceed the memory specified here, the container is killed. This + // parameter maps to Memory in the Create a container // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the COMMAND - // parameter to docker run (https://docs.docker.com/engine/reference/run/). For - // more information, see https://docs.docker.com/engine/reference/builder/#cmd - // (https://docs.docker.com/engine/reference/builder/#cmd). - Command []*string + // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the --memory + // option to docker run (https://docs.docker.com/engine/reference/run/). You must + // specify at least 4 MiB of memory for a job. If you are trying to maximize your + // resource utilization by providing your jobs as much memory as possible for a + // particular instance type, see Memory Management + // (https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) in + // the AWS Batch User Guide. + Memory *int32 - // A list of ulimits to set in the container. This parameter maps to Ulimits in the - // Create a container + // The mount points for data volumes in your container. This parameter maps to + // Volumes in the Create a container // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the --ulimit + // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the --volume // option to docker run (https://docs.docker.com/engine/reference/run/). - Ulimits []*Ulimit + MountPoints []*MountPoint + + // When this parameter is true, the container is given elevated privileges on the + // host container instance (similar to the root user). This parameter maps to + // Privileged in the Create a container + // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the + // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the + // --privileged option to docker run + // (https://docs.docker.com/engine/reference/run/). + Privileged *bool // When this parameter is true, the container is given read-only access to its root // file system. This parameter maps to ReadonlyRootfs in the Create a container @@ -517,18 +504,31 @@ type ContainerProperties struct { // supported resource is GPU. ResourceRequirements []*ResourceRequirement - // The hard limit (in MiB) of memory to present to the container. If your container - // attempts to exceed the memory specified here, the container is killed. This - // parameter maps to Memory in the Create a container + // A list of ulimits to set in the container. This parameter maps to Ulimits in the + // Create a container // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the --memory - // option to docker run (https://docs.docker.com/engine/reference/run/). You must - // specify at least 4 MiB of memory for a job. If you are trying to maximize your - // resource utilization by providing your jobs as much memory as possible for a - // particular instance type, see Memory Management - // (https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) in - // the AWS Batch User Guide. - Memory *int32 + // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the --ulimit + // option to docker run (https://docs.docker.com/engine/reference/run/). + Ulimits []*Ulimit + + // The user name to use inside the container. This parameter maps to User in the + // Create a container + // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the + // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the --user + // option to docker run (https://docs.docker.com/engine/reference/run/). + User *string + + // The number of vCPUs reserved for the container. This parameter maps to CpuShares + // in the Create a container + // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the + // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the + // --cpu-shares option to docker run + // (https://docs.docker.com/engine/reference/run/). Each vCPU is equivalent to + // 1,024 CPU shares. You must specify at least one vCPU. + Vcpus *int32 + + // A list of data volumes used in a job. + Volumes []*Volume } // An object representing summary details of a container within a job. @@ -550,13 +550,13 @@ type Device struct { // This member is required. HostPath *string - // The explicit permissions to provide to the container for the device. By default, - // the container has permissions for read, write, and mknod for the device. - Permissions []DeviceCgroupPermission - // The path inside the container at which to expose the host device. By default the // hostPath value is used. ContainerPath *string + + // The explicit permissions to provide to the container for the device. By default, + // the container has permissions for read, write, and mknod for the device. + Permissions []DeviceCgroupPermission } // Determine whether your data volume persists on the host container instance and @@ -578,32 +578,31 @@ type Host struct { // An object representing an AWS Batch job definition. type JobDefinition struct { - // An object with various properties specific to multi-node parallel jobs. - NodeProperties *NodeProperties - - // The timeout configuration for jobs that are submitted with this job definition. - // You can specify a timeout duration after which AWS Batch terminates your jobs if - // they have not finished. - Timeout *JobTimeout - - // The retry strategy to use for failed jobs that are submitted with this job - // definition. - RetryStrategy *RetryStrategy - + // The Amazon Resource Name (ARN) for the job definition. + // + // This member is required. + JobDefinitionArn *string + // The name of the job definition. // // This member is required. JobDefinitionName *string - // The type of job definition. + // The revision of the job definition. // // This member is required. - Type *string + Revision *int32 - // The Amazon Resource Name (ARN) for the job definition. + // The type of job definition. // // This member is required. - JobDefinitionArn *string + Type *string + + // An object with various properties specific to container-based jobs. + ContainerProperties *ContainerProperties + + // An object with various properties specific to multi-node parallel jobs. + NodeProperties *NodeProperties // Default parameters or parameter substitution placeholders that are set in the // job definition. Parameters are specified as a key-value pair mapping. Parameters @@ -614,44 +613,58 @@ type JobDefinition struct { // in the AWS Batch User Guide. Parameters map[string]*string + // The retry strategy to use for failed jobs that are submitted with this job + // definition. + RetryStrategy *RetryStrategy + // The status of the job definition. Status *string - // An object with various properties specific to container-based jobs. - ContainerProperties *ContainerProperties - - // The revision of the job definition. - // - // This member is required. - Revision *int32 + // The timeout configuration for jobs that are submitted with this job definition. + // You can specify a timeout duration after which AWS Batch terminates your jobs if + // they have not finished. + Timeout *JobTimeout } // An object representing an AWS Batch job dependency. type JobDependency struct { - // The type of the job dependency. - Type ArrayJobDependency - // The job ID of the AWS Batch job associated with this dependency. JobId *string + + // The type of the job dependency. + Type ArrayJobDependency } // An object representing an AWS Batch job. type JobDetail struct { + // The job definition that is used by this job. + // + // This member is required. + JobDefinition *string + + // The ID for the job. + // + // This member is required. + JobId *string + // The name of the job. // // This member is required. JobName *string - // An object representing the details of a node that is associated with a - // multi-node parallel job. - NodeDetails *NodeDetails + // The Amazon Resource Name (ARN) of the job queue with which the job is + // associated. + // + // This member is required. + JobQueue *string - // The job definition that is used by this job. + // The Unix timestamp (in seconds and milliseconds) for when the job was started + // (when the job transitioned from the STARTING state to the RUNNING state). // // This member is required. - JobDefinition *string + StartedAt *int64 // The current status for the job. If your jobs do not progress to STARTING, see // Jobs Stuck in RUNNABLE Status @@ -664,14 +677,13 @@ type JobDetail struct { // The array properties of the job, if it is an array job. ArrayProperties *ArrayPropertiesDetail + // A list of job attempts associated with this job. + Attempts []*AttemptDetail + // An object representing the details of the container that is associated with the // job. Container *ContainerDetail - // A short, human-readable string to provide additional details about the current - // status of the job. - StatusReason *string - // The Unix timestamp (in seconds and milliseconds) for when the job was created. // For non-array jobs and parent array jobs, this is when the job entered the // SUBMITTED state (at the time SubmitJob () was called). For array child jobs, @@ -679,68 +691,46 @@ type JobDetail struct { // state. CreatedAt *int64 - // The timeout configuration for the job. - Timeout *JobTimeout - - // The retry strategy to use for this job if an attempt fails. - RetryStrategy *RetryStrategy - - // A list of job attempts associated with this job. - Attempts []*AttemptDetail + // A list of job IDs on which this job depends. + DependsOn []*JobDependency - // The Unix timestamp (in seconds and milliseconds) for when the job was started - // (when the job transitioned from the STARTING state to the RUNNING state). - // - // This member is required. - StartedAt *int64 + // An object representing the details of a node that is associated with a + // multi-node parallel job. + NodeDetails *NodeDetails - // The ID for the job. - // - // This member is required. - JobId *string + // An object representing the node properties of a multi-node parallel job. + NodeProperties *NodeProperties // Additional parameters passed to the job that replace parameter substitution // placeholders or override any corresponding parameter defaults from the job // definition. Parameters map[string]*string + // The retry strategy to use for this job if an attempt fails. + RetryStrategy *RetryStrategy + + // A short, human-readable string to provide additional details about the current + // status of the job. + StatusReason *string + // The Unix timestamp (in seconds and milliseconds) for when the job was stopped // (when the job transitioned from the RUNNING state to a terminal state, such as // SUCCEEDED or FAILED). StoppedAt *int64 - // An object representing the node properties of a multi-node parallel job. - NodeProperties *NodeProperties - - // The Amazon Resource Name (ARN) of the job queue with which the job is - // associated. - // - // This member is required. - JobQueue *string - - // A list of job IDs on which this job depends. - DependsOn []*JobDependency + // The timeout configuration for the job. + Timeout *JobTimeout } // An object representing the details of an AWS Batch job queue. type JobQueueDetail struct { - // Describes the ability of the queue to accept new jobs. - // - // This member is required. - State JQState - - // The priority of the job queue. + // The compute environments that are attached to the job queue and the order in + // which job placement is preferred. Compute environments are selected for job + // placement in ascending order. // // This member is required. - Priority *int32 - - // The status of the job queue (for example, CREATING or VALID). - Status JQStatus - - // A short, human-readable string to provide additional details about the current - // status of the job queue. - StatusReason *string + ComputeEnvironmentOrder []*ComputeEnvironmentOrder // The Amazon Resource Name (ARN) of the job queue. // @@ -752,36 +742,26 @@ type JobQueueDetail struct { // This member is required. JobQueueName *string - // The compute environments that are attached to the job queue and the order in - // which job placement is preferred. Compute environments are selected for job - // placement in ascending order. + // The priority of the job queue. // // This member is required. - ComputeEnvironmentOrder []*ComputeEnvironmentOrder -} - -// An object representing summary details of a job. -type JobSummary struct { + Priority *int32 - // The current status for the job. - Status JobStatus + // Describes the ability of the queue to accept new jobs. + // + // This member is required. + State JQState - // The Unix timestamp for when the job was created. For non-array jobs and parent - // array jobs, this is when the job entered the SUBMITTED state (at the time - // SubmitJob () was called). For array child jobs, this is when the child job was - // spawned by its parent and entered the PENDING state. - CreatedAt *int64 + // The status of the job queue (for example, CREATING or VALID). + Status JQStatus // A short, human-readable string to provide additional details about the current - // status of the job. + // status of the job queue. StatusReason *string +} - // The node properties for a single node in a job summary list. - NodeProperties *NodePropertiesSummary - - // The Unix timestamp for when the job was started (when the job transitioned from - // the STARTING state to the RUNNING state). - StartedAt *int64 +// An object representing summary details of a job. +type JobSummary struct { // The ID of the job. // @@ -800,6 +780,26 @@ type JobSummary struct { // job. Container *ContainerSummary + // The Unix timestamp for when the job was created. For non-array jobs and parent + // array jobs, this is when the job entered the SUBMITTED state (at the time + // SubmitJob () was called). For array child jobs, this is when the child job was + // spawned by its parent and entered the PENDING state. + CreatedAt *int64 + + // The node properties for a single node in a job summary list. + NodeProperties *NodePropertiesSummary + + // The Unix timestamp for when the job was started (when the job transitioned from + // the STARTING state to the RUNNING state). + StartedAt *int64 + + // The current status for the job. + Status JobStatus + + // A short, human-readable string to provide additional details about the current + // status of the job. + StatusReason *string + // The Unix timestamp for when the job was stopped (when the job transitioned from // the RUNNING state to a terminal state, such as SUCCEEDED or FAILED). StoppedAt *int64 @@ -816,13 +816,13 @@ type JobTimeout struct { // A key-value pair object. type KeyValuePair struct { - // The value of the key-value pair. For environment variables, this is the value of - // the environment variable. - Value *string - // The name of the key-value pair. For environment variables, this is the name of // the environment variable. Name *string + + // The value of the key-value pair. For environment variables, this is the value of + // the environment variable. + Value *string } // An object representing a launch template associated with a compute resource. You @@ -833,12 +833,12 @@ type LaunchTemplateSpecification struct { // The ID of the launch template. LaunchTemplateId *string + // The name of the launch template. + LaunchTemplateName *string + // The version number of the launch template. Default: The default version of the // launch template. Version *string - - // The name of the launch template. - LaunchTemplateName *string } // Linux-specific modifications that are applied to the container, such as details @@ -859,13 +859,13 @@ type LinuxParameters struct { // section of the Docker Remote API and the --volume option to docker run. type MountPoint struct { + // The path on the container at which to mount the host volume. + ContainerPath *string + // If this value is true, the container has read-only access to the volume; // otherwise, the container can write to the volume. The default value is false. ReadOnly *bool - // The path on the container at which to mount the host volume. - ContainerPath *string - // The name of the volume to mount. SourceVolume *string } @@ -874,12 +874,12 @@ type MountPoint struct { // job node. type NetworkInterface struct { - // The private IPv6 address for the network interface. - Ipv6Address *string - // The attachment ID for the network interface. AttachmentId *string + // The private IPv6 address for the network interface. + Ipv6Address *string + // The private IPv4 address for the network interface. PrivateIpv4Address *string } @@ -901,6 +901,9 @@ type NodeDetails struct { // SubmitJob () API operation. type NodeOverrides struct { + // The node property overrides for the job. + NodePropertyOverrides []*NodePropertyOverride + // The number of nodes to use with a multi-node parallel job. This value overrides // the number of nodes that are specified in the job definition. To use this // override: @@ -915,26 +918,23 @@ type NodeOverrides struct { // * The main node index specified in the job // definition must be fewer than the number of nodes specified in the override. NumNodes *int32 - - // The node property overrides for the job. - NodePropertyOverrides []*NodePropertyOverride } // An object representing the node properties of a multi-node parallel job. type NodeProperties struct { - // A list of node ranges and their properties associated with a multi-node parallel - // job. - // - // This member is required. - NodeRangeProperties []*NodeRangeProperty - // Specifies the node index for the main node of a multi-node parallel job. This // node index value must be fewer than the number of nodes. // // This member is required. MainNode *int32 + // A list of node ranges and their properties associated with a multi-node parallel + // job. + // + // This member is required. + NodeRangeProperties []*NodeRangeProperty + // The number of nodes associated with a multi-node parallel job. // // This member is required. @@ -979,9 +979,6 @@ type NodePropertyOverride struct { // parallel job. type NodeRangeProperty struct { - // The container details for the node range. - Container *ContainerProperties - // The range of nodes, using node index values. A range of 0:3 indicates nodes with // index values of 0 through 3. If the starting range value is omitted (:n), then 0 // is used to start the range. If the ending range value is omitted (n:), then the @@ -992,24 +989,27 @@ type NodeRangeProperty struct { // // This member is required. TargetNodes *string + + // The container details for the node range. + Container *ContainerProperties } // The type and amount of a resource to assign to a container. Currently, the only // supported resource type is GPU. type ResourceRequirement struct { + // The type of resource to assign to a container. Currently, the only supported + // resource type is GPU. + // + // This member is required. + Type ResourceType + // The number of physical GPUs to reserve for the container. The number of GPUs // reserved for all containers in a job should not exceed the number of available // GPUs on the compute resource that the job is launched on. // // This member is required. Value *string - - // The type of resource to assign to a container. Currently, the only supported - // resource type is GPU. - // - // This member is required. - Type ResourceType } // The retry strategy associated with a job. @@ -1029,15 +1029,15 @@ type Ulimit struct { // This member is required. HardLimit *int32 - // The soft limit for the ulimit type. + // The type of the ulimit. // // This member is required. - SoftLimit *int32 + Name *string - // The type of the ulimit. + // The soft limit for the ulimit type. // // This member is required. - Name *string + SoftLimit *int32 } // A data volume used in a job's container properties. diff --git a/service/braket/api_op_CancelQuantumTask.go b/service/braket/api_op_CancelQuantumTask.go index 2e1965dcd46..f47cafd439a 100644 --- a/service/braket/api_op_CancelQuantumTask.go +++ b/service/braket/api_op_CancelQuantumTask.go @@ -56,28 +56,28 @@ func (c *Client) CancelQuantumTask(ctx context.Context, params *CancelQuantumTas type CancelQuantumTaskInput struct { - // The ARN of the task to cancel. + // The client token associated with the request. // // This member is required. - QuantumTaskArn *string + ClientToken *string - // The client token associated with the request. + // The ARN of the task to cancel. // // This member is required. - ClientToken *string + QuantumTaskArn *string } type CancelQuantumTaskOutput struct { - // The ARN of the task. + // The status of the cancellation request. // // This member is required. - QuantumTaskArn *string + CancellationStatus types.CancellationStatus - // The status of the cancellation request. + // The ARN of the task. // // This member is required. - CancellationStatus types.CancellationStatus + QuantumTaskArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/braket/api_op_CreateQuantumTask.go b/service/braket/api_op_CreateQuantumTask.go index 5e5f7114b6e..7ae8da34fe5 100644 --- a/service/braket/api_op_CreateQuantumTask.go +++ b/service/braket/api_op_CreateQuantumTask.go @@ -55,6 +55,12 @@ func (c *Client) CreateQuantumTask(ctx context.Context, params *CreateQuantumTas type CreateQuantumTaskInput struct { + // The action associated with the task. + // This value conforms to the media type: application/json + // + // This member is required. + Action *string + // The client token associated with the request. // // This member is required. @@ -65,15 +71,6 @@ type CreateQuantumTaskInput struct { // This member is required. DeviceArn *string - // The parameters for the device to run the task on. - // This value conforms to the media type: application/json - DeviceParameters *string - - // The number of shots to use for the task. - // - // This member is required. - Shots *int64 - // The S3 bucket to store task result files in. // // This member is required. @@ -84,11 +81,14 @@ type CreateQuantumTaskInput struct { // This member is required. OutputS3KeyPrefix *string - // The action associated with the task. - // This value conforms to the media type: application/json + // The number of shots to use for the task. // // This member is required. - Action *string + Shots *int64 + + // The parameters for the device to run the task on. + // This value conforms to the media type: application/json + DeviceParameters *string } type CreateQuantumTaskOutput struct { diff --git a/service/braket/api_op_GetDevice.go b/service/braket/api_op_GetDevice.go index 0f1d6419dda..e5cc1c3fc51 100644 --- a/service/braket/api_op_GetDevice.go +++ b/service/braket/api_op_GetDevice.go @@ -69,31 +69,31 @@ type GetDeviceOutput struct { // This member is required. DeviceArn *string + // Details about the capabilities of the device. + // This value conforms to the media type: application/json + // + // This member is required. + DeviceCapabilities *string + // The name of the device. // // This member is required. DeviceName *string - // The name of the partner company for the device. + // The status of the device. // // This member is required. - ProviderName *string + DeviceStatus types.DeviceStatus // The type of the device. // // This member is required. DeviceType types.DeviceType - // The status of the device. - // - // This member is required. - DeviceStatus types.DeviceStatus - - // Details about the capabilities of the device. - // This value conforms to the media type: application/json + // The name of the partner company for the device. // // This member is required. - DeviceCapabilities *string + ProviderName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/braket/api_op_GetQuantumTask.go b/service/braket/api_op_GetQuantumTask.go index 47786f961db..692097bf108 100644 --- a/service/braket/api_op_GetQuantumTask.go +++ b/service/braket/api_op_GetQuantumTask.go @@ -65,18 +65,10 @@ type GetQuantumTaskInput struct { type GetQuantumTaskOutput struct { - // The ARN of the task. - // - // This member is required. - QuantumTaskArn *string - - // The status of the task. + // The time at which the task was created. // // This member is required. - Status types.QuantumTaskStatus - - // The reason that a task failed. - FailureReason *string + CreatedAt *time.Time // The ARN of the device the task was run on. // @@ -89,11 +81,6 @@ type GetQuantumTaskOutput struct { // This member is required. DeviceParameters *string - // The number of shots used in the task. - // - // This member is required. - Shots *int64 - // The S3 bucket where task results are stored. // // This member is required. @@ -104,14 +91,27 @@ type GetQuantumTaskOutput struct { // This member is required. OutputS3Directory *string - // The time at which the task was created. + // The ARN of the task. // // This member is required. - CreatedAt *time.Time + QuantumTaskArn *string + + // The number of shots used in the task. + // + // This member is required. + Shots *int64 + + // The status of the task. + // + // This member is required. + Status types.QuantumTaskStatus // The time at which the task ended. EndedAt *time.Time + // The reason that a task failed. + FailureReason *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/braket/api_op_SearchDevices.go b/service/braket/api_op_SearchDevices.go index 9db6e440afb..04556c5218e 100644 --- a/service/braket/api_op_SearchDevices.go +++ b/service/braket/api_op_SearchDevices.go @@ -56,18 +56,18 @@ func (c *Client) SearchDevices(ctx context.Context, params *SearchDevicesInput, type SearchDevicesInput struct { - // A token used for pagination of results returned in the response. Use the token - // returned from the previous request continue results where the previous request - // ended. - NextToken *string - - // The maximum number of results to return in the response. - MaxResults *int32 - // The filter values to use to search for a device. // // This member is required. Filters []*types.SearchDevicesFilter + + // The maximum number of results to return in the response. + MaxResults *int32 + + // A token used for pagination of results returned in the response. Use the token + // returned from the previous request continue results where the previous request + // ended. + NextToken *string } type SearchDevicesOutput struct { diff --git a/service/braket/api_op_SearchQuantumTasks.go b/service/braket/api_op_SearchQuantumTasks.go index f3b9d7c83f9..a6ff71df919 100644 --- a/service/braket/api_op_SearchQuantumTasks.go +++ b/service/braket/api_op_SearchQuantumTasks.go @@ -56,18 +56,18 @@ func (c *Client) SearchQuantumTasks(ctx context.Context, params *SearchQuantumTa type SearchQuantumTasksInput struct { - // A token used for pagination of results returned in the response. Use the token - // returned from the previous request continue results where the previous request - // ended. - NextToken *string - - // Maximum number of results to return in the response. - MaxResults *int32 - // Array of SearchQuantumTasksFilter objects. // // This member is required. Filters []*types.SearchQuantumTasksFilter + + // Maximum number of results to return in the response. + MaxResults *int32 + + // A token used for pagination of results returned in the response. Use the token + // returned from the previous request continue results where the previous request + // ended. + NextToken *string } type SearchQuantumTasksOutput struct { diff --git a/service/braket/go.mod b/service/braket/go.mod index 7ed7559f569..40dcc5d2452 100644 --- a/service/braket/go.mod +++ b/service/braket/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/braket go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/braket/types/types.go b/service/braket/types/types.go index f10a48be20e..ec13b4d9db9 100644 --- a/service/braket/types/types.go +++ b/service/braket/types/types.go @@ -19,45 +19,35 @@ type DeviceSummary struct { // This member is required. DeviceName *string - // The provider of the device. + // The status of the device. // // This member is required. - ProviderName *string + DeviceStatus DeviceStatus // The type of the device. // // This member is required. DeviceType DeviceType - // The status of the device. + // The provider of the device. // // This member is required. - DeviceStatus DeviceStatus + ProviderName *string } // Includes information about a quantum task. type QuantumTaskSummary struct { - // The ARN of the task. - // - // This member is required. - QuantumTaskArn *string - - // The status of the task. + // The time at which the task was created. // // This member is required. - Status QuantumTaskStatus + CreatedAt *time.Time // The ARN of the device the task ran on. // // This member is required. DeviceArn *string - // The shots used for the task. - // - // This member is required. - Shots *int64 - // The S3 bucket where the task result file is stored.. // // This member is required. @@ -68,10 +58,20 @@ type QuantumTaskSummary struct { // This member is required. OutputS3Directory *string - // The time at which the task was created. + // The ARN of the task. // // This member is required. - CreatedAt *time.Time + QuantumTaskArn *string + + // The shots used for the task. + // + // This member is required. + Shots *int64 + + // The status of the task. + // + // This member is required. + Status QuantumTaskStatus // The time at which the task finished. EndedAt *time.Time @@ -99,13 +99,13 @@ type SearchQuantumTasksFilter struct { // This member is required. Name *string - // The values to use for the filter. + // An operator to use in the filter. // // This member is required. - Values []*string + Operator SearchQuantumTasksFilterOperator - // An operator to use in the filter. + // The values to use for the filter. // // This member is required. - Operator SearchQuantumTasksFilterOperator + Values []*string } diff --git a/service/budgets/api_op_CreateBudget.go b/service/budgets/api_op_CreateBudget.go index 5a1f51774af..e4c9ef79db8 100644 --- a/service/budgets/api_op_CreateBudget.go +++ b/service/budgets/api_op_CreateBudget.go @@ -63,21 +63,21 @@ func (c *Client) CreateBudget(ctx context.Context, params *CreateBudgetInput, op // Request of CreateBudget type CreateBudgetInput struct { - // A notification that you want to associate with a budget. A budget can have up to - // five notifications, and each notification can have one SNS subscriber and up to - // 10 email subscribers. If you include notifications and subscribers in your - // CreateBudget call, AWS creates the notifications and subscribers for you. - NotificationsWithSubscribers []*types.NotificationWithSubscribers + // The accountId that is associated with the budget. + // + // This member is required. + AccountId *string // The budget object that you want to create. // // This member is required. Budget *types.Budget - // The accountId that is associated with the budget. - // - // This member is required. - AccountId *string + // A notification that you want to associate with a budget. A budget can have up to + // five notifications, and each notification can have one SNS subscriber and up to + // 10 email subscribers. If you include notifications and subscribers in your + // CreateBudget call, AWS creates the notifications and subscribers for you. + NotificationsWithSubscribers []*types.NotificationWithSubscribers } // Response of CreateBudget diff --git a/service/budgets/api_op_CreateNotification.go b/service/budgets/api_op_CreateNotification.go index c49346e384a..65f5e208fc4 100644 --- a/service/budgets/api_op_CreateNotification.go +++ b/service/budgets/api_op_CreateNotification.go @@ -59,16 +59,11 @@ func (c *Client) CreateNotification(ctx context.Context, params *CreateNotificat // Request of CreateNotification type CreateNotificationInput struct { - // A list of subscribers that you want to associate with the notification. Each - // notification can have one SNS subscriber and up to 10 email subscribers. - // - // This member is required. - Subscribers []*types.Subscriber - - // The notification that you want to create. + // The accountId that is associated with the budget that you want to create a + // notification for. // // This member is required. - Notification *types.Notification + AccountId *string // The name of the budget that you want AWS to notify you about. Budget names must // be unique within an account. @@ -76,11 +71,16 @@ type CreateNotificationInput struct { // This member is required. BudgetName *string - // The accountId that is associated with the budget that you want to create a - // notification for. + // The notification that you want to create. // // This member is required. - AccountId *string + Notification *types.Notification + + // A list of subscribers that you want to associate with the notification. Each + // notification can have one SNS subscriber and up to 10 email subscribers. + // + // This member is required. + Subscribers []*types.Subscriber } // Response of CreateNotification diff --git a/service/budgets/api_op_CreateSubscriber.go b/service/budgets/api_op_CreateSubscriber.go index 1f1953cbfaf..b7894b86d4a 100644 --- a/service/budgets/api_op_CreateSubscriber.go +++ b/service/budgets/api_op_CreateSubscriber.go @@ -59,16 +59,6 @@ func (c *Client) CreateSubscriber(ctx context.Context, params *CreateSubscriberI // Request of CreateSubscriber type CreateSubscriberInput struct { - // The notification that you want to create a subscriber for. - // - // This member is required. - Notification *types.Notification - - // The subscriber that you want to associate with a budget notification. - // - // This member is required. - Subscriber *types.Subscriber - // The accountId that is associated with the budget that you want to create a // subscriber for. // @@ -80,6 +70,16 @@ type CreateSubscriberInput struct { // // This member is required. BudgetName *string + + // The notification that you want to create a subscriber for. + // + // This member is required. + Notification *types.Notification + + // The subscriber that you want to associate with a budget notification. + // + // This member is required. + Subscriber *types.Subscriber } // Response of CreateSubscriber diff --git a/service/budgets/api_op_DeleteBudget.go b/service/budgets/api_op_DeleteBudget.go index b20dd89bae3..29f6ab57ded 100644 --- a/service/budgets/api_op_DeleteBudget.go +++ b/service/budgets/api_op_DeleteBudget.go @@ -58,15 +58,15 @@ func (c *Client) DeleteBudget(ctx context.Context, params *DeleteBudgetInput, op // Request of DeleteBudget type DeleteBudgetInput struct { - // The name of the budget that you want to delete. + // The accountId that is associated with the budget that you want to delete. // // This member is required. - BudgetName *string + AccountId *string - // The accountId that is associated with the budget that you want to delete. + // The name of the budget that you want to delete. // // This member is required. - AccountId *string + BudgetName *string } // Response of DeleteBudget diff --git a/service/budgets/api_op_DeleteNotification.go b/service/budgets/api_op_DeleteNotification.go index bdeaf17efd3..659a184c1cb 100644 --- a/service/budgets/api_op_DeleteNotification.go +++ b/service/budgets/api_op_DeleteNotification.go @@ -59,6 +59,12 @@ func (c *Client) DeleteNotification(ctx context.Context, params *DeleteNotificat // Request of DeleteNotification type DeleteNotificationInput struct { + // The accountId that is associated with the budget whose notification you want to + // delete. + // + // This member is required. + AccountId *string + // The name of the budget whose notification you want to delete. // // This member is required. @@ -68,12 +74,6 @@ type DeleteNotificationInput struct { // // This member is required. Notification *types.Notification - - // The accountId that is associated with the budget whose notification you want to - // delete. - // - // This member is required. - AccountId *string } // Response of DeleteNotification diff --git a/service/budgets/api_op_DeleteSubscriber.go b/service/budgets/api_op_DeleteSubscriber.go index 47292bd5a1b..266050139c7 100644 --- a/service/budgets/api_op_DeleteSubscriber.go +++ b/service/budgets/api_op_DeleteSubscriber.go @@ -59,21 +59,21 @@ func (c *Client) DeleteSubscriber(ctx context.Context, params *DeleteSubscriberI // Request of DeleteSubscriber type DeleteSubscriberInput struct { - // The notification whose subscriber you want to delete. + // The accountId that is associated with the budget whose subscriber you want to + // delete. // // This member is required. - Notification *types.Notification + AccountId *string // The name of the budget whose subscriber you want to delete. // // This member is required. BudgetName *string - // The accountId that is associated with the budget whose subscriber you want to - // delete. + // The notification whose subscriber you want to delete. // // This member is required. - AccountId *string + Notification *types.Notification // The subscriber that you want to delete. // diff --git a/service/budgets/api_op_DescribeBudget.go b/service/budgets/api_op_DescribeBudget.go index 1340a154d74..4c82ae9ebe2 100644 --- a/service/budgets/api_op_DescribeBudget.go +++ b/service/budgets/api_op_DescribeBudget.go @@ -61,15 +61,15 @@ func (c *Client) DescribeBudget(ctx context.Context, params *DescribeBudgetInput // Request of DescribeBudget type DescribeBudgetInput struct { - // The name of the budget that you want a description of. + // The accountId that is associated with the budget that you want a description of. // // This member is required. - BudgetName *string + AccountId *string - // The accountId that is associated with the budget that you want a description of. + // The name of the budget that you want a description of. // // This member is required. - AccountId *string + BudgetName *string } // Response of DescribeBudget diff --git a/service/budgets/api_op_DescribeBudgetPerformanceHistory.go b/service/budgets/api_op_DescribeBudgetPerformanceHistory.go index 93220f54a2d..5a923d60399 100644 --- a/service/budgets/api_op_DescribeBudgetPerformanceHistory.go +++ b/service/budgets/api_op_DescribeBudgetPerformanceHistory.go @@ -58,34 +58,31 @@ func (c *Client) DescribeBudgetPerformanceHistory(ctx context.Context, params *D type DescribeBudgetPerformanceHistoryInput struct { + // The account ID of the user. It should be a 12-digit number. + // + // This member is required. + AccountId *string + // A string that represents the budget name. The ":" and "\" characters aren't // allowed. // // This member is required. BudgetName *string - // A generic string. - NextToken *string - // An integer that represents how many entries a paginated response contains. The // maximum is 100. MaxResults *int32 + // A generic string. + NextToken *string + // Retrieves how often the budget went into an ALARM state for the specified time // period. TimePeriod *types.TimePeriod - - // The account ID of the user. It should be a 12-digit number. - // - // This member is required. - AccountId *string } type DescribeBudgetPerformanceHistoryOutput struct { - // A generic string. - NextToken *string - // The history of how often the budget has gone into an ALARM state. For DAILY // budgets, the history saves the state of the budget for the last 60 days. For // MONTHLY budgets, the history saves the state of the budget for the current month @@ -93,6 +90,9 @@ type DescribeBudgetPerformanceHistoryOutput struct { // the budget for the last four quarters. BudgetPerformanceHistory *types.BudgetPerformanceHistory + // A generic string. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/budgets/api_op_DescribeBudgets.go b/service/budgets/api_op_DescribeBudgets.go index a6ac45ed25d..3666025e2b9 100644 --- a/service/budgets/api_op_DescribeBudgets.go +++ b/service/budgets/api_op_DescribeBudgets.go @@ -66,25 +66,25 @@ type DescribeBudgetsInput struct { // This member is required. AccountId *string - // The pagination token that you include in your request to indicate the next set - // of results that you want to retrieve. - NextToken *string - // An optional integer that represents how many entries a paginated response // contains. The maximum is 100. MaxResults *int32 + + // The pagination token that you include in your request to indicate the next set + // of results that you want to retrieve. + NextToken *string } // Response of DescribeBudgets type DescribeBudgetsOutput struct { + // A list of budgets. + Budgets []*types.Budget + // The pagination token in the service response that indicates the next set of // results that you can retrieve. NextToken *string - // A list of budgets. - Budgets []*types.Budget - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/budgets/api_op_DescribeNotificationsForBudget.go b/service/budgets/api_op_DescribeNotificationsForBudget.go index d8a463e2cfc..8c06fcc2153 100644 --- a/service/budgets/api_op_DescribeNotificationsForBudget.go +++ b/service/budgets/api_op_DescribeNotificationsForBudget.go @@ -64,6 +64,11 @@ type DescribeNotificationsForBudgetInput struct { // This member is required. AccountId *string + // The name of the budget whose notifications you want descriptions of. + // + // This member is required. + BudgetName *string + // An optional integer that represents how many entries a paginated response // contains. The maximum is 100. MaxResults *int32 @@ -71,11 +76,6 @@ type DescribeNotificationsForBudgetInput struct { // The pagination token that you include in your request to indicate the next set // of results that you want to retrieve. NextToken *string - - // The name of the budget whose notifications you want descriptions of. - // - // This member is required. - BudgetName *string } // Response of GetNotificationsForBudget diff --git a/service/budgets/api_op_DescribeSubscribersForNotification.go b/service/budgets/api_op_DescribeSubscribersForNotification.go index b9fd92ea0e7..97146ef43ea 100644 --- a/service/budgets/api_op_DescribeSubscribersForNotification.go +++ b/service/budgets/api_op_DescribeSubscribersForNotification.go @@ -64,23 +64,23 @@ type DescribeSubscribersForNotificationInput struct { // This member is required. AccountId *string - // The notification whose subscribers you want to list. - // - // This member is required. - Notification *types.Notification - // The name of the budget whose subscribers you want descriptions of. // // This member is required. BudgetName *string - // The pagination token that you include in your request to indicate the next set - // of results that you want to retrieve. - NextToken *string + // The notification whose subscribers you want to list. + // + // This member is required. + Notification *types.Notification // An optional integer that represents how many entries a paginated response // contains. The maximum is 100. MaxResults *int32 + + // The pagination token that you include in your request to indicate the next set + // of results that you want to retrieve. + NextToken *string } // Response of DescribeSubscribersForNotification diff --git a/service/budgets/api_op_UpdateBudget.go b/service/budgets/api_op_UpdateBudget.go index 3632cc5548a..14ebd41606a 100644 --- a/service/budgets/api_op_UpdateBudget.go +++ b/service/budgets/api_op_UpdateBudget.go @@ -66,15 +66,15 @@ func (c *Client) UpdateBudget(ctx context.Context, params *UpdateBudgetInput, op // Request of UpdateBudget type UpdateBudgetInput struct { - // The budget that you want to update your budget to. + // The accountId that is associated with the budget that you want to update. // // This member is required. - NewBudget *types.Budget + AccountId *string - // The accountId that is associated with the budget that you want to update. + // The budget that you want to update your budget to. // // This member is required. - AccountId *string + NewBudget *types.Budget } // Response of UpdateBudget diff --git a/service/budgets/api_op_UpdateNotification.go b/service/budgets/api_op_UpdateNotification.go index d852d6d712c..7cb4bc0c6f0 100644 --- a/service/budgets/api_op_UpdateNotification.go +++ b/service/budgets/api_op_UpdateNotification.go @@ -64,11 +64,6 @@ type UpdateNotificationInput struct { // This member is required. AccountId *string - // The previous notification that is associated with a budget. - // - // This member is required. - OldNotification *types.Notification - // The name of the budget whose notification you want to update. // // This member is required. @@ -78,6 +73,11 @@ type UpdateNotificationInput struct { // // This member is required. NewNotification *types.Notification + + // The previous notification that is associated with a budget. + // + // This member is required. + OldNotification *types.Notification } // Response of UpdateNotification diff --git a/service/budgets/api_op_UpdateSubscriber.go b/service/budgets/api_op_UpdateSubscriber.go index d7d2f14d41e..bc42b10a8fe 100644 --- a/service/budgets/api_op_UpdateSubscriber.go +++ b/service/budgets/api_op_UpdateSubscriber.go @@ -58,16 +58,21 @@ func (c *Client) UpdateSubscriber(ctx context.Context, params *UpdateSubscriberI // Request of UpdateSubscriber type UpdateSubscriberInput struct { + // The accountId that is associated with the budget whose subscriber you want to + // update. + // + // This member is required. + AccountId *string + // The name of the budget whose subscriber you want to update. // // This member is required. BudgetName *string - // The accountId that is associated with the budget whose subscriber you want to - // update. + // The updated subscriber that is associated with a budget notification. // // This member is required. - AccountId *string + NewSubscriber *types.Subscriber // The notification whose subscriber you want to update. // @@ -78,11 +83,6 @@ type UpdateSubscriberInput struct { // // This member is required. OldSubscriber *types.Subscriber - - // The updated subscriber that is associated with a budget notification. - // - // This member is required. - NewSubscriber *types.Subscriber } // Response of UpdateSubscriber diff --git a/service/budgets/go.mod b/service/budgets/go.mod index 38fdae46a88..e879355e214 100644 --- a/service/budgets/go.mod +++ b/service/budgets/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/budgets go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/budgets/types/types.go b/service/budgets/types/types.go index 21c52c60b68..ff612d0667f 100644 --- a/service/budgets/types/types.go +++ b/service/budgets/types/types.go @@ -12,10 +12,17 @@ import ( // arn:aws:budgetservice::AccountId:budget/budgetName type Budget struct { - // The types of costs that are included in this COST budget. USAGE, RI_UTILIZATION, - // RI_COVERAGE, Savings_Plans_Utilization, and Savings_Plans_Coverage budgets do - // not have CostTypes. - CostTypes *CostTypes + // The name of a budget. The name must be unique within an account. The : and \ + // characters aren't allowed in BudgetName. + // + // This member is required. + BudgetName *string + + // Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings + // Plans utilization, or Savings Plans coverage. + // + // This member is required. + BudgetType BudgetType // The length of time until a budget resets the actual and forecasted spend. DAILY // is available only for RI_UTILIZATION, RI_COVERAGE, Savings_Plans_Utilization, @@ -24,6 +31,18 @@ type Budget struct { // This member is required. TimeUnit TimeUnit + // The total amount of cost, usage, RI utilization, RI coverage, Savings Plans + // utilization, or Savings Plans coverage that you want to track with your budget. + // BudgetLimit is required for cost or usage budgets, but optional for RI or + // Savings Plans utilization or coverage budgets. RI and Savings Plans utilization + // or coverage budgets default to 100, which is the only valid value for RI or + // Savings Plans utilization or coverage budgets. You can't use BudgetLimit with + // PlannedBudgetLimits for CreateBudget and UpdateBudget actions. + BudgetLimit *Spend + + // The actual and forecasted cost or usage that the budget tracks. + CalculatedSpend *CalculatedSpend + // The cost filters, such as service or tag, that are applied to a budget. AWS // Budgets supports the following services as a filter for RI budgets: // @@ -41,8 +60,10 @@ type Budget struct { // Elasticsearch Service CostFilters map[string][]*string - // The actual and forecasted cost or usage that the budget tracks. - CalculatedSpend *CalculatedSpend + // The types of costs that are included in this COST budget. USAGE, RI_UTILIZATION, + // RI_COVERAGE, Savings_Plans_Utilization, and Savings_Plans_Coverage budgets do + // not have CostTypes. + CostTypes *CostTypes // The last time that you updated this budget. LastUpdatedTime *time.Time @@ -69,21 +90,6 @@ type Budget struct { // PlannedBudgetLimits. PlannedBudgetLimits map[string]*Spend - // The name of a budget. The name must be unique within an account. The : and \ - // characters aren't allowed in BudgetName. - // - // This member is required. - BudgetName *string - - // The total amount of cost, usage, RI utilization, RI coverage, Savings Plans - // utilization, or Savings Plans coverage that you want to track with your budget. - // BudgetLimit is required for cost or usage budgets, but optional for RI or - // Savings Plans utilization or coverage budgets. RI and Savings Plans utilization - // or coverage budgets default to 100, which is the only valid value for RI or - // Savings Plans utilization or coverage budgets. You can't use BudgetLimit with - // PlannedBudgetLimits for CreateBudget and UpdateBudget actions. - BudgetLimit *Spend - // The period of time that is covered by a budget. The period has a start date and // an end date. The start date must come before the end date. The end date must // come before 06/15/87 00:00 UTC. If you create your budget and don't specify a @@ -97,12 +103,6 @@ type Budget struct { // operation. After the end date, AWS deletes the budget and all associated // notifications and subscribers. TimePeriod *TimePeriod - - // Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings - // Plans utilization, or Savings Plans coverage. - // - // This member is required. - BudgetType BudgetType } // The amount of cost or usage that you created the budget for, compared to your @@ -127,22 +127,22 @@ type BudgetPerformanceHistory struct { // allowed. BudgetName *string + // The type of a budget. It must be one of the following types: COST, USAGE, + // RI_UTILIZATION, or RI_COVERAGE. + BudgetType BudgetType + // A list of amounts of cost or usage that you created budgets for, compared to // your actual costs or usage. BudgetedAndActualAmountsList []*BudgetedAndActualAmounts - // The time unit of the budget, such as MONTHLY or QUARTERLY. - TimeUnit TimeUnit - // The history of the cost filters for a budget during the specified time period. CostFilters map[string][]*string // The history of the cost types for a budget during the specified time period. CostTypes *CostTypes - // The type of a budget. It must be one of the following types: COST, USAGE, - // RI_UTILIZATION, or RI_COVERAGE. - BudgetType BudgetType + // The time unit of the budget, such as MONTHLY or QUARTERLY. + TimeUnit TimeUnit } // The spend objects that are associated with this budget. The actualSpend tracks @@ -152,13 +152,13 @@ type BudgetPerformanceHistory struct { // EC2, your actualSpend is 50 USD, and your forecastedSpend is 75 USD. type CalculatedSpend struct { - // The amount of cost, usage, or RI units that you are forecasted to use. - ForecastedSpend *Spend - // The amount of cost, usage, or RI units that you have used. // // This member is required. ActualSpend *Spend + + // The amount of cost, usage, or RI units that you are forecasted to use. + ForecastedSpend *Spend } // The types of cost that are included in a COST budget, such as tax and @@ -166,41 +166,41 @@ type CalculatedSpend struct { // CostTypes. type CostTypes struct { - // Specifies whether a budget includes upfront RI costs. The default value is true. - IncludeUpfront *bool - - // Specifies whether a budget includes subscriptions. The default value is true. - IncludeSubscription *bool - // Specifies whether a budget includes credits. The default value is true. IncludeCredit *bool // Specifies whether a budget includes discounts. The default value is true. IncludeDiscount *bool - // Specifies whether a budget includes refunds. The default value is true. - IncludeRefund *bool + // Specifies whether a budget includes non-RI subscription costs. The default value + // is true. + IncludeOtherSubscription *bool // Specifies whether a budget includes recurring fees such as monthly RI fees. The // default value is true. IncludeRecurring *bool - // Specifies whether a budget uses the amortized rate. The default value is false. - UseAmortized *bool + // Specifies whether a budget includes refunds. The default value is true. + IncludeRefund *bool - // Specifies whether a budget includes non-RI subscription costs. The default value - // is true. - IncludeOtherSubscription *bool + // Specifies whether a budget includes subscriptions. The default value is true. + IncludeSubscription *bool // Specifies whether a budget includes support subscription fees. The default value // is true. IncludeSupport *bool - // Specifies whether a budget uses a blended rate. The default value is false. - UseBlended *bool - // Specifies whether a budget includes taxes. The default value is true. IncludeTax *bool + + // Specifies whether a budget includes upfront RI costs. The default value is true. + IncludeUpfront *bool + + // Specifies whether a budget uses the amortized rate. The default value is false. + UseAmortized *bool + + // Specifies whether a budget uses a blended rate. The default value is false. + UseBlended *bool } // A notification that is associated with a budget. A budget can have up to five @@ -226,17 +226,11 @@ type Notification struct { // This member is required. ComparisonOperator ComparisonOperator - // The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, AWS - // notifies you when you go over or are forecasted to go over your total cost - // threshold. For PERCENTAGE thresholds, AWS notifies you when you go over or are - // forecasted to go over a certain percentage of your forecasted spend. For - // example, if you have a budget for 200 dollars and you have a PERCENTAGE - // threshold of 80%, AWS notifies you when you go over 160 dollars. - ThresholdType ThresholdType - - // Whether this notification is in alarm. If a budget notification is in the ALARM - // state, you have passed the set threshold for the budget. - NotificationState NotificationState + // Whether the notification is for how much you have spent (ACTUAL) or for how much + // you're forecasted to spend (FORECASTED). + // + // This member is required. + NotificationType NotificationType // The threshold that is associated with a notification. Thresholds are always a // percentage. @@ -244,11 +238,17 @@ type Notification struct { // This member is required. Threshold *float64 - // Whether the notification is for how much you have spent (ACTUAL) or for how much - // you're forecasted to spend (FORECASTED). - // - // This member is required. - NotificationType NotificationType + // Whether this notification is in alarm. If a budget notification is in the ALARM + // state, you have passed the set threshold for the budget. + NotificationState NotificationState + + // The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, AWS + // notifies you when you go over or are forecasted to go over your total cost + // threshold. For PERCENTAGE thresholds, AWS notifies you when you go over or are + // forecasted to go over a certain percentage of your forecasted spend. For + // example, if you have a budget for 200 dollars and you have a PERCENTAGE + // threshold of 80%, AWS notifies you when you go over 160 dollars. + ThresholdType ThresholdType } // A notification with subscribers. A notification can have one SNS subscriber and @@ -316,6 +316,13 @@ type Subscriber struct { // restrictions on the end date. type TimePeriod struct { + // The end date for a budget. If you didn't specify an end date, AWS set your end + // date to 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and + // Cost Management console and the API. After the end date, AWS deletes the budget + // and all associated notifications and subscribers. You can change your end date + // with the UpdateBudget operation. + End *time.Time + // The start date for a budget. If you created your budget and didn't specify a // start date, AWS defaults to the start of your chosen time period (DAILY, // MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on @@ -325,11 +332,4 @@ type TimePeriod struct { // Management console and the API. You can change your start date with the // UpdateBudget operation. Start *time.Time - - // The end date for a budget. If you didn't specify an end date, AWS set your end - // date to 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and - // Cost Management console and the API. After the end date, AWS deletes the budget - // and all associated notifications and subscribers. You can change your end date - // with the UpdateBudget operation. - End *time.Time } diff --git a/service/chime/api_op_AssociatePhoneNumberWithUser.go b/service/chime/api_op_AssociatePhoneNumberWithUser.go index 10f9aa4135f..64a5cd35647 100644 --- a/service/chime/api_op_AssociatePhoneNumberWithUser.go +++ b/service/chime/api_op_AssociatePhoneNumberWithUser.go @@ -56,15 +56,15 @@ func (c *Client) AssociatePhoneNumberWithUser(ctx context.Context, params *Assoc type AssociatePhoneNumberWithUserInput struct { - // The phone number, in E.164 format. + // The Amazon Chime account ID. // // This member is required. - E164PhoneNumber *string + AccountId *string - // The Amazon Chime account ID. + // The phone number, in E.164 format. // // This member is required. - AccountId *string + E164PhoneNumber *string // The user ID. // diff --git a/service/chime/api_op_AssociatePhoneNumbersWithVoiceConnector.go b/service/chime/api_op_AssociatePhoneNumbersWithVoiceConnector.go index 1380a335ec4..1fbfdfda3ee 100644 --- a/service/chime/api_op_AssociatePhoneNumbersWithVoiceConnector.go +++ b/service/chime/api_op_AssociatePhoneNumbersWithVoiceConnector.go @@ -57,11 +57,6 @@ func (c *Client) AssociatePhoneNumbersWithVoiceConnector(ctx context.Context, pa type AssociatePhoneNumbersWithVoiceConnectorInput struct { - // If true, associates the provided phone numbers with the provided Amazon Chime - // Voice Connector and removes any previously existing associations. If false, does - // not associate any phone numbers that have previously existing associations. - ForceAssociate *bool - // List of phone numbers, in E.164 format. // // This member is required. @@ -71,6 +66,11 @@ type AssociatePhoneNumbersWithVoiceConnectorInput struct { // // This member is required. VoiceConnectorId *string + + // If true, associates the provided phone numbers with the provided Amazon Chime + // Voice Connector and removes any previously existing associations. If false, does + // not associate any phone numbers that have previously existing associations. + ForceAssociate *bool } type AssociatePhoneNumbersWithVoiceConnectorOutput struct { diff --git a/service/chime/api_op_AssociatePhoneNumbersWithVoiceConnectorGroup.go b/service/chime/api_op_AssociatePhoneNumbersWithVoiceConnectorGroup.go index e81fa886a53..6d6f0722c3b 100644 --- a/service/chime/api_op_AssociatePhoneNumbersWithVoiceConnectorGroup.go +++ b/service/chime/api_op_AssociatePhoneNumbersWithVoiceConnectorGroup.go @@ -57,6 +57,11 @@ func (c *Client) AssociatePhoneNumbersWithVoiceConnectorGroup(ctx context.Contex type AssociatePhoneNumbersWithVoiceConnectorGroupInput struct { + // List of phone numbers, in E.164 format. + // + // This member is required. + E164PhoneNumbers []*string + // The Amazon Chime Voice Connector group ID. // // This member is required. @@ -67,11 +72,6 @@ type AssociatePhoneNumbersWithVoiceConnectorGroupInput struct { // false, does not associate any phone numbers that have previously existing // associations. ForceAssociate *bool - - // List of phone numbers, in E.164 format. - // - // This member is required. - E164PhoneNumbers []*string } type AssociatePhoneNumbersWithVoiceConnectorGroupOutput struct { diff --git a/service/chime/api_op_AssociateSigninDelegateGroupsWithAccount.go b/service/chime/api_op_AssociateSigninDelegateGroupsWithAccount.go index e3567943da2..6571b598334 100644 --- a/service/chime/api_op_AssociateSigninDelegateGroupsWithAccount.go +++ b/service/chime/api_op_AssociateSigninDelegateGroupsWithAccount.go @@ -58,15 +58,15 @@ func (c *Client) AssociateSigninDelegateGroupsWithAccount(ctx context.Context, p type AssociateSigninDelegateGroupsWithAccountInput struct { - // The sign-in delegate groups. + // The Amazon Chime account ID. // // This member is required. - SigninDelegateGroups []*types.SigninDelegateGroup + AccountId *string - // The Amazon Chime account ID. + // The sign-in delegate groups. // // This member is required. - AccountId *string + SigninDelegateGroups []*types.SigninDelegateGroup } type AssociateSigninDelegateGroupsWithAccountOutput struct { diff --git a/service/chime/api_op_BatchCreateRoomMembership.go b/service/chime/api_op_BatchCreateRoomMembership.go index 487aad05690..42a1ae30557 100644 --- a/service/chime/api_op_BatchCreateRoomMembership.go +++ b/service/chime/api_op_BatchCreateRoomMembership.go @@ -59,15 +59,15 @@ func (c *Client) BatchCreateRoomMembership(ctx context.Context, params *BatchCre type BatchCreateRoomMembershipInput struct { - // The list of membership items. + // The Amazon Chime account ID. // // This member is required. - MembershipItemList []*types.MembershipItem + AccountId *string - // The Amazon Chime account ID. + // The list of membership items. // // This member is required. - AccountId *string + MembershipItemList []*types.MembershipItem // The room ID. // diff --git a/service/chime/api_op_BatchSuspendUser.go b/service/chime/api_op_BatchSuspendUser.go index 2b807658bb6..0407980c689 100644 --- a/service/chime/api_op_BatchSuspendUser.go +++ b/service/chime/api_op_BatchSuspendUser.go @@ -67,15 +67,15 @@ func (c *Client) BatchSuspendUser(ctx context.Context, params *BatchSuspendUserI type BatchSuspendUserInput struct { - // The request containing the user IDs to suspend. + // The Amazon Chime account ID. // // This member is required. - UserIdList []*string + AccountId *string - // The Amazon Chime account ID. + // The request containing the user IDs to suspend. // // This member is required. - AccountId *string + UserIdList []*string } type BatchSuspendUserOutput struct { diff --git a/service/chime/api_op_BatchUnsuspendUser.go b/service/chime/api_op_BatchUnsuspendUser.go index fc754fc150c..a2c7e1ea131 100644 --- a/service/chime/api_op_BatchUnsuspendUser.go +++ b/service/chime/api_op_BatchUnsuspendUser.go @@ -64,15 +64,15 @@ func (c *Client) BatchUnsuspendUser(ctx context.Context, params *BatchUnsuspendU type BatchUnsuspendUserInput struct { - // The request containing the user IDs to unsuspend. + // The Amazon Chime account ID. // // This member is required. - UserIdList []*string + AccountId *string - // The Amazon Chime account ID. + // The request containing the user IDs to unsuspend. // // This member is required. - AccountId *string + UserIdList []*string } type BatchUnsuspendUserOutput struct { diff --git a/service/chime/api_op_CreateBot.go b/service/chime/api_op_CreateBot.go index 7c13303a582..ae63d560b0d 100644 --- a/service/chime/api_op_CreateBot.go +++ b/service/chime/api_op_CreateBot.go @@ -62,13 +62,13 @@ type CreateBotInput struct { // This member is required. AccountId *string - // The domain of the Amazon Chime Enterprise account. - Domain *string - // The bot display name. // // This member is required. DisplayName *string + + // The domain of the Amazon Chime Enterprise account. + Domain *string } type CreateBotOutput struct { diff --git a/service/chime/api_op_CreateMeeting.go b/service/chime/api_op_CreateMeeting.go index 2fe54cfed2f..ecc628ca064 100644 --- a/service/chime/api_op_CreateMeeting.go +++ b/service/chime/api_op_CreateMeeting.go @@ -66,8 +66,14 @@ func (c *Client) CreateMeeting(ctx context.Context, params *CreateMeetingInput, type CreateMeetingInput struct { - // The tag key-value pairs. - Tags []*types.Tag + // The unique identifier for the client request. Use a different token for + // different meetings. + // + // This member is required. + ClientRequestToken *string + + // The external meeting ID. + ExternalMeetingId *string // The Region in which to create the meeting. Default: us-east-1. Available values: // ap-northeast-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, @@ -75,12 +81,6 @@ type CreateMeetingInput struct { // us-west-1, us-west-2. MediaRegion *string - // The unique identifier for the client request. Use a different token for - // different meetings. - // - // This member is required. - ClientRequestToken *string - // Reserved. MeetingHostId *string @@ -88,8 +88,8 @@ type CreateMeetingInput struct { // attendee events occur. NotificationsConfiguration *types.MeetingNotificationConfiguration - // The external meeting ID. - ExternalMeetingId *string + // The tag key-value pairs. + Tags []*types.Tag } type CreateMeetingOutput struct { diff --git a/service/chime/api_op_CreateMeetingWithAttendees.go b/service/chime/api_op_CreateMeetingWithAttendees.go index 9fc0f4d0236..c20efcec6e8 100644 --- a/service/chime/api_op_CreateMeetingWithAttendees.go +++ b/service/chime/api_op_CreateMeetingWithAttendees.go @@ -66,23 +66,18 @@ func (c *Client) CreateMeetingWithAttendees(ctx context.Context, params *CreateM type CreateMeetingWithAttendeesInput struct { - // The configuration for resource targets to receive notifications when Amazon - // Chime SDK meeting and attendee events occur. The Amazon Chime SDK supports - // resource targets located in the US East (N. Virginia) AWS Region (us-east-1). - NotificationsConfiguration *types.MeetingNotificationConfiguration - // The unique identifier for the client request. Use a different token for // different meetings. // // This member is required. ClientRequestToken *string - // The external meeting ID. - ExternalMeetingId *string - // The request containing the attendees to create. Attendees []*types.CreateAttendeeRequestItem + // The external meeting ID. + ExternalMeetingId *string + // The Region in which to create the meeting. Default: us-east-1. Available values: // ap-northeast-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, // eu-north-1, eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, @@ -92,19 +87,24 @@ type CreateMeetingWithAttendeesInput struct { // Reserved. MeetingHostId *string + // The configuration for resource targets to receive notifications when Amazon + // Chime SDK meeting and attendee events occur. The Amazon Chime SDK supports + // resource targets located in the US East (N. Virginia) AWS Region (us-east-1). + NotificationsConfiguration *types.MeetingNotificationConfiguration + // The tag key-value pairs. Tags []*types.Tag } type CreateMeetingWithAttendeesOutput struct { + // The attendee information, including attendees IDs and join tokens. + Attendees []*types.Attendee + // If the action fails for one or more of the attendees in the request, a list of // the attendees is returned, along with error codes and error messages. Errors []*types.CreateAttendeeError - // The attendee information, including attendees IDs and join tokens. - Attendees []*types.Attendee - // A meeting created using the Amazon Chime SDK. Meeting *types.Meeting diff --git a/service/chime/api_op_CreateProxySession.go b/service/chime/api_op_CreateProxySession.go index d399179fc05..598d8e0b031 100644 --- a/service/chime/api_op_CreateProxySession.go +++ b/service/chime/api_op_CreateProxySession.go @@ -63,20 +63,6 @@ type CreateProxySessionInput struct { // This member is required. Capabilities []types.Capability - // The preference for proxy phone number reuse, or stickiness, between the same - // participants across sessions. - NumberSelectionBehavior types.NumberSelectionBehavior - - // The name of the proxy session. - Name *string - - // The country and area code for the proxy phone number. - GeoMatchParams *types.GeoMatchParams - - // The preference for matching the country or area code of the proxy phone number - // with that of the first participant. - GeoMatchLevel types.GeoMatchLevel - // The participant phone numbers. // // This member is required. @@ -89,6 +75,20 @@ type CreateProxySessionInput struct { // The number of minutes allowed for the proxy session. ExpiryMinutes *int32 + + // The preference for matching the country or area code of the proxy phone number + // with that of the first participant. + GeoMatchLevel types.GeoMatchLevel + + // The country and area code for the proxy phone number. + GeoMatchParams *types.GeoMatchParams + + // The name of the proxy session. + Name *string + + // The preference for proxy phone number reuse, or stickiness, between the same + // participants across sessions. + NumberSelectionBehavior types.NumberSelectionBehavior } type CreateProxySessionOutput struct { diff --git a/service/chime/api_op_CreateRoomMembership.go b/service/chime/api_op_CreateRoomMembership.go index f0e8018ad60..70ebf0e6406 100644 --- a/service/chime/api_op_CreateRoomMembership.go +++ b/service/chime/api_op_CreateRoomMembership.go @@ -59,23 +59,23 @@ func (c *Client) CreateRoomMembership(ctx context.Context, params *CreateRoomMem type CreateRoomMembershipInput struct { - // The role of the member. - Role types.RoomMembershipRole - - // The Amazon Chime member ID (user ID or bot ID). + // The Amazon Chime account ID. // // This member is required. - MemberId *string + AccountId *string - // The Amazon Chime account ID. + // The Amazon Chime member ID (user ID or bot ID). // // This member is required. - AccountId *string + MemberId *string // The room ID. // // This member is required. RoomId *string + + // The role of the member. + Role types.RoomMembershipRole } type CreateRoomMembershipOutput struct { diff --git a/service/chime/api_op_CreateVoiceConnector.go b/service/chime/api_op_CreateVoiceConnector.go index cbec7bf1d36..3e91fe70972 100644 --- a/service/chime/api_op_CreateVoiceConnector.go +++ b/service/chime/api_op_CreateVoiceConnector.go @@ -62,19 +62,19 @@ func (c *Client) CreateVoiceConnector(ctx context.Context, params *CreateVoiceCo type CreateVoiceConnectorInput struct { - // The AWS Region in which the Amazon Chime Voice Connector is created. Default - // value: us-east-1. - AwsRegion types.VoiceConnectorAwsRegion + // The name of the Amazon Chime Voice Connector. + // + // This member is required. + Name *string // When enabled, requires encryption for the Amazon Chime Voice Connector. // // This member is required. RequireEncryption *bool - // The name of the Amazon Chime Voice Connector. - // - // This member is required. - Name *string + // The AWS Region in which the Amazon Chime Voice Connector is created. Default + // value: us-east-1. + AwsRegion types.VoiceConnectorAwsRegion } type CreateVoiceConnectorOutput struct { diff --git a/service/chime/api_op_CreateVoiceConnectorGroup.go b/service/chime/api_op_CreateVoiceConnectorGroup.go index c4fc5dd3326..609d83284a4 100644 --- a/service/chime/api_op_CreateVoiceConnectorGroup.go +++ b/service/chime/api_op_CreateVoiceConnectorGroup.go @@ -62,13 +62,13 @@ func (c *Client) CreateVoiceConnectorGroup(ctx context.Context, params *CreateVo type CreateVoiceConnectorGroupInput struct { - // The Amazon Chime Voice Connectors to route inbound calls to. - VoiceConnectorItems []*types.VoiceConnectorItem - // The name of the Amazon Chime Voice Connector group. // // This member is required. Name *string + + // The Amazon Chime Voice Connectors to route inbound calls to. + VoiceConnectorItems []*types.VoiceConnectorItem } type CreateVoiceConnectorGroupOutput struct { diff --git a/service/chime/api_op_DeleteAttendee.go b/service/chime/api_op_DeleteAttendee.go index 15be44f4be7..5a0089e073c 100644 --- a/service/chime/api_op_DeleteAttendee.go +++ b/service/chime/api_op_DeleteAttendee.go @@ -61,15 +61,15 @@ func (c *Client) DeleteAttendee(ctx context.Context, params *DeleteAttendeeInput type DeleteAttendeeInput struct { - // The Amazon Chime SDK meeting ID. + // The Amazon Chime SDK attendee ID. // // This member is required. - MeetingId *string + AttendeeId *string - // The Amazon Chime SDK attendee ID. + // The Amazon Chime SDK meeting ID. // // This member is required. - AttendeeId *string + MeetingId *string } type DeleteAttendeeOutput struct { diff --git a/service/chime/api_op_DeleteEventsConfiguration.go b/service/chime/api_op_DeleteEventsConfiguration.go index 5395ecfdacf..ece187dd38a 100644 --- a/service/chime/api_op_DeleteEventsConfiguration.go +++ b/service/chime/api_op_DeleteEventsConfiguration.go @@ -56,15 +56,15 @@ func (c *Client) DeleteEventsConfiguration(ctx context.Context, params *DeleteEv type DeleteEventsConfigurationInput struct { - // The bot ID. + // The Amazon Chime account ID. // // This member is required. - BotId *string + AccountId *string - // The Amazon Chime account ID. + // The bot ID. // // This member is required. - AccountId *string + BotId *string } type DeleteEventsConfigurationOutput struct { diff --git a/service/chime/api_op_DeleteProxySession.go b/service/chime/api_op_DeleteProxySession.go index bb1bc2fc87e..2203f2fe583 100644 --- a/service/chime/api_op_DeleteProxySession.go +++ b/service/chime/api_op_DeleteProxySession.go @@ -57,15 +57,15 @@ func (c *Client) DeleteProxySession(ctx context.Context, params *DeleteProxySess type DeleteProxySessionInput struct { - // The Amazon Chime voice connector ID. + // The proxy session ID. // // This member is required. - VoiceConnectorId *string + ProxySessionId *string - // The proxy session ID. + // The Amazon Chime voice connector ID. // // This member is required. - ProxySessionId *string + VoiceConnectorId *string } type DeleteProxySessionOutput struct { diff --git a/service/chime/api_op_DeleteRoomMembership.go b/service/chime/api_op_DeleteRoomMembership.go index dc8b0903c1e..59e667f5120 100644 --- a/service/chime/api_op_DeleteRoomMembership.go +++ b/service/chime/api_op_DeleteRoomMembership.go @@ -56,15 +56,15 @@ func (c *Client) DeleteRoomMembership(ctx context.Context, params *DeleteRoomMem type DeleteRoomMembershipInput struct { - // The member ID (user ID or bot ID). + // The Amazon Chime account ID. // // This member is required. - MemberId *string + AccountId *string - // The Amazon Chime account ID. + // The member ID (user ID or bot ID). // // This member is required. - AccountId *string + MemberId *string // The room ID. // diff --git a/service/chime/api_op_DisassociatePhoneNumberFromUser.go b/service/chime/api_op_DisassociatePhoneNumberFromUser.go index c520eb2eecd..39602288858 100644 --- a/service/chime/api_op_DisassociatePhoneNumberFromUser.go +++ b/service/chime/api_op_DisassociatePhoneNumberFromUser.go @@ -57,15 +57,15 @@ func (c *Client) DisassociatePhoneNumberFromUser(ctx context.Context, params *Di type DisassociatePhoneNumberFromUserInput struct { - // The user ID. + // The Amazon Chime account ID. // // This member is required. - UserId *string + AccountId *string - // The Amazon Chime account ID. + // The user ID. // // This member is required. - AccountId *string + UserId *string } type DisassociatePhoneNumberFromUserOutput struct { diff --git a/service/chime/api_op_DisassociatePhoneNumbersFromVoiceConnectorGroup.go b/service/chime/api_op_DisassociatePhoneNumbersFromVoiceConnectorGroup.go index dcb9831b176..1a07066e260 100644 --- a/service/chime/api_op_DisassociatePhoneNumbersFromVoiceConnectorGroup.go +++ b/service/chime/api_op_DisassociatePhoneNumbersFromVoiceConnectorGroup.go @@ -58,15 +58,15 @@ func (c *Client) DisassociatePhoneNumbersFromVoiceConnectorGroup(ctx context.Con type DisassociatePhoneNumbersFromVoiceConnectorGroupInput struct { - // The Amazon Chime Voice Connector group ID. + // List of phone numbers, in E.164 format. // // This member is required. - VoiceConnectorGroupId *string + E164PhoneNumbers []*string - // List of phone numbers, in E.164 format. + // The Amazon Chime Voice Connector group ID. // // This member is required. - E164PhoneNumbers []*string + VoiceConnectorGroupId *string } type DisassociatePhoneNumbersFromVoiceConnectorGroupOutput struct { diff --git a/service/chime/api_op_GetBot.go b/service/chime/api_op_GetBot.go index a22385231ed..02faba17b43 100644 --- a/service/chime/api_op_GetBot.go +++ b/service/chime/api_op_GetBot.go @@ -58,15 +58,15 @@ func (c *Client) GetBot(ctx context.Context, params *GetBotInput, optFns ...func type GetBotInput struct { - // The bot ID. + // The Amazon Chime account ID. // // This member is required. - BotId *string + AccountId *string - // The Amazon Chime account ID. + // The bot ID. // // This member is required. - AccountId *string + BotId *string } type GetBotOutput struct { diff --git a/service/chime/api_op_GetPhoneNumberSettings.go b/service/chime/api_op_GetPhoneNumberSettings.go index 18d5f6ca7b1..db6943ce73b 100644 --- a/service/chime/api_op_GetPhoneNumberSettings.go +++ b/service/chime/api_op_GetPhoneNumberSettings.go @@ -60,12 +60,12 @@ type GetPhoneNumberSettingsInput struct { type GetPhoneNumberSettingsOutput struct { - // The updated outbound calling name timestamp, in ISO 8601 format. - CallingNameUpdatedTimestamp *time.Time - // The default outbound calling name for the account. CallingName *string + // The updated outbound calling name timestamp, in ISO 8601 format. + CallingNameUpdatedTimestamp *time.Time + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/chime/api_op_GetUser.go b/service/chime/api_op_GetUser.go index fe10b089d60..df2c47d9216 100644 --- a/service/chime/api_op_GetUser.go +++ b/service/chime/api_op_GetUser.go @@ -60,15 +60,15 @@ func (c *Client) GetUser(ctx context.Context, params *GetUserInput, optFns ...fu type GetUserInput struct { - // The user ID. + // The Amazon Chime account ID. // // This member is required. - UserId *string + AccountId *string - // The Amazon Chime account ID. + // The user ID. // // This member is required. - AccountId *string + UserId *string } type GetUserOutput struct { diff --git a/service/chime/api_op_InviteUsers.go b/service/chime/api_op_InviteUsers.go index caaf31191ce..946e01538ea 100644 --- a/service/chime/api_op_InviteUsers.go +++ b/service/chime/api_op_InviteUsers.go @@ -64,13 +64,13 @@ type InviteUsersInput struct { // This member is required. AccountId *string - // The user type. - UserType types.UserType - // The user email addresses to which to send the email invitation. // // This member is required. UserEmailList []*string + + // The user type. + UserType types.UserType } type InviteUsersOutput struct { diff --git a/service/chime/api_op_ListAccounts.go b/service/chime/api_op_ListAccounts.go index f577ae3c63a..3be8fbb141b 100644 --- a/service/chime/api_op_ListAccounts.go +++ b/service/chime/api_op_ListAccounts.go @@ -59,27 +59,27 @@ func (c *Client) ListAccounts(ctx context.Context, params *ListAccountsInput, op type ListAccountsInput struct { - // User email address with which to filter results. - UserEmail *string + // The maximum number of results to return in a single call. Defaults to 100. + MaxResults *int32 // Amazon Chime account name prefix with which to filter results. Name *string - // The maximum number of results to return in a single call. Defaults to 100. - MaxResults *int32 - // The token to use to retrieve the next page of results. NextToken *string + + // User email address with which to filter results. + UserEmail *string } type ListAccountsOutput struct { - // The token to use to retrieve the next page of results. - NextToken *string - // List of Amazon Chime accounts and account details. Accounts []*types.Account + // The token to use to retrieve the next page of results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/chime/api_op_ListAttendees.go b/service/chime/api_op_ListAttendees.go index 482167f60bb..687a10076cf 100644 --- a/service/chime/api_op_ListAttendees.go +++ b/service/chime/api_op_ListAttendees.go @@ -60,14 +60,14 @@ func (c *Client) ListAttendees(ctx context.Context, params *ListAttendeesInput, type ListAttendeesInput struct { - // The maximum number of results to return in a single call. - MaxResults *int32 - // The Amazon Chime SDK meeting ID. // // This member is required. MeetingId *string + // The maximum number of results to return in a single call. + MaxResults *int32 + // The token to use to retrieve the next page of results. NextToken *string } diff --git a/service/chime/api_op_ListBots.go b/service/chime/api_op_ListBots.go index 80532396ea3..67ced600926 100644 --- a/service/chime/api_op_ListBots.go +++ b/service/chime/api_op_ListBots.go @@ -58,16 +58,16 @@ func (c *Client) ListBots(ctx context.Context, params *ListBotsInput, optFns ... type ListBotsInput struct { + // The Amazon Chime account ID. + // + // This member is required. + AccountId *string + // The maximum number of results to return in a single call. The default is 10. MaxResults *int32 // The token to use to retrieve the next page of results. NextToken *string - - // The Amazon Chime account ID. - // - // This member is required. - AccountId *string } type ListBotsOutput struct { diff --git a/service/chime/api_op_ListMeetings.go b/service/chime/api_op_ListMeetings.go index 0bcb4c88235..a42d3ddb4fd 100644 --- a/service/chime/api_op_ListMeetings.go +++ b/service/chime/api_op_ListMeetings.go @@ -59,21 +59,21 @@ func (c *Client) ListMeetings(ctx context.Context, params *ListMeetingsInput, op type ListMeetingsInput struct { - // The token to use to retrieve the next page of results. - NextToken *string - // The maximum number of results to return in a single call. MaxResults *int32 -} - -type ListMeetingsOutput struct { // The token to use to retrieve the next page of results. NextToken *string +} + +type ListMeetingsOutput struct { // The Amazon Chime SDK meeting information. Meetings []*types.Meeting + // The token to use to retrieve the next page of results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/chime/api_op_ListPhoneNumbers.go b/service/chime/api_op_ListPhoneNumbers.go index 15a71edc9a3..6f33ec946ad 100644 --- a/service/chime/api_op_ListPhoneNumbers.go +++ b/service/chime/api_op_ListPhoneNumbers.go @@ -57,33 +57,33 @@ func (c *Client) ListPhoneNumbers(ctx context.Context, params *ListPhoneNumbersI type ListPhoneNumbersInput struct { + // The filter to use to limit the number of results. + FilterName types.PhoneNumberAssociationName + // The value to use for the filter. FilterValue *string - // The filter to use to limit the number of results. - FilterName types.PhoneNumberAssociationName + // The maximum number of results to return in a single call. + MaxResults *int32 + + // The token to use to retrieve the next page of results. + NextToken *string // The phone number product type. ProductType types.PhoneNumberProductType // The phone number status. Status types.PhoneNumberStatus +} - // The maximum number of results to return in a single call. - MaxResults *int32 +type ListPhoneNumbersOutput struct { // The token to use to retrieve the next page of results. NextToken *string -} - -type ListPhoneNumbersOutput struct { // The phone number details. PhoneNumbers []*types.PhoneNumber - // The token to use to retrieve the next page of results. - NextToken *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/chime/api_op_ListProxySessions.go b/service/chime/api_op_ListProxySessions.go index a9f696c4f7f..c11d5866e39 100644 --- a/service/chime/api_op_ListProxySessions.go +++ b/service/chime/api_op_ListProxySessions.go @@ -57,19 +57,19 @@ func (c *Client) ListProxySessions(ctx context.Context, params *ListProxySession type ListProxySessionsInput struct { - // The maximum number of results to return in a single call. - MaxResults *int32 - - // The proxy session status. - Status types.ProxySessionStatus - // The Amazon Chime voice connector ID. // // This member is required. VoiceConnectorId *string + // The maximum number of results to return in a single call. + MaxResults *int32 + // The token to use to retrieve the next page of results. NextToken *string + + // The proxy session status. + Status types.ProxySessionStatus } type ListProxySessionsOutput struct { diff --git a/service/chime/api_op_ListRoomMemberships.go b/service/chime/api_op_ListRoomMemberships.go index eba805ed6c7..1ee2290d5e1 100644 --- a/service/chime/api_op_ListRoomMemberships.go +++ b/service/chime/api_op_ListRoomMemberships.go @@ -63,16 +63,16 @@ type ListRoomMembershipsInput struct { // This member is required. AccountId *string + // The room ID. + // + // This member is required. + RoomId *string + // The maximum number of results to return in a single call. MaxResults *int32 // The token to use to retrieve the next page of results. NextToken *string - - // The room ID. - // - // This member is required. - RoomId *string } type ListRoomMembershipsOutput struct { diff --git a/service/chime/api_op_ListRooms.go b/service/chime/api_op_ListRooms.go index 03823e1c84e..a51ecdb67c6 100644 --- a/service/chime/api_op_ListRooms.go +++ b/service/chime/api_op_ListRooms.go @@ -59,19 +59,19 @@ func (c *Client) ListRooms(ctx context.Context, params *ListRoomsInput, optFns . type ListRoomsInput struct { - // The maximum number of results to return in a single call. - MaxResults *int32 - // The Amazon Chime account ID. // // This member is required. AccountId *string - // The token to use to retrieve the next page of results. - NextToken *string + // The maximum number of results to return in a single call. + MaxResults *int32 // The member ID (user ID or bot ID). MemberId *string + + // The token to use to retrieve the next page of results. + NextToken *string } type ListRoomsOutput struct { diff --git a/service/chime/api_op_ListUsers.go b/service/chime/api_op_ListUsers.go index 6e12cdfdf4d..658b55ff190 100644 --- a/service/chime/api_op_ListUsers.go +++ b/service/chime/api_op_ListUsers.go @@ -59,22 +59,22 @@ func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns . type ListUsersInput struct { + // The Amazon Chime account ID. + // + // This member is required. + AccountId *string + + // The maximum number of results to return in a single call. Defaults to 100. + MaxResults *int32 + // The token to use to retrieve the next page of results. NextToken *string // Optional. The user email address used to filter results. Maximum 1. UserEmail *string - // The Amazon Chime account ID. - // - // This member is required. - AccountId *string - // The user type. UserType types.UserType - - // The maximum number of results to return in a single call. Defaults to 100. - MaxResults *int32 } type ListUsersOutput struct { diff --git a/service/chime/api_op_ListVoiceConnectorGroups.go b/service/chime/api_op_ListVoiceConnectorGroups.go index dfd75b6e5e0..9a1d97475f4 100644 --- a/service/chime/api_op_ListVoiceConnectorGroups.go +++ b/service/chime/api_op_ListVoiceConnectorGroups.go @@ -57,11 +57,11 @@ func (c *Client) ListVoiceConnectorGroups(ctx context.Context, params *ListVoice type ListVoiceConnectorGroupsInput struct { - // The token to use to retrieve the next page of results. - NextToken *string - // The maximum number of results to return in a single call. MaxResults *int32 + + // The token to use to retrieve the next page of results. + NextToken *string } type ListVoiceConnectorGroupsOutput struct { diff --git a/service/chime/api_op_ListVoiceConnectors.go b/service/chime/api_op_ListVoiceConnectors.go index 721ab11b461..9187bac350f 100644 --- a/service/chime/api_op_ListVoiceConnectors.go +++ b/service/chime/api_op_ListVoiceConnectors.go @@ -56,11 +56,11 @@ func (c *Client) ListVoiceConnectors(ctx context.Context, params *ListVoiceConne type ListVoiceConnectorsInput struct { - // The token to use to retrieve the next page of results. - NextToken *string - // The maximum number of results to return in a single call. MaxResults *int32 + + // The token to use to retrieve the next page of results. + NextToken *string } type ListVoiceConnectorsOutput struct { diff --git a/service/chime/api_op_PutEventsConfiguration.go b/service/chime/api_op_PutEventsConfiguration.go index 9b9ad63b974..7360561d6c5 100644 --- a/service/chime/api_op_PutEventsConfiguration.go +++ b/service/chime/api_op_PutEventsConfiguration.go @@ -59,12 +59,6 @@ func (c *Client) PutEventsConfiguration(ctx context.Context, params *PutEventsCo type PutEventsConfigurationInput struct { - // Lambda function ARN that allows the bot to receive outgoing events. - LambdaFunctionArn *string - - // HTTPS endpoint that allows the bot to receive outgoing events. - OutboundEventsHTTPSEndpoint *string - // The Amazon Chime account ID. // // This member is required. @@ -74,6 +68,12 @@ type PutEventsConfigurationInput struct { // // This member is required. BotId *string + + // Lambda function ARN that allows the bot to receive outgoing events. + LambdaFunctionArn *string + + // HTTPS endpoint that allows the bot to receive outgoing events. + OutboundEventsHTTPSEndpoint *string } type PutEventsConfigurationOutput struct { diff --git a/service/chime/api_op_PutRetentionSettings.go b/service/chime/api_op_PutRetentionSettings.go index 3f0169e83c2..f0f91a950a9 100644 --- a/service/chime/api_op_PutRetentionSettings.go +++ b/service/chime/api_op_PutRetentionSettings.go @@ -80,13 +80,13 @@ type PutRetentionSettingsInput struct { type PutRetentionSettingsOutput struct { - // The retention settings. - RetentionSettings *types.RetentionSettings - // The timestamp representing the time at which the specified items are permanently // deleted, in ISO 8601 format. InitiateDeletionTimestamp *time.Time + // The retention settings. + RetentionSettings *types.RetentionSettings + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/chime/api_op_PutVoiceConnectorOrigination.go b/service/chime/api_op_PutVoiceConnectorOrigination.go index ac136543cb0..7aa9a17eb49 100644 --- a/service/chime/api_op_PutVoiceConnectorOrigination.go +++ b/service/chime/api_op_PutVoiceConnectorOrigination.go @@ -59,15 +59,15 @@ func (c *Client) PutVoiceConnectorOrigination(ctx context.Context, params *PutVo type PutVoiceConnectorOriginationInput struct { - // The Amazon Chime Voice Connector ID. + // The origination setting details to add. // // This member is required. - VoiceConnectorId *string + Origination *types.Origination - // The origination setting details to add. + // The Amazon Chime Voice Connector ID. // // This member is required. - Origination *types.Origination + VoiceConnectorId *string } type PutVoiceConnectorOriginationOutput struct { diff --git a/service/chime/api_op_PutVoiceConnectorProxy.go b/service/chime/api_op_PutVoiceConnectorProxy.go index 3a1ef0de876..82a64845295 100644 --- a/service/chime/api_op_PutVoiceConnectorProxy.go +++ b/service/chime/api_op_PutVoiceConnectorProxy.go @@ -58,27 +58,27 @@ func (c *Client) PutVoiceConnectorProxy(ctx context.Context, params *PutVoiceCon type PutVoiceConnectorProxyInput struct { - // When true, stops proxy sessions from being created on the specified Amazon Chime - // Voice Connector. - Disabled *bool - - // The Amazon Chime voice connector ID. - // - // This member is required. - VoiceConnectorId *string - // The default number of minutes allowed for proxy sessions. // // This member is required. DefaultSessionExpiryMinutes *int32 - // The phone number to route calls to after a proxy session expires. - FallBackPhoneNumber *string - // The countries for proxy phone numbers to be selected from. // // This member is required. PhoneNumberPoolCountries []*string + + // The Amazon Chime voice connector ID. + // + // This member is required. + VoiceConnectorId *string + + // When true, stops proxy sessions from being created on the specified Amazon Chime + // Voice Connector. + Disabled *bool + + // The phone number to route calls to after a proxy session expires. + FallBackPhoneNumber *string } type PutVoiceConnectorProxyOutput struct { diff --git a/service/chime/api_op_PutVoiceConnectorStreamingConfiguration.go b/service/chime/api_op_PutVoiceConnectorStreamingConfiguration.go index 45590d8e3b1..6f6e961d91d 100644 --- a/service/chime/api_op_PutVoiceConnectorStreamingConfiguration.go +++ b/service/chime/api_op_PutVoiceConnectorStreamingConfiguration.go @@ -60,15 +60,15 @@ func (c *Client) PutVoiceConnectorStreamingConfiguration(ctx context.Context, pa type PutVoiceConnectorStreamingConfigurationInput struct { - // The Amazon Chime Voice Connector ID. + // The streaming configuration details to add. // // This member is required. - VoiceConnectorId *string + StreamingConfiguration *types.StreamingConfiguration - // The streaming configuration details to add. + // The Amazon Chime Voice Connector ID. // // This member is required. - StreamingConfiguration *types.StreamingConfiguration + VoiceConnectorId *string } type PutVoiceConnectorStreamingConfigurationOutput struct { diff --git a/service/chime/api_op_PutVoiceConnectorTermination.go b/service/chime/api_op_PutVoiceConnectorTermination.go index 6d5ccac8f51..c832a9a79c3 100644 --- a/service/chime/api_op_PutVoiceConnectorTermination.go +++ b/service/chime/api_op_PutVoiceConnectorTermination.go @@ -59,15 +59,15 @@ func (c *Client) PutVoiceConnectorTermination(ctx context.Context, params *PutVo type PutVoiceConnectorTerminationInput struct { - // The Amazon Chime Voice Connector ID. + // The termination setting details to add. // // This member is required. - VoiceConnectorId *string + Termination *types.Termination - // The termination setting details to add. + // The Amazon Chime Voice Connector ID. // // This member is required. - Termination *types.Termination + VoiceConnectorId *string } type PutVoiceConnectorTerminationOutput struct { diff --git a/service/chime/api_op_PutVoiceConnectorTerminationCredentials.go b/service/chime/api_op_PutVoiceConnectorTerminationCredentials.go index 58b51c82051..1fba0498dba 100644 --- a/service/chime/api_op_PutVoiceConnectorTerminationCredentials.go +++ b/service/chime/api_op_PutVoiceConnectorTerminationCredentials.go @@ -57,13 +57,13 @@ func (c *Client) PutVoiceConnectorTerminationCredentials(ctx context.Context, pa type PutVoiceConnectorTerminationCredentialsInput struct { - // The termination SIP credentials. - Credentials []*types.Credential - // The Amazon Chime Voice Connector ID. // // This member is required. VoiceConnectorId *string + + // The termination SIP credentials. + Credentials []*types.Credential } type PutVoiceConnectorTerminationCredentialsOutput struct { diff --git a/service/chime/api_op_RedactConversationMessage.go b/service/chime/api_op_RedactConversationMessage.go index 0e36aa05dd7..97f9d97a925 100644 --- a/service/chime/api_op_RedactConversationMessage.go +++ b/service/chime/api_op_RedactConversationMessage.go @@ -56,6 +56,11 @@ func (c *Client) RedactConversationMessage(ctx context.Context, params *RedactCo type RedactConversationMessageInput struct { + // The Amazon Chime account ID. + // + // This member is required. + AccountId *string + // The conversation ID. // // This member is required. @@ -65,11 +70,6 @@ type RedactConversationMessageInput struct { // // This member is required. MessageId *string - - // The Amazon Chime account ID. - // - // This member is required. - AccountId *string } type RedactConversationMessageOutput struct { diff --git a/service/chime/api_op_RedactRoomMessage.go b/service/chime/api_op_RedactRoomMessage.go index 77b711330ba..ddced83044e 100644 --- a/service/chime/api_op_RedactRoomMessage.go +++ b/service/chime/api_op_RedactRoomMessage.go @@ -56,6 +56,11 @@ func (c *Client) RedactRoomMessage(ctx context.Context, params *RedactRoomMessag type RedactRoomMessageInput struct { + // The Amazon Chime account ID. + // + // This member is required. + AccountId *string + // The message ID. // // This member is required. @@ -65,11 +70,6 @@ type RedactRoomMessageInput struct { // // This member is required. RoomId *string - - // The Amazon Chime account ID. - // - // This member is required. - AccountId *string } type RedactRoomMessageOutput struct { diff --git a/service/chime/api_op_ResetPersonalPIN.go b/service/chime/api_op_ResetPersonalPIN.go index 6d69f682fba..8fb1ac2b32f 100644 --- a/service/chime/api_op_ResetPersonalPIN.go +++ b/service/chime/api_op_ResetPersonalPIN.go @@ -58,15 +58,15 @@ func (c *Client) ResetPersonalPIN(ctx context.Context, params *ResetPersonalPINI type ResetPersonalPINInput struct { - // The user ID. + // The Amazon Chime account ID. // // This member is required. - UserId *string + AccountId *string - // The Amazon Chime account ID. + // The user ID. // // This member is required. - AccountId *string + UserId *string } type ResetPersonalPINOutput struct { diff --git a/service/chime/api_op_SearchAvailablePhoneNumbers.go b/service/chime/api_op_SearchAvailablePhoneNumbers.go index a50e7404101..b62d688cf1b 100644 --- a/service/chime/api_op_SearchAvailablePhoneNumbers.go +++ b/service/chime/api_op_SearchAvailablePhoneNumbers.go @@ -55,26 +55,26 @@ func (c *Client) SearchAvailablePhoneNumbers(ctx context.Context, params *Search type SearchAvailablePhoneNumbersInput struct { - // The token to use to retrieve the next page of results. - NextToken *string + // The area code used to filter results. + AreaCode *string - // The toll-free prefix that you use to filter results. - TollFreePrefix *string + // The city used to filter results. + City *string // The country used to filter results. Country *string - // The city used to filter results. - City *string + // The maximum number of results to return in a single call. + MaxResults *int32 + + // The token to use to retrieve the next page of results. + NextToken *string // The state used to filter results. State *string - // The maximum number of results to return in a single call. - MaxResults *int32 - - // The area code used to filter results. - AreaCode *string + // The toll-free prefix that you use to filter results. + TollFreePrefix *string } type SearchAvailablePhoneNumbersOutput struct { diff --git a/service/chime/api_op_TagAttendee.go b/service/chime/api_op_TagAttendee.go index 48815a74ba7..f8e6e0c05ab 100644 --- a/service/chime/api_op_TagAttendee.go +++ b/service/chime/api_op_TagAttendee.go @@ -57,15 +57,15 @@ func (c *Client) TagAttendee(ctx context.Context, params *TagAttendeeInput, optF type TagAttendeeInput struct { - // The Amazon Chime SDK meeting ID. + // The Amazon Chime SDK attendee ID. // // This member is required. - MeetingId *string + AttendeeId *string - // The Amazon Chime SDK attendee ID. + // The Amazon Chime SDK meeting ID. // // This member is required. - AttendeeId *string + MeetingId *string // The tag key-value pairs. // diff --git a/service/chime/api_op_TagMeeting.go b/service/chime/api_op_TagMeeting.go index ba41d79715e..89b3a51edde 100644 --- a/service/chime/api_op_TagMeeting.go +++ b/service/chime/api_op_TagMeeting.go @@ -57,15 +57,15 @@ func (c *Client) TagMeeting(ctx context.Context, params *TagMeetingInput, optFns type TagMeetingInput struct { - // The tag key-value pairs. + // The Amazon Chime SDK meeting ID. // // This member is required. - Tags []*types.Tag + MeetingId *string - // The Amazon Chime SDK meeting ID. + // The tag key-value pairs. // // This member is required. - MeetingId *string + Tags []*types.Tag } type TagMeetingOutput struct { diff --git a/service/chime/api_op_TagResource.go b/service/chime/api_op_TagResource.go index 3fda53b6c22..a6365e9c892 100644 --- a/service/chime/api_op_TagResource.go +++ b/service/chime/api_op_TagResource.go @@ -57,15 +57,15 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The tag key-value pairs. + // The resource ARN. // // This member is required. - Tags []*types.Tag + ResourceARN *string - // The resource ARN. + // The tag key-value pairs. // // This member is required. - ResourceARN *string + Tags []*types.Tag } type TagResourceOutput struct { diff --git a/service/chime/api_op_UntagAttendee.go b/service/chime/api_op_UntagAttendee.go index b7fa040c847..18914f1af81 100644 --- a/service/chime/api_op_UntagAttendee.go +++ b/service/chime/api_op_UntagAttendee.go @@ -56,11 +56,6 @@ func (c *Client) UntagAttendee(ctx context.Context, params *UntagAttendeeInput, type UntagAttendeeInput struct { - // The tag keys. - // - // This member is required. - TagKeys []*string - // The Amazon Chime SDK attendee ID. // // This member is required. @@ -70,6 +65,11 @@ type UntagAttendeeInput struct { // // This member is required. MeetingId *string + + // The tag keys. + // + // This member is required. + TagKeys []*string } type UntagAttendeeOutput struct { diff --git a/service/chime/api_op_UntagMeeting.go b/service/chime/api_op_UntagMeeting.go index 604571f596b..7f0d81d65b1 100644 --- a/service/chime/api_op_UntagMeeting.go +++ b/service/chime/api_op_UntagMeeting.go @@ -56,15 +56,15 @@ func (c *Client) UntagMeeting(ctx context.Context, params *UntagMeetingInput, op type UntagMeetingInput struct { - // The tag keys. + // The Amazon Chime SDK meeting ID. // // This member is required. - TagKeys []*string + MeetingId *string - // The Amazon Chime SDK meeting ID. + // The tag keys. // // This member is required. - MeetingId *string + TagKeys []*string } type UntagMeetingOutput struct { diff --git a/service/chime/api_op_UpdateAccount.go b/service/chime/api_op_UpdateAccount.go index a0c56466591..6c8e96b6dca 100644 --- a/service/chime/api_op_UpdateAccount.go +++ b/service/chime/api_op_UpdateAccount.go @@ -58,13 +58,13 @@ func (c *Client) UpdateAccount(ctx context.Context, params *UpdateAccountInput, type UpdateAccountInput struct { - // The new name for the specified Amazon Chime account. - Name *string - // The Amazon Chime account ID. // // This member is required. AccountId *string + + // The new name for the specified Amazon Chime account. + Name *string } type UpdateAccountOutput struct { diff --git a/service/chime/api_op_UpdatePhoneNumber.go b/service/chime/api_op_UpdatePhoneNumber.go index 2cfda0641be..80facfc436f 100644 --- a/service/chime/api_op_UpdatePhoneNumber.go +++ b/service/chime/api_op_UpdatePhoneNumber.go @@ -63,16 +63,16 @@ func (c *Client) UpdatePhoneNumber(ctx context.Context, params *UpdatePhoneNumbe type UpdatePhoneNumberInput struct { - // The product type. - ProductType types.PhoneNumberProductType - - // The outbound calling name associated with the phone number. - CallingName *string - // The phone number ID. // // This member is required. PhoneNumberId *string + + // The outbound calling name associated with the phone number. + CallingName *string + + // The product type. + ProductType types.PhoneNumberProductType } type UpdatePhoneNumberOutput struct { diff --git a/service/chime/api_op_UpdateProxySession.go b/service/chime/api_op_UpdateProxySession.go index 553ea107aa1..ae1b9dee557 100644 --- a/service/chime/api_op_UpdateProxySession.go +++ b/service/chime/api_op_UpdateProxySession.go @@ -57,23 +57,23 @@ func (c *Client) UpdateProxySession(ctx context.Context, params *UpdateProxySess type UpdateProxySessionInput struct { - // The proxy session ID. - // - // This member is required. - ProxySessionId *string - // The proxy session capabilities. // // This member is required. Capabilities []types.Capability - // The number of minutes allowed for the proxy session. - ExpiryMinutes *int32 + // The proxy session ID. + // + // This member is required. + ProxySessionId *string // The Amazon Chime voice connector ID. // // This member is required. VoiceConnectorId *string + + // The number of minutes allowed for the proxy session. + ExpiryMinutes *int32 } type UpdateProxySessionOutput struct { diff --git a/service/chime/api_op_UpdateRoomMembership.go b/service/chime/api_op_UpdateRoomMembership.go index f9fc299a4be..2511ac97e99 100644 --- a/service/chime/api_op_UpdateRoomMembership.go +++ b/service/chime/api_op_UpdateRoomMembership.go @@ -60,23 +60,23 @@ func (c *Client) UpdateRoomMembership(ctx context.Context, params *UpdateRoomMem type UpdateRoomMembershipInput struct { - // The member ID. + // The Amazon Chime account ID. // // This member is required. - MemberId *string - - // The role of the member. - Role types.RoomMembershipRole + AccountId *string - // The Amazon Chime account ID. + // The member ID. // // This member is required. - AccountId *string + MemberId *string // The room ID. // // This member is required. RoomId *string + + // The role of the member. + Role types.RoomMembershipRole } type UpdateRoomMembershipOutput struct { diff --git a/service/chime/api_op_UpdateUser.go b/service/chime/api_op_UpdateUser.go index 6c49d1b00ee..f381bf64015 100644 --- a/service/chime/api_op_UpdateUser.go +++ b/service/chime/api_op_UpdateUser.go @@ -58,22 +58,22 @@ func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns type UpdateUserInput struct { + // The Amazon Chime account ID. + // + // This member is required. + AccountId *string + // The user ID. // // This member is required. UserId *string - // The user license type to update. This must be a supported license type for the - // Amazon Chime account that the user belongs to. - LicenseType types.License - // The Alexa for Business metadata. AlexaForBusinessMetadata *types.AlexaForBusinessMetadata - // The Amazon Chime account ID. - // - // This member is required. - AccountId *string + // The user license type to update. This must be a supported license type for the + // Amazon Chime account that the user belongs to. + LicenseType types.License // The user type. UserType types.UserType diff --git a/service/chime/api_op_UpdateUserSettings.go b/service/chime/api_op_UpdateUserSettings.go index b961c5b3ff4..eb6fa0212dc 100644 --- a/service/chime/api_op_UpdateUserSettings.go +++ b/service/chime/api_op_UpdateUserSettings.go @@ -57,6 +57,11 @@ func (c *Client) UpdateUserSettings(ctx context.Context, params *UpdateUserSetti type UpdateUserSettingsInput struct { + // The Amazon Chime account ID. + // + // This member is required. + AccountId *string + // The user ID. // // This member is required. @@ -66,11 +71,6 @@ type UpdateUserSettingsInput struct { // // This member is required. UserSettings *types.UserSettings - - // The Amazon Chime account ID. - // - // This member is required. - AccountId *string } type UpdateUserSettingsOutput struct { diff --git a/service/chime/api_op_UpdateVoiceConnectorGroup.go b/service/chime/api_op_UpdateVoiceConnectorGroup.go index 609198f98a8..1b9249f82b6 100644 --- a/service/chime/api_op_UpdateVoiceConnectorGroup.go +++ b/service/chime/api_op_UpdateVoiceConnectorGroup.go @@ -58,20 +58,20 @@ func (c *Client) UpdateVoiceConnectorGroup(ctx context.Context, params *UpdateVo type UpdateVoiceConnectorGroupInput struct { - // The VoiceConnectorItems to associate with the group. + // The name of the Amazon Chime Voice Connector group. // // This member is required. - VoiceConnectorItems []*types.VoiceConnectorItem + Name *string // The Amazon Chime Voice Connector group ID. // // This member is required. VoiceConnectorGroupId *string - // The name of the Amazon Chime Voice Connector group. + // The VoiceConnectorItems to associate with the group. // // This member is required. - Name *string + VoiceConnectorItems []*types.VoiceConnectorItem } type UpdateVoiceConnectorGroupOutput struct { diff --git a/service/chime/go.mod b/service/chime/go.mod index fa822c9fb45..0acacbf7b91 100644 --- a/service/chime/go.mod +++ b/service/chime/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/chime go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/chime/types/types.go b/service/chime/types/types.go index 4360a69eab7..3fe43a9b6fb 100644 --- a/service/chime/types/types.go +++ b/service/chime/types/types.go @@ -10,38 +10,38 @@ import ( // accounts. type Account struct { - // The default license for the Amazon Chime account. - DefaultLicense License + // The Amazon Chime account ID. + // + // This member is required. + AccountId *string // The AWS account ID. // // This member is required. AwsAccountId *string + // The Amazon Chime account name. + // + // This member is required. + Name *string + // The Amazon Chime account type. For more information about different account // types, see Managing Your Amazon Chime Accounts // (https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) in the // Amazon Chime Administration Guide. AccountType AccountType - // The Amazon Chime account ID. - // - // This member is required. - AccountId *string - - // The Amazon Chime account name. - // - // This member is required. - Name *string - // The Amazon Chime account creation timestamp, in ISO 8601 format. CreatedTimestamp *time.Time - // Supported licenses for the Amazon Chime account. - SupportedLicenses []License + // The default license for the Amazon Chime account. + DefaultLicense License // The sign-in delegate groups associated with the account. SigninDelegateGroups []*SigninDelegateGroup + + // Supported licenses for the Amazon Chime account. + SupportedLicenses []License } // Settings related to the Amazon Chime account. This includes settings that start @@ -65,11 +65,11 @@ type AccountSettings struct { // integrate Alexa for Business with a device. type AlexaForBusinessMetadata struct { - // Starts or stops Alexa for Business. - IsAlexaForBusinessEnabled *bool - // The ARN of the room resource. AlexaForBusinessRoomArn *string + + // Starts or stops Alexa for Business. + IsAlexaForBusinessEnabled *bool } // An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and @@ -84,45 +84,45 @@ type Attendee struct { // The Amazon Chime SDK attendee ID. AttendeeId *string - // The join token used by the Amazon Chime SDK attendee. - JoinToken *string - // The Amazon Chime SDK external user ID. Links the attendee to an identity managed // by a builder application. ExternalUserId *string + + // The join token used by the Amazon Chime SDK attendee. + JoinToken *string } // A resource that allows Enterprise account administrators to configure an // interface to receive events from Amazon Chime. type Bot struct { - // When true, the bot is stopped from running in your account. - Disabled *bool - - // The security token used to authenticate Amazon Chime with the outgoing event - // endpoint. - SecurityToken *string + // The bot email address. + BotEmail *string - // The bot creation timestamp, in ISO 8601 format. - CreatedTimestamp *time.Time + // The bot ID. + BotId *string // The bot type. BotType BotType - // The unique ID for the bot user. - UserId *string + // The bot creation timestamp, in ISO 8601 format. + CreatedTimestamp *time.Time + + // When true, the bot is stopped from running in your account. + Disabled *bool // The bot display name. DisplayName *string + // The security token used to authenticate Amazon Chime with the outgoing event + // endpoint. + SecurityToken *string + // The updated bot timestamp, in ISO 8601 format. UpdatedTimestamp *time.Time - // The bot ID. - BotId *string - - // The bot email address. - BotEmail *string + // The unique ID for the bot user. + UserId *string } // The Amazon Chime Business Calling settings for the administrator's AWS account. @@ -149,12 +149,12 @@ type CreateAttendeeError struct { // The error code. ErrorCode *string + // The error message. + ErrorMessage *string + // The Amazon Chime SDK external user ID. Links the attendee to an identity managed // by a builder application. ExternalUserId *string - - // The error message. - ErrorMessage *string } // The Amazon Chime SDK attendee fields to create, used with the @@ -195,13 +195,13 @@ type DNISEmergencyCallingConfiguration struct { // This member is required. CallingCountry *string - // The DNIS phone number to route test emergency calls to, in E.164 format. - TestPhoneNumber *string - // The DNIS phone number to route emergency calls to, in E.164 format. // // This member is required. EmergencyPhoneNumber *string + + // The DNIS phone number to route test emergency calls to, in E.164 format. + TestPhoneNumber *string } // The emergency calling configuration details associated with an Amazon Chime @@ -217,14 +217,14 @@ type EmergencyCallingConfiguration struct { // HTTPS endpoint or a Lambda function ARN. type EventsConfiguration struct { + // The bot ID. + BotId *string + // Lambda function ARN that allows a bot to receive outgoing events. LambdaFunctionArn *string // HTTPS endpoint that allows a bot to receive outgoing events. OutboundEventsHTTPSEndpoint *string - - // The bot ID. - BotId *string } // The country and area code for a proxy phone number in a proxy phone session. @@ -245,17 +245,17 @@ type GeoMatchParams struct { // Amazon Chime Team account. type Invite struct { + // The email address to which the invite is sent. + EmailAddress *string + // The status of the invite email. EmailStatus EmailStatus - // The status of the invite. - Status InviteStatus - // The invite ID. InviteId *string - // The email address to which the invite is sent. - EmailAddress *string + // The status of the invite. + Status InviteStatus } // The logging configuration associated with an Amazon Chime Voice Connector. @@ -271,14 +271,11 @@ type LoggingConfiguration struct { // Amazon Chime SDK meeting. type MediaPlacement struct { - // The screen viewing URL. - ScreenViewingUrl *string - // The audio fallback URL. AudioFallbackUrl *string - // The turn control URL. - TurnControlUrl *string + // The audio host URL. + AudioHostUrl *string // The screen data URL. ScreenDataUrl *string @@ -286,11 +283,14 @@ type MediaPlacement struct { // The screen sharing URL. ScreenSharingUrl *string - // The audio host URL. - AudioHostUrl *string + // The screen viewing URL. + ScreenViewingUrl *string // The signaling URL. SignalingUrl *string + + // The turn control URL. + TurnControlUrl *string } // A meeting created using the Amazon Chime SDK. @@ -302,14 +302,14 @@ type Meeting struct { // The media placement for the meeting. MediaPlacement *MediaPlacement - // The Amazon Chime SDK meeting ID. - MeetingId *string - // The Region in which to create the meeting. Available values: ap-northeast-1, // ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, // eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, // us-west-2. MediaRegion *string + + // The Amazon Chime SDK meeting ID. + MeetingId *string } // The configuration for resource targets to receive notifications when Amazon @@ -317,28 +317,28 @@ type Meeting struct { // resource targets located in the US East (N. Virginia) AWS Region (us-east-1). type MeetingNotificationConfiguration struct { - // The SQS queue ARN. - SqsQueueArn *string - // The SNS topic ARN. SnsTopicArn *string + + // The SQS queue ARN. + SqsQueueArn *string } // The member details, such as email address, name, member ID, and member type. type Member struct { - // The member email address. - Email *string - - // The member ID (user ID or bot ID). - MemberId *string - // The Amazon Chime account ID. AccountId *string + // The member email address. + Email *string + // The member name. FullName *string + // The member ID (user ID or bot ID). + MemberId *string + // The member type. MemberType MemberType } @@ -349,11 +349,11 @@ type MemberError struct { // The error code. ErrorCode ErrorCode - // The member ID. - MemberId *string - // The error message. ErrorMessage *string + + // The member ID. + MemberId *string } // Membership details, such as member ID and member role. @@ -369,24 +369,24 @@ type MembershipItem struct { // A phone number for which an order has been placed. type OrderedPhoneNumber struct { - // The phone number status. - Status OrderedPhoneNumberStatus - // The phone number, in E.164 format. E164PhoneNumber *string + + // The phone number status. + Status OrderedPhoneNumberStatus } // Origination settings enable your SIP hosts to receive inbound calls using your // Amazon Chime Voice Connector. type Origination struct { - // The call distribution properties defined for your SIP hosts. Valid range: - // Minimum value of 1. Maximum value of 20. - Routes []*OriginationRoute - // When origination settings are disabled, inbound calls are not enabled for your // Amazon Chime Voice Connector. Disabled *bool + + // The call distribution properties defined for your SIP hosts. Valid range: + // Minimum value of 1. Maximum value of 20. + Routes []*OriginationRoute } // Origination routes define call distribution properties for your SIP hosts to @@ -394,75 +394,75 @@ type Origination struct { // origination routes for each Amazon Chime Voice Connector. type OriginationRoute struct { - // The weight associated with the host. If hosts are equal in priority, calls are - // distributed among them based on their relative weight. - Weight *int32 - - // The priority associated with the host, with 1 being the highest priority. Higher - // priority hosts are attempted first. - Priority *int32 + // The FQDN or IP address to contact for origination traffic. + Host *string // The designated origination route port. Defaults to 5060. Port *int32 - // The FQDN or IP address to contact for origination traffic. - Host *string + // The priority associated with the host, with 1 being the highest priority. Higher + // priority hosts are attempted first. + Priority *int32 // The protocol to use for the origination route. Encryption-enabled Amazon Chime // Voice Connectors use TCP protocol by default. Protocol OriginationRouteProtocol + + // The weight associated with the host. If hosts are equal in priority, calls are + // distributed among them based on their relative weight. + Weight *int32 } // The phone number and proxy phone number for a participant in an Amazon Chime // Voice Connector proxy session. type Participant struct { - // The participant's proxy phone number. - ProxyPhoneNumber *string - // The participant's phone number. PhoneNumber *string + + // The participant's proxy phone number. + ProxyPhoneNumber *string } // A phone number used for Amazon Chime Business Calling or an Amazon Chime Voice // Connector. type PhoneNumber struct { - // The phone number creation timestamp, in ISO 8601 format. - CreatedTimestamp *time.Time - - // The updated phone number timestamp, in ISO 8601 format. - UpdatedTimestamp *time.Time - - // The phone number type. - Type PhoneNumberType + // The phone number associations. + Associations []*PhoneNumberAssociation // The outbound calling name associated with the phone number. CallingName *string - // The phone number ID. - PhoneNumberId *string + // The outbound calling name status. + CallingNameStatus CallingNameStatus - // The phone number associations. - Associations []*PhoneNumberAssociation + // The phone number capabilities. + Capabilities *PhoneNumberCapabilities + + // The phone number creation timestamp, in ISO 8601 format. + CreatedTimestamp *time.Time + + // The deleted phone number timestamp, in ISO 8601 format. + DeletionTimestamp *time.Time // The phone number, in E.164 format. E164PhoneNumber *string + // The phone number ID. + PhoneNumberId *string + // The phone number product type. ProductType PhoneNumberProductType - // The outbound calling name status. - CallingNameStatus CallingNameStatus - - // The phone number capabilities. - Capabilities *PhoneNumberCapabilities - // The phone number status. Status PhoneNumberStatus - // The deleted phone number timestamp, in ISO 8601 format. - DeletionTimestamp *time.Time + // The phone number type. + Type PhoneNumberType + + // The updated phone number timestamp, in ISO 8601 format. + UpdatedTimestamp *time.Time } // The phone number associations, such as Amazon Chime account ID, Amazon Chime @@ -473,35 +473,35 @@ type PhoneNumberAssociation struct { // The timestamp of the phone number association, in ISO 8601 format. AssociatedTimestamp *time.Time - // Contains the ID for the entity specified in Name. - Value *string - // Defines the association with an Amazon Chime account ID, user ID, Amazon Chime // Voice Connector ID, or Amazon Chime Voice Connector group ID. Name PhoneNumberAssociationName + + // Contains the ID for the entity specified in Name. + Value *string } // The phone number capabilities for Amazon Chime Business Calling phone numbers, // such as enabled inbound and outbound calling and text messaging. type PhoneNumberCapabilities struct { - // Allows or denies outbound calling for the specified phone number. - OutboundCall *bool + // Allows or denies inbound calling for the specified phone number. + InboundCall *bool + + // Allows or denies inbound MMS messaging for the specified phone number. + InboundMMS *bool // Allows or denies inbound SMS messaging for the specified phone number. InboundSMS *bool - // Allows or denies inbound calling for the specified phone number. - InboundCall *bool - - // Allows or denies outbound SMS messaging for the specified phone number. - OutboundSMS *bool + // Allows or denies outbound calling for the specified phone number. + OutboundCall *bool // Allows or denies outbound MMS messaging for the specified phone number. OutboundMMS *bool - // Allows or denies inbound MMS messaging for the specified phone number. - InboundMMS *bool + // Allows or denies outbound SMS messaging for the specified phone number. + OutboundSMS *bool } // If the phone number action fails for one or more of the phone numbers in the @@ -509,51 +509,51 @@ type PhoneNumberCapabilities struct { // error messages. type PhoneNumberError struct { - // The phone number ID for which the action failed. - PhoneNumberId *string - // The error code. ErrorCode ErrorCode // The error message. ErrorMessage *string + + // The phone number ID for which the action failed. + PhoneNumberId *string } // The details of a phone number order created for Amazon Chime. type PhoneNumberOrder struct { + // The phone number order creation timestamp, in ISO 8601 format. + CreatedTimestamp *time.Time + // The ordered phone number details, such as the phone number in E.164 format and // the phone number status. OrderedPhoneNumbers []*OrderedPhoneNumber - // The updated phone number order timestamp, in ISO 8601 format. - UpdatedTimestamp *time.Time - - // The phone number order creation timestamp, in ISO 8601 format. - CreatedTimestamp *time.Time + // The phone number order ID. + PhoneNumberOrderId *string // The phone number order product type. ProductType PhoneNumberProductType - // The phone number order ID. - PhoneNumberOrderId *string - // The status of the phone number order. Status PhoneNumberOrderStatus + + // The updated phone number order timestamp, in ISO 8601 format. + UpdatedTimestamp *time.Time } // The proxy configuration for an Amazon Chime Voice Connector. type Proxy struct { - // The phone number to route calls to after a proxy session expires. - FallBackPhoneNumber *string + // The default number of minutes allowed for proxy sessions. + DefaultSessionExpiryMinutes *int32 // When true, stops proxy sessions from being created on the specified Amazon Chime // Voice Connector. Disabled *bool - // The default number of minutes allowed for proxy sessions. - DefaultSessionExpiryMinutes *int32 + // The phone number to route calls to after a proxy session expires. + FallBackPhoneNumber *string // The countries for proxy phone numbers to be selected from. PhoneNumberCountries []*string @@ -562,70 +562,70 @@ type Proxy struct { // The proxy session for an Amazon Chime Voice Connector. type ProxySession struct { - // The preference for proxy phone number reuse, or stickiness, between the same - // participants across sessions. - NumberSelectionBehavior NumberSelectionBehavior + // The proxy session capabilities. + Capabilities []Capability - // The name of the proxy session. - Name *string + // The created timestamp, in ISO 8601 format. + CreatedTimestamp *time.Time - // The updated timestamp, in ISO 8601 format. - UpdatedTimestamp *time.Time + // The ended timestamp, in ISO 8601 format. + EndedTimestamp *time.Time - // The status of the proxy session. - Status ProxySessionStatus + // The number of minutes allowed for the proxy session. + ExpiryMinutes *int32 // The preference for matching the country or area code of the proxy phone number // with that of the first participant. GeoMatchLevel GeoMatchLevel - // The proxy session ID. - ProxySessionId *string + // The country and area code for the proxy phone number. + GeoMatchParams *GeoMatchParams - // The number of minutes allowed for the proxy session. - ExpiryMinutes *int32 + // The name of the proxy session. + Name *string - // The Amazon Chime voice connector ID. - VoiceConnectorId *string + // The preference for proxy phone number reuse, or stickiness, between the same + // participants across sessions. + NumberSelectionBehavior NumberSelectionBehavior // The proxy session participants. Participants []*Participant - // The country and area code for the proxy phone number. - GeoMatchParams *GeoMatchParams + // The proxy session ID. + ProxySessionId *string - // The proxy session capabilities. - Capabilities []Capability + // The status of the proxy session. + Status ProxySessionStatus - // The ended timestamp, in ISO 8601 format. - EndedTimestamp *time.Time + // The updated timestamp, in ISO 8601 format. + UpdatedTimestamp *time.Time - // The created timestamp, in ISO 8601 format. - CreatedTimestamp *time.Time + // The Amazon Chime voice connector ID. + VoiceConnectorId *string } // The retention settings for an Amazon Chime Enterprise account that determine how // long to retain items such as chat room messages and chat conversation messages. type RetentionSettings struct { - // The chat room retention settings. - RoomRetentionSettings *RoomRetentionSettings - // The chat conversation retention settings. ConversationRetentionSettings *ConversationRetentionSettings + + // The chat room retention settings. + RoomRetentionSettings *RoomRetentionSettings } // The Amazon Chime chat room details. type Room struct { - // The room creation timestamp, in ISO 8601 format. - CreatedTimestamp *time.Time - // The Amazon Chime account ID. AccountId *string - // The room update timestamp, in ISO 8601 format. - UpdatedTimestamp *time.Time + // The identifier of the room creator. + CreatedBy *string + + // The room creation timestamp, in ISO 8601 format. + CreatedTimestamp *time.Time // The room name. Name *string @@ -633,27 +633,27 @@ type Room struct { // The room ID. RoomId *string - // The identifier of the room creator. - CreatedBy *string + // The room update timestamp, in ISO 8601 format. + UpdatedTimestamp *time.Time } // The room membership details. type RoomMembership struct { - // The membership role. - Role RoomMembershipRole + // The identifier of the user that invited the room member. + InvitedBy *string // The member details, such as email address, name, member ID, and member type. Member *Member + // The membership role. + Role RoomMembershipRole + // The room ID. RoomId *string // The room membership update timestamp, in ISO 8601 format. UpdatedTimestamp *time.Time - - // The identifier of the user that invited the room member. - InvitedBy *string } // The retention settings that determine how long to retain chat room messages for @@ -701,26 +701,21 @@ type StreamingNotificationTarget struct { // Describes a tag applied to a resource. type Tag struct { - // The value of the tag. + // The key of the tag. // // This member is required. - Value *string + Key *string - // The key of the tag. + // The value of the tag. // // This member is required. - Key *string + Value *string } // Settings that allow management of telephony permissions for an Amazon Chime // user, such as inbound and outbound calling and text messaging. type TelephonySettings struct { - // Allows or denies SMS messaging. - // - // This member is required. - SMS *bool - // Allows or denies inbound calling. // // This member is required. @@ -730,6 +725,11 @@ type TelephonySettings struct { // // This member is required. OutboundCalling *bool + + // Allows or denies SMS messaging. + // + // This member is required. + SMS *bool } // Termination settings enable your SIP hosts to make outbound calls using your @@ -740,18 +740,18 @@ type Termination struct { // Required. CallingRegions []*string - // The default caller ID phone number. - DefaultPhoneNumber *string - - // When termination settings are disabled, outbound calls can not be made. - Disabled *bool + // The IP addresses allowed to make calls, in CIDR format. Required. + CidrAllowedList []*string // The limit on calls per second. Max value based on account service quota. Default // value of 1. CpsLimit *int32 - // The IP addresses allowed to make calls, in CIDR format. Required. - CidrAllowedList []*string + // The default caller ID phone number. + DefaultPhoneNumber *string + + // When termination settings are disabled, outbound calls can not be made. + Disabled *bool } // The termination health details, including the source IP address and timestamp of @@ -769,9 +769,6 @@ type TerminationHealth struct { // the BatchUpdatePhoneNumber () and UpdatePhoneNumber () actions. type UpdatePhoneNumberRequestItem struct { - // The product type to update. - ProductType PhoneNumberProductType - // The phone number ID to update. // // This member is required. @@ -779,70 +776,73 @@ type UpdatePhoneNumberRequestItem struct { // The outbound calling name to update. CallingName *string + + // The product type to update. + ProductType PhoneNumberProductType } // The user ID and user fields to update, used with the BatchUpdateUser () action. type UpdateUserRequestItem struct { + // The user ID. + // + // This member is required. + UserId *string + + // The Alexa for Business metadata. + AlexaForBusinessMetadata *AlexaForBusinessMetadata + // The user license type. LicenseType License // The user type. UserType UserType +} - // The Alexa for Business metadata. - AlexaForBusinessMetadata *AlexaForBusinessMetadata +// The user on the Amazon Chime account. +type User struct { // The user ID. // // This member is required. UserId *string -} -// The user on the Amazon Chime account. -type User struct { + // The Amazon Chime account ID. + AccountId *string - // Date and time when the user is invited to the Amazon Chime account, in ISO 8601 - // format. - InvitedOn *time.Time + // The Alexa for Business metadata. + AlexaForBusinessMetadata *AlexaForBusinessMetadata // The display name of the user. DisplayName *string - // Date and time when the user is registered, in ISO 8601 format. - RegisteredOn *time.Time - - // The user's personal meeting PIN. - PersonalPIN *string - - // The user registration status. - UserRegistrationStatus RegistrationStatus - - // The Amazon Chime account ID. - AccountId *string - - // The user ID. - // - // This member is required. - UserId *string + // Date and time when the user is invited to the Amazon Chime account, in ISO 8601 + // format. + InvitedOn *time.Time // The license type for the user. LicenseType License - // The primary phone number associated with the user. - PrimaryProvisionedNumber *string + // The user's personal meeting PIN. + PersonalPIN *string // The primary email address of the user. PrimaryEmail *string - // The Alexa for Business metadata. - AlexaForBusinessMetadata *AlexaForBusinessMetadata + // The primary phone number associated with the user. + PrimaryProvisionedNumber *string - // The user type. - UserType UserType + // Date and time when the user is registered, in ISO 8601 format. + RegisteredOn *time.Time // The user invite status. UserInvitationStatus InviteStatus + + // The user registration status. + UserRegistrationStatus RegistrationStatus + + // The user type. + UserType UserType } // The list of errors returned when errors are encountered during the @@ -850,12 +850,12 @@ type User struct { // includes user IDs, error codes, and error messages. type UserError struct { - // The error message. - ErrorMessage *string - // The error code. ErrorCode ErrorCode + // The error message. + ErrorMessage *string + // The user ID for which the action failed. UserId *string } @@ -874,27 +874,27 @@ type UserSettings struct { // encryption settings. type VoiceConnector struct { - // The Amazon Chime Voice Connector ID. - VoiceConnectorId *string - - // The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format. - CreatedTimestamp *time.Time - - // The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format. - UpdatedTimestamp *time.Time - - // Designates whether encryption is required for the Amazon Chime Voice Connector. - RequireEncryption *bool - // The AWS Region in which the Amazon Chime Voice Connector is created. Default: // us-east-1. AwsRegion VoiceConnectorAwsRegion + // The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format. + CreatedTimestamp *time.Time + // The name of the Amazon Chime Voice Connector. Name *string // The outbound host name for the Amazon Chime Voice Connector. OutboundHostName *string + + // Designates whether encryption is required for the Amazon Chime Voice Connector. + RequireEncryption *bool + + // The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format. + UpdatedTimestamp *time.Time + + // The Amazon Chime Voice Connector ID. + VoiceConnectorId *string } // The Amazon Chime Voice Connector group configuration, including associated @@ -903,20 +903,20 @@ type VoiceConnector struct { // mechanism for fallback in case of availability events. type VoiceConnectorGroup struct { - // The Amazon Chime Voice Connector group ID. - VoiceConnectorGroupId *string + // The Amazon Chime Voice Connector group creation timestamp, in ISO 8601 format. + CreatedTimestamp *time.Time + + // The name of the Amazon Chime Voice Connector group. + Name *string // The updated Amazon Chime Voice Connector group timestamp, in ISO 8601 format. UpdatedTimestamp *time.Time - // The name of the Amazon Chime Voice Connector group. - Name *string + // The Amazon Chime Voice Connector group ID. + VoiceConnectorGroupId *string // The Amazon Chime Voice Connectors to which to route inbound calls. VoiceConnectorItems []*VoiceConnectorItem - - // The Amazon Chime Voice Connector group creation timestamp, in ISO 8601 format. - CreatedTimestamp *time.Time } // For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to diff --git a/service/cloud9/api_op_CreateEnvironmentEC2.go b/service/cloud9/api_op_CreateEnvironmentEC2.go index 35f75865c01..9c69f900e53 100644 --- a/service/cloud9/api_op_CreateEnvironmentEC2.go +++ b/service/cloud9/api_op_CreateEnvironmentEC2.go @@ -59,29 +59,30 @@ func (c *Client) CreateEnvironmentEC2(ctx context.Context, params *CreateEnviron type CreateEnvironmentEC2Input struct { + // The type of instance to connect to the environment (for example, t2.micro). + // + // This member is required. + InstanceType *string + + // The name of the environment to create. This name is visible to other AWS IAM + // users in the same AWS account. + // + // This member is required. + Name *string + + // The number of minutes until the running instance is shut down after the + // environment has last been used. + AutomaticStopTimeMinutes *int32 + // A unique, case-sensitive string that helps AWS Cloud9 to ensure this operation // completes no more than one time. For more information, see Client Tokens // (http://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) // in the Amazon EC2 API Reference. ClientRequestToken *string - // An array of key-value pairs that will be associated with the new AWS Cloud9 - // development environment. - Tags []*types.Tag - // The description of the environment to create. Description *string - // The number of minutes until the running instance is shut down after the - // environment has last been used. - AutomaticStopTimeMinutes *int32 - - // The name of the environment to create. This name is visible to other AWS IAM - // users in the same AWS account. - // - // This member is required. - Name *string - // The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN // of any AWS IAM principal. If this value is not specified, the ARN defaults to // this environment's creator. @@ -91,10 +92,9 @@ type CreateEnvironmentEC2Input struct { // the Amazon EC2 instance. SubnetId *string - // The type of instance to connect to the environment (for example, t2.micro). - // - // This member is required. - InstanceType *string + // An array of key-value pairs that will be associated with the new AWS Cloud9 + // development environment. + Tags []*types.Tag } type CreateEnvironmentEC2Output struct { diff --git a/service/cloud9/api_op_CreateEnvironmentMembership.go b/service/cloud9/api_op_CreateEnvironmentMembership.go index 3b51941bf7e..78e62cde7b9 100644 --- a/service/cloud9/api_op_CreateEnvironmentMembership.go +++ b/service/cloud9/api_op_CreateEnvironmentMembership.go @@ -57,11 +57,6 @@ func (c *Client) CreateEnvironmentMembership(ctx context.Context, params *Create type CreateEnvironmentMembershipInput struct { - // The Amazon Resource Name (ARN) of the environment member you want to add. - // - // This member is required. - UserArn *string - // The ID of the environment that contains the environment member you want to add. // // This member is required. @@ -78,6 +73,11 @@ type CreateEnvironmentMembershipInput struct { // // This member is required. Permissions types.MemberPermissions + + // The Amazon Resource Name (ARN) of the environment member you want to add. + // + // This member is required. + UserArn *string } type CreateEnvironmentMembershipOutput struct { diff --git a/service/cloud9/api_op_DeleteEnvironmentMembership.go b/service/cloud9/api_op_DeleteEnvironmentMembership.go index 032c09ffc24..af64ab4cd97 100644 --- a/service/cloud9/api_op_DeleteEnvironmentMembership.go +++ b/service/cloud9/api_op_DeleteEnvironmentMembership.go @@ -56,16 +56,16 @@ func (c *Client) DeleteEnvironmentMembership(ctx context.Context, params *Delete type DeleteEnvironmentMembershipInput struct { - // The Amazon Resource Name (ARN) of the environment member to delete from the - // environment. + // The ID of the environment to delete the environment member from. // // This member is required. - UserArn *string + EnvironmentId *string - // The ID of the environment to delete the environment member from. + // The Amazon Resource Name (ARN) of the environment member to delete from the + // environment. // // This member is required. - EnvironmentId *string + UserArn *string } type DeleteEnvironmentMembershipOutput struct { diff --git a/service/cloud9/api_op_DescribeEnvironmentMemberships.go b/service/cloud9/api_op_DescribeEnvironmentMemberships.go index 0656220aa77..e237a12842a 100644 --- a/service/cloud9/api_op_DescribeEnvironmentMemberships.go +++ b/service/cloud9/api_op_DescribeEnvironmentMemberships.go @@ -57,6 +57,20 @@ func (c *Client) DescribeEnvironmentMemberships(ctx context.Context, params *Des type DescribeEnvironmentMembershipsInput struct { + // The ID of the environment to get environment member information about. + EnvironmentId *string + + // The maximum number of environment members to get information about. + MaxResults *int32 + + // During a previous call, if there are more than 25 items in the list, only the + // first 25 items are returned, along with a unique string called a next token. To + // get the next batch of items in the list, call this operation again, adding the + // next token to the call. To get all of the items in the list, keep calling this + // operation with each subsequent next token that is returned, until no more next + // tokens are returned. + NextToken *string + // The type of environment member permissions to get information about. Available // values include: // @@ -72,24 +86,10 @@ type DescribeEnvironmentMembershipsInput struct { // members are returned. Permissions []types.Permissions - // The maximum number of environment members to get information about. - MaxResults *int32 - // The Amazon Resource Name (ARN) of an individual environment member to get // information about. If no value is specified, information about all environment // members are returned. UserArn *string - - // During a previous call, if there are more than 25 items in the list, only the - // first 25 items are returned, along with a unique string called a next token. To - // get the next batch of items in the list, call this operation again, adding the - // next token to the call. To get all of the items in the list, keep calling this - // operation with each subsequent next token that is returned, until no more next - // tokens are returned. - NextToken *string - - // The ID of the environment to get environment member information about. - EnvironmentId *string } type DescribeEnvironmentMembershipsOutput struct { diff --git a/service/cloud9/api_op_ListEnvironments.go b/service/cloud9/api_op_ListEnvironments.go index 3dbb8e76c10..a2782d72420 100644 --- a/service/cloud9/api_op_ListEnvironments.go +++ b/service/cloud9/api_op_ListEnvironments.go @@ -55,6 +55,9 @@ func (c *Client) ListEnvironments(ctx context.Context, params *ListEnvironmentsI type ListEnvironmentsInput struct { + // The maximum number of environments to get identifiers for. + MaxResults *int32 + // During a previous call, if there are more than 25 items in the list, only the // first 25 items are returned, along with a unique string called a next token. To // get the next batch of items in the list, call this operation again, adding the @@ -62,22 +65,19 @@ type ListEnvironmentsInput struct { // operation with each subsequent next token that is returned, until no more next // tokens are returned. NextToken *string - - // The maximum number of environments to get identifiers for. - MaxResults *int32 } type ListEnvironmentsOutput struct { + // The list of environment identifiers. + EnvironmentIds []*string + // If there are more than 25 items in the list, only the first 25 items are // returned, along with a unique string called a next token. To get the next batch // of items in the list, call this operation again, adding the next token to the // call. NextToken *string - // The list of environment identifiers. - EnvironmentIds []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloud9/api_op_TagResource.go b/service/cloud9/api_op_TagResource.go index 37dc11d1f24..15bcda96fe7 100644 --- a/service/cloud9/api_op_TagResource.go +++ b/service/cloud9/api_op_TagResource.go @@ -59,16 +59,16 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The list of tags to add to the given AWS Cloud9 development environment. - // - // This member is required. - Tags []*types.Tag - // The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to add // tags to. // // This member is required. ResourceARN *string + + // The list of tags to add to the given AWS Cloud9 development environment. + // + // This member is required. + Tags []*types.Tag } type TagResourceOutput struct { diff --git a/service/cloud9/api_op_UpdateEnvironmentMembership.go b/service/cloud9/api_op_UpdateEnvironmentMembership.go index c6ed0852351..7e4fa533aff 100644 --- a/service/cloud9/api_op_UpdateEnvironmentMembership.go +++ b/service/cloud9/api_op_UpdateEnvironmentMembership.go @@ -58,11 +58,11 @@ func (c *Client) UpdateEnvironmentMembership(ctx context.Context, params *Update type UpdateEnvironmentMembershipInput struct { - // The Amazon Resource Name (ARN) of the environment member whose settings you want - // to change. + // The ID of the environment for the environment member whose settings you want to + // change. // // This member is required. - UserArn *string + EnvironmentId *string // The replacement type of environment member permissions you want to associate // with this environment member. Available values include: @@ -76,11 +76,11 @@ type UpdateEnvironmentMembershipInput struct { // This member is required. Permissions types.MemberPermissions - // The ID of the environment for the environment member whose settings you want to - // change. + // The Amazon Resource Name (ARN) of the environment member whose settings you want + // to change. // // This member is required. - EnvironmentId *string + UserArn *string } type UpdateEnvironmentMembershipOutput struct { diff --git a/service/cloud9/go.mod b/service/cloud9/go.mod index ed87f50a964..f498787e317 100644 --- a/service/cloud9/go.mod +++ b/service/cloud9/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/cloud9 go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/cloud9/types/types.go b/service/cloud9/types/types.go index 674692da831..6b60267f6a9 100644 --- a/service/cloud9/types/types.go +++ b/service/cloud9/types/types.go @@ -12,9 +12,21 @@ type Environment struct { // The Amazon Resource Name (ARN) of the environment. Arn *string + // The description for the environment. + Description *string + + // The ID of the environment. + Id *string + // The state of the environment in its creation or deletion lifecycle. Lifecycle *EnvironmentLifecycle + // The name of the environment. + Name *string + + // The Amazon Resource Name (ARN) of the environment owner. + OwnerArn *string + // The type of environment. Valid values include the following: // // * ec2: An @@ -23,24 +35,19 @@ type Environment struct { // // * ssh: Your own server connects to the environment. Type EnvironmentType - - // The description for the environment. - Description *string - - // The name of the environment. - Name *string - - // The Amazon Resource Name (ARN) of the environment owner. - OwnerArn *string - - // The ID of the environment. - Id *string } // Information about the current creation or deletion lifecycle state of an AWS // Cloud9 development environment. type EnvironmentLifecycle struct { + // If the environment failed to delete, the Amazon Resource Name (ARN) of the + // related AWS resource. + FailureResource *string + + // Any informational message about the lifecycle state of the environment. + Reason *string + // The current creation or deletion lifecycle state of the environment. // // * @@ -57,33 +64,19 @@ type EnvironmentLifecycle struct { // // * DELETE_FAILED: The environment failed to delete. Status EnvironmentLifecycleStatus - - // If the environment failed to delete, the Amazon Resource Name (ARN) of the - // related AWS resource. - FailureResource *string - - // Any informational message about the lifecycle state of the environment. - Reason *string } // Information about an environment member for an AWS Cloud9 development // environment. type EnvironmentMember struct { - // The user ID in AWS Identity and Access Management (AWS IAM) of the environment - // member. - UserId *string + // The ID of the environment for the environment member. + EnvironmentId *string // The time, expressed in epoch time format, when the environment member last // opened the environment. LastAccess *time.Time - // The ID of the environment for the environment member. - EnvironmentId *string - - // The Amazon Resource Name (ARN) of the environment member. - UserArn *string - // The type of environment member permissions associated with this environment // member. Available values include: // @@ -95,6 +88,13 @@ type EnvironmentMember struct { // * read-write: Has // read-write access to the environment. Permissions Permissions + + // The Amazon Resource Name (ARN) of the environment member. + UserArn *string + + // The user ID in AWS Identity and Access Management (AWS IAM) of the environment + // member. + UserId *string } // Metadata that is associated with AWS resources. In particular, a name-value pair @@ -104,13 +104,13 @@ type EnvironmentMember struct { // with "aws:" and cannot be modified by the user. type Tag struct { - // The value part of a tag. + // The name part of a tag. // // This member is required. - Value *string + Key *string - // The name part of a tag. + // The value part of a tag. // // This member is required. - Key *string + Value *string } diff --git a/service/clouddirectory/api_op_AddFacetToObject.go b/service/clouddirectory/api_op_AddFacetToObject.go index 06c6bc6039b..747c81a690a 100644 --- a/service/clouddirectory/api_op_AddFacetToObject.go +++ b/service/clouddirectory/api_op_AddFacetToObject.go @@ -58,25 +58,25 @@ func (c *Client) AddFacetToObject(ctx context.Context, params *AddFacetToObjectI type AddFacetToObjectInput struct { - // Identifiers for the facet that you are adding to the object. See SchemaFacet () - // for details. + // The Amazon Resource Name (ARN) that is associated with the Directory () where + // the object resides. For more information, see arns (). // // This member is required. - SchemaFacet *types.SchemaFacet + DirectoryArn *string // A reference to the object you are adding the specified facet to. // // This member is required. ObjectReference *types.ObjectReference - // Attributes on the facet that you are adding to the object. - ObjectAttributeList []*types.AttributeKeyAndValue - - // The Amazon Resource Name (ARN) that is associated with the Directory () where - // the object resides. For more information, see arns (). + // Identifiers for the facet that you are adding to the object. See SchemaFacet () + // for details. // // This member is required. - DirectoryArn *string + SchemaFacet *types.SchemaFacet + + // Attributes on the facet that you are adding to the object. + ObjectAttributeList []*types.AttributeKeyAndValue } type AddFacetToObjectOutput struct { diff --git a/service/clouddirectory/api_op_ApplySchema.go b/service/clouddirectory/api_op_ApplySchema.go index 2cf6e82c6a2..42cf9a95997 100644 --- a/service/clouddirectory/api_op_ApplySchema.go +++ b/service/clouddirectory/api_op_ApplySchema.go @@ -57,17 +57,17 @@ func (c *Client) ApplySchema(ctx context.Context, params *ApplySchemaInput, optF type ApplySchemaInput struct { - // Published schema Amazon Resource Name (ARN) that needs to be copied. For more - // information, see arns (). - // - // This member is required. - PublishedSchemaArn *string - // The Amazon Resource Name (ARN) that is associated with the Directory () into // which the schema is copied. For more information, see arns (). // // This member is required. DirectoryArn *string + + // Published schema Amazon Resource Name (ARN) that needs to be copied. For more + // information, see arns (). + // + // This member is required. + PublishedSchemaArn *string } type ApplySchemaOutput struct { diff --git a/service/clouddirectory/api_op_AttachObject.go b/service/clouddirectory/api_op_AttachObject.go index 1f6a66866ec..342fc6b0b80 100644 --- a/service/clouddirectory/api_op_AttachObject.go +++ b/service/clouddirectory/api_op_AttachObject.go @@ -62,6 +62,11 @@ func (c *Client) AttachObject(ctx context.Context, params *AttachObjectInput, op type AttachObjectInput struct { + // The child object reference to be attached to the object. + // + // This member is required. + ChildReference *types.ObjectReference + // Amazon Resource Name (ARN) that is associated with the Directory () where both // objects reside. For more information, see arns (). // @@ -73,11 +78,6 @@ type AttachObjectInput struct { // This member is required. LinkName *string - // The child object reference to be attached to the object. - // - // This member is required. - ChildReference *types.ObjectReference - // The parent object reference. // // This member is required. diff --git a/service/clouddirectory/api_op_AttachPolicy.go b/service/clouddirectory/api_op_AttachPolicy.go index 812692939ea..012675b47bf 100644 --- a/service/clouddirectory/api_op_AttachPolicy.go +++ b/service/clouddirectory/api_op_AttachPolicy.go @@ -64,15 +64,15 @@ type AttachPolicyInput struct { // This member is required. DirectoryArn *string - // The reference that is associated with the policy object. + // The reference that identifies the object to which the policy will be attached. // // This member is required. - PolicyReference *types.ObjectReference + ObjectReference *types.ObjectReference - // The reference that identifies the object to which the policy will be attached. + // The reference that is associated with the policy object. // // This member is required. - ObjectReference *types.ObjectReference + PolicyReference *types.ObjectReference } type AttachPolicyOutput struct { diff --git a/service/clouddirectory/api_op_AttachToIndex.go b/service/clouddirectory/api_op_AttachToIndex.go index 7e752a05b2b..5bc7511f1b1 100644 --- a/service/clouddirectory/api_op_AttachToIndex.go +++ b/service/clouddirectory/api_op_AttachToIndex.go @@ -63,15 +63,15 @@ type AttachToIndexInput struct { // This member is required. DirectoryArn *string - // A reference to the object that you are attaching to the index. + // A reference to the index that you are attaching the object to. // // This member is required. - TargetReference *types.ObjectReference + IndexReference *types.ObjectReference - // A reference to the index that you are attaching the object to. + // A reference to the object that you are attaching to the index. // // This member is required. - IndexReference *types.ObjectReference + TargetReference *types.ObjectReference } type AttachToIndexOutput struct { diff --git a/service/clouddirectory/api_op_AttachTypedLink.go b/service/clouddirectory/api_op_AttachTypedLink.go index 51d85c96de8..94b5ca155eb 100644 --- a/service/clouddirectory/api_op_AttachTypedLink.go +++ b/service/clouddirectory/api_op_AttachTypedLink.go @@ -59,15 +59,10 @@ func (c *Client) AttachTypedLink(ctx context.Context, params *AttachTypedLinkInp type AttachTypedLinkInput struct { - // Identifies the typed link facet that is associated with the typed link. - // - // This member is required. - TypedLinkFacet *types.TypedLinkSchemaAndFacetName - - // Identifies the source object that the typed link will attach to. + // A set of attributes that are associated with the typed link. // // This member is required. - SourceObjectReference *types.ObjectReference + Attributes []*types.AttributeNameAndValue // The Amazon Resource Name (ARN) of the directory where you want to attach the // typed link. @@ -75,15 +70,20 @@ type AttachTypedLinkInput struct { // This member is required. DirectoryArn *string - // A set of attributes that are associated with the typed link. + // Identifies the source object that the typed link will attach to. // // This member is required. - Attributes []*types.AttributeNameAndValue + SourceObjectReference *types.ObjectReference // Identifies the target object that the typed link will attach to. // // This member is required. TargetObjectReference *types.ObjectReference + + // Identifies the typed link facet that is associated with the typed link. + // + // This member is required. + TypedLinkFacet *types.TypedLinkSchemaAndFacetName } type AttachTypedLinkOutput struct { diff --git a/service/clouddirectory/api_op_BatchRead.go b/service/clouddirectory/api_op_BatchRead.go index afa42a984d0..83749a5aa97 100644 --- a/service/clouddirectory/api_op_BatchRead.go +++ b/service/clouddirectory/api_op_BatchRead.go @@ -63,14 +63,14 @@ type BatchReadInput struct { // This member is required. DirectoryArn *string - // Represents the manner and timing in which the successful write or update of an - // object is reflected in a subsequent read operation of that same object. - ConsistencyLevel types.ConsistencyLevel - // A list of operations that are part of the batch. // // This member is required. Operations []*types.BatchReadOperation + + // Represents the manner and timing in which the successful write or update of an + // object is reflected in a subsequent read operation of that same object. + ConsistencyLevel types.ConsistencyLevel } type BatchReadOutput struct { diff --git a/service/clouddirectory/api_op_CreateDirectory.go b/service/clouddirectory/api_op_CreateDirectory.go index b26cb099435..cec8d9a56c7 100644 --- a/service/clouddirectory/api_op_CreateDirectory.go +++ b/service/clouddirectory/api_op_CreateDirectory.go @@ -61,25 +61,20 @@ func (c *Client) CreateDirectory(ctx context.Context, params *CreateDirectoryInp type CreateDirectoryInput struct { - // The Amazon Resource Name (ARN) of the published schema that will be copied into - // the data Directory (). For more information, see arns (). + // The name of the Directory (). Should be unique per account, per region. // // This member is required. - SchemaArn *string + Name *string - // The name of the Directory (). Should be unique per account, per region. + // The Amazon Resource Name (ARN) of the published schema that will be copied into + // the data Directory (). For more information, see arns (). // // This member is required. - Name *string + SchemaArn *string } type CreateDirectoryOutput struct { - // The name of the Directory (). - // - // This member is required. - Name *string - // The ARN of the published schema in the Directory (). Once a published schema is // copied into the directory, it has its own ARN, which is referred to applied // schema ARN. For more information, see arns (). @@ -93,6 +88,11 @@ type CreateDirectoryOutput struct { // This member is required. DirectoryArn *string + // The name of the Directory (). + // + // This member is required. + Name *string + // The root object node of the created directory. // // This member is required. diff --git a/service/clouddirectory/api_op_CreateFacet.go b/service/clouddirectory/api_op_CreateFacet.go index 33b224ddbc1..b13a22fc0a1 100644 --- a/service/clouddirectory/api_op_CreateFacet.go +++ b/service/clouddirectory/api_op_CreateFacet.go @@ -58,25 +58,25 @@ func (c *Client) CreateFacet(ctx context.Context, params *CreateFacetInput, optF type CreateFacetInput struct { + // The name of the Facet (), which is unique for a given schema. + // + // This member is required. + Name *string + // The schema ARN in which the new Facet () will be created. For more information, // see arns (). // // This member is required. SchemaArn *string + // The attributes that are associated with the Facet (). + Attributes []*types.FacetAttribute + // There are two different styles that you can define on any given facet, Static // and Dynamic. For static facets, all attributes must be defined in the schema. // For dynamic facets, attributes can be defined during data plane operations. FacetStyle types.FacetStyle - // The name of the Facet (), which is unique for a given schema. - // - // This member is required. - Name *string - - // The attributes that are associated with the Facet (). - Attributes []*types.FacetAttribute - // Specifies whether a given object created from this facet is of type node, leaf // node, policy or index. // diff --git a/service/clouddirectory/api_op_CreateIndex.go b/service/clouddirectory/api_op_CreateIndex.go index 0e813a84471..de14f904f05 100644 --- a/service/clouddirectory/api_op_CreateIndex.go +++ b/service/clouddirectory/api_op_CreateIndex.go @@ -59,18 +59,6 @@ func (c *Client) CreateIndex(ctx context.Context, params *CreateIndexInput, optF type CreateIndexInput struct { - // Specifies the attributes that should be indexed on. Currently only a single - // attribute is supported. - // - // This member is required. - OrderedIndexedAttributeList []*types.AttributeKey - - // A reference to the parent object that contains the index object. - ParentReference *types.ObjectReference - - // The name of the link between the parent object and the index object. - LinkName *string - // The ARN of the directory where the index should be created. // // This member is required. @@ -80,6 +68,18 @@ type CreateIndexInput struct { // // This member is required. IsUnique *bool + + // Specifies the attributes that should be indexed on. Currently only a single + // attribute is supported. + // + // This member is required. + OrderedIndexedAttributeList []*types.AttributeKey + + // The name of the link between the parent object and the index object. + LinkName *string + + // A reference to the parent object that contains the index object. + ParentReference *types.ObjectReference } type CreateIndexOutput struct { diff --git a/service/clouddirectory/api_op_CreateObject.go b/service/clouddirectory/api_op_CreateObject.go index 4322a794767..44abc11a133 100644 --- a/service/clouddirectory/api_op_CreateObject.go +++ b/service/clouddirectory/api_op_CreateObject.go @@ -66,21 +66,21 @@ type CreateObjectInput struct { // This member is required. DirectoryArn *string - // The name of link that is used to attach this object to a parent. - LinkName *string - - // If specified, the parent reference to which this object will be attached. - ParentReference *types.ObjectReference - // A list of schema facets to be associated with the object. Do not provide minor // version components. See SchemaFacet () for details. // // This member is required. SchemaFacets []*types.SchemaFacet + // The name of link that is used to attach this object to a parent. + LinkName *string + // The attribute map whose attribute ARN contains the key and attribute value as // the map value. ObjectAttributeList []*types.AttributeKeyAndValue + + // If specified, the parent reference to which this object will be attached. + ParentReference *types.ObjectReference } type CreateObjectOutput struct { diff --git a/service/clouddirectory/api_op_DetachFromIndex.go b/service/clouddirectory/api_op_DetachFromIndex.go index 9ce2c18153f..8646d9ff2da 100644 --- a/service/clouddirectory/api_op_DetachFromIndex.go +++ b/service/clouddirectory/api_op_DetachFromIndex.go @@ -62,15 +62,15 @@ type DetachFromIndexInput struct { // This member is required. DirectoryArn *string - // A reference to the object being detached from the index. + // A reference to the index object. // // This member is required. - TargetReference *types.ObjectReference + IndexReference *types.ObjectReference - // A reference to the index object. + // A reference to the object being detached from the index. // // This member is required. - IndexReference *types.ObjectReference + TargetReference *types.ObjectReference } type DetachFromIndexOutput struct { diff --git a/service/clouddirectory/api_op_DetachObject.go b/service/clouddirectory/api_op_DetachObject.go index a73bed676d4..cbcbf1532a5 100644 --- a/service/clouddirectory/api_op_DetachObject.go +++ b/service/clouddirectory/api_op_DetachObject.go @@ -58,17 +58,17 @@ func (c *Client) DetachObject(ctx context.Context, params *DetachObjectInput, op type DetachObjectInput struct { - // The link name associated with the object that needs to be detached. - // - // This member is required. - LinkName *string - // The Amazon Resource Name (ARN) that is associated with the Directory () where // objects reside. For more information, see arns (). // // This member is required. DirectoryArn *string + // The link name associated with the object that needs to be detached. + // + // This member is required. + LinkName *string + // The parent reference from which the object with the specified link name is // detached. // diff --git a/service/clouddirectory/api_op_DetachPolicy.go b/service/clouddirectory/api_op_DetachPolicy.go index 6160a3f1458..2a182dbc7df 100644 --- a/service/clouddirectory/api_op_DetachPolicy.go +++ b/service/clouddirectory/api_op_DetachPolicy.go @@ -57,6 +57,12 @@ func (c *Client) DetachPolicy(ctx context.Context, params *DetachPolicyInput, op type DetachPolicyInput struct { + // The Amazon Resource Name (ARN) that is associated with the Directory () where + // both objects reside. For more information, see arns (). + // + // This member is required. + DirectoryArn *string + // Reference that identifies the object whose policy object will be detached. // // This member is required. @@ -66,12 +72,6 @@ type DetachPolicyInput struct { // // This member is required. PolicyReference *types.ObjectReference - - // The Amazon Resource Name (ARN) that is associated with the Directory () where - // both objects reside. For more information, see arns (). - // - // This member is required. - DirectoryArn *string } type DetachPolicyOutput struct { diff --git a/service/clouddirectory/api_op_DetachTypedLink.go b/service/clouddirectory/api_op_DetachTypedLink.go index e719886aaec..9c418ba1e7f 100644 --- a/service/clouddirectory/api_op_DetachTypedLink.go +++ b/service/clouddirectory/api_op_DetachTypedLink.go @@ -59,16 +59,16 @@ func (c *Client) DetachTypedLink(ctx context.Context, params *DetachTypedLinkInp type DetachTypedLinkInput struct { - // Used to accept a typed link specifier as input. - // - // This member is required. - TypedLinkSpecifier *types.TypedLinkSpecifier - // The Amazon Resource Name (ARN) of the directory where you want to detach the // typed link. // // This member is required. DirectoryArn *string + + // Used to accept a typed link specifier as input. + // + // This member is required. + TypedLinkSpecifier *types.TypedLinkSpecifier } type DetachTypedLinkOutput struct { diff --git a/service/clouddirectory/api_op_GetFacet.go b/service/clouddirectory/api_op_GetFacet.go index 6241617af1b..cec01b28cbc 100644 --- a/service/clouddirectory/api_op_GetFacet.go +++ b/service/clouddirectory/api_op_GetFacet.go @@ -59,16 +59,16 @@ func (c *Client) GetFacet(ctx context.Context, params *GetFacetInput, optFns ... type GetFacetInput struct { - // The Amazon Resource Name (ARN) that is associated with the Facet (). For more - // information, see arns (). + // The name of the facet to retrieve. // // This member is required. - SchemaArn *string + Name *string - // The name of the facet to retrieve. + // The Amazon Resource Name (ARN) that is associated with the Facet (). For more + // information, see arns (). // // This member is required. - Name *string + SchemaArn *string } type GetFacetOutput struct { diff --git a/service/clouddirectory/api_op_GetLinkAttributes.go b/service/clouddirectory/api_op_GetLinkAttributes.go index c46ad31a4fa..dc0de91861a 100644 --- a/service/clouddirectory/api_op_GetLinkAttributes.go +++ b/service/clouddirectory/api_op_GetLinkAttributes.go @@ -62,9 +62,6 @@ type GetLinkAttributesInput struct { // This member is required. AttributeNames []*string - // The consistency level at which to retrieve the attributes on a typed link. - ConsistencyLevel types.ConsistencyLevel - // The Amazon Resource Name (ARN) that is associated with the Directory where the // typed link resides. For more information, see arns () or Typed Links // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). @@ -76,6 +73,9 @@ type GetLinkAttributesInput struct { // // This member is required. TypedLinkSpecifier *types.TypedLinkSpecifier + + // The consistency level at which to retrieve the attributes on a typed link. + ConsistencyLevel types.ConsistencyLevel } type GetLinkAttributesOutput struct { diff --git a/service/clouddirectory/api_op_GetObjectInformation.go b/service/clouddirectory/api_op_GetObjectInformation.go index a350b487e15..784c799e8d7 100644 --- a/service/clouddirectory/api_op_GetObjectInformation.go +++ b/service/clouddirectory/api_op_GetObjectInformation.go @@ -57,6 +57,11 @@ func (c *Client) GetObjectInformation(ctx context.Context, params *GetObjectInfo type GetObjectInformationInput struct { + // The ARN of the directory being retrieved. + // + // This member is required. + DirectoryArn *string + // A reference to the object. // // This member is required. @@ -64,23 +69,18 @@ type GetObjectInformationInput struct { // The consistency level at which to retrieve the object information. ConsistencyLevel types.ConsistencyLevel - - // The ARN of the directory being retrieved. - // - // This member is required. - DirectoryArn *string } type GetObjectInformationOutput struct { + // The ObjectIdentifier of the specified object. + ObjectIdentifier *string + // The facets attached to the specified object. Although the response does not // include minor version information, the most recently applied minor version of // each Facet is in effect. See GetAppliedSchemaVersion () for details. SchemaFacets []*types.SchemaFacet - // The ObjectIdentifier of the specified object. - ObjectIdentifier *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/clouddirectory/api_op_GetSchemaAsJson.go b/service/clouddirectory/api_op_GetSchemaAsJson.go index 1d67ecd218d..a299de81855 100644 --- a/service/clouddirectory/api_op_GetSchemaAsJson.go +++ b/service/clouddirectory/api_op_GetSchemaAsJson.go @@ -66,12 +66,12 @@ type GetSchemaAsJsonInput struct { type GetSchemaAsJsonOutput struct { - // The name of the retrieved schema. - Name *string - // The JSON representation of the schema document. Document *string + // The name of the retrieved schema. + Name *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/clouddirectory/api_op_GetTypedLinkFacetInformation.go b/service/clouddirectory/api_op_GetTypedLinkFacetInformation.go index cbaf6e9bac4..90908dacc81 100644 --- a/service/clouddirectory/api_op_GetTypedLinkFacetInformation.go +++ b/service/clouddirectory/api_op_GetTypedLinkFacetInformation.go @@ -58,16 +58,16 @@ func (c *Client) GetTypedLinkFacetInformation(ctx context.Context, params *GetTy type GetTypedLinkFacetInformationInput struct { - // The Amazon Resource Name (ARN) that is associated with the schema. For more - // information, see arns (). + // The unique name of the typed link facet. // // This member is required. - SchemaArn *string + Name *string - // The unique name of the typed link facet. + // The Amazon Resource Name (ARN) that is associated with the schema. For more + // information, see arns (). // // This member is required. - Name *string + SchemaArn *string } type GetTypedLinkFacetInformationOutput struct { diff --git a/service/clouddirectory/api_op_ListAppliedSchemaArns.go b/service/clouddirectory/api_op_ListAppliedSchemaArns.go index 827d6caeeb3..652898a9449 100644 --- a/service/clouddirectory/api_op_ListAppliedSchemaArns.go +++ b/service/clouddirectory/api_op_ListAppliedSchemaArns.go @@ -57,9 +57,10 @@ func (c *Client) ListAppliedSchemaArns(ctx context.Context, params *ListAppliedS type ListAppliedSchemaArnsInput struct { - // The response for ListAppliedSchemaArns when this parameter is used will list all - // minor version ARNs for a major version. - SchemaArn *string + // The ARN of the directory you are listing. + // + // This member is required. + DirectoryArn *string // The maximum number of results to retrieve. MaxResults *int32 @@ -67,20 +68,19 @@ type ListAppliedSchemaArnsInput struct { // The pagination token. NextToken *string - // The ARN of the directory you are listing. - // - // This member is required. - DirectoryArn *string + // The response for ListAppliedSchemaArns when this parameter is used will list all + // minor version ARNs for a major version. + SchemaArn *string } type ListAppliedSchemaArnsOutput struct { - // The ARNs of schemas that are applied to the directory. - SchemaArns []*string - // The pagination token. NextToken *string + // The ARNs of schemas that are applied to the directory. + SchemaArns []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/clouddirectory/api_op_ListAttachedIndices.go b/service/clouddirectory/api_op_ListAttachedIndices.go index a469780c56a..3c6303616a2 100644 --- a/service/clouddirectory/api_op_ListAttachedIndices.go +++ b/service/clouddirectory/api_op_ListAttachedIndices.go @@ -57,8 +57,10 @@ func (c *Client) ListAttachedIndices(ctx context.Context, params *ListAttachedIn type ListAttachedIndicesInput struct { - // The pagination token. - NextToken *string + // The ARN of the directory. + // + // This member is required. + DirectoryArn *string // A reference to the object that has indices attached. // @@ -71,20 +73,18 @@ type ListAttachedIndicesInput struct { // The maximum number of results to retrieve. MaxResults *int32 - // The ARN of the directory. - // - // This member is required. - DirectoryArn *string + // The pagination token. + NextToken *string } type ListAttachedIndicesOutput struct { - // The pagination token. - NextToken *string - // The indices attached to the specified object. IndexAttachments []*types.IndexAttachment + // The pagination token. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/clouddirectory/api_op_ListDevelopmentSchemaArns.go b/service/clouddirectory/api_op_ListDevelopmentSchemaArns.go index 4cebb1f1750..d65d90deb8d 100644 --- a/service/clouddirectory/api_op_ListDevelopmentSchemaArns.go +++ b/service/clouddirectory/api_op_ListDevelopmentSchemaArns.go @@ -55,11 +55,11 @@ func (c *Client) ListDevelopmentSchemaArns(ctx context.Context, params *ListDeve type ListDevelopmentSchemaArnsInput struct { - // The pagination token. - NextToken *string - // The maximum number of results to retrieve. MaxResults *int32 + + // The pagination token. + NextToken *string } type ListDevelopmentSchemaArnsOutput struct { diff --git a/service/clouddirectory/api_op_ListDirectories.go b/service/clouddirectory/api_op_ListDirectories.go index aaebebd704f..cec1d32aeda 100644 --- a/service/clouddirectory/api_op_ListDirectories.go +++ b/service/clouddirectory/api_op_ListDirectories.go @@ -56,28 +56,28 @@ func (c *Client) ListDirectories(ctx context.Context, params *ListDirectoriesInp type ListDirectoriesInput struct { - // The state of the directories in the list. Can be either Enabled, Disabled, or - // Deleted. - State types.DirectoryState + // The maximum number of results to retrieve. + MaxResults *int32 // The pagination token. NextToken *string - // The maximum number of results to retrieve. - MaxResults *int32 + // The state of the directories in the list. Can be either Enabled, Disabled, or + // Deleted. + State types.DirectoryState } type ListDirectoriesOutput struct { - // The pagination token. - NextToken *string - // Lists all directories that are associated with your account in pagination // fashion. // // This member is required. Directories []*types.Directory + // The pagination token. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/clouddirectory/api_op_ListFacetAttributes.go b/service/clouddirectory/api_op_ListFacetAttributes.go index 83eafe5aefa..b883ea621fb 100644 --- a/service/clouddirectory/api_op_ListFacetAttributes.go +++ b/service/clouddirectory/api_op_ListFacetAttributes.go @@ -67,11 +67,11 @@ type ListFacetAttributesInput struct { // This member is required. SchemaArn *string - // The pagination token. - NextToken *string - // The maximum number of results to retrieve. MaxResults *int32 + + // The pagination token. + NextToken *string } type ListFacetAttributesOutput struct { diff --git a/service/clouddirectory/api_op_ListFacetNames.go b/service/clouddirectory/api_op_ListFacetNames.go index 5305d914524..96c09c86837 100644 --- a/service/clouddirectory/api_op_ListFacetNames.go +++ b/service/clouddirectory/api_op_ListFacetNames.go @@ -56,26 +56,26 @@ func (c *Client) ListFacetNames(ctx context.Context, params *ListFacetNamesInput type ListFacetNamesInput struct { - // The pagination token. - NextToken *string - - // The maximum number of results to retrieve. - MaxResults *int32 - // The Amazon Resource Name (ARN) to retrieve facet names from. // // This member is required. SchemaArn *string -} -type ListFacetNamesOutput struct { + // The maximum number of results to retrieve. + MaxResults *int32 // The pagination token. NextToken *string +} + +type ListFacetNamesOutput struct { // The names of facets that exist within the schema. FacetNames []*string + // The pagination token. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/clouddirectory/api_op_ListIncomingTypedLinks.go b/service/clouddirectory/api_op_ListIncomingTypedLinks.go index f2623994b80..09ce1845221 100644 --- a/service/clouddirectory/api_op_ListIncomingTypedLinks.go +++ b/service/clouddirectory/api_op_ListIncomingTypedLinks.go @@ -60,10 +60,11 @@ func (c *Client) ListIncomingTypedLinks(ctx context.Context, params *ListIncomin type ListIncomingTypedLinksInput struct { - // Provides range filters for multiple attributes. When providing ranges to typed - // link selection, any inexact ranges must be specified at the end. Any attributes - // that do not have a range specified are presumed to match the entire range. - FilterAttributeRanges []*types.TypedLinkAttributeRange + // The Amazon Resource Name (ARN) of the directory where you want to list the typed + // links. + // + // This member is required. + DirectoryArn *string // Reference that identifies the object whose attributes will be listed. // @@ -73,21 +74,20 @@ type ListIncomingTypedLinksInput struct { // The consistency level to execute the request at. ConsistencyLevel types.ConsistencyLevel - // The pagination token. - NextToken *string - - // The maximum number of results to retrieve. - MaxResults *int32 + // Provides range filters for multiple attributes. When providing ranges to typed + // link selection, any inexact ranges must be specified at the end. Any attributes + // that do not have a range specified are presumed to match the entire range. + FilterAttributeRanges []*types.TypedLinkAttributeRange // Filters are interpreted in the order of the attributes on the typed link facet, // not the order in which they are supplied to any API calls. FilterTypedLink *types.TypedLinkSchemaAndFacetName - // The Amazon Resource Name (ARN) of the directory where you want to list the typed - // links. - // - // This member is required. - DirectoryArn *string + // The maximum number of results to retrieve. + MaxResults *int32 + + // The pagination token. + NextToken *string } type ListIncomingTypedLinksOutput struct { diff --git a/service/clouddirectory/api_op_ListIndex.go b/service/clouddirectory/api_op_ListIndex.go index a05fb42915e..087d155d765 100644 --- a/service/clouddirectory/api_op_ListIndex.go +++ b/service/clouddirectory/api_op_ListIndex.go @@ -57,11 +57,15 @@ func (c *Client) ListIndex(ctx context.Context, params *ListIndexInput, optFns . type ListIndexInput struct { - // The pagination token. - NextToken *string + // The ARN of the directory that the index exists in. + // + // This member is required. + DirectoryArn *string - // Specifies the ranges of indexed values that you want to query. - RangesOnIndexedValues []*types.ObjectAttributeRange + // The reference to the index to list. + // + // This member is required. + IndexReference *types.ObjectReference // The consistency level to execute the request at. ConsistencyLevel types.ConsistencyLevel @@ -71,25 +75,21 @@ type ListIndexInput struct { // (http://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html). MaxResults *int32 - // The ARN of the directory that the index exists in. - // - // This member is required. - DirectoryArn *string + // The pagination token. + NextToken *string - // The reference to the index to list. - // - // This member is required. - IndexReference *types.ObjectReference + // Specifies the ranges of indexed values that you want to query. + RangesOnIndexedValues []*types.ObjectAttributeRange } type ListIndexOutput struct { - // The pagination token. - NextToken *string - // The objects and indexed values attached to the index. IndexAttachments []*types.IndexAttachment + // The pagination token. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/clouddirectory/api_op_ListManagedSchemaArns.go b/service/clouddirectory/api_op_ListManagedSchemaArns.go index 4364e53f3c3..0a5c909af78 100644 --- a/service/clouddirectory/api_op_ListManagedSchemaArns.go +++ b/service/clouddirectory/api_op_ListManagedSchemaArns.go @@ -57,15 +57,15 @@ func (c *Client) ListManagedSchemaArns(ctx context.Context, params *ListManagedS type ListManagedSchemaArnsInput struct { + // The maximum number of results to retrieve. + MaxResults *int32 + // The pagination token. NextToken *string // The response for ListManagedSchemaArns. When this parameter is used, all minor // version ARNs for a major version are listed. SchemaArn *string - - // The maximum number of results to retrieve. - MaxResults *int32 } type ListManagedSchemaArnsOutput struct { diff --git a/service/clouddirectory/api_op_ListObjectAttributes.go b/service/clouddirectory/api_op_ListObjectAttributes.go index 73bd7bfff7f..26279fc97d5 100644 --- a/service/clouddirectory/api_op_ListObjectAttributes.go +++ b/service/clouddirectory/api_op_ListObjectAttributes.go @@ -63,25 +63,25 @@ type ListObjectAttributesInput struct { // This member is required. DirectoryArn *string - // Represents the manner and timing in which the successful write or update of an - // object is reflected in a subsequent read operation of that same object. - ConsistencyLevel types.ConsistencyLevel - // The reference that identifies the object whose attributes will be listed. // // This member is required. ObjectReference *types.ObjectReference - // The pagination token. - NextToken *string + // Represents the manner and timing in which the successful write or update of an + // object is reflected in a subsequent read operation of that same object. + ConsistencyLevel types.ConsistencyLevel + + // Used to filter the list of object attributes that are associated with a certain + // facet. + FacetFilter *types.SchemaFacet // The maximum number of items to be retrieved in a single call. This is an // approximate number. MaxResults *int32 - // Used to filter the list of object attributes that are associated with a certain - // facet. - FacetFilter *types.SchemaFacet + // The pagination token. + NextToken *string } type ListObjectAttributesOutput struct { diff --git a/service/clouddirectory/api_op_ListObjectChildren.go b/service/clouddirectory/api_op_ListObjectChildren.go index b72df9cd090..72113ad4077 100644 --- a/service/clouddirectory/api_op_ListObjectChildren.go +++ b/service/clouddirectory/api_op_ListObjectChildren.go @@ -58,9 +58,11 @@ func (c *Client) ListObjectChildren(ctx context.Context, params *ListObjectChild type ListObjectChildrenInput struct { - // Represents the manner and timing in which the successful write or update of an - // object is reflected in a subsequent read operation of that same object. - ConsistencyLevel types.ConsistencyLevel + // The Amazon Resource Name (ARN) that is associated with the Directory () where + // the object resides. For more information, see arns (). + // + // This member is required. + DirectoryArn *string // The reference that identifies the object for which child objects are being // listed. @@ -68,29 +70,27 @@ type ListObjectChildrenInput struct { // This member is required. ObjectReference *types.ObjectReference + // Represents the manner and timing in which the successful write or update of an + // object is reflected in a subsequent read operation of that same object. + ConsistencyLevel types.ConsistencyLevel + // The maximum number of items to be retrieved in a single call. This is an // approximate number. MaxResults *int32 // The pagination token. NextToken *string - - // The Amazon Resource Name (ARN) that is associated with the Directory () where - // the object resides. For more information, see arns (). - // - // This member is required. - DirectoryArn *string } type ListObjectChildrenOutput struct { - // The pagination token. - NextToken *string - // Children structure, which is a map with key as the LinkName and ObjectIdentifier // as the value. Children map[string]*string + // The pagination token. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/clouddirectory/api_op_ListObjectParentPaths.go b/service/clouddirectory/api_op_ListObjectParentPaths.go index bb3cdeec183..96a62393a01 100644 --- a/service/clouddirectory/api_op_ListObjectParentPaths.go +++ b/service/clouddirectory/api_op_ListObjectParentPaths.go @@ -66,10 +66,6 @@ func (c *Client) ListObjectParentPaths(ctx context.Context, params *ListObjectPa type ListObjectParentPathsInput struct { - // The maximum number of items to be retrieved in a single call. This is an - // approximate number. - MaxResults *int32 - // The ARN of the directory to which the parent path applies. // // This member is required. @@ -80,6 +76,10 @@ type ListObjectParentPathsInput struct { // This member is required. ObjectReference *types.ObjectReference + // The maximum number of items to be retrieved in a single call. This is an + // approximate number. + MaxResults *int32 + // The pagination token. NextToken *string } diff --git a/service/clouddirectory/api_op_ListObjectParents.go b/service/clouddirectory/api_op_ListObjectParents.go index c6f026d9e55..dbcd9e9234f 100644 --- a/service/clouddirectory/api_op_ListObjectParents.go +++ b/service/clouddirectory/api_op_ListObjectParents.go @@ -58,9 +58,11 @@ func (c *Client) ListObjectParents(ctx context.Context, params *ListObjectParent type ListObjectParentsInput struct { - // Represents the manner and timing in which the successful write or update of an - // object is reflected in a subsequent read operation of that same object. - ConsistencyLevel types.ConsistencyLevel + // The Amazon Resource Name (ARN) that is associated with the Directory () where + // the object resides. For more information, see arns (). + // + // This member is required. + DirectoryArn *string // The reference that identifies the object for which parent objects are being // listed. @@ -68,32 +70,30 @@ type ListObjectParentsInput struct { // This member is required. ObjectReference *types.ObjectReference + // Represents the manner and timing in which the successful write or update of an + // object is reflected in a subsequent read operation of that same object. + ConsistencyLevel types.ConsistencyLevel + + // When set to True, returns all ListObjectParentsResponse$ParentLinks (). There + // could be multiple links between a parent-child pair. + IncludeAllLinksToEachParent *bool + // The maximum number of items to be retrieved in a single call. This is an // approximate number. MaxResults *int32 // The pagination token. NextToken *string - - // When set to True, returns all ListObjectParentsResponse$ParentLinks (). There - // could be multiple links between a parent-child pair. - IncludeAllLinksToEachParent *bool - - // The Amazon Resource Name (ARN) that is associated with the Directory () where - // the object resides. For more information, see arns (). - // - // This member is required. - DirectoryArn *string } type ListObjectParentsOutput struct { - // Returns a list of parent reference and LinkName Tuples. - ParentLinks []*types.ObjectIdentifierAndLinkNameTuple - // The pagination token. NextToken *string + // Returns a list of parent reference and LinkName Tuples. + ParentLinks []*types.ObjectIdentifierAndLinkNameTuple + // The parent structure, which is a map with key as the ObjectIdentifier and // LinkName as the value. Parents map[string]*string diff --git a/service/clouddirectory/api_op_ListObjectPolicies.go b/service/clouddirectory/api_op_ListObjectPolicies.go index 55dcd878316..dbc7940d5d9 100644 --- a/service/clouddirectory/api_op_ListObjectPolicies.go +++ b/service/clouddirectory/api_op_ListObjectPolicies.go @@ -68,14 +68,14 @@ type ListObjectPoliciesInput struct { // This member is required. ObjectReference *types.ObjectReference - // The maximum number of items to be retrieved in a single call. This is an - // approximate number. - MaxResults *int32 - // Represents the manner and timing in which the successful write or update of an // object is reflected in a subsequent read operation of that same object. ConsistencyLevel types.ConsistencyLevel + // The maximum number of items to be retrieved in a single call. This is an + // approximate number. + MaxResults *int32 + // The pagination token. NextToken *string } diff --git a/service/clouddirectory/api_op_ListOutgoingTypedLinks.go b/service/clouddirectory/api_op_ListOutgoingTypedLinks.go index 0a3bcba00fc..25fbf643cf1 100644 --- a/service/clouddirectory/api_op_ListOutgoingTypedLinks.go +++ b/service/clouddirectory/api_op_ListOutgoingTypedLinks.go @@ -66,38 +66,38 @@ type ListOutgoingTypedLinksInput struct { // This member is required. DirectoryArn *string - // The consistency level to execute the request at. - ConsistencyLevel types.ConsistencyLevel - - // The maximum number of results to retrieve. - MaxResults *int32 - // A reference that identifies the object whose attributes will be listed. // // This member is required. ObjectReference *types.ObjectReference + // The consistency level to execute the request at. + ConsistencyLevel types.ConsistencyLevel + + // Provides range filters for multiple attributes. When providing ranges to typed + // link selection, any inexact ranges must be specified at the end. Any attributes + // that do not have a range specified are presumed to match the entire range. + FilterAttributeRanges []*types.TypedLinkAttributeRange + // Filters are interpreted in the order of the attributes defined on the typed link // facet, not the order they are supplied to any API calls. FilterTypedLink *types.TypedLinkSchemaAndFacetName + // The maximum number of results to retrieve. + MaxResults *int32 + // The pagination token. NextToken *string - - // Provides range filters for multiple attributes. When providing ranges to typed - // link selection, any inexact ranges must be specified at the end. Any attributes - // that do not have a range specified are presumed to match the entire range. - FilterAttributeRanges []*types.TypedLinkAttributeRange } type ListOutgoingTypedLinksOutput struct { - // Returns a typed link specifier as output. - TypedLinkSpecifiers []*types.TypedLinkSpecifier - // The pagination token. NextToken *string + // Returns a typed link specifier as output. + TypedLinkSpecifiers []*types.TypedLinkSpecifier + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/clouddirectory/api_op_ListPolicyAttachments.go b/service/clouddirectory/api_op_ListPolicyAttachments.go index b8acfbc11b3..d24473f8715 100644 --- a/service/clouddirectory/api_op_ListPolicyAttachments.go +++ b/service/clouddirectory/api_op_ListPolicyAttachments.go @@ -57,27 +57,27 @@ func (c *Client) ListPolicyAttachments(ctx context.Context, params *ListPolicyAt type ListPolicyAttachmentsInput struct { + // The Amazon Resource Name (ARN) that is associated with the Directory () where + // objects reside. For more information, see arns (). + // + // This member is required. + DirectoryArn *string + // The reference that identifies the policy object. // // This member is required. PolicyReference *types.ObjectReference - // The pagination token. - NextToken *string + // Represents the manner and timing in which the successful write or update of an + // object is reflected in a subsequent read operation of that same object. + ConsistencyLevel types.ConsistencyLevel // The maximum number of items to be retrieved in a single call. This is an // approximate number. MaxResults *int32 - // Represents the manner and timing in which the successful write or update of an - // object is reflected in a subsequent read operation of that same object. - ConsistencyLevel types.ConsistencyLevel - - // The Amazon Resource Name (ARN) that is associated with the Directory () where - // objects reside. For more information, see arns (). - // - // This member is required. - DirectoryArn *string + // The pagination token. + NextToken *string } type ListPolicyAttachmentsOutput struct { diff --git a/service/clouddirectory/api_op_ListPublishedSchemaArns.go b/service/clouddirectory/api_op_ListPublishedSchemaArns.go index 64a478e2848..75df0d97b8e 100644 --- a/service/clouddirectory/api_op_ListPublishedSchemaArns.go +++ b/service/clouddirectory/api_op_ListPublishedSchemaArns.go @@ -57,12 +57,12 @@ func (c *Client) ListPublishedSchemaArns(ctx context.Context, params *ListPublis type ListPublishedSchemaArnsInput struct { - // The pagination token. - NextToken *string - // The maximum number of results to retrieve. MaxResults *int32 + // The pagination token. + NextToken *string + // The response for ListPublishedSchemaArns when this parameter is used will list // all minor version ARNs for a major version. SchemaArn *string diff --git a/service/clouddirectory/api_op_ListTagsForResource.go b/service/clouddirectory/api_op_ListTagsForResource.go index 5525457b523..1ecdeef2ba7 100644 --- a/service/clouddirectory/api_op_ListTagsForResource.go +++ b/service/clouddirectory/api_op_ListTagsForResource.go @@ -59,6 +59,12 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { + // The Amazon Resource Name (ARN) of the resource. Tagging is only supported for + // directories. + // + // This member is required. + ResourceArn *string + // The MaxResults parameter sets the maximum number of results returned in a single // page. This is for future use and is not supported currently. MaxResults *int32 @@ -66,12 +72,6 @@ type ListTagsForResourceInput struct { // The pagination token. This is for future use. Currently pagination is not // supported for tagging. NextToken *string - - // The Amazon Resource Name (ARN) of the resource. Tagging is only supported for - // directories. - // - // This member is required. - ResourceArn *string } type ListTagsForResourceOutput struct { diff --git a/service/clouddirectory/api_op_ListTypedLinkFacetAttributes.go b/service/clouddirectory/api_op_ListTypedLinkFacetAttributes.go index 3ac09050ff9..6387c2c88d0 100644 --- a/service/clouddirectory/api_op_ListTypedLinkFacetAttributes.go +++ b/service/clouddirectory/api_op_ListTypedLinkFacetAttributes.go @@ -59,12 +59,6 @@ func (c *Client) ListTypedLinkFacetAttributes(ctx context.Context, params *ListT type ListTypedLinkFacetAttributesInput struct { - // The pagination token. - NextToken *string - - // The maximum number of results to retrieve. - MaxResults *int32 - // The unique name of the typed link facet. // // This member is required. @@ -75,6 +69,12 @@ type ListTypedLinkFacetAttributesInput struct { // // This member is required. SchemaArn *string + + // The maximum number of results to retrieve. + MaxResults *int32 + + // The pagination token. + NextToken *string } type ListTypedLinkFacetAttributesOutput struct { diff --git a/service/clouddirectory/api_op_LookupPolicy.go b/service/clouddirectory/api_op_LookupPolicy.go index 2c196bf121a..928477c6168 100644 --- a/service/clouddirectory/api_op_LookupPolicy.go +++ b/service/clouddirectory/api_op_LookupPolicy.go @@ -63,10 +63,6 @@ func (c *Client) LookupPolicy(ctx context.Context, params *LookupPolicyInput, op type LookupPolicyInput struct { - // The maximum number of items to be retrieved in a single call. This is an - // approximate number. - MaxResults *int32 - // The Amazon Resource Name (ARN) that is associated with the Directory (). For // more information, see arns (). // @@ -78,20 +74,24 @@ type LookupPolicyInput struct { // This member is required. ObjectReference *types.ObjectReference + // The maximum number of items to be retrieved in a single call. This is an + // approximate number. + MaxResults *int32 + // The token to request the next page of results. NextToken *string } type LookupPolicyOutput struct { + // The pagination token. + NextToken *string + // Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, // and PolicyType. For more information, see Policies // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies). PolicyToPathList []*types.PolicyToPath - // The pagination token. - NextToken *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/clouddirectory/api_op_PublishSchema.go b/service/clouddirectory/api_op_PublishSchema.go index 481f66e38c1..aa44fcba9f2 100644 --- a/service/clouddirectory/api_op_PublishSchema.go +++ b/service/clouddirectory/api_op_PublishSchema.go @@ -57,25 +57,25 @@ func (c *Client) PublishSchema(ctx context.Context, params *PublishSchemaInput, type PublishSchemaInput struct { - // The new name under which the schema will be published. If this is not provided, - // the development schema is considered. - Name *string - // The Amazon Resource Name (ARN) that is associated with the development schema. // For more information, see arns (). // // This member is required. DevelopmentSchemaArn *string - // The minor version under which the schema will be published. This parameter is - // recommended. Schemas have both a major and minor version associated with them. - MinorVersion *string - // The major version under which the schema will be published. Schemas have both a // major and minor version associated with them. // // This member is required. Version *string + + // The minor version under which the schema will be published. This parameter is + // recommended. Schemas have both a major and minor version associated with them. + MinorVersion *string + + // The new name under which the schema will be published. If this is not provided, + // the development schema is considered. + Name *string } type PublishSchemaOutput struct { diff --git a/service/clouddirectory/api_op_PutSchemaFromJson.go b/service/clouddirectory/api_op_PutSchemaFromJson.go index 40e83a72544..d81a91e8edd 100644 --- a/service/clouddirectory/api_op_PutSchemaFromJson.go +++ b/service/clouddirectory/api_op_PutSchemaFromJson.go @@ -59,15 +59,15 @@ func (c *Client) PutSchemaFromJson(ctx context.Context, params *PutSchemaFromJso type PutSchemaFromJsonInput struct { - // The ARN of the schema to update. + // The replacement JSON schema. // // This member is required. - SchemaArn *string + Document *string - // The replacement JSON schema. + // The ARN of the schema to update. // // This member is required. - Document *string + SchemaArn *string } type PutSchemaFromJsonOutput struct { diff --git a/service/clouddirectory/api_op_RemoveFacetFromObject.go b/service/clouddirectory/api_op_RemoveFacetFromObject.go index 8a46ee3ae0a..f1747304b54 100644 --- a/service/clouddirectory/api_op_RemoveFacetFromObject.go +++ b/service/clouddirectory/api_op_RemoveFacetFromObject.go @@ -57,15 +57,15 @@ func (c *Client) RemoveFacetFromObject(ctx context.Context, params *RemoveFacetF type RemoveFacetFromObjectInput struct { - // A reference to the object to remove the facet from. + // The ARN of the directory in which the object resides. // // This member is required. - ObjectReference *types.ObjectReference + DirectoryArn *string - // The ARN of the directory in which the object resides. + // A reference to the object to remove the facet from. // // This member is required. - DirectoryArn *string + ObjectReference *types.ObjectReference // The facet to remove. See SchemaFacet () for details. // diff --git a/service/clouddirectory/api_op_UpdateFacet.go b/service/clouddirectory/api_op_UpdateFacet.go index 6264dba4ff4..169066feb8d 100644 --- a/service/clouddirectory/api_op_UpdateFacet.go +++ b/service/clouddirectory/api_op_UpdateFacet.go @@ -65,9 +65,10 @@ func (c *Client) UpdateFacet(ctx context.Context, params *UpdateFacetInput, optF type UpdateFacetInput struct { - // The object type that is associated with the facet. See - // CreateFacetRequest$ObjectType () for more details. - ObjectType types.ObjectType + // The name of the facet. + // + // This member is required. + Name *string // The Amazon Resource Name (ARN) that is associated with the Facet (). For more // information, see arns (). @@ -80,10 +81,9 @@ type UpdateFacetInput struct { // operation to perform. AttributeUpdates []*types.FacetAttributeUpdate - // The name of the facet. - // - // This member is required. - Name *string + // The object type that is associated with the facet. See + // CreateFacetRequest$ObjectType () for more details. + ObjectType types.ObjectType } type UpdateFacetOutput struct { diff --git a/service/clouddirectory/api_op_UpdateLinkAttributes.go b/service/clouddirectory/api_op_UpdateLinkAttributes.go index 4a494f4b050..0a742d39652 100644 --- a/service/clouddirectory/api_op_UpdateLinkAttributes.go +++ b/service/clouddirectory/api_op_UpdateLinkAttributes.go @@ -64,17 +64,17 @@ type UpdateLinkAttributesInput struct { // This member is required. AttributeUpdates []*types.LinkAttributeUpdate - // Allows a typed link specifier to be accepted as input. - // - // This member is required. - TypedLinkSpecifier *types.TypedLinkSpecifier - // The Amazon Resource Name (ARN) that is associated with the Directory where the // updated typed link resides. For more information, see arns () or Typed Links // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). // // This member is required. DirectoryArn *string + + // Allows a typed link specifier to be accepted as input. + // + // This member is required. + TypedLinkSpecifier *types.TypedLinkSpecifier } type UpdateLinkAttributesOutput struct { diff --git a/service/clouddirectory/api_op_UpdateObjectAttributes.go b/service/clouddirectory/api_op_UpdateObjectAttributes.go index 795af9132f6..b2e60d31927 100644 --- a/service/clouddirectory/api_op_UpdateObjectAttributes.go +++ b/service/clouddirectory/api_op_UpdateObjectAttributes.go @@ -57,11 +57,6 @@ func (c *Client) UpdateObjectAttributes(ctx context.Context, params *UpdateObjec type UpdateObjectAttributesInput struct { - // The reference that identifies the object. - // - // This member is required. - ObjectReference *types.ObjectReference - // The attributes update structure. // // This member is required. @@ -72,6 +67,11 @@ type UpdateObjectAttributesInput struct { // // This member is required. DirectoryArn *string + + // The reference that identifies the object. + // + // This member is required. + ObjectReference *types.ObjectReference } type UpdateObjectAttributesOutput struct { diff --git a/service/clouddirectory/api_op_UpdateSchema.go b/service/clouddirectory/api_op_UpdateSchema.go index 021fab9ba36..5286976b6a9 100644 --- a/service/clouddirectory/api_op_UpdateSchema.go +++ b/service/clouddirectory/api_op_UpdateSchema.go @@ -57,16 +57,16 @@ func (c *Client) UpdateSchema(ctx context.Context, params *UpdateSchemaInput, op type UpdateSchemaInput struct { - // The Amazon Resource Name (ARN) of the development schema. For more information, - // see arns (). + // The name of the schema. // // This member is required. - SchemaArn *string + Name *string - // The name of the schema. + // The Amazon Resource Name (ARN) of the development schema. For more information, + // see arns (). // // This member is required. - Name *string + SchemaArn *string } type UpdateSchemaOutput struct { diff --git a/service/clouddirectory/api_op_UpdateTypedLinkFacet.go b/service/clouddirectory/api_op_UpdateTypedLinkFacet.go index c39644ae3fa..d2123e68086 100644 --- a/service/clouddirectory/api_op_UpdateTypedLinkFacet.go +++ b/service/clouddirectory/api_op_UpdateTypedLinkFacet.go @@ -58,11 +58,6 @@ func (c *Client) UpdateTypedLinkFacet(ctx context.Context, params *UpdateTypedLi type UpdateTypedLinkFacetInput struct { - // The unique name of the typed link facet. - // - // This member is required. - Name *string - // Attributes update structure. // // This member is required. @@ -81,6 +76,11 @@ type UpdateTypedLinkFacetInput struct { // This member is required. IdentityAttributeOrder []*string + // The unique name of the typed link facet. + // + // This member is required. + Name *string + // The Amazon Resource Name (ARN) that is associated with the schema. For more // information, see arns (). // diff --git a/service/clouddirectory/api_op_UpgradePublishedSchema.go b/service/clouddirectory/api_op_UpgradePublishedSchema.go index 53800c2cfc6..5750da42052 100644 --- a/service/clouddirectory/api_op_UpgradePublishedSchema.go +++ b/service/clouddirectory/api_op_UpgradePublishedSchema.go @@ -57,6 +57,11 @@ func (c *Client) UpgradePublishedSchema(ctx context.Context, params *UpgradePubl type UpgradePublishedSchemaInput struct { + // The ARN of the development schema with the changes used for the upgrade. + // + // This member is required. + DevelopmentSchemaArn *string + // Identifies the minor version of the published schema that will be created. This // parameter is NOT optional. // @@ -73,11 +78,6 @@ type UpgradePublishedSchemaInput struct { // If schema compatibility fails, an exception would be thrown else the call would // succeed. This parameter is optional and defaults to false. DryRun *bool - - // The ARN of the development schema with the changes used for the upgrade. - // - // This member is required. - DevelopmentSchemaArn *string } type UpgradePublishedSchemaOutput struct { diff --git a/service/clouddirectory/go.mod b/service/clouddirectory/go.mod index 846bf15a572..3cd1e94eaee 100644 --- a/service/clouddirectory/go.mod +++ b/service/clouddirectory/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/clouddirectory go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/clouddirectory/types/types.go b/service/clouddirectory/types/types.go index ac68c351cb5..8f3de08d962 100644 --- a/service/clouddirectory/types/types.go +++ b/service/clouddirectory/types/types.go @@ -14,16 +14,16 @@ type AttributeKey struct { // This member is required. FacetName *string - // The Amazon Resource Name (ARN) of the schema that contains the facet and - // attribute. + // The name of the attribute. // // This member is required. - SchemaArn *string + Name *string - // The name of the attribute. + // The Amazon Resource Name (ARN) of the schema that contains the facet and + // attribute. // // This member is required. - Name *string + SchemaArn *string } // The combination of an attribute key and an attribute value. @@ -43,15 +43,15 @@ type AttributeKeyAndValue struct { // Identifies the attribute name and value for a typed link. type AttributeNameAndValue struct { - // The value for the typed link. + // The attribute name of the typed link. // // This member is required. - Value *TypedAttributeValue + AttributeName *string - // The attribute name of the typed link. + // The value for the typed link. // // This member is required. - AttributeName *string + Value *TypedAttributeValue } // Represents the output of a batch add facet to object operation. @@ -80,6 +80,11 @@ type BatchAddFacetToObjectResponse struct { // Represents the output of an AttachObject () operation. type BatchAttachObject struct { + // The child object reference that is to be attached to the object. + // + // This member is required. + ChildReference *ObjectReference + // The name of the link. // // This member is required. @@ -89,11 +94,6 @@ type BatchAttachObject struct { // // This member is required. ParentReference *ObjectReference - - // The child object reference that is to be attached to the object. - // - // This member is required. - ChildReference *ObjectReference } // Represents the output batch AttachObject () response operation. @@ -127,15 +127,15 @@ type BatchAttachPolicyResponse struct { // BatchReadRequest$Operations (). type BatchAttachToIndex struct { - // A reference to the object that you are attaching to the index. + // A reference to the index that you are attaching the object to. // // This member is required. - TargetReference *ObjectReference + IndexReference *ObjectReference - // A reference to the index that you are attaching the object to. + // A reference to the object that you are attaching to the index. // // This member is required. - IndexReference *ObjectReference + TargetReference *ObjectReference } // Represents the output of a AttachToIndex () response operation. @@ -150,6 +150,11 @@ type BatchAttachToIndexResponse struct { // BatchReadRequest$Operations (). type BatchAttachTypedLink struct { + // A set of attributes that are associated with the typed link. + // + // This member is required. + Attributes []*AttributeNameAndValue + // Identifies the source object that the typed link will attach to. // // This member is required. @@ -164,11 +169,6 @@ type BatchAttachTypedLink struct { // // This member is required. TypedLinkFacet *TypedLinkSchemaAndFacetName - - // A set of attributes that are associated with the typed link. - // - // This member is required. - Attributes []*AttributeNameAndValue } // Represents the output of a AttachTypedLink () response operation. @@ -182,15 +182,17 @@ type BatchAttachTypedLinkResponse struct { // information, see CreateIndex () and BatchReadRequest$Operations (). type BatchCreateIndex struct { + // Indicates whether the attribute that is being indexed has unique values or not. + // + // This member is required. + IsUnique *bool + // Specifies the attributes that should be indexed on. Currently only a single // attribute is supported. // // This member is required. OrderedIndexedAttributeList []*AttributeKey - // A reference to the parent object that contains the index object. - ParentReference *ObjectReference - // The batch reference name. See Transaction Support // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/transaction_support.html) // for more information. @@ -199,10 +201,8 @@ type BatchCreateIndex struct { // The name of the link between the parent object and the index object. LinkName *string - // Indicates whether the attribute that is being indexed has unique values or not. - // - // This member is required. - IsUnique *bool + // A reference to the parent object that contains the index object. + ParentReference *ObjectReference } // Represents the output of a CreateIndex () response operation. @@ -215,8 +215,11 @@ type BatchCreateIndexResponse struct { // Represents the output of a CreateObject () operation. type BatchCreateObject struct { - // If specified, the parent reference to which this object will be attached. - ParentReference *ObjectReference + // An attribute map, which contains an attribute ARN as the key and attribute value + // as the map value. + // + // This member is required. + ObjectAttributeList []*AttributeKeyAndValue // A list of FacetArns that will be associated with the object. For more // information, see arns (). @@ -224,19 +227,16 @@ type BatchCreateObject struct { // This member is required. SchemaFacet []*SchemaFacet - // The name of the link. - LinkName *string - // The batch reference name. See Transaction Support // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/transaction_support.html) // for more information. BatchReferenceName *string - // An attribute map, which contains an attribute ARN as the key and attribute value - // as the map value. - // - // This member is required. - ObjectAttributeList []*AttributeKeyAndValue + // The name of the link. + LinkName *string + + // If specified, the parent reference to which this object will be attached. + ParentReference *ObjectReference } // Represents the output of a CreateObject () response operation. @@ -290,15 +290,15 @@ type BatchDetachObject struct { // This member is required. LinkName *string - // The batch reference name. See Transaction Support - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/transaction_support.html) - // for more information. - BatchReferenceName *string - // Parent reference from which the object with the specified link name is detached. // // This member is required. ParentReference *ObjectReference + + // The batch reference name. See Transaction Support + // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/transaction_support.html) + // for more information. + BatchReferenceName *string } // Represents the output of a DetachObject () response operation. @@ -371,12 +371,6 @@ type BatchGetLinkAttributesResponse struct { // BatchReadRequest$Operations (). type BatchGetObjectAttributes struct { - // Identifier for the facet whose attributes will be retrieved. See SchemaFacet () - // for details. - // - // This member is required. - SchemaFacet *SchemaFacet - // List of attribute names whose values will be retrieved. // // This member is required. @@ -386,6 +380,12 @@ type BatchGetObjectAttributes struct { // // This member is required. ObjectReference *ObjectReference + + // Identifier for the facet whose attributes will be retrieved. See SchemaFacet () + // for details. + // + // This member is required. + SchemaFacet *SchemaFacet } // Represents the output of a GetObjectAttributes () response operation. @@ -408,11 +408,11 @@ type BatchGetObjectInformation struct { // Represents the output of a GetObjectInformation () response operation. type BatchGetObjectInformationResponse struct { - // The facets attached to the specified object. - SchemaFacets []*SchemaFacet - // The ObjectIdentifier of the specified object. ObjectIdentifier *string + + // The facets attached to the specified object. + SchemaFacets []*SchemaFacet } // Lists indices attached to an object inside a BatchRead () operation. For more @@ -424,11 +424,11 @@ type BatchListAttachedIndices struct { // This member is required. TargetReference *ObjectReference - // The pagination token. - NextToken *string - // The maximum number of results to retrieve. MaxResults *int32 + + // The pagination token. + NextToken *string } // Represents the output of a ListAttachedIndices () response operation. @@ -446,52 +446,52 @@ type BatchListAttachedIndicesResponse struct { // ListIncomingTypedLinks () and BatchReadRequest$Operations (). type BatchListIncomingTypedLinks struct { + // The reference that identifies the object whose attributes will be listed. + // + // This member is required. + ObjectReference *ObjectReference + // Provides range filters for multiple attributes. When providing ranges to typed // link selection, any inexact ranges must be specified at the end. Any attributes // that do not have a range specified are presumed to match the entire range. FilterAttributeRanges []*TypedLinkAttributeRange + // Filters are interpreted in the order of the attributes on the typed link facet, + // not the order in which they are supplied to any API calls. + FilterTypedLink *TypedLinkSchemaAndFacetName + // The maximum number of results to retrieve. MaxResults *int32 // The pagination token. NextToken *string - - // Filters are interpreted in the order of the attributes on the typed link facet, - // not the order in which they are supplied to any API calls. - FilterTypedLink *TypedLinkSchemaAndFacetName - - // The reference that identifies the object whose attributes will be listed. - // - // This member is required. - ObjectReference *ObjectReference } // Represents the output of a ListIncomingTypedLinks () response operation. type BatchListIncomingTypedLinksResponse struct { - // The pagination token. - NextToken *string - // Returns one or more typed link specifiers as output. LinkSpecifiers []*TypedLinkSpecifier + + // The pagination token. + NextToken *string } // Lists objects attached to the specified index inside a BatchRead () operation. // For more information, see ListIndex () and BatchReadRequest$Operations (). type BatchListIndex struct { - // The pagination token. - NextToken *string - - // The maximum number of results to retrieve. - MaxResults *int32 - // The reference to the index to list. // // This member is required. IndexReference *ObjectReference + // The maximum number of results to retrieve. + MaxResults *int32 + + // The pagination token. + NextToken *string + // Specifies the ranges of indexed values that you want to query. RangesOnIndexedValues []*ObjectAttributeRange } @@ -499,11 +499,11 @@ type BatchListIndex struct { // Represents the output of a ListIndex () response operation. type BatchListIndexResponse struct { - // The pagination token. - NextToken *string - // The objects and indexed values attached to the index. IndexAttachments []*IndexAttachment + + // The pagination token. + NextToken *string } // Represents the output of a ListObjectAttributes () operation. @@ -529,28 +529,28 @@ type BatchListObjectAttributes struct { // Represents the output of a ListObjectAttributes () response operation. type BatchListObjectAttributesResponse struct { - // The pagination token. - NextToken *string - // The attributes map that is associated with the object. AttributeArn is the key; // attribute value is the value. Attributes []*AttributeKeyAndValue + + // The pagination token. + NextToken *string } // Represents the output of a ListObjectChildren () operation. type BatchListObjectChildren struct { + // Reference of the object for which child objects are being listed. + // + // This member is required. + ObjectReference *ObjectReference + // Maximum number of items to be retrieved in a single call. This is an approximate // number. MaxResults *int32 // The pagination token. NextToken *string - - // Reference of the object for which child objects are being listed. - // - // This member is required. - ObjectReference *ObjectReference } // Represents the output of a ListObjectChildren () response operation. @@ -570,27 +570,27 @@ type BatchListObjectChildrenResponse struct { // (). type BatchListObjectParentPaths struct { + // The reference that identifies the object whose attributes will be listed. + // + // This member is required. + ObjectReference *ObjectReference + // The maximum number of results to retrieve. MaxResults *int32 // The pagination token. NextToken *string - - // The reference that identifies the object whose attributes will be listed. - // - // This member is required. - ObjectReference *ObjectReference } // Represents the output of a ListObjectParentPaths () response operation. type BatchListObjectParentPathsResponse struct { + // The pagination token. + NextToken *string + // Returns the path to the ObjectIdentifiers that are associated with the // directory. PathToObjectIdentifiersList []*PathToObjectIdentifiers - - // The pagination token. - NextToken *string } type BatchListObjectParents struct { @@ -621,21 +621,21 @@ type BatchListObjectPolicies struct { // This member is required. ObjectReference *ObjectReference - // The pagination token. - NextToken *string - // The maximum number of results to retrieve. MaxResults *int32 + + // The pagination token. + NextToken *string } // Represents the output of a ListObjectPolicies () response operation. type BatchListObjectPoliciesResponse struct { - // The pagination token. - NextToken *string - // A list of policy ObjectIdentifiers, that are attached to the object. AttachedPolicyIds []*string + + // The pagination token. + NextToken *string } // Returns a paginated list of all the outgoing TypedLinkSpecifier () information @@ -643,23 +643,23 @@ type BatchListObjectPoliciesResponse struct { // ListOutgoingTypedLinks () and BatchReadRequest$Operations (). type BatchListOutgoingTypedLinks struct { - // Filters are interpreted in the order of the attributes defined on the typed link - // facet, not the order they are supplied to any API calls. - FilterTypedLink *TypedLinkSchemaAndFacetName - // The reference that identifies the object whose attributes will be listed. // // This member is required. ObjectReference *ObjectReference - // The maximum number of results to retrieve. - MaxResults *int32 - // Provides range filters for multiple attributes. When providing ranges to typed // link selection, any inexact ranges must be specified at the end. Any attributes // that do not have a range specified are presumed to match the entire range. FilterAttributeRanges []*TypedLinkAttributeRange + // Filters are interpreted in the order of the attributes defined on the typed link + // facet, not the order they are supplied to any API calls. + FilterTypedLink *TypedLinkSchemaAndFacetName + + // The maximum number of results to retrieve. + MaxResults *int32 + // The pagination token. NextToken *string } @@ -667,11 +667,11 @@ type BatchListOutgoingTypedLinks struct { // Represents the output of a ListOutgoingTypedLinks () response operation. type BatchListOutgoingTypedLinksResponse struct { - // Returns a typed link specifier as output. - TypedLinkSpecifiers []*TypedLinkSpecifier - // The pagination token. NextToken *string + + // Returns a typed link specifier as output. + TypedLinkSpecifiers []*TypedLinkSpecifier } // Returns all of the ObjectIdentifiers to which a given policy is attached inside @@ -679,9 +679,6 @@ type BatchListOutgoingTypedLinksResponse struct { // BatchReadRequest$Operations (). type BatchListPolicyAttachments struct { - // The pagination token. - NextToken *string - // The reference that identifies the policy object. // // This member is required. @@ -689,6 +686,9 @@ type BatchListPolicyAttachments struct { // The maximum number of results to retrieve. MaxResults *int32 + + // The pagination token. + NextToken *string } // Represents the output of a ListPolicyAttachments () response operation. @@ -706,14 +706,14 @@ type BatchListPolicyAttachmentsResponse struct { // BatchReadRequest$Operations (). type BatchLookupPolicy struct { - // The maximum number of results to retrieve. - MaxResults *int32 - // Reference that identifies the object whose policies will be looked up. // // This member is required. ObjectReference *ObjectReference + // The maximum number of results to retrieve. + MaxResults *int32 + // The pagination token. NextToken *string } @@ -721,39 +721,40 @@ type BatchLookupPolicy struct { // Represents the output of a LookupPolicy () response operation. type BatchLookupPolicyResponse struct { + // The pagination token. + NextToken *string + // Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, // and PolicyType. For more information, see Policies // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies). PolicyToPathList []*PolicyToPath - - // The pagination token. - NextToken *string } // The batch read exception structure, which contains the exception type and // message. type BatchReadException struct { - // A type of exception, such as InvalidArnException. - Type BatchReadExceptionType - // An exception message that is associated with the failure. Message *string + + // A type of exception, such as InvalidArnException. + Type BatchReadExceptionType } // Represents the output of a BatchRead operation. type BatchReadOperation struct { - // Returns a paginated list of all the outgoing TypedLinkSpecifier () information - // for an object. It also supports filtering by typed link facet and identity - // attributes. For more information, see Typed Links - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). - ListOutgoingTypedLinks *BatchListOutgoingTypedLinks + // Retrieves attributes that are associated with a typed link. + GetLinkAttributes *BatchGetLinkAttributes - ListObjectParents *BatchListObjectParents + // Retrieves attributes within a facet that are associated with an object. + GetObjectAttributes *BatchGetObjectAttributes - // Lists objects attached to the specified index. - ListIndex *BatchListIndex + // Retrieves metadata about an object. + GetObjectInformation *BatchGetObjectInformation + + // Lists indices attached to an object. + ListAttachedIndices *BatchListAttachedIndices // Returns a paginated list of all the incoming TypedLinkSpecifier () information // for an object. It also supports filtering by typed link facet and identity @@ -761,62 +762,70 @@ type BatchReadOperation struct { // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). ListIncomingTypedLinks *BatchListIncomingTypedLinks - // Returns policies attached to an object in pagination fashion. - ListObjectPolicies *BatchListObjectPolicies + // Lists objects attached to the specified index. + ListIndex *BatchListIndex // Lists all attributes that are associated with an object. ListObjectAttributes *BatchListObjectAttributes - // Retrieves attributes that are associated with a typed link. - GetLinkAttributes *BatchGetLinkAttributes - - // Lists all policies from the root of the Directory () to the object specified. If - // there are no policies present, an empty list is returned. If policies are - // present, and if some objects don't have the policies attached, it returns the - // ObjectIdentifier for such objects. If policies are present, it returns - // ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root - // from the target object are ignored. For more information, see Policies - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies). - LookupPolicy *BatchLookupPolicy - // Returns a paginated list of child objects that are associated with a given // object. ListObjectChildren *BatchListObjectChildren - // Retrieves metadata about an object. - GetObjectInformation *BatchGetObjectInformation - - // Lists indices attached to an object. - ListAttachedIndices *BatchListAttachedIndices - - // Returns all of the ObjectIdentifiers to which a given policy is attached. - ListPolicyAttachments *BatchListPolicyAttachments - - // Retrieves attributes within a facet that are associated with an object. - GetObjectAttributes *BatchGetObjectAttributes - // Retrieves all available parent paths for any object type such as node, leaf // node, policy node, and index node objects. For more information about objects, // see Directory Structure // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html). ListObjectParentPaths *BatchListObjectParentPaths + + ListObjectParents *BatchListObjectParents + + // Returns policies attached to an object in pagination fashion. + ListObjectPolicies *BatchListObjectPolicies + + // Returns a paginated list of all the outgoing TypedLinkSpecifier () information + // for an object. It also supports filtering by typed link facet and identity + // attributes. For more information, see Typed Links + // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). + ListOutgoingTypedLinks *BatchListOutgoingTypedLinks + + // Returns all of the ObjectIdentifiers to which a given policy is attached. + ListPolicyAttachments *BatchListPolicyAttachments + + // Lists all policies from the root of the Directory () to the object specified. If + // there are no policies present, an empty list is returned. If policies are + // present, and if some objects don't have the policies attached, it returns the + // ObjectIdentifier for such objects. If policies are present, it returns + // ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root + // from the target object are ignored. For more information, see Policies + // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies). + LookupPolicy *BatchLookupPolicy } // Represents the output of a BatchRead response operation. type BatchReadOperationResponse struct { - // Identifies which operation in a batch has succeeded. - SuccessfulResponse *BatchReadSuccessfulResponse - // Identifies which operation in a batch has failed. ExceptionResponse *BatchReadException + + // Identifies which operation in a batch has succeeded. + SuccessfulResponse *BatchReadSuccessfulResponse } // Represents the output of a BatchRead success response operation. type BatchReadSuccessfulResponse struct { - // Lists all attributes that are associated with an object. - ListObjectAttributes *BatchListObjectAttributesResponse + // The list of attributes to retrieve from the typed link. + GetLinkAttributes *BatchGetLinkAttributesResponse + + // Retrieves attributes within a facet that are associated with an object. + GetObjectAttributes *BatchGetObjectAttributesResponse + + // Retrieves metadata about an object. + GetObjectInformation *BatchGetObjectInformationResponse + + // Lists indices attached to an object. + ListAttachedIndices *BatchListAttachedIndicesResponse // Returns a paginated list of all the incoming TypedLinkSpecifier () information // for an object. It also supports filtering by typed link facet and identity @@ -824,53 +833,44 @@ type BatchReadSuccessfulResponse struct { // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). ListIncomingTypedLinks *BatchListIncomingTypedLinksResponse - // Retrieves attributes within a facet that are associated with an object. - GetObjectAttributes *BatchGetObjectAttributesResponse - // Lists objects attached to the specified index. ListIndex *BatchListIndexResponse - // Returns policies attached to an object in pagination fashion. - ListObjectPolicies *BatchListObjectPoliciesResponse - - // The list of attributes to retrieve from the typed link. - GetLinkAttributes *BatchGetLinkAttributesResponse + // Lists all attributes that are associated with an object. + ListObjectAttributes *BatchListObjectAttributesResponse // Returns a paginated list of child objects that are associated with a given // object. ListObjectChildren *BatchListObjectChildrenResponse - // Lists all policies from the root of the Directory () to the object specified. If - // there are no policies present, an empty list is returned. If policies are - // present, and if some objects don't have the policies attached, it returns the - // ObjectIdentifier for such objects. If policies are present, it returns - // ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root - // from the target object are ignored. For more information, see Policies - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies). - LookupPolicy *BatchLookupPolicyResponse - - // Retrieves metadata about an object. - GetObjectInformation *BatchGetObjectInformationResponse - - ListObjectParents *BatchListObjectParentsResponse - // Retrieves all available parent paths for any object type such as node, leaf // node, policy node, and index node objects. For more information about objects, // see Directory Structure // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html). ListObjectParentPaths *BatchListObjectParentPathsResponse - // Lists indices attached to an object. - ListAttachedIndices *BatchListAttachedIndicesResponse + ListObjectParents *BatchListObjectParentsResponse - // Returns all of the ObjectIdentifiers to which a given policy is attached. - ListPolicyAttachments *BatchListPolicyAttachmentsResponse + // Returns policies attached to an object in pagination fashion. + ListObjectPolicies *BatchListObjectPoliciesResponse // Returns a paginated list of all the outgoing TypedLinkSpecifier () information // for an object. It also supports filtering by typed link facet and identity // attributes. For more information, see Typed Links // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). ListOutgoingTypedLinks *BatchListOutgoingTypedLinksResponse + + // Returns all of the ObjectIdentifiers to which a given policy is attached. + ListPolicyAttachments *BatchListPolicyAttachmentsResponse + + // Lists all policies from the root of the Directory () to the object specified. If + // there are no policies present, an empty list is returned. If policies are + // present, and if some objects don't have the policies attached, it returns the + // ObjectIdentifier for such objects. If policies are present, it returns + // ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root + // from the target object are ignored. For more information, see Policies + // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies). + LookupPolicy *BatchLookupPolicyResponse } // A batch operation to remove a facet from an object. @@ -915,15 +915,15 @@ type BatchUpdateLinkAttributesResponse struct { // Represents the output of a BatchUpdate operation. type BatchUpdateObjectAttributes struct { - // Reference that identifies the object. + // Attributes update structure. // // This member is required. - ObjectReference *ObjectReference + AttributeUpdates []*ObjectAttributeUpdate - // Attributes update structure. + // Reference that identifies the object. // // This member is required. - AttributeUpdates []*ObjectAttributeUpdate + ObjectReference *ObjectReference } // Represents the output of a BatchUpdate response operation. @@ -936,95 +936,87 @@ type BatchUpdateObjectAttributesResponse struct { // Represents the output of a BatchWrite operation. type BatchWriteOperation struct { - // Updates a given object's attributes. - UpdateLinkAttributes *BatchUpdateLinkAttributes + // A batch operation that adds a facet to an object. + AddFacetToObject *BatchAddFacetToObject // Attaches an object to a Directory (). AttachObject *BatchAttachObject + // Attaches a policy object to a regular object. An object can have a limited + // number of attached policies. + AttachPolicy *BatchAttachPolicy + + // Attaches the specified object to the specified index. + AttachToIndex *BatchAttachToIndex + + // Attaches a typed link to a specified source and target object. For more + // information, see Typed Links + // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). + AttachTypedLink *BatchAttachTypedLink + // Creates an index object. See Indexing and search // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.htm) // for more information. CreateIndex *BatchCreateIndex + // Creates an object. + CreateObject *BatchCreateObject + + // Deletes an object in a Directory (). + DeleteObject *BatchDeleteObject + // Detaches the specified object from the specified index. DetachFromIndex *BatchDetachFromIndex + // Detaches an object from a Directory (). + DetachObject *BatchDetachObject + + // Detaches a policy from a Directory (). + DetachPolicy *BatchDetachPolicy + // Detaches a typed link from a specified source and target object. For more // information, see Typed Links // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). DetachTypedLink *BatchDetachTypedLink - // Attaches a typed link to a specified source and target object. For more - // information, see Typed Links - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). - AttachTypedLink *BatchAttachTypedLink - // A batch operation that removes a facet from an object. RemoveFacetFromObject *BatchRemoveFacetFromObject - // A batch operation that adds a facet to an object. - AddFacetToObject *BatchAddFacetToObject - - // Attaches the specified object to the specified index. - AttachToIndex *BatchAttachToIndex - - // Creates an object. - CreateObject *BatchCreateObject - - // Attaches a policy object to a regular object. An object can have a limited - // number of attached policies. - AttachPolicy *BatchAttachPolicy - - // Detaches a policy from a Directory (). - DetachPolicy *BatchDetachPolicy - - // Deletes an object in a Directory (). - DeleteObject *BatchDeleteObject + // Updates a given object's attributes. + UpdateLinkAttributes *BatchUpdateLinkAttributes // Updates a given object's attributes. UpdateObjectAttributes *BatchUpdateObjectAttributes - - // Detaches an object from a Directory (). - DetachObject *BatchDetachObject } // Represents the output of a BatchWrite response operation. type BatchWriteOperationResponse struct { + // The result of an add facet to object batch operation. + AddFacetToObject *BatchAddFacetToObjectResponse + + // Attaches an object to a Directory (). + AttachObject *BatchAttachObjectResponse + // Attaches a policy object to a regular object. An object can have a limited // number of attached policies. AttachPolicy *BatchAttachPolicyResponse - // Detaches a typed link from a specified source and target object. For more - // information, see Typed Links - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). - DetachTypedLink *BatchDetachTypedLinkResponse - - // Creates an object in a Directory (). - CreateObject *BatchCreateObjectResponse - - // Detaches a policy from a Directory (). - DetachPolicy *BatchDetachPolicyResponse + // Attaches the specified object to the specified index. + AttachToIndex *BatchAttachToIndexResponse // Attaches a typed link to a specified source and target object. For more // information, see Typed Links // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). AttachTypedLink *BatchAttachTypedLinkResponse - // The result of a batch remove facet from object operation. - RemoveFacetFromObject *BatchRemoveFacetFromObjectResponse - - // Detaches an object from a Directory (). - DetachObject *BatchDetachObjectResponse - // Creates an index object. See Indexing and search // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.htm) // for more information. CreateIndex *BatchCreateIndexResponse - // Attaches an object to a Directory (). - AttachObject *BatchAttachObjectResponse + // Creates an object in a Directory (). + CreateObject *BatchCreateObjectResponse // Deletes an object in a Directory (). DeleteObject *BatchDeleteObjectResponse @@ -1032,34 +1024,42 @@ type BatchWriteOperationResponse struct { // Detaches the specified object from the specified index. DetachFromIndex *BatchDetachFromIndexResponse - // The result of an add facet to object batch operation. - AddFacetToObject *BatchAddFacetToObjectResponse + // Detaches an object from a Directory (). + DetachObject *BatchDetachObjectResponse - // Updates a given object’s attributes. - UpdateObjectAttributes *BatchUpdateObjectAttributesResponse + // Detaches a policy from a Directory (). + DetachPolicy *BatchDetachPolicyResponse + + // Detaches a typed link from a specified source and target object. For more + // information, see Typed Links + // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). + DetachTypedLink *BatchDetachTypedLinkResponse + + // The result of a batch remove facet from object operation. + RemoveFacetFromObject *BatchRemoveFacetFromObjectResponse // Represents the output of a BatchWrite response operation. UpdateLinkAttributes *BatchUpdateLinkAttributesResponse - // Attaches the specified object to the specified index. - AttachToIndex *BatchAttachToIndexResponse + // Updates a given object’s attributes. + UpdateObjectAttributes *BatchUpdateObjectAttributesResponse } // Directory structure that includes the directory name and directory ARN. type Directory struct { + // The date and time when the directory was created. + CreationDateTime *time.Time + // The Amazon Resource Name (ARN) that is associated with the directory. For more // information, see arns (). DirectoryArn *string - // The date and time when the directory was created. - CreationDateTime *time.Time + // The name of the directory. + Name *string // The state of the directory. Can be either Enabled, Disabled, or Deleted. State DirectoryState - - // The name of the directory. - Name *string } // A structure that contains Name, ARN, Attributes, Rule ()s, and ObjectTypes. See @@ -1068,10 +1068,6 @@ type Directory struct { // for more information. type Facet struct { - // The object type that is associated with the facet. See - // CreateFacetRequest$ObjectType () for more details. - ObjectType ObjectType - // There are two different styles that you can define on any given facet, Static // and Dynamic. For static facets, all attributes must be defined in the schema. // For dynamic facets, attributes can be defined during data plane operations. @@ -1079,13 +1075,19 @@ type Facet struct { // The name of the Facet (). Name *string + + // The object type that is associated with the facet. See + // CreateFacetRequest$ObjectType () for more details. + ObjectType ObjectType } // An attribute that is associated with the Facet (). type FacetAttribute struct { - // The required behavior of the FacetAttribute. - RequiredBehavior RequiredAttributeBehavior + // The name of the facet attribute. + // + // This member is required. + Name *string // A facet attribute consists of either a definition or a reference. This structure // contains the attribute definition. See Attribute References @@ -1099,10 +1101,8 @@ type FacetAttribute struct { // for more information. AttributeReference *FacetAttributeReference - // The name of the facet attribute. - // - // This member is required. - Name *string + // The required behavior of the FacetAttribute. + RequiredBehavior RequiredAttributeBehavior } // A facet attribute definition. See Attribute References @@ -1118,11 +1118,11 @@ type FacetAttributeDefinition struct { // The default value of the attribute (if configured). DefaultValue *TypedAttributeValue - // Validation rules attached to the attribute definition. - Rules map[string]*Rule - // Whether the attribute is mutable or not. IsImmutable *bool + + // Validation rules attached to the attribute definition. + Rules map[string]*Rule } // The facet attribute reference that specifies the attribute definition that @@ -1149,11 +1149,11 @@ type FacetAttributeReference struct { // A structure that contains information used to update an attribute. type FacetAttributeUpdate struct { - // The attribute to update. - Attribute *FacetAttribute - // The action to perform when updating the attribute. Action UpdateActionType + + // The attribute to update. + Attribute *FacetAttribute } // Represents an index and an attached object. @@ -1173,11 +1173,11 @@ type IndexAttachment struct { // for attributes which don’t contribute to link identity. type LinkAttributeAction struct { - // The value that you want to update to. - AttributeUpdateValue *TypedAttributeValue - // A type that can be either UPDATE_OR_CREATE or DELETE. AttributeActionType UpdateActionType + + // The value that you want to update to. + AttributeUpdateValue *TypedAttributeValue } // Structure that contains attribute update information. @@ -1257,12 +1257,12 @@ type ObjectReference struct { // Returns the path to the ObjectIdentifiers that is associated with the directory. type PathToObjectIdentifiers struct { - // The path that is used to identify the object starting from directory root. - Path *string - // Lists ObjectIdentifiers starting from directory root to the object in the // request. ObjectIdentifiers []*string + + // The path that is used to identify the object starting from directory root. + Path *string } // Contains the PolicyType, PolicyId, and the ObjectIdentifier to which it is @@ -1270,14 +1270,14 @@ type PathToObjectIdentifiers struct { // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies). type PolicyAttachment struct { - // The type of policy that can be associated with PolicyAttachment. - PolicyType *string - // The ObjectIdentifier that is associated with PolicyAttachment. ObjectIdentifier *string // The ID of PolicyAttachment. PolicyId *string + + // The type of policy that can be associated with PolicyAttachment. + PolicyType *string } // Used when a regular object exists in a Directory () and you want to find all of @@ -1295,34 +1295,34 @@ type PolicyToPath struct { // the rule. type Rule struct { - // The type of attribute validation rule. - Type RuleType - // The minimum and maximum parameters that are associated with the rule. Parameters map[string]*string + + // The type of attribute validation rule. + Type RuleType } // A facet. type SchemaFacet struct { + // The name of the facet. + FacetName *string + // The ARN of the schema that contains the facet with no minor component. See arns // () and In-Place Schema Upgrade // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_inplaceschemaupgrade.html) // for a description of when to provide minor versions. SchemaArn *string - - // The name of the facet. - FacetName *string } // The tag structure that contains a tag key and value. type Tag struct { - // The value that is associated with the tag. - Value *string - // The key that is associated with the tag. Key *string + + // The value that is associated with the tag. + Value *string } // Represents the data for a typed attribute. You can set one, and only one, of the @@ -1330,81 +1330,81 @@ type Tag struct { // single value. type TypedAttributeValue struct { - // A string data value. - StringValue *string - - // A number data value. - NumberValue *string - // A binary data value. BinaryValue []byte + // A Boolean data value. + BooleanValue *bool + // A date and time value. DatetimeValue *time.Time - // A Boolean data value. - BooleanValue *bool + // A number data value. + NumberValue *string + + // A string data value. + StringValue *string } // A range of attribute values. For more information, see Range Filters // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_range_filters.html). type TypedAttributeValueRange struct { + // The inclusive or exclusive range end. + // + // This member is required. + EndMode RangeMode + // The inclusive or exclusive range start. // // This member is required. StartMode RangeMode - // The value to start the range at. - StartValue *TypedAttributeValue - // The attribute value to terminate the range at. EndValue *TypedAttributeValue - // The inclusive or exclusive range end. - // - // This member is required. - EndMode RangeMode + // The value to start the range at. + StartValue *TypedAttributeValue } // A typed link attribute definition. type TypedLinkAttributeDefinition struct { - // The default value of the attribute (if configured). - DefaultValue *TypedAttributeValue - // The unique name of the typed link attribute. // // This member is required. Name *string - // Validation rules that are attached to the attribute definition. - Rules map[string]*Rule - - // Whether the attribute is mutable or not. - IsImmutable *bool + // The required behavior of the TypedLinkAttributeDefinition. + // + // This member is required. + RequiredBehavior RequiredAttributeBehavior // The type of the attribute. // // This member is required. Type FacetAttributeType - // The required behavior of the TypedLinkAttributeDefinition. - // - // This member is required. - RequiredBehavior RequiredAttributeBehavior + // The default value of the attribute (if configured). + DefaultValue *TypedAttributeValue + + // Whether the attribute is mutable or not. + IsImmutable *bool + + // Validation rules that are attached to the attribute definition. + Rules map[string]*Rule } // Identifies the range of attributes that are used by a specified filter. type TypedLinkAttributeRange struct { - // The unique name of the typed link attribute. - AttributeName *string - // The range of attribute values that are being selected. // // This member is required. Range *TypedAttributeValueRange + + // The unique name of the typed link attribute. + AttributeName *string } // Defines the typed links structure and its attributes. To create a typed link @@ -1419,11 +1419,6 @@ type TypedLinkFacet struct { // This member is required. Attributes []*TypedLinkAttributeDefinition - // The unique name of the typed link facet. - // - // This member is required. - Name *string - // The set of attributes that distinguish links made from this facet from each // other, in the order of significance. Listing typed links can filter on the // values of these attributes. See ListOutgoingTypedLinks () and @@ -1431,6 +1426,11 @@ type TypedLinkFacet struct { // // This member is required. IdentityAttributeOrder []*string + + // The unique name of the typed link facet. + // + // This member is required. + Name *string } // A typed link facet attribute update. @@ -1472,23 +1472,23 @@ type TypedLinkSchemaAndFacetName struct { // from scratch. type TypedLinkSpecifier struct { - // Identifies the typed link facet that is associated with the typed link. + // Identifies the attribute value to update. // // This member is required. - TypedLinkFacet *TypedLinkSchemaAndFacetName + IdentityAttributeValues []*AttributeNameAndValue - // Identifies the target object that the typed link will attach to. + // Identifies the source object that the typed link will attach to. // // This member is required. - TargetObjectReference *ObjectReference + SourceObjectReference *ObjectReference - // Identifies the attribute value to update. + // Identifies the target object that the typed link will attach to. // // This member is required. - IdentityAttributeValues []*AttributeNameAndValue + TargetObjectReference *ObjectReference - // Identifies the source object that the typed link will attach to. + // Identifies the typed link facet that is associated with the typed link. // // This member is required. - SourceObjectReference *ObjectReference + TypedLinkFacet *TypedLinkSchemaAndFacetName } diff --git a/service/cloudformation/api_op_CancelUpdateStack.go b/service/cloudformation/api_op_CancelUpdateStack.go index 75473fb6a2a..4b6475e05ec 100644 --- a/service/cloudformation/api_op_CancelUpdateStack.go +++ b/service/cloudformation/api_op_CancelUpdateStack.go @@ -59,17 +59,17 @@ func (c *Client) CancelUpdateStack(ctx context.Context, params *CancelUpdateStac // The input for the CancelUpdateStack () action. type CancelUpdateStackInput struct { + // The name or the unique stack ID that is associated with the stack. + // + // This member is required. + StackName *string + // A unique identifier for this CancelUpdateStack request. Specify this token if // you plan to retry requests so that AWS CloudFormation knows that you're not // attempting to cancel an update on a stack with the same name. You might retry // CancelUpdateStack requests to ensure that AWS CloudFormation successfully // received them. ClientRequestToken *string - - // The name or the unique stack ID that is associated with the stack. - // - // This member is required. - StackName *string } type CancelUpdateStackOutput struct { diff --git a/service/cloudformation/api_op_ContinueUpdateRollback.go b/service/cloudformation/api_op_ContinueUpdateRollback.go index 797b15ec2ed..39628bf0289 100644 --- a/service/cloudformation/api_op_ContinueUpdateRollback.go +++ b/service/cloudformation/api_op_ContinueUpdateRollback.go @@ -77,17 +77,12 @@ type ContinueUpdateRollbackInput struct { // This member is required. StackName *string - // The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) - // role that AWS CloudFormation assumes to roll back the stack. AWS CloudFormation - // uses the role's credentials to make calls on your behalf. AWS CloudFormation - // always uses this role for all future operations on the stack. As long as users - // have permission to operate on the stack, AWS CloudFormation uses this role even - // if the users don't have permission to pass it. Ensure that the role grants least - // privilege. If you don't specify a value, AWS CloudFormation uses the role that - // was previously associated with the stack. If no role is available, AWS - // CloudFormation uses a temporary session that is generated from your user - // credentials. - RoleARN *string + // A unique identifier for this ContinueUpdateRollback request. Specify this token + // if you plan to retry requests so that AWS CloudFormation knows that you're not + // attempting to continue the rollback to a stack with the same name. You might + // retry ContinueUpdateRollback requests to ensure that AWS CloudFormation + // successfully received them. + ClientRequestToken *string // A list of the logical IDs of the resources that AWS CloudFormation skips during // the continue update rollback operation. You can specify only resources that are @@ -119,12 +114,17 @@ type ContinueUpdateRollbackInput struct { // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html#nested-stacks). ResourcesToSkip []*string - // A unique identifier for this ContinueUpdateRollback request. Specify this token - // if you plan to retry requests so that AWS CloudFormation knows that you're not - // attempting to continue the rollback to a stack with the same name. You might - // retry ContinueUpdateRollback requests to ensure that AWS CloudFormation - // successfully received them. - ClientRequestToken *string + // The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) + // role that AWS CloudFormation assumes to roll back the stack. AWS CloudFormation + // uses the role's credentials to make calls on your behalf. AWS CloudFormation + // always uses this role for all future operations on the stack. As long as users + // have permission to operate on the stack, AWS CloudFormation uses this role even + // if the users don't have permission to pass it. Ensure that the role grants least + // privilege. If you don't specify a value, AWS CloudFormation uses the role that + // was previously associated with the stack. If no role is available, AWS + // CloudFormation uses a temporary session that is generated from your user + // credentials. + RoleARN *string } // The output for a ContinueUpdateRollback () action. diff --git a/service/cloudformation/api_op_CreateChangeSet.go b/service/cloudformation/api_op_CreateChangeSet.go index fec5835ebf3..4d9f10353b4 100644 --- a/service/cloudformation/api_op_CreateChangeSet.go +++ b/service/cloudformation/api_op_CreateChangeSet.go @@ -75,16 +75,21 @@ func (c *Client) CreateChangeSet(ctx context.Context, params *CreateChangeSetInp // The input for the CreateChangeSet () action. type CreateChangeSetInput struct { - // The resources to import into your stack. - ResourcesToImport []*types.ResourceToImport - - // Key-value pairs to associate with this stack. AWS CloudFormation also propagates - // these tags to resources in the stack. You can specify a maximum of 50 tags. - Tags []*types.Tag + // The name of the change set. The name must be unique among all change sets that + // are associated with the specified stack. A change set name can contain only + // alphanumeric, case sensitive characters and hyphens. It must start with an + // alphabetic character and cannot exceed 128 characters. + // + // This member is required. + ChangeSetName *string - // The rollback triggers for AWS CloudFormation to monitor during stack creation - // and updating operations, and for the specified monitoring period afterwards. - RollbackConfiguration *types.RollbackConfiguration + // The name or the unique ID of the stack for which you are creating a change set. + // AWS CloudFormation generates the change set by comparing this stack's + // information with the information that you submit, such as a modified template or + // different parameter input values. + // + // This member is required. + StackName *string // In some cases, you must explicitly acknowledge that your stack template contains // certain capabilities in order for AWS CloudFormation to create the stack. @@ -167,25 +172,51 @@ type CreateChangeSetInput struct { // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html). Capabilities []types.Capability + // The type of change set operation. To create a change set for a new stack, + // specify CREATE. To create a change set for an existing stack, specify UPDATE. To + // create a change set for an import operation, specify IMPORT. If you create a + // change set for a new stack, AWS Cloudformation creates a stack with a unique + // stack ID, but no template or resources. The stack will be in the + // REVIEW_IN_PROGRESS + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html#d0e11995) + // state until you execute the change set. By default, AWS CloudFormation specifies + // UPDATE. You can't use the UPDATE type to create a change set for a new stack or + // the CREATE type to create a change set for an existing stack. + ChangeSetType types.ChangeSetType + + // A unique identifier for this CreateChangeSet request. Specify this token if you + // plan to retry requests so that AWS CloudFormation knows that you're not + // attempting to create another change set with the same name. You might retry + // CreateChangeSet requests to ensure that AWS CloudFormation successfully received + // them. + ClientToken *string + + // A description to help you identify this change set. + Description *string + // The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon // SNS) topics that AWS CloudFormation associates with the stack. To remove all // associated notification topics, specify an empty list. NotificationARNs []*string - // The location of the file that contains the revised template. The URL must point - // to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS - // CloudFormation generates the change set by comparing this template with the - // stack that you specified. Conditional: You must specify only TemplateBody or - // TemplateURL. - TemplateURL *string + // A list of Parameter structures that specify input parameters for the change set. + // For more information, see the Parameter () data type. + Parameters []*types.Parameter - // The name of the change set. The name must be unique among all change sets that - // are associated with the specified stack. A change set name can contain only - // alphanumeric, case sensitive characters and hyphens. It must start with an - // alphabetic character and cannot exceed 128 characters. - // - // This member is required. - ChangeSetName *string + // The template resource types that you have permissions to work with if you + // execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or + // Custom::MyCustomInstance. If the list of resource types doesn't include a + // resource type that you're updating, the stack update fails. By default, AWS + // CloudFormation grants permissions to all resource types. AWS Identity and Access + // Management (IAM) uses this parameter for condition keys in IAM policies for AWS + // CloudFormation. For more information, see Controlling Access with AWS Identity + // and Access Management + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html) + // in the AWS CloudFormation User Guide. + ResourceTypes []*string + + // The resources to import into your stack. + ResourcesToImport []*types.ResourceToImport // The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) // role that AWS CloudFormation assumes when executing the change set. AWS @@ -199,6 +230,14 @@ type CreateChangeSetInput struct { // credentials. RoleARN *string + // The rollback triggers for AWS CloudFormation to monitor during stack creation + // and updating operations, and for the specified monitoring period afterwards. + RollbackConfiguration *types.RollbackConfiguration + + // Key-value pairs to associate with this stack. AWS CloudFormation also propagates + // these tags to resources in the stack. You can specify a maximum of 50 tags. + Tags []*types.Tag + // A structure that contains the body of the revised template, with a minimum // length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation // generates the change set by comparing this template with the template of the @@ -206,66 +245,27 @@ type CreateChangeSetInput struct { // TemplateURL. TemplateBody *string + // The location of the file that contains the revised template. The URL must point + // to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS + // CloudFormation generates the change set by comparing this template with the + // stack that you specified. Conditional: You must specify only TemplateBody or + // TemplateURL. + TemplateURL *string + // Whether to reuse the template that is associated with the stack to create the // change set. UsePreviousTemplate *bool - - // A list of Parameter structures that specify input parameters for the change set. - // For more information, see the Parameter () data type. - Parameters []*types.Parameter - - // The template resource types that you have permissions to work with if you - // execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or - // Custom::MyCustomInstance. If the list of resource types doesn't include a - // resource type that you're updating, the stack update fails. By default, AWS - // CloudFormation grants permissions to all resource types. AWS Identity and Access - // Management (IAM) uses this parameter for condition keys in IAM policies for AWS - // CloudFormation. For more information, see Controlling Access with AWS Identity - // and Access Management - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html) - // in the AWS CloudFormation User Guide. - ResourceTypes []*string - - // A description to help you identify this change set. - Description *string - - // The name or the unique ID of the stack for which you are creating a change set. - // AWS CloudFormation generates the change set by comparing this stack's - // information with the information that you submit, such as a modified template or - // different parameter input values. - // - // This member is required. - StackName *string - - // A unique identifier for this CreateChangeSet request. Specify this token if you - // plan to retry requests so that AWS CloudFormation knows that you're not - // attempting to create another change set with the same name. You might retry - // CreateChangeSet requests to ensure that AWS CloudFormation successfully received - // them. - ClientToken *string - - // The type of change set operation. To create a change set for a new stack, - // specify CREATE. To create a change set for an existing stack, specify UPDATE. To - // create a change set for an import operation, specify IMPORT. If you create a - // change set for a new stack, AWS Cloudformation creates a stack with a unique - // stack ID, but no template or resources. The stack will be in the - // REVIEW_IN_PROGRESS - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html#d0e11995) - // state until you execute the change set. By default, AWS CloudFormation specifies - // UPDATE. You can't use the UPDATE type to create a change set for a new stack or - // the CREATE type to create a change set for an existing stack. - ChangeSetType types.ChangeSetType } // The output for the CreateChangeSet () action. type CreateChangeSetOutput struct { - // The unique ID of the stack. - StackId *string - // The Amazon Resource Name (ARN) of the change set. Id *string + // The unique ID of the stack. + StackId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudformation/api_op_CreateStack.go b/service/cloudformation/api_op_CreateStack.go index 00711bb8de1..45852ffe45d 100644 --- a/service/cloudformation/api_op_CreateStack.go +++ b/service/cloudformation/api_op_CreateStack.go @@ -60,20 +60,6 @@ func (c *Client) CreateStack(ctx context.Context, params *CreateStackInput, optF // The input for CreateStack () action. type CreateStackInput struct { - // Structure containing the stack policy body. For more information, go to Prevent - // Updates to Stack Resources - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) - // in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody - // or the StackPolicyURL parameter, but not both. - StackPolicyBody *string - - // Structure containing the template body with a minimum length of 1 byte and a - // maximum length of 51,200 bytes. For more information, go to Template Anatomy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) - // in the AWS CloudFormation User Guide. Conditional: You must specify either the - // TemplateBody or the TemplateURL parameter, but not both. - TemplateBody *string - // The name that is associated with the stack. The name must be unique in the // Region in which you are creating the stack. A stack name can contain only // alphanumeric characters (case sensitive) and hyphens. It must start with an @@ -82,22 +68,6 @@ type CreateStackInput struct { // This member is required. StackName *string - // Location of a file containing the stack policy. The URL must point to a policy - // (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. - // You can specify either the StackPolicyBody or the StackPolicyURL parameter, but - // not both. - StackPolicyURL *string - - // Determines what action will be taken if stack creation fails. This must be one - // of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or - // DisableRollback, but not both. Default: ROLLBACK - OnFailure types.OnFailure - - // The Simple Notification Service (SNS) topic ARNs to publish stack related - // events. You can find your SNS topic ARNs using the SNS console or your Command - // Line Interface (CLI). - NotificationARNs []*string - // In some cases, you must explicitly acknowledge that your stack template contains // certain capabilities in order for AWS CloudFormation to create the stack. // @@ -181,6 +151,25 @@ type CreateStackInput struct { // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html). Capabilities []types.Capability + // A unique identifier for this CreateStack request. Specify this token if you plan + // to retry requests so that AWS CloudFormation knows that you're not attempting to + // create a stack with the same name. You might retry CreateStack requests to + // ensure that AWS CloudFormation successfully received them. All events triggered + // by a given stack operation are assigned the same client request token, which you + // can use to track operations. For example, if you execute a CreateStack operation + // with the token token1, then all the StackEvents generated by that operation will + // have ClientRequestToken set as token1. In the console, stack operations display + // the client request token on the Events tab. Stack operations that are initiated + // from the console use the token format Console-StackOperation-ID, which helps you + // easily identify the stack operation . For example, if you create a stack using + // the console, each stack event would be assigned the same token in the following + // format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. + ClientRequestToken *string + + // Set to true to disable rollback of the stack if stack creation failed. You can + // specify either DisableRollback or OnFailure, but not both. Default: false + DisableRollback *bool + // Whether to enable termination protection on the specified stack. If a user // attempts to delete a stack with termination protection enabled, the operation // fails and the stack remains unchanged. For more information, see Protecting a @@ -193,34 +182,15 @@ type CreateStackInput struct { // on the nested stack. EnableTerminationProtection *bool - // The amount of time that can pass before the stack status becomes CREATE_FAILED; - // if DisableRollback is not set or is set to false, the stack will be rolled back. - TimeoutInMinutes *int32 - - // Set to true to disable rollback of the stack if stack creation failed. You can - // specify either DisableRollback or OnFailure, but not both. Default: false - DisableRollback *bool - - // The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) - // role that AWS CloudFormation assumes to create the stack. AWS CloudFormation - // uses the role's credentials to make calls on your behalf. AWS CloudFormation - // always uses this role for all future operations on the stack. As long as users - // have permission to operate on the stack, AWS CloudFormation uses this role even - // if the users don't have permission to pass it. Ensure that the role grants least - // privilege. If you don't specify a value, AWS CloudFormation uses the role that - // was previously associated with the stack. If no role is available, AWS - // CloudFormation uses a temporary session that is generated from your user - // credentials. - RoleARN *string - - // Key-value pairs to associate with this stack. AWS CloudFormation also propagates - // these tags to the resources created in the stack. A maximum number of 50 tags - // can be specified. - Tags []*types.Tag + // The Simple Notification Service (SNS) topic ARNs to publish stack related + // events. You can find your SNS topic ARNs using the SNS console or your Command + // Line Interface (CLI). + NotificationARNs []*string - // The rollback triggers for AWS CloudFormation to monitor during stack creation - // and updating operations, and for the specified monitoring period afterwards. - RollbackConfiguration *types.RollbackConfiguration + // Determines what action will be taken if stack creation fails. This must be one + // of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or + // DisableRollback, but not both. Default: ROLLBACK + OnFailure types.OnFailure // A list of Parameter structures that specify input parameters for the stack. For // more information, see the Parameter @@ -243,20 +213,46 @@ type CreateStackInput struct { // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html). ResourceTypes []*string - // A unique identifier for this CreateStack request. Specify this token if you plan - // to retry requests so that AWS CloudFormation knows that you're not attempting to - // create a stack with the same name. You might retry CreateStack requests to - // ensure that AWS CloudFormation successfully received them. All events triggered - // by a given stack operation are assigned the same client request token, which you - // can use to track operations. For example, if you execute a CreateStack operation - // with the token token1, then all the StackEvents generated by that operation will - // have ClientRequestToken set as token1. In the console, stack operations display - // the client request token on the Events tab. Stack operations that are initiated - // from the console use the token format Console-StackOperation-ID, which helps you - // easily identify the stack operation . For example, if you create a stack using - // the console, each stack event would be assigned the same token in the following - // format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. - ClientRequestToken *string + // The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) + // role that AWS CloudFormation assumes to create the stack. AWS CloudFormation + // uses the role's credentials to make calls on your behalf. AWS CloudFormation + // always uses this role for all future operations on the stack. As long as users + // have permission to operate on the stack, AWS CloudFormation uses this role even + // if the users don't have permission to pass it. Ensure that the role grants least + // privilege. If you don't specify a value, AWS CloudFormation uses the role that + // was previously associated with the stack. If no role is available, AWS + // CloudFormation uses a temporary session that is generated from your user + // credentials. + RoleARN *string + + // The rollback triggers for AWS CloudFormation to monitor during stack creation + // and updating operations, and for the specified monitoring period afterwards. + RollbackConfiguration *types.RollbackConfiguration + + // Structure containing the stack policy body. For more information, go to Prevent + // Updates to Stack Resources + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) + // in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody + // or the StackPolicyURL parameter, but not both. + StackPolicyBody *string + + // Location of a file containing the stack policy. The URL must point to a policy + // (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. + // You can specify either the StackPolicyBody or the StackPolicyURL parameter, but + // not both. + StackPolicyURL *string + + // Key-value pairs to associate with this stack. AWS CloudFormation also propagates + // these tags to the resources created in the stack. A maximum number of 50 tags + // can be specified. + Tags []*types.Tag + + // Structure containing the template body with a minimum length of 1 byte and a + // maximum length of 51,200 bytes. For more information, go to Template Anatomy + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) + // in the AWS CloudFormation User Guide. Conditional: You must specify either the + // TemplateBody or the TemplateURL parameter, but not both. + TemplateBody *string // Location of file containing the template body. The URL must point to a template // (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more @@ -265,6 +261,10 @@ type CreateStackInput struct { // in the AWS CloudFormation User Guide. Conditional: You must specify either the // TemplateBody or the TemplateURL parameter, but not both. TemplateURL *string + + // The amount of time that can pass before the stack status becomes CREATE_FAILED; + // if DisableRollback is not set or is set to false, the stack will be rolled back. + TimeoutInMinutes *int32 } // The output for a CreateStack () action. diff --git a/service/cloudformation/api_op_CreateStackInstances.go b/service/cloudformation/api_op_CreateStackInstances.go index a65c24b5866..9423670d81e 100644 --- a/service/cloudformation/api_op_CreateStackInstances.go +++ b/service/cloudformation/api_op_CreateStackInstances.go @@ -74,15 +74,6 @@ type CreateStackInstancesInput struct { // This member is required. StackSetName *string - // The unique identifier for this stack set operation. The operation ID also - // functions as an idempotency token, to ensure that AWS CloudFormation performs - // the stack set operation only once, even if you retry the request multiple times. - // You might retry stack set operation requests to ensure that AWS CloudFormation - // successfully received them. If you don't specify an operation ID, the SDK - // generates one automatically. Repeating this stack set operation with a new - // operation ID retries all stack instances whose status is OUTDATED. - OperationId *string - // [Self-managed permissions] The names of one or more AWS accounts that you want // to create stack instances in the specified Region(s) for. You can specify // Accounts or DeploymentTargets, but not both. @@ -93,6 +84,15 @@ type CreateStackInstancesInput struct { // DeploymentTargets, but not both. DeploymentTargets *types.DeploymentTargets + // The unique identifier for this stack set operation. The operation ID also + // functions as an idempotency token, to ensure that AWS CloudFormation performs + // the stack set operation only once, even if you retry the request multiple times. + // You might retry stack set operation requests to ensure that AWS CloudFormation + // successfully received them. If you don't specify an operation ID, the SDK + // generates one automatically. Repeating this stack set operation with a new + // operation ID retries all stack instances whose status is OUTDATED. + OperationId *string + // Preferences for how AWS CloudFormation performs this stack set operation. OperationPreferences *types.StackSetOperationPreferences diff --git a/service/cloudformation/api_op_CreateStackSet.go b/service/cloudformation/api_op_CreateStackSet.go index d6f68d6f98d..5fbf310f1c7 100644 --- a/service/cloudformation/api_op_CreateStackSet.go +++ b/service/cloudformation/api_op_CreateStackSet.go @@ -59,19 +59,13 @@ func (c *Client) CreateStackSet(ctx context.Context, params *CreateStackSetInput type CreateStackSetInput struct { - // The structure that contains the template body, with a minimum length of 1 byte - // and a maximum length of 51,200 bytes. For more information, see Template Anatomy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) - // in the AWS CloudFormation User Guide. Conditional: You must specify either the - // TemplateBody or the TemplateURL parameter, but not both. - TemplateBody *string - - // The name of the IAM execution role to use to create the stack set. If you do not - // specify an execution role, AWS CloudFormation uses the - // AWSCloudFormationStackSetExecutionRole role for the stack set operation. Specify - // an IAM role only if you are using customized execution roles to control which - // stack resources users and groups can include in their stack sets.

- ExecutionRoleName *string + // The name to associate with the stack set. The name must be unique in the Region + // where you create your stack set. A stack name can contain only alphanumeric + // characters (case-sensitive) and hyphens. It must start with an alphabetic + // character and can't be longer than 128 characters. + // + // This member is required. + StackSetName *string // The Amazon Resource Number (ARN) of the IAM role to use to create this stack // set. Specify an IAM role only if you are using customized administrator roles to @@ -87,45 +81,6 @@ type CreateStackSetInput struct { // only if PermissionModel is SERVICE_MANAGED. AutoDeployment *types.AutoDeployment - // The name to associate with the stack set. The name must be unique in the Region - // where you create your stack set. A stack name can contain only alphanumeric - // characters (case-sensitive) and hyphens. It must start with an alphabetic - // character and can't be longer than 128 characters. - // - // This member is required. - StackSetName *string - - // The input parameters for the stack set template. - Parameters []*types.Parameter - - // A description of the stack set. You can use the description to identify the - // stack set's purpose or other important information. - Description *string - - // The key-value pairs to associate with this stack set and the stacks created from - // it. AWS CloudFormation also propagates these tags to supported resources that - // are created in the stacks. A maximum number of 50 tags can be specified. If you - // specify tags as part of a CreateStackSet action, AWS CloudFormation checks to - // see if you have the required IAM permission to tag resources. If you don't, the - // entire CreateStackSet action fails with an access denied error, and the stack - // set is not created. - Tags []*types.Tag - - // The location of the file that contains the template body. The URL must point to - // a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket. - // For more information, see Template Anatomy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) - // in the AWS CloudFormation User Guide. Conditional: You must specify either the - // TemplateBody or the TemplateURL parameter, but not both. - TemplateURL *string - - // A unique identifier for this CreateStackSet request. Specify this token if you - // plan to retry requests so that AWS CloudFormation knows that you're not - // attempting to create another stack set with the same name. You might retry - // CreateStackSet requests to ensure that AWS CloudFormation successfully received - // them. If you don't specify an operation ID, the SDK generates one automatically. - ClientRequestToken *string - // In some cases, you must explicitly acknowledge that your stack set template // contains certain capabilities in order for AWS CloudFormation to create the // stack set and related stack instances. @@ -201,6 +156,27 @@ type CreateStackSetInput struct { // will fail. Capabilities []types.Capability + // A unique identifier for this CreateStackSet request. Specify this token if you + // plan to retry requests so that AWS CloudFormation knows that you're not + // attempting to create another stack set with the same name. You might retry + // CreateStackSet requests to ensure that AWS CloudFormation successfully received + // them. If you don't specify an operation ID, the SDK generates one automatically. + ClientRequestToken *string + + // A description of the stack set. You can use the description to identify the + // stack set's purpose or other important information. + Description *string + + // The name of the IAM execution role to use to create the stack set. If you do not + // specify an execution role, AWS CloudFormation uses the + // AWSCloudFormationStackSetExecutionRole role for the stack set operation. Specify + // an IAM role only if you are using customized execution roles to control which + // stack resources users and groups can include in their stack sets.

+ ExecutionRoleName *string + + // The input parameters for the stack set template. + Parameters []*types.Parameter + // Describes how the IAM roles required for stack set operations are created. By // default, SELF-MANAGED is specified. // @@ -215,6 +191,30 @@ type CreateStackSetInput struct { // information, see Grant Service-Managed Stack Set Permissions // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html). PermissionModel types.PermissionModels + + // The key-value pairs to associate with this stack set and the stacks created from + // it. AWS CloudFormation also propagates these tags to supported resources that + // are created in the stacks. A maximum number of 50 tags can be specified. If you + // specify tags as part of a CreateStackSet action, AWS CloudFormation checks to + // see if you have the required IAM permission to tag resources. If you don't, the + // entire CreateStackSet action fails with an access denied error, and the stack + // set is not created. + Tags []*types.Tag + + // The structure that contains the template body, with a minimum length of 1 byte + // and a maximum length of 51,200 bytes. For more information, see Template Anatomy + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) + // in the AWS CloudFormation User Guide. Conditional: You must specify either the + // TemplateBody or the TemplateURL parameter, but not both. + TemplateBody *string + + // The location of the file that contains the template body. The URL must point to + // a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket. + // For more information, see Template Anatomy + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) + // in the AWS CloudFormation User Guide. Conditional: You must specify either the + // TemplateBody or the TemplateURL parameter, but not both. + TemplateURL *string } type CreateStackSetOutput struct { diff --git a/service/cloudformation/api_op_DeleteStack.go b/service/cloudformation/api_op_DeleteStack.go index f52733d562a..acbec348cbf 100644 --- a/service/cloudformation/api_op_DeleteStack.go +++ b/service/cloudformation/api_op_DeleteStack.go @@ -59,6 +59,11 @@ func (c *Client) DeleteStack(ctx context.Context, params *DeleteStackInput, optF // The input for DeleteStack () action. type DeleteStackInput struct { + // The name or the unique stack ID that is associated with the stack. + // + // This member is required. + StackName *string + // A unique identifier for this DeleteStack request. Specify this token if you plan // to retry requests so that AWS CloudFormation knows that you're not attempting to // delete a stack with the same name. You might retry DeleteStack requests to @@ -74,14 +79,6 @@ type DeleteStackInput struct { // format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. ClientRequestToken *string - // The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) - // role that AWS CloudFormation assumes to delete the stack. AWS CloudFormation - // uses the role's credentials to make calls on your behalf. If you don't specify a - // value, AWS CloudFormation uses the role that was previously associated with the - // stack. If no role is available, AWS CloudFormation uses a temporary session that - // is generated from your user credentials. - RoleARN *string - // For stacks in the DELETE_FAILED state, a list of resource logical IDs that are // associated with the resources you want to retain. During deletion, AWS // CloudFormation deletes the stack but does not delete the retained resources. @@ -89,10 +86,13 @@ type DeleteStackInput struct { // non-empty S3 bucket, but you want to delete the stack. RetainResources []*string - // The name or the unique stack ID that is associated with the stack. - // - // This member is required. - StackName *string + // The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) + // role that AWS CloudFormation assumes to delete the stack. AWS CloudFormation + // uses the role's credentials to make calls on your behalf. If you don't specify a + // value, AWS CloudFormation uses the role that was previously associated with the + // stack. If no role is available, AWS CloudFormation uses a temporary session that + // is generated from your user credentials. + RoleARN *string } type DeleteStackOutput struct { diff --git a/service/cloudformation/api_op_DeleteStackInstances.go b/service/cloudformation/api_op_DeleteStackInstances.go index e2005da7c82..1ff30e9e1d2 100644 --- a/service/cloudformation/api_op_DeleteStackInstances.go +++ b/service/cloudformation/api_op_DeleteStackInstances.go @@ -59,22 +59,11 @@ func (c *Client) DeleteStackInstances(ctx context.Context, params *DeleteStackIn type DeleteStackInstancesInput struct { - // The name or unique ID of the stack set that you want to delete stack instances - // for. - // - // This member is required. - StackSetName *string - // The Regions where you want to delete stack set instances. // // This member is required. Regions []*string - // [Self-managed permissions] The names of the AWS accounts that you want to delete - // stack instances for. You can specify Accounts or DeploymentTargets, but not - // both. - Accounts []*string - // Removes the stack instances from the specified stack set, but doesn't delete the // stacks. You can't reassociate a retained stack or add an existing, saved stack // to a new stack set. For more information, see Stack set operation options @@ -83,8 +72,16 @@ type DeleteStackInstancesInput struct { // This member is required. RetainStacks *bool - // Preferences for how AWS CloudFormation performs this stack set operation. - OperationPreferences *types.StackSetOperationPreferences + // The name or unique ID of the stack set that you want to delete stack instances + // for. + // + // This member is required. + StackSetName *string + + // [Self-managed permissions] The names of the AWS accounts that you want to delete + // stack instances for. You can specify Accounts or DeploymentTargets, but not + // both. + Accounts []*string // [Service-managed permissions] The AWS Organizations accounts from which to // delete stack instances. You can specify Accounts or DeploymentTargets, but not @@ -99,6 +96,9 @@ type DeleteStackInstancesInput struct { // successfully received them. Repeating this stack set operation with a new // operation ID retries all stack instances whose status is OUTDATED. OperationId *string + + // Preferences for how AWS CloudFormation performs this stack set operation. + OperationPreferences *types.StackSetOperationPreferences } type DeleteStackInstancesOutput struct { diff --git a/service/cloudformation/api_op_DeregisterType.go b/service/cloudformation/api_op_DeregisterType.go index 48e41a15ab1..cb398b65050 100644 --- a/service/cloudformation/api_op_DeregisterType.go +++ b/service/cloudformation/api_op_DeregisterType.go @@ -67,14 +67,14 @@ type DeregisterTypeInput struct { // TypeName and Type, or Arn. Arn *string - // The name of the type. Conditional: You must specify either TypeName and Type, or - // Arn. - TypeName *string - // The kind of type. Currently the only valid value is RESOURCE. Conditional: You // must specify either TypeName and Type, or Arn. Type types.RegistryType + // The name of the type. Conditional: You must specify either TypeName and Type, or + // Arn. + TypeName *string + // The ID of a specific version of the type. The version ID is the value at the end // of the Amazon Resource Name (ARN) assigned to the type version when it is // registered. diff --git a/service/cloudformation/api_op_DescribeAccountLimits.go b/service/cloudformation/api_op_DescribeAccountLimits.go index 111b6269594..31a84b0d354 100644 --- a/service/cloudformation/api_op_DescribeAccountLimits.go +++ b/service/cloudformation/api_op_DescribeAccountLimits.go @@ -68,14 +68,14 @@ type DescribeAccountLimitsInput struct { // The output for the DescribeAccountLimits () action. type DescribeAccountLimitsOutput struct { - // If the output exceeds 1 MB in size, a string that identifies the next page of - // limits. If no additional page exists, this value is null. - NextToken *string - // An account limit structure that contain a list of AWS CloudFormation account // limits and their values. AccountLimits []*types.AccountLimit + // If the output exceeds 1 MB in size, a string that identifies the next page of + // limits. If no additional page exists, this value is null. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudformation/api_op_DescribeChangeSet.go b/service/cloudformation/api_op_DescribeChangeSet.go index 10663bc0638..347501a0c52 100644 --- a/service/cloudformation/api_op_DescribeChangeSet.go +++ b/service/cloudformation/api_op_DescribeChangeSet.go @@ -69,78 +69,78 @@ type DescribeChangeSetInput struct { // This member is required. ChangeSetName *string - // If you specified the name of a change set, specify the stack name or ID (ARN) of - // the change set you want to describe. - StackName *string - // A string (provided by the DescribeChangeSet () response output) that identifies // the next page of information that you want to retrieve. NextToken *string + + // If you specified the name of a change set, specify the stack name or ID (ARN) of + // the change set you want to describe. + StackName *string } // The output for the DescribeChangeSet () action. type DescribeChangeSetOutput struct { - // A list of Parameter structures that describes the input parameters and their - // values used to create the change set. For more information, see the Parameter - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html) - // data type. - Parameters []*types.Parameter + // If you execute the change set, the list of capabilities that were explicitly + // acknowledged when the change set was created. + Capabilities []types.Capability + + // The ARN of the change set. + ChangeSetId *string + + // The name of the change set. + ChangeSetName *string // A list of Change structures that describes the resources AWS CloudFormation // changes if you execute the change set. Changes []*types.Change - // The current status of the change set, such as CREATE_IN_PROGRESS, - // CREATE_COMPLETE, or FAILED. - Status types.ChangeSetStatus - - // The name of the stack that is associated with the change set. - StackName *string - - // The ARN of the stack that is associated with the change set. - StackId *string - // The start time when the change set was created, in UTC. CreationTime *time.Time // Information about the change set. Description *string - // If you execute the change set, the list of capabilities that were explicitly - // acknowledged when the change set was created. - Capabilities []types.Capability + // If the change set execution status is AVAILABLE, you can execute the change set. + // If you can’t execute the change set, the status indicates why. For example, a + // change set might be in an UNAVAILABLE state because AWS CloudFormation is still + // creating it or in an OBSOLETE state because the stack was already updated. + ExecutionStatus types.ExecutionStatus - // If you execute the change set, the tags that will be associated with the stack. - Tags []*types.Tag + // If the output exceeds 1 MB, a string that identifies the next page of changes. + // If there is no additional page, this value is null. + NextToken *string + + // The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will + // be associated with the stack if you execute the change set. + NotificationARNs []*string + + // A list of Parameter structures that describes the input parameters and their + // values used to create the change set. For more information, see the Parameter + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html) + // data type. + Parameters []*types.Parameter // The rollback triggers for AWS CloudFormation to monitor during stack creation // and updating operations, and for the specified monitoring period afterwards. RollbackConfiguration *types.RollbackConfiguration - // The name of the change set. - ChangeSetName *string + // The ARN of the stack that is associated with the change set. + StackId *string + + // The name of the stack that is associated with the change set. + StackName *string + + // The current status of the change set, such as CREATE_IN_PROGRESS, + // CREATE_COMPLETE, or FAILED. + Status types.ChangeSetStatus // A description of the change set's status. For example, if your attempt to create // a change set failed, AWS CloudFormation shows the error message. StatusReason *string - // If the output exceeds 1 MB, a string that identifies the next page of changes. - // If there is no additional page, this value is null. - NextToken *string - - // The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will - // be associated with the stack if you execute the change set. - NotificationARNs []*string - - // The ARN of the change set. - ChangeSetId *string - - // If the change set execution status is AVAILABLE, you can execute the change set. - // If you can’t execute the change set, the status indicates why. For example, a - // change set might be in an UNAVAILABLE state because AWS CloudFormation is still - // creating it or in an OBSOLETE state because the stack was already updated. - ExecutionStatus types.ExecutionStatus + // If you execute the change set, the tags that will be associated with the stack. + Tags []*types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/cloudformation/api_op_DescribeStackDriftDetectionStatus.go b/service/cloudformation/api_op_DescribeStackDriftDetectionStatus.go index aeb7edc2b02..73fae936c92 100644 --- a/service/cloudformation/api_op_DescribeStackDriftDetectionStatus.go +++ b/service/cloudformation/api_op_DescribeStackDriftDetectionStatus.go @@ -81,11 +81,6 @@ type DescribeStackDriftDetectionStatusInput struct { type DescribeStackDriftDetectionStatusOutput struct { - // Time at which the stack drift detection operation was initiated. - // - // This member is required. - Timestamp *time.Time - // The status of the stack drift detection operation. // // * DETECTION_COMPLETE: @@ -107,11 +102,32 @@ type DescribeStackDriftDetectionStatusOutput struct { // This member is required. DetectionStatus types.StackDriftDetectionStatus + // The ID of the drift detection results of this operation. AWS CloudFormation + // generates new results, with a new drift detection ID, each time this operation + // is run. However, the number of reports AWS CloudFormation retains for any given + // stack, and for how long, may vary. + // + // This member is required. + StackDriftDetectionId *string + // The ID of the stack. // // This member is required. StackId *string + // Time at which the stack drift detection operation was initiated. + // + // This member is required. + Timestamp *time.Time + + // The reason the stack drift detection operation has its current status. + DetectionStatusReason *string + + // Total number of stack resources that have drifted. This is NULL until the drift + // detection operation reaches a status of DETECTION_COMPLETE. This value will be 0 + // for stacks whose drift status is IN_SYNC. + DriftedStackResourceCount *int32 + // Status of the stack's actual configuration compared to its expected // configuration. // @@ -129,22 +145,6 @@ type DescribeStackDriftDetectionStatusOutput struct { // * UNKNOWN: This value is reserved for future use. StackDriftStatus types.StackDriftStatus - // The ID of the drift detection results of this operation. AWS CloudFormation - // generates new results, with a new drift detection ID, each time this operation - // is run. However, the number of reports AWS CloudFormation retains for any given - // stack, and for how long, may vary. - // - // This member is required. - StackDriftDetectionId *string - - // Total number of stack resources that have drifted. This is NULL until the drift - // detection operation reaches a status of DETECTION_COMPLETE. This value will be 0 - // for stacks whose drift status is IN_SYNC. - DriftedStackResourceCount *int32 - - // The reason the stack drift detection operation has its current status. - DetectionStatusReason *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudformation/api_op_DescribeStackInstance.go b/service/cloudformation/api_op_DescribeStackInstance.go index b31e719b33d..89237ad17c8 100644 --- a/service/cloudformation/api_op_DescribeStackInstance.go +++ b/service/cloudformation/api_op_DescribeStackInstance.go @@ -59,12 +59,6 @@ func (c *Client) DescribeStackInstance(ctx context.Context, params *DescribeStac type DescribeStackInstanceInput struct { - // The name or the unique stack ID of the stack set that you want to get stack - // instance information for. - // - // This member is required. - StackSetName *string - // The ID of an AWS account that's associated with this stack instance. // // This member is required. @@ -74,6 +68,12 @@ type DescribeStackInstanceInput struct { // // This member is required. StackInstanceRegion *string + + // The name or the unique stack ID of the stack set that you want to get stack + // instance information for. + // + // This member is required. + StackSetName *string } type DescribeStackInstanceOutput struct { diff --git a/service/cloudformation/api_op_DescribeStackResourceDrifts.go b/service/cloudformation/api_op_DescribeStackResourceDrifts.go index 0c72245c264..0ae0cb46cdc 100644 --- a/service/cloudformation/api_op_DescribeStackResourceDrifts.go +++ b/service/cloudformation/api_op_DescribeStackResourceDrifts.go @@ -68,6 +68,20 @@ func (c *Client) DescribeStackResourceDrifts(ctx context.Context, params *Descri type DescribeStackResourceDriftsInput struct { + // The name of the stack for which you want drift information. + // + // This member is required. + StackName *string + + // The maximum number of results to be returned with a single call. If the number + // of available results exceeds this maximum, the response includes a NextToken + // value that you can assign to the NextToken request parameter to get the next set + // of results. + MaxResults *int32 + + // A string that identifies the next page of stack resource drift results. + NextToken *string + // The resource drift status values to use as filters for the resource drift // results returned. // @@ -84,20 +98,6 @@ type DescribeStackResourceDriftsInput struct { // * NOT_CHECKED: AWS CloudFormation does not currently return // this value. StackResourceDriftStatusFilters []types.StackResourceDriftStatus - - // A string that identifies the next page of stack resource drift results. - NextToken *string - - // The maximum number of results to be returned with a single call. If the number - // of available results exceeds this maximum, the response includes a NextToken - // value that you can assign to the NextToken request parameter to get the next set - // of results. - MaxResults *int32 - - // The name of the stack for which you want drift information. - // - // This member is required. - StackName *string } type DescribeStackResourceDriftsOutput struct { diff --git a/service/cloudformation/api_op_DescribeStackResources.go b/service/cloudformation/api_op_DescribeStackResources.go index 23797c419b9..2bcf97fa293 100644 --- a/service/cloudformation/api_op_DescribeStackResources.go +++ b/service/cloudformation/api_op_DescribeStackResources.go @@ -70,6 +70,10 @@ func (c *Client) DescribeStackResources(ctx context.Context, params *DescribeSta // The input for DescribeStackResources () action. type DescribeStackResourcesInput struct { + // The logical name of the resource as specified in the template. Default: There is + // no default value. + LogicalResourceId *string + // The name or unique identifier that corresponds to a physical instance ID of a // resource supported by AWS CloudFormation. For example, for an Amazon Elastic // Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. @@ -79,10 +83,6 @@ type DescribeStackResourcesInput struct { // specify StackName. Default: There is no default value. PhysicalResourceId *string - // The logical name of the resource as specified in the template. Default: There is - // no default value. - LogicalResourceId *string - // The name or the unique stack ID that is associated with the stack, which are not // always interchangeable: // diff --git a/service/cloudformation/api_op_DescribeStacks.go b/service/cloudformation/api_op_DescribeStacks.go index 42cf014280a..c4deaf5ecfe 100644 --- a/service/cloudformation/api_op_DescribeStacks.go +++ b/service/cloudformation/api_op_DescribeStacks.go @@ -59,6 +59,9 @@ func (c *Client) DescribeStacks(ctx context.Context, params *DescribeStacksInput // The input for DescribeStacks () action. type DescribeStacksInput struct { + // A string that identifies the next page of stacks that you want to retrieve. + NextToken *string + // The name or the unique stack ID that is associated with the stack, which are not // always interchangeable: // @@ -70,9 +73,6 @@ type DescribeStacksInput struct { // // Default: There is no default value. StackName *string - - // A string that identifies the next page of stacks that you want to retrieve. - NextToken *string } // The output for a DescribeStacks () action. diff --git a/service/cloudformation/api_op_DescribeType.go b/service/cloudformation/api_op_DescribeType.go index 6a4856a84ce..1af8b33017b 100644 --- a/service/cloudformation/api_op_DescribeType.go +++ b/service/cloudformation/api_op_DescribeType.go @@ -59,28 +59,36 @@ func (c *Client) DescribeType(ctx context.Context, params *DescribeTypeInput, op type DescribeTypeInput struct { - // The name of the type. Conditional: You must specify either TypeName and Type, or - // Arn. - TypeName *string - // The Amazon Resource Name (ARN) of the type. Conditional: You must specify either // TypeName and Type, or Arn. Arn *string + // The kind of type. Currently the only valid value is RESOURCE. Conditional: You + // must specify either TypeName and Type, or Arn. + Type types.RegistryType + + // The name of the type. Conditional: You must specify either TypeName and Type, or + // Arn. + TypeName *string + // The ID of a specific version of the type. The version ID is the value at the end // of the Amazon Resource Name (ARN) assigned to the type version when it is // registered. If you specify a VersionId, DescribeType returns information about // that specific type version. Otherwise, it returns information about the default // type version. VersionId *string - - // The kind of type. Currently the only valid value is RESOURCE. Conditional: You - // must specify either TypeName and Type, or Arn. - Type types.RegistryType } type DescribeTypeOutput struct { + // The Amazon Resource Name (ARN) of the type. + Arn *string + + // The ID of the default version of the type. The default version is used when the + // type version is not specified. To set the default version of a type, use + // SetTypeDefaultVersion (). + DefaultVersionId *string + // The deprecation status of the type. Valid values include: // // * LIVE: The type @@ -91,35 +99,29 @@ type DescribeTypeOutput struct { // deregistered and can no longer be used in CloudFormation operations. DeprecatedStatus types.DeprecatedStatus - // The URL of the source code for the type. - SourceUrl *string - // The description of the registered type. Description *string - // The Amazon Resource Name (ARN) of the type. - Arn *string - // The URL of a page providing detailed documentation for this type. DocumentationUrl *string - // The name of the registered type. - TypeName *string + // The Amazon Resource Name (ARN) of the IAM execution role used to register the + // type. If your resource type calls AWS APIs in any of its handlers, you must + // create an IAM execution role + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) that includes + // the necessary permissions to call those AWS APIs, and provision that execution + // role in your account. CloudFormation then assumes that execution role to provide + // your resource type with the appropriate credentials. + ExecutionRoleArn *string - // The schema that defines the type. For more information on type schemas, see - // Resource Provider Schema - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html) - // in the CloudFormation CLI User Guide. - Schema *string + // Whether the specified type version is set as the default version. + IsDefaultVersion *bool // When the specified type version was registered. LastUpdated *time.Time - // The kind of type. Currently the only valid value is RESOURCE. - Type types.RegistryType - - // When the specified type version was registered. - TimeCreated *time.Time + // Contains logging configuration information for a type. + LoggingConfig *types.LoggingConfig // The provisioning behavior of the type. AWS CloudFormation determines the // provisioning type during registration, based on the types of handlers in the @@ -144,14 +146,23 @@ type DescribeTypeOutput struct { // * delete ProvisioningType types.ProvisioningType - // The Amazon Resource Name (ARN) of the IAM execution role used to register the - // type. If your resource type calls AWS APIs in any of its handlers, you must - // create an IAM execution role - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) that includes - // the necessary permissions to call those AWS APIs, and provision that execution - // role in your account. CloudFormation then assumes that execution role to provide - // your resource type with the appropriate credentials. - ExecutionRoleArn *string + // The schema that defines the type. For more information on type schemas, see + // Resource Provider Schema + // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html) + // in the CloudFormation CLI User Guide. + Schema *string + + // The URL of the source code for the type. + SourceUrl *string + + // When the specified type version was registered. + TimeCreated *time.Time + + // The kind of type. Currently the only valid value is RESOURCE. + Type types.RegistryType + + // The name of the registered type. + TypeName *string // The scope at which the type is visible and usable in CloudFormation operations. // Valid values include: @@ -164,17 +175,6 @@ type DescribeTypeOutput struct { // usable within any Amazon account. Visibility types.Visibility - // Contains logging configuration information for a type. - LoggingConfig *types.LoggingConfig - - // Whether the specified type version is set as the default version. - IsDefaultVersion *bool - - // The ID of the default version of the type. The default version is used when the - // type version is not specified. To set the default version of a type, use - // SetTypeDefaultVersion (). - DefaultVersionId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudformation/api_op_DescribeTypeRegistration.go b/service/cloudformation/api_op_DescribeTypeRegistration.go index 7d15ce63657..e907c5ce1b9 100644 --- a/service/cloudformation/api_op_DescribeTypeRegistration.go +++ b/service/cloudformation/api_op_DescribeTypeRegistration.go @@ -77,15 +77,15 @@ type DescribeTypeRegistrationOutput struct { // The current status of the type registration request. ProgressStatus types.RegistrationStatus + // The Amazon Resource Name (ARN) of the type being registered. For registration + // requests with a ProgressStatus of other than COMPLETE, this will be null. + TypeArn *string + // The Amazon Resource Name (ARN) of this specific version of the type being // registered. For registration requests with a ProgressStatus of other than // COMPLETE, this will be null. TypeVersionArn *string - // The Amazon Resource Name (ARN) of the type being registered. For registration - // requests with a ProgressStatus of other than COMPLETE, this will be null. - TypeArn *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudformation/api_op_DetectStackDrift.go b/service/cloudformation/api_op_DetectStackDrift.go index 4926fb46064..5d6e0830e1c 100644 --- a/service/cloudformation/api_op_DetectStackDrift.go +++ b/service/cloudformation/api_op_DetectStackDrift.go @@ -77,13 +77,13 @@ func (c *Client) DetectStackDrift(ctx context.Context, params *DetectStackDriftI type DetectStackDriftInput struct { - // The logical names of any resources you want to use as filters. - LogicalResourceIds []*string - // The name of the stack for which you want to detect drift. // // This member is required. StackName *string + + // The logical names of any resources you want to use as filters. + LogicalResourceIds []*string } type DetectStackDriftOutput struct { diff --git a/service/cloudformation/api_op_DetectStackResourceDrift.go b/service/cloudformation/api_op_DetectStackResourceDrift.go index e3050ac97c8..c8a3de13917 100644 --- a/service/cloudformation/api_op_DetectStackResourceDrift.go +++ b/service/cloudformation/api_op_DetectStackResourceDrift.go @@ -70,15 +70,15 @@ func (c *Client) DetectStackResourceDrift(ctx context.Context, params *DetectSta type DetectStackResourceDriftInput struct { - // The name of the stack to which the resource belongs. + // The logical name of the resource for which to return drift information. // // This member is required. - StackName *string + LogicalResourceId *string - // The logical name of the resource for which to return drift information. + // The name of the stack to which the resource belongs. // // This member is required. - LogicalResourceId *string + StackName *string } type DetectStackResourceDriftOutput struct { diff --git a/service/cloudformation/api_op_ExecuteChangeSet.go b/service/cloudformation/api_op_ExecuteChangeSet.go index 8b9490d50a7..5188dad5d26 100644 --- a/service/cloudformation/api_op_ExecuteChangeSet.go +++ b/service/cloudformation/api_op_ExecuteChangeSet.go @@ -64,6 +64,12 @@ func (c *Client) ExecuteChangeSet(ctx context.Context, params *ExecuteChangeSetI // The input for the ExecuteChangeSet () action. type ExecuteChangeSetInput struct { + // The name or ARN of the change set that you want use to update the specified + // stack. + // + // This member is required. + ChangeSetName *string + // A unique identifier for this ExecuteChangeSet request. Specify this token if you // plan to retry requests so that AWS CloudFormation knows that you're not // attempting to execute a change set to update a stack with the same name. You @@ -74,12 +80,6 @@ type ExecuteChangeSetInput struct { // If you specified the name of a change set, specify the stack name or ID (ARN) // that is associated with the change set you want to execute. StackName *string - - // The name or ARN of the change set that you want use to update the specified - // stack. - // - // This member is required. - ChangeSetName *string } // The output for the ExecuteChangeSet () action. diff --git a/service/cloudformation/api_op_GetTemplate.go b/service/cloudformation/api_op_GetTemplate.go index c1f3ef6a725..648f6e1a821 100644 --- a/service/cloudformation/api_op_GetTemplate.go +++ b/service/cloudformation/api_op_GetTemplate.go @@ -60,6 +60,11 @@ func (c *Client) GetTemplate(ctx context.Context, params *GetTemplateInput, optF // The input for a GetTemplate () action. type GetTemplateInput struct { + // The name or Amazon Resource Name (ARN) of a change set for which AWS + // CloudFormation returns the associated template. If you specify a name, you must + // also specify the StackName. + ChangeSetName *string + // The name or the unique stack ID that is associated with the stack, which are not // always interchangeable: // @@ -78,16 +83,17 @@ type GetTemplateInput struct { // Processed. If the template doesn't include transforms, Original and Processed // return the same template. By default, AWS CloudFormation specifies Original. TemplateStage types.TemplateStage - - // The name or Amazon Resource Name (ARN) of a change set for which AWS - // CloudFormation returns the associated template. If you specify a name, you must - // also specify the StackName. - ChangeSetName *string } // The output for GetTemplate () action. type GetTemplateOutput struct { + // The stage of the template that you can retrieve. For stacks, the Original and + // Processed templates are always available. For change sets, the Original template + // is always available. After AWS CloudFormation finishes creating the change set, + // the Processed template becomes available. + StagesAvailable []types.TemplateStage + // Structure containing the template body. (For more information, go to Template // Anatomy // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) @@ -95,12 +101,6 @@ type GetTemplateOutput struct { // template that was used when the stack was created. TemplateBody *string - // The stage of the template that you can retrieve. For stacks, the Original and - // Processed templates are always available. For change sets, the Original template - // is always available. After AWS CloudFormation finishes creating the change set, - // the Processed template becomes available. - StagesAvailable []types.TemplateStage - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudformation/api_op_GetTemplateSummary.go b/service/cloudformation/api_op_GetTemplateSummary.go index eb1cbd37cc8..7a0d2a862b7 100644 --- a/service/cloudformation/api_op_GetTemplateSummary.go +++ b/service/cloudformation/api_op_GetTemplateSummary.go @@ -64,6 +64,18 @@ func (c *Client) GetTemplateSummary(ctx context.Context, params *GetTemplateSumm // The input for the GetTemplateSummary () action. type GetTemplateSummaryInput struct { + // The name or the stack ID that is associated with the stack, which are not always + // interchangeable. For running stacks, you can specify either the stack's name or + // its unique stack ID. For deleted stack, you must specify the unique stack ID. + // Conditional: You must specify only one of the following parameters: StackName, + // StackSetName, TemplateBody, or TemplateURL. + StackName *string + + // The name or unique ID of the stack set from which the stack was created. + // Conditional: You must specify only one of the following parameters: StackName, + // StackSetName, TemplateBody, or TemplateURL. + StackSetName *string + // Structure containing the template body with a minimum length of 1 byte and a // maximum length of 51,200 bytes. For more information about templates, see // Template Anatomy @@ -79,46 +91,11 @@ type GetTemplateSummaryInput struct { // in the AWS CloudFormation User Guide. Conditional: You must specify only one of // the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL. TemplateURL *string - - // The name or unique ID of the stack set from which the stack was created. - // Conditional: You must specify only one of the following parameters: StackName, - // StackSetName, TemplateBody, or TemplateURL. - StackSetName *string - - // The name or the stack ID that is associated with the stack, which are not always - // interchangeable. For running stacks, you can specify either the stack's name or - // its unique stack ID. For deleted stack, you must specify the unique stack ID. - // Conditional: You must specify only one of the following parameters: StackName, - // StackSetName, TemplateBody, or TemplateURL. - StackName *string } // The output for the GetTemplateSummary () action. type GetTemplateSummaryOutput struct { - // A list of resource identifier summaries that describe the target resources of an - // import operation and the properties you can provide during the import to - // identify the target resources. For example, BucketName is a possible identifier - // property for an AWS::S3::Bucket resource. - ResourceIdentifierSummaries []*types.ResourceIdentifierSummary - - // The AWS template format version, which identifies the capabilities of the - // template. - Version *string - - // The value that is defined for the Metadata property of the template. - Metadata *string - - // The value that is defined in the Description property of the template. - Description *string - - // A list of the transforms that are declared in the template. - DeclaredTransforms []*string - - // A list of all the template resource types that are defined in the template, such - // as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance. - ResourceTypes []*string - // The capabilities found within the template. If your template contains IAM // resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for // this parameter when you use the CreateStack () or UpdateStack () actions with @@ -132,10 +109,33 @@ type GetTemplateSummaryOutput struct { // element. CapabilitiesReason *string + // A list of the transforms that are declared in the template. + DeclaredTransforms []*string + + // The value that is defined in the Description property of the template. + Description *string + + // The value that is defined for the Metadata property of the template. + Metadata *string + // A list of parameter declarations that describe various properties for each // parameter. Parameters []*types.ParameterDeclaration + // A list of resource identifier summaries that describe the target resources of an + // import operation and the properties you can provide during the import to + // identify the target resources. For example, BucketName is a possible identifier + // property for an AWS::S3::Bucket resource. + ResourceIdentifierSummaries []*types.ResourceIdentifierSummary + + // A list of all the template resource types that are defined in the template, such + // as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance. + ResourceTypes []*string + + // The AWS template format version, which identifies the capabilities of the + // template. + Version *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudformation/api_op_ListChangeSets.go b/service/cloudformation/api_op_ListChangeSets.go index 474e814bfa5..93aea30eb5d 100644 --- a/service/cloudformation/api_op_ListChangeSets.go +++ b/service/cloudformation/api_op_ListChangeSets.go @@ -60,15 +60,15 @@ func (c *Client) ListChangeSets(ctx context.Context, params *ListChangeSetsInput // The input for the ListChangeSets () action. type ListChangeSetsInput struct { - // A string (provided by the ListChangeSets () response output) that identifies the - // next page of change sets that you want to retrieve. - NextToken *string - // The name or the Amazon Resource Name (ARN) of the stack for which you want to // list change sets. // // This member is required. StackName *string + + // A string (provided by the ListChangeSets () response output) that identifies the + // next page of change sets that you want to retrieve. + NextToken *string } // The output for the ListChangeSets () action. diff --git a/service/cloudformation/api_op_ListImports.go b/service/cloudformation/api_op_ListImports.go index 616e2c1bb33..820fc1a70e5 100644 --- a/service/cloudformation/api_op_ListImports.go +++ b/service/cloudformation/api_op_ListImports.go @@ -75,13 +75,13 @@ type ListImportsInput struct { type ListImportsOutput struct { + // A list of stack names that are importing the specified exported output value. + Imports []*string + // A string that identifies the next page of exports. If there is no additional // page, this value is null. NextToken *string - // A list of stack names that are importing the specified exported output value. - Imports []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudformation/api_op_ListStackInstances.go b/service/cloudformation/api_op_ListStackInstances.go index f69443d91f4..09353e60396 100644 --- a/service/cloudformation/api_op_ListStackInstances.go +++ b/service/cloudformation/api_op_ListStackInstances.go @@ -59,8 +59,14 @@ func (c *Client) ListStackInstances(ctx context.Context, params *ListStackInstan type ListStackInstancesInput struct { - // The name of the AWS account that you want to list stack instances for. - StackInstanceAccount *string + // The name or unique ID of the stack set that you want to list stack instances + // for. + // + // This member is required. + StackSetName *string + + // The status that stack instances are filtered by. + Filters []*types.StackInstanceFilter // The maximum number of results to be returned with a single call. If the number // of available results exceeds this maximum, the response includes a NextToken @@ -68,9 +74,6 @@ type ListStackInstancesInput struct { // of results. MaxResults *int32 - // The status that stack instances are filtered by. - Filters []*types.StackInstanceFilter - // If the previous request didn't return all of the remaining results, the // response's NextToken parameter value is set to a token. To retrieve the next set // of results, call ListStackInstances again and assign that token to the request @@ -78,14 +81,11 @@ type ListStackInstancesInput struct { // response object's NextToken parameter is set to null. NextToken *string + // The name of the AWS account that you want to list stack instances for. + StackInstanceAccount *string + // The name of the Region where you want to list stack instances. StackInstanceRegion *string - - // The name or unique ID of the stack set that you want to list stack instances - // for. - // - // This member is required. - StackSetName *string } type ListStackInstancesOutput struct { diff --git a/service/cloudformation/api_op_ListStackResources.go b/service/cloudformation/api_op_ListStackResources.go index fe9b9238416..07b0f08e097 100644 --- a/service/cloudformation/api_op_ListStackResources.go +++ b/service/cloudformation/api_op_ListStackResources.go @@ -60,10 +60,6 @@ func (c *Client) ListStackResources(ctx context.Context, params *ListStackResour // The input for the ListStackResource () action. type ListStackResourcesInput struct { - // A string that identifies the next page of stack resources that you want to - // retrieve. - NextToken *string - // The name or the unique stack ID that is associated with the stack, which are not // always interchangeable: // @@ -77,6 +73,10 @@ type ListStackResourcesInput struct { // // This member is required. StackName *string + + // A string that identifies the next page of stack resources that you want to + // retrieve. + NextToken *string } // The output for a ListStackResources () action. diff --git a/service/cloudformation/api_op_ListStackSetOperationResults.go b/service/cloudformation/api_op_ListStackSetOperationResults.go index 9efb6cf3a8b..08d48ac1ae3 100644 --- a/service/cloudformation/api_op_ListStackSetOperationResults.go +++ b/service/cloudformation/api_op_ListStackSetOperationResults.go @@ -57,11 +57,10 @@ func (c *Client) ListStackSetOperationResults(ctx context.Context, params *ListS type ListStackSetOperationResultsInput struct { - // The maximum number of results to be returned with a single call. If the number - // of available results exceeds this maximum, the response includes a NextToken - // value that you can assign to the NextToken request parameter to get the next set - // of results. - MaxResults *int32 + // The ID of the stack set operation. + // + // This member is required. + OperationId *string // The name or unique ID of the stack set that you want to get operation results // for. @@ -69,32 +68,33 @@ type ListStackSetOperationResultsInput struct { // This member is required. StackSetName *string + // The maximum number of results to be returned with a single call. If the number + // of available results exceeds this maximum, the response includes a NextToken + // value that you can assign to the NextToken request parameter to get the next set + // of results. + MaxResults *int32 + // If the previous request didn't return all of the remaining results, the response // object's NextToken parameter value is set to a token. To retrieve the next set // of results, call ListStackSetOperationResults again and assign that token to the // request object's NextToken parameter. If there are no remaining results, the // previous response object's NextToken parameter is set to null. NextToken *string - - // The ID of the stack set operation. - // - // This member is required. - OperationId *string } type ListStackSetOperationResultsOutput struct { - // A list of StackSetOperationResultSummary structures that contain information - // about the specified operation results, for accounts and Regions that are - // included in the operation. - Summaries []*types.StackSetOperationResultSummary - // If the request doesn't return all results, NextToken is set to a token. To // retrieve the next set of results, call ListOperationResults again and assign // that token to the request object's NextToken parameter. If there are no // remaining results, NextToken is set to null. NextToken *string + // A list of StackSetOperationResultSummary structures that contain information + // about the specified operation results, for accounts and Regions that are + // included in the operation. + Summaries []*types.StackSetOperationResultSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudformation/api_op_ListStackSetOperations.go b/service/cloudformation/api_op_ListStackSetOperations.go index 2e9987b2495..b12f8872e52 100644 --- a/service/cloudformation/api_op_ListStackSetOperations.go +++ b/service/cloudformation/api_op_ListStackSetOperations.go @@ -57,13 +57,6 @@ func (c *Client) ListStackSetOperations(ctx context.Context, params *ListStackSe type ListStackSetOperationsInput struct { - // If the previous paginated request didn't return all of the remaining results, - // the response object's NextToken parameter value is set to a token. To retrieve - // the next set of results, call ListStackSetOperations again and assign that token - // to the request object's NextToken parameter. If there are no remaining results, - // the previous response object's NextToken parameter is set to null. - NextToken *string - // The name or unique ID of the stack set that you want to get operation summaries // for. // @@ -75,6 +68,13 @@ type ListStackSetOperationsInput struct { // value that you can assign to the NextToken request parameter to get the next set // of results. MaxResults *int32 + + // If the previous paginated request didn't return all of the remaining results, + // the response object's NextToken parameter value is set to a token. To retrieve + // the next set of results, call ListStackSetOperations again and assign that token + // to the request object's NextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null. + NextToken *string } type ListStackSetOperationsOutput struct { diff --git a/service/cloudformation/api_op_ListStackSets.go b/service/cloudformation/api_op_ListStackSets.go index 129ab0993fd..8c5c7f7616c 100644 --- a/service/cloudformation/api_op_ListStackSets.go +++ b/service/cloudformation/api_op_ListStackSets.go @@ -56,6 +56,12 @@ func (c *Client) ListStackSets(ctx context.Context, params *ListStackSetsInput, type ListStackSetsInput struct { + // The maximum number of results to be returned with a single call. If the number + // of available results exceeds this maximum, the response includes a NextToken + // value that you can assign to the NextToken request parameter to get the next set + // of results. + MaxResults *int32 + // If the previous paginated request didn't return all of the remaining results, // the response object's NextToken parameter value is set to a token. To retrieve // the next set of results, call ListStackSets again and assign that token to the @@ -63,12 +69,6 @@ type ListStackSetsInput struct { // previous response object's NextToken parameter is set to null. NextToken *string - // The maximum number of results to be returned with a single call. If the number - // of available results exceeds this maximum, the response includes a NextToken - // value that you can assign to the NextToken request parameter to get the next set - // of results. - MaxResults *int32 - // The status of the stack sets that you want to get summary information about. Status types.StackSetStatus } diff --git a/service/cloudformation/api_op_ListStacks.go b/service/cloudformation/api_op_ListStacks.go index a4de64f776b..c1fc7b5cf7e 100644 --- a/service/cloudformation/api_op_ListStacks.go +++ b/service/cloudformation/api_op_ListStacks.go @@ -73,14 +73,14 @@ type ListStacksInput struct { // The output for ListStacks () action. type ListStacksOutput struct { - // A list of StackSummary structures containing information about the specified - // stacks. - StackSummaries []*types.StackSummary - // If the output exceeds 1 MB in size, a string that identifies the next page of // stacks. If no additional page exists, this value is null. NextToken *string + // A list of StackSummary structures containing information about the specified + // stacks. + StackSummaries []*types.StackSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudformation/api_op_ListTypeRegistrations.go b/service/cloudformation/api_op_ListTypeRegistrations.go index 819f51d6153..2af1c28a49a 100644 --- a/service/cloudformation/api_op_ListTypeRegistrations.go +++ b/service/cloudformation/api_op_ListTypeRegistrations.go @@ -56,6 +56,12 @@ func (c *Client) ListTypeRegistrations(ctx context.Context, params *ListTypeRegi type ListTypeRegistrationsInput struct { + // The maximum number of results to be returned with a single call. If the number + // of available results exceeds this maximum, the response includes a NextToken + // value that you can assign to the NextToken request parameter to get the next set + // of results. + MaxResults *int32 + // If the previous paginated request didn't return all of the remaining results, // the response object's NextToken parameter value is set to a token. To retrieve // the next set of results, call this action again and assign that token to the @@ -63,40 +69,34 @@ type ListTypeRegistrationsInput struct { // previous response object's NextToken parameter is set to null. NextToken *string - // The Amazon Resource Name (ARN) of the type. Conditional: You must specify either - // TypeName and Type, or Arn. - TypeArn *string + // The current status of the type registration request. The default is IN_PROGRESS. + RegistrationStatusFilter types.RegistrationStatus // The kind of type. Currently the only valid value is RESOURCE. Conditional: You // must specify either TypeName and Type, or Arn. Type types.RegistryType - // The current status of the type registration request. The default is IN_PROGRESS. - RegistrationStatusFilter types.RegistrationStatus + // The Amazon Resource Name (ARN) of the type. Conditional: You must specify either + // TypeName and Type, or Arn. + TypeArn *string // The name of the type. Conditional: You must specify either TypeName and Type, or // Arn. TypeName *string - - // The maximum number of results to be returned with a single call. If the number - // of available results exceeds this maximum, the response includes a NextToken - // value that you can assign to the NextToken request parameter to get the next set - // of results. - MaxResults *int32 } type ListTypeRegistrationsOutput struct { - // A list of type registration tokens. Use DescribeTypeRegistration () to return - // detailed information about a type registration request. - RegistrationTokenList []*string - // If the request doesn't return all of the remaining results, NextToken is set to // a token. To retrieve the next set of results, call this action again and assign // that token to the request object's NextToken parameter. If the request returns // all results, NextToken is set to null. NextToken *string + // A list of type registration tokens. Use DescribeTypeRegistration () to return + // detailed information about a type registration request. + RegistrationTokenList []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudformation/api_op_ListTypeVersions.go b/service/cloudformation/api_op_ListTypeVersions.go index 2c5a3c12017..3b4e7ecd6dd 100644 --- a/service/cloudformation/api_op_ListTypeVersions.go +++ b/service/cloudformation/api_op_ListTypeVersions.go @@ -60,10 +60,6 @@ type ListTypeVersionsInput struct { // information. Conditional: You must specify either TypeName and Type, or Arn. Arn *string - // The name of the type for which you want version summary information. - // Conditional: You must specify either TypeName and Type, or Arn. - TypeName *string - // The deprecation status of the type versions that you want to get summary // information about. Valid values include: // @@ -78,9 +74,11 @@ type ListTypeVersionsInput struct { // The default is LIVE. DeprecatedStatus types.DeprecatedStatus - // The kind of the type. Currently the only valid value is RESOURCE. Conditional: - // You must specify either TypeName and Type, or Arn. - Type types.RegistryType + // The maximum number of results to be returned with a single call. If the number + // of available results exceeds this maximum, the response includes a NextToken + // value that you can assign to the NextToken request parameter to get the next set + // of results. + MaxResults *int32 // If the previous paginated request didn't return all of the remaining results, // the response object's NextToken parameter value is set to a token. To retrieve @@ -89,11 +87,13 @@ type ListTypeVersionsInput struct { // previous response object's NextToken parameter is set to null. NextToken *string - // The maximum number of results to be returned with a single call. If the number - // of available results exceeds this maximum, the response includes a NextToken - // value that you can assign to the NextToken request parameter to get the next set - // of results. - MaxResults *int32 + // The kind of the type. Currently the only valid value is RESOURCE. Conditional: + // You must specify either TypeName and Type, or Arn. + Type types.RegistryType + + // The name of the type for which you want version summary information. + // Conditional: You must specify either TypeName and Type, or Arn. + TypeName *string } type ListTypeVersionsOutput struct { diff --git a/service/cloudformation/api_op_ListTypes.go b/service/cloudformation/api_op_ListTypes.go index 72dc8c02437..6b1637d4f37 100644 --- a/service/cloudformation/api_op_ListTypes.go +++ b/service/cloudformation/api_op_ListTypes.go @@ -57,6 +57,22 @@ func (c *Client) ListTypes(ctx context.Context, params *ListTypesInput, optFns . type ListTypesInput struct { + // The deprecation status of the types that you want to get summary information + // about. Valid values include: + // + // * LIVE: The type is registered for use in + // CloudFormation operations. + // + // * DEPRECATED: The type has been deregistered and + // can no longer be used in CloudFormation operations. + DeprecatedStatus types.DeprecatedStatus + + // The maximum number of results to be returned with a single call. If the number + // of available results exceeds this maximum, the response includes a NextToken + // value that you can assign to the NextToken request parameter to get the next set + // of results. + MaxResults *int32 + // If the previous paginated request didn't return all of the remaining results, // the response object's NextToken parameter value is set to a token. To retrieve // the next set of results, call this action again and assign that token to the @@ -80,22 +96,6 @@ type ListTypesInput struct { // read, and delete handlers, and therefore cannot actually be provisioned. ProvisioningType types.ProvisioningType - // The maximum number of results to be returned with a single call. If the number - // of available results exceeds this maximum, the response includes a NextToken - // value that you can assign to the NextToken request parameter to get the next set - // of results. - MaxResults *int32 - - // The deprecation status of the types that you want to get summary information - // about. Valid values include: - // - // * LIVE: The type is registered for use in - // CloudFormation operations. - // - // * DEPRECATED: The type has been deregistered and - // can no longer be used in CloudFormation operations. - DeprecatedStatus types.DeprecatedStatus - // The scope at which the type is visible and usable in CloudFormation operations. // Valid values include: // @@ -112,16 +112,16 @@ type ListTypesInput struct { type ListTypesOutput struct { - // A list of TypeSummary structures that contain information about the specified - // types. - TypeSummaries []*types.TypeSummary - // If the request doesn't return all of the remaining results, NextToken is set to // a token. To retrieve the next set of results, call this action again and assign // that token to the request object's NextToken parameter. If the request returns // all results, NextToken is set to null. NextToken *string + // A list of TypeSummary structures that contain information about the specified + // types. + TypeSummaries []*types.TypeSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudformation/api_op_RecordHandlerProgress.go b/service/cloudformation/api_op_RecordHandlerProgress.go index c3c70eccc28..b2a84152cf1 100644 --- a/service/cloudformation/api_op_RecordHandlerProgress.go +++ b/service/cloudformation/api_op_RecordHandlerProgress.go @@ -68,21 +68,21 @@ type RecordHandlerProgressInput struct { // Reserved for use by the CloudFormation CLI // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). - CurrentOperationStatus types.OperationStatus + // + // This member is required. + OperationStatus types.OperationStatus // Reserved for use by the CloudFormation CLI // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). - ErrorCode types.HandlerErrorCode + ClientRequestToken *string // Reserved for use by the CloudFormation CLI // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). - ClientRequestToken *string + CurrentOperationStatus types.OperationStatus // Reserved for use by the CloudFormation CLI // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). - // - // This member is required. - OperationStatus types.OperationStatus + ErrorCode types.HandlerErrorCode // Reserved for use by the CloudFormation CLI // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). diff --git a/service/cloudformation/api_op_RegisterType.go b/service/cloudformation/api_op_RegisterType.go index 17128fb9f18..99a2a6b90e2 100644 --- a/service/cloudformation/api_op_RegisterType.go +++ b/service/cloudformation/api_op_RegisterType.go @@ -77,22 +77,20 @@ func (c *Client) RegisterType(ctx context.Context, params *RegisterTypeInput, op type RegisterTypeInput struct { - // The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when - // invoking the resource provider. If your resource type calls AWS APIs in any of - // its handlers, you must create an IAM execution role - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) that includes - // the necessary permissions to call those AWS APIs, and provision that execution - // role in your account. When CloudFormation needs to invoke the resource provider - // handler, CloudFormation assumes this execution role to create a temporary - // session token, which it then passes to the resource provider handler, thereby - // supplying your resource provider with the appropriate credentials. - ExecutionRoleArn *string - - // A unique identifier that acts as an idempotency key for this registration - // request. Specifying a client request token prevents CloudFormation from - // generating more than one version of a type from the same registeration request, - // even if the request is submitted multiple times. - ClientRequestToken *string + // A url to the S3 bucket containing the schema handler package that contains the + // schema, event handlers, and associated files for the type you want to register. + // For information on generating a schema handler package for the type you want to + // register, see submit + // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html) + // in the CloudFormation CLI User Guide. As part of registering a resource provider + // type, CloudFormation must be able to access the S3 bucket which contains the + // schema handler package for that resource provider. For more information, see IAM + // Permissions for Registering a Resource Provider + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html#registry-register-permissions) + // in the AWS CloudFormation User Guide. + // + // This member is required. + SchemaHandlerPackage *string // The name of the type being registered. We recommend that type names adhere to // the following pattern: company_or_organization::service::type. The following @@ -115,26 +113,28 @@ type RegisterTypeInput struct { // This member is required. TypeName *string + // A unique identifier that acts as an idempotency key for this registration + // request. Specifying a client request token prevents CloudFormation from + // generating more than one version of a type from the same registeration request, + // even if the request is submitted multiple times. + ClientRequestToken *string + + // The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when + // invoking the resource provider. If your resource type calls AWS APIs in any of + // its handlers, you must create an IAM execution role + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) that includes + // the necessary permissions to call those AWS APIs, and provision that execution + // role in your account. When CloudFormation needs to invoke the resource provider + // handler, CloudFormation assumes this execution role to create a temporary + // session token, which it then passes to the resource provider handler, thereby + // supplying your resource provider with the appropriate credentials. + ExecutionRoleArn *string + // Specifies logging configuration information for a type. LoggingConfig *types.LoggingConfig // The kind of type. Currently, the only valid value is RESOURCE. Type types.RegistryType - - // A url to the S3 bucket containing the schema handler package that contains the - // schema, event handlers, and associated files for the type you want to register. - // For information on generating a schema handler package for the type you want to - // register, see submit - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html) - // in the CloudFormation CLI User Guide. As part of registering a resource provider - // type, CloudFormation must be able to access the S3 bucket which contains the - // schema handler package for that resource provider. For more information, see IAM - // Permissions for Registering a Resource Provider - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html#registry-register-permissions) - // in the AWS CloudFormation User Guide. - // - // This member is required. - SchemaHandlerPackage *string } type RegisterTypeOutput struct { diff --git a/service/cloudformation/api_op_SetStackPolicy.go b/service/cloudformation/api_op_SetStackPolicy.go index d4afe145ebf..72ff7d7f7dd 100644 --- a/service/cloudformation/api_op_SetStackPolicy.go +++ b/service/cloudformation/api_op_SetStackPolicy.go @@ -57,6 +57,11 @@ func (c *Client) SetStackPolicy(ctx context.Context, params *SetStackPolicyInput // The input for the SetStackPolicy () action. type SetStackPolicyInput struct { + // The name or unique stack ID that you want to associate a policy with. + // + // This member is required. + StackName *string + // Structure containing the stack policy body. For more information, go to Prevent // Updates to Stack Resources // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) @@ -69,11 +74,6 @@ type SetStackPolicyInput struct { // You can specify either the StackPolicyBody or the StackPolicyURL parameter, but // not both. StackPolicyURL *string - - // The name or unique stack ID that you want to associate a policy with. - // - // This member is required. - StackName *string } type SetStackPolicyOutput struct { diff --git a/service/cloudformation/api_op_SetTypeDefaultVersion.go b/service/cloudformation/api_op_SetTypeDefaultVersion.go index 65867519491..73b1a45a535 100644 --- a/service/cloudformation/api_op_SetTypeDefaultVersion.go +++ b/service/cloudformation/api_op_SetTypeDefaultVersion.go @@ -61,6 +61,10 @@ type SetTypeDefaultVersionInput struct { // information. Conditional: You must specify either TypeName and Type, or Arn. Arn *string + // The kind of type. Conditional: You must specify either TypeName and Type, or + // Arn. + Type types.RegistryType + // The name of the type. Conditional: You must specify either TypeName and Type, or // Arn. TypeName *string @@ -69,10 +73,6 @@ type SetTypeDefaultVersionInput struct { // of the Amazon Resource Name (ARN) assigned to the type version when it is // registered. VersionId *string - - // The kind of type. Conditional: You must specify either TypeName and Type, or - // Arn. - Type types.RegistryType } type SetTypeDefaultVersionOutput struct { diff --git a/service/cloudformation/api_op_SignalResource.go b/service/cloudformation/api_op_SignalResource.go index d89d9fb487c..369916fb622 100644 --- a/service/cloudformation/api_op_SignalResource.go +++ b/service/cloudformation/api_op_SignalResource.go @@ -63,18 +63,18 @@ func (c *Client) SignalResource(ctx context.Context, params *SignalResourceInput // The input for the SignalResource () action. type SignalResourceInput struct { - // The stack name or unique stack ID that includes the resource that you want to - // signal. - // - // This member is required. - StackName *string - // The logical ID of the resource that you want to signal. The logical ID is the // name of the resource that given in the template. // // This member is required. LogicalResourceId *string + // The stack name or unique stack ID that includes the resource that you want to + // signal. + // + // This member is required. + StackName *string + // The status of the signal, which is either success or failure. A failure signal // causes AWS CloudFormation to immediately fail the stack creation or update. // diff --git a/service/cloudformation/api_op_UpdateStack.go b/service/cloudformation/api_op_UpdateStack.go index fdedc2a9f67..2c2ac1fb14e 100644 --- a/service/cloudformation/api_op_UpdateStack.go +++ b/service/cloudformation/api_op_UpdateStack.go @@ -69,97 +69,6 @@ type UpdateStackInput struct { // This member is required. StackName *string - // Location of a file containing the temporary overriding stack policy. The URL - // must point to a policy (max size: 16KB) located in an S3 bucket in the same - // Region as the stack. You can specify either the StackPolicyDuringUpdateBody or - // the StackPolicyDuringUpdateURL parameter, but not both. If you want to update - // protected resources, specify a temporary overriding stack policy during this - // update. If you do not specify a stack policy, the current policy that is - // associated with the stack will be used. - StackPolicyDuringUpdateURL *string - - // Structure containing a new stack policy body. You can specify either the - // StackPolicyBody or the StackPolicyURL parameter, but not both. You might update - // the stack policy, for example, in order to protect a new resource that you - // created during a stack update. If you do not specify a stack policy, the current - // policy that is associated with the stack is unchanged. - StackPolicyBody *string - - // Structure containing the template body with a minimum length of 1 byte and a - // maximum length of 51,200 bytes. (For more information, go to Template Anatomy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) - // in the AWS CloudFormation User Guide.) Conditional: You must specify only one of - // the following parameters: TemplateBody, TemplateURL, or set the - // UsePreviousTemplate to true. - TemplateBody *string - - // The template resource types that you have permissions to work with for this - // update stack action, such as AWS::EC2::Instance, AWS::EC2::*, or - // Custom::MyCustomInstance. If the list of resource types doesn't include a - // resource that you're updating, the stack update fails. By default, AWS - // CloudFormation grants permissions to all resource types. AWS Identity and Access - // Management (IAM) uses this parameter for AWS CloudFormation-specific condition - // keys in IAM policies. For more information, see Controlling Access with AWS - // Identity and Access Management - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html). - ResourceTypes []*string - - // The rollback triggers for AWS CloudFormation to monitor during stack creation - // and updating operations, and for the specified monitoring period afterwards. - RollbackConfiguration *types.RollbackConfiguration - - // Reuse the existing template that is associated with the stack that you are - // updating. Conditional: You must specify only one of the following parameters: - // TemplateBody, TemplateURL, or set the UsePreviousTemplate to true. - UsePreviousTemplate *bool - - // The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) - // role that AWS CloudFormation assumes to update the stack. AWS CloudFormation - // uses the role's credentials to make calls on your behalf. AWS CloudFormation - // always uses this role for all future operations on the stack. As long as users - // have permission to operate on the stack, AWS CloudFormation uses this role even - // if the users don't have permission to pass it. Ensure that the role grants least - // privilege. If you don't specify a value, AWS CloudFormation uses the role that - // was previously associated with the stack. If no role is available, AWS - // CloudFormation uses a temporary session that is generated from your user - // credentials. - RoleARN *string - - // Structure containing the temporary overriding stack policy body. You can specify - // either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL - // parameter, but not both. If you want to update protected resources, specify a - // temporary overriding stack policy during this update. If you do not specify a - // stack policy, the current policy that is associated with the stack will be used. - StackPolicyDuringUpdateBody *string - - // A list of Parameter structures that specify input parameters for the stack. For - // more information, see the Parameter - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html) - // data type. - Parameters []*types.Parameter - - // Location of a file containing the updated stack policy. The URL must point to a - // policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. - // You can specify either the StackPolicyBody or the StackPolicyURL parameter, but - // not both. You might update the stack policy, for example, in order to protect a - // new resource that you created during a stack update. If you do not specify a - // stack policy, the current policy that is associated with the stack is unchanged. - StackPolicyURL *string - - // Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS - // CloudFormation associates with the stack. Specify an empty list to remove all - // notification topics. - NotificationARNs []*string - - // Location of file containing the template body. The URL must point to a template - // that is located in an Amazon S3 bucket. For more information, go to Template - // Anatomy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) - // in the AWS CloudFormation User Guide. Conditional: You must specify only one of - // the following parameters: TemplateBody, TemplateURL, or set the - // UsePreviousTemplate to true. - TemplateURL *string - // In some cases, you must explicitly acknowledge that your stack template contains // certain capabilities in order for AWS CloudFormation to update the stack. // @@ -258,12 +167,103 @@ type UpdateStackInput struct { // format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. ClientRequestToken *string + // Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS + // CloudFormation associates with the stack. Specify an empty list to remove all + // notification topics. + NotificationARNs []*string + + // A list of Parameter structures that specify input parameters for the stack. For + // more information, see the Parameter + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html) + // data type. + Parameters []*types.Parameter + + // The template resource types that you have permissions to work with for this + // update stack action, such as AWS::EC2::Instance, AWS::EC2::*, or + // Custom::MyCustomInstance. If the list of resource types doesn't include a + // resource that you're updating, the stack update fails. By default, AWS + // CloudFormation grants permissions to all resource types. AWS Identity and Access + // Management (IAM) uses this parameter for AWS CloudFormation-specific condition + // keys in IAM policies. For more information, see Controlling Access with AWS + // Identity and Access Management + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html). + ResourceTypes []*string + + // The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) + // role that AWS CloudFormation assumes to update the stack. AWS CloudFormation + // uses the role's credentials to make calls on your behalf. AWS CloudFormation + // always uses this role for all future operations on the stack. As long as users + // have permission to operate on the stack, AWS CloudFormation uses this role even + // if the users don't have permission to pass it. Ensure that the role grants least + // privilege. If you don't specify a value, AWS CloudFormation uses the role that + // was previously associated with the stack. If no role is available, AWS + // CloudFormation uses a temporary session that is generated from your user + // credentials. + RoleARN *string + + // The rollback triggers for AWS CloudFormation to monitor during stack creation + // and updating operations, and for the specified monitoring period afterwards. + RollbackConfiguration *types.RollbackConfiguration + + // Structure containing a new stack policy body. You can specify either the + // StackPolicyBody or the StackPolicyURL parameter, but not both. You might update + // the stack policy, for example, in order to protect a new resource that you + // created during a stack update. If you do not specify a stack policy, the current + // policy that is associated with the stack is unchanged. + StackPolicyBody *string + + // Structure containing the temporary overriding stack policy body. You can specify + // either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL + // parameter, but not both. If you want to update protected resources, specify a + // temporary overriding stack policy during this update. If you do not specify a + // stack policy, the current policy that is associated with the stack will be used. + StackPolicyDuringUpdateBody *string + + // Location of a file containing the temporary overriding stack policy. The URL + // must point to a policy (max size: 16KB) located in an S3 bucket in the same + // Region as the stack. You can specify either the StackPolicyDuringUpdateBody or + // the StackPolicyDuringUpdateURL parameter, but not both. If you want to update + // protected resources, specify a temporary overriding stack policy during this + // update. If you do not specify a stack policy, the current policy that is + // associated with the stack will be used. + StackPolicyDuringUpdateURL *string + + // Location of a file containing the updated stack policy. The URL must point to a + // policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. + // You can specify either the StackPolicyBody or the StackPolicyURL parameter, but + // not both. You might update the stack policy, for example, in order to protect a + // new resource that you created during a stack update. If you do not specify a + // stack policy, the current policy that is associated with the stack is unchanged. + StackPolicyURL *string + // Key-value pairs to associate with this stack. AWS CloudFormation also propagates // these tags to supported resources in the stack. You can specify a maximum number // of 50 tags. If you don't specify this parameter, AWS CloudFormation doesn't // modify the stack's tags. If you specify an empty value, AWS CloudFormation // removes all associated tags. Tags []*types.Tag + + // Structure containing the template body with a minimum length of 1 byte and a + // maximum length of 51,200 bytes. (For more information, go to Template Anatomy + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) + // in the AWS CloudFormation User Guide.) Conditional: You must specify only one of + // the following parameters: TemplateBody, TemplateURL, or set the + // UsePreviousTemplate to true. + TemplateBody *string + + // Location of file containing the template body. The URL must point to a template + // that is located in an Amazon S3 bucket. For more information, go to Template + // Anatomy + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) + // in the AWS CloudFormation User Guide. Conditional: You must specify only one of + // the following parameters: TemplateBody, TemplateURL, or set the + // UsePreviousTemplate to true. + TemplateURL *string + + // Reuse the existing template that is associated with the stack that you are + // updating. Conditional: You must specify only one of the following parameters: + // TemplateBody, TemplateURL, or set the UsePreviousTemplate to true. + UsePreviousTemplate *bool } // The output for an UpdateStack () action. diff --git a/service/cloudformation/api_op_UpdateStackInstances.go b/service/cloudformation/api_op_UpdateStackInstances.go index 7c971132c6b..8bda4009742 100644 --- a/service/cloudformation/api_op_UpdateStackInstances.go +++ b/service/cloudformation/api_op_UpdateStackInstances.go @@ -76,6 +76,43 @@ func (c *Client) UpdateStackInstances(ctx context.Context, params *UpdateStackIn type UpdateStackInstancesInput struct { + // The names of one or more Regions in which you want to update parameter values + // for stack instances. The overridden parameter values will be applied to all + // stack instances in the specified accounts and Regions. + // + // This member is required. + Regions []*string + + // The name or unique ID of the stack set associated with the stack instances. + // + // This member is required. + StackSetName *string + + // [Self-managed permissions] The names of one or more AWS accounts for which you + // want to update parameter values for stack instances. The overridden parameter + // values will be applied to all stack instances in the specified accounts and + // Regions. You can specify Accounts or DeploymentTargets, but not both. + Accounts []*string + + // [Service-managed permissions] The AWS Organizations accounts for which you want + // to update parameter values for stack instances. If your update targets OUs, the + // overridden parameter values only apply to the accounts that are currently in the + // target OUs and their child OUs. Accounts added to the target OUs and their child + // OUs in the future won't use the overridden values. You can specify Accounts or + // DeploymentTargets, but not both. + DeploymentTargets *types.DeploymentTargets + + // The unique identifier for this stack set operation. The operation ID also + // functions as an idempotency token, to ensure that AWS CloudFormation performs + // the stack set operation only once, even if you retry the request multiple times. + // You might retry stack set operation requests to ensure that AWS CloudFormation + // successfully received them. If you don't specify an operation ID, the SDK + // generates one automatically. + OperationId *string + + // Preferences for how AWS CloudFormation performs this stack set operation. + OperationPreferences *types.StackSetOperationPreferences + // A list of input parameters whose values you want to update for the specified // stack instances. Any overridden parameter values will be applied to all stack // instances in the specified accounts and Regions. When specifying parameters and @@ -114,43 +151,6 @@ type UpdateStackInstancesInput struct { // specified in the stack set. Once a stack instance has been updated with the new // parameter, you can then override the parameter value using UpdateStackInstances. ParameterOverrides []*types.Parameter - - // Preferences for how AWS CloudFormation performs this stack set operation. - OperationPreferences *types.StackSetOperationPreferences - - // [Service-managed permissions] The AWS Organizations accounts for which you want - // to update parameter values for stack instances. If your update targets OUs, the - // overridden parameter values only apply to the accounts that are currently in the - // target OUs and their child OUs. Accounts added to the target OUs and their child - // OUs in the future won't use the overridden values. You can specify Accounts or - // DeploymentTargets, but not both. - DeploymentTargets *types.DeploymentTargets - - // The names of one or more Regions in which you want to update parameter values - // for stack instances. The overridden parameter values will be applied to all - // stack instances in the specified accounts and Regions. - // - // This member is required. - Regions []*string - - // The name or unique ID of the stack set associated with the stack instances. - // - // This member is required. - StackSetName *string - - // [Self-managed permissions] The names of one or more AWS accounts for which you - // want to update parameter values for stack instances. The overridden parameter - // values will be applied to all stack instances in the specified accounts and - // Regions. You can specify Accounts or DeploymentTargets, but not both. - Accounts []*string - - // The unique identifier for this stack set operation. The operation ID also - // functions as an idempotency token, to ensure that AWS CloudFormation performs - // the stack set operation only once, even if you retry the request multiple times. - // You might retry stack set operation requests to ensure that AWS CloudFormation - // successfully received them. If you don't specify an operation ID, the SDK - // generates one automatically. - OperationId *string } type UpdateStackInstancesOutput struct { diff --git a/service/cloudformation/api_op_UpdateStackSet.go b/service/cloudformation/api_op_UpdateStackSet.go index 99aa607a052..4cc4f50f885 100644 --- a/service/cloudformation/api_op_UpdateStackSet.go +++ b/service/cloudformation/api_op_UpdateStackSet.go @@ -63,38 +63,10 @@ func (c *Client) UpdateStackSet(ctx context.Context, params *UpdateStackSetInput type UpdateStackSetInput struct { - // The structure that contains the template body, with a minimum length of 1 byte - // and a maximum length of 51,200 bytes. For more information, see Template Anatomy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) - // in the AWS CloudFormation User Guide. Conditional: You must specify only one of - // the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate - // to true. - TemplateBody *string - - // Describes how the IAM roles required for stack set operations are created. You - // cannot modify PermissionModel if there are stack instances associated with your - // stack set. - // - // * With self-managed permissions, you must create the - // administrator and execution roles required to deploy to target accounts. For - // more information, see Grant Self-Managed Stack Set Permissions - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html). - // + // The name or unique ID of the stack set that you want to update. // - // * With service-managed permissions, StackSets automatically creates the IAM - // roles required to deploy to accounts managed by AWS Organizations. For more - // information, see Grant Service-Managed Stack Set Permissions - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html). - PermissionModel types.PermissionModels - - // The unique ID for this stack set operation. The operation ID also functions as - // an idempotency token, to ensure that AWS CloudFormation performs the stack set - // operation only once, even if you retry the request multiple times. You might - // retry stack set operation requests to ensure that AWS CloudFormation - // successfully received them. If you don't specify an operation ID, AWS - // CloudFormation generates one automatically. Repeating this stack set operation - // with a new operation ID retries all stack instances whose status is OUTDATED. - OperationId *string + // This member is required. + StackSetName *string // [Self-managed permissions] The accounts in which to update associated stack // instances. If you specify accounts, you must also specify the Regions in which @@ -110,45 +82,24 @@ type UpdateStackSetInput struct { // instance status. Accounts []*string + // The Amazon Resource Number (ARN) of the IAM role to use to update this stack + // set. Specify an IAM role only if you are using customized administrator roles to + // control which users or groups can manage specific stack sets within the same + // administrator account. For more information, see Granting Permissions for Stack + // Set Operations + // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) + // in the AWS CloudFormation User Guide. If you specified a customized + // administrator role when you created the stack set, you must specify a customized + // administrator role, even if it is the same customized administrator role used + // with this stack set previously. + AdministrationRoleARN *string + // [Service-managed permissions] Describes whether StackSets automatically deploys // to AWS Organizations accounts that are added to a target organization or // organizational unit (OU). If you specify AutoDeployment, do not specify // DeploymentTargets or Regions. AutoDeployment *types.AutoDeployment - // A brief description of updates that you are making. - Description *string - - // The key-value pairs to associate with this stack set and the stacks created from - // it. AWS CloudFormation also propagates these tags to supported resources that - // are created in the stacks. You can specify a maximum number of 50 tags. If you - // specify tags for this parameter, those tags replace any list of tags that are - // currently associated with this stack set. This means: - // - // * If you don't - // specify this parameter, AWS CloudFormation doesn't modify the stack's tags. - // - // - // * If you specify any tags using this parameter, you must specify all the tags - // that you want associated with this stack set, even tags you've specifed before - // (for example, when creating the stack set or during a previous update of the - // stack set.). Any tags that you don't include in the updated list of tags are - // removed from the stack set, and therefore from the stacks and resources as - // well. - // - // * If you specify an empty value, AWS CloudFormation removes all - // currently associated tags. - // - // If you specify new tags as part of an UpdateStackSet - // action, AWS CloudFormation checks to see if you have the required IAM permission - // to tag resources. If you omit tags that are currently associated with the stack - // set from the list of tags you specify, AWS CloudFormation assumes that you want - // to remove those tags from the stack set, and checks to see if you have - // permission to untag resources. If you don't have the necessary permission(s), - // the entire UpdateStackSet action fails with an access denied error, and the - // stack set is not updated. - Tags []*types.Tag - // In some cases, you must explicitly acknowledge that your stack template contains // certain capabilities in order for AWS CloudFormation to update the stack set and // its associated stack instances. @@ -223,14 +174,20 @@ type UpdateStackSetInput struct { // will fail. Capabilities []types.Capability - // The location of the file that contains the template body. The URL must point to - // a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket. - // For more information, see Template Anatomy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) - // in the AWS CloudFormation User Guide. Conditional: You must specify only one of - // the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate - // to true. - TemplateURL *string + // [Service-managed permissions] The AWS Organizations accounts in which to update + // associated stack instances. To update all the stack instances associated with + // this stack set, do not specify DeploymentTargets or Regions. If the stack set + // update includes changes to the template (that is, if TemplateBody or TemplateURL + // is specified), or the Parameters, AWS CloudFormation marks all stack instances + // with a status of OUTDATED prior to updating the stack instances in the specified + // accounts and Regions. If the stack set update does not include changes to the + // template or parameters, AWS CloudFormation updates the stack instances in the + // specified accounts and Regions, while leaving all other stack instances with + // their existing stack instance status. + DeploymentTargets *types.DeploymentTargets + + // A brief description of updates that you are making. + Description *string // The name of the IAM execution role to use to update the stack set. If you do not // specify an execution role, AWS CloudFormation uses the @@ -243,22 +200,36 @@ type UpdateStackSetInput struct { // long as you have permissions to perform operations on the stack set. ExecutionRoleName *string - // The Amazon Resource Number (ARN) of the IAM role to use to update this stack - // set. Specify an IAM role only if you are using customized administrator roles to - // control which users or groups can manage specific stack sets within the same - // administrator account. For more information, see Granting Permissions for Stack - // Set Operations - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) - // in the AWS CloudFormation User Guide. If you specified a customized - // administrator role when you created the stack set, you must specify a customized - // administrator role, even if it is the same customized administrator role used - // with this stack set previously. - AdministrationRoleARN *string + // The unique ID for this stack set operation. The operation ID also functions as + // an idempotency token, to ensure that AWS CloudFormation performs the stack set + // operation only once, even if you retry the request multiple times. You might + // retry stack set operation requests to ensure that AWS CloudFormation + // successfully received them. If you don't specify an operation ID, AWS + // CloudFormation generates one automatically. Repeating this stack set operation + // with a new operation ID retries all stack instances whose status is OUTDATED. + OperationId *string - // The name or unique ID of the stack set that you want to update. + // Preferences for how AWS CloudFormation performs this stack set operation. + OperationPreferences *types.StackSetOperationPreferences + + // A list of input parameters for the stack set template. + Parameters []*types.Parameter + + // Describes how the IAM roles required for stack set operations are created. You + // cannot modify PermissionModel if there are stack instances associated with your + // stack set. // - // This member is required. - StackSetName *string + // * With self-managed permissions, you must create the + // administrator and execution roles required to deploy to target accounts. For + // more information, see Grant Self-Managed Stack Set Permissions + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html). + // + // + // * With service-managed permissions, StackSets automatically creates the IAM + // roles required to deploy to accounts managed by AWS Organizations. For more + // information, see Grant Service-Managed Stack Set Permissions + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html). + PermissionModel types.PermissionModels // The Regions in which to update associated stack instances. If you specify // Regions, you must also specify accounts in which to update stack set instances. @@ -273,28 +244,57 @@ type UpdateStackSetInput struct { // their existing stack instance status. Regions []*string - // A list of input parameters for the stack set template. - Parameters []*types.Parameter + // The key-value pairs to associate with this stack set and the stacks created from + // it. AWS CloudFormation also propagates these tags to supported resources that + // are created in the stacks. You can specify a maximum number of 50 tags. If you + // specify tags for this parameter, those tags replace any list of tags that are + // currently associated with this stack set. This means: + // + // * If you don't + // specify this parameter, AWS CloudFormation doesn't modify the stack's tags. + // + // + // * If you specify any tags using this parameter, you must specify all the tags + // that you want associated with this stack set, even tags you've specifed before + // (for example, when creating the stack set or during a previous update of the + // stack set.). Any tags that you don't include in the updated list of tags are + // removed from the stack set, and therefore from the stacks and resources as + // well. + // + // * If you specify an empty value, AWS CloudFormation removes all + // currently associated tags. + // + // If you specify new tags as part of an UpdateStackSet + // action, AWS CloudFormation checks to see if you have the required IAM permission + // to tag resources. If you omit tags that are currently associated with the stack + // set from the list of tags you specify, AWS CloudFormation assumes that you want + // to remove those tags from the stack set, and checks to see if you have + // permission to untag resources. If you don't have the necessary permission(s), + // the entire UpdateStackSet action fails with an access denied error, and the + // stack set is not updated. + Tags []*types.Tag - // Preferences for how AWS CloudFormation performs this stack set operation. - OperationPreferences *types.StackSetOperationPreferences + // The structure that contains the template body, with a minimum length of 1 byte + // and a maximum length of 51,200 bytes. For more information, see Template Anatomy + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) + // in the AWS CloudFormation User Guide. Conditional: You must specify only one of + // the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate + // to true. + TemplateBody *string + + // The location of the file that contains the template body. The URL must point to + // a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket. + // For more information, see Template Anatomy + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) + // in the AWS CloudFormation User Guide. Conditional: You must specify only one of + // the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate + // to true. + TemplateURL *string // Use the existing template that's associated with the stack set that you're // updating. Conditional: You must specify only one of the following parameters: // TemplateBody or TemplateURL—or set UsePreviousTemplate to true. UsePreviousTemplate *bool - - // [Service-managed permissions] The AWS Organizations accounts in which to update - // associated stack instances. To update all the stack instances associated with - // this stack set, do not specify DeploymentTargets or Regions. If the stack set - // update includes changes to the template (that is, if TemplateBody or TemplateURL - // is specified), or the Parameters, AWS CloudFormation marks all stack instances - // with a status of OUTDATED prior to updating the stack instances in the specified - // accounts and Regions. If the stack set update does not include changes to the - // template or parameters, AWS CloudFormation updates the stack instances in the - // specified accounts and Regions, while leaving all other stack instances with - // their existing stack instance status. - DeploymentTargets *types.DeploymentTargets } type UpdateStackSetOutput struct { diff --git a/service/cloudformation/api_op_ValidateTemplate.go b/service/cloudformation/api_op_ValidateTemplate.go index e95bd20db0c..d7cf13eed1e 100644 --- a/service/cloudformation/api_op_ValidateTemplate.go +++ b/service/cloudformation/api_op_ValidateTemplate.go @@ -60,35 +60,25 @@ func (c *Client) ValidateTemplate(ctx context.Context, params *ValidateTemplateI // The input for ValidateTemplate () action. type ValidateTemplateInput struct { - // Location of file containing the template body. The URL must point to a template - // (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more - // information, go to Template Anatomy + // Structure containing the template body with a minimum length of 1 byte and a + // maximum length of 51,200 bytes. For more information, go to Template Anatomy // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the AWS CloudFormation User Guide. Conditional: You must pass TemplateURL or // TemplateBody. If both are passed, only TemplateBody is used. - TemplateURL *string + TemplateBody *string - // Structure containing the template body with a minimum length of 1 byte and a - // maximum length of 51,200 bytes. For more information, go to Template Anatomy + // Location of file containing the template body. The URL must point to a template + // (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more + // information, go to Template Anatomy // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the AWS CloudFormation User Guide. Conditional: You must pass TemplateURL or // TemplateBody. If both are passed, only TemplateBody is used. - TemplateBody *string + TemplateURL *string } // The output for ValidateTemplate () action. type ValidateTemplateOutput struct { - // A list of TemplateParameter structures. - Parameters []*types.TemplateParameter - - // The list of resources that generated the values in the Capabilities response - // element. - CapabilitiesReason *string - - // A list of the transforms that are declared in the template. - DeclaredTransforms []*string - // The capabilities found within the template. If your template contains IAM // resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for // this parameter when you use the CreateStack () or UpdateStack () actions with @@ -98,9 +88,19 @@ type ValidateTemplateOutput struct { // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). Capabilities []types.Capability + // The list of resources that generated the values in the Capabilities response + // element. + CapabilitiesReason *string + + // A list of the transforms that are declared in the template. + DeclaredTransforms []*string + // The description found within the template. Description *string + // A list of TemplateParameter structures. + Parameters []*types.TemplateParameter + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudformation/go.mod b/service/cloudformation/go.mod index 1dc1f07e6ef..3ceab7bb85c 100644 --- a/service/cloudformation/go.mod +++ b/service/cloudformation/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/cloudformation go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/cloudformation/types/types.go b/service/cloudformation/types/types.go index 393314f7dfd..c6d9a3330a6 100644 --- a/service/cloudformation/types/types.go +++ b/service/cloudformation/types/types.go @@ -19,10 +19,6 @@ import ( // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-account-gating.html). type AccountGateResult struct { - // The reason for the account gate status assigned to this account and Region for - // the stack set operation. - StatusReason *string - // The status of the account gate function. // // * SUCCEEDED: The account gate @@ -53,6 +49,10 @@ type AccountGateResult struct { // necessary, or no action is possible, on the stack. AWS CloudFormation skips the // stack set operation in this account and Region. Status AccountGateStatus + + // The reason for the account gate status assigned to this account and Region for + // the stack set operation. + StatusReason *string } // The AccountLimit data type. CloudFormation has the following limits per @@ -84,17 +84,17 @@ type AccountLimit struct { // organizational unit (OU). type AutoDeployment struct { - // If set to true, stack resources are retained when an account is removed from a - // target organization or OU. If set to false, stack resources are deleted. Specify - // only if Enabled is set to True. - RetainStacksOnAccountRemoval *bool - // If set to true, StackSets automatically deploys additional stack instances to // AWS Organizations accounts that are added to a target organization or // organizational unit (OU) in the specified Regions. If an account is removed from // a target organization or OU, StackSets deletes stack instances from the account // in the specified Regions. Enabled *bool + + // If set to true, stack resources are retained when an account is removed from a + // target organization or OU. If set to false, stack resources are deleted. Specify + // only if Enabled is set to True. + RetainStacksOnAccountRemoval *bool } // The Change structure describes the changes AWS CloudFormation will perform if @@ -114,37 +114,37 @@ type Change struct { // with which it's associated. type ChangeSetSummary struct { - // The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or - // FAILED. - Status ChangeSetStatus + // The ID of the change set. + ChangeSetId *string - // A description of the change set's status. For example, if your change set is in - // the FAILED state, AWS CloudFormation shows the error message. - StatusReason *string + // The name of the change set. + ChangeSetName *string + + // The start time when the change set was created, in UTC. + CreationTime *time.Time // Descriptive information about the change set. Description *string - // The ID of the change set. - ChangeSetId *string - // If the change set execution status is AVAILABLE, you can execute the change set. // If you can’t execute the change set, the status indicates why. For example, a // change set might be in an UNAVAILABLE state because AWS CloudFormation is still // creating it or in an OBSOLETE state because the stack was already updated. ExecutionStatus ExecutionStatus - // The name of the change set. - ChangeSetName *string + // The ID of the stack with which the change set is associated. + StackId *string // The name of the stack with which the change set is associated. StackName *string - // The ID of the stack with which the change set is associated. - StackId *string + // The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or + // FAILED. + Status ChangeSetStatus - // The start time when the change set was created, in UTC. - CreationTime *time.Time + // A description of the change set's status. For example, if your change set is in + // the FAILED state, AWS CloudFormation shows the error message. + StatusReason *string } // [Service-managed permissions] The AWS Organizations accounts to which StackSets @@ -167,6 +167,9 @@ type DeploymentTargets struct { // The Export structure describes the exported output values for a stack. type Export struct { + // The stack that contains the exported output name and value. + ExportingStackId *string + // The name of exported output value. Use this name and the Fn::ImportValue // function to import the associated value into other stacks. The name is defined // in the Export field in the associated stack's Outputs section. @@ -175,41 +178,38 @@ type Export struct { // The value of the exported output, such as a resource physical ID. This value is // defined in the Export field in the associated stack's Outputs section. Value *string - - // The stack that contains the exported output name and value. - ExportingStackId *string } // Contains logging configuration information for a type. type LoggingConfig struct { - // The ARN of the role that CloudFormation should assume when sending log entries - // to CloudWatch logs. - // - // This member is required. - LogRoleArn *string - // The Amazon CloudWatch log group to which CloudFormation sends error logging // information when invoking the type's handlers. // // This member is required. LogGroupName *string + + // The ARN of the role that CloudFormation should assume when sending log entries + // to CloudWatch logs. + // + // This member is required. + LogRoleArn *string } // The Output data type. type Output struct { - // The value associated with the output. - OutputValue *string - - // The key associated with the output. - OutputKey *string + // User defined description associated with the output. + Description *string // The name of the export associated with the output. ExportName *string - // User defined description associated with the output. - Description *string + // The key associated with the output. + OutputKey *string + + // The value associated with the output. + OutputValue *string } // The Parameter data type. @@ -220,15 +220,15 @@ type Parameter struct { // specified in your template. ParameterKey *string + // The input value associated with the parameter. + ParameterValue *string + // Read-only. The value that corresponds to a Systems Manager parameter key. This // field is returned only for SSM parameter types // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types) // in the template. ResolvedValue *string - // The input value associated with the parameter. - ParameterValue *string - // During a stack update, use the existing parameter value that the stack is using // for a given parameter key. If you specify true, do not specify a parameter // value. @@ -247,24 +247,24 @@ type ParameterConstraints struct { // The ParameterDeclaration data type. type ParameterDeclaration struct { - // The criteria that AWS CloudFormation uses to validate parameter values. - ParameterConstraints *ParameterConstraints + // The default value of the parameter. + DefaultValue *string // The description that is associate with the parameter. Description *string - // The type of parameter. - ParameterType *string - // Flag that indicates whether the parameter value is shown as plain text in logs // and in the AWS Management Console. NoEcho *bool - // The default value of the parameter. - DefaultValue *string + // The criteria that AWS CloudFormation uses to validate parameter values. + ParameterConstraints *ParameterConstraints // The name that is associated with the parameter. ParameterKey *string + + // The type of parameter. + ParameterType *string } // Context information that enables AWS CloudFormation to uniquely identify a @@ -274,15 +274,15 @@ type ParameterDeclaration struct { // targeted resource. type PhysicalResourceIdContextKeyValuePair struct { - // The resource context value. + // The resource context key. // // This member is required. - Value *string + Key *string - // The resource context key. + // The resource context value. // // This member is required. - Key *string + Value *string } // Information about a resource property whose actual value differs from its @@ -293,17 +293,6 @@ type PhysicalResourceIdContextKeyValuePair struct { // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). type PropertyDifference struct { - // The fully-qualified path to the resource property. - // - // This member is required. - PropertyPath *string - - // The expected property value of the resource property, as defined in the stack - // template and any values specified as template parameters. - // - // This member is required. - ExpectedValue *string - // The actual property value of the resource property. // // This member is required. @@ -323,12 +312,34 @@ type PropertyDifference struct { // // This member is required. DifferenceType DifferenceType + + // The expected property value of the resource property, as defined in the stack + // template and any values specified as template parameters. + // + // This member is required. + ExpectedValue *string + + // The fully-qualified path to the resource property. + // + // This member is required. + PropertyPath *string } // The ResourceChange structure describes the resource and the action that AWS // CloudFormation will perform on it if you execute this change set. type ResourceChange struct { + // The action that AWS CloudFormation takes on the resource, such as Add (adds a + // new resource), Modify (changes a resource), or Remove (deletes a resource). + Action ChangeAction + + // For the Modify action, a list of ResourceChangeDetail structures that describes + // the changes that AWS CloudFormation will make to the resource. + Details []*ResourceChangeDetail + + // The resource's logical ID, which is defined in the stack's template. + LogicalResourceId *string + // The resource's physical ID (resource name). Resources that you are adding don't // have physical IDs because they haven't been created. PhysicalResourceId *string @@ -345,10 +356,6 @@ type ResourceChange struct { // Conditionally, and then Never. Replacement Replacement - // The action that AWS CloudFormation takes on the resource, such as Add (adds a - // new resource), Modify (changes a resource), or Remove (deletes a resource). - Action ChangeAction - // The type of AWS CloudFormation resource, such as AWS::S3::Bucket. ResourceType *string @@ -356,19 +363,19 @@ type ResourceChange struct { // update, such as a change in the resource attribute's Metadata, Properties, or // Tags. Scope []ResourceAttribute - - // For the Modify action, a list of ResourceChangeDetail structures that describes - // the changes that AWS CloudFormation will make to the resource. - Details []*ResourceChangeDetail - - // The resource's logical ID, which is defined in the stack's template. - LogicalResourceId *string } // For a resource with Modify as the action, the ResourceChange structure describes // the changes AWS CloudFormation will make to that resource. type ResourceChangeDetail struct { + // The identity of the entity that triggered this change. This entity is a member + // of the group that is specified by the ChangeSource field. For example, if you + // modified the value of the KeyPairName parameter, the CausingEntity is the name + // of the parameter (KeyPairName). If the ChangeSource value is DirectModification, + // no value is given for CausingEntity. + CausingEntity *string + // The group to which the CausingEntity value belongs. There are five entity // groups: // @@ -395,17 +402,6 @@ type ResourceChangeDetail struct { // to AWS CloudFormation until you run an update on the parent stack. ChangeSource ChangeSource - // The identity of the entity that triggered this change. This entity is a member - // of the group that is specified by the ChangeSource field. For example, if you - // modified the value of the KeyPairName parameter, the CausingEntity is the name - // of the parameter (KeyPairName). If the ChangeSource value is DirectModification, - // no value is given for CausingEntity. - CausingEntity *string - - // A ResourceTargetDefinition structure that describes the field that AWS - // CloudFormation will change and whether the resource will be recreated. - Target *ResourceTargetDefinition - // Indicates whether AWS CloudFormation can determine the target value, and whether // the target value will change before you execute a change set. For Static // evaluations, AWS CloudFormation can determine that the target value will change, @@ -420,6 +416,10 @@ type ResourceChangeDetail struct { // resource is recreated, it will have a new physical ID, so all references to that // resource will also be updated. Evaluation EvaluationType + + // A ResourceTargetDefinition structure that describes the field that AWS + // CloudFormation will change and whether the resource will be recreated. + Target *ResourceTargetDefinition } // Describes the target resources of a specific type in your import template (for @@ -444,6 +444,10 @@ type ResourceIdentifierSummary struct { // property, and whether the resource will be recreated. type ResourceTargetDefinition struct { + // Indicates which resource attribute is triggering this update, such as a change + // in the resource attribute's Metadata, Properties, or Tags. + Attribute ResourceAttribute + // If the Attribute value is Properties, the name of the property. For all other // attributes, the value is null. Name *string @@ -455,10 +459,6 @@ type ResourceTargetDefinition struct { // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) // in the AWS CloudFormation User Guide. RequiresRecreation RequiresRecreation - - // Indicates which resource attribute is triggering this update, such as a change - // in the resource attribute's Metadata, Properties, or Tags. - Attribute ResourceAttribute } // Describes the target resource of an import operation. @@ -495,6 +495,21 @@ type ResourceToImport struct { // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-rollback-triggers.html). type RollbackConfiguration struct { + // The amount of time, in minutes, during which CloudFormation should monitor all + // the rollback triggers after the stack creation or update operation deploys all + // necessary resources. The default is 0 minutes. If you specify a monitoring + // period but do not specify any rollback triggers, CloudFormation still waits the + // specified period of time before cleaning up old resources after update + // operations. You can use this monitoring period to perform any manual stack + // validation desired, and manually cancel the stack creation or update (using + // CancelUpdateStack + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CancelUpdateStack.html), + // for example) as necessary. If you specify 0 for this parameter, CloudFormation + // still monitors the specified rollback triggers during stack creation and update + // operations. Then, for update operations, it begins disposing of old resources + // immediately once the operation completes. + MonitoringTimeInMinutes *int32 + // The triggers to monitor during stack creation or update actions. By default, AWS // CloudFormation saves the rollback triggers specified for a stack and applies // them to any subsequent update operations for the stack, unless you specify @@ -518,21 +533,6 @@ type RollbackConfiguration struct { // a specified trigger is missing, the entire stack operation fails and is rolled // back. RollbackTriggers []*RollbackTrigger - - // The amount of time, in minutes, during which CloudFormation should monitor all - // the rollback triggers after the stack creation or update operation deploys all - // necessary resources. The default is 0 minutes. If you specify a monitoring - // period but do not specify any rollback triggers, CloudFormation still waits the - // specified period of time before cleaning up old resources after update - // operations. You can use this monitoring period to perform any manual stack - // validation desired, and manually cancel the stack creation or update (using - // CancelUpdateStack - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CancelUpdateStack.html), - // for example) as necessary. If you specify 0 for this parameter, CloudFormation - // still monitors the specified rollback triggers during stack creation and update - // operations. Then, for update operations, it begins disposing of old resources - // immediately once the operation completes. - MonitoringTimeInMinutes *int32 } // A rollback trigger AWS CloudFormation monitors during creation and updating of @@ -541,49 +541,49 @@ type RollbackConfiguration struct { // rolls back the entire stack operation. type RollbackTrigger struct { + // The Amazon Resource Name (ARN) of the rollback trigger. If a specified trigger + // is missing, the entire stack operation fails and is rolled back. + // + // This member is required. + Arn *string + // The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html) // is the only supported resource type. // // This member is required. Type *string - - // The Amazon Resource Name (ARN) of the rollback trigger. If a specified trigger - // is missing, the entire stack operation fails and is rolled back. - // - // This member is required. - Arn *string } // The Stack data type. type Stack struct { - // A list of output structures. - Outputs []*Output + // The time at which the stack was created. + // + // This member is required. + CreationTime *time.Time - // A list of Parameter structures. - Parameters []*Parameter + // The name associated with the stack. + // + // This member is required. + StackName *string - // The rollback triggers for AWS CloudFormation to monitor during stack creation - // and updating operations, and for the specified monitoring period afterwards. - RollbackConfiguration *RollbackConfiguration + // Current status of the stack. + // + // This member is required. + StackStatus StackStatus + + // The capabilities allowed in the stack. + Capabilities []Capability + + // The unique ID of the change set. + ChangeSetId *string // The time the stack was deleted. DeletionTime *time.Time - // The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) - // role that is associated with the stack. During a stack operation, AWS - // CloudFormation uses this role's credentials to make calls on your behalf. - RoleARN *string - - // Whether termination protection is enabled for the stack. For nested stacks - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html), - // termination protection is set on the root stack and cannot be changed directly - // on the nested stack. For more information, see Protecting a Stack From Being - // Deleted - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) - // in the AWS CloudFormation User Guide. - EnableTerminationProtection *bool + // A user-defined description associated with the stack. + Description *string // Boolean to enable or disable rollback on stack creation failures: // @@ -593,35 +593,34 @@ type Stack struct { // * false: enable rollback DisableRollback *bool - // The time at which the stack was created. - // - // This member is required. - CreationTime *time.Time + // Information on whether a stack's actual configuration differs, or has drifted, + // from it's expected configuration, as defined in the stack template and any + // values specified as template parameters. For more information, see Detecting + // Unregulated Configuration Changes to Stacks and Resources + // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). + DriftInformation *StackDriftInformation + + // Whether termination protection is enabled for the stack. For nested stacks + // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html), + // termination protection is set on the root stack and cannot be changed directly + // on the nested stack. For more information, see Protecting a Stack From Being + // Deleted + // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) + // in the AWS CloudFormation User Guide. + EnableTerminationProtection *bool // The time the stack was last updated. This field will only be returned if the // stack has been updated at least once. LastUpdatedTime *time.Time - // Success/failure message associated with the stack status. - StackStatusReason *string - - // The capabilities allowed in the stack. - Capabilities []Capability - - // Current status of the stack. - // - // This member is required. - StackStatus StackStatus + // SNS topic ARNs to which stack related events are published. + NotificationARNs []*string - // A user-defined description associated with the stack. - Description *string + // A list of output structures. + Outputs []*Output - // For nested stacks--stacks created as resources for another stack--the stack ID - // of the top-level stack to which the nested stack ultimately belongs. For more - // information, see Working with Nested Stacks - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) - // in the AWS CloudFormation User Guide. - RootId *string + // A list of Parameter structures. + Parameters []*Parameter // For nested stacks--stacks created as resources for another stack--the stack ID // of the direct parent of this stack. For the first level of nested stacks, the @@ -631,32 +630,33 @@ type Stack struct { // in the AWS CloudFormation User Guide. ParentId *string - // SNS topic ARNs to which stack related events are published. - NotificationARNs []*string + // The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) + // role that is associated with the stack. During a stack operation, AWS + // CloudFormation uses this role's credentials to make calls on your behalf. + RoleARN *string - // The unique ID of the change set. - ChangeSetId *string + // The rollback triggers for AWS CloudFormation to monitor during stack creation + // and updating operations, and for the specified monitoring period afterwards. + RollbackConfiguration *RollbackConfiguration + + // For nested stacks--stacks created as resources for another stack--the stack ID + // of the top-level stack to which the nested stack ultimately belongs. For more + // information, see Working with Nested Stacks + // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) + // in the AWS CloudFormation User Guide. + RootId *string + + // Unique identifier of the stack. + StackId *string + + // Success/failure message associated with the stack status. + StackStatusReason *string // A list of Tags that specify information about the stack. Tags []*Tag // The amount of time within which stack creation should complete. TimeoutInMinutes *int32 - - // The name associated with the stack. - // - // This member is required. - StackName *string - - // Unique identifier of the stack. - StackId *string - - // Information on whether a stack's actual configuration differs, or has drifted, - // from it's expected configuration, as defined in the stack template and any - // values specified as template parameters. For more information, see Detecting - // Unregulated Configuration Changes to Stacks and Resources - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). - DriftInformation *StackDriftInformation } // Contains information about whether the stack's actual configuration differs, or @@ -665,10 +665,6 @@ type Stack struct { // drifted if one or more of its resources have drifted. type StackDriftInformation struct { - // Most recent time when a drift detection operation was initiated on the stack, or - // any of its individual resources that support drift detection. - LastCheckTimestamp *time.Time - // Status of the stack's actual configuration compared to its expected template // configuration. // @@ -687,6 +683,10 @@ type StackDriftInformation struct { // // This member is required. StackDriftStatus StackDriftStatus + + // Most recent time when a drift detection operation was initiated on the stack, or + // any of its individual resources that support drift detection. + LastCheckTimestamp *time.Time } // Contains information about whether the stack's actual configuration differs, or @@ -722,6 +722,26 @@ type StackDriftInformationSummary struct { // The StackEvent data type. type StackEvent struct { + // The unique ID of this event. + // + // This member is required. + EventId *string + + // The unique ID name of the instance of the stack. + // + // This member is required. + StackId *string + + // The name associated with a stack. + // + // This member is required. + StackName *string + + // Time the status was updated. + // + // This member is required. + Timestamp *time.Time + // The token passed to the operation that generated this event. All events // triggered by a given stack operation are assigned the same client request token, // which you can use to track operations. For example, if you execute a CreateStack @@ -735,46 +755,26 @@ type StackEvent struct { // Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. ClientRequestToken *string - // Success/failure message associated with the resource. - ResourceStatusReason *string - // The logical name of the resource specified in the template. LogicalResourceId *string + // The name or unique identifier associated with the physical instance of the + // resource. + PhysicalResourceId *string + // BLOB of the properties used to create the resource. ResourceProperties *string - // Time the status was updated. - // - // This member is required. - Timestamp *time.Time - - // The name associated with a stack. - // - // This member is required. - StackName *string - - // The unique ID name of the instance of the stack. - // - // This member is required. - StackId *string - - // The unique ID of this event. - // - // This member is required. - EventId *string - // Current status of the resource. ResourceStatus ResourceStatus + // Success/failure message associated with the resource. + ResourceStatusReason *string + // Type of resource. (For more information, go to AWS Resource Types Reference // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) // in the AWS CloudFormation User Guide.) ResourceType *string - - // The name or unique identifier associated with the physical instance of the - // resource. - PhysicalResourceId *string } // An AWS CloudFormation stack, in a specific account and Region, that's part of a @@ -786,8 +786,9 @@ type StackEvent struct { // stack and the stack status. type StackInstance struct { - // The name of the AWS Region that the stack instance is associated with. - Region *string + // [Self-managed permissions] The name of the AWS account that the stack instance + // is associated with. + Account *string // Status of the stack instance's actual configuration compared to the expected // template and parameter configuration of the stack set to which it belongs. @@ -808,21 +809,32 @@ type StackInstance struct { // * UNKNOWN: This value is reserved for future use. DriftStatus StackDriftStatus + // Most recent time when CloudFormation performed a drift detection operation on + // the stack instance. This value will be NULL for any stack instance on which + // drift detection has not yet been performed. + LastDriftCheckTimestamp *time.Time + + // [Service-managed permissions] The organization root ID or organizational unit + // (OU) IDs that you specified for DeploymentTargets + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html). + OrganizationalUnitId *string + // A list of parameters from the stack set template whose values have been // overridden in this stack instance. ParameterOverrides []*Parameter - // The explanation for the specific status code that is assigned to this stack - // instance. - StatusReason *string + // The name of the AWS Region that the stack instance is associated with. + Region *string // The ID of the stack instance. StackId *string - // Most recent time when CloudFormation performed a drift detection operation on - // the stack instance. This value will be NULL for any stack instance on which - // drift detection has not yet been performed. - LastDriftCheckTimestamp *time.Time + // The detailed status of the stack instance. + StackInstanceStatus *StackInstanceComprehensiveStatus + + // The name or unique ID of the stack set that the stack instance is associated + // with. + StackSetId *string // The status of the stack instance, in terms of its synchronization with its // associated stack set. @@ -847,21 +859,9 @@ type StackInstance struct { // is currently up to date with the stack set. Status StackInstanceStatus - // [Service-managed permissions] The organization root ID or organizational unit - // (OU) IDs that you specified for DeploymentTargets - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html). - OrganizationalUnitId *string - - // The name or unique ID of the stack set that the stack instance is associated - // with. - StackSetId *string - - // [Self-managed permissions] The name of the AWS account that the stack instance - // is associated with. - Account *string - - // The detailed status of the stack instance. - StackInstanceStatus *StackInstanceComprehensiveStatus + // The explanation for the specific status code that is assigned to this stack + // instance. + StatusReason *string } // The detailed status of the stack instance. @@ -907,53 +907,10 @@ type StackInstanceFilter struct { // The structure that contains summary information about a stack instance. type StackInstanceSummary struct { - // The status of the stack instance, in terms of its synchronization with its - // associated stack set. - // - // * INOPERABLE: A DeleteStackInstances operation has - // failed and left the stack in an unstable state. Stacks in this state are - // excluded from further UpdateStackSet operations. You might need to perform a - // DeleteStackInstances operation, with RetainStacks set to true, to delete the - // stack instance, and then delete the stack manually. - // - // * OUTDATED: The stack - // isn't currently up to date with the stack set because: - // - // * The associated - // stack failed during a CreateStackSet or UpdateStackSet operation. - // - // * The - // stack was part of a CreateStackSet or UpdateStackSet operation that failed or - // was stopped before the stack was created or updated. - // - // * CURRENT: The stack - // is currently up to date with the stack set. - Status StackInstanceStatus - - // The explanation for the specific status code assigned to this stack instance. - StatusReason *string - - // Most recent time when CloudFormation performed a drift detection operation on - // the stack instance. This value will be NULL for any stack instance on which - // drift detection has not yet been performed. - LastDriftCheckTimestamp *time.Time - - // [Service-managed permissions] The organization root ID or organizational unit - // (OU) IDs that you specified for DeploymentTargets - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html). - OrganizationalUnitId *string - - // The name or unique ID of the stack set that the stack instance is associated - // with. - StackSetId *string - // [Self-managed permissions] The name of the AWS account that the stack instance // is associated with. Account *string - // The detailed status of the stack instance. - StackInstanceStatus *StackInstanceComprehensiveStatus - // Status of the stack instance's actual configuration compared to the expected // template and parameter configuration of the stack set to which it belongs. // @@ -973,14 +930,57 @@ type StackInstanceSummary struct { // * UNKNOWN: This value is reserved for future use. DriftStatus StackDriftStatus - // The ID of the stack instance. - StackId *string + // Most recent time when CloudFormation performed a drift detection operation on + // the stack instance. This value will be NULL for any stack instance on which + // drift detection has not yet been performed. + LastDriftCheckTimestamp *time.Time + + // [Service-managed permissions] The organization root ID or organizational unit + // (OU) IDs that you specified for DeploymentTargets + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html). + OrganizationalUnitId *string // The name of the AWS Region that the stack instance is associated with. Region *string -} -// The StackResource data type. + // The ID of the stack instance. + StackId *string + + // The detailed status of the stack instance. + StackInstanceStatus *StackInstanceComprehensiveStatus + + // The name or unique ID of the stack set that the stack instance is associated + // with. + StackSetId *string + + // The status of the stack instance, in terms of its synchronization with its + // associated stack set. + // + // * INOPERABLE: A DeleteStackInstances operation has + // failed and left the stack in an unstable state. Stacks in this state are + // excluded from further UpdateStackSet operations. You might need to perform a + // DeleteStackInstances operation, with RetainStacks set to true, to delete the + // stack instance, and then delete the stack manually. + // + // * OUTDATED: The stack + // isn't currently up to date with the stack set because: + // + // * The associated + // stack failed during a CreateStackSet or UpdateStackSet operation. + // + // * The + // stack was part of a CreateStackSet or UpdateStackSet operation that failed or + // was stopped before the stack was created or updated. + // + // * CURRENT: The stack + // is currently up to date with the stack set. + Status StackInstanceStatus + + // The explanation for the specific status code assigned to this stack instance. + StatusReason *string +} + +// The StackResource data type. type StackResource struct { // The logical name of the resource specified in the template. @@ -988,23 +988,6 @@ type StackResource struct { // This member is required. LogicalResourceId *string - // Success/failure message associated with the resource. - ResourceStatusReason *string - - // User defined description associated with the resource. - Description *string - - // Information about whether the resource's actual configuration differs, or has - // drifted, from its expected configuration, as defined in the stack template and - // any values specified as template parameters. For more information, see Detecting - // Unregulated Configuration Changes to Stacks and Resources - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). - DriftInformation *StackResourceDriftInformation - - // The name or unique identifier that corresponds to a physical instance ID of a - // resource supported by AWS CloudFormation. - PhysicalResourceId *string - // Current status of the resource. // // This member is required. @@ -1022,15 +1005,8 @@ type StackResource struct { // This member is required. Timestamp *time.Time - // The name associated with the stack. - StackName *string - - // Unique identifier of the stack. - StackId *string -} - -// Contains detailed information about the specified stack resource. -type StackResourceDetail struct { + // User defined description associated with the resource. + Description *string // Information about whether the resource's actual configuration differs, or has // drifted, from its expected configuration, as defined in the stack template and @@ -1039,25 +1015,54 @@ type StackResourceDetail struct { // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). DriftInformation *StackResourceDriftInformation + // The name or unique identifier that corresponds to a physical instance ID of a + // resource supported by AWS CloudFormation. + PhysicalResourceId *string + + // Success/failure message associated with the resource. + ResourceStatusReason *string + // Unique identifier of the stack. StackId *string // The name associated with the stack. StackName *string +} + +// Contains detailed information about the specified stack resource. +type StackResourceDetail struct { + + // Time the status was updated. + // + // This member is required. + LastUpdatedTimestamp *time.Time // The logical name of the resource specified in the template. // // This member is required. LogicalResourceId *string - // Time the status was updated. + // Current status of the resource. // // This member is required. - LastUpdatedTimestamp *time.Time + ResourceStatus ResourceStatus - // The name or unique identifier that corresponds to a physical instance ID of a - // resource supported by AWS CloudFormation. - PhysicalResourceId *string + // Type of resource. ((For more information, go to AWS Resource Types Reference + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) + // in the AWS CloudFormation User Guide.) + // + // This member is required. + ResourceType *string + + // User defined description associated with the resource. + Description *string + + // Information about whether the resource's actual configuration differs, or has + // drifted, from its expected configuration, as defined in the stack template and + // any values specified as template parameters. For more information, see Detecting + // Unregulated Configuration Changes to Stacks and Resources + // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). + DriftInformation *StackResourceDriftInformation // The content of the Metadata attribute declared for the resource. For more // information, see Metadata Attribute @@ -1065,23 +1070,18 @@ type StackResourceDetail struct { // in the AWS CloudFormation User Guide. Metadata *string - // User defined description associated with the resource. - Description *string - - // Type of resource. ((For more information, go to AWS Resource Types Reference - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) - // in the AWS CloudFormation User Guide.) - // - // This member is required. - ResourceType *string + // The name or unique identifier that corresponds to a physical instance ID of a + // resource supported by AWS CloudFormation. + PhysicalResourceId *string // Success/failure message associated with the resource. ResourceStatusReason *string - // Current status of the resource. - // - // This member is required. - ResourceStatus ResourceStatus + // Unique identifier of the stack. + StackId *string + + // The name associated with the stack. + StackName *string } // Contains the drift information for a resource that has been checked for drift. @@ -1104,17 +1104,15 @@ type StackResourceDrift struct { // This member is required. LogicalResourceId *string - // Context information that enables AWS CloudFormation to uniquely identify a - // resource. AWS CloudFormation uses context key-value pairs in cases where a - // resource's logical and physical IDs are not enough to uniquely identify that - // resource. Each context key-value pair specifies a unique resource that contains - // the targeted resource. - PhysicalResourceIdContext []*PhysicalResourceIdContextKeyValuePair + // The type of the resource. + // + // This member is required. + ResourceType *string - // A JSON structure containing the actual property values of the stack resource. - // For resources whose StackResourceDriftStatus is DELETED, this structure will not - // be present. - ActualProperties *string + // The ID of the stack. + // + // This member is required. + StackId *string // Status of the resource's actual configuration compared to its expected // configuration @@ -1136,31 +1134,33 @@ type StackResourceDrift struct { // This member is required. StackResourceDriftStatus StackResourceDriftStatus - // The type of the resource. - // - // This member is required. - ResourceType *string - - // The name or unique identifier that corresponds to a physical instance ID of a - // resource supported by AWS CloudFormation. - PhysicalResourceId *string - // Time at which AWS CloudFormation performed drift detection on the stack // resource. // // This member is required. Timestamp *time.Time + // A JSON structure containing the actual property values of the stack resource. + // For resources whose StackResourceDriftStatus is DELETED, this structure will not + // be present. + ActualProperties *string + // A JSON structure containing the expected property values of the stack resource, // as defined in the stack template and any values specified as template // parameters. For resources whose StackResourceDriftStatus is DELETED, this // structure will not be present. ExpectedProperties *string - // The ID of the stack. - // - // This member is required. - StackId *string + // The name or unique identifier that corresponds to a physical instance ID of a + // resource supported by AWS CloudFormation. + PhysicalResourceId *string + + // Context information that enables AWS CloudFormation to uniquely identify a + // resource. AWS CloudFormation uses context key-value pairs in cases where a + // resource's logical and physical IDs are not enough to uniquely identify that + // resource. Each context key-value pair specifies a unique resource that contains + // the targeted resource. + PhysicalResourceIdContext []*PhysicalResourceIdContextKeyValuePair // A collection of the resource properties whose actual values differ from their // expected values. These will be present only for resources whose @@ -1203,10 +1203,6 @@ type StackResourceDriftInformation struct { // differs, or has drifted, from its expected configuration. type StackResourceDriftInformationSummary struct { - // When AWS CloudFormation last checked if the resource had drifted from its - // expected configuration. - LastCheckTimestamp *time.Time - // Status of the resource's actual configuration compared to its expected // configuration // @@ -1233,27 +1229,29 @@ type StackResourceDriftInformationSummary struct { // // This member is required. StackResourceDriftStatus StackResourceDriftStatus + + // When AWS CloudFormation last checked if the resource had drifted from its + // expected configuration. + LastCheckTimestamp *time.Time } // Contains high-level information about the specified stack resource. type StackResourceSummary struct { - // Success/failure message associated with the resource. - ResourceStatusReason *string + // Time the status was updated. + // + // This member is required. + LastUpdatedTimestamp *time.Time // The logical name of the resource specified in the template. // // This member is required. LogicalResourceId *string - // The name or unique identifier that corresponds to a physical instance ID of the - // resource. - PhysicalResourceId *string - - // Time the status was updated. + // Current status of the resource. // // This member is required. - LastUpdatedTimestamp *time.Time + ResourceStatus ResourceStatus // Type of resource. (For more information, go to AWS Resource Types Reference // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) @@ -1269,10 +1267,12 @@ type StackResourceSummary struct { // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). DriftInformation *StackResourceDriftInformationSummary - // Current status of the resource. - // - // This member is required. - ResourceStatus ResourceStatus + // The name or unique identifier that corresponds to a physical instance ID of the + // resource. + PhysicalResourceId *string + + // Success/failure message associated with the resource. + ResourceStatusReason *string } // A structure that contains information about a stack set. A stack set enables you @@ -1281,21 +1281,6 @@ type StackResourceSummary struct { // well as any parameters and capabilities that the template requires. type StackSet struct { - // The status of the stack set. - Status StackSetStatus - - // The name that's associated with the stack set. - StackSetName *string - - // The name of the IAM execution role used to create or update the stack set. Use - // customized execution roles to control which stack resources users and groups can - // include in their stack sets. - ExecutionRoleName *string - - // A description of the stack set that you specify when the stack set is created or - // updated. - Description *string - // The Amazon Resource Number (ARN) of the IAM role used to create or update the // stack set. Use customized administrator roles to control which users or groups // can manage specific stack sets within the same administrator account. For more @@ -1304,20 +1289,35 @@ type StackSet struct { // in the AWS CloudFormation User Guide. AdministrationRoleARN *string + // [Service-managed permissions] Describes whether StackSets automatically deploys + // to AWS Organizations accounts that are added to a target organization or + // organizational unit (OU). + AutoDeployment *AutoDeployment + + // The capabilities that are allowed in the stack set. Some stack set templates + // might include resources that can affect permissions in your AWS account—for + // example, by creating new AWS Identity and Access Management (IAM) users. For + // more information, see Acknowledging IAM Resources in AWS CloudFormation + // Templates. + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities) + Capabilities []Capability + + // A description of the stack set that you specify when the stack set is created or + // updated. + Description *string + + // The name of the IAM execution role used to create or update the stack set. Use + // customized execution roles to control which stack resources users and groups can + // include in their stack sets. + ExecutionRoleName *string + // [Service-managed permissions] The organization root ID or organizational unit // (OU) IDs that you specified for DeploymentTargets // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html). OrganizationalUnitIds []*string - // A list of tags that specify information about the stack set. A maximum number of - // 50 tags can be specified. - Tags []*Tag - - // Detailed information about the drift status of the stack set. For stack sets, - // contains information about the last completed drift operation performed on the - // stack set. Information about drift operations currently in progress is not - // included. - StackSetDriftDetectionDetails *StackSetDriftDetectionDetails + // A list of input parameters for a stack set. + Parameters []*Parameter // Describes how the IAM roles required for stack set operations are created. // @@ -1334,27 +1334,27 @@ type StackSet struct { // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html). PermissionModel PermissionModels - // [Service-managed permissions] Describes whether StackSets automatically deploys - // to AWS Organizations accounts that are added to a target organization or - // organizational unit (OU). - AutoDeployment *AutoDeployment + // The Amazon Resource Number (ARN) of the stack set. + StackSetARN *string + + // Detailed information about the drift status of the stack set. For stack sets, + // contains information about the last completed drift operation performed on the + // stack set. Information about drift operations currently in progress is not + // included. + StackSetDriftDetectionDetails *StackSetDriftDetectionDetails // The ID of the stack set. StackSetId *string - // The capabilities that are allowed in the stack set. Some stack set templates - // might include resources that can affect permissions in your AWS account—for - // example, by creating new AWS Identity and Access Management (IAM) users. For - // more information, see Acknowledging IAM Resources in AWS CloudFormation - // Templates. - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities) - Capabilities []Capability + // The name that's associated with the stack set. + StackSetName *string - // The Amazon Resource Number (ARN) of the stack set. - StackSetARN *string + // The status of the stack set. + Status StackSetStatus - // A list of input parameters for a stack set. - Parameters []*Parameter + // A list of tags that specify information about the stack set. A maximum number of + // 50 tags can be specified. + Tags []*Tag // The structure that contains the body of the template that was used to create or // update the stack set. @@ -1371,31 +1371,6 @@ type StackSet struct { // in the AWS CloudFormation User Guide. type StackSetDriftDetectionDetails struct { - // The total number of stack instances belonging to this stack set. The total - // number of stack instances is equal to the total of: - // - // * Stack instances that - // match the stack set configuration. - // - // * Stack instances that have drifted from - // the stack set configuration. - // - // * Stack instances where the drift detection - // operation has failed. - // - // * Stack instances currently being checked for drift. - TotalStackInstancesCount *int32 - - // The number of stack instances that have drifted from the expected template and - // parameter configuration of the stack set. A stack instance is considered to have - // drifted if one or more of the resources in the associated stack do not match - // their expected configuration. - DriftedStackInstancesCount *int32 - - // The number of stack instances which match the expected template and parameter - // configuration of the stack set. - InSyncStackInstancesCount *int32 - // The status of the stack set drift detection operation. // // * COMPLETED: The @@ -1433,21 +1408,102 @@ type StackSetDriftDetectionDetails struct { // the expected template and parameter configuration. DriftStatus StackSetDriftStatus - // The number of stack instances that are currently being checked for drift. - InProgressStackInstancesCount *int32 + // The number of stack instances that have drifted from the expected template and + // parameter configuration of the stack set. A stack instance is considered to have + // drifted if one or more of the resources in the associated stack do not match + // their expected configuration. + DriftedStackInstancesCount *int32 // The number of stack instances for which the drift detection operation failed. FailedStackInstancesCount *int32 + // The number of stack instances that are currently being checked for drift. + InProgressStackInstancesCount *int32 + + // The number of stack instances which match the expected template and parameter + // configuration of the stack set. + InSyncStackInstancesCount *int32 + // Most recent time when CloudFormation performed a drift detection operation on // the stack set. This value will be NULL for any stack set on which drift // detection has not yet been performed. LastDriftCheckTimestamp *time.Time + + // The total number of stack instances belonging to this stack set. The total + // number of stack instances is equal to the total of: + // + // * Stack instances that + // match the stack set configuration. + // + // * Stack instances that have drifted from + // the stack set configuration. + // + // * Stack instances where the drift detection + // operation has failed. + // + // * Stack instances currently being checked for drift. + TotalStackInstancesCount *int32 } // The structure that contains information about a stack set operation. type StackSetOperation struct { + // The type of stack set operation: CREATE, UPDATE, or DELETE. Create and delete + // operations affect only the specified stack set instances that are associated + // with the specified stack set. Update operations affect both the stack set + // itself, as well as all associated stack set instances. + Action StackSetOperationAction + + // The Amazon Resource Number (ARN) of the IAM role used to perform this stack set + // operation. Use customized administrator roles to control which users or groups + // can manage specific stack sets within the same administrator account. For more + // information, see Define Permissions for Multiple Administrators + // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) + // in the AWS CloudFormation User Guide. + AdministrationRoleARN *string + + // The time at which the operation was initiated. Note that the creation times for + // the stack set operation might differ from the creation time of the individual + // stacks themselves. This is because AWS CloudFormation needs to perform + // preparatory work for the operation, such as dispatching the work to the + // requested Regions, before actually creating the first stacks. + CreationTimestamp *time.Time + + // [Service-managed permissions] The AWS Organizations accounts affected by the + // stack operation. + DeploymentTargets *DeploymentTargets + + // The time at which the stack set operation ended, across all accounts and Regions + // specified. Note that this doesn't necessarily mean that the stack set operation + // was successful, or even attempted, in each account or Region. + EndTimestamp *time.Time + + // The name of the IAM execution role used to create or update the stack set. Use + // customized execution roles to control which stack resources users and groups can + // include in their stack sets. + ExecutionRoleName *string + + // The unique ID of a stack set operation. + OperationId *string + + // The preferences for how AWS CloudFormation performs this stack set operation. + OperationPreferences *StackSetOperationPreferences + + // For stack set operations of action type DELETE, specifies whether to remove the + // stack instances from the specified stack set, but doesn't delete the stacks. You + // can't reassociate a retained stack, or add an existing, saved stack to a new + // stack set. + RetainStacks *bool + + // Detailed information about the drift status of the stack set. This includes + // information about drift operations currently being performed on the stack set. + // this information will only be present for stack set operations whose Action type + // is DETECT_DRIFT. For more information, see Detecting Unmanaged Changes in Stack + // Sets + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html) + // in the AWS CloudFormation User Guide. + StackSetDriftDetectionDetails *StackSetDriftDetectionDetails + // The ID of the stack set. StackSetId *string @@ -1480,62 +1536,6 @@ type StackSetOperation struct { // SUCCEEDED: The operation completed creating or updating all the specified stacks // without exceeding the failure tolerance for the operation. Status StackSetOperationStatus - - // For stack set operations of action type DELETE, specifies whether to remove the - // stack instances from the specified stack set, but doesn't delete the stacks. You - // can't reassociate a retained stack, or add an existing, saved stack to a new - // stack set. - RetainStacks *bool - - // The preferences for how AWS CloudFormation performs this stack set operation. - OperationPreferences *StackSetOperationPreferences - - // The time at which the stack set operation ended, across all accounts and Regions - // specified. Note that this doesn't necessarily mean that the stack set operation - // was successful, or even attempted, in each account or Region. - EndTimestamp *time.Time - - // [Service-managed permissions] The AWS Organizations accounts affected by the - // stack operation. - DeploymentTargets *DeploymentTargets - - // The name of the IAM execution role used to create or update the stack set. Use - // customized execution roles to control which stack resources users and groups can - // include in their stack sets. - ExecutionRoleName *string - - // The unique ID of a stack set operation. - OperationId *string - - // Detailed information about the drift status of the stack set. This includes - // information about drift operations currently being performed on the stack set. - // this information will only be present for stack set operations whose Action type - // is DETECT_DRIFT. For more information, see Detecting Unmanaged Changes in Stack - // Sets - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html) - // in the AWS CloudFormation User Guide. - StackSetDriftDetectionDetails *StackSetDriftDetectionDetails - - // The type of stack set operation: CREATE, UPDATE, or DELETE. Create and delete - // operations affect only the specified stack set instances that are associated - // with the specified stack set. Update operations affect both the stack set - // itself, as well as all associated stack set instances. - Action StackSetOperationAction - - // The time at which the operation was initiated. Note that the creation times for - // the stack set operation might differ from the creation time of the individual - // stacks themselves. This is because AWS CloudFormation needs to perform - // preparatory work for the operation, such as dispatching the work to the - // requested Regions, before actually creating the first stacks. - CreationTimestamp *time.Time - - // The Amazon Resource Number (ARN) of the IAM role used to perform this stack set - // operation. Use customized administrator roles to control which users or groups - // can manage specific stack sets within the same administrator account. For more - // information, see Define Permissions for Multiple Administrators - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) - // in the AWS CloudFormation User Guide. - AdministrationRoleARN *string } // The user-specified preferences for how AWS CloudFormation performs a stack set @@ -1544,18 +1544,6 @@ type StackSetOperation struct { // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options). type StackSetOperationPreferences struct { - // The maximum number of accounts in which to perform this operation at one time. - // This is dependent on the value of FailureToleranceCount. MaxConcurrentCount is - // at most one more than the FailureToleranceCount. Note that this setting lets you - // specify the maximum for operations. For large deployments, under certain - // circumstances the actual number of accounts acted upon concurrently may be lower - // due to service throttling. Conditional: You must specify either - // MaxConcurrentCount or MaxConcurrentPercentage, but not both. - MaxConcurrentCount *int32 - - // The order of the Regions in where you want to perform the stack operation. - RegionOrder []*string - // The number of accounts, per Region, for which this operation can fail before AWS // CloudFormation stops the operation in that Region. If the operation is stopped // in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent @@ -1572,6 +1560,15 @@ type StackSetOperationPreferences struct { // FailureTolerancePercentage, but not both. FailureTolerancePercentage *int32 + // The maximum number of accounts in which to perform this operation at one time. + // This is dependent on the value of FailureToleranceCount. MaxConcurrentCount is + // at most one more than the FailureToleranceCount. Note that this setting lets you + // specify the maximum for operations. For large deployments, under certain + // circumstances the actual number of accounts acted upon concurrently may be lower + // due to service throttling. Conditional: You must specify either + // MaxConcurrentCount or MaxConcurrentPercentage, but not both. + MaxConcurrentCount *int32 + // The maximum percentage of accounts in which to perform this operation at one // time. When calculating the number of accounts based on the specified percentage, // AWS CloudFormation rounds down to the next whole number. This is true except in @@ -1582,18 +1579,27 @@ type StackSetOperationPreferences struct { // throttling. Conditional: You must specify either MaxConcurrentCount or // MaxConcurrentPercentage, but not both. MaxConcurrentPercentage *int32 + + // The order of the Regions in where you want to perform the stack operation. + RegionOrder []*string } // The structure that contains information about a specified operation's results // for a given account in a given Region. type StackSetOperationResultSummary struct { + // [Self-managed permissions] The name of the AWS account for this operation + // result. + Account *string + // The results of the account gate function AWS CloudFormation invokes, if present, // before proceeding with stack set operations in an account AccountGateResult *AccountGateResult - // The reason for the assigned result status. - StatusReason *string + // [Service-managed permissions] The organization root ID or organizational unit + // (OU) IDs that you specified for DeploymentTargets + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html). + OrganizationalUnitId *string // The name of the AWS Region for this operation result. Region *string @@ -1621,14 +1627,8 @@ type StackSetOperationResultSummary struct { // Region completed successfully. Status StackSetOperationResultStatus - // [Self-managed permissions] The name of the AWS account for this operation - // result. - Account *string - - // [Service-managed permissions] The organization root ID or organizational unit - // (OU) IDs that you specified for DeploymentTargets - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html). - OrganizationalUnitId *string + // The reason for the assigned result status. + StatusReason *string } // The structures that contain summary information about the specified operation. @@ -1640,6 +1640,21 @@ type StackSetOperationSummary struct { // associated stack set instances. Action StackSetOperationAction + // The time at which the operation was initiated. Note that the creation times for + // the stack set operation might differ from the creation time of the individual + // stacks themselves. This is because AWS CloudFormation needs to perform + // preparatory work for the operation, such as dispatching the work to the + // requested Regions, before actually creating the first stacks. + CreationTimestamp *time.Time + + // The time at which the stack set operation ended, across all accounts and Regions + // specified. Note that this doesn't necessarily mean that the stack set operation + // was successful, or even attempted, in each account or Region. + EndTimestamp *time.Time + + // The unique ID of the stack set operation. + OperationId *string + // The overall status of the operation. // // * FAILED: The operation exceeded the @@ -1669,29 +1684,11 @@ type StackSetOperationSummary struct { // SUCCEEDED: The operation completed creating or updating all the specified stacks // without exceeding the failure tolerance for the operation. Status StackSetOperationStatus - - // The unique ID of the stack set operation. - OperationId *string - - // The time at which the operation was initiated. Note that the creation times for - // the stack set operation might differ from the creation time of the individual - // stacks themselves. This is because AWS CloudFormation needs to perform - // preparatory work for the operation, such as dispatching the work to the - // requested Regions, before actually creating the first stacks. - CreationTimestamp *time.Time - - // The time at which the stack set operation ended, across all accounts and Regions - // specified. Note that this doesn't necessarily mean that the stack set operation - // was successful, or even attempted, in each account or Region. - EndTimestamp *time.Time } // The structures that contain summary information about the specified stack set. type StackSetSummary struct { - // The status of the stack set. - Status StackSetStatus - // [Service-managed permissions] Describes whether StackSets automatically deploys // to AWS Organizations accounts that are added to a target organizational unit // (OU). @@ -1701,32 +1698,6 @@ type StackSetSummary struct { // updated. Description *string - // The ID of the stack set. - StackSetId *string - - // Describes how the IAM roles required for stack set operations are created. - // - // - // * With self-managed permissions, you must create the administrator and execution - // roles required to deploy to target accounts. For more information, see Grant - // Self-Managed Stack Set Permissions - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html). - // - // - // * With service-managed permissions, StackSets automatically creates the IAM - // roles required to deploy to accounts managed by AWS Organizations. For more - // information, see Grant Service-Managed Stack Set Permissions - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html). - PermissionModel PermissionModels - - // Most recent time when CloudFormation performed a drift detection operation on - // the stack set. This value will be NULL for any stack set on which drift - // detection has not yet been performed. - LastDriftCheckTimestamp *time.Time - - // The name of the stack set. - StackSetName *string - // Status of the stack set's actual configuration compared to its expected template // and parameter configuration. A stack set is considered to have drifted if one or // more of its stack instances have drifted from their expected template and @@ -1747,25 +1718,57 @@ type StackSetSummary struct { // * UNKNOWN: This value is // reserved for future use. DriftStatus StackDriftStatus + + // Most recent time when CloudFormation performed a drift detection operation on + // the stack set. This value will be NULL for any stack set on which drift + // detection has not yet been performed. + LastDriftCheckTimestamp *time.Time + + // Describes how the IAM roles required for stack set operations are created. + // + // + // * With self-managed permissions, you must create the administrator and execution + // roles required to deploy to target accounts. For more information, see Grant + // Self-Managed Stack Set Permissions + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html). + // + // + // * With service-managed permissions, StackSets automatically creates the IAM + // roles required to deploy to accounts managed by AWS Organizations. For more + // information, see Grant Service-Managed Stack Set Permissions + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html). + PermissionModel PermissionModels + + // The ID of the stack set. + StackSetId *string + + // The name of the stack set. + StackSetName *string + + // The status of the stack set. + Status StackSetStatus } // The StackSummary Data Type type StackSummary struct { - // Success/Failure message associated with the stack status. - StackStatusReason *string + // The time the stack was created. + // + // This member is required. + CreationTime *time.Time // The name associated with the stack. // // This member is required. StackName *string - // Unique stack identifier. - StackId *string + // The current status of the stack. + // + // This member is required. + StackStatus StackStatus - // The time the stack was last updated. This field will only be returned if the - // stack has been updated at least once. - LastUpdatedTime *time.Time + // The time the stack was deleted. + DeletionTime *time.Time // Summarizes information on whether a stack's actual configuration differs, or has // drifted, from it's expected configuration, as defined in the stack template and @@ -1774,10 +1777,9 @@ type StackSummary struct { // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). DriftInformation *StackDriftInformationSummary - // The time the stack was created. - // - // This member is required. - CreationTime *time.Time + // The time the stack was last updated. This field will only be returned if the + // stack has been updated at least once. + LastUpdatedTime *time.Time // For nested stacks--stacks created as resources for another stack--the stack ID // of the direct parent of this stack. For the first level of nested stacks, the @@ -1794,13 +1796,11 @@ type StackSummary struct { // in the AWS CloudFormation User Guide. RootId *string - // The current status of the stack. - // - // This member is required. - StackStatus StackStatus + // Unique stack identifier. + StackId *string - // The time the stack was deleted. - DeletionTime *time.Time + // Success/Failure message associated with the stack status. + StackStatusReason *string // The template description of the template used to create the stack. TemplateDescription *string @@ -1810,59 +1810,59 @@ type StackSummary struct { // information about an AWS CloudFormation stack. type Tag struct { - // Required. A string containing the value for this tag. You can specify a maximum - // of 256 characters for a tag value. - // - // This member is required. - Value *string - // Required. A string used to identify this tag. You can specify a maximum of 128 // characters for a tag key. Tags owned by Amazon Web Services (AWS) have the // reserved prefix: aws:. // // This member is required. Key *string + + // Required. A string containing the value for this tag. You can specify a maximum + // of 256 characters for a tag value. + // + // This member is required. + Value *string } // The TemplateParameter data type. type TemplateParameter struct { + // The default value associated with the parameter. + DefaultValue *string + // User defined description associated with the parameter. Description *string - // The name associated with the parameter. - ParameterKey *string - // Flag indicating whether the parameter should be displayed as plain text in logs // and UIs. NoEcho *bool - // The default value associated with the parameter. - DefaultValue *string + // The name associated with the parameter. + ParameterKey *string } // Contains summary information about the specified CloudFormation type. type TypeSummary struct { - // The kind of type. - Type RegistryType - - // The name of the type. - TypeName *string - - // The description of the type. - Description *string - // The ID of the default version of the type. The default version is used when the // type version is not specified. To set the default version of a type, use // SetTypeDefaultVersion (). DefaultVersionId *string + // The description of the type. + Description *string + // When the current default version of the type was registered. LastUpdated *time.Time + // The kind of type. + Type RegistryType + // The Amazon Resource Name (ARN) of the type. TypeArn *string + + // The name of the type. + TypeName *string } // Contains summary information about a specific version of a CloudFormation type. @@ -1871,23 +1871,23 @@ type TypeVersionSummary struct { // The Amazon Resource Name (ARN) of the type version. Arn *string - // The name of the type. - TypeName *string - // The description of the type version. Description *string - // The ID of a specific version of the type. The version ID is the value at the end - // of the Amazon Resource Name (ARN) assigned to the type version when it is - // registered. - VersionId *string + // Whether the specified type version is set as the default version. + IsDefaultVersion *bool // When the version was registered. TimeCreated *time.Time - // Whether the specified type version is set as the default version. - IsDefaultVersion *bool - // The kind of type. Type RegistryType + + // The name of the type. + TypeName *string + + // The ID of a specific version of the type. The version ID is the value at the end + // of the Amazon Resource Name (ARN) assigned to the type version when it is + // registered. + VersionId *string } diff --git a/service/cloudfront/api_op_CreateCachePolicy.go b/service/cloudfront/api_op_CreateCachePolicy.go index 093c9f48e7a..2ecd83e263e 100644 --- a/service/cloudfront/api_op_CreateCachePolicy.go +++ b/service/cloudfront/api_op_CreateCachePolicy.go @@ -85,15 +85,15 @@ type CreateCachePolicyInput struct { type CreateCachePolicyOutput struct { + // A cache policy. + CachePolicy *types.CachePolicy + // The current version of the cache policy. ETag *string // The fully qualified URI of the cache policy just created. Location *string - // A cache policy. - CachePolicy *types.CachePolicy - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudfront/api_op_CreateCloudFrontOriginAccessIdentity.go b/service/cloudfront/api_op_CreateCloudFrontOriginAccessIdentity.go index f0ef704b30a..9e2378ddef8 100644 --- a/service/cloudfront/api_op_CreateCloudFrontOriginAccessIdentity.go +++ b/service/cloudfront/api_op_CreateCloudFrontOriginAccessIdentity.go @@ -79,12 +79,12 @@ type CreateCloudFrontOriginAccessIdentityInput struct { // The returned result of the corresponding request. type CreateCloudFrontOriginAccessIdentityOutput struct { - // The current version of the origin access identity created. - ETag *string - // The origin access identity's information. CloudFrontOriginAccessIdentity *types.CloudFrontOriginAccessIdentity + // The current version of the origin access identity created. + ETag *string + // The fully qualified URI of the new origin access identity just created. Location *string diff --git a/service/cloudfront/api_op_CreateFieldLevelEncryptionConfig.go b/service/cloudfront/api_op_CreateFieldLevelEncryptionConfig.go index 7d71ae673ef..df2a9a784e5 100644 --- a/service/cloudfront/api_op_CreateFieldLevelEncryptionConfig.go +++ b/service/cloudfront/api_op_CreateFieldLevelEncryptionConfig.go @@ -65,9 +65,6 @@ type CreateFieldLevelEncryptionConfigInput struct { type CreateFieldLevelEncryptionConfigOutput struct { - // The fully qualified URI of the new configuration resource just created. - Location *string - // The current version of the field level encryption configuration. For example: // E2QWRUHAPOMQZL. ETag *string @@ -75,6 +72,9 @@ type CreateFieldLevelEncryptionConfigOutput struct { // Returned when you create a new field-level encryption configuration. FieldLevelEncryption *types.FieldLevelEncryption + // The fully qualified URI of the new configuration resource just created. + Location *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudfront/api_op_CreateFieldLevelEncryptionProfile.go b/service/cloudfront/api_op_CreateFieldLevelEncryptionProfile.go index c8048c0d9a0..565ccbab363 100644 --- a/service/cloudfront/api_op_CreateFieldLevelEncryptionProfile.go +++ b/service/cloudfront/api_op_CreateFieldLevelEncryptionProfile.go @@ -65,13 +65,13 @@ type CreateFieldLevelEncryptionProfileInput struct { type CreateFieldLevelEncryptionProfileOutput struct { - // Returned when you create a new field-level encryption profile. - FieldLevelEncryptionProfile *types.FieldLevelEncryptionProfile - // The current version of the field level encryption profile. For example: // E2QWRUHAPOMQZL. ETag *string + // Returned when you create a new field-level encryption profile. + FieldLevelEncryptionProfile *types.FieldLevelEncryptionProfile + // The fully qualified URI of the new profile resource just created. Location *string diff --git a/service/cloudfront/api_op_CreateInvalidation.go b/service/cloudfront/api_op_CreateInvalidation.go index 376a7c62d85..9ed8d4e5997 100644 --- a/service/cloudfront/api_op_CreateInvalidation.go +++ b/service/cloudfront/api_op_CreateInvalidation.go @@ -58,15 +58,15 @@ func (c *Client) CreateInvalidation(ctx context.Context, params *CreateInvalidat // The request to create an invalidation. type CreateInvalidationInput struct { - // The batch information for the invalidation. + // The distribution's id. // // This member is required. - InvalidationBatch *types.InvalidationBatch + DistributionId *string - // The distribution's id. + // The batch information for the invalidation. // // This member is required. - DistributionId *string + InvalidationBatch *types.InvalidationBatch } // The returned result of the corresponding request. diff --git a/service/cloudfront/api_op_CreateOriginRequestPolicy.go b/service/cloudfront/api_op_CreateOriginRequestPolicy.go index 70609adf4fb..fe5f02b4280 100644 --- a/service/cloudfront/api_op_CreateOriginRequestPolicy.go +++ b/service/cloudfront/api_op_CreateOriginRequestPolicy.go @@ -89,14 +89,14 @@ type CreateOriginRequestPolicyInput struct { type CreateOriginRequestPolicyOutput struct { - // An origin request policy. - OriginRequestPolicy *types.OriginRequestPolicy + // The current version of the origin request policy. + ETag *string // The fully qualified URI of the origin request policy just created. Location *string - // The current version of the origin request policy. - ETag *string + // An origin request policy. + OriginRequestPolicy *types.OriginRequestPolicy // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/cloudfront/api_op_CreatePublicKey.go b/service/cloudfront/api_op_CreatePublicKey.go index f09440e217c..ce84500501e 100644 --- a/service/cloudfront/api_op_CreatePublicKey.go +++ b/service/cloudfront/api_op_CreatePublicKey.go @@ -66,15 +66,15 @@ type CreatePublicKeyInput struct { type CreatePublicKeyOutput struct { + // The current version of the public key. For example: E2QWRUHAPOMQZL. + ETag *string + // The fully qualified URI of the new public key resource just created. Location *string // Returned when you add a public key. PublicKey *types.PublicKey - // The current version of the public key. For example: E2QWRUHAPOMQZL. - ETag *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudfront/api_op_CreateStreamingDistribution.go b/service/cloudfront/api_op_CreateStreamingDistribution.go index 4ea7123a0b1..9b9deeb12e9 100644 --- a/service/cloudfront/api_op_CreateStreamingDistribution.go +++ b/service/cloudfront/api_op_CreateStreamingDistribution.go @@ -89,15 +89,15 @@ type CreateStreamingDistributionInput struct { // The returned result of the corresponding request. type CreateStreamingDistributionOutput struct { + // The current version of the streaming distribution created. + ETag *string + // The fully qualified URI of the new streaming distribution resource just created. Location *string // The streaming distribution's information. StreamingDistribution *types.StreamingDistribution - // The current version of the streaming distribution created. - ETag *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudfront/api_op_CreateStreamingDistributionWithTags.go b/service/cloudfront/api_op_CreateStreamingDistributionWithTags.go index 9fe8f5d1d78..58ec439c997 100644 --- a/service/cloudfront/api_op_CreateStreamingDistributionWithTags.go +++ b/service/cloudfront/api_op_CreateStreamingDistributionWithTags.go @@ -67,14 +67,14 @@ type CreateStreamingDistributionWithTagsInput struct { // The returned result of the corresponding request. type CreateStreamingDistributionWithTagsOutput struct { - // The streaming distribution's information. - StreamingDistribution *types.StreamingDistribution + // The current version of the distribution created. + ETag *string // The fully qualified URI of the new streaming distribution resource just created. Location *string - // The current version of the distribution created. - ETag *string + // The streaming distribution's information. + StreamingDistribution *types.StreamingDistribution // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/cloudfront/api_op_DeleteCachePolicy.go b/service/cloudfront/api_op_DeleteCachePolicy.go index 37f60254b3e..d95791159d1 100644 --- a/service/cloudfront/api_op_DeleteCachePolicy.go +++ b/service/cloudfront/api_op_DeleteCachePolicy.go @@ -60,16 +60,16 @@ func (c *Client) DeleteCachePolicy(ctx context.Context, params *DeleteCachePolic type DeleteCachePolicyInput struct { - // The version of the cache policy that you are deleting. The version is the cache - // policy’s ETag value, which you can get using ListCachePolicies, GetCachePolicy, - // or GetCachePolicyConfig. - IfMatch *string - // The unique identifier for the cache policy that you are deleting. To get the // identifier, you can use ListCachePolicies. // // This member is required. Id *string + + // The version of the cache policy that you are deleting. The version is the cache + // policy’s ETag value, which you can get using ListCachePolicies, GetCachePolicy, + // or GetCachePolicyConfig. + IfMatch *string } type DeleteCachePolicyOutput struct { diff --git a/service/cloudfront/api_op_DeleteCloudFrontOriginAccessIdentity.go b/service/cloudfront/api_op_DeleteCloudFrontOriginAccessIdentity.go index 0e2fabf5030..59a8c843188 100644 --- a/service/cloudfront/api_op_DeleteCloudFrontOriginAccessIdentity.go +++ b/service/cloudfront/api_op_DeleteCloudFrontOriginAccessIdentity.go @@ -57,14 +57,14 @@ func (c *Client) DeleteCloudFrontOriginAccessIdentity(ctx context.Context, param // Deletes a origin access identity. type DeleteCloudFrontOriginAccessIdentityInput struct { - // The value of the ETag header you received from a previous GET or PUT request. - // For example: E2QWRUHAPOMQZL. - IfMatch *string - // The origin access identity's ID. // // This member is required. Id *string + + // The value of the ETag header you received from a previous GET or PUT request. + // For example: E2QWRUHAPOMQZL. + IfMatch *string } type DeleteCloudFrontOriginAccessIdentityOutput struct { diff --git a/service/cloudfront/api_op_DeleteDistribution.go b/service/cloudfront/api_op_DeleteDistribution.go index 601d9aebecf..02bddde8fd1 100644 --- a/service/cloudfront/api_op_DeleteDistribution.go +++ b/service/cloudfront/api_op_DeleteDistribution.go @@ -96,14 +96,14 @@ func (c *Client) DeleteDistribution(ctx context.Context, params *DeleteDistribut // in the Amazon CloudFront Developer Guide. type DeleteDistributionInput struct { - // The value of the ETag header that you received when you disabled the - // distribution. For example: E2QWRUHAPOMQZL. - IfMatch *string - // The distribution ID. // // This member is required. Id *string + + // The value of the ETag header that you received when you disabled the + // distribution. For example: E2QWRUHAPOMQZL. + IfMatch *string } type DeleteDistributionOutput struct { diff --git a/service/cloudfront/api_op_DeleteFieldLevelEncryptionProfile.go b/service/cloudfront/api_op_DeleteFieldLevelEncryptionProfile.go index ec043e41ad9..935829698cf 100644 --- a/service/cloudfront/api_op_DeleteFieldLevelEncryptionProfile.go +++ b/service/cloudfront/api_op_DeleteFieldLevelEncryptionProfile.go @@ -56,14 +56,14 @@ func (c *Client) DeleteFieldLevelEncryptionProfile(ctx context.Context, params * type DeleteFieldLevelEncryptionProfileInput struct { - // The value of the ETag header that you received when retrieving the profile to - // delete. For example: E2QWRUHAPOMQZL. - IfMatch *string - // Request the ID of the profile you want to delete from CloudFront. // // This member is required. Id *string + + // The value of the ETag header that you received when retrieving the profile to + // delete. For example: E2QWRUHAPOMQZL. + IfMatch *string } type DeleteFieldLevelEncryptionProfileOutput struct { diff --git a/service/cloudfront/api_op_DeleteStreamingDistribution.go b/service/cloudfront/api_op_DeleteStreamingDistribution.go index 456d290ab8e..d0326f91320 100644 --- a/service/cloudfront/api_op_DeleteStreamingDistribution.go +++ b/service/cloudfront/api_op_DeleteStreamingDistribution.go @@ -84,14 +84,14 @@ func (c *Client) DeleteStreamingDistribution(ctx context.Context, params *Delete // The request to delete a streaming distribution. type DeleteStreamingDistributionInput struct { - // The value of the ETag header that you received when you disabled the streaming - // distribution. For example: E2QWRUHAPOMQZL. - IfMatch *string - // The distribution ID. // // This member is required. Id *string + + // The value of the ETag header that you received when you disabled the streaming + // distribution. For example: E2QWRUHAPOMQZL. + IfMatch *string } type DeleteStreamingDistributionOutput struct { diff --git a/service/cloudfront/api_op_GetCachePolicy.go b/service/cloudfront/api_op_GetCachePolicy.go index 25bf1279de2..e27e587d980 100644 --- a/service/cloudfront/api_op_GetCachePolicy.go +++ b/service/cloudfront/api_op_GetCachePolicy.go @@ -79,12 +79,12 @@ type GetCachePolicyInput struct { type GetCachePolicyOutput struct { - // The current version of the cache policy. - ETag *string - // The cache policy. CachePolicy *types.CachePolicy + // The current version of the cache policy. + ETag *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudfront/api_op_GetCachePolicyConfig.go b/service/cloudfront/api_op_GetCachePolicyConfig.go index aa1729949ec..7f9668375b4 100644 --- a/service/cloudfront/api_op_GetCachePolicyConfig.go +++ b/service/cloudfront/api_op_GetCachePolicyConfig.go @@ -72,12 +72,12 @@ type GetCachePolicyConfigInput struct { type GetCachePolicyConfigOutput struct { - // The current version of the cache policy. - ETag *string - // The cache policy configuration. CachePolicyConfig *types.CachePolicyConfig + // The current version of the cache policy. + ETag *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudfront/api_op_GetDistribution.go b/service/cloudfront/api_op_GetDistribution.go index dc449963b10..3e9a07b68a1 100644 --- a/service/cloudfront/api_op_GetDistribution.go +++ b/service/cloudfront/api_op_GetDistribution.go @@ -68,13 +68,13 @@ type GetDistributionInput struct { // The returned result of the corresponding request. type GetDistributionOutput struct { + // The distribution's information. + Distribution *types.Distribution + // The current version of the distribution's information. For example: // E2QWRUHAPOMQZL. ETag *string - // The distribution's information. - Distribution *types.Distribution - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudfront/api_op_GetDistributionConfig.go b/service/cloudfront/api_op_GetDistributionConfig.go index 0ddc2681f49..2bf1d4c666b 100644 --- a/service/cloudfront/api_op_GetDistributionConfig.go +++ b/service/cloudfront/api_op_GetDistributionConfig.go @@ -68,12 +68,12 @@ type GetDistributionConfigInput struct { // The returned result of the corresponding request. type GetDistributionConfigOutput struct { - // The current version of the configuration. For example: E2QWRUHAPOMQZL. - ETag *string - // The distribution's configuration information. DistributionConfig *types.DistributionConfig + // The current version of the configuration. For example: E2QWRUHAPOMQZL. + ETag *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudfront/api_op_GetFieldLevelEncryption.go b/service/cloudfront/api_op_GetFieldLevelEncryption.go index e4d40ab0fc4..e09ff78857e 100644 --- a/service/cloudfront/api_op_GetFieldLevelEncryption.go +++ b/service/cloudfront/api_op_GetFieldLevelEncryption.go @@ -65,13 +65,13 @@ type GetFieldLevelEncryptionInput struct { type GetFieldLevelEncryptionOutput struct { - // Return the field-level encryption configuration information. - FieldLevelEncryption *types.FieldLevelEncryption - // The current version of the field level encryption configuration. For example: // E2QWRUHAPOMQZL. ETag *string + // Return the field-level encryption configuration information. + FieldLevelEncryption *types.FieldLevelEncryption + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudfront/api_op_GetFieldLevelEncryptionProfile.go b/service/cloudfront/api_op_GetFieldLevelEncryptionProfile.go index f301d2f0e9c..43b43092a6a 100644 --- a/service/cloudfront/api_op_GetFieldLevelEncryptionProfile.go +++ b/service/cloudfront/api_op_GetFieldLevelEncryptionProfile.go @@ -65,13 +65,13 @@ type GetFieldLevelEncryptionProfileInput struct { type GetFieldLevelEncryptionProfileOutput struct { - // Return the field-level encryption profile information. - FieldLevelEncryptionProfile *types.FieldLevelEncryptionProfile - // The current version of the field level encryption profile. For example: // E2QWRUHAPOMQZL. ETag *string + // Return the field-level encryption profile information. + FieldLevelEncryptionProfile *types.FieldLevelEncryptionProfile + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudfront/api_op_GetFieldLevelEncryptionProfileConfig.go b/service/cloudfront/api_op_GetFieldLevelEncryptionProfileConfig.go index 70b4df5e257..9a67110c6cc 100644 --- a/service/cloudfront/api_op_GetFieldLevelEncryptionProfileConfig.go +++ b/service/cloudfront/api_op_GetFieldLevelEncryptionProfileConfig.go @@ -65,13 +65,13 @@ type GetFieldLevelEncryptionProfileConfigInput struct { type GetFieldLevelEncryptionProfileConfigOutput struct { - // Return the field-level encryption profile configuration information. - FieldLevelEncryptionProfileConfig *types.FieldLevelEncryptionProfileConfig - // The current version of the field-level encryption profile configuration result. // For example: E2QWRUHAPOMQZL. ETag *string + // Return the field-level encryption profile configuration information. + FieldLevelEncryptionProfileConfig *types.FieldLevelEncryptionProfileConfig + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudfront/api_op_GetInvalidation.go b/service/cloudfront/api_op_GetInvalidation.go index bd129120408..131b20a1460 100644 --- a/service/cloudfront/api_op_GetInvalidation.go +++ b/service/cloudfront/api_op_GetInvalidation.go @@ -58,15 +58,15 @@ func (c *Client) GetInvalidation(ctx context.Context, params *GetInvalidationInp // The request to get an invalidation's information. type GetInvalidationInput struct { - // The identifier for the invalidation request, for example, IDFDVBD632BHDS5. + // The distribution's ID. // // This member is required. - Id *string + DistributionId *string - // The distribution's ID. + // The identifier for the invalidation request, for example, IDFDVBD632BHDS5. // // This member is required. - DistributionId *string + Id *string } // The returned result of the corresponding request. diff --git a/service/cloudfront/api_op_GetOriginRequestPolicy.go b/service/cloudfront/api_op_GetOriginRequestPolicy.go index 5b7e885b43f..a2f661ac3f9 100644 --- a/service/cloudfront/api_op_GetOriginRequestPolicy.go +++ b/service/cloudfront/api_op_GetOriginRequestPolicy.go @@ -81,12 +81,12 @@ type GetOriginRequestPolicyInput struct { type GetOriginRequestPolicyOutput struct { - // The origin request policy. - OriginRequestPolicy *types.OriginRequestPolicy - // The current version of the origin request policy. ETag *string + // The origin request policy. + OriginRequestPolicy *types.OriginRequestPolicy + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudfront/api_op_GetOriginRequestPolicyConfig.go b/service/cloudfront/api_op_GetOriginRequestPolicyConfig.go index b08a507ae50..d56f01815db 100644 --- a/service/cloudfront/api_op_GetOriginRequestPolicyConfig.go +++ b/service/cloudfront/api_op_GetOriginRequestPolicyConfig.go @@ -74,12 +74,12 @@ type GetOriginRequestPolicyConfigInput struct { type GetOriginRequestPolicyConfigOutput struct { - // The origin request policy configuration. - OriginRequestPolicyConfig *types.OriginRequestPolicyConfig - // The current version of the origin request policy. ETag *string + // The origin request policy configuration. + OriginRequestPolicyConfig *types.OriginRequestPolicyConfig + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudfront/api_op_GetPublicKey.go b/service/cloudfront/api_op_GetPublicKey.go index 6ba7756ca65..ecbea364ade 100644 --- a/service/cloudfront/api_op_GetPublicKey.go +++ b/service/cloudfront/api_op_GetPublicKey.go @@ -65,12 +65,12 @@ type GetPublicKeyInput struct { type GetPublicKeyOutput struct { - // Return the public key. - PublicKey *types.PublicKey - // The current version of the public key. For example: E2QWRUHAPOMQZL. ETag *string + // Return the public key. + PublicKey *types.PublicKey + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudfront/api_op_GetStreamingDistribution.go b/service/cloudfront/api_op_GetStreamingDistribution.go index ad1e99f8067..07b819fd234 100644 --- a/service/cloudfront/api_op_GetStreamingDistribution.go +++ b/service/cloudfront/api_op_GetStreamingDistribution.go @@ -68,13 +68,13 @@ type GetStreamingDistributionInput struct { // The returned result of the corresponding request. type GetStreamingDistributionOutput struct { - // The streaming distribution's information. - StreamingDistribution *types.StreamingDistribution - // The current version of the streaming distribution's information. For example: // E2QWRUHAPOMQZL. ETag *string + // The streaming distribution's information. + StreamingDistribution *types.StreamingDistribution + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudfront/api_op_GetStreamingDistributionConfig.go b/service/cloudfront/api_op_GetStreamingDistributionConfig.go index fcd5b58c87d..a30d5d04e70 100644 --- a/service/cloudfront/api_op_GetStreamingDistributionConfig.go +++ b/service/cloudfront/api_op_GetStreamingDistributionConfig.go @@ -67,12 +67,12 @@ type GetStreamingDistributionConfigInput struct { // The returned result of the corresponding request. type GetStreamingDistributionConfigOutput struct { - // The streaming distribution's configuration information. - StreamingDistributionConfig *types.StreamingDistributionConfig - // The current version of the configuration. For example: E2QWRUHAPOMQZL. ETag *string + // The streaming distribution's configuration information. + StreamingDistributionConfig *types.StreamingDistributionConfig + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudfront/api_op_ListCloudFrontOriginAccessIdentities.go b/service/cloudfront/api_op_ListCloudFrontOriginAccessIdentities.go index ee90b030034..ff42e152258 100644 --- a/service/cloudfront/api_op_ListCloudFrontOriginAccessIdentities.go +++ b/service/cloudfront/api_op_ListCloudFrontOriginAccessIdentities.go @@ -57,15 +57,15 @@ func (c *Client) ListCloudFrontOriginAccessIdentities(ctx context.Context, param // The request to list origin access identities. type ListCloudFrontOriginAccessIdentitiesInput struct { - // The maximum number of origin access identities you want in the response body. - MaxItems *string - // Use this when paginating results to indicate where to begin in your list of // origin access identities. The results include identities in the list that occur // after the marker. To get the next page of results, set the Marker to the value // of the NextMarker from the current page's response (which is also the ID of the // last identity on that page). Marker *string + + // The maximum number of origin access identities you want in the response body. + MaxItems *string } // The returned result of the corresponding request. diff --git a/service/cloudfront/api_op_ListDistributions.go b/service/cloudfront/api_op_ListDistributions.go index 44d7b9e2a68..cc3bd6ecf35 100644 --- a/service/cloudfront/api_op_ListDistributions.go +++ b/service/cloudfront/api_op_ListDistributions.go @@ -57,15 +57,15 @@ func (c *Client) ListDistributions(ctx context.Context, params *ListDistribution // The request to list your distributions. type ListDistributionsInput struct { - // The maximum number of distributions you want in the response body. - MaxItems *string - // Use this when paginating results to indicate where to begin in your list of // distributions. The results include distributions in the list that occur after // the marker. To get the next page of results, set the Marker to the value of the // NextMarker from the current page's response (which is also the ID of the last // distribution on that page). Marker *string + + // The maximum number of distributions you want in the response body. + MaxItems *string } // The returned result of the corresponding request. diff --git a/service/cloudfront/api_op_ListDistributionsByCachePolicyId.go b/service/cloudfront/api_op_ListDistributionsByCachePolicyId.go index 50252eac400..14aad33617d 100644 --- a/service/cloudfront/api_op_ListDistributionsByCachePolicyId.go +++ b/service/cloudfront/api_op_ListDistributionsByCachePolicyId.go @@ -63,6 +63,11 @@ func (c *Client) ListDistributionsByCachePolicyId(ctx context.Context, params *L type ListDistributionsByCachePolicyIdInput struct { + // The ID of the cache policy whose associated distribution IDs you want to list. + // + // This member is required. + CachePolicyId *string + // Use this field when paginating results to indicate where to begin in your list // of distribution IDs. The response includes distribution IDs in the list that // occur after the marker. To get the next page of the list, set this field’s value @@ -71,11 +76,6 @@ type ListDistributionsByCachePolicyIdInput struct { // The maximum number of distribution IDs that you want in the response. MaxItems *string - - // The ID of the cache policy whose associated distribution IDs you want to list. - // - // This member is required. - CachePolicyId *string } type ListDistributionsByCachePolicyIdOutput struct { diff --git a/service/cloudfront/api_op_ListDistributionsByOriginRequestPolicyId.go b/service/cloudfront/api_op_ListDistributionsByOriginRequestPolicyId.go index 111993220ba..bc721446465 100644 --- a/service/cloudfront/api_op_ListDistributionsByOriginRequestPolicyId.go +++ b/service/cloudfront/api_op_ListDistributionsByOriginRequestPolicyId.go @@ -63,18 +63,18 @@ func (c *Client) ListDistributionsByOriginRequestPolicyId(ctx context.Context, p type ListDistributionsByOriginRequestPolicyIdInput struct { - // Use this field when paginating results to indicate where to begin in your list - // of distribution IDs. The response includes distribution IDs in the list that - // occur after the marker. To get the next page of the list, set this field’s value - // to the value of NextMarker from the current page’s response. - Marker *string - // The ID of the origin request policy whose associated distribution IDs you want // to list. // // This member is required. OriginRequestPolicyId *string + // Use this field when paginating results to indicate where to begin in your list + // of distribution IDs. The response includes distribution IDs in the list that + // occur after the marker. To get the next page of the list, set this field’s value + // to the value of NextMarker from the current page’s response. + Marker *string + // The maximum number of distribution IDs that you want in the response. MaxItems *string } diff --git a/service/cloudfront/api_op_ListDistributionsByWebACLId.go b/service/cloudfront/api_op_ListDistributionsByWebACLId.go index 30c849cb052..45b2dfedbc0 100644 --- a/service/cloudfront/api_op_ListDistributionsByWebACLId.go +++ b/service/cloudfront/api_op_ListDistributionsByWebACLId.go @@ -59,13 +59,6 @@ func (c *Client) ListDistributionsByWebACLId(ctx context.Context, params *ListDi // web ACL. type ListDistributionsByWebACLIdInput struct { - // Use Marker and MaxItems to control pagination of results. If you have more than - // MaxItems distributions that satisfy the request, the response includes a - // NextMarker element. To get the next page of results, submit another request. For - // the value of Marker, specify the value of NextMarker from the last response. - // (For the first request, omit Marker.) - Marker *string - // The ID of the AWS WAF web ACL that you want to list the associated // distributions. If you specify "null" for the ID, the request returns a list of // the distributions that aren't associated with a web ACL. @@ -73,6 +66,13 @@ type ListDistributionsByWebACLIdInput struct { // This member is required. WebACLId *string + // Use Marker and MaxItems to control pagination of results. If you have more than + // MaxItems distributions that satisfy the request, the response includes a + // NextMarker element. To get the next page of results, submit another request. For + // the value of Marker, specify the value of NextMarker from the last response. + // (For the first request, omit Marker.) + Marker *string + // The maximum number of distributions that you want CloudFront to return in the // response body. The maximum and default values are both 100. MaxItems *string diff --git a/service/cloudfront/api_op_ListInvalidations.go b/service/cloudfront/api_op_ListInvalidations.go index 2b387eb0d79..e09b7370490 100644 --- a/service/cloudfront/api_op_ListInvalidations.go +++ b/service/cloudfront/api_op_ListInvalidations.go @@ -58,8 +58,10 @@ func (c *Client) ListInvalidations(ctx context.Context, params *ListInvalidation // The request to list invalidations. type ListInvalidationsInput struct { - // The maximum number of invalidation batches that you want in the response body. - MaxItems *string + // The distribution's ID. + // + // This member is required. + DistributionId *string // Use this parameter when paginating results to indicate where to begin in your // list of invalidation batches. Because the results are returned in decreasing @@ -70,10 +72,8 @@ type ListInvalidationsInput struct { // that page. Marker *string - // The distribution's ID. - // - // This member is required. - DistributionId *string + // The maximum number of invalidation batches that you want in the response body. + MaxItems *string } // The returned result of the corresponding request. diff --git a/service/cloudfront/api_op_ListOriginRequestPolicies.go b/service/cloudfront/api_op_ListOriginRequestPolicies.go index 36d0c53fffe..9f4f0c9cda9 100644 --- a/service/cloudfront/api_op_ListOriginRequestPolicies.go +++ b/service/cloudfront/api_op_ListOriginRequestPolicies.go @@ -63,6 +63,12 @@ func (c *Client) ListOriginRequestPolicies(ctx context.Context, params *ListOrig type ListOriginRequestPoliciesInput struct { + // Use this field when paginating results to indicate where to begin in your list + // of origin request policies. The response includes origin request policies in the + // list that occur after the marker. To get the next page of the list, set this + // field’s value to the value of NextMarker from the current page’s response. + Marker *string + // The maximum number of origin request policies that you want in the response. MaxItems *string @@ -74,12 +80,6 @@ type ListOriginRequestPoliciesInput struct { // // * custom – Returns only the custom policies created in your AWS account. Type types.OriginRequestPolicyType - - // Use this field when paginating results to indicate where to begin in your list - // of origin request policies. The response includes origin request policies in the - // list that occur after the marker. To get the next page of the list, set this - // field’s value to the value of NextMarker from the current page’s response. - Marker *string } type ListOriginRequestPoliciesOutput struct { diff --git a/service/cloudfront/api_op_ListPublicKeys.go b/service/cloudfront/api_op_ListPublicKeys.go index 95c7861e0b2..fad287c2369 100644 --- a/service/cloudfront/api_op_ListPublicKeys.go +++ b/service/cloudfront/api_op_ListPublicKeys.go @@ -56,15 +56,15 @@ func (c *Client) ListPublicKeys(ctx context.Context, params *ListPublicKeysInput type ListPublicKeysInput struct { - // The maximum number of public keys you want in the response body. - MaxItems *string - // Use this when paginating results to indicate where to begin in your list of // public keys. The results include public keys in the list that occur after the // marker. To get the next page of results, set the Marker to the value of the // NextMarker from the current page's response (which is also the ID of the last // public key on that page). Marker *string + + // The maximum number of public keys you want in the response body. + MaxItems *string } type ListPublicKeysOutput struct { diff --git a/service/cloudfront/api_op_ListStreamingDistributions.go b/service/cloudfront/api_op_ListStreamingDistributions.go index b854b0c650d..f1d60436dd1 100644 --- a/service/cloudfront/api_op_ListStreamingDistributions.go +++ b/service/cloudfront/api_op_ListStreamingDistributions.go @@ -57,11 +57,11 @@ func (c *Client) ListStreamingDistributions(ctx context.Context, params *ListStr // The request to list your streaming distributions. type ListStreamingDistributionsInput struct { - // The value that you provided for the MaxItems request parameter. - MaxItems *string - // The value that you provided for the Marker request parameter. Marker *string + + // The value that you provided for the MaxItems request parameter. + MaxItems *string } // The returned result of the corresponding request. diff --git a/service/cloudfront/api_op_UpdateCachePolicy.go b/service/cloudfront/api_op_UpdateCachePolicy.go index 3ae9ac98850..01f22209a12 100644 --- a/service/cloudfront/api_op_UpdateCachePolicy.go +++ b/service/cloudfront/api_op_UpdateCachePolicy.go @@ -70,9 +70,10 @@ func (c *Client) UpdateCachePolicy(ctx context.Context, params *UpdateCachePolic type UpdateCachePolicyInput struct { - // The version of the cache policy that you are updating. The version is returned - // in the cache policy’s ETag field in the response to GetCachePolicyConfig. - IfMatch *string + // A cache policy configuration. + // + // This member is required. + CachePolicyConfig *types.CachePolicyConfig // The unique identifier for the cache policy that you are updating. The identifier // is returned in a cache behavior’s CachePolicyId field in the response to @@ -81,20 +82,19 @@ type UpdateCachePolicyInput struct { // This member is required. Id *string - // A cache policy configuration. - // - // This member is required. - CachePolicyConfig *types.CachePolicyConfig + // The version of the cache policy that you are updating. The version is returned + // in the cache policy’s ETag field in the response to GetCachePolicyConfig. + IfMatch *string } type UpdateCachePolicyOutput struct { - // The current version of the cache policy. - ETag *string - // A cache policy. CachePolicy *types.CachePolicy + // The current version of the cache policy. + ETag *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudfront/api_op_UpdateCloudFrontOriginAccessIdentity.go b/service/cloudfront/api_op_UpdateCloudFrontOriginAccessIdentity.go index 4f4ec749675..f762bee3e3f 100644 --- a/service/cloudfront/api_op_UpdateCloudFrontOriginAccessIdentity.go +++ b/service/cloudfront/api_op_UpdateCloudFrontOriginAccessIdentity.go @@ -58,19 +58,19 @@ func (c *Client) UpdateCloudFrontOriginAccessIdentity(ctx context.Context, param // The request to update an origin access identity. type UpdateCloudFrontOriginAccessIdentityInput struct { - // The value of the ETag header that you received when retrieving the identity's - // configuration. For example: E2QWRUHAPOMQZL. - IfMatch *string + // The identity's configuration information. + // + // This member is required. + CloudFrontOriginAccessIdentityConfig *types.CloudFrontOriginAccessIdentityConfig // The identity's id. // // This member is required. Id *string - // The identity's configuration information. - // - // This member is required. - CloudFrontOriginAccessIdentityConfig *types.CloudFrontOriginAccessIdentityConfig + // The value of the ETag header that you received when retrieving the identity's + // configuration. For example: E2QWRUHAPOMQZL. + IfMatch *string } // The returned result of the corresponding request. diff --git a/service/cloudfront/api_op_UpdateFieldLevelEncryptionProfile.go b/service/cloudfront/api_op_UpdateFieldLevelEncryptionProfile.go index 14148ce697e..e6fe1306d62 100644 --- a/service/cloudfront/api_op_UpdateFieldLevelEncryptionProfile.go +++ b/service/cloudfront/api_op_UpdateFieldLevelEncryptionProfile.go @@ -57,10 +57,6 @@ func (c *Client) UpdateFieldLevelEncryptionProfile(ctx context.Context, params * type UpdateFieldLevelEncryptionProfileInput struct { - // The value of the ETag header that you received when retrieving the profile - // identity to update. For example: E2QWRUHAPOMQZL. - IfMatch *string - // Request to update a field-level encryption profile. // // This member is required. @@ -70,6 +66,10 @@ type UpdateFieldLevelEncryptionProfileInput struct { // // This member is required. Id *string + + // The value of the ETag header that you received when retrieving the profile + // identity to update. For example: E2QWRUHAPOMQZL. + IfMatch *string } type UpdateFieldLevelEncryptionProfileOutput struct { diff --git a/service/cloudfront/api_op_UpdateOriginRequestPolicy.go b/service/cloudfront/api_op_UpdateOriginRequestPolicy.go index 679ac56ace6..da74ef6722d 100644 --- a/service/cloudfront/api_op_UpdateOriginRequestPolicy.go +++ b/service/cloudfront/api_op_UpdateOriginRequestPolicy.go @@ -71,6 +71,13 @@ func (c *Client) UpdateOriginRequestPolicy(ctx context.Context, params *UpdateOr type UpdateOriginRequestPolicyInput struct { + // The unique identifier for the origin request policy that you are updating. The + // identifier is returned in a cache behavior’s OriginRequestPolicyId field in the + // response to GetDistributionConfig. + // + // This member is required. + Id *string + // An origin request policy configuration. // // This member is required. @@ -80,13 +87,6 @@ type UpdateOriginRequestPolicyInput struct { // returned in the origin request policy’s ETag field in the response to // GetOriginRequestPolicyConfig. IfMatch *string - - // The unique identifier for the origin request policy that you are updating. The - // identifier is returned in a cache behavior’s OriginRequestPolicyId field in the - // response to GetDistributionConfig. - // - // This member is required. - Id *string } type UpdateOriginRequestPolicyOutput struct { diff --git a/service/cloudfront/api_op_UpdatePublicKey.go b/service/cloudfront/api_op_UpdatePublicKey.go index e6c60baa9cd..fa3913d19b7 100644 --- a/service/cloudfront/api_op_UpdatePublicKey.go +++ b/service/cloudfront/api_op_UpdatePublicKey.go @@ -58,15 +58,15 @@ func (c *Client) UpdatePublicKey(ctx context.Context, params *UpdatePublicKeyInp type UpdatePublicKeyInput struct { - // Request to update public key information. + // ID of the public key to be updated. // // This member is required. - PublicKeyConfig *types.PublicKeyConfig + Id *string - // ID of the public key to be updated. + // Request to update public key information. // // This member is required. - Id *string + PublicKeyConfig *types.PublicKeyConfig // The value of the ETag header that you received when retrieving the public key to // update. For example: E2QWRUHAPOMQZL. diff --git a/service/cloudfront/api_op_UpdateStreamingDistribution.go b/service/cloudfront/api_op_UpdateStreamingDistribution.go index 21332d6956d..9306447836f 100644 --- a/service/cloudfront/api_op_UpdateStreamingDistribution.go +++ b/service/cloudfront/api_op_UpdateStreamingDistribution.go @@ -58,30 +58,30 @@ func (c *Client) UpdateStreamingDistribution(ctx context.Context, params *Update // The request to update a streaming distribution. type UpdateStreamingDistributionInput struct { - // The value of the ETag header that you received when retrieving the streaming - // distribution's configuration. For example: E2QWRUHAPOMQZL. - IfMatch *string + // The streaming distribution's id. + // + // This member is required. + Id *string // The streaming distribution's configuration information. // // This member is required. StreamingDistributionConfig *types.StreamingDistributionConfig - // The streaming distribution's id. - // - // This member is required. - Id *string + // The value of the ETag header that you received when retrieving the streaming + // distribution's configuration. For example: E2QWRUHAPOMQZL. + IfMatch *string } // The returned result of the corresponding request. type UpdateStreamingDistributionOutput struct { - // The streaming distribution's information. - StreamingDistribution *types.StreamingDistribution - // The current version of the configuration. For example: E2QWRUHAPOMQZL. ETag *string + // The streaming distribution's information. + StreamingDistribution *types.StreamingDistribution + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudfront/go.mod b/service/cloudfront/go.mod index c1566f31787..25f13674016 100644 --- a/service/cloudfront/go.mod +++ b/service/cloudfront/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/cloudfront go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/cloudfront/types/types.go b/service/cloudfront/types/types.go index e585574e6ae..adeebe439a1 100644 --- a/service/cloudfront/types/types.go +++ b/service/cloudfront/types/types.go @@ -26,14 +26,14 @@ type ActiveTrustedSigners struct { // This member is required. Enabled *bool - // A complex type that contains one Signer complex type for each trusted signer - // that is specified in the TrustedSigners complex type. - Items []*Signer - // The number of trusted signers specified in the TrustedSigners complex type. // // This member is required. Quantity *int32 + + // A complex type that contains one Signer complex type for each trusted signer + // that is specified in the TrustedSigners complex type. + Items []*Signer } // A complex type that contains information about CNAMEs (alternate domain names), @@ -61,6 +61,9 @@ type Aliases struct { // in Getting Started with AWS services in China. type AliasICPRecordal struct { + // A domain name associated with a distribution. + CNAME *string + // The Internet Content Provider (ICP) recordal status for a CNAME. The // ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside // of China. The status values returned are the following: @@ -81,9 +84,6 @@ type AliasICPRecordal struct { // error is resolved in which case CloudFront returns an APPROVED or SUSPENDED // status. ICPRecordalStatus ICPRecordalStatus - - // A domain name associated with a distribution. - CNAME *string } // A complex type that controls which HTTP methods CloudFront processes and @@ -105,6 +105,12 @@ type AliasICPRecordal struct { // from your origin. type AllowedMethods struct { + // A complex type that contains the HTTP methods that you want CloudFront to + // process and forward to your origin. + // + // This member is required. + Items []Method + // The number of HTTP methods that you want CloudFront to forward to your origin. // Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD, and OPTIONS // requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests). @@ -126,12 +132,6 @@ type AllowedMethods struct { // Access-Control-Request-Headers, and Origin headers for the responses to be // cached correctly. CachedMethods *CachedMethods - - // A complex type that contains the HTTP methods that you want CloudFront to - // process and forward to your origin. - // - // This member is required. - Items []Method } // A complex type that describes how CloudFront processes requests. You must create @@ -156,77 +156,43 @@ type AllowedMethods struct { // in the Amazon CloudFront Developer Guide. type CacheBehavior struct { - // This field is deprecated. We recommend that you use the DefaultTTL field in a - // cache policy instead of this field. For more information, see Creating cache - // policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) - // or Using the managed cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) - // in the Amazon CloudFront Developer Guide. The default amount of time that you - // want objects to stay in CloudFront caches before CloudFront forwards another - // request to your origin to determine whether the object has been updated. The - // value that you specify applies only when your origin does not add HTTP headers - // such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. - // For more information, see Managing How Long Content Stays in an Edge Cache - // (Expiration) - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) - // in the Amazon CloudFront Developer Guide. - DefaultTTL *int64 - - // The unique identifier of the origin request policy that is attached to this - // cache behavior. For more information, see Creating origin request policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) - // or Using the managed origin request policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) + // The pattern (for example, images/*.jpg) that specifies which requests to apply + // the behavior to. When CloudFront receives a viewer request, the requested path + // is compared with path patterns in the order in which cache behaviors are listed + // in the distribution. You can optionally include a slash (/) at the beginning of + // the path pattern. For example, /images/*.jpg. CloudFront behavior is the same + // with or without the leading /. The path pattern for the default cache behavior + // is * and cannot be changed. If the request for an object does not match the path + // pattern for any cache behaviors, CloudFront applies the behavior in the default + // cache behavior. For more information, see Path Pattern + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesPathPattern) // in the Amazon CloudFront Developer Guide. - OriginRequestPolicyId *string - - // This field is deprecated. We recommend that you use a cache policy or an origin - // request policy instead of this field. For more information, see Working with - // policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) - // in the Amazon CloudFront Developer Guide. If you want to include values in the - // cache key, use a cache policy. For more information, see Creating cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) - // or Using the managed cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) - // in the Amazon CloudFront Developer Guide. If you want to send values to the - // origin but not include them in the cache key, use an origin request policy. For - // more information, see Creating origin request policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) - // or Using the managed origin request policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) - // in the Amazon CloudFront Developer Guide. A complex type that specifies how - // CloudFront handles query strings, cookies, and HTTP headers. - ForwardedValues *ForwardedValues - - // The value of ID for the field-level encryption configuration that you want - // CloudFront to use for encrypting specific fields of data for this cache - // behavior. - FieldLevelEncryptionId *string + // + // This member is required. + PathPattern *string - // Indicates whether you want to distribute media files in the Microsoft Smooth - // Streaming format using the origin that is associated with this cache behavior. - // If so, specify true; if not, specify false. If you specify true for - // SmoothStreaming, you can still distribute other content using this cache - // behavior if the content matches the value of PathPattern. - SmoothStreaming *bool + // The value of ID for the origin that you want CloudFront to route requests to + // when they match this cache behavior. + // + // This member is required. + TargetOriginId *string - // This field is deprecated. We recommend that you use the MinTTL field in a cache - // policy instead of this field. For more information, see Creating cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) - // or Using the managed cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) - // in the Amazon CloudFront Developer Guide. The minimum amount of time that you - // want objects to stay in CloudFront caches before CloudFront forwards another - // request to your origin to determine whether the object has been updated. For - // more information, see Managing How Long Content Stays in an Edge Cache - // (Expiration) - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) - // in the Amazon CloudFront Developer Guide. You must specify 0 for MinTTL if you - // configure CloudFront to forward all headers to your origin (under Headers, if - // you specify 1 for Quantity and * for Name). - MinTTL *int64 + // A complex type that specifies the AWS accounts, if any, that you want to allow + // to create signed URLs for private content. If you want to require signed URLs in + // requests for objects in the target origin that match the PathPattern for this + // cache behavior, specify true for Enabled, and specify the applicable values for + // Quantity and Items. For more information, see Serving Private Content with + // Signed URLs and Signed Cookies + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) + // in the Amazon CloudFront Developer Guide. If you don’t want to require signed + // URLs in requests for objects that match PathPattern, specify false for Enabled + // and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted + // signers, change Enabled to true (if it’s currently false), change Quantity as + // applicable, and specify all of the trusted signers that you want to include in + // the updated distribution. + // + // This member is required. + TrustedSigners *TrustedSigners // The protocol that viewers can use to access the files in the origin specified by // TargetOriginId when a request matches the path pattern in PathPattern. You can @@ -259,38 +225,6 @@ type CacheBehavior struct { // This member is required. ViewerProtocolPolicy ViewerProtocolPolicy - // This field is deprecated. We recommend that you use the MaxTTL field in a cache - // policy instead of this field. For more information, see Creating cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) - // or Using the managed cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) - // in the Amazon CloudFront Developer Guide. The maximum amount of time that you - // want objects to stay in CloudFront caches before CloudFront forwards another - // request to your origin to determine whether the object has been updated. The - // value that you specify applies only when your origin adds HTTP headers such as - // Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more - // information, see Managing How Long Content Stays in an Edge Cache (Expiration) - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) - // in the Amazon CloudFront Developer Guide. - MaxTTL *int64 - - // A complex type that specifies the AWS accounts, if any, that you want to allow - // to create signed URLs for private content. If you want to require signed URLs in - // requests for objects in the target origin that match the PathPattern for this - // cache behavior, specify true for Enabled, and specify the applicable values for - // Quantity and Items. For more information, see Serving Private Content with - // Signed URLs and Signed Cookies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) - // in the Amazon CloudFront Developer Guide. If you don’t want to require signed - // URLs in requests for objects that match PathPattern, specify false for Enabled - // and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted - // signers, change Enabled to true (if it’s currently false), change Quantity as - // applicable, and specify all of the trusted signers that you want to include in - // the updated distribution. - // - // This member is required. - TrustedSigners *TrustedSigners - // A complex type that controls which HTTP methods CloudFront processes and // forwards to your Amazon S3 bucket or your custom origin. There are three // choices: @@ -310,11 +244,13 @@ type CacheBehavior struct { // from your origin. AllowedMethods *AllowedMethods - // The value of ID for the origin that you want CloudFront to route requests to - // when they match this cache behavior. - // - // This member is required. - TargetOriginId *string + // The unique identifier of the cache policy that is attached to this cache + // behavior. For more information, see Creating cache policies + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) + // or Using the managed cache policies + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) + // in the Amazon CloudFront Developer Guide. + CachePolicyId *string // Whether you want CloudFront to automatically compress certain files for this // cache behavior. If so, specify true; if not, specify false. For more @@ -323,52 +259,116 @@ type CacheBehavior struct { // in the Amazon CloudFront Developer Guide. Compress *bool - // The unique identifier of the cache policy that is attached to this cache - // behavior. For more information, see Creating cache policies + // This field is deprecated. We recommend that you use the DefaultTTL field in a + // cache policy instead of this field. For more information, see Creating cache + // policies // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) // or Using the managed cache policies // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) + // in the Amazon CloudFront Developer Guide. The default amount of time that you + // want objects to stay in CloudFront caches before CloudFront forwards another + // request to your origin to determine whether the object has been updated. The + // value that you specify applies only when your origin does not add HTTP headers + // such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. + // For more information, see Managing How Long Content Stays in an Edge Cache + // (Expiration) + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) // in the Amazon CloudFront Developer Guide. - CachePolicyId *string + DefaultTTL *int64 - // The pattern (for example, images/*.jpg) that specifies which requests to apply - // the behavior to. When CloudFront receives a viewer request, the requested path - // is compared with path patterns in the order in which cache behaviors are listed - // in the distribution. You can optionally include a slash (/) at the beginning of - // the path pattern. For example, /images/*.jpg. CloudFront behavior is the same - // with or without the leading /. The path pattern for the default cache behavior - // is * and cannot be changed. If the request for an object does not match the path - // pattern for any cache behaviors, CloudFront applies the behavior in the default - // cache behavior. For more information, see Path Pattern - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesPathPattern) - // in the Amazon CloudFront Developer Guide. - // - // This member is required. - PathPattern *string + // The value of ID for the field-level encryption configuration that you want + // CloudFront to use for encrypting specific fields of data for this cache + // behavior. + FieldLevelEncryptionId *string + + // This field is deprecated. We recommend that you use a cache policy or an origin + // request policy instead of this field. For more information, see Working with + // policies + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) + // in the Amazon CloudFront Developer Guide. If you want to include values in the + // cache key, use a cache policy. For more information, see Creating cache policies + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) + // or Using the managed cache policies + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) + // in the Amazon CloudFront Developer Guide. If you want to send values to the + // origin but not include them in the cache key, use an origin request policy. For + // more information, see Creating origin request policies + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) + // or Using the managed origin request policies + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) + // in the Amazon CloudFront Developer Guide. A complex type that specifies how + // CloudFront handles query strings, cookies, and HTTP headers. + ForwardedValues *ForwardedValues // A complex type that contains zero or more Lambda function associations for a // cache behavior. LambdaFunctionAssociations *LambdaFunctionAssociations -} - -// A complex type that contains zero or more CacheBehavior elements. -type CacheBehaviors struct { - - // Optional: A complex type that contains cache behaviors for this distribution. If - // Quantity is 0, you can omit Items. - Items []*CacheBehavior - // The number of cache behaviors for this distribution. - // - // This member is required. - Quantity *int32 -} + // This field is deprecated. We recommend that you use the MaxTTL field in a cache + // policy instead of this field. For more information, see Creating cache policies + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) + // or Using the managed cache policies + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) + // in the Amazon CloudFront Developer Guide. The maximum amount of time that you + // want objects to stay in CloudFront caches before CloudFront forwards another + // request to your origin to determine whether the object has been updated. The + // value that you specify applies only when your origin adds HTTP headers such as + // Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more + // information, see Managing How Long Content Stays in an Edge Cache (Expiration) + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) + // in the Amazon CloudFront Developer Guide. + MaxTTL *int64 -// A complex type that controls whether CloudFront caches the response to requests -// using the specified HTTP methods. There are two choices: -// -// * CloudFront -// caches responses to GET and HEAD requests. + // This field is deprecated. We recommend that you use the MinTTL field in a cache + // policy instead of this field. For more information, see Creating cache policies + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) + // or Using the managed cache policies + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) + // in the Amazon CloudFront Developer Guide. The minimum amount of time that you + // want objects to stay in CloudFront caches before CloudFront forwards another + // request to your origin to determine whether the object has been updated. For + // more information, see Managing How Long Content Stays in an Edge Cache + // (Expiration) + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) + // in the Amazon CloudFront Developer Guide. You must specify 0 for MinTTL if you + // configure CloudFront to forward all headers to your origin (under Headers, if + // you specify 1 for Quantity and * for Name). + MinTTL *int64 + + // The unique identifier of the origin request policy that is attached to this + // cache behavior. For more information, see Creating origin request policies + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) + // or Using the managed origin request policies + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) + // in the Amazon CloudFront Developer Guide. + OriginRequestPolicyId *string + + // Indicates whether you want to distribute media files in the Microsoft Smooth + // Streaming format using the origin that is associated with this cache behavior. + // If so, specify true; if not, specify false. If you specify true for + // SmoothStreaming, you can still distribute other content using this cache + // behavior if the content matches the value of PathPattern. + SmoothStreaming *bool +} + +// A complex type that contains zero or more CacheBehavior elements. +type CacheBehaviors struct { + + // The number of cache behaviors for this distribution. + // + // This member is required. + Quantity *int32 + + // Optional: A complex type that contains cache behaviors for this distribution. If + // Quantity is 0, you can omit Items. + Items []*CacheBehavior +} + +// A complex type that controls whether CloudFront caches the response to requests +// using the specified HTTP methods. There are two choices: +// +// * CloudFront +// caches responses to GET and HEAD requests. // // * CloudFront caches responses to // GET, HEAD, and OPTIONS requests. @@ -379,18 +379,18 @@ type CacheBehaviors struct { // cached correctly. type CachedMethods struct { + // A complex type that contains the HTTP methods that you want CloudFront to cache + // responses to. + // + // This member is required. + Items []Method + // The number of HTTP methods for which you want CloudFront to cache responses. // Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for // caching responses to GET, HEAD, and OPTIONS requests). // // This member is required. Quantity *int32 - - // A complex type that contains the HTTP methods that you want CloudFront to cache - // responses to. - // - // This member is required. - Items []Method } // A cache policy. When it’s attached to a cache behavior, the cache policy @@ -412,20 +412,20 @@ type CachedMethods struct { // not include them in the cache key, use OriginRequestPolicy. type CachePolicy struct { - // The date and time when the cache policy was last modified. + // The cache policy configuration. // // This member is required. - LastModifiedTime *time.Time + CachePolicyConfig *CachePolicyConfig // The unique identifier for the cache policy. // // This member is required. Id *string - // The cache policy configuration. + // The date and time when the cache policy was last modified. // // This member is required. - CachePolicyConfig *CachePolicyConfig + LastModifiedTime *time.Time } // A cache policy configuration. This configuration determines the following: @@ -457,30 +457,13 @@ type CachePolicyConfig struct { // This member is required. MinTTL *int64 - // The maximum amount of time, in seconds, that objects stay in the CloudFront - // cache before CloudFront sends another request to the origin to see if the object - // has been updated. CloudFront uses this value only when the origin sends - // Cache-Control or Expires headers with the object. For more information, see - // Managing How Long Content Stays in an Edge Cache (Expiration) - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) - // in the Amazon CloudFront Developer Guide. The default value for this field is - // 31536000 seconds (one year). If the value of MinTTL or DefaultTTL is more than - // 31536000 seconds, then the default value for this field is the same as the value - // of DefaultTTL. - MaxTTL *int64 - - // A comment to describe the cache policy. - Comment *string - // A unique name to identify the cache policy. // // This member is required. Name *string - // The HTTP headers, cookies, and URL query strings to include in the cache key. - // The values included in the cache key are automatically included in requests that - // CloudFront sends to the origin. - ParametersInCacheKeyAndForwardedToOrigin *ParametersInCacheKeyAndForwardedToOrigin + // A comment to describe the cache policy. + Comment *string // The default amount of time, in seconds, that you want objects to stay in the // CloudFront cache before CloudFront sends another request to the origin to see if @@ -493,6 +476,23 @@ type CachePolicyConfig struct { // 86400 seconds (one day). If the value of MinTTL is more than 86400 seconds, then // the default value for this field is the same as the value of MinTTL. DefaultTTL *int64 + + // The maximum amount of time, in seconds, that objects stay in the CloudFront + // cache before CloudFront sends another request to the origin to see if the object + // has been updated. CloudFront uses this value only when the origin sends + // Cache-Control or Expires headers with the object. For more information, see + // Managing How Long Content Stays in an Edge Cache (Expiration) + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) + // in the Amazon CloudFront Developer Guide. The default value for this field is + // 31536000 seconds (one year). If the value of MinTTL or DefaultTTL is more than + // 31536000 seconds, then the default value for this field is the same as the value + // of DefaultTTL. + MaxTTL *int64 + + // The HTTP headers, cookies, and URL query strings to include in the cache key. + // The values included in the cache key are automatically included in requests that + // CloudFront sends to the origin. + ParametersInCacheKeyAndForwardedToOrigin *ParametersInCacheKeyAndForwardedToOrigin } // An object that determines whether any cookies in viewer requests (and if so, @@ -558,23 +558,23 @@ type CachePolicyHeadersConfig struct { // A list of cache policies. type CachePolicyList struct { - // If there are more items in the list than are in this response, this element is - // present. It contains the value that you should use in the Marker field of a - // subsequent request to continue listing cache policies where you left off. - NextMarker *string - - // The total number of cache policies returned in the response. + // The maximum number of cache policies requested. // // This member is required. - Quantity *int32 + MaxItems *int32 - // The maximum number of cache policies requested. + // The total number of cache policies returned in the response. // // This member is required. - MaxItems *int32 + Quantity *int32 // Contains the cache policies in the list. Items []*CachePolicySummary + + // If there are more items in the list than are in this response, this element is + // present. It contains the value that you should use in the Marker field of a + // subsequent request to continue listing cache policies where you left off. + NextMarker *string } // An object that determines whether any URL query strings in viewer requests (and @@ -582,14 +582,6 @@ type CachePolicyList struct { // included in requests that CloudFront sends to the origin. type CachePolicyQueryStringsConfig struct { - // Contains the specific query strings in viewer requests that either are or are - // not included in the cache key and automatically included in requests that - // CloudFront sends to the origin. The behavior depends on whether the - // QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to - // whitelist (the listed query strings are included) or allExcept (the listed query - // strings are not included, but all other query strings are). - QueryStrings *QueryStringNames - // Determines whether any URL query strings in viewer requests are included in the // cache key and automatically included in requests that CloudFront sends to the // origin. Valid values are: @@ -615,21 +607,29 @@ type CachePolicyQueryStringsConfig struct { // // This member is required. QueryStringBehavior CachePolicyQueryStringBehavior + + // Contains the specific query strings in viewer requests that either are or are + // not included in the cache key and automatically included in requests that + // CloudFront sends to the origin. The behavior depends on whether the + // QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to + // whitelist (the listed query strings are included) or allExcept (the listed query + // strings are not included, but all other query strings are). + QueryStrings *QueryStringNames } // Contains a cache policy. type CachePolicySummary struct { - // The type of cache policy, either managed (created by AWS) or custom (created in - // this AWS account). + // The cache policy. // // This member is required. - Type CachePolicyType + CachePolicy *CachePolicy - // The cache policy. + // The type of cache policy, either managed (created by AWS) or custom (created in + // this AWS account). // // This member is required. - CachePolicy *CachePolicy + Type CachePolicyType } // CloudFront origin access identity. @@ -640,25 +640,20 @@ type CloudFrontOriginAccessIdentity struct { // This member is required. Id *string - // The current configuration information for the identity. - CloudFrontOriginAccessIdentityConfig *CloudFrontOriginAccessIdentityConfig - // The Amazon S3 canonical user ID for the origin access identity, used when giving // the origin access identity read permission to an object in Amazon S3. // // This member is required. S3CanonicalUserId *string + + // The current configuration information for the identity. + CloudFrontOriginAccessIdentityConfig *CloudFrontOriginAccessIdentityConfig } // Origin access identity configuration. Send a GET request to the /CloudFront API // version/CloudFront/identity ID/config resource. type CloudFrontOriginAccessIdentityConfig struct { - // Any comments you want to include about the origin access identity. - // - // This member is required. - Comment *string - // A unique value (for example, a date-time stamp) that ensures that the request // can't be replayed. If the value of CallerReference is new (regardless of the // content of the CloudFrontOriginAccessIdentityConfig object), a new origin access @@ -673,6 +668,11 @@ type CloudFrontOriginAccessIdentityConfig struct { // // This member is required. CallerReference *string + + // Any comments you want to include about the origin access identity. + // + // This member is required. + Comment *string } // Lists the origin access identities for CloudFront.Send a GET request to the @@ -683,15 +683,6 @@ type CloudFrontOriginAccessIdentityConfig struct { // long, you can paginate it using the MaxItems and Marker parameters. type CloudFrontOriginAccessIdentityList struct { - // The maximum number of origin access identities you want in the response body. - // - // This member is required. - MaxItems *int32 - - // A complex type that contains one CloudFrontOriginAccessIdentitySummary element - // for each origin access identity that was created by the current AWS account. - Items []*CloudFrontOriginAccessIdentitySummary - // A flag that indicates whether more origin access identities remain to be listed. // If your results were truncated, you can make a follow-up pagination request // using the Marker request parameter to retrieve more items in the list. @@ -708,12 +699,21 @@ type CloudFrontOriginAccessIdentityList struct { // This member is required. Marker *string + // The maximum number of origin access identities you want in the response body. + // + // This member is required. + MaxItems *int32 + // The number of CloudFront origin access identities that were created by the // current AWS account. // // This member is required. Quantity *int32 + // A complex type that contains one CloudFrontOriginAccessIdentitySummary element + // for each origin access identity that was created by the current AWS account. + Items []*CloudFrontOriginAccessIdentitySummary + // If IsTruncated is true, this element is present and contains the value you can // use for the Marker request parameter to continue listing your origin access // identities where they left off. @@ -723,13 +723,6 @@ type CloudFrontOriginAccessIdentityList struct { // Summary of the information about a CloudFront origin access identity. type CloudFrontOriginAccessIdentitySummary struct { - // The Amazon S3 canonical user ID for the origin access identity, which you use - // when giving the origin access identity read permission to an object in Amazon - // S3. - // - // This member is required. - S3CanonicalUserId *string - // The comment for this origin access identity, as originally specified when // created. // @@ -740,6 +733,13 @@ type CloudFrontOriginAccessIdentitySummary struct { // // This member is required. Id *string + + // The Amazon S3 canonical user ID for the origin access identity, which you use + // when giving the origin access identity read permission to an object in Amazon + // S3. + // + // This member is required. + S3CanonicalUserId *string } // A field-level encryption content type profile. @@ -750,13 +750,13 @@ type ContentTypeProfile struct { // This member is required. ContentType *string - // The profile ID for a field-level encryption content type-profile mapping. - ProfileId *string - // The format for a field-level encryption content type-profile mapping. // // This member is required. Format Format + + // The profile ID for a field-level encryption content type-profile mapping. + ProfileId *string } // The configuration for a field-level encryption content type-profile mapping. @@ -778,13 +778,13 @@ type ContentTypeProfileConfig struct { // Field-level encryption content type-profile. type ContentTypeProfiles struct { - // Items in a field-level encryption content type-profile mapping. - Items []*ContentTypeProfile - // The number of field-level encryption content type-profile mappings. // // This member is required. Quantity *int32 + + // Items in a field-level encryption content type-profile mapping. + Items []*ContentTypeProfile } // Contains a list of cookie names. @@ -974,6 +974,18 @@ type CustomHeaders struct { // a custom origin. type CustomOriginConfig struct { + // The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP + // port that the origin listens on. + // + // This member is required. + HTTPPort *int32 + + // The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS + // port that the origin listens on. + // + // This member is required. + HTTPSPort *int32 + // Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the // origin. Valid values are: // @@ -989,18 +1001,6 @@ type CustomOriginConfig struct { // This member is required. OriginProtocolPolicy OriginProtocolPolicy - // The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP - // port that the origin listens on. - // - // This member is required. - HTTPPort *int32 - - // The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS - // port that the origin listens on. - // - // This member is required. - HTTPSPort *int32 - // Specifies how long, in seconds, CloudFront persists its connection to the // origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the // default (if you don’t specify otherwise) is 5 seconds. For more information, see @@ -1009,13 +1009,6 @@ type CustomOriginConfig struct { // in the Amazon CloudFront Developer Guide. OriginKeepaliveTimeout *int32 - // Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to - // your origin over HTTPS. Valid values include SSLv3, TLSv1, TLSv1.1, and TLSv1.2. - // For more information, see Minimum Origin SSL Protocol - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols) - // in the Amazon CloudFront Developer Guide. - OriginSslProtocols *OriginSslProtocols - // Specifies how long, in seconds, CloudFront waits for a response from the origin. // This is also known as the origin response timeout. The minimum timeout is 1 // second, the maximum is 60 seconds, and the default (if you don’t specify @@ -1023,6 +1016,13 @@ type CustomOriginConfig struct { // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout) // in the Amazon CloudFront Developer Guide. OriginReadTimeout *int32 + + // Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to + // your origin over HTTPS. Valid values include SSLv3, TLSv1, TLSv1.1, and TLSv1.2. + // For more information, see Minimum Origin SSL Protocol + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols) + // in the Amazon CloudFront Developer Guide. + OriginSslProtocols *OriginSslProtocols } // A complex type that describes the default cache behavior if you don’t specify a @@ -1031,13 +1031,11 @@ type CustomOriginConfig struct { // behavior. type DefaultCacheBehavior struct { - // The unique identifier of the cache policy that is attached to the default cache - // behavior. For more information, see Creating cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) - // or Using the managed cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) - // in the Amazon CloudFront Developer Guide. - CachePolicyId *string + // The value of ID for the origin that you want CloudFront to route requests to + // when they use the default cache behavior. + // + // This member is required. + TargetOriginId *string // A complex type that specifies the AWS accounts, if any, that you want to allow // to create signed URLs for private content. If you want to require signed URLs in @@ -1056,43 +1054,36 @@ type DefaultCacheBehavior struct { // This member is required. TrustedSigners *TrustedSigners - // This field is deprecated. We recommend that you use the MinTTL field in a cache - // policy instead of this field. For more information, see Creating cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) - // or Using the managed cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) - // in the Amazon CloudFront Developer Guide. The minimum amount of time that you - // want objects to stay in CloudFront caches before CloudFront forwards another - // request to your origin to determine whether the object has been updated. For - // more information, see Managing How Long Content Stays in an Edge Cache - // (Expiration) - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) - // in the Amazon CloudFront Developer Guide. You must specify 0 for MinTTL if you - // configure CloudFront to forward all headers to your origin (under Headers, if - // you specify 1 for Quantity and * for Name). - MinTTL *int64 - - // This field is deprecated. We recommend that you use the MaxTTL field in a cache - // policy instead of this field. For more information, see Creating cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) - // or Using the managed cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) - // in the Amazon CloudFront Developer Guide. The maximum amount of time that you - // want objects to stay in CloudFront caches before CloudFront forwards another - // request to your origin to determine whether the object has been updated. The - // value that you specify applies only when your origin adds HTTP headers such as - // Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more - // information, see Managing How Long Content Stays in an Edge Cache (Expiration) + // The protocol that viewers can use to access the files in the origin specified by + // TargetOriginId when a request matches the path pattern in PathPattern. You can + // specify the following options: + // + // * allow-all: Viewers can use HTTP or + // HTTPS. + // + // * redirect-to-https: If a viewer submits an HTTP request, CloudFront + // returns an HTTP status code of 301 (Moved Permanently) to the viewer along with + // the HTTPS URL. The viewer then resubmits the request using the new URL. + // + // * + // https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status + // code of 403 (Forbidden). + // + // For more information about requiring the HTTPS + // protocol, see Requiring HTTPS Between Viewers and CloudFront + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) + // in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers + // retrieve an object that was fetched from the origin using HTTPS is never to use + // any other protocol to fetch the object. If you have recently changed from HTTP + // to HTTPS, we recommend that you clear your objects’ cache because cached objects + // are protocol agnostic. That means that an edge location will return an object + // from the cache regardless of whether the current request protocol matches the + // protocol used previously. For more information, see Managing Cache Expiration // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) // in the Amazon CloudFront Developer Guide. - MaxTTL *int64 - - // Whether you want CloudFront to automatically compress certain files for this - // cache behavior. If so, specify true; if not, specify false. For more - // information, see Serving Compressed Files - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) - // in the Amazon CloudFront Developer Guide. - Compress *bool + // + // This member is required. + ViewerProtocolPolicy ViewerProtocolPolicy // A complex type that controls which HTTP methods CloudFront processes and // forwards to your Amazon S3 bucket or your custom origin. There are three @@ -1113,24 +1104,42 @@ type DefaultCacheBehavior struct { // from your origin. AllowedMethods *AllowedMethods - // A complex type that contains zero or more Lambda function associations for a - // cache behavior. - LambdaFunctionAssociations *LambdaFunctionAssociations + // The unique identifier of the cache policy that is attached to the default cache + // behavior. For more information, see Creating cache policies + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) + // or Using the managed cache policies + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) + // in the Amazon CloudFront Developer Guide. + CachePolicyId *string - // The unique identifier of the origin request policy that is attached to the - // default cache behavior. For more information, see Creating origin request + // Whether you want CloudFront to automatically compress certain files for this + // cache behavior. If so, specify true; if not, specify false. For more + // information, see Serving Compressed Files + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) + // in the Amazon CloudFront Developer Guide. + Compress *bool + + // This field is deprecated. We recommend that you use the DefaultTTL field in a + // cache policy instead of this field. For more information, see Creating cache // policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) - // or Using the managed origin request policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) + // or Using the managed cache policies + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) + // in the Amazon CloudFront Developer Guide. The default amount of time that you + // want objects to stay in CloudFront caches before CloudFront forwards another + // request to your origin to determine whether the object has been updated. The + // value that you specify applies only when your origin does not add HTTP headers + // such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. + // For more information, see Managing How Long Content Stays in an Edge Cache + // (Expiration) + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) // in the Amazon CloudFront Developer Guide. - OriginRequestPolicyId *string + DefaultTTL *int64 - // The value of ID for the origin that you want CloudFront to route requests to - // when they use the default cache behavior. - // - // This member is required. - TargetOriginId *string + // The value of ID for the field-level encryption configuration that you want + // CloudFront to use for encrypting specific fields of data for the default cache + // behavior. + FieldLevelEncryptionId *string // This field is deprecated. We recommend that you use a cache policy or an origin // request policy instead of this field. For more information, see Working with @@ -1151,58 +1160,49 @@ type DefaultCacheBehavior struct { // CloudFront handles query strings, cookies, and HTTP headers. ForwardedValues *ForwardedValues - // This field is deprecated. We recommend that you use the DefaultTTL field in a - // cache policy instead of this field. For more information, see Creating cache - // policies + // A complex type that contains zero or more Lambda function associations for a + // cache behavior. + LambdaFunctionAssociations *LambdaFunctionAssociations + + // This field is deprecated. We recommend that you use the MaxTTL field in a cache + // policy instead of this field. For more information, see Creating cache policies // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) // or Using the managed cache policies // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) - // in the Amazon CloudFront Developer Guide. The default amount of time that you + // in the Amazon CloudFront Developer Guide. The maximum amount of time that you // want objects to stay in CloudFront caches before CloudFront forwards another // request to your origin to determine whether the object has been updated. The - // value that you specify applies only when your origin does not add HTTP headers - // such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. - // For more information, see Managing How Long Content Stays in an Edge Cache - // (Expiration) + // value that you specify applies only when your origin adds HTTP headers such as + // Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more + // information, see Managing How Long Content Stays in an Edge Cache (Expiration) // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) // in the Amazon CloudFront Developer Guide. - DefaultTTL *int64 - - // The value of ID for the field-level encryption configuration that you want - // CloudFront to use for encrypting specific fields of data for the default cache - // behavior. - FieldLevelEncryptionId *string + MaxTTL *int64 - // The protocol that viewers can use to access the files in the origin specified by - // TargetOriginId when a request matches the path pattern in PathPattern. You can - // specify the following options: - // - // * allow-all: Viewers can use HTTP or - // HTTPS. - // - // * redirect-to-https: If a viewer submits an HTTP request, CloudFront - // returns an HTTP status code of 301 (Moved Permanently) to the viewer along with - // the HTTPS URL. The viewer then resubmits the request using the new URL. - // - // * - // https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status - // code of 403 (Forbidden). - // - // For more information about requiring the HTTPS - // protocol, see Requiring HTTPS Between Viewers and CloudFront - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) - // in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers - // retrieve an object that was fetched from the origin using HTTPS is never to use - // any other protocol to fetch the object. If you have recently changed from HTTP - // to HTTPS, we recommend that you clear your objects’ cache because cached objects - // are protocol agnostic. That means that an edge location will return an object - // from the cache regardless of whether the current request protocol matches the - // protocol used previously. For more information, see Managing Cache Expiration + // This field is deprecated. We recommend that you use the MinTTL field in a cache + // policy instead of this field. For more information, see Creating cache policies + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) + // or Using the managed cache policies + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) + // in the Amazon CloudFront Developer Guide. The minimum amount of time that you + // want objects to stay in CloudFront caches before CloudFront forwards another + // request to your origin to determine whether the object has been updated. For + // more information, see Managing How Long Content Stays in an Edge Cache + // (Expiration) // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) + // in the Amazon CloudFront Developer Guide. You must specify 0 for MinTTL if you + // configure CloudFront to forward all headers to your origin (under Headers, if + // you specify 1 for Quantity and * for Name). + MinTTL *int64 + + // The unique identifier of the origin request policy that is attached to the + // default cache behavior. For more information, see Creating origin request + // policies + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) + // or Using the managed origin request policies + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) // in the Amazon CloudFront Developer Guide. - // - // This member is required. - ViewerProtocolPolicy ViewerProtocolPolicy + OriginRequestPolicyId *string // Indicates whether you want to distribute media files in the Microsoft Smooth // Streaming format using the origin that is associated with this cache behavior. @@ -1216,16 +1216,12 @@ type DefaultCacheBehavior struct { // the details about how to track and manage content delivery. type Distribution struct { - // The domain name corresponding to the distribution, for example, - // d111111abcdef8.cloudfront.net. - // - // This member is required. - DomainName *string - - // The date and time the distribution was last modified. + // The ARN (Amazon Resource Name) for the distribution. For example: + // arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where + // 123456789012 is your AWS account ID. // // This member is required. - LastModifiedTime *time.Time + ARN *string // CloudFront automatically adds this element to the response only if you've set up // the distribution to serve private content with signed URLs. The element lists @@ -1239,11 +1235,40 @@ type Distribution struct { // This member is required. ActiveTrustedSigners *ActiveTrustedSigners + // The current configuration information for the distribution. Send a GET request + // to the /CloudFront API version/distribution ID/config resource. + // + // This member is required. + DistributionConfig *DistributionConfig + + // The domain name corresponding to the distribution, for example, + // d111111abcdef8.cloudfront.net. + // + // This member is required. + DomainName *string + + // The identifier for the distribution. For example: EDFDVBD632BHDS5. + // + // This member is required. + Id *string + // The number of invalidation batches currently in progress. // // This member is required. InProgressInvalidationBatches *int32 + // The date and time the distribution was last modified. + // + // This member is required. + LastModifiedTime *time.Time + + // This response element indicates the current status of the distribution. When the + // status is Deployed, the distribution's information is fully propagated to all + // CloudFront edge locations. + // + // This member is required. + Status *string + // AWS services in China customers must file for an Internet Content Provider (ICP) // recordal if they want to serve content publicly on an alternate domain name, // also known as a CNAME, that they've added to CloudFront. AliasICPRecordal @@ -1252,59 +1277,68 @@ type Distribution struct { // (https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html) // in Getting Started with AWS services in China. AliasICPRecordals []*AliasICPRecordal +} - // The ARN (Amazon Resource Name) for the distribution. For example: - // arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where - // 123456789012 is your AWS account ID. +// A distribution configuration. +type DistributionConfig struct { + + // A unique value (for example, a date-time stamp) that ensures that the request + // can't be replayed. If the value of CallerReference is new (regardless of the + // content of the DistributionConfig object), CloudFront creates a new + // distribution. If CallerReference is a value that you already sent in a previous + // request to create a distribution, CloudFront returns a DistributionAlreadyExists + // error. // // This member is required. - ARN *string + CallerReference *string - // The identifier for the distribution. For example: EDFDVBD632BHDS5. + // Any comments you want to include about the distribution. If you don't want to + // specify a comment, include an empty Comment element. To delete an existing + // comment, update the distribution configuration and include an empty Comment + // element. To add or change a comment, update the distribution configuration and + // specify the new comment. // // This member is required. - Id *string + Comment *string - // This response element indicates the current status of the distribution. When the - // status is Deployed, the distribution's information is fully propagated to all - // CloudFront edge locations. + // A complex type that describes the default cache behavior if you don't specify a + // CacheBehavior element or if files don't match any of the values of PathPattern + // in CacheBehavior elements. You must create exactly one default cache behavior. // // This member is required. - Status *string + DefaultCacheBehavior *DefaultCacheBehavior - // The current configuration information for the distribution. Send a GET request - // to the /CloudFront API version/distribution ID/config resource. + // From this field, you can enable or disable the selected distribution. // // This member is required. - DistributionConfig *DistributionConfig -} - -// A distribution configuration. -type DistributionConfig struct { - - // A complex type that determines the distribution’s SSL/TLS configuration for - // communicating with viewers. - ViewerCertificate *ViewerCertificate + Enabled *bool // A complex type that contains information about origins for this distribution. // // This member is required. Origins *Origins - // A complex type that controls whether access logs are written for the - // distribution. For more information about logging, see Access Logs - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html) - // in the Amazon CloudFront Developer Guide. - Logging *LoggingConfig + // A complex type that contains information about CNAMEs (alternate domain names), + // if any, for this distribution. + Aliases *Aliases - // Any comments you want to include about the distribution. If you don't want to - // specify a comment, include an empty Comment element. To delete an existing - // comment, update the distribution configuration and include an empty Comment - // element. To add or change a comment, update the distribution configuration and - // specify the new comment. + // A complex type that contains zero or more CacheBehavior elements. + CacheBehaviors *CacheBehaviors + + // A complex type that controls the following: // - // This member is required. - Comment *string + // * Whether CloudFront replaces + // HTTP status codes in the 4xx and 5xx range with custom error messages before + // returning the response to the viewer. + // + // * How long CloudFront caches HTTP + // status codes in the 4xx and 5xx range. + // + // For more information about custom error + // pages, see Customizing Error Responses + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) + // in the Amazon CloudFront Developer Guide. + CustomErrorResponses *CustomErrorResponses // The object that you want CloudFront to request from your origin (for example, // index.html) when a viewer requests the root URL for your distribution @@ -1332,6 +1366,48 @@ type DistributionConfig struct { // an Internet search for "http/2 optimization." HttpVersion HttpVersion + // If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for + // your distribution, specify true. If you specify false, CloudFront responds to + // IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. + // This allows viewers to submit a second request, for an IPv4 address for your + // distribution. In general, you should enable IPv6 if you have users on IPv6 + // networks who want to access your content. However, if you're using signed URLs + // or signed cookies to restrict access to your content, and if you're using a + // custom policy that includes the IpAddress parameter to restrict the IP addresses + // that can access your content, don't enable IPv6. If you want to restrict access + // to some content by IP address and not restrict access to other content (or + // restrict access but not by IP address), you can create two distributions. For + // more information, see Creating a Signed URL Using a Custom Policy + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html) + // in the Amazon CloudFront Developer Guide. If you're using an Amazon Route 53 + // alias resource record set to route traffic to your CloudFront distribution, you + // need to create a second alias resource record set when both of the following are + // true: + // + // * You enable IPv6 for the distribution + // + // * You're using alternate + // domain names in the URLs for your objects + // + // For more information, see Routing + // Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name + // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html) + // in the Amazon Route 53 Developer Guide. If you created a CNAME resource record + // set, either with Amazon Route 53 or with another DNS service, you don't need to + // make any changes. A CNAME record will route traffic to your distribution + // regardless of the IP address format of the viewer request. + IsIPV6Enabled *bool + + // A complex type that controls whether access logs are written for the + // distribution. For more information about logging, see Access Logs + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html) + // in the Amazon CloudFront Developer Guide. + Logging *LoggingConfig + + // A complex type that contains information about origin groups for this + // distribution. + OriginGroups *OriginGroups + // The price class that corresponds with the maximum price that you want to pay for // CloudFront service. If you specify PriceClass_All, CloudFront responds to // requests for your objects from all CloudFront edge locations. If you specify a @@ -1348,8 +1424,13 @@ type DistributionConfig struct { // down to see the table at the bottom of the page. PriceClass PriceClass - // A complex type that contains zero or more CacheBehavior elements. - CacheBehaviors *CacheBehaviors + // A complex type that identifies ways in which you want to restrict distribution + // of your content. + Restrictions *Restrictions + + // A complex type that determines the distribution’s SSL/TLS configuration for + // communicating with viewers. + ViewerCertificate *ViewerCertificate // A unique identifier that specifies the AWS WAF web ACL, if any, to associate // with this distribution. To specify a web ACL created using the latest version of @@ -1366,87 +1447,6 @@ type DistributionConfig struct { // about AWS WAF, see the AWS WAF Developer Guide // (https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html). WebACLId *string - - // A complex type that contains information about CNAMEs (alternate domain names), - // if any, for this distribution. - Aliases *Aliases - - // A complex type that controls the following: - // - // * Whether CloudFront replaces - // HTTP status codes in the 4xx and 5xx range with custom error messages before - // returning the response to the viewer. - // - // * How long CloudFront caches HTTP - // status codes in the 4xx and 5xx range. - // - // For more information about custom error - // pages, see Customizing Error Responses - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) - // in the Amazon CloudFront Developer Guide. - CustomErrorResponses *CustomErrorResponses - - // A complex type that contains information about origin groups for this - // distribution. - OriginGroups *OriginGroups - - // A complex type that identifies ways in which you want to restrict distribution - // of your content. - Restrictions *Restrictions - - // From this field, you can enable or disable the selected distribution. - // - // This member is required. - Enabled *bool - - // A complex type that describes the default cache behavior if you don't specify a - // CacheBehavior element or if files don't match any of the values of PathPattern - // in CacheBehavior elements. You must create exactly one default cache behavior. - // - // This member is required. - DefaultCacheBehavior *DefaultCacheBehavior - - // A unique value (for example, a date-time stamp) that ensures that the request - // can't be replayed. If the value of CallerReference is new (regardless of the - // content of the DistributionConfig object), CloudFront creates a new - // distribution. If CallerReference is a value that you already sent in a previous - // request to create a distribution, CloudFront returns a DistributionAlreadyExists - // error. - // - // This member is required. - CallerReference *string - - // If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for - // your distribution, specify true. If you specify false, CloudFront responds to - // IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. - // This allows viewers to submit a second request, for an IPv4 address for your - // distribution. In general, you should enable IPv6 if you have users on IPv6 - // networks who want to access your content. However, if you're using signed URLs - // or signed cookies to restrict access to your content, and if you're using a - // custom policy that includes the IpAddress parameter to restrict the IP addresses - // that can access your content, don't enable IPv6. If you want to restrict access - // to some content by IP address and not restrict access to other content (or - // restrict access but not by IP address), you can create two distributions. For - // more information, see Creating a Signed URL Using a Custom Policy - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html) - // in the Amazon CloudFront Developer Guide. If you're using an Amazon Route 53 - // alias resource record set to route traffic to your CloudFront distribution, you - // need to create a second alias resource record set when both of the following are - // true: - // - // * You enable IPv6 for the distribution - // - // * You're using alternate - // domain names in the URLs for your objects - // - // For more information, see Routing - // Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html) - // in the Amazon Route 53 Developer Guide. If you created a CNAME resource record - // set, either with Amazon Route 53 or with another DNS service, you don't need to - // make any changes. A CNAME record will route traffic to your distribution - // regardless of the IP address format of the viewer request. - IsIPV6Enabled *bool } // A distribution Configuration and a list of tags to be associated with the @@ -1467,44 +1467,39 @@ type DistributionConfigWithTags struct { // A list of distribution IDs. type DistributionIdList struct { - // The total number of distribution IDs returned in the response. + // A flag that indicates whether more distribution IDs remain to be listed. If your + // results were truncated, you can make a subsequent request using the Marker + // request field to retrieve more distribution IDs in the list. // // This member is required. - Quantity *int32 - - // Contains the value that you should use in the Marker field of a subsequent - // request to continue listing distribution IDs where you left off. - NextMarker *string - - // Contains the distribution IDs in the list. - Items []*string + IsTruncated *bool // The value provided in the Marker request field. // // This member is required. Marker *string - // A flag that indicates whether more distribution IDs remain to be listed. If your - // results were truncated, you can make a subsequent request using the Marker - // request field to retrieve more distribution IDs in the list. + // The maximum number of distribution IDs requested. // // This member is required. - IsTruncated *bool + MaxItems *int32 - // The maximum number of distribution IDs requested. + // The total number of distribution IDs returned in the response. // // This member is required. - MaxItems *int32 + Quantity *int32 + + // Contains the distribution IDs in the list. + Items []*string + + // Contains the value that you should use in the Marker field of a subsequent + // request to continue listing distribution IDs where you left off. + NextMarker *string } // A distribution list. type DistributionList struct { - // The value you provided for the MaxItems request parameter. - // - // This member is required. - MaxItems *int32 - // A flag that indicates whether more distributions remain to be listed. If your // results were truncated, you can make a follow-up pagination request using the // Marker request parameter to retrieve more distributions in the list. @@ -1512,24 +1507,29 @@ type DistributionList struct { // This member is required. IsTruncated *bool - // A complex type that contains one DistributionSummary element for each - // distribution that was created by the current AWS account. - Items []*DistributionSummary - - // If IsTruncated is true, this element is present and contains the value you can - // use for the Marker request parameter to continue listing your distributions - // where they left off. - NextMarker *string - // The value you provided for the Marker request parameter. // // This member is required. Marker *string + // The value you provided for the MaxItems request parameter. + // + // This member is required. + MaxItems *int32 + // The number of distributions that were created by the current AWS account. // // This member is required. Quantity *int32 + + // A complex type that contains one DistributionSummary element for each + // distribution that was created by the current AWS account. + Items []*DistributionSummary + + // If IsTruncated is true, this element is present and contains the value you can + // use for the Marker request parameter to continue listing your distributions + // where they left off. + NextMarker *string } // A summary of the information about a CloudFront distribution. @@ -1542,14 +1542,26 @@ type DistributionSummary struct { // This member is required. ARN *string - // The identifier for the distribution. For example: EDFDVBD632BHDS5. + // A complex type that contains information about CNAMEs (alternate domain names), + // if any, for this distribution. // // This member is required. - Id *string + Aliases *Aliases - // A complex type that contains information about origin groups for this - // distribution. - OriginGroups *OriginGroups + // A complex type that contains zero or more CacheBehavior elements. + // + // This member is required. + CacheBehaviors *CacheBehaviors + + // The comment originally specified when this distribution was created. + // + // This member is required. + Comment *string + + // A complex type that contains zero or more CustomErrorResponses elements. + // + // This member is required. + CustomErrorResponses *CustomErrorResponses // A complex type that describes the default cache behavior if you don't specify a // CacheBehavior element or if files don't match any of the values of PathPattern @@ -1558,35 +1570,44 @@ type DistributionSummary struct { // This member is required. DefaultCacheBehavior *DefaultCacheBehavior + // The domain name that corresponds to the distribution, for example, + // d111111abcdef8.cloudfront.net. + // + // This member is required. + DomainName *string + // Whether the distribution is enabled to accept user requests for content. // // This member is required. Enabled *bool - // A complex type that contains zero or more CustomErrorResponses elements. + // Specify the maximum HTTP version that you want viewers to use to communicate + // with CloudFront. The default value for new web distributions is http2. Viewers + // that don't support HTTP/2 will automatically use an earlier version. // // This member is required. - CustomErrorResponses *CustomErrorResponses + HttpVersion HttpVersion - // The comment originally specified when this distribution was created. + // The identifier for the distribution. For example: EDFDVBD632BHDS5. // // This member is required. - Comment *string + Id *string - // The date and time the distribution was last modified. + // Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your + // distribution. // // This member is required. - LastModifiedTime *time.Time + IsIPV6Enabled *bool - // A complex type that contains information about origins for this distribution. + // The date and time the distribution was last modified. // // This member is required. - Origins *Origins + LastModifiedTime *time.Time - // A complex type that contains zero or more CacheBehavior elements. + // A complex type that contains information about origins for this distribution. // // This member is required. - CacheBehaviors *CacheBehaviors + Origins *Origins // A complex type that contains information about price class for this streaming // distribution. @@ -1594,18 +1615,17 @@ type DistributionSummary struct { // This member is required. PriceClass PriceClass - // Specify the maximum HTTP version that you want viewers to use to communicate - // with CloudFront. The default value for new web distributions is http2. Viewers - // that don't support HTTP/2 will automatically use an earlier version. + // A complex type that identifies ways in which you want to restrict distribution + // of your content. // // This member is required. - HttpVersion HttpVersion + Restrictions *Restrictions - // Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your - // distribution. + // The current status of the distribution. When the status is Deployed, the + // distribution's information is propagated to all CloudFront edge locations. // // This member is required. - IsIPV6Enabled *bool + Status *string // A complex type that determines the distribution’s SSL/TLS configuration for // communicating with viewers. @@ -1613,6 +1633,11 @@ type DistributionSummary struct { // This member is required. ViewerCertificate *ViewerCertificate + // The Web ACL Id (if any) associated with the distribution. + // + // This member is required. + WebACLId *string + // AWS services in China customers must file for an Internet Content Provider (ICP) // recordal if they want to serve content publicly on an alternate domain name, // also known as a CNAME, that they've added to CloudFront. AliasICPRecordal @@ -1622,34 +1647,9 @@ type DistributionSummary struct { // in Getting Started with AWS services in China. AliasICPRecordals []*AliasICPRecordal - // The current status of the distribution. When the status is Deployed, the - // distribution's information is propagated to all CloudFront edge locations. - // - // This member is required. - Status *string - - // A complex type that identifies ways in which you want to restrict distribution - // of your content. - // - // This member is required. - Restrictions *Restrictions - - // The Web ACL Id (if any) associated with the distribution. - // - // This member is required. - WebACLId *string - - // The domain name that corresponds to the distribution, for example, - // d111111abcdef8.cloudfront.net. - // - // This member is required. - DomainName *string - - // A complex type that contains information about CNAMEs (alternate domain names), - // if any, for this distribution. - // - // This member is required. - Aliases *Aliases + // A complex type that contains information about origin groups for this + // distribution. + OriginGroups *OriginGroups } // Complex data type for field-level encryption profiles that includes all of the @@ -1671,13 +1671,6 @@ type EncryptionEntities struct { // encryption key and field pattern specifications. type EncryptionEntity struct { - // The provider associated with the public key being used for encryption. This - // value must also be provided with the private key for applications to be able to - // decrypt data. - // - // This member is required. - ProviderId *string - // Field patterns in a field-level encryption content type profile specify the // fields that you want to be encrypted. You can provide the full field name, or // any beginning characters followed by a wildcard (*). You can't overlap field @@ -1687,6 +1680,13 @@ type EncryptionEntity struct { // This member is required. FieldPatterns *FieldPatterns + // The provider associated with the public key being used for encryption. This + // value must also be provided with the private key for applications to be able to + // decrypt data. + // + // This member is required. + ProviderId *string + // The public key associated with a set of field-level encryption patterns, to be // used when encrypting the fields that match the patterns. // @@ -1698,11 +1698,6 @@ type EncryptionEntity struct { // specified for field-level encryption. type FieldLevelEncryption struct { - // The last time the field-level encryption configuration was changed. - // - // This member is required. - LastModifiedTime *time.Time - // A complex data type that includes the profile configurations specified for // field-level encryption. // @@ -1715,6 +1710,11 @@ type FieldLevelEncryption struct { // // This member is required. Id *string + + // The last time the field-level encryption configuration was changed. + // + // This member is required. + LastModifiedTime *time.Time } // A complex data type that includes the profile configurations specified for @@ -1729,14 +1729,14 @@ type FieldLevelEncryptionConfig struct { // An optional comment about the configuration. Comment *string - // A complex data type that specifies when to forward content if a profile isn't - // found and the profile that can be provided as a query argument in a request. - QueryArgProfileConfig *QueryArgProfileConfig - // A complex data type that specifies when to forward content if a content type // isn't recognized and profiles to use as by default in a request if a query // argument doesn't specify a profile to use. ContentTypeProfileConfig *ContentTypeProfileConfig + + // A complex data type that specifies when to forward content if a profile isn't + // found and the profile that can be provided as a query argument in a request. + QueryArgProfileConfig *QueryArgProfileConfig } // List of field-level encrpytion configurations. @@ -1770,22 +1770,27 @@ type FieldLevelEncryptionProfile struct { // This member is required. FieldLevelEncryptionProfileConfig *FieldLevelEncryptionProfileConfig - // The last time the field-level encryption profile was updated. - // - // This member is required. - LastModifiedTime *time.Time - // The ID for a field-level encryption profile configuration which includes a set // of profiles that specify certain selected data fields to be encrypted by // specific public keys. // // This member is required. Id *string + + // The last time the field-level encryption profile was updated. + // + // This member is required. + LastModifiedTime *time.Time } // A complex data type of profiles for the field-level encryption. type FieldLevelEncryptionProfileConfig struct { + // A unique number that ensures that the request can't be replayed. + // + // This member is required. + CallerReference *string + // A complex data type of encryption entities for the field-level encryption // profile that include the public key ID, provider, and field patterns for // specifying which fields to encrypt with this key. @@ -1793,11 +1798,6 @@ type FieldLevelEncryptionProfileConfig struct { // This member is required. EncryptionEntities *EncryptionEntities - // A unique number that ensures that the request can't be replayed. - // - // This member is required. - CallerReference *string - // Profile name for the field-level encryption profile. // // This member is required. @@ -1810,10 +1810,11 @@ type FieldLevelEncryptionProfileConfig struct { // List of field-level encryption profiles. type FieldLevelEncryptionProfileList struct { - // If there are more elements to be listed, this element is present and contains - // the value that you can use for the Marker request parameter to continue listing - // your profiles where you left off. - NextMarker *string + // The maximum number of field-level encryption profiles you want in the response + // body. + // + // This member is required. + MaxItems *int32 // The number of field-level encryption profiles. // @@ -1823,21 +1824,15 @@ type FieldLevelEncryptionProfileList struct { // The field-level encryption profile items. Items []*FieldLevelEncryptionProfileSummary - // The maximum number of field-level encryption profiles you want in the response - // body. - // - // This member is required. - MaxItems *int32 + // If there are more elements to be listed, this element is present and contains + // the value that you can use for the Marker request parameter to continue listing + // your profiles where you left off. + NextMarker *string } // The field-level encryption profile summary. type FieldLevelEncryptionProfileSummary struct { - // ID for the field-level encryption profile summary. - // - // This member is required. - Id *string - // A complex data type of encryption entities for the field-level encryption // profile that include the public key ID, provider, and field patterns for // specifying which fields to encrypt with this key. @@ -1845,6 +1840,11 @@ type FieldLevelEncryptionProfileSummary struct { // This member is required. EncryptionEntities *EncryptionEntities + // ID for the field-level encryption profile summary. + // + // This member is required. + Id *string + // The time when the the field-level encryption profile summary was last updated. // // This member is required. @@ -1862,24 +1862,24 @@ type FieldLevelEncryptionProfileSummary struct { // A summary of a field-level encryption item. type FieldLevelEncryptionSummary struct { - // An optional comment about the field-level encryption item. - Comment *string - // The unique ID of a field-level encryption item. // // This member is required. Id *string + // The last time that the summary of field-level encryption items was modified. + // + // This member is required. + LastModifiedTime *time.Time + + // An optional comment about the field-level encryption item. + Comment *string + // A summary of a content type-profile mapping. ContentTypeProfileConfig *ContentTypeProfileConfig // A summary of a query argument-profile mapping. QueryArgProfileConfig *QueryArgProfileConfig - - // The last time that the summary of field-level encryption items was modified. - // - // This member is required. - LastModifiedTime *time.Time } // A complex data type that includes the field patterns to match for field-level @@ -1925,20 +1925,6 @@ type ForwardedValues struct { // This member is required. Cookies *CookiePreference - // This field is deprecated. We recommend that you use a cache policy or an origin - // request policy instead of this field. If you want to include query strings in - // the cache key, use a cache policy. For more information, see Creating cache - // policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) - // in the Amazon CloudFront Developer Guide. If you want to send query strings to - // the origin but not include them in the cache key, use an origin request policy. - // For more information, see Creating origin request policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) - // in the Amazon CloudFront Developer Guide. A complex type that contains - // information about the query string parameters that you want CloudFront to use - // for caching for this cache behavior. - QueryStringCacheKeys *QueryStringCacheKeys - // This field is deprecated. We recommend that you use a cache policy or an origin // request policy instead of this field. If you want to include query strings in // the cache key, use a cache policy. For more information, see Creating cache @@ -1987,6 +1973,20 @@ type ForwardedValues struct { // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html) // in the Amazon CloudFront Developer Guide. Headers *Headers + + // This field is deprecated. We recommend that you use a cache policy or an origin + // request policy instead of this field. If you want to include query strings in + // the cache key, use a cache policy. For more information, see Creating cache + // policies + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) + // in the Amazon CloudFront Developer Guide. If you want to send query strings to + // the origin but not include them in the cache key, use an origin request policy. + // For more information, see Creating origin request policies + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) + // in the Amazon CloudFront Developer Guide. A complex type that contains + // information about the query string parameters that you want CloudFront to use + // for caching for this cache behavior. + QueryStringCacheKeys *QueryStringCacheKeys } // A complex type that controls the countries in which your content is distributed. @@ -2000,17 +2000,6 @@ type GeoRestriction struct { // This member is required. Quantity *int32 - // A complex type that contains a Location element for each country in which you - // want CloudFront either to distribute your content (whitelist) or not distribute - // your content (blacklist). The Location element is a two-letter, uppercase - // country code for a country that you want to include in your blacklist or - // whitelist. Include one Location element for each country. CloudFront and MaxMind - // both use ISO 3166 country codes. For the current list of countries and the - // corresponding codes, see ISO 3166-1-alpha-2 code on the International - // Organization for Standardization website. You can also refer to the country list - // on the CloudFront console, which includes both country names and codes. - Items []*string - // The method that you want to use to restrict distribution of your content by // country: // @@ -2026,23 +2015,39 @@ type GeoRestriction struct { // // This member is required. RestrictionType GeoRestrictionType + + // A complex type that contains a Location element for each country in which you + // want CloudFront either to distribute your content (whitelist) or not distribute + // your content (blacklist). The Location element is a two-letter, uppercase + // country code for a country that you want to include in your blacklist or + // whitelist. Include one Location element for each country. CloudFront and MaxMind + // both use ISO 3166 country codes. For the current list of countries and the + // corresponding codes, see ISO 3166-1-alpha-2 code on the International + // Organization for Standardization website. You can also refer to the country list + // on the CloudFront console, which includes both country names and codes. + Items []*string } // Contains a list of HTTP header names. type Headers struct { - // A list of HTTP header names. - Items []*string - // The number of header names in the Items list. // // This member is required. Quantity *int32 + + // A list of HTTP header names. + Items []*string } // An invalidation. type Invalidation struct { + // The date and time the invalidation request was first made. + // + // This member is required. + CreateTime *time.Time + // The identifier for the invalidation request. For example: IDFDVBD632BHDS5. // // This member is required. @@ -2053,11 +2058,6 @@ type Invalidation struct { // This member is required. InvalidationBatch *InvalidationBatch - // The date and time the invalidation request was first made. - // - // This member is required. - CreateTime *time.Time - // The status of the invalidation request. When the invalidation batch is finished, // the status is Completed. // @@ -2068,14 +2068,6 @@ type Invalidation struct { // An invalidation batch. type InvalidationBatch struct { - // A complex type that contains information about the objects that you want to - // invalidate. For more information, see Specifying the Objects to Invalidate - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html#invalidation-specifying-objects) - // in the Amazon CloudFront Developer Guide. - // - // This member is required. - Paths *Paths - // A value that you specify to uniquely identify an invalidation request. // CloudFront uses the value to prevent you from accidentally resubmitting an // identical request. Whenever you create a new invalidation request, you must @@ -2092,6 +2084,14 @@ type InvalidationBatch struct { // // This member is required. CallerReference *string + + // A complex type that contains information about the objects that you want to + // invalidate. For more information, see Specifying the Objects to Invalidate + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html#invalidation-specifying-objects) + // in the Amazon CloudFront Developer Guide. + // + // This member is required. + Paths *Paths } // The InvalidationList complex type describes the list of invalidation objects. @@ -2114,10 +2114,6 @@ type InvalidationList struct { // This member is required. Marker *string - // A complex type that contains one InvalidationSummary element for each - // invalidation batch created by the current AWS account. - Items []*InvalidationSummary - // The value that you provided for the MaxItems request parameter. // // This member is required. @@ -2128,6 +2124,10 @@ type InvalidationList struct { // This member is required. Quantity *int32 + // A complex type that contains one InvalidationSummary element for each + // invalidation batch created by the current AWS account. + Items []*InvalidationSummary + // If IsTruncated is true, this element is present and contains the value that you // can use for the Marker request parameter to continue listing your invalidation // batches where they left off. @@ -2137,20 +2137,20 @@ type InvalidationList struct { // A summary of an invalidation request. type InvalidationSummary struct { - // The status of an invalidation request. + // The time that an invalidation request was created. // // This member is required. - Status *string + CreateTime *time.Time // The unique ID for an invalidation request. // // This member is required. Id *string - // The time that an invalidation request was created. + // The status of an invalidation request. // // This member is required. - CreateTime *time.Time + Status *string } // A complex type that lists the active CloudFront key pairs, if any, that are @@ -2174,13 +2174,6 @@ type KeyPairIds struct { // A complex type that contains a Lambda function association. type LambdaFunctionAssociation struct { - // A flag that allows a Lambda function to have read access to the body content. - // For more information, see Accessing the Request Body by Choosing the Include - // Body Option - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-include-body-access.html) - // in the Amazon CloudFront Developer Guide. - IncludeBody *bool - // Specifies the event type that triggers a Lambda function invocation. You can // specify the following values: // @@ -2211,6 +2204,13 @@ type LambdaFunctionAssociation struct { // // This member is required. LambdaFunctionARN *string + + // A flag that allows a Lambda function to have read access to the body content. + // For more information, see Accessing the Request Body by Choosing the Include + // Body Option + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-include-body-access.html) + // in the Amazon CloudFront Developer Guide. + IncludeBody *bool } // A complex type that specifies a list of Lambda functions associations for a @@ -2239,16 +2239,6 @@ type LambdaFunctionAssociations struct { // distribution. type LoggingConfig struct { - // Specifies whether you want CloudFront to include cookies in access logs, specify - // true for IncludeCookies. If you choose to include cookies in logs, CloudFront - // logs all cookies regardless of how you configure the cache behaviors for this - // distribution. If you don't want to include cookies when you create a - // distribution or if you want to disable include cookies for an existing - // distribution, specify false for IncludeCookies. - // - // This member is required. - IncludeCookies *bool - // The Amazon S3 bucket to store the access logs in, for example, // myawslogbucket.s3.amazonaws.com. // @@ -2265,6 +2255,16 @@ type LoggingConfig struct { // This member is required. Enabled *bool + // Specifies whether you want CloudFront to include cookies in access logs, specify + // true for IncludeCookies. If you choose to include cookies in logs, CloudFront + // logs all cookies regardless of how you configure the cache behaviors for this + // distribution. If you don't want to include cookies when you create a + // distribution or if you want to disable include cookies for an existing + // distribution, specify false for IncludeCookies. + // + // This member is required. + IncludeCookies *bool + // An optional string that you want CloudFront to prefix to the access log // filenames for this distribution, for example, myprefix/. If you want to enable // logging, but you don't want to specify a prefix, you still must include an empty @@ -2313,24 +2313,12 @@ type Origin struct { // This member is required. DomainName *string - // Use this type to specify an origin that is an Amazon S3 bucket that is not - // configured with static website hosting. To specify any other type of origin, - // including an Amazon S3 bucket that is configured with static website hosting, - // use the CustomOriginConfig type instead. - S3OriginConfig *S3OriginConfig - - // Use this type to specify an origin that is a content container or HTTP server, - // including an Amazon S3 bucket that is configured with static website hosting. To - // specify an Amazon S3 bucket that is not configured with static website hosting, - // use the S3OriginConfig type instead. - CustomOriginConfig *CustomOriginConfig - - // An optional path that CloudFront appends to the origin domain name when - // CloudFront requests content from the origin. For more information, see Origin - // Path - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginPath) - // in the Amazon CloudFront Developer Guide. - OriginPath *string + // A unique identifier for the origin. This value must be unique within the + // distribution. Use this value to specify the TargetOriginId in a CacheBehavior or + // DefaultCacheBehavior. + // + // This member is required. + Id *string // The number of times that CloudFront attempts to connect to the origin. The // minimum number is 1, the maximum is 3, and the default (if you don’t specify @@ -2344,12 +2332,13 @@ type Origin struct { // in the Amazon CloudFront Developer Guide. ConnectionAttempts *int32 - // A unique identifier for the origin. This value must be unique within the - // distribution. Use this value to specify the TargetOriginId in a CacheBehavior or - // DefaultCacheBehavior. - // - // This member is required. - Id *string + // The number of seconds that CloudFront waits when trying to establish a + // connection to the origin. The minimum timeout is 1 second, the maximum is 10 + // seconds, and the default (if you don’t specify otherwise) is 10 seconds. For + // more information, see Origin Connection Timeout + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout) + // in the Amazon CloudFront Developer Guide. + ConnectionTimeout *int32 // A list of HTTP header names and values that CloudFront adds to requests it sends // to the origin. For more information, see Adding Custom Headers to Origin @@ -2358,24 +2347,30 @@ type Origin struct { // in the Amazon CloudFront Developer Guide. CustomHeaders *CustomHeaders - // The number of seconds that CloudFront waits when trying to establish a - // connection to the origin. The minimum timeout is 1 second, the maximum is 10 - // seconds, and the default (if you don’t specify otherwise) is 10 seconds. For - // more information, see Origin Connection Timeout - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout) + // Use this type to specify an origin that is a content container or HTTP server, + // including an Amazon S3 bucket that is configured with static website hosting. To + // specify an Amazon S3 bucket that is not configured with static website hosting, + // use the S3OriginConfig type instead. + CustomOriginConfig *CustomOriginConfig + + // An optional path that CloudFront appends to the origin domain name when + // CloudFront requests content from the origin. For more information, see Origin + // Path + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginPath) // in the Amazon CloudFront Developer Guide. - ConnectionTimeout *int32 + OriginPath *string + + // Use this type to specify an origin that is an Amazon S3 bucket that is not + // configured with static website hosting. To specify any other type of origin, + // including an Amazon S3 bucket that is configured with static website hosting, + // use the CustomOriginConfig type instead. + S3OriginConfig *S3OriginConfig } // A complex type that contains HeaderName and HeaderValue elements, if any, for // this distribution. type OriginCustomHeader struct { - // The value for the header that you specified in the HeaderName field. - // - // This member is required. - HeaderValue *string - // The name of a header that you want CloudFront to send to your origin. For more // information, see Adding Custom Headers to Origin Requests // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html) @@ -2383,6 +2378,11 @@ type OriginCustomHeader struct { // // This member is required. HeaderName *string + + // The value for the header that you specified in the HeaderName field. + // + // This member is required. + HeaderValue *string } // An origin group includes two origins (a primary origin and a second origin to @@ -2393,6 +2393,12 @@ type OriginCustomHeader struct { // failover conditions that you've chosen. type OriginGroup struct { + // A complex type that contains information about the failover criteria for an + // origin group. + // + // This member is required. + FailoverCriteria *OriginGroupFailoverCriteria + // The origin group's ID. // // This member is required. @@ -2402,12 +2408,6 @@ type OriginGroup struct { // // This member is required. Members *OriginGroupMembers - - // A complex type that contains information about the failover criteria for an - // origin group. - // - // This member is required. - FailoverCriteria *OriginGroupFailoverCriteria } // A complex data type that includes information about the failover criteria for an @@ -2434,27 +2434,27 @@ type OriginGroupMember struct { // A complex data type for the origins included in an origin group. type OriginGroupMembers struct { - // The number of origins in an origin group. + // Items (origins) in an origin group. // // This member is required. - Quantity *int32 + Items []*OriginGroupMember - // Items (origins) in an origin group. + // The number of origins in an origin group. // // This member is required. - Items []*OriginGroupMember + Quantity *int32 } // A complex data type for the origin groups specified for a distribution. type OriginGroups struct { - // The items (origin groups) in a distribution. - Items []*OriginGroup - // The number of origin groups. // // This member is required. Quantity *int32 + + // The items (origin groups) in a distribution. + Items []*OriginGroup } // An origin request policy. When it’s attached to a cache behavior, the origin @@ -2484,15 +2484,15 @@ type OriginRequestPolicy struct { // This member is required. Id *string - // The origin request policy configuration. + // The date and time when the origin request policy was last modified. // // This member is required. - OriginRequestPolicyConfig *OriginRequestPolicyConfig + LastModifiedTime *time.Time - // The date and time when the origin request policy was last modified. + // The origin request policy configuration. // // This member is required. - LastModifiedTime *time.Time + OriginRequestPolicyConfig *OriginRequestPolicyConfig } // An origin request policy configuration. This configuration determines the values @@ -2528,18 +2528,18 @@ type OriginRequestPolicyConfig struct { // This member is required. HeadersConfig *OriginRequestPolicyHeadersConfig - // A comment to describe the origin request policy. - Comment *string + // A unique name to identify the origin request policy. + // + // This member is required. + Name *string // The URL query strings from viewer requests to include in origin requests. // // This member is required. QueryStringsConfig *OriginRequestPolicyQueryStringsConfig - // A unique name to identify the origin request policy. - // - // This member is required. - Name *string + // A comment to describe the origin request policy. + Comment *string } // An object that determines whether any cookies in viewer requests (and if so, @@ -2602,24 +2602,24 @@ type OriginRequestPolicyHeadersConfig struct { // A list of origin request policies. type OriginRequestPolicyList struct { + // The maximum number of origin request policies requested. + // + // This member is required. + MaxItems *int32 + // The total number of origin request policies returned in the response. // // This member is required. Quantity *int32 + // Contains the origin request policies in the list. + Items []*OriginRequestPolicySummary + // If there are more items in the list than are in this response, this element is // present. It contains the value that you should use in the Marker field of a // subsequent request to continue listing origin request policies where you left // off. NextMarker *string - - // The maximum number of origin request policies requested. - // - // This member is required. - MaxItems *int32 - - // Contains the origin request policies in the list. - Items []*OriginRequestPolicySummary } // An object that determines whether any URL query strings in viewer requests (and @@ -2627,10 +2627,6 @@ type OriginRequestPolicyList struct { // the origin. type OriginRequestPolicyQueryStringsConfig struct { - // Contains a list of the query strings in viewer requests that are included in - // requests that CloudFront sends to the origin. - QueryStrings *QueryStringNames - // Determines whether any URL query strings in viewer requests are included in // requests that CloudFront sends to the origin. Valid values are: // @@ -2649,6 +2645,10 @@ type OriginRequestPolicyQueryStringsConfig struct { // // This member is required. QueryStringBehavior OriginRequestPolicyQueryStringBehavior + + // Contains a list of the query strings in viewer requests that are included in + // requests that CloudFront sends to the origin. + QueryStrings *QueryStringNames } // Contains an origin request policy. @@ -2670,31 +2670,31 @@ type OriginRequestPolicySummary struct { // this distribution. type Origins struct { - // The number of origins or origin groups for this distribution. + // A complex type that contains origins or origin groups for this distribution. // // This member is required. - Quantity *int32 + Items []*Origin - // A complex type that contains origins or origin groups for this distribution. + // The number of origins or origin groups for this distribution. // // This member is required. - Items []*Origin + Quantity *int32 } // A complex type that contains information about the SSL/TLS protocols that // CloudFront can use when establishing an HTTPS connection with your origin. type OriginSslProtocols struct { - // The number of SSL/TLS protocols that you want to allow CloudFront to use when - // establishing an HTTPS connection with this origin. + // A list that contains allowed SSL/TLS protocols for this distribution. // // This member is required. - Quantity *int32 + Items []SslProtocol - // A list that contains allowed SSL/TLS protocols for this distribution. + // The number of SSL/TLS protocols that you want to allow CloudFront to use when + // establishing an HTTPS connection with this origin. // // This member is required. - Items []SslProtocol + Quantity *int32 } // This object determines the values that CloudFront includes in the cache key. @@ -2714,13 +2714,6 @@ type ParametersInCacheKeyAndForwardedToOrigin struct { // This member is required. CookiesConfig *CachePolicyCookiesConfig - // An object that determines whether any URL query strings in viewer requests (and - // if so, which query strings) are included in the cache key and automatically - // included in requests that CloudFront sends to the origin. - // - // This member is required. - QueryStringsConfig *CachePolicyQueryStringsConfig - // A flag that determines whether the Accept-Encoding HTTP header is included in // the cache key and included in requests that CloudFront sends to the origin. If // this field is true and the viewer request includes the Accept-Encoding header, @@ -2754,6 +2747,13 @@ type ParametersInCacheKeyAndForwardedToOrigin struct { // // This member is required. HeadersConfig *CachePolicyHeadersConfig + + // An object that determines whether any URL query strings in viewer requests (and + // if so, which query strings) are included in the cache key and automatically + // included in requests that CloudFront sends to the origin. + // + // This member is required. + QueryStringsConfig *CachePolicyQueryStringsConfig } // A complex type that contains information about the objects that you want to @@ -2762,26 +2762,20 @@ type ParametersInCacheKeyAndForwardedToOrigin struct { // in the Amazon CloudFront Developer Guide. type Paths struct { - // A complex type that contains a list of the paths that you want to invalidate. - Items []*string - // The number of invalidation paths specified for the objects that you want to // invalidate. // // This member is required. Quantity *int32 + + // A complex type that contains a list of the paths that you want to invalidate. + Items []*string } // A complex data type of public keys you add to CloudFront to use with features // like field-level encryption. type PublicKey struct { - // A complex data type for a public key you add to CloudFront to use with features - // like field-level encryption. - // - // This member is required. - PublicKeyConfig *PublicKeyConfig - // A time you added a public key to CloudFront. // // This member is required. @@ -2791,14 +2785,22 @@ type PublicKey struct { // // This member is required. Id *string + + // A complex data type for a public key you add to CloudFront to use with features + // like field-level encryption. + // + // This member is required. + PublicKeyConfig *PublicKeyConfig } // Information about a public key you add to CloudFront to use with features like // field-level encryption. type PublicKeyConfig struct { - // An optional comment about a public key. - Comment *string + // A unique number that ensures that the request can't be replayed. + // + // This member is required. + CallerReference *string // The encoded public key that you want to add to CloudFront to use with features // like field-level encryption. @@ -2812,45 +2814,38 @@ type PublicKeyConfig struct { // This member is required. Name *string - // A unique number that ensures that the request can't be replayed. - // - // This member is required. - CallerReference *string + // An optional comment about a public key. + Comment *string } // A list of public keys you've added to CloudFront to use with features like // field-level encryption. type PublicKeyList struct { - // If there are more elements to be listed, this element is present and contains - // the value that you can use for the Marker request parameter to continue listing - // your public keys where you left off. - NextMarker *string - // The maximum number of public keys you want in the response body. // // This member is required. MaxItems *int32 - // An array of information about a public key you add to CloudFront to use with - // features like field-level encryption. - Items []*PublicKeySummary - // The number of public keys you added to CloudFront to use with features like // field-level encryption. // // This member is required. Quantity *int32 + + // An array of information about a public key you add to CloudFront to use with + // features like field-level encryption. + Items []*PublicKeySummary + + // If there are more elements to be listed, this element is present and contains + // the value that you can use for the Marker request parameter to continue listing + // your public keys where you left off. + NextMarker *string } // A complex data type for public key information. type PublicKeySummary struct { - // Name for public key information summary. - // - // This member is required. - Name *string - // Creation time for public key information summary. // // This member is required. @@ -2866,6 +2861,11 @@ type PublicKeySummary struct { // This member is required. Id *string + // Name for public key information summary. + // + // This member is required. + Name *string + // Comment for public key information summary. Comment *string } @@ -2934,15 +2934,15 @@ type QueryStringCacheKeys struct { } // Contains a list of query string names. -type QueryStringNames struct { - - // A list of query string names. - Items []*string +type QueryStringNames struct { // The number of query string names in the Items list. // // This member is required. Quantity *int32 + + // A list of query string names. + Items []*string } // A complex type that identifies ways in which you want to restrict distribution @@ -2960,6 +2960,11 @@ type Restrictions struct { // you want CloudFront to get your media files for distribution. type S3Origin struct { + // The DNS name of the Amazon S3 origin. + // + // This member is required. + DomainName *string + // The CloudFront origin access identity to associate with the distribution. Use an // origin access identity to configure the distribution so that end users can only // access objects in an Amazon S3 bucket through CloudFront. If you want end users @@ -2975,11 +2980,6 @@ type S3Origin struct { // // This member is required. OriginAccessIdentity *string - - // The DNS name of the Amazon S3 origin. - // - // This member is required. - DomainName *string } // A complex type that contains information about the Amazon S3 origin. If the @@ -3012,10 +3012,6 @@ type S3OriginConfig struct { // any. type Signer struct { - // A complex type that lists the active CloudFront key pairs, if any, that are - // associated with AwsAccountNumber. - KeyPairIds *KeyPairIds - // An AWS account that is included in the TrustedSigners complex type for this // distribution. Valid values include: // @@ -3024,6 +3020,10 @@ type Signer struct { // // * An AWS account number. AwsAccountNumber *string + + // A complex type that lists the active CloudFront key pairs, if any, that are + // associated with AwsAccountNumber. + KeyPairIds *KeyPairIds } // A complex data type for the status codes that you specify that, when returned by @@ -3045,13 +3045,27 @@ type StatusCodes struct { // delivered from, and the details about how to track and manage content delivery. type StreamingDistribution struct { - // The date and time that the distribution was last modified. - LastModifiedTime *time.Time + // The ARN (Amazon Resource Name) for the distribution. For example: + // arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where + // 123456789012 is your AWS account ID. + // + // This member is required. + ARN *string - // The current configuration information for the RTMP distribution. + // A complex type that lists the AWS accounts, if any, that you included in the + // TrustedSigners complex type for this distribution. These are the accounts that + // you want to allow to create signed URLs for private content. The Signer complex + // type lists the AWS account number of the trusted signer or self if the signer is + // the AWS account that created the distribution. The Signer element also includes + // the IDs of any active CloudFront key pairs that are associated with the trusted + // signer's AWS account. If no KeyPairId element appears for a Signer, that signer + // can't create signed URLs. For more information, see Serving Private Content + // through CloudFront + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) + // in the Amazon CloudFront Developer Guide. // // This member is required. - StreamingDistributionConfig *StreamingDistributionConfig + ActiveTrustedSigners *ActiveTrustedSigners // The domain name that corresponds to the streaming distribution, for example, // s5c39gqb8ow64r.cloudfront.net. @@ -3070,47 +3084,18 @@ type StreamingDistribution struct { // This member is required. Status *string - // A complex type that lists the AWS accounts, if any, that you included in the - // TrustedSigners complex type for this distribution. These are the accounts that - // you want to allow to create signed URLs for private content. The Signer complex - // type lists the AWS account number of the trusted signer or self if the signer is - // the AWS account that created the distribution. The Signer element also includes - // the IDs of any active CloudFront key pairs that are associated with the trusted - // signer's AWS account. If no KeyPairId element appears for a Signer, that signer - // can't create signed URLs. For more information, see Serving Private Content - // through CloudFront - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) - // in the Amazon CloudFront Developer Guide. + // The current configuration information for the RTMP distribution. // // This member is required. - ActiveTrustedSigners *ActiveTrustedSigners + StreamingDistributionConfig *StreamingDistributionConfig - // The ARN (Amazon Resource Name) for the distribution. For example: - // arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where - // 123456789012 is your AWS account ID. - // - // This member is required. - ARN *string + // The date and time that the distribution was last modified. + LastModifiedTime *time.Time } // The RTMP distribution's configuration information. type StreamingDistributionConfig struct { - // A complex type that contains information about CNAMEs (alternate domain names), - // if any, for this streaming distribution. - Aliases *Aliases - - // A complex type that specifies any AWS accounts that you want to permit to create - // signed URLs for private content. If you want the distribution to use signed - // URLs, include this element; if you want the distribution to use public URLs, - // remove this element. For more information, see Serving Private Content through - // CloudFront - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) - // in the Amazon CloudFront Developer Guide. - // - // This member is required. - TrustedSigners *TrustedSigners - // A unique value (for example, a date-time stamp) that ensures that the request // can't be replayed. If the value of CallerReference is new (regardless of the // content of the StreamingDistributionConfig object), CloudFront creates a new @@ -3121,30 +3106,45 @@ type StreamingDistributionConfig struct { // This member is required. CallerReference *string + // Any comments you want to include about the streaming distribution. + // + // This member is required. + Comment *string + // Whether the streaming distribution is enabled to accept user requests for // content. // // This member is required. Enabled *bool - // A complex type that controls whether access logs are written for the streaming - // distribution. - Logging *StreamingLoggingConfig - // A complex type that contains information about the Amazon S3 bucket from which // you want CloudFront to get your media files for distribution. // // This member is required. S3Origin *S3Origin + // A complex type that specifies any AWS accounts that you want to permit to create + // signed URLs for private content. If you want the distribution to use signed + // URLs, include this element; if you want the distribution to use public URLs, + // remove this element. For more information, see Serving Private Content through + // CloudFront + // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) + // in the Amazon CloudFront Developer Guide. + // + // This member is required. + TrustedSigners *TrustedSigners + + // A complex type that contains information about CNAMEs (alternate domain names), + // if any, for this streaming distribution. + Aliases *Aliases + + // A complex type that controls whether access logs are written for the streaming + // distribution. + Logging *StreamingLoggingConfig + // A complex type that contains information about price class for this streaming // distribution. PriceClass PriceClass - - // Any comments you want to include about the streaming distribution. - // - // This member is required. - Comment *string } // A streaming distribution Configuration and a list of tags to be associated with @@ -3182,16 +3182,16 @@ type StreamingDistributionList struct { // This member is required. MaxItems *int32 - // A complex type that contains one StreamingDistributionSummary element for each - // distribution that was created by the current AWS account. - Items []*StreamingDistributionSummary - // The number of streaming distributions that were created by the current AWS // account. // // This member is required. Quantity *int32 + // A complex type that contains one StreamingDistributionSummary element for each + // distribution that was created by the current AWS account. + Items []*StreamingDistributionSummary + // If IsTruncated is true, this element is present and contains the value you can // use for the Marker request parameter to continue listing your RTMP distributions // where they left off. @@ -3201,11 +3201,6 @@ type StreamingDistributionList struct { // A summary of the information for a CloudFront streaming distribution. type StreamingDistributionSummary struct { - // The identifier for the distribution, for example, EDFDVBD632BHDS5. - // - // This member is required. - Id *string - // The ARN (Amazon Resource Name) for the streaming distribution. For example: // arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where // 123456789012 is your AWS account ID. @@ -3213,34 +3208,43 @@ type StreamingDistributionSummary struct { // This member is required. ARN *string - // Indicates the current status of the distribution. When the status is Deployed, - // the distribution's information is fully propagated throughout the Amazon - // CloudFront system. + // A complex type that contains information about CNAMEs (alternate domain names), + // if any, for this streaming distribution. // // This member is required. - Status *string + Aliases *Aliases - // The date and time the distribution was last modified. + // The comment originally specified when this distribution was created. // // This member is required. - LastModifiedTime *time.Time + Comment *string - // A complex type that contains information about CNAMEs (alternate domain names), - // if any, for this streaming distribution. + // The domain name corresponding to the distribution, for example, + // d111111abcdef8.cloudfront.net. // // This member is required. - Aliases *Aliases + DomainName *string - // A complex type that contains information about price class for this streaming - // distribution. + // Whether the distribution is enabled to accept end user requests for content. // // This member is required. - PriceClass PriceClass + Enabled *bool - // The comment originally specified when this distribution was created. + // The identifier for the distribution, for example, EDFDVBD632BHDS5. // // This member is required. - Comment *string + Id *string + + // The date and time the distribution was last modified. + // + // This member is required. + LastModifiedTime *time.Time + + // A complex type that contains information about price class for this streaming + // distribution. + // + // This member is required. + PriceClass PriceClass // A complex type that contains information about the Amazon S3 bucket from which // you want CloudFront to get your media files for distribution. @@ -3248,10 +3252,12 @@ type StreamingDistributionSummary struct { // This member is required. S3Origin *S3Origin - // Whether the distribution is enabled to accept end user requests for content. + // Indicates the current status of the distribution. When the status is Deployed, + // the distribution's information is fully propagated throughout the Amazon + // CloudFront system. // // This member is required. - Enabled *bool + Status *string // A complex type that specifies the AWS accounts, if any, that you want to allow // to create signed URLs for private content. If you want to require signed URLs in @@ -3269,26 +3275,12 @@ type StreamingDistributionSummary struct { // // This member is required. TrustedSigners *TrustedSigners - - // The domain name corresponding to the distribution, for example, - // d111111abcdef8.cloudfront.net. - // - // This member is required. - DomainName *string } // A complex type that controls whether access logs are written for this streaming // distribution. type StreamingLoggingConfig struct { - // An optional string that you want CloudFront to prefix to the access log - // filenames for this streaming distribution, for example, myprefix/. If you want - // to enable logging, but you don't want to specify a prefix, you still must - // include an empty Prefix element in the Logging element. - // - // This member is required. - Prefix *string - // The Amazon S3 bucket to store the access logs in, for example, // myawslogbucket.s3.amazonaws.com. // @@ -3304,6 +3296,14 @@ type StreamingLoggingConfig struct { // // This member is required. Enabled *bool + + // An optional string that you want CloudFront to prefix to the access log + // filenames for this streaming distribution, for example, myprefix/. If you want + // to enable logging, but you don't want to specify a prefix, you still must + // include an empty Prefix element in the Logging element. + // + // This member is required. + Prefix *string } // A complex type that contains Tag key and Tag value. @@ -3415,6 +3415,15 @@ type TrustedSigners struct { // Guide.

type ViewerCertificate struct { + // If the distribution uses Aliases (alternate domain names or CNAMEs) and the + // SSL/TLS certificate is stored in AWS Certificate Manager (ACM) + // (https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html), provide + // the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports + // ACM certificates in the US East (N. Virginia) Region (us-east-1). If you specify + // an ACM certificate ARN, you must also specify values for MinimumProtocolVerison + // and SSLSupportMethod. + ACMCertificateArn *string + // This field is deprecated. Use one of the following fields instead: // // * @@ -3422,22 +3431,6 @@ type ViewerCertificate struct { //

  • CloudFrontDefaultCertificate

    • Certificate *string - // If the distribution uses Aliases (alternate domain names or CNAMEs), specify - // which viewers the distribution accepts HTTPS connections from. - // - // * sni-only – - // The distribution accepts HTTPS connections from only viewers that support server - // name indication (SNI) (https://en.wikipedia.org/wiki/Server_Name_Indication). - // This is recommended. Most browsers and clients support SNI. - // - // * vip – The - // distribution accepts HTTPS connections from all viewers including those that - // don’t support SNI. This is not recommended, and results in additional monthly - // charges from CloudFront.

    If the distribution uses the CloudFront - // domain name such as d111111abcdef8.cloudfront.net, don’t set a - // value for this field.

    - SSLSupportMethod SSLSupportMethod - // This field is deprecated. Use one of the following fields instead: // // * @@ -3445,22 +3438,6 @@ type ViewerCertificate struct { //

  • CloudFrontDefaultCertificate

    • CertificateSource CertificateSource - // If the distribution uses Aliases (alternate domain names or CNAMEs) and the - // SSL/TLS certificate is stored in AWS Identity and Access Management (AWS IAM) - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html), - // provide the ID of the IAM certificate. If you specify an IAM certificate ID, you - // must also specify values for MinimumProtocolVerison and SSLSupportMethod. - IAMCertificateId *string - - // If the distribution uses Aliases (alternate domain names or CNAMEs) and the - // SSL/TLS certificate is stored in AWS Certificate Manager (ACM) - // (https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html), provide - // the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports - // ACM certificates in the US East (N. Virginia) Region (us-east-1). If you specify - // an ACM certificate ARN, you must also specify values for MinimumProtocolVerison - // and SSLSupportMethod. - ACMCertificateArn *string - // If the distribution uses the CloudFront domain name such as // d111111abcdef8.cloudfront.net, set this field to true. If the distribution uses // Aliases (alternate domain names or CNAMEs), set this field to false and specify @@ -3472,6 +3449,13 @@ type ViewerCertificate struct { // SSLSupportMethod

    CloudFrontDefaultCertificate *bool + // If the distribution uses Aliases (alternate domain names or CNAMEs) and the + // SSL/TLS certificate is stored in AWS Identity and Access Management (AWS IAM) + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html), + // provide the ID of the IAM certificate. If you specify an IAM certificate ID, you + // must also specify values for MinimumProtocolVerison and SSLSupportMethod. + IAMCertificateId *string + // If the distribution uses Aliases (alternate domain names or CNAMEs), specify the // security policy that you want CloudFront to use for HTTPS connections with // viewers. The security policy determines two settings: @@ -3495,4 +3479,20 @@ type ViewerCertificate struct { // CloudFront automatically sets the security policy to TLSv1 regardless of the // value that you set here. MinimumProtocolVersion MinimumProtocolVersion + + // If the distribution uses Aliases (alternate domain names or CNAMEs), specify + // which viewers the distribution accepts HTTPS connections from. + // + // * sni-only – + // The distribution accepts HTTPS connections from only viewers that support server + // name indication (SNI) (https://en.wikipedia.org/wiki/Server_Name_Indication). + // This is recommended. Most browsers and clients support SNI. + // + // * vip – The + // distribution accepts HTTPS connections from all viewers including those that + // don’t support SNI. This is not recommended, and results in additional monthly + // charges from CloudFront.

    If the distribution uses the CloudFront + // domain name such as d111111abcdef8.cloudfront.net, don’t set a + // value for this field.

    + SSLSupportMethod SSLSupportMethod } diff --git a/service/cloudhsm/api_op_CreateHsm.go b/service/cloudhsm/api_op_CreateHsm.go index 393c6741e3f..98c609a11b6 100644 --- a/service/cloudhsm/api_op_CreateHsm.go +++ b/service/cloudhsm/api_op_CreateHsm.go @@ -76,33 +76,22 @@ func (c *Client) CreateHsm(ctx context.Context, params *CreateHsmInput, optFns . // Contains the inputs for the CreateHsm operation. type CreateHsmInput struct { - // The identifier of the subnet in your VPC in which to place the HSM. - // - // This member is required. - SubnetId *string - - // The IP address for the syslog monitoring server. The AWS CloudHSM service only - // supports one syslog monitoring server. - SyslogIp *string - // The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on // your behalf. // // This member is required. IamRoleArn *string - // The IP address to assign to the HSM's ENI. If an IP address is not specified, an - // IP address will be randomly chosen from the CIDR range of the subnet. - EniIp *string - - // The external ID from IamRoleArn, if present. - ExternalId *string - // The SSH public key to install on the HSM. // // This member is required. SshKey *string + // The identifier of the subnet in your VPC in which to place the HSM. + // + // This member is required. + SubnetId *string + // Specifies the type of subscription for the HSM. // // * PRODUCTION - The HSM is @@ -117,6 +106,17 @@ type CreateHsmInput struct { // A user-defined token to ensure idempotence. Subsequent calls to this operation // with the same token will be ignored. ClientToken *string + + // The IP address to assign to the HSM's ENI. If an IP address is not specified, an + // IP address will be randomly chosen from the CIDR range of the subnet. + EniIp *string + + // The external ID from IamRoleArn, if present. + ExternalId *string + + // The IP address for the syslog monitoring server. The AWS CloudHSM service only + // supports one syslog monitoring server. + SyslogIp *string } // Contains the output of the CreateHsm operation. diff --git a/service/cloudhsm/api_op_DescribeHapg.go b/service/cloudhsm/api_op_DescribeHapg.go index bead5bc15f4..2fb6d3372ed 100644 --- a/service/cloudhsm/api_op_DescribeHapg.go +++ b/service/cloudhsm/api_op_DescribeHapg.go @@ -77,30 +77,30 @@ type DescribeHapgInput struct { // Contains the output of the DescribeHapg () action. type DescribeHapgOutput struct { - // The list of partition serial numbers that belong to the high-availability - // partition group. - PartitionSerialList []*string + // The ARN of the high-availability partition group. + HapgArn *string // The serial number of the high-availability partition group. HapgSerial *string + // + HsmsLastActionFailed []*string + // HsmsPendingDeletion []*string + // + HsmsPendingRegistration []*string + // The label for the high-availability partition group. Label *string // The date and time the high-availability partition group was last modified. LastModifiedTimestamp *string - // The ARN of the high-availability partition group. - HapgArn *string - - // - HsmsLastActionFailed []*string - - // - HsmsPendingRegistration []*string + // The list of partition serial numbers that belong to the high-availability + // partition group. + PartitionSerialList []*string // The state of the high-availability partition group. State types.CloudHsmObjectState diff --git a/service/cloudhsm/api_op_DescribeHsm.go b/service/cloudhsm/api_op_DescribeHsm.go index 629da438494..fb38baeab5f 100644 --- a/service/cloudhsm/api_op_DescribeHsm.go +++ b/service/cloudhsm/api_op_DescribeHsm.go @@ -68,41 +68,50 @@ func (c *Client) DescribeHsm(ctx context.Context, params *DescribeHsmInput, optF // Contains the inputs for the DescribeHsm () operation. type DescribeHsmInput struct { - // The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter - // must be specified. - HsmSerialNumber *string - // The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be // specified. HsmArn *string + + // The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter + // must be specified. + HsmSerialNumber *string } // Contains the output of the DescribeHsm () operation. type DescribeHsmOutput struct { - // The subscription start date. - SubscriptionStartDate *string + // The Availability Zone that the HSM is in. + AvailabilityZone *string - // The name of the HSM vendor. - VendorName *string + // The identifier of the elastic network interface (ENI) attached to the HSM. + EniId *string - // The identifier of the subnet that the HSM is in. - SubnetId *string + // The IP address assigned to the HSM's ENI. + EniIp *string + + // The ARN of the HSM. + HsmArn *string + + // The HSM model type. + HsmType *string // The ARN of the IAM role assigned to the HSM. IamRoleArn *string - // Contains additional information about the status of the HSM. - StatusDetails *string + // The list of partitions on the HSM. + Partitions []*string - // The identifier of the elastic network interface (ENI) attached to the HSM. - EniId *string + // The serial number of the HSM. + SerialNumber *string - // The identifier of the VPC that the HSM is in. - VpcId *string + // The date and time that the server certificate was last updated. + ServerCertLastUpdated *string - // The Availability Zone that the HSM is in. - AvailabilityZone *string + // The URI of the certificate server. + ServerCertUri *string + + // The HSM software version. + SoftwareVersion *string // The date and time that the SSH key was last updated. SshKeyLastUpdated *string @@ -110,17 +119,20 @@ type DescribeHsmOutput struct { // The public SSH key. SshPublicKey *string - // The HSM software version. - SoftwareVersion *string + // The status of the HSM. + Status types.HsmStatus - // The date and time that the server certificate was last updated. - ServerCertLastUpdated *string + // Contains additional information about the status of the HSM. + StatusDetails *string + + // The identifier of the subnet that the HSM is in. + SubnetId *string // The subscription end date. SubscriptionEndDate *string - // The ARN of the HSM. - HsmArn *string + // The subscription start date. + SubscriptionStartDate *string // Specifies the type of subscription for the HSM. // @@ -131,23 +143,11 @@ type DescribeHsmOutput struct { // a product trial. SubscriptionType types.SubscriptionType - // The HSM model type. - HsmType *string - - // The URI of the certificate server. - ServerCertUri *string - - // The list of partitions on the HSM. - Partitions []*string - - // The status of the HSM. - Status types.HsmStatus - - // The IP address assigned to the HSM's ENI. - EniIp *string + // The name of the HSM vendor. + VendorName *string - // The serial number of the HSM. - SerialNumber *string + // The identifier of the VPC that the HSM is in. + VpcId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/cloudhsm/api_op_DescribeLunaClient.go b/service/cloudhsm/api_op_DescribeLunaClient.go index 7f2d9b754fe..9d17b75a629 100644 --- a/service/cloudhsm/api_op_DescribeLunaClient.go +++ b/service/cloudhsm/api_op_DescribeLunaClient.go @@ -65,17 +65,17 @@ func (c *Client) DescribeLunaClient(ctx context.Context, params *DescribeLunaCli type DescribeLunaClientInput struct { - // The ARN of the client. - ClientArn *string - // The certificate fingerprint. CertificateFingerprint *string + + // The ARN of the client. + ClientArn *string } type DescribeLunaClientOutput struct { - // The label of the client. - Label *string + // The certificate installed on the HSMs used by this client. + Certificate *string // The certificate fingerprint. CertificateFingerprint *string @@ -83,12 +83,12 @@ type DescribeLunaClientOutput struct { // The ARN of the client. ClientArn *string + // The label of the client. + Label *string + // The date and time the client was last modified. LastModifiedTimestamp *string - // The certificate installed on the HSMs used by this client. - Certificate *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudhsm/api_op_GetConfig.go b/service/cloudhsm/api_op_GetConfig.go index 20cbdb5d5a1..6624c088b78 100644 --- a/service/cloudhsm/api_op_GetConfig.go +++ b/service/cloudhsm/api_op_GetConfig.go @@ -73,29 +73,29 @@ type GetConfigInput struct { // This member is required. ClientArn *string - // A list of ARNs that identify the high-availability partition groups that are - // associated with the client. + // The client version. // // This member is required. - HapgList []*string + ClientVersion types.ClientVersion - // The client version. + // A list of ARNs that identify the high-availability partition groups that are + // associated with the client. // // This member is required. - ClientVersion types.ClientVersion + HapgList []*string } type GetConfigOutput struct { - // The type of credentials. - ConfigType *string - // The certificate file containing the server.pem files of the HSMs. ConfigCred *string // The chrystoki.conf configuration file. ConfigFile *string + // The type of credentials. + ConfigType *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudhsm/api_op_ListHapgs.go b/service/cloudhsm/api_op_ListHapgs.go index 0958c66562f..0ec2c4805df 100644 --- a/service/cloudhsm/api_op_ListHapgs.go +++ b/service/cloudhsm/api_op_ListHapgs.go @@ -75,15 +75,15 @@ type ListHapgsInput struct { type ListHapgsOutput struct { - // If not null, more results are available. Pass this value to ListHapgs to - // retrieve the next set of items. - NextToken *string - // The list of high-availability partition groups. // // This member is required. HapgList []*string + // If not null, more results are available. Pass this value to ListHapgs to + // retrieve the next set of items. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudhsm/api_op_ListHsms.go b/service/cloudhsm/api_op_ListHsms.go index 398ea82563b..b240dea2ff0 100644 --- a/service/cloudhsm/api_op_ListHsms.go +++ b/service/cloudhsm/api_op_ListHsms.go @@ -77,13 +77,13 @@ type ListHsmsInput struct { // Contains the output of the ListHsms operation. type ListHsmsOutput struct { + // The list of ARNs that identify the HSMs. + HsmList []*string + // If not null, more results are available. Pass this value to ListHsms to retrieve // the next set of items. NextToken *string - // The list of ARNs that identify the HSMs. - HsmList []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudhsm/api_op_ListLunaClients.go b/service/cloudhsm/api_op_ListLunaClients.go index cb161273b32..ffb7d53d14c 100644 --- a/service/cloudhsm/api_op_ListLunaClients.go +++ b/service/cloudhsm/api_op_ListLunaClients.go @@ -75,15 +75,15 @@ type ListLunaClientsInput struct { type ListLunaClientsOutput struct { - // If not null, more results are available. Pass this to ListLunaClients to - // retrieve the next set of items. - NextToken *string - // The list of clients. // // This member is required. ClientList []*string + // If not null, more results are available. Pass this to ListLunaClients to + // retrieve the next set of items. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudhsm/api_op_ModifyHapg.go b/service/cloudhsm/api_op_ModifyHapg.go index e62063a8ab4..a4ffd6d421f 100644 --- a/service/cloudhsm/api_op_ModifyHapg.go +++ b/service/cloudhsm/api_op_ModifyHapg.go @@ -66,17 +66,17 @@ func (c *Client) ModifyHapg(ctx context.Context, params *ModifyHapgInput, optFns type ModifyHapgInput struct { - // The list of partition serial numbers to make members of the high-availability - // partition group. - PartitionSerialList []*string - - // The new label for the high-availability partition group. - Label *string - // The ARN of the high-availability partition group to modify. // // This member is required. HapgArn *string + + // The new label for the high-availability partition group. + Label *string + + // The list of partition serial numbers to make members of the high-availability + // partition group. + PartitionSerialList []*string } type ModifyHapgOutput struct { diff --git a/service/cloudhsm/api_op_ModifyHsm.go b/service/cloudhsm/api_op_ModifyHsm.go index d193c0eed76..de50b594d64 100644 --- a/service/cloudhsm/api_op_ModifyHsm.go +++ b/service/cloudhsm/api_op_ModifyHsm.go @@ -71,26 +71,26 @@ func (c *Client) ModifyHsm(ctx context.Context, params *ModifyHsmInput, optFns . // Contains the inputs for the ModifyHsm () operation. type ModifyHsmInput struct { - // The new identifier of the subnet that the HSM is in. The new subnet must be in - // the same Availability Zone as the current subnet. - SubnetId *string - - // The new external ID. - ExternalId *string + // The ARN of the HSM to modify. + // + // This member is required. + HsmArn *string // The new IP address for the elastic network interface (ENI) attached to the HSM. // If the HSM is moved to a different subnet, and an IP address is not specified, // an IP address will be randomly chosen from the CIDR range of the new subnet. EniIp *string - // The ARN of the HSM to modify. - // - // This member is required. - HsmArn *string + // The new external ID. + ExternalId *string // The new IAM role ARN. IamRoleArn *string + // The new identifier of the subnet that the HSM is in. The new subnet must be in + // the same Availability Zone as the current subnet. + SubnetId *string + // The new IP address for the syslog monitoring server. The AWS CloudHSM service // only supports one syslog monitoring server. SyslogIp *string diff --git a/service/cloudhsm/api_op_ModifyLunaClient.go b/service/cloudhsm/api_op_ModifyLunaClient.go index fd31e3739eb..e56f6ca69d7 100644 --- a/service/cloudhsm/api_op_ModifyLunaClient.go +++ b/service/cloudhsm/api_op_ModifyLunaClient.go @@ -67,15 +67,15 @@ func (c *Client) ModifyLunaClient(ctx context.Context, params *ModifyLunaClientI type ModifyLunaClientInput struct { - // The ARN of the client. + // The new certificate for the client. // // This member is required. - ClientArn *string + Certificate *string - // The new certificate for the client. + // The ARN of the client. // // This member is required. - Certificate *string + ClientArn *string } type ModifyLunaClientOutput struct { diff --git a/service/cloudhsm/api_op_RemoveTagsFromResource.go b/service/cloudhsm/api_op_RemoveTagsFromResource.go index 48b4b8bceb4..40267236859 100644 --- a/service/cloudhsm/api_op_RemoveTagsFromResource.go +++ b/service/cloudhsm/api_op_RemoveTagsFromResource.go @@ -68,16 +68,16 @@ func (c *Client) RemoveTagsFromResource(ctx context.Context, params *RemoveTagsF type RemoveTagsFromResourceInput struct { - // The tag key or keys to remove. Specify only the tag key to remove (not the - // value). To overwrite the value for an existing tag, use AddTagsToResource (). + // The Amazon Resource Name (ARN) of the AWS CloudHSM resource. // // This member is required. - TagKeyList []*string + ResourceArn *string - // The Amazon Resource Name (ARN) of the AWS CloudHSM resource. + // The tag key or keys to remove. Specify only the tag key to remove (not the + // value). To overwrite the value for an existing tag, use AddTagsToResource (). // // This member is required. - ResourceArn *string + TagKeyList []*string } type RemoveTagsFromResourceOutput struct { diff --git a/service/cloudhsm/go.mod b/service/cloudhsm/go.mod index 65341748b76..9b9706aca9a 100644 --- a/service/cloudhsm/go.mod +++ b/service/cloudhsm/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/cloudhsm go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/cloudhsm/types/types.go b/service/cloudhsm/types/types.go index fc7a5f923a7..e1cca4a48f3 100644 --- a/service/cloudhsm/types/types.go +++ b/service/cloudhsm/types/types.go @@ -6,13 +6,13 @@ package types // resource. type Tag struct { - // The value of the tag. + // The key of the tag. // // This member is required. - Value *string + Key *string - // The key of the tag. + // The value of the tag. // // This member is required. - Key *string + Value *string } diff --git a/service/cloudhsmv2/api_op_CopyBackupToRegion.go b/service/cloudhsmv2/api_op_CopyBackupToRegion.go index eaad72181a6..cdffb6287c7 100644 --- a/service/cloudhsmv2/api_op_CopyBackupToRegion.go +++ b/service/cloudhsmv2/api_op_CopyBackupToRegion.go @@ -57,20 +57,20 @@ func (c *Client) CopyBackupToRegion(ctx context.Context, params *CopyBackupToReg type CopyBackupToRegionInput struct { - // Tags to apply to the destination backup during creation. If you specify tags, - // only these tags will be applied to the destination backup. If you do not specify - // tags, the service copies tags from the source backup to the destination backup. - TagList []*types.Tag + // The ID of the backup that will be copied to the destination region. + // + // This member is required. + BackupId *string // The AWS region that will contain your copied CloudHSM cluster backup. // // This member is required. DestinationRegion *string - // The ID of the backup that will be copied to the destination region. - // - // This member is required. - BackupId *string + // Tags to apply to the destination backup during creation. If you specify tags, + // only these tags will be applied to the destination backup. If you do not specify + // tags, the service copies tags from the source backup to the destination backup. + TagList []*types.Tag } type CopyBackupToRegionOutput struct { diff --git a/service/cloudhsmv2/api_op_CreateCluster.go b/service/cloudhsmv2/api_op_CreateCluster.go index f175727b62f..6729b0bed18 100644 --- a/service/cloudhsmv2/api_op_CreateCluster.go +++ b/service/cloudhsmv2/api_op_CreateCluster.go @@ -57,13 +57,11 @@ func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, type CreateClusterInput struct { - // The identifier (ID) of the cluster backup to restore. Use this value to restore - // the cluster from a backup instead of creating a new cluster. To find the backup - // ID, use DescribeBackups (). - SourceBackupId *string - - // Tags to apply to the CloudHSM cluster during creation. - TagList []*types.Tag + // The type of HSM to use in the cluster. Currently the only allowed value is + // hsm1.medium. + // + // This member is required. + HsmType *string // The identifiers (IDs) of the subnets where you are creating the cluster. You // must specify at least one subnet. If you specify multiple subnets, they must @@ -78,11 +76,13 @@ type CreateClusterInput struct { // This member is required. SubnetIds []*string - // The type of HSM to use in the cluster. Currently the only allowed value is - // hsm1.medium. - // - // This member is required. - HsmType *string + // The identifier (ID) of the cluster backup to restore. Use this value to restore + // the cluster from a backup instead of creating a new cluster. To find the backup + // ID, use DescribeBackups (). + SourceBackupId *string + + // Tags to apply to the CloudHSM cluster during creation. + TagList []*types.Tag } type CreateClusterOutput struct { diff --git a/service/cloudhsmv2/api_op_DeleteHsm.go b/service/cloudhsmv2/api_op_DeleteHsm.go index eacdfb84132..3fb74cfdb3b 100644 --- a/service/cloudhsmv2/api_op_DeleteHsm.go +++ b/service/cloudhsmv2/api_op_DeleteHsm.go @@ -59,21 +59,21 @@ func (c *Client) DeleteHsm(ctx context.Context, params *DeleteHsmInput, optFns . type DeleteHsmInput struct { - // The IP address of the elastic network interface (ENI) of the HSM that you are - // deleting. - EniIp *string + // The identifier (ID) of the cluster that contains the HSM that you are deleting. + // + // This member is required. + ClusterId *string // The identifier (ID) of the elastic network interface (ENI) of the HSM that you // are deleting. EniId *string + // The IP address of the elastic network interface (ENI) of the HSM that you are + // deleting. + EniIp *string + // The identifier (ID) of the HSM that you are deleting. HsmId *string - - // The identifier (ID) of the cluster that contains the HSM that you are deleting. - // - // This member is required. - ClusterId *string } type DeleteHsmOutput struct { diff --git a/service/cloudhsmv2/api_op_DescribeBackups.go b/service/cloudhsmv2/api_op_DescribeBackups.go index 6b1f8b32859..e7e407e39d0 100644 --- a/service/cloudhsmv2/api_op_DescribeBackups.go +++ b/service/cloudhsmv2/api_op_DescribeBackups.go @@ -61,18 +61,6 @@ func (c *Client) DescribeBackups(ctx context.Context, params *DescribeBackupsInp type DescribeBackupsInput struct { - // The NextToken value that you received in the previous response. Use this value - // to get more backups. - NextToken *string - - // The maximum number of backups to return in the response. When there are more - // backups than the number you specify, the response contains a NextToken value. - MaxResults *int32 - - // Designates whether or not to sort the return backups by ascending chronological - // order of generation. - SortAscending *bool - // One or more filters to limit the items returned in the response. Use the // backupIds filter to return only the specified backups. Specify backups by their // backup identifier (ID). Use the sourceBackupIds filter to return only the @@ -82,18 +70,30 @@ type DescribeBackupsInput struct { // cluster identifier (ID). Use the states filter to return only backups that match // the specified state. Filters map[string][]*string + + // The maximum number of backups to return in the response. When there are more + // backups than the number you specify, the response contains a NextToken value. + MaxResults *int32 + + // The NextToken value that you received in the previous response. Use this value + // to get more backups. + NextToken *string + + // Designates whether or not to sort the return backups by ascending chronological + // order of generation. + SortAscending *bool } type DescribeBackupsOutput struct { + // A list of backups. + Backups []*types.Backup + // An opaque string that indicates that the response contains only a subset of // backups. Use this value in a subsequent DescribeBackups request to get more // backups. NextToken *string - // A list of backups. - Backups []*types.Backup - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudhsmv2/api_op_DescribeClusters.go b/service/cloudhsmv2/api_op_DescribeClusters.go index 5176b0dbd2e..60993ef6f81 100644 --- a/service/cloudhsmv2/api_op_DescribeClusters.go +++ b/service/cloudhsmv2/api_op_DescribeClusters.go @@ -69,25 +69,25 @@ type DescribeClustersInput struct { // specified state. Filters map[string][]*string - // The NextToken value that you received in the previous response. Use this value - // to get more clusters. - NextToken *string - // The maximum number of clusters to return in the response. When there are more // clusters than the number you specify, the response contains a NextToken value. MaxResults *int32 + + // The NextToken value that you received in the previous response. Use this value + // to get more clusters. + NextToken *string } type DescribeClustersOutput struct { + // A list of clusters. + Clusters []*types.Cluster + // An opaque string that indicates that the response contains only a subset of // clusters. Use this value in a subsequent DescribeClusters request to get more // clusters. NextToken *string - // A list of clusters. - Clusters []*types.Cluster - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudhsmv2/api_op_InitializeCluster.go b/service/cloudhsmv2/api_op_InitializeCluster.go index 9aae182505d..b57a36644e4 100644 --- a/service/cloudhsmv2/api_op_InitializeCluster.go +++ b/service/cloudhsmv2/api_op_InitializeCluster.go @@ -60,6 +60,12 @@ func (c *Client) InitializeCluster(ctx context.Context, params *InitializeCluste type InitializeClusterInput struct { + // The identifier (ID) of the cluster that you are claiming. To find the cluster + // ID, use DescribeClusters (). + // + // This member is required. + ClusterId *string + // The cluster certificate issued (signed) by your issuing certificate authority // (CA). The certificate must be in PEM format and can contain a maximum of 5000 // characters. @@ -67,12 +73,6 @@ type InitializeClusterInput struct { // This member is required. SignedCert *string - // The identifier (ID) of the cluster that you are claiming. To find the cluster - // ID, use DescribeClusters (). - // - // This member is required. - ClusterId *string - // The issuing certificate of the issuing certificate authority (CA) that issued // (signed) the cluster certificate. You must use a self-signed certificate. The // certificate used to sign the HSM CSR must be directly available, and thus must @@ -85,12 +85,12 @@ type InitializeClusterInput struct { type InitializeClusterOutput struct { - // A description of the cluster's state. - StateMessage *string - // The cluster's state. State types.ClusterState + // A description of the cluster's state. + StateMessage *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudhsmv2/api_op_ListTags.go b/service/cloudhsmv2/api_op_ListTags.go index f51d59fa568..9c10d3619b0 100644 --- a/service/cloudhsmv2/api_op_ListTags.go +++ b/service/cloudhsmv2/api_op_ListTags.go @@ -62,10 +62,6 @@ func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ... type ListTagsInput struct { - // The NextToken value that you received in the previous response. Use this value - // to get more tags. - NextToken *string - // The cluster identifier (ID) for the cluster whose tags you are getting. To find // the cluster ID, use DescribeClusters (). // @@ -75,19 +71,23 @@ type ListTagsInput struct { // The maximum number of tags to return in the response. When there are more tags // than the number you specify, the response contains a NextToken value. MaxResults *int32 + + // The NextToken value that you received in the previous response. Use this value + // to get more tags. + NextToken *string } type ListTagsOutput struct { - // An opaque string that indicates that the response contains only a subset of - // tags. Use this value in a subsequent ListTags request to get more tags. - NextToken *string - // A list of tags. // // This member is required. TagList []*types.Tag + // An opaque string that indicates that the response contains only a subset of + // tags. Use this value in a subsequent ListTags request to get more tags. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudhsmv2/go.mod b/service/cloudhsmv2/go.mod index e011cc38029..3b6cac76054 100644 --- a/service/cloudhsmv2/go.mod +++ b/service/cloudhsmv2/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/cloudhsmv2 go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/cloudhsmv2/types/types.go b/service/cloudhsmv2/types/types.go index 342a7d09bbc..0f670c421b8 100644 --- a/service/cloudhsmv2/types/types.go +++ b/service/cloudhsmv2/types/types.go @@ -14,44 +14,51 @@ import ( // parameter. type Backup struct { - // The AWS Region that contains the source backup from which the new backup was - // copied. - SourceRegion *string - // The identifier (ID) of the backup. // // This member is required. BackupId *string - // The date and time when the backup was copied from a source backup. - CopyTimestamp *time.Time - - // The date and time when the backup will be permanently deleted. - DeleteTimestamp *time.Time + // The state of the backup. + BackupState BackupState // The identifier (ID) of the cluster that was backed up. ClusterId *string - // The identifier (ID) of the source backup from which the new backup was copied. - SourceBackup *string + // The date and time when the backup was copied from a source backup. + CopyTimestamp *time.Time // The date and time when the backup was created. CreateTimestamp *time.Time - // The list of tags for the backup. - TagList []*Tag + // The date and time when the backup will be permanently deleted. + DeleteTimestamp *time.Time + + // The identifier (ID) of the source backup from which the new backup was copied. + SourceBackup *string // The identifier (ID) of the cluster containing the source backup from which the // new backup was copied. SourceCluster *string - // The state of the backup. - BackupState BackupState + // The AWS Region that contains the source backup from which the new backup was + // copied. + SourceRegion *string + + // The list of tags for the backup. + TagList []*Tag } // Contains one or more certificates or a certificate signing request (CSR). type Certificates struct { + // The HSM hardware certificate issued (signed) by AWS CloudHSM. + AwsHardwareCertificate *string + + // The cluster certificate issued (signed) by the issuing certificate authority + // (CA) of the cluster's owner. + ClusterCertificate *string + // The cluster's certificate signing request (CSR). The CSR exists only when the // cluster's state is UNINITIALIZED. ClusterCsr *string @@ -61,77 +68,70 @@ type Certificates struct { // The HSM hardware certificate issued (signed) by the hardware manufacturer. ManufacturerHardwareCertificate *string - - // The cluster certificate issued (signed) by the issuing certificate authority - // (CA) of the cluster's owner. - ClusterCertificate *string - - // The HSM hardware certificate issued (signed) by AWS CloudHSM. - AwsHardwareCertificate *string } // Contains information about an AWS CloudHSM cluster. type Cluster struct { - // Contains one or more certificates or a certificate signing request (CSR). - Certificates *Certificates - // The cluster's backup policy. BackupPolicy BackupPolicy + // Contains one or more certificates or a certificate signing request (CSR). + Certificates *Certificates + // The cluster's identifier (ID). ClusterId *string - // The cluster's state. - State ClusterState + // The date and time when the cluster was created. + CreateTimestamp *time.Time + + // The type of HSM that the cluster contains. + HsmType *string // Contains information about the HSMs in the cluster. Hsms []*Hsm - // The identifier (ID) of the virtual private cloud (VPC) that contains the - // cluster. - VpcId *string + // The default password for the cluster's Pre-Crypto Officer (PRECO) user. + PreCoPassword *string + + // The identifier (ID) of the cluster's security group. + SecurityGroup *string // The identifier (ID) of the backup used to create the cluster. This value exists // only when the cluster was created from a backup. SourceBackupId *string - // The identifier (ID) of the cluster's security group. - SecurityGroup *string - - // The list of tags for the cluster. - TagList []*Tag + // The cluster's state. + State ClusterState - // The default password for the cluster's Pre-Crypto Officer (PRECO) user. - PreCoPassword *string + // A description of the cluster's state. + StateMessage *string // A map from availability zone to the cluster’s subnet in that availability zone. SubnetMapping map[string]*string - // A description of the cluster's state. - StateMessage *string - - // The type of HSM that the cluster contains. - HsmType *string + // The list of tags for the cluster. + TagList []*Tag - // The date and time when the cluster was created. - CreateTimestamp *time.Time + // The identifier (ID) of the virtual private cloud (VPC) that contains the + // cluster. + VpcId *string } // Contains information about the backup that will be copied and created by the // CopyBackupToRegion () operation. type DestinationBackup struct { - // The identifier (ID) of the cluster containing the source backup from which the - // new backup was copied. - SourceCluster *string - // The date and time when both the source backup was created. CreateTimestamp *time.Time // The identifier (ID) of the source backup from which the new backup was copied. SourceBackup *string + // The identifier (ID) of the cluster containing the source backup from which the + // new backup was copied. + SourceCluster *string + // The AWS region that contains the source backup from which the new backup was // copied. SourceRegion *string @@ -141,31 +141,31 @@ type DestinationBackup struct { // cluster. type Hsm struct { - // The subnet that contains the HSM's elastic network interface (ENI). - SubnetId *string - // The HSM's identifier (ID). // // This member is required. HsmId *string - // A description of the HSM's state. - StateMessage *string + // The Availability Zone that contains the HSM. + AvailabilityZone *string + + // The identifier (ID) of the cluster that contains the HSM. + ClusterId *string // The identifier (ID) of the HSM's elastic network interface (ENI). EniId *string - // The HSM's state. - State HsmState - // The IP address of the HSM's elastic network interface (ENI). EniIp *string - // The Availability Zone that contains the HSM. - AvailabilityZone *string + // The HSM's state. + State HsmState - // The identifier (ID) of the cluster that contains the HSM. - ClusterId *string + // A description of the HSM's state. + StateMessage *string + + // The subnet that contains the HSM's elastic network interface (ENI). + SubnetId *string } // Contains a tag. A tag is a key-value pair. diff --git a/service/cloudsearch/api_op_DefineIndexField.go b/service/cloudsearch/api_op_DefineIndexField.go index 44e4c80b931..ea4236701f8 100644 --- a/service/cloudsearch/api_op_DefineIndexField.go +++ b/service/cloudsearch/api_op_DefineIndexField.go @@ -67,11 +67,6 @@ func (c *Client) DefineIndexField(ctx context.Context, params *DefineIndexFieldI // name of the domain you want to update and the index field configuration. type DefineIndexFieldInput struct { - // The index field and field options you want to configure. - // - // This member is required. - IndexField *types.IndexField - // A string that represents the name of a domain. Domain names are unique across // the domains owned by an account within an AWS region. Domain names start with a // letter or number and can contain the following characters: a-z (lowercase), 0-9, @@ -79,6 +74,11 @@ type DefineIndexFieldInput struct { // // This member is required. DomainName *string + + // The index field and field options you want to configure. + // + // This member is required. + IndexField *types.IndexField } // The result of a DefineIndexField () request. Contains the status of the diff --git a/service/cloudsearch/api_op_DeleteAnalysisScheme.go b/service/cloudsearch/api_op_DeleteAnalysisScheme.go index e0c7c714782..5e624c0769d 100644 --- a/service/cloudsearch/api_op_DeleteAnalysisScheme.go +++ b/service/cloudsearch/api_op_DeleteAnalysisScheme.go @@ -63,6 +63,11 @@ func (c *Client) DeleteAnalysisScheme(ctx context.Context, params *DeleteAnalysi // delete. type DeleteAnalysisSchemeInput struct { + // The name of the analysis scheme you want to delete. + // + // This member is required. + AnalysisSchemeName *string + // A string that represents the name of a domain. Domain names are unique across // the domains owned by an account within an AWS region. Domain names start with a // letter or number and can contain the following characters: a-z (lowercase), 0-9, @@ -70,11 +75,6 @@ type DeleteAnalysisSchemeInput struct { // // This member is required. DomainName *string - - // The name of the analysis scheme you want to delete. - // - // This member is required. - AnalysisSchemeName *string } // The result of a DeleteAnalysisScheme request. Contains the status of the deleted diff --git a/service/cloudsearch/api_op_DeleteExpression.go b/service/cloudsearch/api_op_DeleteExpression.go index 318339ca4d5..c35f7d1cc15 100644 --- a/service/cloudsearch/api_op_DeleteExpression.go +++ b/service/cloudsearch/api_op_DeleteExpression.go @@ -63,11 +63,6 @@ func (c *Client) DeleteExpression(ctx context.Context, params *DeleteExpressionI // delete. type DeleteExpressionInput struct { - // The name of the Expression () to delete. - // - // This member is required. - ExpressionName *string - // A string that represents the name of a domain. Domain names are unique across // the domains owned by an account within an AWS region. Domain names start with a // letter or number and can contain the following characters: a-z (lowercase), 0-9, @@ -75,6 +70,11 @@ type DeleteExpressionInput struct { // // This member is required. DomainName *string + + // The name of the Expression () to delete. + // + // This member is required. + ExpressionName *string } // The result of a DeleteExpression () request. Specifies the expression being diff --git a/service/cloudsearch/api_op_DeleteIndexField.go b/service/cloudsearch/api_op_DeleteIndexField.go index d3703966e8c..b7a7aa7b704 100644 --- a/service/cloudsearch/api_op_DeleteIndexField.go +++ b/service/cloudsearch/api_op_DeleteIndexField.go @@ -63,12 +63,6 @@ func (c *Client) DeleteIndexField(ctx context.Context, params *DeleteIndexFieldI // to delete. type DeleteIndexFieldInput struct { - // The name of the index field your want to remove from the domain's indexing - // options. - // - // This member is required. - IndexFieldName *string - // A string that represents the name of a domain. Domain names are unique across // the domains owned by an account within an AWS region. Domain names start with a // letter or number and can contain the following characters: a-z (lowercase), 0-9, @@ -76,6 +70,12 @@ type DeleteIndexFieldInput struct { // // This member is required. DomainName *string + + // The name of the index field your want to remove from the domain's indexing + // options. + // + // This member is required. + IndexFieldName *string } // The result of a DeleteIndexField () request. diff --git a/service/cloudsearch/api_op_DeleteSuggester.go b/service/cloudsearch/api_op_DeleteSuggester.go index db25f30e7b3..0d7a5f4f30b 100644 --- a/service/cloudsearch/api_op_DeleteSuggester.go +++ b/service/cloudsearch/api_op_DeleteSuggester.go @@ -62,11 +62,6 @@ func (c *Client) DeleteSuggester(ctx context.Context, params *DeleteSuggesterInp // delete. type DeleteSuggesterInput struct { - // Specifies the name of the suggester you want to delete. - // - // This member is required. - SuggesterName *string - // A string that represents the name of a domain. Domain names are unique across // the domains owned by an account within an AWS region. Domain names start with a // letter or number and can contain the following characters: a-z (lowercase), 0-9, @@ -74,6 +69,11 @@ type DeleteSuggesterInput struct { // // This member is required. DomainName *string + + // Specifies the name of the suggester you want to delete. + // + // This member is required. + SuggesterName *string } // The result of a DeleteSuggester request. Contains the status of the deleted diff --git a/service/cloudsearch/api_op_DescribeAvailabilityOptions.go b/service/cloudsearch/api_op_DescribeAvailabilityOptions.go index e1b869ce27e..9cba0ef1711 100644 --- a/service/cloudsearch/api_op_DescribeAvailabilityOptions.go +++ b/service/cloudsearch/api_op_DescribeAvailabilityOptions.go @@ -65,14 +65,14 @@ func (c *Client) DescribeAvailabilityOptions(ctx context.Context, params *Descri // configuration and exclude any pending changes, set the Deployed option to true. type DescribeAvailabilityOptionsInput struct { - // Whether to display the deployed configuration (true) or include any pending - // changes (false). Defaults to false. - Deployed *bool - // The name of the domain you want to describe. // // This member is required. DomainName *string + + // Whether to display the deployed configuration (true) or include any pending + // changes (false). Defaults to false. + Deployed *bool } // The result of a DescribeAvailabilityOptions request. Indicates whether or not diff --git a/service/cloudsearch/api_op_DescribeExpressions.go b/service/cloudsearch/api_op_DescribeExpressions.go index 0e5c228e6c1..648b7916530 100644 --- a/service/cloudsearch/api_op_DescribeExpressions.go +++ b/service/cloudsearch/api_op_DescribeExpressions.go @@ -68,18 +68,18 @@ func (c *Client) DescribeExpressions(ctx context.Context, params *DescribeExpres // option to true. type DescribeExpressionsInput struct { - // Limits the DescribeExpressions () response to the specified expressions. If not - // specified, all expressions are shown. - ExpressionNames []*string + // The name of the domain you want to describe. + // + // This member is required. + DomainName *string // Whether to display the deployed configuration (true) or include any pending // changes (false). Defaults to false. Deployed *bool - // The name of the domain you want to describe. - // - // This member is required. - DomainName *string + // Limits the DescribeExpressions () response to the specified expressions. If not + // specified, all expressions are shown. + ExpressionNames []*string } // The result of a DescribeExpressions request. Contains the expressions configured diff --git a/service/cloudsearch/api_op_DescribeIndexFields.go b/service/cloudsearch/api_op_DescribeIndexFields.go index 359c7863bb8..fdc9e2667fb 100644 --- a/service/cloudsearch/api_op_DescribeIndexFields.go +++ b/service/cloudsearch/api_op_DescribeIndexFields.go @@ -68,10 +68,6 @@ func (c *Client) DescribeIndexFields(ctx context.Context, params *DescribeIndexF // the Deployed option to true. type DescribeIndexFieldsInput struct { - // A list of the index fields you want to describe. If not specified, information - // is returned for all configured index fields. - FieldNames []*string - // The name of the domain you want to describe. // // This member is required. @@ -80,6 +76,10 @@ type DescribeIndexFieldsInput struct { // Whether to display the deployed configuration (true) or include any pending // changes (false). Defaults to false. Deployed *bool + + // A list of the index fields you want to describe. If not specified, information + // is returned for all configured index fields. + FieldNames []*string } // The result of a DescribeIndexFields request. Contains the index fields diff --git a/service/cloudsearch/api_op_UpdateAvailabilityOptions.go b/service/cloudsearch/api_op_UpdateAvailabilityOptions.go index 850310e20f9..24ca36eb2cf 100644 --- a/service/cloudsearch/api_op_UpdateAvailabilityOptions.go +++ b/service/cloudsearch/api_op_UpdateAvailabilityOptions.go @@ -66,14 +66,6 @@ func (c *Client) UpdateAvailabilityOptions(ctx context.Context, params *UpdateAv // availability option. type UpdateAvailabilityOptionsInput struct { - // You expand an existing search domain to a second Availability Zone by setting - // the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to - // downgrade the domain to a single Availability Zone by setting the Multi-AZ - // option to false. - // - // This member is required. - MultiAZ *bool - // A string that represents the name of a domain. Domain names are unique across // the domains owned by an account within an AWS region. Domain names start with a // letter or number and can contain the following characters: a-z (lowercase), 0-9, @@ -81,6 +73,14 @@ type UpdateAvailabilityOptionsInput struct { // // This member is required. DomainName *string + + // You expand an existing search domain to a second Availability Zone by setting + // the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to + // downgrade the domain to a single Availability Zone by setting the Multi-AZ + // option to false. + // + // This member is required. + MultiAZ *bool } // The result of a UpdateAvailabilityOptions request. Contains the status of the diff --git a/service/cloudsearch/api_op_UpdateScalingParameters.go b/service/cloudsearch/api_op_UpdateScalingParameters.go index d031b18062b..b42b7be9ce9 100644 --- a/service/cloudsearch/api_op_UpdateScalingParameters.go +++ b/service/cloudsearch/api_op_UpdateScalingParameters.go @@ -67,12 +67,6 @@ func (c *Client) UpdateScalingParameters(ctx context.Context, params *UpdateScal // you want to configure. type UpdateScalingParametersInput struct { - // The desired instance type and desired number of replicas of each index - // partition. - // - // This member is required. - ScalingParameters *types.ScalingParameters - // A string that represents the name of a domain. Domain names are unique across // the domains owned by an account within an AWS region. Domain names start with a // letter or number and can contain the following characters: a-z (lowercase), 0-9, @@ -80,6 +74,12 @@ type UpdateScalingParametersInput struct { // // This member is required. DomainName *string + + // The desired instance type and desired number of replicas of each index + // partition. + // + // This member is required. + ScalingParameters *types.ScalingParameters } // The result of a UpdateScalingParameters request. Contains the status of the diff --git a/service/cloudsearch/api_op_UpdateServiceAccessPolicies.go b/service/cloudsearch/api_op_UpdateServiceAccessPolicies.go index 2c8b87e3b22..1a0941282bd 100644 --- a/service/cloudsearch/api_op_UpdateServiceAccessPolicies.go +++ b/service/cloudsearch/api_op_UpdateServiceAccessPolicies.go @@ -63,6 +63,11 @@ func (c *Client) UpdateServiceAccessPolicies(ctx context.Context, params *Update // want to configure. type UpdateServiceAccessPoliciesInput struct { + // The access rules you want to configure. These rules replace any existing rules. + // + // This member is required. + AccessPolicies *string + // A string that represents the name of a domain. Domain names are unique across // the domains owned by an account within an AWS region. Domain names start with a // letter or number and can contain the following characters: a-z (lowercase), 0-9, @@ -70,11 +75,6 @@ type UpdateServiceAccessPoliciesInput struct { // // This member is required. DomainName *string - - // The access rules you want to configure. These rules replace any existing rules. - // - // This member is required. - AccessPolicies *string } // The result of an UpdateServiceAccessPolicies request. Contains the new access diff --git a/service/cloudsearch/go.mod b/service/cloudsearch/go.mod index 91416eee177..de6852b911f 100644 --- a/service/cloudsearch/go.mod +++ b/service/cloudsearch/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/cloudsearch go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/cloudsearch/types/types.go b/service/cloudsearch/types/types.go index 9b6dc79787e..57561ee070c 100644 --- a/service/cloudsearch/types/types.go +++ b/service/cloudsearch/types/types.go @@ -29,6 +29,19 @@ type AccessPoliciesStatus struct { // tokenization dictionary for Japanese. type AnalysisOptions struct { + // The level of algorithmic stemming to perform: none, minimal, light, or full. The + // available levels vary depending on the language. For more information, see + // Language Specific Text Processing Settings + // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings) + // in the Amazon CloudSearch Developer Guide + AlgorithmicStemming AlgorithmicStemming + + // A JSON array that contains a collection of terms, tokens, readings and part of + // speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables + // you to override the default tokenization for selected terms. This is only valid + // for Japanese language fields. + JapaneseTokenizationDictionary *string + // A JSON object that contains a collection of string:value pairs that each map a // term to its stem. For example, {"term1": "stem1", "term2": "stem2", "term3": // "stem3"}. The stemming dictionary is applied in addition to any algorithmic @@ -37,12 +50,10 @@ type AnalysisOptions struct { // a stemming dictionary is 500 KB. StemmingDictionary *string - // The level of algorithmic stemming to perform: none, minimal, light, or full. The - // available levels vary depending on the language. For more information, see - // Language Specific Text Processing Settings - // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings) - // in the Amazon CloudSearch Developer Guide - AlgorithmicStemming AlgorithmicStemming + // A JSON array of terms to ignore during indexing and searching. For example, + // ["a", "an", "the", "of"]. The stopwords dictionary must explicitly list each + // word you want to ignore. Wildcards and regular expressions are not supported. + Stopwords *string // A JSON object that defines synonym groups and aliases. A synonym group is an // array of arrays, where each sub-array is a group of terms where each term in the @@ -55,17 +66,6 @@ type AnalysisOptions struct { // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html#synonyms) // in the Amazon CloudSearch Developer Guide. Synonyms *string - - // A JSON array that contains a collection of terms, tokens, readings and part of - // speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables - // you to override the default tokenization for selected terms. This is only valid - // for Japanese language fields. - JapaneseTokenizationDictionary *string - - // A JSON array of terms to ignore during indexing and searching. For example, - // ["a", "an", "the", "of"]. The stopwords dictionary must explicitly list each - // word you want to ignore. Wildcards and regular expressions are not supported. - Stopwords *string } // Configuration information for an analysis scheme. Each analysis scheme has a @@ -94,11 +94,6 @@ type AnalysisScheme struct { // The status and configuration of an AnalysisScheme. type AnalysisSchemeStatus struct { - // The status of domain configuration option. - // - // This member is required. - Status *OptionStatus - // Configuration information for an analysis scheme. Each analysis scheme has a // unique name and specifies the language of the text to be processed. The // following options can be configured for an analysis scheme: Synonyms, Stopwords, @@ -106,6 +101,11 @@ type AnalysisSchemeStatus struct { // // This member is required. Options *AnalysisScheme + + // The status of domain configuration option. + // + // This member is required. + Status *OptionStatus } // The status and configuration of the domain's availability options. @@ -129,17 +129,17 @@ type DateArrayOptions struct { // A value to use for the field if the field isn't specified for a document. DefaultValue *string + // Whether facet information can be returned for the field. + FacetEnabled *bool + // Whether the contents of the field can be returned in the search results. ReturnEnabled *bool - // A list of source fields to map to the field. - SourceFields *string - // Whether the contents of the field are searchable. SearchEnabled *bool - // Whether facet information can be returned for the field. - FacetEnabled *bool + // A list of source fields to map to the field. + SourceFields *string } // Options for a date field. Dates and times are specified in UTC (Coordinated @@ -148,21 +148,21 @@ type DateArrayOptions struct { // default. type DateOptions struct { + // A value to use for the field if the field isn't specified for a document. + DefaultValue *string + // Whether facet information can be returned for the field. FacetEnabled *bool + // Whether the contents of the field can be returned in the search results. + ReturnEnabled *bool + // Whether the contents of the field are searchable. SearchEnabled *bool - // A value to use for the field if the field isn't specified for a document. - DefaultValue *string - // Whether the field can be used to sort the search results. SortEnabled *bool - // Whether the contents of the field can be returned in the search results. - ReturnEnabled *bool - // A string that represents the name of an index field. CloudSearch supports // regular index fields as well as dynamic fields. A dynamic field's name defines a // pattern that begins or ends with a wildcard. Any document fields that don't map @@ -205,11 +205,11 @@ type DocumentSuggesterOptions struct { // The domain's endpoint options. type DomainEndpointOptions struct { - // The minimum required TLS version - TLSSecurityPolicy TLSSecurityPolicy - // Whether the domain is HTTPS only enabled. EnforceHTTPS *bool + + // The minimum required TLS version + TLSSecurityPolicy TLSSecurityPolicy } // The configuration and status of the domain's endpoint options. @@ -229,62 +229,62 @@ type DomainEndpointOptionsStatus struct { // The current status of the search domain. type DomainStatus struct { + // An internally generated unique identifier for a domain. + // + // This member is required. + DomainId *string + + // A string that represents the name of a domain. Domain names are unique across + // the domains owned by an account within an AWS region. Domain names start with a + // letter or number and can contain the following characters: a-z (lowercase), 0-9, + // and - (hyphen). + // + // This member is required. + DomainName *string + // True if IndexDocuments () needs to be called to activate the current domain // configuration. // // This member is required. RequiresIndexDocuments *bool - // The instance type that is being used to process search requests. - SearchInstanceType *string - - // True if processing is being done to activate the current domain configuration. - Processing *bool - - // True if the search domain has been deleted. The system must clean up resources - // dedicated to the search domain when DeleteDomain () is called. Newly deleted - // search domains are returned from DescribeDomains () with a true value for - // IsDeleted for several minutes until resource cleanup is complete. - Deleted *bool - // The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM // Entities // (http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html) // in Using AWS Identity and Access Management for more information. ARN *string - // The number of search instances that are available to process search requests. - SearchInstanceCount *int32 - // True if the search domain is created. It can take several minutes to initialize // a domain when CreateDomain () is called. Newly created search domains are // returned from DescribeDomains () with a false value for Created until domain // creation is complete. Created *bool - // An internally generated unique identifier for a domain. - // - // This member is required. - DomainId *string + // True if the search domain has been deleted. The system must clean up resources + // dedicated to the search domain when DeleteDomain () is called. Newly deleted + // search domains are returned from DescribeDomains () with a true value for + // IsDeleted for several minutes until resource cleanup is complete. + Deleted *bool - // The service endpoint for requesting search results from a search domain. - SearchService *ServiceEndpoint + // The service endpoint for updating documents in a search domain. + DocService *ServiceEndpoint Limits *Limits + // True if processing is being done to activate the current domain configuration. + Processing *bool + + // The number of search instances that are available to process search requests. + SearchInstanceCount *int32 + + // The instance type that is being used to process search requests. + SearchInstanceType *string + // The number of partitions across which the search index is spread. SearchPartitionCount *int32 - // The service endpoint for updating documents in a search domain. - DocService *ServiceEndpoint - - // A string that represents the name of a domain. Domain names are unique across - // the domains owned by an account within an AWS region. Domain names start with a - // letter or number and can contain the following characters: a-z (lowercase), 0-9, - // and - (hyphen). - // - // This member is required. - DomainName *string + // The service endpoint for requesting search results from a search domain. + SearchService *ServiceEndpoint } // Options for a field that contains an array of double-precision 64-bit floating @@ -292,20 +292,20 @@ type DomainStatus struct { // double-array. All options are enabled by default. type DoubleArrayOptions struct { + // A value to use for the field if the field isn't specified for a document. + DefaultValue *float64 + // Whether facet information can be returned for the field. FacetEnabled *bool - // A list of source fields to map to the field. - SourceFields *string + // Whether the contents of the field can be returned in the search results. + ReturnEnabled *bool // Whether the contents of the field are searchable. SearchEnabled *bool - // A value to use for the field if the field isn't specified for a document. - DefaultValue *float64 - - // Whether the contents of the field can be returned in the search results. - ReturnEnabled *bool + // A list of source fields to map to the field. + SourceFields *string } // Options for a double-precision 64-bit floating point field. Present if @@ -313,14 +313,10 @@ type DoubleArrayOptions struct { // default. type DoubleOptions struct { - // Whether the contents of the field are searchable. - SearchEnabled *bool - - // The name of the source field to map to the field. - SourceField *string - - // Whether the field can be used to sort the search results. - SortEnabled *bool + // A value to use for the field if the field isn't specified for a document. This + // can be important if you are using the field in an expression and that field is + // not present in every document. + DefaultValue *float64 // Whether facet information can be returned for the field. FacetEnabled *bool @@ -328,10 +324,14 @@ type DoubleOptions struct { // Whether the contents of the field can be returned in the search results. ReturnEnabled *bool - // A value to use for the field if the field isn't specified for a document. This - // can be important if you are using the field in an expression and that field is - // not present in every document. - DefaultValue *float64 + // Whether the contents of the field are searchable. + SearchEnabled *bool + + // Whether the field can be used to sort the search results. + SortEnabled *bool + + // The name of the source field to map to the field. + SourceField *string } // A named expression that can be evaluated at search time. Can be used to sort the @@ -339,6 +339,12 @@ type DoubleOptions struct { // search results. type Expression struct { + // Names must begin with a letter and can contain the following characters: a-z + // (lowercase), 0-9, and _ (underscore). + // + // This member is required. + ExpressionName *string + // The expression to evaluate for sorting while processing a search request. The // Expression syntax is based on JavaScript expressions. For more information, see // Configuring Expressions @@ -347,55 +353,26 @@ type Expression struct { // // This member is required. ExpressionValue *string - - // Names must begin with a letter and can contain the following characters: a-z - // (lowercase), 0-9, and _ (underscore). - // - // This member is required. - ExpressionName *string } // The value of an Expression and its current status. type ExpressionStatus struct { - // The status of domain configuration option. + // The expression that is evaluated for sorting while processing a search request. // // This member is required. - Status *OptionStatus + Options *Expression - // The expression that is evaluated for sorting while processing a search request. + // The status of domain configuration option. // // This member is required. - Options *Expression + Status *OptionStatus } // Configuration information for a field in the index, including its name, type, // and options. The supported options depend on the IndexFieldType (). type IndexField struct { - // Options for a double-precision 64-bit floating point field. Present if - // IndexFieldType specifies the field is of type double. All options are enabled by - // default. - DoubleOptions *DoubleOptions - - // Options for a field that contains an array of double-precision 64-bit floating - // point values. Present if IndexFieldType specifies the field is of type - // double-array. All options are enabled by default. - DoubleArrayOptions *DoubleArrayOptions - - // Options for a latlon field. A latlon field contains a location stored as a - // latitude and longitude value pair. Present if IndexFieldType specifies the field - // is of type latlon. All options are enabled by default. - LatLonOptions *LatLonOptions - - // Options for literal field. Present if IndexFieldType specifies the field is of - // type literal. All options are enabled by default. - LiteralOptions *LiteralOptions - - // Options for a field that contains an array of dates. Present if IndexFieldType - // specifies the field is of type date-array. All options are enabled by default. - DateArrayOptions *DateArrayOptions - // A string that represents the name of an index field. CloudSearch supports // regular index fields as well as dynamic fields. A dynamic field's name defines a // pattern that begins or ends with a wildcard. Any document fields that don't map @@ -411,42 +388,65 @@ type IndexField struct { // This member is required. IndexFieldName *string + // The type of field. The valid options for a field depend on the field type. For + // more information about the supported field types, see Configuring Index Fields + // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html) + // in the Amazon CloudSearch Developer Guide. + // + // This member is required. + IndexFieldType IndexFieldType + + // Options for a field that contains an array of dates. Present if IndexFieldType + // specifies the field is of type date-array. All options are enabled by default. + DateArrayOptions *DateArrayOptions + // Options for a date field. Dates and times are specified in UTC (Coordinated // Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if // IndexFieldType specifies the field is of type date. All options are enabled by // default. DateOptions *DateOptions - // Options for a 64-bit signed integer field. Present if IndexFieldType specifies - // the field is of type int. All options are enabled by default. - IntOptions *IntOptions + // Options for a field that contains an array of double-precision 64-bit floating + // point values. Present if IndexFieldType specifies the field is of type + // double-array. All options are enabled by default. + DoubleArrayOptions *DoubleArrayOptions - // Options for text field. Present if IndexFieldType specifies the field is of type - // text. A text field is always searchable. All options are enabled by default. - TextOptions *TextOptions + // Options for a double-precision 64-bit floating point field. Present if + // IndexFieldType specifies the field is of type double. All options are enabled by + // default. + DoubleOptions *DoubleOptions // Options for a field that contains an array of 64-bit signed integers. Present if // IndexFieldType specifies the field is of type int-array. All options are enabled // by default. IntArrayOptions *IntArrayOptions - // Options for a field that contains an array of text strings. Present if - // IndexFieldType specifies the field is of type text-array. A text-array field is - // always searchable. All options are enabled by default. - TextArrayOptions *TextArrayOptions + // Options for a 64-bit signed integer field. Present if IndexFieldType specifies + // the field is of type int. All options are enabled by default. + IntOptions *IntOptions - // The type of field. The valid options for a field depend on the field type. For - // more information about the supported field types, see Configuring Index Fields - // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html) - // in the Amazon CloudSearch Developer Guide. - // - // This member is required. - IndexFieldType IndexFieldType + // Options for a latlon field. A latlon field contains a location stored as a + // latitude and longitude value pair. Present if IndexFieldType specifies the field + // is of type latlon. All options are enabled by default. + LatLonOptions *LatLonOptions // Options for a field that contains an array of literal strings. Present if // IndexFieldType specifies the field is of type literal-array. All options are // enabled by default. LiteralArrayOptions *LiteralArrayOptions + + // Options for literal field. Present if IndexFieldType specifies the field is of + // type literal. All options are enabled by default. + LiteralOptions *LiteralOptions + + // Options for a field that contains an array of text strings. Present if + // IndexFieldType specifies the field is of type text-array. A text-array field is + // always searchable. All options are enabled by default. + TextArrayOptions *TextArrayOptions + + // Options for text field. Present if IndexFieldType specifies the field is of type + // text. A text field is always searchable. All options are enabled by default. + TextOptions *TextOptions } // The value of an IndexField and its current status. @@ -469,43 +469,43 @@ type IndexFieldStatus struct { // by default. type IntArrayOptions struct { - // Whether the contents of the field are searchable. - SearchEnabled *bool + // A value to use for the field if the field isn't specified for a document. + DefaultValue *int64 // Whether facet information can be returned for the field. FacetEnabled *bool - // A value to use for the field if the field isn't specified for a document. - DefaultValue *int64 + // Whether the contents of the field can be returned in the search results. + ReturnEnabled *bool + + // Whether the contents of the field are searchable. + SearchEnabled *bool // A list of source fields to map to the field. SourceFields *string - - // Whether the contents of the field can be returned in the search results. - ReturnEnabled *bool } // Options for a 64-bit signed integer field. Present if IndexFieldType specifies // the field is of type int. All options are enabled by default. type IntOptions struct { - // Whether the field can be used to sort the search results. - SortEnabled *bool - - // Whether facet information can be returned for the field. - FacetEnabled *bool - - // Whether the contents of the field are searchable. - SearchEnabled *bool - // A value to use for the field if the field isn't specified for a document. This // can be important if you are using the field in an expression and that field is // not present in every document. DefaultValue *int64 + // Whether facet information can be returned for the field. + FacetEnabled *bool + // Whether the contents of the field can be returned in the search results. ReturnEnabled *bool + // Whether the contents of the field are searchable. + SearchEnabled *bool + + // Whether the field can be used to sort the search results. + SortEnabled *bool + // The name of the source field to map to the field. SourceField *string } @@ -515,18 +515,21 @@ type IntOptions struct { // is of type latlon. All options are enabled by default. type LatLonOptions struct { - // Whether the field can be used to sort the search results. - SortEnabled *bool - // A value to use for the field if the field isn't specified for a document. DefaultValue *string + // Whether facet information can be returned for the field. + FacetEnabled *bool + // Whether the contents of the field can be returned in the search results. ReturnEnabled *bool // Whether the contents of the field are searchable. SearchEnabled *bool + // Whether the field can be used to sort the search results. + SortEnabled *bool + // A string that represents the name of an index field. CloudSearch supports // regular index fields as well as dynamic fields. A dynamic field's name defines a // pattern that begins or ends with a wildcard. Any document fields that don't map @@ -539,15 +542,12 @@ type LatLonOptions struct { // score is reserved and cannot be used as a field name. To reference a document's // ID, you can use the name _id. SourceField *string - - // Whether facet information can be returned for the field. - FacetEnabled *bool } type Limits struct { - MaximumReplicationCount *int32 - MaximumPartitionCount *int32 + + MaximumReplicationCount *int32 } // Options for a field that contains an array of literal strings. Present if @@ -555,18 +555,18 @@ type Limits struct { // enabled by default. type LiteralArrayOptions struct { - // Whether the contents of the field are searchable. - SearchEnabled *bool + // A value to use for the field if the field isn't specified for a document. + DefaultValue *string // Whether facet information can be returned for the field. FacetEnabled *bool - // A value to use for the field if the field isn't specified for a document. - DefaultValue *string - // Whether the contents of the field can be returned in the search results. ReturnEnabled *bool + // Whether the contents of the field are searchable. + SearchEnabled *bool + // A list of source fields to map to the field. SourceFields *string } @@ -575,15 +575,21 @@ type LiteralArrayOptions struct { // type literal. All options are enabled by default. type LiteralOptions struct { - // Whether the field can be used to sort the search results. - SortEnabled *bool + // A value to use for the field if the field isn't specified for a document. + DefaultValue *string // Whether facet information can be returned for the field. FacetEnabled *bool + // Whether the contents of the field can be returned in the search results. + ReturnEnabled *bool + // Whether the contents of the field are searchable. SearchEnabled *bool + // Whether the field can be used to sort the search results. + SortEnabled *bool + // A string that represents the name of an index field. CloudSearch supports // regular index fields as well as dynamic fields. A dynamic field's name defines a // pattern that begins or ends with a wildcard. Any document fields that don't map @@ -596,12 +602,6 @@ type LiteralOptions struct { // score is reserved and cannot be used as a field name. To reference a document's // ID, you can use the name _id. SourceField *string - - // A value to use for the field if the field isn't specified for a document. - DefaultValue *string - - // Whether the contents of the field can be returned in the search results. - ReturnEnabled *bool } // The status of domain configuration option. @@ -612,12 +612,6 @@ type OptionStatus struct { // This member is required. CreationDate *time.Time - // A unique integer that indicates when this option was last updated. - UpdateVersion *int32 - - // Indicates that the option will be deleted once processing is complete. - PendingDeletion *bool - // The state of processing a change to an option. Possible values: // // * @@ -642,22 +636,28 @@ type OptionStatus struct { // // This member is required. UpdateDate *time.Time + + // Indicates that the option will be deleted once processing is complete. + PendingDeletion *bool + + // A unique integer that indicates when this option was last updated. + UpdateVersion *int32 } // The desired instance type and desired number of replicas of each index // partition. type ScalingParameters struct { - // The number of replicas you want to preconfigure for each index partition. - DesiredReplicationCount *int32 + // The instance type that you want to preconfigure for your domain. For example, + // search.m1.small. + DesiredInstanceType PartitionInstanceType // The number of partitions you want to preconfigure for your domain. Only valid // when you select m2.2xlarge as the desired instance type. DesiredPartitionCount *int32 - // The instance type that you want to preconfigure for your domain. For example, - // search.m1.small. - DesiredInstanceType PartitionInstanceType + // The number of replicas you want to preconfigure for each index partition. + DesiredReplicationCount *int32 } // The status and configuration of a search domain's scaling parameters. @@ -690,16 +690,16 @@ type ServiceEndpoint struct { // options can be configured for a suggester: FuzzyMatching, SortExpression. type Suggester struct { - // Names must begin with a letter and can contain the following characters: a-z - // (lowercase), 0-9, and _ (underscore). + // Options for a search suggester. // // This member is required. - SuggesterName *string + DocumentSuggesterOptions *DocumentSuggesterOptions - // Options for a search suggester. + // Names must begin with a letter and can contain the following characters: a-z + // (lowercase), 0-9, and _ (underscore). // // This member is required. - DocumentSuggesterOptions *DocumentSuggesterOptions + SuggesterName *string } // The value of a Suggester and its current status. @@ -723,38 +723,41 @@ type SuggesterStatus struct { // always searchable. All options are enabled by default. type TextArrayOptions struct { - // Whether the contents of the field can be returned in the search results. - ReturnEnabled *bool + // The name of an analysis scheme for a text-array field. + AnalysisScheme *string // A value to use for the field if the field isn't specified for a document. DefaultValue *string - // A list of source fields to map to the field. - SourceFields *string - // Whether highlights can be returned for the field. HighlightEnabled *bool - // The name of an analysis scheme for a text-array field. - AnalysisScheme *string + // Whether the contents of the field can be returned in the search results. + ReturnEnabled *bool + + // A list of source fields to map to the field. + SourceFields *string } // Options for text field. Present if IndexFieldType specifies the field is of type // text. A text field is always searchable. All options are enabled by default. type TextOptions struct { + // The name of an analysis scheme for a text field. + AnalysisScheme *string + + // A value to use for the field if the field isn't specified for a document. + DefaultValue *string + + // Whether highlights can be returned for the field. + HighlightEnabled *bool + // Whether the contents of the field can be returned in the search results. ReturnEnabled *bool // Whether the field can be used to sort the search results. SortEnabled *bool - // A value to use for the field if the field isn't specified for a document. - DefaultValue *string - - // The name of an analysis scheme for a text field. - AnalysisScheme *string - // A string that represents the name of an index field. CloudSearch supports // regular index fields as well as dynamic fields. A dynamic field's name defines a // pattern that begins or ends with a wildcard. Any document fields that don't map @@ -767,7 +770,4 @@ type TextOptions struct { // score is reserved and cannot be used as a field name. To reference a document's // ID, you can use the name _id. SourceField *string - - // Whether highlights can be returned for the field. - HighlightEnabled *bool } diff --git a/service/cloudsearchdomain/api_op_Search.go b/service/cloudsearchdomain/api_op_Search.go index 1458260dd4d..1f827b4da7c 100644 --- a/service/cloudsearchdomain/api_op_Search.go +++ b/service/cloudsearchdomain/api_op_Search.go @@ -84,12 +84,6 @@ func (c *Client) Search(ctx context.Context, params *SearchInput, optFns ...func // Container for the parameters to the Search request. type SearchInput struct { - // Specifies one or more fields for which to get statistics information. Each - // specified field must be facet-enabled in the domain configuration. The fields - // are specified in JSON using the form: {"FIELD-A":{},"FIELD-B":{}} There are - // currently no options supported for statistics. - Stats *string - // Specifies the search criteria for the request. How you specify the search // criteria depends on the query parser used for the request and the parser options // specified in the queryOptions parameter. By default, the simple query parser is @@ -102,52 +96,6 @@ type SearchInput struct { // This member is required. Query *string - // Specifies which query parser to use to process the request. If queryParser is - // not specified, Amazon CloudSearch uses the simple query parser. Amazon - // CloudSearch supports four query parsers: - // - // * simple: perform simple searches - // of text and text-array fields. By default, the simple query parser searches all - // text and text-array fields. You can specify which fields to search by with the - // queryOptions parameter. If you prefix a search term with a plus sign (+) - // documents must contain the term to be considered a match. (This is the default, - // unless you configure the default operator with the queryOptions parameter.) You - // can use the - (NOT), | (OR), and * (wildcard) operators to exclude particular - // terms, find results that match any of the specified terms, or search for a - // prefix. To search for a phrase rather than individual terms, enclose the phrase - // in double quotes. For more information, see Searching for Text - // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-text.html) - // in the Amazon CloudSearch Developer Guide. - // - // * structured: perform advanced - // searches by combining multiple expressions to define the search criteria. You - // can also search within particular fields, search for values and ranges of - // values, and use advanced options such as term boosting, matchall, and near. For - // more information, see Constructing Compound Queries - // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-compound-queries.html) - // in the Amazon CloudSearch Developer Guide. - // - // * lucene: search using the - // Apache Lucene query parser syntax. For more information, see Apache Lucene Query - // Parser Syntax - // (http://lucene.apache.org/core/4_6_0/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description). - // - // - // * dismax: search using the simplified subset of the Apache Lucene query parser - // syntax defined by the DisMax query parser. For more information, see DisMax - // Query Parser Syntax - // (http://wiki.apache.org/solr/DisMaxQParserPlugin#Query_Syntax). - // - QueryParser types.QueryParser - - // Specifies the offset of the first search hit you want to return. Note that the - // result set is zero-based; the first result is at index 0. You can specify either - // the start or cursor parameter in a request, they are mutually exclusive. For - // more information, see Paginating Results - // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html) - // in the Amazon CloudSearch Developer Guide. - Start *int64 - // Retrieves a cursor value you can use to page through large result sets. Use the // size parameter to control the number of hits to include in each response. You // can specify either the cursor or start parameter in a request; they are mutually @@ -158,18 +106,6 @@ type SearchInput struct { // in the Amazon CloudSearch Developer Guide. Cursor *string - // Specifies the fields or custom expressions to use to sort the search results. - // Multiple fields or expressions are specified as a comma-separated list. You must - // specify the sort direction (asc or desc) for each field; for example, year - // desc,title asc. To use a field to sort results, the field must be sort-enabled - // in the domain configuration. Array type fields cannot be used for sorting. If no - // sort parameter is specified, results are sorted by their default relevance - // scores in descending order: _score desc. You can also sort by document ID (_id - // asc) and version (_version desc). For more information, see Sorting Results - // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/sorting-results.html) - // in the Amazon CloudSearch Developer Guide. - Sort *string - // Defines one or more numeric expressions that can be used to sort results or // specify search criteria. You can also specify expressions as return fields. You // specify the expressions in JSON using the form {"EXPRESSIONNAME":"EXPRESSION"}. @@ -181,6 +117,111 @@ type SearchInput struct { // in the Amazon CloudSearch Developer Guide. Expr *string + // Specifies one or more fields for which to get facet information, and options + // that control how the facet information is returned. Each specified field must be + // facet-enabled in the domain configuration. The fields and options are specified + // in JSON using the form + // {"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}. + // You can specify the following faceting options: + // + // * buckets specifies an + // array of the facet values or ranges to count. Ranges are specified using the + // same syntax that you use to search for a range of values. For more information, + // see Searching for a Range of Values + // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-ranges.html) + // in the Amazon CloudSearch Developer Guide. Buckets are returned in the order + // they are specified in the request. The sort and size options are not valid if + // you specify buckets. + // + // * size specifies the maximum number of facets to + // include in the results. By default, Amazon CloudSearch returns counts for the + // top 10. The size parameter is only valid when you specify the sort option; it + // cannot be used in conjunction with buckets. + // + // * sort specifies how you want + // to sort the facets in the results: bucket or count. Specify bucket to sort + // alphabetically or numerically by facet value (in ascending order). Specify count + // to sort by the facet counts computed for each facet value (in descending order). + // To retrieve facet counts for particular values or ranges of values, use the + // buckets option instead of sort. + // + // If no facet options are specified, facet counts + // are computed for all field values, the facets are sorted by facet count, and the + // top 10 facets are returned in the results.

    To count particular buckets of + // values, use the buckets option. For example, the following request + // uses the buckets option to calculate and return facet counts by + // decade.

    + // {"year":{"buckets":["[1970,1979]","[1980,1989]","[1990,1999]","[2000,2009]","[2010,}"]}} + //

    To sort facets by facet count, use the count option. + // For example, the following request sets the sort option to + // count to sort the facet values by facet count, with the facet + // values that have the most matching documents listed first. Setting the + // size option to 3 returns only the top three facet values.

    + //

    {"year":{"sort":"count","size":3}}

    To sort the facets + // by value, use the bucket option. For example, the following request + // sets the sort option to bucket to sort the facet + // values numerically by year, with earliest year listed first.

    + // {"year":{"sort":"bucket"}}

    For more information, see Getting + // and Using Facet Information in the Amazon CloudSearch Developer + // Guide.

    + Facet *string + + // Specifies a structured query that filters the results of a search without + // affecting how the results are scored and sorted. You use filterQuery in + // conjunction with the query parameter to filter the documents that match the + // constraints specified in the query parameter. Specifying a filter controls only + // which matching documents are included in the results, it has no effect on how + // they are scored and sorted. The filterQuery parameter supports the full + // structured query syntax. For more information about using filters, see Filtering + // Matching Documents + // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/filtering-results.html) + // in the Amazon CloudSearch Developer Guide. + FilterQuery *string + + // Retrieves highlights for matches in the specified text or text-array fields. + // Each specified field must be highlight enabled in the domain configuration. The + // fields and options are specified in JSON using the form + // {"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}. + // You can specify the following highlight options: + // + // * format: specifies the + // format of the data in the text field: text or html. When data is returned as + // HTML, all non-alphanumeric characters are encoded. The default is html. + // + // * + // max_phrases: specifies the maximum number of occurrences of the search term(s) + // you want to highlight. By default, the first occurrence is highlighted. + // + // * + // pre_tag: specifies the string to prepend to an occurrence of a search term. The + // default for HTML highlights is . The default for text highlights is *. + // + // + // * post_tag: specifies the string to append to an occurrence of a search term. + // The default for HTML highlights is . The default for text highlights is + // *. + // + // If no highlight options are specified for a field, the returned field text + // is treated as HTML and the first match is highlighted with emphasis tags: + // search-term. For example, the following request retrieves highlights + // for the actors and title fields. { "actors": {}, "title": {"format": + // "text","max_phrases": 2,"pre_tag": "","post_tag": ""} } + Highlight *string + + // Enables partial results to be returned if one or more index partitions are + // unavailable. When your search index is partitioned across multiple search + // instances, by default Amazon CloudSearch only returns results if every partition + // can be queried. This means that the failure of a single search instance can + // result in 5xx (internal server) errors. When you enable partial results, Amazon + // CloudSearch returns whatever results are available and includes the percentage + // of documents searched in the search results (percent-searched). This enables you + // to more gracefully degrade your users' search experience. For example, rather + // than displaying no results, you could display the partial results and a message + // indicating that the results might be incomplete due to a temporary system + // outage. + Partial *bool + // Configures options for the query parser specified in the queryParser parameter. // You specify the options in JSON using the following form // {"OPTION1":"VALUE1","OPTION2":VALUE2"..."OPTIONN":"VALUEN"}. @@ -274,100 +315,43 @@ type SearchInput struct { // Default: 0.0. Valid for: dismax. QueryOptions *string - // Specifies one or more fields for which to get facet information, and options - // that control how the facet information is returned. Each specified field must be - // facet-enabled in the domain configuration. The fields and options are specified - // in JSON using the form - // {"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}. - // You can specify the following faceting options: - // - // * buckets specifies an - // array of the facet values or ranges to count. Ranges are specified using the - // same syntax that you use to search for a range of values. For more information, - // see Searching for a Range of Values - // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-ranges.html) - // in the Amazon CloudSearch Developer Guide. Buckets are returned in the order - // they are specified in the request. The sort and size options are not valid if - // you specify buckets. - // - // * size specifies the maximum number of facets to - // include in the results. By default, Amazon CloudSearch returns counts for the - // top 10. The size parameter is only valid when you specify the sort option; it - // cannot be used in conjunction with buckets. - // - // * sort specifies how you want - // to sort the facets in the results: bucket or count. Specify bucket to sort - // alphabetically or numerically by facet value (in ascending order). Specify count - // to sort by the facet counts computed for each facet value (in descending order). - // To retrieve facet counts for particular values or ranges of values, use the - // buckets option instead of sort. - // - // If no facet options are specified, facet counts - // are computed for all field values, the facets are sorted by facet count, and the - // top 10 facets are returned in the results.

    To count particular buckets of - // values, use the buckets option. For example, the following request - // uses the buckets option to calculate and return facet counts by - // decade.

    - // {"year":{"buckets":["[1970,1979]","[1980,1989]","[1990,1999]","[2000,2009]","[2010,}"]}} - //

    To sort facets by facet count, use the count option. - // For example, the following request sets the sort option to - // count to sort the facet values by facet count, with the facet - // values that have the most matching documents listed first. Setting the - // size option to 3 returns only the top three facet values.

    - //

    {"year":{"sort":"count","size":3}}

    To sort the facets - // by value, use the bucket option. For example, the following request - // sets the sort option to bucket to sort the facet - // values numerically by year, with earliest year listed first.

    - // {"year":{"sort":"bucket"}}

    For more information, see Getting - // and Using Facet Information in the Amazon CloudSearch Developer - // Guide.

    - Facet *string - - // Specifies the maximum number of search hits to include in the response. - Size *int64 - - // Retrieves highlights for matches in the specified text or text-array fields. - // Each specified field must be highlight enabled in the domain configuration. The - // fields and options are specified in JSON using the form - // {"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}. - // You can specify the following highlight options: - // - // * format: specifies the - // format of the data in the text field: text or html. When data is returned as - // HTML, all non-alphanumeric characters are encoded. The default is html. + // Specifies which query parser to use to process the request. If queryParser is + // not specified, Amazon CloudSearch uses the simple query parser. Amazon + // CloudSearch supports four query parsers: // - // * - // max_phrases: specifies the maximum number of occurrences of the search term(s) - // you want to highlight. By default, the first occurrence is highlighted. + // * simple: perform simple searches + // of text and text-array fields. By default, the simple query parser searches all + // text and text-array fields. You can specify which fields to search by with the + // queryOptions parameter. If you prefix a search term with a plus sign (+) + // documents must contain the term to be considered a match. (This is the default, + // unless you configure the default operator with the queryOptions parameter.) You + // can use the - (NOT), | (OR), and * (wildcard) operators to exclude particular + // terms, find results that match any of the specified terms, or search for a + // prefix. To search for a phrase rather than individual terms, enclose the phrase + // in double quotes. For more information, see Searching for Text + // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-text.html) + // in the Amazon CloudSearch Developer Guide. // - // * - // pre_tag: specifies the string to prepend to an occurrence of a search term. The - // default for HTML highlights is . The default for text highlights is *. + // * structured: perform advanced + // searches by combining multiple expressions to define the search criteria. You + // can also search within particular fields, search for values and ranges of + // values, and use advanced options such as term boosting, matchall, and near. For + // more information, see Constructing Compound Queries + // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-compound-queries.html) + // in the Amazon CloudSearch Developer Guide. // + // * lucene: search using the + // Apache Lucene query parser syntax. For more information, see Apache Lucene Query + // Parser Syntax + // (http://lucene.apache.org/core/4_6_0/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description). // - // * post_tag: specifies the string to append to an occurrence of a search term. - // The default for HTML highlights is . The default for text highlights is - // *. // - // If no highlight options are specified for a field, the returned field text - // is treated as HTML and the first match is highlighted with emphasis tags: - // search-term. For example, the following request retrieves highlights - // for the actors and title fields. { "actors": {}, "title": {"format": - // "text","max_phrases": 2,"pre_tag": "","post_tag": ""} } - Highlight *string - - // Specifies a structured query that filters the results of a search without - // affecting how the results are scored and sorted. You use filterQuery in - // conjunction with the query parameter to filter the documents that match the - // constraints specified in the query parameter. Specifying a filter controls only - // which matching documents are included in the results, it has no effect on how - // they are scored and sorted. The filterQuery parameter supports the full - // structured query syntax. For more information about using filters, see Filtering - // Matching Documents - // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/filtering-results.html) - // in the Amazon CloudSearch Developer Guide. - FilterQuery *string + // * dismax: search using the simplified subset of the Apache Lucene query parser + // syntax defined by the DisMax query parser. For more information, see DisMax + // Query Parser Syntax + // (http://wiki.apache.org/solr/DisMaxQParserPlugin#Query_Syntax). + // + QueryParser types.QueryParser // Specifies the field and expression values to include in the response. Multiple // fields or expressions are specified as a comma-separated list. By default, a @@ -376,18 +360,34 @@ type SearchInput struct { // relevance score calculated for each document, specify _score. Return *string - // Enables partial results to be returned if one or more index partitions are - // unavailable. When your search index is partitioned across multiple search - // instances, by default Amazon CloudSearch only returns results if every partition - // can be queried. This means that the failure of a single search instance can - // result in 5xx (internal server) errors. When you enable partial results, Amazon - // CloudSearch returns whatever results are available and includes the percentage - // of documents searched in the search results (percent-searched). This enables you - // to more gracefully degrade your users' search experience. For example, rather - // than displaying no results, you could display the partial results and a message - // indicating that the results might be incomplete due to a temporary system - // outage. - Partial *bool + // Specifies the maximum number of search hits to include in the response. + Size *int64 + + // Specifies the fields or custom expressions to use to sort the search results. + // Multiple fields or expressions are specified as a comma-separated list. You must + // specify the sort direction (asc or desc) for each field; for example, year + // desc,title asc. To use a field to sort results, the field must be sort-enabled + // in the domain configuration. Array type fields cannot be used for sorting. If no + // sort parameter is specified, results are sorted by their default relevance + // scores in descending order: _score desc. You can also sort by document ID (_id + // asc) and version (_version desc). For more information, see Sorting Results + // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/sorting-results.html) + // in the Amazon CloudSearch Developer Guide. + Sort *string + + // Specifies the offset of the first search hit you want to return. Note that the + // result set is zero-based; the first result is at index 0. You can specify either + // the start or cursor parameter in a request, they are mutually exclusive. For + // more information, see Paginating Results + // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html) + // in the Amazon CloudSearch Developer Guide. + Start *int64 + + // Specifies one or more fields for which to get statistics information. Each + // specified field must be facet-enabled in the domain configuration. The fields + // are specified in JSON using the form: {"FIELD-A":{},"FIELD-B":{}} There are + // currently no options supported for statistics. + Stats *string } // The result of a Search request. Contains the documents that match the specified @@ -397,15 +397,15 @@ type SearchOutput struct { // The requested facet information. Facets map[string]*types.BucketInfo + // The documents that match the search criteria. + Hits *types.Hits + // The requested field statistics information. Stats map[string]*types.FieldStats // The status information returned for the search request. Status *types.SearchStatus - // The documents that match the search criteria. - Hits *types.Hits - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudsearchdomain/api_op_Suggest.go b/service/cloudsearchdomain/api_op_Suggest.go index c49d60dba7b..ea23b174bd7 100644 --- a/service/cloudsearchdomain/api_op_Suggest.go +++ b/service/cloudsearchdomain/api_op_Suggest.go @@ -78,25 +78,25 @@ type SuggestInput struct { // This member is required. Query *string - // Specifies the maximum number of suggestions to return. - Size *int64 - // Specifies the name of the suggester to use to find suggested matches. // // This member is required. Suggester *string + + // Specifies the maximum number of suggestions to return. + Size *int64 } // Contains the response to a Suggest request. type SuggestOutput struct { - // Container for the matching search suggestion information. - Suggest *types.SuggestModel - // The status of a SuggestRequest. Contains the resource ID (rid) and how long it // took to process the request (timems). Status *types.SuggestStatus + // Container for the matching search suggestion information. + Suggest *types.SuggestModel + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudsearchdomain/api_op_UploadDocuments.go b/service/cloudsearchdomain/api_op_UploadDocuments.go index d236fbe3a47..839be7af2f4 100644 --- a/service/cloudsearchdomain/api_op_UploadDocuments.go +++ b/service/cloudsearchdomain/api_op_UploadDocuments.go @@ -79,11 +79,6 @@ func (c *Client) UploadDocuments(ctx context.Context, params *UploadDocumentsInp // Container for the parameters to the UploadDocuments request. type UploadDocumentsInput struct { - // A batch of documents formatted in JSON or HTML. - // - // This member is required. - Documents io.Reader - // The format of the batch you are uploading. Amazon CloudSearch supports two // document batch formats: // @@ -93,24 +88,29 @@ type UploadDocumentsInput struct { // // This member is required. ContentType types.ContentType + + // A batch of documents formatted in JSON or HTML. + // + // This member is required. + Documents io.Reader } // Contains the response to an UploadDocuments request. type UploadDocumentsOutput struct { - // Any warnings returned by the document service about the documents being - // uploaded. - Warnings []*types.DocumentServiceWarning - - // The status of an UploadDocumentsRequest. - Status *string - // The number of documents that were added to the search domain. Adds *int64 // The number of documents that were deleted from the search domain. Deletes *int64 + // The status of an UploadDocumentsRequest. + Status *string + + // Any warnings returned by the document service about the documents being + // uploaded. + Warnings []*types.DocumentServiceWarning + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudsearchdomain/go.mod b/service/cloudsearchdomain/go.mod index da573444724..66119e634ac 100644 --- a/service/cloudsearchdomain/go.mod +++ b/service/cloudsearchdomain/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/cloudsearchdomain go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/cloudsearchdomain/types/types.go b/service/cloudsearchdomain/types/types.go index 6803420bc0c..d6090c58724 100644 --- a/service/cloudsearchdomain/types/types.go +++ b/service/cloudsearchdomain/types/types.go @@ -30,6 +30,10 @@ type DocumentServiceWarning struct { // The statistics for a field calculated in the request. type FieldStats struct { + // The number of documents that contain a value in the specified field in the + // result set. + Count *int64 + // The maximum value found in the specified field in the result set. If the field // is numeric (int, int-array, double, or double-array), max is the string // representation of a double-precision 64-bit floating point value. If the field @@ -38,9 +42,6 @@ type FieldStats struct { // yyyy-mm-ddTHH:mm:ss.SSSZ. Max *string - // The standard deviation of the values in the specified field in the result set. - Stddev *float64 - // The average of the values found in the specified field in the result set. If the // field is numeric (int, int-array, double, or double-array), mean is the string // representation of a double-precision 64-bit floating point value. If the field @@ -49,21 +50,6 @@ type FieldStats struct { // yyyy-mm-ddTHH:mm:ss.SSSZ. Mean *string - // The sum of all field values in the result set squared. - SumOfSquares *float64 - - // The sum of the field values across the documents in the result set. null for - // date fields. - Sum *float64 - - // The number of documents that contain a value in the specified field in the - // result set. - Count *int64 - - // The number of documents that do not contain a value in the specified field in - // the result set. - Missing *int64 - // The minimum value found in the specified field in the result set. If the field // is numeric (int, int-array, double, or double-array), min is the string // representation of a double-precision 64-bit floating point value. If the field @@ -71,50 +57,64 @@ type FieldStats struct { // format specified in IETF RFC3339 (http://tools.ietf.org/html/rfc3339): // yyyy-mm-ddTHH:mm:ss.SSSZ. Min *string + + // The number of documents that do not contain a value in the specified field in + // the result set. + Missing *int64 + + // The standard deviation of the values in the specified field in the result set. + Stddev *float64 + + // The sum of the field values across the documents in the result set. null for + // date fields. + Sum *float64 + + // The sum of all field values in the result set squared. + SumOfSquares *float64 } // Information about a document that matches the search request. type Hit struct { - // The highlights returned from a document that matches the search request. - Highlights map[string]*string + // The expressions returned from a document that matches the search request. + Exprs map[string]*string // The fields returned from a document that matches the search request. Fields map[string][]*string + // The highlights returned from a document that matches the search request. + Highlights map[string]*string + // The document ID of a document that matches the search request. Id *string - - // The expressions returned from a document that matches the search request. - Exprs map[string]*string } // The collection of documents that match the search request. type Hits struct { - // The index of the first matching document. - Start *int64 - // A cursor that can be used to retrieve the next set of matching documents when // you want to page through a large result set. Cursor *string + // The total number of documents that match the search request. + Found *int64 + // A document that matches the search request. Hit []*Hit - // The total number of documents that match the search request. - Found *int64 + // The index of the first matching document. + Start *int64 } // Contains the resource id (rid) and the time it took to process the request // (timems). type SearchStatus struct { - // How long it took to process the request, in milliseconds. - Timems *int64 - // The encrypted resource ID for the request. Rid *string + + // How long it took to process the request, in milliseconds. + Timems *int64 } // An autocomplete suggestion that matches the query string specified in a @@ -134,14 +134,14 @@ type SuggestionMatch struct { // Container for the suggestion information returned in a SuggestResponse. type SuggestModel struct { - // The documents that match the query string. - Suggestions []*SuggestionMatch + // The number of documents that were found to match the query string. + Found *int64 // The query string specified in the suggest request. Query *string - // The number of documents that were found to match the query string. - Found *int64 + // The documents that match the query string. + Suggestions []*SuggestionMatch } // Contains the resource id (rid) and the time it took to process the request diff --git a/service/cloudtrail/api_op_CreateTrail.go b/service/cloudtrail/api_op_CreateTrail.go index 982b26eba35..05208cefb6f 100644 --- a/service/cloudtrail/api_op_CreateTrail.go +++ b/service/cloudtrail/api_op_CreateTrail.go @@ -59,6 +59,27 @@ func (c *Client) CreateTrail(ctx context.Context, params *CreateTrailInput, optF // Specifies the settings for each trail. type CreateTrailInput struct { + // Specifies the name of the trail. The name must meet the following + // requirements: + // + // * Contain only ASCII letters (a-z, A-Z), numbers (0-9), + // periods (.), underscores (_), or dashes (-) + // + // * Start with a letter or + // number, and end with a letter or number + // + // * Be between 3 and 128 characters + // + // + // * Have no adjacent periods, underscores or dashes. Names like my-_namespace and + // my--namespace are invalid. + // + // * Not be in IP address format (for example, + // 192.168.5.4) + // + // This member is required. + Name *string + // Specifies the name of the Amazon S3 bucket designated for publishing log files. // See Amazon S3 Bucket Naming Requirements // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html). @@ -66,45 +87,15 @@ type CreateTrailInput struct { // This member is required. S3BucketName *string - // Specifies the name of the Amazon SNS topic defined for notification of log file - // delivery. The maximum length is 256 characters. - SnsTopicName *string - - // Specifies whether the trail is publishing events from global services such as - // IAM to the log files. - IncludeGlobalServiceEvents *bool + // Specifies a log group name using an Amazon Resource Name (ARN), a unique + // identifier that represents the log group to which CloudTrail logs will be + // delivered. Not required unless you specify CloudWatchLogsRoleArn. + CloudWatchLogsLogGroupArn *string // Specifies the role for the CloudWatch Logs endpoint to assume to write to a // user's log group. CloudWatchLogsRoleArn *string - // Specifies the Amazon S3 key prefix that comes after the name of the bucket you - // have designated for log file delivery. For more information, see Finding Your - // CloudTrail Log Files - // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html). - // The maximum length is 200 characters. - S3KeyPrefix *string - - // Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The - // value can be an alias name prefixed by "alias/", a fully specified ARN to an - // alias, a fully specified ARN to a key, or a globally unique identifier. - // Examples: - // - // * alias/MyAliasName - // - // * - // arn:aws:kms:us-east-2:123456789012:alias/MyAliasName - // - // * - // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 - // - // - // * 12345678-1234-1234-1234-123456789012 - KmsKeyId *string - - // A list of tags. - TagsList []*types.Tag - // Specifies whether log file integrity validation is enabled. The default is // false. When you disable log file integrity validation, the chain of digest files // is broken after one hour. CloudTrail will not create digest files for log files @@ -116,69 +107,72 @@ type CreateTrailInput struct { // logging or delete a trail. EnableLogFileValidation *bool + // Specifies whether the trail is publishing events from global services such as + // IAM to the log files. + IncludeGlobalServiceEvents *bool + // Specifies whether the trail is created in the current region or in all regions. // The default is false, which creates a trail only in the region where you are // signed in. As a best practice, consider creating trails that log events in all // regions. IsMultiRegionTrail *bool - // Specifies a log group name using an Amazon Resource Name (ARN), a unique - // identifier that represents the log group to which CloudTrail logs will be - // delivered. Not required unless you specify CloudWatchLogsRoleArn. - CloudWatchLogsLogGroupArn *string + // Specifies whether the trail is created for all accounts in an organization in + // AWS Organizations, or only for the current AWS account. The default is false, + // and cannot be true unless the call is made on behalf of an AWS account that is + // the master account for an organization in AWS Organizations. + IsOrganizationTrail *bool - // Specifies the name of the trail. The name must meet the following - // requirements: - // - // * Contain only ASCII letters (a-z, A-Z), numbers (0-9), - // periods (.), underscores (_), or dashes (-) - // - // * Start with a letter or - // number, and end with a letter or number + // Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The + // value can be an alias name prefixed by "alias/", a fully specified ARN to an + // alias, a fully specified ARN to a key, or a globally unique identifier. + // Examples: // - // * Be between 3 and 128 characters + // * alias/MyAliasName // + // * + // arn:aws:kms:us-east-2:123456789012:alias/MyAliasName // - // * Have no adjacent periods, underscores or dashes. Names like my-_namespace and - // my--namespace are invalid. + // * + // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 // - // * Not be in IP address format (for example, - // 192.168.5.4) // - // This member is required. - Name *string + // * 12345678-1234-1234-1234-123456789012 + KmsKeyId *string - // Specifies whether the trail is created for all accounts in an organization in - // AWS Organizations, or only for the current AWS account. The default is false, - // and cannot be true unless the call is made on behalf of an AWS account that is - // the master account for an organization in AWS Organizations. - IsOrganizationTrail *bool + // Specifies the Amazon S3 key prefix that comes after the name of the bucket you + // have designated for log file delivery. For more information, see Finding Your + // CloudTrail Log Files + // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html). + // The maximum length is 200 characters. + S3KeyPrefix *string + + // Specifies the name of the Amazon SNS topic defined for notification of log file + // delivery. The maximum length is 256 characters. + SnsTopicName *string + + // A list of tags. + TagsList []*types.Tag } // Returns the objects or data listed below if successful. Otherwise, returns an // error. type CreateTrailOutput struct { - // Specifies whether the trail exists in one region or in all regions. - IsMultiRegionTrail *bool - - // Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send - // notifications when log files are delivered. The format of a topic ARN is: - // arn:aws:sns:us-east-2:123456789012:MyTopic - SnsTopicARN *string - - // Specifies the name of the Amazon S3 bucket designated for publishing log files. - S3BucketName *string + // Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail + // logs will be delivered. + CloudWatchLogsLogGroupArn *string // Specifies the role for the CloudWatch Logs endpoint to assume to write to a // user's log group. CloudWatchLogsRoleArn *string - // This field is no longer in use. Use SnsTopicARN. - SnsTopicName *string + // Specifies whether the trail is publishing events from global services such as + // IAM to the log files. + IncludeGlobalServiceEvents *bool - // Specifies the name of the trail. - Name *string + // Specifies whether the trail exists in one region or in all regions. + IsMultiRegionTrail *bool // Specifies whether the trail is an organization trail. IsOrganizationTrail *bool @@ -188,22 +182,28 @@ type CreateTrailOutput struct { // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 KmsKeyId *string + // Specifies whether log file integrity validation is enabled. + LogFileValidationEnabled *bool + + // Specifies the name of the trail. + Name *string + + // Specifies the name of the Amazon S3 bucket designated for publishing log files. + S3BucketName *string + // Specifies the Amazon S3 key prefix that comes after the name of the bucket you // have designated for log file delivery. For more information, see Finding Your // CloudTrail Log Files // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html). S3KeyPrefix *string - // Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail - // logs will be delivered. - CloudWatchLogsLogGroupArn *string - - // Specifies whether the trail is publishing events from global services such as - // IAM to the log files. - IncludeGlobalServiceEvents *bool + // Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send + // notifications when log files are delivered. The format of a topic ARN is: + // arn:aws:sns:us-east-2:123456789012:MyTopic + SnsTopicARN *string - // Specifies whether log file integrity validation is enabled. - LogFileValidationEnabled *bool + // This field is no longer in use. Use SnsTopicARN. + SnsTopicName *string // Specifies the ARN of the trail that was created. The format of a trail ARN is: // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail diff --git a/service/cloudtrail/api_op_GetEventSelectors.go b/service/cloudtrail/api_op_GetEventSelectors.go index 1a449b4eea7..2b9f3976cc1 100644 --- a/service/cloudtrail/api_op_GetEventSelectors.go +++ b/service/cloudtrail/api_op_GetEventSelectors.go @@ -101,12 +101,12 @@ type GetEventSelectorsInput struct { type GetEventSelectorsOutput struct { - // The specified trail ARN that has the event selectors. - TrailARN *string - // The event selectors that are configured for the trail. EventSelectors []*types.EventSelector + // The specified trail ARN that has the event selectors. + TrailARN *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudtrail/api_op_GetTrailStatus.go b/service/cloudtrail/api_op_GetTrailStatus.go index 6629d0ee2e6..0d1ae6d68f8 100644 --- a/service/cloudtrail/api_op_GetTrailStatus.go +++ b/service/cloudtrail/api_op_GetTrailStatus.go @@ -75,21 +75,16 @@ type GetTrailStatusInput struct { // error. type GetTrailStatusOutput struct { + // Whether the CloudTrail is currently logging AWS API calls. + IsLogging *bool + // Displays any CloudWatch Logs error that CloudTrail encountered when attempting // to deliver logs to CloudWatch Logs. LatestCloudWatchLogsDeliveryError *string - // This field is no longer in use. - TimeLoggingStopped *string - - // This field is no longer in use. - TimeLoggingStarted *string - - // This field is no longer in use. - LatestNotificationAttemptTime *string - - // This field is no longer in use. - LatestNotificationAttemptSucceeded *string + // Displays the most recent date and time when CloudTrail delivered logs to + // CloudWatch Logs. + LatestCloudWatchLogsDeliveryTime *time.Time // This field is no longer in use. LatestDeliveryAttemptSucceeded *string @@ -97,24 +92,20 @@ type GetTrailStatusOutput struct { // This field is no longer in use. LatestDeliveryAttemptTime *string - // Specifies the most recent date and time when CloudTrail started recording API - // calls for an AWS account. - StartLoggingTime *time.Time + // Displays any Amazon S3 error that CloudTrail encountered when attempting to + // deliver log files to the designated bucket. For more information see the topic + // Error Responses + // (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html) in the + // Amazon S3 API Reference. This error occurs only when there is a problem with the + // destination S3 bucket and will not occur for timeouts. To resolve the issue, + // create a new bucket and call UpdateTrail to specify the new bucket, or fix the + // existing objects so that CloudTrail can again write to the bucket. + LatestDeliveryError *string // Specifies the date and time that CloudTrail last delivered log files to an // account's Amazon S3 bucket. LatestDeliveryTime *time.Time - // Displays any Amazon SNS error that CloudTrail encountered when attempting to - // send a notification. For more information about Amazon SNS errors, see the - // Amazon SNS Developer Guide - // (https://docs.aws.amazon.com/sns/latest/dg/welcome.html). - LatestNotificationError *string - - // Displays the most recent date and time when CloudTrail delivered logs to - // CloudWatch Logs. - LatestCloudWatchLogsDeliveryTime *time.Time - // Displays any Amazon S3 error that CloudTrail encountered when attempting to // deliver a digest file to the designated bucket. For more information see the // topic Error Responses @@ -125,30 +116,39 @@ type GetTrailStatusOutput struct { // existing objects so that CloudTrail can again write to the bucket. LatestDigestDeliveryError *string - // Specifies the most recent date and time when CloudTrail stopped recording API - // calls for an AWS account. - StopLoggingTime *time.Time + // Specifies the date and time that CloudTrail last delivered a digest file to an + // account's Amazon S3 bucket. + LatestDigestDeliveryTime *time.Time - // Whether the CloudTrail is currently logging AWS API calls. - IsLogging *bool + // This field is no longer in use. + LatestNotificationAttemptSucceeded *string - // Displays any Amazon S3 error that CloudTrail encountered when attempting to - // deliver log files to the designated bucket. For more information see the topic - // Error Responses - // (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html) in the - // Amazon S3 API Reference. This error occurs only when there is a problem with the - // destination S3 bucket and will not occur for timeouts. To resolve the issue, - // create a new bucket and call UpdateTrail to specify the new bucket, or fix the - // existing objects so that CloudTrail can again write to the bucket. - LatestDeliveryError *string + // This field is no longer in use. + LatestNotificationAttemptTime *string + + // Displays any Amazon SNS error that CloudTrail encountered when attempting to + // send a notification. For more information about Amazon SNS errors, see the + // Amazon SNS Developer Guide + // (https://docs.aws.amazon.com/sns/latest/dg/welcome.html). + LatestNotificationError *string // Specifies the date and time of the most recent Amazon SNS notification that // CloudTrail has written a new log file to an account's Amazon S3 bucket. LatestNotificationTime *time.Time - // Specifies the date and time that CloudTrail last delivered a digest file to an - // account's Amazon S3 bucket. - LatestDigestDeliveryTime *time.Time + // Specifies the most recent date and time when CloudTrail started recording API + // calls for an AWS account. + StartLoggingTime *time.Time + + // Specifies the most recent date and time when CloudTrail stopped recording API + // calls for an AWS account. + StopLoggingTime *time.Time + + // This field is no longer in use. + TimeLoggingStarted *string + + // This field is no longer in use. + TimeLoggingStopped *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/cloudtrail/api_op_ListPublicKeys.go b/service/cloudtrail/api_op_ListPublicKeys.go index 60e15087dd2..77fc0fa06ac 100644 --- a/service/cloudtrail/api_op_ListPublicKeys.go +++ b/service/cloudtrail/api_op_ListPublicKeys.go @@ -64,13 +64,13 @@ func (c *Client) ListPublicKeys(ctx context.Context, params *ListPublicKeysInput // Requests the public keys for a specified time range. type ListPublicKeysInput struct { - // Reserved for future use. - NextToken *string - // Optionally specifies, in UTC, the end of the time range to look up public keys // for CloudTrail digest files. If not specified, the current time is used. EndTime *time.Time + // Reserved for future use. + NextToken *string + // Optionally specifies, in UTC, the start of the time range to look up public keys // for CloudTrail digest files. If not specified, the current time is used, and the // current public key is returned. diff --git a/service/cloudtrail/api_op_ListTags.go b/service/cloudtrail/api_op_ListTags.go index 2ad6169ec24..803e0713b16 100644 --- a/service/cloudtrail/api_op_ListTags.go +++ b/service/cloudtrail/api_op_ListTags.go @@ -58,15 +58,15 @@ func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ... // Specifies a list of trail tags to return. type ListTagsInput struct { - // Reserved for future use. - NextToken *string - // Specifies a list of trail ARNs whose tags will be listed. The list has a limit // of 20 ARNs. The format of a trail ARN is: // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail // // This member is required. ResourceIdList []*string + + // Reserved for future use. + NextToken *string } // Returns the objects or data listed below if successful. Otherwise, returns an diff --git a/service/cloudtrail/api_op_ListTrails.go b/service/cloudtrail/api_op_ListTrails.go index 5e3b1991005..1d03350282c 100644 --- a/service/cloudtrail/api_op_ListTrails.go +++ b/service/cloudtrail/api_op_ListTrails.go @@ -66,9 +66,6 @@ type ListTrailsInput struct { type ListTrailsOutput struct { - // Returns the name, ARN, and home region of trails in the current account. - Trails []*types.TrailInfo - // The token to use to get the next page of results after a previous API call. If // the token does not appear, there are no more results to return. The token must // be passed in with the same parameters as the previous call. For example, if the @@ -76,6 +73,9 @@ type ListTrailsOutput struct { // the call with NextToken should include those same parameters. NextToken *string + // Returns the name, ARN, and home region of trails in the current account. + Trails []*types.TrailInfo + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudtrail/api_op_LookupEvents.go b/service/cloudtrail/api_op_LookupEvents.go index 920a3b01bfc..b42e82f00ae 100644 --- a/service/cloudtrail/api_op_LookupEvents.go +++ b/service/cloudtrail/api_op_LookupEvents.go @@ -98,14 +98,23 @@ func (c *Client) LookupEvents(ctx context.Context, params *LookupEventsInput, op // Contains a request for LookupEvents. type LookupEventsInput struct { + // Specifies that only events that occur before or at the specified time are + // returned. If the specified end time is before the specified start time, an error + // is returned. + EndTime *time.Time + + // Specifies the event category. If you do not specify an event category, events of + // the category are not returned in the response. For example, if you do not + // specify insight as the value of EventCategory, no Insights events are returned. + EventCategory types.EventCategory + // Contains a list of lookup attributes. Currently the list can contain only one // item. LookupAttributes []*types.LookupAttribute - // Specifies that only events that occur after or at the specified time are - // returned. If the specified start time is after the specified end time, an error - // is returned. - StartTime *time.Time + // The number of events to return. Possible values are 1 through 50. The default is + // 50. + MaxResults *int32 // The token to use to get the next page of results after a previous API call. This // token must be passed in with the same parameters that were specified in the the @@ -114,19 +123,10 @@ type LookupEventsInput struct { // same parameters. NextToken *string - // Specifies the event category. If you do not specify an event category, events of - // the category are not returned in the response. For example, if you do not - // specify insight as the value of EventCategory, no Insights events are returned. - EventCategory types.EventCategory - - // The number of events to return. Possible values are 1 through 50. The default is - // 50. - MaxResults *int32 - - // Specifies that only events that occur before or at the specified time are - // returned. If the specified end time is before the specified start time, an error + // Specifies that only events that occur after or at the specified time are + // returned. If the specified start time is after the specified end time, an error // is returned. - EndTime *time.Time + StartTime *time.Time } // Contains a response to a LookupEvents action. diff --git a/service/cloudtrail/api_op_PutInsightSelectors.go b/service/cloudtrail/api_op_PutInsightSelectors.go index 31fb173a7a8..bfb669e8992 100644 --- a/service/cloudtrail/api_op_PutInsightSelectors.go +++ b/service/cloudtrail/api_op_PutInsightSelectors.go @@ -60,17 +60,17 @@ func (c *Client) PutInsightSelectors(ctx context.Context, params *PutInsightSele type PutInsightSelectorsInput struct { - // The name of the CloudTrail trail for which you want to change or add Insights - // selectors. - // - // This member is required. - TrailName *string - // A JSON string that contains the insight types you want to log on a trail. In // this release, only ApiCallRateInsight is supported as an insight type. // // This member is required. InsightSelectors []*types.InsightSelector + + // The name of the CloudTrail trail for which you want to change or add Insights + // selectors. + // + // This member is required. + TrailName *string } type PutInsightSelectorsOutput struct { diff --git a/service/cloudtrail/api_op_RemoveTags.go b/service/cloudtrail/api_op_RemoveTags.go index 6e5dfc379a7..7bca745cc47 100644 --- a/service/cloudtrail/api_op_RemoveTags.go +++ b/service/cloudtrail/api_op_RemoveTags.go @@ -58,14 +58,14 @@ func (c *Client) RemoveTags(ctx context.Context, params *RemoveTagsInput, optFns // Specifies the tags to remove from a trail. type RemoveTagsInput struct { - // Specifies a list of tags to be removed. - TagsList []*types.Tag - // Specifies the ARN of the trail from which tags should be removed. The format of // a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail // // This member is required. ResourceId *string + + // Specifies a list of tags to be removed. + TagsList []*types.Tag } // Returns the objects or data listed below if successful. Otherwise, returns an diff --git a/service/cloudtrail/api_op_UpdateTrail.go b/service/cloudtrail/api_op_UpdateTrail.go index 9d662432993..39fad0739e4 100644 --- a/service/cloudtrail/api_op_UpdateTrail.go +++ b/service/cloudtrail/api_op_UpdateTrail.go @@ -62,60 +62,38 @@ func (c *Client) UpdateTrail(ctx context.Context, params *UpdateTrailInput, optF // Specifies settings to update for the trail. type UpdateTrailInput struct { - // Specifies the name of the Amazon S3 bucket designated for publishing log files. - // See Amazon S3 Bucket Naming Requirements - // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html). - S3BucketName *string - - // Specifies whether the trail applies only to the current region or to all - // regions. The default is false. If the trail exists only in the current region - // and this value is set to true, shadow trails (replications of the trail) will be - // created in the other regions. If the trail exists in all regions and this value - // is set to false, the trail will remain in the region where it was created, and - // its shadow trails in other regions will be deleted. As a best practice, consider - // using trails that log events in all regions. - IsMultiRegionTrail *bool - - // Specifies the role for the CloudWatch Logs endpoint to assume to write to a - // user's log group. - CloudWatchLogsRoleArn *string - - // Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The - // value can be an alias name prefixed by "alias/", a fully specified ARN to an - // alias, a fully specified ARN to a key, or a globally unique identifier. - // Examples: + // Specifies the name of the trail or trail ARN. If Name is a trail name, the + // string must meet the following requirements: // - // * alias/MyAliasName + // * Contain only ASCII letters + // (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) // // * - // arn:aws:kms:us-east-2:123456789012:alias/MyAliasName + // Start with a letter or number, and end with a letter or number // - // * - // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 + // * Be between + // 3 and 128 characters // + // * Have no adjacent periods, underscores or dashes. + // Names like my-_namespace and my--namespace are invalid. // - // * 12345678-1234-1234-1234-123456789012 - KmsKeyId *string - - // Specifies the Amazon S3 key prefix that comes after the name of the bucket you - // have designated for log file delivery. For more information, see Finding Your - // CloudTrail Log Files - // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html). - // The maximum length is 200 characters. - S3KeyPrefix *string + // * Not be in IP + // address format (for example, 192.168.5.4) + // + // If Name is a trail ARN, it must be in + // the format: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + // + // This member is required. + Name *string // Specifies a log group name using an Amazon Resource Name (ARN), a unique // identifier that represents the log group to which CloudTrail logs will be // delivered. Not required unless you specify CloudWatchLogsRoleArn. CloudWatchLogsLogGroupArn *string - // Specifies the name of the Amazon SNS topic defined for notification of log file - // delivery. The maximum length is 256 characters. - SnsTopicName *string - - // Specifies whether the trail is publishing events from global services such as - // IAM to the log files. - IncludeGlobalServiceEvents *bool + // Specifies the role for the CloudWatch Logs endpoint to assume to write to a + // user's log group. + CloudWatchLogsRoleArn *string // Specifies whether log file validation is enabled. The default is false. When you // disable log file integrity validation, the chain of digest files is broken after @@ -128,6 +106,19 @@ type UpdateTrailInput struct { // delete a trail. EnableLogFileValidation *bool + // Specifies whether the trail is publishing events from global services such as + // IAM to the log files. + IncludeGlobalServiceEvents *bool + + // Specifies whether the trail applies only to the current region or to all + // regions. The default is false. If the trail exists only in the current region + // and this value is set to true, shadow trails (replications of the trail) will be + // created in the other regions. If the trail exists in all regions and this value + // is set to false, the trail will remain in the region where it was created, and + // its shadow trails in other regions will be deleted. As a best practice, consider + // using trails that log events in all regions. + IsMultiRegionTrail *bool + // Specifies whether the trail is applied to all accounts in an organization in AWS // Organizations, or only for the current AWS account. The default is false, and // cannot be true unless the call is made on behalf of an AWS account that is the @@ -138,86 +129,95 @@ type UpdateTrailInput struct { // be deleted from all member accounts in the organization. IsOrganizationTrail *bool - // Specifies the name of the trail or trail ARN. If Name is a trail name, the - // string must meet the following requirements: + // Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The + // value can be an alias name prefixed by "alias/", a fully specified ARN to an + // alias, a fully specified ARN to a key, or a globally unique identifier. + // Examples: // - // * Contain only ASCII letters - // (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) + // * alias/MyAliasName // // * - // Start with a letter or number, and end with a letter or number - // - // * Be between - // 3 and 128 characters - // - // * Have no adjacent periods, underscores or dashes. - // Names like my-_namespace and my--namespace are invalid. + // arn:aws:kms:us-east-2:123456789012:alias/MyAliasName // - // * Not be in IP - // address format (for example, 192.168.5.4) + // * + // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 // - // If Name is a trail ARN, it must be in - // the format: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail // - // This member is required. - Name *string + // * 12345678-1234-1234-1234-123456789012 + KmsKeyId *string + + // Specifies the name of the Amazon S3 bucket designated for publishing log files. + // See Amazon S3 Bucket Naming Requirements + // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html). + S3BucketName *string + + // Specifies the Amazon S3 key prefix that comes after the name of the bucket you + // have designated for log file delivery. For more information, see Finding Your + // CloudTrail Log Files + // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html). + // The maximum length is 200 characters. + S3KeyPrefix *string + + // Specifies the name of the Amazon SNS topic defined for notification of log file + // delivery. The maximum length is 256 characters. + SnsTopicName *string } // Returns the objects or data listed below if successful. Otherwise, returns an // error. type UpdateTrailOutput struct { + // Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail + // logs will be delivered. + CloudWatchLogsLogGroupArn *string + // Specifies the role for the CloudWatch Logs endpoint to assume to write to a // user's log group. CloudWatchLogsRoleArn *string - // Specifies whether the trail is an organization trail. - IsOrganizationTrail *bool - - // Specifies the name of the trail. - Name *string - // Specifies whether the trail is publishing events from global services such as // IAM to the log files. IncludeGlobalServiceEvents *bool + // Specifies whether the trail exists in one region or in all regions. + IsMultiRegionTrail *bool + + // Specifies whether the trail is an organization trail. + IsOrganizationTrail *bool + + // Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The + // value is a fully specified ARN to a KMS key in the format:

    + // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 + //

    + KmsKeyId *string + // Specifies whether log file integrity validation is enabled. LogFileValidationEnabled *bool + // Specifies the name of the trail. + Name *string + // Specifies the name of the Amazon S3 bucket designated for publishing log files. S3BucketName *string - // Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send - // notifications when log files are delivered. The format of a topic ARN is: - // arn:aws:sns:us-east-2:123456789012:MyTopic - SnsTopicARN *string - // Specifies the Amazon S3 key prefix that comes after the name of the bucket you // have designated for log file delivery. For more information, see Finding Your // CloudTrail Log Files // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html). S3KeyPrefix *string + // Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send + // notifications when log files are delivered. The format of a topic ARN is: + // arn:aws:sns:us-east-2:123456789012:MyTopic + SnsTopicARN *string + // This field is no longer in use. Use SnsTopicARN. SnsTopicName *string - // Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail - // logs will be delivered. - CloudWatchLogsLogGroupArn *string - - // Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The - // value is a fully specified ARN to a KMS key in the format:

    - // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 - //

    - KmsKeyId *string - // Specifies the ARN of the trail that was updated. The format of a trail ARN is: // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail TrailARN *string - // Specifies whether the trail exists in one region or in all regions. - IsMultiRegionTrail *bool - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudtrail/go.mod b/service/cloudtrail/go.mod index 089cfa7bba9..4e2a6b0b465 100644 --- a/service/cloudtrail/go.mod +++ b/service/cloudtrail/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/cloudtrail go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/cloudtrail/types/types.go b/service/cloudtrail/types/types.go index f88f61ba38b..b1b066398b7 100644 --- a/service/cloudtrail/types/types.go +++ b/service/cloudtrail/types/types.go @@ -54,6 +54,10 @@ import ( // trail doesn’t log the event. type DataResource struct { + // The resource type in which you want to log data events. You can specify + // AWS::S3::Object or AWS::Lambda::Function resources. + Type *string + // An array of Amazon Resource Name (ARN) strings or partial ARN strings for the // specified objects. // @@ -86,25 +90,16 @@ type DataResource struct { // will not be logged for // arn:aws:lambda:us-west-2:111111111111:function:helloworld2. Values []*string - - // The resource type in which you want to log data events. You can specify - // AWS::S3::Object or AWS::Lambda::Function resources. - Type *string } // Contains information about an event that was returned by a lookup request. The // result includes a representation of a CloudTrail event. type Event struct { - // A user name or role name of the requester that called the API in the event - // returned. - Username *string - - // Information about whether the event is a write event or a read event. - ReadOnly *string - - // The AWS service that the request was made to. - EventSource *string + // The AWS access key ID that was used to sign the request. If the request was made + // with temporary security credentials, this is the access key ID of the temporary + // credentials. + AccessKeyId *string // A JSON string that contains a representation of the event returned. CloudTrailEvent *string @@ -115,16 +110,21 @@ type Event struct { // The name of the event returned. EventName *string - // A list of resources referenced by the event returned. - Resources []*Resource - - // The AWS access key ID that was used to sign the request. If the request was made - // with temporary security credentials, this is the access key ID of the temporary - // credentials. - AccessKeyId *string + // The AWS service that the request was made to. + EventSource *string // The date and time of the event returned. EventTime *time.Time + + // Information about whether the event is a write event or a read event. + ReadOnly *string + + // A list of resources referenced by the event returned. + Resources []*Resource + + // A user name or role name of the requester that called the API in the event + // returned. + Username *string } // Use event selectors to further specify the management and data event settings @@ -155,17 +155,17 @@ type EventSelector struct { // empty, and AWS KMS events are included in events that are logged to your trail. ExcludeManagementEventSources []*string - // Specify if you want your trail to log read-only events, write-only events, or - // all. For example, the EC2 GetConsoleOutput is a read-only API operation and - // RunInstances is a write-only API operation. By default, the value is All. - ReadWriteType ReadWriteType - // Specify if you want your event selector to include management events for your // trail. For more information, see Management Events // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html#logging-management-events) // in the AWS CloudTrail User Guide.

    By default, the value is // true.

    IncludeManagementEvents *bool + + // Specify if you want your trail to log read-only events, write-only events, or + // all. For example, the EC2 GetConsoleOutput is a read-only API operation and + // RunInstances is a write-only API operation. By default, the value is All. + ReadWriteType ReadWriteType } // A JSON string that contains a list of insight types that are logged on a trail. @@ -196,14 +196,14 @@ type PublicKey struct { // The fingerprint of the public key. Fingerprint *string - // The DER encoded public key value in PKCS#1 format. - Value []byte - // The ending time of validity of the public key. ValidityEndTime *time.Time // The starting time of validity of the public key. ValidityStartTime *time.Time + + // The DER encoded public key value in PKCS#1 format. + Value []byte } // Specifies the type and name of a resource referenced by an event. @@ -237,95 +237,95 @@ type ResourceTag struct { // A custom key-value pair associated with a resource such as a CloudTrail trail. type Tag struct { - // The value in a key-value pair of a tag. The value must be no longer than 256 - // Unicode characters. - Value *string - // The key in a key-value pair. The key must be must be no longer than 128 Unicode // characters. The key must be unique for the resource to which it applies. // // This member is required. Key *string + + // The value in a key-value pair of a tag. The value must be no longer than 256 + // Unicode characters. + Value *string } // The settings for a trail. type Trail struct { - // Specifies the ARN of the trail. The format of a trail ARN is: - // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail - TrailARN *string - - // Specifies whether the trail exists only in one region or exists in all regions. - IsMultiRegionTrail *bool - - // Specifies if the trail has custom event selectors. - HasCustomEventSelectors *bool - - // Name of the trail set by calling CreateTrail (). The maximum length is 128 - // characters. - Name *string + // Specifies an Amazon Resource Name (ARN), a unique identifier that represents the + // log group to which CloudTrail logs will be delivered. + CloudWatchLogsLogGroupArn *string // Specifies the role for the CloudWatch Logs endpoint to assume to write to a // user's log group. CloudWatchLogsRoleArn *string - // Specifies whether the trail is an organization trail. - IsOrganizationTrail *bool + // Specifies if the trail has custom event selectors. + HasCustomEventSelectors *bool - // This field is no longer in use. Use SnsTopicARN. - SnsTopicName *string + // Specifies whether a trail has insight types specified in an InsightSelector + // list. + HasInsightSelectors *bool + + // The region in which the trail was created. + HomeRegion *string // Set to True to include AWS API calls from AWS global services such as IAM. // Otherwise, False. IncludeGlobalServiceEvents *bool + // Specifies whether the trail exists only in one region or exists in all regions. + IsMultiRegionTrail *bool + + // Specifies whether the trail is an organization trail. + IsOrganizationTrail *bool + // Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The // value is a fully specified ARN to a KMS key in the format: // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 KmsKeyId *string - // Specifies the Amazon S3 key prefix that comes after the name of the bucket you - // have designated for log file delivery. For more information, see Finding Your - // CloudTrail Log Files - // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html).The - // maximum length is 200 characters. - S3KeyPrefix *string - - // The region in which the trail was created. - HomeRegion *string + // Specifies whether log file validation is enabled. + LogFileValidationEnabled *bool - // Specifies whether a trail has insight types specified in an InsightSelector - // list. - HasInsightSelectors *bool + // Name of the trail set by calling CreateTrail (). The maximum length is 128 + // characters. + Name *string // Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. // See Amazon S3 Bucket Naming Requirements // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html). S3BucketName *string + // Specifies the Amazon S3 key prefix that comes after the name of the bucket you + // have designated for log file delivery. For more information, see Finding Your + // CloudTrail Log Files + // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html).The + // maximum length is 200 characters. + S3KeyPrefix *string + // Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send // notifications when log files are delivered. The format of a topic ARN is: // arn:aws:sns:us-east-2:123456789012:MyTopic SnsTopicARN *string - // Specifies whether log file validation is enabled. - LogFileValidationEnabled *bool + // This field is no longer in use. Use SnsTopicARN. + SnsTopicName *string - // Specifies an Amazon Resource Name (ARN), a unique identifier that represents the - // log group to which CloudTrail logs will be delivered. - CloudWatchLogsLogGroupArn *string + // Specifies the ARN of the trail. The format of a trail ARN is: + // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + TrailARN *string } // Information about a CloudTrail trail, including the trail's name, home region, // and Amazon Resource Name (ARN). type TrailInfo struct { - // The ARN of a trail. - TrailARN *string + // The AWS region in which a trail was created. + HomeRegion *string // The name of a trail. Name *string - // The AWS region in which a trail was created. - HomeRegion *string + // The ARN of a trail. + TrailARN *string } diff --git a/service/cloudwatch/api_op_DeleteAnomalyDetector.go b/service/cloudwatch/api_op_DeleteAnomalyDetector.go index e8a2f475c78..289bb0a1909 100644 --- a/service/cloudwatch/api_op_DeleteAnomalyDetector.go +++ b/service/cloudwatch/api_op_DeleteAnomalyDetector.go @@ -62,9 +62,6 @@ type DeleteAnomalyDetectorInput struct { // This member is required. MetricName *string - // The metric dimensions associated with the anomaly detection model to delete. - Dimensions []*types.Dimension - // The namespace associated with the anomaly detection model to delete. // // This member is required. @@ -74,6 +71,9 @@ type DeleteAnomalyDetectorInput struct { // // This member is required. Stat *string + + // The metric dimensions associated with the anomaly detection model to delete. + Dimensions []*types.Dimension } type DeleteAnomalyDetectorOutput struct { diff --git a/service/cloudwatch/api_op_DescribeAlarmHistory.go b/service/cloudwatch/api_op_DescribeAlarmHistory.go index 12e76aa6181..6a133df8729 100644 --- a/service/cloudwatch/api_op_DescribeAlarmHistory.go +++ b/service/cloudwatch/api_op_DescribeAlarmHistory.go @@ -60,44 +60,44 @@ func (c *Client) DescribeAlarmHistory(ctx context.Context, params *DescribeAlarm type DescribeAlarmHistoryInput struct { - // The maximum number of alarm history records to retrieve. - MaxRecords *int32 - - // The starting date to retrieve alarm history. - StartDate *time.Time - - // Specified whether to return the newest or oldest alarm history first. Specify - // TimestampDescending to have the newest event history returned first, and specify - // TimestampAscending to have the oldest history returned first. - ScanBy types.ScanBy - // The name of the alarm. AlarmName *string + // Use this parameter to specify whether you want the operation to return metric + // alarms or composite alarms. If you omit this parameter, only metric alarms are + // returned. + AlarmTypes []types.AlarmType + // The ending date to retrieve alarm history. EndDate *time.Time + // The type of alarm histories to retrieve. + HistoryItemType types.HistoryItemType + + // The maximum number of alarm history records to retrieve. + MaxRecords *int32 + // The token returned by a previous call to indicate that there is more data // available. NextToken *string - // The type of alarm histories to retrieve. - HistoryItemType types.HistoryItemType + // Specified whether to return the newest or oldest alarm history first. Specify + // TimestampDescending to have the newest event history returned first, and specify + // TimestampAscending to have the oldest history returned first. + ScanBy types.ScanBy - // Use this parameter to specify whether you want the operation to return metric - // alarms or composite alarms. If you omit this parameter, only metric alarms are - // returned. - AlarmTypes []types.AlarmType + // The starting date to retrieve alarm history. + StartDate *time.Time } type DescribeAlarmHistoryOutput struct { - // The token that marks the start of the next batch of returned results. - NextToken *string - // The alarm histories, in JSON format. AlarmHistoryItems []*types.AlarmHistoryItem + // The token that marks the start of the next batch of returned results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudwatch/api_op_DescribeAlarms.go b/service/cloudwatch/api_op_DescribeAlarms.go index 97e7dee80da..ac926c0ec33 100644 --- a/service/cloudwatch/api_op_DescribeAlarms.go +++ b/service/cloudwatch/api_op_DescribeAlarms.go @@ -57,22 +57,45 @@ func (c *Client) DescribeAlarms(ctx context.Context, params *DescribeAlarmsInput type DescribeAlarmsInput struct { + // Use this parameter to filter the results of the operation to only those alarms + // that use a certain alarm action. For example, you could specify the ARN of an + // SNS topic to find all alarms that send notifications to that topic. + ActionPrefix *string + + // An alarm name prefix. If you specify this parameter, you receive information + // about all alarms that have names that start with this prefix. If this parameter + // is specified, you cannot specify AlarmNames. + AlarmNamePrefix *string + + // The names of the alarms to retrieve information about. + AlarmNames []*string + // Use this parameter to specify whether you want the operation to return metric // alarms or composite alarms. If you omit this parameter, only metric alarms are // returned. AlarmTypes []types.AlarmType + // If you use this parameter and specify the name of a composite alarm, the + // operation returns information about the "children" alarms of the alarm you + // specify. These are the metric alarms and composite alarms referenced in the + // AlarmRule field of the composite alarm that you specify in ChildrenOfAlarmName. + // Information about the composite alarm that you name in ChildrenOfAlarmName is + // not returned. If you specify ChildrenOfAlarmName, you cannot specify any other + // parameters in the request except for MaxRecords and NextToken. If you do so, you + // receive a validation error. Only the Alarm Name, ARN, StateValue + // (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp information are returned + // by this operation when you use this parameter. To get complete information about + // these alarms, perform another DescribeAlarms operation and specify the parent + // alarm names in the AlarmNames parameter. + ChildrenOfAlarmName *string + + // The maximum number of alarm descriptions to retrieve. + MaxRecords *int32 + // The token returned by a previous call to indicate that there is more data // available. NextToken *string - // Specify this parameter to receive information only about alarms that are - // currently in the state that you specify. - StateValue types.StateValue - - // The names of the alarms to retrieve information about. - AlarmNames []*string - // If you use this parameter and specify the name of a metric or composite alarm, // the operation returns information about the "parent" alarms of the alarm you // specify. These are the composite alarms that have AlarmRule parameters that @@ -86,44 +109,21 @@ type DescribeAlarmsInput struct { // parameter. ParentsOfAlarmName *string - // Use this parameter to filter the results of the operation to only those alarms - // that use a certain alarm action. For example, you could specify the ARN of an - // SNS topic to find all alarms that send notifications to that topic. - ActionPrefix *string - - // The maximum number of alarm descriptions to retrieve. - MaxRecords *int32 - - // If you use this parameter and specify the name of a composite alarm, the - // operation returns information about the "children" alarms of the alarm you - // specify. These are the metric alarms and composite alarms referenced in the - // AlarmRule field of the composite alarm that you specify in ChildrenOfAlarmName. - // Information about the composite alarm that you name in ChildrenOfAlarmName is - // not returned. If you specify ChildrenOfAlarmName, you cannot specify any other - // parameters in the request except for MaxRecords and NextToken. If you do so, you - // receive a validation error. Only the Alarm Name, ARN, StateValue - // (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp information are returned - // by this operation when you use this parameter. To get complete information about - // these alarms, perform another DescribeAlarms operation and specify the parent - // alarm names in the AlarmNames parameter. - ChildrenOfAlarmName *string - - // An alarm name prefix. If you specify this parameter, you receive information - // about all alarms that have names that start with this prefix. If this parameter - // is specified, you cannot specify AlarmNames. - AlarmNamePrefix *string + // Specify this parameter to receive information only about alarms that are + // currently in the state that you specify. + StateValue types.StateValue } type DescribeAlarmsOutput struct { - // The token that marks the start of the next batch of returned results. - NextToken *string + // The information about any composite alarms returned by the operation. + CompositeAlarms []*types.CompositeAlarm // The information about any metric alarms returned by the operation. MetricAlarms []*types.MetricAlarm - // The information about any composite alarms returned by the operation. - CompositeAlarms []*types.CompositeAlarm + // The token that marks the start of the next batch of returned results. + NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/cloudwatch/api_op_DescribeAlarmsForMetric.go b/service/cloudwatch/api_op_DescribeAlarmsForMetric.go index 632b6d54090..5fc025817ef 100644 --- a/service/cloudwatch/api_op_DescribeAlarmsForMetric.go +++ b/service/cloudwatch/api_op_DescribeAlarmsForMetric.go @@ -58,32 +58,32 @@ func (c *Client) DescribeAlarmsForMetric(ctx context.Context, params *DescribeAl type DescribeAlarmsForMetricInput struct { + // The name of the metric. + // + // This member is required. + MetricName *string + // The namespace of the metric. // // This member is required. Namespace *string - // The period, in seconds, over which the statistic is applied. - Period *int32 - // The dimensions associated with the metric. If the metric has any associated // dimensions, you must specify them in order for the call to succeed. Dimensions []*types.Dimension + // The percentile statistic for the metric. Specify a value between p0.0 and p100. + ExtendedStatistic *string + + // The period, in seconds, over which the statistic is applied. + Period *int32 + // The statistic for the metric, other than percentiles. For percentile statistics, // use ExtendedStatistics. Statistic types.Statistic - // The name of the metric. - // - // This member is required. - MetricName *string - // The unit for the metric. Unit types.StandardUnit - - // The percentile statistic for the metric. Specify a value between p0.0 and p100. - ExtendedStatistic *string } type DescribeAlarmsForMetricOutput struct { diff --git a/service/cloudwatch/api_op_DescribeAnomalyDetectors.go b/service/cloudwatch/api_op_DescribeAnomalyDetectors.go index 2731bfd6cb9..7ea229b9663 100644 --- a/service/cloudwatch/api_op_DescribeAnomalyDetectors.go +++ b/service/cloudwatch/api_op_DescribeAnomalyDetectors.go @@ -59,6 +59,11 @@ func (c *Client) DescribeAnomalyDetectors(ctx context.Context, params *DescribeA type DescribeAnomalyDetectorsInput struct { + // Limits the results to only the anomaly detection models that are associated with + // the specified metric dimensions. If there are multiple metrics that have these + // dimensions and have anomaly detection models associated, they're all returned. + Dimensions []*types.Dimension + // The maximum number of results to return in one operation. The maximum value that // you can specify is 100. To retrieve the remaining results, make another call // with the returned NextToken value. @@ -70,17 +75,12 @@ type DescribeAnomalyDetectorsInput struct { MetricName *string // Limits the results to only the anomaly detection models that are associated with - // the specified metric dimensions. If there are multiple metrics that have these - // dimensions and have anomaly detection models associated, they're all returned. - Dimensions []*types.Dimension + // the specified namespace. + Namespace *string // Use the token returned by the previous operation to request the next page of // results. NextToken *string - - // Limits the results to only the anomaly detection models that are associated with - // the specified namespace. - Namespace *string } type DescribeAnomalyDetectorsOutput struct { diff --git a/service/cloudwatch/api_op_DescribeInsightRules.go b/service/cloudwatch/api_op_DescribeInsightRules.go index 2f0fdb2d52d..5b0e2b9ac4b 100644 --- a/service/cloudwatch/api_op_DescribeInsightRules.go +++ b/service/cloudwatch/api_op_DescribeInsightRules.go @@ -60,12 +60,12 @@ func (c *Client) DescribeInsightRules(ctx context.Context, params *DescribeInsig type DescribeInsightRulesInput struct { - // Reserved for future use. - NextToken *string - // This parameter is not currently used. Reserved for future use. If it is used in // the future, the maximum value might be different. MaxResults *int32 + + // Reserved for future use. + NextToken *string } type DescribeInsightRulesOutput struct { diff --git a/service/cloudwatch/api_op_GetInsightRuleReport.go b/service/cloudwatch/api_op_GetInsightRuleReport.go index b718810e89e..f1dfbab92d6 100644 --- a/service/cloudwatch/api_op_GetInsightRuleReport.go +++ b/service/cloudwatch/api_op_GetInsightRuleReport.go @@ -89,31 +89,33 @@ func (c *Client) GetInsightRuleReport(ctx context.Context, params *GetInsightRul type GetInsightRuleReportInput struct { - // The start time of the data to use in the report. When used in a raw HTTP Query + // The end time of the data to use in the report. When used in a raw HTTP Query // API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59. // // This member is required. - StartTime *time.Time + EndTime *time.Time - // The end time of the data to use in the report. When used in a raw HTTP Query - // API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59. + // The period, in seconds, to use for the statistics in the + // InsightRuleMetricDatapoint results. // // This member is required. - EndTime *time.Time + Period *int32 // The name of the rule that you want to see data from. // // This member is required. RuleName *string + // The start time of the data to use in the report. When used in a raw HTTP Query + // API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59. + // + // This member is required. + StartTime *time.Time + // The maximum number of contributors to include in the report. The range is 1 to // 100. If you omit this, the default of 10 is used. MaxContributorCount *int32 - // Determines what statistic to use to rank the contributors. Valid values are SUM - // and MAXIMUM. - OrderBy *string - // Specifies which metrics to use for aggregation of contributor values for the // report. You can specify one or more of the following metrics: // @@ -146,39 +148,37 @@ type GetInsightRuleReportInput struct { // period represented by that data point. Metrics []*string - // The period, in seconds, to use for the statistics in the - // InsightRuleMetricDatapoint results. - // - // This member is required. - Period *int32 + // Determines what statistic to use to rank the contributors. Valid values are SUM + // and MAXIMUM. + OrderBy *string } type GetInsightRuleReportOutput struct { + // The sum of the values from all individual contributors that match the rule. + AggregateValue *float64 + // Specifies whether this rule aggregates contributor data by COUNT or SUM. AggregationStatistic *string + // An approximate count of the unique contributors found by this rule in this time + // period. + ApproximateUniqueCount *int64 + // An array of the unique contributors found by this rule in this time period. If // the rule contains multiple keys, each combination of values for the keys counts // as a unique contributor. Contributors []*types.InsightRuleContributor - // The sum of the values from all individual contributors that match the rule. - AggregateValue *float64 - - // A time series of metric data points that matches the time period in the rule - // request. - MetricDatapoints []*types.InsightRuleMetricDatapoint - // An array of the strings used as the keys for this rule. The keys are the // dimensions used to classify contributors. If the rule contains more than one // key, then each unique combination of values for the keys is counted as a unique // contributor. KeyLabels []*string - // An approximate count of the unique contributors found by this rule in this time - // period. - ApproximateUniqueCount *int64 + // A time series of metric data points that matches the time period in the rule + // request. + MetricDatapoints []*types.InsightRuleMetricDatapoint // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/cloudwatch/api_op_GetMetricData.go b/service/cloudwatch/api_op_GetMetricData.go index e8eee22fb3e..4641f7473a7 100644 --- a/service/cloudwatch/api_op_GetMetricData.go +++ b/service/cloudwatch/api_op_GetMetricData.go @@ -89,6 +89,17 @@ func (c *Client) GetMetricData(ctx context.Context, params *GetMetricDataInput, type GetMetricDataInput struct { + // The time stamp indicating the latest data to be returned. The value specified is + // exclusive; results include data points up to the specified time stamp. For + // better performance, specify StartTime and EndTime values that align with the + // value of the metric's Period and sync up with the beginning and end of an hour. + // For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 + // as EndTime can get a faster response from CloudWatch than setting 12:07 or 12:29 + // as the EndTime. + // + // This member is required. + EndTime *time.Time + // The metric queries to be returned. A single GetMetricData call can include as // many as 500 MetricDataQuery structures. Each of these structures can specify // either a metric to retrieve, or a math expression to perform on retrieved data. @@ -127,30 +138,19 @@ type GetMetricDataInput struct { // This member is required. StartTime *time.Time - // Include this value, if it was returned by the previous call, to get the next set - // of data points. - NextToken *string - // The maximum number of data points the request should return before paginating. // If you omit this, the default of 100,800 is used. MaxDatapoints *int32 + // Include this value, if it was returned by the previous call, to get the next set + // of data points. + NextToken *string + // The order in which data points should be returned. TimestampDescending returns // the newest data first and paginates when the MaxDatapoints limit is reached. // TimestampAscending returns the oldest data first and paginates when the // MaxDatapoints limit is reached. ScanBy types.ScanBy - - // The time stamp indicating the latest data to be returned. The value specified is - // exclusive; results include data points up to the specified time stamp. For - // better performance, specify StartTime and EndTime values that align with the - // value of the metric's Period and sync up with the beginning and end of an hour. - // For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 - // as EndTime can get a faster response from CloudWatch than setting 12:07 or 12:29 - // as the EndTime. - // - // This member is required. - EndTime *time.Time } type GetMetricDataOutput struct { diff --git a/service/cloudwatch/api_op_GetMetricStatistics.go b/service/cloudwatch/api_op_GetMetricStatistics.go index cfe26856fc1..51a4fab5596 100644 --- a/service/cloudwatch/api_op_GetMetricStatistics.go +++ b/service/cloudwatch/api_op_GetMetricStatistics.go @@ -93,11 +93,6 @@ func (c *Client) GetMetricStatistics(ctx context.Context, params *GetMetricStati type GetMetricStatisticsInput struct { - // The name of the metric, with or without spaces. - // - // This member is required. - MetricName *string - // The time stamp that determines the last data point to return. The value // specified is exclusive; results include data points up to the specified time // stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for @@ -106,6 +101,38 @@ type GetMetricStatisticsInput struct { // This member is required. EndTime *time.Time + // The name of the metric, with or without spaces. + // + // This member is required. + MetricName *string + + // The namespace of the metric, with or without spaces. + // + // This member is required. + Namespace *string + + // The granularity, in seconds, of the returned data points. For metrics with + // regular resolution, a period can be as short as one minute (60 seconds) and must + // be a multiple of 60. For high-resolution metrics that are collected at intervals + // of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of + // 60. High-resolution metrics are those metrics stored by a PutMetricData call + // that includes a StorageResolution of 1 second. If the StartTime parameter + // specifies a time stamp that is greater than 3 hours ago, you must specify the + // period as follows or no data points in that time range is returned: + // + // * Start + // time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 + // minute). + // + // * Start time between 15 and 63 days ago - Use a multiple of 300 + // seconds (5 minutes). + // + // * Start time greater than 63 days ago - Use a multiple + // of 3600 seconds (1 hour). + // + // This member is required. + Period *int32 + // The time stamp that determines the first data point to return. Start times are // evaluated relative to the time that CloudWatch receives the request. The value // specified is inclusive; results include data points with the specified time @@ -149,27 +176,16 @@ type GetMetricStatisticsInput struct { // in the Amazon CloudWatch User Guide. Dimensions []*types.Dimension - // The granularity, in seconds, of the returned data points. For metrics with - // regular resolution, a period can be as short as one minute (60 seconds) and must - // be a multiple of 60. For high-resolution metrics that are collected at intervals - // of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of - // 60. High-resolution metrics are those metrics stored by a PutMetricData call - // that includes a StorageResolution of 1 second. If the StartTime parameter - // specifies a time stamp that is greater than 3 hours ago, you must specify the - // period as follows or no data points in that time range is returned: - // - // * Start - // time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 - // minute). - // - // * Start time between 15 and 63 days ago - Use a multiple of 300 - // seconds (5 minutes). - // - // * Start time greater than 63 days ago - Use a multiple - // of 3600 seconds (1 hour). - // - // This member is required. - Period *int32 + // The percentile statistics. Specify values between p0.0 and p100. When calling + // GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, + // but not both. Percentile statistics are not available for metrics when any of + // the metric values are negative numbers. + ExtendedStatistics []*string + + // The metric statistics, other than percentile. For percentile statistics, use + // ExtendedStatistics. When calling GetMetricStatistics, you must specify either + // Statistics or ExtendedStatistics, but not both. + Statistics []types.Statistic // The unit for a given metric. If you omit Unit, all data that was collected with // any unit is returned, along with the corresponding units that were specified @@ -178,32 +194,16 @@ type GetMetricStatisticsInput struct { // unit that does not match the data collected, the results of the operation are // null. CloudWatch does not perform unit conversions. Unit types.StandardUnit - - // The metric statistics, other than percentile. For percentile statistics, use - // ExtendedStatistics. When calling GetMetricStatistics, you must specify either - // Statistics or ExtendedStatistics, but not both. - Statistics []types.Statistic - - // The namespace of the metric, with or without spaces. - // - // This member is required. - Namespace *string - - // The percentile statistics. Specify values between p0.0 and p100. When calling - // GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, - // but not both. Percentile statistics are not available for metrics when any of - // the metric values are negative numbers. - ExtendedStatistics []*string } type GetMetricStatisticsOutput struct { - // A label for the specified metric. - Label *string - // The data points for the specified metric. Datapoints []*types.Datapoint + // A label for the specified metric. + Label *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudwatch/api_op_ListDashboards.go b/service/cloudwatch/api_op_ListDashboards.go index 9590e7a3885..f5f1e9b906a 100644 --- a/service/cloudwatch/api_op_ListDashboards.go +++ b/service/cloudwatch/api_op_ListDashboards.go @@ -61,14 +61,14 @@ func (c *Client) ListDashboards(ctx context.Context, params *ListDashboardsInput type ListDashboardsInput struct { - // The token returned by a previous call to indicate that there is more data - // available. - NextToken *string - // If you specify this parameter, only the dashboards with names starting with the // specified string are listed. The maximum length is 255, and valid characters are // A-Z, a-z, 0-9, ".", "-", and "_".

    DashboardNamePrefix *string + + // The token returned by a previous call to indicate that there is more data + // available. + NextToken *string } type ListDashboardsOutput struct { diff --git a/service/cloudwatch/api_op_ListMetrics.go b/service/cloudwatch/api_op_ListMetrics.go index 8f8d0bbc076..6adb839230a 100644 --- a/service/cloudwatch/api_op_ListMetrics.go +++ b/service/cloudwatch/api_op_ListMetrics.go @@ -73,12 +73,19 @@ func (c *Client) ListMetrics(ctx context.Context, params *ListMetricsInput, optF type ListMetricsInput struct { + // The dimensions to filter against. + Dimensions []*types.DimensionFilter + // The name of the metric to filter against. MetricName *string // The namespace to filter against. Namespace *string + // The token returned by a previous call to indicate that there is more data + // available. + NextToken *string + // To filter the results to show only metrics that have had data points published // in the past three hours, specify this parameter with a value of PT3H. This is // the only valid value for this parameter. The results that are returned are an @@ -86,23 +93,16 @@ type ListMetricsInput struct { // returned results include metrics with last published data as much as 40 minutes // more than the specified time interval. RecentlyActive types.RecentlyActive - - // The dimensions to filter against. - Dimensions []*types.DimensionFilter - - // The token returned by a previous call to indicate that there is more data - // available. - NextToken *string } type ListMetricsOutput struct { - // The token that marks the start of the next batch of returned results. - NextToken *string - // The metrics that match your request. Metrics []*types.Metric + // The token that marks the start of the next batch of returned results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudwatch/api_op_PutAnomalyDetector.go b/service/cloudwatch/api_op_PutAnomalyDetector.go index 9a8128e7173..c1212525a71 100644 --- a/service/cloudwatch/api_op_PutAnomalyDetector.go +++ b/service/cloudwatch/api_op_PutAnomalyDetector.go @@ -65,6 +65,16 @@ type PutAnomalyDetectorInput struct { // This member is required. MetricName *string + // The namespace of the metric to create the anomaly detection model for. + // + // This member is required. + Namespace *string + + // The statistic to use for the metric and the anomaly detection model. + // + // This member is required. + Stat *string + // The configuration specifies details about how the anomaly detection model is to // be trained, including time ranges to exclude when training and updating the // model. You can specify as many as 10 time ranges. The configuration can also @@ -73,16 +83,6 @@ type PutAnomalyDetectorInput struct { // The metric dimensions to create the anomaly detection model for. Dimensions []*types.Dimension - - // The statistic to use for the metric and the anomaly detection model. - // - // This member is required. - Stat *string - - // The namespace of the metric to create the anomaly detection model for. - // - // This member is required. - Namespace *string } type PutAnomalyDetectorOutput struct { diff --git a/service/cloudwatch/api_op_PutCompositeAlarm.go b/service/cloudwatch/api_op_PutCompositeAlarm.go index fc1049b0b0a..bfa0ce8964c 100644 --- a/service/cloudwatch/api_op_PutCompositeAlarm.go +++ b/service/cloudwatch/api_op_PutCompositeAlarm.go @@ -82,9 +82,10 @@ func (c *Client) PutCompositeAlarm(ctx context.Context, params *PutCompositeAlar type PutCompositeAlarmInput struct { - // Indicates whether actions should be executed during any changes to the alarm - // state of the composite alarm. The default is TRUE. - ActionsEnabled *bool + // The name for the composite alarm. This name must be unique within the Region. + // + // This member is required. + AlarmName *string // An expression that specifies which other alarms are to be evaluated to determine // this composite alarm's state. For each alarm that you reference, you designate a @@ -140,8 +141,9 @@ type PutCompositeAlarmInput struct { // This member is required. AlarmRule *string - // The description for the composite alarm. - AlarmDescription *string + // Indicates whether actions should be executed during any changes to the alarm + // state of the composite alarm. The default is TRUE. + ActionsEnabled *bool // The actions to execute when this alarm transitions to the ALARM state from any // other state. Each action is specified as an Amazon Resource Name (ARN). @@ -150,6 +152,9 @@ type PutCompositeAlarmInput struct { //

    AlarmActions []*string + // The description for the composite alarm. + AlarmDescription *string + // The actions to execute when this alarm transitions to the INSUFFICIENT_DATA // state from any other state. Each action is specified as an Amazon Resource Name // (ARN).

    Valid Values: @@ -157,11 +162,6 @@ type PutCompositeAlarmInput struct { //

    InsufficientDataActions []*string - // The name for the composite alarm. This name must be unique within the Region. - // - // This member is required. - AlarmName *string - // The actions to execute when this alarm transitions to an OK state from any other // state. Each action is specified as an Amazon Resource Name (ARN).

    Valid // Values: arn:aws:sns:region:account-id:sns-topic-name diff --git a/service/cloudwatch/api_op_PutInsightRule.go b/service/cloudwatch/api_op_PutInsightRule.go index e155056ee4e..c4780d38bca 100644 --- a/service/cloudwatch/api_op_PutInsightRule.go +++ b/service/cloudwatch/api_op_PutInsightRule.go @@ -63,14 +63,21 @@ func (c *Client) PutInsightRule(ctx context.Context, params *PutInsightRuleInput type PutInsightRuleInput struct { - // The state of the rule. Valid values are ENABLED and DISABLED. - RuleState *string + // The definition of the rule, as a JSON object. For details on the valid syntax, + // see Contributor Insights Rule Syntax + // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html). + // + // This member is required. + RuleDefinition *string // A unique name for the rule. // // This member is required. RuleName *string + // The state of the rule. Valid values are ENABLED and DISABLED. + RuleState *string + // A list of key-value pairs to associate with the Contributor Insights rule. You // can associate as many as 50 tags with a rule. Tags can help you organize and // categorize your resources. You can also use them to scope user permissions, by @@ -82,13 +89,6 @@ type PutInsightRuleInput struct { // tags of an existing rule, use TagResource // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html). Tags []*types.Tag - - // The definition of the rule, as a JSON object. For details on the valid syntax, - // see Contributor Insights Rule Syntax - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html). - // - // This member is required. - RuleDefinition *string } type PutInsightRuleOutput struct { diff --git a/service/cloudwatch/api_op_PutMetricAlarm.go b/service/cloudwatch/api_op_PutMetricAlarm.go index 8904b7d8a62..1fd5695a9c5 100644 --- a/service/cloudwatch/api_op_PutMetricAlarm.go +++ b/service/cloudwatch/api_op_PutMetricAlarm.go @@ -87,49 +87,10 @@ func (c *Client) PutMetricAlarm(ctx context.Context, params *PutMetricAlarmInput type PutMetricAlarmInput struct { - // The unit of measure for the statistic. For example, the units for the Amazon EC2 - // NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an - // instance receives on all network interfaces. You can also specify a unit when - // you create a custom metric. Units help provide conceptual meaning to your data. - // Metric data points that specify a unit of measure, such as Percent, are - // aggregated separately. If you don't specify Unit, CloudWatch retrieves all unit - // types that have been published for the metric and attempts to evaluate the - // alarm. Usually, metrics are published with only one unit, so the alarm works as - // intended. However, if the metric is published with multiple types of units and - // you don't specify a unit, the alarm's behavior is not defined and it behaves - // predictably. We recommend omitting Unit so that you don't inadvertently specify - // an incorrect unit that is not published for this metric. Doing so causes the - // alarm to be stuck in the INSUFFICIENT DATA state. - Unit types.StandardUnit - - // The length, in seconds, used each time the metric specified in MetricName is - // evaluated. Valid values are 10, 30, and any multiple of 60. Period is required - // for alarms based on static thresholds. If you are creating an alarm based on a - // metric math expression, you specify the period for each metric within the - // objects in the Metrics array. Be sure to specify 10 or 30 only for metrics that - // are stored by a PutMetricData call with a StorageResolution of 1. If you specify - // a period of 10 or 30 for a metric that does not have sub-minute resolution, the - // alarm still attempts to gather data at the period rate that you specify. In this - // case, it does not receive data for the attempts that do not correspond to a - // one-minute data resolution, and the alarm might often lapse into - // INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a - // high-resolution alarm, which has a higher charge than other alarms. For more - // information about pricing, see Amazon CloudWatch Pricing - // (https://aws.amazon.com/cloudwatch/pricing/). An alarm's total current - // evaluation period can be no longer than one day, so Period multiplied by - // EvaluationPeriods cannot be more than 86,400 seconds. - Period *int32 - - // If this is an alarm based on an anomaly detection model, make this value match - // the ID of the ANOMALY_DETECTION_BAND function. For an example of how to use this - // parameter, see the Anomaly Detection Model Alarm example on this page. If your - // alarm uses this parameter, it cannot have Auto Scaling actions. - ThresholdMetricId *string - - // The value against which the specified statistic is compared. This parameter is - // required for alarms based on static thresholds, but should not be used for - // alarms based on anomaly detection models. - Threshold *float64 + // The name for the alarm. This name must be unique within the Region. + // + // This member is required. + AlarmName *string // The arithmetic operation to use when comparing the specified statistic and // threshold. The specified statistic value is used as the first operand. The @@ -140,55 +101,15 @@ type PutMetricAlarmInput struct { // This member is required. ComparisonOperator types.ComparisonOperator - // Used only for alarms based on percentiles. If you specify ignore, the alarm - // state does not change during periods with too few data points to be - // statistically significant. If you specify evaluate or omit this parameter, the - // alarm is always evaluated and possibly changes state no matter how many data - // points are available. For more information, see Percentile-Based CloudWatch - // Alarms and Low Data Samples - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples). - // Valid Values: evaluate | ignore - EvaluateLowSampleCountPercentile *string - - // The percentile statistic for the metric specified in MetricName. Specify a value - // between p0.0 and p100. When you call PutMetricAlarm and specify a MetricName, - // you must specify either Statistic or ExtendedStatistic, but not both. - ExtendedStatistic *string - - // The number of data points that must be breaching to trigger the alarm. This is - // used only if you are setting an "M out of N" alarm. In that case, this value is - // the M. For more information, see Evaluating an Alarm - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) - // in the Amazon CloudWatch User Guide. - DatapointsToAlarm *int32 - - // Sets how this alarm is to handle missing data points. If TreatMissingData is - // omitted, the default behavior of missing is used. For more information, see - // Configuring How CloudWatch Alarms Treats Missing Data - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data). - // Valid Values: breaching | notBreaching | ignore | missing - TreatMissingData *string - - // A list of key-value pairs to associate with the alarm. You can associate as many - // as 50 tags with an alarm. Tags can help you organize and categorize your - // resources. You can also use them to scope user permissions by granting a user - // permission to access or change only resources with certain tag values. - Tags []*types.Tag - - // The name for the alarm. This name must be unique within the Region. + // The number of periods over which data is compared to the specified threshold. If + // you are setting an alarm that requires that a number of consecutive data points + // be breaching to trigger the alarm, this value specifies that number. If you are + // setting an "M out of N" alarm, this value is the N. An alarm's total current + // evaluation period can be no longer than one day, so this number multiplied by + // Period cannot be more than 86,400 seconds. // // This member is required. - AlarmName *string - - // The name for the metric associated with the alarm. For each PutMetricAlarm - // operation, you must specify either MetricName or a Metrics array. If you are - // creating an alarm based on a math expression, you cannot specify this parameter, - // or any of the Dimensions, Period, Namespace, Statistic, or ExtendedStatistic - // parameters. Instead, you specify all this information in the Metrics array. - MetricName *string - - // The description for the alarm. - AlarmDescription *string + EvaluationPeriods *int32 // Indicates whether actions should be executed during any changes to the alarm // state. The default is TRUE. @@ -212,9 +133,34 @@ type PutMetricAlarmInput struct { //

    AlarmActions []*string + // The description for the alarm. + AlarmDescription *string + + // The number of data points that must be breaching to trigger the alarm. This is + // used only if you are setting an "M out of N" alarm. In that case, this value is + // the M. For more information, see Evaluating an Alarm + // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) + // in the Amazon CloudWatch User Guide. + DatapointsToAlarm *int32 + // The dimensions for the metric specified in MetricName. Dimensions []*types.Dimension + // Used only for alarms based on percentiles. If you specify ignore, the alarm + // state does not change during periods with too few data points to be + // statistically significant. If you specify evaluate or omit this parameter, the + // alarm is always evaluated and possibly changes state no matter how many data + // points are available. For more information, see Percentile-Based CloudWatch + // Alarms and Low Data Samples + // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples). + // Valid Values: evaluate | ignore + EvaluateLowSampleCountPercentile *string + + // The percentile statistic for the metric specified in MetricName. Specify a value + // between p0.0 and p100. When you call PutMetricAlarm and specify a MetricName, + // you must specify either Statistic or ExtendedStatistic, but not both. + ExtendedStatistic *string + // The actions to execute when this alarm transitions to the INSUFFICIENT_DATA // state from any other state. Each action is specified as an Amazon Resource Name // (ARN).

    Valid Values: arn:aws:automate:region:ec2:stop | @@ -233,6 +179,30 @@ type PutMetricAlarmInput struct { //

    InsufficientDataActions []*string + // The name for the metric associated with the alarm. For each PutMetricAlarm + // operation, you must specify either MetricName or a Metrics array. If you are + // creating an alarm based on a math expression, you cannot specify this parameter, + // or any of the Dimensions, Period, Namespace, Statistic, or ExtendedStatistic + // parameters. Instead, you specify all this information in the Metrics array. + MetricName *string + + // An array of MetricDataQuery structures that enable you to create an alarm based + // on the result of a metric math expression. For each PutMetricAlarm operation, + // you must specify either MetricName or a Metrics array. Each item in the Metrics + // array either retrieves a metric or performs a math expression. One item in the + // Metrics array is the expression that the alarm watches. You designate this + // expression by setting ReturnValue to true for this object in the array. For more + // information, see MetricDataQuery + // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDataQuery.html). + // If you use the Metrics parameter, you cannot include the MetricName, Dimensions, + // Period, Namespace, Statistic, or ExtendedStatistic parameters of PutMetricAlarm + // in the same operation. Instead, you retrieve the metrics you are using in your + // math expression as part of the Metrics array. + Metrics []*types.MetricDataQuery + + // The namespace for the metric associated specified in MetricName. + Namespace *string + // The actions to execute when this alarm transitions to an OK state from any other // state. Each action is specified as an Amazon Resource Name (ARN).

    Valid // Values: arn:aws:automate:region:ec2:stop | @@ -251,38 +221,68 @@ type PutMetricAlarmInput struct { //

    OKActions []*string - // The namespace for the metric associated specified in MetricName. - Namespace *string - - // The number of periods over which data is compared to the specified threshold. If - // you are setting an alarm that requires that a number of consecutive data points - // be breaching to trigger the alarm, this value specifies that number. If you are - // setting an "M out of N" alarm, this value is the N. An alarm's total current - // evaluation period can be no longer than one day, so this number multiplied by - // Period cannot be more than 86,400 seconds. - // - // This member is required. - EvaluationPeriods *int32 - - // An array of MetricDataQuery structures that enable you to create an alarm based - // on the result of a metric math expression. For each PutMetricAlarm operation, - // you must specify either MetricName or a Metrics array. Each item in the Metrics - // array either retrieves a metric or performs a math expression. One item in the - // Metrics array is the expression that the alarm watches. You designate this - // expression by setting ReturnValue to true for this object in the array. For more - // information, see MetricDataQuery - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDataQuery.html). - // If you use the Metrics parameter, you cannot include the MetricName, Dimensions, - // Period, Namespace, Statistic, or ExtendedStatistic parameters of PutMetricAlarm - // in the same operation. Instead, you retrieve the metrics you are using in your - // math expression as part of the Metrics array. - Metrics []*types.MetricDataQuery + // The length, in seconds, used each time the metric specified in MetricName is + // evaluated. Valid values are 10, 30, and any multiple of 60. Period is required + // for alarms based on static thresholds. If you are creating an alarm based on a + // metric math expression, you specify the period for each metric within the + // objects in the Metrics array. Be sure to specify 10 or 30 only for metrics that + // are stored by a PutMetricData call with a StorageResolution of 1. If you specify + // a period of 10 or 30 for a metric that does not have sub-minute resolution, the + // alarm still attempts to gather data at the period rate that you specify. In this + // case, it does not receive data for the attempts that do not correspond to a + // one-minute data resolution, and the alarm might often lapse into + // INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a + // high-resolution alarm, which has a higher charge than other alarms. For more + // information about pricing, see Amazon CloudWatch Pricing + // (https://aws.amazon.com/cloudwatch/pricing/). An alarm's total current + // evaluation period can be no longer than one day, so Period multiplied by + // EvaluationPeriods cannot be more than 86,400 seconds. + Period *int32 // The statistic for the metric specified in MetricName, other than percentile. For // percentile statistics, use ExtendedStatistic. When you call PutMetricAlarm and // specify a MetricName, you must specify either Statistic or ExtendedStatistic, // but not both. Statistic types.Statistic + + // A list of key-value pairs to associate with the alarm. You can associate as many + // as 50 tags with an alarm. Tags can help you organize and categorize your + // resources. You can also use them to scope user permissions by granting a user + // permission to access or change only resources with certain tag values. + Tags []*types.Tag + + // The value against which the specified statistic is compared. This parameter is + // required for alarms based on static thresholds, but should not be used for + // alarms based on anomaly detection models. + Threshold *float64 + + // If this is an alarm based on an anomaly detection model, make this value match + // the ID of the ANOMALY_DETECTION_BAND function. For an example of how to use this + // parameter, see the Anomaly Detection Model Alarm example on this page. If your + // alarm uses this parameter, it cannot have Auto Scaling actions. + ThresholdMetricId *string + + // Sets how this alarm is to handle missing data points. If TreatMissingData is + // omitted, the default behavior of missing is used. For more information, see + // Configuring How CloudWatch Alarms Treats Missing Data + // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data). + // Valid Values: breaching | notBreaching | ignore | missing + TreatMissingData *string + + // The unit of measure for the statistic. For example, the units for the Amazon EC2 + // NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an + // instance receives on all network interfaces. You can also specify a unit when + // you create a custom metric. Units help provide conceptual meaning to your data. + // Metric data points that specify a unit of measure, such as Percent, are + // aggregated separately. If you don't specify Unit, CloudWatch retrieves all unit + // types that have been published for the metric and attempts to evaluate the + // alarm. Usually, metrics are published with only one unit, so the alarm works as + // intended. However, if the metric is published with multiple types of units and + // you don't specify a unit, the alarm's behavior is not defined and it behaves + // predictably. We recommend omitting Unit so that you don't inadvertently specify + // an incorrect unit that is not published for this metric. Doing so causes the + // alarm to be stuck in the INSUFFICIENT DATA state. + Unit types.StandardUnit } type PutMetricAlarmOutput struct { diff --git a/service/cloudwatch/api_op_PutMetricData.go b/service/cloudwatch/api_op_PutMetricData.go index 569fa6ec461..1f80ae0a95c 100644 --- a/service/cloudwatch/api_op_PutMetricData.go +++ b/service/cloudwatch/api_op_PutMetricData.go @@ -97,16 +97,16 @@ func (c *Client) PutMetricData(ctx context.Context, params *PutMetricDataInput, type PutMetricDataInput struct { - // The namespace for the metric data. To avoid conflicts with AWS service - // namespaces, you should not specify a namespace that begins with AWS/ + // The data for the metric. The array can include no more than 20 metrics per call. // // This member is required. - Namespace *string + MetricData []*types.MetricDatum - // The data for the metric. The array can include no more than 20 metrics per call. + // The namespace for the metric data. To avoid conflicts with AWS service + // namespaces, you should not specify a namespace that begins with AWS/ // // This member is required. - MetricData []*types.MetricDatum + Namespace *string } type PutMetricDataOutput struct { diff --git a/service/cloudwatch/api_op_SetAlarmState.go b/service/cloudwatch/api_op_SetAlarmState.go index 8a35d1f7bf6..83c15756083 100644 --- a/service/cloudwatch/api_op_SetAlarmState.go +++ b/service/cloudwatch/api_op_SetAlarmState.go @@ -71,26 +71,26 @@ func (c *Client) SetAlarmState(ctx context.Context, params *SetAlarmStateInput, type SetAlarmStateInput struct { + // The name of the alarm. + // + // This member is required. + AlarmName *string + // The reason that this alarm is set to this specific state, in text format. // // This member is required. StateReason *string - // The reason that this alarm is set to this specific state, in JSON format. For - // SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling - // or application Auto Scaling alarm actions, the Auto Scaling policy uses the - // information in this field to take the correct action. - StateReasonData *string - // The value of the state. // // This member is required. StateValue types.StateValue - // The name of the alarm. - // - // This member is required. - AlarmName *string + // The reason that this alarm is set to this specific state, in JSON format. For + // SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling + // or application Auto Scaling alarm actions, the Auto Scaling policy uses the + // information in this field to take the correct action. + StateReasonData *string } type SetAlarmStateOutput struct { diff --git a/service/cloudwatch/api_op_TagResource.go b/service/cloudwatch/api_op_TagResource.go index 2607006e8ed..eb3f1333c93 100644 --- a/service/cloudwatch/api_op_TagResource.go +++ b/service/cloudwatch/api_op_TagResource.go @@ -68,11 +68,6 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The list of key-value pairs to associate with the alarm. - // - // This member is required. - Tags []*types.Tag - // The ARN of the CloudWatch resource that you're adding tags to. The ARN format of // an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name The ARN // format of a Contributor Insights rule is @@ -83,6 +78,11 @@ type TagResourceInput struct { // // This member is required. ResourceARN *string + + // The list of key-value pairs to associate with the alarm. + // + // This member is required. + Tags []*types.Tag } type TagResourceOutput struct { diff --git a/service/cloudwatch/go.mod b/service/cloudwatch/go.mod index 8403516a77d..c817b41a681 100644 --- a/service/cloudwatch/go.mod +++ b/service/cloudwatch/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/cloudwatch go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/cloudwatch/types/types.go b/service/cloudwatch/types/types.go index 47882ed4f3c..57867076321 100644 --- a/service/cloudwatch/types/types.go +++ b/service/cloudwatch/types/types.go @@ -9,23 +9,23 @@ import ( // Represents the history of a specific alarm. type AlarmHistoryItem struct { - // Data about the alarm, in JSON format. - HistoryData *string + // The descriptive name for the alarm. + AlarmName *string - // The time stamp for the alarm history item. - Timestamp *time.Time + // The type of alarm, either metric alarm or composite alarm. + AlarmType AlarmType - // A summary of the alarm history, in text format. - HistorySummary *string + // Data about the alarm, in JSON format. + HistoryData *string // The type of alarm history item. HistoryItemType HistoryItemType - // The descriptive name for the alarm. - AlarmName *string + // A summary of the alarm history, in text format. + HistorySummary *string - // The type of alarm, either metric alarm or composite alarm. - AlarmType AlarmType + // The time stamp for the alarm history item. + Timestamp *time.Time } // An anomaly detection model associated with a particular CloudWatch metric and @@ -33,26 +33,26 @@ type AlarmHistoryItem struct { // when the metric is graphed. type AnomalyDetector struct { - // The current status of the anomaly detector's training. The possible values are - // TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA - StateValue AnomalyDetectorStateValue + // The configuration specifies details about how the anomaly detection model is to + // be trained, including time ranges to exclude from use for training the model, + // and the time zone to use for the metric. + Configuration *AnomalyDetectorConfiguration // The metric dimensions associated with the anomaly detection model. Dimensions []*Dimension - // The namespace of the metric associated with the anomaly detection model. - Namespace *string - // The name of the metric associated with the anomaly detection model. MetricName *string + // The namespace of the metric associated with the anomaly detection model. + Namespace *string + // The statistic associated with the anomaly detection model. Stat *string - // The configuration specifies details about how the anomaly detection model is to - // be trained, including time ranges to exclude from use for training the model, - // and the time zone to use for the metric. - Configuration *AnomalyDetectorConfiguration + // The current status of the anomaly detector's training. The possible values are + // TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA + StateValue AnomalyDetectorStateValue } // The configuration specifies details about how the anomaly detection model is to @@ -60,103 +60,113 @@ type AnomalyDetector struct { // the time zone to use for the metric. type AnomalyDetectorConfiguration struct { + // An array of time ranges to exclude from use when the anomaly detection model is + // trained. Use this to make sure that events that could cause unusual values for + // the metric, such as deployments, aren't used when CloudWatch creates the model. + ExcludedTimeRanges []*Range + // The time zone to use for the metric. This is useful to enable the model to // automatically account for daylight savings time changes if the metric is // sensitive to such time changes. To specify a time zone, use the name of the time // zone as specified in the standard tz database. For more information, see tz // database (https://en.wikipedia.org/wiki/Tz_database). MetricTimezone *string - - // An array of time ranges to exclude from use when the anomaly detection model is - // trained. Use this to make sure that events that could cause unusual values for - // the metric, such as deployments, aren't used when CloudWatch creates the model. - ExcludedTimeRanges []*Range } // The details about a composite alarm. type CompositeAlarm struct { - // The rule that this alarm uses to evaluate its alarm state. - AlarmRule *string - - // An explanation for the alarm state, in JSON format. - StateReasonData *string + // Indicates whether actions should be executed during any changes to the alarm + // state. + ActionsEnabled *bool - // The state value for the alarm. - StateValue StateValue + // The actions to execute when this alarm transitions to the ALARM state from any + // other state. Each action is specified as an Amazon Resource Name (ARN). + AlarmActions []*string // The Amazon Resource Name (ARN) of the alarm. AlarmArn *string - // The actions to execute when this alarm transitions to the INSUFFICIENT_DATA - // state from any other state. Each action is specified as an Amazon Resource Name - // (ARN). - InsufficientDataActions []*string - - // Indicates whether actions should be executed during any changes to the alarm - // state. - ActionsEnabled *bool + // The time stamp of the last update to the alarm configuration. + AlarmConfigurationUpdatedTimestamp *time.Time - // An explanation for the alarm state, in text format. - StateReason *string + // The description of the alarm. + AlarmDescription *string // The name of the alarm. AlarmName *string + // The rule that this alarm uses to evaluate its alarm state. + AlarmRule *string + + // The actions to execute when this alarm transitions to the INSUFFICIENT_DATA + // state from any other state. Each action is specified as an Amazon Resource Name + // (ARN). + InsufficientDataActions []*string + // The actions to execute when this alarm transitions to the OK state from any // other state. Each action is specified as an Amazon Resource Name (ARN). OKActions []*string - // The time stamp of the last update to the alarm configuration. - AlarmConfigurationUpdatedTimestamp *time.Time + // An explanation for the alarm state, in text format. + StateReason *string + + // An explanation for the alarm state, in JSON format. + StateReasonData *string // The time stamp of the last update to the alarm state. StateUpdatedTimestamp *time.Time - // The actions to execute when this alarm transitions to the ALARM state from any - // other state. Each action is specified as an Amazon Resource Name (ARN). - AlarmActions []*string - - // The description of the alarm. - AlarmDescription *string + // The state value for the alarm. + StateValue StateValue } // Represents a specific dashboard. type DashboardEntry struct { - // The size of the dashboard, in bytes. - Size *int64 + // The Amazon Resource Name (ARN) of the dashboard. + DashboardArn *string + + // The name of the dashboard. + DashboardName *string // The time stamp of when the dashboard was last modified, either by an API call or // through the console. This number is expressed as the number of milliseconds // since Jan 1, 1970 00:00:00 UTC. LastModified *time.Time - // The name of the dashboard. - DashboardName *string - - // The Amazon Resource Name (ARN) of the dashboard. - DashboardArn *string + // The size of the dashboard, in bytes. + Size *int64 } // An error or warning for the operation. type DashboardValidationMessage struct { - // A message describing the error or warning. - Message *string - // The data path related to the message. DataPath *string + + // A message describing the error or warning. + Message *string } // Encapsulates the statistical data that CloudWatch computes from metric data. type Datapoint struct { + // The average of the metric values that correspond to the data point. + Average *float64 + + // The percentile statistic for the data point. + ExtendedStatistics map[string]*float64 + + // The maximum metric value for the data point. + Maximum *float64 + // The minimum metric value for the data point. Minimum *float64 - // The standard unit for the data point. - Unit StandardUnit + // The number of metric values that contributed to the aggregate value of this data + // point. + SampleCount *float64 // The sum of the metric values for the data point. Sum *float64 @@ -164,18 +174,8 @@ type Datapoint struct { // The time stamp used for the data point. Timestamp *time.Time - // The percentile statistic for the data point. - ExtendedStatistics map[string]*float64 - - // The number of metric values that contributed to the aggregate value of this data - // point. - SampleCount *float64 - - // The maximum metric value for the data point. - Maximum *float64 - - // The average of the metric values that correspond to the data point. - Average *float64 + // The standard unit for the data point. + Unit StandardUnit } // A dimension is a name/value pair that is part of the identity of a metric. You @@ -184,37 +184,46 @@ type Datapoint struct { // of your metrics, you are creating a new variation of that metric. type Dimension struct { - // The value of the dimension. - // - // This member is required. - Value *string - // The name of the dimension. Dimension names cannot contain blank spaces or // non-ASCII characters. // // This member is required. Name *string + + // The value of the dimension. + // + // This member is required. + Value *string } // Represents filters for a dimension. type DimensionFilter struct { - // The value of the dimension to be matched. - Value *string - // The dimension name to be matched. // // This member is required. Name *string + + // The value of the dimension to be matched. + Value *string } // This structure contains the definition for a Contributor Insights rule. type InsightRule struct { - // Indicates whether the rule is enabled or disabled. + // The definition of the rule, as a JSON object. The definition contains the + // keywords used to define contributors, the value to aggregate on if this rule + // returns a sum instead of a count, and the filters. For details on the valid + // syntax, see Contributor Insights Rule Syntax + // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html). // // This member is required. - State *string + Definition *string + + // The name of the rule. + // + // This member is required. + Name *string // For rules that you create, this is always {"Name": "CloudWatchLogRule", // "Version": 1}. For built-in rules, this is {"Name": "ServiceLogRule", "Version": @@ -223,19 +232,10 @@ type InsightRule struct { // This member is required. Schema *string - // The name of the rule. - // - // This member is required. - Name *string - - // The definition of the rule, as a JSON object. The definition contains the - // keywords used to define contributors, the value to aggregate on if this rule - // returns a sum instead of a count, and the filters. For details on the valid - // syntax, see Contributor Insights Rule Syntax - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html). + // Indicates whether the rule is enabled or disabled. // // This member is required. - Definition *string + State *string } // One of the unique contributors found by a Contributor Insights rule. If the rule @@ -246,11 +246,10 @@ type InsightRule struct { // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html). type InsightRuleContributor struct { - // One of the log entry field keywords that is used to define contributors for this - // rule. + // An approximation of the aggregate value that comes from this contributor. // // This member is required. - Keys []*string + ApproximateAggregateValue *float64 // An array of the data points where this contributor is present. Only the data // points when this contributor appeared are included in the array. @@ -258,10 +257,11 @@ type InsightRuleContributor struct { // This member is required. Datapoints []*InsightRuleContributorDatapoint - // An approximation of the aggregate value that comes from this contributor. + // One of the log entry field keywords that is used to define contributors for this + // rule. // // This member is required. - ApproximateAggregateValue *float64 + Keys []*string } // One data point related to one contributor. For more information, see @@ -287,79 +287,116 @@ type InsightRuleContributorDatapoint struct { // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html). type InsightRuleMetricDatapoint struct { - // The minimum value from a single contributor during the time period represented - // by that data point. This statistic is returned only if you included it in the - // Metrics array in your request. - Minimum *float64 + // The timestamp of the data point. + // + // This member is required. + Timestamp *time.Time - // The number of occurrences that matched the rule during this data point. This - // statistic is returned only if you included it in the Metrics array in your - // request. - SampleCount *float64 + // The average value from all contributors during the time period represented by + // that data point. This statistic is returned only if you included it in the + // Metrics array in your request. + Average *float64 - // The number of unique contributors who published data during this timestamp. This - // statistic is returned only if you included it in the Metrics array in your - // request. - UniqueContributors *float64 + // The maximum value provided by one contributor during this timestamp. Each + // timestamp is evaluated separately, so the identity of the max contributor could + // be different for each timestamp. This statistic is returned only if you included + // it in the Metrics array in your request. + MaxContributorValue *float64 // The maximum value from a single occurence from a single contributor during the // time period represented by that data point. This statistic is returned only if // you included it in the Metrics array in your request. Maximum *float64 - // The average value from all contributors during the time period represented by - // that data point. This statistic is returned only if you included it in the + // The minimum value from a single contributor during the time period represented + // by that data point. This statistic is returned only if you included it in the // Metrics array in your request. - Average *float64 + Minimum *float64 - // The timestamp of the data point. - // - // This member is required. - Timestamp *time.Time + // The number of occurrences that matched the rule during this data point. This + // statistic is returned only if you included it in the Metrics array in your + // request. + SampleCount *float64 // The sum of the values from all contributors during the time period represented // by that data point. This statistic is returned only if you included it in the // Metrics array in your request. Sum *float64 - // The maximum value provided by one contributor during this timestamp. Each - // timestamp is evaluated separately, so the identity of the max contributor could - // be different for each timestamp. This statistic is returned only if you included - // it in the Metrics array in your request. - MaxContributorValue *float64 + // The number of unique contributors who published data during this timestamp. This + // statistic is returned only if you included it in the Metrics array in your + // request. + UniqueContributors *float64 } // A message returned by the GetMetricDataAPI, including a code and a description. type MessageData struct { - // The message text. - Value *string - // The error code or status code associated with the message. Code *string + + // The message text. + Value *string } // Represents a specific metric. type Metric struct { - // The namespace of the metric. - Namespace *string + // The dimensions for the metric. + Dimensions []*Dimension // The name of the metric. This is a required field. MetricName *string - // The dimensions for the metric. + // The namespace of the metric. + Namespace *string +} + +// The details about a metric alarm. +type MetricAlarm struct { + + // Indicates whether actions should be executed during any changes to the alarm + // state. + ActionsEnabled *bool + + // The actions to execute when this alarm transitions to the ALARM state from any + // other state. Each action is specified as an Amazon Resource Name (ARN). + AlarmActions []*string + + // The Amazon Resource Name (ARN) of the alarm. + AlarmArn *string + + // The time stamp of the last update to the alarm configuration. + AlarmConfigurationUpdatedTimestamp *time.Time + + // The description of the alarm. + AlarmDescription *string + + // The name of the alarm. + AlarmName *string + + // The arithmetic operation to use when comparing the specified statistic and + // threshold. The specified statistic value is used as the first operand. + ComparisonOperator ComparisonOperator + + // The number of data points that must be breaching to trigger the alarm. + DatapointsToAlarm *int32 + + // The dimensions for the metric associated with the alarm. Dimensions []*Dimension -} -// The details about a metric alarm. -type MetricAlarm struct { + // Used only for alarms based on percentiles. If ignore, the alarm state does not + // change during periods with too few data points to be statistically significant. + // If evaluate or this parameter is not used, the alarm is always evaluated and + // possibly changes state no matter how many data points are available. + EvaluateLowSampleCountPercentile *string - // The description of the alarm. - AlarmDescription *string + // The number of periods over which data is compared to the specified threshold. + EvaluationPeriods *int32 - // The state value for the alarm. - StateValue StateValue + // The percentile statistic for the metric associated with the alarm. Specify a + // value between p0.0 and p100. + ExtendedStatistic *string // The actions to execute when this alarm transitions to the INSUFFICIENT_DATA // state from any other state. Each action is specified as an Amazon Resource Name @@ -370,89 +407,52 @@ type MetricAlarm struct { // single metric. MetricName *string - // In an alarm based on an anomaly detection model, this is the ID of the - // ANOMALY_DETECTION_BAND function used as the threshold for the alarm. - ThresholdMetricId *string + // An array of MetricDataQuery structures, used in an alarm based on a metric math + // expression. Each structure either retrieves a metric or performs a math + // expression. One item in the Metrics array is the math expression that the alarm + // watches. This expression by designated by having ReturnValue set to + // true.

    + Metrics []*MetricDataQuery - // The actions to execute when this alarm transitions to the ALARM state from any - // other state. Each action is specified as an Amazon Resource Name (ARN). - AlarmActions []*string + // The namespace of the metric associated with the alarm. + Namespace *string - // The name of the alarm. - AlarmName *string + // The actions to execute when this alarm transitions to the OK state from any + // other state. Each action is specified as an Amazon Resource Name (ARN). + OKActions []*string // The period, in seconds, over which the statistic is applied. Period *int32 - // The number of periods over which data is compared to the specified threshold. - EvaluationPeriods *int32 - - // An explanation for the alarm state, in JSON format. - StateReasonData *string - - // The time stamp of the last update to the alarm configuration. - AlarmConfigurationUpdatedTimestamp *time.Time - // An explanation for the alarm state, in text format. StateReason *string - // The Amazon Resource Name (ARN) of the alarm. - AlarmArn *string + // An explanation for the alarm state, in JSON format. + StateReasonData *string - // The dimensions for the metric associated with the alarm. - Dimensions []*Dimension + // The time stamp of the last update to the alarm state. + StateUpdatedTimestamp *time.Time - // Indicates whether actions should be executed during any changes to the alarm - // state. - ActionsEnabled *bool + // The state value for the alarm. + StateValue StateValue - // The namespace of the metric associated with the alarm. - Namespace *string + // The statistic for the metric associated with the alarm, other than percentile. + // For percentile statistics, use ExtendedStatistic. + Statistic Statistic - // The percentile statistic for the metric associated with the alarm. Specify a - // value between p0.0 and p100. - ExtendedStatistic *string + // The value to compare with the specified statistic. + Threshold *float64 - // Used only for alarms based on percentiles. If ignore, the alarm state does not - // change during periods with too few data points to be statistically significant. - // If evaluate or this parameter is not used, the alarm is always evaluated and - // possibly changes state no matter how many data points are available. - EvaluateLowSampleCountPercentile *string + // In an alarm based on an anomaly detection model, this is the ID of the + // ANOMALY_DETECTION_BAND function used as the threshold for the alarm. + ThresholdMetricId *string // Sets how this alarm is to handle missing data points. If this parameter is // omitted, the default behavior of missing is used. TreatMissingData *string - // The time stamp of the last update to the alarm state. - StateUpdatedTimestamp *time.Time - - // The number of data points that must be breaching to trigger the alarm. - DatapointsToAlarm *int32 - // The unit of the metric associated with the alarm. Unit StandardUnit - - // The arithmetic operation to use when comparing the specified statistic and - // threshold. The specified statistic value is used as the first operand. - ComparisonOperator ComparisonOperator - - // The value to compare with the specified statistic. - Threshold *float64 - - // The actions to execute when this alarm transitions to the OK state from any - // other state. Each action is specified as an Amazon Resource Name (ARN). - OKActions []*string - - // An array of MetricDataQuery structures, used in an alarm based on a metric math - // expression. Each structure either retrieves a metric or performs a math - // expression. One item in the Metrics array is the math expression that the alarm - // watches. This expression by designated by having ReturnValue set to - // true.

    - Metrics []*MetricDataQuery - - // The statistic for the metric associated with the alarm, other than percentile. - // For percentile statistics, use ExtendedStatistic. - Statistic Statistic } // This structure is used in both GetMetricData and PutMetricAlarm. The supported @@ -479,6 +479,15 @@ type MetricAlarm struct { // following parameter list.

    type MetricDataQuery struct { + // A short name used to tie this object to the results in the response. This name + // must be unique within a single call to GetMetricData. If you are performing math + // expressions on this set of data, this name represents that data and can serve as + // a variable in the mathematical expression. The valid characters are letters, + // numbers, and underscore. The first character must be a lowercase letter. + // + // This member is required. + Id *string + // The math expression to be performed on the returned data, if this object is // performing a math expression. This expression can use the Id of the other // metrics to refer to those metrics, and can also use the Id of other expressions @@ -489,6 +498,18 @@ type MetricDataQuery struct { // must specify either Expression or MetricStat but not both. Expression *string + // A human-readable label for this metric or expression. This is especially useful + // if this is an expression, so that you know what the value represents. If the + // metric or expression is shown in a CloudWatch dashboard widget, the label is + // shown. If Label is omitted, CloudWatch generates a default. + Label *string + + // The metric to be returned, along with statistics, period, and units. Use this + // parameter only if this object is retrieving a metric and not performing a math + // expression on returned data. Within one MetricDataQuery object, you must specify + // either Expression or MetricStat but not both. + MetricStat *MetricStat + // The granularity, in seconds, of the returned data points. For metrics with // regular resolution, a period can be as short as one minute (60 seconds) and must // be a multiple of 60. For high-resolution metrics that are collected at intervals @@ -505,27 +526,6 @@ type MetricDataQuery struct { // For all other metrics and expressions in the same PutMetricAlarm operation, // specify ReturnData as False. ReturnData *bool - - // A short name used to tie this object to the results in the response. This name - // must be unique within a single call to GetMetricData. If you are performing math - // expressions on this set of data, this name represents that data and can serve as - // a variable in the mathematical expression. The valid characters are letters, - // numbers, and underscore. The first character must be a lowercase letter. - // - // This member is required. - Id *string - - // The metric to be returned, along with statistics, period, and units. Use this - // parameter only if this object is retrieving a metric and not performing a math - // expression on returned data. Within one MetricDataQuery object, you must specify - // either Expression or MetricStat but not both. - MetricStat *MetricStat - - // A human-readable label for this metric or expression. This is especially useful - // if this is an expression, so that you know what the value represents. If the - // metric or expression is shown in a CloudWatch dashboard widget, the label is - // shown. If Label is omitted, CloudWatch generates a default. - Label *string } // A GetMetricData call returns an array of MetricDataResult structures. Each of @@ -533,6 +533,15 @@ type MetricDataQuery struct { // timestamps of those data points and other identifying information. type MetricDataResult struct { + // The short name you specified to represent this metric. + Id *string + + // The human-readable label associated with the data. + Label *string + + // A list of messages with additional information about the data returned. + Messages []*MessageData + // The status of the returned data. Complete indicates that all data points in the // requested time range were returned. PartialData means that an incomplete set of // data points were returned. You can use the NextToken value that was returned and @@ -541,20 +550,11 @@ type MetricDataResult struct { // occurred. Retry your request using NextToken, if present. StatusCode StatusCode - // A list of messages with additional information about the data returned. - Messages []*MessageData - // The timestamps for the data points, formatted in Unix timestamp format. The // number of timestamps always matches the number of values and the value for // Timestamps[x] is Values[x]. Timestamps []*time.Time - // The short name you specified to represent this metric. - Id *string - - // The human-readable label associated with the data. - Label *string - // The data points for the metric corresponding to Timestamps. The number of values // always matches the number of timestamps and the timestamp for Values[x] is // Timestamps[x]. @@ -565,20 +565,23 @@ type MetricDataResult struct { // be aggregated into an existing metric. type MetricDatum struct { - // When you are using a Put operation, this defines what unit you want to use when - // storing the metric. In a Get operation, this displays the unit that is used for - // the metric. - Unit StandardUnit + // The name of the metric. + // + // This member is required. + MetricName *string - // Array of numbers representing the values for the metric during the period. Each - // unique value is listed just once in this array, and the corresponding number in - // the Counts array specifies the number of times that value occurred during the - // period. You can include up to 150 unique values in each PutMetricData action - // that specifies a Values array. Although the Values array accepts numbers of type - // Double, CloudWatch rejects values that are either too small or too large. Values - // must be in the range of -2^360 to 2^360. In addition, special values (for - // example, NaN, +Infinity, -Infinity) are not supported. - Values []*float64 + // Array of numbers that is used along with the Values array. Each number in the + // Count array is the number of times the corresponding value in the Values array + // occurred during the period. If you omit the Counts array, the default of 1 is + // used as the value for each count. If you include a Counts array, it must include + // the same amount of values as the Values array. + Counts []*float64 + + // The dimensions associated with the metric. + Dimensions []*Dimension + + // The statistical values for the metric. + StatisticValues *StatisticSet // Valid values are 1 and 60. Setting this to 1 specifies this metric as a // high-resolution metric, so that CloudWatch stores the metric with sub-minute @@ -591,33 +594,30 @@ type MetricDatum struct { // specify it the default of 60 is used. StorageResolution *int32 - // The dimensions associated with the metric. - Dimensions []*Dimension - // The time the metric data was received, expressed as the number of milliseconds // since Jan 1, 1970 00:00:00 UTC. Timestamp *time.Time - // The name of the metric. - // - // This member is required. - MetricName *string - - // The statistical values for the metric. - StatisticValues *StatisticSet - - // Array of numbers that is used along with the Values array. Each number in the - // Count array is the number of times the corresponding value in the Values array - // occurred during the period. If you omit the Counts array, the default of 1 is - // used as the value for each count. If you include a Counts array, it must include - // the same amount of values as the Values array. - Counts []*float64 + // When you are using a Put operation, this defines what unit you want to use when + // storing the metric. In a Get operation, this displays the unit that is used for + // the metric. + Unit StandardUnit // The value for the metric. Although the parameter accepts numbers of type Double, // CloudWatch rejects values that are either too small or too large. Values must be // in the range of -2^360 to 2^360. In addition, special values (for example, NaN, // +Infinity, -Infinity) are not supported. Value *float64 + + // Array of numbers representing the values for the metric during the period. Each + // unique value is listed just once in this array, and the corresponding number in + // the Counts array specifies the number of times that value occurred during the + // period. You can include up to 150 unique values in each PutMetricData action + // that specifies a Values array. Although the Values array accepts numbers of type + // Double, CloudWatch rejects values that are either too small or too large. Values + // must be in the range of -2^360 to 2^360. In addition, special values (for + // example, NaN, +Infinity, -Infinity) are not supported. + Values []*float64 } // This structure defines the metric to be returned, along with the statistics, @@ -651,6 +651,12 @@ type MetricStat struct { // This member is required. Period *int32 + // The statistic to return. It can include any CloudWatch statistic or extended + // statistic. + // + // This member is required. + Stat *string + // When you are using a Put operation, this defines what unit you want to use when // storing the metric. In a Get operation, if you omit Unit then all data that was // collected with any unit is returned, along with the corresponding units that @@ -659,12 +665,6 @@ type MetricStat struct { // you specify a unit that does not match the data collected, the results of the // operation are null. CloudWatch does not perform unit conversions. Unit StandardUnit - - // The statistic to return. It can include any CloudWatch statistic or extended - // statistic. - // - // This member is required. - Stat *string } // This array is empty if the API operation was successful for all the rules @@ -675,14 +675,14 @@ type PartialFailure struct { // The type of error. ExceptionType *string - // The specified rule that could not be deleted. - FailureResource *string + // The code of the error. + FailureCode *string // A description of the error. FailureDescription *string - // The code of the error. - FailureCode *string + // The specified rule that could not be deleted. + FailureResource *string } // Specifies one range of days or times to exclude from use for training an anomaly @@ -705,15 +705,15 @@ type Range struct { // Represents a set of statistics that describes a specific metric. type StatisticSet struct { - // The minimum value of the sample set. + // The maximum value of the sample set. // // This member is required. - Minimum *float64 + Maximum *float64 - // The maximum value of the sample set. + // The minimum value of the sample set. // // This member is required. - Maximum *float64 + Minimum *float64 // The number of samples used for the statistic set. // diff --git a/service/cloudwatchevents/api_op_CreateEventBus.go b/service/cloudwatchevents/api_op_CreateEventBus.go index 274d0a57ad6..ebc2fd9c7a6 100644 --- a/service/cloudwatchevents/api_op_CreateEventBus.go +++ b/service/cloudwatchevents/api_op_CreateEventBus.go @@ -59,10 +59,6 @@ func (c *Client) CreateEventBus(ctx context.Context, params *CreateEventBusInput type CreateEventBusInput struct { - // If you are creating a partner event bus, this specifies the partner event source - // that the new event bus will be matched with. - EventSourceName *string - // The name of the new event bus. Event bus names cannot contain the / character. // You can't use the name default for a custom event bus, as this name is already // used for your account's default event bus. If this is a partner event bus, the @@ -72,6 +68,10 @@ type CreateEventBusInput struct { // This member is required. Name *string + // If you are creating a partner event bus, this specifies the partner event source + // that the new event bus will be matched with. + EventSourceName *string + // Tags to associate with the event bus. Tags []*types.Tag } diff --git a/service/cloudwatchevents/api_op_CreatePartnerEventSource.go b/service/cloudwatchevents/api_op_CreatePartnerEventSource.go index bda5c5eb524..28bf7e15e88 100644 --- a/service/cloudwatchevents/api_op_CreatePartnerEventSource.go +++ b/service/cloudwatchevents/api_op_CreatePartnerEventSource.go @@ -71,6 +71,12 @@ func (c *Client) CreatePartnerEventSource(ctx context.Context, params *CreatePar type CreatePartnerEventSourceInput struct { + // The AWS account ID that is permitted to create a matching partner event bus for + // this partner event source. + // + // This member is required. + Account *string + // The name of the partner event source. This name must be unique and must be in // the format partner_name/event_namespace/event_name . The AWS account that wants // to use this partner event source must create a partner event bus with a name @@ -78,12 +84,6 @@ type CreatePartnerEventSourceInput struct { // // This member is required. Name *string - - // The AWS account ID that is permitted to create a matching partner event bus for - // this partner event source. - // - // This member is required. - Account *string } type CreatePartnerEventSourceOutput struct { diff --git a/service/cloudwatchevents/api_op_DeleteRule.go b/service/cloudwatchevents/api_op_DeleteRule.go index 3b2ee591e3c..2f27cd511a9 100644 --- a/service/cloudwatchevents/api_op_DeleteRule.go +++ b/service/cloudwatchevents/api_op_DeleteRule.go @@ -63,15 +63,15 @@ func (c *Client) DeleteRule(ctx context.Context, params *DeleteRuleInput, optFns type DeleteRuleInput struct { - // The event bus associated with the rule. If you omit this, the default event bus - // is used. - EventBusName *string - // The name of the rule. // // This member is required. Name *string + // The event bus associated with the rule. If you omit this, the default event bus + // is used. + EventBusName *string + // If this is a managed rule, created by an AWS service on your behalf, you must // specify Force as True to delete the rule. This parameter is ignored for rules // that are not managed rules. You can check whether a rule is a managed rule by diff --git a/service/cloudwatchevents/api_op_DescribeEventBus.go b/service/cloudwatchevents/api_op_DescribeEventBus.go index 43311e5deea..5208c5169aa 100644 --- a/service/cloudwatchevents/api_op_DescribeEventBus.go +++ b/service/cloudwatchevents/api_op_DescribeEventBus.go @@ -68,13 +68,13 @@ type DescribeEventBusInput struct { type DescribeEventBusOutput struct { - // The name of the event bus. Currently, this is always default. - Name *string - // The Amazon Resource Name (ARN) of the account permitted to write events to the // current account. Arn *string + // The name of the event bus. Currently, this is always default. + Name *string + // The policy that enables the external account to send events to your account. Policy *string diff --git a/service/cloudwatchevents/api_op_DescribeEventSource.go b/service/cloudwatchevents/api_op_DescribeEventSource.go index a2e40f7a0fe..05137232df7 100644 --- a/service/cloudwatchevents/api_op_DescribeEventSource.go +++ b/service/cloudwatchevents/api_op_DescribeEventSource.go @@ -67,18 +67,21 @@ type DescribeEventSourceInput struct { type DescribeEventSourceOutput struct { + // The ARN of the partner event source. + Arn *string + // The name of the SaaS partner that created the event source. CreatedBy *string - // The name of the partner event source. - Name *string + // The date and time that the event source was created. + CreationTime *time.Time // The date and time that the event source will expire if you do not create a // matching event bus. ExpirationTime *time.Time - // The ARN of the partner event source. - Arn *string + // The name of the partner event source. + Name *string // The state of the event source. If it is ACTIVE, you have already created a // matching event bus for this event source, and that event bus is active. If it is @@ -87,9 +90,6 @@ type DescribeEventSourceOutput struct { // event source has since been deleted. State types.EventSourceState - // The date and time that the event source was created. - CreationTime *time.Time - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudwatchevents/api_op_DescribeRule.go b/service/cloudwatchevents/api_op_DescribeRule.go index 38c637ba1ed..f770596e729 100644 --- a/service/cloudwatchevents/api_op_DescribeRule.go +++ b/service/cloudwatchevents/api_op_DescribeRule.go @@ -58,36 +58,27 @@ func (c *Client) DescribeRule(ctx context.Context, params *DescribeRuleInput, op type DescribeRuleInput struct { - // The event bus associated with the rule. If you omit this, the default event bus - // is used. - EventBusName *string - // The name of the rule. // // This member is required. Name *string + + // The event bus associated with the rule. If you omit this, the default event bus + // is used. + EventBusName *string } type DescribeRuleOutput struct { - // The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". - ScheduleExpression *string - - // The name of the rule. - Name *string + // The Amazon Resource Name (ARN) of the rule. + Arn *string - // The Amazon Resource Name (ARN) of the IAM role associated with the rule. - RoleArn *string + // The description of the rule. + Description *string // The event bus associated with the rule. EventBusName *string - // Specifies whether the rule is enabled or disabled. - State types.RuleState - - // The Amazon Resource Name (ARN) of the rule. - Arn *string - // The event pattern. For more information, see Events and Event Patterns // (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) // in the Amazon EventBridge User Guide. @@ -97,8 +88,17 @@ type DescribeRuleOutput struct { // displays the principal name of the AWS service that created the rule. ManagedBy *string - // The description of the rule. - Description *string + // The name of the rule. + Name *string + + // The Amazon Resource Name (ARN) of the IAM role associated with the rule. + RoleArn *string + + // The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". + ScheduleExpression *string + + // Specifies whether the rule is enabled or disabled. + State types.RuleState // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/cloudwatchevents/api_op_DisableRule.go b/service/cloudwatchevents/api_op_DisableRule.go index 3c295a21711..5257ac7e53c 100644 --- a/service/cloudwatchevents/api_op_DisableRule.go +++ b/service/cloudwatchevents/api_op_DisableRule.go @@ -59,14 +59,14 @@ func (c *Client) DisableRule(ctx context.Context, params *DisableRuleInput, optF type DisableRuleInput struct { - // The event bus associated with the rule. If you omit this, the default event bus - // is used. - EventBusName *string - // The name of the rule. // // This member is required. Name *string + + // The event bus associated with the rule. If you omit this, the default event bus + // is used. + EventBusName *string } type DisableRuleOutput struct { diff --git a/service/cloudwatchevents/api_op_EnableRule.go b/service/cloudwatchevents/api_op_EnableRule.go index 218e34b2261..7ae4f59e200 100644 --- a/service/cloudwatchevents/api_op_EnableRule.go +++ b/service/cloudwatchevents/api_op_EnableRule.go @@ -59,14 +59,14 @@ func (c *Client) EnableRule(ctx context.Context, params *EnableRuleInput, optFns type EnableRuleInput struct { - // The event bus associated with the rule. If you omit this, the default event bus - // is used. - EventBusName *string - // The name of the rule. // // This member is required. Name *string + + // The event bus associated with the rule. If you omit this, the default event bus + // is used. + EventBusName *string } type EnableRuleOutput struct { diff --git a/service/cloudwatchevents/api_op_ListEventBuses.go b/service/cloudwatchevents/api_op_ListEventBuses.go index c0fd7585f61..6de58edcb46 100644 --- a/service/cloudwatchevents/api_op_ListEventBuses.go +++ b/service/cloudwatchevents/api_op_ListEventBuses.go @@ -57,17 +57,17 @@ func (c *Client) ListEventBuses(ctx context.Context, params *ListEventBusesInput type ListEventBusesInput struct { + // Specifying this limits the number of results returned by this operation. The + // operation also returns a NextToken which you can use in a subsequent operation + // to retrieve the next set of results. + Limit *int32 + // Specifying this limits the results to only those event buses with names that // start with the specified prefix. NamePrefix *string // The token returned by a previous call to retrieve the next set of results. NextToken *string - - // Specifying this limits the number of results returned by this operation. The - // operation also returns a NextToken which you can use in a subsequent operation - // to retrieve the next set of results. - Limit *int32 } type ListEventBusesOutput struct { diff --git a/service/cloudwatchevents/api_op_ListEventSources.go b/service/cloudwatchevents/api_op_ListEventSources.go index 5c7c0542530..55bc4fc0537 100644 --- a/service/cloudwatchevents/api_op_ListEventSources.go +++ b/service/cloudwatchevents/api_op_ListEventSources.go @@ -58,28 +58,28 @@ func (c *Client) ListEventSources(ctx context.Context, params *ListEventSourcesI type ListEventSourcesInput struct { - // Specifying this limits the results to only those partner event sources with - // names that start with the specified prefix. - NamePrefix *string - // Specifying this limits the number of results returned by this operation. The // operation also returns a NextToken which you can use in a subsequent operation // to retrieve the next set of results. Limit *int32 + // Specifying this limits the results to only those partner event sources with + // names that start with the specified prefix. + NamePrefix *string + // The token returned by a previous call to retrieve the next set of results. NextToken *string } type ListEventSourcesOutput struct { + // The list of event sources. + EventSources []*types.EventSource + // A token you can use in a subsequent operation to retrieve the next set of // results. NextToken *string - // The list of event sources. - EventSources []*types.EventSource - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudwatchevents/api_op_ListPartnerEventSourceAccounts.go b/service/cloudwatchevents/api_op_ListPartnerEventSourceAccounts.go index 3b6d1b0f974..5e0e6fb5411 100644 --- a/service/cloudwatchevents/api_op_ListPartnerEventSourceAccounts.go +++ b/service/cloudwatchevents/api_op_ListPartnerEventSourceAccounts.go @@ -59,10 +59,6 @@ func (c *Client) ListPartnerEventSourceAccounts(ctx context.Context, params *Lis type ListPartnerEventSourceAccountsInput struct { - // The token returned by a previous call to this operation. Specifying this - // retrieves the next set of results. - NextToken *string - // The name of the partner event source to display account information about. // // This member is required. @@ -72,17 +68,21 @@ type ListPartnerEventSourceAccountsInput struct { // operation also returns a NextToken which you can use in a subsequent operation // to retrieve the next set of results. Limit *int32 + + // The token returned by a previous call to this operation. Specifying this + // retrieves the next set of results. + NextToken *string } type ListPartnerEventSourceAccountsOutput struct { - // The list of partner event sources returned by the operation. - PartnerEventSourceAccounts []*types.PartnerEventSourceAccount - // A token you can use in a subsequent operation to retrieve the next set of // results. NextToken *string + // The list of partner event sources returned by the operation. + PartnerEventSourceAccounts []*types.PartnerEventSourceAccount + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudwatchevents/api_op_ListPartnerEventSources.go b/service/cloudwatchevents/api_op_ListPartnerEventSources.go index 4207783e487..7480e02cec9 100644 --- a/service/cloudwatchevents/api_op_ListPartnerEventSources.go +++ b/service/cloudwatchevents/api_op_ListPartnerEventSources.go @@ -76,13 +76,13 @@ type ListPartnerEventSourcesInput struct { type ListPartnerEventSourcesOutput struct { - // The list of partner event sources returned by the operation. - PartnerEventSources []*types.PartnerEventSource - // A token you can use in a subsequent operation to retrieve the next set of // results. NextToken *string + // The list of partner event sources returned by the operation. + PartnerEventSources []*types.PartnerEventSource + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudwatchevents/api_op_ListRuleNamesByTarget.go b/service/cloudwatchevents/api_op_ListRuleNamesByTarget.go index 292913f056a..026c5bcf74c 100644 --- a/service/cloudwatchevents/api_op_ListRuleNamesByTarget.go +++ b/service/cloudwatchevents/api_op_ListRuleNamesByTarget.go @@ -57,31 +57,31 @@ func (c *Client) ListRuleNamesByTarget(ctx context.Context, params *ListRuleName type ListRuleNamesByTargetInput struct { - // The maximum number of results to return. - Limit *int32 - - // The token returned by a previous call to retrieve the next set of results. - NextToken *string + // The Amazon Resource Name (ARN) of the target resource. + // + // This member is required. + TargetArn *string // Limits the results to show only the rules associated with the specified event // bus. EventBusName *string - // The Amazon Resource Name (ARN) of the target resource. - // - // This member is required. - TargetArn *string + // The maximum number of results to return. + Limit *int32 + + // The token returned by a previous call to retrieve the next set of results. + NextToken *string } type ListRuleNamesByTargetOutput struct { - // The names of the rules that can invoke the given target. - RuleNames []*string - // Indicates whether there are additional results to retrieve. If there are no more // results, the value is null. NextToken *string + // The names of the rules that can invoke the given target. + RuleNames []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudwatchevents/api_op_ListRules.go b/service/cloudwatchevents/api_op_ListRules.go index 9f9ea983c30..eef8fe9a190 100644 --- a/service/cloudwatchevents/api_op_ListRules.go +++ b/service/cloudwatchevents/api_op_ListRules.go @@ -59,29 +59,29 @@ func (c *Client) ListRules(ctx context.Context, params *ListRulesInput, optFns . type ListRulesInput struct { - // The token returned by a previous call to retrieve the next set of results. - NextToken *string - // Limits the results to show only the rules associated with the specified event // bus. EventBusName *string + // The maximum number of results to return. + Limit *int32 + // The prefix matching the rule name. NamePrefix *string - // The maximum number of results to return. - Limit *int32 + // The token returned by a previous call to retrieve the next set of results. + NextToken *string } type ListRulesOutput struct { - // The rules that match the specified criteria. - Rules []*types.Rule - // Indicates whether there are additional results to retrieve. If there are no more // results, the value is null. NextToken *string + // The rules that match the specified criteria. + Rules []*types.Rule + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudwatchevents/api_op_ListTargetsByRule.go b/service/cloudwatchevents/api_op_ListTargetsByRule.go index cbce24ba2c9..5c879fa073c 100644 --- a/service/cloudwatchevents/api_op_ListTargetsByRule.go +++ b/service/cloudwatchevents/api_op_ListTargetsByRule.go @@ -57,20 +57,20 @@ func (c *Client) ListTargetsByRule(ctx context.Context, params *ListTargetsByRul type ListTargetsByRuleInput struct { - // The event bus associated with the rule. If you omit this, the default event bus - // is used. - EventBusName *string - - // The token returned by a previous call to retrieve the next set of results. - NextToken *string - // The name of the rule. // // This member is required. Rule *string + // The event bus associated with the rule. If you omit this, the default event bus + // is used. + EventBusName *string + // The maximum number of results to return. Limit *int32 + + // The token returned by a previous call to retrieve the next set of results. + NextToken *string } type ListTargetsByRuleOutput struct { diff --git a/service/cloudwatchevents/api_op_PutEvents.go b/service/cloudwatchevents/api_op_PutEvents.go index 5a85918b322..fd51eb15766 100644 --- a/service/cloudwatchevents/api_op_PutEvents.go +++ b/service/cloudwatchevents/api_op_PutEvents.go @@ -67,14 +67,14 @@ type PutEventsInput struct { type PutEventsOutput struct { - // The number of failed entries. - FailedEntryCount *int32 - // The successfully and unsuccessfully ingested events results. If the ingestion // was successful, the entry has the event ID in it. Otherwise, you can use the // error code and error message to identify the problem with the entry. Entries []*types.PutEventsResultEntry + // The number of failed entries. + FailedEntryCount *int32 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudwatchevents/api_op_PutPartnerEvents.go b/service/cloudwatchevents/api_op_PutPartnerEvents.go index 29111b245c5..7087a6dcaa4 100644 --- a/service/cloudwatchevents/api_op_PutPartnerEvents.go +++ b/service/cloudwatchevents/api_op_PutPartnerEvents.go @@ -66,14 +66,14 @@ type PutPartnerEventsInput struct { type PutPartnerEventsOutput struct { - // The number of events from this operation that could not be written to the - // partner event bus. - FailedEntryCount *int32 - // The list of events from this operation that were successfully written to the // partner event bus. Entries []*types.PutPartnerEventsResultEntry + // The number of events from this operation that could not be written to the + // partner event bus. + FailedEntryCount *int32 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudwatchevents/api_op_PutPermission.go b/service/cloudwatchevents/api_op_PutPermission.go index 5f83d8dc4ca..4ef66c1d01d 100644 --- a/service/cloudwatchevents/api_op_PutPermission.go +++ b/service/cloudwatchevents/api_op_PutPermission.go @@ -81,10 +81,6 @@ type PutPermissionInput struct { // This member is required. Action *string - // The event bus associated with the rule. If you omit this, the default event bus - // is used. - EventBusName *string - // The 12-digit AWS account ID that you are permitting to put events to your // default event bus. Specify "*" to permit any account to put events to your // default event bus.

    If you specify "*" without specifying @@ -97,6 +93,13 @@ type PutPermissionInput struct { // This member is required. Principal *string + // An identifier string for the external account that you are granting permissions + // to. If you later want to revoke the permission for this external account, + // specify this StatementId when you run RemovePermission (). + // + // This member is required. + StatementId *string + // This parameter enables you to limit the permission to accounts that fulfill a // certain condition, such as being a member of a certain AWS organization. For // more information about AWS Organizations, see What Is AWS Organizations @@ -108,12 +111,9 @@ type PutPermissionInput struct { // Key, and Value fields.

    Condition *types.Condition - // An identifier string for the external account that you are granting permissions - // to. If you later want to revoke the permission for this external account, - // specify this StatementId when you run RemovePermission (). - // - // This member is required. - StatementId *string + // The event bus associated with the rule. If you omit this, the default event bus + // is used. + EventBusName *string } type PutPermissionOutput struct { diff --git a/service/cloudwatchevents/api_op_PutRule.go b/service/cloudwatchevents/api_op_PutRule.go index dbbc385d955..5af550bd887 100644 --- a/service/cloudwatchevents/api_op_PutRule.go +++ b/service/cloudwatchevents/api_op_PutRule.go @@ -99,35 +99,35 @@ func (c *Client) PutRule(ctx context.Context, params *PutRuleInput, optFns ...fu type PutRuleInput struct { - // The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 - // minutes)". - ScheduleExpression *string - - // Indicates whether the rule is enabled or disabled. - State types.RuleState + // The name of the rule that you are creating or updating. + // + // This member is required. + Name *string // A description of the rule. Description *string - // The event pattern. For more information, see Events and Event Patterns - // (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) - // in the Amazon EventBridge User Guide. - EventPattern *string - // The event bus to associate with this rule. If you omit this, the default event // bus is used. EventBusName *string - // The list of key-value pairs to associate with the rule. - Tags []*types.Tag + // The event pattern. For more information, see Events and Event Patterns + // (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + // in the Amazon EventBridge User Guide. + EventPattern *string // The Amazon Resource Name (ARN) of the IAM role associated with the rule. RoleArn *string - // The name of the rule that you are creating or updating. - // - // This member is required. - Name *string + // The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 + // minutes)". + ScheduleExpression *string + + // Indicates whether the rule is enabled or disabled. + State types.RuleState + + // The list of key-value pairs to associate with the rule. + Tags []*types.Tag } type PutRuleOutput struct { diff --git a/service/cloudwatchevents/api_op_PutTargets.go b/service/cloudwatchevents/api_op_PutTargets.go index 70a9283b5fd..402936aadce 100644 --- a/service/cloudwatchevents/api_op_PutTargets.go +++ b/service/cloudwatchevents/api_op_PutTargets.go @@ -128,10 +128,6 @@ func (c *Client) PutTargets(ctx context.Context, params *PutTargetsInput, optFns type PutTargetsInput struct { - // The name of the event bus associated with the rule. If you omit this, the - // default event bus is used. - EventBusName *string - // The name of the rule. // // This member is required. @@ -141,6 +137,10 @@ type PutTargetsInput struct { // // This member is required. Targets []*types.Target + + // The name of the event bus associated with the rule. If you omit this, the + // default event bus is used. + EventBusName *string } type PutTargetsOutput struct { diff --git a/service/cloudwatchevents/api_op_RemoveTargets.go b/service/cloudwatchevents/api_op_RemoveTargets.go index f72ea5742ff..273bdb5fe97 100644 --- a/service/cloudwatchevents/api_op_RemoveTargets.go +++ b/service/cloudwatchevents/api_op_RemoveTargets.go @@ -64,13 +64,6 @@ func (c *Client) RemoveTargets(ctx context.Context, params *RemoveTargetsInput, type RemoveTargetsInput struct { - // If this is a managed rule, created by an AWS service on your behalf, you must - // specify Force as True to remove targets. This parameter is ignored for rules - // that are not managed rules. You can check whether a rule is a managed rule by - // using DescribeRule or ListRules and checking the ManagedBy field of the - // response. - Force *bool - // The IDs of the targets to remove from the rule. // // This member is required. @@ -83,16 +76,23 @@ type RemoveTargetsInput struct { // The name of the event bus associated with the rule. EventBusName *string + + // If this is a managed rule, created by an AWS service on your behalf, you must + // specify Force as True to remove targets. This parameter is ignored for rules + // that are not managed rules. You can check whether a rule is a managed rule by + // using DescribeRule or ListRules and checking the ManagedBy field of the + // response. + Force *bool } type RemoveTargetsOutput struct { - // The number of failed entries. - FailedEntryCount *int32 - // The failed target entries. FailedEntries []*types.RemoveTargetsResultEntry + // The number of failed entries. + FailedEntryCount *int32 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudwatchevents/go.mod b/service/cloudwatchevents/go.mod index a987354112e..f1210ffc7ae 100644 --- a/service/cloudwatchevents/go.mod +++ b/service/cloudwatchevents/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/cloudwatchevents go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/cloudwatchevents/types/types.go b/service/cloudwatchevents/types/types.go index f0634f4a1e0..32174b76d33 100644 --- a/service/cloudwatchevents/types/types.go +++ b/service/cloudwatchevents/types/types.go @@ -11,6 +11,12 @@ import ( // ECS tasks that use the awsvpc network mode. type AwsVpcConfiguration struct { + // Specifies the subnets associated with the task. These subnets must all be in the + // same VPC. You can specify as many as 16 subnets. + // + // This member is required. + Subnets []*string + // Specifies whether the task's elastic network interface receives a public IP // address. You can specify ENABLED only when LaunchType in EcsParameters is set to // FARGATE. @@ -21,12 +27,6 @@ type AwsVpcConfiguration struct { // you do not specify a security group, the default security group for the VPC is // used. SecurityGroups []*string - - // Specifies the subnets associated with the task. These subnets must all be in the - // same VPC. You can specify as many as 16 subnets. - // - // This member is required. - Subnets []*string } // The array properties for the submitted job, such as the size of the array. The @@ -43,12 +43,6 @@ type BatchArrayProperties struct { // The custom parameters to be used when the target is an AWS Batch job. type BatchParameters struct { - // The array properties for the submitted job, such as the size of the array. The - // array size can be between 2 and 10,000. If you specify array properties for a - // job, it becomes an array job. This parameter is used only if the target is an - // AWS Batch job. - ArrayProperties *BatchArrayProperties - // The ARN or name of the job definition to use if the event target is an AWS Batch // job. This job definition must already exist. // @@ -61,6 +55,12 @@ type BatchParameters struct { // This member is required. JobName *string + // The array properties for the submitted job, such as the size of the array. The + // array size can be between 2 and 10,000. If you specify array properties for a + // job, it becomes an array job. This parameter is used only if the target is an + // AWS Batch job. + ArrayProperties *BatchArrayProperties + // The retry strategy to use for failed jobs, if the target is an AWS Batch job. // The retry strategy is the number of times to retry the failed job execution. // Valid values are 1–10. When you specify a retry strategy here, it overrides the @@ -86,6 +86,12 @@ type BatchRetryStrategy struct { // "StringEquals", "Key": "aws:PrincipalOrgID", "Value": "o-1234567890"}' type Condition struct { + // Specifies the key for the condition. Currently the only supported key is + // aws:PrincipalOrgID. + // + // This member is required. + Key *string + // Specifies the type of condition. Currently the only supported value is // StringEquals. // @@ -97,30 +103,27 @@ type Condition struct { // // This member is required. Value *string - - // Specifies the key for the condition. Currently the only supported key is - // aws:PrincipalOrgID. - // - // This member is required. - Key *string } // The custom parameters to be used when the target is an Amazon ECS task. type EcsParameters struct { + // The ARN of the task definition to use if the event target is an Amazon ECS task. + // + // This member is required. + TaskDefinitionArn *string + // Specifies an ECS task group for the task. The maximum length is 255 characters. Group *string - // The number of tasks to create based on TaskDefinition. The default is 1. - TaskCount *int32 - - // Specifies the platform version for the task. Specify only the numeric portion of - // the platform version, such as 1.1.0. This structure is used only if LaunchType - // is FARGATE. For more information about valid platform versions, see AWS Fargate - // Platform Versions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // Specifies the launch type on which your task is running. The launch type that + // you specify here must match one of the launch type (compatibilities) of the + // target task. The FARGATE value is supported only in the Regions where AWS + // Fargate with Amazon ECS is supported. For more information, see AWS Fargate on + // Amazon ECS + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html) // in the Amazon Elastic Container Service Developer Guide. - PlatformVersion *string + LaunchType LaunchType // Use this structure if the ECS task uses the awsvpc network mode. This structure // specifies the VPC subnets and security groups associated with the task, and @@ -130,19 +133,16 @@ type EcsParameters struct { // awsvpc network mode, the task fails. NetworkConfiguration *NetworkConfiguration - // The ARN of the task definition to use if the event target is an Amazon ECS task. - // - // This member is required. - TaskDefinitionArn *string - - // Specifies the launch type on which your task is running. The launch type that - // you specify here must match one of the launch type (compatibilities) of the - // target task. The FARGATE value is supported only in the Regions where AWS - // Fargate with Amazon ECS is supported. For more information, see AWS Fargate on - // Amazon ECS - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html) + // Specifies the platform version for the task. Specify only the numeric portion of + // the platform version, such as 1.1.0. This structure is used only if LaunchType + // is FARGATE. For more information about valid platform versions, see AWS Fargate + // Platform Versions + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) // in the Amazon Elastic Container Service Developer Guide. - LaunchType LaunchType + PlatformVersion *string + + // The number of tasks to create based on TaskDefinition. The default is 1. + TaskCount *int32 } // An event bus receives events from a source and routes them to rules associated @@ -169,15 +169,8 @@ type EventBus struct { // events from the partner's applications or services. type EventSource struct { - // The name of the event source. - Name *string - - // The state of the event source. If it is ACTIVE, you have already created a - // matching event bus for this event source, and that event bus is active. If it is - // PENDING, either you haven't yet created a matching event bus, or that event bus - // is deactivated. If it is DELETED, you have created a matching event bus, but the - // event source has since been deleted. - State EventSourceState + // The ARN of the event source. + Arn *string // The name of the partner that created the event source. CreatedBy *string @@ -189,8 +182,15 @@ type EventSource struct { // create a matching event bus for it. ExpirationTime *time.Time - // The ARN of the event source. - Arn *string + // The name of the event source. + Name *string + + // The state of the event source. If it is ACTIVE, you have already created a + // matching event bus for this event source, and that event bus is active. If it is + // PENDING, either you haven't yet created a matching event bus, or that event bus + // is deactivated. If it is DELETED, you have created a matching event bus, but the + // event source has since been deleted. + State EventSourceState } // These are custom parameter to be used when the target is an API Gateway REST @@ -273,16 +273,19 @@ type NetworkConfiguration struct { // events from the partner's applications or services. type PartnerEventSource struct { - // The name of the partner event source. - Name *string - // The ARN of the partner event source. Arn *string + + // The name of the partner event source. + Name *string } // The AWS account that a partner event source has been offered to. type PartnerEventSourceAccount struct { + // The AWS account ID that the partner event source was offered to. + Account *string + // The date and time the event source was created. CreationTime *time.Time @@ -290,9 +293,6 @@ type PartnerEventSourceAccount struct { // create a matching event bus for it. ExpirationTime *time.Time - // The AWS account ID that the partner event source was offered to. - Account *string - // The state of the event source. If it is ACTIVE, you have already created a // matching event bus for this event source, and that event bus is active. If it is // PENDING, either you haven't yet created a matching event bus, or that event bus @@ -304,28 +304,28 @@ type PartnerEventSourceAccount struct { // Represents an event to be submitted. type PutEventsRequestEntry struct { - // The source of the event. - Source *string - - // The time stamp of the event, per RFC3339 - // (https://www.rfc-editor.org/rfc/rfc3339.txt). If no time stamp is provided, the - // time stamp of the PutEvents () call is used. - Time *time.Time - - // AWS resources, identified by Amazon Resource Name (ARN), which the event - // primarily concerns. Any number, including zero, may be present. - Resources []*string - - // Free-form string used to decide what fields to expect in the event detail. - DetailType *string - // A valid JSON string. There is no other schema imposed. The JSON string may // contain fields and nested subobjects. Detail *string + // Free-form string used to decide what fields to expect in the event detail. + DetailType *string + // The event bus that will receive the event. Only the rules that are associated // with this event bus will be able to match the event. EventBusName *string + + // AWS resources, identified by Amazon Resource Name (ARN), which the event + // primarily concerns. Any number, including zero, may be present. + Resources []*string + + // The source of the event. + Source *string + + // The time stamp of the event, per RFC3339 + // (https://www.rfc-editor.org/rfc/rfc3339.txt). If no time stamp is provided, the + // time stamp of the PutEvents () call is used. + Time *time.Time } // Represents an event that failed to be submitted. @@ -334,11 +334,11 @@ type PutEventsResultEntry struct { // The error code that indicates why the event submission failed. ErrorCode *string - // The ID of the event. - EventId *string - // The error message that explains why the event submission failed. ErrorMessage *string + + // The ID of the event. + EventId *string } // The details about an event generated by an SaaS partner. @@ -351,40 +351,40 @@ type PutPartnerEventsRequestEntry struct { // A free-form string used to decide what fields to expect in the event detail. DetailType *string + // AWS resources, identified by Amazon Resource Name (ARN), which the event + // primarily concerns. Any number, including zero, may be present. + Resources []*string + // The event source that is generating the evntry. Source *string // The date and time of the event. Time *time.Time - - // AWS resources, identified by Amazon Resource Name (ARN), which the event - // primarily concerns. Any number, including zero, may be present. - Resources []*string } // Represents an event that a partner tried to generate, but failed. type PutPartnerEventsResultEntry struct { + // The error code that indicates why the event submission failed. + ErrorCode *string + // The error message that explains why the event submission failed. ErrorMessage *string // The ID of the event. EventId *string - - // The error code that indicates why the event submission failed. - ErrorCode *string } // Represents a target that failed to be added to a rule. type PutTargetsResultEntry struct { - // The error message that explains why the target addition failed. - ErrorMessage *string - // The error code that indicates why the target addition failed. If the value is // ConcurrentModificationException, too many requests were made at the same time. ErrorCode *string + // The error message that explains why the target addition failed. + ErrorMessage *string + // The ID of the target. TargetId *string } @@ -396,46 +396,46 @@ type RemoveTargetsResultEntry struct { // ConcurrentModificationException, too many requests were made at the same time. ErrorCode *string - // The ID of the target. - TargetId *string - // The error message that explains why the target removal failed. ErrorMessage *string + + // The ID of the target. + TargetId *string } // Contains information about a rule in Amazon EventBridge. type Rule struct { - // The state of the rule. - State RuleState - - // The Amazon Resource Name (ARN) of the role that is used for target invocation. - RoleArn *string - // The Amazon Resource Name (ARN) of the rule. Arn *string + // The description of the rule. + Description *string + + // The event bus associated with the rule. + EventBusName *string + // The event pattern of the rule. For more information, see Events and Event // Patterns // (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) // in the Amazon EventBridge User Guide. EventPattern *string - // The event bus associated with the rule. - EventBusName *string - // If the rule was created on behalf of your account by an AWS service, this field // displays the principal name of the service that created the rule. ManagedBy *string - // The description of the rule. - Description *string + // The name of the rule. + Name *string + + // The Amazon Resource Name (ARN) of the role that is used for target invocation. + RoleArn *string // The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". ScheduleExpression *string - // The name of the rule. - Name *string + // The state of the rule. + State RuleState } // This parameter contains the criteria (either InstanceIds or a tag) used to @@ -454,16 +454,16 @@ type RunCommandParameters struct { // this key may specify multiple values. type RunCommandTarget struct { - // If Key is tag: tag-key, Values is a list of tag values. If Key is InstanceIds, - // Values is a list of Amazon EC2 instance IDs. + // Can be either tag: tag-key or InstanceIds. // // This member is required. - Values []*string + Key *string - // Can be either tag: tag-key or InstanceIds. + // If Key is tag: tag-key, Values is a list of tag values. If Key is InstanceIds, + // Values is a list of Amazon EC2 instance IDs. // // This member is required. - Key *string + Values []*string } // This structure includes the custom parameter to be used when the target is an @@ -478,16 +478,16 @@ type SqsParameters struct { // event buses support tagging. type Tag struct { - // The value for the specified tag key. - // - // This member is required. - Value *string - // A string you can use to assign a value. The combination of tag keys and values // can help you organize and categorize your resources. // // This member is required. Key *string + + // The value for the specified tag key. + // + // This member is required. + Value *string } // Targets are the resources to be invoked when a rule is triggered. For a complete @@ -502,6 +502,35 @@ type Tag struct { // Guide.

    type Target struct { + // The Amazon Resource Name (ARN) of the target. + // + // This member is required. + Arn *string + + // The ID of the target. + // + // This member is required. + Id *string + + // If the event target is an AWS Batch job, this contains the job definition, job + // name, and other parameters. For more information, see Jobs + // (https://docs.aws.amazon.com/batch/latest/userguide/jobs.html) in the AWS Batch + // User Guide. + BatchParameters *BatchParameters + + // Contains the Amazon ECS task definition and task count to be used, if the event + // target is an Amazon ECS task. For more information about Amazon ECS tasks, see + // Task Definitions + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) + // in the Amazon EC2 Container Service Developer Guide. + EcsParameters *EcsParameters + + // Contains the HTTP parameters to use when the target is a API Gateway REST + // endpoint. If you specify an API Gateway REST API as a target, you can use this + // parameter to specify headers, path parameter, query string keys/values as part + // of your target invoking request. + HttpParameters *HttpParameters + // Valid JSON text passed to the target. In this case, nothing from the event // itself is passed to the target. For more information, see The JavaScript Object // Notation (JSON) Data Interchange Format @@ -514,11 +543,10 @@ type Target struct { // (http://goessner.net/articles/JsonPath/). InputPath *string - // If the event target is an AWS Batch job, this contains the job definition, job - // name, and other parameters. For more information, see Jobs - // (https://docs.aws.amazon.com/batch/latest/userguide/jobs.html) in the AWS Batch - // User Guide. - BatchParameters *BatchParameters + // Settings to enable you to provide custom input to a target based on certain + // event data. You can extract one or more key-value pairs from the event and then + // use that data to send customized input to the target. + InputTransformer *InputTransformer // The custom parameter you can use to control the shard assignment, when the // target is a Kinesis data stream. If you do not include this parameter, the @@ -530,39 +558,11 @@ type Target struct { // different IAM role for each target. RoleArn *string - // The ID of the target. - // - // This member is required. - Id *string - - // Settings to enable you to provide custom input to a target based on certain - // event data. You can extract one or more key-value pairs from the event and then - // use that data to send customized input to the target. - InputTransformer *InputTransformer - - // The Amazon Resource Name (ARN) of the target. - // - // This member is required. - Arn *string - // Parameters used when you are using the rule to invoke Amazon EC2 Run Command. RunCommandParameters *RunCommandParameters - // Contains the HTTP parameters to use when the target is a API Gateway REST - // endpoint. If you specify an API Gateway REST API as a target, you can use this - // parameter to specify headers, path parameter, query string keys/values as part - // of your target invoking request. - HttpParameters *HttpParameters - // Contains the message group ID to use when the target is a FIFO queue. If you // specify an SQS FIFO queue as a target, the queue must have content-based // deduplication enabled. SqsParameters *SqsParameters - - // Contains the Amazon ECS task definition and task count to be used, if the event - // target is an Amazon ECS task. For more information about Amazon ECS tasks, see - // Task Definitions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) - // in the Amazon EC2 Container Service Developer Guide. - EcsParameters *EcsParameters } diff --git a/service/cloudwatchlogs/api_op_CreateExportTask.go b/service/cloudwatchlogs/api_op_CreateExportTask.go index ab53f73e568..92df6b58f3a 100644 --- a/service/cloudwatchlogs/api_op_CreateExportTask.go +++ b/service/cloudwatchlogs/api_op_CreateExportTask.go @@ -70,6 +70,12 @@ func (c *Client) CreateExportTask(ctx context.Context, params *CreateExportTaskI type CreateExportTaskInput struct { + // The name of S3 bucket for the exported log data. The bucket must be in the same + // AWS region. + // + // This member is required. + Destination *string + // The start time of the range for the request, expressed as the number of // milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp earlier // than this time are not exported. @@ -77,11 +83,17 @@ type CreateExportTaskInput struct { // This member is required. From *int64 - // The name of S3 bucket for the exported log data. The bucket must be in the same - // AWS region. + // The name of the log group. // // This member is required. - Destination *string + LogGroupName *string + + // The end time of the range for the request, expressed as the number of + // milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than + // this time are not exported. + // + // This member is required. + To *int64 // The prefix used as the start of the key for every object exported. If you don't // specify a value, the default is exportedlogs. @@ -93,18 +105,6 @@ type CreateExportTaskInput struct { // The name of the export task. TaskName *string - - // The name of the log group. - // - // This member is required. - LogGroupName *string - - // The end time of the range for the request, expressed as the number of - // milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than - // this time are not exported. - // - // This member is required. - To *int64 } type CreateExportTaskOutput struct { diff --git a/service/cloudwatchlogs/api_op_DeleteSubscriptionFilter.go b/service/cloudwatchlogs/api_op_DeleteSubscriptionFilter.go index a1fc12d03cd..169a0d53d0d 100644 --- a/service/cloudwatchlogs/api_op_DeleteSubscriptionFilter.go +++ b/service/cloudwatchlogs/api_op_DeleteSubscriptionFilter.go @@ -56,15 +56,15 @@ func (c *Client) DeleteSubscriptionFilter(ctx context.Context, params *DeleteSub type DeleteSubscriptionFilterInput struct { - // The name of the log group. + // The name of the subscription filter. // // This member is required. - LogGroupName *string + FilterName *string - // The name of the subscription filter. + // The name of the log group. // // This member is required. - FilterName *string + LogGroupName *string } type DeleteSubscriptionFilterOutput struct { diff --git a/service/cloudwatchlogs/api_op_DescribeDestinations.go b/service/cloudwatchlogs/api_op_DescribeDestinations.go index 4f17525de02..2f782773230 100644 --- a/service/cloudwatchlogs/api_op_DescribeDestinations.go +++ b/service/cloudwatchlogs/api_op_DescribeDestinations.go @@ -56,16 +56,16 @@ func (c *Client) DescribeDestinations(ctx context.Context, params *DescribeDesti type DescribeDestinationsInput struct { - // The token for the next set of items to return. (You received this token from a - // previous call.) - NextToken *string + // The prefix to match. If you don't specify a value, no prefix filter is applied. + DestinationNamePrefix *string // The maximum number of items returned. If you don't specify a value, the default // is up to 50 items. Limit *int32 - // The prefix to match. If you don't specify a value, no prefix filter is applied. - DestinationNamePrefix *string + // The token for the next set of items to return. (You received this token from a + // previous call.) + NextToken *string } type DescribeDestinationsOutput struct { diff --git a/service/cloudwatchlogs/api_op_DescribeExportTasks.go b/service/cloudwatchlogs/api_op_DescribeExportTasks.go index 9df5dce32d3..33bdae98ef3 100644 --- a/service/cloudwatchlogs/api_op_DescribeExportTasks.go +++ b/service/cloudwatchlogs/api_op_DescribeExportTasks.go @@ -57,31 +57,31 @@ func (c *Client) DescribeExportTasks(ctx context.Context, params *DescribeExport type DescribeExportTasksInput struct { - // The token for the next set of items to return. (You received this token from a - // previous call.) - NextToken *string - // The maximum number of items returned. If you don't specify a value, the default // is up to 50 items. Limit *int32 - // The ID of the export task. Specifying a task ID filters the results to zero or - // one export tasks. - TaskId *string + // The token for the next set of items to return. (You received this token from a + // previous call.) + NextToken *string // The status code of the export task. Specifying a status code filters the results // to zero or more export tasks. StatusCode types.ExportTaskStatusCode + + // The ID of the export task. Specifying a task ID filters the results to zero or + // one export tasks. + TaskId *string } type DescribeExportTasksOutput struct { - // The token for the next set of items to return. The token expires after 24 hours. - NextToken *string - // The export tasks. ExportTasks []*types.ExportTask + // The token for the next set of items to return. The token expires after 24 hours. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudwatchlogs/api_op_DescribeLogGroups.go b/service/cloudwatchlogs/api_op_DescribeLogGroups.go index dd200ab6bf1..54e5893cc48 100644 --- a/service/cloudwatchlogs/api_op_DescribeLogGroups.go +++ b/service/cloudwatchlogs/api_op_DescribeLogGroups.go @@ -57,16 +57,16 @@ func (c *Client) DescribeLogGroups(ctx context.Context, params *DescribeLogGroup type DescribeLogGroupsInput struct { - // The token for the next set of items to return. (You received this token from a - // previous call.) - NextToken *string + // The maximum number of items returned. If you don't specify a value, the default + // is up to 50 items. + Limit *int32 // The prefix to match. LogGroupNamePrefix *string - // The maximum number of items returned. If you don't specify a value, the default - // is up to 50 items. - Limit *int32 + // The token for the next set of items to return. (You received this token from a + // previous call.) + NextToken *string } type DescribeLogGroupsOutput struct { diff --git a/service/cloudwatchlogs/api_op_DescribeLogStreams.go b/service/cloudwatchlogs/api_op_DescribeLogStreams.go index 8580204c820..46bc8efc6dd 100644 --- a/service/cloudwatchlogs/api_op_DescribeLogStreams.go +++ b/service/cloudwatchlogs/api_op_DescribeLogStreams.go @@ -60,37 +60,37 @@ func (c *Client) DescribeLogStreams(ctx context.Context, params *DescribeLogStre type DescribeLogStreamsInput struct { - // If the value is LogStreamName, the results are ordered by log stream name. If - // the value is LastEventTime, the results are ordered by the event time. The - // default value is LogStreamName. If you order the results by event time, you - // cannot specify the logStreamNamePrefix parameter. lastEventTimestamp represents - // the time of the most recent log event in the log stream in CloudWatch Logs. This - // number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 - // UTC. lastEventTimeStamp updates on an eventual consistency basis. It typically - // updates in less than an hour from ingestion, but may take longer in some rare - // situations. - OrderBy types.OrderBy + // The name of the log group. + // + // This member is required. + LogGroupName *string + + // If the value is true, results are returned in descending order. If the value is + // to false, results are returned in ascending order. The default value is false. + Descending *bool // The maximum number of items returned. If you don't specify a value, the default // is up to 50 items. Limit *int32 - // The token for the next set of items to return. (You received this token from a - // previous call.) - NextToken *string - // The prefix to match. If orderBy is LastEventTime,you cannot specify this // parameter. LogStreamNamePrefix *string - // If the value is true, results are returned in descending order. If the value is - // to false, results are returned in ascending order. The default value is false. - Descending *bool + // The token for the next set of items to return. (You received this token from a + // previous call.) + NextToken *string - // The name of the log group. - // - // This member is required. - LogGroupName *string + // If the value is LogStreamName, the results are ordered by log stream name. If + // the value is LastEventTime, the results are ordered by the event time. The + // default value is LogStreamName. If you order the results by event time, you + // cannot specify the logStreamNamePrefix parameter. lastEventTimestamp represents + // the time of the most recent log event in the log stream in CloudWatch Logs. This + // number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 + // UTC. lastEventTimeStamp updates on an eventual consistency basis. It typically + // updates in less than an hour from ingestion, but may take longer in some rare + // situations. + OrderBy types.OrderBy } type DescribeLogStreamsOutput struct { diff --git a/service/cloudwatchlogs/api_op_DescribeMetricFilters.go b/service/cloudwatchlogs/api_op_DescribeMetricFilters.go index fee659c833f..df002c3ac7c 100644 --- a/service/cloudwatchlogs/api_op_DescribeMetricFilters.go +++ b/service/cloudwatchlogs/api_op_DescribeMetricFilters.go @@ -58,9 +58,12 @@ func (c *Client) DescribeMetricFilters(ctx context.Context, params *DescribeMetr type DescribeMetricFiltersInput struct { - // The token for the next set of items to return. (You received this token from a - // previous call.) - NextToken *string + // The prefix to match. + FilterNamePrefix *string + + // The maximum number of items returned. If you don't specify a value, the default + // is up to 50 items. + Limit *int32 // The name of the log group. LogGroupName *string @@ -70,16 +73,13 @@ type DescribeMetricFiltersInput struct { // metricNamespace parameter. MetricName *string - // The prefix to match. - FilterNamePrefix *string - - // The maximum number of items returned. If you don't specify a value, the default - // is up to 50 items. - Limit *int32 - // Filters results to include only those in the specified namespace. If you include // this parameter in your request, you must also include the metricName parameter. MetricNamespace *string + + // The token for the next set of items to return. (You received this token from a + // previous call.) + NextToken *string } type DescribeMetricFiltersOutput struct { diff --git a/service/cloudwatchlogs/api_op_DescribeQueries.go b/service/cloudwatchlogs/api_op_DescribeQueries.go index 0b8d1234e6a..95d10bfa582 100644 --- a/service/cloudwatchlogs/api_op_DescribeQueries.go +++ b/service/cloudwatchlogs/api_op_DescribeQueries.go @@ -59,10 +59,6 @@ func (c *Client) DescribeQueries(ctx context.Context, params *DescribeQueriesInp type DescribeQueriesInput struct { - // Limits the returned queries to only those that have the specified status. Valid - // values are Cancelled, Complete, Failed, Running, and Scheduled. - Status types.QueryStatus - // Limits the returned queries to only those for the specified log group. LogGroupName *string @@ -71,16 +67,20 @@ type DescribeQueriesInput struct { // The token for the next set of items to return. The token expires after 24 hours. NextToken *string + + // Limits the returned queries to only those that have the specified status. Valid + // values are Cancelled, Complete, Failed, Running, and Scheduled. + Status types.QueryStatus } type DescribeQueriesOutput struct { - // The list of queries that match the request. - Queries []*types.QueryInfo - // The token for the next set of items to return. The token expires after 24 hours. NextToken *string + // The list of queries that match the request. + Queries []*types.QueryInfo + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudwatchlogs/api_op_DescribeQueryDefinitions.go b/service/cloudwatchlogs/api_op_DescribeQueryDefinitions.go index b490c203c77..1c016f5828c 100644 --- a/service/cloudwatchlogs/api_op_DescribeQueryDefinitions.go +++ b/service/cloudwatchlogs/api_op_DescribeQueryDefinitions.go @@ -54,12 +54,12 @@ func (c *Client) DescribeQueryDefinitions(ctx context.Context, params *DescribeQ } type DescribeQueryDefinitionsInput struct { - QueryDefinitionNamePrefix *string - MaxResults *int32 // The token for the next set of items to return. The token expires after 24 hours. NextToken *string + + QueryDefinitionNamePrefix *string } type DescribeQueryDefinitionsOutput struct { diff --git a/service/cloudwatchlogs/api_op_DescribeResourcePolicies.go b/service/cloudwatchlogs/api_op_DescribeResourcePolicies.go index 8c22d3c9f0f..6deebdb78ad 100644 --- a/service/cloudwatchlogs/api_op_DescribeResourcePolicies.go +++ b/service/cloudwatchlogs/api_op_DescribeResourcePolicies.go @@ -56,12 +56,12 @@ func (c *Client) DescribeResourcePolicies(ctx context.Context, params *DescribeR type DescribeResourcePoliciesInput struct { - // The token for the next set of items to return. The token expires after 24 hours. - NextToken *string - // The maximum number of resource policies to be displayed with one call of this // API. Limit *int32 + + // The token for the next set of items to return. The token expires after 24 hours. + NextToken *string } type DescribeResourcePoliciesOutput struct { diff --git a/service/cloudwatchlogs/api_op_DescribeSubscriptionFilters.go b/service/cloudwatchlogs/api_op_DescribeSubscriptionFilters.go index 3db9ee6556c..2f675d8a2bf 100644 --- a/service/cloudwatchlogs/api_op_DescribeSubscriptionFilters.go +++ b/service/cloudwatchlogs/api_op_DescribeSubscriptionFilters.go @@ -59,14 +59,6 @@ func (c *Client) DescribeSubscriptionFilters(ctx context.Context, params *Descri type DescribeSubscriptionFiltersInput struct { - // The token for the next set of items to return. (You received this token from a - // previous call.) - NextToken *string - - // The maximum number of items returned. If you don't specify a value, the default - // is up to 50 items. - Limit *int32 - // The name of the log group. // // This member is required. @@ -74,6 +66,14 @@ type DescribeSubscriptionFiltersInput struct { // The prefix to match. If you don't specify a value, no prefix filter is applied. FilterNamePrefix *string + + // The maximum number of items returned. If you don't specify a value, the default + // is up to 50 items. + Limit *int32 + + // The token for the next set of items to return. (You received this token from a + // previous call.) + NextToken *string } type DescribeSubscriptionFiltersOutput struct { diff --git a/service/cloudwatchlogs/api_op_FilterLogEvents.go b/service/cloudwatchlogs/api_op_FilterLogEvents.go index 9d750dda13d..29fa1757fae 100644 --- a/service/cloudwatchlogs/api_op_FilterLogEvents.go +++ b/service/cloudwatchlogs/api_op_FilterLogEvents.go @@ -63,26 +63,20 @@ func (c *Client) FilterLogEvents(ctx context.Context, params *FilterLogEventsInp type FilterLogEventsInput struct { - // The start of the time range, expressed as the number of milliseconds after Jan - // 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not returned. - StartTime *int64 - - // The token for the next set of events to return. (You received this token from a - // previous call.) - NextToken *string - - // The maximum number of events to return. The default is 10,000 events. - Limit *int32 + // The name of the log group to search. + // + // This member is required. + LogGroupName *string // The end of the time range, expressed as the number of milliseconds after Jan 1, // 1970 00:00:00 UTC. Events with a timestamp later than this time are not // returned. EndTime *int64 - // The name of the log group to search. - // - // This member is required. - LogGroupName *string + // The filter pattern to use. For more information, see Filter and Pattern Syntax + // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html). + // If not provided, all the events are matched. + FilterPattern *string // If the value is true, the operation makes a best effort to provide responses // that contain events from multiple log streams within the log group, interleaved @@ -94,10 +88,8 @@ type FilterLogEventsInput struct { // group. Interleaved *bool - // The filter pattern to use. For more information, see Filter and Pattern Syntax - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html). - // If not provided, all the events are matched. - FilterPattern *string + // The maximum number of events to return. The default is 10,000 events. + Limit *int32 // Filters the results to include only events from log streams that have names // starting with this prefix. If you specify a value for both logStreamNamePrefix @@ -110,17 +102,25 @@ type FilterLogEventsInput struct { // specify a value for both logStreamNamePrefix and logStreamNames, the action // returns an InvalidParameterException error. LogStreamNames []*string + + // The token for the next set of events to return. (You received this token from a + // previous call.) + NextToken *string + + // The start of the time range, expressed as the number of milliseconds after Jan + // 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not returned. + StartTime *int64 } type FilterLogEventsOutput struct { + // The matched events. + Events []*types.FilteredLogEvent + // The token to use when requesting the next set of items. The token expires after // 24 hours. NextToken *string - // The matched events. - Events []*types.FilteredLogEvent - // Indicates which log streams have been searched and whether each has been // searched completely. SearchedLogStreams []*types.SearchedLogStream diff --git a/service/cloudwatchlogs/api_op_GetLogEvents.go b/service/cloudwatchlogs/api_op_GetLogEvents.go index 22259131ec4..2487f2900da 100644 --- a/service/cloudwatchlogs/api_op_GetLogEvents.go +++ b/service/cloudwatchlogs/api_op_GetLogEvents.go @@ -61,36 +61,36 @@ func (c *Client) GetLogEvents(ctx context.Context, params *GetLogEventsInput, op type GetLogEventsInput struct { - // If the value is true, the earliest log events are returned first. If the value - // is false, the latest log events are returned first. The default value is false. - // If you are using nextToken in this operation, you must specify true for - // startFromHead. - StartFromHead *bool - - // The end of the time range, expressed as the number of milliseconds after Jan 1, - // 1970 00:00:00 UTC. Events with a timestamp equal to or later than this time are - // not included. - EndTime *int64 + // The name of the log group. + // + // This member is required. + LogGroupName *string // The name of the log stream. // // This member is required. LogStreamName *string - // The name of the log group. - // - // This member is required. - LogGroupName *string + // The end of the time range, expressed as the number of milliseconds after Jan 1, + // 1970 00:00:00 UTC. Events with a timestamp equal to or later than this time are + // not included. + EndTime *int64 + + // The maximum number of log events returned. If you don't specify a value, the + // maximum is as many log events as can fit in a response size of 1 MB, up to + // 10,000 log events. + Limit *int32 // The token for the next set of items to return. (You received this token from a // previous call.) Using this token works only when you specify true for // startFromHead. NextToken *string - // The maximum number of log events returned. If you don't specify a value, the - // maximum is as many log events as can fit in a response size of 1 MB, up to - // 10,000 log events. - Limit *int32 + // If the value is true, the earliest log events are returned first. If the value + // is false, the latest log events are returned first. The default value is false. + // If you are using nextToken in this operation, you must specify true for + // startFromHead. + StartFromHead *bool // The start of the time range, expressed as the number of milliseconds after Jan // 1, 1970 00:00:00 UTC. Events with a timestamp equal to this time or later than @@ -101,14 +101,14 @@ type GetLogEventsInput struct { type GetLogEventsOutput struct { + // The events. + Events []*types.OutputLogEvent + // The token for the next set of items in the backward direction. The token expires // after 24 hours. This token will never be null. If you have reached the end of // the stream, it will return the same token you passed in. NextBackwardToken *string - // The events. - Events []*types.OutputLogEvent - // The token for the next set of items in the forward direction. The token expires // after 24 hours. If you have reached the end of the stream, it will return the // same token you passed in. diff --git a/service/cloudwatchlogs/api_op_GetLogGroupFields.go b/service/cloudwatchlogs/api_op_GetLogGroupFields.go index 9dee58bb811..219b819c2b6 100644 --- a/service/cloudwatchlogs/api_op_GetLogGroupFields.go +++ b/service/cloudwatchlogs/api_op_GetLogGroupFields.go @@ -65,16 +65,16 @@ func (c *Client) GetLogGroupFields(ctx context.Context, params *GetLogGroupField type GetLogGroupFieldsInput struct { + // The name of the log group to search. + // + // This member is required. + LogGroupName *string + // The time to set as the center of the query. If you specify time, the 8 minutes // before and 8 minutes after this time are searched. If you omit time, the past 15 // minutes are queried. The time value is specified as epoch time, the number of // seconds since January 1, 1970, 00:00:00 UTC. Time *int64 - - // The name of the log group to search. - // - // This member is required. - LogGroupName *string } type GetLogGroupFieldsOutput struct { diff --git a/service/cloudwatchlogs/api_op_GetQueryResults.go b/service/cloudwatchlogs/api_op_GetQueryResults.go index 783ab61c93d..93cdbc497ed 100644 --- a/service/cloudwatchlogs/api_op_GetQueryResults.go +++ b/service/cloudwatchlogs/api_op_GetQueryResults.go @@ -80,6 +80,11 @@ type GetQueryResultsOutput struct { // pairs. Results [][]*types.ResultField + // Includes the number of log events scanned by the query, the number of log events + // that matched the query criteria, and the total number of bytes in the log events + // that were scanned. + Statistics *types.QueryStatistics + // The status of the most recent running of the query. Possible values are // Cancelled, Complete, Failed, Running, Scheduled, Timeout, and Unknown. Queries // time out after 15 minutes of execution. To avoid having your queries time out, @@ -87,11 +92,6 @@ type GetQueryResultsOutput struct { // queries. Status types.QueryStatus - // Includes the number of log events scanned by the query, the number of log events - // that matched the query criteria, and the total number of bytes in the log events - // that were scanned. - Statistics *types.QueryStatistics - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudwatchlogs/api_op_PutDestination.go b/service/cloudwatchlogs/api_op_PutDestination.go index 859921bcd65..c5904a1e84e 100644 --- a/service/cloudwatchlogs/api_op_PutDestination.go +++ b/service/cloudwatchlogs/api_op_PutDestination.go @@ -70,11 +70,6 @@ func (c *Client) PutDestination(ctx context.Context, params *PutDestinationInput type PutDestinationInput struct { - // The ARN of an Amazon Kinesis stream to which to deliver matching log events. - // - // This member is required. - TargetArn *string - // A name for the destination. // // This member is required. @@ -85,6 +80,11 @@ type PutDestinationInput struct { // // This member is required. RoleArn *string + + // The ARN of an Amazon Kinesis stream to which to deliver matching log events. + // + // This member is required. + TargetArn *string } type PutDestinationOutput struct { diff --git a/service/cloudwatchlogs/api_op_PutDestinationPolicy.go b/service/cloudwatchlogs/api_op_PutDestinationPolicy.go index be029154b66..298e26ff6d1 100644 --- a/service/cloudwatchlogs/api_op_PutDestinationPolicy.go +++ b/service/cloudwatchlogs/api_op_PutDestinationPolicy.go @@ -60,16 +60,16 @@ func (c *Client) PutDestinationPolicy(ctx context.Context, params *PutDestinatio type PutDestinationPolicyInput struct { - // A name for an existing destination. - // - // This member is required. - DestinationName *string - // An IAM policy document that authorizes cross-account users to deliver their log // events to the associated destination. // // This member is required. AccessPolicy *string + + // A name for an existing destination. + // + // This member is required. + DestinationName *string } type PutDestinationPolicyOutput struct { diff --git a/service/cloudwatchlogs/api_op_PutLogEvents.go b/service/cloudwatchlogs/api_op_PutLogEvents.go index 387381357c6..e4438ccb7d2 100644 --- a/service/cloudwatchlogs/api_op_PutLogEvents.go +++ b/service/cloudwatchlogs/api_op_PutLogEvents.go @@ -95,11 +95,6 @@ func (c *Client) PutLogEvents(ctx context.Context, params *PutLogEventsInput, op type PutLogEventsInput struct { - // The name of the log stream. - // - // This member is required. - LogStreamName *string - // The log events. // // This member is required. @@ -110,6 +105,11 @@ type PutLogEventsInput struct { // This member is required. LogGroupName *string + // The name of the log stream. + // + // This member is required. + LogStreamName *string + // The sequence token obtained from the response of the previous PutLogEvents call. // An upload in a newly created log stream does not require a sequence token. You // can also get the sequence token using DescribeLogStreams @@ -121,12 +121,12 @@ type PutLogEventsInput struct { type PutLogEventsOutput struct { - // The rejected events. - RejectedLogEventsInfo *types.RejectedLogEventsInfo - // The next sequence token. NextSequenceToken *string + // The rejected events. + RejectedLogEventsInfo *types.RejectedLogEventsInfo + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cloudwatchlogs/api_op_PutMetricFilter.go b/service/cloudwatchlogs/api_op_PutMetricFilter.go index 61db1aee019..b36e9c8dd03 100644 --- a/service/cloudwatchlogs/api_op_PutMetricFilter.go +++ b/service/cloudwatchlogs/api_op_PutMetricFilter.go @@ -62,6 +62,11 @@ func (c *Client) PutMetricFilter(ctx context.Context, params *PutMetricFilterInp type PutMetricFilterInput struct { + // A name for the metric filter. + // + // This member is required. + FilterName *string + // A filter pattern for extracting metric data out of ingested log events. // // This member is required. @@ -72,11 +77,6 @@ type PutMetricFilterInput struct { // This member is required. LogGroupName *string - // A name for the metric filter. - // - // This member is required. - FilterName *string - // A collection of information that defines how metric data gets emitted. // // This member is required. diff --git a/service/cloudwatchlogs/api_op_PutQueryDefinition.go b/service/cloudwatchlogs/api_op_PutQueryDefinition.go index 956093b876f..c262088b6e6 100644 --- a/service/cloudwatchlogs/api_op_PutQueryDefinition.go +++ b/service/cloudwatchlogs/api_op_PutQueryDefinition.go @@ -54,13 +54,13 @@ func (c *Client) PutQueryDefinition(ctx context.Context, params *PutQueryDefinit } type PutQueryDefinitionInput struct { - LogGroupNames []*string - - QueryDefinitionId *string - Name *string QueryString *string + + LogGroupNames []*string + + QueryDefinitionId *string } type PutQueryDefinitionOutput struct { diff --git a/service/cloudwatchlogs/api_op_PutSubscriptionFilter.go b/service/cloudwatchlogs/api_op_PutSubscriptionFilter.go index 02ff0713b00..58ebd72eaeb 100644 --- a/service/cloudwatchlogs/api_op_PutSubscriptionFilter.go +++ b/service/cloudwatchlogs/api_op_PutSubscriptionFilter.go @@ -81,16 +81,6 @@ func (c *Client) PutSubscriptionFilter(ctx context.Context, params *PutSubscript type PutSubscriptionFilterInput struct { - // The name of the log group. - // - // This member is required. - LogGroupName *string - - // The ARN of an IAM role that grants CloudWatch Logs permissions to deliver - // ingested log events to the destination stream. You don't need to provide the ARN - // when you are working with a logical destination for cross-account delivery. - RoleArn *string - // The ARN of the destination to deliver matching log events to. Currently, the // supported destinations are: // @@ -120,16 +110,26 @@ type PutSubscriptionFilterInput struct { // This member is required. FilterName *string + // A filter pattern for subscribing to a filtered stream of log events. + // + // This member is required. + FilterPattern *string + + // The name of the log group. + // + // This member is required. + LogGroupName *string + // The method used to distribute log data to the destination. By default log data // is grouped by log stream, but the grouping can be set to random for a more even // distribution. This property is only applicable when the destination is an Amazon // Kinesis stream. Distribution types.Distribution - // A filter pattern for subscribing to a filtered stream of log events. - // - // This member is required. - FilterPattern *string + // The ARN of an IAM role that grants CloudWatch Logs permissions to deliver + // ingested log events to the destination stream. You don't need to provide the ARN + // when you are working with a logical destination for cross-account delivery. + RoleArn *string } type PutSubscriptionFilterOutput struct { diff --git a/service/cloudwatchlogs/api_op_StartQuery.go b/service/cloudwatchlogs/api_op_StartQuery.go index 3af8d2de46e..955aa785e2d 100644 --- a/service/cloudwatchlogs/api_op_StartQuery.go +++ b/service/cloudwatchlogs/api_op_StartQuery.go @@ -62,9 +62,12 @@ func (c *Client) StartQuery(ctx context.Context, params *StartQueryInput, optFns type StartQueryInput struct { - // The log group on which to perform the query. A StartQuery operation must include - // a logGroupNames or a logGroupName parameter, but not both. - LogGroupName *string + // The end of the time range to query. The range is inclusive, so the specified end + // time is included in the query. Specified as epoch time, the number of seconds + // since January 1, 1970, 00:00:00 UTC. + // + // This member is required. + EndTime *int64 // The query string to use. For more information, see CloudWatch Logs Insights // Query Syntax @@ -73,13 +76,6 @@ type StartQueryInput struct { // This member is required. QueryString *string - // The end of the time range to query. The range is inclusive, so the specified end - // time is included in the query. Specified as epoch time, the number of seconds - // since January 1, 1970, 00:00:00 UTC. - // - // This member is required. - EndTime *int64 - // The beginning of the time range to query. The range is inclusive, so the // specified start time is included in the query. Specified as epoch time, the // number of seconds since January 1, 1970, 00:00:00 UTC. @@ -92,6 +88,10 @@ type StartQueryInput struct { // returned. The default is 1000. Limit *int32 + // The log group on which to perform the query. A StartQuery operation must include + // a logGroupNames or a logGroupName parameter, but not both. + LogGroupName *string + // The list of log groups to be queried. You can include up to 20 log groups. A // StartQuery operation must include a logGroupNames or a logGroupName parameter, // but not both. diff --git a/service/cloudwatchlogs/api_op_TestMetricFilter.go b/service/cloudwatchlogs/api_op_TestMetricFilter.go index e205c18b178..afe4c43799b 100644 --- a/service/cloudwatchlogs/api_op_TestMetricFilter.go +++ b/service/cloudwatchlogs/api_op_TestMetricFilter.go @@ -59,11 +59,6 @@ func (c *Client) TestMetricFilter(ctx context.Context, params *TestMetricFilterI type TestMetricFilterInput struct { - // The log event messages to test. - // - // This member is required. - LogEventMessages []*string - // A symbolic description of how CloudWatch Logs should interpret the data in each // log event. For example, a log event may contain timestamps, IP addresses, // strings, and so on. You use the filter pattern to specify what to look for in @@ -71,6 +66,11 @@ type TestMetricFilterInput struct { // // This member is required. FilterPattern *string + + // The log event messages to test. + // + // This member is required. + LogEventMessages []*string } type TestMetricFilterOutput struct { diff --git a/service/cloudwatchlogs/api_op_UntagLogGroup.go b/service/cloudwatchlogs/api_op_UntagLogGroup.go index fa5575a214e..94875066c8d 100644 --- a/service/cloudwatchlogs/api_op_UntagLogGroup.go +++ b/service/cloudwatchlogs/api_op_UntagLogGroup.go @@ -60,15 +60,15 @@ func (c *Client) UntagLogGroup(ctx context.Context, params *UntagLogGroupInput, type UntagLogGroupInput struct { - // The tag keys. The corresponding tags are removed from the log group. + // The name of the log group. // // This member is required. - Tags []*string + LogGroupName *string - // The name of the log group. + // The tag keys. The corresponding tags are removed from the log group. // // This member is required. - LogGroupName *string + Tags []*string } type UntagLogGroupOutput struct { diff --git a/service/cloudwatchlogs/go.mod b/service/cloudwatchlogs/go.mod index f70e9f00970..2bb23a465e3 100644 --- a/service/cloudwatchlogs/go.mod +++ b/service/cloudwatchlogs/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/cloudwatchlogs go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/cloudwatchlogs/types/types.go b/service/cloudwatchlogs/types/types.go index 6e01e9d46f7..9f01884b9e8 100644 --- a/service/cloudwatchlogs/types/types.go +++ b/service/cloudwatchlogs/types/types.go @@ -5,72 +5,72 @@ package types // Represents a cross-account destination that receives subscription log events. type Destination struct { + // An IAM policy document that governs which AWS accounts can create subscription + // filters against this destination. + AccessPolicy *string + + // The ARN of this destination. + Arn *string + // The creation time of the destination, expressed as the number of milliseconds // after Jan 1, 1970 00:00:00 UTC. CreationTime *int64 - // A role for impersonation, used when delivering log events to the target. - RoleArn *string - // The name of the destination. DestinationName *string + // A role for impersonation, used when delivering log events to the target. + RoleArn *string + // The Amazon Resource Name (ARN) of the physical target to where the log events // are delivered (for example, a Kinesis stream). TargetArn *string - - // The ARN of this destination. - Arn *string - - // An IAM policy document that governs which AWS accounts can create subscription - // filters against this destination. - AccessPolicy *string } // Represents an export task. type ExportTask struct { + // The name of Amazon S3 bucket to which the log data was exported. + Destination *string + // The prefix that was used as the start of Amazon S3 key for every object // exported. DestinationPrefix *string - // The end time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 - // UTC. Events with a timestamp later than this time are not exported. - To *int64 + // Execution info about the export task. + ExecutionInfo *ExportTaskExecutionInfo // The start time, expressed as the number of milliseconds after Jan 1, 1970 // 00:00:00 UTC. Events with a timestamp before this time are not exported. From *int64 + // The name of the log group from which logs data was exported. + LogGroupName *string + // The status of the export task. Status *ExportTaskStatus - // The name of the log group from which logs data was exported. - LogGroupName *string + // The ID of the export task. + TaskId *string // The name of the export task. TaskName *string - // Execution info about the export task. - ExecutionInfo *ExportTaskExecutionInfo - - // The name of Amazon S3 bucket to which the log data was exported. - Destination *string - - // The ID of the export task. - TaskId *string + // The end time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 + // UTC. Events with a timestamp later than this time are not exported. + To *int64 } // Represents the status of an export task. type ExportTaskExecutionInfo struct { - // The creation time of the export task, expressed as the number of milliseconds - // after Jan 1, 1970 00:00:00 UTC. - CreationTime *int64 - // The completion time of the export task, expressed as the number of milliseconds // after Jan 1, 1970 00:00:00 UTC. CompletionTime *int64 + + // The creation time of the export task, expressed as the number of milliseconds + // after Jan 1, 1970 00:00:00 UTC. + CreationTime *int64 } // Represents the status of an export task. @@ -86,19 +86,19 @@ type ExportTaskStatus struct { // Represents a matched event. type FilteredLogEvent struct { - // The name of the log stream to which this event belongs. - LogStreamName *string + // The ID of the event. + EventId *string // The time the event was ingested, expressed as the number of milliseconds after // Jan 1, 1970 00:00:00 UTC. IngestionTime *int64 + // The name of the log stream to which this event belongs. + LogStreamName *string + // The data contained in the log event. Message *string - // The ID of the event. - EventId *string - // The time the event occurred, expressed as the number of milliseconds after Jan // 1, 1970 00:00:00 UTC. Timestamp *int64 @@ -123,6 +123,13 @@ type InputLogEvent struct { // Represents a log group. type LogGroup struct { + // The Amazon Resource Name (ARN) of the log group. + Arn *string + + // The creation time of the log group, expressed as the number of milliseconds + // after Jan 1, 1970 00:00:00 UTC. + CreationTime *int64 + // The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. KmsKeyId *string @@ -137,13 +144,6 @@ type LogGroup struct { // and 3653. RetentionInDays *int32 - // The Amazon Resource Name (ARN) of the log group. - Arn *string - - // The creation time of the log group, expressed as the number of milliseconds - // after Jan 1, 1970 00:00:00 UTC. - CreationTime *int64 - // The number of bytes stored. StoredBytes *int64 } @@ -163,8 +163,8 @@ type LogGroupField struct { // of logs. type LogStream struct { - // The name of the log stream. - LogStreamName *string + // The Amazon Resource Name (ARN) of the log stream. + Arn *string // The creation time of the stream, expressed as the number of milliseconds after // Jan 1, 1970 00:00:00 UTC. @@ -174,10 +174,6 @@ type LogStream struct { // 1, 1970 00:00:00 UTC. FirstEventTimestamp *int64 - // The ingestion time, expressed as the number of milliseconds after Jan 1, 1970 - // 00:00:00 UTC. - LastIngestionTime *int64 - // The time of the most recent log event in the log stream in CloudWatch Logs. This // number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 // UTC. The lastEventTime value updates on an eventual consistency basis. It @@ -185,16 +181,20 @@ type LogStream struct { // some rare situations. LastEventTimestamp *int64 - // The Amazon Resource Name (ARN) of the log stream. - Arn *string + // The ingestion time, expressed as the number of milliseconds after Jan 1, 1970 + // 00:00:00 UTC. + LastIngestionTime *int64 - // The sequence token. - UploadSequenceToken *string + // The name of the log stream. + LogStreamName *string // The number of bytes stored. IMPORTANT:On June 17, 2019, this parameter was // deprecated for log streams, and is always reported as zero. This change applies // only to log streams. The storedBytes parameter for log groups is not affected. StoredBytes *int64 + + // The sequence token. + UploadSequenceToken *string } // Metric filters express how CloudWatch Logs would extract metric observations @@ -209,9 +209,6 @@ type MetricFilter struct { // The name of the metric filter. FilterName *string - // The metric transformations. - MetricTransformations []*MetricTransformation - // A symbolic description of how CloudWatch Logs should interpret the data in each // log event. For example, a log event may contain timestamps, IP addresses, // strings, and so on. You use the filter pattern to specify what to look for in @@ -220,25 +217,33 @@ type MetricFilter struct { // The name of the log group. LogGroupName *string + + // The metric transformations. + MetricTransformations []*MetricTransformation } // Represents a matched event. type MetricFilterMatchRecord struct { - // The values extracted from the event data by the filter. - ExtractedValues map[string]*string - // The raw event data. EventMessage *string // The event number. EventNumber *int64 + + // The values extracted from the event data by the filter. + ExtractedValues map[string]*string } // Indicates how to transform ingested log events to metric data in a CloudWatch // metric. type MetricTransformation struct { + // The name of the CloudWatch metric. + // + // This member is required. + MetricName *string + // A custom namespace to contain your metric in CloudWatch. Use namespaces to group // together metrics that are similar. For more information, see Namespaces // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace). @@ -246,20 +251,15 @@ type MetricTransformation struct { // This member is required. MetricNamespace *string - // (Optional) The value to emit when a filter pattern does not match a log event. - // This value can be null. - DefaultValue *float64 - // The value to publish to the CloudWatch metric when a filter pattern matches a // log event. // // This member is required. MetricValue *string - // The name of the CloudWatch metric. - // - // This member is required. - MetricName *string + // (Optional) The value to emit when a filter pattern does not match a log event. + // This value can be null. + DefaultValue *float64 } // Represents a log event. @@ -300,12 +300,12 @@ type QueryCompileErrorLocation struct { type QueryDefinition struct { LastModified *int64 - QueryDefinitionId *string - LogGroupNames []*string Name *string + QueryDefinitionId *string + QueryString *string } @@ -316,6 +316,9 @@ type QueryInfo struct { // The date and time that this query was created. CreateTime *int64 + // The name of the log group scanned by this query. + LogGroupName *string + // The unique ID number of this query. QueryId *string @@ -325,9 +328,6 @@ type QueryInfo struct { // The status of this query. Possible values are Cancelled, Complete, Failed, // Running, Scheduled, and Unknown. Status QueryStatus - - // The name of the log group scanned by this query. - LogGroupName *string } // Contains the number of log events scanned by the query, the number of log events @@ -335,42 +335,42 @@ type QueryInfo struct { // that were scanned. type QueryStatistics struct { - // The total number of log events scanned during the query. - RecordsScanned *float64 - // The total number of bytes in the log events scanned during the query. BytesScanned *float64 // The number of log events that matched the query string. RecordsMatched *float64 + + // The total number of log events scanned during the query. + RecordsScanned *float64 } // Represents the rejected events. type RejectedLogEventsInfo struct { - // The log events that are too old. - TooOldLogEventEndIndex *int32 - // The expired log events. ExpiredLogEventEndIndex *int32 // The log events that are too new. TooNewLogEventStartIndex *int32 + + // The log events that are too old. + TooOldLogEventEndIndex *int32 } // A policy enabling one or more entities to put logs to a log group in this // account. type ResourcePolicy struct { + // Timestamp showing when this policy was last updated, expressed as the number of + // milliseconds after Jan 1, 1970 00:00:00 UTC. + LastUpdatedTime *int64 + // The details of the policy. PolicyDocument *string // The name of the resource policy. PolicyName *string - - // Timestamp showing when this policy was last updated, expressed as the number of - // milliseconds after Jan 1, 1970 00:00:00 UTC. - LastUpdatedTime *int64 } // Contains one field from one log event returned by a CloudWatch Logs Insights @@ -399,11 +399,12 @@ type SearchedLogStream struct { // Represents a subscription filter. type SubscriptionFilter struct { - // A symbolic description of how CloudWatch Logs should interpret the data in each - // log event. For example, a log event may contain timestamps, IP addresses, - // strings, and so on. You use the filter pattern to specify what to look for in - // the log event message. - FilterPattern *string + // The creation time of the subscription filter, expressed as the number of + // milliseconds after Jan 1, 1970 00:00:00 UTC. + CreationTime *int64 + + // The Amazon Resource Name (ARN) of the destination. + DestinationArn *string // The method used to distribute log data to the destination, which can be either // random or grouped by log stream. @@ -412,16 +413,15 @@ type SubscriptionFilter struct { // The name of the subscription filter. FilterName *string - // - RoleArn *string - - // The Amazon Resource Name (ARN) of the destination. - DestinationArn *string - - // The creation time of the subscription filter, expressed as the number of - // milliseconds after Jan 1, 1970 00:00:00 UTC. - CreationTime *int64 + // A symbolic description of how CloudWatch Logs should interpret the data in each + // log event. For example, a log event may contain timestamps, IP addresses, + // strings, and so on. You use the filter pattern to specify what to look for in + // the log event message. + FilterPattern *string // The name of the log group. LogGroupName *string + + // + RoleArn *string } diff --git a/service/codeartifact/api_op_AssociateExternalConnection.go b/service/codeartifact/api_op_AssociateExternalConnection.go index d4840124570..2388dadbeb1 100644 --- a/service/codeartifact/api_op_AssociateExternalConnection.go +++ b/service/codeartifact/api_op_AssociateExternalConnection.go @@ -59,20 +59,11 @@ func (c *Client) AssociateExternalConnection(ctx context.Context, params *Associ type AssociateExternalConnectionInput struct { - // The 12-digit account number of the AWS account that owns the domain. It does not - // include dashes or spaces. - DomainOwner *string - // The name of the domain that contains the repository. // // This member is required. Domain *string - // The name of the repository to which the external connection is added. - // - // This member is required. - Repository *string - // The name of the external connection to add to the repository. The following // values are supported: // @@ -95,6 +86,15 @@ type AssociateExternalConnectionInput struct { // // This member is required. ExternalConnection *string + + // The name of the repository to which the external connection is added. + // + // This member is required. + Repository *string + + // The 12-digit account number of the AWS account that owns the domain. It does not + // include dashes or spaces. + DomainOwner *string } type AssociateExternalConnectionOutput struct { diff --git a/service/codeartifact/api_op_CopyPackageVersions.go b/service/codeartifact/api_op_CopyPackageVersions.go index 3a07687cdc8..23db5983477 100644 --- a/service/codeartifact/api_op_CopyPackageVersions.go +++ b/service/codeartifact/api_op_CopyPackageVersions.go @@ -58,31 +58,56 @@ func (c *Client) CopyPackageVersions(ctx context.Context, params *CopyPackageVer type CopyPackageVersionsInput struct { + // The name of the repository into which package versions are copied. + // + // This member is required. + DestinationRepository *string + // The name of the domain that contains the source and destination repositories. // // This member is required. Domain *string - // The name of the repository that contains the package versions to copy. + // The format of the package that is copied. The valid package types are: + // + // * + // npm: A Node Package Manager (npm) package. + // + // * pypi: A Python Package Index + // (PyPI) package. + // + // * maven: A Maven package that contains compiled code in a + // distributable format, such as a JAR file. // // This member is required. - SourceRepository *string + Format types.PackageFormat // The name of the package that is copied. // // This member is required. Package *string + // The name of the repository that contains the package versions to copy. + // + // This member is required. + SourceRepository *string + + // Set to true to overwrite a package version that already exists in the + // destination repository. If set to false and the package version already exists + // in the destination repository, the package version is returned in the + // failedVersions field of the response with an ALREADY_EXISTS error code. + AllowOverwrite *bool + + // The 12-digit account number of the AWS account that owns the domain. It does not + // include dashes or spaces. + DomainOwner *string + // Set to true to copy packages from repositories that are upstream from the source // repository to the destination repository. The default setting is false. For more // information, see Working with upstream repositories // (https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html). IncludeFromUpstream *bool - // The 12-digit account number of the AWS account that owns the domain. It does not - // include dashes or spaces. - DomainOwner *string - // The namespace of the package. The package component that specifies its namespace // depends on its type. For example: // @@ -96,21 +121,6 @@ type CopyPackageVersionsInput struct { // have a namespace. Namespace *string - // Set to true to overwrite a package version that already exists in the - // destination repository. If set to false and the package version already exists - // in the destination repository, the package version is returned in the - // failedVersions field of the response with an ALREADY_EXISTS error code. - AllowOverwrite *bool - - // The name of the repository into which package versions are copied. - // - // This member is required. - DestinationRepository *string - - // The versions of the package to copy. You must specify versions or - // versionRevisions. You cannot specify both. - Versions []*string - // A list of key-value pairs. The keys are package versions and the values are // package version revisions. A CopyPackageVersion operation succeeds if the // specified versions in the source repository match the specified package version @@ -118,26 +128,13 @@ type CopyPackageVersionsInput struct { // both. VersionRevisions map[string]*string - // The format of the package that is copied. The valid package types are: - // - // * - // npm: A Node Package Manager (npm) package. - // - // * pypi: A Python Package Index - // (PyPI) package. - // - // * maven: A Maven package that contains compiled code in a - // distributable format, such as a JAR file. - // - // This member is required. - Format types.PackageFormat + // The versions of the package to copy. You must specify versions or + // versionRevisions. You cannot specify both. + Versions []*string } type CopyPackageVersionsOutput struct { - // A list of the package versions that were successfully copied to your repository. - SuccessfulVersions map[string]*types.SuccessfulPackageVersionInfo - // A map of package versions that failed to copy and their error codes. The // possible error codes are in the PackageVersionError data type. They are: // @@ -156,6 +153,9 @@ type CopyPackageVersionsOutput struct { // * SKIPPED FailedVersions map[string]*types.PackageVersionError + // A list of the package versions that were successfully copied to your repository. + SuccessfulVersions map[string]*types.SuccessfulPackageVersionInfo + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codeartifact/api_op_CreateRepository.go b/service/codeartifact/api_op_CreateRepository.go index 99933376150..4f86f603820 100644 --- a/service/codeartifact/api_op_CreateRepository.go +++ b/service/codeartifact/api_op_CreateRepository.go @@ -57,6 +57,11 @@ func (c *Client) CreateRepository(ctx context.Context, params *CreateRepositoryI type CreateRepositoryInput struct { + // The domain that contains the created repository. + // + // This member is required. + Domain *string + // The name of the repository to create. // // This member is required. @@ -65,11 +70,6 @@ type CreateRepositoryInput struct { // A description of the created repository. Description *string - // The domain that contains the created repository. - // - // This member is required. - Domain *string - // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string diff --git a/service/codeartifact/api_op_DeleteDomain.go b/service/codeartifact/api_op_DeleteDomain.go index a3921df42b7..0e69a18f29d 100644 --- a/service/codeartifact/api_op_DeleteDomain.go +++ b/service/codeartifact/api_op_DeleteDomain.go @@ -58,14 +58,14 @@ func (c *Client) DeleteDomain(ctx context.Context, params *DeleteDomainInput, op type DeleteDomainInput struct { - // The 12-digit account number of the AWS account that owns the domain. It does not - // include dashes or spaces. - DomainOwner *string - // The name of the domain to delete. // // This member is required. Domain *string + + // The 12-digit account number of the AWS account that owns the domain. It does not + // include dashes or spaces. + DomainOwner *string } type DeleteDomainOutput struct { diff --git a/service/codeartifact/api_op_DeleteDomainPermissionsPolicy.go b/service/codeartifact/api_op_DeleteDomainPermissionsPolicy.go index 8694356e95a..00c0dc4fce9 100644 --- a/service/codeartifact/api_op_DeleteDomainPermissionsPolicy.go +++ b/service/codeartifact/api_op_DeleteDomainPermissionsPolicy.go @@ -57,15 +57,15 @@ func (c *Client) DeleteDomainPermissionsPolicy(ctx context.Context, params *Dele type DeleteDomainPermissionsPolicyInput struct { - // The 12-digit account number of the AWS account that owns the domain. It does not - // include dashes or spaces. - DomainOwner *string - // The name of the domain associated with the resource policy to be deleted. // // This member is required. Domain *string + // The 12-digit account number of the AWS account that owns the domain. It does not + // include dashes or spaces. + DomainOwner *string + // The current revision of the resource policy to be deleted. This revision is used // for optimistic locking, which prevents others from overwriting your changes to // the domain's resource policy. diff --git a/service/codeartifact/api_op_DeletePackageVersions.go b/service/codeartifact/api_op_DeletePackageVersions.go index 4d070cefa46..3967f3f54e5 100644 --- a/service/codeartifact/api_op_DeletePackageVersions.go +++ b/service/codeartifact/api_op_DeletePackageVersions.go @@ -69,11 +69,6 @@ type DeletePackageVersionsInput struct { // This member is required. Domain *string - // The name of the repository that contains the package versions to delete. - // - // This member is required. - Repository *string - // The format of the package versions to delete. The valid values are: // // * npm @@ -86,22 +81,24 @@ type DeletePackageVersionsInput struct { // This member is required. Format types.PackageFormat - // The 12-digit account number of the AWS account that owns the domain. It does not - // include dashes or spaces. - DomainOwner *string - - // The namespace of the package. The package component that specifies its namespace - // depends on its type. For example: + // The name of the package with the versions to delete. // - // * The namespace of a Maven package is its - // groupId. + // This member is required. + Package *string + + // The name of the repository that contains the package versions to delete. // - // * The namespace of an npm package is its scope. + // This member is required. + Repository *string + + // An array of strings that specify the versions of the package to delete. // - // * A Python - // package does not contain a corresponding component, so Python packages do not - // have a namespace. - Namespace *string + // This member is required. + Versions []*string + + // The 12-digit account number of the AWS account that owns the domain. It does not + // include dashes or spaces. + DomainOwner *string // The expected status of the package version to delete. Valid values are: // @@ -117,15 +114,18 @@ type DeletePackageVersionsInput struct { // * Disposed ExpectedStatus types.PackageVersionStatus - // An array of strings that specify the versions of the package to delete. + // The namespace of the package. The package component that specifies its namespace + // depends on its type. For example: // - // This member is required. - Versions []*string - - // The name of the package with the versions to delete. + // * The namespace of a Maven package is its + // groupId. // - // This member is required. - Package *string + // * The namespace of an npm package is its scope. + // + // * A Python + // package does not contain a corresponding component, so Python packages do not + // have a namespace. + Namespace *string } type DeletePackageVersionsOutput struct { diff --git a/service/codeartifact/api_op_DeleteRepository.go b/service/codeartifact/api_op_DeleteRepository.go index 21f6466d2e8..f2eb4ae111c 100644 --- a/service/codeartifact/api_op_DeleteRepository.go +++ b/service/codeartifact/api_op_DeleteRepository.go @@ -57,6 +57,11 @@ func (c *Client) DeleteRepository(ctx context.Context, params *DeleteRepositoryI type DeleteRepositoryInput struct { + // The name of the domain that contains the repository to delete. + // + // This member is required. + Domain *string + // The name of the repository to delete. // // This member is required. @@ -65,11 +70,6 @@ type DeleteRepositoryInput struct { // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string - - // The name of the domain that contains the repository to delete. - // - // This member is required. - Domain *string } type DeleteRepositoryOutput struct { diff --git a/service/codeartifact/api_op_DeleteRepositoryPermissionsPolicy.go b/service/codeartifact/api_op_DeleteRepositoryPermissionsPolicy.go index 4c892bc9e68..5d4fa767e7a 100644 --- a/service/codeartifact/api_op_DeleteRepositoryPermissionsPolicy.go +++ b/service/codeartifact/api_op_DeleteRepositoryPermissionsPolicy.go @@ -62,9 +62,11 @@ func (c *Client) DeleteRepositoryPermissionsPolicy(ctx context.Context, params * type DeleteRepositoryPermissionsPolicyInput struct { - // The 12-digit account number of the AWS account that owns the domain. It does not - // include dashes or spaces. - DomainOwner *string + // The name of the domain that contains the repository associated with the resource + // policy to be deleted. + // + // This member is required. + Domain *string // The name of the repository that is associated with the resource policy to be // deleted @@ -72,16 +74,14 @@ type DeleteRepositoryPermissionsPolicyInput struct { // This member is required. Repository *string + // The 12-digit account number of the AWS account that owns the domain. It does not + // include dashes or spaces. + DomainOwner *string + // The revision of the repository's resource policy to be deleted. This revision is // used for optimistic locking, which prevents others from accidentally overwriting // your changes to the repository's resource policy. PolicyRevision *string - - // The name of the domain that contains the repository associated with the resource - // policy to be deleted. - // - // This member is required. - Domain *string } type DeleteRepositoryPermissionsPolicyOutput struct { diff --git a/service/codeartifact/api_op_DescribePackageVersion.go b/service/codeartifact/api_op_DescribePackageVersion.go index 8934b9bb0ac..4eaead2dbf1 100644 --- a/service/codeartifact/api_op_DescribePackageVersion.go +++ b/service/codeartifact/api_op_DescribePackageVersion.go @@ -65,11 +65,28 @@ type DescribePackageVersionInput struct { // This member is required. Domain *string + // A format that specifies the type of the requested package version. The valid + // values are: + // + // * npm + // + // * pypi + // + // * maven + // + // This member is required. + Format types.PackageFormat + // The name of the requested package version. // // This member is required. Package *string + // A string that contains the package version (for example, 3.5.2). + // + // This member is required. + PackageVersion *string + // The name of the repository that contains the package version. // // This member is required. @@ -91,23 +108,6 @@ type DescribePackageVersionInput struct { // package does not contain a corresponding component, so Python packages do not // have a namespace. Namespace *string - - // A format that specifies the type of the requested package version. The valid - // values are: - // - // * npm - // - // * pypi - // - // * maven - // - // This member is required. - Format types.PackageFormat - - // A string that contains the package version (for example, 3.5.2). - // - // This member is required. - PackageVersion *string } type DescribePackageVersionOutput struct { diff --git a/service/codeartifact/api_op_DescribeRepository.go b/service/codeartifact/api_op_DescribeRepository.go index c6e571e50ed..db78f58a4e2 100644 --- a/service/codeartifact/api_op_DescribeRepository.go +++ b/service/codeartifact/api_op_DescribeRepository.go @@ -58,15 +58,15 @@ func (c *Client) DescribeRepository(ctx context.Context, params *DescribeReposit type DescribeRepositoryInput struct { - // A string that specifies the name of the requested repository. + // The name of the domain that contains the repository to describe. // // This member is required. - Repository *string + Domain *string - // The name of the domain that contains the repository to describe. + // A string that specifies the name of the requested repository. // // This member is required. - Domain *string + Repository *string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. diff --git a/service/codeartifact/api_op_DisassociateExternalConnection.go b/service/codeartifact/api_op_DisassociateExternalConnection.go index 3966042ef24..3fdc5c39f92 100644 --- a/service/codeartifact/api_op_DisassociateExternalConnection.go +++ b/service/codeartifact/api_op_DisassociateExternalConnection.go @@ -57,25 +57,25 @@ func (c *Client) DisassociateExternalConnection(ctx context.Context, params *Dis type DisassociateExternalConnectionInput struct { - // The name of the repository from which the external connection will be removed. + // The name of the domain that contains the repository from which to remove the + // external repository. // // This member is required. - Repository *string - - // The 12-digit account number of the AWS account that owns the domain. It does not - // include dashes or spaces. - DomainOwner *string + Domain *string // The name of the external connection to be removed from the repository. // // This member is required. ExternalConnection *string - // The name of the domain that contains the repository from which to remove the - // external repository. + // The name of the repository from which the external connection will be removed. // // This member is required. - Domain *string + Repository *string + + // The 12-digit account number of the AWS account that owns the domain. It does not + // include dashes or spaces. + DomainOwner *string } type DisassociateExternalConnectionOutput struct { diff --git a/service/codeartifact/api_op_DisposePackageVersions.go b/service/codeartifact/api_op_DisposePackageVersions.go index adaf091a8e0..b93d5bfe3e2 100644 --- a/service/codeartifact/api_op_DisposePackageVersions.go +++ b/service/codeartifact/api_op_DisposePackageVersions.go @@ -69,9 +69,10 @@ func (c *Client) DisposePackageVersions(ctx context.Context, params *DisposePack type DisposePackageVersionsInput struct { - // The 12-digit account number of the AWS account that owns the domain. It does not - // include dashes or spaces. - DomainOwner *string + // The name of the domain that contains the repository you want to dispose. + // + // This member is required. + Domain *string // A format that specifies the type of package versions you want to dispose. The // valid values are: @@ -85,18 +86,10 @@ type DisposePackageVersionsInput struct { // This member is required. Format types.PackageFormat - // The namespace of the package. The package component that specifies its namespace - // depends on its type. For example: - // - // * The namespace of a Maven package is its - // groupId. - // - // * The namespace of an npm package is its scope. + // The name of the package with the versions you want to dispose. // - // * A Python - // package does not contain a corresponding component, so Python packages do not - // have a namespace. - Namespace *string + // This member is required. + Package *string // The name of the repository that contains the package versions you want to // dispose. @@ -104,19 +97,15 @@ type DisposePackageVersionsInput struct { // This member is required. Repository *string - // The revisions of the package versions you want to dispose. - VersionRevisions map[string]*string - - // The name of the domain that contains the repository you want to dispose. - // - // This member is required. - Domain *string - // The versions of the package you want to dispose. // // This member is required. Versions []*string + // The 12-digit account number of the AWS account that owns the domain. It does not + // include dashes or spaces. + DomainOwner *string + // The expected status of the package version to dispose. Valid values are: // // * @@ -131,17 +120,25 @@ type DisposePackageVersionsInput struct { // * Disposed ExpectedStatus types.PackageVersionStatus - // The name of the package with the versions you want to dispose. + // The namespace of the package. The package component that specifies its namespace + // depends on its type. For example: // - // This member is required. - Package *string + // * The namespace of a Maven package is its + // groupId. + // + // * The namespace of an npm package is its scope. + // + // * A Python + // package does not contain a corresponding component, so Python packages do not + // have a namespace. + Namespace *string + + // The revisions of the package versions you want to dispose. + VersionRevisions map[string]*string } type DisposePackageVersionsOutput struct { - // A list of the package versions that were successfully disposed. - SuccessfulVersions map[string]*types.SuccessfulPackageVersionInfo - // A PackageVersionError object that contains a map of errors codes for the // disposed package versions that failed. The possible error codes are: // @@ -160,6 +157,9 @@ type DisposePackageVersionsOutput struct { // * SKIPPED FailedVersions map[string]*types.PackageVersionError + // A list of the package versions that were successfully disposed. + SuccessfulVersions map[string]*types.SuccessfulPackageVersionInfo + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codeartifact/api_op_GetAuthorizationToken.go b/service/codeartifact/api_op_GetAuthorizationToken.go index 57465878815..3f8c076e709 100644 --- a/service/codeartifact/api_op_GetAuthorizationToken.go +++ b/service/codeartifact/api_op_GetAuthorizationToken.go @@ -72,27 +72,27 @@ func (c *Client) GetAuthorizationToken(ctx context.Context, params *GetAuthoriza type GetAuthorizationTokenInput struct { + // The name of the domain that is in scope for the generated authorization token. + // + // This member is required. + Domain *string + // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string // The time, in seconds, that the generated authorization token is valid. DurationSeconds *int64 - - // The name of the domain that is in scope for the generated authorization token. - // - // This member is required. - Domain *string } type GetAuthorizationTokenOutput struct { - // A timestamp that specifies the date and time the authorization token expires. - Expiration *time.Time - // The returned authentication token. AuthorizationToken *string + // A timestamp that specifies the date and time the authorization token expires. + Expiration *time.Time + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codeartifact/api_op_GetDomainPermissionsPolicy.go b/service/codeartifact/api_op_GetDomainPermissionsPolicy.go index b64cd9c21c2..df7867f9fae 100644 --- a/service/codeartifact/api_op_GetDomainPermissionsPolicy.go +++ b/service/codeartifact/api_op_GetDomainPermissionsPolicy.go @@ -61,14 +61,14 @@ func (c *Client) GetDomainPermissionsPolicy(ctx context.Context, params *GetDoma type GetDomainPermissionsPolicyInput struct { - // The 12-digit account number of the AWS account that owns the domain. It does not - // include dashes or spaces. - DomainOwner *string - // The name of the domain to which the resource policy is attached. // // This member is required. Domain *string + + // The 12-digit account number of the AWS account that owns the domain. It does not + // include dashes or spaces. + DomainOwner *string } type GetDomainPermissionsPolicyOutput struct { diff --git a/service/codeartifact/api_op_GetPackageVersionAsset.go b/service/codeartifact/api_op_GetPackageVersionAsset.go index 2451e879276..475bf24194f 100644 --- a/service/codeartifact/api_op_GetPackageVersionAsset.go +++ b/service/codeartifact/api_op_GetPackageVersionAsset.go @@ -59,10 +59,10 @@ func (c *Client) GetPackageVersionAsset(ctx context.Context, params *GetPackageV type GetPackageVersionAssetInput struct { - // A string that contains the package version (for example, 3.5.2). + // The name of the requested asset. // // This member is required. - PackageVersion *string + Asset *string // The domain that contains the repository that contains the package version with // the requested asset. @@ -70,14 +70,6 @@ type GetPackageVersionAssetInput struct { // This member is required. Domain *string - // The name of the package that contains the requested asset. - // - // This member is required. - Package *string - - // The name of the package version revision that contains the requested asset. - PackageVersionRevision *string - // A format that specifies the type of the package version with the requested asset // file. The valid values are: // @@ -90,6 +82,21 @@ type GetPackageVersionAssetInput struct { // This member is required. Format types.PackageFormat + // The name of the package that contains the requested asset. + // + // This member is required. + Package *string + + // A string that contains the package version (for example, 3.5.2). + // + // This member is required. + PackageVersion *string + + // The repository that contains the package version with the requested asset. + // + // This member is required. + Repository *string + // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string @@ -107,31 +114,24 @@ type GetPackageVersionAssetInput struct { // have a namespace. Namespace *string - // The name of the requested asset. - // - // This member is required. - Asset *string - - // The repository that contains the package version with the requested asset. - // - // This member is required. - Repository *string + // The name of the package version revision that contains the requested asset. + PackageVersionRevision *string } type GetPackageVersionAssetOutput struct { - // The name of the package version revision that contains the downloaded asset. - PackageVersionRevision *string - - // A string that contains the package version (for example, 3.5.2). - PackageVersion *string - // The binary file, or asset, that is downloaded. Asset io.ReadCloser // The name of the asset that is downloaded. AssetName *string + // A string that contains the package version (for example, 3.5.2). + PackageVersion *string + + // The name of the package version revision that contains the downloaded asset. + PackageVersionRevision *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codeartifact/api_op_GetPackageVersionReadme.go b/service/codeartifact/api_op_GetPackageVersionReadme.go index 56ddc134bdb..53081302476 100644 --- a/service/codeartifact/api_op_GetPackageVersionReadme.go +++ b/service/codeartifact/api_op_GetPackageVersionReadme.go @@ -61,21 +61,39 @@ func (c *Client) GetPackageVersionReadme(ctx context.Context, params *GetPackage type GetPackageVersionReadmeInput struct { - // The name of the package version that contains the requested readme file. + // The name of the domain that contains the repository that contains the package + // version with the requested readme file. // // This member is required. - Package *string + Domain *string - // The repository that contains the package with the requested readme file. + // A format that specifies the type of the package version with the requested + // readme file. The valid values are: + // + // * npm + // + // * pypi + // + // * maven // // This member is required. - Repository *string + Format types.PackageFormat + + // The name of the package version that contains the requested readme file. + // + // This member is required. + Package *string // A string that contains the package version (for example, 3.5.2). // // This member is required. PackageVersion *string + // The repository that contains the package with the requested readme file. + // + // This member is required. + Repository *string + // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string @@ -92,28 +110,20 @@ type GetPackageVersionReadmeInput struct { // package does not contain a corresponding component, so Python packages do not // have a namespace. Namespace *string +} - // A format that specifies the type of the package version with the requested - // readme file. The valid values are: +type GetPackageVersionReadmeOutput struct { + + // The format of the package with the requested readme file. Valid format types + // are: // // * npm // // * pypi // // * maven - // - // This member is required. Format types.PackageFormat - // The name of the domain that contains the repository that contains the package - // version with the requested readme file. - // - // This member is required. - Domain *string -} - -type GetPackageVersionReadmeOutput struct { - // The namespace of the package. The package component that specifies its namespace // depends on its type. For example: // @@ -127,28 +137,18 @@ type GetPackageVersionReadmeOutput struct { // have a namespace. Namespace *string - // The text of the returned readme file. - Readme *string - - // The current revision associated with the package version. - VersionRevision *string - - // The format of the package with the requested readme file. Valid format types - // are: - // - // * npm - // - // * pypi - // - // * maven - Format types.PackageFormat - // The name of the package that contains the returned readme file. Package *string + // The text of the returned readme file. + Readme *string + // The version of the package with the requested readme file. Version *string + // The current revision associated with the package version. + VersionRevision *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codeartifact/api_op_GetRepositoryEndpoint.go b/service/codeartifact/api_op_GetRepositoryEndpoint.go index f1c916e2da9..00679d6137f 100644 --- a/service/codeartifact/api_op_GetRepositoryEndpoint.go +++ b/service/codeartifact/api_op_GetRepositoryEndpoint.go @@ -81,14 +81,14 @@ type GetRepositoryEndpointInput struct { // This member is required. Format types.PackageFormat - // The 12-digit account number of the AWS account that owns the domain that - // contains the repository. It does not include dashes or spaces. - DomainOwner *string - // The name of the repository. // // This member is required. Repository *string + + // The 12-digit account number of the AWS account that owns the domain that + // contains the repository. It does not include dashes or spaces. + DomainOwner *string } type GetRepositoryEndpointOutput struct { diff --git a/service/codeartifact/api_op_GetRepositoryPermissionsPolicy.go b/service/codeartifact/api_op_GetRepositoryPermissionsPolicy.go index 93540fb360d..573e8afc7be 100644 --- a/service/codeartifact/api_op_GetRepositoryPermissionsPolicy.go +++ b/service/codeartifact/api_op_GetRepositoryPermissionsPolicy.go @@ -57,10 +57,6 @@ func (c *Client) GetRepositoryPermissionsPolicy(ctx context.Context, params *Get type GetRepositoryPermissionsPolicyInput struct { - // The 12-digit account number of the AWS account that owns the domain. It does not - // include dashes or spaces. - DomainOwner *string - // The name of the domain containing the repository whose associated resource // policy is to be retrieved. // @@ -71,6 +67,10 @@ type GetRepositoryPermissionsPolicyInput struct { // // This member is required. Repository *string + + // The 12-digit account number of the AWS account that owns the domain. It does not + // include dashes or spaces. + DomainOwner *string } type GetRepositoryPermissionsPolicyOutput struct { diff --git a/service/codeartifact/api_op_ListPackageVersionAssets.go b/service/codeartifact/api_op_ListPackageVersionAssets.go index bdaca5a01ca..cf77355de83 100644 --- a/service/codeartifact/api_op_ListPackageVersionAssets.go +++ b/service/codeartifact/api_op_ListPackageVersionAssets.go @@ -59,25 +59,12 @@ func (c *Client) ListPackageVersionAssets(ctx context.Context, params *ListPacka type ListPackageVersionAssetsInput struct { - // The token for the next set of results. Use the value returned in the previous - // response in the next request to retrieve the next set of results. - NextToken *string - - // A string that contains the package version (for example, 3.5.2). - // - // This member is required. - PackageVersion *string - // The name of the domain that contains the repository associated with the package // version assets. // // This member is required. Domain *string - // The 12-digit account number of the AWS account that owns the domain. It does not - // include dashes or spaces. - DomainOwner *string - // The format of the package that contains the returned package version assets. The // valid package types are: // @@ -92,20 +79,29 @@ type ListPackageVersionAssetsInput struct { // This member is required. Format types.PackageFormat - // The maximum number of results to return per page. - MaxResults *int32 - // The name of the package that contains the returned package version assets. // // This member is required. Package *string + // A string that contains the package version (for example, 3.5.2). + // + // This member is required. + PackageVersion *string + // The name of the repository that contains the package that contains the returned // package version assets. // // This member is required. Repository *string + // The 12-digit account number of the AWS account that owns the domain. It does not + // include dashes or spaces. + DomainOwner *string + + // The maximum number of results to return per page. + MaxResults *int32 + // The namespace of the package. The package component that specifies its namespace // depends on its type. For example: // @@ -118,21 +114,22 @@ type ListPackageVersionAssetsInput struct { // package does not contain a corresponding component, so Python packages do not // have a namespace. Namespace *string + + // The token for the next set of results. Use the value returned in the previous + // response in the next request to retrieve the next set of results. + NextToken *string } type ListPackageVersionAssetsOutput struct { - // The version of the package associated with the returned assets. - Version *string - - // If there are additional results, this is the token for the next set of results. - NextToken *string - // The returned list of AssetSummary // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_AssetSummary.html) // objects. Assets []*types.AssetSummary + // The format of the package that contains the returned package version assets. + Format types.PackageFormat + // The namespace of the package. The package component that specifies its namespace // depends on its type. For example: // @@ -146,15 +143,18 @@ type ListPackageVersionAssetsOutput struct { // have a namespace. Namespace *string - // The format of the package that contains the returned package version assets. - Format types.PackageFormat - - // The current revision associated with the package version. - VersionRevision *string + // If there are additional results, this is the token for the next set of results. + NextToken *string // The name of the package that contains the returned package version assets. Package *string + // The version of the package associated with the returned assets. + Version *string + + // The current revision associated with the package version. + VersionRevision *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codeartifact/api_op_ListPackageVersionDependencies.go b/service/codeartifact/api_op_ListPackageVersionDependencies.go index b8decbc84dc..748874762c9 100644 --- a/service/codeartifact/api_op_ListPackageVersionDependencies.go +++ b/service/codeartifact/api_op_ListPackageVersionDependencies.go @@ -69,33 +69,6 @@ type ListPackageVersionDependenciesInput struct { // This member is required. Domain *string - // The name of the package versions' package. - // - // This member is required. - Package *string - - // A string that contains the package version (for example, 3.5.2). - // - // This member is required. - PackageVersion *string - - // The namespace of the package. The package component that specifies its namespace - // depends on its type. For example: - // - // * The namespace of a Maven package is its - // groupId. - // - // * The namespace of an npm package is its scope. - // - // * A Python - // package does not contain a corresponding component, so Python packages do not - // have a namespace. - Namespace *string - - // The token for the next set of results. Use the value returned in the previous - // response in the next request to retrieve the next set of results. - NextToken *string - // The format of the package with the requested dependencies. The valid package // types are: // @@ -110,6 +83,16 @@ type ListPackageVersionDependenciesInput struct { // This member is required. Format types.PackageFormat + // The name of the package versions' package. + // + // This member is required. + Package *string + + // A string that contains the package version (for example, 3.5.2). + // + // This member is required. + PackageVersion *string + // The name of the repository that contains the requested package version. // // This member is required. @@ -118,9 +101,6 @@ type ListPackageVersionDependenciesInput struct { // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string -} - -type ListPackageVersionDependenciesOutput struct { // The namespace of the package. The package component that specifies its namespace // depends on its type. For example: @@ -135,6 +115,18 @@ type ListPackageVersionDependenciesOutput struct { // have a namespace. Namespace *string + // The token for the next set of results. Use the value returned in the previous + // response in the next request to retrieve the next set of results. + NextToken *string +} + +type ListPackageVersionDependenciesOutput struct { + + // The returned list of PackageDependency + // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDependency.html) + // objects. + Dependencies []*types.PackageDependency + // A format that specifies the type of the package that contains the returned // dependencies. The valid values are: // @@ -145,15 +137,23 @@ type ListPackageVersionDependenciesOutput struct { // * maven Format types.PackageFormat + // The namespace of the package. The package component that specifies its namespace + // depends on its type. For example: + // + // * The namespace of a Maven package is its + // groupId. + // + // * The namespace of an npm package is its scope. + // + // * A Python + // package does not contain a corresponding component, so Python packages do not + // have a namespace. + Namespace *string + // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string - // The returned list of PackageDependency - // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDependency.html) - // objects. - Dependencies []*types.PackageDependency - // The name of the package that contains the returned package versions // dependencies. Package *string diff --git a/service/codeartifact/api_op_ListPackageVersions.go b/service/codeartifact/api_op_ListPackageVersions.go index 1212b0c27f8..d92e939476e 100644 --- a/service/codeartifact/api_op_ListPackageVersions.go +++ b/service/codeartifact/api_op_ListPackageVersions.go @@ -59,37 +59,43 @@ func (c *Client) ListPackageVersions(ctx context.Context, params *ListPackageVer type ListPackageVersionsInput struct { - // The name of the repository that contains the package. + // The name of the domain that contains the repository that contains the returned + // package versions. // // This member is required. - Repository *string + Domain *string - // A string that specifies the status of the package versions to include in the - // returned list. It can be one of the following: - // - // * Published - // - // * - // Unfinished + // The format of the returned packages. The valid package types are: // - // * Unlisted + // * npm: A + // Node Package Manager (npm) package. // - // * Archived + // * pypi: A Python Package Index (PyPI) + // package. // - // * Disposed - Status types.PackageVersionStatus - - // The name of the domain that contains the repository that contains the returned - // package versions. + // * maven: A Maven package that contains compiled code in a + // distributable format, such as a JAR file. // // This member is required. - Domain *string + Format types.PackageFormat // The name of the package for which you want to return a list of package versions. // // This member is required. Package *string + // The name of the repository that contains the package. + // + // This member is required. + Repository *string + + // The 12-digit account number of the AWS account that owns the domain. It does not + // include dashes or spaces. + DomainOwner *string + + // The maximum number of results to return per page. + MaxResults *int32 + // The namespace of the package. The package component that specifies its namespace // depends on its type. For example: // @@ -103,24 +109,6 @@ type ListPackageVersionsInput struct { // have a namespace. Namespace *string - // The 12-digit account number of the AWS account that owns the domain. It does not - // include dashes or spaces. - DomainOwner *string - - // The format of the returned packages. The valid package types are: - // - // * npm: A - // Node Package Manager (npm) package. - // - // * pypi: A Python Package Index (PyPI) - // package. - // - // * maven: A Maven package that contains compiled code in a - // distributable format, such as a JAR file. - // - // This member is required. - Format types.PackageFormat - // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string @@ -128,29 +116,23 @@ type ListPackageVersionsInput struct { // How to sort the returned list of package versions. SortBy types.PackageVersionSortType - // The maximum number of results to return per page. - MaxResults *int32 -} - -type ListPackageVersionsOutput struct { - - // The returned list of PackageVersionSummary - // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionSummary.html) - // objects. - Versions []*types.PackageVersionSummary - - // A format of the package. Valid package format values are: + // A string that specifies the status of the package versions to include in the + // returned list. It can be one of the following: // - // * npm + // * Published // // * - // pypi + // Unfinished // - // * maven - Format types.PackageFormat + // * Unlisted + // + // * Archived + // + // * Disposed + Status types.PackageVersionStatus +} - // The name of the package. - Package *string +type ListPackageVersionsOutput struct { // The default package version to display. This depends on the package format: // @@ -162,8 +144,15 @@ type ListPackageVersionsOutput struct { // If the latest tag is not set, it's the most recently published package version. DefaultDisplayVersion *string - // If there are additional results, this is the token for the next set of results. - NextToken *string + // A format of the package. Valid package format values are: + // + // * npm + // + // * + // pypi + // + // * maven + Format types.PackageFormat // The namespace of the package. The package component that specifies its namespace // depends on its type. For example: @@ -178,6 +167,17 @@ type ListPackageVersionsOutput struct { // have a namespace. Namespace *string + // If there are additional results, this is the token for the next set of results. + NextToken *string + + // The name of the package. + Package *string + + // The returned list of PackageVersionSummary + // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionSummary.html) + // objects. + Versions []*types.PackageVersionSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codeartifact/api_op_ListPackages.go b/service/codeartifact/api_op_ListPackages.go index 49a34b77749..db73554387b 100644 --- a/service/codeartifact/api_op_ListPackages.go +++ b/service/codeartifact/api_op_ListPackages.go @@ -59,18 +59,20 @@ func (c *Client) ListPackages(ctx context.Context, params *ListPackagesInput, op type ListPackagesInput struct { - // The namespace of the package. The package component that specifies its namespace - // depends on its type. For example: - // - // * The namespace of a Maven package is its - // groupId. + // The domain that contains the repository that contains the requested list of + // packages. // - // * The namespace of an npm package is its scope. + // This member is required. + Domain *string + + // The name of the repository from which packages are to be listed. // - // * A Python - // package does not contain a corresponding component, so Python packages do not - // have a namespace. - Namespace *string + // This member is required. + Repository *string + + // The 12-digit account number of the AWS account that owns the domain. It does not + // include dashes or spaces. + DomainOwner *string // The format of the packages. The valid package types are: // @@ -84,31 +86,29 @@ type ListPackagesInput struct { // distributable format, such as a JAR file. Format types.PackageFormat - // The 12-digit account number of the AWS account that owns the domain. It does not - // include dashes or spaces. - DomainOwner *string + // The maximum number of results to return per page. + MaxResults *int32 + + // The namespace of the package. The package component that specifies its namespace + // depends on its type. For example: + // + // * The namespace of a Maven package is its + // groupId. + // + // * The namespace of an npm package is its scope. + // + // * A Python + // package does not contain a corresponding component, so Python packages do not + // have a namespace. + Namespace *string // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string - // The maximum number of results to return per page. - MaxResults *int32 - // A prefix used to filter returned repositories. Only repositories with names that // start with repositoryPrefix are returned. PackagePrefix *string - - // The name of the repository from which packages are to be listed. - // - // This member is required. - Repository *string - - // The domain that contains the repository that contains the requested list of - // packages. - // - // This member is required. - Domain *string } type ListPackagesOutput struct { diff --git a/service/codeartifact/api_op_ListRepositories.go b/service/codeartifact/api_op_ListRepositories.go index e541c995db5..88e5a205b25 100644 --- a/service/codeartifact/api_op_ListRepositories.go +++ b/service/codeartifact/api_op_ListRepositories.go @@ -59,16 +59,16 @@ func (c *Client) ListRepositories(ctx context.Context, params *ListRepositoriesI type ListRepositoriesInput struct { - // A prefix used to filter returned repositories. Only repositories with names that - // start with repositoryPrefix are returned. - RepositoryPrefix *string - // The maximum number of results to return per page. MaxResults *int32 // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string + + // A prefix used to filter returned repositories. Only repositories with names that + // start with repositoryPrefix are returned. + RepositoryPrefix *string } type ListRepositoriesOutput struct { diff --git a/service/codeartifact/api_op_ListRepositoriesInDomain.go b/service/codeartifact/api_op_ListRepositoriesInDomain.go index a0b6860d3d3..1367b8ad5a3 100644 --- a/service/codeartifact/api_op_ListRepositoriesInDomain.go +++ b/service/codeartifact/api_op_ListRepositoriesInDomain.go @@ -60,25 +60,25 @@ func (c *Client) ListRepositoriesInDomain(ctx context.Context, params *ListRepos type ListRepositoriesInDomainInput struct { - // The token for the next set of results. Use the value returned in the previous - // response in the next request to retrieve the next set of results. - NextToken *string + // The name of the domain that contains the returned list of repositories. + // + // This member is required. + Domain *string // Filter the list of repositories to only include those that are managed by the // AWS account ID. AdministratorAccount *string - // The maximum number of results to return per page. - MaxResults *int32 - // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string - // The name of the domain that contains the returned list of repositories. - // - // This member is required. - Domain *string + // The maximum number of results to return per page. + MaxResults *int32 + + // The token for the next set of results. Use the value returned in the previous + // response in the next request to retrieve the next set of results. + NextToken *string // A prefix used to filter returned repositories. Only repositories with names that // start with repositoryPrefix are returned. diff --git a/service/codeartifact/api_op_PutDomainPermissionsPolicy.go b/service/codeartifact/api_op_PutDomainPermissionsPolicy.go index ceef6c53f12..1cf2ef6d096 100644 --- a/service/codeartifact/api_op_PutDomainPermissionsPolicy.go +++ b/service/codeartifact/api_op_PutDomainPermissionsPolicy.go @@ -57,15 +57,6 @@ func (c *Client) PutDomainPermissionsPolicy(ctx context.Context, params *PutDoma type PutDomainPermissionsPolicyInput struct { - // The current revision of the resource policy to be set. This revision is used for - // optimistic locking, which prevents others from overwriting your changes to the - // domain's resource policy. - PolicyRevision *string - - // The 12-digit account number of the AWS account that owns the domain. It does not - // include dashes or spaces. - DomainOwner *string - // The name of the domain on which to set the resource policy. // // This member is required. @@ -76,6 +67,15 @@ type PutDomainPermissionsPolicyInput struct { // // This member is required. PolicyDocument *string + + // The 12-digit account number of the AWS account that owns the domain. It does not + // include dashes or spaces. + DomainOwner *string + + // The current revision of the resource policy to be set. This revision is used for + // optimistic locking, which prevents others from overwriting your changes to the + // domain's resource policy. + PolicyRevision *string } type PutDomainPermissionsPolicyOutput struct { diff --git a/service/codeartifact/api_op_PutRepositoryPermissionsPolicy.go b/service/codeartifact/api_op_PutRepositoryPermissionsPolicy.go index f1bf9e179e5..44fd6a0965b 100644 --- a/service/codeartifact/api_op_PutRepositoryPermissionsPolicy.go +++ b/service/codeartifact/api_op_PutRepositoryPermissionsPolicy.go @@ -58,15 +58,6 @@ func (c *Client) PutRepositoryPermissionsPolicy(ctx context.Context, params *Put type PutRepositoryPermissionsPolicyInput struct { - // Sets the revision of the resource policy that specifies permissions to access - // the repository. This revision is used for optimistic locking, which prevents - // others from overwriting your changes to the repository's resource policy. - PolicyRevision *string - - // The 12-digit account number of the AWS account that owns the domain. It does not - // include dashes or spaces. - DomainOwner *string - // The name of the domain containing the repository to set the resource policy on. // // This member is required. @@ -82,6 +73,15 @@ type PutRepositoryPermissionsPolicyInput struct { // // This member is required. Repository *string + + // The 12-digit account number of the AWS account that owns the domain. It does not + // include dashes or spaces. + DomainOwner *string + + // Sets the revision of the resource policy that specifies permissions to access + // the repository. This revision is used for optimistic locking, which prevents + // others from overwriting your changes to the repository's resource policy. + PolicyRevision *string } type PutRepositoryPermissionsPolicyOutput struct { diff --git a/service/codeartifact/api_op_UpdatePackageVersionsStatus.go b/service/codeartifact/api_op_UpdatePackageVersionsStatus.go index 7ba686eedbf..1446a9814de 100644 --- a/service/codeartifact/api_op_UpdatePackageVersionsStatus.go +++ b/service/codeartifact/api_op_UpdatePackageVersionsStatus.go @@ -63,22 +63,49 @@ type UpdatePackageVersionsStatusInput struct { // This member is required. Domain *string + // A format that specifies the type of the package with the statuses to update. The + // valid values are: + // + // * npm + // + // * pypi + // + // * maven + // + // This member is required. + Format types.PackageFormat + + // The name of the package with the version statuses to update. + // + // This member is required. + Package *string + + // The repository that contains the package versions with the status you want to + // update. + // + // This member is required. + Repository *string + + // The status you want to change the package version status to. + // + // This member is required. + TargetStatus types.PackageVersionStatus + // An array of strings that specify the versions of the package with the statuses // to update. // // This member is required. Versions []*string + // The 12-digit account number of the AWS account that owns the domain. It does not + // include dashes or spaces. + DomainOwner *string + // The package version’s expected status before it is updated. If expectedStatus is // provided, the package version's status is updated only if its status at the time // UpdatePackageVersionsStatus is called matches expectedStatus. ExpectedStatus types.PackageVersionStatus - // The name of the package with the version statuses to update. - // - // This member is required. - Package *string - // The namespace of the package. The package component that specifies its namespace // depends on its type. For example: // @@ -96,33 +123,6 @@ type UpdatePackageVersionsStatusInput struct { // package version (for example, 3.5.2), and the map value is the package version // revision. VersionRevisions map[string]*string - - // A format that specifies the type of the package with the statuses to update. The - // valid values are: - // - // * npm - // - // * pypi - // - // * maven - // - // This member is required. - Format types.PackageFormat - - // The 12-digit account number of the AWS account that owns the domain. It does not - // include dashes or spaces. - DomainOwner *string - - // The repository that contains the package versions with the status you want to - // update. - // - // This member is required. - Repository *string - - // The status you want to change the package version status to. - // - // This member is required. - TargetStatus types.PackageVersionStatus } type UpdatePackageVersionsStatusOutput struct { diff --git a/service/codeartifact/api_op_UpdateRepository.go b/service/codeartifact/api_op_UpdateRepository.go index a9627a1073f..ca50770921c 100644 --- a/service/codeartifact/api_op_UpdateRepository.go +++ b/service/codeartifact/api_op_UpdateRepository.go @@ -67,13 +67,13 @@ type UpdateRepositoryInput struct { // This member is required. Repository *string + // An updated repository description. + Description *string + // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string - // An updated repository description. - Description *string - // A list of upstream repositories to associate with the repository. The order of // the upstream repositories in the list determines their priority order when AWS // CodeArtifact looks for a requested package version. For more information, see diff --git a/service/codeartifact/go.mod b/service/codeartifact/go.mod index eb66243e2d7..3897a86a81a 100644 --- a/service/codeartifact/go.mod +++ b/service/codeartifact/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/codeartifact go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/codeartifact/types/types.go b/service/codeartifact/types/types.go index 4307f0adeea..2f151ecbea4 100644 --- a/service/codeartifact/types/types.go +++ b/service/codeartifact/types/types.go @@ -9,9 +9,6 @@ import ( // Contains details about a package version asset. type AssetSummary struct { - // The size of the asset. - Size *int64 - // The name of the asset. // // This member is required. @@ -19,6 +16,9 @@ type AssetSummary struct { // The hashes of the asset. Hashes map[string]*string + + // The size of the asset. + Size *int64 } // Information about a domain. A domain is a container for repositories. When you @@ -31,6 +31,15 @@ type DomainDescription struct { // The total size of all assets in the domain. AssetSizeBytes *int64 + // A timestamp that represents the date and time the domain was created. + CreatedTime *time.Time + + // The ARN of an AWS Key Management Service (AWS KMS) key associated with a domain. + EncryptionKey *string + + // The name of the domain. + Name *string + // The AWS account ID that owns the domain. Owner *string @@ -44,15 +53,6 @@ type DomainDescription struct { // * // Deleted Status DomainStatus - - // The ARN of an AWS Key Management Service (AWS KMS) key associated with a domain. - EncryptionKey *string - - // The name of the domain. - Name *string - - // A timestamp that represents the date and time the domain was created. - CreatedTime *time.Time } // Information about a domain, including its name, Amazon Resource Name (ARN), and @@ -61,9 +61,22 @@ type DomainDescription struct { // operation returns a list of DomainSummary objects. type DomainSummary struct { + // The ARN of the domain. + Arn *string + + // A timestamp that contains the date and time the domain was created. + CreatedTime *time.Time + // The key used to encrypt the domain. EncryptionKey *string + // The name of the domain. + Name *string + + // The 12-digit account number of the AWS account that owns the domain. It does not + // include dashes or spaces. + Owner *string + // A string that contains the status of the domain. The valid values are: // // * @@ -71,41 +84,25 @@ type DomainSummary struct { // // * Deleted Status DomainStatus - - // The name of the domain. - Name *string - - // The ARN of the domain. - Arn *string - - // A timestamp that contains the date and time the domain was created. - CreatedTime *time.Time - - // The 12-digit account number of the AWS account that owns the domain. It does not - // include dashes or spaces. - Owner *string } // Details of the license data. type LicenseInfo struct { - // The URL for license data. - Url *string - // Name of the license. Name *string + + // The URL for license data. + Url *string } // Details about a package dependency. type PackageDependency struct { - // The required version, or version range, of the package that this package depends - // on. The version format is specific to the package type. For example, the - // following are possible valid required versions: 1.2.3, ^2.3.4, or 4.x. - VersionRequirement *string - - // The name of the package that this package depends on. - Package *string + // The type of a package dependency. The possible values depend on the package + // type. Example types are compile, runtime, and test for Maven packages, and dev, + // prod, and optional for npm packages. + DependencyType *string // The namespace of the package. The package component that specifies its namespace // depends on its type. For example: @@ -120,10 +117,13 @@ type PackageDependency struct { // have a namespace. Namespace *string - // The type of a package dependency. The possible values depend on the package - // type. Example types are compile, runtime, and test for Maven packages, and dev, - // prod, and optional for npm packages. - DependencyType *string + // The name of the package that this package depends on. + Package *string + + // The required version, or version range, of the package that this package depends + // on. The version format is specific to the package type. For example, the + // following are possible valid required versions: 1.2.3, ^2.3.4, or 4.x. + VersionRequirement *string } // Details about a package, including its format, namespace, and name. The @@ -132,9 +132,6 @@ type PackageDependency struct { // operation returns a list of PackageSummary objects. type PackageSummary struct { - // The name of the package. - Package *string - // The format of the package. Valid values are: // // * npm @@ -156,44 +153,37 @@ type PackageSummary struct { // package does not contain a corresponding component, so Python packages do not // have a namespace. Namespace *string + + // The name of the package. + Package *string } // Details about a package version. type PackageVersionDescription struct { - // A summary of the package version. The summary is extracted from the package. The - // information in and detail level of the summary depends on the package version's - // format. - Summary *string - - // The repository for the source code in the package version, or the source code - // used to build it. - SourceCodeRepository *string - - // The version of the package. - Version *string + // The name of the package that is displayed. The displayName varies depending on + // the package version's format. For example, if an npm package is named ui, is in + // the namespace vue, and has the format npm, then the displayName is @vue/ui. + DisplayName *string - // A string that contains the status of the package version. It can be one of the - // following: - // - // * Published - // - // * Unfinished - // - // * Unlisted + // The format of the package version. The valid package formats are: // - // * Archived + // * npm: A + // Node Package Manager (npm) package. // + // * pypi: A Python Package Index (PyPI) + // package. // - // * Disposed - Status PackageVersionStatus - - // Information about licenses associated with the package version. - Licenses []*LicenseInfo + // * maven: A Maven package that contains compiled code in a + // distributable format, such as a JAR file. + Format PackageFormat // The homepage associated with the package. HomePage *string + // Information about licenses associated with the package version. + Licenses []*LicenseInfo + // The namespace of the package. The package component that specifies its namespace // depends on its type. For example: // @@ -210,36 +200,43 @@ type PackageVersionDescription struct { // The name of the requested package. PackageName *string - // The format of the package version. The valid package formats are: - // - // * npm: A - // Node Package Manager (npm) package. - // - // * pypi: A Python Package Index (PyPI) - // package. - // - // * maven: A Maven package that contains compiled code in a - // distributable format, such as a JAR file. - Format PackageFormat + // A timestamp that contains the date and time the package version was published. + PublishedTime *time.Time // The revision of the package version. Revision *string - // The name of the package that is displayed. The displayName varies depending on - // the package version's format. For example, if an npm package is named ui, is in - // the namespace vue, and has the format npm, then the displayName is @vue/ui. - DisplayName *string + // The repository for the source code in the package version, or the source code + // used to build it. + SourceCodeRepository *string - // A timestamp that contains the date and time the package version was published. - PublishedTime *time.Time + // A string that contains the status of the package version. It can be one of the + // following: + // + // * Published + // + // * Unfinished + // + // * Unlisted + // + // * Archived + // + // + // * Disposed + Status PackageVersionStatus + + // A summary of the package version. The summary is extracted from the package. The + // information in and detail level of the summary depends on the package version's + // format. + Summary *string + + // The version of the package. + Version *string } // An error associated with package. type PackageVersionError struct { - // The error message associated with the error. - ErrorMessage *string - // The error code associated with the error. Valid error codes are: // // * @@ -256,6 +253,9 @@ type PackageVersionError struct { // // * SKIPPED ErrorCode PackageVersionErrorCode + + // The error message associated with the error. + ErrorMessage *string } // Details about a package version, including its status, version, and revision. @@ -264,11 +264,6 @@ type PackageVersionError struct { // operation returns a list of PackageVersionSummary objects. type PackageVersionSummary struct { - // Information about a package version. - // - // This member is required. - Version *string - // A string that contains the status of the package version. It can be one of the // following: // @@ -286,6 +281,11 @@ type PackageVersionSummary struct { // This member is required. Status PackageVersionStatus + // Information about a package version. + // + // This member is required. + Version *string + // The revision associated with a package version. Revision *string } @@ -298,39 +298,42 @@ type PackageVersionSummary struct { // You can create up to 100 repositories per AWS account. type RepositoryDescription struct { - // The name of the domain that contains the repository. - DomainName *string + // The 12-digit account number of the AWS account that manages the repository. + AdministratorAccount *string + + // The Amazon Resource Name (ARN) of the repository. + Arn *string // A text description of the repository. Description *string - // The name of the repository. - Name *string + // The name of the domain that contains the repository. + DomainName *string // The 12-digit account number of the AWS account that owns the domain that // contains the repository. It does not include dashes or spaces. DomainOwner *string + // An array of external connections associated with the repository. + ExternalConnections []*RepositoryExternalConnectionInfo + + // The name of the repository. + Name *string + // A list of upstream repositories to associate with the repository. The order of // the upstream repositories in the list determines their priority order when AWS // CodeArtifact looks for a requested package version. For more information, see // Working with upstream repositories // (https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html). Upstreams []*UpstreamRepositoryInfo - - // An array of external connections associated with the repository. - ExternalConnections []*RepositoryExternalConnectionInfo - - // The Amazon Resource Name (ARN) of the repository. - Arn *string - - // The 12-digit account number of the AWS account that manages the repository. - AdministratorAccount *string } // Contains information about the external connection of a repository. type RepositoryExternalConnectionInfo struct { + // The name of the external connection associated with a repository. + ExternalConnectionName *string + // The package format associated with a repository's external connection. The valid // package formats are: // @@ -346,9 +349,6 @@ type RepositoryExternalConnectionInfo struct { // The status of the external connection of a repository. There is one valid value, // Available. Status ExternalConnectionStatus - - // The name of the external connection associated with a repository. - ExternalConnectionName *string } // Details about a repository, including its Amazon Resource Name (ARN), @@ -360,21 +360,21 @@ type RepositorySummary struct { // The AWS account ID that manages the repository. AdministratorAccount *string - // The name of the repository. - Name *string - - // The 12-digit account number of the AWS account that owns the domain. It does not - // include dashes or spaces. - DomainOwner *string - // The ARN of the repository. Arn *string + // The description of the repository. + Description *string + // The name of the domain that contains the repository. DomainName *string - // The description of the repository. - Description *string + // The 12-digit account number of the AWS account that owns the domain. It does not + // include dashes or spaces. + DomainOwner *string + + // The name of the repository. + Name *string } // An AWS CodeArtifact resource policy that contains a resource ARN, document diff --git a/service/codebuild/api_op_BatchGetBuildBatches.go b/service/codebuild/api_op_BatchGetBuildBatches.go index 8c0490b6ca9..57021221034 100644 --- a/service/codebuild/api_op_BatchGetBuildBatches.go +++ b/service/codebuild/api_op_BatchGetBuildBatches.go @@ -65,12 +65,12 @@ type BatchGetBuildBatchesInput struct { type BatchGetBuildBatchesOutput struct { - // An array that contains the identifiers of any batch builds that are not found. - BuildBatchesNotFound []*string - // An array of BuildBatch objects that represent the retrieved batch builds. BuildBatches []*types.BuildBatch + // An array that contains the identifiers of any batch builds that are not found. + BuildBatchesNotFound []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codebuild/api_op_BatchGetReportGroups.go b/service/codebuild/api_op_BatchGetReportGroups.go index 12548798ec9..76718b228f9 100644 --- a/service/codebuild/api_op_BatchGetReportGroups.go +++ b/service/codebuild/api_op_BatchGetReportGroups.go @@ -65,13 +65,13 @@ type BatchGetReportGroupsInput struct { type BatchGetReportGroupsOutput struct { + // The array of report groups returned by BatchGetReportGroups. + ReportGroups []*types.ReportGroup + // An array of ARNs passed to BatchGetReportGroups that are not associated with a // ReportGroup. ReportGroupsNotFound []*string - // The array of report groups returned by BatchGetReportGroups. - ReportGroups []*types.ReportGroup - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codebuild/api_op_BatchGetReports.go b/service/codebuild/api_op_BatchGetReports.go index 8677b8d6029..b343eb6159d 100644 --- a/service/codebuild/api_op_BatchGetReports.go +++ b/service/codebuild/api_op_BatchGetReports.go @@ -65,13 +65,13 @@ type BatchGetReportsInput struct { type BatchGetReportsOutput struct { + // The array of Report objects returned by BatchGetReports. + Reports []*types.Report + // An array of ARNs passed to BatchGetReportGroups that are not associated with a // Report. ReportsNotFound []*string - // The array of Report objects returned by BatchGetReports. - Reports []*types.Report - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codebuild/api_op_CreateProject.go b/service/codebuild/api_op_CreateProject.go index 6f608d0c5c6..397f91695d4 100644 --- a/service/codebuild/api_op_CreateProject.go +++ b/service/codebuild/api_op_CreateProject.go @@ -57,35 +57,77 @@ func (c *Client) CreateProject(ctx context.Context, params *CreateProjectInput, type CreateProjectInput struct { + // Information about the build output artifacts for the build project. + // + // This member is required. + Artifacts *types.ProjectArtifacts + + // Information about the build environment for the build project. + // + // This member is required. + Environment *types.ProjectEnvironment + + // The name of the build project. + // + // This member is required. + Name *string + + // The ARN of the AWS Identity and Access Management (IAM) role that enables AWS + // CodeBuild to interact with dependent AWS services on behalf of the AWS account. + // + // This member is required. + ServiceRole *string + + // Information about the build input source code for the build project. + // + // This member is required. + Source *types.ProjectSource + + // Set this to true to generate a publicly accessible URL for your project's build + // badge. + BadgeEnabled *bool + + // A ProjectBuildBatchConfig () object that defines the batch build options for the + // project. + BuildBatchConfig *types.ProjectBuildBatchConfig + // Stores recently used information so that it can be quickly accessed at a later // time. Cache *types.ProjectCache + // A description that makes the build project easy to identify. + Description *string + + // The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used + // for encrypting the build output artifacts. You can use a cross-account KMS key + // to encrypt the build output artifacts if your service role has permission to + // that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, + // if available, the CMK's alias (using the format alias/alias-name ). + EncryptionKey *string + + // An array of ProjectFileSystemLocation objects for a CodeBuild build project. A + // ProjectFileSystemLocation object specifies the identifier, location, + // mountOptions, mountPoint, and type of a file system created using Amazon Elastic + // File System. + FileSystemLocations []*types.ProjectFileSystemLocation + // Information about logs for the build project. These can be logs in Amazon // CloudWatch Logs, logs uploaded to a specified S3 bucket, or both. LogsConfig *types.LogsConfig - // Information about the build output artifacts for the build project. - // - // This member is required. - Artifacts *types.ProjectArtifacts + // The number of minutes a build is allowed to be queued before it times out. + QueuedTimeoutInMinutes *int32 - // A list of tag key and value pairs associated with this build project. These tags - // are available for use by AWS services that support AWS CodeBuild build project - // tags. - Tags []*types.Tag + // An array of ProjectArtifacts objects. + SecondaryArtifacts []*types.ProjectArtifacts // An array of ProjectSourceVersion objects. If secondarySourceVersions is // specified at the build level, then they take precedence over these // secondarySourceVersions (at the project level). SecondarySourceVersions []*types.ProjectSourceVersion - // The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used - // for encrypting the build output artifacts. You can use a cross-account KMS key - // to encrypt the build output artifacts if your service role has permission to - // that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, - // if available, the CMK's alias (using the format alias/alias-name ). - EncryptionKey *string + // An array of ProjectSource objects. + SecondarySources []*types.ProjectSource // A version of the build input to be built for this project. If not specified, the // latest version is used. If specified, it must be one of: @@ -116,60 +158,18 @@ type CreateProjectInput struct { // in the AWS CodeBuild User Guide. SourceVersion *string - // A description that makes the build project easy to identify. - Description *string - - // An array of ProjectArtifacts objects. - SecondaryArtifacts []*types.ProjectArtifacts - - // An array of ProjectSource objects. - SecondarySources []*types.ProjectSource - - // An array of ProjectFileSystemLocation objects for a CodeBuild build project. A - // ProjectFileSystemLocation object specifies the identifier, location, - // mountOptions, mountPoint, and type of a file system created using Amazon Elastic - // File System. - FileSystemLocations []*types.ProjectFileSystemLocation - - // Information about the build input source code for the build project. - // - // This member is required. - Source *types.ProjectSource - - // VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC. - VpcConfig *types.VpcConfig - - // The number of minutes a build is allowed to be queued before it times out. - QueuedTimeoutInMinutes *int32 - - // Information about the build environment for the build project. - // - // This member is required. - Environment *types.ProjectEnvironment + // A list of tag key and value pairs associated with this build project. These tags + // are available for use by AWS services that support AWS CodeBuild build project + // tags. + Tags []*types.Tag // How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before // it times out any build that has not been marked as completed. The default is 60 // minutes. TimeoutInMinutes *int32 - // The name of the build project. - // - // This member is required. - Name *string - - // The ARN of the AWS Identity and Access Management (IAM) role that enables AWS - // CodeBuild to interact with dependent AWS services on behalf of the AWS account. - // - // This member is required. - ServiceRole *string - - // Set this to true to generate a publicly accessible URL for your project's build - // badge. - BadgeEnabled *bool - - // A ProjectBuildBatchConfig () object that defines the batch build options for the - // project. - BuildBatchConfig *types.ProjectBuildBatchConfig + // VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC. + VpcConfig *types.VpcConfig } type CreateProjectOutput struct { diff --git a/service/codebuild/api_op_CreateReportGroup.go b/service/codebuild/api_op_CreateReportGroup.go index 60fd0726c9e..96ad10c235c 100644 --- a/service/codebuild/api_op_CreateReportGroup.go +++ b/service/codebuild/api_op_CreateReportGroup.go @@ -57,26 +57,26 @@ func (c *Client) CreateReportGroup(ctx context.Context, params *CreateReportGrou type CreateReportGroupInput struct { - // The type of report group. + // A ReportExportConfig object that contains information about where the report + // group test results are exported. // // This member is required. - Type types.ReportType + ExportConfig *types.ReportExportConfig // The name of the report group. // // This member is required. Name *string + // The type of report group. + // + // This member is required. + Type types.ReportType + // A list of tag key and value pairs associated with this report group. These tags // are available for use by AWS services that support AWS CodeBuild report group // tags. Tags []*types.Tag - - // A ReportExportConfig object that contains information about where the report - // group test results are exported. - // - // This member is required. - ExportConfig *types.ReportExportConfig } type CreateReportGroupOutput struct { diff --git a/service/codebuild/api_op_CreateWebhook.go b/service/codebuild/api_op_CreateWebhook.go index 086af4962a8..f7feeef10c9 100644 --- a/service/codebuild/api_op_CreateWebhook.go +++ b/service/codebuild/api_op_CreateWebhook.go @@ -67,15 +67,6 @@ func (c *Client) CreateWebhook(ctx context.Context, params *CreateWebhookInput, type CreateWebhookInput struct { - // Specifies the type of build this webhook will trigger. - BuildType types.WebhookBuildType - - // An array of arrays of WebhookFilter objects used to determine which webhooks are - // triggered. At least one WebhookFilter in the array must specify EVENT as its - // type. For a build to be triggered, at least one filter group in the filterGroups - // array must pass. For a filter group to pass, each of its filters must pass. - FilterGroups [][]*types.WebhookFilter - // The name of the AWS CodeBuild project. // // This member is required. @@ -86,6 +77,15 @@ type CreateWebhookInput struct { // then it is built. If branchFilter is empty, then all branches are built. It is // recommended that you use filterGroups instead of branchFilter. BranchFilter *string + + // Specifies the type of build this webhook will trigger. + BuildType types.WebhookBuildType + + // An array of arrays of WebhookFilter objects used to determine which webhooks are + // triggered. At least one WebhookFilter in the array must specify EVENT as its + // type. For a build to be triggered, at least one filter group in the filterGroups + // array must pass. For a filter group to pass, each of its filters must pass. + FilterGroups [][]*types.WebhookFilter } type CreateWebhookOutput struct { diff --git a/service/codebuild/api_op_DeleteBuildBatch.go b/service/codebuild/api_op_DeleteBuildBatch.go index d78655222db..6ce2df1b1d9 100644 --- a/service/codebuild/api_op_DeleteBuildBatch.go +++ b/service/codebuild/api_op_DeleteBuildBatch.go @@ -65,16 +65,16 @@ type DeleteBuildBatchInput struct { type DeleteBuildBatchOutput struct { - // The status code. - StatusCode *string + // An array of strings that contain the identifiers of the builds that were + // deleted. + BuildsDeleted []*string // An array of BuildNotDeleted objects that specify the builds that could not be // deleted. BuildsNotDeleted []*types.BuildNotDeleted - // An array of strings that contain the identifiers of the builds that were - // deleted. - BuildsDeleted []*string + // The status code. + StatusCode *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/codebuild/api_op_DescribeCodeCoverages.go b/service/codebuild/api_op_DescribeCodeCoverages.go index a379d46fa46..0d93cc4fc7f 100644 --- a/service/codebuild/api_op_DescribeCodeCoverages.go +++ b/service/codebuild/api_op_DescribeCodeCoverages.go @@ -57,32 +57,32 @@ func (c *Client) DescribeCodeCoverages(ctx context.Context, params *DescribeCode type DescribeCodeCoveragesInput struct { - // The minimum line coverage percentage to report. - MinLineCoveragePercentage *float64 - - // The maximum number of results to return. - MaxResults *int32 - - // The maximum line coverage percentage to report. - MaxLineCoveragePercentage *float64 - // The ARN of the report for which test cases are returned. // // This member is required. ReportArn *string - // Specifies if the results are sorted in ascending or descending order. - SortOrder types.SortOrderType + // The maximum line coverage percentage to report. + MaxLineCoveragePercentage *float64 - // Specifies how the results are sorted. Possible values are: FILE_PATH The results - // are sorted by file path. LINE_COVERAGE_PERCENTAGE The results are sorted by the - // percentage of lines that are covered. - SortBy types.ReportCodeCoverageSortByType + // The maximum number of results to return. + MaxResults *int32 + + // The minimum line coverage percentage to report. + MinLineCoveragePercentage *float64 // The nextToken value returned from a previous call to DescribeCodeCoverages. This // specifies the next item to return. To return the beginning of the list, exclude // this parameter. NextToken *string + + // Specifies how the results are sorted. Possible values are: FILE_PATH The results + // are sorted by file path. LINE_COVERAGE_PERCENTAGE The results are sorted by the + // percentage of lines that are covered. + SortBy types.ReportCodeCoverageSortByType + + // Specifies if the results are sorted in ascending or descending order. + SortOrder types.SortOrderType } type DescribeCodeCoveragesOutput struct { diff --git a/service/codebuild/api_op_DescribeTestCases.go b/service/codebuild/api_op_DescribeTestCases.go index 6acd88af9d6..7c31253ba59 100644 --- a/service/codebuild/api_op_DescribeTestCases.go +++ b/service/codebuild/api_op_DescribeTestCases.go @@ -57,16 +57,19 @@ func (c *Client) DescribeTestCases(ctx context.Context, params *DescribeTestCase type DescribeTestCasesInput struct { - // The maximum number of paginated test cases returned per response. Use nextToken - // to iterate pages in the list of returned TestCase objects. The default value is - // 100. - MaxResults *int32 - // The ARN of the report for which test cases are returned. // // This member is required. ReportArn *string + // A TestCaseFilter object used to filter the returned reports. + Filter *types.TestCaseFilter + + // The maximum number of paginated test cases returned per response. Use nextToken + // to iterate pages in the list of returned TestCase objects. The default value is + // 100. + MaxResults *int32 + // During a previous call, the maximum number of items that can be returned is the // value specified in maxResults. If there more items in the list, then a unique // string called a nextToken is returned. To get the next batch of items in the @@ -74,9 +77,6 @@ type DescribeTestCasesInput struct { // of the items in the list, keep calling this operation with each subsequent next // token that is returned, until no more next tokens are returned. NextToken *string - - // A TestCaseFilter object used to filter the returned reports. - Filter *types.TestCaseFilter } type DescribeTestCasesOutput struct { diff --git a/service/codebuild/api_op_ImportSourceCredentials.go b/service/codebuild/api_op_ImportSourceCredentials.go index 23f88a7109d..b9b2d23fef9 100644 --- a/service/codebuild/api_op_ImportSourceCredentials.go +++ b/service/codebuild/api_op_ImportSourceCredentials.go @@ -58,31 +58,31 @@ func (c *Client) ImportSourceCredentials(ctx context.Context, params *ImportSour type ImportSourceCredentialsInput struct { + // The type of authentication used to connect to a GitHub, GitHub Enterprise, or + // Bitbucket repository. An OAUTH connection is not supported by the API and must + // be created using the AWS CodeBuild console. + // + // This member is required. + AuthType types.AuthType + // The source provider used for this project. // // This member is required. ServerType types.ServerType - // The Bitbucket username when the authType is BASIC_AUTH. This parameter is not - // valid for other types of source providers or connections. - Username *string - // For GitHub or GitHub Enterprise, this is the personal access token. For // Bitbucket, this is the app password. // // This member is required. Token *string - // The type of authentication used to connect to a GitHub, GitHub Enterprise, or - // Bitbucket repository. An OAUTH connection is not supported by the API and must - // be created using the AWS CodeBuild console. - // - // This member is required. - AuthType types.AuthType - // Set to false to prevent overwriting the repository source credentials. Set to // true to overwrite the repository source credentials. The default value is true. ShouldOverwrite *bool + + // The Bitbucket username when the authType is BASIC_AUTH. This parameter is not + // valid for other types of source providers or connections. + Username *string } type ImportSourceCredentialsOutput struct { diff --git a/service/codebuild/api_op_ListBuildBatches.go b/service/codebuild/api_op_ListBuildBatches.go index 7fc6e9c8d8a..5d0cb3f57d0 100644 --- a/service/codebuild/api_op_ListBuildBatches.go +++ b/service/codebuild/api_op_ListBuildBatches.go @@ -56,6 +56,17 @@ func (c *Client) ListBuildBatches(ctx context.Context, params *ListBuildBatchesI type ListBuildBatchesInput struct { + // A BuildBatchFilter object that specifies the filters for the search. + Filter *types.BuildBatchFilter + + // The maximum number of results to return. + MaxResults *int32 + + // The nextToken value returned from a previous call to ListBuildBatches. This + // specifies the next item to return. To return the beginning of the list, exclude + // this parameter. + NextToken *string + // Specifies the sort order of the returned items. Valid values include: // // * @@ -65,28 +76,17 @@ type ListBuildBatchesInput struct { // * DESCENDING: List the batch build identifiers in descending order by // identifier. SortOrder types.SortOrderType - - // The nextToken value returned from a previous call to ListBuildBatches. This - // specifies the next item to return. To return the beginning of the list, exclude - // this parameter. - NextToken *string - - // A BuildBatchFilter object that specifies the filters for the search. - Filter *types.BuildBatchFilter - - // The maximum number of results to return. - MaxResults *int32 } type ListBuildBatchesOutput struct { + // An array of strings that contains the batch build identifiers. + Ids []*string + // If there are more items to return, this contains a token that is passed to a // subsequent call to ListBuildBatches to retrieve the next set of items. NextToken *string - // An array of strings that contains the batch build identifiers. - Ids []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codebuild/api_op_ListBuildBatchesForProject.go b/service/codebuild/api_op_ListBuildBatchesForProject.go index faed5582d05..42625f3d865 100644 --- a/service/codebuild/api_op_ListBuildBatchesForProject.go +++ b/service/codebuild/api_op_ListBuildBatchesForProject.go @@ -56,11 +56,20 @@ func (c *Client) ListBuildBatchesForProject(ctx context.Context, params *ListBui type ListBuildBatchesForProjectInput struct { + // A BuildBatchFilter object that specifies the filters for the search. + Filter *types.BuildBatchFilter + + // The maximum number of results to return. + MaxResults *int32 + // The nextToken value returned from a previous call to ListBuildBatchesForProject. // This specifies the next item to return. To return the beginning of the list, // exclude this parameter. NextToken *string + // The name of the project. + ProjectName *string + // Specifies the sort order of the returned items. Valid values include: // // * @@ -70,15 +79,6 @@ type ListBuildBatchesForProjectInput struct { // * DESCENDING: List the batch build identifiers in descending order by // identifier. SortOrder types.SortOrderType - - // The maximum number of results to return. - MaxResults *int32 - - // A BuildBatchFilter object that specifies the filters for the search. - Filter *types.BuildBatchFilter - - // The name of the project. - ProjectName *string } type ListBuildBatchesForProjectOutput struct { diff --git a/service/codebuild/api_op_ListBuilds.go b/service/codebuild/api_op_ListBuilds.go index e4f6232b7b2..7053f0e706b 100644 --- a/service/codebuild/api_op_ListBuilds.go +++ b/service/codebuild/api_op_ListBuilds.go @@ -56,6 +56,14 @@ func (c *Client) ListBuilds(ctx context.Context, params *ListBuildsInput, optFns type ListBuildsInput struct { + // During a previous call, if there are more than 100 items in the list, only the + // first 100 items are returned, along with a unique string called a nextToken. To + // get the next batch of items in the list, call this operation again, adding the + // next token to the call. To get all of the items in the list, keep calling this + // operation with each subsequent next token that is returned, until no more next + // tokens are returned. + NextToken *string + // The order to list build IDs. Valid values include: // // * ASCENDING: List the @@ -64,14 +72,6 @@ type ListBuildsInput struct { // * DESCENDING: List the build IDs // in descending order by build ID. SortOrder types.SortOrderType - - // During a previous call, if there are more than 100 items in the list, only the - // first 100 items are returned, along with a unique string called a nextToken. To - // get the next batch of items in the list, call this operation again, adding the - // next token to the call. To get all of the items in the list, keep calling this - // operation with each subsequent next token that is returned, until no more next - // tokens are returned. - NextToken *string } type ListBuildsOutput struct { diff --git a/service/codebuild/api_op_ListBuildsForProject.go b/service/codebuild/api_op_ListBuildsForProject.go index 91d21d5d31c..39ba9bb69ff 100644 --- a/service/codebuild/api_op_ListBuildsForProject.go +++ b/service/codebuild/api_op_ListBuildsForProject.go @@ -58,14 +58,10 @@ func (c *Client) ListBuildsForProject(ctx context.Context, params *ListBuildsFor type ListBuildsForProjectInput struct { - // The order to list build IDs. Valid values include: - // - // * ASCENDING: List the - // build IDs in ascending order by build ID. + // The name of the AWS CodeBuild project. // - // * DESCENDING: List the build IDs - // in descending order by build ID. - SortOrder types.SortOrderType + // This member is required. + ProjectName *string // During a previous call, if there are more than 100 items in the list, only the // first 100 items are returned, along with a unique string called a nextToken. To @@ -75,24 +71,28 @@ type ListBuildsForProjectInput struct { // tokens are returned. NextToken *string - // The name of the AWS CodeBuild project. + // The order to list build IDs. Valid values include: // - // This member is required. - ProjectName *string + // * ASCENDING: List the + // build IDs in ascending order by build ID. + // + // * DESCENDING: List the build IDs + // in descending order by build ID. + SortOrder types.SortOrderType } type ListBuildsForProjectOutput struct { + // A list of build IDs for the specified build project, with each build ID + // representing a single build. + Ids []*string + // If there are more than 100 items in the list, only the first 100 items are // returned, along with a unique string called a nextToken. To get the next batch // of items in the list, call this operation again, adding the next token to the // call. NextToken *string - // A list of build IDs for the specified build project, with each build ID - // representing a single build. - Ids []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codebuild/api_op_ListProjects.go b/service/codebuild/api_op_ListProjects.go index fc25f6eb4e0..d6695a0eb37 100644 --- a/service/codebuild/api_op_ListProjects.go +++ b/service/codebuild/api_op_ListProjects.go @@ -57,6 +57,14 @@ func (c *Client) ListProjects(ctx context.Context, params *ListProjectsInput, op type ListProjectsInput struct { + // During a previous call, if there are more than 100 items in the list, only the + // first 100 items are returned, along with a unique string called a nextToken. To + // get the next batch of items in the list, call this operation again, adding the + // next token to the call. To get all of the items in the list, keep calling this + // operation with each subsequent next token that is returned, until no more next + // tokens are returned. + NextToken *string + // The criterion to be used to list build project names. Valid values include: // // @@ -73,14 +81,6 @@ type ListProjectsInput struct { // preceding criteria. SortBy types.ProjectSortByType - // During a previous call, if there are more than 100 items in the list, only the - // first 100 items are returned, along with a unique string called a nextToken. To - // get the next batch of items in the list, call this operation again, adding the - // next token to the call. To get all of the items in the list, keep calling this - // operation with each subsequent next token that is returned, until no more next - // tokens are returned. - NextToken *string - // The order in which to list build projects. Valid values include: // // * diff --git a/service/codebuild/api_op_ListReportGroups.go b/service/codebuild/api_op_ListReportGroups.go index 504f9b618d5..d57841a83c0 100644 --- a/service/codebuild/api_op_ListReportGroups.go +++ b/service/codebuild/api_op_ListReportGroups.go @@ -56,6 +56,11 @@ func (c *Client) ListReportGroups(ctx context.Context, params *ListReportGroupsI type ListReportGroupsInput struct { + // The maximum number of paginated report groups returned per response. Use + // nextToken to iterate pages in the list of returned ReportGroup objects. The + // default value is 100. + MaxResults *int32 + // During a previous call, the maximum number of items that can be returned is the // value specified in maxResults. If there more items in the list, then a unique // string called a nextToken is returned. To get the next batch of items in the @@ -76,11 +81,6 @@ type ListReportGroupsInput struct { // * NAME: List based on each report group's name. SortBy types.ReportGroupSortByType - // The maximum number of paginated report groups returned per response. Use - // nextToken to iterate pages in the list of returned ReportGroup objects. The - // default value is 100. - MaxResults *int32 - // Used to specify the order to sort the list of returned report groups. Valid // values are ASCENDING and DESCENDING. SortOrder types.SortOrderType @@ -88,9 +88,6 @@ type ListReportGroupsInput struct { type ListReportGroupsOutput struct { - // The list of ARNs for the report groups in the current AWS account. - ReportGroups []*string - // During a previous call, the maximum number of items that can be returned is the // value specified in maxResults. If there more items in the list, then a unique // string called a nextToken is returned. To get the next batch of items in the @@ -99,6 +96,9 @@ type ListReportGroupsOutput struct { // token that is returned, until no more next tokens are returned. NextToken *string + // The list of ARNs for the report groups in the current AWS account. + ReportGroups []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codebuild/api_op_ListReports.go b/service/codebuild/api_op_ListReports.go index 6b634e194c3..27aad533dbd 100644 --- a/service/codebuild/api_op_ListReports.go +++ b/service/codebuild/api_op_ListReports.go @@ -56,13 +56,13 @@ func (c *Client) ListReports(ctx context.Context, params *ListReportsInput, optF type ListReportsInput struct { + // A ReportFilter object used to filter the returned reports. + Filter *types.ReportFilter + // The maximum number of paginated reports returned per response. Use nextToken to // iterate pages in the list of returned Report objects. The default value is 100. MaxResults *int32 - // A ReportFilter object used to filter the returned reports. - Filter *types.ReportFilter - // During a previous call, the maximum number of items that can be returned is the // value specified in maxResults. If there more items in the list, then a unique // string called a nextToken is returned. To get the next batch of items in the @@ -84,9 +84,6 @@ type ListReportsInput struct { type ListReportsOutput struct { - // The list of returned ARNs for the reports in the current AWS account. - Reports []*string - // During a previous call, the maximum number of items that can be returned is the // value specified in maxResults. If there more items in the list, then a unique // string called a nextToken is returned. To get the next batch of items in the @@ -95,6 +92,9 @@ type ListReportsOutput struct { // token that is returned, until no more next tokens are returned. NextToken *string + // The list of returned ARNs for the reports in the current AWS account. + Reports []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codebuild/api_op_ListReportsForReportGroup.go b/service/codebuild/api_op_ListReportsForReportGroup.go index 29172e2d0f1..51cfca9126b 100644 --- a/service/codebuild/api_op_ListReportsForReportGroup.go +++ b/service/codebuild/api_op_ListReportsForReportGroup.go @@ -57,6 +57,19 @@ func (c *Client) ListReportsForReportGroup(ctx context.Context, params *ListRepo type ListReportsForReportGroupInput struct { + // The ARN of the report group for which you want to return report ARNs. + // + // This member is required. + ReportGroupArn *string + + // A ReportFilter object used to filter the returned reports. + Filter *types.ReportFilter + + // The maximum number of paginated reports in this report group returned per + // response. Use nextToken to iterate pages in the list of returned Report objects. + // The default value is 100. + MaxResults *int32 + // During a previous call, the maximum number of items that can be returned is the // value specified in maxResults. If there more items in the list, then a unique // string called a nextToken is returned. To get the next batch of items in the @@ -68,26 +81,10 @@ type ListReportsForReportGroupInput struct { // Use to specify whether the results are returned in ascending or descending // order. SortOrder types.SortOrderType - - // The maximum number of paginated reports in this report group returned per - // response. Use nextToken to iterate pages in the list of returned Report objects. - // The default value is 100. - MaxResults *int32 - - // The ARN of the report group for which you want to return report ARNs. - // - // This member is required. - ReportGroupArn *string - - // A ReportFilter object used to filter the returned reports. - Filter *types.ReportFilter } type ListReportsForReportGroupOutput struct { - // The list of report ARNs. - Reports []*string - // During a previous call, the maximum number of items that can be returned is the // value specified in maxResults. If there more items in the list, then a unique // string called a nextToken is returned. To get the next batch of items in the @@ -96,6 +93,9 @@ type ListReportsForReportGroupOutput struct { // token that is returned, until no more next tokens are returned. NextToken *string + // The list of report ARNs. + Reports []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codebuild/api_op_ListSharedProjects.go b/service/codebuild/api_op_ListSharedProjects.go index 0b7c7a2b4af..aed10539cdc 100644 --- a/service/codebuild/api_op_ListSharedProjects.go +++ b/service/codebuild/api_op_ListSharedProjects.go @@ -61,13 +61,13 @@ type ListSharedProjectsInput struct { // value is 100. MaxResults *int32 - // The order in which to list shared build projects. Valid values include: - // - // * - // ASCENDING: List in ascending order. - // - // * DESCENDING: List in descending order. - SortOrder types.SortOrderType + // During a previous call, the maximum number of items that can be returned is the + // value specified in maxResults. If there more items in the list, then a unique + // string called a nextToken is returned. To get the next batch of items in the + // list, call this operation again, adding the next token to the call. To get all + // of the items in the list, keep calling this operation with each subsequent next + // token that is returned, until no more next tokens are returned. + NextToken *string // The criterion to be used to list build projects shared with the current AWS // account or user. Valid values include: @@ -79,21 +79,17 @@ type ListSharedProjectsInput struct { // changed. SortBy types.SharedResourceSortByType - // During a previous call, the maximum number of items that can be returned is the - // value specified in maxResults. If there more items in the list, then a unique - // string called a nextToken is returned. To get the next batch of items in the - // list, call this operation again, adding the next token to the call. To get all - // of the items in the list, keep calling this operation with each subsequent next - // token that is returned, until no more next tokens are returned. - NextToken *string + // The order in which to list shared build projects. Valid values include: + // + // * + // ASCENDING: List in ascending order. + // + // * DESCENDING: List in descending order. + SortOrder types.SortOrderType } type ListSharedProjectsOutput struct { - // The list of ARNs for the build projects shared with the current AWS account or - // user. - Projects []*string - // During a previous call, the maximum number of items that can be returned is the // value specified in maxResults. If there more items in the list, then a unique // string called a nextToken is returned. To get the next batch of items in the @@ -102,6 +98,10 @@ type ListSharedProjectsOutput struct { // token that is returned, until no more next tokens are returned. NextToken *string + // The list of ARNs for the build projects shared with the current AWS account or + // user. + Projects []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codebuild/api_op_ListSharedReportGroups.go b/service/codebuild/api_op_ListSharedReportGroups.go index 3a1f7195016..327ba5e9d00 100644 --- a/service/codebuild/api_op_ListSharedReportGroups.go +++ b/service/codebuild/api_op_ListSharedReportGroups.go @@ -61,6 +61,14 @@ type ListSharedReportGroupsInput struct { // is 100. MaxResults *int32 + // During a previous call, the maximum number of items that can be returned is the + // value specified in maxResults. If there more items in the list, then a unique + // string called a nextToken is returned. To get the next batch of items in the + // list, call this operation again, adding the next token to the call. To get all + // of the items in the list, keep calling this operation with each subsequent next + // token that is returned, until no more next tokens are returned. + NextToken *string + // The criterion to be used to list report groups shared with the current AWS // account or user. Valid values include: // @@ -78,6 +86,9 @@ type ListSharedReportGroupsInput struct { // // * DESCENDING: List in descending order. SortOrder types.SortOrderType +} + +type ListSharedReportGroupsOutput struct { // During a previous call, the maximum number of items that can be returned is the // value specified in maxResults. If there more items in the list, then a unique @@ -86,22 +97,11 @@ type ListSharedReportGroupsInput struct { // of the items in the list, keep calling this operation with each subsequent next // token that is returned, until no more next tokens are returned. NextToken *string -} - -type ListSharedReportGroupsOutput struct { // The list of ARNs for the report groups shared with the current AWS account or // user. ReportGroups []*string - // During a previous call, the maximum number of items that can be returned is the - // value specified in maxResults. If there more items in the list, then a unique - // string called a nextToken is returned. To get the next batch of items in the - // list, call this operation again, adding the next token to the call. To get all - // of the items in the list, keep calling this operation with each subsequent next - // token that is returned, until no more next tokens are returned. - NextToken *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codebuild/api_op_PutResourcePolicy.go b/service/codebuild/api_op_PutResourcePolicy.go index 5fa37b71823..bf5a94ca8ab 100644 --- a/service/codebuild/api_op_PutResourcePolicy.go +++ b/service/codebuild/api_op_PutResourcePolicy.go @@ -56,12 +56,6 @@ func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolic type PutResourcePolicyInput struct { - // The ARN of the Project or ReportGroup resource you want to associate with a - // resource policy. - // - // This member is required. - ResourceArn *string - // A JSON-formatted resource policy. For more information, see Sharing a Project // (https://docs.aws.amazon.com/codebuild/latest/userguide/project-sharing.html#project-sharing-share) // and Sharing a Report Group @@ -70,6 +64,12 @@ type PutResourcePolicyInput struct { // // This member is required. Policy *string + + // The ARN of the Project or ReportGroup resource you want to associate with a + // resource policy. + // + // This member is required. + ResourceArn *string } type PutResourcePolicyOutput struct { diff --git a/service/codebuild/api_op_RetryBuildBatch.go b/service/codebuild/api_op_RetryBuildBatch.go index deff0fdc3ea..c926512560d 100644 --- a/service/codebuild/api_op_RetryBuildBatch.go +++ b/service/codebuild/api_op_RetryBuildBatch.go @@ -56,6 +56,9 @@ func (c *Client) RetryBuildBatch(ctx context.Context, params *RetryBuildBatchInp type RetryBuildBatchInput struct { + // Specifies the identifier of the batch build to restart. + Id *string + // A unique, case sensitive identifier you provide to ensure the idempotency of the // RetryBuildBatch request. The token is included in the RetryBuildBatch request // and is valid for five minutes. If you repeat the RetryBuildBatch request with @@ -65,9 +68,6 @@ type RetryBuildBatchInput struct { // Specifies the type of retry to perform. RetryType types.RetryBuildBatchType - - // Specifies the identifier of the batch build to restart. - Id *string } type RetryBuildBatchOutput struct { diff --git a/service/codebuild/api_op_StartBuild.go b/service/codebuild/api_op_StartBuild.go index e489f185030..e6e1be2c073 100644 --- a/service/codebuild/api_op_StartBuild.go +++ b/service/codebuild/api_op_StartBuild.go @@ -57,82 +57,19 @@ func (c *Client) StartBuild(ctx context.Context, params *StartBuildInput, optFns type StartBuildInput struct { - // Log settings for this build that override the log settings defined in the build - // project. - LogsConfigOverride *types.LogsConfig - - // The number of minutes a build is allowed to be queued before it times out. - QueuedTimeoutInMinutesOverride *int32 - - // Set to true to report to your source provider the status of a build's start and - // completion. If you use this option with a source provider other than GitHub, - // GitHub Enterprise, or Bitbucket, an invalidInputException is thrown. The status - // of a build triggered by a webhook is always reported to your source provider. - ReportBuildStatusOverride *bool - - // The version of the build input to be built, for this build only. If not - // specified, the latest version is used. If specified, the contents depends on the - // source provider: AWS CodeCommit The commit ID, branch, or Git tag to use. GitHub - // The commit ID, pull request ID, branch name, or tag name that corresponds to the - // version of the source code you want to build. If a pull request ID is specified, - // it must use the format pr/pull-request-ID (for example pr/25). If a branch name - // is specified, the branch's HEAD commit ID is used. If not specified, the default - // branch's HEAD commit ID is used. Bitbucket The commit ID, branch name, or tag - // name that corresponds to the version of the source code you want to build. If a - // branch name is specified, the branch's HEAD commit ID is used. If not specified, - // the default branch's HEAD commit ID is used. Amazon Simple Storage Service - // (Amazon S3) The version ID of the object that represents the build input ZIP - // file to use. If sourceVersion is specified at the project level, then this - // sourceVersion (at the build level) takes precedence. For more information, see - // Source Version Sample with CodeBuild - // (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) - // in the AWS CodeBuild User Guide. - SourceVersion *string - - // The AWS Key Management Service (AWS KMS) customer master key (CMK) that - // overrides the one specified in the build project. The CMK key encrypts the build - // output artifacts. You can use a cross-account KMS key to encrypt the build - // output artifacts if your service role has permission to that key. You can - // specify either the Amazon Resource Name (ARN) of the CMK or, if available, the - // CMK's alias (using the format alias/alias-name ). - EncryptionKeyOverride *string - - // Build output artifact settings that override, for this build only, the latest - // ones already defined in the build project. - ArtifactsOverride *types.ProjectArtifacts - - // The user-defined depth of history, with a minimum value of 0, that overrides, - // for this build only, any previous depth of history defined in the build project. - GitCloneDepthOverride *int32 - - // An array of ProjectArtifacts objects. - SecondaryArtifactsOverride []*types.ProjectArtifacts - // The name of the AWS CodeBuild build project to start running a build. // // This member is required. ProjectName *string - // An array of ProjectSourceVersion objects that specify one or more versions of - // the project's secondary sources to be used for this build only. - SecondarySourcesVersionOverride []*types.ProjectSourceVersion - - // Enable this flag to override the insecure SSL setting that is specified in the - // build project. The insecure SSL setting determines whether to ignore SSL - // warnings while connecting to the project source code. This override applies only - // if the build's source is GitHub Enterprise. - InsecureSslOverride *bool - - // The credentials for access to a private registry. - RegistryCredentialOverride *types.RegistryCredential - - // An authorization type for this build that overrides the one defined in the build - // project. This override applies only if the build project's source is BitBucket - // or GitHub. - SourceAuthOverride *types.SourceAuth + // Build output artifact settings that override, for this build only, the latest + // ones already defined in the build project. + ArtifactsOverride *types.ProjectArtifacts - // An array of ProjectSource objects. - SecondarySourcesOverride []*types.ProjectSource + // Contains information that defines how the build project reports the build status + // to the source provider. This option is only used when the source provider is + // GITHUB, GITHUB_ENTERPRISE, or BITBUCKET. + BuildStatusConfigOverride *types.BuildStatusConfig // A buildspec file declaration that overrides, for this build only, the latest one // already defined in the build project. If this value is set, it can be either an @@ -147,40 +84,57 @@ type StartBuildInput struct { // (https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage). BuildspecOverride *string - // Information about the Git submodules configuration for this build of an AWS - // CodeBuild build project. - GitSubmodulesConfigOverride *types.GitSubmodulesConfig - - // A unique, case sensitive identifier you provide to ensure the idempotency of the - // StartBuild request. The token is included in the StartBuild request and is valid - // for 5 minutes. If you repeat the StartBuild request with the same token, but - // change a parameter, AWS CodeBuild returns a parameter mismatch error. - IdempotencyToken *string - - // Enable this flag to override privileged mode in the build project. - PrivilegedModeOverride *bool - // A ProjectCache object specified for this build that overrides the one defined in // the build project. CacheOverride *types.ProjectCache + // The name of a certificate for this build that overrides the one specified in the + // build project. + CertificateOverride *string + // The name of a compute type for this build that overrides the one specified in // the build project. ComputeTypeOverride types.ComputeType - // The name of an image for this build that overrides the one specified in the - // build project. - ImageOverride *string - // Specifies if session debugging is enabled for this build. For more information, // see Viewing a running build in Session Manager // (https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html). DebugSessionEnabled *bool + // The AWS Key Management Service (AWS KMS) customer master key (CMK) that + // overrides the one specified in the build project. The CMK key encrypts the build + // output artifacts. You can use a cross-account KMS key to encrypt the build + // output artifacts if your service role has permission to that key. You can + // specify either the Amazon Resource Name (ARN) of the CMK or, if available, the + // CMK's alias (using the format alias/alias-name ). + EncryptionKeyOverride *string + // A container type for this build that overrides the one specified in the build // project. EnvironmentTypeOverride types.EnvironmentType + // A set of environment variables that overrides, for this build only, the latest + // ones already defined in the build project. + EnvironmentVariablesOverride []*types.EnvironmentVariable + + // The user-defined depth of history, with a minimum value of 0, that overrides, + // for this build only, any previous depth of history defined in the build project. + GitCloneDepthOverride *int32 + + // Information about the Git submodules configuration for this build of an AWS + // CodeBuild build project. + GitSubmodulesConfigOverride *types.GitSubmodulesConfig + + // A unique, case sensitive identifier you provide to ensure the idempotency of the + // StartBuild request. The token is included in the StartBuild request and is valid + // for 5 minutes. If you repeat the StartBuild request with the same token, but + // change a parameter, AWS CodeBuild returns a parameter mismatch error. + IdempotencyToken *string + + // The name of an image for this build that overrides the one specified in the + // build project. + ImageOverride *string + // The type of credentials AWS CodeBuild uses to pull images in your build. There // are two valid values: CODEBUILD Specifies that AWS CodeBuild uses its own // credentials. This requires that you modify your ECR repository policy to trust @@ -190,34 +144,80 @@ type StartBuildInput struct { // CodeBuild curated image, you must use CODEBUILD credentials. ImagePullCredentialsTypeOverride types.ImagePullCredentialsType - // The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, - // for this build only, the latest setting already defined in the build project. - TimeoutInMinutesOverride *int32 + // Enable this flag to override the insecure SSL setting that is specified in the + // build project. The insecure SSL setting determines whether to ignore SSL + // warnings while connecting to the project source code. This override applies only + // if the build's source is GitHub Enterprise. + InsecureSslOverride *bool + + // Log settings for this build that override the log settings defined in the build + // project. + LogsConfigOverride *types.LogsConfig + + // Enable this flag to override privileged mode in the build project. + PrivilegedModeOverride *bool + + // The number of minutes a build is allowed to be queued before it times out. + QueuedTimeoutInMinutesOverride *int32 + + // The credentials for access to a private registry. + RegistryCredentialOverride *types.RegistryCredential + + // Set to true to report to your source provider the status of a build's start and + // completion. If you use this option with a source provider other than GitHub, + // GitHub Enterprise, or Bitbucket, an invalidInputException is thrown. The status + // of a build triggered by a webhook is always reported to your source provider. + ReportBuildStatusOverride *bool + + // An array of ProjectArtifacts objects. + SecondaryArtifactsOverride []*types.ProjectArtifacts + + // An array of ProjectSource objects. + SecondarySourcesOverride []*types.ProjectSource + + // An array of ProjectSourceVersion objects that specify one or more versions of + // the project's secondary sources to be used for this build only. + SecondarySourcesVersionOverride []*types.ProjectSourceVersion // The name of a service role for this build that overrides the one specified in // the build project. ServiceRoleOverride *string - // Contains information that defines how the build project reports the build status - // to the source provider. This option is only used when the source provider is - // GITHUB, GITHUB_ENTERPRISE, or BITBUCKET. - BuildStatusConfigOverride *types.BuildStatusConfig + // An authorization type for this build that overrides the one defined in the build + // project. This override applies only if the build project's source is BitBucket + // or GitHub. + SourceAuthOverride *types.SourceAuth - // The name of a certificate for this build that overrides the one specified in the - // build project. - CertificateOverride *string + // A location that overrides, for this build, the source location for the one + // defined in the build project. + SourceLocationOverride *string // A source input type, for this build, that overrides the source input defined in // the build project. SourceTypeOverride types.SourceType - // A set of environment variables that overrides, for this build only, the latest - // ones already defined in the build project. - EnvironmentVariablesOverride []*types.EnvironmentVariable + // The version of the build input to be built, for this build only. If not + // specified, the latest version is used. If specified, the contents depends on the + // source provider: AWS CodeCommit The commit ID, branch, or Git tag to use. GitHub + // The commit ID, pull request ID, branch name, or tag name that corresponds to the + // version of the source code you want to build. If a pull request ID is specified, + // it must use the format pr/pull-request-ID (for example pr/25). If a branch name + // is specified, the branch's HEAD commit ID is used. If not specified, the default + // branch's HEAD commit ID is used. Bitbucket The commit ID, branch name, or tag + // name that corresponds to the version of the source code you want to build. If a + // branch name is specified, the branch's HEAD commit ID is used. If not specified, + // the default branch's HEAD commit ID is used. Amazon Simple Storage Service + // (Amazon S3) The version ID of the object that represents the build input ZIP + // file to use. If sourceVersion is specified at the project level, then this + // sourceVersion (at the build level) takes precedence. For more information, see + // Source Version Sample with CodeBuild + // (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) + // in the AWS CodeBuild User Guide. + SourceVersion *string - // A location that overrides, for this build, the source location for the one - // defined in the build project. - SourceLocationOverride *string + // The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, + // for this build only, the latest setting already defined in the build project. + TimeoutInMinutesOverride *int32 } type StartBuildOutput struct { diff --git a/service/codebuild/api_op_StartBuildBatch.go b/service/codebuild/api_op_StartBuildBatch.go index 796ddea942c..421fbd1ef9f 100644 --- a/service/codebuild/api_op_StartBuildBatch.go +++ b/service/codebuild/api_op_StartBuildBatch.go @@ -57,17 +57,21 @@ func (c *Client) StartBuildBatch(ctx context.Context, params *StartBuildBatchInp type StartBuildBatchInput struct { - // The AWS Key Management Service (AWS KMS) customer master key (CMK) that - // overrides the one specified in the batch build project. The CMK key encrypts the - // build output artifacts. You can use a cross-account KMS key to encrypt the build - // output artifacts if your service role has permission to that key. You can - // specify either the Amazon Resource Name (ARN) of the CMK or, if available, the - // CMK's alias (using the format alias/alias-name ). - EncryptionKeyOverride *string + // The name of the project. + // + // This member is required. + ProjectName *string - // The name of a certificate for this batch build that overrides the one specified - // in the batch build project. - CertificateOverride *string + // An array of ProjectArtifacts objects that contains information about the build + // output artifact overrides for the build project. + ArtifactsOverride *types.ProjectArtifacts + + // A BuildBatchConfigOverride object that contains batch build configuration + // overrides. + BuildBatchConfigOverride *types.ProjectBuildBatchConfig + + // Overrides the build timeout specified in the batch build project. + BuildTimeoutInMinutesOverride *int32 // A buildspec file declaration that overrides, for this build only, the latest one // already defined in the build project. If this value is set, it can be either an @@ -82,28 +86,41 @@ type StartBuildBatchInput struct { // (https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage). BuildspecOverride *string - // The version of the batch build input to be built, for this build only. If not - // specified, the latest version is used. If specified, the contents depends on the - // source provider: AWS CodeCommit The commit ID, branch, or Git tag to use. GitHub - // The commit ID, pull request ID, branch name, or tag name that corresponds to the - // version of the source code you want to build. If a pull request ID is specified, - // it must use the format pr/pull-request-ID (for example pr/25). If a branch name - // is specified, the branch's HEAD commit ID is used. If not specified, the default - // branch's HEAD commit ID is used. Bitbucket The commit ID, branch name, or tag - // name that corresponds to the version of the source code you want to build. If a - // branch name is specified, the branch's HEAD commit ID is used. If not specified, - // the default branch's HEAD commit ID is used. Amazon Simple Storage Service - // (Amazon S3) The version ID of the object that represents the build input ZIP - // file to use. If sourceVersion is specified at the project level, then this - // sourceVersion (at the build level) takes precedence. For more information, see - // Source Version Sample with CodeBuild - // (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) - // in the AWS CodeBuild User Guide. - SourceVersion *string + // A ProjectCache object that specifies cache overrides. + CacheOverride *types.ProjectCache - // An array of ProjectArtifacts objects that contains information about the build - // output artifact overrides for the build project. - ArtifactsOverride *types.ProjectArtifacts + // The name of a certificate for this batch build that overrides the one specified + // in the batch build project. + CertificateOverride *string + + // The name of a compute type for this batch build that overrides the one specified + // in the batch build project. + ComputeTypeOverride types.ComputeType + + // The AWS Key Management Service (AWS KMS) customer master key (CMK) that + // overrides the one specified in the batch build project. The CMK key encrypts the + // build output artifacts. You can use a cross-account KMS key to encrypt the build + // output artifacts if your service role has permission to that key. You can + // specify either the Amazon Resource Name (ARN) of the CMK or, if available, the + // CMK's alias (using the format alias/alias-name ). + EncryptionKeyOverride *string + + // A container type for this batch build that overrides the one specified in the + // batch build project. + EnvironmentTypeOverride types.EnvironmentType + + // An array of EnvironmentVariable objects that override, or add to, the + // environment variables defined in the batch build project. + EnvironmentVariablesOverride []*types.EnvironmentVariable + + // The user-defined depth of history, with a minimum value of 0, that overrides, + // for this batch build only, any previous depth of history defined in the batch + // build project. + GitCloneDepthOverride *int32 + + // A GitSubmodulesConfig object that overrides the Git submodules configuration for + // this batch build. + GitSubmodulesConfigOverride *types.GitSubmodulesConfig // A unique, case sensitive identifier you provide to ensure the idempotency of the // StartBuildBatch request. The token is included in the StartBuildBatch request @@ -112,16 +129,18 @@ type StartBuildBatchInput struct { // mismatch error. IdempotencyToken *string - // Set to true to report to your source provider the status of a batch build's - // start and completion. If you use this option with a source provider other than - // GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown. The - // status of a build triggered by a webhook is always reported to your source - // provider. - ReportBuildBatchStatusOverride *bool + // The name of an image for this batch build that overrides the one specified in + // the batch build project. + ImageOverride *string - // An array of ProjectArtifacts objects that override the secondary artifacts - // defined in the batch build project. - SecondaryArtifactsOverride []*types.ProjectArtifacts + // The type of credentials AWS CodeBuild uses to pull images in your batch build. + // There are two valid values: CODEBUILD Specifies that AWS CodeBuild uses its own + // credentials. This requires that you modify your ECR repository policy to trust + // AWS CodeBuild's service principal. SERVICE_ROLE Specifies that AWS CodeBuild + // uses your build project's service role. When using a cross-account or private + // registry image, you must use SERVICE_ROLE credentials. When using an AWS + // CodeBuild curated image, you must use CODEBUILD credentials. + ImagePullCredentialsTypeOverride types.ImagePullCredentialsType // Enable this flag to override the insecure SSL setting that is specified in the // batch build project. The insecure SSL setting determines whether to ignore SSL @@ -129,92 +148,73 @@ type StartBuildBatchInput struct { // if the build's source is GitHub Enterprise. InsecureSslOverride *bool - // A GitSubmodulesConfig object that overrides the Git submodules configuration for - // this batch build. - GitSubmodulesConfigOverride *types.GitSubmodulesConfig - - // A BuildBatchConfigOverride object that contains batch build configuration - // overrides. - BuildBatchConfigOverride *types.ProjectBuildBatchConfig - - // An array of ProjectSourceVersion objects that override the secondary source - // versions in the batch build project. - SecondarySourcesVersionOverride []*types.ProjectSourceVersion - - // An array of ProjectSource objects that override the secondary sources defined in - // the batch build project. - SecondarySourcesOverride []*types.ProjectSource - - // The user-defined depth of history, with a minimum value of 0, that overrides, - // for this batch build only, any previous depth of history defined in the batch - // build project. - GitCloneDepthOverride *int32 + // A LogsConfig object that override the log settings defined in the batch build + // project. + LogsConfigOverride *types.LogsConfig - // The name of the project. - // - // This member is required. - ProjectName *string + // Enable this flag to override privileged mode in the batch build project. + PrivilegedModeOverride *bool - // A SourceAuth object that overrides the one defined in the batch build project. - // This override applies only if the build project's source is BitBucket or GitHub. - SourceAuthOverride *types.SourceAuth + // The number of minutes a batch build is allowed to be queued before it times out. + QueuedTimeoutInMinutesOverride *int32 // A RegistryCredential object that overrides credentials for access to a private // registry. RegistryCredentialOverride *types.RegistryCredential - // Overrides the build timeout specified in the batch build project. - BuildTimeoutInMinutesOverride *int32 - - // A container type for this batch build that overrides the one specified in the - // batch build project. - EnvironmentTypeOverride types.EnvironmentType - - // The name of a compute type for this batch build that overrides the one specified - // in the batch build project. - ComputeTypeOverride types.ComputeType + // Set to true to report to your source provider the status of a batch build's + // start and completion. If you use this option with a source provider other than + // GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown. The + // status of a build triggered by a webhook is always reported to your source + // provider. + ReportBuildBatchStatusOverride *bool - // Enable this flag to override privileged mode in the batch build project. - PrivilegedModeOverride *bool + // An array of ProjectArtifacts objects that override the secondary artifacts + // defined in the batch build project. + SecondaryArtifactsOverride []*types.ProjectArtifacts - // The name of an image for this batch build that overrides the one specified in + // An array of ProjectSource objects that override the secondary sources defined in // the batch build project. - ImageOverride *string + SecondarySourcesOverride []*types.ProjectSource + + // An array of ProjectSourceVersion objects that override the secondary source + // versions in the batch build project. + SecondarySourcesVersionOverride []*types.ProjectSourceVersion // The name of a service role for this batch build that overrides the one specified // in the batch build project. ServiceRoleOverride *string - // A ProjectCache object that specifies cache overrides. - CacheOverride *types.ProjectCache - - // The type of credentials AWS CodeBuild uses to pull images in your batch build. - // There are two valid values: CODEBUILD Specifies that AWS CodeBuild uses its own - // credentials. This requires that you modify your ECR repository policy to trust - // AWS CodeBuild's service principal. SERVICE_ROLE Specifies that AWS CodeBuild - // uses your build project's service role. When using a cross-account or private - // registry image, you must use SERVICE_ROLE credentials. When using an AWS - // CodeBuild curated image, you must use CODEBUILD credentials. - ImagePullCredentialsTypeOverride types.ImagePullCredentialsType - - // The number of minutes a batch build is allowed to be queued before it times out. - QueuedTimeoutInMinutesOverride *int32 + // A SourceAuth object that overrides the one defined in the batch build project. + // This override applies only if the build project's source is BitBucket or GitHub. + SourceAuthOverride *types.SourceAuth // A location that overrides, for this batch build, the source location defined in // the batch build project. SourceLocationOverride *string - // A LogsConfig object that override the log settings defined in the batch build - // project. - LogsConfigOverride *types.LogsConfig - // The source input type that overrides the source input defined in the batch build // project. SourceTypeOverride types.SourceType - // An array of EnvironmentVariable objects that override, or add to, the - // environment variables defined in the batch build project. - EnvironmentVariablesOverride []*types.EnvironmentVariable + // The version of the batch build input to be built, for this build only. If not + // specified, the latest version is used. If specified, the contents depends on the + // source provider: AWS CodeCommit The commit ID, branch, or Git tag to use. GitHub + // The commit ID, pull request ID, branch name, or tag name that corresponds to the + // version of the source code you want to build. If a pull request ID is specified, + // it must use the format pr/pull-request-ID (for example pr/25). If a branch name + // is specified, the branch's HEAD commit ID is used. If not specified, the default + // branch's HEAD commit ID is used. Bitbucket The commit ID, branch name, or tag + // name that corresponds to the version of the source code you want to build. If a + // branch name is specified, the branch's HEAD commit ID is used. If not specified, + // the default branch's HEAD commit ID is used. Amazon Simple Storage Service + // (Amazon S3) The version ID of the object that represents the build input ZIP + // file to use. If sourceVersion is specified at the project level, then this + // sourceVersion (at the build level) takes precedence. For more information, see + // Source Version Sample with CodeBuild + // (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) + // in the AWS CodeBuild User Guide. + SourceVersion *string } type StartBuildBatchOutput struct { diff --git a/service/codebuild/api_op_UpdateProject.go b/service/codebuild/api_op_UpdateProject.go index 42a90b679ec..08cb1e24036 100644 --- a/service/codebuild/api_op_UpdateProject.go +++ b/service/codebuild/api_op_UpdateProject.go @@ -57,6 +57,29 @@ func (c *Client) UpdateProject(ctx context.Context, params *UpdateProjectInput, type UpdateProjectInput struct { + // The name of the build project. You cannot change a build project's name. + // + // This member is required. + Name *string + + // Information to be changed about the build output artifacts for the build + // project. + Artifacts *types.ProjectArtifacts + + // Set this to true to generate a publicly accessible URL for your project's build + // badge. + BadgeEnabled *bool + + // Contains configuration information about a batch build project. + BuildBatchConfig *types.ProjectBuildBatchConfig + + // Stores recently used information so that it can be quickly accessed at a later + // time. + Cache *types.ProjectCache + + // A new or replacement description of the build project. + Description *string + // The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used // for encrypting the build output artifacts. You can use a cross-account KMS key // to encrypt the build output artifacts if your service role has permission to @@ -64,6 +87,42 @@ type UpdateProjectInput struct { // if available, the CMK's alias (using the format alias/alias-name ). EncryptionKey *string + // Information to be changed about the build environment for the build project. + Environment *types.ProjectEnvironment + + // An array of ProjectFileSystemLocation objects for a CodeBuild build project. A + // ProjectFileSystemLocation object specifies the identifier, location, + // mountOptions, mountPoint, and type of a file system created using Amazon Elastic + // File System. + FileSystemLocations []*types.ProjectFileSystemLocation + + // Information about logs for the build project. A project can create logs in + // Amazon CloudWatch Logs, logs in an S3 bucket, or both. + LogsConfig *types.LogsConfig + + // The number of minutes a build is allowed to be queued before it times out. + QueuedTimeoutInMinutes *int32 + + // An array of ProjectSource objects. + SecondaryArtifacts []*types.ProjectArtifacts + + // An array of ProjectSourceVersion objects. If secondarySourceVersions is + // specified at the build level, then they take over these secondarySourceVersions + // (at the project level). + SecondarySourceVersions []*types.ProjectSourceVersion + + // An array of ProjectSource objects. + SecondarySources []*types.ProjectSource + + // The replacement ARN of the AWS Identity and Access Management (IAM) role that + // enables AWS CodeBuild to interact with dependent AWS services on behalf of the + // AWS account. + ServiceRole *string + + // Information to be changed about the build input source code for the build + // project. + Source *types.ProjectSource + // A version of the build input to be built for this project. If not specified, the // latest version is used. If specified, it must be one of: // @@ -93,34 +152,6 @@ type UpdateProjectInput struct { // in the AWS CodeBuild User Guide. SourceVersion *string - // An array of ProjectSourceVersion objects. If secondarySourceVersions is - // specified at the build level, then they take over these secondarySourceVersions - // (at the project level). - SecondarySourceVersions []*types.ProjectSourceVersion - - // A new or replacement description of the build project. - Description *string - - // Stores recently used information so that it can be quickly accessed at a later - // time. - Cache *types.ProjectCache - - // An array of ProjectSource objects. - SecondarySources []*types.ProjectSource - - // Information to be changed about the build input source code for the build - // project. - Source *types.ProjectSource - - // An array of ProjectFileSystemLocation objects for a CodeBuild build project. A - // ProjectFileSystemLocation object specifies the identifier, location, - // mountOptions, mountPoint, and type of a file system created using Amazon Elastic - // File System. - FileSystemLocations []*types.ProjectFileSystemLocation - - // An array of ProjectSource objects. - SecondaryArtifacts []*types.ProjectArtifacts - // An updated list of tag key and value pairs associated with this build project. // These tags are available for use by AWS services that support AWS CodeBuild // build project tags. @@ -130,39 +161,8 @@ type UpdateProjectInput struct { // wait before timing out any related build that did not get marked as completed. TimeoutInMinutes *int32 - // The number of minutes a build is allowed to be queued before it times out. - QueuedTimeoutInMinutes *int32 - - // Information to be changed about the build environment for the build project. - Environment *types.ProjectEnvironment - // VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC. VpcConfig *types.VpcConfig - - // The replacement ARN of the AWS Identity and Access Management (IAM) role that - // enables AWS CodeBuild to interact with dependent AWS services on behalf of the - // AWS account. - ServiceRole *string - - // Information about logs for the build project. A project can create logs in - // Amazon CloudWatch Logs, logs in an S3 bucket, or both. - LogsConfig *types.LogsConfig - - // Contains configuration information about a batch build project. - BuildBatchConfig *types.ProjectBuildBatchConfig - - // Information to be changed about the build output artifacts for the build - // project. - Artifacts *types.ProjectArtifacts - - // The name of the build project. You cannot change a build project's name. - // - // This member is required. - Name *string - - // Set this to true to generate a publicly accessible URL for your project's build - // badge. - BadgeEnabled *bool } type UpdateProjectOutput struct { diff --git a/service/codebuild/api_op_UpdateReportGroup.go b/service/codebuild/api_op_UpdateReportGroup.go index ffd9f85e53f..14b7e12f9dd 100644 --- a/service/codebuild/api_op_UpdateReportGroup.go +++ b/service/codebuild/api_op_UpdateReportGroup.go @@ -57,6 +57,11 @@ func (c *Client) UpdateReportGroup(ctx context.Context, params *UpdateReportGrou type UpdateReportGroupInput struct { + // The ARN of the report group to update. + // + // This member is required. + Arn *string + // Used to specify an updated export type. Valid values are: // // * S3: The report @@ -70,11 +75,6 @@ type UpdateReportGroupInput struct { // These tags are available for use by AWS services that support AWS CodeBuild // report group tags. Tags []*types.Tag - - // The ARN of the report group to update. - // - // This member is required. - Arn *string } type UpdateReportGroupOutput struct { diff --git a/service/codebuild/api_op_UpdateWebhook.go b/service/codebuild/api_op_UpdateWebhook.go index 7984e0ad43b..ed25267978a 100644 --- a/service/codebuild/api_op_UpdateWebhook.go +++ b/service/codebuild/api_op_UpdateWebhook.go @@ -58,11 +58,6 @@ func (c *Client) UpdateWebhook(ctx context.Context, params *UpdateWebhookInput, type UpdateWebhookInput struct { - // A boolean value that specifies whether the associated GitHub repository's secret - // token should be updated. If you use Bitbucket for your repository, rotateSecret - // is ignored. - RotateSecret *bool - // The name of the AWS CodeBuild project. // // This member is required. @@ -81,6 +76,11 @@ type UpdateWebhookInput struct { // can trigger a build. A filter group must contain at least one // EVENTWebhookFilter. FilterGroups [][]*types.WebhookFilter + + // A boolean value that specifies whether the associated GitHub repository's secret + // token should be updated. If you use Bitbucket for your repository, rotateSecret + // is ignored. + RotateSecret *bool } type UpdateWebhookOutput struct { diff --git a/service/codebuild/go.mod b/service/codebuild/go.mod index 02c52481a6d..3135f8dc070 100644 --- a/service/codebuild/go.mod +++ b/service/codebuild/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/codebuild go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/codebuild/types/types.go b/service/codebuild/types/types.go index e280d5eeca7..5c4eadffcf4 100644 --- a/service/codebuild/types/types.go +++ b/service/codebuild/types/types.go @@ -9,43 +9,30 @@ import ( // Specifies restrictions for the batch build. type BatchRestrictions struct { - // Specifies the maximum number of builds allowed. - MaximumBuildsAllowed *int32 - // An array of strings that specify the compute types that are allowed for the // batch build. See Build environment compute types // (https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html) // in the AWS CodeBuild User Guide for these values. ComputeTypesAllowed []*string + + // Specifies the maximum number of builds allowed. + MaximumBuildsAllowed *int32 } // Information about a build. type Build struct { - // Information about the build's logs in Amazon CloudWatch Logs. - Logs *LogsLocation - - // An array of ProjectFileSystemLocation objects for a CodeBuild build project. A - // ProjectFileSystemLocation object specifies the identifier, location, - // mountOptions, mountPoint, and type of a file system created using Amazon Elastic - // File System. - FileSystemLocations []*ProjectFileSystemLocation - - // When the build process started, expressed in Unix time format. - StartTime *time.Time + // The Amazon Resource Name (ARN) of the build. + Arn *string - // The name of a service role used for this build. - ServiceRole *string + // Information about the output artifacts for the build. + Artifacts *BuildArtifacts - // The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used - // for encrypting the build output artifacts. You can use a cross-account KMS key - // to encrypt the build output artifacts if your service role has permission to - // that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, - // if available, the CMK's alias (using the format alias/alias-name ). - EncryptionKey *string + // The ARN of the batch build that this build is a member of, if applicable. + BuildBatchArn *string - // Information about the build environment for this build. - Environment *ProjectEnvironment + // Whether the build is complete. True if complete; otherwise, false. + BuildComplete *bool // The number of the build. For each project, the buildNumber of its first build is // 1. The buildNumber of each subsequent build is incremented by 1. If a build is @@ -70,48 +57,72 @@ type Build struct { // * TIMED_OUT: The build timed out. BuildStatus StatusType - // The name of the AWS CodeBuild project. - ProjectName *string - - // Whether the build is complete. True if complete; otherwise, false. - BuildComplete *bool - - // If your AWS CodeBuild project accesses resources in an Amazon VPC, you provide - // this parameter that identifies the VPC ID and the list of security group IDs and - // subnet IDs. The security groups and subnets must belong to the same VPC. You - // must provide at least one security group and one subnet ID. - VpcConfig *VpcConfig + // Information about the cache for the build. + Cache *ProjectCache // The current build phase. CurrentPhase *string - // Describes a network interface. - NetworkInterface *NetworkInterface + // Contains information about the debug session for this build. + DebugSession *DebugSession + + // The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used + // for encrypting the build output artifacts. You can use a cross-account KMS key + // to encrypt the build output artifacts if your service role has permission to + // that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, + // if available, the CMK's alias (using the format alias/alias-name ). + EncryptionKey *string // When the build process ended, expressed in Unix time format. EndTime *time.Time - // The number of minutes a build is allowed to be queued before it times out. - QueuedTimeoutInMinutes *int32 + // Information about the build environment for this build. + Environment *ProjectEnvironment + + // A list of exported environment variables for this build. + ExportedEnvironmentVariables []*ExportedEnvironmentVariable + + // An array of ProjectFileSystemLocation objects for a CodeBuild build project. A + // ProjectFileSystemLocation object specifies the identifier, location, + // mountOptions, mountPoint, and type of a file system created using Amazon Elastic + // File System. + FileSystemLocations []*ProjectFileSystemLocation // The unique ID for the build. Id *string - // The Amazon Resource Name (ARN) of the build. - Arn *string + // The entity that started the build. Valid values include: + // + // * If AWS + // CodePipeline started the build, the pipeline's name (for example, + // codepipeline/my-demo-pipeline). + // + // * If an AWS Identity and Access Management + // (IAM) user started the build, the user's name (for example, MyUserName). + // + // * + // If the Jenkins plugin for AWS CodeBuild started the build, the string + // CodeBuild-Jenkins-Plugin. + Initiator *string - // An array of ProjectSource objects. - SecondarySources []*ProjectSource + // Information about the build's logs in Amazon CloudWatch Logs. + Logs *LogsLocation - // How long, in minutes, for AWS CodeBuild to wait before timing out this build if - // it does not get marked as completed. - TimeoutInMinutes *int32 + // Describes a network interface. + NetworkInterface *NetworkInterface - // A list of exported environment variables for this build. - ExportedEnvironmentVariables []*ExportedEnvironmentVariable + // Information about all previous build phases that are complete and information + // about any current build phase that is not yet complete. + Phases []*BuildPhase - // Contains information about the debug session for this build. - DebugSession *DebugSession + // The name of the AWS CodeBuild project. + ProjectName *string + + // The number of minutes a build is allowed to be queued before it times out. + QueuedTimeoutInMinutes *int32 + + // An array of the ARNs associated with this build's reports. + ReportArns []*string // An identifier for the version of this build's source code. // @@ -125,16 +136,8 @@ type Build struct { // Amazon Simple Storage Service (Amazon S3), this does not apply. ResolvedSourceVersion *string - // The ARN of the batch build that this build is a member of, if applicable. - BuildBatchArn *string - - // Any version identifier for the version of the source code to be built. If - // sourceVersion is specified at the project level, then this sourceVersion (at the - // build level) takes precedence. For more information, see Source Version Sample - // with CodeBuild - // (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) - // in the AWS CodeBuild User Guide. - SourceVersion *string + // An array of ProjectArtifacts objects. + SecondaryArtifacts []*BuildArtifacts // An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one // of: @@ -158,51 +161,49 @@ type Build struct { // version ID of the object that represents the build input ZIP file to use. SecondarySourceVersions []*ProjectSourceVersion - // An array of ProjectArtifacts objects. - SecondaryArtifacts []*BuildArtifacts + // An array of ProjectSource objects. + SecondarySources []*ProjectSource + + // The name of a service role used for this build. + ServiceRole *string // Information about the source code to be built. Source *ProjectSource - // The entity that started the build. Valid values include: - // - // * If AWS - // CodePipeline started the build, the pipeline's name (for example, - // codepipeline/my-demo-pipeline). - // - // * If an AWS Identity and Access Management - // (IAM) user started the build, the user's name (for example, MyUserName). - // - // * - // If the Jenkins plugin for AWS CodeBuild started the build, the string - // CodeBuild-Jenkins-Plugin. - Initiator *string - - // Information about the cache for the build. - Cache *ProjectCache + // Any version identifier for the version of the source code to be built. If + // sourceVersion is specified at the project level, then this sourceVersion (at the + // build level) takes precedence. For more information, see Source Version Sample + // with CodeBuild + // (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) + // in the AWS CodeBuild User Guide. + SourceVersion *string - // Information about all previous build phases that are complete and information - // about any current build phase that is not yet complete. - Phases []*BuildPhase + // When the build process started, expressed in Unix time format. + StartTime *time.Time - // Information about the output artifacts for the build. - Artifacts *BuildArtifacts + // How long, in minutes, for AWS CodeBuild to wait before timing out this build if + // it does not get marked as completed. + TimeoutInMinutes *int32 - // An array of the ARNs associated with this build's reports. - ReportArns []*string + // If your AWS CodeBuild project accesses resources in an Amazon VPC, you provide + // this parameter that identifies the VPC ID and the list of security group IDs and + // subnet IDs. The security groups and subnets must belong to the same VPC. You + // must provide at least one security group and one subnet ID. + VpcConfig *VpcConfig } // Information about build output artifacts. type BuildArtifacts struct { - // The SHA-256 hash of the build artifact. You can use this hash along with a - // checksum tool to confirm file integrity and authenticity. This value is - // available only if the build project's packaging value is set to ZIP. - Sha256sum *string + // An identifier for this artifact definition. + ArtifactIdentifier *string // Information that tells you if encryption for build artifacts is disabled. EncryptionDisabled *bool + // Information about the location of the build artifacts. + Location *string + // The MD5 hash of the build artifact. You can use this hash along with a checksum // tool to confirm file integrity and authenticity. This value is available only if // the build project's packaging value is set to ZIP. @@ -214,31 +215,61 @@ type BuildArtifacts struct { // time to your artifact name so that it is always unique. OverrideArtifactName *bool - // An identifier for this artifact definition. - ArtifactIdentifier *string - - // Information about the location of the build artifacts. - Location *string + // The SHA-256 hash of the build artifact. You can use this hash along with a + // checksum tool to confirm file integrity and authenticity. This value is + // available only if the build project's packaging value is set to ZIP. + Sha256sum *string } // Contains information about a batch build. type BuildBatch struct { - // Information about the build input source code for the build project. - Source *ProjectSource + // The ARN of the batch build. + Arn *string - // The name of the batch build project. - ProjectName *string + // A BuildArtifacts object the defines the build artifacts for this batch build. + Artifacts *BuildArtifacts - // An array of BuildBatchPhase objects the specify the phases of the batch build. - Phases []*BuildBatchPhase + // Contains configuration information about a batch build project. + BuildBatchConfig *ProjectBuildBatchConfig - // Information about the VPC configuration that AWS CodeBuild accesses. - VpcConfig *VpcConfig + // The number of the batch build. For each project, the buildBatchNumber of its + // first batch build is 1. The buildBatchNumber of each subsequent batch build is + // incremented by 1. If a batch build is deleted, the buildBatchNumber of other + // batch builds does not change. + BuildBatchNumber *int64 - // Specifies the amount of time, in minutes, that the batch build is allowed to be - // queued before it times out. - QueuedTimeoutInMinutes *int32 + // The status of the batch build. + BuildBatchStatus StatusType + + // An array of BuildGroup objects that define the build groups for the batch build. + BuildGroups []*BuildGroup + + // Specifies the maximum amount of time, in minutes, that the build in a batch must + // be completed in. + BuildTimeoutInMinutes *int32 + + // Information about the cache for the build project. + Cache *ProjectCache + + // Indicates if the batch build is complete. + Complete *bool + + // The current phase of the batch build. + CurrentPhase *string + + // The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used + // for encrypting the batch build output artifacts. You can use a cross-account KMS + // key to encrypt the build output artifacts if your service role has permission to + // that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, + // if available, the CMK's alias (using the format alias/alias-name ). + EncryptionKey *string + + // The date and time that the batch build ended. + EndTime *time.Time + + // Information about the build environment of the build project. + Environment *ProjectEnvironment // An array of ProjectFileSystemLocation objects for the batch build project. A // ProjectFileSystemLocation object specifies the identifier, location, @@ -246,15 +277,35 @@ type BuildBatch struct { // File System. FileSystemLocations []*ProjectFileSystemLocation + // The identifier of the batch build. + Id *string + + // The entity that started the batch build. Valid values include: + // + // * If AWS + // CodePipeline started the build, the pipeline's name (for example, + // codepipeline/my-demo-pipeline). + // + // * If an AWS Identity and Access Management + // (IAM) user started the build, the user's name. + // + // * If the Jenkins plugin for + // AWS CodeBuild started the build, the string CodeBuild-Jenkins-Plugin. + Initiator *string + // Information about logs for a build project. These can be logs in Amazon // CloudWatch Logs, built in a specified S3 bucket, or both. LogConfig *LogsConfig - // The date and time that the batch build ended. - EndTime *time.Time + // An array of BuildBatchPhase objects the specify the phases of the batch build. + Phases []*BuildBatchPhase - // An array of ProjectSource objects that define the sources for the batch build. - SecondarySources []*ProjectSource + // The name of the batch build project. + ProjectName *string + + // Specifies the amount of time, in minutes, that the batch build is allowed to be + // queued before it times out. + QueuedTimeoutInMinutes *int32 // The identifier of the resolved version of this batch build's source code. // @@ -268,9 +319,9 @@ type BuildBatch struct { // For Amazon Simple Storage Service (Amazon S3), this does not apply. ResolvedSourceVersion *string - // Specifies the maximum amount of time, in minutes, that the build in a batch must - // be completed in. - BuildTimeoutInMinutes *int32 + // An array of BuildArtifacts objects the define the build artifacts for this batch + // build. + SecondaryArtifacts []*BuildArtifacts // An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one // of: @@ -294,74 +345,23 @@ type BuildBatch struct { // version ID of the object that represents the build input ZIP file to use. SecondarySourceVersions []*ProjectSourceVersion - // The current phase of the batch build. - CurrentPhase *string - - // The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used - // for encrypting the batch build output artifacts. You can use a cross-account KMS - // key to encrypt the build output artifacts if your service role has permission to - // that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, - // if available, the CMK's alias (using the format alias/alias-name ). - EncryptionKey *string - - // Information about the build environment of the build project. - Environment *ProjectEnvironment - - // An array of BuildArtifacts objects the define the build artifacts for this batch - // build. - SecondaryArtifacts []*BuildArtifacts - - // The number of the batch build. For each project, the buildBatchNumber of its - // first batch build is 1. The buildBatchNumber of each subsequent batch build is - // incremented by 1. If a batch build is deleted, the buildBatchNumber of other - // batch builds does not change. - BuildBatchNumber *int64 - - // An array of BuildGroup objects that define the build groups for the batch build. - BuildGroups []*BuildGroup - - // A BuildArtifacts object the defines the build artifacts for this batch build. - Artifacts *BuildArtifacts - - // Information about the cache for the build project. - Cache *ProjectCache - - // Indicates if the batch build is complete. - Complete *bool - - // The date and time that the batch build started. - StartTime *time.Time - - // The identifier of the batch build. - Id *string - - // The ARN of the batch build. - Arn *string + // An array of ProjectSource objects that define the sources for the batch build. + SecondarySources []*ProjectSource // The name of a service role used for builds in the batch. ServiceRole *string - // Contains configuration information about a batch build project. - BuildBatchConfig *ProjectBuildBatchConfig - - // The status of the batch build. - BuildBatchStatus StatusType - - // The entity that started the batch build. Valid values include: - // - // * If AWS - // CodePipeline started the build, the pipeline's name (for example, - // codepipeline/my-demo-pipeline). - // - // * If an AWS Identity and Access Management - // (IAM) user started the build, the user's name. - // - // * If the Jenkins plugin for - // AWS CodeBuild started the build, the string CodeBuild-Jenkins-Plugin. - Initiator *string + // Information about the build input source code for the build project. + Source *ProjectSource // The identifier of the version of the source code to be built. SourceVersion *string + + // The date and time that the batch build started. + StartTime *time.Time + + // Information about the VPC configuration that AWS CodeBuild accesses. + VpcConfig *VpcConfig } // Specifies filters when retrieving batch builds. @@ -375,6 +375,17 @@ type BuildBatchFilter struct { // Contains information about a stage for a batch build. type BuildBatchPhase struct { + // Additional information about the batch build phase. Especially to help + // troubleshoot a failed btach build. + Contexts []*PhaseContext + + // How long, in seconds, between the starting and ending times of the batch build's + // phase. + DurationInSeconds *int64 + + // When the batch build phase ended, expressed in Unix time format. + EndTime *time.Time + // The current status of the batch build phase. Valid values include: FAILED The // build phase failed. FAULT The build phase faulted. IN_PROGRESS The build phase // is still in progress. QUEUED The build has been submitted and is queued behind @@ -392,17 +403,6 @@ type BuildBatchPhase struct { // When the batch build phase started, expressed in Unix time format. StartTime *time.Time - - // How long, in seconds, between the starting and ending times of the batch build's - // phase. - DurationInSeconds *int64 - - // Additional information about the batch build phase. Especially to help - // troubleshoot a failed btach build. - Contexts []*PhaseContext - - // When the batch build phase ended, expressed in Unix time format. - EndTime *time.Time } // Contains information about a batch build build group. Build groups are used to @@ -413,19 +413,19 @@ type BuildGroup struct { // A BuildSummary object that contains a summary of the current build group. CurrentBuildSummary *BuildSummary - // An array of BuildSummary objects that contain summaries of previous build - // groups. - PriorBuildSummaryList []*BuildSummary - // An array of strings that contain the identifiers of the build groups that this // build group depends on. DependsOn []*string + // Contains the identifier of the build group. + Identifier *string + // Specifies if failures in this build group can be ignored. IgnoreFailure *bool - // Contains the identifier of the build group. - Identifier *string + // An array of BuildSummary objects that contain summaries of previous build + // groups. + PriorBuildSummaryList []*BuildSummary } // Information about a build that could not be successfully deleted. @@ -441,13 +441,24 @@ type BuildNotDeleted struct { // Information about a stage for a build. type BuildPhase struct { - // When the build phase ended, expressed in Unix time format. - EndTime *time.Time - // Additional information about a build phase, especially to help troubleshoot a // failed build. Contexts []*PhaseContext + // How long, in seconds, between the starting and ending times of the build's + // phase. + DurationInSeconds *int64 + + // When the build phase ended, expressed in Unix time format. + EndTime *time.Time + + // The current status of the build phase. Valid values include: FAILED The build + // phase failed. FAULT The build phase faulted. IN_PROGRESS The build phase is + // still in progress. QUEUED The build has been submitted and is queued behind + // other submitted builds. STOPPED The build phase stopped. SUCCEEDED The build + // phase succeeded. TIMED_OUT The build phase timed out. + PhaseStatus StatusType + // The name of the build phase. Valid values include: // // * BUILD: Core build @@ -483,19 +494,8 @@ type BuildPhase struct { // Build output artifacts are being uploaded to the output location. PhaseType BuildPhaseType - // The current status of the build phase. Valid values include: FAILED The build - // phase failed. FAULT The build phase faulted. IN_PROGRESS The build phase is - // still in progress. QUEUED The build has been submitted and is queued behind - // other submitted builds. STOPPED The build phase stopped. SUCCEEDED The build - // phase succeeded. TIMED_OUT The build phase timed out. - PhaseStatus StatusType - // When the build phase started, expressed in Unix time format. StartTime *time.Time - - // How long, in seconds, between the starting and ending times of the build's - // phase. - DurationInSeconds *int64 } // Contains information that defines how the AWS CodeBuild build project reports @@ -530,40 +530,30 @@ type BuildStatusConfig struct { // Contains summary information about a batch build group. type BuildSummary struct { - // A ResolvedArtifact object that represents the primary build artifacts for the - // build group. - PrimaryArtifact *ResolvedArtifact - // The batch build ARN. Arn *string - // An array of ResolvedArtifact objects that represents the secondary build - // artifacts for the build group. - SecondaryArtifacts []*ResolvedArtifact - // The status of the build group. FAILED The build group failed. FAULT The build // group faulted. IN_PROGRESS The build group is still in progress. STOPPED The // build group stopped. SUCCEEDED The build group succeeded. TIMED_OUT The build // group timed out. BuildStatus StatusType + // A ResolvedArtifact object that represents the primary build artifacts for the + // build group. + PrimaryArtifact *ResolvedArtifact + // When the build was started, expressed in Unix time format. RequestedOn *time.Time + + // An array of ResolvedArtifact objects that represents the secondary build + // artifacts for the build group. + SecondaryArtifacts []*ResolvedArtifact } // Information about Amazon CloudWatch Logs for a build project. type CloudWatchLogsConfig struct { - // The group name of the logs in Amazon CloudWatch Logs. For more information, see - // Working with Log Groups and Log Streams - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html). - GroupName *string - - // The prefix of the stream name of the Amazon CloudWatch Logs. For more - // information, see Working with Log Groups and Log Streams - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html). - StreamName *string - // The current status of the logs in Amazon CloudWatch Logs for a build project. // Valid values are: // @@ -575,6 +565,16 @@ type CloudWatchLogsConfig struct { // // This member is required. Status LogsConfigStatusType + + // The group name of the logs in Amazon CloudWatch Logs. For more information, see + // Working with Log Groups and Log Streams + // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html). + GroupName *string + + // The prefix of the stream name of the Amazon CloudWatch Logs. For more + // information, see Working with Log Groups and Log Streams + // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html). + StreamName *string } // Contains code coverage report information. Line coverage measures how many @@ -586,14 +586,20 @@ type CodeCoverage struct { // The percentage of branches that are covered by your tests. BranchCoveragePercentage *float64 - // The number of lines that are not covered by your tests. - LinesMissed *int32 + // The number of conditional branches that are covered by your tests. + BranchesCovered *int32 + + // The number of conditional branches that are not covered by your tests. + BranchesMissed *int32 + + // The date and time that the tests were run. + Expired *time.Time // The path of the test report file. FilePath *string - // The ARN of the report. - ReportARN *string + // The identifier of the code coverage report. + Id *string // The percentage of lines that are covered by your tests. LineCoveragePercentage *float64 @@ -601,17 +607,11 @@ type CodeCoverage struct { // The number of lines that are covered by your tests. LinesCovered *int32 - // The date and time that the tests were run. - Expired *time.Time - - // The number of conditional branches that are not covered by your tests. - BranchesMissed *int32 - - // The number of conditional branches that are covered by your tests. - BranchesCovered *int32 + // The number of lines that are not covered by your tests. + LinesMissed *int32 - // The identifier of the code coverage report. - Id *string + // The ARN of the report. + ReportARN *string } // Contains a summary of a code coverage report. Line coverage measures how many @@ -620,11 +620,8 @@ type CodeCoverage struct { // every possible branch of a control structure, such as an if or case statement. type CodeCoverageReportSummary struct { - // The number of lines that are covered by your tests. - LinesCovered *int32 - - // The percentage of lines that are covered by your tests. - LineCoveragePercentage *float64 + // The percentage of branches that are covered by your tests. + BranchCoveragePercentage *float64 // The number of conditional branches that are covered by your tests. BranchesCovered *int32 @@ -632,8 +629,11 @@ type CodeCoverageReportSummary struct { // The number of conditional branches that are not covered by your tests. BranchesMissed *int32 - // The percentage of branches that are covered by your tests. - BranchCoveragePercentage *float64 + // The percentage of lines that are covered by your tests. + LineCoveragePercentage *float64 + + // The number of lines that are covered by your tests. + LinesCovered *int32 // The number of lines that are not covered by your tests. LinesMissed *int32 @@ -656,26 +656,26 @@ type DebugSession struct { // Information about a Docker image that is managed by AWS CodeBuild. type EnvironmentImage struct { + // The description of the Docker image. + Description *string + // The name of the Docker image. Name *string // A list of environment image versions. Versions []*string - - // The description of the Docker image. - Description *string } // A set of Docker images that are related by programming language and are managed // by AWS CodeBuild. type EnvironmentLanguage struct { - // The programming language for the Docker images. - Language LanguageType - // The list of Docker images that are related by the specified programming // language. Images []*EnvironmentImage + + // The programming language for the Docker images. + Language LanguageType } // A set of Docker images that are related by platform and are managed by AWS @@ -692,6 +692,11 @@ type EnvironmentPlatform struct { // Information about an environment variable for a build project or a build. type EnvironmentVariable struct { + // The name or key of the environment variable. + // + // This member is required. + Name *string + // The value of the environment variable. We strongly discourage the use of // PLAINTEXT environment variables to store sensitive values, especially AWS secret // key IDs and secret access keys. PLAINTEXT environment variables can be displayed @@ -719,11 +724,6 @@ type EnvironmentVariable struct { // secrets manager reference-key in the buildspec file // (https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#secrets-manager-build-spec). Type EnvironmentVariableType - - // The name or key of the environment variable. - // - // This member is required. - Name *string } // Information about an exported environment variable. @@ -766,8 +766,8 @@ type LogsConfig struct { // Information about build logs in Amazon CloudWatch Logs. type LogsLocation struct { - // The URL to a build log in an S3 bucket. - S3DeepLink *string + // Information about Amazon CloudWatch Logs for a build project. + CloudWatchLogs *CloudWatchLogsConfig // The ARN of Amazon CloudWatch Logs for a build project. Its format is // arn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName}. @@ -775,6 +775,15 @@ type LogsLocation struct { // (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatchlogs.html#amazoncloudwatchlogs-resources-for-iam-policies). CloudWatchLogsArn *string + // The URL to an individual build log in Amazon CloudWatch Logs. + DeepLink *string + + // The name of the Amazon CloudWatch Logs group for the build logs. + GroupName *string + + // The URL to a build log in an S3 bucket. + S3DeepLink *string + // Information about S3 logs for a build project. S3Logs *S3LogsConfig @@ -784,17 +793,8 @@ type LogsLocation struct { // (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html#amazons3-resources-for-iam-policies). S3LogsArn *string - // The name of the Amazon CloudWatch Logs group for the build logs. - GroupName *string - - // The URL to an individual build log in Amazon CloudWatch Logs. - DeepLink *string - // The name of the Amazon CloudWatch Logs stream for the build logs. StreamName *string - - // Information about Amazon CloudWatch Logs for a build project. - CloudWatchLogs *CloudWatchLogsConfig } // Describes a network interface. @@ -822,20 +822,43 @@ type PhaseContext struct { // Information about a build project. type Project struct { + // The Amazon Resource Name (ARN) of the build project. + Arn *string + + // Information about the build output artifacts for the build project. + Artifacts *ProjectArtifacts + // Information about the build badge for the build project. Badge *ProjectBadge - // Information about the VPC configuration that AWS CodeBuild accesses. - VpcConfig *VpcConfig + // A ProjectBuildBatchConfig () object that defines the batch build options for the + // project. + BuildBatchConfig *ProjectBuildBatchConfig - // Information about the build input source code for this build project. - Source *ProjectSource + // Information about the cache for the build project. + Cache *ProjectCache - // The name of the build project. - Name *string + // When the build project was created, expressed in Unix time format. + Created *time.Time - // The number of minutes a build is allowed to be queued before it times out. - QueuedTimeoutInMinutes *int32 + // A description that makes the build project easy to identify. + Description *string + + // The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used + // for encrypting the build output artifacts. You can use a cross-account KMS key + // to encrypt the build output artifacts if your service role has permission to + // that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, + // if available, the CMK's alias (using the format alias/alias-name ). + EncryptionKey *string + + // Information about the build environment for this build project. + Environment *ProjectEnvironment + + // An array of ProjectFileSystemLocation objects for a CodeBuild build project. A + // ProjectFileSystemLocation object specifies the identifier, location, + // mountOptions, mountPoint, and type of a file system created using Amazon Elastic + // File System. + FileSystemLocations []*ProjectFileSystemLocation // When the build project's settings were last modified, expressed in Unix time // format. @@ -845,59 +868,29 @@ type Project struct { // Amazon CloudWatch Logs, an S3 bucket, or both. LogsConfig *LogsConfig - // Information about the cache for the build project. - Cache *ProjectCache + // The name of the build project. + Name *string - // A list of tag key and value pairs associated with this build project. These tags - // are available for use by AWS services that support AWS CodeBuild build project - // tags. - Tags []*Tag + // The number of minutes a build is allowed to be queued before it times out. + QueuedTimeoutInMinutes *int32 - // Information about the build output artifacts for the build project. - Artifacts *ProjectArtifacts + // An array of ProjectArtifacts objects. + SecondaryArtifacts []*ProjectArtifacts // An array of ProjectSourceVersion objects. If secondarySourceVersions is // specified at the build level, then they take over these secondarySourceVersions // (at the project level). SecondarySourceVersions []*ProjectSourceVersion - // The ARN of the AWS Identity and Access Management (IAM) role that enables AWS - // CodeBuild to interact with dependent AWS services on behalf of the AWS account. - ServiceRole *string - - // An array of ProjectFileSystemLocation objects for a CodeBuild build project. A - // ProjectFileSystemLocation object specifies the identifier, location, - // mountOptions, mountPoint, and type of a file system created using Amazon Elastic - // File System. - FileSystemLocations []*ProjectFileSystemLocation - - // The Amazon Resource Name (ARN) of the build project. - Arn *string - // An array of ProjectSource objects. SecondarySources []*ProjectSource - // Information about a webhook that connects repository events to a build project - // in AWS CodeBuild. - Webhook *Webhook - - // A ProjectBuildBatchConfig () object that defines the batch build options for the - // project. - BuildBatchConfig *ProjectBuildBatchConfig - - // When the build project was created, expressed in Unix time format. - Created *time.Time - - // How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before - // timing out any related build that did not get marked as completed. The default - // is 60 minutes. - TimeoutInMinutes *int32 - - // A description that makes the build project easy to identify. - Description *string + // The ARN of the AWS Identity and Access Management (IAM) role that enables AWS + // CodeBuild to interact with dependent AWS services on behalf of the AWS account. + ServiceRole *string - // An array of ProjectArtifacts objects. - SecondaryArtifacts []*ProjectArtifacts + // Information about the build input source code for this build project. + Source *ProjectSource // A version of the build input to be built for this project. If not specified, the // latest version is used. If specified, it must be one of: @@ -928,15 +921,22 @@ type Project struct { // in the AWS CodeBuild User Guide. SourceVersion *string - // The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used - // for encrypting the build output artifacts. You can use a cross-account KMS key - // to encrypt the build output artifacts if your service role has permission to - // that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, - // if available, the CMK's alias (using the format alias/alias-name ). - EncryptionKey *string + // A list of tag key and value pairs associated with this build project. These tags + // are available for use by AWS services that support AWS CodeBuild build project + // tags. + Tags []*Tag - // Information about the build environment for this build project. - Environment *ProjectEnvironment + // How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before + // timing out any related build that did not get marked as completed. The default + // is 60 minutes. + TimeoutInMinutes *int32 + + // Information about the VPC configuration that AWS CodeBuild accesses. + VpcConfig *VpcConfig + + // Information about a webhook that connects repository events to a build project + // in AWS CodeBuild. + Webhook *Webhook } // Information about the build output artifacts for the build project. @@ -954,17 +954,30 @@ type ProjectArtifacts struct { // * S3: The build // project stores build output in Amazon Simple Storage Service (Amazon S3). // - // This member is required. - Type ArtifactsType - - // An identifier for this artifact definition. - ArtifactIdentifier *string - - // If this flag is set, a name specified in the buildspec file overrides the - // artifact name. The name specified in a buildspec file is calculated at build - // time and uses the Shell Command Language. For example, you can append a date and - // time to your artifact name so that it is always unique. - OverrideArtifactName *bool + // This member is required. + Type ArtifactsType + + // An identifier for this artifact definition. + ArtifactIdentifier *string + + // Set to true if you do not want your output artifacts encrypted. This option is + // valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). + // If this is set with another artifacts type, an invalidInputException is thrown. + EncryptionDisabled *bool + + // Information about the build output artifact location: + // + // * If type is set to + // CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because + // AWS CodePipeline manages its build output locations instead of AWS CodeBuild. + // + // + // * If type is set to NO_ARTIFACTS, this value is ignored if specified, because no + // build output is produced. + // + // * If type is set to S3, this is the name of the + // output bucket. + Location *string // Along with path and namespaceType, the pattern that AWS CodeBuild uses to name // and store the output artifact: @@ -997,52 +1010,6 @@ type ProjectArtifacts struct { // MyArtifacts/build-ID . Name *string - // Along with namespaceType and name, the pattern that AWS CodeBuild uses to name - // and store the output artifact: - // - // * If type is set to CODEPIPELINE, AWS - // CodePipeline ignores this value if specified. This is because AWS CodePipeline - // manages its build output names instead of AWS CodeBuild. - // - // * If type is set - // to NO_ARTIFACTS, this value is ignored if specified, because no build output is - // produced. - // - // * If type is set to S3, this is the path to the output artifact. - // If path is not specified, path is not used. - // - // For example, if path is set to - // MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, - // the output artifact is stored in the output bucket at - // MyArtifacts/MyArtifact.zip. - Path *string - - // The type of build output artifact to create: - // - // * If type is set to - // CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because - // AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild. - // - // - // * If type is set to NO_ARTIFACTS, this value is ignored if specified, because no - // build output is produced. - // - // * If type is set to S3, valid values include: - // - // - // * NONE: AWS CodeBuild creates in the output bucket a folder that contains the - // build output. This is the default if packaging is not specified. - // - // * ZIP: - // AWS CodeBuild creates in the output bucket a ZIP file that contains the build - // output. - Packaging ArtifactPackaging - - // Set to true if you do not want your output artifacts encrypted. This option is - // valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). - // If this is set with another artifacts type, an invalidInputException is thrown. - EncryptionDisabled *bool - // Along with path and name, the pattern that AWS CodeBuild uses to determine the // name and location to store the output artifact: // @@ -1068,37 +1035,74 @@ type ProjectArtifacts struct { // MyArtifacts/build-ID/MyArtifact.zip. NamespaceType ArtifactNamespace - // Information about the build output artifact location: + // If this flag is set, a name specified in the buildspec file overrides the + // artifact name. The name specified in a buildspec file is calculated at build + // time and uses the Shell Command Language. For example, you can append a date and + // time to your artifact name so that it is always unique. + OverrideArtifactName *bool + + // The type of build output artifact to create: // // * If type is set to // CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because - // AWS CodePipeline manages its build output locations instead of AWS CodeBuild. + // AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild. // // // * If type is set to NO_ARTIFACTS, this value is ignored if specified, because no // build output is produced. // - // * If type is set to S3, this is the name of the - // output bucket. - Location *string + // * If type is set to S3, valid values include: + // + // + // * NONE: AWS CodeBuild creates in the output bucket a folder that contains the + // build output. This is the default if packaging is not specified. + // + // * ZIP: + // AWS CodeBuild creates in the output bucket a ZIP file that contains the build + // output. + Packaging ArtifactPackaging + + // Along with namespaceType and name, the pattern that AWS CodeBuild uses to name + // and store the output artifact: + // + // * If type is set to CODEPIPELINE, AWS + // CodePipeline ignores this value if specified. This is because AWS CodePipeline + // manages its build output names instead of AWS CodeBuild. + // + // * If type is set + // to NO_ARTIFACTS, this value is ignored if specified, because no build output is + // produced. + // + // * If type is set to S3, this is the path to the output artifact. + // If path is not specified, path is not used. + // + // For example, if path is set to + // MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, + // the output artifact is stored in the output bucket at + // MyArtifacts/MyArtifact.zip. + Path *string } // Information about the build badge for the build project. type ProjectBadge struct { + // Set this to true to generate a publicly accessible URL for your project's build + // badge. + BadgeEnabled *bool + // The publicly-accessible URL through which you can access the build badge for // your project. The publicly accessible URL through which you can access the build // badge for your project. BadgeRequestUrl *string - - // Set this to true to generate a publicly accessible URL for your project's build - // badge. - BadgeEnabled *bool } // Contains configuration information about a batch build project. type ProjectBuildBatchConfig struct { + // Specifies if the build artifacts for the batch build should be combined into a + // single artifact location. + CombineArtifacts *bool + // A BatchRestrictions object that specifies the restrictions for the batch build. Restrictions *BatchRestrictions @@ -1108,10 +1112,6 @@ type ProjectBuildBatchConfig struct { // Specifies the maximum amount of time, in minutes, that the batch build must be // completed in. TimeoutInMins *int32 - - // Specifies if the build artifacts for the batch build should be combined into a - // single artifact location. - CombineArtifacts *bool } // Information about the cache for the build project. @@ -1131,6 +1131,14 @@ type ProjectCache struct { // This member is required. Type CacheType + // Information about the cache location: + // + // * NO_CACHE or LOCAL: This value is + // ignored. + // + // * S3: This is the S3 bucket name/prefix. + Location *string + // If you use a LOCAL cache, the local cache mode. You can use one or more local // cache modes at the same time. // @@ -1172,14 +1180,6 @@ type ProjectCache struct { // if a source item has the same name. Directories are specified using cache paths // in the buildspec file. Modes []CacheMode - - // Information about the cache location: - // - // * NO_CACHE or LOCAL: This value is - // ignored. - // - // * S3: This is the S3 bucket name/prefix. - Location *string } // Information about the build environment of the build project. @@ -1222,20 +1222,20 @@ type ProjectEnvironment struct { // This member is required. ComputeType ComputeType - // The type of credentials AWS CodeBuild uses to pull images in your build. There - // are two valid values: + // The image tag or image digest that identifies the Docker image to use for this + // build project. Use the following formats: // - // * CODEBUILD specifies that AWS CodeBuild uses its own - // credentials. This requires that you modify your ECR repository policy to trust - // AWS CodeBuild's service principal. + // * For an image tag: + // registry/repository:tag. For example, to specify an image with the tag "latest," + // use registry/repository:latest. // - // * SERVICE_ROLE specifies that AWS - // CodeBuild uses your build project's service role. + // * For an image digest: + // registry/repository@digest. For example, to specify an image with the digest + // "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use + // registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf. // - // When you use a cross-account - // or private registry image, you must use SERVICE_ROLE credentials. When you use - // an AWS CodeBuild curated image, you must use CODEBUILD credentials. - ImagePullCredentialsType ImagePullCredentialsType + // This member is required. + Image *string // The type of build environment to use for related builds. // @@ -1260,26 +1260,27 @@ type ProjectEnvironment struct { // This member is required. Type EnvironmentType - // The image tag or image digest that identifies the Docker image to use for this - // build project. Use the following formats: - // - // * For an image tag: - // registry/repository:tag. For example, to specify an image with the tag "latest," - // use registry/repository:latest. - // - // * For an image digest: - // registry/repository@digest. For example, to specify an image with the digest - // "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use - // registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf. - // - // This member is required. - Image *string - // The certificate to use with this build project. Certificate *string - // The credentials for access to a private registry. - RegistryCredential *RegistryCredential + // A set of environment variables to make available to builds for this build + // project. + EnvironmentVariables []*EnvironmentVariable + + // The type of credentials AWS CodeBuild uses to pull images in your build. There + // are two valid values: + // + // * CODEBUILD specifies that AWS CodeBuild uses its own + // credentials. This requires that you modify your ECR repository policy to trust + // AWS CodeBuild's service principal. + // + // * SERVICE_ROLE specifies that AWS + // CodeBuild uses your build project's service role. + // + // When you use a cross-account + // or private registry image, you must use SERVICE_ROLE credentials. When you use + // an AWS CodeBuild curated image, you must use CODEBUILD credentials. + ImagePullCredentialsType ImagePullCredentialsType // Enables running the Docker daemon inside a Docker container. Set to true only if // the build project is used to build Docker images. Otherwise, a build that @@ -1297,9 +1298,8 @@ type ProjectEnvironment struct { // "until docker info; do echo .; sleep 1; done" PrivilegedMode *bool - // A set of environment variables to make available to builds for this build - // project. - EnvironmentVariables []*EnvironmentVariable + // The credentials for access to a private registry. + RegistryCredential *RegistryCredential } // Information about a file system created by Amazon Elastic File System (EFS). For @@ -1307,6 +1307,13 @@ type ProjectEnvironment struct { // (https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html) type ProjectFileSystemLocation struct { + // The name used to access a file system created by Amazon EFS. CodeBuild creates + // an environment variable by appending the identifier in all capital letters to + // CODEBUILD_. For example, if you specify my-efs for identifier, a new environment + // variable is create named CODEBUILD_MY-EFS. The identifier is used to mount your + // file system. + Identifier *string + // A string that specifies the location of the file system created by Amazon EFS. // Its format is efs-dns-name:/directory-path. You can find the DNS name of file // system when you view it in the AWS EFS console. The directory path is a path to @@ -1319,16 +1326,6 @@ type ProjectFileSystemLocation struct { // the entire file system. Location *string - // The location in the container where you mount the file system. - MountPoint *string - - // The name used to access a file system created by Amazon EFS. CodeBuild creates - // an environment variable by appending the identifier in all capital letters to - // CODEBUILD_. For example, if you specify my-efs for identifier, a new environment - // variable is create named CODEBUILD_MY-EFS. The identifier is used to mount your - // file system. - Identifier *string - // The mount options for a file system created by AWS EFS. The default mount // options used by CodeBuild are // nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For more @@ -1336,6 +1333,9 @@ type ProjectFileSystemLocation struct { // (https://docs.aws.amazon.com/efs/latest/ug/mounting-fs-nfs-mount-settings.html). MountOptions *string + // The location in the container where you mount the file system. + MountPoint *string + // The type of the file system. The one supported type is EFS. Type FileSystemType } @@ -1343,12 +1343,42 @@ type ProjectFileSystemLocation struct { // Information about the build input source code for the build project. type ProjectSource struct { - // Set to true to report the status of a build's start and finish to your source - // provider. This option is valid only when your source provider is GitHub, GitHub - // Enterprise, or Bitbucket. If this is set and you use a different source - // provider, an invalidInputException is thrown. The status of a build triggered by - // a webhook is always reported to your source provider. - ReportBuildStatus *bool + // The type of repository that contains the source code to be built. Valid values + // include: + // + // * BITBUCKET: The source code is in a Bitbucket repository. + // + // * + // CODECOMMIT: The source code is in an AWS CodeCommit repository. + // + // * + // CODEPIPELINE: The source code settings are specified in the source action of a + // pipeline in AWS CodePipeline. + // + // * GITHUB: The source code is in a GitHub or + // GitHub Enterprise Cloud repository. + // + // * GITHUB_ENTERPRISE: The source code is + // in a GitHub Enterprise Server repository. + // + // * NO_SOURCE: The project does not + // have input source code. + // + // * S3: The source code is in an Amazon Simple + // Storage Service (Amazon S3) input bucket. + // + // This member is required. + Type SourceType + + // Information about the authorization settings for AWS CodeBuild to access the + // source code to be built. This information is for the AWS CodeBuild console's use + // only. Your code should not get or set this information directly. + Auth *SourceAuth + + // Contains information that defines how the build project reports the build status + // to the source provider. This option is only used when the source provider is + // GITHUB, GITHUB_ENTERPRISE, or BITBUCKET. + BuildStatusConfig *BuildStatusConfig // The buildspec file declaration to use for the builds in this build project. If // this value is set, it can be either an inline buildspec definition, the path to @@ -1362,6 +1392,16 @@ type ProjectSource struct { // (https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage). Buildspec *string + // Information about the Git clone depth for the build project. + GitCloneDepth *int32 + + // Information about the Git submodules configuration for the build project. + GitSubmodulesConfig *GitSubmodulesConfig + + // Enable this flag to ignore SSL warnings while connecting to the project source + // code. + InsecureSsl *bool + // Information about the location of the source code to be built. Valid values // include: // @@ -1410,60 +1450,25 @@ type ProjectSource struct { // type value to OAUTH. Location *string - // Information about the authorization settings for AWS CodeBuild to access the - // source code to be built. This information is for the AWS CodeBuild console's use - // only. Your code should not get or set this information directly. - Auth *SourceAuth - - // Enable this flag to ignore SSL warnings while connecting to the project source - // code. - InsecureSsl *bool - - // Information about the Git submodules configuration for the build project. - GitSubmodulesConfig *GitSubmodulesConfig - - // Contains information that defines how the build project reports the build status - // to the source provider. This option is only used when the source provider is - // GITHUB, GITHUB_ENTERPRISE, or BITBUCKET. - BuildStatusConfig *BuildStatusConfig + // Set to true to report the status of a build's start and finish to your source + // provider. This option is valid only when your source provider is GitHub, GitHub + // Enterprise, or Bitbucket. If this is set and you use a different source + // provider, an invalidInputException is thrown. The status of a build triggered by + // a webhook is always reported to your source provider. + ReportBuildStatus *bool // An identifier for this project source. SourceIdentifier *string - - // Information about the Git clone depth for the build project. - GitCloneDepth *int32 - - // The type of repository that contains the source code to be built. Valid values - // include: - // - // * BITBUCKET: The source code is in a Bitbucket repository. - // - // * - // CODECOMMIT: The source code is in an AWS CodeCommit repository. - // - // * - // CODEPIPELINE: The source code settings are specified in the source action of a - // pipeline in AWS CodePipeline. - // - // * GITHUB: The source code is in a GitHub or - // GitHub Enterprise Cloud repository. - // - // * GITHUB_ENTERPRISE: The source code is - // in a GitHub Enterprise Server repository. - // - // * NO_SOURCE: The project does not - // have input source code. - // - // * S3: The source code is in an Amazon Simple - // Storage Service (Amazon S3) input bucket. - // - // This member is required. - Type SourceType } // A source identifier and its corresponding version. type ProjectSourceVersion struct { + // An identifier for a source in the build project. + // + // This member is required. + SourceIdentifier *string + // The source version for the corresponding source identifier. If specified, must // be one of: // @@ -1492,11 +1497,6 @@ type ProjectSourceVersion struct { // // This member is required. SourceVersion *string - - // An identifier for a source in the build project. - // - // This member is required. - SourceIdentifier *string } // Information about credentials that provide access to a private Docker registry. @@ -1532,38 +1532,18 @@ type RegistryCredential struct { // of tests you want, such as unit tests, integration tests, and functional tests. type Report struct { - // A TestReportSummary object that contains information about this test report. - TestSummary *TestReportSummary - - // The status of this report. - Status ReportStatusType - - // The type of the report that was run. CODE_COVERAGE A code coverage report. TEST - // A test report. - Type ReportType - - // The ARN of the build run that generated this report. - ExecutionId *string - - // A boolean that specifies if this report run is truncated. The list of test cases - // is truncated after the maximum number of test cases is reached. - Truncated *bool - // The ARN of the report run. Arn *string - // The ARN of the report group associated with this report. - ReportGroupArn *string - - // The date and time this report run occurred. - Created *time.Time - // A CodeCoverageReportSummary object that contains a code coverage summary for // this report. CodeCoverageSummary *CodeCoverageReportSummary - // The name of the report that was run. - Name *string + // The date and time this report run occurred. + Created *time.Time + + // The ARN of the build run that generated this report. + ExecutionId *string // The date and time a report expires. A report expires 30 days after it is // created. An expired report is not available to view in CodeBuild. @@ -1571,6 +1551,26 @@ type Report struct { // Information about where the raw data used to generate this report was exported. ExportConfig *ReportExportConfig + + // The name of the report that was run. + Name *string + + // The ARN of the report group associated with this report. + ReportGroupArn *string + + // The status of this report. + Status ReportStatusType + + // A TestReportSummary object that contains information about this test report. + TestSummary *TestReportSummary + + // A boolean that specifies if this report run is truncated. The list of test cases + // is truncated after the maximum number of test cases is reached. + Truncated *bool + + // The type of the report that was run. CODE_COVERAGE A code coverage report. TEST + // A test report. + Type ReportType } // Information about the location where the run of a report is exported. @@ -1604,19 +1604,15 @@ type ReportFilter struct { // files. type ReportGroup struct { - // The type of the ReportGroup. The one valid value is TEST. - Type ReportType - - // A list of tag key and value pairs associated with this report group. These tags - // are available for use by AWS services that support AWS CodeBuild report group - // tags. - Tags []*Tag + // The ARN of a ReportGroup. + Arn *string // The date and time this ReportGroup was created. Created *time.Time - // The ARN of a ReportGroup. - Arn *string + // Information about the destination where the raw data of this ReportGroup is + // exported. + ExportConfig *ReportExportConfig // The date and time this ReportGroup was last modified. LastModified *time.Time @@ -1624,9 +1620,13 @@ type ReportGroup struct { // The name of a ReportGroup. Name *string - // Information about the destination where the raw data of this ReportGroup is - // exported. - ExportConfig *ReportExportConfig + // A list of tag key and value pairs associated with this report group. These tags + // are available for use by AWS services that support AWS CodeBuild report group + // tags. + Tags []*Tag + + // The type of the ReportGroup. The one valid value is TEST. + Type ReportType } // Represents a resolved build artifact. A resolve artifact is an artifact that is @@ -1647,10 +1647,6 @@ type ResolvedArtifact struct { // Information about S3 logs for a build project. type S3LogsConfig struct { - // Set to true if you do not want your S3 build log output encrypted. By default S3 - // build logs are encrypted. - EncryptionDisabled *bool - // The current status of the S3 build logs. Valid values are: // // * ENABLED: S3 @@ -1662,6 +1658,10 @@ type S3LogsConfig struct { // This member is required. Status LogsConfigStatusType + // Set to true if you do not want your S3 build log output encrypted. By default S3 + // build logs are encrypted. + EncryptionDisabled *bool + // The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 // bucket name is my-bucket, and your path prefix is build-log, then acceptable // formats are my-bucket/build-log or arn:aws:s3:::my-bucket/build-log. @@ -1671,6 +1671,15 @@ type S3LogsConfig struct { // Information about the S3 bucket where the raw data of a report are exported. type S3ReportExportConfig struct { + // The name of the S3 bucket where the raw data of a report are exported. + Bucket *string + + // A boolean value that specifies if the results of a report are encrypted. + EncryptionDisabled *bool + + // The encryption key for the report's encrypted raw data. + EncryptionKey *string + // The type of build output artifact to create. Valid values include: // // * NONE: @@ -1681,15 +1690,6 @@ type S3ReportExportConfig struct { // the raw data in the output bucket. Packaging ReportPackagingType - // The encryption key for the report's encrypted raw data. - EncryptionKey *string - - // The name of the S3 bucket where the raw data of a report are exported. - Bucket *string - - // A boolean value that specifies if the results of a report are encrypted. - EncryptionDisabled *bool - // The path to the exported report's raw data results. Path *string } @@ -1699,31 +1699,31 @@ type S3ReportExportConfig struct { // only. Your code should not get or set this information directly. type SourceAuth struct { - // The resource value that applies to the specified authorization type. - Resource *string - // This data type is deprecated and is no longer accurate or used. The // authorization type to use. The only valid value is OAUTH, which represents the // OAuth authorization type. // // This member is required. Type SourceAuthType + + // The resource value that applies to the specified authorization type. + Resource *string } // Information about the credentials for a GitHub, GitHub Enterprise, or Bitbucket // repository. type SourceCredentialsInfo struct { - // The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, or - // BITBUCKET. - ServerType ServerType - // The Amazon Resource Name (ARN) of the token. Arn *string // The type of authentication used by the credentials. Valid options are OAUTH, // BASIC_AUTH, or PERSONAL_ACCESS_TOKEN. AuthType AuthType + + // The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, or + // BITBUCKET. + ServerType ServerType } // A tag, consisting of a key and a value. This tag is available for use by AWS @@ -1741,33 +1741,33 @@ type Tag struct { // Cucumber. A test case might be a unit test or a configuration test. type TestCase struct { - // The ARN of the report to which the test case belongs. - ReportArn *string - - // The name of the test case. - Name *string - - // The status returned by the test case after it was run. Valid statuses are - // SUCCEEDED, FAILED, ERROR, SKIPPED, and UNKNOWN. - Status *string - // The number of nanoseconds it took to run this test case. DurationInNanoSeconds *int64 + // The date and time a test case expires. A test case expires 30 days after it is + // created. An expired test case is not available to view in CodeBuild. + Expired *time.Time + // A message associated with a test case. For example, an error message or stack // trace. Message *string + // The name of the test case. + Name *string + // A string that is applied to a series of related test cases. CodeBuild generates // the prefix. The prefix depends on the framework used to generate the tests. Prefix *string + // The ARN of the report to which the test case belongs. + ReportArn *string + + // The status returned by the test case after it was run. Valid statuses are + // SUCCEEDED, FAILED, ERROR, SKIPPED, and UNKNOWN. + Status *string + // The path to the raw data file that contains the test result. TestRawDataPath *string - - // The date and time a test case expires. A test case expires 30 days after it is - // created. An expired test case is not available to view in CodeBuild. - Expired *time.Time } // A filter used to return specific types of test cases. @@ -1802,12 +1802,12 @@ type TestReportSummary struct { // Information about the VPC configuration that AWS CodeBuild accesses. type VpcConfig struct { - // A list of one or more subnet IDs in your Amazon VPC. - Subnets []*string - // A list of one or more security groups IDs in your Amazon VPC. SecurityGroupIds []*string + // A list of one or more subnet IDs in your Amazon VPC. + Subnets []*string + // The ID of the Amazon VPC. VpcId *string } @@ -1816,16 +1816,14 @@ type VpcConfig struct { // in AWS CodeBuild. type Webhook struct { - // A timestamp that indicates the last time a repository's secret token was - // modified. - LastModifiedSecret *time.Time - - // The secret token of the associated repository. A Bitbucket webhook does not - // support secret. - Secret *string + // A regular expression used to determine which repository branches are built when + // a webhook is triggered. If the name of a branch matches the regular expression, + // then it is built. If branchFilter is empty, then all branches are built. It is + // recommended that you use filterGroups instead of branchFilter. + BranchFilter *string - // The URL to the webhook. - Url *string + // Specifies the type of build this webhook will trigger. + BuildType WebhookBuildType // An array of arrays of WebhookFilter objects used to determine which webhooks are // triggered. At least one WebhookFilter in the array must specify EVENT as its @@ -1833,17 +1831,19 @@ type Webhook struct { // array must pass. For a filter group to pass, each of its filters must pass. FilterGroups [][]*WebhookFilter + // A timestamp that indicates the last time a repository's secret token was + // modified. + LastModifiedSecret *time.Time + // The AWS CodeBuild endpoint where webhook events are sent. PayloadUrl *string - // A regular expression used to determine which repository branches are built when - // a webhook is triggered. If the name of a branch matches the regular expression, - // then it is built. If branchFilter is empty, then all branches are built. It is - // recommended that you use filterGroups instead of branchFilter. - BranchFilter *string + // The secret token of the associated repository. A Bitbucket webhook does not + // support secret. + Secret *string - // Specifies the type of build this webhook will trigger. - BuildType WebhookBuildType + // The URL to the webhook. + Url *string } // A filter used to determine which webhooks trigger a build. diff --git a/service/codecommit/api_op_AssociateApprovalRuleTemplateWithRepository.go b/service/codecommit/api_op_AssociateApprovalRuleTemplateWithRepository.go index 9525777daa1..f1aef1f4a4d 100644 --- a/service/codecommit/api_op_AssociateApprovalRuleTemplateWithRepository.go +++ b/service/codecommit/api_op_AssociateApprovalRuleTemplateWithRepository.go @@ -62,15 +62,15 @@ func (c *Client) AssociateApprovalRuleTemplateWithRepository(ctx context.Context type AssociateApprovalRuleTemplateWithRepositoryInput struct { - // The name of the repository that you want to associate with the template. + // The name for the approval rule template. // // This member is required. - RepositoryName *string + ApprovalRuleTemplateName *string - // The name for the approval rule template. + // The name of the repository that you want to associate with the template. // // This member is required. - ApprovalRuleTemplateName *string + RepositoryName *string } type AssociateApprovalRuleTemplateWithRepositoryOutput struct { diff --git a/service/codecommit/api_op_BatchAssociateApprovalRuleTemplateWithRepositories.go b/service/codecommit/api_op_BatchAssociateApprovalRuleTemplateWithRepositories.go index 0673b8d0ca2..d3f203840b0 100644 --- a/service/codecommit/api_op_BatchAssociateApprovalRuleTemplateWithRepositories.go +++ b/service/codecommit/api_op_BatchAssociateApprovalRuleTemplateWithRepositories.go @@ -73,16 +73,16 @@ type BatchAssociateApprovalRuleTemplateWithRepositoriesInput struct { type BatchAssociateApprovalRuleTemplateWithRepositoriesOutput struct { - // A list of any errors that might have occurred while attempting to create the - // association between the template and the repositories. + // A list of names of the repositories that have been associated with the template. // // This member is required. - Errors []*types.BatchAssociateApprovalRuleTemplateWithRepositoriesError + AssociatedRepositoryNames []*string - // A list of names of the repositories that have been associated with the template. + // A list of any errors that might have occurred while attempting to create the + // association between the template and the repositories. // // This member is required. - AssociatedRepositoryNames []*string + Errors []*types.BatchAssociateApprovalRuleTemplateWithRepositoriesError // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/codecommit/api_op_BatchDescribeMergeConflicts.go b/service/codecommit/api_op_BatchDescribeMergeConflicts.go index 9658a107f7d..32b219e5572 100644 --- a/service/codecommit/api_op_BatchDescribeMergeConflicts.go +++ b/service/codecommit/api_op_BatchDescribeMergeConflicts.go @@ -64,8 +64,15 @@ type BatchDescribeMergeConflictsInput struct { // This member is required. DestinationCommitSpecifier *string - // The maximum number of merge hunks to include in the output. - MaxMergeHunks *int32 + // The merge option or strategy you want to use to merge the code. + // + // This member is required. + MergeOption types.MergeOptionTypeEnum + + // The name of the repository that contains the merge conflicts you want to review. + // + // This member is required. + RepositoryName *string // The branch, tag, HEAD, or other fully qualified reference used to identify a // commit (for example, a branch name or a full commit ID). @@ -79,64 +86,57 @@ type BatchDescribeMergeConflictsInput struct { // mergeable if the same file in both branches has differences on the same line. ConflictDetailLevel types.ConflictDetailLevelTypeEnum - // An enumeration token that, when provided in a request, returns the next batch of - // the results. - NextToken *string - - // The merge option or strategy you want to use to merge the code. - // - // This member is required. - MergeOption types.MergeOptionTypeEnum - - // The name of the repository that contains the merge conflicts you want to review. - // - // This member is required. - RepositoryName *string - // Specifies which branch to use when resolving conflicts, or whether to attempt // automatically merging two versions of a file. The default is NONE, which // requires any conflicts to be resolved manually before the merge operation is // successful. ConflictResolutionStrategy types.ConflictResolutionStrategyTypeEnum - // The maximum number of files to include in the output. - MaxConflictFiles *int32 - // The path of the target files used to describe the conflicts. If not specified, // the default is all conflict files. FilePaths []*string + + // The maximum number of files to include in the output. + MaxConflictFiles *int32 + + // The maximum number of merge hunks to include in the output. + MaxMergeHunks *int32 + + // An enumeration token that, when provided in a request, returns the next batch of + // the results. + NextToken *string } type BatchDescribeMergeConflictsOutput struct { - // The commit ID of the merge base. - BaseCommitId *string - // A list of conflicts for each file, including the conflict metadata and the hunks // of the differences between the files. // // This member is required. Conflicts []*types.Conflict + // The commit ID of the destination commit specifier that was used in the merge + // evaluation. + // + // This member is required. + DestinationCommitId *string + // The commit ID of the source commit specifier that was used in the merge // evaluation. // // This member is required. SourceCommitId *string - // An enumeration token that can be used in a request to return the next batch of - // the results. - NextToken *string + // The commit ID of the merge base. + BaseCommitId *string // A list of any errors returned while describing the merge conflicts for each // file. Errors []*types.BatchDescribeMergeConflictsError - // The commit ID of the destination commit specifier that was used in the merge - // evaluation. - // - // This member is required. - DestinationCommitId *string + // An enumeration token that can be used in a request to return the next batch of + // the results. + NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/codecommit/api_op_BatchDisassociateApprovalRuleTemplateFromRepositories.go b/service/codecommit/api_op_BatchDisassociateApprovalRuleTemplateFromRepositories.go index bba983a8281..bf16adf119f 100644 --- a/service/codecommit/api_op_BatchDisassociateApprovalRuleTemplateFromRepositories.go +++ b/service/codecommit/api_op_BatchDisassociateApprovalRuleTemplateFromRepositories.go @@ -58,18 +58,18 @@ func (c *Client) BatchDisassociateApprovalRuleTemplateFromRepositories(ctx conte type BatchDisassociateApprovalRuleTemplateFromRepositoriesInput struct { + // The name of the template that you want to disassociate from one or more + // repositories. + // + // This member is required. + ApprovalRuleTemplateName *string + // The repository names that you want to disassociate from the approval rule // template. The length constraint limit is for each string in the array. The array // itself can be empty. // // This member is required. RepositoryNames []*string - - // The name of the template that you want to disassociate from one or more - // repositories. - // - // This member is required. - ApprovalRuleTemplateName *string } type BatchDisassociateApprovalRuleTemplateFromRepositoriesOutput struct { diff --git a/service/codecommit/api_op_BatchGetCommits.go b/service/codecommit/api_op_BatchGetCommits.go index 9b329c5bbb5..535a4f02237 100644 --- a/service/codecommit/api_op_BatchGetCommits.go +++ b/service/codecommit/api_op_BatchGetCommits.go @@ -57,16 +57,16 @@ func (c *Client) BatchGetCommits(ctx context.Context, params *BatchGetCommitsInp type BatchGetCommitsInput struct { - // The name of the repository that contains the commits. - // - // This member is required. - RepositoryName *string - // The full commit IDs of the commits to get information about. You must supply the // full SHA IDs of each commit. You cannot use shortened SHA IDs. // // This member is required. CommitIds []*string + + // The name of the repository that contains the commits. + // + // This member is required. + RepositoryName *string } type BatchGetCommitsOutput struct { diff --git a/service/codecommit/api_op_BatchGetRepositories.go b/service/codecommit/api_op_BatchGetRepositories.go index d1feb481a2c..cebf08961e4 100644 --- a/service/codecommit/api_op_BatchGetRepositories.go +++ b/service/codecommit/api_op_BatchGetRepositories.go @@ -73,12 +73,12 @@ type BatchGetRepositoriesInput struct { // Represents the output of a batch get repositories operation. type BatchGetRepositoriesOutput struct { - // Returns a list of repository names for which information could not be found. - RepositoriesNotFound []*string - // A list of repositories returned by the batch get repositories operation. Repositories []*types.RepositoryMetadata + // Returns a list of repository names for which information could not be found. + RepositoriesNotFound []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codecommit/api_op_CreateApprovalRuleTemplate.go b/service/codecommit/api_op_CreateApprovalRuleTemplate.go index 72909310254..24cf98f838b 100644 --- a/service/codecommit/api_op_CreateApprovalRuleTemplate.go +++ b/service/codecommit/api_op_CreateApprovalRuleTemplate.go @@ -61,18 +61,6 @@ func (c *Client) CreateApprovalRuleTemplate(ctx context.Context, params *CreateA type CreateApprovalRuleTemplateInput struct { - // The name of the approval rule template. Provide descriptive names, because this - // name is applied to the approval rules created automatically in associated - // repositories. - // - // This member is required. - ApprovalRuleTemplateName *string - - // The description of the approval rule template. Consider providing a description - // that explains what this template does and when it might be appropriate to - // associate it with repositories. - ApprovalRuleTemplateDescription *string - // The content of the approval rule that is created on pull requests in associated // repositories. If you specify one or more destination references (branches), // approval rules are created in an associated repository only if their destination @@ -111,6 +99,18 @@ type CreateApprovalRuleTemplateInput struct { // // This member is required. ApprovalRuleTemplateContent *string + + // The name of the approval rule template. Provide descriptive names, because this + // name is applied to the approval rules created automatically in associated + // repositories. + // + // This member is required. + ApprovalRuleTemplateName *string + + // The description of the approval rule template. Consider providing a description + // that explains what this template does and when it might be appropriate to + // associate it with repositories. + ApprovalRuleTemplateDescription *string } type CreateApprovalRuleTemplateOutput struct { diff --git a/service/codecommit/api_op_CreateBranch.go b/service/codecommit/api_op_CreateBranch.go index 15357ab00e8..e2bc8c98a29 100644 --- a/service/codecommit/api_op_CreateBranch.go +++ b/service/codecommit/api_op_CreateBranch.go @@ -59,15 +59,15 @@ func (c *Client) CreateBranch(ctx context.Context, params *CreateBranchInput, op // Represents the input of a create branch operation. type CreateBranchInput struct { - // The ID of the commit to point the new branch to. + // The name of the new branch to create. // // This member is required. - CommitId *string + BranchName *string - // The name of the new branch to create. + // The ID of the commit to point the new branch to. // // This member is required. - BranchName *string + CommitId *string // The name of the repository in which you want to create the new branch. // diff --git a/service/codecommit/api_op_CreateCommit.go b/service/codecommit/api_op_CreateCommit.go index 2d05e12d01f..122020a2ef2 100644 --- a/service/codecommit/api_op_CreateCommit.go +++ b/service/codecommit/api_op_CreateCommit.go @@ -57,28 +57,11 @@ func (c *Client) CreateCommit(ctx context.Context, params *CreateCommitInput, op type CreateCommitInput struct { - // The commit message you want to include in the commit. Commit messages are - // limited to 256 KB. If no message is specified, a default message is used. - CommitMessage *string - - // The ID of the commit that is the parent of the commit you create. Not required - // if this is an empty repository. - ParentCommitId *string - - // The files to add or update in this commit. - PutFiles []*types.PutFileEntry - // The name of the branch where you create the commit. // // This member is required. BranchName *string - // The email address of the person who created the commit. - Email *string - - // The file modes to update for files in this commit. - SetFileModes []*types.SetFileModeEntry - // The name of the repository where you create the commit. // // This member is required. @@ -88,28 +71,45 @@ type CreateCommitInput struct { // the author and committer for the commit. AuthorName *string + // The commit message you want to include in the commit. Commit messages are + // limited to 256 KB. If no message is specified, a default message is used. + CommitMessage *string + // The files to delete in this commit. These files still exist in earlier commits. DeleteFiles []*types.DeleteFileEntry + // The email address of the person who created the commit. + Email *string + // If the commit contains deletions, whether to keep a folder or folder structure // if the changes leave the folders empty. If true, a ..gitkeep file is created for // empty folders. The default is false. KeepEmptyFolders *bool + + // The ID of the commit that is the parent of the commit you create. Not required + // if this is an empty repository. + ParentCommitId *string + + // The files to add or update in this commit. + PutFiles []*types.PutFileEntry + + // The file modes to update for files in this commit. + SetFileModes []*types.SetFileModeEntry } type CreateCommitOutput struct { + // The full commit ID of the commit that contains your committed file changes. + CommitId *string + // The files added as part of the committed file changes. FilesAdded []*types.FileMetadata - // The files updated as part of the commited file changes. - FilesUpdated []*types.FileMetadata - // The files deleted as part of the committed file changes. FilesDeleted []*types.FileMetadata - // The full commit ID of the commit that contains your committed file changes. - CommitId *string + // The files updated as part of the commited file changes. + FilesUpdated []*types.FileMetadata // The full SHA-1 pointer of the tree information for the commit that contains the // commited file changes. diff --git a/service/codecommit/api_op_CreatePullRequest.go b/service/codecommit/api_op_CreatePullRequest.go index 369f2448289..3a847f60dea 100644 --- a/service/codecommit/api_op_CreatePullRequest.go +++ b/service/codecommit/api_op_CreatePullRequest.go @@ -59,6 +59,14 @@ func (c *Client) CreatePullRequest(ctx context.Context, params *CreatePullReques type CreatePullRequestInput struct { + // The targets for the pull request, including the source of the code to be + // reviewed (the source branch) and the destination where the creator of the pull + // request intends the code to be merged after the pull request is closed (the + // destination branch). + // + // This member is required. + Targets []*types.Target + // The title of the pull request. This title is used to identify the pull request // to other users in the repository. // @@ -75,14 +83,6 @@ type CreatePullRequestInput struct { // A description of the pull request. Description *string - - // The targets for the pull request, including the source of the code to be - // reviewed (the source branch) and the destination where the creator of the pull - // request intends the code to be merged after the pull request is closed (the - // destination branch). - // - // This member is required. - Targets []*types.Target } type CreatePullRequestOutput struct { diff --git a/service/codecommit/api_op_CreatePullRequestApprovalRule.go b/service/codecommit/api_op_CreatePullRequestApprovalRule.go index c73189269d3..bc3006c7348 100644 --- a/service/codecommit/api_op_CreatePullRequestApprovalRule.go +++ b/service/codecommit/api_op_CreatePullRequestApprovalRule.go @@ -57,12 +57,6 @@ func (c *Client) CreatePullRequestApprovalRule(ctx context.Context, params *Crea type CreatePullRequestApprovalRuleInput struct { - // The system-generated ID of the pull request for which you want to create the - // approval rule. - // - // This member is required. - PullRequestId *string - // The content of the approval rule, including the number of approvals needed and // the structure of an approval pool defined for approvals, if any. For more // information about approval pools, see the AWS CodeCommit User Guide. When you @@ -105,6 +99,12 @@ type CreatePullRequestApprovalRuleInput struct { // // This member is required. ApprovalRuleName *string + + // The system-generated ID of the pull request for which you want to create the + // approval rule. + // + // This member is required. + PullRequestId *string } type CreatePullRequestApprovalRuleOutput struct { diff --git a/service/codecommit/api_op_CreateRepository.go b/service/codecommit/api_op_CreateRepository.go index a4a1e0ff6d7..6e077548809 100644 --- a/service/codecommit/api_op_CreateRepository.go +++ b/service/codecommit/api_op_CreateRepository.go @@ -58,14 +58,6 @@ func (c *Client) CreateRepository(ctx context.Context, params *CreateRepositoryI // Represents the input of a create repository operation. type CreateRepositoryInput struct { - // A comment or description about the new repository. The description field for a - // repository accepts all HTML characters and all valid Unicode characters. - // Applications that do not HTML-encode the description and display it in a webpage - // can expose users to potentially malicious code. Make sure that you HTML-encode - // the description field in any application that uses this API to display the - // repository description on a webpage. - RepositoryDescription *string - // The name of the new repository to be created. The repository name must be unique // across the calling AWS account. Repository names are limited to 100 // alphanumeric, dash, and underscore characters, and cannot include certain @@ -76,6 +68,14 @@ type CreateRepositoryInput struct { // This member is required. RepositoryName *string + // A comment or description about the new repository. The description field for a + // repository accepts all HTML characters and all valid Unicode characters. + // Applications that do not HTML-encode the description and display it in a webpage + // can expose users to potentially malicious code. Make sure that you HTML-encode + // the description field in any application that uses this API to display the + // repository description on a webpage. + RepositoryDescription *string + // One or more tag key-value pairs to use when tagging this repository. Tags map[string]*string } diff --git a/service/codecommit/api_op_CreateUnreferencedMergeCommit.go b/service/codecommit/api_op_CreateUnreferencedMergeCommit.go index 7c9d5679bac..fba97b596d4 100644 --- a/service/codecommit/api_op_CreateUnreferencedMergeCommit.go +++ b/service/codecommit/api_op_CreateUnreferencedMergeCommit.go @@ -63,42 +63,35 @@ func (c *Client) CreateUnreferencedMergeCommit(ctx context.Context, params *Crea type CreateUnreferencedMergeCommitInput struct { - // The name of the repository where you want to create the unreferenced merge - // commit. + // The branch, tag, HEAD, or other fully qualified reference used to identify a + // commit (for example, a branch name or a full commit ID). // // This member is required. - RepositoryName *string - - // The commit message for the unreferenced commit. - CommitMessage *string + DestinationCommitSpecifier *string // The merge option or strategy you want to use to merge the code. // // This member is required. MergeOption types.MergeOptionTypeEnum + // The name of the repository where you want to create the unreferenced merge + // commit. + // + // This member is required. + RepositoryName *string + // The branch, tag, HEAD, or other fully qualified reference used to identify a // commit (for example, a branch name or a full commit ID). // // This member is required. - DestinationCommitSpecifier *string - - // The email address for the person who created the unreferenced commit. - Email *string - - // If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when - // resolving conflicts during a merge. - ConflictResolution *types.ConflictResolution + SourceCommitSpecifier *string // The name of the author who created the unreferenced commit. This information is // used as both the author and committer for the commit. AuthorName *string - // Specifies which branch to use when resolving conflicts, or whether to attempt - // automatically merging two versions of a file. The default is NONE, which - // requires any conflicts to be resolved manually before the merge operation is - // successful. - ConflictResolutionStrategy types.ConflictResolutionStrategyTypeEnum + // The commit message for the unreferenced commit. + CommitMessage *string // The level of conflict detail to use. If unspecified, the default FILE_LEVEL is // used, which returns a not-mergeable result if the same file has differences in @@ -106,11 +99,18 @@ type CreateUnreferencedMergeCommitInput struct { // mergeable if the same file in both branches has differences on the same line. ConflictDetailLevel types.ConflictDetailLevelTypeEnum - // The branch, tag, HEAD, or other fully qualified reference used to identify a - // commit (for example, a branch name or a full commit ID). - // - // This member is required. - SourceCommitSpecifier *string + // If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when + // resolving conflicts during a merge. + ConflictResolution *types.ConflictResolution + + // Specifies which branch to use when resolving conflicts, or whether to attempt + // automatically merging two versions of a file. The default is NONE, which + // requires any conflicts to be resolved manually before the merge operation is + // successful. + ConflictResolutionStrategy types.ConflictResolutionStrategyTypeEnum + + // The email address for the person who created the unreferenced commit. + Email *string // If the commit contains deletions, whether to keep a folder or folder structure // if the changes leave the folders empty. If this is specified as true, a .gitkeep diff --git a/service/codecommit/api_op_DeleteBranch.go b/service/codecommit/api_op_DeleteBranch.go index d0a0033c3ee..61dff59ba9c 100644 --- a/service/codecommit/api_op_DeleteBranch.go +++ b/service/codecommit/api_op_DeleteBranch.go @@ -59,15 +59,15 @@ func (c *Client) DeleteBranch(ctx context.Context, params *DeleteBranchInput, op // Represents the input of a delete branch operation. type DeleteBranchInput struct { - // The name of the repository that contains the branch to be deleted. + // The name of the branch to delete. // // This member is required. - RepositoryName *string + BranchName *string - // The name of the branch to delete. + // The name of the repository that contains the branch to be deleted. // // This member is required. - BranchName *string + RepositoryName *string } // Represents the output of a delete branch operation. diff --git a/service/codecommit/api_op_DeleteFile.go b/service/codecommit/api_op_DeleteFile.go index 4770930e2c2..1940bfd0a0f 100644 --- a/service/codecommit/api_op_DeleteFile.go +++ b/service/codecommit/api_op_DeleteFile.go @@ -58,9 +58,10 @@ func (c *Client) DeleteFile(ctx context.Context, params *DeleteFileInput, optFns type DeleteFileInput struct { - // The email address for the commit that deletes the file. If no email address is - // specified, the email address is left blank. - Email *string + // The name of the branch where the commit that deletes the file is made. + // + // This member is required. + BranchName *string // The fully qualified path to the file that to be deleted, including the full name // and extension of that file. For example, /examples/file.md is a fully qualified @@ -69,6 +70,13 @@ type DeleteFileInput struct { // This member is required. FilePath *string + // The ID of the commit that is the tip of the branch where you want to create the + // commit that deletes the file. This must be the HEAD commit for the branch. The + // commit that deletes the file is created from this commit ID. + // + // This member is required. + ParentCommitId *string + // The name of the repository that contains the file to delete. // // This member is required. @@ -79,21 +87,9 @@ type DeleteFileInput struct { // used. CommitMessage *string - // The name of the author of the commit that deletes the file. If no name is - // specified, the user's ARN is used as the author name and committer name. - Name *string - - // The name of the branch where the commit that deletes the file is made. - // - // This member is required. - BranchName *string - - // The ID of the commit that is the tip of the branch where you want to create the - // commit that deletes the file. This must be the HEAD commit for the branch. The - // commit that deletes the file is created from this commit ID. - // - // This member is required. - ParentCommitId *string + // The email address for the commit that deletes the file. If no email address is + // specified, the email address is left blank. + Email *string // If a file is the only object in the folder or directory, specifies whether to // delete the folder or directory that contains the file. By default, empty folders @@ -102,6 +98,10 @@ type DeleteFileInput struct { // and dir3 are empty, deleting the last file in dir4 also deletes the empty // folders dir4, dir3, and dir2. KeepEmptyFolders *bool + + // The name of the author of the commit that deletes the file. If no name is + // specified, the user's ARN is used as the author name and committer name. + Name *string } type DeleteFileOutput struct { diff --git a/service/codecommit/api_op_DeletePullRequestApprovalRule.go b/service/codecommit/api_op_DeletePullRequestApprovalRule.go index b6a9807dcae..f4a9c489a60 100644 --- a/service/codecommit/api_op_DeletePullRequestApprovalRule.go +++ b/service/codecommit/api_op_DeletePullRequestApprovalRule.go @@ -61,16 +61,16 @@ func (c *Client) DeletePullRequestApprovalRule(ctx context.Context, params *Dele type DeletePullRequestApprovalRuleInput struct { - // The system-generated ID of the pull request that contains the approval rule you - // want to delete. + // The name of the approval rule you want to delete. // // This member is required. - PullRequestId *string + ApprovalRuleName *string - // The name of the approval rule you want to delete. + // The system-generated ID of the pull request that contains the approval rule you + // want to delete. // // This member is required. - ApprovalRuleName *string + PullRequestId *string } type DeletePullRequestApprovalRuleOutput struct { diff --git a/service/codecommit/api_op_DescribeMergeConflicts.go b/service/codecommit/api_op_DescribeMergeConflicts.go index 2ca1cdeb34d..4cf259fa236 100644 --- a/service/codecommit/api_op_DescribeMergeConflicts.go +++ b/service/codecommit/api_op_DescribeMergeConflicts.go @@ -60,6 +60,17 @@ func (c *Client) DescribeMergeConflicts(ctx context.Context, params *DescribeMer type DescribeMergeConflictsInput struct { + // The branch, tag, HEAD, or other fully qualified reference used to identify a + // commit (for example, a branch name or a full commit ID). + // + // This member is required. + DestinationCommitSpecifier *string + + // The path of the target files used to describe the conflicts. + // + // This member is required. + FilePath *string + // The merge option or strategy you want to use to merge the code. // // This member is required. @@ -71,16 +82,11 @@ type DescribeMergeConflictsInput struct { // This member is required. RepositoryName *string - // The path of the target files used to describe the conflicts. - // - // This member is required. - FilePath *string - // The branch, tag, HEAD, or other fully qualified reference used to identify a // commit (for example, a branch name or a full commit ID). // // This member is required. - DestinationCommitSpecifier *string + SourceCommitSpecifier *string // The level of conflict detail to use. If unspecified, the default FILE_LEVEL is // used, which returns a not-mergeable result if the same file has differences in @@ -88,21 +94,15 @@ type DescribeMergeConflictsInput struct { // mergeable if the same file in both branches has differences on the same line. ConflictDetailLevel types.ConflictDetailLevelTypeEnum - // The branch, tag, HEAD, or other fully qualified reference used to identify a - // commit (for example, a branch name or a full commit ID). - // - // This member is required. - SourceCommitSpecifier *string - - // The maximum number of merge hunks to include in the output. - MaxMergeHunks *int32 - // Specifies which branch to use when resolving conflicts, or whether to attempt // automatically merging two versions of a file. The default is NONE, which // requires any conflicts to be resolved manually before the merge operation is // successful. ConflictResolutionStrategy types.ConflictResolutionStrategyTypeEnum + // The maximum number of merge hunks to include in the output. + MaxMergeHunks *int32 + // An enumeration token that, when provided in a request, returns the next batch of // the results. NextToken *string @@ -110,12 +110,22 @@ type DescribeMergeConflictsInput struct { type DescribeMergeConflictsOutput struct { + // Contains metadata about the conflicts found in the merge. + // + // This member is required. + ConflictMetadata *types.ConflictMetadata + // The commit ID of the destination commit specifier that was used in the merge // evaluation. // // This member is required. DestinationCommitId *string + // A list of merge hunks of the differences between the files or lines. + // + // This member is required. + MergeHunks []*types.MergeHunk + // The commit ID of the source commit specifier that was used in the merge // evaluation. // @@ -125,20 +135,10 @@ type DescribeMergeConflictsOutput struct { // The commit ID of the merge base. BaseCommitId *string - // Contains metadata about the conflicts found in the merge. - // - // This member is required. - ConflictMetadata *types.ConflictMetadata - // An enumeration token that can be used in a request to return the next batch of // the results. NextToken *string - // A list of merge hunks of the differences between the files or lines. - // - // This member is required. - MergeHunks []*types.MergeHunk - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codecommit/api_op_DescribePullRequestEvents.go b/service/codecommit/api_op_DescribePullRequestEvents.go index d3f1b4f7a51..84295bd8930 100644 --- a/service/codecommit/api_op_DescribePullRequestEvents.go +++ b/service/codecommit/api_op_DescribePullRequestEvents.go @@ -57,29 +57,29 @@ func (c *Client) DescribePullRequestEvents(ctx context.Context, params *Describe type DescribePullRequestEventsInput struct { - // An enumeration token that, when provided in a request, returns the next batch of - // the results. - NextToken *string + // The system-generated ID of the pull request. To get this ID, use + // ListPullRequests (). + // + // This member is required. + PullRequestId *string // The Amazon Resource Name (ARN) of the user whose actions resulted in the event. // Examples include updating the pull request with more commits or changing the // status of a pull request. ActorArn *string - // Optional. The pull request event type about which you want to return - // information. - PullRequestEventType types.PullRequestEventType - // A non-zero, non-negative integer used to limit the number of returned results. // The default is 100 events, which is also the maximum number of events that can // be returned in a result. MaxResults *int32 - // The system-generated ID of the pull request. To get this ID, use - // ListPullRequests (). - // - // This member is required. - PullRequestId *string + // An enumeration token that, when provided in a request, returns the next batch of + // the results. + NextToken *string + + // Optional. The pull request event type about which you want to return + // information. + PullRequestEventType types.PullRequestEventType } type DescribePullRequestEventsOutput struct { diff --git a/service/codecommit/api_op_EvaluatePullRequestApprovalRules.go b/service/codecommit/api_op_EvaluatePullRequestApprovalRules.go index 1e86099c13e..c22cb617e35 100644 --- a/service/codecommit/api_op_EvaluatePullRequestApprovalRules.go +++ b/service/codecommit/api_op_EvaluatePullRequestApprovalRules.go @@ -58,16 +58,16 @@ func (c *Client) EvaluatePullRequestApprovalRules(ctx context.Context, params *E type EvaluatePullRequestApprovalRulesInput struct { - // The system-generated ID for the pull request revision. To retrieve the most - // recent revision ID for a pull request, use GetPullRequest (). + // The system-generated ID of the pull request you want to evaluate. // // This member is required. - RevisionId *string + PullRequestId *string - // The system-generated ID of the pull request you want to evaluate. + // The system-generated ID for the pull request revision. To retrieve the most + // recent revision ID for a pull request, use GetPullRequest (). // // This member is required. - PullRequestId *string + RevisionId *string } type EvaluatePullRequestApprovalRulesOutput struct { diff --git a/service/codecommit/api_op_GetBranch.go b/service/codecommit/api_op_GetBranch.go index 09547d16cde..ce0f1a9b5e9 100644 --- a/service/codecommit/api_op_GetBranch.go +++ b/service/codecommit/api_op_GetBranch.go @@ -58,12 +58,12 @@ func (c *Client) GetBranch(ctx context.Context, params *GetBranchInput, optFns . // Represents the input of a get branch operation. type GetBranchInput struct { + // The name of the branch for which you want to retrieve information. + BranchName *string + // The name of the repository that contains the branch for which you want to // retrieve information. RepositoryName *string - - // The name of the branch for which you want to retrieve information. - BranchName *string } // Represents the output of a get branch operation. diff --git a/service/codecommit/api_op_GetCommentReactions.go b/service/codecommit/api_op_GetCommentReactions.go index 7983d4570a7..d91bda4cb8a 100644 --- a/service/codecommit/api_op_GetCommentReactions.go +++ b/service/codecommit/api_op_GetCommentReactions.go @@ -63,10 +63,6 @@ type GetCommentReactionsInput struct { // This member is required. CommentId *string - // Optional. The Amazon Resource Name (ARN) of the user or identity for which you - // want to get reaction information. - ReactionUserArn *string - // A non-zero, non-negative integer used to limit the number of returned results. // The default is the same as the allowed maximum, 1,000. MaxResults *int32 @@ -74,6 +70,10 @@ type GetCommentReactionsInput struct { // An enumeration token that, when provided in a request, returns the next batch of // the results. NextToken *string + + // Optional. The Amazon Resource Name (ARN) of the user or identity for which you + // want to get reaction information. + ReactionUserArn *string } type GetCommentReactionsOutput struct { diff --git a/service/codecommit/api_op_GetCommentsForComparedCommit.go b/service/codecommit/api_op_GetCommentsForComparedCommit.go index e4fb40552d2..2c68afb991b 100644 --- a/service/codecommit/api_op_GetCommentsForComparedCommit.go +++ b/service/codecommit/api_op_GetCommentsForComparedCommit.go @@ -60,18 +60,6 @@ func (c *Client) GetCommentsForComparedCommit(ctx context.Context, params *GetCo type GetCommentsForComparedCommitInput struct { - // To establish the directionality of the comparison, the full commit ID of the - // before commit. - BeforeCommitId *string - - // An enumeration token that when provided in a request, returns the next batch of - // the results. - NextToken *string - - // A non-zero, non-negative integer used to limit the number of returned results. - // The default is 100 comments, but you can configure up to 500. - MaxResults *int32 - // To establish the directionality of the comparison, the full commit ID of the // after commit. // @@ -82,6 +70,18 @@ type GetCommentsForComparedCommitInput struct { // // This member is required. RepositoryName *string + + // To establish the directionality of the comparison, the full commit ID of the + // before commit. + BeforeCommitId *string + + // A non-zero, non-negative integer used to limit the number of returned results. + // The default is 100 comments, but you can configure up to 500. + MaxResults *int32 + + // An enumeration token that when provided in a request, returns the next batch of + // the results. + NextToken *string } type GetCommentsForComparedCommitOutput struct { diff --git a/service/codecommit/api_op_GetCommentsForPullRequest.go b/service/codecommit/api_op_GetCommentsForPullRequest.go index 73da95be164..ddba031f7e9 100644 --- a/service/codecommit/api_op_GetCommentsForPullRequest.go +++ b/service/codecommit/api_op_GetCommentsForPullRequest.go @@ -59,28 +59,28 @@ func (c *Client) GetCommentsForPullRequest(ctx context.Context, params *GetComme type GetCommentsForPullRequestInput struct { - // The full commit ID of the commit in the destination branch that was the tip of - // the branch at the time the pull request was created. - BeforeCommitId *string + // The system-generated ID of the pull request. To get this ID, use + // ListPullRequests (). + // + // This member is required. + PullRequestId *string // The full commit ID of the commit in the source branch that was the tip of the // branch at the time the comment was made. AfterCommitId *string - // An enumeration token that, when provided in a request, returns the next batch of - // the results. - NextToken *string + // The full commit ID of the commit in the destination branch that was the tip of + // the branch at the time the pull request was created. + BeforeCommitId *string // A non-zero, non-negative integer used to limit the number of returned results. // The default is 100 comments. You can return up to 500 comments with a single // request. MaxResults *int32 - // The system-generated ID of the pull request. To get this ID, use - // ListPullRequests (). - // - // This member is required. - PullRequestId *string + // An enumeration token that, when provided in a request, returns the next batch of + // the results. + NextToken *string // The name of the repository that contains the pull request. RepositoryName *string diff --git a/service/codecommit/api_op_GetCommit.go b/service/codecommit/api_op_GetCommit.go index 8c01d81b74d..6fb5afded4b 100644 --- a/service/codecommit/api_op_GetCommit.go +++ b/service/codecommit/api_op_GetCommit.go @@ -59,15 +59,15 @@ func (c *Client) GetCommit(ctx context.Context, params *GetCommitInput, optFns . // Represents the input of a get commit operation. type GetCommitInput struct { - // The name of the repository to which the commit was made. + // The commit ID. Commit IDs are the full SHA ID of the commit. // // This member is required. - RepositoryName *string + CommitId *string - // The commit ID. Commit IDs are the full SHA ID of the commit. + // The name of the repository to which the commit was made. // // This member is required. - CommitId *string + RepositoryName *string } // Represents the output of a get commit operation. diff --git a/service/codecommit/api_op_GetDifferences.go b/service/codecommit/api_op_GetDifferences.go index 3a943b1e32e..f7921cf2491 100644 --- a/service/codecommit/api_op_GetDifferences.go +++ b/service/codecommit/api_op_GetDifferences.go @@ -59,9 +59,21 @@ func (c *Client) GetDifferences(ctx context.Context, params *GetDifferencesInput type GetDifferencesInput struct { - // An enumeration token that, when provided in a request, returns the next batch of - // the results. - NextToken *string + // The branch, tag, HEAD, or other fully qualified reference used to identify a + // commit. + // + // This member is required. + AfterCommitSpecifier *string + + // The name of the repository where you want to get differences. + // + // This member is required. + RepositoryName *string + + // The file path in which to check differences. Limits the results to this path. + // Can also be used to specify the changed name of a directory or folder, if it has + // changed. If not specified, differences are shown for all paths. + AfterPath *string // The branch, tag, HEAD, or other fully qualified reference used to identify a // commit (for example, the full commit ID). Optional. If not specified, all @@ -75,36 +87,24 @@ type GetDifferencesInput struct { // beforePath and afterPath are not specified, differences are shown for all paths. BeforePath *string - // The name of the repository where you want to get differences. - // - // This member is required. - RepositoryName *string - // A non-zero, non-negative integer used to limit the number of returned results. MaxResults *int32 - // The branch, tag, HEAD, or other fully qualified reference used to identify a - // commit. - // - // This member is required. - AfterCommitSpecifier *string - - // The file path in which to check differences. Limits the results to this path. - // Can also be used to specify the changed name of a directory or folder, if it has - // changed. If not specified, differences are shown for all paths. - AfterPath *string + // An enumeration token that, when provided in a request, returns the next batch of + // the results. + NextToken *string } type GetDifferencesOutput struct { - // An enumeration token that can be used in a request to return the next batch of - // the results. - NextToken *string - // A data type object that contains information about the differences, including // whether the difference is added, modified, or deleted (A, D, M). Differences []*types.Difference + // An enumeration token that can be used in a request to return the next batch of + // the results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codecommit/api_op_GetFile.go b/service/codecommit/api_op_GetFile.go index d7a79123115..8c3f21e89a2 100644 --- a/service/codecommit/api_op_GetFile.go +++ b/service/codecommit/api_op_GetFile.go @@ -57,6 +57,13 @@ func (c *Client) GetFile(ctx context.Context, params *GetFileInput, optFns ...fu type GetFileInput struct { + // The fully qualified path to the file, including the full name and extension of + // the file. For example, /examples/file.md is the fully qualified path to a file + // named file.md in a folder named examples. + // + // This member is required. + FilePath *string + // The name of the repository that contains the file. // // This member is required. @@ -67,26 +74,19 @@ type GetFileInput struct { // reference such as refs/heads/master. If none is provided, the head commit is // used. CommitSpecifier *string - - // The fully qualified path to the file, including the full name and extension of - // the file. For example, /examples/file.md is the fully qualified path to a file - // named file.md in a folder named examples. - // - // This member is required. - FilePath *string } type GetFileOutput struct { - // The full commit ID of the commit that contains the content returned by GetFile. + // The blob ID of the object that represents the file content. // // This member is required. - CommitId *string + BlobId *string - // The blob ID of the object that represents the file content. + // The full commit ID of the commit that contains the content returned by GetFile. // // This member is required. - BlobId *string + CommitId *string // The base-64 encoded binary data object that represents the content of the file. // diff --git a/service/codecommit/api_op_GetFolder.go b/service/codecommit/api_op_GetFolder.go index e12fb40e302..3464e6aa200 100644 --- a/service/codecommit/api_op_GetFolder.go +++ b/service/codecommit/api_op_GetFolder.go @@ -78,9 +78,11 @@ type GetFolderInput struct { type GetFolderOutput struct { - // The full SHA-1 pointer of the tree information for the commit that contains the - // folder. - TreeId *string + // The full commit ID used as a reference for the returned version of the folder + // content. + // + // This member is required. + CommitId *string // The fully qualified path of the folder whose contents are returned. // @@ -90,11 +92,8 @@ type GetFolderOutput struct { // The list of files in the specified folder, if any. Files []*types.File - // The full commit ID used as a reference for the returned version of the folder - // content. - // - // This member is required. - CommitId *string + // The list of folders that exist under the specified folder, if any. + SubFolders []*types.Folder // The list of submodules in the specified folder, if any. SubModules []*types.SubModule @@ -103,8 +102,9 @@ type GetFolderOutput struct { // if any. SymbolicLinks []*types.SymbolicLink - // The list of folders that exist under the specified folder, if any. - SubFolders []*types.Folder + // The full SHA-1 pointer of the tree information for the commit that contains the + // folder. + TreeId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/codecommit/api_op_GetMergeCommit.go b/service/codecommit/api_op_GetMergeCommit.go index 28b3807a97c..ea1167c4087 100644 --- a/service/codecommit/api_op_GetMergeCommit.go +++ b/service/codecommit/api_op_GetMergeCommit.go @@ -57,24 +57,6 @@ func (c *Client) GetMergeCommit(ctx context.Context, params *GetMergeCommitInput type GetMergeCommitInput struct { - // Specifies which branch to use when resolving conflicts, or whether to attempt - // automatically merging two versions of a file. The default is NONE, which - // requires any conflicts to be resolved manually before the merge operation is - // successful. - ConflictResolutionStrategy types.ConflictResolutionStrategyTypeEnum - - // The level of conflict detail to use. If unspecified, the default FILE_LEVEL is - // used, which returns a not-mergeable result if the same file has differences in - // both branches. If LINE_LEVEL is specified, a conflict is considered not - // mergeable if the same file in both branches has differences on the same line. - ConflictDetailLevel types.ConflictDetailLevelTypeEnum - - // The branch, tag, HEAD, or other fully qualified reference used to identify a - // commit (for example, a branch name or a full commit ID). - // - // This member is required. - SourceCommitSpecifier *string - // The branch, tag, HEAD, or other fully qualified reference used to identify a // commit (for example, a branch name or a full commit ID). // @@ -86,21 +68,39 @@ type GetMergeCommitInput struct { // // This member is required. RepositoryName *string + + // The branch, tag, HEAD, or other fully qualified reference used to identify a + // commit (for example, a branch name or a full commit ID). + // + // This member is required. + SourceCommitSpecifier *string + + // The level of conflict detail to use. If unspecified, the default FILE_LEVEL is + // used, which returns a not-mergeable result if the same file has differences in + // both branches. If LINE_LEVEL is specified, a conflict is considered not + // mergeable if the same file in both branches has differences on the same line. + ConflictDetailLevel types.ConflictDetailLevelTypeEnum + + // Specifies which branch to use when resolving conflicts, or whether to attempt + // automatically merging two versions of a file. The default is NONE, which + // requires any conflicts to be resolved manually before the merge operation is + // successful. + ConflictResolutionStrategy types.ConflictResolutionStrategyTypeEnum } type GetMergeCommitOutput struct { - // The commit ID for the merge commit created when the source branch was merged - // into the destination branch. If the fast-forward merge strategy was used, there - // is no merge commit. - MergedCommitId *string + // The commit ID of the merge base. + BaseCommitId *string // The commit ID of the destination commit specifier that was used in the merge // evaluation. DestinationCommitId *string - // The commit ID of the merge base. - BaseCommitId *string + // The commit ID for the merge commit created when the source branch was merged + // into the destination branch. If the fast-forward merge strategy was used, there + // is no merge commit. + MergedCommitId *string // The commit ID of the source commit specifier that was used in the merge // evaluation. diff --git a/service/codecommit/api_op_GetMergeConflicts.go b/service/codecommit/api_op_GetMergeConflicts.go index 66da8dcedab..1e88794ceb1 100644 --- a/service/codecommit/api_op_GetMergeConflicts.go +++ b/service/codecommit/api_op_GetMergeConflicts.go @@ -58,30 +58,33 @@ func (c *Client) GetMergeConflicts(ctx context.Context, params *GetMergeConflict type GetMergeConflictsInput struct { - // An enumeration token that, when provided in a request, returns the next batch of - // the results. - NextToken *string - - // The level of conflict detail to use. If unspecified, the default FILE_LEVEL is - // used, which returns a not-mergeable result if the same file has differences in - // both branches. If LINE_LEVEL is specified, a conflict is considered not - // mergeable if the same file in both branches has differences on the same line. - ConflictDetailLevel types.ConflictDetailLevelTypeEnum - // The branch, tag, HEAD, or other fully qualified reference used to identify a // commit (for example, a branch name or a full commit ID). // // This member is required. DestinationCommitSpecifier *string + // The merge option or strategy you want to use to merge the code. + // + // This member is required. + MergeOption types.MergeOptionTypeEnum + + // The name of the repository where the pull request was created. + // + // This member is required. + RepositoryName *string + // The branch, tag, HEAD, or other fully qualified reference used to identify a // commit (for example, a branch name or a full commit ID). // // This member is required. SourceCommitSpecifier *string - // The maximum number of files to include in the output. - MaxConflictFiles *int32 + // The level of conflict detail to use. If unspecified, the default FILE_LEVEL is + // used, which returns a not-mergeable result if the same file has differences in + // both branches. If LINE_LEVEL is specified, a conflict is considered not + // mergeable if the same file in both branches has differences on the same line. + ConflictDetailLevel types.ConflictDetailLevelTypeEnum // Specifies which branch to use when resolving conflicts, or whether to attempt // automatically merging two versions of a file. The default is NONE, which @@ -89,30 +92,27 @@ type GetMergeConflictsInput struct { // successful. ConflictResolutionStrategy types.ConflictResolutionStrategyTypeEnum - // The merge option or strategy you want to use to merge the code. - // - // This member is required. - MergeOption types.MergeOptionTypeEnum + // The maximum number of files to include in the output. + MaxConflictFiles *int32 - // The name of the repository where the pull request was created. - // - // This member is required. - RepositoryName *string + // An enumeration token that, when provided in a request, returns the next batch of + // the results. + NextToken *string } type GetMergeConflictsOutput struct { - // The commit ID of the destination commit specifier that was used in the merge - // evaluation. + // A list of metadata for any conflicting files. If the specified merge strategy is + // FAST_FORWARD_MERGE, this list is always empty. // // This member is required. - DestinationCommitId *string + ConflictMetadataList []*types.ConflictMetadata - // The commit ID of the source commit specifier that was used in the merge + // The commit ID of the destination commit specifier that was used in the merge // evaluation. // // This member is required. - SourceCommitId *string + DestinationCommitId *string // A Boolean value that indicates whether the code is mergeable by the specified // merge option. @@ -120,6 +120,12 @@ type GetMergeConflictsOutput struct { // This member is required. Mergeable *bool + // The commit ID of the source commit specifier that was used in the merge + // evaluation. + // + // This member is required. + SourceCommitId *string + // The commit ID of the merge base. BaseCommitId *string @@ -127,12 +133,6 @@ type GetMergeConflictsOutput struct { // the results. NextToken *string - // A list of metadata for any conflicting files. If the specified merge strategy is - // FAST_FORWARD_MERGE, this list is always empty. - // - // This member is required. - ConflictMetadataList []*types.ConflictMetadata - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codecommit/api_op_GetMergeOptions.go b/service/codecommit/api_op_GetMergeOptions.go index 8dc4218bada..6ea68a3fb95 100644 --- a/service/codecommit/api_op_GetMergeOptions.go +++ b/service/codecommit/api_op_GetMergeOptions.go @@ -71,18 +71,18 @@ type GetMergeOptionsInput struct { // This member is required. RepositoryName *string - // The level of conflict detail to use. If unspecified, the default FILE_LEVEL is - // used, which returns a not-mergeable result if the same file has differences in - // both branches. If LINE_LEVEL is specified, a conflict is considered not - // mergeable if the same file in both branches has differences on the same line. - ConflictDetailLevel types.ConflictDetailLevelTypeEnum - // The branch, tag, HEAD, or other fully qualified reference used to identify a // commit (for example, a branch name or a full commit ID). // // This member is required. SourceCommitSpecifier *string + // The level of conflict detail to use. If unspecified, the default FILE_LEVEL is + // used, which returns a not-mergeable result if the same file has differences in + // both branches. If LINE_LEVEL is specified, a conflict is considered not + // mergeable if the same file in both branches has differences on the same line. + ConflictDetailLevel types.ConflictDetailLevelTypeEnum + // Specifies which branch to use when resolving conflicts, or whether to attempt // automatically merging two versions of a file. The default is NONE, which // requires any conflicts to be resolved manually before the merge operation is @@ -92,27 +92,27 @@ type GetMergeOptionsInput struct { type GetMergeOptionsOutput struct { - // The merge option or strategy used to merge the code. - // - // This member is required. - MergeOptions []types.MergeOptionTypeEnum - // The commit ID of the merge base. // // This member is required. BaseCommitId *string - // The commit ID of the source commit specifier that was used in the merge + // The commit ID of the destination commit specifier that was used in the merge // evaluation. // // This member is required. - SourceCommitId *string + DestinationCommitId *string - // The commit ID of the destination commit specifier that was used in the merge + // The merge option or strategy used to merge the code. + // + // This member is required. + MergeOptions []types.MergeOptionTypeEnum + + // The commit ID of the source commit specifier that was used in the merge // evaluation. // // This member is required. - DestinationCommitId *string + SourceCommitId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/codecommit/api_op_GetPullRequestApprovalStates.go b/service/codecommit/api_op_GetPullRequestApprovalStates.go index 796514389a0..0b0e1af6a87 100644 --- a/service/codecommit/api_op_GetPullRequestApprovalStates.go +++ b/service/codecommit/api_op_GetPullRequestApprovalStates.go @@ -59,15 +59,15 @@ func (c *Client) GetPullRequestApprovalStates(ctx context.Context, params *GetPu type GetPullRequestApprovalStatesInput struct { - // The system-generated ID for the pull request revision. + // The system-generated ID for the pull request. // // This member is required. - RevisionId *string + PullRequestId *string - // The system-generated ID for the pull request. + // The system-generated ID for the pull request revision. // // This member is required. - PullRequestId *string + RevisionId *string } type GetPullRequestApprovalStatesOutput struct { diff --git a/service/codecommit/api_op_GetPullRequestOverrideState.go b/service/codecommit/api_op_GetPullRequestOverrideState.go index 34ddc856862..d311536b390 100644 --- a/service/codecommit/api_op_GetPullRequestOverrideState.go +++ b/service/codecommit/api_op_GetPullRequestOverrideState.go @@ -74,14 +74,14 @@ type GetPullRequestOverrideStateInput struct { type GetPullRequestOverrideStateOutput struct { - // The Amazon Resource Name (ARN) of the user or identity that overrode the rules - // and their requirements for the pull request. - Overrider *string - // A Boolean value that indicates whether a pull request has had its rules set // aside (TRUE) or whether all approval rules still apply (FALSE). Overridden *bool + // The Amazon Resource Name (ARN) of the user or identity that overrode the rules + // and their requirements for the pull request. + Overrider *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codecommit/api_op_ListApprovalRuleTemplates.go b/service/codecommit/api_op_ListApprovalRuleTemplates.go index f2a08254ea3..6d7fb27a8a0 100644 --- a/service/codecommit/api_op_ListApprovalRuleTemplates.go +++ b/service/codecommit/api_op_ListApprovalRuleTemplates.go @@ -67,14 +67,14 @@ type ListApprovalRuleTemplatesInput struct { type ListApprovalRuleTemplatesOutput struct { - // An enumeration token that allows the operation to batch the next results of the - // operation. - NextToken *string - // The names of all the approval rule templates found in the AWS Region for your // AWS account. ApprovalRuleTemplateNames []*string + // An enumeration token that allows the operation to batch the next results of the + // operation. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codecommit/api_op_ListAssociatedApprovalRuleTemplatesForRepository.go b/service/codecommit/api_op_ListAssociatedApprovalRuleTemplatesForRepository.go index 5e2e4cdbef5..50874cf4bc4 100644 --- a/service/codecommit/api_op_ListAssociatedApprovalRuleTemplatesForRepository.go +++ b/service/codecommit/api_op_ListAssociatedApprovalRuleTemplatesForRepository.go @@ -57,18 +57,18 @@ func (c *Client) ListAssociatedApprovalRuleTemplatesForRepository(ctx context.Co type ListAssociatedApprovalRuleTemplatesForRepositoryInput struct { + // The name of the repository for which you want to list all associated approval + // rule templates. + // + // This member is required. + RepositoryName *string + // A non-zero, non-negative integer used to limit the number of returned results. MaxResults *int32 // An enumeration token that, when provided in a request, returns the next batch of // the results. NextToken *string - - // The name of the repository for which you want to list all associated approval - // rule templates. - // - // This member is required. - RepositoryName *string } type ListAssociatedApprovalRuleTemplatesForRepositoryOutput struct { diff --git a/service/codecommit/api_op_ListBranches.go b/service/codecommit/api_op_ListBranches.go index c31b5fde694..66a9e59ac2e 100644 --- a/service/codecommit/api_op_ListBranches.go +++ b/service/codecommit/api_op_ListBranches.go @@ -57,24 +57,24 @@ func (c *Client) ListBranches(ctx context.Context, params *ListBranchesInput, op // Represents the input of a list branches operation. type ListBranchesInput struct { - // An enumeration token that allows the operation to batch the results. - NextToken *string - // The name of the repository that contains the branches. // // This member is required. RepositoryName *string + + // An enumeration token that allows the operation to batch the results. + NextToken *string } // Represents the output of a list branches operation. type ListBranchesOutput struct { - // An enumeration token that returns the batch of the results. - NextToken *string - // The list of branch names. Branches []*string + // An enumeration token that returns the batch of the results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codecommit/api_op_ListPullRequests.go b/service/codecommit/api_op_ListPullRequests.go index e384016fbc8..056093e2314 100644 --- a/service/codecommit/api_op_ListPullRequests.go +++ b/service/codecommit/api_op_ListPullRequests.go @@ -68,13 +68,13 @@ type ListPullRequestsInput struct { // user. AuthorArn *string + // A non-zero, non-negative integer used to limit the number of returned results. + MaxResults *int32 + // An enumeration token that, when provided in a request, returns the next batch of // the results. NextToken *string - // A non-zero, non-negative integer used to limit the number of returned results. - MaxResults *int32 - // Optional. The status of the pull request. If used, this refines the results to // the pull requests that match the specified status. PullRequestStatus types.PullRequestStatusEnum diff --git a/service/codecommit/api_op_ListRepositories.go b/service/codecommit/api_op_ListRepositories.go index 01fc0030aa2..c065c79a78d 100644 --- a/service/codecommit/api_op_ListRepositories.go +++ b/service/codecommit/api_op_ListRepositories.go @@ -57,31 +57,31 @@ func (c *Client) ListRepositories(ctx context.Context, params *ListRepositoriesI // Represents the input of a list repositories operation. type ListRepositoriesInput struct { - // The criteria used to sort the results of a list repositories operation. - SortBy types.SortByEnum - - // The order in which to sort the results of a list repositories operation. - Order types.OrderEnum - // An enumeration token that allows the operation to batch the results of the // operation. Batch sizes are 1,000 for list repository operations. When the client // sends the token back to AWS CodeCommit, another page of 1,000 records is // retrieved. NextToken *string + + // The order in which to sort the results of a list repositories operation. + Order types.OrderEnum + + // The criteria used to sort the results of a list repositories operation. + SortBy types.SortByEnum } // Represents the output of a list repositories operation. type ListRepositoriesOutput struct { - // Lists the repositories called by the list repositories operation. - Repositories []*types.RepositoryNameIdPair - // An enumeration token that allows the operation to batch the results of the // operation. Batch sizes are 1,000 for list repository operations. When the client // sends the token back to AWS CodeCommit, another page of 1,000 records is // retrieved. NextToken *string + // Lists the repositories called by the list repositories operation. + Repositories []*types.RepositoryNameIdPair + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codecommit/api_op_ListRepositoriesForApprovalRuleTemplate.go b/service/codecommit/api_op_ListRepositoriesForApprovalRuleTemplate.go index 0747049be5e..3c57440d71a 100644 --- a/service/codecommit/api_op_ListRepositoriesForApprovalRuleTemplate.go +++ b/service/codecommit/api_op_ListRepositoriesForApprovalRuleTemplate.go @@ -56,18 +56,18 @@ func (c *Client) ListRepositoriesForApprovalRuleTemplate(ctx context.Context, pa type ListRepositoriesForApprovalRuleTemplateInput struct { + // The name of the approval rule template for which you want to list repositories + // that are associated with that template. + // + // This member is required. + ApprovalRuleTemplateName *string + // A non-zero, non-negative integer used to limit the number of returned results. MaxResults *int32 // An enumeration token that, when provided in a request, returns the next batch of // the results. NextToken *string - - // The name of the approval rule template for which you want to list repositories - // that are associated with that template. - // - // This member is required. - ApprovalRuleTemplateName *string } type ListRepositoriesForApprovalRuleTemplateOutput struct { diff --git a/service/codecommit/api_op_ListTagsForResource.go b/service/codecommit/api_op_ListTagsForResource.go index 0ba1527270f..ee32161855a 100644 --- a/service/codecommit/api_op_ListTagsForResource.go +++ b/service/codecommit/api_op_ListTagsForResource.go @@ -60,15 +60,15 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // An enumeration token that, when provided in a request, returns the next batch of - // the results. - NextToken *string - // The Amazon Resource Name (ARN) of the resource for which you want to get // information about tags, if any. // // This member is required. ResourceArn *string + + // An enumeration token that, when provided in a request, returns the next batch of + // the results. + NextToken *string } type ListTagsForResourceOutput struct { diff --git a/service/codecommit/api_op_MergeBranchesByFastForward.go b/service/codecommit/api_op_MergeBranchesByFastForward.go index 82679a06dd9..bc75aefb694 100644 --- a/service/codecommit/api_op_MergeBranchesByFastForward.go +++ b/service/codecommit/api_op_MergeBranchesByFastForward.go @@ -62,6 +62,11 @@ type MergeBranchesByFastForwardInput struct { // This member is required. DestinationCommitSpecifier *string + // The name of the repository where you want to merge two branches. + // + // This member is required. + RepositoryName *string + // The branch, tag, HEAD, or other fully qualified reference used to identify a // commit (for example, a branch name or a full commit ID). // @@ -70,11 +75,6 @@ type MergeBranchesByFastForwardInput struct { // The branch where the merge is applied. TargetBranch *string - - // The name of the repository where you want to merge two branches. - // - // This member is required. - RepositoryName *string } type MergeBranchesByFastForwardOutput struct { diff --git a/service/codecommit/api_op_MergeBranchesBySquash.go b/service/codecommit/api_op_MergeBranchesBySquash.go index 850814d212d..7f1ed13c766 100644 --- a/service/codecommit/api_op_MergeBranchesBySquash.go +++ b/service/codecommit/api_op_MergeBranchesBySquash.go @@ -57,17 +57,6 @@ func (c *Client) MergeBranchesBySquash(ctx context.Context, params *MergeBranche type MergeBranchesBySquashInput struct { - // If the commit contains deletions, whether to keep a folder or folder structure - // if the changes leave the folders empty. If this is specified as true, a .gitkeep - // file is created for empty folders. The default is false. - KeepEmptyFolders *bool - - // The branch, tag, HEAD, or other fully qualified reference used to identify a - // commit (for example, a branch name or a full commit ID). - // - // This member is required. - SourceCommitSpecifier *string - // The branch, tag, HEAD, or other fully qualified reference used to identify a // commit (for example, a branch name or a full commit ID). // @@ -79,13 +68,18 @@ type MergeBranchesBySquashInput struct { // This member is required. RepositoryName *string - // If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when - // resolving conflicts during a merge. - ConflictResolution *types.ConflictResolution + // The branch, tag, HEAD, or other fully qualified reference used to identify a + // commit (for example, a branch name or a full commit ID). + // + // This member is required. + SourceCommitSpecifier *string - // The email address of the person merging the branches. This information is used - // in the commit information for the merge. - Email *string + // The name of the author who created the commit. This information is used as both + // the author and committer for the commit. + AuthorName *string + + // The commit message for the merge. + CommitMessage *string // The level of conflict detail to use. If unspecified, the default FILE_LEVEL is // used, which returns a not-mergeable result if the same file has differences in @@ -93,9 +87,9 @@ type MergeBranchesBySquashInput struct { // mergeable if the same file in both branches has differences on the same line. ConflictDetailLevel types.ConflictDetailLevelTypeEnum - // The name of the author who created the commit. This information is used as both - // the author and committer for the commit. - AuthorName *string + // If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when + // resolving conflicts during a merge. + ConflictResolution *types.ConflictResolution // Specifies which branch to use when resolving conflicts, or whether to attempt // automatically merging two versions of a file. The default is NONE, which @@ -103,21 +97,27 @@ type MergeBranchesBySquashInput struct { // successful. ConflictResolutionStrategy types.ConflictResolutionStrategyTypeEnum + // The email address of the person merging the branches. This information is used + // in the commit information for the merge. + Email *string + + // If the commit contains deletions, whether to keep a folder or folder structure + // if the changes leave the folders empty. If this is specified as true, a .gitkeep + // file is created for empty folders. The default is false. + KeepEmptyFolders *bool + // The branch where the merge is applied. TargetBranch *string - - // The commit message for the merge. - CommitMessage *string } type MergeBranchesBySquashOutput struct { - // The tree ID of the merge in the destination or target branch. - TreeId *string - // The commit ID of the merge in the destination or target branch. CommitId *string + // The tree ID of the merge in the destination or target branch. + TreeId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codecommit/api_op_MergeBranchesByThreeWay.go b/service/codecommit/api_op_MergeBranchesByThreeWay.go index 18f30be16a1..2bcc339cdec 100644 --- a/service/codecommit/api_op_MergeBranchesByThreeWay.go +++ b/service/codecommit/api_op_MergeBranchesByThreeWay.go @@ -61,13 +61,32 @@ type MergeBranchesByThreeWayInput struct { // commit (for example, a branch name or a full commit ID). // // This member is required. - SourceCommitSpecifier *string + DestinationCommitSpecifier *string // The name of the repository where you want to merge two branches. // // This member is required. RepositoryName *string + // The branch, tag, HEAD, or other fully qualified reference used to identify a + // commit (for example, a branch name or a full commit ID). + // + // This member is required. + SourceCommitSpecifier *string + + // The name of the author who created the commit. This information is used as both + // the author and committer for the commit. + AuthorName *string + + // The commit message to include in the commit information for the merge. + CommitMessage *string + + // The level of conflict detail to use. If unspecified, the default FILE_LEVEL is + // used, which returns a not-mergeable result if the same file has differences in + // both branches. If LINE_LEVEL is specified, a conflict is considered not + // mergeable if the same file in both branches has differences on the same line. + ConflictDetailLevel types.ConflictDetailLevelTypeEnum + // If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when // resolving conflicts during a merge. ConflictResolution *types.ConflictResolution @@ -78,46 +97,27 @@ type MergeBranchesByThreeWayInput struct { // successful. ConflictResolutionStrategy types.ConflictResolutionStrategyTypeEnum - // If the commit contains deletions, whether to keep a folder or folder structure - // if the changes leave the folders empty. If true, a .gitkeep file is created for - // empty folders. The default is false. - KeepEmptyFolders *bool - // The email address of the person merging the branches. This information is used // in the commit information for the merge. Email *string - // The level of conflict detail to use. If unspecified, the default FILE_LEVEL is - // used, which returns a not-mergeable result if the same file has differences in - // both branches. If LINE_LEVEL is specified, a conflict is considered not - // mergeable if the same file in both branches has differences on the same line. - ConflictDetailLevel types.ConflictDetailLevelTypeEnum - - // The branch, tag, HEAD, or other fully qualified reference used to identify a - // commit (for example, a branch name or a full commit ID). - // - // This member is required. - DestinationCommitSpecifier *string + // If the commit contains deletions, whether to keep a folder or folder structure + // if the changes leave the folders empty. If true, a .gitkeep file is created for + // empty folders. The default is false. + KeepEmptyFolders *bool // The branch where the merge is applied. TargetBranch *string - - // The name of the author who created the commit. This information is used as both - // the author and committer for the commit. - AuthorName *string - - // The commit message to include in the commit information for the merge. - CommitMessage *string } type MergeBranchesByThreeWayOutput struct { - // The tree ID of the merge in the destination or target branch. - TreeId *string - // The commit ID of the merge in the destination or target branch. CommitId *string + // The tree ID of the merge in the destination or target branch. + TreeId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codecommit/api_op_MergePullRequestByFastForward.go b/service/codecommit/api_op_MergePullRequestByFastForward.go index 251019572c3..a4ba76fcaa7 100644 --- a/service/codecommit/api_op_MergePullRequestByFastForward.go +++ b/service/codecommit/api_op_MergePullRequestByFastForward.go @@ -60,17 +60,17 @@ func (c *Client) MergePullRequestByFastForward(ctx context.Context, params *Merg type MergePullRequestByFastForwardInput struct { - // The name of the repository where the pull request was created. - // - // This member is required. - RepositoryName *string - // The system-generated ID of the pull request. To get this ID, use // ListPullRequests (). // // This member is required. PullRequestId *string + // The name of the repository where the pull request was created. + // + // This member is required. + RepositoryName *string + // The full commit ID of the original or updated commit in the pull request source // branch. Pass this value if you want an exception thrown if the current commit ID // of the tip of the source branch does not match this commit ID. diff --git a/service/codecommit/api_op_MergePullRequestBySquash.go b/service/codecommit/api_op_MergePullRequestBySquash.go index 9bda842aff6..7186040222d 100644 --- a/service/codecommit/api_op_MergePullRequestBySquash.go +++ b/service/codecommit/api_op_MergePullRequestBySquash.go @@ -59,20 +59,16 @@ func (c *Client) MergePullRequestBySquash(ctx context.Context, params *MergePull type MergePullRequestBySquashInput struct { - // The full commit ID of the original or updated commit in the pull request source - // branch. Pass this value if you want an exception thrown if the current commit ID - // of the tip of the source branch does not match this commit ID. - SourceCommitId *string - - // The level of conflict detail to use. If unspecified, the default FILE_LEVEL is - // used, which returns a not-mergeable result if the same file has differences in - // both branches. If LINE_LEVEL is specified, a conflict is considered not - // mergeable if the same file in both branches has differences on the same line. - ConflictDetailLevel types.ConflictDetailLevelTypeEnum + // The system-generated ID of the pull request. To get this ID, use + // ListPullRequests (). + // + // This member is required. + PullRequestId *string - // The email address of the person merging the branches. This information is used - // in the commit information for the merge. - Email *string + // The name of the repository where the pull request was created. + // + // This member is required. + RepositoryName *string // The name of the author who created the commit. This information is used as both // the author and committer for the commit. @@ -81,31 +77,35 @@ type MergePullRequestBySquashInput struct { // The commit message to include in the commit information for the merge. CommitMessage *string - // Specifies which branch to use when resolving conflicts, or whether to attempt - // automatically merging two versions of a file. The default is NONE, which - // requires any conflicts to be resolved manually before the merge operation is - // successful. - ConflictResolutionStrategy types.ConflictResolutionStrategyTypeEnum + // The level of conflict detail to use. If unspecified, the default FILE_LEVEL is + // used, which returns a not-mergeable result if the same file has differences in + // both branches. If LINE_LEVEL is specified, a conflict is considered not + // mergeable if the same file in both branches has differences on the same line. + ConflictDetailLevel types.ConflictDetailLevelTypeEnum // If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when // resolving conflicts during a merge. ConflictResolution *types.ConflictResolution - // The name of the repository where the pull request was created. - // - // This member is required. - RepositoryName *string + // Specifies which branch to use when resolving conflicts, or whether to attempt + // automatically merging two versions of a file. The default is NONE, which + // requires any conflicts to be resolved manually before the merge operation is + // successful. + ConflictResolutionStrategy types.ConflictResolutionStrategyTypeEnum - // The system-generated ID of the pull request. To get this ID, use - // ListPullRequests (). - // - // This member is required. - PullRequestId *string + // The email address of the person merging the branches. This information is used + // in the commit information for the merge. + Email *string // If the commit contains deletions, whether to keep a folder or folder structure // if the changes leave the folders empty. If true, a .gitkeep file is created for // empty folders. The default is false. KeepEmptyFolders *bool + + // The full commit ID of the original or updated commit in the pull request source + // branch. Pass this value if you want an exception thrown if the current commit ID + // of the tip of the source branch does not match this commit ID. + SourceCommitId *string } type MergePullRequestBySquashOutput struct { diff --git a/service/codecommit/api_op_MergePullRequestByThreeWay.go b/service/codecommit/api_op_MergePullRequestByThreeWay.go index a6210e61b53..c0ef207e1b2 100644 --- a/service/codecommit/api_op_MergePullRequestByThreeWay.go +++ b/service/codecommit/api_op_MergePullRequestByThreeWay.go @@ -60,11 +60,23 @@ func (c *Client) MergePullRequestByThreeWay(ctx context.Context, params *MergePu type MergePullRequestByThreeWayInput struct { - // Specifies which branch to use when resolving conflicts, or whether to attempt - // automatically merging two versions of a file. The default is NONE, which - // requires any conflicts to be resolved manually before the merge operation is - // successful. - ConflictResolutionStrategy types.ConflictResolutionStrategyTypeEnum + // The system-generated ID of the pull request. To get this ID, use + // ListPullRequests (). + // + // This member is required. + PullRequestId *string + + // The name of the repository where the pull request was created. + // + // This member is required. + RepositoryName *string + + // The name of the author who created the commit. This information is used as both + // the author and committer for the commit. + AuthorName *string + + // The commit message to include in the commit information for the merge. + CommitMessage *string // The level of conflict detail to use. If unspecified, the default FILE_LEVEL is // used, which returns a not-mergeable result if the same file has differences in @@ -72,41 +84,29 @@ type MergePullRequestByThreeWayInput struct { // mergeable if the same file in both branches has differences on the same line. ConflictDetailLevel types.ConflictDetailLevelTypeEnum - // If the commit contains deletions, whether to keep a folder or folder structure - // if the changes leave the folders empty. If true, a .gitkeep file is created for - // empty folders. The default is false. - KeepEmptyFolders *bool + // If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when + // resolving conflicts during a merge. + ConflictResolution *types.ConflictResolution + + // Specifies which branch to use when resolving conflicts, or whether to attempt + // automatically merging two versions of a file. The default is NONE, which + // requires any conflicts to be resolved manually before the merge operation is + // successful. + ConflictResolutionStrategy types.ConflictResolutionStrategyTypeEnum // The email address of the person merging the branches. This information is used // in the commit information for the merge. Email *string - // The name of the repository where the pull request was created. - // - // This member is required. - RepositoryName *string - - // The system-generated ID of the pull request. To get this ID, use - // ListPullRequests (). - // - // This member is required. - PullRequestId *string - - // If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when - // resolving conflicts during a merge. - ConflictResolution *types.ConflictResolution + // If the commit contains deletions, whether to keep a folder or folder structure + // if the changes leave the folders empty. If true, a .gitkeep file is created for + // empty folders. The default is false. + KeepEmptyFolders *bool // The full commit ID of the original or updated commit in the pull request source // branch. Pass this value if you want an exception thrown if the current commit ID // of the tip of the source branch does not match this commit ID. SourceCommitId *string - - // The name of the author who created the commit. This information is used as both - // the author and committer for the commit. - AuthorName *string - - // The commit message to include in the commit information for the merge. - CommitMessage *string } type MergePullRequestByThreeWayOutput struct { diff --git a/service/codecommit/api_op_OverridePullRequestApprovalRules.go b/service/codecommit/api_op_OverridePullRequestApprovalRules.go index 82d6b86fa75..21634818d7e 100644 --- a/service/codecommit/api_op_OverridePullRequestApprovalRules.go +++ b/service/codecommit/api_op_OverridePullRequestApprovalRules.go @@ -58,12 +58,12 @@ func (c *Client) OverridePullRequestApprovalRules(ctx context.Context, params *O type OverridePullRequestApprovalRulesInput struct { - // The system-generated ID of the most recent revision of the pull request. You - // cannot override approval rules for anything but the most recent revision of a - // pull request. To get the revision ID, use GetPullRequest. + // Whether you want to set aside approval rule requirements for the pull request + // (OVERRIDE) or revoke a previous override and apply approval rule requirements + // (REVOKE). REVOKE status is not stored. // // This member is required. - RevisionId *string + OverrideStatus types.OverrideStatus // The system-generated ID of the pull request for which you want to override all // approval rule requirements. To get this information, use GetPullRequest (). @@ -71,12 +71,12 @@ type OverridePullRequestApprovalRulesInput struct { // This member is required. PullRequestId *string - // Whether you want to set aside approval rule requirements for the pull request - // (OVERRIDE) or revoke a previous override and apply approval rule requirements - // (REVOKE). REVOKE status is not stored. + // The system-generated ID of the most recent revision of the pull request. You + // cannot override approval rules for anything but the most recent revision of a + // pull request. To get the revision ID, use GetPullRequest. // // This member is required. - OverrideStatus types.OverrideStatus + RevisionId *string } type OverridePullRequestApprovalRulesOutput struct { diff --git a/service/codecommit/api_op_PostCommentForComparedCommit.go b/service/codecommit/api_op_PostCommentForComparedCommit.go index 5af5ed059af..1a474b49dff 100644 --- a/service/codecommit/api_op_PostCommentForComparedCommit.go +++ b/service/codecommit/api_op_PostCommentForComparedCommit.go @@ -59,17 +59,17 @@ func (c *Client) PostCommentForComparedCommit(ctx context.Context, params *PostC type PostCommentForComparedCommitInput struct { + // To establish the directionality of the comparison, the full commit ID of the + // after commit. + // + // This member is required. + AfterCommitId *string + // The content of the comment you want to make. // // This member is required. Content *string - // A unique, client-generated idempotency token that, when provided in a request, - // ensures the request cannot be repeated with a changed parameter. If a request is - // received with the same parameters and a token is included, the request returns - // information about the initial request that used that token. - ClientRequestToken *string - // The name of the repository where you want to post a comment on the comparison // between commits. // @@ -81,39 +81,39 @@ type PostCommentForComparedCommitInput struct { // initial commit. BeforeCommitId *string + // A unique, client-generated idempotency token that, when provided in a request, + // ensures the request cannot be repeated with a changed parameter. If a request is + // received with the same parameters and a token is included, the request returns + // information about the initial request that used that token. + ClientRequestToken *string + // The location of the comparison where you want to comment. Location *types.Location - - // To establish the directionality of the comparison, the full commit ID of the - // after commit. - // - // This member is required. - AfterCommitId *string } type PostCommentForComparedCommitOutput struct { - // The location of the comment in the comparison between the two commits. - Location *types.Location - // In the directionality you established, the blob ID of the after blob. AfterBlobId *string + // In the directionality you established, the full commit ID of the after commit. + AfterCommitId *string + + // In the directionality you established, the blob ID of the before blob. + BeforeBlobId *string + // In the directionality you established, the full commit ID of the before commit. BeforeCommitId *string - // The name of the repository where you posted a comment on the comparison between - // commits. - RepositoryName *string - // The content of the comment you posted. Comment *types.Comment - // In the directionality you established, the full commit ID of the after commit. - AfterCommitId *string + // The location of the comment in the comparison between the two commits. + Location *types.Location - // In the directionality you established, the blob ID of the before blob. - BeforeBlobId *string + // The name of the repository where you posted a comment on the comparison between + // commits. + RepositoryName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/codecommit/api_op_PostCommentForPullRequest.go b/service/codecommit/api_op_PostCommentForPullRequest.go index 9bce3ed04dc..1f5cc576017 100644 --- a/service/codecommit/api_op_PostCommentForPullRequest.go +++ b/service/codecommit/api_op_PostCommentForPullRequest.go @@ -59,6 +59,12 @@ func (c *Client) PostCommentForPullRequest(ctx context.Context, params *PostComm type PostCommentForPullRequestInput struct { + // The full commit ID of the commit in the source branch that is the current tip of + // the branch for the pull request when you post the comment. + // + // This member is required. + AfterCommitId *string + // The full commit ID of the commit in the destination branch that was the tip of // the branch at the time the pull request was created. // @@ -70,47 +76,33 @@ type PostCommentForPullRequestInput struct { // This member is required. Content *string - // The name of the repository where you want to post a comment on a pull request. - // - // This member is required. - RepositoryName *string - // The system-generated ID of the pull request. To get this ID, use // ListPullRequests (). // // This member is required. PullRequestId *string - // The location of the change where you want to post your comment. If no location - // is provided, the comment is posted as a general comment on the pull request - // difference between the before commit ID and the after commit ID. - Location *types.Location - - // The full commit ID of the commit in the source branch that is the current tip of - // the branch for the pull request when you post the comment. + // The name of the repository where you want to post a comment on a pull request. // // This member is required. - AfterCommitId *string + RepositoryName *string // A unique, client-generated idempotency token that, when provided in a request, // ensures the request cannot be repeated with a changed parameter. If a request is // received with the same parameters and a token is included, the request returns // information about the initial request that used that token. ClientRequestToken *string + + // The location of the change where you want to post your comment. If no location + // is provided, the comment is posted as a general comment on the pull request + // difference between the before commit ID and the after commit ID. + Location *types.Location } type PostCommentForPullRequestOutput struct { - // The full commit ID of the commit in the source branch used to create the pull - // request, or in the case of an updated pull request, the full commit ID of the - // commit used to update the pull request. - BeforeCommitId *string - - // The system-generated ID of the pull request. - PullRequestId *string - - // The name of the repository where you posted a comment on a pull request. - RepositoryName *string + // In the directionality of the pull request, the blob ID of the after blob. + AfterBlobId *string // The full commit ID of the commit in the destination branch where the pull // request is merged. @@ -119,8 +111,10 @@ type PostCommentForPullRequestOutput struct { // In the directionality of the pull request, the blob ID of the before blob. BeforeBlobId *string - // In the directionality of the pull request, the blob ID of the after blob. - AfterBlobId *string + // The full commit ID of the commit in the source branch used to create the pull + // request, or in the case of an updated pull request, the full commit ID of the + // commit used to update the pull request. + BeforeCommitId *string // The content of the comment you posted. Comment *types.Comment @@ -128,6 +122,12 @@ type PostCommentForPullRequestOutput struct { // The location of the change where you posted your comment. Location *types.Location + // The system-generated ID of the pull request. + PullRequestId *string + + // The name of the repository where you posted a comment on a pull request. + RepositoryName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codecommit/api_op_PostCommentReply.go b/service/codecommit/api_op_PostCommentReply.go index 76c86fda634..7f3ad17f281 100644 --- a/service/codecommit/api_op_PostCommentReply.go +++ b/service/codecommit/api_op_PostCommentReply.go @@ -65,17 +65,17 @@ type PostCommentReplyInput struct { // This member is required. Content *string - // A unique, client-generated idempotency token that, when provided in a request, - // ensures the request cannot be repeated with a changed parameter. If a request is - // received with the same parameters and a token is included, the request returns - // information about the initial request that used that token. - ClientRequestToken *string - // The system-generated ID of the comment to which you want to reply. To get this // ID, use GetCommentsForComparedCommit () or GetCommentsForPullRequest (). // // This member is required. InReplyTo *string + + // A unique, client-generated idempotency token that, when provided in a request, + // ensures the request cannot be repeated with a changed parameter. If a request is + // received with the same parameters and a token is included, the request returns + // information about the initial request that used that token. + ClientRequestToken *string } type PostCommentReplyOutput struct { diff --git a/service/codecommit/api_op_PutFile.go b/service/codecommit/api_op_PutFile.go index fe5330143d7..832fb8a72bd 100644 --- a/service/codecommit/api_op_PutFile.go +++ b/service/codecommit/api_op_PutFile.go @@ -58,13 +58,6 @@ func (c *Client) PutFile(ctx context.Context, params *PutFileInput, optFns ...fu type PutFileInput struct { - // The full commit ID of the head commit in the branch where you want to add or - // update the file. If this is an empty repository, no commit ID is required. If - // this is not an empty repository, a commit ID is required. The commit ID must - // match the ID of the head commit at the time of the operation. Otherwise, an - // error occurs, and the file is not added or updated. - ParentCommitId *string - // The name of the branch where you want to add or update the file. If this is an // empty repository, this branch is created. // @@ -76,13 +69,6 @@ type PutFileInput struct { // This member is required. FileContent []byte - // The file mode permissions of the blob. Valid file mode permissions are listed - // here. - FileMode types.FileModeTypeEnum - - // An email address for the person adding or updating the file. - Email *string - // The name of the file you want to add or update, including the relative path to // the file in the repository. If the path does not currently exist in the // repository, the path is created as part of adding the file. @@ -95,13 +81,27 @@ type PutFileInput struct { // This member is required. RepositoryName *string + // A message about why this file was added or updated. Although it is optional, a + // message makes the commit history for your repository more useful. + CommitMessage *string + + // An email address for the person adding or updating the file. + Email *string + + // The file mode permissions of the blob. Valid file mode permissions are listed + // here. + FileMode types.FileModeTypeEnum + // The name of the person adding or updating the file. Although it is optional, a // name makes the commit history for your repository more useful. Name *string - // A message about why this file was added or updated. Although it is optional, a - // message makes the commit history for your repository more useful. - CommitMessage *string + // The full commit ID of the head commit in the branch where you want to add or + // update the file. If this is an empty repository, no commit ID is required. If + // this is not an empty repository, a commit ID is required. The commit ID must + // match the ID of the head commit at the time of the operation. Otherwise, an + // error occurs, and the file is not added or updated. + ParentCommitId *string } type PutFileOutput struct { @@ -111,16 +111,16 @@ type PutFileOutput struct { // This member is required. BlobId *string - // The full SHA-1 pointer of the tree information for the commit that contains this - // file change. + // The full SHA ID of the commit that contains this file change. // // This member is required. - TreeId *string + CommitId *string - // The full SHA ID of the commit that contains this file change. + // The full SHA-1 pointer of the tree information for the commit that contains this + // file change. // // This member is required. - CommitId *string + TreeId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/codecommit/api_op_PutRepositoryTriggers.go b/service/codecommit/api_op_PutRepositoryTriggers.go index a978adad9f0..b78e7f05e9c 100644 --- a/service/codecommit/api_op_PutRepositoryTriggers.go +++ b/service/codecommit/api_op_PutRepositoryTriggers.go @@ -58,15 +58,15 @@ func (c *Client) PutRepositoryTriggers(ctx context.Context, params *PutRepositor // Represents the input of a put repository triggers operation. type PutRepositoryTriggersInput struct { - // The JSON block of configuration information for each trigger. + // The name of the repository where you want to create or update the trigger. // // This member is required. - Triggers []*types.RepositoryTrigger + RepositoryName *string - // The name of the repository where you want to create or update the trigger. + // The JSON block of configuration information for each trigger. // // This member is required. - RepositoryName *string + Triggers []*types.RepositoryTrigger } // Represents the output of a put repository triggers operation. diff --git a/service/codecommit/api_op_TagResource.go b/service/codecommit/api_op_TagResource.go index 89a4ab7b4b1..3307f612083 100644 --- a/service/codecommit/api_op_TagResource.go +++ b/service/codecommit/api_op_TagResource.go @@ -59,16 +59,16 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The key-value pair to use when tagging this repository. - // - // This member is required. - Tags map[string]*string - // The Amazon Resource Name (ARN) of the resource to which you want to add or // update tags. // // This member is required. ResourceArn *string + + // The key-value pair to use when tagging this repository. + // + // This member is required. + Tags map[string]*string } type TagResourceOutput struct { diff --git a/service/codecommit/api_op_TestRepositoryTriggers.go b/service/codecommit/api_op_TestRepositoryTriggers.go index 3edd4b57dc9..03f0c35bf23 100644 --- a/service/codecommit/api_op_TestRepositoryTriggers.go +++ b/service/codecommit/api_op_TestRepositoryTriggers.go @@ -74,14 +74,14 @@ type TestRepositoryTriggersInput struct { // Represents the output of a test repository triggers operation. type TestRepositoryTriggersOutput struct { - // The list of triggers that were successfully tested. This list provides the names - // of the triggers that were successfully tested, separated by commas. - SuccessfulExecutions []*string - // The list of triggers that were not tested. This list provides the names of the // triggers that could not be tested, separated by commas. FailedExecutions []*types.RepositoryTriggerExecutionFailure + // The list of triggers that were successfully tested. This list provides the names + // of the triggers that were successfully tested, separated by commas. + SuccessfulExecutions []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codecommit/api_op_UpdateApprovalRuleTemplateContent.go b/service/codecommit/api_op_UpdateApprovalRuleTemplateContent.go index 77129f62ad9..a643985cd9f 100644 --- a/service/codecommit/api_op_UpdateApprovalRuleTemplateContent.go +++ b/service/codecommit/api_op_UpdateApprovalRuleTemplateContent.go @@ -59,18 +59,18 @@ func (c *Client) UpdateApprovalRuleTemplateContent(ctx context.Context, params * type UpdateApprovalRuleTemplateContentInput struct { - // The content that replaces the existing content of the rule. Content statements - // must be complete. You cannot provide only the changes. - // - // This member is required. - NewRuleContent *string - // The name of the approval rule template where you want to update the content of // the rule. // // This member is required. ApprovalRuleTemplateName *string + // The content that replaces the existing content of the rule. Content statements + // must be complete. You cannot provide only the changes. + // + // This member is required. + NewRuleContent *string + // The SHA-256 hash signature for the content of the approval rule. You can // retrieve this information by using GetPullRequest (). ExistingRuleContentSha256 *string diff --git a/service/codecommit/api_op_UpdateApprovalRuleTemplateDescription.go b/service/codecommit/api_op_UpdateApprovalRuleTemplateDescription.go index bc4f3e6be1d..ee7c2aeb32c 100644 --- a/service/codecommit/api_op_UpdateApprovalRuleTemplateDescription.go +++ b/service/codecommit/api_op_UpdateApprovalRuleTemplateDescription.go @@ -57,15 +57,15 @@ func (c *Client) UpdateApprovalRuleTemplateDescription(ctx context.Context, para type UpdateApprovalRuleTemplateDescriptionInput struct { - // The name of the template for which you want to update the description. + // The updated description of the approval rule template. // // This member is required. - ApprovalRuleTemplateName *string + ApprovalRuleTemplateDescription *string - // The updated description of the approval rule template. + // The name of the template for which you want to update the description. // // This member is required. - ApprovalRuleTemplateDescription *string + ApprovalRuleTemplateName *string } type UpdateApprovalRuleTemplateDescriptionOutput struct { diff --git a/service/codecommit/api_op_UpdateComment.go b/service/codecommit/api_op_UpdateComment.go index 8ae023b7522..d46bdc0646f 100644 --- a/service/codecommit/api_op_UpdateComment.go +++ b/service/codecommit/api_op_UpdateComment.go @@ -57,16 +57,16 @@ func (c *Client) UpdateComment(ctx context.Context, params *UpdateCommentInput, type UpdateCommentInput struct { - // The updated content to replace the existing content of the comment. - // - // This member is required. - Content *string - // The system-generated ID of the comment you want to update. To get this ID, use // GetCommentsForComparedCommit () or GetCommentsForPullRequest (). // // This member is required. CommentId *string + + // The updated content to replace the existing content of the comment. + // + // This member is required. + Content *string } type UpdateCommentOutput struct { diff --git a/service/codecommit/api_op_UpdateDefaultBranch.go b/service/codecommit/api_op_UpdateDefaultBranch.go index b1e0fe5bf83..18d41b581dc 100644 --- a/service/codecommit/api_op_UpdateDefaultBranch.go +++ b/service/codecommit/api_op_UpdateDefaultBranch.go @@ -60,15 +60,15 @@ func (c *Client) UpdateDefaultBranch(ctx context.Context, params *UpdateDefaultB // Represents the input of an update default branch operation. type UpdateDefaultBranchInput struct { - // The name of the repository to set or change the default branch for. + // The name of the branch to set as the default. // // This member is required. - RepositoryName *string + DefaultBranchName *string - // The name of the branch to set as the default. + // The name of the repository to set or change the default branch for. // // This member is required. - DefaultBranchName *string + RepositoryName *string } type UpdateDefaultBranchOutput struct { diff --git a/service/codecommit/api_op_UpdatePullRequestApprovalRuleContent.go b/service/codecommit/api_op_UpdatePullRequestApprovalRuleContent.go index d39a646078c..ade082393bd 100644 --- a/service/codecommit/api_op_UpdatePullRequestApprovalRuleContent.go +++ b/service/codecommit/api_op_UpdatePullRequestApprovalRuleContent.go @@ -59,6 +59,11 @@ func (c *Client) UpdatePullRequestApprovalRuleContent(ctx context.Context, param type UpdatePullRequestApprovalRuleContentInput struct { + // The name of the approval rule you want to update. + // + // This member is required. + ApprovalRuleName *string + // The updated content for the approval rule. When you update the content of the // approval rule, you can specify approvers in an approval pool in one of two // ways: @@ -95,19 +100,14 @@ type UpdatePullRequestApprovalRuleContentInput struct { // This member is required. NewRuleContent *string - // The name of the approval rule you want to update. + // The system-generated ID of the pull request. // // This member is required. - ApprovalRuleName *string + PullRequestId *string // The SHA-256 hash signature for the content of the approval rule. You can // retrieve this information by using GetPullRequest (). ExistingRuleContentSha256 *string - - // The system-generated ID of the pull request. - // - // This member is required. - PullRequestId *string } type UpdatePullRequestApprovalRuleContentOutput struct { diff --git a/service/codecommit/api_op_UpdatePullRequestApprovalState.go b/service/codecommit/api_op_UpdatePullRequestApprovalState.go index 1128e46d989..2f017a3a62b 100644 --- a/service/codecommit/api_op_UpdatePullRequestApprovalState.go +++ b/service/codecommit/api_op_UpdatePullRequestApprovalState.go @@ -58,11 +58,6 @@ func (c *Client) UpdatePullRequestApprovalState(ctx context.Context, params *Upd type UpdatePullRequestApprovalStateInput struct { - // The system-generated ID of the revision. - // - // This member is required. - RevisionId *string - // The approval state to associate with the user on the pull request. // // This member is required. @@ -72,6 +67,11 @@ type UpdatePullRequestApprovalStateInput struct { // // This member is required. PullRequestId *string + + // The system-generated ID of the revision. + // + // This member is required. + RevisionId *string } type UpdatePullRequestApprovalStateOutput struct { diff --git a/service/codecommit/go.mod b/service/codecommit/go.mod index 6a182ff7d6a..a125fc03afb 100644 --- a/service/codecommit/go.mod +++ b/service/codecommit/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/codecommit go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/codecommit/types/types.go b/service/codecommit/types/types.go index 07fa600599a..d779612b0f6 100644 --- a/service/codecommit/types/types.go +++ b/service/codecommit/types/types.go @@ -9,37 +9,37 @@ import ( // Returns information about a specific approval on a pull request. type Approval struct { - // The Amazon Resource Name (ARN) of the user. - UserArn *string - // The state of the approval, APPROVE or REVOKE. REVOKE states are not stored. ApprovalState ApprovalState + + // The Amazon Resource Name (ARN) of the user. + UserArn *string } // Returns information about an approval rule. type ApprovalRule struct { + // The content of the approval rule. + ApprovalRuleContent *string + + // The system-generated ID of the approval rule. + ApprovalRuleId *string + + // The name of the approval rule. + ApprovalRuleName *string + // The date the approval rule was created, in timestamp format. CreationDate *time.Time - // The approval rule template used to create the rule. - OriginApprovalRuleTemplate *OriginApprovalRuleTemplate + // The date the approval rule was most recently changed, in timestamp format. + LastModifiedDate *time.Time // The Amazon Resource Name (ARN) of the user who made the most recent changes to // the approval rule. LastModifiedUser *string - // The date the approval rule was most recently changed, in timestamp format. - LastModifiedDate *time.Time - - // The name of the approval rule. - ApprovalRuleName *string - - // The system-generated ID of the approval rule. - ApprovalRuleId *string - - // The content of the approval rule. - ApprovalRuleContent *string + // The approval rule template used to create the rule. + OriginApprovalRuleTemplate *OriginApprovalRuleTemplate // The SHA-256 hash signature for the content of the approval rule. RuleContentSha256 *string @@ -62,11 +62,11 @@ type ApprovalRuleEventMetadata struct { // request. type ApprovalRuleOverriddenEventMetadata struct { - // The revision ID of the pull request when the override event occurred. - RevisionId *string - // The status of the override event. OverrideStatus OverrideStatus + + // The revision ID of the pull request when the override event occurred. + RevisionId *string } // Returns information about an approval rule template. @@ -78,49 +78,49 @@ type ApprovalRuleTemplate struct { // The description of the approval rule template. ApprovalRuleTemplateDescription *string - // The Amazon Resource Name (ARN) of the user who made the most recent changes to - // the approval rule template. - LastModifiedUser *string - - // The date the approval rule template was created, in timestamp format. - CreationDate *time.Time - - // The SHA-256 hash signature for the content of the approval rule template. - RuleContentSha256 *string - // The system-generated ID of the approval rule template. ApprovalRuleTemplateId *string // The name of the approval rule template. ApprovalRuleTemplateName *string + // The date the approval rule template was created, in timestamp format. + CreationDate *time.Time + // The date the approval rule template was most recently changed, in timestamp // format. LastModifiedDate *time.Time + + // The Amazon Resource Name (ARN) of the user who made the most recent changes to + // the approval rule template. + LastModifiedUser *string + + // The SHA-256 hash signature for the content of the approval rule template. + RuleContentSha256 *string } // Returns information about a change in the approval state for a pull request. type ApprovalStateChangedEventMetadata struct { - // The revision ID of the pull request when the approval state changed. - RevisionId *string - // The approval status for the pull request. ApprovalStatus ApprovalState + + // The revision ID of the pull request when the approval state changed. + RevisionId *string } // Returns information about errors in a // BatchAssociateApprovalRuleTemplateWithRepositories operation. type BatchAssociateApprovalRuleTemplateWithRepositoriesError struct { - // An error message that provides details about why the repository name was not - // found or not valid. - ErrorMessage *string - // An error code that specifies whether the repository name was not valid or not // found. ErrorCode *string + // An error message that provides details about why the repository name was not + // found or not valid. + ErrorMessage *string + // The name of the repository where the association was not made. RepositoryName *string } @@ -178,9 +178,6 @@ type BatchGetCommitsError struct { // Returns information about a specific Git blob object. type BlobMetadata struct { - // The path to the blob and associated file name, if any. - Path *string - // The full ID of the blob. BlobId *string @@ -196,6 +193,9 @@ type BlobMetadata struct { // // * 120000 indicates a symlink Mode *string + + // The path to the blob and associated file name, if any. + Path *string } // Returns information about a branch. @@ -211,14 +211,12 @@ type BranchInfo struct { // Returns information about a specific comment. type Comment struct { - // A Boolean value indicating whether the comment has been deleted. - Deleted *bool - // The Amazon Resource Name (ARN) of the person who posted the comment. AuthorArn *string - // The content of the comment. - Content *string + // The emoji reactions to a comment, if any, submitted by the user whose + // credentials are associated with the call to the API. + CallerReactions []*string // A unique, client-generated idempotency token that, when provided in a request, // ensures the request cannot be repeated with a changed parameter. If a request is @@ -226,33 +224,37 @@ type Comment struct { // information about the initial request that used that token. ClientRequestToken *string - // The date and time the comment was most recently modified, in timestamp format. - LastModifiedDate *time.Time - - // A string to integer map that represents the number of individual users who have - // responded to a comment with the specified reactions. - ReactionCounts map[string]*int32 - - // The ID of the comment for which this comment is a reply, if any. - InReplyTo *string - // The system-generated comment ID. CommentId *string + // The content of the comment. + Content *string + // The date and time the comment was created, in timestamp format. CreationDate *time.Time - // The emoji reactions to a comment, if any, submitted by the user whose - // credentials are associated with the call to the API. - CallerReactions []*string + // A Boolean value indicating whether the comment has been deleted. + Deleted *bool + + // The ID of the comment for which this comment is a reply, if any. + InReplyTo *string + + // The date and time the comment was most recently modified, in timestamp format. + LastModifiedDate *time.Time + + // A string to integer map that represents the number of individual users who have + // responded to a comment with the specified reactions. + ReactionCounts map[string]*int32 } // Returns information about comments on the comparison between two commits. type CommentsForComparedCommit struct { - // An array of comment objects. Each comment object contains information about a - // comment on the comparison between commits. - Comments []*Comment + // The full blob ID of the commit used to establish the after of the comparison. + AfterBlobId *string + + // The full commit ID of the commit used to establish the after of the comparison. + AfterCommitId *string // The full blob ID of the commit used to establish the before of the comparison. BeforeBlobId *string @@ -260,19 +262,17 @@ type CommentsForComparedCommit struct { // The full commit ID of the commit used to establish the before of the comparison. BeforeCommitId *string - // The name of the repository that contains the compared commits. - RepositoryName *string + // An array of comment objects. Each comment object contains information about a + // comment on the comparison between commits. + Comments []*Comment // Location information about the comment on the comparison, including the file // name, line number, and whether the version of the file where the comment was // made is BEFORE or AFTER. Location *Location - // The full blob ID of the commit used to establish the after of the comparison. - AfterBlobId *string - - // The full commit ID of the commit used to establish the after of the comparison. - AfterCommitId *string + // The name of the repository that contains the compared commits. + RepositoryName *string } // Returns information about comments on a pull request. @@ -281,34 +281,34 @@ type CommentsForPullRequest struct { // The full blob ID of the file on which you want to comment on the source commit. AfterBlobId *string - // Location information about the comment on the pull request, including the file - // name, line number, and whether the version of the file where the comment was - // made is BEFORE (destination branch) or AFTER (source branch). - Location *Location - // The full commit ID of the commit that was the tip of the source branch at the // time the comment was made. AfterCommitId *string + // The full blob ID of the file on which you want to comment on the destination + // commit. + BeforeBlobId *string + // The full commit ID of the commit that was the tip of the destination branch when // the pull request was created. This commit is superceded by the after commit in // the source branch when and if you merge the source branch into the destination // branch. BeforeCommitId *string - // The full blob ID of the file on which you want to comment on the destination - // commit. - BeforeBlobId *string + // An array of comment objects. Each comment object contains information about a + // comment on the pull request. + Comments []*Comment + + // Location information about the comment on the pull request, including the file + // name, line number, and whether the version of the file where the comment was + // made is BEFORE (destination branch) or AFTER (source branch). + Location *Location // The system-generated ID of the pull request. PullRequestId *string // The name of the repository that contains the pull request. RepositoryName *string - - // An array of comment objects. Each comment object contains information about a - // comment on the pull request. - Comments []*Comment } // Returns information about a specific commit. @@ -317,20 +317,13 @@ type Commit struct { // Any other data associated with the specified commit. AdditionalData *string - // A list of parent commits for the specified commit. Each parent commit ID is the - // full commit ID. - Parents []*string - - // The full SHA ID of the specified commit. - CommitId *string - // Information about the author of the specified commit. Information includes the // date in timestamp format with GMT offset, the name of the author, and the email // address for the author, as configured in Git. Author *UserInfo - // The commit message associated with the specified commit. - Message *string + // The full SHA ID of the specified commit. + CommitId *string // Information about the person who committed the specified commit, also known as // the committer. Information includes the date in timestamp format with GMT @@ -340,6 +333,13 @@ type Commit struct { // (http://git-scm.com/book/ch2-3.html) in Pro Git by Scott Chacon and Ben Straub. Committer *UserInfo + // The commit message associated with the specified commit. + Message *string + + // A list of parent commits for the specified commit. Each parent commit ID is the + // full commit ID. + Parents []*string + // Tree information for the specified commit. TreeId *string } @@ -347,28 +347,30 @@ type Commit struct { // Information about conflicts in a merge operation. type Conflict struct { + // Metadata about a conflict in a merge operation. + ConflictMetadata *ConflictMetadata + // A list of hunks that contain the differences between files or lines causing the // conflict. MergeHunks []*MergeHunk - - // Metadata about a conflict in a merge operation. - ConflictMetadata *ConflictMetadata } // Information about the metadata for a conflict in a merge operation. type ConflictMetadata struct { + // A boolean value indicating whether there are conflicts in the content of a file. + ContentConflict *bool + // A boolean value indicating whether there are conflicts in the file mode of a // file. FileModeConflict *bool - // Whether an add, modify, or delete operation caused the conflict between the - // source and destination of the merge. - MergeOperations *MergeOperations - // The file modes of the file in the source, destination, and base of the merge. FileModes *FileModes + // The path of the file that contains conflicts. + FilePath *string + // The file sizes of the file in the source, destination, and base of the merge. FileSizes *FileSizes @@ -376,14 +378,9 @@ type ConflictMetadata struct { // in the source, destination, and base of the merge. IsBinaryFile *IsBinaryFile - // Information about any object type conflicts in a merge operation. - ObjectTypes *ObjectTypes - - // A boolean value indicating whether there are conflicts in the content of a file. - ContentConflict *bool - - // The path of the file that contains conflicts. - FilePath *string + // Whether an add, modify, or delete operation caused the conflict between the + // source and destination of the merge. + MergeOperations *MergeOperations // The number of conflicts, including both hunk conflicts and metadata conflicts. NumberOfConflicts *int32 @@ -391,6 +388,9 @@ type ConflictMetadata struct { // A boolean value (true or false) indicating whether there are conflicts between // the branches in the object type of a file, folder, or submodule. ObjectTypeConflict *bool + + // Information about any object type conflicts in a merge operation. + ObjectTypes *ObjectTypes } // If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when @@ -419,17 +419,17 @@ type DeleteFileEntry struct { // Returns information about a set of differences for a commit specifier. type Difference struct { - // Whether the change type of the difference is an addition (A), deletion (D), or - // modification (M). - ChangeType ChangeTypeEnum + // Information about an afterBlob data type object, including the ID, the file mode + // permission code, and the path. + AfterBlob *BlobMetadata // Information about a beforeBlob data type object, including the ID, the file mode // permission code, and the path. BeforeBlob *BlobMetadata - // Information about an afterBlob data type object, including the ID, the file mode - // permission code, and the path. - AfterBlob *BlobMetadata + // Whether the change type of the difference is an addition (A), deletion (D), or + // modification (M). + ChangeType ChangeTypeEnum } // Returns information about the approval rules applied to a pull request and @@ -439,15 +439,15 @@ type Evaluation struct { // The names of the approval rules that have not had their conditions met. ApprovalRulesNotSatisfied []*string - // Whether the approval rule requirements for the pull request have been overridden - // and no longer need to be met. - Overridden *bool - // The names of the approval rules that have had their conditions met. ApprovalRulesSatisfied []*string // Whether the state of the pull request is approved. Approved *bool + + // Whether the approval rule requirements for the pull request have been overridden + // and no longer need to be met. + Overridden *bool } // Returns information about a file in a repository. @@ -470,13 +470,13 @@ type File struct { // A file to be added, updated, or deleted as part of a commit. type FileMetadata struct { - // The blob ID that contains the file information. - BlobId *string - // The full path to the file to be added or updated, including the name of the // file. AbsolutePath *string + // The blob ID that contains the file information. + BlobId *string + // The extrapolated file mode permissions for the file. Valid values include // EXECUTABLE and NORMAL. FileMode FileModeTypeEnum @@ -498,12 +498,12 @@ type FileModes struct { // Information about the size of files in a merge or pull request. type FileSizes struct { - // The size of a file in the destination of a merge or pull request. - Destination *int64 - // The size of a file in the base of a merge or pull request. Base *int64 + // The size of a file in the destination of a merge or pull request. + Destination *int64 + // The size of a file in the source of a merge or pull request. Source *int64 } @@ -511,6 +511,9 @@ type FileSizes struct { // Returns information about a folder in a repository. type Folder struct { + // The fully qualified path of the folder in the repository. + AbsolutePath *string + // The relative path of the specified folder from the folder where the query // originated. RelativePath *string @@ -518,9 +521,6 @@ type Folder struct { // The full SHA-1 pointer of the tree information for the commit that contains the // folder. TreeId *string - - // The fully qualified path of the folder in the repository. - AbsolutePath *string } // Information about whether a file is binary or textual in a merge or pull request @@ -531,13 +531,13 @@ type IsBinaryFile struct { // request. Base *bool - // The binary or non-binary status of file in the source of a merge or pull - // request. - Source *bool - // The binary or non-binary status of a file in the destination of a merge or pull // request. Destination *bool + + // The binary or non-binary status of file in the source of a merge or pull + // request. + Source *bool } // Returns information about the location of a change or comment in the comparison @@ -548,13 +548,13 @@ type Location struct { // if any. FilePath *string + // The position of a change in a compared file, in line number format. + FilePosition *int64 + // In a comparison of commits or a pull request, whether the change is in the // before or after of that comparison. RelativeFileVersion RelativeFileVersionEnum - - // The position of a change in a compared file, in line number format. - FilePosition *int64 -} +} // Information about merge hunks in a merge or pull request operation. type MergeHunk struct { @@ -562,8 +562,8 @@ type MergeHunk struct { // Information about the merge hunk in the base of a merge or pull request. Base *MergeHunkDetail - // Information about the merge hunk in the source of a merge or pull request. - Source *MergeHunkDetail + // Information about the merge hunk in the destination of a merge or pull request. + Destination *MergeHunkDetail // A Boolean value indicating whether a combination of hunks contains a conflict. // Conflicts occur when the same file or the same lines in a file were modified in @@ -573,8 +573,8 @@ type MergeHunk struct { // to true. IsConflict *bool - // Information about the merge hunk in the destination of a merge or pull request. - Destination *MergeHunkDetail + // Information about the merge hunk in the source of a merge or pull request. + Source *MergeHunkDetail } // Information about the details of a merge hunk that contains a conflict in a @@ -596,17 +596,17 @@ type MergeHunkDetail struct { // and a destination reference in a pull request. type MergeMetadata struct { - // The merge strategy used in the merge. - MergeOption MergeOptionTypeEnum - - // The Amazon Resource Name (ARN) of the user who merged the branches. - MergedBy *string - // A Boolean value indicating whether the merge has been made. IsMerged *bool // The commit ID for the merge commit, if any. MergeCommitId *string + + // The merge strategy used in the merge. + MergeOption MergeOptionTypeEnum + + // The Amazon Resource Name (ARN) of the user who merged the branches. + MergedBy *string } // Information about the file operation conflicts in a merge operation. @@ -623,33 +623,35 @@ type MergeOperations struct { // Information about the type of an object in a merge operation. type ObjectTypes struct { + // The type of the object in the base commit of the merge. + Base ObjectTypeEnum + // The type of the object in the destination branch. Destination ObjectTypeEnum // The type of the object in the source branch. Source ObjectTypeEnum - - // The type of the object in the base commit of the merge. - Base ObjectTypeEnum } // Returns information about the template that created the approval rule for a pull // request. type OriginApprovalRuleTemplate struct { - // The name of the template that created the approval rule. - ApprovalRuleTemplateName *string - // The ID of the template that created the approval rule. ApprovalRuleTemplateId *string + + // The name of the template that created the approval rule. + ApprovalRuleTemplateName *string } // Returns information about a pull request. type PullRequest struct { - // The user-defined description of the pull request. This description can be used - // to clarify what should be reviewed and other details of the request. - Description *string + // The approval rules applied to the pull request. + ApprovalRules []*ApprovalRule + + // The Amazon Resource Name (ARN) of the user who created the pull request. + AuthorArn *string // A unique, client-generated idempotency token that, when provided in a request, // ensures the request cannot be repeated with a changed parameter. If a request is @@ -657,12 +659,12 @@ type PullRequest struct { // information about the initial request that used that token. ClientRequestToken *string - // The Amazon Resource Name (ARN) of the user who created the pull request. - AuthorArn *string + // The date and time the pull request was originally created, in timestamp format. + CreationDate *time.Time - // The status of the pull request. Pull request status can only change from OPEN to - // CLOSED. - PullRequestStatus PullRequestStatusEnum + // The user-defined description of the pull request. This description can be used + // to clarify what should be reviewed and other details of the request. + Description *string // The day and time of the last user or system activity on the pull request, in // timestamp format. @@ -671,15 +673,9 @@ type PullRequest struct { // The system-generated ID of the pull request. PullRequestId *string - // The date and time the pull request was originally created, in timestamp format. - CreationDate *time.Time - - // The approval rules applied to the pull request. - ApprovalRules []*ApprovalRule - - // The user-defined title of the pull request. This title is displayed in the list - // of pull requests to other repository users. - Title *string + // The status of the pull request. Pull request status can only change from OPEN to + // CLOSED. + PullRequestStatus PullRequestStatusEnum // The targets of the pull request, including the source branch and destination // branch for the pull request. @@ -687,12 +683,20 @@ type PullRequest struct { // The system-generated revision ID for the pull request. RevisionId *string + + // The user-defined title of the pull request. This title is displayed in the list + // of pull requests to other repository users. + Title *string } // Metadata about the pull request that is used when comparing the pull request // source with its destination. type PullRequestCreatedEventMetadata struct { + // The commit ID of the tip of the branch specified as the destination branch when + // the pull request was created. + DestinationCommitId *string + // The commit ID of the most recent commit that the source branch and the // destination branch have in common. MergeBase *string @@ -700,10 +704,6 @@ type PullRequestCreatedEventMetadata struct { // The name of the repository where the pull request was created. RepositoryName *string - // The commit ID of the tip of the branch specified as the destination branch when - // the pull request was created. - DestinationCommitId *string - // The commit ID on the source branch used when the pull request was created. SourceCommitId *string } @@ -711,42 +711,42 @@ type PullRequestCreatedEventMetadata struct { // Returns information about a pull request event. type PullRequestEvent struct { - // Information about the change in status for the pull request event. - PullRequestStatusChangedEventMetadata *PullRequestStatusChangedEventMetadata + // The Amazon Resource Name (ARN) of the user whose actions resulted in the event. + // Examples include updating the pull request with more commits or changing the + // status of a pull request. + ActorArn *string + + // Information about a pull request event. + ApprovalRuleEventMetadata *ApprovalRuleEventMetadata // Information about an approval rule override event for a pull request. ApprovalRuleOverriddenEventMetadata *ApprovalRuleOverriddenEventMetadata - // The type of the pull request event (for example, a status change event - // (PULL_REQUEST_STATUS_CHANGED) or update event - // (PULL_REQUEST_SOURCE_REFERENCE_UPDATED)). - PullRequestEventType PullRequestEventType + // Information about an approval state change for a pull request. + ApprovalStateChangedEventMetadata *ApprovalStateChangedEventMetadata + + // The day and time of the pull request event, in timestamp format. + EventDate *time.Time // Information about the source and destination branches for the pull request. PullRequestCreatedEventMetadata *PullRequestCreatedEventMetadata - // Information about the updated source branch for the pull request event. - PullRequestSourceReferenceUpdatedEventMetadata *PullRequestSourceReferenceUpdatedEventMetadata - - // Information about an approval state change for a pull request. - ApprovalStateChangedEventMetadata *ApprovalStateChangedEventMetadata - - // Information about a pull request event. - ApprovalRuleEventMetadata *ApprovalRuleEventMetadata + // The type of the pull request event (for example, a status change event + // (PULL_REQUEST_STATUS_CHANGED) or update event + // (PULL_REQUEST_SOURCE_REFERENCE_UPDATED)). + PullRequestEventType PullRequestEventType // The system-generated ID of the pull request. PullRequestId *string - // The day and time of the pull request event, in timestamp format. - EventDate *time.Time - - // The Amazon Resource Name (ARN) of the user whose actions resulted in the event. - // Examples include updating the pull request with more commits or changing the - // status of a pull request. - ActorArn *string - // Information about the change in mergability state for the pull request event. PullRequestMergedStateChangedEventMetadata *PullRequestMergedStateChangedEventMetadata + + // Information about the updated source branch for the pull request event. + PullRequestSourceReferenceUpdatedEventMetadata *PullRequestSourceReferenceUpdatedEventMetadata + + // Information about the change in status for the pull request event. + PullRequestStatusChangedEventMetadata *PullRequestStatusChangedEventMetadata } // Returns information about the change in the merge state for a pull request @@ -756,24 +756,24 @@ type PullRequestMergedStateChangedEventMetadata struct { // The name of the branch that the pull request is merged into. DestinationReference *string - // The name of the repository where the pull request was created. - RepositoryName *string - // Information about the merge state change event. MergeMetadata *MergeMetadata + + // The name of the repository where the pull request was created. + RepositoryName *string } // Information about an update to the source branch of a pull request. type PullRequestSourceReferenceUpdatedEventMetadata struct { - // The full commit ID of the commit in the destination branch that was the tip of - // the branch at the time the pull request was updated. - BeforeCommitId *string - // The full commit ID of the commit in the source branch that was the tip of the // branch at the time the pull request was updated. AfterCommitId *string + // The full commit ID of the commit in the destination branch that was the tip of + // the branch at the time the pull request was updated. + BeforeCommitId *string + // The commit ID of the most recent commit that the source branch and the // destination branch have in common. MergeBase *string @@ -792,17 +792,25 @@ type PullRequestStatusChangedEventMetadata struct { // Returns information about a pull request target. type PullRequestTarget struct { - // The name of the repository that contains the pull request source and destination - // branches. - RepositoryName *string + // The full commit ID that is the tip of the destination branch. This is the commit + // where the pull request was or will be merged. + DestinationCommit *string // The branch of the repository where the pull request changes are merged. Also // known as the destination branch. DestinationReference *string - // The full commit ID that is the tip of the destination branch. This is the commit - // where the pull request was or will be merged. - DestinationCommit *string + // The commit ID of the most recent commit that the source branch and the + // destination branch have in common. + MergeBase *string + + // Returns metadata about the state of the merge, including whether the merge has + // been made. + MergeMetadata *MergeMetadata + + // The name of the repository that contains the pull request source and destination + // branches. + RepositoryName *string // The full commit ID of the tip of the source branch used to create the pull // request. If the pull request branch is updated by a push while the pull request @@ -812,27 +820,11 @@ type PullRequestTarget struct { // The branch of the repository that contains the changes for the pull request. // Also known as the source branch. SourceReference *string - - // Returns metadata about the state of the merge, including whether the merge has - // been made. - MergeMetadata *MergeMetadata - - // The commit ID of the most recent commit that the source branch and the - // destination branch have in common. - MergeBase *string } // Information about a file added or updated as part of a commit. type PutFileEntry struct { - // The name and full path of the file that contains the changes you want to make as - // part of the commit, if you are not providing the file content directly. - SourceFile *SourceFileSpecifier - - // The extrapolated file mode permissions for the file. Valid values include - // EXECUTABLE and NORMAL. - FileMode FileModeTypeEnum - // The full path to the file in the repository, including the name of the file. // // This member is required. @@ -840,11 +832,22 @@ type PutFileEntry struct { // The content of the file, if a source file is not specified. FileContent []byte + + // The extrapolated file mode permissions for the file. Valid values include + // EXECUTABLE and NORMAL. + FileMode FileModeTypeEnum + + // The name and full path of the file that contains the changes you want to make as + // part of the commit, if you are not providing the file content directly. + SourceFile *SourceFileSpecifier } // Information about the reaction values provided by users on a comment. type ReactionForComment struct { + // The reaction for a specified comment. + Reaction *ReactionValueFormats + // The Amazon Resource Names (ARNs) of users who have provided reactions to the // comment. ReactionUsers []*string @@ -853,9 +856,6 @@ type ReactionForComment struct { // have been subsequently deleted from IAM. While these IAM users or roles no // longer exist, the reactions might still appear in total reaction counts. ReactionsFromDeletedUsersCount *int32 - - // The reaction for a specified comment. - Reaction *ReactionValueFormats } // Information about the values for reactions to a comment. AWS CodeCommit supports @@ -866,24 +866,18 @@ type ReactionValueFormats struct { // slightly differently on different operating systems. Emoji *string - // The Unicode codepoint for the reaction. - Unicode *string - // The emoji short code for the reaction. Short codes are interpreted slightly // differently on different operating systems. ShortCode *string + + // The Unicode codepoint for the reaction. + Unicode *string } // Information about a replacement content entry in the conflict of a merge or pull // request operation. type ReplaceContentEntry struct { - // The base-64 encoded content to use when the replacement type is USE_NEW_CONTENT. - Content []byte - - // The file mode to apply during conflict resoltion. - FileMode FileModeTypeEnum - // The path of the conflicting file. // // This member is required. @@ -893,40 +887,46 @@ type ReplaceContentEntry struct { // // This member is required. ReplacementType ReplacementTypeEnum + + // The base-64 encoded content to use when the replacement type is USE_NEW_CONTENT. + Content []byte + + // The file mode to apply during conflict resoltion. + FileMode FileModeTypeEnum } // Information about a repository. type RepositoryMetadata struct { - // The URL to use for cloning the repository over HTTPS. - CloneUrlHttp *string - - // A comment or description about the repository. - RepositoryDescription *string + // The ID of the AWS account associated with the repository. + AccountId *string - // The ID of the repository. - RepositoryId *string + // The Amazon Resource Name (ARN) of the repository. + Arn *string - // The date and time the repository was last modified, in timestamp format. - LastModifiedDate *time.Time + // The URL to use for cloning the repository over HTTPS. + CloneUrlHttp *string // The URL to use for cloning the repository over SSH. CloneUrlSsh *string - // The ID of the AWS account associated with the repository. - AccountId *string + // The date and time the repository was created, in timestamp format. + CreationDate *time.Time // The repository's default branch name. DefaultBranch *string - // The repository's name. - RepositoryName *string + // The date and time the repository was last modified, in timestamp format. + LastModifiedDate *time.Time - // The date and time the repository was created, in timestamp format. - CreationDate *time.Time + // A comment or description about the repository. + RepositoryDescription *string - // The Amazon Resource Name (ARN) of the repository. - Arn *string + // The ID of the repository. + RepositoryId *string + + // The repository's name. + RepositoryName *string } // Information about a repository name and ID. @@ -942,32 +942,32 @@ type RepositoryNameIdPair struct { // Information about a trigger for a repository. type RepositoryTrigger struct { - // Any custom data associated with the trigger to be included in the information - // sent to the target of the trigger. - CustomData *string - // The ARN of the resource that is the target for a trigger (for example, the ARN // of a topic in Amazon SNS). // // This member is required. DestinationArn *string - // The branches to be included in the trigger configuration. If you specify an - // empty array, the trigger applies to all branches. Although no content is - // required in the array, you must include the array itself. - Branches []*string - - // The name of the trigger. - // - // This member is required. - Name *string - // The repository events that cause the trigger to run actions in another service, // such as sending a notification through Amazon SNS.

    The valid // value "all" cannot be used with any other values.

     // // This member is required. Events []RepositoryTriggerEventEnum + + // The name of the trigger. + // + // This member is required. + Name *string + + // The branches to be included in the trigger configuration. If you specify an + // empty array, the trigger applies to all branches. Although no content is + // required in the array, you must include the array itself. + Branches []*string + + // Any custom data associated with the trigger to be included in the information + // sent to the target of the trigger. + CustomData *string } // A trigger failed to run. @@ -997,13 +997,13 @@ type SetFileModeEntry struct { // Information about a source file that is part of changes made in a commit. type SourceFileSpecifier struct { - // Whether to remove the source file from the parent commit. - IsMove *bool - // The full path to the file, including the name of the file. // // This member is required. FilePath *string + + // Whether to remove the source file from the parent commit. + IsMove *bool } // Returns information about a submodule reference in a repository folder. @@ -1013,44 +1013,44 @@ type SubModule struct { // submodule. AbsolutePath *string - // The relative path of the submodule from the folder where the query originated. - RelativePath *string - // The commit ID that contains the reference to the submodule. CommitId *string + + // The relative path of the submodule from the folder where the query originated. + RelativePath *string } // Returns information about a symbolic link in a repository folder. type SymbolicLink struct { + // The fully qualified path to the folder that contains the symbolic link. + AbsolutePath *string + // The blob ID that contains the information about the symbolic link. BlobId *string - // The relative path of the symbolic link from the folder where the query - // originated. - RelativePath *string - // The file mode permissions of the blob that cotains information about the // symbolic link. FileMode FileModeTypeEnum - // The fully qualified path to the folder that contains the symbolic link. - AbsolutePath *string + // The relative path of the symbolic link from the folder where the query + // originated. + RelativePath *string } // Returns information about a target for a pull request. type Target struct { - // The branch of the repository that contains the changes for the pull request. - // Also known as the source branch. + // The name of the repository that contains the pull request. // // This member is required. - SourceReference *string + RepositoryName *string - // The name of the repository that contains the pull request. + // The branch of the repository that contains the changes for the pull request. + // Also known as the source branch. // // This member is required. - RepositoryName *string + SourceReference *string // The branch of the repository where the pull request changes are merged. Also // known as the destination branch. @@ -1060,13 +1060,13 @@ type Target struct { // Information about the user who made a specified commit. type UserInfo struct { - // The name of the user who made the specified commit. - Name *string - // The date when the specified commit was commited, in timestamp format with GMT // offset. Date *string // The email address associated with the user who made the commit, if any. Email *string + + // The name of the user who made the specified commit. + Name *string } diff --git a/service/codedeploy/api_op_BatchGetApplicationRevisions.go b/service/codedeploy/api_op_BatchGetApplicationRevisions.go index 47851f8fcbb..cb07121399d 100644 --- a/service/codedeploy/api_op_BatchGetApplicationRevisions.go +++ b/service/codedeploy/api_op_BatchGetApplicationRevisions.go @@ -59,32 +59,32 @@ func (c *Client) BatchGetApplicationRevisions(ctx context.Context, params *Batch // Represents the input of a BatchGetApplicationRevisions operation. type BatchGetApplicationRevisionsInput struct { + // The name of an AWS CodeDeploy application about which to get revision + // information. + // + // This member is required. + ApplicationName *string + // An array of RevisionLocation objects that specify information to get about the // application revisions, including type and location. The maximum number of // RevisionLocation objects you can specify is 25. // // This member is required. Revisions []*types.RevisionLocation - - // The name of an AWS CodeDeploy application about which to get revision - // information. - // - // This member is required. - ApplicationName *string } // Represents the output of a BatchGetApplicationRevisions operation. type BatchGetApplicationRevisionsOutput struct { + // The name of the application that corresponds to the revisions. + ApplicationName *string + // Information about errors that might have occurred during the API call. ErrorMessage *string // Additional information about the revisions, including the type and location. Revisions []*types.RevisionInfo - // The name of the application that corresponds to the revisions. - ApplicationName *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codedeploy/api_op_BatchGetDeploymentGroups.go b/service/codedeploy/api_op_BatchGetDeploymentGroups.go index c13f95a1b0f..2b082c019db 100644 --- a/service/codedeploy/api_op_BatchGetDeploymentGroups.go +++ b/service/codedeploy/api_op_BatchGetDeploymentGroups.go @@ -58,27 +58,27 @@ func (c *Client) BatchGetDeploymentGroups(ctx context.Context, params *BatchGetD // Represents the input of a BatchGetDeploymentGroups operation. type BatchGetDeploymentGroupsInput struct { - // The names of the deployment groups. - // - // This member is required. - DeploymentGroupNames []*string - // The name of an AWS CodeDeploy application associated with the applicable IAM // user or AWS account. // // This member is required. ApplicationName *string + + // The names of the deployment groups. + // + // This member is required. + DeploymentGroupNames []*string } // Represents the output of a BatchGetDeploymentGroups operation. type BatchGetDeploymentGroupsOutput struct { - // Information about errors that might have occurred during the API call. - ErrorMessage *string - // Information about the deployment groups. DeploymentGroupsInfo []*types.DeploymentGroupInfo + // Information about errors that might have occurred during the API call. + ErrorMessage *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codedeploy/api_op_BatchGetDeploymentInstances.go b/service/codedeploy/api_op_BatchGetDeploymentInstances.go index 234a0c85349..16398893304 100644 --- a/service/codedeploy/api_op_BatchGetDeploymentInstances.go +++ b/service/codedeploy/api_op_BatchGetDeploymentInstances.go @@ -62,27 +62,27 @@ func (c *Client) BatchGetDeploymentInstances(ctx context.Context, params *BatchG // Represents the input of a BatchGetDeploymentInstances operation. type BatchGetDeploymentInstancesInput struct { - // The unique IDs of instances used in the deployment. The maximum number of - // instance IDs you can specify is 25. + // The unique ID of a deployment. // // This member is required. - InstanceIds []*string + DeploymentId *string - // The unique ID of a deployment. + // The unique IDs of instances used in the deployment. The maximum number of + // instance IDs you can specify is 25. // // This member is required. - DeploymentId *string + InstanceIds []*string } // Represents the output of a BatchGetDeploymentInstances operation. type BatchGetDeploymentInstancesOutput struct { - // Information about the instance. - InstancesSummary []*types.InstanceSummary - // Information about errors that might have occurred during the API call. ErrorMessage *string + // Information about the instance. + InstancesSummary []*types.InstanceSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codedeploy/api_op_BatchGetDeploymentTargets.go b/service/codedeploy/api_op_BatchGetDeploymentTargets.go index f49280fcaa0..ee9a7ba4bf0 100644 --- a/service/codedeploy/api_op_BatchGetDeploymentTargets.go +++ b/service/codedeploy/api_op_BatchGetDeploymentTargets.go @@ -72,6 +72,9 @@ func (c *Client) BatchGetDeploymentTargets(ctx context.Context, params *BatchGet type BatchGetDeploymentTargetsInput struct { + // The unique ID of a deployment. + DeploymentId *string + // The unique IDs of the deployment targets. The compute platform of the deployment // determines the type of the targets and their formats. The maximum number of // deployment target IDs you can specify is 25. @@ -93,9 +96,6 @@ type BatchGetDeploymentTargetsInput struct { // target IDs are CloudFormation stack IDs. Their target type is // cloudFormationTarget. TargetIds []*string - - // The unique ID of a deployment. - DeploymentId *string } type BatchGetDeploymentTargetsOutput struct { diff --git a/service/codedeploy/api_op_CreateApplication.go b/service/codedeploy/api_op_CreateApplication.go index 15645be84e6..00e1a934523 100644 --- a/service/codedeploy/api_op_CreateApplication.go +++ b/service/codedeploy/api_op_CreateApplication.go @@ -64,13 +64,13 @@ type CreateApplicationInput struct { // This member is required. ApplicationName *string + // The destination platform type for the deployment (Lambda, Server, or ECS). + ComputePlatform types.ComputePlatform + // The metadata that you apply to CodeDeploy applications to help you organize and // categorize them. Each tag consists of a key and an optional value, both of which // you define. Tags []*types.Tag - - // The destination platform type for the deployment (Lambda, Server, or ECS). - ComputePlatform types.ComputePlatform } // Represents the output of a CreateApplication operation. diff --git a/service/codedeploy/api_op_CreateDeployment.go b/service/codedeploy/api_op_CreateDeployment.go index 5d94fc98ae8..36ccb57e584 100644 --- a/service/codedeploy/api_op_CreateDeployment.go +++ b/service/codedeploy/api_op_CreateDeployment.go @@ -58,12 +58,25 @@ func (c *Client) CreateDeployment(ctx context.Context, params *CreateDeploymentI // Represents the input of a CreateDeployment operation. type CreateDeploymentInput struct { + // The name of an AWS CodeDeploy application associated with the IAM user or AWS + // account. + // + // This member is required. + ApplicationName *string + + // Configuration information for an automatic rollback that is added when a + // deployment is created. + AutoRollbackConfiguration *types.AutoRollbackConfiguration + // The name of a deployment configuration associated with the IAM user or AWS // account. If not specified, the value configured in the deployment group is used // as the default. If the deployment group does not have a deployment configuration // associated with it, CodeDeployDefault.OneAtATime is used by default. DeploymentConfigName *string + // The name of the deployment group. + DeploymentGroupName *string + // A comment about the deployment. Description *string @@ -83,10 +96,6 @@ type CreateDeploymentInput struct { // kept and used as part of the new deployment. FileExistsBehavior types.FileExistsBehavior - // Information about the instances that belong to the replacement environment in a - // blue/green deployment. - TargetInstances *types.TargetInstances - // If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic // deployment lifecycle event to an instance fails, then the deployment continues // to the next deployment lifecycle event. For example, if ApplicationStop fails, @@ -109,25 +118,16 @@ type CreateDeploymentInput struct { // and AfterBlockTraffic failures should be ignored.

    IgnoreApplicationStopFailures *bool - // Indicates whether to deploy to all instances or only to instances that are not - // running the latest application revision. - UpdateOutdatedInstancesOnly *bool - - // The name of the deployment group. - DeploymentGroupName *string - - // The name of an AWS CodeDeploy application associated with the IAM user or AWS - // account. - // - // This member is required. - ApplicationName *string - // The type and location of the revision to deploy. Revision *types.RevisionLocation - // Configuration information for an automatic rollback that is added when a - // deployment is created. - AutoRollbackConfiguration *types.AutoRollbackConfiguration + // Information about the instances that belong to the replacement environment in a + // blue/green deployment. + TargetInstances *types.TargetInstances + + // Indicates whether to deploy to all instances or only to instances that are not + // running the latest application revision. + UpdateOutdatedInstancesOnly *bool } // Represents the output of a CreateDeployment operation. diff --git a/service/codedeploy/api_op_CreateDeploymentConfig.go b/service/codedeploy/api_op_CreateDeploymentConfig.go index 4d1ac5f7ecf..9f582542f55 100644 --- a/service/codedeploy/api_op_CreateDeploymentConfig.go +++ b/service/codedeploy/api_op_CreateDeploymentConfig.go @@ -63,6 +63,9 @@ type CreateDeploymentConfigInput struct { // This member is required. DeploymentConfigName *string + // The destination platform type for the deployment (Lambda, Server, or ECS). + ComputePlatform types.ComputePlatform + // The minimum number of healthy instances that should be available at any time // during the deployment. There are two parameters expected in the input: type and // value. The type parameter takes either of the following values: @@ -84,9 +87,6 @@ type CreateDeploymentConfigInput struct { // The configuration that specifies how the deployment traffic is routed. TrafficRoutingConfig *types.TrafficRoutingConfig - - // The destination platform type for the deployment (Lambda, Server, or ECS). - ComputePlatform types.ComputePlatform } // Represents the output of a CreateDeploymentConfig operation. diff --git a/service/codedeploy/api_op_CreateDeploymentGroup.go b/service/codedeploy/api_op_CreateDeploymentGroup.go index f06dd8cab48..8d428d2cdff 100644 --- a/service/codedeploy/api_op_CreateDeploymentGroup.go +++ b/service/codedeploy/api_op_CreateDeploymentGroup.go @@ -58,42 +58,36 @@ func (c *Client) CreateDeploymentGroup(ctx context.Context, params *CreateDeploy // Represents the input of a CreateDeploymentGroup operation. type CreateDeploymentGroupInput struct { - // The on-premises instance tags on which to filter. The deployment group includes - // on-premises instances with any of the specified tags. Cannot be used in the same - // call as OnPremisesTagSet. - OnPremisesInstanceTagFilters []*types.TagFilter - - // Information about the type of deployment, in-place or blue/green, that you want - // to run and whether to route deployment traffic behind a load balancer. - DeploymentStyle *types.DeploymentStyle - - // Information about blue/green deployment options for a deployment group. - BlueGreenDeploymentConfiguration *types.BlueGreenDeploymentConfiguration - - // Information about groups of tags applied to on-premises instances. The - // deployment group includes only on-premises instances identified by all of the - // tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters. - OnPremisesTagSet *types.OnPremisesTagSet + // The name of an AWS CodeDeploy application associated with the IAM user or AWS + // account. + // + // This member is required. + ApplicationName *string - // A list of associated Amazon EC2 Auto Scaling groups. - AutoScalingGroups []*string + // The name of a new deployment group for the specified application. + // + // This member is required. + DeploymentGroupName *string - // The metadata that you apply to CodeDeploy deployment groups to help you organize - // and categorize them. Each tag consists of a key and an optional value, both of - // which you define. - Tags []*types.Tag + // A service role Amazon Resource Name (ARN) that allows AWS CodeDeploy to act on + // the user's behalf when interacting with AWS services. + // + // This member is required. + ServiceRoleArn *string // Information to add about Amazon CloudWatch alarms when the deployment group is // created. AlarmConfiguration *types.AlarmConfiguration - // The Amazon EC2 tags on which to filter. The deployment group includes EC2 - // instances with any of the specified tags. Cannot be used in the same call as - // ec2TagSet. - Ec2TagFilters []*types.EC2TagFilter + // Configuration information for an automatic rollback that is added when a + // deployment group is created. + AutoRollbackConfiguration *types.AutoRollbackConfiguration - // Information about the load balancer used in a deployment. - LoadBalancerInfo *types.LoadBalancerInfo + // A list of associated Amazon EC2 Auto Scaling groups. + AutoScalingGroups []*string + + // Information about blue/green deployment options for a deployment group. + BlueGreenDeploymentConfiguration *types.BlueGreenDeploymentConfiguration // If specified, the deployment configuration name can be either one of the // predefined configurations provided with AWS CodeDeploy or a custom deployment @@ -106,16 +100,19 @@ type CreateDeploymentGroupInput struct { // in the AWS CodeDeploy User Guide. DeploymentConfigName *string - // The name of a new deployment group for the specified application. - // - // This member is required. - DeploymentGroupName *string + // Information about the type of deployment, in-place or blue/green, that you want + // to run and whether to route deployment traffic behind a load balancer. + DeploymentStyle *types.DeploymentStyle - // Information about triggers to create when the deployment group is created. For - // examples, see Create a Trigger for an AWS CodeDeploy Event - // (https://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-notify-sns.html) - // in the AWS CodeDeploy User Guide. - TriggerConfigurations []*types.TriggerConfig + // The Amazon EC2 tags on which to filter. The deployment group includes EC2 + // instances with any of the specified tags. Cannot be used in the same call as + // ec2TagSet. + Ec2TagFilters []*types.EC2TagFilter + + // Information about groups of tags applied to EC2 instances. The deployment group + // includes only EC2 instances identified by all the tag groups. Cannot be used in + // the same call as ec2TagFilters. + Ec2TagSet *types.EC2TagSet // The target Amazon ECS services in the deployment group. This applies only to // deployment groups that use the Amazon ECS compute platform. A target Amazon ECS @@ -123,26 +120,29 @@ type CreateDeploymentGroupInput struct { // format :. EcsServices []*types.ECSService - // Configuration information for an automatic rollback that is added when a - // deployment group is created. - AutoRollbackConfiguration *types.AutoRollbackConfiguration + // Information about the load balancer used in a deployment. + LoadBalancerInfo *types.LoadBalancerInfo - // A service role Amazon Resource Name (ARN) that allows AWS CodeDeploy to act on - // the user's behalf when interacting with AWS services. - // - // This member is required. - ServiceRoleArn *string + // The on-premises instance tags on which to filter. The deployment group includes + // on-premises instances with any of the specified tags. Cannot be used in the same + // call as OnPremisesTagSet. + OnPremisesInstanceTagFilters []*types.TagFilter - // The name of an AWS CodeDeploy application associated with the IAM user or AWS - // account. - // - // This member is required. - ApplicationName *string + // Information about groups of tags applied to on-premises instances. The + // deployment group includes only on-premises instances identified by all of the + // tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters. + OnPremisesTagSet *types.OnPremisesTagSet - // Information about groups of tags applied to EC2 instances. The deployment group - // includes only EC2 instances identified by all the tag groups. Cannot be used in - // the same call as ec2TagFilters. - Ec2TagSet *types.EC2TagSet + // The metadata that you apply to CodeDeploy deployment groups to help you organize + // and categorize them. Each tag consists of a key and an optional value, both of + // which you define. + Tags []*types.Tag + + // Information about triggers to create when the deployment group is created. For + // examples, see Create a Trigger for an AWS CodeDeploy Event + // (https://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-notify-sns.html) + // in the AWS CodeDeploy User Guide. + TriggerConfigurations []*types.TriggerConfig } // Represents the output of a CreateDeploymentGroup operation. diff --git a/service/codedeploy/api_op_DeleteDeploymentGroup.go b/service/codedeploy/api_op_DeleteDeploymentGroup.go index d8835d2de9d..d9566cca079 100644 --- a/service/codedeploy/api_op_DeleteDeploymentGroup.go +++ b/service/codedeploy/api_op_DeleteDeploymentGroup.go @@ -58,16 +58,16 @@ func (c *Client) DeleteDeploymentGroup(ctx context.Context, params *DeleteDeploy // Represents the input of a DeleteDeploymentGroup operation. type DeleteDeploymentGroupInput struct { - // The name of a deployment group for the specified application. - // - // This member is required. - DeploymentGroupName *string - // The name of an AWS CodeDeploy application associated with the IAM user or AWS // account. // // This member is required. ApplicationName *string + + // The name of a deployment group for the specified application. + // + // This member is required. + DeploymentGroupName *string } // Represents the output of a DeleteDeploymentGroup operation. diff --git a/service/codedeploy/api_op_GetApplicationRevision.go b/service/codedeploy/api_op_GetApplicationRevision.go index 75abb98dac5..094c632e46f 100644 --- a/service/codedeploy/api_op_GetApplicationRevision.go +++ b/service/codedeploy/api_op_GetApplicationRevision.go @@ -72,14 +72,14 @@ type GetApplicationRevisionInput struct { // Represents the output of a GetApplicationRevision operation. type GetApplicationRevisionOutput struct { - // General information about the revision. - RevisionInfo *types.GenericRevisionInfo + // The name of the application that corresponds to the revision. + ApplicationName *string // Additional information about the revision, including type and location. Revision *types.RevisionLocation - // The name of the application that corresponds to the revision. - ApplicationName *string + // General information about the revision. + RevisionInfo *types.GenericRevisionInfo // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/codedeploy/api_op_GetDeploymentGroup.go b/service/codedeploy/api_op_GetDeploymentGroup.go index bf3d9f4cb51..16c81661f94 100644 --- a/service/codedeploy/api_op_GetDeploymentGroup.go +++ b/service/codedeploy/api_op_GetDeploymentGroup.go @@ -58,16 +58,16 @@ func (c *Client) GetDeploymentGroup(ctx context.Context, params *GetDeploymentGr // Represents the input of a GetDeploymentGroup operation. type GetDeploymentGroupInput struct { - // The name of a deployment group for the specified application. - // - // This member is required. - DeploymentGroupName *string - // The name of an AWS CodeDeploy application associated with the IAM user or AWS // account. // // This member is required. ApplicationName *string + + // The name of a deployment group for the specified application. + // + // This member is required. + DeploymentGroupName *string } // Represents the output of a GetDeploymentGroup operation. diff --git a/service/codedeploy/api_op_GetDeploymentInstance.go b/service/codedeploy/api_op_GetDeploymentInstance.go index e84ad6a1cef..698c356b3af 100644 --- a/service/codedeploy/api_op_GetDeploymentInstance.go +++ b/service/codedeploy/api_op_GetDeploymentInstance.go @@ -58,15 +58,15 @@ func (c *Client) GetDeploymentInstance(ctx context.Context, params *GetDeploymen // Represents the input of a GetDeploymentInstance operation. type GetDeploymentInstanceInput struct { - // The unique ID of an instance in the deployment group. + // The unique ID of a deployment. // // This member is required. - InstanceId *string + DeploymentId *string - // The unique ID of a deployment. + // The unique ID of an instance in the deployment group. // // This member is required. - DeploymentId *string + InstanceId *string } // Represents the output of a GetDeploymentInstance operation. diff --git a/service/codedeploy/api_op_GetDeploymentTarget.go b/service/codedeploy/api_op_GetDeploymentTarget.go index d06cbcafd8f..5137a135bfd 100644 --- a/service/codedeploy/api_op_GetDeploymentTarget.go +++ b/service/codedeploy/api_op_GetDeploymentTarget.go @@ -56,11 +56,11 @@ func (c *Client) GetDeploymentTarget(ctx context.Context, params *GetDeploymentT type GetDeploymentTargetInput struct { - // The unique ID of a deployment target. - TargetId *string - // The unique ID of a deployment. DeploymentId *string + + // The unique ID of a deployment target. + TargetId *string } type GetDeploymentTargetOutput struct { diff --git a/service/codedeploy/api_op_ListApplicationRevisions.go b/service/codedeploy/api_op_ListApplicationRevisions.go index 5310de4edbd..b57fae57cbd 100644 --- a/service/codedeploy/api_op_ListApplicationRevisions.go +++ b/service/codedeploy/api_op_ListApplicationRevisions.go @@ -58,16 +58,32 @@ func (c *Client) ListApplicationRevisions(ctx context.Context, params *ListAppli // Represents the input of a ListApplicationRevisions operation. type ListApplicationRevisionsInput struct { - // An Amazon S3 bucket name to limit the search for revisions. If set to null, all - // of the user's buckets are searched. - S3Bucket *string - // The name of an AWS CodeDeploy application associated with the IAM user or AWS // account. // // This member is required. ApplicationName *string + // Whether to list revisions based on whether the revision is the target revision + // of a deployment group: + // + // * include: List revisions that are target revisions + // of a deployment group. + // + // * exclude: Do not list revisions that are target + // revisions of a deployment group. + // + // * ignore: List all revisions. + Deployed types.ListStateFilterAction + + // An identifier returned from the previous ListApplicationRevisions call. It can + // be used to return the next set of applications in the list. + NextToken *string + + // An Amazon S3 bucket name to limit the search for revisions. If set to null, all + // of the user's buckets are searched. + S3Bucket *string + // A key prefix for the set of Amazon S3 objects to limit the search for revisions. S3KeyPrefix *string @@ -87,22 +103,6 @@ type ListApplicationRevisionsInput struct { // arbitrary order. SortBy types.ApplicationRevisionSortBy - // Whether to list revisions based on whether the revision is the target revision - // of a deployment group: - // - // * include: List revisions that are target revisions - // of a deployment group. - // - // * exclude: Do not list revisions that are target - // revisions of a deployment group. - // - // * ignore: List all revisions. - Deployed types.ListStateFilterAction - - // An identifier returned from the previous ListApplicationRevisions call. It can - // be used to return the next set of applications in the list. - NextToken *string - // The order in which to sort the list results: // // * ascending: ascending diff --git a/service/codedeploy/api_op_ListDeploymentGroups.go b/service/codedeploy/api_op_ListDeploymentGroups.go index 2e6b4592107..303f4d57ab8 100644 --- a/service/codedeploy/api_op_ListDeploymentGroups.go +++ b/service/codedeploy/api_op_ListDeploymentGroups.go @@ -75,14 +75,14 @@ type ListDeploymentGroupsOutput struct { // The application name. ApplicationName *string + // A list of deployment group names. + DeploymentGroups []*string + // If a large amount of information is returned, an identifier is also returned. It // can be used in a subsequent list deployment groups call to return the next set // of deployment groups in the list. NextToken *string - // A list of deployment group names. - DeploymentGroups []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codedeploy/api_op_ListDeploymentInstances.go b/service/codedeploy/api_op_ListDeploymentInstances.go index 75b51e3d880..5204ff46727 100644 --- a/service/codedeploy/api_op_ListDeploymentInstances.go +++ b/service/codedeploy/api_op_ListDeploymentInstances.go @@ -66,15 +66,6 @@ type ListDeploymentInstancesInput struct { // This member is required. DeploymentId *string - // An identifier returned from the previous list deployment instances call. It can - // be used to return the next set of deployment instances in the list. - NextToken *string - - // The set of instances in a blue/green deployment, either those in the original - // environment ("BLUE") or those in the replacement environment ("GREEN"), for - // which you want to view instance information. - InstanceTypeFilter []types.InstanceType - // A subset of instances to list by status: // // * Pending: Include those instances @@ -94,19 +85,28 @@ type ListDeploymentInstancesInput struct { // // * Unknown: Include those instances with deployments in an unknown state. InstanceStatusFilter []types.InstanceStatus + + // The set of instances in a blue/green deployment, either those in the original + // environment ("BLUE") or those in the replacement environment ("GREEN"), for + // which you want to view instance information. + InstanceTypeFilter []types.InstanceType + + // An identifier returned from the previous list deployment instances call. It can + // be used to return the next set of deployment instances in the list. + NextToken *string } // Represents the output of a ListDeploymentInstances operation. type ListDeploymentInstancesOutput struct { + // A list of instance IDs. + InstancesList []*string + // If a large amount of information is returned, an identifier is also returned. It // can be used in a subsequent list deployment instances call to return the next // set of deployment instances in the list. NextToken *string - // A list of instance IDs. - InstancesList []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codedeploy/api_op_ListDeploymentTargets.go b/service/codedeploy/api_op_ListDeploymentTargets.go index 7d77ff6a3be..bae1cbf73f4 100644 --- a/service/codedeploy/api_op_ListDeploymentTargets.go +++ b/service/codedeploy/api_op_ListDeploymentTargets.go @@ -55,6 +55,13 @@ func (c *Client) ListDeploymentTargets(ctx context.Context, params *ListDeployme type ListDeploymentTargetsInput struct { + // The unique ID of a deployment. + DeploymentId *string + + // A token identifier returned from the previous ListDeploymentTargets call. It can + // be used to return the next set of deployment targets in the list. + NextToken *string + // A key used to filter the returned targets. The two valid values are: // // * @@ -64,13 +71,6 @@ type ListDeploymentTargetsInput struct { // * ServerInstanceLabel - A // ServerInstanceLabel filter string can be Blue or Green. TargetFilters map[string][]*string - - // A token identifier returned from the previous ListDeploymentTargets call. It can - // be used to return the next set of deployment targets in the list. - NextToken *string - - // The unique ID of a deployment. - DeploymentId *string } type ListDeploymentTargetsOutput struct { diff --git a/service/codedeploy/api_op_ListDeployments.go b/service/codedeploy/api_op_ListDeployments.go index 7d57d563555..a157da78a93 100644 --- a/service/codedeploy/api_op_ListDeployments.go +++ b/service/codedeploy/api_op_ListDeployments.go @@ -58,28 +58,24 @@ func (c *Client) ListDeployments(ctx context.Context, params *ListDeploymentsInp // Represents the input of a ListDeployments operation. type ListDeploymentsInput struct { - // A time range (start and end) for returning a subset of the list of deployments. - CreateTimeRange *types.TimeRange - - // The unique ID of an external resource for returning deployments linked to the - // external resource. - ExternalId *string - // The name of an AWS CodeDeploy application associated with the IAM user or AWS // account. If applicationName is specified, then deploymentGroupName must be // specified. If it is not specified, then deploymentGroupName must not be // specified. ApplicationName *string - // An identifier returned from the previous list deployments call. It can be used - // to return the next set of deployments in the list. - NextToken *string + // A time range (start and end) for returning a subset of the list of deployments. + CreateTimeRange *types.TimeRange // The name of a deployment group for the specified application. If // deploymentGroupName is specified, then applicationName must be specified. If it // is not specified, then applicationName must not be specified. DeploymentGroupName *string + // The unique ID of an external resource for returning deployments linked to the + // external resource. + ExternalId *string + // A subset of deployments to list by status: // // * Created: Include created @@ -99,6 +95,10 @@ type ListDeploymentsInput struct { // // * Stopped: Include stopped deployments in the resulting list. IncludeOnlyStatuses []types.DeploymentStatus + + // An identifier returned from the previous list deployments call. It can be used + // to return the next set of deployments in the list. + NextToken *string } // Represents the output of a ListDeployments operation. diff --git a/service/codedeploy/api_op_ListOnPremisesInstances.go b/service/codedeploy/api_op_ListOnPremisesInstances.go index 353cbc04108..2fb63929bd3 100644 --- a/service/codedeploy/api_op_ListOnPremisesInstances.go +++ b/service/codedeploy/api_op_ListOnPremisesInstances.go @@ -60,10 +60,6 @@ func (c *Client) ListOnPremisesInstances(ctx context.Context, params *ListOnPrem // Represents the input of a ListOnPremisesInstances operation. type ListOnPremisesInstancesInput struct { - // The on-premises instance tags that are used to restrict the on-premises instance - // names returned. - TagFilters []*types.TagFilter - // An identifier returned from the previous list on-premises instances call. It can // be used to return the next set of on-premises instances in the list. NextToken *string @@ -76,19 +72,23 @@ type ListOnPremisesInstancesInput struct { // * // Registered: Include registered on-premises instances in the resulting list. RegistrationStatus types.RegistrationStatus + + // The on-premises instance tags that are used to restrict the on-premises instance + // names returned. + TagFilters []*types.TagFilter } // Represents the output of the list on-premises instances operation. type ListOnPremisesInstancesOutput struct { + // The list of matching on-premises instance names. + InstanceNames []*string + // If a large amount of information is returned, an identifier is also returned. It // can be used in a subsequent list on-premises instances call to return the next // set of on-premises instances in the list. NextToken *string - // The list of matching on-premises instance names. - InstanceNames []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codedeploy/api_op_ListTagsForResource.go b/service/codedeploy/api_op_ListTagsForResource.go index 96b3fb02cbe..f1d9b46d49f 100644 --- a/service/codedeploy/api_op_ListTagsForResource.go +++ b/service/codedeploy/api_op_ListTagsForResource.go @@ -59,28 +59,28 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // An identifier returned from the previous ListTagsForResource call. It can be - // used to return the next set of applications in the list. - NextToken *string - // The ARN of a CodeDeploy resource. ListTagsForResource returns all the tags // associated with the resource that is identified by the ResourceArn. // // This member is required. ResourceArn *string + + // An identifier returned from the previous ListTagsForResource call. It can be + // used to return the next set of applications in the list. + NextToken *string } type ListTagsForResourceOutput struct { - // A list of tags returned by ListTagsForResource. The tags are associated with the - // resource identified by the input ResourceArn parameter. - Tags []*types.Tag - // If a large amount of information is returned, an identifier is also returned. It // can be used in a subsequent list application revisions call to return the next // set of application revisions in the list. NextToken *string + // A list of tags returned by ListTagsForResource. The tags are associated with the + // resource identified by the input ResourceArn parameter. + Tags []*types.Tag + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codedeploy/api_op_PutLifecycleEventHookExecutionStatus.go b/service/codedeploy/api_op_PutLifecycleEventHookExecutionStatus.go index ef428cfc58a..6ad476c3bd9 100644 --- a/service/codedeploy/api_op_PutLifecycleEventHookExecutionStatus.go +++ b/service/codedeploy/api_op_PutLifecycleEventHookExecutionStatus.go @@ -70,13 +70,13 @@ type PutLifecycleEventHookExecutionStatusInput struct { // a deployment lifecycle event. DeploymentId *string - // The result of a Lambda function that validates a deployment lifecycle event - // (Succeeded or Failed). - Status types.LifecycleEventStatus - // The execution ID of a deployment's lifecycle hook. A deployment lifecycle hook // is specified in the hooks section of the AppSpec file. LifecycleEventHookExecutionId *string + + // The result of a Lambda function that validates a deployment lifecycle event + // (Succeeded or Failed). + Status types.LifecycleEventStatus } type PutLifecycleEventHookExecutionStatusOutput struct { diff --git a/service/codedeploy/api_op_RegisterApplicationRevision.go b/service/codedeploy/api_op_RegisterApplicationRevision.go index dfde0b06ce8..17a2fbc52de 100644 --- a/service/codedeploy/api_op_RegisterApplicationRevision.go +++ b/service/codedeploy/api_op_RegisterApplicationRevision.go @@ -58,18 +58,18 @@ func (c *Client) RegisterApplicationRevision(ctx context.Context, params *Regist // Represents the input of a RegisterApplicationRevision operation. type RegisterApplicationRevisionInput struct { - // Information about the application revision to register, including type and - // location. - // - // This member is required. - Revision *types.RevisionLocation - // The name of an AWS CodeDeploy application associated with the IAM user or AWS // account. // // This member is required. ApplicationName *string + // Information about the application revision to register, including type and + // location. + // + // This member is required. + Revision *types.RevisionLocation + // A comment about the revision. Description *string } diff --git a/service/codedeploy/api_op_RegisterOnPremisesInstance.go b/service/codedeploy/api_op_RegisterOnPremisesInstance.go index 833a81a2a6f..569702bfb1d 100644 --- a/service/codedeploy/api_op_RegisterOnPremisesInstance.go +++ b/service/codedeploy/api_op_RegisterOnPremisesInstance.go @@ -58,16 +58,16 @@ func (c *Client) RegisterOnPremisesInstance(ctx context.Context, params *Registe // Represents the input of the register on-premises instance operation. type RegisterOnPremisesInstanceInput struct { + // The name of the on-premises instance to register. + // + // This member is required. + InstanceName *string + // The ARN of the IAM session to associate with the on-premises instance. IamSessionArn *string // The ARN of the IAM user to associate with the on-premises instance. IamUserArn *string - - // The name of the on-premises instance to register. - // - // This member is required. - InstanceName *string } type RegisterOnPremisesInstanceOutput struct { diff --git a/service/codedeploy/api_op_RemoveTagsFromOnPremisesInstances.go b/service/codedeploy/api_op_RemoveTagsFromOnPremisesInstances.go index ee294241f1c..5adf5f7ea3d 100644 --- a/service/codedeploy/api_op_RemoveTagsFromOnPremisesInstances.go +++ b/service/codedeploy/api_op_RemoveTagsFromOnPremisesInstances.go @@ -58,15 +58,15 @@ func (c *Client) RemoveTagsFromOnPremisesInstances(ctx context.Context, params * // Represents the input of a RemoveTagsFromOnPremisesInstances operation. type RemoveTagsFromOnPremisesInstancesInput struct { - // The tag key-value pairs to remove from the on-premises instances. + // The names of the on-premises instances from which to remove tags. // // This member is required. - Tags []*types.Tag + InstanceNames []*string - // The names of the on-premises instances from which to remove tags. + // The tag key-value pairs to remove from the on-premises instances. // // This member is required. - InstanceNames []*string + Tags []*types.Tag } type RemoveTagsFromOnPremisesInstancesOutput struct { diff --git a/service/codedeploy/api_op_TagResource.go b/service/codedeploy/api_op_TagResource.go index db76c050ea9..14e46da7dee 100644 --- a/service/codedeploy/api_op_TagResource.go +++ b/service/codedeploy/api_op_TagResource.go @@ -58,16 +58,16 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // A list of tags that TagResource associates with a resource. The resource is - // identified by the ResourceArn input parameter. + // The ARN of a resource, such as a CodeDeploy application or deployment group. // // This member is required. - Tags []*types.Tag + ResourceArn *string - // The ARN of a resource, such as a CodeDeploy application or deployment group. + // A list of tags that TagResource associates with a resource. The resource is + // identified by the ResourceArn input parameter. // // This member is required. - ResourceArn *string + Tags []*types.Tag } type TagResourceOutput struct { diff --git a/service/codedeploy/api_op_UpdateDeploymentGroup.go b/service/codedeploy/api_op_UpdateDeploymentGroup.go index 7e183c2fd8c..6a5f6eea93f 100644 --- a/service/codedeploy/api_op_UpdateDeploymentGroup.go +++ b/service/codedeploy/api_op_UpdateDeploymentGroup.go @@ -58,77 +58,77 @@ func (c *Client) UpdateDeploymentGroup(ctx context.Context, params *UpdateDeploy // Represents the input of an UpdateDeploymentGroup operation. type UpdateDeploymentGroupInput struct { - // Information about the type of deployment, either in-place or blue/green, you - // want to run and whether to route deployment traffic behind a load balancer. - DeploymentStyle *types.DeploymentStyle - // The application name that corresponds to the deployment group to update. // // This member is required. ApplicationName *string - // Information about blue/green deployment options for a deployment group. - BlueGreenDeploymentConfiguration *types.BlueGreenDeploymentConfiguration - - // The replacement set of on-premises instance tags on which to filter, if you want - // to change them. To keep the existing tags, enter their names. To remove tags, do - // not enter any tag names. - OnPremisesInstanceTagFilters []*types.TagFilter + // The current name of the deployment group. + // + // This member is required. + CurrentDeploymentGroupName *string // Information to add or change about Amazon CloudWatch alarms when the deployment // group is updated. AlarmConfiguration *types.AlarmConfiguration - // Information about the load balancer used in a deployment. - LoadBalancerInfo *types.LoadBalancerInfo + // Information for an automatic rollback configuration that is added or changed + // when a deployment group is updated. + AutoRollbackConfiguration *types.AutoRollbackConfiguration // The replacement list of Auto Scaling groups to be included in the deployment // group, if you want to change them. To keep the Auto Scaling groups, enter their // names. To remove Auto Scaling groups, do not enter any Auto Scaling group names. AutoScalingGroups []*string - // A replacement ARN for the service role, if you want to change it. - ServiceRoleArn *string + // Information about blue/green deployment options for a deployment group. + BlueGreenDeploymentConfiguration *types.BlueGreenDeploymentConfiguration + + // The replacement deployment configuration name to use, if you want to change it. + DeploymentConfigName *string + + // Information about the type of deployment, either in-place or blue/green, you + // want to run and whether to route deployment traffic behind a load balancer. + DeploymentStyle *types.DeploymentStyle // The replacement set of Amazon EC2 tags on which to filter, if you want to change // them. To keep the existing tags, enter their names. To remove tags, do not enter // any tag names. Ec2TagFilters []*types.EC2TagFilter + // Information about groups of tags applied to on-premises instances. The + // deployment group includes only EC2 instances identified by all the tag groups. + Ec2TagSet *types.EC2TagSet + // The target Amazon ECS services in the deployment group. This applies only to // deployment groups that use the Amazon ECS compute platform. A target Amazon ECS // service is specified as an Amazon ECS cluster and service name pair using the // format :. EcsServices []*types.ECSService + // Information about the load balancer used in a deployment. + LoadBalancerInfo *types.LoadBalancerInfo + + // The new name of the deployment group, if you want to change it. + NewDeploymentGroupName *string + + // The replacement set of on-premises instance tags on which to filter, if you want + // to change them. To keep the existing tags, enter their names. To remove tags, do + // not enter any tag names. + OnPremisesInstanceTagFilters []*types.TagFilter + // Information about an on-premises instance tag set. The deployment group includes // only on-premises instances identified by all the tag groups. OnPremisesTagSet *types.OnPremisesTagSet - // The current name of the deployment group. - // - // This member is required. - CurrentDeploymentGroupName *string - - // Information for an automatic rollback configuration that is added or changed - // when a deployment group is updated. - AutoRollbackConfiguration *types.AutoRollbackConfiguration + // A replacement ARN for the service role, if you want to change it. + ServiceRoleArn *string // Information about triggers to change when the deployment group is updated. For // examples, see Edit a Trigger in a CodeDeploy Deployment Group // (https://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-notify-edit.html) // in the AWS CodeDeploy User Guide. TriggerConfigurations []*types.TriggerConfig - - // The replacement deployment configuration name to use, if you want to change it. - DeploymentConfigName *string - - // The new name of the deployment group, if you want to change it. - NewDeploymentGroupName *string - - // Information about groups of tags applied to on-premises instances. The - // deployment group includes only EC2 instances identified by all the tag groups. - Ec2TagSet *types.EC2TagSet } // Represents the output of an UpdateDeploymentGroup operation. diff --git a/service/codedeploy/go.mod b/service/codedeploy/go.mod index ade3ec21d67..63411124fed 100644 --- a/service/codedeploy/go.mod +++ b/service/codedeploy/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/codedeploy go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/codedeploy/types/types.go b/service/codedeploy/types/types.go index bb4d2d2279b..5cc234ac048 100644 --- a/service/codedeploy/types/types.go +++ b/service/codedeploy/types/types.go @@ -17,6 +17,13 @@ type Alarm struct { // Information about alarms associated with the deployment group. type AlarmConfiguration struct { + // A list of alarms configured for the deployment group. A maximum of 10 alarms can + // be added to a deployment group. + Alarms []*Alarm + + // Indicates whether the alarm configuration is enabled. + Enabled *bool + // Indicates whether a deployment should continue if information about the current // state of alarms cannot be retrieved from Amazon CloudWatch. The default value is // false. @@ -27,37 +34,30 @@ type AlarmConfiguration struct { // * false: The deployment stops if // alarm status information can't be retrieved from Amazon CloudWatch. IgnorePollAlarmFailure *bool - - // Indicates whether the alarm configuration is enabled. - Enabled *bool - - // A list of alarms configured for the deployment group. A maximum of 10 alarms can - // be added to a deployment group. - Alarms []*Alarm } // Information about an application. type ApplicationInfo struct { - // The time at which the application was created. - CreateTime *time.Time + // The application ID. + ApplicationId *string - // True if the user has authenticated with GitHub for the specified application. - // Otherwise, false. - LinkedToGitHub *bool + // The application name. + ApplicationName *string // The destination platform type for deployment of the application (Lambda or // Server). ComputePlatform ComputePlatform + // The time at which the application was created. + CreateTime *time.Time + // The name for a connection to a GitHub account. GitHubAccountName *string - // The application name. - ApplicationName *string - - // The application ID. - ApplicationId *string + // True if the user has authenticated with GitHub for the specified application. + // Otherwise, false. + LinkedToGitHub *bool } // A revision for an AWS Lambda or Amazon ECS deployment that is a YAML-formatted @@ -66,9 +66,6 @@ type ApplicationInfo struct { // RawString data type. type AppSpecContent struct { - // The SHA256 hash value of the revision content. - Sha256 *string - // The YAML-formatted or JSON-formatted revision string. For an AWS Lambda // deployment, the content includes a Lambda function name, the alias for its // original version, and the alias for its replacement version. The deployment @@ -79,6 +76,9 @@ type AppSpecContent struct { // functions that run at specified hooks, such as BeforeInstall, during a // deployment. Content *string + + // The SHA256 hash value of the revision content. + Sha256 *string } // Information about a configuration for automatically rolling back to a previous @@ -86,22 +86,22 @@ type AppSpecContent struct { // successfully. type AutoRollbackConfiguration struct { - // The event type or types that trigger a rollback. - Events []AutoRollbackEvent - // Indicates whether a defined automatic rollback configuration is currently // enabled. Enabled *bool + + // The event type or types that trigger a rollback. + Events []AutoRollbackEvent } // Information about an Auto Scaling group. type AutoScalingGroup struct { - // The Auto Scaling group name. - Name *string - // An Auto Scaling lifecycle event hook name. Hook *string + + // The Auto Scaling group name. + Name *string } // Information about blue/green deployment options for a deployment group. @@ -125,14 +125,6 @@ type BlueGreenDeploymentConfiguration struct { // not apply to Lambda deployments. type BlueInstanceTerminationOption struct { - // For an Amazon EC2 deployment, the number of minutes to wait after a successful - // blue/green deployment before terminating instances from the original - // environment.

    For an Amazon ECS deployment, the number of minutes before - // deleting the original (blue) task set. During an Amazon ECS deployment, - // CodeDeploy shifts traffic from the original (blue) task set to a replacement - // (green) task set.

    The maximum setting is 2880 minutes (2 days).

    - TerminationWaitTimeInMinutes *int32 - // The action to take on instances in the original environment after a successful // blue/green deployment. // @@ -142,6 +134,14 @@ type BlueInstanceTerminationOption struct { // * KEEP_ALIVE: Instances are left running after they // are deregistered from the load balancer and removed from the deployment group. Action InstanceAction + + // For an Amazon EC2 deployment, the number of minutes to wait after a successful + // blue/green deployment before terminating instances from the original + // environment.

    For an Amazon ECS deployment, the number of minutes before + // deleting the original (blue) task set. During an Amazon ECS deployment, + // CodeDeploy shifts traffic from the original (blue) task set to a replacement + // (green) task set.

    The maximum setting is 2880 minutes (2 days).

    + TerminationWaitTimeInMinutes *int32 } // Information about the target to be updated by an AWS CloudFormation blue/green @@ -149,12 +149,16 @@ type BlueInstanceTerminationOption struct { // CloudFormation stack update. type CloudFormationTarget struct { - // The percentage of production traffic that the target version of an AWS - // CloudFormation blue/green deployment receives. - TargetVersionWeight *float64 + // The unique ID of an AWS CloudFormation blue/green deployment. + DeploymentId *string - // The unique ID of a deployment target that has a type of CloudFormationTarget. - TargetId *string + // The date and time when the target application was updated by an AWS + // CloudFormation blue/green deployment. + LastUpdatedAt *time.Time + + // The lifecycle events of the AWS CloudFormation blue/green deployment to this + // target application. + LifecycleEvents []*LifecycleEvent // The resource type for the AWS CloudFormation blue/green deployment. ResourceType *string @@ -162,16 +166,12 @@ type CloudFormationTarget struct { // The status of an AWS CloudFormation blue/green deployment's target application. Status TargetStatus - // The lifecycle events of the AWS CloudFormation blue/green deployment to this - // target application. - LifecycleEvents []*LifecycleEvent - - // The date and time when the target application was updated by an AWS - // CloudFormation blue/green deployment. - LastUpdatedAt *time.Time + // The unique ID of a deployment target that has a type of CloudFormationTarget. + TargetId *string - // The unique ID of an AWS CloudFormation blue/green deployment. - DeploymentId *string + // The percentage of production traffic that the target version of an AWS + // CloudFormation blue/green deployment receives. + TargetVersionWeight *float64 } // Information about a deployment configuration. @@ -183,129 +183,185 @@ type DeploymentConfigInfo struct { // The time at which the deployment configuration was created. CreateTime *time.Time + // The deployment configuration ID. + DeploymentConfigId *string + + // The deployment configuration name. + DeploymentConfigName *string + // Information about the number or percentage of minimum healthy instance. MinimumHealthyHosts *MinimumHealthyHosts // The configuration that specifies how the deployment traffic is routed. Used for // deployments with a Lambda or ECS compute platform only. TrafficRoutingConfig *TrafficRoutingConfig - - // The deployment configuration name. - DeploymentConfigName *string - - // The deployment configuration ID. - DeploymentConfigId *string } // Information about a deployment group. type DeploymentGroupInfo struct { - // The on-premises instance tags on which to filter. The deployment group includes - // on-premises instances with any of the specified tags. - OnPremisesInstanceTagFilters []*TagFilter - - // Information about the type of deployment, either in-place or blue/green, you - // want to run and whether to route deployment traffic behind a load balancer. - DeploymentStyle *DeploymentStyle - - // Information about groups of tags applied to an EC2 instance. The deployment - // group includes only EC2 instances identified by all of the tag groups. Cannot be - // used in the same call as ec2TagFilters. - Ec2TagSet *EC2TagSet - - // Information about triggers associated with the deployment group. - TriggerConfigurations []*TriggerConfig + // A list of alarms associated with the deployment group. + AlarmConfiguration *AlarmConfiguration // The application name. ApplicationName *string - // A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to - // make calls to AWS services on your behalf. For more information, see Create a - // Service Role for AWS CodeDeploy - // (https://docs.aws.amazon.com/codedeploy/latest/userguide/getting-started-create-service-role.html) - // in the AWS CodeDeploy User Guide. - ServiceRoleArn *string - - // The target Amazon ECS services in the deployment group. This applies only to - // deployment groups that use the Amazon ECS compute platform. A target Amazon ECS - // service is specified as an Amazon ECS cluster and service name pair using the - // format :. - EcsServices []*ECSService - // Information about the automatic rollback configuration associated with the // deployment group. AutoRollbackConfiguration *AutoRollbackConfiguration + // A list of associated Auto Scaling groups. + AutoScalingGroups []*AutoScalingGroup + // Information about blue/green deployment options for a deployment group. BlueGreenDeploymentConfiguration *BlueGreenDeploymentConfiguration + // The destination platform type for the deployment (Lambda, Server, or ECS). + ComputePlatform ComputePlatform + // The deployment configuration name. DeploymentConfigName *string - // Information about the deployment group's target revision, including type and - // location. - TargetRevision *RevisionLocation + // The deployment group ID. + DeploymentGroupId *string - // A list of alarms associated with the deployment group. - AlarmConfiguration *AlarmConfiguration + // The deployment group name. + DeploymentGroupName *string - // Information about the load balancer to use in a deployment. - LoadBalancerInfo *LoadBalancerInfo + // Information about the type of deployment, either in-place or blue/green, you + // want to run and whether to route deployment traffic behind a load balancer. + DeploymentStyle *DeploymentStyle - // The deployment group ID. - DeploymentGroupId *string + // The Amazon EC2 tags on which to filter. The deployment group includes EC2 + // instances with any of the specified tags. + Ec2TagFilters []*EC2TagFilter - // The destination platform type for the deployment (Lambda, Server, or ECS). - ComputePlatform ComputePlatform + // Information about groups of tags applied to an EC2 instance. The deployment + // group includes only EC2 instances identified by all of the tag groups. Cannot be + // used in the same call as ec2TagFilters. + Ec2TagSet *EC2TagSet - // A list of associated Auto Scaling groups. - AutoScalingGroups []*AutoScalingGroup + // The target Amazon ECS services in the deployment group. This applies only to + // deployment groups that use the Amazon ECS compute platform. A target Amazon ECS + // service is specified as an Amazon ECS cluster and service name pair using the + // format :. + EcsServices []*ECSService + + // Information about the most recent attempted deployment to the deployment group. + LastAttemptedDeployment *LastDeploymentInfo // Information about the most recent successful deployment to the deployment group. LastSuccessfulDeployment *LastDeploymentInfo - // The deployment group name. - DeploymentGroupName *string + // Information about the load balancer to use in a deployment. + LoadBalancerInfo *LoadBalancerInfo + + // The on-premises instance tags on which to filter. The deployment group includes + // on-premises instances with any of the specified tags. + OnPremisesInstanceTagFilters []*TagFilter // Information about groups of tags applied to an on-premises instance. The // deployment group includes only on-premises instances identified by all the tag // groups. Cannot be used in the same call as onPremisesInstanceTagFilters. OnPremisesTagSet *OnPremisesTagSet - // The Amazon EC2 tags on which to filter. The deployment group includes EC2 - // instances with any of the specified tags. - Ec2TagFilters []*EC2TagFilter + // A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to + // make calls to AWS services on your behalf. For more information, see Create a + // Service Role for AWS CodeDeploy + // (https://docs.aws.amazon.com/codedeploy/latest/userguide/getting-started-create-service-role.html) + // in the AWS CodeDeploy User Guide. + ServiceRoleArn *string - // Information about the most recent attempted deployment to the deployment group. - LastAttemptedDeployment *LastDeploymentInfo + // Information about the deployment group's target revision, including type and + // location. + TargetRevision *RevisionLocation + + // Information about triggers associated with the deployment group. + TriggerConfigurations []*TriggerConfig } // Information about a deployment. type DeploymentInfo struct { - // Information about any error associated with this deployment. - ErrorInformation *ErrorInformation - - // Information about blue/green deployment options for this deployment. - BlueGreenDeploymentConfiguration *BlueGreenDeploymentConfiguration + // Provides information about the results of a deployment, such as whether + // instances in the original environment in a blue/green deployment were not + // terminated. + AdditionalDeploymentStatusInfo *string - // Messages that contain information about the status of a deployment. - DeploymentStatusMessages []*string + // The application name. + ApplicationName *string // Information about the automatic rollback configuration associated with the // deployment. AutoRollbackConfiguration *AutoRollbackConfiguration + // Information about blue/green deployment options for this deployment. + BlueGreenDeploymentConfiguration *BlueGreenDeploymentConfiguration + + // A timestamp that indicates when the deployment was complete. + CompleteTime *time.Time + + // The destination platform type for the deployment (Lambda, Server, or ECS). + ComputePlatform ComputePlatform + // A timestamp that indicates when the deployment was created. CreateTime *time.Time - // The application name. - ApplicationName *string + // The means by which the deployment was created: + // + // * user: A user created the + // deployment. + // + // * autoscaling: Amazon EC2 Auto Scaling created the + // deployment. + // + // * codeDeployRollback: A rollback process created the + // deployment. + Creator DeploymentCreator - // Provides information about the results of a deployment, such as whether - // instances in the original environment in a blue/green deployment were not - // terminated. - AdditionalDeploymentStatusInfo *string + // The deployment configuration name. + DeploymentConfigName *string + + // The deployment group name. + DeploymentGroupName *string + + // The unique ID of a deployment. + DeploymentId *string + + // A summary of the deployment status of the instances in the deployment. + DeploymentOverview *DeploymentOverview + + // Messages that contain information about the status of a deployment. + DeploymentStatusMessages []*string + + // Information about the type of deployment, either in-place or blue/green, you + // want to run and whether to route deployment traffic behind a load balancer. + DeploymentStyle *DeploymentStyle + + // A comment about the deployment. + Description *string + + // Information about any error associated with this deployment. + ErrorInformation *ErrorInformation + + // The unique ID for an external resource (for example, a CloudFormation stack ID) + // that is linked to this deployment. + ExternalId *string + + // Information about how AWS CodeDeploy handles files that already exist in a + // deployment target location but weren't part of the previous successful + // deployment. + // + // * DISALLOW: The deployment fails. This is also the default + // behavior if no option is specified. + // + // * OVERWRITE: The version of the file + // from the application revision currently being deployed replaces the version + // already on the instance. + // + // * RETAIN: The version of the file already on the + // instance is kept and used as part of the new deployment. + FileExistsBehavior FileExistsBehavior // If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic // deployment lifecycle event to an instance fails, then the deployment continues @@ -329,105 +385,51 @@ type DeploymentInfo struct { // and AfterBlockTraffic failures should be ignored.

    IgnoreApplicationStopFailures *bool - // The deployment group name. - DeploymentGroupName *string - - // Information about how AWS CodeDeploy handles files that already exist in a - // deployment target location but weren't part of the previous successful - // deployment. - // - // * DISALLOW: The deployment fails. This is also the default - // behavior if no option is specified. - // - // * OVERWRITE: The version of the file - // from the application revision currently being deployed replaces the version - // already on the instance. - // - // * RETAIN: The version of the file already on the - // instance is kept and used as part of the new deployment. - FileExistsBehavior FileExistsBehavior - - // The unique ID of a deployment. - DeploymentId *string - // Indicates whether the wait period set for the termination of instances in the // original environment has started. Status is 'false' if the KEEP_ALIVE option is // specified. Otherwise, 'true' as soon as the termination wait period starts. InstanceTerminationWaitTimeStarted *bool + // Information about the load balancer used in the deployment. + LoadBalancerInfo *LoadBalancerInfo + + // Information about the application revision that was deployed to the deployment + // group before the most recent successful deployment. + PreviousRevision *RevisionLocation + // Information about the location of stored application artifacts and the service // from which to retrieve them. Revision *RevisionLocation - // Indicates whether only instances that are not running the latest application - // revision are to be deployed to. - UpdateOutdatedInstancesOnly *bool - // Information about a deployment rollback. RollbackInfo *RollbackInfo - // Information about the type of deployment, either in-place or blue/green, you - // want to run and whether to route deployment traffic behind a load balancer. - DeploymentStyle *DeploymentStyle - // A timestamp that indicates when the deployment was deployed to the deployment // group. In some cases, the reported value of the start time might be later than // the complete time. This is due to differences in the clock settings of backend // servers that participate in the deployment process. StartTime *time.Time - // Information about the instances that belong to the replacement environment in a - // blue/green deployment. - TargetInstances *TargetInstances - // The current state of the deployment as a whole. Status DeploymentStatus - // Information about the application revision that was deployed to the deployment - // group before the most recent successful deployment. - PreviousRevision *RevisionLocation - - // A summary of the deployment status of the instances in the deployment. - DeploymentOverview *DeploymentOverview - - // The destination platform type for the deployment (Lambda, Server, or ECS). - ComputePlatform ComputePlatform - - // The means by which the deployment was created: - // - // * user: A user created the - // deployment. - // - // * autoscaling: Amazon EC2 Auto Scaling created the - // deployment. - // - // * codeDeployRollback: A rollback process created the - // deployment. - Creator DeploymentCreator - - // The deployment configuration name. - DeploymentConfigName *string - - // Information about the load balancer used in the deployment. - LoadBalancerInfo *LoadBalancerInfo - - // The unique ID for an external resource (for example, a CloudFormation stack ID) - // that is linked to this deployment. - ExternalId *string - - // A timestamp that indicates when the deployment was complete. - CompleteTime *time.Time + // Information about the instances that belong to the replacement environment in a + // blue/green deployment. + TargetInstances *TargetInstances - // A comment about the deployment. - Description *string + // Indicates whether only instances that are not running the latest application + // revision are to be deployed to. + UpdateOutdatedInstancesOnly *bool } // Information about the deployment status of the instances in the deployment. type DeploymentOverview struct { - // The number of instances in the deployment to which revisions have been - // successfully deployed. - Succeeded *int64 + // The number of instances in the deployment in a failed state. + Failed *int64 + + // The number of instances in which the deployment is in progress. + InProgress *int64 // The number of instances in the deployment in a pending state. Pending *int64 @@ -439,11 +441,9 @@ type DeploymentOverview struct { // The number of instances in the deployment in a skipped state. Skipped *int64 - // The number of instances in the deployment in a failed state. - Failed *int64 - - // The number of instances in which the deployment is in progress. - InProgress *int64 + // The number of instances in the deployment to which revisions have been + // successfully deployed. + Succeeded *int64 } // Information about how traffic is rerouted to instances in a replacement @@ -474,48 +474,41 @@ type DeploymentReadyOption struct { // want to run and whether to route deployment traffic behind a load balancer. type DeploymentStyle struct { - // Indicates whether to run an in-place deployment or a blue/green deployment. - DeploymentType DeploymentType - // Indicates whether to route deployment traffic behind a load balancer. DeploymentOption DeploymentOption + + // Indicates whether to run an in-place deployment or a blue/green deployment. + DeploymentType DeploymentType } // Information about the deployment target. type DeploymentTarget struct { - // Information about the target for a deployment that uses the EC2/On-premises - // compute platform. - InstanceTarget *InstanceTarget - - // The deployment type that is specific to the deployment's compute platform or - // deployments initiated by a CloudFormation stack update. - DeploymentTargetType DeploymentTargetType - // Information about the target to be updated by an AWS CloudFormation blue/green // deployment. This target type is used for all deployments initiated by a // CloudFormation stack update. CloudFormationTarget *CloudFormationTarget - // Information about the target for a deployment that uses the AWS Lambda compute - // platform. - LambdaTarget *LambdaTarget + // The deployment type that is specific to the deployment's compute platform or + // deployments initiated by a CloudFormation stack update. + DeploymentTargetType DeploymentTargetType // Information about the target for a deployment that uses the Amazon ECS compute // platform. EcsTarget *ECSTarget + + // Information about the target for a deployment that uses the EC2/On-premises + // compute platform. + InstanceTarget *InstanceTarget + + // Information about the target for a deployment that uses the AWS Lambda compute + // platform. + LambdaTarget *LambdaTarget } // Diagnostic information about executable scripts that are part of a deployment. type Diagnostics struct { - // The last portion of the diagnostic log. If available, AWS CodeDeploy returns up - // to the last 4 KB of the diagnostic log. - LogTail *string - - // The name of the script. - ScriptName *string - // The associated error code: // // * Success: The specified script ran. @@ -537,13 +530,23 @@ type Diagnostics struct { // unknown reason. ErrorCode LifecycleErrorCode + // The last portion of the diagnostic log. If available, AWS CodeDeploy returns up + // to the last 4 KB of the diagnostic log. + LogTail *string + // The message associated with the error. Message *string + + // The name of the script. + ScriptName *string } // Information about an EC2 tag filter. type EC2TagFilter struct { + // The tag filter key. + Key *string + // The tag filter type: // // * KEY_ONLY: Key only. @@ -554,9 +557,6 @@ type EC2TagFilter struct { // * KEY_AND_VALUE: Key and value. Type EC2TagFilterType - // The tag filter key. - Key *string - // The tag filter value. Value *string } @@ -574,37 +574,37 @@ type EC2TagSet struct { // deployment's target. type ECSService struct { - // The name of the target Amazon ECS service. - ServiceName *string - // The name of the cluster that the Amazon ECS service is associated with. ClusterName *string + + // The name of the target Amazon ECS service. + ServiceName *string } // Information about the target of an Amazon ECS deployment. type ECSTarget struct { - // The status an Amazon ECS deployment's target ECS application. - Status TargetStatus - - // The ECSTaskSet objects associated with the ECS target. - TaskSetsInfo []*ECSTaskSet - - // The unique ID of a deployment target that has a type of ecsTarget. - TargetId *string - - // The Amazon Resource Name (ARN) of the target. - TargetArn *string + // The unique ID of a deployment. + DeploymentId *string // The date and time when the target Amazon ECS application was updated by a // deployment. LastUpdatedAt *time.Time - // The unique ID of a deployment. - DeploymentId *string - // The lifecycle events of the deployment to this target Amazon ECS application. LifecycleEvents []*LifecycleEvent + + // The status an Amazon ECS deployment's target ECS application. + Status TargetStatus + + // The Amazon Resource Name (ARN) of the target. + TargetArn *string + + // The unique ID of a deployment target that has a type of ecsTarget. + TargetId *string + + // The ECSTaskSet objects associated with the ECS target. + TaskSetsInfo []*ECSTaskSet } // Information about a set of Amazon ECS tasks in an AWS CodeDeploy deployment. An @@ -614,9 +614,21 @@ type ECSTarget struct { // containerized application in an Amazon ECS service as a task set. type ECSTaskSet struct { + // The number of tasks in a task set. During a deployment that uses the Amazon ECS + // compute type, CodeDeploy instructs Amazon ECS to create a new task set and uses + // this value to determine how many tasks to create. After the updated task set is + // created, CodeDeploy shifts traffic to the new task set. + DesiredCount *int64 + // A unique ID of an ECSTaskSet. Identifer *string + // The number of tasks in the task set that are in the PENDING status during an + // Amazon ECS deployment. A task in the PENDING state is preparing to enter the + // RUNNING state. A task set enters the PENDING status when it launches for the + // first time, or when it is restarted after being in the STOPPED state. + PendingCount *int64 + // The number of tasks in the task set that are in the RUNNING status during an // Amazon ECS deployment. A task in the RUNNING state is running and ready for use. RunningCount *int64 @@ -628,20 +640,11 @@ type ECSTaskSet struct { // // * ACTIVE: // Indicates the task set is not serving production traffic. - // - // * DRAINING: - // Indicates the tasks in the task set are being stopped and their corresponding - // targets are being deregistered from their target group. - Status *string - - // The number of tasks in a task set. During a deployment that uses the Amazon ECS - // compute type, CodeDeploy instructs Amazon ECS to create a new task set and uses - // this value to determine how many tasks to create. After the updated task set is - // created, CodeDeploy shifts traffic to the new task set. - DesiredCount *int64 - - // The percentage of traffic served by this task set. - TrafficWeight *float64 + // + // * DRAINING: + // Indicates the tasks in the task set are being stopped and their corresponding + // targets are being deregistered from their target group. + Status *string // The target group associated with the task set. The target group is used by AWS // CodeDeploy to manage traffic to a task set. @@ -651,11 +654,8 @@ type ECSTaskSet struct { // a replacement target (GREEN). TaskSetLabel TargetLabel - // The number of tasks in the task set that are in the PENDING status during an - // Amazon ECS deployment. A task in the PENDING state is preparing to enter the - // RUNNING state. A task set enters the PENDING status when it launches for the - // first time, or when it is restarted after being in the STOPPED state. - PendingCount *int64 + // The percentage of traffic served by this task set. + TrafficWeight *float64 } // Information about a load balancer in Elastic Load Balancing to use in a @@ -674,9 +674,6 @@ type ELBInfo struct { // Information about a deployment error. type ErrorInformation struct { - // An accompanying error message. - Message *string - // For more information, see Error Codes for AWS CodeDeploy // (https://docs.aws.amazon.com/codedeploy/latest/userguide/error-codes.html) in // the AWS CodeDeploy User Guide @@ -727,38 +724,41 @@ type ErrorInformation struct { // was missing. This error code is most likely raised if the revision is deleted // after the deployment is created, but before it is started. Code ErrorCode + + // An accompanying error message. + Message *string } // Information about an application revision. type GenericRevisionInfo struct { - // When the revision was last used by AWS CodeDeploy. - LastUsedTime *time.Time + // The deployment groups for which this is the current target revision. + DeploymentGroups []*string // A comment about the revision. Description *string - // The deployment groups for which this is the current target revision. - DeploymentGroups []*string + // When the revision was first used by AWS CodeDeploy. + FirstUsedTime *time.Time + + // When the revision was last used by AWS CodeDeploy. + LastUsedTime *time.Time // When the revision was registered with AWS CodeDeploy. RegisterTime *time.Time - - // When the revision was first used by AWS CodeDeploy. - FirstUsedTime *time.Time } // Information about the location of application artifacts stored in GitHub. type GitHubLocation struct { + // The SHA1 commit ID of the GitHub commit that represents the bundled artifacts + // for the application revision. + CommitId *string + // The GitHub account and repository pair that stores a reference to the commit // that represents the bundled artifacts for the application revision. Specified as // account/repository. Repository *string - - // The SHA1 commit ID of the GitHub commit that represents the bundled artifacts - // for the application revision. - CommitId *string } // Information about the instances that belong to the replacement environment in a @@ -779,27 +779,27 @@ type GreenFleetProvisioningOption struct { // Information about an on-premises instance. type InstanceInfo struct { + // If the on-premises instance was deregistered, the time at which the on-premises + // instance was deregistered. + DeregisterTime *time.Time + // The ARN of the IAM session associated with the on-premises instance. IamSessionArn *string - // The ARN of the on-premises instance. - InstanceArn *string - - // The tags currently associated with the on-premises instance. - Tags []*Tag - // The IAM user ARN associated with the on-premises instance. IamUserArn *string - // If the on-premises instance was deregistered, the time at which the on-premises - // instance was deregistered. - DeregisterTime *time.Time + // The ARN of the on-premises instance. + InstanceArn *string + + // The name of the on-premises instance. + InstanceName *string // The time at which the on-premises instance was registered. RegisterTime *time.Time - // The name of the on-premises instance. - InstanceName *string + // The tags currently associated with the on-premises instance. + Tags []*Tag } // Information about an instance in a deployment. @@ -811,9 +811,6 @@ type InstanceSummary struct { // The instance ID. InstanceId *string - // A timestamp that indicates when the instance information was last updated. - LastUpdatedAt *time.Time - // Information about which environment an instance belongs to in a blue/green // deployment. // @@ -823,6 +820,9 @@ type InstanceSummary struct { // * GREEN: The instance is part of the replacement environment. InstanceType InstanceType + // A timestamp that indicates when the instance information was last updated. + LastUpdatedAt *time.Time + // A list of lifecycle events for this instance. LifecycleEvents []*LifecycleEvent @@ -851,27 +851,27 @@ type InstanceSummary struct { // EC2/On-premises compute platform. type InstanceTarget struct { + // The unique ID of a deployment. + DeploymentId *string + // A label that identifies whether the instance is an original target (BLUE) or a // replacement target (GREEN). InstanceLabel TargetLabel - // The lifecycle events of the deployment to this target instance. - LifecycleEvents []*LifecycleEvent - // The date and time when the target instance was updated by a deployment. LastUpdatedAt *time.Time - // The unique ID of a deployment. - DeploymentId *string + // The lifecycle events of the deployment to this target instance. + LifecycleEvents []*LifecycleEvent - // The unique ID of a deployment target that has a type of instanceTarget. - TargetId *string + // The status an EC2/On-premises deployment's target instance. + Status TargetStatus // The Amazon Resource Name (ARN) of the target. TargetArn *string - // The status an EC2/On-premises deployment's target instance. - Status TargetStatus + // The unique ID of a deployment target that has a type of instanceTarget. + TargetId *string } // Information about a Lambda function specified in a deployment. @@ -880,18 +880,18 @@ type LambdaFunctionInfo struct { // The version of a Lambda function that production traffic points to. CurrentVersion *string - // The version of a Lambda function that production traffic points to after the - // Lambda function is deployed. - TargetVersion *string - - // The name of a Lambda function. - FunctionName *string - // The alias of a Lambda function. For more information, see AWS Lambda Function // Aliases (https://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html) in the // AWS Lambda Developer Guide. FunctionAlias *string + // The name of a Lambda function. + FunctionName *string + + // The version of a Lambda function that production traffic points to after the + // Lambda function is deployed. + TargetVersion *string + // The percentage of production traffic that the target version of a Lambda // function receives. TargetVersionWeight *float64 @@ -901,23 +901,23 @@ type LambdaFunctionInfo struct { // deployment. type LambdaTarget struct { - // The status an AWS Lambda deployment's target Lambda function. - Status TargetStatus + // The unique ID of a deployment. + DeploymentId *string // A LambdaFunctionInfo object that describes a target Lambda function. LambdaFunctionInfo *LambdaFunctionInfo - // The Amazon Resource Name (ARN) of the target. - TargetArn *string - - // The unique ID of a deployment. - DeploymentId *string + // The date and time when the target Lambda function was updated by a deployment. + LastUpdatedAt *time.Time // The lifecycle events of the deployment to this target Lambda function. LifecycleEvents []*LifecycleEvent - // The date and time when the target Lambda function was updated by a deployment. - LastUpdatedAt *time.Time + // The status an AWS Lambda deployment's target Lambda function. + Status TargetStatus + + // The Amazon Resource Name (ARN) of the target. + TargetArn *string // The unique ID of a deployment target that has a type of lambdaTarget. TargetId *string @@ -934,17 +934,27 @@ type LastDeploymentInfo struct { // The unique ID of a deployment. DeploymentId *string - // The status of the most recent deployment. - Status DeploymentStatus - // A timestamp that indicates when the most recent deployment to the deployment // group was complete. EndTime *time.Time + + // The status of the most recent deployment. + Status DeploymentStatus } // Information about a deployment lifecycle event. type LifecycleEvent struct { + // Diagnostic information about the deployment lifecycle event. + Diagnostics *Diagnostics + + // A timestamp that indicates when the deployment lifecycle event ended. + EndTime *time.Time + + // The deployment lifecycle event name, such as ApplicationStop, BeforeInstall, + // AfterInstall, ApplicationStart, or ValidateService. + LifecycleEventName *string + // A timestamp that indicates when the deployment lifecycle event started. StartTime *time.Time @@ -967,25 +977,17 @@ type LifecycleEvent struct { // * Unknown: The deployment // lifecycle event is unknown. Status LifecycleEventStatus - - // The deployment lifecycle event name, such as ApplicationStop, BeforeInstall, - // AfterInstall, ApplicationStart, or ValidateService. - LifecycleEventName *string - - // A timestamp that indicates when the deployment lifecycle event ended. - EndTime *time.Time - - // Diagnostic information about the deployment lifecycle event. - Diagnostics *Diagnostics } // Information about the Elastic Load Balancing load balancer or target group used // in a deployment. type LoadBalancerInfo struct { - // The target group pair information. This is an array of TargeGroupPairInfo - // objects with a maximum size of one. - TargetGroupPairInfoList []*TargetGroupPairInfo + // An array that contains information about the load balancer to use for load + // balancing in a deployment. In Elastic Load Balancing, load balancers are used + // with Classic Load Balancers. Adding more than one load balancer to the array is + // not supported. + ElbInfoList []*ELBInfo // An array that contains information about the target group to use for load // balancing in a deployment. In Elastic Load Balancing, target groups are used @@ -993,19 +995,14 @@ type LoadBalancerInfo struct { // is not supported. TargetGroupInfoList []*TargetGroupInfo - // An array that contains information about the load balancer to use for load - // balancing in a deployment. In Elastic Load Balancing, load balancers are used - // with Classic Load Balancers. Adding more than one load balancer to the array is - // not supported. - ElbInfoList []*ELBInfo + // The target group pair information. This is an array of TargeGroupPairInfo + // objects with a maximum size of one. + TargetGroupPairInfoList []*TargetGroupPairInfo } // Information about minimum healthy instance. type MinimumHealthyHosts struct { - // The minimum healthy instance value. - Value *int32 - // The minimum healthy instance type: // // * HOST_COUNT: The minimum number of @@ -1033,6 +1030,9 @@ type MinimumHealthyHosts struct { // (https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-health.html) // in the AWS CodeDeploy User Guide. Type MinimumHealthyHostsType + + // The minimum healthy instance value. + Value *int32 } // Information about groups of on-premises instance tags. @@ -1049,29 +1049,33 @@ type OnPremisesTagSet struct { // the AppSpec file. type RawString struct { - // The SHA256 hash value of the revision content. - Sha256 *string - // The YAML-formatted or JSON-formatted revision string. It includes information // about which Lambda function to update and optional Lambda functions that // validate deployment lifecycle events. Content *string + + // The SHA256 hash value of the revision content. + Sha256 *string } // Information about an application revision. type RevisionInfo struct { - // Information about the location and type of an application revision. - RevisionLocation *RevisionLocation - // Information about an application revision, including usage details and // associated deployment groups. GenericRevisionInfo *GenericRevisionInfo + + // Information about the location and type of an application revision. + RevisionLocation *RevisionLocation } // Information about the location of an application revision. type RevisionLocation struct { + // The content of an AppSpec file for an AWS Lambda or Amazon ECS deployment. The + // content is formatted as JSON or YAML and stored as a RawString. + AppSpecContent *AppSpecContent + // Information about the location of application artifacts stored in GitHub. GitHubLocation *GitHubLocation @@ -1092,25 +1096,17 @@ type RevisionLocation struct { // as a RawString. RevisionType RevisionLocationType - // The content of an AppSpec file for an AWS Lambda or Amazon ECS deployment. The - // content is formatted as JSON or YAML and stored as a RawString. - AppSpecContent *AppSpecContent + // Information about the location of a revision stored in Amazon S3. + S3Location *S3Location // Information about the location of an AWS Lambda deployment revision stored as a // RawString. String_ *RawString - - // Information about the location of a revision stored in Amazon S3. - S3Location *S3Location } // Information about a deployment rollback. type RollbackInfo struct { - // The deployment ID of the deployment that was underway and triggered a rollback - // deployment because it failed or was stopped. - RollbackTriggeringDeploymentId *string - // The ID of the deployment rollback. RollbackDeploymentId *string @@ -1118,6 +1114,10 @@ type RollbackInfo struct { // whether the deployment can't be rolled back, is in progress, failed, or // succeeded). RollbackMessage *string + + // The deployment ID of the deployment that was underway and triggered a rollback + // deployment because it failed or was stopped. + RollbackTriggeringDeploymentId *string } // Information about the location of application artifacts stored in Amazon S3. @@ -1165,6 +1165,9 @@ type Tag struct { // Information about an on-premises instance tag filter. type TagFilter struct { + // The on-premises instance tag filter key. + Key *string + // The on-premises instance tag filter type: // // * KEY_ONLY: Key only. @@ -1175,9 +1178,6 @@ type TagFilter struct { // * KEY_AND_VALUE: Key and value. Type TagFilterType - // The on-premises instance tag filter key. - Key *string - // The on-premises instance tag filter value. Value *string } @@ -1200,11 +1200,6 @@ type TargetGroupInfo struct { // ECS deployment. An optional test traffic route can be specified. type TargetGroupPairInfo struct { - // An optional path used by a load balancer to route test traffic after an Amazon - // ECS deployment. Validation can occur while test traffic is served during a - // deployment. - TestTrafficRoute *TrafficRoute - // The path used by a load balancer to route production traffic when an Amazon ECS // deployment is complete. ProdTrafficRoute *TrafficRoute @@ -1213,6 +1208,11 @@ type TargetGroupPairInfo struct { // second is associated with the task set that serves traffic after the deployment // is complete. TargetGroups []*TargetGroupInfo + + // An optional path used by a load balancer to route test traffic after an Amazon + // ECS deployment. Validation can occur while test traffic is served during a + // deployment. + TestTrafficRoute *TrafficRoute } // Information about the instances to be used in the replacement environment in a @@ -1239,13 +1239,13 @@ type TargetInstances struct { // versions or ECS task sets are specified in the deployment's AppSpec file. type TimeBasedCanary struct { - // The percentage of traffic to shift in the first increment of a TimeBasedCanary - // deployment. - CanaryPercentage *int32 - // The number of minutes between the first and second traffic shifts of a // TimeBasedCanary deployment. CanaryInterval *int32 + + // The percentage of traffic to shift in the first increment of a TimeBasedCanary + // deployment. + CanaryPercentage *int32 } // A configuration that shifts traffic from one version of a Lambda function or ECS @@ -1254,24 +1254,24 @@ type TimeBasedCanary struct { // sets are specified in the deployment's AppSpec file. type TimeBasedLinear struct { - // The percentage of traffic that is shifted at the start of each increment of a - // TimeBasedLinear deployment. - LinearPercentage *int32 - // The number of minutes between each incremental traffic shift of a // TimeBasedLinear deployment. LinearInterval *int32 + + // The percentage of traffic that is shifted at the start of each increment of a + // TimeBasedLinear deployment. + LinearPercentage *int32 } // Information about a time range. type TimeRange struct { + // The end time of the time range. Specify null to leave the end time open-ended. + End *time.Time + // The start time of the time range. Specify null to leave the start time // open-ended. Start *time.Time - - // The end time of the time range. Specify null to leave the end time open-ended. - End *time.Time } // Information about a listener. The listener contains the path used to route @@ -1289,9 +1289,10 @@ type TrafficRoute struct { // Amazon ECS task set to another during an Amazon ECS deployment. type TrafficRoutingConfig struct { - // The type of traffic shifting (TimeBasedCanary or TimeBasedLinear) used by a - // deployment configuration. - Type TrafficRoutingType + // A configuration that shifts traffic from one version of a Lambda function or ECS + // task set to another in two increments. The original and target Lambda function + // versions or ECS task sets are specified in the deployment's AppSpec file. + TimeBasedCanary *TimeBasedCanary // A configuration that shifts traffic from one version of a Lambda function or ECS // task set to another in equal increments, with an equal number of minutes between @@ -1299,22 +1300,21 @@ type TrafficRoutingConfig struct { // sets are specified in the deployment's AppSpec file. TimeBasedLinear *TimeBasedLinear - // A configuration that shifts traffic from one version of a Lambda function or ECS - // task set to another in two increments. The original and target Lambda function - // versions or ECS task sets are specified in the deployment's AppSpec file. - TimeBasedCanary *TimeBasedCanary + // The type of traffic shifting (TimeBasedCanary or TimeBasedLinear) used by a + // deployment configuration. + Type TrafficRoutingType } // Information about notification triggers for the deployment group. type TriggerConfig struct { + // The event type or types for which notifications are triggered. + TriggerEvents []TriggerEventType + // The name of the notification trigger. TriggerName *string // The Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic // through which notifications about deployment or instance events are sent. TriggerTargetArn *string - - // The event type or types for which notifications are triggered. - TriggerEvents []TriggerEventType } diff --git a/service/codeguruprofiler/api_op_ConfigureAgent.go b/service/codeguruprofiler/api_op_ConfigureAgent.go index a83085376a0..a939db05745 100644 --- a/service/codeguruprofiler/api_op_ConfigureAgent.go +++ b/service/codeguruprofiler/api_op_ConfigureAgent.go @@ -57,15 +57,15 @@ func (c *Client) ConfigureAgent(ctx context.Context, params *ConfigureAgentInput // The structure representing the configureAgentRequest. type ConfigureAgentInput struct { - // - FleetInstanceId *string - - Metadata map[string]*string - // // // This member is required. ProfilingGroupName *string + + // + FleetInstanceId *string + + Metadata map[string]*string } // The structure representing the configureAgentResponse. diff --git a/service/codeguruprofiler/api_op_CreateProfilingGroup.go b/service/codeguruprofiler/api_op_CreateProfilingGroup.go index f172adb1ce9..417f97cd5e9 100644 --- a/service/codeguruprofiler/api_op_CreateProfilingGroup.go +++ b/service/codeguruprofiler/api_op_CreateProfilingGroup.go @@ -57,9 +57,6 @@ func (c *Client) CreateProfilingGroup(ctx context.Context, params *CreateProfili // The structure representing the createProfiliingGroupRequest. type CreateProfilingGroupInput struct { - // The agent orchestration configuration. - AgentOrchestrationConfig *types.AgentOrchestrationConfig - // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. This parameter specifies a unique identifier for the new profiling // group that helps ensure idempotency. @@ -67,12 +64,15 @@ type CreateProfilingGroupInput struct { // This member is required. ClientToken *string - ComputePlatform types.ComputePlatform - // The name of the profiling group. // // This member is required. ProfilingGroupName *string + + // The agent orchestration configuration. + AgentOrchestrationConfig *types.AgentOrchestrationConfig + + ComputePlatform types.ComputePlatform } // The structure representing the createProfilingGroupResponse. diff --git a/service/codeguruprofiler/api_op_GetProfile.go b/service/codeguruprofiler/api_op_GetProfile.go index 90c09a763e1..5f2fa7be760 100644 --- a/service/codeguruprofiler/api_op_GetProfile.go +++ b/service/codeguruprofiler/api_op_GetProfile.go @@ -65,6 +65,11 @@ func (c *Client) GetProfile(ctx context.Context, params *GetProfileInput, optFns // The structure representing the getProfileRequest. type GetProfileInput struct { + // The name of the profiling group to get. + // + // This member is required. + ProfilingGroupName *string + // The format of the profile to return. You can choose application/json or the // default application/x-amzn-ion. Accept *string @@ -81,11 +86,6 @@ type GetProfileInput struct { // startTime, period, and endTime. Period *string - // The name of the profiling group to get. - // - // This member is required. - ProfilingGroupName *string - // The start time of the profile to get. You must specify exactly two of the // following parameters: startTime, period, and endTime. StartTime *time.Time @@ -94,9 +94,6 @@ type GetProfileInput struct { // The structure representing the getProfileResponse. type GetProfileOutput struct { - // The content encoding of the profile. - ContentEncoding *string - // The content type of the profile in the payload. It is either application/json or // the default application/x-amzn-ion. // @@ -108,6 +105,9 @@ type GetProfileOutput struct { // This member is required. Profile []byte + // The content encoding of the profile. + ContentEncoding *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codeguruprofiler/api_op_ListProfileTimes.go b/service/codeguruprofiler/api_op_ListProfileTimes.go index 32e18de8afe..f89388d0853 100644 --- a/service/codeguruprofiler/api_op_ListProfileTimes.go +++ b/service/codeguruprofiler/api_op_ListProfileTimes.go @@ -64,6 +64,21 @@ type ListProfileTimesInput struct { // This member is required. EndTime *time.Time + // The aggregation period. + // + // This member is required. + Period types.AggregationPeriod + + // The name of the profiling group. + // + // This member is required. + ProfilingGroupName *string + + // The start time of the time range from which to list the profiles. + // + // This member is required. + StartTime *time.Time + // The maximum number of profile time results returned by ListProfileTimes in // paginated output. When this parameter is used, ListProfileTimes only returns // maxResults results in a single page with a nextToken response element. The @@ -82,38 +97,23 @@ type ListProfileTimesInput struct { // The order (ascending or descending by start time of the profile) to use when // listing profiles. Defaults to TIMESTAMP_DESCENDING. OrderBy types.OrderBy - - // The aggregation period. - // - // This member is required. - Period types.AggregationPeriod - - // The name of the profiling group. - // - // This member is required. - ProfilingGroupName *string - - // The start time of the time range from which to list the profiles. - // - // This member is required. - StartTime *time.Time } // The structure representing the listProfileTimesResponse. type ListProfileTimesOutput struct { - // The nextToken value to include in a future ListProfileTimes request. When the - // results of a ListProfileTimes request exceed maxResults, this value can be used - // to retrieve the next page of results. This value is null when there are no more - // results to return. - NextToken *string - // The list of start times of the available profiles for the aggregation period in // the specified time range. // // This member is required. ProfileTimes []*types.ProfileTime + // The nextToken value to include in a future ListProfileTimes request. When the + // results of a ListProfileTimes request exceed maxResults, this value can be used + // to retrieve the next page of results. This value is null when there are no more + // results to return. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codeguruprofiler/api_op_ListProfilingGroups.go b/service/codeguruprofiler/api_op_ListProfilingGroups.go index e429ea20b95..262d7ca4e01 100644 --- a/service/codeguruprofiler/api_op_ListProfilingGroups.go +++ b/service/codeguruprofiler/api_op_ListProfilingGroups.go @@ -78,17 +78,17 @@ type ListProfilingGroupsInput struct { // The structure representing the listProfilingGroupsResponse. type ListProfilingGroupsOutput struct { + // Information about profiling group names. + // + // This member is required. + ProfilingGroupNames []*string + // The nextToken value to include in a future ListProfilingGroups request. When the // results of a ListProfilingGroups request exceed maxResults, this value can be // used to retrieve the next page of results. This value is null when there are no // more results to return. NextToken *string - // Information about profiling group names. - // - // This member is required. - ProfilingGroupNames []*string - // Information about profiling groups. ProfilingGroups []*types.ProfilingGroupDescription diff --git a/service/codeguruprofiler/api_op_PostAgentProfile.go b/service/codeguruprofiler/api_op_PostAgentProfile.go index 9a2b0c63acd..1ec9b5f9b3f 100644 --- a/service/codeguruprofiler/api_op_PostAgentProfile.go +++ b/service/codeguruprofiler/api_op_PostAgentProfile.go @@ -66,13 +66,13 @@ type PostAgentProfileInput struct { // This member is required. ContentType *string - // - ProfileToken *string - // // // This member is required. ProfilingGroupName *string + + // + ProfileToken *string } // The structure representing the postAgentProfileResponse. diff --git a/service/codeguruprofiler/api_op_RetrieveTimeSeries.go b/service/codeguruprofiler/api_op_RetrieveTimeSeries.go index 8fbc475787a..e41134eb891 100644 --- a/service/codeguruprofiler/api_op_RetrieveTimeSeries.go +++ b/service/codeguruprofiler/api_op_RetrieveTimeSeries.go @@ -55,14 +55,14 @@ func (c *Client) RetrieveTimeSeries(ctx context.Context, params *RetrieveTimeSer } type RetrieveTimeSeriesInput struct { + ProfilingGroupName *string + EndTime *time.Time FrameMetrics []*types.FrameMetric Period *string - ProfilingGroupName *string - StartTime *time.Time TargetResolution types.AggregationPeriod diff --git a/service/codeguruprofiler/go.mod b/service/codeguruprofiler/go.mod index 800ea10e2d3..2d889a1033a 100644 --- a/service/codeguruprofiler/go.mod +++ b/service/codeguruprofiler/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/codeguruprofiler go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/codeguruprofiler/types/types.go b/service/codeguruprofiler/types/types.go index 1a87998039f..afd5ee3e225 100644 --- a/service/codeguruprofiler/types/types.go +++ b/service/codeguruprofiler/types/types.go @@ -18,7 +18,6 @@ type AggregatedProfileTime struct { // type AgentConfiguration struct { - AgentParameters map[string]*string // // @@ -29,6 +28,8 @@ type AgentConfiguration struct { // // This member is required. ShouldProfile *bool + + AgentParameters map[string]*string } // diff --git a/service/codegurureviewer/api_op_DescribeRecommendationFeedback.go b/service/codegurureviewer/api_op_DescribeRecommendationFeedback.go index 7233bee094f..7d256818c3e 100644 --- a/service/codegurureviewer/api_op_DescribeRecommendationFeedback.go +++ b/service/codegurureviewer/api_op_DescribeRecommendationFeedback.go @@ -57,12 +57,6 @@ func (c *Client) DescribeRecommendationFeedback(ctx context.Context, params *Des type DescribeRecommendationFeedbackInput struct { - // The recommendation ID that can be used to track the provided recommendations and - // then to collect the feedback. - // - // This member is required. - RecommendationId *string - // The Amazon Resource Name (ARN) of the CodeReview // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) // object. @@ -70,6 +64,12 @@ type DescribeRecommendationFeedbackInput struct { // This member is required. CodeReviewArn *string + // The recommendation ID that can be used to track the provided recommendations and + // then to collect the feedback. + // + // This member is required. + RecommendationId *string + // Optional parameter to describe the feedback for a given user. If this is not // supplied, it defaults to the user making the request. The UserId is an IAM // principal that can be specified as an AWS account ID or an Amazon Resource Name diff --git a/service/codegurureviewer/api_op_ListCodeReviews.go b/service/codegurureviewer/api_op_ListCodeReviews.go index 66268343c99..ed2d9106fdd 100644 --- a/service/codegurureviewer/api_op_ListCodeReviews.go +++ b/service/codegurureviewer/api_op_ListCodeReviews.go @@ -57,6 +57,11 @@ func (c *Client) ListCodeReviews(ctx context.Context, params *ListCodeReviewsInp type ListCodeReviewsInput struct { + // The type of code reviews to list in the response. + // + // This member is required. + Type types.Type + // The maximum number of results that are returned per call. The default is 100. MaxResults *int32 @@ -66,15 +71,14 @@ type ListCodeReviewsInput struct { // unchanged. NextToken *string + // List of provider types for filtering that needs to be applied before displaying + // the result. For example, providerTypes=[GitHub] lists code reviews from GitHub. + ProviderTypes []types.ProviderType + // List of repository names for filtering that needs to be applied before // displaying the result. RepositoryNames []*string - // The type of code reviews to list in the response. - // - // This member is required. - Type types.Type - // List of states for filtering that needs to be applied before displaying the // result. For example, states=[Pending] lists code reviews in the Pending state. // The valid code review states are: @@ -90,20 +94,16 @@ type ListCodeReviewsInput struct { // * Deleting: The code review // is being deleted. States []types.JobState - - // List of provider types for filtering that needs to be applied before displaying - // the result. For example, providerTypes=[GitHub] lists code reviews from GitHub. - ProviderTypes []types.ProviderType } type ListCodeReviewsOutput struct { - // Pagination token. - NextToken *string - // A list of code reviews that meet the criteria of the request. CodeReviewSummaries []*types.CodeReviewSummary + // Pagination token. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codegurureviewer/api_op_ListRecommendationFeedback.go b/service/codegurureviewer/api_op_ListRecommendationFeedback.go index 4d479bd96d4..9b7323ead88 100644 --- a/service/codegurureviewer/api_op_ListRecommendationFeedback.go +++ b/service/codegurureviewer/api_op_ListRecommendationFeedback.go @@ -60,17 +60,6 @@ func (c *Client) ListRecommendationFeedback(ctx context.Context, params *ListRec type ListRecommendationFeedbackInput struct { - // The maximum number of results that are returned per call. The default is 100. - MaxResults *int32 - - // An AWS user's account ID or Amazon Resource Name (ARN). Use this ID to query the - // recommendation feedback for a code review from that user. The UserId is an IAM - // principal that can be specified as an AWS account ID or an Amazon Resource Name - // (ARN). For more information, see Specifying a Principal - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying) - // in the AWS Identity and Access Management User Guide. - UserIds []*string - // The Amazon Resource Name (ARN) of the CodeReview // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) // object. @@ -78,27 +67,38 @@ type ListRecommendationFeedbackInput struct { // This member is required. CodeReviewArn *string - // Used to query the recommendation feedback for a given recommendation. - RecommendationIds []*string + // The maximum number of results that are returned per call. The default is 100. + MaxResults *int32 // If nextToken is returned, there are more results available. The value of // nextToken is a unique pagination token for each page. Make the call again using // the returned token to retrieve the next page. Keep all other arguments // unchanged. NextToken *string + + // Used to query the recommendation feedback for a given recommendation. + RecommendationIds []*string + + // An AWS user's account ID or Amazon Resource Name (ARN). Use this ID to query the + // recommendation feedback for a code review from that user. The UserId is an IAM + // principal that can be specified as an AWS account ID or an Amazon Resource Name + // (ARN). For more information, see Specifying a Principal + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying) + // in the AWS Identity and Access Management User Guide. + UserIds []*string } type ListRecommendationFeedbackOutput struct { - // Recommendation feedback summaries corresponding to the code review ARN. - RecommendationFeedbackSummaries []*types.RecommendationFeedbackSummary - // If nextToken is returned, there are more results available. The value of // nextToken is a unique pagination token for each page. Make the call again using // the returned token to retrieve the next page. Keep all other arguments // unchanged. NextToken *string + // Recommendation feedback summaries corresponding to the code review ARN. + RecommendationFeedbackSummaries []*types.RecommendationFeedbackSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codegurureviewer/api_op_ListRecommendations.go b/service/codegurureviewer/api_op_ListRecommendations.go index 8456d8cd604..1ed509a628a 100644 --- a/service/codegurureviewer/api_op_ListRecommendations.go +++ b/service/codegurureviewer/api_op_ListRecommendations.go @@ -57,9 +57,6 @@ func (c *Client) ListRecommendations(ctx context.Context, params *ListRecommenda type ListRecommendationsInput struct { - // The maximum number of results that are returned per call. The default is 100. - MaxResults *int32 - // The Amazon Resource Name (ARN) of the CodeReview // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) // object. @@ -67,18 +64,21 @@ type ListRecommendationsInput struct { // This member is required. CodeReviewArn *string + // The maximum number of results that are returned per call. The default is 100. + MaxResults *int32 + // Pagination token. NextToken *string } type ListRecommendationsOutput struct { - // List of recommendations for the requested code review. - RecommendationSummaries []*types.RecommendationSummary - // Pagination token. NextToken *string + // List of recommendations for the requested code review. + RecommendationSummaries []*types.RecommendationSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codegurureviewer/api_op_ListRepositoryAssociations.go b/service/codegurureviewer/api_op_ListRepositoryAssociations.go index 6f472fbbae6..a5b018bfdf2 100644 --- a/service/codegurureviewer/api_op_ListRepositoryAssociations.go +++ b/service/codegurureviewer/api_op_ListRepositoryAssociations.go @@ -76,6 +76,9 @@ type ListRepositoryAssociationsInput struct { // if applicable. MaxResults *int32 + // List of repository names to use as a filter. + Names []*string + // The nextToken value returned from a previous paginated // ListRepositoryAssociations request where maxResults was used and the results // exceeded the value of that parameter. Pagination continues from the end of the @@ -84,6 +87,12 @@ type ListRepositoryAssociationsInput struct { // for other programmatic purposes. NextToken *string + // List of owners to use as a filter. For AWS CodeCommit, it is the name of the + // CodeCommit account that was used to associate the repository. For other + // repository source providers, such as Bitbucket, this is name of the account that + // was used to associate the repository. + Owners []*string + // List of provider types to use as a filter. ProviderTypes []types.ProviderType @@ -112,28 +121,19 @@ type ListRepositoryAssociationsInput struct { // Disassociating: CodeGuru Reviewer is removing the repository's pull request // notifications and source code access. States []types.RepositoryAssociationState - - // List of owners to use as a filter. For AWS CodeCommit, it is the name of the - // CodeCommit account that was used to associate the repository. For other - // repository source providers, such as Bitbucket, this is name of the account that - // was used to associate the repository. - Owners []*string - - // List of repository names to use as a filter. - Names []*string } type ListRepositoryAssociationsOutput struct { - // A list of repository associations that meet the criteria of the request. - RepositoryAssociationSummaries []*types.RepositoryAssociationSummary - // The nextToken value to include in a future ListRecommendations request. When the // results of a ListRecommendations request exceed maxResults, this value can be // used to retrieve the next page of results. This value is null when there are no // more results to return. NextToken *string + // A list of repository associations that meet the criteria of the request. + RepositoryAssociationSummaries []*types.RepositoryAssociationSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codegurureviewer/api_op_PutRecommendationFeedback.go b/service/codegurureviewer/api_op_PutRecommendationFeedback.go index 77948abc17e..6f7b94872a3 100644 --- a/service/codegurureviewer/api_op_PutRecommendationFeedback.go +++ b/service/codegurureviewer/api_op_PutRecommendationFeedback.go @@ -58,12 +58,6 @@ func (c *Client) PutRecommendationFeedback(ctx context.Context, params *PutRecom type PutRecommendationFeedbackInput struct { - // List for storing reactions. Reactions are utf-8 text code for emojis. If you - // send an empty list it clears all your feedback. - // - // This member is required. - Reactions []types.Reaction - // The Amazon Resource Name (ARN) of the CodeReview // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) // object. @@ -71,6 +65,12 @@ type PutRecommendationFeedbackInput struct { // This member is required. CodeReviewArn *string + // List for storing reactions. Reactions are utf-8 text code for emojis. If you + // send an empty list it clears all your feedback. + // + // This member is required. + Reactions []types.Reaction + // The recommendation ID that can be used to track the provided recommendations and // then to collect the feedback. // diff --git a/service/codegurureviewer/go.mod b/service/codegurureviewer/go.mod index 1c4365b8aec..11212a446ef 100644 --- a/service/codegurureviewer/go.mod +++ b/service/codegurureviewer/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/codegurureviewer go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/codegurureviewer/types/types.go b/service/codegurureviewer/types/types.go index f3f86ebbcb7..9e7bc0c59d0 100644 --- a/service/codegurureviewer/types/types.go +++ b/service/codegurureviewer/types/types.go @@ -23,38 +23,41 @@ type CodeCommitRepository struct { // Information about a code review. type CodeReview struct { - // The reason for the state of the code review. - StateReason *string + // The Amazon Resource Name (ARN) of the CodeReview + // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) + // object. + CodeReviewArn *string - // The type of code review. - Type Type + // The time, in milliseconds since the epoch, when the code review was created. + CreatedTimeStamp *time.Time + + // The time, in milliseconds since the epoch, when the code review was last + // updated. + LastUpdatedTimeStamp *time.Time + + // The statistics from the code review. + Metrics *Metrics + + // The name of the code review. + Name *string // The owner of the repository. For an AWS CodeCommit repository, this is the AWS // account ID of the account that owns the repository. For a GitHub or Bitbucket // repository, this is the username for the account that owns the repository. Owner *string - // The type of the source code for the code review. - SourceCodeType *SourceCodeType - - // The time, in milliseconds since the epoch, when the code review was last - // updated. - LastUpdatedTimeStamp *time.Time - // The type of repository that contains the reviewed code (for example, GitHub or // Bitbucket). ProviderType ProviderType - // The Amazon Resource Name (ARN) of the CodeReview - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) - // object. - CodeReviewArn *string - // The pull request ID for the code review. PullRequestId *string - // The name of the code review. - Name *string + // The name of the repository. + RepositoryName *string + + // The type of the source code for the code review. + SourceCodeType *SourceCodeType // The valid code review states are: // @@ -70,22 +73,48 @@ type CodeReview struct { // is being deleted. State JobState - // The statistics from the code review. - Metrics *Metrics - - // The time, in milliseconds since the epoch, when the code review was created. - CreatedTimeStamp *time.Time + // The reason for the state of the code review. + StateReason *string - // The name of the repository. - RepositoryName *string + // The type of code review. + Type Type } // Information about the summary of the code review. type CodeReviewSummary struct { + // The Amazon Resource Name (ARN) of the CodeReview + // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) + // object. + CodeReviewArn *string + + // The time, in milliseconds since the epoch, when the code review was created. + CreatedTimeStamp *time.Time + + // The time, in milliseconds since the epoch, when the code review was last + // updated. + LastUpdatedTimeStamp *time.Time + + // The statistics from the code review. + MetricsSummary *MetricsSummary + + // The name of the code review. + Name *string + + // The owner of the repository. For an AWS CodeCommit repository, this is the AWS + // account ID of the account that owns the repository. For a GitHub or Bitbucket + // repository, this is the username for the account that owns the repository. + Owner *string + // The provider type of the repository association. ProviderType ProviderType + // The pull request ID for the code review. + PullRequestId *string + + // The name of the repository. + RepositoryName *string + // The state of the code review. The valid code review states are: // // * @@ -100,52 +129,26 @@ type CodeReviewSummary struct { // Deleting: The code review is being deleted. State JobState - // The statistics from the code review. - MetricsSummary *MetricsSummary - - // The pull request ID for the code review. - PullRequestId *string - - // The Amazon Resource Name (ARN) of the CodeReview - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) - // object. - CodeReviewArn *string - - // The owner of the repository. For an AWS CodeCommit repository, this is the AWS - // account ID of the account that owns the repository. For a GitHub or Bitbucket - // repository, this is the username for the account that owns the repository. - Owner *string - // The type of the code review. Type Type - - // The time, in milliseconds since the epoch, when the code review was created. - CreatedTimeStamp *time.Time - - // The name of the code review. - Name *string - - // The time, in milliseconds since the epoch, when the code review was last - // updated. - LastUpdatedTimeStamp *time.Time - - // The name of the repository. - RepositoryName *string } // The commit diff for the pull request. type CommitDiffSourceCodeType struct { - // The SHA of the source commit. - SourceCommit *string - // The SHA of the destination commit. DestinationCommit *string + + // The SHA of the source commit. + SourceCommit *string } // Information about the statistics from the code review. type Metrics struct { + // Total number of recommendations found in the code review. + FindingsCount *int64 + // Lines of code metered in the code review. For the initial code review pull // request and all subsequent revisions, this includes all lines of code in the // files added to the pull request. In subsequent revisions, for files that already @@ -158,14 +161,14 @@ type Metrics struct { // lines), the new file (200 lines) and the 25 changed lines of code for a total of // 2,725 lines of code. MeteredLinesOfCodeCount *int64 - - // Total number of recommendations found in the code review. - FindingsCount *int64 } // Information about metrics summaries. type MetricsSummary struct { + // Total number of recommendations found in the code review. + FindingsCount *int64 + // Lines of code metered in the code review. For the initial code review pull // request and all subsequent revisions, this includes all lines of code in the // files added to the pull request. In subsequent revisions, for files that already @@ -178,39 +181,36 @@ type MetricsSummary struct { // lines), the new file (200 lines) and the 25 changed lines of code for a total of // 2,725 lines of code. MeteredLinesOfCodeCount *int64 - - // Total number of recommendations found in the code review. - FindingsCount *int64 } // Information about the recommendation feedback. type RecommendationFeedback struct { - // The recommendation ID that can be used to track the provided recommendations. - // Later on it can be used to collect the feedback. - RecommendationId *string - - // The time at which the feedback was created. - CreatedTimeStamp *time.Time - // The Amazon Resource Name (ARN) of the CodeReview // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) // object. CodeReviewArn *string + // The time at which the feedback was created. + CreatedTimeStamp *time.Time + + // The time at which the feedback was last updated. + LastUpdatedTimeStamp *time.Time + // List for storing reactions. Reactions are utf-8 text code for emojis. You can // send an empty list to clear off all your feedback. Reactions []Reaction + // The recommendation ID that can be used to track the provided recommendations. + // Later on it can be used to collect the feedback. + RecommendationId *string + // The ID of the user that made the API call. The UserId is an IAM principal that // can be specified as an AWS account ID or an Amazon Resource Name (ARN). For more // information, see Specifying a Principal // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying) // in the AWS Identity and Access Management User Guide. UserId *string - - // The time at which the feedback was last updated. - LastUpdatedTimeStamp *time.Time } // Information about recommendation feedback summaries. @@ -234,25 +234,25 @@ type RecommendationFeedbackSummary struct { // Information about recommendations. type RecommendationSummary struct { - // Name of the file on which a recommendation is provided. - FilePath *string - // A description of the recommendation generated by CodeGuru Reviewer for the lines // of code between the start line and the end line. Description *string - // Start line from where the recommendation is applicable in the source commit or - // source branch. - StartLine *int32 + // Last line where the recommendation is applicable in the source commit or source + // branch. For a single line comment the start line and end line values are the + // same. + EndLine *int32 + + // Name of the file on which a recommendation is provided. + FilePath *string // The recommendation ID that can be used to track the provided recommendations. // Later on it can be used to collect the feedback. RecommendationId *string - // Last line where the recommendation is applicable in the source commit or source - // branch. For a single line comment the start line and end line values are the - // same. - EndLine *int32 + // Start line from where the recommendation is applicable in the source commit or + // source branch. + StartLine *int32 } // Information about an associated AWS CodeCommit repository or an associated @@ -261,14 +261,14 @@ type RecommendationSummary struct { // GitHub repository. type Repository struct { - // Information about a GitHub Enterprise Server repository. - GitHubEnterpriseServer *ThirdPartySourceRepository - // Information about a Bitbucket repository. Bitbucket *ThirdPartySourceRepository // Information about an AWS CodeCommit repository. CodeCommit *CodeCommitRepository + + // Information about a GitHub Enterprise Server repository. + GitHubEnterpriseServer *ThirdPartySourceRepository } // Information about a repository association. The DescribeRepositoryAssociation @@ -279,20 +279,36 @@ type RepositoryAssociation struct { // The Amazon Resource Name (ARN) identifying the repository association. AssociationArn *string - // The time, in milliseconds since the epoch, when the repository association was - // last updated. - LastUpdatedTimeStamp *time.Time + // The ID of the repository association. + AssociationId *string + + // The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. Its + // format is + // arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. + // For more information, see Connection + // (https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html) + // in the AWS CodeStar Connections API Reference. + ConnectionArn *string // The time, in milliseconds since the epoch, when the repository association was // created. CreatedTimeStamp *time.Time + // The time, in milliseconds since the epoch, when the repository association was + // last updated. + LastUpdatedTimeStamp *time.Time + + // The name of the repository. + Name *string + + // The owner of the repository. For an AWS CodeCommit repository, this is the AWS + // account ID of the account that owns the repository. For a GitHub or Bitbucket + // repository, this is the username for the account that owns the repository. + Owner *string + // The provider type of the repository association. ProviderType ProviderType - // A description of why the repository association is in the current state. - StateReason *string - // The state of the repository association. The valid repository association states // are: // @@ -319,6 +335,24 @@ type RepositoryAssociation struct { // access. State RepositoryAssociationState + // A description of why the repository association is in the current state. + StateReason *string +} + +// Summary information about a repository association. The +// ListRepositoryAssociations +// (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html) +// operation returns a list of RepositoryAssociationSummary objects. +type RepositoryAssociationSummary struct { + + // The Amazon Resource Name (ARN) of the RepositoryAssociation + // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) + // object. + AssociationArn *string + + // The repository association ID. + AssociationId *string + // The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. Its // format is // arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. @@ -327,23 +361,20 @@ type RepositoryAssociation struct { // in the AWS CodeStar Connections API Reference. ConnectionArn *string - // The name of the repository. - Name *string + // The time, in milliseconds since the epoch, since the repository association was + // last updated. + LastUpdatedTimeStamp *time.Time - // The ID of the repository association. - AssociationId *string + // The name of the repository association. + Name *string // The owner of the repository. For an AWS CodeCommit repository, this is the AWS // account ID of the account that owns the repository. For a GitHub or Bitbucket // repository, this is the username for the account that owns the repository. Owner *string -} -// Summary information about a repository association. The -// ListRepositoryAssociations -// (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html) -// operation returns a list of RepositoryAssociationSummary objects. -type RepositoryAssociationSummary struct { + // The provider type of the repository association. + ProviderType ProviderType // The state of the repository association. The valid repository association states // are: @@ -370,37 +401,6 @@ type RepositoryAssociationSummary struct { // Reviewer is removing the repository's pull request notifications and source code // access. State RepositoryAssociationState - - // The repository association ID. - AssociationId *string - - // The provider type of the repository association. - ProviderType ProviderType - - // The name of the repository association. - Name *string - - // The Amazon Resource Name (ARN) of the RepositoryAssociation - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) - // object. - AssociationArn *string - - // The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. Its - // format is - // arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. - // For more information, see Connection - // (https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html) - // in the AWS CodeStar Connections API Reference. - ConnectionArn *string - - // The owner of the repository. For an AWS CodeCommit repository, this is the AWS - // account ID of the account that owns the repository. For a GitHub or Bitbucket - // repository, this is the username for the account that owns the repository. - Owner *string - - // The time, in milliseconds since the epoch, since the repository association was - // last updated. - LastUpdatedTimeStamp *time.Time } // Information about the source code type. @@ -414,24 +414,24 @@ type SourceCodeType struct { // Reviewer. type ThirdPartySourceRepository struct { - // The owner of the repository. For a GitHub, GitHub Enterprise, or Bitbucket - // repository, this is the username for the account that owns the repository. + // The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. Its + // format is + // arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. + // For more information, see Connection + // (https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html) + // in the AWS CodeStar Connections API Reference. // // This member is required. - Owner *string + ConnectionArn *string // The name of the third party source repository. // // This member is required. Name *string - // The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. Its - // format is - // arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. - // For more information, see Connection - // (https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html) - // in the AWS CodeStar Connections API Reference. + // The owner of the repository. For a GitHub, GitHub Enterprise, or Bitbucket + // repository, this is the username for the account that owns the repository. // // This member is required. - ConnectionArn *string + Owner *string } diff --git a/service/codepipeline/api_op_AcknowledgeJob.go b/service/codepipeline/api_op_AcknowledgeJob.go index 44db5483b11..3189cdbfe25 100644 --- a/service/codepipeline/api_op_AcknowledgeJob.go +++ b/service/codepipeline/api_op_AcknowledgeJob.go @@ -59,17 +59,17 @@ func (c *Client) AcknowledgeJob(ctx context.Context, params *AcknowledgeJobInput // Represents the input of an AcknowledgeJob action. type AcknowledgeJobInput struct { + // The unique system-generated ID of the job for which you want to confirm receipt. + // + // This member is required. + JobId *string + // A system-generated random number that AWS CodePipeline uses to ensure that the // job is being worked on by only one job worker. Get this number from the response // of the PollForJobs () request that returned this job. // // This member is required. Nonce *string - - // The unique system-generated ID of the job for which you want to confirm receipt. - // - // This member is required. - JobId *string } // Represents the output of an AcknowledgeJob action. diff --git a/service/codepipeline/api_op_AcknowledgeThirdPartyJob.go b/service/codepipeline/api_op_AcknowledgeThirdPartyJob.go index c190b46fd8b..556f446243f 100644 --- a/service/codepipeline/api_op_AcknowledgeThirdPartyJob.go +++ b/service/codepipeline/api_op_AcknowledgeThirdPartyJob.go @@ -65,17 +65,17 @@ type AcknowledgeThirdPartyJobInput struct { // This member is required. ClientToken *string + // The unique system-generated ID of the job. + // + // This member is required. + JobId *string + // A system-generated random number that AWS CodePipeline uses to ensure that the // job is being worked on by only one job worker. Get this number from the response // to a GetThirdPartyJobDetails () request. // // This member is required. Nonce *string - - // The unique system-generated ID of the job. - // - // This member is required. - JobId *string } // Represents the output of an AcknowledgeThirdPartyJob action. diff --git a/service/codepipeline/api_op_CreateCustomActionType.go b/service/codepipeline/api_op_CreateCustomActionType.go index bd5b29d405d..634d06be5ec 100644 --- a/service/codepipeline/api_op_CreateCustomActionType.go +++ b/service/codepipeline/api_op_CreateCustomActionType.go @@ -59,6 +59,13 @@ func (c *Client) CreateCustomActionType(ctx context.Context, params *CreateCusto // Represents the input of a CreateCustomActionType operation. type CreateCustomActionTypeInput struct { + // The category of the custom action, such as a build action or a test action. + // Although Source and Approval are listed as valid values, they are not currently + // functional. These values are reserved for future use. + // + // This member is required. + Category types.ActionCategory + // The details of the input artifact for the action, such as its commit ID. // // This member is required. @@ -69,21 +76,15 @@ type CreateCustomActionTypeInput struct { // This member is required. OutputArtifactDetails *types.ArtifactDetails - // URLs that provide users information about this custom action. - Settings *types.ActionTypeSettings - - // The version identifier of the custom action. - // - // This member is required. - Version *string - // The provider of the service used in the custom action, such as AWS CodeDeploy. // // This member is required. Provider *string - // The tags for the custom action. - Tags []*types.Tag + // The version identifier of the custom action. + // + // This member is required. + Version *string // The configuration properties for the custom action. You can refer to a name in // the configuration properties of the custom action within the URL templates by @@ -93,12 +94,11 @@ type CreateCustomActionTypeInput struct { // (https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html). ConfigurationProperties []*types.ActionConfigurationProperty - // The category of the custom action, such as a build action or a test action. - // Although Source and Approval are listed as valid values, they are not currently - // functional. These values are reserved for future use. - // - // This member is required. - Category types.ActionCategory + // URLs that provide users information about this custom action. + Settings *types.ActionTypeSettings + + // The tags for the custom action. + Tags []*types.Tag } // Represents the output of a CreateCustomActionType operation. diff --git a/service/codepipeline/api_op_CreatePipeline.go b/service/codepipeline/api_op_CreatePipeline.go index d7095e82582..9485536cf6e 100644 --- a/service/codepipeline/api_op_CreatePipeline.go +++ b/service/codepipeline/api_op_CreatePipeline.go @@ -72,12 +72,12 @@ type CreatePipelineInput struct { // Represents the output of a CreatePipeline action. type CreatePipelineOutput struct { - // Specifies the tags applied to the pipeline. - Tags []*types.Tag - // Represents the structure of actions and stages to be performed in the pipeline. Pipeline *types.PipelineDeclaration + // Specifies the tags applied to the pipeline. + Tags []*types.Tag + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codepipeline/api_op_DisableStageTransition.go b/service/codepipeline/api_op_DisableStageTransition.go index 81c3db85aa3..d9faa3692cc 100644 --- a/service/codepipeline/api_op_DisableStageTransition.go +++ b/service/codepipeline/api_op_DisableStageTransition.go @@ -59,20 +59,6 @@ func (c *Client) DisableStageTransition(ctx context.Context, params *DisableStag // Represents the input of a DisableStageTransition action. type DisableStageTransitionInput struct { - // Specifies whether artifacts are prevented from transitioning into the stage and - // being processed by the actions in that stage (inbound), or prevented from - // transitioning from the stage after they have been processed by the actions in - // that stage (outbound). - // - // This member is required. - TransitionType types.StageTransitionType - - // The name of the stage where you want to disable the inbound or outbound - // transition of artifacts. - // - // This member is required. - StageName *string - // The name of the pipeline in which you want to disable the flow of artifacts from // one stage to another. // @@ -85,6 +71,20 @@ type DisableStageTransitionInput struct { // // This member is required. Reason *string + + // The name of the stage where you want to disable the inbound or outbound + // transition of artifacts. + // + // This member is required. + StageName *string + + // Specifies whether artifacts are prevented from transitioning into the stage and + // being processed by the actions in that stage (inbound), or prevented from + // transitioning from the stage after they have been processed by the actions in + // that stage (outbound). + // + // This member is required. + TransitionType types.StageTransitionType } type DisableStageTransitionOutput struct { diff --git a/service/codepipeline/api_op_EnableStageTransition.go b/service/codepipeline/api_op_EnableStageTransition.go index 262045d116e..330c70f78cd 100644 --- a/service/codepipeline/api_op_EnableStageTransition.go +++ b/service/codepipeline/api_op_EnableStageTransition.go @@ -58,13 +58,6 @@ func (c *Client) EnableStageTransition(ctx context.Context, params *EnableStageT // Represents the input of an EnableStageTransition action. type EnableStageTransitionInput struct { - // Specifies whether artifacts are allowed to enter the stage and be processed by - // the actions in that stage (inbound) or whether already processed artifacts are - // allowed to transition to the next stage (outbound). - // - // This member is required. - TransitionType types.StageTransitionType - // The name of the pipeline in which you want to enable the flow of artifacts from // one stage to another. // @@ -76,6 +69,13 @@ type EnableStageTransitionInput struct { // // This member is required. StageName *string + + // Specifies whether artifacts are allowed to enter the stage and be processed by + // the actions in that stage (inbound) or whether already processed artifacts are + // allowed to transition to the next stage (outbound). + // + // This member is required. + TransitionType types.StageTransitionType } type EnableStageTransitionOutput struct { diff --git a/service/codepipeline/api_op_GetPipeline.go b/service/codepipeline/api_op_GetPipeline.go index 6366932bed6..7efc5bce9aa 100644 --- a/service/codepipeline/api_op_GetPipeline.go +++ b/service/codepipeline/api_op_GetPipeline.go @@ -60,15 +60,15 @@ func (c *Client) GetPipeline(ctx context.Context, params *GetPipelineInput, optF // Represents the input of a GetPipeline action. type GetPipelineInput struct { - // The version number of the pipeline. If you do not specify a version, defaults to - // the current version. - Version *int32 - // The name of the pipeline for which you want to get information. Pipeline names // must be unique under an AWS user account. // // This member is required. Name *string + + // The version number of the pipeline. If you do not specify a version, defaults to + // the current version. + Version *int32 } // Represents the output of a GetPipeline action. diff --git a/service/codepipeline/api_op_GetPipelineExecution.go b/service/codepipeline/api_op_GetPipelineExecution.go index d0763290b2b..b06725c52b9 100644 --- a/service/codepipeline/api_op_GetPipelineExecution.go +++ b/service/codepipeline/api_op_GetPipelineExecution.go @@ -60,15 +60,15 @@ func (c *Client) GetPipelineExecution(ctx context.Context, params *GetPipelineEx // Represents the input of a GetPipelineExecution action. type GetPipelineExecutionInput struct { - // The name of the pipeline about which you want to get execution details. + // The ID of the pipeline execution about which you want to get execution details. // // This member is required. - PipelineName *string + PipelineExecutionId *string - // The ID of the pipeline execution about which you want to get execution details. + // The name of the pipeline about which you want to get execution details. // // This member is required. - PipelineExecutionId *string + PipelineName *string } // Represents the output of a GetPipelineExecution action. diff --git a/service/codepipeline/api_op_GetPipelineState.go b/service/codepipeline/api_op_GetPipelineState.go index 54dfdf65fdc..af6eb54328e 100644 --- a/service/codepipeline/api_op_GetPipelineState.go +++ b/service/codepipeline/api_op_GetPipelineState.go @@ -70,22 +70,22 @@ type GetPipelineStateInput struct { // Represents the output of a GetPipelineState action. type GetPipelineStateOutput struct { - // The date and time the pipeline was last updated, in timestamp format. - Updated *time.Time - - // A list of the pipeline stage output information, including stage name, state, - // most recent run details, whether the stage is disabled, and other data. - StageStates []*types.StageState - // The date and time the pipeline was created, in timestamp format. Created *time.Time + // The name of the pipeline for which you want to get the state. + PipelineName *string + // The version number of the pipeline. A newly created pipeline is always assigned // a version number of 1. PipelineVersion *int32 - // The name of the pipeline for which you want to get the state. - PipelineName *string + // A list of the pipeline stage output information, including stage name, state, + // most recent run details, whether the stage is disabled, and other data. + StageStates []*types.StageState + + // The date and time the pipeline was last updated, in timestamp format. + Updated *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/codepipeline/api_op_GetThirdPartyJobDetails.go b/service/codepipeline/api_op_GetThirdPartyJobDetails.go index ee3f356943b..44435fc4760 100644 --- a/service/codepipeline/api_op_GetThirdPartyJobDetails.go +++ b/service/codepipeline/api_op_GetThirdPartyJobDetails.go @@ -62,16 +62,16 @@ func (c *Client) GetThirdPartyJobDetails(ctx context.Context, params *GetThirdPa // Represents the input of a GetThirdPartyJobDetails action. type GetThirdPartyJobDetailsInput struct { - // The unique system-generated ID used for identifying the job. - // - // This member is required. - JobId *string - // The clientToken portion of the clientId and clientToken pair used to verify that // the calling entity is allowed access to the job and its details. // // This member is required. ClientToken *string + + // The unique system-generated ID used for identifying the job. + // + // This member is required. + JobId *string } // Represents the output of a GetThirdPartyJobDetails action. diff --git a/service/codepipeline/api_op_ListActionExecutions.go b/service/codepipeline/api_op_ListActionExecutions.go index 545119d7f43..a58b34abad0 100644 --- a/service/codepipeline/api_op_ListActionExecutions.go +++ b/service/codepipeline/api_op_ListActionExecutions.go @@ -57,6 +57,14 @@ func (c *Client) ListActionExecutions(ctx context.Context, params *ListActionExe type ListActionExecutionsInput struct { + // The name of the pipeline for which you want to list action execution history. + // + // This member is required. + PipelineName *string + + // Input information used to filter action execution history. + Filter *types.ActionExecutionFilter + // The maximum number of results to return in a single call. To retrieve the // remaining results, make another call with the returned nextToken value. Action // execution history is retained for up to 12 months, based on action execution @@ -64,14 +72,6 @@ type ListActionExecutionsInput struct { // executions run on or after February 21, 2019. MaxResults *int32 - // Input information used to filter action execution history. - Filter *types.ActionExecutionFilter - - // The name of the pipeline for which you want to list action execution history. - // - // This member is required. - PipelineName *string - // The token that was returned from the previous ListActionExecutions call, which // can be used to return the next set of action executions in the list. NextToken *string diff --git a/service/codepipeline/api_op_ListPipelineExecutions.go b/service/codepipeline/api_op_ListPipelineExecutions.go index 346baab3725..538d43a9858 100644 --- a/service/codepipeline/api_op_ListPipelineExecutions.go +++ b/service/codepipeline/api_op_ListPipelineExecutions.go @@ -78,14 +78,14 @@ type ListPipelineExecutionsInput struct { // Represents the output of a ListPipelineExecutions action. type ListPipelineExecutionsOutput struct { - // A list of executions in the history of a pipeline. - PipelineExecutionSummaries []*types.PipelineExecutionSummary - // A token that can be used in the next ListPipelineExecutions call. To view all // items in the list, continue to call this operation with each subsequent token // until no more nextToken values are returned. NextToken *string + // A list of executions in the history of a pipeline. + PipelineExecutionSummaries []*types.PipelineExecutionSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codepipeline/api_op_ListPipelines.go b/service/codepipeline/api_op_ListPipelines.go index fff24fb05bd..40ceb960a92 100644 --- a/service/codepipeline/api_op_ListPipelines.go +++ b/service/codepipeline/api_op_ListPipelines.go @@ -65,14 +65,14 @@ type ListPipelinesInput struct { // Represents the output of a ListPipelines action. type ListPipelinesOutput struct { - // The list of pipelines. - Pipelines []*types.PipelineSummary - // If the amount of returned information is significantly large, an identifier is // also returned. It can be used in a subsequent list pipelines call to return the // next set of pipelines in the list. NextToken *string + // The list of pipelines. + Pipelines []*types.PipelineSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codepipeline/api_op_ListTagsForResource.go b/service/codepipeline/api_op_ListTagsForResource.go index c4525919910..2edf26455d3 100644 --- a/service/codepipeline/api_op_ListTagsForResource.go +++ b/service/codepipeline/api_op_ListTagsForResource.go @@ -57,6 +57,11 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { + // The Amazon Resource Name (ARN) of the resource to get tags for. + // + // This member is required. + ResourceArn *string + // The maximum number of results to return in a single call. MaxResults *int32 @@ -64,11 +69,6 @@ type ListTagsForResourceInput struct { // return the next page of the list. The ListTagsforResource call lists all // available tags in one call and does not use pagination. NextToken *string - - // The Amazon Resource Name (ARN) of the resource to get tags for. - // - // This member is required. - ResourceArn *string } type ListTagsForResourceOutput struct { diff --git a/service/codepipeline/api_op_PollForJobs.go b/service/codepipeline/api_op_PollForJobs.go index 8cc177f6ebd..106d8531ba4 100644 --- a/service/codepipeline/api_op_PollForJobs.go +++ b/service/codepipeline/api_op_PollForJobs.go @@ -64,19 +64,19 @@ func (c *Client) PollForJobs(ctx context.Context, params *PollForJobsInput, optF // Represents the input of a PollForJobs action. type PollForJobsInput struct { + // Represents information about an action type. + // + // This member is required. + ActionTypeId *types.ActionTypeId + + // The maximum number of jobs to return in a poll for jobs call. + MaxBatchSize *int32 + // A map of property names and values. For an action type with no queryable // properties, this value must be null or an empty map. For an action type with a // queryable property, you must supply that property as a key in the map. Only jobs // whose action configuration matches the mapped value are returned. QueryParam map[string]*string - - // The maximum number of jobs to return in a poll for jobs call. - MaxBatchSize *int32 - - // Represents information about an action type. - // - // This member is required. - ActionTypeId *types.ActionTypeId } // Represents the output of a PollForJobs action. diff --git a/service/codepipeline/api_op_PutActionRevision.go b/service/codepipeline/api_op_PutActionRevision.go index 332d40c89cb..7ab60cf8446 100644 --- a/service/codepipeline/api_op_PutActionRevision.go +++ b/service/codepipeline/api_op_PutActionRevision.go @@ -58,25 +58,25 @@ func (c *Client) PutActionRevision(ctx context.Context, params *PutActionRevisio // Represents the input of a PutActionRevision action. type PutActionRevisionInput struct { - // The name of the stage that contains the action that acts on the revision. + // The name of the action that processes the revision. // // This member is required. - StageName *string + ActionName *string - // The name of the pipeline that starts processing the revision to the source. + // Represents information about the version (or revision) of an action. // // This member is required. - PipelineName *string + ActionRevision *types.ActionRevision - // The name of the action that processes the revision. + // The name of the pipeline that starts processing the revision to the source. // // This member is required. - ActionName *string + PipelineName *string - // Represents information about the version (or revision) of an action. + // The name of the stage that contains the action that acts on the revision. // // This member is required. - ActionRevision *types.ActionRevision + StageName *string } // Represents the output of a PutActionRevision action. diff --git a/service/codepipeline/api_op_PutApprovalResult.go b/service/codepipeline/api_op_PutApprovalResult.go index e3c5ca8fc08..e8b7501a46b 100644 --- a/service/codepipeline/api_op_PutApprovalResult.go +++ b/service/codepipeline/api_op_PutApprovalResult.go @@ -60,6 +60,11 @@ func (c *Client) PutApprovalResult(ctx context.Context, params *PutApprovalResul // Represents the input of a PutApprovalResult action. type PutApprovalResultInput struct { + // The name of the action for which approval is requested. + // + // This member is required. + ActionName *string + // The name of the pipeline that contains the action. // // This member is required. @@ -70,10 +75,10 @@ type PutApprovalResultInput struct { // This member is required. Result *types.ApprovalResult - // The name of the action for which approval is requested. + // The name of the stage that contains the action. // // This member is required. - ActionName *string + StageName *string // The system-generated token used to identify a unique approval request. The token // for each open approval request can be obtained using the GetPipelineState () @@ -82,11 +87,6 @@ type PutApprovalResultInput struct { // // This member is required. Token *string - - // The name of the stage that contains the action. - // - // This member is required. - StageName *string } // Represents the output of a PutApprovalResult action. diff --git a/service/codepipeline/api_op_PutJobFailureResult.go b/service/codepipeline/api_op_PutJobFailureResult.go index 728e1dafa8a..3800015571a 100644 --- a/service/codepipeline/api_op_PutJobFailureResult.go +++ b/service/codepipeline/api_op_PutJobFailureResult.go @@ -59,16 +59,16 @@ func (c *Client) PutJobFailureResult(ctx context.Context, params *PutJobFailureR // Represents the input of a PutJobFailureResult action. type PutJobFailureResultInput struct { - // The unique system-generated ID of the job that failed. This is the same ID - // returned from PollForJobs. + // The details about the failure of a job. // // This member is required. - JobId *string + FailureDetails *types.FailureDetails - // The details about the failure of a job. + // The unique system-generated ID of the job that failed. This is the same ID + // returned from PollForJobs. // // This member is required. - FailureDetails *types.FailureDetails + JobId *string } type PutJobFailureResultOutput struct { diff --git a/service/codepipeline/api_op_PutJobSuccessResult.go b/service/codepipeline/api_op_PutJobSuccessResult.go index 9842f055b96..00ae4631d52 100644 --- a/service/codepipeline/api_op_PutJobSuccessResult.go +++ b/service/codepipeline/api_op_PutJobSuccessResult.go @@ -59,19 +59,6 @@ func (c *Client) PutJobSuccessResult(ctx context.Context, params *PutJobSuccessR // Represents the input of a PutJobSuccessResult action. type PutJobSuccessResultInput struct { - // Key-value pairs produced as output by a job worker that can be made available to - // a downstream action configuration. outputVariables can be included only when - // there is no continuation token on the request. - OutputVariables map[string]*string - - // The ID of the current revision of the artifact successfully worked on by the - // job. - CurrentRevision *types.CurrentRevision - - // The execution details of the successful job, such as the actions taken by the - // job worker. - ExecutionDetails *types.ExecutionDetails - // The unique system-generated ID of the job that succeeded. This is the same ID // returned from PollForJobs. // @@ -84,6 +71,19 @@ type PutJobSuccessResultInput struct { // to return more information about the progress of the custom action. When the // action is complete, no continuation token should be supplied. ContinuationToken *string + + // The ID of the current revision of the artifact successfully worked on by the + // job. + CurrentRevision *types.CurrentRevision + + // The execution details of the successful job, such as the actions taken by the + // job worker. + ExecutionDetails *types.ExecutionDetails + + // Key-value pairs produced as output by a job worker that can be made available to + // a downstream action configuration. outputVariables can be included only when + // there is no continuation token on the request. + OutputVariables map[string]*string } type PutJobSuccessResultOutput struct { diff --git a/service/codepipeline/api_op_PutThirdPartyJobFailureResult.go b/service/codepipeline/api_op_PutThirdPartyJobFailureResult.go index 33e8605a355..6667392d91a 100644 --- a/service/codepipeline/api_op_PutThirdPartyJobFailureResult.go +++ b/service/codepipeline/api_op_PutThirdPartyJobFailureResult.go @@ -65,16 +65,16 @@ type PutThirdPartyJobFailureResultInput struct { // This member is required. ClientToken *string - // The ID of the job that failed. This is the same ID returned from - // PollForThirdPartyJobs. + // Represents information about failure details. // // This member is required. - JobId *string + FailureDetails *types.FailureDetails - // Represents information about failure details. + // The ID of the job that failed. This is the same ID returned from + // PollForThirdPartyJobs. // // This member is required. - FailureDetails *types.FailureDetails + JobId *string } type PutThirdPartyJobFailureResultOutput struct { diff --git a/service/codepipeline/api_op_PutThirdPartyJobSuccessResult.go b/service/codepipeline/api_op_PutThirdPartyJobSuccessResult.go index 54f1c3a4398..c15fb94a6ef 100644 --- a/service/codepipeline/api_op_PutThirdPartyJobSuccessResult.go +++ b/service/codepipeline/api_op_PutThirdPartyJobSuccessResult.go @@ -59,8 +59,11 @@ func (c *Client) PutThirdPartyJobSuccessResult(ctx context.Context, params *PutT // Represents the input of a PutThirdPartyJobSuccessResult action. type PutThirdPartyJobSuccessResultInput struct { - // Represents information about a current revision. - CurrentRevision *types.CurrentRevision + // The clientToken portion of the clientId and clientToken pair used to verify that + // the calling entity is allowed access to the job and its details. + // + // This member is required. + ClientToken *string // The ID of the job that successfully completed. This is the same ID returned from // PollForThirdPartyJobs. @@ -68,22 +71,19 @@ type PutThirdPartyJobSuccessResultInput struct { // This member is required. JobId *string - // The details of the actions taken and results produced on an artifact as it - // passes through stages in the pipeline. - ExecutionDetails *types.ExecutionDetails - - // The clientToken portion of the clientId and clientToken pair used to verify that - // the calling entity is allowed access to the job and its details. - // - // This member is required. - ClientToken *string - // A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that // a successful job provides to identify a partner action in progress. Future jobs // use this token to identify the running instance of the action. It can be reused // to return more information about the progress of the partner action. When the // action is complete, no continuation token should be supplied. ContinuationToken *string + + // Represents information about a current revision. + CurrentRevision *types.CurrentRevision + + // The details of the actions taken and results produced on an artifact as it + // passes through stages in the pipeline. + ExecutionDetails *types.ExecutionDetails } type PutThirdPartyJobSuccessResultOutput struct { diff --git a/service/codepipeline/api_op_PutWebhook.go b/service/codepipeline/api_op_PutWebhook.go index c50e67bc53a..4e76d6ef616 100644 --- a/service/codepipeline/api_op_PutWebhook.go +++ b/service/codepipeline/api_op_PutWebhook.go @@ -64,9 +64,6 @@ func (c *Client) PutWebhook(ctx context.Context, params *PutWebhookInput, optFns type PutWebhookInput struct { - // The tags for the webhook. - Tags []*types.Tag - // The detail provided in an input file to create the webhook, such as the webhook // name, the pipeline name, and the action name. Give the webhook a unique name // that helps you identify it. You might name the webhook after the pipeline and @@ -74,6 +71,9 @@ type PutWebhookInput struct { // // This member is required. Webhook *types.WebhookDefinition + + // The tags for the webhook. + Tags []*types.Tag } type PutWebhookOutput struct { diff --git a/service/codepipeline/api_op_RetryStageExecution.go b/service/codepipeline/api_op_RetryStageExecution.go index 4123b166f9a..97508854c4f 100644 --- a/service/codepipeline/api_op_RetryStageExecution.go +++ b/service/codepipeline/api_op_RetryStageExecution.go @@ -68,10 +68,10 @@ type RetryStageExecutionInput struct { // This member is required. PipelineExecutionId *string - // The name of the failed stage to be retried. + // The name of the pipeline that contains the failed stage. // // This member is required. - StageName *string + PipelineName *string // The scope of the retry attempt. Currently, the only supported value is // FAILED_ACTIONS. @@ -79,10 +79,10 @@ type RetryStageExecutionInput struct { // This member is required. RetryMode types.StageRetryMode - // The name of the pipeline that contains the failed stage. + // The name of the failed stage to be retried. // // This member is required. - PipelineName *string + StageName *string } // Represents the output of a RetryStageExecution action. diff --git a/service/codepipeline/api_op_StopPipelineExecution.go b/service/codepipeline/api_op_StopPipelineExecution.go index a15175efe76..1b067b19172 100644 --- a/service/codepipeline/api_op_StopPipelineExecution.go +++ b/service/codepipeline/api_op_StopPipelineExecution.go @@ -67,16 +67,16 @@ type StopPipelineExecutionInput struct { // This member is required. PipelineExecutionId *string - // Use this option to stop the pipeline execution by abandoning, rather than - // finishing, in-progress actions. This option can lead to failed or - // out-of-sequence tasks. - Abandon *bool - // The name of the pipeline to stop. // // This member is required. PipelineName *string + // Use this option to stop the pipeline execution by abandoning, rather than + // finishing, in-progress actions. This option can lead to failed or + // out-of-sequence tasks. + Abandon *bool + // Use this option to enter comments, such as the reason the pipeline was stopped. Reason *string } diff --git a/service/codepipeline/api_op_TagResource.go b/service/codepipeline/api_op_TagResource.go index 4a4ee9f2604..343946a8099 100644 --- a/service/codepipeline/api_op_TagResource.go +++ b/service/codepipeline/api_op_TagResource.go @@ -58,15 +58,15 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The tags you want to modify or add to the resource. + // The Amazon Resource Name (ARN) of the resource you want to add tags to. // // This member is required. - Tags []*types.Tag + ResourceArn *string - // The Amazon Resource Name (ARN) of the resource you want to add tags to. + // The tags you want to modify or add to the resource. // // This member is required. - ResourceArn *string + Tags []*types.Tag } type TagResourceOutput struct { diff --git a/service/codepipeline/api_op_UntagResource.go b/service/codepipeline/api_op_UntagResource.go index 82134897015..7c9a531a863 100644 --- a/service/codepipeline/api_op_UntagResource.go +++ b/service/codepipeline/api_op_UntagResource.go @@ -56,15 +56,15 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The list of keys for the tags to be removed from the resource. + // The Amazon Resource Name (ARN) of the resource to remove tags from. // // This member is required. - TagKeys []*string + ResourceArn *string - // The Amazon Resource Name (ARN) of the resource to remove tags from. + // The list of keys for the tags to be removed from the resource. // // This member is required. - ResourceArn *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/codepipeline/go.mod b/service/codepipeline/go.mod index 3f2a14f9f1a..06a21cc0ba7 100644 --- a/service/codepipeline/go.mod +++ b/service/codepipeline/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/codepipeline go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/codepipeline/types/types.go b/service/codepipeline/types/types.go index 78508909923..b149290efdc 100644 --- a/service/codepipeline/types/types.go +++ b/service/codepipeline/types/types.go @@ -16,26 +16,6 @@ type ActionConfiguration struct { // Represents information about an action configuration property. type ActionConfigurationProperty struct { - // Indicates that the property is used with PollForJobs. When creating a custom - // action, an action can have up to one queryable property. If it has one, that - // property must be both required and not secret. If you create a pipeline with a - // custom action type, and that custom action contains a queryable property, the - // value for that configuration property is subject to other restrictions. The - // value must be less than or equal to twenty (20) characters. The value can - // contain only alphanumeric characters, underscores, and hyphens. - Queryable *bool - - // The description of the action configuration property that is displayed to users. - Description *string - - // Whether the configuration property is a required value. - // - // This member is required. - Required *bool - - // The type of the configuration property. - Type ActionConfigurationPropertyType - // Whether the configuration property is a key. // // This member is required. @@ -46,6 +26,11 @@ type ActionConfigurationProperty struct { // This member is required. Name *string + // Whether the configuration property is a required value. + // + // This member is required. + Required *bool + // Whether the configuration property is secret. Secrets are hidden from all calls // except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and // PollForThirdPartyJobs. When updating a pipeline, passing * * * * * without @@ -54,6 +39,21 @@ type ActionConfigurationProperty struct { // // This member is required. Secret *bool + + // The description of the action configuration property that is displayed to users. + Description *string + + // Indicates that the property is used with PollForJobs. When creating a custom + // action, an action can have up to one queryable property. If it has one, that + // property must be both required and not secret. If you create a pipeline with a + // custom action type, and that custom action contains a queryable property, the + // value for that configuration property is subject to other restrictions. The + // value must be less than or equal to twenty (20) characters. The value can + // contain only alphanumeric characters, underscores, and hyphens. + Queryable *bool + + // The type of the configuration property. + Type ActionConfigurationPropertyType } // Represents the context of an action in the stage of a pipeline to a job worker. @@ -69,26 +69,15 @@ type ActionContext struct { // Represents information about an action declaration. type ActionDeclaration struct { - // The ARN of the IAM service role that performs the declared action. This is - // assumed through the roleArn for the pipeline. - RoleArn *string - - // The action declaration's name. + // Specifies the action type and the provider of the action. // // This member is required. - Name *string - - // The variable namespace associated with the action. All variables produced as - // output by this action fall under this namespace. - Namespace *string - - // The action declaration's AWS Region, such as us-east-1. - Region *string + ActionTypeId *ActionTypeId - // Specifies the action type and the provider of the action. + // The action declaration's name. // // This member is required. - ActionTypeId *ActionTypeId + Name *string // The action's configuration. These are key-value pairs that specify input values // for an action. For more information, see Action Structure Requirements in @@ -105,46 +94,57 @@ type ActionDeclaration struct { // follows: JSON: "Configuration" : { Key : Value }, Configuration map[string]*string - // The order in which actions are run. - RunOrder *int32 - // The name or ID of the artifact consumed by the action, such as a test or build // artifact. InputArtifacts []*InputArtifact + // The variable namespace associated with the action. All variables produced as + // output by this action fall under this namespace. + Namespace *string + // The name or ID of the result of the action declaration, such as a test or build // artifact. OutputArtifacts []*OutputArtifact + + // The action declaration's AWS Region, such as us-east-1. + Region *string + + // The ARN of the IAM service role that performs the declared action. This is + // assumed through the roleArn for the pipeline. + RoleArn *string + + // The order in which actions are run. + RunOrder *int32 } // Represents information about the run of an action. type ActionExecution struct { + // The details of an error returned by a URL external to AWS. + ErrorDetails *ErrorDetails + + // The external ID of the run of the action. + ExternalExecutionId *string + // The URL of a resource external to AWS that is used when running the action (for // example, an external repository URL). ExternalExecutionUrl *string - // A summary of the run of the action. - Summary *string + // The last status change of the action. + LastStatusChange *time.Time // The ARN of the user who last changed the pipeline. LastUpdatedBy *string - // The last status change of the action. - LastStatusChange *time.Time - // A percentage of completeness of the action as it runs. PercentComplete *int32 - // The details of an error returned by a URL external to AWS. - ErrorDetails *ErrorDetails - // The status of the action, or for a completed action, the last status of the // action. Status ActionExecutionStatus - // The external ID of the run of the action. - ExternalExecutionId *string + // A summary of the run of the action. + Summary *string // The system-generated token used to identify a unique approval request. The token // for each open approval request can be obtained using the GetPipelineState @@ -157,37 +157,37 @@ type ActionExecution struct { // execution ID, and the name, version, and timing of the action. type ActionExecutionDetail struct { - // The pipeline execution ID for the action execution. - PipelineExecutionId *string - - // The start time of the action execution. - StartTime *time.Time + // The action execution ID. + ActionExecutionId *string - // The last update time of the action execution. - LastUpdateTime *time.Time + // The name of the action. + ActionName *string // Input details for the action execution, such as role ARN, Region, and input // artifacts. Input *ActionExecutionInput - // The version of the pipeline where the action was run. - PipelineVersion *int32 + // The last update time of the action execution. + LastUpdateTime *time.Time - // The status of the action execution. Status categories are InProgress, Succeeded, - // and Failed. - Status ActionExecutionStatus + // Output details for the action execution, such as the action execution result. + Output *ActionExecutionOutput - // The name of the action. - ActionName *string + // The pipeline execution ID for the action execution. + PipelineExecutionId *string - // The action execution ID. - ActionExecutionId *string + // The version of the pipeline where the action was run. + PipelineVersion *int32 // The name of the stage that contains the action. StageName *string - // Output details for the action execution, such as the action execution result. - Output *ActionExecutionOutput + // The start time of the action execution. + StartTime *time.Time + + // The status of the action execution. Status categories are InProgress, Succeeded, + // and Failed. + Status ActionExecutionStatus } // Filter values for the action execution. @@ -200,30 +200,30 @@ type ActionExecutionFilter struct { // Input information used for an action execution. type ActionExecutionInput struct { - // Configuration data for an action execution with all variable references replaced - // with their real values for the execution. - ResolvedConfiguration map[string]*string - // Represents information about an action type. ActionTypeId *ActionTypeId - // The ARN of the IAM service role that performs the declared action. This is - // assumed through the roleArn for the pipeline. - RoleArn *string - - // The AWS Region for the action, such as us-east-1. - Region *string - // Configuration data for an action execution. Configuration map[string]*string + // Details of input artifacts of the action that correspond to the action + // execution. + InputArtifacts []*ArtifactDetail + // The variable namespace associated with the action. All variables produced as // output by this action fall under this namespace. Namespace *string - // Details of input artifacts of the action that correspond to the action - // execution. - InputArtifacts []*ArtifactDetail + // The AWS Region for the action, such as us-east-1. + Region *string + + // Configuration data for an action execution with all variable references replaced + // with their real values for the execution. + ResolvedConfiguration map[string]*string + + // The ARN of the IAM service role that performs the declared action. This is + // assumed through the roleArn for the pipeline. + RoleArn *string } // Output details listed for an action execution, such as the action execution @@ -234,37 +234,37 @@ type ActionExecutionOutput struct { // execution. ExecutionResult *ActionExecutionResult - // The outputVariables field shows the key-value pairs that were output as part of - // that execution. - OutputVariables map[string]*string - // Details of output artifacts of the action that correspond to the action // execution. OutputArtifacts []*ArtifactDetail + + // The outputVariables field shows the key-value pairs that were output as part of + // that execution. + OutputVariables map[string]*string } // Execution result information, such as the external execution ID. type ActionExecutionResult struct { + // The action provider's external ID for the action execution. + ExternalExecutionId *string + // The action provider's summary for the action execution. ExternalExecutionSummary *string // The deepest external link to the external resource (for example, a repository // URL or deployment endpoint) that is used when running the action. ExternalExecutionUrl *string - - // The action provider's external ID for the action execution. - ExternalExecutionId *string } // Represents information about the version (or revision) of an action. type ActionRevision struct { - // The system-generated unique ID that identifies the revision number of the - // action. + // The date and time when the most recent version of the action was created, in + // timestamp format. // // This member is required. - RevisionId *string + Created *time.Time // The unique identifier of the change that set the state to this revision (for // example, a deployment ID or timestamp). @@ -272,21 +272,25 @@ type ActionRevision struct { // This member is required. RevisionChangeId *string - // The date and time when the most recent version of the action was created, in - // timestamp format. + // The system-generated unique ID that identifies the revision number of the + // action. // // This member is required. - Created *time.Time + RevisionId *string } // Represents information about the state of an action. type ActionState struct { + // The name of the action. + ActionName *string + // Represents information about the version (or revision) of an action. CurrentRevision *ActionRevision - // The name of the action. - ActionName *string + // A URL link for more information about the state of the action, such as a + // deployment group details page. + EntityUrl *string // Represents information about the run of an action. LatestExecution *ActionExecution @@ -294,35 +298,31 @@ type ActionState struct { // A URL link for more information about the revision, such as a commit details // page. RevisionUrl *string - - // A URL link for more information about the state of the action, such as a - // deployment group details page. - EntityUrl *string } // Returns information about the details of an action type. type ActionType struct { - // The settings for the action type. - Settings *ActionTypeSettings - // Represents information about an action type. // // This member is required. Id *ActionTypeId - // The details of the output artifact of the action, such as its commit ID. + // The details of the input artifact for the action, such as its commit ID. // // This member is required. - OutputArtifactDetails *ArtifactDetails + InputArtifactDetails *ArtifactDetails - // The details of the input artifact for the action, such as its commit ID. + // The details of the output artifact of the action, such as its commit ID. // // This member is required. - InputArtifactDetails *ArtifactDetails + OutputArtifactDetails *ArtifactDetails // The configuration properties for the action type. ActionConfigurationProperties []*ActionConfigurationProperty + + // The settings for the action type. + Settings *ActionTypeSettings } // Represents information about an action type. @@ -335,11 +335,6 @@ type ActionTypeId struct { // This member is required. Category ActionCategory - // A string that describes the action version. - // - // This member is required. - Version *string - // The creator of the action being called. // // This member is required. @@ -354,15 +349,16 @@ type ActionTypeId struct { // // This member is required. Provider *string + + // A string that describes the action version. + // + // This member is required. + Version *string } // Returns information about the settings for an action type. type ActionTypeSettings struct { - // The URL of a sign-up page where users can sign up for an external service and - // perform initial configuration of the action provided by that service. - ThirdPartyConfigurationUrl *string - // The URL returned to the AWS CodePipeline console that provides a deep link to // the resources of the external system, such as the configuration page for an AWS // CodeDeploy deployment group. This link is provided as part of the action display @@ -379,45 +375,49 @@ type ActionTypeSettings struct { // page where customers can update or change the configuration of the external // action. RevisionUrlTemplate *string + + // The URL of a sign-up page where users can sign up for an external service and + // perform initial configuration of the action provided by that service. + ThirdPartyConfigurationUrl *string } // Represents information about the result of an approval request. type ApprovalResult struct { - // The summary of the current status of the approval request. + // The response submitted by a reviewer assigned to an approval action request. // // This member is required. - Summary *string + Status ApprovalStatus - // The response submitted by a reviewer assigned to an approval action request. + // The summary of the current status of the approval request. // // This member is required. - Status ApprovalStatus + Summary *string } // Represents information about an artifact that is worked on by actions in the // pipeline. type Artifact struct { - // The artifact's revision ID. Depending on the type of object, this could be a - // commit ID (GitHub) or a revision ID (Amazon S3). - Revision *string + // The location of an artifact. + Location *ArtifactLocation // The artifact's name. Name *string - // The location of an artifact. - Location *ArtifactLocation + // The artifact's revision ID. Depending on the type of object, this could be a + // commit ID (GitHub) or a revision ID (Amazon S3). + Revision *string } // Artifact details for the action execution, such as the artifact location. type ArtifactDetail struct { - // The Amazon S3 artifact location for the action execution. - S3location *S3Location - // The artifact object name for the action execution. Name *string + + // The Amazon S3 artifact location for the action execution. + S3location *S3Location } // Returns information about the details of an artifact. @@ -437,24 +437,28 @@ type ArtifactDetails struct { // Represents information about the location of an artifact. type ArtifactLocation struct { - // The type of artifact in the location. - Type ArtifactLocationType - // The S3 bucket that contains the artifact. S3Location *S3ArtifactLocation + + // The type of artifact in the location. + Type ArtifactLocationType } // Represents revision details of an artifact. type ArtifactRevision struct { - // An additional identifier for a revision, such as a commit date or, for artifacts - // stored in Amazon S3 buckets, the ETag value. - RevisionChangeIdentifier *string + // The date and time when the most recent revision of the artifact was created, in + // timestamp format. + Created *time.Time // The name of an artifact. This name might be system-generated, such as "MyApp", // or defined by the user when an action is created. Name *string + // An additional identifier for a revision, such as a commit date or, for artifacts + // stored in Amazon S3 buckets, the ETag value. + RevisionChangeIdentifier *string + // The revision ID of the artifact. RevisionId *string @@ -464,10 +468,6 @@ type ArtifactRevision struct { // key specified in the object metadata. RevisionSummary *string - // The date and time when the most recent revision of the artifact was created, in - // timestamp format. - Created *time.Time - // The commit ID for the artifact revision. For artifacts stored in GitHub or AWS // CodeCommit repositories, the commit ID is linked to a commit details page. RevisionUrl *string @@ -479,6 +479,15 @@ type ArtifactRevision struct { // artifactStores. type ArtifactStore struct { + // The S3 bucket used for storing the artifacts for a pipeline. You can specify the + // name of an S3 bucket but not a folder in the bucket. A folder to contain the + // pipeline artifacts is created for you based on the name of the pipeline. You can + // use any S3 bucket in the same AWS Region as the pipeline to store your pipeline + // artifacts. + // + // This member is required. + Location *string + // The type of the artifact store, such as S3. // // This member is required. @@ -488,15 +497,6 @@ type ArtifactStore struct { // AWS Key Management Service (AWS KMS) key. If this is undefined, the default key // for Amazon S3 is used. EncryptionKey *EncryptionKey - - // The S3 bucket used for storing the artifacts for a pipeline. You can specify the - // name of an S3 bucket but not a folder in the bucket. A folder to contain the - // pipeline artifacts is created for you based on the name of the pipeline. You can - // use any S3 bucket in the same AWS Region as the pipeline to store your pipeline - // artifacts. - // - // This member is required. - Location *string } // Represents an AWS session credentials object. These credentials are temporary @@ -505,11 +505,6 @@ type ArtifactStore struct { // the pipeline in AWS CodePipeline. type AWSSessionCredentials struct { - // The token for the session. - // - // This member is required. - SessionToken *string - // The access key for the session. // // This member is required. @@ -519,6 +514,11 @@ type AWSSessionCredentials struct { // // This member is required. SecretAccessKey *string + + // The token for the session. + // + // This member is required. + SessionToken *string } // Reserved for future use. @@ -538,13 +538,6 @@ type BlockerDeclaration struct { // Represents information about a current revision. type CurrentRevision struct { - // The summary of the most recent revision of the artifact. - RevisionSummary *string - - // The date and time when the most recent revision of the artifact was created, in - // timestamp format. - Created *time.Time - // The change identifier for the current revision. // // This member is required. @@ -554,18 +547,19 @@ type CurrentRevision struct { // // This member is required. Revision *string + + // The date and time when the most recent revision of the artifact was created, in + // timestamp format. + Created *time.Time + + // The summary of the most recent revision of the artifact. + RevisionSummary *string } // Represents information about the key used to encrypt data in the artifact store, // such as an AWS Key Management Service (AWS KMS) key. type EncryptionKey struct { - // The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. - // When creating or updating a pipeline, the value must be set to 'KMS'. - // - // This member is required. - Type EncryptionKeyType - // The ID used to identify the key. For an AWS KMS key, you can use the key ID, the // key ARN, or the alias ARN. Aliases are recognized only in the account that // created the customer master key (CMK). For cross-account actions, you can only @@ -573,25 +567,28 @@ type EncryptionKey struct { // // This member is required. Id *string + + // The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. + // When creating or updating a pipeline, the value must be set to 'KMS'. + // + // This member is required. + Type EncryptionKeyType } // Represents information about an error in AWS CodePipeline. type ErrorDetails struct { - // The text of the error message. - Message *string - // The system ID or number code of the error. Code *string + + // The text of the error message. + Message *string } // The details of the actions taken and results produced on an artifact as it // passes through stages in the pipeline. type ExecutionDetails struct { - // The summary of the current status of the actions. - Summary *string - // The system-generated unique ID of this action used to identify this job worker // in any external systems, such as AWS CodeDeploy. ExternalExecutionId *string @@ -599,27 +596,27 @@ type ExecutionDetails struct { // The percentage of work completed on the action, represented on a scale of 0 to // 100 percent. PercentComplete *int32 + + // The summary of the current status of the actions. + Summary *string } // The interaction or event that started a pipeline execution. type ExecutionTrigger struct { - // The type of change-detection method, command, or user interaction that started a - // pipeline execution. - TriggerType TriggerType - // Detail related to the event that started a pipeline execution, such as the // webhook ARN of the webhook that triggered the pipeline execution or the user ARN // for a user-initiated start-pipeline-execution CLI command. TriggerDetail *string + + // The type of change-detection method, command, or user interaction that started a + // pipeline execution. + TriggerType TriggerType } // Represents information about failure details. type FailureDetails struct { - // The external ID of the run of the action that failed. - ExternalExecutionId *string - // The message about the failure. // // This member is required. @@ -629,6 +626,9 @@ type FailureDetails struct { // // This member is required. Type FailureType + + // The external ID of the run of the action that failed. + ExternalExecutionId *string } // Represents information about an artifact to be worked on, such as a test or @@ -652,25 +652,27 @@ type Job struct { // The ID of the AWS account to use when performing the job. AccountId *string - // A system-generated random number that AWS CodePipeline uses to ensure that the - // job is being worked on by only one job worker. Use this number in an - // AcknowledgeJob () request. - Nonce *string + // Other data about a job. + Data *JobData // The unique system-generated ID of the job. Id *string - // Other data about a job. - Data *JobData + // A system-generated random number that AWS CodePipeline uses to ensure that the + // job is being worked on by only one job worker. Use this number in an + // AcknowledgeJob () request. + Nonce *string } // Represents other information about a job required for a job worker to complete // the job. type JobData struct { - // Represents information about a pipeline to a job worker. Includes pipelineArn - // and pipelineExecutionId for custom jobs. - PipelineContext *PipelineContext + // Represents information about an action configuration. + ActionConfiguration *ActionConfiguration + + // Represents information about an action type. + ActionTypeId *ActionTypeId // Represents an AWS session credentials object. These credentials are temporary // credentials that are issued by AWS Secure Token Service (STS). They can be used @@ -686,40 +688,40 @@ type JobData struct { // such as an AWS Key Management Service (AWS KMS) key. EncryptionKey *EncryptionKey - // Represents information about an action configuration. - ActionConfiguration *ActionConfiguration - - // Represents information about an action type. - ActionTypeId *ActionTypeId - // The artifact supplied to the job. InputArtifacts []*Artifact // The output of the job. OutputArtifacts []*Artifact + + // Represents information about a pipeline to a job worker. Includes pipelineArn + // and pipelineExecutionId for custom jobs. + PipelineContext *PipelineContext } // Represents information about the details of a job. type JobDetails struct { + // The AWS account ID associated with the job. + AccountId *string + // Represents other information about a job required for a job worker to complete // the job. Data *JobData // The unique system-generated ID of the job. Id *string - - // The AWS account ID associated with the job. - AccountId *string } // The detail returned for each webhook after listing webhooks, such as the webhook // URL, the webhook name, and the webhook ARN. type ListWebhookItem struct { - // The date and time a webhook was last successfully triggered, in timestamp - // format. - LastTriggered *time.Time + // The detail returned for each webhook, such as the webhook authentication type + // and filter rules. + // + // This member is required. + Definition *WebhookDefinition // A unique URL generated by CodePipeline. When a POST request is made to this URL, // the defined pipeline is started as long as the body of the post request @@ -729,23 +731,21 @@ type ListWebhookItem struct { // This member is required. Url *string - // The text of the error message about the webhook. - ErrorMessage *string + // The Amazon Resource Name (ARN) of the webhook. + Arn *string // The number code of the error. ErrorCode *string - // Specifies the tags applied to the webhook. - Tags []*Tag + // The text of the error message about the webhook. + ErrorMessage *string - // The Amazon Resource Name (ARN) of the webhook. - Arn *string + // The date and time a webhook was last successfully triggered, in timestamp + // format. + LastTriggered *time.Time - // The detail returned for each webhook, such as the webhook authentication type - // and filter rules. - // - // This member is required. - Definition *WebhookDefinition + // Specifies the tags applied to the webhook. + Tags []*Tag } // Represents information about the output of an action. @@ -790,24 +790,8 @@ type PipelineDeclaration struct { // The name of the action to be performed. // - // This member is required. - Name *string - - // A mapping of artifactStore objects and their corresponding AWS Regions. There - // must be an artifact store for the pipeline Region and for each cross-region - // action in the pipeline. You must include either artifactStore or artifactStores - // in your pipeline, but you cannot use both. If you create a cross-region action - // in your pipeline, you must use artifactStores. - ArtifactStores map[string]*ArtifactStore - - // The stage in which to perform the action. - // - // This member is required. - Stages []*StageDeclaration - - // The version number of the pipeline. A new pipeline always has a version number - // of 1. This number is incremented when a pipeline is updated. - Version *int32 + // This member is required. + Name *string // The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform // actions with no actionRoleArn, or to use to assume roles for actions with an @@ -816,22 +800,44 @@ type PipelineDeclaration struct { // This member is required. RoleArn *string + // The stage in which to perform the action. + // + // This member is required. + Stages []*StageDeclaration + // Represents information about the S3 bucket where artifacts are stored for the // pipeline. You must include either artifactStore or artifactStores in your // pipeline, but you cannot use both. If you create a cross-region action in your // pipeline, you must use artifactStores. ArtifactStore *ArtifactStore + + // A mapping of artifactStore objects and their corresponding AWS Regions. There + // must be an artifact store for the pipeline Region and for each cross-region + // action in the pipeline. You must include either artifactStore or artifactStores + // in your pipeline, but you cannot use both. If you create a cross-region action + // in your pipeline, you must use artifactStores. + ArtifactStores map[string]*ArtifactStore + + // The version number of the pipeline. A new pipeline always has a version number + // of 1. This number is incremented when a pipeline is updated. + Version *int32 } // Represents information about an execution of a pipeline. type PipelineExecution struct { - // The version number of the pipeline with the specified pipeline execution. - PipelineVersion *int32 + // A list of ArtifactRevision objects included in a pipeline execution. + ArtifactRevisions []*ArtifactRevision + + // The ID of the pipeline execution. + PipelineExecutionId *string // The name of the pipeline with the specified pipeline execution. PipelineName *string + // The version number of the pipeline with the specified pipeline execution. + PipelineVersion *int32 + // The status of the pipeline execution. // // * InProgress: The pipeline execution @@ -859,24 +865,11 @@ type PipelineExecution struct { // // * Failed: The pipeline execution was not completed successfully. Status PipelineExecutionStatus - - // A list of ArtifactRevision objects included in a pipeline execution. - ArtifactRevisions []*ArtifactRevision - - // The ID of the pipeline execution. - PipelineExecutionId *string } // Summary information about a pipeline execution. type PipelineExecutionSummary struct { - // The interaction or event that started a pipeline execution, such as automated - // change detection or a StartPipelineExecution API call. - Trigger *ExecutionTrigger - - // The date and time when the pipeline execution began, in timestamp format. - StartTime *time.Time - // The date and time of the last change to the pipeline execution, in timestamp // format. LastUpdateTime *time.Time @@ -884,12 +877,12 @@ type PipelineExecutionSummary struct { // The ID of the pipeline execution. PipelineExecutionId *string - // The interaction that stopped a pipeline execution. - StopTrigger *StopExecutionTrigger - // A list of the source artifact revisions that initiated a pipeline execution. SourceRevisions []*SourceRevision + // The date and time when the pipeline execution began, in timestamp format. + StartTime *time.Time + // The status of the pipeline execution. // // * InProgress: The pipeline execution @@ -917,66 +910,82 @@ type PipelineExecutionSummary struct { // // * Failed: The pipeline execution was not completed successfully. Status PipelineExecutionStatus + + // The interaction that stopped a pipeline execution. + StopTrigger *StopExecutionTrigger + + // The interaction or event that started a pipeline execution, such as automated + // change detection or a StartPipelineExecution API call. + Trigger *ExecutionTrigger } // Information about a pipeline. type PipelineMetadata struct { + // The date and time the pipeline was created, in timestamp format. + Created *time.Time + // The Amazon Resource Name (ARN) of the pipeline. PipelineArn *string // The date and time the pipeline was last updated, in timestamp format. Updated *time.Time - - // The date and time the pipeline was created, in timestamp format. - Created *time.Time } // Returns a summary of a pipeline. type PipelineSummary struct { - // The date and time of the last update to the pipeline, in timestamp format. - Updated *time.Time + // The date and time the pipeline was created, in timestamp format. + Created *time.Time // The name of the pipeline. Name *string + // The date and time of the last update to the pipeline, in timestamp format. + Updated *time.Time + // The version number of the pipeline. Version *int32 - - // The date and time the pipeline was created, in timestamp format. - Created *time.Time } // The location of the S3 bucket that contains a revision. type S3ArtifactLocation struct { - // The key of the object in the S3 bucket, which uniquely identifies the object in - // the bucket. + // The name of the S3 bucket. // // This member is required. - ObjectKey *string + BucketName *string - // The name of the S3 bucket. + // The key of the object in the S3 bucket, which uniquely identifies the object in + // the bucket. // // This member is required. - BucketName *string + ObjectKey *string } // The Amazon S3 artifact location for an action's artifacts. type S3Location struct { - // The artifact name. - Key *string - // The Amazon S3 artifact bucket for an action's artifacts. Bucket *string + + // The artifact name. + Key *string } // Information about the version (or revision) of a source artifact that initiated // a pipeline execution. type SourceRevision struct { + // The name of the action that processed the revision to the source artifact. + // + // This member is required. + ActionName *string + + // The system-generated unique ID that identifies the revision number of the + // artifact. + RevisionId *string + // Summary information about the most recent revision of the artifact. For GitHub // and AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or // actions, the user-provided content of a codepipeline-artifact-revision-summary @@ -986,15 +995,6 @@ type SourceRevision struct { // The commit ID for the artifact revision. For artifacts stored in GitHub or AWS // CodeCommit repositories, the commit ID is linked to a commit details page. RevisionUrl *string - - // The system-generated unique ID that identifies the revision number of the - // artifact. - RevisionId *string - - // The name of the action that processed the revision to the source artifact. - // - // This member is required. - ActionName *string } // Represents information about a stage to a job worker. @@ -1007,32 +1007,32 @@ type StageContext struct { // Represents information about a stage and its definition. type StageDeclaration struct { - // Reserved for future use. - Blockers []*BlockerDeclaration + // The actions included in a stage. + // + // This member is required. + Actions []*ActionDeclaration // The name of the stage. // // This member is required. Name *string - // The actions included in a stage. - // - // This member is required. - Actions []*ActionDeclaration + // Reserved for future use. + Blockers []*BlockerDeclaration } // Represents information about the run of a stage. type StageExecution struct { - // The status of the stage, or for a completed stage, the last status of the stage. + // The ID of the pipeline execution associated with the stage. // // This member is required. - Status StageExecutionStatus + PipelineExecutionId *string - // The ID of the pipeline execution associated with the stage. + // The status of the stage, or for a completed stage, the last status of the stage. // // This member is required. - PipelineExecutionId *string + Status StageExecutionStatus } // Represents information about the state of the stage. @@ -1041,15 +1041,15 @@ type StageState struct { // The state of the stage. ActionStates []*ActionState - // The name of the stage. - StageName *string - // The state of the inbound transition, which is either enabled or disabled. InboundTransitionState *TransitionState // Information about the latest execution in the stage, including its ID and // status. LatestExecution *StageExecution + + // The name of the stage. + StageName *string } // The interaction that stopped a pipeline execution. @@ -1062,35 +1062,37 @@ type StopExecutionTrigger struct { // A tag is a key-value pair that is used to manage the resource. type Tag struct { - // The tag's value. + // The tag's key. // // This member is required. - Value *string + Key *string - // The tag's key. + // The tag's value. // // This member is required. - Key *string + Value *string } // A response to a PollForThirdPartyJobs request returned by AWS CodePipeline when // there is a job to be worked on by a partner action. type ThirdPartyJob struct { - // The identifier used to identify the job in AWS CodePipeline. - JobId *string - // The clientToken portion of the clientId and clientToken pair used to verify that // the calling entity is allowed access to the job and its details. ClientId *string + + // The identifier used to identify the job in AWS CodePipeline. + JobId *string } // Represents information about the job data for a partner action. type ThirdPartyJobData struct { - // A system-generated token, such as a AWS CodeDeploy deployment ID, that a job - // requires to continue the job asynchronously. - ContinuationToken *string + // Represents information about an action configuration. + ActionConfiguration *ActionConfiguration + + // Represents information about an action type. + ActionTypeId *ActionTypeId // Represents an AWS session credentials object. These credentials are temporary // credentials that are issued by AWS Secure Token Service (STS). They can be used @@ -1098,94 +1100,81 @@ type ThirdPartyJobData struct { // the pipeline in AWS CodePipeline. ArtifactCredentials *AWSSessionCredentials - // Represents information about an action configuration. - ActionConfiguration *ActionConfiguration - - // The name of the artifact that is the result of the action, if any. This name - // might be system-generated, such as "MyBuiltApp", or it might be defined by the - // user when the action is created. - OutputArtifacts []*Artifact + // A system-generated token, such as a AWS CodeDeploy deployment ID, that a job + // requires to continue the job asynchronously. + ContinuationToken *string // The encryption key used to encrypt and decrypt data in the artifact store for // the pipeline, such as an AWS Key Management Service (AWS KMS) key. This is // optional and might not be present. EncryptionKey *EncryptionKey - // Represents information about a pipeline to a job worker. Does not include - // pipelineArn and pipelineExecutionId for ThirdParty jobs. - PipelineContext *PipelineContext - - // Represents information about an action type. - ActionTypeId *ActionTypeId - // The name of the artifact that is worked on by the action, if any. This name // might be system-generated, such as "MyApp", or it might be defined by the user // when the action is created. The input artifact name must match the name of an // output artifact generated by an action in an earlier action or stage of the // pipeline. InputArtifacts []*Artifact + + // The name of the artifact that is the result of the action, if any. This name + // might be system-generated, such as "MyBuiltApp", or it might be defined by the + // user when the action is created. + OutputArtifacts []*Artifact + + // Represents information about a pipeline to a job worker. Does not include + // pipelineArn and pipelineExecutionId for ThirdParty jobs. + PipelineContext *PipelineContext } // The details of a job sent in response to a GetThirdPartyJobDetails request. type ThirdPartyJobDetails struct { - // A system-generated random number that AWS CodePipeline uses to ensure that the - // job is being worked on by only one job worker. Use this number in an - // AcknowledgeThirdPartyJob () request. - Nonce *string + // The data to be returned by the third party job worker. + Data *ThirdPartyJobData // The identifier used to identify the job details in AWS CodePipeline. Id *string - // The data to be returned by the third party job worker. - Data *ThirdPartyJobData + // A system-generated random number that AWS CodePipeline uses to ensure that the + // job is being worked on by only one job worker. Use this number in an + // AcknowledgeThirdPartyJob () request. + Nonce *string } // Represents information about the state of transitions between one stage and // another stage. type TransitionState struct { - // The timestamp when the transition state was last changed. - LastChangedAt *time.Time - - // The ID of the user who last changed the transition state. - LastChangedBy *string - // The user-specified reason why the transition between two stages of a pipeline // was disabled. DisabledReason *string // Whether the transition between stages is enabled (true) or disabled (false). Enabled *bool + + // The timestamp when the transition state was last changed. + LastChangedAt *time.Time + + // The ID of the user who last changed the transition state. + LastChangedBy *string } // The authentication applied to incoming webhook trigger requests. type WebhookAuthConfiguration struct { - // The property used to configure GitHub authentication. For GITHUB_HMAC, only the - // SecretToken property must be set. - SecretToken *string - // The property used to configure acceptance of webhooks in an IP address range. // For IP, only the AllowedIPRange property must be set. This property must be set // to a valid CIDR range. AllowedIPRange *string + + // The property used to configure GitHub authentication. For GITHUB_HMAC, only the + // SecretToken property must be set. + SecretToken *string } // Represents information about a webhook and its definition. type WebhookDefinition struct { - // The name of the action in a pipeline you want to connect to the webhook. The - // action must be from the source (first) stage of the pipeline. - // - // This member is required. - TargetAction *string - - // The name of the pipeline you want to connect to the webhook. - // - // This member is required. - TargetPipeline *string - // Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED. // // * For @@ -1212,22 +1201,41 @@ type WebhookDefinition struct { // This member is required. AuthenticationConfiguration *WebhookAuthConfiguration + // A list of rules applied to the body/payload sent in the POST request to a + // webhook URL. All defined rules must pass for the request to be accepted and the + // pipeline started. + // + // This member is required. + Filters []*WebhookFilterRule + // The name of the webhook. // // This member is required. Name *string - // A list of rules applied to the body/payload sent in the POST request to a - // webhook URL. All defined rules must pass for the request to be accepted and the - // pipeline started. + // The name of the action in a pipeline you want to connect to the webhook. The + // action must be from the source (first) stage of the pipeline. // // This member is required. - Filters []*WebhookFilterRule + TargetAction *string + + // The name of the pipeline you want to connect to the webhook. + // + // This member is required. + TargetPipeline *string } // The event criteria that specify when a webhook notification is sent to your URL. type WebhookFilterRule struct { + // A JsonPath expression that is applied to the body/payload of the webhook. The + // value selected by the JsonPath expression must match the value specified in the + // MatchEquals field. Otherwise, the request is ignored. For more information, see + // Java JsonPath implementation (https://github.com/json-path/JsonPath) in GitHub. + // + // This member is required. + JsonPath *string + // The value selected by the JsonPath expression must match what is supplied in the // MatchEquals field. Otherwise, the request is ignored. Properties from the target // action configuration can be included as placeholders in this value by @@ -1239,12 +1247,4 @@ type WebhookFilterRule struct { // Reference Action Requirements // (https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements). MatchEquals *string - - // A JsonPath expression that is applied to the body/payload of the webhook. The - // value selected by the JsonPath expression must match the value specified in the - // MatchEquals field. Otherwise, the request is ignored. For more information, see - // Java JsonPath implementation (https://github.com/json-path/JsonPath) in GitHub. - // - // This member is required. - JsonPath *string } diff --git a/service/codestar/api_op_AssociateTeamMember.go b/service/codestar/api_op_AssociateTeamMember.go index 86b1c500f26..623a4b65822 100644 --- a/service/codestar/api_op_AssociateTeamMember.go +++ b/service/codestar/api_op_AssociateTeamMember.go @@ -56,14 +56,10 @@ func (c *Client) AssociateTeamMember(ctx context.Context, params *AssociateTeamM type AssociateTeamMemberInput struct { - // Whether the team member is allowed to use an SSH public/private key pair to - // remotely access project resources, for example Amazon EC2 instances. - RemoteAccessAllowed *bool - - // A user- or system-generated token that identifies the entity that requested the - // team member association to the project. This token can be used to repeat the - // request. - ClientRequestToken *string + // The ID of the project to which you will add the IAM user. + // + // This member is required. + ProjectId *string // The AWS CodeStar project role that will apply to this user. This role determines // what actions a user can take in an AWS CodeStar project. @@ -77,10 +73,14 @@ type AssociateTeamMemberInput struct { // This member is required. UserArn *string - // The ID of the project to which you will add the IAM user. - // - // This member is required. - ProjectId *string + // A user- or system-generated token that identifies the entity that requested the + // team member association to the project. This token can be used to repeat the + // request. + ClientRequestToken *string + + // Whether the team member is allowed to use an SSH public/private key pair to + // remotely access project resources, for example Amazon EC2 instances. + RemoteAccessAllowed *bool } type AssociateTeamMemberOutput struct { diff --git a/service/codestar/api_op_CreateProject.go b/service/codestar/api_op_CreateProject.go index 1e508cdee9f..12cf176de27 100644 --- a/service/codestar/api_op_CreateProject.go +++ b/service/codestar/api_op_CreateProject.go @@ -60,55 +60,55 @@ func (c *Client) CreateProject(ctx context.Context, params *CreateProjectInput, type CreateProjectInput struct { - // The description of the project, if any. - Description *string + // The ID of the project to be created in AWS CodeStar. + // + // This member is required. + Id *string // The display name for the project to be created in AWS CodeStar. // // This member is required. Name *string - // The tags created for the project. - Tags map[string]*string + // A user- or system-generated token that identifies the entity that requested + // project creation. This token can be used to repeat the request. + ClientRequestToken *string + + // The description of the project, if any. + Description *string // A list of the Code objects submitted with the project request. If this parameter // is specified, the request must also include the toolchain parameter. SourceCode []*types.Code + // The tags created for the project. + Tags map[string]*string + // The name of the toolchain template file submitted with the project request. If // this parameter is specified, the request must also include the sourceCode // parameter. Toolchain *types.Toolchain - - // The ID of the project to be created in AWS CodeStar. - // - // This member is required. - Id *string - - // A user- or system-generated token that identifies the entity that requested - // project creation. This token can be used to repeat the request. - ClientRequestToken *string } type CreateProjectOutput struct { - // The ID of the project. - // - // This member is required. - Id *string - // The Amazon Resource Name (ARN) of the created project. // // This member is required. Arn *string - // Reserved for future use. - ProjectTemplateId *string + // The ID of the project. + // + // This member is required. + Id *string // A user- or system-generated token that identifies the entity that requested // project creation. ClientRequestToken *string + // Reserved for future use. + ProjectTemplateId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codestar/api_op_CreateUserProfile.go b/service/codestar/api_op_CreateUserProfile.go index b62d8d00d9f..cb0ba813565 100644 --- a/service/codestar/api_op_CreateUserProfile.go +++ b/service/codestar/api_op_CreateUserProfile.go @@ -72,15 +72,15 @@ type CreateUserProfileInput struct { // This member is required. EmailAddress *string - // The SSH public key associated with the user in AWS CodeStar. If a project owner - // allows the user remote access to project resources, this public key will be used - // along with the user's private key for SSH access. - SshPublicKey *string - // The Amazon Resource Name (ARN) of the user in IAM. // // This member is required. UserArn *string + + // The SSH public key associated with the user in AWS CodeStar. If a project owner + // allows the user remote access to project resources, this public key will be used + // along with the user's private key for SSH access. + SshPublicKey *string } type CreateUserProfileOutput struct { @@ -93,15 +93,15 @@ type CreateUserProfileOutput struct { // The date the user profile was created, in timestamp format. CreatedTimestamp *time.Time - // The date the user profile was last modified, in timestamp format. - LastModifiedTimestamp *time.Time + // The name that is displayed as the friendly name for the user in AWS CodeStar. + DisplayName *string // The email address that is displayed as part of the user's profile in AWS // CodeStar. EmailAddress *string - // The name that is displayed as the friendly name for the user in AWS CodeStar. - DisplayName *string + // The date the user profile was last modified, in timestamp format. + LastModifiedTimestamp *time.Time // The SSH public key associated with the user in AWS CodeStar. This is the public // portion of the public/private keypair the user can use to access project diff --git a/service/codestar/api_op_DeleteProject.go b/service/codestar/api_op_DeleteProject.go index d4cd6d788ff..fe6a1cdf837 100644 --- a/service/codestar/api_op_DeleteProject.go +++ b/service/codestar/api_op_DeleteProject.go @@ -58,12 +58,6 @@ func (c *Client) DeleteProject(ctx context.Context, params *DeleteProjectInput, type DeleteProjectInput struct { - // Whether to send a delete request for the primary stack in AWS CloudFormation - // originally used to generate the project and its resources. This option will - // delete all AWS resources for the project (except for any buckets in Amazon S3) - // as well as deleting the project itself. Recommended for most use cases. - DeleteStack *bool - // The ID of the project to be deleted in AWS CodeStar. // // This member is required. @@ -72,17 +66,23 @@ type DeleteProjectInput struct { // A user- or system-generated token that identifies the entity that requested // project deletion. This token can be used to repeat the request. ClientRequestToken *string + + // Whether to send a delete request for the primary stack in AWS CloudFormation + // originally used to generate the project and its resources. This option will + // delete all AWS resources for the project (except for any buckets in Amazon S3) + // as well as deleting the project itself. Recommended for most use cases. + DeleteStack *bool } type DeleteProjectOutput struct { + // The Amazon Resource Name (ARN) of the deleted project. + ProjectArn *string + // The ID of the primary stack in AWS CloudFormation that will be deleted as part // of deleting the project and its resources. StackId *string - // The Amazon Resource Name (ARN) of the deleted project. - ProjectArn *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codestar/api_op_DescribeProject.go b/service/codestar/api_op_DescribeProject.go index e88fef29c92..4fd230118b9 100644 --- a/service/codestar/api_op_DescribeProject.go +++ b/service/codestar/api_op_DescribeProject.go @@ -66,35 +66,35 @@ type DescribeProjectInput struct { type DescribeProjectOutput struct { - // The description of the project, if any. - Description *string + // The Amazon Resource Name (ARN) for the project. + Arn *string + + // A user- or system-generated token that identifies the entity that requested + // project creation. + ClientRequestToken *string // The date and time the project was created, in timestamp format. CreatedTimeStamp *time.Time - // The display name for the project. - Name *string + // The description of the project, if any. + Description *string - // The Amazon Resource Name (ARN) for the project. - Arn *string + // The ID of the project. + Id *string - // The project creation or deletion status. - Status *types.ProjectStatus + // The display name for the project. + Name *string // The ID for the AWS CodeStar project template used to create the project. ProjectTemplateId *string - // The ID of the project. - Id *string - - // A user- or system-generated token that identifies the entity that requested - // project creation. - ClientRequestToken *string - // The ID of the primary stack in AWS CloudFormation used to generate resources for // the project. StackId *string + // The project creation or deletion status. + Status *types.ProjectStatus + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codestar/api_op_DescribeUserProfile.go b/service/codestar/api_op_DescribeUserProfile.go index e75ca771f80..62080f5fb49 100644 --- a/service/codestar/api_op_DescribeUserProfile.go +++ b/service/codestar/api_op_DescribeUserProfile.go @@ -71,6 +71,16 @@ type DescribeUserProfileOutput struct { // This member is required. CreatedTimestamp *time.Time + // The date and time when the user profile was last modified, in timestamp format. + // + // This member is required. + LastModifiedTimestamp *time.Time + + // The Amazon Resource Name (ARN) of the user. + // + // This member is required. + UserArn *string + // The display name shown for the user in AWS CodeStar projects. For example, this // could be set to both first and last name ("Mary Major") or a single name // ("Mary"). The display name is also used to generate the initial icon associated @@ -82,19 +92,9 @@ type DescribeUserProfileOutput struct { // first character after the space ("MJ", not "MM"). DisplayName *string - // The date and time when the user profile was last modified, in timestamp format. - // - // This member is required. - LastModifiedTimestamp *time.Time - // The email address for the user. Optional. EmailAddress *string - // The Amazon Resource Name (ARN) of the user. - // - // This member is required. - UserArn *string - // The SSH public key associated with the user. This SSH public key is associated // with the user profile, and can be used in conjunction with the associated // private key for access to project resources, such as Amazon EC2 instances, if a diff --git a/service/codestar/api_op_DisassociateTeamMember.go b/service/codestar/api_op_DisassociateTeamMember.go index 6992c06458c..f5fcbb8433f 100644 --- a/service/codestar/api_op_DisassociateTeamMember.go +++ b/service/codestar/api_op_DisassociateTeamMember.go @@ -59,16 +59,16 @@ func (c *Client) DisassociateTeamMember(ctx context.Context, params *Disassociat type DisassociateTeamMemberInput struct { - // The Amazon Resource Name (ARN) of the IAM user or group whom you want to remove - // from the project. + // The ID of the AWS CodeStar project from which you want to remove a team member. // // This member is required. - UserArn *string + ProjectId *string - // The ID of the AWS CodeStar project from which you want to remove a team member. + // The Amazon Resource Name (ARN) of the IAM user or group whom you want to remove + // from the project. // // This member is required. - ProjectId *string + UserArn *string } type DisassociateTeamMemberOutput struct { diff --git a/service/codestar/api_op_ListProjects.go b/service/codestar/api_op_ListProjects.go index fcfe4f9f6f3..13a4d75f84a 100644 --- a/service/codestar/api_op_ListProjects.go +++ b/service/codestar/api_op_ListProjects.go @@ -56,12 +56,12 @@ func (c *Client) ListProjects(ctx context.Context, params *ListProjectsInput, op type ListProjectsInput struct { + // The maximum amount of data that can be contained in a single set of results. + MaxResults *int32 + // The continuation token to be used to return the next set of results, if the // results cannot be returned in one response. NextToken *string - - // The maximum amount of data that can be contained in a single set of results. - MaxResults *int32 } type ListProjectsOutput struct { diff --git a/service/codestar/api_op_ListResources.go b/service/codestar/api_op_ListResources.go index bbce61754e9..816632e815e 100644 --- a/service/codestar/api_op_ListResources.go +++ b/service/codestar/api_op_ListResources.go @@ -62,23 +62,23 @@ type ListResourcesInput struct { // This member is required. ProjectId *string + // The maximum amount of data that can be contained in a single set of results. + MaxResults *int32 + // The continuation token for the next set of results, if the results cannot be // returned in one response. NextToken *string - - // The maximum amount of data that can be contained in a single set of results. - MaxResults *int32 } type ListResourcesOutput struct { - // An array of resources associated with the project. - Resources []*types.Resource - // The continuation token to use when requesting the next set of results, if there // are more results to be returned. NextToken *string + // An array of resources associated with the project. + Resources []*types.Resource + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codestar/api_op_ListTagsForProject.go b/service/codestar/api_op_ListTagsForProject.go index 403c365bb75..3ec2da7cdc1 100644 --- a/service/codestar/api_op_ListTagsForProject.go +++ b/service/codestar/api_op_ListTagsForProject.go @@ -56,26 +56,26 @@ func (c *Client) ListTagsForProject(ctx context.Context, params *ListTagsForProj type ListTagsForProjectInput struct { - // Reserved for future use. - NextToken *string - - // Reserved for future use. - MaxResults *int32 - // The ID of the project to get tags for. // // This member is required. Id *string + + // Reserved for future use. + MaxResults *int32 + + // Reserved for future use. + NextToken *string } type ListTagsForProjectOutput struct { - // The tags for the project. - Tags map[string]*string - // Reserved for future use. NextToken *string + // The tags for the project. + Tags map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codestar/api_op_ListTeamMembers.go b/service/codestar/api_op_ListTeamMembers.go index 13de581e2f2..aa8dfb07492 100644 --- a/service/codestar/api_op_ListTeamMembers.go +++ b/service/codestar/api_op_ListTeamMembers.go @@ -57,14 +57,14 @@ func (c *Client) ListTeamMembers(ctx context.Context, params *ListTeamMembersInp type ListTeamMembersInput struct { - // The maximum number of team members you want returned in a response. - MaxResults *int32 - // The ID of the project for which you want to list team members. // // This member is required. ProjectId *string + // The maximum number of team members you want returned in a response. + MaxResults *int32 + // The continuation token for the next set of results, if the results cannot be // returned in one response. NextToken *string diff --git a/service/codestar/api_op_ListUserProfiles.go b/service/codestar/api_op_ListUserProfiles.go index 7ffd9ce9203..c16c034315c 100644 --- a/service/codestar/api_op_ListUserProfiles.go +++ b/service/codestar/api_op_ListUserProfiles.go @@ -66,15 +66,15 @@ type ListUserProfilesInput struct { type ListUserProfilesOutput struct { - // The continuation token to use when requesting the next set of results, if there - // are more results to be returned. - NextToken *string - // All the user profiles configured in AWS CodeStar for an AWS account. // // This member is required. UserProfiles []*types.UserProfileSummary + // The continuation token to use when requesting the next set of results, if there + // are more results to be returned. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codestar/api_op_UntagProject.go b/service/codestar/api_op_UntagProject.go index 12a2cb4b9fe..23b2946ff78 100644 --- a/service/codestar/api_op_UntagProject.go +++ b/service/codestar/api_op_UntagProject.go @@ -56,15 +56,15 @@ func (c *Client) UntagProject(ctx context.Context, params *UntagProjectInput, op type UntagProjectInput struct { - // The tags to remove from the project. + // The ID of the project to remove tags from. // // This member is required. - Tags []*string + Id *string - // The ID of the project to remove tags from. + // The tags to remove from the project. // // This member is required. - Id *string + Tags []*string } type UntagProjectOutput struct { diff --git a/service/codestar/api_op_UpdateProject.go b/service/codestar/api_op_UpdateProject.go index 033044a498e..1c6a94feb6d 100644 --- a/service/codestar/api_op_UpdateProject.go +++ b/service/codestar/api_op_UpdateProject.go @@ -61,11 +61,11 @@ type UpdateProjectInput struct { // This member is required. Id *string - // The name of the project you want to update. - Name *string - // The description of the project, if any. Description *string + + // The name of the project you want to update. + Name *string } type UpdateProjectOutput struct { diff --git a/service/codestar/api_op_UpdateTeamMember.go b/service/codestar/api_op_UpdateTeamMember.go index e6529be800f..c1008e5c989 100644 --- a/service/codestar/api_op_UpdateTeamMember.go +++ b/service/codestar/api_op_UpdateTeamMember.go @@ -63,18 +63,18 @@ type UpdateTeamMemberInput struct { // This member is required. ProjectId *string - // The role assigned to the user in the project. Project roles have different - // levels of access. For more information, see Working with Teams - // (http://docs.aws.amazon.com/codestar/latest/userguide/working-with-teams.html) - // in the AWS CodeStar User Guide. - ProjectRole *string - // The Amazon Resource Name (ARN) of the user for whom you want to change team // membership attributes. // // This member is required. UserArn *string + // The role assigned to the user in the project. Project roles have different + // levels of access. For more information, see Working with Teams + // (http://docs.aws.amazon.com/codestar/latest/userguide/working-with-teams.html) + // in the AWS CodeStar User Guide. + ProjectRole *string + // Whether a team member is allowed to remotely access project resources using the // SSH public key associated with the user's profile. Even if this is set to True, // the user must associate a public key with their profile before the user can diff --git a/service/codestar/api_op_UpdateUserProfile.go b/service/codestar/api_op_UpdateUserProfile.go index ac6ba60668b..28adf8c4eeb 100644 --- a/service/codestar/api_op_UpdateUserProfile.go +++ b/service/codestar/api_op_UpdateUserProfile.go @@ -65,21 +65,29 @@ type UpdateUserProfileInput struct { // This member is required. UserArn *string - // The SSH public key associated with the user in AWS CodeStar. If a project owner - // allows the user remote access to project resources, this public key will be used - // along with the user's private key for SSH access. - SshPublicKey *string - // The name that is displayed as the friendly name for the user in AWS CodeStar. DisplayName *string // The email address that is displayed as part of the user's profile in AWS // CodeStar. EmailAddress *string + + // The SSH public key associated with the user in AWS CodeStar. If a project owner + // allows the user remote access to project resources, this public key will be used + // along with the user's private key for SSH access. + SshPublicKey *string } type UpdateUserProfileOutput struct { + // The Amazon Resource Name (ARN) of the user in IAM. + // + // This member is required. + UserArn *string + + // The date the user profile was created, in timestamp format. + CreatedTimestamp *time.Time + // The name that is displayed as the friendly name for the user in AWS CodeStar. DisplayName *string @@ -87,9 +95,6 @@ type UpdateUserProfileOutput struct { // CodeStar. EmailAddress *string - // The date the user profile was created, in timestamp format. - CreatedTimestamp *time.Time - // The date the user profile was last modified, in timestamp format. LastModifiedTimestamp *time.Time @@ -98,11 +103,6 @@ type UpdateUserProfileOutput struct { // resources if a project owner allows the user remote access to those resources. SshPublicKey *string - // The Amazon Resource Name (ARN) of the user in IAM. - // - // This member is required. - UserArn *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codestar/go.mod b/service/codestar/go.mod index 5f079d4d1c1..2be154cc54f 100644 --- a/service/codestar/go.mod +++ b/service/codestar/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/codestar go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/codestar/types/types.go b/service/codestar/types/types.go index 33c414b24ff..540175c1dd5 100644 --- a/service/codestar/types/types.go +++ b/service/codestar/types/types.go @@ -7,18 +7,18 @@ package types // repository after project creation. type Code struct { - // The location where the source code files provided with the project request are - // stored. AWS CodeStar retrieves the files during project creation. - // - // This member is required. - Source *CodeSource - // The repository to be created in AWS CodeStar. Valid values are AWS CodeCommit or // GitHub. After AWS CodeStar provisions the new repository, the source code files // provided with the project request are placed in the repository. // // This member is required. Destination *CodeDestination + + // The location where the source code files provided with the project request are + // stored. AWS CodeStar retrieves the files during project creation. + // + // This member is required. + Source *CodeSource } // Information about the AWS CodeCommit repository to be created in AWS CodeStar. @@ -37,15 +37,15 @@ type CodeCommitCodeDestination struct { // provided with the project request are placed in the repository. type CodeDestination struct { - // Information about the GitHub repository to be created in AWS CodeStar. This is - // where the source code files provided with the project request will be uploaded - // after project creation. - GitHub *GitHubCodeDestination - // Information about the AWS CodeCommit repository to be created in AWS CodeStar. // This is where the source code files provided with the project request will be // uploaded after project creation. CodeCommit *CodeCommitCodeDestination + + // Information about the GitHub repository to be created in AWS CodeStar. This is + // where the source code files provided with the project request will be uploaded + // after project creation. + GitHub *GitHubCodeDestination } // The location where the source code files provided with the project request are @@ -64,38 +64,38 @@ type CodeSource struct { // after project creation. type GitHubCodeDestination struct { - // The type of GitHub repository to be created in AWS CodeStar. Valid values are - // User or Organization. + // Whether to enable issues for the GitHub repository. // // This member is required. - Type *string + IssuesEnabled *bool - // Whether the GitHub repository is to be a private repository. + // Name of the GitHub repository to be created in AWS CodeStar. // // This member is required. - PrivateRepository *bool + Name *string - // The GitHub user's personal access token for the GitHub repository. + // The GitHub username for the owner of the GitHub repository to be created in AWS + // CodeStar. If this repository should be owned by a GitHub organization, provide + // its name. // // This member is required. - Token *string + Owner *string - // Name of the GitHub repository to be created in AWS CodeStar. + // Whether the GitHub repository is to be a private repository. // // This member is required. - Name *string + PrivateRepository *bool - // Whether to enable issues for the GitHub repository. + // The GitHub user's personal access token for the GitHub repository. // // This member is required. - IssuesEnabled *bool + Token *string - // The GitHub username for the owner of the GitHub repository to be created in AWS - // CodeStar. If this repository should be owned by a GitHub organization, provide - // its name. + // The type of GitHub repository to be created in AWS CodeStar. Valid values are + // User or Organization. // // This member is required. - Owner *string + Type *string // Description for the GitHub repository to be created in AWS CodeStar. This // description displays in GitHub after the repository is created. @@ -117,11 +117,11 @@ type ProjectStatus struct { // Information about the metadata for a project. type ProjectSummary struct { - // The ID of the project. - ProjectId *string - // The Amazon Resource Name (ARN) of the project. ProjectArn *string + + // The ID of the project. + ProjectId *string } // Information about a resource for a project. @@ -178,13 +178,13 @@ type Toolchain struct { // This member is required. Source *ToolchainSource - // The list of parameter overrides to be passed into the toolchain template during - // stack provisioning, if any. - StackParameters map[string]*string - // The service role ARN for AWS CodeStar to use for the toolchain template during // stack provisioning. RoleArn *string + + // The list of parameter overrides to be passed into the toolchain template during + // stack provisioning, if any. + StackParameters map[string]*string } // The Amazon S3 location where the toolchain template file provided with the @@ -202,9 +202,6 @@ type ToolchainSource struct { // Information about a user's profile in AWS CodeStar. type UserProfileSummary struct { - // The email address associated with the user. - EmailAddress *string - // The display name of a user in AWS CodeStar. For example, this could be set to // both first and last name ("Mary Major") or a single name ("Mary"). The display // name is also used to generate the initial icon associated with the user in AWS @@ -216,11 +213,14 @@ type UserProfileSummary struct { // the space ("MJ", not "MM"). DisplayName *string - // The Amazon Resource Name (ARN) of the user in IAM. - UserArn *string + // The email address associated with the user. + EmailAddress *string // The SSH public key associated with the user in AWS CodeStar. If a project owner // allows the user remote access to project resources, this public key will be used // along with the user's private key for SSH access. SshPublicKey *string + + // The Amazon Resource Name (ARN) of the user in IAM. + UserArn *string } diff --git a/service/codestarconnections/api_op_CreateConnection.go b/service/codestarconnections/api_op_CreateConnection.go index 7f3f8dd142a..095f7ad608f 100644 --- a/service/codestarconnections/api_op_CreateConnection.go +++ b/service/codestarconnections/api_op_CreateConnection.go @@ -60,6 +60,12 @@ func (c *Client) CreateConnection(ctx context.Context, params *CreateConnectionI type CreateConnectionInput struct { + // The name of the connection to be created. The name must be unique in the calling + // AWS account. + // + // This member is required. + ConnectionName *string + // The Amazon Resource Name (ARN) of the host associated with the connection to be // created. HostArn *string @@ -68,21 +74,12 @@ type CreateConnectionInput struct { // configured. The valid provider type is Bitbucket. ProviderType types.ProviderType - // The name of the connection to be created. The name must be unique in the calling - // AWS account. - // - // This member is required. - ConnectionName *string - // The key-value pair to use when tagging the resource. Tags []*types.Tag } type CreateConnectionOutput struct { - // Specifies the tags applied to the resource. - Tags []*types.Tag - // The Amazon Resource Name (ARN) of the connection to be created. The ARN is used // as the connection reference when the connection is shared between AWS services. // The ARN is never reused if the connection is deleted. @@ -90,6 +87,9 @@ type CreateConnectionOutput struct { // This member is required. ConnectionArn *string + // Specifies the tags applied to the resource. + Tags []*types.Tag + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codestarconnections/api_op_CreateHost.go b/service/codestarconnections/api_op_CreateHost.go index fd2b7c98673..bdf92768177 100644 --- a/service/codestarconnections/api_op_CreateHost.go +++ b/service/codestarconnections/api_op_CreateHost.go @@ -62,17 +62,11 @@ func (c *Client) CreateHost(ctx context.Context, params *CreateHostInput, optFns type CreateHostInput struct { - // The name of the installed provider to be associated with your connection. The - // host resource represents the infrastructure where your provider type is - // installed. The valid provider type is GitHub Enterprise Server. + // The name of the host to be created. The name must be unique in the calling AWS + // account. // // This member is required. - ProviderType types.ProviderType - - // The VPC configuration to be provisioned for the host. A VPC must be configured - // and the infrastructure to be represented by the host must already be connected - // to the VPC. - VpcConfiguration *types.VpcConfiguration + Name *string // The endpoint of the infrastructure to be represented by the host after it is // created. @@ -80,11 +74,17 @@ type CreateHostInput struct { // This member is required. ProviderEndpoint *string - // The name of the host to be created. The name must be unique in the calling AWS - // account. + // The name of the installed provider to be associated with your connection. The + // host resource represents the infrastructure where your provider type is + // installed. The valid provider type is GitHub Enterprise Server. // // This member is required. - Name *string + ProviderType types.ProviderType + + // The VPC configuration to be provisioned for the host. A VPC must be configured + // and the infrastructure to be represented by the host must already be connected + // to the VPC. + VpcConfiguration *types.VpcConfiguration } type CreateHostOutput struct { diff --git a/service/codestarconnections/api_op_GetHost.go b/service/codestarconnections/api_op_GetHost.go index aa835e226aa..f58f637bf54 100644 --- a/service/codestarconnections/api_op_GetHost.go +++ b/service/codestarconnections/api_op_GetHost.go @@ -66,20 +66,20 @@ type GetHostInput struct { type GetHostOutput struct { - // The provider type of the requested host, such as GitHub Enterprise Server. - ProviderType types.ProviderType - - // The VPC configuration of the requested host. - VpcConfiguration *types.VpcConfiguration + // The name of the requested host. + Name *string // The endpoint of the infrastructure represented by the requested host. ProviderEndpoint *string + // The provider type of the requested host, such as GitHub Enterprise Server. + ProviderType types.ProviderType + // The status of the requested host. Status *string - // The name of the requested host. - Name *string + // The VPC configuration of the requested host. + VpcConfiguration *types.VpcConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/codestarconnections/api_op_ListConnections.go b/service/codestarconnections/api_op_ListConnections.go index 671300ba6f3..d1420c79bf9 100644 --- a/service/codestarconnections/api_op_ListConnections.go +++ b/service/codestarconnections/api_op_ListConnections.go @@ -59,30 +59,30 @@ type ListConnectionsInput struct { // Filters the list of connections to those associated with a specified host. HostArnFilter *string - // Filters the list of connections to those associated with a specified provider, - // such as Bitbucket. - ProviderTypeFilter types.ProviderType + // The maximum number of results to return in a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int32 // The token that was returned from the previous ListConnections call, which can be // used to return the next set of connections in the list. NextToken *string - // The maximum number of results to return in a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. - MaxResults *int32 + // Filters the list of connections to those associated with a specified provider, + // such as Bitbucket. + ProviderTypeFilter types.ProviderType } type ListConnectionsOutput struct { + // A list of connections and the details for each connection, such as status, + // owner, and provider type. + Connections []*types.Connection + // A token that can be used in the next ListConnections call. To view all items in // the list, continue to call this operation with each subsequent token until no // more nextToken values are returned. NextToken *string - // A list of connections and the details for each connection, such as status, - // owner, and provider type. - Connections []*types.Connection - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codestarconnections/api_op_ListHosts.go b/service/codestarconnections/api_op_ListHosts.go index 7e004251ac6..e88ac4fe20f 100644 --- a/service/codestarconnections/api_op_ListHosts.go +++ b/service/codestarconnections/api_op_ListHosts.go @@ -56,26 +56,26 @@ func (c *Client) ListHosts(ctx context.Context, params *ListHostsInput, optFns . type ListHostsInput struct { - // The token that was returned from the previous ListHosts call, which can be used - // to return the next set of hosts in the list. - NextToken *string - // The maximum number of results to return in a single call. To retrieve the // remaining results, make another call with the returned nextToken value. MaxResults *int32 + + // The token that was returned from the previous ListHosts call, which can be used + // to return the next set of hosts in the list. + NextToken *string } type ListHostsOutput struct { + // A list of hosts and the details for each host, such as status, endpoint, and + // provider type. + Hosts []*types.Host + // A token that can be used in the next ListHosts call. To view all items in the // list, continue to call this operation with each subsequent token until no more // nextToken values are returned. NextToken *string - // A list of hosts and the details for each host, such as status, endpoint, and - // provider type. - Hosts []*types.Host - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codestarconnections/api_op_UntagResource.go b/service/codestarconnections/api_op_UntagResource.go index 579cf742ed0..e1ebe35275b 100644 --- a/service/codestarconnections/api_op_UntagResource.go +++ b/service/codestarconnections/api_op_UntagResource.go @@ -56,15 +56,15 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The list of keys for the tags to be removed from the resource. + // The Amazon Resource Name (ARN) of the resource to remove tags from. // // This member is required. - TagKeys []*string + ResourceArn *string - // The Amazon Resource Name (ARN) of the resource to remove tags from. + // The list of keys for the tags to be removed from the resource. // // This member is required. - ResourceArn *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/codestarconnections/go.mod b/service/codestarconnections/go.mod index 10e8766277f..2b6a66080a1 100644 --- a/service/codestarconnections/go.mod +++ b/service/codestarconnections/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/codestarconnections go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/codestarconnections/types/types.go b/service/codestarconnections/types/types.go index 411f4cc1929..bab291d82bb 100644 --- a/service/codestarconnections/types/types.go +++ b/service/codestarconnections/types/types.go @@ -13,24 +13,24 @@ type Connection struct { // is never reused if the connection is deleted. ConnectionArn *string - // The Amazon Resource Name (ARN) of the host associated with the connection. - HostArn *string + // The name of the connection. Connection names must be unique in an AWS user + // account. + ConnectionName *string // The current status of the connection. ConnectionStatus ConnectionStatus - // The name of the external provider where your third-party code repository is - // configured. The valid provider type is Bitbucket. - ProviderType ProviderType + // The Amazon Resource Name (ARN) of the host associated with the connection. + HostArn *string // The identifier of the external provider where your third-party code repository // is configured. For Bitbucket, this is the account ID of the owner of the // Bitbucket repository. OwnerAccountId *string - // The name of the connection. Connection names must be unique in an AWS user - // account. - ConnectionName *string + // The name of the external provider where your third-party code repository is + // configured. The valid provider type is Bitbucket. + ProviderType ProviderType } // A resource that represents the infrastructure where a third-party provider is @@ -41,8 +41,8 @@ type Connection struct { // setting up the host in the console. type Host struct { - // The VPC configuration provisioned for the host. - VpcConfiguration *VpcConfiguration + // The Amazon Resource Name (ARN) of the host. + HostArn *string // The name of the host. Name *string @@ -50,8 +50,10 @@ type Host struct { // The endpoint of the infrastructure where your provider type is installed. ProviderEndpoint *string - // The Amazon Resource Name (ARN) of the host. - HostArn *string + // The name of the installed provider to be associated with your connection. The + // host resource represents the infrastructure where your provider type is + // installed. The valid provider type is GitHub Enterprise Server. + ProviderType ProviderType // The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, // VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION. @@ -60,25 +62,23 @@ type Host struct { // The status description for the host. StatusMessage *string - // The name of the installed provider to be associated with your connection. The - // host resource represents the infrastructure where your provider type is - // installed. The valid provider type is GitHub Enterprise Server. - ProviderType ProviderType + // The VPC configuration provisioned for the host. + VpcConfiguration *VpcConfiguration } // A tag is a key-value pair that is used to manage the resource. This tag is // available for use by AWS services that support tags. type Tag struct { - // The tag's value. + // The tag's key. // // This member is required. - Value *string + Key *string - // The tag's key. + // The tag's value. // // This member is required. - Key *string + Value *string } // The VPC configuration provisioned for the host. @@ -90,18 +90,18 @@ type VpcConfiguration struct { // This member is required. SecurityGroupIds []*string - // The ID of the Amazon VPC connected to the infrastructure where your provider - // type is installed. - // - // This member is required. - VpcId *string - // The ID of the subnet or subnets associated with the Amazon VPC connected to the // infrastructure where your provider type is installed. // // This member is required. SubnetIds []*string + // The ID of the Amazon VPC connected to the infrastructure where your provider + // type is installed. + // + // This member is required. + VpcId *string + // The value of the Transport Layer Security (TLS) certificate associated with the // infrastructure where your provider type is installed. TlsCertificate *string diff --git a/service/codestarnotifications/api_op_CreateNotificationRule.go b/service/codestarnotifications/api_op_CreateNotificationRule.go index e2de6042149..d104fdc5668 100644 --- a/service/codestarnotifications/api_op_CreateNotificationRule.go +++ b/service/codestarnotifications/api_op_CreateNotificationRule.go @@ -61,9 +61,14 @@ func (c *Client) CreateNotificationRule(ctx context.Context, params *CreateNotif type CreateNotificationRuleInput struct { - // A list of tags to apply to this notification rule. Key names cannot start with - // "aws". - Tags map[string]*string + // The level of detail to include in the notifications for this resource. BASIC + // will include only the contents of the event as it would appear in AWS + // CloudWatch. FULL will include any supplemental information provided by AWS + // CodeStar Notifications and/or the service for the resource for which the + // notification is created. + // + // This member is required. + DetailType types.DetailType // A list of event types associated with this notification rule. For a list of // allowed events, see EventTypeSummary (). @@ -71,22 +76,11 @@ type CreateNotificationRuleInput struct { // This member is required. EventTypeIds []*string - // A unique, client-generated idempotency token that, when provided in a request, - // ensures the request cannot be repeated with a changed parameter. If a request - // with the same parameters is received and a token is included, the request - // returns information about the initial request that used that token. The AWS SDKs - // prepopulate client request tokens. If you are using an AWS SDK, an idempotency - // token is created for you. - ClientRequestToken *string - - // The level of detail to include in the notifications for this resource. BASIC - // will include only the contents of the event as it would appear in AWS - // CloudWatch. FULL will include any supplemental information provided by AWS - // CodeStar Notifications and/or the service for the resource for which the - // notification is created. + // The name for the notification rule. Notifictaion rule names must be unique in + // your AWS account. // // This member is required. - DetailType types.DetailType + Name *string // The Amazon Resource Name (ARN) of the resource to associate with the // notification rule. Supported resources include pipelines in AWS CodePipeline, @@ -95,21 +89,27 @@ type CreateNotificationRuleInput struct { // This member is required. Resource *string - // The status of the notification rule. The default value is ENABLED. If the status - // is set to DISABLED, notifications aren't sent for the notification rule. - Status types.NotificationRuleStatus - // A list of Amazon Resource Names (ARNs) of SNS topics to associate with the // notification rule. // // This member is required. Targets []*types.Target - // The name for the notification rule. Notifictaion rule names must be unique in - // your AWS account. - // - // This member is required. - Name *string + // A unique, client-generated idempotency token that, when provided in a request, + // ensures the request cannot be repeated with a changed parameter. If a request + // with the same parameters is received and a token is included, the request + // returns information about the initial request that used that token. The AWS SDKs + // prepopulate client request tokens. If you are using an AWS SDK, an idempotency + // token is created for you. + ClientRequestToken *string + + // The status of the notification rule. The default value is ENABLED. If the status + // is set to DISABLED, notifications aren't sent for the notification rule. + Status types.NotificationRuleStatus + + // A list of tags to apply to this notification rule. Key names cannot start with + // "aws". + Tags map[string]*string } type CreateNotificationRuleOutput struct { diff --git a/service/codestarnotifications/api_op_DeleteTarget.go b/service/codestarnotifications/api_op_DeleteTarget.go index 4cdff956e46..66688785878 100644 --- a/service/codestarnotifications/api_op_DeleteTarget.go +++ b/service/codestarnotifications/api_op_DeleteTarget.go @@ -56,15 +56,15 @@ func (c *Client) DeleteTarget(ctx context.Context, params *DeleteTargetInput, op type DeleteTargetInput struct { - // A Boolean value that can be used to delete all associations with this SNS topic. - // The default value is FALSE. If set to TRUE, all associations between that target - // and every notification rule in your AWS account are deleted. - ForceUnsubscribeAll *bool - // The Amazon Resource Name (ARN) of the SNS topic to delete. // // This member is required. TargetAddress *string + + // A Boolean value that can be used to delete all associations with this SNS topic. + // The default value is FALSE. If set to TRUE, all associations between that target + // and every notification rule in your AWS account are deleted. + ForceUnsubscribeAll *bool } type DeleteTargetOutput struct { diff --git a/service/codestarnotifications/api_op_DescribeNotificationRule.go b/service/codestarnotifications/api_op_DescribeNotificationRule.go index 4e03ac921f0..0abcbebfe18 100644 --- a/service/codestarnotifications/api_op_DescribeNotificationRule.go +++ b/service/codestarnotifications/api_op_DescribeNotificationRule.go @@ -71,9 +71,11 @@ type DescribeNotificationRuleOutput struct { // This member is required. Arn *string - // The date and time the notification rule was most recently updated, in timestamp - // format. - LastModifiedTimestamp *time.Time + // The name or email alias of the person who created the notification rule. + CreatedBy *string + + // The date and time the notification rule was created, in timestamp format. + CreatedTimestamp *time.Time // The level of detail included in the notifications for this resource. BASIC will // include only the contents of the event as it would appear in AWS CloudWatch. @@ -82,32 +84,30 @@ type DescribeNotificationRuleOutput struct { // created. DetailType types.DetailType - // The status of the notification rule. Valid statuses are on (sending - // notifications) or off (not sending notifications). - Status types.NotificationRuleStatus - // A list of the event types associated with the notification rule. EventTypes []*types.EventTypeSummary + // The date and time the notification rule was most recently updated, in timestamp + // format. + LastModifiedTimestamp *time.Time + + // The name of the notification rule. + Name *string + // The Amazon Resource Name (ARN) of the resource associated with the notification // rule. Resource *string - // The name of the notification rule. - Name *string + // The status of the notification rule. Valid statuses are on (sending + // notifications) or off (not sending notifications). + Status types.NotificationRuleStatus // The tags associated with the notification rule. Tags map[string]*string - // The date and time the notification rule was created, in timestamp format. - CreatedTimestamp *time.Time - // A list of the SNS topics associated with the notification rule. Targets []*types.TargetSummary - // The name or email alias of the person who created the notification rule. - CreatedBy *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codestarnotifications/api_op_ListEventTypes.go b/service/codestarnotifications/api_op_ListEventTypes.go index 8fce8600d75..ffff8da477f 100644 --- a/service/codestarnotifications/api_op_ListEventTypes.go +++ b/service/codestarnotifications/api_op_ListEventTypes.go @@ -61,13 +61,13 @@ type ListEventTypesInput struct { // The filters to use to return information by service or resource type. Filters []*types.ListEventTypesFilter - // An enumeration token that, when provided in a request, returns the next batch of - // the results. - NextToken *string - // A non-negative integer used to limit the number of returned results. The default // number is 50. The maximum number of results that can be returned is 100. MaxResults *int32 + + // An enumeration token that, when provided in a request, returns the next batch of + // the results. + NextToken *string } type ListEventTypesOutput struct { diff --git a/service/codestarnotifications/api_op_ListNotificationRules.go b/service/codestarnotifications/api_op_ListNotificationRules.go index 7e99530b4ca..4f1b107e367 100644 --- a/service/codestarnotifications/api_op_ListNotificationRules.go +++ b/service/codestarnotifications/api_op_ListNotificationRules.go @@ -57,16 +57,16 @@ func (c *Client) ListNotificationRules(ctx context.Context, params *ListNotifica type ListNotificationRulesInput struct { - // A non-negative integer used to limit the number of returned results. The maximum - // number of results that can be returned is 100. - MaxResults *int32 - // The filters to use to return information by service or resource type. For valid // values, see ListNotificationRulesFilter (). A filter with the same name can // appear more than once when used with OR statements. Filters with different names // should be applied with AND statements. Filters []*types.ListNotificationRulesFilter + // A non-negative integer used to limit the number of returned results. The maximum + // number of results that can be returned is 100. + MaxResults *int32 + // An enumeration token that, when provided in a request, returns the next batch of // the results. NextToken *string @@ -74,14 +74,14 @@ type ListNotificationRulesInput struct { type ListNotificationRulesOutput struct { - // The list of notification rules for the AWS account, by Amazon Resource Name - // (ARN) and ID. - NotificationRules []*types.NotificationRuleSummary - // An enumeration token that can be used in a request to return the next batch of // the results. NextToken *string + // The list of notification rules for the AWS account, by Amazon Resource Name + // (ARN) and ID. + NotificationRules []*types.NotificationRuleSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/codestarnotifications/api_op_ListTargets.go b/service/codestarnotifications/api_op_ListTargets.go index c29ea1b9499..cc44e48e489 100644 --- a/service/codestarnotifications/api_op_ListTargets.go +++ b/service/codestarnotifications/api_op_ListTargets.go @@ -63,13 +63,13 @@ type ListTargetsInput struct { // with different names should be applied with AND statements. Filters []*types.ListTargetsFilter - // An enumeration token that, when provided in a request, returns the next batch of - // the results. - NextToken *string - // A non-negative integer used to limit the number of returned results. The maximum // number of results that can be returned is 100. MaxResults *int32 + + // An enumeration token that, when provided in a request, returns the next batch of + // the results. + NextToken *string } type ListTargetsOutput struct { diff --git a/service/codestarnotifications/api_op_Subscribe.go b/service/codestarnotifications/api_op_Subscribe.go index bb807f7f6cb..36eac7bb0d6 100644 --- a/service/codestarnotifications/api_op_Subscribe.go +++ b/service/codestarnotifications/api_op_Subscribe.go @@ -59,17 +59,17 @@ func (c *Client) Subscribe(ctx context.Context, params *SubscribeInput, optFns . type SubscribeInput struct { - // Information about the SNS topics associated with a notification rule. - // - // This member is required. - Target *types.Target - // The Amazon Resource Name (ARN) of the notification rule for which you want to // create the association. // // This member is required. Arn *string + // Information about the SNS topics associated with a notification rule. + // + // This member is required. + Target *types.Target + // An enumeration token that, when provided in a request, returns the next batch of // the results. ClientRequestToken *string diff --git a/service/codestarnotifications/api_op_TagResource.go b/service/codestarnotifications/api_op_TagResource.go index b75739949b4..b4193147597 100644 --- a/service/codestarnotifications/api_op_TagResource.go +++ b/service/codestarnotifications/api_op_TagResource.go @@ -56,16 +56,16 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The list of tags to associate with the resource. Tag key names cannot start with - // "aws". + // The Amazon Resource Name (ARN) of the notification rule to tag. // // This member is required. - Tags map[string]*string + Arn *string - // The Amazon Resource Name (ARN) of the notification rule to tag. + // The list of tags to associate with the resource. Tag key names cannot start with + // "aws". // // This member is required. - Arn *string + Tags map[string]*string } type TagResourceOutput struct { diff --git a/service/codestarnotifications/api_op_UntagResource.go b/service/codestarnotifications/api_op_UntagResource.go index a7dcc768a73..b8edb9837a2 100644 --- a/service/codestarnotifications/api_op_UntagResource.go +++ b/service/codestarnotifications/api_op_UntagResource.go @@ -57,16 +57,16 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The key names of the tags to remove. - // - // This member is required. - TagKeys []*string - // The Amazon Resource Name (ARN) of the notification rule from which to remove the // tags. // // This member is required. Arn *string + + // The key names of the tags to remove. + // + // This member is required. + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/codestarnotifications/api_op_UpdateNotificationRule.go b/service/codestarnotifications/api_op_UpdateNotificationRule.go index 556211ce647..abe034f39ab 100644 --- a/service/codestarnotifications/api_op_UpdateNotificationRule.go +++ b/service/codestarnotifications/api_op_UpdateNotificationRule.go @@ -60,9 +60,10 @@ func (c *Client) UpdateNotificationRule(ctx context.Context, params *UpdateNotif type UpdateNotificationRuleInput struct { - // The address and type of the targets to receive notifications from this - // notification rule. - Targets []*types.Target + // The Amazon Resource Name (ARN) of the notification rule. + // + // This member is required. + Arn *string // The level of detail to include in the notifications for this resource. BASIC // will include only the contents of the event as it would appear in AWS @@ -74,17 +75,16 @@ type UpdateNotificationRuleInput struct { // A list of event types associated with this notification rule. EventTypeIds []*string + // The name of the notification rule. + Name *string + // The status of the notification rule. Valid statuses include enabled (sending // notifications) or disabled (not sending notifications). Status types.NotificationRuleStatus - // The Amazon Resource Name (ARN) of the notification rule. - // - // This member is required. - Arn *string - - // The name of the notification rule. - Name *string + // The address and type of the targets to receive notifications from this + // notification rule. + Targets []*types.Target } type UpdateNotificationRuleOutput struct { diff --git a/service/codestarnotifications/go.mod b/service/codestarnotifications/go.mod index a8d2c5d917a..873b9f539df 100644 --- a/service/codestarnotifications/go.mod +++ b/service/codestarnotifications/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/codestarnotifications go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/codestarnotifications/types/types.go b/service/codestarnotifications/types/types.go index 00d05fac76d..31456bbe661 100644 --- a/service/codestarnotifications/types/types.go +++ b/service/codestarnotifications/types/types.go @@ -8,48 +8,48 @@ type EventTypeSummary struct { // The system-generated ID of the event. EventTypeId *string + // The name of the event. + EventTypeName *string + // The resource type of the event. ResourceType *string // The name of the service for which the event applies. ServiceName *string - - // The name of the event. - EventTypeName *string } // Information about a filter to apply to the list of returned event types. You can // filter by resource type or service name. type ListEventTypesFilter struct { - // The name of the resource type (for example, pipeline) or service name (for - // example, CodePipeline) that you want to filter by. + // The system-generated name of the filter type you want to filter by. // // This member is required. - Value *string + Name ListEventTypesFilterName - // The system-generated name of the filter type you want to filter by. + // The name of the resource type (for example, pipeline) or service name (for + // example, CodePipeline) that you want to filter by. // // This member is required. - Name ListEventTypesFilterName + Value *string } // Information about a filter to apply to the list of returned notification rules. // You can filter by event type, owner, resource, or target. type ListNotificationRulesFilter struct { + // The name of the attribute you want to use to filter the returned notification + // rules. + // + // This member is required. + Name ListNotificationRulesFilterName + // The value of the attribute you want to use to filter the returned notification // rules. For example, if you specify filtering by RESOURCE in Name, you might // specify the ARN of a pipeline in AWS CodePipeline for the value. // // This member is required. Value *string - - // The name of the attribute you want to use to filter the returned notification - // rules. - // - // This member is required. - Name ListNotificationRulesFilterName } // Information about a filter to apply to the list of returned targets. You can @@ -75,11 +75,11 @@ type ListTargetsFilter struct { // Information about a specified notification rule. type NotificationRuleSummary struct { - // The unique ID of the notification rule. - Id *string - // The Amazon Resource Name (ARN) of the notification rule. Arn *string + + // The unique ID of the notification rule. + Id *string } // Information about the SNS topics associated with a notification rule. diff --git a/service/cognitoidentity/api_op_CreateIdentityPool.go b/service/cognitoidentity/api_op_CreateIdentityPool.go index 319a5ee397a..2c0ef329330 100644 --- a/service/cognitoidentity/api_op_CreateIdentityPool.go +++ b/service/cognitoidentity/api_op_CreateIdentityPool.go @@ -66,11 +66,25 @@ func (c *Client) CreateIdentityPool(ctx context.Context, params *CreateIdentityP // Input to the CreateIdentityPool action. type CreateIdentityPoolInput struct { + // TRUE if the identity pool supports unauthenticated logins. + // + // This member is required. + AllowUnauthenticatedIdentities *bool + // A string that you provide. // // This member is required. IdentityPoolName *string + // Enables or disables the Basic (Classic) authentication flow. For more + // information, see Identity Pools (Federated Identities) Authentication Flow + // (https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html) + // in the Amazon Cognito Developer Guide. + AllowClassicFlow *bool + + // An array of Amazon Cognito user pools and their client IDs. + CognitoIdentityProviders []*types.CognitoIdentityProvider + // The "domain" by which Cognito will refer to your users. This name acts as a // placeholder that allows your backend and the Cognito service to communicate // about the developer provider. For the DeveloperProviderName, you can use letters @@ -79,14 +93,10 @@ type CreateIdentityPoolInput struct { // parameter. DeveloperProviderName *string - // An array of Amazon Cognito user pools and their client IDs. - CognitoIdentityProviders []*types.CognitoIdentityProvider - - // Enables or disables the Basic (Classic) authentication flow. For more - // information, see Identity Pools (Federated Identities) Authentication Flow - // (https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html) - // in the Amazon Cognito Developer Guide. - AllowClassicFlow *bool + // Tags to assign to the identity pool. A tag is a label that you can apply to + // identity pools to categorize and manage them in different ways, such as by + // purpose, owner, environment, or other criteria. + IdentityPoolTags map[string]*string // A list of OpendID Connect provider ARNs. OpenIdConnectProviderARNs []*string @@ -95,22 +105,27 @@ type CreateIdentityPoolInput struct { // pool. SamlProviderARNs []*string - // Tags to assign to the identity pool. A tag is a label that you can apply to - // identity pools to categorize and manage them in different ways, such as by - // purpose, owner, environment, or other criteria. - IdentityPoolTags map[string]*string - // Optional key:value pairs mapping provider names to provider app IDs. SupportedLoginProviders map[string]*string +} + +// An object representing an Amazon Cognito identity pool. +type CreateIdentityPoolOutput struct { // TRUE if the identity pool supports unauthenticated logins. // // This member is required. AllowUnauthenticatedIdentities *bool -} -// An object representing an Amazon Cognito identity pool. -type CreateIdentityPoolOutput struct { + // An identity pool ID in the format REGION:GUID. + // + // This member is required. + IdentityPoolId *string + + // A string that you provide. + // + // This member is required. + IdentityPoolName *string // Enables or disables the Basic (Classic) authentication flow. For more // information, see Identity Pools (Federated Identities) Authentication Flow @@ -121,39 +136,24 @@ type CreateIdentityPoolOutput struct { // A list representing an Amazon Cognito user pool and its client ID. CognitoIdentityProviders []*types.CognitoIdentityProvider - // An array of Amazon Resource Names (ARNs) of the SAML provider for your identity - // pool. - SamlProviderARNs []*string - - // A list of OpendID Connect provider ARNs. - OpenIdConnectProviderARNs []*string + // The "domain" by which Cognito will refer to your users. + DeveloperProviderName *string // The tags that are assigned to the identity pool. A tag is a label that you can // apply to identity pools to categorize and manage them in different ways, such as // by purpose, owner, environment, or other criteria. IdentityPoolTags map[string]*string - // An identity pool ID in the format REGION:GUID. - // - // This member is required. - IdentityPoolId *string - - // The "domain" by which Cognito will refer to your users. - DeveloperProviderName *string + // A list of OpendID Connect provider ARNs. + OpenIdConnectProviderARNs []*string - // A string that you provide. - // - // This member is required. - IdentityPoolName *string + // An array of Amazon Resource Names (ARNs) of the SAML provider for your identity + // pool. + SamlProviderARNs []*string // Optional key:value pairs mapping provider names to provider app IDs. SupportedLoginProviders map[string]*string - // TRUE if the identity pool supports unauthenticated logins. - // - // This member is required. - AllowUnauthenticatedIdentities *bool - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cognitoidentity/api_op_DescribeIdentity.go b/service/cognitoidentity/api_op_DescribeIdentity.go index 789088de78f..2d53556cdf6 100644 --- a/service/cognitoidentity/api_op_DescribeIdentity.go +++ b/service/cognitoidentity/api_op_DescribeIdentity.go @@ -69,15 +69,15 @@ type DescribeIdentityInput struct { // A description of the identity. type DescribeIdentityOutput struct { - // Date on which the identity was last modified. - LastModifiedDate *time.Time - // Date on which the identity was created. CreationDate *time.Time // A unique identifier in the format REGION:GUID. IdentityId *string + // Date on which the identity was last modified. + LastModifiedDate *time.Time + // The provider names. Logins []*string diff --git a/service/cognitoidentity/api_op_DescribeIdentityPool.go b/service/cognitoidentity/api_op_DescribeIdentityPool.go index 21552593aa8..a0164f93ed4 100644 --- a/service/cognitoidentity/api_op_DescribeIdentityPool.go +++ b/service/cognitoidentity/api_op_DescribeIdentityPool.go @@ -69,6 +69,21 @@ type DescribeIdentityPoolInput struct { // An object representing an Amazon Cognito identity pool. type DescribeIdentityPoolOutput struct { + // TRUE if the identity pool supports unauthenticated logins. + // + // This member is required. + AllowUnauthenticatedIdentities *bool + + // An identity pool ID in the format REGION:GUID. + // + // This member is required. + IdentityPoolId *string + + // A string that you provide. + // + // This member is required. + IdentityPoolName *string + // Enables or disables the Basic (Classic) authentication flow. For more // information, see Identity Pools (Federated Identities) Authentication Flow // (https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html) @@ -78,39 +93,24 @@ type DescribeIdentityPoolOutput struct { // A list representing an Amazon Cognito user pool and its client ID. CognitoIdentityProviders []*types.CognitoIdentityProvider - // An array of Amazon Resource Names (ARNs) of the SAML provider for your identity - // pool. - SamlProviderARNs []*string - - // A list of OpendID Connect provider ARNs. - OpenIdConnectProviderARNs []*string + // The "domain" by which Cognito will refer to your users. + DeveloperProviderName *string // The tags that are assigned to the identity pool. A tag is a label that you can // apply to identity pools to categorize and manage them in different ways, such as // by purpose, owner, environment, or other criteria. IdentityPoolTags map[string]*string - // An identity pool ID in the format REGION:GUID. - // - // This member is required. - IdentityPoolId *string - - // The "domain" by which Cognito will refer to your users. - DeveloperProviderName *string + // A list of OpendID Connect provider ARNs. + OpenIdConnectProviderARNs []*string - // A string that you provide. - // - // This member is required. - IdentityPoolName *string + // An array of Amazon Resource Names (ARNs) of the SAML provider for your identity + // pool. + SamlProviderARNs []*string // Optional key:value pairs mapping provider names to provider app IDs. SupportedLoginProviders map[string]*string - // TRUE if the identity pool supports unauthenticated logins. - // - // This member is required. - AllowUnauthenticatedIdentities *bool - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cognitoidentity/api_op_GetCredentialsForIdentity.go b/service/cognitoidentity/api_op_GetCredentialsForIdentity.go index 73b7aea3f9c..87894134816 100644 --- a/service/cognitoidentity/api_op_GetCredentialsForIdentity.go +++ b/service/cognitoidentity/api_op_GetCredentialsForIdentity.go @@ -64,6 +64,12 @@ type GetCredentialsForIdentityInput struct { // This member is required. IdentityId *string + // The Amazon Resource Name (ARN) of the role to be assumed when multiple roles + // were received in the token from the identity provider. For example, a SAML-based + // identity provider. This parameter is optional for identity providers that do not + // support role customization. + CustomRoleArn *string + // A set of optional name-value pairs that map provider names to provider tokens. // The name-value pair will follow the syntax "provider_name": // "provider_user_identifier". Logins should not be specified when trying to get @@ -74,23 +80,17 @@ type GetCredentialsForIdentityInput struct { // (http://docs.aws.amazon.com/cognito/latest/developerguide/external-identity-providers.html) // section of the Amazon Cognito Developer Guide. Logins map[string]*string - - // The Amazon Resource Name (ARN) of the role to be assumed when multiple roles - // were received in the token from the identity provider. For example, a SAML-based - // identity provider. This parameter is optional for identity providers that do not - // support role customization. - CustomRoleArn *string } // Returned in response to a successful GetCredentialsForIdentity operation. type GetCredentialsForIdentityOutput struct { - // A unique identifier in the format REGION:GUID. - IdentityId *string - // Credentials for the provided identity ID. Credentials *types.Credentials + // A unique identifier in the format REGION:GUID. + IdentityId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cognitoidentity/api_op_GetIdentityPoolRoles.go b/service/cognitoidentity/api_op_GetIdentityPoolRoles.go index 6fbdc2d33c4..2d54b4ca16c 100644 --- a/service/cognitoidentity/api_op_GetIdentityPoolRoles.go +++ b/service/cognitoidentity/api_op_GetIdentityPoolRoles.go @@ -68,15 +68,15 @@ type GetIdentityPoolRolesInput struct { // Returned in response to a successful GetIdentityPoolRoles operation. type GetIdentityPoolRolesOutput struct { + // An identity pool ID in the format REGION:GUID. + IdentityPoolId *string + // How users for a specific identity provider are to mapped to roles. This is a // String-to-RoleMapping () object map. The string identifies the identity // provider, for example, "graph.facebook.com" or // "cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id". RoleMappings map[string]*types.RoleMapping - // An identity pool ID in the format REGION:GUID. - IdentityPoolId *string - // The map of roles associated with this pool. Currently only authenticated and // unauthenticated roles are supported. Roles map[string]*string diff --git a/service/cognitoidentity/api_op_GetOpenIdToken.go b/service/cognitoidentity/api_op_GetOpenIdToken.go index bdf5f560f97..2c889001902 100644 --- a/service/cognitoidentity/api_op_GetOpenIdToken.go +++ b/service/cognitoidentity/api_op_GetOpenIdToken.go @@ -58,29 +58,29 @@ func (c *Client) GetOpenIdToken(ctx context.Context, params *GetOpenIdTokenInput // Input to the GetOpenIdToken action. type GetOpenIdTokenInput struct { + // A unique identifier in the format REGION:GUID. + // + // This member is required. + IdentityId *string + // A set of optional name-value pairs that map provider names to provider tokens. // When using graph.facebook.com and www.amazon.com, supply the access_token // returned from the provider's authflow. For accounts.google.com, an Amazon // Cognito user pool provider, or any other OpenId Connect provider, always include // the id_token. Logins map[string]*string - - // A unique identifier in the format REGION:GUID. - // - // This member is required. - IdentityId *string } // Returned in response to a successful GetOpenIdToken request. type GetOpenIdTokenOutput struct { - // An OpenID token, valid for 10 minutes. - Token *string - // A unique identifier in the format REGION:GUID. Note that the IdentityId returned // may not match the one passed on input. IdentityId *string + // An OpenID token, valid for 10 minutes. + Token *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cognitoidentity/api_op_GetOpenIdTokenForDeveloperIdentity.go b/service/cognitoidentity/api_op_GetOpenIdTokenForDeveloperIdentity.go index 4f7a6f7d49f..4d1d3db8ffe 100644 --- a/service/cognitoidentity/api_op_GetOpenIdTokenForDeveloperIdentity.go +++ b/service/cognitoidentity/api_op_GetOpenIdTokenForDeveloperIdentity.go @@ -74,9 +74,6 @@ type GetOpenIdTokenForDeveloperIdentityInput struct { // This member is required. IdentityPoolId *string - // A unique identifier in the format REGION:GUID. - IdentityId *string - // A set of optional name-value pairs that map provider names to provider tokens. // Each name-value pair represents a user from a public provider or developer // provider. If the user is from a developer provider, the name-value pair will @@ -90,6 +87,9 @@ type GetOpenIdTokenForDeveloperIdentityInput struct { // This member is required. Logins map[string]*string + // A unique identifier in the format REGION:GUID. + IdentityId *string + // The expiration time of the token, in seconds. You can specify a custom // expiration time for the token so that you can cache it. If you don't provide an // expiration time, the token is valid for 15 minutes. You can exchange the token diff --git a/service/cognitoidentity/api_op_ListIdentities.go b/service/cognitoidentity/api_op_ListIdentities.go index d712c1e809e..d66fe534df6 100644 --- a/service/cognitoidentity/api_op_ListIdentities.go +++ b/service/cognitoidentity/api_op_ListIdentities.go @@ -59,23 +59,23 @@ func (c *Client) ListIdentities(ctx context.Context, params *ListIdentitiesInput // Input to the ListIdentities action. type ListIdentitiesInput struct { - // A pagination token. - NextToken *string - - // The maximum number of identities to return. + // An identity pool ID in the format REGION:GUID. // // This member is required. - MaxResults *int32 + IdentityPoolId *string - // An identity pool ID in the format REGION:GUID. + // The maximum number of identities to return. // // This member is required. - IdentityPoolId *string + MaxResults *int32 // An optional boolean parameter that allows you to hide disabled identities. If // omitted, the ListIdentities API will include disabled identities in the // response. HideDisabled *bool + + // A pagination token. + NextToken *string } // The response to a ListIdentities request. @@ -84,12 +84,12 @@ type ListIdentitiesOutput struct { // An object containing a set of identities and associated mappings. Identities []*types.IdentityDescription - // A pagination token. - NextToken *string - // An identity pool ID in the format REGION:GUID. IdentityPoolId *string + // A pagination token. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cognitoidentity/api_op_ListIdentityPools.go b/service/cognitoidentity/api_op_ListIdentityPools.go index 662860b1bbc..227bb86e9b3 100644 --- a/service/cognitoidentity/api_op_ListIdentityPools.go +++ b/service/cognitoidentity/api_op_ListIdentityPools.go @@ -71,12 +71,12 @@ type ListIdentityPoolsInput struct { // The result of a successful ListIdentityPools action. type ListIdentityPoolsOutput struct { - // A pagination token. - NextToken *string - // The identity pools returned by the ListIdentityPools action. IdentityPools []*types.IdentityPoolShortDescription + // A pagination token. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cognitoidentity/api_op_LookupDeveloperIdentity.go b/service/cognitoidentity/api_op_LookupDeveloperIdentity.go index 06437585071..be5edbf5088 100644 --- a/service/cognitoidentity/api_op_LookupDeveloperIdentity.go +++ b/service/cognitoidentity/api_op_LookupDeveloperIdentity.go @@ -70,14 +70,6 @@ func (c *Client) LookupDeveloperIdentity(ctx context.Context, params *LookupDeve // Input to the LookupDeveloperIdentityInput action. type LookupDeveloperIdentityInput struct { - // A pagination token. The first call you make will have NextToken set to null. - // After that the service will return NextToken values as needed. For example, - // let's say you make a request with MaxResults set to 10, and there are 20 matches - // in the database. The service will return a pagination token as a part of the - // response. This token can be used to call the API again and get results starting - // from the 11th match. - NextToken *string - // An identity pool ID in the format REGION:GUID. // // This member is required. @@ -88,16 +80,29 @@ type LookupDeveloperIdentityInput struct { // identifiers, in keeping with the number of users. DeveloperUserIdentifier *string + // A unique identifier in the format REGION:GUID. + IdentityId *string + // The maximum number of identities to return. MaxResults *int32 - // A unique identifier in the format REGION:GUID. - IdentityId *string + // A pagination token. The first call you make will have NextToken set to null. + // After that the service will return NextToken values as needed. For example, + // let's say you make a request with MaxResults set to 10, and there are 20 matches + // in the database. The service will return a pagination token as a part of the + // response. This token can be used to call the API again and get results starting + // from the 11th match. + NextToken *string } // Returned in response to a successful LookupDeveloperIdentity action. type LookupDeveloperIdentityOutput struct { + // This is the list of developer user identifiers associated with an identity ID. + // Cognito supports the association of multiple developer user identifiers with an + // identity ID. + DeveloperUserIdentifierList []*string + // A unique identifier in the format REGION:GUID. IdentityId *string @@ -109,11 +114,6 @@ type LookupDeveloperIdentityOutput struct { // from the 11th match. NextToken *string - // This is the list of developer user identifiers associated with an identity ID. - // Cognito supports the association of multiple developer user identifiers with an - // identity ID. - DeveloperUserIdentifierList []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cognitoidentity/api_op_MergeDeveloperIdentities.go b/service/cognitoidentity/api_op_MergeDeveloperIdentities.go index 48b94f1a8c4..54ba8789707 100644 --- a/service/cognitoidentity/api_op_MergeDeveloperIdentities.go +++ b/service/cognitoidentity/api_op_MergeDeveloperIdentities.go @@ -83,16 +83,16 @@ type MergeDeveloperIdentitiesInput struct { // This member is required. DeveloperProviderName *string - // User identifier for the source user. The value should be a - // DeveloperUserIdentifier. + // An identity pool ID in the format REGION:GUID. // // This member is required. - SourceUserIdentifier *string + IdentityPoolId *string - // An identity pool ID in the format REGION:GUID. + // User identifier for the source user. The value should be a + // DeveloperUserIdentifier. // // This member is required. - IdentityPoolId *string + SourceUserIdentifier *string } // Returned in response to a successful MergeDeveloperIdentities action. diff --git a/service/cognitoidentity/api_op_SetIdentityPoolRoles.go b/service/cognitoidentity/api_op_SetIdentityPoolRoles.go index 676bf31f05f..5278cc87a13 100644 --- a/service/cognitoidentity/api_op_SetIdentityPoolRoles.go +++ b/service/cognitoidentity/api_op_SetIdentityPoolRoles.go @@ -60,16 +60,16 @@ func (c *Client) SetIdentityPoolRoles(ctx context.Context, params *SetIdentityPo // Input to the SetIdentityPoolRoles action. type SetIdentityPoolRolesInput struct { - // The map of roles associated with this pool. For a given role, the key will be - // either "authenticated" or "unauthenticated" and the value will be the Role ARN. + // An identity pool ID in the format REGION:GUID. // // This member is required. - Roles map[string]*string + IdentityPoolId *string - // An identity pool ID in the format REGION:GUID. + // The map of roles associated with this pool. For a given role, the key will be + // either "authenticated" or "unauthenticated" and the value will be the Role ARN. // // This member is required. - IdentityPoolId *string + Roles map[string]*string // How users for a specific identity provider are to mapped to roles. This is a // string to RoleMapping () object map. The string identifies the identity diff --git a/service/cognitoidentity/api_op_TagResource.go b/service/cognitoidentity/api_op_TagResource.go index 297a4c1e389..0f8e0bad336 100644 --- a/service/cognitoidentity/api_op_TagResource.go +++ b/service/cognitoidentity/api_op_TagResource.go @@ -68,15 +68,15 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The tags to assign to the identity pool. + // The Amazon Resource Name (ARN) of the identity pool to assign the tags to. // // This member is required. - Tags map[string]*string + ResourceArn *string - // The Amazon Resource Name (ARN) of the identity pool to assign the tags to. + // The tags to assign to the identity pool. // // This member is required. - ResourceArn *string + Tags map[string]*string } type TagResourceOutput struct { diff --git a/service/cognitoidentity/api_op_UnlinkDeveloperIdentity.go b/service/cognitoidentity/api_op_UnlinkDeveloperIdentity.go index cf68156c08f..ed6e74d9e78 100644 --- a/service/cognitoidentity/api_op_UnlinkDeveloperIdentity.go +++ b/service/cognitoidentity/api_op_UnlinkDeveloperIdentity.go @@ -61,25 +61,25 @@ func (c *Client) UnlinkDeveloperIdentity(ctx context.Context, params *UnlinkDeve // Input to the UnlinkDeveloperIdentity action. type UnlinkDeveloperIdentityInput struct { - // An identity pool ID in the format REGION:GUID. + // The "domain" by which Cognito will refer to your users. // // This member is required. - IdentityPoolId *string + DeveloperProviderName *string - // A unique identifier in the format REGION:GUID. + // A unique ID used by your backend authentication process to identify a user. // // This member is required. - IdentityId *string + DeveloperUserIdentifier *string - // A unique ID used by your backend authentication process to identify a user. + // A unique identifier in the format REGION:GUID. // // This member is required. - DeveloperUserIdentifier *string + IdentityId *string - // The "domain" by which Cognito will refer to your users. + // An identity pool ID in the format REGION:GUID. // // This member is required. - DeveloperProviderName *string + IdentityPoolId *string } type UnlinkDeveloperIdentityOutput struct { diff --git a/service/cognitoidentity/api_op_UnlinkIdentity.go b/service/cognitoidentity/api_op_UnlinkIdentity.go index 5f1ec342327..5a6a04ff914 100644 --- a/service/cognitoidentity/api_op_UnlinkIdentity.go +++ b/service/cognitoidentity/api_op_UnlinkIdentity.go @@ -57,15 +57,15 @@ func (c *Client) UnlinkIdentity(ctx context.Context, params *UnlinkIdentityInput // Input to the UnlinkIdentity action. type UnlinkIdentityInput struct { - // A set of optional name-value pairs that map provider names to provider tokens. + // A unique identifier in the format REGION:GUID. // // This member is required. - Logins map[string]*string + IdentityId *string - // A unique identifier in the format REGION:GUID. + // A set of optional name-value pairs that map provider names to provider tokens. // // This member is required. - IdentityId *string + Logins map[string]*string // Provider names to unlink from this identity. // diff --git a/service/cognitoidentity/api_op_UntagResource.go b/service/cognitoidentity/api_op_UntagResource.go index 95c0c196244..1c7b0a49f94 100644 --- a/service/cognitoidentity/api_op_UntagResource.go +++ b/service/cognitoidentity/api_op_UntagResource.go @@ -57,16 +57,16 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The keys of the tags to remove from the user pool. - // - // This member is required. - TagKeys []*string - // The Amazon Resource Name (ARN) of the identity pool that the tags are assigned // to. // // This member is required. ResourceArn *string + + // The keys of the tags to remove from the user pool. + // + // This member is required. + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/cognitoidentity/api_op_UpdateIdentityPool.go b/service/cognitoidentity/api_op_UpdateIdentityPool.go index 0dc370783d0..9ec0a6959c4 100644 --- a/service/cognitoidentity/api_op_UpdateIdentityPool.go +++ b/service/cognitoidentity/api_op_UpdateIdentityPool.go @@ -59,6 +59,21 @@ func (c *Client) UpdateIdentityPool(ctx context.Context, params *UpdateIdentityP // An object representing an Amazon Cognito identity pool. type UpdateIdentityPoolInput struct { + // TRUE if the identity pool supports unauthenticated logins. + // + // This member is required. + AllowUnauthenticatedIdentities *bool + + // An identity pool ID in the format REGION:GUID. + // + // This member is required. + IdentityPoolId *string + + // A string that you provide. + // + // This member is required. + IdentityPoolName *string + // Enables or disables the Basic (Classic) authentication flow. For more // information, see Identity Pools (Federated Identities) Authentication Flow // (https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html) @@ -68,42 +83,42 @@ type UpdateIdentityPoolInput struct { // A list representing an Amazon Cognito user pool and its client ID. CognitoIdentityProviders []*types.CognitoIdentityProvider - // An array of Amazon Resource Names (ARNs) of the SAML provider for your identity - // pool. - SamlProviderARNs []*string - - // A list of OpendID Connect provider ARNs. - OpenIdConnectProviderARNs []*string + // The "domain" by which Cognito will refer to your users. + DeveloperProviderName *string // The tags that are assigned to the identity pool. A tag is a label that you can // apply to identity pools to categorize and manage them in different ways, such as // by purpose, owner, environment, or other criteria. IdentityPoolTags map[string]*string - // An identity pool ID in the format REGION:GUID. - // - // This member is required. - IdentityPoolId *string - - // The "domain" by which Cognito will refer to your users. - DeveloperProviderName *string + // A list of OpendID Connect provider ARNs. + OpenIdConnectProviderARNs []*string - // A string that you provide. - // - // This member is required. - IdentityPoolName *string + // An array of Amazon Resource Names (ARNs) of the SAML provider for your identity + // pool. + SamlProviderARNs []*string // Optional key:value pairs mapping provider names to provider app IDs. SupportedLoginProviders map[string]*string +} + +// An object representing an Amazon Cognito identity pool. +type UpdateIdentityPoolOutput struct { // TRUE if the identity pool supports unauthenticated logins. // // This member is required. AllowUnauthenticatedIdentities *bool -} -// An object representing an Amazon Cognito identity pool. -type UpdateIdentityPoolOutput struct { + // An identity pool ID in the format REGION:GUID. + // + // This member is required. + IdentityPoolId *string + + // A string that you provide. + // + // This member is required. + IdentityPoolName *string // Enables or disables the Basic (Classic) authentication flow. For more // information, see Identity Pools (Federated Identities) Authentication Flow @@ -114,39 +129,24 @@ type UpdateIdentityPoolOutput struct { // A list representing an Amazon Cognito user pool and its client ID. CognitoIdentityProviders []*types.CognitoIdentityProvider - // An array of Amazon Resource Names (ARNs) of the SAML provider for your identity - // pool. - SamlProviderARNs []*string - - // A list of OpendID Connect provider ARNs. - OpenIdConnectProviderARNs []*string + // The "domain" by which Cognito will refer to your users. + DeveloperProviderName *string // The tags that are assigned to the identity pool. A tag is a label that you can // apply to identity pools to categorize and manage them in different ways, such as // by purpose, owner, environment, or other criteria. IdentityPoolTags map[string]*string - // An identity pool ID in the format REGION:GUID. - // - // This member is required. - IdentityPoolId *string - - // The "domain" by which Cognito will refer to your users. - DeveloperProviderName *string + // A list of OpendID Connect provider ARNs. + OpenIdConnectProviderARNs []*string - // A string that you provide. - // - // This member is required. - IdentityPoolName *string + // An array of Amazon Resource Names (ARNs) of the SAML provider for your identity + // pool. + SamlProviderARNs []*string // Optional key:value pairs mapping provider names to provider app IDs. SupportedLoginProviders map[string]*string - // TRUE if the identity pool supports unauthenticated logins. - // - // This member is required. - AllowUnauthenticatedIdentities *bool - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cognitoidentity/go.mod b/service/cognitoidentity/go.mod index 600ec2dee66..21f3d98c090 100644 --- a/service/cognitoidentity/go.mod +++ b/service/cognitoidentity/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/cognitoidentity go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/cognitoidentity/types/types.go b/service/cognitoidentity/types/types.go index 2d8ba167772..cce5a70c277 100644 --- a/service/cognitoidentity/types/types.go +++ b/service/cognitoidentity/types/types.go @@ -28,15 +28,15 @@ type CognitoIdentityProvider struct { // Credentials for the provided identity ID. type Credentials struct { - // The Secret Access Key portion of the credentials - SecretKey *string - // The Access Key portion of the credentials. AccessKeyId *string // The date at which these credentials will expire. Expiration *time.Time + // The Secret Access Key portion of the credentials + SecretKey *string + // The Session Token portion of the credentials SessionToken *string } @@ -44,15 +44,15 @@ type Credentials struct { // A description of the identity. type IdentityDescription struct { - // Date on which the identity was last modified. - LastModifiedDate *time.Time - // Date on which the identity was created. CreationDate *time.Time // A unique identifier in the format REGION:GUID. IdentityId *string + // Date on which the identity was last modified. + LastModifiedDate *time.Time + // The provider names. Logins []*string } @@ -60,11 +60,11 @@ type IdentityDescription struct { // A description of the identity pool. type IdentityPoolShortDescription struct { - // A string that you provide. - IdentityPoolName *string - // An identity pool ID in the format REGION:GUID. IdentityPoolId *string + + // A string that you provide. + IdentityPoolName *string } // A rule that maps a claim name, a claim value, and a match type to a role ARN. @@ -76,17 +76,17 @@ type MappingRule struct { // This member is required. Claim *string - // The role ARN. - // - // This member is required. - RoleARN *string - // The match condition that specifies how closely the claim value in the IdP token // must match Value. // // This member is required. MatchType MappingRuleMatchType + // The role ARN. + // + // This member is required. + RoleARN *string + // A brief string that the claim must match, for example, "paid" or "yes". // // This member is required. @@ -103,15 +103,15 @@ type RoleMapping struct { // This member is required. Type RoleMappingType - // The rules to be used for mapping users to roles. If you specify Rules as the - // role mapping type, RulesConfiguration is required. - RulesConfiguration *RulesConfigurationType - // If you specify Token or Rules as the Type, AmbiguousRoleResolution is required. // Specifies the action to be taken if either no rules match the claim value for // the Rules type, or there is no cognito:preferred_role claim and there are // multiple cognito:roles matches for the Token type. AmbiguousRoleResolution AmbiguousRoleResolutionType + + // The rules to be used for mapping users to roles. If you specify Rules as the + // role mapping type, RulesConfiguration is required. + RulesConfiguration *RulesConfigurationType } // A container for rules. diff --git a/service/cognitoidentityprovider/api_op_AddCustomAttributes.go b/service/cognitoidentityprovider/api_op_AddCustomAttributes.go index 25d3ee77f70..b040a0ced52 100644 --- a/service/cognitoidentityprovider/api_op_AddCustomAttributes.go +++ b/service/cognitoidentityprovider/api_op_AddCustomAttributes.go @@ -58,15 +58,15 @@ func (c *Client) AddCustomAttributes(ctx context.Context, params *AddCustomAttri // Represents the request to add custom attributes. type AddCustomAttributesInput struct { - // The user pool ID for the user pool where you want to add custom attributes. + // An array of custom attributes, such as Mutable and Name. // // This member is required. - UserPoolId *string + CustomAttributes []*types.SchemaAttributeType - // An array of custom attributes, such as Mutable and Name. + // The user pool ID for the user pool where you want to add custom attributes. // // This member is required. - CustomAttributes []*types.SchemaAttributeType + UserPoolId *string } // Represents the response from the server for the request to add custom diff --git a/service/cognitoidentityprovider/api_op_AdminAddUserToGroup.go b/service/cognitoidentityprovider/api_op_AdminAddUserToGroup.go index e7a30c0ba2b..6864be7fe7c 100644 --- a/service/cognitoidentityprovider/api_op_AdminAddUserToGroup.go +++ b/service/cognitoidentityprovider/api_op_AdminAddUserToGroup.go @@ -57,15 +57,15 @@ func (c *Client) AdminAddUserToGroup(ctx context.Context, params *AdminAddUserTo type AdminAddUserToGroupInput struct { - // The user pool ID for the user pool. + // The group name. // // This member is required. - UserPoolId *string + GroupName *string - // The group name. + // The user pool ID for the user pool. // // This member is required. - GroupName *string + UserPoolId *string // The username for the user. // diff --git a/service/cognitoidentityprovider/api_op_AdminConfirmSignUp.go b/service/cognitoidentityprovider/api_op_AdminConfirmSignUp.go index f6e92de304f..c68e6571a58 100644 --- a/service/cognitoidentityprovider/api_op_AdminConfirmSignUp.go +++ b/service/cognitoidentityprovider/api_op_AdminConfirmSignUp.go @@ -58,15 +58,15 @@ func (c *Client) AdminConfirmSignUp(ctx context.Context, params *AdminConfirmSig // Represents the request to confirm user registration. type AdminConfirmSignUpInput struct { - // The user name for which you want to confirm user registration. + // The user pool ID for which you want to confirm user registration. // // This member is required. - Username *string + UserPoolId *string - // The user pool ID for which you want to confirm user registration. + // The user name for which you want to confirm user registration. // // This member is required. - UserPoolId *string + Username *string // A map of custom key-value pairs that you can provide as input for any custom // workflows that this action triggers. If your user pool configuration includes diff --git a/service/cognitoidentityprovider/api_op_AdminCreateUser.go b/service/cognitoidentityprovider/api_op_AdminCreateUser.go index 1b2ab0a2abe..74f372d76ce 100644 --- a/service/cognitoidentityprovider/api_op_AdminCreateUser.go +++ b/service/cognitoidentityprovider/api_op_AdminCreateUser.go @@ -65,6 +65,18 @@ func (c *Client) AdminCreateUser(ctx context.Context, params *AdminCreateUserInp // Represents the request to create a user in the specified user pool. type AdminCreateUserInput struct { + // The user pool ID for the user pool where the user will be created. + // + // This member is required. + UserPoolId *string + + // The username for the user. Must be unique within the user pool. Must be a UTF-8 + // string between 1 and 128 characters. After the user is created, the username + // cannot be changed. + // + // This member is required. + Username *string + // A map of custom key-value pairs that you can provide as input for any custom // workflows that this action triggers. You create custom workflows by assigning // AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API @@ -93,6 +105,11 @@ type AdminCreateUserInput struct { // ClientMetadata value, so don't use it to provide sensitive information. ClientMetadata map[string]*string + // Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" + // if the phone number will be used. The default value is "SMS". More than one + // value can be specified. + DesiredDeliveryMediums []types.DeliveryMediumType + // This parameter is only used if the phone_number_verified or email_verified // attribute is set to True. Otherwise, it is ignored. If this parameter is set to // True and the phone number or email address specified in the UserAttributes @@ -108,27 +125,16 @@ type AdminCreateUserInput struct { // suppress sending the message. Only one value can be specified. MessageAction types.MessageActionType - // The user's validation data. This is an array of name-value pairs that contain - // user attributes and attribute values that you can use for custom validation, - // such as restricting the types of user accounts that can be registered. For - // example, you might choose to allow or disallow user sign-up based on the user's - // domain. To configure custom validation, you must create a Pre Sign-up Lambda - // trigger for the user pool as described in the Amazon Cognito Developer Guide. - // The Lambda trigger receives the validation data and uses it in the validation - // process. The user's validation data is not persisted. - ValidationData []*types.AttributeType - - // The user pool ID for the user pool where the user will be created. - // - // This member is required. - UserPoolId *string - - // The username for the user. Must be unique within the user pool. Must be a UTF-8 - // string between 1 and 128 characters. After the user is created, the username - // cannot be changed. - // - // This member is required. - Username *string + // The user's temporary password. This password must conform to the password policy + // that you specified when you created the user pool. The temporary password is + // valid only once. To complete the Admin Create User flow, the user must enter the + // temporary password in the sign-in page along with a new password to be used in + // all future sign-ins. This parameter is not required. If you do not specify a + // value, Amazon Cognito generates one for you. The temporary password can only be + // used until the user account expiration limit that you specified when you created + // the user pool. To reset the account after that time limit, you must call + // AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. + TemporaryPassword *string // An array of name-value pairs that contain user attributes and attribute values // to be set for the user to be created. You can create a user without specifying @@ -155,21 +161,15 @@ type AdminCreateUserInput struct { // parameter. UserAttributes []*types.AttributeType - // The user's temporary password. This password must conform to the password policy - // that you specified when you created the user pool. The temporary password is - // valid only once. To complete the Admin Create User flow, the user must enter the - // temporary password in the sign-in page along with a new password to be used in - // all future sign-ins. This parameter is not required. If you do not specify a - // value, Amazon Cognito generates one for you. The temporary password can only be - // used until the user account expiration limit that you specified when you created - // the user pool. To reset the account after that time limit, you must call - // AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. - TemporaryPassword *string - - // Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" - // if the phone number will be used. The default value is "SMS". More than one - // value can be specified. - DesiredDeliveryMediums []types.DeliveryMediumType + // The user's validation data. This is an array of name-value pairs that contain + // user attributes and attribute values that you can use for custom validation, + // such as restricting the types of user accounts that can be registered. For + // example, you might choose to allow or disallow user sign-up based on the user's + // domain. To configure custom validation, you must create a Pre Sign-up Lambda + // trigger for the user pool as described in the Amazon Cognito Developer Guide. + // The Lambda trigger receives the validation data and uses it in the validation + // process. The user's validation data is not persisted. + ValidationData []*types.AttributeType } // Represents the response from the server to the request to create the user. diff --git a/service/cognitoidentityprovider/api_op_AdminEnableUser.go b/service/cognitoidentityprovider/api_op_AdminEnableUser.go index f220378e3d2..b1f76253ddc 100644 --- a/service/cognitoidentityprovider/api_op_AdminEnableUser.go +++ b/service/cognitoidentityprovider/api_op_AdminEnableUser.go @@ -58,15 +58,15 @@ func (c *Client) AdminEnableUser(ctx context.Context, params *AdminEnableUserInp // Represents the request that enables the user as an administrator. type AdminEnableUserInput struct { - // The user name of the user you wish to enable. + // The user pool ID for the user pool where you want to enable the user. // // This member is required. - Username *string + UserPoolId *string - // The user pool ID for the user pool where you want to enable the user. + // The user name of the user you wish to enable. // // This member is required. - UserPoolId *string + Username *string } // Represents the response from the server for the request to enable a user as an diff --git a/service/cognitoidentityprovider/api_op_AdminForgetDevice.go b/service/cognitoidentityprovider/api_op_AdminForgetDevice.go index b49550473f6..4fee75971da 100644 --- a/service/cognitoidentityprovider/api_op_AdminForgetDevice.go +++ b/service/cognitoidentityprovider/api_op_AdminForgetDevice.go @@ -63,15 +63,15 @@ type AdminForgetDeviceInput struct { // This member is required. DeviceKey *string - // The user name. + // The user pool ID. // // This member is required. - Username *string + UserPoolId *string - // The user pool ID. + // The user name. // // This member is required. - UserPoolId *string + Username *string } type AdminForgetDeviceOutput struct { diff --git a/service/cognitoidentityprovider/api_op_AdminGetDevice.go b/service/cognitoidentityprovider/api_op_AdminGetDevice.go index 7d1abfcc807..4e6908f65fa 100644 --- a/service/cognitoidentityprovider/api_op_AdminGetDevice.go +++ b/service/cognitoidentityprovider/api_op_AdminGetDevice.go @@ -59,11 +59,6 @@ func (c *Client) AdminGetDevice(ctx context.Context, params *AdminGetDeviceInput // Represents the request to get the device, as an administrator. type AdminGetDeviceInput struct { - // The user name. - // - // This member is required. - Username *string - // The device key. // // This member is required. @@ -73,6 +68,11 @@ type AdminGetDeviceInput struct { // // This member is required. UserPoolId *string + + // The user name. + // + // This member is required. + Username *string } // Gets the device response, as an administrator. diff --git a/service/cognitoidentityprovider/api_op_AdminGetUser.go b/service/cognitoidentityprovider/api_op_AdminGetUser.go index 764fcd6c47a..da56a173cc5 100644 --- a/service/cognitoidentityprovider/api_op_AdminGetUser.go +++ b/service/cognitoidentityprovider/api_op_AdminGetUser.go @@ -76,27 +76,37 @@ type AdminGetUserInput struct { // user as an administrator. type AdminGetUserOutput struct { - // The user's preferred MFA setting. - PreferredMfaSetting *string - - // The date the user was created. - UserCreateDate *time.Time - // The user name of the user about whom you are receiving information. // // This member is required. Username *string - // The MFA options that are enabled for the user. The possible values in this list - // are SMS_MFA and SOFTWARE_TOKEN_MFA. - UserMFASettingList []*string - // Indicates that the status is enabled. Enabled *bool + // This response parameter is no longer supported. It provides information only + // about SMS MFA configurations. It doesn't provide information about TOTP software + // token MFA configurations. To look up information about either type of MFA + // configuration, use the AdminGetUserResponse$UserMFASettingList () response + // instead. + MFAOptions []*types.MFAOptionType + + // The user's preferred MFA setting. + PreferredMfaSetting *string + // An array of name-value pairs representing user attributes. UserAttributes []*types.AttributeType + // The date the user was created. + UserCreateDate *time.Time + + // The date the user was last modified. + UserLastModifiedDate *time.Time + + // The MFA options that are enabled for the user. The possible values in this list + // are SMS_MFA and SOFTWARE_TOKEN_MFA. + UserMFASettingList []*string + // The user status. Can be one of the following: // // * UNCONFIRMED - User has been @@ -122,16 +132,6 @@ type AdminGetUserOutput struct { // doing anything else. UserStatus types.UserStatusType - // This response parameter is no longer supported. It provides information only - // about SMS MFA configurations. It doesn't provide information about TOTP software - // token MFA configurations. To look up information about either type of MFA - // configuration, use the AdminGetUserResponse$UserMFASettingList () response - // instead. - MFAOptions []*types.MFAOptionType - - // The date the user was last modified. - UserLastModifiedDate *time.Time - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cognitoidentityprovider/api_op_AdminInitiateAuth.go b/service/cognitoidentityprovider/api_op_AdminInitiateAuth.go index 94e258225a9..20590eaeb6a 100644 --- a/service/cognitoidentityprovider/api_op_AdminInitiateAuth.go +++ b/service/cognitoidentityprovider/api_op_AdminInitiateAuth.go @@ -101,11 +101,40 @@ type AdminInitiateAuthInput struct { // This member is required. AuthFlow types.AuthFlowType + // The app client ID. + // + // This member is required. + ClientId *string + // The ID of the Amazon Cognito user pool. // // This member is required. UserPoolId *string + // The analytics metadata for collecting Amazon Pinpoint metrics for + // AdminInitiateAuth calls. + AnalyticsMetadata *types.AnalyticsMetadataType + + // The authentication parameters. These are inputs corresponding to the AuthFlow + // that you are invoking. The required values depend on the value of AuthFlow: + // + // + // * For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH + // (required if the app client is configured with a client secret), DEVICE_KEY + // + // + // * For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH + // (required if the app client is configured with a client secret), DEVICE_KEY + // + // + // * For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is + // configured with client secret), PASSWORD (required), DEVICE_KEY + // + // * For + // CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with + // client secret), DEVICE_KEY + AuthParameters map[string]*string + // A map of custom key-value pairs that you can provide as input for certain custom // workflows that this action triggers. You create custom workflows by assigning // AWS Lambda functions to user pool triggers. When you use the AdminInitiateAuth @@ -146,39 +175,10 @@ type AdminInitiateAuthInput struct { // ClientMetadata map[string]*string - // The analytics metadata for collecting Amazon Pinpoint metrics for - // AdminInitiateAuth calls. - AnalyticsMetadata *types.AnalyticsMetadataType - // Contextual data such as the user's device fingerprint, IP address, or location // used for evaluating the risk of an unexpected event by Amazon Cognito advanced // security. ContextData *types.ContextDataType - - // The authentication parameters. These are inputs corresponding to the AuthFlow - // that you are invoking. The required values depend on the value of AuthFlow: - // - // - // * For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH - // (required if the app client is configured with a client secret), DEVICE_KEY - // - // - // * For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH - // (required if the app client is configured with a client secret), DEVICE_KEY - // - // - // * For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is - // configured with client secret), PASSWORD (required), DEVICE_KEY - // - // * For - // CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with - // client secret), DEVICE_KEY - AuthParameters map[string]*string - - // The app client ID. - // - // This member is required. - ClientId *string } // Initiates the authentication response, as an administrator. @@ -231,13 +231,6 @@ type AdminInitiateAuthOutput struct { // and any other required attributes. ChallengeName types.ChallengeNameType - // The session which should be passed both ways in challenge-response calls to the - // service. If AdminInitiateAuth or AdminRespondToAuthChallenge API call determines - // that the caller needs to go through another challenge, they return a session - // with other challenge parameters. This session should be passed as it is to the - // next AdminRespondToAuthChallenge API call. - Session *string - // The challenge parameters. These are returned to you in the AdminInitiateAuth // response if you need to pass another challenge. The responses in this parameter // should be used to compute inputs to the next call (AdminRespondToAuthChallenge). @@ -248,6 +241,13 @@ type AdminInitiateAuthOutput struct { // API ChallengeResponses, the USERNAME attribute cannot be an alias. ChallengeParameters map[string]*string + // The session which should be passed both ways in challenge-response calls to the + // service. If AdminInitiateAuth or AdminRespondToAuthChallenge API call determines + // that the caller needs to go through another challenge, they return a session + // with other challenge parameters. This session should be passed as it is to the + // next AdminRespondToAuthChallenge API call. + Session *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cognitoidentityprovider/api_op_AdminLinkProviderForUser.go b/service/cognitoidentityprovider/api_op_AdminLinkProviderForUser.go index 3dc13d368f1..4032ddbcf43 100644 --- a/service/cognitoidentityprovider/api_op_AdminLinkProviderForUser.go +++ b/service/cognitoidentityprovider/api_op_AdminLinkProviderForUser.go @@ -83,11 +83,6 @@ type AdminLinkProviderForUserInput struct { // This member is required. DestinationUser *types.ProviderUserIdentifierType - // The user pool ID for the user pool. - // - // This member is required. - UserPoolId *string - // An external identity provider account for a user who does not currently exist // yet in the user pool. This user must be a federated user (for example, a SAML or // Facebook user), not another native user. If the SourceUser is a federated social @@ -107,6 +102,11 @@ type AdminLinkProviderForUserInput struct { // // This member is required. SourceUser *types.ProviderUserIdentifierType + + // The user pool ID for the user pool. + // + // This member is required. + UserPoolId *string } type AdminLinkProviderForUserOutput struct { diff --git a/service/cognitoidentityprovider/api_op_AdminListDevices.go b/service/cognitoidentityprovider/api_op_AdminListDevices.go index aa4c4d8187a..71b57d84f64 100644 --- a/service/cognitoidentityprovider/api_op_AdminListDevices.go +++ b/service/cognitoidentityprovider/api_op_AdminListDevices.go @@ -69,22 +69,22 @@ type AdminListDevicesInput struct { // This member is required. Username *string - // The pagination token. - PaginationToken *string - // The limit of the devices request. Limit *int32 + + // The pagination token. + PaginationToken *string } // Lists the device's response, as an administrator. type AdminListDevicesOutput struct { - // The pagination token. - PaginationToken *string - // The devices in the list of devices response. Devices []*types.DeviceType + // The pagination token. + PaginationToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cognitoidentityprovider/api_op_AdminListGroupsForUser.go b/service/cognitoidentityprovider/api_op_AdminListGroupsForUser.go index 30f8d15a565..dad5f947dc8 100644 --- a/service/cognitoidentityprovider/api_op_AdminListGroupsForUser.go +++ b/service/cognitoidentityprovider/api_op_AdminListGroupsForUser.go @@ -68,23 +68,23 @@ type AdminListGroupsForUserInput struct { // This member is required. Username *string + // The limit of the request to list groups. + Limit *int32 + // An identifier that was returned from the previous call to this operation, which // can be used to return the next set of items in the list. NextToken *string - - // The limit of the request to list groups. - Limit *int32 } type AdminListGroupsForUserOutput struct { + // The groups that the user belongs to. + Groups []*types.GroupType + // An identifier that was returned from the previous call to this operation, which // can be used to return the next set of items in the list. NextToken *string - // The groups that the user belongs to. - Groups []*types.GroupType - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cognitoidentityprovider/api_op_AdminListUserAuthEvents.go b/service/cognitoidentityprovider/api_op_AdminListUserAuthEvents.go index 7b9add37ceb..81a35a452b3 100644 --- a/service/cognitoidentityprovider/api_op_AdminListUserAuthEvents.go +++ b/service/cognitoidentityprovider/api_op_AdminListUserAuthEvents.go @@ -58,21 +58,21 @@ func (c *Client) AdminListUserAuthEvents(ctx context.Context, params *AdminListU type AdminListUserAuthEventsInput struct { - // The maximum number of authentication events to return. - MaxResults *int32 - - // A pagination token. - NextToken *string + // The user pool ID. + // + // This member is required. + UserPoolId *string // The user pool username or an alias. // // This member is required. Username *string - // The user pool ID. - // - // This member is required. - UserPoolId *string + // The maximum number of authentication events to return. + MaxResults *int32 + + // A pagination token. + NextToken *string } type AdminListUserAuthEventsOutput struct { diff --git a/service/cognitoidentityprovider/api_op_AdminRemoveUserFromGroup.go b/service/cognitoidentityprovider/api_op_AdminRemoveUserFromGroup.go index e7e40f0b361..7746cad77c5 100644 --- a/service/cognitoidentityprovider/api_op_AdminRemoveUserFromGroup.go +++ b/service/cognitoidentityprovider/api_op_AdminRemoveUserFromGroup.go @@ -57,20 +57,20 @@ func (c *Client) AdminRemoveUserFromGroup(ctx context.Context, params *AdminRemo type AdminRemoveUserFromGroupInput struct { - // The username for the user. + // The group name. // // This member is required. - Username *string + GroupName *string // The user pool ID for the user pool. // // This member is required. UserPoolId *string - // The group name. + // The username for the user. // // This member is required. - GroupName *string + Username *string } type AdminRemoveUserFromGroupOutput struct { diff --git a/service/cognitoidentityprovider/api_op_AdminResetUserPassword.go b/service/cognitoidentityprovider/api_op_AdminResetUserPassword.go index 93985ca158a..99bccee43e6 100644 --- a/service/cognitoidentityprovider/api_op_AdminResetUserPassword.go +++ b/service/cognitoidentityprovider/api_op_AdminResetUserPassword.go @@ -71,6 +71,11 @@ type AdminResetUserPasswordInput struct { // This member is required. UserPoolId *string + // The user name of the user whose password you wish to reset. + // + // This member is required. + Username *string + // A map of custom key-value pairs that you can provide as input for any custom // workflows that this action triggers. You create custom workflows by assigning // AWS Lambda functions to user pool triggers. When you use the @@ -98,11 +103,6 @@ type AdminResetUserPasswordInput struct { // * Amazon Cognito does not encrypt the the // ClientMetadata value, so don't use it to provide sensitive information. ClientMetadata map[string]*string - - // The user name of the user whose password you wish to reset. - // - // This member is required. - Username *string } // Represents the response from the server to reset a user password as an diff --git a/service/cognitoidentityprovider/api_op_AdminRespondToAuthChallenge.go b/service/cognitoidentityprovider/api_op_AdminRespondToAuthChallenge.go index 51e0dd8cdc8..b947ce521c5 100644 --- a/service/cognitoidentityprovider/api_op_AdminRespondToAuthChallenge.go +++ b/service/cognitoidentityprovider/api_op_AdminRespondToAuthChallenge.go @@ -59,6 +59,50 @@ func (c *Client) AdminRespondToAuthChallenge(ctx context.Context, params *AdminR // The request to respond to the authentication challenge, as an administrator. type AdminRespondToAuthChallengeInput struct { + // The challenge name. For more information, see . + // + // This member is required. + ChallengeName types.ChallengeNameType + + // The app client ID. + // + // This member is required. + ClientId *string + + // The ID of the Amazon Cognito user pool. + // + // This member is required. + UserPoolId *string + + // The analytics metadata for collecting Amazon Pinpoint metrics for + // AdminRespondToAuthChallenge calls. + AnalyticsMetadata *types.AnalyticsMetadataType + + // The challenge responses. These are inputs corresponding to the value of + // ChallengeName, for example: + // + // * SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH + // (if app client is configured with client secret). + // + // * PASSWORD_VERIFIER: + // PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, + // SECRET_HASH (if app client is configured with client secret). + // + // * + // ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured + // with client secret). + // + // * NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other + // required attributes, USERNAME, SECRET_HASH (if app client is configured with + // client secret). + // + // The value of the USERNAME attribute must be the user's actual + // username, not an alias (such as email address or phone number). To make this + // easier, the AdminInitiateAuth response includes the actual username value in the + // USERNAMEUSER_ID_FOR_SRP attribute, even if you specified an alias in your call + // to AdminInitiateAuth. + ChallengeResponses map[string]*string + // A map of custom key-value pairs that you can provide as input for any custom // workflows that this action triggers. You create custom workflows by assigning // AWS Lambda functions to user pool triggers. When you use the @@ -90,75 +134,31 @@ type AdminRespondToAuthChallengeInput struct { // ClientMetadata value, so don't use it to provide sensitive information. ClientMetadata map[string]*string - // The challenge responses. These are inputs corresponding to the value of - // ChallengeName, for example: - // - // * SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH - // (if app client is configured with client secret). - // - // * PASSWORD_VERIFIER: - // PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, - // SECRET_HASH (if app client is configured with client secret). - // - // * - // ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured - // with client secret). - // - // * NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other - // required attributes, USERNAME, SECRET_HASH (if app client is configured with - // client secret). - // - // The value of the USERNAME attribute must be the user's actual - // username, not an alias (such as email address or phone number). To make this - // easier, the AdminInitiateAuth response includes the actual username value in the - // USERNAMEUSER_ID_FOR_SRP attribute, even if you specified an alias in your call - // to AdminInitiateAuth. - ChallengeResponses map[string]*string - // Contextual data such as the user's device fingerprint, IP address, or location // used for evaluating the risk of an unexpected event by Amazon Cognito advanced // security. ContextData *types.ContextDataType - // The challenge name. For more information, see . - // - // This member is required. - ChallengeName types.ChallengeNameType - - // The analytics metadata for collecting Amazon Pinpoint metrics for - // AdminRespondToAuthChallenge calls. - AnalyticsMetadata *types.AnalyticsMetadataType - // The session which should be passed both ways in challenge-response calls to the // service. If InitiateAuth or RespondToAuthChallenge API call determines that the // caller needs to go through another challenge, they return a session with other // challenge parameters. This session should be passed as it is to the next // RespondToAuthChallenge API call. Session *string - - // The ID of the Amazon Cognito user pool. - // - // This member is required. - UserPoolId *string - - // The app client ID. - // - // This member is required. - ClientId *string } // Responds to the authentication challenge, as an administrator. type AdminRespondToAuthChallengeOutput struct { - // The challenge parameters. For more information, see . - ChallengeParameters map[string]*string - // The result returned by the server in response to the authentication request. AuthenticationResult *types.AuthenticationResultType // The name of the challenge. For more information, see . ChallengeName types.ChallengeNameType + // The challenge parameters. For more information, see . + ChallengeParameters map[string]*string + // The session which should be passed both ways in challenge-response calls to the // service. If the or API call determines that the caller needs to go through // another challenge, they return a session with other challenge parameters. This diff --git a/service/cognitoidentityprovider/api_op_AdminSetUserMFAPreference.go b/service/cognitoidentityprovider/api_op_AdminSetUserMFAPreference.go index 40d4ee6a49d..e558f899ff6 100644 --- a/service/cognitoidentityprovider/api_op_AdminSetUserMFAPreference.go +++ b/service/cognitoidentityprovider/api_op_AdminSetUserMFAPreference.go @@ -61,9 +61,6 @@ func (c *Client) AdminSetUserMFAPreference(ctx context.Context, params *AdminSet type AdminSetUserMFAPreferenceInput struct { - // The SMS text message MFA settings. - SMSMfaSettings *types.SMSMfaSettingsType - // The user pool ID. // // This member is required. @@ -74,6 +71,9 @@ type AdminSetUserMFAPreferenceInput struct { // This member is required. Username *string + // The SMS text message MFA settings. + SMSMfaSettings *types.SMSMfaSettingsType + // The time-based one-time password software token MFA settings. SoftwareTokenMfaSettings *types.SoftwareTokenMfaSettingsType } diff --git a/service/cognitoidentityprovider/api_op_AdminSetUserPassword.go b/service/cognitoidentityprovider/api_op_AdminSetUserPassword.go index 5d1ee21ab8a..5b0d1ecbfa5 100644 --- a/service/cognitoidentityprovider/api_op_AdminSetUserPassword.go +++ b/service/cognitoidentityprovider/api_op_AdminSetUserPassword.go @@ -63,23 +63,23 @@ func (c *Client) AdminSetUserPassword(ctx context.Context, params *AdminSetUserP type AdminSetUserPasswordInput struct { - // The user pool ID for the user pool where you want to set the user's password. - // - // This member is required. - UserPoolId *string - // The password for the user. // // This member is required. Password *string - // True if the password is permanent, False if it is temporary. - Permanent *bool + // The user pool ID for the user pool where you want to set the user's password. + // + // This member is required. + UserPoolId *string // The user name of the user whose password you wish to set. // // This member is required. Username *string + + // True if the password is permanent, False if it is temporary. + Permanent *bool } type AdminSetUserPasswordOutput struct { diff --git a/service/cognitoidentityprovider/api_op_AdminSetUserSettings.go b/service/cognitoidentityprovider/api_op_AdminSetUserSettings.go index d91181308a1..72ad67a700d 100644 --- a/service/cognitoidentityprovider/api_op_AdminSetUserSettings.go +++ b/service/cognitoidentityprovider/api_op_AdminSetUserSettings.go @@ -61,11 +61,6 @@ func (c *Client) AdminSetUserSettings(ctx context.Context, params *AdminSetUserS // delivery medium. type AdminSetUserSettingsInput struct { - // The user name of the user that you are setting options for. - // - // This member is required. - Username *string - // You can use this parameter only to set an SMS configuration that uses SMS for // delivery. // @@ -76,6 +71,11 @@ type AdminSetUserSettingsInput struct { // // This member is required. UserPoolId *string + + // The user name of the user that you are setting options for. + // + // This member is required. + Username *string } // Represents the response from the server to set user settings as an diff --git a/service/cognitoidentityprovider/api_op_AdminUpdateAuthEventFeedback.go b/service/cognitoidentityprovider/api_op_AdminUpdateAuthEventFeedback.go index 9c3c7b04650..c51991fa72c 100644 --- a/service/cognitoidentityprovider/api_op_AdminUpdateAuthEventFeedback.go +++ b/service/cognitoidentityprovider/api_op_AdminUpdateAuthEventFeedback.go @@ -59,25 +59,25 @@ func (c *Client) AdminUpdateAuthEventFeedback(ctx context.Context, params *Admin type AdminUpdateAuthEventFeedbackInput struct { - // The user pool username. + // The authentication event ID. // // This member is required. - Username *string + EventId *string // The authentication event feedback value. // // This member is required. FeedbackValue types.FeedbackValueType - // The authentication event ID. + // The user pool ID. // // This member is required. - EventId *string + UserPoolId *string - // The user pool ID. + // The user pool username. // // This member is required. - UserPoolId *string + Username *string } type AdminUpdateAuthEventFeedbackOutput struct { diff --git a/service/cognitoidentityprovider/api_op_AdminUpdateDeviceStatus.go b/service/cognitoidentityprovider/api_op_AdminUpdateDeviceStatus.go index 0321186075a..f63907aa826 100644 --- a/service/cognitoidentityprovider/api_op_AdminUpdateDeviceStatus.go +++ b/service/cognitoidentityprovider/api_op_AdminUpdateDeviceStatus.go @@ -59,23 +59,23 @@ func (c *Client) AdminUpdateDeviceStatus(ctx context.Context, params *AdminUpdat // The request to update the device status, as an administrator. type AdminUpdateDeviceStatusInput struct { + // The device key. + // + // This member is required. + DeviceKey *string + // The user pool ID. // // This member is required. UserPoolId *string - // The status indicating whether a device has been remembered or not. - DeviceRememberedStatus types.DeviceRememberedStatusType - // The user name. // // This member is required. Username *string - // The device key. - // - // This member is required. - DeviceKey *string + // The status indicating whether a device has been remembered or not. + DeviceRememberedStatus types.DeviceRememberedStatusType } // The status response from the request to update the device, as an administrator. diff --git a/service/cognitoidentityprovider/api_op_AdminUpdateUserAttributes.go b/service/cognitoidentityprovider/api_op_AdminUpdateUserAttributes.go index 2814c85b148..6ce10804b04 100644 --- a/service/cognitoidentityprovider/api_op_AdminUpdateUserAttributes.go +++ b/service/cognitoidentityprovider/api_op_AdminUpdateUserAttributes.go @@ -62,6 +62,22 @@ func (c *Client) AdminUpdateUserAttributes(ctx context.Context, params *AdminUpd // Represents the request to update the user's attributes as an administrator. type AdminUpdateUserAttributesInput struct { + // An array of name-value pairs representing user attributes. For custom + // attributes, you must prepend the custom: prefix to the attribute name. + // + // This member is required. + UserAttributes []*types.AttributeType + + // The user pool ID for the user pool where you want to update user attributes. + // + // This member is required. + UserPoolId *string + + // The user name of the user for whom you want to update user attributes. + // + // This member is required. + Username *string + // A map of custom key-value pairs that you can provide as input for any custom // workflows that this action triggers. You create custom workflows by assigning // AWS Lambda functions to user pool triggers. When you use the @@ -89,22 +105,6 @@ type AdminUpdateUserAttributesInput struct { // * Amazon Cognito does not encrypt the the // ClientMetadata value, so don't use it to provide sensitive information. ClientMetadata map[string]*string - - // An array of name-value pairs representing user attributes. For custom - // attributes, you must prepend the custom: prefix to the attribute name. - // - // This member is required. - UserAttributes []*types.AttributeType - - // The user pool ID for the user pool where you want to update user attributes. - // - // This member is required. - UserPoolId *string - - // The user name of the user for whom you want to update user attributes. - // - // This member is required. - Username *string } // Represents the response from the server for the request to update user diff --git a/service/cognitoidentityprovider/api_op_AdminUserGlobalSignOut.go b/service/cognitoidentityprovider/api_op_AdminUserGlobalSignOut.go index f95823f5249..caec97980cd 100644 --- a/service/cognitoidentityprovider/api_op_AdminUserGlobalSignOut.go +++ b/service/cognitoidentityprovider/api_op_AdminUserGlobalSignOut.go @@ -60,15 +60,15 @@ func (c *Client) AdminUserGlobalSignOut(ctx context.Context, params *AdminUserGl // The request to sign out of all devices, as an administrator. type AdminUserGlobalSignOutInput struct { - // The user name. + // The user pool ID. // // This member is required. - Username *string + UserPoolId *string - // The user pool ID. + // The user name. // // This member is required. - UserPoolId *string + Username *string } // The global sign-out response, as an administrator. diff --git a/service/cognitoidentityprovider/api_op_AssociateSoftwareToken.go b/service/cognitoidentityprovider/api_op_AssociateSoftwareToken.go index f596b8ab97e..66ae9f4180c 100644 --- a/service/cognitoidentityprovider/api_op_AssociateSoftwareToken.go +++ b/service/cognitoidentityprovider/api_op_AssociateSoftwareToken.go @@ -56,13 +56,13 @@ func (c *Client) AssociateSoftwareToken(ctx context.Context, params *AssociateSo type AssociateSoftwareTokenInput struct { + // The access token. + AccessToken *string + // The session which should be passed both ways in challenge-response calls to the // service. This allows authentication of the user as part of the MFA setup // process. Session *string - - // The access token. - AccessToken *string } type AssociateSoftwareTokenOutput struct { diff --git a/service/cognitoidentityprovider/api_op_ChangePassword.go b/service/cognitoidentityprovider/api_op_ChangePassword.go index 6fdeeb16af6..98154b88eb0 100644 --- a/service/cognitoidentityprovider/api_op_ChangePassword.go +++ b/service/cognitoidentityprovider/api_op_ChangePassword.go @@ -54,15 +54,15 @@ func (c *Client) ChangePassword(ctx context.Context, params *ChangePasswordInput // Represents the request to change a user password. type ChangePasswordInput struct { - // The old password. + // The access token. // // This member is required. - PreviousPassword *string + AccessToken *string - // The access token. + // The old password. // // This member is required. - AccessToken *string + PreviousPassword *string // The new password. // diff --git a/service/cognitoidentityprovider/api_op_ConfirmDevice.go b/service/cognitoidentityprovider/api_op_ConfirmDevice.go index 69f0dceef86..87e3f6ac110 100644 --- a/service/cognitoidentityprovider/api_op_ConfirmDevice.go +++ b/service/cognitoidentityprovider/api_op_ConfirmDevice.go @@ -64,14 +64,14 @@ type ConfirmDeviceInput struct { // This member is required. AccessToken *string - // The device name. - DeviceName *string - // The device key. // // This member is required. DeviceKey *string + // The device name. + DeviceName *string + // The configuration of the device secret verifier. DeviceSecretVerifierConfig *types.DeviceSecretVerifierConfigType } diff --git a/service/cognitoidentityprovider/api_op_ConfirmForgotPassword.go b/service/cognitoidentityprovider/api_op_ConfirmForgotPassword.go index 07aa7b721c8..1e52ca3539a 100644 --- a/service/cognitoidentityprovider/api_op_ConfirmForgotPassword.go +++ b/service/cognitoidentityprovider/api_op_ConfirmForgotPassword.go @@ -55,15 +55,32 @@ func (c *Client) ConfirmForgotPassword(ctx context.Context, params *ConfirmForgo // The request representing the confirmation for a password reset. type ConfirmForgotPasswordInput struct { - // A keyed-hash message authentication code (HMAC) calculated using the secret key - // of a user pool client and username plus the client ID in the message. - SecretHash *string - // The app client ID of the app associated with the user pool. // // This member is required. ClientId *string + // The confirmation code sent by a user's request to retrieve a forgotten password. + // For more information, see + // + // This member is required. + ConfirmationCode *string + + // The password sent by a user's request to retrieve a forgotten password. + // + // This member is required. + Password *string + + // The user name of the user for whom you want to enter a code to retrieve a + // forgotten password. + // + // This member is required. + Username *string + + // The Amazon Pinpoint analytics metadata for collecting metrics for + // ConfirmForgotPassword calls. + AnalyticsMetadata *types.AnalyticsMetadataType + // A map of custom key-value pairs that you can provide as input for any custom // workflows that this action triggers. You create custom workflows by assigning // AWS Lambda functions to user pool triggers. When you use the @@ -92,31 +109,14 @@ type ConfirmForgotPasswordInput struct { // ClientMetadata value, so don't use it to provide sensitive information. ClientMetadata map[string]*string - // The confirmation code sent by a user's request to retrieve a forgotten password. - // For more information, see - // - // This member is required. - ConfirmationCode *string - - // The user name of the user for whom you want to enter a code to retrieve a - // forgotten password. - // - // This member is required. - Username *string + // A keyed-hash message authentication code (HMAC) calculated using the secret key + // of a user pool client and username plus the client ID in the message. + SecretHash *string // Contextual data such as the user's device fingerprint, IP address, or location // used for evaluating the risk of an unexpected event by Amazon Cognito advanced // security. UserContextData *types.UserContextDataType - - // The password sent by a user's request to retrieve a forgotten password. - // - // This member is required. - Password *string - - // The Amazon Pinpoint analytics metadata for collecting metrics for - // ConfirmForgotPassword calls. - AnalyticsMetadata *types.AnalyticsMetadataType } // The response from the server that results from a user's request to retrieve a diff --git a/service/cognitoidentityprovider/api_op_ConfirmSignUp.go b/service/cognitoidentityprovider/api_op_ConfirmSignUp.go index c52d07523cf..ff1f4185425 100644 --- a/service/cognitoidentityprovider/api_op_ConfirmSignUp.go +++ b/service/cognitoidentityprovider/api_op_ConfirmSignUp.go @@ -56,13 +56,24 @@ func (c *Client) ConfirmSignUp(ctx context.Context, params *ConfirmSignUpInput, // Represents the request to confirm registration of a user. type ConfirmSignUpInput struct { - // Boolean to be specified to force user confirmation irrespective of existing - // alias. By default set to False. If this parameter is set to True and the phone - // number/email used for sign up confirmation already exists as an alias with a - // different user, the API call will migrate the alias from the previous user to - // the newly created user being confirmed. If set to False, the API will throw an - // AliasExistsException error. - ForceAliasCreation *bool + // The ID of the app client associated with the user pool. + // + // This member is required. + ClientId *string + + // The confirmation code sent by a user's request to confirm registration. + // + // This member is required. + ConfirmationCode *string + + // The user name of the user whose registration you wish to confirm. + // + // This member is required. + Username *string + + // The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp + // calls. + AnalyticsMetadata *types.AnalyticsMetadataType // A map of custom key-value pairs that you can provide as input for any custom // workflows that this action triggers. You create custom workflows by assigning @@ -92,33 +103,22 @@ type ConfirmSignUpInput struct { // ClientMetadata value, so don't use it to provide sensitive information. ClientMetadata map[string]*string + // Boolean to be specified to force user confirmation irrespective of existing + // alias. By default set to False. If this parameter is set to True and the phone + // number/email used for sign up confirmation already exists as an alias with a + // different user, the API call will migrate the alias from the previous user to + // the newly created user being confirmed. If set to False, the API will throw an + // AliasExistsException error. + ForceAliasCreation *bool + // A keyed-hash message authentication code (HMAC) calculated using the secret key // of a user pool client and username plus the client ID in the message. SecretHash *string - // The ID of the app client associated with the user pool. - // - // This member is required. - ClientId *string - // Contextual data such as the user's device fingerprint, IP address, or location // used for evaluating the risk of an unexpected event by Amazon Cognito advanced // security. UserContextData *types.UserContextDataType - - // The confirmation code sent by a user's request to confirm registration. - // - // This member is required. - ConfirmationCode *string - - // The user name of the user whose registration you wish to confirm. - // - // This member is required. - Username *string - - // The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp - // calls. - AnalyticsMetadata *types.AnalyticsMetadataType } // Represents the response from the server for the registration confirmation. diff --git a/service/cognitoidentityprovider/api_op_CreateGroup.go b/service/cognitoidentityprovider/api_op_CreateGroup.go index fb70ea25faa..be796446c0f 100644 --- a/service/cognitoidentityprovider/api_op_CreateGroup.go +++ b/service/cognitoidentityprovider/api_op_CreateGroup.go @@ -58,6 +58,19 @@ func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optF type CreateGroupInput struct { + // The name of the group. Must be unique. + // + // This member is required. + GroupName *string + + // The user pool ID for the user pool. + // + // This member is required. + UserPoolId *string + + // A string containing the description of the group. + Description *string + // A nonnegative integer value that specifies the precedence of this group relative // to the other groups that a user can belong to in the user pool. Zero is the // highest precedence value. Groups with lower Precedence values take precedence @@ -72,21 +85,8 @@ type CreateGroupInput struct { // users' tokens. The default Precedence value is null. Precedence *int32 - // The name of the group. Must be unique. - // - // This member is required. - GroupName *string - - // The user pool ID for the user pool. - // - // This member is required. - UserPoolId *string - // The role ARN for the group. RoleArn *string - - // A string containing the description of the group. - Description *string } type CreateGroupOutput struct { diff --git a/service/cognitoidentityprovider/api_op_CreateIdentityProvider.go b/service/cognitoidentityprovider/api_op_CreateIdentityProvider.go index 15e69822c6b..8368cace708 100644 --- a/service/cognitoidentityprovider/api_op_CreateIdentityProvider.go +++ b/service/cognitoidentityprovider/api_op_CreateIdentityProvider.go @@ -57,28 +57,6 @@ func (c *Client) CreateIdentityProvider(ctx context.Context, params *CreateIdent type CreateIdentityProviderInput struct { - // The user pool ID. - // - // This member is required. - UserPoolId *string - - // The identity provider type. - // - // This member is required. - ProviderType types.IdentityProviderTypeType - - // A mapping of identity provider attributes to standard and custom user pool - // attributes. - AttributeMapping map[string]*string - - // A list of identity provider identifiers. - IdpIdentifiers []*string - - // The identity provider name. - // - // This member is required. - ProviderName *string - // The identity provider details. The following list describes the provider detail // keys for each identity provider type. // @@ -143,6 +121,28 @@ type CreateIdentityProviderInput struct { // // This member is required. ProviderDetails map[string]*string + + // The identity provider name. + // + // This member is required. + ProviderName *string + + // The identity provider type. + // + // This member is required. + ProviderType types.IdentityProviderTypeType + + // The user pool ID. + // + // This member is required. + UserPoolId *string + + // A mapping of identity provider attributes to standard and custom user pool + // attributes. + AttributeMapping map[string]*string + + // A list of identity provider identifiers. + IdpIdentifiers []*string } type CreateIdentityProviderOutput struct { diff --git a/service/cognitoidentityprovider/api_op_CreateResourceServer.go b/service/cognitoidentityprovider/api_op_CreateResourceServer.go index 4432e8b4aba..ed79ce7dcf2 100644 --- a/service/cognitoidentityprovider/api_op_CreateResourceServer.go +++ b/service/cognitoidentityprovider/api_op_CreateResourceServer.go @@ -64,9 +64,6 @@ type CreateResourceServerInput struct { // This member is required. Identifier *string - // A list of scopes. Each scope is map, where the keys are name and description. - Scopes []*types.ResourceServerScopeType - // A friendly name for the resource server. // // This member is required. @@ -76,6 +73,9 @@ type CreateResourceServerInput struct { // // This member is required. UserPoolId *string + + // A list of scopes. Each scope is map, where the keys are name and description. + Scopes []*types.ResourceServerScopeType } type CreateResourceServerOutput struct { diff --git a/service/cognitoidentityprovider/api_op_CreateUserImportJob.go b/service/cognitoidentityprovider/api_op_CreateUserImportJob.go index e71f8e6ad4b..be8b5cd13f0 100644 --- a/service/cognitoidentityprovider/api_op_CreateUserImportJob.go +++ b/service/cognitoidentityprovider/api_op_CreateUserImportJob.go @@ -58,11 +58,6 @@ func (c *Client) CreateUserImportJob(ctx context.Context, params *CreateUserImpo // Represents the request to create the user import job. type CreateUserImportJobInput struct { - // The user pool ID for the user pool that the users are being imported into. - // - // This member is required. - UserPoolId *string - // The role ARN for the Amazon CloudWatch Logging role for the user import job. // // This member is required. @@ -72,6 +67,11 @@ type CreateUserImportJobInput struct { // // This member is required. JobName *string + + // The user pool ID for the user pool that the users are being imported into. + // + // This member is required. + UserPoolId *string } // Represents the response from the server to the request to create the user import diff --git a/service/cognitoidentityprovider/api_op_CreateUserPool.go b/service/cognitoidentityprovider/api_op_CreateUserPool.go index 1798c0d4b55..0ac2413672a 100644 --- a/service/cognitoidentityprovider/api_op_CreateUserPool.go +++ b/service/cognitoidentityprovider/api_op_CreateUserPool.go @@ -59,32 +59,56 @@ func (c *Client) CreateUserPool(ctx context.Context, params *CreateUserPoolInput // Represents the request to create a user pool. type CreateUserPoolInput struct { - // The email configuration. - EmailConfiguration *types.EmailConfigurationType + // A string used to name the user pool. + // + // This member is required. + PoolName *string + + // Use this setting to define which verified available method a user can use to + // recover their password when they call ForgotPassword. It allows you to define a + // preferred method when a user has more than one method available. With this + // setting, SMS does not qualify for a valid password recovery mechanism if the + // user also has SMS MFA enabled. In the absence of this setting, Cognito uses the + // legacy behavior to determine the recovery method where SMS is preferred over + // email. Starting February 1, 2020, the value of AccountRecoverySetting will + // default to verified_email first and verified_phone_number as the second option + // for newly created user pools if no value is provided. + AccountRecoverySetting *types.AccountRecoverySettingType // The configuration for AdminCreateUser requests. AdminCreateUserConfig *types.AdminCreateUserConfigType - // A string representing the email verification message. - EmailVerificationMessage *string + // Attributes supported as an alias for this user pool. Possible values: + // phone_number, email, or preferred_username. + AliasAttributes []types.AliasAttributeType + + // The attributes to be auto-verified. Possible values: email, phone_number. + AutoVerifiedAttributes []types.VerifiedAttributeType // The device configuration. DeviceConfiguration *types.DeviceConfigurationType - // The SMS configuration. - SmsConfiguration *types.SmsConfigurationType + // The email configuration. + EmailConfiguration *types.EmailConfigurationType - // The tag keys and values to assign to the user pool. A tag is a label that you - // can use to categorize and manage user pools in different ways, such as by - // purpose, owner, environment, or other criteria. - UserPoolTags map[string]*string + // A string representing the email verification message. + EmailVerificationMessage *string // A string representing the email verification subject. EmailVerificationSubject *string - // Used to enable advanced security risk detection. Set the key - // AdvancedSecurityMode to the value "AUDIT". - UserPoolAddOns *types.UserPoolAddOnsType + // The Lambda trigger configuration information for the new user pool. In a push + // model, event sources (such as Amazon S3 and custom applications) need permission + // to invoke a function. So you will need to make an extra call to add permission + // for these event sources to invoke your Lambda function. For more information on + // using the Lambda API to add permission, see AddPermission + // (https://docs.aws.amazon.com/lambda/latest/dg/API_AddPermission.html). For + // adding permission using the AWS CLI, see add-permission + // (https://docs.aws.amazon.com/cli/latest/reference/lambda/add-permission.html). + LambdaConfig *types.LambdaConfigType + + // Specifies MFA configuration details. + MfaConfiguration types.UserPoolMfaType // The policies associated with the new user pool. Policies *types.UserPoolPolicyType @@ -93,45 +117,27 @@ type CreateUserPoolInput struct { // standard or custom attributes. Schema []*types.SchemaAttributeType - // The attributes to be auto-verified. Possible values: email, phone_number. - AutoVerifiedAttributes []types.VerifiedAttributeType - // A string representing the SMS authentication message. SmsAuthenticationMessage *string - // Use this setting to define which verified available method a user can use to - // recover their password when they call ForgotPassword. It allows you to define a - // preferred method when a user has more than one method available. With this - // setting, SMS does not qualify for a valid password recovery mechanism if the - // user also has SMS MFA enabled. In the absence of this setting, Cognito uses the - // legacy behavior to determine the recovery method where SMS is preferred over - // email. Starting February 1, 2020, the value of AccountRecoverySetting will - // default to verified_email first and verified_phone_number as the second option - // for newly created user pools if no value is provided. - AccountRecoverySetting *types.AccountRecoverySettingType + // The SMS configuration. + SmsConfiguration *types.SmsConfigurationType - // Specifies whether email addresses or phone numbers can be specified as usernames - // when a user signs up. - UsernameAttributes []types.UsernameAttributeType + // A string representing the SMS verification message. + SmsVerificationMessage *string - // The Lambda trigger configuration information for the new user pool. In a push - // model, event sources (such as Amazon S3 and custom applications) need permission - // to invoke a function. So you will need to make an extra call to add permission - // for these event sources to invoke your Lambda function. For more information on - // using the Lambda API to add permission, see AddPermission - // (https://docs.aws.amazon.com/lambda/latest/dg/API_AddPermission.html). For - // adding permission using the AWS CLI, see add-permission - // (https://docs.aws.amazon.com/cli/latest/reference/lambda/add-permission.html). - LambdaConfig *types.LambdaConfigType + // Used to enable advanced security risk detection. Set the key + // AdvancedSecurityMode to the value "AUDIT". + UserPoolAddOns *types.UserPoolAddOnsType - // The template for the verification message that the user sees when the app - // requests permission to access the user's information. - VerificationMessageTemplate *types.VerificationMessageTemplateType + // The tag keys and values to assign to the user pool. A tag is a label that you + // can use to categorize and manage user pools in different ways, such as by + // purpose, owner, environment, or other criteria. + UserPoolTags map[string]*string - // A string used to name the user pool. - // - // This member is required. - PoolName *string + // Specifies whether email addresses or phone numbers can be specified as usernames + // when a user signs up. + UsernameAttributes []types.UsernameAttributeType // You can choose to set case sensitivity on the username input for the selected // sign-in option. For example, when this is set to False, users will be able to @@ -139,15 +145,9 @@ type CreateUserPoolInput struct { // once it has been set. For more information, see . UsernameConfiguration *types.UsernameConfigurationType - // Attributes supported as an alias for this user pool. Possible values: - // phone_number, email, or preferred_username. - AliasAttributes []types.AliasAttributeType - - // A string representing the SMS verification message. - SmsVerificationMessage *string - - // Specifies MFA configuration details. - MfaConfiguration types.UserPoolMfaType + // The template for the verification message that the user sees when the app + // requests permission to access the user's information. + VerificationMessageTemplate *types.VerificationMessageTemplateType } // Represents the response from the server for the request to create a user pool. diff --git a/service/cognitoidentityprovider/api_op_CreateUserPoolClient.go b/service/cognitoidentityprovider/api_op_CreateUserPoolClient.go index c4edf39450d..ee53d6e0c9f 100644 --- a/service/cognitoidentityprovider/api_op_CreateUserPoolClient.go +++ b/service/cognitoidentityprovider/api_op_CreateUserPoolClient.go @@ -58,6 +58,57 @@ func (c *Client) CreateUserPoolClient(ctx context.Context, params *CreateUserPoo // Represents the request to create a user pool client. type CreateUserPoolClientInput struct { + // The client name for the user pool client you would like to create. + // + // This member is required. + ClientName *string + + // The user pool ID for the user pool where you want to create a user pool client. + // + // This member is required. + UserPoolId *string + + // The allowed OAuth flows. Set to code to initiate a code grant flow, which + // provides an authorization code as the response. This code can be exchanged for + // access tokens with the token endpoint. Set to implicit to specify that the + // client should get the access token (and, optionally, ID token, based on scopes) + // directly. Set to client_credentials to specify that the client should get the + // access token (and, optionally, ID token, based on scopes) from the token + // endpoint using a combination of client and client_secret. + AllowedOAuthFlows []types.OAuthFlowType + + // Set to true if the client is allowed to follow the OAuth protocol when + // interacting with Cognito user pools. + AllowedOAuthFlowsUserPoolClient *bool + + // The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, + // openid, and profile. Possible values provided by AWS are: + // aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are + // also supported. + AllowedOAuthScopes []*string + + // The Amazon Pinpoint analytics configuration for collecting metrics for this user + // pool. Cognito User Pools only supports sending events to Amazon Pinpoint + // projects in the US East (N. Virginia) us-east-1 Region, regardless of the region + // in which the user pool resides. + AnalyticsConfiguration *types.AnalyticsConfigurationType + + // A list of allowed redirect (callback) URLs for the identity providers. A + // redirect URI must: + // + // * Be an absolute URI. + // + // * Be registered with the + // authorization server. + // + // * Not include a fragment component. + // + // See OAuth 2.0 - + // Redirection Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2). Amazon + // Cognito requires HTTPS over HTTP except for http://localhost for testing + // purposes only. App callback URLs such as myapp://example are also supported. + CallbackURLs []*string + // The default redirect URI. Must be in the CallbackURLs list. A redirect URI // must: // @@ -74,24 +125,38 @@ type CreateUserPoolClientInput struct { // App callback URLs such as myapp://example are also supported. DefaultRedirectURI *string - // The allowed OAuth flows. Set to code to initiate a code grant flow, which - // provides an authorization code as the response. This code can be exchanged for - // access tokens with the token endpoint. Set to implicit to specify that the - // client should get the access token (and, optionally, ID token, based on scopes) - // directly. Set to client_credentials to specify that the client should get the - // access token (and, optionally, ID token, based on scopes) from the token - // endpoint using a combination of client and client_secret. - AllowedOAuthFlows []types.OAuthFlowType - - // The user pool ID for the user pool where you want to create a user pool client. + // The authentication flows that are supported by the user pool clients. Flow names + // without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ + // prefix. Note that values with ALLOW_ prefix cannot be used along with values + // without ALLOW_ prefix. Valid values include: // - // This member is required. - UserPoolId *string - - // The client name for the user pool client you would like to create. + // * + // ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication + // flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH + // setting. With this authentication flow, Cognito receives the password in the + // request instead of using the SRP (Secure Remote Password protocol) protocol to + // verify passwords. // - // This member is required. - ClientName *string + // * ALLOW_CUSTOM_AUTH: Enable Lambda trigger based + // authentication. + // + // * ALLOW_USER_PASSWORD_AUTH: Enable user password-based + // authentication. In this flow, Cognito receives the password in the request + // instead of using the SRP protocol to verify passwords. + // + // * + // ALLOW_USER_SRP_AUTH: Enable SRP based authentication. + // + // * + // ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens. + ExplicitAuthFlows []types.ExplicitAuthFlowsType + + // Boolean to specify whether you want to generate a secret for the user pool + // client being created. + GenerateSecret *bool + + // A list of allowed logout URLs for the identity providers. + LogoutURLs []*string // Use this setting to choose which errors and responses are returned by Cognito // APIs during authentication, account confirmation, and password recovery when the @@ -135,17 +200,6 @@ type CreateUserPoolClientInput struct { // created user pool clients if no value is provided. PreventUserExistenceErrors types.PreventUserExistenceErrorTypes - // The user pool attributes that the app client can write to. If your app client - // allows users to sign in through an identity provider, this array must include - // all attributes that are mapped to identity provider attributes. Amazon Cognito - // updates mapped attributes when users sign in to your application through an - // identity provider. If your app client lacks write access to a mapped attribute, - // Amazon Cognito throws an error when it attempts to update the attribute. For - // more information, see Specifying Identity Provider Attribute Mappings for Your - // User Pool - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html). - WriteAttributes []*string - // The read attributes. ReadAttributes []*string @@ -153,75 +207,21 @@ type CreateUserPoolClientInput struct { // cannot be used. RefreshTokenValidity *int32 - // The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, - // openid, and profile. Possible values provided by AWS are: - // aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are - // also supported. - AllowedOAuthScopes []*string - // A list of provider names for the identity providers that are supported on this // client. The following are supported: COGNITO, Facebook, Google and // LoginWithAmazon. SupportedIdentityProviders []*string - // A list of allowed redirect (callback) URLs for the identity providers. A - // redirect URI must: - // - // * Be an absolute URI. - // - // * Be registered with the - // authorization server. - // - // * Not include a fragment component. - // - // See OAuth 2.0 - - // Redirection Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2). Amazon - // Cognito requires HTTPS over HTTP except for http://localhost for testing - // purposes only. App callback URLs such as myapp://example are also supported. - CallbackURLs []*string - - // Set to true if the client is allowed to follow the OAuth protocol when - // interacting with Cognito user pools. - AllowedOAuthFlowsUserPoolClient *bool - - // The Amazon Pinpoint analytics configuration for collecting metrics for this user - // pool. Cognito User Pools only supports sending events to Amazon Pinpoint - // projects in the US East (N. Virginia) us-east-1 Region, regardless of the region - // in which the user pool resides. - AnalyticsConfiguration *types.AnalyticsConfigurationType - - // A list of allowed logout URLs for the identity providers. - LogoutURLs []*string - - // The authentication flows that are supported by the user pool clients. Flow names - // without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ - // prefix. Note that values with ALLOW_ prefix cannot be used along with values - // without ALLOW_ prefix. Valid values include: - // - // * - // ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication - // flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH - // setting. With this authentication flow, Cognito receives the password in the - // request instead of using the SRP (Secure Remote Password protocol) protocol to - // verify passwords. - // - // * ALLOW_CUSTOM_AUTH: Enable Lambda trigger based - // authentication. - // - // * ALLOW_USER_PASSWORD_AUTH: Enable user password-based - // authentication. In this flow, Cognito receives the password in the request - // instead of using the SRP protocol to verify passwords. - // - // * - // ALLOW_USER_SRP_AUTH: Enable SRP based authentication. - // - // * - // ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens. - ExplicitAuthFlows []types.ExplicitAuthFlowsType - - // Boolean to specify whether you want to generate a secret for the user pool - // client being created. - GenerateSecret *bool + // The user pool attributes that the app client can write to. If your app client + // allows users to sign in through an identity provider, this array must include + // all attributes that are mapped to identity provider attributes. Amazon Cognito + // updates mapped attributes when users sign in to your application through an + // identity provider. If your app client lacks write access to a mapped attribute, + // Amazon Cognito throws an error when it attempts to update the attribute. For + // more information, see Specifying Identity Provider Attribute Mappings for Your + // User Pool + // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html). + WriteAttributes []*string } // Represents the response from the server to create a user pool client. diff --git a/service/cognitoidentityprovider/api_op_DeleteGroup.go b/service/cognitoidentityprovider/api_op_DeleteGroup.go index cb7969c8890..f21a17c525c 100644 --- a/service/cognitoidentityprovider/api_op_DeleteGroup.go +++ b/service/cognitoidentityprovider/api_op_DeleteGroup.go @@ -57,15 +57,15 @@ func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optF type DeleteGroupInput struct { - // The user pool ID for the user pool. + // The name of the group. // // This member is required. - UserPoolId *string + GroupName *string - // The name of the group. + // The user pool ID for the user pool. // // This member is required. - GroupName *string + UserPoolId *string } type DeleteGroupOutput struct { diff --git a/service/cognitoidentityprovider/api_op_DeleteResourceServer.go b/service/cognitoidentityprovider/api_op_DeleteResourceServer.go index 660e081892b..1945d2a5f73 100644 --- a/service/cognitoidentityprovider/api_op_DeleteResourceServer.go +++ b/service/cognitoidentityprovider/api_op_DeleteResourceServer.go @@ -56,15 +56,15 @@ func (c *Client) DeleteResourceServer(ctx context.Context, params *DeleteResourc type DeleteResourceServerInput struct { - // The user pool ID for the user pool that hosts the resource server. + // The identifier for the resource server. // // This member is required. - UserPoolId *string + Identifier *string - // The identifier for the resource server. + // The user pool ID for the user pool that hosts the resource server. // // This member is required. - Identifier *string + UserPoolId *string } type DeleteResourceServerOutput struct { diff --git a/service/cognitoidentityprovider/api_op_DescribeRiskConfiguration.go b/service/cognitoidentityprovider/api_op_DescribeRiskConfiguration.go index 9f8466d31b4..b6a8d452f59 100644 --- a/service/cognitoidentityprovider/api_op_DescribeRiskConfiguration.go +++ b/service/cognitoidentityprovider/api_op_DescribeRiskConfiguration.go @@ -57,13 +57,13 @@ func (c *Client) DescribeRiskConfiguration(ctx context.Context, params *Describe type DescribeRiskConfigurationInput struct { - // The app client ID. - ClientId *string - // The user pool ID. // // This member is required. UserPoolId *string + + // The app client ID. + ClientId *string } type DescribeRiskConfigurationOutput struct { diff --git a/service/cognitoidentityprovider/api_op_ForgotPassword.go b/service/cognitoidentityprovider/api_op_ForgotPassword.go index 23f0d7d43cb..5dfd01ef3f6 100644 --- a/service/cognitoidentityprovider/api_op_ForgotPassword.go +++ b/service/cognitoidentityprovider/api_op_ForgotPassword.go @@ -62,16 +62,20 @@ func (c *Client) ForgotPassword(ctx context.Context, params *ForgotPasswordInput // Represents the request to reset a user's password. type ForgotPasswordInput struct { + // The ID of the client associated with the user pool. + // + // This member is required. + ClientId *string + // The user name of the user for whom you want to enter a code to reset a forgotten // password. // // This member is required. Username *string - // Contextual data such as the user's device fingerprint, IP address, or location - // used for evaluating the risk of an unexpected event by Amazon Cognito advanced - // security. - UserContextData *types.UserContextDataType + // The Amazon Pinpoint analytics metadata for collecting metrics for ForgotPassword + // calls. + AnalyticsMetadata *types.AnalyticsMetadataType // A map of custom key-value pairs that you can provide as input for any custom // workflows that this action triggers. You create custom workflows by assigning @@ -101,18 +105,14 @@ type ForgotPasswordInput struct { // ClientMetadata value, so don't use it to provide sensitive information. ClientMetadata map[string]*string - // The Amazon Pinpoint analytics metadata for collecting metrics for ForgotPassword - // calls. - AnalyticsMetadata *types.AnalyticsMetadataType - // A keyed-hash message authentication code (HMAC) calculated using the secret key // of a user pool client and username plus the client ID in the message. SecretHash *string - // The ID of the client associated with the user pool. - // - // This member is required. - ClientId *string + // Contextual data such as the user's device fingerprint, IP address, or location + // used for evaluating the risk of an unexpected event by Amazon Cognito advanced + // security. + UserContextData *types.UserContextDataType } // Respresents the response from the server regarding the request to reset a diff --git a/service/cognitoidentityprovider/api_op_GetDevice.go b/service/cognitoidentityprovider/api_op_GetDevice.go index f649adbfd2d..802a36755e0 100644 --- a/service/cognitoidentityprovider/api_op_GetDevice.go +++ b/service/cognitoidentityprovider/api_op_GetDevice.go @@ -58,13 +58,13 @@ func (c *Client) GetDevice(ctx context.Context, params *GetDeviceInput, optFns . // Represents the request to get the device. type GetDeviceInput struct { - // The access token. - AccessToken *string - // The device key. // // This member is required. DeviceKey *string + + // The access token. + AccessToken *string } // Gets the device response. diff --git a/service/cognitoidentityprovider/api_op_GetGroup.go b/service/cognitoidentityprovider/api_op_GetGroup.go index dfcb067d1de..bc73ce5274f 100644 --- a/service/cognitoidentityprovider/api_op_GetGroup.go +++ b/service/cognitoidentityprovider/api_op_GetGroup.go @@ -57,15 +57,15 @@ func (c *Client) GetGroup(ctx context.Context, params *GetGroupInput, optFns ... type GetGroupInput struct { - // The user pool ID for the user pool. + // The name of the group. // // This member is required. - UserPoolId *string + GroupName *string - // The name of the group. + // The user pool ID for the user pool. // // This member is required. - GroupName *string + UserPoolId *string } type GetGroupOutput struct { diff --git a/service/cognitoidentityprovider/api_op_GetIdentityProviderByIdentifier.go b/service/cognitoidentityprovider/api_op_GetIdentityProviderByIdentifier.go index 67df75ac452..39d8d6b94b1 100644 --- a/service/cognitoidentityprovider/api_op_GetIdentityProviderByIdentifier.go +++ b/service/cognitoidentityprovider/api_op_GetIdentityProviderByIdentifier.go @@ -57,15 +57,15 @@ func (c *Client) GetIdentityProviderByIdentifier(ctx context.Context, params *Ge type GetIdentityProviderByIdentifierInput struct { - // The user pool ID. + // The identity provider ID. // // This member is required. - UserPoolId *string + IdpIdentifier *string - // The identity provider ID. + // The user pool ID. // // This member is required. - IdpIdentifier *string + UserPoolId *string } type GetIdentityProviderByIdentifierOutput struct { diff --git a/service/cognitoidentityprovider/api_op_GetUICustomization.go b/service/cognitoidentityprovider/api_op_GetUICustomization.go index 39f46ee503e..b0cd994376f 100644 --- a/service/cognitoidentityprovider/api_op_GetUICustomization.go +++ b/service/cognitoidentityprovider/api_op_GetUICustomization.go @@ -60,13 +60,13 @@ func (c *Client) GetUICustomization(ctx context.Context, params *GetUICustomizat type GetUICustomizationInput struct { - // The client ID for the client app. - ClientId *string - // The user pool ID for the user pool. // // This member is required. UserPoolId *string + + // The client ID for the client app. + ClientId *string } type GetUICustomizationOutput struct { diff --git a/service/cognitoidentityprovider/api_op_GetUser.go b/service/cognitoidentityprovider/api_op_GetUser.go index 3c43805c398..83a844d880d 100644 --- a/service/cognitoidentityprovider/api_op_GetUser.go +++ b/service/cognitoidentityprovider/api_op_GetUser.go @@ -66,21 +66,17 @@ type GetUserInput struct { // about the user. type GetUserOutput struct { - // The user name of the user you wish to retrieve from the get user request. - // - // This member is required. - Username *string - - // The MFA options that are enabled for the user. The possible values in this list - // are SMS_MFA and SOFTWARE_TOKEN_MFA. - UserMFASettingList []*string - // An array of name-value pairs representing user attributes. For custom // attributes, you must prepend the custom: prefix to the attribute name. // // This member is required. UserAttributes []*types.AttributeType + // The user name of the user you wish to retrieve from the get user request. + // + // This member is required. + Username *string + // This response parameter is no longer supported. It provides information only // about SMS MFA configurations. It doesn't provide information about TOTP software // token MFA configurations. To look up information about either type of MFA @@ -91,6 +87,10 @@ type GetUserOutput struct { // The user's preferred MFA setting. PreferredMfaSetting *string + // The MFA options that are enabled for the user. The possible values in this list + // are SMS_MFA and SOFTWARE_TOKEN_MFA. + UserMFASettingList []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cognitoidentityprovider/api_op_GetUserPoolMfaConfig.go b/service/cognitoidentityprovider/api_op_GetUserPoolMfaConfig.go index abe35bf8a66..ecd57e1a77e 100644 --- a/service/cognitoidentityprovider/api_op_GetUserPoolMfaConfig.go +++ b/service/cognitoidentityprovider/api_op_GetUserPoolMfaConfig.go @@ -65,12 +65,6 @@ type GetUserPoolMfaConfigInput struct { type GetUserPoolMfaConfigOutput struct { - // The SMS text message multi-factor (MFA) configuration. - SmsMfaConfiguration *types.SmsMfaConfigType - - // The software token multi-factor (MFA) configuration. - SoftwareTokenMfaConfiguration *types.SoftwareTokenMfaConfigType - // The multi-factor (MFA) configuration. Valid values include: // // * OFF MFA will @@ -83,6 +77,12 @@ type GetUserPoolMfaConfigOutput struct { // enabled. MfaConfiguration types.UserPoolMfaType + // The SMS text message multi-factor (MFA) configuration. + SmsMfaConfiguration *types.SmsMfaConfigType + + // The software token multi-factor (MFA) configuration. + SoftwareTokenMfaConfiguration *types.SoftwareTokenMfaConfigType + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cognitoidentityprovider/api_op_InitiateAuth.go b/service/cognitoidentityprovider/api_op_InitiateAuth.go index ce80a8a7ad5..7c1fbffb445 100644 --- a/service/cognitoidentityprovider/api_op_InitiateAuth.go +++ b/service/cognitoidentityprovider/api_op_InitiateAuth.go @@ -55,6 +55,56 @@ func (c *Client) InitiateAuth(ctx context.Context, params *InitiateAuthInput, op // Initiates the authentication request. type InitiateAuthInput struct { + // The authentication flow for this call to execute. The API action will depend on + // this value. For example: + // + // * REFRESH_TOKEN_AUTH will take in a valid refresh + // token and return new tokens. + // + // * USER_SRP_AUTH will take in USERNAME and + // SRP_A and return the SRP variables to be used for next challenge execution. + // + // + // * USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next + // challenge or tokens. + // + // Valid values include: + // + // * USER_SRP_AUTH: Authentication + // flow for the Secure Remote Password (SRP) protocol. + // + // * + // REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access + // token and ID token by supplying a valid refresh token. + // + // * CUSTOM_AUTH: + // Custom authentication flow. + // + // * USER_PASSWORD_AUTH: Non-SRP authentication + // flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda + // trigger is set, this flow will invoke the user migration Lambda if the USERNAME + // is not found in the user pool. + // + // * ADMIN_USER_PASSWORD_AUTH: Admin-based user + // password authentication. This replaces the ADMIN_NO_SRP_AUTH authentication + // flow. In this flow, Cognito receives the password in the request instead of + // using the SRP process to verify passwords. + // + // ADMIN_NO_SRP_AUTH is not a valid + // value. + // + // This member is required. + AuthFlow types.AuthFlowType + + // The app client ID. + // + // This member is required. + ClientId *string + + // The Amazon Pinpoint analytics metadata for collecting metrics for InitiateAuth + // calls. + AnalyticsMetadata *types.AnalyticsMetadataType + // The authentication parameters. These are inputs corresponding to the AuthFlow // that you are invoking. The required values depend on the value of AuthFlow: // @@ -110,76 +160,20 @@ type InitiateAuthInput struct { // ClientMetadata map[string]*string - // The Amazon Pinpoint analytics metadata for collecting metrics for InitiateAuth - // calls. - AnalyticsMetadata *types.AnalyticsMetadataType - - // The app client ID. - // - // This member is required. - ClientId *string - // Contextual data such as the user's device fingerprint, IP address, or location // used for evaluating the risk of an unexpected event by Amazon Cognito advanced // security. UserContextData *types.UserContextDataType - - // The authentication flow for this call to execute. The API action will depend on - // this value. For example: - // - // * REFRESH_TOKEN_AUTH will take in a valid refresh - // token and return new tokens. - // - // * USER_SRP_AUTH will take in USERNAME and - // SRP_A and return the SRP variables to be used for next challenge execution. - // - // - // * USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next - // challenge or tokens. - // - // Valid values include: - // - // * USER_SRP_AUTH: Authentication - // flow for the Secure Remote Password (SRP) protocol. - // - // * - // REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access - // token and ID token by supplying a valid refresh token. - // - // * CUSTOM_AUTH: - // Custom authentication flow. - // - // * USER_PASSWORD_AUTH: Non-SRP authentication - // flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda - // trigger is set, this flow will invoke the user migration Lambda if the USERNAME - // is not found in the user pool. - // - // * ADMIN_USER_PASSWORD_AUTH: Admin-based user - // password authentication. This replaces the ADMIN_NO_SRP_AUTH authentication - // flow. In this flow, Cognito receives the password in the request instead of - // using the SRP process to verify passwords. - // - // ADMIN_NO_SRP_AUTH is not a valid - // value. - // - // This member is required. - AuthFlow types.AuthFlowType } // Initiates the authentication response. type InitiateAuthOutput struct { - // The session which should be passed both ways in challenge-response calls to the - // service. If the or API call determines that the caller needs to go through - // another challenge, they return a session with other challenge parameters. This - // session should be passed as it is to the next RespondToAuthChallenge API call. - Session *string - - // The challenge parameters. These are returned to you in the InitiateAuth response - // if you need to pass another challenge. The responses in this parameter should be - // used to compute inputs to the next call (RespondToAuthChallenge). All challenges - // require USERNAME and SECRET_HASH (if applicable). - ChallengeParameters map[string]*string + // The result of the authentication response. This is only returned if the caller + // does not need to pass another challenge. If the caller does need to pass another + // challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session + // are returned. + AuthenticationResult *types.AuthenticationResultType // The name of the challenge which you are responding to with this call. This is // returned to you in the AdminInitiateAuth response if you need to pass another @@ -211,11 +205,17 @@ type InitiateAuthOutput struct { // and any other required attributes. ChallengeName types.ChallengeNameType - // The result of the authentication response. This is only returned if the caller - // does not need to pass another challenge. If the caller does need to pass another - // challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session - // are returned. - AuthenticationResult *types.AuthenticationResultType + // The challenge parameters. These are returned to you in the InitiateAuth response + // if you need to pass another challenge. The responses in this parameter should be + // used to compute inputs to the next call (RespondToAuthChallenge). All challenges + // require USERNAME and SECRET_HASH (if applicable). + ChallengeParameters map[string]*string + + // The session which should be passed both ways in challenge-response calls to the + // service. If the or API call determines that the caller needs to go through + // another challenge, they return a session with other challenge parameters. This + // session should be passed as it is to the next RespondToAuthChallenge API call. + Session *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/cognitoidentityprovider/api_op_ListDevices.go b/service/cognitoidentityprovider/api_op_ListDevices.go index f9f4920ac1c..ec70c30c7a4 100644 --- a/service/cognitoidentityprovider/api_op_ListDevices.go +++ b/service/cognitoidentityprovider/api_op_ListDevices.go @@ -58,27 +58,27 @@ func (c *Client) ListDevices(ctx context.Context, params *ListDevicesInput, optF // Represents the request to list the devices. type ListDevicesInput struct { - // The pagination token for the list request. - PaginationToken *string - - // The limit of the device request. - Limit *int32 - // The access tokens for the request to list devices. // // This member is required. AccessToken *string + + // The limit of the device request. + Limit *int32 + + // The pagination token for the list request. + PaginationToken *string } // Represents the response to list devices. type ListDevicesOutput struct { - // The pagination token for the list device response. - PaginationToken *string - // The devices returned in the list devices response. Devices []*types.DeviceType + // The pagination token for the list device response. + PaginationToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cognitoidentityprovider/api_op_ListGroups.go b/service/cognitoidentityprovider/api_op_ListGroups.go index 0a9d332498d..ddc02dcc968 100644 --- a/service/cognitoidentityprovider/api_op_ListGroups.go +++ b/service/cognitoidentityprovider/api_op_ListGroups.go @@ -58,10 +58,6 @@ func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns type ListGroupsInput struct { - // An identifier that was returned from the previous call to this operation, which - // can be used to return the next set of items in the list. - NextToken *string - // The user pool ID for the user pool. // // This member is required. @@ -69,6 +65,10 @@ type ListGroupsInput struct { // The limit of the request to list groups. Limit *int32 + + // An identifier that was returned from the previous call to this operation, which + // can be used to return the next set of items in the list. + NextToken *string } type ListGroupsOutput struct { diff --git a/service/cognitoidentityprovider/api_op_ListIdentityProviders.go b/service/cognitoidentityprovider/api_op_ListIdentityProviders.go index fb848455757..ef18824466c 100644 --- a/service/cognitoidentityprovider/api_op_ListIdentityProviders.go +++ b/service/cognitoidentityprovider/api_op_ListIdentityProviders.go @@ -57,28 +57,28 @@ func (c *Client) ListIdentityProviders(ctx context.Context, params *ListIdentity type ListIdentityProvidersInput struct { - // A pagination token. - NextToken *string - - // The maximum number of identity providers to return. - MaxResults *int32 - // The user pool ID. // // This member is required. UserPoolId *string -} -type ListIdentityProvidersOutput struct { + // The maximum number of identity providers to return. + MaxResults *int32 // A pagination token. NextToken *string +} + +type ListIdentityProvidersOutput struct { // A list of identity provider objects. // // This member is required. Providers []*types.ProviderDescription + // A pagination token. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cognitoidentityprovider/api_op_ListResourceServers.go b/service/cognitoidentityprovider/api_op_ListResourceServers.go index 55e5a2b703d..2a7d6d3514b 100644 --- a/service/cognitoidentityprovider/api_op_ListResourceServers.go +++ b/service/cognitoidentityprovider/api_op_ListResourceServers.go @@ -57,9 +57,6 @@ func (c *Client) ListResourceServers(ctx context.Context, params *ListResourceSe type ListResourceServersInput struct { - // A pagination token. - NextToken *string - // The user pool ID for the user pool. // // This member is required. @@ -67,6 +64,9 @@ type ListResourceServersInput struct { // The maximum number of resource servers to return. MaxResults *int32 + + // A pagination token. + NextToken *string } type ListResourceServersOutput struct { diff --git a/service/cognitoidentityprovider/api_op_ListUserImportJobs.go b/service/cognitoidentityprovider/api_op_ListUserImportJobs.go index 1ae4fb27ea6..046991e4d76 100644 --- a/service/cognitoidentityprovider/api_op_ListUserImportJobs.go +++ b/service/cognitoidentityprovider/api_op_ListUserImportJobs.go @@ -58,6 +58,11 @@ func (c *Client) ListUserImportJobs(ctx context.Context, params *ListUserImportJ // Represents the request to list the user import jobs. type ListUserImportJobsInput struct { + // The maximum number of import jobs you want the request to return. + // + // This member is required. + MaxResults *int32 + // The user pool ID for the user pool that the users are being imported into. // // This member is required. @@ -66,24 +71,19 @@ type ListUserImportJobsInput struct { // An identifier that was returned from the previous call to ListUserImportJobs, // which can be used to return the next set of import jobs in the list. PaginationToken *string - - // The maximum number of import jobs you want the request to return. - // - // This member is required. - MaxResults *int32 } // Represents the response from the server to the request to list the user import // jobs. type ListUserImportJobsOutput struct { - // The user import jobs. - UserImportJobs []*types.UserImportJobType - // An identifier that can be used to return the next set of user import jobs in the // list. PaginationToken *string + // The user import jobs. + UserImportJobs []*types.UserImportJobType + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cognitoidentityprovider/api_op_ListUserPools.go b/service/cognitoidentityprovider/api_op_ListUserPools.go index 52a2a1efe14..ef211052e2d 100644 --- a/service/cognitoidentityprovider/api_op_ListUserPools.go +++ b/service/cognitoidentityprovider/api_op_ListUserPools.go @@ -58,27 +58,27 @@ func (c *Client) ListUserPools(ctx context.Context, params *ListUserPoolsInput, // Represents the request to list user pools. type ListUserPoolsInput struct { - // An identifier that was returned from the previous call to this operation, which - // can be used to return the next set of items in the list. - NextToken *string - // The maximum number of results you want the request to return when listing the // user pools. // // This member is required. MaxResults *int32 + + // An identifier that was returned from the previous call to this operation, which + // can be used to return the next set of items in the list. + NextToken *string } // Represents the response to list user pools. type ListUserPoolsOutput struct { - // The user pools from the response to list users. - UserPools []*types.UserPoolDescriptionType - // An identifier that was returned from the previous call to this operation, which // can be used to return the next set of items in the list. NextToken *string + // The user pools from the response to list users. + UserPools []*types.UserPoolDescriptionType + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cognitoidentityprovider/api_op_ListUsers.go b/service/cognitoidentityprovider/api_op_ListUsers.go index 14e29364672..33acf90c44a 100644 --- a/service/cognitoidentityprovider/api_op_ListUsers.go +++ b/service/cognitoidentityprovider/api_op_ListUsers.go @@ -58,22 +58,15 @@ func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns . // Represents the request to list users. type ListUsersInput struct { - // An array of strings, where each string is the name of a user attribute to be - // returned for each user in the search results. If the array is null, all - // attributes are returned. - AttributesToGet []*string - // The user pool ID for the user pool on which the search should be performed. // // This member is required. UserPoolId *string - // An identifier that was returned from the previous call to this operation, which - // can be used to return the next set of items in the list. - PaginationToken *string - - // Maximum number of users to be returned. - Limit *int32 + // An array of strings, where each string is the name of a user attribute to be + // returned for each user in the search results. If the array is null, all + // attributes are returned. + AttributesToGet []*string // A filter string of the form "AttributeName Filter-Type "AttributeValue"". // Quotation marks within the filter string must be escaped using the backslash (\) @@ -125,18 +118,25 @@ type ListUsersInput struct { // (https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-listusers-api-examples) // in the Amazon Cognito Developer Guide. Filter *string + + // Maximum number of users to be returned. + Limit *int32 + + // An identifier that was returned from the previous call to this operation, which + // can be used to return the next set of items in the list. + PaginationToken *string } // The response from the request to list users. type ListUsersOutput struct { - // The users returned in the request to list users. - Users []*types.UserType - // An identifier that was returned from the previous call to this operation, which // can be used to return the next set of items in the list. PaginationToken *string + // The users returned in the request to list users. + Users []*types.UserType + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cognitoidentityprovider/api_op_ResendConfirmationCode.go b/service/cognitoidentityprovider/api_op_ResendConfirmationCode.go index 086eda84cc7..55626998a3e 100644 --- a/service/cognitoidentityprovider/api_op_ResendConfirmationCode.go +++ b/service/cognitoidentityprovider/api_op_ResendConfirmationCode.go @@ -56,24 +56,19 @@ func (c *Client) ResendConfirmationCode(ctx context.Context, params *ResendConfi // Represents the request to resend the confirmation code. type ResendConfirmationCodeInput struct { - // Contextual data such as the user's device fingerprint, IP address, or location - // used for evaluating the risk of an unexpected event by Amazon Cognito advanced - // security. - UserContextData *types.UserContextDataType - - // The user name of the user to whom you wish to resend a confirmation code. + // The ID of the client associated with the user pool. // // This member is required. - Username *string + ClientId *string - // The ID of the client associated with the user pool. + // The user name of the user to whom you wish to resend a confirmation code. // // This member is required. - ClientId *string + Username *string - // A keyed-hash message authentication code (HMAC) calculated using the secret key - // of a user pool client and username plus the client ID in the message. - SecretHash *string + // The Amazon Pinpoint analytics metadata for collecting metrics for + // ResendConfirmationCode calls. + AnalyticsMetadata *types.AnalyticsMetadataType // A map of custom key-value pairs that you can provide as input for any custom // workflows that this action triggers. You create custom workflows by assigning @@ -103,9 +98,14 @@ type ResendConfirmationCodeInput struct { // ClientMetadata value, so don't use it to provide sensitive information. ClientMetadata map[string]*string - // The Amazon Pinpoint analytics metadata for collecting metrics for - // ResendConfirmationCode calls. - AnalyticsMetadata *types.AnalyticsMetadataType + // A keyed-hash message authentication code (HMAC) calculated using the secret key + // of a user pool client and username plus the client ID in the message. + SecretHash *string + + // Contextual data such as the user's device fingerprint, IP address, or location + // used for evaluating the risk of an unexpected event by Amazon Cognito advanced + // security. + UserContextData *types.UserContextDataType } // The response from the server when the Amazon Cognito Your User Pools service diff --git a/service/cognitoidentityprovider/api_op_RespondToAuthChallenge.go b/service/cognitoidentityprovider/api_op_RespondToAuthChallenge.go index b7bb2686b2b..bbd5fc37cdf 100644 --- a/service/cognitoidentityprovider/api_op_RespondToAuthChallenge.go +++ b/service/cognitoidentityprovider/api_op_RespondToAuthChallenge.go @@ -55,6 +55,21 @@ func (c *Client) RespondToAuthChallenge(ctx context.Context, params *RespondToAu // The request to respond to an authentication challenge. type RespondToAuthChallengeInput struct { + // The challenge name. For more information, see . ADMIN_NO_SRP_AUTH is not a valid + // value. + // + // This member is required. + ChallengeName types.ChallengeNameType + + // The app client ID. + // + // This member is required. + ClientId *string + + // The Amazon Pinpoint analytics metadata for collecting metrics for + // RespondToAuthChallenge calls. + AnalyticsMetadata *types.AnalyticsMetadataType + // The challenge responses. These are inputs corresponding to the value of // ChallengeName, for example: SECRET_HASH (if app client is configured with client // secret) applies to all inputs below (including SOFTWARE_TOKEN_MFA). @@ -79,11 +94,6 @@ type RespondToAuthChallengeInput struct { // PASSWORD_VERIFIER requires plus DEVICE_KEY. ChallengeResponses map[string]*string - // The app client ID. - // - // This member is required. - ClientId *string - // A map of custom key-value pairs that you can provide as input for any custom // workflows that this action triggers. You create custom workflows by assigning // AWS Lambda functions to user pool triggers. When you use the @@ -114,16 +124,6 @@ type RespondToAuthChallengeInput struct { // ClientMetadata value, so don't use it to provide sensitive information. ClientMetadata map[string]*string - // The challenge name. For more information, see . ADMIN_NO_SRP_AUTH is not a valid - // value. - // - // This member is required. - ChallengeName types.ChallengeNameType - - // The Amazon Pinpoint analytics metadata for collecting metrics for - // RespondToAuthChallenge calls. - AnalyticsMetadata *types.AnalyticsMetadataType - // The session which should be passed both ways in challenge-response calls to the // service. If InitiateAuth or RespondToAuthChallenge API call determines that the // caller needs to go through another challenge, they return a session with other @@ -147,15 +147,15 @@ type RespondToAuthChallengeOutput struct { // The challenge name. For more information, see . ChallengeName types.ChallengeNameType + // The challenge parameters. For more information, see . + ChallengeParameters map[string]*string + // The session which should be passed both ways in challenge-response calls to the // service. If the or API call determines that the caller needs to go through // another challenge, they return a session with other challenge parameters. This // session should be passed as it is to the next RespondToAuthChallenge API call. Session *string - // The challenge parameters. For more information, see . - ChallengeParameters map[string]*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cognitoidentityprovider/api_op_SetRiskConfiguration.go b/service/cognitoidentityprovider/api_op_SetRiskConfiguration.go index fd6d18640db..167badd9b74 100644 --- a/service/cognitoidentityprovider/api_op_SetRiskConfiguration.go +++ b/service/cognitoidentityprovider/api_op_SetRiskConfiguration.go @@ -60,19 +60,13 @@ func (c *Client) SetRiskConfiguration(ctx context.Context, params *SetRiskConfig type SetRiskConfigurationInput struct { - // The configuration to override the risk decision. - RiskExceptionConfiguration *types.RiskExceptionConfigurationType - - // The account takeover risk configuration. - AccountTakeoverRiskConfiguration *types.AccountTakeoverRiskConfigurationType - // The user pool ID. // // This member is required. UserPoolId *string - // The compromised credentials risk configuration. - CompromisedCredentialsRiskConfiguration *types.CompromisedCredentialsRiskConfigurationType + // The account takeover risk configuration. + AccountTakeoverRiskConfiguration *types.AccountTakeoverRiskConfigurationType // The app client ID. If ClientId is null, then the risk configuration is mapped to // userPoolId. When the client ID is null, the same risk configuration is applied @@ -80,6 +74,12 @@ type SetRiskConfigurationInput struct { // When the client ID is not null, the user pool configuration is overridden and // the risk configuration for the client is used instead. ClientId *string + + // The compromised credentials risk configuration. + CompromisedCredentialsRiskConfiguration *types.CompromisedCredentialsRiskConfigurationType + + // The configuration to override the risk decision. + RiskExceptionConfiguration *types.RiskExceptionConfigurationType } type SetRiskConfigurationOutput struct { diff --git a/service/cognitoidentityprovider/api_op_SetUICustomization.go b/service/cognitoidentityprovider/api_op_SetUICustomization.go index 683318eaabc..744e9167b2a 100644 --- a/service/cognitoidentityprovider/api_op_SetUICustomization.go +++ b/service/cognitoidentityprovider/api_op_SetUICustomization.go @@ -64,9 +64,6 @@ func (c *Client) SetUICustomization(ctx context.Context, params *SetUICustomizat type SetUICustomizationInput struct { - // The client ID for the client app. - ClientId *string - // The user pool ID for the user pool. // // This member is required. @@ -75,6 +72,9 @@ type SetUICustomizationInput struct { // The CSS values in the UI customization. CSS *string + // The client ID for the client app. + ClientId *string + // The uploaded logo image for the UI customization. ImageFile []byte } diff --git a/service/cognitoidentityprovider/api_op_SetUserMFAPreference.go b/service/cognitoidentityprovider/api_op_SetUserMFAPreference.go index 95cf9072f97..1891a210636 100644 --- a/service/cognitoidentityprovider/api_op_SetUserMFAPreference.go +++ b/service/cognitoidentityprovider/api_op_SetUserMFAPreference.go @@ -67,11 +67,11 @@ type SetUserMFAPreferenceInput struct { // This member is required. AccessToken *string - // The time-based one-time password software token MFA settings. - SoftwareTokenMfaSettings *types.SoftwareTokenMfaSettingsType - // The SMS text message multi-factor authentication (MFA) settings. SMSMfaSettings *types.SMSMfaSettingsType + + // The time-based one-time password software token MFA settings. + SoftwareTokenMfaSettings *types.SoftwareTokenMfaSettingsType } type SetUserMFAPreferenceOutput struct { diff --git a/service/cognitoidentityprovider/api_op_SetUserPoolMfaConfig.go b/service/cognitoidentityprovider/api_op_SetUserPoolMfaConfig.go index 51e95935421..ac11f7517a3 100644 --- a/service/cognitoidentityprovider/api_op_SetUserPoolMfaConfig.go +++ b/service/cognitoidentityprovider/api_op_SetUserPoolMfaConfig.go @@ -73,11 +73,11 @@ type SetUserPoolMfaConfigInput struct { // MFA will be required only for individual users who have an MFA factor enabled. MfaConfiguration types.UserPoolMfaType - // The software token MFA configuration. - SoftwareTokenMfaConfiguration *types.SoftwareTokenMfaConfigType - // The SMS text message MFA configuration. SmsMfaConfiguration *types.SmsMfaConfigType + + // The software token MFA configuration. + SoftwareTokenMfaConfiguration *types.SoftwareTokenMfaConfigType } type SetUserPoolMfaConfigOutput struct { @@ -93,12 +93,12 @@ type SetUserPoolMfaConfigOutput struct { // MFA will be required only for individual users who have an MFA factor enabled. MfaConfiguration types.UserPoolMfaType - // The software token MFA configuration. - SoftwareTokenMfaConfiguration *types.SoftwareTokenMfaConfigType - // The SMS text message MFA configuration. SmsMfaConfiguration *types.SmsMfaConfigType + // The software token MFA configuration. + SoftwareTokenMfaConfiguration *types.SoftwareTokenMfaConfigType + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cognitoidentityprovider/api_op_SignUp.go b/service/cognitoidentityprovider/api_op_SignUp.go index 0f65f462ac0..3354dad8b2d 100644 --- a/service/cognitoidentityprovider/api_op_SignUp.go +++ b/service/cognitoidentityprovider/api_op_SignUp.go @@ -56,11 +56,24 @@ func (c *Client) SignUp(ctx context.Context, params *SignUpInput, optFns ...func // Represents the request to register a user. type SignUpInput struct { + // The ID of the client associated with the user pool. + // + // This member is required. + ClientId *string + + // The password of the user you wish to register. + // + // This member is required. + Password *string + // The user name of the user you wish to register. // // This member is required. Username *string + // The Amazon Pinpoint analytics metadata for collecting metrics for SignUp calls. + AnalyticsMetadata *types.AnalyticsMetadataType + // A map of custom key-value pairs that you can provide as input for any custom // workflows that this action triggers. You create custom workflows by assigning // AWS Lambda functions to user pool triggers. When you use the SignUp API action, @@ -89,32 +102,19 @@ type SignUpInput struct { // ClientMetadata value, so don't use it to provide sensitive information. ClientMetadata map[string]*string - // The password of the user you wish to register. - // - // This member is required. - Password *string - - // The Amazon Pinpoint analytics metadata for collecting metrics for SignUp calls. - AnalyticsMetadata *types.AnalyticsMetadataType + // A keyed-hash message authentication code (HMAC) calculated using the secret key + // of a user pool client and username plus the client ID in the message. + SecretHash *string // An array of name-value pairs representing user attributes. For custom // attributes, you must prepend the custom: prefix to the attribute name. UserAttributes []*types.AttributeType - // The ID of the client associated with the user pool. - // - // This member is required. - ClientId *string - // Contextual data such as the user's device fingerprint, IP address, or location // used for evaluating the risk of an unexpected event by Amazon Cognito advanced // security. UserContextData *types.UserContextDataType - // A keyed-hash message authentication code (HMAC) calculated using the secret key - // of a user pool client and username plus the client ID in the message. - SecretHash *string - // The validation data in the request to register a user. ValidationData []*types.AttributeType } diff --git a/service/cognitoidentityprovider/api_op_TagResource.go b/service/cognitoidentityprovider/api_op_TagResource.go index 36c18ecf043..cd04ce755e2 100644 --- a/service/cognitoidentityprovider/api_op_TagResource.go +++ b/service/cognitoidentityprovider/api_op_TagResource.go @@ -68,15 +68,15 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The tags to assign to the user pool. + // The Amazon Resource Name (ARN) of the user pool to assign the tags to. // // This member is required. - Tags map[string]*string + ResourceArn *string - // The Amazon Resource Name (ARN) of the user pool to assign the tags to. + // The tags to assign to the user pool. // // This member is required. - ResourceArn *string + Tags map[string]*string } type TagResourceOutput struct { diff --git a/service/cognitoidentityprovider/api_op_UpdateAuthEventFeedback.go b/service/cognitoidentityprovider/api_op_UpdateAuthEventFeedback.go index cf93c5f0da1..037e43d1cf6 100644 --- a/service/cognitoidentityprovider/api_op_UpdateAuthEventFeedback.go +++ b/service/cognitoidentityprovider/api_op_UpdateAuthEventFeedback.go @@ -59,25 +59,25 @@ func (c *Client) UpdateAuthEventFeedback(ctx context.Context, params *UpdateAuth type UpdateAuthEventFeedbackInput struct { - // The user pool ID. + // The event ID. // // This member is required. - UserPoolId *string + EventId *string - // The authentication event feedback value. + // The feedback token. // // This member is required. - FeedbackValue types.FeedbackValueType + FeedbackToken *string - // The event ID. + // The authentication event feedback value. // // This member is required. - EventId *string + FeedbackValue types.FeedbackValueType - // The feedback token. + // The user pool ID. // // This member is required. - FeedbackToken *string + UserPoolId *string // The user pool username. // diff --git a/service/cognitoidentityprovider/api_op_UpdateGroup.go b/service/cognitoidentityprovider/api_op_UpdateGroup.go index 759341c4614..fac5754bee8 100644 --- a/service/cognitoidentityprovider/api_op_UpdateGroup.go +++ b/service/cognitoidentityprovider/api_op_UpdateGroup.go @@ -69,6 +69,9 @@ type UpdateGroupInput struct { // This member is required. UserPoolId *string + // A string containing the new description of the group. + Description *string + // The new precedence value for the group. For more information about this // parameter, see . Precedence *int32 @@ -76,9 +79,6 @@ type UpdateGroupInput struct { // The new role ARN for the group. This is used for setting the cognito:roles and // cognito:preferred_role claims in the token. RoleArn *string - - // A string containing the new description of the group. - Description *string } type UpdateGroupOutput struct { diff --git a/service/cognitoidentityprovider/api_op_UpdateIdentityProvider.go b/service/cognitoidentityprovider/api_op_UpdateIdentityProvider.go index 742dff0586d..9c4cbfcaa90 100644 --- a/service/cognitoidentityprovider/api_op_UpdateIdentityProvider.go +++ b/service/cognitoidentityprovider/api_op_UpdateIdentityProvider.go @@ -57,22 +57,22 @@ func (c *Client) UpdateIdentityProvider(ctx context.Context, params *UpdateIdent type UpdateIdentityProviderInput struct { - // A list of identity provider identifiers. - IdpIdentifiers []*string - // The identity provider name. // // This member is required. ProviderName *string - // The identity provider attribute mapping to be changed. - AttributeMapping map[string]*string - // The user pool ID. // // This member is required. UserPoolId *string + // The identity provider attribute mapping to be changed. + AttributeMapping map[string]*string + + // A list of identity provider identifiers. + IdpIdentifiers []*string + // The identity provider details to be updated, such as MetadataURL and // MetadataFile. ProviderDetails map[string]*string diff --git a/service/cognitoidentityprovider/api_op_UpdateResourceServer.go b/service/cognitoidentityprovider/api_op_UpdateResourceServer.go index a8ed93dd388..07dbfce4904 100644 --- a/service/cognitoidentityprovider/api_op_UpdateResourceServer.go +++ b/service/cognitoidentityprovider/api_op_UpdateResourceServer.go @@ -64,15 +64,15 @@ type UpdateResourceServerInput struct { // This member is required. Identifier *string - // The user pool ID for the user pool. + // The name of the resource server. // // This member is required. - UserPoolId *string + Name *string - // The name of the resource server. + // The user pool ID for the user pool. // // This member is required. - Name *string + UserPoolId *string // The scope values to be set for the resource server. Scopes []*types.ResourceServerScopeType diff --git a/service/cognitoidentityprovider/api_op_UpdateUserAttributes.go b/service/cognitoidentityprovider/api_op_UpdateUserAttributes.go index 344c918d62b..77d8f56e09d 100644 --- a/service/cognitoidentityprovider/api_op_UpdateUserAttributes.go +++ b/service/cognitoidentityprovider/api_op_UpdateUserAttributes.go @@ -55,6 +55,17 @@ func (c *Client) UpdateUserAttributes(ctx context.Context, params *UpdateUserAtt // Represents the request to update user attributes. type UpdateUserAttributesInput struct { + // The access token for the request to update user attributes. + // + // This member is required. + AccessToken *string + + // An array of name-value pairs representing user attributes. For custom + // attributes, you must prepend the custom: prefix to the attribute name. + // + // This member is required. + UserAttributes []*types.AttributeType + // A map of custom key-value pairs that you can provide as input for any custom // workflows that this action triggers. You create custom workflows by assigning // AWS Lambda functions to user pool triggers. When you use the @@ -82,17 +93,6 @@ type UpdateUserAttributesInput struct { // * Amazon Cognito does not encrypt the the // ClientMetadata value, so don't use it to provide sensitive information. ClientMetadata map[string]*string - - // An array of name-value pairs representing user attributes. For custom - // attributes, you must prepend the custom: prefix to the attribute name. - // - // This member is required. - UserAttributes []*types.AttributeType - - // The access token for the request to update user attributes. - // - // This member is required. - AccessToken *string } // Represents the response from the server for the request to update user diff --git a/service/cognitoidentityprovider/api_op_UpdateUserPool.go b/service/cognitoidentityprovider/api_op_UpdateUserPool.go index 649a44df702..5fc66c2329d 100644 --- a/service/cognitoidentityprovider/api_op_UpdateUserPool.go +++ b/service/cognitoidentityprovider/api_op_UpdateUserPool.go @@ -60,24 +60,39 @@ func (c *Client) UpdateUserPool(ctx context.Context, params *UpdateUserPoolInput // Represents the request to update the user pool. type UpdateUserPoolInput struct { - // Used to enable advanced security risk detection. Set the key - // AdvancedSecurityMode to the value "AUDIT". - UserPoolAddOns *types.UserPoolAddOnsType + // The user pool ID for the user pool you want to update. + // + // This member is required. + UserPoolId *string - // A container with information about the SMS verification message. - SmsVerificationMessage *string + // Use this setting to define which verified available method a user can use to + // recover their password when they call ForgotPassword. It allows you to define a + // preferred method when a user has more than one method available. With this + // setting, SMS does not qualify for a valid password recovery mechanism if the + // user also has SMS MFA enabled. In the absence of this setting, Cognito uses the + // legacy behavior to determine the recovery method where SMS is preferred over + // email. + AccountRecoverySetting *types.AccountRecoverySettingType + + // The configuration for AdminCreateUser requests. + AdminCreateUserConfig *types.AdminCreateUserConfigType + + // The attributes that are automatically verified when the Amazon Cognito service + // makes a request to update user pools. + AutoVerifiedAttributes []types.VerifiedAttributeType + + // Device configuration. + DeviceConfiguration *types.DeviceConfigurationType // Email configuration. EmailConfiguration *types.EmailConfigurationType + // The contents of the email verification message. + EmailVerificationMessage *string + // The subject of the email verification message. EmailVerificationSubject *string - // The user pool ID for the user pool you want to update. - // - // This member is required. - UserPoolId *string - // The AWS Lambda configuration information from the request to update the user // pool. LambdaConfig *types.LambdaConfigType @@ -95,41 +110,26 @@ type UpdateUserPoolInput struct { // registering to create an MFA token. MfaConfiguration types.UserPoolMfaType - // The contents of the email verification message. - EmailVerificationMessage *string - - // Device configuration. - DeviceConfiguration *types.DeviceConfigurationType - - // The tag keys and values to assign to the user pool. A tag is a label that you - // can use to categorize and manage user pools in different ways, such as by - // purpose, owner, environment, or other criteria. - UserPoolTags map[string]*string - - // The attributes that are automatically verified when the Amazon Cognito service - // makes a request to update user pools. - AutoVerifiedAttributes []types.VerifiedAttributeType + // A container with the policies you wish to update in a user pool. + Policies *types.UserPoolPolicyType // The contents of the SMS authentication message. SmsAuthenticationMessage *string - // Use this setting to define which verified available method a user can use to - // recover their password when they call ForgotPassword. It allows you to define a - // preferred method when a user has more than one method available. With this - // setting, SMS does not qualify for a valid password recovery mechanism if the - // user also has SMS MFA enabled. In the absence of this setting, Cognito uses the - // legacy behavior to determine the recovery method where SMS is preferred over - // email. - AccountRecoverySetting *types.AccountRecoverySettingType + // SMS configuration. + SmsConfiguration *types.SmsConfigurationType - // A container with the policies you wish to update in a user pool. - Policies *types.UserPoolPolicyType + // A container with information about the SMS verification message. + SmsVerificationMessage *string - // The configuration for AdminCreateUser requests. - AdminCreateUserConfig *types.AdminCreateUserConfigType + // Used to enable advanced security risk detection. Set the key + // AdvancedSecurityMode to the value "AUDIT". + UserPoolAddOns *types.UserPoolAddOnsType - // SMS configuration. - SmsConfiguration *types.SmsConfigurationType + // The tag keys and values to assign to the user pool. A tag is a label that you + // can use to categorize and manage user pools in different ways, such as by + // purpose, owner, environment, or other criteria. + UserPoolTags map[string]*string // The template for verification messages. VerificationMessageTemplate *types.VerificationMessageTemplateType diff --git a/service/cognitoidentityprovider/api_op_UpdateUserPoolClient.go b/service/cognitoidentityprovider/api_op_UpdateUserPoolClient.go index 046ada63fb8..1875483e2aa 100644 --- a/service/cognitoidentityprovider/api_op_UpdateUserPoolClient.go +++ b/service/cognitoidentityprovider/api_op_UpdateUserPoolClient.go @@ -60,9 +60,41 @@ func (c *Client) UpdateUserPoolClient(ctx context.Context, params *UpdateUserPoo // Represents the request to update the user pool client. type UpdateUserPoolClientInput struct { - // A list of provider names for the identity providers that are supported on this + // The ID of the client associated with the user pool. + // + // This member is required. + ClientId *string + + // The user pool ID for the user pool where you want to update the user pool // client. - SupportedIdentityProviders []*string + // + // This member is required. + UserPoolId *string + + // The allowed OAuth flows. Set to code to initiate a code grant flow, which + // provides an authorization code as the response. This code can be exchanged for + // access tokens with the token endpoint. Set to implicit to specify that the + // client should get the access token (and, optionally, ID token, based on scopes) + // directly. Set to client_credentials to specify that the client should get the + // access token (and, optionally, ID token, based on scopes) from the token + // endpoint using a combination of client and client_secret. + AllowedOAuthFlows []types.OAuthFlowType + + // Set to true if the client is allowed to follow the OAuth protocol when + // interacting with Cognito user pools. + AllowedOAuthFlowsUserPoolClient *bool + + // The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, + // openid, and profile. Possible values provided by AWS are: + // aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are + // also supported. + AllowedOAuthScopes []*string + + // The Amazon Pinpoint analytics configuration for collecting metrics for this user + // pool. Cognito User Pools only supports sending events to Amazon Pinpoint + // projects in the US East (N. Virginia) us-east-1 Region, regardless of the region + // in which the user pool resides. + AnalyticsConfiguration *types.AnalyticsConfigurationType // A list of allowed redirect (callback) URLs for the identity providers. A // redirect URI must: @@ -80,24 +112,54 @@ type UpdateUserPoolClientInput struct { // purposes only. App callback URLs such as myapp://example are also supported. CallbackURLs []*string - // The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, - // openid, and profile. Possible values provided by AWS are: - // aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are - // also supported. - AllowedOAuthScopes []*string + // The client name from the update user pool client request. + ClientName *string - // The ID of the client associated with the user pool. + // The default redirect URI. Must be in the CallbackURLs list. A redirect URI + // must: // - // This member is required. - ClientId *string + // * Be an absolute URI. + // + // * Be registered with the authorization + // server. + // + // * Not include a fragment component. + // + // See OAuth 2.0 - Redirection + // Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2). Amazon Cognito + // requires HTTPS over HTTP except for http://localhost for testing purposes only. + // App callback URLs such as myapp://example are also supported. + DefaultRedirectURI *string + + // The authentication flows that are supported by the user pool clients. Flow names + // without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ + // prefix. Note that values with ALLOW_ prefix cannot be used along with values + // without ALLOW_ prefix. Valid values include: + // + // * + // ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication + // flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH + // setting. With this authentication flow, Cognito receives the password in the + // request instead of using the SRP (Secure Remote Password protocol) protocol to + // verify passwords. + // + // * ALLOW_CUSTOM_AUTH: Enable Lambda trigger based + // authentication. + // + // * ALLOW_USER_PASSWORD_AUTH: Enable user password-based + // authentication. In this flow, Cognito receives the password in the request + // instead of using the SRP protocol to verify passwords. + // + // * + // ALLOW_USER_SRP_AUTH: Enable SRP based authentication. + // + // * + // ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens. + ExplicitAuthFlows []types.ExplicitAuthFlowsType // A list of allowed logout URLs for the identity providers. LogoutURLs []*string - // The time limit, in days, after which the refresh token is no longer valid and - // cannot be used. - RefreshTokenValidity *int32 - // Use this setting to choose which errors and responses are returned by Cognito // APIs during authentication, account confirmation, and password recovery when the // user does not exist in the user pool. When set to ENABLED and the user does not @@ -140,81 +202,19 @@ type UpdateUserPoolClientInput struct { // created user pool clients if no value is provided. PreventUserExistenceErrors types.PreventUserExistenceErrorTypes - // The writeable attributes of the user pool. - WriteAttributes []*string + // The read-only attributes of the user pool. + ReadAttributes []*string - // The Amazon Pinpoint analytics configuration for collecting metrics for this user - // pool. Cognito User Pools only supports sending events to Amazon Pinpoint - // projects in the US East (N. Virginia) us-east-1 Region, regardless of the region - // in which the user pool resides. - AnalyticsConfiguration *types.AnalyticsConfigurationType + // The time limit, in days, after which the refresh token is no longer valid and + // cannot be used. + RefreshTokenValidity *int32 - // The user pool ID for the user pool where you want to update the user pool + // A list of provider names for the identity providers that are supported on this // client. - // - // This member is required. - UserPoolId *string - - // The allowed OAuth flows. Set to code to initiate a code grant flow, which - // provides an authorization code as the response. This code can be exchanged for - // access tokens with the token endpoint. Set to implicit to specify that the - // client should get the access token (and, optionally, ID token, based on scopes) - // directly. Set to client_credentials to specify that the client should get the - // access token (and, optionally, ID token, based on scopes) from the token - // endpoint using a combination of client and client_secret. - AllowedOAuthFlows []types.OAuthFlowType - - // The client name from the update user pool client request. - ClientName *string - - // The authentication flows that are supported by the user pool clients. Flow names - // without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ - // prefix. Note that values with ALLOW_ prefix cannot be used along with values - // without ALLOW_ prefix. Valid values include: - // - // * - // ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication - // flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH - // setting. With this authentication flow, Cognito receives the password in the - // request instead of using the SRP (Secure Remote Password protocol) protocol to - // verify passwords. - // - // * ALLOW_CUSTOM_AUTH: Enable Lambda trigger based - // authentication. - // - // * ALLOW_USER_PASSWORD_AUTH: Enable user password-based - // authentication. In this flow, Cognito receives the password in the request - // instead of using the SRP protocol to verify passwords. - // - // * - // ALLOW_USER_SRP_AUTH: Enable SRP based authentication. - // - // * - // ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens. - ExplicitAuthFlows []types.ExplicitAuthFlowsType - - // Set to true if the client is allowed to follow the OAuth protocol when - // interacting with Cognito user pools. - AllowedOAuthFlowsUserPoolClient *bool - - // The default redirect URI. Must be in the CallbackURLs list. A redirect URI - // must: - // - // * Be an absolute URI. - // - // * Be registered with the authorization - // server. - // - // * Not include a fragment component. - // - // See OAuth 2.0 - Redirection - // Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2). Amazon Cognito - // requires HTTPS over HTTP except for http://localhost for testing purposes only. - // App callback URLs such as myapp://example are also supported. - DefaultRedirectURI *string + SupportedIdentityProviders []*string - // The read-only attributes of the user pool. - ReadAttributes []*string + // The writeable attributes of the user pool. + WriteAttributes []*string } // Represents the response from the server to the request to update the user pool diff --git a/service/cognitoidentityprovider/api_op_UpdateUserPoolDomain.go b/service/cognitoidentityprovider/api_op_UpdateUserPoolDomain.go index 76d16f7e7a7..a65ae1dd1f5 100644 --- a/service/cognitoidentityprovider/api_op_UpdateUserPoolDomain.go +++ b/service/cognitoidentityprovider/api_op_UpdateUserPoolDomain.go @@ -76,6 +76,13 @@ func (c *Client) UpdateUserPoolDomain(ctx context.Context, params *UpdateUserPoo // The UpdateUserPoolDomain request input. type UpdateUserPoolDomainInput struct { + // The configuration for a custom domain that hosts the sign-up and sign-in pages + // for your application. Use this object to specify an SSL certificate that is + // managed by ACM. + // + // This member is required. + CustomDomainConfig *types.CustomDomainConfigType + // The domain name for the custom domain that hosts the sign-up and sign-in pages // for your application. For example: auth.example.com. This string can include // only lowercase letters, numbers, and hyphens. Do not use a hyphen for the first @@ -84,13 +91,6 @@ type UpdateUserPoolDomainInput struct { // This member is required. Domain *string - // The configuration for a custom domain that hosts the sign-up and sign-in pages - // for your application. Use this object to specify an SSL certificate that is - // managed by ACM. - // - // This member is required. - CustomDomainConfig *types.CustomDomainConfigType - // The ID of the user pool that is associated with the custom domain that you are // updating the certificate for. // diff --git a/service/cognitoidentityprovider/api_op_VerifySoftwareToken.go b/service/cognitoidentityprovider/api_op_VerifySoftwareToken.go index 5bd9e41ffca..f2feccfa731 100644 --- a/service/cognitoidentityprovider/api_op_VerifySoftwareToken.go +++ b/service/cognitoidentityprovider/api_op_VerifySoftwareToken.go @@ -59,13 +59,6 @@ func (c *Client) VerifySoftwareToken(ctx context.Context, params *VerifySoftware type VerifySoftwareTokenInput struct { - // The friendly device name. - FriendlyDeviceName *string - - // The session which should be passed both ways in challenge-response calls to the - // service. - Session *string - // The one time password computed using the secret code returned by // // This member is required. @@ -73,17 +66,24 @@ type VerifySoftwareTokenInput struct { // The access token. AccessToken *string + + // The friendly device name. + FriendlyDeviceName *string + + // The session which should be passed both ways in challenge-response calls to the + // service. + Session *string } type VerifySoftwareTokenOutput struct { - // The status of the verify software token. - Status types.VerifySoftwareTokenResponseType - // The session which should be passed both ways in challenge-response calls to the // service. Session *string + // The status of the verify software token. + Status types.VerifySoftwareTokenResponseType + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cognitoidentityprovider/api_op_VerifyUserAttribute.go b/service/cognitoidentityprovider/api_op_VerifyUserAttribute.go index 0cd174c89cb..49fbb418b21 100644 --- a/service/cognitoidentityprovider/api_op_VerifyUserAttribute.go +++ b/service/cognitoidentityprovider/api_op_VerifyUserAttribute.go @@ -59,15 +59,15 @@ type VerifyUserAttributeInput struct { // This member is required. AccessToken *string - // The verification code in the request to verify user attributes. + // The attribute name in the request to verify user attributes. // // This member is required. - Code *string + AttributeName *string - // The attribute name in the request to verify user attributes. + // The verification code in the request to verify user attributes. // // This member is required. - AttributeName *string + Code *string } // A container representing the response from the server from the request to verify diff --git a/service/cognitoidentityprovider/go.mod b/service/cognitoidentityprovider/go.mod index 0ee458d88a9..78cc88ba250 100644 --- a/service/cognitoidentityprovider/go.mod +++ b/service/cognitoidentityprovider/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/cognitoidentityprovider go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/cognitoidentityprovider/types/types.go b/service/cognitoidentityprovider/types/types.go index 2016388183c..40d4c753b81 100644 --- a/service/cognitoidentityprovider/types/types.go +++ b/service/cognitoidentityprovider/types/types.go @@ -19,21 +19,16 @@ type AccountTakeoverActionsType struct { // Action to take for a high risk. HighAction *AccountTakeoverActionType - // Action to take for a medium risk. - MediumAction *AccountTakeoverActionType - // Action to take for a low risk. LowAction *AccountTakeoverActionType + + // Action to take for a medium risk. + MediumAction *AccountTakeoverActionType } // Account takeover action type. type AccountTakeoverActionType struct { - // Flag specifying whether to send a notification. - // - // This member is required. - Notify *bool - // The event action. // // * BLOCK Choosing this action will block the request. @@ -49,19 +44,24 @@ type AccountTakeoverActionType struct { // // This member is required. EventAction AccountTakeoverEventActionType + + // Flag specifying whether to send a notification. + // + // This member is required. + Notify *bool } // Configuration for mitigation actions and notification for different levels of // risk detected for a potential account takeover. type AccountTakeoverRiskConfigurationType struct { - // The notify configuration used to construct email notifications. - NotifyConfiguration *NotifyConfigurationType - // Account takeover risk configuration actions // // This member is required. Actions *AccountTakeoverActionsType + + // The notify configuration used to construct email notifications. + NotifyConfiguration *NotifyConfigurationType } // The configuration for creating a new user profile. @@ -71,6 +71,11 @@ type AdminCreateUserConfigType struct { // False if users can sign themselves up via an app. AllowAdminCreateUserOnly *bool + // The message template to be used for the welcome message to new users. See also + // Customizing User Invitation Messages + // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization). + InviteMessageTemplate *MessageTemplateType + // The user account expiration limit, in days, after which the account is no longer // usable. To reset the account after that time limit, you must call // AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. The @@ -78,11 +83,6 @@ type AdminCreateUserConfigType struct { // TemporaryPasswordValidityDays in PasswordPolicy, that value will be used and // UnusedAccountValidityDays will be deprecated for that user pool. UnusedAccountValidityDays *int32 - - // The message template to be used for the welcome message to new users. See also - // Customizing User Invitation Messages - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization). - InviteMessageTemplate *MessageTemplateType } // The Amazon Pinpoint analytics configuration for collecting metrics for a user @@ -91,25 +91,25 @@ type AdminCreateUserConfigType struct { // in which the user pool resides. type AnalyticsConfigurationType struct { - // If UserDataShared is true, Amazon Cognito will include user data in the events - // it publishes to Amazon Pinpoint analytics. - UserDataShared *bool - - // The ARN of an IAM role that authorizes Amazon Cognito to publish events to - // Amazon Pinpoint analytics. + // The application ID for an Amazon Pinpoint application. // // This member is required. - RoleArn *string + ApplicationId *string // The external ID. // // This member is required. ExternalId *string - // The application ID for an Amazon Pinpoint application. + // The ARN of an IAM role that authorizes Amazon Cognito to publish events to + // Amazon Pinpoint analytics. // // This member is required. - ApplicationId *string + RoleArn *string + + // If UserDataShared is true, Amazon Cognito will include user data in the events + // it publishes to Amazon Pinpoint analytics. + UserDataShared *bool } // An Amazon Pinpoint analytics endpoint. An endpoint uniquely identifies a mobile @@ -138,39 +138,33 @@ type AttributeType struct { // The authentication result. type AuthenticationResultType struct { - // The token type. - TokenType *string - // The access token. AccessToken *string + // The expiration period of the authentication result in seconds. + ExpiresIn *int32 + + // The ID token. + IdToken *string + // The new device metadata from an authentication result. NewDeviceMetadata *NewDeviceMetadataType // The refresh token. RefreshToken *string - // The ID token. - IdToken *string - - // The expiration period of the authentication result in seconds. - ExpiresIn *int32 + // The token type. + TokenType *string } // The authentication event type. type AuthEventType struct { - // The event type. - EventType EventType - // The challenge responses. ChallengeResponses []*ChallengeResponseType - // The event ID. - EventId *string - - // The event response. - EventResponse EventResponseType + // The creation date + CreationDate *time.Time // The user context data captured at the time of an event request. It provides // additional information about the client from which event the request is @@ -181,11 +175,17 @@ type AuthEventType struct { // good or bad. EventFeedback *EventFeedbackType - // The creation date - CreationDate *time.Time + // The event ID. + EventId *string + + // The event response. + EventResponse EventResponseType // The event risk. EventRisk *EventRiskType + + // The event type. + EventType EventType } // The challenge response type. @@ -204,11 +204,11 @@ type CodeDeliveryDetailsType struct { // The attribute name. AttributeName *string - // The destination for the code delivery details. - Destination *string - // The delivery medium (email message or phone number). DeliveryMedium DeliveryMediumType + + // The destination for the code delivery details. + Destination *string } // The compromised credentials actions type @@ -223,14 +223,14 @@ type CompromisedCredentialsActionsType struct { // The compromised credentials risk configuration type. type CompromisedCredentialsRiskConfigurationType struct { - // Perform the action for these events. The default is to perform all events if no - // event filter is specified. - EventFilter []EventFilterType - // The compromised credentials risk configuration actions. // // This member is required. Actions *CompromisedCredentialsActionsType + + // Perform the action for these events. The default is to perform all events if no + // event filter is specified. + EventFilter []EventFilterType } // Contextual user data type used for evaluating the risk of an unexpected event by @@ -242,10 +242,6 @@ type ContextDataType struct { // This member is required. HttpHeaders []*HttpHeader - // Encoded data containing device fingerprinting details, collected using the - // Amazon Cognito context data collection library. - EncodedData *string - // Source IP address of your user. // // This member is required. @@ -260,6 +256,10 @@ type ContextDataType struct { // // This member is required. ServerPath *string + + // Encoded data containing device fingerprinting details, collected using the + // Amazon Cognito context data collection library. + EncodedData *string } // The configuration for a custom domain that hosts the sign-up and sign-in @@ -276,12 +276,12 @@ type CustomDomainConfigType struct { // The configuration for the user pool's device tracking. type DeviceConfigurationType struct { - // If true, a device is only remembered on user prompt. - DeviceOnlyRememberedOnUserPrompt *bool - // Indicates whether a challenge is required on a new device. Only applicable to a // new device. ChallengeRequiredOnNewDevice *bool + + // If true, a device is only remembered on user prompt. + DeviceOnlyRememberedOnUserPrompt *bool } // The device verifier against which it will be authenticated. @@ -297,58 +297,70 @@ type DeviceSecretVerifierConfigType struct { // The device type. type DeviceType struct { + // The device attributes. + DeviceAttributes []*AttributeType + // The creation date of the device. DeviceCreateDate *time.Time - // The date in which the device was last authenticated. - DeviceLastAuthenticatedDate *time.Time - // The device key. DeviceKey *string + // The date in which the device was last authenticated. + DeviceLastAuthenticatedDate *time.Time + // The last modified date of the device. DeviceLastModifiedDate *time.Time - - // The device attributes. - DeviceAttributes []*AttributeType } // A container for information about a domain. type DomainDescriptionType struct { - // The S3 bucket where the static files for this domain are stored. - S3Bucket *string - - // The domain string. - Domain *string - // The AWS account ID for the user pool owner. AWSAccountId *string - // The app version. - Version *string - // The ARN of the CloudFront distribution. CloudFrontDistribution *string - // The user pool ID. - UserPoolId *string + // The configuration for a custom domain that hosts the sign-up and sign-in + // webpages for your application. + CustomDomainConfig *CustomDomainConfigType + + // The domain string. + Domain *string + + // The S3 bucket where the static files for this domain are stored. + S3Bucket *string // The domain status. Status DomainStatusType - // The configuration for a custom domain that hosts the sign-up and sign-in - // webpages for your application. - CustomDomainConfig *CustomDomainConfigType + // The user pool ID. + UserPoolId *string + + // The app version. + Version *string } // The email configuration type. type EmailConfigurationType struct { - // Identifies either the sender’s email address or the sender’s name with their - // email address. For example, testuser@example.com or Test User . This address - // will appear before the body of the email. - From *string + // The set of configuration rules that can be applied to emails sent using Amazon + // SES. A configuration set is applied to an email by including a reference to the + // configuration set in the headers of the email. Once applied, all of the rules in + // that configuration set are applied to the email. Configuration sets can be used + // to apply the following types of rules to emails: + // + // * Event publishing – + // Amazon SES can track the number of send, delivery, open, click, bounce, and + // complaint events for each email sent. Use event publishing to send information + // about these events to other AWS services such as SNS and CloudWatch. + // + // * IP + // pool management – When leasing dedicated IP addresses with Amazon SES, you can + // create groups of IP addresses, called dedicated IP pools. You can then associate + // the dedicated IP pools with configuration sets. + ConfigurationSet *string // Specifies whether Amazon Cognito emails your users by using its built-in email // functionality or your Amazon SES email configuration. Specify one of the @@ -379,22 +391,10 @@ type EmailConfigurationType struct { // in the Amazon Cognito Developer Guide. EmailSendingAccount EmailSendingAccountType - // The set of configuration rules that can be applied to emails sent using Amazon - // SES. A configuration set is applied to an email by including a reference to the - // configuration set in the headers of the email. Once applied, all of the rules in - // that configuration set are applied to the email. Configuration sets can be used - // to apply the following types of rules to emails: - // - // * Event publishing – - // Amazon SES can track the number of send, delivery, open, click, bounce, and - // complaint events for each email sent. Use event publishing to send information - // about these events to other AWS services such as SNS and CloudWatch. - // - // * IP - // pool management – When leasing dedicated IP addresses with Amazon SES, you can - // create groups of IP addresses, called dedicated IP pools. You can then associate - // the dedicated IP pools with configuration sets. - ConfigurationSet *string + // Identifies either the sender’s email address or the sender’s name with their + // email address. For example, testuser@example.com or Test User . This address + // will appear before the body of the email. + From *string // The destination to which the receiver of the email should reply to. ReplyToEmailAddress *string @@ -416,25 +416,30 @@ type EmailConfigurationType struct { // Specifies the user context data captured at the time of an event request. type EventContextDataType struct { + // The user's city. + City *string + // The user's country. Country *string + // The user's device name. + DeviceName *string + // The user's IP address. IpAddress *string - // The user's city. - City *string - // The user's time zone. Timezone *string - - // The user's device name. - DeviceName *string } // Specifies the event feedback type. type EventFeedbackType struct { + // The event feedback value. + // + // This member is required. + FeedbackValue FeedbackValueType + // The provider. // // This member is required. @@ -442,23 +447,18 @@ type EventFeedbackType struct { // The event feedback date. FeedbackDate *time.Time - - // The event feedback value. - // - // This member is required. - FeedbackValue FeedbackValueType } // The event risk type. type EventRiskType struct { - // The risk decision. - RiskDecision RiskDecisionType - // Indicates whether compromised credentials were detected during an authentication // event. CompromisedCredentialsDetected *bool + // The risk decision. + RiskDecision RiskDecisionType + // The risk level. RiskLevel RiskLevelType } @@ -466,6 +466,18 @@ type EventRiskType struct { // The group type. type GroupType struct { + // The date the group was created. + CreationDate *time.Time + + // A string containing the description of the group. + Description *string + + // The name of the group. + GroupName *string + + // The date the group was last modified. + LastModifiedDate *time.Time + // A nonnegative integer value that specifies the precedence of this group relative // to the other groups that a user can belong to in the user pool. If a user // belongs to two or more groups, it is the group with the highest precedence whose @@ -480,38 +492,39 @@ type GroupType struct { // value is null. Precedence *int32 - // The date the group was last modified. - LastModifiedDate *time.Time - - // The date the group was created. - CreationDate *time.Time - - // A string containing the description of the group. - Description *string - - // The name of the group. - GroupName *string + // The role ARN for the group. + RoleArn *string // The user pool ID for the user pool. UserPoolId *string - - // The role ARN for the group. - RoleArn *string } // The HTTP header. type HttpHeader struct { - // The header value. - HeaderValue *string - // The header name HeaderName *string + + // The header value. + HeaderValue *string } // A container for information about an identity provider. type IdentityProviderType struct { + // A mapping of identity provider attributes to standard and custom user pool + // attributes. + AttributeMapping map[string]*string + + // The date the identity provider was created. + CreationDate *time.Time + + // A list of identity provider identifiers. + IdpIdentifiers []*string + + // The date the identity provider was last modified. + LastModifiedDate *time.Time + // The identity provider details. The following list describes the provider detail // keys for each identity provider type. // @@ -575,61 +588,48 @@ type IdentityProviderType struct { // * IDPSignOut optional ProviderDetails map[string]*string - // A list of identity provider identifiers. - IdpIdentifiers []*string - - // A mapping of identity provider attributes to standard and custom user pool - // attributes. - AttributeMapping map[string]*string - - // The user pool ID. - UserPoolId *string - - // The date the identity provider was last modified. - LastModifiedDate *time.Time - - // The date the identity provider was created. - CreationDate *time.Time - // The identity provider name. ProviderName *string // The identity provider type. ProviderType IdentityProviderTypeType + + // The user pool ID. + UserPoolId *string } // Specifies the configuration for AWS Lambda triggers. type LambdaConfigType struct { - // A pre-registration AWS Lambda trigger. - PreSignUp *string + // Creates an authentication challenge. + CreateAuthChallenge *string + + // A custom Message AWS Lambda trigger. + CustomMessage *string + + // Defines the authentication challenge. + DefineAuthChallenge *string + + // A post-authentication AWS Lambda trigger. + PostAuthentication *string // A post-confirmation AWS Lambda trigger. PostConfirmation *string - // Creates an authentication challenge. - CreateAuthChallenge *string + // A pre-authentication AWS Lambda trigger. + PreAuthentication *string + + // A pre-registration AWS Lambda trigger. + PreSignUp *string // A Lambda trigger that is invoked before token generation. PreTokenGeneration *string - // A pre-authentication AWS Lambda trigger. - PreAuthentication *string - // The user migration Lambda config type. UserMigration *string - // A custom Message AWS Lambda trigger. - CustomMessage *string - - // A post-authentication AWS Lambda trigger. - PostAuthentication *string - // Verifies the authentication challenge response. VerifyAuthChallengeResponse *string - - // Defines the authentication challenge. - DefineAuthChallenge *string } // The message template structure. @@ -638,11 +638,11 @@ type MessageTemplateType struct { // The message template for email messages. EmailMessage *string - // The message template for SMS messages. - SMSMessage *string - // The subject line for email messages. EmailSubject *string + + // The message template for SMS messages. + SMSMessage *string } // This data type is no longer supported. You can use it only for SMS MFA @@ -653,12 +653,12 @@ type MessageTemplateType struct { // GetUserResponse$UserMFASettingList () responses. type MFAOptionType struct { + // The attribute name of the MFA option type. The only valid value is phone_number. + AttributeName *string + // The delivery medium to send the MFA code. You can use this parameter to set only // the SMS delivery medium value. DeliveryMedium DeliveryMediumType - - // The attribute name of the MFA option type. The only valid value is phone_number. - AttributeName *string } // The new device metadata type. @@ -674,11 +674,6 @@ type NewDeviceMetadataType struct { // The notify configuration type. type NotifyConfigurationType struct { - // The email address that is sending the email. It must be either individually - // verified with Amazon SES, or from a domain that has been verified with Amazon - // SES. - From *string - // The Amazon Resource Name (ARN) of the identity that is associated with the // sending authorization policy. It permits Amazon Cognito to send for the email // address specified in the From parameter. @@ -686,17 +681,22 @@ type NotifyConfigurationType struct { // This member is required. SourceArn *string - // The email template used when a detected risk event is allowed. - NoActionEmail *NotifyEmailType + // Email template used when a detected risk event is blocked. + BlockEmail *NotifyEmailType - // The destination to which the receiver of an email should reply to. - ReplyTo *string + // The email address that is sending the email. It must be either individually + // verified with Amazon SES, or from a domain that has been verified with Amazon + // SES. + From *string // The MFA email template used when MFA is challenged as part of a detected risk. MfaEmail *NotifyEmailType - // Email template used when a detected risk event is blocked. - BlockEmail *NotifyEmailType + // The email template used when a detected risk event is allowed. + NoActionEmail *NotifyEmailType + + // The destination to which the receiver of an email should reply to. + ReplyTo *string } // The notify email type. @@ -717,16 +717,28 @@ type NotifyEmailType struct { // The minimum and maximum value of an attribute that is of the number data type. type NumberAttributeConstraintsType struct { - // The minimum value of an attribute that is of the number data type. - MinValue *string - // The maximum value of an attribute that is of the number data type. MaxValue *string + + // The minimum value of an attribute that is of the number data type. + MinValue *string } // The password policy type. type PasswordPolicyType struct { + // The minimum length of the password policy that you have set. Cannot be less than + // 6. + MinimumLength *int32 + + // In the password policy that you have set, refers to whether you have required + // users to use at least one lowercase letter in their password. + RequireLowercase *bool + + // In the password policy that you have set, refers to whether you have required + // users to use at least one number in their password. + RequireNumbers *bool + // In the password policy that you have set, refers to whether you have required // users to use at least one symbol in their password. RequireSymbols *bool @@ -741,47 +753,35 @@ type PasswordPolicyType struct { // TemporaryPasswordValidityDays for a user pool, you will no longer be able to set // the deprecated UnusedAccountValidityDays value for that user pool. TemporaryPasswordValidityDays *int32 - - // The minimum length of the password policy that you have set. Cannot be less than - // 6. - MinimumLength *int32 - - // In the password policy that you have set, refers to whether you have required - // users to use at least one lowercase letter in their password. - RequireLowercase *bool - - // In the password policy that you have set, refers to whether you have required - // users to use at least one number in their password. - RequireNumbers *bool } // A container for identity provider details. type ProviderDescription struct { - // The identity provider name. - ProviderName *string - - // The identity provider type. - ProviderType IdentityProviderTypeType - // The date the provider was added to the user pool. CreationDate *time.Time // The date the provider was last modified. LastModifiedDate *time.Time + + // The identity provider name. + ProviderName *string + + // The identity provider type. + ProviderType IdentityProviderTypeType } // A container for information about an identity provider for a user pool. type ProviderUserIdentifierType struct { - // The name of the provider, for example, Facebook, Google, or Login with Amazon. - ProviderName *string - // The name of the provider attribute to link to, for example, NameID. ProviderAttributeName *string // The value of the provider attribute to link to, for example, xxxxx_account. ProviderAttributeValue *string + + // The name of the provider, for example, Facebook, Google, or Login with Amazon. + ProviderName *string } // A map containing a priority as a key, and recovery method name as a value. @@ -802,48 +802,42 @@ type RecoveryOptionType struct { // A resource server scope. type ResourceServerScopeType struct { - // The name of the scope. + // A description of the scope. // // This member is required. - ScopeName *string + ScopeDescription *string - // A description of the scope. + // The name of the scope. // // This member is required. - ScopeDescription *string + ScopeName *string } // A container for information about a resource server for a user pool. type ResourceServerType struct { - // The user pool ID for the user pool that hosts the resource server. - UserPoolId *string - // The identifier for the resource server. Identifier *string + // The name of the resource server. + Name *string + // A list of scopes that are defined for the resource server. Scopes []*ResourceServerScopeType - // The name of the resource server. - Name *string + // The user pool ID for the user pool that hosts the resource server. + UserPoolId *string } // The risk configuration type. type RiskConfigurationType struct { - // The configuration to override the risk decision. - RiskExceptionConfiguration *RiskExceptionConfigurationType - - // The app client ID. - ClientId *string - // The account takeover risk configuration object including the NotifyConfiguration // object and Actions to take in the case of an account takeover. AccountTakeoverRiskConfiguration *AccountTakeoverRiskConfigurationType - // The user pool ID. - UserPoolId *string + // The app client ID. + ClientId *string // The compromised credentials risk configuration object including the EventFilter // and the EventAction @@ -851,6 +845,12 @@ type RiskConfigurationType struct { // The last modified date. LastModifiedDate *time.Time + + // The configuration to override the risk decision. + RiskExceptionConfiguration *RiskExceptionConfigurationType + + // The user pool ID. + UserPoolId *string } // The type of the configuration to override the risk decision. @@ -869,16 +869,8 @@ type RiskExceptionConfigurationType struct { // Contains information about the schema attribute. type SchemaAttributeType struct { - // Specifies whether a user pool attribute is required. If the attribute is - // required and the user does not provide a value, registration or sign-in will - // fail. - Required *bool - - // Specifies the constraints for an attribute of the string type. - StringAttributeConstraints *StringAttributeConstraintsType - - // A schema attribute of the name type. - Name *string + // The attribute data type. + AttributeDataType AttributeDataType // We recommend that you use WriteAttributes // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserPoolClientType.html#CognitoUserPools-Type-UserPoolClientType-WriteAttributes) @@ -900,11 +892,19 @@ type SchemaAttributeType struct { // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html). Mutable *bool + // A schema attribute of the name type. + Name *string + // Specifies the constraints for an attribute of the number type. NumberAttributeConstraints *NumberAttributeConstraintsType - // The attribute data type. - AttributeDataType AttributeDataType + // Specifies whether a user pool attribute is required. If the attribute is + // required and the user does not provide a value, registration or sign-in will + // fail. + Required *bool + + // Specifies the constraints for an attribute of the string type. + StringAttributeConstraints *StringAttributeConstraintsType } // The SMS configuration type that includes the settings the Cognito User Pool @@ -913,6 +913,13 @@ type SchemaAttributeType struct { // using an AWS IAM role that you provide for your AWS account. type SmsConfigurationType struct { + // The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) + // caller. This is the ARN of the IAM role in your AWS account which Cognito will + // use to send SMS messages. + // + // This member is required. + SnsCallerArn *string + // The external ID is a value that we recommend you use to add security to your IAM // role which is used to call Amazon SNS to send SMS messages for your user pool. // If you provide an ExternalId, the Cognito User Pool will include it when @@ -921,26 +928,19 @@ type SmsConfigurationType struct { // role for SMS MFA, Cognito will create a role with the required permissions and a // trust policy that demonstrates use of the ExternalId. ExternalId *string - - // The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) - // caller. This is the ARN of the IAM role in your AWS account which Cognito will - // use to send SMS messages. - // - // This member is required. - SnsCallerArn *string } // The SMS text message multi-factor authentication (MFA) configuration type. type SmsMfaConfigType struct { - // The SMS configuration. - SmsConfiguration *SmsConfigurationType - // The SMS authentication message that will be sent to users with the code they // need to sign in. The message must contain the ‘{####}’ placeholder, which will // be replaced with the code. If the message is not included, and default message // will be used. SmsAuthenticationMessage *string + + // The SMS configuration. + SmsConfiguration *SmsConfigurationType } // The type used for enabling SMS MFA at the user level. @@ -963,42 +963,42 @@ type SoftwareTokenMfaConfigType struct { // The type used for enabling software token MFA at the user level. type SoftwareTokenMfaSettingsType struct { - // Specifies whether software token MFA is the preferred MFA method. - PreferredMfa *bool - // Specifies whether software token MFA is enabled. Enabled *bool + + // Specifies whether software token MFA is the preferred MFA method. + PreferredMfa *bool } // The constraints associated with a string attribute. type StringAttributeConstraintsType struct { - // The minimum length. - MinLength *string - // The maximum length. MaxLength *string + + // The minimum length. + MinLength *string } // A container for the UI customization information for a user pool's built-in app // UI. type UICustomizationType struct { - // The client ID for the client app. - ClientId *string - - // The logo image for the UI customization. - ImageUrl *string - // The CSS values in the UI customization. CSS *string // The CSS version number. CSSVersion *string + // The client ID for the client app. + ClientId *string + // The creation date for the UI customization. CreationDate *time.Time + // The logo image for the UI customization. + ImageUrl *string + // The last-modified date for the UI customization. LastModifiedDate *time.Time @@ -1020,35 +1020,40 @@ type UserContextDataType struct { // The user import job type. type UserImportJobType struct { - // The job ID for the user import job. - JobId *string + // The role ARN for the Amazon CloudWatch Logging role for the user import job. For + // more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon + // Cognito Developer Guide. + CloudWatchLogsRoleArn *string // The date when the user import job was completed. CompletionDate *time.Time - // The user pool ID for the user pool that the users are being imported into. - UserPoolId *string - // The message returned when the user import job is completed. CompletionMessage *string - // The date when the user import job was started. - StartDate *time.Time + // The date the user import job was created. + CreationDate *time.Time - // The pre-signed URL to be used to upload the .csv file. - PreSignedUrl *string + // The number of users that could not be imported. + FailedUsers *int64 // The number of users that were successfully imported. ImportedUsers *int64 + // The job ID for the user import job. + JobId *string + // The job name for the user import job. JobName *string - // The date the user import job was created. - CreationDate *time.Time + // The pre-signed URL to be used to upload the .csv file. + PreSignedUrl *string - // The number of users that could not be imported. - FailedUsers *int64 + // The number of users that were skipped. + SkippedUsers *int64 + + // The date when the user import job was started. + StartDate *time.Time // The status of the user import job. One of the following: // @@ -1078,13 +1083,8 @@ type UserImportJobType struct { // the job cannot be started. Status UserImportJobStatusType - // The role ARN for the Amazon CloudWatch Logging role for the user import job. For - // more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon - // Cognito Developer Guide. - CloudWatchLogsRoleArn *string - - // The number of users that were skipped. - SkippedUsers *int64 + // The user pool ID for the user pool that the users are being imported into. + UserPoolId *string } // The username configuration type. @@ -1134,6 +1134,75 @@ type UserPoolClientDescription struct { // Contains information about a user pool client. type UserPoolClientType struct { + // The allowed OAuth flows. Set to code to initiate a code grant flow, which + // provides an authorization code as the response. This code can be exchanged for + // access tokens with the token endpoint. Set to implicit to specify that the + // client should get the access token (and, optionally, ID token, based on scopes) + // directly. Set to client_credentials to specify that the client should get the + // access token (and, optionally, ID token, based on scopes) from the token + // endpoint using a combination of client and client_secret. + AllowedOAuthFlows []OAuthFlowType + + // Set to true if the client is allowed to follow the OAuth protocol when + // interacting with Cognito user pools. + AllowedOAuthFlowsUserPoolClient *bool + + // The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, + // openid, and profile. Possible values provided by AWS are: + // aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are + // also supported. + AllowedOAuthScopes []*string + + // The Amazon Pinpoint analytics configuration for the user pool client. Cognito + // User Pools only supports sending events to Amazon Pinpoint projects in the US + // East (N. Virginia) us-east-1 Region, regardless of the region in which the user + // pool resides. + AnalyticsConfiguration *AnalyticsConfigurationType + + // A list of allowed redirect (callback) URLs for the identity providers. A + // redirect URI must: + // + // * Be an absolute URI. + // + // * Be registered with the + // authorization server. + // + // * Not include a fragment component. + // + // See OAuth 2.0 - + // Redirection Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2). Amazon + // Cognito requires HTTPS over HTTP except for http://localhost for testing + // purposes only. App callback URLs such as myapp://example are also supported. + CallbackURLs []*string + + // The ID of the client associated with the user pool. + ClientId *string + + // The client name from the user pool request of the client type. + ClientName *string + + // The client secret from the user pool request of the client type. + ClientSecret *string + + // The date the user pool client was created. + CreationDate *time.Time + + // The default redirect URI. Must be in the CallbackURLs list. A redirect URI + // must: + // + // * Be an absolute URI. + // + // * Be registered with the authorization + // server. + // + // * Not include a fragment component. + // + // See OAuth 2.0 - Redirection + // Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2). Amazon Cognito + // requires HTTPS over HTTP except for http://localhost for testing purposes only. + // App callback URLs such as myapp://example are also supported. + DefaultRedirectURI *string + // The authentication flows that are supported by the user pool clients. Flow names // without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ // prefix. Note that values with ALLOW_ prefix cannot be used along with values @@ -1160,41 +1229,11 @@ type UserPoolClientType struct { // ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens. ExplicitAuthFlows []ExplicitAuthFlowsType - // The default redirect URI. Must be in the CallbackURLs list. A redirect URI - // must: - // - // * Be an absolute URI. - // - // * Be registered with the authorization - // server. - // - // * Not include a fragment component. - // - // See OAuth 2.0 - Redirection - // Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2). Amazon Cognito - // requires HTTPS over HTTP except for http://localhost for testing purposes only. - // App callback URLs such as myapp://example are also supported. - DefaultRedirectURI *string - - // The writeable attributes. - WriteAttributes []*string - - // The time limit, in days, after which the refresh token is no longer valid and - // cannot be used. - RefreshTokenValidity *int32 - - // Set to true if the client is allowed to follow the OAuth protocol when - // interacting with Cognito user pools. - AllowedOAuthFlowsUserPoolClient *bool - - // The Read-only attributes. - ReadAttributes []*string + // The date the user pool client was last modified. + LastModifiedDate *time.Time - // The Amazon Pinpoint analytics configuration for the user pool client. Cognito - // User Pools only supports sending events to Amazon Pinpoint projects in the US - // East (N. Virginia) us-east-1 Region, regardless of the region in which the user - // pool resides. - AnalyticsConfiguration *AnalyticsConfigurationType + // A list of allowed logout URLs for the identity providers. + LogoutURLs []*string // Use this setting to choose which errors and responses are returned by Cognito // APIs during authentication, account confirmation, and password recovery when the @@ -1238,72 +1277,27 @@ type UserPoolClientType struct { // created user pool clients if no value is provided. PreventUserExistenceErrors PreventUserExistenceErrorTypes - // The client secret from the user pool request of the client type. - ClientSecret *string - - // The ID of the client associated with the user pool. - ClientId *string + // The Read-only attributes. + ReadAttributes []*string - // A list of allowed logout URLs for the identity providers. - LogoutURLs []*string + // The time limit, in days, after which the refresh token is no longer valid and + // cannot be used. + RefreshTokenValidity *int32 // A list of provider names for the identity providers that are supported on this // client. SupportedIdentityProviders []*string - // The client name from the user pool request of the client type. - ClientName *string - - // The allowed OAuth flows. Set to code to initiate a code grant flow, which - // provides an authorization code as the response. This code can be exchanged for - // access tokens with the token endpoint. Set to implicit to specify that the - // client should get the access token (and, optionally, ID token, based on scopes) - // directly. Set to client_credentials to specify that the client should get the - // access token (and, optionally, ID token, based on scopes) from the token - // endpoint using a combination of client and client_secret. - AllowedOAuthFlows []OAuthFlowType - // The user pool ID for the user pool client. UserPoolId *string - // The date the user pool client was created. - CreationDate *time.Time - - // The date the user pool client was last modified. - LastModifiedDate *time.Time - - // A list of allowed redirect (callback) URLs for the identity providers. A - // redirect URI must: - // - // * Be an absolute URI. - // - // * Be registered with the - // authorization server. - // - // * Not include a fragment component. - // - // See OAuth 2.0 - - // Redirection Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2). Amazon - // Cognito requires HTTPS over HTTP except for http://localhost for testing - // purposes only. App callback URLs such as myapp://example are also supported. - CallbackURLs []*string - - // The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, - // openid, and profile. Possible values provided by AWS are: - // aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are - // also supported. - AllowedOAuthScopes []*string + // The writeable attributes. + WriteAttributes []*string } // A user pool description. type UserPoolDescriptionType struct { - // The name in a user pool description. - Name *string - - // The date the user pool description was last modified. - LastModifiedDate *time.Time - // The date the user pool description was created. CreationDate *time.Time @@ -1313,6 +1307,12 @@ type UserPoolDescriptionType struct { // The AWS Lambda configuration information in a user pool description. LambdaConfig *LambdaConfigType + // The date the user pool description was last modified. + LastModifiedDate *time.Time + + // The name in a user pool description. + Name *string + // The user pool status in a user pool description. Status StatusType } @@ -1327,36 +1327,6 @@ type UserPoolPolicyType struct { // A container for information about the user pool. type UserPoolType struct { - // The contents of the SMS verification message. - SmsVerificationMessage *string - - // The SMS configuration. - SmsConfiguration *SmsConfigurationType - - // A number estimating the size of the user pool. - EstimatedNumberOfUsers *int32 - - // The AWS Lambda triggers associated with the user pool. - LambdaConfig *LambdaConfigType - - // Holds the domain prefix if the user pool has a domain associated with it. - Domain *string - - // Specifies the attributes that are aliased in a user pool. - AliasAttributes []AliasAttributeType - - // The name of the user pool. - Name *string - - // The date the user pool was last modified. - LastModifiedDate *time.Time - - // The date the user pool was created. - CreationDate *time.Time - - // The template for verification messages. - VerificationMessageTemplate *VerificationMessageTemplateType - // Use this setting to define which verified available method a user can use to // recover their password when they call ForgotPassword. It allows you to define a // preferred method when a user has more than one method available. With this @@ -1366,26 +1336,20 @@ type UserPoolType struct { // email. AccountRecoverySetting *AccountRecoverySettingType - // The subject of the email verification message. - EmailVerificationSubject *string - // The configuration for AdminCreateUser requests. AdminCreateUserConfig *AdminCreateUserConfigType - // The reason why the SMS configuration cannot send the messages to your users. - SmsConfigurationFailure *string + // Specifies the attributes that are aliased in a user pool. + AliasAttributes []AliasAttributeType - // The policies associated with the user pool. - Policies *UserPoolPolicyType + // The Amazon Resource Name (ARN) for the user pool. + Arn *string - // The email configuration. - EmailConfiguration *EmailConfigurationType + // Specifies the attributes that are auto-verified in a user pool. + AutoVerifiedAttributes []VerifiedAttributeType - // You can choose to enable case sensitivity on the username input for the selected - // sign-in option. For example, when this is set to False, users will be able to - // sign in using either "username" or "Username". This configuration is immutable - // once it has been set. For more information, see . - UsernameConfiguration *UsernameConfigurationType + // The date the user pool was created. + CreationDate *time.Time // A custom domain name that you provide to Amazon Cognito. This parameter applies // only if you use a custom domain to host the sign-up and sign-in pages for your @@ -1394,8 +1358,35 @@ type UserPoolType struct { // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html). CustomDomain *string - // A container with the schema attributes of a user pool. - SchemaAttributes []*SchemaAttributeType + // The device configuration. + DeviceConfiguration *DeviceConfigurationType + + // Holds the domain prefix if the user pool has a domain associated with it. + Domain *string + + // The email configuration. + EmailConfiguration *EmailConfigurationType + + // The reason why the email configuration cannot send the messages to your users. + EmailConfigurationFailure *string + + // The contents of the email verification message. + EmailVerificationMessage *string + + // The subject of the email verification message. + EmailVerificationSubject *string + + // A number estimating the size of the user pool. + EstimatedNumberOfUsers *int32 + + // The ID of the user pool. + Id *string + + // The AWS Lambda triggers associated with the user pool. + LambdaConfig *LambdaConfigType + + // The date the user pool was last modified. + LastModifiedDate *time.Time // Can be one of the following values: // @@ -1410,46 +1401,70 @@ type UserPoolType struct { // registering to create an MFA token. MfaConfiguration UserPoolMfaType - // The tags that are assigned to the user pool. A tag is a label that you can apply - // to user pools to categorize and manage them in different ways, such as by - // purpose, owner, environment, or other criteria. - UserPoolTags map[string]*string + // The name of the user pool. + Name *string + + // The policies associated with the user pool. + Policies *UserPoolPolicyType + + // A container with the schema attributes of a user pool. + SchemaAttributes []*SchemaAttributeType // The contents of the SMS authentication message. SmsAuthenticationMessage *string - // The Amazon Resource Name (ARN) for the user pool. - Arn *string + // The SMS configuration. + SmsConfiguration *SmsConfigurationType - // The ID of the user pool. - Id *string + // The reason why the SMS configuration cannot send the messages to your users. + SmsConfigurationFailure *string - // The device configuration. - DeviceConfiguration *DeviceConfigurationType + // The contents of the SMS verification message. + SmsVerificationMessage *string - // The contents of the email verification message. - EmailVerificationMessage *string + // The status of a user pool. + Status StatusType + + // The user pool add-ons. + UserPoolAddOns *UserPoolAddOnsType + + // The tags that are assigned to the user pool. A tag is a label that you can apply + // to user pools to categorize and manage them in different ways, such as by + // purpose, owner, environment, or other criteria. + UserPoolTags map[string]*string // Specifies whether email addresses or phone numbers can be specified as usernames // when a user signs up. UsernameAttributes []UsernameAttributeType - // The reason why the email configuration cannot send the messages to your users. - EmailConfigurationFailure *string - - // Specifies the attributes that are auto-verified in a user pool. - AutoVerifiedAttributes []VerifiedAttributeType - - // The user pool add-ons. - UserPoolAddOns *UserPoolAddOnsType + // You can choose to enable case sensitivity on the username input for the selected + // sign-in option. For example, when this is set to False, users will be able to + // sign in using either "username" or "Username". This configuration is immutable + // once it has been set. For more information, see . + UsernameConfiguration *UsernameConfigurationType - // The status of a user pool. - Status StatusType + // The template for verification messages. + VerificationMessageTemplate *VerificationMessageTemplateType } // The user type. type UserType struct { + // A container with information about the user type attributes. + Attributes []*AttributeType + + // Specifies whether the user is enabled. + Enabled *bool + + // The MFA options for the user. + MFAOptions []*MFAOptionType + + // The creation date of the user. + UserCreateDate *time.Time + + // The last modified date of the user. + UserLastModifiedDate *time.Time + // The user status. Can be one of the following: // // * UNCONFIRMED - User has been @@ -1477,42 +1492,27 @@ type UserType struct { // The user name of the user you wish to describe. Username *string - - // The creation date of the user. - UserCreateDate *time.Time - - // Specifies whether the user is enabled. - Enabled *bool - - // A container with information about the user type attributes. - Attributes []*AttributeType - - // The last modified date of the user. - UserLastModifiedDate *time.Time - - // The MFA options for the user. - MFAOptions []*MFAOptionType } // The template for verification messages. type VerificationMessageTemplateType struct { + // The default email option. + DefaultEmailOption DefaultEmailOptionType + // The email message template. EmailMessage *string + // The email message template for sending a confirmation link to the user. + EmailMessageByLink *string + + // The subject line for the email message template. + EmailSubject *string + // The subject line for the email message template for sending a confirmation link // to the user. EmailSubjectByLink *string // The SMS message template. SmsMessage *string - - // The email message template for sending a confirmation link to the user. - EmailMessageByLink *string - - // The default email option. - DefaultEmailOption DefaultEmailOptionType - - // The subject line for the email message template. - EmailSubject *string } diff --git a/service/cognitosync/api_op_DeleteDataset.go b/service/cognitosync/api_op_DeleteDataset.go index cc3b8e8c219..f7f86e8e204 100644 --- a/service/cognitosync/api_op_DeleteDataset.go +++ b/service/cognitosync/api_op_DeleteDataset.go @@ -72,13 +72,13 @@ type DeleteDatasetInput struct { // created by Amazon Cognito. GUID generation is unique within a region. // // This member is required. - IdentityPoolId *string + IdentityId *string // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. GUID generation is unique within a region. // // This member is required. - IdentityId *string + IdentityPoolId *string } // Response to a successful DeleteDataset request. diff --git a/service/cognitosync/api_op_DescribeDataset.go b/service/cognitosync/api_op_DescribeDataset.go index f5078306610..ab29c8e0a3f 100644 --- a/service/cognitosync/api_op_DescribeDataset.go +++ b/service/cognitosync/api_op_DescribeDataset.go @@ -64,18 +64,18 @@ func (c *Client) DescribeDataset(ctx context.Context, params *DescribeDatasetInp // by owner and dataset name. type DescribeDatasetInput struct { - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. GUID generation is unique within a region. - // - // This member is required. - IdentityId *string - // A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' // (underscore), '-' (dash), and '.' (dot). // // This member is required. DatasetName *string + // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) + // created by Amazon Cognito. GUID generation is unique within a region. + // + // This member is required. + IdentityId *string + // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. GUID generation is unique within a region. // diff --git a/service/cognitosync/api_op_DescribeIdentityUsage.go b/service/cognitosync/api_op_DescribeIdentityUsage.go index 611f24b43ce..6abc2c0be01 100644 --- a/service/cognitosync/api_op_DescribeIdentityUsage.go +++ b/service/cognitosync/api_op_DescribeIdentityUsage.go @@ -64,13 +64,13 @@ type DescribeIdentityUsageInput struct { // created by Amazon Cognito. GUID generation is unique within a region. // // This member is required. - IdentityPoolId *string + IdentityId *string // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. GUID generation is unique within a region. // // This member is required. - IdentityId *string + IdentityPoolId *string } // The response to a successful DescribeIdentityUsage request. diff --git a/service/cognitosync/api_op_GetBulkPublishDetails.go b/service/cognitosync/api_op_GetBulkPublishDetails.go index b33cfe0b591..7f98d4bef62 100644 --- a/service/cognitosync/api_op_GetBulkPublishDetails.go +++ b/service/cognitosync/api_op_GetBulkPublishDetails.go @@ -71,6 +71,13 @@ type GetBulkPublishDetailsInput struct { // The output for the GetBulkPublishDetails operation. type GetBulkPublishDetailsOutput struct { + // If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation + // completed. + BulkPublishCompleteTime *time.Time + + // The date/time at which the last bulk publish was initiated. + BulkPublishStartTime *time.Time + // Status of the last bulk publish operation, valid values are: // // * NOT_STARTED @@ -87,20 +94,13 @@ type GetBulkPublishDetailsOutput struct { // cause. BulkPublishStatus types.BulkPublishStatus - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. GUID generation is unique within a region. - IdentityPoolId *string - // If BulkPublishStatus is FAILED this field will contain the error message that // caused the bulk publish to fail. FailureMessage *string - // If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation - // completed. - BulkPublishCompleteTime *time.Time - - // The date/time at which the last bulk publish was initiated. - BulkPublishStartTime *time.Time + // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) + // created by Amazon Cognito. GUID generation is unique within a region. + IdentityPoolId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/cognitosync/api_op_GetIdentityPoolConfiguration.go b/service/cognitosync/api_op_GetIdentityPoolConfiguration.go index 0d248f280bd..76e8297a450 100644 --- a/service/cognitosync/api_op_GetIdentityPoolConfiguration.go +++ b/service/cognitosync/api_op_GetIdentityPoolConfiguration.go @@ -71,13 +71,13 @@ type GetIdentityPoolConfigurationInput struct { // The output for the GetIdentityPoolConfiguration operation. type GetIdentityPoolConfigurationOutput struct { + // Options to apply to this identity pool for Amazon Cognito streams. + CognitoStreams *types.CognitoStreams + // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. IdentityPoolId *string - // Options to apply to this identity pool for Amazon Cognito streams. - CognitoStreams *types.CognitoStreams - // Options to apply to this identity pool for push synchronization. PushSync *types.PushSync diff --git a/service/cognitosync/api_op_ListDatasets.go b/service/cognitosync/api_op_ListDatasets.go index 85872d1a8ae..3d367d707d1 100644 --- a/service/cognitosync/api_op_ListDatasets.go +++ b/service/cognitosync/api_op_ListDatasets.go @@ -63,8 +63,11 @@ func (c *Client) ListDatasets(ctx context.Context, params *ListDatasetsInput, op // Request for a list of datasets for an identity. type ListDatasetsInput struct { - // A pagination token for obtaining the next page of results. - NextToken *string + // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) + // created by Amazon Cognito. GUID generation is unique within a region. + // + // This member is required. + IdentityId *string // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. GUID generation is unique within a region. @@ -75,11 +78,8 @@ type ListDatasetsInput struct { // The maximum number of results to be returned. MaxResults *string - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. GUID generation is unique within a region. - // - // This member is required. - IdentityId *string + // A pagination token for obtaining the next page of results. + NextToken *string } // Returned for a successful ListDatasets request. diff --git a/service/cognitosync/api_op_ListIdentityPoolUsage.go b/service/cognitosync/api_op_ListIdentityPoolUsage.go index 97adbae5b0a..9b29201b1ae 100644 --- a/service/cognitosync/api_op_ListIdentityPoolUsage.go +++ b/service/cognitosync/api_op_ListIdentityPoolUsage.go @@ -59,28 +59,28 @@ func (c *Client) ListIdentityPoolUsage(ctx context.Context, params *ListIdentity // A request for usage information on an identity pool. type ListIdentityPoolUsageInput struct { - // A pagination token for obtaining the next page of results. - NextToken *string - // The maximum number of results to be returned. MaxResults *int32 + + // A pagination token for obtaining the next page of results. + NextToken *string } // Returned for a successful ListIdentityPoolUsage request. type ListIdentityPoolUsageOutput struct { - // Usage information for the identity pools. - IdentityPoolUsages []*types.IdentityPoolUsage - // Total number of identities for the identity pool. Count *int32 - // A pagination token for obtaining the next page of results. - NextToken *string + // Usage information for the identity pools. + IdentityPoolUsages []*types.IdentityPoolUsage // The maximum number of results to be returned. MaxResults *int32 + // A pagination token for obtaining the next page of results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cognitosync/api_op_ListRecords.go b/service/cognitosync/api_op_ListRecords.go index d36b4ad3e64..aa7fdf02b11 100644 --- a/service/cognitosync/api_op_ListRecords.go +++ b/service/cognitosync/api_op_ListRecords.go @@ -63,17 +63,26 @@ func (c *Client) ListRecords(ctx context.Context, params *ListRecordsInput, optF // A request for a list of records. type ListRecordsInput struct { + // A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' + // (underscore), '-' (dash), and '.' (dot). + // + // This member is required. + DatasetName *string + // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. GUID generation is unique within a region. // // This member is required. - IdentityPoolId *string + IdentityId *string // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. GUID generation is unique within a region. // // This member is required. - IdentityId *string + IdentityPoolId *string + + // The last server sync count for this record. + LastSyncCount *int64 // The maximum number of results to be returned. MaxResults *int32 @@ -81,15 +90,6 @@ type ListRecordsInput struct { // A pagination token for obtaining the next page of results. NextToken *string - // The last server sync count for this record. - LastSyncCount *int64 - - // A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' - // (underscore), '-' (dash), and '.' (dot). - // - // This member is required. - DatasetName *string - // A token containing a session ID, identity ID, and expiration. SyncSessionToken *string } @@ -100,29 +100,29 @@ type ListRecordsOutput struct { // Total number of records. Count *int32 - // Server sync count for this dataset. - DatasetSyncCount *int64 + // A boolean value specifying whether to delete the dataset locally. + DatasetDeletedAfterRequestedSyncCount *bool - // Names of merged datasets. - MergedDatasetNames []*string + // Indicates whether the dataset exists. + DatasetExists *bool - // A token containing a session ID, identity ID, and expiration. - SyncSessionToken *string + // Server sync count for this dataset. + DatasetSyncCount *int64 // The user/device that made the last change to this record. LastModifiedBy *string - // A boolean value specifying whether to delete the dataset locally. - DatasetDeletedAfterRequestedSyncCount *bool - - // A list of all records. - Records []*types.Record + // Names of merged datasets. + MergedDatasetNames []*string // A pagination token for obtaining the next page of results. NextToken *string - // Indicates whether the dataset exists. - DatasetExists *bool + // A list of all records. + Records []*types.Record + + // A token containing a session ID, identity ID, and expiration. + SyncSessionToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/cognitosync/api_op_RegisterDevice.go b/service/cognitosync/api_op_RegisterDevice.go index 53e76788601..08ba345bc4c 100644 --- a/service/cognitosync/api_op_RegisterDevice.go +++ b/service/cognitosync/api_op_RegisterDevice.go @@ -60,6 +60,11 @@ func (c *Client) RegisterDevice(ctx context.Context, params *RegisterDeviceInput // A request to RegisterDevice. type RegisterDeviceInput struct { + // The unique ID for this identity. + // + // This member is required. + IdentityId *string + // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. Here, the ID of the pool that the identity belongs // to. @@ -72,11 +77,6 @@ type RegisterDeviceInput struct { // This member is required. Platform types.Platform - // The unique ID for this identity. - // - // This member is required. - IdentityId *string - // The push token. // // This member is required. diff --git a/service/cognitosync/api_op_SetIdentityPoolConfiguration.go b/service/cognitosync/api_op_SetIdentityPoolConfiguration.go index d1c5295448d..77c04d2d6ed 100644 --- a/service/cognitosync/api_op_SetIdentityPoolConfiguration.go +++ b/service/cognitosync/api_op_SetIdentityPoolConfiguration.go @@ -60,17 +60,17 @@ func (c *Client) SetIdentityPoolConfiguration(ctx context.Context, params *SetId // The input for the SetIdentityPoolConfiguration operation. type SetIdentityPoolConfigurationInput struct { - // Options to apply to this identity pool for push synchronization. - PushSync *types.PushSync - - // Options to apply to this identity pool for Amazon Cognito streams. - CognitoStreams *types.CognitoStreams - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. This is the ID of the pool to modify. // // This member is required. IdentityPoolId *string + + // Options to apply to this identity pool for Amazon Cognito streams. + CognitoStreams *types.CognitoStreams + + // Options to apply to this identity pool for push synchronization. + PushSync *types.PushSync } // The output for the SetIdentityPoolConfiguration operation @@ -79,13 +79,13 @@ type SetIdentityPoolConfigurationOutput struct { // Options to apply to this identity pool for Amazon Cognito streams. CognitoStreams *types.CognitoStreams - // Options to apply to this identity pool for push synchronization. - PushSync *types.PushSync - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. IdentityPoolId *string + // Options to apply to this identity pool for push synchronization. + PushSync *types.PushSync + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/cognitosync/api_op_SubscribeToDataset.go b/service/cognitosync/api_op_SubscribeToDataset.go index 594b59aa598..621bcd6bdeb 100644 --- a/service/cognitosync/api_op_SubscribeToDataset.go +++ b/service/cognitosync/api_op_SubscribeToDataset.go @@ -64,15 +64,15 @@ type SubscribeToDatasetInput struct { // This member is required. DatasetName *string - // Unique ID for this identity. + // The unique ID generated for this device by Cognito. // // This member is required. - IdentityId *string + DeviceId *string - // The unique ID generated for this device by Cognito. + // Unique ID for this identity. // // This member is required. - DeviceId *string + IdentityId *string // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. The ID of the pool to which the identity belongs. diff --git a/service/cognitosync/api_op_UnsubscribeFromDataset.go b/service/cognitosync/api_op_UnsubscribeFromDataset.go index 4c969deba3a..da5fbebb5e0 100644 --- a/service/cognitosync/api_op_UnsubscribeFromDataset.go +++ b/service/cognitosync/api_op_UnsubscribeFromDataset.go @@ -59,26 +59,26 @@ func (c *Client) UnsubscribeFromDataset(ctx context.Context, params *Unsubscribe // A request to UnsubscribeFromDataset. type UnsubscribeFromDatasetInput struct { - // Unique ID for this identity. + // The name of the dataset from which to unsubcribe. // // This member is required. - IdentityId *string + DatasetName *string - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. The ID of the pool to which this identity belongs. + // The unique ID generated for this device by Cognito. // // This member is required. - IdentityPoolId *string + DeviceId *string - // The unique ID generated for this device by Cognito. + // Unique ID for this identity. // // This member is required. - DeviceId *string + IdentityId *string - // The name of the dataset from which to unsubcribe. + // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) + // created by Amazon Cognito. The ID of the pool to which this identity belongs. // // This member is required. - DatasetName *string + IdentityPoolId *string } // Response to an UnsubscribeFromDataset request. diff --git a/service/cognitosync/api_op_UpdateRecords.go b/service/cognitosync/api_op_UpdateRecords.go index 328f7001b54..ce1e3d08e57 100644 --- a/service/cognitosync/api_op_UpdateRecords.go +++ b/service/cognitosync/api_op_UpdateRecords.go @@ -70,8 +70,17 @@ func (c *Client) UpdateRecords(ctx context.Context, params *UpdateRecordsInput, // user. type UpdateRecordsInput struct { - // A list of patch operations. - RecordPatches []*types.RecordPatch + // A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' + // (underscore), '-' (dash), and '.' (dot). + // + // This member is required. + DatasetName *string + + // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) + // created by Amazon Cognito. GUID generation is unique within a region. + // + // This member is required. + IdentityId *string // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. GUID generation is unique within a region. @@ -79,11 +88,11 @@ type UpdateRecordsInput struct { // This member is required. IdentityPoolId *string - // A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' - // (underscore), '-' (dash), and '.' (dot). + // The SyncSessionToken returned by a previous call to ListRecords for this dataset + // and identity. // // This member is required. - DatasetName *string + SyncSessionToken *string // Intended to supply a device ID that will populate the lastModifiedBy field // referenced in other methods. The ClientContext field is not yet implemented. @@ -92,17 +101,8 @@ type UpdateRecordsInput struct { // The unique ID generated for this device by Cognito. DeviceId *string - // The SyncSessionToken returned by a previous call to ListRecords for this dataset - // and identity. - // - // This member is required. - SyncSessionToken *string - - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. GUID generation is unique within a region. - // - // This member is required. - IdentityId *string + // A list of patch operations. + RecordPatches []*types.RecordPatch } // Returned for a successful UpdateRecordsRequest. diff --git a/service/cognitosync/go.mod b/service/cognitosync/go.mod index 82909487b62..38ee1ca57e6 100644 --- a/service/cognitosync/go.mod +++ b/service/cognitosync/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/cognitosync go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/cognitosync/types/types.go b/service/cognitosync/types/types.go index 0a5d38245dc..cd6874c9494 100644 --- a/service/cognitosync/types/types.go +++ b/service/cognitosync/types/types.go @@ -13,6 +13,11 @@ type CognitoStreams struct { // disabled. DisabledReason *string + // The ARN of the role Amazon Cognito can assume in order to publish to the stream. + // This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord + // on your Cognito stream. + RoleArn *string + // The name of the Cognito stream to receive updates. This stream must be in the // developers account and in the same region as the identity pool. StreamName *string @@ -26,11 +31,6 @@ type CognitoStreams struct { // identity pool is disabled. Bulk publish will also fail if StreamingStatus is // DISABLED. StreamingStatus StreamingStatus - - // The ARN of the role Amazon Cognito can assume in order to publish to the stream. - // This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord - // on your Cognito stream. - RoleArn *string } // A collection of data for an identity pool. An identity pool can have multiple @@ -40,8 +40,15 @@ type CognitoStreams struct { // dataset can hold up to 1MB of key-value pairs. type Dataset struct { - // Number of records in this dataset. - NumRecords *int64 + // Date on which the dataset was created. + CreationDate *time.Time + + // Total size in bytes of the records in this dataset. + DataStorage *int64 + + // A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' + // (underscore), '-' (dash), and '.' (dot). + DatasetName *string // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. GUID generation is unique within a region. @@ -53,23 +60,13 @@ type Dataset struct { // Date when the dataset was last modified. LastModifiedDate *time.Time - // Date on which the dataset was created. - CreationDate *time.Time - - // Total size in bytes of the records in this dataset. - DataStorage *int64 - - // A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' - // (underscore), '-' (dash), and '.' (dot). - DatasetName *string + // Number of records in this dataset. + NumRecords *int64 } // Usage information for the identity pool. type IdentityPoolUsage struct { - // Date on which the identity pool was last modified. - LastModifiedDate *time.Time - // Data storage information for the identity pool. DataStorage *int64 @@ -77,6 +74,9 @@ type IdentityPoolUsage struct { // created by Amazon Cognito. GUID generation is unique within a region. IdentityPoolId *string + // Date on which the identity pool was last modified. + LastModifiedDate *time.Time + // Number of sync sessions for the identity pool. SyncSessionsCount *int64 } @@ -84,12 +84,12 @@ type IdentityPoolUsage struct { // Usage information for the identity. type IdentityUsage struct { + // Total data storage for this identity. + DataStorage *int64 + // Number of datasets for the identity. DatasetCount *int32 - // Date on which the identity was last modified. - LastModifiedDate *time.Time - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. GUID generation is unique within a region. IdentityId *string @@ -98,8 +98,8 @@ type IdentityUsage struct { // created by Amazon Cognito. GUID generation is unique within a region. IdentityPoolId *string - // Total data storage for this identity. - DataStorage *int64 + // Date on which the identity was last modified. + LastModifiedDate *time.Time } // Configuration options to be applied to the identity pool. @@ -118,20 +118,20 @@ type Record struct { // The last modified date of the client device. DeviceLastModifiedDate *time.Time - // The server sync count for this record. - SyncCount *int64 + // The key for the record. + Key *string + + // The user/device that made the last change to this record. + LastModifiedBy *string // The date on which the record was last modified. LastModifiedDate *time.Time + // The server sync count for this record. + SyncCount *int64 + // The value for the record. Value *string - - // The key for the record. - Key *string - - // The user/device that made the last change to this record. - LastModifiedBy *string } // An update operation for a record. @@ -142,9 +142,6 @@ type RecordPatch struct { // This member is required. Key *string - // The last modified date of the client device. - DeviceLastModifiedDate *time.Time - // An operation, either replace or remove. // // This member is required. @@ -155,6 +152,9 @@ type RecordPatch struct { // This member is required. SyncCount *int64 + // The last modified date of the client device. + DeviceLastModifiedDate *time.Time + // The value associated with the record patch. Value *string } diff --git a/service/comprehend/api_op_BatchDetectKeyPhrases.go b/service/comprehend/api_op_BatchDetectKeyPhrases.go index 37f718dcc8d..0eb6fb02245 100644 --- a/service/comprehend/api_op_BatchDetectKeyPhrases.go +++ b/service/comprehend/api_op_BatchDetectKeyPhrases.go @@ -74,14 +74,6 @@ type BatchDetectKeyPhrasesInput struct { type BatchDetectKeyPhrasesOutput struct { - // A list of objects containing the results of the operation. The results are - // sorted in ascending order by the Index field and match the order of the - // documents in the input list. If all of the documents contain an error, the - // ResultList is empty. - // - // This member is required. - ResultList []*types.BatchDetectKeyPhrasesItemResult - // A list containing one object for each document that contained an error. The // results are sorted in ascending order by the Index field and match the order of // the documents in the input list. If there are no errors in the batch, the @@ -90,6 +82,14 @@ type BatchDetectKeyPhrasesOutput struct { // This member is required. ErrorList []*types.BatchItemError + // A list of objects containing the results of the operation. The results are + // sorted in ascending order by the Index field and match the order of the + // documents in the input list. If all of the documents contain an error, the + // ResultList is empty. + // + // This member is required. + ResultList []*types.BatchDetectKeyPhrasesItemResult + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/comprehend/api_op_BatchDetectSentiment.go b/service/comprehend/api_op_BatchDetectSentiment.go index b78d7e5c63d..9b0f23a6f0e 100644 --- a/service/comprehend/api_op_BatchDetectSentiment.go +++ b/service/comprehend/api_op_BatchDetectSentiment.go @@ -58,19 +58,19 @@ func (c *Client) BatchDetectSentiment(ctx context.Context, params *BatchDetectSe type BatchDetectSentimentInput struct { - // A list containing the text of the input documents. The list can contain a - // maximum of 25 documents. Each document must contain fewer that 5,000 bytes of - // UTF-8 encoded characters. - // - // This member is required. - TextList []*string - // The language of the input documents. You can specify any of the primary // languages supported by Amazon Comprehend. All documents must be in the same // language. // // This member is required. LanguageCode types.LanguageCode + + // A list containing the text of the input documents. The list can contain a + // maximum of 25 documents. Each document must contain fewer that 5,000 bytes of + // UTF-8 encoded characters. + // + // This member is required. + TextList []*string } type BatchDetectSentimentOutput struct { diff --git a/service/comprehend/api_op_BatchDetectSyntax.go b/service/comprehend/api_op_BatchDetectSyntax.go index faf94061fd3..597830d9ac8 100644 --- a/service/comprehend/api_op_BatchDetectSyntax.go +++ b/service/comprehend/api_op_BatchDetectSyntax.go @@ -59,13 +59,6 @@ func (c *Client) BatchDetectSyntax(ctx context.Context, params *BatchDetectSynta type BatchDetectSyntaxInput struct { - // A list containing the text of the input documents. The list can contain a - // maximum of 25 documents. Each document must contain fewer that 5,000 bytes of - // UTF-8 encoded characters. - // - // This member is required. - TextList []*string - // The language of the input documents. You can specify any of the following // languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish // ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must @@ -73,6 +66,13 @@ type BatchDetectSyntaxInput struct { // // This member is required. LanguageCode types.SyntaxLanguageCode + + // A list containing the text of the input documents. The list can contain a + // maximum of 25 documents. Each document must contain fewer that 5,000 bytes of + // UTF-8 encoded characters. + // + // This member is required. + TextList []*string } type BatchDetectSyntaxOutput struct { diff --git a/service/comprehend/api_op_ClassifyDocument.go b/service/comprehend/api_op_ClassifyDocument.go index 959b43e61d1..896f39cbd4d 100644 --- a/service/comprehend/api_op_ClassifyDocument.go +++ b/service/comprehend/api_op_ClassifyDocument.go @@ -58,15 +58,15 @@ func (c *Client) ClassifyDocument(ctx context.Context, params *ClassifyDocumentI type ClassifyDocumentInput struct { - // The document text to be analyzed. + // The Amazon Resource Number (ARN) of the endpoint. // // This member is required. - Text *string + EndpointArn *string - // The Amazon Resource Number (ARN) of the endpoint. + // The document text to be analyzed. // // This member is required. - EndpointArn *string + Text *string } type ClassifyDocumentOutput struct { diff --git a/service/comprehend/api_op_CreateDocumentClassifier.go b/service/comprehend/api_op_CreateDocumentClassifier.go index c8311df3823..1be34074ddf 100644 --- a/service/comprehend/api_op_CreateDocumentClassifier.go +++ b/service/comprehend/api_op_CreateDocumentClassifier.go @@ -63,32 +63,21 @@ func (c *Client) CreateDocumentClassifier(ctx context.Context, params *CreateDoc type CreateDocumentClassifierInput struct { + // The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role + // that grants Amazon Comprehend read access to your input data. + // + // This member is required. + DataAccessRoleArn *string + // The name of the document classifier. // // This member is required. DocumentClassifierName *string - // Tags to be associated with the document classifier being created. A tag is a - // key-value pair that adds as a metadata to a resource used by Amazon Comprehend. - // For example, a tag with "Sales" as the key might be added to a resource to - // indicate its use by the sales department. - Tags []*types.Tag - - // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to - // encrypt data on the storage volume attached to the ML compute instance(s) that - // process the analysis job. The VolumeKmsKeyId can be either of the following - // formats: - // - // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // Specifies the format and location of the input data for the job. // - // * Amazon - // Resource Name (ARN) of a KMS Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" - VolumeKmsKeyId *string - - // A unique identifier for the request. If you don't set the client request token, - // Amazon Comprehend generates one. - ClientRequestToken *string + // This member is required. + InputDataConfig *types.DocumentClassifierInputDataConfig // The language of the input documents. You can specify any of the following // languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish @@ -98,6 +87,10 @@ type CreateDocumentClassifierInput struct { // This member is required. LanguageCode types.LanguageCode + // A unique identifier for the request. If you don't set the client request token, + // Amazon Comprehend generates one. + ClientRequestToken *string + // Indicates the mode in which the classifier will be trained. The classifier can // be trained in multi-class mode, which identifies one and only one class for each // document, or multi-label mode, which identifies one or more labels for each @@ -105,26 +98,33 @@ type CreateDocumentClassifierInput struct { // separated by a delimiter. The default delimiter between labels is a pipe (|). Mode types.DocumentClassifierMode - // Specifies the format and location of the input data for the job. + // Enables the addition of output results configuration parameters for custom + // classifier jobs. + OutputDataConfig *types.DocumentClassifierOutputDataConfig + + // Tags to be associated with the document classifier being created. A tag is a + // key-value pair that adds as a metadata to a resource used by Amazon Comprehend. + // For example, a tag with "Sales" as the key might be added to a resource to + // indicate its use by the sales department. + Tags []*types.Tag + + // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to + // encrypt data on the storage volume attached to the ML compute instance(s) that + // process the analysis job. The VolumeKmsKeyId can be either of the following + // formats: // - // This member is required. - InputDataConfig *types.DocumentClassifierInputDataConfig + // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // + // * Amazon + // Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + VolumeKmsKeyId *string // Configuration parameters for an optional private Virtual Private Cloud (VPC) // containing the resources you are using for your custom classifier. For more // information, see Amazon VPC // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). VpcConfig *types.VpcConfig - - // The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role - // that grants Amazon Comprehend read access to your input data. - // - // This member is required. - DataAccessRoleArn *string - - // Enables the addition of output results configuration parameters for custom - // classifier jobs. - OutputDataConfig *types.DocumentClassifierOutputDataConfig } type CreateDocumentClassifierOutput struct { diff --git a/service/comprehend/api_op_CreateEndpoint.go b/service/comprehend/api_op_CreateEndpoint.go index 6ccdac8349f..a52431957e8 100644 --- a/service/comprehend/api_op_CreateEndpoint.go +++ b/service/comprehend/api_op_CreateEndpoint.go @@ -60,12 +60,6 @@ func (c *Client) CreateEndpoint(ctx context.Context, params *CreateEndpointInput type CreateEndpointInput struct { - // This is the descriptive suffix that becomes part of the EndpointArn used for all - // subsequent requests to this resource. - // - // This member is required. - EndpointName *string - // The desired number of inference units to be used by the model using this // endpoint. Each inference unit represents of a throughput of 100 characters per // second. @@ -73,10 +67,11 @@ type CreateEndpointInput struct { // This member is required. DesiredInferenceUnits *int32 - // An idempotency token provided by the customer. If this token matches a previous - // endpoint creation request, Amazon Comprehend will not return a - // ResourceInUseException. - ClientRequestToken *string + // This is the descriptive suffix that becomes part of the EndpointArn used for all + // subsequent requests to this resource. + // + // This member is required. + EndpointName *string // The Amazon Resource Number (ARN) of the model to which the endpoint will be // attached. @@ -84,6 +79,11 @@ type CreateEndpointInput struct { // This member is required. ModelArn *string + // An idempotency token provided by the customer. If this token matches a previous + // endpoint creation request, Amazon Comprehend will not return a + // ResourceInUseException. + ClientRequestToken *string + // Tags associated with the endpoint being created. A tag is a key-value pair that // adds metadata to the endpoint. For example, a tag with "Sales" as the key might // be added to an endpoint to indicate its use by the sales department. diff --git a/service/comprehend/api_op_CreateEntityRecognizer.go b/service/comprehend/api_op_CreateEntityRecognizer.go index 133ad1c1804..a267f7f16af 100644 --- a/service/comprehend/api_op_CreateEntityRecognizer.go +++ b/service/comprehend/api_op_CreateEntityRecognizer.go @@ -61,17 +61,24 @@ func (c *Client) CreateEntityRecognizer(ctx context.Context, params *CreateEntit type CreateEntityRecognizerInput struct { - // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to - // encrypt data on the storage volume attached to the ML compute instance(s) that - // process the analysis job. The VolumeKmsKeyId can be either of the following - // formats: + // The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role + // that grants Amazon Comprehend read access to your input data. // - // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // This member is required. + DataAccessRoleArn *string + + // Specifies the format and location of the input data. The S3 bucket containing + // the input data must be located in the same region as the entity recognizer being + // created. // - // * Amazon - // Resource Name (ARN) of a KMS Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" - VolumeKmsKeyId *string + // This member is required. + InputDataConfig *types.EntityRecognizerInputDataConfig + + // The language of the input documents. All documents must be in the same language. + // Only English ("en") is currently supported. + // + // This member is required. + LanguageCode types.LanguageCode // The name given to the newly created recognizer. Recognizer names can be a // maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores @@ -80,12 +87,9 @@ type CreateEntityRecognizerInput struct { // This member is required. RecognizerName *string - // Specifies the format and location of the input data. The S3 bucket containing - // the input data must be located in the same region as the entity recognizer being - // created. - // - // This member is required. - InputDataConfig *types.EntityRecognizerInputDataConfig + // A unique identifier for the request. If you don't set the client request token, + // Amazon Comprehend generates one. + ClientRequestToken *string // Tags to be associated with the entity recognizer being created. A tag is a // key-value pair that adds as a metadata to a resource used by Amazon Comprehend. @@ -93,21 +97,17 @@ type CreateEntityRecognizerInput struct { // indicate its use by the sales department. Tags []*types.Tag - // A unique identifier for the request. If you don't set the client request token, - // Amazon Comprehend generates one. - ClientRequestToken *string - - // The language of the input documents. All documents must be in the same language. - // Only English ("en") is currently supported. + // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to + // encrypt data on the storage volume attached to the ML compute instance(s) that + // process the analysis job. The VolumeKmsKeyId can be either of the following + // formats: // - // This member is required. - LanguageCode types.LanguageCode - - // The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role - // that grants Amazon Comprehend read access to your input data. + // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" // - // This member is required. - DataAccessRoleArn *string + // * Amazon + // Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + VolumeKmsKeyId *string // Configuration parameters for an optional private Virtual Private Cloud (VPC) // containing the resources you are using for your custom entity recognizer. For diff --git a/service/comprehend/api_op_DetectEntities.go b/service/comprehend/api_op_DetectEntities.go index 39839cc44e8..50723356013 100644 --- a/service/comprehend/api_op_DetectEntities.go +++ b/service/comprehend/api_op_DetectEntities.go @@ -58,6 +58,12 @@ func (c *Client) DetectEntities(ctx context.Context, params *DetectEntitiesInput type DetectEntitiesInput struct { + // A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 + // encoded characters. + // + // This member is required. + Text *string + // The Amazon Resource Name of an endpoint that is associated with a custom entity // recognition model. Provide an endpoint if you want to detect entities by using // your own custom model instead of the default model that is used by Amazon @@ -72,12 +78,6 @@ type DetectEntitiesInput struct { // model, Amazon Comprehend uses the language of your custom model, and it ignores // any language code that you specify here. LanguageCode types.LanguageCode - - // A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 - // encoded characters. - // - // This member is required. - Text *string } type DetectEntitiesOutput struct { diff --git a/service/comprehend/api_op_DetectKeyPhrases.go b/service/comprehend/api_op_DetectKeyPhrases.go index 94a11ef461a..a934eaf45ea 100644 --- a/service/comprehend/api_op_DetectKeyPhrases.go +++ b/service/comprehend/api_op_DetectKeyPhrases.go @@ -57,18 +57,18 @@ func (c *Client) DetectKeyPhrases(ctx context.Context, params *DetectKeyPhrasesI type DetectKeyPhrasesInput struct { - // A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 - // encoded characters. - // - // This member is required. - Text *string - // The language of the input documents. You can specify any of the primary // languages supported by Amazon Comprehend. All documents must be in the same // language. // // This member is required. LanguageCode types.LanguageCode + + // A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 + // encoded characters. + // + // This member is required. + Text *string } type DetectKeyPhrasesOutput struct { diff --git a/service/comprehend/api_op_DetectSentiment.go b/service/comprehend/api_op_DetectSentiment.go index 24e700d9d2f..1ccb03d3d2d 100644 --- a/service/comprehend/api_op_DetectSentiment.go +++ b/service/comprehend/api_op_DetectSentiment.go @@ -58,29 +58,29 @@ func (c *Client) DetectSentiment(ctx context.Context, params *DetectSentimentInp type DetectSentimentInput struct { - // A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 - // encoded characters. - // - // This member is required. - Text *string - // The language of the input documents. You can specify any of the primary // languages supported by Amazon Comprehend. All documents must be in the same // language. // // This member is required. LanguageCode types.LanguageCode + + // A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 + // encoded characters. + // + // This member is required. + Text *string } type DetectSentimentOutput struct { - // An object that lists the sentiments, and their corresponding confidence levels. - SentimentScore *types.SentimentScore - // The inferred sentiment that Amazon Comprehend has the highest level of // confidence in. Sentiment types.SentimentType + // An object that lists the sentiments, and their corresponding confidence levels. + SentimentScore *types.SentimentScore + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/comprehend/api_op_DetectSyntax.go b/service/comprehend/api_op_DetectSyntax.go index 60aa4169cc3..5ef0738a0d2 100644 --- a/service/comprehend/api_op_DetectSyntax.go +++ b/service/comprehend/api_op_DetectSyntax.go @@ -58,18 +58,18 @@ func (c *Client) DetectSyntax(ctx context.Context, params *DetectSyntaxInput, op type DetectSyntaxInput struct { - // A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded - // characters. - // - // This member is required. - Text *string - // The language code of the input documents. You can specify any of the following // languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish // ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). // // This member is required. LanguageCode types.SyntaxLanguageCode + + // A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded + // characters. + // + // This member is required. + Text *string } type DetectSyntaxOutput struct { diff --git a/service/comprehend/api_op_ListDocumentClassifiers.go b/service/comprehend/api_op_ListDocumentClassifiers.go index 99dd49ce15c..d965992811f 100644 --- a/service/comprehend/api_op_ListDocumentClassifiers.go +++ b/service/comprehend/api_op_ListDocumentClassifiers.go @@ -56,26 +56,26 @@ func (c *Client) ListDocumentClassifiers(ctx context.Context, params *ListDocume type ListDocumentClassifiersInput struct { - // Identifies the next page of results to return. - NextToken *string - - // The maximum number of results to return in each page. The default is 100. - MaxResults *int32 - // Filters the jobs that are returned. You can filter jobs on their name, status, // or the date and time that they were submitted. You can only set one filter at a // time. Filter *types.DocumentClassifierFilter -} -type ListDocumentClassifiersOutput struct { + // The maximum number of results to return in each page. The default is 100. + MaxResults *int32 // Identifies the next page of results to return. NextToken *string +} + +type ListDocumentClassifiersOutput struct { // A list containing the properties of each job returned. DocumentClassifierPropertiesList []*types.DocumentClassifierProperties + // Identifies the next page of results to return. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/comprehend/api_op_ListDominantLanguageDetectionJobs.go b/service/comprehend/api_op_ListDominantLanguageDetectionJobs.go index bf1f072c38e..198081b5e95 100644 --- a/service/comprehend/api_op_ListDominantLanguageDetectionJobs.go +++ b/service/comprehend/api_op_ListDominantLanguageDetectionJobs.go @@ -56,9 +56,6 @@ func (c *Client) ListDominantLanguageDetectionJobs(ctx context.Context, params * type ListDominantLanguageDetectionJobsInput struct { - // Identifies the next page of results to return. - NextToken *string - // Filters that jobs that are returned. You can filter jobs on their name, status, // or the date and time that they were submitted. You can only set one filter at a // time. @@ -66,16 +63,19 @@ type ListDominantLanguageDetectionJobsInput struct { // The maximum number of results to return in each page. The default is 100. MaxResults *int32 -} - -type ListDominantLanguageDetectionJobsOutput struct { // Identifies the next page of results to return. NextToken *string +} + +type ListDominantLanguageDetectionJobsOutput struct { // A list containing the properties of each job that is returned. DominantLanguageDetectionJobPropertiesList []*types.DominantLanguageDetectionJobProperties + // Identifies the next page of results to return. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/comprehend/api_op_ListEndpoints.go b/service/comprehend/api_op_ListEndpoints.go index 02681301a0f..5653ac806ea 100644 --- a/service/comprehend/api_op_ListEndpoints.go +++ b/service/comprehend/api_op_ListEndpoints.go @@ -56,27 +56,27 @@ func (c *Client) ListEndpoints(ctx context.Context, params *ListEndpointsInput, type ListEndpointsInput struct { - // Identifies the next page of results to return. - NextToken *string - - // The maximum number of results to return in each page. The default is 100. - MaxResults *int32 - // Filters the endpoints that are returned. You can filter endpoints on their name, // model, status, or the date and time that they were created. You can only set one // filter at a time. Filter *types.EndpointFilter -} -type ListEndpointsOutput struct { + // The maximum number of results to return in each page. The default is 100. + MaxResults *int32 // Identifies the next page of results to return. NextToken *string +} + +type ListEndpointsOutput struct { // Displays a list of endpoint properties being retrieved by the service in // response to the request. EndpointPropertiesList []*types.EndpointProperties + // Identifies the next page of results to return. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/comprehend/api_op_ListEntityRecognizers.go b/service/comprehend/api_op_ListEntityRecognizers.go index b5cca91e780..6d8cc71db70 100644 --- a/service/comprehend/api_op_ListEntityRecognizers.go +++ b/service/comprehend/api_op_ListEntityRecognizers.go @@ -61,25 +61,25 @@ func (c *Client) ListEntityRecognizers(ctx context.Context, params *ListEntityRe type ListEntityRecognizersInput struct { - // Identifies the next page of results to return. - NextToken *string - - // The maximum number of results to return on each page. The default is 100. - MaxResults *int32 - // Filters the list of entities returned. You can filter on Status, // SubmitTimeBefore, or SubmitTimeAfter. You can only set one filter at a time. Filter *types.EntityRecognizerFilter -} -type ListEntityRecognizersOutput struct { + // The maximum number of results to return on each page. The default is 100. + MaxResults *int32 // Identifies the next page of results to return. NextToken *string +} + +type ListEntityRecognizersOutput struct { // The list of properties of an entity recognizer. EntityRecognizerPropertiesList []*types.EntityRecognizerProperties + // Identifies the next page of results to return. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/comprehend/api_op_ListKeyPhrasesDetectionJobs.go b/service/comprehend/api_op_ListKeyPhrasesDetectionJobs.go index 6418c405e2e..247678dee23 100644 --- a/service/comprehend/api_op_ListKeyPhrasesDetectionJobs.go +++ b/service/comprehend/api_op_ListKeyPhrasesDetectionJobs.go @@ -56,16 +56,16 @@ func (c *Client) ListKeyPhrasesDetectionJobs(ctx context.Context, params *ListKe type ListKeyPhrasesDetectionJobsInput struct { - // Identifies the next page of results to return. - NextToken *string - - // The maximum number of results to return in each page. The default is 100. - MaxResults *int32 - // Filters the jobs that are returned. You can filter jobs on their name, status, // or the date and time that they were submitted. You can only set one filter at a // time. Filter *types.KeyPhrasesDetectionJobFilter + + // The maximum number of results to return in each page. The default is 100. + MaxResults *int32 + + // Identifies the next page of results to return. + NextToken *string } type ListKeyPhrasesDetectionJobsOutput struct { diff --git a/service/comprehend/api_op_ListSentimentDetectionJobs.go b/service/comprehend/api_op_ListSentimentDetectionJobs.go index 9578d13ef29..997374c8e0e 100644 --- a/service/comprehend/api_op_ListSentimentDetectionJobs.go +++ b/service/comprehend/api_op_ListSentimentDetectionJobs.go @@ -56,9 +56,6 @@ func (c *Client) ListSentimentDetectionJobs(ctx context.Context, params *ListSen type ListSentimentDetectionJobsInput struct { - // Identifies the next page of results to return. - NextToken *string - // Filters the jobs that are returned. You can filter jobs on their name, status, // or the date and time that they were submitted. You can only set one filter at a // time. @@ -66,16 +63,19 @@ type ListSentimentDetectionJobsInput struct { // The maximum number of results to return in each page. The default is 100. MaxResults *int32 + + // Identifies the next page of results to return. + NextToken *string } type ListSentimentDetectionJobsOutput struct { - // A list containing the properties of each job that is returned. - SentimentDetectionJobPropertiesList []*types.SentimentDetectionJobProperties - // Identifies the next page of results to return. NextToken *string + // A list containing the properties of each job that is returned. + SentimentDetectionJobPropertiesList []*types.SentimentDetectionJobProperties + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/comprehend/api_op_ListTagsForResource.go b/service/comprehend/api_op_ListTagsForResource.go index 4cca2bd222b..a7bab461367 100644 --- a/service/comprehend/api_op_ListTagsForResource.go +++ b/service/comprehend/api_op_ListTagsForResource.go @@ -66,16 +66,16 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { + // The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are + // querying. + ResourceArn *string + // Tags associated with the Amazon Comprehend resource being queried. A tag is a // key-value pair that adds as a metadata to a resource used by Amazon Comprehend. // For example, a tag with "Sales" as the key might be added to a resource to // indicate its use by the sales department. Tags []*types.Tag - // The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are - // querying. - ResourceArn *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/comprehend/api_op_ListTopicsDetectionJobs.go b/service/comprehend/api_op_ListTopicsDetectionJobs.go index b0c686ba54d..fa5c515281f 100644 --- a/service/comprehend/api_op_ListTopicsDetectionJobs.go +++ b/service/comprehend/api_op_ListTopicsDetectionJobs.go @@ -56,26 +56,26 @@ func (c *Client) ListTopicsDetectionJobs(ctx context.Context, params *ListTopics type ListTopicsDetectionJobsInput struct { - // The maximum number of results to return in each page. The default is 100. - MaxResults *int32 - // Filters the jobs that are returned. Jobs can be filtered on their name, status, // or the date and time that they were submitted. You can set only one filter at a // time. Filter *types.TopicsDetectionJobFilter + // The maximum number of results to return in each page. The default is 100. + MaxResults *int32 + // Identifies the next page of results to return. NextToken *string } type ListTopicsDetectionJobsOutput struct { - // A list containing the properties of each job that is returned. - TopicsDetectionJobPropertiesList []*types.TopicsDetectionJobProperties - // Identifies the next page of results to return. NextToken *string + // A list containing the properties of each job that is returned. + TopicsDetectionJobPropertiesList []*types.TopicsDetectionJobProperties + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/comprehend/api_op_StartDocumentClassificationJob.go b/service/comprehend/api_op_StartDocumentClassificationJob.go index d878c2f501d..0a645f50c93 100644 --- a/service/comprehend/api_op_StartDocumentClassificationJob.go +++ b/service/comprehend/api_op_StartDocumentClassificationJob.go @@ -60,27 +60,34 @@ func (c *Client) StartDocumentClassificationJob(ctx context.Context, params *Sta type StartDocumentClassificationJobInput struct { + // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) + // role that grants Amazon Comprehend read access to your input data. + // + // This member is required. + DataAccessRoleArn *string + // The Amazon Resource Name (ARN) of the document classifier to use to process the // job. // // This member is required. DocumentClassifierArn *string - // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) - // role that grants Amazon Comprehend read access to your input data. + // Specifies the format and location of the input data for the job. // // This member is required. - DataAccessRoleArn *string + InputDataConfig *types.InputDataConfig // Specifies where to send the output files. // // This member is required. OutputDataConfig *types.OutputDataConfig - // Specifies the format and location of the input data for the job. - // - // This member is required. - InputDataConfig *types.InputDataConfig + // A unique identifier for the request. If you do not set the client request token, + // Amazon Comprehend generates one. + ClientRequestToken *string + + // The identifier of the job. + JobName *string // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to // encrypt data on the storage volume attached to the ML compute instance(s) that @@ -94,22 +101,19 @@ type StartDocumentClassificationJobInput struct { // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string - // The identifier of the job. - JobName *string - // Configuration parameters for an optional private Virtual Private Cloud (VPC) // containing the resources you are using for your document classification job. For // more information, see Amazon VPC // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). VpcConfig *types.VpcConfig - - // A unique identifier for the request. If you do not set the client request token, - // Amazon Comprehend generates one. - ClientRequestToken *string } type StartDocumentClassificationJobOutput struct { + // The identifier generated for the job. To get the status of the job, use this + // identifier with the operation. + JobId *string + // The status of the job: // // * SUBMITTED - The job has been received and queued @@ -131,10 +135,6 @@ type StartDocumentClassificationJobOutput struct { // without completing. JobStatus types.JobStatus - // The identifier generated for the job. To get the status of the job, use this - // identifier with the operation. - JobId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/comprehend/api_op_StartDominantLanguageDetectionJob.go b/service/comprehend/api_op_StartDominantLanguageDetectionJob.go index 155c58133a2..bc361fbaf86 100644 --- a/service/comprehend/api_op_StartDominantLanguageDetectionJob.go +++ b/service/comprehend/api_op_StartDominantLanguageDetectionJob.go @@ -60,14 +60,32 @@ func (c *Client) StartDominantLanguageDetectionJob(ctx context.Context, params * type StartDominantLanguageDetectionJobInput struct { - // An identifier for the job. - JobName *string + // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) + // role that grants Amazon Comprehend read access to your input data. For more + // information, see + // https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions + // (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions). + // + // This member is required. + DataAccessRoleArn *string // Specifies the format and location of the input data for the job. // // This member is required. InputDataConfig *types.InputDataConfig + // Specifies where to send the output files. + // + // This member is required. + OutputDataConfig *types.OutputDataConfig + + // A unique identifier for the request. If you do not set the client request token, + // Amazon Comprehend generates one. + ClientRequestToken *string + + // An identifier for the job. + JobName *string + // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to // encrypt data on the storage volume attached to the ML compute instance(s) that // process the analysis job. The VolumeKmsKeyId can be either of the following @@ -80,29 +98,11 @@ type StartDominantLanguageDetectionJobInput struct { // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string - // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) - // role that grants Amazon Comprehend read access to your input data. For more - // information, see - // https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions - // (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions). - // - // This member is required. - DataAccessRoleArn *string - // Configuration parameters for an optional private Virtual Private Cloud (VPC) // containing the resources you are using for your dominant language detection job. // For more information, see Amazon VPC // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). VpcConfig *types.VpcConfig - - // A unique identifier for the request. If you do not set the client request token, - // Amazon Comprehend generates one. - ClientRequestToken *string - - // Specifies where to send the output files. - // - // This member is required. - OutputDataConfig *types.OutputDataConfig } type StartDominantLanguageDetectionJobOutput struct { diff --git a/service/comprehend/api_op_StartEntitiesDetectionJob.go b/service/comprehend/api_op_StartEntitiesDetectionJob.go index a4f5b8e2c26..874f5fb96b9 100644 --- a/service/comprehend/api_op_StartEntitiesDetectionJob.go +++ b/service/comprehend/api_op_StartEntitiesDetectionJob.go @@ -64,11 +64,45 @@ func (c *Client) StartEntitiesDetectionJob(ctx context.Context, params *StartEnt type StartEntitiesDetectionJobInput struct { + // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) + // role that grants Amazon Comprehend read access to your input data. For more + // information, see + // https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions + // (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions). + // + // This member is required. + DataAccessRoleArn *string + + // Specifies the format and location of the input data for the job. + // + // This member is required. + InputDataConfig *types.InputDataConfig + + // The language of the input documents. All documents must be in the same language. + // You can specify any of the languages supported by Amazon Comprehend. If custom + // entities recognition is used, this parameter is ignored and the language used + // for training the model is used instead. + // + // This member is required. + LanguageCode types.LanguageCode + // Specifies where to send the output files. // // This member is required. OutputDataConfig *types.OutputDataConfig + // A unique identifier for the request. If you don't set the client request token, + // Amazon Comprehend generates one. + ClientRequestToken *string + + // The Amazon Resource Name (ARN) that identifies the specific entity recognizer to + // be used by the StartEntitiesDetectionJob. This ARN is optional and is only used + // for a custom entity recognition job. + EntityRecognizerArn *string + + // The identifier of the job. + JobName *string + // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to // encrypt data on the storage volume attached to the ML compute instance(s) that // process the analysis job. The VolumeKmsKeyId can be either of the following @@ -81,45 +115,11 @@ type StartEntitiesDetectionJobInput struct { // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string - // The Amazon Resource Name (ARN) that identifies the specific entity recognizer to - // be used by the StartEntitiesDetectionJob. This ARN is optional and is only used - // for a custom entity recognition job. - EntityRecognizerArn *string - - // Specifies the format and location of the input data for the job. - // - // This member is required. - InputDataConfig *types.InputDataConfig - - // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) - // role that grants Amazon Comprehend read access to your input data. For more - // information, see - // https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions - // (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions). - // - // This member is required. - DataAccessRoleArn *string - - // The identifier of the job. - JobName *string - // Configuration parameters for an optional private Virtual Private Cloud (VPC) // containing the resources you are using for your entity detection job. For more // information, see Amazon VPC // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). VpcConfig *types.VpcConfig - - // The language of the input documents. All documents must be in the same language. - // You can specify any of the languages supported by Amazon Comprehend. If custom - // entities recognition is used, this parameter is ignored and the language used - // for training the model is used instead. - // - // This member is required. - LanguageCode types.LanguageCode - - // A unique identifier for the request. If you don't set the client request token, - // Amazon Comprehend generates one. - ClientRequestToken *string } type StartEntitiesDetectionJobOutput struct { diff --git a/service/comprehend/api_op_StartKeyPhrasesDetectionJob.go b/service/comprehend/api_op_StartKeyPhrasesDetectionJob.go index ae5433387ba..87eb7cf3a75 100644 --- a/service/comprehend/api_op_StartKeyPhrasesDetectionJob.go +++ b/service/comprehend/api_op_StartKeyPhrasesDetectionJob.go @@ -60,17 +60,6 @@ func (c *Client) StartKeyPhrasesDetectionJob(ctx context.Context, params *StartK type StartKeyPhrasesDetectionJobInput struct { - // Configuration parameters for an optional private Virtual Private Cloud (VPC) - // containing the resources you are using for your key phrases detection job. For - // more information, see Amazon VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). - VpcConfig *types.VpcConfig - - // Specifies the format and location of the input data for the job. - // - // This member is required. - InputDataConfig *types.InputDataConfig - // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) // role that grants Amazon Comprehend read access to your input data. For more // information, see @@ -80,17 +69,17 @@ type StartKeyPhrasesDetectionJobInput struct { // This member is required. DataAccessRoleArn *string - // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to - // encrypt data on the storage volume attached to the ML compute instance(s) that - // process the analysis job. The VolumeKmsKeyId can be either of the following - // formats: + // Specifies the format and location of the input data for the job. // - // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // This member is required. + InputDataConfig *types.InputDataConfig + + // The language of the input documents. You can specify any of the primary + // languages supported by Amazon Comprehend. All documents must be in the same + // language. // - // * Amazon - // Resource Name (ARN) of a KMS Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" - VolumeKmsKeyId *string + // This member is required. + LanguageCode types.LanguageCode // Specifies where to send the output files. // @@ -101,19 +90,34 @@ type StartKeyPhrasesDetectionJobInput struct { // Amazon Comprehend generates one. ClientRequestToken *string - // The language of the input documents. You can specify any of the primary - // languages supported by Amazon Comprehend. All documents must be in the same - // language. - // - // This member is required. - LanguageCode types.LanguageCode - // The identifier of the job. JobName *string + + // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to + // encrypt data on the storage volume attached to the ML compute instance(s) that + // process the analysis job. The VolumeKmsKeyId can be either of the following + // formats: + // + // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // + // * Amazon + // Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + VolumeKmsKeyId *string + + // Configuration parameters for an optional private Virtual Private Cloud (VPC) + // containing the resources you are using for your key phrases detection job. For + // more information, see Amazon VPC + // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + VpcConfig *types.VpcConfig } type StartKeyPhrasesDetectionJobOutput struct { + // The identifier generated for the job. To get the status of a job, use this + // identifier with the operation. + JobId *string + // The status of the job. // // * SUBMITTED - The job has been received and is @@ -129,10 +133,6 @@ type StartKeyPhrasesDetectionJobOutput struct { // operation. JobStatus types.JobStatus - // The identifier generated for the job. To get the status of a job, use this - // identifier with the operation. - JobId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/comprehend/api_op_StartSentimentDetectionJob.go b/service/comprehend/api_op_StartSentimentDetectionJob.go index 42937d1fd49..86815a12bc8 100644 --- a/service/comprehend/api_op_StartSentimentDetectionJob.go +++ b/service/comprehend/api_op_StartSentimentDetectionJob.go @@ -60,11 +60,6 @@ func (c *Client) StartSentimentDetectionJob(ctx context.Context, params *StartSe type StartSentimentDetectionJobInput struct { - // Specifies the format and location of the input data for the job. - // - // This member is required. - InputDataConfig *types.InputDataConfig - // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) // role that grants Amazon Comprehend read access to your input data. For more // information, see @@ -74,6 +69,30 @@ type StartSentimentDetectionJobInput struct { // This member is required. DataAccessRoleArn *string + // Specifies the format and location of the input data for the job. + // + // This member is required. + InputDataConfig *types.InputDataConfig + + // The language of the input documents. You can specify any of the primary + // languages supported by Amazon Comprehend. All documents must be in the same + // language. + // + // This member is required. + LanguageCode types.LanguageCode + + // Specifies where to send the output files. + // + // This member is required. + OutputDataConfig *types.OutputDataConfig + + // A unique identifier for the request. If you don't set the client request token, + // Amazon Comprehend generates one. + ClientRequestToken *string + + // The identifier of the job. + JobName *string + // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to // encrypt data on the storage volume attached to the ML compute instance(s) that // process the analysis job. The VolumeKmsKeyId can be either of the following @@ -86,30 +105,11 @@ type StartSentimentDetectionJobInput struct { // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string - // Specifies where to send the output files. - // - // This member is required. - OutputDataConfig *types.OutputDataConfig - // Configuration parameters for an optional private Virtual Private Cloud (VPC) // containing the resources you are using for your sentiment detection job. For // more information, see Amazon VPC // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). VpcConfig *types.VpcConfig - - // A unique identifier for the request. If you don't set the client request token, - // Amazon Comprehend generates one. - ClientRequestToken *string - - // The language of the input documents. You can specify any of the primary - // languages supported by Amazon Comprehend. All documents must be in the same - // language. - // - // This member is required. - LanguageCode types.LanguageCode - - // The identifier of the job. - JobName *string } type StartSentimentDetectionJobOutput struct { diff --git a/service/comprehend/api_op_StartTopicsDetectionJob.go b/service/comprehend/api_op_StartTopicsDetectionJob.go index d187a6c3443..9b0433ccd08 100644 --- a/service/comprehend/api_op_StartTopicsDetectionJob.go +++ b/service/comprehend/api_op_StartTopicsDetectionJob.go @@ -69,21 +69,25 @@ type StartTopicsDetectionJobInput struct { // This member is required. DataAccessRoleArn *string - // A unique identifier for the request. If you do not set the client request token, - // Amazon Comprehend generates one. - ClientRequestToken *string - - // Configuration parameters for an optional private Virtual Private Cloud (VPC) - // containing the resources you are using for your topic detection job. For more - // information, see Amazon VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). - VpcConfig *types.VpcConfig - // Specifies the format and location of the input data for the job. // // This member is required. InputDataConfig *types.InputDataConfig + // Specifies where to send the output files. The output is a compressed archive + // with two files, topic-terms.csv that lists the terms associated with each topic, + // and doc-topics.csv that lists the documents associated with each topic + // + // This member is required. + OutputDataConfig *types.OutputDataConfig + + // A unique identifier for the request. If you do not set the client request token, + // Amazon Comprehend generates one. + ClientRequestToken *string + + // The identifier of the job. + JobName *string + // The number of topics to detect. NumberOfTopics *int32 @@ -99,19 +103,19 @@ type StartTopicsDetectionJobInput struct { // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string - // Specifies where to send the output files. The output is a compressed archive - // with two files, topic-terms.csv that lists the terms associated with each topic, - // and doc-topics.csv that lists the documents associated with each topic - // - // This member is required. - OutputDataConfig *types.OutputDataConfig - - // The identifier of the job. - JobName *string + // Configuration parameters for an optional private Virtual Private Cloud (VPC) + // containing the resources you are using for your topic detection job. For more + // information, see Amazon VPC + // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + VpcConfig *types.VpcConfig } type StartTopicsDetectionJobOutput struct { + // The identifier generated for the job. To get the status of the job, use this + // identifier with the DescribeTopicDetectionJob operation. + JobId *string + // The status of the job: // // * SUBMITTED - The job has been received and is @@ -127,10 +131,6 @@ type StartTopicsDetectionJobOutput struct { // DescribeTopicDetectionJob operation. JobStatus types.JobStatus - // The identifier generated for the job. To get the status of the job, use this - // identifier with the DescribeTopicDetectionJob operation. - JobId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/comprehend/api_op_StopDominantLanguageDetectionJob.go b/service/comprehend/api_op_StopDominantLanguageDetectionJob.go index 2d269e37796..fababcabbb7 100644 --- a/service/comprehend/api_op_StopDominantLanguageDetectionJob.go +++ b/service/comprehend/api_op_StopDominantLanguageDetectionJob.go @@ -72,13 +72,13 @@ type StopDominantLanguageDetectionJobInput struct { type StopDominantLanguageDetectionJobOutput struct { + // The identifier of the dominant language detection job to stop. + JobId *string + // Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was // previously stopped with the StopDominantLanguageDetectionJob operation. JobStatus types.JobStatus - // The identifier of the dominant language detection job to stop. - JobId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/comprehend/api_op_StopSentimentDetectionJob.go b/service/comprehend/api_op_StopSentimentDetectionJob.go index 6c5eb6bdcd9..5b4744d049f 100644 --- a/service/comprehend/api_op_StopSentimentDetectionJob.go +++ b/service/comprehend/api_op_StopSentimentDetectionJob.go @@ -71,13 +71,13 @@ type StopSentimentDetectionJobInput struct { type StopSentimentDetectionJobOutput struct { + // The identifier of the sentiment detection job to stop. + JobId *string + // Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was // previously stopped with the StopSentimentDetectionJob operation. JobStatus types.JobStatus - // The identifier of the sentiment detection job to stop. - JobId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/comprehend/api_op_UpdateEndpoint.go b/service/comprehend/api_op_UpdateEndpoint.go index 5910554f6a5..7377861a93a 100644 --- a/service/comprehend/api_op_UpdateEndpoint.go +++ b/service/comprehend/api_op_UpdateEndpoint.go @@ -56,17 +56,17 @@ func (c *Client) UpdateEndpoint(ctx context.Context, params *UpdateEndpointInput type UpdateEndpointInput struct { - // The Amazon Resource Number (ARN) of the endpoint being updated. - // - // This member is required. - EndpointArn *string - // The desired number of inference units to be used by the model using this // endpoint. Each inference unit represents of a throughput of 100 characters per // second. // // This member is required. DesiredInferenceUnits *int32 + + // The Amazon Resource Number (ARN) of the endpoint being updated. + // + // This member is required. + EndpointArn *string } type UpdateEndpointOutput struct { diff --git a/service/comprehend/go.mod b/service/comprehend/go.mod index d2991f6a886..f0d24dd098c 100644 --- a/service/comprehend/go.mod +++ b/service/comprehend/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/comprehend go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/comprehend/types/types.go b/service/comprehend/types/types.go index df58ec733e1..ca2ea3aaeb0 100644 --- a/service/comprehend/types/types.go +++ b/service/comprehend/types/types.go @@ -10,12 +10,12 @@ import ( // document that is successfully processed by the operation. type BatchDetectDominantLanguageItemResult struct { + // The zero-based index of the document in the input list. + Index *int32 + // One or more DominantLanguage () objects describing the dominant languages in the // document. Languages []*DominantLanguage - - // The zero-based index of the document in the input list. - Index *int32 } // The result of calling the operation. The operation returns one object for each @@ -33,24 +33,24 @@ type BatchDetectEntitiesItemResult struct { // document that is successfully processed by the operation. type BatchDetectKeyPhrasesItemResult struct { + // The zero-based index of the document in the input list. + Index *int32 + // One or more KeyPhrase () objects, one for each key phrase detected in the // document. KeyPhrases []*KeyPhrase - - // The zero-based index of the document in the input list. - Index *int32 } // The result of calling the operation. The operation returns one object for each // document that is successfully processed by the operation. type BatchDetectSentimentItemResult struct { - // The sentiment detected in the document. - Sentiment SentimentType - // The zero-based index of the document in the input list. Index *int32 + // The sentiment detected in the document. + Sentiment SentimentType + // The level of confidence that Amazon Comprehend has in the accuracy of its // sentiment detection. SentimentScore *SentimentScore @@ -72,14 +72,14 @@ type BatchDetectSyntaxItemResult struct { // error. type BatchItemError struct { - // The zero-based index of the document in the input list. - Index *int32 + // The numeric error code of the error. + ErrorCode *string // A text description of the error. ErrorMessage *string - // The numeric error code of the error. - ErrorCode *string + // The zero-based index of the document in the input list. + Index *int32 } // Describes the result metrics for the test data associated with an documentation @@ -91,66 +91,66 @@ type ClassifierEvaluationMetrics struct { // recognized by the total number of labels in the test documents. Accuracy *float64 + // A measure of how accurate the classifier results are for the test data. It is + // derived from the Precision and Recall values. The F1Score is the harmonic + // average of the two scores. The highest score is 1, and the worst score is 0. + F1Score *float64 + // Indicates the fraction of labels that are incorrectly predicted. Also seen as // the fraction of wrong labels compared to the total number of labels. Scores // closer to zero are better. HammingLoss *float64 - // A measure of how complete the classifier results are for the test data. High - // recall means that the classifier returned most of the relevant results. - // Specifically, this indicates how many of the correct categories in the text that - // the model can predict. It is a percentage of correct categories in the text that - // can found. Instead of averaging the recall scores of all labels (as with - // Recall), micro Recall is based on the overall score of all recall scores added - // together. - MicroRecall *float64 - // A measure of how accurate the classifier results are for the test data. It is a // combination of the Micro Precision and Micro Recall values. The Micro F1Score is // the harmonic mean of the two scores. The highest score is 1, and the worst score // is 0. MicroF1Score *float64 - // A measure of how accurate the classifier results are for the test data. It is - // derived from the Precision and Recall values. The F1Score is the harmonic - // average of the two scores. The highest score is 1, and the worst score is 0. - F1Score *float64 + // A measure of the usefulness of the recognizer results in the test data. High + // precision means that the recognizer returned substantially more relevant results + // than irrelevant ones. Unlike the Precision metric which comes from averaging the + // precision of all available labels, this is based on the overall score of all + // precision scores added together. + MicroPrecision *float64 // A measure of how complete the classifier results are for the test data. High // recall means that the classifier returned most of the relevant results. - Recall *float64 + // Specifically, this indicates how many of the correct categories in the text that + // the model can predict. It is a percentage of correct categories in the text that + // can found. Instead of averaging the recall scores of all labels (as with + // Recall), micro Recall is based on the overall score of all recall scores added + // together. + MicroRecall *float64 // A measure of the usefulness of the classifier results in the test data. High // precision means that the classifier returned substantially more relevant results // than irrelevant ones. Precision *float64 - // A measure of the usefulness of the recognizer results in the test data. High - // precision means that the recognizer returned substantially more relevant results - // than irrelevant ones. Unlike the Precision metric which comes from averaging the - // precision of all available labels, this is based on the overall score of all - // precision scores added together. - MicroPrecision *float64 + // A measure of how complete the classifier results are for the test data. High + // recall means that the classifier returned most of the relevant results. + Recall *float64 } // Provides information about a document classifier. type ClassifierMetadata struct { + // Describes the result metrics for the test data associated with an documentation + // classifier. + EvaluationMetrics *ClassifierEvaluationMetrics + // The number of labels in the input data. NumberOfLabels *int32 - // The number of documents in the input data that were used to train the - // classifier. Typically this is 80 to 90 percent of the input documents. - NumberOfTrainedDocuments *int32 - // The number of documents in the input data that were used to test the classifier. // Typically this is 10 to 20 percent of the input documents, up to 10,000 // documents. NumberOfTestDocuments *int32 - // Describes the result metrics for the test data associated with an documentation - // classifier. - EvaluationMetrics *ClassifierEvaluationMetrics + // The number of documents in the input data that were used to train the + // classifier. Typically this is 80 to 90 percent of the input documents. + NumberOfTrainedDocuments *int32 } // Specifies the class that categorizes the document being analyzed @@ -189,15 +189,40 @@ type DocumentClassificationJobFilter struct { // Provides information about a document classification job. type DocumentClassificationJobProperties struct { + // The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) + // role that grants Amazon Comprehend read access to your input data. + DataAccessRoleArn *string + + // The Amazon Resource Name (ARN) that identifies the document classifier. + DocumentClassifierArn *string + + // The time that the document classification job completed. + EndTime *time.Time + + // The input data configuration that you supplied when you created the document + // classification job. + InputDataConfig *InputDataConfig + + // The identifier assigned to the document classification job. + JobId *string + + // The name that you assigned to the document classification job. + JobName *string + + // The current status of the document classification job. If the status is FAILED, + // the Message field shows the reason for the failure. + JobStatus JobStatus + // A description of the status of the job. Message *string + // The output data configuration that you supplied when you created the document + // classification job. + OutputDataConfig *OutputDataConfig + // The time that the document classification job was submitted for processing. SubmitTime *time.Time - // The Amazon Resource Name (ARN) that identifies the document classifier. - DocumentClassifierArn *string - // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to // encrypt data on the storage volume attached to the ML compute instance(s) that // process the analysis job. The VolumeKmsKeyId can be either of the following @@ -210,36 +235,11 @@ type DocumentClassificationJobProperties struct { // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string - // The identifier assigned to the document classification job. - JobId *string - - // The current status of the document classification job. If the status is FAILED, - // the Message field shows the reason for the failure. - JobStatus JobStatus - - // The input data configuration that you supplied when you created the document - // classification job. - InputDataConfig *InputDataConfig - // Configuration parameters for a private Virtual Private Cloud (VPC) containing // the resources you are using for your document classification job. For more // information, see Amazon VPC // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). VpcConfig *VpcConfig - - // The time that the document classification job completed. - EndTime *time.Time - - // The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) - // role that grants Amazon Comprehend read access to your input data. - DataAccessRoleArn *string - - // The output data configuration that you supplied when you created the document - // classification job. - OutputDataConfig *OutputDataConfig - - // The name that you assigned to the document classification job. - JobName *string } // Provides information for filtering a list of document classifiers. You can only @@ -247,14 +247,14 @@ type DocumentClassificationJobProperties struct { // operation. type DocumentClassifierFilter struct { + // Filters the list of classifiers based on status. + Status ModelStatus + // Filters the list of classifiers based on the time that the classifier was // submitted for processing. Returns only classifiers submitted after the specified // time. Classifiers are returned in descending order, newest to oldest. SubmitTimeAfter *time.Time - // Filters the list of classifiers based on status. - Status ModelStatus - // Filters the list of classifiers based on the time that the classifier was // submitted for processing. Returns only classifiers submitted before the // specified time. Classifiers are returned in ascending order, oldest to newest. @@ -319,19 +319,31 @@ type DocumentClassifierOutputDataConfig struct { // Provides information about a document classifier. type DocumentClassifierProperties struct { - // The status of the document classifier. If the status is TRAINED the classifier - // is ready to use. If the status is FAILED you can see additional information - // about why the classifier wasn't trained in the Message field. - Status ModelStatus + // Information about the document classifier, including the number of documents + // used for training the classifier, the number of documents used for test the + // classifier, and an accuracy rating. + ClassifierMetadata *ClassifierMetadata - // Configuration parameters for a private Virtual Private Cloud (VPC) containing - // the resources you are using for your custom classifier. For more information, - // see Amazon VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). - VpcConfig *VpcConfig + // The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role + // that grants Amazon Comprehend read access to your input data. + DataAccessRoleArn *string - // The time that the document classifier was submitted for training. - SubmitTime *time.Time + // The Amazon Resource Name (ARN) that identifies the document classifier. + DocumentClassifierArn *string + + // The time that training the document classifier completed. + EndTime *time.Time + + // The input data configuration that you supplied when you created the document + // classifier for training. + InputDataConfig *DocumentClassifierInputDataConfig + + // The language code for the language of the documents that the classifier was + // trained on. + LanguageCode LanguageCode + + // Additional information about the status of the classifier. + Message *string // Indicates the mode in which the specific classifier was trained. This also // indicates the format of input documents and the format of the confusion matrix. @@ -339,20 +351,26 @@ type DocumentClassifierProperties struct { // the classifier is trained. Mode DocumentClassifierMode - // The input data configuration that you supplied when you created the document - // classifier for training. - InputDataConfig *DocumentClassifierInputDataConfig + // Provides output results configuration parameters for custom classifier jobs. + OutputDataConfig *DocumentClassifierOutputDataConfig - // The time that training the document classifier completed. - EndTime *time.Time + // The status of the document classifier. If the status is TRAINED the classifier + // is ready to use. If the status is FAILED you can see additional information + // about why the classifier wasn't trained in the Message field. + Status ModelStatus + + // The time that the document classifier was submitted for training. + SubmitTime *time.Time // The time that training of the document classifier was completed. Indicates the // time when the training completes on documentation classifiers. You are billed // for the time interval between this time and the value of TrainingStartTime. TrainingEndTime *time.Time - // Provides output results configuration parameters for custom classifier jobs. - OutputDataConfig *DocumentClassifierOutputDataConfig + // Indicates the time when the training starts on documentation classifiers. You + // are billed for the time interval between this time and the value of + // TrainingEndTime. + TrainingStartTime *time.Time // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to // encrypt data on the storage volume attached to the ML compute instance(s) that @@ -366,29 +384,11 @@ type DocumentClassifierProperties struct { // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string - // The language code for the language of the documents that the classifier was - // trained on. - LanguageCode LanguageCode - - // The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role - // that grants Amazon Comprehend read access to your input data. - DataAccessRoleArn *string - - // Indicates the time when the training starts on documentation classifiers. You - // are billed for the time interval between this time and the value of - // TrainingEndTime. - TrainingStartTime *time.Time - - // The Amazon Resource Name (ARN) that identifies the document classifier. - DocumentClassifierArn *string - - // Information about the document classifier, including the number of documents - // used for training the classifier, the number of documents used for test the - // classifier, and an accuracy rating. - ClassifierMetadata *ClassifierMetadata - - // Additional information about the status of the classifier. - Message *string + // Configuration parameters for a private Virtual Private Cloud (VPC) containing + // the resources you are using for your custom classifier. For more information, + // see Amazon VPC + // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + VpcConfig *VpcConfig } // Specifies one of the label or labels that categorize the document being @@ -406,31 +406,31 @@ type DocumentLabel struct { // confidence that Amazon Comprehend has in the accuracy of the detection. type DominantLanguage struct { - // The level of confidence that Amazon Comprehend has in the accuracy of the - // detection. - Score *float32 - // The RFC 5646 language code for the dominant language. For more information about // RFC 5646, see Tags for Identifying Languages // (https://tools.ietf.org/html/rfc5646) on the IETF Tools web site. LanguageCode *string + + // The level of confidence that Amazon Comprehend has in the accuracy of the + // detection. + Score *float32 } // Provides information for filtering a list of dominant language detection jobs. // For more information, see the operation. type DominantLanguageDetectionJobFilter struct { - // Filters the list of jobs based on the time that the job was submitted for - // processing. Returns only jobs submitted after the specified time. Jobs are - // returned in descending order, newest to oldest. - SubmitTimeAfter *time.Time + // Filters on the name of the job. + JobName *string // Filters the list of jobs based on job status. Returns only jobs with the // specified status. JobStatus JobStatus - // Filters on the name of the job. - JobName *string + // Filters the list of jobs based on the time that the job was submitted for + // processing. Returns only jobs submitted after the specified time. Jobs are + // returned in descending order, newest to oldest. + SubmitTimeAfter *time.Time // Filters the list of jobs based on the time that the job was submitted for // processing. Returns only jobs submitted before the specified time. Jobs are @@ -441,36 +441,37 @@ type DominantLanguageDetectionJobFilter struct { // Provides information about a dominant language detection job. type DominantLanguageDetectionJobProperties struct { - // The current status of the dominant language detection job. If the status is - // FAILED, the Message field shows the reason for the failure. - JobStatus JobStatus - // The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your // input data. DataAccessRoleArn *string - // The time that the dominant language detection job was submitted for processing. - SubmitTime *time.Time + // The time that the dominant language detection job completed. + EndTime *time.Time + + // The input data configuration that you supplied when you created the dominant + // language detection job. + InputDataConfig *InputDataConfig // The identifier assigned to the dominant language detection job. JobId *string - // A description for the status of a job. - Message *string - - // Configuration parameters for a private Virtual Private Cloud (VPC) containing - // the resources you are using for your dominant language detection job. For more - // information, see Amazon VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). - VpcConfig *VpcConfig - // The name that you assigned to the dominant language detection job. JobName *string + // The current status of the dominant language detection job. If the status is + // FAILED, the Message field shows the reason for the failure. + JobStatus JobStatus + + // A description for the status of a job. + Message *string + // The output data configuration that you supplied when you created the dominant // language detection job. OutputDataConfig *OutputDataConfig + // The time that the dominant language detection job was submitted for processing. + SubmitTime *time.Time + // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to // encrypt data on the storage volume attached to the ML compute instance(s) that // process the analysis job. The VolumeKmsKeyId can be either of the following @@ -483,12 +484,11 @@ type DominantLanguageDetectionJobProperties struct { // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string - // The time that the dominant language detection job completed. - EndTime *time.Time - - // The input data configuration that you supplied when you created the dominant - // language detection job. - InputDataConfig *InputDataConfig + // Configuration parameters for a private Virtual Private Cloud (VPC) containing + // the resources you are using for your dominant language detection job. For more + // information, see Amazon VPC + // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + VpcConfig *VpcConfig } // The filter used to determine which endpoints are are returned. You can filter @@ -502,31 +502,37 @@ type EndpointFilter struct { // Specifies a date before which the returned endpoint or endpoints were created. CreationTimeBefore *time.Time + // The Amazon Resource Number (ARN) of the model to which the endpoint is attached. + ModelArn *string + // Specifies the status of the endpoint being returned. Possible values are: // Creating, Ready, Updating, Deleting, Failed. Status EndpointStatus - - // The Amazon Resource Number (ARN) of the model to which the endpoint is attached. - ModelArn *string } // Specifies information about the specified endpoint. type EndpointProperties struct { + // The creation date and time of the endpoint. + CreationTime *time.Time + + // The number of inference units currently used by the model using this endpoint. + CurrentInferenceUnits *int32 + // The desired number of inference units to be used by the model using this // endpoint. Each inference unit represents of a throughput of 100 characters per // second. DesiredInferenceUnits *int32 + // The Amazon Resource Number (ARN) of the endpoint. + EndpointArn *string + // The date and time that the endpoint was last modified. LastModifiedTime *time.Time // Specifies a reason for failure in cases of Failed status. Message *string - // The number of inference units currently used by the model using this endpoint. - CurrentInferenceUnits *int32 - // The Amazon Resource Number (ARN) of the model to which the endpoint is attached. ModelArn *string @@ -534,18 +540,15 @@ type EndpointProperties struct { // are asynchronous, so customers will need to wait for the endpoint to be Ready // status before making inference requests. Status EndpointStatus - - // The Amazon Resource Number (ARN) of the endpoint. - EndpointArn *string - - // The creation date and time of the endpoint. - CreationTime *time.Time } // Provides information for filtering a list of dominant language detection jobs. // For more information, see the operation. type EntitiesDetectionJobFilter struct { + // Filters on the name of the job. + JobName *string + // Filters the list of jobs based on job status. Returns only jobs with the // specified status. JobStatus JobStatus @@ -555,9 +558,6 @@ type EntitiesDetectionJobFilter struct { // returned in descending order, newest to oldest. SubmitTimeAfter *time.Time - // Filters on the name of the job. - JobName *string - // Filters the list of jobs based on the time that the job was submitted for // processing. Returns only jobs submitted before the specified time. Jobs are // returned in ascending order, oldest to newest. @@ -567,6 +567,26 @@ type EntitiesDetectionJobFilter struct { // Provides information about an entities detection job. type EntitiesDetectionJobProperties struct { + // The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your + // input data. + DataAccessRoleArn *string + + // The time that the entities detection job completed + EndTime *time.Time + + // The Amazon Resource Name (ARN) that identifies the entity recognizer. + EntityRecognizerArn *string + + // The input data configuration that you supplied when you created the entities + // detection job. + InputDataConfig *InputDataConfig + + // The identifier assigned to the entities detection job. + JobId *string + + // The name that you assigned the entities detection job. + JobName *string + // The current status of the entities detection job. If the status is FAILED, the // Message field shows the reason for the failure. JobStatus JobStatus @@ -574,35 +594,16 @@ type EntitiesDetectionJobProperties struct { // The language code of the input documents. LanguageCode LanguageCode - // The name that you assigned the entities detection job. - JobName *string + // A description of the status of a job. + Message *string // The output data configuration that you supplied when you created the entities // detection job. OutputDataConfig *OutputDataConfig - // The input data configuration that you supplied when you created the entities - // detection job. - InputDataConfig *InputDataConfig - // The time that the entities detection job was submitted for processing. SubmitTime *time.Time - // Configuration parameters for a private Virtual Private Cloud (VPC) containing - // the resources you are using for your entity detection job. For more information, - // see Amazon VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). - VpcConfig *VpcConfig - - // The time that the entities detection job completed - EndTime *time.Time - - // A description of the status of a job. - Message *string - - // The identifier assigned to the entities detection job. - JobId *string - // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to // encrypt data on the storage volume attached to the ML compute instance(s) that // process the analysis job. The VolumeKmsKeyId can be either of the following @@ -615,27 +616,16 @@ type EntitiesDetectionJobProperties struct { // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string - // The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your - // input data. - DataAccessRoleArn *string - - // The Amazon Resource Name (ARN) that identifies the entity recognizer. - EntityRecognizerArn *string + // Configuration parameters for a private Virtual Private Cloud (VPC) containing + // the resources you are using for your entity detection job. For more information, + // see Amazon VPC + // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + VpcConfig *VpcConfig } // Provides information about an entity. type Entity struct { - // The text of the entity. - Text *string - - // The level of confidence that Amazon Comprehend has in the accuracy of the - // detection. - Score *float32 - - // The entity's type. - Type EntityType - // A character offset in the input text that shows where the entity begins (the // first character is at position 0). The offset returns the position of each UTF-8 // code point in the string. A code point is the abstract character from a @@ -648,6 +638,16 @@ type Entity struct { // is the abstract character from a particular graphical representation. For // example, a multi-byte UTF-8 character maps to a single code point. EndOffset *int32 + + // The level of confidence that Amazon Comprehend has in the accuracy of the + // detection. + Score *float32 + + // The text of the entity. + Text *string + + // The entity's type. + Type EntityType } // Describes the annotations associated with a entity recognizer. @@ -690,14 +690,14 @@ type EntityRecognizerEvaluationMetrics struct { // average of the two scores. The highest score is 1, and the worst score is 0. F1Score *float64 - // A measure of how complete the recognizer results are for the test data. High - // recall means that the recognizer returned most of the relevant results. - Recall *float64 - // A measure of the usefulness of the recognizer results in the test data. High // precision means that the recognizer returned substantially more relevant results // than irrelevant ones. Precision *float64 + + // A measure of how complete the recognizer results are for the test data. High + // recall means that the recognizer returned most of the relevant results. + Recall *float64 } // Provides information for filtering a list of entity recognizers. You can only @@ -722,22 +722,22 @@ type EntityRecognizerFilter struct { // Specifies the format and location of the input data. type EntityRecognizerInputDataConfig struct { + // S3 location of the documents folder for an entity recognizer + // + // This member is required. + Documents *EntityRecognizerDocuments + // The entity types in the input data for an entity recognizer. A maximum of 12 // entity types can be used at one time to train an entity recognizer. // // This member is required. EntityTypes []*EntityTypesListItem - // S3 location of the entity list for an entity recognizer. - EntityList *EntityRecognizerEntityList - // S3 location of the annotations file for an entity recognizer. Annotations *EntityRecognizerAnnotations - // S3 location of the documents folder for an entity recognizer - // - // This member is required. - Documents *EntityRecognizerDocuments + // S3 location of the entity list for an entity recognizer. + EntityList *EntityRecognizerEntityList } // Detailed information about an entity recognizer. @@ -766,54 +766,52 @@ type EntityRecognizerMetadataEntityTypesListItem struct { // item on the list of entity types. EvaluationMetrics *EntityTypesEvaluationMetrics - // Type of entity from the list of entity types in the metadata of an entity - // recognizer. - Type *string - // Indicates the number of times the given entity type was seen in the training // data. NumberOfTrainMentions *int32 + + // Type of entity from the list of entity types in the metadata of an entity + // recognizer. + Type *string } // Describes information about an entity recognizer. type EntityRecognizerProperties struct { - // The time that the recognizer was submitted for processing. - SubmitTime *time.Time - - // Configuration parameters for a private Virtual Private Cloud (VPC) containing - // the resources you are using for your custom entity recognizer. For more - // information, see Amazon VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). - VpcConfig *VpcConfig + // The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role + // that grants Amazon Comprehend read access to your input data. + DataAccessRoleArn *string // The time that the recognizer creation completed. EndTime *time.Time + // The Amazon Resource Name (ARN) that identifies the entity recognizer. + EntityRecognizerArn *string + // The input data properties of an entity recognizer. InputDataConfig *EntityRecognizerInputDataConfig - // The time that training of the entity recognizer started. - TrainingStartTime *time.Time + // The language of the input documents. All documents must be in the same language. + // Only English ("en") is currently supported. + LanguageCode LanguageCode // A description of the status of the recognizer. Message *string - // The time that training of the entity recognizer was completed. - TrainingEndTime *time.Time + // Provides information about an entity recognizer. + RecognizerMetadata *EntityRecognizerMetadata // Provides the status of the entity recognizer. Status ModelStatus - // The Amazon Resource Name (ARN) that identifies the entity recognizer. - EntityRecognizerArn *string + // The time that the recognizer was submitted for processing. + SubmitTime *time.Time - // The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role - // that grants Amazon Comprehend read access to your input data. - DataAccessRoleArn *string + // The time that training of the entity recognizer was completed. + TrainingEndTime *time.Time - // Provides information about an entity recognizer. - RecognizerMetadata *EntityRecognizerMetadata + // The time that training of the entity recognizer started. + TrainingStartTime *time.Time // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to // encrypt data on the storage volume attached to the ML compute instance(s) that @@ -827,15 +825,23 @@ type EntityRecognizerProperties struct { // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string - // The language of the input documents. All documents must be in the same language. - // Only English ("en") is currently supported. - LanguageCode LanguageCode + // Configuration parameters for a private Virtual Private Cloud (VPC) containing + // the resources you are using for your custom entity recognizer. For more + // information, see Amazon VPC + // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + VpcConfig *VpcConfig } // Detailed information about the accuracy of an entity recognizer for a specific // entity type. type EntityTypesEvaluationMetrics struct { + // A measure of how accurate the recognizer results are for for a specific entity + // type in the test data. It is derived from the Precision and Recall values. The + // F1Score is the harmonic average of the two scores. The highest score is 1, and + // the worst score is 0. + F1Score *float64 + // A measure of the usefulness of the recognizer results for a specific entity type // in the test data. High precision means that the recognizer returned // substantially more relevant results than irrelevant ones. @@ -845,12 +851,6 @@ type EntityTypesEvaluationMetrics struct { // in the test data. High recall means that the recognizer returned most of the // relevant results. Recall *float64 - - // A measure of how accurate the recognizer results are for for a specific entity - // type in the test data. It is derived from the Precision and Recall values. The - // F1Score is the harmonic average of the two scores. The highest score is 1, and - // the worst score is 0. - F1Score *float64 } // Information about an individual item on a list of entity types. @@ -865,6 +865,16 @@ type EntityTypesListItem struct { // The input properties for a topic detection job. type InputDataConfig struct { + // The Amazon S3 URI for the input data. The URI must be in same region as the API + // endpoint that you are calling. The URI can point to a single input file or it + // can provide the prefix for a collection of data files. For example, if you use + // the URI S3://bucketName/prefix, if the prefix is a single file, Amazon + // Comprehend uses that file as input. If more than one file begins with the + // prefix, Amazon Comprehend uses all of them as input. + // + // This member is required. + S3Uri *string + // Specifies how the text in an input file should be processed: // // * @@ -876,30 +886,11 @@ type InputDataConfig struct { // separate document. Use this option when you are processing many short documents, // such as text messages. InputFormat InputFormat - - // The Amazon S3 URI for the input data. The URI must be in same region as the API - // endpoint that you are calling. The URI can point to a single input file or it - // can provide the prefix for a collection of data files. For example, if you use - // the URI S3://bucketName/prefix, if the prefix is a single file, Amazon - // Comprehend uses that file as input. If more than one file begins with the - // prefix, Amazon Comprehend uses all of them as input. - // - // This member is required. - S3Uri *string } // Describes a key noun phrase. type KeyPhrase struct { - // The text of a key noun phrase. - Text *string - - // A character offset in the input text where the key phrase ends. The offset - // returns the position of each UTF-8 code point in the string. A code point is the - // abstract character from a particular graphical representation. For example, a - // multi-byte UTF-8 character maps to a single code point. - EndOffset *int32 - // A character offset in the input text that shows where the key phrase begins (the // first character is at position 0). The offset returns the position of each UTF-8 // code point in the string. A code point is the abstract character from a @@ -907,20 +898,24 @@ type KeyPhrase struct { // maps to a single code point. BeginOffset *int32 + // A character offset in the input text where the key phrase ends. The offset + // returns the position of each UTF-8 code point in the string. A code point is the + // abstract character from a particular graphical representation. For example, a + // multi-byte UTF-8 character maps to a single code point. + EndOffset *int32 + // The level of confidence that Amazon Comprehend has in the accuracy of the // detection. Score *float32 + + // The text of a key noun phrase. + Text *string } // Provides information for filtering a list of dominant language detection jobs. // For more information, see the operation. type KeyPhrasesDetectionJobFilter struct { - // Filters the list of jobs based on the time that the job was submitted for - // processing. Returns only jobs submitted before the specified time. Jobs are - // returned in ascending order, oldest to newest. - SubmitTimeBefore *time.Time - // Filters on the name of the job. JobName *string @@ -932,35 +927,49 @@ type KeyPhrasesDetectionJobFilter struct { // processing. Returns only jobs submitted after the specified time. Jobs are // returned in descending order, newest to oldest. SubmitTimeAfter *time.Time + + // Filters the list of jobs based on the time that the job was submitted for + // processing. Returns only jobs submitted before the specified time. Jobs are + // returned in ascending order, oldest to newest. + SubmitTimeBefore *time.Time } // Provides information about a key phrases detection job. type KeyPhrasesDetectionJobProperties struct { - // The language code of the input documents. - LanguageCode LanguageCode + // The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your + // input data. + DataAccessRoleArn *string + + // The time that the key phrases detection job completed. + EndTime *time.Time + + // The input data configuration that you supplied when you created the key phrases + // detection job. + InputDataConfig *InputDataConfig // The identifier assigned to the key phrases detection job. JobId *string + // The name that you assigned the key phrases detection job. + JobName *string + // The current status of the key phrases detection job. If the status is FAILED, // the Message field shows the reason for the failure. JobStatus JobStatus - // The time that the key phrases detection job completed. - EndTime *time.Time + // The language code of the input documents. + LanguageCode LanguageCode - // The input data configuration that you supplied when you created the key phrases - // detection job. - InputDataConfig *InputDataConfig + // A description of the status of a job. + Message *string // The output data configuration that you supplied when you created the key phrases // detection job. OutputDataConfig *OutputDataConfig - // The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your - // input data. - DataAccessRoleArn *string + // The time that the key phrases detection job was submitted for processing. + SubmitTime *time.Time // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to // encrypt data on the storage volume attached to the ML compute instance(s) that @@ -974,15 +983,6 @@ type KeyPhrasesDetectionJobProperties struct { // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string - // The name that you assigned the key phrases detection job. - JobName *string - - // A description of the status of a job. - Message *string - - // The time that the key phrases detection job was submitted for processing. - SubmitTime *time.Time - // Configuration parameters for a private Virtual Private Cloud (VPC) containing // the resources you are using for your key phrases detection job. For more // information, see Amazon VPC @@ -1029,18 +1029,21 @@ type OutputDataConfig struct { // see how-syntax (). type PartOfSpeechTag struct { - // Identifies the part of speech that the token represents. - Tag PartOfSpeechTagType - // The confidence that Amazon Comprehend has that the part of speech was correctly // identified. Score *float32 + + // Identifies the part of speech that the token represents. + Tag PartOfSpeechTagType } // Provides information for filtering a list of dominant language detection jobs. // For more information, see the operation. type SentimentDetectionJobFilter struct { + // Filters on the name of the job. + JobName *string + // Filters the list of jobs based on job status. Returns only jobs with the // specified status. JobStatus JobStatus @@ -1054,54 +1057,45 @@ type SentimentDetectionJobFilter struct { // processing. Returns only jobs submitted before the specified time. Jobs are // returned in ascending order, oldest to newest. SubmitTimeBefore *time.Time - - // Filters on the name of the job. - JobName *string } // Provides information about a sentiment detection job. type SentimentDetectionJobProperties struct { - // The identifier assigned to the sentiment detection job. - JobId *string + // The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your + // input data. + DataAccessRoleArn *string - // A description of the status of a job. - Message *string + // The time that the sentiment detection job ended. + EndTime *time.Time - // The output data configuration that you supplied when you created the sentiment + // The input data configuration that you supplied when you created the sentiment // detection job. - OutputDataConfig *OutputDataConfig + InputDataConfig *InputDataConfig + + // The identifier assigned to the sentiment detection job. + JobId *string // The name that you assigned to the sentiment detection job JobName *string - // Configuration parameters for a private Virtual Private Cloud (VPC) containing - // the resources you are using for your sentiment detection job. For more - // information, see Amazon VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). - VpcConfig *VpcConfig + // The current status of the sentiment detection job. If the status is FAILED, the + // Messages field shows the reason for the failure. + JobStatus JobStatus // The language code of the input documents. LanguageCode LanguageCode - // The input data configuration that you supplied when you created the sentiment + // A description of the status of a job. + Message *string + + // The output data configuration that you supplied when you created the sentiment // detection job. - InputDataConfig *InputDataConfig + OutputDataConfig *OutputDataConfig // The time that the sentiment detection job was submitted for processing. SubmitTime *time.Time - // The time that the sentiment detection job ended. - EndTime *time.Time - - // The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your - // input data. - DataAccessRoleArn *string - - // The current status of the sentiment detection job. If the status is FAILED, the - // Messages field shows the reason for the failure. - JobStatus JobStatus - // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to // encrypt data on the storage volume attached to the ML compute instance(s) that // process the analysis job. The VolumeKmsKeyId can be either of the following @@ -1113,36 +1107,39 @@ type SentimentDetectionJobProperties struct { // Resource Name (ARN) of a KMS Key: // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string + + // Configuration parameters for a private Virtual Private Cloud (VPC) containing + // the resources you are using for your sentiment detection job. For more + // information, see Amazon VPC + // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + VpcConfig *VpcConfig } // Describes the level of confidence that Amazon Comprehend has in the accuracy of // its detection of sentiments. type SentimentScore struct { - // The level of confidence that Amazon Comprehend has in the accuracy of its - // detection of the NEGATIVE sentiment. - Negative *float32 - - // The level of confidence that Amazon Comprehend has in the accuracy of its - // detection of the POSITIVE sentiment. - Positive *float32 - // The level of confidence that Amazon Comprehend has in the accuracy of its // detection of the MIXED sentiment. Mixed *float32 + // The level of confidence that Amazon Comprehend has in the accuracy of its + // detection of the NEGATIVE sentiment. + Negative *float32 + // The level of confidence that Amazon Comprehend has in the accuracy of its // detection of the NEUTRAL sentiment. Neutral *float32 + + // The level of confidence that Amazon Comprehend has in the accuracy of its + // detection of the POSITIVE sentiment. + Positive *float32 } // Represents a work in the input text that was recognized and assigned a part of // speech. There is one syntax token record for each word in the source text. type SyntaxToken struct { - // A unique identifier for a token. - TokenId *int32 - // The zero-based offset from the beginning of the source text to the first // character in the word. BeginOffset *int32 @@ -1151,13 +1148,16 @@ type SyntaxToken struct { // character in the word. EndOffset *int32 - // The word that was recognized in the source text. - Text *string - // Provides the part of speech label and the confidence level that Amazon // Comprehend has that the part of speech was correctly identified. For more // information, see how-syntax (). PartOfSpeech *PartOfSpeechTag + + // The word that was recognized in the source text. + Text *string + + // A unique identifier for a token. + TokenId *int32 } // A key-value pair that adds as a metadata to a resource used by Amazon @@ -1165,12 +1165,6 @@ type SyntaxToken struct { // might be added to a resource to indicate its use by a particular department. type Tag struct { - // The second part of a key-value pair that forms a tag associated with a given - // resource. For instance, if you want to show which resources are used by which - // departments, you might use “Department” as the initial (key) portion of the - // pair, with a value of “sales” to indicate the sales department. - Value *string - // The initial part of a key-value pair that forms a tag associated with a given // resource. For instance, if you want to show which resources are used by which // departments, you might use “Department” as the key portion of the pair, with @@ -1178,12 +1172,21 @@ type Tag struct { // // This member is required. Key *string + + // The second part of a key-value pair that forms a tag associated with a given + // resource. For instance, if you want to show which resources are used by which + // departments, you might use “Department” as the initial (key) portion of the + // pair, with a value of “sales” to indicate the sales department. + Value *string } // Provides information for filtering topic detection jobs. For more information, // see . type TopicsDetectionJobFilter struct { + // + JobName *string + // Filters the list of topic detection jobs based on job status. Returns only jobs // with the specified status. JobStatus JobStatus @@ -1197,17 +1200,41 @@ type TopicsDetectionJobFilter struct { // processing. Only returns jobs submitted before the specified time. Jobs are // returned in descending order, newest to oldest. SubmitTimeBefore *time.Time - - // - JobName *string } // Provides information about a topic detection job. type TopicsDetectionJobProperties struct { + // The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role + // that grants Amazon Comprehend read access to your job data. + DataAccessRoleArn *string + + // The time that the topic detection job was completed. + EndTime *time.Time + + // The input data configuration supplied when you created the topic detection job. + InputDataConfig *InputDataConfig + + // The identifier assigned to the topic detection job. + JobId *string + + // The name of the topic detection job. + JobName *string + + // The current status of the topic detection job. If the status is Failed, the + // reason for the failure is shown in the Message field. + JobStatus JobStatus + // A description for the status of a job. Message *string + // The number of topics to detect supplied when you created the topic detection + // job. The default is 10. + NumberOfTopics *int32 + + // The output data configuration supplied when you created the topic detection job. + OutputDataConfig *OutputDataConfig + // The time that the topic detection job was submitted for processing. SubmitTime *time.Time @@ -1223,33 +1250,6 @@ type TopicsDetectionJobProperties struct { // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string - // The current status of the topic detection job. If the status is Failed, the - // reason for the failure is shown in the Message field. - JobStatus JobStatus - - // The identifier assigned to the topic detection job. - JobId *string - - // The input data configuration supplied when you created the topic detection job. - InputDataConfig *InputDataConfig - - // The number of topics to detect supplied when you created the topic detection - // job. The default is 10. - NumberOfTopics *int32 - - // The time that the topic detection job was completed. - EndTime *time.Time - - // The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role - // that grants Amazon Comprehend read access to your job data. - DataAccessRoleArn *string - - // The output data configuration supplied when you created the topic detection job. - OutputDataConfig *OutputDataConfig - - // The name of the topic detection job. - JobName *string - // Configuration parameters for a private Virtual Private Cloud (VPC) containing // the resources you are using for your topic detection job. For more information, // see Amazon VPC @@ -1263,15 +1263,6 @@ type TopicsDetectionJobProperties struct { // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). type VpcConfig struct { - // The ID for each subnet being used in your private VPC. This subnet is a subset - // of the a range of IPv4 addresses used by the VPC and is specific to a given - // availability zone in the VPC’s region. This ID number is preceded by "subnet-", - // for instance: "subnet-04ccf456919e69055". For more information, see VPCs and - // Subnets (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html). - // - // This member is required. - Subnets []*string - // The ID number for a security group on an instance of your private VPC. Security // groups on your VPC function serve as a virtual firewall to control inbound and // outbound traffic and provides security for the resources that you’ll be @@ -1281,4 +1272,13 @@ type VpcConfig struct { // // This member is required. SecurityGroupIds []*string + + // The ID for each subnet being used in your private VPC. This subnet is a subset + // of the a range of IPv4 addresses used by the VPC and is specific to a given + // availability zone in the VPC’s region. This ID number is preceded by "subnet-", + // for instance: "subnet-04ccf456919e69055". For more information, see VPCs and + // Subnets (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html). + // + // This member is required. + Subnets []*string } diff --git a/service/comprehendmedical/api_op_DetectEntities.go b/service/comprehendmedical/api_op_DetectEntities.go index 1ee2f6d6bc8..a04776a34d9 100644 --- a/service/comprehendmedical/api_op_DetectEntities.go +++ b/service/comprehendmedical/api_op_DetectEntities.go @@ -69,6 +69,15 @@ type DetectEntitiesInput struct { type DetectEntitiesOutput struct { + // The collection of medical entities extracted from the input text and their + // associated information. For each entity, the response provides the entity text, + // the entity category, where the entity text begins and ends, and the level of + // confidence that Amazon Comprehend Medical has in the detection and analysis. + // Attributes and traits of the entity are also returned. + // + // This member is required. + Entities []*types.Entity + // The version of the model used to analyze the documents. The version number looks // like X.X.X. You can use this information to track the model used for a // particular batch of documents. @@ -80,15 +89,6 @@ type DetectEntitiesOutput struct { // the PaginationToken to fetch the next page of entities. PaginationToken *string - // The collection of medical entities extracted from the input text and their - // associated information. For each entity, the response provides the entity text, - // the entity category, where the entity text begins and ends, and the level of - // confidence that Amazon Comprehend Medical has in the detection and analysis. - // Attributes and traits of the entity are also returned. - // - // This member is required. - Entities []*types.Entity - // Attributes extracted from the input text that we were unable to relate to an // entity. UnmappedAttributes []*types.UnmappedAttribute diff --git a/service/comprehendmedical/api_op_DetectEntitiesV2.go b/service/comprehendmedical/api_op_DetectEntitiesV2.go index bae999d98d9..e8502c55656 100644 --- a/service/comprehendmedical/api_op_DetectEntitiesV2.go +++ b/service/comprehendmedical/api_op_DetectEntitiesV2.go @@ -74,13 +74,6 @@ type DetectEntitiesV2Input struct { type DetectEntitiesV2Output struct { - // Attributes extracted from the input text that couldn't be related to an entity. - UnmappedAttributes []*types.UnmappedAttribute - - // If the result to the DetectEntitiesV2 operation was truncated, include the - // PaginationToken to fetch the next page of entities. - PaginationToken *string - // The collection of medical entities extracted from the input text and their // associated information. For each entity, the response provides the entity text, // the entity category, where the entity text begins and ends, and the level of @@ -97,6 +90,13 @@ type DetectEntitiesV2Output struct { // This member is required. ModelVersion *string + // If the result to the DetectEntitiesV2 operation was truncated, include the + // PaginationToken to fetch the next page of entities. + PaginationToken *string + + // Attributes extracted from the input text that couldn't be related to an entity. + UnmappedAttributes []*types.UnmappedAttribute + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/comprehendmedical/api_op_DetectPHI.go b/service/comprehendmedical/api_op_DetectPHI.go index 26ec972ba43..338060e4afd 100644 --- a/service/comprehendmedical/api_op_DetectPHI.go +++ b/service/comprehendmedical/api_op_DetectPHI.go @@ -76,10 +76,6 @@ type DetectPHIOutput struct { // This member is required. Entities []*types.Entity - // If the result of the previous request to DetectPHI was truncated, include the - // PaginationToken to fetch the next page of PHI entities. - PaginationToken *string - // The version of the model used to analyze the documents. The version number looks // like X.X.X. You can use this information to track the model used for a // particular batch of documents. @@ -87,6 +83,10 @@ type DetectPHIOutput struct { // This member is required. ModelVersion *string + // If the result of the previous request to DetectPHI was truncated, include the + // PaginationToken to fetch the next page of PHI entities. + PaginationToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/comprehendmedical/api_op_ListEntitiesDetectionV2Jobs.go b/service/comprehendmedical/api_op_ListEntitiesDetectionV2Jobs.go index 96525fe236a..23a2c9ae37a 100644 --- a/service/comprehendmedical/api_op_ListEntitiesDetectionV2Jobs.go +++ b/service/comprehendmedical/api_op_ListEntitiesDetectionV2Jobs.go @@ -61,11 +61,11 @@ type ListEntitiesDetectionV2JobsInput struct { // filter at a time. Filter *types.ComprehendMedicalAsyncJobFilter - // Identifies the next page of results to return. - NextToken *string - // The maximum number of results to return in each page. The default is 100. MaxResults *int32 + + // Identifies the next page of results to return. + NextToken *string } type ListEntitiesDetectionV2JobsOutput struct { diff --git a/service/comprehendmedical/api_op_ListPHIDetectionJobs.go b/service/comprehendmedical/api_op_ListPHIDetectionJobs.go index 59091cde4f2..e3a670a0601 100644 --- a/service/comprehendmedical/api_op_ListPHIDetectionJobs.go +++ b/service/comprehendmedical/api_op_ListPHIDetectionJobs.go @@ -71,12 +71,12 @@ type ListPHIDetectionJobsInput struct { type ListPHIDetectionJobsOutput struct { - // Identifies the next page of results to return. - NextToken *string - // A list containing the properties of each job returned. ComprehendMedicalAsyncJobPropertiesList []*types.ComprehendMedicalAsyncJobProperties + // Identifies the next page of results to return. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/comprehendmedical/api_op_ListRxNormInferenceJobs.go b/service/comprehendmedical/api_op_ListRxNormInferenceJobs.go index 10c2674d586..eb34a3bc154 100644 --- a/service/comprehendmedical/api_op_ListRxNormInferenceJobs.go +++ b/service/comprehendmedical/api_op_ListRxNormInferenceJobs.go @@ -70,12 +70,12 @@ type ListRxNormInferenceJobsInput struct { type ListRxNormInferenceJobsOutput struct { - // Identifies the next page of results to return. - NextToken *string - // The maximum number of results to return in each page. The default is 100. ComprehendMedicalAsyncJobPropertiesList []*types.ComprehendMedicalAsyncJobProperties + // Identifies the next page of results to return. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/comprehendmedical/api_op_StartEntitiesDetectionV2Job.go b/service/comprehendmedical/api_op_StartEntitiesDetectionV2Job.go index dd821970991..6b8cce513fa 100644 --- a/service/comprehendmedical/api_op_StartEntitiesDetectionV2Job.go +++ b/service/comprehendmedical/api_op_StartEntitiesDetectionV2Job.go @@ -61,27 +61,6 @@ func (c *Client) StartEntitiesDetectionV2Job(ctx context.Context, params *StartE type StartEntitiesDetectionV2JobInput struct { - // The identifier of the job. - JobName *string - - // The language of the input documents. All documents must be in the same language. - // - // This member is required. - LanguageCode types.LanguageCode - - // A unique identifier for the request. If you don't set the client request token, - // Amazon Comprehend Medical generates one. - ClientRequestToken *string - - // An AWS Key Management Service key to encrypt your output files. If you do not - // specify a key, the files are written in plain text. - KMSKey *string - - // Specifies where to send the output files. - // - // This member is required. - OutputDataConfig *types.OutputDataConfig - // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) // role that grants Amazon Comprehend Medical read access to your input data. For // more information, see Role-Based Permissions Required for Asynchronous @@ -95,6 +74,27 @@ type StartEntitiesDetectionV2JobInput struct { // // This member is required. InputDataConfig *types.InputDataConfig + + // The language of the input documents. All documents must be in the same language. + // + // This member is required. + LanguageCode types.LanguageCode + + // Specifies where to send the output files. + // + // This member is required. + OutputDataConfig *types.OutputDataConfig + + // A unique identifier for the request. If you don't set the client request token, + // Amazon Comprehend Medical generates one. + ClientRequestToken *string + + // The identifier of the job. + JobName *string + + // An AWS Key Management Service key to encrypt your output files. If you do not + // specify a key, the files are written in plain text. + KMSKey *string } type StartEntitiesDetectionV2JobOutput struct { diff --git a/service/comprehendmedical/api_op_StartICD10CMInferenceJob.go b/service/comprehendmedical/api_op_StartICD10CMInferenceJob.go index 7086ea76265..2d6d97a2735 100644 --- a/service/comprehendmedical/api_op_StartICD10CMInferenceJob.go +++ b/service/comprehendmedical/api_op_StartICD10CMInferenceJob.go @@ -61,40 +61,40 @@ func (c *Client) StartICD10CMInferenceJob(ctx context.Context, params *StartICD1 type StartICD10CMInferenceJobInput struct { - // Specifies where to send the output files. + // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) + // role that grants Amazon Comprehend Medical read access to your input data. For + // more information, see Role-Based Permissions Required for Asynchronous + // Operations + // (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med). // // This member is required. - OutputDataConfig *types.OutputDataConfig + DataAccessRoleArn *string - // The identifier of the job. - JobName *string + // Specifies the format and location of the input data for the job. + // + // This member is required. + InputDataConfig *types.InputDataConfig // The language of the input documents. All documents must be in the same language. // // This member is required. LanguageCode types.LanguageCode + // Specifies where to send the output files. + // + // This member is required. + OutputDataConfig *types.OutputDataConfig + // A unique identifier for the request. If you don't set the client request token, // Amazon Comprehend Medical generates one. ClientRequestToken *string - // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) - // role that grants Amazon Comprehend Medical read access to your input data. For - // more information, see Role-Based Permissions Required for Asynchronous - // Operations - // (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med). - // - // This member is required. - DataAccessRoleArn *string + // The identifier of the job. + JobName *string // An AWS Key Management Service key to encrypt your output files. If you do not // specify a key, the files are written in plain text. KMSKey *string - - // Specifies the format and location of the input data for the job. - // - // This member is required. - InputDataConfig *types.InputDataConfig } type StartICD10CMInferenceJobOutput struct { diff --git a/service/comprehendmedical/api_op_StartPHIDetectionJob.go b/service/comprehendmedical/api_op_StartPHIDetectionJob.go index 05d3edad9ad..63ba80f0983 100644 --- a/service/comprehendmedical/api_op_StartPHIDetectionJob.go +++ b/service/comprehendmedical/api_op_StartPHIDetectionJob.go @@ -69,25 +69,25 @@ type StartPHIDetectionJobInput struct { // This member is required. DataAccessRoleArn *string - // The language of the input documents. All documents must be in the same language. + // Specifies the format and location of the input data for the job. // // This member is required. - LanguageCode types.LanguageCode - - // A unique identifier for the request. If you don't set the client request token, - // Amazon Comprehend Medical generates one. - ClientRequestToken *string + InputDataConfig *types.InputDataConfig - // Specifies the format and location of the input data for the job. + // The language of the input documents. All documents must be in the same language. // // This member is required. - InputDataConfig *types.InputDataConfig + LanguageCode types.LanguageCode // Specifies where to send the output files. // // This member is required. OutputDataConfig *types.OutputDataConfig + // A unique identifier for the request. If you don't set the client request token, + // Amazon Comprehend Medical generates one. + ClientRequestToken *string + // The identifier of the job. JobName *string diff --git a/service/comprehendmedical/api_op_StartRxNormInferenceJob.go b/service/comprehendmedical/api_op_StartRxNormInferenceJob.go index 245240d42d9..18c60815201 100644 --- a/service/comprehendmedical/api_op_StartRxNormInferenceJob.go +++ b/service/comprehendmedical/api_op_StartRxNormInferenceJob.go @@ -61,20 +61,6 @@ func (c *Client) StartRxNormInferenceJob(ctx context.Context, params *StartRxNor type StartRxNormInferenceJobInput struct { - // Specifies where to send the output files. - // - // This member is required. - OutputDataConfig *types.OutputDataConfig - - // Specifies the format and location of the input data for the job. - // - // This member is required. - InputDataConfig *types.InputDataConfig - - // An AWS Key Management Service key to encrypt your output files. If you do not - // specify a key, the files are written in plain text. - KMSKey *string - // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) // role that grants Amazon Comprehend Medical read access to your input data. For // more information, see Role-Based Permissions Required for Asynchronous @@ -84,17 +70,31 @@ type StartRxNormInferenceJobInput struct { // This member is required. DataAccessRoleArn *string + // Specifies the format and location of the input data for the job. + // + // This member is required. + InputDataConfig *types.InputDataConfig + // The language of the input documents. All documents must be in the same language. // // This member is required. LanguageCode types.LanguageCode + // Specifies where to send the output files. + // + // This member is required. + OutputDataConfig *types.OutputDataConfig + // A unique identifier for the request. If you don't set the client request token, // Amazon Comprehend Medical generates one. ClientRequestToken *string // The identifier of the job. JobName *string + + // An AWS Key Management Service key to encrypt your output files. If you do not + // specify a key, the files are written in plain text. + KMSKey *string } type StartRxNormInferenceJobOutput struct { diff --git a/service/comprehendmedical/go.mod b/service/comprehendmedical/go.mod index 61798ce8db0..0dd49913c06 100644 --- a/service/comprehendmedical/go.mod +++ b/service/comprehendmedical/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/comprehendmedical go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/comprehendmedical/types/types.go b/service/comprehendmedical/types/types.go index 94d225cc589..c05835beb9f 100644 --- a/service/comprehendmedical/types/types.go +++ b/service/comprehendmedical/types/types.go @@ -12,17 +12,13 @@ import ( // input text, and the segment of the input text. type Attribute struct { - // The level of confidence that Amazon Comprehend Medical has that the segment of - // text is correctly recognized as an attribute. - Score *float32 + // The 0-based character offset in the input text that shows where the attribute + // begins. The offset returns the UTF-8 code point in the string. + BeginOffset *int32 // The category of attribute. Category EntityType - // The level of confidence that Amazon Comprehend Medical has that this attribute - // is correctly related to this entity. - RelationshipScore *float32 - // The 0-based character offset in the input text that shows where the attribute // ends. The offset returns the UTF-8 code point in the string. EndOffset *int32 @@ -31,21 +27,25 @@ type Attribute struct { // unique within this response rather than a global unique identifier. Id *int32 - // The 0-based character offset in the input text that shows where the attribute - // begins. The offset returns the UTF-8 code point in the string. - BeginOffset *int32 - - // Contextual information for this attribute. - Traits []*Trait + // The level of confidence that Amazon Comprehend Medical has that this attribute + // is correctly related to this entity. + RelationshipScore *float32 // The type of relationship between the entity and attribute. Type for the // relationship is OVERLAP, indicating that the entity occurred at the same time as // the Date_Expression. RelationshipType RelationshipType + // The level of confidence that Amazon Comprehend Medical has that the segment of + // text is correctly recognized as an attribute. + Score *float32 + // The segment of input text extracted as this attribute. Text *string + // Contextual information for this attribute. + Traits []*Trait + // The type of attribute. Type EntitySubType } @@ -53,6 +53,13 @@ type Attribute struct { // Provides information for filtering a list of detection jobs. type ComprehendMedicalAsyncJobFilter struct { + // Filters on the name of the job. + JobName *string + + // Filters the list of jobs based on job status. Returns only jobs with the + // specified status. + JobStatus JobStatus + // Filters the list of jobs based on the time that the job was submitted for // processing. Returns only jobs submitted after the specified time. Jobs are // returned in descending order, newest to oldest. @@ -62,103 +69,96 @@ type ComprehendMedicalAsyncJobFilter struct { // processing. Returns only jobs submitted before the specified time. Jobs are // returned in ascending order, oldest to newest. SubmitTimeBefore *time.Time - - // Filters on the name of the job. - JobName *string - - // Filters the list of jobs based on job status. Returns only jobs with the - // specified status. - JobStatus JobStatus } // Provides information about a detection job. type ComprehendMedicalAsyncJobProperties struct { - // The path to the file that describes the results of a batch job. - ManifestFilePath *string - - // The input data configuration that you supplied when you created the detection - // job. - InputDataConfig *InputDataConfig - - // The version of the model used to analyze the documents. The version number looks - // like X.X.X. You can use this information to track the model used for a - // particular batch of documents. - ModelVersion *string - - // The output data configuration that you supplied when you created the detection - // job. - OutputDataConfig *OutputDataConfig + // The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access + // to your input data. + DataAccessRoleArn *string // The time that the detection job completed. EndTime *time.Time - // The name that you assigned to the detection job. - JobName *string - - // A description of the status of a job. - Message *string - - // The time that the detection job was submitted for processing. - SubmitTime *time.Time - // The date and time that job metadata is deleted from the server. Output files in // your S3 bucket will not be deleted. After the metadata is deleted, the job will // no longer appear in the results of the ListEntitiesDetectionV2Job or the // ListPHIDetectionJobs operation. ExpirationTime *time.Time - // The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access - // to your input data. - DataAccessRoleArn *string + // The input data configuration that you supplied when you created the detection + // job. + InputDataConfig *InputDataConfig - // The AWS Key Management Service key, if any, used to encrypt the output files. - KMSKey *string + // The identifier assigned to the detection job. + JobId *string + + // The name that you assigned to the detection job. + JobName *string // The current status of the detection job. If the status is FAILED, the Message // field shows the reason for the failure. JobStatus JobStatus + // The AWS Key Management Service key, if any, used to encrypt the output files. + KMSKey *string + // The language code of the input documents. LanguageCode LanguageCode - // The identifier assigned to the detection job. - JobId *string + // The path to the file that describes the results of a batch job. + ManifestFilePath *string + + // A description of the status of a job. + Message *string + + // The version of the model used to analyze the documents. The version number looks + // like X.X.X. You can use this information to track the model used for a + // particular batch of documents. + ModelVersion *string + + // The output data configuration that you supplied when you created the detection + // job. + OutputDataConfig *OutputDataConfig + + // The time that the detection job was submitted for processing. + SubmitTime *time.Time } // Provides information about an extracted medical entity. type Entity struct { - // The segment of input text extracted as this entity. - Text *string - - // The 0-based character offset in the input text that shows where the entity ends. - // The offset returns the UTF-8 code point in the string. - EndOffset *int32 - // The extracted attributes that relate to this entity. Attributes []*Attribute - // The category of the entity. - Category EntityType - // The 0-based character offset in the input text that shows where the entity // begins. The offset returns the UTF-8 code point in the string. BeginOffset *int32 + // The category of the entity. + Category EntityType + + // The 0-based character offset in the input text that shows where the entity ends. + // The offset returns the UTF-8 code point in the string. + EndOffset *int32 + // The numeric identifier for the entity. This is a monotonically increasing id // unique within this response rather than a global unique identifier. Id *int32 - // Describes the specific type of entity with category of entities. - Type EntitySubType - // The level of confidence that Amazon Comprehend Medical has in the accuracy of // the detection. Score *float32 + // The segment of input text extracted as this entity. + Text *string + // Contextual information for the entity. Traits []*Trait + + // Describes the specific type of entity with category of entities. + Type EntitySubType } // The detected attributes that relate to an entity. This includes an extracted @@ -167,16 +167,9 @@ type Entity struct { // Organ or Site, and Acuity. type ICD10CMAttribute struct { - // The level of confidence that Amazon Comprehend Medical has that this attribute - // is correctly related to this entity. - RelationshipScore *float32 - - // The type of attribute. InferICD10CM detects entities of the type DX_NAME. - Type ICD10CMAttributeType - - // The level of confidence that Amazon Comprehend Medical has that the segment of - // text is correctly recognized as an attribute. - Score *float32 + // The 0-based character offset in the input text that shows where the attribute + // begins. The offset returns the UTF-8 code point in the string. + BeginOffset *int32 // The 0-based character offset in the input text that shows where the attribute // ends. The offset returns the UTF-8 code point in the string. @@ -186,32 +179,39 @@ type ICD10CMAttribute struct { // unique within this response rather than a global unique identifier. Id *int32 - // The contextual information for the attribute. The traits recognized by - // InferICD10CM are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION. - Traits []*ICD10CMTrait + // The level of confidence that Amazon Comprehend Medical has that this attribute + // is correctly related to this entity. + RelationshipScore *float32 - // The 0-based character offset in the input text that shows where the attribute - // begins. The offset returns the UTF-8 code point in the string. - BeginOffset *int32 + // The level of confidence that Amazon Comprehend Medical has that the segment of + // text is correctly recognized as an attribute. + Score *float32 // The segment of input text which contains the detected attribute. Text *string + + // The contextual information for the attribute. The traits recognized by + // InferICD10CM are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION. + Traits []*ICD10CMTrait + + // The type of attribute. InferICD10CM detects entities of the type DX_NAME. + Type ICD10CMAttributeType } // The ICD-10-CM concepts that the entity could refer to, along with a score // indicating the likelihood of the match. type ICD10CMConcept struct { - // The level of confidence that Amazon Comprehend Medical has that the entity is - // accurately linked to an ICD-10-CM concept. - Score *float32 + // The ICD-10-CM code that identifies the concept found in the knowledge base from + // the Centers for Disease Control. + Code *string // The long description of the ICD-10-CM code in the ontology. Description *string - // The ICD-10-CM code that identifies the concept found in the knowledge base from - // the Centers for Disease Control. - Code *string + // The level of confidence that Amazon Comprehend Medical has that the entity is + // accurately linked to an ICD-10-CM concept. + Score *float32 } // The collection of medical entities extracted from the input text and their @@ -226,6 +226,18 @@ type ICD10CMEntity struct { // as the nature of a medical condition. Attributes []*ICD10CMAttribute + // The 0-based character offset in the input text that shows where the entity + // begins. The offset returns the UTF-8 code point in the string. + BeginOffset *int32 + + // The category of the entity. InferICD10CM detects entities in the + // MEDICAL_CONDITION category. + Category ICD10CMEntityCategory + + // The 0-based character offset in the input text that shows where the entity ends. + // The offset returns the UTF-8 code point in the string. + EndOffset *int32 + // The ICD-10-CM concepts that the entity could refer to, along with a score // indicating the likelihood of the match. ICD10CMConcepts []*ICD10CMConcept @@ -234,32 +246,20 @@ type ICD10CMEntity struct { // unique within this response rather than a global unique identifier. Id *int32 + // The level of confidence that Amazon Comprehend Medical has in the accuracy of + // the detection. + Score *float32 + + // The segment of input text that is matched to the detected entity. + Text *string + // Provides Contextual information for the entity. The traits recognized by // InferICD10CM are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION. Traits []*ICD10CMTrait - // The 0-based character offset in the input text that shows where the entity ends. - // The offset returns the UTF-8 code point in the string. - EndOffset *int32 - - // The 0-based character offset in the input text that shows where the entity - // begins. The offset returns the UTF-8 code point in the string. - BeginOffset *int32 - // Describes the specific type of entity with category of entities. InferICD10CM // detects entities of the type DX_NAME. Type ICD10CMEntityType - - // The level of confidence that Amazon Comprehend Medical has in the accuracy of - // the detection. - Score *float32 - - // The category of the entity. InferICD10CM detects entities in the - // MEDICAL_CONDITION category. - Category ICD10CMEntityCategory - - // The segment of input text that is matched to the detected entity. - Text *string } // Contextual information for the entity. The traits recognized by InferICD10CM are @@ -294,11 +294,6 @@ type InputDataConfig struct { // The output properties for a detection job. type OutputDataConfig struct { - // The path to the output data files in the S3 bucket. Amazon Comprehend Medical - // creates an output directory using the job ID so that the output from one job - // does not overwrite the output of another. - S3Key *string - // When you use the OutputDataConfig object with asynchronous operations, you // specify the Amazon S3 location where you want to write the output data. The URI // must be in the same region as the API endpoint that you are calling. The @@ -306,58 +301,63 @@ type OutputDataConfig struct { // // This member is required. S3Bucket *string + + // The path to the output data files in the S3 bucket. Amazon Comprehend Medical + // creates an output directory using the job ID so that the output from one job + // does not overwrite the output of another. + S3Key *string } // The extracted attributes that relate to this entity. The attributes recognized // by InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE. type RxNormAttribute struct { - // The level of confidence that Comprehend Medical has that the segment of text is - // correctly recognized as an attribute. - Score *float32 - - // The level of confidence that Amazon Comprehend Medical has that the attribute is - // accurately linked to an entity. - RelationshipScore *float32 - // The 0-based character offset in the input text that shows where the attribute // begins. The offset returns the UTF-8 code point in the string. BeginOffset *int32 - // The type of attribute. The types of attributes recognized by InferRxNorm are - // BRAND_NAME and GENERIC_NAME. - Type RxNormAttributeType - // The 0-based character offset in the input text that shows where the attribute // ends. The offset returns the UTF-8 code point in the string. EndOffset *int32 - // Contextual information for the attribute. InferRxNorm recognizes the trait - // NEGATION for attributes, i.e. that the patient is not taking a specific dose or - // form of a medication. - Traits []*RxNormTrait - // The numeric identifier for this attribute. This is a monotonically increasing id // unique within this response rather than a global unique identifier. Id *int32 + // The level of confidence that Amazon Comprehend Medical has that the attribute is + // accurately linked to an entity. + RelationshipScore *float32 + + // The level of confidence that Comprehend Medical has that the segment of text is + // correctly recognized as an attribute. + Score *float32 + // The segment of input text which corresponds to the detected attribute. Text *string + + // Contextual information for the attribute. InferRxNorm recognizes the trait + // NEGATION for attributes, i.e. that the patient is not taking a specific dose or + // form of a medication. + Traits []*RxNormTrait + + // The type of attribute. The types of attributes recognized by InferRxNorm are + // BRAND_NAME and GENERIC_NAME. + Type RxNormAttributeType } // The RxNorm concept that the entity could refer to, along with a score indicating // the likelihood of the match. type RxNormConcept struct { - // The level of confidence that Amazon Comprehend Medical has that the entity is - // accurately linked to the reported RxNorm concept. - Score *float32 + // RxNorm concept ID, also known as the RxCUI. + Code *string // The description of the RxNorm concept. Description *string - // RxNorm concept ID, also known as the RxCUI. - Code *string + // The level of confidence that Amazon Comprehend Medical has that the entity is + // accurately linked to the reported RxNorm concept. + Score *float32 } // The collection of medical entities extracted from the input text and their @@ -367,40 +367,40 @@ type RxNormConcept struct { // Attributes and traits of the entity are also returned. type RxNormEntity struct { - // The 0-based character offset in the input text that shows where the entity ends. - // The offset returns the UTF-8 code point in the string. - EndOffset *int32 + // The extracted attributes that relate to the entity. The attributes recognized by + // InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE, and + // STRENGTH. + Attributes []*RxNormAttribute + + // The 0-based character offset in the input text that shows where the entity + // begins. The offset returns the UTF-8 code point in the string. + BeginOffset *int32 // The category of the entity. The recognized categories are GENERIC or BRAND_NAME. Category RxNormEntityCategory + // The 0-based character offset in the input text that shows where the entity ends. + // The offset returns the UTF-8 code point in the string. + EndOffset *int32 + // The numeric identifier for the entity. This is a monotonically increasing id // unique within this response rather than a global unique identifier. Id *int32 - // The 0-based character offset in the input text that shows where the entity - // begins. The offset returns the UTF-8 code point in the string. - BeginOffset *int32 - - // The extracted attributes that relate to the entity. The attributes recognized by - // InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE, and - // STRENGTH. - Attributes []*RxNormAttribute - - // The segment of input text extracted from which the entity was detected. - Text *string - // The RxNorm concepts that the entity could refer to, along with a score // indicating the likelihood of the match. RxNormConcepts []*RxNormConcept - // Contextual information for the entity. - Traits []*RxNormTrait - // The level of confidence that Amazon Comprehend Medical has in the accuracy of // the detected entity. Score *float32 + // The segment of input text extracted from which the entity was detected. + Text *string + + // Contextual information for the entity. + Traits []*RxNormTrait + // Describes the specific type of entity. For InferRxNorm, the recognized entity // type is MEDICATION. Type RxNormEntityType @@ -410,12 +410,12 @@ type RxNormEntity struct { // NEGATION, which is any indication that the patient is not taking a medication. type RxNormTrait struct { + // Provides a name or contextual description about the trait. + Name RxNormTraitName + // The level of confidence that Amazon Comprehend Medical has in the accuracy of // the detected trait. Score *float32 - - // Provides a name or contextual description about the trait. - Name RxNormTraitName } // Provides contextual information about the extracted entity. diff --git a/service/computeoptimizer/api_op_DescribeRecommendationExportJobs.go b/service/computeoptimizer/api_op_DescribeRecommendationExportJobs.go index 0f9e56d2cfe..5fc9ad08059 100644 --- a/service/computeoptimizer/api_op_DescribeRecommendationExportJobs.go +++ b/service/computeoptimizer/api_op_DescribeRecommendationExportJobs.go @@ -60,9 +60,6 @@ func (c *Client) DescribeRecommendationExportJobs(ctx context.Context, params *D type DescribeRecommendationExportJobsInput struct { - // The token to advance to the next page of export jobs. - NextToken *string - // An array of objects that describe a filter to return a more specific list of // export jobs. Filters []*types.JobFilter @@ -77,6 +74,9 @@ type DescribeRecommendationExportJobsInput struct { // The maximum number of export jobs to return with a single request. To retrieve // the remaining results, make another request with the returned NextToken value. MaxResults *int32 + + // The token to advance to the next page of export jobs. + NextToken *string } type DescribeRecommendationExportJobsOutput struct { diff --git a/service/computeoptimizer/api_op_ExportAutoScalingGroupRecommendations.go b/service/computeoptimizer/api_op_ExportAutoScalingGroupRecommendations.go index e0b1c3f9e6e..6cc17f93c9d 100644 --- a/service/computeoptimizer/api_op_ExportAutoScalingGroupRecommendations.go +++ b/service/computeoptimizer/api_op_ExportAutoScalingGroupRecommendations.go @@ -64,16 +64,6 @@ func (c *Client) ExportAutoScalingGroupRecommendations(ctx context.Context, para type ExportAutoScalingGroupRecommendationsInput struct { - // Indicates whether to include recommendations for resources in all member - // accounts of the organization if your account is the master account of an - // organization. The member accounts must also be opted in to Compute Optimizer. - // Recommendations for member accounts of the organization are not included in the - // export file if this parameter is omitted. This parameter cannot be specified - // together with the account IDs parameter. The parameters are mutually exclusive. - // Recommendations for member accounts are not included in the export if this - // parameter, or the account IDs parameter, is omitted. - IncludeMemberAccounts *bool - // An object to specify the destination Amazon Simple Storage Service (Amazon S3) // bucket name and key prefix for the export job. You must create the destination // Amazon S3 bucket for your recommendations export before you create the export @@ -89,13 +79,6 @@ type ExportAutoScalingGroupRecommendationsInput struct { // This member is required. S3DestinationConfig *types.S3DestinationConfig - // The format of the export file. The only export file format currently supported - // is Csv. - FileFormat types.FileFormat - - // The recommendations data to include in the export file. - FieldsToExport []types.ExportableAutoScalingGroupField - // The IDs of the AWS accounts for which to export Auto Scaling group // recommendations. If your account is the master account of an organization, use // this parameter to specify the member accounts for which you want to export @@ -106,22 +89,39 @@ type ExportAutoScalingGroupRecommendationsInput struct { // multiple account IDs per request. AccountIds []*string + // The recommendations data to include in the export file. + FieldsToExport []types.ExportableAutoScalingGroupField + + // The format of the export file. The only export file format currently supported + // is Csv. + FileFormat types.FileFormat + // An array of objects that describe a filter to export a more specific set of Auto // Scaling group recommendations. Filters []*types.Filter + + // Indicates whether to include recommendations for resources in all member + // accounts of the organization if your account is the master account of an + // organization. The member accounts must also be opted in to Compute Optimizer. + // Recommendations for member accounts of the organization are not included in the + // export file if this parameter is omitted. This parameter cannot be specified + // together with the account IDs parameter. The parameters are mutually exclusive. + // Recommendations for member accounts are not included in the export if this + // parameter, or the account IDs parameter, is omitted. + IncludeMemberAccounts *bool } type ExportAutoScalingGroupRecommendationsOutput struct { - // An object that describes the destination Amazon S3 bucket of a recommendations - // export file. - S3Destination *types.S3Destination - // The identification number of the export job. Use the // DescribeRecommendationExportJobs action, and specify the job ID to view the // status of an export job. JobId *string + // An object that describes the destination Amazon S3 bucket of a recommendations + // export file. + S3Destination *types.S3Destination + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/computeoptimizer/api_op_ExportEC2InstanceRecommendations.go b/service/computeoptimizer/api_op_ExportEC2InstanceRecommendations.go index 7a7d63c125b..13528bb6597 100644 --- a/service/computeoptimizer/api_op_ExportEC2InstanceRecommendations.go +++ b/service/computeoptimizer/api_op_ExportEC2InstanceRecommendations.go @@ -64,6 +64,21 @@ func (c *Client) ExportEC2InstanceRecommendations(ctx context.Context, params *E type ExportEC2InstanceRecommendationsInput struct { + // An object to specify the destination Amazon Simple Storage Service (Amazon S3) + // bucket name and key prefix for the export job. You must create the destination + // Amazon S3 bucket for your recommendations export before you create the export + // job. Compute Optimizer does not create the S3 bucket for you. After you create + // the S3 bucket, ensure that it has the required permission policy to allow + // Compute Optimizer to write the export file to it. If you plan to specify an + // object prefix when you create the export job, you must include the object prefix + // in the policy that you add to the S3 bucket. For more information, see Amazon S3 + // Bucket Policy for Compute Optimizer + // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html) + // in the Compute Optimizer user guide. + // + // This member is required. + S3DestinationConfig *types.S3DestinationConfig + // The IDs of the AWS accounts for which to export instance recommendations. If // your account is the master account of an organization, use this parameter to // specify the member accounts for which you want to export recommendations. This @@ -74,12 +89,16 @@ type ExportEC2InstanceRecommendationsInput struct { // request. AccountIds []*string + // The recommendations data to include in the export file. + FieldsToExport []types.ExportableInstanceField + // The format of the export file. The only export file format currently supported // is Csv. FileFormat types.FileFormat - // The recommendations data to include in the export file. - FieldsToExport []types.ExportableInstanceField + // An array of objects that describe a filter to export a more specific set of + // instance recommendations. + Filters []*types.Filter // Indicates whether to include recommendations for resources in all member // accounts of the organization if your account is the master account of an @@ -89,25 +108,6 @@ type ExportEC2InstanceRecommendationsInput struct { // are not included in the export if this parameter, or the account IDs parameter, // is omitted. IncludeMemberAccounts *bool - - // An array of objects that describe a filter to export a more specific set of - // instance recommendations. - Filters []*types.Filter - - // An object to specify the destination Amazon Simple Storage Service (Amazon S3) - // bucket name and key prefix for the export job. You must create the destination - // Amazon S3 bucket for your recommendations export before you create the export - // job. Compute Optimizer does not create the S3 bucket for you. After you create - // the S3 bucket, ensure that it has the required permission policy to allow - // Compute Optimizer to write the export file to it. If you plan to specify an - // object prefix when you create the export job, you must include the object prefix - // in the policy that you add to the S3 bucket. For more information, see Amazon S3 - // Bucket Policy for Compute Optimizer - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html) - // in the Compute Optimizer user guide. - // - // This member is required. - S3DestinationConfig *types.S3DestinationConfig } type ExportEC2InstanceRecommendationsOutput struct { diff --git a/service/computeoptimizer/api_op_GetAutoScalingGroupRecommendations.go b/service/computeoptimizer/api_op_GetAutoScalingGroupRecommendations.go index 6534748423b..b227a13194b 100644 --- a/service/computeoptimizer/api_op_GetAutoScalingGroupRecommendations.go +++ b/service/computeoptimizer/api_op_GetAutoScalingGroupRecommendations.go @@ -64,31 +64,34 @@ func (c *Client) GetAutoScalingGroupRecommendations(ctx context.Context, params type GetAutoScalingGroupRecommendationsInput struct { - // The maximum number of Auto Scaling group recommendations to return with a single - // request. To retrieve the remaining results, make another request with the - // returned NextToken value. - MaxResults *int32 + // The IDs of the AWS accounts for which to return Auto Scaling group + // recommendations. If your account is the master account of an organization, use + // this parameter to specify the member accounts for which you want to return Auto + // Scaling group recommendations. Only one account ID can be specified per request. + AccountIds []*string + + // The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return + // recommendations. + AutoScalingGroupArns []*string // An array of objects that describe a filter that returns a more specific list of // Auto Scaling group recommendations. Filters []*types.Filter + // The maximum number of Auto Scaling group recommendations to return with a single + // request. To retrieve the remaining results, make another request with the + // returned NextToken value. + MaxResults *int32 + // The token to advance to the next page of Auto Scaling group recommendations. NextToken *string - - // The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return - // recommendations. - AutoScalingGroupArns []*string - - // The IDs of the AWS accounts for which to return Auto Scaling group - // recommendations. If your account is the master account of an organization, use - // this parameter to specify the member accounts for which you want to return Auto - // Scaling group recommendations. Only one account ID can be specified per request. - AccountIds []*string } type GetAutoScalingGroupRecommendationsOutput struct { + // An array of objects that describe Auto Scaling group recommendations. + AutoScalingGroupRecommendations []*types.AutoScalingGroupRecommendation + // An array of objects that describe errors of the request. For example, an error // is returned if you request recommendations for an unsupported Auto Scaling // group. @@ -99,9 +102,6 @@ type GetAutoScalingGroupRecommendationsOutput struct { // group recommendations to return. NextToken *string - // An array of objects that describe Auto Scaling group recommendations. - AutoScalingGroupRecommendations []*types.AutoScalingGroupRecommendation - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/computeoptimizer/api_op_GetEC2InstanceRecommendations.go b/service/computeoptimizer/api_op_GetEC2InstanceRecommendations.go index 1c5e3c7771b..e3964b78c85 100644 --- a/service/computeoptimizer/api_op_GetEC2InstanceRecommendations.go +++ b/service/computeoptimizer/api_op_GetEC2InstanceRecommendations.go @@ -60,39 +60,39 @@ func (c *Client) GetEC2InstanceRecommendations(ctx context.Context, params *GetE type GetEC2InstanceRecommendationsInput struct { - // The token to advance to the next page of instance recommendations. - NextToken *string - - // The maximum number of instance recommendations to return with a single request. - // To retrieve the remaining results, make another request with the returned - // NextToken value. - MaxResults *int32 - // The IDs of the AWS accounts for which to return instance recommendations. If // your account is the master account of an organization, use this parameter to // specify the member accounts for which you want to return instance // recommendations. Only one account ID can be specified per request. AccountIds []*string + // An array of objects that describe a filter that returns a more specific list of + // instance recommendations. + Filters []*types.Filter + // The Amazon Resource Name (ARN) of the instances for which to return // recommendations. InstanceArns []*string - // An array of objects that describe a filter that returns a more specific list of - // instance recommendations. - Filters []*types.Filter + // The maximum number of instance recommendations to return with a single request. + // To retrieve the remaining results, make another request with the returned + // NextToken value. + MaxResults *int32 + + // The token to advance to the next page of instance recommendations. + NextToken *string } type GetEC2InstanceRecommendationsOutput struct { - // An array of objects that describe instance recommendations. - InstanceRecommendations []*types.InstanceRecommendation - // An array of objects that describe errors of the request. For example, an error // is returned if you request recommendations for an instance of an unsupported // instance family. Errors []*types.GetRecommendationError + // An array of objects that describe instance recommendations. + InstanceRecommendations []*types.InstanceRecommendation + // The token to use to advance to the next page of instance recommendations. This // value is null when there are no more pages of instance recommendations to // return. diff --git a/service/computeoptimizer/api_op_GetEC2RecommendationProjectedMetrics.go b/service/computeoptimizer/api_op_GetEC2RecommendationProjectedMetrics.go index 849ddc22f76..82bb0b20b46 100644 --- a/service/computeoptimizer/api_op_GetEC2RecommendationProjectedMetrics.go +++ b/service/computeoptimizer/api_op_GetEC2RecommendationProjectedMetrics.go @@ -64,26 +64,26 @@ type GetEC2RecommendationProjectedMetricsInput struct { // This member is required. EndTime *time.Time - // The time stamp of the first projected metrics data point to return. + // The Amazon Resource Name (ARN) of the instances for which to return + // recommendation projected metrics. // // This member is required. - StartTime *time.Time + InstanceArn *string // The granularity, in seconds, of the projected metrics data points. // // This member is required. Period *int32 - // The statistic of the projected metrics. + // The time stamp of the first projected metrics data point to return. // // This member is required. - Stat types.MetricStatistic + StartTime *time.Time - // The Amazon Resource Name (ARN) of the instances for which to return - // recommendation projected metrics. + // The statistic of the projected metrics. // // This member is required. - InstanceArn *string + Stat types.MetricStatistic } type GetEC2RecommendationProjectedMetricsOutput struct { diff --git a/service/computeoptimizer/api_op_GetEnrollmentStatus.go b/service/computeoptimizer/api_op_GetEnrollmentStatus.go index 2cc93b87e85..9b797a101da 100644 --- a/service/computeoptimizer/api_op_GetEnrollmentStatus.go +++ b/service/computeoptimizer/api_op_GetEnrollmentStatus.go @@ -62,11 +62,6 @@ type GetEnrollmentStatusInput struct { type GetEnrollmentStatusOutput struct { - // The reason for the enrollment status of the account. For example, an account - // might show a status of Pending because member accounts of an organization - // require more time to be enrolled in the service. - StatusReason *string - // Confirms the enrollment status of member accounts within the organization, if // the account is a master account of an organization. MemberAccountsEnrolled *bool @@ -74,6 +69,11 @@ type GetEnrollmentStatusOutput struct { // The enrollment status of the account. Status types.Status + // The reason for the enrollment status of the account. For example, an account + // might show a status of Pending because member accounts of an organization + // require more time to be enrolled in the service. + StatusReason *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/computeoptimizer/api_op_GetRecommendationSummaries.go b/service/computeoptimizer/api_op_GetRecommendationSummaries.go index 62075e218e2..6be0c1a7c22 100644 --- a/service/computeoptimizer/api_op_GetRecommendationSummaries.go +++ b/service/computeoptimizer/api_op_GetRecommendationSummaries.go @@ -59,6 +59,12 @@ func (c *Client) GetRecommendationSummaries(ctx context.Context, params *GetReco type GetRecommendationSummariesInput struct { + // The IDs of the AWS accounts for which to return recommendation summaries. If + // your account is the master account of an organization, use this parameter to + // specify the member accounts for which you want to return recommendation + // summaries. Only one account ID can be specified per request. + AccountIds []*string + // The maximum number of recommendation summaries to return with a single request. // To retrieve the remaining results, make another request with the returned // NextToken value. @@ -66,24 +72,18 @@ type GetRecommendationSummariesInput struct { // The token to advance to the next page of recommendation summaries. NextToken *string - - // The IDs of the AWS accounts for which to return recommendation summaries. If - // your account is the master account of an organization, use this parameter to - // specify the member accounts for which you want to return recommendation - // summaries. Only one account ID can be specified per request. - AccountIds []*string } type GetRecommendationSummariesOutput struct { - // An array of objects that summarize a recommendation. - RecommendationSummaries []*types.RecommendationSummary - // The token to use to advance to the next page of recommendation summaries. This // value is null when there are no more pages of recommendation summaries to // return. NextToken *string + // An array of objects that summarize a recommendation. + RecommendationSummaries []*types.RecommendationSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/computeoptimizer/api_op_UpdateEnrollmentStatus.go b/service/computeoptimizer/api_op_UpdateEnrollmentStatus.go index d55e6c19f0d..a7e121edebb 100644 --- a/service/computeoptimizer/api_op_UpdateEnrollmentStatus.go +++ b/service/computeoptimizer/api_op_UpdateEnrollmentStatus.go @@ -72,14 +72,14 @@ type UpdateEnrollmentStatusInput struct { type UpdateEnrollmentStatusOutput struct { + // The enrollment status of the account. + Status types.Status + // The reason for the enrollment status of the account. For example, an account // might show a status of Pending because member accounts of an organization // require more time to be enrolled in the service. StatusReason *string - // The enrollment status of the account. - Status types.Status - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/computeoptimizer/go.mod b/service/computeoptimizer/go.mod index d5e70e86acc..b9df94a0fcf 100644 --- a/service/computeoptimizer/go.mod +++ b/service/computeoptimizer/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/computeoptimizer go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/computeoptimizer/types/types.go b/service/computeoptimizer/types/types.go index 2d1e2e1ea66..0bccafc7b7d 100644 --- a/service/computeoptimizer/types/types.go +++ b/service/computeoptimizer/types/types.go @@ -9,14 +9,14 @@ import ( // Describes the configuration of an Auto Scaling group. type AutoScalingGroupConfiguration struct { - // The maximum size, or maximum number of instances, for the Auto Scaling group. - MaxSize *int32 + // The desired capacity, or number of instances, for the Auto Scaling group. + DesiredCapacity *int32 // The instance type for the Auto Scaling group. InstanceType *string - // The desired capacity, or number of instances, for the Auto Scaling group. - DesiredCapacity *int32 + // The maximum size, or maximum number of instances, for the Auto Scaling group. + MaxSize *int32 // The minimum size, or minimum number of instances, for the Auto Scaling group. MinSize *int32 @@ -25,34 +25,19 @@ type AutoScalingGroupConfiguration struct { // Describes an Auto Scaling group recommendation. type AutoScalingGroupRecommendation struct { - // The number of days for which utilization metrics were analyzed for the Auto - // Scaling group. - LookBackPeriodInDays *float64 - // The AWS account ID of the Auto Scaling group. AccountId *string - // An array of objects that describe the utilization metrics of the Auto Scaling - // group. - UtilizationMetrics []*UtilizationMetric + // The Amazon Resource Name (ARN) of the Auto Scaling group. + AutoScalingGroupArn *string // The name of the Auto Scaling group. AutoScalingGroupName *string - // An array of objects that describe the recommendation options for the Auto - // Scaling group. - RecommendationOptions []*AutoScalingGroupRecommendationOption - // An array of objects that describe the current configuration of the Auto Scaling // group. CurrentConfiguration *AutoScalingGroupConfiguration - // The Amazon Resource Name (ARN) of the Auto Scaling group. - AutoScalingGroupArn *string - - // The time stamp of when the Auto Scaling group recommendation was last refreshed. - LastRefreshTimestamp *time.Time - // The finding classification for the Auto Scaling group. Findings for Auto Scaling // groups include: // @@ -69,19 +54,26 @@ type AutoScalingGroupRecommendation struct { // The values that are returned might be NOT_OPTIMIZED or // OPTIMIZED. Finding Finding + + // The time stamp of when the Auto Scaling group recommendation was last refreshed. + LastRefreshTimestamp *time.Time + + // The number of days for which utilization metrics were analyzed for the Auto + // Scaling group. + LookBackPeriodInDays *float64 + + // An array of objects that describe the recommendation options for the Auto + // Scaling group. + RecommendationOptions []*AutoScalingGroupRecommendationOption + + // An array of objects that describe the utilization metrics of the Auto Scaling + // group. + UtilizationMetrics []*UtilizationMetric } // Describes a recommendation option for an Auto Scaling group. type AutoScalingGroupRecommendationOption struct { - // An array of objects that describe the projected utilization metrics of the Auto - // Scaling group recommendation option. - ProjectedUtilizationMetrics []*UtilizationMetric - - // The rank of the Auto Scaling group recommendation option. The top recommendation - // option is ranked as 1. - Rank *int32 - // An array of objects that describe an Auto Scaling group configuration. Configuration *AutoScalingGroupConfiguration @@ -90,6 +82,14 @@ type AutoScalingGroupRecommendationOption struct { // the performance requirement of your workload. The lowest performance risk is // categorized as 0, and the highest as 5. PerformanceRisk *float64 + + // An array of objects that describe the projected utilization metrics of the Auto + // Scaling group recommendation option. + ProjectedUtilizationMetrics []*UtilizationMetric + + // The rank of the Auto Scaling group recommendation option. The top recommendation + // option is ranked as 1. + Rank *int32 } // Describes the destination of the recommendations export and metadata files. @@ -126,21 +126,24 @@ type Filter struct { // instance family. type GetRecommendationError struct { - // The message, or reason, for the error. - Message *string - // The error code. Code *string // The ID of the error. Identifier *string + + // The message, or reason, for the error. + Message *string } // Describes an Amazon EC2 instance recommendation. type InstanceRecommendation struct { - // The time stamp of when the instance recommendation was last refreshed. - LastRefreshTimestamp *time.Time + // The AWS account ID of the instance. + AccountId *string + + // The instance type of the current instance. + CurrentInstanceType *string // The finding classification for the instance. Findings for instances include: // @@ -168,81 +171,78 @@ type InstanceRecommendation struct { // UNDER_PROVISIONED, OVER_PROVISIONED, or OPTIMIZED. Finding Finding - // An array of objects that describe the recommendation options for the instance. - RecommendationOptions []*InstanceRecommendationOption - - // An array of objects that describe the source resource of the recommendation. - RecommendationSources []*RecommendationSource - - // An array of objects that describe the utilization metrics of the instance. - UtilizationMetrics []*UtilizationMetric + // The Amazon Resource Name (ARN) of the current instance. + InstanceArn *string // The name of the current instance. InstanceName *string - // The instance type of the current instance. - CurrentInstanceType *string - - // The AWS account ID of the instance. - AccountId *string + // The time stamp of when the instance recommendation was last refreshed. + LastRefreshTimestamp *time.Time // The number of days for which utilization metrics were analyzed for the instance. LookBackPeriodInDays *float64 - // The Amazon Resource Name (ARN) of the current instance. - InstanceArn *string + // An array of objects that describe the recommendation options for the instance. + RecommendationOptions []*InstanceRecommendationOption + + // An array of objects that describe the source resource of the recommendation. + RecommendationSources []*RecommendationSource + + // An array of objects that describe the utilization metrics of the instance. + UtilizationMetrics []*UtilizationMetric } // Describes a recommendation option for an Amazon EC2 instance. type InstanceRecommendationOption struct { - // The rank of the instance recommendation option. The top recommendation option is - // ranked as 1. - Rank *int32 - // The instance type of the instance recommendation. InstanceType *string - // An array of objects that describe the projected utilization metrics of the - // instance recommendation option. - ProjectedUtilizationMetrics []*UtilizationMetric - // The performance risk of the instance recommendation option. Performance risk is // the likelihood of the recommended instance type not meeting the performance // requirement of your workload. The lowest performance risk is categorized as 0, // and the highest as 5. PerformanceRisk *float64 + + // An array of objects that describe the projected utilization metrics of the + // instance recommendation option. + ProjectedUtilizationMetrics []*UtilizationMetric + + // The rank of the instance recommendation option. The top recommendation option is + // ranked as 1. + Rank *int32 } // Describes a filter that returns a more specific list of recommendation export // jobs. This filter is used with the DescribeRecommendationExportJobs action. type JobFilter struct { + // The name of the filter. Specify ResourceType to return export jobs of a specific + // resource type (e.g., Ec2Instance). Specify JobStatus to return export jobs with + // a specific status (e.g, Complete). + Name JobFilterName + // The value of the filter. If you specify the name parameter as ResourceType, the // valid values are Ec2Instance or AutoScalingGroup. If you specify the name // parameter as JobStatus, the valid values are Queued, InProgress, Complete, or // Failed. Values []*string - - // The name of the filter. Specify ResourceType to return export jobs of a specific - // resource type (e.g., Ec2Instance). Specify JobStatus to return export jobs with - // a specific status (e.g, Complete). - Name JobFilterName } // Describes a projected utilization metric of a recommendation option, such as an // Amazon EC2 instance. type ProjectedMetric struct { - // The time stamps of the projected utilization metric. - Timestamps []*time.Time - // The name of the projected utilization metric. Memory metrics are only returned // for resources that have the unified CloudWatch agent installed on them. For more // information, see Enabling Memory Utilization with the CloudWatch Agent // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Install-CloudWatch-Agent.html). Name MetricName + // The time stamps of the projected utilization metric. + Timestamps []*time.Time + // The values of the projected utilization metrics. Values []*float64 } @@ -254,26 +254,26 @@ type ProjectedMetric struct { // your recommendations.

    type RecommendationExportJob struct { + // The timestamp of when the export job was created. + CreationTimestamp *time.Time + + // An object that describes the destination of the export file. + Destination *ExportDestination + // The reason for an export job failure. FailureReason *string - // The status of the export job. - Status JobStatus + // The identification number of the export job. + JobId *string // The timestamp of when the export job was last updated. LastUpdatedTimestamp *time.Time - // An object that describes the destination of the export file. - Destination *ExportDestination - // The resource type of the exported recommendations. ResourceType ResourceType - // The identification number of the export job. - JobId *string - - // The timestamp of when the export job was created. - CreationTimestamp *time.Time + // The status of the export job. + Status JobStatus } // Describes the source of a recommendation, such as an Amazon EC2 instance or Auto @@ -293,19 +293,16 @@ type RecommendationSummary struct { // The AWS account ID of the recommendation summary. AccountId *string - // An array of objects that describe a recommendation summary. - Summaries []*Summary - // The resource type of the recommendation. RecommendationResourceType RecommendationSourceType + + // An array of objects that describe a recommendation summary. + Summaries []*Summary } // Describes a projected utilization metric of a recommendation option. type RecommendedOptionProjectedMetric struct { - // The recommended instance type. - RecommendedInstanceType *string - // An array of objects that describe a projected utilization metric. ProjectedMetrics []*ProjectedMetric @@ -315,6 +312,9 @@ type RecommendedOptionProjectedMetric struct { // related to the recommendation option that is also ranked as 1 in the same // response. Rank *int32 + + // The recommended instance type. + RecommendedInstanceType *string } // Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name @@ -322,16 +322,16 @@ type RecommendedOptionProjectedMetric struct { // file. type S3Destination struct { - // The Amazon S3 bucket key of a metadata file. The key uniquely identifies the - // object, or metadata file, in the S3 bucket. - MetadataKey *string + // The name of the Amazon S3 bucket used as the destination of an export file. + Bucket *string // The Amazon S3 bucket key of an export file. The key uniquely identifies the // object, or export file, in the S3 bucket. Key *string - // The name of the Amazon S3 bucket used as the destination of an export file. - Bucket *string + // The Amazon S3 bucket key of a metadata file. The key uniquely identifies the + // object, or metadata file, in the S3 bucket. + MetadataKey *string } // Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name @@ -347,29 +347,26 @@ type S3Destination struct { // in the Compute Optimizer user guide. type S3DestinationConfig struct { - // The Amazon S3 bucket prefix for an export job. - KeyPrefix *string - // The name of the Amazon S3 bucket to use as the destination for an export job. Bucket *string + + // The Amazon S3 bucket prefix for an export job. + KeyPrefix *string } // The summary of a recommendation. type Summary struct { - // The value of the recommendation summary. - Value *float64 - // The finding classification of the recommendation. Name Finding + + // The value of the recommendation summary. + Value *float64 } // Describes a utilization metric of a resource, such as an Amazon EC2 instance. type UtilizationMetric struct { - // The value of the utilization metric. - Value *float64 - // The name of the utilization metric. Memory metrics are only returned for // resources that have the unified CloudWatch agent installed on them. For more // information, see Enabling Memory Utilization with the CloudWatch Agent @@ -378,4 +375,7 @@ type UtilizationMetric struct { // The statistic of the utilization metric. Statistic MetricStatistic + + // The value of the utilization metric. + Value *float64 } diff --git a/service/configservice/api_op_BatchGetAggregateResourceConfig.go b/service/configservice/api_op_BatchGetAggregateResourceConfig.go index 3d10074899e..a68c0f9a837 100644 --- a/service/configservice/api_op_BatchGetAggregateResourceConfig.go +++ b/service/configservice/api_op_BatchGetAggregateResourceConfig.go @@ -62,26 +62,26 @@ func (c *Client) BatchGetAggregateResourceConfig(ctx context.Context, params *Ba type BatchGetAggregateResourceConfigInput struct { - // A list of aggregate ResourceIdentifiers objects. + // The name of the configuration aggregator. // // This member is required. - ResourceIdentifiers []*types.AggregateResourceIdentifier + ConfigurationAggregatorName *string - // The name of the configuration aggregator. + // A list of aggregate ResourceIdentifiers objects. // // This member is required. - ConfigurationAggregatorName *string + ResourceIdentifiers []*types.AggregateResourceIdentifier } type BatchGetAggregateResourceConfigOutput struct { + // A list that contains the current configuration of one or more resources. + BaseConfigurationItems []*types.BaseConfigurationItem + // A list of resource identifiers that were not processed with current scope. The // list is empty if all the resources are processed. UnprocessedResourceIdentifiers []*types.AggregateResourceIdentifier - // A list that contains the current configuration of one or more resources. - BaseConfigurationItems []*types.BaseConfigurationItem - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/configservice/api_op_DeleteAggregationAuthorization.go b/service/configservice/api_op_DeleteAggregationAuthorization.go index 4d78e80abed..689b47178d6 100644 --- a/service/configservice/api_op_DeleteAggregationAuthorization.go +++ b/service/configservice/api_op_DeleteAggregationAuthorization.go @@ -57,15 +57,15 @@ func (c *Client) DeleteAggregationAuthorization(ctx context.Context, params *Del type DeleteAggregationAuthorizationInput struct { - // The region authorized to collect aggregated data. + // The 12-digit account ID of the account authorized to aggregate data. // // This member is required. - AuthorizedAwsRegion *string + AuthorizedAccountId *string - // The 12-digit account ID of the account authorized to aggregate data. + // The region authorized to collect aggregated data. // // This member is required. - AuthorizedAccountId *string + AuthorizedAwsRegion *string } type DeleteAggregationAuthorizationOutput struct { diff --git a/service/configservice/api_op_DeleteRemediationConfiguration.go b/service/configservice/api_op_DeleteRemediationConfiguration.go index ae96600b59f..67f3a6b4535 100644 --- a/service/configservice/api_op_DeleteRemediationConfiguration.go +++ b/service/configservice/api_op_DeleteRemediationConfiguration.go @@ -56,14 +56,14 @@ func (c *Client) DeleteRemediationConfiguration(ctx context.Context, params *Del type DeleteRemediationConfigurationInput struct { - // The type of a resource. - ResourceType *string - // The name of the AWS Config rule for which you want to delete remediation // configuration. // // This member is required. ConfigRuleName *string + + // The type of a resource. + ResourceType *string } type DeleteRemediationConfigurationOutput struct { diff --git a/service/configservice/api_op_DeleteRemediationExceptions.go b/service/configservice/api_op_DeleteRemediationExceptions.go index c75f33dacd1..66cb35e5f1f 100644 --- a/service/configservice/api_op_DeleteRemediationExceptions.go +++ b/service/configservice/api_op_DeleteRemediationExceptions.go @@ -60,18 +60,18 @@ func (c *Client) DeleteRemediationExceptions(ctx context.Context, params *Delete type DeleteRemediationExceptionsInput struct { + // The name of the AWS Config rule for which you want to delete remediation + // exception configuration. + // + // This member is required. + ConfigRuleName *string + // An exception list of resource exception keys to be processed with the current // request. AWS Config adds exception for each resource key. For example, AWS // Config adds 3 exceptions for 3 resource keys. // // This member is required. ResourceKeys []*types.RemediationExceptionResourceKey - - // The name of the AWS Config rule for which you want to delete remediation - // exception configuration. - // - // This member is required. - ConfigRuleName *string } type DeleteRemediationExceptionsOutput struct { diff --git a/service/configservice/api_op_DeleteResourceConfig.go b/service/configservice/api_op_DeleteResourceConfig.go index 1dadcb14feb..90940103aac 100644 --- a/service/configservice/api_op_DeleteResourceConfig.go +++ b/service/configservice/api_op_DeleteResourceConfig.go @@ -59,15 +59,15 @@ func (c *Client) DeleteResourceConfig(ctx context.Context, params *DeleteResourc type DeleteResourceConfigInput struct { - // The type of the resource. + // Unique identifier of the resource. // // This member is required. - ResourceType *string + ResourceId *string - // Unique identifier of the resource. + // The type of the resource. // // This member is required. - ResourceId *string + ResourceType *string } type DeleteResourceConfigOutput struct { diff --git a/service/configservice/api_op_DescribeAggregateComplianceByConfigRules.go b/service/configservice/api_op_DescribeAggregateComplianceByConfigRules.go index 9c8825394d3..5c262de4bfe 100644 --- a/service/configservice/api_op_DescribeAggregateComplianceByConfigRules.go +++ b/service/configservice/api_op_DescribeAggregateComplianceByConfigRules.go @@ -59,14 +59,14 @@ func (c *Client) DescribeAggregateComplianceByConfigRules(ctx context.Context, p type DescribeAggregateComplianceByConfigRulesInput struct { - // Filters the results by ConfigRuleComplianceFilters object. - Filters *types.ConfigRuleComplianceFilters - // The name of the configuration aggregator. // // This member is required. ConfigurationAggregatorName *string + // Filters the results by ConfigRuleComplianceFilters object. + Filters *types.ConfigRuleComplianceFilters + // The maximum number of evaluation results returned on each page. The default is // maximum. If you specify 0, AWS Config uses the default. Limit *int32 @@ -78,13 +78,13 @@ type DescribeAggregateComplianceByConfigRulesInput struct { type DescribeAggregateComplianceByConfigRulesOutput struct { + // Returns a list of AggregateComplianceByConfigRule object. + AggregateComplianceByConfigRules []*types.AggregateComplianceByConfigRule + // The nextToken string returned on a previous page that you use to get the next // page of results in a paginated response. NextToken *string - // Returns a list of AggregateComplianceByConfigRule object. - AggregateComplianceByConfigRules []*types.AggregateComplianceByConfigRule - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/configservice/api_op_DescribeComplianceByResource.go b/service/configservice/api_op_DescribeComplianceByResource.go index fa0c1e88982..29ff7a26420 100644 --- a/service/configservice/api_op_DescribeComplianceByResource.go +++ b/service/configservice/api_op_DescribeComplianceByResource.go @@ -83,11 +83,6 @@ type DescribeComplianceByResourceInput struct { // NON_COMPLIANT, and INSUFFICIENT_DATA. ComplianceTypes []types.ComplianceType - // The ID of the AWS resource for which you want compliance information. You can - // specify only one resource ID. If you specify a resource ID, you must also - // specify a type for ResourceType. - ResourceId *string - // The maximum number of evaluation results returned on each page. The default is // 10. You cannot specify a number greater than 100. If you specify 0, AWS Config // uses the default. @@ -97,6 +92,11 @@ type DescribeComplianceByResourceInput struct { // page of results in a paginated response. NextToken *string + // The ID of the AWS resource for which you want compliance information. You can + // specify only one resource ID. If you specify a resource ID, you must also + // specify a type for ResourceType. + ResourceId *string + // The types of AWS resources for which you want compliance information (for // example, AWS::EC2::Instance). For this action, you can specify that the resource // type is an AWS account by specifying AWS::::Account. @@ -106,14 +106,14 @@ type DescribeComplianceByResourceInput struct { // type DescribeComplianceByResourceOutput struct { - // The string that you use in a subsequent request to get the next page of results - // in a paginated response. - NextToken *string - // Indicates whether the specified AWS resource complies with all of the AWS Config // rules that evaluate it. ComplianceByResources []*types.ComplianceByResource + // The string that you use in a subsequent request to get the next page of results + // in a paginated response. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/configservice/api_op_DescribeConfigRuleEvaluationStatus.go b/service/configservice/api_op_DescribeConfigRuleEvaluationStatus.go index ebc2d8c15fe..3cf609a875c 100644 --- a/service/configservice/api_op_DescribeConfigRuleEvaluationStatus.go +++ b/service/configservice/api_op_DescribeConfigRuleEvaluationStatus.go @@ -60,6 +60,11 @@ func (c *Client) DescribeConfigRuleEvaluationStatus(ctx context.Context, params // type DescribeConfigRuleEvaluationStatusInput struct { + // The name of the AWS managed Config rules for which you want status information. + // If you do not specify any names, AWS Config returns status information for all + // AWS managed Config rules that you use. + ConfigRuleNames []*string + // The number of rule evaluation results that you want returned.

    This parameter // is required if the rule limit for your account is more than the default of 150 // rules.

    For information about requesting a rule limit increase, see If a // value for resourceTypes is not specified, AWS Config returns all @@ -90,19 +99,14 @@ type GetDiscoveredResourceCountsInput struct { // recording a specific resource type (for example, S3 buckets), that resource type // is not returned in the list of ResourceCount objects.

    ResourceTypes []*string - - // The maximum number of ResourceCount () objects returned on each page. The - // default is 100. You cannot specify a number greater than 100. If you specify 0, - // AWS Config uses the default. - Limit *int32 - - // The nextToken string returned on a previous page that you use to get the next - // page of results in a paginated response. - NextToken *string } type GetDiscoveredResourceCountsOutput struct { + // The string that you use in a subsequent request to get the next page of results + // in a paginated response. + NextToken *string + // The list of ResourceCount objects. Each object is listed in descending order by // the number of resources. ResourceCounts []*types.ResourceCount @@ -118,10 +122,6 @@ type GetDiscoveredResourceCountsOutput struct { // Config returns 25 for totalDiscoveredResources.

    TotalDiscoveredResources *int64 - // The string that you use in a subsequent request to get the next page of results - // in a paginated response. - NextToken *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/configservice/api_op_GetOrganizationConfigRuleDetailedStatus.go b/service/configservice/api_op_GetOrganizationConfigRuleDetailedStatus.go index 773fa87fe93..a24ece72d4e 100644 --- a/service/configservice/api_op_GetOrganizationConfigRuleDetailedStatus.go +++ b/service/configservice/api_op_GetOrganizationConfigRuleDetailedStatus.go @@ -61,15 +61,15 @@ func (c *Client) GetOrganizationConfigRuleDetailedStatus(ctx context.Context, pa type GetOrganizationConfigRuleDetailedStatusInput struct { - // A StatusDetailFilters object. - Filters *types.StatusDetailFilters - // The name of organization config rule for which you want status details for // member accounts. // // This member is required. OrganizationConfigRuleName *string + // A StatusDetailFilters object. + Filters *types.StatusDetailFilters + // The maximum number of OrganizationConfigRuleDetailedStatus returned on each // page. If you do not specify a number, AWS Config uses the default. The default // is 100. diff --git a/service/configservice/api_op_GetOrganizationConformancePackDetailedStatus.go b/service/configservice/api_op_GetOrganizationConformancePackDetailedStatus.go index eccf74d8a2a..bdf1f2ad696 100644 --- a/service/configservice/api_op_GetOrganizationConformancePackDetailedStatus.go +++ b/service/configservice/api_op_GetOrganizationConformancePackDetailedStatus.go @@ -61,23 +61,23 @@ func (c *Client) GetOrganizationConformancePackDetailedStatus(ctx context.Contex type GetOrganizationConformancePackDetailedStatusInput struct { - // An OrganizationResourceDetailedStatusFilters object. - Filters *types.OrganizationResourceDetailedStatusFilters - // The name of organization conformance pack for which you want status details for // member accounts. // // This member is required. OrganizationConformancePackName *string - // The nextToken string returned on a previous page that you use to get the next - // page of results in a paginated response. - NextToken *string + // An OrganizationResourceDetailedStatusFilters object. + Filters *types.OrganizationResourceDetailedStatusFilters // The maximum number of OrganizationConformancePackDetailedStatuses returned on // each page. If you do not specify a number, AWS Config uses the default. The // default is 100. Limit *int32 + + // The nextToken string returned on a previous page that you use to get the next + // page of results in a paginated response. + NextToken *string } type GetOrganizationConformancePackDetailedStatusOutput struct { diff --git a/service/configservice/api_op_GetResourceConfigHistory.go b/service/configservice/api_op_GetResourceConfigHistory.go index 6d7610d2a20..79e70268a84 100644 --- a/service/configservice/api_op_GetResourceConfigHistory.go +++ b/service/configservice/api_op_GetResourceConfigHistory.go @@ -70,24 +70,11 @@ func (c *Client) GetResourceConfigHistory(ctx context.Context, params *GetResour // The input for the GetResourceConfigHistory () action. type GetResourceConfigHistoryInput struct { - // The time stamp that indicates a later time. If not specified, current time is - // taken. - LaterTime *time.Time - // The ID of the resource (for example., sg-xxxxxx). // // This member is required. ResourceId *string - // The nextToken string returned on a previous page that you use to get the next - // page of results in a paginated response. - NextToken *string - - // The time stamp that indicates an earlier time. If not specified, the action - // returns paginated results that contain configuration items that start when the - // first configuration item was recorded. - EarlierTime *time.Time - // The resource type. // // This member is required. @@ -97,22 +84,35 @@ type GetResourceConfigHistoryInput struct { // are listed in reverse chronological order. ChronologicalOrder types.ChronologicalOrder + // The time stamp that indicates an earlier time. If not specified, the action + // returns paginated results that contain configuration items that start when the + // first configuration item was recorded. + EarlierTime *time.Time + + // The time stamp that indicates a later time. If not specified, current time is + // taken. + LaterTime *time.Time + // The maximum number of configuration items returned on each page. The default is // 10. You cannot specify a number greater than 100. If you specify 0, AWS Config // uses the default. Limit *int32 + + // The nextToken string returned on a previous page that you use to get the next + // page of results in a paginated response. + NextToken *string } // The output for the GetResourceConfigHistory () action. type GetResourceConfigHistoryOutput struct { + // A list that contains the configuration history of one or more resources. + ConfigurationItems []*types.ConfigurationItem + // The string that you use in a subsequent request to get the next page of results // in a paginated response. NextToken *string - // A list that contains the configuration history of one or more resources. - ConfigurationItems []*types.ConfigurationItem - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/configservice/api_op_ListAggregateDiscoveredResources.go b/service/configservice/api_op_ListAggregateDiscoveredResources.go index a8d466b277a..5f051b69601 100644 --- a/service/configservice/api_op_ListAggregateDiscoveredResources.go +++ b/service/configservice/api_op_ListAggregateDiscoveredResources.go @@ -65,27 +65,27 @@ func (c *Client) ListAggregateDiscoveredResources(ctx context.Context, params *L type ListAggregateDiscoveredResourcesInput struct { - // Filters the results based on the ResourceFilters object. - Filters *types.ResourceFilters + // The name of the configuration aggregator. + // + // This member is required. + ConfigurationAggregatorName *string // The type of resources that you want AWS Config to list in the response. // // This member is required. ResourceType types.ResourceType - // The nextToken string returned on a previous page that you use to get the next - // page of results in a paginated response. - NextToken *string + // Filters the results based on the ResourceFilters object. + Filters *types.ResourceFilters // The maximum number of resource identifiers returned on each page. The default is // 100. You cannot specify a number greater than 100. If you specify 0, AWS Config // uses the default. Limit *int32 - // The name of the configuration aggregator. - // - // This member is required. - ConfigurationAggregatorName *string + // The nextToken string returned on a previous page that you use to get the next + // page of results in a paginated response. + NextToken *string } type ListAggregateDiscoveredResourcesOutput struct { diff --git a/service/configservice/api_op_ListDiscoveredResources.go b/service/configservice/api_op_ListDiscoveredResources.go index 7b4ba624d5d..277c6d593d3 100644 --- a/service/configservice/api_op_ListDiscoveredResources.go +++ b/service/configservice/api_op_ListDiscoveredResources.go @@ -68,24 +68,24 @@ func (c *Client) ListDiscoveredResources(ctx context.Context, params *ListDiscov // type ListDiscoveredResourcesInput struct { - // The maximum number of resource identifiers returned on each page. The default is - // 100. You cannot specify a number greater than 100. If you specify 0, AWS Config - // uses the default. - Limit *int32 + // The type of resources that you want AWS Config to list in the response. + // + // This member is required. + ResourceType types.ResourceType // Specifies whether AWS Config includes deleted resources in the results. By // default, deleted resources are not included. IncludeDeletedResources *bool + // The maximum number of resource identifiers returned on each page. The default is + // 100. You cannot specify a number greater than 100. If you specify 0, AWS Config + // uses the default. + Limit *int32 + // The nextToken string returned on a previous page that you use to get the next // page of results in a paginated response. NextToken *string - // The type of resources that you want AWS Config to list in the response. - // - // This member is required. - ResourceType types.ResourceType - // The IDs of only those resources that you want AWS Config to list in the // response. If you do not specify this parameter, AWS Config lists all resources // of the specified type that it has discovered. diff --git a/service/configservice/api_op_ListTagsForResource.go b/service/configservice/api_op_ListTagsForResource.go index 3b0e3d1cc43..32506b286c9 100644 --- a/service/configservice/api_op_ListTagsForResource.go +++ b/service/configservice/api_op_ListTagsForResource.go @@ -57,32 +57,32 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The nextToken string returned on a previous page that you use to get the next - // page of results in a paginated response. - NextToken *string - - // The maximum number of tags returned on each page. The limit maximum is 50. You - // cannot specify a number greater than 50. If you specify 0, AWS Config uses the - // default. - Limit *int32 - // The Amazon Resource Name (ARN) that identifies the resource for which to list // the tags. Currently, the supported resources are ConfigRule, // ConfigurationAggregator and AggregatorAuthorization. // // This member is required. ResourceArn *string + + // The maximum number of tags returned on each page. The limit maximum is 50. You + // cannot specify a number greater than 50. If you specify 0, AWS Config uses the + // default. + Limit *int32 + + // The nextToken string returned on a previous page that you use to get the next + // page of results in a paginated response. + NextToken *string } type ListTagsForResourceOutput struct { - // The tags for the resource. - Tags []*types.Tag - // The nextToken string returned on a previous page that you use to get the next // page of results in a paginated response. NextToken *string + // The tags for the resource. + Tags []*types.Tag + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/configservice/api_op_PutConfigRule.go b/service/configservice/api_op_PutConfigRule.go index f56ed658820..57dcd4db6b1 100644 --- a/service/configservice/api_op_PutConfigRule.go +++ b/service/configservice/api_op_PutConfigRule.go @@ -83,13 +83,13 @@ func (c *Client) PutConfigRule(ctx context.Context, params *PutConfigRuleInput, type PutConfigRuleInput struct { - // An array of tag object. - Tags []*types.Tag - // The rule that you want to add to your account. // // This member is required. ConfigRule *types.ConfigRule + + // An array of tag object. + Tags []*types.Tag } type PutConfigRuleOutput struct { diff --git a/service/configservice/api_op_PutConfigurationAggregator.go b/service/configservice/api_op_PutConfigurationAggregator.go index 7b14bcf0a02..ac98aeca171 100644 --- a/service/configservice/api_op_PutConfigurationAggregator.go +++ b/service/configservice/api_op_PutConfigurationAggregator.go @@ -63,19 +63,19 @@ func (c *Client) PutConfigurationAggregator(ctx context.Context, params *PutConf type PutConfigurationAggregatorInput struct { + // The name of the configuration aggregator. + // + // This member is required. + ConfigurationAggregatorName *string + // A list of AccountAggregationSource object.

    AccountAggregationSources []*types.AccountAggregationSource - // An array of tag object. - Tags []*types.Tag - // An OrganizationAggregationSource object. OrganizationAggregationSource *types.OrganizationAggregationSource - // The name of the configuration aggregator. - // - // This member is required. - ConfigurationAggregatorName *string + // An array of tag object. + Tags []*types.Tag } type PutConfigurationAggregatorOutput struct { diff --git a/service/configservice/api_op_PutConformancePack.go b/service/configservice/api_op_PutConformancePack.go index c718bf3a261..6a98a972467 100644 --- a/service/configservice/api_op_PutConformancePack.go +++ b/service/configservice/api_op_PutConformancePack.go @@ -64,33 +64,33 @@ func (c *Client) PutConformancePack(ctx context.Context, params *PutConformanceP type PutConformancePackInput struct { - // AWS Config stores intermediate files while processing conformance pack template. + // Name of the conformance pack you want to create. // // This member is required. - DeliveryS3Bucket *string + ConformancePackName *string - // Name of the conformance pack you want to create. + // AWS Config stores intermediate files while processing conformance pack template. // // This member is required. - ConformancePackName *string + DeliveryS3Bucket *string - // Location of file containing the template body (s3://bucketname/prefix). The uri - // must point to the conformance pack template (max size: 300 KB) that is located - // in an Amazon S3 bucket in the same region as the conformance pack. You must have - // access to read Amazon S3 bucket. - TemplateS3Uri *string + // A list of ConformancePackInputParameter objects. + ConformancePackInputParameters []*types.ConformancePackInputParameter // The prefix for the Amazon S3 bucket. DeliveryS3KeyPrefix *string - // A list of ConformancePackInputParameter objects. - ConformancePackInputParameters []*types.ConformancePackInputParameter - // A string containing full conformance pack template body. Structure containing // the template body with a minimum length of 1 byte and a maximum length of 51,200 // bytes. You can only use a YAML template with one resource type, that is, config // rule and a remediation action. TemplateBody *string + + // Location of file containing the template body (s3://bucketname/prefix). The uri + // must point to the conformance pack template (max size: 300 KB) that is located + // in an Amazon S3 bucket in the same region as the conformance pack. You must have + // access to read Amazon S3 bucket. + TemplateS3Uri *string } type PutConformancePackOutput struct { diff --git a/service/configservice/api_op_PutEvaluations.go b/service/configservice/api_op_PutEvaluations.go index 9ae414cffb9..57d28f26150 100644 --- a/service/configservice/api_op_PutEvaluations.go +++ b/service/configservice/api_op_PutEvaluations.go @@ -60,17 +60,17 @@ func (c *Client) PutEvaluations(ctx context.Context, params *PutEvaluationsInput // type PutEvaluationsInput struct { - // The assessments that the AWS Lambda function performs. Each evaluation - // identifies an AWS resource and indicates whether it complies with the AWS Config - // rule that invokes the AWS Lambda function. - Evaluations []*types.Evaluation - // An encrypted token that associates an evaluation with an AWS Config rule. // Identifies the rule and the event that triggered the evaluation. // // This member is required. ResultToken *string + // The assessments that the AWS Lambda function performs. Each evaluation + // identifies an AWS resource and indicates whether it complies with the AWS Config + // rule that invokes the AWS Lambda function. + Evaluations []*types.Evaluation + // Use this parameter to specify a test run for PutEvaluations. You can verify // whether your AWS Lambda function will deliver evaluation results to AWS Config. // No updates occur to your existing evaluations, and evaluation results are not diff --git a/service/configservice/api_op_PutOrganizationConfigRule.go b/service/configservice/api_op_PutOrganizationConfigRule.go index 2acfe9dd2e2..009b220eafc 100644 --- a/service/configservice/api_op_PutOrganizationConfigRule.go +++ b/service/configservice/api_op_PutOrganizationConfigRule.go @@ -81,20 +81,20 @@ func (c *Client) PutOrganizationConfigRule(ctx context.Context, params *PutOrgan type PutOrganizationConfigRuleInput struct { - // An OrganizationCustomRuleMetadata object. - OrganizationCustomRuleMetadata *types.OrganizationCustomRuleMetadata + // The name that you assign to an organization config rule. + // + // This member is required. + OrganizationConfigRuleName *string // A comma-separated list of accounts that you want to exclude from an organization // config rule. ExcludedAccounts []*string + // An OrganizationCustomRuleMetadata object. + OrganizationCustomRuleMetadata *types.OrganizationCustomRuleMetadata + // An OrganizationManagedRuleMetadata object. OrganizationManagedRuleMetadata *types.OrganizationManagedRuleMetadata - - // The name that you assign to an organization config rule. - // - // This member is required. - OrganizationConfigRuleName *string } type PutOrganizationConfigRuleOutput struct { diff --git a/service/configservice/api_op_PutOrganizationConformancePack.go b/service/configservice/api_op_PutOrganizationConformancePack.go index 2273c9b615a..71c2c0635a3 100644 --- a/service/configservice/api_op_PutOrganizationConformancePack.go +++ b/service/configservice/api_op_PutOrganizationConformancePack.go @@ -87,16 +87,6 @@ type PutOrganizationConformancePackInput struct { // This member is required. DeliveryS3Bucket *string - // A string containing full conformance pack template body. Structure containing - // the template body with a minimum length of 1 byte and a maximum length of 51,200 - // bytes. - TemplateBody *string - - // Location of file containing the template body. The uri must point to the - // conformance pack template (max size: 300 KB). You must have access to read - // Amazon S3 bucket. - TemplateS3Uri *string - // Name of the organization conformance pack you want to create. // // This member is required. @@ -111,6 +101,16 @@ type PutOrganizationConformancePackInput struct { // A list of AWS accounts to be excluded from an organization conformance pack // while deploying a conformance pack. ExcludedAccounts []*string + + // A string containing full conformance pack template body. Structure containing + // the template body with a minimum length of 1 byte and a maximum length of 51,200 + // bytes. + TemplateBody *string + + // Location of file containing the template body. The uri must point to the + // conformance pack template (max size: 300 KB). You must have access to read + // Amazon S3 bucket. + TemplateS3Uri *string } type PutOrganizationConformancePackOutput struct { diff --git a/service/configservice/api_op_PutResourceConfig.go b/service/configservice/api_op_PutResourceConfig.go index a002866304e..bb938e2c425 100644 --- a/service/configservice/api_op_PutResourceConfig.go +++ b/service/configservice/api_op_PutResourceConfig.go @@ -66,19 +66,6 @@ func (c *Client) PutResourceConfig(ctx context.Context, params *PutResourceConfi type PutResourceConfigInput struct { - // Unique identifier of the resource. - // - // This member is required. - ResourceId *string - - // Version of the schema registered for the ResourceType in AWS CloudFormation. - // - // This member is required. - SchemaVersionId *string - - // Tags associated with the resource. - Tags map[string]*string - // The configuration object of the resource in valid JSON format. It must match the // schema registered with AWS CloudFormation. The configuration JSON must not // exceed 64 KB. @@ -86,8 +73,10 @@ type PutResourceConfigInput struct { // This member is required. Configuration *string - // Name of the resource. - ResourceName *string + // Unique identifier of the resource. + // + // This member is required. + ResourceId *string // The type of the resource. The custom resource type must be registered with AWS // CloudFormation. You cannot use the organization names “aws”, “amzn”, “amazon”, @@ -96,6 +85,17 @@ type PutResourceConfigInput struct { // // This member is required. ResourceType *string + + // Version of the schema registered for the ResourceType in AWS CloudFormation. + // + // This member is required. + SchemaVersionId *string + + // Name of the resource. + ResourceName *string + + // Tags associated with the resource. + Tags map[string]*string } type PutResourceConfigOutput struct { diff --git a/service/configservice/api_op_SelectAggregateResourceConfig.go b/service/configservice/api_op_SelectAggregateResourceConfig.go index fb91e50d093..2d58603ad62 100644 --- a/service/configservice/api_op_SelectAggregateResourceConfig.go +++ b/service/configservice/api_op_SelectAggregateResourceConfig.go @@ -63,33 +63,30 @@ func (c *Client) SelectAggregateResourceConfig(ctx context.Context, params *Sele type SelectAggregateResourceConfigInput struct { - // The maximum number of query results returned on each page. AWS Config also - // allows the Limit request parameter. - MaxResults *int32 - - // The maximum number of query results returned on each page. - Limit *int32 - // The name of the configuration aggregator. // // This member is required. ConfigurationAggregatorName *string - // The nextToken string returned in a previous request that you use to request the - // next page of results in a paginated response. - NextToken *string - // The SQL query SELECT command. // // This member is required. Expression *string + + // The maximum number of query results returned on each page. + Limit *int32 + + // The maximum number of query results returned on each page. AWS Config also + // allows the Limit request parameter. + MaxResults *int32 + + // The nextToken string returned in a previous request that you use to request the + // next page of results in a paginated response. + NextToken *string } type SelectAggregateResourceConfigOutput struct { - // Returns the results for the SQL query. - Results []*string - // The nextToken string returned in a previous request that you use to request the // next page of results in a paginated response. NextToken *string @@ -97,6 +94,9 @@ type SelectAggregateResourceConfigOutput struct { // Details about the query. QueryInfo *types.QueryInfo + // Returns the results for the SQL query. + Results []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/configservice/api_op_SelectResourceConfig.go b/service/configservice/api_op_SelectResourceConfig.go index e02571b52e4..fd12c611ff9 100644 --- a/service/configservice/api_op_SelectResourceConfig.go +++ b/service/configservice/api_op_SelectResourceConfig.go @@ -62,28 +62,28 @@ func (c *Client) SelectResourceConfig(ctx context.Context, params *SelectResourc type SelectResourceConfigInput struct { - // The nextToken string returned in a previous request that you use to request the - // next page of results in a paginated response. - NextToken *string - - // The maximum number of query results returned on each page. - Limit *int32 - // The SQL query SELECT command. // // This member is required. Expression *string + + // The maximum number of query results returned on each page. + Limit *int32 + + // The nextToken string returned in a previous request that you use to request the + // next page of results in a paginated response. + NextToken *string } type SelectResourceConfigOutput struct { - // Returns the QueryInfo object. - QueryInfo *types.QueryInfo - // The nextToken string returned in a previous request that you use to request the // next page of results in a paginated response. NextToken *string + // Returns the QueryInfo object. + QueryInfo *types.QueryInfo + // Returns the results for the SQL query. Results []*string diff --git a/service/configservice/api_op_StartRemediationExecution.go b/service/configservice/api_op_StartRemediationExecution.go index 52f7ca417eb..2d3d73b9c28 100644 --- a/service/configservice/api_op_StartRemediationExecution.go +++ b/service/configservice/api_op_StartRemediationExecution.go @@ -61,28 +61,28 @@ func (c *Client) StartRemediationExecution(ctx context.Context, params *StartRem type StartRemediationExecutionInput struct { - // A list of resource keys to be processed with the current request. Each element - // in the list consists of the resource type and resource ID. - // - // This member is required. - ResourceKeys []*types.ResourceKey - // The list of names of AWS Config rules that you want to run remediation execution // for. // // This member is required. ConfigRuleName *string + + // A list of resource keys to be processed with the current request. Each element + // in the list consists of the resource type and resource ID. + // + // This member is required. + ResourceKeys []*types.ResourceKey } type StartRemediationExecutionOutput struct { - // Returns a failure message. For example, the resource is already compliant. - FailureMessage *string - // For resources that have failed to start execution, the API returns a resource // key object. FailedItems []*types.ResourceKey + // Returns a failure message. For example, the resource is already compliant. + FailureMessage *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/configservice/api_op_UntagResource.go b/service/configservice/api_op_UntagResource.go index 2065c8cc856..c329137c71b 100644 --- a/service/configservice/api_op_UntagResource.go +++ b/service/configservice/api_op_UntagResource.go @@ -56,17 +56,17 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The keys of the tags to be removed. - // - // This member is required. - TagKeys []*string - // The Amazon Resource Name (ARN) that identifies the resource for which to list // the tags. Currently, the supported resources are ConfigRule, // ConfigurationAggregator and AggregatorAuthorization. // // This member is required. ResourceArn *string + + // The keys of the tags to be removed. + // + // This member is required. + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/configservice/go.mod b/service/configservice/go.mod index 2657e1be11e..3c36300cc8d 100644 --- a/service/configservice/go.mod +++ b/service/configservice/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/configservice go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/configservice/types/types.go b/service/configservice/types/types.go index 81bb3c9a880..31ae9637d8d 100644 --- a/service/configservice/types/types.go +++ b/service/configservice/types/types.go @@ -9,16 +9,16 @@ import ( // A collection of accounts and regions. type AccountAggregationSource struct { + // The 12-digit account ID of the account being aggregated. + // + // This member is required. + AccountIds []*string + // If true, aggregate existing AWS Config regions and future regions. AllAwsRegions *bool // The source regions being aggregated. AwsRegions []*string - - // The 12-digit account ID of the account being aggregated. - // - // This member is required. - AccountIds []*string } // Indicates whether an AWS Config rule is compliant based on account ID, region, @@ -27,15 +27,15 @@ type AccountAggregationSource struct { // not comply. type AggregateComplianceByConfigRule struct { - // Indicates whether an AWS resource or AWS Config rule is compliant and provides - // the number of contributors that affect the compliance. - Compliance *Compliance + // The 12-digit account ID of the source account. + AccountId *string // The source region from where the data is aggregated. AwsRegion *string - // The 12-digit account ID of the source account. - AccountId *string + // Indicates whether an AWS resource or AWS Config rule is compliant and provides + // the number of contributors that affect the compliance. + Compliance *Compliance // The name of the AWS Config rule. ConfigRuleName *string @@ -45,21 +45,26 @@ type AggregateComplianceByConfigRule struct { // and regions in an aggregator. type AggregateComplianceCount struct { - // The 12-digit account ID or region based on the GroupByKey value. - GroupName *string - // The number of compliant and noncompliant AWS Config rules. ComplianceSummary *ComplianceSummary + + // The 12-digit account ID or region based on the GroupByKey value. + GroupName *string } // The current sync status between the source and the aggregator account. type AggregatedSourceStatus struct { - // The source account ID or an organization. - SourceId *string + // The region authorized to collect aggregated data. + AwsRegion *string - // The time of the last update. - LastUpdateTime *time.Time + // The error code that AWS Config returned when the source account aggregation last + // failed. + LastErrorCode *string + + // The message indicating that the source account aggregation failed due to an + // error. + LastErrorMessage *string // Filters the last updated status type. // @@ -73,19 +78,14 @@ type AggregatedSourceStatus struct { // most recent. LastUpdateStatus AggregatedSourceStatusType - // The message indicating that the source account aggregation failed due to an - // error. - LastErrorMessage *string + // The time of the last update. + LastUpdateTime *time.Time - // The error code that AWS Config returned when the source account aggregation last - // failed. - LastErrorCode *string + // The source account ID or an organization. + SourceId *string // The source account or an organization. SourceType AggregatedSourceType - - // The region authorized to collect aggregated data. - AwsRegion *string } // The details of an AWS Config evaluation for an account ID and region in an @@ -93,10 +93,8 @@ type AggregatedSourceStatus struct { // resource, related time stamps, and supplementary information. type AggregateEvaluationResult struct { - // The resource compliance status. For the AggregationEvaluationResult data type, - // AWS Config supports only the COMPLIANT and NON_COMPLIANT. AWS Config does not - // support the NOT_APPLICABLE and INSUFFICIENT_DATA value. - ComplianceType ComplianceType + // The 12-digit account ID of the source account. + AccountId *string // Supplementary information about how the agrregate evaluation determined the // compliance. @@ -105,15 +103,17 @@ type AggregateEvaluationResult struct { // The source region from where the data is aggregated. AwsRegion *string - // The 12-digit account ID of the source account. - AccountId *string - - // Uniquely identifies the evaluation result. - EvaluationResultIdentifier *EvaluationResultIdentifier + // The resource compliance status. For the AggregationEvaluationResult data type, + // AWS Config supports only the COMPLIANT and NON_COMPLIANT. AWS Config does not + // support the NOT_APPLICABLE and INSUFFICIENT_DATA value. + ComplianceType ComplianceType // The time when the AWS Config rule evaluated the AWS resource. ConfigRuleInvokedTime *time.Time + // Uniquely identifies the evaluation result. + EvaluationResultIdentifier *EvaluationResultIdentifier + // The time when AWS Config recorded the aggregate evaluation result. ResultRecordedTime *time.Time } @@ -123,84 +123,64 @@ type AggregateEvaluationResult struct { // source account, and source region. type AggregateResourceIdentifier struct { - // The source region where data is aggregated. + // The ID of the AWS resource. // // This member is required. - SourceRegion *string + ResourceId *string - // The 12-digit account ID of the source account. + // The type of the AWS resource. // // This member is required. - SourceAccountId *string - - // The name of the AWS resource. - ResourceName *string + ResourceType ResourceType - // The ID of the AWS resource. + // The 12-digit account ID of the source account. // // This member is required. - ResourceId *string + SourceAccountId *string - // The type of the AWS resource. + // The source region where data is aggregated. // // This member is required. - ResourceType ResourceType + SourceRegion *string + + // The name of the AWS resource. + ResourceName *string } // An object that represents the authorizations granted to aggregator accounts and // regions. type AggregationAuthorization struct { - // The time stamp when the aggregation authorization was created. - CreationTime *time.Time + // The Amazon Resource Name (ARN) of the aggregation object. + AggregationAuthorizationArn *string // The 12-digit account ID of the account authorized to aggregate data. AuthorizedAccountId *string - // The Amazon Resource Name (ARN) of the aggregation object. - AggregationAuthorizationArn *string - // The region authorized to collect aggregated data. AuthorizedAwsRegion *string + + // The time stamp when the aggregation authorization was created. + CreationTime *time.Time } // The detailed configuration of a specified resource. type BaseConfigurationItem struct { - // An identifier that indicates the ordering of the configuration items of a - // resource. - ConfigurationStateId *string - // The 12-digit AWS account ID associated with the resource. AccountId *string - // The type of AWS resource. - ResourceType ResourceType - - // Configuration attributes that AWS Config returns for certain resource types to - // supplement the information returned for the configuration parameter. - SupplementaryConfiguration map[string]*string - - // The custom name of the resource, if available. - ResourceName *string - - // The version number of the resource configuration. - Version *string - - // The description of the resource configuration. - Configuration *string + // The Amazon Resource Name (ARN) of the resource. + Arn *string - // The ID of the resource (for example., sg-xxxxxx). - ResourceId *string + // The Availability Zone associated with the resource. + AvailabilityZone *string // The region where the resource resides. AwsRegion *string - // The Availability Zone associated with the resource. - AvailabilityZone *string - - // The Amazon Resource Name (ARN) of the resource. - Arn *string + // The description of the resource configuration. + Configuration *string // The time when the configuration recording was initiated. ConfigurationItemCaptureTime *time.Time @@ -216,8 +196,28 @@ type BaseConfigurationItem struct { // type

    The CIs do not incur any cost.

     ConfigurationItemStatus ConfigurationItemStatus + // An identifier that indicates the ordering of the configuration items of a + // resource. + ConfigurationStateId *string + // The time stamp when the resource was created. ResourceCreationTime *time.Time + + // The ID of the resource (for example., sg-xxxxxx). + ResourceId *string + + // The custom name of the resource, if available. + ResourceName *string + + // The type of AWS resource. + ResourceType ResourceType + + // Configuration attributes that AWS Config returns for certain resource types to + // supplement the information returned for the configuration parameter. + SupplementaryConfiguration map[string]*string + + // The version number of the resource configuration. + Version *string } // Indicates whether an AWS resource or AWS Config rule is compliant and provides @@ -258,15 +258,15 @@ type ComplianceByConfigRule struct { // with one or more of these rules. type ComplianceByResource struct { + // Indicates whether the AWS resource complies with all of the AWS Config rules + // that evaluated it. + Compliance *Compliance + // The ID of the AWS resource that was evaluated. ResourceId *string // The type of the AWS resource that was evaluated. ResourceType *string - - // Indicates whether the AWS resource complies with all of the AWS Config rules - // that evaluated it. - Compliance *Compliance } // The number of AWS resources or AWS Config rules responsible for the current @@ -285,16 +285,16 @@ type ComplianceContributorCount struct { // noncompliant. type ComplianceSummary struct { - // The number of AWS Config rules or AWS resources that are noncompliant, up to a - // maximum of 25 for rules and 100 for resources. - NonCompliantResourceCount *ComplianceContributorCount - // The time that AWS Config created the compliance summary. ComplianceSummaryTimestamp *time.Time // The number of AWS Config rules or AWS resources that are compliant, up to a // maximum of 25 for rules and 100 for resources. CompliantResourceCount *ComplianceContributorCount + + // The number of AWS Config rules or AWS resources that are noncompliant, up to a + // maximum of 25 for rules and 100 for resources. + NonCompliantResourceCount *ComplianceContributorCount } // The number of AWS resources of a specific type that are compliant or @@ -314,23 +314,23 @@ type ComplianceSummaryByResourceType struct { // the Amazon S3 delivery to the specified Amazon SNS topic. type ConfigExportDeliveryInfo struct { - // Status of the last attempted delivery. - LastStatus DeliveryStatus - // The time of the last attempted delivery. LastAttemptTime *time.Time - // The time of the last successful delivery. - LastSuccessfulTime *time.Time - - // The time that the next delivery occurs. - NextDeliveryTime *time.Time - // The error code from the last attempted delivery. LastErrorCode *string // The error message from the last attempted delivery. LastErrorMessage *string + + // Status of the last attempted delivery. + LastStatus DeliveryStatus + + // The time of the last successful delivery. + LastSuccessfulTime *time.Time + + // The time that the next delivery occurs. + NextDeliveryTime *time.Time } // An AWS Config rule represents an AWS Lambda function that you create for a @@ -348,6 +348,22 @@ type ConfigExportDeliveryInfo struct { // Guide.

    type ConfigRule struct { + // Provides the rule owner (AWS or customer), the rule identifier, and the + // notifications that cause the function to evaluate your AWS resources. + // + // This member is required. + Source *Source + + // The Amazon Resource Name (ARN) of the AWS Config rule. + ConfigRuleArn *string + + // The ID of the AWS Config rule. + ConfigRuleId *string + + // The name that you assign to the AWS Config rule. The name is required if you are + // adding a new rule. + ConfigRuleName *string + // Indicates whether the AWS Config rule is active or is currently being deleted by // AWS Config. It can also indicate the evaluation status for the AWS Config rule. //

    AWS Config sets the state of the rule to EVALUATING temporarily @@ -361,28 +377,17 @@ type ConfigRule struct { // of its evaluations are erased and are no longer available.

    ConfigRuleState ConfigRuleState - // Provides the rule owner (AWS or customer), the rule identifier, and the - // notifications that cause the function to evaluate your AWS resources. - // - // This member is required. - Source *Source - - // The Amazon Resource Name (ARN) of the AWS Config rule. - ConfigRuleArn *string - - // Defines which resources can trigger an evaluation for the rule. The scope can - // include one or more resource types, a combination of one resource type and one - // resource ID, or a combination of a tag key and value. Specify a scope to - // constrain the resources that can trigger an evaluation for the rule. If you do - // not specify a scope, evaluations are triggered when any resource in the - // recording group changes. The scope can be empty. - Scope *Scope - // Service principal name of the service that created the rule. The field is // populated only if the service linked rule is created by a service. The field is // empty if you create your own rule. CreatedBy *string + // The description that you provide for the AWS Config rule. + Description *string + + // A string, in JSON format, that is passed to the AWS Config rule Lambda function. + InputParameters *string + // The maximum frequency with which AWS Config runs evaluations for a rule. You can // specify a value for MaximumExecutionFrequency when: // @@ -399,47 +404,42 @@ type ConfigRule struct { // parameter.

    MaximumExecutionFrequency MaximumExecutionFrequency - // The ID of the AWS Config rule. - ConfigRuleId *string - - // A string, in JSON format, that is passed to the AWS Config rule Lambda function. - InputParameters *string - - // The description that you provide for the AWS Config rule. - Description *string - - // The name that you assign to the AWS Config rule. The name is required if you are - // adding a new rule. - ConfigRuleName *string + // Defines which resources can trigger an evaluation for the rule. The scope can + // include one or more resource types, a combination of one resource type and one + // resource ID, or a combination of a tag key and value. Specify a scope to + // constrain the resources that can trigger an evaluation for the rule. If you do + // not specify a scope, evaluations are triggered when any resource in the + // recording group changes. The scope can be empty. + Scope *Scope } // Filters the compliance results based on account ID, region, compliance type, and // rule name. type ConfigRuleComplianceFilters struct { - // The name of the AWS Config rule. - ConfigRuleName *string + // The 12-digit account ID of the source account. + AccountId *string // The source region where the data is aggregated. AwsRegion *string - // The 12-digit account ID of the source account. - AccountId *string - // The rule compliance status. For the ConfigRuleComplianceFilters data type, AWS // Config supports only COMPLIANT and NON_COMPLIANT. AWS Config does not support // the NOT_APPLICABLE and the INSUFFICIENT_DATA values. ComplianceType ComplianceType + + // The name of the AWS Config rule. + ConfigRuleName *string } // Filters the results based on the account IDs and regions. type ConfigRuleComplianceSummaryFilters struct { - // The source region where the data is aggregated. - AwsRegion *string - // The 12-digit account ID of the source account. AccountId *string + + // The source region where the data is aggregated. + AwsRegion *string } // Status information for your AWS managed Config rules. The status includes @@ -448,16 +448,17 @@ type ConfigRuleComplianceSummaryFilters struct { // information about custom AWS Config rules. type ConfigRuleEvaluationStatus struct { - // The error code that AWS Config returned when the rule last failed. - LastErrorCode *string + // The Amazon Resource Name (ARN) of the AWS Config rule. + ConfigRuleArn *string - // The time that AWS Config last failed to invoke the AWS Config rule to evaluate - // your AWS resources. - LastFailedInvocationTime *time.Time + // The ID of the AWS Config rule. + ConfigRuleId *string - // The time that AWS Config last failed to evaluate your AWS resources against the - // rule. - LastFailedEvaluationTime *time.Time + // The name of the AWS Config rule. + ConfigRuleName *string + + // The time that you first activated the AWS Config rule. + FirstActivatedTime *time.Time // Indicates whether AWS Config has evaluated your resources against the rule at // least once. @@ -469,31 +470,30 @@ type ConfigRuleEvaluationStatus struct { // evaluating your AWS resources against the rule. FirstEvaluationStarted *bool - // The time that AWS Config last successfully evaluated your AWS resources against - // the rule. - LastSuccessfulEvaluationTime *time.Time - - // The ID of the AWS Config rule. - ConfigRuleId *string - // The time that you last turned off the AWS Config rule. LastDeactivatedTime *time.Time - // The time that you first activated the AWS Config rule. - FirstActivatedTime *time.Time + // The error code that AWS Config returned when the rule last failed. + LastErrorCode *string - // The time that AWS Config last successfully invoked the AWS Config rule to - // evaluate your AWS resources. - LastSuccessfulInvocationTime *time.Time + // The error message that AWS Config returned when the rule last failed. + LastErrorMessage *string - // The Amazon Resource Name (ARN) of the AWS Config rule. - ConfigRuleArn *string + // The time that AWS Config last failed to evaluate your AWS resources against the + // rule. + LastFailedEvaluationTime *time.Time - // The name of the AWS Config rule. - ConfigRuleName *string + // The time that AWS Config last failed to invoke the AWS Config rule to evaluate + // your AWS resources. + LastFailedInvocationTime *time.Time - // The error message that AWS Config returned when the rule last failed. - LastErrorMessage *string + // The time that AWS Config last successfully evaluated your AWS resources against + // the rule. + LastSuccessfulEvaluationTime *time.Time + + // The time that AWS Config last successfully invoked the AWS Config rule to + // evaluate your AWS resources. + LastSuccessfulInvocationTime *time.Time } // Provides options for how often AWS Config delivers configuration snapshots to @@ -534,6 +534,12 @@ type ConfigSnapshotDeliveryProperties struct { // notification to the Amazon SNS topic. type ConfigStreamDeliveryInfo struct { + // The error code from the last attempted delivery. + LastErrorCode *string + + // The error message from the last attempted delivery. + LastErrorMessage *string + // Status of the last attempted delivery. Note Providing an SNS topic on a // DeliveryChannel // (https://docs.aws.amazon.com/config/latest/APIReference/API_DeliveryChannel.html) @@ -543,56 +549,74 @@ type ConfigStreamDeliveryInfo struct { // The time from the last status change. LastStatusChangeTime *time.Time - - // The error code from the last attempted delivery. - LastErrorCode *string - - // The error message from the last attempted delivery. - LastErrorMessage *string } // The details about the configuration aggregator, including information about // source accounts, regions, and metadata of the aggregator. type ConfigurationAggregator struct { - // AWS service that created the configuration aggregator. - CreatedBy *string - - // The Amazon Resource Name (ARN) of the aggregator. - ConfigurationAggregatorArn *string - // Provides a list of source accounts and regions to be aggregated. AccountAggregationSources []*AccountAggregationSource - // Provides an organization and list of regions to be aggregated. - OrganizationAggregationSource *OrganizationAggregationSource + // The Amazon Resource Name (ARN) of the aggregator. + ConfigurationAggregatorArn *string // The name of the aggregator. ConfigurationAggregatorName *string + // AWS service that created the configuration aggregator. + CreatedBy *string + // The time stamp when the configuration aggregator was created. CreationTime *time.Time // The time of the last update. LastUpdatedTime *time.Time + + // Provides an organization and list of regions to be aggregated. + OrganizationAggregationSource *OrganizationAggregationSource } // A list that contains detailed configurations of a specified resource. type ConfigurationItem struct { + // The 12-digit AWS account ID associated with the resource. + AccountId *string + + // accoun + Arn *string + + // The Availability Zone associated with the resource. + AvailabilityZone *string + // The region where the resource resides. AwsRegion *string + // The description of the resource configuration. + Configuration *string + + // The time when the configuration recording was initiated. + ConfigurationItemCaptureTime *time.Time + // Unique MD5 hash that represents the configuration item's state. You can use MD5 // hash to compare the states of two or more configuration items that are // associated with the same resource. ConfigurationItemMD5Hash *string - // The ID of the resource (for example, sg-xxxxxx). - ResourceId *string + // The configuration item status. The valid values are:

    The CIs do not incur any cost.

     + ConfigurationItemStatus ConfigurationItemStatus - // The type of AWS resource. - ResourceType ResourceType + // An identifier that indicates the ordering of the configuration items of a + // resource. + ConfigurationStateId *string // A list of CloudTrail event IDs. A populated field indicates that the current // configuration was initiated by the events recorded in the CloudTrail log. For @@ -608,45 +632,21 @@ type ConfigurationItem struct { // A list of related AWS resources. Relationships []*Relationship - // The 12-digit AWS account ID associated with the resource. - AccountId *string - - // An identifier that indicates the ordering of the configuration items of a - // resource. - ConfigurationStateId *string - - // accoun - Arn *string - // The time stamp when the resource was created. ResourceCreationTime *time.Time - // Configuration attributes that AWS Config returns for certain resource types to - // supplement the information returned for the configuration parameter. - SupplementaryConfiguration map[string]*string - - // The configuration item status. The valid values are:

    The CIs do not incur any cost.

     - ConfigurationItemStatus ConfigurationItemStatus - - // The time when the configuration recording was initiated. - ConfigurationItemCaptureTime *time.Time - - // The description of the resource configuration. - Configuration *string + // The ID of the resource (for example, sg-xxxxxx). + ResourceId *string // The custom name of the resource, if available. ResourceName *string - // The Availability Zone associated with the resource. - AvailabilityZone *string + // The type of AWS resource. + ResourceType ResourceType + + // Configuration attributes that AWS Config returns for certain resource types to + // supplement the information returned for the configuration parameter. + SupplementaryConfiguration map[string]*string // A mapping of key value tags associated with the resource. Tags map[string]*string @@ -659,6 +659,11 @@ type ConfigurationItem struct { // resource. type ConfigurationRecorder struct { + // The name of the recorder. By default, AWS Config automatically assigns the name + // "default" when creating the configuration recorder. You cannot change the + // assigned name. + Name *string + // Specifies the types of AWS resources for which AWS Config records configuration // changes. RecordingGroup *RecordingGroup @@ -666,25 +671,14 @@ type ConfigurationRecorder struct { // Amazon Resource Name (ARN) of the IAM role used to describe the AWS resources // associated with the account. RoleARN *string - - // The name of the recorder. By default, AWS Config automatically assigns the name - // "default" when creating the configuration recorder. You cannot change the - // assigned name. - Name *string } // The current status of the configuration recorder. type ConfigurationRecorderStatus struct { - // Specifies whether or not the recorder is currently recording. - Recording *bool - // The error code indicating that the recording failed. LastErrorCode *string - // The time when the status was last changed. - LastStatusChangeTime *time.Time - // The message indicating that the recording failed due to an error. LastErrorMessage *string @@ -694,11 +688,17 @@ type ConfigurationRecorderStatus struct { // The last (previous) status of the recorder. LastStatus RecorderStatus - // The name of the configuration recorder. - Name *string + // The time when the status was last changed. + LastStatusChangeTime *time.Time // The time the recorder was last stopped. LastStopTime *time.Time + + // The name of the configuration recorder. + Name *string + + // Specifies whether or not the recorder is currently recording. + Recording *bool } // Filters the conformance pack by compliance types and AWS Config rule names. @@ -732,47 +732,48 @@ type ConformancePackComplianceSummary struct { // and a region. type ConformancePackDetail struct { - // Conformance pack template that is used to create a pack. The delivery bucket - // name should start with awsconfigconforms. For example: "Resource": - // "arn:aws:s3:::your_bucket_name/*". - // - // This member is required. - DeliveryS3Bucket *string - // Amazon Resource Name (ARN) of the conformance pack. // // This member is required. ConformancePackArn *string - // AWS service that created the conformance pack. - CreatedBy *string - - // A list of ConformancePackInputParameter objects. - ConformancePackInputParameters []*ConformancePackInputParameter - // ID of the conformance pack. // // This member is required. ConformancePackId *string - // Last time when conformation pack update was requested. - LastUpdateRequestedTime *time.Time - // Name of the conformance pack. // // This member is required. ConformancePackName *string + // Conformance pack template that is used to create a pack. The delivery bucket + // name should start with awsconfigconforms. For example: "Resource": + // "arn:aws:s3:::your_bucket_name/*". + // + // This member is required. + DeliveryS3Bucket *string + + // A list of ConformancePackInputParameter objects. + ConformancePackInputParameters []*ConformancePackInputParameter + + // AWS service that created the conformance pack. + CreatedBy *string + // The prefix for the Amazon S3 bucket. DeliveryS3KeyPrefix *string + + // Last time when conformation pack update was requested. + LastUpdateRequestedTime *time.Time } // Filters a conformance pack by AWS Config rule names, compliance types, AWS // resource types, and resource IDs. type ConformancePackEvaluationFilters struct { - // Filters the results by the resource type (for example, "AWS::EC2::Instance"). - ResourceType *string + // Filters the results by compliance. The allowed values are COMPLIANT and + // NON_COMPLIANT. + ComplianceType ConformancePackComplianceType // Filters the results by AWS Config rule names. ConfigRuleNames []*string @@ -781,9 +782,8 @@ type ConformancePackEvaluationFilters struct { // resource type. If there is no resource type, you will see an error. ResourceIds []*string - // Filters the results by compliance. The allowed values are COMPLIANT and - // NON_COMPLIANT. - ComplianceType ConformancePackComplianceType + // Filters the results by the resource type (for example, "AWS::EC2::Instance"). + ResourceType *string } // The details of a conformance pack evaluation. Provides AWS Config rule and AWS @@ -796,15 +796,15 @@ type ConformancePackEvaluationResult struct { // This member is required. ComplianceType ConformancePackComplianceType - // Uniquely identifies an evaluation result. + // The time when AWS Config rule evaluated AWS resource. // // This member is required. - EvaluationResultIdentifier *EvaluationResultIdentifier + ConfigRuleInvokedTime *time.Time - // The time when AWS Config rule evaluated AWS resource. + // Uniquely identifies an evaluation result. // // This member is required. - ConfigRuleInvokedTime *time.Time + EvaluationResultIdentifier *EvaluationResultIdentifier // The time when AWS Config recorded the evaluation result. // @@ -820,15 +820,15 @@ type ConformancePackEvaluationResult struct { // and values can have a maximum length of 4096 characters. type ConformancePackInputParameter struct { - // Another part of the key-value pair. + // One part of a key-value pair. // // This member is required. - ParameterValue *string + ParameterName *string - // One part of a key-value pair. + // Another part of the key-value pair. // // This member is required. - ParameterName *string + ParameterValue *string } // Compliance information of one or more AWS Config rules within a conformance @@ -846,15 +846,15 @@ type ConformancePackRuleCompliance struct { // Status details of a conformance pack. type ConformancePackStatusDetail struct { - // ID of the conformance pack. + // Amazon Resource Name (ARN) of comformance pack. // // This member is required. - ConformancePackId *string + ConformancePackArn *string - // Last time when conformation pack creation and update was requested. + // ID of the conformance pack. // // This member is required. - LastUpdateRequestedTime *time.Time + ConformancePackId *string // Name of the conformance pack. // @@ -882,27 +882,38 @@ type ConformancePackStatusDetail struct { // This member is required. ConformancePackState ConformancePackState - // The reason of conformance pack creation failure. - ConformancePackStatusReason *string - - // Last time when conformation pack creation and update was successful. - LastUpdateCompletedTime *time.Time + // Last time when conformation pack creation and update was requested. + // + // This member is required. + LastUpdateRequestedTime *time.Time // Amazon Resource Name (ARN) of AWS CloudFormation stack. // // This member is required. StackArn *string - // Amazon Resource Name (ARN) of comformance pack. - // - // This member is required. - ConformancePackArn *string + // The reason of conformance pack creation failure. + ConformancePackStatusReason *string + + // Last time when conformation pack creation and update was successful. + LastUpdateCompletedTime *time.Time } // The channel through which AWS Config delivers notifications and updated // configuration states. type DeliveryChannel struct { + // The options for how often AWS Config delivers configuration snapshots to the + // Amazon S3 bucket. + ConfigSnapshotDeliveryProperties *ConfigSnapshotDeliveryProperties + + // The name of the delivery channel. By default, AWS Config assigns the name + // "default" when creating the delivery channel. To change the delivery channel + // name, you must use the DeleteDeliveryChannel action to delete your current + // delivery channel, and then you must use the PutDeliveryChannel command to create + // a delivery channel that has the desired name. + Name *string + // The name of the Amazon S3 bucket to which AWS Config delivers configuration // snapshots and configuration history files. If you specify a bucket that belongs // to another AWS account, that bucket must have policies that grant access @@ -915,17 +926,6 @@ type DeliveryChannel struct { // The prefix for the specified Amazon S3 bucket. S3KeyPrefix *string - // The name of the delivery channel. By default, AWS Config assigns the name - // "default" when creating the delivery channel. To change the delivery channel - // name, you must use the DeleteDeliveryChannel action to delete your current - // delivery channel, and then you must use the PutDeliveryChannel command to create - // a delivery channel that has the desired name. - Name *string - - // The options for how often AWS Config delivers configuration snapshots to the - // Amazon S3 bucket. - ConfigSnapshotDeliveryProperties *ConfigSnapshotDeliveryProperties - // The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends // notifications about configuration changes. If you choose a topic from another // account, the topic must have policies that grant access permissions to AWS @@ -942,31 +942,31 @@ type DeliveryChannelStatus struct { // the specified Amazon S3 bucket. ConfigHistoryDeliveryInfo *ConfigExportDeliveryInfo + // A list containing the status of the delivery of the snapshot to the specified + // Amazon S3 bucket. + ConfigSnapshotDeliveryInfo *ConfigExportDeliveryInfo + // A list containing the status of the delivery of the configuration stream // notification to the specified Amazon SNS topic. ConfigStreamDeliveryInfo *ConfigStreamDeliveryInfo // The name of the delivery channel. Name *string - - // A list containing the status of the delivery of the snapshot to the specified - // Amazon S3 bucket. - ConfigSnapshotDeliveryInfo *ConfigExportDeliveryInfo } // Identifies an AWS resource and indicates whether it complies with the AWS Config // rule that it was evaluated against. type Evaluation struct { - // The type of AWS resource that was evaluated. + // The ID of the AWS resource that was evaluated. // // This member is required. - ComplianceResourceType *string + ComplianceResourceId *string - // The ID of the AWS resource that was evaluated. + // The type of AWS resource that was evaluated. // // This member is required. - ComplianceResourceId *string + ComplianceResourceType *string // Indicates whether the AWS resource complies with the AWS Config rule that it was // evaluated against. For the Evaluation data type, AWS Config supports only the @@ -979,9 +979,6 @@ type Evaluation struct { // This member is required. ComplianceType ComplianceType - // Supplementary information about how the evaluation determined the compliance. - Annotation *string - // The time of the event in AWS Config that triggered the evaluation. For // event-based evaluations, the time indicates when AWS Config created the // configuration item that triggered the evaluation. For periodic evaluations, the @@ -990,6 +987,9 @@ type Evaluation struct { // // This member is required. OrderingTimestamp *time.Time + + // Supplementary information about how the evaluation determined the compliance. + Annotation *string } // The details of an AWS Config evaluation. Provides the AWS resource that was @@ -1000,20 +1000,20 @@ type EvaluationResult struct { // Supplementary information about how the evaluation determined the compliance. Annotation *string + // Indicates whether the AWS resource complies with the AWS Config rule that + // evaluated it. For the EvaluationResult data type, AWS Config supports only the + // COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support + // the INSUFFICIENT_DATA value for the EvaluationResult data type. + ComplianceType ComplianceType + // The time when the AWS Config rule evaluated the AWS resource. ConfigRuleInvokedTime *time.Time - // The time when AWS Config recorded the evaluation result. - ResultRecordedTime *time.Time - // Uniquely identifies the evaluation result. EvaluationResultIdentifier *EvaluationResultIdentifier - // Indicates whether the AWS resource complies with the AWS Config rule that - // evaluated it. For the EvaluationResult data type, AWS Config supports only the - // COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support - // the INSUFFICIENT_DATA value for the EvaluationResult data type. - ComplianceType ComplianceType + // The time when AWS Config recorded the evaluation result. + ResultRecordedTime *time.Time // An encrypted token that associates an evaluation with an AWS Config rule. The // token identifies the rule, the AWS resource being evaluated, and the event that @@ -1024,15 +1024,15 @@ type EvaluationResult struct { // Uniquely identifies an evaluation result. type EvaluationResultIdentifier struct { + // Identifies an AWS Config rule used to evaluate an AWS resource, and provides the + // type and ID of the evaluated resource. + EvaluationResultQualifier *EvaluationResultQualifier + // The time of the event that triggered the evaluation of your AWS resources. The // time can indicate when AWS Config delivered a configuration item change // notification, or it can indicate when AWS Config delivered the configuration // snapshot, depending on which event triggered the evaluation. OrderingTimestamp *time.Time - - // Identifies an AWS Config rule used to evaluate an AWS resource, and provides the - // type and ID of the evaluated resource. - EvaluationResultQualifier *EvaluationResultQualifier } // Identifies an AWS Config rule that evaluated an AWS resource, and provides the @@ -1070,21 +1070,21 @@ type FailedDeleteRemediationExceptionsBatch struct { // List of each of the failed remediations with specific reasons. type FailedRemediationBatch struct { - // Returns a failure message. For example, the resource is already compliant. - FailureMessage *string - // Returns remediation configurations of the failed items. FailedItems []*RemediationConfiguration + + // Returns a failure message. For example, the resource is already compliant. + FailureMessage *string } // List of each of the failed remediation exceptions with specific reasons. type FailedRemediationExceptionBatch struct { - // Returns a failure message. For example, the auto-remediation has failed. - FailureMessage *string - // Returns remediation exception resource key object of the failed items. FailedItems []*RemediationException + + // Returns a failure message. For example, the auto-remediation has failed. + FailureMessage *string } // Details about the fields such as name of the field. @@ -1097,16 +1097,16 @@ type FieldInfo struct { // The count of resources that are grouped by the group name. type GroupedResourceCount struct { - // The number of resources in the group. - // - // This member is required. - ResourceCount *int64 - // The name of the group that can be region, account ID, or resource type. For // example, region1, region2 if the region was chosen as GroupByKey. // // This member is required. GroupName *string + + // The number of resources in the group. + // + // This member is required. + ResourceCount *int64 } // Organization config rule creation or deletion status in each member account. @@ -1114,18 +1114,16 @@ type GroupedResourceCount struct { // when the rule creation or deletion failed. type MemberAccountStatus struct { - // An error message indicating that config rule account creation or deletion has - // failed due to an error in the member account. - ErrorMessage *string + // The 12-digit account ID of a member account. + // + // This member is required. + AccountId *string // The name of config rule deployed in the member account. // // This member is required. ConfigRuleName *string - // The timestamp of the last status update. - LastUpdateTime *time.Time - // Indicates deployment status for config rule in the member account. When master // account calls PutOrganizationConfigRule action for the first time, config rule // status is created in the member account. When master account calls @@ -1165,31 +1163,33 @@ type MemberAccountStatus struct { // This member is required. MemberAccountRuleStatus MemberAccountRuleStatus - // The 12-digit account ID of a member account. - // - // This member is required. - AccountId *string - // An error code that is returned when config rule creation or deletion failed in // the member account. ErrorCode *string + + // An error message indicating that config rule account creation or deletion has + // failed due to an error in the member account. + ErrorMessage *string + + // The timestamp of the last status update. + LastUpdateTime *time.Time } // This object contains regions to set up the aggregator and an IAM role to // retrieve organization details. type OrganizationAggregationSource struct { - // The source regions being aggregated. - AwsRegions []*string - - // If true, aggregate existing AWS Config regions and future regions. - AllAwsRegions *bool - // ARN of the IAM role used to retrieve AWS Organization details associated with // the aggregator account. // // This member is required. RoleArn *string + + // If true, aggregate existing AWS Config regions and future regions. + AllAwsRegions *bool + + // The source regions being aggregated. + AwsRegions []*string } // An organization config rule that has information about config rules that AWS @@ -1201,20 +1201,20 @@ type OrganizationConfigRule struct { // This member is required. OrganizationConfigRuleArn *string - // An OrganizationCustomRuleMetadata object. - OrganizationCustomRuleMetadata *OrganizationCustomRuleMetadata - - // The timestamp of the last update. - LastUpdateTime *time.Time - - // A comma-separated list of accounts excluded from organization config rule. - ExcludedAccounts []*string - // The name that you assign to organization config rule. // // This member is required. OrganizationConfigRuleName *string + // A comma-separated list of accounts excluded from organization config rule. + ExcludedAccounts []*string + + // The timestamp of the last update. + LastUpdateTime *time.Time + + // An OrganizationCustomRuleMetadata object. + OrganizationCustomRuleMetadata *OrganizationCustomRuleMetadata + // An OrganizationManagedRuleMetadata object. OrganizationManagedRuleMetadata *OrganizationManagedRuleMetadata } @@ -1227,10 +1227,6 @@ type OrganizationConfigRuleStatus struct { // This member is required. OrganizationConfigRuleName *string - // An error message indicating that organization config rule creation or deletion - // failed due to an error. - ErrorMessage *string - // Indicates deployment status of an organization config rule. When master account // calls PutOrganizationConfigRule action for the first time, config rule status is // created in all the member accounts. When master account calls @@ -1279,6 +1275,10 @@ type OrganizationConfigRuleStatus struct { // deletion has failed. ErrorCode *string + // An error message indicating that organization config rule creation or deletion + // failed due to an error. + ErrorMessage *string + // The timestamp of the last update. LastUpdateTime *time.Time } @@ -1293,17 +1293,6 @@ type OrganizationConformancePack struct { // This member is required. DeliveryS3Bucket *string - // Any folder structure you want to add to an Amazon S3 bucket. - DeliveryS3KeyPrefix *string - - // The name you assign to an organization conformance pack. - // - // This member is required. - OrganizationConformancePackName *string - - // A list of ConformancePackInputParameter objects. - ConformancePackInputParameters []*ConformancePackInputParameter - // Last time when organization conformation pack was updated. // // This member is required. @@ -1314,6 +1303,17 @@ type OrganizationConformancePack struct { // This member is required. OrganizationConformancePackArn *string + // The name you assign to an organization conformance pack. + // + // This member is required. + OrganizationConformancePackName *string + + // A list of ConformancePackInputParameter objects. + ConformancePackInputParameters []*ConformancePackInputParameter + + // Any folder structure you want to add to an Amazon S3 bucket. + DeliveryS3KeyPrefix *string + // A comma-separated list of accounts excluded from organization conformance pack. ExcludedAccounts []*string } @@ -1323,23 +1323,15 @@ type OrganizationConformancePack struct { // and error message when the conformance pack creation or deletion failed. type OrganizationConformancePackDetailedStatus struct { - // An error message indicating that conformance pack account creation or deletion - // has failed due to an error in the member account. - ErrorMessage *string - - // The name of conformance pack deployed in the member account. + // The 12-digit account ID of a member account. // // This member is required. - ConformancePackName *string - - // An error code that is returned when conformance pack creation or deletion failed - // in the member account. - ErrorCode *string + AccountId *string - // The 12-digit account ID of a member account. + // The name of conformance pack deployed in the member account. // // This member is required. - AccountId *string + ConformancePackName *string // Indicates deployment status for conformance pack in a member account. When // master account calls PutOrganizationConformancePack action for the first time, @@ -1381,6 +1373,14 @@ type OrganizationConformancePackDetailedStatus struct { // This member is required. Status OrganizationResourceDetailedStatus + // An error code that is returned when conformance pack creation or deletion failed + // in the member account. + ErrorCode *string + + // An error message indicating that conformance pack account creation or deletion + // has failed due to an error in the member account. + ErrorMessage *string + // The timestamp of the last status update. LastUpdateTime *time.Time } @@ -1388,8 +1388,10 @@ type OrganizationConformancePackDetailedStatus struct { // Returns the status for an organization conformance pack in an organization. type OrganizationConformancePackStatus struct { - // The timestamp of the last update. - LastUpdateTime *time.Time + // The name that you assign to organization conformance pack. + // + // This member is required. + OrganizationConformancePackName *string // Indicates deployment status of an organization conformance pack. When master // account calls PutOrganizationConformancePack for the first time, conformance @@ -1444,10 +1446,8 @@ type OrganizationConformancePackStatus struct { // deletion failed due to an error. ErrorMessage *string - // The name that you assign to organization conformance pack. - // - // This member is required. - OrganizationConformancePackName *string + // The timestamp of the last update. + LastUpdateTime *time.Time } // An object that specifies organization custom rule metadata such as resource @@ -1457,16 +1457,10 @@ type OrganizationConformancePackStatus struct { // for the rule if the trigger type is periodic. type OrganizationCustomRuleMetadata struct { - // One part of a key-value pair that make up a tag. A key is a general label that - // acts like a category for more specific tag values. - TagKeyScope *string - - // The type of the AWS resource that was evaluated. - ResourceTypesScope []*string - - // A string, in JSON format, that is passed to organization config rule Lambda - // function. - InputParameters *string + // The lambda function ARN. + // + // This member is required. + LambdaFunctionArn *string // The type of notification that triggers AWS Config to run an evaluation for a // rule. You can specify the following notification types: + //

    For fuzz tests (Android only):

    • event_count: The + // number of events, between 1 and 10000, that the UI fuzz test should perform.

      + //

    • throttle: The time, in ms, between 0 and 1000, that the UI fuzz + // test should wait between events.

    • seed: A seed to use for + // randomizing the UI fuzz test. Using the same seed value between tests ensures + // identical event sequences.

    For Explorer tests:

    • + //

      username: A user name to use if the Explorer encounters a login form. If not + // supplied, no user name is inserted.

    • password: A password to + // use if the Explorer encounters a login form. If not supplied, no password is + // inserted.

    For Instrumentation:

    • filter: A + // test filter string. Examples:

      • Running a single test case: + // com.android.abc.Test1

      • Running a single test: + // com.android.abc.Test1#smoke

      • Running multiple + // tests: com.android.abc.Test1,com.android.abc.Test2

      + //

    For XCTest and XCTestUI:

    • filter: A test filter + // string. Examples:

      • Running a single test class: + // LoginTests

      • Running a multiple test classes: + // LoginTests,SmokeTests

      • Running a single test: + // LoginTests/testValid

      • Running multiple tests: + // LoginTests/testValid,LoginTests/testInvalid

      • + //

    For UIAutomator:

    • filter: A test filter string. + // Examples:

      • Running a single test case: + // com.android.abc.Test1

      • Running a single test: + // com.android.abc.Test1#smoke

      • Running multiple + // tests: com.android.abc.Test1,com.android.abc.Test2

      + //
    + Parameters map[string]*string + // The ARN of the uploaded test to be run. TestPackageArn *string // The ARN of the YAML-formatted test specification. TestSpecArn *string - - // The test's filter. - Filter *string } // Represents a collection of one or more tests. type Suite struct { - // A message about the suite's result. - Message *string - // The suite's ARN. Arn *string - // Represents the total (metered or unmetered) minutes used by the test suite. - DeviceMinutes *DeviceMinutes + // The suite's result counters. + Counters *Counters // When the suite was created. Created *time.Time - // The suite's stop time. - Stopped *time.Time + // Represents the total (metered or unmetered) minutes used by the test suite. + DeviceMinutes *DeviceMinutes + + // A message about the suite's result. + Message *string + + // The suite's name. + Name *string // The suite's result. Allowed values include: // @@ -1595,6 +1598,35 @@ type Suite struct { // * STOPPED Result ExecutionResult + // The suite's start time. + Started *time.Time + + // The suite's status. Allowed values include: + // + // * PENDING + // + // * + // PENDING_CONCURRENCY + // + // * PENDING_DEVICE + // + // * PROCESSING + // + // * SCHEDULING + // + // + // * PREPARING + // + // * RUNNING + // + // * COMPLETED + // + // * STOPPING + Status ExecutionStatus + + // The suite's stop time. + Stopped *time.Time + // The suite's type. Must be one of the following values: // // * BUILTIN_FUZZ @@ -1640,38 +1672,6 @@ type Suite struct { // // * XCTEST_UI Type TestType - - // The suite's result counters. - Counters *Counters - - // The suite's status. Allowed values include: - // - // * PENDING - // - // * - // PENDING_CONCURRENCY - // - // * PENDING_DEVICE - // - // * PROCESSING - // - // * SCHEDULING - // - // - // * PREPARING - // - // * RUNNING - // - // * COMPLETED - // - // * STOPPING - Status ExecutionStatus - - // The suite's start time. - Started *time.Time - - // The suite's name. - Name *string } // The metadata that you apply to a resource to help you categorize and organize @@ -1696,6 +1696,42 @@ type Tag struct { // Represents a condition that is evaluated. type Test struct { + // The test's ARN. + Arn *string + + // The test's result counters. + Counters *Counters + + // When the test was created. + Created *time.Time + + // Represents the total (metered or unmetered) minutes used by the test. + DeviceMinutes *DeviceMinutes + + // A message about the test's result. + Message *string + + // The test's name. + Name *string + + // The test's result. Allowed values include: + // + // * PENDING + // + // * PASSED + // + // * + // WARNED + // + // * FAILED + // + // * SKIPPED + // + // * ERRORED + // + // * STOPPED + Result ExecutionResult + // The test's start time. Started *time.Time @@ -1722,42 +1758,9 @@ type Test struct { // * STOPPING Status ExecutionStatus - // The test's name. - Name *string - - // When the test was created. - Created *time.Time - - // The test's result counters. - Counters *Counters - - // The test's result. Allowed values include: - // - // * PENDING - // - // * PASSED - // - // * - // WARNED - // - // * FAILED - // - // * SKIPPED - // - // * ERRORED - // - // * STOPPED - Result ExecutionResult - // The test's stop time. Stopped *time.Time - // Represents the total (metered or unmetered) minutes used by the test. - DeviceMinutes *DeviceMinutes - - // The test's ARN. - Arn *string - // The test's type. Must be one of the following values: // // * BUILTIN_FUZZ @@ -1803,67 +1806,64 @@ type Test struct { // // * XCTEST_UI Type TestType - - // A message about the test's result. - Message *string } // A Selenium testing project. Projects are used to collect and collate sessions. type TestGridProject struct { + // The ARN for the project. + Arn *string + + // When the project was created. + Created *time.Time + // A human-readable description for the project. Description *string // A human-readable name for the project. Name *string - - // When the project was created. - Created *time.Time - - // The ARN for the project. - Arn *string } // A TestGridSession () is a single instance of a browser launched from the URL // provided by a call to CreateTestGridUrl (). type TestGridSession struct { + // The ARN of the session. + Arn *string + + // The number of billed minutes that were used for this session. + BillingMinutes *float64 + // The time that the session was started. Created *time.Time // The time the session ended. Ended *time.Time - // The ARN of the session. - Arn *string - - // The state of the session. - Status TestGridSessionStatus - // A JSON object of options and parameters passed to the Selenium WebDriver. SeleniumProperties *string - // The number of billed minutes that were used for this session. - BillingMinutes *float64 + // The state of the session. + Status TestGridSessionStatus } // An action taken by a TestGridSession () browser instance. type TestGridSessionAction struct { - // HTTP status code returned to the browser when the action was taken. - StatusCode *string - // The action taken by the session. Action *string - // The time that the session invoked the action. - Started *time.Time - // The time, in milliseconds, that the action took to complete in the browser. Duration *int64 // HTTP method that the browser used to make the request. RequestMethod *string + + // The time that the session invoked the action. + Started *time.Time + + // HTTP status code returned to the browser when the action was taken. + StatusCode *string } // Artifacts are video and other files that are produced in the process of running @@ -1871,12 +1871,12 @@ type TestGridSessionAction struct { // multiple artifacts as they grow in size during creation. type TestGridSessionArtifact struct { - // The kind of artifact. - Type TestGridSessionArtifactType - // The file name of the artifact. Filename *string + // The kind of artifact. + Type TestGridSessionArtifactType + // A semi-stable URL to the content of the object. Url *string } @@ -1884,11 +1884,11 @@ type TestGridSessionArtifact struct { // Represents information about free trial device minutes for an AWS account. type TrialMinutes struct { - // The total number of free trial minutes that the account started with. - Total *float64 - // The number of free trial minutes remaining in the account. Remaining *float64 + + // The total number of free trial minutes that the account started with. + Total *float64 } // A collection of one or more problems, grouped by their result. @@ -1904,11 +1904,8 @@ type UniqueProblem struct { // An app or a set of one or more tests to upload or that have been uploaded. type Upload struct { - // A message about the upload's result. - Message *string - - // The presigned Amazon S3 URL that was used to store a file using a PUT request. - Url *string + // The upload's ARN. + Arn *string // The upload's category. Allowed values include: // @@ -1919,11 +1916,22 @@ type Upload struct { // customer. Category UploadCategory + // The upload's content type (for example, application/octet-stream). + ContentType *string + // When the upload was created. Created *time.Time - // The upload's content type (for example, application/octet-stream). - ContentType *string + // A message about the upload's result. + Message *string + + // The upload's metadata. For example, for Android, this contains information that + // is parsed from the manifest and is displayed in the AWS Device Farm console + // after the associated app is uploaded. + Metadata *string + + // The upload's file name. + Name *string // The upload's status. Must be one of the following values: // @@ -2019,28 +2027,20 @@ type Upload struct { // * XCTEST_UI_TEST_SPEC Type UploadType - // The upload's metadata. For example, for Android, this contains information that - // is parsed from the manifest and is displayed in the AWS Device Farm console - // after the associated app is uploaded. - Metadata *string - - // The upload's ARN. - Arn *string - - // The upload's file name. - Name *string + // The presigned Amazon S3 URL that was used to store a file using a PUT request. + Url *string } // Represents an Amazon Virtual Private Cloud (VPC) endpoint configuration. type VPCEConfiguration struct { + // The Amazon Resource Name (ARN) of the VPC endpoint configuration. + Arn *string + // The DNS name that maps to the private IP address of the service you want to // access. ServiceDnsName *string - // The Amazon Resource Name (ARN) of the VPC endpoint configuration. - Arn *string - // An optional description that provides details about your VPC endpoint // configuration. VpceConfigurationDescription *string diff --git a/service/directconnect/api_op_AcceptDirectConnectGatewayAssociationProposal.go b/service/directconnect/api_op_AcceptDirectConnectGatewayAssociationProposal.go index 420c6dcf3c1..aeb5893e102 100644 --- a/service/directconnect/api_op_AcceptDirectConnectGatewayAssociationProposal.go +++ b/service/directconnect/api_op_AcceptDirectConnectGatewayAssociationProposal.go @@ -58,27 +58,27 @@ func (c *Client) AcceptDirectConnectGatewayAssociationProposal(ctx context.Conte type AcceptDirectConnectGatewayAssociationProposalInput struct { - // The ID of the Direct Connect gateway. - // - // This member is required. - DirectConnectGatewayId *string - - // Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway. For - // information about how to set the prefixes, see Allowed Prefixes - // (https://docs.aws.amazon.com/directconnect/latest/UserGuide/multi-account-associate-vgw.html#allowed-prefixes) - // in the AWS Direct Connect User Guide. - OverrideAllowedPrefixesToDirectConnectGateway []*types.RouteFilterPrefix - // The ID of the AWS account that owns the virtual private gateway or transit // gateway. // // This member is required. AssociatedGatewayOwnerAccount *string + // The ID of the Direct Connect gateway. + // + // This member is required. + DirectConnectGatewayId *string + // The ID of the request proposal. // // This member is required. ProposalId *string + + // Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway. For + // information about how to set the prefixes, see Allowed Prefixes + // (https://docs.aws.amazon.com/directconnect/latest/UserGuide/multi-account-associate-vgw.html#allowed-prefixes) + // in the AWS Direct Connect User Guide. + OverrideAllowedPrefixesToDirectConnectGateway []*types.RouteFilterPrefix } type AcceptDirectConnectGatewayAssociationProposalOutput struct { diff --git a/service/directconnect/api_op_AllocateConnectionOnInterconnect.go b/service/directconnect/api_op_AllocateConnectionOnInterconnect.go index b8a2f08e28e..a043a0af2f2 100644 --- a/service/directconnect/api_op_AllocateConnectionOnInterconnect.go +++ b/service/directconnect/api_op_AllocateConnectionOnInterconnect.go @@ -61,16 +61,6 @@ func (c *Client) AllocateConnectionOnInterconnect(ctx context.Context, params *A type AllocateConnectionOnInterconnectInput struct { - // The name of the provisioned connection. - // - // This member is required. - ConnectionName *string - - // The dedicated VLAN provisioned to the connection. - // - // This member is required. - Vlan *int32 - // The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, // 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that // only those AWS Direct Connect Partners who have met specific requirements are @@ -79,6 +69,11 @@ type AllocateConnectionOnInterconnectInput struct { // This member is required. Bandwidth *string + // The name of the provisioned connection. + // + // This member is required. + ConnectionName *string + // The ID of the interconnect on which the connection will be provisioned. // // This member is required. @@ -89,37 +84,30 @@ type AllocateConnectionOnInterconnectInput struct { // // This member is required. OwnerAccount *string + + // The dedicated VLAN provisioned to the connection. + // + // This member is required. + Vlan *int32 } // Information about an AWS Direct Connect connection. type AllocateConnectionOnInterconnectOutput struct { - // Indicates whether jumbo frames (9001 MTU) are supported. - JumboFrameCapable *bool + // The Direct Connect endpoint on which the physical connection terminates. + AwsDevice *string // The Direct Connect endpoint on which the physical connection terminates. AwsDeviceV2 *string - // The ID of the VLAN. - Vlan *int32 - - // The name of the connection. - ConnectionName *string - - // The AWS Region where the connection is located. - Region *string - - // The ID of the LAG. - LagId *string + // The bandwidth of the connection. + Bandwidth *string // The ID of the connection. ConnectionId *string - // The tags associated with the connection. - Tags []*types.Tag - - // The ID of the AWS account that owns the connection. - OwnerAccount *string + // The name of the connection. + ConnectionName *string // The state of the connection. The following are the possible values: // @@ -154,28 +142,40 @@ type AllocateConnectionOnInterconnectOutput struct { // not available. ConnectionState types.ConnectionState - // The Direct Connect endpoint on which the physical connection terminates. - AwsDevice *string + // Indicates whether the connection supports a secondary BGP peer in the same + // address family (IPv4/IPv6). + HasLogicalRedundancy types.HasLogicalRedundancy - // The name of the AWS Direct Connect service provider associated with the - // connection. - PartnerName *string + // Indicates whether jumbo frames (9001 MTU) are supported. + JumboFrameCapable *bool + + // The ID of the LAG. + LagId *string // The time of the most recent call to DescribeLoa () for this connection. LoaIssueTime *time.Time - // Indicates whether the connection supports a secondary BGP peer in the same - // address family (IPv4/IPv6). - HasLogicalRedundancy types.HasLogicalRedundancy + // The location of the connection. + Location *string + + // The ID of the AWS account that owns the connection. + OwnerAccount *string + + // The name of the AWS Direct Connect service provider associated with the + // connection. + PartnerName *string // The name of the service provider associated with the connection. ProviderName *string - // The bandwidth of the connection. - Bandwidth *string + // The AWS Region where the connection is located. + Region *string - // The location of the connection. - Location *string + // The tags associated with the connection. + Tags []*types.Tag + + // The ID of the VLAN. + Vlan *int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/directconnect/api_op_AllocateHostedConnection.go b/service/directconnect/api_op_AllocateHostedConnection.go index 528c61a5997..8b6bd99e87e 100644 --- a/service/directconnect/api_op_AllocateHostedConnection.go +++ b/service/directconnect/api_op_AllocateHostedConnection.go @@ -64,67 +64,55 @@ func (c *Client) AllocateHostedConnection(ctx context.Context, params *AllocateH type AllocateHostedConnectionInput struct { - // The tags associated with the connection. - Tags []*types.Tag + // The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, + // 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that + // only those AWS Direct Connect Partners who have met specific requirements are + // allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection. + // + // This member is required. + Bandwidth *string - // The ID of the AWS account ID of the customer for the connection. + // The ID of the interconnect or LAG. // // This member is required. - OwnerAccount *string + ConnectionId *string // The name of the hosted connection. // // This member is required. ConnectionName *string - // The dedicated VLAN provisioned to the hosted connection. + // The ID of the AWS account ID of the customer for the connection. // // This member is required. - Vlan *int32 + OwnerAccount *string - // The ID of the interconnect or LAG. + // The dedicated VLAN provisioned to the hosted connection. // // This member is required. - ConnectionId *string + Vlan *int32 - // The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, - // 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that - // only those AWS Direct Connect Partners who have met specific requirements are - // allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection. - // - // This member is required. - Bandwidth *string + // The tags associated with the connection. + Tags []*types.Tag } // Information about an AWS Direct Connect connection. type AllocateHostedConnectionOutput struct { - // Indicates whether jumbo frames (9001 MTU) are supported. - JumboFrameCapable *bool + // The Direct Connect endpoint on which the physical connection terminates. + AwsDevice *string // The Direct Connect endpoint on which the physical connection terminates. AwsDeviceV2 *string - // The ID of the VLAN. - Vlan *int32 - - // The name of the connection. - ConnectionName *string - - // The AWS Region where the connection is located. - Region *string - - // The ID of the LAG. - LagId *string + // The bandwidth of the connection. + Bandwidth *string // The ID of the connection. ConnectionId *string - // The tags associated with the connection. - Tags []*types.Tag - - // The ID of the AWS account that owns the connection. - OwnerAccount *string + // The name of the connection. + ConnectionName *string // The state of the connection. The following are the possible values: // @@ -159,28 +147,40 @@ type AllocateHostedConnectionOutput struct { // not available. ConnectionState types.ConnectionState - // The Direct Connect endpoint on which the physical connection terminates. - AwsDevice *string + // Indicates whether the connection supports a secondary BGP peer in the same + // address family (IPv4/IPv6). + HasLogicalRedundancy types.HasLogicalRedundancy - // The name of the AWS Direct Connect service provider associated with the - // connection. - PartnerName *string + // Indicates whether jumbo frames (9001 MTU) are supported. + JumboFrameCapable *bool + + // The ID of the LAG. + LagId *string // The time of the most recent call to DescribeLoa () for this connection. LoaIssueTime *time.Time - // Indicates whether the connection supports a secondary BGP peer in the same - // address family (IPv4/IPv6). - HasLogicalRedundancy types.HasLogicalRedundancy + // The location of the connection. + Location *string + + // The ID of the AWS account that owns the connection. + OwnerAccount *string + + // The name of the AWS Direct Connect service provider associated with the + // connection. + PartnerName *string // The name of the service provider associated with the connection. ProviderName *string - // The bandwidth of the connection. - Bandwidth *string + // The AWS Region where the connection is located. + Region *string - // The location of the connection. - Location *string + // The tags associated with the connection. + Tags []*types.Tag + + // The ID of the VLAN. + Vlan *int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/directconnect/api_op_AllocatePrivateVirtualInterface.go b/service/directconnect/api_op_AllocatePrivateVirtualInterface.go index 05608195462..42342bc3457 100644 --- a/service/directconnect/api_op_AllocatePrivateVirtualInterface.go +++ b/service/directconnect/api_op_AllocatePrivateVirtualInterface.go @@ -65,26 +65,90 @@ type AllocatePrivateVirtualInterfaceInput struct { // This member is required. ConnectionId *string - // The ID of the AWS account that owns the virtual private interface. + // Information about the private virtual interface. // // This member is required. - OwnerAccount *string + NewPrivateVirtualInterfaceAllocation *types.NewPrivateVirtualInterfaceAllocation - // Information about the private virtual interface. + // The ID of the AWS account that owns the virtual private interface. // // This member is required. - NewPrivateVirtualInterfaceAllocation *types.NewPrivateVirtualInterfaceAllocation + OwnerAccount *string } // Information about a virtual interface. type AllocatePrivateVirtualInterfaceOutput struct { - // The ID of the connection. - ConnectionId *string + // The address family for the BGP peer. + AddressFamily types.AddressFamily + + // The IP address assigned to the Amazon interface. + AmazonAddress *string + + // The autonomous system number (ASN) for the Amazon side of the connection. + AmazonSideAsn *int64 + + // The autonomous system (AS) number for Border Gateway Protocol (BGP) + // configuration. The valid values are 1-2147483647. + Asn *int32 + + // The authentication key for BGP configuration. This string has a minimum length + // of 6 characters and and a maximun lenth of 80 characters. + AuthKey *string + + // The Direct Connect endpoint on which the virtual interface terminates. + AwsDeviceV2 *string // The BGP peers configured on this virtual interface. BgpPeers []*types.BGPPeer + // The ID of the connection. + ConnectionId *string + + // The IP address assigned to the customer interface. + CustomerAddress *string + + // The customer router configuration. + CustomerRouterConfig *string + + // The ID of the Direct Connect gateway. + DirectConnectGatewayId *string + + // Indicates whether jumbo frames (9001 MTU) are supported. + JumboFrameCapable *bool + + // The location of the connection. + Location *string + + // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and + // 9001. The default value is 1500. + Mtu *int32 + + // The ID of the AWS account that owns the virtual interface. + OwnerAccount *string + + // The AWS Region where the virtual interface is located. + Region *string + + // The routes to be advertised to the AWS network in this Region. Applies to public + // virtual interfaces. + RouteFilterPrefixes []*types.RouteFilterPrefix + + // The tags associated with the virtual interface. + Tags []*types.Tag + + // The ID of the virtual private gateway. Applies only to private virtual + // interfaces. + VirtualGatewayId *string + + // The ID of the virtual interface. + VirtualInterfaceId *string + + // The name of the virtual interface assigned by the customer network. The name has + // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a + // hyphen (-). + VirtualInterfaceName *string + // The state of the virtual interface. The following are the possible values: // // @@ -126,73 +190,9 @@ type AllocatePrivateVirtualInterfaceOutput struct { // The type of virtual interface. The possible values are private and public. VirtualInterfaceType *string - // The routes to be advertised to the AWS network in this Region. Applies to public - // virtual interfaces. - RouteFilterPrefixes []*types.RouteFilterPrefix - - // The authentication key for BGP configuration. This string has a minimum length - // of 6 characters and and a maximun lenth of 80 characters. - AuthKey *string - - // The Direct Connect endpoint on which the virtual interface terminates. - AwsDeviceV2 *string - - // The tags associated with the virtual interface. - Tags []*types.Tag - - // Indicates whether jumbo frames (9001 MTU) are supported. - JumboFrameCapable *bool - - // The ID of the AWS account that owns the virtual interface. - OwnerAccount *string - - // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and - // 9001. The default value is 1500. - Mtu *int32 - - // The IP address assigned to the customer interface. - CustomerAddress *string - - // The ID of the Direct Connect gateway. - DirectConnectGatewayId *string - - // The customer router configuration. - CustomerRouterConfig *string - - // The location of the connection. - Location *string - - // The ID of the virtual interface. - VirtualInterfaceId *string - - // The autonomous system number (ASN) for the Amazon side of the connection. - AmazonSideAsn *int64 - - // The IP address assigned to the Amazon interface. - AmazonAddress *string - - // The ID of the virtual private gateway. Applies only to private virtual - // interfaces. - VirtualGatewayId *string - - // The name of the virtual interface assigned by the customer network. The name has - // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a - // hyphen (-). - VirtualInterfaceName *string - // The ID of the VLAN. Vlan *int32 - // The autonomous system (AS) number for Border Gateway Protocol (BGP) - // configuration. The valid values are 1-2147483647. - Asn *int32 - - // The address family for the BGP peer. - AddressFamily types.AddressFamily - - // The AWS Region where the virtual interface is located. - Region *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/directconnect/api_op_AllocatePublicVirtualInterface.go b/service/directconnect/api_op_AllocatePublicVirtualInterface.go index 7cba338e206..dbf89be447a 100644 --- a/service/directconnect/api_op_AllocatePublicVirtualInterface.go +++ b/service/directconnect/api_op_AllocatePublicVirtualInterface.go @@ -65,31 +65,95 @@ func (c *Client) AllocatePublicVirtualInterface(ctx context.Context, params *All type AllocatePublicVirtualInterfaceInput struct { - // The ID of the AWS account that owns the public virtual interface. + // The ID of the connection on which the public virtual interface is provisioned. // // This member is required. - OwnerAccount *string + ConnectionId *string // Information about the public virtual interface. // // This member is required. NewPublicVirtualInterfaceAllocation *types.NewPublicVirtualInterfaceAllocation - // The ID of the connection on which the public virtual interface is provisioned. + // The ID of the AWS account that owns the public virtual interface. // // This member is required. - ConnectionId *string + OwnerAccount *string } // Information about a virtual interface. type AllocatePublicVirtualInterfaceOutput struct { - // The ID of the connection. - ConnectionId *string + // The address family for the BGP peer. + AddressFamily types.AddressFamily + + // The IP address assigned to the Amazon interface. + AmazonAddress *string + + // The autonomous system number (ASN) for the Amazon side of the connection. + AmazonSideAsn *int64 + + // The autonomous system (AS) number for Border Gateway Protocol (BGP) + // configuration. The valid values are 1-2147483647. + Asn *int32 + + // The authentication key for BGP configuration. This string has a minimum length + // of 6 characters and and a maximun lenth of 80 characters. + AuthKey *string + + // The Direct Connect endpoint on which the virtual interface terminates. + AwsDeviceV2 *string // The BGP peers configured on this virtual interface. BgpPeers []*types.BGPPeer + // The ID of the connection. + ConnectionId *string + + // The IP address assigned to the customer interface. + CustomerAddress *string + + // The customer router configuration. + CustomerRouterConfig *string + + // The ID of the Direct Connect gateway. + DirectConnectGatewayId *string + + // Indicates whether jumbo frames (9001 MTU) are supported. + JumboFrameCapable *bool + + // The location of the connection. + Location *string + + // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and + // 9001. The default value is 1500. + Mtu *int32 + + // The ID of the AWS account that owns the virtual interface. + OwnerAccount *string + + // The AWS Region where the virtual interface is located. + Region *string + + // The routes to be advertised to the AWS network in this Region. Applies to public + // virtual interfaces. + RouteFilterPrefixes []*types.RouteFilterPrefix + + // The tags associated with the virtual interface. + Tags []*types.Tag + + // The ID of the virtual private gateway. Applies only to private virtual + // interfaces. + VirtualGatewayId *string + + // The ID of the virtual interface. + VirtualInterfaceId *string + + // The name of the virtual interface assigned by the customer network. The name has + // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a + // hyphen (-). + VirtualInterfaceName *string + // The state of the virtual interface. The following are the possible values: // // @@ -131,73 +195,9 @@ type AllocatePublicVirtualInterfaceOutput struct { // The type of virtual interface. The possible values are private and public. VirtualInterfaceType *string - // The routes to be advertised to the AWS network in this Region. Applies to public - // virtual interfaces. - RouteFilterPrefixes []*types.RouteFilterPrefix - - // The authentication key for BGP configuration. This string has a minimum length - // of 6 characters and and a maximun lenth of 80 characters. - AuthKey *string - - // The Direct Connect endpoint on which the virtual interface terminates. - AwsDeviceV2 *string - - // The tags associated with the virtual interface. - Tags []*types.Tag - - // Indicates whether jumbo frames (9001 MTU) are supported. - JumboFrameCapable *bool - - // The ID of the AWS account that owns the virtual interface. - OwnerAccount *string - - // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and - // 9001. The default value is 1500. - Mtu *int32 - - // The IP address assigned to the customer interface. - CustomerAddress *string - - // The ID of the Direct Connect gateway. - DirectConnectGatewayId *string - - // The customer router configuration. - CustomerRouterConfig *string - - // The location of the connection. - Location *string - - // The ID of the virtual interface. - VirtualInterfaceId *string - - // The autonomous system number (ASN) for the Amazon side of the connection. - AmazonSideAsn *int64 - - // The IP address assigned to the Amazon interface. - AmazonAddress *string - - // The ID of the virtual private gateway. Applies only to private virtual - // interfaces. - VirtualGatewayId *string - - // The name of the virtual interface assigned by the customer network. The name has - // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a - // hyphen (-). - VirtualInterfaceName *string - // The ID of the VLAN. Vlan *int32 - // The autonomous system (AS) number for Border Gateway Protocol (BGP) - // configuration. The valid values are 1-2147483647. - Asn *int32 - - // The address family for the BGP peer. - AddressFamily types.AddressFamily - - // The AWS Region where the virtual interface is located. - Region *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/directconnect/api_op_AllocateTransitVirtualInterface.go b/service/directconnect/api_op_AllocateTransitVirtualInterface.go index 2f34a91a1e8..85fe54d9718 100644 --- a/service/directconnect/api_op_AllocateTransitVirtualInterface.go +++ b/service/directconnect/api_op_AllocateTransitVirtualInterface.go @@ -64,20 +64,20 @@ func (c *Client) AllocateTransitVirtualInterface(ctx context.Context, params *Al type AllocateTransitVirtualInterfaceInput struct { - // The ID of the AWS account that owns the transit virtual interface. + // The ID of the connection on which the transit virtual interface is provisioned. // // This member is required. - OwnerAccount *string + ConnectionId *string // Information about the transit virtual interface. // // This member is required. NewTransitVirtualInterfaceAllocation *types.NewTransitVirtualInterfaceAllocation - // The ID of the connection on which the transit virtual interface is provisioned. + // The ID of the AWS account that owns the transit virtual interface. // // This member is required. - ConnectionId *string + OwnerAccount *string } type AllocateTransitVirtualInterfaceOutput struct { diff --git a/service/directconnect/api_op_AssociateConnectionWithLag.go b/service/directconnect/api_op_AssociateConnectionWithLag.go index e3c24c05a35..287ebd0a643 100644 --- a/service/directconnect/api_op_AssociateConnectionWithLag.go +++ b/service/directconnect/api_op_AssociateConnectionWithLag.go @@ -71,46 +71,34 @@ func (c *Client) AssociateConnectionWithLag(ctx context.Context, params *Associa type AssociateConnectionWithLagInput struct { - // The ID of the LAG with which to associate the connection. + // The ID of the connection. // // This member is required. - LagId *string + ConnectionId *string - // The ID of the connection. + // The ID of the LAG with which to associate the connection. // // This member is required. - ConnectionId *string + LagId *string } // Information about an AWS Direct Connect connection. type AssociateConnectionWithLagOutput struct { - // Indicates whether jumbo frames (9001 MTU) are supported. - JumboFrameCapable *bool + // The Direct Connect endpoint on which the physical connection terminates. + AwsDevice *string // The Direct Connect endpoint on which the physical connection terminates. AwsDeviceV2 *string - // The ID of the VLAN. - Vlan *int32 - - // The name of the connection. - ConnectionName *string - - // The AWS Region where the connection is located. - Region *string - - // The ID of the LAG. - LagId *string + // The bandwidth of the connection. + Bandwidth *string // The ID of the connection. ConnectionId *string - // The tags associated with the connection. - Tags []*types.Tag - - // The ID of the AWS account that owns the connection. - OwnerAccount *string + // The name of the connection. + ConnectionName *string // The state of the connection. The following are the possible values: // @@ -145,28 +133,40 @@ type AssociateConnectionWithLagOutput struct { // not available. ConnectionState types.ConnectionState - // The Direct Connect endpoint on which the physical connection terminates. - AwsDevice *string + // Indicates whether the connection supports a secondary BGP peer in the same + // address family (IPv4/IPv6). + HasLogicalRedundancy types.HasLogicalRedundancy - // The name of the AWS Direct Connect service provider associated with the - // connection. - PartnerName *string + // Indicates whether jumbo frames (9001 MTU) are supported. + JumboFrameCapable *bool + + // The ID of the LAG. + LagId *string // The time of the most recent call to DescribeLoa () for this connection. LoaIssueTime *time.Time - // Indicates whether the connection supports a secondary BGP peer in the same - // address family (IPv4/IPv6). - HasLogicalRedundancy types.HasLogicalRedundancy + // The location of the connection. + Location *string + + // The ID of the AWS account that owns the connection. + OwnerAccount *string + + // The name of the AWS Direct Connect service provider associated with the + // connection. + PartnerName *string // The name of the service provider associated with the connection. ProviderName *string - // The bandwidth of the connection. - Bandwidth *string + // The AWS Region where the connection is located. + Region *string - // The location of the connection. - Location *string + // The tags associated with the connection. + Tags []*types.Tag + + // The ID of the VLAN. + Vlan *int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/directconnect/api_op_AssociateHostedConnection.go b/service/directconnect/api_op_AssociateHostedConnection.go index a822b7a5970..fe781a62be8 100644 --- a/service/directconnect/api_op_AssociateHostedConnection.go +++ b/service/directconnect/api_op_AssociateHostedConnection.go @@ -77,32 +77,20 @@ type AssociateHostedConnectionInput struct { // Information about an AWS Direct Connect connection. type AssociateHostedConnectionOutput struct { - // Indicates whether jumbo frames (9001 MTU) are supported. - JumboFrameCapable *bool + // The Direct Connect endpoint on which the physical connection terminates. + AwsDevice *string // The Direct Connect endpoint on which the physical connection terminates. AwsDeviceV2 *string - // The ID of the VLAN. - Vlan *int32 - - // The name of the connection. - ConnectionName *string - - // The AWS Region where the connection is located. - Region *string - - // The ID of the LAG. - LagId *string + // The bandwidth of the connection. + Bandwidth *string // The ID of the connection. ConnectionId *string - // The tags associated with the connection. - Tags []*types.Tag - - // The ID of the AWS account that owns the connection. - OwnerAccount *string + // The name of the connection. + ConnectionName *string // The state of the connection. The following are the possible values: // @@ -137,28 +125,40 @@ type AssociateHostedConnectionOutput struct { // not available. ConnectionState types.ConnectionState - // The Direct Connect endpoint on which the physical connection terminates. - AwsDevice *string + // Indicates whether the connection supports a secondary BGP peer in the same + // address family (IPv4/IPv6). + HasLogicalRedundancy types.HasLogicalRedundancy - // The name of the AWS Direct Connect service provider associated with the - // connection. - PartnerName *string + // Indicates whether jumbo frames (9001 MTU) are supported. + JumboFrameCapable *bool + + // The ID of the LAG. + LagId *string // The time of the most recent call to DescribeLoa () for this connection. LoaIssueTime *time.Time - // Indicates whether the connection supports a secondary BGP peer in the same - // address family (IPv4/IPv6). - HasLogicalRedundancy types.HasLogicalRedundancy + // The location of the connection. + Location *string + + // The ID of the AWS account that owns the connection. + OwnerAccount *string + + // The name of the AWS Direct Connect service provider associated with the + // connection. + PartnerName *string // The name of the service provider associated with the connection. ProviderName *string - // The bandwidth of the connection. - Bandwidth *string + // The AWS Region where the connection is located. + Region *string - // The location of the connection. - Location *string + // The tags associated with the connection. + Tags []*types.Tag + + // The ID of the VLAN. + Vlan *int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/directconnect/api_op_AssociateVirtualInterface.go b/service/directconnect/api_op_AssociateVirtualInterface.go index da876024b97..8e488e596b2 100644 --- a/service/directconnect/api_op_AssociateVirtualInterface.go +++ b/service/directconnect/api_op_AssociateVirtualInterface.go @@ -67,26 +67,90 @@ func (c *Client) AssociateVirtualInterface(ctx context.Context, params *Associat type AssociateVirtualInterfaceInput struct { - // The ID of the virtual interface. + // The ID of the LAG or connection. // // This member is required. - VirtualInterfaceId *string + ConnectionId *string - // The ID of the LAG or connection. + // The ID of the virtual interface. // // This member is required. - ConnectionId *string + VirtualInterfaceId *string } // Information about a virtual interface. type AssociateVirtualInterfaceOutput struct { - // The ID of the connection. - ConnectionId *string + // The address family for the BGP peer. + AddressFamily types.AddressFamily + + // The IP address assigned to the Amazon interface. + AmazonAddress *string + + // The autonomous system number (ASN) for the Amazon side of the connection. + AmazonSideAsn *int64 + + // The autonomous system (AS) number for Border Gateway Protocol (BGP) + // configuration. The valid values are 1-2147483647. + Asn *int32 + + // The authentication key for BGP configuration. This string has a minimum length + // of 6 characters and and a maximun lenth of 80 characters. + AuthKey *string + + // The Direct Connect endpoint on which the virtual interface terminates. + AwsDeviceV2 *string // The BGP peers configured on this virtual interface. BgpPeers []*types.BGPPeer + // The ID of the connection. + ConnectionId *string + + // The IP address assigned to the customer interface. + CustomerAddress *string + + // The customer router configuration. + CustomerRouterConfig *string + + // The ID of the Direct Connect gateway. + DirectConnectGatewayId *string + + // Indicates whether jumbo frames (9001 MTU) are supported. + JumboFrameCapable *bool + + // The location of the connection. + Location *string + + // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and + // 9001. The default value is 1500. + Mtu *int32 + + // The ID of the AWS account that owns the virtual interface. + OwnerAccount *string + + // The AWS Region where the virtual interface is located. + Region *string + + // The routes to be advertised to the AWS network in this Region. Applies to public + // virtual interfaces. + RouteFilterPrefixes []*types.RouteFilterPrefix + + // The tags associated with the virtual interface. + Tags []*types.Tag + + // The ID of the virtual private gateway. Applies only to private virtual + // interfaces. + VirtualGatewayId *string + + // The ID of the virtual interface. + VirtualInterfaceId *string + + // The name of the virtual interface assigned by the customer network. The name has + // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a + // hyphen (-). + VirtualInterfaceName *string + // The state of the virtual interface. The following are the possible values: // // @@ -128,73 +192,9 @@ type AssociateVirtualInterfaceOutput struct { // The type of virtual interface. The possible values are private and public. VirtualInterfaceType *string - // The routes to be advertised to the AWS network in this Region. Applies to public - // virtual interfaces. - RouteFilterPrefixes []*types.RouteFilterPrefix - - // The authentication key for BGP configuration. This string has a minimum length - // of 6 characters and and a maximun lenth of 80 characters. - AuthKey *string - - // The Direct Connect endpoint on which the virtual interface terminates. - AwsDeviceV2 *string - - // The tags associated with the virtual interface. - Tags []*types.Tag - - // Indicates whether jumbo frames (9001 MTU) are supported. - JumboFrameCapable *bool - - // The ID of the AWS account that owns the virtual interface. - OwnerAccount *string - - // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and - // 9001. The default value is 1500. - Mtu *int32 - - // The IP address assigned to the customer interface. - CustomerAddress *string - - // The ID of the Direct Connect gateway. - DirectConnectGatewayId *string - - // The customer router configuration. - CustomerRouterConfig *string - - // The location of the connection. - Location *string - - // The ID of the virtual interface. - VirtualInterfaceId *string - - // The autonomous system number (ASN) for the Amazon side of the connection. - AmazonSideAsn *int64 - - // The IP address assigned to the Amazon interface. - AmazonAddress *string - - // The ID of the virtual private gateway. Applies only to private virtual - // interfaces. - VirtualGatewayId *string - - // The name of the virtual interface assigned by the customer network. The name has - // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a - // hyphen (-). - VirtualInterfaceName *string - // The ID of the VLAN. Vlan *int32 - // The autonomous system (AS) number for Border Gateway Protocol (BGP) - // configuration. The valid values are 1-2147483647. - Asn *int32 - - // The address family for the BGP peer. - AddressFamily types.AddressFamily - - // The AWS Region where the virtual interface is located. - Region *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/directconnect/api_op_ConfirmPrivateVirtualInterface.go b/service/directconnect/api_op_ConfirmPrivateVirtualInterface.go index 0731af7399d..7e231ab2c9e 100644 --- a/service/directconnect/api_op_ConfirmPrivateVirtualInterface.go +++ b/service/directconnect/api_op_ConfirmPrivateVirtualInterface.go @@ -60,9 +60,6 @@ func (c *Client) ConfirmPrivateVirtualInterface(ctx context.Context, params *Con type ConfirmPrivateVirtualInterfaceInput struct { - // The ID of the virtual private gateway. - VirtualGatewayId *string - // The ID of the virtual interface. // // This member is required. @@ -70,6 +67,9 @@ type ConfirmPrivateVirtualInterfaceInput struct { // The ID of the Direct Connect gateway. DirectConnectGatewayId *string + + // The ID of the virtual private gateway. + VirtualGatewayId *string } type ConfirmPrivateVirtualInterfaceOutput struct { diff --git a/service/directconnect/api_op_ConfirmTransitVirtualInterface.go b/service/directconnect/api_op_ConfirmTransitVirtualInterface.go index 98d0346a923..1a3248bdc65 100644 --- a/service/directconnect/api_op_ConfirmTransitVirtualInterface.go +++ b/service/directconnect/api_op_ConfirmTransitVirtualInterface.go @@ -60,15 +60,15 @@ func (c *Client) ConfirmTransitVirtualInterface(ctx context.Context, params *Con type ConfirmTransitVirtualInterfaceInput struct { - // The ID of the virtual interface. + // The ID of the Direct Connect gateway. // // This member is required. - VirtualInterfaceId *string + DirectConnectGatewayId *string - // The ID of the Direct Connect gateway. + // The ID of the virtual interface. // // This member is required. - DirectConnectGatewayId *string + VirtualInterfaceId *string } type ConfirmTransitVirtualInterfaceOutput struct { diff --git a/service/directconnect/api_op_CreateConnection.go b/service/directconnect/api_op_CreateConnection.go index e6ede10dc11..a7721e5ef4f 100644 --- a/service/directconnect/api_op_CreateConnection.go +++ b/service/directconnect/api_op_CreateConnection.go @@ -67,60 +67,48 @@ func (c *Client) CreateConnection(ctx context.Context, params *CreateConnectionI type CreateConnectionInput struct { - // The name of the service provider associated with the requested connection. - ProviderName *string - // The bandwidth of the connection. // // This member is required. Bandwidth *string - // The location of the connection. + // The name of the connection. // // This member is required. - Location *string - - // The tags to associate with the lag. - Tags []*types.Tag + ConnectionName *string - // The name of the connection. + // The location of the connection. // // This member is required. - ConnectionName *string + Location *string // The ID of the LAG. LagId *string + + // The name of the service provider associated with the requested connection. + ProviderName *string + + // The tags to associate with the lag. + Tags []*types.Tag } // Information about an AWS Direct Connect connection. type CreateConnectionOutput struct { - // Indicates whether jumbo frames (9001 MTU) are supported. - JumboFrameCapable *bool + // The Direct Connect endpoint on which the physical connection terminates. + AwsDevice *string // The Direct Connect endpoint on which the physical connection terminates. AwsDeviceV2 *string - // The ID of the VLAN. - Vlan *int32 - - // The name of the connection. - ConnectionName *string - - // The AWS Region where the connection is located. - Region *string - - // The ID of the LAG. - LagId *string + // The bandwidth of the connection. + Bandwidth *string // The ID of the connection. ConnectionId *string - // The tags associated with the connection. - Tags []*types.Tag - - // The ID of the AWS account that owns the connection. - OwnerAccount *string + // The name of the connection. + ConnectionName *string // The state of the connection. The following are the possible values: // @@ -155,28 +143,40 @@ type CreateConnectionOutput struct { // not available. ConnectionState types.ConnectionState - // The Direct Connect endpoint on which the physical connection terminates. - AwsDevice *string + // Indicates whether the connection supports a secondary BGP peer in the same + // address family (IPv4/IPv6). + HasLogicalRedundancy types.HasLogicalRedundancy - // The name of the AWS Direct Connect service provider associated with the - // connection. - PartnerName *string + // Indicates whether jumbo frames (9001 MTU) are supported. + JumboFrameCapable *bool + + // The ID of the LAG. + LagId *string // The time of the most recent call to DescribeLoa () for this connection. LoaIssueTime *time.Time - // Indicates whether the connection supports a secondary BGP peer in the same - // address family (IPv4/IPv6). - HasLogicalRedundancy types.HasLogicalRedundancy + // The location of the connection. + Location *string + + // The ID of the AWS account that owns the connection. + OwnerAccount *string + + // The name of the AWS Direct Connect service provider associated with the + // connection. + PartnerName *string // The name of the service provider associated with the connection. ProviderName *string - // The bandwidth of the connection. - Bandwidth *string + // The AWS Region where the connection is located. + Region *string - // The location of the connection. - Location *string + // The tags associated with the connection. + Tags []*types.Tag + + // The ID of the VLAN. + Vlan *int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/directconnect/api_op_CreateDirectConnectGateway.go b/service/directconnect/api_op_CreateDirectConnectGateway.go index f57b5b0a205..d2aab7da315 100644 --- a/service/directconnect/api_op_CreateDirectConnectGateway.go +++ b/service/directconnect/api_op_CreateDirectConnectGateway.go @@ -63,16 +63,16 @@ func (c *Client) CreateDirectConnectGateway(ctx context.Context, params *CreateD type CreateDirectConnectGatewayInput struct { + // The name of the Direct Connect gateway. + // + // This member is required. + DirectConnectGatewayName *string + // The autonomous system number (ASN) for Border Gateway Protocol (BGP) to be // configured on the Amazon side of the connection. The ASN must be in the private // range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294. The default is // 64512. AmazonSideAsn *int64 - - // The name of the Direct Connect gateway. - // - // This member is required. - DirectConnectGatewayName *string } type CreateDirectConnectGatewayOutput struct { diff --git a/service/directconnect/api_op_CreateDirectConnectGatewayAssociation.go b/service/directconnect/api_op_CreateDirectConnectGatewayAssociation.go index 2e50360061d..b424ee1a8d7 100644 --- a/service/directconnect/api_op_CreateDirectConnectGatewayAssociation.go +++ b/service/directconnect/api_op_CreateDirectConnectGatewayAssociation.go @@ -59,12 +59,6 @@ func (c *Client) CreateDirectConnectGatewayAssociation(ctx context.Context, para type CreateDirectConnectGatewayAssociationInput struct { - // The ID of the virtual private gateway. - VirtualGatewayId *string - - // The ID of the virtual private gateway or transit gateway. - GatewayId *string - // The ID of the Direct Connect gateway. // // This member is required. @@ -76,6 +70,12 @@ type CreateDirectConnectGatewayAssociationInput struct { // (https://docs.aws.amazon.com/directconnect/latest/UserGuide/multi-account-associate-vgw.html#allowed-prefixes) // in the AWS Direct Connect User Guide. AddAllowedPrefixesToDirectConnectGateway []*types.RouteFilterPrefix + + // The ID of the virtual private gateway or transit gateway. + GatewayId *string + + // The ID of the virtual private gateway. + VirtualGatewayId *string } type CreateDirectConnectGatewayAssociationOutput struct { diff --git a/service/directconnect/api_op_CreateDirectConnectGatewayAssociationProposal.go b/service/directconnect/api_op_CreateDirectConnectGatewayAssociationProposal.go index 9f01b273acd..99ad6bdb522 100644 --- a/service/directconnect/api_op_CreateDirectConnectGatewayAssociationProposal.go +++ b/service/directconnect/api_op_CreateDirectConnectGatewayAssociationProposal.go @@ -60,26 +60,26 @@ func (c *Client) CreateDirectConnectGatewayAssociationProposal(ctx context.Conte type CreateDirectConnectGatewayAssociationProposalInput struct { - // The ID of the virtual private gateway or transit gateway. + // The ID of the Direct Connect gateway. // // This member is required. - GatewayId *string + DirectConnectGatewayId *string - // The ID of the Direct Connect gateway. + // The ID of the AWS account that owns the Direct Connect gateway. // // This member is required. - DirectConnectGatewayId *string + DirectConnectGatewayOwnerAccount *string + + // The ID of the virtual private gateway or transit gateway. + // + // This member is required. + GatewayId *string // The Amazon VPC prefixes to advertise to the Direct Connect gateway. AddAllowedPrefixesToDirectConnectGateway []*types.RouteFilterPrefix // The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway. RemoveAllowedPrefixesToDirectConnectGateway []*types.RouteFilterPrefix - - // The ID of the AWS account that owns the Direct Connect gateway. - // - // This member is required. - DirectConnectGatewayOwnerAccount *string } type CreateDirectConnectGatewayAssociationProposalOutput struct { diff --git a/service/directconnect/api_op_CreateInterconnect.go b/service/directconnect/api_op_CreateInterconnect.go index e37dcf3bb30..e584cc70190 100644 --- a/service/directconnect/api_op_CreateInterconnect.go +++ b/service/directconnect/api_op_CreateInterconnect.go @@ -74,17 +74,11 @@ func (c *Client) CreateInterconnect(ctx context.Context, params *CreateInterconn type CreateInterconnectInput struct { - // The ID of the LAG. - LagId *string - // The port bandwidth, in Gbps. The possible values are 1 and 10. // // This member is required. Bandwidth *string - // The name of the service provider associated with the interconnect. - ProviderName *string - // The name of the interconnect. // // This member is required. @@ -95,6 +89,12 @@ type CreateInterconnectInput struct { // This member is required. Location *string + // The ID of the LAG. + LagId *string + + // The name of the service provider associated with the interconnect. + ProviderName *string + // The tags to associate with the interconnect. Tags []*types.Tag } @@ -102,8 +102,11 @@ type CreateInterconnectInput struct { // Information about an interconnect. type CreateInterconnectOutput struct { - // The ID of the interconnect. - InterconnectId *string + // The Direct Connect endpoint on which the physical connection terminates. + AwsDevice *string + + // The Direct Connect endpoint on which the physical connection terminates. + AwsDeviceV2 *string // The bandwidth of the connection. Bandwidth *string @@ -112,8 +115,11 @@ type CreateInterconnectOutput struct { // family (IPv4/IPv6). HasLogicalRedundancy types.HasLogicalRedundancy - // The name of the service provider associated with the interconnect. - ProviderName *string + // The ID of the interconnect. + InterconnectId *string + + // The name of the interconnect. + InterconnectName *string // The state of the interconnect. The following are the possible values: // @@ -139,32 +145,26 @@ type CreateInterconnectOutput struct { // * unknown: The state of the interconnect is not available. InterconnectState types.InterconnectState - // The tags associated with the interconnect. - Tags []*types.Tag - // Indicates whether jumbo frames (9001 MTU) are supported. JumboFrameCapable *bool + // The ID of the LAG. + LagId *string + // The time of the most recent call to DescribeLoa () for this connection. LoaIssueTime *time.Time - // The ID of the LAG. - LagId *string + // The location of the connection. + Location *string - // The Direct Connect endpoint on which the physical connection terminates. - AwsDevice *string + // The name of the service provider associated with the interconnect. + ProviderName *string // The AWS Region where the connection is located. Region *string - // The Direct Connect endpoint on which the physical connection terminates. - AwsDeviceV2 *string - - // The location of the connection. - Location *string - - // The name of the interconnect. - InterconnectName *string + // The tags associated with the interconnect. + Tags []*types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/directconnect/api_op_CreateLag.go b/service/directconnect/api_op_CreateLag.go index 9b285eca623..291fd840984 100644 --- a/service/directconnect/api_op_CreateLag.go +++ b/service/directconnect/api_op_CreateLag.go @@ -75,60 +75,73 @@ func (c *Client) CreateLag(ctx context.Context, params *CreateLagInput, optFns . type CreateLagInput struct { - // The ID of an existing connection to migrate to the LAG. - ConnectionId *string - - // The name of the service provider associated with the LAG. - ProviderName *string - - // The number of physical connections initially provisioned and bundled by the LAG. + // The bandwidth of the individual physical connections bundled by the LAG. The + // possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, + // 2Gbps, 5Gbps, and 10Gbps. // // This member is required. - NumberOfConnections *int32 - - // The tags to associate with the LAG. - Tags []*types.Tag + ConnectionsBandwidth *string - // The tags to associate with the automtically created LAGs. - ChildConnectionTags []*types.Tag + // The name of the LAG. + // + // This member is required. + LagName *string // The location for the LAG. // // This member is required. Location *string - // The bandwidth of the individual physical connections bundled by the LAG. The - // possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, - // 2Gbps, 5Gbps, and 10Gbps. + // The number of physical connections initially provisioned and bundled by the LAG. // // This member is required. - ConnectionsBandwidth *string + NumberOfConnections *int32 - // The name of the LAG. - // - // This member is required. - LagName *string + // The tags to associate with the automtically created LAGs. + ChildConnectionTags []*types.Tag + + // The ID of an existing connection to migrate to the LAG. + ConnectionId *string + + // The name of the service provider associated with the LAG. + ProviderName *string + + // The tags to associate with the LAG. + Tags []*types.Tag } // Information about a link aggregation group (LAG). type CreateLagOutput struct { - // The name of the service provider associated with the LAG. - ProviderName *string + // Indicates whether the LAG can host other connections. + AllowsHostedConnections *bool - // Indicates whether the LAG supports a secondary BGP peer in the same address - // family (IPv4/IPv6). - HasLogicalRedundancy types.HasLogicalRedundancy + // The AWS Direct Connect endpoint that hosts the LAG. + AwsDevice *string // The AWS Direct Connect endpoint that hosts the LAG. AwsDeviceV2 *string - // The AWS Direct Connect endpoint that hosts the LAG. - AwsDevice *string + // The connections bundled by the LAG. + Connections []*types.Connection + + // The individual bandwidth of the physical connections bundled by the LAG. The + // possible values are 1Gbps and 10Gbps. + ConnectionsBandwidth *string + + // Indicates whether the LAG supports a secondary BGP peer in the same address + // family (IPv4/IPv6). + HasLogicalRedundancy types.HasLogicalRedundancy + + // Indicates whether jumbo frames (9001 MTU) are supported. + JumboFrameCapable *bool // The ID of the LAG. LagId *string + // The name of the LAG. + LagName *string + // The state of the LAG. The following are the possible values: // // * requested: @@ -152,24 +165,12 @@ type CreateLagOutput struct { // * unknown: The state of the LAG is not available. LagState types.LagState - // Indicates whether jumbo frames (9001 MTU) are supported. - JumboFrameCapable *bool - - // Indicates whether the LAG can host other connections. - AllowsHostedConnections *bool - - // The individual bandwidth of the physical connections bundled by the LAG. The - // possible values are 1Gbps and 10Gbps. - ConnectionsBandwidth *string - - // The tags associated with the LAG. - Tags []*types.Tag - // The location of the LAG. Location *string - // The name of the LAG. - LagName *string + // The minimum number of physical connections that must be operational for the LAG + // itself to be operational. + MinimumLinks *int32 // The number of physical connections bundled by the LAG, up to a maximum of 10. NumberOfConnections *int32 @@ -177,15 +178,14 @@ type CreateLagOutput struct { // The ID of the AWS account that owns the LAG. OwnerAccount *string - // The connections bundled by the LAG. - Connections []*types.Connection + // The name of the service provider associated with the LAG. + ProviderName *string // The AWS Region where the connection is located. Region *string - // The minimum number of physical connections that must be operational for the LAG - // itself to be operational. - MinimumLinks *int32 + // The tags associated with the LAG. + Tags []*types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/directconnect/api_op_CreatePrivateVirtualInterface.go b/service/directconnect/api_op_CreatePrivateVirtualInterface.go index dd64ce51114..696a3c3d379 100644 --- a/service/directconnect/api_op_CreatePrivateVirtualInterface.go +++ b/service/directconnect/api_op_CreatePrivateVirtualInterface.go @@ -83,12 +83,76 @@ type CreatePrivateVirtualInterfaceInput struct { // Information about a virtual interface. type CreatePrivateVirtualInterfaceOutput struct { - // The ID of the connection. - ConnectionId *string + // The address family for the BGP peer. + AddressFamily types.AddressFamily + + // The IP address assigned to the Amazon interface. + AmazonAddress *string + + // The autonomous system number (ASN) for the Amazon side of the connection. + AmazonSideAsn *int64 + + // The autonomous system (AS) number for Border Gateway Protocol (BGP) + // configuration. The valid values are 1-2147483647. + Asn *int32 + + // The authentication key for BGP configuration. This string has a minimum length + // of 6 characters and and a maximun lenth of 80 characters. + AuthKey *string + + // The Direct Connect endpoint on which the virtual interface terminates. + AwsDeviceV2 *string // The BGP peers configured on this virtual interface. BgpPeers []*types.BGPPeer + // The ID of the connection. + ConnectionId *string + + // The IP address assigned to the customer interface. + CustomerAddress *string + + // The customer router configuration. + CustomerRouterConfig *string + + // The ID of the Direct Connect gateway. + DirectConnectGatewayId *string + + // Indicates whether jumbo frames (9001 MTU) are supported. + JumboFrameCapable *bool + + // The location of the connection. + Location *string + + // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and + // 9001. The default value is 1500. + Mtu *int32 + + // The ID of the AWS account that owns the virtual interface. + OwnerAccount *string + + // The AWS Region where the virtual interface is located. + Region *string + + // The routes to be advertised to the AWS network in this Region. Applies to public + // virtual interfaces. + RouteFilterPrefixes []*types.RouteFilterPrefix + + // The tags associated with the virtual interface. + Tags []*types.Tag + + // The ID of the virtual private gateway. Applies only to private virtual + // interfaces. + VirtualGatewayId *string + + // The ID of the virtual interface. + VirtualInterfaceId *string + + // The name of the virtual interface assigned by the customer network. The name has + // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a + // hyphen (-). + VirtualInterfaceName *string + // The state of the virtual interface. The following are the possible values: // // @@ -130,73 +194,9 @@ type CreatePrivateVirtualInterfaceOutput struct { // The type of virtual interface. The possible values are private and public. VirtualInterfaceType *string - // The routes to be advertised to the AWS network in this Region. Applies to public - // virtual interfaces. - RouteFilterPrefixes []*types.RouteFilterPrefix - - // The authentication key for BGP configuration. This string has a minimum length - // of 6 characters and and a maximun lenth of 80 characters. - AuthKey *string - - // The Direct Connect endpoint on which the virtual interface terminates. - AwsDeviceV2 *string - - // The tags associated with the virtual interface. - Tags []*types.Tag - - // Indicates whether jumbo frames (9001 MTU) are supported. - JumboFrameCapable *bool - - // The ID of the AWS account that owns the virtual interface. - OwnerAccount *string - - // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and - // 9001. The default value is 1500. - Mtu *int32 - - // The IP address assigned to the customer interface. - CustomerAddress *string - - // The ID of the Direct Connect gateway. - DirectConnectGatewayId *string - - // The customer router configuration. - CustomerRouterConfig *string - - // The location of the connection. - Location *string - - // The ID of the virtual interface. - VirtualInterfaceId *string - - // The autonomous system number (ASN) for the Amazon side of the connection. - AmazonSideAsn *int64 - - // The IP address assigned to the Amazon interface. - AmazonAddress *string - - // The ID of the virtual private gateway. Applies only to private virtual - // interfaces. - VirtualGatewayId *string - - // The name of the virtual interface assigned by the customer network. The name has - // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a - // hyphen (-). - VirtualInterfaceName *string - // The ID of the VLAN. Vlan *int32 - // The autonomous system (AS) number for Border Gateway Protocol (BGP) - // configuration. The valid values are 1-2147483647. - Asn *int32 - - // The address family for the BGP peer. - AddressFamily types.AddressFamily - - // The AWS Region where the virtual interface is located. - Region *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/directconnect/api_op_CreatePublicVirtualInterface.go b/service/directconnect/api_op_CreatePublicVirtualInterface.go index 842bbb75d70..70432a7d1b0 100644 --- a/service/directconnect/api_op_CreatePublicVirtualInterface.go +++ b/service/directconnect/api_op_CreatePublicVirtualInterface.go @@ -76,12 +76,76 @@ type CreatePublicVirtualInterfaceInput struct { // Information about a virtual interface. type CreatePublicVirtualInterfaceOutput struct { - // The ID of the connection. - ConnectionId *string + // The address family for the BGP peer. + AddressFamily types.AddressFamily + + // The IP address assigned to the Amazon interface. + AmazonAddress *string + + // The autonomous system number (ASN) for the Amazon side of the connection. + AmazonSideAsn *int64 + + // The autonomous system (AS) number for Border Gateway Protocol (BGP) + // configuration. The valid values are 1-2147483647. + Asn *int32 + + // The authentication key for BGP configuration. This string has a minimum length + // of 6 characters and and a maximun lenth of 80 characters. + AuthKey *string + + // The Direct Connect endpoint on which the virtual interface terminates. + AwsDeviceV2 *string // The BGP peers configured on this virtual interface. BgpPeers []*types.BGPPeer + // The ID of the connection. + ConnectionId *string + + // The IP address assigned to the customer interface. + CustomerAddress *string + + // The customer router configuration. + CustomerRouterConfig *string + + // The ID of the Direct Connect gateway. + DirectConnectGatewayId *string + + // Indicates whether jumbo frames (9001 MTU) are supported. + JumboFrameCapable *bool + + // The location of the connection. + Location *string + + // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and + // 9001. The default value is 1500. + Mtu *int32 + + // The ID of the AWS account that owns the virtual interface. + OwnerAccount *string + + // The AWS Region where the virtual interface is located. + Region *string + + // The routes to be advertised to the AWS network in this Region. Applies to public + // virtual interfaces. + RouteFilterPrefixes []*types.RouteFilterPrefix + + // The tags associated with the virtual interface. + Tags []*types.Tag + + // The ID of the virtual private gateway. Applies only to private virtual + // interfaces. + VirtualGatewayId *string + + // The ID of the virtual interface. + VirtualInterfaceId *string + + // The name of the virtual interface assigned by the customer network. The name has + // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a + // hyphen (-). + VirtualInterfaceName *string + // The state of the virtual interface. The following are the possible values: // // @@ -123,73 +187,9 @@ type CreatePublicVirtualInterfaceOutput struct { // The type of virtual interface. The possible values are private and public. VirtualInterfaceType *string - // The routes to be advertised to the AWS network in this Region. Applies to public - // virtual interfaces. - RouteFilterPrefixes []*types.RouteFilterPrefix - - // The authentication key for BGP configuration. This string has a minimum length - // of 6 characters and and a maximun lenth of 80 characters. - AuthKey *string - - // The Direct Connect endpoint on which the virtual interface terminates. - AwsDeviceV2 *string - - // The tags associated with the virtual interface. - Tags []*types.Tag - - // Indicates whether jumbo frames (9001 MTU) are supported. - JumboFrameCapable *bool - - // The ID of the AWS account that owns the virtual interface. - OwnerAccount *string - - // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and - // 9001. The default value is 1500. - Mtu *int32 - - // The IP address assigned to the customer interface. - CustomerAddress *string - - // The ID of the Direct Connect gateway. - DirectConnectGatewayId *string - - // The customer router configuration. - CustomerRouterConfig *string - - // The location of the connection. - Location *string - - // The ID of the virtual interface. - VirtualInterfaceId *string - - // The autonomous system number (ASN) for the Amazon side of the connection. - AmazonSideAsn *int64 - - // The IP address assigned to the Amazon interface. - AmazonAddress *string - - // The ID of the virtual private gateway. Applies only to private virtual - // interfaces. - VirtualGatewayId *string - - // The name of the virtual interface assigned by the customer network. The name has - // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a - // hyphen (-). - VirtualInterfaceName *string - // The ID of the VLAN. Vlan *int32 - // The autonomous system (AS) number for Border Gateway Protocol (BGP) - // configuration. The valid values are 1-2147483647. - Asn *int32 - - // The address family for the BGP peer. - AddressFamily types.AddressFamily - - // The AWS Region where the virtual interface is located. - Region *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/directconnect/api_op_CreateTransitVirtualInterface.go b/service/directconnect/api_op_CreateTransitVirtualInterface.go index 15ddf27a8f3..3b22adbaaf1 100644 --- a/service/directconnect/api_op_CreateTransitVirtualInterface.go +++ b/service/directconnect/api_op_CreateTransitVirtualInterface.go @@ -71,15 +71,15 @@ func (c *Client) CreateTransitVirtualInterface(ctx context.Context, params *Crea type CreateTransitVirtualInterfaceInput struct { - // Information about the transit virtual interface. + // The ID of the connection. // // This member is required. - NewTransitVirtualInterface *types.NewTransitVirtualInterface + ConnectionId *string - // The ID of the connection. + // Information about the transit virtual interface. // // This member is required. - ConnectionId *string + NewTransitVirtualInterface *types.NewTransitVirtualInterface } type CreateTransitVirtualInterfaceOutput struct { diff --git a/service/directconnect/api_op_DeleteBGPPeer.go b/service/directconnect/api_op_DeleteBGPPeer.go index 8cb851d2690..88d238eb444 100644 --- a/service/directconnect/api_op_DeleteBGPPeer.go +++ b/service/directconnect/api_op_DeleteBGPPeer.go @@ -58,18 +58,18 @@ func (c *Client) DeleteBGPPeer(ctx context.Context, params *DeleteBGPPeerInput, type DeleteBGPPeerInput struct { - // The IP address assigned to the customer interface. - CustomerAddress *string - // The autonomous system (AS) number for Border Gateway Protocol (BGP) // configuration. Asn *int32 - // The ID of the virtual interface. - VirtualInterfaceId *string - // The ID of the BGP peer. BgpPeerId *string + + // The IP address assigned to the customer interface. + CustomerAddress *string + + // The ID of the virtual interface. + VirtualInterfaceId *string } type DeleteBGPPeerOutput struct { diff --git a/service/directconnect/api_op_DeleteConnection.go b/service/directconnect/api_op_DeleteConnection.go index 611ce5d85a4..95ce298f71f 100644 --- a/service/directconnect/api_op_DeleteConnection.go +++ b/service/directconnect/api_op_DeleteConnection.go @@ -70,32 +70,20 @@ type DeleteConnectionInput struct { // Information about an AWS Direct Connect connection. type DeleteConnectionOutput struct { - // Indicates whether jumbo frames (9001 MTU) are supported. - JumboFrameCapable *bool + // The Direct Connect endpoint on which the physical connection terminates. + AwsDevice *string // The Direct Connect endpoint on which the physical connection terminates. AwsDeviceV2 *string - // The ID of the VLAN. - Vlan *int32 - - // The name of the connection. - ConnectionName *string - - // The AWS Region where the connection is located. - Region *string - - // The ID of the LAG. - LagId *string + // The bandwidth of the connection. + Bandwidth *string // The ID of the connection. ConnectionId *string - // The tags associated with the connection. - Tags []*types.Tag - - // The ID of the AWS account that owns the connection. - OwnerAccount *string + // The name of the connection. + ConnectionName *string // The state of the connection. The following are the possible values: // @@ -130,28 +118,40 @@ type DeleteConnectionOutput struct { // not available. ConnectionState types.ConnectionState - // The Direct Connect endpoint on which the physical connection terminates. - AwsDevice *string + // Indicates whether the connection supports a secondary BGP peer in the same + // address family (IPv4/IPv6). + HasLogicalRedundancy types.HasLogicalRedundancy - // The name of the AWS Direct Connect service provider associated with the - // connection. - PartnerName *string + // Indicates whether jumbo frames (9001 MTU) are supported. + JumboFrameCapable *bool + + // The ID of the LAG. + LagId *string // The time of the most recent call to DescribeLoa () for this connection. LoaIssueTime *time.Time - // Indicates whether the connection supports a secondary BGP peer in the same - // address family (IPv4/IPv6). - HasLogicalRedundancy types.HasLogicalRedundancy + // The location of the connection. + Location *string + + // The ID of the AWS account that owns the connection. + OwnerAccount *string + + // The name of the AWS Direct Connect service provider associated with the + // connection. + PartnerName *string // The name of the service provider associated with the connection. ProviderName *string - // The bandwidth of the connection. - Bandwidth *string + // The AWS Region where the connection is located. + Region *string - // The location of the connection. - Location *string + // The tags associated with the connection. + Tags []*types.Tag + + // The ID of the VLAN. + Vlan *int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/directconnect/api_op_DeleteDirectConnectGatewayAssociation.go b/service/directconnect/api_op_DeleteDirectConnectGatewayAssociation.go index 506fd85c59d..d62bab9abaf 100644 --- a/service/directconnect/api_op_DeleteDirectConnectGatewayAssociation.go +++ b/service/directconnect/api_op_DeleteDirectConnectGatewayAssociation.go @@ -60,14 +60,14 @@ func (c *Client) DeleteDirectConnectGatewayAssociation(ctx context.Context, para type DeleteDirectConnectGatewayAssociationInput struct { - // The ID of the virtual private gateway. - VirtualGatewayId *string + // The ID of the Direct Connect gateway association. + AssociationId *string // The ID of the Direct Connect gateway. DirectConnectGatewayId *string - // The ID of the Direct Connect gateway association. - AssociationId *string + // The ID of the virtual private gateway. + VirtualGatewayId *string } type DeleteDirectConnectGatewayAssociationOutput struct { diff --git a/service/directconnect/api_op_DeleteLag.go b/service/directconnect/api_op_DeleteLag.go index 7078a3faf3d..f4fe92c5a97 100644 --- a/service/directconnect/api_op_DeleteLag.go +++ b/service/directconnect/api_op_DeleteLag.go @@ -67,22 +67,35 @@ type DeleteLagInput struct { // Information about a link aggregation group (LAG). type DeleteLagOutput struct { - // The name of the service provider associated with the LAG. - ProviderName *string + // Indicates whether the LAG can host other connections. + AllowsHostedConnections *bool - // Indicates whether the LAG supports a secondary BGP peer in the same address - // family (IPv4/IPv6). - HasLogicalRedundancy types.HasLogicalRedundancy + // The AWS Direct Connect endpoint that hosts the LAG. + AwsDevice *string // The AWS Direct Connect endpoint that hosts the LAG. AwsDeviceV2 *string - // The AWS Direct Connect endpoint that hosts the LAG. - AwsDevice *string + // The connections bundled by the LAG. + Connections []*types.Connection + + // The individual bandwidth of the physical connections bundled by the LAG. The + // possible values are 1Gbps and 10Gbps. + ConnectionsBandwidth *string + + // Indicates whether the LAG supports a secondary BGP peer in the same address + // family (IPv4/IPv6). + HasLogicalRedundancy types.HasLogicalRedundancy + + // Indicates whether jumbo frames (9001 MTU) are supported. + JumboFrameCapable *bool // The ID of the LAG. LagId *string + // The name of the LAG. + LagName *string + // The state of the LAG. The following are the possible values: // // * requested: @@ -106,24 +119,12 @@ type DeleteLagOutput struct { // * unknown: The state of the LAG is not available. LagState types.LagState - // Indicates whether jumbo frames (9001 MTU) are supported. - JumboFrameCapable *bool - - // Indicates whether the LAG can host other connections. - AllowsHostedConnections *bool - - // The individual bandwidth of the physical connections bundled by the LAG. The - // possible values are 1Gbps and 10Gbps. - ConnectionsBandwidth *string - - // The tags associated with the LAG. - Tags []*types.Tag - // The location of the LAG. Location *string - // The name of the LAG. - LagName *string + // The minimum number of physical connections that must be operational for the LAG + // itself to be operational. + MinimumLinks *int32 // The number of physical connections bundled by the LAG, up to a maximum of 10. NumberOfConnections *int32 @@ -131,15 +132,14 @@ type DeleteLagOutput struct { // The ID of the AWS account that owns the LAG. OwnerAccount *string - // The connections bundled by the LAG. - Connections []*types.Connection + // The name of the service provider associated with the LAG. + ProviderName *string // The AWS Region where the connection is located. Region *string - // The minimum number of physical connections that must be operational for the LAG - // itself to be operational. - MinimumLinks *int32 + // The tags associated with the LAG. + Tags []*types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/directconnect/api_op_DescribeConnectionLoa.go b/service/directconnect/api_op_DescribeConnectionLoa.go index 20c4ab0f344..ccb4e233d12 100644 --- a/service/directconnect/api_op_DescribeConnectionLoa.go +++ b/service/directconnect/api_op_DescribeConnectionLoa.go @@ -63,19 +63,19 @@ func (c *Client) DescribeConnectionLoa(ctx context.Context, params *DescribeConn type DescribeConnectionLoaInput struct { - // The name of the APN partner or service provider who establishes connectivity on - // your behalf. If you specify this parameter, the LOA-CFA lists the provider name - // alongside your company name as the requester of the cross connect. - ProviderName *string + // The ID of the connection. + // + // This member is required. + ConnectionId *string // The standard media type for the LOA-CFA document. The only supported value is // application/pdf. LoaContentType types.LoaContentType - // The ID of the connection. - // - // This member is required. - ConnectionId *string + // The name of the APN partner or service provider who establishes connectivity on + // your behalf. If you specify this parameter, the LOA-CFA lists the provider name + // alongside your company name as the requester of the cross connect. + ProviderName *string } type DescribeConnectionLoaOutput struct { diff --git a/service/directconnect/api_op_DescribeDirectConnectGatewayAssociationProposals.go b/service/directconnect/api_op_DescribeDirectConnectGatewayAssociationProposals.go index 1cfdf3e9d90..a1be033eade 100644 --- a/service/directconnect/api_op_DescribeDirectConnectGatewayAssociationProposals.go +++ b/service/directconnect/api_op_DescribeDirectConnectGatewayAssociationProposals.go @@ -57,12 +57,12 @@ func (c *Client) DescribeDirectConnectGatewayAssociationProposals(ctx context.Co type DescribeDirectConnectGatewayAssociationProposalsInput struct { + // The ID of the associated gateway. + AssociatedGatewayId *string + // The ID of the Direct Connect gateway. DirectConnectGatewayId *string - // The ID of the proposal. - ProposalId *string - // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. If // MaxResults is given a value larger than 100, only 100 results are returned. @@ -71,19 +71,19 @@ type DescribeDirectConnectGatewayAssociationProposalsInput struct { // The token for the next page of results. NextToken *string - // The ID of the associated gateway. - AssociatedGatewayId *string + // The ID of the proposal. + ProposalId *string } type DescribeDirectConnectGatewayAssociationProposalsOutput struct { + // Describes the Direct Connect gateway association proposals. + DirectConnectGatewayAssociationProposals []*types.DirectConnectGatewayAssociationProposal + // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string - // Describes the Direct Connect gateway association proposals. - DirectConnectGatewayAssociationProposals []*types.DirectConnectGatewayAssociationProposal - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/directconnect/api_op_DescribeDirectConnectGatewayAssociations.go b/service/directconnect/api_op_DescribeDirectConnectGatewayAssociations.go index 178fd07128c..311618450ff 100644 --- a/service/directconnect/api_op_DescribeDirectConnectGatewayAssociations.go +++ b/service/directconnect/api_op_DescribeDirectConnectGatewayAssociations.go @@ -63,35 +63,35 @@ func (c *Client) DescribeDirectConnectGatewayAssociations(ctx context.Context, p type DescribeDirectConnectGatewayAssociationsInput struct { + // The ID of the associated gateway. + AssociatedGatewayId *string + // The ID of the Direct Connect gateway association. AssociationId *string - // The token provided in the previous call to retrieve the next page. - NextToken *string - // The ID of the Direct Connect gateway. DirectConnectGatewayId *string - // The ID of the associated gateway. - AssociatedGatewayId *string - // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. If // MaxResults is given a value larger than 100, only 100 results are returned. MaxResults *int32 + // The token provided in the previous call to retrieve the next page. + NextToken *string + // The ID of the virtual private gateway. VirtualGatewayId *string } type DescribeDirectConnectGatewayAssociationsOutput struct { - // The token to retrieve the next page. - NextToken *string - // Information about the associations. DirectConnectGatewayAssociations []*types.DirectConnectGatewayAssociation + // The token to retrieve the next page. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/directconnect/api_op_DescribeDirectConnectGatewayAttachments.go b/service/directconnect/api_op_DescribeDirectConnectGatewayAttachments.go index aec1f94b6ee..5d582a05711 100644 --- a/service/directconnect/api_op_DescribeDirectConnectGatewayAttachments.go +++ b/service/directconnect/api_op_DescribeDirectConnectGatewayAttachments.go @@ -79,12 +79,12 @@ type DescribeDirectConnectGatewayAttachmentsInput struct { type DescribeDirectConnectGatewayAttachmentsOutput struct { - // The token to retrieve the next page. - NextToken *string - // The attachments. DirectConnectGatewayAttachments []*types.DirectConnectGatewayAttachment + // The token to retrieve the next page. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/directconnect/api_op_DescribeInterconnectLoa.go b/service/directconnect/api_op_DescribeInterconnectLoa.go index 1481bfd4ed1..014b8842b16 100644 --- a/service/directconnect/api_op_DescribeInterconnectLoa.go +++ b/service/directconnect/api_op_DescribeInterconnectLoa.go @@ -68,14 +68,14 @@ type DescribeInterconnectLoaInput struct { // This member is required. InterconnectId *string + // The standard media type for the LOA-CFA document. The only supported value is + // application/pdf. + LoaContentType types.LoaContentType + // The name of the service provider who establishes connectivity on your behalf. If // you supply this parameter, the LOA-CFA lists the provider name alongside your // company name as the requester of the cross connect. ProviderName *string - - // The standard media type for the LOA-CFA document. The only supported value is - // application/pdf. - LoaContentType types.LoaContentType } type DescribeInterconnectLoaOutput struct { diff --git a/service/directconnect/api_op_DescribeLoa.go b/service/directconnect/api_op_DescribeLoa.go index 82bb678b05d..02b3bd51ce6 100644 --- a/service/directconnect/api_op_DescribeLoa.go +++ b/service/directconnect/api_op_DescribeLoa.go @@ -68,14 +68,14 @@ type DescribeLoaInput struct { // This member is required. ConnectionId *string + // The standard media type for the LOA-CFA document. The only supported value is + // application/pdf. + LoaContentType types.LoaContentType + // The name of the service provider who establishes connectivity on your behalf. If // you specify this parameter, the LOA-CFA lists the provider name alongside your // company name as the requester of the cross connect. ProviderName *string - - // The standard media type for the LOA-CFA document. The only supported value is - // application/pdf. - LoaContentType types.LoaContentType } // Information about a Letter of Authorization - Connecting Facility Assignment diff --git a/service/directconnect/api_op_DescribeVirtualInterfaces.go b/service/directconnect/api_op_DescribeVirtualInterfaces.go index a26c7d3915a..fa596bb051c 100644 --- a/service/directconnect/api_op_DescribeVirtualInterfaces.go +++ b/service/directconnect/api_op_DescribeVirtualInterfaces.go @@ -61,11 +61,11 @@ func (c *Client) DescribeVirtualInterfaces(ctx context.Context, params *Describe type DescribeVirtualInterfacesInput struct { - // The ID of the virtual interface. - VirtualInterfaceId *string - // The ID of the connection. ConnectionId *string + + // The ID of the virtual interface. + VirtualInterfaceId *string } type DescribeVirtualInterfacesOutput struct { diff --git a/service/directconnect/api_op_DisassociateConnectionFromLag.go b/service/directconnect/api_op_DisassociateConnectionFromLag.go index 38fe130b25b..82de52d26c3 100644 --- a/service/directconnect/api_op_DisassociateConnectionFromLag.go +++ b/service/directconnect/api_op_DisassociateConnectionFromLag.go @@ -81,32 +81,20 @@ type DisassociateConnectionFromLagInput struct { // Information about an AWS Direct Connect connection. type DisassociateConnectionFromLagOutput struct { - // Indicates whether jumbo frames (9001 MTU) are supported. - JumboFrameCapable *bool + // The Direct Connect endpoint on which the physical connection terminates. + AwsDevice *string // The Direct Connect endpoint on which the physical connection terminates. AwsDeviceV2 *string - // The ID of the VLAN. - Vlan *int32 - - // The name of the connection. - ConnectionName *string - - // The AWS Region where the connection is located. - Region *string - - // The ID of the LAG. - LagId *string + // The bandwidth of the connection. + Bandwidth *string // The ID of the connection. ConnectionId *string - // The tags associated with the connection. - Tags []*types.Tag - - // The ID of the AWS account that owns the connection. - OwnerAccount *string + // The name of the connection. + ConnectionName *string // The state of the connection. The following are the possible values: // @@ -141,28 +129,40 @@ type DisassociateConnectionFromLagOutput struct { // not available. ConnectionState types.ConnectionState - // The Direct Connect endpoint on which the physical connection terminates. - AwsDevice *string + // Indicates whether the connection supports a secondary BGP peer in the same + // address family (IPv4/IPv6). + HasLogicalRedundancy types.HasLogicalRedundancy - // The name of the AWS Direct Connect service provider associated with the - // connection. - PartnerName *string + // Indicates whether jumbo frames (9001 MTU) are supported. + JumboFrameCapable *bool + + // The ID of the LAG. + LagId *string // The time of the most recent call to DescribeLoa () for this connection. LoaIssueTime *time.Time - // Indicates whether the connection supports a secondary BGP peer in the same - // address family (IPv4/IPv6). - HasLogicalRedundancy types.HasLogicalRedundancy + // The location of the connection. + Location *string + + // The ID of the AWS account that owns the connection. + OwnerAccount *string + + // The name of the AWS Direct Connect service provider associated with the + // connection. + PartnerName *string // The name of the service provider associated with the connection. ProviderName *string - // The bandwidth of the connection. - Bandwidth *string + // The AWS Region where the connection is located. + Region *string - // The location of the connection. - Location *string + // The tags associated with the connection. + Tags []*types.Tag + + // The ID of the VLAN. + Vlan *int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/directconnect/api_op_ListVirtualInterfaceTestHistory.go b/service/directconnect/api_op_ListVirtualInterfaceTestHistory.go index 5134ebcf1af..456b8926924 100644 --- a/service/directconnect/api_op_ListVirtualInterfaceTestHistory.go +++ b/service/directconnect/api_op_ListVirtualInterfaceTestHistory.go @@ -56,6 +56,10 @@ func (c *Client) ListVirtualInterfaceTestHistory(ctx context.Context, params *Li type ListVirtualInterfaceTestHistoryInput struct { + // The BGP peers that were placed in the DOWN state during the virtual interface + // failover test. + BgpPeers []*string + // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. If // MaxResults is given a value larger than 100, only 100 results are returned. @@ -64,15 +68,11 @@ type ListVirtualInterfaceTestHistoryInput struct { // The token for the next page of results. NextToken *string - // The ID of the virtual interface failover test. - TestId *string - // The status of the virtual interface failover test. Status *string - // The BGP peers that were placed in the DOWN state during the virtual interface - // failover test. - BgpPeers []*string + // The ID of the virtual interface failover test. + TestId *string // The ID of the virtual interface that was tested. VirtualInterfaceId *string diff --git a/service/directconnect/api_op_StartBgpFailoverTest.go b/service/directconnect/api_op_StartBgpFailoverTest.go index 739aa96e129..9ce3283c102 100644 --- a/service/directconnect/api_op_StartBgpFailoverTest.go +++ b/service/directconnect/api_op_StartBgpFailoverTest.go @@ -65,10 +65,6 @@ func (c *Client) StartBgpFailoverTest(ctx context.Context, params *StartBgpFailo type StartBgpFailoverTestInput struct { - // The time in minutes that the virtual interface failover test will last. Maximum - // value: 180 minutes (3 hours). Default: 180 minutes (3 hours). - TestDurationInMinutes *int32 - // The ID of the virtual interface you want to test. // // This member is required. @@ -76,6 +72,10 @@ type StartBgpFailoverTestInput struct { // The BGP peers to place in the DOWN state. BgpPeers []*string + + // The time in minutes that the virtual interface failover test will last. Maximum + // value: 180 minutes (3 hours). Default: 180 minutes (3 hours). + TestDurationInMinutes *int32 } type StartBgpFailoverTestOutput struct { diff --git a/service/directconnect/api_op_TagResource.go b/service/directconnect/api_op_TagResource.go index 505685f1b4a..5f198e80a69 100644 --- a/service/directconnect/api_op_TagResource.go +++ b/service/directconnect/api_op_TagResource.go @@ -60,15 +60,15 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The tags to add. + // The Amazon Resource Name (ARN) of the resource. // // This member is required. - Tags []*types.Tag + ResourceArn *string - // The Amazon Resource Name (ARN) of the resource. + // The tags to add. // // This member is required. - ResourceArn *string + Tags []*types.Tag } type TagResourceOutput struct { diff --git a/service/directconnect/api_op_UntagResource.go b/service/directconnect/api_op_UntagResource.go index d5e062c2a62..0c0044e21d3 100644 --- a/service/directconnect/api_op_UntagResource.go +++ b/service/directconnect/api_op_UntagResource.go @@ -56,15 +56,15 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The tag keys of the tags to remove. + // The Amazon Resource Name (ARN) of the resource. // // This member is required. - TagKeys []*string + ResourceArn *string - // The Amazon Resource Name (ARN) of the resource. + // The tag keys of the tags to remove. // // This member is required. - ResourceArn *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/directconnect/api_op_UpdateDirectConnectGatewayAssociation.go b/service/directconnect/api_op_UpdateDirectConnectGatewayAssociation.go index 2cb7dc61e37..d029def23c7 100644 --- a/service/directconnect/api_op_UpdateDirectConnectGatewayAssociation.go +++ b/service/directconnect/api_op_UpdateDirectConnectGatewayAssociation.go @@ -57,14 +57,14 @@ func (c *Client) UpdateDirectConnectGatewayAssociation(ctx context.Context, para type UpdateDirectConnectGatewayAssociationInput struct { - // The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway. - RemoveAllowedPrefixesToDirectConnectGateway []*types.RouteFilterPrefix + // The Amazon VPC prefixes to advertise to the Direct Connect gateway. + AddAllowedPrefixesToDirectConnectGateway []*types.RouteFilterPrefix // The ID of the Direct Connect gateway association. AssociationId *string - // The Amazon VPC prefixes to advertise to the Direct Connect gateway. - AddAllowedPrefixesToDirectConnectGateway []*types.RouteFilterPrefix + // The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway. + RemoveAllowedPrefixesToDirectConnectGateway []*types.RouteFilterPrefix } type UpdateDirectConnectGatewayAssociationOutput struct { diff --git a/service/directconnect/api_op_UpdateLag.go b/service/directconnect/api_op_UpdateLag.go index b54aa36be0e..9a4fa93ec6f 100644 --- a/service/directconnect/api_op_UpdateLag.go +++ b/service/directconnect/api_op_UpdateLag.go @@ -71,38 +71,51 @@ func (c *Client) UpdateLag(ctx context.Context, params *UpdateLagInput, optFns . type UpdateLagInput struct { + // The ID of the LAG. + // + // This member is required. + LagId *string + // The name of the LAG. LagName *string // The minimum number of physical connections that must be operational for the LAG // itself to be operational. MinimumLinks *int32 - - // The ID of the LAG. - // - // This member is required. - LagId *string } // Information about a link aggregation group (LAG). type UpdateLagOutput struct { - // The name of the service provider associated with the LAG. - ProviderName *string + // Indicates whether the LAG can host other connections. + AllowsHostedConnections *bool - // Indicates whether the LAG supports a secondary BGP peer in the same address - // family (IPv4/IPv6). - HasLogicalRedundancy types.HasLogicalRedundancy + // The AWS Direct Connect endpoint that hosts the LAG. + AwsDevice *string // The AWS Direct Connect endpoint that hosts the LAG. AwsDeviceV2 *string - // The AWS Direct Connect endpoint that hosts the LAG. - AwsDevice *string + // The connections bundled by the LAG. + Connections []*types.Connection + + // The individual bandwidth of the physical connections bundled by the LAG. The + // possible values are 1Gbps and 10Gbps. + ConnectionsBandwidth *string + + // Indicates whether the LAG supports a secondary BGP peer in the same address + // family (IPv4/IPv6). + HasLogicalRedundancy types.HasLogicalRedundancy + + // Indicates whether jumbo frames (9001 MTU) are supported. + JumboFrameCapable *bool // The ID of the LAG. LagId *string + // The name of the LAG. + LagName *string + // The state of the LAG. The following are the possible values: // // * requested: @@ -126,24 +139,12 @@ type UpdateLagOutput struct { // * unknown: The state of the LAG is not available. LagState types.LagState - // Indicates whether jumbo frames (9001 MTU) are supported. - JumboFrameCapable *bool - - // Indicates whether the LAG can host other connections. - AllowsHostedConnections *bool - - // The individual bandwidth of the physical connections bundled by the LAG. The - // possible values are 1Gbps and 10Gbps. - ConnectionsBandwidth *string - - // The tags associated with the LAG. - Tags []*types.Tag - // The location of the LAG. Location *string - // The name of the LAG. - LagName *string + // The minimum number of physical connections that must be operational for the LAG + // itself to be operational. + MinimumLinks *int32 // The number of physical connections bundled by the LAG, up to a maximum of 10. NumberOfConnections *int32 @@ -151,15 +152,14 @@ type UpdateLagOutput struct { // The ID of the AWS account that owns the LAG. OwnerAccount *string - // The connections bundled by the LAG. - Connections []*types.Connection + // The name of the service provider associated with the LAG. + ProviderName *string // The AWS Region where the connection is located. Region *string - // The minimum number of physical connections that must be operational for the LAG - // itself to be operational. - MinimumLinks *int32 + // The tags associated with the LAG. + Tags []*types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/directconnect/api_op_UpdateVirtualInterfaceAttributes.go b/service/directconnect/api_op_UpdateVirtualInterfaceAttributes.go index 6868c0da598..65761b6cc2c 100644 --- a/service/directconnect/api_op_UpdateVirtualInterfaceAttributes.go +++ b/service/directconnect/api_op_UpdateVirtualInterfaceAttributes.go @@ -77,12 +77,76 @@ type UpdateVirtualInterfaceAttributesInput struct { // Information about a virtual interface. type UpdateVirtualInterfaceAttributesOutput struct { - // The ID of the connection. - ConnectionId *string + // The address family for the BGP peer. + AddressFamily types.AddressFamily + + // The IP address assigned to the Amazon interface. + AmazonAddress *string + + // The autonomous system number (ASN) for the Amazon side of the connection. + AmazonSideAsn *int64 + + // The autonomous system (AS) number for Border Gateway Protocol (BGP) + // configuration. The valid values are 1-2147483647. + Asn *int32 + + // The authentication key for BGP configuration. This string has a minimum length + // of 6 characters and and a maximun lenth of 80 characters. + AuthKey *string + + // The Direct Connect endpoint on which the virtual interface terminates. + AwsDeviceV2 *string // The BGP peers configured on this virtual interface. BgpPeers []*types.BGPPeer + // The ID of the connection. + ConnectionId *string + + // The IP address assigned to the customer interface. + CustomerAddress *string + + // The customer router configuration. + CustomerRouterConfig *string + + // The ID of the Direct Connect gateway. + DirectConnectGatewayId *string + + // Indicates whether jumbo frames (9001 MTU) are supported. + JumboFrameCapable *bool + + // The location of the connection. + Location *string + + // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and + // 9001. The default value is 1500. + Mtu *int32 + + // The ID of the AWS account that owns the virtual interface. + OwnerAccount *string + + // The AWS Region where the virtual interface is located. + Region *string + + // The routes to be advertised to the AWS network in this Region. Applies to public + // virtual interfaces. + RouteFilterPrefixes []*types.RouteFilterPrefix + + // The tags associated with the virtual interface. + Tags []*types.Tag + + // The ID of the virtual private gateway. Applies only to private virtual + // interfaces. + VirtualGatewayId *string + + // The ID of the virtual interface. + VirtualInterfaceId *string + + // The name of the virtual interface assigned by the customer network. The name has + // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a + // hyphen (-). + VirtualInterfaceName *string + // The state of the virtual interface. The following are the possible values: // // @@ -124,73 +188,9 @@ type UpdateVirtualInterfaceAttributesOutput struct { // The type of virtual interface. The possible values are private and public. VirtualInterfaceType *string - // The routes to be advertised to the AWS network in this Region. Applies to public - // virtual interfaces. - RouteFilterPrefixes []*types.RouteFilterPrefix - - // The authentication key for BGP configuration. This string has a minimum length - // of 6 characters and and a maximun lenth of 80 characters. - AuthKey *string - - // The Direct Connect endpoint on which the virtual interface terminates. - AwsDeviceV2 *string - - // The tags associated with the virtual interface. - Tags []*types.Tag - - // Indicates whether jumbo frames (9001 MTU) are supported. - JumboFrameCapable *bool - - // The ID of the AWS account that owns the virtual interface. - OwnerAccount *string - - // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and - // 9001. The default value is 1500. - Mtu *int32 - - // The IP address assigned to the customer interface. - CustomerAddress *string - - // The ID of the Direct Connect gateway. - DirectConnectGatewayId *string - - // The customer router configuration. - CustomerRouterConfig *string - - // The location of the connection. - Location *string - - // The ID of the virtual interface. - VirtualInterfaceId *string - - // The autonomous system number (ASN) for the Amazon side of the connection. - AmazonSideAsn *int64 - - // The IP address assigned to the Amazon interface. - AmazonAddress *string - - // The ID of the virtual private gateway. Applies only to private virtual - // interfaces. - VirtualGatewayId *string - - // The name of the virtual interface assigned by the customer network. The name has - // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a - // hyphen (-). - VirtualInterfaceName *string - // The ID of the VLAN. Vlan *int32 - // The autonomous system (AS) number for Border Gateway Protocol (BGP) - // configuration. The valid values are 1-2147483647. - Asn *int32 - - // The address family for the BGP peer. - AddressFamily types.AddressFamily - - // The AWS Region where the virtual interface is located. - Region *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/directconnect/go.mod b/service/directconnect/go.mod index c407f48444f..8cdc69d2fd7 100644 --- a/service/directconnect/go.mod +++ b/service/directconnect/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/directconnect go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/directconnect/types/types.go b/service/directconnect/types/types.go index 3b97968bb6a..248dddb24d6 100644 --- a/service/directconnect/types/types.go +++ b/service/directconnect/types/types.go @@ -9,25 +9,39 @@ import ( // Information about the associated gateway. type AssociatedGateway struct { - // The type of associated gateway. - Type GatewayType + // The ID of the associated gateway. + Id *string // The ID of the AWS account that owns the associated virtual private gateway or // transit gateway. OwnerAccount *string - // The ID of the associated gateway. - Id *string - // The Region where the associated gateway is located. Region *string + + // The type of associated gateway. + Type GatewayType } // Information about a BGP peer. type BGPPeer struct { - // The IP address assigned to the customer interface. - CustomerAddress *string + // The address family for the BGP peer. + AddressFamily AddressFamily + + // The IP address assigned to the Amazon interface. + AmazonAddress *string + + // The autonomous system (AS) number for Border Gateway Protocol (BGP) + // configuration. + Asn *int32 + + // The authentication key for BGP configuration. This string has a minimum length + // of 6 characters and and a maximun lenth of 80 characters. + AuthKey *string + + // The Direct Connect endpoint on which the BGP peer terminates. + AwsDeviceV2 *string // The ID of the BGP peer. BgpPeerId *string @@ -51,23 +65,6 @@ type BGPPeer struct { // deleted and cannot be established. BgpPeerState BGPPeerState - // The authentication key for BGP configuration. This string has a minimum length - // of 6 characters and and a maximun lenth of 80 characters. - AuthKey *string - - // The autonomous system (AS) number for Border Gateway Protocol (BGP) - // configuration. - Asn *int32 - - // The address family for the BGP peer. - AddressFamily AddressFamily - - // The IP address assigned to the Amazon interface. - AmazonAddress *string - - // The Direct Connect endpoint on which the BGP peer terminates. - AwsDeviceV2 *string - // The status of the BGP peer. The following are the possible values: // // * up: @@ -80,37 +77,28 @@ type BGPPeer struct { // * unknown: The BGP peer status is not // available. BgpStatus BGPStatus + + // The IP address assigned to the customer interface. + CustomerAddress *string } // Information about an AWS Direct Connect connection. type Connection struct { - // Indicates whether jumbo frames (9001 MTU) are supported. - JumboFrameCapable *bool + // The Direct Connect endpoint on which the physical connection terminates. + AwsDevice *string // The Direct Connect endpoint on which the physical connection terminates. AwsDeviceV2 *string - // The ID of the VLAN. - Vlan *int32 - - // The name of the connection. - ConnectionName *string - - // The AWS Region where the connection is located. - Region *string - - // The ID of the LAG. - LagId *string + // The bandwidth of the connection. + Bandwidth *string // The ID of the connection. ConnectionId *string - // The tags associated with the connection. - Tags []*Tag - - // The ID of the AWS account that owns the connection. - OwnerAccount *string + // The name of the connection. + ConnectionName *string // The state of the connection. The following are the possible values: // @@ -145,36 +133,51 @@ type Connection struct { // not available. ConnectionState ConnectionState - // The Direct Connect endpoint on which the physical connection terminates. - AwsDevice *string + // Indicates whether the connection supports a secondary BGP peer in the same + // address family (IPv4/IPv6). + HasLogicalRedundancy HasLogicalRedundancy - // The name of the AWS Direct Connect service provider associated with the - // connection. - PartnerName *string + // Indicates whether jumbo frames (9001 MTU) are supported. + JumboFrameCapable *bool + + // The ID of the LAG. + LagId *string // The time of the most recent call to DescribeLoa () for this connection. LoaIssueTime *time.Time - // Indicates whether the connection supports a secondary BGP peer in the same - // address family (IPv4/IPv6). - HasLogicalRedundancy HasLogicalRedundancy + // The location of the connection. + Location *string + + // The ID of the AWS account that owns the connection. + OwnerAccount *string + + // The name of the AWS Direct Connect service provider associated with the + // connection. + PartnerName *string // The name of the service provider associated with the connection. ProviderName *string - // The bandwidth of the connection. - Bandwidth *string + // The AWS Region where the connection is located. + Region *string - // The location of the connection. - Location *string + // The tags associated with the connection. + Tags []*Tag + + // The ID of the VLAN. + Vlan *int32 } // Information about a Direct Connect gateway, which enables you to connect virtual // interfaces and virtual private gateway or transit gateways. type DirectConnectGateway struct { - // The error message if the state of an object failed to advance. - StateChangeError *string + // The autonomous system number (ASN) for the Amazon side of the connection. + AmazonSideAsn *int64 + + // The ID of the Direct Connect gateway. + DirectConnectGatewayId *string // The name of the Direct Connect gateway. DirectConnectGatewayName *string @@ -195,20 +198,26 @@ type DirectConnectGateway struct { // deleted and cannot pass traffic. DirectConnectGatewayState DirectConnectGatewayState - // The autonomous system number (ASN) for the Amazon side of the connection. - AmazonSideAsn *int64 - // The ID of the AWS account that owns the Direct Connect gateway. OwnerAccount *string - // The ID of the Direct Connect gateway. - DirectConnectGatewayId *string + // The error message if the state of an object failed to advance. + StateChangeError *string } // Information about an association between a Direct Connect gateway and a virtual // private gateway or transit gateway. type DirectConnectGatewayAssociation struct { + // The Amazon VPC prefixes to advertise to the Direct Connect gateway. + AllowedPrefixesToDirectConnectGateway []*RouteFilterPrefix + + // Information about the associated gateway. + AssociatedGateway *AssociatedGateway + + // The ID of the Direct Connect gateway association. + AssociationId *string + // The state of the association. The following are the possible values: // // * @@ -228,38 +237,44 @@ type DirectConnectGatewayAssociation struct { // private gateway or transit gateway is stopped. AssociationState DirectConnectGatewayAssociationState + // The ID of the Direct Connect gateway. + DirectConnectGatewayId *string + + // The ID of the AWS account that owns the associated gateway. + DirectConnectGatewayOwnerAccount *string + // The error message if the state of an object failed to advance. StateChangeError *string + // The ID of the virtual private gateway. Applies only to private virtual + // interfaces. + VirtualGatewayId *string + // The ID of the AWS account that owns the virtual private gateway. VirtualGatewayOwnerAccount *string // The AWS Region where the virtual private gateway is located. VirtualGatewayRegion *string +} - // The Amazon VPC prefixes to advertise to the Direct Connect gateway. - AllowedPrefixesToDirectConnectGateway []*RouteFilterPrefix - - // The ID of the virtual private gateway. Applies only to private virtual - // interfaces. - VirtualGatewayId *string +// Information about the proposal request to attach a virtual private gateway to a +// Direct Connect gateway. +type DirectConnectGatewayAssociationProposal struct { // Information about the associated gateway. AssociatedGateway *AssociatedGateway - // The ID of the AWS account that owns the associated gateway. - DirectConnectGatewayOwnerAccount *string - // The ID of the Direct Connect gateway. DirectConnectGatewayId *string - // The ID of the Direct Connect gateway association. - AssociationId *string -} + // The ID of the AWS account that owns the Direct Connect gateway. + DirectConnectGatewayOwnerAccount *string -// Information about the proposal request to attach a virtual private gateway to a -// Direct Connect gateway. -type DirectConnectGatewayAssociationProposal struct { + // The existing Amazon VPC prefixes advertised to the Direct Connect gateway. + ExistingAllowedPrefixesToDirectConnectGateway []*RouteFilterPrefix + + // The ID of the association proposal. + ProposalId *string // The state of the proposal. The following are possible values: // @@ -277,39 +292,12 @@ type DirectConnectGatewayAssociationProposal struct { // The Amazon VPC prefixes to advertise to the Direct Connect gateway. RequestedAllowedPrefixesToDirectConnectGateway []*RouteFilterPrefix - - // The existing Amazon VPC prefixes advertised to the Direct Connect gateway. - ExistingAllowedPrefixesToDirectConnectGateway []*RouteFilterPrefix - - // The ID of the association proposal. - ProposalId *string - - // The ID of the Direct Connect gateway. - DirectConnectGatewayId *string - - // Information about the associated gateway. - AssociatedGateway *AssociatedGateway - - // The ID of the AWS account that owns the Direct Connect gateway. - DirectConnectGatewayOwnerAccount *string } // Information about an attachment between a Direct Connect gateway and a virtual // interface. type DirectConnectGatewayAttachment struct { - // The error message if the state of an object failed to advance. - StateChangeError *string - - // The ID of the AWS account that owns the virtual interface. - VirtualInterfaceOwnerAccount *string - - // The ID of the Direct Connect gateway. - DirectConnectGatewayId *string - - // The ID of the virtual interface. - VirtualInterfaceId *string - // The state of the attachment. The following are the possible values: // // * @@ -327,18 +315,33 @@ type DirectConnectGatewayAttachment struct { // Direct Connect gateway and virtual interface is stopped. AttachmentState DirectConnectGatewayAttachmentState - // The AWS Region where the virtual interface is located. - VirtualInterfaceRegion *string - // The type of attachment. AttachmentType DirectConnectGatewayAttachmentType + + // The ID of the Direct Connect gateway. + DirectConnectGatewayId *string + + // The error message if the state of an object failed to advance. + StateChangeError *string + + // The ID of the virtual interface. + VirtualInterfaceId *string + + // The ID of the AWS account that owns the virtual interface. + VirtualInterfaceOwnerAccount *string + + // The AWS Region where the virtual interface is located. + VirtualInterfaceRegion *string } // Information about an interconnect. type Interconnect struct { - // The ID of the interconnect. - InterconnectId *string + // The Direct Connect endpoint on which the physical connection terminates. + AwsDevice *string + + // The Direct Connect endpoint on which the physical connection terminates. + AwsDeviceV2 *string // The bandwidth of the connection. Bandwidth *string @@ -347,8 +350,11 @@ type Interconnect struct { // family (IPv4/IPv6). HasLogicalRedundancy HasLogicalRedundancy - // The name of the service provider associated with the interconnect. - ProviderName *string + // The ID of the interconnect. + InterconnectId *string + + // The name of the interconnect. + InterconnectName *string // The state of the interconnect. The following are the possible values: // @@ -374,53 +380,60 @@ type Interconnect struct { // * unknown: The state of the interconnect is not available. InterconnectState InterconnectState - // The tags associated with the interconnect. - Tags []*Tag - // Indicates whether jumbo frames (9001 MTU) are supported. JumboFrameCapable *bool + // The ID of the LAG. + LagId *string + // The time of the most recent call to DescribeLoa () for this connection. LoaIssueTime *time.Time - // The ID of the LAG. - LagId *string + // The location of the connection. + Location *string - // The Direct Connect endpoint on which the physical connection terminates. - AwsDevice *string + // The name of the service provider associated with the interconnect. + ProviderName *string // The AWS Region where the connection is located. Region *string - // The Direct Connect endpoint on which the physical connection terminates. - AwsDeviceV2 *string - - // The location of the connection. - Location *string - - // The name of the interconnect. - InterconnectName *string + // The tags associated with the interconnect. + Tags []*Tag } // Information about a link aggregation group (LAG). type Lag struct { - // The name of the service provider associated with the LAG. - ProviderName *string + // Indicates whether the LAG can host other connections. + AllowsHostedConnections *bool - // Indicates whether the LAG supports a secondary BGP peer in the same address - // family (IPv4/IPv6). - HasLogicalRedundancy HasLogicalRedundancy + // The AWS Direct Connect endpoint that hosts the LAG. + AwsDevice *string // The AWS Direct Connect endpoint that hosts the LAG. AwsDeviceV2 *string - // The AWS Direct Connect endpoint that hosts the LAG. - AwsDevice *string + // The connections bundled by the LAG. + Connections []*Connection + + // The individual bandwidth of the physical connections bundled by the LAG. The + // possible values are 1Gbps and 10Gbps. + ConnectionsBandwidth *string + + // Indicates whether the LAG supports a secondary BGP peer in the same address + // family (IPv4/IPv6). + HasLogicalRedundancy HasLogicalRedundancy + + // Indicates whether jumbo frames (9001 MTU) are supported. + JumboFrameCapable *bool // The ID of the LAG. LagId *string + // The name of the LAG. + LagName *string + // The state of the LAG. The following are the possible values: // // * requested: @@ -444,24 +457,12 @@ type Lag struct { // * unknown: The state of the LAG is not available. LagState LagState - // Indicates whether jumbo frames (9001 MTU) are supported. - JumboFrameCapable *bool - - // Indicates whether the LAG can host other connections. - AllowsHostedConnections *bool - - // The individual bandwidth of the physical connections bundled by the LAG. The - // possible values are 1Gbps and 10Gbps. - ConnectionsBandwidth *string - - // The tags associated with the LAG. - Tags []*Tag - // The location of the LAG. Location *string - // The name of the LAG. - LagName *string + // The minimum number of physical connections that must be operational for the LAG + // itself to be operational. + MinimumLinks *int32 // The number of physical connections bundled by the LAG, up to a maximum of 10. NumberOfConnections *int32 @@ -469,15 +470,14 @@ type Lag struct { // The ID of the AWS account that owns the LAG. OwnerAccount *string - // The connections bundled by the LAG. - Connections []*Connection + // The name of the service provider associated with the LAG. + ProviderName *string // The AWS Region where the connection is located. Region *string - // The minimum number of physical connections that must be operational for the LAG - // itself to be operational. - MinimumLinks *int32 + // The tags associated with the LAG. + Tags []*Tag } // Information about a Letter of Authorization - Connecting Facility Assignment @@ -495,11 +495,14 @@ type Loa struct { // Information about an AWS Direct Connect location. type Location struct { + // The available port speeds for the location. + AvailablePortSpeeds []*string + // The name of the service provider for the location. AvailableProviders []*string - // The available port speeds for the location. - AvailablePortSpeeds []*string + // The code for the location. + LocationCode *string // The name of the location. This includes the name of the colocation partner and // the physical site of the building. @@ -507,38 +510,37 @@ type Location struct { // The AWS Region for the location. Region *string - - // The code for the location. - LocationCode *string } // Information about a new BGP peer. type NewBGPPeer struct { - // The IP address assigned to the customer interface. - CustomerAddress *string + // The address family for the BGP peer. + AddressFamily AddressFamily - // The authentication key for BGP configuration. This string has a minimum length - // of 6 characters and and a maximun lenth of 80 characters. - AuthKey *string + // The IP address assigned to the Amazon interface. + AmazonAddress *string // The autonomous system (AS) number for Border Gateway Protocol (BGP) // configuration. Asn *int32 - // The IP address assigned to the Amazon interface. - AmazonAddress *string + // The authentication key for BGP configuration. This string has a minimum length + // of 6 characters and and a maximun lenth of 80 characters. + AuthKey *string - // The address family for the BGP peer. - AddressFamily AddressFamily + // The IP address assigned to the customer interface. + CustomerAddress *string } // Information about a private virtual interface. type NewPrivateVirtualInterface struct { - // The authentication key for BGP configuration. This string has a minimum length - // of 6 characters and and a maximun lenth of 80 characters. - AuthKey *string + // The autonomous system (AS) number for Border Gateway Protocol (BGP) + // configuration. The valid values are 1-2147483647. + // + // This member is required. + Asn *int32 // The name of the virtual interface assigned by the customer network. The name has // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a @@ -547,68 +549,47 @@ type NewPrivateVirtualInterface struct { // This member is required. VirtualInterfaceName *string - // The ID of the virtual private gateway. - VirtualGatewayId *string - - // The ID of the Direct Connect gateway. - DirectConnectGatewayId *string - // The ID of the VLAN. // // This member is required. Vlan *int32 - // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and - // 9001. The default value is 1500. - Mtu *int32 - - // The autonomous system (AS) number for Border Gateway Protocol (BGP) - // configuration. The valid values are 1-2147483647. - // - // This member is required. - Asn *int32 - // The address family for the BGP peer. AddressFamily AddressFamily + // The IP address assigned to the Amazon interface. + AmazonAddress *string + + // The authentication key for BGP configuration. This string has a minimum length + // of 6 characters and and a maximun lenth of 80 characters. + AuthKey *string + // The IP address assigned to the customer interface. CustomerAddress *string + // The ID of the Direct Connect gateway. + DirectConnectGatewayId *string + + // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and + // 9001. The default value is 1500. + Mtu *int32 + // The tags associated with the private virtual interface. Tags []*Tag - // The IP address assigned to the Amazon interface. - AmazonAddress *string + // The ID of the virtual private gateway. + VirtualGatewayId *string } // Information about a private virtual interface to be provisioned on a connection. type NewPrivateVirtualInterfaceAllocation struct { - // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and - // 9001. The default value is 1500. - Mtu *int32 - - // The ID of the VLAN. - // - // This member is required. - Vlan *int32 - // The autonomous system (AS) number for Border Gateway Protocol (BGP) // configuration. The valid values are 1-2147483647. // // This member is required. Asn *int32 - // The authentication key for BGP configuration. This string has a minimum length - // of 6 characters and and a maximun lenth of 80 characters. - AuthKey *string - - // The IP address assigned to the customer interface. - CustomerAddress *string - - // The address family for the BGP peer. - AddressFamily AddressFamily - // The name of the virtual interface assigned by the customer network. The name has // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a // hyphen (-). @@ -616,9 +597,28 @@ type NewPrivateVirtualInterfaceAllocation struct { // This member is required. VirtualInterfaceName *string + // The ID of the VLAN. + // + // This member is required. + Vlan *int32 + + // The address family for the BGP peer. + AddressFamily AddressFamily + // The IP address assigned to the Amazon interface. AmazonAddress *string + // The authentication key for BGP configuration. This string has a minimum length + // of 6 characters and and a maximun lenth of 80 characters. + AuthKey *string + + // The IP address assigned to the customer interface. + CustomerAddress *string + + // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and + // 9001. The default value is 1500. + Mtu *int32 + // The tags associated with the private virtual interface. Tags []*Tag } @@ -632,10 +632,6 @@ type NewPublicVirtualInterface struct { // This member is required. Asn *int32 - // The routes to be advertised to the AWS network in this Region. Applies to public - // virtual interfaces. - RouteFilterPrefixes []*RouteFilterPrefix - // The name of the virtual interface assigned by the customer network. The name has // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a // hyphen (-). @@ -643,42 +639,40 @@ type NewPublicVirtualInterface struct { // This member is required. VirtualInterfaceName *string - // The IP address assigned to the customer interface. - CustomerAddress *string - - // The tags associated with the public virtual interface. - Tags []*Tag + // The ID of the VLAN. + // + // This member is required. + Vlan *int32 // The address family for the BGP peer. AddressFamily AddressFamily + // The IP address assigned to the Amazon interface. + AmazonAddress *string + // The authentication key for BGP configuration. This string has a minimum length // of 6 characters and and a maximun lenth of 80 characters. AuthKey *string - // The IP address assigned to the Amazon interface. - AmazonAddress *string + // The IP address assigned to the customer interface. + CustomerAddress *string - // The ID of the VLAN. - // - // This member is required. - Vlan *int32 + // The routes to be advertised to the AWS network in this Region. Applies to public + // virtual interfaces. + RouteFilterPrefixes []*RouteFilterPrefix + + // The tags associated with the public virtual interface. + Tags []*Tag } // Information about a public virtual interface to be provisioned on a connection. type NewPublicVirtualInterfaceAllocation struct { - // The routes to be advertised to the AWS network in this Region. Applies to public - // virtual interfaces. - RouteFilterPrefixes []*RouteFilterPrefix - - // The ID of the VLAN. + // The autonomous system (AS) number for Border Gateway Protocol (BGP) + // configuration. The valid values are 1-2147483647. // // This member is required. - Vlan *int32 - - // The IP address assigned to the Amazon interface. - AmazonAddress *string + Asn *int32 // The name of the virtual interface assigned by the customer network. The name has // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a @@ -687,28 +681,16 @@ type NewPublicVirtualInterfaceAllocation struct { // This member is required. VirtualInterfaceName *string - // The tags associated with the public virtual interface. - Tags []*Tag - - // The IP address assigned to the customer interface. - CustomerAddress *string - - // The authentication key for BGP configuration. This string has a minimum length - // of 6 characters and and a maximun lenth of 80 characters. - AuthKey *string - - // The autonomous system (AS) number for Border Gateway Protocol (BGP) - // configuration. The valid values are 1-2147483647. + // The ID of the VLAN. // // This member is required. - Asn *int32 + Vlan *int32 // The address family for the BGP peer. AddressFamily AddressFamily -} -// Information about a transit virtual interface. -type NewTransitVirtualInterface struct { + // The IP address assigned to the Amazon interface. + AmazonAddress *string // The authentication key for BGP configuration. This string has a minimum length // of 6 characters and and a maximun lenth of 80 characters. @@ -717,33 +699,51 @@ type NewTransitVirtualInterface struct { // The IP address assigned to the customer interface. CustomerAddress *string - // The ID of the VLAN. - Vlan *int32 + // The routes to be advertised to the AWS network in this Region. Applies to public + // virtual interfaces. + RouteFilterPrefixes []*RouteFilterPrefix + + // The tags associated with the public virtual interface. + Tags []*Tag +} + +// Information about a transit virtual interface. +type NewTransitVirtualInterface struct { // The address family for the BGP peer. AddressFamily AddressFamily - // The name of the virtual interface assigned by the customer network. The name has - // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a - // hyphen (-). - VirtualInterfaceName *string + // The IP address assigned to the Amazon interface. + AmazonAddress *string // The autonomous system (AS) number for Border Gateway Protocol (BGP) // configuration. The valid values are 1-2147483647. Asn *int32 - // The IP address assigned to the Amazon interface. - AmazonAddress *string + // The authentication key for BGP configuration. This string has a minimum length + // of 6 characters and and a maximun lenth of 80 characters. + AuthKey *string - // The tags associated with the transitive virtual interface. - Tags []*Tag + // The IP address assigned to the customer interface. + CustomerAddress *string + + // The ID of the Direct Connect gateway. + DirectConnectGatewayId *string // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and // 9001. The default value is 1500. Mtu *int32 - // The ID of the Direct Connect gateway. - DirectConnectGatewayId *string + // The tags associated with the transitive virtual interface. + Tags []*Tag + + // The name of the virtual interface assigned by the customer network. The name has + // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a + // hyphen (-). + VirtualInterfaceName *string + + // The ID of the VLAN. + Vlan *int32 } // Information about a transit virtual interface to be provisioned on a connection. @@ -752,44 +752,44 @@ type NewTransitVirtualInterfaceAllocation struct { // The address family for the BGP peer. AddressFamily AddressFamily - // The tags associated with the transitive virtual interface. - Tags []*Tag - // The IP address assigned to the Amazon interface. AmazonAddress *string - // The name of the virtual interface assigned by the customer network. The name has - // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a - // hyphen (-). - VirtualInterfaceName *string - // The autonomous system (AS) number for Border Gateway Protocol (BGP) // configuration. The valid values are 1-2147483647. Asn *int32 - // The ID of the VLAN. - Vlan *int32 + // The authentication key for BGP configuration. This string has a minimum length + // of 6 characters and and a maximun lenth of 80 characters. + AuthKey *string + + // The IP address assigned to the customer interface. + CustomerAddress *string // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and // 9001. The default value is 1500. Mtu *int32 - // The IP address assigned to the customer interface. - CustomerAddress *string + // The tags associated with the transitive virtual interface. + Tags []*Tag - // The authentication key for BGP configuration. This string has a minimum length - // of 6 characters and and a maximun lenth of 80 characters. - AuthKey *string + // The name of the virtual interface assigned by the customer network. The name has + // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a + // hyphen (-). + VirtualInterfaceName *string + + // The ID of the VLAN. + Vlan *int32 } // Information about a tag associated with an AWS Direct Connect resource. type ResourceTag struct { - // The tags. - Tags []*Tag - // The Amazon Resource Name (ARN) of the resource. ResourceArn *string + + // The tags. + Tags []*Tag } // Information about a route filter prefix that a customer can advertise through @@ -839,12 +839,76 @@ type VirtualGateway struct { // Information about a virtual interface. type VirtualInterface struct { - // The ID of the connection. - ConnectionId *string + // The address family for the BGP peer. + AddressFamily AddressFamily + + // The IP address assigned to the Amazon interface. + AmazonAddress *string + + // The autonomous system number (ASN) for the Amazon side of the connection. + AmazonSideAsn *int64 + + // The autonomous system (AS) number for Border Gateway Protocol (BGP) + // configuration. The valid values are 1-2147483647. + Asn *int32 + + // The authentication key for BGP configuration. This string has a minimum length + // of 6 characters and and a maximun lenth of 80 characters. + AuthKey *string + + // The Direct Connect endpoint on which the virtual interface terminates. + AwsDeviceV2 *string // The BGP peers configured on this virtual interface. BgpPeers []*BGPPeer + // The ID of the connection. + ConnectionId *string + + // The IP address assigned to the customer interface. + CustomerAddress *string + + // The customer router configuration. + CustomerRouterConfig *string + + // The ID of the Direct Connect gateway. + DirectConnectGatewayId *string + + // Indicates whether jumbo frames (9001 MTU) are supported. + JumboFrameCapable *bool + + // The location of the connection. + Location *string + + // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and + // 9001. The default value is 1500. + Mtu *int32 + + // The ID of the AWS account that owns the virtual interface. + OwnerAccount *string + + // The AWS Region where the virtual interface is located. + Region *string + + // The routes to be advertised to the AWS network in this Region. Applies to public + // virtual interfaces. + RouteFilterPrefixes []*RouteFilterPrefix + + // The tags associated with the virtual interface. + Tags []*Tag + + // The ID of the virtual private gateway. Applies only to private virtual + // interfaces. + VirtualGatewayId *string + + // The ID of the virtual interface. + VirtualInterfaceId *string + + // The name of the virtual interface assigned by the customer network. The name has + // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a + // hyphen (-). + VirtualInterfaceName *string + // The state of the virtual interface. The following are the possible values: // // @@ -886,99 +950,35 @@ type VirtualInterface struct { // The type of virtual interface. The possible values are private and public. VirtualInterfaceType *string - // The routes to be advertised to the AWS network in this Region. Applies to public - // virtual interfaces. - RouteFilterPrefixes []*RouteFilterPrefix - - // The authentication key for BGP configuration. This string has a minimum length - // of 6 characters and and a maximun lenth of 80 characters. - AuthKey *string - - // The Direct Connect endpoint on which the virtual interface terminates. - AwsDeviceV2 *string - - // The tags associated with the virtual interface. - Tags []*Tag - - // Indicates whether jumbo frames (9001 MTU) are supported. - JumboFrameCapable *bool - - // The ID of the AWS account that owns the virtual interface. - OwnerAccount *string - - // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and - // 9001. The default value is 1500. - Mtu *int32 - - // The IP address assigned to the customer interface. - CustomerAddress *string - - // The ID of the Direct Connect gateway. - DirectConnectGatewayId *string - - // The customer router configuration. - CustomerRouterConfig *string - - // The location of the connection. - Location *string - - // The ID of the virtual interface. - VirtualInterfaceId *string - - // The autonomous system number (ASN) for the Amazon side of the connection. - AmazonSideAsn *int64 - - // The IP address assigned to the Amazon interface. - AmazonAddress *string - - // The ID of the virtual private gateway. Applies only to private virtual - // interfaces. - VirtualGatewayId *string - - // The name of the virtual interface assigned by the customer network. The name has - // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a - // hyphen (-). - VirtualInterfaceName *string - // The ID of the VLAN. Vlan *int32 - - // The autonomous system (AS) number for Border Gateway Protocol (BGP) - // configuration. The valid values are 1-2147483647. - Asn *int32 - - // The address family for the BGP peer. - AddressFamily AddressFamily - - // The AWS Region where the virtual interface is located. - Region *string } // Information about the virtual interface failover test. type VirtualInterfaceTestHistory struct { - // The ID of the virtual interface failover test. - TestId *string - - // The owner ID of the tested virtual interface. - OwnerAccount *string - - // The status of the virtual interface failover test. - Status *string + // The BGP peers that were put in the DOWN state as part of the virtual interface + // failover test. + BgpPeers []*string // The time that the virtual interface moves out of the DOWN state. EndTime *time.Time - // The BGP peers that were put in the DOWN state as part of the virtual interface - // failover test. - BgpPeers []*string + // The owner ID of the tested virtual interface. + OwnerAccount *string // The time that the virtual interface moves to the DOWN state. StartTime *time.Time - // The ID of the tested virtual interface. - VirtualInterfaceId *string + // The status of the virtual interface failover test. + Status *string // The time that the virtual interface failover test ran in minutes. TestDurationInMinutes *int32 + + // The ID of the virtual interface failover test. + TestId *string + + // The ID of the tested virtual interface. + VirtualInterfaceId *string } diff --git a/service/directoryservice/api_op_ConnectDirectory.go b/service/directoryservice/api_op_ConnectDirectory.go index 4ddc7712ebf..4905b70520a 100644 --- a/service/directoryservice/api_op_ConnectDirectory.go +++ b/service/directoryservice/api_op_ConnectDirectory.go @@ -63,35 +63,35 @@ func (c *Client) ConnectDirectory(ctx context.Context, params *ConnectDirectoryI // Contains the inputs for the ConnectDirectory () operation. type ConnectDirectoryInput struct { - // The password for the on-premises user account. + // A DirectoryConnectSettings () object that contains additional information for + // the operation. // // This member is required. - Password *string + ConnectSettings *types.DirectoryConnectSettings - // The size of the directory. + // The fully qualified name of the on-premises directory, such as corp.example.com. // // This member is required. - Size types.DirectorySize + Name *string - // The fully qualified name of the on-premises directory, such as corp.example.com. + // The password for the on-premises user account. // // This member is required. - Name *string + Password *string - // A DirectoryConnectSettings () object that contains additional information for - // the operation. + // The size of the directory. // // This member is required. - ConnectSettings *types.DirectoryConnectSettings + Size types.DirectorySize + + // A description for the directory. + Description *string // The NetBIOS name of the on-premises directory, such as CORP. ShortName *string // The tags to be assigned to AD Connector. Tags []*types.Tag - - // A description for the directory. - Description *string } // Contains the results of the ConnectDirectory () operation. diff --git a/service/directoryservice/api_op_CreateAlias.go b/service/directoryservice/api_op_CreateAlias.go index f84b820ca04..6877cb4e93c 100644 --- a/service/directoryservice/api_op_CreateAlias.go +++ b/service/directoryservice/api_op_CreateAlias.go @@ -60,17 +60,17 @@ func (c *Client) CreateAlias(ctx context.Context, params *CreateAliasInput, optF // Contains the inputs for the CreateAlias () operation. type CreateAliasInput struct { - // The identifier of the directory for which to create the alias. - // - // This member is required. - DirectoryId *string - // The requested alias. The alias must be unique amongst all aliases in AWS. This // operation throws an EntityAlreadyExistsException error if the alias already // exists. // // This member is required. Alias *string + + // The identifier of the directory for which to create the alias. + // + // This member is required. + DirectoryId *string } // Contains the results of the CreateAlias () operation. diff --git a/service/directoryservice/api_op_CreateComputer.go b/service/directoryservice/api_op_CreateComputer.go index d41ec2d642c..9c9a4ce93ec 100644 --- a/service/directoryservice/api_op_CreateComputer.go +++ b/service/directoryservice/api_op_CreateComputer.go @@ -59,19 +59,15 @@ func (c *Client) CreateComputer(ctx context.Context, params *CreateComputerInput // Contains the inputs for the CreateComputer () operation. type CreateComputerInput struct { - // The fully-qualified distinguished name of the organizational unit to place the - // computer account in. - OrganizationalUnitDistinguishedName *string - - // The identifier of the directory in which to create the computer account. + // The name of the computer account. // // This member is required. - DirectoryId *string + ComputerName *string - // The name of the computer account. + // The identifier of the directory in which to create the computer account. // // This member is required. - ComputerName *string + DirectoryId *string // A one-time password that is used to join the computer to the directory. You // should generate a random, strong password to use for this parameter. @@ -82,6 +78,10 @@ type CreateComputerInput struct { // An array of Attribute () objects that contain any LDAP attributes to apply to // the computer account. ComputerAttributes []*types.Attribute + + // The fully-qualified distinguished name of the organizational unit to place the + // computer account in. + OrganizationalUnitDistinguishedName *string } // Contains the results for the CreateComputer () operation. diff --git a/service/directoryservice/api_op_CreateDirectory.go b/service/directoryservice/api_op_CreateDirectory.go index ec36988dba6..0a04422f5d6 100644 --- a/service/directoryservice/api_op_CreateDirectory.go +++ b/service/directoryservice/api_op_CreateDirectory.go @@ -65,14 +65,6 @@ func (c *Client) CreateDirectory(ctx context.Context, params *CreateDirectoryInp // Contains the inputs for the CreateDirectory () operation. type CreateDirectoryInput struct { - // A description for the directory. - Description *string - - // The size of the directory. - // - // This member is required. - Size types.DirectorySize - // The fully qualified name for the directory, such as corp.example.com. // // This member is required. @@ -86,15 +78,23 @@ type CreateDirectoryInput struct { // This member is required. Password *string - // A DirectoryVpcSettings () object that contains additional information for the - // operation. - VpcSettings *types.DirectoryVpcSettings + // The size of the directory. + // + // This member is required. + Size types.DirectorySize + + // A description for the directory. + Description *string // The NetBIOS name of the directory, such as CORP. ShortName *string // The tags to be assigned to the Simple AD directory. Tags []*types.Tag + + // A DirectoryVpcSettings () object that contains additional information for the + // operation. + VpcSettings *types.DirectoryVpcSettings } // Contains the results of the CreateDirectory () operation. diff --git a/service/directoryservice/api_op_CreateMicrosoftAD.go b/service/directoryservice/api_op_CreateMicrosoftAD.go index 3bc46334899..4d493ae5014 100644 --- a/service/directoryservice/api_op_CreateMicrosoftAD.go +++ b/service/directoryservice/api_op_CreateMicrosoftAD.go @@ -66,13 +66,6 @@ func (c *Client) CreateMicrosoftAD(ctx context.Context, params *CreateMicrosoftA // Creates an AWS Managed Microsoft AD directory. type CreateMicrosoftADInput struct { - // The tags to be assigned to the AWS Managed Microsoft AD directory. - Tags []*types.Tag - - // A description for the directory. This label will appear on the AWS console - // Directory Details page after the directory is created. - Description *string - // The fully qualified domain name for the AWS Managed Microsoft AD directory, such // as corp.example.com. This name will resolve inside your VPC only. It does not // need to be publicly resolvable. @@ -87,6 +80,16 @@ type CreateMicrosoftADInput struct { // This member is required. Password *string + // Contains VPC information for the CreateDirectory () or CreateMicrosoftAD () + // operation. + // + // This member is required. + VpcSettings *types.DirectoryVpcSettings + + // A description for the directory. This label will appear on the AWS console + // Directory Details page after the directory is created. + Description *string + // AWS Managed Microsoft AD is available in two editions: Standard and Enterprise. // Enterprise is the default. Edition types.DirectoryEdition @@ -96,11 +99,8 @@ type CreateMicrosoftADInput struct { // for the directory DNS corp.example.com. ShortName *string - // Contains VPC information for the CreateDirectory () or CreateMicrosoftAD () - // operation. - // - // This member is required. - VpcSettings *types.DirectoryVpcSettings + // The tags to be assigned to the AWS Managed Microsoft AD directory. + Tags []*types.Tag } // Result of a CreateMicrosoftAD request. diff --git a/service/directoryservice/api_op_CreateSnapshot.go b/service/directoryservice/api_op_CreateSnapshot.go index 1bb133c8955..965ff928408 100644 --- a/service/directoryservice/api_op_CreateSnapshot.go +++ b/service/directoryservice/api_op_CreateSnapshot.go @@ -58,13 +58,13 @@ func (c *Client) CreateSnapshot(ctx context.Context, params *CreateSnapshotInput // Contains the inputs for the CreateSnapshot () operation. type CreateSnapshotInput struct { - // The descriptive name to apply to the snapshot. - Name *string - // The identifier of the directory of which to take a snapshot. // // This member is required. DirectoryId *string + + // The descriptive name to apply to the snapshot. + Name *string } // Contains the results of the CreateSnapshot () operation. diff --git a/service/directoryservice/api_op_CreateTrust.go b/service/directoryservice/api_op_CreateTrust.go index ac3ce44bda6..e9867cb1353 100644 --- a/service/directoryservice/api_op_CreateTrust.go +++ b/service/directoryservice/api_op_CreateTrust.go @@ -83,25 +83,25 @@ type CreateTrustInput struct { // This member is required. RemoteDomainName *string - // Optional parameter to enable selective authentication for the trust. - SelectiveAuth types.SelectiveAuth - - // The trust relationship type. Forest is the default. - TrustType types.TrustType - // The direction of the trust relationship. // // This member is required. TrustDirection types.TrustDirection - // The IP addresses of the remote DNS server associated with RemoteDomainName. - ConditionalForwarderIpAddrs []*string - // The trust password. The must be the same password that was used when creating // the trust relationship on the external domain. // // This member is required. TrustPassword *string + + // The IP addresses of the remote DNS server associated with RemoteDomainName. + ConditionalForwarderIpAddrs []*string + + // Optional parameter to enable selective authentication for the trust. + SelectiveAuth types.SelectiveAuth + + // The trust relationship type. Forest is the default. + TrustType types.TrustType } // The result of a CreateTrust request. diff --git a/service/directoryservice/api_op_DeleteTrust.go b/service/directoryservice/api_op_DeleteTrust.go index 9ba1032b9af..ff652e28371 100644 --- a/service/directoryservice/api_op_DeleteTrust.go +++ b/service/directoryservice/api_op_DeleteTrust.go @@ -59,13 +59,13 @@ func (c *Client) DeleteTrust(ctx context.Context, params *DeleteTrustInput, optF // Microsoft AD directory and the external domain. type DeleteTrustInput struct { - // Delete a conditional forwarder as part of a DeleteTrustRequest. - DeleteAssociatedConditionalForwarder *bool - // The Trust ID of the trust relationship to be deleted. // // This member is required. TrustId *string + + // Delete a conditional forwarder as part of a DeleteTrustRequest. + DeleteAssociatedConditionalForwarder *bool } // The result of a DeleteTrust request. diff --git a/service/directoryservice/api_op_DeregisterCertificate.go b/service/directoryservice/api_op_DeregisterCertificate.go index 999942f3113..68a7fce5071 100644 --- a/service/directoryservice/api_op_DeregisterCertificate.go +++ b/service/directoryservice/api_op_DeregisterCertificate.go @@ -57,15 +57,15 @@ func (c *Client) DeregisterCertificate(ctx context.Context, params *DeregisterCe type DeregisterCertificateInput struct { - // The identifier of the directory. + // The identifier of the certificate. // // This member is required. - DirectoryId *string + CertificateId *string - // The identifier of the certificate. + // The identifier of the directory. // // This member is required. - CertificateId *string + DirectoryId *string } type DeregisterCertificateOutput struct { diff --git a/service/directoryservice/api_op_DeregisterEventTopic.go b/service/directoryservice/api_op_DeregisterEventTopic.go index 7ac1bfb53a7..746a9b7a8ee 100644 --- a/service/directoryservice/api_op_DeregisterEventTopic.go +++ b/service/directoryservice/api_op_DeregisterEventTopic.go @@ -57,16 +57,16 @@ func (c *Client) DeregisterEventTopic(ctx context.Context, params *DeregisterEve // Removes the specified directory as a publisher to the specified SNS topic. type DeregisterEventTopicInput struct { - // The name of the SNS topic from which to remove the directory as a publisher. - // - // This member is required. - TopicName *string - // The Directory ID to remove as a publisher. This directory will no longer send // messages to the specified SNS topic. // // This member is required. DirectoryId *string + + // The name of the SNS topic from which to remove the directory as a publisher. + // + // This member is required. + TopicName *string } // The result of a DeregisterEventTopic request. diff --git a/service/directoryservice/api_op_DescribeConditionalForwarders.go b/service/directoryservice/api_op_DescribeConditionalForwarders.go index cd1c62da60f..99e2474bc7b 100644 --- a/service/directoryservice/api_op_DescribeConditionalForwarders.go +++ b/service/directoryservice/api_op_DescribeConditionalForwarders.go @@ -60,15 +60,15 @@ func (c *Client) DescribeConditionalForwarders(ctx context.Context, params *Desc // Describes a conditional forwarder. type DescribeConditionalForwardersInput struct { - // The fully qualified domain names (FQDN) of the remote domains for which to get - // the list of associated conditional forwarders. If this member is null, all - // conditional forwarders are returned. - RemoteDomainNames []*string - // The directory ID for which to get the list of associated conditional forwarders. // // This member is required. DirectoryId *string + + // The fully qualified domain names (FQDN) of the remote domains for which to get + // the list of associated conditional forwarders. If this member is null, all + // conditional forwarders are returned. + RemoteDomainNames []*string } // The result of a DescribeConditionalForwarder request. diff --git a/service/directoryservice/api_op_DescribeDirectories.go b/service/directoryservice/api_op_DescribeDirectories.go index eb80a1262be..eedbc5c99f7 100644 --- a/service/directoryservice/api_op_DescribeDirectories.go +++ b/service/directoryservice/api_op_DescribeDirectories.go @@ -65,28 +65,23 @@ func (c *Client) DescribeDirectories(ctx context.Context, params *DescribeDirect // Contains the inputs for the DescribeDirectories () operation. type DescribeDirectoriesInput struct { - // The DescribeDirectoriesResult.NextToken value from a previous call to - // DescribeDirectories (). Pass null if this is the first call. - NextToken *string + // A list of identifiers of the directories for which to obtain the information. If + // this member is null, all directories that belong to the current account are + // returned. An empty list results in an InvalidParameterException being thrown. + DirectoryIds []*string // The maximum number of items to return. If this value is zero, the maximum number // of items is specified by the limitations of the operation. Limit *int32 - // A list of identifiers of the directories for which to obtain the information. If - // this member is null, all directories that belong to the current account are - // returned. An empty list results in an InvalidParameterException being thrown. - DirectoryIds []*string + // The DescribeDirectoriesResult.NextToken value from a previous call to + // DescribeDirectories (). Pass null if this is the first call. + NextToken *string } // Contains the results of the DescribeDirectories () operation. type DescribeDirectoriesOutput struct { - // If not null, more results are available. Pass this value for the NextToken - // parameter in a subsequent call to DescribeDirectories () to retrieve the next - // set of items. - NextToken *string - // The list of DirectoryDescription () objects that were retrieved. It is possible // that this list contains less than the number of items specified in the Limit // member of the request. This occurs if there are less than the requested number @@ -94,6 +89,11 @@ type DescribeDirectoriesOutput struct { // exceeded. DirectoryDescriptions []*types.DirectoryDescription + // If not null, more results are available. Pass this value for the NextToken + // parameter in a subsequent call to DescribeDirectories () to retrieve the next + // set of items. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/directoryservice/api_op_DescribeDomainControllers.go b/service/directoryservice/api_op_DescribeDomainControllers.go index 194e4202ab1..9d4dfdd0a56 100644 --- a/service/directoryservice/api_op_DescribeDomainControllers.go +++ b/service/directoryservice/api_op_DescribeDomainControllers.go @@ -57,10 +57,6 @@ func (c *Client) DescribeDomainControllers(ctx context.Context, params *Describe type DescribeDomainControllersInput struct { - // The DescribeDomainControllers.NextToken value from a previous call to - // DescribeDomainControllers (). Pass null if this is the first call. - NextToken *string - // Identifier of the directory for which to retrieve the domain controller // information. // @@ -73,6 +69,10 @@ type DescribeDomainControllersInput struct { // The maximum number of items to return. Limit *int32 + + // The DescribeDomainControllers.NextToken value from a previous call to + // DescribeDomainControllers (). Pass null if this is the first call. + NextToken *string } type DescribeDomainControllersOutput struct { diff --git a/service/directoryservice/api_op_DescribeLDAPSSettings.go b/service/directoryservice/api_op_DescribeLDAPSSettings.go index c84807ca58c..a0749c8c9f2 100644 --- a/service/directoryservice/api_op_DescribeLDAPSSettings.go +++ b/service/directoryservice/api_op_DescribeLDAPSSettings.go @@ -57,9 +57,10 @@ func (c *Client) DescribeLDAPSSettings(ctx context.Context, params *DescribeLDAP type DescribeLDAPSSettingsInput struct { - // The type of LDAP security to enable. Currently only the value Client is - // supported. - Type types.LDAPSType + // The identifier of the directory. + // + // This member is required. + DirectoryId *string // Specifies the number of items that should be displayed on one page. Limit *int32 @@ -67,22 +68,21 @@ type DescribeLDAPSSettingsInput struct { // The type of next token used for pagination. NextToken *string - // The identifier of the directory. - // - // This member is required. - DirectoryId *string + // The type of LDAP security to enable. Currently only the value Client is + // supported. + Type types.LDAPSType } type DescribeLDAPSSettingsOutput struct { - // The next token used to retrieve the LDAPS settings if the number of setting - // types exceeds page limit and there is another page. - NextToken *string - // Information about LDAP security for the specified directory, including status of // enablement, state last updated date time, and the reason for the state. LDAPSSettingsInfo []*types.LDAPSSettingInfo + // The next token used to retrieve the LDAPS settings if the number of setting + // types exceeds page limit and there is another page. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/directoryservice/api_op_DescribeSharedDirectories.go b/service/directoryservice/api_op_DescribeSharedDirectories.go index fb9935f5f11..26fa465a35f 100644 --- a/service/directoryservice/api_op_DescribeSharedDirectories.go +++ b/service/directoryservice/api_op_DescribeSharedDirectories.go @@ -57,32 +57,32 @@ func (c *Client) DescribeSharedDirectories(ctx context.Context, params *Describe type DescribeSharedDirectoriesInput struct { - // A list of identifiers of all shared directories in your account. - SharedDirectoryIds []*string + // Returns the identifier of the directory in the directory owner account. + // + // This member is required. + OwnerDirectoryId *string + + // The number of shared directories to return in the response object. + Limit *int32 // The DescribeSharedDirectoriesResult.NextToken value from a previous call to // DescribeSharedDirectories (). Pass null if this is the first call. NextToken *string - // The number of shared directories to return in the response object. - Limit *int32 - - // Returns the identifier of the directory in the directory owner account. - // - // This member is required. - OwnerDirectoryId *string + // A list of identifiers of all shared directories in your account. + SharedDirectoryIds []*string } type DescribeSharedDirectoriesOutput struct { - // A list of all shared directories in your account. - SharedDirectories []*types.SharedDirectory - // If not null, token that indicates that more results are available. Pass this // value for the NextToken parameter in a subsequent call to // DescribeSharedDirectories () to retrieve the next set of items. NextToken *string + // A list of all shared directories in your account. + SharedDirectories []*types.SharedDirectory + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/directoryservice/api_op_DescribeSnapshots.go b/service/directoryservice/api_op_DescribeSnapshots.go index 20e2c58c02f..caf29225878 100644 --- a/service/directoryservice/api_op_DescribeSnapshots.go +++ b/service/directoryservice/api_op_DescribeSnapshots.go @@ -68,14 +68,14 @@ type DescribeSnapshotsInput struct { // The maximum number of objects to return. Limit *int32 + // The DescribeSnapshotsResult.NextToken value from a previous call to + // DescribeSnapshots (). Pass null if this is the first call. + NextToken *string + // A list of identifiers of the snapshots to obtain the information for. If this // member is null or empty, all snapshots are returned using the Limit and // NextToken members. SnapshotIds []*string - - // The DescribeSnapshotsResult.NextToken value from a previous call to - // DescribeSnapshots (). Pass null if this is the first call. - NextToken *string } // Contains the results of the DescribeSnapshots () operation. diff --git a/service/directoryservice/api_op_DescribeTrusts.go b/service/directoryservice/api_op_DescribeTrusts.go index 821df1ffc3e..920e412efe9 100644 --- a/service/directoryservice/api_op_DescribeTrusts.go +++ b/service/directoryservice/api_op_DescribeTrusts.go @@ -82,17 +82,17 @@ type DescribeTrustsInput struct { // The result of a DescribeTrust request. type DescribeTrustsOutput struct { + // If not null, more results are available. Pass this value for the NextToken + // parameter in a subsequent call to DescribeTrusts () to retrieve the next set of + // items. + NextToken *string + // The list of Trust objects that were retrieved. It is possible that this list // contains less than the number of items specified in the Limit member of the // request. This occurs if there are less than the requested number of items left // to retrieve, or if the limitations of the operation have been exceeded. Trusts []*types.Trust - // If not null, more results are available. Pass this value for the NextToken - // parameter in a subsequent call to DescribeTrusts () to retrieve the next set of - // items. - NextToken *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/directoryservice/api_op_DisableSso.go b/service/directoryservice/api_op_DisableSso.go index 19861e9e7c3..61339bda16e 100644 --- a/service/directoryservice/api_op_DisableSso.go +++ b/service/directoryservice/api_op_DisableSso.go @@ -57,6 +57,16 @@ func (c *Client) DisableSso(ctx context.Context, params *DisableSsoInput, optFns // Contains the inputs for the DisableSso () operation. type DisableSsoInput struct { + // The identifier of the directory for which to disable single-sign on. + // + // This member is required. + DirectoryId *string + + // The password of an alternate account to use to disable single-sign on. This is + // only used for AD Connector directories. For more information, see the UserName + // parameter. + Password *string + // The username of an alternate account to use to disable single-sign on. This is // only used for AD Connector directories. This account must have privileges to // remove a service principal name. If the AD Connector service account does not @@ -65,16 +75,6 @@ type DisableSsoInput struct { // used to disable single sign-on and are not stored by the service. The AD // Connector service account is not changed. UserName *string - - // The password of an alternate account to use to disable single-sign on. This is - // only used for AD Connector directories. For more information, see the UserName - // parameter. - Password *string - - // The identifier of the directory for which to disable single-sign on. - // - // This member is required. - DirectoryId *string } // Contains the results of the DisableSso () operation. diff --git a/service/directoryservice/api_op_EnableLDAPS.go b/service/directoryservice/api_op_EnableLDAPS.go index 4ccd42d00eb..0a280be8915 100644 --- a/service/directoryservice/api_op_EnableLDAPS.go +++ b/service/directoryservice/api_op_EnableLDAPS.go @@ -57,16 +57,16 @@ func (c *Client) EnableLDAPS(ctx context.Context, params *EnableLDAPSInput, optF type EnableLDAPSInput struct { - // The type of LDAP security to enable. Currently only the value Client is - // supported. + // The identifier of the directory. // // This member is required. - Type types.LDAPSType + DirectoryId *string - // The identifier of the directory. + // The type of LDAP security to enable. Currently only the value Client is + // supported. // // This member is required. - DirectoryId *string + Type types.LDAPSType } type EnableLDAPSOutput struct { diff --git a/service/directoryservice/api_op_EnableRadius.go b/service/directoryservice/api_op_EnableRadius.go index 41bdda84a79..054a6bd3e77 100644 --- a/service/directoryservice/api_op_EnableRadius.go +++ b/service/directoryservice/api_op_EnableRadius.go @@ -59,15 +59,15 @@ func (c *Client) EnableRadius(ctx context.Context, params *EnableRadiusInput, op // Contains the inputs for the EnableRadius () operation. type EnableRadiusInput struct { - // A RadiusSettings () object that contains information about the RADIUS server. + // The identifier of the directory for which to enable MFA. // // This member is required. - RadiusSettings *types.RadiusSettings + DirectoryId *string - // The identifier of the directory for which to enable MFA. + // A RadiusSettings () object that contains information about the RADIUS server. // // This member is required. - DirectoryId *string + RadiusSettings *types.RadiusSettings } // Contains the results of the EnableRadius () operation. diff --git a/service/directoryservice/api_op_EnableSso.go b/service/directoryservice/api_op_EnableSso.go index 77d00b3d2a4..c9f0a9dde85 100644 --- a/service/directoryservice/api_op_EnableSso.go +++ b/service/directoryservice/api_op_EnableSso.go @@ -59,16 +59,16 @@ func (c *Client) EnableSso(ctx context.Context, params *EnableSsoInput, optFns . // Contains the inputs for the EnableSso () operation. type EnableSsoInput struct { - // The password of an alternate account to use to enable single-sign on. This is - // only used for AD Connector directories. For more information, see the UserName - // parameter. - Password *string - // The identifier of the directory for which to enable single-sign on. // // This member is required. DirectoryId *string + // The password of an alternate account to use to enable single-sign on. This is + // only used for AD Connector directories. For more information, see the UserName + // parameter. + Password *string + // The username of an alternate account to use to enable single-sign on. This is // only used for AD Connector directories. This account must have privileges to add // a service principal name. If the AD Connector service account does not have diff --git a/service/directoryservice/api_op_ListCertificates.go b/service/directoryservice/api_op_ListCertificates.go index 6bf4f23241b..54dcd0563bf 100644 --- a/service/directoryservice/api_op_ListCertificates.go +++ b/service/directoryservice/api_op_ListCertificates.go @@ -58,6 +58,11 @@ func (c *Client) ListCertificates(ctx context.Context, params *ListCertificatesI type ListCertificatesInput struct { + // The identifier of the directory. + // + // This member is required. + DirectoryId *string + // The number of items that should show up on one page Limit *int32 @@ -66,23 +71,18 @@ type ListCertificatesInput struct { // returned NextToken element in your request until the token comes back as null. // Pass null if this is the first call. NextToken *string - - // The identifier of the directory. - // - // This member is required. - DirectoryId *string } type ListCertificatesOutput struct { - // Indicates whether another page of certificates is available when the number of - // available certificates exceeds the page limit. - NextToken *string - // A list of certificates with basic details including certificate ID, certificate // common name, certificate state. CertificatesInfo []*types.CertificateInfo + // Indicates whether another page of certificates is available when the number of + // available certificates exceeds the page limit. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/directoryservice/api_op_ListIpRoutes.go b/service/directoryservice/api_op_ListIpRoutes.go index 71f956b4524..79b6a071732 100644 --- a/service/directoryservice/api_op_ListIpRoutes.go +++ b/service/directoryservice/api_op_ListIpRoutes.go @@ -74,14 +74,14 @@ type ListIpRoutesInput struct { type ListIpRoutesOutput struct { + // A list of IpRoute ()s. + IpRoutesInfo []*types.IpRouteInfo + // If not null, more results are available. Pass this value for the NextToken // parameter in a subsequent call to ListIpRoutes () to retrieve the next set of // items. NextToken *string - // A list of IpRoute ()s. - IpRoutesInfo []*types.IpRouteInfo - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/directoryservice/api_op_ListLogSubscriptions.go b/service/directoryservice/api_op_ListLogSubscriptions.go index d1c3bf3450b..c9f9a07aa55 100644 --- a/service/directoryservice/api_op_ListLogSubscriptions.go +++ b/service/directoryservice/api_op_ListLogSubscriptions.go @@ -56,9 +56,6 @@ func (c *Client) ListLogSubscriptions(ctx context.Context, params *ListLogSubscr type ListLogSubscriptionsInput struct { - // The token for the next set of items to return. - NextToken *string - // If a DirectoryID is provided, lists only the log subscription associated with // that directory. If no DirectoryId is provided, lists all log subscriptions // associated with your AWS account. If there are no log subscriptions for the AWS @@ -67,16 +64,19 @@ type ListLogSubscriptionsInput struct { // The maximum number of items returned. Limit *int32 -} - -type ListLogSubscriptionsOutput struct { // The token for the next set of items to return. NextToken *string +} + +type ListLogSubscriptionsOutput struct { // A list of active LogSubscription () objects for calling the AWS account. LogSubscriptions []*types.LogSubscription + // The token for the next set of items to return. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/directoryservice/api_op_ListSchemaExtensions.go b/service/directoryservice/api_op_ListSchemaExtensions.go index 5aa9232b74f..74a1c294f49 100644 --- a/service/directoryservice/api_op_ListSchemaExtensions.go +++ b/service/directoryservice/api_op_ListSchemaExtensions.go @@ -57,10 +57,6 @@ func (c *Client) ListSchemaExtensions(ctx context.Context, params *ListSchemaExt type ListSchemaExtensionsInput struct { - // The ListSchemaExtensions.NextToken value from a previous call to - // ListSchemaExtensions. Pass null if this is the first call. - NextToken *string - // The identifier of the directory from which to retrieve the schema extension // information. // @@ -69,6 +65,10 @@ type ListSchemaExtensionsInput struct { // The maximum number of items to return. Limit *int32 + + // The ListSchemaExtensions.NextToken value from a previous call to + // ListSchemaExtensions. Pass null if this is the first call. + NextToken *string } type ListSchemaExtensionsOutput struct { diff --git a/service/directoryservice/api_op_ListTagsForResource.go b/service/directoryservice/api_op_ListTagsForResource.go index db48cc7b934..4d95065aad2 100644 --- a/service/directoryservice/api_op_ListTagsForResource.go +++ b/service/directoryservice/api_op_ListTagsForResource.go @@ -57,9 +57,6 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // Reserved for future use. - NextToken *string - // Identifier (ID) of the directory for which you want to retrieve tags. // // This member is required. @@ -67,6 +64,9 @@ type ListTagsForResourceInput struct { // Reserved for future use. Limit *int32 + + // Reserved for future use. + NextToken *string } type ListTagsForResourceOutput struct { diff --git a/service/directoryservice/api_op_RegisterCertificate.go b/service/directoryservice/api_op_RegisterCertificate.go index e7b02f76135..64288e6e386 100644 --- a/service/directoryservice/api_op_RegisterCertificate.go +++ b/service/directoryservice/api_op_RegisterCertificate.go @@ -56,15 +56,15 @@ func (c *Client) RegisterCertificate(ctx context.Context, params *RegisterCertif type RegisterCertificateInput struct { - // The identifier of the directory. + // The certificate PEM string that needs to be registered. // // This member is required. - DirectoryId *string + CertificateData *string - // The certificate PEM string that needs to be registered. + // The identifier of the directory. // // This member is required. - CertificateData *string + DirectoryId *string } type RegisterCertificateOutput struct { diff --git a/service/directoryservice/api_op_RegisterEventTopic.go b/service/directoryservice/api_op_RegisterEventTopic.go index 610ff658598..7fd6b82f9f2 100644 --- a/service/directoryservice/api_op_RegisterEventTopic.go +++ b/service/directoryservice/api_op_RegisterEventTopic.go @@ -61,16 +61,16 @@ func (c *Client) RegisterEventTopic(ctx context.Context, params *RegisterEventTo // Registers a new event topic. type RegisterEventTopicInput struct { - // The SNS topic name to which the directory will publish status messages. This SNS - // topic must be in the same region as the specified Directory ID. + // The Directory ID that will publish status messages to the SNS topic. // // This member is required. - TopicName *string + DirectoryId *string - // The Directory ID that will publish status messages to the SNS topic. + // The SNS topic name to which the directory will publish status messages. This SNS + // topic must be in the same region as the specified Directory ID. // // This member is required. - DirectoryId *string + TopicName *string } // The result of a RegisterEventTopic request. diff --git a/service/directoryservice/api_op_RemoveIpRoutes.go b/service/directoryservice/api_op_RemoveIpRoutes.go index d507409f8f6..b97ecc459f2 100644 --- a/service/directoryservice/api_op_RemoveIpRoutes.go +++ b/service/directoryservice/api_op_RemoveIpRoutes.go @@ -56,15 +56,15 @@ func (c *Client) RemoveIpRoutes(ctx context.Context, params *RemoveIpRoutesInput type RemoveIpRoutesInput struct { - // Identifier (ID) of the directory from which you want to remove the IP addresses. + // IP address blocks that you want to remove. // // This member is required. - DirectoryId *string + CidrIps []*string - // IP address blocks that you want to remove. + // Identifier (ID) of the directory from which you want to remove the IP addresses. // // This member is required. - CidrIps []*string + DirectoryId *string } type RemoveIpRoutesOutput struct { diff --git a/service/directoryservice/api_op_ResetUserPassword.go b/service/directoryservice/api_op_ResetUserPassword.go index 6f5ac66b2bf..7db5b08f3bc 100644 --- a/service/directoryservice/api_op_ResetUserPassword.go +++ b/service/directoryservice/api_op_ResetUserPassword.go @@ -71,17 +71,17 @@ func (c *Client) ResetUserPassword(ctx context.Context, params *ResetUserPasswor type ResetUserPasswordInput struct { - // The new password that will be reset. - // - // This member is required. - NewPassword *string - // Identifier of the AWS Managed Microsoft AD or Simple AD directory in which the // user resides. // // This member is required. DirectoryId *string + // The new password that will be reset. + // + // This member is required. + NewPassword *string + // The user name of the user whose password will be reset. // // This member is required. diff --git a/service/directoryservice/api_op_ShareDirectory.go b/service/directoryservice/api_op_ShareDirectory.go index 7a50f12ee88..cdce9b0911a 100644 --- a/service/directoryservice/api_op_ShareDirectory.go +++ b/service/directoryservice/api_op_ShareDirectory.go @@ -75,6 +75,13 @@ type ShareDirectoryInput struct { // This member is required. DirectoryId *string + // The method used when sharing a directory to determine whether the directory + // should be shared within your AWS organization (ORGANIZATIONS) or with any AWS + // account by sending a directory sharing request (HANDSHAKE). + // + // This member is required. + ShareMethod types.ShareMethod + // Identifier for the directory consumer account with whom the directory is to be // shared. // @@ -85,13 +92,6 @@ type ShareDirectoryInput struct { // consumer. The request includes a typed message to help the directory consumer // administrator determine whether to approve or reject the share invitation. ShareNotes *string - - // The method used when sharing a directory to determine whether the directory - // should be shared within your AWS organization (ORGANIZATIONS) or with any AWS - // account by sending a directory sharing request (HANDSHAKE). - // - // This member is required. - ShareMethod types.ShareMethod } type ShareDirectoryOutput struct { diff --git a/service/directoryservice/api_op_StartSchemaExtension.go b/service/directoryservice/api_op_StartSchemaExtension.go index 6e71371fd78..31e1aede3aa 100644 --- a/service/directoryservice/api_op_StartSchemaExtension.go +++ b/service/directoryservice/api_op_StartSchemaExtension.go @@ -56,29 +56,29 @@ func (c *Client) StartSchemaExtension(ctx context.Context, params *StartSchemaEx type StartSchemaExtensionInput struct { - // The LDIF file represented as a string. To construct the LdifContent string, - // precede each line as it would be formatted in an ldif file with \n. See the - // example request below for more details. The file size can be no larger than 1MB. + // If true, creates a snapshot of the directory before applying the schema + // extension. // // This member is required. - LdifContent *string + CreateSnapshotBeforeSchemaExtension *bool - // The identifier of the directory for which the schema extension will be applied - // to. + // A description of the schema extension. // // This member is required. - DirectoryId *string + Description *string - // A description of the schema extension. + // The identifier of the directory for which the schema extension will be applied + // to. // // This member is required. - Description *string + DirectoryId *string - // If true, creates a snapshot of the directory before applying the schema - // extension. + // The LDIF file represented as a string. To construct the LdifContent string, + // precede each line as it would be formatted in an ldif file with \n. See the + // example request below for more details. The file size can be no larger than 1MB. // // This member is required. - CreateSnapshotBeforeSchemaExtension *bool + LdifContent *string } type StartSchemaExtensionOutput struct { diff --git a/service/directoryservice/api_op_UpdateConditionalForwarder.go b/service/directoryservice/api_op_UpdateConditionalForwarder.go index 41174cae665..cf820c72fe2 100644 --- a/service/directoryservice/api_op_UpdateConditionalForwarder.go +++ b/service/directoryservice/api_op_UpdateConditionalForwarder.go @@ -57,12 +57,6 @@ func (c *Client) UpdateConditionalForwarder(ctx context.Context, params *UpdateC // Updates a conditional forwarder. type UpdateConditionalForwarderInput struct { - // The fully qualified domain name (FQDN) of the remote domain with which you will - // set up a trust relationship. - // - // This member is required. - RemoteDomainName *string - // The directory ID of the AWS directory for which to update the conditional // forwarder. // @@ -74,6 +68,12 @@ type UpdateConditionalForwarderInput struct { // // This member is required. DnsIpAddrs []*string + + // The fully qualified domain name (FQDN) of the remote domain with which you will + // set up a trust relationship. + // + // This member is required. + RemoteDomainName *string } // The result of an UpdateConditionalForwarder request. diff --git a/service/directoryservice/api_op_UpdateNumberOfDomainControllers.go b/service/directoryservice/api_op_UpdateNumberOfDomainControllers.go index deae494930c..97ee5068565 100644 --- a/service/directoryservice/api_op_UpdateNumberOfDomainControllers.go +++ b/service/directoryservice/api_op_UpdateNumberOfDomainControllers.go @@ -61,16 +61,16 @@ func (c *Client) UpdateNumberOfDomainControllers(ctx context.Context, params *Up type UpdateNumberOfDomainControllersInput struct { - // Identifier of the directory to which the domain controllers will be added or - // removed. + // The number of domain controllers desired in the directory. // // This member is required. - DirectoryId *string + DesiredNumber *int32 - // The number of domain controllers desired in the directory. + // Identifier of the directory to which the domain controllers will be added or + // removed. // // This member is required. - DesiredNumber *int32 + DirectoryId *string } type UpdateNumberOfDomainControllersOutput struct { diff --git a/service/directoryservice/api_op_UpdateRadius.go b/service/directoryservice/api_op_UpdateRadius.go index 7895fece2fd..5bbb0cf23f5 100644 --- a/service/directoryservice/api_op_UpdateRadius.go +++ b/service/directoryservice/api_op_UpdateRadius.go @@ -59,16 +59,16 @@ func (c *Client) UpdateRadius(ctx context.Context, params *UpdateRadiusInput, op // Contains the inputs for the UpdateRadius () operation. type UpdateRadiusInput struct { - // A RadiusSettings () object that contains information about the RADIUS server. - // - // This member is required. - RadiusSettings *types.RadiusSettings - // The identifier of the directory for which to update the RADIUS server // information. // // This member is required. DirectoryId *string + + // A RadiusSettings () object that contains information about the RADIUS server. + // + // This member is required. + RadiusSettings *types.RadiusSettings } // Contains the results of the UpdateRadius () operation. diff --git a/service/directoryservice/api_op_UpdateTrust.go b/service/directoryservice/api_op_UpdateTrust.go index a6d99588342..eeda930de92 100644 --- a/service/directoryservice/api_op_UpdateTrust.go +++ b/service/directoryservice/api_op_UpdateTrust.go @@ -58,13 +58,13 @@ func (c *Client) UpdateTrust(ctx context.Context, params *UpdateTrustInput, optF type UpdateTrustInput struct { - // Updates selective authentication for the trust. - SelectiveAuth types.SelectiveAuth - // Identifier of the trust relationship. // // This member is required. TrustId *string + + // Updates selective authentication for the trust. + SelectiveAuth types.SelectiveAuth } type UpdateTrustOutput struct { diff --git a/service/directoryservice/go.mod b/service/directoryservice/go.mod index 52aee837517..76f8adbcf41 100644 --- a/service/directoryservice/go.mod +++ b/service/directoryservice/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/directoryservice go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/directoryservice/types/types.go b/service/directoryservice/types/types.go index 6e8de235ec5..251a5e7450b 100644 --- a/service/directoryservice/types/types.go +++ b/service/directoryservice/types/types.go @@ -19,37 +19,37 @@ type Attribute struct { // Information about the certificate. type Certificate struct { - // The common name for the certificate. - CommonName *string - // The identifier of the certificate. CertificateId *string - // The state of the certificate. - State CertificateState + // The common name for the certificate. + CommonName *string // The date and time when the certificate will expire. ExpiryDateTime *time.Time - // Describes a state change for the certificate. - StateReason *string - // The date and time that the certificate was registered. RegisteredDateTime *time.Time + + // The state of the certificate. + State CertificateState + + // Describes a state change for the certificate. + StateReason *string } // Contains general information about a certificate. type CertificateInfo struct { - // The date and time when the certificate will expire. - ExpiryDateTime *time.Time - // The identifier of the certificate. CertificateId *string // The common name for the certificate. CommonName *string + // The date and time when the certificate will expire. + ExpiryDateTime *time.Time + // The state of the certificate. State CertificateState } @@ -57,13 +57,13 @@ type CertificateInfo struct { // Contains information about a computer account in a directory. type Computer struct { - // The identifier of the computer. - ComputerId *string - // An array of Attribute () objects containing the LDAP attributes that belong to // the computer account. ComputerAttributes []*Attribute + // The identifier of the computer. + ComputerId *string + // The computer name. ComputerName *string } @@ -91,11 +91,6 @@ type ConditionalForwarder struct { // directory is being created. type DirectoryConnectSettings struct { - // A list of subnet identifiers in the VPC in which the AD Connector is created. - // - // This member is required. - SubnetIds []*string - // A list of one or more IP addresses of DNS servers or domain controllers in the // on-premises directory. // @@ -116,6 +111,11 @@ type DirectoryConnectSettings struct { // This member is required. CustomerUserName *string + // A list of subnet identifiers in the VPC in which the AD Connector is created. + // + // This member is required. + SubnetIds []*string + // The identifier of the VPC in which the AD Connector is created. // // This member is required. @@ -125,269 +125,269 @@ type DirectoryConnectSettings struct { // Contains information about an AD Connector directory. type DirectoryConnectSettingsDescription struct { - // The security group identifier for the AD Connector directory. - SecurityGroupId *string + // A list of the Availability Zones that the directory is in. + AvailabilityZones []*string // The IP addresses of the AD Connector servers. ConnectIps []*string + // The user name of the service account in the on-premises directory. + CustomerUserName *string + + // The security group identifier for the AD Connector directory. + SecurityGroupId *string + // A list of subnet identifiers in the VPC that the AD Connector is in. SubnetIds []*string // The identifier of the VPC that the AD Connector is in. VpcId *string - - // The user name of the service account in the on-premises directory. - CustomerUserName *string - - // A list of the Availability Zones that the directory is in. - AvailabilityZones []*string } // Contains information about an AWS Directory Service directory. type DirectoryDescription struct { + // The access URL for the directory, such as http://.awsapps.com. If no alias has + // been created for the directory, is the directory identifier, such as + // d-XXXXXXXXXX. + AccessUrl *string + + // The alias for the directory. If no alias has been created for the directory, the + // alias is the directory identifier, such as d-XXXXXXXXXX. + Alias *string + // A DirectoryConnectSettingsDescription () object that contains additional // information about an AD Connector directory. This member is only present if the // directory is an AD Connector directory. ConnectSettings *DirectoryConnectSettingsDescription - // A directory share request that is sent by the directory owner to the directory - // consumer. The request includes a typed message to help the directory consumer - // administrator determine whether to approve or reject the share invitation. - ShareNotes *string - - // The current stage of the directory. - Stage DirectoryStage - - // The method used when sharing a directory to determine whether the directory - // should be shared within your AWS organization (ORGANIZATIONS) or with any AWS - // account by sending a shared directory request (HANDSHAKE). - ShareMethod ShareMethod + // The description for the directory. + Description *string - // The directory size. - Type DirectoryType + // The desired number of domain controllers in the directory if the directory is + // Microsoft AD. + DesiredNumberOfDomainControllers *int32 - // The status of the RADIUS MFA server connection. - RadiusStatus RadiusStatus + // The directory identifier. + DirectoryId *string - // The short name of the directory. - ShortName *string + // The IP addresses of the DNS servers for the directory. For a Simple AD or + // Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft + // AD directory servers. For an AD Connector directory, these are the IP addresses + // of the DNS servers or domain controllers in the on-premises directory to which + // the AD Connector is connected. + DnsIpAddrs []*string - // The alias for the directory. If no alias has been created for the directory, the - // alias is the directory identifier, such as d-XXXXXXXXXX. - Alias *string + // The edition associated with this directory. + Edition DirectoryEdition - // Additional information about the directory stage. - StageReason *string + // Specifies when the directory was created. + LaunchTime *time.Time - // The date and time that the stage was last updated. - StageLastUpdatedDateTime *time.Time + // The fully qualified name of the directory. + Name *string // Describes the AWS Managed Microsoft AD directory in the directory owner account. OwnerDirectoryDescription *OwnerDirectoryDescription - // The description for the directory. - Description *string - - // A DirectoryVpcSettingsDescription () object that contains additional information - // about a directory. This member is only present if the directory is a Simple AD - // or Managed AD directory. - VpcSettings *DirectoryVpcSettingsDescription - // A RadiusSettings () object that contains information about the RADIUS server // configured for this directory. RadiusSettings *RadiusSettings - // The fully qualified name of the directory. - Name *string + // The status of the RADIUS MFA server connection. + RadiusStatus RadiusStatus - // The directory identifier. - DirectoryId *string + // The method used when sharing a directory to determine whether the directory + // should be shared within your AWS organization (ORGANIZATIONS) or with any AWS + // account by sending a shared directory request (HANDSHAKE). + ShareMethod ShareMethod + + // A directory share request that is sent by the directory owner to the directory + // consumer. The request includes a typed message to help the directory consumer + // administrator determine whether to approve or reject the share invitation. + ShareNotes *string + + // Current directory status of the shared AWS Managed Microsoft AD directory. + ShareStatus ShareStatus + + // The short name of the directory. + ShortName *string // The directory size. Size DirectorySize - // Specifies when the directory was created. - LaunchTime *time.Time - - // The access URL for the directory, such as http://.awsapps.com. If no alias has - // been created for the directory, is the directory identifier, such as - // d-XXXXXXXXXX. - AccessUrl *string + // Indicates if single sign-on is enabled for the directory. For more information, + // see EnableSso () and DisableSso (). + SsoEnabled *bool - // The edition associated with this directory. - Edition DirectoryEdition + // The current stage of the directory. + Stage DirectoryStage - // The desired number of domain controllers in the directory if the directory is - // Microsoft AD. - DesiredNumberOfDomainControllers *int32 + // The date and time that the stage was last updated. + StageLastUpdatedDateTime *time.Time - // The IP addresses of the DNS servers for the directory. For a Simple AD or - // Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft - // AD directory servers. For an AD Connector directory, these are the IP addresses - // of the DNS servers or domain controllers in the on-premises directory to which - // the AD Connector is connected. - DnsIpAddrs []*string + // Additional information about the directory stage. + StageReason *string - // Current directory status of the shared AWS Managed Microsoft AD directory. - ShareStatus ShareStatus + // The directory size. + Type DirectoryType - // Indicates if single sign-on is enabled for the directory. For more information, - // see EnableSso () and DisableSso (). - SsoEnabled *bool + // A DirectoryVpcSettingsDescription () object that contains additional information + // about a directory. This member is only present if the directory is a Simple AD + // or Managed AD directory. + VpcSettings *DirectoryVpcSettingsDescription } // Contains directory limit information for a Region. type DirectoryLimits struct { + // The current number of cloud directories in the Region. + CloudOnlyDirectoriesCurrentCount *int32 + + // The maximum number of cloud directories allowed in the Region. + CloudOnlyDirectoriesLimit *int32 + // Indicates if the cloud directory limit has been reached. CloudOnlyDirectoriesLimitReached *bool - // Indicates if the connected directory limit has been reached. - ConnectedDirectoriesLimitReached *bool + // The current number of AWS Managed Microsoft AD directories in the region. + CloudOnlyMicrosoftADCurrentCount *int32 - // The maximum number of cloud directories allowed in the Region. - CloudOnlyDirectoriesLimit *int32 + // The maximum number of AWS Managed Microsoft AD directories allowed in the + // region. + CloudOnlyMicrosoftADLimit *int32 // Indicates if the AWS Managed Microsoft AD directory limit has been reached. CloudOnlyMicrosoftADLimitReached *bool - // The maximum number of connected directories allowed in the Region. - ConnectedDirectoriesLimit *int32 - // The current number of connected directories in the Region. ConnectedDirectoriesCurrentCount *int32 - // The current number of cloud directories in the Region. - CloudOnlyDirectoriesCurrentCount *int32 - - // The maximum number of AWS Managed Microsoft AD directories allowed in the - // region. - CloudOnlyMicrosoftADLimit *int32 + // The maximum number of connected directories allowed in the Region. + ConnectedDirectoriesLimit *int32 - // The current number of AWS Managed Microsoft AD directories in the region. - CloudOnlyMicrosoftADCurrentCount *int32 + // Indicates if the connected directory limit has been reached. + ConnectedDirectoriesLimitReached *bool } // Contains VPC information for the CreateDirectory () or CreateMicrosoftAD () // operation. type DirectoryVpcSettings struct { - // The identifier of the VPC in which to create the directory. - // - // This member is required. - VpcId *string - // The identifiers of the subnets for the directory servers. The two subnets must // be in different Availability Zones. AWS Directory Service creates a directory // server and a DNS server in each of these subnets. // // This member is required. SubnetIds []*string + + // The identifier of the VPC in which to create the directory. + // + // This member is required. + VpcId *string } // Contains information about the directory. type DirectoryVpcSettingsDescription struct { - // The identifiers of the subnets for the directory servers. - SubnetIds []*string - // The list of Availability Zones that the directory is in. AvailabilityZones []*string - // The identifier of the VPC that the directory is in. - VpcId *string - // The domain controller security group identifier for the directory. SecurityGroupId *string + + // The identifiers of the subnets for the directory servers. + SubnetIds []*string + + // The identifier of the VPC that the directory is in. + VpcId *string } // Contains information about the domain controllers for a specified directory. type DomainController struct { - // A description of the domain controller state. - StatusReason *string + // The Availability Zone where the domain controller is located. + AvailabilityZone *string - // Identifier of the subnet in the VPC that contains the domain controller. - SubnetId *string + // Identifier of the directory where the domain controller resides. + DirectoryId *string - // The date and time that the status was last updated. - StatusLastUpdatedDateTime *time.Time + // The IP address of the domain controller. + DnsIpAddr *string + + // Identifies a specific domain controller in the directory. + DomainControllerId *string // Specifies when the domain controller was created. LaunchTime *time.Time - // The IP address of the domain controller. - DnsIpAddr *string - // The status of the domain controller. Status DomainControllerStatus - // Identifier of the directory where the domain controller resides. - DirectoryId *string + // The date and time that the status was last updated. + StatusLastUpdatedDateTime *time.Time - // The Availability Zone where the domain controller is located. - AvailabilityZone *string + // A description of the domain controller state. + StatusReason *string + + // Identifier of the subnet in the VPC that contains the domain controller. + SubnetId *string // The identifier of the VPC that contains the domain controller. VpcId *string - - // Identifies a specific domain controller in the directory. - DomainControllerId *string } // Information about SNS topic and AWS Directory Service directory associations. type EventTopic struct { - // The SNS topic ARN (Amazon Resource Name). - TopicArn *string - - // The name of an AWS SNS topic the receives status messages from the directory. - TopicName *string - // The date and time of when you associated your directory with the SNS topic. CreatedDateTime *time.Time - // The topic registration status. - Status TopicStatus - // The Directory ID of an AWS Directory Service directory that will publish status // messages to an SNS topic. DirectoryId *string + + // The topic registration status. + Status TopicStatus + + // The SNS topic ARN (Amazon Resource Name). + TopicArn *string + + // The name of an AWS SNS topic the receives status messages from the directory. + TopicName *string } // IP address block. This is often the address block of the DNS server used for // your on-premises domain. type IpRoute struct { - // Description of the address block. - Description *string - // IP address block using CIDR format, for example 10.0.0.0/24. This is often the // address block of the DNS server used for your on-premises domain. For a single // IP address use a CIDR address block with /32. For example 10.0.0.0/32. CidrIp *string + + // Description of the address block. + Description *string } // Information about one or more IP address blocks. type IpRouteInfo struct { + // The date and time the address block was added to the directory. + AddedDateTime *time.Time + + // IP address block in the IpRoute (). + CidrIp *string + // Description of the IpRouteInfo (). Description *string // Identifier (ID) of the directory associated with the IP addresses. DirectoryId *string - // IP address block in the IpRoute (). - CidrIp *string - // The status of the IP address block. IpRouteStatusMsg IpRouteStatusMsg - // The date and time the address block was added to the directory. - AddedDateTime *time.Time - // The reason for the IpRouteStatusMsg. IpRouteStatusReason *string } @@ -395,37 +395,41 @@ type IpRouteInfo struct { // Contains general information about the LDAPS settings. type LDAPSSettingInfo struct { + // The state of the LDAPS settings. + LDAPSStatus LDAPSStatus + // Describes a state change for LDAPS. LDAPSStatusReason *string // The date and time when the LDAPS settings were last updated. LastUpdatedDateTime *time.Time - - // The state of the LDAPS settings. - LDAPSStatus LDAPSStatus } // Represents a log subscription, which tracks real-time data from a chosen log // group to a specified destination. type LogSubscription struct { - // The date and time that the log subscription was created. - SubscriptionCreatedDateTime *time.Time - // Identifier (ID) of the directory that you want to associate with the log // subscription. DirectoryId *string // The name of the log group. LogGroupName *string + + // The date and time that the log subscription was created. + SubscriptionCreatedDateTime *time.Time } // Describes the directory owner account details that have been shared to the // directory consumer account. type OwnerDirectoryDescription struct { - // Information about the status of the RADIUS server. - RadiusStatus RadiusStatus + // Identifier of the directory owner account. + AccountId *string + + // Identifier of the AWS Managed Microsoft AD directory in the directory owner + // account. + DirectoryId *string // IP address of the directory’s domain controllers. DnsIpAddrs []*string @@ -433,12 +437,8 @@ type OwnerDirectoryDescription struct { // A RadiusSettings () object that contains information about the RADIUS server. RadiusSettings *RadiusSettings - // Identifier of the directory owner account. - AccountId *string - - // Identifier of the AWS Managed Microsoft AD directory in the directory owner - // account. - DirectoryId *string + // Information about the status of the RADIUS server. + RadiusStatus RadiusStatus // Information about the VPC settings for the directory. VpcSettings *DirectoryVpcSettingsDescription @@ -448,33 +448,33 @@ type OwnerDirectoryDescription struct { // server. type RadiusSettings struct { - // Not currently used. - UseSameUsername *bool + // The protocol specified for your RADIUS endpoints. + AuthenticationProtocol RadiusAuthenticationProtocol - // The amount of time, in seconds, to wait for the RADIUS server to respond. - RadiusTimeout *int32 + // Not currently used. + DisplayLabel *string // The port that your RADIUS server is using for communications. Your on-premises // network must allow inbound traffic over this port from the AWS Directory Service // servers. RadiusPort *int32 - // Required for enabling RADIUS on the directory. - SharedSecret *string + // The maximum number of times that communication with the RADIUS server is + // attempted. + RadiusRetries *int32 // An array of strings that contains the IP addresses of the RADIUS server // endpoints, or the IP addresses of your RADIUS server load balancer. RadiusServers []*string - // The maximum number of times that communication with the RADIUS server is - // attempted. - RadiusRetries *int32 + // The amount of time, in seconds, to wait for the RADIUS server to respond. + RadiusTimeout *int32 - // The protocol specified for your RADIUS endpoints. - AuthenticationProtocol RadiusAuthenticationProtocol + // Required for enabling RADIUS on the directory. + SharedSecret *string // Not currently used. - DisplayLabel *string + UseSameUsername *bool } // Information about a schema extension. @@ -486,8 +486,8 @@ type SchemaExtensionInfo struct { // The identifier of the directory to which the schema extension is applied. DirectoryId *string - // The reason for the SchemaExtensionStatus. - SchemaExtensionStatusReason *string + // The date and time that the schema extension was completed. + EndDateTime *time.Time // The identifier of the schema extension. SchemaExtensionId *string @@ -495,8 +495,8 @@ type SchemaExtensionInfo struct { // The current status of the schema extension. SchemaExtensionStatus SchemaExtensionStatus - // The date and time that the schema extension was completed. - EndDateTime *time.Time + // The reason for the SchemaExtensionStatus. + SchemaExtensionStatusReason *string // The date and time that the schema extension started being applied to the // directory. @@ -507,26 +507,12 @@ type SchemaExtensionInfo struct { // share request in the directory consumer account has been accepted. type SharedDirectory struct { - // Identifier of the shared directory in the directory consumer account. This - // identifier is different for each directory owner account. - SharedDirectoryId *string - - // A directory share request that is sent by the directory owner to the directory - // consumer. The request includes a typed message to help the directory consumer - // administrator determine whether to approve or reject the share invitation. - ShareNotes *string - // The date and time that the shared directory was created. CreatedDateTime *time.Time // The date and time that the shared directory was last updated. LastUpdatedDateTime *time.Time - // The method used when sharing a directory to determine whether the directory - // should be shared within your AWS organization (ORGANIZATIONS) or with any AWS - // account by sending a shared directory request (HANDSHAKE). - ShareMethod ShareMethod - // Identifier of the directory owner account, which contains the directory that has // been shared to the consumer account. OwnerAccountId *string @@ -534,33 +520,50 @@ type SharedDirectory struct { // Identifier of the directory in the directory owner account. OwnerDirectoryId *string + // The method used when sharing a directory to determine whether the directory + // should be shared within your AWS organization (ORGANIZATIONS) or with any AWS + // account by sending a shared directory request (HANDSHAKE). + ShareMethod ShareMethod + + // A directory share request that is sent by the directory owner to the directory + // consumer. The request includes a typed message to help the directory consumer + // administrator determine whether to approve or reject the share invitation. + ShareNotes *string + // Current directory status of the shared AWS Managed Microsoft AD directory. ShareStatus ShareStatus // Identifier of the directory consumer account that has access to the shared // directory (OwnerDirectoryId) in the directory owner account. SharedAccountId *string + + // Identifier of the shared directory in the directory consumer account. This + // identifier is different for each directory owner account. + SharedDirectoryId *string } // Identifier that contains details about the directory consumer account. type ShareTarget struct { - // Type of identifier to be used in the Id field. + // Identifier of the directory consumer account. // // This member is required. - Type TargetType + Id *string - // Identifier of the directory consumer account. + // Type of identifier to be used in the Id field. // // This member is required. - Id *string + Type TargetType } // Describes a directory snapshot. type Snapshot struct { - // The snapshot status. - Status SnapshotStatus + // The directory identifier. + DirectoryId *string + + // The descriptive name of the snapshot. + Name *string // The snapshot identifier. SnapshotId *string @@ -568,25 +571,22 @@ type Snapshot struct { // The date and time that the snapshot was taken. StartTime *time.Time - // The descriptive name of the snapshot. - Name *string + // The snapshot status. + Status SnapshotStatus // The snapshot type. Type SnapshotType - - // The directory identifier. - DirectoryId *string } // Contains manual snapshot limit information for a directory. type SnapshotLimits struct { - // The maximum number of manual snapshots allowed. - ManualSnapshotsLimit *int32 - // The current number of manual snapshots of the directory. ManualSnapshotsCurrentCount *int32 + // The maximum number of manual snapshots allowed. + ManualSnapshotsLimit *int32 + // Indicates if the manual snapshot limit has been reached. ManualSnapshotsLimitReached *bool } @@ -594,13 +594,6 @@ type SnapshotLimits struct { // Metadata assigned to a directory consisting of a key-value pair. type Tag struct { - // The optional value of the tag. The string value can be Unicode characters. The - // string can contain only the set of Unicode letters, digits, white-space, '_', - // '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). - // - // This member is required. - Value *string - // Required name of the tag. The string value can be Unicode characters and cannot // be prefixed with "aws:". The string can contain only the set of Unicode letters, // digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: @@ -608,23 +601,31 @@ type Tag struct { // // This member is required. Key *string + + // The optional value of the tag. The string value can be Unicode characters. The + // string can contain only the set of Unicode letters, digits, white-space, '_', + // '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). + // + // This member is required. + Value *string } // Describes a trust relationship between an AWS Managed Microsoft AD directory and // an external domain. type Trust struct { + // The date and time that the trust relationship was created. + CreatedDateTime *time.Time + // The Directory ID of the AWS directory involved in the trust relationship. DirectoryId *string - // The reason for the TrustState. - TrustStateReason *string - - // The date and time that the trust relationship was created. - CreatedDateTime *time.Time + // The date and time that the trust relationship was last updated. + LastUpdatedDateTime *time.Time - // The trust relationship state. - TrustState TrustState + // The Fully Qualified Domain Name (FQDN) of the external domain involved in the + // trust relationship. + RemoteDomainName *string // Current state of selective authentication for the trust. SelectiveAuth SelectiveAuth @@ -632,18 +633,17 @@ type Trust struct { // The date and time that the TrustState was last updated. StateLastUpdatedDateTime *time.Time - // The Fully Qualified Domain Name (FQDN) of the external domain involved in the - // trust relationship. - RemoteDomainName *string + // The trust relationship direction. + TrustDirection TrustDirection // The unique ID of the trust relationship. TrustId *string - // The date and time that the trust relationship was last updated. - LastUpdatedDateTime *time.Time + // The trust relationship state. + TrustState TrustState - // The trust relationship direction. - TrustDirection TrustDirection + // The reason for the TrustState. + TrustStateReason *string // The trust relationship type. Forest is the default. TrustType TrustType diff --git a/service/dlm/api_op_CreateLifecyclePolicy.go b/service/dlm/api_op_CreateLifecyclePolicy.go index 38b740dcac7..3ec8428ae18 100644 --- a/service/dlm/api_op_CreateLifecyclePolicy.go +++ b/service/dlm/api_op_CreateLifecyclePolicy.go @@ -58,28 +58,28 @@ func (c *Client) CreateLifecyclePolicy(ctx context.Context, params *CreateLifecy type CreateLifecyclePolicyInput struct { - // The Amazon Resource Name (ARN) of the IAM role used to run the operations - // specified by the lifecycle policy. - // - // This member is required. - ExecutionRoleArn *string - // A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are // supported. // // This member is required. Description *string - // The desired activation state of the lifecycle policy after creation. + // The Amazon Resource Name (ARN) of the IAM role used to run the operations + // specified by the lifecycle policy. // // This member is required. - State types.SettablePolicyStateValues + ExecutionRoleArn *string // The configuration details of the lifecycle policy. // // This member is required. PolicyDetails *types.PolicyDetails + // The desired activation state of the lifecycle policy after creation. + // + // This member is required. + State types.SettablePolicyStateValues + // The tags to apply to the lifecycle policy during creation. Tags map[string]*string } diff --git a/service/dlm/api_op_GetLifecyclePolicies.go b/service/dlm/api_op_GetLifecyclePolicies.go index fb9b425fcd5..826a06852f0 100644 --- a/service/dlm/api_op_GetLifecyclePolicies.go +++ b/service/dlm/api_op_GetLifecyclePolicies.go @@ -57,22 +57,22 @@ func (c *Client) GetLifecyclePolicies(ctx context.Context, params *GetLifecycleP type GetLifecyclePoliciesInput struct { + // The identifiers of the data lifecycle policies. + PolicyIds []*string + // The resource type. ResourceTypes []types.ResourceTypeValues - // The target tag for a policy. Tags are strings in the format key=value. - TargetTags []*string - - // The identifiers of the data lifecycle policies. - PolicyIds []*string + // The activation state. + State types.GettablePolicyStateValues // The tags to add to objects created by the policy. Tags are strings in the format // key=value. These user-defined tags are added in addition to the AWS-added // lifecycle tags. TagsToAdd []*string - // The activation state. - State types.GettablePolicyStateValues + // The target tag for a policy. Tags are strings in the format key=value. + TargetTags []*string } type GetLifecyclePoliciesOutput struct { diff --git a/service/dlm/api_op_TagResource.go b/service/dlm/api_op_TagResource.go index 67fbfcd7a59..815aef31114 100644 --- a/service/dlm/api_op_TagResource.go +++ b/service/dlm/api_op_TagResource.go @@ -56,15 +56,15 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // One or more tags. + // The Amazon Resource Name (ARN) of the resource. // // This member is required. - Tags map[string]*string + ResourceArn *string - // The Amazon Resource Name (ARN) of the resource. + // One or more tags. // // This member is required. - ResourceArn *string + Tags map[string]*string } type TagResourceOutput struct { diff --git a/service/dlm/api_op_UntagResource.go b/service/dlm/api_op_UntagResource.go index 4608488b2c2..268f90e6e65 100644 --- a/service/dlm/api_op_UntagResource.go +++ b/service/dlm/api_op_UntagResource.go @@ -56,15 +56,15 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The tag keys. + // The Amazon Resource Name (ARN) of the resource. // // This member is required. - TagKeys []*string + ResourceArn *string - // The Amazon Resource Name (ARN) of the resource. + // The tag keys. // // This member is required. - ResourceArn *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/dlm/api_op_UpdateLifecyclePolicy.go b/service/dlm/api_op_UpdateLifecyclePolicy.go index f84e1b85a92..f49d80ae52e 100644 --- a/service/dlm/api_op_UpdateLifecyclePolicy.go +++ b/service/dlm/api_op_UpdateLifecyclePolicy.go @@ -62,19 +62,19 @@ type UpdateLifecyclePolicyInput struct { // This member is required. PolicyId *string - // The desired activation state of the lifecycle policy after creation. - State types.SettablePolicyStateValues - - // The configuration of the lifecycle policy. You cannot update the policy type or - // the resource type. - PolicyDetails *types.PolicyDetails - // A description of the lifecycle policy. Description *string // The Amazon Resource Name (ARN) of the IAM role used to run the operations // specified by the lifecycle policy. ExecutionRoleArn *string + + // The configuration of the lifecycle policy. You cannot update the policy type or + // the resource type. + PolicyDetails *types.PolicyDetails + + // The desired activation state of the lifecycle policy after creation. + State types.SettablePolicyStateValues } type UpdateLifecyclePolicyOutput struct { diff --git a/service/dlm/go.mod b/service/dlm/go.mod index 61500f9d96f..1a91f94dcc8 100644 --- a/service/dlm/go.mod +++ b/service/dlm/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/dlm go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/dlm/types/types.go b/service/dlm/types/types.go index 2f743bea0df..b7894457968 100644 --- a/service/dlm/types/types.go +++ b/service/dlm/types/types.go @@ -11,34 +11,34 @@ import ( // specify both. type CreateRule struct { - // The time, in UTC, to start the operation. The supported format is hh:mm. The - // operation occurs within a one-hour window following the specified time. If you - // do not specify a time, Amazon DLM selects a time within the next 24 hours. - Times []*string - // The schedule, as a Cron expression. The schedule interval must be between 1 hour // and 1 year. For more information, see Cron expressions // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions) // in the Amazon CloudWatch User Guide. CronExpression *string - // The interval unit. - IntervalUnit IntervalUnitValues - // The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, // and 24. Interval *int32 + + // The interval unit. + IntervalUnit IntervalUnitValues + + // The time, in UTC, to start the operation. The supported format is hh:mm. The + // operation occurs within a one-hour window following the specified time. If you + // do not specify a time, Amazon DLM selects a time within the next 24 hours. + Times []*string } // Specifies the retention rule for cross-Region snapshot copies. type CrossRegionCopyRetainRule struct { - // The unit of time for time-based retention. - IntervalUnit RetentionIntervalUnitValues - // The amount of time to retain each snapshot. The maximum is 100 years. This is // equivalent to 1200 months, 5200 weeks, or 36500 days. Interval *int32 + + // The unit of time for time-based retention. + IntervalUnit RetentionIntervalUnitValues } // Specifies a rule for cross-Region snapshot copies. @@ -52,76 +52,76 @@ type CrossRegionCopyRule struct { // This member is required. Encrypted *bool - // The retention rule. - RetainRule *CrossRegionCopyRetainRule - // The target Region. // // This member is required. TargetRegion *string - // Copy all user-defined tags from the source snapshot to the copied snapshot. - CopyTags *bool - // The Amazon Resource Name (ARN) of the AWS KMS customer master key (CMK) to use // for EBS encryption. If this parameter is not specified, your AWS managed CMK for // EBS is used. CmkArn *string + + // Copy all user-defined tags from the source snapshot to the copied snapshot. + CopyTags *bool + + // The retention rule. + RetainRule *CrossRegionCopyRetainRule } // Specifies a rule for enabling fast snapshot restore. You can enable fast // snapshot restore based on either a count or a time interval. type FastRestoreRule struct { + // The Availability Zones in which to enable fast snapshot restore. + // + // This member is required. + AvailabilityZones []*string + // The number of snapshots to be enabled with fast snapshot restore. Count *int32 - // The unit of time for enabling fast snapshot restore. - IntervalUnit RetentionIntervalUnitValues - // The amount of time to enable fast snapshot restore. The maximum is 100 years. // This is equivalent to 1200 months, 5200 weeks, or 36500 days. Interval *int32 - // The Availability Zones in which to enable fast snapshot restore. - // - // This member is required. - AvailabilityZones []*string + // The unit of time for enabling fast snapshot restore. + IntervalUnit RetentionIntervalUnitValues } // Detailed information about a lifecycle policy. type LifecyclePolicy struct { - // The Amazon Resource Name (ARN) of the policy. - PolicyArn *string - - // The identifier of the lifecycle policy. - PolicyId *string + // The local date and time when the lifecycle policy was created. + DateCreated *time.Time // The local date and time when the lifecycle policy was last modified. DateModified *time.Time - // The description of the status. - StatusMessage *string - - // The tags. - Tags map[string]*string + // The description of the lifecycle policy. + Description *string // The Amazon Resource Name (ARN) of the IAM role used to run the operations // specified by the lifecycle policy. ExecutionRoleArn *string - // The activation state of the lifecycle policy. - State GettablePolicyStateValues - - // The local date and time when the lifecycle policy was created. - DateCreated *time.Time + // The Amazon Resource Name (ARN) of the policy. + PolicyArn *string // The configuration of the lifecycle policy PolicyDetails *PolicyDetails - // The description of the lifecycle policy. - Description *string + // The identifier of the lifecycle policy. + PolicyId *string + + // The activation state of the lifecycle policy. + State GettablePolicyStateValues + + // The description of the status. + StatusMessage *string + + // The tags. + Tags map[string]*string } // Summary information about a lifecycle policy. @@ -130,14 +130,14 @@ type LifecyclePolicySummary struct { // The description of the lifecycle policy. Description *string - // The tags. - Tags map[string]*string - // The identifier of the lifecycle policy. PolicyId *string // The activation state of the lifecycle policy. State GettablePolicyStateValues + + // The tags. + Tags map[string]*string } // Specifies optional parameters to add to a policy. The set of valid parameters @@ -157,14 +157,14 @@ type PolicyDetails struct { // A set of optional parameters for the policy. Parameters *Parameters - // The resource type. Use VOLUME to create snapshots of individual volumes or use - // INSTANCE to create multi-volume snapshots from the volumes for an instance. - ResourceTypes []ResourceTypeValues - // The valid target resource types and actions a policy can manage. The default is // EBS_SNAPSHOT_MANAGEMENT. PolicyType PolicyTypeValues + // The resource type. Use VOLUME to create snapshots of individual volumes or use + // INSTANCE to create multi-volume snapshots from the volumes for an instance. + ResourceTypes []ResourceTypeValues + // The schedule of policy-defined actions. Schedules []*Schedule @@ -176,33 +176,36 @@ type PolicyDetails struct { // based on either a count or a time interval. type RetainRule struct { - // The unit of time for time-based retention. - IntervalUnit RetentionIntervalUnitValues - // The number of snapshots to retain for each volume, up to a maximum of 1000. Count *int32 // The amount of time to retain each snapshot. The maximum is 100 years. This is // equivalent to 1200 months, 5200 weeks, or 36500 days. Interval *int32 + + // The unit of time for time-based retention. + IntervalUnit RetentionIntervalUnitValues } // Specifies a backup schedule. type Schedule struct { - // The rule for cross-Region snapshot copies. - CrossRegionCopyRules []*CrossRegionCopyRule - // Copy all user-defined tags on a source volume to snapshots of the volume created // by this policy. CopyTags *bool - // The name of the schedule. - Name *string + // The creation rule. + CreateRule *CreateRule + + // The rule for cross-Region snapshot copies. + CrossRegionCopyRules []*CrossRegionCopyRule // The rule for enabling fast snapshot restore. FastRestoreRule *FastRestoreRule + // The name of the schedule. + Name *string + // The retention rule. RetainRule *RetainRule @@ -215,9 +218,6 @@ type Schedule struct { // one of the two following formats: $(instance-id) or $(timestamp). Variable tags // are only valid for EBS Snapshot Management – Instance policies. VariableTags []*Tag - - // The creation rule. - CreateRule *CreateRule } // Specifies a tag for a resource. diff --git a/service/docdb/api_op_AddTagsToResource.go b/service/docdb/api_op_AddTagsToResource.go index e590336867b..b6014c162f0 100644 --- a/service/docdb/api_op_AddTagsToResource.go +++ b/service/docdb/api_op_AddTagsToResource.go @@ -61,16 +61,16 @@ func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourc // Represents the input to AddTagsToResource (). type AddTagsToResourceInput struct { - // The tags to be assigned to the Amazon DocumentDB resource. - // - // This member is required. - Tags []*types.Tag - // The Amazon DocumentDB resource that the tags are added to. This value is an // Amazon Resource Name (ARN). // // This member is required. ResourceName *string + + // The tags to be assigned to the Amazon DocumentDB resource. + // + // This member is required. + Tags []*types.Tag } type AddTagsToResourceOutput struct { diff --git a/service/docdb/api_op_CopyDBClusterParameterGroup.go b/service/docdb/api_op_CopyDBClusterParameterGroup.go index 6f522541b23..40ca18e30aa 100644 --- a/service/docdb/api_op_CopyDBClusterParameterGroup.go +++ b/service/docdb/api_op_CopyDBClusterParameterGroup.go @@ -58,9 +58,6 @@ func (c *Client) CopyDBClusterParameterGroup(ctx context.Context, params *CopyDB // Represents the input to CopyDBClusterParameterGroup (). type CopyDBClusterParameterGroupInput struct { - // The tags that are to be assigned to the parameter group. - Tags []*types.Tag - // The identifier or Amazon Resource Name (ARN) for the source cluster parameter // group. Constraints: // @@ -79,6 +76,11 @@ type CopyDBClusterParameterGroupInput struct { // This member is required. SourceDBClusterParameterGroupIdentifier *string + // A description for the copied cluster parameter group. + // + // This member is required. + TargetDBClusterParameterGroupDescription *string + // The identifier for the copied cluster parameter group. Constraints: // // * @@ -98,10 +100,8 @@ type CopyDBClusterParameterGroupInput struct { // This member is required. TargetDBClusterParameterGroupIdentifier *string - // A description for the copied cluster parameter group. - // - // This member is required. - TargetDBClusterParameterGroupDescription *string + // The tags that are to be assigned to the parameter group. + Tags []*types.Tag } type CopyDBClusterParameterGroupOutput struct { diff --git a/service/docdb/api_op_CopyDBClusterSnapshot.go b/service/docdb/api_op_CopyDBClusterSnapshot.go index d78edd5376b..643fb40819f 100644 --- a/service/docdb/api_op_CopyDBClusterSnapshot.go +++ b/service/docdb/api_op_CopyDBClusterSnapshot.go @@ -63,8 +63,41 @@ func (c *Client) CopyDBClusterSnapshot(ctx context.Context, params *CopyDBCluste // Represents the input to CopyDBClusterSnapshot (). type CopyDBClusterSnapshotInput struct { - // The tags to be assigned to the cluster snapshot. - Tags []*types.Tag + // The identifier of the cluster snapshot to copy. This parameter is not case + // sensitive. You can't copy an encrypted, shared cluster snapshot from one AWS + // Region to another. Constraints: + // + // * Must specify a valid system snapshot in + // the "available" state. + // + // * If the source snapshot is in the same AWS Region + // as the copy, specify a valid snapshot identifier. + // + // * If the source snapshot + // is in a different AWS Region than the copy, specify a valid cluster snapshot + // ARN. + // + // Example: my-cluster-snapshot1 + // + // This member is required. + SourceDBClusterSnapshotIdentifier *string + + // The identifier of the new cluster snapshot to create from the source cluster + // snapshot. This parameter is not case sensitive. Constraints: + // + // * Must contain + // from 1 to 63 letters, numbers, or hyphens. + // + // * The first character must be a + // letter. + // + // * Cannot end with a hyphen or contain two consecutive + // hyphens. + // + // Example: my-cluster-snapshot2 + // + // This member is required. + TargetDBClusterSnapshotIdentifier *string // Set to true to copy all tags from the source cluster snapshot to the target // cluster snapshot, and otherwise false. The default is false. @@ -86,25 +119,6 @@ type CopyDBClusterSnapshotInput struct { // for the KmsKeyId parameter, an error is returned. KmsKeyId *string - // The identifier of the cluster snapshot to copy. This parameter is not case - // sensitive. You can't copy an encrypted, shared cluster snapshot from one AWS - // Region to another. Constraints: - // - // * Must specify a valid system snapshot in - // the "available" state. - // - // * If the source snapshot is in the same AWS Region - // as the copy, specify a valid snapshot identifier. - // - // * If the source snapshot - // is in a different AWS Region than the copy, specify a valid cluster snapshot - // ARN. - // - // Example: my-cluster-snapshot1 - // - // This member is required. - SourceDBClusterSnapshotIdentifier *string - // The URL that contains a Signature Version 4 signed request for the // CopyDBClusterSnapshot API action in the AWS Region that contains the source // cluster snapshot to copy. You must use the PreSignedUrl parameter when copying @@ -132,22 +146,8 @@ type CopyDBClusterSnapshotInput struct { // arn:aws:rds:us-west-2:123456789012:cluster-snapshot:my-cluster-snapshot-20161115. PreSignedUrl *string - // The identifier of the new cluster snapshot to create from the source cluster - // snapshot. This parameter is not case sensitive. Constraints: - // - // * Must contain - // from 1 to 63 letters, numbers, or hyphens. - // - // * The first character must be a - // letter. - // - // * Cannot end with a hyphen or contain two consecutive - // hyphens. - // - // Example: my-cluster-snapshot2 - // - // This member is required. - TargetDBClusterSnapshotIdentifier *string + // The tags to be assigned to the cluster snapshot. + Tags []*types.Tag } type CopyDBClusterSnapshotOutput struct { diff --git a/service/docdb/api_op_CreateDBCluster.go b/service/docdb/api_op_CreateDBCluster.go index 3e12cd7cc90..f487e968b3c 100644 --- a/service/docdb/api_op_CreateDBCluster.go +++ b/service/docdb/api_op_CreateDBCluster.go @@ -58,47 +58,6 @@ func (c *Client) CreateDBCluster(ctx context.Context, params *CreateDBClusterInp // Represents the input to CreateDBCluster (). type CreateDBClusterInput struct { - // A subnet group to associate with this cluster. Constraints: Must match the name - // of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup - DBSubnetGroupName *string - - // A list of EC2 VPC security groups to associate with this cluster. - VpcSecurityGroupIds []*string - - // The tags to be assigned to the cluster. - Tags []*types.Tag - - // A list of Amazon EC2 Availability Zones that instances in the cluster can be - // created in. - AvailabilityZones []*string - - // The password for the master database user. This password can contain any - // printable ASCII character except forward slash (/), double quote ("), or the - // "at" symbol (@). Constraints: Must contain from 8 to 100 characters. - // - // This member is required. - MasterUserPassword *string - - // The name of the database engine to be used for this cluster. Valid values: docdb - // - // This member is required. - Engine *string - - // A list of log types that need to be enabled for exporting to Amazon CloudWatch - // Logs. - EnableCloudwatchLogsExports []*string - - // Specifies whether this cluster can be deleted. If DeletionProtection is enabled, - // the cluster cannot be deleted unless it is modified and DeletionProtection is - // disabled. DeletionProtection protects clusters from being accidentally deleted. - DeletionProtection *bool - - // The number of days for which automated backups are retained. You must specify a - // minimum value of 1. Default: 1 Constraints: - // - // * Must be a value from 1 to 35. - BackupRetentionPeriod *int32 - // The cluster identifier. This parameter is stored as a lowercase string. // Constraints: // @@ -115,6 +74,18 @@ type CreateDBClusterInput struct { // This member is required. DBClusterIdentifier *string + // The name of the database engine to be used for this cluster. Valid values: docdb + // + // This member is required. + Engine *string + + // The password for the master database user. This password can contain any + // printable ASCII character except forward slash (/), double quote ("), or the + // "at" symbol (@). Constraints: Must contain from 8 to 100 characters. + // + // This member is required. + MasterUserPassword *string + // The name of the master user for the cluster. Constraints: // // * Must be from 1 @@ -128,9 +99,35 @@ type CreateDBClusterInput struct { // This member is required. MasterUsername *string + // A list of Amazon EC2 Availability Zones that instances in the cluster can be + // created in. + AvailabilityZones []*string + + // The number of days for which automated backups are retained. You must specify a + // minimum value of 1. Default: 1 Constraints: + // + // * Must be a value from 1 to 35. + BackupRetentionPeriod *int32 + // The name of the cluster parameter group to associate with this cluster. DBClusterParameterGroupName *string + // A subnet group to associate with this cluster. Constraints: Must match the name + // of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup + DBSubnetGroupName *string + + // Specifies whether this cluster can be deleted. If DeletionProtection is enabled, + // the cluster cannot be deleted unless it is modified and DeletionProtection is + // disabled. DeletionProtection protects clusters from being accidentally deleted. + DeletionProtection *bool + + // A list of log types that need to be enabled for exporting to Amazon CloudWatch + // Logs. + EnableCloudwatchLogsExports []*string + + // The version number of the database engine to use. + EngineVersion *string + // The AWS KMS key identifier for an encrypted cluster. The AWS KMS key identifier // is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are // creating a cluster using the same AWS account that owns the AWS KMS encryption @@ -157,12 +154,6 @@ type CreateDBClusterInput struct { // The port number on which the instances in the cluster accept connections. Port *int32 - // The version number of the database engine to use. - EngineVersion *string - - // Specifies whether the cluster is encrypted. - StorageEncrypted *bool - // The daily time range during which automated backups are created if automated // backups are enabled using the BackupRetentionPeriod parameter. The default is a // 30-minute window selected at random from an 8-hour block of time for each AWS @@ -185,6 +176,15 @@ type CreateDBClusterInput struct { // Region, occurring on a random day of the week. Valid days: Mon, Tue, Wed, Thu, // Fri, Sat, Sun Constraints: Minimum 30-minute window. PreferredMaintenanceWindow *string + + // Specifies whether the cluster is encrypted. + StorageEncrypted *bool + + // The tags to be assigned to the cluster. + Tags []*types.Tag + + // A list of EC2 VPC security groups to associate with this cluster. + VpcSecurityGroupIds []*string } type CreateDBClusterOutput struct { diff --git a/service/docdb/api_op_CreateDBClusterParameterGroup.go b/service/docdb/api_op_CreateDBClusterParameterGroup.go index 98c5dbae164..e182318ea5c 100644 --- a/service/docdb/api_op_CreateDBClusterParameterGroup.go +++ b/service/docdb/api_op_CreateDBClusterParameterGroup.go @@ -72,14 +72,6 @@ func (c *Client) CreateDBClusterParameterGroup(ctx context.Context, params *Crea // Represents the input of CreateDBClusterParameterGroup (). type CreateDBClusterParameterGroupInput struct { - // The description for the cluster parameter group. - // - // This member is required. - Description *string - - // The tags to be assigned to the cluster parameter group. - Tags []*types.Tag - // The name of the cluster parameter group. Constraints: // // * Must not match the @@ -95,6 +87,14 @@ type CreateDBClusterParameterGroupInput struct { // // This member is required. DBParameterGroupFamily *string + + // The description for the cluster parameter group. + // + // This member is required. + Description *string + + // The tags to be assigned to the cluster parameter group. + Tags []*types.Tag } type CreateDBClusterParameterGroupOutput struct { diff --git a/service/docdb/api_op_CreateDBClusterSnapshot.go b/service/docdb/api_op_CreateDBClusterSnapshot.go index 69d21648f2d..ba1f26bfc92 100644 --- a/service/docdb/api_op_CreateDBClusterSnapshot.go +++ b/service/docdb/api_op_CreateDBClusterSnapshot.go @@ -58,9 +58,6 @@ func (c *Client) CreateDBClusterSnapshot(ctx context.Context, params *CreateDBCl // Represents the input of CreateDBClusterSnapshot (). type CreateDBClusterSnapshotInput struct { - // The tags to be assigned to the cluster snapshot. - Tags []*types.Tag - // The identifier of the cluster to create a snapshot for. This parameter is not // case sensitive. Constraints: // @@ -87,6 +84,9 @@ type CreateDBClusterSnapshotInput struct { // // This member is required. DBClusterSnapshotIdentifier *string + + // The tags to be assigned to the cluster snapshot. + Tags []*types.Tag } type CreateDBClusterSnapshotOutput struct { diff --git a/service/docdb/api_op_CreateDBInstance.go b/service/docdb/api_op_CreateDBInstance.go index 7a0cc59fe38..d77ee57c3f8 100644 --- a/service/docdb/api_op_CreateDBInstance.go +++ b/service/docdb/api_op_CreateDBInstance.go @@ -58,47 +58,15 @@ func (c *Client) CreateDBInstance(ctx context.Context, params *CreateDBInstanceI // Represents the input to CreateDBInstance (). type CreateDBInstanceInput struct { - // A value that specifies the order in which an Amazon DocumentDB replica is - // promoted to the primary instance after a failure of the existing primary - // instance. Default: 1 Valid values: 0-15 - PromotionTier *int32 - - // The compute and memory capacity of the instance; for example, db.r5.large. - // - // This member is required. - DBInstanceClass *string - - // Indicates that minor engine upgrades are applied automatically to the instance - // during the maintenance window. Default: true - AutoMinorVersionUpgrade *bool - - // The tags to be assigned to the instance. You can assign up to 10 tags to an - // instance. - Tags []*types.Tag - - // The name of the database engine to be used for this instance. Valid value: docdb - // - // This member is required. - Engine *string - - // The time range each week during which system maintenance can occur, in Universal - // Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a - // 30-minute window selected at random from an 8-hour block of time for each AWS - // Region, occurring on a random day of the week. Valid days: Mon, Tue, Wed, Thu, - // Fri, Sat, Sun Constraints: Minimum 30-minute window. - PreferredMaintenanceWindow *string - // The identifier of the cluster that the instance will belong to. // // This member is required. DBClusterIdentifier *string - // The Amazon EC2 Availability Zone that the instance is created in. Default: A - // random, system-chosen Availability Zone in the endpoint's AWS Region. Example: - // us-east-1d Constraint: The AvailabilityZone parameter can't be specified if the - // MultiAZ parameter is set to true. The specified Availability Zone must be in the - // same AWS Region as the current endpoint. - AvailabilityZone *string + // The compute and memory capacity of the instance; for example, db.r5.large. + // + // This member is required. + DBInstanceClass *string // The instance identifier. This parameter is stored as a lowercase string. // Constraints: @@ -115,6 +83,38 @@ type CreateDBInstanceInput struct { // // This member is required. DBInstanceIdentifier *string + + // The name of the database engine to be used for this instance. Valid value: docdb + // + // This member is required. + Engine *string + + // Indicates that minor engine upgrades are applied automatically to the instance + // during the maintenance window. Default: true + AutoMinorVersionUpgrade *bool + + // The Amazon EC2 Availability Zone that the instance is created in. Default: A + // random, system-chosen Availability Zone in the endpoint's AWS Region. Example: + // us-east-1d Constraint: The AvailabilityZone parameter can't be specified if the + // MultiAZ parameter is set to true. The specified Availability Zone must be in the + // same AWS Region as the current endpoint. + AvailabilityZone *string + + // The time range each week during which system maintenance can occur, in Universal + // Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a + // 30-minute window selected at random from an 8-hour block of time for each AWS + // Region, occurring on a random day of the week. Valid days: Mon, Tue, Wed, Thu, + // Fri, Sat, Sun Constraints: Minimum 30-minute window. + PreferredMaintenanceWindow *string + + // A value that specifies the order in which an Amazon DocumentDB replica is + // promoted to the primary instance after a failure of the existing primary + // instance. Default: 1 Valid values: 0-15 + PromotionTier *int32 + + // The tags to be assigned to the instance. You can assign up to 10 tags to an + // instance. + Tags []*types.Tag } type CreateDBInstanceOutput struct { diff --git a/service/docdb/api_op_CreateDBSubnetGroup.go b/service/docdb/api_op_CreateDBSubnetGroup.go index ec57dcbe91e..1e5900ea3bf 100644 --- a/service/docdb/api_op_CreateDBSubnetGroup.go +++ b/service/docdb/api_op_CreateDBSubnetGroup.go @@ -64,9 +64,6 @@ type CreateDBSubnetGroupInput struct { // This member is required. DBSubnetGroupDescription *string - // The tags to be assigned to the subnet group. - Tags []*types.Tag - // The name for the subnet group. This value is stored as a lowercase string. // Constraints: Must contain no more than 255 letters, numbers, periods, // underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup @@ -78,6 +75,9 @@ type CreateDBSubnetGroupInput struct { // // This member is required. SubnetIds []*string + + // The tags to be assigned to the subnet group. + Tags []*types.Tag } type CreateDBSubnetGroupOutput struct { diff --git a/service/docdb/api_op_DeleteDBCluster.go b/service/docdb/api_op_DeleteDBCluster.go index 7154626697c..e10855296a2 100644 --- a/service/docdb/api_op_DeleteDBCluster.go +++ b/service/docdb/api_op_DeleteDBCluster.go @@ -60,12 +60,13 @@ func (c *Client) DeleteDBCluster(ctx context.Context, params *DeleteDBClusterInp // Represents the input to DeleteDBCluster (). type DeleteDBClusterInput struct { - // Determines whether a final cluster snapshot is created before the cluster is - // deleted. If true is specified, no cluster snapshot is created. If false is - // specified, a cluster snapshot is created before the DB cluster is deleted. If - // SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier - // parameter. Default: false - SkipFinalSnapshot *bool + // The cluster identifier for the cluster to be deleted. This parameter isn't case + // sensitive. Constraints: + // + // * Must match an existing DBClusterIdentifier. + // + // This member is required. + DBClusterIdentifier *string // The cluster snapshot identifier of the new cluster snapshot created when // SkipFinalSnapshot is set to false. Specifying this parameter and also setting @@ -81,13 +82,12 @@ type DeleteDBClusterInput struct { // hyphens. FinalDBSnapshotIdentifier *string - // The cluster identifier for the cluster to be deleted. This parameter isn't case - // sensitive. Constraints: - // - // * Must match an existing DBClusterIdentifier. - // - // This member is required. - DBClusterIdentifier *string + // Determines whether a final cluster snapshot is created before the cluster is + // deleted. If true is specified, no cluster snapshot is created. If false is + // specified, a cluster snapshot is created before the DB cluster is deleted. If + // SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier + // parameter. Default: false + SkipFinalSnapshot *bool } type DeleteDBClusterOutput struct { diff --git a/service/docdb/api_op_DescribeCertificates.go b/service/docdb/api_op_DescribeCertificates.go index 3e8a647a42b..e6cfd6da181 100644 --- a/service/docdb/api_op_DescribeCertificates.go +++ b/service/docdb/api_op_DescribeCertificates.go @@ -58,11 +58,6 @@ func (c *Client) DescribeCertificates(ctx context.Context, params *DescribeCerti type DescribeCertificatesInput struct { - // An optional pagination token provided by a previous DescribeCertificates - // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. - Marker *string - // The user-supplied certificate identifier. If this parameter is specified, // information for only the specified certificate is returned. If this parameter is // omitted, a list of up to MaxRecords certificates is returned. This parameter is @@ -75,6 +70,11 @@ type DescribeCertificatesInput struct { // This parameter is not currently supported. Filters []*types.Filter + // An optional pagination token provided by a previous DescribeCertificates + // request. If this parameter is specified, the response includes only records + // beyond the marker, up to the value specified by MaxRecords. + Marker *string + // The maximum number of records to include in the response. If more records exist // than the specified MaxRecords value, a pagination token called a marker is // included in the response so that the remaining results can be retrieved. diff --git a/service/docdb/api_op_DescribeDBClusterParameterGroups.go b/service/docdb/api_op_DescribeDBClusterParameterGroups.go index 183f6ba62b9..dd47e2a7b6b 100644 --- a/service/docdb/api_op_DescribeDBClusterParameterGroups.go +++ b/service/docdb/api_op_DescribeDBClusterParameterGroups.go @@ -67,14 +67,14 @@ type DescribeDBClusterParameterGroupsInput struct { // DBClusterParameterGroup. DBClusterParameterGroupName *string + // This parameter is not currently supported. + Filters []*types.Filter + // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the // value specified by MaxRecords. Marker *string - // This parameter is not currently supported. - Filters []*types.Filter - // The maximum number of records to include in the response. If more records exist // than the specified MaxRecords value, a pagination token (marker) is included in // the response so that the remaining results can be retrieved. Default: 100 @@ -85,14 +85,14 @@ type DescribeDBClusterParameterGroupsInput struct { // Represents the output of DBClusterParameterGroups (). type DescribeDBClusterParameterGroupsOutput struct { + // A list of cluster parameter groups. + DBClusterParameterGroups []*types.DBClusterParameterGroup + // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the // value specified by MaxRecords. Marker *string - // A list of cluster parameter groups. - DBClusterParameterGroups []*types.DBClusterParameterGroup - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/docdb/api_op_DescribeDBClusterParameters.go b/service/docdb/api_op_DescribeDBClusterParameters.go index 42abcff9033..4b77e590121 100644 --- a/service/docdb/api_op_DescribeDBClusterParameters.go +++ b/service/docdb/api_op_DescribeDBClusterParameters.go @@ -58,32 +58,32 @@ func (c *Client) DescribeDBClusterParameters(ctx context.Context, params *Descri // Represents the input to DescribeDBClusterParameters (). type DescribeDBClusterParametersInput struct { + // The name of a specific cluster parameter group to return parameter details for. + // Constraints: + // + // * If provided, must match the name of an existing + // DBClusterParameterGroup. + // + // This member is required. + DBClusterParameterGroupName *string + + // This parameter is not currently supported. + Filters []*types.Filter + // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the // value specified by MaxRecords. Marker *string - // A value that indicates to return only parameters for a specific source. - // Parameter sources can be engine, service, or customer. - Source *string - // The maximum number of records to include in the response. If more records exist // than the specified MaxRecords value, a pagination token (marker) is included in // the response so that the remaining results can be retrieved. Default: 100 // Constraints: Minimum 20, maximum 100. MaxRecords *int32 - // This parameter is not currently supported. - Filters []*types.Filter - - // The name of a specific cluster parameter group to return parameter details for. - // Constraints: - // - // * If provided, must match the name of an existing - // DBClusterParameterGroup. - // - // This member is required. - DBClusterParameterGroupName *string + // A value that indicates to return only parameters for a specific source. + // Parameter sources can be engine, service, or customer. + Source *string } // Represents the output of DBClusterParameterGroup (). diff --git a/service/docdb/api_op_DescribeDBClusterSnapshots.go b/service/docdb/api_op_DescribeDBClusterSnapshots.go index 01dc0a15af3..33a8e91fbce 100644 --- a/service/docdb/api_op_DescribeDBClusterSnapshots.go +++ b/service/docdb/api_op_DescribeDBClusterSnapshots.go @@ -78,11 +78,30 @@ type DescribeDBClusterSnapshotsInput struct { // snapshot, the SnapshotType parameter must also be specified. DBClusterSnapshotIdentifier *string + // This parameter is not currently supported. + Filters []*types.Filter + + // Set to true to include manual cluster snapshots that are public and can be + // copied or restored by any AWS account, and otherwise false. The default is + // false. + IncludePublic *bool + // Set to true to include shared manual cluster snapshots from other AWS accounts // that this AWS account has been given permission to copy or restore, and // otherwise false. The default is false. IncludeShared *bool + // An optional pagination token provided by a previous request. If this parameter + // is specified, the response includes only records beyond the marker, up to the + // value specified by MaxRecords. + Marker *string + + // The maximum number of records to include in the response. If more records exist + // than the specified MaxRecords value, a pagination token (marker) is included in + // the response so that the remaining results can be retrieved. Default: 100 + // Constraints: Minimum 20, maximum 100. + MaxRecords *int32 + // The type of cluster snapshots to be returned. You can specify one of the // following values: // @@ -108,38 +127,19 @@ type DescribeDBClusterSnapshotsInput struct { // parameter doesn't apply when SnapshotType is set to shared. The IncludeShared // parameter doesn't apply when SnapshotType is set to public. SnapshotType *string - - // Set to true to include manual cluster snapshots that are public and can be - // copied or restored by any AWS account, and otherwise false. The default is - // false. - IncludePublic *bool - - // This parameter is not currently supported. - Filters []*types.Filter - - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a pagination token (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 - // Constraints: Minimum 20, maximum 100. - MaxRecords *int32 - - // An optional pagination token provided by a previous request. If this parameter - // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. - Marker *string } // Represents the output of DescribeDBClusterSnapshots (). type DescribeDBClusterSnapshotsOutput struct { + // Provides a list of cluster snapshots. + DBClusterSnapshots []*types.DBClusterSnapshot + // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the // value specified by MaxRecords. Marker *string - // Provides a list of cluster snapshots. - DBClusterSnapshots []*types.DBClusterSnapshot - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/docdb/api_op_DescribeDBClusters.go b/service/docdb/api_op_DescribeDBClusters.go index f229c80c213..7f40bf83b69 100644 --- a/service/docdb/api_op_DescribeDBClusters.go +++ b/service/docdb/api_op_DescribeDBClusters.go @@ -63,11 +63,13 @@ func (c *Client) DescribeDBClusters(ctx context.Context, params *DescribeDBClust // Represents the input to DescribeDBClusters (). type DescribeDBClustersInput struct { - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a pagination token (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 - // Constraints: Minimum 20, maximum 100. - MaxRecords *int32 + // The user-provided cluster identifier. If this parameter is specified, + // information from only the specific cluster is returned. This parameter isn't + // case sensitive. Constraints: + // + // * If provided, must match an existing + // DBClusterIdentifier. + DBClusterIdentifier *string // A filter that specifies one or more clusters to describe. Supported filters: // @@ -77,18 +79,16 @@ type DescribeDBClustersInput struct { // by these ARNs. Filters []*types.Filter - // The user-provided cluster identifier. If this parameter is specified, - // information from only the specific cluster is returned. This parameter isn't - // case sensitive. Constraints: - // - // * If provided, must match an existing - // DBClusterIdentifier. - DBClusterIdentifier *string - // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the // value specified by MaxRecords. Marker *string + + // The maximum number of records to include in the response. If more records exist + // than the specified MaxRecords value, a pagination token (marker) is included in + // the response so that the remaining results can be retrieved. Default: 100 + // Constraints: Minimum 20, maximum 100. + MaxRecords *int32 } // Represents the output of DescribeDBClusters (). diff --git a/service/docdb/api_op_DescribeDBEngineVersions.go b/service/docdb/api_op_DescribeDBEngineVersions.go index 4c6383af321..4c53e58513e 100644 --- a/service/docdb/api_op_DescribeDBEngineVersions.go +++ b/service/docdb/api_op_DescribeDBEngineVersions.go @@ -58,58 +58,58 @@ func (c *Client) DescribeDBEngineVersions(ctx context.Context, params *DescribeD // Represents the input to DescribeDBEngineVersions (). type DescribeDBEngineVersionsInput struct { - // If this parameter is specified and the requested engine supports the TimeZone - // parameter for CreateDBInstance, the response includes a list of supported time - // zones for each engine version. - ListSupportedTimezones *bool - - // An optional pagination token provided by a previous request. If this parameter - // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. - Marker *string - - // The database engine to return. - Engine *string - - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a pagination token (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 - // Constraints: Minimum 20, maximum 100. - MaxRecords *int32 - // The name of a specific parameter group family to return details for. // Constraints: // // * If provided, must match an existing DBParameterGroupFamily. DBParameterGroupFamily *string - // This parameter is not currently supported. - Filters []*types.Filter + // Indicates that only the default version of the specified engine or engine and + // major version combination is returned. + DefaultOnly *bool + + // The database engine to return. + Engine *string // The database engine version to return. Example: 5.1.49 EngineVersion *string - // Indicates that only the default version of the specified engine or engine and - // major version combination is returned. - DefaultOnly *bool + // This parameter is not currently supported. + Filters []*types.Filter // If this parameter is specified and the requested engine supports the // CharacterSetName parameter for CreateDBInstance, the response includes a list of // supported character sets for each engine version. ListSupportedCharacterSets *bool -} -// Represents the output of DescribeDBEngineVersions (). -type DescribeDBEngineVersionsOutput struct { + // If this parameter is specified and the requested engine supports the TimeZone + // parameter for CreateDBInstance, the response includes a list of supported time + // zones for each engine version. + ListSupportedTimezones *bool // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the // value specified by MaxRecords. Marker *string + // The maximum number of records to include in the response. If more records exist + // than the specified MaxRecords value, a pagination token (marker) is included in + // the response so that the remaining results can be retrieved. Default: 100 + // Constraints: Minimum 20, maximum 100. + MaxRecords *int32 +} + +// Represents the output of DescribeDBEngineVersions (). +type DescribeDBEngineVersionsOutput struct { + // Detailed information about one or more engine versions. DBEngineVersions []*types.DBEngineVersion + // An optional pagination token provided by a previous request. If this parameter + // is specified, the response includes only records beyond the marker, up to the + // value specified by MaxRecords. + Marker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/docdb/api_op_DescribeDBInstances.go b/service/docdb/api_op_DescribeDBInstances.go index 5010d97e582..f99f556849b 100644 --- a/service/docdb/api_op_DescribeDBInstances.go +++ b/service/docdb/api_op_DescribeDBInstances.go @@ -59,6 +59,14 @@ func (c *Client) DescribeDBInstances(ctx context.Context, params *DescribeDBInst // Represents the input to DescribeDBInstances (). type DescribeDBInstancesInput struct { + // The user-provided instance identifier. If this parameter is specified, + // information from only the specific instance is returned. This parameter isn't + // case sensitive. Constraints: + // + // * If provided, must match the identifier of an + // existing DBInstance. + DBInstanceIdentifier *string + // A filter that specifies one or more instances to describe. Supported filters: // // @@ -72,37 +80,29 @@ type DescribeDBInstancesInput struct { // these ARNs. Filters []*types.Filter + // An optional pagination token provided by a previous request. If this parameter + // is specified, the response includes only records beyond the marker, up to the + // value specified by MaxRecords. + Marker *string + // The maximum number of records to include in the response. If more records exist // than the specified MaxRecords value, a pagination token (marker) is included in // the response so that the remaining results can be retrieved. Default: 100 // Constraints: Minimum 20, maximum 100. MaxRecords *int32 - - // The user-provided instance identifier. If this parameter is specified, - // information from only the specific instance is returned. This parameter isn't - // case sensitive. Constraints: - // - // * If provided, must match the identifier of an - // existing DBInstance. - DBInstanceIdentifier *string - - // An optional pagination token provided by a previous request. If this parameter - // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. - Marker *string } // Represents the output of DescribeDBInstances (). type DescribeDBInstancesOutput struct { + // Detailed information about one or more instances. + DBInstances []*types.DBInstance + // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the // value specified by MaxRecords. Marker *string - // Detailed information about one or more instances. - DBInstances []*types.DBInstance - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/docdb/api_op_DescribeDBSubnetGroups.go b/service/docdb/api_op_DescribeDBSubnetGroups.go index 3003309d7fe..ecc87b5d03b 100644 --- a/service/docdb/api_op_DescribeDBSubnetGroups.go +++ b/service/docdb/api_op_DescribeDBSubnetGroups.go @@ -60,35 +60,35 @@ func (c *Client) DescribeDBSubnetGroups(ctx context.Context, params *DescribeDBS // Represents the input to DescribeDBSubnetGroups (). type DescribeDBSubnetGroupsInput struct { + // The name of the subnet group to return details for. + DBSubnetGroupName *string + // This parameter is not currently supported. Filters []*types.Filter + // An optional pagination token provided by a previous request. If this parameter + // is specified, the response includes only records beyond the marker, up to the + // value specified by MaxRecords. + Marker *string + // The maximum number of records to include in the response. If more records exist // than the specified MaxRecords value, a pagination token (marker) is included in // the response so that the remaining results can be retrieved. Default: 100 // Constraints: Minimum 20, maximum 100. MaxRecords *int32 - - // The name of the subnet group to return details for. - DBSubnetGroupName *string - - // An optional pagination token provided by a previous request. If this parameter - // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. - Marker *string } // Represents the output of DescribeDBSubnetGroups (). type DescribeDBSubnetGroupsOutput struct { + // Detailed information about one or more subnet groups. + DBSubnetGroups []*types.DBSubnetGroup + // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the // value specified by MaxRecords. Marker *string - // Detailed information about one or more subnet groups. - DBSubnetGroups []*types.DBSubnetGroup - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/docdb/api_op_DescribeEngineDefaultClusterParameters.go b/service/docdb/api_op_DescribeEngineDefaultClusterParameters.go index e197889a8fd..acc0db6aed3 100644 --- a/service/docdb/api_op_DescribeEngineDefaultClusterParameters.go +++ b/service/docdb/api_op_DescribeEngineDefaultClusterParameters.go @@ -65,14 +65,14 @@ type DescribeEngineDefaultClusterParametersInput struct { // This member is required. DBParameterGroupFamily *string + // This parameter is not currently supported. + Filters []*types.Filter + // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the // value specified by MaxRecords. Marker *string - // This parameter is not currently supported. - Filters []*types.Filter - // The maximum number of records to include in the response. If more records exist // than the specified MaxRecords value, a pagination token (marker) is included in // the response so that the remaining results can be retrieved. Default: 100 diff --git a/service/docdb/api_op_DescribeEvents.go b/service/docdb/api_op_DescribeEvents.go index aa7914480c5..eb595d949b2 100644 --- a/service/docdb/api_op_DescribeEvents.go +++ b/service/docdb/api_op_DescribeEvents.go @@ -63,28 +63,30 @@ func (c *Client) DescribeEvents(ctx context.Context, params *DescribeEventsInput // Represents the input to DescribeEvents (). type DescribeEventsInput struct { + // The number of minutes to retrieve events for. Default: 60 + Duration *int32 + // The end of the time interval for which to retrieve events, specified in ISO 8601 // format. Example: 2009-07-08T18:00Z EndTime *time.Time - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a pagination token (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 - // Constraints: Minimum 20, maximum 100. - MaxRecords *int32 + // A list of event categories that trigger notifications for an event notification + // subscription. + EventCategories []*string + + // This parameter is not currently supported. + Filters []*types.Filter // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the // value specified by MaxRecords. Marker *string - // The event source to retrieve events for. If no value is specified, all events - // are returned. - SourceType types.SourceType - - // The beginning of the time interval to retrieve events for, specified in ISO 8601 - // format. Example: 2009-07-08T18:00Z - StartTime *time.Time + // The maximum number of records to include in the response. If more records exist + // than the specified MaxRecords value, a pagination token (marker) is included in + // the response so that the remaining results can be retrieved. Default: 100 + // Constraints: Minimum 20, maximum 100. + MaxRecords *int32 // The identifier of the event source for which events are returned. If not // specified, then all sources are included in the response. Constraints: @@ -108,28 +110,26 @@ type DescribeEventsInput struct { // * Cannot end with a hyphen or contain two consecutive hyphens. SourceIdentifier *string - // A list of event categories that trigger notifications for an event notification - // subscription. - EventCategories []*string - - // This parameter is not currently supported. - Filters []*types.Filter + // The event source to retrieve events for. If no value is specified, all events + // are returned. + SourceType types.SourceType - // The number of minutes to retrieve events for. Default: 60 - Duration *int32 + // The beginning of the time interval to retrieve events for, specified in ISO 8601 + // format. Example: 2009-07-08T18:00Z + StartTime *time.Time } // Represents the output of DescribeEvents (). type DescribeEventsOutput struct { + // Detailed information about one or more events. + Events []*types.Event + // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the // value specified by MaxRecords. Marker *string - // Detailed information about one or more events. - Events []*types.Event - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/docdb/api_op_DescribeOrderableDBInstanceOptions.go b/service/docdb/api_op_DescribeOrderableDBInstanceOptions.go index 0973d06e563..a69636bda69 100644 --- a/service/docdb/api_op_DescribeOrderableDBInstanceOptions.go +++ b/service/docdb/api_op_DescribeOrderableDBInstanceOptions.go @@ -58,30 +58,19 @@ func (c *Client) DescribeOrderableDBInstanceOptions(ctx context.Context, params // Represents the input to DescribeOrderableDBInstanceOptions (). type DescribeOrderableDBInstanceOptionsInput struct { - // An optional pagination token provided by a previous request. If this parameter - // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. - Marker *string - - // The virtual private cloud (VPC) filter value. Specify this parameter to show - // only the available VPC or non-VPC offerings. - Vpc *bool - // The name of the engine to retrieve instance options for. // // This member is required. Engine *string - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a pagination token (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 - // Constraints: Minimum 20, maximum 100. - MaxRecords *int32 - // The instance class filter value. Specify this parameter to show only the // available offerings that match the specified instance class. DBInstanceClass *string + // The engine version filter value. Specify this parameter to show only the + // available offerings that match the specified engine version. + EngineVersion *string + // This parameter is not currently supported. Filters []*types.Filter @@ -89,22 +78,33 @@ type DescribeOrderableDBInstanceOptionsInput struct { // available offerings that match the specified license model. LicenseModel *string - // The engine version filter value. Specify this parameter to show only the - // available offerings that match the specified engine version. - EngineVersion *string + // An optional pagination token provided by a previous request. If this parameter + // is specified, the response includes only records beyond the marker, up to the + // value specified by MaxRecords. + Marker *string + + // The maximum number of records to include in the response. If more records exist + // than the specified MaxRecords value, a pagination token (marker) is included in + // the response so that the remaining results can be retrieved. Default: 100 + // Constraints: Minimum 20, maximum 100. + MaxRecords *int32 + + // The virtual private cloud (VPC) filter value. Specify this parameter to show + // only the available VPC or non-VPC offerings. + Vpc *bool } // Represents the output of DescribeOrderableDBInstanceOptions (). type DescribeOrderableDBInstanceOptionsOutput struct { - // The options that are available for a particular orderable instance. - OrderableDBInstanceOptions []*types.OrderableDBInstanceOption - // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the // value specified by MaxRecords. Marker *string + // The options that are available for a particular orderable instance. + OrderableDBInstanceOptions []*types.OrderableDBInstanceOption + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/docdb/api_op_DescribePendingMaintenanceActions.go b/service/docdb/api_op_DescribePendingMaintenanceActions.go index 6e36e9c9cef..b4fa1ec8d89 100644 --- a/service/docdb/api_op_DescribePendingMaintenanceActions.go +++ b/service/docdb/api_op_DescribePendingMaintenanceActions.go @@ -59,20 +59,6 @@ func (c *Client) DescribePendingMaintenanceActions(ctx context.Context, params * // Represents the input to DescribePendingMaintenanceActions (). type DescribePendingMaintenanceActionsInput struct { - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a pagination token (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 - // Constraints: Minimum 20, maximum 100. - MaxRecords *int32 - - // An optional pagination token provided by a previous request. If this parameter - // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. - Marker *string - - // The ARN of a resource to return pending maintenance actions for. - ResourceIdentifier *string - // A filter that specifies one or more resources to return pending maintenance // actions for. Supported filters: // @@ -85,6 +71,20 @@ type DescribePendingMaintenanceActionsInput struct { // list includes only pending maintenance actions for the DB instances identified // by these ARNs. Filters []*types.Filter + + // An optional pagination token provided by a previous request. If this parameter + // is specified, the response includes only records beyond the marker, up to the + // value specified by MaxRecords. + Marker *string + + // The maximum number of records to include in the response. If more records exist + // than the specified MaxRecords value, a pagination token (marker) is included in + // the response so that the remaining results can be retrieved. Default: 100 + // Constraints: Minimum 20, maximum 100. + MaxRecords *int32 + + // The ARN of a resource to return pending maintenance actions for. + ResourceIdentifier *string } // Represents the output of DescribePendingMaintenanceActions (). diff --git a/service/docdb/api_op_ListTagsForResource.go b/service/docdb/api_op_ListTagsForResource.go index 519e9893e7d..89e00f97c53 100644 --- a/service/docdb/api_op_ListTagsForResource.go +++ b/service/docdb/api_op_ListTagsForResource.go @@ -58,14 +58,14 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes // Represents the input to ListTagsForResource (). type ListTagsForResourceInput struct { - // This parameter is not currently supported. - Filters []*types.Filter - // The Amazon DocumentDB resource with tags to be listed. This value is an Amazon // Resource Name (ARN). // // This member is required. ResourceName *string + + // This parameter is not currently supported. + Filters []*types.Filter } // Represents the output of ListTagsForResource (). diff --git a/service/docdb/api_op_ModifyDBCluster.go b/service/docdb/api_op_ModifyDBCluster.go index 2b9a28e17ab..5dccec20233 100644 --- a/service/docdb/api_op_ModifyDBCluster.go +++ b/service/docdb/api_op_ModifyDBCluster.go @@ -60,26 +60,6 @@ func (c *Client) ModifyDBCluster(ctx context.Context, params *ModifyDBClusterInp // Represents the input to ModifyDBCluster (). type ModifyDBClusterInput struct { - // The new cluster identifier for the cluster when renaming a cluster. This value - // is stored as a lowercase string. Constraints: - // - // * Must contain from 1 to 63 - // letters, numbers, or hyphens. - // - // * The first character must be a letter. - // - // - // * Cannot end with a hyphen or contain two consecutive hyphens. - // - // Example: - // my-cluster2 - NewDBClusterIdentifier *string - - // Specifies whether this cluster can be deleted. If DeletionProtection is enabled, - // the cluster cannot be deleted unless it is modified and DeletionProtection is - // disabled. DeletionProtection protects clusters from being accidentally deleted. - DeletionProtection *bool - // The cluster identifier for the cluster that is being modified. This parameter is // not case sensitive. Constraints: // @@ -89,16 +69,36 @@ type ModifyDBClusterInput struct { // This member is required. DBClusterIdentifier *string - // The weekly time range during which system maintenance can occur, in Universal - // Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a - // 30-minute window selected at random from an 8-hour block of time for each AWS - // Region, occurring on a random day of the week. Valid days: Mon, Tue, Wed, Thu, - // Fri, Sat, Sun Constraints: Minimum 30-minute window. - PreferredMaintenanceWindow *string + // A value that specifies whether the changes in this request and any pending + // changes are asynchronously applied as soon as possible, regardless of the + // PreferredMaintenanceWindow setting for the cluster. If this parameter is set to + // false, changes to the cluster are applied during the next maintenance window. + // The ApplyImmediately parameter affects only the NewDBClusterIdentifier and + // MasterUserPassword values. If you set this parameter value to false, the changes + // to the NewDBClusterIdentifier and MasterUserPassword values are applied during + // the next maintenance window. All other changes are applied immediately, + // regardless of the value of the ApplyImmediately parameter. Default: false + ApplyImmediately *bool - // The port number on which the cluster accepts connections. Constraints: Must be a - // value from 1150 to 65535. Default: The same port as the original cluster. - Port *int32 + // The number of days for which automated backups are retained. You must specify a + // minimum value of 1. Default: 1 Constraints: + // + // * Must be a value from 1 to 35. + BackupRetentionPeriod *int32 + + // The configuration setting for the log types to be enabled for export to Amazon + // CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and + // DisableLogTypes arrays determine which logs are exported (or not exported) to + // CloudWatch Logs. + CloudwatchLogsExportConfiguration *types.CloudwatchLogsExportConfiguration + + // The name of the cluster parameter group to use for the cluster. + DBClusterParameterGroupName *string + + // Specifies whether this cluster can be deleted. If DeletionProtection is enabled, + // the cluster cannot be deleted unless it is modified and DeletionProtection is + // disabled. DeletionProtection protects clusters from being accidentally deleted. + DeletionProtection *bool // The version number of the database engine to which you want to upgrade. Changing // this parameter results in an outage. The change is applied during the next @@ -110,9 +110,24 @@ type ModifyDBClusterInput struct { // "at" symbol (@). Constraints: Must contain from 8 to 100 characters. MasterUserPassword *string - // A list of virtual private cloud (VPC) security groups that the cluster will - // belong to. - VpcSecurityGroupIds []*string + // The new cluster identifier for the cluster when renaming a cluster. This value + // is stored as a lowercase string. Constraints: + // + // * Must contain from 1 to 63 + // letters, numbers, or hyphens. + // + // * The first character must be a letter. + // + // + // * Cannot end with a hyphen or contain two consecutive hyphens. + // + // Example: + // my-cluster2 + NewDBClusterIdentifier *string + + // The port number on which the cluster accepts connections. Constraints: Must be a + // value from 1150 to 65535. Default: The same port as the original cluster. + Port *int32 // The daily time range during which automated backups are created if automated // backups are enabled, using the BackupRetentionPeriod parameter. The default is a @@ -130,31 +145,16 @@ type ModifyDBClusterInput struct { // * Must be at least 30 minutes. PreferredBackupWindow *string - // The name of the cluster parameter group to use for the cluster. - DBClusterParameterGroupName *string - - // The number of days for which automated backups are retained. You must specify a - // minimum value of 1. Default: 1 Constraints: - // - // * Must be a value from 1 to 35. - BackupRetentionPeriod *int32 - - // A value that specifies whether the changes in this request and any pending - // changes are asynchronously applied as soon as possible, regardless of the - // PreferredMaintenanceWindow setting for the cluster. If this parameter is set to - // false, changes to the cluster are applied during the next maintenance window. - // The ApplyImmediately parameter affects only the NewDBClusterIdentifier and - // MasterUserPassword values. If you set this parameter value to false, the changes - // to the NewDBClusterIdentifier and MasterUserPassword values are applied during - // the next maintenance window. All other changes are applied immediately, - // regardless of the value of the ApplyImmediately parameter. Default: false - ApplyImmediately *bool + // The weekly time range during which system maintenance can occur, in Universal + // Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a + // 30-minute window selected at random from an 8-hour block of time for each AWS + // Region, occurring on a random day of the week. Valid days: Mon, Tue, Wed, Thu, + // Fri, Sat, Sun Constraints: Minimum 30-minute window. + PreferredMaintenanceWindow *string - // The configuration setting for the log types to be enabled for export to Amazon - // CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and - // DisableLogTypes arrays determine which logs are exported (or not exported) to - // CloudWatch Logs. - CloudwatchLogsExportConfiguration *types.CloudwatchLogsExportConfiguration + // A list of virtual private cloud (VPC) security groups that the cluster will + // belong to. + VpcSecurityGroupIds []*string } type ModifyDBClusterOutput struct { diff --git a/service/docdb/api_op_ModifyDBClusterParameterGroup.go b/service/docdb/api_op_ModifyDBClusterParameterGroup.go index 06ab21c9bd3..f22237c1237 100644 --- a/service/docdb/api_op_ModifyDBClusterParameterGroup.go +++ b/service/docdb/api_op_ModifyDBClusterParameterGroup.go @@ -70,15 +70,15 @@ func (c *Client) ModifyDBClusterParameterGroup(ctx context.Context, params *Modi // Represents the input to ModifyDBClusterParameterGroup (). type ModifyDBClusterParameterGroupInput struct { - // A list of parameters in the cluster parameter group to modify. + // The name of the cluster parameter group to modify. // // This member is required. - Parameters []*types.Parameter + DBClusterParameterGroupName *string - // The name of the cluster parameter group to modify. + // A list of parameters in the cluster parameter group to modify. // // This member is required. - DBClusterParameterGroupName *string + Parameters []*types.Parameter } // Contains the name of a cluster parameter group. diff --git a/service/docdb/api_op_ModifyDBClusterSnapshotAttribute.go b/service/docdb/api_op_ModifyDBClusterSnapshotAttribute.go index cdaffa6abcc..5fb505eb499 100644 --- a/service/docdb/api_op_ModifyDBClusterSnapshotAttribute.go +++ b/service/docdb/api_op_ModifyDBClusterSnapshotAttribute.go @@ -80,6 +80,14 @@ type ModifyDBClusterSnapshotAttributeInput struct { // This member is required. DBClusterSnapshotIdentifier *string + // A list of cluster snapshot attributes to add to the attribute specified by + // AttributeName. To authorize other AWS accounts to copy or restore a manual + // cluster snapshot, set this list to include one or more AWS account IDs. To make + // the manual cluster snapshot restorable by any AWS account, set it to all. Do not + // add the all value for any manual cluster snapshots that contain private + // information that you don't want to be available to all AWS accounts. + ValuesToAdd []*string + // A list of cluster snapshot attributes to remove from the attribute specified by // AttributeName. To remove authorization for other AWS accounts to copy or restore // a manual cluster snapshot, set this list to include one or more AWS account @@ -88,14 +96,6 @@ type ModifyDBClusterSnapshotAttributeInput struct { // account ID is explicitly added to the restore attribute can still copy or // restore a manual cluster snapshot. ValuesToRemove []*string - - // A list of cluster snapshot attributes to add to the attribute specified by - // AttributeName. To authorize other AWS accounts to copy or restore a manual - // cluster snapshot, set this list to include one or more AWS account IDs. To make - // the manual cluster snapshot restorable by any AWS account, set it to all. Do not - // add the all value for any manual cluster snapshots that contain private - // information that you don't want to be available to all AWS accounts. - ValuesToAdd []*string } type ModifyDBClusterSnapshotAttributeOutput struct { diff --git a/service/docdb/api_op_ModifyDBInstance.go b/service/docdb/api_op_ModifyDBInstance.go index 439c3f4084f..6465cb34050 100644 --- a/service/docdb/api_op_ModifyDBInstance.go +++ b/service/docdb/api_op_ModifyDBInstance.go @@ -60,22 +60,32 @@ func (c *Client) ModifyDBInstance(ctx context.Context, params *ModifyDBInstanceI // Represents the input to ModifyDBInstance (). type ModifyDBInstanceInput struct { - // The weekly time range (in UTC) during which system maintenance can occur, which - // might result in an outage. Changing this parameter doesn't result in an outage - // except in the following situation, and the change is asynchronously applied as - // soon as possible. If there are pending actions that cause a reboot, and the - // maintenance window is changed to include the current time, changing this - // parameter causes a reboot of the instance. If you are moving this window to the - // current time, there must be at least 30 minutes between the current time and end - // of the window to ensure that pending changes are applied. Default: Uses existing - // setting. Format: ddd:hh24:mi-ddd:hh24:mi Valid days: Mon, Tue, Wed, Thu, Fri, - // Sat, Sun Constraints: Must be at least 30 minutes. - PreferredMaintenanceWindow *string + // The instance identifier. This value is stored as a lowercase string. + // Constraints: + // + // * Must match the identifier of an existing DBInstance. + // + // This member is required. + DBInstanceIdentifier *string - // A value that specifies the order in which an Amazon DocumentDB replica is - // promoted to the primary instance after a failure of the existing primary - // instance. Default: 1 Valid values: 0-15 - PromotionTier *int32 + // Specifies whether the modifications in this request and any pending + // modifications are asynchronously applied as soon as possible, regardless of the + // PreferredMaintenanceWindow setting for the instance. If this parameter is set to + // false, changes to the instance are applied during the next maintenance window. + // Some parameter changes can cause an outage and are applied on the next reboot. + // Default: false + ApplyImmediately *bool + + // Indicates that minor version upgrades are applied automatically to the instance + // during the maintenance window. Changing this parameter doesn't result in an + // outage except in the following case, and the change is asynchronously applied as + // soon as possible. An outage results if this parameter is set to true during the + // maintenance window, and a newer minor version is available, and Amazon + // DocumentDB has enabled automatic patching for that engine version. + AutoMinorVersionUpgrade *bool + + // Indicates the certificate that needs to be associated with the instance. + CACertificateIdentifier *string // The new compute and memory capacity of the instance; for example, db.r5.large. // Not all instance classes are available in all AWS Regions. If you modify the @@ -101,32 +111,22 @@ type ModifyDBInstanceInput struct { // Example: mydbinstance NewDBInstanceIdentifier *string - // The instance identifier. This value is stored as a lowercase string. - // Constraints: - // - // * Must match the identifier of an existing DBInstance. - // - // This member is required. - DBInstanceIdentifier *string - - // Indicates that minor version upgrades are applied automatically to the instance - // during the maintenance window. Changing this parameter doesn't result in an - // outage except in the following case, and the change is asynchronously applied as - // soon as possible. An outage results if this parameter is set to true during the - // maintenance window, and a newer minor version is available, and Amazon - // DocumentDB has enabled automatic patching for that engine version. - AutoMinorVersionUpgrade *bool - - // Specifies whether the modifications in this request and any pending - // modifications are asynchronously applied as soon as possible, regardless of the - // PreferredMaintenanceWindow setting for the instance. If this parameter is set to - // false, changes to the instance are applied during the next maintenance window. - // Some parameter changes can cause an outage and are applied on the next reboot. - // Default: false - ApplyImmediately *bool + // The weekly time range (in UTC) during which system maintenance can occur, which + // might result in an outage. Changing this parameter doesn't result in an outage + // except in the following situation, and the change is asynchronously applied as + // soon as possible. If there are pending actions that cause a reboot, and the + // maintenance window is changed to include the current time, changing this + // parameter causes a reboot of the instance. If you are moving this window to the + // current time, there must be at least 30 minutes between the current time and end + // of the window to ensure that pending changes are applied. Default: Uses existing + // setting. Format: ddd:hh24:mi-ddd:hh24:mi Valid days: Mon, Tue, Wed, Thu, Fri, + // Sat, Sun Constraints: Must be at least 30 minutes. + PreferredMaintenanceWindow *string - // Indicates the certificate that needs to be associated with the instance. - CACertificateIdentifier *string + // A value that specifies the order in which an Amazon DocumentDB replica is + // promoted to the primary instance after a failure of the existing primary + // instance. Default: 1 Valid values: 0-15 + PromotionTier *int32 } type ModifyDBInstanceOutput struct { diff --git a/service/docdb/api_op_ModifyDBSubnetGroup.go b/service/docdb/api_op_ModifyDBSubnetGroup.go index c900bfd9cd3..91e6a783645 100644 --- a/service/docdb/api_op_ModifyDBSubnetGroup.go +++ b/service/docdb/api_op_ModifyDBSubnetGroup.go @@ -66,13 +66,13 @@ type ModifyDBSubnetGroupInput struct { // This member is required. DBSubnetGroupName *string - // The description for the subnet group. - DBSubnetGroupDescription *string - // The Amazon EC2 subnet IDs for the subnet group. // // This member is required. SubnetIds []*string + + // The description for the subnet group. + DBSubnetGroupDescription *string } type ModifyDBSubnetGroupOutput struct { diff --git a/service/docdb/api_op_ResetDBClusterParameterGroup.go b/service/docdb/api_op_ResetDBClusterParameterGroup.go index 884014c5004..fee92b0014f 100644 --- a/service/docdb/api_op_ResetDBClusterParameterGroup.go +++ b/service/docdb/api_op_ResetDBClusterParameterGroup.go @@ -64,11 +64,6 @@ func (c *Client) ResetDBClusterParameterGroup(ctx context.Context, params *Reset // Represents the input to ResetDBClusterParameterGroup (). type ResetDBClusterParameterGroupInput struct { - // A value that is set to true to reset all parameters in the cluster parameter - // group to their default values, and false otherwise. You can't use this parameter - // if there is a list of parameter names specified for the Parameters parameter. - ResetAllParameters *bool - // The name of the cluster parameter group to reset. // // This member is required. @@ -78,6 +73,11 @@ type ResetDBClusterParameterGroupInput struct { // values. You can't use this parameter if the ResetAllParameters parameter is set // to true. Parameters []*types.Parameter + + // A value that is set to true to reset all parameters in the cluster parameter + // group to their default values, and false otherwise. You can't use this parameter + // if there is a list of parameter names specified for the Parameters parameter. + ResetAllParameters *bool } // Contains the name of a cluster parameter group. diff --git a/service/docdb/api_op_RestoreDBClusterFromSnapshot.go b/service/docdb/api_op_RestoreDBClusterFromSnapshot.go index a01c513c012..5363545e7c6 100644 --- a/service/docdb/api_op_RestoreDBClusterFromSnapshot.go +++ b/service/docdb/api_op_RestoreDBClusterFromSnapshot.go @@ -63,23 +63,6 @@ func (c *Client) RestoreDBClusterFromSnapshot(ctx context.Context, params *Resto // Represents the input to RestoreDBClusterFromSnapshot (). type RestoreDBClusterFromSnapshotInput struct { - // The tags to be assigned to the restored cluster. - Tags []*types.Tag - - // A list of virtual private cloud (VPC) security groups that the new cluster will - // belong to. - VpcSecurityGroupIds []*string - - // The name of the subnet group to use for the new cluster. Constraints: If - // provided, must match the name of an existing DBSubnetGroup. Example: - // mySubnetgroup - DBSubnetGroupName *string - - // Specifies whether this cluster can be deleted. If DeletionProtection is enabled, - // the cluster cannot be deleted unless it is modified and DeletionProtection is - // disabled. DeletionProtection protects clusters from being accidentally deleted. - DeletionProtection *bool - // The name of the cluster to create from the snapshot or cluster snapshot. This // parameter isn't case sensitive. Constraints: // @@ -97,8 +80,11 @@ type RestoreDBClusterFromSnapshotInput struct { // This member is required. DBClusterIdentifier *string - // The version of the database engine to use for the new cluster. - EngineVersion *string + // The database engine to use for the new cluster. Default: The same as source. + // Constraint: Must be compatible with the engine of the source. + // + // This member is required. + Engine *string // The identifier for the snapshot or cluster snapshot to restore from. You can use // either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. @@ -110,9 +96,26 @@ type RestoreDBClusterFromSnapshotInput struct { // This member is required. SnapshotIdentifier *string - // The port number on which the new cluster accepts connections. Constraints: Must - // be a value from 1150 to 65535. Default: The same port as the original cluster. - Port *int32 + // Provides the list of Amazon EC2 Availability Zones that instances in the + // restored DB cluster can be created in. + AvailabilityZones []*string + + // The name of the subnet group to use for the new cluster. Constraints: If + // provided, must match the name of an existing DBSubnetGroup. Example: + // mySubnetgroup + DBSubnetGroupName *string + + // Specifies whether this cluster can be deleted. If DeletionProtection is enabled, + // the cluster cannot be deleted unless it is modified and DeletionProtection is + // disabled. DeletionProtection protects clusters from being accidentally deleted. + DeletionProtection *bool + + // A list of log types that must be enabled for exporting to Amazon CloudWatch + // Logs. + EnableCloudwatchLogsExports []*string + + // The version of the database engine to use for the new cluster. + EngineVersion *string // The AWS KMS key identifier to use when restoring an encrypted cluster from a DB // snapshot or cluster snapshot. The AWS KMS key identifier is the Amazon Resource @@ -131,19 +134,16 @@ type RestoreDBClusterFromSnapshotInput struct { // encrypted, then the restored DB cluster is not encrypted. KmsKeyId *string - // Provides the list of Amazon EC2 Availability Zones that instances in the - // restored DB cluster can be created in. - AvailabilityZones []*string + // The port number on which the new cluster accepts connections. Constraints: Must + // be a value from 1150 to 65535. Default: The same port as the original cluster. + Port *int32 - // The database engine to use for the new cluster. Default: The same as source. - // Constraint: Must be compatible with the engine of the source. - // - // This member is required. - Engine *string + // The tags to be assigned to the restored cluster. + Tags []*types.Tag - // A list of log types that must be enabled for exporting to Amazon CloudWatch - // Logs. - EnableCloudwatchLogsExports []*string + // A list of virtual private cloud (VPC) security groups that the new cluster will + // belong to. + VpcSecurityGroupIds []*string } type RestoreDBClusterFromSnapshotOutput struct { diff --git a/service/docdb/api_op_RestoreDBClusterToPointInTime.go b/service/docdb/api_op_RestoreDBClusterToPointInTime.go index 333a2698bfc..ceae945478f 100644 --- a/service/docdb/api_op_RestoreDBClusterToPointInTime.go +++ b/service/docdb/api_op_RestoreDBClusterToPointInTime.go @@ -63,8 +63,18 @@ func (c *Client) RestoreDBClusterToPointInTime(ctx context.Context, params *Rest // Represents the input to RestoreDBClusterToPointInTime (). type RestoreDBClusterToPointInTimeInput struct { - // The tags to be assigned to the restored cluster. - Tags []*types.Tag + // The name of the new cluster to be created. Constraints: + // + // * Must contain from + // 1 to 63 letters, numbers, or hyphens. + // + // * The first character must be a + // letter. + // + // * Cannot end with a hyphen or contain two consecutive hyphens. + // + // This member is required. + DBClusterIdentifier *string // The identifier of the source cluster from which to restore. Constraints: // @@ -74,37 +84,6 @@ type RestoreDBClusterToPointInTimeInput struct { // This member is required. SourceDBClusterIdentifier *string - // The port number on which the new cluster accepts connections. Constraints: Must - // be a value from 1150 to 65535. Default: The default port for the engine. - Port *int32 - - // The date and time to restore the cluster to. Valid values: A time in Universal - // Coordinated Time (UTC) format. Constraints: - // - // * Must be before the latest - // restorable time for the instance. - // - // * Must be specified if the - // UseLatestRestorableTime parameter is not provided. - // - // * Cannot be specified if - // the UseLatestRestorableTime parameter is true. - // - // * Cannot be specified if the - // RestoreType parameter is copy-on-write. - // - // Example: 2015-03-07T23:45:00Z - RestoreToTime *time.Time - - // A list of log types that must be enabled for exporting to Amazon CloudWatch - // Logs. - EnableCloudwatchLogsExports []*string - - // A value that is set to true to restore the cluster to the latest restorable - // backup time, and false otherwise. Default: false Constraints: Cannot be - // specified if the RestoreToTime parameter is provided. - UseLatestRestorableTime *bool - // The subnet group name to use for the new cluster. Constraints: If provided, must // match the name of an existing DBSubnetGroup. Example: mySubnetgroup DBSubnetGroupName *string @@ -114,18 +93,9 @@ type RestoreDBClusterToPointInTimeInput struct { // disabled. DeletionProtection protects clusters from being accidentally deleted. DeletionProtection *bool - // The name of the new cluster to be created. Constraints: - // - // * Must contain from - // 1 to 63 letters, numbers, or hyphens. - // - // * The first character must be a - // letter. - // - // * Cannot end with a hyphen or contain two consecutive hyphens. - // - // This member is required. - DBClusterIdentifier *string + // A list of log types that must be enabled for exporting to Amazon CloudWatch + // Logs. + EnableCloudwatchLogsExports []*string // The AWS KMS key identifier to use when restoring an encrypted cluster from an // encrypted cluster. The AWS KMS key identifier is the Amazon Resource Name (ARN) @@ -149,6 +119,36 @@ type RestoreDBClusterToPointInTimeInput struct { // not encrypted, then the restore request is rejected. KmsKeyId *string + // The port number on which the new cluster accepts connections. Constraints: Must + // be a value from 1150 to 65535. Default: The default port for the engine. + Port *int32 + + // The date and time to restore the cluster to. Valid values: A time in Universal + // Coordinated Time (UTC) format. Constraints: + // + // * Must be before the latest + // restorable time for the instance. + // + // * Must be specified if the + // UseLatestRestorableTime parameter is not provided. + // + // * Cannot be specified if + // the UseLatestRestorableTime parameter is true. + // + // * Cannot be specified if the + // RestoreType parameter is copy-on-write. + // + // Example: 2015-03-07T23:45:00Z + RestoreToTime *time.Time + + // The tags to be assigned to the restored cluster. + Tags []*types.Tag + + // A value that is set to true to restore the cluster to the latest restorable + // backup time, and false otherwise. Default: false Constraints: Cannot be + // specified if the RestoreToTime parameter is provided. + UseLatestRestorableTime *bool + // A list of VPC security groups that the new cluster belongs to. VpcSecurityGroupIds []*string } diff --git a/service/docdb/go.mod b/service/docdb/go.mod index e48655729a9..4746dd82e7a 100644 --- a/service/docdb/go.mod +++ b/service/docdb/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/docdb go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/docdb/types/types.go b/service/docdb/types/types.go index 353b058daeb..63f5b952541 100644 --- a/service/docdb/types/types.go +++ b/service/docdb/types/types.go @@ -16,26 +16,26 @@ type AvailabilityZone struct { // A certificate authority (CA) certificate for an AWS account. type Certificate struct { + // The Amazon Resource Name (ARN) for the certificate. Example: + // arn:aws:rds:us-east-1::cert:rds-ca-2019 + CertificateArn *string + // The unique key that identifies a certificate. Example: rds-ca-2019 CertificateIdentifier *string + // The type of the certificate. Example: CA + CertificateType *string + // The thumbprint of the certificate. Thumbprint *string - // The date-time after which the certificate is no longer valid. Example: - // 2024-07-31T17:57:09Z - ValidTill *time.Time - // The starting date-time from which the certificate is valid. Example: // 2019-07-31T17:57:09Z ValidFrom *time.Time - // The type of the certificate. Example: CA - CertificateType *string - - // The Amazon Resource Name (ARN) for the certificate. Example: - // arn:aws:rds:us-east-1::cert:rds-ca-2019 - CertificateArn *string + // The date-time after which the certificate is no longer valid. Example: + // 2024-07-31T17:57:09Z + ValidTill *time.Time } // The configuration setting for the log types to be enabled for export to Amazon @@ -45,62 +45,42 @@ type Certificate struct { // being used. type CloudwatchLogsExportConfiguration struct { - // The list of log types to enable. - EnableLogTypes []*string - // The list of log types to disable. DisableLogTypes []*string + + // The list of log types to enable. + EnableLogTypes []*string } // Detailed information about a cluster. type DBCluster struct { - // Specifies the latest time to which a database can be restored with point-in-time - // restore. - LatestRestorableTime *time.Time - - // The reader endpoint for the cluster. The reader endpoint for a cluster load - // balances connections across the Amazon DocumentDB replicas that are available in - // a cluster. As clients request new connections to the reader endpoint, Amazon - // DocumentDB distributes the connection requests among the Amazon DocumentDB - // replicas in the cluster. This functionality can help balance your read workload - // across multiple Amazon DocumentDB replicas in your cluster. If a failover - // occurs, and the Amazon DocumentDB replica that you are connected to is promoted - // to be the primary instance, your connection is dropped. To continue sending your - // read workload to other Amazon DocumentDB replicas in the cluster, you can then - // reconnect to the reader endpoint. - ReaderEndpoint *string - - // Provides the name of the database engine to be used for this cluster. - Engine *string - - // Specifies whether this cluster can be deleted. If DeletionProtection is enabled, - // the cluster cannot be deleted unless it is modified and DeletionProtection is - // disabled. DeletionProtection protects clusters from being accidentally deleted. - DeletionProtection *bool - - // Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. - HostedZoneId *string + // Provides a list of the AWS Identity and Access Management (IAM) roles that are + // associated with the cluster. IAM roles that are associated with a cluster grant + // permission for the cluster to access other AWS services on your behalf. + AssociatedRoles []*DBClusterRole // Provides the list of Amazon EC2 Availability Zones that instances in the cluster // can be created in. AvailabilityZones []*string - // If StorageEncrypted is true, the AWS KMS key identifier for the encrypted - // cluster. - KmsKeyId *string - - // Specifies the weekly time range during which system maintenance can occur, in - // Universal Coordinated Time (UTC). - PreferredMaintenanceWindow *string + // Specifies the number of days for which automatic snapshots are retained. + BackupRetentionPeriod *int32 - // Specifies the daily time range during which automated backups are created if - // automated backups are enabled, as determined by the BackupRetentionPeriod. - PreferredBackupWindow *string + // Specifies the time when the cluster was created, in Universal Coordinated Time + // (UTC). + ClusterCreateTime *time.Time // The Amazon Resource Name (ARN) for the cluster. DBClusterArn *string + // Contains a user-supplied cluster identifier. This identifier is the unique key + // that identifies a cluster. + DBClusterIdentifier *string + + // Provides the list of instances that make up the cluster. + DBClusterMembers []*DBClusterMember + // Specifies the name of the cluster parameter group for the cluster. DBClusterParameterGroup *string @@ -108,90 +88,113 @@ type DBCluster struct { // including the name, description, and subnets in the subnet group. DBSubnetGroup *string + // The AWS Region-unique, immutable identifier for the cluster. This identifier is + // found in AWS CloudTrail log entries whenever the AWS KMS key for the cluster is + // accessed. + DbClusterResourceId *string + + // Specifies whether this cluster can be deleted. If DeletionProtection is enabled, + // the cluster cannot be deleted unless it is modified and DeletionProtection is + // disabled. DeletionProtection protects clusters from being accidentally deleted. + DeletionProtection *bool + + // The earliest time to which a database can be restored with point-in-time + // restore. + EarliestRestorableTime *time.Time + // A list of log types that this cluster is configured to export to Amazon // CloudWatch Logs. EnabledCloudwatchLogsExports []*string - // Provides a list of the AWS Identity and Access Management (IAM) roles that are - // associated with the cluster. IAM roles that are associated with a cluster grant - // permission for the cluster to access other AWS services on your behalf. - AssociatedRoles []*DBClusterRole + // Specifies the connection endpoint for the primary instance of the cluster. + Endpoint *string - // Specifies whether the cluster has instances in multiple Availability Zones. - MultiAZ *bool + // Provides the name of the database engine to be used for this cluster. + Engine *string - // Provides a list of virtual private cloud (VPC) security groups that the cluster - // belongs to. - VpcSecurityGroups []*VpcSecurityGroupMembership + // Indicates the database engine version. + EngineVersion *string - // Specifies whether the cluster is encrypted. - StorageEncrypted *bool + // Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. + HostedZoneId *string - // Specifies the connection endpoint for the primary instance of the cluster. - Endpoint *string + // If StorageEncrypted is true, the AWS KMS key identifier for the encrypted + // cluster. + KmsKeyId *string + + // Specifies the latest time to which a database can be restored with point-in-time + // restore. + LatestRestorableTime *time.Time // Contains the master user name for the cluster. MasterUsername *string - // Specifies the number of days for which automatic snapshots are retained. - BackupRetentionPeriod *int32 + // Specifies whether the cluster has instances in multiple Availability Zones. + MultiAZ *bool // Specifies the progress of the operation as a percentage. PercentProgress *string - // Contains a user-supplied cluster identifier. This identifier is the unique key - // that identifies a cluster. - DBClusterIdentifier *string + // Specifies the port that the database engine is listening on. + Port *int32 - // The AWS Region-unique, immutable identifier for the cluster. This identifier is - // found in AWS CloudTrail log entries whenever the AWS KMS key for the cluster is - // accessed. - DbClusterResourceId *string + // Specifies the daily time range during which automated backups are created if + // automated backups are enabled, as determined by the BackupRetentionPeriod. + PreferredBackupWindow *string - // Provides the list of instances that make up the cluster. - DBClusterMembers []*DBClusterMember + // Specifies the weekly time range during which system maintenance can occur, in + // Universal Coordinated Time (UTC). + PreferredMaintenanceWindow *string + + // The reader endpoint for the cluster. The reader endpoint for a cluster load + // balances connections across the Amazon DocumentDB replicas that are available in + // a cluster. As clients request new connections to the reader endpoint, Amazon + // DocumentDB distributes the connection requests among the Amazon DocumentDB + // replicas in the cluster. This functionality can help balance your read workload + // across multiple Amazon DocumentDB replicas in your cluster. If a failover + // occurs, and the Amazon DocumentDB replica that you are connected to is promoted + // to be the primary instance, your connection is dropped. To continue sending your + // read workload to other Amazon DocumentDB replicas in the cluster, you can then + // reconnect to the reader endpoint. + ReaderEndpoint *string // Specifies the current state of this cluster. Status *string - // The earliest time to which a database can be restored with point-in-time - // restore. - EarliestRestorableTime *time.Time - - // Indicates the database engine version. - EngineVersion *string - - // Specifies the time when the cluster was created, in Universal Coordinated Time - // (UTC). - ClusterCreateTime *time.Time + // Specifies whether the cluster is encrypted. + StorageEncrypted *bool - // Specifies the port that the database engine is listening on. - Port *int32 + // Provides a list of virtual private cloud (VPC) security groups that the cluster + // belongs to. + VpcSecurityGroups []*VpcSecurityGroupMembership } // Contains information about an instance that is part of a cluster. type DBClusterMember struct { - // A value that is true if the cluster member is the primary instance for the - // cluster and false otherwise. - IsClusterWriter *bool + // Specifies the status of the cluster parameter group for this member of the DB + // cluster. + DBClusterParameterGroupStatus *string // Specifies the instance identifier for this member of the cluster. DBInstanceIdentifier *string + // A value that is true if the cluster member is the primary instance for the + // cluster and false otherwise. + IsClusterWriter *bool + // A value that specifies the order in which an Amazon DocumentDB replica is // promoted to the primary instance after a failure of the existing primary // instance. PromotionTier *int32 - - // Specifies the status of the cluster parameter group for this member of the DB - // cluster. - DBClusterParameterGroupStatus *string } // Detailed information about a cluster parameter group. type DBClusterParameterGroup struct { + // The Amazon Resource Name (ARN) for the cluster parameter group. + DBClusterParameterGroupArn *string + // Provides the name of the cluster parameter group. DBClusterParameterGroupName *string @@ -199,9 +202,6 @@ type DBClusterParameterGroup struct { // group is compatible with. DBParameterGroupFamily *string - // The Amazon Resource Name (ARN) for the cluster parameter group. - DBClusterParameterGroupArn *string - // Provides the customer-specified description for this cluster parameter group. Description *string } @@ -233,43 +233,36 @@ type DBClusterRole struct { // Detailed information about a cluster snapshot. type DBClusterSnapshot struct { + // Provides the list of Amazon EC2 Availability Zones that instances in the cluster + // snapshot can be restored in. + AvailabilityZones []*string + // Specifies the time when the cluster was created, in Universal Coordinated Time // (UTC). ClusterCreateTime *time.Time + // Specifies the cluster identifier of the cluster that this cluster snapshot was + // created from. + DBClusterIdentifier *string + + // The Amazon Resource Name (ARN) for the cluster snapshot. + DBClusterSnapshotArn *string + + // Specifies the identifier for the cluster snapshot. + DBClusterSnapshotIdentifier *string + // Specifies the name of the database engine. Engine *string - // Provides the list of Amazon EC2 Availability Zones that instances in the cluster - // snapshot can be restored in. - AvailabilityZones []*string - // Provides the version of the database engine for this cluster snapshot. EngineVersion *string - // Provides the master user name for the cluster snapshot. - MasterUsername *string - // If StorageEncrypted is true, the AWS KMS key identifier for the encrypted // cluster snapshot. KmsKeyId *string - // Specifies the identifier for the cluster snapshot. - DBClusterSnapshotIdentifier *string - - // Provides the virtual private cloud (VPC) ID that is associated with the cluster - // snapshot. - VpcId *string - - // Specifies whether the cluster snapshot is encrypted. - StorageEncrypted *bool - - // Specifies the cluster identifier of the cluster that this cluster snapshot was - // created from. - DBClusterIdentifier *string - - // Provides the time when the snapshot was taken, in UTC. - SnapshotCreateTime *time.Time + // Provides the master user name for the cluster snapshot. + MasterUsername *string // Specifies the percentage of the estimated data that has been transferred. PercentProgress *int32 @@ -278,8 +271,11 @@ type DBClusterSnapshot struct { // snapshot. Port *int32 - // The Amazon Resource Name (ARN) for the cluster snapshot. - DBClusterSnapshotArn *string + // Provides the time when the snapshot was taken, in UTC. + SnapshotCreateTime *time.Time + + // Provides the type of the cluster snapshot. + SnapshotType *string // If the cluster snapshot was copied from a source cluster snapshot, the ARN for // the source cluster snapshot; otherwise, a null value. @@ -288,8 +284,12 @@ type DBClusterSnapshot struct { // Specifies the status of this cluster snapshot. Status *string - // Provides the type of the cluster snapshot. - SnapshotType *string + // Specifies whether the cluster snapshot is encrypted. + StorageEncrypted *bool + + // Provides the virtual private cloud (VPC) ID that is associated with the cluster + // snapshot. + VpcId *string } // Contains the name and values of a manual cluster snapshot attribute. Manual @@ -324,140 +324,133 @@ type DBClusterSnapshotAttributesResult struct { // Detailed information about an engine version. type DBEngineVersion struct { - // A value that indicates whether the engine version supports exporting the log - // types specified by ExportableLogTypes to CloudWatch Logs. - SupportsLogExportsToCloudwatchLogs *bool + // The description of the database engine. + DBEngineDescription *string + + // The description of the database engine version. + DBEngineVersionDescription *string + + // The name of the parameter group family for the database engine. + DBParameterGroupFamily *string // The name of the database engine. Engine *string - // A list of engine versions that this database engine version can be upgraded to. - ValidUpgradeTarget []*UpgradeTarget - // The version number of the database engine. EngineVersion *string - // The name of the parameter group family for the database engine. - DBParameterGroupFamily *string - // The types of logs that the database engine has available for export to Amazon // CloudWatch Logs. ExportableLogTypes []*string - // The description of the database engine version. - DBEngineVersionDescription *string + // A value that indicates whether the engine version supports exporting the log + // types specified by ExportableLogTypes to CloudWatch Logs. + SupportsLogExportsToCloudwatchLogs *bool - // The description of the database engine. - DBEngineDescription *string + // A list of engine versions that this database engine version can be upgraded to. + ValidUpgradeTarget []*UpgradeTarget } // Detailed information about an instance. type DBInstance struct { - // Specifies the weekly time range during which system maintenance can occur, in - // Universal Coordinated Time (UTC). - PreferredMaintenanceWindow *string + // Indicates that minor version patches are applied automatically. + AutoMinorVersionUpgrade *bool // Specifies the name of the Availability Zone that the instance is located in. AvailabilityZone *string - // Not supported. Amazon DocumentDB does not currently support public endpoints. - // The value of PubliclyAccessible is always false. - PubliclyAccessible *bool - - // Specifies information on the subnet group that is associated with the instance, - // including the name, description, and subnets in the subnet group. - DBSubnetGroup *DBSubnetGroup + // Specifies the number of days for which automatic snapshots are retained. + BackupRetentionPeriod *int32 // The identifier of the CA certificate for this DB instance. CACertificateIdentifier *string - // Specifies the connection endpoint. - Endpoint *Endpoint - - // If StorageEncrypted is true, the AWS KMS key identifier for the encrypted - // instance. - KmsKeyId *string + // Contains the name of the cluster that the instance is a member of if the + // instance is a member of a cluster. + DBClusterIdentifier *string - // Specifies that changes to the instance are pending. This element is included - // only when changes are pending. Specific changes are identified by subelements. - PendingModifiedValues *PendingModifiedValues + // The Amazon Resource Name (ARN) for the instance. + DBInstanceArn *string // Contains the name of the compute and memory capacity class of the instance. DBInstanceClass *string - // Specifies the latest time to which a database can be restored with point-in-time - // restore. - LatestRestorableTime *time.Time - - // Indicates that minor version patches are applied automatically. - AutoMinorVersionUpgrade *bool + // Contains a user-provided database identifier. This identifier is the unique key + // that identifies an instance. + DBInstanceIdentifier *string - // Provides a list of VPC security group elements that the instance belongs to. - VpcSecurityGroups []*VpcSecurityGroupMembership + // Specifies the current state of this database. + DBInstanceStatus *string - // Provides the name of the database engine to be used for this instance. - Engine *string + // Specifies information on the subnet group that is associated with the instance, + // including the name, description, and subnets in the subnet group. + DBSubnetGroup *DBSubnetGroup + + // The AWS Region-unique, immutable identifier for the instance. This identifier is + // found in AWS CloudTrail log entries whenever the AWS KMS key for the instance is + // accessed. + DbiResourceId *string // A list of log types that this instance is configured to export to Amazon // CloudWatch Logs. EnabledCloudwatchLogsExports []*string - // The status of a read replica. If the instance is not a read replica, this is - // blank. - StatusInfos []*DBInstanceStatusInfo + // Specifies the connection endpoint. + Endpoint *Endpoint - // The Amazon Resource Name (ARN) for the instance. - DBInstanceArn *string + // Provides the name of the database engine to be used for this instance. + Engine *string - // Specifies the current state of this database. - DBInstanceStatus *string + // Indicates the database engine version. + EngineVersion *string - // Specifies the number of days for which automatic snapshots are retained. - BackupRetentionPeriod *int32 + // Provides the date and time that the instance was created. + InstanceCreateTime *time.Time - // Contains the name of the cluster that the instance is a member of if the - // instance is a member of a cluster. - DBClusterIdentifier *string + // If StorageEncrypted is true, the AWS KMS key identifier for the encrypted + // instance. + KmsKeyId *string - // The AWS Region-unique, immutable identifier for the instance. This identifier is - // found in AWS CloudTrail log entries whenever the AWS KMS key for the instance is - // accessed. - DbiResourceId *string + // Specifies the latest time to which a database can be restored with point-in-time + // restore. + LatestRestorableTime *time.Time + + // Specifies that changes to the instance are pending. This element is included + // only when changes are pending. Specific changes are identified by subelements. + PendingModifiedValues *PendingModifiedValues // Specifies the daily time range during which automated backups are created if // automated backups are enabled, as determined by the BackupRetentionPeriod. PreferredBackupWindow *string - // Specifies whether or not the instance is encrypted. - StorageEncrypted *bool - - // Provides the date and time that the instance was created. - InstanceCreateTime *time.Time + // Specifies the weekly time range during which system maintenance can occur, in + // Universal Coordinated Time (UTC). + PreferredMaintenanceWindow *string // A value that specifies the order in which an Amazon DocumentDB replica is // promoted to the primary instance after a failure of the existing primary // instance. PromotionTier *int32 - // Contains a user-provided database identifier. This identifier is the unique key - // that identifies an instance. - DBInstanceIdentifier *string + // Not supported. Amazon DocumentDB does not currently support public endpoints. + // The value of PubliclyAccessible is always false. + PubliclyAccessible *bool - // Indicates the database engine version. - EngineVersion *string + // The status of a read replica. If the instance is not a read replica, this is + // blank. + StatusInfos []*DBInstanceStatusInfo + + // Specifies whether or not the instance is encrypted. + StorageEncrypted *bool + + // Provides a list of VPC security group elements that the instance belongs to. + VpcSecurityGroups []*VpcSecurityGroupMembership } // Provides a list of status information for an instance. type DBInstanceStatusInfo struct { - // Status of the instance. For a StatusType of read replica, the values can be - // replicating, error, stopped, or terminated. - Status *string - - // This value is currently "read replication." - StatusType *string - // Details of the error if there is an error for the instance. If the instance is // not in an error state, this value is blank. Message *string @@ -465,57 +458,64 @@ type DBInstanceStatusInfo struct { // A Boolean value that is true if the instance is operating normally, or false if // the instance is in an error state. Normal *bool + + // Status of the instance. For a StatusType of read replica, the values can be + // replicating, error, stopped, or terminated. + Status *string + + // This value is currently "read replication." + StatusType *string } // Detailed information about a subnet group. type DBSubnetGroup struct { - // Provides the virtual private cloud (VPC) ID of the subnet group. - VpcId *string - // The Amazon Resource Name (ARN) for the DB subnet group. DBSubnetGroupArn *string // Provides the description of the subnet group. DBSubnetGroupDescription *string - // Provides the status of the subnet group. - SubnetGroupStatus *string - // The name of the subnet group. DBSubnetGroupName *string + // Provides the status of the subnet group. + SubnetGroupStatus *string + // Detailed information about one or more subnets within a subnet group. Subnets []*Subnet + + // Provides the virtual private cloud (VPC) ID of the subnet group. + VpcId *string } // Network information for accessing a cluster or instance. Client programs must // specify a valid endpoint to access these Amazon DocumentDB resources. type Endpoint struct { - // Specifies the port that the database engine is listening on. - Port *int32 + // Specifies the DNS address of the instance. + Address *string // Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. HostedZoneId *string - // Specifies the DNS address of the instance. - Address *string + // Specifies the port that the database engine is listening on. + Port *int32 } // Contains the result of a successful invocation of the // DescribeEngineDefaultClusterParameters operation. type EngineDefaults struct { + // The name of the cluster parameter group family to return the engine parameter + // information for. + DBParameterGroupFamily *string + // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the // value specified by MaxRecords. Marker *string - // The name of the cluster parameter group family to return the engine parameter - // information for. - DBParameterGroupFamily *string - // The parameters of a particular cluster parameter group family. Parameters []*Parameter } @@ -526,20 +526,20 @@ type Event struct { // Specifies the date and time of the event. Date *time.Time - // Provides the identifier for the source of the event. - SourceIdentifier *string - - // Specifies the source type for this event. - SourceType SourceType + // Specifies the category for the event. + EventCategories []*string // Provides the text of this event. Message *string - // Specifies the category for the event. - EventCategories []*string - // The Amazon Resource Name (ARN) for the event. SourceArn *string + + // Provides the identifier for the source of the event. + SourceIdentifier *string + + // Specifies the source type for this event. + SourceType SourceType } // An event source type, accompanied by one or more event category names. @@ -580,50 +580,50 @@ type OrderableDBInstanceOption struct { // The engine type of an instance. Engine *string - // Indicates whether an instance is in a virtual private cloud (VPC). - Vpc *bool - // The engine version of an instance. EngineVersion *string // The license model for an instance. LicenseModel *string + + // Indicates whether an instance is in a virtual private cloud (VPC). + Vpc *bool } // Detailed information about an individual parameter. type Parameter struct { - // Provides a description of the parameter. - Description *string + // Specifies the valid range of values for the parameter. + AllowedValues *string + + // Indicates when to apply parameter updates. + ApplyMethod ApplyMethod // Specifies the engine-specific parameters type. ApplyType *string + // Specifies the valid data type for the parameter. + DataType *string + + // Provides a description of the parameter. + Description *string + // Indicates whether (true) or not (false) the parameter can be modified. Some // parameters have security or operational implications that prevent them from // being changed. IsModifiable *bool - // Indicates when to apply parameter updates. - ApplyMethod ApplyMethod - - // Specifies the name of the parameter. - ParameterName *string - - // Indicates the source of the parameter value. - Source *string - - // Specifies the valid data type for the parameter. - DataType *string - // The earliest engine version to which the parameter can apply. MinimumEngineVersion *string - // Specifies the valid range of values for the parameter. - AllowedValues *string + // Specifies the name of the parameter. + ParameterName *string // Specifies the value of the parameter. ParameterValue *string + + // Indicates the source of the parameter value. + Source *string } // A list of the log types whose configuration is still pending. These log types @@ -642,16 +642,6 @@ type PendingCloudwatchLogsExports struct { // Provides information about a pending maintenance action for a resource. type PendingMaintenanceAction struct { - // Indicates the type of opt-in request that has been received for the resource. - OptInStatus *string - - // The effective date when the pending maintenance action is applied to the - // resource. - CurrentApplyDate *time.Time - - // A description providing more detail about the maintenance action. - Description *string - // The type of pending maintenance action that is available for the resource. Action *string @@ -661,26 +651,48 @@ type PendingMaintenanceAction struct { // ignored. AutoAppliedAfterDate *time.Time + // The effective date when the pending maintenance action is applied to the + // resource. + CurrentApplyDate *time.Time + + // A description providing more detail about the maintenance action. + Description *string + // The date when the maintenance action is automatically applied. The maintenance // action is applied to the resource on this date regardless of the maintenance // window for the resource. If this date is specified, any immediate opt-in // requests are ignored. ForcedApplyDate *time.Time + + // Indicates the type of opt-in request that has been received for the resource. + OptInStatus *string } // One or more modified settings for an instance. These modified settings have been // requested, but haven't been applied yet. type PendingModifiedValues struct { - // Specifies the storage type to be associated with the instance. - StorageType *string + // Contains the new AllocatedStorage size for then instance that will be applied or + // is currently being applied. + AllocatedStorage *int32 - // The license model for the instance. Valid values: license-included, - // bring-your-own-license, general-public-license - LicenseModel *string + // Specifies the pending number of days for which automated backups are retained. + BackupRetentionPeriod *int32 - // Specifies the pending port for the instance. - Port *int32 + // Specifies the identifier of the certificate authority (CA) certificate for the + // DB instance. + CACertificateIdentifier *string + + // Contains the new DBInstanceClass for the instance that will be applied or is + // currently being applied. + DBInstanceClass *string + + // Contains the new DBInstanceIdentifier for the instance that will be applied or + // is currently being applied. + DBInstanceIdentifier *string + + // The new subnet group for the instance. + DBSubnetGroupName *string // Indicates the database engine version. EngineVersion *string @@ -689,38 +701,26 @@ type PendingModifiedValues struct { // or is currently being applied. Iops *int32 - // Contains the new AllocatedStorage size for then instance that will be applied or - // is currently being applied. - AllocatedStorage *int32 - - // The new subnet group for the instance. - DBSubnetGroupName *string + // The license model for the instance. Valid values: license-included, + // bring-your-own-license, general-public-license + LicenseModel *string // Contains the pending or currently in-progress change of the master credentials // for the instance. MasterUserPassword *string - // Specifies the identifier of the certificate authority (CA) certificate for the - // DB instance. - CACertificateIdentifier *string - - // Contains the new DBInstanceIdentifier for the instance that will be applied or - // is currently being applied. - DBInstanceIdentifier *string + // Indicates that the Single-AZ instance is to change to a Multi-AZ deployment. + MultiAZ *bool // A list of the log types whose configuration is still pending. These log types // are in the process of being activated or deactivated. PendingCloudwatchLogsExports *PendingCloudwatchLogsExports - // Contains the new DBInstanceClass for the instance that will be applied or is - // currently being applied. - DBInstanceClass *string - - // Indicates that the Single-AZ instance is to change to a Multi-AZ deployment. - MultiAZ *bool + // Specifies the pending port for the instance. + Port *int32 - // Specifies the pending number of days for which automated backups are retained. - BackupRetentionPeriod *int32 + // Specifies the storage type to be associated with the instance. + StorageType *string } // Represents the output of ApplyPendingMaintenanceAction (). @@ -738,14 +738,14 @@ type ResourcePendingMaintenanceActions struct { // Detailed information about a subnet. type Subnet struct { - // Specifies the status of the subnet. - SubnetStatus *string + // Specifies the Availability Zone for the subnet. + SubnetAvailabilityZone *AvailabilityZone // Specifies the identifier of the subnet. SubnetIdentifier *string - // Specifies the Availability Zone for the subnet. - SubnetAvailabilityZone *AvailabilityZone + // Specifies the status of the subnet. + SubnetStatus *string } // Metadata assigned to an Amazon DocumentDB resource consisting of a key-value @@ -768,21 +768,21 @@ type Tag struct { // The version of the database engine that an instance can be upgraded to. type UpgradeTarget struct { - // The version of the database engine that an instance can be upgraded to. - Description *string - // A value that indicates whether the target version is applied to any source DB // instances that have AutoMinorVersionUpgrade set to true. AutoUpgrade *bool + // The version of the database engine that an instance can be upgraded to. + Description *string + + // The name of the upgrade target database engine. + Engine *string + // The version number of the upgrade target database engine. EngineVersion *string // A value that indicates whether a database engine is upgraded to a major version. IsMajorVersionUpgrade *bool - - // The name of the upgrade target database engine. - Engine *string } // Used as a response element for queries on virtual private cloud (VPC) security diff --git a/service/dynamodb/api_op_BatchGetItem.go b/service/dynamodb/api_op_BatchGetItem.go index 60b2123fb3f..c59c60c3fdd 100644 --- a/service/dynamodb/api_op_BatchGetItem.go +++ b/service/dynamodb/api_op_BatchGetItem.go @@ -195,11 +195,6 @@ type BatchGetItemInput struct { // Represents the output of a BatchGetItem operation. type BatchGetItemOutput struct { - // A map of table name to a list of items. Each object in Responses consists of a - // table name, along with a map of attribute data consisting of the data type and - // attribute value. - Responses map[string][]map[string]*types.AttributeValue - // The read capacity units consumed by the entire BatchGetItem operation. Each // element consists of: // @@ -209,6 +204,11 @@ type BatchGetItemOutput struct { // * CapacityUnits - The total number of capacity units consumed. ConsumedCapacity []*types.ConsumedCapacity + // A map of table name to a list of items. Each object in Responses consists of a + // table name, along with a map of attribute data consisting of the data type and + // attribute value. + Responses map[string][]map[string]*types.AttributeValue + // A map of tables and their respective keys that were not processed with the // current response. The UnprocessedKeys value is in the same form as RequestItems, // so the value can be provided directly to a subsequent BatchGetItem operation. diff --git a/service/dynamodb/api_op_BatchWriteItem.go b/service/dynamodb/api_op_BatchWriteItem.go index d09ba267fcb..23b4d704ff0 100644 --- a/service/dynamodb/api_op_BatchWriteItem.go +++ b/service/dynamodb/api_op_BatchWriteItem.go @@ -111,23 +111,6 @@ func (c *Client) BatchWriteItem(ctx context.Context, params *BatchWriteItemInput // Represents the input of a BatchWriteItem operation. type BatchWriteItemInput struct { - // Determines the level of detail about provisioned throughput consumption that is - // returned in the response: - // - // * INDEXES - The response includes the aggregate - // ConsumedCapacity for the operation, together with ConsumedCapacity for each - // table and secondary index that was accessed. Note that some operations, such as - // GetItem and BatchGetItem, do not access any indexes at all. In these cases, - // specifying INDEXES will only return ConsumedCapacity information for table(s). - // - // - // * TOTAL - The response includes only the aggregate ConsumedCapacity for the - // operation. - // - // * NONE - No ConsumedCapacity details are included in the - // response. - ReturnConsumedCapacity types.ReturnConsumedCapacity - // A map of one or more table names and, for each table, a list of operations to be // performed (DeleteRequest or PutRequest). Each element in the map consists of the // following: @@ -158,6 +141,23 @@ type BatchWriteItemInput struct { // This member is required. RequestItems map[string][]*types.WriteRequest + // Determines the level of detail about provisioned throughput consumption that is + // returned in the response: + // + // * INDEXES - The response includes the aggregate + // ConsumedCapacity for the operation, together with ConsumedCapacity for each + // table and secondary index that was accessed. Note that some operations, such as + // GetItem and BatchGetItem, do not access any indexes at all. In these cases, + // specifying INDEXES will only return ConsumedCapacity information for table(s). + // + // + // * TOTAL - The response includes only the aggregate ConsumedCapacity for the + // operation. + // + // * NONE - No ConsumedCapacity details are included in the + // response. + ReturnConsumedCapacity types.ReturnConsumedCapacity + // Determines whether item collection metrics are returned. If set to SIZE, the // response includes statistics about item collections, if any, that were modified // during the operation are returned in the response. If set to NONE (the default), @@ -168,6 +168,33 @@ type BatchWriteItemInput struct { // Represents the output of a BatchWriteItem operation. type BatchWriteItemOutput struct { + // The capacity units consumed by the entire BatchWriteItem operation. Each element + // consists of: + // + // * TableName - The table that consumed the provisioned + // throughput. + // + // * CapacityUnits - The total number of capacity units consumed. + ConsumedCapacity []*types.ConsumedCapacity + + // A list of tables that were processed by BatchWriteItem and, for each table, + // information about any item collections that were affected by individual + // DeleteItem or PutItem operations. Each entry consists of the following + // subelements: + // + // * ItemCollectionKey - The partition key value of the item + // collection. This is the same as the partition key value of the item. + // + // * + // SizeEstimateRangeGB - An estimate of item collection size, expressed in GB. This + // is a two-element array containing a lower bound and an upper bound for the + // estimate. The estimate includes the size of all the items in the table, plus the + // size of all attributes projected into all of the local secondary indexes on the + // table. Use this estimate to measure whether a local secondary index is + // approaching its size limit. The estimate is subject to change over time; + // therefore, do not rely on the precision or accuracy of the estimate. + ItemCollectionMetrics map[string][]*types.ItemCollectionMetrics + // A map of tables and requests against those tables that were not processed. The // UnprocessedItems value is in the same form as RequestItems, so you can provide // this value directly to a subsequent BatchGetItem operation. For more @@ -200,33 +227,6 @@ type BatchWriteItemOutput struct { // an empty UnprocessedItems map. UnprocessedItems map[string][]*types.WriteRequest - // The capacity units consumed by the entire BatchWriteItem operation. Each element - // consists of: - // - // * TableName - The table that consumed the provisioned - // throughput. - // - // * CapacityUnits - The total number of capacity units consumed. - ConsumedCapacity []*types.ConsumedCapacity - - // A list of tables that were processed by BatchWriteItem and, for each table, - // information about any item collections that were affected by individual - // DeleteItem or PutItem operations. Each entry consists of the following - // subelements: - // - // * ItemCollectionKey - The partition key value of the item - // collection. This is the same as the partition key value of the item. - // - // * - // SizeEstimateRangeGB - An estimate of item collection size, expressed in GB. This - // is a two-element array containing a lower bound and an upper bound for the - // estimate. The estimate includes the size of all the items in the table, plus the - // size of all attributes projected into all of the local secondary indexes on the - // table. Use this estimate to measure whether a local secondary index is - // approaching its size limit. The estimate is subject to change over time; - // therefore, do not rely on the precision or accuracy of the estimate. - ItemCollectionMetrics map[string][]*types.ItemCollectionMetrics - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/dynamodb/api_op_CreateBackup.go b/service/dynamodb/api_op_CreateBackup.go index cba8bcb08ff..7df01169a3b 100644 --- a/service/dynamodb/api_op_CreateBackup.go +++ b/service/dynamodb/api_op_CreateBackup.go @@ -82,15 +82,15 @@ func (c *Client) CreateBackup(ctx context.Context, params *CreateBackupInput, op type CreateBackupInput struct { - // The name of the table. + // Specified name for the backup. // // This member is required. - TableName *string + BackupName *string - // Specified name for the backup. + // The name of the table. // // This member is required. - BackupName *string + TableName *string } type CreateBackupOutput struct { diff --git a/service/dynamodb/api_op_CreateTable.go b/service/dynamodb/api_op_CreateTable.go index e9365f2bedb..4ce5ed31695 100644 --- a/service/dynamodb/api_op_CreateTable.go +++ b/service/dynamodb/api_op_CreateTable.go @@ -71,32 +71,10 @@ func (c *Client) CreateTable(ctx context.Context, params *CreateTableInput, optF // Represents the input of a CreateTable operation. type CreateTableInput struct { - // Represents the settings used to enable server-side encryption. - SSESpecification *types.SSESpecification - - // The settings for DynamoDB Streams on the table. These settings consist of: - // - // - // * StreamEnabled - Indicates whether DynamoDB Streams is to be enabled (true) or - // disabled (false). - // - // * StreamViewType - When an item in the table is modified, - // StreamViewType determines what information is written to the table's stream. - // Valid values for StreamViewType are: - // - // * KEYS_ONLY - Only the key - // attributes of the modified item are written to the stream. - // - // * NEW_IMAGE - // - The entire item, as it appears after it was modified, is written to the - // stream. - // - // * OLD_IMAGE - The entire item, as it appeared before it was - // modified, is written to the stream. + // An array of attributes that describe the key schema for the table and indexes. // - // * NEW_AND_OLD_IMAGES - Both the new - // and the old item images of the item are written to the stream. - StreamSpecification *types.StreamSpecification + // This member is required. + AttributeDefinitions []*types.AttributeDefinition // Specifies the attributes that make up the primary key for a table or an index. // The attributes in KeySchema must also be defined in the AttributeDefinitions @@ -134,10 +112,24 @@ type CreateTableInput struct { // This member is required. KeySchema []*types.KeySchemaElement - // An array of attributes that describe the key schema for the table and indexes. + // The name of the table to create. // // This member is required. - AttributeDefinitions []*types.AttributeDefinition + TableName *string + + // Controls how you are charged for read and write throughput and how you manage + // capacity. This setting can be changed later. + // + // * PROVISIONED - We recommend + // using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode + // to Provisioned Mode + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual). + // + // + // * PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable + // workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand). + BillingMode types.BillingMode // One or more global secondary indexes (the maximum is 20) to be created on the // table. Each global secondary index in the array includes the following: @@ -178,20 +170,6 @@ type CreateTableInput struct { // the global secondary index, consisting of read and write capacity units. GlobalSecondaryIndexes []*types.GlobalSecondaryIndex - // Controls how you are charged for read and write throughput and how you manage - // capacity. This setting can be changed later. - // - // * PROVISIONED - We recommend - // using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode - // to Provisioned Mode - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual). - // - // - // * PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable - // workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand). - BillingMode types.BillingMode - // One or more local secondary indexes (the maximum is 5) to be created on the // table. Each index is scoped to a given partition key value. There is a 10 GB // size limit per partition key value; otherwise, the size of a local secondary @@ -240,15 +218,37 @@ type CreateTableInput struct { // in the Amazon DynamoDB Developer Guide. ProvisionedThroughput *types.ProvisionedThroughput + // Represents the settings used to enable server-side encryption. + SSESpecification *types.SSESpecification + + // The settings for DynamoDB Streams on the table. These settings consist of: + // + // + // * StreamEnabled - Indicates whether DynamoDB Streams is to be enabled (true) or + // disabled (false). + // + // * StreamViewType - When an item in the table is modified, + // StreamViewType determines what information is written to the table's stream. + // Valid values for StreamViewType are: + // + // * KEYS_ONLY - Only the key + // attributes of the modified item are written to the stream. + // + // * NEW_IMAGE + // - The entire item, as it appears after it was modified, is written to the + // stream. + // + // * OLD_IMAGE - The entire item, as it appeared before it was + // modified, is written to the stream. + // + // * NEW_AND_OLD_IMAGES - Both the new + // and the old item images of the item are written to the stream. + StreamSpecification *types.StreamSpecification + // A list of key-value pairs to label the table. For more information, see Tagging // for DynamoDB // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html). Tags []*types.Tag - - // The name of the table to create. - // - // This member is required. - TableName *string } // Represents the output of a CreateTable operation. diff --git a/service/dynamodb/api_op_DeleteItem.go b/service/dynamodb/api_op_DeleteItem.go index 03ea54f1bcd..00beb23b61f 100644 --- a/service/dynamodb/api_op_DeleteItem.go +++ b/service/dynamodb/api_op_DeleteItem.go @@ -68,18 +68,19 @@ func (c *Client) DeleteItem(ctx context.Context, params *DeleteItemInput, optFns // Represents the input of a DeleteItem operation. type DeleteItemInput struct { - // One or more values that can be substituted in an expression. Use the : (colon) - // character in an expression to dereference an attribute value. For example, - // suppose that you wanted to check whether the value of the ProductStatus - // attribute was one of the following: Available | Backordered | Discontinued You - // would first need to specify ExpressionAttributeValues as follows: { - // ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, - // ":disc":{"S":"Discontinued"} } You could then use these values in an expression, - // such as this: ProductStatus IN (:avail, :back, :disc) For more information on - // expression attribute values, see Condition Expressions - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) - // in the Amazon DynamoDB Developer Guide. - ExpressionAttributeValues map[string]*types.AttributeValue + // A map of attribute names to AttributeValue objects, representing the primary key + // of the item to delete. For the primary key, you must provide all of the + // attributes. For example, with a simple primary key, you only need to provide a + // value for the partition key. For a composite primary key, you must provide + // values for both the partition key and the sort key. + // + // This member is required. + Key map[string]*types.AttributeValue + + // The name of the table from which to delete the item. + // + // This member is required. + TableName *string // A condition that must be satisfied in order for a conditional DeleteItem to // succeed. An expression can contain any of the following: @@ -100,58 +101,17 @@ type DeleteItemInput struct { // in the Amazon DynamoDB Developer Guide. ConditionExpression *string - // A map of attribute names to AttributeValue objects, representing the primary key - // of the item to delete. For the primary key, you must provide all of the - // attributes. For example, with a simple primary key, you only need to provide a - // value for the partition key. For a composite primary key, you must provide - // values for both the partition key and the sort key. - // - // This member is required. - Key map[string]*types.AttributeValue - - // This is a legacy parameter. Use ConditionExpression instead. For more - // information, see Expected - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html) - // in the Amazon DynamoDB Developer Guide. - Expected map[string]*types.ExpectedAttributeValue - // This is a legacy parameter. Use ConditionExpression instead. For more // information, see ConditionalOperator // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) // in the Amazon DynamoDB Developer Guide. ConditionalOperator types.ConditionalOperator - // Determines the level of detail about provisioned throughput consumption that is - // returned in the response: - // - // * INDEXES - The response includes the aggregate - // ConsumedCapacity for the operation, together with ConsumedCapacity for each - // table and secondary index that was accessed. Note that some operations, such as - // GetItem and BatchGetItem, do not access any indexes at all. In these cases, - // specifying INDEXES will only return ConsumedCapacity information for table(s). - // - // - // * TOTAL - The response includes only the aggregate ConsumedCapacity for the - // operation. - // - // * NONE - No ConsumedCapacity details are included in the - // response. - ReturnConsumedCapacity types.ReturnConsumedCapacity - - // Use ReturnValues if you want to get the item attributes as they appeared before - // they were deleted. For DeleteItem, the valid values are: - // - // * NONE - If - // ReturnValues is not specified, or if its value is NONE, then nothing is - // returned. (This setting is the default for ReturnValues.) - // - // * ALL_OLD - The - // content of the old item is returned. - // - // The ReturnValues parameter is used by - // several DynamoDB operations; however, DeleteItem does not recognize any values - // other than NONE or ALL_OLD. - ReturnValues types.ReturnValue + // This is a legacy parameter. Use ConditionExpression instead. For more + // information, see Expected + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html) + // in the Amazon DynamoDB Developer Guide. + Expected map[string]*types.ExpectedAttributeValue // One or more substitution tokens for attribute names in an expression. The // following are some use cases for using ExpressionAttributeNames: @@ -194,21 +154,75 @@ type DeleteItemInput struct { // in the Amazon DynamoDB Developer Guide. ExpressionAttributeNames map[string]*string + // One or more values that can be substituted in an expression. Use the : (colon) + // character in an expression to dereference an attribute value. For example, + // suppose that you wanted to check whether the value of the ProductStatus + // attribute was one of the following: Available | Backordered | Discontinued You + // would first need to specify ExpressionAttributeValues as follows: { + // ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, + // ":disc":{"S":"Discontinued"} } You could then use these values in an expression, + // such as this: ProductStatus IN (:avail, :back, :disc) For more information on + // expression attribute values, see Condition Expressions + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) + // in the Amazon DynamoDB Developer Guide. + ExpressionAttributeValues map[string]*types.AttributeValue + + // Determines the level of detail about provisioned throughput consumption that is + // returned in the response: + // + // * INDEXES - The response includes the aggregate + // ConsumedCapacity for the operation, together with ConsumedCapacity for each + // table and secondary index that was accessed. Note that some operations, such as + // GetItem and BatchGetItem, do not access any indexes at all. In these cases, + // specifying INDEXES will only return ConsumedCapacity information for table(s). + // + // + // * TOTAL - The response includes only the aggregate ConsumedCapacity for the + // operation. + // + // * NONE - No ConsumedCapacity details are included in the + // response. + ReturnConsumedCapacity types.ReturnConsumedCapacity + // Determines whether item collection metrics are returned. If set to SIZE, the // response includes statistics about item collections, if any, that were modified // during the operation are returned in the response. If set to NONE (the default), // no statistics are returned. ReturnItemCollectionMetrics types.ReturnItemCollectionMetrics - // The name of the table from which to delete the item. + // Use ReturnValues if you want to get the item attributes as they appeared before + // they were deleted. For DeleteItem, the valid values are: // - // This member is required. - TableName *string + // * NONE - If + // ReturnValues is not specified, or if its value is NONE, then nothing is + // returned. (This setting is the default for ReturnValues.) + // + // * ALL_OLD - The + // content of the old item is returned. + // + // The ReturnValues parameter is used by + // several DynamoDB operations; however, DeleteItem does not recognize any values + // other than NONE or ALL_OLD. + ReturnValues types.ReturnValue } // Represents the output of a DeleteItem operation. type DeleteItemOutput struct { + // A map of attribute names to AttributeValue objects, representing the item as it + // appeared before the DeleteItem operation. This map appears in the response only + // if ReturnValues was specified as ALL_OLD in the request. + Attributes map[string]*types.AttributeValue + + // The capacity units consumed by the DeleteItem operation. The data returned + // includes the total provisioned throughput consumed, along with statistics for + // the table and any indexes involved in the operation. ConsumedCapacity is only + // returned if the ReturnConsumedCapacity parameter was specified. For more + // information, see Provisioned Mode + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) + // in the Amazon DynamoDB Developer Guide. + ConsumedCapacity *types.ConsumedCapacity + // Information about item collections, if any, that were affected by the DeleteItem // operation. ItemCollectionMetrics is only returned if the // ReturnItemCollectionMetrics parameter was specified. If the table does not have @@ -229,20 +243,6 @@ type DeleteItemOutput struct { // of the estimate. ItemCollectionMetrics *types.ItemCollectionMetrics - // A map of attribute names to AttributeValue objects, representing the item as it - // appeared before the DeleteItem operation. This map appears in the response only - // if ReturnValues was specified as ALL_OLD in the request. - Attributes map[string]*types.AttributeValue - - // The capacity units consumed by the DeleteItem operation. The data returned - // includes the total provisioned throughput consumed, along with statistics for - // the table and any indexes involved in the operation. ConsumedCapacity is only - // returned if the ReturnConsumedCapacity parameter was specified. For more - // information, see Provisioned Mode - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) - // in the Amazon DynamoDB Developer Guide. - ConsumedCapacity *types.ConsumedCapacity - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/dynamodb/api_op_DescribeContributorInsights.go b/service/dynamodb/api_op_DescribeContributorInsights.go index 208cef02694..f169cb29ef1 100644 --- a/service/dynamodb/api_op_DescribeContributorInsights.go +++ b/service/dynamodb/api_op_DescribeContributorInsights.go @@ -61,17 +61,23 @@ func (c *Client) DescribeContributorInsights(ctx context.Context, params *Descri type DescribeContributorInsightsInput struct { - // The name of the global secondary index to describe, if applicable. - IndexName *string - // The name of the table to describe. // // This member is required. TableName *string + + // The name of the global secondary index to describe, if applicable. + IndexName *string } type DescribeContributorInsightsOutput struct { + // List of names of the associated Alpine rules. + ContributorInsightsRuleList []*string + + // Current Status contributor insights. + ContributorInsightsStatus types.ContributorInsightsStatus + // Returns information about the last failure that encountered. The most common // exceptions for a FAILED status are: // @@ -91,20 +97,14 @@ type DescribeContributorInsightsOutput struct { // create Amazon CloudWatch Contributor Insights rules. Please retry request. FailureException *types.FailureException - // List of names of the associated Alpine rules. - ContributorInsightsRuleList []*string - - // The name of the table being described. - TableName *string - - // Current Status contributor insights. - ContributorInsightsStatus types.ContributorInsightsStatus + // The name of the global secondary index being described. + IndexName *string // Timestamp of the last time the status was changed. LastUpdateDateTime *time.Time - // The name of the global secondary index being described. - IndexName *string + // The name of the table being described. + TableName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/dynamodb/api_op_DescribeGlobalTableSettings.go b/service/dynamodb/api_op_DescribeGlobalTableSettings.go index 5bbf7fa5bff..0a118118187 100644 --- a/service/dynamodb/api_op_DescribeGlobalTableSettings.go +++ b/service/dynamodb/api_op_DescribeGlobalTableSettings.go @@ -70,12 +70,12 @@ type DescribeGlobalTableSettingsInput struct { type DescribeGlobalTableSettingsOutput struct { - // The Region-specific settings for the global table. - ReplicaSettings []*types.ReplicaSettingsDescription - // The name of the global table. GlobalTableName *string + // The Region-specific settings for the global table. + ReplicaSettings []*types.ReplicaSettingsDescription + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/dynamodb/api_op_DescribeLimits.go b/service/dynamodb/api_op_DescribeLimits.go index 3d0c699fbb9..73b0ea62adc 100644 --- a/service/dynamodb/api_op_DescribeLimits.go +++ b/service/dynamodb/api_op_DescribeLimits.go @@ -102,23 +102,23 @@ type DescribeLimitsInput struct { // Represents the output of a DescribeLimits operation. type DescribeLimitsOutput struct { + // The maximum total read capacity units that your account allows you to provision + // across all of your tables in this Region. + AccountMaxReadCapacityUnits *int64 + // The maximum total write capacity units that your account allows you to provision // across all of your tables in this Region. AccountMaxWriteCapacityUnits *int64 - // The maximum write capacity units that your account allows you to provision for a - // new table that you are creating in this Region, including the write capacity - // units provisioned for its global secondary indexes (GSIs). - TableMaxWriteCapacityUnits *int64 - // The maximum read capacity units that your account allows you to provision for a // new table that you are creating in this Region, including the read capacity // units provisioned for its global secondary indexes (GSIs). TableMaxReadCapacityUnits *int64 - // The maximum total read capacity units that your account allows you to provision - // across all of your tables in this Region. - AccountMaxReadCapacityUnits *int64 + // The maximum write capacity units that your account allows you to provision for a + // new table that you are creating in this Region, including the write capacity + // units provisioned for its global secondary indexes (GSIs). + TableMaxWriteCapacityUnits *int64 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/dynamodb/api_op_GetItem.go b/service/dynamodb/api_op_GetItem.go index 1266873c5e0..9931071580c 100644 --- a/service/dynamodb/api_op_GetItem.go +++ b/service/dynamodb/api_op_GetItem.go @@ -66,15 +66,14 @@ func (c *Client) GetItem(ctx context.Context, params *GetItemInput, optFns ...fu // Represents the input of a GetItem operation. type GetItemInput struct { - // A string that identifies one or more attributes to retrieve from the table. - // These attributes can include scalars, sets, or elements of a JSON document. The - // attributes in the expression must be separated by commas. If no attribute names - // are specified, then all attributes are returned. If any of the requested - // attributes are not found, they do not appear in the result. For more - // information, see Specifying Item Attributes - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) - // in the Amazon DynamoDB Developer Guide. - ProjectionExpression *string + // A map of attribute names to AttributeValue objects, representing the primary key + // of the item to retrieve. For the primary key, you must provide all of the + // attributes. For example, with a simple primary key, you only need to provide a + // value for the partition key. For a composite primary key, you must provide + // values for both the partition key and the sort key. + // + // This member is required. + Key map[string]*types.AttributeValue // The name of the table containing the requested item. // @@ -87,6 +86,11 @@ type GetItemInput struct { // in the Amazon DynamoDB Developer Guide. AttributesToGet []*string + // Determines the read consistency model: If set to true, then the operation uses + // strongly consistent reads; otherwise, the operation uses eventually consistent + // reads. + ConsistentRead *bool + // One or more substitution tokens for attribute names in an expression. The // following are some use cases for using ExpressionAttributeNames: // @@ -128,6 +132,16 @@ type GetItemInput struct { // in the Amazon DynamoDB Developer Guide. ExpressionAttributeNames map[string]*string + // A string that identifies one or more attributes to retrieve from the table. + // These attributes can include scalars, sets, or elements of a JSON document. The + // attributes in the expression must be separated by commas. If no attribute names + // are specified, then all attributes are returned. If any of the requested + // attributes are not found, they do not appear in the result. For more + // information, see Specifying Item Attributes + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) + // in the Amazon DynamoDB Developer Guide. + ProjectionExpression *string + // Determines the level of detail about provisioned throughput consumption that is // returned in the response: // @@ -144,20 +158,6 @@ type GetItemInput struct { // * NONE - No ConsumedCapacity details are included in the // response. ReturnConsumedCapacity types.ReturnConsumedCapacity - - // A map of attribute names to AttributeValue objects, representing the primary key - // of the item to retrieve. For the primary key, you must provide all of the - // attributes. For example, with a simple primary key, you only need to provide a - // value for the partition key. For a composite primary key, you must provide - // values for both the partition key and the sort key. - // - // This member is required. - Key map[string]*types.AttributeValue - - // Determines the read consistency model: If set to true, then the operation uses - // strongly consistent reads; otherwise, the operation uses eventually consistent - // reads. - ConsistentRead *bool } // Represents the output of a GetItem operation. diff --git a/service/dynamodb/api_op_ListBackups.go b/service/dynamodb/api_op_ListBackups.go index c96d252ca52..5c56098b19b 100644 --- a/service/dynamodb/api_op_ListBackups.go +++ b/service/dynamodb/api_op_ListBackups.go @@ -77,10 +77,6 @@ type ListBackupsInput struct { // backups (USER and SYSTEM). BackupType types.BackupTypeFilter - // Only backups created before this time are listed. TimeRangeUpperBound is - // exclusive. - TimeRangeUpperBound *time.Time - // LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last // evaluated when the current page of results was returned, inclusive of the // current page of results. This value may be specified as the @@ -88,15 +84,19 @@ type ListBackupsInput struct { // next page of results. ExclusiveStartBackupArn *string - // Only backups created after this time are listed. TimeRangeLowerBound is - // inclusive. - TimeRangeLowerBound *time.Time + // Maximum number of backups to return at once. + Limit *int32 // The backups from the table specified by TableName are listed. TableName *string - // Maximum number of backups to return at once. - Limit *int32 + // Only backups created after this time are listed. TimeRangeLowerBound is + // inclusive. + TimeRangeLowerBound *time.Time + + // Only backups created before this time are listed. TimeRangeUpperBound is + // exclusive. + TimeRangeUpperBound *time.Time } type ListBackupsOutput struct { diff --git a/service/dynamodb/api_op_ListContributorInsights.go b/service/dynamodb/api_op_ListContributorInsights.go index d6d9ea841f9..39d99e9867e 100644 --- a/service/dynamodb/api_op_ListContributorInsights.go +++ b/service/dynamodb/api_op_ListContributorInsights.go @@ -59,24 +59,24 @@ func (c *Client) ListContributorInsights(ctx context.Context, params *ListContri type ListContributorInsightsInput struct { - // The name of the table. - TableName *string - // Maximum number of results to return per page. MaxResults *int32 // A token to for the desired page, if there is one. NextToken *string + + // The name of the table. + TableName *string } type ListContributorInsightsOutput struct { - // A token to go to the next page if there is one. - NextToken *string - // A list of ContributorInsightsSummary. ContributorInsightsSummaries []*types.ContributorInsightsSummary + // A token to go to the next page if there is one. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/dynamodb/api_op_ListTables.go b/service/dynamodb/api_op_ListTables.go index 3def9b27d81..ef616946fa2 100644 --- a/service/dynamodb/api_op_ListTables.go +++ b/service/dynamodb/api_op_ListTables.go @@ -60,26 +60,19 @@ func (c *Client) ListTables(ctx context.Context, params *ListTablesInput, optFns // Represents the input of a ListTables operation. type ListTablesInput struct { - // A maximum number of table names to return. If this parameter is not specified, - // the limit is 100. - Limit *int32 - // The first table name that this operation will evaluate. Use the value that was // returned for LastEvaluatedTableName in a previous operation, so that you can // obtain the next page of results. ExclusiveStartTableName *string + + // A maximum number of table names to return. If this parameter is not specified, + // the limit is 100. + Limit *int32 } // Represents the output of a ListTables operation. type ListTablesOutput struct { - // The names of the tables associated with the current account at the current - // endpoint. The maximum size of this array is 100. If LastEvaluatedTableName also - // appears in the output, you can use this value as the ExclusiveStartTableName - // parameter in a subsequent ListTables request and obtain the next page of - // results. - TableNames []*string - // The name of the last table in the current page of results. Use this value as the // ExclusiveStartTableName in a new request to obtain the next page of results, // until all the table names are returned. If you do not receive a @@ -87,6 +80,13 @@ type ListTablesOutput struct { // table names to be retrieved. LastEvaluatedTableName *string + // The names of the tables associated with the current account at the current + // endpoint. The maximum size of this array is 100. If LastEvaluatedTableName also + // appears in the output, you can use this value as the ExclusiveStartTableName + // parameter in a subsequent ListTables request and obtain the next page of + // results. + TableNames []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/dynamodb/api_op_ListTagsOfResource.go b/service/dynamodb/api_op_ListTagsOfResource.go index 6dd894c5baf..39b5e697f4f 100644 --- a/service/dynamodb/api_op_ListTagsOfResource.go +++ b/service/dynamodb/api_op_ListTagsOfResource.go @@ -63,16 +63,16 @@ func (c *Client) ListTagsOfResource(ctx context.Context, params *ListTagsOfResou type ListTagsOfResourceInput struct { - // An optional string that, if supplied, must be copied from the output of a - // previous call to ListTagOfResource. When provided in this manner, this API - // fetches the next page of results. - NextToken *string - // The Amazon DynamoDB resource with tags to be listed. This value is an Amazon // Resource Name (ARN). // // This member is required. ResourceArn *string + + // An optional string that, if supplied, must be copied from the output of a + // previous call to ListTagOfResource. When provided in this manner, this API + // fetches the next page of results. + NextToken *string } type ListTagsOfResourceOutput struct { diff --git a/service/dynamodb/api_op_PutItem.go b/service/dynamodb/api_op_PutItem.go index c304d947f1d..31f2b25380d 100644 --- a/service/dynamodb/api_op_PutItem.go +++ b/service/dynamodb/api_op_PutItem.go @@ -119,11 +119,60 @@ func (c *Client) PutItem(ctx context.Context, params *PutItemInput, optFns ...fu // Represents the input of a PutItem operation. type PutItemInput struct { - // Determines whether item collection metrics are returned. If set to SIZE, the - // response includes statistics about item collections, if any, that were modified - // during the operation are returned in the response. If set to NONE (the default), - // no statistics are returned. - ReturnItemCollectionMetrics types.ReturnItemCollectionMetrics + // A map of attribute name/value pairs, one for each attribute. Only the primary + // key attributes are required; you can optionally provide other attribute + // name-value pairs for the item. You must provide all of the attributes for the + // primary key. For example, with a simple primary key, you only need to provide a + // value for the partition key. For a composite primary key, you must provide both + // values for both the partition key and the sort key. If you specify any + // attributes that are part of an index key, then the data types for those + // attributes must match those of the schema in the table's attribute definition. + // Empty String and Binary attribute values are allowed. Attribute values of type + // String and Binary must have a length greater than zero if the attribute is used + // as a key attribute for a table or index.

    For more information about primary + // keys, see Primary + // Key in the Amazon DynamoDB Developer Guide.

    Each element in + // the Item map is an AttributeValue object.

    + // + // This member is required. + Item map[string]*types.AttributeValue + + // The name of the table to contain the item. + // + // This member is required. + TableName *string + + // A condition that must be satisfied in order for a conditional PutItem operation + // to succeed. An expression can contain any of the following: + // + // * Functions: + // attribute_exists | attribute_not_exists | attribute_type | contains | + // begins_with | size These function names are case-sensitive. + // + // * Comparison + // operators: = | <> | < | > | <= | >= | BETWEEN | IN + // + // * Logical operators: AND + // | OR | NOT + // + // For more information on condition expressions, see Condition + // Expressions + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) + // in the Amazon DynamoDB Developer Guide. + ConditionExpression *string + + // This is a legacy parameter. Use ConditionExpression instead. For more + // information, see ConditionalOperator + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) + // in the Amazon DynamoDB Developer Guide. + ConditionalOperator types.ConditionalOperator + + // This is a legacy parameter. Use ConditionExpression instead. For more + // information, see Expected + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html) + // in the Amazon DynamoDB Developer Guide. + Expected map[string]*types.ExpectedAttributeValue // One or more substitution tokens for attribute names in an expression. The // following are some use cases for using ExpressionAttributeNames: @@ -166,44 +215,18 @@ type PutItemInput struct { // in the Amazon DynamoDB Developer Guide. ExpressionAttributeNames map[string]*string - // Use ReturnValues if you want to get the item attributes as they appeared before - // they were updated with the PutItem request. For PutItem, the valid values are: - // - // - // * NONE - If ReturnValues is not specified, or if its value is NONE, then nothing - // is returned. (This setting is the default for ReturnValues.) - // - // * ALL_OLD - If - // PutItem overwrote an attribute name-value pair, then the content of the old item - // is returned. - // - // The ReturnValues parameter is used by several DynamoDB operations; - // however, PutItem does not recognize any values other than NONE or ALL_OLD. - ReturnValues types.ReturnValue - - // The name of the table to contain the item. - // - // This member is required. - TableName *string - - // A map of attribute name/value pairs, one for each attribute. Only the primary - // key attributes are required; you can optionally provide other attribute - // name-value pairs for the item. You must provide all of the attributes for the - // primary key. For example, with a simple primary key, you only need to provide a - // value for the partition key. For a composite primary key, you must provide both - // values for both the partition key and the sort key. If you specify any - // attributes that are part of an index key, then the data types for those - // attributes must match those of the schema in the table's attribute definition. - // Empty String and Binary attribute values are allowed. Attribute values of type - // String and Binary must have a length greater than zero if the attribute is used - // as a key attribute for a table or index.

    For more information about primary - // keys, see Primary - // Key in the Amazon DynamoDB Developer Guide.

    Each element in - // the Item map is an AttributeValue object.

    - // - // This member is required. - Item map[string]*types.AttributeValue + // One or more values that can be substituted in an expression. Use the : (colon) + // character in an expression to dereference an attribute value. For example, + // suppose that you wanted to check whether the value of the ProductStatus + // attribute was one of the following: Available | Backordered | Discontinued You + // would first need to specify ExpressionAttributeValues as follows: { + // ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, + // ":disc":{"S":"Discontinued"} } You could then use these values in an expression, + // such as this: ProductStatus IN (:avail, :back, :disc) For more information on + // expression attribute values, see Condition Expressions + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) + // in the Amazon DynamoDB Developer Guide. + ExpressionAttributeValues map[string]*types.AttributeValue // Determines the level of detail about provisioned throughput consumption that is // returned in the response: @@ -222,54 +245,45 @@ type PutItemInput struct { // response. ReturnConsumedCapacity types.ReturnConsumedCapacity - // One or more values that can be substituted in an expression. Use the : (colon) - // character in an expression to dereference an attribute value. For example, - // suppose that you wanted to check whether the value of the ProductStatus - // attribute was one of the following: Available | Backordered | Discontinued You - // would first need to specify ExpressionAttributeValues as follows: { - // ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, - // ":disc":{"S":"Discontinued"} } You could then use these values in an expression, - // such as this: ProductStatus IN (:avail, :back, :disc) For more information on - // expression attribute values, see Condition Expressions - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) - // in the Amazon DynamoDB Developer Guide. - ExpressionAttributeValues map[string]*types.AttributeValue + // Determines whether item collection metrics are returned. If set to SIZE, the + // response includes statistics about item collections, if any, that were modified + // during the operation are returned in the response. If set to NONE (the default), + // no statistics are returned. + ReturnItemCollectionMetrics types.ReturnItemCollectionMetrics - // A condition that must be satisfied in order for a conditional PutItem operation - // to succeed. An expression can contain any of the following: + // Use ReturnValues if you want to get the item attributes as they appeared before + // they were updated with the PutItem request. For PutItem, the valid values are: // - // * Functions: - // attribute_exists | attribute_not_exists | attribute_type | contains | - // begins_with | size These function names are case-sensitive. // - // * Comparison - // operators: = | <> | < | > | <= | >= | BETWEEN | IN + // * NONE - If ReturnValues is not specified, or if its value is NONE, then nothing + // is returned. (This setting is the default for ReturnValues.) // - // * Logical operators: AND - // | OR | NOT + // * ALL_OLD - If + // PutItem overwrote an attribute name-value pair, then the content of the old item + // is returned. // - // For more information on condition expressions, see Condition - // Expressions - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) - // in the Amazon DynamoDB Developer Guide. - ConditionExpression *string - - // This is a legacy parameter. Use ConditionExpression instead. For more - // information, see ConditionalOperator - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) - // in the Amazon DynamoDB Developer Guide. - ConditionalOperator types.ConditionalOperator - - // This is a legacy parameter. Use ConditionExpression instead. For more - // information, see Expected - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html) - // in the Amazon DynamoDB Developer Guide. - Expected map[string]*types.ExpectedAttributeValue + // The ReturnValues parameter is used by several DynamoDB operations; + // however, PutItem does not recognize any values other than NONE or ALL_OLD. + ReturnValues types.ReturnValue } // Represents the output of a PutItem operation. type PutItemOutput struct { + // The attribute values as they appeared before the PutItem operation, but only if + // ReturnValues is specified as ALL_OLD in the request. Each element consists of an + // attribute name and an attribute value. + Attributes map[string]*types.AttributeValue + + // The capacity units consumed by the PutItem operation. The data returned includes + // the total provisioned throughput consumed, along with statistics for the table + // and any indexes involved in the operation. ConsumedCapacity is only returned if + // the ReturnConsumedCapacity parameter was specified. For more information, see + // Read/Write Capacity Mode + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) + // in the Amazon DynamoDB Developer Guide. + ConsumedCapacity *types.ConsumedCapacity + // Information about item collections, if any, that were affected by the PutItem // operation. ItemCollectionMetrics is only returned if the // ReturnItemCollectionMetrics parameter was specified. If the table does not have @@ -290,20 +304,6 @@ type PutItemOutput struct { // of the estimate. ItemCollectionMetrics *types.ItemCollectionMetrics - // The capacity units consumed by the PutItem operation. The data returned includes - // the total provisioned throughput consumed, along with statistics for the table - // and any indexes involved in the operation. ConsumedCapacity is only returned if - // the ReturnConsumedCapacity parameter was specified. For more information, see - // Read/Write Capacity Mode - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) - // in the Amazon DynamoDB Developer Guide. - ConsumedCapacity *types.ConsumedCapacity - - // The attribute values as they appeared before the PutItem operation, but only if - // ReturnValues is specified as ALL_OLD in the request. Each element consists of an - // attribute name and an attribute value. - Attributes map[string]*types.AttributeValue - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/dynamodb/api_op_Query.go b/service/dynamodb/api_op_Query.go index 02c57bfcba2..6d5eea35dc7 100644 --- a/service/dynamodb/api_op_Query.go +++ b/service/dynamodb/api_op_Query.go @@ -96,56 +96,35 @@ func (c *Client) Query(ctx context.Context, params *QueryInput, optFns ...func(* // Represents the input of a Query operation. type QueryInput struct { - // This is a legacy parameter. Use KeyConditionExpression instead. For more - // information, see KeyConditions - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.KeyConditions.html) - // in the Amazon DynamoDB Developer Guide. - KeyConditions map[string]*types.Condition - - // Specifies the order for index traversal: If true (default), the traversal is - // performed in ascending order; if false, the traversal is performed in descending - // order. Items with the same partition key value are stored in sorted order by - // sort key. If the sort key data type is Number, the results are stored in numeric - // order. For type String, the results are stored in order of UTF-8 bytes. For type - // Binary, DynamoDB treats each byte of the binary data as unsigned. If - // ScanIndexForward is true, DynamoDB returns the results in the order in which - // they are stored (by sort key value). This is the default behavior. If - // ScanIndexForward is false, DynamoDB reads the results in reverse order by sort - // key value, and then returns the results to the client. - ScanIndexForward *bool - - // This is a legacy parameter. Use FilterExpression instead. For more information, - // see QueryFilter - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.QueryFilter.html) - // in the Amazon DynamoDB Developer Guide. - QueryFilter map[string]*types.Condition - // The name of the table containing the requested items. // // This member is required. TableName *string - // The name of an index to query. This index can be any local secondary index or - // global secondary index on the table. Note that if you use the IndexName - // parameter, you must also provide TableName. - IndexName *string + // This is a legacy parameter. Use ProjectionExpression instead. For more + // information, see AttributesToGet + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html) + // in the Amazon DynamoDB Developer Guide. + AttributesToGet []*string - // Determines the level of detail about provisioned throughput consumption that is - // returned in the response: - // - // * INDEXES - The response includes the aggregate - // ConsumedCapacity for the operation, together with ConsumedCapacity for each - // table and secondary index that was accessed. Note that some operations, such as - // GetItem and BatchGetItem, do not access any indexes at all. In these cases, - // specifying INDEXES will only return ConsumedCapacity information for table(s). - // - // - // * TOTAL - The response includes only the aggregate ConsumedCapacity for the - // operation. - // - // * NONE - No ConsumedCapacity details are included in the - // response. - ReturnConsumedCapacity types.ReturnConsumedCapacity + // This is a legacy parameter. Use FilterExpression instead. For more information, + // see ConditionalOperator + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) + // in the Amazon DynamoDB Developer Guide. + ConditionalOperator types.ConditionalOperator + + // Determines the read consistency model: If set to true, then the operation uses + // strongly consistent reads; otherwise, the operation uses eventually consistent + // reads. Strongly consistent reads are not supported on global secondary indexes. + // If you query a global secondary index with ConsistentRead set to true, you will + // receive a ValidationException. + ConsistentRead *bool + + // The primary key of the first item that this operation will evaluate. Use the + // value that was returned for LastEvaluatedKey in the previous operation. The data + // type for ExclusiveStartKey must be String, Number, or Binary. No set data types + // are allowed. + ExclusiveStartKey map[string]*types.AttributeValue // One or more substitution tokens for attribute names in an expression. The // following are some use cases for using ExpressionAttributeNames: @@ -188,12 +167,6 @@ type QueryInput struct { // in the Amazon DynamoDB Developer Guide. ExpressionAttributeNames map[string]*string - // This is a legacy parameter. Use ProjectionExpression instead. For more - // information, see AttributesToGet - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html) - // in the Amazon DynamoDB Developer Guide. - AttributesToGet []*string - // One or more values that can be substituted in an expression. Use the : (colon) // character in an expression to dereference an attribute value. For example, // suppose that you wanted to check whether the value of the ProductStatus @@ -207,84 +180,6 @@ type QueryInput struct { // in the Amazon DynamoDB Developer Guide. ExpressionAttributeValues map[string]*types.AttributeValue - // A string that identifies one or more attributes to retrieve from the table. - // These attributes can include scalars, sets, or elements of a JSON document. The - // attributes in the expression must be separated by commas. If no attribute names - // are specified, then all attributes will be returned. If any of the requested - // attributes are not found, they will not appear in the result. For more - // information, see Accessing Item Attributes - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) - // in the Amazon DynamoDB Developer Guide. - ProjectionExpression *string - - // Determines the read consistency model: If set to true, then the operation uses - // strongly consistent reads; otherwise, the operation uses eventually consistent - // reads. Strongly consistent reads are not supported on global secondary indexes. - // If you query a global secondary index with ConsistentRead set to true, you will - // receive a ValidationException. - ConsistentRead *bool - - // This is a legacy parameter. Use FilterExpression instead. For more information, - // see ConditionalOperator - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) - // in the Amazon DynamoDB Developer Guide. - ConditionalOperator types.ConditionalOperator - - // The attributes to be returned in the result. You can retrieve all item - // attributes, specific item attributes, the count of matching items, or in the - // case of an index, some or all of the attributes projected into the index. - // - // * - // ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or - // index. If you query a local secondary index, then for each matching item in the - // index, DynamoDB fetches the entire item from the parent table. If the index is - // configured to project all item attributes, then all of the data can be obtained - // from the local secondary index, and no fetching is required. - // - // * - // ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all - // attributes that have been projected into the index. If the index is configured - // to project all attributes, this return value is equivalent to specifying - // ALL_ATTRIBUTES. - // - // * COUNT - Returns the number of matching items, rather than - // the matching items themselves. - // - // * SPECIFIC_ATTRIBUTES - Returns only the - // attributes listed in AttributesToGet. This return value is equivalent to - // specifying AttributesToGet without specifying any value for Select. If you query - // or scan a local secondary index and request only attributes that are projected - // into that index, the operation will read only the index and not the table. If - // any of the requested attributes are not projected into the local secondary - // index, DynamoDB fetches each of these attributes from the parent table. This - // extra fetching incurs additional throughput cost and latency. If you query or - // scan a global secondary index, you can only request attributes that are - // projected into the index. Global secondary index queries cannot fetch attributes - // from the parent table. - // - // If neither Select nor AttributesToGet are specified, - // DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and - // ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and - // AttributesToGet together in a single request, unless the value for Select is - // SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet - // without any value for Select.) If you use the ProjectionExpression parameter, - // then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for - // Select will return an error. - Select types.Select - - // The maximum number of items to evaluate (not necessarily the number of matching - // items). If DynamoDB processes the number of items up to the limit while - // processing the results, it stops the operation and returns the matching values - // up to that point, and a key in LastEvaluatedKey to apply in a subsequent - // operation, so that you can pick up where you left off. Also, if the processed - // dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the - // operation and returns the matching values up to the limit, and a key in - // LastEvaluatedKey to apply in a subsequent operation to continue the operation. - // For more information, see Query and Scan - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html) - // in the Amazon DynamoDB Developer Guide. - Limit *int32 - // A string that contains conditions that DynamoDB applies after the Query // operation, but before the data is returned to you. Items that do not satisfy the // FilterExpression criteria are not returned. A FilterExpression does not allow @@ -296,11 +191,10 @@ type QueryInput struct { // in the Amazon DynamoDB Developer Guide. FilterExpression *string - // The primary key of the first item that this operation will evaluate. Use the - // value that was returned for LastEvaluatedKey in the previous operation. The data - // type for ExclusiveStartKey must be String, Number, or Binary. No set data types - // are allowed. - ExclusiveStartKey map[string]*types.AttributeValue + // The name of an index to query. This index can be any local secondary index or + // global secondary index on the table. Note that if you use the IndexName + // parameter, you must also provide TableName. + IndexName *string // The condition that specifies the key values for items to be retrieved by the // Query action.

    The condition must perform an equality test on a single @@ -356,18 +250,125 @@ type QueryInput struct { // Placeholders for Attribute Names and Values in the Amazon DynamoDB // Developer Guide.

    KeyConditionExpression *string + + // This is a legacy parameter. Use KeyConditionExpression instead. For more + // information, see KeyConditions + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.KeyConditions.html) + // in the Amazon DynamoDB Developer Guide. + KeyConditions map[string]*types.Condition + + // The maximum number of items to evaluate (not necessarily the number of matching + // items). If DynamoDB processes the number of items up to the limit while + // processing the results, it stops the operation and returns the matching values + // up to that point, and a key in LastEvaluatedKey to apply in a subsequent + // operation, so that you can pick up where you left off. Also, if the processed + // dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the + // operation and returns the matching values up to the limit, and a key in + // LastEvaluatedKey to apply in a subsequent operation to continue the operation. + // For more information, see Query and Scan + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html) + // in the Amazon DynamoDB Developer Guide. + Limit *int32 + + // A string that identifies one or more attributes to retrieve from the table. + // These attributes can include scalars, sets, or elements of a JSON document. The + // attributes in the expression must be separated by commas. If no attribute names + // are specified, then all attributes will be returned. If any of the requested + // attributes are not found, they will not appear in the result. For more + // information, see Accessing Item Attributes + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) + // in the Amazon DynamoDB Developer Guide. + ProjectionExpression *string + + // This is a legacy parameter. Use FilterExpression instead. For more information, + // see QueryFilter + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.QueryFilter.html) + // in the Amazon DynamoDB Developer Guide. + QueryFilter map[string]*types.Condition + + // Determines the level of detail about provisioned throughput consumption that is + // returned in the response: + // + // * INDEXES - The response includes the aggregate + // ConsumedCapacity for the operation, together with ConsumedCapacity for each + // table and secondary index that was accessed. Note that some operations, such as + // GetItem and BatchGetItem, do not access any indexes at all. In these cases, + // specifying INDEXES will only return ConsumedCapacity information for table(s). + // + // + // * TOTAL - The response includes only the aggregate ConsumedCapacity for the + // operation. + // + // * NONE - No ConsumedCapacity details are included in the + // response. + ReturnConsumedCapacity types.ReturnConsumedCapacity + + // Specifies the order for index traversal: If true (default), the traversal is + // performed in ascending order; if false, the traversal is performed in descending + // order. Items with the same partition key value are stored in sorted order by + // sort key. If the sort key data type is Number, the results are stored in numeric + // order. For type String, the results are stored in order of UTF-8 bytes. For type + // Binary, DynamoDB treats each byte of the binary data as unsigned. If + // ScanIndexForward is true, DynamoDB returns the results in the order in which + // they are stored (by sort key value). This is the default behavior. If + // ScanIndexForward is false, DynamoDB reads the results in reverse order by sort + // key value, and then returns the results to the client. + ScanIndexForward *bool + + // The attributes to be returned in the result. You can retrieve all item + // attributes, specific item attributes, the count of matching items, or in the + // case of an index, some or all of the attributes projected into the index. + // + // * + // ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or + // index. If you query a local secondary index, then for each matching item in the + // index, DynamoDB fetches the entire item from the parent table. If the index is + // configured to project all item attributes, then all of the data can be obtained + // from the local secondary index, and no fetching is required. + // + // * + // ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all + // attributes that have been projected into the index. If the index is configured + // to project all attributes, this return value is equivalent to specifying + // ALL_ATTRIBUTES. + // + // * COUNT - Returns the number of matching items, rather than + // the matching items themselves. + // + // * SPECIFIC_ATTRIBUTES - Returns only the + // attributes listed in AttributesToGet. This return value is equivalent to + // specifying AttributesToGet without specifying any value for Select. If you query + // or scan a local secondary index and request only attributes that are projected + // into that index, the operation will read only the index and not the table. If + // any of the requested attributes are not projected into the local secondary + // index, DynamoDB fetches each of these attributes from the parent table. This + // extra fetching incurs additional throughput cost and latency. If you query or + // scan a global secondary index, you can only request attributes that are + // projected into the index. Global secondary index queries cannot fetch attributes + // from the parent table. + // + // If neither Select nor AttributesToGet are specified, + // DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and + // ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and + // AttributesToGet together in a single request, unless the value for Select is + // SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet + // without any value for Select.) If you use the ProjectionExpression parameter, + // then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for + // Select will return an error. + Select types.Select } // Represents the output of a Query operation. type QueryOutput struct { - // The number of items evaluated, before any QueryFilter is applied. A high - // ScannedCount value with few, or no, Count results indicates an inefficient Query - // operation. For more information, see Count and ScannedCount - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count) - // in the Amazon DynamoDB Developer Guide. If you did not use a filter in the - // request, then ScannedCount is the same as Count. - ScannedCount *int32 + // The capacity units consumed by the Query operation. The data returned includes + // the total provisioned throughput consumed, along with statistics for the table + // and any indexes involved in the operation. ConsumedCapacity is only returned if + // the ReturnConsumedCapacity parameter was specified. For more information, see + // Provisioned Throughput + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) + // in the Amazon DynamoDB Developer Guide. + ConsumedCapacity *types.ConsumedCapacity // The number of items in the response. If you used a QueryFilter in the request, // then Count is the number of items returned after the filter was applied, and @@ -380,15 +381,6 @@ type QueryOutput struct { // array consists of an attribute name and the value for that attribute. Items []map[string]*types.AttributeValue - // The capacity units consumed by the Query operation. The data returned includes - // the total provisioned throughput consumed, along with statistics for the table - // and any indexes involved in the operation. ConsumedCapacity is only returned if - // the ReturnConsumedCapacity parameter was specified. For more information, see - // Provisioned Throughput - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) - // in the Amazon DynamoDB Developer Guide. - ConsumedCapacity *types.ConsumedCapacity - // The primary key of the item where the operation stopped, inclusive of the // previous result set. Use this value to start a new operation, excluding this // value in the new request. If LastEvaluatedKey is empty, then the "last page" of @@ -398,6 +390,14 @@ type QueryOutput struct { // the result set is when LastEvaluatedKey is empty. LastEvaluatedKey map[string]*types.AttributeValue + // The number of items evaluated, before any QueryFilter is applied. A high + // ScannedCount value with few, or no, Count results indicates an inefficient Query + // operation. For more information, see Count and ScannedCount + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count) + // in the Amazon DynamoDB Developer Guide. If you did not use a filter in the + // request, then ScannedCount is the same as Count. + ScannedCount *int32 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/dynamodb/api_op_RestoreTableFromBackup.go b/service/dynamodb/api_op_RestoreTableFromBackup.go index 3ad6741e4ac..ccc86314894 100644 --- a/service/dynamodb/api_op_RestoreTableFromBackup.go +++ b/service/dynamodb/api_op_RestoreTableFromBackup.go @@ -76,34 +76,34 @@ func (c *Client) RestoreTableFromBackup(ctx context.Context, params *RestoreTabl type RestoreTableFromBackupInput struct { - // List of global secondary indexes for the restored table. The indexes provided - // should match existing secondary indexes. You can choose to exclude some or all - // of the indexes at the time of restore. - GlobalSecondaryIndexOverride []*types.GlobalSecondaryIndex - - // The new server-side encryption settings for the restored table. - SSESpecificationOverride *types.SSESpecification + // The Amazon Resource Name (ARN) associated with the backup. + // + // This member is required. + BackupArn *string // The name of the new table to which the backup must be restored. // // This member is required. TargetTableName *string - // The Amazon Resource Name (ARN) associated with the backup. - // - // This member is required. - BackupArn *string + // The billing mode of the restored table. + BillingModeOverride types.BillingMode + + // List of global secondary indexes for the restored table. The indexes provided + // should match existing secondary indexes. You can choose to exclude some or all + // of the indexes at the time of restore. + GlobalSecondaryIndexOverride []*types.GlobalSecondaryIndex // List of local secondary indexes for the restored table. The indexes provided // should match existing secondary indexes. You can choose to exclude some or all // of the indexes at the time of restore. LocalSecondaryIndexOverride []*types.LocalSecondaryIndex - // The billing mode of the restored table. - BillingModeOverride types.BillingMode - // Provisioned throughput settings for the restored table. ProvisionedThroughputOverride *types.ProvisionedThroughput + + // The new server-side encryption settings for the restored table. + SSESpecificationOverride *types.SSESpecification } type RestoreTableFromBackupOutput struct { diff --git a/service/dynamodb/api_op_RestoreTableToPointInTime.go b/service/dynamodb/api_op_RestoreTableToPointInTime.go index 7b6b2bbdaad..cc1adc31136 100644 --- a/service/dynamodb/api_op_RestoreTableToPointInTime.go +++ b/service/dynamodb/api_op_RestoreTableToPointInTime.go @@ -85,40 +85,40 @@ func (c *Client) RestoreTableToPointInTime(ctx context.Context, params *RestoreT type RestoreTableToPointInTimeInput struct { + // The name of the new table to which it must be restored to. + // + // This member is required. + TargetTableName *string + + // The billing mode of the restored table. + BillingModeOverride types.BillingMode + + // List of global secondary indexes for the restored table. The indexes provided + // should match existing secondary indexes. You can choose to exclude some or all + // of the indexes at the time of restore. + GlobalSecondaryIndexOverride []*types.GlobalSecondaryIndex + // List of local secondary indexes for the restored table. The indexes provided // should match existing secondary indexes. You can choose to exclude some or all // of the indexes at the time of restore. LocalSecondaryIndexOverride []*types.LocalSecondaryIndex - // The DynamoDB table that will be restored. This value is an Amazon Resource Name - // (ARN). - SourceTableArn *string - // Provisioned throughput settings for the restored table. ProvisionedThroughputOverride *types.ProvisionedThroughput + // Time in the past to restore the table to. + RestoreDateTime *time.Time + // The new server-side encryption settings for the restored table. SSESpecificationOverride *types.SSESpecification - // The name of the new table to which it must be restored to. - // - // This member is required. - TargetTableName *string - - // The billing mode of the restored table. - BillingModeOverride types.BillingMode + // The DynamoDB table that will be restored. This value is an Amazon Resource Name + // (ARN). + SourceTableArn *string // Name of the source table that is being restored. SourceTableName *string - // Time in the past to restore the table to. - RestoreDateTime *time.Time - - // List of global secondary indexes for the restored table. The indexes provided - // should match existing secondary indexes. You can choose to exclude some or all - // of the indexes at the time of restore. - GlobalSecondaryIndexOverride []*types.GlobalSecondaryIndex - // Restore the table to the latest possible time. LatestRestorableDateTime is // typically 5 minutes before the current time. UseLatestRestorableTime *bool diff --git a/service/dynamodb/api_op_Scan.go b/service/dynamodb/api_op_Scan.go index e306eff35f9..c78f8f31d09 100644 --- a/service/dynamodb/api_op_Scan.go +++ b/service/dynamodb/api_op_Scan.go @@ -82,81 +82,23 @@ func (c *Client) Scan(ctx context.Context, params *ScanInput, optFns ...func(*Op // Represents the input of a Scan operation. type ScanInput struct { - // One or more values that can be substituted in an expression. Use the : (colon) - // character in an expression to dereference an attribute value. For example, - // suppose that you wanted to check whether the value of the ProductStatus - // attribute was one of the following: Available | Backordered | Discontinued You - // would first need to specify ExpressionAttributeValues as follows: { - // ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, - // ":disc":{"S":"Discontinued"} } You could then use these values in an expression, - // such as this: ProductStatus IN (:avail, :back, :disc) For more information on - // expression attribute values, see Condition Expressions - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) - // in the Amazon DynamoDB Developer Guide. - ExpressionAttributeValues map[string]*types.AttributeValue - - // The attributes to be returned in the result. You can retrieve all item - // attributes, specific item attributes, the count of matching items, or in the - // case of an index, some or all of the attributes projected into the index. - // - // * - // ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or - // index. If you query a local secondary index, then for each matching item in the - // index, DynamoDB fetches the entire item from the parent table. If the index is - // configured to project all item attributes, then all of the data can be obtained - // from the local secondary index, and no fetching is required. - // - // * - // ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all - // attributes that have been projected into the index. If the index is configured - // to project all attributes, this return value is equivalent to specifying - // ALL_ATTRIBUTES. - // - // * COUNT - Returns the number of matching items, rather than - // the matching items themselves. - // - // * SPECIFIC_ATTRIBUTES - Returns only the - // attributes listed in AttributesToGet. This return value is equivalent to - // specifying AttributesToGet without specifying any value for Select. If you query - // or scan a local secondary index and request only attributes that are projected - // into that index, the operation reads only the index and not the table. If any of - // the requested attributes are not projected into the local secondary index, - // DynamoDB fetches each of these attributes from the parent table. This extra - // fetching incurs additional throughput cost and latency. If you query or scan a - // global secondary index, you can only request attributes that are projected into - // the index. Global secondary index queries cannot fetch attributes from the - // parent table. + // The name of the table containing the requested items; or, if you provide + // IndexName, the name of the table to which that index belongs. // - // If neither Select nor AttributesToGet are specified, DynamoDB - // defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES - // when accessing an index. You cannot use both Select and AttributesToGet together - // in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This - // usage is equivalent to specifying AttributesToGet without any value for Select.) - // If you use the ProjectionExpression parameter, then the value for Select can - // only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error. - Select types.Select + // This member is required. + TableName *string - // For a parallel Scan request, Segment identifies an individual segment to be - // scanned by an application worker. Segment IDs are zero-based, so the first - // segment is always 0. For example, if you want to use four application threads to - // scan a table or an index, then the first thread specifies a Segment value of 0, - // the second thread specifies 1, and so on. The value of LastEvaluatedKey returned - // from a parallel Scan request must be used as ExclusiveStartKey with the same - // segment ID in a subsequent Scan operation. The value for Segment must be greater - // than or equal to 0, and less than the value provided for TotalSegments. If you - // provide Segment, you must also provide TotalSegments. - Segment *int32 + // This is a legacy parameter. Use ProjectionExpression instead. For more + // information, see AttributesToGet + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html) + // in the Amazon DynamoDB Developer Guide. + AttributesToGet []*string - // For a parallel Scan request, TotalSegments represents the total number of - // segments into which the Scan operation will be divided. The value of - // TotalSegments corresponds to the number of application workers that will perform - // the parallel scan. For example, if you want to use four application threads to - // scan a table or an index, specify a TotalSegments value of 4. The value for - // TotalSegments must be greater than or equal to 1, and less than or equal to - // 1000000. If you specify a TotalSegments value of 1, the Scan operation will be - // sequential rather than parallel. If you specify TotalSegments, you must also - // specify Segment. - TotalSegments *int32 + // This is a legacy parameter. Use FilterExpression instead. For more information, + // see ConditionalOperator + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) + // in the Amazon DynamoDB Developer Guide. + ConditionalOperator types.ConditionalOperator // A Boolean value that determines the read consistency model during the scan: // @@ -175,55 +117,13 @@ type ScanInput struct { // a ValidationException. ConsistentRead *bool - // A string that identifies one or more attributes to retrieve from the specified - // table or index. These attributes can include scalars, sets, or elements of a - // JSON document. The attributes in the expression must be separated by commas. If - // no attribute names are specified, then all attributes will be returned. If any - // of the requested attributes are not found, they will not appear in the result. - // For more information, see Specifying Item Attributes - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) - // in the Amazon DynamoDB Developer Guide. - ProjectionExpression *string - - // This is a legacy parameter. Use FilterExpression instead. For more information, - // see ScanFilter - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html) - // in the Amazon DynamoDB Developer Guide. - ScanFilter map[string]*types.Condition - - // The name of a secondary index to scan. This index can be any local secondary - // index or global secondary index. Note that if you use the IndexName parameter, - // you must also provide TableName. - IndexName *string - - // Determines the level of detail about provisioned throughput consumption that is - // returned in the response: - // - // * INDEXES - The response includes the aggregate - // ConsumedCapacity for the operation, together with ConsumedCapacity for each - // table and secondary index that was accessed. Note that some operations, such as - // GetItem and BatchGetItem, do not access any indexes at all. In these cases, - // specifying INDEXES will only return ConsumedCapacity information for table(s). - // - // - // * TOTAL - The response includes only the aggregate ConsumedCapacity for the - // operation. - // - // * NONE - No ConsumedCapacity details are included in the - // response. - ReturnConsumedCapacity types.ReturnConsumedCapacity - - // The name of the table containing the requested items; or, if you provide - // IndexName, the name of the table to which that index belongs. - // - // This member is required. - TableName *string - - // This is a legacy parameter. Use ProjectionExpression instead. For more - // information, see AttributesToGet - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html) - // in the Amazon DynamoDB Developer Guide. - AttributesToGet []*string + // The primary key of the first item that this operation will evaluate. Use the + // value that was returned for LastEvaluatedKey in the previous operation. The data + // type for ExclusiveStartKey must be String, Number or Binary. No set data types + // are allowed. In a parallel scan, a Scan request that includes ExclusiveStartKey + // must specify the same segment whose previous Scan returned the corresponding + // value of LastEvaluatedKey. + ExclusiveStartKey map[string]*types.AttributeValue // One or more substitution tokens for attribute names in an expression. The // following are some use cases for using ExpressionAttributeNames: @@ -266,6 +166,19 @@ type ScanInput struct { // in the Amazon DynamoDB Developer Guide. ExpressionAttributeNames map[string]*string + // One or more values that can be substituted in an expression. Use the : (colon) + // character in an expression to dereference an attribute value. For example, + // suppose that you wanted to check whether the value of the ProductStatus + // attribute was one of the following: Available | Backordered | Discontinued You + // would first need to specify ExpressionAttributeValues as follows: { + // ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, + // ":disc":{"S":"Discontinued"} } You could then use these values in an expression, + // such as this: ProductStatus IN (:avail, :back, :disc) For more information on + // expression attribute values, see Condition Expressions + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) + // in the Amazon DynamoDB Developer Guide. + ExpressionAttributeValues map[string]*types.AttributeValue + // A string that contains conditions that DynamoDB applies after the Scan // operation, but before the data is returned to you. Items that do not satisfy the // FilterExpression criteria are not returned. A FilterExpression is applied after @@ -275,19 +188,10 @@ type ScanInput struct { // in the Amazon DynamoDB Developer Guide. FilterExpression *string - // The primary key of the first item that this operation will evaluate. Use the - // value that was returned for LastEvaluatedKey in the previous operation. The data - // type for ExclusiveStartKey must be String, Number or Binary. No set data types - // are allowed. In a parallel scan, a Scan request that includes ExclusiveStartKey - // must specify the same segment whose previous Scan returned the corresponding - // value of LastEvaluatedKey. - ExclusiveStartKey map[string]*types.AttributeValue - - // This is a legacy parameter. Use FilterExpression instead. For more information, - // see ConditionalOperator - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) - // in the Amazon DynamoDB Developer Guide. - ConditionalOperator types.ConditionalOperator + // The name of a secondary index to scan. This index can be any local secondary + // index or global secondary index. Note that if you use the IndexName parameter, + // you must also provide TableName. + IndexName *string // The maximum number of items to evaluate (not necessarily the number of matching // items). If DynamoDB processes the number of items up to the limit while @@ -301,14 +205,115 @@ type ScanInput struct { // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html) // in the Amazon DynamoDB Developer Guide. Limit *int32 + + // A string that identifies one or more attributes to retrieve from the specified + // table or index. These attributes can include scalars, sets, or elements of a + // JSON document. The attributes in the expression must be separated by commas. If + // no attribute names are specified, then all attributes will be returned. If any + // of the requested attributes are not found, they will not appear in the result. + // For more information, see Specifying Item Attributes + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) + // in the Amazon DynamoDB Developer Guide. + ProjectionExpression *string + + // Determines the level of detail about provisioned throughput consumption that is + // returned in the response: + // + // * INDEXES - The response includes the aggregate + // ConsumedCapacity for the operation, together with ConsumedCapacity for each + // table and secondary index that was accessed. Note that some operations, such as + // GetItem and BatchGetItem, do not access any indexes at all. In these cases, + // specifying INDEXES will only return ConsumedCapacity information for table(s). + // + // + // * TOTAL - The response includes only the aggregate ConsumedCapacity for the + // operation. + // + // * NONE - No ConsumedCapacity details are included in the + // response. + ReturnConsumedCapacity types.ReturnConsumedCapacity + + // This is a legacy parameter. Use FilterExpression instead. For more information, + // see ScanFilter + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html) + // in the Amazon DynamoDB Developer Guide. + ScanFilter map[string]*types.Condition + + // For a parallel Scan request, Segment identifies an individual segment to be + // scanned by an application worker. Segment IDs are zero-based, so the first + // segment is always 0. For example, if you want to use four application threads to + // scan a table or an index, then the first thread specifies a Segment value of 0, + // the second thread specifies 1, and so on. The value of LastEvaluatedKey returned + // from a parallel Scan request must be used as ExclusiveStartKey with the same + // segment ID in a subsequent Scan operation. The value for Segment must be greater + // than or equal to 0, and less than the value provided for TotalSegments. If you + // provide Segment, you must also provide TotalSegments. + Segment *int32 + + // The attributes to be returned in the result. You can retrieve all item + // attributes, specific item attributes, the count of matching items, or in the + // case of an index, some or all of the attributes projected into the index. + // + // * + // ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or + // index. If you query a local secondary index, then for each matching item in the + // index, DynamoDB fetches the entire item from the parent table. If the index is + // configured to project all item attributes, then all of the data can be obtained + // from the local secondary index, and no fetching is required. + // + // * + // ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all + // attributes that have been projected into the index. If the index is configured + // to project all attributes, this return value is equivalent to specifying + // ALL_ATTRIBUTES. + // + // * COUNT - Returns the number of matching items, rather than + // the matching items themselves. + // + // * SPECIFIC_ATTRIBUTES - Returns only the + // attributes listed in AttributesToGet. This return value is equivalent to + // specifying AttributesToGet without specifying any value for Select. If you query + // or scan a local secondary index and request only attributes that are projected + // into that index, the operation reads only the index and not the table. If any of + // the requested attributes are not projected into the local secondary index, + // DynamoDB fetches each of these attributes from the parent table. This extra + // fetching incurs additional throughput cost and latency. If you query or scan a + // global secondary index, you can only request attributes that are projected into + // the index. Global secondary index queries cannot fetch attributes from the + // parent table. + // + // If neither Select nor AttributesToGet are specified, DynamoDB + // defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES + // when accessing an index. You cannot use both Select and AttributesToGet together + // in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This + // usage is equivalent to specifying AttributesToGet without any value for Select.) + // If you use the ProjectionExpression parameter, then the value for Select can + // only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error. + Select types.Select + + // For a parallel Scan request, TotalSegments represents the total number of + // segments into which the Scan operation will be divided. The value of + // TotalSegments corresponds to the number of application workers that will perform + // the parallel scan. For example, if you want to use four application threads to + // scan a table or an index, specify a TotalSegments value of 4. The value for + // TotalSegments must be greater than or equal to 1, and less than or equal to + // 1000000. If you specify a TotalSegments value of 1, the Scan operation will be + // sequential rather than parallel. If you specify TotalSegments, you must also + // specify Segment. + TotalSegments *int32 } // Represents the output of a Scan operation. type ScanOutput struct { - // An array of item attributes that match the scan criteria. Each element in this - // array consists of an attribute name and the value for that attribute. - Items []map[string]*types.AttributeValue + // The capacity units consumed by the Scan operation. The data returned includes + // the total provisioned throughput consumed, along with statistics for the table + // and any indexes involved in the operation. ConsumedCapacity is only returned if + // the ReturnConsumedCapacity parameter was specified. For more information, see + // Provisioned Throughput + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) + // in the Amazon DynamoDB Developer Guide. + ConsumedCapacity *types.ConsumedCapacity // The number of items in the response. If you set ScanFilter in the request, then // Count is the number of items returned after the filter was applied, and @@ -316,13 +321,9 @@ type ScanOutput struct { // you did not use a filter in the request, then Count is the same as ScannedCount. Count *int32 - // The number of items evaluated, before any ScanFilter is applied. A high - // ScannedCount value with few, or no, Count results indicates an inefficient Scan - // operation. For more information, see Count and ScannedCount - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count) - // in the Amazon DynamoDB Developer Guide. If you did not use a filter in the - // request, then ScannedCount is the same as Count. - ScannedCount *int32 + // An array of item attributes that match the scan criteria. Each element in this + // array consists of an attribute name and the value for that attribute. + Items []map[string]*types.AttributeValue // The primary key of the item where the operation stopped, inclusive of the // previous result set. Use this value to start a new operation, excluding this @@ -333,14 +334,13 @@ type ScanOutput struct { // the result set is when LastEvaluatedKey is empty. LastEvaluatedKey map[string]*types.AttributeValue - // The capacity units consumed by the Scan operation. The data returned includes - // the total provisioned throughput consumed, along with statistics for the table - // and any indexes involved in the operation. ConsumedCapacity is only returned if - // the ReturnConsumedCapacity parameter was specified. For more information, see - // Provisioned Throughput - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) - // in the Amazon DynamoDB Developer Guide. - ConsumedCapacity *types.ConsumedCapacity + // The number of items evaluated, before any ScanFilter is applied. A high + // ScannedCount value with few, or no, Count results indicates an inefficient Scan + // operation. For more information, see Count and ScannedCount + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count) + // in the Amazon DynamoDB Developer Guide. If you did not use a filter in the + // request, then ScannedCount is the same as Count. + ScannedCount *int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/dynamodb/api_op_TagResource.go b/service/dynamodb/api_op_TagResource.go index 05dddbd4844..4d5997f1640 100644 --- a/service/dynamodb/api_op_TagResource.go +++ b/service/dynamodb/api_op_TagResource.go @@ -65,16 +65,16 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The tags to be assigned to the Amazon DynamoDB resource. - // - // This member is required. - Tags []*types.Tag - // Identifies the Amazon DynamoDB resource to which tags should be added. This // value is an Amazon Resource Name (ARN). // // This member is required. ResourceArn *string + + // The tags to be assigned to the Amazon DynamoDB resource. + // + // This member is required. + Tags []*types.Tag } type TagResourceOutput struct { diff --git a/service/dynamodb/api_op_UpdateContinuousBackups.go b/service/dynamodb/api_op_UpdateContinuousBackups.go index c43a3bfc30a..ba71b2ba7c7 100644 --- a/service/dynamodb/api_op_UpdateContinuousBackups.go +++ b/service/dynamodb/api_op_UpdateContinuousBackups.go @@ -67,15 +67,15 @@ func (c *Client) UpdateContinuousBackups(ctx context.Context, params *UpdateCont type UpdateContinuousBackupsInput struct { - // The name of the table. + // Represents the settings used to enable point in time recovery. // // This member is required. - TableName *string + PointInTimeRecoverySpecification *types.PointInTimeRecoverySpecification - // Represents the settings used to enable point in time recovery. + // The name of the table. // // This member is required. - PointInTimeRecoverySpecification *types.PointInTimeRecoverySpecification + TableName *string } type UpdateContinuousBackupsOutput struct { diff --git a/service/dynamodb/api_op_UpdateContributorInsights.go b/service/dynamodb/api_op_UpdateContributorInsights.go index b50b3169915..ee36da107a8 100644 --- a/service/dynamodb/api_op_UpdateContributorInsights.go +++ b/service/dynamodb/api_op_UpdateContributorInsights.go @@ -78,12 +78,12 @@ type UpdateContributorInsightsOutput struct { // The status of contributor insights ContributorInsightsStatus types.ContributorInsightsStatus - // The name of the table. - TableName *string - // The name of the global secondary index, if applicable. IndexName *string + // The name of the table. + TableName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/dynamodb/api_op_UpdateGlobalTableSettings.go b/service/dynamodb/api_op_UpdateGlobalTableSettings.go index 82c1d872160..f97f455bbd4 100644 --- a/service/dynamodb/api_op_UpdateGlobalTableSettings.go +++ b/service/dynamodb/api_op_UpdateGlobalTableSettings.go @@ -59,16 +59,10 @@ func (c *Client) UpdateGlobalTableSettings(ctx context.Context, params *UpdateGl type UpdateGlobalTableSettingsInput struct { - // Represents the settings of a global secondary index for a global table that will - // be modified. - GlobalTableGlobalSecondaryIndexSettingsUpdate []*types.GlobalTableGlobalSecondaryIndexSettingsUpdate - - // Represents the settings for a global table in a Region that will be modified. - ReplicaSettingsUpdate []*types.ReplicaSettingsUpdate - - // Auto scaling settings for managing provisioned write capacity for the global - // table. - GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate *types.AutoScalingSettingsUpdate + // The name of the global table + // + // This member is required. + GlobalTableName *string // The billing mode of the global table. If GlobalTableBillingMode is not // specified, the global table defaults to PROVISIONED capacity billing mode. @@ -84,24 +78,30 @@ type UpdateGlobalTableSettingsInput struct { // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand). GlobalTableBillingMode types.BillingMode - // The name of the global table - // - // This member is required. - GlobalTableName *string + // Represents the settings of a global secondary index for a global table that will + // be modified. + GlobalTableGlobalSecondaryIndexSettingsUpdate []*types.GlobalTableGlobalSecondaryIndexSettingsUpdate + + // Auto scaling settings for managing provisioned write capacity for the global + // table. + GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate *types.AutoScalingSettingsUpdate // The maximum number of writes consumed per second before DynamoDB returns a // ThrottlingException. GlobalTableProvisionedWriteCapacityUnits *int64 + + // Represents the settings for a global table in a Region that will be modified. + ReplicaSettingsUpdate []*types.ReplicaSettingsUpdate } type UpdateGlobalTableSettingsOutput struct { - // The Region-specific settings for the global table. - ReplicaSettings []*types.ReplicaSettingsDescription - // The name of the global table. GlobalTableName *string + // The Region-specific settings for the global table. + ReplicaSettings []*types.ReplicaSettingsDescription + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/dynamodb/api_op_UpdateItem.go b/service/dynamodb/api_op_UpdateItem.go index 48460a096d4..32c716981bb 100644 --- a/service/dynamodb/api_op_UpdateItem.go +++ b/service/dynamodb/api_op_UpdateItem.go @@ -66,38 +66,56 @@ func (c *Client) UpdateItem(ctx context.Context, params *UpdateItemInput, optFns // Represents the input of an UpdateItem operation. type UpdateItemInput struct { - // Determines whether item collection metrics are returned. If set to SIZE, the - // response includes statistics about item collections, if any, that were modified - // during the operation are returned in the response. If set to NONE (the default), - // no statistics are returned. - ReturnItemCollectionMetrics types.ReturnItemCollectionMetrics - - // Use ReturnValues if you want to get the item attributes as they appear before or - // after they are updated. For UpdateItem, the valid values are: - // - // * NONE - If - // ReturnValues is not specified, or if its value is NONE, then nothing is - // returned. (This setting is the default for ReturnValues.) + // The primary key of the item to be updated. Each element consists of an attribute + // name and a value for that attribute. For the primary key, you must provide all + // of the attributes. For example, with a simple primary key, you only need to + // provide a value for the partition key. For a composite primary key, you must + // provide values for both the partition key and the sort key. // - // * ALL_OLD - - // Returns all of the attributes of the item, as they appeared before the - // UpdateItem operation. + // This member is required. + Key map[string]*types.AttributeValue + + // The name of the table containing the item to update. // - // * UPDATED_OLD - Returns only the updated attributes, - // as they appeared before the UpdateItem operation. + // This member is required. + TableName *string + + // This is a legacy parameter. Use UpdateExpression instead. For more information, + // see AttributeUpdates + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributeUpdates.html) + // in the Amazon DynamoDB Developer Guide. + AttributeUpdates map[string]*types.AttributeValueUpdate + + // A condition that must be satisfied in order for a conditional update to succeed. + // An expression can contain any of the following: // - // * ALL_NEW - Returns all - // of the attributes of the item, as they appear after the UpdateItem operation. + // * Functions: + // attribute_exists | attribute_not_exists | attribute_type | contains | + // begins_with | size These function names are case-sensitive. // + // * Comparison + // operators: = | <> | < | > | <= | >= | BETWEEN | IN // - // * UPDATED_NEW - Returns only the updated attributes, as they appear after the - // UpdateItem operation. + // * Logical operators: AND + // | OR | NOT // - // There is no additional cost associated with requesting a - // return value aside from the small network and processing overhead of receiving a - // larger response. No read capacity units are consumed. The values returned are - // strongly consistent. - ReturnValues types.ReturnValue + // For more information about condition expressions, see Specifying + // Conditions + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) + // in the Amazon DynamoDB Developer Guide. + ConditionExpression *string + + // This is a legacy parameter. Use ConditionExpression instead. For more + // information, see ConditionalOperator + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) + // in the Amazon DynamoDB Developer Guide. + ConditionalOperator types.ConditionalOperator + + // This is a legacy parameter. Use ConditionExpression instead. For more + // information, see Expected + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html) + // in the Amazon DynamoDB Developer Guide. + Expected map[string]*types.ExpectedAttributeValue // One or more substitution tokens for attribute names in an expression. The // following are some use cases for using ExpressionAttributeNames: @@ -140,6 +158,69 @@ type UpdateItemInput struct { // in the Amazon DynamoDB Developer Guide. ExpressionAttributeNames map[string]*string + // One or more values that can be substituted in an expression. Use the : (colon) + // character in an expression to dereference an attribute value. For example, + // suppose that you wanted to check whether the value of the ProductStatus + // attribute was one of the following: Available | Backordered | Discontinued You + // would first need to specify ExpressionAttributeValues as follows: { + // ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, + // ":disc":{"S":"Discontinued"} } You could then use these values in an expression, + // such as this: ProductStatus IN (:avail, :back, :disc) For more information on + // expression attribute values, see Condition Expressions + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) + // in the Amazon DynamoDB Developer Guide. + ExpressionAttributeValues map[string]*types.AttributeValue + + // Determines the level of detail about provisioned throughput consumption that is + // returned in the response: + // + // * INDEXES - The response includes the aggregate + // ConsumedCapacity for the operation, together with ConsumedCapacity for each + // table and secondary index that was accessed. Note that some operations, such as + // GetItem and BatchGetItem, do not access any indexes at all. In these cases, + // specifying INDEXES will only return ConsumedCapacity information for table(s). + // + // + // * TOTAL - The response includes only the aggregate ConsumedCapacity for the + // operation. + // + // * NONE - No ConsumedCapacity details are included in the + // response. + ReturnConsumedCapacity types.ReturnConsumedCapacity + + // Determines whether item collection metrics are returned. If set to SIZE, the + // response includes statistics about item collections, if any, that were modified + // during the operation are returned in the response. If set to NONE (the default), + // no statistics are returned. + ReturnItemCollectionMetrics types.ReturnItemCollectionMetrics + + // Use ReturnValues if you want to get the item attributes as they appear before or + // after they are updated. For UpdateItem, the valid values are: + // + // * NONE - If + // ReturnValues is not specified, or if its value is NONE, then nothing is + // returned. (This setting is the default for ReturnValues.) + // + // * ALL_OLD - + // Returns all of the attributes of the item, as they appeared before the + // UpdateItem operation. + // + // * UPDATED_OLD - Returns only the updated attributes, + // as they appeared before the UpdateItem operation. + // + // * ALL_NEW - Returns all + // of the attributes of the item, as they appear after the UpdateItem operation. + // + // + // * UPDATED_NEW - Returns only the updated attributes, as they appear after the + // UpdateItem operation. + // + // There is no additional cost associated with requesting a + // return value aside from the small network and processing overhead of receiving a + // larger response. No read capacity units are consumed. The values returned are + // strongly consistent. + ReturnValues types.ReturnValue + // An expression that defines one or more attributes to be updated, the action to // be performed on them, and new values for them. The following action values are // available for UpdateExpression. @@ -208,87 +289,6 @@ type UpdateItemInput struct { // href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Modifying.html">Modifying // Items and Attributes in the Amazon DynamoDB Developer Guide.

    UpdateExpression *string - - // A condition that must be satisfied in order for a conditional update to succeed. - // An expression can contain any of the following: - // - // * Functions: - // attribute_exists | attribute_not_exists | attribute_type | contains | - // begins_with | size These function names are case-sensitive. - // - // * Comparison - // operators: = | <> | < | > | <= | >= | BETWEEN | IN - // - // * Logical operators: AND - // | OR | NOT - // - // For more information about condition expressions, see Specifying - // Conditions - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) - // in the Amazon DynamoDB Developer Guide. - ConditionExpression *string - - // This is a legacy parameter. Use ConditionExpression instead. For more - // information, see ConditionalOperator - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) - // in the Amazon DynamoDB Developer Guide. - ConditionalOperator types.ConditionalOperator - - // One or more values that can be substituted in an expression. Use the : (colon) - // character in an expression to dereference an attribute value. For example, - // suppose that you wanted to check whether the value of the ProductStatus - // attribute was one of the following: Available | Backordered | Discontinued You - // would first need to specify ExpressionAttributeValues as follows: { - // ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, - // ":disc":{"S":"Discontinued"} } You could then use these values in an expression, - // such as this: ProductStatus IN (:avail, :back, :disc) For more information on - // expression attribute values, see Condition Expressions - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) - // in the Amazon DynamoDB Developer Guide. - ExpressionAttributeValues map[string]*types.AttributeValue - - // Determines the level of detail about provisioned throughput consumption that is - // returned in the response: - // - // * INDEXES - The response includes the aggregate - // ConsumedCapacity for the operation, together with ConsumedCapacity for each - // table and secondary index that was accessed. Note that some operations, such as - // GetItem and BatchGetItem, do not access any indexes at all. In these cases, - // specifying INDEXES will only return ConsumedCapacity information for table(s). - // - // - // * TOTAL - The response includes only the aggregate ConsumedCapacity for the - // operation. - // - // * NONE - No ConsumedCapacity details are included in the - // response. - ReturnConsumedCapacity types.ReturnConsumedCapacity - - // This is a legacy parameter. Use UpdateExpression instead. For more information, - // see AttributeUpdates - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributeUpdates.html) - // in the Amazon DynamoDB Developer Guide. - AttributeUpdates map[string]*types.AttributeValueUpdate - - // The primary key of the item to be updated. Each element consists of an attribute - // name and a value for that attribute. For the primary key, you must provide all - // of the attributes. For example, with a simple primary key, you only need to - // provide a value for the partition key. For a composite primary key, you must - // provide values for both the partition key and the sort key. - // - // This member is required. - Key map[string]*types.AttributeValue - - // This is a legacy parameter. Use ConditionExpression instead. For more - // information, see Expected - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html) - // in the Amazon DynamoDB Developer Guide. - Expected map[string]*types.ExpectedAttributeValue - - // The name of the table containing the item to update. - // - // This member is required. - TableName *string } // Represents the output of an UpdateItem operation. @@ -300,6 +300,15 @@ type UpdateItemOutput struct { // request. Each element represents one attribute. Attributes map[string]*types.AttributeValue + // The capacity units consumed by the UpdateItem operation. The data returned + // includes the total provisioned throughput consumed, along with statistics for + // the table and any indexes involved in the operation. ConsumedCapacity is only + // returned if the ReturnConsumedCapacity parameter was specified. For more + // information, see Provisioned Throughput + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) + // in the Amazon DynamoDB Developer Guide. + ConsumedCapacity *types.ConsumedCapacity + // Information about item collections, if any, that were affected by the UpdateItem // operation. ItemCollectionMetrics is only returned if the // ReturnItemCollectionMetrics parameter was specified. If the table does not have @@ -320,15 +329,6 @@ type UpdateItemOutput struct { // of the estimate. ItemCollectionMetrics *types.ItemCollectionMetrics - // The capacity units consumed by the UpdateItem operation. The data returned - // includes the total provisioned throughput consumed, along with statistics for - // the table and any indexes involved in the operation. ConsumedCapacity is only - // returned if the ReturnConsumedCapacity parameter was specified. For more - // information, see Provisioned Throughput - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) - // in the Amazon DynamoDB Developer Guide. - ConsumedCapacity *types.ConsumedCapacity - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/dynamodb/api_op_UpdateTable.go b/service/dynamodb/api_op_UpdateTable.go index 857d715e784..c72d480345a 100644 --- a/service/dynamodb/api_op_UpdateTable.go +++ b/service/dynamodb/api_op_UpdateTable.go @@ -80,9 +80,6 @@ func (c *Client) UpdateTable(ctx context.Context, params *UpdateTableInput, optF // Represents the input of an UpdateTable operation. type UpdateTableInput struct { - // The new server-side encryption settings for the specified table. - SSESpecification *types.SSESpecification - // The name of the table to be updated. // // This member is required. @@ -93,6 +90,23 @@ type UpdateTableInput struct { // AttributeDefinitions must include the key element(s) of the new index. AttributeDefinitions []*types.AttributeDefinition + // Controls how you are charged for read and write throughput and how you manage + // capacity. When switching from pay-per-request to provisioned capacity, initial + // provisioned capacity values must be set. The initial provisioned capacity values + // are estimated based on the consumed read and write capacity of your table and + // global secondary indexes over the past 30 minutes. + // + // * PROVISIONED - We + // recommend using PROVISIONED for predictable workloads. PROVISIONED sets the + // billing mode to Provisioned Mode + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual). + // + // + // * PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable + // workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand). + BillingMode types.BillingMode + // An array of one or more global secondary indexes for the table. For each index // in the array, you can request one action: // @@ -112,23 +126,6 @@ type UpdateTableInput struct { // in the Amazon DynamoDB Developer Guide. GlobalSecondaryIndexUpdates []*types.GlobalSecondaryIndexUpdate - // Controls how you are charged for read and write throughput and how you manage - // capacity. When switching from pay-per-request to provisioned capacity, initial - // provisioned capacity values must be set. The initial provisioned capacity values - // are estimated based on the consumed read and write capacity of your table and - // global secondary indexes over the past 30 minutes. - // - // * PROVISIONED - We - // recommend using PROVISIONED for predictable workloads. PROVISIONED sets the - // billing mode to Provisioned Mode - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual). - // - // - // * PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable - // workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand). - BillingMode types.BillingMode - // The new provisioned throughput settings for the specified table or index. ProvisionedThroughput *types.ProvisionedThroughput @@ -138,6 +135,9 @@ type UpdateTableInput struct { // of global tables. ReplicaUpdates []*types.ReplicationGroupUpdate + // The new server-side encryption settings for the specified table. + SSESpecification *types.SSESpecification + // Represents the DynamoDB Streams configuration for the table. You receive a // ResourceInUseException if you try to enable a stream on a table that already has // a stream, or if you try to disable a stream on a table that doesn't have a diff --git a/service/dynamodb/api_op_UpdateTableReplicaAutoScaling.go b/service/dynamodb/api_op_UpdateTableReplicaAutoScaling.go index 9576bcf1b44..8ced8219cba 100644 --- a/service/dynamodb/api_op_UpdateTableReplicaAutoScaling.go +++ b/service/dynamodb/api_op_UpdateTableReplicaAutoScaling.go @@ -62,14 +62,6 @@ func (c *Client) UpdateTableReplicaAutoScaling(ctx context.Context, params *Upda type UpdateTableReplicaAutoScalingInput struct { - // Represents the auto scaling settings of replicas of the table that will be - // modified. - ReplicaUpdates []*types.ReplicaAutoScalingUpdate - - // Represents the auto scaling settings to be modified for a global table or global - // secondary index. - ProvisionedWriteCapacityAutoScalingUpdate *types.AutoScalingSettingsUpdate - // The name of the global table to be updated. // // This member is required. @@ -78,6 +70,14 @@ type UpdateTableReplicaAutoScalingInput struct { // Represents the auto scaling settings of the global secondary indexes of the // replica to be updated. GlobalSecondaryIndexUpdates []*types.GlobalSecondaryIndexAutoScalingUpdate + + // Represents the auto scaling settings to be modified for a global table or global + // secondary index. + ProvisionedWriteCapacityAutoScalingUpdate *types.AutoScalingSettingsUpdate + + // Represents the auto scaling settings of replicas of the table that will be + // modified. + ReplicaUpdates []*types.ReplicaAutoScalingUpdate } type UpdateTableReplicaAutoScalingOutput struct { diff --git a/service/dynamodb/api_op_UpdateTimeToLive.go b/service/dynamodb/api_op_UpdateTimeToLive.go index ec6f9bceb25..66702b91521 100644 --- a/service/dynamodb/api_op_UpdateTimeToLive.go +++ b/service/dynamodb/api_op_UpdateTimeToLive.go @@ -78,16 +78,16 @@ func (c *Client) UpdateTimeToLive(ctx context.Context, params *UpdateTimeToLiveI // Represents the input of an UpdateTimeToLive operation. type UpdateTimeToLiveInput struct { - // Represents the settings used to enable or disable Time to Live for the specified - // table. + // The name of the table to be configured. // // This member is required. - TimeToLiveSpecification *types.TimeToLiveSpecification + TableName *string - // The name of the table to be configured. + // Represents the settings used to enable or disable Time to Live for the specified + // table. // // This member is required. - TableName *string + TimeToLiveSpecification *types.TimeToLiveSpecification } type UpdateTimeToLiveOutput struct { diff --git a/service/dynamodb/go.mod b/service/dynamodb/go.mod index 2b83e2f9fc3..b2726e2a5a7 100644 --- a/service/dynamodb/go.mod +++ b/service/dynamodb/go.mod @@ -3,8 +3,8 @@ module github.com/aws/aws-sdk-go-v2/service/dynamodb go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 - github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v0.1.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 + github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v0.0.0-20200930084954-897dfb99530c github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/dynamodb/types/types.go b/service/dynamodb/types/types.go index a3a75720d81..b368007a6d7 100644 --- a/service/dynamodb/types/types.go +++ b/service/dynamodb/types/types.go @@ -9,12 +9,6 @@ import ( // Contains details of a table archival operation. type ArchivalSummary struct { - // The reason DynamoDB archived the table. Currently, the only possible value is: - //

    • INACCESSIBLE_ENCRYPTION_CREDENTIALS - The table was - // archived due to the table's AWS KMS key being inaccessible for more than seven - // days. An On-Demand backup was created at the archival time.

    - ArchivalReason *string - // The Amazon Resource Name (ARN) of the backup the table was archived to, when // applicable in the archival reason. If you wish to restore this backup to the // same table name, you will need to delete the original table. @@ -23,11 +17,22 @@ type ArchivalSummary struct { // The date and time when table archival was initiated by DynamoDB, in UNIX epoch // time format. ArchivalDateTime *time.Time + + // The reason DynamoDB archived the table. Currently, the only possible value is: + //

    • INACCESSIBLE_ENCRYPTION_CREDENTIALS - The table was + // archived due to the table's AWS KMS key being inaccessible for more than seven + // days. An On-Demand backup was created at the archival time.

    + ArchivalReason *string } // Represents an attribute for describing the key schema for the table and indexes. type AttributeDefinition struct { + // A name for the attribute. + // + // This member is required. + AttributeName *string + // The data type for the attribute, where: // // * S - the attribute is of type @@ -40,11 +45,6 @@ type AttributeDefinition struct { // // This member is required. AttributeType ScalarAttributeType - - // A name for the attribute. - // - // This member is required. - AttributeName *string } // Represents the data for an attribute. Each attribute value is described as a @@ -54,46 +54,46 @@ type AttributeDefinition struct { // in the Amazon DynamoDB Developer Guide. type AttributeValue struct { + // An attribute of type Binary. For example: "B": + // "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk" + B []byte + // An attribute of type Boolean. For example: "BOOL": true BOOL *bool - // An attribute of type Number Set. For example: "NS": ["42.2", "-19", "7.5", - // "3.14"] Numbers are sent across the network to DynamoDB as strings, to maximize - // compatibility across languages and libraries. However, DynamoDB treats them as - // number type attributes for mathematical operations. - NS []*string - // An attribute of type Binary Set. For example: "BS": ["U3Vubnk=", "UmFpbnk=", // "U25vd3k="] BS [][]byte - // An attribute of type Null. For example: "NULL": true - NULL *bool - - // An attribute of type String Set. For example: "SS": ["Giraffe", "Hippo" - // ,"Zebra"] - SS []*string - - // An attribute of type String. For example: "S": "Hello" - S *string - - // An attribute of type Binary. For example: "B": - // "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk" - B []byte + // An attribute of type List. For example: "L": [ {"S": "Cookies"} , {"S": + // "Coffee"}, {"N", "3.14159"}] + L []*AttributeValue // An attribute of type Map. For example: "M": {"Name": {"S": "Joe"}, "Age": {"N": // "35"}} M map[string]*AttributeValue - // An attribute of type List. For example: "L": [ {"S": "Cookies"} , {"S": - // "Coffee"}, {"N", "3.14159"}] - L []*AttributeValue - // An attribute of type Number. For example: "N": "123.45" Numbers are sent across // the network to DynamoDB as strings, to maximize compatibility across languages // and libraries. However, DynamoDB treats them as number type attributes for // mathematical operations. N *string + + // An attribute of type Number Set. For example: "NS": ["42.2", "-19", "7.5", + // "3.14"] Numbers are sent across the network to DynamoDB as strings, to maximize + // compatibility across languages and libraries. However, DynamoDB treats them as + // number type attributes for mathematical operations. + NS []*string + + // An attribute of type Null. For example: "NULL": true + NULL *bool + + // An attribute of type String. For example: "S": "Hello" + S *string + + // An attribute of type String Set. For example: "SS": ["Giraffe", "Hippo" + // ,"Zebra"] + SS []*string } // For the UpdateItem operation, represents the attributes to be modified, the @@ -177,21 +177,24 @@ type AutoScalingPolicyDescription struct { // Represents the auto scaling policy to be modified. type AutoScalingPolicyUpdate struct { - // The name of the scaling policy. - PolicyName *string - // Represents a target tracking scaling policy configuration. // // This member is required. TargetTrackingScalingPolicyConfiguration *AutoScalingTargetTrackingScalingPolicyConfigurationUpdate + + // The name of the scaling policy. + PolicyName *string } // Represents the auto scaling settings for a global table or global secondary // index. type AutoScalingSettingsDescription struct { - // Information about the scaling policies. - ScalingPolicies []*AutoScalingPolicyDescription + // Disabled auto scaling for this global table or global secondary index. + AutoScalingDisabled *bool + + // Role ARN used for configuring the auto scaling policy. + AutoScalingRoleArn *string // The maximum capacity units that a global table or global secondary index should // be scaled up to. @@ -201,11 +204,8 @@ type AutoScalingSettingsDescription struct { // be scaled down to. MinimumUnits *int64 - // Disabled auto scaling for this global table or global secondary index. - AutoScalingDisabled *bool - - // Role ARN used for configuring the auto scaling policy. - AutoScalingRoleArn *string + // Information about the scaling policies. + ScalingPolicies []*AutoScalingPolicyDescription } // Represents the auto scaling settings to be modified for a global table or global @@ -215,6 +215,13 @@ type AutoScalingSettingsUpdate struct { // Disabled auto scaling for this global table or global secondary index. AutoScalingDisabled *bool + // Role ARN used for configuring auto scaling policy. + AutoScalingRoleArn *string + + // The maximum capacity units that a global table or global secondary index should + // be scaled up to. + MaximumUnits *int64 + // The minimum capacity units that a global table or global secondary index should // be scaled down to. MinimumUnits *int64 @@ -222,24 +229,23 @@ type AutoScalingSettingsUpdate struct { // The scaling policy to apply for scaling target global table or global secondary // index capacity units. ScalingPolicyUpdate *AutoScalingPolicyUpdate - - // The maximum capacity units that a global table or global secondary index should - // be scaled up to. - MaximumUnits *int64 - - // Role ARN used for configuring auto scaling policy. - AutoScalingRoleArn *string } // Represents the properties of a target tracking scaling policy. type AutoScalingTargetTrackingScalingPolicyConfigurationDescription struct { - // The amount of time, in seconds, after a scale out activity completes before - // another scale out activity can start. While the cooldown period is in effect, - // the capacity that has been added by the previous scale out event that initiated - // the cooldown is calculated as part of the desired capacity for the next scale - // out. You should continuously (but not excessively) scale out. - ScaleOutCooldown *int32 + // The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 + // (Base 10) or 2e-360 to 2e360 (Base 2). + // + // This member is required. + TargetValue *float64 + + // Indicates whether scale in by the target tracking policy is disabled. If the + // value is true, scale in is disabled and the target tracking policy won't remove + // capacity from the scalable resource. Otherwise, scale in is enabled and the + // target tracking policy can remove capacity from the scalable resource. The + // default value is false. + DisableScaleIn *bool // The amount of time, in seconds, after a scale in activity completes before // another scale in activity can start. The cooldown period is used to block @@ -249,30 +255,30 @@ type AutoScalingTargetTrackingScalingPolicyConfigurationDescription struct { // application auto scaling scales out your scalable target immediately. ScaleInCooldown *int32 - // Indicates whether scale in by the target tracking policy is disabled. If the - // value is true, scale in is disabled and the target tracking policy won't remove - // capacity from the scalable resource. Otherwise, scale in is enabled and the - // target tracking policy can remove capacity from the scalable resource. The - // default value is false. - DisableScaleIn *bool + // The amount of time, in seconds, after a scale out activity completes before + // another scale out activity can start. While the cooldown period is in effect, + // the capacity that has been added by the previous scale out event that initiated + // the cooldown is calculated as part of the desired capacity for the next scale + // out. You should continuously (but not excessively) scale out. + ScaleOutCooldown *int32 +} + +// Represents the settings of a target tracking scaling policy that will be +// modified. +type AutoScalingTargetTrackingScalingPolicyConfigurationUpdate struct { // The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 // (Base 10) or 2e-360 to 2e360 (Base 2). // // This member is required. TargetValue *float64 -} -// Represents the settings of a target tracking scaling policy that will be -// modified. -type AutoScalingTargetTrackingScalingPolicyConfigurationUpdate struct { - - // The amount of time, in seconds, after a scale out activity completes before - // another scale out activity can start. While the cooldown period is in effect, - // the capacity that has been added by the previous scale out event that initiated - // the cooldown is calculated as part of the desired capacity for the next scale - // out. You should continuously (but not excessively) scale out. - ScaleOutCooldown *int32 + // Indicates whether scale in by the target tracking policy is disabled. If the + // value is true, scale in is disabled and the target tracking policy won't remove + // capacity from the scalable resource. Otherwise, scale in is enabled and the + // target tracking policy can remove capacity from the scalable resource. The + // default value is false. + DisableScaleIn *bool // The amount of time, in seconds, after a scale in activity completes before // another scale in activity can start. The cooldown period is used to block @@ -282,50 +288,50 @@ type AutoScalingTargetTrackingScalingPolicyConfigurationUpdate struct { // application auto scaling scales out your scalable target immediately. ScaleInCooldown *int32 - // Indicates whether scale in by the target tracking policy is disabled. If the - // value is true, scale in is disabled and the target tracking policy won't remove - // capacity from the scalable resource. Otherwise, scale in is enabled and the - // target tracking policy can remove capacity from the scalable resource. The - // default value is false. - DisableScaleIn *bool - - // The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 - // (Base 10) or 2e-360 to 2e360 (Base 2). - // - // This member is required. - TargetValue *float64 + // The amount of time, in seconds, after a scale out activity completes before + // another scale out activity can start. While the cooldown period is in effect, + // the capacity that has been added by the previous scale out event that initiated + // the cooldown is calculated as part of the desired capacity for the next scale + // out. You should continuously (but not excessively) scale out. + ScaleOutCooldown *int32 } // Contains the description of the backup created for the table. type BackupDescription struct { - // Contains the details of the features enabled on the table when the backup was - // created. For example, LSIs, GSIs, streams, TTL. - SourceTableFeatureDetails *SourceTableFeatureDetails + // Contains the details of the backup created for the table. + BackupDetails *BackupDetails // Contains the details of the table when the backup was created. SourceTableDetails *SourceTableDetails - // Contains the details of the backup created for the table. - BackupDetails *BackupDetails + // Contains the details of the features enabled on the table when the backup was + // created. For example, LSIs, GSIs, streams, TTL. + SourceTableFeatureDetails *SourceTableFeatureDetails } // Contains the details of the backup created for the table. type BackupDetails struct { - // Backup can be in one of the following states: CREATING, ACTIVE, DELETED. + // ARN associated with the backup. // // This member is required. - BackupStatus BackupStatus + BackupArn *string // Time at which the backup was created. This is the request time of the backup. // // This member is required. BackupCreationDateTime *time.Time - // Time at which the automatic on-demand backup created by DynamoDB will expire. - // This SYSTEM on-demand backup expires automatically 35 days after its creation. - BackupExpiryDateTime *time.Time + // Name of the requested backup. + // + // This member is required. + BackupName *string + + // Backup can be in one of the following states: CREATING, ACTIVE, DELETED. + // + // This member is required. + BackupStatus BackupStatus // BackupType: // @@ -343,15 +349,9 @@ type BackupDetails struct { // This member is required. BackupType BackupType - // Name of the requested backup. - // - // This member is required. - BackupName *string - - // ARN associated with the backup. - // - // This member is required. - BackupArn *string + // Time at which the automatic on-demand backup created by DynamoDB will expire. + // This SYSTEM on-demand backup expires automatically 35 days after its creation. + BackupExpiryDateTime *time.Time // Size of the backup in bytes. BackupSizeBytes *int64 @@ -360,24 +360,24 @@ type BackupDetails struct { // Contains details for the backup. type BackupSummary struct { - // Name of the specified backup. - BackupName *string + // ARN associated with the backup. + BackupArn *string + + // Time at which the backup was created. + BackupCreationDateTime *time.Time // Time at which the automatic on-demand backup created by DynamoDB will expire. // This SYSTEM on-demand backup expires automatically 35 days after its creation. BackupExpiryDateTime *time.Time - // ARN associated with the backup. - BackupArn *string - - // Name of the table. - TableName *string + // Name of the specified backup. + BackupName *string - // Unique identifier for the table. - TableId *string + // Size of the backup in bytes. + BackupSizeBytes *int64 - // ARN associated with the table. - TableArn *string + // Backup can be in one of the following states: CREATING, ACTIVE, DELETED. + BackupStatus BackupStatus // BackupType: // @@ -393,23 +393,19 @@ type BackupSummary struct { // On-demand backup created by you from AWS Backup service. BackupType BackupType - // Backup can be in one of the following states: CREATING, ACTIVE, DELETED. - BackupStatus BackupStatus + // ARN associated with the table. + TableArn *string - // Time at which the backup was created. - BackupCreationDateTime *time.Time + // Unique identifier for the table. + TableId *string - // Size of the backup in bytes. - BackupSizeBytes *int64 + // Name of the table. + TableName *string } // Contains the details for the read/write capacity mode. type BillingModeSummary struct { - // Represents the time when PAY_PER_REQUEST was last set as the read/write capacity - // mode. - LastUpdateToPayPerRequestDateTime *time.Time - // Controls how you are charged for read and write throughput and how you manage // capacity. This setting can be changed later. // @@ -421,6 +417,10 @@ type BillingModeSummary struct { // mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable // workloads. BillingMode BillingMode + + // Represents the time when PAY_PER_REQUEST was last set as the read/write capacity + // mode. + LastUpdateToPayPerRequestDateTime *time.Time } // An ordered list of errors for each item in the request which caused the @@ -430,14 +430,14 @@ type BillingModeSummary struct { // present. type CancellationReason struct { - // Cancellation reason message description. - Message *string + // Status code for the result of the cancelled transaction. + Code *string // Item in the request which caused the transaction to get cancelled. Item map[string]*AttributeValue - // Status code for the result of the cancelled transaction. - Code *string + // Cancellation reason message description. + Message *string } // Represents the amount of provisioned throughput capacity consumed on a table or @@ -447,11 +447,11 @@ type Capacity struct { // The total number of capacity units consumed on a table or an index. CapacityUnits *float64 - // The total number of write capacity units consumed on a table or an index. - WriteCapacityUnits *float64 - // The total number of read capacity units consumed on a table or an index. ReadCapacityUnits *float64 + + // The total number of write capacity units consumed on a table or an index. + WriteCapacityUnits *float64 } // Represents the selection criteria for a Query or Scan operation: @@ -468,17 +468,6 @@ type Capacity struct { // values. type Condition struct { - // One or more values to evaluate against the supplied attribute. The number of - // values in the list depends on the ComparisonOperator being used. For type - // Number, value comparisons are numeric. String value comparisons for greater - // than, equals, or less than are based on ASCII character code values. For - // example, a is greater than A, and a is greater than B. For a list of code - // values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters - // (http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters). For Binary, - // DynamoDB treats each byte of the binary data as unsigned when it compares binary - // values. - AttributeValueList []*AttributeValue - // A comparator for evaluating attributes. For example, equals, greater than, less // than, etc. The following comparison operators are available: EQ | NE | LE | LT | // GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN @@ -593,20 +582,23 @@ type Condition struct { // // This member is required. ComparisonOperator ComparisonOperator + + // One or more values to evaluate against the supplied attribute. The number of + // values in the list depends on the ComparisonOperator being used. For type + // Number, value comparisons are numeric. String value comparisons for greater + // than, equals, or less than are based on ASCII character code values. For + // example, a is greater than A, and a is greater than B. For a list of code + // values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters + // (http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters). For Binary, + // DynamoDB treats each byte of the binary data as unsigned when it compares binary + // values. + AttributeValueList []*AttributeValue } // Represents a request to perform a check that an item exists or to check the // condition of specific attributes of the item. type ConditionCheck struct { - // One or more values that can be substituted in an expression. - ExpressionAttributeValues map[string]*AttributeValue - - // Use ReturnValuesOnConditionCheckFailure to get the item attributes if the - // ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure, the - // valid values are: NONE and ALL_OLD. - ReturnValuesOnConditionCheckFailure ReturnValuesOnConditionCheckFailure - // A condition that must be satisfied in order for a conditional update to succeed. // // This member is required. @@ -625,6 +617,14 @@ type ConditionCheck struct { // One or more substitution tokens for attribute names in an expression. ExpressionAttributeNames map[string]*string + + // One or more values that can be substituted in an expression. + ExpressionAttributeValues map[string]*AttributeValue + + // Use ReturnValuesOnConditionCheckFailure to get the item attributes if the + // ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure, the + // valid values are: NONE and ALL_OLD. + ReturnValuesOnConditionCheckFailure ReturnValuesOnConditionCheckFailure } // The capacity units consumed by an operation. The data returned includes the @@ -635,15 +635,6 @@ type ConditionCheck struct { // in the Amazon DynamoDB Developer Guide. type ConsumedCapacity struct { - // The amount of throughput consumed on the table affected by the operation. - Table *Capacity - - // The name of the table that was affected by the operation. - TableName *string - - // The amount of throughput consumed on each local index affected by the operation. - LocalSecondaryIndexes map[string]*Capacity - // The total number of capacity units consumed by the operation. CapacityUnits *float64 @@ -651,9 +642,18 @@ type ConsumedCapacity struct { // operation. GlobalSecondaryIndexes map[string]*Capacity + // The amount of throughput consumed on each local index affected by the operation. + LocalSecondaryIndexes map[string]*Capacity + // The total number of read capacity units consumed by the operation. ReadCapacityUnits *float64 + // The amount of throughput consumed on the table affected by the operation. + Table *Capacity + + // The name of the table that was affected by the operation. + TableName *string + // The total number of write capacity units consumed by the operation. WriteCapacityUnits *float64 } @@ -674,13 +674,13 @@ type ContinuousBackupsDescription struct { // Represents a Contributor Insights summary entry.. type ContributorInsightsSummary struct { - // Name of the index associated with the summary, if any. - IndexName *string - // Describes the current status for contributor insights for the given table and // index, if applicable. ContributorInsightsStatus ContributorInsightsStatus + // Name of the index associated with the summary, if any. + IndexName *string + // Name of the table associated with the summary. TableName *string } @@ -688,13 +688,6 @@ type ContributorInsightsSummary struct { // Represents a new global secondary index to be added to an existing table. type CreateGlobalSecondaryIndexAction struct { - // Represents attributes that are copied (projected) from the table into an index. - // These are in addition to the primary key attributes and index key attributes, - // which are automatically projected. - // - // This member is required. - Projection *Projection - // The name of the global secondary index to be created. // // This member is required. @@ -705,6 +698,13 @@ type CreateGlobalSecondaryIndexAction struct { // This member is required. KeySchema []*KeySchemaElement + // Represents attributes that are copied (projected) from the table into an index. + // These are in addition to the primary key attributes and index key attributes, + // which are automatically projected. + // + // This member is required. + Projection *Projection + // Represents the provisioned throughput settings for the specified global // secondary index. For current minimum and maximum provisioned throughput values, // see Limits @@ -748,26 +748,26 @@ type CreateReplicationGroupMemberAction struct { // Represents a request to perform a DeleteItem operation. type Delete struct { - // Name of the table in which the item to be deleted resides. - // - // This member is required. - TableName *string - - // One or more values that can be substituted in an expression. - ExpressionAttributeValues map[string]*AttributeValue - // The primary key of the item to be deleted. Each element consists of an attribute // name and a value for that attribute. // // This member is required. Key map[string]*AttributeValue + // Name of the table in which the item to be deleted resides. + // + // This member is required. + TableName *string + // A condition that must be satisfied in order for a conditional delete to succeed. ConditionExpression *string // One or more substitution tokens for attribute names in an expression. ExpressionAttributeNames map[string]*string + // One or more values that can be substituted in an expression. + ExpressionAttributeValues map[string]*AttributeValue + // Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Delete // condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: // NONE and ALL_OLD. @@ -815,15 +815,15 @@ type DeleteRequest struct { // An endpoint information details. type Endpoint struct { - // Endpoint cache time to live (TTL) value. + // IP address of the endpoint. // // This member is required. - CachePeriodInMinutes *int64 + Address *string - // IP address of the endpoint. + // Endpoint cache time to live (TTL) value. // // This member is required. - Address *string + CachePeriodInMinutes *int64 } // Represents a condition to be compared with an attribute value. This condition @@ -849,13 +849,6 @@ type Endpoint struct { // DynamoDB will return a ValidationException exception. type ExpectedAttributeValue struct { - // Represents the data for the expected attribute. Each attribute value is - // described as a name-value pair. The name is the data type, and the value is the - // data itself. For more information, see Data Types - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) - // in the Amazon DynamoDB Developer Guide. - Value *AttributeValue - // One or more values to evaluate against the supplied attribute. The number of // values in the list depends on the ComparisonOperator being used. For type // Number, value comparisons are numeric. String value comparisons for greater @@ -869,33 +862,6 @@ type ExpectedAttributeValue struct { // in the Amazon DynamoDB Developer Guide. AttributeValueList []*AttributeValue - // Causes DynamoDB to evaluate the value before attempting a conditional - // operation: - // - // * If Exists is true, DynamoDB will check to see if that - // attribute value already exists in the table. If it is found, then the operation - // succeeds. If it is not found, the operation fails with a - // ConditionCheckFailedException. - // - // * If Exists is false, DynamoDB assumes that - // the attribute value does not exist in the table. If in fact the value does not - // exist, then the assumption is valid and the operation succeeds. If the value is - // found, despite the assumption that it does not exist, the operation fails with a - // ConditionCheckFailedException. - // - // The default setting for Exists is true. If you - // supply a Value all by itself, DynamoDB assumes the attribute exists: You don't - // have to set Exists to true, because it is implied. DynamoDB returns a - // ValidationException if: - // - // * Exists is true but there is no Value to check. - // (You expect a value to exist, but don't specify what that value is.) - // - // * - // Exists is false but you also provide a Value. (You cannot expect an attribute to - // have a value, while also expecting it not to exist.) - Exists *bool - // A comparator for evaluating attributes in the AttributeValueList. For example, // equals, greater than, less than, etc. The following comparison operators are // available: EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | @@ -1004,6 +970,40 @@ type ExpectedAttributeValue struct { // match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} // does not compare to {"NS":["6", "2", "1"]} ComparisonOperator ComparisonOperator + + // Causes DynamoDB to evaluate the value before attempting a conditional + // operation: + // + // * If Exists is true, DynamoDB will check to see if that + // attribute value already exists in the table. If it is found, then the operation + // succeeds. If it is not found, the operation fails with a + // ConditionCheckFailedException. + // + // * If Exists is false, DynamoDB assumes that + // the attribute value does not exist in the table. If in fact the value does not + // exist, then the assumption is valid and the operation succeeds. If the value is + // found, despite the assumption that it does not exist, the operation fails with a + // ConditionCheckFailedException. + // + // The default setting for Exists is true. If you + // supply a Value all by itself, DynamoDB assumes the attribute exists: You don't + // have to set Exists to true, because it is implied. DynamoDB returns a + // ValidationException if: + // + // * Exists is true but there is no Value to check. + // (You expect a value to exist, but don't specify what that value is.) + // + // * + // Exists is false but you also provide a Value. (You cannot expect an attribute to + // have a value, while also expecting it not to exist.) + Exists *bool + + // Represents the data for the expected attribute. Each attribute value is + // described as a name-value pair. The name is the data type, and the value is the + // data itself. For more information, see Data Types + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) + // in the Amazon DynamoDB Developer Guide. + Value *AttributeValue } // Represents a failure a contributor insights operation. @@ -1020,17 +1020,6 @@ type FailureException struct { // object. type Get struct { - // One or more substitution tokens for attribute names in the ProjectionExpression - // parameter. - ExpressionAttributeNames map[string]*string - - // A string that identifies one or more attributes of the specified item to - // retrieve from the table. The attributes in the expression must be separated by - // commas. If no attribute names are specified, then all attributes of the - // specified item are returned. If any of the requested attributes are not found, - // they do not appear in the result. - ProjectionExpression *string - // A map of attribute names to AttributeValue objects that specifies the primary // key of the item to retrieve. // @@ -1041,24 +1030,21 @@ type Get struct { // // This member is required. TableName *string -} - -// Represents the properties of a global secondary index. -type GlobalSecondaryIndex struct { - // Represents attributes that are copied (projected) from the table into the global - // secondary index. These are in addition to the primary key attributes and index - // key attributes, which are automatically projected. - // - // This member is required. - Projection *Projection + // One or more substitution tokens for attribute names in the ProjectionExpression + // parameter. + ExpressionAttributeNames map[string]*string - // Represents the provisioned throughput settings for the specified global - // secondary index. For current minimum and maximum provisioned throughput values, - // see Limits - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) - // in the Amazon DynamoDB Developer Guide. - ProvisionedThroughput *ProvisionedThroughput + // A string that identifies one or more attributes of the specified item to + // retrieve from the table. The attributes in the expression must be separated by + // commas. If no attribute names are specified, then all attributes of the + // specified item are returned. If any of the requested attributes are not found, + // they do not appear in the result. + ProjectionExpression *string +} + +// Represents the properties of a global secondary index. +type GlobalSecondaryIndex struct { // The name of the global secondary index. The name must be unique among all other // indexes on this table. @@ -1084,6 +1070,20 @@ type GlobalSecondaryIndex struct { // // This member is required. KeySchema []*KeySchemaElement + + // Represents attributes that are copied (projected) from the table into the global + // secondary index. These are in addition to the primary key attributes and index + // key attributes, which are automatically projected. + // + // This member is required. + Projection *Projection + + // Represents the provisioned throughput settings for the specified global + // secondary index. For current minimum and maximum provisioned throughput values, + // see Limits + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) + // in the Amazon DynamoDB Developer Guide. + ProvisionedThroughput *ProvisionedThroughput } // Represents the auto scaling settings of a global secondary index for a global @@ -1101,23 +1101,47 @@ type GlobalSecondaryIndexAutoScalingUpdate struct { // Represents the properties of a global secondary index. type GlobalSecondaryIndexDescription struct { - // Represents attributes that are copied (projected) from the table into the global - // secondary index. These are in addition to the primary key attributes and index - // key attributes, which are automatically projected. - Projection *Projection + // Indicates whether the index is currently backfilling. Backfilling is the process + // of reading items from the table and determining whether they can be added to the + // index. (Not all items will qualify: For example, a partition key cannot have any + // duplicate values.) If an item can be added to the index, DynamoDB will do so. + // After all items have been processed, the backfilling operation is complete and + // Backfilling is false. You can delete an index that is being created during the + // Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. + // You can't delete the index that is being created when IndexStatus is set to + // CREATING and Backfilling is false. For indexes that were created during a + // CreateTable operation, the Backfilling attribute does not appear in the + // DescribeTable output. + Backfilling *bool - // The number of items in the specified index. DynamoDB updates this value - // approximately every six hours. Recent changes might not be reflected in this - // value. - ItemCount *int64 + // The Amazon Resource Name (ARN) that uniquely identifies the index. + IndexArn *string + + // The name of the global secondary index. + IndexName *string // The total size of the specified index, in bytes. DynamoDB updates this value // approximately every six hours. Recent changes might not be reflected in this // value. IndexSizeBytes *int64 - // The Amazon Resource Name (ARN) that uniquely identifies the index. - IndexArn *string + // The current state of the global secondary index: + // + // * CREATING - The index is + // being created. + // + // * UPDATING - The index is being updated. + // + // * DELETING - + // The index is being deleted. + // + // * ACTIVE - The index is ready for use. + IndexStatus IndexStatus + + // The number of items in the specified index. DynamoDB updates this value + // approximately every six hours. Recent changes might not be reflected in this + // value. + ItemCount *int64 // The complete key schema for a global secondary index, which consists of one or // more pairs of attribute names and key types: @@ -1136,21 +1160,10 @@ type GlobalSecondaryIndexDescription struct { // the sort key value. KeySchema []*KeySchemaElement - // The name of the global secondary index. - IndexName *string - - // The current state of the global secondary index: - // - // * CREATING - The index is - // being created. - // - // * UPDATING - The index is being updated. - // - // * DELETING - - // The index is being deleted. - // - // * ACTIVE - The index is ready for use. - IndexStatus IndexStatus + // Represents attributes that are copied (projected) from the table into the global + // secondary index. These are in addition to the primary key attributes and index + // key attributes, which are automatically projected. + Projection *Projection // Represents the provisioned throughput settings for the specified global // secondary index. For current minimum and maximum provisioned throughput values, @@ -1158,19 +1171,6 @@ type GlobalSecondaryIndexDescription struct { // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) // in the Amazon DynamoDB Developer Guide. ProvisionedThroughput *ProvisionedThroughputDescription - - // Indicates whether the index is currently backfilling. Backfilling is the process - // of reading items from the table and determining whether they can be added to the - // index. (Not all items will qualify: For example, a partition key cannot have any - // duplicate values.) If an item can be added to the index, DynamoDB will do so. - // After all items have been processed, the backfilling operation is complete and - // Backfilling is false. You can delete an index that is being created during the - // Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. - // You can't delete the index that is being created when IndexStatus is set to - // CREATING and Backfilling is false. For indexes that were created during a - // CreateTable operation, the Backfilling attribute does not appear in the - // DescribeTable output. - Backfilling *bool } // Represents the properties of a global secondary index for the table when the @@ -1197,14 +1197,14 @@ type GlobalSecondaryIndexInfo struct { // the sort key value. KeySchema []*KeySchemaElement - // Represents the provisioned throughput settings for the specified global - // secondary index. - ProvisionedThroughput *ProvisionedThroughput - // Represents attributes that are copied (projected) from the table into the global // secondary index. These are in addition to the primary key attributes and index // key attributes, which are automatically projected. Projection *Projection + + // Represents the provisioned throughput settings for the specified global + // secondary index. + ProvisionedThroughput *ProvisionedThroughput } // Represents one of the following: @@ -1219,10 +1219,6 @@ type GlobalSecondaryIndexInfo struct { // removed from an existing table. type GlobalSecondaryIndexUpdate struct { - // The name of an existing global secondary index, along with new provisioned - // throughput settings to be applied to that index. - Update *UpdateGlobalSecondaryIndexAction - // The parameters required for creating a global secondary index on an existing // table: // @@ -1240,16 +1236,20 @@ type GlobalSecondaryIndexUpdate struct { // The name of an existing global secondary index to be removed. Delete *DeleteGlobalSecondaryIndexAction + + // The name of an existing global secondary index, along with new provisioned + // throughput settings to be applied to that index. + Update *UpdateGlobalSecondaryIndexAction } // Represents the properties of a global table. type GlobalTable struct { - // The Regions where the global table has replicas. - ReplicationGroup []*Replica - // The global table name. GlobalTableName *string + + // The Regions where the global table has replicas. + ReplicationGroup []*Replica } // Contains details about the global table. @@ -1258,8 +1258,11 @@ type GlobalTableDescription struct { // The creation time of the global table. CreationDateTime *time.Time - // The Regions where the global table has replicas. - ReplicationGroup []*ReplicaDescription + // The unique identifier of the global table. + GlobalTableArn *string + + // The global table name. + GlobalTableName *string // The current state of the global table: // @@ -1275,21 +1278,14 @@ type GlobalTableDescription struct { // is ready for use. GlobalTableStatus GlobalTableStatus - // The global table name. - GlobalTableName *string - - // The unique identifier of the global table. - GlobalTableArn *string + // The Regions where the global table has replicas. + ReplicationGroup []*ReplicaDescription } // Represents the settings of a global secondary index for a global table that will // be modified. type GlobalTableGlobalSecondaryIndexSettingsUpdate struct { - // The maximum number of writes consumed per second before DynamoDB returns a - // ThrottlingException. - ProvisionedWriteCapacityUnits *int64 - // The name of the global secondary index. The name must be unique among all other // indexes on this table. // @@ -1299,6 +1295,10 @@ type GlobalTableGlobalSecondaryIndexSettingsUpdate struct { // Auto scaling settings for managing a global secondary index's write capacity // units. ProvisionedWriteCapacityAutoScalingSettingsUpdate *AutoScalingSettingsUpdate + + // The maximum number of writes consumed per second before DynamoDB returns a + // ThrottlingException. + ProvisionedWriteCapacityUnits *int64 } // Information about item collections, if any, that were affected by the operation. @@ -1335,22 +1335,18 @@ type ItemResponse struct { // key and the sort key. type KeysAndAttributes struct { - // A string that identifies one or more attributes to retrieve from the table. - // These attributes can include scalars, sets, or elements of a JSON document. The - // attributes in the ProjectionExpression must be separated by commas. If no - // attribute names are specified, then all attributes will be returned. If any of - // the requested attributes are not found, they will not appear in the result. For - // more information, see Accessing Item Attributes - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) - // in the Amazon DynamoDB Developer Guide. - ProjectionExpression *string - // The primary key attribute values that define the items and the attributes // associated with the items. // // This member is required. Keys []map[string]*AttributeValue + // This is a legacy parameter. Use ProjectionExpression instead. For more + // information, see Legacy Conditional Parameters + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html) + // in the Amazon DynamoDB Developer Guide. + AttributesToGet []*string + // The consistency of a read operation. If set to true, then a strongly consistent // read is used; otherwise, an eventually consistent read is used. ConsistentRead *bool @@ -1396,11 +1392,15 @@ type KeysAndAttributes struct { // in the Amazon DynamoDB Developer Guide. ExpressionAttributeNames map[string]*string - // This is a legacy parameter. Use ProjectionExpression instead. For more - // information, see Legacy Conditional Parameters - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html) + // A string that identifies one or more attributes to retrieve from the table. + // These attributes can include scalars, sets, or elements of a JSON document. The + // attributes in the ProjectionExpression must be separated by commas. If no + // attribute names are specified, then all attributes will be returned. If any of + // the requested attributes are not found, they will not appear in the result. For + // more information, see Accessing Item Attributes + // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) // in the Amazon DynamoDB Developer Guide. - AttributesToGet []*string + ProjectionExpression *string } // Represents a single element of a key schema. A key schema specifies the @@ -1414,6 +1414,11 @@ type KeysAndAttributes struct { // attribute cannot be nested within a List or a Map. type KeySchemaElement struct { + // The name of a key attribute. + // + // This member is required. + AttributeName *string + // The role that this key attribute will assume: // // * HASH - partition key @@ -1431,22 +1436,16 @@ type KeySchemaElement struct { // // This member is required. KeyType KeyType - - // The name of a key attribute. - // - // This member is required. - AttributeName *string } // Represents the properties of a local secondary index. type LocalSecondaryIndex struct { - // Represents attributes that are copied (projected) from the table into the local - // secondary index. These are in addition to the primary key attributes and index - // key attributes, which are automatically projected. + // The name of the local secondary index. The name must be unique among all other + // indexes on this table. // // This member is required. - Projection *Projection + IndexName *string // The complete key schema for the local secondary index, consisting of one or more // pairs of attribute names and key types: @@ -1467,11 +1466,12 @@ type LocalSecondaryIndex struct { // This member is required. KeySchema []*KeySchemaElement - // The name of the local secondary index. The name must be unique among all other - // indexes on this table. + // Represents attributes that are copied (projected) from the table into the local + // secondary index. These are in addition to the primary key attributes and index + // key attributes, which are automatically projected. // // This member is required. - IndexName *string + Projection *Projection } // Represents the properties of a local secondary index. @@ -1483,11 +1483,6 @@ type LocalSecondaryIndexDescription struct { // Represents the name of the local secondary index. IndexName *string - // Represents attributes that are copied (projected) from the table into the global - // secondary index. These are in addition to the primary key attributes and index - // key attributes, which are automatically projected. - Projection *Projection - // The total size of the specified index, in bytes. DynamoDB updates this value // approximately every six hours. Recent changes might not be reflected in this // value. @@ -1514,6 +1509,11 @@ type LocalSecondaryIndexDescription struct { // with the same partition key physically close together, in sorted order by the // sort key value. KeySchema []*KeySchemaElement + + // Represents attributes that are copied (projected) from the table into the global + // secondary index. These are in addition to the primary key attributes and index + // key attributes, which are automatically projected. + Projection *Projection } // Represents the properties of a local secondary index for the table when the @@ -1553,6 +1553,9 @@ type PointInTimeRecoveryDescription struct { // restore your table to any point in time during the last 35 days. EarliestRestorableDateTime *time.Time + // LatestRestorableDateTime is typically 5 minutes before the current time. + LatestRestorableDateTime *time.Time + // The current state of point in time recovery: // // * ENABLING - Point in time @@ -1563,9 +1566,6 @@ type PointInTimeRecoveryDescription struct { // // * DISABLED - Point in time recovery is disabled. PointInTimeRecoveryStatus PointInTimeRecoveryStatus - - // LatestRestorableDateTime is typically 5 minutes before the current time. - LatestRestorableDateTime *time.Time } // Represents the settings used to enable point in time recovery. @@ -1583,6 +1583,13 @@ type PointInTimeRecoverySpecification struct { // which are automatically projected. type Projection struct { + // Represents the non-key attribute names which will be projected into the index. + // For local secondary indexes, the total count of NonKeyAttributes summed across + // all of the local secondary indexes, must not exceed 20. If you project the same + // attribute into two different indexes, this counts as two distinct attributes + // when determining the total. + NonKeyAttributes []*string + // The set of attributes that are projected into the index: // // * KEYS_ONLY - Only @@ -1595,13 +1602,6 @@ type Projection struct { // * ALL - All of the table // attributes are projected into the index. ProjectionType ProjectionType - - // Represents the non-key attribute names which will be projected into the index. - // For local secondary indexes, the total count of NonKeyAttributes summed across - // all of the local secondary indexes, must not exceed 20. If you project the same - // attribute into two different indexes, this counts as two distinct attributes - // when determining the total. - NonKeyAttributes []*string } // Represents the provisioned throughput settings for a specified table or index. @@ -1636,9 +1636,8 @@ type ProvisionedThroughput struct { // and write capacity units, along with data about increases and decreases. type ProvisionedThroughputDescription struct { - // The maximum number of writes consumed per second before DynamoDB returns a - // ThrottlingException. - WriteCapacityUnits *int64 + // The date and time of the last provisioned throughput decrease for this table. + LastDecreaseDateTime *time.Time // The date and time of the last provisioned throughput increase for this table. LastIncreaseDateTime *time.Time @@ -1650,46 +1649,28 @@ type ProvisionedThroughputDescription struct { // in the Amazon DynamoDB Developer Guide. NumberOfDecreasesToday *int64 - // The date and time of the last provisioned throughput decrease for this table. - LastDecreaseDateTime *time.Time - // The maximum number of strongly consistent reads consumed per second before // DynamoDB returns a ThrottlingException. Eventually consistent reads require less // effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per // second provides 100 eventually consistent ReadCapacityUnits per second. ReadCapacityUnits *int64 + + // The maximum number of writes consumed per second before DynamoDB returns a + // ThrottlingException. + WriteCapacityUnits *int64 } // Replica-specific provisioned throughput settings. If not specified, uses the // source table's provisioned throughput settings. type ProvisionedThroughputOverride struct { - // Replica-specific read capacity units. If not specified, uses the source table's - // read capacity settings. - ReadCapacityUnits *int64 -} - -// Represents a request to perform a PutItem operation. -type Put struct { - - // One or more values that can be substituted in an expression. - ExpressionAttributeValues map[string]*AttributeValue - - // A condition that must be satisfied in order for a conditional update to succeed. - ConditionExpression *string - - // Name of the table in which to write the item. - // - // This member is required. - TableName *string - - // Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Put - // condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: - // NONE and ALL_OLD. - ReturnValuesOnConditionCheckFailure ReturnValuesOnConditionCheckFailure - - // One or more substitution tokens for attribute names in an expression. - ExpressionAttributeNames map[string]*string + // Replica-specific read capacity units. If not specified, uses the source table's + // read capacity settings. + ReadCapacityUnits *int64 +} + +// Represents a request to perform a PutItem operation. +type Put struct { // A map of attribute name to attribute values, representing the primary key of the // item to be written by PutItem. All of the table's primary key attributes must be @@ -1699,6 +1680,25 @@ type Put struct { // // This member is required. Item map[string]*AttributeValue + + // Name of the table in which to write the item. + // + // This member is required. + TableName *string + + // A condition that must be satisfied in order for a conditional update to succeed. + ConditionExpression *string + + // One or more substitution tokens for attribute names in an expression. + ExpressionAttributeNames map[string]*string + + // One or more values that can be substituted in an expression. + ExpressionAttributeValues map[string]*AttributeValue + + // Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Put + // condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: + // NONE and ALL_OLD. + ReturnValuesOnConditionCheckFailure ReturnValuesOnConditionCheckFailure } // Represents a request to perform a PutItem operation on an item. @@ -1724,6 +1724,9 @@ type Replica struct { // Represents the auto scaling settings of the replica. type ReplicaAutoScalingDescription struct { + // Replica-specific global secondary index auto scaling settings. + GlobalSecondaryIndexes []*ReplicaGlobalSecondaryIndexAutoScalingDescription + // The Region where the replica exists. RegionName *string @@ -1747,14 +1750,16 @@ type ReplicaAutoScalingDescription struct { // // * ACTIVE - The replica is ready for use. ReplicaStatus ReplicaStatus - - // Replica-specific global secondary index auto scaling settings. - GlobalSecondaryIndexes []*ReplicaGlobalSecondaryIndexAutoScalingDescription } // Represents the auto scaling settings of a replica that will be modified. type ReplicaAutoScalingUpdate struct { + // The Region where the replica exists. + // + // This member is required. + RegionName *string + // Represents the auto scaling settings of global secondary indexes that will be // modified. ReplicaGlobalSecondaryIndexUpdates []*ReplicaGlobalSecondaryIndexAutoScalingUpdate @@ -1762,26 +1767,25 @@ type ReplicaAutoScalingUpdate struct { // Represents the auto scaling settings to be modified for a global table or global // secondary index. ReplicaProvisionedReadCapacityAutoScalingUpdate *AutoScalingSettingsUpdate - - // The Region where the replica exists. - // - // This member is required. - RegionName *string } // Contains the details of the replica. type ReplicaDescription struct { - // The name of the Region. - RegionName *string - // Replica-specific global secondary index settings. GlobalSecondaryIndexes []*ReplicaGlobalSecondaryIndexDescription + // The AWS KMS customer master key (CMK) of the replica that will be used for AWS + // KMS encryption. + KMSMasterKeyId *string + // Replica-specific provisioned throughput. If not described, uses the source // table's provisioned throughput settings. ProvisionedThroughputOverride *ProvisionedThroughputOverride + // The name of the Region. + RegionName *string + // The current state of the replica: // // * CREATING - The replica is being @@ -1795,16 +1799,12 @@ type ReplicaDescription struct { // * ACTIVE - The replica is ready for use. ReplicaStatus ReplicaStatus + // Detailed information about the replica status. + ReplicaStatusDescription *string + // Specifies the progress of a Create, Update, or Delete action on the replica as a // percentage. ReplicaStatusPercentProgress *string - - // The AWS KMS customer master key (CMK) of the replica that will be used for AWS - // KMS encryption. - KMSMasterKeyId *string - - // Detailed information about the replica status. - ReplicaStatusDescription *string } // Represents the properties of a replica global secondary index. @@ -1823,14 +1823,6 @@ type ReplicaGlobalSecondaryIndex struct { // Represents the auto scaling configuration for a replica global secondary index. type ReplicaGlobalSecondaryIndexAutoScalingDescription struct { - // Represents the auto scaling settings for a global table or global secondary - // index. - ProvisionedWriteCapacityAutoScalingSettings *AutoScalingSettingsDescription - - // Represents the auto scaling settings for a global table or global secondary - // index. - ProvisionedReadCapacityAutoScalingSettings *AutoScalingSettingsDescription - // The name of the global secondary index. IndexName *string @@ -1847,36 +1839,46 @@ type ReplicaGlobalSecondaryIndexAutoScalingDescription struct { // * ACTIVE - The index is ready for // use. IndexStatus IndexStatus + + // Represents the auto scaling settings for a global table or global secondary + // index. + ProvisionedReadCapacityAutoScalingSettings *AutoScalingSettingsDescription + + // Represents the auto scaling settings for a global table or global secondary + // index. + ProvisionedWriteCapacityAutoScalingSettings *AutoScalingSettingsDescription } // Represents the auto scaling settings of a global secondary index for a replica // that will be modified. type ReplicaGlobalSecondaryIndexAutoScalingUpdate struct { + // The name of the global secondary index. + IndexName *string + // Represents the auto scaling settings to be modified for a global table or global // secondary index. ProvisionedReadCapacityAutoScalingUpdate *AutoScalingSettingsUpdate - - // The name of the global secondary index. - IndexName *string } // Represents the properties of a replica global secondary index. type ReplicaGlobalSecondaryIndexDescription struct { - // If not described, uses the source table GSI's read capacity settings. - ProvisionedThroughputOverride *ProvisionedThroughputOverride - // The name of the global secondary index. IndexName *string + + // If not described, uses the source table GSI's read capacity settings. + ProvisionedThroughputOverride *ProvisionedThroughputOverride } // Represents the properties of a global secondary index. type ReplicaGlobalSecondaryIndexSettingsDescription struct { - // Auto scaling settings for a global secondary index replica's write capacity - // units. - ProvisionedWriteCapacityAutoScalingSettings *AutoScalingSettingsDescription + // The name of the global secondary index. The name must be unique among all other + // indexes on this table. + // + // This member is required. + IndexName *string // The current status of the global secondary index: // @@ -1892,16 +1894,6 @@ type ReplicaGlobalSecondaryIndexSettingsDescription struct { // * ACTIVE - The global secondary index is ready for use. IndexStatus IndexStatus - // The maximum number of writes consumed per second before DynamoDB returns a - // ThrottlingException. - ProvisionedWriteCapacityUnits *int64 - - // The name of the global secondary index. The name must be unique among all other - // indexes on this table. - // - // This member is required. - IndexName *string - // Auto scaling settings for a global secondary index replica's read capacity // units. ProvisionedReadCapacityAutoScalingSettings *AutoScalingSettingsDescription @@ -1909,12 +1901,26 @@ type ReplicaGlobalSecondaryIndexSettingsDescription struct { // The maximum number of strongly consistent reads consumed per second before // DynamoDB returns a ThrottlingException. ProvisionedReadCapacityUnits *int64 + + // Auto scaling settings for a global secondary index replica's write capacity + // units. + ProvisionedWriteCapacityAutoScalingSettings *AutoScalingSettingsDescription + + // The maximum number of writes consumed per second before DynamoDB returns a + // ThrottlingException. + ProvisionedWriteCapacityUnits *int64 } // Represents the settings of a global secondary index for a global table that will // be modified. type ReplicaGlobalSecondaryIndexSettingsUpdate struct { + // The name of the global secondary index. The name must be unique among all other + // indexes on this table. + // + // This member is required. + IndexName *string + // Auto scaling settings for managing a global secondary index replica's read // capacity units. ProvisionedReadCapacityAutoScalingSettingsUpdate *AutoScalingSettingsUpdate @@ -1922,19 +1928,24 @@ type ReplicaGlobalSecondaryIndexSettingsUpdate struct { // The maximum number of strongly consistent reads consumed per second before // DynamoDB returns a ThrottlingException. ProvisionedReadCapacityUnits *int64 - - // The name of the global secondary index. The name must be unique among all other - // indexes on this table. - // - // This member is required. - IndexName *string } // Represents the properties of a replica. type ReplicaSettingsDescription struct { - // Auto scaling settings for a global table replica's write capacity units. - ReplicaProvisionedWriteCapacityAutoScalingSettings *AutoScalingSettingsDescription + // The Region name of the replica. + // + // This member is required. + RegionName *string + + // The read/write capacity mode of the replica. + ReplicaBillingModeSummary *BillingModeSummary + + // Replica global secondary index settings for the global table. + ReplicaGlobalSecondaryIndexSettings []*ReplicaGlobalSecondaryIndexSettingsDescription + + // Auto scaling settings for a global table replica's read capacity units. + ReplicaProvisionedReadCapacityAutoScalingSettings *AutoScalingSettingsDescription // The maximum number of strongly consistent reads consumed per second before // DynamoDB returns a ThrottlingException. For more information, see Specifying @@ -1943,8 +1954,8 @@ type ReplicaSettingsDescription struct { // in the Amazon DynamoDB Developer Guide. ReplicaProvisionedReadCapacityUnits *int64 - // Auto scaling settings for a global table replica's read capacity units. - ReplicaProvisionedReadCapacityAutoScalingSettings *AutoScalingSettingsDescription + // Auto scaling settings for a global table replica's write capacity units. + ReplicaProvisionedWriteCapacityAutoScalingSettings *AutoScalingSettingsDescription // The maximum number of writes consumed per second before DynamoDB returns a // ThrottlingException. For more information, see Specifying Read and Write @@ -1953,11 +1964,6 @@ type ReplicaSettingsDescription struct { // in the Amazon DynamoDB Developer Guide. ReplicaProvisionedWriteCapacityUnits *int64 - // The Region name of the replica. - // - // This member is required. - RegionName *string - // The current state of the Region: // // * CREATING - The Region is being @@ -1970,28 +1976,22 @@ type ReplicaSettingsDescription struct { // // * ACTIVE - The Region is ready for use. ReplicaStatus ReplicaStatus - - // The read/write capacity mode of the replica. - ReplicaBillingModeSummary *BillingModeSummary - - // Replica global secondary index settings for the global table. - ReplicaGlobalSecondaryIndexSettings []*ReplicaGlobalSecondaryIndexSettingsDescription } // Represents the settings for a global table in a Region that will be modified. type ReplicaSettingsUpdate struct { - // Auto scaling settings for managing a global table replica's read capacity units. - ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate *AutoScalingSettingsUpdate + // The Region of the replica to be added. + // + // This member is required. + RegionName *string // Represents the settings of a global secondary index for a global table that will // be modified. ReplicaGlobalSecondaryIndexSettingsUpdate []*ReplicaGlobalSecondaryIndexSettingsUpdate - // The Region of the replica to be added. - // - // This member is required. - RegionName *string + // Auto scaling settings for managing a global table replica's read capacity units. + ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate *AutoScalingSettingsUpdate // The maximum number of strongly consistent reads consumed per second before // DynamoDB returns a ThrottlingException. For more information, see Specifying @@ -2016,12 +2016,12 @@ type ReplicaSettingsUpdate struct { // the destination Region. type ReplicationGroupUpdate struct { - // The parameters required for deleting a replica for the table. - Delete *DeleteReplicationGroupMemberAction - // The parameters required for creating a replica for the table. Create *CreateReplicationGroupMemberAction + // The parameters required for deleting a replica for the table. + Delete *DeleteReplicationGroupMemberAction + // The parameters required for updating a replica for the table. Update *UpdateReplicationGroupMemberAction } @@ -2047,12 +2047,6 @@ type ReplicaUpdate struct { // Contains details for the restore. type RestoreSummary struct { - // The Amazon Resource Name (ARN) of the backup from which the table was restored. - SourceBackupArn *string - - // The ARN of the source table of the backup that is being restored. - SourceTableArn *string - // Point in time or source backup time. // // This member is required. @@ -2062,44 +2056,41 @@ type RestoreSummary struct { // // This member is required. RestoreInProgress *bool + + // The Amazon Resource Name (ARN) of the backup from which the table was restored. + SourceBackupArn *string + + // The ARN of the source table of the backup that is being restored. + SourceTableArn *string } // Contains the details of the table when the backup was created. type SourceTableDetails struct { - // Read IOPs and Write IOPS on the table when the backup was created. - // - // This member is required. - ProvisionedThroughput *ProvisionedThroughput - - // Unique identifier for the table for which the backup was created. + // Schema of the table. // // This member is required. - TableId *string + KeySchema []*KeySchemaElement - // The name of the table for which the backup was created. + // Read IOPs and Write IOPS on the table when the backup was created. // // This member is required. - TableName *string - - // Number of items in the table. Note that this is an approximate value. - ItemCount *int64 - - // Size of the table in bytes. Note that this is an approximate value. - TableSizeBytes *int64 + ProvisionedThroughput *ProvisionedThroughput // Time when the source table was created. // // This member is required. TableCreationDateTime *time.Time - // ARN of the table for which backup was created. - TableArn *string + // Unique identifier for the table for which the backup was created. + // + // This member is required. + TableId *string - // Schema of the table. + // The name of the table for which the backup was created. // // This member is required. - KeySchema []*KeySchemaElement + TableName *string // Controls how you are charged for read and write throughput and how you manage // capacity. This setting can be changed later. @@ -2112,20 +2103,31 @@ type SourceTableDetails struct { // mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable // workloads. BillingMode BillingMode + + // Number of items in the table. Note that this is an approximate value. + ItemCount *int64 + + // ARN of the table for which backup was created. + TableArn *string + + // Size of the table in bytes. Note that this is an approximate value. + TableSizeBytes *int64 } // Contains the details of the features enabled on the table when the backup was // created. For example, LSIs, GSIs, streams, TTL. type SourceTableFeatureDetails struct { + // Represents the GSI properties for the table when the backup was created. It + // includes the IndexName, KeySchema, Projection, and ProvisionedThroughput for the + // GSIs on the table at the time of backup. + GlobalSecondaryIndexes []*GlobalSecondaryIndexInfo + // Represents the LSI properties for the table when the backup was created. It // includes the IndexName, KeySchema and Projection for the LSIs on the table at // the time of backup. LocalSecondaryIndexes []*LocalSecondaryIndexInfo - // Time to Live settings on the table when the backup was created. - TimeToLiveDescription *TimeToLiveDescription - // The description of the server-side encryption status on the table when the // backup was created. SSEDescription *SSEDescription @@ -2133,10 +2135,8 @@ type SourceTableFeatureDetails struct { // Stream settings on the table when the backup was created. StreamDescription *StreamSpecification - // Represents the GSI properties for the table when the backup was created. It - // includes the IndexName, KeySchema, Projection, and ProvisionedThroughput for the - // GSIs on the table at the time of backup. - GlobalSecondaryIndexes []*GlobalSecondaryIndexInfo + // Time to Live settings on the table when the backup was created. + TimeToLiveDescription *TimeToLiveDescription } // The description of the server-side encryption status on the specified table. @@ -2149,15 +2149,6 @@ type SSEDescription struct { // remains inaccessible for more than seven days from this date. InaccessibleEncryptionDateTime *time.Time - // Represents the current state of server-side encryption. The only supported - // values are: - // - // * ENABLED - Server-side encryption is enabled. - // - // * UPDATING - // - Server-side encryption is being updated. - Status SSEStatus - // The AWS KMS customer master key (CMK) ARN used for the AWS KMS encryption. KMSMasterKeyArn *string @@ -2167,11 +2158,26 @@ type SSEDescription struct { // Server-side encryption that uses AWS Key Management Service. The key is stored // in your account and is managed by AWS KMS (AWS KMS charges apply). SSEType SSEType + + // Represents the current state of server-side encryption. The only supported + // values are: + // + // * ENABLED - Server-side encryption is enabled. + // + // * UPDATING + // - Server-side encryption is being updated. + Status SSEStatus } // Represents the settings used to enable server-side encryption. type SSESpecification struct { + // Indicates whether server-side encryption is done using an AWS managed CMK or an + // AWS owned CMK. If enabled (true), server-side encryption type is set to KMS and + // an AWS managed CMK is used (AWS KMS charges apply). If disabled (false) or not + // specified, server-side encryption is set to AWS owned CMK. + Enabled *bool + // The AWS KMS customer master key (CMK) that should be used for the AWS KMS // encryption. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias // name, or alias ARN. Note that you should only provide this parameter if the key @@ -2184,17 +2190,17 @@ type SSESpecification struct { // Server-side encryption that uses AWS Key Management Service. The key is stored // in your account and is managed by AWS KMS (AWS KMS charges apply). SSEType SSEType - - // Indicates whether server-side encryption is done using an AWS managed CMK or an - // AWS owned CMK. If enabled (true), server-side encryption type is set to KMS and - // an AWS managed CMK is used (AWS KMS charges apply). If disabled (false) or not - // specified, server-side encryption is set to AWS owned CMK. - Enabled *bool } // Represents the DynamoDB Streams configuration for a table in DynamoDB. type StreamSpecification struct { + // Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the + // table. + // + // This member is required. + StreamEnabled *bool + // When an item in the table is modified, StreamViewType determines what // information is written to the stream for this table. Valid values for // StreamViewType are: @@ -2212,17 +2218,17 @@ type StreamSpecification struct { // * NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are // written to the stream. StreamViewType StreamViewType - - // Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the - // table. - // - // This member is required. - StreamEnabled *bool } // Represents the auto scaling configuration for a global table. type TableAutoScalingDescription struct { + // Represents replicas of the global table. + Replicas []*ReplicaAutoScalingDescription + + // The name of the table. + TableName *string + // The current state of the table: // // * CREATING - The table is being created. @@ -2235,29 +2241,30 @@ type TableAutoScalingDescription struct { // // * ACTIVE - The table is ready for use. TableStatus TableStatus - - // The name of the table. - TableName *string - - // Represents replicas of the global table. - Replicas []*ReplicaAutoScalingDescription } // Represents the properties of a table. type TableDescription struct { - // The description of the server-side encryption status on the specified table. - SSEDescription *SSEDescription - // Contains information about the table archive. ArchivalSummary *ArchivalSummary + // An array of AttributeDefinition objects. Each of these objects describes one + // attribute in the table and index key schema. Each AttributeDefinition object in + // this array is composed of: + // + // * AttributeName - The name of the attribute. + // + // + // * AttributeType - The data type for the attribute. + AttributeDefinitions []*AttributeDefinition + // Contains the details for the read/write capacity mode. BillingModeSummary *BillingModeSummary - // The Amazon Resource Name (ARN) that uniquely identifies the latest stream for - // this table. - LatestStreamArn *string + // The date and time when the table was created, in UNIX epoch time + // (http://www.epochconverter.com/) format. + CreationDateTime *time.Time // The global secondary indexes, if any, on the table. Each index is scoped to a // given partition key value. Each element is composed of: @@ -2336,67 +2343,15 @@ type TableDescription struct { // no information about indexes will be returned. GlobalSecondaryIndexes []*GlobalSecondaryIndexDescription - // An array of AttributeDefinition objects. Each of these objects describes one - // attribute in the table and index key schema. Each AttributeDefinition object in - // this array is composed of: - // - // * AttributeName - The name of the attribute. - // - // - // * AttributeType - The data type for the attribute. - AttributeDefinitions []*AttributeDefinition - - // The Amazon Resource Name (ARN) that uniquely identifies the table. - TableArn *string - // Represents the version of global tables // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html) // in use, if the table is replicated across AWS Regions. GlobalTableVersion *string - // The provisioned throughput settings for the table, consisting of read and write - // capacity units, along with data about increases and decreases. - ProvisionedThroughput *ProvisionedThroughputDescription - - // Represents replicas of the table. - Replicas []*ReplicaDescription - - // Unique identifier for the table for which the backup was created. - TableId *string - - // The total size of the specified table, in bytes. DynamoDB updates this value + // The number of items in the specified table. DynamoDB updates this value // approximately every six hours. Recent changes might not be reflected in this // value. - TableSizeBytes *int64 - - // The current state of the table: - // - // * CREATING - The table is being created. - // - // - // * UPDATING - The table is being updated. - // - // * DELETING - The table is being - // deleted. - // - // * ACTIVE - The table is ready for use. - // - // * - // INACCESSIBLE_ENCRYPTION_CREDENTIALS - The AWS KMS key used to encrypt the table - // in inaccessible. Table operations may fail due to failure to use the AWS KMS - // key. DynamoDB will initiate the table archival process when a table's AWS KMS - // key remains inaccessible for more than seven days. - // - // * ARCHIVING - The table - // is being archived. Operations are not allowed until archival is complete. - // - // * - // ARCHIVED - The table has been archived. See the ArchivalReason for more - // information. - TableStatus TableStatus - - // The current DynamoDB Streams configuration for the table. - StreamSpecification *StreamSpecification + ItemCount *int64 // The primary key structure for the table. Each KeySchemaElement consists of: // @@ -2422,8 +2377,17 @@ type TableDescription struct { // Key in the Amazon DynamoDB Developer Guide.

    KeySchema []*KeySchemaElement - // Contains details for the restore. - RestoreSummary *RestoreSummary + // The Amazon Resource Name (ARN) that uniquely identifies the latest stream for + // this table. + LatestStreamArn *string + + // A timestamp, in ISO 8601 format, for this stream.

    Note that + // LatestStreamLabel is not a unique identifier for the stream, + // because it is possible that a stream from another table might have the same + // timestamp. However, the combination of the following three elements is + // guaranteed to be unique:

    • AWS customer ID

    • + //

      Table name

    • StreamLabel

    + LatestStreamLabel *string // Represents one or more local secondary indexes on the table. Each index is // scoped to a given partition key value. Tables with one or more local secondary @@ -2476,25 +2440,61 @@ type TableDescription struct { // be returned. LocalSecondaryIndexes []*LocalSecondaryIndexDescription - // A timestamp, in ISO 8601 format, for this stream.

    Note that - // LatestStreamLabel is not a unique identifier for the stream, - // because it is possible that a stream from another table might have the same - // timestamp. However, the combination of the following three elements is - // guaranteed to be unique:

    • AWS customer ID

    • - //

      Table name

    • StreamLabel

    - LatestStreamLabel *string + // The provisioned throughput settings for the table, consisting of read and write + // capacity units, along with data about increases and decreases. + ProvisionedThroughput *ProvisionedThroughputDescription - // The date and time when the table was created, in UNIX epoch time - // (http://www.epochconverter.com/) format. - CreationDateTime *time.Time + // Represents replicas of the table. + Replicas []*ReplicaDescription + + // Contains details for the restore. + RestoreSummary *RestoreSummary + + // The description of the server-side encryption status on the specified table. + SSEDescription *SSEDescription + + // The current DynamoDB Streams configuration for the table. + StreamSpecification *StreamSpecification + + // The Amazon Resource Name (ARN) that uniquely identifies the table. + TableArn *string + + // Unique identifier for the table for which the backup was created. + TableId *string // The name of the table. TableName *string - // The number of items in the specified table. DynamoDB updates this value + // The total size of the specified table, in bytes. DynamoDB updates this value // approximately every six hours. Recent changes might not be reflected in this // value. - ItemCount *int64 + TableSizeBytes *int64 + + // The current state of the table: + // + // * CREATING - The table is being created. + // + // + // * UPDATING - The table is being updated. + // + // * DELETING - The table is being + // deleted. + // + // * ACTIVE - The table is ready for use. + // + // * + // INACCESSIBLE_ENCRYPTION_CREDENTIALS - The AWS KMS key used to encrypt the table + // in inaccessible. Table operations may fail due to failure to use the AWS KMS + // key. DynamoDB will initiate the table archival process when a table's AWS KMS + // key remains inaccessible for more than seven days. + // + // * ARCHIVING - The table + // is being archived. Operations are not allowed until archival is complete. + // + // * + // ARCHIVED - The table has been archived. See the ArchivalReason for more + // information. + TableStatus TableStatus } // Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a @@ -2524,27 +2524,27 @@ type Tag struct { // The description of the Time to Live (TTL) status on the specified table. type TimeToLiveDescription struct { - // The TTL status for the table. - TimeToLiveStatus TimeToLiveStatus - // The name of the TTL attribute for items in the table. AttributeName *string + + // The TTL status for the table. + TimeToLiveStatus TimeToLiveStatus } // Represents the settings used to enable or disable Time to Live (TTL) for the // specified table. type TimeToLiveSpecification struct { - // Indicates whether TTL is to be enabled (true) or disabled (false) on the table. - // - // This member is required. - Enabled *bool - // The name of the TTL attribute used to store the expiration time for items in the // table. // // This member is required. AttributeName *string + + // Indicates whether TTL is to be enabled (true) or disabled (false) on the table. + // + // This member is required. + Enabled *bool } // Specifies an item to be retrieved as part of the transaction. @@ -2562,44 +2562,44 @@ type TransactGetItem struct { // multiple items in one or more tables atomically. type TransactWriteItem struct { - // A request to perform a PutItem operation. - Put *Put - // A request to perform a check item operation. ConditionCheck *ConditionCheck - // A request to perform an UpdateItem operation. - Update *Update - // A request to perform a DeleteItem operation. Delete *Delete + + // A request to perform a PutItem operation. + Put *Put + + // A request to perform an UpdateItem operation. + Update *Update } // Represents a request to perform an UpdateItem operation. type Update struct { - // One or more substitution tokens for attribute names in an expression. - ExpressionAttributeNames map[string]*string - - // An expression that defines one or more attributes to be updated, the action to - // be performed on them, and new value(s) for them. + // The primary key of the item to be updated. Each element consists of an attribute + // name and a value for that attribute. // // This member is required. - UpdateExpression *string + Key map[string]*AttributeValue // Name of the table for the UpdateItem request. // // This member is required. TableName *string + // An expression that defines one or more attributes to be updated, the action to + // be performed on them, and new value(s) for them. + // + // This member is required. + UpdateExpression *string + // A condition that must be satisfied in order for a conditional update to succeed. ConditionExpression *string - // The primary key of the item to be updated. Each element consists of an attribute - // name and a value for that attribute. - // - // This member is required. - Key map[string]*AttributeValue + // One or more substitution tokens for attribute names in an expression. + ExpressionAttributeNames map[string]*string // One or more values that can be substituted in an expression. ExpressionAttributeValues map[string]*AttributeValue @@ -2614,6 +2614,11 @@ type Update struct { // secondary index. type UpdateGlobalSecondaryIndexAction struct { + // The name of the global secondary index to be updated. + // + // This member is required. + IndexName *string + // Represents the provisioned throughput settings for the specified global // secondary index. For current minimum and maximum provisioned throughput values, // see Limits @@ -2622,11 +2627,6 @@ type UpdateGlobalSecondaryIndexAction struct { // // This member is required. ProvisionedThroughput *ProvisionedThroughput - - // The name of the global secondary index to be updated. - // - // This member is required. - IndexName *string } // Represents a replica to be modified. @@ -2637,10 +2637,6 @@ type UpdateReplicationGroupMemberAction struct { // This member is required. RegionName *string - // Replica-specific provisioned throughput. If not specified, uses the source - // table's provisioned throughput settings. - ProvisionedThroughputOverride *ProvisionedThroughputOverride - // Replica-specific global secondary index settings. GlobalSecondaryIndexes []*ReplicaGlobalSecondaryIndex @@ -2650,6 +2646,10 @@ type UpdateReplicationGroupMemberAction struct { // the key is different from the default DynamoDB KMS master key // alias/aws/dynamodb. KMSMasterKeyId *string + + // Replica-specific provisioned throughput. If not specified, uses the source + // table's provisioned throughput settings. + ProvisionedThroughputOverride *ProvisionedThroughputOverride } // Represents an operation to perform - either DeleteItem or PutItem. You can only diff --git a/service/dynamodbstreams/api_op_DescribeStream.go b/service/dynamodbstreams/api_op_DescribeStream.go index 2e85405602f..b092a7ab2f5 100644 --- a/service/dynamodbstreams/api_op_DescribeStream.go +++ b/service/dynamodbstreams/api_op_DescribeStream.go @@ -70,12 +70,12 @@ type DescribeStreamInput struct { // This member is required. StreamArn *string - // The maximum number of shard objects to return. The upper limit is 100. - Limit *int32 - // The shard ID of the first item that this operation will evaluate. Use the value // that was returned for LastEvaluatedShardId in the previous operation. ExclusiveStartShardId *string + + // The maximum number of shard objects to return. The upper limit is 100. + Limit *int32 } // Represents the output of a DescribeStream operation. diff --git a/service/dynamodbstreams/api_op_GetRecords.go b/service/dynamodbstreams/api_op_GetRecords.go index 557a88638ab..aa00cce5a0e 100644 --- a/service/dynamodbstreams/api_op_GetRecords.go +++ b/service/dynamodbstreams/api_op_GetRecords.go @@ -65,14 +65,14 @@ func (c *Client) GetRecords(ctx context.Context, params *GetRecordsInput, optFns // Represents the input of a GetRecords operation. type GetRecordsInput struct { - // The maximum number of records to return from the shard. The upper limit is 1000. - Limit *int32 - // A shard iterator that was retrieved from a previous GetShardIterator operation. // This iterator can be used to access the stream records in this shard. // // This member is required. ShardIterator *string + + // The maximum number of records to return from the shard. The upper limit is 1000. + Limit *int32 } // Represents the output of a GetRecords operation. diff --git a/service/dynamodbstreams/api_op_GetShardIterator.go b/service/dynamodbstreams/api_op_GetShardIterator.go index 00514d7a050..3a4375333b6 100644 --- a/service/dynamodbstreams/api_op_GetShardIterator.go +++ b/service/dynamodbstreams/api_op_GetShardIterator.go @@ -61,14 +61,6 @@ func (c *Client) GetShardIterator(ctx context.Context, params *GetShardIteratorI // Represents the input of a GetShardIterator operation. type GetShardIteratorInput struct { - // The Amazon Resource Name (ARN) for the stream. - // - // This member is required. - StreamArn *string - - // The sequence number of a stream record in the shard from which to start reading. - SequenceNumber *string - // The identifier of the shard. The iterator will be returned for this shard ID. // // This member is required. @@ -95,6 +87,14 @@ type GetShardIteratorInput struct { // // This member is required. ShardIteratorType types.ShardIteratorType + + // The Amazon Resource Name (ARN) for the stream. + // + // This member is required. + StreamArn *string + + // The sequence number of a stream record in the shard from which to start reading. + SequenceNumber *string } // Represents the output of a GetShardIterator operation. diff --git a/service/dynamodbstreams/api_op_ListStreams.go b/service/dynamodbstreams/api_op_ListStreams.go index 1dd7fcffe78..927d6a01ccf 100644 --- a/service/dynamodbstreams/api_op_ListStreams.go +++ b/service/dynamodbstreams/api_op_ListStreams.go @@ -60,14 +60,14 @@ func (c *Client) ListStreams(ctx context.Context, params *ListStreamsInput, optF // Represents the input of a ListStreams operation. type ListStreamsInput struct { - // The maximum number of streams to return. The upper limit is 100. - Limit *int32 - // The ARN (Amazon Resource Name) of the first item that this operation will // evaluate. Use the value that was returned for LastEvaluatedStreamArn in the // previous operation. ExclusiveStartStreamArn *string + // The maximum number of streams to return. The upper limit is 100. + Limit *int32 + // If this parameter is provided, then only the streams associated with this table // name are returned. TableName *string diff --git a/service/dynamodbstreams/go.mod b/service/dynamodbstreams/go.mod index 5e51b73dbb7..5f7eca967fb 100644 --- a/service/dynamodbstreams/go.mod +++ b/service/dynamodbstreams/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/dynamodbstreams go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/dynamodbstreams/types/types.go b/service/dynamodbstreams/types/types.go index 9a5ec3031ec..c9c72671c7a 100644 --- a/service/dynamodbstreams/types/types.go +++ b/service/dynamodbstreams/types/types.go @@ -13,20 +13,23 @@ import ( // multi-valued attribute is a set; duplicate values are not allowed. type AttributeValue struct { + // A Binary data type. + B []byte + // A Boolean data type. BOOL *bool - // A Map data type. - M map[string]*AttributeValue + // A Binary Set data type. + BS [][]byte // A List data type. L []*AttributeValue - // A String data type. - S *string + // A Map data type. + M map[string]*AttributeValue - // A Binary data type. - B []byte + // A Number data type. + N *string // A Number Set data type. NS []*string @@ -34,11 +37,8 @@ type AttributeValue struct { // A Null data type. NULL *bool - // A Number data type. - N *string - - // A Binary Set data type. - BS [][]byte + // A String data type. + S *string // A String Set data type. SS []*string @@ -47,12 +47,12 @@ type AttributeValue struct { // Contains details about the type of identity that made the request. type Identity struct { - // The type of the identity. For Time To Live, the type is "Service". - Type *string - // A unique identifier for the entity that made the call. For Time To Live, the // principalId is "dynamodb.amazonaws.com". PrincipalId *string + + // The type of the identity. For Time To Live, the type is "Service". + Type *string } // Represents a single element of a key schema. A key schema specifies the @@ -70,26 +70,30 @@ type Identity struct { // the sort key value. type KeySchemaElement struct { - // The attribute data, consisting of the data type and the attribute value itself. + // The name of a key attribute. // // This member is required. - KeyType KeyType + AttributeName *string - // The name of a key attribute. + // The attribute data, consisting of the data type and the attribute value itself. // // This member is required. - AttributeName *string + KeyType KeyType } // A description of a unique event within a stream. type Record struct { + // The region in which the GetRecords request was received. + AwsRegion *string + // The main body of the stream record, containing all of the DynamoDB-specific // fields. Dynamodb *StreamRecord - // The region in which the GetRecords request was received. - AwsRegion *string + // A globally unique identifier for the event that was recorded in this stream + // record. + EventID *string // The type of data modification that was performed on the DynamoDB table: // @@ -107,6 +111,13 @@ type Record struct { // this is aws:dynamodb. EventSource *string + // The version number of the stream record format. This number is updated whenever + // the structure of Record is modified. Client applications must not assume that + // eventVersion will remain at a particular value, as this number is subject to + // change at any time. In general, eventVersion will only increase as the low-level + // DynamoDB Streams API evolves. + EventVersion *string + // Items that are deleted by the Time to Live process after expiration have the // following fields: // @@ -115,17 +126,6 @@ type Record struct { // * // Records[].userIdentity.principalId "dynamodb.amazonaws.com" UserIdentity *Identity - - // The version number of the stream record format. This number is updated whenever - // the structure of Record is modified. Client applications must not assume that - // eventVersion will remain at a particular value, as this number is subject to - // change at any time. In general, eventVersion will only increase as the low-level - // DynamoDB Streams API evolves. - EventVersion *string - - // A globally unique identifier for the event that was recorded in this stream - // record. - EventID *string } // The beginning and ending sequence numbers for the stream records contained @@ -145,16 +145,19 @@ type Shard struct { // The shard ID of the current shard's parent. ParentShardId *string - // The system-generated identifier for this shard. - ShardId *string - // The range of possible sequence numbers for the shard. SequenceNumberRange *SequenceNumberRange + + // The system-generated identifier for this shard. + ShardId *string } // Represents all of the data describing a particular stream. type Stream struct { + // The Amazon Resource Name (ARN) for the stream. + StreamArn *string + // A timestamp, in ISO 8601 format, for this stream. Note that LatestStreamLabel is // not a unique identifier for the stream, because it is possible that a stream // from another table might have the same timestamp. However, the combination of @@ -170,14 +173,17 @@ type Stream struct { // The DynamoDB table with which the stream is associated. TableName *string - - // The Amazon Resource Name (ARN) for the stream. - StreamArn *string } // Represents all of the data describing a particular stream. type StreamDescription struct { + // The date and time when the request to create this stream was issued. + CreationRequestDateTime *time.Time + + // The key attribute(s) of the stream's DynamoDB table. + KeySchema []*KeySchemaElement + // The shard ID of the item where the operation stopped, inclusive of the previous // result set. Use this value to start a new operation, excluding this value in the // new request. If LastEvaluatedShardId is empty, then the "last page" of results @@ -187,31 +193,12 @@ type StreamDescription struct { // of the result set is when LastEvaluatedShardId is empty. LastEvaluatedShardId *string - // The key attribute(s) of the stream's DynamoDB table. - KeySchema []*KeySchemaElement - - // Indicates the format of the records within this stream: - // - // * KEYS_ONLY - only - // the key attributes of items that were modified in the DynamoDB table. - // - // * - // NEW_IMAGE - entire items from the table, as they appeared after they were - // modified. - // - // * OLD_IMAGE - entire items from the table, as they appeared - // before they were modified. - // - // * NEW_AND_OLD_IMAGES - both the new and the old - // images of the items from the table. - StreamViewType StreamViewType + // The shards that comprise the stream. + Shards []*Shard // The Amazon Resource Name (ARN) for the stream. StreamArn *string - // The shards that comprise the stream. - Shards []*Shard - // A timestamp, in ISO 8601 format, for this stream. Note that LatestStreamLabel is // not a unique identifier for the stream, because it is possible that a stream // from another table might have the same timestamp. However, the combination of @@ -225,9 +212,6 @@ type StreamDescription struct { // * the StreamLabel StreamLabel *string - // The date and time when the request to create this stream was issued. - CreationRequestDateTime *time.Time - // Indicates the current status of the stream: // // * ENABLING - Streams is @@ -242,6 +226,22 @@ type StreamDescription struct { // * DISABLED - the stream is disabled. StreamStatus StreamStatus + // Indicates the format of the records within this stream: + // + // * KEYS_ONLY - only + // the key attributes of items that were modified in the DynamoDB table. + // + // * + // NEW_IMAGE - entire items from the table, as they appeared after they were + // modified. + // + // * OLD_IMAGE - entire items from the table, as they appeared + // before they were modified. + // + // * NEW_AND_OLD_IMAGES - both the new and the old + // images of the items from the table. + StreamViewType StreamViewType + // The DynamoDB table with which the stream is associated. TableName *string } @@ -250,9 +250,25 @@ type StreamDescription struct { // DynamoDB table. type StreamRecord struct { + // The approximate date and time when the stream record was created, in UNIX epoch + // time (http://www.epochconverter.com/) format. + ApproximateCreationDateTime *time.Time + + // The primary key attribute(s) for the DynamoDB item that was modified. + Keys map[string]*AttributeValue + + // The item in the DynamoDB table as it appeared after it was modified. + NewImage map[string]*AttributeValue + + // The item in the DynamoDB table as it appeared before it was modified. + OldImage map[string]*AttributeValue + // The sequence number of the stream record. SequenceNumber *string + // The size of the stream record, in bytes. + SizeBytes *int64 + // The type of data from the modified DynamoDB item that was captured in this // stream record: // @@ -268,20 +284,4 @@ type StreamRecord struct { // * NEW_AND_OLD_IMAGES - both the new and the old item images of // the item. StreamViewType StreamViewType - - // The item in the DynamoDB table as it appeared before it was modified. - OldImage map[string]*AttributeValue - - // The approximate date and time when the stream record was created, in UNIX epoch - // time (http://www.epochconverter.com/) format. - ApproximateCreationDateTime *time.Time - - // The primary key attribute(s) for the DynamoDB item that was modified. - Keys map[string]*AttributeValue - - // The size of the stream record, in bytes. - SizeBytes *int64 - - // The item in the DynamoDB table as it appeared after it was modified. - NewImage map[string]*AttributeValue } diff --git a/service/ebs/api_op_CompleteSnapshot.go b/service/ebs/api_op_CompleteSnapshot.go index e8a2b098d93..56c177ed817 100644 --- a/service/ebs/api_op_CompleteSnapshot.go +++ b/service/ebs/api_op_CompleteSnapshot.go @@ -59,6 +59,16 @@ func (c *Client) CompleteSnapshot(ctx context.Context, params *CompleteSnapshotI type CompleteSnapshotInput struct { + // The number of blocks that were written to the snapshot. + // + // This member is required. + ChangedBlocksCount *int32 + + // The ID of the snapshot. + // + // This member is required. + SnapshotId *string + // An aggregated Base-64 SHA256 checksum based on the checksums of each written // block. To generate the aggregated checksum using the linear aggregation method, // arrange the checksums for each written block in ascending order of their block @@ -66,20 +76,10 @@ type CompleteSnapshotInput struct { // on the entire string using the SHA256 algorithm. Checksum *string - // The ID of the snapshot. - // - // This member is required. - SnapshotId *string - // The aggregation method used to generate the checksum. Currently, the only // supported aggregation method is LINEAR. ChecksumAggregationMethod types.ChecksumAggregationMethod - // The number of blocks that were written to the snapshot. - // - // This member is required. - ChangedBlocksCount *int32 - // The algorithm used to generate the checksum. Currently, the only supported // algorithm is SHA256. ChecksumAlgorithm types.ChecksumAlgorithm diff --git a/service/ebs/api_op_GetSnapshotBlock.go b/service/ebs/api_op_GetSnapshotBlock.go index 49b6c54eea7..095cf6443d0 100644 --- a/service/ebs/api_op_GetSnapshotBlock.go +++ b/service/ebs/api_op_GetSnapshotBlock.go @@ -57,19 +57,19 @@ func (c *Client) GetSnapshotBlock(ctx context.Context, params *GetSnapshotBlockI type GetSnapshotBlockInput struct { - // The block token of the block from which to get data.

    Obtain the - // BlockToken by running the ListChangedBlocks or + // The block index of the block from which to get data.

    Obtain the + // BlockIndex by running the ListChangedBlocks or // ListSnapshotBlocks operations.

    // // This member is required. - BlockToken *string + BlockIndex *int32 - // The block index of the block from which to get data.

    Obtain the - // BlockIndex by running the ListChangedBlocks or + // The block token of the block from which to get data.

    Obtain the + // BlockToken by running the ListChangedBlocks or // ListSnapshotBlocks operations.

    // // This member is required. - BlockIndex *int32 + BlockToken *string // The ID of the snapshot containing the block from which to get data. // @@ -85,12 +85,12 @@ type GetSnapshotBlockOutput struct { // The checksum generated for the block, which is Base64 encoded. Checksum *string - // The size of the data in the block. - DataLength *int32 - // The algorithm used to generate the checksum for the block, such as SHA256. ChecksumAlgorithm types.ChecksumAlgorithm + // The size of the data in the block. + DataLength *int32 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ebs/api_op_ListChangedBlocks.go b/service/ebs/api_op_ListChangedBlocks.go index ec57617f223..24cc2fb7e1f 100644 --- a/service/ebs/api_op_ListChangedBlocks.go +++ b/service/ebs/api_op_ListChangedBlocks.go @@ -59,23 +59,23 @@ func (c *Client) ListChangedBlocks(ctx context.Context, params *ListChangedBlock type ListChangedBlocksInput struct { + // The ID of the second snapshot to use for the comparison. The SecondSnapshotId + // parameter must be specified with a FirstSnapshotID parameter; otherwise, an + // error occurs. + // + // This member is required. + SecondSnapshotId *string + // The ID of the first snapshot to use for the comparison. The FirstSnapshotID // parameter must be specified with a SecondSnapshotId parameter; otherwise, an // error occurs. FirstSnapshotId *string - // The token to request the next page of results. - NextToken *string - // The number of results to return. MaxResults *int32 - // The ID of the second snapshot to use for the comparison. The SecondSnapshotId - // parameter must be specified with a FirstSnapshotID parameter; otherwise, an - // error occurs. - // - // This member is required. - SecondSnapshotId *string + // The token to request the next page of results. + NextToken *string // The block index from which the comparison should start.

    The list in the // response will start from this block index or the next valid block index in the @@ -85,21 +85,21 @@ type ListChangedBlocksInput struct { type ListChangedBlocksOutput struct { - // The token to use to retrieve the next page of results. This value is null when - // there are no more results to return. - NextToken *string - - // The size of the volume in GB. - VolumeSize *int64 - // The size of the block. BlockSize *int32 + // An array of objects containing information about the changed blocks. + ChangedBlocks []*types.ChangedBlock + // The time when the BlockToken expires. ExpiryTime *time.Time - // An array of objects containing information about the changed blocks. - ChangedBlocks []*types.ChangedBlock + // The token to use to retrieve the next page of results. This value is null when + // there are no more results to return. + NextToken *string + + // The size of the volume in GB. + VolumeSize *int64 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/ebs/api_op_ListSnapshotBlocks.go b/service/ebs/api_op_ListSnapshotBlocks.go index 8240944a98a..b87fe657cfb 100644 --- a/service/ebs/api_op_ListSnapshotBlocks.go +++ b/service/ebs/api_op_ListSnapshotBlocks.go @@ -64,35 +64,35 @@ type ListSnapshotBlocksInput struct { // This member is required. SnapshotId *string - // The block index from which the list should start. The list in the response will - // start from this block index or the next valid block index in the snapshot. - StartingBlockIndex *int32 + // The number of results to return. + MaxResults *int32 // The token to request the next page of results. NextToken *string - // The number of results to return. - MaxResults *int32 + // The block index from which the list should start. The list in the response will + // start from this block index or the next valid block index in the snapshot. + StartingBlockIndex *int32 } type ListSnapshotBlocksOutput struct { - // The size of the volume in GB. - VolumeSize *int64 - - // The token to use to retrieve the next page of results. This value is null when - // there are no more results to return. - NextToken *string + // The size of the block. + BlockSize *int32 // An array of objects containing information about the blocks. Blocks []*types.Block - // The size of the block. - BlockSize *int32 - // The time when the BlockToken expires. ExpiryTime *time.Time + // The token to use to retrieve the next page of results. This value is null when + // there are no more results to return. + NextToken *string + + // The size of the volume in GB. + VolumeSize *int64 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ebs/api_op_PutSnapshotBlock.go b/service/ebs/api_op_PutSnapshotBlock.go index 040582d5ed9..5b37d4e2bae 100644 --- a/service/ebs/api_op_PutSnapshotBlock.go +++ b/service/ebs/api_op_PutSnapshotBlock.go @@ -62,14 +62,20 @@ func (c *Client) PutSnapshotBlock(ctx context.Context, params *PutSnapshotBlockI type PutSnapshotBlockInput struct { - // The size of the data to write to the block, in bytes. Currently, the only - // supported size is 524288. Valid values: 524288 + // The data to write to the block. The block data is not signed as part of the + // Signature Version 4 signing process. As a result, you must generate and provide + // a Base64-encoded SHA256 checksum for the block data using the x-amz-Checksum + // header. Also, you must specify the checksum algorithm using the + // x-amz-Checksum-Algorithm header. The checksum that you provide is part of the + // Signature Version 4 signing process. It is validated against a checksum + // generated by Amazon EBS to ensure the validity and authenticity of the data. If + // the checksums do not correspond, the request fails. For more information, see + // Using checksums with the EBS direct APIs + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapis-using-checksums) + // in the Amazon Elastic Compute Cloud User Guide. // // This member is required. - DataLength *int32 - - // The progress of the write process, as a percentage. - Progress *int32 + BlockData io.Reader // The block index of the block in which to write the data. A block index is the // offset position of a block within a snapshot, and it is used to identify the @@ -85,31 +91,25 @@ type PutSnapshotBlockInput struct { // This member is required. Checksum *string - // The ID of the snapshot. - // - // This member is required. - SnapshotId *string - // The algorithm used to generate the checksum. Currently, the only supported // algorithm is SHA256. // // This member is required. ChecksumAlgorithm types.ChecksumAlgorithm - // The data to write to the block. The block data is not signed as part of the - // Signature Version 4 signing process. As a result, you must generate and provide - // a Base64-encoded SHA256 checksum for the block data using the x-amz-Checksum - // header. Also, you must specify the checksum algorithm using the - // x-amz-Checksum-Algorithm header. The checksum that you provide is part of the - // Signature Version 4 signing process. It is validated against a checksum - // generated by Amazon EBS to ensure the validity and authenticity of the data. If - // the checksums do not correspond, the request fails. For more information, see - // Using checksums with the EBS direct APIs - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapis-using-checksums) - // in the Amazon Elastic Compute Cloud User Guide. + // The size of the data to write to the block, in bytes. Currently, the only + // supported size is 524288. Valid values: 524288 // // This member is required. - BlockData io.Reader + DataLength *int32 + + // The ID of the snapshot. + // + // This member is required. + SnapshotId *string + + // The progress of the write process, as a percentage. + Progress *int32 } type PutSnapshotBlockOutput struct { diff --git a/service/ebs/api_op_StartSnapshot.go b/service/ebs/api_op_StartSnapshot.go index e0fdc1cabc6..dd40ab182b7 100644 --- a/service/ebs/api_op_StartSnapshot.go +++ b/service/ebs/api_op_StartSnapshot.go @@ -63,6 +63,11 @@ func (c *Client) StartSnapshot(ctx context.Context, params *StartSnapshotInput, type StartSnapshotInput struct { + // The size of the volume, in GiB. The maximum size is 16384 GiB (16 TiB). + // + // This member is required. + VolumeSize *int64 + // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. Idempotency ensures that an API request completes only once. // With an idempotent request, if the original request completes successfully. The @@ -77,22 +82,6 @@ type StartSnapshotInput struct { // A description for the snapshot. Description *string - // The tags to apply to the snapshot. - Tags []*types.Tag - - // The size of the volume, in GiB. The maximum size is 16384 GiB (16 TiB). - // - // This member is required. - VolumeSize *int64 - - // The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) - // customer master key (CMK) to be used to encrypt the snapshot. If you do not - // specify a CMK, the default AWS managed CMK is used. If you specify a - // ParentSnapshotId, omit this parameter; the snapshot will be encrypted using the - // same CMK that was used to encrypt the parent snapshot. If Encrypted is set to - // true, you must specify a CMK ARN. - KmsKeyArn *string - // Indicates whether to encrypt the snapshot. To create an encrypted snapshot, // specify true. To create an unencrypted snapshot, omit this parameter. If you // specify a value for ParentSnapshotId, omit this parameter. If you specify true, @@ -108,6 +97,14 @@ type StartSnapshotInput struct { // Using encryption in the Amazon Elastic Compute Cloud User Guide.

    Encrypted *bool + // The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) + // customer master key (CMK) to be used to encrypt the snapshot. If you do not + // specify a CMK, the default AWS managed CMK is used. If you specify a + // ParentSnapshotId, omit this parameter; the snapshot will be encrypted using the + // same CMK that was used to encrypt the parent snapshot. If Encrypted is set to + // true, you must specify a CMK ARN. + KmsKeyArn *string + // The ID of the parent snapshot. If there is no parent snapshot, or if you are // creating the first snapshot for an on-premises volume, omit this parameter. If // your account is enabled for encryption by default, you cannot use an unencrypted @@ -116,6 +113,9 @@ type StartSnapshotInput struct { // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CopySnapshot.html). ParentSnapshotId *string + // The tags to apply to the snapshot. + Tags []*types.Tag + // The amount of time (in minutes) after which the snapshot is automatically // cancelled if: // @@ -131,14 +131,8 @@ type StartSnapshotInput struct { type StartSnapshotOutput struct { - // The timestamp when the snapshot was created. - StartTime *time.Time - - // The AWS account ID of the snapshot owner. - OwnerId *string - - // The ID of the snapshot. - SnapshotId *string + // The size of the blocks in the snapshot, in bytes. + BlockSize *int32 // The description of the snapshot. Description *string @@ -147,15 +141,21 @@ type StartSnapshotOutput struct { // customer master key (CMK) used to encrypt the snapshot. KmsKeyArn *string + // The AWS account ID of the snapshot owner. + OwnerId *string + // The ID of the parent snapshot. ParentSnapshotId *string + // The ID of the snapshot. + SnapshotId *string + + // The timestamp when the snapshot was created. + StartTime *time.Time + // The status of the snapshot. Status types.Status - // The size of the blocks in the snapshot, in bytes. - BlockSize *int32 - // The tags applied to the snapshot. You can specify up to 50 tags per snapshot. // For more information, see Tagging your Amazon EC2 resources // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) in the diff --git a/service/ebs/go.mod b/service/ebs/go.mod index a437012ac53..5bdcd846056 100644 --- a/service/ebs/go.mod +++ b/service/ebs/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/ebs go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/ebs/types/types.go b/service/ebs/types/types.go index 7bc7cf6fc88..22f8c9089ed 100644 --- a/service/ebs/types/types.go +++ b/service/ebs/types/types.go @@ -32,9 +32,9 @@ type ChangedBlock struct { // Describes a tag. type Tag struct { - // The value of the tag. - Value *string - // The key of the tag. Key *string + + // The value of the tag. + Value *string } diff --git a/service/ec2/api_op_AcceptReservedInstancesExchangeQuote.go b/service/ec2/api_op_AcceptReservedInstancesExchangeQuote.go index 13094da3302..ee4407b1246 100644 --- a/service/ec2/api_op_AcceptReservedInstancesExchangeQuote.go +++ b/service/ec2/api_op_AcceptReservedInstancesExchangeQuote.go @@ -65,15 +65,15 @@ type AcceptReservedInstancesExchangeQuoteInput struct { // This member is required. ReservedInstanceIds []*string - // The configuration of the target Convertible Reserved Instance to exchange for - // your current Convertible Reserved Instances. - TargetConfigurations []*types.TargetConfigurationRequest - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // The configuration of the target Convertible Reserved Instance to exchange for + // your current Convertible Reserved Instances. + TargetConfigurations []*types.TargetConfigurationRequest } // The result of the exchange and whether it was successful. diff --git a/service/ec2/api_op_AcceptVpcPeeringConnection.go b/service/ec2/api_op_AcceptVpcPeeringConnection.go index c85db8760a0..be267f79307 100644 --- a/service/ec2/api_op_AcceptVpcPeeringConnection.go +++ b/service/ec2/api_op_AcceptVpcPeeringConnection.go @@ -60,15 +60,15 @@ func (c *Client) AcceptVpcPeeringConnection(ctx context.Context, params *AcceptV type AcceptVpcPeeringConnectionInput struct { - // The ID of the VPC peering connection. You must specify this parameter in the - // request. - VpcPeeringConnectionId *string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // The ID of the VPC peering connection. You must specify this parameter in the + // request. + VpcPeeringConnectionId *string } type AcceptVpcPeeringConnectionOutput struct { diff --git a/service/ec2/api_op_AllocateAddress.go b/service/ec2/api_op_AllocateAddress.go index 482bc017459..a1c07fa8b19 100644 --- a/service/ec2/api_op_AllocateAddress.go +++ b/service/ec2/api_op_AllocateAddress.go @@ -75,6 +75,26 @@ func (c *Client) AllocateAddress(ctx context.Context, params *AllocateAddressInp type AllocateAddressInput struct { + // [EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address + // pool. + Address *string + + // The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 + // select an address from the address pool. Alternatively, specify a specific + // address from the address pool. + CustomerOwnedIpv4Pool *string + + // Indicates whether the Elastic IP address is for use with instances in a VPC or + // instances in EC2-Classic. Default: If the Region supports EC2-Classic, the + // default is standard. Otherwise, the default is vpc. + Domain types.DomainType + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // The location from which the IP address is advertised. Use this parameter to // limit the address to this location. A network border group is a unique set of // Availability Zones or Local Zones from where AWS advertises IP addresses and @@ -89,56 +109,36 @@ type AllocateAddressInput struct { // Codes.

    NetworkBorderGroup *string - // Indicates whether the Elastic IP address is for use with instances in a VPC or - // instances in EC2-Classic. Default: If the Region supports EC2-Classic, the - // default is standard. Otherwise, the default is vpc. - Domain types.DomainType - - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The ID of an address pool that you own. Use this parameter to let Amazon EC2 // select an address from the address pool. To specify a specific address from the // address pool, use the Address parameter instead. PublicIpv4Pool *string - - // The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 - // select an address from the address pool. Alternatively, specify a specific - // address from the address pool. - CustomerOwnedIpv4Pool *string - - // [EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address - // pool. - Address *string } type AllocateAddressOutput struct { + // [EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP + // address for use with instances in a VPC. + AllocationId *string + // The customer-owned IP address. CustomerOwnedIp *string + // The ID of the customer-owned address pool. + CustomerOwnedIpv4Pool *string + // Indicates whether the Elastic IP address is for use with instances in a VPC // (vpc) or instances in EC2-Classic (standard). Domain types.DomainType - // The ID of an address pool. - PublicIpv4Pool *string - - // The Elastic IP address. - PublicIp *string - // The location from which the IP address is advertised. NetworkBorderGroup *string - // The ID of the customer-owned address pool. - CustomerOwnedIpv4Pool *string + // The Elastic IP address. + PublicIp *string - // [EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP - // address for use with instances in a VPC. - AllocationId *string + // The ID of an address pool. + PublicIpv4Pool *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/ec2/api_op_AllocateHosts.go b/service/ec2/api_op_AllocateHosts.go index 37923ba1399..4d1a7d2116d 100644 --- a/service/ec2/api_op_AllocateHosts.go +++ b/service/ec2/api_op_AllocateHosts.go @@ -59,35 +59,29 @@ func (c *Client) AllocateHosts(ctx context.Context, params *AllocateHostsInput, type AllocateHostsInput struct { - // Indicates whether the host accepts any untargeted instance launches that match - // its instance type configuration, or if it only accepts Host tenancy instance - // launches that specify its unique host ID. For more information, see - // Understanding Instance Placement and Host Affinity - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-understanding) - // in the Amazon EC2 User Guide for Linux Instances.

    Default: on - //

    - AutoPlacement types.AutoPlacement - // The Availability Zone in which to allocate the Dedicated Host. // // This member is required. AvailabilityZone *string - // Specifies the instance family to be supported by the Dedicated Hosts. If you - // specify an instance family, the Dedicated Hosts support multiple instance types - // within that instance family.

    If you want the Dedicated Hosts to support a - // specific instance type only, omit this parameter and specify InstanceType - // instead. You cannot specify InstanceFamily and InstanceType in the - // same request.

    - InstanceFamily *string - // The number of Dedicated Hosts to allocate to your account with these parameters. // // This member is required. Quantity *int32 - // The tags to apply to the Dedicated Host during creation. - TagSpecifications []*types.TagSpecification + // Indicates whether the host accepts any untargeted instance launches that match + // its instance type configuration, or if it only accepts Host tenancy instance + // launches that specify its unique host ID. For more information, see + // Understanding Instance Placement and Host Affinity + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-understanding) + // in the Amazon EC2 User Guide for Linux Instances.

    Default: on + //

    + AutoPlacement types.AutoPlacement + + // Unique, case-sensitive identifier that you provide to ensure the idempotency of + // the request. For more information, see How to Ensure Idempotency + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + ClientToken *string // Indicates whether to enable or disable host recovery for the Dedicated Host. // Host recovery is disabled by default. For more information, see Host Recovery @@ -95,10 +89,13 @@ type AllocateHostsInput struct { // in the Amazon Elastic Compute Cloud User Guide. Default: off HostRecovery types.HostRecovery - // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to Ensure Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). - ClientToken *string + // Specifies the instance family to be supported by the Dedicated Hosts. If you + // specify an instance family, the Dedicated Hosts support multiple instance types + // within that instance family.

    If you want the Dedicated Hosts to support a + // specific instance type only, omit this parameter and specify InstanceType + // instead. You cannot specify InstanceFamily and InstanceType in the + // same request.

    + InstanceFamily *string // Specifies the instance type to be supported by the Dedicated Hosts. If you // specify an instance type, the Dedicated Hosts support instances of the specified @@ -107,6 +104,9 @@ type AllocateHostsInput struct { // InstanceFamily instead. You cannot specify InstanceType and // InstanceFamily in the same request.

    InstanceType *string + + // The tags to apply to the Dedicated Host during creation. + TagSpecifications []*types.TagSpecification } // Contains the output of AllocateHosts. diff --git a/service/ec2/api_op_ApplySecurityGroupsToClientVpnTargetNetwork.go b/service/ec2/api_op_ApplySecurityGroupsToClientVpnTargetNetwork.go index d470b901f7a..1d651a309aa 100644 --- a/service/ec2/api_op_ApplySecurityGroupsToClientVpnTargetNetwork.go +++ b/service/ec2/api_op_ApplySecurityGroupsToClientVpnTargetNetwork.go @@ -63,17 +63,17 @@ type ApplySecurityGroupsToClientVpnTargetNetworkInput struct { // This member is required. ClientVpnEndpointId *string - // The ID of the VPC in which the associated target network is located. - // - // This member is required. - VpcId *string - // The IDs of the security groups to apply to the associated target network. Up to // 5 security groups can be applied to an associated target network. // // This member is required. SecurityGroupIds []*string + // The ID of the VPC in which the associated target network is located. + // + // This member is required. + VpcId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is diff --git a/service/ec2/api_op_AssignIpv6Addresses.go b/service/ec2/api_op_AssignIpv6Addresses.go index 647261b597f..507ba52ad54 100644 --- a/service/ec2/api_op_AssignIpv6Addresses.go +++ b/service/ec2/api_op_AssignIpv6Addresses.go @@ -64,10 +64,6 @@ func (c *Client) AssignIpv6Addresses(ctx context.Context, params *AssignIpv6Addr type AssignIpv6AddressesInput struct { - // One or more specific IPv6 addresses to be assigned to the network interface. You - // can't use this option if you're specifying a number of IPv6 addresses. - Ipv6Addresses []*string - // The ID of the network interface. // // This member is required. @@ -77,16 +73,20 @@ type AssignIpv6AddressesInput struct { // automatically selects the IPv6 addresses from the subnet range. You can't use // this option if specifying specific IPv6 addresses. Ipv6AddressCount *int32 + + // One or more specific IPv6 addresses to be assigned to the network interface. You + // can't use this option if you're specifying a number of IPv6 addresses. + Ipv6Addresses []*string } type AssignIpv6AddressesOutput struct { - // The ID of the network interface. - NetworkInterfaceId *string - // The IPv6 addresses assigned to the network interface. AssignedIpv6Addresses []*string + // The ID of the network interface. + NetworkInterfaceId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_AssignPrivateIpAddresses.go b/service/ec2/api_op_AssignPrivateIpAddresses.go index 5c3dbfd977d..e260afd8f13 100644 --- a/service/ec2/api_op_AssignPrivateIpAddresses.go +++ b/service/ec2/api_op_AssignPrivateIpAddresses.go @@ -74,6 +74,11 @@ func (c *Client) AssignPrivateIpAddresses(ctx context.Context, params *AssignPri // Contains the parameters for AssignPrivateIpAddresses. type AssignPrivateIpAddressesInput struct { + // The ID of the network interface. + // + // This member is required. + NetworkInterfaceId *string + // Indicates whether to allow an IP address that is already assigned to another // network interface or instance to be reassigned to the specified network // interface. @@ -85,11 +90,6 @@ type AssignPrivateIpAddressesInput struct { // automatically selects an IP address within the subnet range. PrivateIpAddresses []*string - // The ID of the network interface. - // - // This member is required. - NetworkInterfaceId *string - // The number of secondary IP addresses to assign to the network interface. You // can't specify this parameter when also specifying private IP addresses. SecondaryPrivateIpAddressCount *int32 diff --git a/service/ec2/api_op_AssociateAddress.go b/service/ec2/api_op_AssociateAddress.go index b5a10e637df..bdf5de8b326 100644 --- a/service/ec2/api_op_AssociateAddress.go +++ b/service/ec2/api_op_AssociateAddress.go @@ -76,6 +76,9 @@ func (c *Client) AssociateAddress(ctx context.Context, params *AssociateAddressI type AssociateAddressInput struct { + // [EC2-VPC] The allocation ID. This is required for EC2-VPC. + AllocationId *string + // [EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic // IP address that is already associated with an instance or network interface to // be reassociated with the specified instance or network interface. Otherwise, the @@ -84,16 +87,6 @@ type AssociateAddressInput struct { // Elastic IP address is already associated with another resource. AllowReassociation *bool - // [EC2-VPC] The primary or secondary private IP address to associate with the - // Elastic IP address. If no private IP address is specified, the Elastic IP - // address is associated with the primary private IP address. - PrivateIpAddress *string - - // [EC2-VPC] The ID of the network interface. If the instance has more than one - // network interface, you must specify a network interface ID. For EC2-VPC, you can - // specify either the instance ID or the network interface ID, but not both. - NetworkInterfaceId *string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -106,12 +99,19 @@ type AssociateAddressInput struct { // interface is attached. InstanceId *string + // [EC2-VPC] The ID of the network interface. If the instance has more than one + // network interface, you must specify a network interface ID. For EC2-VPC, you can + // specify either the instance ID or the network interface ID, but not both. + NetworkInterfaceId *string + + // [EC2-VPC] The primary or secondary private IP address to associate with the + // Elastic IP address. If no private IP address is specified, the Elastic IP + // address is associated with the primary private IP address. + PrivateIpAddress *string + // The Elastic IP address to associate with the instance. This is required for // EC2-Classic. PublicIp *string - - // [EC2-VPC] The allocation ID. This is required for EC2-VPC. - AllocationId *string } type AssociateAddressOutput struct { diff --git a/service/ec2/api_op_AssociateClientVpnTargetNetwork.go b/service/ec2/api_op_AssociateClientVpnTargetNetwork.go index 4d4309812fb..b40fb5ee82f 100644 --- a/service/ec2/api_op_AssociateClientVpnTargetNetwork.go +++ b/service/ec2/api_op_AssociateClientVpnTargetNetwork.go @@ -67,6 +67,16 @@ func (c *Client) AssociateClientVpnTargetNetwork(ctx context.Context, params *As type AssociateClientVpnTargetNetworkInput struct { + // The ID of the Client VPN endpoint. + // + // This member is required. + ClientVpnEndpointId *string + + // The ID of the subnet to associate with the Client VPN endpoint. + // + // This member is required. + SubnetId *string + // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. For more information, see How to Ensure Idempotency // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). @@ -77,16 +87,6 @@ type AssociateClientVpnTargetNetworkInput struct { // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The ID of the subnet to associate with the Client VPN endpoint. - // - // This member is required. - SubnetId *string - - // The ID of the Client VPN endpoint. - // - // This member is required. - ClientVpnEndpointId *string } type AssociateClientVpnTargetNetworkOutput struct { diff --git a/service/ec2/api_op_AssociateDhcpOptions.go b/service/ec2/api_op_AssociateDhcpOptions.go index f20de81a36d..4e917e281aa 100644 --- a/service/ec2/api_op_AssociateDhcpOptions.go +++ b/service/ec2/api_op_AssociateDhcpOptions.go @@ -65,17 +65,17 @@ func (c *Client) AssociateDhcpOptions(ctx context.Context, params *AssociateDhcp type AssociateDhcpOptionsInput struct { - // The ID of the VPC. - // - // This member is required. - VpcId *string - // The ID of the DHCP options set, or default to associate no DHCP options with the // VPC. // // This member is required. DhcpOptionsId *string + // The ID of the VPC. + // + // This member is required. + VpcId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is diff --git a/service/ec2/api_op_AssociateIamInstanceProfile.go b/service/ec2/api_op_AssociateIamInstanceProfile.go index 07063fe4dbc..e8efacc9fc0 100644 --- a/service/ec2/api_op_AssociateIamInstanceProfile.go +++ b/service/ec2/api_op_AssociateIamInstanceProfile.go @@ -58,15 +58,15 @@ func (c *Client) AssociateIamInstanceProfile(ctx context.Context, params *Associ type AssociateIamInstanceProfileInput struct { - // The ID of the instance. + // The IAM instance profile. // // This member is required. - InstanceId *string + IamInstanceProfile *types.IamInstanceProfileSpecification - // The IAM instance profile. + // The ID of the instance. // // This member is required. - IamInstanceProfile *types.IamInstanceProfileSpecification + InstanceId *string } type AssociateIamInstanceProfileOutput struct { diff --git a/service/ec2/api_op_AssociateRouteTable.go b/service/ec2/api_op_AssociateRouteTable.go index 9be5f6c214d..9ff923baad3 100644 --- a/service/ec2/api_op_AssociateRouteTable.go +++ b/service/ec2/api_op_AssociateRouteTable.go @@ -64,11 +64,10 @@ func (c *Client) AssociateRouteTable(ctx context.Context, params *AssociateRoute type AssociateRouteTableInput struct { - // The ID of the subnet. - SubnetId *string - - // The ID of the internet gateway or virtual private gateway. - GatewayId *string + // The ID of the route table. + // + // This member is required. + RouteTableId *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the @@ -76,21 +75,22 @@ type AssociateRouteTableInput struct { // UnauthorizedOperation. DryRun *bool - // The ID of the route table. - // - // This member is required. - RouteTableId *string + // The ID of the internet gateway or virtual private gateway. + GatewayId *string + + // The ID of the subnet. + SubnetId *string } type AssociateRouteTableOutput struct { - // The state of the association. - AssociationState *types.RouteTableAssociationState - // The route table association ID. This ID is required for disassociating the route // table. AssociationId *string + // The state of the association. + AssociationState *types.RouteTableAssociationState + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_AssociateSubnetCidrBlock.go b/service/ec2/api_op_AssociateSubnetCidrBlock.go index 531a6277765..b0a6413fbbd 100644 --- a/service/ec2/api_op_AssociateSubnetCidrBlock.go +++ b/service/ec2/api_op_AssociateSubnetCidrBlock.go @@ -72,12 +72,12 @@ type AssociateSubnetCidrBlockInput struct { type AssociateSubnetCidrBlockOutput struct { - // The ID of the subnet. - SubnetId *string - // Information about the IPv6 CIDR block association. Ipv6CidrBlockAssociation *types.SubnetIpv6CidrBlockAssociation + // The ID of the subnet. + SubnetId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_AssociateTransitGatewayMulticastDomain.go b/service/ec2/api_op_AssociateTransitGatewayMulticastDomain.go index 855d51bb035..537af809983 100644 --- a/service/ec2/api_op_AssociateTransitGatewayMulticastDomain.go +++ b/service/ec2/api_op_AssociateTransitGatewayMulticastDomain.go @@ -70,12 +70,12 @@ type AssociateTransitGatewayMulticastDomainInput struct { // The IDs of the subnets to associate with the transit gateway multicast domain. SubnetIds []*string - // The ID of the transit gateway multicast domain. - TransitGatewayMulticastDomainId *string - // The ID of the transit gateway attachment to associate with the transit gateway // multicast domain. TransitGatewayAttachmentId *string + + // The ID of the transit gateway multicast domain. + TransitGatewayMulticastDomainId *string } type AssociateTransitGatewayMulticastDomainOutput struct { diff --git a/service/ec2/api_op_AssociateTransitGatewayRouteTable.go b/service/ec2/api_op_AssociateTransitGatewayRouteTable.go index 29df26827be..7ec0379ef0c 100644 --- a/service/ec2/api_op_AssociateTransitGatewayRouteTable.go +++ b/service/ec2/api_op_AssociateTransitGatewayRouteTable.go @@ -58,21 +58,21 @@ func (c *Client) AssociateTransitGatewayRouteTable(ctx context.Context, params * type AssociateTransitGatewayRouteTableInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The ID of the attachment. + // + // This member is required. + TransitGatewayAttachmentId *string // The ID of the transit gateway route table. // // This member is required. TransitGatewayRouteTableId *string - // The ID of the attachment. - // - // This member is required. - TransitGatewayAttachmentId *string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool } type AssociateTransitGatewayRouteTableOutput struct { diff --git a/service/ec2/api_op_AssociateVpcCidrBlock.go b/service/ec2/api_op_AssociateVpcCidrBlock.go index d254d45da1b..a0b90b99108 100644 --- a/service/ec2/api_op_AssociateVpcCidrBlock.go +++ b/service/ec2/api_op_AssociateVpcCidrBlock.go @@ -66,42 +66,42 @@ func (c *Client) AssociateVpcCidrBlock(ctx context.Context, params *AssociateVpc type AssociateVpcCidrBlockInput struct { - // The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block. - Ipv6Pool *string + // The ID of the VPC. + // + // This member is required. + VpcId *string + + // Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the + // VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR + // block. + AmazonProvidedIpv6CidrBlock *bool // An IPv4 CIDR block to associate with the VPC. CidrBlock *string - // The name of the location from which we advertise the IPV6 CIDR block. Use this - // parameter to limit the CiDR block to this location. You must set - // AmazonProvidedIpv6CidrBlock to true to use this parameter. You can have one IPv6 - // CIDR block association per network border group. - Ipv6CidrBlockNetworkBorderGroup *string - // An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in // the request. To let Amazon choose the IPv6 CIDR block for you, omit this // parameter. Ipv6CidrBlock *string - // Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the - // VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR - // block. - AmazonProvidedIpv6CidrBlock *bool + // The name of the location from which we advertise the IPV6 CIDR block. Use this + // parameter to limit the CiDR block to this location. You must set + // AmazonProvidedIpv6CidrBlock to true to use this parameter. You can have one IPv6 + // CIDR block association per network border group. + Ipv6CidrBlockNetworkBorderGroup *string - // The ID of the VPC. - // - // This member is required. - VpcId *string + // The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block. + Ipv6Pool *string } type AssociateVpcCidrBlockOutput struct { - // Information about the IPv6 CIDR block association. - Ipv6CidrBlockAssociation *types.VpcIpv6CidrBlockAssociation - // Information about the IPv4 CIDR block association. CidrBlockAssociation *types.VpcCidrBlockAssociation + // Information about the IPv6 CIDR block association. + Ipv6CidrBlockAssociation *types.VpcIpv6CidrBlockAssociation + // The ID of the VPC. VpcId *string diff --git a/service/ec2/api_op_AttachClassicLinkVpc.go b/service/ec2/api_op_AttachClassicLinkVpc.go index 1955f19af4e..db9da6a5dcb 100644 --- a/service/ec2/api_op_AttachClassicLinkVpc.go +++ b/service/ec2/api_op_AttachClassicLinkVpc.go @@ -70,12 +70,6 @@ type AttachClassicLinkVpcInput struct { // This member is required. Groups []*string - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC. // // This member is required. @@ -85,6 +79,12 @@ type AttachClassicLinkVpcInput struct { // // This member is required. VpcId *string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool } type AttachClassicLinkVpcOutput struct { diff --git a/service/ec2/api_op_AttachInternetGateway.go b/service/ec2/api_op_AttachInternetGateway.go index 36b5ea06681..9cb5f467a1c 100644 --- a/service/ec2/api_op_AttachInternetGateway.go +++ b/service/ec2/api_op_AttachInternetGateway.go @@ -59,12 +59,6 @@ func (c *Client) AttachInternetGateway(ctx context.Context, params *AttachIntern type AttachInternetGatewayInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The ID of the internet gateway. // // This member is required. @@ -74,6 +68,12 @@ type AttachInternetGatewayInput struct { // // This member is required. VpcId *string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool } type AttachInternetGatewayOutput struct { diff --git a/service/ec2/api_op_AttachNetworkInterface.go b/service/ec2/api_op_AttachNetworkInterface.go index c8c32951a32..4ba02ccf0a3 100644 --- a/service/ec2/api_op_AttachNetworkInterface.go +++ b/service/ec2/api_op_AttachNetworkInterface.go @@ -57,26 +57,26 @@ func (c *Client) AttachNetworkInterface(ctx context.Context, params *AttachNetwo // Contains the parameters for AttachNetworkInterface. type AttachNetworkInterfaceInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - - // The ID of the instance. + // The index of the device for the network interface attachment. // // This member is required. - InstanceId *string + DeviceIndex *int32 - // The index of the device for the network interface attachment. + // The ID of the instance. // // This member is required. - DeviceIndex *int32 + InstanceId *string // The ID of the network interface. // // This member is required. NetworkInterfaceId *string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool } // Contains the output of AttachNetworkInterface. diff --git a/service/ec2/api_op_AttachVolume.go b/service/ec2/api_op_AttachVolume.go index 5ae105c78ef..11445fb2779 100644 --- a/service/ec2/api_op_AttachVolume.go +++ b/service/ec2/api_op_AttachVolume.go @@ -84,12 +84,6 @@ func (c *Client) AttachVolume(ctx context.Context, params *AttachVolumeInput, op type AttachVolumeInput struct { - // The ID of the EBS volume. The volume and instance must be within the same - // Availability Zone. - // - // This member is required. - VolumeId *string - // The device name (for example, /dev/sdh or xvdh). // // This member is required. @@ -100,6 +94,12 @@ type AttachVolumeInput struct { // This member is required. InstanceId *string + // The ID of the EBS volume. The volume and instance must be within the same + // Availability Zone. + // + // This member is required. + VolumeId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -110,24 +110,24 @@ type AttachVolumeInput struct { // Describes volume attachment details. type AttachVolumeOutput struct { - // The ID of the volume. - VolumeId *string - - // The ID of the instance. - InstanceId *string - // The time stamp when the attachment initiated. AttachTime *time.Time + // Indicates whether the EBS volume is deleted on instance termination. + DeleteOnTermination *bool + // The device name. Device *string - // Indicates whether the EBS volume is deleted on instance termination. - DeleteOnTermination *bool + // The ID of the instance. + InstanceId *string // The attachment state of the volume. State types.VolumeAttachmentState + // The ID of the volume. + VolumeId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_AttachVpnGateway.go b/service/ec2/api_op_AttachVpnGateway.go index d007d58e80e..87a072d3af9 100644 --- a/service/ec2/api_op_AttachVpnGateway.go +++ b/service/ec2/api_op_AttachVpnGateway.go @@ -66,16 +66,16 @@ type AttachVpnGatewayInput struct { // This member is required. VpcId *string + // The ID of the virtual private gateway. + // + // This member is required. + VpnGatewayId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The ID of the virtual private gateway. - // - // This member is required. - VpnGatewayId *string } // Contains the output of AttachVpnGateway. diff --git a/service/ec2/api_op_AuthorizeClientVpnIngress.go b/service/ec2/api_op_AuthorizeClientVpnIngress.go index fe940ff2581..4ba98278bcc 100644 --- a/service/ec2/api_op_AuthorizeClientVpnIngress.go +++ b/service/ec2/api_op_AuthorizeClientVpnIngress.go @@ -62,9 +62,6 @@ func (c *Client) AuthorizeClientVpnIngress(ctx context.Context, params *Authoriz type AuthorizeClientVpnIngressInput struct { - // A brief description of the authorization rule. - Description *string - // The ID of the Client VPN endpoint. // // This member is required. @@ -76,26 +73,29 @@ type AuthorizeClientVpnIngressInput struct { // This member is required. TargetNetworkCidr *string - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The ID of the group to grant access to, for example, the Active Directory group // or identity provider (IdP) group. Required if AuthorizeAllGroups is false or not // specified. AccessGroupId *string + // Indicates whether to grant access to all clients. Specify true to grant all + // clients who successfully establish a VPN connection access to the network. Must + // be set to true if AccessGroupId is not specified. + AuthorizeAllGroups *bool + // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. For more information, see How to Ensure Idempotency // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). ClientToken *string - // Indicates whether to grant access to all clients. Specify true to grant all - // clients who successfully establish a VPN connection access to the network. Must - // be set to true if AccessGroupId is not specified. - AuthorizeAllGroups *bool + // A brief description of the authorization rule. + Description *string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool } type AuthorizeClientVpnIngressOutput struct { diff --git a/service/ec2/api_op_AuthorizeSecurityGroupEgress.go b/service/ec2/api_op_AuthorizeSecurityGroupEgress.go index bbd67a16022..58aeae5e5da 100644 --- a/service/ec2/api_op_AuthorizeSecurityGroupEgress.go +++ b/service/ec2/api_op_AuthorizeSecurityGroupEgress.go @@ -67,41 +67,41 @@ func (c *Client) AuthorizeSecurityGroupEgress(ctx context.Context, params *Autho type AuthorizeSecurityGroupEgressInput struct { - // Not supported. Use a set of IP permissions to specify the port. - ToPort *int32 + // The ID of the security group. + // + // This member is required. + GroupId *string - // Not supported. Use a set of IP permissions to specify a destination security - // group. - SourceSecurityGroupName *string + // Not supported. Use a set of IP permissions to specify the CIDR. + CidrIp *string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // Not supported. Use a set of IP permissions to specify the port. FromPort *int32 - // The ID of the security group. - // - // This member is required. - GroupId *string + // The sets of IP permissions. You can't specify a destination security group and a + // CIDR IP address range in the same set of permissions. + IpPermissions []*types.IpPermission // Not supported. Use a set of IP permissions to specify the protocol name or // number. IpProtocol *string - // The sets of IP permissions. You can't specify a destination security group and a - // CIDR IP address range in the same set of permissions. - IpPermissions []*types.IpPermission + // Not supported. Use a set of IP permissions to specify a destination security + // group. + SourceSecurityGroupName *string // Not supported. Use a set of IP permissions to specify a destination security // group. SourceSecurityGroupOwnerId *string - // Not supported. Use a set of IP permissions to specify the CIDR. - CidrIp *string - - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // Not supported. Use a set of IP permissions to specify the port. + ToPort *int32 } type AuthorizeSecurityGroupEgressOutput struct { diff --git a/service/ec2/api_op_AuthorizeSecurityGroupIngress.go b/service/ec2/api_op_AuthorizeSecurityGroupIngress.go index aabe410eee8..120ee0f348a 100644 --- a/service/ec2/api_op_AuthorizeSecurityGroupIngress.go +++ b/service/ec2/api_op_AuthorizeSecurityGroupIngress.go @@ -65,15 +65,17 @@ func (c *Client) AuthorizeSecurityGroupIngress(ctx context.Context, params *Auth type AuthorizeSecurityGroupIngressInput struct { - // The end of port range for the TCP and UDP protocols, or an ICMP code number. For - // the ICMP code number, use -1 to specify all codes. If you specify all ICMP - // types, you must specify all codes. Alternatively, use a set of IP permissions to - // specify multiple rules and a description for the rule. - ToPort *int32 + // The IPv4 address range, in CIDR format. You can't specify this parameter when + // specifying a source security group. To specify an IPv6 address range, use a set + // of IP permissions. Alternatively, use a set of IP permissions to specify + // multiple rules and a description for the rule. + CidrIp *string - // [EC2-Classic, default VPC] The name of the security group. You must specify - // either the security group ID or the security group name in the request. - GroupName *string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // The start of port range for the TCP and UDP protocols, or an ICMP type number. // For the ICMP type number, use -1 to specify all types. If you specify all ICMP @@ -81,27 +83,17 @@ type AuthorizeSecurityGroupIngressInput struct { // specify multiple rules and a description for the rule. FromPort *int32 - // [nondefault VPC] The AWS account ID for the source security group, if the source - // security group is in a different account. You can't specify this parameter in - // combination with the following parameters: the CIDR IP address range, the IP - // protocol, the start of the port range, and the end of the port range. Creates - // rules that grant full ICMP, UDP, and TCP access. To create a rule with a - // specific IP protocol and port range, use a set of IP permissions instead. - SourceSecurityGroupOwnerId *string + // The ID of the security group. You must specify either the security group ID or + // the security group name in the request. For security groups in a nondefault VPC, + // you must specify the security group ID. + GroupId *string - // [EC2-Classic, default VPC] The name of the source security group. You can't - // specify this parameter in combination with the following parameters: the CIDR IP - // address range, the start of the port range, the IP protocol, and the end of the - // port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a - // rule with a specific IP protocol and port range, use a set of IP permissions - // instead. For EC2-VPC, the source security group must be in the same VPC. - SourceSecurityGroupName *string + // [EC2-Classic, default VPC] The name of the security group. You must specify + // either the security group ID or the security group name in the request. + GroupName *string - // The IPv4 address range, in CIDR format. You can't specify this parameter when - // specifying a source security group. To specify an IPv6 address range, use a set - // of IP permissions. Alternatively, use a set of IP permissions to specify - // multiple rules and a description for the rule. - CidrIp *string + // The sets of IP permissions. + IpPermissions []*types.IpPermission // The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers // (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)). To @@ -112,19 +104,27 @@ type AuthorizeSecurityGroupIngressInput struct { // rule. IpProtocol *string - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // [EC2-Classic, default VPC] The name of the source security group. You can't + // specify this parameter in combination with the following parameters: the CIDR IP + // address range, the start of the port range, the IP protocol, and the end of the + // port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a + // rule with a specific IP protocol and port range, use a set of IP permissions + // instead. For EC2-VPC, the source security group must be in the same VPC. + SourceSecurityGroupName *string - // The sets of IP permissions. - IpPermissions []*types.IpPermission + // [nondefault VPC] The AWS account ID for the source security group, if the source + // security group is in a different account. You can't specify this parameter in + // combination with the following parameters: the CIDR IP address range, the IP + // protocol, the start of the port range, and the end of the port range. Creates + // rules that grant full ICMP, UDP, and TCP access. To create a rule with a + // specific IP protocol and port range, use a set of IP permissions instead. + SourceSecurityGroupOwnerId *string - // The ID of the security group. You must specify either the security group ID or - // the security group name in the request. For security groups in a nondefault VPC, - // you must specify the security group ID. - GroupId *string + // The end of port range for the TCP and UDP protocols, or an ICMP code number. For + // the ICMP code number, use -1 to specify all codes. If you specify all ICMP + // types, you must specify all codes. Alternatively, use a set of IP permissions to + // specify multiple rules and a description for the rule. + ToPort *int32 } type AuthorizeSecurityGroupIngressOutput struct { diff --git a/service/ec2/api_op_BundleInstance.go b/service/ec2/api_op_BundleInstance.go index d0e52e95b76..114e284fed9 100644 --- a/service/ec2/api_op_BundleInstance.go +++ b/service/ec2/api_op_BundleInstance.go @@ -61,11 +61,10 @@ func (c *Client) BundleInstance(ctx context.Context, params *BundleInstanceInput // Contains the parameters for BundleInstance. type BundleInstanceInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The ID of the instance to bundle. Type: String Default: None Required: Yes + // + // This member is required. + InstanceId *string // The bucket in which to store the AMI. You can specify a bucket that you already // own or a new bucket that Amazon EC2 creates on your behalf. If you specify a @@ -74,10 +73,11 @@ type BundleInstanceInput struct { // This member is required. Storage *types.Storage - // The ID of the instance to bundle. Type: String Default: None Required: Yes - // - // This member is required. - InstanceId *string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool } // Contains the output of BundleInstance. diff --git a/service/ec2/api_op_CancelBundleTask.go b/service/ec2/api_op_CancelBundleTask.go index 8a63730f73a..b48e7179d97 100644 --- a/service/ec2/api_op_CancelBundleTask.go +++ b/service/ec2/api_op_CancelBundleTask.go @@ -58,16 +58,16 @@ func (c *Client) CancelBundleTask(ctx context.Context, params *CancelBundleTaskI // Contains the parameters for CancelBundleTask. type CancelBundleTaskInput struct { + // The ID of the bundle task. + // + // This member is required. + BundleId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The ID of the bundle task. - // - // This member is required. - BundleId *string } // Contains the output of CancelBundleTask. diff --git a/service/ec2/api_op_CancelCapacityReservation.go b/service/ec2/api_op_CancelCapacityReservation.go index 19a7535f575..e4e93f29c22 100644 --- a/service/ec2/api_op_CancelCapacityReservation.go +++ b/service/ec2/api_op_CancelCapacityReservation.go @@ -62,16 +62,16 @@ func (c *Client) CancelCapacityReservation(ctx context.Context, params *CancelCa type CancelCapacityReservationInput struct { + // The ID of the Capacity Reservation to be cancelled. + // + // This member is required. + CapacityReservationId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The ID of the Capacity Reservation to be cancelled. - // - // This member is required. - CapacityReservationId *string } type CancelCapacityReservationOutput struct { diff --git a/service/ec2/api_op_CancelConversionTask.go b/service/ec2/api_op_CancelConversionTask.go index 617de9babfd..4c6ac3c6f72 100644 --- a/service/ec2/api_op_CancelConversionTask.go +++ b/service/ec2/api_op_CancelConversionTask.go @@ -62,8 +62,10 @@ func (c *Client) CancelConversionTask(ctx context.Context, params *CancelConvers type CancelConversionTaskInput struct { - // The reason for canceling the conversion task. - ReasonMessage *string + // The ID of the conversion task. + // + // This member is required. + ConversionTaskId *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the @@ -71,10 +73,8 @@ type CancelConversionTaskInput struct { // UnauthorizedOperation. DryRun *bool - // The ID of the conversion task. - // - // This member is required. - ConversionTaskId *string + // The reason for canceling the conversion task. + ReasonMessage *string } type CancelConversionTaskOutput struct { diff --git a/service/ec2/api_op_CancelImportTask.go b/service/ec2/api_op_CancelImportTask.go index d3d0f8f34f0..08f618cd669 100644 --- a/service/ec2/api_op_CancelImportTask.go +++ b/service/ec2/api_op_CancelImportTask.go @@ -55,9 +55,6 @@ func (c *Client) CancelImportTask(ctx context.Context, params *CancelImportTaskI type CancelImportTaskInput struct { - // The ID of the import image or import snapshot task to be canceled. - ImportTaskId *string - // The reason for canceling the task. CancelReason *string @@ -66,18 +63,21 @@ type CancelImportTaskInput struct { // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // The ID of the import image or import snapshot task to be canceled. + ImportTaskId *string } type CancelImportTaskOutput struct { - // The current state of the task being canceled. - State *string + // The ID of the task being canceled. + ImportTaskId *string // The current state of the task being canceled. PreviousState *string - // The ID of the task being canceled. - ImportTaskId *string + // The current state of the task being canceled. + State *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/ec2/api_op_CancelSpotFleetRequests.go b/service/ec2/api_op_CancelSpotFleetRequests.go index 8347dc70a5c..f4d046993e9 100644 --- a/service/ec2/api_op_CancelSpotFleetRequests.go +++ b/service/ec2/api_op_CancelSpotFleetRequests.go @@ -69,17 +69,17 @@ type CancelSpotFleetRequestsInput struct { // This member is required. SpotFleetRequestIds []*string - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // Indicates whether to terminate instances for a Spot Fleet request if it is // canceled successfully. // // This member is required. TerminateInstances *bool + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool } // Contains the output of CancelSpotFleetRequests. diff --git a/service/ec2/api_op_CancelSpotInstanceRequests.go b/service/ec2/api_op_CancelSpotInstanceRequests.go index a5399a50e99..b7bb1931e01 100644 --- a/service/ec2/api_op_CancelSpotInstanceRequests.go +++ b/service/ec2/api_op_CancelSpotInstanceRequests.go @@ -59,16 +59,16 @@ func (c *Client) CancelSpotInstanceRequests(ctx context.Context, params *CancelS // Contains the parameters for CancelSpotInstanceRequests. type CancelSpotInstanceRequestsInput struct { + // One or more Spot Instance request IDs. + // + // This member is required. + SpotInstanceRequestIds []*string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // One or more Spot Instance request IDs. - // - // This member is required. - SpotInstanceRequestIds []*string } // Contains the output of CancelSpotInstanceRequests. diff --git a/service/ec2/api_op_ConfirmProductInstance.go b/service/ec2/api_op_ConfirmProductInstance.go index d104ac26d98..39108c2b08b 100644 --- a/service/ec2/api_op_ConfirmProductInstance.go +++ b/service/ec2/api_op_ConfirmProductInstance.go @@ -58,15 +58,15 @@ func (c *Client) ConfirmProductInstance(ctx context.Context, params *ConfirmProd type ConfirmProductInstanceInput struct { - // The product code. This must be a product code that you own. + // The ID of the instance. // // This member is required. - ProductCode *string + InstanceId *string - // The ID of the instance. + // The product code. This must be a product code that you own. // // This member is required. - InstanceId *string + ProductCode *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the diff --git a/service/ec2/api_op_CopyFpgaImage.go b/service/ec2/api_op_CopyFpgaImage.go index 123db710060..aa18ed35fcd 100644 --- a/service/ec2/api_op_CopyFpgaImage.go +++ b/service/ec2/api_op_CopyFpgaImage.go @@ -61,8 +61,15 @@ type CopyFpgaImageInput struct { // This member is required. SourceFpgaImageId *string - // The name for the new AFI. The default is the name of the source AFI. - Name *string + // The Region that contains the source AFI. + // + // This member is required. + SourceRegion *string + + // Unique, case-sensitive identifier that you provide to ensure the idempotency of + // the request. For more information, see Ensuring Idempotency + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). + ClientToken *string // The description for the new AFI. Description *string @@ -73,15 +80,8 @@ type CopyFpgaImageInput struct { // UnauthorizedOperation. DryRun *bool - // The Region that contains the source AFI. - // - // This member is required. - SourceRegion *string - - // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). - ClientToken *string + // The name for the new AFI. The default is the name of the source AFI. + Name *string } type CopyFpgaImageOutput struct { diff --git a/service/ec2/api_op_CopyImage.go b/service/ec2/api_op_CopyImage.go index d30b3b2fc9a..46de979ccd1 100644 --- a/service/ec2/api_op_CopyImage.go +++ b/service/ec2/api_op_CopyImage.go @@ -65,20 +65,20 @@ func (c *Client) CopyImage(ctx context.Context, params *CopyImageInput, optFns . // Contains the parameters for CopyImage. type CopyImageInput struct { - // The name of the Region that contains the AMI to copy. + // The name of the new AMI in the destination Region. // // This member is required. - SourceRegion *string + Name *string // The ID of the AMI to copy. // // This member is required. SourceImageId *string - // The name of the new AMI in the destination Region. + // The name of the Region that contains the AMI to copy. // // This member is required. - Name *string + SourceRegion *string // Unique, case-sensitive identifier you provide to ensure idempotency of the // request. For more information, see How to Ensure Idempotency @@ -86,14 +86,23 @@ type CopyImageInput struct { // in the Amazon Elastic Compute Cloud User Guide. ClientToken *string + // A description for the new AMI in the destination Region. + Description *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // A description for the new AMI in the destination Region. - Description *string + // Specifies whether the destination snapshots of the copied image should be + // encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot + // create an unencrypted copy of an encrypted snapshot. The default CMK for EBS is + // used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK + // using KmsKeyId. For more information, see Amazon EBS Encryption + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the + // Amazon Elastic Compute Cloud User Guide. + Encrypted *bool // An identifier for the symmetric AWS Key Management Service (AWS KMS) customer // master key (CMK) to use when creating the encrypted volume. This parameter is @@ -121,15 +130,6 @@ type CopyImageInput struct { // failure. The specified CMK must exist in the Region that the snapshot is being // copied to. Amazon EBS does not support asymmetric CMKs. KmsKeyId *string - - // Specifies whether the destination snapshots of the copied image should be - // encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot - // create an unencrypted copy of an encrypted snapshot. The default CMK for EBS is - // used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK - // using KmsKeyId. For more information, see Amazon EBS Encryption - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the - // Amazon Elastic Compute Cloud User Guide. - Encrypted *bool } // Contains the output of CopyImage. diff --git a/service/ec2/api_op_CopySnapshot.go b/service/ec2/api_op_CopySnapshot.go index 321071b331e..c9d554154fb 100644 --- a/service/ec2/api_op_CopySnapshot.go +++ b/service/ec2/api_op_CopySnapshot.go @@ -70,24 +70,27 @@ func (c *Client) CopySnapshot(ctx context.Context, params *CopySnapshotInput, op type CopySnapshotInput struct { + // The ID of the Region that contains the snapshot to be copied. + // + // This member is required. + SourceRegion *string + + // The ID of the EBS snapshot to copy. + // + // This member is required. + SourceSnapshotId *string + // A description for the EBS snapshot. Description *string - // When you copy an encrypted source snapshot using the Amazon EC2 Query API, you - // must supply a pre-signed URL. This parameter is optional for unencrypted - // snapshots. For more information, see Query Requests - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html). - // The PresignedUrl should use the snapshot source endpoint, the CopySnapshot - // action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion - // parameters. The PresignedUrl must be signed using AWS Signature Version 4. - // Because EBS snapshots are stored in Amazon S3, the signing algorithm for this - // parameter uses the same logic that is described in Authenticating Requests by - // Using Query Parameters (AWS Signature Version 4) - // (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) - // in the Amazon Simple Storage Service API Reference. An invalid or improperly - // signed PresignedUrl will cause the copy operation to fail asynchronously, and - // the snapshot will move to an error state. - PresignedUrl *string + // The destination Region to use in the PresignedUrl parameter of a snapshot copy + // operation. This parameter is only valid for specifying the destination Region in + // a PresignedUrl parameter, where it is required.

    The snapshot copy is sent to + // the regional endpoint that you sent the HTTP request to (for example, + // ec2.us-east-1.amazonaws.com). With the AWS CLI, this is specified + // using the --region parameter or the default Region in your AWS + // configuration file.

    + DestinationRegion *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the @@ -95,10 +98,14 @@ type CopySnapshotInput struct { // UnauthorizedOperation. DryRun *bool - // The ID of the Region that contains the snapshot to be copied. - // - // This member is required. - SourceRegion *string + // To encrypt a copy of an unencrypted snapshot if encryption by default is not + // enabled, enable encryption using this parameter. Otherwise, omit this parameter. + // Encrypted snapshots are encrypted, even if you omit this parameter and + // encryption by default is not enabled. You cannot set this parameter to false. + // For more information, see Amazon EBS Encryption + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the + // Amazon Elastic Compute Cloud User Guide. + Encrypted *bool // The identifier of the AWS Key Management Service (AWS KMS) customer master key // (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your @@ -123,28 +130,21 @@ type CopySnapshotInput struct { // valid, the action can appear to complete, but eventually fails. KmsKeyId *string - // The destination Region to use in the PresignedUrl parameter of a snapshot copy - // operation. This parameter is only valid for specifying the destination Region in - // a PresignedUrl parameter, where it is required.

    The snapshot copy is sent to - // the regional endpoint that you sent the HTTP request to (for example, - // ec2.us-east-1.amazonaws.com). With the AWS CLI, this is specified - // using the --region parameter or the default Region in your AWS - // configuration file.

    - DestinationRegion *string - - // To encrypt a copy of an unencrypted snapshot if encryption by default is not - // enabled, enable encryption using this parameter. Otherwise, omit this parameter. - // Encrypted snapshots are encrypted, even if you omit this parameter and - // encryption by default is not enabled. You cannot set this parameter to false. - // For more information, see Amazon EBS Encryption - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the - // Amazon Elastic Compute Cloud User Guide. - Encrypted *bool - - // The ID of the EBS snapshot to copy. - // - // This member is required. - SourceSnapshotId *string + // When you copy an encrypted source snapshot using the Amazon EC2 Query API, you + // must supply a pre-signed URL. This parameter is optional for unencrypted + // snapshots. For more information, see Query Requests + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html). + // The PresignedUrl should use the snapshot source endpoint, the CopySnapshot + // action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion + // parameters. The PresignedUrl must be signed using AWS Signature Version 4. + // Because EBS snapshots are stored in Amazon S3, the signing algorithm for this + // parameter uses the same logic that is described in Authenticating Requests by + // Using Query Parameters (AWS Signature Version 4) + // (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) + // in the Amazon Simple Storage Service API Reference. An invalid or improperly + // signed PresignedUrl will cause the copy operation to fail asynchronously, and + // the snapshot will move to an error state. + PresignedUrl *string // The tags to apply to the new snapshot. TagSpecifications []*types.TagSpecification diff --git a/service/ec2/api_op_CreateCapacityReservation.go b/service/ec2/api_op_CreateCapacityReservation.go index 431e714904f..8b7944a2b85 100644 --- a/service/ec2/api_op_CreateCapacityReservation.go +++ b/service/ec2/api_op_CreateCapacityReservation.go @@ -79,15 +79,15 @@ func (c *Client) CreateCapacityReservation(ctx context.Context, params *CreateCa type CreateCapacityReservationInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The number of instances for which to reserve capacity. + // + // This member is required. + InstanceCount *int32 - // Indicates whether the Capacity Reservation supports instances with temporary, - // block-level storage. - EphemeralStorage *bool + // The type of operating system for which to reserve capacity. + // + // This member is required. + InstancePlatform types.CapacityReservationInstancePlatform // The instance type for which to reserve capacity. For more information, see // Instance Types @@ -97,35 +97,22 @@ type CreateCapacityReservationInput struct { // This member is required. InstanceType *string - // Indicates the type of instance launches that the Capacity Reservation accepts. - // The options include: - // - // * open - The Capacity Reservation automatically - // matches all instances that have matching attributes (instance type, platform, - // and Availability Zone). Instances that have matching attributes run in the - // Capacity Reservation automatically without specifying any additional - // parameters. - // - // * targeted - The Capacity Reservation only accepts instances - // that have matching attributes (instance type, platform, and Availability Zone), - // and explicitly target the Capacity Reservation. This ensures that only permitted - // instances can use the reserved capacity. - // - // Default: open - InstanceMatchCriteria types.InstanceMatchCriteria + // The Availability Zone in which to create the Capacity Reservation. + AvailabilityZone *string - // The type of operating system for which to reserve capacity. - // - // This member is required. - InstancePlatform types.CapacityReservationInstancePlatform + // The ID of the Availability Zone in which to create the Capacity Reservation. + AvailabilityZoneId *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. For more information, see How to Ensure Idempotency // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). ClientToken *string - // The ID of the Availability Zone in which to create the Capacity Reservation. - AvailabilityZoneId *string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // Indicates whether the Capacity Reservation supports EBS-optimized instances. // This optimization provides dedicated throughput to Amazon EBS and an optimized @@ -134,12 +121,6 @@ type CreateCapacityReservationInput struct { // EBS- optimized instance. EbsOptimized *bool - // The tags to apply to the Capacity Reservation during launch. - TagSpecifications []*types.TagSpecification - - // The Availability Zone in which to create the Capacity Reservation. - AvailabilityZone *string - // The date and time at which the Capacity Reservation expires. When a Capacity // Reservation expires, the reserved capacity is released and you can no longer // launch instances into it. The Capacity Reservation's state changes to expired @@ -151,17 +132,6 @@ type CreateCapacityReservationInput struct { // 13:30:55 and 14:30:55 on 5/31/2019.

    EndDate *time.Time - // Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can - // have one of the following tenancy settings: - // - // * default - The Capacity - // Reservation is created on hardware that is shared with other AWS accounts. - // - // - // * dedicated - The Capacity Reservation is created on single-tenant hardware that - // is dedicated to a single AWS account. - Tenancy types.CapacityReservationTenancy - // Indicates the way in which the Capacity Reservation ends. A Capacity Reservation // can have one of the following end types: // @@ -174,10 +144,40 @@ type CreateCapacityReservationInput struct { // an EndDate value if the EndDateType value is limited. EndDateType types.EndDateType - // The number of instances for which to reserve capacity. + // Indicates whether the Capacity Reservation supports instances with temporary, + // block-level storage. + EphemeralStorage *bool + + // Indicates the type of instance launches that the Capacity Reservation accepts. + // The options include: // - // This member is required. - InstanceCount *int32 + // * open - The Capacity Reservation automatically + // matches all instances that have matching attributes (instance type, platform, + // and Availability Zone). Instances that have matching attributes run in the + // Capacity Reservation automatically without specifying any additional + // parameters. + // + // * targeted - The Capacity Reservation only accepts instances + // that have matching attributes (instance type, platform, and Availability Zone), + // and explicitly target the Capacity Reservation. This ensures that only permitted + // instances can use the reserved capacity. + // + // Default: open + InstanceMatchCriteria types.InstanceMatchCriteria + + // The tags to apply to the Capacity Reservation during launch. + TagSpecifications []*types.TagSpecification + + // Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can + // have one of the following tenancy settings: + // + // * default - The Capacity + // Reservation is created on hardware that is shared with other AWS accounts. + // + // + // * dedicated - The Capacity Reservation is created on single-tenant hardware that + // is dedicated to a single AWS account. + Tenancy types.CapacityReservationTenancy } type CreateCapacityReservationOutput struct { diff --git a/service/ec2/api_op_CreateClientVpnEndpoint.go b/service/ec2/api_op_CreateClientVpnEndpoint.go index 83cd07d22e1..f3075cc8d95 100644 --- a/service/ec2/api_op_CreateClientVpnEndpoint.go +++ b/service/ec2/api_op_CreateClientVpnEndpoint.go @@ -61,9 +61,19 @@ func (c *Client) CreateClientVpnEndpoint(ctx context.Context, params *CreateClie type CreateClientVpnEndpointInput struct { - // The port number to assign to the Client VPN endpoint for TCP and UDP traffic. - // Valid Values: 443 | 1194 Default Value: 443 - VpnPort *int32 + // Information about the authentication method to be used to authenticate clients. + // + // This member is required. + AuthenticationOptions []*types.ClientVpnAuthenticationRequest + + // The IPv4 address range, in CIDR notation, from which to assign client IP + // addresses. The address range cannot overlap with the local CIDR of the VPC in + // which the associated subnet is located, or the routes that you add manually. The + // address range cannot be changed after the Client VPN endpoint has been created. + // The CIDR block should be /22 or greater. + // + // This member is required. + ClientCidrBlock *string // Information about the client connection logging options. If you enable client // connection logging, data about client connections is sent to a Cloudwatch Logs @@ -83,50 +93,34 @@ type CreateClientVpnEndpointInput struct { // This member is required. ConnectionLogOptions *types.ConnectionLogOptions - // The transport protocol to be used by the VPN session. Default value: udp - TransportProtocol types.TransportProtocol + // The ARN of the server certificate. For more information, see the AWS Certificate + // Manager User Guide (https://docs.aws.amazon.com/acm/latest/userguide/). + // + // This member is required. + ServerCertificateArn *string + + // Unique, case-sensitive identifier that you provide to ensure the idempotency of + // the request. For more information, see How to Ensure Idempotency + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + ClientToken *string // A brief description of the Client VPN endpoint. Description *string - // The IPv4 address range, in CIDR notation, from which to assign client IP - // addresses. The address range cannot overlap with the local CIDR of the VPC in - // which the associated subnet is located, or the routes that you add manually. The - // address range cannot be changed after the Client VPN endpoint has been created. - // The CIDR block should be /22 or greater. - // - // This member is required. - ClientCidrBlock *string - // Information about the DNS servers to be used for DNS resolution. A Client VPN // endpoint can have up to two DNS servers. If no DNS server is specified, the DNS // address configured on the device is used for the DNS server. DnsServers []*string - // The ARN of the server certificate. For more information, see the AWS Certificate - // Manager User Guide (https://docs.aws.amazon.com/acm/latest/userguide/). - // - // This member is required. - ServerCertificateArn *string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to Ensure Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). - ClientToken *string - - // The tags to apply to the Client VPN endpoint during creation. - TagSpecifications []*types.TagSpecification - - // The ID of the VPC to associate with the Client VPN endpoint. If no security - // group IDs are specified in the request, the default security group for the VPC - // is applied. - VpcId *string + // The IDs of one or more security groups to apply to the target network. You must + // also specify the ID of the VPC that contains the security groups. + SecurityGroupIds []*string // Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint. By // default, split-tunnel on a VPN endpoint is disabled. For information about @@ -135,27 +129,33 @@ type CreateClientVpnEndpointInput struct { // in the AWS Client VPN Administrator Guide. SplitTunnel *bool - // Information about the authentication method to be used to authenticate clients. - // - // This member is required. - AuthenticationOptions []*types.ClientVpnAuthenticationRequest + // The tags to apply to the Client VPN endpoint during creation. + TagSpecifications []*types.TagSpecification - // The IDs of one or more security groups to apply to the target network. You must - // also specify the ID of the VPC that contains the security groups. - SecurityGroupIds []*string + // The transport protocol to be used by the VPN session. Default value: udp + TransportProtocol types.TransportProtocol + + // The ID of the VPC to associate with the Client VPN endpoint. If no security + // group IDs are specified in the request, the default security group for the VPC + // is applied. + VpcId *string + + // The port number to assign to the Client VPN endpoint for TCP and UDP traffic. + // Valid Values: 443 | 1194 Default Value: 443 + VpnPort *int32 } type CreateClientVpnEndpointOutput struct { + // The ID of the Client VPN endpoint. + ClientVpnEndpointId *string + // The DNS name to be used by clients when establishing their VPN session. DnsName *string // The current state of the Client VPN endpoint. Status *types.ClientVpnEndpointStatus - // The ID of the Client VPN endpoint. - ClientVpnEndpointId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_CreateClientVpnRoute.go b/service/ec2/api_op_CreateClientVpnRoute.go index cebf6ca51d5..fcf264d2c72 100644 --- a/service/ec2/api_op_CreateClientVpnRoute.go +++ b/service/ec2/api_op_CreateClientVpnRoute.go @@ -62,10 +62,10 @@ func (c *Client) CreateClientVpnRoute(ctx context.Context, params *CreateClientV type CreateClientVpnRouteInput struct { - // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to Ensure Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). - ClientToken *string + // The ID of the Client VPN endpoint to which to add the route. + // + // This member is required. + ClientVpnEndpointId *string // The IPv4 address range, in CIDR notation, of the route destination. For // example: @@ -91,14 +91,14 @@ type CreateClientVpnRouteInput struct { // This member is required. TargetVpcSubnetId *string + // Unique, case-sensitive identifier that you provide to ensure the idempotency of + // the request. For more information, see How to Ensure Idempotency + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + ClientToken *string + // A brief description of the route. Description *string - // The ID of the Client VPN endpoint to which to add the route. - // - // This member is required. - ClientVpnEndpointId *string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is diff --git a/service/ec2/api_op_CreateCustomerGateway.go b/service/ec2/api_op_CreateCustomerGateway.go index f89cda1c74d..a783be34aaa 100644 --- a/service/ec2/api_op_CreateCustomerGateway.go +++ b/service/ec2/api_op_CreateCustomerGateway.go @@ -74,35 +74,35 @@ func (c *Client) CreateCustomerGateway(ctx context.Context, params *CreateCustom // Contains the parameters for CreateCustomerGateway. type CreateCustomerGatewayInput struct { - // The Internet-routable IP address for the customer gateway's outside interface. - // The address must be static. - PublicIp *string - - // The tags to apply to the customer gateway. - TagSpecifications []*types.TagSpecification - - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // For devices that support BGP, the customer gateway's BGP ASN. Default: 65000 + // + // This member is required. + BgpAsn *int32 // The type of VPN connection that this customer gateway supports (ipsec.1). // // This member is required. Type types.GatewayType + // The Amazon Resource Name (ARN) for the customer gateway certificate. + CertificateArn *string + // A name for the customer gateway device. Length Constraints: Up to 255 // characters. DeviceName *string - // The Amazon Resource Name (ARN) for the customer gateway certificate. - CertificateArn *string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool - // For devices that support BGP, the customer gateway's BGP ASN. Default: 65000 - // - // This member is required. - BgpAsn *int32 + // The Internet-routable IP address for the customer gateway's outside interface. + // The address must be static. + PublicIp *string + + // The tags to apply to the customer gateway. + TagSpecifications []*types.TagSpecification } // Contains the output of CreateCustomerGateway. diff --git a/service/ec2/api_op_CreateDhcpOptions.go b/service/ec2/api_op_CreateDhcpOptions.go index 1f27fd427c4..73241cdbd8a 100644 --- a/service/ec2/api_op_CreateDhcpOptions.go +++ b/service/ec2/api_op_CreateDhcpOptions.go @@ -105,14 +105,14 @@ type CreateDhcpOptionsInput struct { // This member is required. DhcpConfigurations []*types.NewDhcpConfiguration - // The tags to assign to the DHCP option. - TagSpecifications []*types.TagSpecification - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // The tags to assign to the DHCP option. + TagSpecifications []*types.TagSpecification } type CreateDhcpOptionsOutput struct { diff --git a/service/ec2/api_op_CreateFleet.go b/service/ec2/api_op_CreateFleet.go index 615a0f132b6..dbf51f9e3a0 100644 --- a/service/ec2/api_op_CreateFleet.go +++ b/service/ec2/api_op_CreateFleet.go @@ -62,24 +62,15 @@ func (c *Client) CreateFleet(ctx context.Context, params *CreateFleetInput, optF type CreateFleetInput struct { - // The start date and time of the request, in UTC format (for example, - // YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request - // immediately. - ValidFrom *time.Time - - // Describes the configuration of Spot Instances in an EC2 Fleet. - SpotOptions *types.SpotOptionsRequest + // The configuration for the EC2 Fleet. + // + // This member is required. + LaunchTemplateConfigs []*types.FleetLaunchTemplateConfigRequest - // The type of the request. By default, the EC2 Fleet places an asynchronous - // request for your desired capacity, and maintains it by replenishing interrupted - // Spot Instances (maintain). A value of instant places a synchronous one-time - // request, and returns errors for any instances that could not be launched. A - // value of request places an asynchronous one-time request without maintaining - // capacity or submitting requests in alternative capacity pools if capacity is - // unavailable. For more information, see EC2 Fleet Request Types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-configuration-strategies.html#ec2-fleet-request-type) - // in the Amazon Elastic Compute Cloud User Guide. - Type types.FleetType + // The number of units to request. + // + // This member is required. + TargetCapacitySpecification *types.TargetCapacitySpecificationRequest // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. For more information, see Ensuring Idempotency @@ -92,13 +83,18 @@ type CreateFleetInput struct { // UnauthorizedOperation. DryRun *bool + // Indicates whether running instances should be terminated if the total target + // capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet. + ExcessCapacityTerminationPolicy types.FleetExcessCapacityTerminationPolicy + + // Describes the configuration of On-Demand Instances in an EC2 Fleet. + OnDemandOptions *types.OnDemandOptionsRequest + // Indicates whether EC2 Fleet should replace unhealthy instances. ReplaceUnhealthyInstances *bool - // The configuration for the EC2 Fleet. - // - // This member is required. - LaunchTemplateConfigs []*types.FleetLaunchTemplateConfigRequest + // Describes the configuration of Spot Instances in an EC2 Fleet. + SpotOptions *types.SpotOptionsRequest // The key-value pair for tagging the EC2 Fleet request on creation. The value for // ResourceType must be fleet, otherwise the fleet request fails. To tag instances @@ -108,22 +104,26 @@ type CreateFleetInput struct { // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources). TagSpecifications []*types.TagSpecification - // The number of units to request. - // - // This member is required. - TargetCapacitySpecification *types.TargetCapacitySpecificationRequest - - // Indicates whether running instances should be terminated if the total target - // capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet. - ExcessCapacityTerminationPolicy types.FleetExcessCapacityTerminationPolicy - - // Describes the configuration of On-Demand Instances in an EC2 Fleet. - OnDemandOptions *types.OnDemandOptionsRequest - // Indicates whether running instances should be terminated when the EC2 Fleet // expires. TerminateInstancesWithExpiration *bool + // The type of the request. By default, the EC2 Fleet places an asynchronous + // request for your desired capacity, and maintains it by replenishing interrupted + // Spot Instances (maintain). A value of instant places a synchronous one-time + // request, and returns errors for any instances that could not be launched. A + // value of request places an asynchronous one-time request without maintaining + // capacity or submitting requests in alternative capacity pools if capacity is + // unavailable. For more information, see EC2 Fleet Request Types + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-configuration-strategies.html#ec2-fleet-request-type) + // in the Amazon Elastic Compute Cloud User Guide. + Type types.FleetType + + // The start date and time of the request, in UTC format (for example, + // YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request + // immediately. + ValidFrom *time.Time + // The end date and time of the request, in UTC format (for example, // YYYY-MM-DDTHH:MM:SSZ). At this point, no new EC2 Fleet requests are placed or // able to fulfill the request. If no value is specified, the request remains until diff --git a/service/ec2/api_op_CreateFlowLogs.go b/service/ec2/api_op_CreateFlowLogs.go index 2769d91bf56..ee26baf1e9a 100644 --- a/service/ec2/api_op_CreateFlowLogs.go +++ b/service/ec2/api_op_CreateFlowLogs.go @@ -70,25 +70,39 @@ func (c *Client) CreateFlowLogs(ctx context.Context, params *CreateFlowLogsInput type CreateFlowLogsInput struct { + // The ID of the subnet, network interface, or VPC for which you want to create a + // flow log. Constraints: Maximum of 1000 resources + // + // This member is required. + ResourceIds []*string + // The type of resource for which to create the flow log. For example, if you // specified a VPC ID for the ResourceId property, specify VPC for this property. // // This member is required. ResourceType types.FlowLogsResourceType - // The name of a new or existing CloudWatch Logs log group where Amazon EC2 - // publishes your flow logs. If you specify LogDestinationType as s3, do not - // specify DeliverLogsPermissionArn or LogGroupName. - LogGroupName *string + // The type of traffic to log. You can log traffic that the resource accepts or + // rejects, or all traffic. + // + // This member is required. + TrafficType types.TrafficType - // The fields to include in the flow log record, in the order in which they should - // appear. For a list of available fields, see Flow Log Records - // (https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records). - // If you omit this parameter, the flow log is created using the default format. If - // you specify this parameter, you must specify at least one field. Specify the - // fields using the ${field-id} format, separated by spaces. For the AWS CLI, use - // single quotation marks (' ') to surround the parameter value. - LogFormat *string + // Unique, case-sensitive identifier that you provide to ensure the idempotency of + // the request. For more information, see How to Ensure Idempotency + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). + ClientToken *string + + // The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a + // CloudWatch Logs log group in your account. If you specify LogDestinationType as + // s3, do not specify DeliverLogsPermissionArn or LogGroupName. + DeliverLogsPermissionArn *string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // Specifies the destination to which the flow log data is to be published. Flow // log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. @@ -106,14 +120,26 @@ type CreateFlowLogsInput struct { // This is a reserved term. LogDestination *string - // The ID of the subnet, network interface, or VPC for which you want to create a - // flow log. Constraints: Maximum of 1000 resources - // - // This member is required. - ResourceIds []*string + // Specifies the type of destination to which the flow log data is to be published. + // Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow + // log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data + // to Amazon S3, specify s3. If you specify LogDestinationType as s3, do not + // specify DeliverLogsPermissionArn or LogGroupName. Default: cloud-watch-logs + LogDestinationType types.LogDestinationType - // The tags to apply to the flow logs. - TagSpecifications []*types.TagSpecification + // The fields to include in the flow log record, in the order in which they should + // appear. For a list of available fields, see Flow Log Records + // (https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records). + // If you omit this parameter, the flow log is created using the default format. If + // you specify this parameter, you must specify at least one field. Specify the + // fields using the ${field-id} format, separated by spaces. For the AWS CLI, use + // single quotation marks (' ') to surround the parameter value. + LogFormat *string + + // The name of a new or existing CloudWatch Logs log group where Amazon EC2 + // publishes your flow logs. If you specify LogDestinationType as s3, do not + // specify DeliverLogsPermissionArn or LogGroupName. + LogGroupName *string // The maximum interval of time during which a flow of packets is captured and // aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 @@ -124,47 +150,21 @@ type CreateFlowLogsInput struct { // that you specify. Default: 600 MaxAggregationInterval *int32 - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - - // Specifies the type of destination to which the flow log data is to be published. - // Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow - // log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data - // to Amazon S3, specify s3. If you specify LogDestinationType as s3, do not - // specify DeliverLogsPermissionArn or LogGroupName. Default: cloud-watch-logs - LogDestinationType types.LogDestinationType - - // The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a - // CloudWatch Logs log group in your account. If you specify LogDestinationType as - // s3, do not specify DeliverLogsPermissionArn or LogGroupName. - DeliverLogsPermissionArn *string - - // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to Ensure Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). - ClientToken *string - - // The type of traffic to log. You can log traffic that the resource accepts or - // rejects, or all traffic. - // - // This member is required. - TrafficType types.TrafficType + // The tags to apply to the flow logs. + TagSpecifications []*types.TagSpecification } type CreateFlowLogsOutput struct { - // Information about the flow logs that could not be created successfully. - Unsuccessful []*types.UnsuccessfulItem + // Unique, case-sensitive identifier that you provide to ensure the idempotency of + // the request. + ClientToken *string // The IDs of the flow logs. FlowLogIds []*string - // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. - ClientToken *string + // Information about the flow logs that could not be created successfully. + Unsuccessful []*types.UnsuccessfulItem // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/ec2/api_op_CreateFpgaImage.go b/service/ec2/api_op_CreateFpgaImage.go index 3b771ae4010..caf36530fc9 100644 --- a/service/ec2/api_op_CreateFpgaImage.go +++ b/service/ec2/api_op_CreateFpgaImage.go @@ -68,16 +68,13 @@ type CreateFpgaImageInput struct { // This member is required. InputStorageLocation *types.StorageLocation - // The location in Amazon S3 for the output logs. - LogsStorageLocation *types.StorageLocation - // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. For more information, see Ensuring Idempotency // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). ClientToken *string - // A name for the AFI. - Name *string + // A description for the AFI. + Description *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the @@ -85,21 +82,24 @@ type CreateFpgaImageInput struct { // UnauthorizedOperation. DryRun *bool + // The location in Amazon S3 for the output logs. + LogsStorageLocation *types.StorageLocation + + // A name for the AFI. + Name *string + // The tags to apply to the FPGA image during creation. TagSpecifications []*types.TagSpecification - - // A description for the AFI. - Description *string } type CreateFpgaImageOutput struct { - // The FPGA image identifier (AFI ID). - FpgaImageId *string - // The global FPGA image identifier (AGFI ID). FpgaImageGlobalId *string + // The FPGA image identifier (AFI ID). + FpgaImageId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_CreateImage.go b/service/ec2/api_op_CreateImage.go index 7b25776d73d..169d2eed2f7 100644 --- a/service/ec2/api_op_CreateImage.go +++ b/service/ec2/api_op_CreateImage.go @@ -65,21 +65,25 @@ func (c *Client) CreateImage(ctx context.Context, params *CreateImageInput, optF type CreateImageInput struct { - // By default, Amazon EC2 attempts to shut down and reboot the instance before - // creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut - // down the instance before creating the image. When this option is used, file - // system integrity on the created image can't be guaranteed. - NoReboot *bool + // The ID of the instance. + // + // This member is required. + InstanceId *string + + // A name for the new image. Constraints: 3-128 alphanumeric characters, + // parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), + // dashes (-), single quotes ('), at-signs (@), or underscores(_) + // + // This member is required. + Name *string // The block device mappings. This parameter cannot be used to modify the // encryption status of existing volumes or snapshots. To create an AMI with // encrypted snapshots, use the CopyImage () action. BlockDeviceMappings []*types.BlockDeviceMapping - // The ID of the instance. - // - // This member is required. - InstanceId *string + // A description for the new image. + Description *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the @@ -87,15 +91,11 @@ type CreateImageInput struct { // UnauthorizedOperation. DryRun *bool - // A description for the new image. - Description *string - - // A name for the new image. Constraints: 3-128 alphanumeric characters, - // parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), - // dashes (-), single quotes ('), at-signs (@), or underscores(_) - // - // This member is required. - Name *string + // By default, Amazon EC2 attempts to shut down and reboot the instance before + // creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut + // down the instance before creating the image. When this option is used, file + // system integrity on the created image can't be guaranteed. + NoReboot *bool } type CreateImageOutput struct { diff --git a/service/ec2/api_op_CreateInstanceExportTask.go b/service/ec2/api_op_CreateInstanceExportTask.go index 20ae6806337..192874322e8 100644 --- a/service/ec2/api_op_CreateInstanceExportTask.go +++ b/service/ec2/api_op_CreateInstanceExportTask.go @@ -62,23 +62,23 @@ func (c *Client) CreateInstanceExportTask(ctx context.Context, params *CreateIns type CreateInstanceExportTaskInput struct { - // The target virtualization environment. - TargetEnvironment types.ExportEnvironment + // The ID of the instance. + // + // This member is required. + InstanceId *string // A description for the conversion task or the resource being exported. The // maximum length is 255 characters. Description *string - // The ID of the instance. - // - // This member is required. - InstanceId *string + // The format and location for an instance export task. + ExportToS3Task *types.ExportToS3TaskSpecification // The tags to apply to the instance export task during creation. TagSpecifications []*types.TagSpecification - // The format and location for an instance export task. - ExportToS3Task *types.ExportToS3TaskSpecification + // The target virtualization environment. + TargetEnvironment types.ExportEnvironment } type CreateInstanceExportTaskOutput struct { diff --git a/service/ec2/api_op_CreateKeyPair.go b/service/ec2/api_op_CreateKeyPair.go index 0bbfd3e3e9d..944f1c8d34a 100644 --- a/service/ec2/api_op_CreateKeyPair.go +++ b/service/ec2/api_op_CreateKeyPair.go @@ -66,9 +66,6 @@ func (c *Client) CreateKeyPair(ctx context.Context, params *CreateKeyPairInput, type CreateKeyPairInput struct { - // The tags to apply to the new key pair. - TagSpecifications []*types.TagSpecification - // A unique name for the key pair. Constraints: Up to 255 ASCII characters // // This member is required. @@ -79,6 +76,9 @@ type CreateKeyPairInput struct { // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // The tags to apply to the new key pair. + TagSpecifications []*types.TagSpecification } // Describes a key pair. @@ -87,12 +87,12 @@ type CreateKeyPairOutput struct { // The SHA-1 digest of the DER encoded private key. KeyFingerprint *string - // The name of the key pair. - KeyName *string - // An unencrypted PEM encoded RSA private key. KeyMaterial *string + // The name of the key pair. + KeyName *string + // The ID of the key pair. KeyPairId *string diff --git a/service/ec2/api_op_CreateLaunchTemplate.go b/service/ec2/api_op_CreateLaunchTemplate.go index 5c55fb33082..659c7fa50ec 100644 --- a/service/ec2/api_op_CreateLaunchTemplate.go +++ b/service/ec2/api_op_CreateLaunchTemplate.go @@ -62,24 +62,21 @@ func (c *Client) CreateLaunchTemplate(ctx context.Context, params *CreateLaunchT type CreateLaunchTemplateInput struct { - // The tags to apply to the launch template during creation. - TagSpecifications []*types.TagSpecification - - // Unique, case-sensitive identifier you provide to ensure the idempotency of the - // request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). - // Constraint: Maximum 128 ASCII characters. - ClientToken *string + // The information for the launch template. + // + // This member is required. + LaunchTemplateData *types.RequestLaunchTemplateData // A name for the launch template. // // This member is required. LaunchTemplateName *string - // The information for the launch template. - // - // This member is required. - LaunchTemplateData *types.RequestLaunchTemplateData + // Unique, case-sensitive identifier you provide to ensure the idempotency of the + // request. For more information, see Ensuring Idempotency + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // Constraint: Maximum 128 ASCII characters. + ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the @@ -87,6 +84,9 @@ type CreateLaunchTemplateInput struct { // UnauthorizedOperation. DryRun *bool + // The tags to apply to the launch template during creation. + TagSpecifications []*types.TagSpecification + // A description for the first version of the launch template. VersionDescription *string } diff --git a/service/ec2/api_op_CreateLaunchTemplateVersion.go b/service/ec2/api_op_CreateLaunchTemplateVersion.go index 4c81571b0b4..8d2e89a0989 100644 --- a/service/ec2/api_op_CreateLaunchTemplateVersion.go +++ b/service/ec2/api_op_CreateLaunchTemplateVersion.go @@ -63,12 +63,31 @@ func (c *Client) CreateLaunchTemplateVersion(ctx context.Context, params *Create type CreateLaunchTemplateVersionInput struct { + // The information for the launch template. + // + // This member is required. + LaunchTemplateData *types.RequestLaunchTemplateData + + // Unique, case-sensitive identifier you provide to ensure the idempotency of the + // request. For more information, see Ensuring Idempotency + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // Constraint: Maximum 128 ASCII characters. + ClientToken *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + // The ID of the launch template. You must specify either the launch template ID or + // launch template name in the request. + LaunchTemplateId *string + + // The name of the launch template. You must specify either the launch template ID + // or launch template name in the request. + LaunchTemplateName *string + // The version number of the launch template version on which to base the new // version. The new version inherits the same launch parameters as the source // version, except for parameters that you specify in LaunchTemplateData. Snapshots @@ -76,39 +95,20 @@ type CreateLaunchTemplateVersionInput struct { // unless they are explicitly included. SourceVersion *string - // Unique, case-sensitive identifier you provide to ensure the idempotency of the - // request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). - // Constraint: Maximum 128 ASCII characters. - ClientToken *string - - // The name of the launch template. You must specify either the launch template ID - // or launch template name in the request. - LaunchTemplateName *string - - // The information for the launch template. - // - // This member is required. - LaunchTemplateData *types.RequestLaunchTemplateData - // A description for the version of the launch template. VersionDescription *string - - // The ID of the launch template. You must specify either the launch template ID or - // launch template name in the request. - LaunchTemplateId *string } type CreateLaunchTemplateVersionOutput struct { + // Information about the launch template version. + LaunchTemplateVersion *types.LaunchTemplateVersion + // If the new version of the launch template contains parameters or parameter // combinations that are not valid, an error code and an error message are returned // for each issue that's found. Warning *types.ValidationWarning - // Information about the launch template version. - LaunchTemplateVersion *types.LaunchTemplateVersion - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_CreateLocalGatewayRoute.go b/service/ec2/api_op_CreateLocalGatewayRoute.go index 3f32ec3558a..fef8eff2a3e 100644 --- a/service/ec2/api_op_CreateLocalGatewayRoute.go +++ b/service/ec2/api_op_CreateLocalGatewayRoute.go @@ -57,27 +57,27 @@ func (c *Client) CreateLocalGatewayRoute(ctx context.Context, params *CreateLoca type CreateLocalGatewayRouteInput struct { - // The ID of the virtual interface group. + // The CIDR range used for destination matches. Routing decisions are based on the + // most specific match. // // This member is required. - LocalGatewayVirtualInterfaceGroupId *string + DestinationCidrBlock *string // The ID of the local gateway route table. // // This member is required. LocalGatewayRouteTableId *string + // The ID of the virtual interface group. + // + // This member is required. + LocalGatewayVirtualInterfaceGroupId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The CIDR range used for destination matches. Routing decisions are based on the - // most specific match. - // - // This member is required. - DestinationCidrBlock *string } type CreateLocalGatewayRouteOutput struct { diff --git a/service/ec2/api_op_CreateLocalGatewayRouteTableVpcAssociation.go b/service/ec2/api_op_CreateLocalGatewayRouteTableVpcAssociation.go index 51850ee4b12..de50a9b5c8a 100644 --- a/service/ec2/api_op_CreateLocalGatewayRouteTableVpcAssociation.go +++ b/service/ec2/api_op_CreateLocalGatewayRouteTableVpcAssociation.go @@ -57,6 +57,11 @@ func (c *Client) CreateLocalGatewayRouteTableVpcAssociation(ctx context.Context, type CreateLocalGatewayRouteTableVpcAssociationInput struct { + // The ID of the local gateway route table. + // + // This member is required. + LocalGatewayRouteTableId *string + // The ID of the VPC. // // This member is required. @@ -68,11 +73,6 @@ type CreateLocalGatewayRouteTableVpcAssociationInput struct { // UnauthorizedOperation. DryRun *bool - // The ID of the local gateway route table. - // - // This member is required. - LocalGatewayRouteTableId *string - // The tags to assign to the local gateway route table VPC association. TagSpecifications []*types.TagSpecification } diff --git a/service/ec2/api_op_CreateManagedPrefixList.go b/service/ec2/api_op_CreateManagedPrefixList.go index 756a47de34e..63796cb1b5c 100644 --- a/service/ec2/api_op_CreateManagedPrefixList.go +++ b/service/ec2/api_op_CreateManagedPrefixList.go @@ -67,34 +67,34 @@ type CreateManagedPrefixListInput struct { // This member is required. AddressFamily *string - // Unique, case-sensitive identifier you provide to ensure the idempotency of the - // request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). - // Constraints: Up to 255 UTF-8 characters in length. - ClientToken *string - - // One or more entries for the prefix list. - Entries []*types.AddPrefixListEntry - // The maximum number of entries for the prefix list. // // This member is required. MaxEntries *int32 - // The tags to apply to the prefix list during creation. - TagSpecifications []*types.TagSpecification - // A name for the prefix list. Constraints: Up to 255 characters in length. The // name cannot start with com.amazonaws. // // This member is required. PrefixListName *string + // Unique, case-sensitive identifier you provide to ensure the idempotency of the + // request. For more information, see Ensuring Idempotency + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // Constraints: Up to 255 UTF-8 characters in length. + ClientToken *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // One or more entries for the prefix list. + Entries []*types.AddPrefixListEntry + + // The tags to apply to the prefix list during creation. + TagSpecifications []*types.TagSpecification } type CreateManagedPrefixListOutput struct { diff --git a/service/ec2/api_op_CreateNatGateway.go b/service/ec2/api_op_CreateNatGateway.go index f661ba547b7..fc24181e6bf 100644 --- a/service/ec2/api_op_CreateNatGateway.go +++ b/service/ec2/api_op_CreateNatGateway.go @@ -72,36 +72,36 @@ type CreateNatGatewayInput struct { // This member is required. AllocationId *string - // The tags to assign to the NAT gateway. - TagSpecifications []*types.TagSpecification - // The subnet in which to create the NAT gateway. // // This member is required. SubnetId *string + // Unique, case-sensitive identifier that you provide to ensure the idempotency of + // the request. For more information, see How to Ensure Idempotency + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // Constraint: Maximum 64 ASCII characters. + ClientToken *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to Ensure Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). - // Constraint: Maximum 64 ASCII characters. - ClientToken *string + // The tags to assign to the NAT gateway. + TagSpecifications []*types.TagSpecification } type CreateNatGatewayOutput struct { - // Information about the NAT gateway. - NatGateway *types.NatGateway - // Unique, case-sensitive identifier to ensure the idempotency of the request. Only // returned if a client token was provided in the request. ClientToken *string + // Information about the NAT gateway. + NatGateway *types.NatGateway + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_CreateNetworkAcl.go b/service/ec2/api_op_CreateNetworkAcl.go index 81a8bb3e02c..601fffa0ede 100644 --- a/service/ec2/api_op_CreateNetworkAcl.go +++ b/service/ec2/api_op_CreateNetworkAcl.go @@ -61,17 +61,17 @@ func (c *Client) CreateNetworkAcl(ctx context.Context, params *CreateNetworkAclI type CreateNetworkAclInput struct { + // The ID of the VPC. + // + // This member is required. + VpcId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // The ID of the VPC. - // - // This member is required. - VpcId *string - // The tags to assign to the network ACL. TagSpecifications []*types.TagSpecification } diff --git a/service/ec2/api_op_CreateNetworkAclEntry.go b/service/ec2/api_op_CreateNetworkAclEntry.go index b725ca64bfb..d158b77dcee 100644 --- a/service/ec2/api_op_CreateNetworkAclEntry.go +++ b/service/ec2/api_op_CreateNetworkAclEntry.go @@ -70,23 +70,11 @@ func (c *Client) CreateNetworkAclEntry(ctx context.Context, params *CreateNetwor type CreateNetworkAclEntryInput struct { - // The IPv4 network range to allow or deny, in CIDR notation (for example - // 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for - // example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18. - CidrBlock *string - - // TCP or UDP protocols: The range of ports the rule applies to. Required if - // specifying protocol 6 (TCP) or 17 (UDP). - PortRange *types.PortRange - - // Indicates whether to allow or deny the traffic that matches the rule. + // Indicates whether this is an egress rule (rule is applied to traffic leaving the + // subnet). // // This member is required. - RuleAction types.RuleAction - - // ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol - // 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block. - IcmpTypeCode *types.IcmpTypeCode + Egress *bool // The ID of the network ACL. // @@ -104,17 +92,10 @@ type CreateNetworkAclEntryInput struct { // This member is required. Protocol *string - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - - // Indicates whether this is an egress rule (rule is applied to traffic leaving the - // subnet). + // Indicates whether to allow or deny the traffic that matches the rule. // // This member is required. - Egress *bool + RuleAction types.RuleAction // The rule number for the entry (for example, 100). ACL entries are processed in // ascending order by rule number. Constraints: Positive integer from 1 to 32766. @@ -123,9 +104,28 @@ type CreateNetworkAclEntryInput struct { // This member is required. RuleNumber *int32 + // The IPv4 network range to allow or deny, in CIDR notation (for example + // 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for + // example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18. + CidrBlock *string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + + // ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol + // 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block. + IcmpTypeCode *types.IcmpTypeCode + // The IPv6 network range to allow or deny, in CIDR notation (for example // 2001:db8:1234:1a00::/64). Ipv6CidrBlock *string + + // TCP or UDP protocols: The range of ports the rule applies to. Required if + // specifying protocol 6 (TCP) or 17 (UDP). + PortRange *types.PortRange } type CreateNetworkAclEntryOutput struct { diff --git a/service/ec2/api_op_CreateNetworkInterface.go b/service/ec2/api_op_CreateNetworkInterface.go index 730c6f1fee9..13c5d0bc9ca 100644 --- a/service/ec2/api_op_CreateNetworkInterface.go +++ b/service/ec2/api_op_CreateNetworkInterface.go @@ -61,31 +61,22 @@ func (c *Client) CreateNetworkInterface(ctx context.Context, params *CreateNetwo // Contains the parameters for CreateNetworkInterface. type CreateNetworkInterfaceInput struct { - // One or more specific IPv6 addresses from the IPv6 CIDR block range of your - // subnet. You can't use this option if you're specifying a number of IPv6 - // addresses. - Ipv6Addresses []*types.InstanceIpv6Address - - // The IDs of one or more security groups. - Groups []*string - - // A description for the network interface. - Description *string - // The ID of the subnet to associate with the network interface. // // This member is required. SubnetId *string - // One or more private IPv4 addresses. - PrivateIpAddresses []*types.PrivateIpAddressSpecification + // A description for the network interface. + Description *string - // The primary private IPv4 address of the network interface. If you don't specify - // an IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR - // range. If you specify an IP address, you cannot indicate any IP addresses - // specified in privateIpAddresses as primary (only one IP address can be - // designated as primary). - PrivateIpAddress *string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + + // The IDs of one or more security groups. + Groups []*string // Indicates the type of network interface. To create an Elastic Fabric Adapter // (EFA), specify efa. For more information, see Elastic Fabric Adapter @@ -100,14 +91,20 @@ type CreateNetworkInterfaceInput struct { // this setting. Ipv6AddressCount *int32 - // The tags to apply to the new network interface. - TagSpecifications []*types.TagSpecification + // One or more specific IPv6 addresses from the IPv6 CIDR block range of your + // subnet. You can't use this option if you're specifying a number of IPv6 + // addresses. + Ipv6Addresses []*types.InstanceIpv6Address - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The primary private IPv4 address of the network interface. If you don't specify + // an IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR + // range. If you specify an IP address, you cannot indicate any IP addresses + // specified in privateIpAddresses as primary (only one IP address can be + // designated as primary). + PrivateIpAddress *string + + // One or more private IPv4 addresses. + PrivateIpAddresses []*types.PrivateIpAddressSpecification // The number of secondary private IPv4 addresses to assign to a network interface. // When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these @@ -118,6 +115,9 @@ type CreateNetworkInterfaceInput struct { // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#AvailableIpPerENI) // in the Amazon Virtual Private Cloud User Guide. SecondaryPrivateIpAddressCount *int32 + + // The tags to apply to the new network interface. + TagSpecifications []*types.TagSpecification } // Contains the output of CreateNetworkInterface. diff --git a/service/ec2/api_op_CreateNetworkInterfacePermission.go b/service/ec2/api_op_CreateNetworkInterfacePermission.go index 1eb34fe43ff..38289063a4e 100644 --- a/service/ec2/api_op_CreateNetworkInterfacePermission.go +++ b/service/ec2/api_op_CreateNetworkInterfacePermission.go @@ -60,27 +60,27 @@ func (c *Client) CreateNetworkInterfacePermission(ctx context.Context, params *C // Contains the parameters for CreateNetworkInterfacePermission. type CreateNetworkInterfacePermissionInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The ID of the network interface. // // This member is required. NetworkInterfaceId *string + // The type of permission to grant. + // + // This member is required. + Permission types.InterfacePermissionType + // The AWS account ID. AwsAccountId *string // The AWS service. Currently not supported. AwsService *string - // The type of permission to grant. - // - // This member is required. - Permission types.InterfacePermissionType + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool } // Contains the output of CreateNetworkInterfacePermission. diff --git a/service/ec2/api_op_CreatePlacementGroup.go b/service/ec2/api_op_CreatePlacementGroup.go index 025d9ac507b..43a596a2fe1 100644 --- a/service/ec2/api_op_CreatePlacementGroup.go +++ b/service/ec2/api_op_CreatePlacementGroup.go @@ -65,24 +65,24 @@ func (c *Client) CreatePlacementGroup(ctx context.Context, params *CreatePlaceme type CreatePlacementGroupInput struct { - // A name for the placement group. Must be unique within the scope of your account - // for the Region. Constraints: Up to 255 ASCII characters - GroupName *string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // The tags to apply to the new placement group. - TagSpecifications []*types.TagSpecification + // A name for the placement group. Must be unique within the scope of your account + // for the Region. Constraints: Up to 255 ASCII characters + GroupName *string + + // The number of partitions. Valid only when Strategy is set to partition. + PartitionCount *int32 // The placement strategy. Strategy types.PlacementStrategy - // The number of partitions. Valid only when Strategy is set to partition. - PartitionCount *int32 + // The tags to apply to the new placement group. + TagSpecifications []*types.TagSpecification } type CreatePlacementGroupOutput struct { diff --git a/service/ec2/api_op_CreateReservedInstancesListing.go b/service/ec2/api_op_CreateReservedInstancesListing.go index 3f8e7dffce3..a9d164054af 100644 --- a/service/ec2/api_op_CreateReservedInstancesListing.go +++ b/service/ec2/api_op_CreateReservedInstancesListing.go @@ -76,11 +76,6 @@ func (c *Client) CreateReservedInstancesListing(ctx context.Context, params *Cre // Contains the parameters for CreateReservedInstancesListing. type CreateReservedInstancesListingInput struct { - // The ID of the active Standard Reserved Instance. - // - // This member is required. - ReservedInstancesId *string - // Unique, case-sensitive identifier you provide to ensure idempotency of your // listings. This helps avoid duplicate listings. For more information, see // Ensuring Idempotency @@ -89,19 +84,24 @@ type CreateReservedInstancesListingInput struct { // This member is required. ClientToken *string + // The number of instances that are a part of a Reserved Instance account to be + // listed in the Reserved Instance Marketplace. This number should be less than or + // equal to the instance count associated with the Reserved Instance ID specified + // in this call. + // + // This member is required. + InstanceCount *int32 + // A list specifying the price of the Standard Reserved Instance for each month // remaining in the Reserved Instance term. // // This member is required. PriceSchedules []*types.PriceScheduleSpecification - // The number of instances that are a part of a Reserved Instance account to be - // listed in the Reserved Instance Marketplace. This number should be less than or - // equal to the instance count associated with the Reserved Instance ID specified - // in this call. + // The ID of the active Standard Reserved Instance. // // This member is required. - InstanceCount *int32 + ReservedInstancesId *string } // Contains the output of CreateReservedInstancesListing. diff --git a/service/ec2/api_op_CreateRoute.go b/service/ec2/api_op_CreateRoute.go index 4b5b5c01c41..ea6a9722bb7 100644 --- a/service/ec2/api_op_CreateRoute.go +++ b/service/ec2/api_op_CreateRoute.go @@ -74,14 +74,10 @@ func (c *Client) CreateRoute(ctx context.Context, params *CreateRouteInput, optF type CreateRouteInput struct { - // The ID of a VPC peering connection. - VpcPeeringConnectionId *string - - // The ID of a network interface. - NetworkInterfaceId *string - - // The ID of the local gateway. - LocalGatewayId *string + // The ID of the route table for the route. + // + // This member is required. + RouteTableId *string // The IPv4 CIDR address block used for the destination match. Routing decisions // are based on the most specific match. We modify the specified CIDR block to its @@ -89,39 +85,43 @@ type CreateRouteInput struct { // 100.68.0.0/18. DestinationCidrBlock *string + // The IPv6 CIDR block used for the destination match. Routing decisions are based + // on the most specific match. + DestinationIpv6CidrBlock *string + // The ID of a prefix list used for the destination match. DestinationPrefixListId *string - // [IPv6 traffic only] The ID of an egress-only internet gateway. - EgressOnlyInternetGatewayId *string - - // The ID of an internet gateway or virtual private gateway attached to your VPC. - GatewayId *string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // The ID of the route table for the route. - // - // This member is required. - RouteTableId *string + // [IPv6 traffic only] The ID of an egress-only internet gateway. + EgressOnlyInternetGatewayId *string - // The ID of a transit gateway. - TransitGatewayId *string + // The ID of an internet gateway or virtual private gateway attached to your VPC. + GatewayId *string - // The IPv6 CIDR block used for the destination match. Routing decisions are based - // on the most specific match. - DestinationIpv6CidrBlock *string + // The ID of a NAT instance in your VPC. The operation fails if you specify an + // instance ID unless exactly one network interface is attached. + InstanceId *string + + // The ID of the local gateway. + LocalGatewayId *string // [IPv4 traffic only] The ID of a NAT gateway. NatGatewayId *string - // The ID of a NAT instance in your VPC. The operation fails if you specify an - // instance ID unless exactly one network interface is attached. - InstanceId *string + // The ID of a network interface. + NetworkInterfaceId *string + + // The ID of a transit gateway. + TransitGatewayId *string + + // The ID of a VPC peering connection. + VpcPeeringConnectionId *string } type CreateRouteOutput struct { diff --git a/service/ec2/api_op_CreateRouteTable.go b/service/ec2/api_op_CreateRouteTable.go index ec487a5f379..2b88d87163d 100644 --- a/service/ec2/api_op_CreateRouteTable.go +++ b/service/ec2/api_op_CreateRouteTable.go @@ -66,14 +66,14 @@ type CreateRouteTableInput struct { // This member is required. VpcId *string - // The tags to assign to the route table. - TagSpecifications []*types.TagSpecification - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // The tags to assign to the route table. + TagSpecifications []*types.TagSpecification } type CreateRouteTableOutput struct { diff --git a/service/ec2/api_op_CreateSecurityGroup.go b/service/ec2/api_op_CreateSecurityGroup.go index 04b83306fea..58f6ab8733e 100644 --- a/service/ec2/api_op_CreateSecurityGroup.go +++ b/service/ec2/api_op_CreateSecurityGroup.go @@ -77,9 +77,6 @@ func (c *Client) CreateSecurityGroup(ctx context.Context, params *CreateSecurity type CreateSecurityGroupInput struct { - // The tags to assign to the security group. - TagSpecifications []*types.TagSpecification - // A description for the security group. This is informational only. Constraints: // Up to 255 characters in length Constraints for EC2-Classic: ASCII characters // Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* @@ -94,14 +91,17 @@ type CreateSecurityGroupInput struct { // This member is required. GroupName *string - // [EC2-VPC] The ID of the VPC. Required for EC2-VPC. - VpcId *string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // The tags to assign to the security group. + TagSpecifications []*types.TagSpecification + + // [EC2-VPC] The ID of the VPC. Required for EC2-VPC. + VpcId *string } type CreateSecurityGroupOutput struct { diff --git a/service/ec2/api_op_CreateSnapshot.go b/service/ec2/api_op_CreateSnapshot.go index dc4f8d50e80..07760e069b0 100644 --- a/service/ec2/api_op_CreateSnapshot.go +++ b/service/ec2/api_op_CreateSnapshot.go @@ -83,6 +83,11 @@ func (c *Client) CreateSnapshot(ctx context.Context, params *CreateSnapshotInput type CreateSnapshotInput struct { + // The ID of the EBS volume. + // + // This member is required. + VolumeId *string + // A description for the snapshot. Description *string @@ -94,21 +99,29 @@ type CreateSnapshotInput struct { // The tags to apply to the snapshot during creation. TagSpecifications []*types.TagSpecification - - // The ID of the EBS volume. - // - // This member is required. - VolumeId *string } // Describes a snapshot. type CreateSnapshotOutput struct { - // The AWS account ID of the EBS snapshot owner. - OwnerId *string + // The data encryption key identifier for the snapshot. This value is a unique + // identifier that corresponds to the data encryption key that was used to encrypt + // the original volume or snapshot copy. Because data encryption keys are inherited + // by volumes created from snapshots, and vice versa, if snapshots share the same + // data encryption key identifier, then they belong to the same volume/snapshot + // lineage. This parameter is only returned by DescribeSnapshots (). + DataEncryptionKeyId *string - // The size of the volume, in GiB. - VolumeSize *int32 + // The description for the snapshot. + Description *string + + // Indicates whether the snapshot is encrypted. + Encrypted *bool + + // The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) + // customer master key (CMK) that was used to protect the volume encryption key for + // the parent volume. + KmsKeyId *string // The AWS owner alias, as maintained by Amazon. The possible values are: amazon | // self | all | aws-marketplace | microsoft. This AWS owner alias is not to be @@ -116,14 +129,21 @@ type CreateSnapshotOutput struct { // console. OwnerAlias *string + // The AWS account ID of the EBS snapshot owner. + OwnerId *string + + // The progress of the snapshot, as a percentage. + Progress *string + // The ID of the snapshot. Each snapshot receives a unique identifier when it is // created. SnapshotId *string - // The ID of the volume that was used to create the snapshot. Snapshots created by - // the CopySnapshot () action have an arbitrary volume ID that should not be used - // for any purpose. - VolumeId *string + // The time stamp when the snapshot was initiated. + StartTime *time.Time + + // The snapshot state. + State types.SnapshotState // Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy // operation fails (for example, if the proper AWS Key Management Service (AWS KMS) @@ -132,36 +152,16 @@ type CreateSnapshotOutput struct { // DescribeSnapshots (). StateMessage *string - // Indicates whether the snapshot is encrypted. - Encrypted *bool - // Any tags assigned to the snapshot. Tags []*types.Tag - // The data encryption key identifier for the snapshot. This value is a unique - // identifier that corresponds to the data encryption key that was used to encrypt - // the original volume or snapshot copy. Because data encryption keys are inherited - // by volumes created from snapshots, and vice versa, if snapshots share the same - // data encryption key identifier, then they belong to the same volume/snapshot - // lineage. This parameter is only returned by DescribeSnapshots (). - DataEncryptionKeyId *string - - // The progress of the snapshot, as a percentage. - Progress *string - - // The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) - // customer master key (CMK) that was used to protect the volume encryption key for - // the parent volume. - KmsKeyId *string - - // The description for the snapshot. - Description *string - - // The snapshot state. - State types.SnapshotState + // The ID of the volume that was used to create the snapshot. Snapshots created by + // the CopySnapshot () action have an arbitrary volume ID that should not be used + // for any purpose. + VolumeId *string - // The time stamp when the snapshot was initiated. - StartTime *time.Time + // The size of the volume, in GiB. + VolumeSize *int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/ec2/api_op_CreateSnapshots.go b/service/ec2/api_op_CreateSnapshots.go index babfa94aec5..ae472436a0a 100644 --- a/service/ec2/api_op_CreateSnapshots.go +++ b/service/ec2/api_op_CreateSnapshots.go @@ -60,25 +60,25 @@ func (c *Client) CreateSnapshots(ctx context.Context, params *CreateSnapshotsInp type CreateSnapshotsInput struct { + // The instance to specify which volumes should be included in the snapshots. + // + // This member is required. + InstanceSpecification *types.InstanceSpecification + + // Copies the tags from the specified volume to corresponding snapshot. + CopyTagsFromSource types.CopyTagsFromSource + + // A description propagated to every snapshot specified by the instance. + Description *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // Copies the tags from the specified volume to corresponding snapshot. - CopyTagsFromSource types.CopyTagsFromSource - // Tags to apply to every snapshot specified by the instance. TagSpecifications []*types.TagSpecification - - // The instance to specify which volumes should be included in the snapshots. - // - // This member is required. - InstanceSpecification *types.InstanceSpecification - - // A description propagated to every snapshot specified by the instance. - Description *string } type CreateSnapshotsOutput struct { diff --git a/service/ec2/api_op_CreateSpotDatafeedSubscription.go b/service/ec2/api_op_CreateSpotDatafeedSubscription.go index 7ce5bd5ab3e..bae2d787082 100644 --- a/service/ec2/api_op_CreateSpotDatafeedSubscription.go +++ b/service/ec2/api_op_CreateSpotDatafeedSubscription.go @@ -62,9 +62,6 @@ func (c *Client) CreateSpotDatafeedSubscription(ctx context.Context, params *Cre // Contains the parameters for CreateSpotDatafeedSubscription. type CreateSpotDatafeedSubscriptionInput struct { - // A prefix for the data feed file names. - Prefix *string - // The Amazon S3 bucket in which to store the Spot Instance data feed. // // This member is required. @@ -75,6 +72,9 @@ type CreateSpotDatafeedSubscriptionInput struct { // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // A prefix for the data feed file names. + Prefix *string } // Contains the output of CreateSpotDatafeedSubscription. diff --git a/service/ec2/api_op_CreateSubnet.go b/service/ec2/api_op_CreateSubnet.go index a9b93d90e43..30ce24c8f2f 100644 --- a/service/ec2/api_op_CreateSubnet.go +++ b/service/ec2/api_op_CreateSubnet.go @@ -71,22 +71,6 @@ func (c *Client) CreateSubnet(ctx context.Context, params *CreateSubnetInput, op type CreateSubnetInput struct { - // The IPv6 network range for the subnet, in CIDR notation. The subnet size must - // use a /64 prefix length. - Ipv6CidrBlock *string - - // The ID of the VPC. - // - // This member is required. - VpcId *string - - // The AZ ID or the Local Zone ID of the subnet. - AvailabilityZoneId *string - - // The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost ARN, - // you must also specify the Availability Zone of the Outpost subnet. - OutpostArn *string - // The IPv4 network range for the subnet, in CIDR notation. For example, // 10.0.0.0/24. We modify the specified CIDR block to its canonical form; for // example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18. @@ -94,6 +78,11 @@ type CreateSubnetInput struct { // This member is required. CidrBlock *string + // The ID of the VPC. + // + // This member is required. + VpcId *string + // The Availability Zone or Local Zone for the subnet. Default: AWS selects one for // you. If you create more than one subnet in your VPC, we do not necessarily // select a different zone for each subnet. To create a subnet in a Local Zone, set @@ -105,14 +94,25 @@ type CreateSubnetInput struct { // Outpost ARN. AvailabilityZone *string - // The tags to assign to the subnet. - TagSpecifications []*types.TagSpecification + // The AZ ID or the Local Zone ID of the subnet. + AvailabilityZoneId *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // The IPv6 network range for the subnet, in CIDR notation. The subnet size must + // use a /64 prefix length. + Ipv6CidrBlock *string + + // The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost ARN, + // you must also specify the Availability Zone of the Outpost subnet. + OutpostArn *string + + // The tags to assign to the subnet. + TagSpecifications []*types.TagSpecification } type CreateSubnetOutput struct { diff --git a/service/ec2/api_op_CreateTrafficMirrorFilter.go b/service/ec2/api_op_CreateTrafficMirrorFilter.go index e308920510b..75ff27f51c3 100644 --- a/service/ec2/api_op_CreateTrafficMirrorFilter.go +++ b/service/ec2/api_op_CreateTrafficMirrorFilter.go @@ -65,12 +65,6 @@ func (c *Client) CreateTrafficMirrorFilter(ctx context.Context, params *CreateTr type CreateTrafficMirrorFilterInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. For more information, see How to Ensure Idempotency // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). @@ -79,6 +73,12 @@ type CreateTrafficMirrorFilterInput struct { // The description of the Traffic Mirror filter. Description *string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // The tags to assign to a Traffic Mirror filter. TagSpecifications []*types.TagSpecification } diff --git a/service/ec2/api_op_CreateTrafficMirrorFilterRule.go b/service/ec2/api_op_CreateTrafficMirrorFilterRule.go index b7899424a7d..3494ad80193 100644 --- a/service/ec2/api_op_CreateTrafficMirrorFilterRule.go +++ b/service/ec2/api_op_CreateTrafficMirrorFilterRule.go @@ -61,63 +61,63 @@ func (c *Client) CreateTrafficMirrorFilterRule(ctx context.Context, params *Crea type CreateTrafficMirrorFilterRuleInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - - // The source CIDR block to assign to the Traffic Mirror rule. + // The destination CIDR block to assign to the Traffic Mirror rule. // // This member is required. - SourceCidrBlock *string + DestinationCidrBlock *string // The action to take (accept | reject) on the filtered traffic. // // This member is required. RuleAction types.TrafficMirrorRuleAction - // The protocol, for example UDP, to assign to the Traffic Mirror rule. For - // information about the protocol value, see Protocol Numbers - // (https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) on - // the Internet Assigned Numbers Authority (IANA) website. - Protocol *int32 - - // The destination CIDR block to assign to the Traffic Mirror rule. + // The number of the Traffic Mirror rule. This number must be unique for each + // Traffic Mirror rule in a given direction. The rules are processed in ascending + // order by rule number. // // This member is required. - DestinationCidrBlock *string - - // The description of the Traffic Mirror rule. - Description *string + RuleNumber *int32 - // The destination port range. - DestinationPortRange *types.TrafficMirrorPortRangeRequest + // The source CIDR block to assign to the Traffic Mirror rule. + // + // This member is required. + SourceCidrBlock *string // The type of traffic (ingress | egress). // // This member is required. TrafficDirection types.TrafficDirection + // The ID of the filter that this rule is associated with. + // + // This member is required. + TrafficMirrorFilterId *string + // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. For more information, see How to Ensure Idempotency // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). ClientToken *string - // The source port range. - SourcePortRange *types.TrafficMirrorPortRangeRequest + // The description of the Traffic Mirror rule. + Description *string - // The number of the Traffic Mirror rule. This number must be unique for each - // Traffic Mirror rule in a given direction. The rules are processed in ascending - // order by rule number. - // - // This member is required. - RuleNumber *int32 + // The destination port range. + DestinationPortRange *types.TrafficMirrorPortRangeRequest - // The ID of the filter that this rule is associated with. - // - // This member is required. - TrafficMirrorFilterId *string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + + // The protocol, for example UDP, to assign to the Traffic Mirror rule. For + // information about the protocol value, see Protocol Numbers + // (https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) on + // the Internet Assigned Numbers Authority (IANA) website. + Protocol *int32 + + // The source port range. + SourcePortRange *types.TrafficMirrorPortRangeRequest } type CreateTrafficMirrorFilterRuleOutput struct { diff --git a/service/ec2/api_op_CreateTrafficMirrorSession.go b/service/ec2/api_op_CreateTrafficMirrorSession.go index 14b5590732d..b719f6aafb4 100644 --- a/service/ec2/api_op_CreateTrafficMirrorSession.go +++ b/service/ec2/api_op_CreateTrafficMirrorSession.go @@ -67,21 +67,35 @@ func (c *Client) CreateTrafficMirrorSession(ctx context.Context, params *CreateT type CreateTrafficMirrorSessionInput struct { - // The description of the Traffic Mirror session. - Description *string + // The ID of the source network interface. + // + // This member is required. + NetworkInterfaceId *string + + // The session number determines the order in which sessions are evaluated when an + // interface is used by multiple sessions. The first session with a matching filter + // is the one that mirrors the packets. Valid values are 1-32766. + // + // This member is required. + SessionNumber *int32 + + // The ID of the Traffic Mirror filter. + // + // This member is required. + TrafficMirrorFilterId *string + + // The ID of the Traffic Mirror target. + // + // This member is required. + TrafficMirrorTargetId *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. For more information, see How to Ensure Idempotency // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). ClientToken *string - // The ID of the source network interface. - // - // This member is required. - NetworkInterfaceId *string - - // The tags to assign to a Traffic Mirror session. - TagSpecifications []*types.TagSpecification + // The description of the Traffic Mirror session. + Description *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the @@ -89,11 +103,6 @@ type CreateTrafficMirrorSessionInput struct { // UnauthorizedOperation. DryRun *bool - // The VXLAN ID for the Traffic Mirror session. For more information about the - // VXLAN protocol, see RFC 7348 (https://tools.ietf.org/html/rfc7348). If you do - // not specify a VirtualNetworkId, an account-wide unique id is chosen at random. - VirtualNetworkId *int32 - // The number of bytes in each packet to mirror. These are bytes after the VXLAN // header. Do not specify this parameter when you want to mirror the entire packet. // To mirror a subset of the packet, set this to the length (in bytes) that you @@ -103,22 +112,13 @@ type CreateTrafficMirrorSessionInput struct { // number of bytes in each packet to mirror. PacketLength *int32 - // The session number determines the order in which sessions are evaluated when an - // interface is used by multiple sessions. The first session with a matching filter - // is the one that mirrors the packets. Valid values are 1-32766. - // - // This member is required. - SessionNumber *int32 - - // The ID of the Traffic Mirror target. - // - // This member is required. - TrafficMirrorTargetId *string + // The tags to assign to a Traffic Mirror session. + TagSpecifications []*types.TagSpecification - // The ID of the Traffic Mirror filter. - // - // This member is required. - TrafficMirrorFilterId *string + // The VXLAN ID for the Traffic Mirror session. For more information about the + // VXLAN protocol, see RFC 7348 (https://tools.ietf.org/html/rfc7348). If you do + // not specify a VirtualNetworkId, an account-wide unique id is chosen at random. + VirtualNetworkId *int32 } type CreateTrafficMirrorSessionOutput struct { diff --git a/service/ec2/api_op_CreateTrafficMirrorTarget.go b/service/ec2/api_op_CreateTrafficMirrorTarget.go index 4fbc33a8296..428746f8f87 100644 --- a/service/ec2/api_op_CreateTrafficMirrorTarget.go +++ b/service/ec2/api_op_CreateTrafficMirrorTarget.go @@ -64,9 +64,13 @@ func (c *Client) CreateTrafficMirrorTarget(ctx context.Context, params *CreateTr type CreateTrafficMirrorTargetInput struct { - // The Amazon Resource Name (ARN) of the Network Load Balancer that is associated - // with the target. - NetworkLoadBalancerArn *string + // Unique, case-sensitive identifier that you provide to ensure the idempotency of + // the request. For more information, see How to Ensure Idempotency + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + ClientToken *string + + // The description of the Traffic Mirror target. + Description *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the @@ -74,19 +78,15 @@ type CreateTrafficMirrorTargetInput struct { // UnauthorizedOperation. DryRun *bool - // The description of the Traffic Mirror target. - Description *string + // The network interface ID that is associated with the target. + NetworkInterfaceId *string + + // The Amazon Resource Name (ARN) of the Network Load Balancer that is associated + // with the target. + NetworkLoadBalancerArn *string // The tags to assign to the Traffic Mirror target. TagSpecifications []*types.TagSpecification - - // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to Ensure Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). - ClientToken *string - - // The network interface ID that is associated with the target. - NetworkInterfaceId *string } type CreateTrafficMirrorTargetOutput struct { diff --git a/service/ec2/api_op_CreateTransitGateway.go b/service/ec2/api_op_CreateTransitGateway.go index ce10c7e6636..c32b001fb4c 100644 --- a/service/ec2/api_op_CreateTransitGateway.go +++ b/service/ec2/api_op_CreateTransitGateway.go @@ -71,8 +71,8 @@ func (c *Client) CreateTransitGateway(ctx context.Context, params *CreateTransit type CreateTransitGatewayInput struct { - // The tags to apply to the transit gateway. - TagSpecifications []*types.TagSpecification + // A description of the transit gateway. + Description *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the @@ -83,8 +83,8 @@ type CreateTransitGatewayInput struct { // The transit gateway options. Options *types.TransitGatewayRequestOptions - // A description of the transit gateway. - Description *string + // The tags to apply to the transit gateway. + TagSpecifications []*types.TagSpecification } type CreateTransitGatewayOutput struct { diff --git a/service/ec2/api_op_CreateTransitGatewayMulticastDomain.go b/service/ec2/api_op_CreateTransitGatewayMulticastDomain.go index 7928f372b99..883839ed757 100644 --- a/service/ec2/api_op_CreateTransitGatewayMulticastDomain.go +++ b/service/ec2/api_op_CreateTransitGatewayMulticastDomain.go @@ -61,6 +61,11 @@ func (c *Client) CreateTransitGatewayMulticastDomain(ctx context.Context, params type CreateTransitGatewayMulticastDomainInput struct { + // The ID of the transit gateway. + // + // This member is required. + TransitGatewayId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -69,11 +74,6 @@ type CreateTransitGatewayMulticastDomainInput struct { // The tags for the transit gateway multicast domain. TagSpecifications []*types.TagSpecification - - // The ID of the transit gateway. - // - // This member is required. - TransitGatewayId *string } type CreateTransitGatewayMulticastDomainOutput struct { diff --git a/service/ec2/api_op_CreateTransitGatewayPeeringAttachment.go b/service/ec2/api_op_CreateTransitGatewayPeeringAttachment.go index 5de5f82f926..09a3b329a7c 100644 --- a/service/ec2/api_op_CreateTransitGatewayPeeringAttachment.go +++ b/service/ec2/api_op_CreateTransitGatewayPeeringAttachment.go @@ -61,23 +61,25 @@ func (c *Client) CreateTransitGatewayPeeringAttachment(ctx context.Context, para type CreateTransitGatewayPeeringAttachmentInput struct { - // The ID of the transit gateway. + // The AWS account ID of the owner of the peer transit gateway. // // This member is required. - TransitGatewayId *string + PeerAccountId *string + + // The Region where the peer transit gateway is located. + // + // This member is required. + PeerRegion *string // The ID of the peer transit gateway with which to create the peering attachment. // // This member is required. PeerTransitGatewayId *string - // The tags to apply to the transit gateway peering attachment. - TagSpecifications []*types.TagSpecification - - // The AWS account ID of the owner of the peer transit gateway. + // The ID of the transit gateway. // // This member is required. - PeerAccountId *string + TransitGatewayId *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the @@ -85,10 +87,8 @@ type CreateTransitGatewayPeeringAttachmentInput struct { // UnauthorizedOperation. DryRun *bool - // The Region where the peer transit gateway is located. - // - // This member is required. - PeerRegion *string + // The tags to apply to the transit gateway peering attachment. + TagSpecifications []*types.TagSpecification } type CreateTransitGatewayPeeringAttachmentOutput struct { diff --git a/service/ec2/api_op_CreateTransitGatewayRoute.go b/service/ec2/api_op_CreateTransitGatewayRoute.go index 35629f14477..d4bf8f0292a 100644 --- a/service/ec2/api_op_CreateTransitGatewayRoute.go +++ b/service/ec2/api_op_CreateTransitGatewayRoute.go @@ -57,14 +57,17 @@ func (c *Client) CreateTransitGatewayRoute(ctx context.Context, params *CreateTr type CreateTransitGatewayRouteInput struct { + // The CIDR range used for destination matches. Routing decisions are based on the + // most specific match. + // + // This member is required. + DestinationCidrBlock *string + // The ID of the transit gateway route table. // // This member is required. TransitGatewayRouteTableId *string - // The ID of the attachment. - TransitGatewayAttachmentId *string - // Indicates whether to drop traffic that matches this route. Blackhole *bool @@ -74,11 +77,8 @@ type CreateTransitGatewayRouteInput struct { // UnauthorizedOperation. DryRun *bool - // The CIDR range used for destination matches. Routing decisions are based on the - // most specific match. - // - // This member is required. - DestinationCidrBlock *string + // The ID of the attachment. + TransitGatewayAttachmentId *string } type CreateTransitGatewayRouteOutput struct { diff --git a/service/ec2/api_op_CreateTransitGatewayVpcAttachment.go b/service/ec2/api_op_CreateTransitGatewayVpcAttachment.go index a26008218a1..c44399ee529 100644 --- a/service/ec2/api_op_CreateTransitGatewayVpcAttachment.go +++ b/service/ec2/api_op_CreateTransitGatewayVpcAttachment.go @@ -61,17 +61,6 @@ func (c *Client) CreateTransitGatewayVpcAttachment(ctx context.Context, params * type CreateTransitGatewayVpcAttachmentInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - - // The ID of the VPC. - // - // This member is required. - VpcId *string - // The IDs of one or more subnets. You can specify only one subnet per Availability // Zone. You must specify at least one subnet, but we recommend that you specify // two subnets for better availability. The transit gateway uses one IP address @@ -80,16 +69,27 @@ type CreateTransitGatewayVpcAttachmentInput struct { // This member is required. SubnetIds []*string + // The ID of the transit gateway. + // + // This member is required. + TransitGatewayId *string + + // The ID of the VPC. + // + // This member is required. + VpcId *string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // The VPC attachment options. Options *types.CreateTransitGatewayVpcAttachmentRequestOptions // The tags to apply to the VPC attachment. TagSpecifications []*types.TagSpecification - - // The ID of the transit gateway. - // - // This member is required. - TransitGatewayId *string } type CreateTransitGatewayVpcAttachmentOutput struct { diff --git a/service/ec2/api_op_CreateVolume.go b/service/ec2/api_op_CreateVolume.go index de03048d95e..4a11b9388a6 100644 --- a/service/ec2/api_op_CreateVolume.go +++ b/service/ec2/api_op_CreateVolume.go @@ -79,13 +79,33 @@ type CreateVolumeInput struct { // This member is required. AvailabilityZone *string - // The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned - // IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for - // Magnetic volumes. Default: gp2 - VolumeType types.VolumeType + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool - // The tags to apply to the volume during creation. - TagSpecifications []*types.TagSpecification + // Specifies whether the volume should be encrypted. The effect of setting the + // encryption state to true depends on the volume origin (new or from a snapshot), + // starting encryption state, ownership, and whether encryption by default is + // enabled. For more information, see Encryption by Default + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) + // in the Amazon Elastic Compute Cloud User Guide. Encrypted Amazon EBS volumes + // must be attached to instances that support Amazon EBS encryption. For more + // information, see Supported Instance Types + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances). + Encrypted *bool + + // The number of I/O operations per second (IOPS) to provision for the volume, with + // a maximum ratio of 50 IOPS/GiB. Range is 100 to 64,000 IOPS for volumes in most + // Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). + // Other instance families guarantee performance up to 32,000 IOPS. For more + // information, see Amazon EBS Volume Types + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the + // Amazon Elastic Compute Cloud User Guide. This parameter is valid only for + // Provisioned IOPS SSD (io1) volumes. + Iops *int32 // The identifier of the AWS Key Management Service (AWS KMS) customer master key // (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your @@ -110,37 +130,6 @@ type CreateVolumeInput struct { // valid, the action can appear to complete, but eventually fails. KmsKeyId *string - // The number of I/O operations per second (IOPS) to provision for the volume, with - // a maximum ratio of 50 IOPS/GiB. Range is 100 to 64,000 IOPS for volumes in most - // Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). - // Other instance families guarantee performance up to 32,000 IOPS. For more - // information, see Amazon EBS Volume Types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the - // Amazon Elastic Compute Cloud User Guide. This parameter is valid only for - // Provisioned IOPS SSD (io1) volumes. - Iops *int32 - - // The Amazon Resource Name (ARN) of the Outpost. - OutpostArn *string - - // Specifies whether the volume should be encrypted. The effect of setting the - // encryption state to true depends on the volume origin (new or from a snapshot), - // starting encryption state, ownership, and whether encryption by default is - // enabled. For more information, see Encryption by Default - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) - // in the Amazon Elastic Compute Cloud User Guide. Encrypted Amazon EBS volumes - // must be attached to instances that support Amazon EBS encryption. For more - // information, see Supported Instance Types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances). - Encrypted *bool - - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, // you can attach the volume to up to 16 Nitro-based instances // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) @@ -150,9 +139,8 @@ type CreateVolumeInput struct { // the Amazon Elastic Compute Cloud User Guide. MultiAttachEnabled *bool - // The snapshot from which to create the volume. You must specify either a snapshot - // ID or a volume size. - SnapshotId *string + // The Amazon Resource Name (ARN) of the Outpost. + OutpostArn *string // The size of the volume, in GiBs. You must specify either a snapshot ID or a // volume size. Constraints: 1-16,384 for gp2, 4-16,384 for io1, 500-16,384 for @@ -161,56 +149,37 @@ type CreateVolumeInput struct { // you're creating the volume from a snapshot and don't specify a volume size, the // default is the snapshot size. Size *int32 -} - -// Describes a volume. -type CreateVolumeOutput struct { - - // Indicates whether the volume is encrypted. - Encrypted *bool - - // Any tags assigned to the volume. - Tags []*types.Tag - // Indicates whether Amazon EBS Multi-Attach is enabled. - MultiAttachEnabled *bool - - // The Amazon Resource Name (ARN) of the Outpost. - OutpostArn *string + // The snapshot from which to create the volume. You must specify either a snapshot + // ID or a volume size. + SnapshotId *string - // The size of the volume, in GiBs. - Size *int32 + // The tags to apply to the volume during creation. + TagSpecifications []*types.TagSpecification // The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned // IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for - // Magnetic volumes. + // Magnetic volumes. Default: gp2 VolumeType types.VolumeType +} - // Indicates whether the volume was created using fast snapshot restore. - FastRestored *bool +// Describes a volume. +type CreateVolumeOutput struct { // Information about the volume attachments. Attachments []*types.VolumeAttachment - // The snapshot from which the volume was created, if applicable. - SnapshotId *string - - // The volume state. - State types.VolumeState - - // The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) - // customer master key (CMK) that was used to protect the volume encryption key for - // the volume. - KmsKeyId *string - // The Availability Zone for the volume. AvailabilityZone *string // The time stamp when volume creation was initiated. CreateTime *time.Time - // The ID of the volume. - VolumeId *string + // Indicates whether the volume is encrypted. + Encrypted *bool + + // Indicates whether the volume was created using fast snapshot restore. + FastRestored *bool // The number of I/O operations per second (IOPS) that the volume supports. For // Provisioned IOPS SSD volumes, this represents the number of IOPS that are @@ -227,6 +196,37 @@ type CreateVolumeOutput struct { // requests to create gp2, st1, sc1, or standard volumes. Iops *int32 + // The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) + // customer master key (CMK) that was used to protect the volume encryption key for + // the volume. + KmsKeyId *string + + // Indicates whether Amazon EBS Multi-Attach is enabled. + MultiAttachEnabled *bool + + // The Amazon Resource Name (ARN) of the Outpost. + OutpostArn *string + + // The size of the volume, in GiBs. + Size *int32 + + // The snapshot from which the volume was created, if applicable. + SnapshotId *string + + // The volume state. + State types.VolumeState + + // Any tags assigned to the volume. + Tags []*types.Tag + + // The ID of the volume. + VolumeId *string + + // The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned + // IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for + // Magnetic volumes. + VolumeType types.VolumeType + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_CreateVpc.go b/service/ec2/api_op_CreateVpc.go index 9517a0fd648..ae280591f31 100644 --- a/service/ec2/api_op_CreateVpc.go +++ b/service/ec2/api_op_CreateVpc.go @@ -75,15 +75,6 @@ func (c *Client) CreateVpc(ctx context.Context, params *CreateVpcInput, optFns . type CreateVpcInput struct { - // The tags to assign to the VPC. - TagSpecifications []*types.TagSpecification - - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16. // We modify the specified CIDR block to its canonical form; for example, if you // specify 100.68.0.18/18, we modify it to 100.68.0.0/18. @@ -91,6 +82,17 @@ type CreateVpcInput struct { // This member is required. CidrBlock *string + // Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the + // VPC. You cannot specify the range of IP addresses, or the size of the CIDR + // block. + AmazonProvidedIpv6CidrBlock *bool + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // The tenancy options for instances launched into the VPC. For default, instances // are launched with shared tenancy by default. You can launch instances with any // tenancy into a shared tenancy VPC. For dedicated, instances are launched as @@ -100,23 +102,21 @@ type CreateVpcInput struct { // only. Default: default InstanceTenancy types.Tenancy - // The name of the location from which we advertise the IPV6 CIDR block. Use this - // parameter to limit the address to this location. You must set - // AmazonProvidedIpv6CidrBlock to true to use this parameter. - Ipv6CidrBlockNetworkBorderGroup *string - // The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool // in the request. To let Amazon choose the IPv6 CIDR block for you, omit this // parameter. Ipv6CidrBlock *string - // Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the - // VPC. You cannot specify the range of IP addresses, or the size of the CIDR - // block. - AmazonProvidedIpv6CidrBlock *bool + // The name of the location from which we advertise the IPV6 CIDR block. Use this + // parameter to limit the address to this location. You must set + // AmazonProvidedIpv6CidrBlock to true to use this parameter. + Ipv6CidrBlockNetworkBorderGroup *string // The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block. Ipv6Pool *string + + // The tags to assign to the VPC. + TagSpecifications []*types.TagSpecification } type CreateVpcOutput struct { diff --git a/service/ec2/api_op_CreateVpcEndpoint.go b/service/ec2/api_op_CreateVpcEndpoint.go index 85643750425..c205c462f60 100644 --- a/service/ec2/api_op_CreateVpcEndpoint.go +++ b/service/ec2/api_op_CreateVpcEndpoint.go @@ -71,14 +71,6 @@ func (c *Client) CreateVpcEndpoint(ctx context.Context, params *CreateVpcEndpoin // Contains the parameters for CreateVpcEndpoint. type CreateVpcEndpointInput struct { - // (Interface endpoint) The ID of one or more subnets in which to create an - // endpoint network interface. - SubnetIds []*string - - // (Interface endpoint) The ID of one or more security groups to associate with the - // endpoint network interface. - SecurityGroupIds []*string - // The service name. To get a list of available services, use the // DescribeVpcEndpointServices () request, or get the name from the service // provider. @@ -86,6 +78,11 @@ type CreateVpcEndpointInput struct { // This member is required. ServiceName *string + // The ID of the VPC in which the endpoint will be used. + // + // This member is required. + VpcId *string + // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. For more information, see How to Ensure Idempotency // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). @@ -97,25 +94,11 @@ type CreateVpcEndpointInput struct { // UnauthorizedOperation. DryRun *bool - // The tags to associate with the endpoint. - TagSpecifications []*types.TagSpecification - - // The type of endpoint. Default: Gateway - VpcEndpointType types.VpcEndpointType - - // (Gateway endpoint) One or more route table IDs. - RouteTableIds []*string - // A policy to attach to the endpoint that controls access to the service. The // policy must be in valid JSON format. If this parameter is not specified, we // attach a default policy that allows full access to the service. PolicyDocument *string - // The ID of the VPC in which the endpoint will be used. - // - // This member is required. - VpcId *string - // (Interface endpoint) Indicates whether to associate a private hosted zone with // the specified VPC. The private hosted zone contains a record set for the default // public DNS name for the service for the Region (for example, @@ -127,6 +110,23 @@ type CreateVpcEndpointInput struct { // enableDnsSupport. Use ModifyVpcAttribute () to set the VPC attributes. Default: // true PrivateDnsEnabled *bool + + // (Gateway endpoint) One or more route table IDs. + RouteTableIds []*string + + // (Interface endpoint) The ID of one or more security groups to associate with the + // endpoint network interface. + SecurityGroupIds []*string + + // (Interface endpoint) The ID of one or more subnets in which to create an + // endpoint network interface. + SubnetIds []*string + + // The tags to associate with the endpoint. + TagSpecifications []*types.TagSpecification + + // The type of endpoint. Default: Gateway + VpcEndpointType types.VpcEndpointType } // Contains the output of CreateVpcEndpoint. diff --git a/service/ec2/api_op_CreateVpcEndpointConnectionNotification.go b/service/ec2/api_op_CreateVpcEndpointConnectionNotification.go index 82bb44047c3..e3baf96e353 100644 --- a/service/ec2/api_op_CreateVpcEndpointConnectionNotification.go +++ b/service/ec2/api_op_CreateVpcEndpointConnectionNotification.go @@ -62,23 +62,17 @@ func (c *Client) CreateVpcEndpointConnectionNotification(ctx context.Context, pa type CreateVpcEndpointConnectionNotificationInput struct { - // The ID of the endpoint. - VpcEndpointId *string - - // The ARN of the SNS topic for the notifications. - // - // This member is required. - ConnectionNotificationArn *string - - // The ID of the endpoint service. - ServiceId *string - // One or more endpoint events for which to receive notifications. Valid values are // Accept, Connect, Delete, and Reject. // // This member is required. ConnectionEvents []*string + // The ARN of the SNS topic for the notifications. + // + // This member is required. + ConnectionNotificationArn *string + // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. For more information, see How to Ensure Idempotency // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). @@ -89,17 +83,23 @@ type CreateVpcEndpointConnectionNotificationInput struct { // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // The ID of the endpoint service. + ServiceId *string + + // The ID of the endpoint. + VpcEndpointId *string } type CreateVpcEndpointConnectionNotificationOutput struct { - // Information about the notification. - ConnectionNotification *types.ConnectionNotification - // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. ClientToken *string + // Information about the notification. + ConnectionNotification *types.ConnectionNotification + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_CreateVpcEndpointServiceConfiguration.go b/service/ec2/api_op_CreateVpcEndpointServiceConfiguration.go index 8b4c9b32fb1..343c89dd186 100644 --- a/service/ec2/api_op_CreateVpcEndpointServiceConfiguration.go +++ b/service/ec2/api_op_CreateVpcEndpointServiceConfiguration.go @@ -73,8 +73,10 @@ type CreateVpcEndpointServiceConfigurationInput struct { // This member is required. NetworkLoadBalancerArns []*string - // The private DNS name to assign to the VPC endpoint service. - PrivateDnsName *string + // Indicates whether requests from service consumers to create an endpoint to your + // service must be accepted. To accept a request, use AcceptVpcEndpointConnections + // (). + AcceptanceRequired *bool // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. For more information, see How to Ensure Idempotency @@ -87,13 +89,11 @@ type CreateVpcEndpointServiceConfigurationInput struct { // UnauthorizedOperation. DryRun *bool + // The private DNS name to assign to the VPC endpoint service. + PrivateDnsName *string + // The tags to associate with the service. TagSpecifications []*types.TagSpecification - - // Indicates whether requests from service consumers to create an endpoint to your - // service must be accepted. To accept a request, use AcceptVpcEndpointConnections - // (). - AcceptanceRequired *bool } type CreateVpcEndpointServiceConfigurationOutput struct { diff --git a/service/ec2/api_op_CreateVpcPeeringConnection.go b/service/ec2/api_op_CreateVpcPeeringConnection.go index bfb8e82adc2..a7b38d8077f 100644 --- a/service/ec2/api_op_CreateVpcPeeringConnection.go +++ b/service/ec2/api_op_CreateVpcPeeringConnection.go @@ -67,30 +67,30 @@ func (c *Client) CreateVpcPeeringConnection(ctx context.Context, params *CreateV type CreateVpcPeeringConnectionInput struct { - // The ID of the requester VPC. You must specify this parameter in the request. - VpcId *string - - // The Region code for the accepter VPC, if the accepter VPC is located in a Region - // other than the Region in which you make the request. Default: The Region in - // which you make the request. - PeerRegion *string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // The AWS account ID of the owner of the accepter VPC. Default: Your AWS account // ID PeerOwnerId *string - // The tags to assign to the peering connection. - TagSpecifications []*types.TagSpecification + // The Region code for the accepter VPC, if the accepter VPC is located in a Region + // other than the Region in which you make the request. Default: The Region in + // which you make the request. + PeerRegion *string // The ID of the VPC with which you are creating the VPC peering connection. You // must specify this parameter in the request. PeerVpcId *string - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The tags to assign to the peering connection. + TagSpecifications []*types.TagSpecification + + // The ID of the requester VPC. You must specify this parameter in the request. + VpcId *string } type CreateVpcPeeringConnectionOutput struct { diff --git a/service/ec2/api_op_CreateVpnConnection.go b/service/ec2/api_op_CreateVpnConnection.go index a90fa8f578f..71b8ba661b4 100644 --- a/service/ec2/api_op_CreateVpnConnection.go +++ b/service/ec2/api_op_CreateVpnConnection.go @@ -69,6 +69,11 @@ func (c *Client) CreateVpnConnection(ctx context.Context, params *CreateVpnConne // Contains the parameters for CreateVpnConnection. type CreateVpnConnectionInput struct { + // The ID of the customer gateway. + // + // This member is required. + CustomerGatewayId *string + // The type of VPN connection (ipsec.1). // // This member is required. @@ -83,21 +88,16 @@ type CreateVpnConnectionInput struct { // The options for the VPN connection. Options *types.VpnConnectionOptionsSpecification - // The ID of the customer gateway. - // - // This member is required. - CustomerGatewayId *string - // The tags to apply to the VPN connection. TagSpecifications []*types.TagSpecification - // The ID of the virtual private gateway. If you specify a virtual private gateway, - // you cannot specify a transit gateway. - VpnGatewayId *string - // The ID of the transit gateway. If you specify a transit gateway, you cannot // specify a virtual private gateway. TransitGatewayId *string + + // The ID of the virtual private gateway. If you specify a virtual private gateway, + // you cannot specify a transit gateway. + VpnGatewayId *string } // Contains the output of CreateVpnConnection. diff --git a/service/ec2/api_op_CreateVpnConnectionRoute.go b/service/ec2/api_op_CreateVpnConnectionRoute.go index 49c0800d2bb..296dc82fe3a 100644 --- a/service/ec2/api_op_CreateVpnConnectionRoute.go +++ b/service/ec2/api_op_CreateVpnConnectionRoute.go @@ -62,15 +62,15 @@ func (c *Client) CreateVpnConnectionRoute(ctx context.Context, params *CreateVpn // Contains the parameters for CreateVpnConnectionRoute. type CreateVpnConnectionRouteInput struct { - // The ID of the VPN connection. + // The CIDR block associated with the local subnet of the customer network. // // This member is required. - VpnConnectionId *string + DestinationCidrBlock *string - // The CIDR block associated with the local subnet of the customer network. + // The ID of the VPN connection. // // This member is required. - DestinationCidrBlock *string + VpnConnectionId *string } type CreateVpnConnectionRouteOutput struct { diff --git a/service/ec2/api_op_CreateVpnGateway.go b/service/ec2/api_op_CreateVpnGateway.go index 8cea0dc085d..f07837a87c4 100644 --- a/service/ec2/api_op_CreateVpnGateway.go +++ b/service/ec2/api_op_CreateVpnGateway.go @@ -62,11 +62,10 @@ func (c *Client) CreateVpnGateway(ctx context.Context, params *CreateVpnGatewayI // Contains the parameters for CreateVpnGateway. type CreateVpnGatewayInput struct { - // The Availability Zone for the virtual private gateway. - AvailabilityZone *string - - // The tags to apply to the virtual private gateway. - TagSpecifications []*types.TagSpecification + // The type of VPN connection this virtual private gateway supports. + // + // This member is required. + Type types.GatewayType // A private Autonomous System Number (ASN) for the Amazon side of a BGP session. // If you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're @@ -74,16 +73,17 @@ type CreateVpnGatewayInput struct { // 64512 AmazonSideAsn *int64 - // The type of VPN connection this virtual private gateway supports. - // - // This member is required. - Type types.GatewayType + // The Availability Zone for the virtual private gateway. + AvailabilityZone *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // The tags to apply to the virtual private gateway. + TagSpecifications []*types.TagSpecification } // Contains the output of CreateVpnGateway. diff --git a/service/ec2/api_op_DeleteClientVpnRoute.go b/service/ec2/api_op_DeleteClientVpnRoute.go index 28e7a79547b..a1c07266492 100644 --- a/service/ec2/api_op_DeleteClientVpnRoute.go +++ b/service/ec2/api_op_DeleteClientVpnRoute.go @@ -61,24 +61,24 @@ func (c *Client) DeleteClientVpnRoute(ctx context.Context, params *DeleteClientV type DeleteClientVpnRouteInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The ID of the Client VPN endpoint from which the route is to be deleted. + // + // This member is required. + ClientVpnEndpointId *string // The IPv4 address range, in CIDR notation, of the route to be deleted. // // This member is required. DestinationCidrBlock *string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // The ID of the target subnet used by the route. TargetVpcSubnetId *string - - // The ID of the Client VPN endpoint from which the route is to be deleted. - // - // This member is required. - ClientVpnEndpointId *string } type DeleteClientVpnRouteOutput struct { diff --git a/service/ec2/api_op_DeleteFleets.go b/service/ec2/api_op_DeleteFleets.go index 0d913ce7c3d..1a1673fcf1c 100644 --- a/service/ec2/api_op_DeleteFleets.go +++ b/service/ec2/api_op_DeleteFleets.go @@ -82,12 +82,12 @@ type DeleteFleetsInput struct { type DeleteFleetsOutput struct { - // Information about the EC2 Fleets that are not successfully deleted. - UnsuccessfulFleetDeletions []*types.DeleteFleetErrorItem - // Information about the EC2 Fleets that are successfully deleted. SuccessfulFleetDeletions []*types.DeleteFleetSuccessItem + // Information about the EC2 Fleets that are not successfully deleted. + UnsuccessfulFleetDeletions []*types.DeleteFleetErrorItem + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DeleteKeyPair.go b/service/ec2/api_op_DeleteKeyPair.go index 3252701c8bf..e534c7881bd 100644 --- a/service/ec2/api_op_DeleteKeyPair.go +++ b/service/ec2/api_op_DeleteKeyPair.go @@ -55,17 +55,17 @@ func (c *Client) DeleteKeyPair(ctx context.Context, params *DeleteKeyPairInput, type DeleteKeyPairInput struct { - // The ID of the key pair. - KeyPairId *string - - // The name of the key pair. - KeyName *string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // The name of the key pair. + KeyName *string + + // The ID of the key pair. + KeyPairId *string } type DeleteKeyPairOutput struct { diff --git a/service/ec2/api_op_DeleteLaunchTemplate.go b/service/ec2/api_op_DeleteLaunchTemplate.go index 90ccac7136e..a14031f5a51 100644 --- a/service/ec2/api_op_DeleteLaunchTemplate.go +++ b/service/ec2/api_op_DeleteLaunchTemplate.go @@ -57,19 +57,19 @@ func (c *Client) DeleteLaunchTemplate(ctx context.Context, params *DeleteLaunchT type DeleteLaunchTemplateInput struct { - // The name of the launch template. You must specify either the launch template ID - // or launch template name in the request. - LaunchTemplateName *string - - // The ID of the launch template. You must specify either the launch template ID or - // launch template name in the request. - LaunchTemplateId *string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // The ID of the launch template. You must specify either the launch template ID or + // launch template name in the request. + LaunchTemplateId *string + + // The name of the launch template. You must specify either the launch template ID + // or launch template name in the request. + LaunchTemplateName *string } type DeleteLaunchTemplateOutput struct { diff --git a/service/ec2/api_op_DeleteLaunchTemplateVersions.go b/service/ec2/api_op_DeleteLaunchTemplateVersions.go index d12ba9b8dea..57ad2020096 100644 --- a/service/ec2/api_op_DeleteLaunchTemplateVersions.go +++ b/service/ec2/api_op_DeleteLaunchTemplateVersions.go @@ -60,9 +60,10 @@ func (c *Client) DeleteLaunchTemplateVersions(ctx context.Context, params *Delet type DeleteLaunchTemplateVersionsInput struct { - // The ID of the launch template. You must specify either the launch template ID or - // launch template name in the request. - LaunchTemplateId *string + // The version numbers of one or more launch template versions to delete. + // + // This member is required. + Versions []*string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the @@ -70,24 +71,23 @@ type DeleteLaunchTemplateVersionsInput struct { // UnauthorizedOperation. DryRun *bool + // The ID of the launch template. You must specify either the launch template ID or + // launch template name in the request. + LaunchTemplateId *string + // The name of the launch template. You must specify either the launch template ID // or launch template name in the request. LaunchTemplateName *string - - // The version numbers of one or more launch template versions to delete. - // - // This member is required. - Versions []*string } type DeleteLaunchTemplateVersionsOutput struct { - // Information about the launch template versions that could not be deleted. - UnsuccessfullyDeletedLaunchTemplateVersions []*types.DeleteLaunchTemplateVersionsResponseErrorItem - // Information about the launch template versions that were successfully deleted. SuccessfullyDeletedLaunchTemplateVersions []*types.DeleteLaunchTemplateVersionsResponseSuccessItem + // Information about the launch template versions that could not be deleted. + UnsuccessfullyDeletedLaunchTemplateVersions []*types.DeleteLaunchTemplateVersionsResponseErrorItem + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DeleteLocalGatewayRoute.go b/service/ec2/api_op_DeleteLocalGatewayRoute.go index 641bc2c4736..b4d20f5a3a7 100644 --- a/service/ec2/api_op_DeleteLocalGatewayRoute.go +++ b/service/ec2/api_op_DeleteLocalGatewayRoute.go @@ -57,6 +57,11 @@ func (c *Client) DeleteLocalGatewayRoute(ctx context.Context, params *DeleteLoca type DeleteLocalGatewayRouteInput struct { + // The CIDR range for the route. This must match the CIDR for the route exactly. + // + // This member is required. + DestinationCidrBlock *string + // The ID of the local gateway route table. // // This member is required. @@ -67,11 +72,6 @@ type DeleteLocalGatewayRouteInput struct { // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The CIDR range for the route. This must match the CIDR for the route exactly. - // - // This member is required. - DestinationCidrBlock *string } type DeleteLocalGatewayRouteOutput struct { diff --git a/service/ec2/api_op_DeleteNatGateway.go b/service/ec2/api_op_DeleteNatGateway.go index 63bf09c0046..7f29f384b16 100644 --- a/service/ec2/api_op_DeleteNatGateway.go +++ b/service/ec2/api_op_DeleteNatGateway.go @@ -58,16 +58,16 @@ func (c *Client) DeleteNatGateway(ctx context.Context, params *DeleteNatGatewayI type DeleteNatGatewayInput struct { + // The ID of the NAT gateway. + // + // This member is required. + NatGatewayId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The ID of the NAT gateway. - // - // This member is required. - NatGatewayId *string } type DeleteNatGatewayOutput struct { diff --git a/service/ec2/api_op_DeleteNetworkAcl.go b/service/ec2/api_op_DeleteNetworkAcl.go index 6012275afbb..25635570456 100644 --- a/service/ec2/api_op_DeleteNetworkAcl.go +++ b/service/ec2/api_op_DeleteNetworkAcl.go @@ -57,16 +57,16 @@ func (c *Client) DeleteNetworkAcl(ctx context.Context, params *DeleteNetworkAclI type DeleteNetworkAclInput struct { + // The ID of the network ACL. + // + // This member is required. + NetworkAclId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The ID of the network ACL. - // - // This member is required. - NetworkAclId *string } type DeleteNetworkAclOutput struct { diff --git a/service/ec2/api_op_DeleteNetworkAclEntry.go b/service/ec2/api_op_DeleteNetworkAclEntry.go index cc6fbafd8b1..a89a1d4fa2b 100644 --- a/service/ec2/api_op_DeleteNetworkAclEntry.go +++ b/service/ec2/api_op_DeleteNetworkAclEntry.go @@ -57,26 +57,26 @@ func (c *Client) DeleteNetworkAclEntry(ctx context.Context, params *DeleteNetwor type DeleteNetworkAclEntryInput struct { + // Indicates whether the rule is an egress rule. + // + // This member is required. + Egress *bool + // The ID of the network ACL. // // This member is required. NetworkAclId *string - // Indicates whether the rule is an egress rule. + // The rule number of the entry to delete. // // This member is required. - Egress *bool + RuleNumber *int32 // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The rule number of the entry to delete. - // - // This member is required. - RuleNumber *int32 } type DeleteNetworkAclEntryOutput struct { diff --git a/service/ec2/api_op_DeleteNetworkInterface.go b/service/ec2/api_op_DeleteNetworkInterface.go index 982e843db0a..8267bd90be0 100644 --- a/service/ec2/api_op_DeleteNetworkInterface.go +++ b/service/ec2/api_op_DeleteNetworkInterface.go @@ -58,16 +58,16 @@ func (c *Client) DeleteNetworkInterface(ctx context.Context, params *DeleteNetwo // Contains the parameters for DeleteNetworkInterface. type DeleteNetworkInterfaceInput struct { + // The ID of the network interface. + // + // This member is required. + NetworkInterfaceId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The ID of the network interface. - // - // This member is required. - NetworkInterfaceId *string } type DeleteNetworkInterfaceOutput struct { diff --git a/service/ec2/api_op_DeleteNetworkInterfacePermission.go b/service/ec2/api_op_DeleteNetworkInterfacePermission.go index 06df0d4777a..65fa6a81bea 100644 --- a/service/ec2/api_op_DeleteNetworkInterfacePermission.go +++ b/service/ec2/api_op_DeleteNetworkInterfacePermission.go @@ -65,15 +65,15 @@ type DeleteNetworkInterfacePermissionInput struct { // This member is required. NetworkInterfacePermissionId *string - // Specify true to remove the permission even if the network interface is attached - // to an instance. - Force *bool - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // Specify true to remove the permission even if the network interface is attached + // to an instance. + Force *bool } // Contains the output for DeleteNetworkInterfacePermission. diff --git a/service/ec2/api_op_DeleteQueuedReservedInstances.go b/service/ec2/api_op_DeleteQueuedReservedInstances.go index 7171ad8afde..7cbe091de2d 100644 --- a/service/ec2/api_op_DeleteQueuedReservedInstances.go +++ b/service/ec2/api_op_DeleteQueuedReservedInstances.go @@ -71,12 +71,12 @@ type DeleteQueuedReservedInstancesInput struct { type DeleteQueuedReservedInstancesOutput struct { - // Information about the queued purchases that were successfully deleted. - SuccessfulQueuedPurchaseDeletions []*types.SuccessfulQueuedPurchaseDeletion - // Information about the queued purchases that could not be deleted. FailedQueuedPurchaseDeletions []*types.FailedQueuedPurchaseDeletion + // Information about the queued purchases that were successfully deleted. + SuccessfulQueuedPurchaseDeletions []*types.SuccessfulQueuedPurchaseDeletion + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DeleteRoute.go b/service/ec2/api_op_DeleteRoute.go index caa48996321..70c7976a80e 100644 --- a/service/ec2/api_op_DeleteRoute.go +++ b/service/ec2/api_op_DeleteRoute.go @@ -56,27 +56,27 @@ func (c *Client) DeleteRoute(ctx context.Context, params *DeleteRouteInput, optF type DeleteRouteInput struct { + // The ID of the route table. + // + // This member is required. + RouteTableId *string + + // The IPv4 CIDR range for the route. The value you specify must match the CIDR for + // the route exactly. + DestinationCidrBlock *string + // The IPv6 CIDR range for the route. The value you specify must match the CIDR for // the route exactly. DestinationIpv6CidrBlock *string + // The ID of the prefix list for the route. + DestinationPrefixListId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The IPv4 CIDR range for the route. The value you specify must match the CIDR for - // the route exactly. - DestinationCidrBlock *string - - // The ID of the route table. - // - // This member is required. - RouteTableId *string - - // The ID of the prefix list for the route. - DestinationPrefixListId *string } type DeleteRouteOutput struct { diff --git a/service/ec2/api_op_DeleteSecurityGroup.go b/service/ec2/api_op_DeleteSecurityGroup.go index 3c1f66d3c3b..8e809b69409 100644 --- a/service/ec2/api_op_DeleteSecurityGroup.go +++ b/service/ec2/api_op_DeleteSecurityGroup.go @@ -58,10 +58,6 @@ func (c *Client) DeleteSecurityGroup(ctx context.Context, params *DeleteSecurity type DeleteSecurityGroupInput struct { - // [EC2-Classic, default VPC] The name of the security group. You can specify - // either the security group name or the security group ID. - GroupName *string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -70,6 +66,10 @@ type DeleteSecurityGroupInput struct { // The ID of the security group. Required for a nondefault VPC. GroupId *string + + // [EC2-Classic, default VPC] The name of the security group. You can specify + // either the security group name or the security group ID. + GroupName *string } type DeleteSecurityGroupOutput struct { diff --git a/service/ec2/api_op_DeleteSnapshot.go b/service/ec2/api_op_DeleteSnapshot.go index d10dd0637ea..d7fd855f281 100644 --- a/service/ec2/api_op_DeleteSnapshot.go +++ b/service/ec2/api_op_DeleteSnapshot.go @@ -66,16 +66,16 @@ func (c *Client) DeleteSnapshot(ctx context.Context, params *DeleteSnapshotInput type DeleteSnapshotInput struct { + // The ID of the EBS snapshot. + // + // This member is required. + SnapshotId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The ID of the EBS snapshot. - // - // This member is required. - SnapshotId *string } type DeleteSnapshotOutput struct { diff --git a/service/ec2/api_op_DeleteSubnet.go b/service/ec2/api_op_DeleteSubnet.go index f0a836c67c9..62e3017e208 100644 --- a/service/ec2/api_op_DeleteSubnet.go +++ b/service/ec2/api_op_DeleteSubnet.go @@ -57,16 +57,16 @@ func (c *Client) DeleteSubnet(ctx context.Context, params *DeleteSubnetInput, op type DeleteSubnetInput struct { + // The ID of the subnet. + // + // This member is required. + SubnetId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The ID of the subnet. - // - // This member is required. - SubnetId *string } type DeleteSubnetOutput struct { diff --git a/service/ec2/api_op_DeleteTags.go b/service/ec2/api_op_DeleteTags.go index bd4fd8d2a04..8b918bbd643 100644 --- a/service/ec2/api_op_DeleteTags.go +++ b/service/ec2/api_op_DeleteTags.go @@ -61,6 +61,12 @@ func (c *Client) DeleteTags(ctx context.Context, params *DeleteTagsInput, optFns type DeleteTagsInput struct { + // The IDs of the resources, separated by spaces. Constraints: Up to 1000 resource + // IDs. We recommend breaking up this request into smaller batches. + // + // This member is required. + Resources []*string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -74,12 +80,6 @@ type DeleteTagsInput struct { // If you omit this parameter, we delete all user-defined tags for the specified // resources. We do not delete AWS-generated tags (tags that have the aws: prefix). Tags []*types.Tag - - // The IDs of the resources, separated by spaces. Constraints: Up to 1000 resource - // IDs. We recommend breaking up this request into smaller batches. - // - // This member is required. - Resources []*string } type DeleteTagsOutput struct { diff --git a/service/ec2/api_op_DeleteTrafficMirrorFilter.go b/service/ec2/api_op_DeleteTrafficMirrorFilter.go index 6f0cf9189cb..17807b64f59 100644 --- a/service/ec2/api_op_DeleteTrafficMirrorFilter.go +++ b/service/ec2/api_op_DeleteTrafficMirrorFilter.go @@ -57,16 +57,16 @@ func (c *Client) DeleteTrafficMirrorFilter(ctx context.Context, params *DeleteTr type DeleteTrafficMirrorFilterInput struct { + // The ID of the Traffic Mirror filter. + // + // This member is required. + TrafficMirrorFilterId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The ID of the Traffic Mirror filter. - // - // This member is required. - TrafficMirrorFilterId *string } type DeleteTrafficMirrorFilterOutput struct { diff --git a/service/ec2/api_op_DeleteTrafficMirrorSession.go b/service/ec2/api_op_DeleteTrafficMirrorSession.go index 3b0c18b97d1..354b88937b0 100644 --- a/service/ec2/api_op_DeleteTrafficMirrorSession.go +++ b/service/ec2/api_op_DeleteTrafficMirrorSession.go @@ -56,16 +56,16 @@ func (c *Client) DeleteTrafficMirrorSession(ctx context.Context, params *DeleteT type DeleteTrafficMirrorSessionInput struct { + // The ID of the Traffic Mirror session. + // + // This member is required. + TrafficMirrorSessionId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The ID of the Traffic Mirror session. - // - // This member is required. - TrafficMirrorSessionId *string } type DeleteTrafficMirrorSessionOutput struct { diff --git a/service/ec2/api_op_DeleteTransitGatewayMulticastDomain.go b/service/ec2/api_op_DeleteTransitGatewayMulticastDomain.go index e44fce8164e..6ba809df0eb 100644 --- a/service/ec2/api_op_DeleteTransitGatewayMulticastDomain.go +++ b/service/ec2/api_op_DeleteTransitGatewayMulticastDomain.go @@ -57,16 +57,16 @@ func (c *Client) DeleteTransitGatewayMulticastDomain(ctx context.Context, params type DeleteTransitGatewayMulticastDomainInput struct { + // The ID of the transit gateway multicast domain. + // + // This member is required. + TransitGatewayMulticastDomainId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The ID of the transit gateway multicast domain. - // - // This member is required. - TransitGatewayMulticastDomainId *string } type DeleteTransitGatewayMulticastDomainOutput struct { diff --git a/service/ec2/api_op_DeleteTransitGatewayRoute.go b/service/ec2/api_op_DeleteTransitGatewayRoute.go index adb1659053d..852ae7271ff 100644 --- a/service/ec2/api_op_DeleteTransitGatewayRoute.go +++ b/service/ec2/api_op_DeleteTransitGatewayRoute.go @@ -62,16 +62,16 @@ type DeleteTransitGatewayRouteInput struct { // This member is required. DestinationCidrBlock *string + // The ID of the transit gateway route table. + // + // This member is required. + TransitGatewayRouteTableId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The ID of the transit gateway route table. - // - // This member is required. - TransitGatewayRouteTableId *string } type DeleteTransitGatewayRouteOutput struct { diff --git a/service/ec2/api_op_DeleteTransitGatewayRouteTable.go b/service/ec2/api_op_DeleteTransitGatewayRouteTable.go index 8c143b0be2e..5e694dfbc75 100644 --- a/service/ec2/api_op_DeleteTransitGatewayRouteTable.go +++ b/service/ec2/api_op_DeleteTransitGatewayRouteTable.go @@ -58,16 +58,16 @@ func (c *Client) DeleteTransitGatewayRouteTable(ctx context.Context, params *Del type DeleteTransitGatewayRouteTableInput struct { + // The ID of the transit gateway route table. + // + // This member is required. + TransitGatewayRouteTableId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The ID of the transit gateway route table. - // - // This member is required. - TransitGatewayRouteTableId *string } type DeleteTransitGatewayRouteTableOutput struct { diff --git a/service/ec2/api_op_DeleteVpc.go b/service/ec2/api_op_DeleteVpc.go index da4f0cab63f..dbb90c07378 100644 --- a/service/ec2/api_op_DeleteVpc.go +++ b/service/ec2/api_op_DeleteVpc.go @@ -60,16 +60,16 @@ func (c *Client) DeleteVpc(ctx context.Context, params *DeleteVpcInput, optFns . type DeleteVpcInput struct { + // The ID of the VPC. + // + // This member is required. + VpcId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The ID of the VPC. - // - // This member is required. - VpcId *string } type DeleteVpcOutput struct { diff --git a/service/ec2/api_op_DeleteVpcEndpointConnectionNotifications.go b/service/ec2/api_op_DeleteVpcEndpointConnectionNotifications.go index 41a10f5f763..86a22af2af0 100644 --- a/service/ec2/api_op_DeleteVpcEndpointConnectionNotifications.go +++ b/service/ec2/api_op_DeleteVpcEndpointConnectionNotifications.go @@ -57,16 +57,16 @@ func (c *Client) DeleteVpcEndpointConnectionNotifications(ctx context.Context, p type DeleteVpcEndpointConnectionNotificationsInput struct { + // One or more notification IDs. + // + // This member is required. + ConnectionNotificationIds []*string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // One or more notification IDs. - // - // This member is required. - ConnectionNotificationIds []*string } type DeleteVpcEndpointConnectionNotificationsOutput struct { diff --git a/service/ec2/api_op_DeleteVpcPeeringConnection.go b/service/ec2/api_op_DeleteVpcPeeringConnection.go index 1dc9b3e4d4b..161799cdca8 100644 --- a/service/ec2/api_op_DeleteVpcPeeringConnection.go +++ b/service/ec2/api_op_DeleteVpcPeeringConnection.go @@ -60,16 +60,16 @@ func (c *Client) DeleteVpcPeeringConnection(ctx context.Context, params *DeleteV type DeleteVpcPeeringConnectionInput struct { + // The ID of the VPC peering connection. + // + // This member is required. + VpcPeeringConnectionId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The ID of the VPC peering connection. - // - // This member is required. - VpcPeeringConnectionId *string } type DeleteVpcPeeringConnectionOutput struct { diff --git a/service/ec2/api_op_DeleteVpnConnectionRoute.go b/service/ec2/api_op_DeleteVpnConnectionRoute.go index 6f88f22713a..447a9c258cd 100644 --- a/service/ec2/api_op_DeleteVpnConnectionRoute.go +++ b/service/ec2/api_op_DeleteVpnConnectionRoute.go @@ -60,15 +60,15 @@ func (c *Client) DeleteVpnConnectionRoute(ctx context.Context, params *DeleteVpn // Contains the parameters for DeleteVpnConnectionRoute. type DeleteVpnConnectionRouteInput struct { - // The ID of the VPN connection. + // The CIDR block associated with the local subnet of the customer network. // // This member is required. - VpnConnectionId *string + DestinationCidrBlock *string - // The CIDR block associated with the local subnet of the customer network. + // The ID of the VPN connection. // // This member is required. - DestinationCidrBlock *string + VpnConnectionId *string } type DeleteVpnConnectionRouteOutput struct { diff --git a/service/ec2/api_op_DeregisterInstanceEventNotificationAttributes.go b/service/ec2/api_op_DeregisterInstanceEventNotificationAttributes.go index 2b6f8ff4573..f7911fc2b97 100644 --- a/service/ec2/api_op_DeregisterInstanceEventNotificationAttributes.go +++ b/service/ec2/api_op_DeregisterInstanceEventNotificationAttributes.go @@ -57,14 +57,14 @@ func (c *Client) DeregisterInstanceEventNotificationAttributes(ctx context.Conte type DeregisterInstanceEventNotificationAttributesInput struct { - // Information about the tag keys to deregister. - InstanceTagAttribute *types.DeregisterInstanceTagAttributeRequest - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // Information about the tag keys to deregister. + InstanceTagAttribute *types.DeregisterInstanceTagAttributeRequest } type DeregisterInstanceEventNotificationAttributesOutput struct { diff --git a/service/ec2/api_op_DeregisterTransitGatewayMulticastGroupSources.go b/service/ec2/api_op_DeregisterTransitGatewayMulticastGroupSources.go index b3bdcab830f..9a9015de54c 100644 --- a/service/ec2/api_op_DeregisterTransitGatewayMulticastGroupSources.go +++ b/service/ec2/api_op_DeregisterTransitGatewayMulticastGroupSources.go @@ -57,20 +57,20 @@ func (c *Client) DeregisterTransitGatewayMulticastGroupSources(ctx context.Conte type DeregisterTransitGatewayMulticastGroupSourcesInput struct { - // The IDs of the group sources' network interfaces. - NetworkInterfaceIds []*string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // The IP address assigned to the transit gateway multicast group. GroupIpAddress *string + // The IDs of the group sources' network interfaces. + NetworkInterfaceIds []*string + // The ID of the transit gateway multicast domain. TransitGatewayMulticastDomainId *string - - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool } type DeregisterTransitGatewayMulticastGroupSourcesOutput struct { diff --git a/service/ec2/api_op_DescribeAddresses.go b/service/ec2/api_op_DescribeAddresses.go index 18de81a0021..541c682036d 100644 --- a/service/ec2/api_op_DescribeAddresses.go +++ b/service/ec2/api_op_DescribeAddresses.go @@ -60,6 +60,15 @@ func (c *Client) DescribeAddresses(ctx context.Context, params *DescribeAddresse type DescribeAddressesInput struct { + // [EC2-VPC] Information about the allocation IDs. + AllocationIds []*string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // One or more filters. Filter names and values are case-sensitive. // // * @@ -101,18 +110,9 @@ type DescribeAddressesInput struct { // assigned a tag with a specific key, regardless of the tag value. Filters []*types.Filter - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // One or more Elastic IP addresses. Default: Describes all your Elastic IP // addresses. PublicIps []*string - - // [EC2-VPC] Information about the allocation IDs. - AllocationIds []*string } type DescribeAddressesOutput struct { diff --git a/service/ec2/api_op_DescribeAvailabilityZones.go b/service/ec2/api_op_DescribeAvailabilityZones.go index f71c880c759..f14f237cfd7 100644 --- a/service/ec2/api_op_DescribeAvailabilityZones.go +++ b/service/ec2/api_op_DescribeAvailabilityZones.go @@ -67,8 +67,11 @@ type DescribeAvailabilityZonesInput struct { // Regions where you have chosen the option to opt in. AllAvailabilityZones *bool - // The names of the Zones. - ZoneNames []*string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // The filters. // @@ -105,14 +108,11 @@ type DescribeAvailabilityZonesInput struct { // * zone-type - The type of zone, for example, local-zone. Filters []*types.Filter - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The IDs of the Zones. ZoneIds []*string + + // The names of the Zones. + ZoneNames []*string } type DescribeAvailabilityZonesOutput struct { diff --git a/service/ec2/api_op_DescribeByoipCidrs.go b/service/ec2/api_op_DescribeByoipCidrs.go index 0fb4442a9ae..201995acd79 100644 --- a/service/ec2/api_op_DescribeByoipCidrs.go +++ b/service/ec2/api_op_DescribeByoipCidrs.go @@ -60,6 +60,12 @@ func (c *Client) DescribeByoipCidrs(ctx context.Context, params *DescribeByoipCi type DescribeByoipCidrsInput struct { + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + // + // This member is required. + MaxResults *int32 + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -68,23 +74,17 @@ type DescribeByoipCidrsInput struct { // The token for the next page of results. NextToken *string - - // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. - // - // This member is required. - MaxResults *int32 } type DescribeByoipCidrsOutput struct { + // Information about your address ranges. + ByoipCidrs []*types.ByoipCidr + // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string - // Information about your address ranges. - ByoipCidrs []*types.ByoipCidr - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeCapacityReservations.go b/service/ec2/api_op_DescribeCapacityReservations.go index 1f21f9f405b..6aa1ed4c8f3 100644 --- a/service/ec2/api_op_DescribeCapacityReservations.go +++ b/service/ec2/api_op_DescribeCapacityReservations.go @@ -57,21 +57,15 @@ func (c *Client) DescribeCapacityReservations(ctx context.Context, params *Descr type DescribeCapacityReservationsInput struct { + // The ID of the Capacity Reservation. + CapacityReservationIds []*string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // The token to use to retrieve the next page of results. - NextToken *string - - // The maximum number of results to return for the request in a single page. The - // remaining results can be seen by sending another request with the returned - // nextToken value. This value can be between 5 and 500. If maxResults is given a - // larger value than 500, you receive an error. - MaxResults *int32 - // One or more filters. // // * instance-type - The type of instance for which the @@ -155,19 +149,25 @@ type DescribeCapacityReservationsInput struct { // that only permitted instances can use the reserved capacity. Filters []*types.Filter - // The ID of the Capacity Reservation. - CapacityReservationIds []*string + // The maximum number of results to return for the request in a single page. The + // remaining results can be seen by sending another request with the returned + // nextToken value. This value can be between 5 and 500. If maxResults is given a + // larger value than 500, you receive an error. + MaxResults *int32 + + // The token to use to retrieve the next page of results. + NextToken *string } type DescribeCapacityReservationsOutput struct { + // Information about the Capacity Reservations. + CapacityReservations []*types.CapacityReservation + // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string - // Information about the Capacity Reservations. - CapacityReservations []*types.CapacityReservation - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeClassicLinkInstances.go b/service/ec2/api_op_DescribeClassicLinkInstances.go index 97804da32ad..3d3450788a4 100644 --- a/service/ec2/api_op_DescribeClassicLinkInstances.go +++ b/service/ec2/api_op_DescribeClassicLinkInstances.go @@ -59,23 +59,12 @@ func (c *Client) DescribeClassicLinkInstances(ctx context.Context, params *Descr type DescribeClassicLinkInstancesInput struct { - // One or more instance IDs. Must be instances linked to a VPC through ClassicLink. - InstanceIds []*string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. - // Constraint: If the value is greater than 1000, we return only 1000 items. - MaxResults *int32 - - // The token for the next page of results. - NextToken *string - // One or more filters. // // * group-id - The ID of a VPC security group that's @@ -98,6 +87,17 @@ type DescribeClassicLinkInstancesInput struct { // linked.

    vpc-id - The ID of the VPC that the instance is // linked to.

    Filters []*types.Filter + + // One or more instance IDs. Must be instances linked to a VPC through ClassicLink. + InstanceIds []*string + + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + // Constraint: If the value is greater than 1000, we return only 1000 items. + MaxResults *int32 + + // The token for the next page of results. + NextToken *string } type DescribeClassicLinkInstancesOutput struct { diff --git a/service/ec2/api_op_DescribeClientVpnAuthorizationRules.go b/service/ec2/api_op_DescribeClientVpnAuthorizationRules.go index 82db8c38b1e..dfb1718d530 100644 --- a/service/ec2/api_op_DescribeClientVpnAuthorizationRules.go +++ b/service/ec2/api_op_DescribeClientVpnAuthorizationRules.go @@ -57,6 +57,17 @@ func (c *Client) DescribeClientVpnAuthorizationRules(ctx context.Context, params type DescribeClientVpnAuthorizationRulesInput struct { + // The ID of the Client VPN endpoint. + // + // This member is required. + ClientVpnEndpointId *string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // One or more filters. Filter names and values are case-sensitive. // // * @@ -70,17 +81,6 @@ type DescribeClientVpnAuthorizationRulesInput struct { // grants access. Filters []*types.Filter - // The ID of the Client VPN endpoint. - // - // This member is required. - ClientVpnEndpointId *string - - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The maximum number of results to return for the request in a single page. The // remaining results can be seen by sending another request with the nextToken // value. diff --git a/service/ec2/api_op_DescribeClientVpnConnections.go b/service/ec2/api_op_DescribeClientVpnConnections.go index 6b3ecdabda2..54e13a4c0b9 100644 --- a/service/ec2/api_op_DescribeClientVpnConnections.go +++ b/service/ec2/api_op_DescribeClientVpnConnections.go @@ -58,13 +58,10 @@ func (c *Client) DescribeClientVpnConnections(ctx context.Context, params *Descr type DescribeClientVpnConnectionsInput struct { - // The maximum number of results to return for the request in a single page. The - // remaining results can be seen by sending another request with the nextToken - // value. - MaxResults *int32 - - // The token to retrieve the next page of results. - NextToken *string + // The ID of the Client VPN endpoint. + // + // This member is required. + ClientVpnEndpointId *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the @@ -72,11 +69,6 @@ type DescribeClientVpnConnectionsInput struct { // UnauthorizedOperation. DryRun *bool - // The ID of the Client VPN endpoint. - // - // This member is required. - ClientVpnEndpointId *string - // One or more filters. Filter names and values are case-sensitive. // // * @@ -86,6 +78,14 @@ type DescribeClientVpnConnectionsInput struct { // client authentication, the user name of the client who established the client // connection. Filters []*types.Filter + + // The maximum number of results to return for the request in a single page. The + // remaining results can be seen by sending another request with the nextToken + // value. + MaxResults *int32 + + // The token to retrieve the next page of results. + NextToken *string } type DescribeClientVpnConnectionsOutput struct { diff --git a/service/ec2/api_op_DescribeClientVpnEndpoints.go b/service/ec2/api_op_DescribeClientVpnEndpoints.go index 2c707b4338e..4b064da6a4d 100644 --- a/service/ec2/api_op_DescribeClientVpnEndpoints.go +++ b/service/ec2/api_op_DescribeClientVpnEndpoints.go @@ -56,15 +56,15 @@ func (c *Client) DescribeClientVpnEndpoints(ctx context.Context, params *Describ type DescribeClientVpnEndpointsInput struct { + // The ID of the Client VPN endpoint. + ClientVpnEndpointIds []*string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // The token to retrieve the next page of results. - NextToken *string - // One or more filters. Filter names and values are case-sensitive. // // * @@ -79,8 +79,8 @@ type DescribeClientVpnEndpointsInput struct { // value. MaxResults *int32 - // The ID of the Client VPN endpoint. - ClientVpnEndpointIds []*string + // The token to retrieve the next page of results. + NextToken *string } type DescribeClientVpnEndpointsOutput struct { diff --git a/service/ec2/api_op_DescribeClientVpnRoutes.go b/service/ec2/api_op_DescribeClientVpnRoutes.go index 160c418a7c5..0f2dc67ee48 100644 --- a/service/ec2/api_op_DescribeClientVpnRoutes.go +++ b/service/ec2/api_op_DescribeClientVpnRoutes.go @@ -57,20 +57,17 @@ func (c *Client) DescribeClientVpnRoutes(ctx context.Context, params *DescribeCl type DescribeClientVpnRoutesInput struct { + // The ID of the Client VPN endpoint. + // + // This member is required. + ClientVpnEndpointId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // The token to retrieve the next page of results. - NextToken *string - - // The ID of the Client VPN endpoint. - // - // This member is required. - ClientVpnEndpointId *string - // One or more filters. Filter names and values are case-sensitive. // // * @@ -87,6 +84,9 @@ type DescribeClientVpnRoutesInput struct { // remaining results can be seen by sending another request with the nextToken // value. MaxResults *int32 + + // The token to retrieve the next page of results. + NextToken *string } type DescribeClientVpnRoutesOutput struct { diff --git a/service/ec2/api_op_DescribeClientVpnTargetNetworks.go b/service/ec2/api_op_DescribeClientVpnTargetNetworks.go index 27b81f04a11..7e8cc4b260b 100644 --- a/service/ec2/api_op_DescribeClientVpnTargetNetworks.go +++ b/service/ec2/api_op_DescribeClientVpnTargetNetworks.go @@ -57,6 +57,20 @@ func (c *Client) DescribeClientVpnTargetNetworks(ctx context.Context, params *De type DescribeClientVpnTargetNetworksInput struct { + // The ID of the Client VPN endpoint. + // + // This member is required. + ClientVpnEndpointId *string + + // The IDs of the target network associations. + AssociationIds []*string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // One or more filters. Filter names and values are case-sensitive. // // * @@ -69,38 +83,24 @@ type DescribeClientVpnTargetNetworksInput struct { // which the target network is located. Filters []*types.Filter - // The IDs of the target network associations. - AssociationIds []*string - - // The ID of the Client VPN endpoint. - // - // This member is required. - ClientVpnEndpointId *string - // The maximum number of results to return for the request in a single page. The // remaining results can be seen by sending another request with the nextToken // value. MaxResults *int32 - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The token to retrieve the next page of results. NextToken *string } type DescribeClientVpnTargetNetworksOutput struct { + // Information about the associated target networks. + ClientVpnTargetNetworks []*types.TargetNetwork + // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string - // Information about the associated target networks. - ClientVpnTargetNetworks []*types.TargetNetwork - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeCoipPools.go b/service/ec2/api_op_DescribeCoipPools.go index 087763844b2..99b7b176334 100644 --- a/service/ec2/api_op_DescribeCoipPools.go +++ b/service/ec2/api_op_DescribeCoipPools.go @@ -57,6 +57,12 @@ func (c *Client) DescribeCoipPools(ctx context.Context, params *DescribeCoipPool type DescribeCoipPoolsInput struct { + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // The filters. The following are the possible values: // // * coip-pool.pool-id @@ -65,21 +71,15 @@ type DescribeCoipPoolsInput struct { // * coip-pool.local-gateway-route-table-id Filters []*types.Filter - // The IDs of the address pools. - PoolIds []*string + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int32 // The token for the next page of results. NextToken *string - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - - // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. - MaxResults *int32 + // The IDs of the address pools. + PoolIds []*string } type DescribeCoipPoolsOutput struct { diff --git a/service/ec2/api_op_DescribeConversionTasks.go b/service/ec2/api_op_DescribeConversionTasks.go index 3a5399f611d..30af292f3f4 100644 --- a/service/ec2/api_op_DescribeConversionTasks.go +++ b/service/ec2/api_op_DescribeConversionTasks.go @@ -60,14 +60,14 @@ func (c *Client) DescribeConversionTasks(ctx context.Context, params *DescribeCo type DescribeConversionTasksInput struct { + // The conversion task IDs. + ConversionTaskIds []*string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The conversion task IDs. - ConversionTaskIds []*string } type DescribeConversionTasksOutput struct { diff --git a/service/ec2/api_op_DescribeCustomerGateways.go b/service/ec2/api_op_DescribeCustomerGateways.go index bb488797a61..af3ba3d443d 100644 --- a/service/ec2/api_op_DescribeCustomerGateways.go +++ b/service/ec2/api_op_DescribeCustomerGateways.go @@ -60,15 +60,15 @@ func (c *Client) DescribeCustomerGateways(ctx context.Context, params *DescribeC // Contains the parameters for DescribeCustomerGateways. type DescribeCustomerGatewaysInput struct { + // One or more customer gateway IDs. Default: Describes all your customer gateways. + CustomerGatewayIds []*string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // One or more customer gateway IDs. Default: Describes all your customer gateways. - CustomerGatewayIds []*string - // One or more filters. // // * bgp-asn - The customer gateway's Border Gateway diff --git a/service/ec2/api_op_DescribeDhcpOptions.go b/service/ec2/api_op_DescribeDhcpOptions.go index 791e2aea23b..c41a33a5e68 100644 --- a/service/ec2/api_op_DescribeDhcpOptions.go +++ b/service/ec2/api_op_DescribeDhcpOptions.go @@ -59,13 +59,16 @@ func (c *Client) DescribeDhcpOptions(ctx context.Context, params *DescribeDhcpOp type DescribeDhcpOptionsInput struct { - // The token for the next page of results. - NextToken *string - // The IDs of one or more DHCP options sets. Default: Describes all your DHCP // options sets. DhcpOptionsIds []*string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // One or more filters. // // * dhcp-options-id - The ID of a DHCP options set. @@ -90,26 +93,23 @@ type DescribeDhcpOptionsInput struct { // key, regardless of the tag value. Filters []*types.Filter - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. MaxResults *int32 + + // The token for the next page of results. + NextToken *string } type DescribeDhcpOptionsOutput struct { + // Information about one or more DHCP options sets. + DhcpOptions []*types.DhcpOptions + // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string - // Information about one or more DHCP options sets. - DhcpOptions []*types.DhcpOptions - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeEgressOnlyInternetGateways.go b/service/ec2/api_op_DescribeEgressOnlyInternetGateways.go index aebb92844c2..e006329b775 100644 --- a/service/ec2/api_op_DescribeEgressOnlyInternetGateways.go +++ b/service/ec2/api_op_DescribeEgressOnlyInternetGateways.go @@ -56,9 +56,14 @@ func (c *Client) DescribeEgressOnlyInternetGateways(ctx context.Context, params type DescribeEgressOnlyInternetGatewaysInput struct { - // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. - MaxResults *int32 + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + + // One or more egress-only internet gateway IDs. + EgressOnlyInternetGatewayIds []*string // One or more filters. // @@ -73,28 +78,23 @@ type DescribeEgressOnlyInternetGatewaysInput struct { // regardless of the tag value. Filters []*types.Filter - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int32 // The token for the next page of results. NextToken *string - - // One or more egress-only internet gateway IDs. - EgressOnlyInternetGatewayIds []*string } type DescribeEgressOnlyInternetGatewaysOutput struct { + // Information about the egress-only internet gateways. + EgressOnlyInternetGateways []*types.EgressOnlyInternetGateway + // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string - // Information about the egress-only internet gateways. - EgressOnlyInternetGateways []*types.EgressOnlyInternetGateway - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeElasticGpus.go b/service/ec2/api_op_DescribeElasticGpus.go index b1b3504d386..161cf2ad9b4 100644 --- a/service/ec2/api_op_DescribeElasticGpus.go +++ b/service/ec2/api_op_DescribeElasticGpus.go @@ -58,14 +58,15 @@ func (c *Client) DescribeElasticGpus(ctx context.Context, params *DescribeElasti type DescribeElasticGpusInput struct { + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // The Elastic Graphics accelerator IDs. ElasticGpuIds []*string - // The maximum number of results to return in a single call. To retrieve the - // remaining results, make another call with the returned NextToken value. This - // value can be between 5 and 1000. - MaxResults *int32 - // The filters. // // * availability-zone - The Availability Zone in which the @@ -85,18 +86,20 @@ type DescribeElasticGpusInput struct { // is associated. Filters []*types.Filter + // The maximum number of results to return in a single call. To retrieve the + // remaining results, make another call with the returned NextToken value. This + // value can be between 5 and 1000. + MaxResults *int32 + // The token to request the next page of results. NextToken *string - - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool } type DescribeElasticGpusOutput struct { + // Information about the Elastic Graphics accelerators. + ElasticGpuSet []*types.ElasticGpus + // The total number of items to return. If the total number of items available is // more than the value specified in max-items then a Next-Token will be provided in // the output that you can use to resume pagination. @@ -106,9 +109,6 @@ type DescribeElasticGpusOutput struct { // there are no more results to return. NextToken *string - // Information about the Elastic Graphics accelerators. - ElasticGpuSet []*types.ElasticGpus - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeExportImageTasks.go b/service/ec2/api_op_DescribeExportImageTasks.go index 5c0a886098c..f1fb57f74d4 100644 --- a/service/ec2/api_op_DescribeExportImageTasks.go +++ b/service/ec2/api_op_DescribeExportImageTasks.go @@ -56,9 +56,6 @@ func (c *Client) DescribeExportImageTasks(ctx context.Context, params *DescribeE type DescribeExportImageTasksInput struct { - // A token that indicates the next page of results. - NextToken *string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -68,12 +65,15 @@ type DescribeExportImageTasksInput struct { // The IDs of the export image tasks. ExportImageTaskIds []*string - // The maximum number of results to return in a single call. - MaxResults *int32 - // Filter tasks using the task-state filter and one of the following values: // active, completed, deleting, or deleted. Filters []*types.Filter + + // The maximum number of results to return in a single call. + MaxResults *int32 + + // A token that indicates the next page of results. + NextToken *string } type DescribeExportImageTasksOutput struct { diff --git a/service/ec2/api_op_DescribeExportTasks.go b/service/ec2/api_op_DescribeExportTasks.go index dac2a54d743..d666b75e54e 100644 --- a/service/ec2/api_op_DescribeExportTasks.go +++ b/service/ec2/api_op_DescribeExportTasks.go @@ -57,11 +57,11 @@ func (c *Client) DescribeExportTasks(ctx context.Context, params *DescribeExport type DescribeExportTasksInput struct { - // the filters for the export tasks. - Filters []*types.Filter - // The export task IDs. ExportTaskIds []*string + + // the filters for the export tasks. + Filters []*types.Filter } type DescribeExportTasksOutput struct { diff --git a/service/ec2/api_op_DescribeFastSnapshotRestores.go b/service/ec2/api_op_DescribeFastSnapshotRestores.go index 1b31ea8e6cd..cdeadf9cc8a 100644 --- a/service/ec2/api_op_DescribeFastSnapshotRestores.go +++ b/service/ec2/api_op_DescribeFastSnapshotRestores.go @@ -56,6 +56,12 @@ func (c *Client) DescribeFastSnapshotRestores(ctx context.Context, params *Descr type DescribeFastSnapshotRestoresInput struct { + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // The filters. The possible values are: // // * availability-zone: The Availability @@ -71,29 +77,23 @@ type DescribeFastSnapshotRestoresInput struct { // (enabling | optimizing | enabled | disabling | disabled). Filters []*types.Filter - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - - // The token for the next page of results. - NextToken *string - // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. MaxResults *int32 + + // The token for the next page of results. + NextToken *string } type DescribeFastSnapshotRestoresOutput struct { + // Information about the state of fast snapshot restores. + FastSnapshotRestores []*types.DescribeFastSnapshotRestoreSuccessItem + // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string - // Information about the state of fast snapshot restores. - FastSnapshotRestores []*types.DescribeFastSnapshotRestoreSuccessItem - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeFleetHistory.go b/service/ec2/api_op_DescribeFleetHistory.go index 780fc1423ef..cba962d526b 100644 --- a/service/ec2/api_op_DescribeFleetHistory.go +++ b/service/ec2/api_op_DescribeFleetHistory.go @@ -66,10 +66,11 @@ type DescribeFleetHistoryInput struct { // This member is required. FleetId *string - // The maximum number of results to return in a single call. Specify a value - // between 1 and 1000. The default value is 1000. To retrieve the remaining - // results, make another call with the returned NextToken value. - MaxResults *int32 + // The start date and time for the events, in UTC format (for example, + // YYYY-MM-DDTHH:MM:SSZ). + // + // This member is required. + StartTime *time.Time // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the @@ -77,28 +78,26 @@ type DescribeFleetHistoryInput struct { // UnauthorizedOperation. DryRun *bool - // The start date and time for the events, in UTC format (for example, - // YYYY-MM-DDTHH:MM:SSZ). - // - // This member is required. - StartTime *time.Time - // The type of events to describe. By default, all events are described. EventType types.FleetEventType + // The maximum number of results to return in a single call. Specify a value + // between 1 and 1000. The default value is 1000. To retrieve the remaining + // results, make another call with the returned NextToken value. + MaxResults *int32 + // The token for the next set of results. NextToken *string } type DescribeFleetHistoryOutput struct { + // The ID of the EC Fleet. + FleetId *string + // Information about the events in the history of the EC2 Fleet. HistoryRecords []*types.HistoryRecordEntry - // The start date and time for the events, in UTC format (for example, - // YYYY-MM-DDTHH:MM:SSZ). - StartTime *time.Time - // The last date and time for the events, in UTC format (for example, // YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved. If nextToken // indicates that there are more results, this value is not present. @@ -107,8 +106,9 @@ type DescribeFleetHistoryOutput struct { // The token for the next set of results. NextToken *string - // The ID of the EC Fleet. - FleetId *string + // The start date and time for the events, in UTC format (for example, + // YYYY-MM-DDTHH:MM:SSZ). + StartTime *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/ec2/api_op_DescribeFleetInstances.go b/service/ec2/api_op_DescribeFleetInstances.go index a92f3cea935..45ec54500f7 100644 --- a/service/ec2/api_op_DescribeFleetInstances.go +++ b/service/ec2/api_op_DescribeFleetInstances.go @@ -57,11 +57,6 @@ func (c *Client) DescribeFleetInstances(ctx context.Context, params *DescribeFle type DescribeFleetInstancesInput struct { - // The filters. - // - // * instance-type - The instance type. - Filters []*types.Filter - // The ID of the EC2 Fleet. // // This member is required. @@ -73,6 +68,11 @@ type DescribeFleetInstancesInput struct { // UnauthorizedOperation. DryRun *bool + // The filters. + // + // * instance-type - The instance type. + Filters []*types.Filter + // The maximum number of results to return in a single call. Specify a value // between 1 and 1000. The default value is 1000. To retrieve the remaining // results, make another call with the returned NextToken value. @@ -88,12 +88,12 @@ type DescribeFleetInstancesOutput struct { // date. ActiveInstances []*types.ActiveInstance - // The token for the next set of results. - NextToken *string - // The ID of the EC2 Fleet. FleetId *string + // The token for the next set of results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeFleets.go b/service/ec2/api_op_DescribeFleets.go index 71ae5986fea..7418297593a 100644 --- a/service/ec2/api_op_DescribeFleets.go +++ b/service/ec2/api_op_DescribeFleets.go @@ -56,6 +56,12 @@ func (c *Client) DescribeFleets(ctx context.Context, params *DescribeFleetsInput type DescribeFleetsInput struct { + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // The filters. // // * activity-status - The progress of the EC2 Fleet ( error | @@ -77,6 +83,9 @@ type DescribeFleetsInput struct { // request (instant | request | maintain). Filters []*types.Filter + // The ID of the EC2 Fleets. + FleetIds []*string + // The maximum number of results to return in a single call. Specify a value // between 1 and 1000. The default value is 1000. To retrieve the remaining // results, make another call with the returned NextToken value. @@ -84,15 +93,6 @@ type DescribeFleetsInput struct { // The token for the next set of results. NextToken *string - - // The ID of the EC2 Fleets. - FleetIds []*string - - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool } type DescribeFleetsOutput struct { diff --git a/service/ec2/api_op_DescribeFlowLogs.go b/service/ec2/api_op_DescribeFlowLogs.go index 6b6bcd1b7e6..2bf2555647c 100644 --- a/service/ec2/api_op_DescribeFlowLogs.go +++ b/service/ec2/api_op_DescribeFlowLogs.go @@ -58,16 +58,6 @@ func (c *Client) DescribeFlowLogs(ctx context.Context, params *DescribeFlowLogsI type DescribeFlowLogsInput struct { - // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. - MaxResults *int32 - - // One or more flow log IDs. Constraint: Maximum of 1000 flow log IDs. - FlowLogIds []*string - - // The token for the next page of results. - NextToken *string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -104,6 +94,16 @@ type DescribeFlowLogsInput struct { // resource. Use this filter to find all resources assigned a tag with a specific // key, regardless of the tag value. Filter []*types.Filter + + // One or more flow log IDs. Constraint: Maximum of 1000 flow log IDs. + FlowLogIds []*string + + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int32 + + // The token for the next page of results. + NextToken *string } type DescribeFlowLogsOutput struct { diff --git a/service/ec2/api_op_DescribeFpgaImageAttribute.go b/service/ec2/api_op_DescribeFpgaImageAttribute.go index a7697e396ad..22715bc3646 100644 --- a/service/ec2/api_op_DescribeFpgaImageAttribute.go +++ b/service/ec2/api_op_DescribeFpgaImageAttribute.go @@ -57,21 +57,21 @@ func (c *Client) DescribeFpgaImageAttribute(ctx context.Context, params *Describ type DescribeFpgaImageAttributeInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The AFI attribute. + // + // This member is required. + Attribute types.FpgaImageAttributeName // The ID of the AFI. // // This member is required. FpgaImageId *string - // The AFI attribute. - // - // This member is required. - Attribute types.FpgaImageAttributeName + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool } type DescribeFpgaImageAttributeOutput struct { diff --git a/service/ec2/api_op_DescribeFpgaImages.go b/service/ec2/api_op_DescribeFpgaImages.go index 2764e3cb4f9..e32ed4f1849 100644 --- a/service/ec2/api_op_DescribeFpgaImages.go +++ b/service/ec2/api_op_DescribeFpgaImages.go @@ -58,10 +58,11 @@ func (c *Client) DescribeFpgaImages(ctx context.Context, params *DescribeFpgaIma type DescribeFpgaImagesInput struct { - // Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender - // of the request), or an AWS owner alias (valid values are amazon | - // aws-marketplace). - Owners []*string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // The filters. // @@ -101,31 +102,30 @@ type DescribeFpgaImagesInput struct { // most recent update. Filters []*types.Filter - // The token to retrieve the next page of results. - NextToken *string + // The AFI IDs. + FpgaImageIds []*string // The maximum number of results to return in a single call. MaxResults *int32 - // The AFI IDs. - FpgaImageIds []*string + // The token to retrieve the next page of results. + NextToken *string - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender + // of the request), or an AWS owner alias (valid values are amazon | + // aws-marketplace). + Owners []*string } type DescribeFpgaImagesOutput struct { + // Information about the FPGA images. + FpgaImages []*types.FpgaImage + // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string - // Information about the FPGA images. - FpgaImages []*types.FpgaImage - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeHostReservationOfferings.go b/service/ec2/api_op_DescribeHostReservationOfferings.go index ac588dcd355..683df733a9f 100644 --- a/service/ec2/api_op_DescribeHostReservationOfferings.go +++ b/service/ec2/api_op_DescribeHostReservationOfferings.go @@ -64,6 +64,15 @@ func (c *Client) DescribeHostReservationOfferings(ctx context.Context, params *D type DescribeHostReservationOfferingsInput struct { + // The filters. + // + // * instance-family - The instance family of the offering (for + // example, m4). + // + // * payment-option - The payment option (NoUpfront | + // PartialUpfront | AllUpfront). + Filter []*types.Filter + // This is the maximum duration of the reservation to purchase, specified in // seconds. Reservations are available in one-year and three-year terms. The number // of seconds specified must be the number of seconds in a year (365x24x60x60) @@ -71,33 +80,24 @@ type DescribeHostReservationOfferingsInput struct { // three years. MaxDuration *int32 - // The token to use to retrieve the next page of results. - NextToken *string - - // The ID of the reservation offering. - OfferingId *string - // The maximum number of results to return for the request in a single page. The // remaining results can be seen by sending another request with the returned // nextToken value. This value can be between 5 and 500. If maxResults is given a // larger value than 500, you receive an error. MaxResults *int32 - // The filters. - // - // * instance-family - The instance family of the offering (for - // example, m4). - // - // * payment-option - The payment option (NoUpfront | - // PartialUpfront | AllUpfront). - Filter []*types.Filter - // This is the minimum duration of the reservation you'd like to purchase, // specified in seconds. Reservations are available in one-year and three-year // terms. The number of seconds specified must be the number of seconds in a year // (365x24x60x60) times one of the supported durations (1 or 3). For example, // specify 31536000 for one year. MinDuration *int32 + + // The token to use to retrieve the next page of results. + NextToken *string + + // The ID of the reservation offering. + OfferingId *string } type DescribeHostReservationOfferingsOutput struct { diff --git a/service/ec2/api_op_DescribeHosts.go b/service/ec2/api_op_DescribeHosts.go index 15ea47a4962..ee0621b1915 100644 --- a/service/ec2/api_op_DescribeHosts.go +++ b/service/ec2/api_op_DescribeHosts.go @@ -59,9 +59,6 @@ func (c *Client) DescribeHosts(ctx context.Context, params *DescribeHostsInput, type DescribeHostsInput struct { - // The token to use to retrieve the next page of results. - NextToken *string - // The filters. // // * auto-placement - Whether auto-placement is enabled or @@ -88,6 +85,9 @@ type DescribeHostsInput struct { // key, regardless of the tag value. Filter []*types.Filter + // The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches. + HostIds []*string + // The maximum number of results to return for the request in a single page. The // remaining results can be seen by sending another request with the returned // nextToken value. This value can be between 5 and 500. If maxResults is given a @@ -95,8 +95,8 @@ type DescribeHostsInput struct { // and the host IDs parameter in the same request. MaxResults *int32 - // The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches. - HostIds []*string + // The token to use to retrieve the next page of results. + NextToken *string } type DescribeHostsOutput struct { diff --git a/service/ec2/api_op_DescribeIamInstanceProfileAssociations.go b/service/ec2/api_op_DescribeIamInstanceProfileAssociations.go index 565606dd164..7f22412ee0f 100644 --- a/service/ec2/api_op_DescribeIamInstanceProfileAssociations.go +++ b/service/ec2/api_op_DescribeIamInstanceProfileAssociations.go @@ -59,13 +59,6 @@ type DescribeIamInstanceProfileAssociationsInput struct { // The IAM instance profile associations. AssociationIds []*string - // The maximum number of results to return in a single call. To retrieve the - // remaining results, make another call with the returned NextToken value. - MaxResults *int32 - - // The token to request the next page of results. - NextToken *string - // The filters. // // * instance-id - The ID of the instance. @@ -73,6 +66,13 @@ type DescribeIamInstanceProfileAssociationsInput struct { // * state - The // state of the association (associating | associated | disassociating). Filters []*types.Filter + + // The maximum number of results to return in a single call. To retrieve the + // remaining results, make another call with the returned NextToken value. + MaxResults *int32 + + // The token to request the next page of results. + NextToken *string } type DescribeIamInstanceProfileAssociationsOutput struct { diff --git a/service/ec2/api_op_DescribeIdentityIdFormat.go b/service/ec2/api_op_DescribeIdentityIdFormat.go index b9dd99dcd82..e0712770ce9 100644 --- a/service/ec2/api_op_DescribeIdentityIdFormat.go +++ b/service/ec2/api_op_DescribeIdentityIdFormat.go @@ -72,6 +72,11 @@ func (c *Client) DescribeIdentityIdFormat(ctx context.Context, params *DescribeI type DescribeIdentityIdFormatInput struct { + // The ARN of the principal, which can be an IAM role, IAM user, or the root user. + // + // This member is required. + PrincipalArn *string + // The type of resource: bundle | conversion-task | customer-gateway | dhcp-options // | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | // image | import-task | instance | internet-gateway | network-acl | @@ -81,11 +86,6 @@ type DescribeIdentityIdFormatInput struct { // vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | // vpn-connection | vpn-gateway Resource *string - - // The ARN of the principal, which can be an IAM role, IAM user, or the root user. - // - // This member is required. - PrincipalArn *string } type DescribeIdentityIdFormatOutput struct { diff --git a/service/ec2/api_op_DescribeImageAttribute.go b/service/ec2/api_op_DescribeImageAttribute.go index 2a231b6754a..16f6c89f947 100644 --- a/service/ec2/api_op_DescribeImageAttribute.go +++ b/service/ec2/api_op_DescribeImageAttribute.go @@ -59,17 +59,6 @@ func (c *Client) DescribeImageAttribute(ctx context.Context, params *DescribeIma // Contains the parameters for DescribeImageAttribute. type DescribeImageAttributeInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - - // The ID of the AMI. - // - // This member is required. - ImageId *string - // The AMI attribute. Note: Depending on your account privileges, the // blockDeviceMapping attribute may return a Client.AuthFailure error. If this // happens, use DescribeImages () to get information about the block device mapping @@ -77,36 +66,47 @@ type DescribeImageAttributeInput struct { // // This member is required. Attribute types.ImageAttributeName + + // The ID of the AMI. + // + // This member is required. + ImageId *string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool } // Describes an image attribute. type DescribeImageAttributeOutput struct { - // The RAM disk ID. - RamdiskId *types.AttributeValue - - // The kernel ID. - KernelId *types.AttributeValue - - // The ID of the AMI. - ImageId *string - // The block device mapping entries. BlockDeviceMappings []*types.BlockDeviceMapping - // Indicates whether enhanced networking with the Intel 82599 Virtual Function - // interface is enabled. - SriovNetSupport *types.AttributeValue - // A description for the AMI. Description *types.AttributeValue + // The ID of the AMI. + ImageId *string + + // The kernel ID. + KernelId *types.AttributeValue + // The launch permissions. LaunchPermissions []*types.LaunchPermission // The product codes. ProductCodes []*types.ProductCode + // The RAM disk ID. + RamdiskId *types.AttributeValue + + // Indicates whether enhanced networking with the Intel 82599 Virtual Function + // interface is enabled. + SriovNetSupport *types.AttributeValue + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeImages.go b/service/ec2/api_op_DescribeImages.go index 95f69611670..7d44394c797 100644 --- a/service/ec2/api_op_DescribeImages.go +++ b/service/ec2/api_op_DescribeImages.go @@ -63,21 +63,16 @@ func (c *Client) DescribeImages(ctx context.Context, params *DescribeImagesInput type DescribeImagesInput struct { - // Scopes the results to images with the specified owners. You can specify a - // combination of AWS account IDs, self, amazon, and aws-marketplace. If you omit - // this parameter, the results include all images for which you have launch - // permissions, regardless of ownership. - Owners []*string - - // The image IDs. Default: Describes all images available to you. - ImageIds []*string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + // Scopes the images by users with explicit launch permissions. Specify an AWS + // account ID, self (the sender of the request), or all (public AMIs). + ExecutableUsers []*string + // The filters. // // * architecture - The image architecture (i386 | x86_64 | @@ -181,9 +176,14 @@ type DescribeImagesInput struct { // virtualization-type - The virtualization type (paravirtual | hvm). Filters []*types.Filter - // Scopes the images by users with explicit launch permissions. Specify an AWS - // account ID, self (the sender of the request), or all (public AMIs). - ExecutableUsers []*string + // The image IDs. Default: Describes all images available to you. + ImageIds []*string + + // Scopes the results to images with the specified owners. You can specify a + // combination of AWS account IDs, self, amazon, and aws-marketplace. If you omit + // this parameter, the results include all images for which you have launch + // permissions, regardless of ownership. + Owners []*string } type DescribeImagesOutput struct { diff --git a/service/ec2/api_op_DescribeImportImageTasks.go b/service/ec2/api_op_DescribeImportImageTasks.go index 09a0d2e1ac7..8e629e03d82 100644 --- a/service/ec2/api_op_DescribeImportImageTasks.go +++ b/service/ec2/api_op_DescribeImportImageTasks.go @@ -57,15 +57,6 @@ func (c *Client) DescribeImportImageTasks(ctx context.Context, params *DescribeI type DescribeImportImageTasksInput struct { - // A token that indicates the next page of results. - NextToken *string - - // The IDs of the import image tasks. - ImportTaskIds []*string - - // The maximum number of results to return in a single call. - MaxResults *int32 - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -75,6 +66,15 @@ type DescribeImportImageTasksInput struct { // Filter tasks using the task-state filter and one of the following values: // active, completed, deleting, or deleted. Filters []*types.Filter + + // The IDs of the import image tasks. + ImportTaskIds []*string + + // The maximum number of results to return in a single call. + MaxResults *int32 + + // A token that indicates the next page of results. + NextToken *string } type DescribeImportImageTasksOutput struct { diff --git a/service/ec2/api_op_DescribeImportSnapshotTasks.go b/service/ec2/api_op_DescribeImportSnapshotTasks.go index 2c8f529e831..ad12230563f 100644 --- a/service/ec2/api_op_DescribeImportSnapshotTasks.go +++ b/service/ec2/api_op_DescribeImportSnapshotTasks.go @@ -56,36 +56,36 @@ func (c *Client) DescribeImportSnapshotTasks(ctx context.Context, params *Descri type DescribeImportSnapshotTasksInput struct { - // A list of import snapshot task IDs. - ImportTaskIds []*string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // The filters. Filters []*types.Filter - // A token that indicates the next page of results. - NextToken *string + // A list of import snapshot task IDs. + ImportTaskIds []*string // The maximum number of results to return in a single call. To retrieve the // remaining results, make another call with the returned NextToken value. MaxResults *int32 - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // A token that indicates the next page of results. + NextToken *string } type DescribeImportSnapshotTasksOutput struct { - // The token to use to get the next page of results. This value is null when there - // are no more results to return. - NextToken *string - // A list of zero or more import snapshot tasks that are currently active or were // completed or canceled in the previous 7 days. ImportSnapshotTasks []*types.ImportSnapshotTask + // The token to use to get the next page of results. This value is null when there + // are no more results to return. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeInstanceAttribute.go b/service/ec2/api_op_DescribeInstanceAttribute.go index 103a481dc36..f7560c8a192 100644 --- a/service/ec2/api_op_DescribeInstanceAttribute.go +++ b/service/ec2/api_op_DescribeInstanceAttribute.go @@ -67,70 +67,70 @@ type DescribeInstanceAttributeInput struct { // This member is required. Attribute types.InstanceAttributeName + // The ID of the instance. + // + // This member is required. + InstanceId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The ID of the instance. - // - // This member is required. - InstanceId *string } // Describes an instance attribute. type DescribeInstanceAttributeOutput struct { - // The security groups associated with the instance. - Groups []*types.GroupIdentifier + // The block device mapping of the instance. + BlockDeviceMappings []*types.InstanceBlockDeviceMapping // If the value is true, you can't terminate the instance through the Amazon EC2 // console, CLI, or API; otherwise, you can. DisableApiTermination *types.AttributeBooleanValue - // Indicates whether an instance stops or terminates when you initiate shutdown - // from the instance (using the operating system command for system shutdown). - InstanceInitiatedShutdownBehavior *types.AttributeValue - - // Indicates whether enhanced networking with the Intel 82599 Virtual Function - // interface is enabled. - SriovNetSupport *types.AttributeValue + // Indicates whether the instance is optimized for Amazon EBS I/O. + EbsOptimized *types.AttributeBooleanValue - // A list of product codes. - ProductCodes []*types.ProductCode + // Indicates whether enhanced networking with ENA is enabled. + EnaSupport *types.AttributeBooleanValue - // The device name of the root device volume (for example, /dev/sda1). - RootDeviceName *types.AttributeValue + // The security groups associated with the instance. + Groups []*types.GroupIdentifier - // Indicates whether the instance is optimized for Amazon EBS I/O. - EbsOptimized *types.AttributeBooleanValue + // The ID of the instance. + InstanceId *string - // The RAM disk ID. - RamdiskId *types.AttributeValue + // Indicates whether an instance stops or terminates when you initiate shutdown + // from the instance (using the operating system command for system shutdown). + InstanceInitiatedShutdownBehavior *types.AttributeValue // The instance type. InstanceType *types.AttributeValue - // The user data. - UserData *types.AttributeValue + // The kernel ID. + KernelId *types.AttributeValue - // The block device mapping of the instance. - BlockDeviceMappings []*types.InstanceBlockDeviceMapping + // A list of product codes. + ProductCodes []*types.ProductCode - // Indicates whether enhanced networking with ENA is enabled. - EnaSupport *types.AttributeBooleanValue + // The RAM disk ID. + RamdiskId *types.AttributeValue - // The ID of the instance. - InstanceId *string + // The device name of the root device volume (for example, /dev/sda1). + RootDeviceName *types.AttributeValue // Indicates whether source/destination checking is enabled. A value of true means // that checking is enabled, and false means that checking is disabled. This value // must be false for a NAT instance to perform NAT. SourceDestCheck *types.AttributeBooleanValue - // The kernel ID. - KernelId *types.AttributeValue + // Indicates whether enhanced networking with the Intel 82599 Virtual Function + // interface is enabled. + SriovNetSupport *types.AttributeValue + + // The user data. + UserData *types.AttributeValue // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/ec2/api_op_DescribeInstanceCreditSpecifications.go b/service/ec2/api_op_DescribeInstanceCreditSpecifications.go index e7a0a375dcc..5febffd8b3b 100644 --- a/service/ec2/api_op_DescribeInstanceCreditSpecifications.go +++ b/service/ec2/api_op_DescribeInstanceCreditSpecifications.go @@ -73,29 +73,29 @@ func (c *Client) DescribeInstanceCreditSpecifications(ctx context.Context, param type DescribeInstanceCreditSpecificationsInput struct { - // The filters. - // - // * instance-id - The ID of the instance. - Filters []*types.Filter - - // The token to retrieve the next page of results. - NextToken *string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + // The filters. + // + // * instance-id - The ID of the instance. + Filters []*types.Filter + + // The instance IDs. Default: Describes all your instances. Constraints: Maximum + // 1000 explicitly specified instance IDs. + InstanceIds []*string + // The maximum number of results to return in a single call. To retrieve the // remaining results, make another call with the returned NextToken value. This // value can be between 5 and 1000. You cannot specify this parameter and the // instance IDs parameter in the same call. MaxResults *int32 - // The instance IDs. Default: Describes all your instances. Constraints: Maximum - // 1000 explicitly specified instance IDs. - InstanceIds []*string + // The token to retrieve the next page of results. + NextToken *string } type DescribeInstanceCreditSpecificationsOutput struct { diff --git a/service/ec2/api_op_DescribeInstanceStatus.go b/service/ec2/api_op_DescribeInstanceStatus.go index 69bb1771d67..9c3ab501e63 100644 --- a/service/ec2/api_op_DescribeInstanceStatus.go +++ b/service/ec2/api_op_DescribeInstanceStatus.go @@ -80,6 +80,12 @@ func (c *Client) DescribeInstanceStatus(ctx context.Context, params *DescribeIns type DescribeInstanceStatusInput struct { + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // The filters. // // * availability-zone - The Availability Zone of the instance. @@ -131,18 +137,13 @@ type DescribeInstanceStatusInput struct { // initializing | insufficient-data | not-applicable). Filters []*types.Filter - // The token to retrieve the next page of results. - NextToken *string - // When true, includes the health status for all instances. When false, includes // the health status for running instances only. Default: false IncludeAllInstances *bool - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The instance IDs. Default: Describes all your instances. Constraints: Maximum + // 100 explicitly specified instance IDs. + InstanceIds []*string // The maximum number of results to return in a single call. To retrieve the // remaining results, make another call with the returned NextToken value. This @@ -150,20 +151,19 @@ type DescribeInstanceStatusInput struct { // instance IDs parameter in the same call. MaxResults *int32 - // The instance IDs. Default: Describes all your instances. Constraints: Maximum - // 100 explicitly specified instance IDs. - InstanceIds []*string + // The token to retrieve the next page of results. + NextToken *string } type DescribeInstanceStatusOutput struct { + // Information about the status of the instances. + InstanceStatuses []*types.InstanceStatus + // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string - // Information about the status of the instances. - InstanceStatuses []*types.InstanceStatus - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeInstanceTypeOfferings.go b/service/ec2/api_op_DescribeInstanceTypeOfferings.go index 7db3aa8a12a..63945cb6b20 100644 --- a/service/ec2/api_op_DescribeInstanceTypeOfferings.go +++ b/service/ec2/api_op_DescribeInstanceTypeOfferings.go @@ -58,10 +58,11 @@ func (c *Client) DescribeInstanceTypeOfferings(ctx context.Context, params *Desc type DescribeInstanceTypeOfferingsInput struct { - // The maximum number of results to return for the request in a single page. The - // remaining results can be seen by sending another request with the next token - // value. - MaxResults *int32 + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // One or more filters. Filter names and values are case-sensitive. // @@ -76,11 +77,10 @@ type DescribeInstanceTypeOfferingsInput struct { // The location type. LocationType types.LocationType - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The maximum number of results to return for the request in a single page. The + // remaining results can be seen by sending another request with the next token + // value. + MaxResults *int32 // The token to retrieve the next page of results. NextToken *string @@ -88,13 +88,13 @@ type DescribeInstanceTypeOfferingsInput struct { type DescribeInstanceTypeOfferingsOutput struct { + // The instance types offered. + InstanceTypeOfferings []*types.InstanceTypeOffering + // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string - // The instance types offered. - InstanceTypeOfferings []*types.InstanceTypeOffering - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeInstanceTypes.go b/service/ec2/api_op_DescribeInstanceTypes.go index f454636da0d..7b1234c6a0c 100644 --- a/service/ec2/api_op_DescribeInstanceTypes.go +++ b/service/ec2/api_op_DescribeInstanceTypes.go @@ -57,18 +57,11 @@ func (c *Client) DescribeInstanceTypes(ctx context.Context, params *DescribeInst type DescribeInstanceTypesInput struct { - // The maximum number of results to return for the request in a single page. The - // remaining results can be seen by sending another request with the next token - // value. - MaxResults *int32 - - // The token to retrieve the next page of results. - NextToken *string - - // The instance types. For more information, see Instance Types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the - // Amazon Elastic Compute Cloud User Guide. - InstanceTypes []types.InstanceType + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // One or more filters. Filter names and values are case-sensitive. // @@ -189,11 +182,18 @@ type DescribeInstanceTypesInput struct { // vcpu-info.default-vcpus - The default number of vCPUs for the instance type. Filters []*types.Filter - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The instance types. For more information, see Instance Types + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the + // Amazon Elastic Compute Cloud User Guide. + InstanceTypes []types.InstanceType + + // The maximum number of results to return for the request in a single page. The + // remaining results can be seen by sending another request with the next token + // value. + MaxResults *int32 + + // The token to retrieve the next page of results. + NextToken *string } type DescribeInstanceTypesOutput struct { diff --git a/service/ec2/api_op_DescribeInstances.go b/service/ec2/api_op_DescribeInstances.go index 5a814c80147..87d79e96838 100644 --- a/service/ec2/api_op_DescribeInstances.go +++ b/service/ec2/api_op_DescribeInstances.go @@ -69,8 +69,11 @@ func (c *Client) DescribeInstances(ctx context.Context, params *DescribeInstance type DescribeInstancesInput struct { - // The instance IDs. Default: Describes all your instances. - InstanceIds []*string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // The filters. // @@ -380,20 +383,17 @@ type DescribeInstancesInput struct { // * vpc-id - The ID of the VPC that the instance is running in. Filters []*types.Filter - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - - // The token to request the next page of results. - NextToken *string + // The instance IDs. Default: Describes all your instances. + InstanceIds []*string // The maximum number of results to return in a single call. To retrieve the // remaining results, make another call with the returned NextToken value. This // value can be between 5 and 1000. You cannot specify this parameter and the // instance IDs parameter in the same call. MaxResults *int32 + + // The token to request the next page of results. + NextToken *string } type DescribeInstancesOutput struct { diff --git a/service/ec2/api_op_DescribeInternetGateways.go b/service/ec2/api_op_DescribeInternetGateways.go index aa33dde884e..e8607ec8de3 100644 --- a/service/ec2/api_op_DescribeInternetGateways.go +++ b/service/ec2/api_op_DescribeInternetGateways.go @@ -62,10 +62,6 @@ type DescribeInternetGatewaysInput struct { // UnauthorizedOperation. DryRun *bool - // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. - MaxResults *int32 - // One or more filters. // // * attachment.state - The current state of the @@ -94,6 +90,10 @@ type DescribeInternetGatewaysInput struct { // One or more internet gateway IDs. Default: Describes all your internet gateways. InternetGatewayIds []*string + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int32 + // The token for the next page of results. NextToken *string } diff --git a/service/ec2/api_op_DescribeIpv6Pools.go b/service/ec2/api_op_DescribeIpv6Pools.go index 8b1c7d2df89..95f382be4eb 100644 --- a/service/ec2/api_op_DescribeIpv6Pools.go +++ b/service/ec2/api_op_DescribeIpv6Pools.go @@ -56,6 +56,12 @@ func (c *Client) DescribeIpv6Pools(ctx context.Context, params *DescribeIpv6Pool type DescribeIpv6PoolsInput struct { + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // One or more filters. // // * tag: - The key/value combination of a tag assigned @@ -73,12 +79,6 @@ type DescribeIpv6PoolsInput struct { // remaining results, make another call with the returned nextToken value. MaxResults *int32 - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The token for the next page of results. NextToken *string @@ -88,13 +88,13 @@ type DescribeIpv6PoolsInput struct { type DescribeIpv6PoolsOutput struct { + // Information about the IPv6 address pools. + Ipv6Pools []*types.Ipv6Pool + // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string - // Information about the IPv6 address pools. - Ipv6Pools []*types.Ipv6Pool - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeKeyPairs.go b/service/ec2/api_op_DescribeKeyPairs.go index d9ff7723aca..de9b032cacd 100644 --- a/service/ec2/api_op_DescribeKeyPairs.go +++ b/service/ec2/api_op_DescribeKeyPairs.go @@ -85,11 +85,11 @@ type DescribeKeyPairsInput struct { // specify tag:Owner for the filter name and TeamA for the filter value. Filters []*types.Filter - // The IDs of the key pairs. - KeyPairIds []*string - // The key pair names. Default: Describes all your key pairs. KeyNames []*string + + // The IDs of the key pairs. + KeyPairIds []*string } type DescribeKeyPairsOutput struct { diff --git a/service/ec2/api_op_DescribeLaunchTemplateVersions.go b/service/ec2/api_op_DescribeLaunchTemplateVersions.go index a890e336123..7bcce79152e 100644 --- a/service/ec2/api_op_DescribeLaunchTemplateVersions.go +++ b/service/ec2/api_op_DescribeLaunchTemplateVersions.go @@ -59,19 +59,11 @@ func (c *Client) DescribeLaunchTemplateVersions(ctx context.Context, params *Des type DescribeLaunchTemplateVersionsInput struct { - // The name of the launch template. To describe one or more versions of a specified - // launch template, you must specify either the launch template ID or the launch - // template name in the request. To describe all the latest or default launch - // template versions in your account, you must omit this parameter. - LaunchTemplateName *string - - // The version number after which to describe launch template versions. - MinVersion *string - - // The maximum number of results to return in a single call. To retrieve the - // remaining results, make another call with the returned NextToken value. This - // value can be between 1 and 200. - MaxResults *int32 + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // One or more filters. // @@ -98,9 +90,32 @@ type DescribeLaunchTemplateVersionsInput struct { // * ram-disk-id - The RAM disk ID. Filters []*types.Filter + // The ID of the launch template. To describe one or more versions of a specified + // launch template, you must specify either the launch template ID or the launch + // template name in the request. To describe all the latest or default launch + // template versions in your account, you must omit this parameter. + LaunchTemplateId *string + + // The name of the launch template. To describe one or more versions of a specified + // launch template, you must specify either the launch template ID or the launch + // template name in the request. To describe all the latest or default launch + // template versions in your account, you must omit this parameter. + LaunchTemplateName *string + + // The maximum number of results to return in a single call. To retrieve the + // remaining results, make another call with the returned NextToken value. This + // value can be between 1 and 200. + MaxResults *int32 + // The version number up to which to describe launch template versions. MaxVersion *string + // The version number after which to describe launch template versions. + MinVersion *string + + // The token to request the next page of results. + NextToken *string + // One or more versions of the launch template. Valid values depend on whether you // are describing a specified launch template (by ID or name) or all launch // templates in your account. To describe one or more versions of a specified @@ -110,21 +125,6 @@ type DescribeLaunchTemplateVersionsInput struct { // are defined as the default version, the valid value is $Default. You can specify // $Latest and $Default in the same call. You cannot specify numbers. Versions []*string - - // The ID of the launch template. To describe one or more versions of a specified - // launch template, you must specify either the launch template ID or the launch - // template name in the request. To describe all the latest or default launch - // template versions in your account, you must omit this parameter. - LaunchTemplateId *string - - // The token to request the next page of results. - NextToken *string - - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool } type DescribeLaunchTemplateVersionsOutput struct { diff --git a/service/ec2/api_op_DescribeLaunchTemplates.go b/service/ec2/api_op_DescribeLaunchTemplates.go index fb1df43f0ba..d5c8edd1b85 100644 --- a/service/ec2/api_op_DescribeLaunchTemplates.go +++ b/service/ec2/api_op_DescribeLaunchTemplates.go @@ -56,13 +56,11 @@ func (c *Client) DescribeLaunchTemplates(ctx context.Context, params *DescribeLa type DescribeLaunchTemplatesInput struct { - // The maximum number of results to return in a single call. To retrieve the - // remaining results, make another call with the returned NextToken value. This - // value can be between 1 and 200. - MaxResults *int32 - - // One or more launch template names. - LaunchTemplateNames []*string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // One or more filters. // @@ -82,28 +80,30 @@ type DescribeLaunchTemplatesInput struct { // resources assigned a tag with a specific key, regardless of the tag value. Filters []*types.Filter - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // One or more launch template IDs. LaunchTemplateIds []*string + // One or more launch template names. + LaunchTemplateNames []*string + + // The maximum number of results to return in a single call. To retrieve the + // remaining results, make another call with the returned NextToken value. This + // value can be between 1 and 200. + MaxResults *int32 + // The token to request the next page of results. NextToken *string } type DescribeLaunchTemplatesOutput struct { + // Information about the launch templates. + LaunchTemplates []*types.LaunchTemplate + // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string - // Information about the launch templates. - LaunchTemplates []*types.LaunchTemplate - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations.go b/service/ec2/api_op_DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations.go index a22aecaae09..f5cc9320ad4 100644 --- a/service/ec2/api_op_DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations.go +++ b/service/ec2/api_op_DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations.go @@ -57,16 +57,6 @@ func (c *Client) DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations type DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsInput struct { - // The IDs of the associations. - LocalGatewayRouteTableVirtualInterfaceGroupAssociationIds []*string - - // The token for the next page of results. - NextToken *string - - // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. - MaxResults *int32 - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -89,6 +79,16 @@ type DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsInput struct // // * state - The state of the association. Filters []*types.Filter + + // The IDs of the associations. + LocalGatewayRouteTableVirtualInterfaceGroupAssociationIds []*string + + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int32 + + // The token for the next page of results. + NextToken *string } type DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsOutput struct { diff --git a/service/ec2/api_op_DescribeLocalGatewayRouteTableVpcAssociations.go b/service/ec2/api_op_DescribeLocalGatewayRouteTableVpcAssociations.go index dd6687c93c8..5a48909ba69 100644 --- a/service/ec2/api_op_DescribeLocalGatewayRouteTableVpcAssociations.go +++ b/service/ec2/api_op_DescribeLocalGatewayRouteTableVpcAssociations.go @@ -57,22 +57,12 @@ func (c *Client) DescribeLocalGatewayRouteTableVpcAssociations(ctx context.Conte type DescribeLocalGatewayRouteTableVpcAssociationsInput struct { - // The IDs of the associations. - LocalGatewayRouteTableVpcAssociationIds []*string - - // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. - MaxResults *int32 - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // The token for the next page of results. - NextToken *string - // One or more filters. // // * local-gateway-id - The ID of a local gateway. @@ -88,6 +78,16 @@ type DescribeLocalGatewayRouteTableVpcAssociationsInput struct { // // * vpc-id - The ID of the VPC. Filters []*types.Filter + + // The IDs of the associations. + LocalGatewayRouteTableVpcAssociationIds []*string + + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int32 + + // The token for the next page of results. + NextToken *string } type DescribeLocalGatewayRouteTableVpcAssociationsOutput struct { diff --git a/service/ec2/api_op_DescribeLocalGatewayRouteTables.go b/service/ec2/api_op_DescribeLocalGatewayRouteTables.go index 297e218317f..40cf7dec7cc 100644 --- a/service/ec2/api_op_DescribeLocalGatewayRouteTables.go +++ b/service/ec2/api_op_DescribeLocalGatewayRouteTables.go @@ -57,10 +57,6 @@ func (c *Client) DescribeLocalGatewayRouteTables(ctx context.Context, params *De type DescribeLocalGatewayRouteTablesInput struct { - // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. - MaxResults *int32 - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -81,11 +77,15 @@ type DescribeLocalGatewayRouteTablesInput struct { // state of the local gateway route table. Filters []*types.Filter - // The token for the next page of results. - NextToken *string - // The IDs of the local gateway route tables. LocalGatewayRouteTableIds []*string + + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int32 + + // The token for the next page of results. + NextToken *string } type DescribeLocalGatewayRouteTablesOutput struct { diff --git a/service/ec2/api_op_DescribeLocalGatewayVirtualInterfaceGroups.go b/service/ec2/api_op_DescribeLocalGatewayVirtualInterfaceGroups.go index f1c9048b8d7..0208418497b 100644 --- a/service/ec2/api_op_DescribeLocalGatewayVirtualInterfaceGroups.go +++ b/service/ec2/api_op_DescribeLocalGatewayVirtualInterfaceGroups.go @@ -56,6 +56,12 @@ func (c *Client) DescribeLocalGatewayVirtualInterfaceGroups(ctx context.Context, type DescribeLocalGatewayVirtualInterfaceGroupsInput struct { + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // One or more filters. // // * local-gateway-id - The ID of a local gateway. @@ -68,9 +74,6 @@ type DescribeLocalGatewayVirtualInterfaceGroupsInput struct { // group. Filters []*types.Filter - // The token for the next page of results. - NextToken *string - // The IDs of the virtual interface groups. LocalGatewayVirtualInterfaceGroupIds []*string @@ -78,22 +81,19 @@ type DescribeLocalGatewayVirtualInterfaceGroupsInput struct { // remaining results, make another call with the returned nextToken value. MaxResults *int32 - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The token for the next page of results. + NextToken *string } type DescribeLocalGatewayVirtualInterfaceGroupsOutput struct { + // The virtual interface groups. + LocalGatewayVirtualInterfaceGroups []*types.LocalGatewayVirtualInterfaceGroup + // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string - // The virtual interface groups. - LocalGatewayVirtualInterfaceGroups []*types.LocalGatewayVirtualInterfaceGroup - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeLocalGatewayVirtualInterfaces.go b/service/ec2/api_op_DescribeLocalGatewayVirtualInterfaces.go index 559b89d570f..1a366350cfb 100644 --- a/service/ec2/api_op_DescribeLocalGatewayVirtualInterfaces.go +++ b/service/ec2/api_op_DescribeLocalGatewayVirtualInterfaces.go @@ -62,16 +62,16 @@ type DescribeLocalGatewayVirtualInterfacesInput struct { // UnauthorizedOperation. DryRun *bool - // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. - MaxResults *int32 - // One or more filters. Filters []*types.Filter // The IDs of the virtual interfaces. LocalGatewayVirtualInterfaceIds []*string + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int32 + // The token for the next page of results. NextToken *string } diff --git a/service/ec2/api_op_DescribeLocalGateways.go b/service/ec2/api_op_DescribeLocalGateways.go index 9f668c311af..afe82437a14 100644 --- a/service/ec2/api_op_DescribeLocalGateways.go +++ b/service/ec2/api_op_DescribeLocalGateways.go @@ -57,6 +57,12 @@ func (c *Client) DescribeLocalGateways(ctx context.Context, params *DescribeLoca type DescribeLocalGatewaysInput struct { + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // One or more filters. Filters []*types.Filter @@ -86,12 +92,6 @@ type DescribeLocalGatewaysInput struct { // The token for the next page of results. NextToken *string - - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool } type DescribeLocalGatewaysOutput struct { diff --git a/service/ec2/api_op_DescribeManagedPrefixLists.go b/service/ec2/api_op_DescribeManagedPrefixLists.go index 65c574882e4..07ede54a33c 100644 --- a/service/ec2/api_op_DescribeManagedPrefixLists.go +++ b/service/ec2/api_op_DescribeManagedPrefixLists.go @@ -63,9 +63,6 @@ type DescribeManagedPrefixListsInput struct { // UnauthorizedOperation. DryRun *bool - // The token for the next page of results. - NextToken *string - // One or more filters. // // * owner-id - The ID of the prefix list owner. @@ -81,6 +78,9 @@ type DescribeManagedPrefixListsInput struct { // remaining results, make another call with the returned nextToken value. MaxResults *int32 + // The token for the next page of results. + NextToken *string + // One or more prefix list IDs. PrefixListIds []*string } diff --git a/service/ec2/api_op_DescribeMovingAddresses.go b/service/ec2/api_op_DescribeMovingAddresses.go index 87d25a54e14..6324bd55647 100644 --- a/service/ec2/api_op_DescribeMovingAddresses.go +++ b/service/ec2/api_op_DescribeMovingAddresses.go @@ -65,6 +65,12 @@ type DescribeMovingAddressesInput struct { // UnauthorizedOperation. DryRun *bool + // One or more filters. + // + // * moving-status - The status of the Elastic IP address + // (MovingToVpc | RestoringToClassic). + Filters []*types.Filter + // The maximum number of results to return for the request in a single page. The // remaining results of the initial request can be seen by sending another request // with the returned NextToken value. This value can be between 5 and 1000; if @@ -72,28 +78,22 @@ type DescribeMovingAddressesInput struct { // Default: If no value is provided, the default is 1000. MaxResults *int32 - // One or more filters. - // - // * moving-status - The status of the Elastic IP address - // (MovingToVpc | RestoringToClassic). - Filters []*types.Filter + // The token for the next page of results. + NextToken *string // One or more Elastic IP addresses. PublicIps []*string - - // The token for the next page of results. - NextToken *string } type DescribeMovingAddressesOutput struct { + // The status for each Elastic IP address. + MovingAddressStatuses []*types.MovingAddressStatus + // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string - // The status for each Elastic IP address. - MovingAddressStatuses []*types.MovingAddressStatus - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeNatGateways.go b/service/ec2/api_op_DescribeNatGateways.go index 1c5d7df3cbf..557c966ea48 100644 --- a/service/ec2/api_op_DescribeNatGateways.go +++ b/service/ec2/api_op_DescribeNatGateways.go @@ -56,8 +56,11 @@ func (c *Client) DescribeNatGateways(ctx context.Context, params *DescribeNatGat type DescribeNatGatewaysInput struct { - // The token for the next page of results. - NextToken *string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // One or more filters. // @@ -84,29 +87,26 @@ type DescribeNatGatewaysInput struct { // resides. Filter []*types.Filter - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. MaxResults *int32 // One or more NAT gateway IDs. NatGatewayIds []*string + + // The token for the next page of results. + NextToken *string } type DescribeNatGatewaysOutput struct { + // Information about the NAT gateways. + NatGateways []*types.NatGateway + // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string - // Information about the NAT gateways. - NatGateways []*types.NatGateway - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeNetworkAcls.go b/service/ec2/api_op_DescribeNetworkAcls.go index 6e4a4f4fd7d..55bf08874e3 100644 --- a/service/ec2/api_op_DescribeNetworkAcls.go +++ b/service/ec2/api_op_DescribeNetworkAcls.go @@ -64,9 +64,6 @@ type DescribeNetworkAclsInput struct { // UnauthorizedOperation. DryRun *bool - // One or more network ACL IDs. Default: Describes all your network ACLs. - NetworkAclIds []*string - // One or more filters. // // * association.association-id - The ID of an @@ -127,12 +124,15 @@ type DescribeNetworkAclsInput struct { // * vpc-id - The ID of the VPC for the network ACL. Filters []*types.Filter - // The token for the next page of results. - NextToken *string - // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. MaxResults *int32 + + // One or more network ACL IDs. Default: Describes all your network ACLs. + NetworkAclIds []*string + + // The token for the next page of results. + NextToken *string } type DescribeNetworkAclsOutput struct { diff --git a/service/ec2/api_op_DescribeNetworkInterfaceAttribute.go b/service/ec2/api_op_DescribeNetworkInterfaceAttribute.go index 27705f58717..ee3b4ba8260 100644 --- a/service/ec2/api_op_DescribeNetworkInterfaceAttribute.go +++ b/service/ec2/api_op_DescribeNetworkInterfaceAttribute.go @@ -64,27 +64,27 @@ type DescribeNetworkInterfaceAttributeInput struct { // This member is required. NetworkInterfaceId *string + // The attribute of the network interface. This parameter is required. + Attribute types.NetworkInterfaceAttribute + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The attribute of the network interface. This parameter is required. - Attribute types.NetworkInterfaceAttribute } // Contains the output of DescribeNetworkInterfaceAttribute. type DescribeNetworkInterfaceAttributeOutput struct { - // The security groups associated with the network interface. - Groups []*types.GroupIdentifier + // The attachment (if any) of the network interface. + Attachment *types.NetworkInterfaceAttachment // The description of the network interface. Description *types.AttributeValue - // The attachment (if any) of the network interface. - Attachment *types.NetworkInterfaceAttachment + // The security groups associated with the network interface. + Groups []*types.GroupIdentifier // The ID of the network interface. NetworkInterfaceId *string diff --git a/service/ec2/api_op_DescribeNetworkInterfacePermissions.go b/service/ec2/api_op_DescribeNetworkInterfacePermissions.go index 49ba8921440..2514281039d 100644 --- a/service/ec2/api_op_DescribeNetworkInterfacePermissions.go +++ b/service/ec2/api_op_DescribeNetworkInterfacePermissions.go @@ -57,14 +57,6 @@ func (c *Client) DescribeNetworkInterfacePermissions(ctx context.Context, params // Contains the parameters for DescribeNetworkInterfacePermissions. type DescribeNetworkInterfacePermissionsInput struct { - // The maximum number of results to return in a single call. To retrieve the - // remaining results, make another call with the returned NextToken value. If this - // parameter is not specified, up to 50 results are returned by default. - MaxResults *int32 - - // The token to request the next page of results. - NextToken *string - // One or more filters. // // * @@ -84,19 +76,27 @@ type DescribeNetworkInterfacePermissionsInput struct { // (INSTANCE-ATTACH | EIP-ASSOCIATE). Filters []*types.Filter + // The maximum number of results to return in a single call. To retrieve the + // remaining results, make another call with the returned NextToken value. If this + // parameter is not specified, up to 50 results are returned by default. + MaxResults *int32 + // One or more network interface permission IDs. NetworkInterfacePermissionIds []*string + + // The token to request the next page of results. + NextToken *string } // Contains the output for DescribeNetworkInterfacePermissions. type DescribeNetworkInterfacePermissionsOutput struct { - // The token to use to retrieve the next page of results. - NextToken *string - // The network interface permissions. NetworkInterfacePermissions []*types.NetworkInterfacePermission + // The token to use to retrieve the next page of results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeNetworkInterfaces.go b/service/ec2/api_op_DescribeNetworkInterfaces.go index e065468ac17..47a50e201d6 100644 --- a/service/ec2/api_op_DescribeNetworkInterfaces.go +++ b/service/ec2/api_op_DescribeNetworkInterfaces.go @@ -57,19 +57,6 @@ func (c *Client) DescribeNetworkInterfaces(ctx context.Context, params *Describe // Contains the parameters for DescribeNetworkInterfaces. type DescribeNetworkInterfacesInput struct { - // The token to retrieve the next page of results. - NextToken *string - - // One or more network interface IDs. Default: Describes all your network - // interfaces. - NetworkInterfaceIds []*string - - // The maximum number of items to return for this request. The request returns a - // token that you can specify in a subsequent call to get the next set of results. - // You cannot specify this parameter and the network interface IDs parameter in the - // same request. - MaxResults *int32 - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -197,6 +184,19 @@ type DescribeNetworkInterfacesInput struct { // * vpc-id - The ID of // the VPC for the network interface. Filters []*types.Filter + + // The maximum number of items to return for this request. The request returns a + // token that you can specify in a subsequent call to get the next set of results. + // You cannot specify this parameter and the network interface IDs parameter in the + // same request. + MaxResults *int32 + + // One or more network interface IDs. Default: Describes all your network + // interfaces. + NetworkInterfaceIds []*string + + // The token to retrieve the next page of results. + NextToken *string } // Contains the output of DescribeNetworkInterfaces. diff --git a/service/ec2/api_op_DescribePlacementGroups.go b/service/ec2/api_op_DescribePlacementGroups.go index 5c1e5b47f01..c8107030210 100644 --- a/service/ec2/api_op_DescribePlacementGroups.go +++ b/service/ec2/api_op_DescribePlacementGroups.go @@ -59,13 +59,6 @@ func (c *Client) DescribePlacementGroups(ctx context.Context, params *DescribePl type DescribePlacementGroupsInput struct { - // The IDs of the placement groups. - GroupIds []*string - - // The names of the placement groups. Default: Describes all your placement groups, - // or only those otherwise specified. - GroupNames []*string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -93,6 +86,13 @@ type DescribePlacementGroupsInput struct { // filter to find all resources that have a tag with a specific key, regardless of // the tag value. Filters []*types.Filter + + // The IDs of the placement groups. + GroupIds []*string + + // The names of the placement groups. Default: Describes all your placement groups, + // or only those otherwise specified. + GroupNames []*string } type DescribePlacementGroupsOutput struct { diff --git a/service/ec2/api_op_DescribePrefixLists.go b/service/ec2/api_op_DescribePrefixLists.go index e40f3c315c8..7b5ba1bb5ba 100644 --- a/service/ec2/api_op_DescribePrefixLists.go +++ b/service/ec2/api_op_DescribePrefixLists.go @@ -58,8 +58,11 @@ func (c *Client) DescribePrefixLists(ctx context.Context, params *DescribePrefix type DescribePrefixListsInput struct { - // The token for the next page of results. - NextToken *string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // One or more filters. // @@ -69,29 +72,26 @@ type DescribePrefixListsInput struct { // prefix-list-name: The name of a prefix list. Filters []*types.Filter - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. MaxResults *int32 + // The token for the next page of results. + NextToken *string + // One or more prefix list IDs. PrefixListIds []*string } type DescribePrefixListsOutput struct { - // All available prefix lists. - PrefixLists []*types.PrefixList - // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string + // All available prefix lists. + PrefixLists []*types.PrefixList + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribePrincipalIdFormat.go b/service/ec2/api_op_DescribePrincipalIdFormat.go index 17eb5bc52b2..42ec657a970 100644 --- a/service/ec2/api_op_DescribePrincipalIdFormat.go +++ b/service/ec2/api_op_DescribePrincipalIdFormat.go @@ -68,6 +68,16 @@ func (c *Client) DescribePrincipalIdFormat(ctx context.Context, params *Describe type DescribePrincipalIdFormatInput struct { + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + + // The maximum number of results to return in a single call. To retrieve the + // remaining results, make another call with the returned NextToken value. + MaxResults *int32 + // The token to request the next page of results. NextToken *string @@ -80,16 +90,6 @@ type DescribePrincipalIdFormatInput struct { // vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | // vpn-connection | vpn-gateway Resources []*string - - // The maximum number of results to return in a single call. To retrieve the - // remaining results, make another call with the returned NextToken value. - MaxResults *int32 - - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool } type DescribePrincipalIdFormatOutput struct { diff --git a/service/ec2/api_op_DescribePublicIpv4Pools.go b/service/ec2/api_op_DescribePublicIpv4Pools.go index c5ce4eb3bf6..06e5b378196 100644 --- a/service/ec2/api_op_DescribePublicIpv4Pools.go +++ b/service/ec2/api_op_DescribePublicIpv4Pools.go @@ -56,9 +56,6 @@ func (c *Client) DescribePublicIpv4Pools(ctx context.Context, params *DescribePu type DescribePublicIpv4PoolsInput struct { - // The IDs of the address pools. - PoolIds []*string - // One or more filters. // // * tag: - The key/value combination of a tag assigned @@ -78,17 +75,20 @@ type DescribePublicIpv4PoolsInput struct { // The token for the next page of results. NextToken *string + + // The IDs of the address pools. + PoolIds []*string } type DescribePublicIpv4PoolsOutput struct { - // Information about the address pools. - PublicIpv4Pools []*types.PublicIpv4Pool - // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string + // Information about the address pools. + PublicIpv4Pools []*types.PublicIpv4Pool + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeRegions.go b/service/ec2/api_op_DescribeRegions.go index ea984d69a39..87ddaa36d87 100644 --- a/service/ec2/api_op_DescribeRegions.go +++ b/service/ec2/api_op_DescribeRegions.go @@ -61,20 +61,16 @@ func (c *Client) DescribeRegions(ctx context.Context, params *DescribeRegionsInp type DescribeRegionsInput struct { + // Indicates whether to display all Regions, including Regions that are disabled + // for your account. + AllRegions *bool + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // The names of the Regions. You can specify any Regions, whether they are enabled - // and disabled for your account. - RegionNames []*string - - // Indicates whether to display all Regions, including Regions that are disabled - // for your account. - AllRegions *bool - // The filters. // // * endpoint - The endpoint of the Region (for example, @@ -86,6 +82,10 @@ type DescribeRegionsInput struct { // * region-name - The // name of the Region (for example, us-east-1). Filters []*types.Filter + + // The names of the Regions. You can specify any Regions, whether they are enabled + // and disabled for your account. + RegionNames []*string } type DescribeRegionsOutput struct { diff --git a/service/ec2/api_op_DescribeReservedInstances.go b/service/ec2/api_op_DescribeReservedInstances.go index a826d1d74d2..1be7664ae79 100644 --- a/service/ec2/api_op_DescribeReservedInstances.go +++ b/service/ec2/api_op_DescribeReservedInstances.go @@ -60,15 +60,6 @@ func (c *Client) DescribeReservedInstances(ctx context.Context, params *Describe // Contains the parameters for DescribeReservedInstances. type DescribeReservedInstancesInput struct { - // One or more Reserved Instance IDs. Default: Describes all your Reserved - // Instances, or only those otherwise specified. - ReservedInstancesIds []*string - - // The Reserved Instance offering type. If you are using tools that predate the - // 2011-11-01 API version, you only have access to the Medium Utilization Reserved - // Instance offering type. - OfferingType types.OfferingTypeValues - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -133,6 +124,15 @@ type DescribeReservedInstancesInput struct { // Describes whether the Reserved Instance is Standard or Convertible. OfferingClass types.OfferingClassType + + // The Reserved Instance offering type. If you are using tools that predate the + // 2011-11-01 API version, you only have access to the Medium Utilization Reserved + // Instance offering type. + OfferingType types.OfferingTypeValues + + // One or more Reserved Instance IDs. Default: Describes all your Reserved + // Instances, or only those otherwise specified. + ReservedInstancesIds []*string } // Contains the output for DescribeReservedInstances. diff --git a/service/ec2/api_op_DescribeReservedInstancesListings.go b/service/ec2/api_op_DescribeReservedInstancesListings.go index 01cdf53ecc7..388563e668b 100644 --- a/service/ec2/api_op_DescribeReservedInstancesListings.go +++ b/service/ec2/api_op_DescribeReservedInstancesListings.go @@ -72,9 +72,6 @@ func (c *Client) DescribeReservedInstancesListings(ctx context.Context, params * // Contains the parameters for DescribeReservedInstancesListings. type DescribeReservedInstancesListingsInput struct { - // One or more Reserved Instance listing IDs. - ReservedInstancesListingId *string - // One or more filters. // // * reserved-instances-id - The ID of the Reserved @@ -92,6 +89,9 @@ type DescribeReservedInstancesListingsInput struct { // One or more Reserved Instance IDs. ReservedInstancesId *string + + // One or more Reserved Instance listing IDs. + ReservedInstancesListingId *string } // Contains the output of DescribeReservedInstancesListings. diff --git a/service/ec2/api_op_DescribeReservedInstancesModifications.go b/service/ec2/api_op_DescribeReservedInstancesModifications.go index 3326c54511e..e536b7acf95 100644 --- a/service/ec2/api_op_DescribeReservedInstancesModifications.go +++ b/service/ec2/api_op_DescribeReservedInstancesModifications.go @@ -110,23 +110,23 @@ type DescribeReservedInstancesModificationsInput struct { // update-date - The time when the modification request was last updated. Filters []*types.Filter - // IDs for the submitted modification request. - ReservedInstancesModificationIds []*string - // The token to retrieve the next page of results. NextToken *string + + // IDs for the submitted modification request. + ReservedInstancesModificationIds []*string } // Contains the output of DescribeReservedInstancesModifications. type DescribeReservedInstancesModificationsOutput struct { - // The Reserved Instance modification information. - ReservedInstancesModifications []*types.ReservedInstancesModification - // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string + // The Reserved Instance modification information. + ReservedInstancesModifications []*types.ReservedInstancesModification + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeReservedInstancesOfferings.go b/service/ec2/api_op_DescribeReservedInstancesOfferings.go index dcdfb1d1ada..3ca8668f4f6 100644 --- a/service/ec2/api_op_DescribeReservedInstancesOfferings.go +++ b/service/ec2/api_op_DescribeReservedInstancesOfferings.go @@ -66,21 +66,8 @@ func (c *Client) DescribeReservedInstancesOfferings(ctx context.Context, params // Contains the parameters for DescribeReservedInstancesOfferings. type DescribeReservedInstancesOfferingsInput struct { - // The offering class of the Reserved Instance. Can be standard or convertible. - OfferingClass types.OfferingClassType - - // The instance type that the reservation will cover (for example, m1.small). For - // more information, see Instance Types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the - // Amazon Elastic Compute Cloud User Guide. - InstanceType types.InstanceType - - // The token to retrieve the next page of results. - NextToken *string - - // The Reserved Instance product platform description. Instances that include - // (Amazon VPC) in the description are for use with Amazon VPC. - ProductDescription types.RIProductDescription + // The Availability Zone in which the Reserved Instance can be used. + AvailabilityZone *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the @@ -88,28 +75,6 @@ type DescribeReservedInstancesOfferingsInput struct { // UnauthorizedOperation. DryRun *bool - // The Availability Zone in which the Reserved Instance can be used. - AvailabilityZone *string - - // The tenancy of the instances covered by the reservation. A Reserved Instance - // with a tenancy of dedicated is applied to instances that run in a VPC on - // single-tenant hardware (i.e., Dedicated Instances). Important: The host value - // cannot be used with this parameter. Use the default or dedicated values only. - // Default: default - InstanceTenancy types.Tenancy - - // The Reserved Instance offering type. If you are using tools that predate the - // 2011-11-01 API version, you only have access to the Medium Utilization Reserved - // Instance offering type. - OfferingType types.OfferingTypeValues - - // The minimum duration (in seconds) to filter when searching for offerings. - // Default: 2592000 (1 month) - MinDuration *int64 - - // Include Reserved Instance Marketplace offerings in the response. - IncludeMarketplace *bool - // One or more filters. // // * availability-zone - The Availability Zone where the @@ -151,18 +116,53 @@ type DescribeReservedInstancesOfferingsInput struct { // 0.84). Filters []*types.Filter + // Include Reserved Instance Marketplace offerings in the response. + IncludeMarketplace *bool + + // The tenancy of the instances covered by the reservation. A Reserved Instance + // with a tenancy of dedicated is applied to instances that run in a VPC on + // single-tenant hardware (i.e., Dedicated Instances). Important: The host value + // cannot be used with this parameter. Use the default or dedicated values only. + // Default: default + InstanceTenancy types.Tenancy + + // The instance type that the reservation will cover (for example, m1.small). For + // more information, see Instance Types + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the + // Amazon Elastic Compute Cloud User Guide. + InstanceType types.InstanceType + // The maximum duration (in seconds) to filter when searching for offerings. // Default: 94608000 (3 years) MaxDuration *int64 + // The maximum number of instances to filter when searching for offerings. Default: + // 20 + MaxInstanceCount *int32 + // The maximum number of results to return for the request in a single page. The // remaining results of the initial request can be seen by sending another request // with the returned NextToken value. The maximum is 100. Default: 100 MaxResults *int32 - // The maximum number of instances to filter when searching for offerings. Default: - // 20 - MaxInstanceCount *int32 + // The minimum duration (in seconds) to filter when searching for offerings. + // Default: 2592000 (1 month) + MinDuration *int64 + + // The token to retrieve the next page of results. + NextToken *string + + // The offering class of the Reserved Instance. Can be standard or convertible. + OfferingClass types.OfferingClassType + + // The Reserved Instance offering type. If you are using tools that predate the + // 2011-11-01 API version, you only have access to the Medium Utilization Reserved + // Instance offering type. + OfferingType types.OfferingTypeValues + + // The Reserved Instance product platform description. Instances that include + // (Amazon VPC) in the description are for use with Amazon VPC. + ProductDescription types.RIProductDescription // One or more Reserved Instances offering IDs. ReservedInstancesOfferingIds []*string @@ -171,13 +171,13 @@ type DescribeReservedInstancesOfferingsInput struct { // Contains the output of DescribeReservedInstancesOfferings. type DescribeReservedInstancesOfferingsOutput struct { - // A list of Reserved Instances offerings. - ReservedInstancesOfferings []*types.ReservedInstancesOffering - // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string + // A list of Reserved Instances offerings. + ReservedInstancesOfferings []*types.ReservedInstancesOffering + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeRouteTables.go b/service/ec2/api_op_DescribeRouteTables.go index 3cd1b58dd95..b86cec9aef9 100644 --- a/service/ec2/api_op_DescribeRouteTables.go +++ b/service/ec2/api_op_DescribeRouteTables.go @@ -62,9 +62,6 @@ func (c *Client) DescribeRouteTables(ctx context.Context, params *DescribeRouteT type DescribeRouteTablesInput struct { - // One or more route table IDs. Default: Describes all your route tables. - RouteTableIds []*string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -147,12 +144,15 @@ type DescribeRouteTablesInput struct { // the VPC for the route table. Filters []*types.Filter - // The token for the next page of results. - NextToken *string - // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. MaxResults *int32 + + // The token for the next page of results. + NextToken *string + + // One or more route table IDs. Default: Describes all your route tables. + RouteTableIds []*string } // Contains the output of DescribeRouteTables. diff --git a/service/ec2/api_op_DescribeScheduledInstanceAvailability.go b/service/ec2/api_op_DescribeScheduledInstanceAvailability.go index 3e173a3776c..16c91405087 100644 --- a/service/ec2/api_op_DescribeScheduledInstanceAvailability.go +++ b/service/ec2/api_op_DescribeScheduledInstanceAvailability.go @@ -69,8 +69,10 @@ type DescribeScheduledInstanceAvailabilityInput struct { // This member is required. FirstSlotStartTimeRange *types.SlotDateTimeRangeRequest - // The token for the next set of results. - NextToken *string + // The schedule recurrence. + // + // This member is required. + Recurrence *types.ScheduledInstanceRecurrenceRequest // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the @@ -78,15 +80,6 @@ type DescribeScheduledInstanceAvailabilityInput struct { // UnauthorizedOperation. DryRun *bool - // The maximum available duration, in hours. This value must be greater than - // MinSlotDurationInHours and less than 1,720. - MaxSlotDurationInHours *int32 - - // The maximum number of results to return in a single call. This value can be - // between 5 and 300. The default value is 300. To retrieve the remaining results, - // make another call with the returned NextToken value. - MaxResults *int32 - // The filters. // // * availability-zone - The Availability Zone (for example, @@ -101,27 +94,34 @@ type DescribeScheduledInstanceAvailabilityInput struct { // platform - The platform (Linux/UNIX or Windows). Filters []*types.Filter + // The maximum number of results to return in a single call. This value can be + // between 5 and 300. The default value is 300. To retrieve the remaining results, + // make another call with the returned NextToken value. + MaxResults *int32 + + // The maximum available duration, in hours. This value must be greater than + // MinSlotDurationInHours and less than 1,720. + MaxSlotDurationInHours *int32 + // The minimum available duration, in hours. The minimum required duration is 1,200 // hours per year. For example, the minimum daily schedule is 4 hours, the minimum // weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours. MinSlotDurationInHours *int32 - // The schedule recurrence. - // - // This member is required. - Recurrence *types.ScheduledInstanceRecurrenceRequest + // The token for the next set of results. + NextToken *string } // Contains the output of DescribeScheduledInstanceAvailability. type DescribeScheduledInstanceAvailabilityOutput struct { - // Information about the available Scheduled Instances. - ScheduledInstanceAvailabilitySet []*types.ScheduledInstanceAvailability - // The token required to retrieve the next set of results. This value is null when // there are no more results to return. NextToken *string + // Information about the available Scheduled Instances. + ScheduledInstanceAvailabilitySet []*types.ScheduledInstanceAvailability + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeScheduledInstances.go b/service/ec2/api_op_DescribeScheduledInstances.go index 51e00f83e73..6ca743fb74f 100644 --- a/service/ec2/api_op_DescribeScheduledInstances.go +++ b/service/ec2/api_op_DescribeScheduledInstances.go @@ -57,16 +57,11 @@ func (c *Client) DescribeScheduledInstances(ctx context.Context, params *Describ // Contains the parameters for DescribeScheduledInstances. type DescribeScheduledInstancesInput struct { - // The token for the next set of results. - NextToken *string - - // The maximum number of results to return in a single call. This value can be - // between 5 and 300. The default value is 100. To retrieve the remaining results, - // make another call with the returned NextToken value. - MaxResults *int32 - - // The Scheduled Instance IDs. - ScheduledInstanceIds []*string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // The filters. // @@ -82,11 +77,16 @@ type DescribeScheduledInstancesInput struct { // platform - The platform (Linux/UNIX or Windows). Filters []*types.Filter - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The maximum number of results to return in a single call. This value can be + // between 5 and 300. The default value is 100. To retrieve the remaining results, + // make another call with the returned NextToken value. + MaxResults *int32 + + // The token for the next set of results. + NextToken *string + + // The Scheduled Instance IDs. + ScheduledInstanceIds []*string // The time period for the first schedule to start. SlotStartTimeRange *types.SlotStartTimeRangeRequest diff --git a/service/ec2/api_op_DescribeSecurityGroupReferences.go b/service/ec2/api_op_DescribeSecurityGroupReferences.go index a6eeb641489..9637ee623a1 100644 --- a/service/ec2/api_op_DescribeSecurityGroupReferences.go +++ b/service/ec2/api_op_DescribeSecurityGroupReferences.go @@ -58,16 +58,16 @@ func (c *Client) DescribeSecurityGroupReferences(ctx context.Context, params *De type DescribeSecurityGroupReferencesInput struct { + // The IDs of the security groups in your account. + // + // This member is required. + GroupId []*string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The IDs of the security groups in your account. - // - // This member is required. - GroupId []*string } type DescribeSecurityGroupReferencesOutput struct { diff --git a/service/ec2/api_op_DescribeSecurityGroups.go b/service/ec2/api_op_DescribeSecurityGroups.go index 8712a25955d..c9af246ffb4 100644 --- a/service/ec2/api_op_DescribeSecurityGroups.go +++ b/service/ec2/api_op_DescribeSecurityGroups.go @@ -62,24 +62,11 @@ func (c *Client) DescribeSecurityGroups(ctx context.Context, params *DescribeSec type DescribeSecurityGroupsInput struct { - // The IDs of the security groups. Required for security groups in a nondefault - // VPC. Default: Describes all your security groups. - GroupIds []*string - - // [EC2-Classic and default VPC only] The names of the security groups. You can - // specify either the security group name or the security group ID. For security - // groups in a nondefault VPC, use the group-name filter to describe security - // groups by name. Default: Describes all your security groups. - GroupNames []*string - - // The maximum number of results to return in a single call. To retrieve the - // remaining results, make another request with the returned NextToken value. This - // value can be between 5 and 1000. If this parameter is not specified, then all - // results are returned. - MaxResults *int32 - - // The token to request the next page of results. - NextToken *string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // The filters. If using multiple filters for rules, the results include security // groups for which any combination of rules - not necessarily a single rule - @@ -174,22 +161,35 @@ type DescribeSecurityGroupsInput struct { // the VPC specified when the security group was created. Filters []*types.Filter - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The IDs of the security groups. Required for security groups in a nondefault + // VPC. Default: Describes all your security groups. + GroupIds []*string + + // [EC2-Classic and default VPC only] The names of the security groups. You can + // specify either the security group name or the security group ID. For security + // groups in a nondefault VPC, use the group-name filter to describe security + // groups by name. Default: Describes all your security groups. + GroupNames []*string + + // The maximum number of results to return in a single call. To retrieve the + // remaining results, make another request with the returned NextToken value. This + // value can be between 5 and 1000. If this parameter is not specified, then all + // results are returned. + MaxResults *int32 + + // The token to request the next page of results. + NextToken *string } type DescribeSecurityGroupsOutput struct { - // Information about the security groups. - SecurityGroups []*types.SecurityGroup - // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string + // Information about the security groups. + SecurityGroups []*types.SecurityGroup + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeSnapshotAttribute.go b/service/ec2/api_op_DescribeSnapshotAttribute.go index 07cd5e22c12..6f488b7dfac 100644 --- a/service/ec2/api_op_DescribeSnapshotAttribute.go +++ b/service/ec2/api_op_DescribeSnapshotAttribute.go @@ -61,6 +61,11 @@ func (c *Client) DescribeSnapshotAttribute(ctx context.Context, params *Describe type DescribeSnapshotAttributeInput struct { + // The snapshot attribute you would like to view. + // + // This member is required. + Attribute types.SnapshotAttributeName + // The ID of the EBS snapshot. // // This member is required. @@ -71,24 +76,19 @@ type DescribeSnapshotAttributeInput struct { // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The snapshot attribute you would like to view. - // - // This member is required. - Attribute types.SnapshotAttributeName } type DescribeSnapshotAttributeOutput struct { - // The ID of the EBS snapshot. - SnapshotId *string + // The users and groups that have the permissions for creating volumes from the + // snapshot. + CreateVolumePermissions []*types.CreateVolumePermission // The product codes. ProductCodes []*types.ProductCode - // The users and groups that have the permissions for creating volumes from the - // snapshot. - CreateVolumePermissions []*types.CreateVolumePermission + // The ID of the EBS snapshot. + SnapshotId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/ec2/api_op_DescribeSnapshots.go b/service/ec2/api_op_DescribeSnapshots.go index 4a094109034..6ba455ca101 100644 --- a/service/ec2/api_op_DescribeSnapshots.go +++ b/service/ec2/api_op_DescribeSnapshots.go @@ -97,16 +97,11 @@ func (c *Client) DescribeSnapshots(ctx context.Context, params *DescribeSnapshot type DescribeSnapshotsInput struct { - // The IDs of the AWS accounts that can create volumes from the snapshot. - RestorableByUserIds []*string - - // The snapshot IDs. Default: Describes the snapshots for which you have create - // volume permissions. - SnapshotIds []*string - - // Scopes the results to snapshots with the specified owners. You can specify a - // combination of AWS account IDs, self, and amazon. - OwnerIds []*string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // The filters. // @@ -152,12 +147,6 @@ type DescribeSnapshotsInput struct { // size of the volume, in GiB. Filters []*types.Filter - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The maximum number of snapshot results returned by DescribeSnapshots in // paginated output. When this parameter is used, DescribeSnapshots only returns // MaxResults results in a single page along with a NextToken response element. The @@ -174,19 +163,30 @@ type DescribeSnapshotsInput struct { // Pagination continues from the end of the previous results that returned the // NextToken value. This value is null when there are no more results to return. NextToken *string + + // Scopes the results to snapshots with the specified owners. You can specify a + // combination of AWS account IDs, self, and amazon. + OwnerIds []*string + + // The IDs of the AWS accounts that can create volumes from the snapshot. + RestorableByUserIds []*string + + // The snapshot IDs. Default: Describes the snapshots for which you have create + // volume permissions. + SnapshotIds []*string } type DescribeSnapshotsOutput struct { - // Information about the snapshots. - Snapshots []*types.Snapshot - // The NextToken value to include in a future DescribeSnapshots request. When the // results of a DescribeSnapshots request exceed MaxResults, this value can be used // to retrieve the next page of results. This value is null when there are no more // results to return. NextToken *string + // Information about the snapshots. + Snapshots []*types.Snapshot + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeSpotFleetInstances.go b/service/ec2/api_op_DescribeSpotFleetInstances.go index 5cb4af75c76..c098a2fcfc6 100644 --- a/service/ec2/api_op_DescribeSpotFleetInstances.go +++ b/service/ec2/api_op_DescribeSpotFleetInstances.go @@ -58,6 +58,11 @@ func (c *Client) DescribeSpotFleetInstances(ctx context.Context, params *Describ // Contains the parameters for DescribeSpotFleetInstances. type DescribeSpotFleetInstancesInput struct { + // The ID of the Spot Fleet request. + // + // This member is required. + SpotFleetRequestId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -71,16 +76,15 @@ type DescribeSpotFleetInstancesInput struct { // The token for the next set of results. NextToken *string - - // The ID of the Spot Fleet request. - // - // This member is required. - SpotFleetRequestId *string } // Contains the output of DescribeSpotFleetInstances. type DescribeSpotFleetInstancesOutput struct { + // The running instances. This list is refreshed periodically and might be out of + // date. + ActiveInstances []*types.ActiveInstance + // The token required to retrieve the next set of results. This value is null when // there are no more results to return. NextToken *string @@ -88,10 +92,6 @@ type DescribeSpotFleetInstancesOutput struct { // The ID of the Spot Fleet request. SpotFleetRequestId *string - // The running instances. This list is refreshed periodically and might be out of - // date. - ActiveInstances []*types.ActiveInstance - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeSpotFleetRequestHistory.go b/service/ec2/api_op_DescribeSpotFleetRequestHistory.go index 7c2d118458f..4324de55c77 100644 --- a/service/ec2/api_op_DescribeSpotFleetRequestHistory.go +++ b/service/ec2/api_op_DescribeSpotFleetRequestHistory.go @@ -62,17 +62,11 @@ func (c *Client) DescribeSpotFleetRequestHistory(ctx context.Context, params *De // Contains the parameters for DescribeSpotFleetRequestHistory. type DescribeSpotFleetRequestHistoryInput struct { - // The type of events to describe. By default, all events are described. - EventType types.EventType - // The ID of the Spot Fleet request. // // This member is required. SpotFleetRequestId *string - // The token for the next set of results. - NextToken *string - // The starting date and time for the events, in UTC format (for example, // YYYY-MM-DDTHH:MM:SSZ). // @@ -85,10 +79,16 @@ type DescribeSpotFleetRequestHistoryInput struct { // UnauthorizedOperation. DryRun *bool + // The type of events to describe. By default, all events are described. + EventType types.EventType + // The maximum number of results to return in a single call. Specify a value // between 1 and 1000. The default value is 1000. To retrieve the remaining // results, make another call with the returned NextToken value. MaxResults *int32 + + // The token for the next set of results. + NextToken *string } // Contains the output of DescribeSpotFleetRequestHistory. @@ -97,21 +97,21 @@ type DescribeSpotFleetRequestHistoryOutput struct { // Information about the events in the history of the Spot Fleet request. HistoryRecords []*types.HistoryRecord - // The starting date and time for the events, in UTC format (for example, - // YYYY-MM-DDTHH:MM:SSZ). - StartTime *time.Time - - // The ID of the Spot Fleet request. - SpotFleetRequestId *string + // The last date and time for the events, in UTC format (for example, + // YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved. If nextToken + // indicates that there are more results, this value is not present. + LastEvaluatedTime *time.Time // The token required to retrieve the next set of results. This value is null when // there are no more results to return. NextToken *string - // The last date and time for the events, in UTC format (for example, - // YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved. If nextToken - // indicates that there are more results, this value is not present. - LastEvaluatedTime *time.Time + // The ID of the Spot Fleet request. + SpotFleetRequestId *string + + // The starting date and time for the events, in UTC format (for example, + // YYYY-MM-DDTHH:MM:SSZ). + StartTime *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/ec2/api_op_DescribeSpotInstanceRequests.go b/service/ec2/api_op_DescribeSpotInstanceRequests.go index 2920154a6c7..660919a9935 100644 --- a/service/ec2/api_op_DescribeSpotInstanceRequests.go +++ b/service/ec2/api_op_DescribeSpotInstanceRequests.go @@ -70,24 +70,12 @@ func (c *Client) DescribeSpotInstanceRequests(ctx context.Context, params *Descr // Contains the parameters for DescribeSpotInstanceRequests. type DescribeSpotInstanceRequestsInput struct { - // The token to request the next set of results. This value is null when there are - // no more results to return. - NextToken *string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // One or more Spot Instance request IDs. - SpotInstanceRequestIds []*string - - // The maximum number of results to return in a single call. Specify a value - // between 5 and 1000. To retrieve the remaining results, make another call with - // the returned NextToken value. - MaxResults *int32 - // One or more filters. // // * availability-zone-group - The Availability Zone @@ -221,18 +209,30 @@ type DescribeSpotInstanceRequestsInput struct { // * // valid-until - The end date of the request. Filters []*types.Filter + + // The maximum number of results to return in a single call. Specify a value + // between 5 and 1000. To retrieve the remaining results, make another call with + // the returned NextToken value. + MaxResults *int32 + + // The token to request the next set of results. This value is null when there are + // no more results to return. + NextToken *string + + // One or more Spot Instance request IDs. + SpotInstanceRequestIds []*string } // Contains the output of DescribeSpotInstanceRequests. type DescribeSpotInstanceRequestsOutput struct { - // One or more Spot Instance requests. - SpotInstanceRequests []*types.SpotInstanceRequest - // The token to use to retrieve the next set of results. This value is null when // there are no more results to return. NextToken *string + // One or more Spot Instance requests. + SpotInstanceRequests []*types.SpotInstanceRequest + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeSpotPriceHistory.go b/service/ec2/api_op_DescribeSpotPriceHistory.go index 95ab137a5d6..ede2ee8e6cd 100644 --- a/service/ec2/api_op_DescribeSpotPriceHistory.go +++ b/service/ec2/api_op_DescribeSpotPriceHistory.go @@ -65,25 +65,6 @@ func (c *Client) DescribeSpotPriceHistory(ctx context.Context, params *DescribeS // Contains the parameters for DescribeSpotPriceHistory. type DescribeSpotPriceHistoryInput struct { - // The date and time, up to the current date, from which to stop retrieving the - // price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). - EndTime *time.Time - - // Filters the results by the specified instance types. - InstanceTypes []types.InstanceType - - // The date and time, up to the past 90 days, from which to start retrieving the - // price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). - StartTime *time.Time - - // The token for the next set of results. - NextToken *string - - // The maximum number of results to return in a single call. Specify a value - // between 1 and 1000. The default value is 1000. To retrieve the remaining - // results, make another call with the returned NextToken value. - MaxResults *int32 - // Filters the results by the specified Availability Zone. AvailabilityZone *string @@ -93,6 +74,10 @@ type DescribeSpotPriceHistoryInput struct { // UnauthorizedOperation. DryRun *bool + // The date and time, up to the current date, from which to stop retrieving the + // price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). + EndTime *time.Time + // One or more filters. // // * availability-zone - The Availability Zone for which @@ -114,8 +99,23 @@ type DescribeSpotPriceHistoryInput struct { // wildcards (* and ?). Greater than or less than comparison is not supported. Filters []*types.Filter + // Filters the results by the specified instance types. + InstanceTypes []types.InstanceType + + // The maximum number of results to return in a single call. Specify a value + // between 1 and 1000. The default value is 1000. To retrieve the remaining + // results, make another call with the returned NextToken value. + MaxResults *int32 + + // The token for the next set of results. + NextToken *string + // Filters the results by the specified basic product descriptions. ProductDescriptions []*string + + // The date and time, up to the past 90 days, from which to start retrieving the + // price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). + StartTime *time.Time } // Contains the output of DescribeSpotPriceHistory. diff --git a/service/ec2/api_op_DescribeStaleSecurityGroups.go b/service/ec2/api_op_DescribeStaleSecurityGroups.go index 94426a40212..078057f92dc 100644 --- a/service/ec2/api_op_DescribeStaleSecurityGroups.go +++ b/service/ec2/api_op_DescribeStaleSecurityGroups.go @@ -60,14 +60,6 @@ func (c *Client) DescribeStaleSecurityGroups(ctx context.Context, params *Descri type DescribeStaleSecurityGroupsInput struct { - // The maximum number of items to return for this request. The request returns a - // token that you can specify in a subsequent call to get the next set of results. - MaxResults *int32 - - // The token for the next set of items to return. (You received this token from a - // prior call.) - NextToken *string - // The ID of the VPC. // // This member is required. @@ -78,17 +70,25 @@ type DescribeStaleSecurityGroupsInput struct { // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // The maximum number of items to return for this request. The request returns a + // token that you can specify in a subsequent call to get the next set of results. + MaxResults *int32 + + // The token for the next set of items to return. (You received this token from a + // prior call.) + NextToken *string } type DescribeStaleSecurityGroupsOutput struct { - // Information about the stale security groups. - StaleSecurityGroupSet []*types.StaleSecurityGroup - // The token to use when requesting the next set of items. If there are no // additional items to return, the string is empty. NextToken *string + // Information about the stale security groups. + StaleSecurityGroupSet []*types.StaleSecurityGroup + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeSubnets.go b/service/ec2/api_op_DescribeSubnets.go index 0be0d69feaa..59d09667cfe 100644 --- a/service/ec2/api_op_DescribeSubnets.go +++ b/service/ec2/api_op_DescribeSubnets.go @@ -64,13 +64,6 @@ type DescribeSubnetsInput struct { // UnauthorizedOperation. DryRun *bool - // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. - MaxResults *int32 - - // The token for the next page of results. - NextToken *string - // One or more filters. // // * availability-zone - The Availability Zone for the @@ -127,19 +120,26 @@ type DescribeSubnetsInput struct { // * vpc-id - The ID of the VPC for the subnet. Filters []*types.Filter + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int32 + + // The token for the next page of results. + NextToken *string + // One or more subnet IDs. Default: Describes all your subnets. SubnetIds []*string } type DescribeSubnetsOutput struct { - // Information about one or more subnets. - Subnets []*types.Subnet - // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string + // Information about one or more subnets. + Subnets []*types.Subnet + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeTags.go b/service/ec2/api_op_DescribeTags.go index 1505c725b67..e033a4eb1c4 100644 --- a/service/ec2/api_op_DescribeTags.go +++ b/service/ec2/api_op_DescribeTags.go @@ -59,6 +59,12 @@ func (c *Client) DescribeTags(ctx context.Context, params *DescribeTagsInput, op type DescribeTagsInput struct { + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // The filters. // // * key - The tag key. @@ -82,19 +88,13 @@ type DescribeTagsInput struct { // * value - The tag value. Filters []*types.Filter - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - - // The token to retrieve the next page of results. - NextToken *string - // The maximum number of results to return in a single call. This value can be // between 5 and 1000. To retrieve the remaining results, make another call with // the returned NextToken value. MaxResults *int32 + + // The token to retrieve the next page of results. + NextToken *string } type DescribeTagsOutput struct { diff --git a/service/ec2/api_op_DescribeTrafficMirrorFilters.go b/service/ec2/api_op_DescribeTrafficMirrorFilters.go index 10b51d480c2..7ad5ff6991b 100644 --- a/service/ec2/api_op_DescribeTrafficMirrorFilters.go +++ b/service/ec2/api_op_DescribeTrafficMirrorFilters.go @@ -56,6 +56,12 @@ func (c *Client) DescribeTrafficMirrorFilters(ctx context.Context, params *Descr type DescribeTrafficMirrorFiltersInput struct { + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // One or more filters. The possible values are: // // * description: The Traffic @@ -65,32 +71,26 @@ type DescribeTrafficMirrorFiltersInput struct { // Traffic Mirror filter. Filters []*types.Filter - // The ID of the Traffic Mirror filter. - TrafficMirrorFilterIds []*string - - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int32 // The token for the next page of results. NextToken *string - // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. - MaxResults *int32 + // The ID of the Traffic Mirror filter. + TrafficMirrorFilterIds []*string } type DescribeTrafficMirrorFiltersOutput struct { - // Information about one or more Traffic Mirror filters. - TrafficMirrorFilters []*types.TrafficMirrorFilter - // The token to use to retrieve the next page of results. The value is null when // there are no more results to return. NextToken *string + // Information about one or more Traffic Mirror filters. + TrafficMirrorFilters []*types.TrafficMirrorFilter + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeTrafficMirrorSessions.go b/service/ec2/api_op_DescribeTrafficMirrorSessions.go index c631357725d..638b59e7510 100644 --- a/service/ec2/api_op_DescribeTrafficMirrorSessions.go +++ b/service/ec2/api_op_DescribeTrafficMirrorSessions.go @@ -57,8 +57,11 @@ func (c *Client) DescribeTrafficMirrorSessions(ctx context.Context, params *Desc type DescribeTrafficMirrorSessionsInput struct { - // The ID of the Traffic Mirror session. - TrafficMirrorSessionIds []*string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // One or more filters. The possible values are: // @@ -89,18 +92,15 @@ type DescribeTrafficMirrorSessionsInput struct { // virtual-network-id: The virtual network ID of the Traffic Mirror session. Filters []*types.Filter - // The token for the next page of results. - NextToken *string - // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. MaxResults *int32 - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The token for the next page of results. + NextToken *string + + // The ID of the Traffic Mirror session. + TrafficMirrorSessionIds []*string } type DescribeTrafficMirrorSessionsOutput struct { diff --git a/service/ec2/api_op_DescribeTrafficMirrorTargets.go b/service/ec2/api_op_DescribeTrafficMirrorTargets.go index f3b704f478a..11c30e523e9 100644 --- a/service/ec2/api_op_DescribeTrafficMirrorTargets.go +++ b/service/ec2/api_op_DescribeTrafficMirrorTargets.go @@ -56,8 +56,11 @@ func (c *Client) DescribeTrafficMirrorTargets(ctx context.Context, params *Descr type DescribeTrafficMirrorTargetsInput struct { - // The ID of the Traffic Mirror targets. - TrafficMirrorTargetIds []*string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // One or more filters. The possible values are: // @@ -77,29 +80,26 @@ type DescribeTrafficMirrorTargetsInput struct { // * traffic-mirror-target-id: The ID of the Traffic Mirror target. Filters []*types.Filter - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int32 // The token for the next page of results. NextToken *string - // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. - MaxResults *int32 + // The ID of the Traffic Mirror targets. + TrafficMirrorTargetIds []*string } type DescribeTrafficMirrorTargetsOutput struct { - // Information about one or more Traffic Mirror targets. - TrafficMirrorTargets []*types.TrafficMirrorTarget - // The token to use to retrieve the next page of results. The value is null when // there are no more results to return. NextToken *string + // Information about one or more Traffic Mirror targets. + TrafficMirrorTargets []*types.TrafficMirrorTarget + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeTransitGatewayAttachments.go b/service/ec2/api_op_DescribeTransitGatewayAttachments.go index d8c490f005a..928289eed1c 100644 --- a/service/ec2/api_op_DescribeTransitGatewayAttachments.go +++ b/service/ec2/api_op_DescribeTransitGatewayAttachments.go @@ -64,13 +64,6 @@ type DescribeTransitGatewayAttachmentsInput struct { // UnauthorizedOperation. DryRun *bool - // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. - MaxResults *int32 - - // The token for the next page of results. - NextToken *string - // One or more filters. The possible values are: // // * association.state - The @@ -103,19 +96,26 @@ type DescribeTransitGatewayAttachmentsInput struct { // gateway. Filters []*types.Filter + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int32 + + // The token for the next page of results. + NextToken *string + // The IDs of the attachments. TransitGatewayAttachmentIds []*string } type DescribeTransitGatewayAttachmentsOutput struct { - // Information about the attachments. - TransitGatewayAttachments []*types.TransitGatewayAttachment - // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string + // Information about the attachments. + TransitGatewayAttachments []*types.TransitGatewayAttachment + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeTransitGatewayMulticastDomains.go b/service/ec2/api_op_DescribeTransitGatewayMulticastDomains.go index bfa448f78ea..e6312736033 100644 --- a/service/ec2/api_op_DescribeTransitGatewayMulticastDomains.go +++ b/service/ec2/api_op_DescribeTransitGatewayMulticastDomains.go @@ -56,9 +56,11 @@ func (c *Client) DescribeTransitGatewayMulticastDomains(ctx context.Context, par type DescribeTransitGatewayMulticastDomainsInput struct { - // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. - MaxResults *int32 + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // One or more filters. The possible values are: // @@ -73,28 +75,26 @@ type DescribeTransitGatewayMulticastDomainsInput struct { // domain. Filters []*types.Filter - // The ID of the transit gateway multicast domain. - TransitGatewayMulticastDomainIds []*string + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int32 // The token for the next page of results. NextToken *string - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The ID of the transit gateway multicast domain. + TransitGatewayMulticastDomainIds []*string } type DescribeTransitGatewayMulticastDomainsOutput struct { - // Information about the transit gateway multicast domains. - TransitGatewayMulticastDomains []*types.TransitGatewayMulticastDomain - // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string + // Information about the transit gateway multicast domains. + TransitGatewayMulticastDomains []*types.TransitGatewayMulticastDomain + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeTransitGatewayPeeringAttachments.go b/service/ec2/api_op_DescribeTransitGatewayPeeringAttachments.go index f8c62910784..51a79c2391e 100644 --- a/service/ec2/api_op_DescribeTransitGatewayPeeringAttachments.go +++ b/service/ec2/api_op_DescribeTransitGatewayPeeringAttachments.go @@ -56,11 +56,11 @@ func (c *Client) DescribeTransitGatewayPeeringAttachments(ctx context.Context, p type DescribeTransitGatewayPeeringAttachmentsInput struct { - // The token for the next page of results. - NextToken *string - - // One or more IDs of the transit gateway peering attachments. - TransitGatewayAttachmentIds []*string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // One or more filters. The possible values are: // @@ -85,11 +85,11 @@ type DescribeTransitGatewayPeeringAttachmentsInput struct { // remaining results, make another call with the returned nextToken value. MaxResults *int32 - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The token for the next page of results. + NextToken *string + + // One or more IDs of the transit gateway peering attachments. + TransitGatewayAttachmentIds []*string } type DescribeTransitGatewayPeeringAttachmentsOutput struct { diff --git a/service/ec2/api_op_DescribeTransitGatewayRouteTables.go b/service/ec2/api_op_DescribeTransitGatewayRouteTables.go index b5a60648a0b..50b9165027b 100644 --- a/service/ec2/api_op_DescribeTransitGatewayRouteTables.go +++ b/service/ec2/api_op_DescribeTransitGatewayRouteTables.go @@ -57,12 +57,11 @@ func (c *Client) DescribeTransitGatewayRouteTables(ctx context.Context, params * type DescribeTransitGatewayRouteTablesInput struct { - // The IDs of the transit gateway route tables. - TransitGatewayRouteTableIds []*string - - // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. - MaxResults *int32 + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // One or more filters. The possible values are: // @@ -85,25 +84,26 @@ type DescribeTransitGatewayRouteTablesInput struct { // transit-gateway-route-table-id - The ID of the transit gateway route table. Filters []*types.Filter + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int32 + // The token for the next page of results. NextToken *string - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The IDs of the transit gateway route tables. + TransitGatewayRouteTableIds []*string } type DescribeTransitGatewayRouteTablesOutput struct { - // Information about the transit gateway route tables. - TransitGatewayRouteTables []*types.TransitGatewayRouteTable - // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string + // Information about the transit gateway route tables. + TransitGatewayRouteTables []*types.TransitGatewayRouteTable + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeTransitGatewayVpcAttachments.go b/service/ec2/api_op_DescribeTransitGatewayVpcAttachments.go index 749d4b0eaec..6efc86f705a 100644 --- a/service/ec2/api_op_DescribeTransitGatewayVpcAttachments.go +++ b/service/ec2/api_op_DescribeTransitGatewayVpcAttachments.go @@ -63,13 +63,6 @@ type DescribeTransitGatewayVpcAttachmentsInput struct { // UnauthorizedOperation. DryRun *bool - // The token for the next page of results. - NextToken *string - - // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. - MaxResults *int32 - // One or more filters. The possible values are: // // * state - The state of the @@ -86,19 +79,26 @@ type DescribeTransitGatewayVpcAttachmentsInput struct { // the VPC. Filters []*types.Filter + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int32 + + // The token for the next page of results. + NextToken *string + // The IDs of the attachments. TransitGatewayAttachmentIds []*string } type DescribeTransitGatewayVpcAttachmentsOutput struct { - // Information about the VPC attachments. - TransitGatewayVpcAttachments []*types.TransitGatewayVpcAttachment - // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string + // Information about the VPC attachments. + TransitGatewayVpcAttachments []*types.TransitGatewayVpcAttachment + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeTransitGateways.go b/service/ec2/api_op_DescribeTransitGateways.go index 394e35d9fc0..ea60c8c6f5a 100644 --- a/service/ec2/api_op_DescribeTransitGateways.go +++ b/service/ec2/api_op_DescribeTransitGateways.go @@ -63,9 +63,6 @@ type DescribeTransitGatewaysInput struct { // UnauthorizedOperation. DryRun *bool - // The IDs of the transit gateways. - TransitGatewayIds []*string - // One or more filters. The possible values are: // // * @@ -115,17 +112,20 @@ type DescribeTransitGatewaysInput struct { // The token for the next page of results. NextToken *string + + // The IDs of the transit gateways. + TransitGatewayIds []*string } type DescribeTransitGatewaysOutput struct { - // Information about the transit gateways. - TransitGateways []*types.TransitGateway - // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string + // Information about the transit gateways. + TransitGateways []*types.TransitGateway + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeVolumeAttribute.go b/service/ec2/api_op_DescribeVolumeAttribute.go index 27292f0d8e4..a097e673034 100644 --- a/service/ec2/api_op_DescribeVolumeAttribute.go +++ b/service/ec2/api_op_DescribeVolumeAttribute.go @@ -65,29 +65,29 @@ type DescribeVolumeAttributeInput struct { // This member is required. Attribute types.VolumeAttributeName + // The ID of the volume. + // + // This member is required. + VolumeId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The ID of the volume. - // - // This member is required. - VolumeId *string } type DescribeVolumeAttributeOutput struct { - // The ID of the volume. - VolumeId *string - // The state of autoEnableIO attribute. AutoEnableIO *types.AttributeBooleanValue // A list of product codes. ProductCodes []*types.ProductCode + // The ID of the volume. + VolumeId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeVolumeStatus.go b/service/ec2/api_op_DescribeVolumeStatus.go index 00423deaf30..22e99022595 100644 --- a/service/ec2/api_op_DescribeVolumeStatus.go +++ b/service/ec2/api_op_DescribeVolumeStatus.go @@ -84,6 +84,12 @@ func (c *Client) DescribeVolumeStatus(ctx context.Context, params *DescribeVolum type DescribeVolumeStatusInput struct { + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // The filters. // // * action.code - The action code for the event (for example, @@ -125,15 +131,6 @@ type DescribeVolumeStatusInput struct { // volume (ok | impaired | warning | insufficient-data). Filters []*types.Filter - // The IDs of the volumes. Default: Describes all your volumes. - VolumeIds []*string - - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The maximum number of volume results returned by DescribeVolumeStatus in // paginated output. When this parameter is used, the request only returns // MaxResults results in a single page along with a NextToken response element. The @@ -149,17 +146,20 @@ type DescribeVolumeStatusInput struct { // the next page of results. This value is null when there are no more results to // return. NextToken *string + + // The IDs of the volumes. Default: Describes all your volumes. + VolumeIds []*string } type DescribeVolumeStatusOutput struct { - // Information about the status of the volumes. - VolumeStatuses []*types.VolumeStatusItem - // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string + // Information about the status of the volumes. + VolumeStatuses []*types.VolumeStatusItem + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeVolumes.go b/service/ec2/api_op_DescribeVolumes.go index 5cd13a76f04..0476d20b66f 100644 --- a/service/ec2/api_op_DescribeVolumes.go +++ b/service/ec2/api_op_DescribeVolumes.go @@ -64,8 +64,11 @@ func (c *Client) DescribeVolumes(ctx context.Context, params *DescribeVolumesInp type DescribeVolumesInput struct { - // The volume IDs. - VolumeIds []*string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // The filters. // @@ -127,18 +130,6 @@ type DescribeVolumesInput struct { // HDD, sc1 for Cold HDD, or standard for Magnetic volumes. Filters []*types.Filter - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - - // The NextToken value returned from a previous paginated DescribeVolumes request - // where MaxResults was used and the results exceeded the value of that parameter. - // Pagination continues from the end of the previous results that returned the - // NextToken value. This value is null when there are no more results to return. - NextToken *string - // The maximum number of volume results returned by DescribeVolumes in paginated // output. When this parameter is used, DescribeVolumes only returns MaxResults // results in a single page along with a NextToken response element. The remaining @@ -148,19 +139,28 @@ type DescribeVolumesInput struct { // If this parameter is not used, then DescribeVolumes returns all results. You // cannot specify this parameter and the volume IDs parameter in the same request. MaxResults *int32 + + // The NextToken value returned from a previous paginated DescribeVolumes request + // where MaxResults was used and the results exceeded the value of that parameter. + // Pagination continues from the end of the previous results that returned the + // NextToken value. This value is null when there are no more results to return. + NextToken *string + + // The volume IDs. + VolumeIds []*string } type DescribeVolumesOutput struct { - // Information about the volumes. - Volumes []*types.Volume - // The NextToken value to include in a future DescribeVolumes request. When the // results of a DescribeVolumes request exceed MaxResults, this value can be used // to retrieve the next page of results. This value is null when there are no more // results to return. NextToken *string + // Information about the volumes. + Volumes []*types.Volume + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeVolumesModifications.go b/service/ec2/api_op_DescribeVolumesModifications.go index 12d7a667a5f..7e417f29ffb 100644 --- a/service/ec2/api_op_DescribeVolumesModifications.go +++ b/service/ec2/api_op_DescribeVolumesModifications.go @@ -65,6 +65,12 @@ func (c *Client) DescribeVolumesModifications(ctx context.Context, params *Descr type DescribeVolumesModificationsInput struct { + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // The filters. // // * modification-state - The current modification state @@ -101,31 +107,25 @@ type DescribeVolumesModificationsInput struct { // of the volume. Filters []*types.Filter - // The nextToken value returned by a previous paginated request. - NextToken *string - - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The maximum number of results (up to a limit of 500) to be returned in a // paginated request. MaxResults *int32 + // The nextToken value returned by a previous paginated request. + NextToken *string + // The IDs of the volumes. VolumeIds []*string } type DescribeVolumesModificationsOutput struct { - // Information about the volume modifications. - VolumesModifications []*types.VolumeModification - // Token for pagination, null if there are no more results NextToken *string + // Information about the volume modifications. + VolumesModifications []*types.VolumeModification + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeVpcAttribute.go b/service/ec2/api_op_DescribeVpcAttribute.go index 6e06eaa44d5..6775c8177a6 100644 --- a/service/ec2/api_op_DescribeVpcAttribute.go +++ b/service/ec2/api_op_DescribeVpcAttribute.go @@ -58,6 +58,11 @@ func (c *Client) DescribeVpcAttribute(ctx context.Context, params *DescribeVpcAt type DescribeVpcAttributeInput struct { + // The VPC attribute. + // + // This member is required. + Attribute types.VpcAttributeName + // The ID of the VPC. // // This member is required. @@ -68,27 +73,22 @@ type DescribeVpcAttributeInput struct { // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The VPC attribute. - // - // This member is required. - Attribute types.VpcAttributeName } type DescribeVpcAttributeOutput struct { - // The ID of the VPC. - VpcId *string + // Indicates whether the instances launched in the VPC get DNS hostnames. If this + // attribute is true, instances in the VPC get DNS hostnames; otherwise, they do + // not. + EnableDnsHostnames *types.AttributeBooleanValue // Indicates whether DNS resolution is enabled for the VPC. If this attribute is // true, the Amazon DNS server resolves DNS hostnames for your instances to their // corresponding IP addresses; otherwise, it does not. EnableDnsSupport *types.AttributeBooleanValue - // Indicates whether the instances launched in the VPC get DNS hostnames. If this - // attribute is true, instances in the VPC get DNS hostnames; otherwise, they do - // not. - EnableDnsHostnames *types.AttributeBooleanValue + // The ID of the VPC. + VpcId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/ec2/api_op_DescribeVpcClassicLink.go b/service/ec2/api_op_DescribeVpcClassicLink.go index f0670c8ebf3..b7cc8f40d59 100644 --- a/service/ec2/api_op_DescribeVpcClassicLink.go +++ b/service/ec2/api_op_DescribeVpcClassicLink.go @@ -56,6 +56,12 @@ func (c *Client) DescribeVpcClassicLink(ctx context.Context, params *DescribeVpc type DescribeVpcClassicLinkInput struct { + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // One or more filters. // // * is-classic-link-enabled - Whether the VPC is enabled @@ -72,12 +78,6 @@ type DescribeVpcClassicLinkInput struct { // key, regardless of the tag value. Filters []*types.Filter - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // One or more VPCs for which you want to describe the ClassicLink status. VpcIds []*string } diff --git a/service/ec2/api_op_DescribeVpcClassicLinkDnsSupport.go b/service/ec2/api_op_DescribeVpcClassicLinkDnsSupport.go index 69dc750c340..028b667e103 100644 --- a/service/ec2/api_op_DescribeVpcClassicLinkDnsSupport.go +++ b/service/ec2/api_op_DescribeVpcClassicLinkDnsSupport.go @@ -67,22 +67,22 @@ type DescribeVpcClassicLinkDnsSupportInput struct { // remaining results, make another call with the returned nextToken value. MaxResults *int32 - // One or more VPC IDs. - VpcIds []*string - // The token for the next page of results. NextToken *string + + // One or more VPC IDs. + VpcIds []*string } type DescribeVpcClassicLinkDnsSupportOutput struct { - // Information about the ClassicLink DNS support status of the VPCs. - Vpcs []*types.ClassicLinkDnsSupport - // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string + // Information about the ClassicLink DNS support status of the VPCs. + Vpcs []*types.ClassicLinkDnsSupport + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeVpcEndpointConnectionNotifications.go b/service/ec2/api_op_DescribeVpcEndpointConnectionNotifications.go index 9f65d8d4df1..f7db491e339 100644 --- a/service/ec2/api_op_DescribeVpcEndpointConnectionNotifications.go +++ b/service/ec2/api_op_DescribeVpcEndpointConnectionNotifications.go @@ -57,6 +57,15 @@ func (c *Client) DescribeVpcEndpointConnectionNotifications(ctx context.Context, type DescribeVpcEndpointConnectionNotificationsInput struct { + // The ID of the notification. + ConnectionNotificationId *string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // One or more filters. // // * connection-notification-arn - The ARN of the SNS @@ -83,15 +92,6 @@ type DescribeVpcEndpointConnectionNotificationsInput struct { // The token to request the next page of results. NextToken *string - - // The ID of the notification. - ConnectionNotificationId *string - - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool } type DescribeVpcEndpointConnectionNotificationsOutput struct { diff --git a/service/ec2/api_op_DescribeVpcEndpointConnections.go b/service/ec2/api_op_DescribeVpcEndpointConnections.go index 14561bbba46..56045dc8cb2 100644 --- a/service/ec2/api_op_DescribeVpcEndpointConnections.go +++ b/service/ec2/api_op_DescribeVpcEndpointConnections.go @@ -57,6 +57,12 @@ func (c *Client) DescribeVpcEndpointConnections(ctx context.Context, params *Des type DescribeVpcEndpointConnectionsInput struct { + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // One or more filters. // // * service-id - The ID of the service. @@ -72,12 +78,6 @@ type DescribeVpcEndpointConnectionsInput struct { // The ID of the endpoint. Filters []*types.Filter - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The maximum number of results to return for the request in a single page. The // remaining results of the initial request can be seen by sending another request // with the returned NextToken value. This value can be between 5 and 1,000; if @@ -90,13 +90,13 @@ type DescribeVpcEndpointConnectionsInput struct { type DescribeVpcEndpointConnectionsOutput struct { - // Information about one or more VPC endpoint connections. - VpcEndpointConnections []*types.VpcEndpointConnection - // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string + // Information about one or more VPC endpoint connections. + VpcEndpointConnections []*types.VpcEndpointConnection + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeVpcEndpointServiceConfigurations.go b/service/ec2/api_op_DescribeVpcEndpointServiceConfigurations.go index 8383ae59f24..f084f17fdf0 100644 --- a/service/ec2/api_op_DescribeVpcEndpointServiceConfigurations.go +++ b/service/ec2/api_op_DescribeVpcEndpointServiceConfigurations.go @@ -84,9 +84,6 @@ type DescribeVpcEndpointServiceConfigurationsInput struct { // assigned a tag with a specific key, regardless of the tag value. Filters []*types.Filter - // The IDs of one or more services. - ServiceIds []*string - // The maximum number of results to return for the request in a single page. The // remaining results of the initial request can be seen by sending another request // with the returned NextToken value. This value can be between 5 and 1,000; if @@ -95,6 +92,9 @@ type DescribeVpcEndpointServiceConfigurationsInput struct { // The token to retrieve the next page of results. NextToken *string + + // The IDs of one or more services. + ServiceIds []*string } type DescribeVpcEndpointServiceConfigurationsOutput struct { diff --git a/service/ec2/api_op_DescribeVpcEndpointServicePermissions.go b/service/ec2/api_op_DescribeVpcEndpointServicePermissions.go index d531fed9ccc..6acf2c6f918 100644 --- a/service/ec2/api_op_DescribeVpcEndpointServicePermissions.go +++ b/service/ec2/api_op_DescribeVpcEndpointServicePermissions.go @@ -58,15 +58,6 @@ func (c *Client) DescribeVpcEndpointServicePermissions(ctx context.Context, para type DescribeVpcEndpointServicePermissionsInput struct { - // One or more filters. - // - // * principal - The ARN of the principal. - // - // * - // principal-type - The principal type (All | Service | OrganizationUnit | Account - // | User | Role). - Filters []*types.Filter - // The ID of the service. // // This member is required. @@ -78,25 +69,34 @@ type DescribeVpcEndpointServicePermissionsInput struct { // UnauthorizedOperation. DryRun *bool - // The token to retrieve the next page of results. - NextToken *string + // One or more filters. + // + // * principal - The ARN of the principal. + // + // * + // principal-type - The principal type (All | Service | OrganizationUnit | Account + // | User | Role). + Filters []*types.Filter // The maximum number of results to return for the request in a single page. The // remaining results of the initial request can be seen by sending another request // with the returned NextToken value. This value can be between 5 and 1,000; if // MaxResults is given a value larger than 1,000, only 1,000 results are returned. MaxResults *int32 + + // The token to retrieve the next page of results. + NextToken *string } type DescribeVpcEndpointServicePermissionsOutput struct { + // Information about one or more allowed principals. + AllowedPrincipals []*types.AllowedPrincipal + // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string - // Information about one or more allowed principals. - AllowedPrincipals []*types.AllowedPrincipal - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeVpcEndpointServices.go b/service/ec2/api_op_DescribeVpcEndpointServices.go index f67d8c6fed6..2309a0b439e 100644 --- a/service/ec2/api_op_DescribeVpcEndpointServices.go +++ b/service/ec2/api_op_DescribeVpcEndpointServices.go @@ -57,9 +57,11 @@ func (c *Client) DescribeVpcEndpointServices(ctx context.Context, params *Descri // Contains the parameters for DescribeVpcEndpointServices. type DescribeVpcEndpointServicesInput struct { - // The token for the next set of items to return. (You received this token from a - // prior call.) - NextToken *string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // One or more filters. // @@ -76,17 +78,15 @@ type DescribeVpcEndpointServicesInput struct { // assigned a tag with a specific key, regardless of the tag value. Filters []*types.Filter - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The maximum number of items to return for this request. The request returns a // token that you can specify in a subsequent call to get the next set of results. // Constraint: If the value is greater than 1,000, we return only 1,000 items. MaxResults *int32 + // The token for the next set of items to return. (You received this token from a + // prior call.) + NextToken *string + // One or more service names. ServiceNames []*string } @@ -94,9 +94,6 @@ type DescribeVpcEndpointServicesInput struct { // Contains the output of DescribeVpcEndpointServices. type DescribeVpcEndpointServicesOutput struct { - // A list of supported services. - ServiceNames []*string - // The token to use when requesting the next set of items. If there are no // additional items to return, the string is empty. NextToken *string @@ -104,6 +101,9 @@ type DescribeVpcEndpointServicesOutput struct { // Information about the service. ServiceDetails []*types.ServiceDetail + // A list of supported services. + ServiceNames []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeVpcEndpoints.go b/service/ec2/api_op_DescribeVpcEndpoints.go index de6dcc87f41..006fca6dbdd 100644 --- a/service/ec2/api_op_DescribeVpcEndpoints.go +++ b/service/ec2/api_op_DescribeVpcEndpoints.go @@ -88,9 +88,6 @@ type DescribeVpcEndpointsInput struct { // the tag value. Filters []*types.Filter - // One or more endpoint IDs. - VpcEndpointIds []*string - // The maximum number of items to return for this request. The request returns a // token that you can specify in a subsequent call to get the next set of results. // Constraint: If the value is greater than 1,000, we return only 1,000 items. @@ -99,6 +96,9 @@ type DescribeVpcEndpointsInput struct { // The token for the next set of items to return. (You received this token from a // prior call.) NextToken *string + + // One or more endpoint IDs. + VpcEndpointIds []*string } // Contains the output of DescribeVpcEndpoints. diff --git a/service/ec2/api_op_DescribeVpcPeeringConnections.go b/service/ec2/api_op_DescribeVpcPeeringConnections.go index 736e88c84fd..45f90139536 100644 --- a/service/ec2/api_op_DescribeVpcPeeringConnections.go +++ b/service/ec2/api_op_DescribeVpcPeeringConnections.go @@ -56,10 +56,6 @@ func (c *Client) DescribeVpcPeeringConnections(ctx context.Context, params *Desc type DescribeVpcPeeringConnectionsInput struct { - // One or more VPC peering connection IDs. Default: Describes all your VPC peering - // connections. - VpcPeeringConnectionIds []*string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -116,17 +112,21 @@ type DescribeVpcPeeringConnectionsInput struct { // The token for the next page of results. NextToken *string + + // One or more VPC peering connection IDs. Default: Describes all your VPC peering + // connections. + VpcPeeringConnectionIds []*string } type DescribeVpcPeeringConnectionsOutput struct { - // Information about the VPC peering connections. - VpcPeeringConnections []*types.VpcPeeringConnection - // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string + // Information about the VPC peering connections. + VpcPeeringConnections []*types.VpcPeeringConnection + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeVpcs.go b/service/ec2/api_op_DescribeVpcs.go index cf87f39679c..218100215bd 100644 --- a/service/ec2/api_op_DescribeVpcs.go +++ b/service/ec2/api_op_DescribeVpcs.go @@ -117,26 +117,26 @@ type DescribeVpcsInput struct { // * vpc-id - The ID of the VPC. Filters []*types.Filter - // The token for the next page of results. - NextToken *string - // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. MaxResults *int32 + // The token for the next page of results. + NextToken *string + // One or more VPC IDs. Default: Describes all your VPCs. VpcIds []*string } type DescribeVpcsOutput struct { - // Information about one or more VPCs. - Vpcs []*types.Vpc - // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string + // Information about one or more VPCs. + Vpcs []*types.Vpc + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DescribeVpnGateways.go b/service/ec2/api_op_DescribeVpnGateways.go index 21652fba660..22306a4f8d3 100644 --- a/service/ec2/api_op_DescribeVpnGateways.go +++ b/service/ec2/api_op_DescribeVpnGateways.go @@ -66,10 +66,6 @@ type DescribeVpnGatewaysInput struct { // UnauthorizedOperation. DryRun *bool - // One or more virtual private gateway IDs. Default: Describes all your virtual - // private gateways. - VpnGatewayIds []*string - // One or more filters. // // * amazon-side-asn - The Autonomous System Number (ASN) @@ -104,6 +100,10 @@ type DescribeVpnGatewaysInput struct { // * // vpn-gateway-id - The ID of the virtual private gateway. Filters []*types.Filter + + // One or more virtual private gateway IDs. Default: Describes all your virtual + // private gateways. + VpnGatewayIds []*string } // Contains the output of DescribeVpnGateways. diff --git a/service/ec2/api_op_DetachClassicLinkVpc.go b/service/ec2/api_op_DetachClassicLinkVpc.go index 02a8a3b56f0..73a74fdb885 100644 --- a/service/ec2/api_op_DetachClassicLinkVpc.go +++ b/service/ec2/api_op_DetachClassicLinkVpc.go @@ -58,6 +58,11 @@ func (c *Client) DetachClassicLinkVpc(ctx context.Context, params *DetachClassic type DetachClassicLinkVpcInput struct { + // The ID of the instance to unlink from the VPC. + // + // This member is required. + InstanceId *string + // The ID of the VPC to which the instance is linked. // // This member is required. @@ -68,11 +73,6 @@ type DetachClassicLinkVpcInput struct { // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The ID of the instance to unlink from the VPC. - // - // This member is required. - InstanceId *string } type DetachClassicLinkVpcOutput struct { diff --git a/service/ec2/api_op_DetachInternetGateway.go b/service/ec2/api_op_DetachInternetGateway.go index b99ceac3c85..4add7dcd28b 100644 --- a/service/ec2/api_op_DetachInternetGateway.go +++ b/service/ec2/api_op_DetachInternetGateway.go @@ -58,12 +58,6 @@ func (c *Client) DetachInternetGateway(ctx context.Context, params *DetachIntern type DetachInternetGatewayInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The ID of the internet gateway. // // This member is required. @@ -73,6 +67,12 @@ type DetachInternetGatewayInput struct { // // This member is required. VpcId *string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool } type DetachInternetGatewayOutput struct { diff --git a/service/ec2/api_op_DetachNetworkInterface.go b/service/ec2/api_op_DetachNetworkInterface.go index 6598f99d53b..fd610a6d545 100644 --- a/service/ec2/api_op_DetachNetworkInterface.go +++ b/service/ec2/api_op_DetachNetworkInterface.go @@ -57,6 +57,11 @@ func (c *Client) DetachNetworkInterface(ctx context.Context, params *DetachNetwo // Contains the parameters for DetachNetworkInterface. type DetachNetworkInterfaceInput struct { + // The ID of the attachment. + // + // This member is required. + AttachmentId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -80,11 +85,6 @@ type DetachNetworkInterfaceInput struct { // detached network interface might still be visible. The instance metadata will // get updated when you stop and start the instance. Force *bool - - // The ID of the attachment. - // - // This member is required. - AttachmentId *string } type DetachNetworkInterfaceOutput struct { diff --git a/service/ec2/api_op_DetachVolume.go b/service/ec2/api_op_DetachVolume.go index 7f8d7168981..7b37f4fd97a 100644 --- a/service/ec2/api_op_DetachVolume.go +++ b/service/ec2/api_op_DetachVolume.go @@ -74,6 +74,9 @@ type DetachVolumeInput struct { // This member is required. VolumeId *string + // The device name. + Device *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -92,32 +95,29 @@ type DetachVolumeInput struct { // The ID of the instance. If you are detaching a Multi-Attach enabled volume, you // must specify an instance ID. InstanceId *string - - // The device name. - Device *string } // Describes volume attachment details. type DetachVolumeOutput struct { - // The ID of the volume. - VolumeId *string - - // The ID of the instance. - InstanceId *string - // The time stamp when the attachment initiated. AttachTime *time.Time + // Indicates whether the EBS volume is deleted on instance termination. + DeleteOnTermination *bool + // The device name. Device *string - // Indicates whether the EBS volume is deleted on instance termination. - DeleteOnTermination *bool + // The ID of the instance. + InstanceId *string // The attachment state of the volume. State types.VolumeAttachmentState + // The ID of the volume. + VolumeId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DetachVpnGateway.go b/service/ec2/api_op_DetachVpnGateway.go index 3e77c13173f..4d251bebd2e 100644 --- a/service/ec2/api_op_DetachVpnGateway.go +++ b/service/ec2/api_op_DetachVpnGateway.go @@ -63,15 +63,15 @@ func (c *Client) DetachVpnGateway(ctx context.Context, params *DetachVpnGatewayI // Contains the parameters for DetachVpnGateway. type DetachVpnGatewayInput struct { - // The ID of the virtual private gateway. + // The ID of the VPC. // // This member is required. - VpnGatewayId *string + VpcId *string - // The ID of the VPC. + // The ID of the virtual private gateway. // // This member is required. - VpcId *string + VpnGatewayId *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the diff --git a/service/ec2/api_op_DisableFastSnapshotRestores.go b/service/ec2/api_op_DisableFastSnapshotRestores.go index 4da32d16a90..e5ebd93596d 100644 --- a/service/ec2/api_op_DisableFastSnapshotRestores.go +++ b/service/ec2/api_op_DisableFastSnapshotRestores.go @@ -58,12 +58,6 @@ func (c *Client) DisableFastSnapshotRestores(ctx context.Context, params *Disabl type DisableFastSnapshotRestoresInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // One or more Availability Zones. For example, us-east-2a. // // This member is required. @@ -73,18 +67,24 @@ type DisableFastSnapshotRestoresInput struct { // // This member is required. SourceSnapshotIds []*string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool } type DisableFastSnapshotRestoresOutput struct { - // Information about the snapshots for which fast snapshot restores could not be - // disabled. - Unsuccessful []*types.DisableFastSnapshotRestoreErrorItem - // Information about the snapshots for which fast snapshot restores were // successfully disabled. Successful []*types.DisableFastSnapshotRestoreSuccessItem + // Information about the snapshots for which fast snapshot restores could not be + // disabled. + Unsuccessful []*types.DisableFastSnapshotRestoreErrorItem + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_DisableTransitGatewayRouteTablePropagation.go b/service/ec2/api_op_DisableTransitGatewayRouteTablePropagation.go index 55e1e5f300f..7ca0d790319 100644 --- a/service/ec2/api_op_DisableTransitGatewayRouteTablePropagation.go +++ b/service/ec2/api_op_DisableTransitGatewayRouteTablePropagation.go @@ -58,12 +58,6 @@ func (c *Client) DisableTransitGatewayRouteTablePropagation(ctx context.Context, type DisableTransitGatewayRouteTablePropagationInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The ID of the attachment. // // This member is required. @@ -73,6 +67,12 @@ type DisableTransitGatewayRouteTablePropagationInput struct { // // This member is required. TransitGatewayRouteTableId *string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool } type DisableTransitGatewayRouteTablePropagationOutput struct { diff --git a/service/ec2/api_op_DisableVgwRoutePropagation.go b/service/ec2/api_op_DisableVgwRoutePropagation.go index 4a6b1c3b946..6928058ae35 100644 --- a/service/ec2/api_op_DisableVgwRoutePropagation.go +++ b/service/ec2/api_op_DisableVgwRoutePropagation.go @@ -58,12 +58,6 @@ func (c *Client) DisableVgwRoutePropagation(ctx context.Context, params *Disable // Contains the parameters for DisableVgwRoutePropagation. type DisableVgwRoutePropagationInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The ID of the virtual private gateway. // // This member is required. @@ -73,6 +67,12 @@ type DisableVgwRoutePropagationInput struct { // // This member is required. RouteTableId *string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool } type DisableVgwRoutePropagationOutput struct { diff --git a/service/ec2/api_op_DisassociateClientVpnTargetNetwork.go b/service/ec2/api_op_DisassociateClientVpnTargetNetwork.go index 2d589fdbf5b..e2e38bf5dea 100644 --- a/service/ec2/api_op_DisassociateClientVpnTargetNetwork.go +++ b/service/ec2/api_op_DisassociateClientVpnTargetNetwork.go @@ -69,12 +69,6 @@ func (c *Client) DisassociateClientVpnTargetNetwork(ctx context.Context, params type DisassociateClientVpnTargetNetworkInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The ID of the target network association. // // This member is required. @@ -84,6 +78,12 @@ type DisassociateClientVpnTargetNetworkInput struct { // // This member is required. ClientVpnEndpointId *string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool } type DisassociateClientVpnTargetNetworkOutput struct { diff --git a/service/ec2/api_op_DisassociateTransitGatewayMulticastDomain.go b/service/ec2/api_op_DisassociateTransitGatewayMulticastDomain.go index 71579deaac5..43238db4eb6 100644 --- a/service/ec2/api_op_DisassociateTransitGatewayMulticastDomain.go +++ b/service/ec2/api_op_DisassociateTransitGatewayMulticastDomain.go @@ -62,14 +62,14 @@ type DisassociateTransitGatewayMulticastDomainInput struct { // UnauthorizedOperation. DryRun *bool - // The ID of the transit gateway multicast domain. - TransitGatewayMulticastDomainId *string + // The IDs of the subnets; + SubnetIds []*string // The ID of the attachment. TransitGatewayAttachmentId *string - // The IDs of the subnets; - SubnetIds []*string + // The ID of the transit gateway multicast domain. + TransitGatewayMulticastDomainId *string } type DisassociateTransitGatewayMulticastDomainOutput struct { diff --git a/service/ec2/api_op_DisassociateTransitGatewayRouteTable.go b/service/ec2/api_op_DisassociateTransitGatewayRouteTable.go index 51ded072074..fe5556e97e3 100644 --- a/service/ec2/api_op_DisassociateTransitGatewayRouteTable.go +++ b/service/ec2/api_op_DisassociateTransitGatewayRouteTable.go @@ -62,16 +62,16 @@ type DisassociateTransitGatewayRouteTableInput struct { // This member is required. TransitGatewayAttachmentId *string + // The ID of the transit gateway route table. + // + // This member is required. + TransitGatewayRouteTableId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The ID of the transit gateway route table. - // - // This member is required. - TransitGatewayRouteTableId *string } type DisassociateTransitGatewayRouteTableOutput struct { diff --git a/service/ec2/api_op_DisassociateVpcCidrBlock.go b/service/ec2/api_op_DisassociateVpcCidrBlock.go index f90a3500dbb..0a56a1f4063 100644 --- a/service/ec2/api_op_DisassociateVpcCidrBlock.go +++ b/service/ec2/api_op_DisassociateVpcCidrBlock.go @@ -69,15 +69,15 @@ type DisassociateVpcCidrBlockInput struct { type DisassociateVpcCidrBlockOutput struct { - // The ID of the VPC. - VpcId *string - // Information about the IPv4 CIDR block association. CidrBlockAssociation *types.VpcCidrBlockAssociation // Information about the IPv6 CIDR block association. Ipv6CidrBlockAssociation *types.VpcIpv6CidrBlockAssociation + // The ID of the VPC. + VpcId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_EnableFastSnapshotRestores.go b/service/ec2/api_op_EnableFastSnapshotRestores.go index 50875b6ce2b..a1698e79ad9 100644 --- a/service/ec2/api_op_EnableFastSnapshotRestores.go +++ b/service/ec2/api_op_EnableFastSnapshotRestores.go @@ -69,17 +69,17 @@ type EnableFastSnapshotRestoresInput struct { // This member is required. AvailabilityZones []*string - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The IDs of one or more snapshots. For example, snap-1234567890abcdef0. You can // specify a snapshot that was shared with you from another AWS account. // // This member is required. SourceSnapshotIds []*string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool } type EnableFastSnapshotRestoresOutput struct { diff --git a/service/ec2/api_op_EnableTransitGatewayRouteTablePropagation.go b/service/ec2/api_op_EnableTransitGatewayRouteTablePropagation.go index 53a9a7d7b3a..901bf2224c2 100644 --- a/service/ec2/api_op_EnableTransitGatewayRouteTablePropagation.go +++ b/service/ec2/api_op_EnableTransitGatewayRouteTablePropagation.go @@ -58,21 +58,21 @@ func (c *Client) EnableTransitGatewayRouteTablePropagation(ctx context.Context, type EnableTransitGatewayRouteTablePropagationInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The ID of the attachment. + // + // This member is required. + TransitGatewayAttachmentId *string // The ID of the propagation route table. // // This member is required. TransitGatewayRouteTableId *string - // The ID of the attachment. - // - // This member is required. - TransitGatewayAttachmentId *string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool } type EnableTransitGatewayRouteTablePropagationOutput struct { diff --git a/service/ec2/api_op_EnableVgwRoutePropagation.go b/service/ec2/api_op_EnableVgwRoutePropagation.go index 6b56cdfaf7b..78ee91862b4 100644 --- a/service/ec2/api_op_EnableVgwRoutePropagation.go +++ b/service/ec2/api_op_EnableVgwRoutePropagation.go @@ -58,12 +58,6 @@ func (c *Client) EnableVgwRoutePropagation(ctx context.Context, params *EnableVg // Contains the parameters for EnableVgwRoutePropagation. type EnableVgwRoutePropagationInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The ID of the virtual private gateway that is attached to a VPC. The virtual // private gateway must be attached to the same VPC that the routing tables are // associated with. @@ -76,6 +70,12 @@ type EnableVgwRoutePropagationInput struct { // // This member is required. RouteTableId *string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool } type EnableVgwRoutePropagationOutput struct { diff --git a/service/ec2/api_op_EnableVolumeIO.go b/service/ec2/api_op_EnableVolumeIO.go index 4de30cc8b8a..45050983654 100644 --- a/service/ec2/api_op_EnableVolumeIO.go +++ b/service/ec2/api_op_EnableVolumeIO.go @@ -57,16 +57,16 @@ func (c *Client) EnableVolumeIO(ctx context.Context, params *EnableVolumeIOInput type EnableVolumeIOInput struct { + // The ID of the volume. + // + // This member is required. + VolumeId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The ID of the volume. - // - // This member is required. - VolumeId *string } type EnableVolumeIOOutput struct { diff --git a/service/ec2/api_op_EnableVpcClassicLink.go b/service/ec2/api_op_EnableVpcClassicLink.go index df94e4166bd..4fc7cf8e053 100644 --- a/service/ec2/api_op_EnableVpcClassicLink.go +++ b/service/ec2/api_op_EnableVpcClassicLink.go @@ -63,16 +63,16 @@ func (c *Client) EnableVpcClassicLink(ctx context.Context, params *EnableVpcClas type EnableVpcClassicLinkInput struct { + // The ID of the VPC. + // + // This member is required. + VpcId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The ID of the VPC. - // - // This member is required. - VpcId *string } type EnableVpcClassicLinkOutput struct { diff --git a/service/ec2/api_op_ExportClientVpnClientCertificateRevocationList.go b/service/ec2/api_op_ExportClientVpnClientCertificateRevocationList.go index f2243010788..f3364167160 100644 --- a/service/ec2/api_op_ExportClientVpnClientCertificateRevocationList.go +++ b/service/ec2/api_op_ExportClientVpnClientCertificateRevocationList.go @@ -72,12 +72,12 @@ type ExportClientVpnClientCertificateRevocationListInput struct { type ExportClientVpnClientCertificateRevocationListOutput struct { - // The current state of the client certificate revocation list. - Status *types.ClientCertificateRevocationListStatus - // Information about the client certificate revocation list. CertificateRevocationList *string + // The current state of the client certificate revocation list. + Status *types.ClientCertificateRevocationListStatus + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_ExportImage.go b/service/ec2/api_op_ExportImage.go index ca4f8dfb323..640986d5b53 100644 --- a/service/ec2/api_op_ExportImage.go +++ b/service/ec2/api_op_ExportImage.go @@ -62,32 +62,15 @@ func (c *Client) ExportImage(ctx context.Context, params *ExportImageInput, optF type ExportImageInput struct { - // The name of the role that grants VM Import/Export permission to export images to - // your Amazon S3 bucket. If this parameter is not specified, the default role is - // named 'vmimport'. - RoleName *string - - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - - // The tags to apply to the image being exported. - TagSpecifications []*types.TagSpecification - - // The ID of the image. + // The disk image format. // // This member is required. - ImageId *string - - // A description of the image being exported. The maximum length is 255 characters. - Description *string + DiskImageFormat types.DiskImageFormat - // The disk image format. + // The ID of the image. // // This member is required. - DiskImageFormat types.DiskImageFormat + ImageId *string // Information about the destination Amazon S3 bucket. The bucket must exist and // grant WRITE and READ_ACP permissions to the AWS account @@ -98,35 +81,42 @@ type ExportImageInput struct { // Token to enable idempotency for export image requests. ClientToken *string -} -type ExportImageOutput struct { + // A description of the image being exported. The maximum length is 255 characters. + Description *string - // The disk image format for the exported image. - DiskImageFormat types.DiskImageFormat + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool - // The status message for the export image task. - StatusMessage *string + // The name of the role that grants VM Import/Export permission to export images to + // your Amazon S3 bucket. If this parameter is not specified, the default role is + // named 'vmimport'. + RoleName *string - // The percent complete of the export image task. - Progress *string + // The tags to apply to the image being exported. + TagSpecifications []*types.TagSpecification +} + +type ExportImageOutput struct { // A description of the image being exported. Description *string + // The disk image format for the exported image. + DiskImageFormat types.DiskImageFormat + // The ID of the export image task. ExportImageTaskId *string - // The status of the export image task. The possible values are active, completed, - // deleting, and deleted. - Status *string - - // Any tags assigned to the image being exported. - Tags []*types.Tag - // The ID of the image. ImageId *string + // The percent complete of the export image task. + Progress *string + // The name of the role that grants VM Import/Export permission to export images to // your Amazon S3 bucket. RoleName *string @@ -134,6 +124,16 @@ type ExportImageOutput struct { // Information about the destination Amazon S3 bucket. S3ExportLocation *types.ExportTaskS3Location + // The status of the export image task. The possible values are active, completed, + // deleting, and deleted. + Status *string + + // The status message for the export image task. + StatusMessage *string + + // Any tags assigned to the image being exported. + Tags []*types.Tag + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_ExportTransitGatewayRoutes.go b/service/ec2/api_op_ExportTransitGatewayRoutes.go index 7a7c413a3bd..81ef41f977c 100644 --- a/service/ec2/api_op_ExportTransitGatewayRoutes.go +++ b/service/ec2/api_op_ExportTransitGatewayRoutes.go @@ -67,6 +67,11 @@ type ExportTransitGatewayRoutesInput struct { // This member is required. S3Bucket *string + // The ID of the route table. + // + // This member is required. + TransitGatewayRouteTableId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -107,11 +112,6 @@ type ExportTransitGatewayRoutesInput struct { // * type - The // type of route (active | blackhole). Filters []*types.Filter - - // The ID of the route table. - // - // This member is required. - TransitGatewayRouteTableId *string } type ExportTransitGatewayRoutesOutput struct { diff --git a/service/ec2/api_op_GetAssociatedIpv6PoolCidrs.go b/service/ec2/api_op_GetAssociatedIpv6PoolCidrs.go index 1a896a7c7df..e9c8d156c3c 100644 --- a/service/ec2/api_op_GetAssociatedIpv6PoolCidrs.go +++ b/service/ec2/api_op_GetAssociatedIpv6PoolCidrs.go @@ -63,29 +63,29 @@ type GetAssociatedIpv6PoolCidrsInput struct { // This member is required. PoolId *string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. MaxResults *int32 // The token for the next page of results. NextToken *string - - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool } type GetAssociatedIpv6PoolCidrsOutput struct { + // Information about the IPv6 CIDR block associations. + Ipv6CidrAssociations []*types.Ipv6CidrAssociation + // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string - // Information about the IPv6 CIDR block associations. - Ipv6CidrAssociations []*types.Ipv6CidrAssociation - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_GetCapacityReservationUsage.go b/service/ec2/api_op_GetCapacityReservationUsage.go index 26708e83823..43c4bdef6c6 100644 --- a/service/ec2/api_op_GetCapacityReservationUsage.go +++ b/service/ec2/api_op_GetCapacityReservationUsage.go @@ -65,6 +65,12 @@ type GetCapacityReservationUsageInput struct { // This member is required. CapacityReservationId *string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // The maximum number of results to return for the request in a single page. The // remaining results can be seen by sending another request with the returned // nextToken value. This value can be between 5 and 500. If maxResults is given a @@ -74,18 +80,13 @@ type GetCapacityReservationUsageInput struct { // The token to use to retrieve the next page of results. NextToken *string - - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool } type GetCapacityReservationUsageOutput struct { - // The number of instances for which the Capacity Reservation reserves capacity. - TotalInstanceCount *int32 + // The remaining capacity. Indicates the number of instances that can be launched + // in the Capacity Reservation. + AvailableInstanceCount *int32 // The ID of the Capacity Reservation. CapacityReservationId *string @@ -93,6 +94,13 @@ type GetCapacityReservationUsageOutput struct { // The type of instance for which the Capacity Reservation reserves capacity. InstanceType *string + // Information about the Capacity Reservation usage. + InstanceUsages []*types.InstanceUsage + + // The token to use to retrieve the next page of results. This value is null when + // there are no more results to return. + NextToken *string + // The current state of the Capacity Reservation. A Capacity Reservation can be in // one of the following states: // @@ -116,16 +124,8 @@ type GetCapacityReservationUsageOutput struct { // limit constraints. Failed requests are retained for 60 minutes. State types.CapacityReservationState - // The remaining capacity. Indicates the number of instances that can be launched - // in the Capacity Reservation. - AvailableInstanceCount *int32 - - // Information about the Capacity Reservation usage. - InstanceUsages []*types.InstanceUsage - - // The token to use to retrieve the next page of results. This value is null when - // there are no more results to return. - NextToken *string + // The number of instances for which the Capacity Reservation reserves capacity. + TotalInstanceCount *int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/ec2/api_op_GetCoipPoolUsage.go b/service/ec2/api_op_GetCoipPoolUsage.go index 5c2f6eeacfa..06b819cc298 100644 --- a/service/ec2/api_op_GetCoipPoolUsage.go +++ b/service/ec2/api_op_GetCoipPoolUsage.go @@ -62,6 +62,12 @@ type GetCoipPoolUsageInput struct { // This member is required. PoolId *string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // The filters. The following are the possible values: // // * @@ -75,18 +81,12 @@ type GetCoipPoolUsageInput struct { // * coip-address-usage.co-ip Filters []*types.Filter - // The token for the next page of results. - NextToken *string - - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. MaxResults *int32 + + // The token for the next page of results. + NextToken *string } type GetCoipPoolUsageOutput struct { @@ -94,12 +94,12 @@ type GetCoipPoolUsageOutput struct { // Information about the address usage. CoipAddressUsages []*types.CoipAddressUsage - // The ID of the local gateway route table. - LocalGatewayRouteTableId *string - // The ID of the customer-owned address pool. CoipPoolId *string + // The ID of the local gateway route table. + LocalGatewayRouteTableId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_GetConsoleOutput.go b/service/ec2/api_op_GetConsoleOutput.go index b64f369cf3c..ff8453fdab6 100644 --- a/service/ec2/api_op_GetConsoleOutput.go +++ b/service/ec2/api_op_GetConsoleOutput.go @@ -69,10 +69,6 @@ func (c *Client) GetConsoleOutput(ctx context.Context, params *GetConsoleOutputI type GetConsoleOutputInput struct { - // When enabled, retrieves the latest console output for the instance. Default: - // disabled (false) - Latest *bool - // The ID of the instance. // // This member is required. @@ -83,17 +79,21 @@ type GetConsoleOutputInput struct { // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // When enabled, retrieves the latest console output for the instance. Default: + // disabled (false) + Latest *bool } type GetConsoleOutputOutput struct { + // The ID of the instance. + InstanceId *string + // The console output, base64-encoded. If you are using a command line tool, the // tool decodes the output for you. Output *string - // The ID of the instance. - InstanceId *string - // The time at which the output was last updated. Timestamp *time.Time diff --git a/service/ec2/api_op_GetConsoleScreenshot.go b/service/ec2/api_op_GetConsoleScreenshot.go index ca4a26214b8..e095f58a59f 100644 --- a/service/ec2/api_op_GetConsoleScreenshot.go +++ b/service/ec2/api_op_GetConsoleScreenshot.go @@ -57,17 +57,17 @@ func (c *Client) GetConsoleScreenshot(ctx context.Context, params *GetConsoleScr type GetConsoleScreenshotInput struct { + // The ID of the instance. + // + // This member is required. + InstanceId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // The ID of the instance. - // - // This member is required. - InstanceId *string - // When set to true, acts as keystroke input and wakes up an instance that's in // standby or "sleep" mode. WakeUp *bool @@ -75,12 +75,12 @@ type GetConsoleScreenshotInput struct { type GetConsoleScreenshotOutput struct { - // The ID of the instance. - InstanceId *string - // The data that comprises the image. ImageData *string + // The ID of the instance. + InstanceId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_GetGroupsForCapacityReservation.go b/service/ec2/api_op_GetGroupsForCapacityReservation.go index 37902d85bb6..d7cf6cff8a2 100644 --- a/service/ec2/api_op_GetGroupsForCapacityReservation.go +++ b/service/ec2/api_op_GetGroupsForCapacityReservation.go @@ -57,25 +57,25 @@ func (c *Client) GetGroupsForCapacityReservation(ctx context.Context, params *Ge type GetGroupsForCapacityReservationInput struct { + // The ID of the Capacity Reservation. + // + // This member is required. + CapacityReservationId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // The token to use to retrieve the next page of results. - NextToken *string - // The maximum number of results to return for the request in a single page. The // remaining results can be seen by sending another request with the returned // nextToken value. This value can be between 5 and 500. If maxResults is given a // larger value than 500, you receive an error. MaxResults *int32 - // The ID of the Capacity Reservation. - // - // This member is required. - CapacityReservationId *string + // The token to use to retrieve the next page of results. + NextToken *string } type GetGroupsForCapacityReservationOutput struct { diff --git a/service/ec2/api_op_GetHostReservationPurchasePreview.go b/service/ec2/api_op_GetHostReservationPurchasePreview.go index 93d04b191a2..3aabc0bef97 100644 --- a/service/ec2/api_op_GetHostReservationPurchasePreview.go +++ b/service/ec2/api_op_GetHostReservationPurchasePreview.go @@ -77,13 +77,13 @@ type GetHostReservationPurchasePreviewOutput struct { // specified. At this time, the only supported currency is USD. CurrencyCode types.CurrencyCodeValues - // The potential total hourly price of the reservation per hour. - TotalHourlyPrice *string - // The purchase information of the Dedicated Host reservation and the Dedicated // Hosts associated with it. Purchase []*types.Purchase + // The potential total hourly price of the reservation per hour. + TotalHourlyPrice *string + // The potential total upfront price. This is billed immediately. TotalUpfrontPrice *string diff --git a/service/ec2/api_op_GetManagedPrefixListAssociations.go b/service/ec2/api_op_GetManagedPrefixListAssociations.go index 9335a4c7011..4755b13f397 100644 --- a/service/ec2/api_op_GetManagedPrefixListAssociations.go +++ b/service/ec2/api_op_GetManagedPrefixListAssociations.go @@ -58,34 +58,34 @@ func (c *Client) GetManagedPrefixListAssociations(ctx context.Context, params *G type GetManagedPrefixListAssociationsInput struct { + // The ID of the prefix list. + // + // This member is required. + PrefixListId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // The token for the next page of results. - NextToken *string - // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. MaxResults *int32 - // The ID of the prefix list. - // - // This member is required. - PrefixListId *string + // The token for the next page of results. + NextToken *string } type GetManagedPrefixListAssociationsOutput struct { - // Information about the associations. - PrefixListAssociations []*types.PrefixListAssociation - // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string + // Information about the associations. + PrefixListAssociations []*types.PrefixListAssociation + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_GetManagedPrefixListEntries.go b/service/ec2/api_op_GetManagedPrefixListEntries.go index a486cb17bc2..bf3bca9c900 100644 --- a/service/ec2/api_op_GetManagedPrefixListEntries.go +++ b/service/ec2/api_op_GetManagedPrefixListEntries.go @@ -57,17 +57,6 @@ func (c *Client) GetManagedPrefixListEntries(ctx context.Context, params *GetMan type GetManagedPrefixListEntriesInput struct { - // The version of the prefix list for which to return the entries. The default is - // the current version. - TargetVersion *int64 - - // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. - MaxResults *int32 - - // The token for the next page of results. - NextToken *string - // The ID of the prefix list. // // This member is required. @@ -78,6 +67,17 @@ type GetManagedPrefixListEntriesInput struct { // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int32 + + // The token for the next page of results. + NextToken *string + + // The version of the prefix list for which to return the entries. The default is + // the current version. + TargetVersion *int64 } type GetManagedPrefixListEntriesOutput struct { diff --git a/service/ec2/api_op_GetPasswordData.go b/service/ec2/api_op_GetPasswordData.go index fbac4590878..5d9d4397bfe 100644 --- a/service/ec2/api_op_GetPasswordData.go +++ b/service/ec2/api_op_GetPasswordData.go @@ -88,13 +88,13 @@ type GetPasswordDataOutput struct { // The ID of the Windows instance. InstanceId *string - // The time the data was last updated. - Timestamp *time.Time - // The password of the instance. Returns an empty string if the password is not // available. PasswordData *string + // The time the data was last updated. + Timestamp *time.Time + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_GetReservedInstancesExchangeQuote.go b/service/ec2/api_op_GetReservedInstancesExchangeQuote.go index 947181c800f..623c816d21a 100644 --- a/service/ec2/api_op_GetReservedInstancesExchangeQuote.go +++ b/service/ec2/api_op_GetReservedInstancesExchangeQuote.go @@ -62,6 +62,11 @@ func (c *Client) GetReservedInstancesExchangeQuote(ctx context.Context, params * // Contains the parameters for GetReservedInstanceExchangeQuote. type GetReservedInstancesExchangeQuoteInput struct { + // The IDs of the Convertible Reserved Instances to exchange. + // + // This member is required. + ReservedInstanceIds []*string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -71,42 +76,37 @@ type GetReservedInstancesExchangeQuoteInput struct { // The configuration of the target Convertible Reserved Instance to exchange for // your current Convertible Reserved Instances. TargetConfigurations []*types.TargetConfigurationRequest - - // The IDs of the Convertible Reserved Instances to exchange. - // - // This member is required. - ReservedInstanceIds []*string } // Contains the output of GetReservedInstancesExchangeQuote. type GetReservedInstancesExchangeQuoteOutput struct { + // The currency of the transaction. + CurrencyCode *string + // If true, the exchange is valid. If false, the exchange cannot be completed. IsValidExchange *bool - // The configuration of your Convertible Reserved Instances. - ReservedInstanceValueSet []*types.ReservedInstanceReservationValue - - // The values of the target Convertible Reserved Instances. - TargetConfigurationValueSet []*types.TargetReservationValue - // The new end date of the reservation term. OutputReservedInstancesWillExpireAt *time.Time + // The total true upfront charge for the exchange. + PaymentDue *string + // The cost associated with the Reserved Instance. - TargetConfigurationValueRollup *types.ReservationValue + ReservedInstanceValueRollup *types.ReservationValue - // Describes the reason why the exchange cannot be completed. - ValidationFailureReason *string + // The configuration of your Convertible Reserved Instances. + ReservedInstanceValueSet []*types.ReservedInstanceReservationValue // The cost associated with the Reserved Instance. - ReservedInstanceValueRollup *types.ReservationValue + TargetConfigurationValueRollup *types.ReservationValue - // The currency of the transaction. - CurrencyCode *string + // The values of the target Convertible Reserved Instances. + TargetConfigurationValueSet []*types.TargetReservationValue - // The total true upfront charge for the exchange. - PaymentDue *string + // Describes the reason why the exchange cannot be completed. + ValidationFailureReason *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/ec2/api_op_GetTransitGatewayAttachmentPropagations.go b/service/ec2/api_op_GetTransitGatewayAttachmentPropagations.go index 6c03f066763..052feaf91be 100644 --- a/service/ec2/api_op_GetTransitGatewayAttachmentPropagations.go +++ b/service/ec2/api_op_GetTransitGatewayAttachmentPropagations.go @@ -69,29 +69,29 @@ type GetTransitGatewayAttachmentPropagationsInput struct { // UnauthorizedOperation. DryRun *bool + // One or more filters. The possible values are: + // + // * + // transit-gateway-route-table-id - The ID of the transit gateway route table. + Filters []*types.Filter + // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. MaxResults *int32 // The token for the next page of results. NextToken *string - - // One or more filters. The possible values are: - // - // * - // transit-gateway-route-table-id - The ID of the transit gateway route table. - Filters []*types.Filter } type GetTransitGatewayAttachmentPropagationsOutput struct { - // Information about the propagation route tables. - TransitGatewayAttachmentPropagations []*types.TransitGatewayAttachmentPropagation - // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string + // Information about the propagation route tables. + TransitGatewayAttachmentPropagations []*types.TransitGatewayAttachmentPropagation + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_GetTransitGatewayMulticastDomainAssociations.go b/service/ec2/api_op_GetTransitGatewayMulticastDomainAssociations.go index dc4165d150c..ca933ae4fe6 100644 --- a/service/ec2/api_op_GetTransitGatewayMulticastDomainAssociations.go +++ b/service/ec2/api_op_GetTransitGatewayMulticastDomainAssociations.go @@ -57,16 +57,6 @@ func (c *Client) GetTransitGatewayMulticastDomainAssociations(ctx context.Contex type GetTransitGatewayMulticastDomainAssociationsInput struct { - // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. - MaxResults *int32 - - // The ID of the transit gateway multicast domain. - TransitGatewayMulticastDomainId *string - - // The token for the next page of results. - NextToken *string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -88,6 +78,16 @@ type GetTransitGatewayMulticastDomainAssociationsInput struct { // transit-gateway-attachment-id - The id of the transit gateway // attachment.

    Filters []*types.Filter + + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int32 + + // The token for the next page of results. + NextToken *string + + // The ID of the transit gateway multicast domain. + TransitGatewayMulticastDomainId *string } type GetTransitGatewayMulticastDomainAssociationsOutput struct { diff --git a/service/ec2/api_op_GetTransitGatewayRouteTableAssociations.go b/service/ec2/api_op_GetTransitGatewayRouteTableAssociations.go index 8b9bd7a852b..006fd503214 100644 --- a/service/ec2/api_op_GetTransitGatewayRouteTableAssociations.go +++ b/service/ec2/api_op_GetTransitGatewayRouteTableAssociations.go @@ -58,6 +58,17 @@ func (c *Client) GetTransitGatewayRouteTableAssociations(ctx context.Context, pa type GetTransitGatewayRouteTableAssociationsInput struct { + // The ID of the transit gateway route table. + // + // This member is required. + TransitGatewayRouteTableId *string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // One or more filters. The possible values are: // // * resource-id - The ID of the @@ -69,34 +80,23 @@ type GetTransitGatewayRouteTableAssociationsInput struct { // transit-gateway-attachment-id - The ID of the attachment. Filters []*types.Filter - // The ID of the transit gateway route table. - // - // This member is required. - TransitGatewayRouteTableId *string - // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. MaxResults *int32 - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The token for the next page of results. NextToken *string } type GetTransitGatewayRouteTableAssociationsOutput struct { + // Information about the associations. + Associations []*types.TransitGatewayRouteTableAssociation + // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string - // Information about the associations. - Associations []*types.TransitGatewayRouteTableAssociation - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_GetTransitGatewayRouteTablePropagations.go b/service/ec2/api_op_GetTransitGatewayRouteTablePropagations.go index b924f9f8964..bd119bad1c1 100644 --- a/service/ec2/api_op_GetTransitGatewayRouteTablePropagations.go +++ b/service/ec2/api_op_GetTransitGatewayRouteTablePropagations.go @@ -63,19 +63,12 @@ type GetTransitGatewayRouteTablePropagationsInput struct { // This member is required. TransitGatewayRouteTableId *string - // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. - MaxResults *int32 - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // The token for the next page of results. - NextToken *string - // One or more filters. The possible values are: // // * resource-id - The ID of the @@ -86,6 +79,13 @@ type GetTransitGatewayRouteTablePropagationsInput struct { // * // transit-gateway-attachment-id - The ID of the attachment. Filters []*types.Filter + + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int32 + + // The token for the next page of results. + NextToken *string } type GetTransitGatewayRouteTablePropagationsOutput struct { diff --git a/service/ec2/api_op_ImportClientVpnClientCertificateRevocationList.go b/service/ec2/api_op_ImportClientVpnClientCertificateRevocationList.go index 1abcbf1dc60..dd6c4eb1772 100644 --- a/service/ec2/api_op_ImportClientVpnClientCertificateRevocationList.go +++ b/service/ec2/api_op_ImportClientVpnClientCertificateRevocationList.go @@ -59,6 +59,14 @@ func (c *Client) ImportClientVpnClientCertificateRevocationList(ctx context.Cont type ImportClientVpnClientCertificateRevocationListInput struct { + // The client certificate revocation list file. For more information, see Generate + // a Client Certificate Revocation List + // (https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-certificates.html#cvpn-working-certificates-generate) + // in the AWS Client VPN Administrator Guide. + // + // This member is required. + CertificateRevocationList *string + // The ID of the Client VPN endpoint to which the client certificate revocation // list applies. // @@ -70,14 +78,6 @@ type ImportClientVpnClientCertificateRevocationListInput struct { // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The client certificate revocation list file. For more information, see Generate - // a Client Certificate Revocation List - // (https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-certificates.html#cvpn-working-certificates-generate) - // in the AWS Client VPN Administrator Guide. - // - // This member is required. - CertificateRevocationList *string } type ImportClientVpnClientCertificateRevocationListOutput struct { diff --git a/service/ec2/api_op_ImportImage.go b/service/ec2/api_op_ImportImage.go index 95059643a39..519d017a351 100644 --- a/service/ec2/api_op_ImportImage.go +++ b/service/ec2/api_op_ImportImage.go @@ -60,8 +60,37 @@ func (c *Client) ImportImage(ctx context.Context, params *ImportImageInput, optF type ImportImageInput struct { - // The ARNs of the license configurations. - LicenseSpecifications []*types.ImportImageLicenseConfigurationRequest + // The architecture of the virtual machine. Valid values: i386 | x86_64 | arm64 + Architecture *string + + // The client-specific data. + ClientData *types.ClientData + + // The token to enable idempotency for VM import requests. + ClientToken *string + + // A description string for the import image task. + Description *string + + // Information about the disk containers. + DiskContainers []*types.ImageDiskContainer + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + + // Specifies whether the destination AMI of the imported image should be encrypted. + // The default CMK for EBS is used unless you specify a non-default AWS Key + // Management Service (AWS KMS) CMK using KmsKeyId. For more information, see + // Amazon EBS Encryption + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the + // Amazon Elastic Compute Cloud User Guide. + Encrypted *bool + + // The target hypervisor platform. Valid values: xen + Hypervisor *string // An identifier for the symmetric AWS Key Management Service (AWS KMS) customer // master key (CMK) to use when creating the encrypted AMI. This parameter is only @@ -96,35 +125,8 @@ type ImportImageInput struct { // to. Amazon EBS does not support asymmetric CMKs. KmsKeyId *string - // The operating system of the virtual machine. Valid values: Windows | Linux - Platform *string - - // The tags to apply to the image being imported. - TagSpecifications []*types.TagSpecification - - // The architecture of the virtual machine. Valid values: i386 | x86_64 | arm64 - Architecture *string - - // The token to enable idempotency for VM import requests. - ClientToken *string - - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - - // A description string for the import image task. - Description *string - - // The client-specific data. - ClientData *types.ClientData - - // The name of the role to use when not using the default role, 'vmimport'. - RoleName *string - - // Information about the disk containers. - DiskContainers []*types.ImageDiskContainer + // The ARNs of the license configurations. + LicenseSpecifications []*types.ImportImageLicenseConfigurationRequest // The license type to be used for the Amazon Machine Image (AMI) after importing. // By default, we detect the source-system operating system (OS) and apply the @@ -137,65 +139,63 @@ type ImportImageInput struct { // in the VM Import/Export User Guide. LicenseType *string - // Specifies whether the destination AMI of the imported image should be encrypted. - // The default CMK for EBS is used unless you specify a non-default AWS Key - // Management Service (AWS KMS) CMK using KmsKeyId. For more information, see - // Amazon EBS Encryption - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the - // Amazon Elastic Compute Cloud User Guide. - Encrypted *bool + // The operating system of the virtual machine. Valid values: Windows | Linux + Platform *string - // The target hypervisor platform. Valid values: xen - Hypervisor *string + // The name of the role to use when not using the default role, 'vmimport'. + RoleName *string + + // The tags to apply to the image being imported. + TagSpecifications []*types.TagSpecification } type ImportImageOutput struct { - // The ID of the Amazon Machine Image (AMI) created by the import task. - ImageId *string - - // Any tags assigned to the image being imported. - Tags []*types.Tag - - // The ARNs of the license configurations. - LicenseSpecifications []*types.ImportImageLicenseConfigurationResponse - // The architecture of the virtual machine. Architecture *string - // A brief status of the task. - Status *string - // A description of the import task. Description *string + // Indicates whether the AMI is encrypted. + Encrypted *bool + // The target hypervisor of the import task. Hypervisor *string + // The ID of the Amazon Machine Image (AMI) created by the import task. + ImageId *string + + // The task ID of the import image task. + ImportTaskId *string + // The identifier for the symmetric AWS Key Management Service (AWS KMS) customer // master key (CMK) that was used to create the encrypted AMI. KmsKeyId *string + // The ARNs of the license configurations. + LicenseSpecifications []*types.ImportImageLicenseConfigurationResponse + // The license type of the virtual machine. LicenseType *string // The operating system of the virtual machine. Platform *string - // Indicates whether the AMI is encrypted. - Encrypted *bool + // The progress of the task. + Progress *string // Information about the snapshots. SnapshotDetails []*types.SnapshotDetail - // The progress of the task. - Progress *string + // A brief status of the task. + Status *string // A detailed status message of the import task. StatusMessage *string - // The task ID of the import image task. - ImportTaskId *string + // Any tags assigned to the image being imported. + Tags []*types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/ec2/api_op_ImportInstance.go b/service/ec2/api_op_ImportInstance.go index fd75a6825b9..b1225199a17 100644 --- a/service/ec2/api_op_ImportInstance.go +++ b/service/ec2/api_op_ImportInstance.go @@ -64,9 +64,17 @@ func (c *Client) ImportInstance(ctx context.Context, params *ImportInstanceInput type ImportInstanceInput struct { + // The instance operating system. + // + // This member is required. + Platform types.PlatformValues + // A description for the instance being imported. Description *string + // The disk image. + DiskImages []*types.DiskImage + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -75,14 +83,6 @@ type ImportInstanceInput struct { // The launch specification. LaunchSpecification *types.ImportInstanceLaunchSpecification - - // The disk image. - DiskImages []*types.DiskImage - - // The instance operating system. - // - // This member is required. - Platform types.PlatformValues } type ImportInstanceOutput struct { diff --git a/service/ec2/api_op_ImportKeyPair.go b/service/ec2/api_op_ImportKeyPair.go index ab132ffaf9d..e5aa9b61332 100644 --- a/service/ec2/api_op_ImportKeyPair.go +++ b/service/ec2/api_op_ImportKeyPair.go @@ -69,6 +69,12 @@ type ImportKeyPairInput struct { // This member is required. KeyName *string + // The public key. For API calls, the text must be base64-encoded. For command line + // tools, base64 encoding is performed for you. + // + // This member is required. + PublicKeyMaterial []byte + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -77,27 +83,21 @@ type ImportKeyPairInput struct { // The tags to apply to the imported key pair. TagSpecifications []*types.TagSpecification - - // The public key. For API calls, the text must be base64-encoded. For command line - // tools, base64 encoding is performed for you. - // - // This member is required. - PublicKeyMaterial []byte } type ImportKeyPairOutput struct { + // The MD5 public key fingerprint as specified in section 4 of RFC 4716. + KeyFingerprint *string + // The key pair name you provided. KeyName *string - // The tags applied to the imported key pair. - Tags []*types.Tag - // The ID of the resulting key pair. KeyPairId *string - // The MD5 public key fingerprint as specified in section 4 of RFC 4716. - KeyFingerprint *string + // The tags applied to the imported key pair. + Tags []*types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/ec2/api_op_ImportSnapshot.go b/service/ec2/api_op_ImportSnapshot.go index 46cd9285b2e..fe2c109d2f7 100644 --- a/service/ec2/api_op_ImportSnapshot.go +++ b/service/ec2/api_op_ImportSnapshot.go @@ -56,15 +56,15 @@ func (c *Client) ImportSnapshot(ctx context.Context, params *ImportSnapshotInput type ImportSnapshotInput struct { - // The name of the role to use when not using the default role, 'vmimport'. - RoleName *string - - // The description string for the import snapshot task. - Description *string + // The client-specific data. + ClientData *types.ClientData // Token to enable idempotency for VM import requests. ClientToken *string + // The description string for the import snapshot task. + Description *string + // Information about the disk container. DiskContainer *types.SnapshotDiskContainer @@ -74,12 +74,6 @@ type ImportSnapshotInput struct { // UnauthorizedOperation. DryRun *bool - // The tags to apply to the snapshot being imported. - TagSpecifications []*types.TagSpecification - - // The client-specific data. - ClientData *types.ClientData - // Specifies whether the destination snapshot of the imported image should be // encrypted. The default CMK for EBS is used unless you specify a non-default AWS // Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see @@ -120,6 +114,12 @@ type ImportSnapshotInput struct { // failure. The specified CMK must exist in the Region that the snapshot is being // copied to. Amazon EBS does not support asymmetric CMKs. KmsKeyId *string + + // The name of the role to use when not using the default role, 'vmimport'. + RoleName *string + + // The tags to apply to the snapshot being imported. + TagSpecifications []*types.TagSpecification } type ImportSnapshotOutput struct { @@ -127,14 +127,14 @@ type ImportSnapshotOutput struct { // A description of the import snapshot task. Description *string - // Any tags assigned to the snapshot being imported. - Tags []*types.Tag + // The ID of the import snapshot task. + ImportTaskId *string // Information about the import snapshot task. SnapshotTaskDetail *types.SnapshotTaskDetail - // The ID of the import snapshot task. - ImportTaskId *string + // Any tags assigned to the snapshot being imported. + Tags []*types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/ec2/api_op_ImportVolume.go b/service/ec2/api_op_ImportVolume.go index 0839977ce55..aacc26d0bf2 100644 --- a/service/ec2/api_op_ImportVolume.go +++ b/service/ec2/api_op_ImportVolume.go @@ -67,24 +67,24 @@ type ImportVolumeInput struct { // This member is required. AvailabilityZone *string - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - - // A description of the volume. - Description *string + // The disk image. + // + // This member is required. + Image *types.DiskImageDetail // The volume size. // // This member is required. Volume *types.VolumeDetail - // The disk image. - // - // This member is required. - Image *types.DiskImageDetail + // A description of the volume. + Description *string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool } type ImportVolumeOutput struct { diff --git a/service/ec2/api_op_ModifyAvailabilityZoneGroup.go b/service/ec2/api_op_ModifyAvailabilityZoneGroup.go index c6a28866793..ef58e4b0d09 100644 --- a/service/ec2/api_op_ModifyAvailabilityZoneGroup.go +++ b/service/ec2/api_op_ModifyAvailabilityZoneGroup.go @@ -60,6 +60,11 @@ func (c *Client) ModifyAvailabilityZoneGroup(ctx context.Context, params *Modify type ModifyAvailabilityZoneGroupInput struct { + // The name of the Availability Zone Group. + // + // This member is required. + GroupName *string + // Indicates whether to enable or disable membership. The valid values are // opted-in. You must contact AWS Support // (https://console.aws.amazon.com/support/home#/case/create%3FissueType=customer-service%26serviceCode=general-info%26getting-started%26categoryCode=using-aws%26services) @@ -73,11 +78,6 @@ type ModifyAvailabilityZoneGroupInput struct { // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The name of the Availability Zone Group. - // - // This member is required. - GroupName *string } type ModifyAvailabilityZoneGroupOutput struct { diff --git a/service/ec2/api_op_ModifyCapacityReservation.go b/service/ec2/api_op_ModifyCapacityReservation.go index 5cb7e2616c7..a633e04bc69 100644 --- a/service/ec2/api_op_ModifyCapacityReservation.go +++ b/service/ec2/api_op_ModifyCapacityReservation.go @@ -63,6 +63,17 @@ func (c *Client) ModifyCapacityReservation(ctx context.Context, params *ModifyCa type ModifyCapacityReservationInput struct { + // The ID of the Capacity Reservation. + // + // This member is required. + CapacityReservationId *string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // The date and time at which the Capacity Reservation expires. When a Capacity // Reservation expires, the reserved capacity is released and you can no longer // launch instances into it. The Capacity Reservation's state changes to expired @@ -73,15 +84,6 @@ type ModifyCapacityReservationInput struct { // limited. Omit EndDate if EndDateType is unlimited. EndDate *time.Time - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - - // The number of instances for which to reserve capacity. - InstanceCount *int32 - // Indicates the way in which the Capacity Reservation ends. A Capacity Reservation // can have one of the following end types: // @@ -94,10 +96,8 @@ type ModifyCapacityReservationInput struct { // an EndDate value if EndDateType is limited. EndDateType types.EndDateType - // The ID of the Capacity Reservation. - // - // This member is required. - CapacityReservationId *string + // The number of instances for which to reserve capacity. + InstanceCount *int32 } type ModifyCapacityReservationOutput struct { diff --git a/service/ec2/api_op_ModifyClientVpnEndpoint.go b/service/ec2/api_op_ModifyClientVpnEndpoint.go index 734d1a835a2..170851dfbd4 100644 --- a/service/ec2/api_op_ModifyClientVpnEndpoint.go +++ b/service/ec2/api_op_ModifyClientVpnEndpoint.go @@ -58,21 +58,10 @@ func (c *Client) ModifyClientVpnEndpoint(ctx context.Context, params *ModifyClie type ModifyClientVpnEndpointInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - - // The port number to assign to the Client VPN endpoint for TCP and UDP traffic. - // Valid Values: 443 | 1194 Default Value: 443 - VpnPort *int32 - - // The IDs of one or more security groups to apply to the target network. - SecurityGroupIds []*string - - // A brief description of the Client VPN endpoint. - Description *string + // The ID of the Client VPN endpoint to modify. + // + // This member is required. + ClientVpnEndpointId *string // Information about the client connection logging options. If you enable client // connection logging, data about client connections is sent to a Cloudwatch Logs @@ -90,14 +79,26 @@ type ModifyClientVpnEndpointInput struct { // termination time ConnectionLogOptions *types.ConnectionLogOptions - // The ARN of the server certificate to be used. The server certificate must be - // provisioned in AWS Certificate Manager (ACM). - ServerCertificateArn *string + // A brief description of the Client VPN endpoint. + Description *string // Information about the DNS servers to be used by Client VPN connections. A Client // VPN endpoint can have up to two DNS servers. DnsServers *types.DnsServersOptionsModifyStructure + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + + // The IDs of one or more security groups to apply to the target network. + SecurityGroupIds []*string + + // The ARN of the server certificate to be used. The server certificate must be + // provisioned in AWS Certificate Manager (ACM). + ServerCertificateArn *string + // Indicates whether the VPN is split-tunnel. For information about split-tunnel // VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint // (https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html) @@ -107,10 +108,9 @@ type ModifyClientVpnEndpointInput struct { // The ID of the VPC to associate with the Client VPN endpoint. VpcId *string - // The ID of the Client VPN endpoint to modify. - // - // This member is required. - ClientVpnEndpointId *string + // The port number to assign to the Client VPN endpoint for TCP and UDP traffic. + // Valid Values: 443 | 1194 Default Value: 443 + VpnPort *int32 } type ModifyClientVpnEndpointOutput struct { diff --git a/service/ec2/api_op_ModifyDefaultCreditSpecification.go b/service/ec2/api_op_ModifyDefaultCreditSpecification.go index 873cc3ff730..29f72efbaa6 100644 --- a/service/ec2/api_op_ModifyDefaultCreditSpecification.go +++ b/service/ec2/api_op_ModifyDefaultCreditSpecification.go @@ -69,12 +69,6 @@ func (c *Client) ModifyDefaultCreditSpecification(ctx context.Context, params *M type ModifyDefaultCreditSpecificationInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The credit option for CPU usage of the instance family. Valid Values: standard | // unlimited // @@ -85,6 +79,12 @@ type ModifyDefaultCreditSpecificationInput struct { // // This member is required. InstanceFamily types.UnlimitedSupportedInstanceFamily + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool } type ModifyDefaultCreditSpecificationOutput struct { diff --git a/service/ec2/api_op_ModifyFleet.go b/service/ec2/api_op_ModifyFleet.go index 25272d1510d..00be34a0053 100644 --- a/service/ec2/api_op_ModifyFleet.go +++ b/service/ec2/api_op_ModifyFleet.go @@ -79,25 +79,25 @@ func (c *Client) ModifyFleet(ctx context.Context, params *ModifyFleetInput, optF type ModifyFleetInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The ID of the EC2 Fleet. // // This member is required. FleetId *string - // Indicates whether running instances should be terminated if the total target - // capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet. - ExcessCapacityTerminationPolicy types.FleetExcessCapacityTerminationPolicy - // The size of the EC2 Fleet. // // This member is required. TargetCapacitySpecification *types.TargetCapacitySpecificationRequest + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + + // Indicates whether running instances should be terminated if the total target + // capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet. + ExcessCapacityTerminationPolicy types.FleetExcessCapacityTerminationPolicy } type ModifyFleetOutput struct { diff --git a/service/ec2/api_op_ModifyFpgaImageAttribute.go b/service/ec2/api_op_ModifyFpgaImageAttribute.go index f8a11d831e5..6ec525f6db7 100644 --- a/service/ec2/api_op_ModifyFpgaImageAttribute.go +++ b/service/ec2/api_op_ModifyFpgaImageAttribute.go @@ -57,25 +57,23 @@ func (c *Client) ModifyFpgaImageAttribute(ctx context.Context, params *ModifyFpg type ModifyFpgaImageAttributeInput struct { - // The user groups. This parameter is valid only when modifying the loadPermission - // attribute. - UserGroups []*string - // The ID of the AFI. // // This member is required. FpgaImageId *string - // The product codes. After you add a product code to an AFI, it can't be removed. - // This parameter is valid only when modifying the productCodes attribute. - ProductCodes []*string - // The name of the attribute. Attribute types.FpgaImageAttributeName // A description for the AFI. Description *string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // The load permission for the AFI. LoadPermission *types.LoadPermissionModifications @@ -85,11 +83,13 @@ type ModifyFpgaImageAttributeInput struct { // The operation type. OperationType types.OperationType - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The product codes. After you add a product code to an AFI, it can't be removed. + // This parameter is valid only when modifying the productCodes attribute. + ProductCodes []*string + + // The user groups. This parameter is valid only when modifying the loadPermission + // attribute. + UserGroups []*string // The AWS account IDs. This parameter is valid only when modifying the // loadPermission attribute. diff --git a/service/ec2/api_op_ModifyHosts.go b/service/ec2/api_op_ModifyHosts.go index 7e1ec353e51..e9d6c3ef4cc 100644 --- a/service/ec2/api_op_ModifyHosts.go +++ b/service/ec2/api_op_ModifyHosts.go @@ -65,9 +65,20 @@ func (c *Client) ModifyHosts(ctx context.Context, params *ModifyHostsInput, optF type ModifyHostsInput struct { + // The IDs of the Dedicated Hosts to modify. + // + // This member is required. + HostIds []*string + // Specify whether to enable or disable auto-placement. AutoPlacement types.AutoPlacement + // Indicates whether to enable or disable host recovery for the Dedicated Host. For + // more information, see Host Recovery + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-recovery.html) + // in the Amazon Elastic Compute Cloud User Guide. + HostRecovery types.HostRecovery + // Specifies the instance family to be supported by the Dedicated Host. Specify // this parameter to modify a Dedicated Host to support multiple instance types // within its current instance family.

    If you want to modify a Dedicated Host @@ -83,28 +94,17 @@ type ModifyHostsInput struct { // InstanceFamily instead. You cannot specify InstanceType and // InstanceFamily in the same request.

    InstanceType *string - - // Indicates whether to enable or disable host recovery for the Dedicated Host. For - // more information, see Host Recovery - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-recovery.html) - // in the Amazon Elastic Compute Cloud User Guide. - HostRecovery types.HostRecovery - - // The IDs of the Dedicated Hosts to modify. - // - // This member is required. - HostIds []*string } type ModifyHostsOutput struct { + // The IDs of the Dedicated Hosts that were successfully modified. + Successful []*string + // The IDs of the Dedicated Hosts that could not be modified. Check whether the // setting you requested can be used. Unsuccessful []*types.UnsuccessfulItem - // The IDs of the Dedicated Hosts that were successfully modified. - Successful []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_ModifyIdFormat.go b/service/ec2/api_op_ModifyIdFormat.go index 229cb1e9e74..ff3d08c3d92 100644 --- a/service/ec2/api_op_ModifyIdFormat.go +++ b/service/ec2/api_op_ModifyIdFormat.go @@ -76,11 +76,6 @@ func (c *Client) ModifyIdFormat(ctx context.Context, params *ModifyIdFormatInput type ModifyIdFormatInput struct { - // Indicate whether the resource should use longer IDs (17-character IDs). - // - // This member is required. - UseLongIds *bool - // The type of resource: bundle | conversion-task | customer-gateway | dhcp-options // | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | // image | import-task | internet-gateway | network-acl | network-acl-association | @@ -93,6 +88,11 @@ type ModifyIdFormatInput struct { // // This member is required. Resource *string + + // Indicate whether the resource should use longer IDs (17-character IDs). + // + // This member is required. + UseLongIds *bool } type ModifyIdFormatOutput struct { diff --git a/service/ec2/api_op_ModifyIdentityIdFormat.go b/service/ec2/api_op_ModifyIdentityIdFormat.go index b02eb7bebe4..a86d9f1a524 100644 --- a/service/ec2/api_op_ModifyIdentityIdFormat.go +++ b/service/ec2/api_op_ModifyIdentityIdFormat.go @@ -74,10 +74,12 @@ func (c *Client) ModifyIdentityIdFormat(ctx context.Context, params *ModifyIdent type ModifyIdentityIdFormatInput struct { - // Indicates whether the resource should use longer IDs (17-character IDs) + // The ARN of the principal, which can be an IAM user, IAM role, or the root user. + // Specify all to modify the ID format for all IAM users, IAM roles, and the root + // user of the account. // // This member is required. - UseLongIds *bool + PrincipalArn *string // The type of resource: bundle | conversion-task | customer-gateway | dhcp-options // | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | @@ -92,12 +94,10 @@ type ModifyIdentityIdFormatInput struct { // This member is required. Resource *string - // The ARN of the principal, which can be an IAM user, IAM role, or the root user. - // Specify all to modify the ID format for all IAM users, IAM roles, and the root - // user of the account. + // Indicates whether the resource should use longer IDs (17-character IDs) // // This member is required. - PrincipalArn *string + UseLongIds *bool } type ModifyIdentityIdFormatOutput struct { diff --git a/service/ec2/api_op_ModifyImageAttribute.go b/service/ec2/api_op_ModifyImageAttribute.go index 1a656807306..b2ff3f3ea54 100644 --- a/service/ec2/api_op_ModifyImageAttribute.go +++ b/service/ec2/api_op_ModifyImageAttribute.go @@ -64,46 +64,46 @@ func (c *Client) ModifyImageAttribute(ctx context.Context, params *ModifyImageAt // Contains the parameters for ModifyImageAttribute. type ModifyImageAttributeInput struct { - // The value of the attribute being modified. This parameter can be used only when - // the Attribute parameter is description or productCodes. - Value *string - - // The operation type. This parameter can be used only when the Attribute parameter - // is launchPermission. - OperationType types.OperationType - // The ID of the AMI. // // This member is required. ImageId *string - // A new description for the AMI. - Description *types.AttributeValue - - // The DevPay product codes. After you add a product code to an AMI, it can't be - // removed. - ProductCodes []*string - // The name of the attribute to modify. The valid values are description, // launchPermission, and productCodes. Attribute *string + // A new description for the AMI. + Description *types.AttributeValue + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + // A new launch permission for the AMI. + LaunchPermission *types.LaunchPermissionModifications + + // The operation type. This parameter can be used only when the Attribute parameter + // is launchPermission. + OperationType types.OperationType + + // The DevPay product codes. After you add a product code to an AMI, it can't be + // removed. + ProductCodes []*string + // The user groups. This parameter can be used only when the Attribute parameter is // launchPermission. UserGroups []*string - // A new launch permission for the AMI. - LaunchPermission *types.LaunchPermissionModifications - // The AWS account IDs. This parameter can be used only when the Attribute // parameter is launchPermission. UserIds []*string + + // The value of the attribute being modified. This parameter can be used only when + // the Attribute parameter is description or productCodes. + Value *string } type ModifyImageAttributeOutput struct { diff --git a/service/ec2/api_op_ModifyInstanceAttribute.go b/service/ec2/api_op_ModifyInstanceAttribute.go index 6c9ff6a2c9b..3a6d65f0bae 100644 --- a/service/ec2/api_op_ModifyInstanceAttribute.go +++ b/service/ec2/api_op_ModifyInstanceAttribute.go @@ -66,48 +66,14 @@ func (c *Client) ModifyInstanceAttribute(ctx context.Context, params *ModifyInst type ModifyInstanceAttributeInput struct { - // Changes the instance type to the specified value. For more information, see - // Instance types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html). If - // the instance type is not valid, the error returned is - // InvalidInstanceAttributeValue. - InstanceType *types.AttributeValue - - // Set to simple to enable enhanced networking with the Intel 82599 Virtual - // Function interface for the instance. There is no way to disable enhanced - // networking with the Intel 82599 Virtual Function interface at this time. This - // option is supported only for HVM instances. Specifying this option with a PV - // instance can make it unreachable. - SriovNetSupport *types.AttributeValue - - // A new value for the attribute. Use only with the kernel, ramdisk, userData, - // disableApiTermination, or instanceInitiatedShutdownBehavior attribute. - Value *string - - // Specifies whether an instance stops or terminates when you initiate shutdown - // from the instance (using the operating system command for system shutdown). - InstanceInitiatedShutdownBehavior *types.AttributeValue - - // Changes the instance's RAM disk to the specified value. We recommend that you - // use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html). - Ramdisk *types.AttributeValue - - // If the value is true, you can't terminate the instance using the Amazon EC2 - // console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot - // Instances. - DisableApiTermination *types.AttributeBooleanValue - - // Changes the instance's kernel to the specified value. We recommend that you use - // PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html). - Kernel *types.AttributeValue - // The ID of the instance. // // This member is required. InstanceId *string + // The name of the attribute. + Attribute types.InstanceAttributeName + // Modifies the DeleteOnTermination attribute for volumes that are currently // attached. The volume must be owned by the caller. If no value is specified for // DeleteOnTermination, the default is true and the volume is deleted when the @@ -118,6 +84,24 @@ type ModifyInstanceAttributeInput struct { // in the Amazon Elastic Compute Cloud User Guide. BlockDeviceMappings []*types.InstanceBlockDeviceMappingSpecification + // If the value is true, you can't terminate the instance using the Amazon EC2 + // console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot + // Instances. + DisableApiTermination *types.AttributeBooleanValue + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + + // Specifies whether the instance is optimized for Amazon EBS I/O. This + // optimization provides dedicated throughput to Amazon EBS and an optimized + // configuration stack to provide optimal EBS I/O performance. This optimization + // isn't available with all instance types. Additional usage charges apply when + // using an EBS Optimized instance. + EbsOptimized *types.AttributeBooleanValue + // Set to true to enable enhanced networking with ENA for the instance. This option // is supported only for HVM instances. Specifying this option with a PV instance // can make it unreachable. @@ -128,31 +112,47 @@ type ModifyInstanceAttributeInput struct { // You must specify the security group ID, not the security group name. Groups []*string - // Changes the instance's user data to the specified value. If you are using an AWS - // SDK or command line tool, base64-encoding is performed for you, and you can load - // the text from a file. Otherwise, you must provide base64-encoded text. - UserData *types.BlobAttributeValue + // Specifies whether an instance stops or terminates when you initiate shutdown + // from the instance (using the operating system command for system shutdown). + InstanceInitiatedShutdownBehavior *types.AttributeValue - // The name of the attribute. - Attribute types.InstanceAttributeName + // Changes the instance type to the specified value. For more information, see + // Instance types + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html). If + // the instance type is not valid, the error returned is + // InvalidInstanceAttributeValue. + InstanceType *types.AttributeValue - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // Changes the instance's kernel to the specified value. We recommend that you use + // PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html). + Kernel *types.AttributeValue + + // Changes the instance's RAM disk to the specified value. We recommend that you + // use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html). + Ramdisk *types.AttributeValue // Specifies whether source/destination checking is enabled. A value of true means // that checking is enabled, and false means that checking is disabled. This value // must be false for a NAT instance to perform NAT. SourceDestCheck *types.AttributeBooleanValue - // Specifies whether the instance is optimized for Amazon EBS I/O. This - // optimization provides dedicated throughput to Amazon EBS and an optimized - // configuration stack to provide optimal EBS I/O performance. This optimization - // isn't available with all instance types. Additional usage charges apply when - // using an EBS Optimized instance. - EbsOptimized *types.AttributeBooleanValue + // Set to simple to enable enhanced networking with the Intel 82599 Virtual + // Function interface for the instance. There is no way to disable enhanced + // networking with the Intel 82599 Virtual Function interface at this time. This + // option is supported only for HVM instances. Specifying this option with a PV + // instance can make it unreachable. + SriovNetSupport *types.AttributeValue + + // Changes the instance's user data to the specified value. If you are using an AWS + // SDK or command line tool, base64-encoding is performed for you, and you can load + // the text from a file. Otherwise, you must provide base64-encoded text. + UserData *types.BlobAttributeValue + + // A new value for the attribute. Use only with the kernel, ramdisk, userData, + // disableApiTermination, or instanceInitiatedShutdownBehavior attribute. + Value *string } type ModifyInstanceAttributeOutput struct { diff --git a/service/ec2/api_op_ModifyInstanceCapacityReservationAttributes.go b/service/ec2/api_op_ModifyInstanceCapacityReservationAttributes.go index 51a5fcde1fe..dd8143664e5 100644 --- a/service/ec2/api_op_ModifyInstanceCapacityReservationAttributes.go +++ b/service/ec2/api_op_ModifyInstanceCapacityReservationAttributes.go @@ -60,15 +60,15 @@ func (c *Client) ModifyInstanceCapacityReservationAttributes(ctx context.Context type ModifyInstanceCapacityReservationAttributesInput struct { - // The ID of the instance to be modified. + // Information about the Capacity Reservation targeting option. // // This member is required. - InstanceId *string + CapacityReservationSpecification *types.CapacityReservationSpecification - // Information about the Capacity Reservation targeting option. + // The ID of the instance to be modified. // // This member is required. - CapacityReservationSpecification *types.CapacityReservationSpecification + InstanceId *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the diff --git a/service/ec2/api_op_ModifyInstanceCreditSpecification.go b/service/ec2/api_op_ModifyInstanceCreditSpecification.go index a7418f17dd3..37994e037d5 100644 --- a/service/ec2/api_op_ModifyInstanceCreditSpecification.go +++ b/service/ec2/api_op_ModifyInstanceCreditSpecification.go @@ -61,16 +61,16 @@ func (c *Client) ModifyInstanceCreditSpecification(ctx context.Context, params * type ModifyInstanceCreditSpecificationInput struct { - // A unique, case-sensitive token that you provide to ensure idempotency of your - // modification request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). - ClientToken *string - // Information about the credit option for CPU usage. // // This member is required. InstanceCreditSpecifications []*types.InstanceCreditSpecificationRequest + // A unique, case-sensitive token that you provide to ensure idempotency of your + // modification request. For more information, see Ensuring Idempotency + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + ClientToken *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is diff --git a/service/ec2/api_op_ModifyInstanceEventStartTime.go b/service/ec2/api_op_ModifyInstanceEventStartTime.go index 44a26371924..3ad747145c3 100644 --- a/service/ec2/api_op_ModifyInstanceEventStartTime.go +++ b/service/ec2/api_op_ModifyInstanceEventStartTime.go @@ -58,11 +58,10 @@ func (c *Client) ModifyInstanceEventStartTime(ctx context.Context, params *Modif type ModifyInstanceEventStartTimeInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The ID of the event whose date and time you are modifying. + // + // This member is required. + InstanceEventId *string // The ID of the instance with the scheduled event. // @@ -74,10 +73,11 @@ type ModifyInstanceEventStartTimeInput struct { // This member is required. NotBefore *time.Time - // The ID of the event whose date and time you are modifying. - // - // This member is required. - InstanceEventId *string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool } type ModifyInstanceEventStartTimeOutput struct { diff --git a/service/ec2/api_op_ModifyInstanceMetadataOptions.go b/service/ec2/api_op_ModifyInstanceMetadataOptions.go index 4a256cce310..c3405c030f3 100644 --- a/service/ec2/api_op_ModifyInstanceMetadataOptions.go +++ b/service/ec2/api_op_ModifyInstanceMetadataOptions.go @@ -64,11 +64,10 @@ func (c *Client) ModifyInstanceMetadataOptions(ctx context.Context, params *Modi type ModifyInstanceMetadataOptionsInput struct { - // This parameter enables or disables the HTTP metadata endpoint on your instances. - // If the parameter is not specified, the existing state is maintained. If you - // specify a value of disabled, you will not be able to access your instance - // metadata. - HttpEndpoint types.InstanceMetadataEndpointState + // The ID of the instance. + // + // This member is required. + InstanceId *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the @@ -76,6 +75,18 @@ type ModifyInstanceMetadataOptionsInput struct { // UnauthorizedOperation. DryRun *bool + // This parameter enables or disables the HTTP metadata endpoint on your instances. + // If the parameter is not specified, the existing state is maintained. If you + // specify a value of disabled, you will not be able to access your instance + // metadata. + HttpEndpoint types.InstanceMetadataEndpointState + + // The desired HTTP PUT response hop limit for instance metadata requests. The + // larger the number, the further instance metadata requests can travel. If no + // parameter is specified, the existing state is maintained. Possible values: + // Integers from 1 to 64 + HttpPutResponseHopLimit *int32 + // The state of token usage for your instance metadata requests. If the parameter // is not specified in the request, the default state is optional. If the state is // optional, you can choose to retrieve instance metadata with or without a signed @@ -87,27 +98,16 @@ type ModifyInstanceMetadataOptionsInput struct { // credential always returns the version 2.0 credentials; the version 1.0 // credentials are not available. HttpTokens types.HttpTokensState +} - // The desired HTTP PUT response hop limit for instance metadata requests. The - // larger the number, the further instance metadata requests can travel. If no - // parameter is specified, the existing state is maintained. Possible values: - // Integers from 1 to 64 - HttpPutResponseHopLimit *int32 +type ModifyInstanceMetadataOptionsOutput struct { // The ID of the instance. - // - // This member is required. InstanceId *string -} - -type ModifyInstanceMetadataOptionsOutput struct { // The metadata options for the instance. InstanceMetadataOptions *types.InstanceMetadataOptionsResponse - // The ID of the instance. - InstanceId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_ModifyInstancePlacement.go b/service/ec2/api_op_ModifyInstancePlacement.go index a8194ff79df..9c3f6a91afa 100644 --- a/service/ec2/api_op_ModifyInstancePlacement.go +++ b/service/ec2/api_op_ModifyInstancePlacement.go @@ -81,14 +81,14 @@ func (c *Client) ModifyInstancePlacement(ctx context.Context, params *ModifyInst type ModifyInstancePlacementInput struct { - // The affinity setting for the instance. - Affinity types.Affinity - // The ID of the instance that you are modifying. // // This member is required. InstanceId *string + // The affinity setting for the instance. + Affinity types.Affinity + // The name of the placement group in which to place the instance. For spread // placement groups, the instance must have a tenancy of default. For cluster and // partition placement groups, the instance must have a tenancy of default or @@ -96,17 +96,17 @@ type ModifyInstancePlacementInput struct { // (""). GroupName *string - // The tenancy for the instance. - Tenancy types.HostTenancy - - // Reserved for future use. - PartitionNumber *int32 + // The ID of the Dedicated Host with which to associate the instance. + HostId *string // The ARN of the host resource group in which to place the instance. HostResourceGroupArn *string - // The ID of the Dedicated Host with which to associate the instance. - HostId *string + // Reserved for future use. + PartitionNumber *int32 + + // The tenancy for the instance. + Tenancy types.HostTenancy } type ModifyInstancePlacementOutput struct { diff --git a/service/ec2/api_op_ModifyLaunchTemplate.go b/service/ec2/api_op_ModifyLaunchTemplate.go index c676b9d53d1..4b88f5c6ae5 100644 --- a/service/ec2/api_op_ModifyLaunchTemplate.go +++ b/service/ec2/api_op_ModifyLaunchTemplate.go @@ -58,9 +58,14 @@ func (c *Client) ModifyLaunchTemplate(ctx context.Context, params *ModifyLaunchT type ModifyLaunchTemplateInput struct { - // The ID of the launch template. You must specify either the launch template ID or - // launch template name in the request. - LaunchTemplateId *string + // Unique, case-sensitive identifier you provide to ensure the idempotency of the + // request. For more information, see Ensuring Idempotency + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // Constraint: Maximum 128 ASCII characters. + ClientToken *string + + // The version number of the launch template to set as the default version. + DefaultVersion *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the @@ -68,14 +73,9 @@ type ModifyLaunchTemplateInput struct { // UnauthorizedOperation. DryRun *bool - // The version number of the launch template to set as the default version. - DefaultVersion *string - - // Unique, case-sensitive identifier you provide to ensure the idempotency of the - // request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). - // Constraint: Maximum 128 ASCII characters. - ClientToken *string + // The ID of the launch template. You must specify either the launch template ID or + // launch template name in the request. + LaunchTemplateId *string // The name of the launch template. You must specify either the launch template ID // or launch template name in the request. diff --git a/service/ec2/api_op_ModifyManagedPrefixList.go b/service/ec2/api_op_ModifyManagedPrefixList.go index 1741d8979ef..7a8a0838862 100644 --- a/service/ec2/api_op_ModifyManagedPrefixList.go +++ b/service/ec2/api_op_ModifyManagedPrefixList.go @@ -60,14 +60,14 @@ func (c *Client) ModifyManagedPrefixList(ctx context.Context, params *ModifyMana type ModifyManagedPrefixListInput struct { - // One or more entries to add to the prefix list. - AddEntries []*types.AddPrefixListEntry - // The ID of the prefix list. // // This member is required. PrefixListId *string + // One or more entries to add to the prefix list. + AddEntries []*types.AddPrefixListEntry + // The current version of the prefix list. CurrentVersion *int64 diff --git a/service/ec2/api_op_ModifyNetworkInterfaceAttribute.go b/service/ec2/api_op_ModifyNetworkInterfaceAttribute.go index afb2b324f42..079c30d0859 100644 --- a/service/ec2/api_op_ModifyNetworkInterfaceAttribute.go +++ b/service/ec2/api_op_ModifyNetworkInterfaceAttribute.go @@ -60,36 +60,36 @@ func (c *Client) ModifyNetworkInterfaceAttribute(ctx context.Context, params *Mo // Contains the parameters for ModifyNetworkInterfaceAttribute. type ModifyNetworkInterfaceAttributeInput struct { - // Indicates whether source/destination checking is enabled. A value of true means - // checking is enabled, and false means checking is disabled. This value must be - // false for a NAT instance to perform NAT. For more information, see NAT Instances - // (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html) - // in the Amazon Virtual Private Cloud User Guide. - SourceDestCheck *types.AttributeBooleanValue - - // Changes the security groups for the network interface. The new set of groups you - // specify replaces the current set. You must specify at least one group, even if - // it's just the default security group in the VPC. You must specify the ID of the - // security group, not the name. - Groups []*string - - // A description for the network interface. - Description *types.AttributeValue + // The ID of the network interface. + // + // This member is required. + NetworkInterfaceId *string // Information about the interface attachment. If modifying the 'delete on // termination' attribute, you must specify the ID of the interface attachment. Attachment *types.NetworkInterfaceAttachmentChanges + // A description for the network interface. + Description *types.AttributeValue + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // The ID of the network interface. - // - // This member is required. - NetworkInterfaceId *string + // Changes the security groups for the network interface. The new set of groups you + // specify replaces the current set. You must specify at least one group, even if + // it's just the default security group in the VPC. You must specify the ID of the + // security group, not the name. + Groups []*string + + // Indicates whether source/destination checking is enabled. A value of true means + // checking is enabled, and false means checking is disabled. This value must be + // false for a NAT instance to perform NAT. For more information, see NAT Instances + // (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html) + // in the Amazon Virtual Private Cloud User Guide. + SourceDestCheck *types.AttributeBooleanValue } type ModifyNetworkInterfaceAttributeOutput struct { diff --git a/service/ec2/api_op_ModifyReservedInstances.go b/service/ec2/api_op_ModifyReservedInstances.go index 1d6bd534c0d..b4b0c7008f0 100644 --- a/service/ec2/api_op_ModifyReservedInstances.go +++ b/service/ec2/api_op_ModifyReservedInstances.go @@ -64,15 +64,15 @@ func (c *Client) ModifyReservedInstances(ctx context.Context, params *ModifyRese // Contains the parameters for ModifyReservedInstances. type ModifyReservedInstancesInput struct { - // The configuration settings for the Reserved Instances to modify. + // The IDs of the Reserved Instances to modify. // // This member is required. - TargetConfigurations []*types.ReservedInstancesConfiguration + ReservedInstancesIds []*string - // The IDs of the Reserved Instances to modify. + // The configuration settings for the Reserved Instances to modify. // // This member is required. - ReservedInstancesIds []*string + TargetConfigurations []*types.ReservedInstancesConfiguration // A unique, case-sensitive token you provide to ensure idempotency of your // modification request. For more information, see Ensuring Idempotency diff --git a/service/ec2/api_op_ModifySnapshotAttribute.go b/service/ec2/api_op_ModifySnapshotAttribute.go index 2daa3f25f73..184d03d1df5 100644 --- a/service/ec2/api_op_ModifySnapshotAttribute.go +++ b/service/ec2/api_op_ModifySnapshotAttribute.go @@ -67,17 +67,11 @@ func (c *Client) ModifySnapshotAttribute(ctx context.Context, params *ModifySnap type ModifySnapshotAttributeInput struct { - // The account ID to modify for the snapshot. - UserIds []*string - // The ID of the snapshot. // // This member is required. SnapshotId *string - // The type of operation to perform to the attribute. - OperationType types.OperationType - // The snapshot attribute to modify. Only volume creation permissions can be // modified. Attribute types.SnapshotAttributeName @@ -85,14 +79,20 @@ type ModifySnapshotAttributeInput struct { // A JSON representation of the snapshot attribute modification. CreateVolumePermission *types.CreateVolumePermissionModifications - // The group to modify for the snapshot. - GroupNames []*string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // The group to modify for the snapshot. + GroupNames []*string + + // The type of operation to perform to the attribute. + OperationType types.OperationType + + // The account ID to modify for the snapshot. + UserIds []*string } type ModifySnapshotAttributeOutput struct { diff --git a/service/ec2/api_op_ModifySpotFleetRequest.go b/service/ec2/api_op_ModifySpotFleetRequest.go index 3828ff20e9f..8e7856b8989 100644 --- a/service/ec2/api_op_ModifySpotFleetRequest.go +++ b/service/ec2/api_op_ModifySpotFleetRequest.go @@ -85,16 +85,16 @@ type ModifySpotFleetRequestInput struct { // This member is required. SpotFleetRequestId *string - // The size of the fleet. - TargetCapacity *int32 - - // The number of On-Demand Instances in the fleet. - OnDemandTargetCapacity *int32 - // Indicates whether running Spot Instances should be terminated if the target // capacity of the Spot Fleet request is decreased below the current size of the // Spot Fleet. ExcessCapacityTerminationPolicy types.ExcessCapacityTerminationPolicy + + // The number of On-Demand Instances in the fleet. + OnDemandTargetCapacity *int32 + + // The size of the fleet. + TargetCapacity *int32 } // Contains the output of ModifySpotFleetRequest. diff --git a/service/ec2/api_op_ModifySubnetAttribute.go b/service/ec2/api_op_ModifySubnetAttribute.go index 73c90a2dc71..54e788f3f9c 100644 --- a/service/ec2/api_op_ModifySubnetAttribute.go +++ b/service/ec2/api_op_ModifySubnetAttribute.go @@ -62,10 +62,6 @@ type ModifySubnetAttributeInput struct { // This member is required. SubnetId *string - // The customer-owned IPv4 address pool associated with the subnet. You must set - // this value when you specify true for MapCustomerOwnedIpOnLaunch. - CustomerOwnedIpv4Pool *string - // Specify true to indicate that network interfaces created in the specified subnet // should be assigned an IPv6 address. This includes a network interface that's // created when launching an instance into the subnet (the instance therefore @@ -74,6 +70,10 @@ type ModifySubnetAttributeInput struct { // created using version 2016-11-15 or later of the Amazon EC2 API. AssignIpv6AddressOnCreation *types.AttributeBooleanValue + // The customer-owned IPv4 address pool associated with the subnet. You must set + // this value when you specify true for MapCustomerOwnedIpOnLaunch. + CustomerOwnedIpv4Pool *string + // Specify true to indicate that network interfaces attached to instances created // in the specified subnet should be assigned a customer-owned IPv4 address. When // this value is true, you must specify the customer-owned IP pool using diff --git a/service/ec2/api_op_ModifyTrafficMirrorFilterNetworkServices.go b/service/ec2/api_op_ModifyTrafficMirrorFilterNetworkServices.go index e8e98b07d2f..b7b53d9afa1 100644 --- a/service/ec2/api_op_ModifyTrafficMirrorFilterNetworkServices.go +++ b/service/ec2/api_op_ModifyTrafficMirrorFilterNetworkServices.go @@ -73,14 +73,14 @@ type ModifyTrafficMirrorFilterNetworkServicesInput struct { // The network service, for example Amazon DNS, that you want to mirror. AddNetworkServices []types.TrafficMirrorNetworkService - // The network service, for example Amazon DNS, that you no longer want to mirror. - RemoveNetworkServices []types.TrafficMirrorNetworkService - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // The network service, for example Amazon DNS, that you no longer want to mirror. + RemoveNetworkServices []types.TrafficMirrorNetworkService } type ModifyTrafficMirrorFilterNetworkServicesOutput struct { diff --git a/service/ec2/api_op_ModifyTrafficMirrorFilterRule.go b/service/ec2/api_op_ModifyTrafficMirrorFilterRule.go index 5e36260a5b3..9b6124e36b8 100644 --- a/service/ec2/api_op_ModifyTrafficMirrorFilterRule.go +++ b/service/ec2/api_op_ModifyTrafficMirrorFilterRule.go @@ -58,50 +58,50 @@ func (c *Client) ModifyTrafficMirrorFilterRule(ctx context.Context, params *Modi type ModifyTrafficMirrorFilterRuleInput struct { - // The number of the Traffic Mirror rule. This number must be unique for each - // Traffic Mirror rule in a given direction. The rules are processed in ascending - // order by rule number. - RuleNumber *int32 - - // The protocol, for example TCP, to assign to the Traffic Mirror rule. - Protocol *int32 - - // The source CIDR block to assign to the Traffic Mirror rule. - SourceCidrBlock *string - - // The type of traffic (ingress | egress) to assign to the rule. - TrafficDirection types.TrafficDirection - - // The description to assign to the Traffic Mirror rule. - Description *string - - // The action to assign to the rule. - RuleAction types.TrafficMirrorRuleAction - - // The destination ports that are associated with the Traffic Mirror rule. - DestinationPortRange *types.TrafficMirrorPortRangeRequest - // The ID of the Traffic Mirror rule. // // This member is required. TrafficMirrorFilterRuleId *string - // The port range to assign to the Traffic Mirror rule. - SourcePortRange *types.TrafficMirrorPortRangeRequest + // The description to assign to the Traffic Mirror rule. + Description *string // The destination CIDR block to assign to the Traffic Mirror rule. DestinationCidrBlock *string - // The properties that you want to remove from the Traffic Mirror filter rule. When - // you remove a property from a Traffic Mirror filter rule, the property is set to - // the default. - RemoveFields []types.TrafficMirrorFilterRuleField + // The destination ports that are associated with the Traffic Mirror rule. + DestinationPortRange *types.TrafficMirrorPortRangeRequest // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // The protocol, for example TCP, to assign to the Traffic Mirror rule. + Protocol *int32 + + // The properties that you want to remove from the Traffic Mirror filter rule. When + // you remove a property from a Traffic Mirror filter rule, the property is set to + // the default. + RemoveFields []types.TrafficMirrorFilterRuleField + + // The action to assign to the rule. + RuleAction types.TrafficMirrorRuleAction + + // The number of the Traffic Mirror rule. This number must be unique for each + // Traffic Mirror rule in a given direction. The rules are processed in ascending + // order by rule number. + RuleNumber *int32 + + // The source CIDR block to assign to the Traffic Mirror rule. + SourceCidrBlock *string + + // The port range to assign to the Traffic Mirror rule. + SourcePortRange *types.TrafficMirrorPortRangeRequest + + // The type of traffic (ingress | egress) to assign to the rule. + TrafficDirection types.TrafficDirection } type ModifyTrafficMirrorFilterRuleOutput struct { diff --git a/service/ec2/api_op_ModifyTrafficMirrorSession.go b/service/ec2/api_op_ModifyTrafficMirrorSession.go index d0ed9367df1..fa9706e5742 100644 --- a/service/ec2/api_op_ModifyTrafficMirrorSession.go +++ b/service/ec2/api_op_ModifyTrafficMirrorSession.go @@ -57,26 +57,20 @@ func (c *Client) ModifyTrafficMirrorSession(ctx context.Context, params *ModifyT type ModifyTrafficMirrorSessionInput struct { - // The description to assign to the Traffic Mirror session. - Description *string - - // The properties that you want to remove from the Traffic Mirror session. When you - // remove a property from a Traffic Mirror session, the property is set to the - // default. - RemoveFields []types.TrafficMirrorSessionField - - // The Traffic Mirror target. The target must be in the same VPC as the source, or - // have a VPC peering connection with the source. - TrafficMirrorTargetId *string - - // The ID of the Traffic Mirror filter. - TrafficMirrorFilterId *string - // The ID of the Traffic Mirror session. // // This member is required. TrafficMirrorSessionId *string + // The description to assign to the Traffic Mirror session. + Description *string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // The number of bytes in each packet to mirror. These are bytes after the VXLAN // header. To mirror a subset, set this to the length (in bytes) to mirror. For // example, if you set this value to 100, then the first 100 bytes that meet the @@ -84,16 +78,22 @@ type ModifyTrafficMirrorSessionInput struct { // want to mirror the entire packet. PacketLength *int32 + // The properties that you want to remove from the Traffic Mirror session. When you + // remove a property from a Traffic Mirror session, the property is set to the + // default. + RemoveFields []types.TrafficMirrorSessionField + // The session number determines the order in which sessions are evaluated when an // interface is used by multiple sessions. The first session with a matching filter // is the one that mirrors the packets. Valid values are 1-32766. SessionNumber *int32 - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The ID of the Traffic Mirror filter. + TrafficMirrorFilterId *string + + // The Traffic Mirror target. The target must be in the same VPC as the source, or + // have a VPC peering connection with the source. + TrafficMirrorTargetId *string // The virtual network ID of the Traffic Mirror session. VirtualNetworkId *int32 diff --git a/service/ec2/api_op_ModifyTransitGatewayVpcAttachment.go b/service/ec2/api_op_ModifyTransitGatewayVpcAttachment.go index 658c619cfb9..caf6e0a5166 100644 --- a/service/ec2/api_op_ModifyTransitGatewayVpcAttachment.go +++ b/service/ec2/api_op_ModifyTransitGatewayVpcAttachment.go @@ -62,21 +62,21 @@ type ModifyTransitGatewayVpcAttachmentInput struct { // This member is required. TransitGatewayAttachmentId *string - // The new VPC attachment options. You cannot modify the IPv6 options. - Options *types.ModifyTransitGatewayVpcAttachmentRequestOptions - // The IDs of one or more subnets to add. You can specify at most one subnet per // Availability Zone. AddSubnetIds []*string - // The IDs of one or more subnets to remove. - RemoveSubnetIds []*string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // The new VPC attachment options. You cannot modify the IPv6 options. + Options *types.ModifyTransitGatewayVpcAttachmentRequestOptions + + // The IDs of one or more subnets to remove. + RemoveSubnetIds []*string } type ModifyTransitGatewayVpcAttachmentOutput struct { diff --git a/service/ec2/api_op_ModifyVolume.go b/service/ec2/api_op_ModifyVolume.go index f739e76e29a..7834299f8f0 100644 --- a/service/ec2/api_op_ModifyVolume.go +++ b/service/ec2/api_op_ModifyVolume.go @@ -91,12 +91,23 @@ func (c *Client) ModifyVolume(ctx context.Context, params *ModifyVolumeInput, op type ModifyVolumeInput struct { + // The ID of the volume. + // + // This member is required. + VolumeId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + // The target IOPS rate of the volume. This is only valid for Provisioned IOPS SSD + // (io1) volumes. For more information, see Provisioned IOPS SSD (io1) Volumes + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html#EBSVolumeTypes_piops). + // Default: If no IOPS value is specified, the existing value is retained. + Iops *int32 + // The target size of the volume, in GiB. The target volume size must be greater // than or equal to than the existing size of the volume. For information about // available EBS volume sizes, see Amazon EBS Volume Types @@ -104,17 +115,6 @@ type ModifyVolumeInput struct { // Default: If no size is specified, the existing size is retained. Size *int32 - // The ID of the volume. - // - // This member is required. - VolumeId *string - - // The target IOPS rate of the volume. This is only valid for Provisioned IOPS SSD - // (io1) volumes. For more information, see Provisioned IOPS SSD (io1) Volumes - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html#EBSVolumeTypes_piops). - // Default: If no IOPS value is specified, the existing value is retained. - Iops *int32 - // The target EBS volume type of the volume. Default: If no type is specified, the // existing type is retained. VolumeType types.VolumeType diff --git a/service/ec2/api_op_ModifyVolumeAttribute.go b/service/ec2/api_op_ModifyVolumeAttribute.go index e5da31c52d2..c372f2dd9b3 100644 --- a/service/ec2/api_op_ModifyVolumeAttribute.go +++ b/service/ec2/api_op_ModifyVolumeAttribute.go @@ -63,14 +63,14 @@ func (c *Client) ModifyVolumeAttribute(ctx context.Context, params *ModifyVolume type ModifyVolumeAttributeInput struct { - // Indicates whether the volume should be auto-enabled for I/O operations. - AutoEnableIO *types.AttributeBooleanValue - // The ID of the volume. // // This member is required. VolumeId *string + // Indicates whether the volume should be auto-enabled for I/O operations. + AutoEnableIO *types.AttributeBooleanValue + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is diff --git a/service/ec2/api_op_ModifyVpcAttribute.go b/service/ec2/api_op_ModifyVpcAttribute.go index 2e0080c5a52..919d98ad12b 100644 --- a/service/ec2/api_op_ModifyVpcAttribute.go +++ b/service/ec2/api_op_ModifyVpcAttribute.go @@ -57,15 +57,6 @@ func (c *Client) ModifyVpcAttribute(ctx context.Context, params *ModifyVpcAttrib type ModifyVpcAttributeInput struct { - // Indicates whether the DNS resolution is supported for the VPC. If enabled, - // queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or - // the reserved IP address at the base of the VPC network range "plus two" succeed. - // If disabled, the Amazon provided DNS service in the VPC that resolves public DNS - // hostnames to IP addresses is not enabled. You cannot modify the DNS resolution - // and DNS hostnames attributes in the same request. Use separate requests for each - // attribute. - EnableDnsSupport *types.AttributeBooleanValue - // The ID of the VPC. // // This member is required. @@ -77,6 +68,15 @@ type ModifyVpcAttributeInput struct { // request. Use separate requests for each attribute. You can only enable DNS // hostnames if you've enabled DNS support. EnableDnsHostnames *types.AttributeBooleanValue + + // Indicates whether the DNS resolution is supported for the VPC. If enabled, + // queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or + // the reserved IP address at the base of the VPC network range "plus two" succeed. + // If disabled, the Amazon provided DNS service in the VPC that resolves public DNS + // hostnames to IP addresses is not enabled. You cannot modify the DNS resolution + // and DNS hostnames attributes in the same request. Use separate requests for each + // attribute. + EnableDnsSupport *types.AttributeBooleanValue } type ModifyVpcAttributeOutput struct { diff --git a/service/ec2/api_op_ModifyVpcEndpoint.go b/service/ec2/api_op_ModifyVpcEndpoint.go index 69ff4b16791..6e52ce64b38 100644 --- a/service/ec2/api_op_ModifyVpcEndpoint.go +++ b/service/ec2/api_op_ModifyVpcEndpoint.go @@ -61,49 +61,49 @@ func (c *Client) ModifyVpcEndpoint(ctx context.Context, params *ModifyVpcEndpoin // Contains the parameters for ModifyVpcEndpoint. type ModifyVpcEndpointInput struct { - // (Gateway endpoint) One or more route table IDs to disassociate from the - // endpoint. - RemoveRouteTableIds []*string - - // (Interface endpoint) Indicates whether a private hosted zone is associated with - // the VPC. - PrivateDnsEnabled *bool - // The ID of the endpoint. // // This member is required. VpcEndpointId *string - // (Gateway endpoint) Specify true to reset the policy document to the default - // policy. The default policy allows full access to the service. - ResetPolicy *bool + // (Gateway endpoint) One or more route tables IDs to associate with the endpoint. + AddRouteTableIds []*string + + // (Interface endpoint) One or more security group IDs to associate with the + // network interface. + AddSecurityGroupIds []*string // (Interface endpoint) One or more subnet IDs in which to serve the endpoint. AddSubnetIds []*string - // A policy to attach to the endpoint that controls access to the service. The - // policy must be in valid JSON format. - PolicyDocument *string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // (Interface endpoint) One or more security group IDs to associate with the - // network interface. - AddSecurityGroupIds []*string + // A policy to attach to the endpoint that controls access to the service. The + // policy must be in valid JSON format. + PolicyDocument *string + + // (Interface endpoint) Indicates whether a private hosted zone is associated with + // the VPC. + PrivateDnsEnabled *bool + + // (Gateway endpoint) One or more route table IDs to disassociate from the + // endpoint. + RemoveRouteTableIds []*string // (Interface endpoint) One or more security group IDs to disassociate from the // network interface. RemoveSecurityGroupIds []*string - // (Gateway endpoint) One or more route tables IDs to associate with the endpoint. - AddRouteTableIds []*string - // (Interface endpoint) One or more subnets IDs in which to remove the endpoint. RemoveSubnetIds []*string + + // (Gateway endpoint) Specify true to reset the policy document to the default + // policy. The default policy allows full access to the service. + ResetPolicy *bool } type ModifyVpcEndpointOutput struct { diff --git a/service/ec2/api_op_ModifyVpcEndpointConnectionNotification.go b/service/ec2/api_op_ModifyVpcEndpointConnectionNotification.go index 30373be3f64..39697124953 100644 --- a/service/ec2/api_op_ModifyVpcEndpointConnectionNotification.go +++ b/service/ec2/api_op_ModifyVpcEndpointConnectionNotification.go @@ -58,17 +58,17 @@ func (c *Client) ModifyVpcEndpointConnectionNotification(ctx context.Context, pa type ModifyVpcEndpointConnectionNotificationInput struct { - // The ARN for the SNS topic for the notification. - ConnectionNotificationArn *string + // The ID of the notification. + // + // This member is required. + ConnectionNotificationId *string // One or more events for the endpoint. Valid values are Accept, Connect, Delete, // and Reject. ConnectionEvents []*string - // The ID of the notification. - // - // This member is required. - ConnectionNotificationId *string + // The ARN for the SNS topic for the notification. + ConnectionNotificationArn *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the diff --git a/service/ec2/api_op_ModifyVpcEndpointServiceConfiguration.go b/service/ec2/api_op_ModifyVpcEndpointServiceConfiguration.go index 7e67c58a0cd..4d1983c7b3e 100644 --- a/service/ec2/api_op_ModifyVpcEndpointServiceConfiguration.go +++ b/service/ec2/api_op_ModifyVpcEndpointServiceConfiguration.go @@ -63,6 +63,15 @@ func (c *Client) ModifyVpcEndpointServiceConfiguration(ctx context.Context, para type ModifyVpcEndpointServiceConfigurationInput struct { + // The ID of the service. + // + // This member is required. + ServiceId *string + + // Indicates whether requests to create an endpoint to your service must be + // accepted. + AcceptanceRequired *bool + // The Amazon Resource Names (ARNs) of Network Load Balancers to add to your // service configuration. AddNetworkLoadBalancerArns []*string @@ -73,21 +82,12 @@ type ModifyVpcEndpointServiceConfigurationInput struct { // UnauthorizedOperation. DryRun *bool - // The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your - // service configuration. - RemoveNetworkLoadBalancerArns []*string - - // The ID of the service. - // - // This member is required. - ServiceId *string - // The private DNS name to assign to the endpoint service. PrivateDnsName *string - // Indicates whether requests to create an endpoint to your service must be - // accepted. - AcceptanceRequired *bool + // The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your + // service configuration. + RemoveNetworkLoadBalancerArns []*string // Removes the private DNS name of the endpoint service. RemovePrivateDnsName *bool diff --git a/service/ec2/api_op_ModifyVpcEndpointServicePermissions.go b/service/ec2/api_op_ModifyVpcEndpointServicePermissions.go index 4d9d079e8ce..f1d62fae640 100644 --- a/service/ec2/api_op_ModifyVpcEndpointServicePermissions.go +++ b/service/ec2/api_op_ModifyVpcEndpointServicePermissions.go @@ -62,21 +62,21 @@ func (c *Client) ModifyVpcEndpointServicePermissions(ctx context.Context, params type ModifyVpcEndpointServicePermissionsInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The ID of the service. + // + // This member is required. + ServiceId *string // The Amazon Resource Names (ARN) of one or more principals. Permissions are // granted to the principals in this list. To grant permissions to all principals, // specify an asterisk (*). AddAllowedPrincipals []*string - // The ID of the service. - // - // This member is required. - ServiceId *string + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // The Amazon Resource Names (ARN) of one or more principals. Permissions are // revoked for principals in this list. diff --git a/service/ec2/api_op_ModifyVpcPeeringConnectionOptions.go b/service/ec2/api_op_ModifyVpcPeeringConnectionOptions.go index a31a050b3e3..f1497a4b289 100644 --- a/service/ec2/api_op_ModifyVpcPeeringConnectionOptions.go +++ b/service/ec2/api_op_ModifyVpcPeeringConnectionOptions.go @@ -87,9 +87,6 @@ type ModifyVpcPeeringConnectionOptionsInput struct { // This member is required. VpcPeeringConnectionId *string - // The VPC peering connection options for the requester VPC. - RequesterPeeringConnectionOptions *types.PeeringConnectionOptionsRequest - // The VPC peering connection options for the accepter VPC. AccepterPeeringConnectionOptions *types.PeeringConnectionOptionsRequest @@ -98,6 +95,9 @@ type ModifyVpcPeeringConnectionOptionsInput struct { // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // The VPC peering connection options for the requester VPC. + RequesterPeeringConnectionOptions *types.PeeringConnectionOptionsRequest } type ModifyVpcPeeringConnectionOptionsOutput struct { diff --git a/service/ec2/api_op_ModifyVpnConnection.go b/service/ec2/api_op_ModifyVpnConnection.go index d48e43df773..1e5560fa9e4 100644 --- a/service/ec2/api_op_ModifyVpnConnection.go +++ b/service/ec2/api_op_ModifyVpnConnection.go @@ -91,20 +91,20 @@ func (c *Client) ModifyVpnConnection(ctx context.Context, params *ModifyVpnConne type ModifyVpnConnectionInput struct { + // The ID of the VPN connection. + // + // This member is required. + VpnConnectionId *string + + // The ID of the customer gateway at your end of the VPN connection. + CustomerGatewayId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // The ID of the customer gateway at your end of the VPN connection. - CustomerGatewayId *string - - // The ID of the VPN connection. - // - // This member is required. - VpnConnectionId *string - // The ID of the transit gateway. TransitGatewayId *string diff --git a/service/ec2/api_op_ModifyVpnTunnelCertificate.go b/service/ec2/api_op_ModifyVpnTunnelCertificate.go index 732d93eddac..5e2296763f8 100644 --- a/service/ec2/api_op_ModifyVpnTunnelCertificate.go +++ b/service/ec2/api_op_ModifyVpnTunnelCertificate.go @@ -62,16 +62,16 @@ type ModifyVpnTunnelCertificateInput struct { // This member is required. VpnConnectionId *string + // The external IP address of the VPN tunnel. + // + // This member is required. + VpnTunnelOutsideIpAddress *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The external IP address of the VPN tunnel. - // - // This member is required. - VpnTunnelOutsideIpAddress *string } type ModifyVpnTunnelCertificateOutput struct { diff --git a/service/ec2/api_op_ModifyVpnTunnelOptions.go b/service/ec2/api_op_ModifyVpnTunnelOptions.go index 1bd412ca702..9f3d8b646a4 100644 --- a/service/ec2/api_op_ModifyVpnTunnelOptions.go +++ b/service/ec2/api_op_ModifyVpnTunnelOptions.go @@ -62,26 +62,26 @@ func (c *Client) ModifyVpnTunnelOptions(ctx context.Context, params *ModifyVpnTu type ModifyVpnTunnelOptionsInput struct { + // The tunnel options to modify. + // + // This member is required. + TunnelOptions *types.ModifyVpnTunnelOptionsSpecification + // The ID of the AWS Site-to-Site VPN connection. // // This member is required. VpnConnectionId *string - // The tunnel options to modify. + // The external IP address of the VPN tunnel. // // This member is required. - TunnelOptions *types.ModifyVpnTunnelOptionsSpecification + VpnTunnelOutsideIpAddress *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The external IP address of the VPN tunnel. - // - // This member is required. - VpnTunnelOutsideIpAddress *string } type ModifyVpnTunnelOptionsOutput struct { diff --git a/service/ec2/api_op_MonitorInstances.go b/service/ec2/api_op_MonitorInstances.go index af630254458..c85e065fb0f 100644 --- a/service/ec2/api_op_MonitorInstances.go +++ b/service/ec2/api_op_MonitorInstances.go @@ -61,16 +61,16 @@ func (c *Client) MonitorInstances(ctx context.Context, params *MonitorInstancesI type MonitorInstancesInput struct { + // The IDs of the instances. + // + // This member is required. + InstanceIds []*string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The IDs of the instances. - // - // This member is required. - InstanceIds []*string } type MonitorInstancesOutput struct { diff --git a/service/ec2/api_op_MoveAddressToVpc.go b/service/ec2/api_op_MoveAddressToVpc.go index 57504ab3ca8..3a026d1fdb8 100644 --- a/service/ec2/api_op_MoveAddressToVpc.go +++ b/service/ec2/api_op_MoveAddressToVpc.go @@ -77,12 +77,12 @@ type MoveAddressToVpcInput struct { type MoveAddressToVpcOutput struct { - // The status of the move of the IP address. - Status types.Status - // The allocation ID for the Elastic IP address. AllocationId *string + // The status of the move of the IP address. + Status types.Status + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_ProvisionByoipCidr.go b/service/ec2/api_op_ProvisionByoipCidr.go index cde00444904..b9c8be90944 100644 --- a/service/ec2/api_op_ProvisionByoipCidr.go +++ b/service/ec2/api_op_ProvisionByoipCidr.go @@ -72,12 +72,20 @@ func (c *Client) ProvisionByoipCidr(ctx context.Context, params *ProvisionByoipC type ProvisionByoipCidrInput struct { - // The tags to apply to the address pool. - PoolTagSpecifications []*types.TagSpecification + // The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 + // prefix that you can specify is /24. The most specific IPv6 prefix you can + // specify is /56. The address range cannot overlap with another address range that + // you've brought to this or another Region. + // + // This member is required. + Cidr *string - // (IPv6 only) Indicate whether the address range will be publicly advertised to - // the internet. Default: true - PubliclyAdvertisable *bool + // A signed document that proves that you are authorized to bring the specified IP + // address range to Amazon using BYOIP. + CidrAuthorizationContext *types.CidrAuthorizationContext + + // A description for the address range and the address pool. + Description *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the @@ -85,20 +93,12 @@ type ProvisionByoipCidrInput struct { // UnauthorizedOperation. DryRun *bool - // A description for the address range and the address pool. - Description *string - - // A signed document that proves that you are authorized to bring the specified IP - // address range to Amazon using BYOIP. - CidrAuthorizationContext *types.CidrAuthorizationContext + // The tags to apply to the address pool. + PoolTagSpecifications []*types.TagSpecification - // The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 - // prefix that you can specify is /24. The most specific IPv6 prefix you can - // specify is /56. The address range cannot overlap with another address range that - // you've brought to this or another Region. - // - // This member is required. - Cidr *string + // (IPv6 only) Indicate whether the address range will be publicly advertised to + // the internet. Default: true + PubliclyAdvertisable *bool } type ProvisionByoipCidrOutput struct { diff --git a/service/ec2/api_op_PurchaseHostReservation.go b/service/ec2/api_op_PurchaseHostReservation.go index 1cd73de80c7..e2a7dc04e3b 100644 --- a/service/ec2/api_op_PurchaseHostReservation.go +++ b/service/ec2/api_op_PurchaseHostReservation.go @@ -60,21 +60,6 @@ func (c *Client) PurchaseHostReservation(ctx context.Context, params *PurchaseHo type PurchaseHostReservationInput struct { - // The tags to apply to the Dedicated Host Reservation during purchase. - TagSpecifications []*types.TagSpecification - - // The specified limit is checked against the total upfront cost of the reservation - // (calculated as the offering's upfront cost multiplied by the host count). If the - // total upfront cost is greater than the specified price limit, the request fails. - // This is used to ensure that the purchase does not exceed the expected upfront - // cost of the purchase. At this time, the only supported currency is USD. For - // example, to indicate a limit price of USD 100, specify 100.00. - LimitPrice *string - - // The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice - // amounts are specified. At this time, the only supported currency is USD. - CurrencyCode types.CurrencyCodeValues - // The IDs of the Dedicated Hosts with which the reservation will be associated. // // This member is required. @@ -89,10 +74,30 @@ type PurchaseHostReservationInput struct { // the request. For more information, see How to Ensure Idempotency // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). ClientToken *string + + // The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice + // amounts are specified. At this time, the only supported currency is USD. + CurrencyCode types.CurrencyCodeValues + + // The specified limit is checked against the total upfront cost of the reservation + // (calculated as the offering's upfront cost multiplied by the host count). If the + // total upfront cost is greater than the specified price limit, the request fails. + // This is used to ensure that the purchase does not exceed the expected upfront + // cost of the purchase. At this time, the only supported currency is USD. For + // example, to indicate a limit price of USD 100, specify 100.00. + LimitPrice *string + + // The tags to apply to the Dedicated Host Reservation during purchase. + TagSpecifications []*types.TagSpecification } type PurchaseHostReservationOutput struct { + // Unique, case-sensitive identifier that you provide to ensure the idempotency of + // the request. For more information, see How to Ensure Idempotency + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + ClientToken *string + // The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are // specified. At this time, the only supported currency is USD. CurrencyCode types.CurrencyCodeValues @@ -100,17 +105,12 @@ type PurchaseHostReservationOutput struct { // Describes the details of the purchase. Purchase []*types.Purchase - // The total amount charged to your account when you purchase the reservation. - TotalUpfrontPrice *string - - // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to Ensure Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). - ClientToken *string - // The total hourly price of the reservation calculated per hour. TotalHourlyPrice *string + // The total amount charged to your account when you purchase the reservation. + TotalUpfrontPrice *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_PurchaseReservedInstancesOffering.go b/service/ec2/api_op_PurchaseReservedInstancesOffering.go index bba4f457614..3d59120dd87 100644 --- a/service/ec2/api_op_PurchaseReservedInstancesOffering.go +++ b/service/ec2/api_op_PurchaseReservedInstancesOffering.go @@ -70,21 +70,21 @@ func (c *Client) PurchaseReservedInstancesOffering(ctx context.Context, params * // Contains the parameters for PurchaseReservedInstancesOffering. type PurchaseReservedInstancesOfferingInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool + // The number of Reserved Instances to purchase. + // + // This member is required. + InstanceCount *int32 // The ID of the Reserved Instance offering to purchase. // // This member is required. ReservedInstancesOfferingId *string - // The number of Reserved Instances to purchase. - // - // This member is required. - InstanceCount *int32 + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool // Specified for Reserved Instance Marketplace offerings to limit the total order // and ensure that the Reserved Instances are not purchased at unexpected prices. diff --git a/service/ec2/api_op_PurchaseScheduledInstances.go b/service/ec2/api_op_PurchaseScheduledInstances.go index e2bc3a1bc2d..5b38f1ba551 100644 --- a/service/ec2/api_op_PurchaseScheduledInstances.go +++ b/service/ec2/api_op_PurchaseScheduledInstances.go @@ -66,16 +66,16 @@ func (c *Client) PurchaseScheduledInstances(ctx context.Context, params *Purchas // Contains the parameters for PurchaseScheduledInstances. type PurchaseScheduledInstancesInput struct { - // Unique, case-sensitive identifier that ensures the idempotency of the request. - // For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). - ClientToken *string - // The purchase requests. // // This member is required. PurchaseRequests []*types.PurchaseRequest + // Unique, case-sensitive identifier that ensures the idempotency of the request. + // For more information, see Ensuring Idempotency + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + ClientToken *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is diff --git a/service/ec2/api_op_RebootInstances.go b/service/ec2/api_op_RebootInstances.go index 631813e8273..ef43cc73d21 100644 --- a/service/ec2/api_op_RebootInstances.go +++ b/service/ec2/api_op_RebootInstances.go @@ -63,16 +63,16 @@ func (c *Client) RebootInstances(ctx context.Context, params *RebootInstancesInp type RebootInstancesInput struct { + // The instance IDs. + // + // This member is required. + InstanceIds []*string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The instance IDs. - // - // This member is required. - InstanceIds []*string } type RebootInstancesOutput struct { diff --git a/service/ec2/api_op_RegisterImage.go b/service/ec2/api_op_RegisterImage.go index b12591348e3..ce4aba74f57 100644 --- a/service/ec2/api_op_RegisterImage.go +++ b/service/ec2/api_op_RegisterImage.go @@ -91,34 +91,27 @@ func (c *Client) RegisterImage(ctx context.Context, params *RegisterImageInput, // Contains the parameters for RegisterImage. type RegisterImageInput struct { - // Set to simple to enable enhanced networking with the Intel 82599 Virtual - // Function interface for the AMI and any instances that you launch from the AMI. - // There is no way to disable sriovNetSupport at this time. This option is - // supported only for HVM AMIs. Specifying this option with a PV AMI can make - // instances launched from the AMI unreachable. - SriovNetSupport *string - - // The full path to your AMI manifest in Amazon S3 storage. The specified bucket - // must have the aws-exec-read canned access control list (ACL) to ensure that it - // can be accessed by Amazon EC2. For more information, see Canned ACLs - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) - // in the Amazon S3 Service Developer Guide. - ImageLocation *string + // A name for your AMI. Constraints: 3-128 alphanumeric characters, parentheses + // (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), + // single quotes ('), at-signs (@), or underscores(_) + // + // This member is required. + Name *string - // The device name of the root device volume (for example, /dev/sda1). - RootDeviceName *string + // The architecture of the AMI. Default: For Amazon EBS-backed AMIs, i386. For + // instance store-backed AMIs, the architecture specified in the manifest file. + Architecture types.ArchitectureValues // The billing product codes. Your account must be authorized to specify billing // product codes. Otherwise, you can use the AWS Marketplace to bill for the use of // an AMI. BillingProducts []*string - // The architecture of the AMI. Default: For Amazon EBS-backed AMIs, i386. For - // instance store-backed AMIs, the architecture specified in the manifest file. - Architecture types.ArchitectureValues + // The block device mapping entries. + BlockDeviceMappings []*types.BlockDeviceMapping - // The type of virtualization (hvm | paravirtual). Default: paravirtual - VirtualizationType *string + // A description for your AMI. + Description *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the @@ -126,30 +119,37 @@ type RegisterImageInput struct { // UnauthorizedOperation. DryRun *bool + // Set to true to enable enhanced networking with ENA for the AMI and any instances + // that you launch from the AMI. This option is supported only for HVM AMIs. + // Specifying this option with a PV AMI can make instances launched from the AMI + // unreachable. + EnaSupport *bool + + // The full path to your AMI manifest in Amazon S3 storage. The specified bucket + // must have the aws-exec-read canned access control list (ACL) to ensure that it + // can be accessed by Amazon EC2. For more information, see Canned ACLs + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) + // in the Amazon S3 Service Developer Guide. + ImageLocation *string + // The ID of the kernel. KernelId *string // The ID of the RAM disk. RamdiskId *string - // A name for your AMI. Constraints: 3-128 alphanumeric characters, parentheses - // (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), - // single quotes ('), at-signs (@), or underscores(_) - // - // This member is required. - Name *string - - // A description for your AMI. - Description *string + // The device name of the root device volume (for example, /dev/sda1). + RootDeviceName *string - // The block device mapping entries. - BlockDeviceMappings []*types.BlockDeviceMapping + // Set to simple to enable enhanced networking with the Intel 82599 Virtual + // Function interface for the AMI and any instances that you launch from the AMI. + // There is no way to disable sriovNetSupport at this time. This option is + // supported only for HVM AMIs. Specifying this option with a PV AMI can make + // instances launched from the AMI unreachable. + SriovNetSupport *string - // Set to true to enable enhanced networking with ENA for the AMI and any instances - // that you launch from the AMI. This option is supported only for HVM AMIs. - // Specifying this option with a PV AMI can make instances launched from the AMI - // unreachable. - EnaSupport *bool + // The type of virtualization (hvm | paravirtual). Default: paravirtual + VirtualizationType *string } // Contains the output of RegisterImage. diff --git a/service/ec2/api_op_RegisterTransitGatewayMulticastGroupMembers.go b/service/ec2/api_op_RegisterTransitGatewayMulticastGroupMembers.go index fa0245bde59..c27c652e1d3 100644 --- a/service/ec2/api_op_RegisterTransitGatewayMulticastGroupMembers.go +++ b/service/ec2/api_op_RegisterTransitGatewayMulticastGroupMembers.go @@ -64,13 +64,6 @@ func (c *Client) RegisterTransitGatewayMulticastGroupMembers(ctx context.Context type RegisterTransitGatewayMulticastGroupMembersInput struct { - // The group members' network interface IDs to register with the transit gateway - // multicast group. - NetworkInterfaceIds []*string - - // The ID of the transit gateway multicast domain. - TransitGatewayMulticastDomainId *string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -79,6 +72,13 @@ type RegisterTransitGatewayMulticastGroupMembersInput struct { // The IP address assigned to the transit gateway multicast group. GroupIpAddress *string + + // The group members' network interface IDs to register with the transit gateway + // multicast group. + NetworkInterfaceIds []*string + + // The ID of the transit gateway multicast domain. + TransitGatewayMulticastDomainId *string } type RegisterTransitGatewayMulticastGroupMembersOutput struct { diff --git a/service/ec2/api_op_RegisterTransitGatewayMulticastGroupSources.go b/service/ec2/api_op_RegisterTransitGatewayMulticastGroupSources.go index 7a38fd22cca..f18eeb1eb6e 100644 --- a/service/ec2/api_op_RegisterTransitGatewayMulticastGroupSources.go +++ b/service/ec2/api_op_RegisterTransitGatewayMulticastGroupSources.go @@ -64,15 +64,15 @@ func (c *Client) RegisterTransitGatewayMulticastGroupSources(ctx context.Context type RegisterTransitGatewayMulticastGroupSourcesInput struct { - // The IP address assigned to the transit gateway multicast group. - GroupIpAddress *string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + // The IP address assigned to the transit gateway multicast group. + GroupIpAddress *string + // The group sources' network interface IDs to register with the transit gateway // multicast group. NetworkInterfaceIds []*string diff --git a/service/ec2/api_op_RejectTransitGatewayVpcAttachment.go b/service/ec2/api_op_RejectTransitGatewayVpcAttachment.go index 09c3afe6de4..c20d3187c7b 100644 --- a/service/ec2/api_op_RejectTransitGatewayVpcAttachment.go +++ b/service/ec2/api_op_RejectTransitGatewayVpcAttachment.go @@ -60,16 +60,16 @@ func (c *Client) RejectTransitGatewayVpcAttachment(ctx context.Context, params * type RejectTransitGatewayVpcAttachmentInput struct { + // The ID of the attachment. + // + // This member is required. + TransitGatewayAttachmentId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The ID of the attachment. - // - // This member is required. - TransitGatewayAttachmentId *string } type RejectTransitGatewayVpcAttachmentOutput struct { diff --git a/service/ec2/api_op_RejectVpcEndpointConnections.go b/service/ec2/api_op_RejectVpcEndpointConnections.go index a972c35e051..519e7ad35c0 100644 --- a/service/ec2/api_op_RejectVpcEndpointConnections.go +++ b/service/ec2/api_op_RejectVpcEndpointConnections.go @@ -58,6 +58,11 @@ func (c *Client) RejectVpcEndpointConnections(ctx context.Context, params *Rejec type RejectVpcEndpointConnectionsInput struct { + // The ID of the service. + // + // This member is required. + ServiceId *string + // The IDs of one or more VPC endpoints. // // This member is required. @@ -68,11 +73,6 @@ type RejectVpcEndpointConnectionsInput struct { // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The ID of the service. - // - // This member is required. - ServiceId *string } type RejectVpcEndpointConnectionsOutput struct { diff --git a/service/ec2/api_op_RejectVpcPeeringConnection.go b/service/ec2/api_op_RejectVpcPeeringConnection.go index 859f060bf11..57b2121f580 100644 --- a/service/ec2/api_op_RejectVpcPeeringConnection.go +++ b/service/ec2/api_op_RejectVpcPeeringConnection.go @@ -60,16 +60,16 @@ func (c *Client) RejectVpcPeeringConnection(ctx context.Context, params *RejectV type RejectVpcPeeringConnectionInput struct { + // The ID of the VPC peering connection. + // + // This member is required. + VpcPeeringConnectionId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The ID of the VPC peering connection. - // - // This member is required. - VpcPeeringConnectionId *string } type RejectVpcPeeringConnectionOutput struct { diff --git a/service/ec2/api_op_ReleaseAddress.go b/service/ec2/api_op_ReleaseAddress.go index fdb120ae84a..b11f868fc96 100644 --- a/service/ec2/api_op_ReleaseAddress.go +++ b/service/ec2/api_op_ReleaseAddress.go @@ -66,6 +66,9 @@ func (c *Client) ReleaseAddress(ctx context.Context, params *ReleaseAddressInput type ReleaseAddressInput struct { + // [EC2-VPC] The allocation ID. Required for EC2-VPC. + AllocationId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -84,9 +87,6 @@ type ReleaseAddressInput struct { // [EC2-Classic] The Elastic IP address. Required for EC2-Classic. PublicIp *string - - // [EC2-VPC] The allocation ID. Required for EC2-VPC. - AllocationId *string } type ReleaseAddressOutput struct { diff --git a/service/ec2/api_op_ReplaceIamInstanceProfileAssociation.go b/service/ec2/api_op_ReplaceIamInstanceProfileAssociation.go index 776ffb5ea28..d6de55d6934 100644 --- a/service/ec2/api_op_ReplaceIamInstanceProfileAssociation.go +++ b/service/ec2/api_op_ReplaceIamInstanceProfileAssociation.go @@ -60,15 +60,15 @@ func (c *Client) ReplaceIamInstanceProfileAssociation(ctx context.Context, param type ReplaceIamInstanceProfileAssociationInput struct { - // The IAM instance profile. + // The ID of the existing IAM instance profile association. // // This member is required. - IamInstanceProfile *types.IamInstanceProfileSpecification + AssociationId *string - // The ID of the existing IAM instance profile association. + // The IAM instance profile. // // This member is required. - AssociationId *string + IamInstanceProfile *types.IamInstanceProfileSpecification } type ReplaceIamInstanceProfileAssociationOutput struct { diff --git a/service/ec2/api_op_ReplaceNetworkAclAssociation.go b/service/ec2/api_op_ReplaceNetworkAclAssociation.go index b580df60d35..f00c5620963 100644 --- a/service/ec2/api_op_ReplaceNetworkAclAssociation.go +++ b/service/ec2/api_op_ReplaceNetworkAclAssociation.go @@ -60,12 +60,6 @@ func (c *Client) ReplaceNetworkAclAssociation(ctx context.Context, params *Repla type ReplaceNetworkAclAssociationInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The ID of the current association between the original network ACL and the // subnet. // @@ -76,6 +70,12 @@ type ReplaceNetworkAclAssociationInput struct { // // This member is required. NetworkAclId *string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool } type ReplaceNetworkAclAssociationOutput struct { diff --git a/service/ec2/api_op_ReplaceNetworkAclEntry.go b/service/ec2/api_op_ReplaceNetworkAclEntry.go index eae5180c396..5e0c1a72075 100644 --- a/service/ec2/api_op_ReplaceNetworkAclEntry.go +++ b/service/ec2/api_op_ReplaceNetworkAclEntry.go @@ -59,25 +59,16 @@ func (c *Client) ReplaceNetworkAclEntry(ctx context.Context, params *ReplaceNetw type ReplaceNetworkAclEntryInput struct { - // The IPv4 network range to allow or deny, in CIDR notation (for example - // 172.16.0.0/24). - CidrBlock *string - // Indicates whether to replace the egress rule. Default: If no value is specified, // we replace the ingress rule. // // This member is required. Egress *bool - // The rule number of the entry to replace. - // - // This member is required. - RuleNumber *int32 - - // Indicates whether to allow or deny the traffic that matches the rule. + // The ID of the ACL. // // This member is required. - RuleAction types.RuleAction + NetworkAclId *string // The protocol number. A value of "-1" means all protocols. If you specify "-1" or // a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on @@ -90,28 +81,37 @@ type ReplaceNetworkAclEntryInput struct { // This member is required. Protocol *string + // Indicates whether to allow or deny the traffic that matches the rule. + // + // This member is required. + RuleAction types.RuleAction + + // The rule number of the entry to replace. + // + // This member is required. + RuleNumber *int32 + + // The IPv4 network range to allow or deny, in CIDR notation (for example + // 172.16.0.0/24). + CidrBlock *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // TCP or UDP protocols: The range of ports the rule applies to. Required if - // specifying protocol 6 (TCP) or 17 (UDP). - PortRange *types.PortRange + // ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol + // 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block. + IcmpTypeCode *types.IcmpTypeCode // The IPv6 network range to allow or deny, in CIDR notation (for example // 2001:bd8:1234:1a00::/64). Ipv6CidrBlock *string - // The ID of the ACL. - // - // This member is required. - NetworkAclId *string - - // ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol - // 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block. - IcmpTypeCode *types.IcmpTypeCode + // TCP or UDP protocols: The range of ports the rule applies to. Required if + // specifying protocol 6 (TCP) or 17 (UDP). + PortRange *types.PortRange } type ReplaceNetworkAclEntryOutput struct { diff --git a/service/ec2/api_op_ReplaceRoute.go b/service/ec2/api_op_ReplaceRoute.go index a7dd55691e5..b5797ee7ea0 100644 --- a/service/ec2/api_op_ReplaceRoute.go +++ b/service/ec2/api_op_ReplaceRoute.go @@ -66,29 +66,17 @@ type ReplaceRouteInput struct { // This member is required. RouteTableId *string - // The ID of a transit gateway. - TransitGatewayId *string + // The IPv4 CIDR address block used for the destination match. The value that you + // provide must match the CIDR of an existing route in the table. + DestinationCidrBlock *string // The IPv6 CIDR address block used for the destination match. The value that you // provide must match the CIDR of an existing route in the table. DestinationIpv6CidrBlock *string - // The ID of the local gateway. - LocalGatewayId *string - - // Specifies whether to reset the local route to its default target (local). - LocalTarget *bool - - // The IPv4 CIDR address block used for the destination match. The value that you - // provide must match the CIDR of an existing route in the table. - DestinationCidrBlock *string - // The ID of the prefix list for the route. DestinationPrefixListId *string - // The ID of an internet gateway or virtual private gateway. - GatewayId *string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -98,17 +86,29 @@ type ReplaceRouteInput struct { // [IPv6 traffic only] The ID of an egress-only internet gateway. EgressOnlyInternetGatewayId *string - // The ID of a VPC peering connection. - VpcPeeringConnectionId *string + // The ID of an internet gateway or virtual private gateway. + GatewayId *string - // The ID of a network interface. - NetworkInterfaceId *string + // The ID of a NAT instance in your VPC. + InstanceId *string + + // The ID of the local gateway. + LocalGatewayId *string + + // Specifies whether to reset the local route to its default target (local). + LocalTarget *bool // [IPv4 traffic only] The ID of a NAT gateway. NatGatewayId *string - // The ID of a NAT instance in your VPC. - InstanceId *string + // The ID of a network interface. + NetworkInterfaceId *string + + // The ID of a transit gateway. + TransitGatewayId *string + + // The ID of a VPC peering connection. + VpcPeeringConnectionId *string } type ReplaceRouteOutput struct { diff --git a/service/ec2/api_op_ReplaceRouteTableAssociation.go b/service/ec2/api_op_ReplaceRouteTableAssociation.go index 2de04c89f54..aa9dfb3a330 100644 --- a/service/ec2/api_op_ReplaceRouteTableAssociation.go +++ b/service/ec2/api_op_ReplaceRouteTableAssociation.go @@ -64,12 +64,6 @@ func (c *Client) ReplaceRouteTableAssociation(ctx context.Context, params *Repla type ReplaceRouteTableAssociationInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The association ID. // // This member is required. @@ -79,16 +73,22 @@ type ReplaceRouteTableAssociationInput struct { // // This member is required. RouteTableId *string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool } type ReplaceRouteTableAssociationOutput struct { - // The ID of the new association. - NewAssociationId *string - // The state of the association. AssociationState *types.RouteTableAssociationState + // The ID of the new association. + NewAssociationId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_ReplaceTransitGatewayRoute.go b/service/ec2/api_op_ReplaceTransitGatewayRoute.go index 979755ec6d6..7567a7cf4f2 100644 --- a/service/ec2/api_op_ReplaceTransitGatewayRoute.go +++ b/service/ec2/api_op_ReplaceTransitGatewayRoute.go @@ -57,20 +57,17 @@ func (c *Client) ReplaceTransitGatewayRoute(ctx context.Context, params *Replace type ReplaceTransitGatewayRouteInput struct { - // The ID of the attachment. - TransitGatewayAttachmentId *string - - // The ID of the route table. - // - // This member is required. - TransitGatewayRouteTableId *string - // The CIDR range used for the destination match. Routing decisions are based on // the most specific match. // // This member is required. DestinationCidrBlock *string + // The ID of the route table. + // + // This member is required. + TransitGatewayRouteTableId *string + // Indicates whether traffic matching this route is to be dropped. Blackhole *bool @@ -79,6 +76,9 @@ type ReplaceTransitGatewayRouteInput struct { // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // The ID of the attachment. + TransitGatewayAttachmentId *string } type ReplaceTransitGatewayRouteOutput struct { diff --git a/service/ec2/api_op_ReportInstanceStatus.go b/service/ec2/api_op_ReportInstanceStatus.go index 79a320df304..cf33736919d 100644 --- a/service/ec2/api_op_ReportInstanceStatus.go +++ b/service/ec2/api_op_ReportInstanceStatus.go @@ -63,12 +63,6 @@ func (c *Client) ReportInstanceStatus(ctx context.Context, params *ReportInstanc type ReportInstanceStatusInput struct { - // The time at which the reported instance health state began. - StartTime *time.Time - - // The time at which the reported instance health state ended. - EndTime *time.Time - // The instances. // // This member is required. @@ -113,14 +107,20 @@ type ReportInstanceStatusInput struct { // This member is required. Status types.ReportStatusType + // Descriptive text about the health state of your instance. + Description *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // Descriptive text about the health state of your instance. - Description *string + // The time at which the reported instance health state ended. + EndTime *time.Time + + // The time at which the reported instance health state began. + StartTime *time.Time } type ReportInstanceStatusOutput struct { diff --git a/service/ec2/api_op_RequestSpotInstances.go b/service/ec2/api_op_RequestSpotInstances.go index 144073eca7c..fd865db62d3 100644 --- a/service/ec2/api_op_RequestSpotInstances.go +++ b/service/ec2/api_op_RequestSpotInstances.go @@ -62,17 +62,55 @@ func (c *Client) RequestSpotInstances(ctx context.Context, params *RequestSpotIn // Contains the parameters for RequestSpotInstances. type RequestSpotInstancesInput struct { + // The user-specified name for a logical grouping of requests. When you specify an + // Availability Zone group in a Spot Instance request, all Spot Instances in the + // request are launched in the same Availability Zone. Instance proximity is + // maintained with this parameter, but the choice of Availability Zone is not. The + // group applies only to requests for Spot Instances of the same instance type. Any + // additional Spot Instance requests that are specified with the same Availability + // Zone group name are launched in that same Availability Zone, as long as at least + // one instance from the group is still active. If there is no active instance + // running in the Availability Zone group that you specify for a new Spot Instance + // request (all instances are terminated, the request is expired, or the maximum + // price you specified falls below current Spot price), then Amazon EC2 launches + // the instance in any Availability Zone where the constraint can be met. + // Consequently, the subsequent set of Spot Instances could be placed in a + // different zone from the original request, even if you specified the same + // Availability Zone group. Default: Instances are launched in any available + // Availability Zone. + AvailabilityZoneGroup *string + + // The required duration for the Spot Instances (also known as Spot blocks), in + // minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360). + // The duration period starts as soon as your Spot Instance receives its instance + // ID. At the end of the duration period, Amazon EC2 marks the Spot Instance for + // termination and provides a Spot Instance termination notice, which gives the + // instance a two-minute warning before it terminates. You can't specify an + // Availability Zone group or a launch group if you specify a duration. + BlockDurationMinutes *int32 + // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. For more information, see How to Ensure Idempotency // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html) // in the Amazon EC2 User Guide for Linux Instances. ClientToken *string - // The end date of the request. If this is a one-time request, the request remains - // active until all instances launch, the request is canceled, or this date is - // reached. If the request is persistent, it remains active until it is canceled or - // this date is reached. The default end date is 7 days from the current date. - ValidUntil *time.Time + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + + // The maximum number of Spot Instances to launch. Default: 1 + InstanceCount *int32 + + // The behavior when a Spot Instance is interrupted. The default is terminate. + InstanceInterruptionBehavior types.InstanceInterruptionBehavior + + // The instance launch group. Launch groups are Spot Instances that launch together + // and terminate together. Default: Instances are launched and terminated + // individually + LaunchGroup *string // The launch specification. LaunchSpecification *types.RequestSpotLaunchSpecification @@ -81,9 +119,6 @@ type RequestSpotInstancesInput struct { // default is the On-Demand price. SpotPrice *string - // The Spot Instance request type. Default: one-time - Type types.SpotInstanceType - // The key-value pair for tagging the Spot Instance request on creation. The value // for ResourceType must be spot-instances-request, otherwise the Spot Instance // request fails. To tag the Spot Instance request after it has been created, see @@ -91,13 +126,8 @@ type RequestSpotInstancesInput struct { // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). TagSpecifications []*types.TagSpecification - // The instance launch group. Launch groups are Spot Instances that launch together - // and terminate together. Default: Instances are launched and terminated - // individually - LaunchGroup *string - - // The behavior when a Spot Instance is interrupted. The default is terminate. - InstanceInterruptionBehavior types.InstanceInterruptionBehavior + // The Spot Instance request type. Default: one-time + Type types.SpotInstanceType // The start date of the request. If this is a one-time request, the request // becomes active at this date and time and remains active until all instances @@ -108,41 +138,11 @@ type RequestSpotInstancesInput struct { // occurs after the current date and time. ValidFrom *time.Time - // The maximum number of Spot Instances to launch. Default: 1 - InstanceCount *int32 - - // The user-specified name for a logical grouping of requests. When you specify an - // Availability Zone group in a Spot Instance request, all Spot Instances in the - // request are launched in the same Availability Zone. Instance proximity is - // maintained with this parameter, but the choice of Availability Zone is not. The - // group applies only to requests for Spot Instances of the same instance type. Any - // additional Spot Instance requests that are specified with the same Availability - // Zone group name are launched in that same Availability Zone, as long as at least - // one instance from the group is still active. If there is no active instance - // running in the Availability Zone group that you specify for a new Spot Instance - // request (all instances are terminated, the request is expired, or the maximum - // price you specified falls below current Spot price), then Amazon EC2 launches - // the instance in any Availability Zone where the constraint can be met. - // Consequently, the subsequent set of Spot Instances could be placed in a - // different zone from the original request, even if you specified the same - // Availability Zone group. Default: Instances are launched in any available - // Availability Zone. - AvailabilityZoneGroup *string - - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - - // The required duration for the Spot Instances (also known as Spot blocks), in - // minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360). - // The duration period starts as soon as your Spot Instance receives its instance - // ID. At the end of the duration period, Amazon EC2 marks the Spot Instance for - // termination and provides a Spot Instance termination notice, which gives the - // instance a two-minute warning before it terminates. You can't specify an - // Availability Zone group or a launch group if you specify a duration. - BlockDurationMinutes *int32 + // The end date of the request. If this is a one-time request, the request remains + // active until all instances launch, the request is canceled, or this date is + // reached. If the request is persistent, it remains active until it is canceled or + // this date is reached. The default end date is 7 days from the current date. + ValidUntil *time.Time } // Contains the output of RequestSpotInstances. diff --git a/service/ec2/api_op_ResetFpgaImageAttribute.go b/service/ec2/api_op_ResetFpgaImageAttribute.go index a81cc7b74a2..66b253d4ffe 100644 --- a/service/ec2/api_op_ResetFpgaImageAttribute.go +++ b/service/ec2/api_op_ResetFpgaImageAttribute.go @@ -58,12 +58,6 @@ func (c *Client) ResetFpgaImageAttribute(ctx context.Context, params *ResetFpgaI type ResetFpgaImageAttributeInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The ID of the AFI. // // This member is required. @@ -71,6 +65,12 @@ type ResetFpgaImageAttributeInput struct { // The attribute. Attribute types.ResetFpgaImageAttributeName + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool } type ResetFpgaImageAttributeOutput struct { diff --git a/service/ec2/api_op_ResetInstanceAttribute.go b/service/ec2/api_op_ResetInstanceAttribute.go index f98b4df53d6..e423fc2e1ed 100644 --- a/service/ec2/api_op_ResetInstanceAttribute.go +++ b/service/ec2/api_op_ResetInstanceAttribute.go @@ -64,23 +64,23 @@ func (c *Client) ResetInstanceAttribute(ctx context.Context, params *ResetInstan type ResetInstanceAttributeInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - - // The ID of the instance. - // - // This member is required. - InstanceId *string - // The attribute to reset. You can only reset the following attributes: kernel | // ramdisk | sourceDestCheck. To change an instance attribute, use // ModifyInstanceAttribute (). // // This member is required. Attribute types.InstanceAttributeName + + // The ID of the instance. + // + // This member is required. + InstanceId *string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool } type ResetInstanceAttributeOutput struct { diff --git a/service/ec2/api_op_ResetNetworkInterfaceAttribute.go b/service/ec2/api_op_ResetNetworkInterfaceAttribute.go index 55e5dc22cc6..6e7fb3222db 100644 --- a/service/ec2/api_op_ResetNetworkInterfaceAttribute.go +++ b/service/ec2/api_op_ResetNetworkInterfaceAttribute.go @@ -58,17 +58,17 @@ func (c *Client) ResetNetworkInterfaceAttribute(ctx context.Context, params *Res // Contains the parameters for ResetNetworkInterfaceAttribute. type ResetNetworkInterfaceAttributeInput struct { + // The ID of the network interface. + // + // This member is required. + NetworkInterfaceId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // The ID of the network interface. - // - // This member is required. - NetworkInterfaceId *string - // The source/destination checking attribute. Resets the value to true. SourceDestCheck *string } diff --git a/service/ec2/api_op_ResetSnapshotAttribute.go b/service/ec2/api_op_ResetSnapshotAttribute.go index e6dfd1fc811..a7298bb0a86 100644 --- a/service/ec2/api_op_ResetSnapshotAttribute.go +++ b/service/ec2/api_op_ResetSnapshotAttribute.go @@ -60,6 +60,12 @@ func (c *Client) ResetSnapshotAttribute(ctx context.Context, params *ResetSnapsh type ResetSnapshotAttributeInput struct { + // The attribute to reset. Currently, only the attribute for permission to create + // volumes can be reset. + // + // This member is required. + Attribute types.SnapshotAttributeName + // The ID of the snapshot. // // This member is required. @@ -70,12 +76,6 @@ type ResetSnapshotAttributeInput struct { // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The attribute to reset. Currently, only the attribute for permission to create - // volumes can be reset. - // - // This member is required. - Attribute types.SnapshotAttributeName } type ResetSnapshotAttributeOutput struct { diff --git a/service/ec2/api_op_RestoreAddressToClassic.go b/service/ec2/api_op_RestoreAddressToClassic.go index 933f96ae830..16020edb760 100644 --- a/service/ec2/api_op_RestoreAddressToClassic.go +++ b/service/ec2/api_op_RestoreAddressToClassic.go @@ -74,12 +74,12 @@ type RestoreAddressToClassicInput struct { type RestoreAddressToClassicOutput struct { - // The move status for the IP address. - Status types.Status - // The Elastic IP address. PublicIp *string + // The move status for the IP address. + Status types.Status + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_RestoreManagedPrefixListVersion.go b/service/ec2/api_op_RestoreManagedPrefixListVersion.go index 3cad7328cbe..dfb9753455f 100644 --- a/service/ec2/api_op_RestoreManagedPrefixListVersion.go +++ b/service/ec2/api_op_RestoreManagedPrefixListVersion.go @@ -58,6 +58,11 @@ func (c *Client) RestoreManagedPrefixListVersion(ctx context.Context, params *Re type RestoreManagedPrefixListVersionInput struct { + // The current version number for the prefix list. + // + // This member is required. + CurrentVersion *int64 + // The ID of the prefix list. // // This member is required. @@ -68,11 +73,6 @@ type RestoreManagedPrefixListVersionInput struct { // This member is required. PreviousVersion *int64 - // The current version number for the prefix list. - // - // This member is required. - CurrentVersion *int64 - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is diff --git a/service/ec2/api_op_RevokeClientVpnIngress.go b/service/ec2/api_op_RevokeClientVpnIngress.go index af07754292f..73b979b0169 100644 --- a/service/ec2/api_op_RevokeClientVpnIngress.go +++ b/service/ec2/api_op_RevokeClientVpnIngress.go @@ -69,9 +69,6 @@ type RevokeClientVpnIngressInput struct { // This member is required. TargetNetworkCidr *string - // Indicates whether access should be revoked for all clients. - RevokeAllGroups *bool - // The ID of the Active Directory group for which to revoke access. AccessGroupId *string @@ -80,6 +77,9 @@ type RevokeClientVpnIngressInput struct { // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // Indicates whether access should be revoked for all clients. + RevokeAllGroups *bool } type RevokeClientVpnIngressOutput struct { diff --git a/service/ec2/api_op_RevokeSecurityGroupEgress.go b/service/ec2/api_op_RevokeSecurityGroupEgress.go index 91deccd40a0..31e95541248 100644 --- a/service/ec2/api_op_RevokeSecurityGroupEgress.go +++ b/service/ec2/api_op_RevokeSecurityGroupEgress.go @@ -66,41 +66,41 @@ func (c *Client) RevokeSecurityGroupEgress(ctx context.Context, params *RevokeSe type RevokeSecurityGroupEgressInput struct { - // Not supported. Use a set of IP permissions to specify the port. - FromPort *int32 - // The ID of the security group. // // This member is required. GroupId *string + // Not supported. Use a set of IP permissions to specify the CIDR. + CidrIp *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + // Not supported. Use a set of IP permissions to specify the port. + FromPort *int32 + // The sets of IP permissions. You can't specify a destination security group and a // CIDR IP address range in the same set of permissions. IpPermissions []*types.IpPermission + // Not supported. Use a set of IP permissions to specify the protocol name or + // number. + IpProtocol *string + // Not supported. Use a set of IP permissions to specify a destination security // group. SourceSecurityGroupName *string - // Not supported. Use a set of IP permissions to specify the CIDR. - CidrIp *string - // Not supported. Use a set of IP permissions to specify a destination security // group. SourceSecurityGroupOwnerId *string // Not supported. Use a set of IP permissions to specify the port. ToPort *int32 - - // Not supported. Use a set of IP permissions to specify the protocol name or - // number. - IpProtocol *string } type RevokeSecurityGroupEgressOutput struct { diff --git a/service/ec2/api_op_RevokeSecurityGroupIngress.go b/service/ec2/api_op_RevokeSecurityGroupIngress.go index 29c15ec1cd6..72b326e3b42 100644 --- a/service/ec2/api_op_RevokeSecurityGroupIngress.go +++ b/service/ec2/api_op_RevokeSecurityGroupIngress.go @@ -66,22 +66,9 @@ func (c *Client) RevokeSecurityGroupIngress(ctx context.Context, params *RevokeS type RevokeSecurityGroupIngressInput struct { - // The ID of the security group. You must specify either the security group ID or - // the security group name in the request. For security groups in a nondefault VPC, - // you must specify the security group ID. - GroupId *string - - // [EC2-Classic, default VPC] The name of the source security group. You can't - // specify this parameter in combination with the following parameters: the CIDR IP - // address range, the start of the port range, the IP protocol, and the end of the - // port range. For EC2-VPC, the source security group must be in the same VPC. To - // revoke a specific rule for an IP protocol and port range, use a set of IP - // permissions instead. - SourceSecurityGroupName *string - - // The sets of IP permissions. You can't specify a source security group and a CIDR - // IP address range in the same set of permissions. - IpPermissions []*types.IpPermission + // The CIDR IP address range. You can't specify this parameter when specifying a + // source security group. + CidrIp *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the @@ -93,17 +80,31 @@ type RevokeSecurityGroupIngressInput struct { // For the ICMP type number, use -1 to specify all ICMP types. FromPort *int32 + // The ID of the security group. You must specify either the security group ID or + // the security group name in the request. For security groups in a nondefault VPC, + // you must specify the security group ID. + GroupId *string + // [EC2-Classic, default VPC] The name of the security group. You must specify // either the security group ID or the security group name in the request. GroupName *string - // The end of port range for the TCP and UDP protocols, or an ICMP code number. For - // the ICMP code number, use -1 to specify all ICMP codes for the ICMP type. - ToPort *int32 + // The sets of IP permissions. You can't specify a source security group and a CIDR + // IP address range in the same set of permissions. + IpPermissions []*types.IpPermission - // The CIDR IP address range. You can't specify this parameter when specifying a - // source security group. - CidrIp *string + // The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers + // (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)). Use + // -1 to specify all. + IpProtocol *string + + // [EC2-Classic, default VPC] The name of the source security group. You can't + // specify this parameter in combination with the following parameters: the CIDR IP + // address range, the start of the port range, the IP protocol, and the end of the + // port range. For EC2-VPC, the source security group must be in the same VPC. To + // revoke a specific rule for an IP protocol and port range, use a set of IP + // permissions instead. + SourceSecurityGroupName *string // [EC2-Classic] The AWS account ID of the source security group, if the source // security group is in a different account. You can't specify this parameter in @@ -113,10 +114,9 @@ type RevokeSecurityGroupIngressInput struct { // instead. SourceSecurityGroupOwnerId *string - // The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers - // (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)). Use - // -1 to specify all. - IpProtocol *string + // The end of port range for the TCP and UDP protocols, or an ICMP code number. For + // the ICMP code number, use -1 to specify all ICMP codes for the ICMP type. + ToPort *int32 } type RevokeSecurityGroupIngressOutput struct { diff --git a/service/ec2/api_op_RunInstances.go b/service/ec2/api_op_RunInstances.go index d99226b6336..319ebdaa7da 100644 --- a/service/ec2/api_op_RunInstances.go +++ b/service/ec2/api_op_RunInstances.go @@ -116,41 +116,35 @@ func (c *Client) RunInstances(ctx context.Context, params *RunInstancesInput, op type RunInstancesInput struct { - // [EC2-VPC] The number of IPv6 addresses to associate with the primary network - // interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. - // You cannot specify this option and the option to assign specific IPv6 addresses - // in the same request. You can specify this option if you've specified a minimum - // number of instances to launch. You cannot specify this option and the network - // interfaces option in the same request. - Ipv6AddressCount *int32 - - // The IAM instance profile. - IamInstanceProfile *types.IamInstanceProfileSpecification - - // An elastic inference accelerator to associate with the instance. Elastic - // inference accelerators are a resource you can attach to your Amazon EC2 - // instances to accelerate your Deep Learning (DL) inference workloads. You cannot - // specify accelerators from different generations in the same request. - ElasticInferenceAccelerators []*types.ElasticInferenceAccelerator + // The maximum number of instances to launch. If you specify more instances than + // Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the + // largest possible number of instances above MinCount. Constraints: Between 1 and + // the maximum number you're allowed for the specified instance type. For more + // information about the default limits, and how to request an increase, see How + // many instances can I run in Amazon EC2 + // (http://aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2) in + // the Amazon EC2 FAQ. + // + // This member is required. + MaxCount *int32 - // If you set this parameter to true, you can't terminate the instance using the - // Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute - // after launch, use ModifyInstanceAttribute - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html). - // Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you - // can terminate the instance by running the shutdown command from the instance. - // Default: false - DisableApiTermination *bool + // The minimum number of instances to launch. If you specify a minimum that is more + // instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 + // launches no instances. Constraints: Between 1 and the maximum number you're + // allowed for the specified instance type. For more information about the default + // limits, and how to request an increase, see How many instances can I run in + // Amazon EC2 + // (http://aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2) in + // the Amazon EC2 General FAQ. + // + // This member is required. + MinCount *int32 - // Unique, case-sensitive identifier you provide to ensure the idempotency of the - // request. If you do not specify a client token, a randomly generated token is - // used for the request to ensure idempotency.

    For more information, see Ensuring - // Idempotency.

    Constraints: Maximum 64 ASCII characters

    - ClientToken *string + // Reserved. + AdditionalInfo *string - // The placement for the instance. - Placement *types.Placement + // The block device mapping entries. + BlockDeviceMappings []*types.BlockDeviceMapping // Information about the Capacity Reservation targeting option. If you do not // specify this parameter, the instance's Capacity Reservation preference defaults @@ -158,51 +152,37 @@ type RunInstancesInput struct { // matching attributes (instance type, platform, Availability Zone). CapacityReservationSpecification *types.CapacityReservationSpecification - // The metadata options for the instance. For more information, see Instance - // metadata and user data - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html). - MetadataOptions *types.InstanceMetadataOptionsRequest - - // Specifies whether detailed monitoring is enabled for the instance. - Monitoring *types.RunInstancesMonitoringEnabled + // Unique, case-sensitive identifier you provide to ensure the idempotency of the + // request. If you do not specify a client token, a randomly generated token is + // used for the request to ensure idempotency.

    For more information, see Ensuring + // Idempotency.

    Constraints: Maximum 64 ASCII characters

    + ClientToken *string - // The ID of the RAM disk to select. Some kernels require additional drivers at - // launch. Check the kernel requirements for information about whether you need to - // specify a RAM disk. To find kernel requirements, go to the AWS Resource Center - // and search for the kernel ID. We recommend that you use PV-GRUB instead of - // kernels and RAM disks. For more information, see PV-GRUB - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) + // The CPU options for the instance. For more information, see Optimizing CPU + // options + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) // in the Amazon Elastic Compute Cloud User Guide. - RamdiskId *string - - // Indicates whether the instance is optimized for Amazon EBS I/O. This - // optimization provides dedicated throughput to Amazon EBS and an optimized - // configuration stack to provide optimal Amazon EBS I/O performance. This - // optimization isn't available with all instance types. Additional usage charges - // apply when using an EBS-optimized instance. Default: false - EbsOptimized *bool - - // The tags to apply to the resources during launch. You can only tag instances and - // volumes on launch. The specified tags are applied to all instances or volumes - // that are created during launch. To tag a resource after it has been created, see - // CreateTags - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). - TagSpecifications []*types.TagSpecification + CpuOptions *types.CpuOptionsRequest - // The license configurations. - LicenseSpecifications []*types.LicenseConfigurationRequest + // The credit option for CPU usage of the burstable performance instance. Valid + // values are standard and unlimited. To change this attribute after launch, use + // ModifyInstanceCreditSpecification + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceCreditSpecification.html). + // For more information, see Burstable performance instances + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) + // in the Amazon Elastic Compute Cloud User Guide. Default: standard (T2 instances) + // or unlimited (T3/T3a instances) + CreditSpecification *types.CreditSpecificationRequest - // The minimum number of instances to launch. If you specify a minimum that is more - // instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 - // launches no instances. Constraints: Between 1 and the maximum number you're - // allowed for the specified instance type. For more information about the default - // limits, and how to request an increase, see How many instances can I run in - // Amazon EC2 - // (http://aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2) in - // the Amazon EC2 General FAQ. - // - // This member is required. - MinCount *int32 + // If you set this parameter to true, you can't terminate the instance using the + // Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute + // after launch, use ModifyInstanceAttribute + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html). + // Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you + // can terminate the instance by running the shutdown command from the instance. + // Default: false + DisableApiTermination *bool // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the @@ -210,12 +190,12 @@ type RunInstancesInput struct { // UnauthorizedOperation. DryRun *bool - // The IDs of the security groups. You can create a security group using - // CreateSecurityGroup - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSecurityGroup.html). - // If you specify a network interface, you must specify any security groups as part - // of the network interface. - SecurityGroupIds []*string + // Indicates whether the instance is optimized for Amazon EBS I/O. This + // optimization provides dedicated throughput to Amazon EBS and an optimized + // configuration stack to provide optimal Amazon EBS I/O performance. This + // optimization isn't available with all instance types. Additional usage charges + // apply when using an EBS-optimized instance. Default: false + EbsOptimized *bool // An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource // that you can attach to your Windows instance to accelerate the graphics @@ -225,48 +205,60 @@ type RunInstancesInput struct { // in the Amazon Elastic Compute Cloud User Guide. ElasticGpuSpecification []*types.ElasticGpuSpecification - // The block device mapping entries. - BlockDeviceMappings []*types.BlockDeviceMapping - - // The CPU options for the instance. For more information, see Optimizing CPU - // options - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) - // in the Amazon Elastic Compute Cloud User Guide. - CpuOptions *types.CpuOptionsRequest + // An elastic inference accelerator to associate with the instance. Elastic + // inference accelerators are a resource you can attach to your Amazon EC2 + // instances to accelerate your Deep Learning (DL) inference workloads. You cannot + // specify accelerators from different generations in the same request. + ElasticInferenceAccelerators []*types.ElasticInferenceAccelerator - // The market (purchasing) option for the instances. For RunInstances (), - // persistent Spot Instance requests are only supported when - // InstanceInterruptionBehavior is set to either hibernate or stop. - InstanceMarketOptions *types.InstanceMarketOptionsRequest + // Indicates whether an instance is enabled for hibernation. For more information, + // see Hibernate your instance + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the + // Amazon Elastic Compute Cloud User Guide. + HibernationOptions *types.HibernationOptionsRequest - // The maximum number of instances to launch. If you specify more instances than - // Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the - // largest possible number of instances above MinCount. Constraints: Between 1 and - // the maximum number you're allowed for the specified instance type. For more - // information about the default limits, and how to request an increase, see How - // many instances can I run in Amazon EC2 - // (http://aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2) in - // the Amazon EC2 FAQ. - // - // This member is required. - MaxCount *int32 + // The IAM instance profile. + IamInstanceProfile *types.IamInstanceProfileSpecification - // The network interfaces to associate with the instance. If you specify a network - // interface, you must specify any security groups and subnets as part of the - // network interface. - NetworkInterfaces []*types.InstanceNetworkInterfaceSpecification + // The ID of the AMI. An AMI ID is required to launch an instance and must be + // specified here or in a launch template. + ImageId *string // Indicates whether an instance stops or terminates when you initiate shutdown // from the instance (using the operating system command for system shutdown). // Default: stop InstanceInitiatedShutdownBehavior types.ShutdownBehavior - // Reserved. - AdditionalInfo *string + // The market (purchasing) option for the instances. For RunInstances (), + // persistent Spot Instance requests are only supported when + // InstanceInterruptionBehavior is set to either hibernate or stop. + InstanceMarketOptions *types.InstanceMarketOptionsRequest - // The ID of the AMI. An AMI ID is required to launch an instance and must be - // specified here or in a launch template. - ImageId *string + // The instance type. For more information, see Instance types + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the + // Amazon Elastic Compute Cloud User Guide. Default: m1.small + InstanceType types.InstanceType + + // [EC2-VPC] The number of IPv6 addresses to associate with the primary network + // interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. + // You cannot specify this option and the option to assign specific IPv6 addresses + // in the same request. You can specify this option if you've specified a minimum + // number of instances to launch. You cannot specify this option and the network + // interfaces option in the same request. + Ipv6AddressCount *int32 + + // [EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the + // primary network interface. You cannot specify this option and the option to + // assign a number of IPv6 addresses in the same request. You cannot specify this + // option if you've specified a minimum number of instances to launch. You cannot + // specify this option and the network interfaces option in the same request. + Ipv6Addresses []*types.InstanceIpv6Address + + // The ID of the kernel. We recommend that you use PV-GRUB instead of kernels and + // RAM disks. For more information, see PV-GRUB + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) + // in the Amazon Elastic Compute Cloud User Guide. + KernelId *string // The name of the key pair. You can create a key pair using CreateKeyPair // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html) @@ -276,32 +268,29 @@ type RunInstancesInput struct { // choose an AMI that is configured to allow users another way to log in. KeyName *string - // The credit option for CPU usage of the burstable performance instance. Valid - // values are standard and unlimited. To change this attribute after launch, use - // ModifyInstanceCreditSpecification - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceCreditSpecification.html). - // For more information, see Burstable performance instances - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) - // in the Amazon Elastic Compute Cloud User Guide. Default: standard (T2 instances) - // or unlimited (T3/T3a instances) - CreditSpecification *types.CreditSpecificationRequest + // The launch template to use to launch the instances. Any parameters that you + // specify in RunInstances () override the same parameters in the launch template. + // You can specify either the name or ID of a launch template, but not both. + LaunchTemplate *types.LaunchTemplateSpecification - // [EC2-Classic, default VPC] The names of the security groups. For a nondefault - // VPC, you must use security group IDs instead. If you specify a network - // interface, you must specify any security groups as part of the network - // interface. Default: Amazon EC2 uses the default security group. - SecurityGroups []*string + // The license configurations. + LicenseSpecifications []*types.LicenseConfigurationRequest - // Indicates whether an instance is enabled for hibernation. For more information, - // see Hibernate your instance - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the - // Amazon Elastic Compute Cloud User Guide. - HibernationOptions *types.HibernationOptionsRequest + // The metadata options for the instance. For more information, see Instance + // metadata and user data + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html). + MetadataOptions *types.InstanceMetadataOptionsRequest - // The instance type. For more information, see Instance types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the - // Amazon Elastic Compute Cloud User Guide. Default: m1.small - InstanceType types.InstanceType + // Specifies whether detailed monitoring is enabled for the instance. + Monitoring *types.RunInstancesMonitoringEnabled + + // The network interfaces to associate with the instance. If you specify a network + // interface, you must specify any security groups and subnets as part of the + // network interface. + NetworkInterfaces []*types.InstanceNetworkInterfaceSpecification + + // The placement for the instance. + Placement *types.Placement // [EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 // address range of the subnet. Only one private IP address can be designated as @@ -312,11 +301,40 @@ type RunInstancesInput struct { // interfaces option in the same request. PrivateIpAddress *string + // The ID of the RAM disk to select. Some kernels require additional drivers at + // launch. Check the kernel requirements for information about whether you need to + // specify a RAM disk. To find kernel requirements, go to the AWS Resource Center + // and search for the kernel ID. We recommend that you use PV-GRUB instead of + // kernels and RAM disks. For more information, see PV-GRUB + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) + // in the Amazon Elastic Compute Cloud User Guide. + RamdiskId *string + + // The IDs of the security groups. You can create a security group using + // CreateSecurityGroup + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSecurityGroup.html). + // If you specify a network interface, you must specify any security groups as part + // of the network interface. + SecurityGroupIds []*string + + // [EC2-Classic, default VPC] The names of the security groups. For a nondefault + // VPC, you must use security group IDs instead. If you specify a network + // interface, you must specify any security groups as part of the network + // interface. Default: Amazon EC2 uses the default security group. + SecurityGroups []*string + // [EC2-VPC] The ID of the subnet to launch the instance into. If you specify a // network interface, you must specify any subnets as part of the network // interface. SubnetId *string + // The tags to apply to the resources during launch. You can only tag instances and + // volumes on launch. The specified tags are applied to all instances or volumes + // that are created during launch. To tag a resource after it has been created, see + // CreateTags + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). + TagSpecifications []*types.TagSpecification + // The user data to make available to the instance. For more information, see // Running commands on your Linux instance at launch // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) (Linux) and @@ -326,24 +344,6 @@ type RunInstancesInput struct { // for you, and you can load the text from a file. Otherwise, you must provide // base64-encoded text. User data is limited to 16 KB. UserData *string - - // The launch template to use to launch the instances. Any parameters that you - // specify in RunInstances () override the same parameters in the launch template. - // You can specify either the name or ID of a launch template, but not both. - LaunchTemplate *types.LaunchTemplateSpecification - - // [EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the - // primary network interface. You cannot specify this option and the option to - // assign a number of IPv6 addresses in the same request. You cannot specify this - // option if you've specified a minimum number of instances to launch. You cannot - // specify this option and the network interfaces option in the same request. - Ipv6Addresses []*types.InstanceIpv6Address - - // The ID of the kernel. We recommend that you use PV-GRUB instead of kernels and - // RAM disks. For more information, see PV-GRUB - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) - // in the Amazon Elastic Compute Cloud User Guide. - KernelId *string } // Describes a reservation. @@ -355,6 +355,9 @@ type RunInstancesOutput struct { // The instances. Instances []*types.Instance + // The ID of the AWS account that owns the reservation. + OwnerId *string + // The ID of the requester that launched the instances on your behalf (for example, // AWS Management Console or Auto Scaling). RequesterId *string @@ -362,9 +365,6 @@ type RunInstancesOutput struct { // The ID of the reservation. ReservationId *string - // The ID of the AWS account that owns the reservation. - OwnerId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_RunScheduledInstances.go b/service/ec2/api_op_RunScheduledInstances.go index 6266a208c4c..714b23b645e 100644 --- a/service/ec2/api_op_RunScheduledInstances.go +++ b/service/ec2/api_op_RunScheduledInstances.go @@ -68,12 +68,6 @@ func (c *Client) RunScheduledInstances(ctx context.Context, params *RunScheduled // Contains the parameters for RunScheduledInstances. type RunScheduledInstancesInput struct { - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool - // The launch specification. You must match the instance type, Availability Zone, // network, and platform of the schedule that you purchased. // @@ -85,13 +79,19 @@ type RunScheduledInstancesInput struct { // This member is required. ScheduledInstanceId *string - // The number of instances. Default: 1 - InstanceCount *int32 - // Unique, case-sensitive identifier that ensures the idempotency of the request. // For more information, see Ensuring Idempotency // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). ClientToken *string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + + // The number of instances. Default: 1 + InstanceCount *int32 } // Contains the output of RunScheduledInstances. diff --git a/service/ec2/api_op_SearchTransitGatewayMulticastGroups.go b/service/ec2/api_op_SearchTransitGatewayMulticastGroups.go index c221293395c..152a0d6a803 100644 --- a/service/ec2/api_op_SearchTransitGatewayMulticastGroups.go +++ b/service/ec2/api_op_SearchTransitGatewayMulticastGroups.go @@ -57,22 +57,12 @@ func (c *Client) SearchTransitGatewayMulticastGroups(ctx context.Context, params type SearchTransitGatewayMulticastGroupsInput struct { - // The ID of the transit gateway multicast domain. - TransitGatewayMulticastDomainId *string - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. - MaxResults *int32 - - // The token for the next page of results. - NextToken *string - // One or more filters. The possible values are: // // * group-ip-address - The IP @@ -105,17 +95,27 @@ type SearchTransitGatewayMulticastGroupsInput struct { // * // transit-gateway-attachment-id - The id of the transit gateway attachment. Filters []*types.Filter + + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int32 + + // The token for the next page of results. + NextToken *string + + // The ID of the transit gateway multicast domain. + TransitGatewayMulticastDomainId *string } type SearchTransitGatewayMulticastGroupsOutput struct { + // Information about the transit gateway multicast group. + MulticastGroups []*types.TransitGatewayMulticastGroup + // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string - // Information about the transit gateway multicast group. - MulticastGroups []*types.TransitGatewayMulticastGroup - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_SearchTransitGatewayRoutes.go b/service/ec2/api_op_SearchTransitGatewayRoutes.go index 445c88b7250..e7eb3607470 100644 --- a/service/ec2/api_op_SearchTransitGatewayRoutes.go +++ b/service/ec2/api_op_SearchTransitGatewayRoutes.go @@ -97,24 +97,24 @@ type SearchTransitGatewayRoutesInput struct { // This member is required. TransitGatewayRouteTableId *string - // The maximum number of routes to return. - MaxResults *int32 - // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool + + // The maximum number of routes to return. + MaxResults *int32 } type SearchTransitGatewayRoutesOutput struct { - // Information about the routes. - Routes []*types.TransitGatewayRoute - // Indicates whether there are additional routes available. AdditionalRoutesAvailable *bool + // Information about the routes. + Routes []*types.TransitGatewayRoute + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2/api_op_StopInstances.go b/service/ec2/api_op_StopInstances.go index 03b534c4fff..de0a667833a 100644 --- a/service/ec2/api_op_StopInstances.go +++ b/service/ec2/api_op_StopInstances.go @@ -97,29 +97,29 @@ func (c *Client) StopInstances(ctx context.Context, params *StopInstancesInput, type StopInstancesInput struct { + // The IDs of the instances. + // + // This member is required. + InstanceIds []*string + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it is + // UnauthorizedOperation. + DryRun *bool + // Forces the instances to stop. The instances do not have an opportunity to flush // file system caches or file system metadata. If you use this option, you must // perform file system check and repair procedures. This option is not recommended // for Windows instances. Default: false Force *bool - // The IDs of the instances. - // - // This member is required. - InstanceIds []*string - // Hibernates the instance if the instance was enabled for hibernation at launch. // If the instance cannot hibernate successfully, a normal shutdown occurs. For // more information, see Hibernate your instance // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the // Amazon Elastic Compute Cloud User Guide. Default: false Hibernate *bool - - // Checks whether you have the required permissions for the action, without - // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. - DryRun *bool } type StopInstancesOutput struct { diff --git a/service/ec2/api_op_TerminateClientVpnConnections.go b/service/ec2/api_op_TerminateClientVpnConnections.go index 243ca407a6e..4a50f82b903 100644 --- a/service/ec2/api_op_TerminateClientVpnConnections.go +++ b/service/ec2/api_op_TerminateClientVpnConnections.go @@ -59,14 +59,14 @@ func (c *Client) TerminateClientVpnConnections(ctx context.Context, params *Term type TerminateClientVpnConnectionsInput struct { - // The ID of the client connection to be terminated. - ConnectionId *string - // The ID of the Client VPN endpoint to which the client is connected. // // This member is required. ClientVpnEndpointId *string + // The ID of the client connection to be terminated. + ConnectionId *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -81,12 +81,12 @@ type TerminateClientVpnConnectionsInput struct { type TerminateClientVpnConnectionsOutput struct { - // The current state of the client connections. - ConnectionStatuses []*types.TerminateConnectionStatus - // The ID of the Client VPN endpoint. ClientVpnEndpointId *string + // The current state of the client connections. + ConnectionStatuses []*types.TerminateConnectionStatus + // The user who established the terminated client connections. Username *string diff --git a/service/ec2/api_op_UnassignIpv6Addresses.go b/service/ec2/api_op_UnassignIpv6Addresses.go index 9732d0e3bab..323812729f9 100644 --- a/service/ec2/api_op_UnassignIpv6Addresses.go +++ b/service/ec2/api_op_UnassignIpv6Addresses.go @@ -56,15 +56,15 @@ func (c *Client) UnassignIpv6Addresses(ctx context.Context, params *UnassignIpv6 type UnassignIpv6AddressesInput struct { - // The ID of the network interface. + // The IPv6 addresses to unassign from the network interface. // // This member is required. - NetworkInterfaceId *string + Ipv6Addresses []*string - // The IPv6 addresses to unassign from the network interface. + // The ID of the network interface. // // This member is required. - Ipv6Addresses []*string + NetworkInterfaceId *string } type UnassignIpv6AddressesOutput struct { diff --git a/service/ec2/api_op_UnmonitorInstances.go b/service/ec2/api_op_UnmonitorInstances.go index f3e44aea858..e890e069495 100644 --- a/service/ec2/api_op_UnmonitorInstances.go +++ b/service/ec2/api_op_UnmonitorInstances.go @@ -60,16 +60,16 @@ func (c *Client) UnmonitorInstances(ctx context.Context, params *UnmonitorInstan type UnmonitorInstancesInput struct { + // The IDs of the instances. + // + // This member is required. + InstanceIds []*string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The IDs of the instances. - // - // This member is required. - InstanceIds []*string } type UnmonitorInstancesOutput struct { diff --git a/service/ec2/api_op_UpdateSecurityGroupRuleDescriptionsEgress.go b/service/ec2/api_op_UpdateSecurityGroupRuleDescriptionsEgress.go index 5e104d973a7..f319dc907db 100644 --- a/service/ec2/api_op_UpdateSecurityGroupRuleDescriptionsEgress.go +++ b/service/ec2/api_op_UpdateSecurityGroupRuleDescriptionsEgress.go @@ -61,6 +61,11 @@ func (c *Client) UpdateSecurityGroupRuleDescriptionsEgress(ctx context.Context, type UpdateSecurityGroupRuleDescriptionsEgressInput struct { + // The IP permissions for the security group rule. + // + // This member is required. + IpPermissions []*types.IpPermission + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is @@ -72,11 +77,6 @@ type UpdateSecurityGroupRuleDescriptionsEgressInput struct { // you must specify the security group ID. GroupId *string - // The IP permissions for the security group rule. - // - // This member is required. - IpPermissions []*types.IpPermission - // [Default VPC] The name of the security group. You must specify either the // security group ID or the security group name in the request. GroupName *string diff --git a/service/ec2/api_op_UpdateSecurityGroupRuleDescriptionsIngress.go b/service/ec2/api_op_UpdateSecurityGroupRuleDescriptionsIngress.go index 8f2e45d5daa..94ebbe145b4 100644 --- a/service/ec2/api_op_UpdateSecurityGroupRuleDescriptionsIngress.go +++ b/service/ec2/api_op_UpdateSecurityGroupRuleDescriptionsIngress.go @@ -72,14 +72,14 @@ type UpdateSecurityGroupRuleDescriptionsIngressInput struct { // UnauthorizedOperation. DryRun *bool - // [EC2-Classic, default VPC] The name of the security group. You must specify - // either the security group ID or the security group name in the request. - GroupName *string - // The ID of the security group. You must specify either the security group ID or // the security group name in the request. For security groups in a nondefault VPC, // you must specify the security group ID. GroupId *string + + // [EC2-Classic, default VPC] The name of the security group. You must specify + // either the security group ID or the security group name in the request. + GroupName *string } type UpdateSecurityGroupRuleDescriptionsIngressOutput struct { diff --git a/service/ec2/api_op_WithdrawByoipCidr.go b/service/ec2/api_op_WithdrawByoipCidr.go index 3beafeea510..9e92b74c2ed 100644 --- a/service/ec2/api_op_WithdrawByoipCidr.go +++ b/service/ec2/api_op_WithdrawByoipCidr.go @@ -60,16 +60,16 @@ func (c *Client) WithdrawByoipCidr(ctx context.Context, params *WithdrawByoipCid type WithdrawByoipCidrInput struct { + // The address range, in CIDR notation. + // + // This member is required. + Cidr *string + // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the // required permissions, the error response is DryRunOperation. Otherwise, it is // UnauthorizedOperation. DryRun *bool - - // The address range, in CIDR notation. - // - // This member is required. - Cidr *string } type WithdrawByoipCidrOutput struct { diff --git a/service/ec2/go.mod b/service/ec2/go.mod index 3eb6abdb5f0..a19455dff7e 100644 --- a/service/ec2/go.mod +++ b/service/ec2/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/ec2 go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/ec2/types/types.go b/service/ec2/types/types.go index b793fb476da..5ad9a4fc46d 100644 --- a/service/ec2/types/types.go +++ b/service/ec2/types/types.go @@ -26,57 +26,54 @@ type AccountAttributeValue struct { // Describes a running instance in a Spot Fleet. type ActiveInstance struct { - // The ID of the Spot Instance request. - SpotInstanceRequestId *string - - // The ID of the instance. - InstanceId *string - // The health status of the instance. If the status of either the instance status // check or the system status check is impaired, the health status of the instance // is unhealthy. Otherwise, the health status is healthy. InstanceHealth InstanceHealthStatus + // The ID of the instance. + InstanceId *string + // The instance type. InstanceType *string + + // The ID of the Spot Instance request. + SpotInstanceRequestId *string } // An entry for a prefix list. type AddPrefixListEntry struct { - // A description for the entry. Constraints: Up to 255 characters in length. - Description *string - // The CIDR block. // // This member is required. Cidr *string + + // A description for the entry. Constraints: Up to 255 characters in length. + Description *string } // Describes an Elastic IP address. type Address struct { - // Indicates whether this Elastic IP address is for use with instances in - // EC2-Classic (standard) or instances in a VPC (vpc). - Domain DomainType + // The ID representing the allocation of the address for use with EC2-VPC. + AllocationId *string + + // The ID representing the association of the address with an instance in a VPC. + AssociationId *string // The customer-owned IP address. CustomerOwnedIp *string - // The private IP address associated with the Elastic IP address. - PrivateIpAddress *string - - // Any tags assigned to the Elastic IP address. - Tags []*Tag - - // The ID representing the allocation of the address for use with EC2-VPC. - AllocationId *string - // The ID of the customer-owned address pool. CustomerOwnedIpv4Pool *string - // The ID of an address pool. - PublicIpv4Pool *string + // Indicates whether this Elastic IP address is for use with instances in + // EC2-Classic (standard) or instances in a VPC (vpc). + Domain DomainType + + // The ID of the instance that the address is associated with (if any). + InstanceId *string // The name of the location from which the IP address is advertised. NetworkBorderGroup *string @@ -84,17 +81,20 @@ type Address struct { // The ID of the network interface. NetworkInterfaceId *string - // The ID of the instance that the address is associated with (if any). - InstanceId *string + // The ID of the AWS account that owns the network interface. + NetworkInterfaceOwnerId *string + + // The private IP address associated with the Elastic IP address. + PrivateIpAddress *string // The Elastic IP address. PublicIp *string - // The ID of the AWS account that owns the network interface. - NetworkInterfaceOwnerId *string + // The ID of an address pool. + PublicIpv4Pool *string - // The ID representing the association of the address with an instance in a VPC. - AssociationId *string + // Any tags assigned to the Elastic IP address. + Tags []*Tag } // Describes a principal. @@ -118,11 +118,11 @@ type AssignedPrivateIpAddress struct { // target network is a subnet in a VPC. type AssociatedTargetNetwork struct { - // The target network type. - NetworkType AssociatedNetworkType - // The ID of the subnet. NetworkId *string + + // The target network type. + NetworkType AssociatedNetworkType } // Describes the state of a target network association. @@ -152,9 +152,8 @@ type AttributeValue struct { // Information about an authorization rule. type AuthorizationRule struct { - // The ID of the Active Directory group to which the authorization rule grants - // access. - GroupId *string + // Indicates whether the authorization rule grants access to all clients. + AccessAll *bool // The ID of the Client VPN endpoint with which the authorization rule is // associated. @@ -163,57 +162,58 @@ type AuthorizationRule struct { // A brief description of the authorization rule. Description *string - // The current state of the authorization rule. - Status *ClientVpnAuthorizationRuleStatus - // The IPv4 address range, in CIDR notation, of the network to which the // authorization rule applies. DestinationCidr *string - // Indicates whether the authorization rule grants access to all clients. - AccessAll *bool + // The ID of the Active Directory group to which the authorization rule grants + // access. + GroupId *string + + // The current state of the authorization rule. + Status *ClientVpnAuthorizationRuleStatus } // Describes a Zone. type AvailabilityZone struct { - // The ID of the zone that handles some of the Local Zone control plane operations, - // such as API calls. - ParentZoneId *string - // For Availability Zones, this parameter has the same value as the Region name. // For Local Zones, the name of the associated group, for example us-west-2-lax-1. GroupName *string + // Any messages about the Zone. + Messages []*AvailabilityZoneMessage + + // The name of the location from which the address is advertised. + NetworkBorderGroup *string + + // For Availability Zones, this parameter always has the value of + // opt-in-not-required. For Local Zones, this parameter is the opt in status. The + // possible values are opted-in, and not-opted-in. + OptInStatus AvailabilityZoneOptInStatus + + // The ID of the zone that handles some of the Local Zone control plane operations, + // such as API calls. + ParentZoneId *string + // The name of the zone that handles some of the Local Zone control plane // operations, such as API calls. ParentZoneName *string - // The type of zone. The valid values are availability-zone and local-zone. - ZoneType *string - - // The ID of the Zone. - ZoneId *string + // The name of the Region. + RegionName *string // The state of the Zone. State AvailabilityZoneState - // The name of the Region. - RegionName *string - - // The name of the location from which the address is advertised. - NetworkBorderGroup *string + // The ID of the Zone. + ZoneId *string // The name of the Zone. ZoneName *string - // Any messages about the Zone. - Messages []*AvailabilityZoneMessage - - // For Availability Zones, this parameter always has the value of - // opt-in-not-required. For Local Zones, this parameter is the opt in status. The - // possible values are opted-in, and not-opted-in. - OptInStatus AvailabilityZoneOptInStatus + // The type of zone. The valid values are availability-zone and local-zone. + ZoneType *string } // Describes a message about a Zone. @@ -227,14 +227,14 @@ type AvailabilityZoneMessage struct { // Host. type AvailableCapacity struct { - // The number of vCPUs available for launching instances onto the Dedicated Host. - AvailableVCpus *int32 - // The number of instances that can be launched onto the Dedicated Host depending // on the host's available capacity. For Dedicated Hosts that support multiple // instance types, this parameter represents the number of instances for each // instance size that is supported on the host. AvailableInstanceCapacity []*InstanceCapacity + + // The number of vCPUs available for launching instances onto the Dedicated Host. + AvailableVCpus *int32 } type BlobAttributeValue struct { @@ -247,6 +247,13 @@ type BlockDeviceMapping struct { // The device name (for example, /dev/sdh or xvdh). DeviceName *string + // Parameters used to automatically set up EBS volumes when the instance is + // launched. + Ebs *EbsBlockDevice + + // Suppresses the specified device included in the block device mapping of the AMI. + NoDevice *string + // The virtual device name (ephemeralN). Instance store volumes are numbered // starting from 0. An instance type with 2 available instance store volumes can // specify mappings for ephemeral0 and ephemeral1. The number of available instance @@ -258,41 +265,34 @@ type BlockDeviceMapping struct { // M3 instance, we ignore any instance store volumes specified in the block device // mapping for the AMI. VirtualName *string - - // Parameters used to automatically set up EBS volumes when the instance is - // launched. - Ebs *EbsBlockDevice - - // Suppresses the specified device included in the block device mapping of the AMI. - NoDevice *string } // Describes a bundle task. type BundleTask struct { - // The ID of the instance associated with this bundle task. - InstanceId *string - // The ID of the bundle task. BundleId *string - // The time of the most recent update for the task. - UpdateTime *time.Time - - // The level of task completion, as a percent (for example, 20%). - Progress *string - // If the task fails, a description of the error. BundleTaskError *BundleTaskError - // The Amazon S3 storage locations. - Storage *Storage + // The ID of the instance associated with this bundle task. + InstanceId *string + + // The level of task completion, as a percent (for example, 20%). + Progress *string // The time this task started. StartTime *time.Time // The state of the task. State BundleTaskState + + // The Amazon S3 storage locations. + Storage *Storage + + // The time of the most recent update for the task. + UpdateTime *time.Time } // Describes an error for BundleInstance (). @@ -309,14 +309,14 @@ type BundleTaskError struct { // resources through bring your own IP addresses (BYOIP). type ByoipCidr struct { - // The state of the address pool. - State ByoipCidrState + // The address range, in CIDR notation. + Cidr *string // The description of the address range. Description *string - // The address range, in CIDR notation. - Cidr *string + // The state of the address pool. + State ByoipCidrState // Upon success, contains the ID of the address pool. Otherwise, contains an error // message. @@ -326,71 +326,74 @@ type ByoipCidr struct { // Describes a request to cancel a Spot Instance. type CancelledSpotInstanceRequest struct { - // The state of the Spot Instance request. - State CancelSpotInstanceRequestState - // The ID of the Spot Instance request. SpotInstanceRequestId *string + + // The state of the Spot Instance request. + State CancelSpotInstanceRequestState } // Describes a Spot Fleet error. type CancelSpotFleetRequestsError struct { - // The description for the error code. - Message *string - // The error code. Code CancelBatchErrorCode + + // The description for the error code. + Message *string } // Describes a Spot Fleet request that was not successfully canceled. type CancelSpotFleetRequestsErrorItem struct { - // The ID of the Spot Fleet request. - SpotFleetRequestId *string - // The error. Error *CancelSpotFleetRequestsError + + // The ID of the Spot Fleet request. + SpotFleetRequestId *string } // Describes a Spot Fleet request that was successfully canceled. type CancelSpotFleetRequestsSuccessItem struct { + // The current state of the Spot Fleet request. + CurrentSpotFleetRequestState BatchState + // The previous state of the Spot Fleet request. PreviousSpotFleetRequestState BatchState // The ID of the Spot Fleet request. SpotFleetRequestId *string - - // The current state of the Spot Fleet request. - CurrentSpotFleetRequestState BatchState } // Describes a Capacity Reservation. type CapacityReservation struct { - // The type of instance for which the Capacity Reservation reserves capacity. - InstanceType *string + // The Availability Zone in which the capacity is reserved. + AvailabilityZone *string + + // The Availability Zone ID of the Capacity Reservation. + AvailabilityZoneId *string // The remaining capacity. Indicates the number of instances that can be launched // in the Capacity Reservation. AvailableInstanceCount *int32 - // Any tags assigned to the Capacity Reservation. - Tags []*Tag + // The Amazon Resource Name (ARN) of the Capacity Reservation. + CapacityReservationArn *string // The ID of the Capacity Reservation. CapacityReservationId *string - // The total number of instances for which the Capacity Reservation reserves - // capacity. - TotalInstanceCount *int32 - - // The ID of the AWS account that owns the Capacity Reservation. - OwnerId *string + // The date and time at which the Capacity Reservation was created. + CreateDate *time.Time - // The Availability Zone in which the capacity is reserved. - AvailabilityZone *string + // Indicates whether the Capacity Reservation supports EBS-optimized instances. + // This optimization provides dedicated throughput to Amazon EBS and an optimized + // configuration stack to provide optimal I/O performance. This optimization isn't + // available with all instance types. Additional usage charges apply when using an + // EBS- optimized instance. + EbsOptimized *bool // The date and time at which the Capacity Reservation expires. When a Capacity // Reservation expires, the reserved capacity is released and you can no longer @@ -398,40 +401,44 @@ type CapacityReservation struct { // when it reaches its end date and time. EndDate *time.Time - // The Amazon Resource Name (ARN) of the Capacity Reservation. - CapacityReservationArn *string - - // Indicates whether the Capacity Reservation supports EBS-optimized instances. - // This optimization provides dedicated throughput to Amazon EBS and an optimized - // configuration stack to provide optimal I/O performance. This optimization isn't - // available with all instance types. Additional usage charges apply when using an - // EBS- optimized instance. - EbsOptimized *bool + // Indicates the way in which the Capacity Reservation ends. A Capacity Reservation + // can have one of the following end types: + // + // * unlimited - The Capacity + // Reservation remains active until you explicitly cancel it. + // + // * limited - The + // Capacity Reservation expires automatically at a specified date and time. + EndDateType EndDateType // Indicates whether the Capacity Reservation supports instances with temporary, // block-level storage. EphemeralStorage *bool + // Indicates the type of instance launches that the Capacity Reservation accepts. + // The options include: + // + // * open - The Capacity Reservation accepts all + // instances that have matching attributes (instance type, platform, and + // Availability Zone). Instances that have matching attributes launch into the + // Capacity Reservation automatically without specifying any additional + // parameters. + // + // * targeted - The Capacity Reservation only accepts instances + // that have matching attributes (instance type, platform, and Availability Zone), + // and explicitly target the Capacity Reservation. This ensures that only permitted + // instances can use the reserved capacity. + InstanceMatchCriteria InstanceMatchCriteria + // The type of operating system for which the Capacity Reservation reserves // capacity. InstancePlatform CapacityReservationInstancePlatform - // The Availability Zone ID of the Capacity Reservation. - AvailabilityZoneId *string - - // Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can - // have one of the following tenancy settings: - // - // * default - The Capacity - // Reservation is created on hardware that is shared with other AWS accounts. - // - // - // * dedicated - The Capacity Reservation is created on single-tenant hardware that - // is dedicated to a single AWS account. - Tenancy CapacityReservationTenancy + // The type of instance for which the Capacity Reservation reserves capacity. + InstanceType *string - // The date and time at which the Capacity Reservation was created. - CreateDate *time.Time + // The ID of the AWS account that owns the Capacity Reservation. + OwnerId *string // The current state of the Capacity Reservation. A Capacity Reservation can be in // one of the following states: @@ -456,30 +463,23 @@ type CapacityReservation struct { // limit constraints. Failed requests are retained for 60 minutes. State CapacityReservationState - // Indicates the way in which the Capacity Reservation ends. A Capacity Reservation - // can have one of the following end types: - // - // * unlimited - The Capacity - // Reservation remains active until you explicitly cancel it. - // - // * limited - The - // Capacity Reservation expires automatically at a specified date and time. - EndDateType EndDateType + // Any tags assigned to the Capacity Reservation. + Tags []*Tag - // Indicates the type of instance launches that the Capacity Reservation accepts. - // The options include: + // Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can + // have one of the following tenancy settings: // - // * open - The Capacity Reservation accepts all - // instances that have matching attributes (instance type, platform, and - // Availability Zone). Instances that have matching attributes launch into the - // Capacity Reservation automatically without specifying any additional - // parameters. + // * default - The Capacity + // Reservation is created on hardware that is shared with other AWS accounts. // - // * targeted - The Capacity Reservation only accepts instances - // that have matching attributes (instance type, platform, and Availability Zone), - // and explicitly target the Capacity Reservation. This ensures that only permitted - // instances can use the reserved capacity. - InstanceMatchCriteria InstanceMatchCriteria + // + // * dedicated - The Capacity Reservation is created on single-tenant hardware that + // is dedicated to a single AWS account. + Tenancy CapacityReservationTenancy + + // The total number of instances for which the Capacity Reservation reserves + // capacity. + TotalInstanceCount *int32 } // Describes a resource group to which a Capacity Reservation has been added. @@ -550,9 +550,6 @@ type CapacityReservationOptionsRequest struct { // Reservation or a Capacity Reservation group. type CapacityReservationSpecification struct { - // Information about the target Capacity Reservation or Capacity Reservation group. - CapacityReservationTarget *CapacityReservationTarget - // Indicates the instance's Capacity Reservation preferences. Possible preferences // include: // @@ -563,6 +560,9 @@ type CapacityReservationSpecification struct { // * none - The instance avoids running in a Capacity Reservation even if one is // available. The instance runs as an On-Demand Instance. CapacityReservationPreference CapacityReservationPreference + + // Information about the target Capacity Reservation or Capacity Reservation group. + CapacityReservationTarget *CapacityReservationTarget } // Describes the instance's Capacity Reservation targeting preferences. The action @@ -574,10 +574,6 @@ type CapacityReservationSpecification struct { // Capacity Reservation group. type CapacityReservationSpecificationResponse struct { - // Information about the targeted Capacity Reservation or Capacity Reservation - // group. - CapacityReservationTarget *CapacityReservationTargetResponse - // Describes the instance's Capacity Reservation preferences. Possible preferences // include: // @@ -588,6 +584,10 @@ type CapacityReservationSpecificationResponse struct { // * none - The instance avoids running in a Capacity Reservation even if one is // available. The instance runs in On-Demand capacity. CapacityReservationPreference CapacityReservationPreference + + // Information about the targeted Capacity Reservation or Capacity Reservation + // group. + CapacityReservationTarget *CapacityReservationTargetResponse } // Describes a target Capacity Reservation or Capacity Reservation group. @@ -633,15 +633,15 @@ type CertificateAuthenticationRequest struct { // in the Amazon Elastic Compute Cloud User Guide. type CidrAuthorizationContext struct { - // The signed authorization message for the prefix and account. + // The plain-text authorization message for the prefix and account. // // This member is required. - Signature *string + Message *string - // The plain-text authorization message for the prefix and account. + // The signed authorization message for the prefix and account. // // This member is required. - Message *string + Signature *string } // Describes an IPv4 CIDR block. @@ -664,17 +664,17 @@ type ClassicLinkDnsSupport struct { // Describes a linked EC2-Classic instance. type ClassicLinkInstance struct { - // The ID of the instance. - InstanceId *string - - // The ID of the VPC. - VpcId *string - // A list of security groups. Groups []*GroupIdentifier + // The ID of the instance. + InstanceId *string + // Any tags assigned to the instance. Tags []*Tag + + // The ID of the VPC. + VpcId *string } // Describes a Classic Load Balancer. @@ -709,14 +709,14 @@ type ClientData struct { // A user-defined comment about the disk upload. Comment *string - // The time that the disk upload starts. - UploadStart *time.Time - // The time that the disk upload ends. UploadEnd *time.Time // The size of the uploaded disk image, in GiB. UploadSize *float64 + + // The time that the disk upload starts. + UploadStart *time.Time } // Describes the authentication methods used by a Client VPN endpoint. For more @@ -731,11 +731,11 @@ type ClientVpnAuthentication struct { // Information about the IAM SAML identity provider, if applicable. FederatedAuthentication *FederatedAuthentication - // The authentication type used. - Type ClientVpnAuthenticationType - // Information about the authentication certificates, if applicable. MutualAuthentication *CertificateAuthentication + + // The authentication type used. + Type ClientVpnAuthenticationType } // Describes the authentication method to be used by a Client VPN endpoint. For @@ -773,89 +773,99 @@ type ClientVpnAuthorizationRuleStatus struct { // Describes a client connection. type ClientVpnConnection struct { - // The number of packets received by the client. - EgressPackets *string + // The IP address of the client. + ClientIp *string - // The ID of the client connection. - ConnectionId *string + // The ID of the Client VPN endpoint to which the client is connected. + ClientVpnEndpointId *string - // The number of bytes received by the client. - EgressBytes *string + // The common name associated with the client. This is either the name of the + // client certificate, or the Active Directory user name. + CommonName *string + + // The date and time the client connection was terminated. + ConnectionEndTime *string // The date and time the client connection was established. ConnectionEstablishedTime *string - // The username of the client who established the client connection. This - // information is only provided if Active Directory client authentication is used. - Username *string + // The ID of the client connection. + ConnectionId *string - // The current date and time. - Timestamp *string + // The number of bytes received by the client. + EgressBytes *string - // The IP address of the client. - ClientIp *string + // The number of packets received by the client. + EgressPackets *string // The number of bytes sent by the client. IngressBytes *string - // The current state of the client connection. - Status *ClientVpnConnectionStatus - // The number of packets sent by the client. IngressPackets *string - // The common name associated with the client. This is either the name of the - // client certificate, or the Active Directory user name. - CommonName *string + // The current state of the client connection. + Status *ClientVpnConnectionStatus - // The ID of the Client VPN endpoint to which the client is connected. - ClientVpnEndpointId *string + // The current date and time. + Timestamp *string - // The date and time the client connection was terminated. - ConnectionEndTime *string + // The username of the client who established the client connection. This + // information is only provided if Active Directory client authentication is used. + Username *string } // Describes the status of a client connection. type ClientVpnConnectionStatus struct { - // A message about the status of the client connection, if applicable. - Message *string - // The state of the client connection. Code ClientVpnConnectionStatusCode + + // A message about the status of the client connection, if applicable. + Message *string } // Describes a Client VPN endpoint. type ClientVpnEndpoint struct { - // The ARN of the server certificate. - ServerCertificateArn *string + // Information about the associated target networks. A target network is a subnet + // in a VPC. + AssociatedTargetNetworks []*AssociatedTargetNetwork + + // Information about the authentication method used by the Client VPN endpoint. + AuthenticationOptions []*ClientVpnAuthentication + + // The IPv4 address range, in CIDR notation, from which client IP addresses are + // assigned. + ClientCidrBlock *string // The ID of the Client VPN endpoint. ClientVpnEndpointId *string - // The current state of the Client VPN endpoint. - Status *ClientVpnEndpointStatus + // Information about the client connection logging options for the Client VPN + // endpoint. + ConnectionLogOptions *ConnectionLogResponseOptions - // Any tags assigned to the Client VPN endpoint. - Tags []*Tag + // The date and time the Client VPN endpoint was created. + CreationTime *string - // The IPv4 address range, in CIDR notation, from which client IP addresses are - // assigned. - ClientCidrBlock *string + // The date and time the Client VPN endpoint was deleted, if applicable. + DeletionTime *string - // The IDs of the security groups for the target network. - SecurityGroupIds []*string + // A brief description of the endpoint. + Description *string - // The protocol used by the VPN session. - VpnProtocol VpnProtocol + // The DNS name to be used by clients when connecting to the Client VPN endpoint. + DnsName *string - // Information about the associated target networks. A target network is a subnet - // in a VPC. - AssociatedTargetNetworks []*AssociatedTargetNetwork + // Information about the DNS servers to be used for DNS resolution. + DnsServers []*string - // Information about the authentication method used by the Client VPN endpoint. - AuthenticationOptions []*ClientVpnAuthentication + // The IDs of the security groups for the target network. + SecurityGroupIds []*string + + // The ARN of the server certificate. + ServerCertificateArn *string // Indicates whether split-tunnel is enabled in the AWS Client VPN endpoint. For // information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN @@ -864,33 +874,23 @@ type ClientVpnEndpoint struct { // in the AWS Client VPN Administrator Guide. SplitTunnel *bool - // The port number for the Client VPN endpoint. - VpnPort *int32 - - // Information about the DNS servers to be used for DNS resolution. - DnsServers []*string - - // The date and time the Client VPN endpoint was deleted, if applicable. - DeletionTime *string - - // The DNS name to be used by clients when connecting to the Client VPN endpoint. - DnsName *string - - // A brief description of the endpoint. - Description *string + // The current state of the Client VPN endpoint. + Status *ClientVpnEndpointStatus - // Information about the client connection logging options for the Client VPN - // endpoint. - ConnectionLogOptions *ConnectionLogResponseOptions + // Any tags assigned to the Client VPN endpoint. + Tags []*Tag // The transport protocol used by the Client VPN endpoint. TransportProtocol TransportProtocol - // The date and time the Client VPN endpoint was created. - CreationTime *string - // The ID of the VPC. VpcId *string + + // The port number for the Client VPN endpoint. + VpnPort *int32 + + // The protocol used by the VPN session. + VpnProtocol VpnProtocol } // Describes the state of a Client VPN endpoint. @@ -921,8 +921,14 @@ type ClientVpnEndpointStatus struct { // Information about a Client VPN endpoint route. type ClientVpnRoute struct { - // The ID of the subnet through which traffic is routed. - TargetSubnet *string + // The ID of the Client VPN endpoint with which the route is associated. + ClientVpnEndpointId *string + + // A brief description of the route. + Description *string + + // The IPv4 address range, in CIDR notation, of the route destination. + DestinationCidr *string // Indicates how the route was associated with the Client VPN endpoint. associate // indicates that the route was automatically added when the target network was @@ -930,78 +936,72 @@ type ClientVpnRoute struct { // manually added using the CreateClientVpnRoute action. Origin *string - // The IPv4 address range, in CIDR notation, of the route destination. - DestinationCidr *string - - // The route type. - Type *string - // The current state of the route. Status *ClientVpnRouteStatus - // The ID of the Client VPN endpoint with which the route is associated. - ClientVpnEndpointId *string + // The ID of the subnet through which traffic is routed. + TargetSubnet *string - // A brief description of the route. - Description *string + // The route type. + Type *string } // Describes the state of a Client VPN endpoint route. type ClientVpnRouteStatus struct { - // A message about the status of the Client VPN endpoint route, if applicable. - Message *string - // The state of the Client VPN endpoint route. Code ClientVpnRouteStatusCode -} + + // A message about the status of the Client VPN endpoint route, if applicable. + Message *string +} // Describes address usage for a customer-owned address pool. type CoipAddressUsage struct { - // The AWS service. - AwsService *string - // The allocation ID of the address. AllocationId *string - // The customer-owned IP address. - CoIp *string - // The AWS account ID. AwsAccountId *string + + // The AWS service. + AwsService *string + + // The customer-owned IP address. + CoIp *string } // Describes a customer-owned address pool. type CoipPool struct { - // The ID of the address pool. - PoolId *string + // The ID of the local gateway route table. + LocalGatewayRouteTableId *string // The ARN of the address pool. PoolArn *string - // The tags. - Tags []*Tag - // The address ranges of the address pool. PoolCidrs []*string - // The ID of the local gateway route table. - LocalGatewayRouteTableId *string + // The ID of the address pool. + PoolId *string + + // The tags. + Tags []*Tag } // Describes the client connection logging options for the Client VPN endpoint. type ConnectionLogOptions struct { - // The name of the CloudWatch Logs log stream to which the connection data is - // published. - CloudwatchLogStream *string - // The name of the CloudWatch Logs log group. Required if connection logging is // enabled. CloudwatchLogGroup *string + // The name of the CloudWatch Logs log stream to which the connection data is + // published. + CloudwatchLogStream *string + // Indicates whether connection logging is enabled. Enabled *bool } @@ -1014,132 +1014,132 @@ type ConnectionLogResponseOptions struct { // data is published. CloudwatchLogGroup *string - // Indicates whether client connection logging is enabled for the Client VPN - // endpoint. - Enabled *bool - // The name of the Amazon CloudWatch Logs log stream to which connection logging // data is published. CloudwatchLogStream *string + + // Indicates whether client connection logging is enabled for the Client VPN + // endpoint. + Enabled *bool } // Describes a connection notification for a VPC endpoint or VPC endpoint service. type ConnectionNotification struct { + // The events for the notification. Valid values are Accept, Connect, Delete, and + // Reject. + ConnectionEvents []*string + + // The ARN of the SNS topic for the notification. + ConnectionNotificationArn *string + + // The ID of the notification. + ConnectionNotificationId *string + // The state of the notification. ConnectionNotificationState ConnectionNotificationState - // The ID of the endpoint service. - ServiceId *string - // The type of notification. ConnectionNotificationType ConnectionNotificationType + // The ID of the endpoint service. + ServiceId *string + // The ID of the VPC endpoint. VpcEndpointId *string - - // The ID of the notification. - ConnectionNotificationId *string - - // The ARN of the SNS topic for the notification. - ConnectionNotificationArn *string - - // The events for the notification. Valid values are Accept, Connect, Delete, and - // Reject. - ConnectionEvents []*string } // Describes a conversion task. type ConversionTask struct { - // If the task is for importing a volume, this contains information about the - // import volume task. - ImportVolume *ImportVolumeTaskDetails - - // If the task is for importing an instance, this contains information about the - // import instance task. - ImportInstance *ImportInstanceTaskDetails - // The ID of the conversion task. ConversionTaskId *string - // Any tags assigned to the task. - Tags []*Tag - // The time when the task expires. If the upload isn't complete before the // expiration time, we automatically cancel the task. ExpirationTime *string + // If the task is for importing an instance, this contains information about the + // import instance task. + ImportInstance *ImportInstanceTaskDetails + + // If the task is for importing a volume, this contains information about the + // import volume task. + ImportVolume *ImportVolumeTaskDetails + // The state of the conversion task. State ConversionTaskState // The status message related to the conversion task. StatusMessage *string + + // Any tags assigned to the task. + Tags []*Tag } // The CPU options for the instance. type CpuOptions struct { - // The number of threads per CPU core. - ThreadsPerCore *int32 - // The number of CPU cores for the instance. CoreCount *int32 + + // The number of threads per CPU core. + ThreadsPerCore *int32 } // The CPU options for the instance. Both the core count and threads per core must // be specified in the request. type CpuOptionsRequest struct { + // The number of CPU cores for the instance. + CoreCount *int32 + // The number of threads per CPU core. To disable multithreading for the instance, // specify a value of 1. Otherwise, specify the default value of 2. ThreadsPerCore *int32 - - // The number of CPU cores for the instance. - CoreCount *int32 } // Describes the instances that could not be launched by the fleet. type CreateFleetError struct { - // The error message that describes why the instance could not be launched. For - // more information about error messages, see Error Codes - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html). - ErrorMessage *string - - // Indicates if the instance that could not be launched was a Spot Instance or - // On-Demand Instance. - Lifecycle InstanceLifecycle - // The error code that indicates why the instance could not be launched. For more // information about error codes, see Error Codes // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html). ErrorCode *string + // The error message that describes why the instance could not be launched. For + // more information about error messages, see Error Codes + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html). + ErrorMessage *string + // The launch templates and overrides that were used for launching the instances. // The values that you specify in the Overrides replace the values in the launch // template. LaunchTemplateAndOverrides *LaunchTemplateAndOverridesResponse + + // Indicates if the instance that could not be launched was a Spot Instance or + // On-Demand Instance. + Lifecycle InstanceLifecycle } // Describes the instances that were launched by the fleet. type CreateFleetInstance struct { - // Indicates if the instance that was launched is a Spot Instance or On-Demand - // Instance. - Lifecycle InstanceLifecycle + // The IDs of the instances. + InstanceIds []*string // The instance type. InstanceType InstanceType - // The IDs of the instances. - InstanceIds []*string - // The launch templates and overrides that were used for launching the instances. // The values that you specify in the Overrides replace the values in the launch // template. LaunchTemplateAndOverrides *LaunchTemplateAndOverridesResponse + // Indicates if the instance that was launched is a Spot Instance or On-Demand + // Instance. + Lifecycle InstanceLifecycle + // The value is Windows for Windows instances. Otherwise, the value is blank. Platform PlatformValues } @@ -1147,32 +1147,32 @@ type CreateFleetInstance struct { // Describes the options for a VPC attachment. type CreateTransitGatewayVpcAttachmentRequestOptions struct { - // Enable or disable IPv6 support. The default is enable. - Ipv6Support Ipv6SupportValue - // Enable or disable DNS support. The default is enable. DnsSupport DnsSupportValue + + // Enable or disable IPv6 support. The default is enable. + Ipv6Support Ipv6SupportValue } // Describes the user or group to be added or removed from the list of create // volume permissions for a volume. type CreateVolumePermission struct { - // The AWS account ID to be added or removed. - UserId *string - // The group to be added or removed. The possible value is all. Group PermissionGroup + + // The AWS account ID to be added or removed. + UserId *string } // Describes modifications to the list of create volume permissions for a volume. type CreateVolumePermissionModifications struct { - // Removes the specified AWS account ID or group from the list. - Remove []*CreateVolumePermission - // Adds the specified AWS account ID or group to the list. Add []*CreateVolumePermission + + // Removes the specified AWS account ID or group from the list. + Remove []*CreateVolumePermission } // Describes the credit option for CPU usage of a T2, T3, or T3a instance. @@ -1196,31 +1196,31 @@ type CreditSpecificationRequest struct { // Describes a customer gateway. type CustomerGateway struct { - // The Internet-routable IP address of the customer gateway's outside interface. - IpAddress *string + // The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number + // (ASN). + BgpAsn *string - // The current state of the customer gateway (pending | available | deleting | - // deleted). - State *string + // The Amazon Resource Name (ARN) for the customer gateway certificate. + CertificateArn *string // The ID of the customer gateway. CustomerGatewayId *string - // The Amazon Resource Name (ARN) for the customer gateway certificate. - CertificateArn *string + // The name of customer gateway device. + DeviceName *string - // The type of VPN connection the customer gateway supports (ipsec.1). - Type *string + // The Internet-routable IP address of the customer gateway's outside interface. + IpAddress *string + + // The current state of the customer gateway (pending | available | deleting | + // deleted). + State *string // Any tags assigned to the customer gateway. Tags []*Tag - // The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number - // (ASN). - BgpAsn *string - - // The name of customer gateway device. - DeviceName *string + // The type of VPN connection the customer gateway supports (ipsec.1). + Type *string } // Describes an EC2 Fleet error. @@ -1236,22 +1236,22 @@ type DeleteFleetError struct { // Describes an EC2 Fleet that was not successfully deleted. type DeleteFleetErrorItem struct { - // The ID of the EC2 Fleet. - FleetId *string - // The error. Error *DeleteFleetError + + // The ID of the EC2 Fleet. + FleetId *string } // Describes an EC2 Fleet that was successfully deleted. type DeleteFleetSuccessItem struct { - // The ID of the EC2 Fleet. - FleetId *string - // The current state of the EC2 Fleet. CurrentFleetState FleetStateCode + // The ID of the EC2 Fleet. + FleetId *string + // The previous state of the EC2 Fleet. PreviousFleetState FleetStateCode } @@ -1259,41 +1259,41 @@ type DeleteFleetSuccessItem struct { // Describes a launch template version that could not be deleted. type DeleteLaunchTemplateVersionsResponseErrorItem struct { + // The ID of the launch template. + LaunchTemplateId *string + // The name of the launch template. LaunchTemplateName *string - // The version number of the launch template. - VersionNumber *int64 - // Information about the error. ResponseError *ResponseError - // The ID of the launch template. - LaunchTemplateId *string + // The version number of the launch template. + VersionNumber *int64 } // Describes a launch template version that was successfully deleted. type DeleteLaunchTemplateVersionsResponseSuccessItem struct { + // The ID of the launch template. + LaunchTemplateId *string + // The name of the launch template. LaunchTemplateName *string // The version number of the launch template. VersionNumber *int64 - - // The ID of the launch template. - LaunchTemplateId *string } // Describes the error for a Reserved Instance whose queued purchase could not be // deleted. type DeleteQueuedReservedInstancesError struct { - // The error message. - Message *string - // The error code. Code DeleteQueuedReservedInstancesErrorCode + + // The error message. + Message *string } // Information about the tag keys to deregister for the current Region. You can @@ -1302,48 +1302,48 @@ type DeleteQueuedReservedInstancesError struct { // the request type DeregisterInstanceTagAttributeRequest struct { - // Information about the tag keys to deregister. - InstanceTagKeys []*string - // Indicates whether to deregister all tag keys in the current Region. Specify // false to deregister all tag keys. IncludeAllTagsOfInstance *bool + + // Information about the tag keys to deregister. + InstanceTagKeys []*string } // Describes fast snapshot restores for a snapshot. type DescribeFastSnapshotRestoreSuccessItem struct { - // The ID of the snapshot. - SnapshotId *string + // The Availability Zone. + AvailabilityZone *string - // The time at which fast snapshot restores entered the enabled state. - EnabledTime *time.Time + // The time at which fast snapshot restores entered the disabled state. + DisabledTime *time.Time // The time at which fast snapshot restores entered the disabling state. DisablingTime *time.Time + // The time at which fast snapshot restores entered the enabled state. + EnabledTime *time.Time + + // The time at which fast snapshot restores entered the enabling state. + EnablingTime *time.Time + // The time at which fast snapshot restores entered the optimizing state. OptimizingTime *time.Time - // The time at which fast snapshot restores entered the disabled state. - DisabledTime *time.Time + // The AWS owner alias that enabled fast snapshot restores on the snapshot. This is + // intended for future use. + OwnerAlias *string // The ID of the AWS account that enabled fast snapshot restores on the snapshot. OwnerId *string - // The time at which fast snapshot restores entered the enabling state. - EnablingTime *time.Time - - // The Availability Zone. - AvailabilityZone *string + // The ID of the snapshot. + SnapshotId *string // The state of fast snapshot restores. State FastSnapshotRestoreStateCode - // The AWS owner alias that enabled fast snapshot restores on the snapshot. This is - // intended for future use. - OwnerAlias *string - // The reason for the state transition. The possible values are as follows: // // * @@ -1368,14 +1368,14 @@ type DescribeFleetError struct { // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html). ErrorMessage *string - // Indicates if the instance that could not be launched was a Spot Instance or - // On-Demand Instance. - Lifecycle InstanceLifecycle - // The launch templates and overrides that were used for launching the instances. // The values that you specify in the Overrides replace the values in the launch // template. LaunchTemplateAndOverrides *LaunchTemplateAndOverridesResponse + + // Indicates if the instance that could not be launched was a Spot Instance or + // On-Demand Instance. + Lifecycle InstanceLifecycle } // Describes the instances that were launched by the fleet. @@ -1384,13 +1384,6 @@ type DescribeFleetsInstances struct { // The IDs of the instances. InstanceIds []*string - // Indicates if the instance that was launched is a Spot Instance or On-Demand - // Instance. - Lifecycle InstanceLifecycle - - // The value is Windows for Windows instances. Otherwise, the value is blank. - Platform PlatformValues - // The instance type. InstanceType InstanceType @@ -1398,6 +1391,13 @@ type DescribeFleetsInstances struct { // The values that you specify in the Overrides replace the values in the launch // template. LaunchTemplateAndOverrides *LaunchTemplateAndOverridesResponse + + // Indicates if the instance that was launched is a Spot Instance or On-Demand + // Instance. + Lifecycle InstanceLifecycle + + // The value is Windows for Windows instances. Otherwise, the value is blank. + Platform PlatformValues } // Describes a DHCP configuration option. @@ -1416,14 +1416,14 @@ type DhcpOptions struct { // One or more DHCP options in the set. DhcpConfigurations []*DhcpConfiguration - // Any tags assigned to the DHCP options set. - Tags []*Tag - // The ID of the set of DHCP options. DhcpOptionsId *string // The ID of the AWS account that owns the DHCP options set. OwnerId *string + + // Any tags assigned to the DHCP options set. + Tags []*Tag } // Describes an Active Directory. @@ -1444,11 +1444,11 @@ type DirectoryServiceAuthenticationRequest struct { // restores. type DisableFastSnapshotRestoreErrorItem struct { - // The ID of the snapshot. - SnapshotId *string - // The errors. FastSnapshotRestoreStateErrors []*DisableFastSnapshotRestoreStateErrorItem + + // The ID of the snapshot. + SnapshotId *string } // Describes an error that occurred when disabling fast snapshot restores. @@ -1475,36 +1475,36 @@ type DisableFastSnapshotRestoreStateErrorItem struct { // Describes fast snapshot restores that were successfully disabled. type DisableFastSnapshotRestoreSuccessItem struct { - // The state of fast snapshot restores for the snapshot. - State FastSnapshotRestoreStateCode - - // The time at which fast snapshot restores entered the enabling state. - EnablingTime *time.Time + // The Availability Zone. + AvailabilityZone *string // The time at which fast snapshot restores entered the disabled state. DisabledTime *time.Time - // The Availability Zone. - AvailabilityZone *string + // The time at which fast snapshot restores entered the disabling state. + DisablingTime *time.Time - // The ID of the AWS account that enabled fast snapshot restores on the snapshot. - OwnerId *string + // The time at which fast snapshot restores entered the enabled state. + EnabledTime *time.Time + + // The time at which fast snapshot restores entered the enabling state. + EnablingTime *time.Time // The time at which fast snapshot restores entered the optimizing state. OptimizingTime *time.Time - // The time at which fast snapshot restores entered the enabled state. - EnabledTime *time.Time - // The AWS owner alias that enabled fast snapshot restores on the snapshot. This is // intended for future use. OwnerAlias *string + // The ID of the AWS account that enabled fast snapshot restores on the snapshot. + OwnerId *string + // The ID of the snapshot. SnapshotId *string - // The time at which fast snapshot restores entered the disabling state. - DisablingTime *time.Time + // The state of fast snapshot restores for the snapshot. + State FastSnapshotRestoreStateCode // The reason for the state transition. The possible values are as follows: // @@ -1523,11 +1523,11 @@ type DiskImage struct { // A description of the disk image. Description *string - // Information about the volume. - Volume *VolumeDetail - // Information about the disk image. Image *DiskImageDetail + + // Information about the volume. + Volume *VolumeDetail } // Describes a disk image. @@ -1539,9 +1539,6 @@ type DiskImageDescription struct { // The disk image format. Format DiskImageFormat - // The size of the disk image, in GiB. - Size *int64 - // A presigned URL for the import manifest stored in Amazon S3. For information // about creating a presigned URL for an Amazon S3 object, read the "Query String // Request Authentication Alternative" section of the Authenticating REST Requests @@ -1550,6 +1547,9 @@ type DiskImageDescription struct { // import manifest referenced by this API action, see VM Import Manifest // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html). ImportManifestUrl *string + + // The size of the disk image, in GiB. + Size *int64 } // Describes a disk image. @@ -1560,6 +1560,11 @@ type DiskImageDetail struct { // This member is required. Bytes *int64 + // The disk image format. + // + // This member is required. + Format DiskImageFormat + // A presigned URL for the import manifest stored in Amazon S3 and presented here // as an Amazon S3 presigned URL. For information about creating a presigned URL // for an Amazon S3 object, read the "Query String Request Authentication @@ -1571,11 +1576,6 @@ type DiskImageDetail struct { // // This member is required. ImportManifestUrl *string - - // The disk image format. - // - // This member is required. - Format DiskImageFormat } // Describes a disk image volume. @@ -1591,12 +1591,12 @@ type DiskImageVolumeDescription struct { // Describes the disk. type DiskInfo struct { - // The size of the disk in GB. - SizeInGB *int64 - // The number of disks with this configuration. Count *int32 + // The size of the disk in GB. + SizeInGB *int64 + // The type of disk. Type DiskType } @@ -1604,11 +1604,11 @@ type DiskInfo struct { // Describes a DNS entry. type DnsEntry struct { - // The ID of the private hosted zone. - HostedZoneId *string - // The DNS name. DnsName *string + + // The ID of the private hosted zone. + HostedZoneId *string } // Information about the DNS server to be used. @@ -1627,21 +1627,25 @@ type DnsServersOptionsModifyStructure struct { // Describes a block device for an EBS volume. type EbsBlockDevice struct { - // The volume type. If you set the type to io1, you must also specify the Iops - // parameter. If you set the type to gp2, st1, sc1, or standard, you must omit the - // Iops parameter. Default: gp2 - VolumeType VolumeType - - // The ID of the snapshot. - SnapshotId *string + // Indicates whether the EBS volume is deleted on instance termination. For more + // information, see Preserving Amazon EBS volumes on instance termination + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination) + // in the Amazon Elastic Compute Cloud User Guide. + DeleteOnTermination *bool - // The size of the volume, in GiB. Default: If you're creating the volume from a - // snapshot and don't specify a volume size, the default is the snapshot size. - // Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS - // SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD - // (sc1), and 1-1024 for Magnetic (standard) volumes. If you specify a snapshot, - // the volume size must be equal to or larger than the snapshot size. - VolumeSize *int32 + // Indicates whether the encryption state of an EBS volume is changed while being + // restored from a backing snapshot. The effect of setting the encryption state to + // true depends on the volume origin (new or from a snapshot), starting encryption + // state, ownership, and whether encryption by default is enabled. For more + // information, see Amazon EBS Encryption + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-parameters) + // in the Amazon Elastic Compute Cloud User Guide. In no case can you remove + // encryption from an encrypted volume. Encrypted volumes can only be attached to + // instances that support Amazon EBS encryption. For more information, see + // Supported instance types + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances). + // This parameter is not returned by . + Encrypted *bool // The number of I/O operations per second (IOPS) that the volume supports. For io1 // volumes, this represents the number of IOPS that are provisioned for the volume. @@ -1661,12 +1665,6 @@ type EbsBlockDevice struct { // st1, sc1, or standard volumes. Iops *int32 - // Indicates whether the EBS volume is deleted on instance termination. For more - // information, see Preserving Amazon EBS volumes on instance termination - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination) - // in the Amazon Elastic Compute Cloud User Guide. - DeleteOnTermination *bool - // Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK // under which the EBS volume is encrypted. This parameter is only supported on // BlockDeviceMapping objects called by RunInstances @@ -1677,120 +1675,122 @@ type EbsBlockDevice struct { // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html). KmsKeyId *string - // Indicates whether the encryption state of an EBS volume is changed while being - // restored from a backing snapshot. The effect of setting the encryption state to - // true depends on the volume origin (new or from a snapshot), starting encryption - // state, ownership, and whether encryption by default is enabled. For more - // information, see Amazon EBS Encryption - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-parameters) - // in the Amazon Elastic Compute Cloud User Guide. In no case can you remove - // encryption from an encrypted volume. Encrypted volumes can only be attached to - // instances that support Amazon EBS encryption. For more information, see - // Supported instance types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances). - // This parameter is not returned by . - Encrypted *bool + // The ID of the snapshot. + SnapshotId *string + + // The size of the volume, in GiB. Default: If you're creating the volume from a + // snapshot and don't specify a volume size, the default is the snapshot size. + // Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS + // SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD + // (sc1), and 1-1024 for Magnetic (standard) volumes. If you specify a snapshot, + // the volume size must be equal to or larger than the snapshot size. + VolumeSize *int32 + + // The volume type. If you set the type to io1, you must also specify the Iops + // parameter. If you set the type to gp2, st1, sc1, or standard, you must omit the + // Iops parameter. Default: gp2 + VolumeType VolumeType } // Describes the Amazon EBS features supported by the instance type. type EbsInfo struct { + // Describes the optimized EBS performance for the instance type. + EbsOptimizedInfo *EbsOptimizedInfo + // Indicates that the instance type is Amazon EBS-optimized. For more information, // see Amazon EBS-Optimized Instances // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html) in // Amazon EC2 User Guide for Linux Instances. EbsOptimizedSupport EbsOptimizedSupport - // Indicates whether non-volatile memory express (NVMe) is supported. - NvmeSupport EbsNvmeSupport - // Indicates whether Amazon EBS encryption is supported. EncryptionSupport EbsEncryptionSupport - // Describes the optimized EBS performance for the instance type. - EbsOptimizedInfo *EbsOptimizedInfo + // Indicates whether non-volatile memory express (NVMe) is supported. + NvmeSupport EbsNvmeSupport } // Describes a parameter used to set up an EBS volume in a block device mapping. type EbsInstanceBlockDevice struct { + // The time stamp when the attachment initiated. + AttachTime *time.Time + // Indicates whether the volume is deleted on instance termination. DeleteOnTermination *bool - // The ID of the EBS volume. - VolumeId *string - // The attachment state. Status AttachmentStatus - // The time stamp when the attachment initiated. - AttachTime *time.Time + // The ID of the EBS volume. + VolumeId *string } // Describes information used to set up an EBS volume specified in a block device // mapping. type EbsInstanceBlockDeviceSpecification struct { - // The ID of the EBS volume. - VolumeId *string - // Indicates whether the volume is deleted on instance termination. DeleteOnTermination *bool + + // The ID of the EBS volume. + VolumeId *string } // Describes the optimized EBS performance for supported instance types. type EbsOptimizedInfo struct { - // The baseline throughput performance for an EBS-optimized instance type, in MBps. - BaselineThroughputInMBps *float64 - - // The maximum throughput performance for an EBS-optimized instance type, in MBps. - MaximumThroughputInMBps *float64 + // The baseline bandwidth performance for an EBS-optimized instance type, in Mbps. + BaselineBandwidthInMbps *int32 - // The maximum input/output storage operations per second for an EBS-optimized + // The baseline input/output storage operations per seconds for an EBS-optimized // instance type. - MaximumIops *int32 + BaselineIops *int32 + + // The baseline throughput performance for an EBS-optimized instance type, in MBps. + BaselineThroughputInMBps *float64 // The maximum bandwidth performance for an EBS-optimized instance type, in Mbps. MaximumBandwidthInMbps *int32 - // The baseline input/output storage operations per seconds for an EBS-optimized + // The maximum input/output storage operations per second for an EBS-optimized // instance type. - BaselineIops *int32 + MaximumIops *int32 - // The baseline bandwidth performance for an EBS-optimized instance type, in Mbps. - BaselineBandwidthInMbps *int32 + // The maximum throughput performance for an EBS-optimized instance type, in MBps. + MaximumThroughputInMBps *float64 } // Describes an egress-only internet gateway. type EgressOnlyInternetGateway struct { + // Information about the attachment of the egress-only internet gateway. + Attachments []*InternetGatewayAttachment + // The ID of the egress-only internet gateway. EgressOnlyInternetGatewayId *string // The tags assigned to the egress-only internet gateway. Tags []*Tag - - // Information about the attachment of the egress-only internet gateway. - Attachments []*InternetGatewayAttachment } // Describes the association between an instance and an Elastic Graphics // accelerator. type ElasticGpuAssociation struct { - // The ID of the Elastic Graphics accelerator. - ElasticGpuId *string - - // The time the Elastic Graphics accelerator was associated with the instance. - ElasticGpuAssociationTime *string - // The ID of the association. ElasticGpuAssociationId *string // The state of the association between the instance and the Elastic Graphics // accelerator. ElasticGpuAssociationState *string + + // The time the Elastic Graphics accelerator was associated with the instance. + ElasticGpuAssociationTime *string + + // The ID of the Elastic Graphics accelerator. + ElasticGpuId *string } // Describes the status of an Elastic Graphics accelerator. @@ -1803,26 +1803,26 @@ type ElasticGpuHealth struct { // Describes an Elastic Graphics accelerator. type ElasticGpus struct { - // The ID of the Elastic Graphics accelerator. - ElasticGpuId *string - - // The ID of the instance to which the Elastic Graphics accelerator is attached. - InstanceId *string - // The Availability Zone in the which the Elastic Graphics accelerator resides. AvailabilityZone *string // The status of the Elastic Graphics accelerator. ElasticGpuHealth *ElasticGpuHealth + // The ID of the Elastic Graphics accelerator. + ElasticGpuId *string + + // The state of the Elastic Graphics accelerator. + ElasticGpuState ElasticGpuState + // The type of Elastic Graphics accelerator. ElasticGpuType *string + // The ID of the instance to which the Elastic Graphics accelerator is attached. + InstanceId *string + // The tags assigned to the Elastic Graphics accelerator. Tags []*Tag - - // The state of the Elastic Graphics accelerator. - ElasticGpuState ElasticGpuState } // A specification for an Elastic Graphics accelerator. @@ -1848,33 +1848,33 @@ type ElasticGpuSpecificationResponse struct { // Describes an elastic inference accelerator. type ElasticInferenceAccelerator struct { - // The number of elastic inference accelerators to attach to the instance. Default: - // 1 - Count *int32 - // The type of elastic inference accelerator. The possible values are eia1.medium, // eia1.large, eia1.xlarge, eia2.medium, eia2.large, and eia2.xlarge. // // This member is required. Type *string + + // The number of elastic inference accelerators to attach to the instance. Default: + // 1 + Count *int32 } // Describes the association between an instance and an elastic inference // accelerator. type ElasticInferenceAcceleratorAssociation struct { + // The Amazon Resource Name (ARN) of the elastic inference accelerator. + ElasticInferenceAcceleratorArn *string + // The ID of the association. ElasticInferenceAcceleratorAssociationId *string - // The time at which the elastic inference accelerator is associated with an - // instance. - ElasticInferenceAcceleratorAssociationTime *time.Time - - // The Amazon Resource Name (ARN) of the elastic inference accelerator. - ElasticInferenceAcceleratorArn *string - // The state of the elastic inference accelerator. ElasticInferenceAcceleratorAssociationState *string + + // The time at which the elastic inference accelerator is associated with an + // instance. + ElasticInferenceAcceleratorAssociationTime *time.Time } // Contains information about the errors that occurred when enabling fast snapshot @@ -1891,52 +1891,51 @@ type EnableFastSnapshotRestoreErrorItem struct { // Describes an error that occurred when enabling fast snapshot restores. type EnableFastSnapshotRestoreStateError struct { - // The error message. - Message *string - // The error code. Code *string + + // The error message. + Message *string } // Contains information about an error that occurred when enabling fast snapshot // restores. type EnableFastSnapshotRestoreStateErrorItem struct { - // The error. - Error *EnableFastSnapshotRestoreStateError - // The Availability Zone. AvailabilityZone *string + + // The error. + Error *EnableFastSnapshotRestoreStateError } // Describes fast snapshot restores that were successfully enabled. type EnableFastSnapshotRestoreSuccessItem struct { - // The ID of the AWS account that enabled fast snapshot restores on the snapshot. - OwnerId *string - // The Availability Zone. AvailabilityZone *string - // The reason for the state transition. The possible values are as follows: - // - // * - // Client.UserInitiated - The state successfully transitioned to enabling or - // disabling. - // - // * Client.UserInitiated - Lifecycle state transition - The state - // successfully transitioned to optimizing, enabled, or disabled. - StateTransitionReason *string + // The time at which fast snapshot restores entered the disabled state. + DisabledTime *time.Time + + // The time at which fast snapshot restores entered the disabling state. + DisablingTime *time.Time + + // The time at which fast snapshot restores entered the enabled state. + EnabledTime *time.Time + + // The time at which fast snapshot restores entered the enabling state. + EnablingTime *time.Time + + // The time at which fast snapshot restores entered the optimizing state. + OptimizingTime *time.Time // The AWS owner alias that enabled fast snapshot restores on the snapshot. This is // intended for future use. OwnerAlias *string - // The time at which fast snapshot restores entered the disabling state. - DisablingTime *time.Time - - // The time at which fast snapshot restores entered the disabled state. - DisabledTime *time.Time + // The ID of the AWS account that enabled fast snapshot restores on the snapshot. + OwnerId *string // The ID of the snapshot. SnapshotId *string @@ -1944,22 +1943,22 @@ type EnableFastSnapshotRestoreSuccessItem struct { // The state of fast snapshot restores. State FastSnapshotRestoreStateCode - // The time at which fast snapshot restores entered the enabling state. - EnablingTime *time.Time - - // The time at which fast snapshot restores entered the enabled state. - EnabledTime *time.Time - - // The time at which fast snapshot restores entered the optimizing state. - OptimizingTime *time.Time + // The reason for the state transition. The possible values are as follows: + // + // * + // Client.UserInitiated - The state successfully transitioned to enabling or + // disabling. + // + // * Client.UserInitiated - Lifecycle state transition - The state + // successfully transitioned to optimizing, enabled, or disabled. + StateTransitionReason *string } // Describes an EC2 Fleet or Spot Fleet event. type EventInformation struct { - // The ID of the instance. This information is available only for instanceChange - // events. - InstanceId *string + // The description of the event. + EventDescription *string // The event.

    The following are the error events:

    • //

      iamFleetRoleInvalid - The EC2 Fleet or Spot Fleet did not have @@ -2004,91 +2003,93 @@ type EventInformation struct { // valid if the Spot price changes.

    EventSubType *string - // The description of the event. - EventDescription *string + // The ID of the instance. This information is available only for instanceChange + // events. + InstanceId *string } // Describes an export image task. type ExportImageTask struct { - // The status message for the export image task. - StatusMessage *string - - // The percent complete of the export image task. - Progress *string + // A description of the image being exported. + Description *string // The ID of the export image task. ExportImageTaskId *string - // A description of the image being exported. - Description *string + // The ID of the image. + ImageId *string + + // The percent complete of the export image task. + Progress *string + + // Information about the destination Amazon S3 bucket. + S3ExportLocation *ExportTaskS3Location // The status of the export image task. The possible values are active, completed, // deleting, and deleted. Status *string + // The status message for the export image task. + StatusMessage *string + // Any tags assigned to the image being exported. Tags []*Tag - - // Information about the destination Amazon S3 bucket. - S3ExportLocation *ExportTaskS3Location - - // The ID of the image. - ImageId *string } // Describes an instance export task. type ExportTask struct { - // The status message related to the export task. - StatusMessage *string - // A description of the resource being exported. Description *string + // The ID of the export task. + ExportTaskId *string + + // Information about the export task. + ExportToS3Task *ExportToS3Task + // Information about the instance to export. InstanceExportDetails *InstanceExportDetails // The state of the export task. State ExportTaskState - // Information about the export task. - ExportToS3Task *ExportToS3Task + // The status message related to the export task. + StatusMessage *string // The tags for the export task. Tags []*Tag - - // The ID of the export task. - ExportTaskId *string } // Describes the destination for an export image task. type ExportTaskS3Location struct { - // The prefix (logical hierarchy) in the bucket. - S3Prefix *string - // The destination Amazon S3 bucket. S3Bucket *string + + // The prefix (logical hierarchy) in the bucket. + S3Prefix *string } // Describes the destination for an export image task. type ExportTaskS3LocationRequest struct { - // The prefix (logical hierarchy) in the bucket. - S3Prefix *string - // The destination Amazon S3 bucket. // // This member is required. S3Bucket *string + + // The prefix (logical hierarchy) in the bucket. + S3Prefix *string } // Describes the format and location for an instance export task. type ExportToS3Task struct { - // The encryption key for your S3 bucket. - S3Key *string + // The container format used to combine disk images with metadata (such as OVF). If + // absent, only the disk image is exported. + ContainerFormat ContainerFormat // The format for the exported image. DiskImageFormat DiskImageFormat @@ -2098,9 +2099,8 @@ type ExportToS3Task struct { // vm-import-export@amazon.com. S3Bucket *string - // The container format used to combine disk images with metadata (such as OVF). If - // absent, only the disk image is exported. - ContainerFormat ContainerFormat + // The encryption key for your S3 bucket. + S3Key *string } // Describes an instance export task. @@ -2110,6 +2110,9 @@ type ExportToS3TaskSpecification struct { // absent, only the disk image is exported. ContainerFormat ContainerFormat + // The format for the exported image. + DiskImageFormat DiskImageFormat + // The Amazon S3 bucket for the destination image. The destination bucket must // exist and grant WRITE and READ_ACP permissions to the AWS account // vm-import-export@amazon.com. @@ -2118,19 +2121,16 @@ type ExportToS3TaskSpecification struct { // The image is written to a single object in the Amazon S3 bucket at the S3 key // s3prefix + exportTaskId + '.' + diskImageFormat. S3Prefix *string - - // The format for the exported image. - DiskImageFormat DiskImageFormat } // Describes a Reserved Instance whose queued purchase was not deleted. type FailedQueuedPurchaseDeletion struct { - // The ID of the Reserved Instance. - ReservedInstancesId *string - // The error. Error *DeleteQueuedReservedInstancesError + + // The ID of the Reserved Instance. + ReservedInstancesId *string } // Describes the IAM SAML identity provider used for federated authentication. @@ -2177,29 +2177,16 @@ type FederatedAuthenticationRequest struct { // * DescribeVpcs () type Filter struct { - // The filter values. Filter values are case-sensitive. - Values []*string - // The name of the filter. Filter names are case-sensitive. Name *string + + // The filter values. Filter values are case-sensitive. + Values []*string } // Describes an EC2 Fleet. type FleetData struct { - // Indicates whether EC2 Fleet should replace unhealthy instances. - ReplaceUnhealthyInstances *bool - - // The creation date and time of the EC2 Fleet. - CreateTime *time.Time - - // Indicates whether running instances should be terminated when the EC2 Fleet - // expires. - TerminateInstancesWithExpiration *bool - - // The allocation strategy of On-Demand Instances in an EC2 Fleet. - OnDemandOptions *OnDemandOptions - // The progress of the EC2 Fleet. If there is an error, the status is error. After // all requests are placed, the status is pending_fulfillment. If the size of the // EC2 Fleet is equal to or greater than its target capacity, the status is @@ -2207,20 +2194,33 @@ type FleetData struct { // pending_termination while instances are terminating. ActivityStatus FleetActivityStatus - // The end date and time of the request, in UTC format (for example, - // YYYY-MM-DDTHH:MM:SSZ). At this point, no new instance requests are placed or - // able to fulfill the request. The default end date is 7 days from the current - // date. - ValidUntil *time.Time + // Unique, case-sensitive identifier that you provide to ensure the idempotency of + // the request. For more information, see Ensuring Idempotency + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // Constraints: Maximum 64 ASCII characters + ClientToken *string - // Indicates whether running instances should be terminated if the target capacity - // of the EC2 Fleet is decreased below the current size of the EC2 Fleet. - ExcessCapacityTerminationPolicy FleetExcessCapacityTerminationPolicy + // The creation date and time of the EC2 Fleet. + CreateTime *time.Time // Information about the instances that could not be launched by the fleet. Valid // only when Type is set to instant. Errors []*DescribeFleetError + // Indicates whether running instances should be terminated if the target capacity + // of the EC2 Fleet is decreased below the current size of the EC2 Fleet. + ExcessCapacityTerminationPolicy FleetExcessCapacityTerminationPolicy + + // The ID of the EC2 Fleet. + FleetId *string + + // The state of the EC2 Fleet. + FleetState FleetStateCode + + // The number of units fulfilled by this request compared to the set target + // capacity. + FulfilledCapacity *float64 + // The number of units fulfilled by this request compared to the set target // On-Demand capacity. FulfilledOnDemandCapacity *float64 @@ -2229,22 +2229,20 @@ type FleetData struct { // Type is set to instant. Instances []*DescribeFleetsInstances - // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). - // Constraints: Maximum 64 ASCII characters - ClientToken *string + // The launch template and overrides. + LaunchTemplateConfigs []*FleetLaunchTemplateConfig - // The start date and time of the request, in UTC format (for example, - // YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request - // immediately. - ValidFrom *time.Time + // The allocation strategy of On-Demand Instances in an EC2 Fleet. + OnDemandOptions *OnDemandOptions + + // Indicates whether EC2 Fleet should replace unhealthy instances. + ReplaceUnhealthyInstances *bool // The configuration of Spot Instances in an EC2 Fleet. SpotOptions *SpotOptions - // The state of the EC2 Fleet. - FleetState FleetStateCode + // The tags for an EC2 Fleet resource. + Tags []*Tag // The number of units to request. You can choose to set the target capacity in // terms of instances or a performance characteristic that is important to your @@ -2252,18 +2250,9 @@ type FleetData struct { // maintain, you can specify a target capacity of 0 and add capacity later. TargetCapacitySpecification *TargetCapacitySpecification - // The launch template and overrides. - LaunchTemplateConfigs []*FleetLaunchTemplateConfig - - // The tags for an EC2 Fleet resource. - Tags []*Tag - - // The ID of the EC2 Fleet. - FleetId *string - - // The number of units fulfilled by this request compared to the set target - // capacity. - FulfilledCapacity *float64 + // Indicates whether running instances should be terminated when the EC2 Fleet + // expires. + TerminateInstancesWithExpiration *bool // The type of request. Indicates whether the EC2 Fleet only requests the target // capacity, or also attempts to maintain it. If you request a certain target @@ -2274,6 +2263,17 @@ type FleetData struct { // capacity. It also automatically replenishes any interrupted Spot Instances. // Default: maintain. Type FleetType + + // The start date and time of the request, in UTC format (for example, + // YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request + // immediately. + ValidFrom *time.Time + + // The end date and time of the request, in UTC format (for example, + // YYYY-MM-DDTHH:MM:SSZ). At this point, no new instance requests are placed or + // able to fulfill the request. The default end date is 7 days from the current + // date. + ValidUntil *time.Time } // Describes a launch template and overrides. @@ -2302,8 +2302,17 @@ type FleetLaunchTemplateConfigRequest struct { // Describes overrides for a launch template. type FleetLaunchTemplateOverrides struct { - // The number of units provided by the specified instance type. - WeightedCapacity *float64 + // The Availability Zone in which to launch the instances. + AvailabilityZone *string + + // The instance type. + InstanceType InstanceType + + // The maximum price per unit hour that you are willing to pay for a Spot Instance. + MaxPrice *string + + // The location where the instance launched, if applicable. + Placement *PlacementResponse // The priority for the launch template override. If AllocationStrategy is set to // prioritized, EC2 Fleet uses priority to determine which launch template override @@ -2312,28 +2321,28 @@ type FleetLaunchTemplateOverrides struct { // higher the priority. If no number is set, the override has the lowest priority. Priority *float64 - // The Availability Zone in which to launch the instances. - AvailabilityZone *string - // The ID of the subnet in which to launch the instances. SubnetId *string - // The location where the instance launched, if applicable. - Placement *PlacementResponse - - // The instance type. - InstanceType InstanceType - - // The maximum price per unit hour that you are willing to pay for a Spot Instance. - MaxPrice *string + // The number of units provided by the specified instance type. + WeightedCapacity *float64 } // Describes overrides for a launch template. type FleetLaunchTemplateOverridesRequest struct { + // The Availability Zone in which to launch the instances. + AvailabilityZone *string + // The instance type. InstanceType InstanceType + // The maximum price per unit hour that you are willing to pay for a Spot Instance. + MaxPrice *string + + // The location where the instance launched, if applicable. + Placement *Placement + // The priority for the launch template override. If AllocationStrategy is set to // prioritized, EC2 Fleet uses priority to determine which launch template override // to use first in fulfilling On-Demand capacity. The highest priority is launched @@ -2348,17 +2357,8 @@ type FleetLaunchTemplateOverridesRequest struct { // ID. SubnetId *string - // The maximum price per unit hour that you are willing to pay for a Spot Instance. - MaxPrice *string - // The number of units provided by the specified instance type. WeightedCapacity *float64 - - // The Availability Zone in which to launch the instances. - AvailabilityZone *string - - // The location where the instance launched, if applicable. - Placement *Placement } // Describes the Amazon EC2 launch template and the launch template version that @@ -2369,6 +2369,10 @@ type FleetLaunchTemplateOverridesRequest struct { // in the Amazon EC2 User Guide for Linux Instances. type FleetLaunchTemplateSpecification struct { + // The ID of the launch template. If you specify the template ID, you can't specify + // the template name. + LaunchTemplateId *string + // The name of the launch template. If you specify the template name, you can't // specify the template ID. LaunchTemplateName *string @@ -2378,10 +2382,6 @@ type FleetLaunchTemplateSpecification struct { // latest version of the launch template. If the value is $Default, Amazon EC2 uses // the default version of the launch template. Version *string - - // The ID of the launch template. If you specify the template ID, you can't specify - // the template name. - LaunchTemplateId *string } // Describes the Amazon EC2 launch template and the launch template version that @@ -2391,63 +2391,65 @@ type FleetLaunchTemplateSpecification struct { // in the Amazon Elastic Compute Cloud User Guide. type FleetLaunchTemplateSpecificationRequest struct { - // The launch template version number, $Latest, or $Default. You must specify a - // value, otherwise the request fails. If the value is $Latest, Amazon EC2 uses the - // latest version of the launch template. If the value is $Default, Amazon EC2 uses - // the default version of the launch template. - Version *string + // The ID of the launch template. If you specify the template ID, you can't specify + // the template name. + LaunchTemplateId *string // The name of the launch template. If you specify the template name, you can't // specify the template ID. LaunchTemplateName *string - // The ID of the launch template. If you specify the template ID, you can't specify - // the template name. - LaunchTemplateId *string + // The launch template version number, $Latest, or $Default. You must specify a + // value, otherwise the request fails. If the value is $Latest, Amazon EC2 uses the + // latest version of the launch template. If the value is $Default, Amazon EC2 uses + // the default version of the launch template. + Version *string } // Describes a flow log. type FlowLog struct { - // Specifies the type of destination to which the flow log data is published. Flow - // log data can be published to CloudWatch Logs or Amazon S3. - LogDestinationType LogDestinationType - - // The ID of the resource on which the flow log was created. - ResourceId *string + // The date and time the flow log was created. + CreationTime *time.Time - // Specifies the destination to which the flow log data is published. Flow log data - // can be published to an CloudWatch Logs log group or an Amazon S3 bucket. If the - // flow log publishes to CloudWatch Logs, this element indicates the Amazon - // Resource Name (ARN) of the CloudWatch Logs log group to which the data is - // published. If the flow log publishes to Amazon S3, this element indicates the - // ARN of the Amazon S3 bucket to which the data is published. - LogDestination *string + // Information about the error that occurred. Rate limited indicates that + // CloudWatch Logs throttling has been applied for one or more network interfaces, + // or that you've reached the limit on the number of log groups that you can + // create. Access error indicates that the IAM role associated with the flow log + // does not have sufficient permissions to publish to CloudWatch Logs. Unknown + // error indicates an internal error. + DeliverLogsErrorMessage *string // The ARN of the IAM role that posts logs to CloudWatch Logs. DeliverLogsPermissionArn *string - // The tags for the flow log. - Tags []*Tag + // The status of the logs delivery (SUCCESS | FAILED). + DeliverLogsStatus *string // The flow log ID. FlowLogId *string - // The date and time the flow log was created. - CreationTime *time.Time + // The status of the flow log (ACTIVE). + FlowLogStatus *string - // The type of traffic captured for the flow log. - TrafficType TrafficType + // Specifies the destination to which the flow log data is published. Flow log data + // can be published to an CloudWatch Logs log group or an Amazon S3 bucket. If the + // flow log publishes to CloudWatch Logs, this element indicates the Amazon + // Resource Name (ARN) of the CloudWatch Logs log group to which the data is + // published. If the flow log publishes to Amazon S3, this element indicates the + // ARN of the Amazon S3 bucket to which the data is published. + LogDestination *string - // The status of the logs delivery (SUCCESS | FAILED). - DeliverLogsStatus *string + // Specifies the type of destination to which the flow log data is published. Flow + // log data can be published to CloudWatch Logs or Amazon S3. + LogDestinationType LogDestinationType + + // The format of the flow log record. + LogFormat *string // The name of the flow log group. LogGroupName *string - // The status of the flow log (ACTIVE). - FlowLogStatus *string - // The maximum interval of time, in seconds, during which a flow of packets is // captured and aggregated into a flow log record. When a network interface is // attached to a Nitro-based instance @@ -2456,32 +2458,30 @@ type FlowLog struct { // the specified value. Valid Values: 60 | 600 MaxAggregationInterval *int32 - // The format of the flow log record. - LogFormat *string + // The ID of the resource on which the flow log was created. + ResourceId *string - // Information about the error that occurred. Rate limited indicates that - // CloudWatch Logs throttling has been applied for one or more network interfaces, - // or that you've reached the limit on the number of log groups that you can - // create. Access error indicates that the IAM role associated with the flow log - // does not have sufficient permissions to publish to CloudWatch Logs. Unknown - // error indicates an internal error. - DeliverLogsErrorMessage *string + // The tags for the flow log. + Tags []*Tag + + // The type of traffic captured for the flow log. + TrafficType TrafficType } // Describes the FPGA accelerator for the instance type. type FpgaDeviceInfo struct { - // The name of the FPGA accelerator. - Name *string - - // Describes the memory for the FPGA accelerator for the instance type. - MemoryInfo *FpgaDeviceMemoryInfo + // The count of FPGA accelerators for the instance type. + Count *int32 // The manufacturer of the FPGA accelerator. Manufacturer *string - // The count of FPGA accelerators for the instance type. - Count *int32 + // Describes the memory for the FPGA accelerator for the instance type. + MemoryInfo *FpgaDeviceMemoryInfo + + // The name of the FPGA accelerator. + Name *string } // Describes the memory for the FPGA accelerator for the instance type. @@ -2494,70 +2494,70 @@ type FpgaDeviceMemoryInfo struct { // Describes an Amazon FPGA image (AFI). type FpgaImage struct { - // The time of the most recent update to the AFI. - UpdateTime *time.Time + // The date and time the AFI was created. + CreateTime *time.Time + + // Indicates whether data retention support is enabled for the AFI. + DataRetentionSupport *bool + + // The description of the AFI. + Description *string // The global FPGA image identifier (AGFI ID). FpgaImageGlobalId *string + // The FPGA image identifier (AFI ID). + FpgaImageId *string + // The name of the AFI. Name *string - // Any tags assigned to the AFI. - Tags []*Tag - - // Information about the state of the AFI. - State *FpgaImageState + // The alias of the AFI owner. Possible values include self, amazon, and + // aws-marketplace. + OwnerAlias *string // The AWS account ID of the AFI owner. OwnerId *string + // Information about the PCI bus. + PciId *PciId + + // The product codes for the AFI. + ProductCodes []*ProductCode + // Indicates whether the AFI is public. Public *bool - // The date and time the AFI was created. - CreateTime *time.Time - // The version of the AWS Shell that was used to create the bitstream. ShellVersion *string - // The FPGA image identifier (AFI ID). - FpgaImageId *string - - // The product codes for the AFI. - ProductCodes []*ProductCode - - // The description of the AFI. - Description *string - - // Indicates whether data retention support is enabled for the AFI. - DataRetentionSupport *bool + // Information about the state of the AFI. + State *FpgaImageState - // The alias of the AFI owner. Possible values include self, amazon, and - // aws-marketplace. - OwnerAlias *string + // Any tags assigned to the AFI. + Tags []*Tag - // Information about the PCI bus. - PciId *PciId + // The time of the most recent update to the AFI. + UpdateTime *time.Time } // Describes an Amazon FPGA image (AFI) attribute. type FpgaImageAttribute struct { - // The load permissions. - LoadPermissions []*LoadPermission - - // The product codes. - ProductCodes []*ProductCode - // The description of the AFI. Description *string + // The ID of the AFI. + FpgaImageId *string + + // The load permissions. + LoadPermissions []*LoadPermission + // The name of the AFI. Name *string - // The ID of the AFI. - FpgaImageId *string + // The product codes. + ProductCodes []*ProductCode } // Describes the state of the bitstream generation process for an Amazon FPGA image @@ -2585,18 +2585,18 @@ type FpgaImageState struct { // Describes the FPGAs for the instance type. type FpgaInfo struct { - // The total memory of all FPGA accelerators for the instance type. - TotalFpgaMemoryInMiB *int32 - // Describes the FPGAs for the instance type. Fpgas []*FpgaDeviceInfo + + // The total memory of all FPGA accelerators for the instance type. + TotalFpgaMemoryInMiB *int32 } // Describes the GPU accelerators for the instance type. type GpuDeviceInfo struct { - // The name of the GPU accelerator. - Name *string + // The number of GPUs for the instance type. + Count *int32 // The manufacturer of the GPU accelerator. Manufacturer *string @@ -2604,8 +2604,8 @@ type GpuDeviceInfo struct { // Describes the memory available to the GPU accelerator. MemoryInfo *GpuDeviceMemoryInfo - // The number of GPUs for the instance type. - Count *int32 + // The name of the GPU accelerator. + Name *string } // Describes the memory available to the GPU accelerator. @@ -2618,21 +2618,21 @@ type GpuDeviceMemoryInfo struct { // Describes the GPU accelerators for the instance type. type GpuInfo struct { - // The total size of the memory for the GPU accelerators for the instance type. - TotalGpuMemoryInMiB *int32 - // Describes the GPU accelerators for the instance type. Gpus []*GpuDeviceInfo + + // The total size of the memory for the GPU accelerators for the instance type. + TotalGpuMemoryInMiB *int32 } // Describes a security group. type GroupIdentifier struct { - // The name of the security group. - GroupName *string - // The ID of the security group. GroupId *string + + // The name of the security group. + GroupName *string } // Indicates whether your instance is configured for hibernation. This parameter is @@ -2664,10 +2664,6 @@ type HibernationOptionsRequest struct { // Describes an event in the history of the Spot Fleet request. type HistoryRecord struct { - // The date and time of the event, in UTC format (for example, - // YYYY-MM-DDTHH:MM:SSZ). - Timestamp *time.Time - // Information about the event. EventInformation *EventInformation @@ -2684,6 +2680,10 @@ type HistoryRecord struct { // * // Information - An informational event. EventType EventType + + // The date and time of the event, in UTC format (for example, + // YYYY-MM-DDTHH:MM:SSZ). + Timestamp *time.Time } // Describes an event in the history of an EC2 Fleet. @@ -2703,75 +2703,75 @@ type HistoryRecordEntry struct { // Describes the properties of the Dedicated Host. type Host struct { - // Indicates whether host recovery is enabled or disabled for the Dedicated Host. - HostRecovery HostRecovery - - // The Dedicated Host's state. - State AllocationState - // The time that the Dedicated Host was allocated. AllocationTime *time.Time - // The reservation ID of the Dedicated Host. This returns a null response if the - // Dedicated Host doesn't have an associated reservation. - HostReservationId *string - // Indicates whether the Dedicated Host supports multiple instance types of the // same instance family, or a specific instance type only. one indicates that the // Dedicated Host supports multiple instance types in the instance family. off // indicates that the Dedicated Host supports a single instance type only. AllowsMultipleInstanceTypes AllowsMultipleInstanceTypes - // Information about the instances running on the Dedicated Host. - AvailableCapacity *AvailableCapacity - - // The time that the Dedicated Host was released. - ReleaseTime *time.Time + // Whether auto-placement is on or off. + AutoPlacement AutoPlacement - // The IDs and instance type that are currently running on the Dedicated Host. - Instances []*HostInstance + // The Availability Zone of the Dedicated Host. + AvailabilityZone *string // The ID of the Availability Zone in which the Dedicated Host is allocated. AvailabilityZoneId *string + // Information about the instances running on the Dedicated Host. + AvailableCapacity *AvailableCapacity + // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. For more information, see How to Ensure Idempotency // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). ClientToken *string - // Whether auto-placement is on or off. - AutoPlacement AutoPlacement - // The ID of the Dedicated Host. HostId *string // The hardware specifications of the Dedicated Host. HostProperties *HostProperties - // The ID of the AWS account that owns the Dedicated Host. - OwnerId *string + // Indicates whether host recovery is enabled or disabled for the Dedicated Host. + HostRecovery HostRecovery - // Any tags assigned to the Dedicated Host. - Tags []*Tag + // The reservation ID of the Dedicated Host. This returns a null response if the + // Dedicated Host doesn't have an associated reservation. + HostReservationId *string + + // The IDs and instance type that are currently running on the Dedicated Host. + Instances []*HostInstance // Indicates whether the Dedicated Host is in a host resource group. If // memberOfServiceLinkedResourceGroup is true, the host is in a host resource // group; otherwise, it is not. MemberOfServiceLinkedResourceGroup *bool - // The Availability Zone of the Dedicated Host. - AvailabilityZone *string + // The ID of the AWS account that owns the Dedicated Host. + OwnerId *string + + // The time that the Dedicated Host was released. + ReleaseTime *time.Time + + // The Dedicated Host's state. + State AllocationState + + // Any tags assigned to the Dedicated Host. + Tags []*Tag } // Describes an instance running on a Dedicated Host. type HostInstance struct { - // The instance type (for example, m3.medium) of the running instance. - InstanceType *string - // The ID of instance that is running on the Dedicated Host. InstanceId *string + // The instance type (for example, m3.medium) of the running instance. + InstanceType *string + // The ID of the AWS account that owns the instance. OwnerId *string } @@ -2779,31 +2779,37 @@ type HostInstance struct { // Details about the Dedicated Host Reservation offering. type HostOffering struct { - // The upfront price of the offering. Does not apply to No Upfront offerings. - UpfrontPrice *string + // The currency of the offering. + CurrencyCode CurrencyCodeValues // The duration of the offering (in seconds). Duration *int32 - // The currency of the offering. - CurrencyCode CurrencyCodeValues - // The hourly price of the offering. HourlyPrice *string - // The available payment option. - PaymentOption PaymentOption - // The instance family of the offering. InstanceFamily *string // The ID of the offering. OfferingId *string + + // The available payment option. + PaymentOption PaymentOption + + // The upfront price of the offering. Does not apply to No Upfront offerings. + UpfrontPrice *string } // Describes the properties of a Dedicated Host. type HostProperties struct { + // The number of cores on the Dedicated Host. + Cores *int32 + + // The instance family supported by the Dedicated Host. For example, m5. + InstanceFamily *string + // The instance type supported by the Dedicated Host. For example, m5.large. If the // host supports multiple instance types, no instanceType is returned. InstanceType *string @@ -2811,42 +2817,40 @@ type HostProperties struct { // The number of sockets on the Dedicated Host. Sockets *int32 - // The instance family supported by the Dedicated Host. For example, m5. - InstanceFamily *string - // The total number of vCPUs on the Dedicated Host. TotalVCpus *int32 - - // The number of cores on the Dedicated Host. - Cores *int32 } // Details about the Dedicated Host Reservation and associated Dedicated Hosts. type HostReservation struct { - // The state of the reservation. - State ReservationState - - // Any tags assigned to the Dedicated Host Reservation. - Tags []*Tag - // The number of Dedicated Hosts the reservation is associated with. Count *int32 - // The instance family of the Dedicated Host Reservation. The instance family on - // the Dedicated Host must be the same in order for it to benefit from the - // reservation. - InstanceFamily *string + // The currency in which the upfrontPrice and hourlyPrice amounts are specified. At + // this time, the only supported currency is USD. + CurrencyCode CurrencyCodeValues // The length of the reservation's term, specified in seconds. Can be 31536000 (1 // year) | 94608000 (3 years). Duration *int32 - // The upfront price of the reservation. - UpfrontPrice *string + // The date and time that the reservation ends. + End *time.Time - // The date and time that the reservation started. - Start *time.Time + // The IDs of the Dedicated Hosts associated with the reservation. + HostIdSet []*string + + // The ID of the reservation that specifies the associated Dedicated Hosts. + HostReservationId *string + + // The hourly price of the reservation. + HourlyPrice *string + + // The instance family of the Dedicated Host Reservation. The instance family on + // the Dedicated Host must be the same in order for it to benefit from the + // reservation. + InstanceFamily *string // The ID of the reservation. This remains the same regardless of which Dedicated // Hosts are associated with it. @@ -2855,70 +2859,66 @@ type HostReservation struct { // The payment option selected for this reservation. PaymentOption PaymentOption - // The hourly price of the reservation. - HourlyPrice *string - - // The date and time that the reservation ends. - End *time.Time + // The date and time that the reservation started. + Start *time.Time - // The IDs of the Dedicated Hosts associated with the reservation. - HostIdSet []*string + // The state of the reservation. + State ReservationState - // The currency in which the upfrontPrice and hourlyPrice amounts are specified. At - // this time, the only supported currency is USD. - CurrencyCode CurrencyCodeValues + // Any tags assigned to the Dedicated Host Reservation. + Tags []*Tag - // The ID of the reservation that specifies the associated Dedicated Hosts. - HostReservationId *string + // The upfront price of the reservation. + UpfrontPrice *string } // Describes an IAM instance profile. type IamInstanceProfile struct { - // The ID of the instance profile. - Id *string - // The Amazon Resource Name (ARN) of the instance profile. Arn *string + + // The ID of the instance profile. + Id *string } // Describes an association between an IAM instance profile and an instance. type IamInstanceProfileAssociation struct { + // The ID of the association. + AssociationId *string + + // The IAM instance profile. + IamInstanceProfile *IamInstanceProfile + // The ID of the instance. InstanceId *string - // The time the IAM instance profile was associated with the instance. - Timestamp *time.Time - // The state of the association. State IamInstanceProfileAssociationState - // The ID of the association. - AssociationId *string - - // The IAM instance profile. - IamInstanceProfile *IamInstanceProfile + // The time the IAM instance profile was associated with the instance. + Timestamp *time.Time } // Describes an IAM instance profile. type IamInstanceProfileSpecification struct { - // The name of the instance profile. - Name *string - // The Amazon Resource Name (ARN) of the instance profile. Arn *string + + // The name of the instance profile. + Name *string } // Describes the ICMP type and code. type IcmpTypeCode struct { - // The ICMP type. A value of -1 means all types. - Type *int32 - // The ICMP code. A value of -1 means all codes for the specified ICMP type. Code *int32 + + // The ICMP type. A value of -1 means all types. + Type *int32 } // Describes the ID format for a resource. @@ -2929,11 +2929,11 @@ type IdFormat struct { // returned. Deadline *time.Time - // Indicates whether longer IDs (17-character IDs) are enabled for the resource. - UseLongIds *bool - // The type of resource. Resource *string + + // Indicates whether longer IDs (17-character IDs) are enabled for the resource. + UseLongIds *bool } // The internet key exchange (IKE) version permitted for the VPN tunnel. @@ -2953,31 +2953,26 @@ type IKEVersionsRequestListValue struct { // Describes an image. type Image struct { - // Specifies whether enhanced networking with ENA is enabled. - EnaSupport *bool + // The architecture of the image. + Architecture ArchitectureValues - // The type of image. - ImageType ImageTypeValues + // Any block device mapping entries. + BlockDeviceMappings []*BlockDeviceMapping - // This value is set to windows for Windows AMIs; otherwise, it is blank. - Platform PlatformValues + // The date and time the image was created. + CreationDate *string - // The reason for the state change. - StateReason *StateReason + // The description of the AMI that was provided during image creation. + Description *string - // The operation of the Amazon EC2 instance and the billing code that is associated - // with the AMI. usageOperation corresponds to the lineitem/Operation - // (https://docs.aws.amazon.com/cur/latest/userguide/Lineitem-columns.html#Lineitem-details-O-Operation) - // column on your AWS Cost and Usage Report and in the AWS Price List API - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html). - // For the list of UsageOperation codes, see Platform Details and Usage Operation - // Billing Codes - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-billing-info.html#billing-info) - // in the Amazon Elastic Compute Cloud User Guide. - UsageOperation *string + // Specifies whether enhanced networking with ENA is enabled. + EnaSupport *bool - // The AWS account ID of the image owner. - OwnerId *string + // The hypervisor type of the image. + Hypervisor HypervisorType + + // The ID of the AMI. + ImageId *string // The location of the AMI. ImageLocation *string @@ -2986,26 +2981,21 @@ type Image struct { // AMI owner. ImageOwnerAlias *string - // The date and time the image was created. - CreationDate *string - - // The description of the AMI that was provided during image creation. - Description *string - - // The device name of the root device volume (for example, /dev/sda1). - RootDeviceName *string + // The type of image. + ImageType ImageTypeValues // The kernel associated with the image, if any. Only applicable for machine // images. KernelId *string - // Indicates whether the image has public launch permissions. The value is true if - // this image has public launch permissions or false if it has only implicit and - // explicit launch permissions. - Public *bool + // The name of the AMI that was provided during image creation. + Name *string - // The type of virtualization of the AMI. - VirtualizationType VirtualizationType + // The AWS account ID of the image owner. + OwnerId *string + + // This value is set to windows for Windows AMIs; otherwise, it is blank. + Platform PlatformValues // The platform details associated with the billing code of the AMI. For more // information, see Obtaining Billing Information @@ -3013,63 +3003,73 @@ type Image struct { // the Amazon Elastic Compute Cloud User Guide. PlatformDetails *string - // The ID of the AMI. - ImageId *string + // Any product codes associated with the AMI. + ProductCodes []*ProductCode - // The name of the AMI that was provided during image creation. - Name *string + // Indicates whether the image has public launch permissions. The value is true if + // this image has public launch permissions or false if it has only implicit and + // explicit launch permissions. + Public *bool - // The hypervisor type of the image. - Hypervisor HypervisorType + // The RAM disk associated with the image, if any. Only applicable for machine + // images. + RamdiskId *string + + // The device name of the root device volume (for example, /dev/sda1). + RootDeviceName *string // The type of root device used by the AMI. The AMI can use an EBS volume or an // instance store volume. RootDeviceType DeviceType - // The architecture of the image. - Architecture ArchitectureValues - - // Any product codes associated with the AMI. - ProductCodes []*ProductCode - - // Any block device mapping entries. - BlockDeviceMappings []*BlockDeviceMapping + // Specifies whether enhanced networking with the Intel 82599 Virtual Function + // interface is enabled. + SriovNetSupport *string // The current state of the AMI. If the state is available, the image is // successfully registered and can be used to launch an instance. State ImageState - // Any tags assigned to the image. + // The reason for the state change. + StateReason *StateReason + + // Any tags assigned to the image. Tags []*Tag - // Specifies whether enhanced networking with the Intel 82599 Virtual Function - // interface is enabled. - SriovNetSupport *string + // The operation of the Amazon EC2 instance and the billing code that is associated + // with the AMI. usageOperation corresponds to the lineitem/Operation + // (https://docs.aws.amazon.com/cur/latest/userguide/Lineitem-columns.html#Lineitem-details-O-Operation) + // column on your AWS Cost and Usage Report and in the AWS Price List API + // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html). + // For the list of UsageOperation codes, see Platform Details and Usage Operation + // Billing Codes + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-billing-info.html#billing-info) + // in the Amazon Elastic Compute Cloud User Guide. + UsageOperation *string - // The RAM disk associated with the image, if any. Only applicable for machine - // images. - RamdiskId *string + // The type of virtualization of the AMI. + VirtualizationType VirtualizationType } // Describes the disk container object for an import image task. type ImageDiskContainer struct { - // The URL to the Amazon S3-based disk image being imported. The URL can either be - // a https URL (https://..) or an Amazon S3 URL (s3://..) - Url *string + // The description of the disk image. + Description *string - // The ID of the EBS snapshot to be used for importing the snapshot. - SnapshotId *string + // The block device mapping for the disk. + DeviceName *string // The format of the disk image being imported. Valid values: OVA | VHD | VHDX // |VMDK Format *string - // The description of the disk image. - Description *string + // The ID of the EBS snapshot to be used for importing the snapshot. + SnapshotId *string - // The block device mapping for the disk. - DeviceName *string + // The URL to the Amazon S3-based disk image being imported. The URL can either be + // a https URL (https://..) or an Amazon S3 URL (s3://..) + Url *string // The S3 bucket for the disk image. UserBucket *UserBucket @@ -3092,157 +3092,157 @@ type ImportImageLicenseConfigurationResponse struct { // Describes an import image task. type ImportImageTask struct { - // A brief status for the import image task. - Status *string + // The architecture of the virtual machine. Valid values: i386 | x86_64 | arm64 + Architecture *string // A description of the import task. Description *string + // Indicates whether the image is encrypted. + Encrypted *bool + + // The target hypervisor for the import task. Valid values: xen + Hypervisor *string + // The ID of the Amazon Machine Image (AMI) of the imported virtual machine. ImageId *string - // The architecture of the virtual machine. Valid values: i386 | x86_64 | arm64 - Architecture *string + // The ID of the import image task. + ImportTaskId *string - // The tags for the import image task. - Tags []*Tag + // The identifier for the AWS Key Management Service (AWS KMS) customer master key + // (CMK) that was used to create the encrypted image. + KmsKeyId *string // The ARNs of the license configurations that are associated with the import image // task. LicenseSpecifications []*ImportImageLicenseConfigurationResponse - // The ID of the import image task. - ImportTaskId *string - // The license type of the virtual machine. LicenseType *string // The description string for the import image task. Platform *string - // Indicates whether the image is encrypted. - Encrypted *bool - - // The identifier for the AWS Key Management Service (AWS KMS) customer master key - // (CMK) that was used to create the encrypted image. - KmsKeyId *string - // The percentage of progress of the import image task. Progress *string - // A descriptive status message for the import image task. - StatusMessage *string - // Information about the snapshots. SnapshotDetails []*SnapshotDetail - // The target hypervisor for the import task. Valid values: xen - Hypervisor *string + // A brief status for the import image task. + Status *string + + // A descriptive status message for the import image task. + StatusMessage *string + + // The tags for the import image task. + Tags []*Tag } // Describes the launch specification for VM import. type ImportInstanceLaunchSpecification struct { - // Indicates whether monitoring is enabled. - Monitoring *bool - - // [EC2-VPC] An available IP address from the IP address range of the subnet. - PrivateIpAddress *string - - // The instance type. For more information about the instance types that you can - // import, see Instance Types - // (https://docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#vmimport-instance-types) - // in the VM Import/Export User Guide. - InstanceType InstanceType + // Reserved. + AdditionalInfo *string - // The Base64-encoded user data to make available to the instance. - UserData *UserData + // The architecture of the instance. + Architecture ArchitectureValues // The security group IDs. GroupIds []*string + // The security group names. + GroupNames []*string + // Indicates whether an instance stops or terminates when you initiate shutdown // from the instance (using the operating system command for system shutdown). InstanceInitiatedShutdownBehavior ShutdownBehavior - // The architecture of the instance. - Architecture ArchitectureValues + // The instance type. For more information about the instance types that you can + // import, see Instance Types + // (https://docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#vmimport-instance-types) + // in the VM Import/Export User Guide. + InstanceType InstanceType + + // Indicates whether monitoring is enabled. + Monitoring *bool // The placement information for the instance. Placement *Placement + // [EC2-VPC] An available IP address from the IP address range of the subnet. + PrivateIpAddress *string + // [EC2-VPC] The ID of the subnet in which to launch the instance. SubnetId *string - // Reserved. - AdditionalInfo *string - - // The security group names. - GroupNames []*string + // The Base64-encoded user data to make available to the instance. + UserData *UserData } // Describes an import instance task. type ImportInstanceTaskDetails struct { - // The instance operating system. - Platform PlatformValues - // A description of the task. Description *string - // The volumes. - Volumes []*ImportInstanceVolumeDetailItem - // The ID of the instance. InstanceId *string + + // The instance operating system. + Platform PlatformValues + + // The volumes. + Volumes []*ImportInstanceVolumeDetailItem } // Describes an import volume task. type ImportInstanceVolumeDetailItem struct { - // The status information or errors related to the disk image. - StatusMessage *string - // The Availability Zone where the resulting instance will reside. AvailabilityZone *string + // The number of bytes converted so far. + BytesConverted *int64 + // A description of the task. Description *string - // The number of bytes converted so far. - BytesConverted *int64 + // The image. + Image *DiskImageDescription // The status of the import of this particular disk image. Status *string + // The status information or errors related to the disk image. + StatusMessage *string + // The volume. Volume *DiskImageVolumeDescription - - // The image. - Image *DiskImageDescription } // Describes an import snapshot task. type ImportSnapshotTask struct { + // A description of the import snapshot task. + Description *string + // The ID of the import snapshot task. ImportTaskId *string - // The tags for the import snapshot task. - Tags []*Tag - // Describes an import snapshot task. SnapshotTaskDetail *SnapshotTaskDetail - // A description of the import snapshot task. - Description *string + // The tags for the import snapshot task. + Tags []*Tag } // Describes an import volume task. type ImportVolumeTaskDetails struct { - // The image. - Image *DiskImageDescription + // The Availability Zone where the resulting volume will reside. + AvailabilityZone *string // The number of bytes converted so far. BytesConverted *int64 @@ -3250,8 +3250,8 @@ type ImportVolumeTaskDetails struct { // The description you provided when starting the import volume task. Description *string - // The Availability Zone where the resulting volume will reside. - AvailabilityZone *string + // The image. + Image *DiskImageDescription // The volume. Volume *DiskImageVolumeDescription @@ -3267,12 +3267,12 @@ type InferenceAcceleratorInfo struct { // Describes the Inference accelerators for the instance type. type InferenceDeviceInfo struct { - // The manufacturer of the Inference accelerator. - Manufacturer *string - // The number of Inference accelerators for the instance type. Count *int32 + // The manufacturer of the Inference accelerator. + Manufacturer *string + // The name of the Inference accelerator. Name *string } @@ -3280,59 +3280,28 @@ type InferenceDeviceInfo struct { // Describes an instance. type Instance struct { - // The ID of the Capacity Reservation. - CapacityReservationId *string + // The AMI launch index, which can be used to find this instance in the launch + // group. + AmiLaunchIndex *int32 - // The IAM instance profile associated with the instance, if applicable. - IamInstanceProfile *IamInstanceProfile + // The architecture of the image. + Architecture ArchitectureValues - // The current state of the instance. - State *InstanceState + // Any block device mapping entries for the instance. + BlockDeviceMappings []*InstanceBlockDeviceMapping - // The security groups for the instance. - SecurityGroups []*GroupIdentifier + // The ID of the Capacity Reservation. + CapacityReservationId *string + + // Information about the Capacity Reservation targeting option. + CapacityReservationSpecification *CapacityReservationSpecificationResponse // The idempotency token you provided when you launched the instance, if // applicable. ClientToken *string - // If the request is a Spot Instance request, the ID of the request. - SpotInstanceRequestId *string - - // The license configurations. - Licenses []*LicenseConfiguration - - // Any tags assigned to the instance. - Tags []*Tag - - // (IPv4 only) The public DNS name assigned to the instance. This name is not - // available until the instance enters the running state. For EC2-VPC, this name is - // only available if you've enabled DNS hostnames for your VPC. - PublicDnsName *string - - // The product codes attached to this instance, if applicable. - ProductCodes []*ProductCode - - // The ID of the instance. - InstanceId *string - - // The reason for the most recent state transition. - StateReason *StateReason - - // The reason for the most recent state transition. This might be an empty string. - StateTransitionReason *string - - // The metadata options for the instance. - MetadataOptions *InstanceMetadataOptionsResponse - - // Specifies whether enhanced networking with ENA is enabled. - EnaSupport *bool - - // [EC2-VPC] The ID of the VPC in which the instance is running. - VpcId *string - - // Any block device mapping entries for the instance. - BlockDeviceMappings []*InstanceBlockDeviceMapping + // The CPU options for the instance. + CpuOptions *CpuOptions // Indicates whether the instance is optimized for Amazon EBS I/O. This // optimization provides dedicated throughput to Amazon EBS and an optimized @@ -3344,67 +3313,64 @@ type Instance struct { // The Elastic GPU associated with the instance. ElasticGpuAssociations []*ElasticGpuAssociation - // The RAM disk associated with this instance, if applicable. - RamdiskId *string + // The elastic inference accelerator associated with the instance. + ElasticInferenceAcceleratorAssociations []*ElasticInferenceAcceleratorAssociation - // Specifies whether enhanced networking with the Intel 82599 Virtual Function - // interface is enabled. - SriovNetSupport *string + // Specifies whether enhanced networking with ENA is enabled. + EnaSupport *bool - // [EC2-VPC] The network interfaces for the instance. - NetworkInterfaces []*InstanceNetworkInterface + // Indicates whether the instance is enabled for hibernation. + HibernationOptions *HibernationOptions - // The name of the key pair, if this instance was launched with an associated key - // pair. - KeyName *string + // The hypervisor type of the instance. The value xen is used for both Xen and + // Nitro hypervisors. + Hypervisor HypervisorType + + // The IAM instance profile associated with the instance, if applicable. + IamInstanceProfile *IamInstanceProfile // The ID of the AMI used to launch the instance. ImageId *string - // Specifies whether to enable an instance launched in a VPC to perform NAT. This - // controls whether source/destination checking is enabled on the instance. A value - // of true means that checking is enabled, and false means that checking is - // disabled. The value must be false for the instance to perform NAT. For more - // information, see NAT Instances - // (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html) - // in the Amazon Virtual Private Cloud User Guide. - SourceDestCheck *bool + // The ID of the instance. + InstanceId *string - // The private IPv4 address assigned to the instance. - PrivateIpAddress *string + // Indicates whether this is a Spot Instance or a Scheduled Instance. + InstanceLifecycle InstanceLifecycleType - // The AMI launch index, which can be used to find this instance in the launch - // group. - AmiLaunchIndex *int32 + // The instance type. + InstanceType InstanceType - // The root device type used by the AMI. The AMI can use an EBS volume or an - // instance store volume. - RootDeviceType DeviceType + // The kernel associated with this instance, if applicable. + KernelId *string - // The elastic inference accelerator associated with the instance. - ElasticInferenceAcceleratorAssociations []*ElasticInferenceAcceleratorAssociation + // The name of the key pair, if this instance was launched with an associated key + // pair. + KeyName *string - // [EC2-VPC] The ID of the subnet in which the instance is running. - SubnetId *string + // The time the instance was launched. + LaunchTime *time.Time - // Indicates whether the instance is enabled for hibernation. - HibernationOptions *HibernationOptions + // The license configurations. + Licenses []*LicenseConfiguration - // The kernel associated with this instance, if applicable. - KernelId *string + // The metadata options for the instance. + MetadataOptions *InstanceMetadataOptionsResponse - // The value is Windows for Windows instances; otherwise blank. - Platform PlatformValues + // The monitoring for the instance. + Monitoring *Monitoring - // The instance type. - InstanceType InstanceType + // [EC2-VPC] The network interfaces for the instance. + NetworkInterfaces []*InstanceNetworkInterface - // Indicates whether this is a Spot Instance or a Scheduled Instance. - InstanceLifecycle InstanceLifecycleType + // The Amazon Resource Name (ARN) of the Outpost. + OutpostArn *string - // The hypervisor type of the instance. The value xen is used for both Xen and - // Nitro hypervisors. - Hypervisor HypervisorType + // The location where the instance launched, if applicable. + Placement *Placement + + // The value is Windows for Windows instances; otherwise blank. + Platform PlatformValues // (IPv4 only) The private DNS hostname name assigned to the instance. This DNS // hostname can only be used inside the Amazon EC2 network. This name is not @@ -3415,35 +3381,69 @@ type Instance struct { // servers must resolve the hostname as appropriate. PrivateDnsName *string - // The CPU options for the instance. - CpuOptions *CpuOptions - - // The time the instance was launched. - LaunchTime *time.Time - - // Information about the Capacity Reservation targeting option. - CapacityReservationSpecification *CapacityReservationSpecificationResponse - - // The location where the instance launched, if applicable. - Placement *Placement - - // The virtualization type of the instance. - VirtualizationType VirtualizationType + // The private IPv4 address assigned to the instance. + PrivateIpAddress *string - // The Amazon Resource Name (ARN) of the Outpost. - OutpostArn *string + // The product codes attached to this instance, if applicable. + ProductCodes []*ProductCode - // The monitoring for the instance. - Monitoring *Monitoring + // (IPv4 only) The public DNS name assigned to the instance. This name is not + // available until the instance enters the running state. For EC2-VPC, this name is + // only available if you've enabled DNS hostnames for your VPC. + PublicDnsName *string // The public IPv4 address assigned to the instance, if applicable. PublicIpAddress *string - // The architecture of the image. - Architecture ArchitectureValues + // The RAM disk associated with this instance, if applicable. + RamdiskId *string // The device name of the root device volume (for example, /dev/sda1). RootDeviceName *string + + // The root device type used by the AMI. The AMI can use an EBS volume or an + // instance store volume. + RootDeviceType DeviceType + + // The security groups for the instance. + SecurityGroups []*GroupIdentifier + + // Specifies whether to enable an instance launched in a VPC to perform NAT. This + // controls whether source/destination checking is enabled on the instance. A value + // of true means that checking is enabled, and false means that checking is + // disabled. The value must be false for the instance to perform NAT. For more + // information, see NAT Instances + // (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html) + // in the Amazon Virtual Private Cloud User Guide. + SourceDestCheck *bool + + // If the request is a Spot Instance request, the ID of the request. + SpotInstanceRequestId *string + + // Specifies whether enhanced networking with the Intel 82599 Virtual Function + // interface is enabled. + SriovNetSupport *string + + // The current state of the instance. + State *InstanceState + + // The reason for the most recent state transition. + StateReason *StateReason + + // The reason for the most recent state transition. This might be an empty string. + StateTransitionReason *string + + // [EC2-VPC] The ID of the subnet in which the instance is running. + SubnetId *string + + // Any tags assigned to the instance. + Tags []*Tag + + // The virtualization type of the instance. + VirtualizationType VirtualizationType + + // [EC2-VPC] The ID of the VPC in which the instance is running. + VpcId *string } // Describes a block device mapping. @@ -3460,8 +3460,8 @@ type InstanceBlockDeviceMapping struct { // Describes a block device mapping entry. type InstanceBlockDeviceMappingSpecification struct { - // The virtual device name. - VirtualName *string + // The device name (for example, /dev/sdh or xvdh). + DeviceName *string // Parameters used to automatically set up EBS volumes when the instance is // launched. @@ -3470,8 +3470,8 @@ type InstanceBlockDeviceMappingSpecification struct { // suppress the specified device included in the block device mapping. NoDevice *string - // The device name (for example, /dev/sdh or xvdh). - DeviceName *string + // The virtual device name. + VirtualName *string } // Information about the number of instances that can be launched onto the @@ -3482,44 +3482,44 @@ type InstanceCapacity struct { // the host's available capacity. AvailableCapacity *int32 + // The instance type supported by the Dedicated Host. + InstanceType *string + // The total number of instances that can be launched onto the Dedicated Host if // there are no instances running on it. TotalCapacity *int32 - - // The instance type supported by the Dedicated Host. - InstanceType *string } // Describes a Reserved Instance listing state. type InstanceCount struct { - // The states of the listed Reserved Instances. - State ListingState - // The number of listed Reserved Instances in the state specified by the state. InstanceCount *int32 + + // The states of the listed Reserved Instances. + State ListingState } // Describes the credit option for CPU usage of a burstable performance instance. type InstanceCreditSpecification struct { - // The ID of the instance. - InstanceId *string - // The credit option for CPU usage of the instance. Valid values are standard and // unlimited. CpuCredits *string + + // The ID of the instance. + InstanceId *string } // Describes the credit option for CPU usage of a burstable performance instance. type InstanceCreditSpecificationRequest struct { - // The ID of the instance. - InstanceId *string - // The credit option for CPU usage of the instance. Valid values are standard and // unlimited. CpuCredits *string + + // The ID of the instance. + InstanceId *string } // Describes an instance to export. @@ -3536,12 +3536,12 @@ type InstanceExportDetails struct { // instance family. type InstanceFamilyCreditSpecification struct { - // The instance family. - InstanceFamily UnlimitedSupportedInstanceFamily - // The default credit option for CPU usage of the instance family. Valid values are // standard and unlimited. CpuCredits *string + + // The instance family. + InstanceFamily UnlimitedSupportedInstanceFamily } // Describes an IPv6 address. @@ -3561,11 +3561,11 @@ type InstanceIpv6AddressRequest struct { // Describes the market (purchasing) option for the instances. type InstanceMarketOptionsRequest struct { - // The options for Spot Instances. - SpotOptions *SpotMarketOptions - // The market type. MarketType MarketType + + // The options for Spot Instances. + SpotOptions *SpotMarketOptions } // The metadata options for the instance. @@ -3576,6 +3576,11 @@ type InstanceMetadataOptionsRequest struct { // a value of disabled, you will not be able to access your instance metadata. HttpEndpoint InstanceMetadataEndpointState + // The desired HTTP PUT response hop limit for instance metadata requests. The + // larger the number, the further instance metadata requests can travel. Default: 1 + // Possible values: Integers from 1 to 64 + HttpPutResponseHopLimit *int32 + // The state of token usage for your instance metadata requests. If the parameter // is not specified in the request, the default state is optional. If the state is // optional, you can choose to retrieve instance metadata with or without a signed @@ -3587,27 +3592,21 @@ type InstanceMetadataOptionsRequest struct { // credentials always returns the version 2.0 credentials; the version 1.0 // credentials are not available. HttpTokens HttpTokensState - - // The desired HTTP PUT response hop limit for instance metadata requests. The - // larger the number, the further instance metadata requests can travel. Default: 1 - // Possible values: Integers from 1 to 64 - HttpPutResponseHopLimit *int32 } // The metadata options for the instance. type InstanceMetadataOptionsResponse struct { + // This parameter enables or disables the HTTP metadata endpoint on your instances. + // If the parameter is not specified, the default state is enabled. If you specify + // a value of disabled, you will not be able to access your instance metadata. + HttpEndpoint InstanceMetadataEndpointState + // The desired HTTP PUT response hop limit for instance metadata requests. The // larger the number, the further instance metadata requests can travel. Default: 1 // Possible values: Integers from 1 to 64 HttpPutResponseHopLimit *int32 - // The state of the metadata option changes. pending - The metadata options are - // being updated and the instance is not ready to process metadata traffic with the - // new selection. applied - The metadata options have been successfully applied on - // the instance. - State InstanceMetadataOptionsState - // The state of token usage for your instance metadata requests. If the parameter // is not specified in the request, the default state is optional. If the state is // optional, you can choose to retrieve instance metadata with or without a signed @@ -3620,20 +3619,21 @@ type InstanceMetadataOptionsResponse struct { // credentials are not available. HttpTokens HttpTokensState - // This parameter enables or disables the HTTP metadata endpoint on your instances. - // If the parameter is not specified, the default state is enabled. If you specify - // a value of disabled, you will not be able to access your instance metadata. - HttpEndpoint InstanceMetadataEndpointState + // The state of the metadata option changes. pending - The metadata options are + // being updated and the instance is not ready to process metadata traffic with the + // new selection. applied - The metadata options have been successfully applied on + // the instance. + State InstanceMetadataOptionsState } // Describes the monitoring of an instance. type InstanceMonitoring struct { - // The monitoring for the instance. - Monitoring *Monitoring - // The ID of the instance. InstanceId *string + + // The monitoring for the instance. + Monitoring *Monitoring } // Describes a network interface. @@ -3643,74 +3643,74 @@ type InstanceNetworkInterface struct { // interface. Association *InstanceNetworkInterfaceAssociation - // One or more private IPv4 addresses associated with the network interface. - PrivateIpAddresses []*InstancePrivateIpAddress + // The network interface attachment. + Attachment *InstanceNetworkInterfaceAttachment - // The ID of the network interface. - NetworkInterfaceId *string + // The description. + Description *string - // The ID of the subnet. - SubnetId *string + // One or more security groups. + Groups []*GroupIdentifier - // The status of the network interface. - Status NetworkInterfaceStatus + // Describes the type of network interface. Valid values: interface | efa + InterfaceType *string - // The network interface attachment. - Attachment *InstanceNetworkInterfaceAttachment + // One or more IPv6 addresses associated with the network interface. + Ipv6Addresses []*InstanceIpv6Address + + // The MAC address. + MacAddress *string + + // The ID of the network interface. + NetworkInterfaceId *string // The ID of the AWS account that created the network interface. OwnerId *string - // One or more IPv6 addresses associated with the network interface. - Ipv6Addresses []*InstanceIpv6Address + // The private DNS name. + PrivateDnsName *string // The IPv4 address of the network interface within the subnet. PrivateIpAddress *string - // The private DNS name. - PrivateDnsName *string - - // The MAC address. - MacAddress *string + // One or more private IPv4 addresses associated with the network interface. + PrivateIpAddresses []*InstancePrivateIpAddress // Indicates whether to validate network traffic to or from this network interface. SourceDestCheck *bool - // One or more security groups. - Groups []*GroupIdentifier + // The status of the network interface. + Status NetworkInterfaceStatus - // The description. - Description *string + // The ID of the subnet. + SubnetId *string // The ID of the VPC. VpcId *string - - // Describes the type of network interface. Valid values: interface | efa - InterfaceType *string } // Describes association information for an Elastic IP address (IPv4). type InstanceNetworkInterfaceAssociation struct { - // The public IP address or Elastic IP address bound to the network interface. - PublicIp *string + // The ID of the owner of the Elastic IP address. + IpOwnerId *string // The public DNS name. PublicDnsName *string - // The ID of the owner of the Elastic IP address. - IpOwnerId *string + // The public IP address or Elastic IP address bound to the network interface. + PublicIp *string } // Describes a network interface attachment. type InstanceNetworkInterfaceAttachment struct { + // The time stamp when the attachment initiated. + AttachTime *time.Time + // The ID of the network interface attachment. AttachmentId *string - // The attachment state. - Status AttachmentStatus - // Indicates whether the network interface is deleted when the instance is // terminated. DeleteOnTermination *bool @@ -3718,55 +3718,69 @@ type InstanceNetworkInterfaceAttachment struct { // The index of the device on the instance for the network interface attachment. DeviceIndex *int32 - // The time stamp when the attachment initiated. - AttachTime *time.Time + // The attachment state. + Status AttachmentStatus } // Describes a network interface. type InstanceNetworkInterfaceSpecification struct { + // Indicates whether to assign a public IPv4 address to an instance you launch in a + // VPC. The public IP address can only be assigned to a network interface for eth0, + // and can only be assigned to a new network interface, not an existing one. You + // cannot specify more than one network interface in the request. If launching into + // a default subnet, the default value is true. + AssociatePublicIpAddress *bool + // If set to true, the interface is deleted when the instance is terminated. You // can specify true only if creating a new network interface when launching an // instance. DeleteOnTermination *bool - // The private IPv4 address of the network interface. Applies only if creating a - // network interface when launching an instance. You cannot specify this option if - // you're launching more than one instance in a RunInstances - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) - // request. - PrivateIpAddress *string + // The description of the network interface. Applies only if creating a network + // interface when launching an instance. + Description *string // The position of the network interface in the attachment order. A primary network // interface has a device index of 0. If you specify a network interface when // launching an instance, you must specify the device index. DeviceIndex *int32 + // The IDs of the security groups for the network interface. Applies only if + // creating a network interface when launching an instance. + Groups []*string + + // The type of network interface. To create an Elastic Fabric Adapter (EFA), + // specify efa. For more information, see Elastic Fabric Adapter + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the Amazon + // Elastic Compute Cloud User Guide. If you are not creating an EFA, specify + // interface or omit this parameter. Valid values: interface | efa + InterfaceType *string + + // A number of IPv6 addresses to assign to the network interface. Amazon EC2 + // chooses the IPv6 addresses from the range of the subnet. You cannot specify this + // option and the option to assign specific IPv6 addresses in the same request. You + // can specify this option if you've specified a minimum number of instances to + // launch. + Ipv6AddressCount *int32 + // One or more IPv6 addresses to assign to the network interface. You cannot // specify this option and the option to assign a number of IPv6 addresses in the // same request. You cannot specify this option if you've specified a minimum // number of instances to launch. Ipv6Addresses []*InstanceIpv6Address - // The number of secondary private IPv4 addresses. You can't specify this option - // and specify more than one private IP address using the private IP addresses - // option. You cannot specify this option if you're launching more than one - // instance in a RunInstances - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) - // request. - SecondaryPrivateIpAddressCount *int32 - // The ID of the network interface. If you are creating a Spot Fleet, omit this // parameter because you can’t specify a network interface ID in a launch // specification. NetworkInterfaceId *string - // The type of network interface. To create an Elastic Fabric Adapter (EFA), - // specify efa. For more information, see Elastic Fabric Adapter - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the Amazon - // Elastic Compute Cloud User Guide. If you are not creating an EFA, specify - // interface or omit this parameter. Valid values: interface | efa - InterfaceType *string + // The private IPv4 address of the network interface. Applies only if creating a + // network interface when launching an instance. You cannot specify this option if + // you're launching more than one instance in a RunInstances + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) + // request. + PrivateIpAddress *string // One or more private IPv4 addresses to assign to the network interface. Only one // private IPv4 address can be designated as primary. You cannot specify this @@ -3775,38 +3789,24 @@ type InstanceNetworkInterfaceSpecification struct { // request. PrivateIpAddresses []*PrivateIpAddressSpecification + // The number of secondary private IPv4 addresses. You can't specify this option + // and specify more than one private IP address using the private IP addresses + // option. You cannot specify this option if you're launching more than one + // instance in a RunInstances + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) + // request. + SecondaryPrivateIpAddressCount *int32 + // The ID of the subnet associated with the network interface. Applies only if // creating a network interface when launching an instance. SubnetId *string - - // The description of the network interface. Applies only if creating a network - // interface when launching an instance. - Description *string - - // The IDs of the security groups for the network interface. Applies only if - // creating a network interface when launching an instance. - Groups []*string - - // A number of IPv6 addresses to assign to the network interface. Amazon EC2 - // chooses the IPv6 addresses from the range of the subnet. You cannot specify this - // option and the option to assign specific IPv6 addresses in the same request. You - // can specify this option if you've specified a minimum number of instances to - // launch. - Ipv6AddressCount *int32 - - // Indicates whether to assign a public IPv4 address to an instance you launch in a - // VPC. The public IP address can only be assigned to a network interface for eth0, - // and can only be assigned to a new network interface, not an existing one. You - // cannot specify more than one network interface in the request. If launching into - // a default subnet, the default value is true. - AssociatePublicIpAddress *bool } // Describes a private IPv4 address. type InstancePrivateIpAddress struct { - // The private IPv4 address of the network interface. - PrivateIpAddress *string + // The association information for an Elastic IP address for the network interface. + Association *InstanceNetworkInterfaceAssociation // Indicates whether this IPv4 address is the primary private IP address of the // network interface. @@ -3815,26 +3815,23 @@ type InstancePrivateIpAddress struct { // The private IPv4 DNS name. PrivateDnsName *string - // The association information for an Elastic IP address for the network interface. - Association *InstanceNetworkInterfaceAssociation + // The private IPv4 address of the network interface. + PrivateIpAddress *string } // The instance details to specify which volumes should be snapshotted. type InstanceSpecification struct { - // The instance to specify which volumes should be snapshotted. - InstanceId *string - // Excludes the root volume from being snapshotted. ExcludeBootVolume *bool + + // The instance to specify which volumes should be snapshotted. + InstanceId *string } // Describes the current state of an instance. type InstanceState struct { - // The current state of the instance. - Name InstanceStateName - // The state of the instance as a 16-bit unsigned integer. The high byte is all of // the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and // 65,535. These numerical values are used for internal purposes and should be @@ -3859,35 +3856,32 @@ type InstanceState struct { // You can ignore the high byte value by zeroing out all of the // bits above 2^8 or 256 in decimal. Code *int32 + + // The current state of the instance. + Name InstanceStateName } // Describes an instance state change. type InstanceStateChange struct { - // The previous state of the instance. - PreviousState *InstanceState - // The current state of the instance. CurrentState *InstanceState // The ID of the instance. InstanceId *string + + // The previous state of the instance. + PreviousState *InstanceState } // Describes the status of an instance. type InstanceStatus struct { - // Reports impaired functionality that stems from issues related to the systems - // that support an instance, such as hardware failures and network connectivity - // problems. - SystemStatus *InstanceStatusSummary - // The Availability Zone of the instance. AvailabilityZone *string - // Reports impaired functionality that stems from issues internal to the instance, - // such as impaired reachability. - InstanceStatus *InstanceStatusSummary + // Any scheduled events associated with the instance. + Events []*InstanceStatusEvent // The ID of the instance. InstanceId *string @@ -3896,11 +3890,17 @@ type InstanceStatus struct { // instance be in the running state. InstanceState *InstanceState + // Reports impaired functionality that stems from issues internal to the instance, + // such as impaired reachability. + InstanceStatus *InstanceStatusSummary + // The Amazon Resource Name (ARN) of the Outpost. OutpostArn *string - // Any scheduled events associated with the instance. - Events []*InstanceStatusEvent + // Reports impaired functionality that stems from issues related to the systems + // that support an instance, such as hardware failures and network connectivity + // problems. + SystemStatus *InstanceStatusSummary } // Describes the instance status. @@ -3923,22 +3923,22 @@ type InstanceStatusEvent struct { // The event code. Code EventCode - // The deadline for starting the event. - NotBeforeDeadline *time.Time - - // The latest scheduled end time for the event. - NotAfter *time.Time - // A description of the event. After a scheduled event is completed, it can still // be described for up to a week. If the event has been completed, this description // starts with the following text: [Completed]. Description *string + // The ID of the event. + InstanceEventId *string + + // The latest scheduled end time for the event. + NotAfter *time.Time + // The earliest scheduled start time for the event. NotBefore *time.Time - // The ID of the event. - InstanceEventId *string + // The deadline for starting the event. + NotBeforeDeadline *time.Time } // Describes the status of an instance. @@ -3964,88 +3964,88 @@ type InstanceStorageInfo struct { // Describes the registered tag keys for the current Region. type InstanceTagNotificationAttribute struct { - // The registered tag keys. - InstanceTagKeys []*string - // Indicates wheter all tag keys in the current Region are registered to appear in // scheduled event notifications. true indicates that all tag keys in the current // Region are registered. IncludeAllTagsOfInstance *bool + + // The registered tag keys. + InstanceTagKeys []*string } // Describes the instance type. type InstanceTypeInfo struct { - // Indicates the hypervisor used for the instance type. - Hypervisor InstanceTypeHypervisor + // Indicates whether auto recovery is supported. + AutoRecoverySupported *bool - // Describes the Inference accelerator settings for the instance type. - InferenceAcceleratorInfo *InferenceAcceleratorInfo + // Indicates whether the instance is bare metal. + BareMetal *bool - // Describes the placement group settings for the instance type. - PlacementGroupInfo *PlacementGroupInfo + // Indicates whether the instance type is a burstable performance instance type. + BurstablePerformanceSupported *bool - // Describes the network settings for the instance type. - NetworkInfo *NetworkInfo + // Indicates whether the instance type is a current generation. + CurrentGeneration *bool + + // Indicates whether Dedicated Hosts are supported on the instance type. + DedicatedHostsSupported *bool // Describes the Amazon EBS settings for the instance type. EbsInfo *EbsInfo - // Indicates whether On-Demand hibernation is supported. - HibernationSupported *bool - - // Indicates whether the instance type is a current generation. - CurrentGeneration *bool - - // Describes the disks for the instance type. - InstanceStorageInfo *InstanceStorageInfo + // Describes the FPGA accelerator settings for the instance type. + FpgaInfo *FpgaInfo // Indicates whether the instance type is eligible for the free tier. FreeTierEligible *bool - // Indicates whether auto recovery is supported. - AutoRecoverySupported *bool + // Describes the GPU accelerator settings for the instance type. + GpuInfo *GpuInfo - // Indicates whether the instance is bare metal. - BareMetal *bool + // Indicates whether On-Demand hibernation is supported. + HibernationSupported *bool - // Describes the FPGA accelerator settings for the instance type. - FpgaInfo *FpgaInfo + // Indicates the hypervisor used for the instance type. + Hypervisor InstanceTypeHypervisor - // Describes the GPU accelerator settings for the instance type. - GpuInfo *GpuInfo + // Describes the Inference accelerator settings for the instance type. + InferenceAcceleratorInfo *InferenceAcceleratorInfo - // Describes the vCPU configurations for the instance type. - VCpuInfo *VCpuInfo + // Describes the disks for the instance type. + InstanceStorageInfo *InstanceStorageInfo - // Indicates the supported root device types. - SupportedRootDeviceTypes []RootDeviceType + // Indicates whether instance storage is supported. + InstanceStorageSupported *bool // The instance type. For more information, see Instance Types // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the // Amazon Elastic Compute Cloud User Guide. InstanceType InstanceType - // The supported virtualization types. - SupportedVirtualizationTypes []VirtualizationType - // Describes the memory for the instance type. MemoryInfo *MemoryInfo - // Indicates whether the instance type is offered for spot or On-Demand. - SupportedUsageClasses []UsageClassType + // Describes the network settings for the instance type. + NetworkInfo *NetworkInfo - // Indicates whether Dedicated Hosts are supported on the instance type. - DedicatedHostsSupported *bool + // Describes the placement group settings for the instance type. + PlacementGroupInfo *PlacementGroupInfo // Describes the processor. ProcessorInfo *ProcessorInfo - // Indicates whether the instance type is a burstable performance instance type. - BurstablePerformanceSupported *bool + // Indicates the supported root device types. + SupportedRootDeviceTypes []RootDeviceType - // Indicates whether instance storage is supported. - InstanceStorageSupported *bool + // Indicates whether the instance type is offered for spot or On-Demand. + SupportedUsageClasses []UsageClassType + + // The supported virtualization types. + SupportedVirtualizationTypes []VirtualizationType + + // Describes the vCPU configurations for the instance type. + VCpuInfo *VCpuInfo } // The instance types offered. @@ -4056,68 +4056,57 @@ type InstanceTypeOffering struct { // Amazon Elastic Compute Cloud User Guide. InstanceType InstanceType - // The location type. - LocationType LocationType - // The identifier for the location. This depends on the location type. For example, // if the location type is region, the location is the Region code (for example, // us-east-2.) Location *string + + // The location type. + LocationType LocationType } // Information about the Capacity Reservation usage. type InstanceUsage struct { + // The ID of the AWS account that is making use of the Capacity Reservation. + AccountId *string + // The number of instances the AWS account currently has in the Capacity // Reservation. UsedInstanceCount *int32 - - // The ID of the AWS account that is making use of the Capacity Reservation. - AccountId *string } // Describes an internet gateway. type InternetGateway struct { + // Any VPCs attached to the internet gateway. + Attachments []*InternetGatewayAttachment + // The ID of the internet gateway. InternetGatewayId *string - // Any tags assigned to the internet gateway. - Tags []*Tag - // The ID of the AWS account that owns the internet gateway. OwnerId *string - // Any VPCs attached to the internet gateway. - Attachments []*InternetGatewayAttachment + // Any tags assigned to the internet gateway. + Tags []*Tag } // Describes the attachment of a VPC to an internet gateway or an egress-only // internet gateway. type InternetGatewayAttachment struct { - // The ID of the VPC. - VpcId *string - // The current state of the attachment. For an internet gateway, the state is // available when attached to a VPC; otherwise, this value is not returned. State AttachmentStatus + + // The ID of the VPC. + VpcId *string } // Describes a set of permissions for a security group rule. type IpPermission struct { - // The IPv4 ranges. - IpRanges []*IpRange - - // [VPC only] The IPv6 ranges. - Ipv6Ranges []*Ipv6Range - - // The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A - // value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 - // types, you must specify all codes. - ToPort *int32 - // The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type // number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all // ICMP/ICMPv6 types, you must specify all codes. @@ -4132,9 +4121,20 @@ type IpPermission struct { // if you omit the port range, traffic for all types and codes is allowed. IpProtocol *string + // The IPv4 ranges. + IpRanges []*IpRange + + // [VPC only] The IPv6 ranges. + Ipv6Ranges []*Ipv6Range + // [VPC only] The prefix list IDs. PrefixListIds []*PrefixListId + // The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A + // value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 + // types, you must specify all codes. + ToPort *int32 + // The security group and AWS account ID pairs. UserIdGroupPairs []*UserIdGroupPair } @@ -4172,17 +4172,17 @@ type Ipv6CidrBlock struct { // Describes an IPv6 address pool. type Ipv6Pool struct { - // Any tags for the address pool. - Tags []*Tag - - // The ID of the address pool. - PoolId *string - // The description for the address pool. Description *string // The CIDR blocks for the address pool. PoolCidrBlocks []*PoolCidrBlock + + // The ID of the address pool. + PoolId *string + + // Any tags for the address pool. + Tags []*Tag } // [EC2-VPC only] Describes an IPv6 range. @@ -4201,20 +4201,20 @@ type Ipv6Range struct { // Describes a key pair. type KeyPairInfo struct { - // Any tags applied to the key pair. - Tags []*Tag - // If you used CreateKeyPair () to create the key pair, this is the SHA-1 digest of // the DER encoded private key. If you used ImportKeyPair () to provide AWS the // public key, this is the MD5 public key fingerprint as specified in section 4 of // RFC4716. KeyFingerprint *string + // The name of the key pair. + KeyName *string + // The ID of the key pair. KeyPairId *string - // The name of the key pair. - KeyName *string + // Any tags applied to the key pair. + Tags []*Tag } // The last error that occurred for a VPC endpoint. @@ -4230,48 +4230,31 @@ type LastError struct { // Describes a launch permission. type LaunchPermission struct { - // The AWS account ID. - UserId *string - // The name of the group. Group PermissionGroup + + // The AWS account ID. + UserId *string } // Describes a launch permission modification. type LaunchPermissionModifications struct { - // The AWS account ID to remove from the list of launch permissions for the AMI. - Remove []*LaunchPermission - // The AWS account ID to add to the list of launch permissions for the AMI. Add []*LaunchPermission + + // The AWS account ID to remove from the list of launch permissions for the AMI. + Remove []*LaunchPermission } // Describes the launch specification for an instance. type LaunchSpecification struct { - // One or more block device mapping entries. - BlockDeviceMappings []*BlockDeviceMapping - - // The ID of the subnet in which to launch the instance. - SubnetId *string - - // The ID of the kernel. - KernelId *string - - // The Base64-encoded user data for the instance. - UserData *string - // Deprecated. AddressingType *string - // One or more security groups. When requesting instances in a VPC, you must - // specify the IDs of the security groups. When requesting instances in - // EC2-Classic, you can specify the names or the IDs of the security groups. - SecurityGroups []*GroupIdentifier - - // The ID of the AMI. - ImageId *string + // One or more block device mapping entries. + BlockDeviceMappings []*BlockDeviceMapping // Indicates whether the instance is optimized for EBS I/O. This optimization // provides dedicated throughput to Amazon EBS and an optimized configuration stack @@ -4280,41 +4263,61 @@ type LaunchSpecification struct { // instance. Default: false EbsOptimized *bool - // The ID of the RAM disk. - RamdiskId *string + // The IAM instance profile. + IamInstanceProfile *IamInstanceProfileSpecification + + // The ID of the AMI. + ImageId *string // The instance type. InstanceType InstanceType - // The placement information for the instance. - Placement *SpotPlacement + // The ID of the kernel. + KernelId *string // The name of the key pair. KeyName *string + // Describes the monitoring of an instance. + Monitoring *RunInstancesMonitoringEnabled + // One or more network interfaces. If you specify a network interface, you must // specify subnet IDs and security group IDs using the network interface. NetworkInterfaces []*InstanceNetworkInterfaceSpecification - // The IAM instance profile. - IamInstanceProfile *IamInstanceProfileSpecification + // The placement information for the instance. + Placement *SpotPlacement - // Describes the monitoring of an instance. - Monitoring *RunInstancesMonitoringEnabled + // The ID of the RAM disk. + RamdiskId *string + + // One or more security groups. When requesting instances in a VPC, you must + // specify the IDs of the security groups. When requesting instances in + // EC2-Classic, you can specify the names or the IDs of the security groups. + SecurityGroups []*GroupIdentifier + + // The ID of the subnet in which to launch the instance. + SubnetId *string + + // The Base64-encoded user data for the instance. + UserData *string } // Describes a launch template. type LaunchTemplate struct { + // The time launch template was created. + CreateTime *time.Time + + // The principal that created the launch template. + CreatedBy *string + // The version number of the default version of the launch template. DefaultVersionNumber *int64 // The version number of the latest version of the launch template. LatestVersionNumber *int64 - // The time launch template was created. - CreateTime *time.Time - // The ID of the launch template. LaunchTemplateId *string @@ -4323,9 +4326,6 @@ type LaunchTemplate struct { // The tags for the launch template. Tags []*Tag - - // The principal that created the launch template. - CreatedBy *string } // Describes a launch template and overrides. @@ -4342,17 +4342,17 @@ type LaunchTemplateAndOverridesResponse struct { // Describes a block device mapping. type LaunchTemplateBlockDeviceMapping struct { - // Information about the block device for an EBS volume. - Ebs *LaunchTemplateEbsBlockDevice - - // The virtual device name (ephemeralN). - VirtualName *string - // The device name. DeviceName *string + // Information about the block device for an EBS volume. + Ebs *LaunchTemplateEbsBlockDevice + // Suppresses the specified device included in the block device mapping of the AMI. NoDevice *string + + // The virtual device name (ephemeralN). + VirtualName *string } // Describes a block device mapping. @@ -4384,9 +4384,6 @@ type LaunchTemplateBlockDeviceMappingRequest struct { // target a specific Capacity Reservation or a Capacity Reservation group. type LaunchTemplateCapacityReservationSpecificationRequest struct { - // Information about the target Capacity Reservation or Capacity Reservation group. - CapacityReservationTarget *CapacityReservationTarget - // Indicates the instance's Capacity Reservation preferences. Possible preferences // include: // @@ -4397,14 +4394,14 @@ type LaunchTemplateCapacityReservationSpecificationRequest struct { // * none - The instance avoids running in a Capacity Reservation even if one is // available. The instance runs in On-Demand capacity. CapacityReservationPreference CapacityReservationPreference + + // Information about the target Capacity Reservation or Capacity Reservation group. + CapacityReservationTarget *CapacityReservationTarget } // Information about the Capacity Reservation targeting option. type LaunchTemplateCapacityReservationSpecificationResponse struct { - // Information about the target Capacity Reservation or Capacity Reservation group. - CapacityReservationTarget *CapacityReservationTargetResponse - // Indicates the instance's Capacity Reservation preferences. Possible preferences // include: // @@ -4415,6 +4412,9 @@ type LaunchTemplateCapacityReservationSpecificationResponse struct { // * none - The instance avoids running in a Capacity Reservation even if one is // available. The instance runs in On-Demand capacity. CapacityReservationPreference CapacityReservationPreference + + // Information about the target Capacity Reservation or Capacity Reservation group. + CapacityReservationTarget *CapacityReservationTargetResponse } // Describes a launch template and overrides. @@ -4453,8 +4453,8 @@ type LaunchTemplateCpuOptionsRequest struct { // Describes a block device for an EBS volume. type LaunchTemplateEbsBlockDevice struct { - // The volume type. - VolumeType VolumeType + // Indicates whether the EBS volume is deleted on instance termination. + DeleteOnTermination *bool // Indicates whether the EBS volume is encrypted. Encrypted *bool @@ -4462,44 +4462,30 @@ type LaunchTemplateEbsBlockDevice struct { // The number of I/O operations per second (IOPS) that the volume supports. Iops *int32 - // Indicates whether the EBS volume is deleted on instance termination. - DeleteOnTermination *bool - // The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption. KmsKeyId *string + // The ID of the snapshot. + SnapshotId *string + // The size of the volume, in GiB. VolumeSize *int32 - // The ID of the snapshot. - SnapshotId *string + // The volume type. + VolumeType VolumeType } // The parameters for a block device for an EBS volume. type LaunchTemplateEbsBlockDeviceRequest struct { - // The ARN of the symmetric AWS Key Management Service (AWS KMS) CMK used for - // encryption. - KmsKeyId *string - - // The size of the volume, in GiB. Default: If you're creating the volume from a - // snapshot and don't specify a volume size, the default is the snapshot size. - VolumeSize *int32 + // Indicates whether the EBS volume is deleted on instance termination. + DeleteOnTermination *bool // Indicates whether the EBS volume is encrypted. Encrypted volumes can only be // attached to instances that support Amazon EBS encryption. If you are creating a // volume from a snapshot, you can't specify an encryption value. Encrypted *bool - // Indicates whether the EBS volume is deleted on instance termination. - DeleteOnTermination *bool - - // The ID of the snapshot. - SnapshotId *string - - // The volume type. - VolumeType VolumeType - // The number of I/O operations per second (IOPS) that the volume supports. For // io1, this represents the number of IOPS that are provisioned for the volume. For // gp2, this represents the baseline performance of the volume and the rate at @@ -4511,6 +4497,20 @@ type LaunchTemplateEbsBlockDeviceRequest struct { // for requests to create io1 volumes; it is not used in requests to create gp2, // st1, sc1, or standard volumes. Iops *int32 + + // The ARN of the symmetric AWS Key Management Service (AWS KMS) CMK used for + // encryption. + KmsKeyId *string + + // The ID of the snapshot. + SnapshotId *string + + // The size of the volume, in GiB. Default: If you're creating the volume from a + // snapshot and don't specify a volume size, the default is the snapshot size. + VolumeSize *int32 + + // The volume type. + VolumeType VolumeType } // Describes an elastic inference accelerator. @@ -4560,41 +4560,41 @@ type LaunchTemplateHibernationOptionsRequest struct { // Describes an IAM instance profile. type LaunchTemplateIamInstanceProfileSpecification struct { - // The name of the instance profile. - Name *string - // The Amazon Resource Name (ARN) of the instance profile. Arn *string + + // The name of the instance profile. + Name *string } // An IAM instance profile. type LaunchTemplateIamInstanceProfileSpecificationRequest struct { - // The name of the instance profile. - Name *string - // The Amazon Resource Name (ARN) of the instance profile. Arn *string + + // The name of the instance profile. + Name *string } // The market (purchasing) option for the instances. type LaunchTemplateInstanceMarketOptions struct { - // The options for Spot Instances. - SpotOptions *LaunchTemplateSpotMarketOptions - // The market type. MarketType MarketType + + // The options for Spot Instances. + SpotOptions *LaunchTemplateSpotMarketOptions } // The market (purchasing) option for the instances. type LaunchTemplateInstanceMarketOptionsRequest struct { - // The options for Spot Instances. - SpotOptions *LaunchTemplateSpotMarketOptionsRequest - // The market type. MarketType MarketType + + // The options for Spot Instances. + SpotOptions *LaunchTemplateSpotMarketOptionsRequest } // The metadata options for the instance. For more information, see Instance @@ -4603,6 +4603,16 @@ type LaunchTemplateInstanceMarketOptionsRequest struct { // in the Amazon Elastic Compute Cloud User Guide. type LaunchTemplateInstanceMetadataOptions struct { + // This parameter enables or disables the HTTP metadata endpoint on your instances. + // If the parameter is not specified, the default state is enabled. If you specify + // a value of disabled, you will not be able to access your instance metadata. + HttpEndpoint LaunchTemplateInstanceMetadataEndpointState + + // The desired HTTP PUT response hop limit for instance metadata requests. The + // larger the number, the further instance metadata requests can travel. Default: 1 + // Possible values: Integers from 1 to 64 + HttpPutResponseHopLimit *int32 + // The state of token usage for your instance metadata requests. If the parameter // is not specified in the request, the default state is optional. If the state is // optional, you can choose to retrieve instance metadata with or without a signed @@ -4620,17 +4630,7 @@ type LaunchTemplateInstanceMetadataOptions struct { // new selection. applied - The metadata options have been successfully applied on // the instance. State LaunchTemplateInstanceMetadataOptionsState - - // The desired HTTP PUT response hop limit for instance metadata requests. The - // larger the number, the further instance metadata requests can travel. Default: 1 - // Possible values: Integers from 1 to 64 - HttpPutResponseHopLimit *int32 - - // This parameter enables or disables the HTTP metadata endpoint on your instances. - // If the parameter is not specified, the default state is enabled. If you specify - // a value of disabled, you will not be able to access your instance metadata. - HttpEndpoint LaunchTemplateInstanceMetadataEndpointState -} +} // The metadata options for the instance. For more information, see Instance // Metadata and User Data @@ -4668,47 +4668,70 @@ type LaunchTemplateInstanceNetworkInterfaceSpecification struct { // interface. AssociatePublicIpAddress *bool + // Indicates whether the network interface is deleted when the instance is + // terminated. + DeleteOnTermination *bool + // A description for the network interface. Description *string + // The device index for the network interface attachment. + DeviceIndex *int32 + + // The IDs of one or more security groups. + Groups []*string + + // The type of network interface. + InterfaceType *string + // The number of IPv6 addresses for the network interface. Ipv6AddressCount *int32 - // The ID of the subnet for the network interface. - SubnetId *string + // The IPv6 addresses for the network interface. + Ipv6Addresses []*InstanceIpv6Address - // One or more private IPv4 addresses. - PrivateIpAddresses []*PrivateIpAddressSpecification + // The ID of the network interface. + NetworkInterfaceId *string // The primary private IPv4 address of the network interface. PrivateIpAddress *string - // The device index for the network interface attachment. - DeviceIndex *int32 + // One or more private IPv4 addresses. + PrivateIpAddresses []*PrivateIpAddressSpecification - // The ID of the network interface. - NetworkInterfaceId *string + // The number of secondary private IPv4 addresses for the network interface. + SecondaryPrivateIpAddressCount *int32 + + // The ID of the subnet for the network interface. + SubnetId *string +} + +// The parameters for a network interface. +type LaunchTemplateInstanceNetworkInterfaceSpecificationRequest struct { + + // Associates a public IPv4 address with eth0 for a new network interface. + AssociatePublicIpAddress *bool // Indicates whether the network interface is deleted when the instance is // terminated. DeleteOnTermination *bool - // The IPv6 addresses for the network interface. - Ipv6Addresses []*InstanceIpv6Address + // A description for the network interface. + Description *string + + // The device index for the network interface attachment. + DeviceIndex *int32 // The IDs of one or more security groups. Groups []*string - // The type of network interface. + // The type of network interface. To create an Elastic Fabric Adapter (EFA), + // specify efa. For more information, see Elastic Fabric Adapter + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the Amazon + // Elastic Compute Cloud User Guide. If you are not creating an EFA, specify + // interface or omit this parameter. Valid values: interface | efa InterfaceType *string - // The number of secondary private IPv4 addresses for the network interface. - SecondaryPrivateIpAddressCount *int32 -} - -// The parameters for a network interface. -type LaunchTemplateInstanceNetworkInterfaceSpecificationRequest struct { - // The number of IPv6 addresses to assign to a network interface. Amazon EC2 // automatically selects the IPv6 addresses from the subnet range. You can't use // this option if specifying specific IPv6 addresses. @@ -4719,43 +4742,20 @@ type LaunchTemplateInstanceNetworkInterfaceSpecificationRequest struct { // addresses. Ipv6Addresses []*InstanceIpv6AddressRequest - // The ID of the subnet for the network interface. - SubnetId *string - - // Indicates whether the network interface is deleted when the instance is - // terminated. - DeleteOnTermination *bool - // The ID of the network interface. NetworkInterfaceId *string - // Associates a public IPv4 address with eth0 for a new network interface. - AssociatePublicIpAddress *bool - - // The number of secondary private IPv4 addresses to assign to a network interface. - SecondaryPrivateIpAddressCount *int32 + // The primary private IPv4 address of the network interface. + PrivateIpAddress *string // One or more private IPv4 addresses. PrivateIpAddresses []*PrivateIpAddressSpecification - // A description for the network interface. - Description *string - - // The IDs of one or more security groups. - Groups []*string - - // The device index for the network interface attachment. - DeviceIndex *int32 - - // The type of network interface. To create an Elastic Fabric Adapter (EFA), - // specify efa. For more information, see Elastic Fabric Adapter - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the Amazon - // Elastic Compute Cloud User Guide. If you are not creating an EFA, specify - // interface or omit this parameter. Valid values: interface | efa - InterfaceType *string + // The number of secondary private IPv4 addresses to assign to a network interface. + SecondaryPrivateIpAddressCount *int32 - // The primary private IPv4 address of the network interface. - PrivateIpAddress *string + // The ID of the subnet for the network interface. + SubnetId *string } // Describes a license configuration. @@ -4775,6 +4775,12 @@ type LaunchTemplateLicenseConfigurationRequest struct { // Describes overrides for a launch template. type LaunchTemplateOverrides struct { + // The Availability Zone in which to launch the instances. + AvailabilityZone *string + + // The instance type. + InstanceType InstanceType + // The priority for the launch template override. If OnDemandAllocationStrategy is // set to prioritized, Spot Fleet uses priority to determine which launch template // override to use first in fulfilling On-Demand capacity. The highest priority is @@ -4783,30 +4789,21 @@ type LaunchTemplateOverrides struct { // override has the lowest priority. Priority *float64 - // The instance type. - InstanceType InstanceType - // The maximum price per unit hour that you are willing to pay for a Spot Instance. SpotPrice *string - // The number of units provided by the specified instance type. - WeightedCapacity *float64 - // The ID of the subnet in which to launch the instances. SubnetId *string - // The Availability Zone in which to launch the instances. - AvailabilityZone *string + // The number of units provided by the specified instance type. + WeightedCapacity *float64 } // Describes the placement of an instance. type LaunchTemplatePlacement struct { - // The ID of the Dedicated Host for the instance. - HostId *string - - // Reserved for future use. - SpreadDomain *string + // The affinity setting for the instance on the Dedicated Host. + Affinity *string // The Availability Zone of the instance. AvailabilityZone *string @@ -4814,8 +4811,8 @@ type LaunchTemplatePlacement struct { // The name of the placement group for the instance. GroupName *string - // The affinity setting for the instance on the Dedicated Host. - Affinity *string + // The ID of the Dedicated Host for the instance. + HostId *string // The ARN of the host resource group in which to launch the instances. HostResourceGroupArn *string @@ -4824,6 +4821,9 @@ type LaunchTemplatePlacement struct { // placement group strategy is set to partition. PartitionNumber *int32 + // Reserved for future use. + SpreadDomain *string + // The tenancy of the instance (if the instance is running in a VPC). An instance // with a tenancy of dedicated runs on single-tenant hardware. Tenancy Tenancy @@ -4832,32 +4832,32 @@ type LaunchTemplatePlacement struct { // Describes the placement of an instance. type LaunchTemplatePlacementRequest struct { - // The number of the partition the instance should launch in. Valid only if the - // placement group strategy is set to partition. - PartitionNumber *int32 + // The affinity setting for an instance on a Dedicated Host. + Affinity *string - // The tenancy of the instance (if the instance is running in a VPC). An instance - // with a tenancy of dedicated runs on single-tenant hardware. - Tenancy Tenancy + // The Availability Zone for the instance. + AvailabilityZone *string - // Reserved for future use. - SpreadDomain *string + // The name of the placement group for the instance. + GroupName *string + + // The ID of the Dedicated Host for the instance. + HostId *string // The ARN of the host resource group in which to launch the instances. If you // specify a host resource group ARN, omit the Tenancy parameter or set it to host. HostResourceGroupArn *string - // The ID of the Dedicated Host for the instance. - HostId *string - - // The affinity setting for an instance on a Dedicated Host. - Affinity *string + // The number of the partition the instance should launch in. Valid only if the + // placement group strategy is set to partition. + PartitionNumber *int32 - // The Availability Zone for the instance. - AvailabilityZone *string + // Reserved for future use. + SpreadDomain *string - // The name of the placement group for the instance. - GroupName *string + // The tenancy of the instance (if the instance is running in a VPC). An instance + // with a tenancy of dedicated runs on single-tenant hardware. + Tenancy Tenancy } // Describes the monitoring for the instance. @@ -4880,61 +4880,61 @@ type LaunchTemplatesMonitoringRequest struct { // launch template name in the request, but not both. type LaunchTemplateSpecification struct { - // The version number of the launch template. Default: The default version for the - // launch template. - Version *string + // The ID of the launch template. + LaunchTemplateId *string // The name of the launch template. LaunchTemplateName *string - // The ID of the launch template. - LaunchTemplateId *string + // The version number of the launch template. Default: The default version for the + // launch template. + Version *string } // The options for Spot Instances. type LaunchTemplateSpotMarketOptions struct { - // The maximum hourly price you're willing to pay for the Spot Instances. - MaxPrice *string + // The required duration for the Spot Instances (also known as Spot blocks), in + // minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360). + BlockDurationMinutes *int32 // The behavior when a Spot Instance is interrupted. InstanceInterruptionBehavior InstanceInterruptionBehavior - // The required duration for the Spot Instances (also known as Spot blocks), in - // minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360). - BlockDurationMinutes *int32 + // The maximum hourly price you're willing to pay for the Spot Instances. + MaxPrice *string + + // The Spot Instance request type. + SpotInstanceType SpotInstanceType // The end date of the request. For a one-time request, the request remains active // until all instances launch, the request is canceled, or this date is reached. If // the request is persistent, it remains active until it is canceled or this date // and time is reached. ValidUntil *time.Time - - // The Spot Instance request type. - SpotInstanceType SpotInstanceType } // The options for Spot Instances. type LaunchTemplateSpotMarketOptionsRequest struct { - // The Spot Instance request type. - SpotInstanceType SpotInstanceType + // The required duration for the Spot Instances (also known as Spot blocks), in + // minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360). + BlockDurationMinutes *int32 // The behavior when a Spot Instance is interrupted. The default is terminate. InstanceInterruptionBehavior InstanceInterruptionBehavior + // The maximum hourly price you're willing to pay for the Spot Instances. + MaxPrice *string + + // The Spot Instance request type. + SpotInstanceType SpotInstanceType + // The end date of the request. For a one-time request, the request remains active // until all instances launch, the request is canceled, or this date is reached. If // the request is persistent, it remains active until it is canceled or this date // and time is reached. The default end date is 7 days from the current date. ValidUntil *time.Time - - // The required duration for the Spot Instances (also known as Spot blocks), in - // minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360). - BlockDurationMinutes *int32 - - // The maximum hourly price you're willing to pay for the Spot Instances. - MaxPrice *string } // The tag specification for the launch template. @@ -4963,29 +4963,29 @@ type LaunchTemplateTagSpecificationRequest struct { // Describes a launch template version. type LaunchTemplateVersion struct { - // The description for the version. - VersionDescription *string - - // The version number. - VersionNumber *int64 - - // Indicates whether the version is the default version. - DefaultVersion *bool - - // The ID of the launch template. - LaunchTemplateId *string - // The time the version was created. CreateTime *time.Time // The principal that created the version. CreatedBy *string + // Indicates whether the version is the default version. + DefaultVersion *bool + // Information about the launch template. LaunchTemplateData *ResponseLaunchTemplateData + // The ID of the launch template. + LaunchTemplateId *string + // The name of the launch template. LaunchTemplateName *string + + // The description for the version. + VersionDescription *string + + // The version number. + VersionNumber *int64 } // Describes a license configuration. @@ -5006,150 +5006,150 @@ type LicenseConfigurationRequest struct { // request. type LoadBalancersConfig struct { - // The target groups. - TargetGroupsConfig *TargetGroupsConfig - // The Classic Load Balancers. ClassicLoadBalancersConfig *ClassicLoadBalancersConfig + + // The target groups. + TargetGroupsConfig *TargetGroupsConfig } // Describes a load permission. type LoadPermission struct { - // The AWS account ID. - UserId *string - // The name of the group. Group PermissionGroup + + // The AWS account ID. + UserId *string } // Describes modifications to the load permissions of an Amazon FPGA image (AFI). type LoadPermissionModifications struct { - // The load permissions to remove. - Remove []*LoadPermissionRequest - // The load permissions to add. Add []*LoadPermissionRequest + + // The load permissions to remove. + Remove []*LoadPermissionRequest } // Describes a load permission. type LoadPermissionRequest struct { - // The AWS account ID. - UserId *string - // The name of the group. Group PermissionGroup -} + + // The AWS account ID. + UserId *string +} // Describes a local gateway. type LocalGateway struct { - // The state of the local gateway. - State *string + // The ID of the local gateway. + LocalGatewayId *string // The Amazon Resource Name (ARN) of the Outpost. OutpostArn *string - // The tags assigned to the local gateway. - Tags []*Tag - // The ID of the AWS account ID that owns the local gateway. OwnerId *string - // The ID of the local gateway. - LocalGatewayId *string + // The state of the local gateway. + State *string + + // The tags assigned to the local gateway. + Tags []*Tag } // Describes a route for a local gateway route table. type LocalGatewayRoute struct { - // The state of the route. - State LocalGatewayRouteState + // The CIDR block used for destination matches. + DestinationCidrBlock *string // The ID of the local gateway route table. LocalGatewayRouteTableId *string - // The route type. - Type LocalGatewayRouteType - - // The CIDR block used for destination matches. - DestinationCidrBlock *string - // The ID of the virtual interface group. LocalGatewayVirtualInterfaceGroupId *string + + // The state of the route. + State LocalGatewayRouteState + + // The route type. + Type LocalGatewayRouteType } // Describes a local gateway route table. type LocalGatewayRouteTable struct { - // The tags assigned to the local gateway route table. - Tags []*Tag - // The ID of the local gateway. LocalGatewayId *string - // The state of the local gateway route table. - State *string - // The ID of the local gateway route table. LocalGatewayRouteTableId *string // The Amazon Resource Name (ARN) of the Outpost. OutpostArn *string + + // The state of the local gateway route table. + State *string + + // The tags assigned to the local gateway route table. + Tags []*Tag } // Describes an association between a local gateway route table and a virtual // interface group. type LocalGatewayRouteTableVirtualInterfaceGroupAssociation struct { - // The ID of the association. - LocalGatewayRouteTableVirtualInterfaceGroupAssociationId *string - // The ID of the local gateway. LocalGatewayId *string - // The tags assigned to the association. - Tags []*Tag - - // The state of the association. - State *string - // The ID of the local gateway route table. LocalGatewayRouteTableId *string + // The ID of the association. + LocalGatewayRouteTableVirtualInterfaceGroupAssociationId *string + // The ID of the virtual interface group. LocalGatewayVirtualInterfaceGroupId *string + + // The state of the association. + State *string + + // The tags assigned to the association. + Tags []*Tag } // Describes an association between a local gateway route table and a VPC. type LocalGatewayRouteTableVpcAssociation struct { - // The ID of the association. - LocalGatewayRouteTableVpcAssociationId *string + // The ID of the local gateway. + LocalGatewayId *string // The ID of the local gateway route table. LocalGatewayRouteTableId *string + // The ID of the association. + LocalGatewayRouteTableVpcAssociationId *string + // The state of the association. State *string - // The ID of the VPC. - VpcId *string - - // The ID of the local gateway. - LocalGatewayId *string - // The tags assigned to the association. Tags []*Tag + + // The ID of the VPC. + VpcId *string } // Describes a local gateway virtual interface. type LocalGatewayVirtualInterface struct { - // The ID of the VLAN. - Vlan *int32 + // The local address. + LocalAddress *string // The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local // gateway. @@ -5158,31 +5158,31 @@ type LocalGatewayVirtualInterface struct { // The ID of the local gateway. LocalGatewayId *string - // The tags assigned to the virtual interface. - Tags []*Tag - - // The peer BGP ASN. - PeerBgpAsn *int32 + // The ID of the virtual interface. + LocalGatewayVirtualInterfaceId *string // The peer address. PeerAddress *string - // The local address. - LocalAddress *string + // The peer BGP ASN. + PeerBgpAsn *int32 - // The ID of the virtual interface. - LocalGatewayVirtualInterfaceId *string + // The tags assigned to the virtual interface. + Tags []*Tag + + // The ID of the VLAN. + Vlan *int32 } // Describes a local gateway virtual interface group. type LocalGatewayVirtualInterfaceGroup struct { - // The ID of the virtual interface group. - LocalGatewayVirtualInterfaceGroupId *string - // The ID of the local gateway. LocalGatewayId *string + // The ID of the virtual interface group. + LocalGatewayVirtualInterfaceGroupId *string + // The IDs of the virtual interfaces. LocalGatewayVirtualInterfaceIds []*string @@ -5193,35 +5193,35 @@ type LocalGatewayVirtualInterfaceGroup struct { // Describes a managed prefix list. type ManagedPrefixList struct { - // The state message. - StateMessage *string + // The IP address version. + AddressFamily *string - // The ID of the prefix list. - PrefixListId *string + // The maximum number of entries for the prefix list. + MaxEntries *int32 // The ID of the owner of the prefix list. OwnerId *string + // The Amazon Resource Name (ARN) for the prefix list. + PrefixListArn *string + + // The ID of the prefix list. + PrefixListId *string + // The name of the prefix list. PrefixListName *string - // The Amazon Resource Name (ARN) for the prefix list. - PrefixListArn *string + // The state of the prefix list. + State PrefixListState - // The maximum number of entries for the prefix list. - MaxEntries *int32 + // The state message. + StateMessage *string // The tags for the prefix list. Tags []*Tag - // The IP address version. - AddressFamily *string - // The version of the prefix list. Version *int64 - - // The state of the prefix list. - State PrefixListState } // Describes the memory for the instance type. @@ -5244,32 +5244,59 @@ type ModifyTransitGatewayVpcAttachmentRequestOptions struct { // The AWS Site-to-Site VPN tunnel options to modify. type ModifyVpnTunnelOptionsSpecification struct { - // The lifetime for phase 2 of the IKE negotiation, in seconds. Constraints: A - // value between 900 and 3,600. The value must be less than the value for - // Phase1LifetimeSeconds. Default: 3600 - Phase2LifetimeSeconds *int32 + // The number of seconds after which a DPD timeout occurs. Constraints: A value + // between 0 and 30. Default: 30 + DPDTimeoutSeconds *int32 + + // The IKE versions that are permitted for the VPN tunnel. Valid values: ikev1 | + // ikev2 + IKEVersions []*IKEVersionsRequestListValue + + // One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel + // for phase 1 IKE negotiations. Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 22 | 23 + // | 24 + Phase1DHGroupNumbers []*Phase1DHGroupNumbersRequestListValue + + // One or more encryption algorithms that are permitted for the VPN tunnel for + // phase 1 IKE negotiations. Valid values: AES128 | AES256 + Phase1EncryptionAlgorithms []*Phase1EncryptionAlgorithmsRequestListValue // One or more integrity algorithms that are permitted for the VPN tunnel for phase // 1 IKE negotiations. Valid values: SHA1 | SHA2-256 Phase1IntegrityAlgorithms []*Phase1IntegrityAlgorithmsRequestListValue + // The lifetime for phase 1 of the IKE negotiation, in seconds. Constraints: A + // value between 900 and 28,800. Default: 28800 + Phase1LifetimeSeconds *int32 + + // One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel + // for phase 2 IKE negotiations. Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 22 + // | 23 | 24 + Phase2DHGroupNumbers []*Phase2DHGroupNumbersRequestListValue + + // One or more encryption algorithms that are permitted for the VPN tunnel for + // phase 2 IKE negotiations. Valid values: AES128 | AES256 + Phase2EncryptionAlgorithms []*Phase2EncryptionAlgorithmsRequestListValue + // One or more integrity algorithms that are permitted for the VPN tunnel for phase // 2 IKE negotiations. Valid values: SHA1 | SHA2-256 Phase2IntegrityAlgorithms []*Phase2IntegrityAlgorithmsRequestListValue + // The lifetime for phase 2 of the IKE negotiation, in seconds. Constraints: A + // value between 900 and 3,600. The value must be less than the value for + // Phase1LifetimeSeconds. Default: 3600 + Phase2LifetimeSeconds *int32 + // The pre-shared key (PSK) to establish initial authentication between the virtual // private gateway and the customer gateway. Constraints: Allowed characters are // alphanumeric characters, periods (.), and underscores (_). Must be between 8 and // 64 characters in length and cannot start with zero (0). PreSharedKey *string - // One or more encryption algorithms that are permitted for the VPN tunnel for - // phase 2 IKE negotiations. Valid values: AES128 | AES256 - Phase2EncryptionAlgorithms []*Phase2EncryptionAlgorithmsRequestListValue - - // One or more encryption algorithms that are permitted for the VPN tunnel for - // phase 1 IKE negotiations. Valid values: AES128 | AES256 - Phase1EncryptionAlgorithms []*Phase1EncryptionAlgorithmsRequestListValue + // The percentage of the rekey window (determined by RekeyMarginTimeSeconds) during + // which the rekey time is randomly selected. Constraints: A value between 0 and + // 100. Default: 100 + RekeyFuzzPercentage *int32 // The margin time, in seconds, before the phase 2 lifetime expires, during which // the AWS side of the VPN connection performs an IKE rekey. The exact time of the @@ -5277,28 +5304,10 @@ type ModifyVpnTunnelOptionsSpecification struct { // Constraints: A value between 60 and half of Phase2LifetimeSeconds. Default: 540 RekeyMarginTimeSeconds *int32 - // The number of seconds after which a DPD timeout occurs. Constraints: A value - // between 0 and 30. Default: 30 - DPDTimeoutSeconds *int32 - // The number of packets in an IKE replay window. Constraints: A value between 64 // and 2048. Default: 1024 ReplayWindowSize *int32 - // One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel - // for phase 2 IKE negotiations. Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 22 - // | 23 | 24 - Phase2DHGroupNumbers []*Phase2DHGroupNumbersRequestListValue - - // The percentage of the rekey window (determined by RekeyMarginTimeSeconds) during - // which the rekey time is randomly selected. Constraints: A value between 0 and - // 100. Default: 100 - RekeyFuzzPercentage *int32 - - // The lifetime for phase 1 of the IKE negotiation, in seconds. Constraints: A - // value between 900 and 28,800. Default: 28800 - Phase1LifetimeSeconds *int32 - // The range of inside IP addresses for the tunnel. Any specified CIDR blocks must // be unique across all VPN connections that use the same virtual private gateway. // Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The following @@ -5320,15 +5329,6 @@ type ModifyVpnTunnelOptionsSpecification struct { // // * 169.254.169.252/30 TunnelInsideCidr *string - - // One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel - // for phase 1 IKE negotiations. Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 22 | 23 - // | 24 - Phase1DHGroupNumbers []*Phase1DHGroupNumbersRequestListValue - - // The IKE versions that are permitted for the VPN tunnel. Valid values: ikev1 | - // ikev2 - IKEVersions []*IKEVersionsRequestListValue } // Describes the monitoring of an instance. @@ -5342,44 +5342,28 @@ type Monitoring struct { // Describes the status of a moving Elastic IP address. type MovingAddressStatus struct { - // The Elastic IP address. - PublicIp *string - // The status of the Elastic IP address that's being moved to the EC2-VPC platform, // or restored to the EC2-Classic platform. MoveStatus MoveStatus + + // The Elastic IP address. + PublicIp *string } // Describes a NAT gateway. type NatGateway struct { - // The ID of the VPC in which the NAT gateway is located. - VpcId *string - - // If the NAT gateway could not be created, specifies the error code for the - // failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | - // InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | - // InvalidSubnetID.NotFound) - FailureCode *string - - // The tags for the NAT gateway. - Tags []*Tag - - // The ID of the subnet in which the NAT gateway is located. - SubnetId *string - - // Information about the IP addresses and network interface associated with the NAT - // gateway. - NatGatewayAddresses []*NatGatewayAddress - // The date and time the NAT gateway was created. CreateTime *time.Time // The date and time the NAT gateway was deleted, if applicable. DeleteTime *time.Time - // The ID of the NAT gateway. - NatGatewayId *string + // If the NAT gateway could not be created, specifies the error code for the + // failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | + // InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | + // InvalidSubnetID.NotFound) + FailureCode *string // If the NAT gateway could not be created, specifies the error message for the // failure, that corresponds to the error code. @@ -5406,6 +5390,18 @@ type NatGateway struct { // specified subnet subnet-xxxxxxxx does not exist or could not be found." FailureMessage *string + // Information about the IP addresses and network interface associated with the NAT + // gateway. + NatGatewayAddresses []*NatGatewayAddress + + // The ID of the NAT gateway. + NatGatewayId *string + + // Reserved. If you need to sustain traffic greater than the documented limits + // (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html), contact + // us through the Support Center (https://console.aws.amazon.com/support/home?). + ProvisionedBandwidth *ProvisionedBandwidth + // The state of the NAT gateway. // // * pending: The NAT gateway is being created @@ -5426,15 +5422,23 @@ type NatGateway struct { // terminated and is no longer processing traffic. State NatGatewayState - // Reserved. If you need to sustain traffic greater than the documented limits - // (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html), contact - // us through the Support Center (https://console.aws.amazon.com/support/home?). - ProvisionedBandwidth *ProvisionedBandwidth + // The ID of the subnet in which the NAT gateway is located. + SubnetId *string + + // The tags for the NAT gateway. + Tags []*Tag + + // The ID of the VPC in which the NAT gateway is located. + VpcId *string } // Describes the IP addresses and network interface associated with a NAT gateway. type NatGatewayAddress struct { + // The allocation ID of the Elastic IP address that's associated with the NAT + // gateway. + AllocationId *string + // The ID of the network interface associated with the NAT gateway. NetworkInterfaceId *string @@ -5443,35 +5447,31 @@ type NatGatewayAddress struct { // The Elastic IP address associated with the NAT gateway. PublicIp *string - - // The allocation ID of the Elastic IP address that's associated with the NAT - // gateway. - AllocationId *string } // Describes a network ACL. type NetworkAcl struct { - // Any tags assigned to the network ACL. - Tags []*Tag + // Any associations between the network ACL and one or more subnets + Associations []*NetworkAclAssociation + + // One or more entries (rules) in the network ACL. + Entries []*NetworkAclEntry // Indicates whether this is the default network ACL for the VPC. IsDefault *bool - // One or more entries (rules) in the network ACL. - Entries []*NetworkAclEntry + // The ID of the network ACL. + NetworkAclId *string // The ID of the AWS account that owns the network ACL. OwnerId *string + // Any tags assigned to the network ACL. + Tags []*Tag + // The ID of the VPC for the network ACL. VpcId *string - - // The ID of the network ACL. - NetworkAclId *string - - // Any associations between the network ACL and one or more subnets - Associations []*NetworkAclAssociation } // Describes an association between a network ACL and a subnet. @@ -5480,19 +5480,32 @@ type NetworkAclAssociation struct { // The ID of the association between a network ACL and a subnet. NetworkAclAssociationId *string - // The ID of the subnet. - SubnetId *string - // The ID of the network ACL. NetworkAclId *string + + // The ID of the subnet. + SubnetId *string } // Describes an entry in a network ACL. type NetworkAclEntry struct { + // The IPv4 network range to allow or deny, in CIDR notation. + CidrBlock *string + + // Indicates whether the rule is an egress rule (applied to traffic leaving the + // subnet). + Egress *bool + // ICMP protocol: The ICMP type and code. IcmpTypeCode *IcmpTypeCode + // The IPv6 network range to allow or deny, in CIDR notation. + Ipv6CidrBlock *string + + // TCP or UDP protocols: The range of ports the rule applies to. + PortRange *PortRange + // The protocol number. A value of "-1" means all protocols. Protocol *string @@ -5502,38 +5515,25 @@ type NetworkAclEntry struct { // The rule number for the entry. ACL entries are processed in ascending order by // rule number. RuleNumber *int32 - - // Indicates whether the rule is an egress rule (applied to traffic leaving the - // subnet). - Egress *bool - - // The IPv6 network range to allow or deny, in CIDR notation. - Ipv6CidrBlock *string - - // The IPv4 network range to allow or deny, in CIDR notation. - CidrBlock *string - - // TCP or UDP protocols: The range of ports the rule applies to. - PortRange *PortRange } // Describes the networking features of the instance type. type NetworkInfo struct { + // Indicates whether Elastic Fabric Adapter (EFA) is supported. + EfaSupported *bool + // Indicates whether Elastic Network Adapter (ENA) is supported. EnaSupport EnaSupport // The maximum number of IPv4 addresses per network interface. Ipv4AddressesPerInterface *int32 - // Indicates whether IPv6 is supported. - Ipv6Supported *bool - // The maximum number of IPv6 addresses per network interface. Ipv6AddressesPerInterface *int32 - // Indicates whether Elastic Fabric Adapter (EFA) is supported. - EfaSupported *bool + // Indicates whether IPv6 is supported. + Ipv6Supported *bool // The maximum number of network interfaces for the instance type. MaximumNetworkInterfaces *int32 @@ -5545,126 +5545,126 @@ type NetworkInfo struct { // Describes a network interface. type NetworkInterface struct { - // Any security groups for the network interface. - Groups []*GroupIdentifier - - // Indicates whether the network interface is being managed by AWS. - RequesterManaged *bool - // The association information for an Elastic IP address (IPv4) associated with the // network interface. Association *NetworkInterfaceAssociation - // The ID of the VPC. - VpcId *string + // The network interface attachment. + Attachment *NetworkInterfaceAttachment // The Availability Zone. AvailabilityZone *string - // The AWS account ID of the owner of the network interface. - OwnerId *string - - // The ID of the subnet. - SubnetId *string - - // The private IPv4 addresses associated with the network interface. - PrivateIpAddresses []*NetworkInterfacePrivateIpAddress + // A description. + Description *string - // Indicates whether traffic to or from the instance is validated. - SourceDestCheck *bool + // Any security groups for the network interface. + Groups []*GroupIdentifier // The type of network interface. InterfaceType NetworkInterfaceType - // A description. - Description *string + // The IPv6 addresses associated with the network interface. + Ipv6Addresses []*NetworkInterfaceIpv6Address + + // The MAC address. + MacAddress *string + + // The ID of the network interface. + NetworkInterfaceId *string + + // The Amazon Resource Name (ARN) of the Outpost. + OutpostArn *string + + // The AWS account ID of the owner of the network interface. + OwnerId *string + + // The private DNS name. + PrivateDnsName *string // The IPv4 address of the network interface within the subnet. PrivateIpAddress *string - // The status of the network interface. - Status NetworkInterfaceStatus - - // The IPv6 addresses associated with the network interface. - Ipv6Addresses []*NetworkInterfaceIpv6Address + // The private IPv4 addresses associated with the network interface. + PrivateIpAddresses []*NetworkInterfacePrivateIpAddress // The ID of the entity that launched the instance on your behalf (for example, AWS // Management Console or Auto Scaling). RequesterId *string - // The network interface attachment. - Attachment *NetworkInterfaceAttachment + // Indicates whether the network interface is being managed by AWS. + RequesterManaged *bool - // The private DNS name. - PrivateDnsName *string + // Indicates whether traffic to or from the instance is validated. + SourceDestCheck *bool - // The ID of the network interface. - NetworkInterfaceId *string + // The status of the network interface. + Status NetworkInterfaceStatus - // The MAC address. - MacAddress *string + // The ID of the subnet. + SubnetId *string // Any tags assigned to the network interface. TagSet []*Tag - // The Amazon Resource Name (ARN) of the Outpost. - OutpostArn *string + // The ID of the VPC. + VpcId *string } // Describes association information for an Elastic IP address (IPv4 only). type NetworkInterfaceAssociation struct { - // The public DNS name. - PublicDnsName *string + // The allocation ID. + AllocationId *string + + // The association ID. + AssociationId *string // The ID of the Elastic IP address owner. IpOwnerId *string + // The public DNS name. + PublicDnsName *string + // The address of the Elastic IP address bound to the network interface. PublicIp *string - - // The allocation ID. - AllocationId *string - - // The association ID. - AssociationId *string } // Describes a network interface attachment. type NetworkInterfaceAttachment struct { - // The ID of the instance. - InstanceId *string + // The timestamp indicating when the attachment initiated. + AttachTime *time.Time // The ID of the network interface attachment. AttachmentId *string - // The attachment state. - Status AttachmentStatus - - // The AWS account ID of the owner of the instance. - InstanceOwnerId *string - - // The timestamp indicating when the attachment initiated. - AttachTime *time.Time + // Indicates whether the network interface is deleted when the instance is + // terminated. + DeleteOnTermination *bool // The device index of the network interface attachment on the instance. DeviceIndex *int32 - // Indicates whether the network interface is deleted when the instance is - // terminated. - DeleteOnTermination *bool + // The ID of the instance. + InstanceId *string + + // The AWS account ID of the owner of the instance. + InstanceOwnerId *string + + // The attachment state. + Status AttachmentStatus } // Describes an attachment change. type NetworkInterfaceAttachmentChanges struct { + // The ID of the network interface attachment. + AttachmentId *string + // Indicates whether the network interface is deleted when the instance is // terminated. DeleteOnTermination *bool - - // The ID of the network interface attachment. - AttachmentId *string } // Describes an IPv6 address associated with a network interface. @@ -5680,30 +5680,30 @@ type NetworkInterfacePermission struct { // The AWS account ID. AwsAccountId *string - // The ID of the network interface permission. - NetworkInterfacePermissionId *string - // The AWS service. AwsService *string - // Information about the state of the permission. - PermissionState *NetworkInterfacePermissionState + // The ID of the network interface. + NetworkInterfaceId *string + + // The ID of the network interface permission. + NetworkInterfacePermissionId *string // The type of permission. Permission InterfacePermissionType - // The ID of the network interface. - NetworkInterfaceId *string + // Information about the state of the permission. + PermissionState *NetworkInterfacePermissionState } // Describes the state of a network interface permission. type NetworkInterfacePermissionState struct { - // A status message, if applicable. - StatusMessage *string - // The state of the permission. State NetworkInterfacePermissionStateCode + + // A status message, if applicable. + StatusMessage *string } // Describes the private IPv4 address of a network interface. @@ -5713,13 +5713,13 @@ type NetworkInterfacePrivateIpAddress struct { // network interface. Association *NetworkInterfaceAssociation - // The private DNS name. - PrivateDnsName *string - // Indicates whether this IPv4 address is the primary private IPv4 address of the // network interface. Primary *bool + // The private DNS name. + PrivateDnsName *string + // The private IPv4 address. PrivateIpAddress *string } @@ -5727,16 +5727,24 @@ type NetworkInterfacePrivateIpAddress struct { // Describes a DHCP configuration option. type NewDhcpConfiguration struct { - // One or more values for the DHCP option. - Values []*string - // The name of a DHCP option. Key *string + + // One or more values for the DHCP option. + Values []*string } // Describes the configuration of On-Demand Instances in an EC2 Fleet. type OnDemandOptions struct { + // The order of the launch template overrides to use in fulfilling On-Demand + // capacity. If you specify lowest-price, EC2 Fleet uses price to determine the + // order, launching the lowest price first. If you specify prioritized, EC2 Fleet + // uses the priority that you assigned to each launch template override, launching + // the highest priority first. If you do not specify a value, EC2 Fleet defaults to + // lowest-price. + AllocationStrategy FleetOnDemandAllocationStrategy + // The strategy for using unused Capacity Reservations for fulfilling On-Demand // capacity. Supported only for fleets of type instant. CapacityReservationOptions *CapacityReservationOptions @@ -5744,25 +5752,17 @@ type OnDemandOptions struct { // The maximum amount per hour for On-Demand Instances that you're willing to pay. MaxTotalPrice *string - // Indicates that the fleet launches all On-Demand Instances into a single - // Availability Zone. Supported only for fleets of type instant. - SingleAvailabilityZone *bool - // The minimum target capacity for On-Demand Instances in the fleet. If the minimum // target capacity is not reached, the fleet launches no instances. MinTargetCapacity *int32 + // Indicates that the fleet launches all On-Demand Instances into a single + // Availability Zone. Supported only for fleets of type instant. + SingleAvailabilityZone *bool + // Indicates that the fleet uses a single instance type to launch all On-Demand // Instances in the fleet. Supported only for fleets of type instant. SingleInstanceType *bool - - // The order of the launch template overrides to use in fulfilling On-Demand - // capacity. If you specify lowest-price, EC2 Fleet uses price to determine the - // order, launching the lowest price first. If you specify prioritized, EC2 Fleet - // uses the priority that you assigned to each launch template override, launching - // the highest priority first. If you do not specify a value, EC2 Fleet defaults to - // lowest-price. - AllocationStrategy FleetOnDemandAllocationStrategy } // Describes the configuration of On-Demand Instances in an EC2 Fleet. @@ -5776,40 +5776,40 @@ type OnDemandOptionsRequest struct { // lowest-price. AllocationStrategy FleetOnDemandAllocationStrategy - // The minimum target capacity for On-Demand Instances in the fleet. If the minimum - // target capacity is not reached, the fleet launches no instances. - MinTargetCapacity *int32 + // The strategy for using unused Capacity Reservations for fulfilling On-Demand + // capacity. Supported only for fleets of type instant. + CapacityReservationOptions *CapacityReservationOptionsRequest // The maximum amount per hour for On-Demand Instances that you're willing to pay. MaxTotalPrice *string - // Indicates that the fleet uses a single instance type to launch all On-Demand - // Instances in the fleet. Supported only for fleets of type instant. - SingleInstanceType *bool + // The minimum target capacity for On-Demand Instances in the fleet. If the minimum + // target capacity is not reached, the fleet launches no instances. + MinTargetCapacity *int32 // Indicates that the fleet launches all On-Demand Instances into a single // Availability Zone. Supported only for fleets of type instant. SingleAvailabilityZone *bool - // The strategy for using unused Capacity Reservations for fulfilling On-Demand - // capacity. Supported only for fleets of type instant. - CapacityReservationOptions *CapacityReservationOptionsRequest + // Indicates that the fleet uses a single instance type to launch all On-Demand + // Instances in the fleet. Supported only for fleets of type instant. + SingleInstanceType *bool } // Describes the data that identifies an Amazon FPGA image (AFI) on the PCI bus. type PciId struct { - // The ID of the vendor. - VendorId *string - // The ID of the device. DeviceId *string + // The ID of the subsystem. + SubsystemId *string + // The ID of the vendor for the subsystem. SubsystemVendorId *string - // The ID of the subsystem. - SubsystemId *string + // The ID of the vendor. + VendorId *string } // The status of the transit gateway peering attachment. @@ -5825,6 +5825,10 @@ type PeeringAttachmentStatus struct { // Describes the VPC peering connection options. type PeeringConnectionOptions struct { + // If true, the public DNS hostnames of instances in the specified VPC resolve to + // private IP addresses when queried from instances in the peer VPC. + AllowDnsResolutionFromRemoteVpc *bool + // If true, enables outbound communication from an EC2-Classic instance that's // linked to a local VPC using ClassicLink to instances in a peer VPC. AllowEgressFromLocalClassicLinkToRemoteVpc *bool @@ -5832,10 +5836,6 @@ type PeeringConnectionOptions struct { // If true, enables outbound communication from instances in a local VPC to an // EC2-Classic instance that's linked to a peer VPC using ClassicLink. AllowEgressFromLocalVpcToRemoteClassicLink *bool - - // If true, the public DNS hostnames of instances in the specified VPC resolve to - // private IP addresses when queried from instances in the peer VPC. - AllowDnsResolutionFromRemoteVpc *bool } // The VPC peering connection options. @@ -5960,16 +5960,6 @@ type Phase2IntegrityAlgorithmsRequestListValue struct { // Describes the placement of an instance. type Placement struct { - // Reserved for future use. This parameter is not supported by CreateFleet - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet). - SpreadDomain *string - - // The number of the partition the instance is in. Valid only if the placement - // group strategy is set to partition. This parameter is not supported by - // CreateFleet - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet). - PartitionNumber *int32 - // The affinity setting for the instance on the Dedicated Host. This parameter is // not supported for the ImportInstance // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html) @@ -5977,15 +5967,15 @@ type Placement struct { // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet). Affinity *string - // The name of the placement group the instance is in. - GroupName *string - // The Availability Zone of the instance. If not specified, an Availability Zone // will be automatically chosen for you based on the load balancing criteria for // the Region. This parameter is not supported by CreateFleet // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet). AvailabilityZone *string + // The name of the placement group the instance is in. + GroupName *string + // The ID of the Dedicated Host on which the instance resides. This parameter is // not supported for the ImportInstance // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html) @@ -5999,6 +5989,16 @@ type Placement struct { // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet). HostResourceGroupArn *string + // The number of the partition the instance is in. Valid only if the placement + // group strategy is set to partition. This parameter is not supported by + // CreateFleet + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet). + PartitionNumber *int32 + + // Reserved for future use. This parameter is not supported by CreateFleet + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet). + SpreadDomain *string + // The tenancy of the instance (if the instance is running in a VPC). An instance // with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is // not supported for the ImportInstance @@ -6011,8 +6011,8 @@ type Placement struct { // Describes a placement group. type PlacementGroup struct { - // The state of the placement group. - State PlacementGroupState + // The ID of the placement group. + GroupId *string // The name of the placement group. GroupName *string @@ -6020,14 +6020,14 @@ type PlacementGroup struct { // The number of partitions. Valid only if strategy is set to partition. PartitionCount *int32 - // Any tags applied to the placement group. - Tags []*Tag - - // The ID of the placement group. - GroupId *string + // The state of the placement group. + State PlacementGroupState // The placement strategy. Strategy PlacementStrategy + + // Any tags applied to the placement group. + Tags []*Tag } // Describes the placement group support of the instance type. @@ -6077,11 +6077,11 @@ type PrefixList struct { // Describes the resource with which a prefix list is associated. type PrefixListAssociation struct { - // The owner of the resource. - ResourceOwner *string - // The ID of the resource. ResourceId *string + + // The owner of the resource. + ResourceOwner *string } // Describes a prefix list entry. @@ -6109,17 +6109,6 @@ type PrefixListId struct { // Describes the price for a Reserved Instance. type PriceSchedule struct { - // The fixed price for the term. - Price *float64 - - // The currency for transacting the Reserved Instance resale. At this time, the - // only supported currency is USD. - CurrencyCode CurrencyCodeValues - - // The number of months remaining in the reservation. For example, 2 is the second - // to the last month before the capacity reservation expires. - Term *int64 - // The current price schedule, as determined by the term remaining for the Reserved // Instance in the listing. A specific price schedule is always in effect, but only // one price schedule can be active at any time. Take, for example, a Reserved @@ -6129,14 +6118,21 @@ type PriceSchedule struct { // months 5, 4, and 3. Then schedule 2, covering the last two months of the term, // will be active for months 2 and 1. Active *bool -} -// Describes the price for a Reserved Instance. -type PriceScheduleSpecification struct { + // The currency for transacting the Reserved Instance resale. At this time, the + // only supported currency is USD. + CurrencyCode CurrencyCodeValues + + // The fixed price for the term. + Price *float64 // The number of months remaining in the reservation. For example, 2 is the second // to the last month before the capacity reservation expires. Term *int64 +} + +// Describes the price for a Reserved Instance. +type PriceScheduleSpecification struct { // The currency for transacting the Reserved Instance resale. At this time, the // only supported currency is USD. @@ -6144,6 +6140,10 @@ type PriceScheduleSpecification struct { // The fixed price for the term. Price *float64 + + // The number of months remaining in the reservation. For example, 2 is the second + // to the last month before the capacity reservation expires. + Term *int64 } // Describes a Reserved Instance offering. @@ -6173,16 +6173,16 @@ type PrincipalIdFormat struct { // in the Amazon Virtual Private Cloud User Guide. type PrivateDnsNameConfiguration struct { - // The endpoint service verification type, for example TXT. - Type *string + // The name of the record subdomain the service provider needs to create. The + // service provider adds the value text to the name. + Name *string // The verification state of the VPC endpoint service. >Consumers of the endpoint // service can use the private name only when the state is verified. State DnsNameState - // The name of the record subdomain the service provider needs to create. The - // service provider adds the value text to the name. - Name *string + // The endpoint service verification type, for example TXT. + Type *string // The value the service provider adds to the private DNS name domain record before // verification. @@ -6235,61 +6235,61 @@ type ProvisionedBandwidth struct { // Reserved. If you need to sustain traffic greater than the documented limits // (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html), contact // us through the Support Center (https://console.aws.amazon.com/support/home?). - Requested *string + ProvisionTime *time.Time // Reserved. If you need to sustain traffic greater than the documented limits // (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html), contact // us through the Support Center (https://console.aws.amazon.com/support/home?). - RequestTime *time.Time + Provisioned *string // Reserved. If you need to sustain traffic greater than the documented limits // (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html), contact // us through the Support Center (https://console.aws.amazon.com/support/home?). - Status *string + RequestTime *time.Time // Reserved. If you need to sustain traffic greater than the documented limits // (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html), contact // us through the Support Center (https://console.aws.amazon.com/support/home?). - ProvisionTime *time.Time + Requested *string // Reserved. If you need to sustain traffic greater than the documented limits // (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html), contact // us through the Support Center (https://console.aws.amazon.com/support/home?). - Provisioned *string + Status *string } // Describes an IPv4 address pool. type PublicIpv4Pool struct { + // A description of the address pool. + Description *string + // The name of the location from which the address pool is advertised. A network // border group is a unique set of Availability Zones or Local Zones from where AWS // advertises public IP addresses. NetworkBorderGroup *string - // The total number of addresses. - TotalAddressCount *int32 + // The address ranges. + PoolAddressRanges []*PublicIpv4PoolRange // The ID of the address pool. PoolId *string - // The total number of available addresses. - TotalAvailableAddressCount *int32 - - // A description of the address pool. - Description *string - - // The address ranges. - PoolAddressRanges []*PublicIpv4PoolRange - // Any tags for the address pool. Tags []*Tag + + // The total number of addresses. + TotalAddressCount *int32 + + // The total number of available addresses. + TotalAvailableAddressCount *int32 } // Describes an address range of an IPv4 address pool. type PublicIpv4PoolRange struct { - // The last IP address in the range. - LastAddress *string + // The number of addresses in the range. + AddressCount *int32 // The number of available addresses in the range. AvailableAddressCount *int32 @@ -6297,35 +6297,35 @@ type PublicIpv4PoolRange struct { // The first IP address in the range. FirstAddress *string - // The number of addresses in the range. - AddressCount *int32 + // The last IP address in the range. + LastAddress *string } // Describes the result of the purchase. type Purchase struct { - // The payment option for the reservation. - PaymentOption PaymentOption - - // The ID of the reservation. - HostReservationId *string + // The currency in which the UpfrontPrice and HourlyPrice amounts are specified. At + // this time, the only supported currency is USD. + CurrencyCode CurrencyCodeValues - // The instance family on the Dedicated Host that the reservation can be associated - // with. - InstanceFamily *string + // The duration of the reservation's term in seconds. + Duration *int32 // The IDs of the Dedicated Hosts associated with the reservation. HostIdSet []*string - // The currency in which the UpfrontPrice and HourlyPrice amounts are specified. At - // this time, the only supported currency is USD. - CurrencyCode CurrencyCodeValues + // The ID of the reservation. + HostReservationId *string // The hourly price of the reservation per hour. HourlyPrice *string - // The duration of the reservation's term in seconds. - Duration *int32 + // The instance family on the Dedicated Host that the reservation can be associated + // with. + InstanceFamily *string + + // The payment option for the reservation. + PaymentOption PaymentOption // The upfront price of the reservation. UpfrontPrice *string @@ -6334,39 +6334,39 @@ type Purchase struct { // Describes a request to purchase Scheduled Instances. type PurchaseRequest struct { - // The purchase token. + // The number of instances. // // This member is required. - PurchaseToken *string + InstanceCount *int32 - // The number of instances. + // The purchase token. // // This member is required. - InstanceCount *int32 + PurchaseToken *string } // Describes a recurring charge. type RecurringCharge struct { - // The frequency of the recurring charge. - Frequency RecurringChargeFrequency - // The amount of the recurring charge. Amount *float64 + + // The frequency of the recurring charge. + Frequency RecurringChargeFrequency } // Describes a Region. type Region struct { + // The Region service endpoint. + Endpoint *string + // The Region opt-in status. The possible values are opt-in-not-required, opted-in, // and not-opted-in. OptInStatus *string // The name of the Region. RegionName *string - - // The Region service endpoint. - Endpoint *string } // Information about the tag keys to register for the current Region. You can @@ -6375,12 +6375,12 @@ type Region struct { // the request type RegisterInstanceTagAttributeRequest struct { - // The tag keys to register. - InstanceTagKeys []*string - // Indicates whether to register all tag keys in the current Region. Specify true // to register all tag keys. IncludeAllTagsOfInstance *bool + + // The tag keys to register. + InstanceTagKeys []*string } // An entry for a prefix list. @@ -6395,20 +6395,24 @@ type RemovePrefixListEntry struct { // The information to include in the launch template. type RequestLaunchTemplateData struct { - // One or more network interfaces. If you specify a network interface, you must - // specify any security groups and subnets as part of the network interface. - NetworkInterfaces []*LaunchTemplateInstanceNetworkInterfaceSpecificationRequest + // The block device mapping. + BlockDeviceMappings []*LaunchTemplateBlockDeviceMappingRequest - // The ID of the RAM disk. We recommend that you use PV-GRUB instead of kernels and - // RAM disks. For more information, see User Provided Kernels - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) + // The Capacity Reservation targeting option. If you do not specify this parameter, + // the instance's Capacity Reservation preference defaults to open, which enables + // it to run in any open Capacity Reservation that has matching attributes + // (instance type, platform, Availability Zone). + CapacityReservationSpecification *LaunchTemplateCapacityReservationSpecificationRequest + + // The CPU options for the instance. For more information, see Optimizing CPU + // Options + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) // in the Amazon Elastic Compute Cloud User Guide. - RamDiskId *string + CpuOptions *LaunchTemplateCpuOptionsRequest - // Indicates whether an instance stops or terminates when you initiate shutdown - // from the instance (using the operating system command for system shutdown). - // Default: stop - InstanceInitiatedShutdownBehavior ShutdownBehavior + // The credit option for CPU usage of the instance. Valid for T2, T3, or T3a + // instances only. + CreditSpecification *CreditSpecificationRequest // If you set this parameter to true, you can't terminate the instance using the // Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute @@ -6418,14 +6422,6 @@ type RequestLaunchTemplateData struct { // can terminate the instance by running the shutdown command from the instance. DisableApiTermination *bool - // Indicates whether an instance is enabled for hibernation. This parameter is - // valid only if the instance meets the hibernation prerequisites - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites). - // For more information, see Hibernate Your Instance - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the - // Amazon Elastic Compute Cloud User Guide. - HibernationOptions *LaunchTemplateHibernationOptionsRequest - // Indicates whether the instance is optimized for Amazon EBS I/O. This // optimization provides dedicated throughput to Amazon EBS and an optimized // configuration stack to provide optimal Amazon EBS I/O performance. This @@ -6433,54 +6429,44 @@ type RequestLaunchTemplateData struct { // apply when using an EBS-optimized instance. EbsOptimized *bool - // The CPU options for the instance. For more information, see Optimizing CPU - // Options - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) - // in the Amazon Elastic Compute Cloud User Guide. - CpuOptions *LaunchTemplateCpuOptionsRequest - - // One or more security group IDs. You can create a security group using - // CreateSecurityGroup - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSecurityGroup.html). - // You cannot specify both a security group ID and security name in the same - // request. - SecurityGroupIds []*string + // An elastic GPU to associate with the instance. + ElasticGpuSpecifications []*ElasticGpuSpecification // The elastic inference accelerator for the instance. ElasticInferenceAccelerators []*LaunchTemplateElasticInferenceAccelerator - // The license configurations. - LicenseSpecifications []*LaunchTemplateLicenseConfigurationRequest + // Indicates whether an instance is enabled for hibernation. This parameter is + // valid only if the instance meets the hibernation prerequisites + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites). + // For more information, see Hibernate Your Instance + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the + // Amazon Elastic Compute Cloud User Guide. + HibernationOptions *LaunchTemplateHibernationOptionsRequest - // The credit option for CPU usage of the instance. Valid for T2, T3, or T3a - // instances only. - CreditSpecification *CreditSpecificationRequest + // The IAM instance profile. + IamInstanceProfile *LaunchTemplateIamInstanceProfileSpecificationRequest - // The metadata options for the instance. For more information, see Instance - // Metadata and User Data - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) - // in the Amazon Elastic Compute Cloud User Guide. - MetadataOptions *LaunchTemplateInstanceMetadataOptionsRequest + // The ID of the AMI. + ImageId *string - // The Capacity Reservation targeting option. If you do not specify this parameter, - // the instance's Capacity Reservation preference defaults to open, which enables - // it to run in any open Capacity Reservation that has matching attributes - // (instance type, platform, Availability Zone). - CapacityReservationSpecification *LaunchTemplateCapacityReservationSpecificationRequest + // Indicates whether an instance stops or terminates when you initiate shutdown + // from the instance (using the operating system command for system shutdown). + // Default: stop + InstanceInitiatedShutdownBehavior ShutdownBehavior - // The IAM instance profile. - IamInstanceProfile *LaunchTemplateIamInstanceProfileSpecificationRequest + // The market (purchasing) option for the instances. + InstanceMarketOptions *LaunchTemplateInstanceMarketOptionsRequest - // The block device mapping. - BlockDeviceMappings []*LaunchTemplateBlockDeviceMappingRequest + // The instance type. For more information, see Instance Types + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the + // Amazon Elastic Compute Cloud User Guide. + InstanceType InstanceType - // The Base64-encoded user data to make available to the instance. For more - // information, see Running Commands on Your Linux Instance at Launch - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) (Linux) and - // Adding User Data - // (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html#instancedata-add-user-data) - // (Windows). - UserData *string + // The ID of the kernel. We recommend that you use PV-GRUB instead of kernels and + // RAM disks. For more information, see User Provided Kernels + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) + // in the Amazon Elastic Compute Cloud User Guide. + KernelId *string // The name of the key pair. You can create a key pair using CreateKeyPair // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html) @@ -6490,22 +6476,42 @@ type RequestLaunchTemplateData struct { // choose an AMI that is configured to allow users another way to log in. KeyName *string - // The ID of the AMI. - ImageId *string + // The license configurations. + LicenseSpecifications []*LaunchTemplateLicenseConfigurationRequest - // [EC2-Classic, default VPC] One or more security group names. For a nondefault - // VPC, you must use security group IDs instead. You cannot specify both a security - // group ID and security name in the same request. - SecurityGroups []*string + // The metadata options for the instance. For more information, see Instance + // Metadata and User Data + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) + // in the Amazon Elastic Compute Cloud User Guide. + MetadataOptions *LaunchTemplateInstanceMetadataOptionsRequest - // The market (purchasing) option for the instances. - InstanceMarketOptions *LaunchTemplateInstanceMarketOptionsRequest + // The monitoring for the instance. + Monitoring *LaunchTemplatesMonitoringRequest - // The ID of the kernel. We recommend that you use PV-GRUB instead of kernels and + // One or more network interfaces. If you specify a network interface, you must + // specify any security groups and subnets as part of the network interface. + NetworkInterfaces []*LaunchTemplateInstanceNetworkInterfaceSpecificationRequest + + // The placement for the instance. + Placement *LaunchTemplatePlacementRequest + + // The ID of the RAM disk. We recommend that you use PV-GRUB instead of kernels and // RAM disks. For more information, see User Provided Kernels // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) // in the Amazon Elastic Compute Cloud User Guide. - KernelId *string + RamDiskId *string + + // One or more security group IDs. You can create a security group using + // CreateSecurityGroup + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSecurityGroup.html). + // You cannot specify both a security group ID and security name in the same + // request. + SecurityGroupIds []*string + + // [EC2-Classic, default VPC] One or more security group names. For a nondefault + // VPC, you must use security group IDs instead. You cannot specify both a security + // group ID and security name in the same request. + SecurityGroups []*string // The tags to apply to the resources during launch. You can only tag instances and // volumes on launch. The specified tags are applied to all instances or volumes @@ -6514,39 +6520,26 @@ type RequestLaunchTemplateData struct { // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). TagSpecifications []*LaunchTemplateTagSpecificationRequest - // The placement for the instance. - Placement *LaunchTemplatePlacementRequest - - // The instance type. For more information, see Instance Types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the - // Amazon Elastic Compute Cloud User Guide. - InstanceType InstanceType - - // An elastic GPU to associate with the instance. - ElasticGpuSpecifications []*ElasticGpuSpecification - - // The monitoring for the instance. - Monitoring *LaunchTemplatesMonitoringRequest + // The Base64-encoded user data to make available to the instance. For more + // information, see Running Commands on Your Linux Instance at Launch + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) (Linux) and + // Adding User Data + // (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html#instancedata-add-user-data) + // (Windows). + UserData *string } // Describes the launch specification for an instance. type RequestSpotLaunchSpecification struct { - // The ID of the RAM disk. - RamdiskId *string - - // The ID of the AMI. - ImageId *string - - // Indicates whether basic or detailed monitoring is enabled for the instance. - // Default: Disabled - Monitoring *RunInstancesMonitoringEnabled - - // The Base64-encoded user data for the instance. User data is limited to 16 KB. - UserData *string + // Deprecated. + AddressingType *string - // One or more security group IDs. - SecurityGroupIds []*string + // One or more block device mapping entries. You can't specify both a snapshot ID + // and an encryption value. This is because only blank volumes can be encrypted on + // creation. If a snapshot is the basis for a volume, it is not blank and its + // encryption status is used for the volume encryption status. + BlockDeviceMappings []*BlockDeviceMapping // Indicates whether the instance is optimized for EBS I/O. This optimization // provides dedicated throughput to Amazon EBS and an optimized configuration stack @@ -6555,10 +6548,24 @@ type RequestSpotLaunchSpecification struct { // instance. Default: false EbsOptimized *bool - // One or more security groups. When requesting instances in a VPC, you must - // specify the IDs of the security groups. When requesting instances in - // EC2-Classic, you can specify the names or the IDs of the security groups. - SecurityGroups []*string + // The IAM instance profile. + IamInstanceProfile *IamInstanceProfileSpecification + + // The ID of the AMI. + ImageId *string + + // The instance type. + InstanceType InstanceType + + // The ID of the kernel. + KernelId *string + + // The name of the key pair. + KeyName *string + + // Indicates whether basic or detailed monitoring is enabled for the instance. + // Default: Disabled + Monitoring *RunInstancesMonitoringEnabled // One or more network interfaces. If you specify a network interface, you must // specify subnet IDs and security group IDs using the network interface. @@ -6567,31 +6574,24 @@ type RequestSpotLaunchSpecification struct { // The placement information for the instance. Placement *SpotPlacement - // The name of the key pair. - KeyName *string - - // The instance type. - InstanceType InstanceType - - // One or more block device mapping entries. You can't specify both a snapshot ID - // and an encryption value. This is because only blank volumes can be encrypted on - // creation. If a snapshot is the basis for a volume, it is not blank and its - // encryption status is used for the volume encryption status. - BlockDeviceMappings []*BlockDeviceMapping + // The ID of the RAM disk. + RamdiskId *string - // The IAM instance profile. - IamInstanceProfile *IamInstanceProfileSpecification + // One or more security group IDs. + SecurityGroupIds []*string - // The ID of the kernel. - KernelId *string + // One or more security groups. When requesting instances in a VPC, you must + // specify the IDs of the security groups. When requesting instances in + // EC2-Classic, you can specify the names or the IDs of the security groups. + SecurityGroups []*string // The IDs of the subnets in which to launch the instance. To specify multiple // subnets, separate them using commas; for example, "subnet-1234abcdeexample1, // subnet-0987cdef6example2". SubnetId *string - // Deprecated. - AddressingType *string + // The Base64-encoded user data for the instance. User data is limited to 16 KB. + UserData *string } // Describes a reservation. @@ -6603,15 +6603,15 @@ type Reservation struct { // The instances. Instances []*Instance + // The ID of the AWS account that owns the reservation. + OwnerId *string + // The ID of the requester that launched the instances on your behalf (for example, // AWS Management Console or Auto Scaling). RequesterId *string // The ID of the reservation. ReservationId *string - - // The ID of the AWS account that owns the reservation. - OwnerId *string } // The cost associated with the Reserved Instance. @@ -6620,115 +6620,115 @@ type ReservationValue struct { // The hourly rate of the reservation. HourlyPrice *string - // The remaining upfront cost of the reservation. - RemainingUpfrontValue *string - // The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * // number of hours remaining). RemainingTotalValue *string + + // The remaining upfront cost of the reservation. + RemainingUpfrontValue *string } // Describes the limit price of a Reserved Instance offering. type ReservedInstanceLimitPrice struct { - // The currency in which the limitPrice amount is specified. At this time, the only - // supported currency is USD. - CurrencyCode CurrencyCodeValues - // Used for Reserved Instance Marketplace offerings. Specifies the limit price on // the total order (instanceCount * price). Amount *float64 + + // The currency in which the limitPrice amount is specified. At this time, the only + // supported currency is USD. + CurrencyCode CurrencyCodeValues } // The total value of the Convertible Reserved Instance. type ReservedInstanceReservationValue struct { - // The ID of the Convertible Reserved Instance that you are exchanging. - ReservedInstanceId *string - // The total value of the Convertible Reserved Instance that you are exchanging. ReservationValue *ReservationValue + + // The ID of the Convertible Reserved Instance that you are exchanging. + ReservedInstanceId *string } // Describes a Reserved Instance. type ReservedInstances struct { - // The tenancy of the instance. - InstanceTenancy Tenancy - - // Any tags assigned to the resource. - Tags []*Tag - // The Availability Zone in which the Reserved Instance can be used. AvailabilityZone *string - // The state of the Reserved Instance purchase. - State ReservedInstanceState - - // The usage price of the Reserved Instance, per hour. - UsagePrice *float32 - - // The ID of the Reserved Instance. - ReservedInstancesId *string + // The currency of the Reserved Instance. It's specified using ISO 4217 standard + // currency codes. At this time, the only supported currency is USD. + CurrencyCode CurrencyCodeValues // The duration of the Reserved Instance, in seconds. Duration *int64 - // The scope of the Reserved Instance. - Scope Scope - // The time when the Reserved Instance expires. End *time.Time - // The offering class of the Reserved Instance. - OfferingClass OfferingClassType + // The purchase price of the Reserved Instance. + FixedPrice *float32 - // The date and time the Reserved Instance started. - Start *time.Time + // The number of reservations purchased. + InstanceCount *int32 - // The currency of the Reserved Instance. It's specified using ISO 4217 standard - // currency codes. At this time, the only supported currency is USD. - CurrencyCode CurrencyCodeValues + // The tenancy of the instance. + InstanceTenancy Tenancy + + // The instance type on which the Reserved Instance can be used. + InstanceType InstanceType + + // The offering class of the Reserved Instance. + OfferingClass OfferingClassType // The Reserved Instance offering type. OfferingType OfferingTypeValues + // The Reserved Instance product platform description. + ProductDescription RIProductDescription + // The recurring charge tag assigned to the resource. RecurringCharges []*RecurringCharge - // The purchase price of the Reserved Instance. - FixedPrice *float32 + // The ID of the Reserved Instance. + ReservedInstancesId *string - // The Reserved Instance product platform description. - ProductDescription RIProductDescription + // The scope of the Reserved Instance. + Scope Scope - // The number of reservations purchased. - InstanceCount *int32 + // The date and time the Reserved Instance started. + Start *time.Time - // The instance type on which the Reserved Instance can be used. - InstanceType InstanceType + // The state of the Reserved Instance purchase. + State ReservedInstanceState + + // Any tags assigned to the resource. + Tags []*Tag + + // The usage price of the Reserved Instance, per hour. + UsagePrice *float32 } // Describes the configuration settings for the modified Reserved Instances. type ReservedInstancesConfiguration struct { - // The network platform of the modified Reserved Instances, which is either - // EC2-Classic or EC2-VPC. - Platform *string + // The Availability Zone for the modified Reserved Instances. + AvailabilityZone *string + + // The number of modified Reserved Instances. This is a required field for a + // request. + InstanceCount *int32 // The instance type for the modified Reserved Instances. InstanceType InstanceType + // The network platform of the modified Reserved Instances, which is either + // EC2-Classic or EC2-VPC. + Platform *string + // Whether the Reserved Instance is applied to instances in a Region or instances // in a specific Availability Zone. Scope Scope - - // The number of modified Reserved Instances. This is a required field for a - // request. - InstanceCount *int32 - - // The Availability Zone for the modified Reserved Instances. - AvailabilityZone *string } // Describes the ID of a Reserved Instance. @@ -6741,70 +6741,70 @@ type ReservedInstancesId struct { // Describes a Reserved Instance listing. type ReservedInstancesListing struct { - // The reason for the current status of the Reserved Instance listing. The response - // can be blank. - StatusMessage *string - - // The number of instances in this state. - InstanceCounts []*InstanceCount - // A unique, case-sensitive key supplied by the client to ensure that the request // is idempotent. For more information, see Ensuring Idempotency // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). ClientToken *string + // The time the listing was created. + CreateDate *time.Time + + // The number of instances in this state. + InstanceCounts []*InstanceCount + + // The price of the Reserved Instance listing. + PriceSchedules []*PriceSchedule + // The ID of the Reserved Instance. ReservedInstancesId *string - // The last modified timestamp of the listing. - UpdateDate *time.Time + // The ID of the Reserved Instance listing. + ReservedInstancesListingId *string // The status of the Reserved Instance listing. Status ListingStatus + // The reason for the current status of the Reserved Instance listing. The response + // can be blank. + StatusMessage *string + // Any tags assigned to the resource. Tags []*Tag - // The time the listing was created. - CreateDate *time.Time - - // The price of the Reserved Instance listing. - PriceSchedules []*PriceSchedule - - // The ID of the Reserved Instance listing. - ReservedInstancesListingId *string + // The last modified timestamp of the listing. + UpdateDate *time.Time } // Describes a Reserved Instance modification. type ReservedInstancesModification struct { - // The IDs of one or more Reserved Instances. - ReservedInstancesIds []*ReservedInstancesId - - // The status of the Reserved Instances modification request. - Status *string - // A unique, case-sensitive key supplied by the client to ensure that the request // is idempotent. For more information, see Ensuring Idempotency // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). ClientToken *string - // Contains target configurations along with their corresponding new Reserved - // Instance IDs. - ModificationResults []*ReservedInstancesModificationResult + // The time when the modification request was created. + CreateDate *time.Time // The time for the modification to become effective. EffectiveDate *time.Time - // The reason for the status. - StatusMessage *string + // Contains target configurations along with their corresponding new Reserved + // Instance IDs. + ModificationResults []*ReservedInstancesModificationResult - // The time when the modification request was created. - CreateDate *time.Time + // The IDs of one or more Reserved Instances. + ReservedInstancesIds []*ReservedInstancesId // A unique ID for the Reserved Instance modification. ReservedInstancesModificationId *string + // The status of the Reserved Instances modification request. + Status *string + + // The reason for the status. + StatusMessage *string + // The time when the modification request was last updated. UpdateDate *time.Time } @@ -6812,13 +6812,13 @@ type ReservedInstancesModification struct { // Describes the modification request/s. type ReservedInstancesModificationResult struct { - // The target Reserved Instances configurations supplied as part of the - // modification request. - TargetConfiguration *ReservedInstancesConfiguration - // The ID for the Reserved Instances that were created as part of the modification // request. This field is only available when the modification is fulfilled. ReservedInstancesId *string + + // The target Reserved Instances configurations supplied as part of the + // modification request. + TargetConfiguration *ReservedInstancesConfiguration } // Describes a Reserved Instance offering. @@ -6827,6 +6827,28 @@ type ReservedInstancesOffering struct { // The Availability Zone in which the Reserved Instance can be used. AvailabilityZone *string + // The currency of the Reserved Instance offering you are purchasing. It's + // specified using ISO 4217 standard currency codes. At this time, the only + // supported currency is USD. + CurrencyCode CurrencyCodeValues + + // The duration of the Reserved Instance, in seconds. + Duration *int64 + + // The purchase price of the Reserved Instance. + FixedPrice *float32 + + // The tenancy of the instance. + InstanceTenancy Tenancy + + // The instance type on which the Reserved Instance can be used. + InstanceType InstanceType + + // Indicates whether the offering is available through the Reserved Instance + // Marketplace (resale) or AWS. If it's a Reserved Instance Marketplace offering, + // this is true. + Marketplace *bool + // If convertible it can be exchanged for Reserved Instances of the same or higher // monetary value, with different configurations. If standard, it is not possible // to perform an exchange. @@ -6835,47 +6857,25 @@ type ReservedInstancesOffering struct { // The Reserved Instance offering type. OfferingType OfferingTypeValues - // The Reserved Instance product platform description. - ProductDescription RIProductDescription - // The pricing details of the Reserved Instance offering. PricingDetails []*PricingDetail + // The Reserved Instance product platform description. + ProductDescription RIProductDescription + // The recurring charge tag assigned to the resource. RecurringCharges []*RecurringCharge - // Indicates whether the offering is available through the Reserved Instance - // Marketplace (resale) or AWS. If it's a Reserved Instance Marketplace offering, - // this is true. - Marketplace *bool + // The ID of the Reserved Instance offering. This is the offering ID used in + // GetReservedInstancesExchangeQuote () to confirm that an exchange can be made. + ReservedInstancesOfferingId *string // Whether the Reserved Instance is applied to instances in a Region or an // Availability Zone. Scope Scope - // The tenancy of the instance. - InstanceTenancy Tenancy - // The usage price of the Reserved Instance, per hour. UsagePrice *float32 - - // The duration of the Reserved Instance, in seconds. - Duration *int64 - - // The instance type on which the Reserved Instance can be used. - InstanceType InstanceType - - // The purchase price of the Reserved Instance. - FixedPrice *float32 - - // The currency of the Reserved Instance offering you are purchasing. It's - // specified using ISO 4217 standard currency codes. At this time, the only - // supported currency is USD. - CurrencyCode CurrencyCodeValues - - // The ID of the Reserved Instance offering. This is the offering ID used in - // GetReservedInstancesExchangeQuote () to confirm that an exchange can be made. - ReservedInstancesOfferingId *string } // Describes the error that's returned when you cannot delete a launch template @@ -6892,18 +6892,33 @@ type ResponseError struct { // The information for a launch template. type ResponseLaunchTemplateData struct { - // The user data for the instance. - UserData *string + // The block device mappings. + BlockDeviceMappings []*LaunchTemplateBlockDeviceMapping // Information about the Capacity Reservation targeting option. CapacityReservationSpecification *LaunchTemplateCapacityReservationSpecificationResponse - // The security group IDs. - SecurityGroupIds []*string + // The CPU options for the instance. For more information, see Optimizing CPU + // Options + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) + // in the Amazon Elastic Compute Cloud User Guide. + CpuOptions *LaunchTemplateCpuOptions - // Indicates whether an instance stops or terminates when you initiate shutdown - // from the instance (using the operating system command for system shutdown). - InstanceInitiatedShutdownBehavior ShutdownBehavior + // The credit option for CPU usage of the instance. + CreditSpecification *CreditSpecification + + // If set to true, indicates that the instance cannot be terminated using the + // Amazon EC2 console, command line tool, or API. + DisableApiTermination *bool + + // Indicates whether the instance is optimized for Amazon EBS I/O. + EbsOptimized *bool + + // The elastic GPU specification. + ElasticGpuSpecifications []*ElasticGpuSpecificationResponse + + // The elastic inference accelerator for the instance. + ElasticInferenceAccelerators []*LaunchTemplateElasticInferenceAcceleratorResponse // Indicates whether an instance is configured for hibernation. For more // information, see Hibernate Your Instance @@ -6911,96 +6926,94 @@ type ResponseLaunchTemplateData struct { // Amazon Elastic Compute Cloud User Guide. HibernationOptions *LaunchTemplateHibernationOptions - // The ID of the kernel, if applicable. - KernelId *string + // The IAM instance profile. + IamInstanceProfile *LaunchTemplateIamInstanceProfileSpecification - // The ID of the RAM disk, if applicable. - RamDiskId *string + // The ID of the AMI that was used to launch the instance. + ImageId *string - // If set to true, indicates that the instance cannot be terminated using the - // Amazon EC2 console, command line tool, or API. - DisableApiTermination *bool + // Indicates whether an instance stops or terminates when you initiate shutdown + // from the instance (using the operating system command for system shutdown). + InstanceInitiatedShutdownBehavior ShutdownBehavior // The market (purchasing) option for the instances. InstanceMarketOptions *LaunchTemplateInstanceMarketOptions + // The instance type. + InstanceType InstanceType + + // The ID of the kernel, if applicable. + KernelId *string + + // The name of the key pair. + KeyName *string + + // The license configurations. + LicenseSpecifications []*LaunchTemplateLicenseConfiguration + // The metadata options for the instance. For more information, see Instance // Metadata and User Data // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) // in the Amazon Elastic Compute Cloud User Guide. MetadataOptions *LaunchTemplateInstanceMetadataOptions - // The placement of the instance. - Placement *LaunchTemplatePlacement + // The monitoring for the instance. + Monitoring *LaunchTemplatesMonitoring // The network interfaces. NetworkInterfaces []*LaunchTemplateInstanceNetworkInterfaceSpecification - // The security group names. - SecurityGroups []*string + // The placement of the instance. + Placement *LaunchTemplatePlacement - // The monitoring for the instance. - Monitoring *LaunchTemplatesMonitoring + // The ID of the RAM disk, if applicable. + RamDiskId *string - // The ID of the AMI that was used to launch the instance. - ImageId *string + // The security group IDs. + SecurityGroupIds []*string + + // The security group names. + SecurityGroups []*string // The tags. TagSpecifications []*LaunchTemplateTagSpecification - // The license configurations. - LicenseSpecifications []*LaunchTemplateLicenseConfiguration - - // Indicates whether the instance is optimized for Amazon EBS I/O. - EbsOptimized *bool - - // The instance type. - InstanceType InstanceType + // The user data for the instance. + UserData *string +} - // The credit option for CPU usage of the instance. - CreditSpecification *CreditSpecification +// Describes a route in a route table. +type Route struct { - // The name of the key pair. - KeyName *string + // The IPv4 CIDR block used for the destination match. + DestinationCidrBlock *string - // The block device mappings. - BlockDeviceMappings []*LaunchTemplateBlockDeviceMapping + // The IPv6 CIDR block used for the destination match. + DestinationIpv6CidrBlock *string - // The elastic inference accelerator for the instance. - ElasticInferenceAccelerators []*LaunchTemplateElasticInferenceAcceleratorResponse + // The prefix of the AWS service. + DestinationPrefixListId *string - // The IAM instance profile. - IamInstanceProfile *LaunchTemplateIamInstanceProfileSpecification + // The ID of the egress-only internet gateway. + EgressOnlyInternetGatewayId *string - // The elastic GPU specification. - ElasticGpuSpecifications []*ElasticGpuSpecificationResponse + // The ID of a gateway attached to your VPC. + GatewayId *string - // The CPU options for the instance. For more information, see Optimizing CPU - // Options - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) - // in the Amazon Elastic Compute Cloud User Guide. - CpuOptions *LaunchTemplateCpuOptions -} + // The ID of a NAT instance in your VPC. + InstanceId *string -// Describes a route in a route table. -type Route struct { + // The AWS account ID of the owner of the instance. + InstanceOwnerId *string // The ID of the local gateway. LocalGatewayId *string - // The IPv6 CIDR block used for the destination match. - DestinationIpv6CidrBlock *string - - // The state of the route. The blackhole state indicates that the route's target - // isn't available (for example, the specified gateway isn't attached to the VPC, - // or the specified NAT instance has been terminated). - State RouteState - - // The ID of a transit gateway. - TransitGatewayId *string + // The ID of a NAT gateway. + NatGatewayId *string - // The ID of the egress-only internet gateway. - EgressOnlyInternetGatewayId *string + // The ID of the network interface. + NetworkInterfaceId *string // Describes how the route was created. // @@ -7014,54 +7027,41 @@ type Route struct { // The route was propagated by route propagation. Origin RouteOrigin - // The IPv4 CIDR block used for the destination match. - DestinationCidrBlock *string + // The state of the route. The blackhole state indicates that the route's target + // isn't available (for example, the specified gateway isn't attached to the VPC, + // or the specified NAT instance has been terminated). + State RouteState - // The ID of a gateway attached to your VPC. - GatewayId *string + // The ID of a transit gateway. + TransitGatewayId *string // The ID of a VPC peering connection. VpcPeeringConnectionId *string - - // The AWS account ID of the owner of the instance. - InstanceOwnerId *string - - // The ID of the network interface. - NetworkInterfaceId *string - - // The prefix of the AWS service. - DestinationPrefixListId *string - - // The ID of a NAT gateway. - NatGatewayId *string - - // The ID of a NAT instance in your VPC. - InstanceId *string } // Describes a route table. type RouteTable struct { - // The ID of the VPC. - VpcId *string + // The associations between the route table and one or more subnets or a gateway. + Associations []*RouteTableAssociation + + // The ID of the AWS account that owns the route table. + OwnerId *string + + // Any virtual private gateway (VGW) propagating routes. + PropagatingVgws []*PropagatingVgw // The ID of the route table. RouteTableId *string - // The associations between the route table and one or more subnets or a gateway. - Associations []*RouteTableAssociation - // The routes in the route table. Routes []*Route // Any tags assigned to the route table. Tags []*Tag - // Any virtual private gateway (VGW) propagating routes. - PropagatingVgws []*PropagatingVgw - - // The ID of the AWS account that owns the route table. - OwnerId *string + // The ID of the VPC. + VpcId *string } // Describes an association between a route table and a subnet or gateway. @@ -7070,31 +7070,31 @@ type RouteTableAssociation struct { // The state of the association. AssociationState *RouteTableAssociationState - // The ID of the subnet. A subnet ID is not returned for an implicit association. - SubnetId *string + // The ID of the internet gateway or virtual private gateway. + GatewayId *string // Indicates whether this is the main route table. Main *bool - // The ID of the internet gateway or virtual private gateway. - GatewayId *string + // The ID of the association. + RouteTableAssociationId *string // The ID of the route table. RouteTableId *string - // The ID of the association. - RouteTableAssociationId *string + // The ID of the subnet. A subnet ID is not returned for an implicit association. + SubnetId *string } // Describes the state of an association between a route table and a subnet or // gateway. type RouteTableAssociationState struct { - // The status message, if applicable. - StatusMessage *string - // The state of the association. State RouteTableAssociationStateCode + + // The status message, if applicable. + StatusMessage *string } // Describes the monitoring of an instance. @@ -7111,75 +7111,75 @@ type RunInstancesMonitoringEnabled struct { // store-backed AMI. type S3Storage struct { - // The beginning of the file name of the AMI. - Prefix *string - - // The signature of the JSON document. - UploadPolicySignature *string - - // An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into - // Amazon S3 on your behalf. - UploadPolicy []byte + // The access key ID of the owner of the bucket. Before you specify a value for + // your access key ID, review and follow the guidance in Best Practices for + // Managing AWS Access Keys + // (https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html). + AWSAccessKeyId *string // The bucket in which to store the AMI. You can specify a bucket that you already // own or a new bucket that Amazon EC2 creates on your behalf. If you specify a // bucket that belongs to someone else, Amazon EC2 returns an error. Bucket *string - // The access key ID of the owner of the bucket. Before you specify a value for - // your access key ID, review and follow the guidance in Best Practices for - // Managing AWS Access Keys - // (https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html). - AWSAccessKeyId *string + // The beginning of the file name of the AMI. + Prefix *string + + // An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into + // Amazon S3 on your behalf. + UploadPolicy []byte + + // The signature of the JSON document. + UploadPolicySignature *string } // Describes a Scheduled Instance. type ScheduledInstance struct { - // The number of instances. - InstanceCount *int32 + // The Availability Zone. + AvailabilityZone *string - // The total number of hours for a single instance for the entire term. - TotalScheduledInstanceHours *int32 + // The date when the Scheduled Instance was purchased. + CreateDate *time.Time - // The start date for the Scheduled Instance. - TermStartDate *time.Time + // The hourly price for a single instance. + HourlyPrice *string + + // The number of instances. + InstanceCount *int32 // The instance type. InstanceType *string - // The end date for the Scheduled Instance. - TermEndDate *time.Time - // The network platform (EC2-Classic or EC2-VPC). NetworkPlatform *string - // The number of hours in the schedule. - SlotDurationInHours *int32 - - // The time that the previous schedule ended or will end. - PreviousSlotEndTime *time.Time + // The time for the next schedule to start. + NextSlotStartTime *time.Time // The platform (Linux/UNIX or Windows). Platform *string + // The time that the previous schedule ended or will end. + PreviousSlotEndTime *time.Time + // The schedule recurrence. Recurrence *ScheduledInstanceRecurrence - // The Availability Zone. - AvailabilityZone *string - // The Scheduled Instance ID. ScheduledInstanceId *string - // The date when the Scheduled Instance was purchased. - CreateDate *time.Time + // The number of hours in the schedule. + SlotDurationInHours *int32 - // The time for the next schedule to start. - NextSlotStartTime *time.Time + // The end date for the Scheduled Instance. + TermEndDate *time.Time - // The hourly price for a single instance. - HourlyPrice *string + // The start date for the Scheduled Instance. + TermStartDate *time.Time + + // The total number of hours for a single instance for the entire term. + TotalScheduledInstanceHours *int32 } // Describes a schedule that is available for your Scheduled Instances. @@ -7188,41 +7188,41 @@ type ScheduledInstanceAvailability struct { // The Availability Zone. AvailabilityZone *string - // The minimum term. The only possible value is 365 days. - MinTermDurationInDays *int32 + // The number of available instances. + AvailableInstanceCount *int32 - // The number of hours in the schedule. - SlotDurationInHours *int32 + // The time period for the first schedule to start. + FirstSlotStartTime *time.Time - // The purchase token. This token expires in two hours. - PurchaseToken *string + // The hourly price for a single instance. + HourlyPrice *string + + // The instance type. You can specify one of the C3, C4, M4, or R3 instance types. + InstanceType *string // The maximum term. The only possible value is 365 days. MaxTermDurationInDays *int32 - // The platform (Linux/UNIX or Windows). - Platform *string - - // The number of available instances. - AvailableInstanceCount *int32 + // The minimum term. The only possible value is 365 days. + MinTermDurationInDays *int32 // The network platform (EC2-Classic or EC2-VPC). NetworkPlatform *string - // The total number of hours for a single instance for the entire term. - TotalScheduledInstanceHours *int32 + // The platform (Linux/UNIX or Windows). + Platform *string - // The time period for the first schedule to start. - FirstSlotStartTime *time.Time + // The purchase token. This token expires in two hours. + PurchaseToken *string // The schedule recurrence. Recurrence *ScheduledInstanceRecurrence - // The hourly price for a single instance. - HourlyPrice *string + // The number of hours in the schedule. + SlotDurationInHours *int32 - // The instance type. You can specify one of the C3, C4, M4, or R3 instance types. - InstanceType *string + // The total number of hours for a single instance for the entire term. + TotalScheduledInstanceHours *int32 } // Describes the recurring schedule for a Scheduled Instance. @@ -7231,26 +7231,29 @@ type ScheduledInstanceRecurrence struct { // The frequency (Daily, Weekly, or Monthly). Frequency *string - // The unit for occurrenceDaySet (DayOfWeek or DayOfMonth). - OccurrenceUnit *string - - // Indicates whether the occurrence is relative to the end of the specified week or - // month. - OccurrenceRelativeToEnd *bool + // The interval quantity. The interval unit depends on the value of frequency. For + // example, every 2 weeks or every 2 months. + Interval *int32 // The days. For a monthly schedule, this is one or more days of the month (1-31). // For a weekly schedule, this is one or more days of the week (1-7, where 1 is // Sunday). OccurrenceDaySet []*int32 - // The interval quantity. The interval unit depends on the value of frequency. For - // example, every 2 weeks or every 2 months. - Interval *int32 + // Indicates whether the occurrence is relative to the end of the specified week or + // month. + OccurrenceRelativeToEnd *bool + + // The unit for occurrenceDaySet (DayOfWeek or DayOfMonth). + OccurrenceUnit *string } // Describes the recurring schedule for a Scheduled Instance. type ScheduledInstanceRecurrenceRequest struct { + // The frequency (Daily, Weekly, or Monthly). + Frequency *string + // The interval quantity. The interval unit depends on the value of Frequency. For // example, every 2 weeks or every 2 months. Interval *int32 @@ -7261,28 +7264,28 @@ type ScheduledInstanceRecurrenceRequest struct { // is relative to the end of the month, you can specify only a single day. OccurrenceDays []*int32 - // The frequency (Daily, Weekly, or Monthly). - Frequency *string + // Indicates whether the occurrence is relative to the end of the specified week or + // month. You can't specify this value with a daily schedule. + OccurrenceRelativeToEnd *bool // The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required // for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You // can't specify this value with a daily schedule. OccurrenceUnit *string - - // Indicates whether the occurrence is relative to the end of the specified week or - // month. You can't specify this value with a daily schedule. - OccurrenceRelativeToEnd *bool } // Describes a block device mapping for a Scheduled Instance. type ScheduledInstancesBlockDeviceMapping struct { + // The device name (for example, /dev/sdh or xvdh). + DeviceName *string + // Parameters used to set up EBS volumes automatically when the instance is // launched. Ebs *ScheduledInstancesEbs - // The device name (for example, /dev/sdh or xvdh). - DeviceName *string + // Suppresses the specified device included in the block device mapping of the AMI. + NoDevice *string // The virtual device name (ephemeralN). Instance store volumes are numbered // starting from 0. An instance type with two available instance store volumes can @@ -7293,25 +7296,18 @@ type ScheduledInstancesBlockDeviceMapping struct { // launch an M3 instance, we ignore any instance store volumes specified in the // block device mapping for the AMI. VirtualName *string - - // Suppresses the specified device included in the block device mapping of the AMI. - NoDevice *string } // Describes an EBS volume for a Scheduled Instance. type ScheduledInstancesEbs struct { + // Indicates whether the volume is deleted on instance termination. + DeleteOnTermination *bool + // Indicates whether the volume is encrypted. You can attached encrypted volumes // only to instances that support them. Encrypted *bool - // The size of the volume, in GiB. Default: If you're creating the volume from a - // snapshot and don't specify a volume size, the default is the snapshot size. - VolumeSize *int32 - - // Indicates whether the volume is deleted on instance termination. - DeleteOnTermination *bool - // The number of I/O operations per second (IOPS) that the volume supports. For io1 // volumes, this represents the number of IOPS that are provisioned for the volume. // For gp2 volumes, this represents the baseline performance of the volume and the @@ -7325,13 +7321,17 @@ type ScheduledInstancesEbs struct { // gp2, st1, sc1, or standard volumes. Iops *int32 + // The ID of the snapshot. + SnapshotId *string + + // The size of the volume, in GiB. Default: If you're creating the volume from a + // snapshot and don't specify a volume size, the default is the snapshot size. + VolumeSize *int32 + // The volume type. gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, // Throughput Optimized HDD for st1, Cold HDD for sc1, or standard for Magnetic. // Default: gp2 VolumeType *string - - // The ID of the snapshot. - SnapshotId *string } // Describes an IAM instance profile for a Scheduled Instance. @@ -7356,6 +7356,14 @@ type ScheduledInstancesIpv6Address struct { // subnet. You can specify the subnet using either SubnetId or NetworkInterface. type ScheduledInstancesLaunchSpecification struct { + // The ID of the Amazon Machine Image (AMI). + // + // This member is required. + ImageId *string + + // The block device mapping entries. + BlockDeviceMappings []*ScheduledInstancesBlockDeviceMapping + // Indicates whether the instances are optimized for EBS I/O. This optimization // provides dedicated throughput to Amazon EBS and an optimized configuration stack // to provide optimal EBS I/O performance. This optimization isn't available with @@ -7363,43 +7371,35 @@ type ScheduledInstancesLaunchSpecification struct { // instance. Default: false EbsOptimized *bool - // Enable or disable monitoring for the instances. - Monitoring *ScheduledInstancesMonitoring - - // The ID of the RAM disk. - RamdiskId *string - - // The placement information. - Placement *ScheduledInstancesPlacement - // The IAM instance profile. IamInstanceProfile *ScheduledInstancesIamInstanceProfile // The instance type. InstanceType *string - // The IDs of the security groups. - SecurityGroupIds []*string - // The ID of the kernel. KernelId *string - // The ID of the subnet in which to launch the instances. - SubnetId *string + // The name of the key pair. + KeyName *string - // The block device mapping entries. - BlockDeviceMappings []*ScheduledInstancesBlockDeviceMapping + // Enable or disable monitoring for the instances. + Monitoring *ScheduledInstancesMonitoring // The network interfaces. NetworkInterfaces []*ScheduledInstancesNetworkInterface - // The name of the key pair. - KeyName *string + // The placement information. + Placement *ScheduledInstancesPlacement - // The ID of the Amazon Machine Image (AMI). - // - // This member is required. - ImageId *string + // The ID of the RAM disk. + RamdiskId *string + + // The IDs of the security groups. + SecurityGroupIds []*string + + // The ID of the subnet in which to launch the instances. + SubnetId *string // The base64-encoded MIME user data. UserData *string @@ -7415,21 +7415,6 @@ type ScheduledInstancesMonitoring struct { // Describes a network interface for a Scheduled Instance. type ScheduledInstancesNetworkInterface struct { - // The IDs of the security groups. - Groups []*string - - // The IPv4 address of the network interface within the subnet. - PrivateIpAddress *string - - // The index of the device for the network interface attachment. - DeviceIndex *int32 - - // The private IPv4 addresses. - PrivateIpAddressConfigs []*ScheduledInstancesPrivateIpAddressConfig - - // Indicates whether to delete the interface when the instance is terminated. - DeleteOnTermination *bool - // Indicates whether to assign a public IPv4 address to instances launched in a // VPC. The public IPv4 address can only be assigned to a network interface for // eth0, and can only be assigned to a new network interface, not an existing one. @@ -7437,24 +7422,39 @@ type ScheduledInstancesNetworkInterface struct { // into a default subnet, the default value is true. AssociatePublicIpAddress *bool - // The ID of the network interface. - NetworkInterfaceId *string - - // The specific IPv6 addresses from the subnet range. - Ipv6Addresses []*ScheduledInstancesIpv6Address - - // The ID of the subnet. - SubnetId *string + // Indicates whether to delete the interface when the instance is terminated. + DeleteOnTermination *bool // The description. Description *string + // The index of the device for the network interface attachment. + DeviceIndex *int32 + + // The IDs of the security groups. + Groups []*string + // The number of IPv6 addresses to assign to the network interface. The IPv6 // addresses are automatically selected from the subnet range. Ipv6AddressCount *int32 + // The specific IPv6 addresses from the subnet range. + Ipv6Addresses []*ScheduledInstancesIpv6Address + + // The ID of the network interface. + NetworkInterfaceId *string + + // The IPv4 address of the network interface within the subnet. + PrivateIpAddress *string + + // The private IPv4 addresses. + PrivateIpAddressConfigs []*ScheduledInstancesPrivateIpAddressConfig + // The number of secondary private IPv4 addresses. SecondaryPrivateIpAddressCount *int32 + + // The ID of the subnet. + SubnetId *string } // Describes the placement for a Scheduled Instance. @@ -7470,50 +7470,50 @@ type ScheduledInstancesPlacement struct { // Describes a private IPv4 address for a Scheduled Instance. type ScheduledInstancesPrivateIpAddressConfig struct { - // The IPv4 address. - PrivateIpAddress *string - // Indicates whether this is a primary IPv4 address. Otherwise, this is a secondary // IPv4 address. Primary *bool -} - -// Describes a security group -type SecurityGroup struct { - - // [VPC only] The outbound rules associated with the security group. - IpPermissionsEgress []*IpPermission - // The name of the security group. - GroupName *string + // The IPv4 address. + PrivateIpAddress *string +} - // [VPC only] The ID of the VPC for the security group. - VpcId *string +// Describes a security group +type SecurityGroup struct { - // Any tags assigned to the security group. - Tags []*Tag + // A description of the security group. + Description *string // The ID of the security group. GroupId *string + // The name of the security group. + GroupName *string + // The inbound rules associated with the security group. IpPermissions []*IpPermission + // [VPC only] The outbound rules associated with the security group. + IpPermissionsEgress []*IpPermission + // The AWS account ID of the owner of the security group. OwnerId *string - // A description of the security group. - Description *string + // Any tags assigned to the security group. + Tags []*Tag + + // [VPC only] The ID of the VPC for the security group. + VpcId *string } // Describes a security group. type SecurityGroupIdentifier struct { - // The name of the security group. - GroupName *string - // The ID of the security group. GroupId *string + + // The name of the security group. + GroupName *string } // Describes a VPC with a security group that references your security group. @@ -7532,50 +7532,54 @@ type SecurityGroupReference struct { // Describes a service configuration for a VPC endpoint service. type ServiceConfiguration struct { + // Indicates whether requests from other AWS accounts to create an endpoint to the + // service must first be accepted. + AcceptanceRequired *bool + + // The Availability Zones in which the service is available. + AvailabilityZones []*string + + // The DNS names for the service. + BaseEndpointDnsNames []*string + // Indicates whether the service manages its VPC endpoints. Management of the // service VPC endpoints using the VPC endpoint API is restricted. ManagesVpcEndpoints *bool + // The Amazon Resource Names (ARNs) of the Network Load Balancers for the service. + NetworkLoadBalancerArns []*string + // The private DNS name for the service. PrivateDnsName *string - // The DNS names for the service. - BaseEndpointDnsNames []*string + // Information about the endpoint service private DNS name configuration. + PrivateDnsNameConfiguration *PrivateDnsNameConfiguration // The ID of the service. ServiceId *string - // The type of service. - ServiceType []*ServiceTypeDetail - - // Any tags assigned to the service. - Tags []*Tag - // The name of the service. ServiceName *string - // Information about the endpoint service private DNS name configuration. - PrivateDnsNameConfiguration *PrivateDnsNameConfiguration - // The service state. ServiceState ServiceState - // The Availability Zones in which the service is available. - AvailabilityZones []*string - - // The Amazon Resource Names (ARNs) of the Network Load Balancers for the service. - NetworkLoadBalancerArns []*string + // The type of service. + ServiceType []*ServiceTypeDetail - // Indicates whether requests from other AWS accounts to create an endpoint to the - // service must first be accepted. - AcceptanceRequired *bool + // Any tags assigned to the service. + Tags []*Tag } // Describes a VPC endpoint service. type ServiceDetail struct { - // Indicates whether the service supports endpoint policies. - VpcEndpointPolicySupported *bool + // Indicates whether VPC endpoint connection requests to the service must be + // accepted by the service owner. + AcceptanceRequired *bool + + // The Availability Zones in which the service is available. + AvailabilityZones []*string // The DNS names for the service. BaseEndpointDnsNames []*string @@ -7584,34 +7588,30 @@ type ServiceDetail struct { // service VPC endpoints using the VPC endpoint API is restricted. ManagesVpcEndpoints *bool - // The type of service. - ServiceType []*ServiceTypeDetail + // The AWS account ID of the service owner. + Owner *string + + // The private DNS name for the service. + PrivateDnsName *string // The verification state of the VPC endpoint service. Consumers of the endpoint // service cannot use the private name when the state is not verified. PrivateDnsNameVerificationState DnsNameState + // The ID of the endpoint service. + ServiceId *string + // The Amazon Resource Name (ARN) of the service. ServiceName *string + // The type of service. + ServiceType []*ServiceTypeDetail + // Any tags assigned to the service. Tags []*Tag - // The Availability Zones in which the service is available. - AvailabilityZones []*string - - // The ID of the endpoint service. - ServiceId *string - - // Indicates whether VPC endpoint connection requests to the service must be - // accepted by the service owner. - AcceptanceRequired *bool - - // The private DNS name for the service. - PrivateDnsName *string - - // The AWS account ID of the service owner. - Owner *string + // Indicates whether the service supports endpoint policies. + VpcEndpointPolicySupported *bool } // Describes the type of service for a VPC endpoint. @@ -7651,11 +7651,24 @@ type SlotStartTimeRangeRequest struct { // Describes a snapshot. type Snapshot struct { - // The AWS account ID of the EBS snapshot owner. - OwnerId *string + // The data encryption key identifier for the snapshot. This value is a unique + // identifier that corresponds to the data encryption key that was used to encrypt + // the original volume or snapshot copy. Because data encryption keys are inherited + // by volumes created from snapshots, and vice versa, if snapshots share the same + // data encryption key identifier, then they belong to the same volume/snapshot + // lineage. This parameter is only returned by DescribeSnapshots (). + DataEncryptionKeyId *string - // The size of the volume, in GiB. - VolumeSize *int32 + // The description for the snapshot. + Description *string + + // Indicates whether the snapshot is encrypted. + Encrypted *bool + + // The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) + // customer master key (CMK) that was used to protect the volume encryption key for + // the parent volume. + KmsKeyId *string // The AWS owner alias, as maintained by Amazon. The possible values are: amazon | // self | all | aws-marketplace | microsoft. This AWS owner alias is not to be @@ -7663,14 +7676,21 @@ type Snapshot struct { // console. OwnerAlias *string + // The AWS account ID of the EBS snapshot owner. + OwnerId *string + + // The progress of the snapshot, as a percentage. + Progress *string + // The ID of the snapshot. Each snapshot receives a unique identifier when it is // created. SnapshotId *string - // The ID of the volume that was used to create the snapshot. Snapshots created by - // the CopySnapshot () action have an arbitrary volume ID that should not be used - // for any purpose. - VolumeId *string + // The time stamp when the snapshot was initiated. + StartTime *time.Time + + // The snapshot state. + State SnapshotState // Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy // operation fails (for example, if the proper AWS Key Management Service (AWS KMS) @@ -7679,70 +7699,50 @@ type Snapshot struct { // DescribeSnapshots (). StateMessage *string - // Indicates whether the snapshot is encrypted. - Encrypted *bool - // Any tags assigned to the snapshot. Tags []*Tag - // The data encryption key identifier for the snapshot. This value is a unique - // identifier that corresponds to the data encryption key that was used to encrypt - // the original volume or snapshot copy. Because data encryption keys are inherited - // by volumes created from snapshots, and vice versa, if snapshots share the same - // data encryption key identifier, then they belong to the same volume/snapshot - // lineage. This parameter is only returned by DescribeSnapshots (). - DataEncryptionKeyId *string - - // The progress of the snapshot, as a percentage. - Progress *string - - // The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) - // customer master key (CMK) that was used to protect the volume encryption key for - // the parent volume. - KmsKeyId *string - - // The description for the snapshot. - Description *string - - // The snapshot state. - State SnapshotState + // The ID of the volume that was used to create the snapshot. Snapshots created by + // the CopySnapshot () action have an arbitrary volume ID that should not be used + // for any purpose. + VolumeId *string - // The time stamp when the snapshot was initiated. - StartTime *time.Time + // The size of the volume, in GiB. + VolumeSize *int32 } // Describes the snapshot created from the imported disk. type SnapshotDetail struct { - // The snapshot ID of the disk being imported. - SnapshotId *string + // A description for the snapshot. + Description *string // The block device mapping for the snapshot. DeviceName *string - // A brief status of the snapshot creation. - Status *string - - // The URL used to access the disk image. - Url *string + // The size of the disk in the snapshot, in GiB. + DiskImageSize *float64 - // The Amazon S3 bucket for the disk image. - UserBucket *UserBucketDetails + // The format of the disk image from which the snapshot is created. + Format *string // The percentage of progress for the task. Progress *string + // The snapshot ID of the disk being imported. + SnapshotId *string + + // A brief status of the snapshot creation. + Status *string + // A detailed status message for the snapshot creation. StatusMessage *string - // A description for the snapshot. - Description *string - - // The size of the disk in the snapshot, in GiB. - DiskImageSize *float64 + // The URL used to access the disk image. + Url *string - // The format of the disk image from which the snapshot is created. - Format *string + // The Amazon S3 bucket for the disk image. + UserBucket *UserBucketDetails } // The disk container object for the import snapshot request. @@ -7751,15 +7751,15 @@ type SnapshotDiskContainer struct { // The description of the disk image being imported. Description *string - // The Amazon S3 bucket for the disk image. - UserBucket *UserBucket + // The format of the disk image being imported. Valid values: VHD | VMDK + Format *string // The URL to the Amazon S3-based disk image being imported. It can either be a // https URL (https://..) or an Amazon S3 URL (s3://..). Url *string - // The format of the disk image being imported. Valid values: VHD | VMDK - Format *string + // The Amazon S3 bucket for the disk image. + UserBucket *UserBucket } // Information about a snapshot. @@ -7772,87 +7772,87 @@ type SnapshotInfo struct { // Indicates whether the snapshot is encrypted. Encrypted *bool - // Source volume from which this snapshot was created. - VolumeId *string + // Account id used when creating this snapshot. + OwnerId *string + + // Progress this snapshot has made towards completing. + Progress *string // Snapshot id that can be used to describe this snapshot. SnapshotId *string + // Time this snapshot was started. This is the same for all snapshots initiated by + // the same request. + StartTime *time.Time + // Current state of the snapshot. State SnapshotState - // Progress this snapshot has made towards completing. - Progress *string + // Tags associated with this snapshot. + Tags []*Tag - // Account id used when creating this snapshot. - OwnerId *string + // Source volume from which this snapshot was created. + VolumeId *string // Size of the volume from which this snapshot was created. VolumeSize *int32 - - // Tags associated with this snapshot. - Tags []*Tag - - // Time this snapshot was started. This is the same for all snapshots initiated by - // the same request. - StartTime *time.Time } // Details about the import snapshot task. type SnapshotTaskDetail struct { - // The snapshot ID of the disk being imported. - SnapshotId *string + // The description of the snapshot. + Description *string - // A brief status for the import snapshot task. - Status *string + // The size of the disk in the snapshot, in GiB. + DiskImageSize *float64 // Indicates whether the snapshot is encrypted. Encrypted *bool - // The description of the snapshot. - Description *string + // The format of the disk image from which the snapshot is created. + Format *string - // The URL of the disk image from which the snapshot is created. - Url *string + // The identifier for the AWS Key Management Service (AWS KMS) customer master key + // (CMK) that was used to create the encrypted snapshot. + KmsKeyId *string // The percentage of completion for the import snapshot task. Progress *string - // The size of the disk in the snapshot, in GiB. - DiskImageSize *float64 + // The snapshot ID of the disk being imported. + SnapshotId *string + + // A brief status for the import snapshot task. + Status *string // A detailed status message for the import snapshot task. StatusMessage *string + // The URL of the disk image from which the snapshot is created. + Url *string + // The Amazon S3 bucket for the disk image. UserBucket *UserBucketDetails - - // The format of the disk image from which the snapshot is created. - Format *string - - // The identifier for the AWS Key Management Service (AWS KMS) customer master key - // (CMK) that was used to create the encrypted snapshot. - KmsKeyId *string } // Describes the data feed for a Spot Instance. type SpotDatafeedSubscription struct { - // The prefix that is prepended to data feed files. - Prefix *string + // The Amazon S3 bucket where the Spot Instance data feed is located. + Bucket *string + + // The fault codes for the Spot Instance request, if any. + Fault *SpotInstanceStateFault // The AWS account ID of the account. OwnerId *string - // The fault codes for the Spot Instance request, if any. - Fault *SpotInstanceStateFault + // The prefix that is prepended to data feed files. + Prefix *string // The state of the Spot Instance data feed subscription. State DatafeedSubscriptionState - - // The Amazon S3 bucket where the Spot Instance data feed is located. - Bucket *string } // Describes the launch specification for one or more Spot Instances. If you @@ -7861,6 +7861,9 @@ type SpotDatafeedSubscription struct { // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplateConfig.html). type SpotFleetLaunchSpecification struct { + // Deprecated. + AddressingType *string + // One or more block devices that are mapped to the Spot Instances. You can't // specify both a snapshot ID and an encryption value. This is because only blank // volumes can be encrypted on creation. If a snapshot is the basis for a volume, @@ -7868,11 +7871,6 @@ type SpotFleetLaunchSpecification struct { // status. BlockDeviceMappings []*BlockDeviceMapping - // One or more security groups. When requesting instances in a VPC, you must - // specify the IDs of the security groups. When requesting instances in - // EC2-Classic, you can specify the names or the IDs of the security groups. - SecurityGroups []*GroupIdentifier - // Indicates whether the instances are optimized for EBS I/O. This optimization // provides dedicated throughput to Amazon EBS and an optimized configuration stack // to provide optimal EBS I/O performance. This optimization isn't available with @@ -7880,21 +7878,41 @@ type SpotFleetLaunchSpecification struct { // instance. Default: false EbsOptimized *bool - // One or more network interfaces. If you specify a network interface, you must - // specify subnet IDs and security group IDs using the network interface. - NetworkInterfaces []*InstanceNetworkInterfaceSpecification + // The IAM instance profile. + IamInstanceProfile *IamInstanceProfileSpecification + + // The ID of the AMI. + ImageId *string + + // The instance type. + InstanceType InstanceType + + // The ID of the kernel. + KernelId *string // The name of the key pair. KeyName *string + // Enable or disable monitoring for the instances. + Monitoring *SpotFleetMonitoring + + // One or more network interfaces. If you specify a network interface, you must + // specify subnet IDs and security group IDs using the network interface. + NetworkInterfaces []*InstanceNetworkInterfaceSpecification + // The placement information. Placement *SpotPlacement - // The instance type. - InstanceType InstanceType + // The ID of the RAM disk. Some kernels require additional drivers at launch. Check + // the kernel requirements for information about whether you need to specify a RAM + // disk. To find kernel requirements, refer to the AWS Resource Center and search + // for the kernel ID. + RamdiskId *string - // Enable or disable monitoring for the instances. - Monitoring *SpotFleetMonitoring + // One or more security groups. When requesting instances in a VPC, you must + // specify the IDs of the security groups. When requesting instances in + // EC2-Classic, you can specify the names or the IDs of the security groups. + SecurityGroups []*GroupIdentifier // The maximum price per unit hour that you are willing to pay for a Spot Instance. // If this value is not specified, the default is the Spot price specified for the @@ -7902,21 +7920,17 @@ type SpotFleetLaunchSpecification struct { // value of WeightedCapacity. SpotPrice *string + // The IDs of the subnets in which to launch the instances. To specify multiple + // subnets, separate them using commas; for example, "subnet-1234abcdeexample1, + // subnet-0987cdef6example2". + SubnetId *string + // The tags to apply during creation. TagSpecifications []*SpotFleetTagSpecification - // The ID of the RAM disk. Some kernels require additional drivers at launch. Check - // the kernel requirements for information about whether you need to specify a RAM - // disk. To find kernel requirements, refer to the AWS Resource Center and search - // for the kernel ID. - RamdiskId *string - // The Base64-encoded user data that instances use when starting up. UserData *string - // The ID of the AMI. - ImageId *string - // The number of units provided by the specified instance type. These are the same // units that you chose to set the target capacity in terms of instances, or a // performance characteristic such as vCPUs, memory, or I/O. If the target capacity @@ -7924,20 +7938,6 @@ type SpotFleetLaunchSpecification struct { // instances to the next whole number. If this value is not specified, the default // is 1. WeightedCapacity *float64 - - // The IAM instance profile. - IamInstanceProfile *IamInstanceProfileSpecification - - // The IDs of the subnets in which to launch the instances. To specify multiple - // subnets, separate them using commas; for example, "subnet-1234abcdeexample1, - // subnet-0987cdef6example2". - SubnetId *string - - // Deprecated. - AddressingType *string - - // The ID of the kernel. - KernelId *string } // Describes whether monitoring is enabled. @@ -7950,12 +7950,6 @@ type SpotFleetMonitoring struct { // Describes a Spot Fleet request. type SpotFleetRequestConfig struct { - // The ID of the Spot Fleet request. - SpotFleetRequestId *string - - // The state of the Spot Fleet request. - SpotFleetRequestState BatchState - // The progress of the Spot Fleet request. If there is an error, the status is // error. After all requests are placed, the status is pending_fulfillment. If the // size of the fleet is equal to or greater than its target capacity, the status is @@ -7969,6 +7963,12 @@ type SpotFleetRequestConfig struct { // The configuration of the Spot Fleet request. SpotFleetRequestConfig *SpotFleetRequestConfigData + // The ID of the Spot Fleet request. + SpotFleetRequestId *string + + // The state of the Spot Fleet request. + SpotFleetRequestState BatchState + // The tags for a Spot Fleet resource. Tags []*Tag } @@ -7976,17 +7976,20 @@ type SpotFleetRequestConfig struct { // Describes the configuration of a Spot Fleet request. type SpotFleetRequestConfigData struct { - // The key-value pair for tagging the Spot Fleet request on creation. The value for - // ResourceType must be spot-fleet-request, otherwise the Spot Fleet request fails. - // To tag instances at launch, specify the tags in the launch template - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template) - // (valid only if you use LaunchTemplateConfigs) or in the - // SpotFleetTagSpecification - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetTagSpecification.html) - // (valid only if you use LaunchSpecifications). For information about tagging - // after launch, see Tagging Your Resources - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources). - TagSpecifications []*TagSpecification + // The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) + // role that grants the Spot Fleet the permission to request, launch, terminate, + // and tag instances on your behalf. For more information, see Spot Fleet + // prerequisites + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html#spot-fleet-prerequisites) + // in the Amazon EC2 User Guide for Linux Instances. Spot Fleet can terminate Spot + // Instances on your behalf when you cancel its Spot Fleet request using + // CancelSpotFleetRequests + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CancelSpotFleetRequests) + // or when the Spot Fleet request expires, if you set + // TerminateInstancesWithExpiration. + // + // This member is required. + IamFleetRole *string // The number of units to request for the Spot Fleet. You can choose to set the // target capacity in terms of instances or a performance characteristic that is @@ -7997,18 +8000,6 @@ type SpotFleetRequestConfigData struct { // This member is required. TargetCapacity *int32 - // The start date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). By - // default, Amazon EC2 starts fulfilling the request immediately. - ValidFrom *time.Time - - // The behavior when a Spot Instance is interrupted. The default is terminate. - InstanceInterruptionBehavior InstanceInterruptionBehavior - - // The launch template and overrides. If you specify LaunchTemplateConfigs, you - // can't specify LaunchSpecifications. If you include On-Demand capacity in your - // request, you must use LaunchTemplateConfigs. - LaunchTemplateConfigs []*LaunchTemplateConfig - // Indicates how to allocate the target Spot Instance capacity across the Spot // Instance pools specified by the Spot Fleet request. If the allocation strategy // is lowestPrice, Spot Fleet launches instances from the Spot Instance pools with @@ -8019,41 +8010,23 @@ type SpotFleetRequestConfigData struct { // optimal capacity for the number of instances that are launching. AllocationStrategy AllocationStrategy + // A unique, case-sensitive identifier that you provide to ensure the idempotency + // of your listings. This helps to avoid duplicate listings. For more information, + // see Ensuring Idempotency + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + ClientToken *string + + // Indicates whether running Spot Instances should be terminated if you decrease + // the target capacity of the Spot Fleet request below the current size of the Spot + // Fleet. + ExcessCapacityTerminationPolicy ExcessCapacityTerminationPolicy + // The number of units fulfilled by this request compared to the set target // capacity. You cannot set this value. FulfilledCapacity *float64 - // The maximum price per unit hour that you are willing to pay for a Spot Instance. - // The default is the On-Demand price. - SpotPrice *string - - // Indicates whether Spot Fleet should replace unhealthy instances. - ReplaceUnhealthyInstances *bool - - // The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) - // role that grants the Spot Fleet the permission to request, launch, terminate, - // and tag instances on your behalf. For more information, see Spot Fleet - // prerequisites - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html#spot-fleet-prerequisites) - // in the Amazon EC2 User Guide for Linux Instances. Spot Fleet can terminate Spot - // Instances on your behalf when you cancel its Spot Fleet request using - // CancelSpotFleetRequests - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CancelSpotFleetRequests) - // or when the Spot Fleet request expires, if you set - // TerminateInstancesWithExpiration. - // - // This member is required. - IamFleetRole *string - - // The maximum amount per hour for Spot Instances that you're willing to pay. You - // can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice parameter, - // or both parameters to ensure that your fleet cost does not exceed your budget. - // If you set a maximum price per hour for the On-Demand Instances and Spot - // Instances in your request, Spot Fleet will launch instances until it reaches the - // maximum amount you're willing to pay. When the maximum amount you're willing to - // pay is reached, the fleet stops launching instances even if it hasn’t met the - // target capacity. - SpotMaxTotalPrice *string + // The behavior when a Spot Instance is interrupted. The default is terminate. + InstanceInterruptionBehavior InstanceInterruptionBehavior // The number of Spot pools across which to allocate your target Spot capacity. // Valid only when Spot AllocationStrategy is set to lowest-price. Spot Fleet @@ -8061,6 +8034,16 @@ type SpotFleetRequestConfigData struct { // across the number of Spot pools that you specify. InstancePoolsToUseCount *int32 + // The launch specifications for the Spot Fleet request. If you specify + // LaunchSpecifications, you can't specify LaunchTemplateConfigs. If you include + // On-Demand capacity in your request, you must use LaunchTemplateConfigs. + LaunchSpecifications []*SpotFleetLaunchSpecification + + // The launch template and overrides. If you specify LaunchTemplateConfigs, you + // can't specify LaunchSpecifications. If you include On-Demand capacity in your + // request, you must use LaunchTemplateConfigs. + LaunchTemplateConfigs []*LaunchTemplateConfig + // One or more Classic Load Balancers and target groups to attach to the Spot Fleet // request. Spot Fleet registers the running Spot Instances with the specified // Classic Load Balancers and target groups. With Network Load Balancers, Spot @@ -8068,10 +8051,17 @@ type SpotFleetRequestConfigData struct { // CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1. LoadBalancersConfig *LoadBalancersConfig - // Indicates whether running Spot Instances should be terminated if you decrease - // the target capacity of the Spot Fleet request below the current size of the Spot - // Fleet. - ExcessCapacityTerminationPolicy ExcessCapacityTerminationPolicy + // The order of the launch template overrides to use in fulfilling On-Demand + // capacity. If you specify lowestPrice, Spot Fleet uses price to determine the + // order, launching the lowest price first. If you specify prioritized, Spot Fleet + // uses the priority that you assign to each Spot Fleet launch template override, + // launching the highest priority first. If you do not specify a value, Spot Fleet + // defaults to lowestPrice. + OnDemandAllocationStrategy OnDemandAllocationStrategy + + // The number of On-Demand units fulfilled by this request compared to the set + // target On-Demand capacity. + OnDemandFulfilledCapacity *float64 // The maximum amount per hour for On-Demand Instances that you're willing to pay. // You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice @@ -8083,11 +8073,44 @@ type SpotFleetRequestConfigData struct { // met the target capacity. OnDemandMaxTotalPrice *string - // The end date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). - // After the end date and time, no new Spot Instance requests are placed or able to - // fulfill the request. If no value is specified, the Spot Fleet request remains - // until you cancel it. - ValidUntil *time.Time + // The number of On-Demand units to request. You can choose to set the target + // capacity in terms of instances or a performance characteristic that is important + // to your application workload, such as vCPUs, memory, or I/O. If the request type + // is maintain, you can specify a target capacity of 0 and add capacity later. + OnDemandTargetCapacity *int32 + + // Indicates whether Spot Fleet should replace unhealthy instances. + ReplaceUnhealthyInstances *bool + + // The maximum amount per hour for Spot Instances that you're willing to pay. You + // can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice parameter, + // or both parameters to ensure that your fleet cost does not exceed your budget. + // If you set a maximum price per hour for the On-Demand Instances and Spot + // Instances in your request, Spot Fleet will launch instances until it reaches the + // maximum amount you're willing to pay. When the maximum amount you're willing to + // pay is reached, the fleet stops launching instances even if it hasn’t met the + // target capacity. + SpotMaxTotalPrice *string + + // The maximum price per unit hour that you are willing to pay for a Spot Instance. + // The default is the On-Demand price. + SpotPrice *string + + // The key-value pair for tagging the Spot Fleet request on creation. The value for + // ResourceType must be spot-fleet-request, otherwise the Spot Fleet request fails. + // To tag instances at launch, specify the tags in the launch template + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template) + // (valid only if you use LaunchTemplateConfigs) or in the + // SpotFleetTagSpecification + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetTagSpecification.html) + // (valid only if you use LaunchSpecifications). For information about tagging + // after launch, see Tagging Your Resources + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources). + TagSpecifications []*TagSpecification + + // Indicates whether running Spot Instances are terminated when the Spot Fleet + // request expires. + TerminateInstancesWithExpiration *bool // The type of request. Indicates whether the Spot Fleet only requests the target // capacity or also attempts to maintain it. When this value is request, the Spot @@ -8099,87 +8122,77 @@ type SpotFleetRequestConfigData struct { // Default: maintain. instant is listed but is not used by Spot Fleet. Type FleetType - // The launch specifications for the Spot Fleet request. If you specify - // LaunchSpecifications, you can't specify LaunchTemplateConfigs. If you include - // On-Demand capacity in your request, you must use LaunchTemplateConfigs. - LaunchSpecifications []*SpotFleetLaunchSpecification - - // The order of the launch template overrides to use in fulfilling On-Demand - // capacity. If you specify lowestPrice, Spot Fleet uses price to determine the - // order, launching the lowest price first. If you specify prioritized, Spot Fleet - // uses the priority that you assign to each Spot Fleet launch template override, - // launching the highest priority first. If you do not specify a value, Spot Fleet - // defaults to lowestPrice. - OnDemandAllocationStrategy OnDemandAllocationStrategy - - // The number of On-Demand units fulfilled by this request compared to the set - // target On-Demand capacity. - OnDemandFulfilledCapacity *float64 - - // The number of On-Demand units to request. You can choose to set the target - // capacity in terms of instances or a performance characteristic that is important - // to your application workload, such as vCPUs, memory, or I/O. If the request type - // is maintain, you can specify a target capacity of 0 and add capacity later. - OnDemandTargetCapacity *int32 - - // A unique, case-sensitive identifier that you provide to ensure the idempotency - // of your listings. This helps to avoid duplicate listings. For more information, - // see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). - ClientToken *string + // The start date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). By + // default, Amazon EC2 starts fulfilling the request immediately. + ValidFrom *time.Time - // Indicates whether running Spot Instances are terminated when the Spot Fleet - // request expires. - TerminateInstancesWithExpiration *bool + // The end date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). + // After the end date and time, no new Spot Instance requests are placed or able to + // fulfill the request. If no value is specified, the Spot Fleet request remains + // until you cancel it. + ValidUntil *time.Time } // The tags for a Spot Fleet resource. type SpotFleetTagSpecification struct { - // The tags. - Tags []*Tag - // The type of resource. Currently, the only resource type that is supported is // instance. To tag the Spot Fleet request on creation, use the TagSpecifications // parameter in SpotFleetRequestConfigData // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetRequestConfigData.html). ResourceType ResourceType + + // The tags. + Tags []*Tag } // Describes a Spot Instance request. type SpotInstanceRequest struct { + // If you specified a duration and your Spot Instance request was fulfilled, this + // is the fixed hourly price in effect for the Spot Instance while it runs. + ActualBlockHourlyPrice *string + + // The Availability Zone group. If you specify the same Availability Zone group for + // all Spot Instance requests, all Spot Instances are launched in the same + // Availability Zone. + AvailabilityZoneGroup *string + + // The duration for the Spot Instance, in minutes. + BlockDurationMinutes *int32 + + // The date and time when the Spot Instance request was created, in UTC format (for + // example, YYYY-MM-DDTHH:MM:SSZ). + CreateTime *time.Time + // The fault codes for the Spot Instance request, if any. Fault *SpotInstanceStateFault - // The start date of the request, in UTC format (for example, - // YYYY-MM-DDTHH:MM:SSZ). The request becomes active at this date and time. - ValidFrom *time.Time + // The instance ID, if an instance has been launched to fulfill the Spot Instance + // request. + InstanceId *string + + // The behavior when a Spot Instance is interrupted. + InstanceInterruptionBehavior InstanceInterruptionBehavior + + // The instance launch group. Launch groups are Spot Instances that launch together + // and terminate together. + LaunchGroup *string // Additional information for launching instances. LaunchSpecification *LaunchSpecification - // The ID of the Spot Instance request. - SpotInstanceRequestId *string + // The Availability Zone in which the request is launched. + LaunchedAvailabilityZone *string // The product description associated with the Spot Instance. ProductDescription RIProductDescription - // If you specified a duration and your Spot Instance request was fulfilled, this - // is the fixed hourly price in effect for the Spot Instance while it runs. - ActualBlockHourlyPrice *string - - // The instance launch group. Launch groups are Spot Instances that launch together - // and terminate together. - LaunchGroup *string - - // The behavior when a Spot Instance is interrupted. - InstanceInterruptionBehavior InstanceInterruptionBehavior + // The ID of the Spot Instance request. + SpotInstanceRequestId *string - // The Availability Zone group. If you specify the same Availability Zone group for - // all Spot Instance requests, all Spot Instances are launched in the same - // Availability Zone. - AvailabilityZoneGroup *string + // The maximum price per hour that you are willing to pay for a Spot Instance. + SpotPrice *string // The state of the Spot Instance request. Spot status information helps track your // Spot Instance requests. For more information, see Spot status @@ -8187,12 +8200,8 @@ type SpotInstanceRequest struct { // the Amazon EC2 User Guide for Linux Instances. State SpotInstanceState - // The end date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). - // If this is a one-time request, it remains active until all instances launch, the - // request is canceled, or this date is reached. If the request is persistent, it - // remains active until it is canceled or this date is reached. The default end - // date is 7 days from the current date. - ValidUntil *time.Time + // The status code and status message describing the Spot Instance request. + Status *SpotInstanceStatus // Any tags assigned to the resource. Tags []*Tag @@ -8200,94 +8209,74 @@ type SpotInstanceRequest struct { // The Spot Instance request type. Type SpotInstanceType - // The instance ID, if an instance has been launched to fulfill the Spot Instance - // request. - InstanceId *string - - // The status code and status message describing the Spot Instance request. - Status *SpotInstanceStatus - - // The date and time when the Spot Instance request was created, in UTC format (for - // example, YYYY-MM-DDTHH:MM:SSZ). - CreateTime *time.Time - - // The maximum price per hour that you are willing to pay for a Spot Instance. - SpotPrice *string - - // The Availability Zone in which the request is launched. - LaunchedAvailabilityZone *string + // The start date of the request, in UTC format (for example, + // YYYY-MM-DDTHH:MM:SSZ). The request becomes active at this date and time. + ValidFrom *time.Time - // The duration for the Spot Instance, in minutes. - BlockDurationMinutes *int32 + // The end date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). + // If this is a one-time request, it remains active until all instances launch, the + // request is canceled, or this date is reached. If the request is persistent, it + // remains active until it is canceled or this date is reached. The default end + // date is 7 days from the current date. + ValidUntil *time.Time } // Describes a Spot Instance state change. type SpotInstanceStateFault struct { - // The message for the Spot Instance state change. - Message *string - // The reason code for the Spot Instance state change. Code *string + + // The message for the Spot Instance state change. + Message *string } // Describes the status of a Spot Instance request. type SpotInstanceStatus struct { - // The date and time of the most recent status update, in UTC format (for example, - // YYYY-MM-DDTHH:MM:SSZ). - UpdateTime *time.Time - - // The description for the status code. - Message *string - // The status code. For a list of status codes, see Spot status codes // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-bid-status.html#spot-instance-bid-status-understand) // in the Amazon EC2 User Guide for Linux Instances. Code *string + + // The description for the status code. + Message *string + + // The date and time of the most recent status update, in UTC format (for example, + // YYYY-MM-DDTHH:MM:SSZ). + UpdateTime *time.Time } // The options for Spot Instances. type SpotMarketOptions struct { + // The required duration for the Spot Instances (also known as Spot blocks), in + // minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360). + BlockDurationMinutes *int32 + + // The behavior when a Spot Instance is interrupted. The default is terminate. + InstanceInterruptionBehavior InstanceInterruptionBehavior + + // The maximum hourly price you're willing to pay for the Spot Instances. The + // default is the On-Demand price. + MaxPrice *string + // The Spot Instance request type. For RunInstances // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances), // persistent Spot Instance requests are only supported when // InstanceInterruptionBehavior is set to either hibernate or stop. SpotInstanceType SpotInstanceType - // The behavior when a Spot Instance is interrupted. The default is terminate. - InstanceInterruptionBehavior InstanceInterruptionBehavior - // The end date of the request. For a one-time request, the request remains active // until all instances launch, the request is canceled, or this date is reached. If // the request is persistent, it remains active until it is canceled or this date // and time is reached. The default end date is 7 days from the current date. ValidUntil *time.Time - - // The required duration for the Spot Instances (also known as Spot blocks), in - // minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360). - BlockDurationMinutes *int32 - - // The maximum hourly price you're willing to pay for the Spot Instances. The - // default is the On-Demand price. - MaxPrice *string } // Describes the configuration of Spot Instances in an EC2 Fleet. type SpotOptions struct { - // Indicates that the fleet launches all Spot Instances into a single Availability - // Zone. Supported only for fleets of type instant. - SingleAvailabilityZone *bool - - // The minimum target capacity for Spot Instances in the fleet. If the minimum - // target capacity is not reached, the fleet launches no instances. - MinTargetCapacity *int32 - - // The behavior when a Spot Instance is interrupted. The default is terminate. - InstanceInterruptionBehavior SpotInstanceInterruptionBehavior - // Indicates how to allocate the target Spot Instance capacity across the Spot // Instance pools specified by the EC2 Fleet. If the allocation strategy is // lowest-price, EC2 Fleet launches instances from the Spot Instance pools with the @@ -8298,23 +8287,15 @@ type SpotOptions struct { // optimal capacity for the number of instances that are launching. AllocationStrategy SpotAllocationStrategy + // The behavior when a Spot Instance is interrupted. The default is terminate. + InstanceInterruptionBehavior SpotInstanceInterruptionBehavior + // The number of Spot pools across which to allocate your target Spot capacity. // Valid only when AllocationStrategy is set to lowest-price. EC2 Fleet selects the // cheapest Spot pools and evenly allocates your target Spot capacity across the // number of Spot pools that you specify. InstancePoolsToUseCount *int32 - // Indicates that the fleet uses a single instance type to launch all Spot - // Instances in the fleet. Supported only for fleets of type instant. - SingleInstanceType *bool - - // The maximum amount per hour for Spot Instances that you're willing to pay. - MaxTotalPrice *string -} - -// Describes the configuration of Spot Instances in an EC2 Fleet request. -type SpotOptionsRequest struct { - // The maximum amount per hour for Spot Instances that you're willing to pay. MaxTotalPrice *string @@ -8322,11 +8303,17 @@ type SpotOptionsRequest struct { // target capacity is not reached, the fleet launches no instances. MinTargetCapacity *int32 - // The number of Spot pools across which to allocate your target Spot capacity. - // Valid only when Spot AllocationStrategy is set to lowest-price. EC2 Fleet - // selects the cheapest Spot pools and evenly allocates your target Spot capacity - // across the number of Spot pools that you specify. - InstancePoolsToUseCount *int32 + // Indicates that the fleet launches all Spot Instances into a single Availability + // Zone. Supported only for fleets of type instant. + SingleAvailabilityZone *bool + + // Indicates that the fleet uses a single instance type to launch all Spot + // Instances in the fleet. Supported only for fleets of type instant. + SingleInstanceType *bool +} + +// Describes the configuration of Spot Instances in an EC2 Fleet request. +type SpotOptionsRequest struct { // Indicates how to allocate the target Spot Instance capacity across the Spot // Instance pools specified by the EC2 Fleet. If the allocation strategy is @@ -8338,40 +8325,53 @@ type SpotOptionsRequest struct { // optimal capacity for the number of instances that are launching. AllocationStrategy SpotAllocationStrategy - // Indicates that the fleet uses a single instance type to launch all Spot - // Instances in the fleet. Supported only for fleets of type instant. - SingleInstanceType *bool + // The behavior when a Spot Instance is interrupted. The default is terminate. + InstanceInterruptionBehavior SpotInstanceInterruptionBehavior + + // The number of Spot pools across which to allocate your target Spot capacity. + // Valid only when Spot AllocationStrategy is set to lowest-price. EC2 Fleet + // selects the cheapest Spot pools and evenly allocates your target Spot capacity + // across the number of Spot pools that you specify. + InstancePoolsToUseCount *int32 + + // The maximum amount per hour for Spot Instances that you're willing to pay. + MaxTotalPrice *string + + // The minimum target capacity for Spot Instances in the fleet. If the minimum + // target capacity is not reached, the fleet launches no instances. + MinTargetCapacity *int32 // Indicates that the fleet launches all Spot Instances into a single Availability // Zone. Supported only for fleets of type instant. SingleAvailabilityZone *bool - // The behavior when a Spot Instance is interrupted. The default is terminate. - InstanceInterruptionBehavior SpotInstanceInterruptionBehavior + // Indicates that the fleet uses a single instance type to launch all Spot + // Instances in the fleet. Supported only for fleets of type instant. + SingleInstanceType *bool } // Describes Spot Instance placement. type SpotPlacement struct { - // The tenancy of the instance (if the instance is running in a VPC). An instance - // with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is - // not supported for Spot Instances. - Tenancy Tenancy - // The Availability Zone. [Spot Fleet only] To specify multiple Availability Zones, // separate them using commas; for example, "us-west-2a, us-west-2b". AvailabilityZone *string // The name of the placement group. GroupName *string + + // The tenancy of the instance (if the instance is running in a VPC). An instance + // with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is + // not supported for Spot Instances. + Tenancy Tenancy } // Describes the maximum price per hour that you are willing to pay for a Spot // Instance. type SpotPrice struct { - // The maximum price per hour that you are willing to pay for a Spot Instance. - SpotPrice *string + // The Availability Zone. + AvailabilityZone *string // The instance type. InstanceType InstanceType @@ -8379,60 +8379,60 @@ type SpotPrice struct { // A general description of the AMI. ProductDescription RIProductDescription + // The maximum price per hour that you are willing to pay for a Spot Instance. + SpotPrice *string + // The date and time the request was created, in UTC format (for example, // YYYY-MM-DDTHH:MM:SSZ). Timestamp *time.Time - - // The Availability Zone. - AvailabilityZone *string } // Describes a stale rule in a security group. type StaleIpPermission struct { - // The end of the port range for the TCP and UDP protocols, or an ICMP type number. - // A value of -1 indicates all ICMP types. - ToPort *int32 - - // The security group pairs. Returns the ID of the referenced security group and - // VPC, and the ID and status of the VPC peering connection. - UserIdGroupPairs []*UserIdGroupPair + // The start of the port range for the TCP and UDP protocols, or an ICMP type + // number. A value of -1 indicates all ICMP types. + FromPort *int32 // The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers) // (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). IpProtocol *string + // The IP ranges. Not applicable for stale security group rules. + IpRanges []*string + // The prefix list IDs. Not applicable for stale security group rules. PrefixListIds []*string - // The IP ranges. Not applicable for stale security group rules. - IpRanges []*string + // The end of the port range for the TCP and UDP protocols, or an ICMP type number. + // A value of -1 indicates all ICMP types. + ToPort *int32 - // The start of the port range for the TCP and UDP protocols, or an ICMP type - // number. A value of -1 indicates all ICMP types. - FromPort *int32 + // The security group pairs. Returns the ID of the referenced security group and + // VPC, and the ID and status of the VPC peering connection. + UserIdGroupPairs []*UserIdGroupPair } // Describes a stale security group (a security group that contains stale rules). type StaleSecurityGroup struct { + // The description of the security group. + Description *string + + // The ID of the security group. + GroupId *string + // The name of the security group. GroupName *string + // Information about the stale inbound rules in the security group. + StaleIpPermissions []*StaleIpPermission + // Information about the stale outbound rules in the security group. StaleIpPermissionsEgress []*StaleIpPermission // The ID of the VPC for the security group. VpcId *string - - // Information about the stale inbound rules in the security group. - StaleIpPermissions []*StaleIpPermission - - // The ID of the security group. - GroupId *string - - // The description of the security group. - Description *string } // Describes a state change. @@ -8508,19 +8508,12 @@ type StorageLocation struct { // Describes a subnet. type Subnet struct { - // The Availability Zone of the subnet. - AvailabilityZone *string - - // The ID of the VPC the subnet is in. - VpcId *string - // Indicates whether a network interface created in this subnet (including a - // network interface created by RunInstances ()) receives a customer-owned IPv4 - // address. - MapCustomerOwnedIpOnLaunch *bool + // network interface created by RunInstances ()) receives an IPv6 address. + AssignIpv6AddressOnCreation *bool - // Indicates whether this is the default subnet for the Availability Zone. - DefaultForAz *bool + // The Availability Zone of the subnet. + AvailabilityZone *string // The AZ ID of the subnet. AvailabilityZoneId *string @@ -8529,40 +8522,47 @@ type Subnet struct { // for any stopped instances are considered unavailable. AvailableIpAddressCount *int32 - // Indicates whether a network interface created in this subnet (including a - // network interface created by RunInstances ()) receives an IPv6 address. - AssignIpv6AddressOnCreation *bool - - // Any tags assigned to the subnet. - Tags []*Tag + // The IPv4 CIDR block assigned to the subnet. + CidrBlock *string - // The ID of the AWS account that owns the subnet. - OwnerId *string + // The customer-owned IPv4 address pool associated with the subnet. + CustomerOwnedIpv4Pool *string - // The ID of the subnet. - SubnetId *string + // Indicates whether this is the default subnet for the Availability Zone. + DefaultForAz *bool // Information about the IPv6 CIDR blocks associated with the subnet. Ipv6CidrBlockAssociationSet []*SubnetIpv6CidrBlockAssociation - // The customer-owned IPv4 address pool associated with the subnet. - CustomerOwnedIpv4Pool *string - - // The IPv4 CIDR block assigned to the subnet. - CidrBlock *string + // Indicates whether a network interface created in this subnet (including a + // network interface created by RunInstances ()) receives a customer-owned IPv4 + // address. + MapCustomerOwnedIpOnLaunch *bool // Indicates whether instances launched in this subnet receive a public IPv4 // address. MapPublicIpOnLaunch *bool + // The Amazon Resource Name (ARN) of the Outpost. + OutpostArn *string + + // The ID of the AWS account that owns the subnet. + OwnerId *string + // The current state of the subnet. State SubnetState // The Amazon Resource Name (ARN) of the subnet. SubnetArn *string - // The Amazon Resource Name (ARN) of the Outpost. - OutpostArn *string + // The ID of the subnet. + SubnetId *string + + // Any tags assigned to the subnet. + Tags []*Tag + + // The ID of the VPC the subnet is in. + VpcId *string } // Describes the subnet association with the transit gateway multicast domain. @@ -8578,22 +8578,22 @@ type SubnetAssociation struct { // Describes the state of a CIDR block. type SubnetCidrBlockState struct { - // A message about the status of the CIDR block, if applicable. - StatusMessage *string - // The state of a CIDR block. State SubnetCidrBlockStateCode + + // A message about the status of the CIDR block, if applicable. + StatusMessage *string } // Describes an IPv6 CIDR block associated with a subnet. type SubnetIpv6CidrBlockAssociation struct { - // The IPv6 CIDR block. - Ipv6CidrBlock *string - // The association ID for the CIDR block. AssociationId *string + // The IPv6 CIDR block. + Ipv6CidrBlock *string + // Information about the state of the CIDR block. Ipv6CidrBlockState *SubnetCidrBlockState } @@ -8616,29 +8616,29 @@ type SuccessfulQueuedPurchaseDeletion struct { // Describes a tag. type Tag struct { - // The value of the tag. Constraints: Tag values are case-sensitive and accept a - // maximum of 255 Unicode characters. - Value *string - // The key of the tag. Constraints: Tag keys are case-sensitive and accept a // maximum of 127 Unicode characters. May not begin with aws:. Key *string + + // The value of the tag. Constraints: Tag values are case-sensitive and accept a + // maximum of 255 Unicode characters. + Value *string } // Describes a tag. type TagDescription struct { - // The tag value. - Value *string - - // The resource type. - ResourceType ResourceType + // The tag key. + Key *string // The ID of the resource. ResourceId *string - // The tag key. - Key *string + // The resource type. + ResourceType ResourceType + + // The tag value. + Value *string } // The tags to apply to a resource when the resource is being created. @@ -8681,13 +8681,13 @@ type TagSpecification struct { // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotOptions) type TargetCapacitySpecification struct { + // The default TotalTargetCapacity, which is either Spot or On-Demand. + DefaultTargetCapacityType DefaultTargetCapacityType + // The number of On-Demand units to request. If you specify a target capacity for // Spot units, you cannot specify a target capacity for On-Demand units. OnDemandTargetCapacity *int32 - // The default TotalTargetCapacity, which is either Spot or On-Demand. - DefaultTargetCapacityType DefaultTargetCapacityType - // The maximum number of Spot units to launch. If you specify a target capacity for // On-Demand units, you cannot specify a target capacity for Spot units. SpotTargetCapacity *int32 @@ -8718,14 +8718,14 @@ type TargetCapacitySpecificationRequest struct { // This member is required. TotalTargetCapacity *int32 - // The number of Spot units to request. - SpotTargetCapacity *int32 + // The default TotalTargetCapacity, which is either Spot or On-Demand. + DefaultTargetCapacityType DefaultTargetCapacityType // The number of On-Demand units to request. OnDemandTargetCapacity *int32 - // The default TotalTargetCapacity, which is either Spot or On-Demand. - DefaultTargetCapacityType DefaultTargetCapacityType + // The number of Spot units to request. + SpotTargetCapacity *int32 } // Information about the Convertible Reserved Instance offering. @@ -8770,23 +8770,23 @@ type TargetGroupsConfig struct { // Describes a target network associated with a Client VPN endpoint. type TargetNetwork struct { + // The ID of the association. + AssociationId *string + + // The ID of the Client VPN endpoint with which the target network is associated. + ClientVpnEndpointId *string + // The IDs of the security groups applied to the target network association. SecurityGroups []*string // The current state of the target network association. Status *AssociationStatus - // The ID of the VPC in which the target network (subnet) is located. - VpcId *string - // The ID of the subnet specified as the target network. TargetNetworkId *string - // The ID of the association. - AssociationId *string - - // The ID of the Client VPN endpoint with which the target network is associated. - ClientVpnEndpointId *string + // The ID of the VPC in which the target network (subnet) is located. + VpcId *string } // The total value of the new Convertible Reserved Instances. @@ -8805,21 +8805,21 @@ type TargetReservationValue struct { // Information about a terminated Client VPN endpoint client connection. type TerminateConnectionStatus struct { - // The state of the client connection. - PreviousStatus *ClientVpnConnectionStatus + // The ID of the client connection. + ConnectionId *string // A message about the status of the client connection, if applicable. CurrentStatus *ClientVpnConnectionStatus - // The ID of the client connection. - ConnectionId *string + // The state of the client connection. + PreviousStatus *ClientVpnConnectionStatus } // Describes the Traffic Mirror filter. type TrafficMirrorFilter struct { - // The network service traffic that is associated with the Traffic Mirror filter. - NetworkServices []TrafficMirrorNetworkService + // The description of the Traffic Mirror filter. + Description *string // Information about the egress rules that are associated with the Traffic Mirror // filter. @@ -8829,51 +8829,51 @@ type TrafficMirrorFilter struct { // filter. IngressFilterRules []*TrafficMirrorFilterRule - // The ID of the Traffic Mirror filter. - TrafficMirrorFilterId *string - - // The description of the Traffic Mirror filter. - Description *string + // The network service traffic that is associated with the Traffic Mirror filter. + NetworkServices []TrafficMirrorNetworkService // The tags assigned to the Traffic Mirror filter. Tags []*Tag + + // The ID of the Traffic Mirror filter. + TrafficMirrorFilterId *string } // Describes the Traffic Mirror rule. type TrafficMirrorFilterRule struct { - // The source port range assigned to the Traffic Mirror rule. - SourcePortRange *TrafficMirrorPortRange - - // The destination port range assigned to the Traffic Mirror rule. - DestinationPortRange *TrafficMirrorPortRange - - // The action assigned to the Traffic Mirror rule. - RuleAction TrafficMirrorRuleAction + // The description of the Traffic Mirror rule. + Description *string // The destination CIDR block assigned to the Traffic Mirror rule. DestinationCidrBlock *string - // The ID of the Traffic Mirror filter that the rule is associated with. - TrafficMirrorFilterId *string + // The destination port range assigned to the Traffic Mirror rule. + DestinationPortRange *TrafficMirrorPortRange // The protocol assigned to the Traffic Mirror rule. Protocol *int32 - // The source CIDR block assigned to the Traffic Mirror rule. - SourceCidrBlock *string + // The action assigned to the Traffic Mirror rule. + RuleAction TrafficMirrorRuleAction // The rule number of the Traffic Mirror rule. RuleNumber *int32 - // The description of the Traffic Mirror rule. - Description *string + // The source CIDR block assigned to the Traffic Mirror rule. + SourceCidrBlock *string - // The ID of the Traffic Mirror rule. - TrafficMirrorFilterRuleId *string + // The source port range assigned to the Traffic Mirror rule. + SourcePortRange *TrafficMirrorPortRange // The traffic direction assigned to the Traffic Mirror rule. TrafficDirection TrafficDirection + + // The ID of the Traffic Mirror filter that the rule is associated with. + TrafficMirrorFilterId *string + + // The ID of the Traffic Mirror rule. + TrafficMirrorFilterRuleId *string } // Describes the Traffic Mirror port range. @@ -8903,148 +8903,148 @@ type TrafficMirrorPortRangeRequest struct { // Describes a Traffic Mirror session. type TrafficMirrorSession struct { - // The ID of the Traffic Mirror target. - TrafficMirrorTargetId *string - - // The tags assigned to the Traffic Mirror session. - Tags []*Tag - - // The ID of the Traffic Mirror filter. - TrafficMirrorFilterId *string - - // The virtual network ID associated with the Traffic Mirror session. - VirtualNetworkId *int32 - // The description of the Traffic Mirror session. Description *string + // The ID of the Traffic Mirror session's network interface. + NetworkInterfaceId *string + // The ID of the account that owns the Traffic Mirror session. OwnerId *string - // The ID of the Traffic Mirror session's network interface. - NetworkInterfaceId *string + // The number of bytes in each packet to mirror. These are the bytes after the + // VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. + // For example, if you set this value to 100, then the first 100 bytes that meet + // the filter criteria are copied to the target. Do not specify this parameter when + // you want to mirror the entire packet + PacketLength *int32 + + // The session number determines the order in which sessions are evaluated when an + // interface is used by multiple sessions. The first session with a matching filter + // is the one that mirrors the packets. Valid values are 1-32766. + SessionNumber *int32 + + // The tags assigned to the Traffic Mirror session. + Tags []*Tag + + // The ID of the Traffic Mirror filter. + TrafficMirrorFilterId *string // The ID for the Traffic Mirror session. TrafficMirrorSessionId *string - // The session number determines the order in which sessions are evaluated when an - // interface is used by multiple sessions. The first session with a matching filter - // is the one that mirrors the packets. Valid values are 1-32766. - SessionNumber *int32 + // The ID of the Traffic Mirror target. + TrafficMirrorTargetId *string - // The number of bytes in each packet to mirror. These are the bytes after the - // VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. - // For example, if you set this value to 100, then the first 100 bytes that meet - // the filter criteria are copied to the target. Do not specify this parameter when - // you want to mirror the entire packet - PacketLength *int32 + // The virtual network ID associated with the Traffic Mirror session. + VirtualNetworkId *int32 } // Describes a Traffic Mirror target. type TrafficMirrorTarget struct { + // Information about the Traffic Mirror target. + Description *string + // The network interface ID that is attached to the target. NetworkInterfaceId *string + // The Amazon Resource Name (ARN) of the Network Load Balancer. + NetworkLoadBalancerArn *string + // The ID of the account that owns the Traffic Mirror target. OwnerId *string - // The type of Traffic Mirror target. - Type TrafficMirrorTargetType - // The tags assigned to the Traffic Mirror target. Tags []*Tag // The ID of the Traffic Mirror target. TrafficMirrorTargetId *string - // The Amazon Resource Name (ARN) of the Network Load Balancer. - NetworkLoadBalancerArn *string - - // Information about the Traffic Mirror target. - Description *string + // The type of Traffic Mirror target. + Type TrafficMirrorTargetType } // Describes a transit gateway. type TransitGateway struct { + // The creation time. + CreationTime *time.Time + + // The description of the transit gateway. + Description *string + + // The transit gateway options. + Options *TransitGatewayOptions + // The ID of the AWS account ID that owns the transit gateway. OwnerId *string - // The Amazon Resource Name (ARN) of the transit gateway. - TransitGatewayArn *string - // The state of the transit gateway. State TransitGatewayState - // The creation time. - CreationTime *time.Time - // The tags for the transit gateway. Tags []*Tag + // The Amazon Resource Name (ARN) of the transit gateway. + TransitGatewayArn *string + // The ID of the transit gateway. TransitGatewayId *string - - // The transit gateway options. - Options *TransitGatewayOptions - - // The description of the transit gateway. - Description *string } // Describes an association between a resource attachment and a transit gateway // route table. type TransitGatewayAssociation struct { - // The state of the association. - State TransitGatewayAssociationState - - // The ID of the transit gateway route table. - TransitGatewayRouteTableId *string + // The ID of the resource. + ResourceId *string // The resource type. ResourceType TransitGatewayAttachmentResourceType - // The ID of the resource. - ResourceId *string + // The state of the association. + State TransitGatewayAssociationState // The ID of the attachment. TransitGatewayAttachmentId *string + + // The ID of the transit gateway route table. + TransitGatewayRouteTableId *string } // Describes an attachment between a resource and a transit gateway. type TransitGatewayAttachment struct { + // The association. + Association *TransitGatewayAttachmentAssociation + + // The creation time. + CreationTime *time.Time + // The ID of the resource. ResourceId *string + // The ID of the AWS account that owns the resource. + ResourceOwnerId *string + // The resource type. ResourceType TransitGatewayAttachmentResourceType - // The ID of the transit gateway. - TransitGatewayId *string + // The attachment state. + State TransitGatewayAttachmentState // The tags for the attachment. Tags []*Tag - // The creation time. - CreationTime *time.Time + // The ID of the attachment. + TransitGatewayAttachmentId *string - // The attachment state. - State TransitGatewayAttachmentState + // The ID of the transit gateway. + TransitGatewayId *string // The ID of the AWS account that owns the transit gateway. TransitGatewayOwnerId *string - - // The ID of the AWS account that owns the resource. - ResourceOwnerId *string - - // The ID of the attachment. - TransitGatewayAttachmentId *string - - // The association. - Association *TransitGatewayAttachmentAssociation } // Describes an association. @@ -9060,37 +9060,37 @@ type TransitGatewayAttachmentAssociation struct { // Describes a propagation route table. type TransitGatewayAttachmentPropagation struct { - // The ID of the propagation route table. - TransitGatewayRouteTableId *string - // The state of the propagation route table. State TransitGatewayPropagationState + + // The ID of the propagation route table. + TransitGatewayRouteTableId *string } // Describes the deregistered transit gateway multicast group members. type TransitGatewayMulticastDeregisteredGroupMembers struct { + // The network interface IDs of the deregistered members. + DeregisteredNetworkInterfaceIds []*string + // The IP address assigned to the transit gateway multicast group. GroupIpAddress *string // The ID of the transit gateway multicast domain. TransitGatewayMulticastDomainId *string - - // The network interface IDs of the deregistered members. - DeregisteredNetworkInterfaceIds []*string } // Describes the deregistered transit gateway multicast group sources. type TransitGatewayMulticastDeregisteredGroupSources struct { - // The ID of the transit gateway multicast domain. - TransitGatewayMulticastDomainId *string - // The network interface IDs of the non-registered members. DeregisteredNetworkInterfaceIds []*string // The IP address assigned to the transit gateway multicast group. GroupIpAddress *string + + // The ID of the transit gateway multicast domain. + TransitGatewayMulticastDomainId *string } // Describes the transit gateway multicast domain. @@ -9099,17 +9099,17 @@ type TransitGatewayMulticastDomain struct { // The time the transit gateway multicast domain was created. CreationTime *time.Time - // The ID of the transit gateway. - TransitGatewayId *string - - // The ID of the transit gateway multicast domain. - TransitGatewayMulticastDomainId *string - // The state of the transit gateway multicast domain. State TransitGatewayMulticastDomainState // The tags for the transit gateway multicast domain. Tags []*Tag + + // The ID of the transit gateway. + TransitGatewayId *string + + // The ID of the transit gateway multicast domain. + TransitGatewayMulticastDomainId *string } // Describes the resources associated with the transit gateway multicast domain. @@ -9118,12 +9118,12 @@ type TransitGatewayMulticastDomainAssociation struct { // The ID of the resource. ResourceId *string - // The subnet associated with the transit gateway multicast domain. - Subnet *SubnetAssociation - // The type of resource, for example a VPC attachment. ResourceType TransitGatewayAttachmentResourceType + // The subnet associated with the transit gateway multicast domain. + Subnet *SubnetAssociation + // The ID of the transit gateway attachment. TransitGatewayAttachmentId *string } @@ -9131,20 +9131,20 @@ type TransitGatewayMulticastDomainAssociation struct { // Describes the multicast domain associations. type TransitGatewayMulticastDomainAssociations struct { - // The ID of the transit gateway multicast domain. - TransitGatewayMulticastDomainId *string - - // The ID of the transit gateway attachment. - TransitGatewayAttachmentId *string - // The ID of the resource. ResourceId *string + // The type of resource, for example a VPC attachment. + ResourceType TransitGatewayAttachmentResourceType + // The subnets associated with the multicast domain. Subnets []*SubnetAssociation - // The type of resource, for example a VPC attachment. - ResourceType TransitGatewayAttachmentResourceType + // The ID of the transit gateway attachment. + TransitGatewayAttachmentId *string + + // The ID of the transit gateway multicast domain. + TransitGatewayMulticastDomainId *string } // Describes the transit gateway multicast group resources. @@ -9153,117 +9153,117 @@ type TransitGatewayMulticastGroup struct { // The IP address assigned to the transit gateway multicast group. GroupIpAddress *string + // Indicates that the resource is a transit gateway multicast group member. + GroupMember *bool + + // Indicates that the resource is a transit gateway multicast group member. + GroupSource *bool + // The member type (for example, static). MemberType MembershipType // The ID of the transit gateway attachment. - TransitGatewayAttachmentId *string + NetworkInterfaceId *string // The ID of the resource. ResourceId *string - // Indicates that the resource is a transit gateway multicast group member. - GroupSource *bool + // The type of resource, for example a VPC attachment. + ResourceType TransitGatewayAttachmentResourceType // The source type. SourceType MembershipType - // Indicates that the resource is a transit gateway multicast group member. - GroupMember *bool - // The ID of the subnet. SubnetId *string // The ID of the transit gateway attachment. - NetworkInterfaceId *string - - // The type of resource, for example a VPC attachment. - ResourceType TransitGatewayAttachmentResourceType + TransitGatewayAttachmentId *string } // Describes the registered transit gateway multicast group members. type TransitGatewayMulticastRegisteredGroupMembers struct { - // The ID of the transit gateway multicast domain. - TransitGatewayMulticastDomainId *string + // The IP address assigned to the transit gateway multicast group. + GroupIpAddress *string // The ID of the registered network interfaces. RegisteredNetworkInterfaceIds []*string - // The IP address assigned to the transit gateway multicast group. - GroupIpAddress *string + // The ID of the transit gateway multicast domain. + TransitGatewayMulticastDomainId *string } // Describes the members registered with the transit gateway multicast group. type TransitGatewayMulticastRegisteredGroupSources struct { - // The ID of the transit gateway multicast domain. - TransitGatewayMulticastDomainId *string - // The IP address assigned to the transit gateway multicast group. GroupIpAddress *string // The IDs of the network interfaces members registered with the transit gateway // multicast group. RegisteredNetworkInterfaceIds []*string + + // The ID of the transit gateway multicast domain. + TransitGatewayMulticastDomainId *string } // Describes the options for a transit gateway. type TransitGatewayOptions struct { - // The ID of the default propagation route table. - PropagationDefaultRouteTableId *string - - // Indicates whether multicast is enabled on the transit gateway - MulticastSupport MulticastSupportValue - // A private Autonomous System Number (ASN) for the Amazon side of a BGP session. // The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for // 32-bit ASNs. AmazonSideAsn *int64 - // Indicates whether DNS support is enabled. - DnsSupport DnsSupportValue - // The ID of the default association route table. AssociationDefaultRouteTableId *string - // Indicates whether resource attachments automatically propagate routes to the - // default propagation route table. - DefaultRouteTablePropagation DefaultRouteTablePropagationValue + // Indicates whether attachment requests are automatically accepted. + AutoAcceptSharedAttachments AutoAcceptSharedAttachmentsValue // Indicates whether resource attachments are automatically associated with the // default association route table. DefaultRouteTableAssociation DefaultRouteTableAssociationValue + // Indicates whether resource attachments automatically propagate routes to the + // default propagation route table. + DefaultRouteTablePropagation DefaultRouteTablePropagationValue + + // Indicates whether DNS support is enabled. + DnsSupport DnsSupportValue + + // Indicates whether multicast is enabled on the transit gateway + MulticastSupport MulticastSupportValue + + // The ID of the default propagation route table. + PropagationDefaultRouteTableId *string + // Indicates whether Equal Cost Multipath Protocol support is enabled. VpnEcmpSupport VpnEcmpSupportValue - - // Indicates whether attachment requests are automatically accepted. - AutoAcceptSharedAttachments AutoAcceptSharedAttachmentsValue } // Describes the transit gateway peering attachment. type TransitGatewayPeeringAttachment struct { + // Information about the accepter transit gateway. + AccepterTgwInfo *PeeringTgwInfo + // The time the transit gateway peering attachment was created. CreationTime *time.Time - // The status of the transit gateway peering attachment. - Status *PeeringAttachmentStatus - - // The tags for the transit gateway peering attachment. - Tags []*Tag - // Information about the requester transit gateway. RequesterTgwInfo *PeeringTgwInfo - // Information about the accepter transit gateway. - AccepterTgwInfo *PeeringTgwInfo - // The state of the transit gateway peering attachment. State TransitGatewayAttachmentState + // The status of the transit gateway peering attachment. + Status *PeeringAttachmentStatus + + // The tags for the transit gateway peering attachment. + Tags []*Tag + // The ID of the transit gateway peering attachment. TransitGatewayAttachmentId *string } @@ -9271,50 +9271,50 @@ type TransitGatewayPeeringAttachment struct { // Describes route propagation. type TransitGatewayPropagation struct { - // The ID of the attachment. - TransitGatewayAttachmentId *string + // The ID of the resource. + ResourceId *string + + // The resource type. + ResourceType TransitGatewayAttachmentResourceType // The state. State TransitGatewayPropagationState + // The ID of the attachment. + TransitGatewayAttachmentId *string + // The ID of the transit gateway route table. TransitGatewayRouteTableId *string - - // The resource type. - ResourceType TransitGatewayAttachmentResourceType - - // The ID of the resource. - ResourceId *string } // Describes the options for a transit gateway. -type TransitGatewayRequestOptions struct { - - // Enable or disable automatic association with the default association route - // table. Enabled by default. - DefaultRouteTableAssociation DefaultRouteTableAssociationValue - - // Indicates whether multicast is enabled on the transit gateway - MulticastSupport MulticastSupportValue +type TransitGatewayRequestOptions struct { - // Enable or disable DNS support. Enabled by default. - DnsSupport DnsSupportValue + // A private Autonomous System Number (ASN) for the Amazon side of a BGP session. + // The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for + // 32-bit ASNs. The default is 64512. + AmazonSideAsn *int64 // Enable or disable automatic acceptance of attachment requests. Disabled by // default. AutoAcceptSharedAttachments AutoAcceptSharedAttachmentsValue + // Enable or disable automatic association with the default association route + // table. Enabled by default. + DefaultRouteTableAssociation DefaultRouteTableAssociationValue + // Enable or disable automatic propagation of routes to the default propagation // route table. Enabled by default. DefaultRouteTablePropagation DefaultRouteTablePropagationValue + // Enable or disable DNS support. Enabled by default. + DnsSupport DnsSupportValue + + // Indicates whether multicast is enabled on the transit gateway + MulticastSupport MulticastSupportValue + // Enable or disable Equal Cost Multipath Protocol support. Enabled by default. VpnEcmpSupport VpnEcmpSupportValue - - // A private Autonomous System Number (ASN) for the Amazon side of a BGP session. - // The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for - // 32-bit ASNs. The default is 64512. - AmazonSideAsn *int64 } // Describes a route for a transit gateway route table. @@ -9336,29 +9336,19 @@ type TransitGatewayRoute struct { // Describes a route attachment. type TransitGatewayRouteAttachment struct { - // The ID of the attachment. - TransitGatewayAttachmentId *string + // The ID of the resource. + ResourceId *string // The resource type. ResourceType TransitGatewayAttachmentResourceType - // The ID of the resource. - ResourceId *string + // The ID of the attachment. + TransitGatewayAttachmentId *string } // Describes a transit gateway route table. type TransitGatewayRouteTable struct { - // Indicates whether this is the default propagation route table for the transit - // gateway. - DefaultPropagationRouteTable *bool - - // The ID of the transit gateway route table. - TransitGatewayRouteTableId *string - - // Any tags assigned to the route table. - Tags []*Tag - // The creation time. CreationTime *time.Time @@ -9366,11 +9356,21 @@ type TransitGatewayRouteTable struct { // gateway. DefaultAssociationRouteTable *bool + // Indicates whether this is the default propagation route table for the transit + // gateway. + DefaultPropagationRouteTable *bool + // The state of the transit gateway route table. State TransitGatewayRouteTableState + // Any tags assigned to the route table. + Tags []*Tag + // The ID of the transit gateway. TransitGatewayId *string + + // The ID of the transit gateway route table. + TransitGatewayRouteTableId *string } // Describes an association between a route table and a resource attachment. @@ -9379,132 +9379,132 @@ type TransitGatewayRouteTableAssociation struct { // The ID of the resource. ResourceId *string - // The ID of the attachment. - TransitGatewayAttachmentId *string + // The resource type. + ResourceType TransitGatewayAttachmentResourceType // The state of the association. State TransitGatewayAssociationState - // The resource type. - ResourceType TransitGatewayAttachmentResourceType + // The ID of the attachment. + TransitGatewayAttachmentId *string } // Describes a route table propagation. type TransitGatewayRouteTablePropagation struct { - // The type of resource. - ResourceType TransitGatewayAttachmentResourceType - // The ID of the resource. ResourceId *string - // The ID of the attachment. - TransitGatewayAttachmentId *string + // The type of resource. + ResourceType TransitGatewayAttachmentResourceType // The state of the resource. State TransitGatewayPropagationState + + // The ID of the attachment. + TransitGatewayAttachmentId *string } // Describes a VPC attachment. type TransitGatewayVpcAttachment struct { + // The creation time. + CreationTime *time.Time + // The VPC attachment options. Options *TransitGatewayVpcAttachmentOptions + // The state of the VPC attachment. + State TransitGatewayAttachmentState + // The IDs of the subnets. SubnetIds []*string + // The tags for the VPC attachment. + Tags []*Tag + // The ID of the attachment. TransitGatewayAttachmentId *string - // The ID of the AWS account that owns the VPC. - VpcOwnerId *string - - // The state of the VPC attachment. - State TransitGatewayAttachmentState - // The ID of the transit gateway. TransitGatewayId *string - // The tags for the VPC attachment. - Tags []*Tag - // The ID of the VPC. VpcId *string - // The creation time. - CreationTime *time.Time + // The ID of the AWS account that owns the VPC. + VpcOwnerId *string } // Describes the VPC attachment options. type TransitGatewayVpcAttachmentOptions struct { - // Indicates whether IPv6 support is disabled. - Ipv6Support Ipv6SupportValue - // Indicates whether DNS support is enabled. DnsSupport DnsSupportValue + + // Indicates whether IPv6 support is disabled. + Ipv6Support Ipv6SupportValue } // The VPN tunnel options. type TunnelOption struct { - // The number of packets in an IKE replay window. - ReplayWindowSize *int32 - - // The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE - // negotiations. - Phase2DHGroupNumbers []*Phase2DHGroupNumbersListValue - // The number of seconds after which a DPD timeout occurs. DpdTimeoutSeconds *int32 - // The lifetime for phase 1 of the IKE negotiation, in seconds. - Phase1LifetimeSeconds *int32 + // The IKE versions that are permitted for the VPN tunnel. + IkeVersions []*IKEVersionsListValue + + // The external IP address of the VPN tunnel. + OutsideIpAddress *string // The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE // negotiations. Phase1DHGroupNumbers []*Phase1DHGroupNumbersListValue - // The range of inside IP addresses for the tunnel. - TunnelInsideCidr *string + // The permitted encryption algorithms for the VPN tunnel for phase 1 IKE + // negotiations. + Phase1EncryptionAlgorithms []*Phase1EncryptionAlgorithmsListValue - // The IKE versions that are permitted for the VPN tunnel. - IkeVersions []*IKEVersionsListValue + // The permitted integrity algorithms for the VPN tunnel for phase 1 IKE + // negotiations. + Phase1IntegrityAlgorithms []*Phase1IntegrityAlgorithmsListValue - // The margin time, in seconds, before the phase 2 lifetime expires, during which - // the AWS side of the VPN connection performs an IKE rekey. - RekeyMarginTimeSeconds *int32 + // The lifetime for phase 1 of the IKE negotiation, in seconds. + Phase1LifetimeSeconds *int32 + + // The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE + // negotiations. + Phase2DHGroupNumbers []*Phase2DHGroupNumbersListValue // The permitted encryption algorithms for the VPN tunnel for phase 2 IKE // negotiations. Phase2EncryptionAlgorithms []*Phase2EncryptionAlgorithmsListValue + // The permitted integrity algorithms for the VPN tunnel for phase 2 IKE + // negotiations. + Phase2IntegrityAlgorithms []*Phase2IntegrityAlgorithmsListValue + // The lifetime for phase 2 of the IKE negotiation, in seconds. Phase2LifetimeSeconds *int32 - // The permitted encryption algorithms for the VPN tunnel for phase 1 IKE - // negotiations. - Phase1EncryptionAlgorithms []*Phase1EncryptionAlgorithmsListValue - // The pre-shared key (PSK) to establish initial authentication between the virtual // private gateway and the customer gateway. PreSharedKey *string - // The external IP address of the VPN tunnel. - OutsideIpAddress *string - - // The permitted integrity algorithms for the VPN tunnel for phase 2 IKE - // negotiations. - Phase2IntegrityAlgorithms []*Phase2IntegrityAlgorithmsListValue - - // The permitted integrity algorithms for the VPN tunnel for phase 1 IKE - // negotiations. - Phase1IntegrityAlgorithms []*Phase1IntegrityAlgorithmsListValue - // The percentage of the rekey window determined by RekeyMarginTimeSeconds during // which the rekey time is randomly selected. RekeyFuzzPercentage *int32 + + // The margin time, in seconds, before the phase 2 lifetime expires, during which + // the AWS side of the VPN connection performs an IKE rekey. + RekeyMarginTimeSeconds *int32 + + // The number of packets in an IKE replay window. + ReplayWindowSize *int32 + + // The range of inside IP addresses for the tunnel. + TunnelInsideCidr *string } // Describes the burstable performance instance whose credit option for CPU usage @@ -9533,11 +9533,11 @@ type UnsuccessfulInstanceCreditSpecificationItemError struct { // Information about items that were not successfully processed in a batch call. type UnsuccessfulItem struct { - // The ID of the resource. - ResourceId *string - // Information about the error. Error *UnsuccessfulItemError + + // The ID of the resource. + ResourceId *string } // Information about the error that occurred. For more information about errors, @@ -9555,21 +9555,21 @@ type UnsuccessfulItemError struct { // Describes the Amazon S3 bucket for the disk image. type UserBucket struct { - // The file name of the disk image. - S3Key *string - // The name of the Amazon S3 bucket where the disk image is located. S3Bucket *string + + // The file name of the disk image. + S3Key *string } // Describes the Amazon S3 bucket for the disk image. type UserBucketDetails struct { - // The file name of the disk image. - S3Key *string - // The Amazon S3 bucket from which the disk image was created. S3Bucket *string + + // The file name of the disk image. + S3Key *string } // Describes the user data for an instance. @@ -9584,22 +9584,13 @@ type UserData struct { // Describes a security group and AWS account ID pair. type UserIdGroupPair struct { - // The ID of the security group. - GroupId *string - - // The ID of the VPC for the referenced security group, if applicable. - VpcId *string - - // The status of a VPC peering connection, if applicable. - PeeringStatus *string - // A description for the security group rule that references this user ID group // pair. Constraints: Up to 255 characters in length. Allowed characters are a-z, // A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* Description *string - // The ID of the VPC peering connection, if applicable. - VpcPeeringConnectionId *string + // The ID of the security group. + GroupId *string // The name of the security group. In a request, use this parameter for a security // group in EC2-Classic or a default VPC only. For a security group in a nondefault @@ -9607,12 +9598,21 @@ type UserIdGroupPair struct { // this value is not returned if the referenced security group is deleted. GroupName *string + // The status of a VPC peering connection, if applicable. + PeeringStatus *string + // The ID of an AWS account. For a referenced security group in another VPC, the // account ID of the referenced security group is returned in the response. If the // referenced security group is deleted, this value is not returned. [EC2-Classic] // Required when adding or removing rules that reference a security group in // another AWS account. UserId *string + + // The ID of the VPC for the referenced security group, if applicable. + VpcId *string + + // The ID of the VPC peering connection, if applicable. + VpcPeeringConnectionId *string } // The error code and error message that is returned for a parameter or parameter @@ -9643,18 +9643,18 @@ type ValidationWarning struct { // Describes the vCPU configurations for the instance type. type VCpuInfo struct { - // The default number of vCPUs for the instance type. - DefaultVCpus *int32 + // The default number of cores for the instance type. + DefaultCores *int32 // The default number of threads per core for the instance type. DefaultThreadsPerCore *int32 + // The default number of vCPUs for the instance type. + DefaultVCpus *int32 + // List of the valid number of cores that can be configured for the instance type. ValidCores []*int32 - // The default number of cores for the instance type. - DefaultCores *int32 - // List of the valid number of threads per core that can be configured for the // instance type. ValidThreadsPerCore []*int32 @@ -9666,62 +9666,28 @@ type VgwTelemetry struct { // The number of accepted routes. AcceptedRouteCount *int32 - // The date and time of the last change in status. - LastStatusChange *time.Time - // The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate. CertificateArn *string + // The date and time of the last change in status. + LastStatusChange *time.Time + // The Internet-routable IP address of the virtual private gateway's outside // interface. OutsideIpAddress *string - // If an error occurs, a description of the error. - StatusMessage *string - // The status of the VPN tunnel. Status TelemetryStatus + + // If an error occurs, a description of the error. + StatusMessage *string } // Describes a volume. type Volume struct { - // Indicates whether the volume is encrypted. - Encrypted *bool - - // Any tags assigned to the volume. - Tags []*Tag - - // Indicates whether Amazon EBS Multi-Attach is enabled. - MultiAttachEnabled *bool - - // The Amazon Resource Name (ARN) of the Outpost. - OutpostArn *string - - // The size of the volume, in GiBs. - Size *int32 - - // The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned - // IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for - // Magnetic volumes. - VolumeType VolumeType - - // Indicates whether the volume was created using fast snapshot restore. - FastRestored *bool - - // Information about the volume attachments. - Attachments []*VolumeAttachment - - // The snapshot from which the volume was created, if applicable. - SnapshotId *string - - // The volume state. - State VolumeState - - // The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) - // customer master key (CMK) that was used to protect the volume encryption key for - // the volume. - KmsKeyId *string + // Information about the volume attachments. + Attachments []*VolumeAttachment // The Availability Zone for the volume. AvailabilityZone *string @@ -9729,8 +9695,11 @@ type Volume struct { // The time stamp when volume creation was initiated. CreateTime *time.Time - // The ID of the volume. - VolumeId *string + // Indicates whether the volume is encrypted. + Encrypted *bool + + // Indicates whether the volume was created using fast snapshot restore. + FastRestored *bool // The number of I/O operations per second (IOPS) that the volume supports. For // Provisioned IOPS SSD volumes, this represents the number of IOPS that are @@ -9746,28 +9715,59 @@ type Volume struct { // parameter is required for requests to create io1 volumes; it is not used in // requests to create gp2, st1, sc1, or standard volumes. Iops *int32 -} -// Describes volume attachment details. -type VolumeAttachment struct { + // The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) + // customer master key (CMK) that was used to protect the volume encryption key for + // the volume. + KmsKeyId *string + + // Indicates whether Amazon EBS Multi-Attach is enabled. + MultiAttachEnabled *bool + + // The Amazon Resource Name (ARN) of the Outpost. + OutpostArn *string + + // The size of the volume, in GiBs. + Size *int32 + + // The snapshot from which the volume was created, if applicable. + SnapshotId *string + + // The volume state. + State VolumeState + + // Any tags assigned to the volume. + Tags []*Tag // The ID of the volume. VolumeId *string - // The ID of the instance. - InstanceId *string + // The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned + // IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for + // Magnetic volumes. + VolumeType VolumeType +} + +// Describes volume attachment details. +type VolumeAttachment struct { // The time stamp when the attachment initiated. AttachTime *time.Time + // Indicates whether the EBS volume is deleted on instance termination. + DeleteOnTermination *bool + // The device name. Device *string - // Indicates whether the EBS volume is deleted on instance termination. - DeleteOnTermination *bool + // The ID of the instance. + InstanceId *string // The attachment state of the volume. State VolumeAttachmentState + + // The ID of the volume. + VolumeId *string } // Describes an EBS volume. @@ -9783,18 +9783,15 @@ type VolumeDetail struct { // modified, some element values will be null. type VolumeModification struct { - // The original IOPS rate of the volume. - OriginalIops *int32 + // The modification completion or failure time. + EndTime *time.Time // The current modification state. The modification state is null for unmodified // volumes. ModificationState VolumeModificationState - // The target EBS volume type of the volume. - TargetVolumeType VolumeType - - // The target size of the volume, in GiB. - TargetSize *int32 + // The original IOPS rate of the volume. + OriginalIops *int32 // The original size of the volume, in GiB. OriginalSize *int32 @@ -9802,39 +9799,42 @@ type VolumeModification struct { // The original EBS volume type of the volume. OriginalVolumeType VolumeType - // The modification completion or failure time. - EndTime *time.Time - - // The ID of the volume. - VolumeId *string - // The modification progress, from 0 to 100 percent complete. Progress *int64 + // The modification start time. + StartTime *time.Time + // A status message about the modification progress or failure. StatusMessage *string // The target IOPS rate of the volume. TargetIops *int32 - // The modification start time. - StartTime *time.Time + // The target size of the volume, in GiB. + TargetSize *int32 + + // The target EBS volume type of the volume. + TargetVolumeType VolumeType + + // The ID of the volume. + VolumeId *string } // Describes a volume status operation code. type VolumeStatusAction struct { - // The event type associated with this operation. - EventType *string + // The code identifying the operation, for example, enable-volume-io. + Code *string // A description of the operation. Description *string - // The code identifying the operation, for example, enable-volume-io. - Code *string - // The ID of the event associated with this operation. EventId *string + + // The event type associated with this operation. + EventType *string } // Information about the instances to which the volume is attached. @@ -9850,33 +9850,33 @@ type VolumeStatusAttachmentStatus struct { // Describes a volume status. type VolumeStatusDetails struct { - // The intended status of the volume status. - Status *string - // The name of the volume status. Name VolumeStatusName + + // The intended status of the volume status. + Status *string } // Describes a volume status event. type VolumeStatusEvent struct { - // The ID of this event. - EventId *string - - // The earliest start time of the event. - NotBefore *time.Time - // A description of the event. Description *string - // The ID of the instance associated with the event. - InstanceId *string + // The ID of this event. + EventId *string // The type of this event. EventType *string + // The ID of the instance associated with the event. + InstanceId *string + // The latest end time of the event. NotAfter *time.Time + + // The earliest start time of the event. + NotBefore *time.Time } // Describes the status of a volume. @@ -9892,14 +9892,17 @@ type VolumeStatusInfo struct { // Describes the volume status. type VolumeStatusItem struct { - // The Availability Zone of the volume. - AvailabilityZone *string + // The details of the operation. + Actions []*VolumeStatusAction // Information about the instances to which the volume is attached. AttachmentStatuses []*VolumeStatusAttachmentStatus - // The volume status. - VolumeStatus *VolumeStatusInfo + // The Availability Zone of the volume. + AvailabilityZone *string + + // A list of events associated with the volume. + Events []*VolumeStatusEvent // The Amazon Resource Name (ARN) of the Outpost. OutpostArn *string @@ -9907,46 +9910,43 @@ type VolumeStatusItem struct { // The volume ID. VolumeId *string - // A list of events associated with the volume. - Events []*VolumeStatusEvent - - // The details of the operation. - Actions []*VolumeStatusAction + // The volume status. + VolumeStatus *VolumeStatusInfo } // Describes a VPC. type Vpc struct { - // The ID of the AWS account that owns the VPC. - OwnerId *string + // The primary IPv4 CIDR block for the VPC. + CidrBlock *string + + // Information about the IPv4 CIDR blocks associated with the VPC. + CidrBlockAssociationSet []*VpcCidrBlockAssociation // The ID of the set of DHCP options you've associated with the VPC (or default if // the default options are associated with the VPC). DhcpOptionsId *string - // The primary IPv4 CIDR block for the VPC. - CidrBlock *string + // The allowed tenancy of instances launched into the VPC. + InstanceTenancy Tenancy - // The current state of the VPC. - State VpcState + // Information about the IPv6 CIDR blocks associated with the VPC. + Ipv6CidrBlockAssociationSet []*VpcIpv6CidrBlockAssociation // Indicates whether the VPC is the default VPC. IsDefault *bool - // The ID of the VPC. - VpcId *string + // The ID of the AWS account that owns the VPC. + OwnerId *string - // Information about the IPv4 CIDR blocks associated with the VPC. - CidrBlockAssociationSet []*VpcCidrBlockAssociation + // The current state of the VPC. + State VpcState // Any tags assigned to the VPC. Tags []*Tag - // Information about the IPv6 CIDR blocks associated with the VPC. - Ipv6CidrBlockAssociationSet []*VpcIpv6CidrBlockAssociation - - // The allowed tenancy of instances launched into the VPC. - InstanceTenancy Tenancy + // The ID of the VPC. + VpcId *string } // Describes an attachment between a virtual private gateway and a VPC. @@ -9962,68 +9962,70 @@ type VpcAttachment struct { // Describes an IPv4 CIDR block associated with a VPC. type VpcCidrBlockAssociation struct { - // Information about the state of the CIDR block. - CidrBlockState *VpcCidrBlockState - // The association ID for the IPv4 CIDR block. AssociationId *string // The IPv4 CIDR block. CidrBlock *string + + // Information about the state of the CIDR block. + CidrBlockState *VpcCidrBlockState } // Describes the state of a CIDR block. type VpcCidrBlockState struct { - // A message about the status of the CIDR block, if applicable. - StatusMessage *string - // The state of the CIDR block. State VpcCidrBlockStateCode + + // A message about the status of the CIDR block, if applicable. + StatusMessage *string } // Describes whether a VPC is enabled for ClassicLink. type VpcClassicLink struct { - // The ID of the VPC. - VpcId *string - // Indicates whether the VPC is enabled for ClassicLink. ClassicLinkEnabled *bool // Any tags assigned to the VPC. Tags []*Tag + + // The ID of the VPC. + VpcId *string } // Describes a VPC endpoint. type VpcEndpoint struct { - // The last error that occurred for VPC endpoint. - LastError *LastError + // The date and time that the VPC endpoint was created. + CreationTimestamp *time.Time - // The policy document associated with the endpoint, if applicable. - PolicyDocument *string + // (Interface endpoint) The DNS entries for the endpoint. + DnsEntries []*DnsEntry - // The ID of the VPC endpoint. - VpcEndpointId *string + // (Interface endpoint) Information about the security groups that are associated + // with the network interface. + Groups []*SecurityGroupIdentifier - // Any tags assigned to the VPC endpoint. - Tags []*Tag + // The last error that occurred for VPC endpoint. + LastError *LastError // (Interface endpoint) One or more network interfaces for the endpoint. NetworkInterfaceIds []*string - // (Interface endpoint) One or more subnets in which the endpoint is located. - SubnetIds []*string + // The ID of the AWS account that owns the VPC endpoint. + OwnerId *string - // The type of endpoint. - VpcEndpointType VpcEndpointType + // The policy document associated with the endpoint, if applicable. + PolicyDocument *string - // The date and time that the VPC endpoint was created. - CreationTimestamp *time.Time + // (Interface endpoint) Indicates whether the VPC is associated with a private + // hosted zone. + PrivateDnsEnabled *bool - // (Interface endpoint) The DNS entries for the endpoint. - DnsEntries []*DnsEntry + // Indicates whether the VPC endpoint is being managed by its service. + RequesterManaged *bool // (Gateway endpoint) One or more route tables associated with the endpoint. RouteTableIds []*string @@ -10031,22 +10033,20 @@ type VpcEndpoint struct { // The name of the service to which the endpoint is associated. ServiceName *string - // The ID of the AWS account that owns the VPC endpoint. - OwnerId *string - - // (Interface endpoint) Information about the security groups that are associated - // with the network interface. - Groups []*SecurityGroupIdentifier - // The state of the VPC endpoint. State State - // Indicates whether the VPC endpoint is being managed by its service. - RequesterManaged *bool + // (Interface endpoint) One or more subnets in which the endpoint is located. + SubnetIds []*string - // (Interface endpoint) Indicates whether the VPC is associated with a private - // hosted zone. - PrivateDnsEnabled *bool + // Any tags assigned to the VPC endpoint. + Tags []*Tag + + // The ID of the VPC endpoint. + VpcEndpointId *string + + // The type of endpoint. + VpcEndpointType VpcEndpointType // The ID of the VPC to which the endpoint is associated. VpcId *string @@ -10055,45 +10055,45 @@ type VpcEndpoint struct { // Describes a VPC endpoint connection to a service. type VpcEndpointConnection struct { - // The ID of the VPC endpoint. - VpcEndpointId *string + // The date and time that the VPC endpoint was created. + CreationTimestamp *time.Time - // The state of the VPC endpoint. - VpcEndpointState State + // The DNS entries for the VPC endpoint. + DnsEntries []*DnsEntry - // The AWS account ID of the owner of the VPC endpoint. - VpcEndpointOwner *string + // The Amazon Resource Names (ARNs) of the network load balancers for the service. + NetworkLoadBalancerArns []*string // The ID of the service to which the endpoint is connected. ServiceId *string - // The Amazon Resource Names (ARNs) of the network load balancers for the service. - NetworkLoadBalancerArns []*string + // The ID of the VPC endpoint. + VpcEndpointId *string - // The DNS entries for the VPC endpoint. - DnsEntries []*DnsEntry + // The AWS account ID of the owner of the VPC endpoint. + VpcEndpointOwner *string - // The date and time that the VPC endpoint was created. - CreationTimestamp *time.Time + // The state of the VPC endpoint. + VpcEndpointState State } // Describes an IPv6 CIDR block associated with a VPC. type VpcIpv6CidrBlockAssociation struct { - // The name of the location from which we advertise the IPV6 CIDR block. - NetworkBorderGroup *string - // The association ID for the IPv6 CIDR block. AssociationId *string // The IPv6 CIDR block. Ipv6CidrBlock *string + // Information about the state of the CIDR block. + Ipv6CidrBlockState *VpcCidrBlockState + // The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated. Ipv6Pool *string - // Information about the state of the CIDR block. - Ipv6CidrBlockState *VpcCidrBlockState + // The name of the location from which we advertise the IPV6 CIDR block. + NetworkBorderGroup *string } // Describes a VPC peering connection. @@ -10103,30 +10103,26 @@ type VpcPeeringConnection struct { // describing an active VPC peering connection. AccepterVpcInfo *VpcPeeringConnectionVpcInfo + // The time that an unaccepted VPC peering connection will expire. + ExpirationTime *time.Time + // Information about the requester VPC. CIDR block information is only returned // when describing an active VPC peering connection. RequesterVpcInfo *VpcPeeringConnectionVpcInfo - // Any tags assigned to the resource. - Tags []*Tag - // The status of the VPC peering connection. Status *VpcPeeringConnectionStateReason + // Any tags assigned to the resource. + Tags []*Tag + // The ID of the VPC peering connection. VpcPeeringConnectionId *string - - // The time that an unaccepted VPC peering connection will expire. - ExpirationTime *time.Time } // Describes the VPC peering connection options. type VpcPeeringConnectionOptionsDescription struct { - // Indicates whether a local VPC can communicate with a ClassicLink connection in - // the peer VPC over the VPC peering connection. - AllowEgressFromLocalVpcToRemoteClassicLink *bool - // Indicates whether a local VPC can resolve public DNS hostnames to private IP // addresses when queried from instances in a peer VPC. AllowDnsResolutionFromRemoteVpc *bool @@ -10134,86 +10130,90 @@ type VpcPeeringConnectionOptionsDescription struct { // Indicates whether a local ClassicLink connection can communicate with the peer // VPC over the VPC peering connection. AllowEgressFromLocalClassicLinkToRemoteVpc *bool + + // Indicates whether a local VPC can communicate with a ClassicLink connection in + // the peer VPC over the VPC peering connection. + AllowEgressFromLocalVpcToRemoteClassicLink *bool } // Describes the status of a VPC peering connection. type VpcPeeringConnectionStateReason struct { - // A message that provides more information about the status, if applicable. - Message *string - // The status of the VPC peering connection. Code VpcPeeringConnectionStateReasonCode + + // A message that provides more information about the status, if applicable. + Message *string } // Describes a VPC in a VPC peering connection. type VpcPeeringConnectionVpcInfo struct { - // The Region in which the VPC is located. - Region *string + // The IPv4 CIDR block for the VPC. + CidrBlock *string + + // Information about the IPv4 CIDR blocks for the VPC. + CidrBlockSet []*CidrBlock // The IPv6 CIDR block for the VPC. Ipv6CidrBlockSet []*Ipv6CidrBlock - // The IPv4 CIDR block for the VPC. - CidrBlock *string - - // The ID of the VPC. - VpcId *string + // The AWS account ID of the VPC owner. + OwnerId *string // Information about the VPC peering connection options for the accepter or // requester VPC. PeeringOptions *VpcPeeringConnectionOptionsDescription - // Information about the IPv4 CIDR blocks for the VPC. - CidrBlockSet []*CidrBlock + // The Region in which the VPC is located. + Region *string - // The AWS account ID of the VPC owner. - OwnerId *string + // The ID of the VPC. + VpcId *string } // Describes a VPN connection. type VpnConnection struct { - // The type of VPN connection. - Type GatewayType - - // The ID of the virtual private gateway at the AWS side of the VPN connection. - VpnGatewayId *string + // The category of the VPN connection. A value of VPN indicates an AWS VPN + // connection. A value of VPN-Classic indicates an AWS Classic VPN connection. + Category *string - // Information about the VPN tunnel. - VgwTelemetry []*VgwTelemetry + // The configuration information for the VPN connection's customer gateway (in the + // native XML format). This element is always present in the CreateVpnConnection () + // response; however, it's present in the DescribeVpnConnections () response only + // if the VPN connection is in the pending or available state. + CustomerGatewayConfiguration *string // The ID of the customer gateway at your end of the VPN connection. CustomerGatewayId *string - // The ID of the transit gateway associated with the VPN connection. - TransitGatewayId *string - - // The static routes associated with the VPN connection. - Routes []*VpnStaticRoute - // The VPN connection options. Options *VpnConnectionOptions - // The ID of the VPN connection. - VpnConnectionId *string - - // The configuration information for the VPN connection's customer gateway (in the - // native XML format). This element is always present in the CreateVpnConnection () - // response; however, it's present in the DescribeVpnConnections () response only - // if the VPN connection is in the pending or available state. - CustomerGatewayConfiguration *string + // The static routes associated with the VPN connection. + Routes []*VpnStaticRoute // The current state of the VPN connection. State VpnState - // The category of the VPN connection. A value of VPN indicates an AWS VPN - // connection. A value of VPN-Classic indicates an AWS Classic VPN connection. - Category *string - // Any tags assigned to the VPN connection. Tags []*Tag + + // The ID of the transit gateway associated with the VPN connection. + TransitGatewayId *string + + // The type of VPN connection. + Type GatewayType + + // Information about the VPN tunnel. + VgwTelemetry []*VgwTelemetry + + // The ID of the VPN connection. + VpnConnectionId *string + + // The ID of the virtual private gateway at the AWS side of the VPN connection. + VpnGatewayId *string } // Describes VPN connection options. @@ -10222,34 +10222,38 @@ type VpnConnectionOptions struct { // Indicates whether acceleration is enabled for the VPN connection. EnableAcceleration *bool - // Indicates the VPN tunnel options. - TunnelOptions []*TunnelOption - // Indicates whether the VPN connection uses static routes only. Static routes must // be used for devices that don't support BGP. StaticRoutesOnly *bool + + // Indicates the VPN tunnel options. + TunnelOptions []*TunnelOption } // Describes VPN connection options. type VpnConnectionOptionsSpecification struct { - // The tunnel options for the VPN connection. - TunnelOptions []*VpnTunnelOptionsSpecification + // Indicate whether to enable acceleration for the VPN connection. Default: false + EnableAcceleration *bool // Indicate whether the VPN connection uses static routes only. If you are creating // a VPN connection for a device that does not support BGP, you must specify true. // Use CreateVpnConnectionRoute () to create a static route. Default: false StaticRoutesOnly *bool - // Indicate whether to enable acceleration for the VPN connection. Default: false - EnableAcceleration *bool + // The tunnel options for the VPN connection. + TunnelOptions []*VpnTunnelOptionsSpecification } // Describes a virtual private gateway. type VpnGateway struct { - // The ID of the virtual private gateway. - VpnGatewayId *string + // The private Autonomous System Number (ASN) for the Amazon side of a BGP session. + AmazonSideAsn *int64 + + // The Availability Zone where the virtual private gateway was created, if + // applicable. This field may be empty or not returned. + AvailabilityZone *string // The current state of the virtual private gateway. State VpnState @@ -10257,64 +10261,95 @@ type VpnGateway struct { // Any tags assigned to the virtual private gateway. Tags []*Tag - // Any VPCs attached to the virtual private gateway. - VpcAttachments []*VpcAttachment - - // The private Autonomous System Number (ASN) for the Amazon side of a BGP session. - AmazonSideAsn *int64 - // The type of VPN connection the virtual private gateway supports. Type GatewayType - // The Availability Zone where the virtual private gateway was created, if - // applicable. This field may be empty or not returned. - AvailabilityZone *string + // Any VPCs attached to the virtual private gateway. + VpcAttachments []*VpcAttachment + + // The ID of the virtual private gateway. + VpnGatewayId *string } // Describes a static route for a VPN connection. type VpnStaticRoute struct { + // The CIDR block associated with the local subnet of the customer data center. + DestinationCidrBlock *string + // Indicates how the routes were provided. Source VpnStaticRouteSource // The current state of the static route. State VpnState - - // The CIDR block associated with the local subnet of the customer data center. - DestinationCidrBlock *string } // The tunnel options for a single VPN tunnel. type VpnTunnelOptionsSpecification struct { - // The margin time, in seconds, before the phase 2 lifetime expires, during which - // the AWS side of the VPN connection performs an IKE rekey. The exact time of the - // rekey is randomly selected based on the value for RekeyFuzzPercentage. - // Constraints: A value between 60 and half of Phase2LifetimeSeconds. Default: 540 - RekeyMarginTimeSeconds *int32 + // The number of seconds after which a DPD timeout occurs. Constraints: A value + // between 0 and 30. Default: 30 + DPDTimeoutSeconds *int32 - // The lifetime for phase 2 of the IKE negotiation, in seconds. Constraints: A - // value between 900 and 3,600. The value must be less than the value for - // Phase1LifetimeSeconds. Default: 3600 - Phase2LifetimeSeconds *int32 + // The IKE versions that are permitted for the VPN tunnel. Valid values: ikev1 | + // ikev2 + IKEVersions []*IKEVersionsRequestListValue + + // One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel + // for phase 1 IKE negotiations. Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 22 | 23 + // | 24 + Phase1DHGroupNumbers []*Phase1DHGroupNumbersRequestListValue + + // One or more encryption algorithms that are permitted for the VPN tunnel for + // phase 1 IKE negotiations. Valid values: AES128 | AES256 + Phase1EncryptionAlgorithms []*Phase1EncryptionAlgorithmsRequestListValue + + // One or more integrity algorithms that are permitted for the VPN tunnel for phase + // 1 IKE negotiations. Valid values: SHA1 | SHA2-256 + Phase1IntegrityAlgorithms []*Phase1IntegrityAlgorithmsRequestListValue + + // The lifetime for phase 1 of the IKE negotiation, in seconds. Constraints: A + // value between 900 and 28,800. Default: 28800 + Phase1LifetimeSeconds *int32 + + // One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel + // for phase 2 IKE negotiations. Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 22 + // | 23 | 24 + Phase2DHGroupNumbers []*Phase2DHGroupNumbersRequestListValue + + // One or more encryption algorithms that are permitted for the VPN tunnel for + // phase 2 IKE negotiations. Valid values: AES128 | AES256 + Phase2EncryptionAlgorithms []*Phase2EncryptionAlgorithmsRequestListValue // One or more integrity algorithms that are permitted for the VPN tunnel for phase // 2 IKE negotiations. Valid values: SHA1 | SHA2-256 Phase2IntegrityAlgorithms []*Phase2IntegrityAlgorithmsRequestListValue + // The lifetime for phase 2 of the IKE negotiation, in seconds. Constraints: A + // value between 900 and 3,600. The value must be less than the value for + // Phase1LifetimeSeconds. Default: 3600 + Phase2LifetimeSeconds *int32 + // The pre-shared key (PSK) to establish initial authentication between the virtual // private gateway and customer gateway. Constraints: Allowed characters are // alphanumeric characters, periods (.), and underscores (_). Must be between 8 and // 64 characters in length and cannot start with zero (0). PreSharedKey *string - // One or more integrity algorithms that are permitted for the VPN tunnel for phase - // 1 IKE negotiations. Valid values: SHA1 | SHA2-256 - Phase1IntegrityAlgorithms []*Phase1IntegrityAlgorithmsRequestListValue + // The percentage of the rekey window (determined by RekeyMarginTimeSeconds) during + // which the rekey time is randomly selected. Constraints: A value between 0 and + // 100. Default: 100 + RekeyFuzzPercentage *int32 - // The IKE versions that are permitted for the VPN tunnel. Valid values: ikev1 | - // ikev2 - IKEVersions []*IKEVersionsRequestListValue + // The margin time, in seconds, before the phase 2 lifetime expires, during which + // the AWS side of the VPN connection performs an IKE rekey. The exact time of the + // rekey is randomly selected based on the value for RekeyFuzzPercentage. + // Constraints: A value between 60 and half of Phase2LifetimeSeconds. Default: 540 + RekeyMarginTimeSeconds *int32 + + // The number of packets in an IKE replay window. Constraints: A value between 64 + // and 2048. Default: 1024 + ReplayWindowSize *int32 // The range of inside IP addresses for the tunnel. Any specified CIDR blocks must // be unique across all VPN connections that use the same virtual private gateway. @@ -10337,39 +10372,4 @@ type VpnTunnelOptionsSpecification struct { // // * 169.254.169.252/30 TunnelInsideCidr *string - - // One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel - // for phase 1 IKE negotiations. Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 22 | 23 - // | 24 - Phase1DHGroupNumbers []*Phase1DHGroupNumbersRequestListValue - - // The number of packets in an IKE replay window. Constraints: A value between 64 - // and 2048. Default: 1024 - ReplayWindowSize *int32 - - // One or more encryption algorithms that are permitted for the VPN tunnel for - // phase 2 IKE negotiations. Valid values: AES128 | AES256 - Phase2EncryptionAlgorithms []*Phase2EncryptionAlgorithmsRequestListValue - - // One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel - // for phase 2 IKE negotiations. Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 22 - // | 23 | 24 - Phase2DHGroupNumbers []*Phase2DHGroupNumbersRequestListValue - - // The percentage of the rekey window (determined by RekeyMarginTimeSeconds) during - // which the rekey time is randomly selected. Constraints: A value between 0 and - // 100. Default: 100 - RekeyFuzzPercentage *int32 - - // The lifetime for phase 1 of the IKE negotiation, in seconds. Constraints: A - // value between 900 and 28,800. Default: 28800 - Phase1LifetimeSeconds *int32 - - // One or more encryption algorithms that are permitted for the VPN tunnel for - // phase 1 IKE negotiations. Valid values: AES128 | AES256 - Phase1EncryptionAlgorithms []*Phase1EncryptionAlgorithmsRequestListValue - - // The number of seconds after which a DPD timeout occurs. Constraints: A value - // between 0 and 30. Default: 30 - DPDTimeoutSeconds *int32 } diff --git a/service/ec2instanceconnect/api_op_SendSSHPublicKey.go b/service/ec2instanceconnect/api_op_SendSSHPublicKey.go index a2ca8a03ecc..a7f63808ce0 100644 --- a/service/ec2instanceconnect/api_op_SendSSHPublicKey.go +++ b/service/ec2instanceconnect/api_op_SendSSHPublicKey.go @@ -67,27 +67,27 @@ type SendSSHPublicKeyInput struct { // This member is required. InstanceId *string - // The public key to be published to the instance. To use it after publication you - // must have the matching private key. + // The OS user on the EC2 instance whom the key may be used to authenticate as. // // This member is required. - SSHPublicKey *string + InstanceOSUser *string - // The OS user on the EC2 instance whom the key may be used to authenticate as. + // The public key to be published to the instance. To use it after publication you + // must have the matching private key. // // This member is required. - InstanceOSUser *string + SSHPublicKey *string } type SendSSHPublicKeyOutput struct { - // Indicates request success. - Success *bool - // The request ID as logged by EC2 Connect. Please provide this when contacting AWS // Support. RequestId *string + // Indicates request success. + Success *bool + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ec2instanceconnect/go.mod b/service/ec2instanceconnect/go.mod index a0112b89ed7..97a90e4d09a 100644 --- a/service/ec2instanceconnect/go.mod +++ b/service/ec2instanceconnect/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/ec2instanceconnect go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/ecr/api_op_BatchCheckLayerAvailability.go b/service/ecr/api_op_BatchCheckLayerAvailability.go index f30d6f814f7..cb8af5fc314 100644 --- a/service/ecr/api_op_BatchCheckLayerAvailability.go +++ b/service/ecr/api_op_BatchCheckLayerAvailability.go @@ -62,10 +62,6 @@ func (c *Client) BatchCheckLayerAvailability(ctx context.Context, params *BatchC type BatchCheckLayerAvailabilityInput struct { - // The AWS account ID associated with the registry that contains the image layers - // to check. If you do not specify a registry, the default registry is assumed. - RegistryId *string - // The digests of the image layers to check. // // This member is required. @@ -75,6 +71,10 @@ type BatchCheckLayerAvailabilityInput struct { // // This member is required. RepositoryName *string + + // The AWS account ID associated with the registry that contains the image layers + // to check. If you do not specify a registry, the default registry is assumed. + RegistryId *string } type BatchCheckLayerAvailabilityOutput struct { diff --git a/service/ecr/api_op_BatchDeleteImage.go b/service/ecr/api_op_BatchDeleteImage.go index 669b288562e..387f8581f4a 100644 --- a/service/ecr/api_op_BatchDeleteImage.go +++ b/service/ecr/api_op_BatchDeleteImage.go @@ -81,12 +81,12 @@ type BatchDeleteImageInput struct { type BatchDeleteImageOutput struct { - // The image IDs of the deleted images. - ImageIds []*types.ImageIdentifier - // Any failures associated with the call. Failures []*types.ImageFailure + // The image IDs of the deleted images. + ImageIds []*types.ImageIdentifier + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ecr/api_op_BatchGetImage.go b/service/ecr/api_op_BatchGetImage.go index 1011458cd5c..07e437cb311 100644 --- a/service/ecr/api_op_BatchGetImage.go +++ b/service/ecr/api_op_BatchGetImage.go @@ -70,15 +70,15 @@ type BatchGetImageInput struct { // This member is required. RepositoryName *string - // The AWS account ID associated with the registry that contains the images to - // describe. If you do not specify a registry, the default registry is assumed. - RegistryId *string - // The accepted media types for the request. Valid values: // application/vnd.docker.distribution.manifest.v1+json | // application/vnd.docker.distribution.manifest.v2+json | // application/vnd.oci.image.manifest.v1+json AcceptedMediaTypes []*string + + // The AWS account ID associated with the registry that contains the images to + // describe. If you do not specify a registry, the default registry is assumed. + RegistryId *string } type BatchGetImageOutput struct { diff --git a/service/ecr/api_op_CompleteLayerUpload.go b/service/ecr/api_op_CompleteLayerUpload.go index a537d91088d..4724c40f6c7 100644 --- a/service/ecr/api_op_CompleteLayerUpload.go +++ b/service/ecr/api_op_CompleteLayerUpload.go @@ -62,41 +62,41 @@ func (c *Client) CompleteLayerUpload(ctx context.Context, params *CompleteLayerU type CompleteLayerUploadInput struct { - // The name of the repository to associate with the image layer. + // The sha256 digest of the image layer. // // This member is required. - RepositoryName *string - - // The AWS account ID associated with the registry to which to upload layers. If - // you do not specify a registry, the default registry is assumed. - RegistryId *string + LayerDigests []*string - // The sha256 digest of the image layer. + // The name of the repository to associate with the image layer. // // This member is required. - LayerDigests []*string + RepositoryName *string // The upload ID from a previous InitiateLayerUpload () operation to associate with // the image layer. // // This member is required. UploadId *string + + // The AWS account ID associated with the registry to which to upload layers. If + // you do not specify a registry, the default registry is assumed. + RegistryId *string } type CompleteLayerUploadOutput struct { - // The upload ID associated with the layer. - UploadId *string - - // The repository name associated with the request. - RepositoryName *string - // The sha256 digest of the image layer. LayerDigest *string // The registry ID associated with the request. RegistryId *string + // The repository name associated with the request. + RepositoryName *string + + // The upload ID associated with the layer. + UploadId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ecr/api_op_CreateRepository.go b/service/ecr/api_op_CreateRepository.go index 9771753cb26..f35351860e6 100644 --- a/service/ecr/api_op_CreateRepository.go +++ b/service/ecr/api_op_CreateRepository.go @@ -59,21 +59,6 @@ func (c *Client) CreateRepository(ctx context.Context, params *CreateRepositoryI type CreateRepositoryInput struct { - // The image scanning configuration for the repository. This determines whether - // images are scanned for known vulnerabilities after being pushed to the - // repository. - ImageScanningConfiguration *types.ImageScanningConfiguration - - // The metadata that you apply to the repository to help you categorize and - // organize them. Each tag consists of a key and an optional value, both of which - // you define. Tag keys can have a maximum character length of 128 characters, and - // tag values can have a maximum length of 256 characters. - Tags []*types.Tag - - // The encryption configuration for the repository. This determines how the - // contents of your repository are encrypted at rest. - EncryptionConfiguration *types.EncryptionConfiguration - // The name to use for the repository. The repository name may be specified on its // own (such as nginx-web-app) or it can be prepended with a namespace to group the // repository into a category (such as project-a/nginx-web-app). @@ -81,11 +66,26 @@ type CreateRepositoryInput struct { // This member is required. RepositoryName *string + // The encryption configuration for the repository. This determines how the + // contents of your repository are encrypted at rest. + EncryptionConfiguration *types.EncryptionConfiguration + + // The image scanning configuration for the repository. This determines whether + // images are scanned for known vulnerabilities after being pushed to the + // repository. + ImageScanningConfiguration *types.ImageScanningConfiguration + // The tag mutability setting for the repository. If this parameter is omitted, the // default setting of MUTABLE will be used which will allow image tags to be // overwritten. If IMMUTABLE is specified, all image tags within the repository // will be immutable which will prevent them from being overwritten. ImageTagMutability types.ImageTagMutability + + // The metadata that you apply to the repository to help you categorize and + // organize them. Each tag consists of a key and an optional value, both of which + // you define. Tag keys can have a maximum character length of 128 characters, and + // tag values can have a maximum length of 256 characters. + Tags []*types.Tag } type CreateRepositoryOutput struct { diff --git a/service/ecr/api_op_DeleteLifecyclePolicy.go b/service/ecr/api_op_DeleteLifecyclePolicy.go index 733b44c01e0..09e7039e496 100644 --- a/service/ecr/api_op_DeleteLifecyclePolicy.go +++ b/service/ecr/api_op_DeleteLifecyclePolicy.go @@ -57,30 +57,30 @@ func (c *Client) DeleteLifecyclePolicy(ctx context.Context, params *DeleteLifecy type DeleteLifecyclePolicyInput struct { - // The AWS account ID associated with the registry that contains the repository. If - // you do not specify a registry, the default registry is assumed. - RegistryId *string - // The name of the repository. // // This member is required. RepositoryName *string + + // The AWS account ID associated with the registry that contains the repository. If + // you do not specify a registry, the default registry is assumed. + RegistryId *string } type DeleteLifecyclePolicyOutput struct { - // The JSON lifecycle policy text. - LifecyclePolicyText *string - - // The repository name associated with the request. - RepositoryName *string - // The time stamp of the last time that the lifecycle policy was run. LastEvaluatedAt *time.Time + // The JSON lifecycle policy text. + LifecyclePolicyText *string + // The registry ID associated with the request. RegistryId *string + // The repository name associated with the request. + RepositoryName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ecr/api_op_DeleteRepository.go b/service/ecr/api_op_DeleteRepository.go index 16d92c445e0..3f0c1fe83cc 100644 --- a/service/ecr/api_op_DeleteRepository.go +++ b/service/ecr/api_op_DeleteRepository.go @@ -58,10 +58,6 @@ func (c *Client) DeleteRepository(ctx context.Context, params *DeleteRepositoryI type DeleteRepositoryInput struct { - // The AWS account ID associated with the registry that contains the repository to - // delete. If you do not specify a registry, the default registry is assumed. - RegistryId *string - // The name of the repository to delete. // // This member is required. @@ -69,6 +65,10 @@ type DeleteRepositoryInput struct { // If a repository contains images, forces the deletion. Force *bool + + // The AWS account ID associated with the registry that contains the repository to + // delete. If you do not specify a registry, the default registry is assumed. + RegistryId *string } type DeleteRepositoryOutput struct { diff --git a/service/ecr/api_op_DeleteRepositoryPolicy.go b/service/ecr/api_op_DeleteRepositoryPolicy.go index 2914030c230..4ec677bc3aa 100644 --- a/service/ecr/api_op_DeleteRepositoryPolicy.go +++ b/service/ecr/api_op_DeleteRepositoryPolicy.go @@ -56,16 +56,16 @@ func (c *Client) DeleteRepositoryPolicy(ctx context.Context, params *DeleteRepos type DeleteRepositoryPolicyInput struct { - // The AWS account ID associated with the registry that contains the repository - // policy to delete. If you do not specify a registry, the default registry is - // assumed. - RegistryId *string - // The name of the repository that is associated with the repository policy to // delete. // // This member is required. RepositoryName *string + + // The AWS account ID associated with the registry that contains the repository + // policy to delete. If you do not specify a registry, the default registry is + // assumed. + RegistryId *string } type DeleteRepositoryPolicyOutput struct { diff --git a/service/ecr/api_op_DescribeImageScanFindings.go b/service/ecr/api_op_DescribeImageScanFindings.go index fba482c4a03..b9d45c34d1e 100644 --- a/service/ecr/api_op_DescribeImageScanFindings.go +++ b/service/ecr/api_op_DescribeImageScanFindings.go @@ -57,6 +57,16 @@ func (c *Client) DescribeImageScanFindings(ctx context.Context, params *Describe type DescribeImageScanFindingsInput struct { + // An object with identifying information for an Amazon ECR image. + // + // This member is required. + ImageId *types.ImageIdentifier + + // The repository for the image for which to describe the scan findings. + // + // This member is required. + RepositoryName *string + // The maximum number of image scan results returned by DescribeImageScanFindings // in paginated output. When this parameter is used, DescribeImageScanFindings only // returns maxResults results in a single page along with a nextToken response @@ -67,39 +77,20 @@ type DescribeImageScanFindingsInput struct { // applicable. MaxResults *int32 - // The repository for the image for which to describe the scan findings. - // - // This member is required. - RepositoryName *string - - // An object with identifying information for an Amazon ECR image. - // - // This member is required. - ImageId *types.ImageIdentifier - - // The AWS account ID associated with the registry that contains the repository in - // which to describe the image scan findings for. If you do not specify a registry, - // the default registry is assumed. - RegistryId *string - // The nextToken value returned from a previous paginated DescribeImageScanFindings // request where maxResults was used and the results exceeded the value of that // parameter. Pagination continues from the end of the previous results that // returned the nextToken value. This value is null when there are no more results // to return. NextToken *string -} - -type DescribeImageScanFindingsOutput struct { - // The registry ID associated with the request. + // The AWS account ID associated with the registry that contains the repository in + // which to describe the image scan findings for. If you do not specify a registry, + // the default registry is assumed. RegistryId *string +} - // The current state of the scan. - ImageScanStatus *types.ImageScanStatus - - // The repository name associated with the request. - RepositoryName *string +type DescribeImageScanFindingsOutput struct { // An object with identifying information for an Amazon ECR image. ImageId *types.ImageIdentifier @@ -107,12 +98,21 @@ type DescribeImageScanFindingsOutput struct { // The information contained in the image scan findings. ImageScanFindings *types.ImageScanFindings + // The current state of the scan. + ImageScanStatus *types.ImageScanStatus + // The nextToken value to include in a future DescribeImageScanFindings request. // When the results of a DescribeImageScanFindings request exceed maxResults, this // value can be used to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string + // The registry ID associated with the request. + RegistryId *string + + // The repository name associated with the request. + RepositoryName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ecr/api_op_DescribeImages.go b/service/ecr/api_op_DescribeImages.go index 6716d5e88f9..e73b6ac9460 100644 --- a/service/ecr/api_op_DescribeImages.go +++ b/service/ecr/api_op_DescribeImages.go @@ -61,17 +61,16 @@ func (c *Client) DescribeImages(ctx context.Context, params *DescribeImagesInput type DescribeImagesInput struct { - // The AWS account ID associated with the registry that contains the repository in - // which to describe images. If you do not specify a registry, the default registry - // is assumed. - RegistryId *string + // The repository that contains the images to describe. + // + // This member is required. + RepositoryName *string - // The nextToken value returned from a previous paginated DescribeImages request - // where maxResults was used and the results exceeded the value of that parameter. - // Pagination continues from the end of the previous results that returned the - // nextToken value. This value is null when there are no more results to return. - // This option cannot be used when you specify images with imageIds. - NextToken *string + // The filter key and value with which to filter your DescribeImages results. + Filter *types.DescribeImagesFilter + + // The list of image IDs for the requested repository. + ImageIds []*types.ImageIdentifier // The maximum number of repository results returned by DescribeImages in paginated // output. When this parameter is used, DescribeImages only returns maxResults @@ -83,16 +82,17 @@ type DescribeImagesInput struct { // images with imageIds. MaxResults *int32 - // The filter key and value with which to filter your DescribeImages results. - Filter *types.DescribeImagesFilter - - // The repository that contains the images to describe. - // - // This member is required. - RepositoryName *string + // The nextToken value returned from a previous paginated DescribeImages request + // where maxResults was used and the results exceeded the value of that parameter. + // Pagination continues from the end of the previous results that returned the + // nextToken value. This value is null when there are no more results to return. + // This option cannot be used when you specify images with imageIds. + NextToken *string - // The list of image IDs for the requested repository. - ImageIds []*types.ImageIdentifier + // The AWS account ID associated with the registry that contains the repository in + // which to describe images. If you do not specify a registry, the default registry + // is assumed. + RegistryId *string } type DescribeImagesOutput struct { diff --git a/service/ecr/api_op_DescribeRepositories.go b/service/ecr/api_op_DescribeRepositories.go index cc0e195fa37..67626a3390a 100644 --- a/service/ecr/api_op_DescribeRepositories.go +++ b/service/ecr/api_op_DescribeRepositories.go @@ -56,10 +56,15 @@ func (c *Client) DescribeRepositories(ctx context.Context, params *DescribeRepos type DescribeRepositoriesInput struct { - // The AWS account ID associated with the registry that contains the repositories - // to be described. If you do not specify a registry, the default registry is - // assumed. - RegistryId *string + // The maximum number of repository results returned by DescribeRepositories in + // paginated output. When this parameter is used, DescribeRepositories only returns + // maxResults results in a single page along with a nextToken response element. The + // remaining results of the initial request can be seen by sending another + // DescribeRepositories request with the returned nextToken value. This value can + // be between 1 and 1000. If this parameter is not used, then DescribeRepositories + // returns up to 100 results and a nextToken value, if applicable. This option + // cannot be used when you specify repositories with repositoryNames. + MaxResults *int32 // The nextToken value returned from a previous paginated DescribeRepositories // request where maxResults was used and the results exceeded the value of that @@ -71,32 +76,27 @@ type DescribeRepositoriesInput struct { // purposes. NextToken *string + // The AWS account ID associated with the registry that contains the repositories + // to be described. If you do not specify a registry, the default registry is + // assumed. + RegistryId *string + // A list of repositories to describe. If this parameter is omitted, then all // repositories in a registry are described. RepositoryNames []*string - - // The maximum number of repository results returned by DescribeRepositories in - // paginated output. When this parameter is used, DescribeRepositories only returns - // maxResults results in a single page along with a nextToken response element. The - // remaining results of the initial request can be seen by sending another - // DescribeRepositories request with the returned nextToken value. This value can - // be between 1 and 1000. If this parameter is not used, then DescribeRepositories - // returns up to 100 results and a nextToken value, if applicable. This option - // cannot be used when you specify repositories with repositoryNames. - MaxResults *int32 } type DescribeRepositoriesOutput struct { - // A list of repository objects corresponding to valid repositories. - Repositories []*types.Repository - // The nextToken value to include in a future DescribeRepositories request. When // the results of a DescribeRepositories request exceed maxResults, this value can // be used to retrieve the next page of results. This value is null when there are // no more results to return. NextToken *string + // A list of repository objects corresponding to valid repositories. + Repositories []*types.Repository + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ecr/api_op_GetDownloadUrlForLayer.go b/service/ecr/api_op_GetDownloadUrlForLayer.go index 3b6accd837e..d6131722085 100644 --- a/service/ecr/api_op_GetDownloadUrlForLayer.go +++ b/service/ecr/api_op_GetDownloadUrlForLayer.go @@ -61,10 +61,6 @@ func (c *Client) GetDownloadUrlForLayer(ctx context.Context, params *GetDownload type GetDownloadUrlForLayerInput struct { - // The AWS account ID associated with the registry that contains the image layer to - // download. If you do not specify a registry, the default registry is assumed. - RegistryId *string - // The digest of the image layer to download. // // This member is required. @@ -74,16 +70,20 @@ type GetDownloadUrlForLayerInput struct { // // This member is required. RepositoryName *string + + // The AWS account ID associated with the registry that contains the image layer to + // download. If you do not specify a registry, the default registry is assumed. + RegistryId *string } type GetDownloadUrlForLayerOutput struct { - // The digest of the image layer to download. - LayerDigest *string - // The pre-signed Amazon S3 download URL for the requested layer. DownloadUrl *string + // The digest of the image layer to download. + LayerDigest *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ecr/api_op_GetLifecyclePolicy.go b/service/ecr/api_op_GetLifecyclePolicy.go index ef30b98de02..c6213c00568 100644 --- a/service/ecr/api_op_GetLifecyclePolicy.go +++ b/service/ecr/api_op_GetLifecyclePolicy.go @@ -69,18 +69,18 @@ type GetLifecyclePolicyInput struct { type GetLifecyclePolicyOutput struct { - // The repository name associated with the request. - RepositoryName *string + // The time stamp of the last time that the lifecycle policy was run. + LastEvaluatedAt *time.Time // The JSON lifecycle policy text. LifecyclePolicyText *string - // The time stamp of the last time that the lifecycle policy was run. - LastEvaluatedAt *time.Time - // The registry ID associated with the request. RegistryId *string + // The repository name associated with the request. + RepositoryName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ecr/api_op_GetLifecyclePolicyPreview.go b/service/ecr/api_op_GetLifecyclePolicyPreview.go index 5b7908f7515..1dce392b5a2 100644 --- a/service/ecr/api_op_GetLifecyclePolicyPreview.go +++ b/service/ecr/api_op_GetLifecyclePolicyPreview.go @@ -63,6 +63,13 @@ type GetLifecyclePolicyPreviewInput struct { // This member is required. RepositoryName *string + // An optional parameter that filters results based on image tag status and all + // tags, if tagged. + Filter *types.LifecyclePolicyPreviewFilter + + // The list of imageIDs to be included. + ImageIds []*types.ImageIdentifier + // The maximum number of repository results returned by // GetLifecyclePolicyPreviewRequest in
 paginated output. When this parameter is // used, GetLifecyclePolicyPreviewRequest only returns
 maxResults results in a @@ -75,13 +82,6 @@ type GetLifecyclePolicyPreviewInput struct { // imageIds. MaxResults *int32 - // An optional parameter that filters results based on image tag status and all - // tags, if tagged. - Filter *types.LifecyclePolicyPreviewFilter - - // The list of imageIDs to be included. - ImageIds []*types.ImageIdentifier - // The nextToken value returned from a previous paginated // GetLifecyclePolicyPreviewRequest request where maxResults was used and the // results exceeded the value of that parameter. Pagination continues from the end @@ -97,12 +97,6 @@ type GetLifecyclePolicyPreviewInput struct { type GetLifecyclePolicyPreviewOutput struct { - // The results of the lifecycle policy preview request. - PreviewResults []*types.LifecyclePolicyPreviewResult - - // The repository name associated with the request. - RepositoryName *string - // The JSON lifecycle policy text. LifecyclePolicyText *string @@ -112,9 +106,15 @@ type GetLifecyclePolicyPreviewOutput struct { // there are no more results to return. NextToken *string + // The results of the lifecycle policy preview request. + PreviewResults []*types.LifecyclePolicyPreviewResult + // The registry ID associated with the request. RegistryId *string + // The repository name associated with the request. + RepositoryName *string + // The status of the lifecycle policy preview request. Status types.LifecyclePolicyPreviewStatus diff --git a/service/ecr/api_op_GetRepositoryPolicy.go b/service/ecr/api_op_GetRepositoryPolicy.go index d76abcb9301..98c38fb8230 100644 --- a/service/ecr/api_op_GetRepositoryPolicy.go +++ b/service/ecr/api_op_GetRepositoryPolicy.go @@ -56,24 +56,24 @@ func (c *Client) GetRepositoryPolicy(ctx context.Context, params *GetRepositoryP type GetRepositoryPolicyInput struct { - // The AWS account ID associated with the registry that contains the repository. If - // you do not specify a registry, the default registry is assumed. - RegistryId *string - // The name of the repository with the policy to retrieve. // // This member is required. RepositoryName *string + + // The AWS account ID associated with the registry that contains the repository. If + // you do not specify a registry, the default registry is assumed. + RegistryId *string } type GetRepositoryPolicyOutput struct { - // The registry ID associated with the request. - RegistryId *string - // The JSON repository policy text associated with the repository. PolicyText *string + // The registry ID associated with the request. + RegistryId *string + // The repository name associated with the request. RepositoryName *string diff --git a/service/ecr/api_op_ListImages.go b/service/ecr/api_op_ListImages.go index 036f73f0fc3..94b57815fd2 100644 --- a/service/ecr/api_op_ListImages.go +++ b/service/ecr/api_op_ListImages.go @@ -62,13 +62,13 @@ func (c *Client) ListImages(ctx context.Context, params *ListImagesInput, optFns type ListImagesInput struct { - // The nextToken value returned from a previous paginated ListImages request where - // maxResults was used and the results exceeded the value of that parameter. - // Pagination continues from the end of the previous results that returned the - // nextToken value. This value is null when there are no more results to return. - // This token should be treated as an opaque identifier that is only used to - // retrieve the next items in a list and not for other programmatic purposes. - NextToken *string + // The repository with image IDs to be listed. + // + // This member is required. + RepositoryName *string + + // The filter key and value with which to filter your ListImages results. + Filter *types.ListImagesFilter // The maximum number of image results returned by ListImages in paginated output. // When this parameter is used, ListImages only returns maxResults results in a @@ -79,13 +79,13 @@ type ListImagesInput struct { // value, if applicable. MaxResults *int32 - // The filter key and value with which to filter your ListImages results. - Filter *types.ListImagesFilter - - // The repository with image IDs to be listed. - // - // This member is required. - RepositoryName *string + // The nextToken value returned from a previous paginated ListImages request where + // maxResults was used and the results exceeded the value of that parameter. + // Pagination continues from the end of the previous results that returned the + // nextToken value. This value is null when there are no more results to return. + // This token should be treated as an opaque identifier that is only used to + // retrieve the next items in a list and not for other programmatic purposes. + NextToken *string // The AWS account ID associated with the registry that contains the repository in // which to list images. If you do not specify a registry, the default registry is @@ -95,15 +95,15 @@ type ListImagesInput struct { type ListImagesOutput struct { + // The list of image IDs for the requested repository. + ImageIds []*types.ImageIdentifier + // The nextToken value to include in a future ListImages request. When the results // of a ListImages request exceed maxResults, this value can be used to retrieve // the next page of results. This value is null when there are no more results to // return. NextToken *string - // The list of image IDs for the requested repository. - ImageIds []*types.ImageIdentifier - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ecr/api_op_PutImage.go b/service/ecr/api_op_PutImage.go index 3632c8a4bd2..03fedf0d178 100644 --- a/service/ecr/api_op_PutImage.go +++ b/service/ecr/api_op_PutImage.go @@ -63,16 +63,6 @@ func (c *Client) PutImage(ctx context.Context, params *PutImageInput, optFns ... type PutImageInput struct { - // The media type of the image manifest. If you push an image manifest that does - // not contain the mediaType field, you must specify the imageManifestMediaType in - // the request. - ImageManifestMediaType *string - - // The AWS account ID associated with the registry that contains the repository in - // which to put the image. If you do not specify a registry, the default registry - // is assumed. - RegistryId *string - // The image manifest corresponding to the image to be uploaded. // // This member is required. @@ -83,13 +73,23 @@ type PutImageInput struct { // This member is required. RepositoryName *string + // The image digest of the image manifest corresponding to the image. + ImageDigest *string + + // The media type of the image manifest. If you push an image manifest that does + // not contain the mediaType field, you must specify the imageManifestMediaType in + // the request. + ImageManifestMediaType *string + // The tag to associate with the image. This parameter is required for images that // use the Docker Image Manifest V2 Schema 2 or Open Container Initiative (OCI) // formats. ImageTag *string - // The image digest of the image manifest corresponding to the image. - ImageDigest *string + // The AWS account ID associated with the registry that contains the repository in + // which to put the image. If you do not specify a registry, the default registry + // is assumed. + RegistryId *string } type PutImageOutput struct { diff --git a/service/ecr/api_op_PutImageScanningConfiguration.go b/service/ecr/api_op_PutImageScanningConfiguration.go index dc858f1f978..6ae8bcec743 100644 --- a/service/ecr/api_op_PutImageScanningConfiguration.go +++ b/service/ecr/api_op_PutImageScanningConfiguration.go @@ -57,12 +57,6 @@ func (c *Client) PutImageScanningConfiguration(ctx context.Context, params *PutI type PutImageScanningConfigurationInput struct { - // The name of the repository in which to update the image scanning configuration - // setting. - // - // This member is required. - RepositoryName *string - // The image scanning configuration for the repository. This setting determines // whether images are scanned for known vulnerabilities after being pushed to the // repository. @@ -70,6 +64,12 @@ type PutImageScanningConfigurationInput struct { // This member is required. ImageScanningConfiguration *types.ImageScanningConfiguration + // The name of the repository in which to update the image scanning configuration + // setting. + // + // This member is required. + RepositoryName *string + // The AWS account ID associated with the registry that contains the repository in // which to update the image scanning configuration setting. If you do not specify // a registry, the default registry is assumed. diff --git a/service/ecr/api_op_PutImageTagMutability.go b/service/ecr/api_op_PutImageTagMutability.go index 2e3c20e0a1e..d92a128ddab 100644 --- a/service/ecr/api_op_PutImageTagMutability.go +++ b/service/ecr/api_op_PutImageTagMutability.go @@ -83,12 +83,12 @@ type PutImageTagMutabilityOutput struct { // The image tag mutability setting for the repository. ImageTagMutability types.ImageTagMutability - // The repository name associated with the request. - RepositoryName *string - // The registry ID associated with the request. RegistryId *string + // The repository name associated with the request. + RepositoryName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ecr/api_op_PutLifecyclePolicy.go b/service/ecr/api_op_PutLifecyclePolicy.go index 7c808d2b3b7..135f93abc23 100644 --- a/service/ecr/api_op_PutLifecyclePolicy.go +++ b/service/ecr/api_op_PutLifecyclePolicy.go @@ -58,6 +58,11 @@ func (c *Client) PutLifecyclePolicy(ctx context.Context, params *PutLifecyclePol type PutLifecyclePolicyInput struct { + // The JSON repository policy text to apply to the repository. + // + // This member is required. + LifecyclePolicyText *string + // The name of the repository to receive the policy. // // This member is required. @@ -66,24 +71,19 @@ type PutLifecyclePolicyInput struct { // The AWS account ID associated with the registry that contains the repository. If // you do
 not specify a registry, the default registry is assumed. RegistryId *string - - // The JSON repository policy text to apply to the repository. - // - // This member is required. - LifecyclePolicyText *string } type PutLifecyclePolicyOutput struct { - // The repository name associated with the request. - RepositoryName *string - // The JSON repository policy text. LifecyclePolicyText *string // The registry ID associated with the request. RegistryId *string + // The repository name associated with the request. + RepositoryName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ecr/api_op_SetRepositoryPolicy.go b/service/ecr/api_op_SetRepositoryPolicy.go index 5f16ae0a01b..6cffd11090f 100644 --- a/service/ecr/api_op_SetRepositoryPolicy.go +++ b/service/ecr/api_op_SetRepositoryPolicy.go @@ -67,17 +67,17 @@ type SetRepositoryPolicyInput struct { // This member is required. PolicyText *string + // The name of the repository to receive the policy. + // + // This member is required. + RepositoryName *string + // If the policy you are attempting to set on a repository policy would prevent you // from setting another policy in the future, you must force the // SetRepositoryPolicy () operation. This is intended to prevent accidental // repository lock outs. Force *bool - // The name of the repository to receive the policy. - // - // This member is required. - RepositoryName *string - // The AWS account ID associated with the registry that contains the repository. If // you do not specify a registry, the default registry is assumed. RegistryId *string @@ -85,15 +85,15 @@ type SetRepositoryPolicyInput struct { type SetRepositoryPolicyOutput struct { - // The repository name associated with the request. - RepositoryName *string - // The JSON repository policy text applied to the repository. PolicyText *string // The registry ID associated with the request. RegistryId *string + // The repository name associated with the request. + RepositoryName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ecr/api_op_StartImageScan.go b/service/ecr/api_op_StartImageScan.go index 516f705f3f7..f9af86247a4 100644 --- a/service/ecr/api_op_StartImageScan.go +++ b/service/ecr/api_op_StartImageScan.go @@ -66,15 +66,15 @@ type StartImageScanInput struct { // This member is required. ImageId *types.ImageIdentifier - // The AWS account ID associated with the registry that contains the repository in - // which to start an image scan request. If you do not specify a registry, the - // default registry is assumed. - RegistryId *string - // The name of the repository that contains the images to scan. // // This member is required. RepositoryName *string + + // The AWS account ID associated with the registry that contains the repository in + // which to start an image scan request. If you do not specify a registry, the + // default registry is assumed. + RegistryId *string } type StartImageScanOutput struct { diff --git a/service/ecr/api_op_StartLifecyclePolicyPreview.go b/service/ecr/api_op_StartLifecyclePolicyPreview.go index 276607667b1..d45145b0ed9 100644 --- a/service/ecr/api_op_StartLifecyclePolicyPreview.go +++ b/service/ecr/api_op_StartLifecyclePolicyPreview.go @@ -59,10 +59,6 @@ func (c *Client) StartLifecyclePolicyPreview(ctx context.Context, params *StartL type StartLifecyclePolicyPreviewInput struct { - // The AWS account ID associated with the registry that contains the repository. If - // you do not specify a registry, the default registry is assumed. - RegistryId *string - // The name of the repository to be evaluated. // // This member is required. @@ -71,22 +67,26 @@ type StartLifecyclePolicyPreviewInput struct { // The policy to be evaluated against. If you do not specify a policy, the current // policy for the repository is used. LifecyclePolicyText *string + + // The AWS account ID associated with the registry that contains the repository. If + // you do not specify a registry, the default registry is assumed. + RegistryId *string } type StartLifecyclePolicyPreviewOutput struct { - // The repository name associated with the request. - RepositoryName *string + // The JSON repository policy text. + LifecyclePolicyText *string // The registry ID associated with the request. RegistryId *string + // The repository name associated with the request. + RepositoryName *string + // The status of the lifecycle policy preview request. Status types.LifecyclePolicyPreviewStatus - // The JSON repository policy text. - LifecyclePolicyText *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ecr/api_op_TagResource.go b/service/ecr/api_op_TagResource.go index 715645d1a93..bd7b185a279 100644 --- a/service/ecr/api_op_TagResource.go +++ b/service/ecr/api_op_TagResource.go @@ -58,18 +58,18 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { + // The Amazon Resource Name (ARN) of the the resource to which to add tags. + // Currently, the only supported resource is an Amazon ECR repository. + // + // This member is required. + ResourceArn *string + // The tags to add to the resource. A tag is an array of key-value pairs. Tag keys // can have a maximum character length of 128 characters, and tag values can have a // maximum length of 256 characters. // // This member is required. Tags []*types.Tag - - // The Amazon Resource Name (ARN) of the the resource to which to add tags. - // Currently, the only supported resource is an Amazon ECR repository. - // - // This member is required. - ResourceArn *string } type TagResourceOutput struct { diff --git a/service/ecr/api_op_UntagResource.go b/service/ecr/api_op_UntagResource.go index fde4a70d6ea..45c172464db 100644 --- a/service/ecr/api_op_UntagResource.go +++ b/service/ecr/api_op_UntagResource.go @@ -56,16 +56,16 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The keys of the tags to be removed. - // - // This member is required. - TagKeys []*string - // The Amazon Resource Name (ARN) of the resource from which to remove tags. // Currently, the only supported resource is an Amazon ECR repository. // // This member is required. ResourceArn *string + + // The keys of the tags to be removed. + // + // This member is required. + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/ecr/api_op_UploadLayerPart.go b/service/ecr/api_op_UploadLayerPart.go index 98eb68cd545..8a39174833f 100644 --- a/service/ecr/api_op_UploadLayerPart.go +++ b/service/ecr/api_op_UploadLayerPart.go @@ -61,10 +61,10 @@ func (c *Client) UploadLayerPart(ctx context.Context, params *UploadLayerPartInp type UploadLayerPartInput struct { - // The name of the repository to which you are uploading layer parts. + // The base64-encoded layer part payload. // // This member is required. - RepositoryName *string + LayerPartBlob []byte // The position of the first byte of the layer part witin the overall image layer. // @@ -76,9 +76,10 @@ type UploadLayerPartInput struct { // This member is required. PartLastByte *int64 - // The AWS account ID associated with the registry to which you are uploading layer - // parts. If you do not specify a registry, the default registry is assumed. - RegistryId *string + // The name of the repository to which you are uploading layer parts. + // + // This member is required. + RepositoryName *string // The upload ID from a previous InitiateLayerUpload () operation to associate with // the layer part upload. @@ -86,26 +87,25 @@ type UploadLayerPartInput struct { // This member is required. UploadId *string - // The base64-encoded layer part payload. - // - // This member is required. - LayerPartBlob []byte + // The AWS account ID associated with the registry to which you are uploading layer + // parts. If you do not specify a registry, the default registry is assumed. + RegistryId *string } type UploadLayerPartOutput struct { - // The registry ID associated with the request. - RegistryId *string - - // The upload ID associated with the request. - UploadId *string - // The integer value of the last byte received in the request. LastByteReceived *int64 + // The registry ID associated with the request. + RegistryId *string + // The repository name associated with the request. RepositoryName *string + // The upload ID associated with the request. + UploadId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ecr/go.mod b/service/ecr/go.mod index e6e87727f23..09250a7d645 100644 --- a/service/ecr/go.mod +++ b/service/ecr/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/ecr go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/ecr/types/types.go b/service/ecr/types/types.go index bac57182434..365375d4342 100644 --- a/service/ecr/types/types.go +++ b/service/ecr/types/types.go @@ -9,32 +9,32 @@ import ( // This data type is used in the ImageScanFinding () data type. type Attribute struct { - // The value assigned to the attribute key. - Value *string - // The attribute key. // // This member is required. Key *string + + // The value assigned to the attribute key. + Value *string } // An object representing authorization data for an Amazon ECR registry. type AuthorizationData struct { - // The registry URL to use for this authorization token in a docker login command. - // The Amazon ECR registry URL format is - // https://aws_account_id.dkr.ecr.region.amazonaws.com. For example, - // https://012345678910.dkr.ecr.us-east-1.amazonaws.com.. - ProxyEndpoint *string + // A base64-encoded string that contains authorization data for the specified + // Amazon ECR registry. When the string is decoded, it is presented in the format + // user:password for private registry authentication using docker login. + AuthorizationToken *string // The Unix time in seconds and milliseconds when the authorization token expires. // Authorization tokens are valid for 12 hours. ExpiresAt *time.Time - // A base64-encoded string that contains authorization data for the specified - // Amazon ECR registry. When the string is decoded, it is presented in the format - // user:password for private registry authentication using docker login. - AuthorizationToken *string + // The registry URL to use for this authorization token in a docker login command. + // The Amazon ECR registry URL format is + // https://aws_account_id.dkr.ecr.region.amazonaws.com. For example, + // https://012345678910.dkr.ecr.us-east-1.amazonaws.com.. + ProxyEndpoint *string } // An object representing a filter on a DescribeImages () operation. @@ -87,37 +87,38 @@ type EncryptionConfiguration struct { // An object representing an Amazon ECR image. type Image struct { - // The name of the repository associated with the image. - RepositoryName *string + // An object containing the image tag and image digest associated with an image. + ImageId *ImageIdentifier // The image manifest associated with the image. ImageManifest *string - // The AWS account ID associated with the registry containing the image. - RegistryId *string - // The media type associated with the image manifest. ImageManifestMediaType *string - // An object containing the image tag and image digest associated with an image. - ImageId *ImageIdentifier + // The AWS account ID associated with the registry containing the image. + RegistryId *string + + // The name of the repository associated with the image. + RepositoryName *string } // An object that describes an image returned by a DescribeImages () operation. type ImageDetail struct { - // The list of tags associated with this image. - ImageTags []*string + // The sha256 digest of the image manifest. + ImageDigest *string - // The name of the repository to which this image belongs. - RepositoryName *string + // The date and time, expressed in standard JavaScript date format, at which the + // current image was pushed to the repository. + ImagePushedAt *time.Time + + // A summary of the last completed image scan. + ImageScanFindingsSummary *ImageScanFindingsSummary // The current state of the scan. ImageScanStatus *ImageScanStatus - // The sha256 digest of the image manifest. - ImageDigest *string - // The size, in bytes, of the image in the repository. If the image is a manifest // list, this will be the max size of all manifests in the list. Beginning with // Docker version 1.9, the Docker client compresses image layers before pushing @@ -126,38 +127,37 @@ type ImageDetail struct { // sizes returned by DescribeImages (). ImageSizeInBytes *int64 - // The date and time, expressed in standard JavaScript date format, at which the - // current image was pushed to the repository. - ImagePushedAt *time.Time + // The list of tags associated with this image. + ImageTags []*string // The AWS account ID associated with the registry to which this image belongs. RegistryId *string - // A summary of the last completed image scan. - ImageScanFindingsSummary *ImageScanFindingsSummary + // The name of the repository to which this image belongs. + RepositoryName *string } // An object representing an Amazon ECR image failure. type ImageFailure struct { - // The image ID associated with the failure. - ImageId *ImageIdentifier + // The code associated with the failure. + FailureCode ImageFailureCode // The reason for the failure. FailureReason *string - // The code associated with the failure. - FailureCode ImageFailureCode + // The image ID associated with the failure. + ImageId *ImageIdentifier } // An object with identifying information for an Amazon ECR image. type ImageIdentifier struct { - // The tag used for the image. - ImageTag *string - // The sha256 digest of the image manifest. ImageDigest *string + + // The tag used for the image. + ImageTag *string } // Contains information about an image scan finding. @@ -166,8 +166,8 @@ type ImageScanFinding struct { // A collection of attributes of the host from which the finding is generated. Attributes []*Attribute - // A link containing additional details about the security vulnerability. - Uri *string + // The description of the finding. + Description *string // The name associated with the finding, usually a CVE number. Name *string @@ -175,8 +175,8 @@ type ImageScanFinding struct { // The finding severity. Severity FindingSeverity - // The description of the finding. - Description *string + // A link containing additional details about the security vulnerability. + Uri *string } // The details of an image scan. @@ -185,14 +185,14 @@ type ImageScanFindings struct { // The image vulnerability counts, sorted by severity. FindingSeverityCounts map[string]*int32 + // The findings from the image scan. + Findings []*ImageScanFinding + // The time of the last completed image scan. ImageScanCompletedAt *time.Time // The time when the vulnerability data was last scanned. VulnerabilitySourceUpdatedAt *time.Time - - // The findings from the image scan. - Findings []*ImageScanFinding } // A summary of the last completed image scan. @@ -201,11 +201,11 @@ type ImageScanFindingsSummary struct { // The image vulnerability counts, sorted by severity. FindingSeverityCounts map[string]*int32 - // The time when the vulnerability data was last scanned. - VulnerabilitySourceUpdatedAt *time.Time - // The time of the last completed image scan. ImageScanCompletedAt *time.Time + + // The time when the vulnerability data was last scanned. + VulnerabilitySourceUpdatedAt *time.Time } // The image scanning configuration for a repository. @@ -221,22 +221,22 @@ type ImageScanningConfiguration struct { // The current status of an image scan. type ImageScanStatus struct { - // The current state of an image scan. - Status ScanStatus - // The description of the image scan status. Description *string + + // The current state of an image scan. + Status ScanStatus } // An object representing an Amazon ECR image layer. type Layer struct { - // The sha256 digest of the image layer. - LayerDigest *string - // The availability status of the image layer. LayerAvailability LayerAvailability + // The sha256 digest of the image layer. + LayerDigest *string + // The size, in bytes, of the image layer. LayerSize *int64 @@ -249,14 +249,14 @@ type Layer struct { // An object representing an Amazon ECR image layer failure. type LayerFailure struct { + // The failure code associated with the failure. + FailureCode LayerFailureCode + // The reason for the failure. FailureReason *string // The layer digest associated with the failure. LayerDigest *string - - // The failure code associated with the failure. - FailureCode LayerFailureCode } // The filter for the lifecycle policy preview. @@ -278,12 +278,12 @@ type LifecyclePolicyPreviewResult struct { // The sha256 digest of the image manifest. ImageDigest *string - // The list of tags associated with this image. - ImageTags []*string - // The date and time, expressed in standard JavaScript date format, at which the // current image was pushed to the repository. ImagePushedAt *time.Time + + // The list of tags associated with this image. + ImageTags []*string } // The summary of the lifecycle policy preview request. @@ -314,16 +314,18 @@ type Repository struct { // The date and time, in JavaScript date format, when the repository was created. CreatedAt *time.Time + // The encryption configuration for the repository. This determines how the + // contents of your repository are encrypted at rest. + EncryptionConfiguration *EncryptionConfiguration + // The image scanning configuration for a repository. ImageScanningConfiguration *ImageScanningConfiguration - // The URI for the repository. You can use this URI for container image push and - // pull operations. - RepositoryUri *string + // The tag mutability setting for the repository. + ImageTagMutability ImageTagMutability - // The encryption configuration for the repository. This determines how the - // contents of your repository are encrypted at rest. - EncryptionConfiguration *EncryptionConfiguration + // The AWS account ID associated with the registry that contains the repository. + RegistryId *string // The Amazon Resource Name (ARN) that identifies the repository. The ARN contains // the arn:aws:ecr namespace, followed by the region of the repository, AWS account @@ -331,14 +333,12 @@ type Repository struct { // example, arn:aws:ecr:region:012345678910:repository/test. RepositoryArn *string - // The AWS account ID associated with the registry that contains the repository. - RegistryId *string - // The name of the repository. RepositoryName *string - // The tag mutability setting for the repository. - ImageTagMutability ImageTagMutability + // The URI for the repository. You can use this URI for container image push and + // pull operations. + RepositoryUri *string } // The metadata that you apply to a resource to help you categorize and organize diff --git a/service/ecs/api_op_CreateCluster.go b/service/ecs/api_op_CreateCluster.go index 443cdf9551c..f3aebd07866 100644 --- a/service/ecs/api_op_CreateCluster.go +++ b/service/ecs/api_op_CreateCluster.go @@ -82,6 +82,30 @@ type CreateClusterInput struct { // numbers, and hyphens are allowed. ClusterName *string + // The capacity provider strategy to use by default for the cluster. When creating + // a service or running a task on a cluster, if no capacity provider or launch type + // is specified then the default capacity provider strategy for the cluster is + // used. A capacity provider strategy consists of one or more capacity providers + // along with the base and weight to assign to them. A capacity provider must be + // associated with the cluster to be used in a capacity provider strategy. The + // PutClusterCapacityProviders () API is used to associate a capacity provider with + // a cluster. Only capacity providers with an ACTIVE or UPDATING status can be + // used. If specifying a capacity provider that uses an Auto Scaling group, the + // capacity provider must already be created. New capacity providers can be created + // with the CreateCapacityProvider () API operation. To use a AWS Fargate capacity + // provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS + // Fargate capacity providers are available to all accounts and only need to be + // associated with a cluster to be used. If a default capacity provider strategy is + // not defined for a cluster during creation, it can be defined later with the + // PutClusterCapacityProviders () API operation. + DefaultCapacityProviderStrategy []*types.CapacityProviderStrategyItem + + // The setting to use when creating a cluster. This parameter is used to enable + // CloudWatch Container Insights for a cluster. If this value is specified, it will + // override the containerInsights value set with PutAccountSetting () or + // PutAccountSettingDefault (). + Settings []*types.ClusterSetting + // The metadata that you apply to the cluster to help you categorize and organize // them. Each tag consists of a key and an optional value, both of which you // define. The following basic restrictions apply to tags: @@ -112,30 +136,6 @@ type CreateClusterInput struct { // this prefix. Tags with this prefix do not count against your tags per resource // limit. Tags []*types.Tag - - // The capacity provider strategy to use by default for the cluster. When creating - // a service or running a task on a cluster, if no capacity provider or launch type - // is specified then the default capacity provider strategy for the cluster is - // used. A capacity provider strategy consists of one or more capacity providers - // along with the base and weight to assign to them. A capacity provider must be - // associated with the cluster to be used in a capacity provider strategy. The - // PutClusterCapacityProviders () API is used to associate a capacity provider with - // a cluster. Only capacity providers with an ACTIVE or UPDATING status can be - // used. If specifying a capacity provider that uses an Auto Scaling group, the - // capacity provider must already be created. New capacity providers can be created - // with the CreateCapacityProvider () API operation. To use a AWS Fargate capacity - // provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS - // Fargate capacity providers are available to all accounts and only need to be - // associated with a cluster to be used. If a default capacity provider strategy is - // not defined for a cluster during creation, it can be defined later with the - // PutClusterCapacityProviders () API operation. - DefaultCapacityProviderStrategy []*types.CapacityProviderStrategyItem - - // The setting to use when creating a cluster. This parameter is used to enable - // CloudWatch Container Insights for a cluster. If this value is specified, it will - // override the containerInsights value set with PutAccountSetting () or - // PutAccountSettingDefault (). - Settings []*types.ClusterSetting } type CreateClusterOutput struct { diff --git a/service/ecs/api_op_CreateService.go b/service/ecs/api_op_CreateService.go index ca5810494bc..0cef768209f 100644 --- a/service/ecs/api_op_CreateService.go +++ b/service/ecs/api_op_CreateService.go @@ -155,16 +155,6 @@ func (c *Client) CreateService(ctx context.Context, params *CreateServiceInput, type CreateServiceInput struct { - // Optional deployment parameters that control how many tasks run during the - // deployment and the ordering of stopping and starting tasks. - DeploymentConfiguration *types.DeploymentConfiguration - - // The family and revision (family:revision) or full ARN of the task definition to - // run in your service. If a revision is not specified, the latest ACTIVE revision - // is used. A task definition must be specified if the service is using the ECS - // deployment controller. - TaskDefinition *string - // The name of your service. Up to 255 letters (uppercase and lowercase), numbers, // and hyphens are allowed. Service names must be unique within a cluster, but you // can have similarly named services in multiple clusters within a Region or across @@ -173,6 +163,71 @@ type CreateServiceInput struct { // This member is required. ServiceName *string + // The capacity provider strategy to use for the service. A capacity provider + // strategy consists of one or more capacity providers along with the base and + // weight to assign to them. A capacity provider must be associated with the + // cluster to be used in a capacity provider strategy. The + // PutClusterCapacityProviders () API is used to associate a capacity provider with + // a cluster. Only capacity providers with an ACTIVE or UPDATING status can be + // used. If a capacityProviderStrategy is specified, the launchType parameter must + // be omitted. If no capacityProviderStrategy or launchType is specified, the + // defaultCapacityProviderStrategy for the cluster is used. If specifying a + // capacity provider that uses an Auto Scaling group, the capacity provider must + // already be created. New capacity providers can be created with the + // CreateCapacityProvider () API operation. To use a AWS Fargate capacity provider, + // specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate + // capacity providers are available to all accounts and only need to be associated + // with a cluster to be used. The PutClusterCapacityProviders () API operation is + // used to update the list of available capacity providers for a cluster after the + // cluster is created. + CapacityProviderStrategy []*types.CapacityProviderStrategyItem + + // Unique, case-sensitive identifier that you provide to ensure the idempotency of + // the request. Up to 32 ASCII characters are allowed. + ClientToken *string + + // The short name or full Amazon Resource Name (ARN) of the cluster on which to run + // your service. If you do not specify a cluster, the default cluster is assumed. + Cluster *string + + // Optional deployment parameters that control how many tasks run during the + // deployment and the ordering of stopping and starting tasks. + DeploymentConfiguration *types.DeploymentConfiguration + + // The deployment controller to use for the service. + DeploymentController *types.DeploymentController + + // The number of instantiations of the specified task definition to place and keep + // running on your cluster. This is required if schedulingStrategy is REPLICA or is + // not specified. If schedulingStrategy is DAEMON then this is not required. + DesiredCount *int32 + + // Specifies whether to enable Amazon ECS managed tags for the tasks within the + // service. For more information, see Tagging Your Amazon ECS Resources + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) + // in the Amazon Elastic Container Service Developer Guide. + EnableECSManagedTags *bool + + // The period of time, in seconds, that the Amazon ECS service scheduler should + // ignore unhealthy Elastic Load Balancing target health checks after a task has + // first started. This is only used when your service is configured to use a load + // balancer. If your service has a load balancer defined and you don't specify a + // health check grace period value, the default value of 0 is used. If your + // service's tasks take a while to start and respond to Elastic Load Balancing + // health checks, you can specify a health check grace period of up to + // 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler + // ignores health check status. This grace period can prevent the service scheduler + // from marking tasks as unhealthy and stopping them before they have time to come + // up. + HealthCheckGracePeriodSeconds *int32 + + // The launch type on which to run your service. For more information, see Amazon + // ECS Launch Types + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) + // in the Amazon Elastic Container Service Developer Guide. If a launchType is + // specified, the capacityProviderStrategy parameter must be omitted. + LaunchType types.LaunchType + // A load balancer object representing the load balancers to use with your service. // For more information, see Service Load Balancing // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) @@ -223,32 +278,14 @@ type CreateServiceInput struct { // in the Amazon Elastic Container Service Developer Guide. NetworkConfiguration *types.NetworkConfiguration - // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. Up to 32 ASCII characters are allowed. - ClientToken *string + // An array of placement constraint objects to use for tasks in your service. You + // can specify a maximum of 10 constraints per task (this limit includes + // constraints in the task definition and those specified at runtime). + PlacementConstraints []*types.PlacementConstraint - // The scheduling strategy to use for the service. For more information, see - // Services - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html). - // There are two service scheduler strategies available: - // - // * REPLICA-The replica - // scheduling strategy places and maintains the desired number of tasks across your - // cluster. By default, the service scheduler spreads tasks across Availability - // Zones. You can use task placement strategies and constraints to customize task - // placement decisions. This scheduler strategy is required if the service is using - // the CODE_DEPLOY or EXTERNAL deployment controller types. - // - // * DAEMON-The - // daemon scheduling strategy deploys exactly one task on each active container - // instance that meets all of the task placement constraints that you specify in - // your cluster. The service scheduler also evaluates the task placement - // constraints for running tasks and will stop tasks that do not meet the placement - // constraints. When you're using this strategy, you don't need to specify a - // desired number of tasks, a task placement strategy, or use Service Auto Scaling - // policies. Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL - // deployment controller types don't support the DAEMON scheduling strategy. - SchedulingStrategy types.SchedulingStrategy + // The placement strategy objects to use for tasks in your service. You can specify + // a maximum of five strategy rules per service. + PlacementStrategy []*types.PlacementStrategy // The platform version that your tasks in the service are running on. A platform // version is specified only for tasks using the Fargate launch type. If one isn't @@ -258,14 +295,12 @@ type CreateServiceInput struct { // in the Amazon Elastic Container Service Developer Guide. PlatformVersion *string - // An array of placement constraint objects to use for tasks in your service. You - // can specify a maximum of 10 constraints per task (this limit includes - // constraints in the task definition and those specified at runtime). - PlacementConstraints []*types.PlacementConstraint - - // The short name or full Amazon Resource Name (ARN) of the cluster on which to run - // your service. If you do not specify a cluster, the default cluster is assumed. - Cluster *string + // Specifies whether to propagate the tags from the task definition or the service + // to the tasks in the service. If no value is specified, the tags are not + // propagated. Tags can only be propagated to the tasks within the service during + // service creation. To add tags to a task after service creation, use the + // TagResource () API action. + PropagateTags types.PropagateTags // The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon // ECS to make calls to your load balancer on your behalf. This parameter is only @@ -289,44 +324,36 @@ type CreateServiceInput struct { // in the IAM User Guide. Role *string - // The period of time, in seconds, that the Amazon ECS service scheduler should - // ignore unhealthy Elastic Load Balancing target health checks after a task has - // first started. This is only used when your service is configured to use a load - // balancer. If your service has a load balancer defined and you don't specify a - // health check grace period value, the default value of 0 is used. If your - // service's tasks take a while to start and respond to Elastic Load Balancing - // health checks, you can specify a health check grace period of up to - // 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler - // ignores health check status. This grace period can prevent the service scheduler - // from marking tasks as unhealthy and stopping them before they have time to come - // up. - HealthCheckGracePeriodSeconds *int32 - - // The capacity provider strategy to use for the service. A capacity provider - // strategy consists of one or more capacity providers along with the base and - // weight to assign to them. A capacity provider must be associated with the - // cluster to be used in a capacity provider strategy. The - // PutClusterCapacityProviders () API is used to associate a capacity provider with - // a cluster. Only capacity providers with an ACTIVE or UPDATING status can be - // used. If a capacityProviderStrategy is specified, the launchType parameter must - // be omitted. If no capacityProviderStrategy or launchType is specified, the - // defaultCapacityProviderStrategy for the cluster is used. If specifying a - // capacity provider that uses an Auto Scaling group, the capacity provider must - // already be created. New capacity providers can be created with the - // CreateCapacityProvider () API operation. To use a AWS Fargate capacity provider, - // specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate - // capacity providers are available to all accounts and only need to be associated - // with a cluster to be used. The PutClusterCapacityProviders () API operation is - // used to update the list of available capacity providers for a cluster after the - // cluster is created. - CapacityProviderStrategy []*types.CapacityProviderStrategyItem + // The scheduling strategy to use for the service. For more information, see + // Services + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html). + // There are two service scheduler strategies available: + // + // * REPLICA-The replica + // scheduling strategy places and maintains the desired number of tasks across your + // cluster. By default, the service scheduler spreads tasks across Availability + // Zones. You can use task placement strategies and constraints to customize task + // placement decisions. This scheduler strategy is required if the service is using + // the CODE_DEPLOY or EXTERNAL deployment controller types. + // + // * DAEMON-The + // daemon scheduling strategy deploys exactly one task on each active container + // instance that meets all of the task placement constraints that you specify in + // your cluster. The service scheduler also evaluates the task placement + // constraints for running tasks and will stop tasks that do not meet the placement + // constraints. When you're using this strategy, you don't need to specify a + // desired number of tasks, a task placement strategy, or use Service Auto Scaling + // policies. Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL + // deployment controller types don't support the DAEMON scheduling strategy. + SchedulingStrategy types.SchedulingStrategy - // The launch type on which to run your service. For more information, see Amazon - // ECS Launch Types - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) - // in the Amazon Elastic Container Service Developer Guide. If a launchType is - // specified, the capacityProviderStrategy parameter must be omitted. - LaunchType types.LaunchType + // The details of the service discovery registries to assign to this service. For + // more information, see Service Discovery + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). + // Service discovery is supported for Fargate tasks if you are using platform + // version v1.1.0 or later. For more information, see AWS Fargate Platform Versions + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html). + ServiceRegistries []*types.ServiceRegistry // The metadata that you apply to the service to help you categorize and organize // them. Each tag consists of a key and an optional value, both of which you @@ -359,38 +386,11 @@ type CreateServiceInput struct { // with this prefix do not count against your tags per resource limit. Tags []*types.Tag - // Specifies whether to enable Amazon ECS managed tags for the tasks within the - // service. For more information, see Tagging Your Amazon ECS Resources - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) - // in the Amazon Elastic Container Service Developer Guide. - EnableECSManagedTags *bool - - // The details of the service discovery registries to assign to this service. For - // more information, see Service Discovery - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). - // Service discovery is supported for Fargate tasks if you are using platform - // version v1.1.0 or later. For more information, see AWS Fargate Platform Versions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html). - ServiceRegistries []*types.ServiceRegistry - - // The deployment controller to use for the service. - DeploymentController *types.DeploymentController - - // Specifies whether to propagate the tags from the task definition or the service - // to the tasks in the service. If no value is specified, the tags are not - // propagated. Tags can only be propagated to the tasks within the service during - // service creation. To add tags to a task after service creation, use the - // TagResource () API action. - PropagateTags types.PropagateTags - - // The placement strategy objects to use for tasks in your service. You can specify - // a maximum of five strategy rules per service. - PlacementStrategy []*types.PlacementStrategy - - // The number of instantiations of the specified task definition to place and keep - // running on your cluster. This is required if schedulingStrategy is REPLICA or is - // not specified. If schedulingStrategy is DAEMON then this is not required. - DesiredCount *int32 + // The family and revision (family:revision) or full ARN of the task definition to + // run in your service. If a revision is not specified, the latest ACTIVE revision + // is used. A task definition must be specified if the service is using the ECS + // deployment controller. + TaskDefinition *string } type CreateServiceOutput struct { diff --git a/service/ecs/api_op_CreateTaskSet.go b/service/ecs/api_op_CreateTaskSet.go index d55b8a3f06d..dc8978274cf 100644 --- a/service/ecs/api_op_CreateTaskSet.go +++ b/service/ecs/api_op_CreateTaskSet.go @@ -61,42 +61,23 @@ func (c *Client) CreateTaskSet(ctx context.Context, params *CreateTaskSetInput, type CreateTaskSetInput struct { - // The details of the service discovery registries to assign to this task set. For - // more information, see Service Discovery - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). - ServiceRegistries []*types.ServiceRegistry - // The short name or full Amazon Resource Name (ARN) of the cluster that hosts the // service to create the task set in. // // This member is required. Cluster *string - // The platform version that the tasks in the task set should use. A platform - // version is specified only for tasks using the Fargate launch type. If one isn't - // specified, the LATEST platform version is used by default. - PlatformVersion *string - - // A load balancer object representing the load balancer to use with the task set. - // The supported load balancer types are either an Application Load Balancer or a - // Network Load Balancer. - LoadBalancers []*types.LoadBalancer - - // An optional non-unique tag that identifies this task set in external systems. If - // the task set is associated with a service discovery registry, the tasks in this - // task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to - // the provided value. - ExternalId *string - - // An object representing the network configuration for a task or service. - NetworkConfiguration *types.NetworkConfiguration - // The short name or full Amazon Resource Name (ARN) of the service to create the // task set in. // // This member is required. Service *string + // The task definition for the tasks in the task set to use. + // + // This member is required. + TaskDefinition *string + // The capacity provider strategy to use for the task set. A capacity provider // strategy consists of one or more capacity providers along with the base and // weight to assign to them. A capacity provider must be associated with the @@ -116,10 +97,15 @@ type CreateTaskSetInput struct { // cluster is created. CapacityProviderStrategy []*types.CapacityProviderStrategyItem - // The task definition for the tasks in the task set to use. - // - // This member is required. - TaskDefinition *string + // Unique, case-sensitive identifier that you provide to ensure the idempotency of + // the request. Up to 32 ASCII characters are allowed. + ClientToken *string + + // An optional non-unique tag that identifies this task set in external systems. If + // the task set is associated with a service discovery registry, the tasks in this + // task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to + // the provided value. + ExternalId *string // The launch type that new tasks in the task set will use. For more information, // see Amazon ECS Launch Types @@ -128,9 +114,27 @@ type CreateTaskSetInput struct { // specified, the capacityProviderStrategy parameter must be omitted. LaunchType types.LaunchType - // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. Up to 32 ASCII characters are allowed. - ClientToken *string + // A load balancer object representing the load balancer to use with the task set. + // The supported load balancer types are either an Application Load Balancer or a + // Network Load Balancer. + LoadBalancers []*types.LoadBalancer + + // An object representing the network configuration for a task or service. + NetworkConfiguration *types.NetworkConfiguration + + // The platform version that the tasks in the task set should use. A platform + // version is specified only for tasks using the Fargate launch type. If one isn't + // specified, the LATEST platform version is used by default. + PlatformVersion *string + + // A floating-point percentage of the desired number of tasks to place and keep + // running in the task set. + Scale *types.Scale + + // The details of the service discovery registries to assign to this task set. For + // more information, see Service Discovery + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). + ServiceRegistries []*types.ServiceRegistry // The metadata that you apply to the task set to help you categorize and organize // them. Each tag consists of a key and an optional value, both of which you @@ -162,10 +166,6 @@ type CreateTaskSetInput struct { // AWS use. You cannot edit or delete tag keys or values with this prefix. Tags // with this prefix do not count against your tags per resource limit. Tags []*types.Tag - - // A floating-point percentage of the desired number of tasks to place and keep - // running in the task set. - Scale *types.Scale } type CreateTaskSetOutput struct { diff --git a/service/ecs/api_op_DeleteAccountSetting.go b/service/ecs/api_op_DeleteAccountSetting.go index 4fc71901a77..911f69c97f1 100644 --- a/service/ecs/api_op_DeleteAccountSetting.go +++ b/service/ecs/api_op_DeleteAccountSetting.go @@ -58,13 +58,6 @@ func (c *Client) DeleteAccountSetting(ctx context.Context, params *DeleteAccount type DeleteAccountSettingInput struct { - // The ARN of the principal, which can be an IAM user, IAM role, or the root user. - // If you specify the root user, it disables the account setting for all IAM users, - // IAM roles, and the root user of the account unless an IAM user or role - // explicitly overrides these settings. If this field is omitted, the setting is - // changed only for the authenticated user. - PrincipalArn *string - // The resource name for which to disable the account setting. If // serviceLongArnFormat is specified, the ARN for your Amazon ECS services is // affected. If taskLongArnFormat is specified, the ARN and resource ID for your @@ -75,6 +68,13 @@ type DeleteAccountSettingInput struct { // // This member is required. Name types.SettingName + + // The ARN of the principal, which can be an IAM user, IAM role, or the root user. + // If you specify the root user, it disables the account setting for all IAM users, + // IAM roles, and the root user of the account unless an IAM user or role + // explicitly overrides these settings. If this field is omitted, the setting is + // changed only for the authenticated user. + PrincipalArn *string } type DeleteAccountSettingOutput struct { diff --git a/service/ecs/api_op_DeleteAttributes.go b/service/ecs/api_op_DeleteAttributes.go index 614e17a6c79..7267420d6e5 100644 --- a/service/ecs/api_op_DeleteAttributes.go +++ b/service/ecs/api_op_DeleteAttributes.go @@ -57,11 +57,6 @@ func (c *Client) DeleteAttributes(ctx context.Context, params *DeleteAttributesI type DeleteAttributesInput struct { - // The short name or full Amazon Resource Name (ARN) of the cluster that contains - // the resource to delete attributes. If you do not specify a cluster, the default - // cluster is assumed. - Cluster *string - // The attributes to delete from your resource. You can specify up to 10 attributes // per request. For custom attributes, specify the attribute name and target ID, // but do not specify the value. If you specify the target ID using the short form, @@ -69,6 +64,11 @@ type DeleteAttributesInput struct { // // This member is required. Attributes []*types.Attribute + + // The short name or full Amazon Resource Name (ARN) of the cluster that contains + // the resource to delete attributes. If you do not specify a cluster, the default + // cluster is assumed. + Cluster *string } type DeleteAttributesOutput struct { diff --git a/service/ecs/api_op_DeleteService.go b/service/ecs/api_op_DeleteService.go index 1168cb4d66c..428d3310f85 100644 --- a/service/ecs/api_op_DeleteService.go +++ b/service/ecs/api_op_DeleteService.go @@ -71,11 +71,6 @@ func (c *Client) DeleteService(ctx context.Context, params *DeleteServiceInput, type DeleteServiceInput struct { - // If true, allows you to delete a service even if it has not been scaled down to - // zero tasks. It is only necessary to use this if the service is using the REPLICA - // scheduling strategy. - Force *bool - // The name of the service to delete. // // This member is required. @@ -85,6 +80,11 @@ type DeleteServiceInput struct { // service to delete. If you do not specify a cluster, the default cluster is // assumed. Cluster *string + + // If true, allows you to delete a service even if it has not been scaled down to + // zero tasks. It is only necessary to use this if the service is using the REPLICA + // scheduling strategy. + Force *bool } type DeleteServiceOutput struct { diff --git a/service/ecs/api_op_DeleteTaskSet.go b/service/ecs/api_op_DeleteTaskSet.go index 7dfa786e19c..61a392ec3e8 100644 --- a/service/ecs/api_op_DeleteTaskSet.go +++ b/service/ecs/api_op_DeleteTaskSet.go @@ -61,6 +61,12 @@ func (c *Client) DeleteTaskSet(ctx context.Context, params *DeleteTaskSetInput, type DeleteTaskSetInput struct { + // The short name or full Amazon Resource Name (ARN) of the cluster that hosts the + // service that the task set exists in to delete. + // + // This member is required. + Cluster *string + // The short name or full Amazon Resource Name (ARN) of the service that hosts the // task set to delete. // @@ -75,12 +81,6 @@ type DeleteTaskSetInput struct { // If true, this allows you to delete a task set even if it hasn't been scaled down // to zero. Force *bool - - // The short name or full Amazon Resource Name (ARN) of the cluster that hosts the - // service that the task set exists in to delete. - // - // This member is required. - Cluster *string } type DeleteTaskSetOutput struct { diff --git a/service/ecs/api_op_DeregisterContainerInstance.go b/service/ecs/api_op_DeregisterContainerInstance.go index 74b05505b8f..37fa938a4e9 100644 --- a/service/ecs/api_op_DeregisterContainerInstance.go +++ b/service/ecs/api_op_DeregisterContainerInstance.go @@ -76,6 +76,11 @@ type DeregisterContainerInstanceInput struct { // This member is required. ContainerInstance *string + // The short name or full Amazon Resource Name (ARN) of the cluster that hosts the + // container instance to deregister. If you do not specify a cluster, the default + // cluster is assumed. + Cluster *string + // Forces the deregistration of the container instance. If you have tasks running // on the container instance when you deregister it with the force option, these // tasks remain running until you terminate the instance or the tasks stop through @@ -87,11 +92,6 @@ type DeregisterContainerInstanceInput struct { // Balancer target group are deregistered. They begin connection draining according // to the settings on the load balancer or target group. Force *bool - - // The short name or full Amazon Resource Name (ARN) of the cluster that hosts the - // container instance to deregister. If you do not specify a cluster, the default - // cluster is assumed. - Cluster *string } type DeregisterContainerInstanceOutput struct { diff --git a/service/ecs/api_op_DescribeCapacityProviders.go b/service/ecs/api_op_DescribeCapacityProviders.go index 234869fd24a..631abdc54db 100644 --- a/service/ecs/api_op_DescribeCapacityProviders.go +++ b/service/ecs/api_op_DescribeCapacityProviders.go @@ -56,13 +56,9 @@ func (c *Client) DescribeCapacityProviders(ctx context.Context, params *Describe type DescribeCapacityProvidersInput struct { - // The nextToken value returned from a previous paginated DescribeCapacityProviders - // request where maxResults was used and the results exceeded the value of that - // parameter. Pagination continues from the end of the previous results that - // returned the nextToken value. This token should be treated as an opaque - // identifier that is only used to retrieve the next items in a list and not for - // other programmatic purposes. - NextToken *string + // The short name or full Amazon Resource Name (ARN) of one or more capacity + // providers. Up to 100 capacity providers can be described in an action. + CapacityProviders []*string // Specifies whether or not you want to see the resource tags for the capacity // provider. If TAGS is specified, the tags are included in the response. If this @@ -79,19 +75,23 @@ type DescribeCapacityProvidersInput struct { // nextToken value if applicable. MaxResults *int32 - // The short name or full Amazon Resource Name (ARN) of one or more capacity - // providers. Up to 100 capacity providers can be described in an action. - CapacityProviders []*string + // The nextToken value returned from a previous paginated DescribeCapacityProviders + // request where maxResults was used and the results exceeded the value of that + // parameter. Pagination continues from the end of the previous results that + // returned the nextToken value. This token should be treated as an opaque + // identifier that is only used to retrieve the next items in a list and not for + // other programmatic purposes. + NextToken *string } type DescribeCapacityProvidersOutput struct { - // Any failures associated with the call. - Failures []*types.Failure - // The list of capacity providers. CapacityProviders []*types.CapacityProvider + // Any failures associated with the call. + Failures []*types.Failure + // The nextToken value to include in a future DescribeCapacityProviders request. // When the results of a DescribeCapacityProviders request exceed maxResults, this // value can be used to retrieve the next page of results. This value is null when diff --git a/service/ecs/api_op_DescribeClusters.go b/service/ecs/api_op_DescribeClusters.go index 6e591c33f9b..74d0e6399ba 100644 --- a/service/ecs/api_op_DescribeClusters.go +++ b/service/ecs/api_op_DescribeClusters.go @@ -56,6 +56,10 @@ func (c *Client) DescribeClusters(ctx context.Context, params *DescribeClustersI type DescribeClustersInput struct { + // A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) + // entries. If you do not specify a cluster, the default cluster is assumed. + Clusters []*string + // Whether to include additional information about your clusters in the response. // If this field is omitted, the attachments, statistics, and tags are not // included. If ATTACHMENTS is specified, the attachments for the container @@ -86,20 +90,16 @@ type DescribeClustersInput struct { // If TAGS is // specified, the metadata tags associated with the cluster are included. Include []types.ClusterField - - // A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) - // entries. If you do not specify a cluster, the default cluster is assumed. - Clusters []*string } type DescribeClustersOutput struct { - // Any failures associated with the call. - Failures []*types.Failure - // The list of clusters. Clusters []*types.Cluster + // Any failures associated with the call. + Failures []*types.Failure + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ecs/api_op_DescribeContainerInstances.go b/service/ecs/api_op_DescribeContainerInstances.go index 4c12fd34148..8af17df20cf 100644 --- a/service/ecs/api_op_DescribeContainerInstances.go +++ b/service/ecs/api_op_DescribeContainerInstances.go @@ -58,10 +58,11 @@ func (c *Client) DescribeContainerInstances(ctx context.Context, params *Describ type DescribeContainerInstancesInput struct { - // Specifies whether you want to see the resource tags for the container instance. - // If TAGS is specified, the tags are included in the response. If this field is - // omitted, tags are not included in the response. - Include []types.ContainerInstanceField + // A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) + // entries. + // + // This member is required. + ContainerInstances []*string // The short name or full Amazon Resource Name (ARN) of the cluster that hosts the // container instances to describe. If you do not specify a cluster, the default @@ -70,21 +71,20 @@ type DescribeContainerInstancesInput struct { // the default cluster. Cluster *string - // A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) - // entries. - // - // This member is required. - ContainerInstances []*string + // Specifies whether you want to see the resource tags for the container instance. + // If TAGS is specified, the tags are included in the response. If this field is + // omitted, tags are not included in the response. + Include []types.ContainerInstanceField } type DescribeContainerInstancesOutput struct { - // Any failures associated with the call. - Failures []*types.Failure - // The list of container instances. ContainerInstances []*types.ContainerInstance + // Any failures associated with the call. + Failures []*types.Failure + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ecs/api_op_DescribeServices.go b/service/ecs/api_op_DescribeServices.go index 9a4dd0fa76f..4b8c455eac6 100644 --- a/service/ecs/api_op_DescribeServices.go +++ b/service/ecs/api_op_DescribeServices.go @@ -63,16 +63,16 @@ type DescribeServicesInput struct { // This member is required. Services []*string - // Specifies whether you want to see the resource tags for the service. If TAGS is - // specified, the tags are included in the response. If this field is omitted, tags - // are not included in the response. - Include []types.ServiceField - // The short name or full Amazon Resource Name (ARN)the cluster that hosts the // service to describe. If you do not specify a cluster, the default cluster is // assumed. This parameter is required if the service or services you are // describing were launched in any cluster other than the default cluster. Cluster *string + + // Specifies whether you want to see the resource tags for the service. If TAGS is + // specified, the tags are included in the response. If this field is omitted, tags + // are not included in the response. + Include []types.ServiceField } type DescribeServicesOutput struct { diff --git a/service/ecs/api_op_DescribeTaskDefinition.go b/service/ecs/api_op_DescribeTaskDefinition.go index c49965a5a78..b424cd6285c 100644 --- a/service/ecs/api_op_DescribeTaskDefinition.go +++ b/service/ecs/api_op_DescribeTaskDefinition.go @@ -75,9 +75,6 @@ type DescribeTaskDefinitionInput struct { type DescribeTaskDefinitionOutput struct { - // The full task definition description. - TaskDefinition *types.TaskDefinition - // The metadata that is applied to the task definition to help you categorize and // organize them. Each tag consists of a key and an optional value, both of which // you define. The following basic restrictions apply to tags: @@ -109,6 +106,9 @@ type DescribeTaskDefinitionOutput struct { // limit. Tags []*types.Tag + // The full task definition description. + TaskDefinition *types.TaskDefinition + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ecs/api_op_DescribeTaskSets.go b/service/ecs/api_op_DescribeTaskSets.go index 5e242c4b19e..8925a9378d6 100644 --- a/service/ecs/api_op_DescribeTaskSets.go +++ b/service/ecs/api_op_DescribeTaskSets.go @@ -61,6 +61,12 @@ func (c *Client) DescribeTaskSets(ctx context.Context, params *DescribeTaskSetsI type DescribeTaskSetsInput struct { + // The short name or full Amazon Resource Name (ARN) of the cluster that hosts the + // service that the task sets exist in. + // + // This member is required. + Cluster *string + // The short name or full Amazon Resource Name (ARN) of the service that the task // sets exist in. // @@ -74,22 +80,16 @@ type DescribeTaskSetsInput struct { // The ID or full Amazon Resource Name (ARN) of task sets to describe. TaskSets []*string - - // The short name or full Amazon Resource Name (ARN) of the cluster that hosts the - // service that the task sets exist in. - // - // This member is required. - Cluster *string } type DescribeTaskSetsOutput struct { - // The list of task sets described. - TaskSets []*types.TaskSet - // Any failures associated with the call. Failures []*types.Failure + // The list of task sets described. + TaskSets []*types.TaskSet + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ecs/api_op_DescribeTasks.go b/service/ecs/api_op_DescribeTasks.go index 2c17147cc4f..2680f50a234 100644 --- a/service/ecs/api_op_DescribeTasks.go +++ b/service/ecs/api_op_DescribeTasks.go @@ -57,17 +57,17 @@ func (c *Client) DescribeTasks(ctx context.Context, params *DescribeTasksInput, type DescribeTasksInput struct { + // A list of up to 100 task IDs or full ARN entries. + // + // This member is required. + Tasks []*string + // The short name or full Amazon Resource Name (ARN) of the cluster that hosts the // task or tasks to describe. If you do not specify a cluster, the default cluster // is assumed. This parameter is required if the task or tasks you are describing // were launched in any cluster other than the default cluster. Cluster *string - // A list of up to 100 task IDs or full ARN entries. - // - // This member is required. - Tasks []*string - // Specifies whether you want to see the resource tags for the task. If TAGS is // specified, the tags are included in the response. If this field is omitted, tags // are not included in the response. @@ -76,12 +76,12 @@ type DescribeTasksInput struct { type DescribeTasksOutput struct { - // The list of tasks. - Tasks []*types.Task - // Any failures associated with the call. Failures []*types.Failure + // The list of tasks. + Tasks []*types.Task + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ecs/api_op_ListAccountSettings.go b/service/ecs/api_op_ListAccountSettings.go index 76db1e6154a..99733b519c6 100644 --- a/service/ecs/api_op_ListAccountSettings.go +++ b/service/ecs/api_op_ListAccountSettings.go @@ -56,6 +56,12 @@ func (c *Client) ListAccountSettings(ctx context.Context, params *ListAccountSet type ListAccountSettingsInput struct { + // Specifies whether to return the effective settings. If true, the account + // settings for the root user or the default setting for the principalArn are + // returned. If false, the account settings for the principalArn are returned if + // they are set. Otherwise, no account settings are returned. + EffectiveSettings *bool + // The maximum number of account setting results returned by ListAccountSettings in // paginated output. When this parameter is used, ListAccountSettings only returns // maxResults results in a single page along with a nextToken response element. The @@ -65,10 +71,8 @@ type ListAccountSettingsInput struct { // returns up to 10 results and a nextToken value if applicable. MaxResults *int32 - // The ARN of the principal, which can be an IAM user, IAM role, or the root user. - // If this field is omitted, the account settings are listed only for the - // authenticated user. - PrincipalArn *string + // The name of the account setting you want to list the settings for. + Name types.SettingName // The nextToken value returned from a ListAccountSettings request indicating that // more results are available to fulfill the request and further calls will be @@ -78,31 +82,27 @@ type ListAccountSettingsInput struct { // purposes. NextToken *string + // The ARN of the principal, which can be an IAM user, IAM role, or the root user. + // If this field is omitted, the account settings are listed only for the + // authenticated user. + PrincipalArn *string + // The value of the account settings with which to filter results. You must also // specify an account setting name to use this parameter. Value *string - - // The name of the account setting you want to list the settings for. - Name types.SettingName - - // Specifies whether to return the effective settings. If true, the account - // settings for the root user or the default setting for the principalArn are - // returned. If false, the account settings for the principalArn are returned if - // they are set. Otherwise, no account settings are returned. - EffectiveSettings *bool } type ListAccountSettingsOutput struct { - // The account settings for the resource. - Settings []*types.Setting - // The nextToken value to include in a future ListAccountSettings request. When the // results of a ListAccountSettings request exceed maxResults, this value can be // used to retrieve the next page of results. This value is null when there are no // more results to return. NextToken *string + // The account settings for the resource. + Settings []*types.Setting + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ecs/api_op_ListAttributes.go b/service/ecs/api_op_ListAttributes.go index acfb9afb0e8..2da11c65316 100644 --- a/service/ecs/api_op_ListAttributes.go +++ b/service/ecs/api_op_ListAttributes.go @@ -63,6 +63,22 @@ func (c *Client) ListAttributes(ctx context.Context, params *ListAttributesInput type ListAttributesInput struct { + // The type of the target with which to list attributes. + // + // This member is required. + TargetType types.TargetType + + // The name of the attribute with which to filter the results. + AttributeName *string + + // The value of the attribute with which to filter results. You must also specify + // an attribute name to use this parameter. + AttributeValue *string + + // The short name or full Amazon Resource Name (ARN) of the cluster to list + // attributes. If you do not specify a cluster, the default cluster is assumed. + Cluster *string + // The maximum number of cluster results returned by ListAttributes in paginated // output. When this parameter is used, ListAttributes only returns maxResults // results in a single page along with a nextToken response element. The remaining @@ -79,35 +95,19 @@ type ListAttributesInput struct { // only used to retrieve the next items in a list and not for other programmatic // purposes. NextToken *string - - // The short name or full Amazon Resource Name (ARN) of the cluster to list - // attributes. If you do not specify a cluster, the default cluster is assumed. - Cluster *string - - // The name of the attribute with which to filter the results. - AttributeName *string - - // The value of the attribute with which to filter results. You must also specify - // an attribute name to use this parameter. - AttributeValue *string - - // The type of the target with which to list attributes. - // - // This member is required. - TargetType types.TargetType } type ListAttributesOutput struct { + // A list of attribute objects that meet the criteria of the request. + Attributes []*types.Attribute + // The nextToken value to include in a future ListAttributes request. When the // results of a ListAttributes request exceed maxResults, this value can be used to // retrieve the next page of results. This value is null when there are no more // results to return. NextToken *string - // A list of attribute objects that meet the criteria of the request. - Attributes []*types.Attribute - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ecs/api_op_ListContainerInstances.go b/service/ecs/api_op_ListContainerInstances.go index b913beb0e79..82b8038e2ad 100644 --- a/service/ecs/api_op_ListContainerInstances.go +++ b/service/ecs/api_op_ListContainerInstances.go @@ -61,12 +61,10 @@ func (c *Client) ListContainerInstances(ctx context.Context, params *ListContain type ListContainerInstancesInput struct { - // Filters the container instances by status. For example, if you specify the - // DRAINING status, the results include only container instances that have been set - // to DRAINING using UpdateContainerInstancesState (). If you do not specify this - // parameter, the default is to include container instances set to all states other - // than INACTIVE. - Status types.ContainerInstanceStatus + // The short name or full Amazon Resource Name (ARN) of the cluster that hosts the + // container instances to list. If you do not specify a cluster, the default + // cluster is assumed. + Cluster *string // You can filter the results of a ListContainerInstances operation with cluster // query language statements. For more information, see Cluster Query Language @@ -74,11 +72,6 @@ type ListContainerInstancesInput struct { // in the Amazon Elastic Container Service Developer Guide. Filter *string - // The short name or full Amazon Resource Name (ARN) of the cluster that hosts the - // container instances to list. If you do not specify a cluster, the default - // cluster is assumed. - Cluster *string - // The maximum number of container instance results returned by // ListContainerInstances in paginated output. When this parameter is used, // ListContainerInstances only returns maxResults results in a single page along @@ -96,20 +89,27 @@ type ListContainerInstancesInput struct { // is only used to retrieve the next items in a list and not for other programmatic // purposes. NextToken *string + + // Filters the container instances by status. For example, if you specify the + // DRAINING status, the results include only container instances that have been set + // to DRAINING using UpdateContainerInstancesState (). If you do not specify this + // parameter, the default is to include container instances set to all states other + // than INACTIVE. + Status types.ContainerInstanceStatus } type ListContainerInstancesOutput struct { + // The list of container instances with full ARN entries for each container + // instance associated with the specified cluster. + ContainerInstanceArns []*string + // The nextToken value to include in a future ListContainerInstances request. When // the results of a ListContainerInstances request exceed maxResults, this value // can be used to retrieve the next page of results. This value is null when there // are no more results to return. NextToken *string - // The list of container instances with full ARN entries for each container - // instance associated with the specified cluster. - ContainerInstanceArns []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ecs/api_op_ListServices.go b/service/ecs/api_op_ListServices.go index bfefddb1f06..c6fae67bfab 100644 --- a/service/ecs/api_op_ListServices.go +++ b/service/ecs/api_op_ListServices.go @@ -56,6 +56,14 @@ func (c *Client) ListServices(ctx context.Context, params *ListServicesInput, op type ListServicesInput struct { + // The short name or full Amazon Resource Name (ARN) of the cluster that hosts the + // services to list. If you do not specify a cluster, the default cluster is + // assumed. + Cluster *string + + // The launch type for the services to list. + LaunchType types.LaunchType + // The maximum number of service results returned by ListServices in paginated // output. When this parameter is used, ListServices only returns maxResults // results in a single page along with a nextToken response element. The remaining @@ -65,11 +73,6 @@ type ListServicesInput struct { // nextToken value if applicable. MaxResults *int32 - // The short name or full Amazon Resource Name (ARN) of the cluster that hosts the - // services to list. If you do not specify a cluster, the default cluster is - // assumed. - Cluster *string - // The nextToken value returned from a ListServices request indicating that more // results are available to fulfill the request and further calls will be needed. // If maxResults was provided, it is possible the number of results to be fewer @@ -80,9 +83,6 @@ type ListServicesInput struct { // The scheduling strategy for services to list. SchedulingStrategy types.SchedulingStrategy - - // The launch type for the services to list. - LaunchType types.LaunchType } type ListServicesOutput struct { diff --git a/service/ecs/api_op_ListTaskDefinitionFamilies.go b/service/ecs/api_op_ListTaskDefinitionFamilies.go index 57978ab99c7..d3a1a88b964 100644 --- a/service/ecs/api_op_ListTaskDefinitionFamilies.go +++ b/service/ecs/api_op_ListTaskDefinitionFamilies.go @@ -60,14 +60,6 @@ func (c *Client) ListTaskDefinitionFamilies(ctx context.Context, params *ListTas type ListTaskDefinitionFamiliesInput struct { - // The nextToken value returned from a ListTaskDefinitionFamilies request - // indicating that more results are available to fulfill the request and further - // calls will be needed. If maxResults was provided, it is possible the number of - // results to be fewer than maxResults. This token should be treated as an opaque - // identifier that is only used to retrieve the next items in a list and not for - // other programmatic purposes. - NextToken *string - // The familyPrefix is a string that is used to filter the results of // ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition // family names that begin with the familyPrefix string are returned. @@ -83,6 +75,14 @@ type ListTaskDefinitionFamiliesInput struct { // value if applicable. MaxResults *int32 + // The nextToken value returned from a ListTaskDefinitionFamilies request + // indicating that more results are available to fulfill the request and further + // calls will be needed. If maxResults was provided, it is possible the number of + // results to be fewer than maxResults. This token should be treated as an opaque + // identifier that is only used to retrieve the next items in a list and not for + // other programmatic purposes. + NextToken *string + // The task definition family status with which to filter the // ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task // definition families are listed. If this parameter is set to ACTIVE, only task @@ -96,16 +96,16 @@ type ListTaskDefinitionFamiliesInput struct { type ListTaskDefinitionFamiliesOutput struct { + // The list of task definition family names that match the + // ListTaskDefinitionFamilies request. + Families []*string + // The nextToken value to include in a future ListTaskDefinitionFamilies request. // When the results of a ListTaskDefinitionFamilies request exceed maxResults, this // value can be used to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string - // The list of task definition family names that match the - // ListTaskDefinitionFamilies request. - Families []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ecs/api_op_ListTaskDefinitions.go b/service/ecs/api_op_ListTaskDefinitions.go index 1b653043fb6..f151a560cf9 100644 --- a/service/ecs/api_op_ListTaskDefinitions.go +++ b/service/ecs/api_op_ListTaskDefinitions.go @@ -58,6 +58,20 @@ func (c *Client) ListTaskDefinitions(ctx context.Context, params *ListTaskDefini type ListTaskDefinitionsInput struct { + // The full family name with which to filter the ListTaskDefinitions results. + // Specifying a familyPrefix limits the listed task definitions to task definition + // revisions that belong to that family. + FamilyPrefix *string + + // The maximum number of task definition results returned by ListTaskDefinitions in + // paginated output. When this parameter is used, ListTaskDefinitions only returns + // maxResults results in a single page along with a nextToken response element. The + // remaining results of the initial request can be seen by sending another + // ListTaskDefinitions request with the returned nextToken value. This value can be + // between 1 and 100. If this parameter is not used, then ListTaskDefinitions + // returns up to 100 results and a nextToken value if applicable. + MaxResults *int32 + // The nextToken value returned from a ListTaskDefinitions request indicating that // more results are available to fulfill the request and further calls will be // needed. If maxResults was provided, it is possible the number of results to be @@ -80,34 +94,20 @@ type ListTaskDefinitionsInput struct { // active task or service still references them. If you paginate the resulting // output, be sure to keep the status value constant in each subsequent request. Status types.TaskDefinitionStatus - - // The maximum number of task definition results returned by ListTaskDefinitions in - // paginated output. When this parameter is used, ListTaskDefinitions only returns - // maxResults results in a single page along with a nextToken response element. The - // remaining results of the initial request can be seen by sending another - // ListTaskDefinitions request with the returned nextToken value. This value can be - // between 1 and 100. If this parameter is not used, then ListTaskDefinitions - // returns up to 100 results and a nextToken value if applicable. - MaxResults *int32 - - // The full family name with which to filter the ListTaskDefinitions results. - // Specifying a familyPrefix limits the listed task definitions to task definition - // revisions that belong to that family. - FamilyPrefix *string } type ListTaskDefinitionsOutput struct { - // The list of task definition Amazon Resource Name (ARN) entries for the - // ListTaskDefinitions request. - TaskDefinitionArns []*string - // The nextToken value to include in a future ListTaskDefinitions request. When the // results of a ListTaskDefinitions request exceed maxResults, this value can be // used to retrieve the next page of results. This value is null when there are no // more results to return. NextToken *string + // The list of task definition Amazon Resource Name (ARN) entries for the + // ListTaskDefinitions request. + TaskDefinitionArns []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ecs/api_op_ListTasks.go b/service/ecs/api_op_ListTasks.go index 6a61e1a6134..acba11a9fda 100644 --- a/service/ecs/api_op_ListTasks.go +++ b/service/ecs/api_op_ListTasks.go @@ -60,15 +60,32 @@ func (c *Client) ListTasks(ctx context.Context, params *ListTasksInput, optFns . type ListTasksInput struct { - // The startedBy value with which to filter the task results. Specifying a - // startedBy value limits the results to tasks that were started with that value. - StartedBy *string + // The short name or full Amazon Resource Name (ARN) of the cluster that hosts the + // tasks to list. If you do not specify a cluster, the default cluster is assumed. + Cluster *string // The container instance ID or full ARN of the container instance with which to // filter the ListTasks results. Specifying a containerInstance limits the results // to tasks that belong to that container instance. ContainerInstance *string + // The task desired status with which to filter the ListTasks results. Specifying a + // desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the + // desired status to STOPPED. This can be useful for debugging tasks that are not + // starting properly or have died or finished. The default status filter is + // RUNNING, which shows tasks that Amazon ECS has set the desired status to + // RUNNING. Although you can filter results based on a desired status of PENDING, + // this does not return any results. Amazon ECS never sets the desired status of a + // task to that value (only a task's lastStatus may have a value of PENDING). + DesiredStatus types.DesiredStatus + + // The name of the family with which to filter the ListTasks results. Specifying a + // family limits the results to tasks that belong to that family. + Family *string + + // The launch type for services to list. + LaunchType types.LaunchType + // The maximum number of task results returned by ListTasks in paginated output. // When this parameter is used, ListTasks only returns maxResults results in a // single page along with a nextToken response element. The remaining results of @@ -86,43 +103,26 @@ type ListTasksInput struct { // purposes. NextToken *string - // The short name or full Amazon Resource Name (ARN) of the cluster that hosts the - // tasks to list. If you do not specify a cluster, the default cluster is assumed. - Cluster *string - - // The launch type for services to list. - LaunchType types.LaunchType - - // The name of the family with which to filter the ListTasks results. Specifying a - // family limits the results to tasks that belong to that family. - Family *string - // The name of the service with which to filter the ListTasks results. Specifying a // serviceName limits the results to tasks that belong to that service. ServiceName *string - // The task desired status with which to filter the ListTasks results. Specifying a - // desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the - // desired status to STOPPED. This can be useful for debugging tasks that are not - // starting properly or have died or finished. The default status filter is - // RUNNING, which shows tasks that Amazon ECS has set the desired status to - // RUNNING. Although you can filter results based on a desired status of PENDING, - // this does not return any results. Amazon ECS never sets the desired status of a - // task to that value (only a task's lastStatus may have a value of PENDING). - DesiredStatus types.DesiredStatus + // The startedBy value with which to filter the task results. Specifying a + // startedBy value limits the results to tasks that were started with that value. + StartedBy *string } type ListTasksOutput struct { - // The list of task ARN entries for the ListTasks request. - TaskArns []*string - // The nextToken value to include in a future ListTasks request. When the results // of a ListTasks request exceed maxResults, this value can be used to retrieve the // next page of results. This value is null when there are no more results to // return. NextToken *string + // The list of task ARN entries for the ListTasks request. + TaskArns []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ecs/api_op_PutAccountSetting.go b/service/ecs/api_op_PutAccountSetting.go index a82b5d39d91..9af318209a1 100644 --- a/service/ecs/api_op_PutAccountSetting.go +++ b/service/ecs/api_op_PutAccountSetting.go @@ -83,19 +83,6 @@ func (c *Client) PutAccountSetting(ctx context.Context, params *PutAccountSettin type PutAccountSettingInput struct { - // The ARN of the principal, which can be an IAM user, IAM role, or the root user. - // If you specify the root user, it modifies the account setting for all IAM users, - // IAM roles, and the root user of the account unless an IAM user or role - // explicitly overrides these settings. If this field is omitted, the setting is - // changed only for the authenticated user. - PrincipalArn *string - - // The account setting value for the specified principal ARN. Accepted values are - // enabled and disabled. - // - // This member is required. - Value *string - // The Amazon ECS resource name for which to modify the account setting. If // serviceLongArnFormat is specified, the ARN for your Amazon ECS services is // affected. If taskLongArnFormat is specified, the ARN and resource ID for your @@ -108,6 +95,19 @@ type PutAccountSettingInput struct { // // This member is required. Name types.SettingName + + // The account setting value for the specified principal ARN. Accepted values are + // enabled and disabled. + // + // This member is required. + Value *string + + // The ARN of the principal, which can be an IAM user, IAM role, or the root user. + // If you specify the root user, it modifies the account setting for all IAM users, + // IAM roles, and the root user of the account unless an IAM user or role + // explicitly overrides these settings. If this field is omitted, the setting is + // changed only for the authenticated user. + PrincipalArn *string } type PutAccountSettingOutput struct { diff --git a/service/ecs/api_op_PutAttributes.go b/service/ecs/api_op_PutAttributes.go index 1c2ddb7d51c..8dc29a34a00 100644 --- a/service/ecs/api_op_PutAttributes.go +++ b/service/ecs/api_op_PutAttributes.go @@ -62,16 +62,16 @@ func (c *Client) PutAttributes(ctx context.Context, params *PutAttributesInput, type PutAttributesInput struct { - // The short name or full Amazon Resource Name (ARN) of the cluster that contains - // the resource to apply attributes. If you do not specify a cluster, the default - // cluster is assumed. - Cluster *string - // The attributes to apply to your resource. You can specify up to 10 custom // attributes per resource. You can specify up to 10 attributes in a single call. // // This member is required. Attributes []*types.Attribute + + // The short name or full Amazon Resource Name (ARN) of the cluster that contains + // the resource to apply attributes. If you do not specify a cluster, the default + // cluster is assumed. + Cluster *string } type PutAttributesOutput struct { diff --git a/service/ecs/api_op_PutClusterCapacityProviders.go b/service/ecs/api_op_PutClusterCapacityProviders.go index 2d103e6054f..9a16ac23bc2 100644 --- a/service/ecs/api_op_PutClusterCapacityProviders.go +++ b/service/ecs/api_op_PutClusterCapacityProviders.go @@ -69,24 +69,6 @@ func (c *Client) PutClusterCapacityProviders(ctx context.Context, params *PutClu type PutClusterCapacityProvidersInput struct { - // The capacity provider strategy to use by default for the cluster. When creating - // a service or running a task on a cluster, if no capacity provider or launch type - // is specified then the default capacity provider strategy for the cluster is - // used. A capacity provider strategy consists of one or more capacity providers - // along with the base and weight to assign to them. A capacity provider must be - // associated with the cluster to be used in a capacity provider strategy. The - // PutClusterCapacityProviders () API is used to associate a capacity provider with - // a cluster. Only capacity providers with an ACTIVE or UPDATING status can be - // used. If specifying a capacity provider that uses an Auto Scaling group, the - // capacity provider must already be created. New capacity providers can be created - // with the CreateCapacityProvider () API operation. To use a AWS Fargate capacity - // provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS - // Fargate capacity providers are available to all accounts and only need to be - // associated with a cluster to be used. - // - // This member is required. - DefaultCapacityProviderStrategy []*types.CapacityProviderStrategyItem - // The name of one or more capacity providers to associate with the cluster. If // specifying a capacity provider that uses an Auto Scaling group, the capacity // provider must already be created. New capacity providers can be created with the @@ -104,6 +86,24 @@ type PutClusterCapacityProvidersInput struct { // // This member is required. Cluster *string + + // The capacity provider strategy to use by default for the cluster. When creating + // a service or running a task on a cluster, if no capacity provider or launch type + // is specified then the default capacity provider strategy for the cluster is + // used. A capacity provider strategy consists of one or more capacity providers + // along with the base and weight to assign to them. A capacity provider must be + // associated with the cluster to be used in a capacity provider strategy. The + // PutClusterCapacityProviders () API is used to associate a capacity provider with + // a cluster. Only capacity providers with an ACTIVE or UPDATING status can be + // used. If specifying a capacity provider that uses an Auto Scaling group, the + // capacity provider must already be created. New capacity providers can be created + // with the CreateCapacityProvider () API operation. To use a AWS Fargate capacity + // provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS + // Fargate capacity providers are available to all accounts and only need to be + // associated with a cluster to be used. + // + // This member is required. + DefaultCapacityProviderStrategy []*types.CapacityProviderStrategyItem } type PutClusterCapacityProvidersOutput struct { diff --git a/service/ecs/api_op_RegisterContainerInstance.go b/service/ecs/api_op_RegisterContainerInstance.go index 4d3aca3b39b..7dbf5f3e27d 100644 --- a/service/ecs/api_op_RegisterContainerInstance.go +++ b/service/ecs/api_op_RegisterContainerInstance.go @@ -59,24 +59,16 @@ func (c *Client) RegisterContainerInstance(ctx context.Context, params *Register type RegisterContainerInstanceInput struct { - // The ARN of the container instance (if it was previously registered). - ContainerInstanceArn *string - // The container instance attributes that this container instance supports. Attributes []*types.Attribute - // The version information for the Amazon ECS container agent and Docker daemon - // running on the container instance. - VersionInfo *types.VersionInfo - // The short name or full Amazon Resource Name (ARN) of the cluster with which to // register your container instance. If you do not specify a cluster, the default // cluster is assumed. Cluster *string - // The devices that are available on the container instance. The only supported - // device type is a GPU. - PlatformDevices []*types.PlatformDevice + // The ARN of the container instance (if it was previously registered). + ContainerInstanceArn *string // The instance identity document for the EC2 instance to register. This document // can be found by running the following command from the instance: curl @@ -88,8 +80,9 @@ type RegisterContainerInstanceInput struct { // http://169.254.169.254/latest/dynamic/instance-identity/signature/ InstanceIdentityDocumentSignature *string - // The resources available on the instance. - TotalResources []*types.Resource + // The devices that are available on the container instance. The only supported + // device type is a GPU. + PlatformDevices []*types.PlatformDevice // The metadata that you apply to the container instance to help you categorize and // organize them. Each tag consists of a key and an optional value, both of which @@ -121,6 +114,13 @@ type RegisterContainerInstanceInput struct { // this prefix. Tags with this prefix do not count against your tags per resource // limit. Tags []*types.Tag + + // The resources available on the instance. + TotalResources []*types.Resource + + // The version information for the Amazon ECS container agent and Docker daemon + // running on the container instance. + VersionInfo *types.VersionInfo } type RegisterContainerInstanceOutput struct { diff --git a/service/ecs/api_op_RegisterTaskDefinition.go b/service/ecs/api_op_RegisterTaskDefinition.go index 6c9d277b2bb..c50f24d531a 100644 --- a/service/ecs/api_op_RegisterTaskDefinition.go +++ b/service/ecs/api_op_RegisterTaskDefinition.go @@ -78,54 +78,90 @@ func (c *Client) RegisterTaskDefinition(ctx context.Context, params *RegisterTas type RegisterTaskDefinitionInput struct { - // The process namespace to use for the containers in the task. The valid values - // are host or task. If host is specified, then all containers within the tasks - // that specified the host PID mode on the same container instance share the same - // process namespace with the host Amazon EC2 instance. If task is specified, all - // containers within the specified task share the same process namespace. If no - // value is specified, the default is a private namespace. For more information, - // see PID settings - // (https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the Docker - // run reference. If the host PID mode is used, be aware that there is a heightened - // risk of undesired process namespace expose. For more information, see Docker - // security (https://docs.docker.com/engine/security/security/). This parameter is - // not supported for Windows containers or tasks using the Fargate launch type. - PidMode types.PidMode + // A list of container definitions in JSON format that describe the different + // containers that make up your task. + // + // This member is required. + ContainerDefinitions []*types.ContainerDefinition - // The metadata that you apply to the task definition to help you categorize and - // organize them. Each tag consists of a key and an optional value, both of which - // you define. The following basic restrictions apply to tags: + // You must specify a family for a task definition, which allows you to track + // multiple versions of the same task definition. The family is used as a name for + // your task definition. Up to 255 letters (uppercase and lowercase), numbers, and + // hyphens are allowed. // - // * Maximum - // number of tags per resource - 50 + // This member is required. + Family *string + + // The number of CPU units used by the task. It can be expressed as an integer + // using CPU units, for example 1024, or as a string using vCPUs, for example 1 + // vCPU or 1 vcpu, in a task definition. String values are converted to an integer + // indicating the CPU units when the task definition is registered. Task-level CPU + // and memory parameters are ignored for Windows containers. We recommend + // specifying container-level resources for Windows containers. If you are using + // the EC2 launch type, this field is optional. Supported values are between 128 + // CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). If you are using the + // Fargate launch type, this field is required and you must use one of the + // following values, which determines your range of supported values for the memory + // parameter: // - // * For each resource, each tag key must be - // unique, and each tag key can have only one value. + // * 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 + // (1 GB), 2048 (2 GB) // - // * Maximum key length - - // 128 Unicode characters in UTF-8 + // * 512 (.5 vCPU) - Available memory values: 1024 (1 GB), + // 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) // - // * Maximum value length - 256 Unicode - // characters in UTF-8 + // * 1024 (1 vCPU) - Available memory + // values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 + // GB), 8192 (8 GB) // - // * If your tagging schema is used across multiple - // services and resources, remember that other services may have restrictions on - // allowed characters. Generally allowed characters are: letters, numbers, and - // spaces representable in UTF-8, and the following characters: + - = . _ : / @. + // * 2048 (2 vCPU) - Available memory values: Between 4096 (4 + // GB) and 16384 (16 GB) in increments of 1024 (1 GB) + // + // * 4096 (4 vCPU) - + // Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of + // 1024 (1 GB) + Cpu *string + + // The Amazon Resource Name (ARN) of the task execution role that grants the Amazon + // ECS container agent permission to make AWS API calls on your behalf. The task + // execution IAM role is required depending on the requirements of your task. For + // more information, see Amazon ECS task execution IAM role + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) + // in the Amazon Elastic Container Service Developer Guide. + ExecutionRoleArn *string + + // The Elastic Inference accelerators to use for the containers in the task. + InferenceAccelerators []*types.InferenceAccelerator + + // The IPC resource namespace to use for the containers in the task. The valid + // values are host, task, or none. If host is specified, then all containers within + // the tasks that specified the host IPC mode on the same container instance share + // the same IPC resources with the host Amazon EC2 instance. If task is specified, + // all containers within the specified task share the same IPC resources. If none + // is specified, then IPC resources within the containers of a task are private and + // not shared with other containers in a task or on the container instance. If no + // value is specified, then the IPC resource namespace sharing depends on the + // Docker daemon setting on the container instance. For more information, see IPC + // settings (https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in + // the Docker run reference. If the host IPC mode is used, be aware that there is a + // heightened risk of undesired IPC namespace expose. For more information, see + // Docker security (https://docs.docker.com/engine/security/security/). If you are + // setting namespaced kernel parameters using systemControls for the containers in + // the task, the following will apply to your IPC resource namespace. For more + // information, see System Controls + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) + // in the Amazon Elastic Container Service Developer Guide. // + // * For tasks that + // use the host IPC mode, IPC namespace related systemControls are not supported. // - // * Tag keys and values are case-sensitive. // - // * Do not use aws:, AWS:, or any - // upper or lowercase combination of such as a prefix for either keys or values as - // it is reserved for AWS use. You cannot edit or delete tag keys or values with - // this prefix. Tags with this prefix do not count against your tags per resource - // limit. - Tags []*types.Tag - - // The launch type required by the task. If no value is specified, it defaults to - // EC2. - RequiresCompatibilities []types.Compatibility + // * For tasks that use the task IPC mode, IPC namespace related systemControls + // will apply to all containers within a task. + // + // This parameter is not supported for + // Windows containers or tasks using the Fargate launch type. + IpcMode types.IpcMode // The amount of memory (in MiB) used by the task. It can be expressed as an // integer using MiB, for example 1024, or as a string using GB, for example 1GB or @@ -155,11 +191,6 @@ type RegisterTaskDefinitionInput struct { // cpu values: 4096 (4 vCPU) Memory *string - // An array of placement constraint objects to use for the task. You can specify a - // maximum of 10 constraints per task (this limit includes constraints in the task - // definition and those specified at runtime). - PlacementConstraints []*types.TaskDefinitionPlacementConstraint - // The Docker networking mode to use for the containers in the task. The valid // values are none, bridge, awsvpc, and host. The default Docker network mode is // bridge. If you are using the Fargate launch type, the awsvpc network mode is @@ -190,86 +221,24 @@ type RegisterTaskDefinitionInput struct { // run reference. NetworkMode types.NetworkMode - // A list of container definitions in JSON format that describe the different - // containers that make up your task. - // - // This member is required. - ContainerDefinitions []*types.ContainerDefinition - - // The IPC resource namespace to use for the containers in the task. The valid - // values are host, task, or none. If host is specified, then all containers within - // the tasks that specified the host IPC mode on the same container instance share - // the same IPC resources with the host Amazon EC2 instance. If task is specified, - // all containers within the specified task share the same IPC resources. If none - // is specified, then IPC resources within the containers of a task are private and - // not shared with other containers in a task or on the container instance. If no - // value is specified, then the IPC resource namespace sharing depends on the - // Docker daemon setting on the container instance. For more information, see IPC - // settings (https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in - // the Docker run reference. If the host IPC mode is used, be aware that there is a - // heightened risk of undesired IPC namespace expose. For more information, see - // Docker security (https://docs.docker.com/engine/security/security/). If you are - // setting namespaced kernel parameters using systemControls for the containers in - // the task, the following will apply to your IPC resource namespace. For more - // information, see System Controls - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) - // in the Amazon Elastic Container Service Developer Guide. - // - // * For tasks that - // use the host IPC mode, IPC namespace related systemControls are not supported. - // - // - // * For tasks that use the task IPC mode, IPC namespace related systemControls - // will apply to all containers within a task. - // - // This parameter is not supported for - // Windows containers or tasks using the Fargate launch type. - IpcMode types.IpcMode - - // The Elastic Inference accelerators to use for the containers in the task. - InferenceAccelerators []*types.InferenceAccelerator - - // A list of volume definitions in JSON format that containers in your task may - // use. - Volumes []*types.Volume - - // The Amazon Resource Name (ARN) of the task execution role that grants the Amazon - // ECS container agent permission to make AWS API calls on your behalf. The task - // execution IAM role is required depending on the requirements of your task. For - // more information, see Amazon ECS task execution IAM role - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) - // in the Amazon Elastic Container Service Developer Guide. - ExecutionRoleArn *string + // The process namespace to use for the containers in the task. The valid values + // are host or task. If host is specified, then all containers within the tasks + // that specified the host PID mode on the same container instance share the same + // process namespace with the host Amazon EC2 instance. If task is specified, all + // containers within the specified task share the same process namespace. If no + // value is specified, the default is a private namespace. For more information, + // see PID settings + // (https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the Docker + // run reference. If the host PID mode is used, be aware that there is a heightened + // risk of undesired process namespace expose. For more information, see Docker + // security (https://docs.docker.com/engine/security/security/). This parameter is + // not supported for Windows containers or tasks using the Fargate launch type. + PidMode types.PidMode - // The number of CPU units used by the task. It can be expressed as an integer - // using CPU units, for example 1024, or as a string using vCPUs, for example 1 - // vCPU or 1 vcpu, in a task definition. String values are converted to an integer - // indicating the CPU units when the task definition is registered. Task-level CPU - // and memory parameters are ignored for Windows containers. We recommend - // specifying container-level resources for Windows containers. If you are using - // the EC2 launch type, this field is optional. Supported values are between 128 - // CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). If you are using the - // Fargate launch type, this field is required and you must use one of the - // following values, which determines your range of supported values for the memory - // parameter: - // - // * 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 - // (1 GB), 2048 (2 GB) - // - // * 512 (.5 vCPU) - Available memory values: 1024 (1 GB), - // 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - // - // * 1024 (1 vCPU) - Available memory - // values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 - // GB), 8192 (8 GB) - // - // * 2048 (2 vCPU) - Available memory values: Between 4096 (4 - // GB) and 16384 (16 GB) in increments of 1024 (1 GB) - // - // * 4096 (4 vCPU) - - // Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of - // 1024 (1 GB) - Cpu *string + // An array of placement constraint objects to use for the task. You can specify a + // maximum of 10 constraints per task (this limit includes constraints in the task + // definition and those specified at runtime). + PlacementConstraints []*types.TaskDefinitionPlacementConstraint // The configuration details for the App Mesh proxy. For tasks using the EC2 launch // type, the container instances require at least version 1.26.0 of the container @@ -284,6 +253,41 @@ type RegisterTaskDefinitionInput struct { // later. ProxyConfiguration *types.ProxyConfiguration + // The launch type required by the task. If no value is specified, it defaults to + // EC2. + RequiresCompatibilities []types.Compatibility + + // The metadata that you apply to the task definition to help you categorize and + // organize them. Each tag consists of a key and an optional value, both of which + // you define. The following basic restrictions apply to tags: + // + // * Maximum + // number of tags per resource - 50 + // + // * For each resource, each tag key must be + // unique, and each tag key can have only one value. + // + // * Maximum key length - + // 128 Unicode characters in UTF-8 + // + // * Maximum value length - 256 Unicode + // characters in UTF-8 + // + // * If your tagging schema is used across multiple + // services and resources, remember that other services may have restrictions on + // allowed characters. Generally allowed characters are: letters, numbers, and + // spaces representable in UTF-8, and the following characters: + - = . _ : / @. + // + // + // * Tag keys and values are case-sensitive. + // + // * Do not use aws:, AWS:, or any + // upper or lowercase combination of such as a prefix for either keys or values as + // it is reserved for AWS use. You cannot edit or delete tag keys or values with + // this prefix. Tags with this prefix do not count against your tags per resource + // limit. + Tags []*types.Tag + // The short name or full Amazon Resource Name (ARN) of the IAM role that // containers in this task can assume. All containers in this task are granted the // permissions that are specified in this role. For more information, see IAM Roles @@ -292,13 +296,9 @@ type RegisterTaskDefinitionInput struct { // in the Amazon Elastic Container Service Developer Guide. TaskRoleArn *string - // You must specify a family for a task definition, which allows you to track - // multiple versions of the same task definition. The family is used as a name for - // your task definition. Up to 255 letters (uppercase and lowercase), numbers, and - // hyphens are allowed. - // - // This member is required. - Family *string + // A list of volume definitions in JSON format that containers in your task may + // use. + Volumes []*types.Volume } type RegisterTaskDefinitionOutput struct { diff --git a/service/ecs/api_op_RunTask.go b/service/ecs/api_op_RunTask.go index 48c50e2b02d..57bde938985 100644 --- a/service/ecs/api_op_RunTask.go +++ b/service/ecs/api_op_RunTask.go @@ -82,46 +82,11 @@ func (c *Client) RunTask(ctx context.Context, params *RunTaskInput, optFns ...fu type RunTaskInput struct { - // The placement strategy objects to use for the task. You can specify a maximum of - // five strategy rules per task. - PlacementStrategy []*types.PlacementStrategy - - // Specifies whether to enable Amazon ECS managed tags for the task. For more - // information, see Tagging Your Amazon ECS Resources - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) - // in the Amazon Elastic Container Service Developer Guide. - EnableECSManagedTags *bool - - // The metadata that you apply to the task to help you categorize and organize - // them. Each tag consists of a key and an optional value, both of which you - // define. The following basic restrictions apply to tags: - // - // * Maximum number of - // tags per resource - 50 - // - // * For each resource, each tag key must be unique, - // and each tag key can have only one value. - // - // * Maximum key length - 128 - // Unicode characters in UTF-8 - // - // * Maximum value length - 256 Unicode characters - // in UTF-8 - // - // * If your tagging schema is used across multiple services and - // resources, remember that other services may have restrictions on allowed - // characters. Generally allowed characters are: letters, numbers, and spaces - // representable in UTF-8, and the following characters: + - = . _ : / @. - // - // * - // Tag keys and values are case-sensitive. + // The family and revision (family:revision) or full ARN of the task definition to + // run. If a revision is not specified, the latest ACTIVE revision is used. // - // * Do not use aws:, AWS:, or any - // upper or lowercase combination of such as a prefix for either keys or values as - // it is reserved for AWS use. You cannot edit or delete tag keys or values with - // this prefix. Tags with this prefix do not count against your tags per resource - // limit. - Tags []*types.Tag + // This member is required. + TaskDefinition *string // The capacity provider strategy to use for the task. A capacity provider strategy // consists of one or more capacity providers along with the base and weight to @@ -142,6 +107,24 @@ type RunTaskInput struct { // cluster is created. CapacityProviderStrategy []*types.CapacityProviderStrategyItem + // The short name or full Amazon Resource Name (ARN) of the cluster on which to run + // your task. If you do not specify a cluster, the default cluster is assumed. + Cluster *string + + // The number of instantiations of the specified task to place on your cluster. You + // can specify up to 10 tasks per call. + Count *int32 + + // Specifies whether to enable Amazon ECS managed tags for the task. For more + // information, see Tagging Your Amazon ECS Resources + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) + // in the Amazon Elastic Container Service Developer Guide. + EnableECSManagedTags *bool + + // The name of the task group to associate with the task. The default value is the + // family name of the task definition (for example, family:my-family-name). + Group *string + // The launch type on which to run your task. For more information, see Amazon ECS // Launch Types // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) @@ -149,12 +132,13 @@ type RunTaskInput struct { // specified, the capacityProviderStrategy parameter must be omitted. LaunchType types.LaunchType - // Specifies whether to propagate the tags from the task definition to the task. If - // no value is specified, the tags are not propagated. Tags can only be propagated - // to the task during task creation. To add tags to a task after task creation, use - // the TagResource () API action. An error will be received if you specify the - // SERVICE option when running a task. - PropagateTags types.PropagateTags + // The network configuration for the task. This parameter is required for task + // definitions that use the awsvpc network mode to receive their own elastic + // network interface, and it is not supported for other network modes. For more + // information, see Task Networking + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) + // in the Amazon Elastic Container Service Developer Guide. + NetworkConfiguration *types.NetworkConfiguration // A list of container overrides in JSON format that specify the name of a // container in the specified task definition and the overrides it should receive. @@ -166,45 +150,14 @@ type RunTaskInput struct { // limit includes the JSON formatting characters of the override structure. Overrides *types.TaskOverride - // The reference ID to use for the task. - ReferenceId *string - - // An optional tag specified when a task is started. For example, if you - // automatically trigger a task to run a batch process job, you could apply a - // unique identifier for that job to your task with the startedBy parameter. You - // can then identify which tasks belong to that job by filtering the results of a - // ListTasks () call with the startedBy value. Up to 36 letters (uppercase and - // lowercase), numbers, hyphens, and underscores are allowed. If a task is started - // by an Amazon ECS service, then the startedBy parameter contains the deployment - // ID of the service that starts it. - StartedBy *string - - // The network configuration for the task. This parameter is required for task - // definitions that use the awsvpc network mode to receive their own elastic - // network interface, and it is not supported for other network modes. For more - // information, see Task Networking - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) - // in the Amazon Elastic Container Service Developer Guide. - NetworkConfiguration *types.NetworkConfiguration - - // The short name or full Amazon Resource Name (ARN) of the cluster on which to run - // your task. If you do not specify a cluster, the default cluster is assumed. - Cluster *string - - // The name of the task group to associate with the task. The default value is the - // family name of the task definition (for example, family:my-family-name). - Group *string - // An array of placement constraint objects to use for the task. You can specify up // to 10 constraints per task (including constraints in the task definition and // those specified at runtime). PlacementConstraints []*types.PlacementConstraint - // The family and revision (family:revision) or full ARN of the task definition to - // run. If a revision is not specified, the latest ACTIVE revision is used. - // - // This member is required. - TaskDefinition *string + // The placement strategy objects to use for the task. You can specify a maximum of + // five strategy rules per task. + PlacementStrategy []*types.PlacementStrategy // The platform version the task should run. A platform version is only specified // for tasks using the Fargate launch type. If one is not specified, the LATEST @@ -214,20 +167,67 @@ type RunTaskInput struct { // in the Amazon Elastic Container Service Developer Guide. PlatformVersion *string - // The number of instantiations of the specified task to place on your cluster. You - // can specify up to 10 tasks per call. - Count *int32 + // Specifies whether to propagate the tags from the task definition to the task. If + // no value is specified, the tags are not propagated. Tags can only be propagated + // to the task during task creation. To add tags to a task after task creation, use + // the TagResource () API action. An error will be received if you specify the + // SERVICE option when running a task. + PropagateTags types.PropagateTags + + // The reference ID to use for the task. + ReferenceId *string + + // An optional tag specified when a task is started. For example, if you + // automatically trigger a task to run a batch process job, you could apply a + // unique identifier for that job to your task with the startedBy parameter. You + // can then identify which tasks belong to that job by filtering the results of a + // ListTasks () call with the startedBy value. Up to 36 letters (uppercase and + // lowercase), numbers, hyphens, and underscores are allowed. If a task is started + // by an Amazon ECS service, then the startedBy parameter contains the deployment + // ID of the service that starts it. + StartedBy *string + + // The metadata that you apply to the task to help you categorize and organize + // them. Each tag consists of a key and an optional value, both of which you + // define. The following basic restrictions apply to tags: + // + // * Maximum number of + // tags per resource - 50 + // + // * For each resource, each tag key must be unique, + // and each tag key can have only one value. + // + // * Maximum key length - 128 + // Unicode characters in UTF-8 + // + // * Maximum value length - 256 Unicode characters + // in UTF-8 + // + // * If your tagging schema is used across multiple services and + // resources, remember that other services may have restrictions on allowed + // characters. Generally allowed characters are: letters, numbers, and spaces + // representable in UTF-8, and the following characters: + - = . _ : / @. + // + // * + // Tag keys and values are case-sensitive. + // + // * Do not use aws:, AWS:, or any + // upper or lowercase combination of such as a prefix for either keys or values as + // it is reserved for AWS use. You cannot edit or delete tag keys or values with + // this prefix. Tags with this prefix do not count against your tags per resource + // limit. + Tags []*types.Tag } type RunTaskOutput struct { + // Any failures associated with the call. + Failures []*types.Failure + // A full description of the tasks that were run. The tasks that were successfully // placed on your cluster are described here. Tasks []*types.Task - // Any failures associated with the call. - Failures []*types.Failure - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ecs/api_op_StartTask.go b/service/ecs/api_op_StartTask.go index c6c76ccd064..22a1ef7011e 100644 --- a/service/ecs/api_op_StartTask.go +++ b/service/ecs/api_op_StartTask.go @@ -61,41 +61,38 @@ func (c *Client) StartTask(ctx context.Context, params *StartTaskInput, optFns . type StartTaskInput struct { + // The container instance IDs or full ARN entries for the container instances on + // which you would like to place your task. You can specify up to 10 container + // instances. + // + // This member is required. + ContainerInstances []*string + // The family and revision (family:revision) or full ARN of the task definition to // start. If a revision is not specified, the latest ACTIVE revision is used. // // This member is required. TaskDefinition *string + // The short name or full Amazon Resource Name (ARN) of the cluster on which to + // start your task. If you do not specify a cluster, the default cluster is + // assumed. + Cluster *string + // Specifies whether to enable Amazon ECS managed tags for the task. For more // information, see Tagging Your Amazon ECS Resources // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) // in the Amazon Elastic Container Service Developer Guide. EnableECSManagedTags *bool - // The short name or full Amazon Resource Name (ARN) of the cluster on which to - // start your task. If you do not specify a cluster, the default cluster is - // assumed. - Cluster *string + // The name of the task group to associate with the task. The default value is the + // family name of the task definition (for example, family:my-family-name). + Group *string // The VPC subnet and security group configuration for tasks that receive their own // elastic network interface by using the awsvpc networking mode. NetworkConfiguration *types.NetworkConfiguration - // Specifies whether to propagate the tags from the task definition or the service - // to the task. If no value is specified, the tags are not propagated. - PropagateTags types.PropagateTags - - // An optional tag specified when a task is started. For example, if you - // automatically trigger a task to run a batch process job, you could apply a - // unique identifier for that job to your task with the startedBy parameter. You - // can then identify which tasks belong to that job by filtering the results of a - // ListTasks () call with the startedBy value. Up to 36 letters (uppercase and - // lowercase), numbers, hyphens, and underscores are allowed. If a task is started - // by an Amazon ECS service, then the startedBy parameter contains the deployment - // ID of the service that starts it. - StartedBy *string - // A list of container overrides in JSON format that specify the name of a // container in the specified task definition and the overrides it should receive. // You can override the default command for a container (that is specified in the @@ -106,20 +103,23 @@ type StartTaskInput struct { // limit includes the JSON formatting characters of the override structure. Overrides *types.TaskOverride - // The container instance IDs or full ARN entries for the container instances on - // which you would like to place your task. You can specify up to 10 container - // instances. - // - // This member is required. - ContainerInstances []*string - - // The name of the task group to associate with the task. The default value is the - // family name of the task definition (for example, family:my-family-name). - Group *string + // Specifies whether to propagate the tags from the task definition or the service + // to the task. If no value is specified, the tags are not propagated. + PropagateTags types.PropagateTags // The reference ID to use for the task. ReferenceId *string + // An optional tag specified when a task is started. For example, if you + // automatically trigger a task to run a batch process job, you could apply a + // unique identifier for that job to your task with the startedBy parameter. You + // can then identify which tasks belong to that job by filtering the results of a + // ListTasks () call with the startedBy value. Up to 36 letters (uppercase and + // lowercase), numbers, hyphens, and underscores are allowed. If a task is started + // by an Amazon ECS service, then the startedBy parameter contains the deployment + // ID of the service that starts it. + StartedBy *string + // The metadata that you apply to the task to help you categorize and organize // them. Each tag consists of a key and an optional value, both of which you // define. The following basic restrictions apply to tags: diff --git a/service/ecs/api_op_StopTask.go b/service/ecs/api_op_StopTask.go index b78cce7dbcd..87f66c1126d 100644 --- a/service/ecs/api_op_StopTask.go +++ b/service/ecs/api_op_StopTask.go @@ -67,15 +67,15 @@ func (c *Client) StopTask(ctx context.Context, params *StopTaskInput, optFns ... type StopTaskInput struct { - // The short name or full Amazon Resource Name (ARN) of the cluster that hosts the - // task to stop. If you do not specify a cluster, the default cluster is assumed. - Cluster *string - // The task ID or full Amazon Resource Name (ARN) of the task to stop. // // This member is required. Task *string + // The short name or full Amazon Resource Name (ARN) of the cluster that hosts the + // task to stop. If you do not specify a cluster, the default cluster is assumed. + Cluster *string + // An optional message specified when a task is stopped. For example, if you are // using a custom scheduler, you can use this parameter to specify the reason for // stopping the task here, and the message appears in subsequent DescribeTasks () diff --git a/service/ecs/api_op_SubmitContainerStateChange.go b/service/ecs/api_op_SubmitContainerStateChange.go index c7313ac0904..f8212e41d41 100644 --- a/service/ecs/api_op_SubmitContainerStateChange.go +++ b/service/ecs/api_op_SubmitContainerStateChange.go @@ -57,30 +57,30 @@ func (c *Client) SubmitContainerStateChange(ctx context.Context, params *SubmitC type SubmitContainerStateChangeInput struct { - // The network bindings of the container. - NetworkBindings []*types.NetworkBinding + // The short name or full ARN of the cluster that hosts the container. + Cluster *string // The name of the container. ContainerName *string - // The reason for the state change request. - Reason *string + // The exit code returned for the state change request. + ExitCode *int32 - // The task ID or full Amazon Resource Name (ARN) of the task that hosts the - // container. - Task *string + // The network bindings of the container. + NetworkBindings []*types.NetworkBinding - // The short name or full ARN of the cluster that hosts the container. - Cluster *string + // The reason for the state change request. + Reason *string - // The exit code returned for the state change request. - ExitCode *int32 + // The ID of the Docker container. + RuntimeId *string // The status of the state change request. Status *string - // The ID of the Docker container. - RuntimeId *string + // The task ID or full Amazon Resource Name (ARN) of the task that hosts the + // container. + Task *string } type SubmitContainerStateChangeOutput struct { diff --git a/service/ecs/api_op_SubmitTaskStateChange.go b/service/ecs/api_op_SubmitTaskStateChange.go index 68e49f953e8..21c919b116b 100644 --- a/service/ecs/api_op_SubmitTaskStateChange.go +++ b/service/ecs/api_op_SubmitTaskStateChange.go @@ -59,24 +59,18 @@ func (c *Client) SubmitTaskStateChange(ctx context.Context, params *SubmitTaskSt type SubmitTaskStateChangeInput struct { - // The status of the state change request. - Status *string - - // The Unix timestamp for when the task execution stopped. - ExecutionStoppedAt *time.Time + // Any attachments associated with the state change request. + Attachments []*types.AttachmentStateChange // The short name or full Amazon Resource Name (ARN) of the cluster that hosts the // task. Cluster *string - // Any attachments associated with the state change request. - Attachments []*types.AttachmentStateChange - // Any containers associated with the state change request. Containers []*types.ContainerStateChange - // The reason for the state change request. - Reason *string + // The Unix timestamp for when the task execution stopped. + ExecutionStoppedAt *time.Time // The Unix timestamp for when the container image pull began. PullStartedAt *time.Time @@ -84,6 +78,12 @@ type SubmitTaskStateChangeInput struct { // The Unix timestamp for when the container image pull completed. PullStoppedAt *time.Time + // The reason for the state change request. + Reason *string + + // The status of the state change request. + Status *string + // The task ID or full ARN of the task in the state change request. Task *string } diff --git a/service/ecs/api_op_TagResource.go b/service/ecs/api_op_TagResource.go index b6e6104d103..d9f960fcfc6 100644 --- a/service/ecs/api_op_TagResource.go +++ b/service/ecs/api_op_TagResource.go @@ -60,6 +60,13 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { + // The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, + // the supported resources are Amazon ECS capacity providers, tasks, services, task + // definitions, clusters, and container instances. + // + // This member is required. + ResourceArn *string + // The tags to add to the resource. A tag is an array of key-value pairs. The // following basic restrictions apply to tags: // @@ -91,13 +98,6 @@ type TagResourceInput struct { // // This member is required. Tags []*types.Tag - - // The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, - // the supported resources are Amazon ECS capacity providers, tasks, services, task - // definitions, clusters, and container instances. - // - // This member is required. - ResourceArn *string } type TagResourceOutput struct { diff --git a/service/ecs/api_op_UntagResource.go b/service/ecs/api_op_UntagResource.go index 32a8f9d414a..79f374d8c7d 100644 --- a/service/ecs/api_op_UntagResource.go +++ b/service/ecs/api_op_UntagResource.go @@ -56,17 +56,17 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The keys of the tags to be removed. - // - // This member is required. - TagKeys []*string - // The Amazon Resource Name (ARN) of the resource from which to delete tags. // Currently, the supported resources are Amazon ECS capacity providers, tasks, // services, task definitions, clusters, and container instances. // // This member is required. ResourceArn *string + + // The keys of the tags to be removed. + // + // This member is required. + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/ecs/api_op_UpdateContainerInstancesState.go b/service/ecs/api_op_UpdateContainerInstancesState.go index d717950f005..6e858143bcb 100644 --- a/service/ecs/api_op_UpdateContainerInstancesState.go +++ b/service/ecs/api_op_UpdateContainerInstancesState.go @@ -98,6 +98,11 @@ func (c *Client) UpdateContainerInstancesState(ctx context.Context, params *Upda type UpdateContainerInstancesStateInput struct { + // A list of container instance IDs or full ARN entries. + // + // This member is required. + ContainerInstances []*string + // The container instance state with which to update the container instance. The // only valid values for this action are ACTIVE and DRAINING. A container instance // can only be updated to DRAINING status once it has reached an ACTIVE state. If a @@ -108,11 +113,6 @@ type UpdateContainerInstancesStateInput struct { // This member is required. Status types.ContainerInstanceStatus - // A list of container instance IDs or full ARN entries. - // - // This member is required. - ContainerInstances []*string - // The short name or full Amazon Resource Name (ARN) of the cluster that hosts the // container instance to update. If you do not specify a cluster, the default // cluster is assumed. diff --git a/service/ecs/api_op_UpdateService.go b/service/ecs/api_op_UpdateService.go index a3629582e87..38b9f9fcbe7 100644 --- a/service/ecs/api_op_UpdateService.go +++ b/service/ecs/api_op_UpdateService.go @@ -150,51 +150,10 @@ func (c *Client) UpdateService(ctx context.Context, params *UpdateServiceInput, type UpdateServiceInput struct { - // The family and revision (family:revision) or full ARN of the task definition to - // run in your service. If a revision is not specified, the latest ACTIVE revision - // is used. If you modify the task definition with UpdateService, Amazon ECS spawns - // a task with the new version of the task definition and then stops an old task - // after the new version is running. - TaskDefinition *string - - // The period of time, in seconds, that the Amazon ECS service scheduler should - // ignore unhealthy Elastic Load Balancing target health checks after a task has - // first started. This is only valid if your service is configured to use a load - // balancer. If your service's tasks take a while to start and respond to Elastic - // Load Balancing health checks, you can specify a health check grace period of up - // to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler - // ignores the Elastic Load Balancing health check status. This grace period can - // prevent the ECS service scheduler from marking tasks as unhealthy and stopping - // them before they have time to come up. - HealthCheckGracePeriodSeconds *int32 - - // The platform version on which your tasks in the service are running. A platform - // version is only specified for tasks using the Fargate launch type. If a platform - // version is not specified, the LATEST platform version is used by default. For - // more information, see AWS Fargate Platform Versions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) - // in the Amazon Elastic Container Service Developer Guide. - PlatformVersion *string - - // Whether to force a new deployment of the service. Deployments are not forced by - // default. You can use this option to trigger a new deployment with no service - // definition changes. For example, you can update a service's tasks to use a newer - // Docker image with the same image/tag combination (my_image:latest) or to roll - // Fargate tasks onto a newer platform version. - ForceNewDeployment *bool - - // An array of task placement constraint objects to update the service to use. If - // no value is specified, the existing placement constraints for the service will - // remain unchanged. If this value is specified, it will override any existing - // placement constraints defined for the service. To remove all existing placement - // constraints, specify an empty array. You can specify a maximum of 10 constraints - // per task (this limit includes constraints in the task definition and those - // specified at runtime). - PlacementConstraints []*types.PlacementConstraint - - // Optional deployment parameters that control how many tasks run during the - // deployment and the ordering of stopping and starting tasks. - DeploymentConfiguration *types.DeploymentConfiguration + // The name of the service to update. + // + // This member is required. + Service *string // The capacity provider strategy to update the service to use. If the service is // using the default capacity provider strategy for the cluster, the service can be @@ -217,9 +176,49 @@ type UpdateServiceInput struct { // cluster after the cluster is created. CapacityProviderStrategy []*types.CapacityProviderStrategyItem + // The short name or full Amazon Resource Name (ARN) of the cluster that your + // service is running on. If you do not specify a cluster, the default cluster is + // assumed. + Cluster *string + + // Optional deployment parameters that control how many tasks run during the + // deployment and the ordering of stopping and starting tasks. + DeploymentConfiguration *types.DeploymentConfiguration + + // The number of instantiations of the task to place and keep running in your + // service. + DesiredCount *int32 + + // Whether to force a new deployment of the service. Deployments are not forced by + // default. You can use this option to trigger a new deployment with no service + // definition changes. For example, you can update a service's tasks to use a newer + // Docker image with the same image/tag combination (my_image:latest) or to roll + // Fargate tasks onto a newer platform version. + ForceNewDeployment *bool + + // The period of time, in seconds, that the Amazon ECS service scheduler should + // ignore unhealthy Elastic Load Balancing target health checks after a task has + // first started. This is only valid if your service is configured to use a load + // balancer. If your service's tasks take a while to start and respond to Elastic + // Load Balancing health checks, you can specify a health check grace period of up + // to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler + // ignores the Elastic Load Balancing health check status. This grace period can + // prevent the ECS service scheduler from marking tasks as unhealthy and stopping + // them before they have time to come up. + HealthCheckGracePeriodSeconds *int32 + // An object representing the network configuration for a task or service. NetworkConfiguration *types.NetworkConfiguration + // An array of task placement constraint objects to update the service to use. If + // no value is specified, the existing placement constraints for the service will + // remain unchanged. If this value is specified, it will override any existing + // placement constraints defined for the service. To remove all existing placement + // constraints, specify an empty array. You can specify a maximum of 10 constraints + // per task (this limit includes constraints in the task definition and those + // specified at runtime). + PlacementConstraints []*types.PlacementConstraint + // The task placement strategy objects to update the service to use. If no value is // specified, the existing placement strategy for the service will remain // unchanged. If this value is specified, it will override the existing placement @@ -228,19 +227,20 @@ type UpdateServiceInput struct { // service. PlacementStrategy []*types.PlacementStrategy - // The short name or full Amazon Resource Name (ARN) of the cluster that your - // service is running on. If you do not specify a cluster, the default cluster is - // assumed. - Cluster *string - - // The number of instantiations of the task to place and keep running in your - // service. - DesiredCount *int32 + // The platform version on which your tasks in the service are running. A platform + // version is only specified for tasks using the Fargate launch type. If a platform + // version is not specified, the LATEST platform version is used by default. For + // more information, see AWS Fargate Platform Versions + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // in the Amazon Elastic Container Service Developer Guide. + PlatformVersion *string - // The name of the service to update. - // - // This member is required. - Service *string + // The family and revision (family:revision) or full ARN of the task definition to + // run in your service. If a revision is not specified, the latest ACTIVE revision + // is used. If you modify the task definition with UpdateService, Amazon ECS spawns + // a task with the new version of the task definition and then stops an old task + // after the new version is running. + TaskDefinition *string } type UpdateServiceOutput struct { diff --git a/service/ecs/api_op_UpdateServicePrimaryTaskSet.go b/service/ecs/api_op_UpdateServicePrimaryTaskSet.go index fc5ebdc4d57..6019b2d3ea6 100644 --- a/service/ecs/api_op_UpdateServicePrimaryTaskSet.go +++ b/service/ecs/api_op_UpdateServicePrimaryTaskSet.go @@ -62,6 +62,12 @@ func (c *Client) UpdateServicePrimaryTaskSet(ctx context.Context, params *Update type UpdateServicePrimaryTaskSetInput struct { + // The short name or full Amazon Resource Name (ARN) of the cluster that hosts the + // service that the task set exists in. + // + // This member is required. + Cluster *string + // The short name or full Amazon Resource Name (ARN) of the task set to set as the // primary task set in the deployment. // @@ -73,12 +79,6 @@ type UpdateServicePrimaryTaskSetInput struct { // // This member is required. Service *string - - // The short name or full Amazon Resource Name (ARN) of the cluster that hosts the - // service that the task set exists in. - // - // This member is required. - Cluster *string } type UpdateServicePrimaryTaskSetOutput struct { diff --git a/service/ecs/api_op_UpdateTaskSet.go b/service/ecs/api_op_UpdateTaskSet.go index 2c36710b62f..50ef5fad420 100644 --- a/service/ecs/api_op_UpdateTaskSet.go +++ b/service/ecs/api_op_UpdateTaskSet.go @@ -60,28 +60,28 @@ func (c *Client) UpdateTaskSet(ctx context.Context, params *UpdateTaskSetInput, type UpdateTaskSetInput struct { - // The short name or full Amazon Resource Name (ARN) of the task set to update. - // - // This member is required. - TaskSet *string - // The short name or full Amazon Resource Name (ARN) of the cluster that hosts the // service that the task set exists in. // // This member is required. Cluster *string + // A floating-point percentage of the desired number of tasks to place and keep + // running in the task set. + // + // This member is required. + Scale *types.Scale + // The short name or full Amazon Resource Name (ARN) of the service that the task // set exists in. // // This member is required. Service *string - // A floating-point percentage of the desired number of tasks to place and keep - // running in the task set. + // The short name or full Amazon Resource Name (ARN) of the task set to update. // // This member is required. - Scale *types.Scale + TaskSet *string } type UpdateTaskSetOutput struct { diff --git a/service/ecs/go.mod b/service/ecs/go.mod index f9bcc4f4e60..5ed15e1e746 100644 --- a/service/ecs/go.mod +++ b/service/ecs/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/ecs go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/ecs/types/types.go b/service/ecs/types/types.go index e865e7b023b..43c3f49f130 100644 --- a/service/ecs/types/types.go +++ b/service/ecs/types/types.go @@ -9,14 +9,14 @@ import ( // An object representing a container instance or task attachment. type Attachment struct { - // The unique identifier for the attachment. - Id *string - // Details of the attachment. For elastic network interfaces, this includes the // network interface ID, the MAC address, the subnet ID, and the private IPv4 // address. Details []*KeyValuePair + // The unique identifier for the attachment. + Id *string + // The status of the attachment. Valid values are PRECREATED, CREATED, ATTACHING, // ATTACHED, DETACHING, DETACHED, and DELETED. Status *string @@ -46,10 +46,11 @@ type AttachmentStateChange struct { // in the Amazon Elastic Container Service Developer Guide. type Attribute struct { - // The value of the attribute. Up to 128 letters (uppercase and lowercase), - // numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, - // and spaces are allowed. - Value *string + // The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, + // hyphens, underscores, and periods are allowed. + // + // This member is required. + Name *string // The ID of the target. You can specify the short form ID for a resource or the // full Amazon Resource Name (ARN). @@ -59,16 +60,23 @@ type Attribute struct { // required if you use the short form ID for a resource instead of the full ARN. TargetType TargetType - // The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, - // hyphens, underscores, and periods are allowed. - // - // This member is required. - Name *string + // The value of the attribute. Up to 128 letters (uppercase and lowercase), + // numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, + // and spaces are allowed. + Value *string } // The details of the Auto Scaling group for the capacity provider. type AutoScalingGroupProvider struct { + // The Amazon Resource Name (ARN) that identifies the Auto Scaling group. + // + // This member is required. + AutoScalingGroupArn *string + + // The managed scaling settings for the Auto Scaling group capacity provider. + ManagedScaling *ManagedScaling + // The managed termination protection setting to use for the Auto Scaling group // capacity provider. This determines whether the Auto Scaling group has managed // termination protection. When using managed termination protection, managed @@ -83,19 +91,18 @@ type AutoScalingGroupProvider struct { // disabled, your Amazon EC2 instances are not protected from termination when the // Auto Scaling group scales in. ManagedTerminationProtection ManagedTerminationProtection - - // The managed scaling settings for the Auto Scaling group capacity provider. - ManagedScaling *ManagedScaling - - // The Amazon Resource Name (ARN) that identifies the Auto Scaling group. - // - // This member is required. - AutoScalingGroupArn *string } // An object representing the networking details for a task or service. type AwsVpcConfiguration struct { + // The subnets associated with the task or service. There is a limit of 16 subnets + // that can be specified per AwsVpcConfiguration.

    All specified subnets + // must be from the same VPC.

     + // + // This member is required. + Subnets []*string + // Whether the task's elastic network interface receives a public IP address. The // default value is DISABLED. AssignPublicIp AssignPublicIp @@ -105,13 +112,6 @@ type AwsVpcConfiguration struct { // of 5 security groups that can be specified per AwsVpcConfiguration. //

    All specified security groups must be from the same VPC.

     SecurityGroups []*string - - // The subnets associated with the task or service. There is a limit of 16 subnets - // that can be specified per AwsVpcConfiguration.

    All specified subnets - // must be from the same VPC.

     - // - // This member is required. - Subnets []*string } // The details of a capacity provider. @@ -120,16 +120,16 @@ type CapacityProvider struct { // The Auto Scaling group settings for the capacity provider. AutoScalingGroupProvider *AutoScalingGroupProvider + // The Amazon Resource Name (ARN) that identifies the capacity provider. + CapacityProviderArn *string + // The name of the capacity provider. Name *string - // The update status of the capacity provider. The following are the possible - // states that will be returned. DELETE_IN_PROGRESS The capacity provider is in the - // process of being deleted. DELETE_COMPLETE The capacity provider has been - // successfully deleted and will have an INACTIVE status. DELETE_FAILED The - // capacity provider was unable to be deleted. The update status reason will - // provide further details about why the delete failed. - UpdateStatus CapacityProviderUpdateStatus + // The current status of the capacity provider. Only capacity providers in an + // ACTIVE state can be used in a cluster. When a capacity provider is successfully + // deleted, it will have an INACTIVE status. + Status CapacityProviderStatus // The metadata that you apply to the capacity provider to help you categorize and // organize it. Each tag consists of a key and an optional value, both of which you @@ -162,32 +162,22 @@ type CapacityProvider struct { // limit. Tags []*Tag + // The update status of the capacity provider. The following are the possible + // states that will be returned. DELETE_IN_PROGRESS The capacity provider is in the + // process of being deleted. DELETE_COMPLETE The capacity provider has been + // successfully deleted and will have an INACTIVE status. DELETE_FAILED The + // capacity provider was unable to be deleted. The update status reason will + // provide further details about why the delete failed. + UpdateStatus CapacityProviderUpdateStatus + // The update status reason. This provides further details about the update status // for the capacity provider. UpdateStatusReason *string - - // The current status of the capacity provider. Only capacity providers in an - // ACTIVE state can be used in a cluster. When a capacity provider is successfully - // deleted, it will have an INACTIVE status. - Status CapacityProviderStatus - - // The Amazon Resource Name (ARN) that identifies the capacity provider. - CapacityProviderArn *string } // The details of a capacity provider strategy. type CapacityProviderStrategyItem struct { - // The weight value designates the relative percentage of the total number of tasks - // launched that should use the specified capacity provider. For example, if you - // have a strategy that contains two capacity providers and both have a weight of - // 1, then when the base is satisfied, the tasks will be split evenly across the - // two capacity providers. Using that same logic, if you specify a weight of 1 for - // capacityProviderA and a weight of 4 for capacityProviderB, then for every one - // task that is run using capacityProviderA, four tasks would use - // capacityProviderB. - Weight *int32 - // The short name of the capacity provider. // // This member is required. @@ -197,6 +187,16 @@ type CapacityProviderStrategyItem struct { // capacity provider. Only one capacity provider in a capacity provider strategy // can have a base defined. Base *int32 + + // The weight value designates the relative percentage of the total number of tasks + // launched that should use the specified capacity provider. For example, if you + // have a strategy that contains two capacity providers and both have a weight of + // 1, then when the base is satisfied, the tasks will be split evenly across the + // two capacity providers. Using that same logic, if you specify a weight of 1 for + // capacityProviderA and a weight of 4 for capacityProviderB, then for every one + // task that is run using capacityProviderA, four tasks would use + // capacityProviderB. + Weight *int32 } // A regional grouping of one or more container instances on which you can run task @@ -205,6 +205,15 @@ type CapacityProviderStrategyItem struct { // more than one instance type simultaneously. type Cluster struct { + // The number of services that are running on the cluster in an ACTIVE state. You + // can view these services with ListServices (). + ActiveServicesCount *int32 + + // The resources attached to a cluster. When using a capacity provider with a + // cluster, the Auto Scaling plan that is created will be returned as a cluster + // attachment. + Attachments []*Attachment + // The status of the capacity providers associated with the cluster. The following // are the states that will be returned: UPDATE_IN_PROGRESS The available capacity // providers for the cluster are updating. This occurs when the Auto Scaling plan @@ -212,6 +221,18 @@ type Cluster struct { // successfully updated. UPDATE_FAILED The capacity provider updates failed. AttachmentsStatus *string + // The capacity providers associated with the cluster. + CapacityProviders []*string + + // The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the + // arn:aws:ecs namespace, followed by the Region of the cluster, the AWS account ID + // of the cluster owner, the cluster namespace, and then the cluster name. For + // example, arn:aws:ecs:region:012345678910:cluster/test. + ClusterArn *string + + // A user-generated string that you use to identify your cluster. + ClusterName *string + // The default capacity provider strategy for the cluster. When services or tasks // are run in the cluster with no launch type or capacity provider strategy // specified, the default capacity provider strategy is used. @@ -220,18 +241,17 @@ type Cluster struct { // The number of tasks in the cluster that are in the PENDING state. PendingTasksCount *int32 - // The settings for the cluster. This parameter indicates whether CloudWatch - // Container Insights is enabled or disabled for a cluster. - Settings []*ClusterSetting - - // The resources attached to a cluster. When using a capacity provider with a - // cluster, the Auto Scaling plan that is created will be returned as a cluster - // attachment. - Attachments []*Attachment + // The number of container instances registered into the cluster. This includes + // container instances in both ACTIVE and DRAINING status. + RegisteredContainerInstancesCount *int32 // The number of tasks in the cluster that are in the RUNNING state. RunningTasksCount *int32 + // The settings for the cluster. This parameter indicates whether CloudWatch + // Container Insights is enabled or disabled for a cluster. + Settings []*ClusterSetting + // Additional information about your clusters that are separated by launch type, // including: // @@ -255,6 +275,20 @@ type Cluster struct { // * drainingFargateServiceCount Statistics []*KeyValuePair + // The status of the cluster. The following are the possible states that will be + // returned. ACTIVE The cluster is ready to accept tasks and if applicable you can + // register container instances with the cluster. PROVISIONING The cluster has + // capacity providers associated with it and the resources needed for the capacity + // provider are being created. DEPROVISIONING The cluster has capacity providers + // associated with it and the resources needed for the capacity provider are being + // deleted. FAILED The cluster has capacity providers associated with it and the + // resources needed for the capacity provider have failed to create. INACTIVE The + // cluster has been deleted. Clusters with an INACTIVE status may remain + // discoverable in your account for a period of time. However, this behavior is + // subject to change in the future, so you should not rely on INACTIVE clusters + // persisting. + Status *string + // The metadata that you apply to the cluster to help you categorize and organize // them. Each tag consists of a key and an optional value, both of which you // define. The following basic restrictions apply to tags: @@ -285,40 +319,6 @@ type Cluster struct { // this prefix. Tags with this prefix do not count against your tags per resource // limit. Tags []*Tag - - // The status of the cluster. The following are the possible states that will be - // returned. ACTIVE The cluster is ready to accept tasks and if applicable you can - // register container instances with the cluster. PROVISIONING The cluster has - // capacity providers associated with it and the resources needed for the capacity - // provider are being created. DEPROVISIONING The cluster has capacity providers - // associated with it and the resources needed for the capacity provider are being - // deleted. FAILED The cluster has capacity providers associated with it and the - // resources needed for the capacity provider have failed to create. INACTIVE The - // cluster has been deleted. Clusters with an INACTIVE status may remain - // discoverable in your account for a period of time. However, this behavior is - // subject to change in the future, so you should not rely on INACTIVE clusters - // persisting. - Status *string - - // The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the - // arn:aws:ecs namespace, followed by the Region of the cluster, the AWS account ID - // of the cluster owner, the cluster namespace, and then the cluster name. For - // example, arn:aws:ecs:region:012345678910:cluster/test. - ClusterArn *string - - // The capacity providers associated with the cluster. - CapacityProviders []*string - - // The number of services that are running on the cluster in an ACTIVE state. You - // can view these services with ListServices (). - ActiveServicesCount *int32 - - // A user-generated string that you use to identify your cluster. - ClusterName *string - - // The number of container instances registered into the cluster. This includes - // container instances in both ACTIVE and DRAINING status. - RegisteredContainerInstancesCount *int32 } // The settings to use when creating a cluster. This parameter is used to enable @@ -340,37 +340,27 @@ type ClusterSetting struct { // A Docker container that is part of a task. type Container struct { - // A short (255 max characters) human-readable string to provide additional details - // about a running or stopped container. - Reason *string + // The Amazon Resource Name (ARN) of the container. + ContainerArn *string - // The name of the container. - Name *string + // The number of CPU units set for the container. The value will be 0 if no value + // was specified in the container definition when the task definition was + // registered. + Cpu *string // The exit code returned from the container. ExitCode *int32 - // The ID of the Docker container. - RuntimeId *string - - // The soft limit (in MiB) of memory set for the container. - MemoryReservation *string - - // The network bindings associated with the container. - NetworkBindings []*NetworkBinding + // The IDs of each GPU assigned to the container. + GpuIds []*string - // The ARN of the task. - TaskArn *string + // The health status of the container. If health checks are not configured for this + // container in its task definition, then it reports the health status as UNKNOWN. + HealthStatus HealthStatus // The image used for the container. Image *string - // The network interfaces associated with the container. - NetworkInterfaces []*NetworkInterface - - // The IDs of each GPU assigned to the container. - GpuIds []*string - // The container image manifest digest. The imageDigest is only returned if the // container is using an image hosted in Amazon ECR, otherwise it is omitted. ImageDigest *string @@ -378,59 +368,36 @@ type Container struct { // The last known status of the container. LastStatus *string - // The Amazon Resource Name (ARN) of the container. - ContainerArn *string + // The hard limit (in MiB) of memory set for the container. + Memory *string - // The health status of the container. If health checks are not configured for this - // container in its task definition, then it reports the health status as UNKNOWN. - HealthStatus HealthStatus + // The soft limit (in MiB) of memory set for the container. + MemoryReservation *string - // The number of CPU units set for the container. The value will be 0 if no value - // was specified in the container definition when the task definition was - // registered. - Cpu *string + // The name of the container. + Name *string - // The hard limit (in MiB) of memory set for the container. - Memory *string + // The network bindings associated with the container. + NetworkBindings []*NetworkBinding + + // The network interfaces associated with the container. + NetworkInterfaces []*NetworkInterface + + // A short (255 max characters) human-readable string to provide additional details + // about a running or stopped container. + Reason *string + + // The ID of the Docker container. + RuntimeId *string + + // The ARN of the task. + TaskArn *string } // Container definitions are used in task definitions to describe the different // containers that are launched as part of a task. type ContainerDefinition struct { - // The image used to start a container. This string is passed directly to the - // Docker daemon. Images in the Docker Hub registry are available by default. Other - // repositories are specified with either repository-url/image:tag or - // repository-url/image@digest . Up to 255 letters (uppercase and lowercase), - // numbers, hyphens, underscores, colons, periods, forward slashes, and number - // signs are allowed. This parameter maps to Image in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the IMAGE - // parameter of docker run (https://docs.docker.com/engine/reference/run/). - // - // * - // When a new task starts, the Amazon ECS container agent pulls the latest version - // of the specified image and tag for the container to use. However, subsequent - // updates to a repository image are not propagated to already running tasks. - // - // - // * Images in Amazon ECR repositories can be specified by either using the full - // registry/repository:tag or registry/repository@digest. For example, - // 012345678910.dkr.ecr..amazonaws.com/:latest or - // 012345678910.dkr.ecr..amazonaws.com/@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE. - // - // - // * Images in official repositories on Docker Hub use a single name (for example, - // ubuntu or mongo). - // - // * Images in other repositories on Docker Hub are - // qualified with an organization name (for example, amazon/amazon-ecs-agent). - // - // - // * Images in other online repositories are qualified further by a domain name - // (for example, quay.io/assemblyline/ubuntu). - Image *string - // The command that is passed to the container. This parameter maps to Cmd in the // Create a container // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of @@ -441,139 +408,6 @@ type ContainerDefinition struct { // arguments, each argument should be a separated string in the array. Command []*string - // A key/value map of labels to add to the container. This parameter maps to Labels - // in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --label option to docker run (https://docs.docker.com/engine/reference/run/). - // This parameter requires version 1.18 of the Docker Remote API or greater on your - // container instance. To check the Docker Remote API version on your container - // instance, log in to your container instance and run the following command: sudo - // docker version --format '{{.Server.APIVersion}}' - DockerLabels map[string]*string - - // If the essential parameter of a container is marked as true, and that container - // fails or stops for any reason, all other containers that are part of the task - // are stopped. If the essential parameter of a container is marked as false, then - // its failure does not affect the rest of the containers in a task. If this - // parameter is omitted, a container is assumed to be essential. All tasks must - // have at least one essential container. If you have an application that is - // composed of multiple containers, you should group containers that are used for a - // common purpose into components, and separate the different components into - // multiple task definitions. For more information, see Application Architecture - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html) - // in the Amazon Elastic Container Service Developer Guide. - Essential *bool - - // Linux-specific modifications that are applied to the container, such as Linux - // kernel capabilities. For more information see KernelCapabilities (). This - // parameter is not supported for Windows containers. - LinuxParameters *LinuxParameters - - // The private repository authentication credentials to use. - RepositoryCredentials *RepositoryCredentials - - // A list of namespaced kernel parameters to set in the container. This parameter - // maps to Sysctls in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --sysctl option to docker run (https://docs.docker.com/engine/reference/run/). - // It is not recommended that you specify network-related systemControls parameters - // for multiple containers in a single task that also uses either the awsvpc or - // host network modes. For tasks that use the awsvpc network mode, the container - // that is started last determines which systemControls parameters take effect. For - // tasks that use the host network mode, it changes the container instance's - // namespaced kernel parameters as well as the containers. - SystemControls []*SystemControl - - // The log configuration specification for the container. This parameter maps to - // LogConfig in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --log-driver option to docker run - // (https://docs.docker.com/engine/reference/run/). By default, containers use the - // same logging driver that the Docker daemon uses. However the container may use a - // different logging driver than the Docker daemon by specifying a log driver with - // this parameter in the container definition. To use a different logging driver - // for a container, the log system must be configured properly on the container - // instance (or on a different log server for remote logging options). For more - // information on the options for different supported log drivers, see Configure - // logging drivers (https://docs.docker.com/engine/admin/logging/overview/) in the - // Docker documentation. Amazon ECS currently supports a subset of the logging - // drivers available to the Docker daemon (shown in the LogConfiguration () data - // type). Additional log drivers may be available in future releases of the Amazon - // ECS container agent. This parameter requires version 1.18 of the Docker Remote - // API or greater on your container instance. To check the Docker Remote API - // version on your container instance, log in to your container instance and run - // the following command: sudo docker version --format '{{.Server.APIVersion}}' The - // Amazon ECS container agent running on a container instance must register the - // logging drivers available on that instance with the - // ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on - // that instance can use these log configuration options. For more information, see - // Amazon ECS Container Agent Configuration - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) - // in the Amazon Elastic Container Service Developer Guide. - LogConfiguration *LogConfiguration - - // A list of strings to provide custom labels for SELinux and AppArmor multi-level - // security systems. This field is not valid for containers in tasks using the - // Fargate launch type. With Windows containers, this parameter can be used to - // reference a credential spec file when configuring a container for Active - // Directory authentication. For more information, see Using gMSAs for Windows - // Containers - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) - // in the Amazon Elastic Container Service Developer Guide. This parameter maps to - // SecurityOpt in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --security-opt option to docker run - // (https://docs.docker.com/engine/reference/run/). The Amazon ECS container agent - // running on a container instance must register with the ECS_SELINUX_CAPABLE=true - // or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on - // that instance can use these security options. For more information, see Amazon - // ECS Container Agent Configuration - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) - // in the Amazon Elastic Container Service Developer Guide. - DockerSecurityOptions []*string - - // The dependencies defined for container startup and shutdown. A container can - // contain multiple dependencies. When a dependency is defined for container - // startup, for container shutdown it is reversed. For tasks using the EC2 launch - // type, the container instances require at least version 1.26.0 of the container - // agent to enable container dependencies. However, we recommend using the latest - // container agent version. For information about checking your agent version and - // updating to the latest version, see Updating the Amazon ECS Container Agent - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) - // in the Amazon Elastic Container Service Developer Guide. If you are using an - // Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of - // the ecs-init package. If your container instances are launched from version - // 20190301 or later, then they contain the required versions of the container - // agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) - // in the Amazon Elastic Container Service Developer Guide. For tasks using the - // Fargate launch type, the task or service requires platform version 1.3.0 or - // later. - DependsOn []*ContainerDependency - - // A list of files containing the environment variables to pass to a container. - // This parameter maps to the --env-file option to docker run - // (https://docs.docker.com/engine/reference/run/). You can specify up to ten - // environment files. The file must have a .env file extension. Each line in an - // environment file should contain an environment variable in VARIABLE=VALUE - // format. Lines beginning with # are treated as comments and are ignored. For more - // information on the environment variable file syntax, see Declare default - // environment variables in file (https://docs.docker.com/compose/env-file/). If - // there are environment variables specified using the environment parameter in a - // container definition, they take precedence over the variables contained within - // an environment file. If multiple environment files are specified that contain - // the same variable, they are processed from the top down. It is recommended to - // use unique variable names. For more information, see Specifying Environment - // Variables - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) - // in the Amazon Elastic Container Service Developer Guide. This field is not valid - // for containers in tasks using the Fargate launch type. - EnvironmentFiles []*EnvironmentFile - // The number of cpu units reserved for the container. This parameter maps to // CpuShares in the Create a container // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of @@ -619,22 +453,93 @@ type ContainerDefinition struct { // definition. Cpu *int32 - // The container health check command and associated configuration parameters for - // the container. This parameter maps to HealthCheck in the Create a container + // The dependencies defined for container startup and shutdown. A container can + // contain multiple dependencies. When a dependency is defined for container + // startup, for container shutdown it is reversed. For tasks using the EC2 launch + // type, the container instances require at least version 1.26.0 of the container + // agent to enable container dependencies. However, we recommend using the latest + // container agent version. For information about checking your agent version and + // updating to the latest version, see Updating the Amazon ECS Container Agent + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) + // in the Amazon Elastic Container Service Developer Guide. If you are using an + // Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of + // the ecs-init package. If your container instances are launched from version + // 20190301 or later, then they contain the required versions of the container + // agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) + // in the Amazon Elastic Container Service Developer Guide. For tasks using the + // Fargate launch type, the task or service requires platform version 1.3.0 or + // later. + DependsOn []*ContainerDependency + + // When this parameter is true, networking is disabled within the container. This + // parameter maps to NetworkDisabled in the Create a container // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // HEALTHCHECK parameter of docker run - // (https://docs.docker.com/engine/reference/run/). - HealthCheck *HealthCheck + // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/). This + // parameter is not supported for Windows containers. + DisableNetworking *bool - // When this parameter is true, the container is given read-only access to its root - // file system. This parameter maps to ReadonlyRootfs in the Create a container + // A list of DNS search domains that are presented to the container. This parameter + // maps to DnsSearch in the Create a container // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --read-only option to docker run + // --dns-search option to docker run // (https://docs.docker.com/engine/reference/run/). This parameter is not supported // for Windows containers. - ReadonlyRootFilesystem *bool + DnsSearchDomains []*string + + // A list of DNS servers that are presented to the container. This parameter maps + // to Dns in the Create a container + // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of + // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the --dns + // option to docker run (https://docs.docker.com/engine/reference/run/). This + // parameter is not supported for Windows containers. + DnsServers []*string + + // A key/value map of labels to add to the container. This parameter maps to Labels + // in the Create a container + // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of + // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the + // --label option to docker run (https://docs.docker.com/engine/reference/run/). + // This parameter requires version 1.18 of the Docker Remote API or greater on your + // container instance. To check the Docker Remote API version on your container + // instance, log in to your container instance and run the following command: sudo + // docker version --format '{{.Server.APIVersion}}' + DockerLabels map[string]*string + + // A list of strings to provide custom labels for SELinux and AppArmor multi-level + // security systems. This field is not valid for containers in tasks using the + // Fargate launch type. With Windows containers, this parameter can be used to + // reference a credential spec file when configuring a container for Active + // Directory authentication. For more information, see Using gMSAs for Windows + // Containers + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) + // in the Amazon Elastic Container Service Developer Guide. This parameter maps to + // SecurityOpt in the Create a container + // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of + // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the + // --security-opt option to docker run + // (https://docs.docker.com/engine/reference/run/). The Amazon ECS container agent + // running on a container instance must register with the ECS_SELINUX_CAPABLE=true + // or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on + // that instance can use these security options. For more information, see Amazon + // ECS Container Agent Configuration + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) + // in the Amazon Elastic Container Service Developer Guide. + DockerSecurityOptions []*string + + // Early versions of the Amazon ECS container agent do not properly handle + // entryPoint parameters. If you have problems using entryPoint, update your + // container agent or enter your commands and arguments as command array items + // instead. The entry point that is passed to the container. This parameter maps to + // Entrypoint in the Create a container + // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of + // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the + // --entrypoint option to docker run + // (https://docs.docker.com/engine/reference/run/). For more information, see + // https://docs.docker.com/engine/reference/builder/#entrypoint + // (https://docs.docker.com/engine/reference/builder/#entrypoint). + EntryPoint []*string // The environment variables to pass to a container. This parameter maps to Env in // the Create a container @@ -645,136 +550,163 @@ type ContainerDefinition struct { // as credential data. Environment []*KeyValuePair - // When this parameter is true, the container is given elevated privileges on the - // host container instance (similar to the root user). This parameter maps to - // Privileged in the Create a container + // A list of files containing the environment variables to pass to a container. + // This parameter maps to the --env-file option to docker run + // (https://docs.docker.com/engine/reference/run/). You can specify up to ten + // environment files. The file must have a .env file extension. Each line in an + // environment file should contain an environment variable in VARIABLE=VALUE + // format. Lines beginning with # are treated as comments and are ignored. For more + // information on the environment variable file syntax, see Declare default + // environment variables in file (https://docs.docker.com/compose/env-file/). If + // there are environment variables specified using the environment parameter in a + // container definition, they take precedence over the variables contained within + // an environment file. If multiple environment files are specified that contain + // the same variable, they are processed from the top down. It is recommended to + // use unique variable names. For more information, see Specifying Environment + // Variables + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) + // in the Amazon Elastic Container Service Developer Guide. This field is not valid + // for containers in tasks using the Fargate launch type. + EnvironmentFiles []*EnvironmentFile + + // If the essential parameter of a container is marked as true, and that container + // fails or stops for any reason, all other containers that are part of the task + // are stopped. If the essential parameter of a container is marked as false, then + // its failure does not affect the rest of the containers in a task. If this + // parameter is omitted, a container is assumed to be essential. All tasks must + // have at least one essential container. If you have an application that is + // composed of multiple containers, you should group containers that are used for a + // common purpose into components, and separate the different components into + // multiple task definitions. For more information, see Application Architecture + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html) + // in the Amazon Elastic Container Service Developer Guide. + Essential *bool + + // A list of hostnames and IP address mappings to append to the /etc/hosts file on + // the container. This parameter maps to ExtraHosts in the Create a container // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --privileged option to docker run - // (https://docs.docker.com/engine/reference/run/). This parameter is not supported - // for Windows containers or tasks using the Fargate launch type. - Privileged *bool + // --add-host option to docker run (https://docs.docker.com/engine/reference/run/). + // This parameter is not supported for Windows containers or tasks that use the + // awsvpc network mode. + ExtraHosts []*HostEntry - // The user name to use inside the container. This parameter maps to User in the + // The FireLens configuration for the container. This is used to specify and + // configure a log router for container logs. For more information, see Custom Log + // Routing + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) + // in the Amazon Elastic Container Service Developer Guide. + FirelensConfiguration *FirelensConfiguration + + // The container health check command and associated configuration parameters for + // the container. This parameter maps to HealthCheck in the Create a container + // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of + // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the + // HEALTHCHECK parameter of docker run + // (https://docs.docker.com/engine/reference/run/). + HealthCheck *HealthCheck + + // The hostname to use for your container. This parameter maps to Hostname in the // Create a container // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the --user - // option to docker run (https://docs.docker.com/engine/reference/run/). You can - // use the following formats. If specifying a UID or GID, you must specify it as a - // positive integer. + // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the + // --hostname option to docker run (https://docs.docker.com/engine/reference/run/). + // The hostname parameter is not supported if you are using the awsvpc network + // mode. + Hostname *string + + // The image used to start a container. This string is passed directly to the + // Docker daemon. Images in the Docker Hub registry are available by default. Other + // repositories are specified with either repository-url/image:tag or + // repository-url/image@digest . Up to 255 letters (uppercase and lowercase), + // numbers, hyphens, underscores, colons, periods, forward slashes, and number + // signs are allowed. This parameter maps to Image in the Create a container + // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of + // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the IMAGE + // parameter of docker run (https://docs.docker.com/engine/reference/run/). // - // * user + // * + // When a new task starts, the Amazon ECS container agent pulls the latest version + // of the specified image and tag for the container to use. However, subsequent + // updates to a repository image are not propagated to already running tasks. // - // * user:group // - // * uid + // * Images in Amazon ECR repositories can be specified by either using the full + // registry/repository:tag or registry/repository@digest. For example, + // 012345678910.dkr.ecr..amazonaws.com/:latest or + // 012345678910.dkr.ecr..amazonaws.com/@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE. // - // * uid:gid // - // * - // user:gid + // * Images in official repositories on Docker Hub use a single name (for example, + // ubuntu or mongo). // - // * uid:group + // * Images in other repositories on Docker Hub are + // qualified with an organization name (for example, amazon/amazon-ecs-agent). // - // This parameter is not supported for Windows - // containers. - User *string - - // The secrets to pass to the container. For more information, see Specifying - // Sensitive Data - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) - // in the Amazon Elastic Container Service Developer Guide. - Secrets []*Secret - - // The mount points for data volumes in your container. This parameter maps to - // Volumes in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --volume option to docker run (https://docs.docker.com/engine/reference/run/). - // Windows containers can mount whole directories on the same drive as - // $env:ProgramData. Windows containers cannot mount directories on a different - // drive, and mount point cannot be across drives. - MountPoints []*MountPoint - - // The name of a container. If you are linking multiple containers together in a - // task definition, the name of one container can be entered in the links of - // another container to connect the containers. Up to 255 letters (uppercase and - // lowercase), numbers, and hyphens are allowed. This parameter maps to name in the - // Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the --name - // option to docker run (https://docs.docker.com/engine/reference/run/). - Name *string + // + // * Images in other online repositories are qualified further by a domain name + // (for example, quay.io/assemblyline/ubuntu). + Image *string - // Data volumes to mount from another container. This parameter maps to VolumesFrom - // in the Create a container + // When this parameter is true, this allows you to deploy containerized + // applications that require stdin or a tty to be allocated. This parameter maps to + // OpenStdin in the Create a container // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --volumes-from option to docker run + // --interactive option to docker run // (https://docs.docker.com/engine/reference/run/). - VolumesFrom []*VolumeFrom - - // The working directory in which to run commands inside the container. This - // parameter maps to WorkingDir in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --workdir option to docker run (https://docs.docker.com/engine/reference/run/). - WorkingDirectory *string + Interactive *bool - // The soft limit (in MiB) of memory to reserve for the container. When system - // memory is under heavy contention, Docker attempts to keep the container memory - // to this soft limit. However, your container can consume more memory when it - // needs to, up to either the hard limit specified with the memory parameter (if - // applicable), or all of the available memory on the container instance, whichever - // comes first. This parameter maps to MemoryReservation in the Create a container + // The links parameter allows containers to communicate with each other without the + // need for port mappings. This parameter is only supported if the network mode of + // a task definition is bridge. The name:internalName construct is analogous to + // name:alias in Docker links. Up to 255 letters (uppercase and lowercase), + // numbers, and hyphens are allowed. For more information about linking Docker + // containers, go to Legacy container links + // (https://docs.docker.com/network/links/) in the Docker documentation. This + // parameter maps to Links in the Create a container // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --memory-reservation option to docker run - // (https://docs.docker.com/engine/reference/run/). If a task-level memory value is - // not specified, you must specify a non-zero integer for one or both of memory or - // memoryReservation in a container definition. If you specify both, memory must be - // greater than memoryReservation. If you specify memoryReservation, then that - // value is subtracted from the available memory resources for the container - // instance on which the container is placed. Otherwise, the value of memory is - // used. For example, if your container normally uses 128 MiB of memory, but - // occasionally bursts to 256 MiB of memory for short periods of time, you can set - // a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This - // configuration would allow the container to only reserve 128 MiB of memory from - // the remaining resources on the container instance, but also allow the container - // to consume more memory resources when needed. The Docker daemon reserves a - // minimum of 4 MiB of memory for a container, so you should not specify fewer than - // 4 MiB of memory for your containers. - MemoryReservation *int32 + // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the --link + // option to docker run (https://docs.docker.com/engine/reference/run/). This + // parameter is not supported for Windows containers. Containers that are + // collocated on a single container instance may be able to communicate with each + // other without requiring links or host port mappings. Network isolation is + // achieved on the container instance using security groups and VPC settings. + Links []*string - // A list of DNS search domains that are presented to the container. This parameter - // maps to DnsSearch in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --dns-search option to docker run - // (https://docs.docker.com/engine/reference/run/). This parameter is not supported - // for Windows containers. - DnsSearchDomains []*string + // Linux-specific modifications that are applied to the container, such as Linux + // kernel capabilities. For more information see KernelCapabilities (). This + // parameter is not supported for Windows containers. + LinuxParameters *LinuxParameters - // The list of port mappings for the container. Port mappings allow containers to - // access ports on the host container instance to send or receive traffic. For task - // definitions that use the awsvpc network mode, you should only specify the - // containerPort. The hostPort can be left blank or it must be the same value as - // the containerPort. Port mappings on Windows use the NetNAT gateway address - // rather than localhost. There is no loopback for port mappings on Windows, so you - // cannot access a container's mapped port from the host itself. This parameter - // maps to PortBindings in the Create a container + // The log configuration specification for the container. This parameter maps to + // LogConfig in the Create a container // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --publish option to docker run (https://docs.docker.com/engine/reference/run/). - // If the network mode of a task definition is set to none, then you can't specify - // port mappings. If the network mode of a task definition is set to host, then - // host ports must either be undefined or they must match the container port in the - // port mapping. After a task reaches the RUNNING status, manual and automatic host - // and container port assignments are visible in the Network Bindings section of a - // container description for a selected task in the Amazon ECS console. The - // assignments are also visible in the networkBindings section DescribeTasks () - // responses. - PortMappings []*PortMapping + // --log-driver option to docker run + // (https://docs.docker.com/engine/reference/run/). By default, containers use the + // same logging driver that the Docker daemon uses. However the container may use a + // different logging driver than the Docker daemon by specifying a log driver with + // this parameter in the container definition. To use a different logging driver + // for a container, the log system must be configured properly on the container + // instance (or on a different log server for remote logging options). For more + // information on the options for different supported log drivers, see Configure + // logging drivers (https://docs.docker.com/engine/admin/logging/overview/) in the + // Docker documentation. Amazon ECS currently supports a subset of the logging + // drivers available to the Docker daemon (shown in the LogConfiguration () data + // type). Additional log drivers may be available in future releases of the Amazon + // ECS container agent. This parameter requires version 1.18 of the Docker Remote + // API or greater on your container instance. To check the Docker Remote API + // version on your container instance, log in to your container instance and run + // the following command: sudo docker version --format '{{.Server.APIVersion}}' The + // Amazon ECS container agent running on a container instance must register the + // logging drivers available on that instance with the + // ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on + // that instance can use these log configuration options. For more information, see + // Amazon ECS Container Agent Configuration + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) + // in the Amazon Elastic Container Service Developer Guide. + LogConfiguration *LogConfiguration // The amount (in MiB) of memory to present to the container. If your container // attempts to exceed the memory specified here, the container is killed. The total @@ -795,57 +727,81 @@ type ContainerDefinition struct { // memory for your containers. Memory *int32 - // Early versions of the Amazon ECS container agent do not properly handle - // entryPoint parameters. If you have problems using entryPoint, update your - // container agent or enter your commands and arguments as command array items - // instead. The entry point that is passed to the container. This parameter maps to - // Entrypoint in the Create a container + // The soft limit (in MiB) of memory to reserve for the container. When system + // memory is under heavy contention, Docker attempts to keep the container memory + // to this soft limit. However, your container can consume more memory when it + // needs to, up to either the hard limit specified with the memory parameter (if + // applicable), or all of the available memory on the container instance, whichever + // comes first. This parameter maps to MemoryReservation in the Create a container // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --entrypoint option to docker run - // (https://docs.docker.com/engine/reference/run/). For more information, see - // https://docs.docker.com/engine/reference/builder/#entrypoint - // (https://docs.docker.com/engine/reference/builder/#entrypoint). - EntryPoint []*string + // --memory-reservation option to docker run + // (https://docs.docker.com/engine/reference/run/). If a task-level memory value is + // not specified, you must specify a non-zero integer for one or both of memory or + // memoryReservation in a container definition. If you specify both, memory must be + // greater than memoryReservation. If you specify memoryReservation, then that + // value is subtracted from the available memory resources for the container + // instance on which the container is placed. Otherwise, the value of memory is + // used. For example, if your container normally uses 128 MiB of memory, but + // occasionally bursts to 256 MiB of memory for short periods of time, you can set + // a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This + // configuration would allow the container to only reserve 128 MiB of memory from + // the remaining resources on the container instance, but also allow the container + // to consume more memory resources when needed. The Docker daemon reserves a + // minimum of 4 MiB of memory for a container, so you should not specify fewer than + // 4 MiB of memory for your containers. + MemoryReservation *int32 - // When this parameter is true, this allows you to deploy containerized - // applications that require stdin or a tty to be allocated. This parameter maps to - // OpenStdin in the Create a container + // The mount points for data volumes in your container. This parameter maps to + // Volumes in the Create a container // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --interactive option to docker run - // (https://docs.docker.com/engine/reference/run/). - Interactive *bool + // --volume option to docker run (https://docs.docker.com/engine/reference/run/). + // Windows containers can mount whole directories on the same drive as + // $env:ProgramData. Windows containers cannot mount directories on a different + // drive, and mount point cannot be across drives. + MountPoints []*MountPoint - // When this parameter is true, networking is disabled within the container. This - // parameter maps to NetworkDisabled in the Create a container + // The name of a container. If you are linking multiple containers together in a + // task definition, the name of one container can be entered in the links of + // another container to connect the containers. Up to 255 letters (uppercase and + // lowercase), numbers, and hyphens are allowed. This parameter maps to name in the + // Create a container // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/). This - // parameter is not supported for Windows containers. - DisableNetworking *bool + // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the --name + // option to docker run (https://docs.docker.com/engine/reference/run/). + Name *string - // A list of hostnames and IP address mappings to append to the /etc/hosts file on - // the container. This parameter maps to ExtraHosts in the Create a container + // The list of port mappings for the container. Port mappings allow containers to + // access ports on the host container instance to send or receive traffic. For task + // definitions that use the awsvpc network mode, you should only specify the + // containerPort. The hostPort can be left blank or it must be the same value as + // the containerPort. Port mappings on Windows use the NetNAT gateway address + // rather than localhost. There is no loopback for port mappings on Windows, so you + // cannot access a container's mapped port from the host itself. This parameter + // maps to PortBindings in the Create a container // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --add-host option to docker run (https://docs.docker.com/engine/reference/run/). - // This parameter is not supported for Windows containers or tasks that use the - // awsvpc network mode. - ExtraHosts []*HostEntry + // --publish option to docker run (https://docs.docker.com/engine/reference/run/). + // If the network mode of a task definition is set to none, then you can't specify + // port mappings. If the network mode of a task definition is set to host, then + // host ports must either be undefined or they must match the container port in the + // port mapping. After a task reaches the RUNNING status, manual and automatic host + // and container port assignments are visible in the Network Bindings section of a + // container description for a selected task in the Amazon ECS console. The + // assignments are also visible in the networkBindings section DescribeTasks () + // responses. + PortMappings []*PortMapping - // A list of ulimits to set in the container. If a ulimit value is specified in a - // task definition, it will override the default values set by Docker. This - // parameter maps to Ulimits in the Create a container + // When this parameter is true, the container is given elevated privileges on the + // host container instance (similar to the root user). This parameter maps to + // Privileged in the Create a container // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --ulimit option to docker run (https://docs.docker.com/engine/reference/run/). - // Valid naming values are displayed in the Ulimit () data type. This parameter - // requires version 1.18 of the Docker Remote API or greater on your container - // instance. To check the Docker Remote API version on your container instance, log - // in to your container instance and run the following command: sudo docker version - // --format '{{.Server.APIVersion}}' This parameter is not supported for Windows - // containers. - Ulimits []*Ulimit + // --privileged option to docker run + // (https://docs.docker.com/engine/reference/run/). This parameter is not supported + // for Windows containers or tasks using the Fargate launch type. + Privileged *bool // When this parameter is true, a TTY is allocated. This parameter maps to Tty in // the Create a container @@ -854,6 +810,28 @@ type ContainerDefinition struct { // option to docker run (https://docs.docker.com/engine/reference/run/). PseudoTerminal *bool + // When this parameter is true, the container is given read-only access to its root + // file system. This parameter maps to ReadonlyRootfs in the Create a container + // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of + // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the + // --read-only option to docker run + // (https://docs.docker.com/engine/reference/run/). This parameter is not supported + // for Windows containers. + ReadonlyRootFilesystem *bool + + // The private repository authentication credentials to use. + RepositoryCredentials *RepositoryCredentials + + // The type and amount of a resource to assign to a container. The only supported + // resource is a GPU. + ResourceRequirements []*ResourceRequirement + + // The secrets to pass to the container. For more information, see Specifying + // Sensitive Data + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) + // in the Amazon Elastic Container Service Developer Guide. + Secrets []*Secret + // Time duration (in seconds) to wait before giving up on resolving dependencies // for a container. For example, you specify two containers in a task definition // with containerA having a dependency on containerB reaching a COMPLETE, SUCCESS, @@ -883,51 +861,6 @@ type ContainerDefinition struct { // in the Amazon Elastic Container Service Developer Guide. StartTimeout *int32 - // The hostname to use for your container. This parameter maps to Hostname in the - // Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --hostname option to docker run (https://docs.docker.com/engine/reference/run/). - // The hostname parameter is not supported if you are using the awsvpc network - // mode. - Hostname *string - - // The type and amount of a resource to assign to a container. The only supported - // resource is a GPU. - ResourceRequirements []*ResourceRequirement - - // The FireLens configuration for the container. This is used to specify and - // configure a log router for container logs. For more information, see Custom Log - // Routing - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) - // in the Amazon Elastic Container Service Developer Guide. - FirelensConfiguration *FirelensConfiguration - - // A list of DNS servers that are presented to the container. This parameter maps - // to Dns in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the --dns - // option to docker run (https://docs.docker.com/engine/reference/run/). This - // parameter is not supported for Windows containers. - DnsServers []*string - - // The links parameter allows containers to communicate with each other without the - // need for port mappings. This parameter is only supported if the network mode of - // a task definition is bridge. The name:internalName construct is analogous to - // name:alias in Docker links. Up to 255 letters (uppercase and lowercase), - // numbers, and hyphens are allowed. For more information about linking Docker - // containers, go to Legacy container links - // (https://docs.docker.com/network/links/) in the Docker documentation. This - // parameter maps to Links in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the --link - // option to docker run (https://docs.docker.com/engine/reference/run/). This - // parameter is not supported for Windows containers. Containers that are - // collocated on a single container instance may be able to communicate with each - // other without requiring links or host port mappings. Network isolation is - // achieved on the container instance using security groups and VPC settings. - Links []*string - // Time duration (in seconds) to wait before the container is forcefully killed if // it doesn't exit normally on its own. For tasks using the Fargate launch type, // the task or service requires platform version 1.3.0 or later. The max stop @@ -951,6 +884,73 @@ type ContainerDefinition struct { // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) // in the Amazon Elastic Container Service Developer Guide. StopTimeout *int32 + + // A list of namespaced kernel parameters to set in the container. This parameter + // maps to Sysctls in the Create a container + // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of + // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the + // --sysctl option to docker run (https://docs.docker.com/engine/reference/run/). + // It is not recommended that you specify network-related systemControls parameters + // for multiple containers in a single task that also uses either the awsvpc or + // host network modes. For tasks that use the awsvpc network mode, the container + // that is started last determines which systemControls parameters take effect. For + // tasks that use the host network mode, it changes the container instance's + // namespaced kernel parameters as well as the containers. + SystemControls []*SystemControl + + // A list of ulimits to set in the container. If a ulimit value is specified in a + // task definition, it will override the default values set by Docker. This + // parameter maps to Ulimits in the Create a container + // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of + // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the + // --ulimit option to docker run (https://docs.docker.com/engine/reference/run/). + // Valid naming values are displayed in the Ulimit () data type. This parameter + // requires version 1.18 of the Docker Remote API or greater on your container + // instance. To check the Docker Remote API version on your container instance, log + // in to your container instance and run the following command: sudo docker version + // --format '{{.Server.APIVersion}}' This parameter is not supported for Windows + // containers. + Ulimits []*Ulimit + + // The user name to use inside the container. This parameter maps to User in the + // Create a container + // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of + // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the --user + // option to docker run (https://docs.docker.com/engine/reference/run/). You can + // use the following formats. If specifying a UID or GID, you must specify it as a + // positive integer. + // + // * user + // + // * user:group + // + // * uid + // + // * uid:gid + // + // * + // user:gid + // + // * uid:group + // + // This parameter is not supported for Windows + // containers. + User *string + + // Data volumes to mount from another container. This parameter maps to VolumesFrom + // in the Create a container + // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of + // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the + // --volumes-from option to docker run + // (https://docs.docker.com/engine/reference/run/). + VolumesFrom []*VolumeFrom + + // The working directory in which to run commands inside the container. This + // parameter maps to WorkingDir in the Create a container + // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of + // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the + // --workdir option to docker run (https://docs.docker.com/engine/reference/run/). + WorkingDirectory *string } // The dependencies defined for container startup and shutdown. A container can @@ -1006,75 +1006,27 @@ type ContainerDependency struct { // with a cluster. type ContainerInstance struct { - // The status of the most recent agent update. If an update has never been - // requested, this value is NULL. - AgentUpdateStatus AgentUpdateStatus - - // The Unix timestamp for when the container instance was registered. - RegisteredAt *time.Time - - // The resources attached to a container instance, such as elastic network - // interfaces. - Attachments []*Attachment - - // The version information for the Amazon ECS container agent and Docker daemon - // running on the container instance. - VersionInfo *VersionInfo - // This parameter returns true if the agent is connected to Amazon ECS. Registered // instances with an agent that may be unhealthy or stopped return false. Only // instances connected to an agent can accept placement requests. AgentConnected *bool - // The number of tasks on the container instance that are in the RUNNING status. - RunningTasksCount *int32 + // The status of the most recent agent update. If an update has never been + // requested, this value is NULL. + AgentUpdateStatus AgentUpdateStatus - // The metadata that you apply to the container instance to help you categorize and - // organize them. Each tag consists of a key and an optional value, both of which - // you define. The following basic restrictions apply to tags: - // - // * Maximum - // number of tags per resource - 50 - // - // * For each resource, each tag key must be - // unique, and each tag key can have only one value. - // - // * Maximum key length - - // 128 Unicode characters in UTF-8 - // - // * Maximum value length - 256 Unicode - // characters in UTF-8 - // - // * If your tagging schema is used across multiple - // services and resources, remember that other services may have restrictions on - // allowed characters. Generally allowed characters are: letters, numbers, and - // spaces representable in UTF-8, and the following characters: + - = . _ : / @. - // - // - // * Tag keys and values are case-sensitive. - // - // * Do not use aws:, AWS:, or any - // upper or lowercase combination of such as a prefix for either keys or values as - // it is reserved for AWS use. You cannot edit or delete tag keys or values with - // this prefix. Tags with this prefix do not count against your tags per resource - // limit. - Tags []*Tag + // The resources attached to a container instance, such as elastic network + // interfaces. + Attachments []*Attachment - // The EC2 instance ID of the container instance. - Ec2InstanceId *string + // The attributes set for the container instance, either by the Amazon ECS + // container agent at instance registration or manually with the PutAttributes () + // operation. + Attributes []*Attribute // The capacity provider associated with the container instance. CapacityProviderName *string - // The version counter for the container instance. Every time a container instance - // experiences a change that triggers a CloudWatch event, the version counter is - // incremented. If you are replicating your Amazon ECS container instance state - // with CloudWatch Events, you can compare the version of a container instance - // reported by the Amazon ECS APIs with the version reported in CloudWatch Events - // for the container instance (inside the detail object) to verify that the version - // in your event stream is current. - Version *int64 - // The Amazon Resource Name (ARN) of the container instance. The ARN contains the // arn:aws:ecs namespace, followed by the Region of the container instance, the AWS // account ID of the container instance owner, the container-instance namespace, @@ -1082,13 +1034,14 @@ type ContainerInstance struct { // arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID. ContainerInstanceArn *string + // The EC2 instance ID of the container instance. + Ec2InstanceId *string + // The number of tasks on the container instance that are in the PENDING status. PendingTasksCount *int32 - // The attributes set for the container instance, either by the Amazon ECS - // container agent at instance registration or manually with the PutAttributes () - // operation. - Attributes []*Attribute + // The Unix timestamp for when the container instance was registered. + RegisteredAt *time.Time // For CPU and memory resource types, this parameter describes the amount of each // resource that was available on the container instance when the container agent @@ -1108,8 +1061,8 @@ type ContainerInstance struct { // here is available for new tasks. RemainingResources []*Resource - // The reason that the container instance reached its current status. - StatusReason *string + // The number of tasks on the container instance that are in the RUNNING status. + RunningTasksCount *int32 // The status of the container instance. The valid values are REGISTERING, // REGISTRATION_FAILED, ACTIVE, INACTIVE, DEREGISTERING, or DRAINING. If your @@ -1128,6 +1081,53 @@ type ContainerInstance struct { // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-draining.html) // in the Amazon Elastic Container Service Developer Guide. Status *string + + // The reason that the container instance reached its current status. + StatusReason *string + + // The metadata that you apply to the container instance to help you categorize and + // organize them. Each tag consists of a key and an optional value, both of which + // you define. The following basic restrictions apply to tags: + // + // * Maximum + // number of tags per resource - 50 + // + // * For each resource, each tag key must be + // unique, and each tag key can have only one value. + // + // * Maximum key length - + // 128 Unicode characters in UTF-8 + // + // * Maximum value length - 256 Unicode + // characters in UTF-8 + // + // * If your tagging schema is used across multiple + // services and resources, remember that other services may have restrictions on + // allowed characters. Generally allowed characters are: letters, numbers, and + // spaces representable in UTF-8, and the following characters: + - = . _ : / @. + // + // + // * Tag keys and values are case-sensitive. + // + // * Do not use aws:, AWS:, or any + // upper or lowercase combination of such as a prefix for either keys or values as + // it is reserved for AWS use. You cannot edit or delete tag keys or values with + // this prefix. Tags with this prefix do not count against your tags per resource + // limit. + Tags []*Tag + + // The version counter for the container instance. Every time a container instance + // experiences a change that triggers a CloudWatch event, the version counter is + // incremented. If you are replicating your Amazon ECS container instance state + // with CloudWatch Events, you can compare the version of a container instance + // reported by the Amazon ECS APIs with the version reported in CloudWatch Events + // for the container instance (inside the detail object) to verify that the version + // in your event stream is current. + Version *int64 + + // The version information for the Amazon ECS container agent and Docker daemon + // running on the container instance. + VersionInfo *VersionInfo } // The overrides that should be sent to a container. An empty container override @@ -1136,6 +1136,20 @@ type ContainerInstance struct { // the name parameter must be included. type ContainerOverride struct { + // The command to send to the container that overrides the default command from the + // Docker image or the task definition. You must also specify a container name. + Command []*string + + // The number of cpu units reserved for the container, instead of the default value + // from the task definition. You must also specify a container name. + Cpu *int32 + + // The environment variables to send to the container. You can add new environment + // variables, which are added to the container at launch, or you can override the + // existing environment variables from the Docker image or the task definition. You + // must also specify a container name. + Environment []*KeyValuePair + // A list of files containing the environment variables to pass to a container, // instead of the value from the container definition. EnvironmentFiles []*EnvironmentFile @@ -1146,42 +1160,22 @@ type ContainerOverride struct { // container name. Memory *int32 - // The environment variables to send to the container. You can add new environment - // variables, which are added to the container at launch, or you can override the - // existing environment variables from the Docker image or the task definition. You - // must also specify a container name. - Environment []*KeyValuePair - - // The number of cpu units reserved for the container, instead of the default value - // from the task definition. You must also specify a container name. - Cpu *int32 - // The soft limit (in MiB) of memory to reserve for the container, instead of the // default value from the task definition. You must also specify a container name. MemoryReservation *int32 - // The command to send to the container that overrides the default command from the - // Docker image or the task definition. You must also specify a container name. - Command []*string + // The name of the container that receives the override. This parameter is required + // if any override is specified. + Name *string // The type and amount of a resource to assign to a container, instead of the // default value from the task definition. The only supported resource is a GPU. ResourceRequirements []*ResourceRequirement - - // The name of the container that receives the override. This parameter is required - // if any override is specified. - Name *string } // An object representing a change in state for a container. type ContainerStateChange struct { - // Any network bindings associated with the container. - NetworkBindings []*NetworkBinding - - // The reason for the state change. - Reason *string - // The name of the container. ContainerName *string @@ -1189,48 +1183,36 @@ type ContainerStateChange struct { // container exiting. ExitCode *int32 + // The container image SHA 256 digest. + ImageDigest *string + + // Any network bindings associated with the container. + NetworkBindings []*NetworkBinding + + // The reason for the state change. + Reason *string + // The ID of the Docker container. RuntimeId *string // The status of the container. Status *string - - // The container image SHA 256 digest. - ImageDigest *string } // The details of an Amazon ECS service deployment. This is used only when a // service uses the ECS deployment controller type. type Deployment struct { - // The status of the deployment. The following describes each state: PRIMARY The - // most recent deployment of a service. ACTIVE A service deployment that still has - // running tasks, but are in the process of being replaced with a new PRIMARY - // deployment. INACTIVE A deployment that has been completely replaced. - Status *string - - // The most recent task definition that was specified for the tasks in the service - // to use. - TaskDefinition *string + // The capacity provider strategy that the deployment is using. + CapacityProviderStrategy []*CapacityProviderStrategyItem - // The platform version on which your tasks in the service are running. A platform - // version is only specified for tasks using the Fargate launch type. If one is not - // specified, the LATEST platform version is used by default. For more information, - // see AWS Fargate Platform Versions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) - // in the Amazon Elastic Container Service Developer Guide. - PlatformVersion *string + // The Unix timestamp for when the service deployment was created. + CreatedAt *time.Time // The most recent desired count of tasks that was specified for the service to // deploy or maintain. DesiredCount *int32 - // The capacity provider strategy that the deployment is using. - CapacityProviderStrategy []*CapacityProviderStrategyItem - - // The Unix timestamp for when the service deployment was last updated. - UpdatedAt *time.Time - // The ID of the deployment. Id *string @@ -1240,18 +1222,36 @@ type Deployment struct { // in the Amazon Elastic Container Service Developer Guide. LaunchType LaunchType - // The number of tasks in the deployment that are in the RUNNING status. - RunningCount *int32 + // The VPC subnet and security group configuration for tasks that receive their own + // elastic network interface by using the awsvpc networking mode. + NetworkConfiguration *NetworkConfiguration // The number of tasks in the deployment that are in the PENDING status. PendingCount *int32 - // The VPC subnet and security group configuration for tasks that receive their own - // elastic network interface by using the awsvpc networking mode. - NetworkConfiguration *NetworkConfiguration + // The platform version on which your tasks in the service are running. A platform + // version is only specified for tasks using the Fargate launch type. If one is not + // specified, the LATEST platform version is used by default. For more information, + // see AWS Fargate Platform Versions + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // in the Amazon Elastic Container Service Developer Guide. + PlatformVersion *string - // The Unix timestamp for when the service deployment was created. - CreatedAt *time.Time + // The number of tasks in the deployment that are in the RUNNING status. + RunningCount *int32 + + // The status of the deployment. The following describes each state: PRIMARY The + // most recent deployment of a service. ACTIVE A service deployment that still has + // running tasks, but are in the process of being replaced with a new PRIMARY + // deployment. INACTIVE A deployment that has been completely replaced. + Status *string + + // The most recent task definition that was specified for the tasks in the service + // to use. + TaskDefinition *string + + // The Unix timestamp for when the service deployment was last updated. + UpdatedAt *time.Time } // Optional deployment parameters that control how many tasks run during a @@ -1345,6 +1345,10 @@ type Device struct { // instead. type DockerVolumeConfiguration struct { + // If this value is true, the Docker volume is created if it does not already + // exist. This field is only used if the scope is shared. + Autoprovision *bool + // The Docker volume driver to use. The driver value must match the driver name // provided by Docker because it is used for task placement. If the driver was // installed using the Docker plugin CLI, use docker plugin ls to retrieve the @@ -1367,16 +1371,6 @@ type DockerVolumeConfiguration struct { // (https://docs.docker.com/engine/reference/commandline/volume_create/). DriverOpts map[string]*string - // The scope for the Docker volume that determines its lifecycle. Docker volumes - // that are scoped to a task are automatically provisioned when the task starts and - // destroyed when the task stops. Docker volumes that are scoped as shared persist - // after the task stops. - Scope Scope - - // If this value is true, the Docker volume is created if it does not already - // exist. This field is only used if the scope is shared. - Autoprovision *bool - // Custom metadata to add to your Docker volume. This parameter maps to Labels in // the Create a volume // (https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of @@ -1384,20 +1378,17 @@ type DockerVolumeConfiguration struct { // xxlabel option to docker volume create // (https://docs.docker.com/engine/reference/commandline/volume_create/). Labels map[string]*string + + // The scope for the Docker volume that determines its lifecycle. Docker volumes + // that are scoped to a task are automatically provisioned when the task starts and + // destroyed when the task stops. Docker volumes that are scoped as shared persist + // after the task stops. + Scope Scope } // The authorization configuration details for the Amazon EFS file system. type EFSAuthorizationConfig struct { - // Whether or not to use the Amazon ECS task IAM role defined in a task definition - // when mounting the Amazon EFS file system. If enabled, transit encryption must be - // enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default - // value of DISABLED is used. For more information, see Using Amazon EFS Access - // Points - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) - // in the Amazon Elastic Container Service Developer Guide. - Iam EFSAuthorizationConfigIAM - // The Amazon EFS access point ID to use. If an access point is specified, the root // directory value specified in the EFSVolumeConfiguration will be relative to the // directory set for the access point. If an access point is used, transit @@ -1406,6 +1397,15 @@ type EFSAuthorizationConfig struct { // (https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the Amazon // Elastic File System User Guide. AccessPointId *string + + // Whether or not to use the Amazon ECS task IAM role defined in a task definition + // when mounting the Amazon EFS file system. If enabled, transit encryption must be + // enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default + // value of DISABLED is used. For more information, see Using Amazon EFS Access + // Points + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) + // in the Amazon Elastic Container Service Developer Guide. + Iam EFSAuthorizationConfigIAM } // This parameter is specified when you are using an Amazon Elastic File System @@ -1414,6 +1414,19 @@ type EFSAuthorizationConfig struct { // in the Amazon Elastic Container Service Developer Guide. type EFSVolumeConfiguration struct { + // The Amazon EFS file system ID to use. + // + // This member is required. + FileSystemId *string + + // The authorization configuration details for the Amazon EFS file system. + AuthorizationConfig *EFSAuthorizationConfig + + // The directory within the Amazon EFS file system to mount as the root directory + // inside the host. If this parameter is omitted, the root of the Amazon EFS volume + // will be used. Specifying / will have the same effect as omitting this parameter. + RootDirectory *string + // Whether or not to enable encryption for Amazon EFS data in transit between the // Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if // Amazon EFS IAM authorization is used. If this parameter is omitted, the default @@ -1422,14 +1435,6 @@ type EFSVolumeConfiguration struct { // Amazon Elastic File System User Guide. TransitEncryption EFSTransitEncryption - // The directory within the Amazon EFS file system to mount as the root directory - // inside the host. If this parameter is omitted, the root of the Amazon EFS volume - // will be used. Specifying / will have the same effect as omitting this parameter. - RootDirectory *string - - // The authorization configuration details for the Amazon EFS file system. - AuthorizationConfig *EFSAuthorizationConfig - // The port to use when sending encrypted data between the Amazon ECS host and the // Amazon EFS server. If you do not specify a transit encryption port, it will use // the port selection strategy that the Amazon EFS mount helper uses. For more @@ -1437,11 +1442,6 @@ type EFSVolumeConfiguration struct { // (https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the Amazon // Elastic File System User Guide. TransitEncryptionPort *int32 - - // The Amazon EFS file system ID to use. - // - // This member is required. - FileSystemId *string } // A list of files containing the environment variables to pass to a container. You @@ -1476,12 +1476,12 @@ type EnvironmentFile struct { // A failed resource. type Failure struct { - // The details of the failure. - Detail *string - // The Amazon Resource Name (ARN) of the failed resource. Arn *string + // The details of the failure. + Detail *string + // The reason for the failure. Reason *string } @@ -1576,16 +1576,15 @@ type HealthCheck struct { // This member is required. Command []*string + // The time period in seconds between each health check execution. You may specify + // between 5 and 300 seconds. The default value is 30 seconds. + Interval *int32 + // The number of times to retry a failed health check before the container is // considered unhealthy. You may specify between 1 and 10 retries. The default // value is 3. Retries *int32 - // The time period in seconds to wait for a health check to succeed before it is - // considered a failure. You may specify between 2 and 60 seconds. The default - // value is 5. - Timeout *int32 - // The optional grace period within which to provide containers time to bootstrap // before failed health checks count towards the maximum number of retries. You may // specify between 0 and 300 seconds. The startPeriod is disabled by default. If a @@ -1593,9 +1592,10 @@ type HealthCheck struct { // healthy and any subsequent failures count toward the maximum number of retries. StartPeriod *int32 - // The time period in seconds between each health check execution. You may specify - // between 5 and 300 seconds. The default value is 30 seconds. - Interval *int32 + // The time period in seconds to wait for a health check to succeed before it is + // considered a failure. You may specify between 2 and 60 seconds. The default + // value is 5. + Timeout *int32 } // Hostnames and IP address entries that are added to the /etc/hosts file of a @@ -1634,16 +1634,16 @@ type HostVolumeProperties struct { // the Amazon Elastic Container Service Developer Guide. type InferenceAccelerator struct { - // The Elastic Inference accelerator type to use. - // - // This member is required. - DeviceType *string - // The Elastic Inference accelerator device name. The deviceName must also be // referenced in a container definition as a ResourceRequirement (). // // This member is required. DeviceName *string + + // The Elastic Inference accelerator type to use. + // + // This member is required. + DeviceType *string } // Details on an Elastic Inference accelerator task override. This parameter is @@ -1672,21 +1672,6 @@ type InferenceAcceleratorOverride struct { // (http://man7.org/linux/man-pages/man7/capabilities.7.html) Linux manual page. type KernelCapabilities struct { - // The Linux capabilities for the container that have been removed from the default - // configuration provided by Docker. This parameter maps to CapDrop in the Create a - // container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and - // the --cap-drop option to docker run - // (https://docs.docker.com/engine/reference/run/). Valid values: "ALL" | - // "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | - // "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | - // "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | - // "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | - // "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | - // "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | - // "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM" - Drop []*string - // The Linux capabilities for the container that have been added to the default // configuration provided by Docker. This parameter maps to CapAdd in the Create a // container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) @@ -1704,29 +1689,62 @@ type KernelCapabilities struct { // "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | // "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM" Add []*string + + // The Linux capabilities for the container that have been removed from the default + // configuration provided by Docker. This parameter maps to CapDrop in the Create a + // container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and + // the --cap-drop option to docker run + // (https://docs.docker.com/engine/reference/run/). Valid values: "ALL" | + // "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | + // "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | + // "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | + // "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | + // "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | + // "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | + // "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM" + Drop []*string } // A key-value pair object. type KeyValuePair struct { - // The value of the key-value pair. For environment variables, this is the value of - // the environment variable. - Value *string - // The name of the key-value pair. For environment variables, this is the name of // the environment variable. Name *string + + // The value of the key-value pair. For environment variables, this is the value of + // the environment variable. + Value *string } // Linux-specific options that are applied to the container, such as Linux // KernelCapabilities (). type LinuxParameters struct { - // The value for the size (in MiB) of the /dev/shm volume. This parameter maps to - // the --shm-size option to docker run - // (https://docs.docker.com/engine/reference/run/). If you are using tasks that use - // the Fargate launch type, the sharedMemorySize parameter is not supported. - SharedMemorySize *int32 + // The Linux capabilities for the container that are added to or dropped from the + // default configuration provided by Docker. For tasks that use the Fargate launch + // type, capabilities is supported for all platform versions but the add parameter + // is only supported if using platform version 1.4.0 or later. + Capabilities *KernelCapabilities + + // Any host devices to expose to the container. This parameter maps to Devices in + // the Create a container + // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of + // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the + // --device option to docker run (https://docs.docker.com/engine/reference/run/). + // If you are using tasks that use the Fargate launch type, the devices parameter + // is not supported. + Devices []*Device + + // Run an init process inside the container that forwards signals and reaps + // processes. This parameter maps to the --init option to docker run + // (https://docs.docker.com/engine/reference/run/). This parameter requires version + // 1.25 of the Docker Remote API or greater on your container instance. To check + // the Docker Remote API version on your container instance, log in to your + // container instance and run the following command: sudo docker version --format + // '{{.Server.APIVersion}}' + InitProcessEnabled *bool // The total amount of swap memory (in MiB) a container can use. This parameter // will be translated to the --memory-swap option to docker run @@ -1739,6 +1757,12 @@ type LinuxParameters struct { // tasks that use the Fargate launch type, the maxSwap parameter is not supported. MaxSwap *int32 + // The value for the size (in MiB) of the /dev/shm volume. This parameter maps to + // the --shm-size option to docker run + // (https://docs.docker.com/engine/reference/run/). If you are using tasks that use + // the Fargate launch type, the sharedMemorySize parameter is not supported. + SharedMemorySize *int32 + // This allows you to tune a container's memory swappiness behavior. A swappiness // value of 0 will cause swapping to not happen unless absolutely necessary. A // swappiness value of 100 will cause pages to be swapped very aggressively. @@ -1750,35 +1774,11 @@ type LinuxParameters struct { // the Fargate launch type, the swappiness parameter is not supported. Swappiness *int32 - // Any host devices to expose to the container. This parameter maps to Devices in - // the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --device option to docker run (https://docs.docker.com/engine/reference/run/). - // If you are using tasks that use the Fargate launch type, the devices parameter - // is not supported. - Devices []*Device - // The container path, mount options, and size (in MiB) of the tmpfs mount. This // parameter maps to the --tmpfs option to docker run // (https://docs.docker.com/engine/reference/run/). If you are using tasks that use // the Fargate launch type, the tmpfs parameter is not supported. Tmpfs []*Tmpfs - - // The Linux capabilities for the container that are added to or dropped from the - // default configuration provided by Docker. For tasks that use the Fargate launch - // type, capabilities is supported for all platform versions but the add parameter - // is only supported if using platform version 1.4.0 or later. - Capabilities *KernelCapabilities - - // Run an init process inside the container that forwards signals and reaps - // processes. This parameter maps to the --init option to docker run - // (https://docs.docker.com/engine/reference/run/). This parameter requires version - // 1.25 of the Docker Remote API or greater on your container instance. To check - // the Docker Remote API version on your container instance, log in to your - // container instance and run the following command: sudo docker version --format - // '{{.Server.APIVersion}}' - InitProcessEnabled *bool } // The load balancer configuration to use with a service or task set. For specific @@ -1786,6 +1786,22 @@ type LinuxParameters struct { // task sets, see the CreateService and CreateTaskSet actions. type LoadBalancer struct { + // The name of the container (as it appears in a container definition) to associate + // with the load balancer. + ContainerName *string + + // The port on the container to associate with the load balancer. This port must + // correspond to a containerPort in the task definition the tasks in the service + // are using. For tasks that use the EC2 launch type, the container instance they + // are launched on must allow ingress traffic on the hostPort of the port mapping. + ContainerPort *int32 + + // The name of the load balancer to associate with the Amazon ECS service or task + // set. A load balancer name is only specified when using a Classic Load Balancer. + // If you are using an Application Load Balancer or a Network Load Balancer the + // load balancer name parameter should be omitted. + LoadBalancerName *string + // The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group // or groups associated with a service or task set. A target group ARN is only // specified when using an Application Load Balancer or Network Load Balancer. If @@ -1805,22 +1821,6 @@ type LoadBalancer struct { // your target groups because tasks that use the awsvpc network mode are associated // with an elastic network interface, not an Amazon EC2 instance. TargetGroupArn *string - - // The port on the container to associate with the load balancer. This port must - // correspond to a containerPort in the task definition the tasks in the service - // are using. For tasks that use the EC2 launch type, the container instance they - // are launched on must allow ingress traffic on the hostPort of the port mapping. - ContainerPort *int32 - - // The name of the load balancer to associate with the Amazon ECS service or task - // set. A load balancer name is only specified when using a Classic Load Balancer. - // If you are using an Application Load Balancer or a Network Load Balancer the - // load balancer name parameter should be omitted. - LoadBalancerName *string - - // The name of the container (as it appears in a container definition) to associate - // with the load balancer. - ContainerName *string } // The log configuration specification for the container. This parameter maps to @@ -1864,19 +1864,6 @@ type LoadBalancer struct { // aggregators or a remote host running Logstash to send Gelf logs to. type LogConfiguration struct { - // The secrets to pass to the log configuration. For more information, see - // Specifying Sensitive Data - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) - // in the Amazon Elastic Container Service Developer Guide. - SecretOptions []*Secret - - // The configuration options to send to the log driver. This parameter requires - // version 1.19 of the Docker Remote API or greater on your container instance. To - // check the Docker Remote API version on your container instance, log in to your - // container instance and run the following command: sudo docker version --format - // '{{.Server.APIVersion}}' - Options map[string]*string - // The log driver to use for the container. The valid values listed earlier are log // drivers that the Amazon ECS container agent can communicate with by default. For // tasks using the Fargate launch type, the supported log drivers are awslogs, @@ -1897,6 +1884,19 @@ type LogConfiguration struct { // // This member is required. LogDriver LogDriver + + // The configuration options to send to the log driver. This parameter requires + // version 1.19 of the Docker Remote API or greater on your container instance. To + // check the Docker Remote API version on your container instance, log in to your + // container instance and run the following command: sudo docker version --format + // '{{.Server.APIVersion}}' + Options map[string]*string + + // The secrets to pass to the log configuration. For more information, see + // Specifying Sensitive Data + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) + // in the Amazon Elastic Container Service Developer Guide. + SecretOptions []*Secret } // The managed scaling settings for the Auto Scaling group capacity provider. When @@ -1910,17 +1910,17 @@ type LogConfiguration struct { // disabled, the user must manage the scaling of the Auto Scaling group. type ManagedScaling struct { - // Whether or not to enable managed scaling for the capacity provider. - Status ManagedScalingStatus + // The maximum number of container instances that Amazon ECS will scale in or scale + // out at one time. If this parameter is omitted, the default value of 10000 is + // used. + MaximumScalingStepSize *int32 // The minimum number of container instances that Amazon ECS will scale in or scale // out at one time. If this parameter is omitted, the default value of 1 is used. MinimumScalingStepSize *int32 - // The maximum number of container instances that Amazon ECS will scale in or scale - // out at one time. If this parameter is omitted, the default value of 10000 is - // used. - MaximumScalingStepSize *int32 + // Whether or not to enable managed scaling for the capacity provider. + Status ManagedScalingStatus // The target capacity value for the capacity provider. The specified value must be // greater than 0 and less than or equal to 100. A value of 100 will result in the @@ -1934,14 +1934,14 @@ type MountPoint struct { // The path on the container to mount the host volume at. ContainerPath *string - // The name of the volume to mount. Must be a volume name referenced in the name - // parameter of task definition volume. - SourceVolume *string - // If this value is true, the container has read-only access to the volume. If this // value is false, then the container can write to the volume. The default value is // false. ReadOnly *bool + + // The name of the volume to mount. Must be a volume name referenced in the name + // parameter of task definition volume. + SourceVolume *string } // Details on the network bindings between a container and its host container @@ -1950,17 +1950,17 @@ type MountPoint struct { // DescribeTasks () API responses. type NetworkBinding struct { - // The protocol used for the network binding. - Protocol TransportProtocol - - // The port number on the host that is used with the network binding. - HostPort *int32 + // The IP address that the container is bound to on the container instance. + BindIP *string // The port number on the container that is used with the network binding. ContainerPort *int32 - // The IP address that the container is bound to on the container instance. - BindIP *string + // The port number on the host that is used with the network binding. + HostPort *int32 + + // The protocol used for the network binding. + Protocol TransportProtocol } // An object representing the network configuration for a task or service. @@ -1975,14 +1975,14 @@ type NetworkConfiguration struct { // awsvpc network mode. type NetworkInterface struct { - // The private IPv4 address for the network interface. - PrivateIpv4Address *string + // The attachment ID for the network interface. + AttachmentId *string // The private IPv6 address for the network interface. Ipv6Address *string - // The attachment ID for the network interface. - AttachmentId *string + // The private IPv4 address for the network interface. + PrivateIpv4Address *string } // An object representing a constraint on task placement. For more information, see @@ -1992,17 +1992,17 @@ type NetworkInterface struct { // Fargate launch type, task placement constraints are not supported. type PlacementConstraint struct { - // The type of constraint. Use distinctInstance to ensure that each task in a - // particular group is running on a different container instance. Use memberOf to - // restrict the selection to a group of valid candidates. - Type PlacementConstraintType - // A cluster query language expression to apply to the constraint. You cannot // specify an expression if the constraint type is distinctInstance. For more // information, see Cluster Query Language // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) // in the Amazon Elastic Container Service Developer Guide. Expression *string + + // The type of constraint. Use distinctInstance to ensure that each task in a + // particular group is running on a different container instance. Use memberOf to + // restrict the selection to a group of valid candidates. + Type PlacementConstraintType } // The task placement strategy for a task or service. For more information, see @@ -2011,6 +2011,14 @@ type PlacementConstraint struct { // in the Amazon Elastic Container Service Developer Guide. type PlacementStrategy struct { + // The field to apply the placement strategy against. For the spread placement + // strategy, valid values are instanceId (or host, which has the same effect), or + // any platform or custom attribute that is applied to a container instance, such + // as attribute:ecs.availability-zone. For the binpack placement strategy, valid + // values are cpu and memory. For the random placement strategy, this field is not + // used. + Field *string + // The type of placement strategy. The random placement strategy randomly places // tasks on available candidates. The spread placement strategy spreads placement // across available candidates evenly based on the field parameter. The binpack @@ -2019,14 +2027,6 @@ type PlacementStrategy struct { // if you binpack on memory, a task is placed on the instance with the least amount // of remaining memory (but still enough to run the task). Type PlacementStrategyType - - // The field to apply the placement strategy against. For the spread placement - // strategy, valid values are instanceId (or host, which has the same effect), or - // any platform or custom attribute that is applied to a container instance, such - // as attribute:ecs.availability-zone. For the binpack placement strategy, valid - // values are cpu and memory. For the random placement strategy, this field is not - // used. - Field *string } // The devices that are available on the container instance. The only supported @@ -2057,10 +2057,6 @@ type PlatformDevice struct { // API responses. type PortMapping struct { - // The protocol used for the port mapping. Valid values are tcp and udp. The - // default is tcp. - Protocol TransportProtocol - // The port number on the container that is bound to the user-specified or // automatically assigned host port. If you are using containers in a task with the // awsvpc or host network mode, exposed ports should be specified using @@ -2096,6 +2092,10 @@ type PortMapping struct { // reserved ports at a time, including the default reserved ports. Automatically // assigned ports don't count toward the 100 reserved ports limit. HostPort *int32 + + // The protocol used for the port mapping. Valid values are tcp and udp. The + // default is tcp. + Protocol TransportProtocol } // The configuration details for the App Mesh proxy. For tasks using the EC2 launch @@ -2111,6 +2111,11 @@ type PortMapping struct { // later. type ProxyConfiguration struct { + // The name of the container that will serve as the App Mesh proxy. + // + // This member is required. + ContainerName *string + // The set of network configuration parameters to provide the Container Network // Interface (CNI) plugin, specified as key-value pairs. // @@ -2147,11 +2152,6 @@ type ProxyConfiguration struct { // The proxy type. The only supported value is APPMESH. Type ProxyConfigurationType - - // The name of the container that will serve as the App Mesh proxy. - // - // This member is required. - ContainerName *string } // The repository credentials for private registry authentication. @@ -2170,27 +2170,27 @@ type RepositoryCredentials struct { // Describes the resources available for a container instance. type Resource struct { - // When the stringSetValue type is set, the value of the resource must be a string - // type. - StringSetValue []*string - - // When the longValue type is set, the value of the resource must be an extended + // When the doubleValue type is set, the value of the resource must be a double // precision floating-point type. - LongValue *int64 + DoubleValue *float64 - // The type of the resource, such as INTEGER, DOUBLE, LONG, or STRINGSET. - Type *string + // When the integerValue type is set, the value of the resource must be an integer. + IntegerValue *int32 - // When the doubleValue type is set, the value of the resource must be a double + // When the longValue type is set, the value of the resource must be an extended // precision floating-point type. - DoubleValue *float64 + LongValue *int64 // The name of the resource, such as CPU, MEMORY, PORTS, PORTS_UDP, or a // user-defined resource. Name *string - // When the integerValue type is set, the value of the resource must be an integer. - IntegerValue *int32 + // When the stringSetValue type is set, the value of the resource must be a string + // type. + StringSetValue []*string + + // The type of the resource, such as INTEGER, DOUBLE, LONG, or STRINGSET. + Type *string } // The type and amount of a resource to assign to a container. The supported @@ -2202,6 +2202,12 @@ type Resource struct { // the Amazon Elastic Container Service Developer Guide type ResourceRequirement struct { + // The type of resource to assign to a container. The supported values are GPU or + // InferenceAccelerator. + // + // This member is required. + Type ResourceType + // The value for the specified resource type. If the GPU type is used, the value is // the number of physical GPUs the Amazon ECS container agent will reserve for the // container. The number of GPUs reserved for all containers in a task should not @@ -2211,12 +2217,6 @@ type ResourceRequirement struct { // // This member is required. Value *string - - // The type of resource to assign to a container. The supported values are GPU or - // InferenceAccelerator. - // - // This member is required. - Type ResourceType } // A floating-point percentage of the desired number of tasks to place and keep @@ -2266,53 +2266,94 @@ type Secret struct { // Details on a service within a cluster type Service struct { - // The placement constraints for the tasks in the service. - PlacementConstraints []*PlacementConstraint - // The capacity provider strategy associated with the service. CapacityProviderStrategy []*CapacityProviderStrategyItem - // The launch type on which your service is running. If no value is specified, it - // will default to EC2. Valid values include EC2 and FARGATE. For more information, - // see Amazon ECS Launch Types - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) + // The Amazon Resource Name (ARN) of the cluster that hosts the service. + ClusterArn *string + + // The Unix timestamp for when the service was created. + CreatedAt *time.Time + + // The principal that created the service. + CreatedBy *string + + // Optional deployment parameters that control how many tasks run during the + // deployment and the ordering of stopping and starting tasks. + DeploymentConfiguration *DeploymentConfiguration + + // The deployment controller type the service is using. When using the + // DescribeServices API, this field is omitted if the service is using the ECS + // deployment controller type. + DeploymentController *DeploymentController + + // The current state of deployments for the service. + Deployments []*Deployment + + // The desired number of instantiations of the task definition to keep running on + // the service. This value is specified when the service is created with + // CreateService (), and it can be modified with UpdateService (). + DesiredCount *int32 + + // Specifies whether to enable Amazon ECS managed tags for the tasks in the + // service. For more information, see Tagging Your Amazon ECS Resources + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) // in the Amazon Elastic Container Service Developer Guide. - LaunchType LaunchType + EnableECSManagedTags *bool + + // The event stream for your service. A maximum of 100 of the latest events are + // displayed. + Events []*ServiceEvent // The period of time, in seconds, that the Amazon ECS service scheduler ignores // unhealthy Elastic Load Balancing target health checks after a task has first // started. HealthCheckGracePeriodSeconds *int32 - // Specifies whether to enable Amazon ECS managed tags for the tasks in the - // service. For more information, see Tagging Your Amazon ECS Resources - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) + // The launch type on which your service is running. If no value is specified, it + // will default to EC2. Valid values include EC2 and FARGATE. For more information, + // see Amazon ECS Launch Types + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) // in the Amazon Elastic Container Service Developer Guide. - EnableECSManagedTags *bool + LaunchType LaunchType + + // A list of Elastic Load Balancing load balancer objects, containing the load + // balancer name, the container name (as it appears in a container definition), and + // the container port to access from the load balancer. + LoadBalancers []*LoadBalancer + + // The VPC subnet and security group configuration for tasks that receive their own + // elastic network interface by using the awsvpc networking mode. + NetworkConfiguration *NetworkConfiguration // The number of tasks in the cluster that are in the PENDING state. PendingCount *int32 + // The placement constraints for the tasks in the service. + PlacementConstraints []*PlacementConstraint + + // The placement strategy that determines how tasks for the service are placed. + PlacementStrategy []*PlacementStrategy + + // The platform version on which to run your service. A platform version is only + // specified for tasks using the Fargate launch type. If one is not specified, the + // LATEST platform version is used by default. For more information, see AWS + // Fargate Platform Versions + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // in the Amazon Elastic Container Service Developer Guide. + PlatformVersion *string + // Specifies whether to propagate the tags from the task definition or the service // to the task. If no value is specified, the tags are not propagated. PropagateTags PropagateTags - // The desired number of instantiations of the task definition to keep running on - // the service. This value is specified when the service is created with - // CreateService (), and it can be modified with UpdateService (). - DesiredCount *int32 - - // The deployment controller type the service is using. When using the - // DescribeServices API, this field is omitted if the service is using the ECS - // deployment controller type. - DeploymentController *DeploymentController - - // The principal that created the service. - CreatedBy *string + // The ARN of the IAM role associated with the service that allows the Amazon ECS + // container agent to register container instances with an Elastic Load Balancing + // load balancer. + RoleArn *string - // The VPC subnet and security group configuration for tasks that receive their own - // elastic network interface by using the awsvpc networking mode. - NetworkConfiguration *NetworkConfiguration + // The number of tasks in the cluster that are in the RUNNING state. + RunningCount *int32 // The scheduling strategy to use for the service. For more information, see // Services @@ -2333,6 +2374,23 @@ type Service struct { // the DAEMON scheduling strategy. SchedulingStrategy SchedulingStrategy + // The ARN that identifies the service. The ARN contains the arn:aws:ecs namespace, + // followed by the Region of the service, the AWS account ID of the service owner, + // the service namespace, and then the service name. For example, + // arn:aws:ecs:region:012345678910:service/my-service. + ServiceArn *string + + // The name of your service. Up to 255 letters (uppercase and lowercase), numbers, + // and hyphens are allowed. Service names must be unique within a cluster, but you + // can have similarly named services in multiple clusters within a Region or across + // multiple Regions. + ServiceName *string + + // The details of the service discovery registries to assign to this service. For + // more information, see Service Discovery + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). + ServiceRegistries []*ServiceRegistry + // The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE. Status *string @@ -2367,74 +2425,16 @@ type Service struct { // limit. Tags []*Tag - // Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an - // EXTERNAL deployment. An Amazon ECS task set includes details such as the desired - // number of tasks, how many tasks are running, and whether the task set serves - // production traffic. - TaskSets []*TaskSet - - // The placement strategy that determines how tasks for the service are placed. - PlacementStrategy []*PlacementStrategy - - // The name of your service. Up to 255 letters (uppercase and lowercase), numbers, - // and hyphens are allowed. Service names must be unique within a cluster, but you - // can have similarly named services in multiple clusters within a Region or across - // multiple Regions. - ServiceName *string - - // The current state of deployments for the service. - Deployments []*Deployment - - // The details of the service discovery registries to assign to this service. For - // more information, see Service Discovery - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). - ServiceRegistries []*ServiceRegistry - - // Optional deployment parameters that control how many tasks run during the - // deployment and the ordering of stopping and starting tasks. - DeploymentConfiguration *DeploymentConfiguration - - // The Unix timestamp for when the service was created. - CreatedAt *time.Time - - // The Amazon Resource Name (ARN) of the cluster that hosts the service. - ClusterArn *string - - // The event stream for your service. A maximum of 100 of the latest events are - // displayed. - Events []*ServiceEvent - - // The number of tasks in the cluster that are in the RUNNING state. - RunningCount *int32 - - // A list of Elastic Load Balancing load balancer objects, containing the load - // balancer name, the container name (as it appears in a container definition), and - // the container port to access from the load balancer. - LoadBalancers []*LoadBalancer - // The task definition to use for tasks in the service. This value is specified // when the service is created with CreateService (), and it can be modified with // UpdateService (). TaskDefinition *string - // The platform version on which to run your service. A platform version is only - // specified for tasks using the Fargate launch type. If one is not specified, the - // LATEST platform version is used by default. For more information, see AWS - // Fargate Platform Versions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) - // in the Amazon Elastic Container Service Developer Guide. - PlatformVersion *string - - // The ARN of the IAM role associated with the service that allows the Amazon ECS - // container agent to register container instances with an Elastic Load Balancing - // load balancer. - RoleArn *string - - // The ARN that identifies the service. The ARN contains the arn:aws:ecs namespace, - // followed by the Region of the service, the AWS account ID of the service owner, - // the service namespace, and then the service name. For example, - // arn:aws:ecs:region:012345678910:service/my-service. - ServiceArn *string + // Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an + // EXTERNAL deployment. An Amazon ECS task set includes details such as the desired + // number of tasks, how many tasks are running, and whether the task set serves + // production traffic. + TaskSets []*TaskSet } // Details on an event associated with a service. @@ -2443,11 +2443,11 @@ type ServiceEvent struct { // The Unix timestamp for when the event was triggered. CreatedAt *time.Time - // The event message. - Message *string - // The ID string of the event. Id *string + + // The event message. + Message *string } // Details of the service registry. @@ -2462,15 +2462,6 @@ type ServiceRegistry struct { // containerPort combination or a port value, but not both. ContainerName *string - // The Amazon Resource Name (ARN) of the service registry. The currently supported - // service registry is AWS Cloud Map. For more information, see CreateService - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html). - RegistryArn *string - - // The port value used if your service discovery service specified an SRV record. - // This field may be used if both the awsvpc network mode and SRV records are used. - Port *int32 - // The port value, already specified in the task definition, to be used for your // service discovery service. If the task definition your service task specifies // uses the bridge or host network mode, you must specify a containerName and @@ -2479,20 +2470,29 @@ type ServiceRegistry struct { // used, you must specify either a containerName and containerPort combination or a // port value, but not both. ContainerPort *int32 + + // The port value used if your service discovery service specified an SRV record. + // This field may be used if both the awsvpc network mode and SRV records are used. + Port *int32 + + // The Amazon Resource Name (ARN) of the service registry. The currently supported + // service registry is AWS Cloud Map. For more information, see CreateService + // (https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html). + RegistryArn *string } // The current account setting for a resource. type Setting struct { - // Whether the account setting is enabled or disabled for the specified resource. - Value *string + // The Amazon ECS resource name. + Name SettingName // The ARN of the principal, which can be an IAM user, IAM role, or the root user. // If this field is omitted, the authenticated user is assumed. PrincipalArn *string - // The Amazon ECS resource name. - Name SettingName + // Whether the account setting is enabled or disabled for the specified resource. + Value *string } // A list of namespaced kernel parameters to set in the container. This parameter @@ -2553,57 +2553,112 @@ type SystemControl struct { // limit. type Tag struct { - // The optional part of a key-value pair that make up a tag. A value acts as a - // descriptor within a tag category (key). - Value *string - // One part of a key-value pair that make up a tag. A key is a general label that // acts like a category for more specific tag values. Key *string + + // The optional part of a key-value pair that make up a tag. A value acts as a + // descriptor within a tag category (key). + Value *string } // Details on a task in a cluster. type Task struct { - // The ARN of the task definition that creates the task. - TaskDefinitionArn *string + // The Elastic Network Adapter associated with the task if the task uses the awsvpc + // network mode. + Attachments []*Attachment - // The last known status of the task. For more information, see Task Lifecycle - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html). - LastStatus *string + // The attributes of the task + Attributes []*Attribute + + // The availability zone of the task. + AvailabilityZone *string + + // The capacity provider associated with the task. + CapacityProviderName *string + + // The ARN of the cluster that hosts the task. + ClusterArn *string + + // The connectivity status of a task. + Connectivity Connectivity + + // The Unix timestamp for when the task last went into CONNECTED status. + ConnectivityAt *time.Time + + // The ARN of the container instances that host the task. + ContainerInstanceArn *string + + // The containers associated with the task. + Containers []*Container + + // The number of CPU units used by the task as expressed in a task definition. It + // can be expressed as an integer using CPU units, for example 1024. It can also be + // expressed as a string using vCPUs, for example 1 vCPU or 1 vcpu. String values + // are converted to an integer indicating the CPU units when the task definition is + // registered. If you are using the EC2 launch type, this field is optional. + // Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 + // vCPUs). If you are using the Fargate launch type, this field is required and you + // must use one of the following values, which determines your range of supported + // values for the memory parameter: + // + // * 256 (.25 vCPU) - Available memory + // values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) + // + // * 512 (.5 vCPU) - Available + // memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) + // + // * 1024 (1 + // vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 + // GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) + // + // * 2048 (2 vCPU) - Available + // memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 + // GB) + // + // * 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and + // 30720 (30 GB) in increments of 1024 (1 GB) + Cpu *string // The Unix timestamp for when the task was created (the task entered the PENDING // state). CreatedAt *time.Time - // The Unix timestamp for when the task stops (transitions from the RUNNING state - // to STOPPED). - StoppingAt *time.Time - - // The Unix timestamp for when the task was stopped (the task transitioned from the - // RUNNING state to the STOPPED state). - StoppedAt *time.Time - // The desired status of the task. For more information, see Task Lifecycle // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html). DesiredStatus *string - // The tag specified when a task is started. If the task is started by an Amazon - // ECS service, then the startedBy parameter contains the deployment ID of the - // service that starts it. - StartedBy *string + // The Unix timestamp for when the task execution stopped. + ExecutionStoppedAt *time.Time - // The Unix timestamp for when the container image pull completed. - PullStoppedAt *time.Time + // The name of the task group associated with the task. + Group *string - // The connectivity status of a task. - Connectivity Connectivity + // The health status for the task, which is determined by the health of the + // essential containers in the task. If all essential containers in the task are + // reporting as HEALTHY, then the task status also reports as HEALTHY. If any + // essential containers in the task are reporting as UNHEALTHY or UNKNOWN, then the + // task status also reports as UNHEALTHY or UNKNOWN, accordingly. The Amazon ECS + // container agent does not monitor or report on Docker health checks that are + // embedded in a container image (such as those specified in a parent image or from + // the image's Dockerfile) and not specified in the container definition. Health + // check parameters that are specified in a container definition override any + // Docker health checks that exist in the container image. + HealthStatus HealthStatus - // The Unix timestamp for when the task last went into CONNECTED status. - ConnectivityAt *time.Time + // The Elastic Inference accelerator associated with the task. + InferenceAccelerators []*InferenceAccelerator - // The Unix timestamp for when the container image pull began. - PullStartedAt *time.Time + // The last known status of the task. For more information, see Task Lifecycle + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html). + LastStatus *string + + // The launch type on which your task is running. For more information, see Amazon + // ECS Launch Types + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) + // in the Amazon Elastic Container Service Developer Guide. + LaunchType LaunchType // The amount of memory (in MiB) used by the task as expressed in a task // definition. It can be expressed as an integer using MiB, for example 1024. It @@ -2631,18 +2686,47 @@ type Task struct { // 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU) Memory *string - // The version counter for the task. Every time a task experiences a change that - // triggers a CloudWatch event, the version counter is incremented. If you are - // replicating your Amazon ECS task state with CloudWatch Events, you can compare - // the version of a task reported by the Amazon ECS API actions with the version - // reported in CloudWatch Events for the task (inside the detail object) to verify - // that the version in your event stream is current. - Version *int64 + // One or more container overrides. + Overrides *TaskOverride + + // The platform version on which your task is running. A platform version is only + // specified for tasks using the Fargate launch type. If one is not specified, the + // LATEST platform version is used by default. For more information, see AWS + // Fargate Platform Versions + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // in the Amazon Elastic Container Service Developer Guide. + PlatformVersion *string + + // The Unix timestamp for when the container image pull began. + PullStartedAt *time.Time + + // The Unix timestamp for when the container image pull completed. + PullStoppedAt *time.Time + + // The Unix timestamp for when the task started (the task transitioned from the + // PENDING state to the RUNNING state). + StartedAt *time.Time + + // The tag specified when a task is started. If the task is started by an Amazon + // ECS service, then the startedBy parameter contains the deployment ID of the + // service that starts it. + StartedBy *string // The stop code indicating why a task was stopped. The stoppedReason may contain // additional details. StopCode TaskStopCode + // The Unix timestamp for when the task was stopped (the task transitioned from the + // RUNNING state to the STOPPED state). + StoppedAt *time.Time + + // The reason that the task was stopped. + StoppedReason *string + + // The Unix timestamp for when the task stops (transitions from the RUNNING state + // to STOPPED). + StoppingAt *time.Time + // The metadata that you apply to the task to help you categorize and organize // them. Each tag consists of a key and an optional value, both of which you // define. The following basic restrictions apply to tags: @@ -2674,103 +2758,19 @@ type Task struct { // limit. Tags []*Tag - // The Unix timestamp for when the task execution stopped. - ExecutionStoppedAt *time.Time - - // The availability zone of the task. - AvailabilityZone *string - - // The attributes of the task - Attributes []*Attribute - - // The health status for the task, which is determined by the health of the - // essential containers in the task. If all essential containers in the task are - // reporting as HEALTHY, then the task status also reports as HEALTHY. If any - // essential containers in the task are reporting as UNHEALTHY or UNKNOWN, then the - // task status also reports as UNHEALTHY or UNKNOWN, accordingly. The Amazon ECS - // container agent does not monitor or report on Docker health checks that are - // embedded in a container image (such as those specified in a parent image or from - // the image's Dockerfile) and not specified in the container definition. Health - // check parameters that are specified in a container definition override any - // Docker health checks that exist in the container image. - HealthStatus HealthStatus - - // The ARN of the cluster that hosts the task. - ClusterArn *string - - // The ARN of the container instances that host the task. - ContainerInstanceArn *string - - // The Unix timestamp for when the task started (the task transitioned from the - // PENDING state to the RUNNING state). - StartedAt *time.Time - // The Amazon Resource Name (ARN) of the task. TaskArn *string - // The platform version on which your task is running. A platform version is only - // specified for tasks using the Fargate launch type. If one is not specified, the - // LATEST platform version is used by default. For more information, see AWS - // Fargate Platform Versions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) - // in the Amazon Elastic Container Service Developer Guide. - PlatformVersion *string - - // The reason that the task was stopped. - StoppedReason *string - - // The containers associated with the task. - Containers []*Container - - // The capacity provider associated with the task. - CapacityProviderName *string - - // The Elastic Inference accelerator associated with the task. - InferenceAccelerators []*InferenceAccelerator - - // The Elastic Network Adapter associated with the task if the task uses the awsvpc - // network mode. - Attachments []*Attachment - - // The launch type on which your task is running. For more information, see Amazon - // ECS Launch Types - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) - // in the Amazon Elastic Container Service Developer Guide. - LaunchType LaunchType - - // One or more container overrides. - Overrides *TaskOverride - - // The name of the task group associated with the task. - Group *string - - // The number of CPU units used by the task as expressed in a task definition. It - // can be expressed as an integer using CPU units, for example 1024. It can also be - // expressed as a string using vCPUs, for example 1 vCPU or 1 vcpu. String values - // are converted to an integer indicating the CPU units when the task definition is - // registered. If you are using the EC2 launch type, this field is optional. - // Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 - // vCPUs). If you are using the Fargate launch type, this field is required and you - // must use one of the following values, which determines your range of supported - // values for the memory parameter: - // - // * 256 (.25 vCPU) - Available memory - // values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - // - // * 512 (.5 vCPU) - Available - // memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - // - // * 1024 (1 - // vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 - // GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - // - // * 2048 (2 vCPU) - Available - // memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 - // GB) - // - // * 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and - // 30720 (30 GB) in increments of 1024 (1 GB) - Cpu *string + // The ARN of the task definition that creates the task. + TaskDefinitionArn *string + + // The version counter for the task. Every time a task experiences a change that + // triggers a CloudWatch event, the version counter is incremented. If you are + // replicating your Amazon ECS task state with CloudWatch Events, you can compare + // the version of a task reported by the Amazon ECS API actions with the version + // reported in CloudWatch Events for the task (inside the detail object) to verify + // that the version in your event stream is current. + Version *int64 } // The details of a task definition which describes the container and volume @@ -2779,47 +2779,18 @@ type Task struct { // to launching the task definition through an Amazon ECS service or task. type TaskDefinition struct { - // An array of placement constraint objects to use for tasks. This field is not - // valid if you are using the Fargate launch type for your task. - PlacementConstraints []*TaskDefinitionPlacementConstraint - - // The Docker networking mode to use for the containers in the task. The valid - // values are none, bridge, awsvpc, and host. The default Docker network mode is - // bridge. If you are using the Fargate launch type, the awsvpc network mode is - // required. If you are using the EC2 launch type, any network mode can be used. If - // the network mode is set to none, you cannot specify port mappings in your - // container definitions, and the tasks containers do not have external - // connectivity. The host and awsvpc network modes offer the highest networking - // performance for containers because they use the EC2 network stack instead of the - // virtualized network stack provided by the bridge mode. With the host and awsvpc - // network modes, exposed container ports are mapped directly to the corresponding - // host port (for the host network mode) or the attached elastic network interface - // port (for the awsvpc network mode), so you cannot take advantage of dynamic host - // port mappings. If the network mode is awsvpc, the task is allocated an elastic - // network interface, and you must specify a NetworkConfiguration () value when you - // create a service or run a task with the task definition. For more information, - // see Task Networking - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) - // in the Amazon Elastic Container Service Developer Guide. Currently, only Amazon - // ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or - // AWS Fargate infrastructure support the awsvpc network mode. If the network mode - // is host, you cannot run multiple instantiations of the same task on a single - // container instance when port mappings are used. Docker for Windows uses - // different network modes than Docker for Linux. When you register a task - // definition with Windows containers, you must not specify a network mode. If you - // use the console to register a task definition with Windows containers, you must - // choose the network mode object. For more information, see Network settings - // (https://docs.docker.com/engine/reference/run/#network-settings) in the Docker - // run reference. - NetworkMode NetworkMode - - // The container instance attributes required by your task. This field is not valid - // if you are using the Fargate launch type for your task. - RequiresAttributes []*Attribute + // The launch type to use with your task. For more information, see Amazon ECS + // Launch Types + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) + // in the Amazon Elastic Container Service Developer Guide. + Compatibilities []Compatibility - // The launch type the task requires. If no value is specified, it will default to - // EC2. Valid values include EC2 and FARGATE. - RequiresCompatibilities []Compatibility + // A list of container definitions in JSON format that describe the different + // containers that make up your task. For more information about container + // definition parameters and defaults, see Amazon ECS Task Definitions + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) + // in the Amazon Elastic Container Service Developer Guide. + ContainerDefinitions []*ContainerDefinition // The number of cpu units used by the task. If you are using the EC2 launch type, // this field is optional and any value can be used. If you are using the Fargate @@ -2845,84 +2816,25 @@ type TaskDefinition struct { // GB) Cpu *string - // The process namespace to use for the containers in the task. The valid values - // are host or task. If host is specified, then all containers within the tasks - // that specified the host PID mode on the same container instance share the same - // process namespace with the host Amazon EC2 instance. If task is specified, all - // containers within the specified task share the same process namespace. If no - // value is specified, the default is a private namespace. For more information, - // see PID settings - // (https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the Docker - // run reference. If the host PID mode is used, be aware that there is a heightened - // risk of undesired process namespace expose. For more information, see Docker - // security (https://docs.docker.com/engine/security/security/). This parameter is - // not supported for Windows containers or tasks using the Fargate launch type. - PidMode PidMode - - // The list of volume definitions for the task. If your tasks are using the Fargate - // launch type, the host and sourcePath parameters are not supported. For more - // information about volume definition parameters and defaults, see Amazon ECS Task - // Definitions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html) - // in the Amazon Elastic Container Service Developer Guide. - Volumes []*Volume - - // The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access - // Management (IAM) role that grants containers in the task permission to call AWS - // APIs on your behalf. For more information, see Amazon ECS Task Role - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) - // in the Amazon Elastic Container Service Developer Guide. IAM roles for tasks on - // Windows require that the -EnableTaskIAMRole option is set when you launch the - // Amazon ECS-optimized Windows AMI. Your containers must also run some - // configuration code in order to take advantage of the feature. For more - // information, see Windows IAM Roles for Tasks - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) - // in the Amazon Elastic Container Service Developer Guide. - TaskRoleArn *string - - // A list of container definitions in JSON format that describe the different - // containers that make up your task. For more information about container - // definition parameters and defaults, see Amazon ECS Task Definitions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) - // in the Amazon Elastic Container Service Developer Guide. - ContainerDefinitions []*ContainerDefinition - - // The launch type to use with your task. For more information, see Amazon ECS - // Launch Types - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) + // The Amazon Resource Name (ARN) of the task execution role that grants the Amazon + // ECS container agent permission to make AWS API calls on your behalf. The task + // execution IAM role is required depending on the requirements of your task. For + // more information, see Amazon ECS task execution IAM role + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) // in the Amazon Elastic Container Service Developer Guide. - Compatibilities []Compatibility + ExecutionRoleArn *string - // The status of the task definition. - Status TaskDefinitionStatus + // The name of a family that this task definition is registered to. Up to 255 + // letters (uppercase and lowercase), numbers, hyphens, and underscores are + // allowed. A family groups multiple versions of a task definition. Amazon ECS + // gives the first task definition that you registered to a family a revision + // number of 1. Amazon ECS gives sequential revision numbers to each task + // definition that you add. + Family *string // The Elastic Inference accelerator associated with the task. InferenceAccelerators []*InferenceAccelerator - // The amount (in MiB) of memory used by the task. If using the EC2 launch type, - // this field is optional and any value can be used. If a task-level memory value - // is specified then the container-level memory value is optional. If using the - // Fargate launch type, this field is required and you must use one of the - // following values, which determines your range of valid values for the cpu - // parameter: - // - // * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: - // 256 (.25 vCPU) - // - // * 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - - // Available cpu values: 512 (.5 vCPU) - // - // * 2048 (2 GB), 3072 (3 GB), 4096 (4 - // GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: - // 1024 (1 vCPU) - // - // * Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 - // (1 GB) - Available cpu values: 2048 (2 vCPU) - // - // * Between 8192 (8 GB) and - // 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU) - Memory *string - // The IPC resource namespace to use for the containers in the task. The valid // values are host, task, or none. If host is specified, then all containers within // the tasks that specified the host IPC mode on the same container instance share @@ -2953,6 +2865,78 @@ type TaskDefinition struct { // Windows containers or tasks using the Fargate launch type. IpcMode IpcMode + // The amount (in MiB) of memory used by the task. If using the EC2 launch type, + // this field is optional and any value can be used. If a task-level memory value + // is specified then the container-level memory value is optional. If using the + // Fargate launch type, this field is required and you must use one of the + // following values, which determines your range of valid values for the cpu + // parameter: + // + // * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: + // 256 (.25 vCPU) + // + // * 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - + // Available cpu values: 512 (.5 vCPU) + // + // * 2048 (2 GB), 3072 (3 GB), 4096 (4 + // GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: + // 1024 (1 vCPU) + // + // * Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 + // (1 GB) - Available cpu values: 2048 (2 vCPU) + // + // * Between 8192 (8 GB) and + // 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU) + Memory *string + + // The Docker networking mode to use for the containers in the task. The valid + // values are none, bridge, awsvpc, and host. The default Docker network mode is + // bridge. If you are using the Fargate launch type, the awsvpc network mode is + // required. If you are using the EC2 launch type, any network mode can be used. If + // the network mode is set to none, you cannot specify port mappings in your + // container definitions, and the tasks containers do not have external + // connectivity. The host and awsvpc network modes offer the highest networking + // performance for containers because they use the EC2 network stack instead of the + // virtualized network stack provided by the bridge mode. With the host and awsvpc + // network modes, exposed container ports are mapped directly to the corresponding + // host port (for the host network mode) or the attached elastic network interface + // port (for the awsvpc network mode), so you cannot take advantage of dynamic host + // port mappings. If the network mode is awsvpc, the task is allocated an elastic + // network interface, and you must specify a NetworkConfiguration () value when you + // create a service or run a task with the task definition. For more information, + // see Task Networking + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) + // in the Amazon Elastic Container Service Developer Guide. Currently, only Amazon + // ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or + // AWS Fargate infrastructure support the awsvpc network mode. If the network mode + // is host, you cannot run multiple instantiations of the same task on a single + // container instance when port mappings are used. Docker for Windows uses + // different network modes than Docker for Linux. When you register a task + // definition with Windows containers, you must not specify a network mode. If you + // use the console to register a task definition with Windows containers, you must + // choose the network mode object. For more information, see Network settings + // (https://docs.docker.com/engine/reference/run/#network-settings) in the Docker + // run reference. + NetworkMode NetworkMode + + // The process namespace to use for the containers in the task. The valid values + // are host or task. If host is specified, then all containers within the tasks + // that specified the host PID mode on the same container instance share the same + // process namespace with the host Amazon EC2 instance. If task is specified, all + // containers within the specified task share the same process namespace. If no + // value is specified, the default is a private namespace. For more information, + // see PID settings + // (https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the Docker + // run reference. If the host PID mode is used, be aware that there is a heightened + // risk of undesired process namespace expose. For more information, see Docker + // security (https://docs.docker.com/engine/security/security/). This parameter is + // not supported for Windows containers or tasks using the Fargate launch type. + PidMode PidMode + + // An array of placement constraint objects to use for tasks. This field is not + // valid if you are using the Fargate launch type for your task. + PlacementConstraints []*TaskDefinitionPlacementConstraint + // The configuration details for the App Mesh proxy. Your Amazon ECS container // instances require at least version 1.26.0 of the container agent and at least // version 1.26.0-1 of the ecs-init package to enable a proxy configuration. If @@ -2963,24 +2947,13 @@ type TaskDefinition struct { // in the Amazon Elastic Container Service Developer Guide. ProxyConfiguration *ProxyConfiguration - // The Amazon Resource Name (ARN) of the task execution role that grants the Amazon - // ECS container agent permission to make AWS API calls on your behalf. The task - // execution IAM role is required depending on the requirements of your task. For - // more information, see Amazon ECS task execution IAM role - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) - // in the Amazon Elastic Container Service Developer Guide. - ExecutionRoleArn *string - - // The name of a family that this task definition is registered to. Up to 255 - // letters (uppercase and lowercase), numbers, hyphens, and underscores are - // allowed. A family groups multiple versions of a task definition. Amazon ECS - // gives the first task definition that you registered to a family a revision - // number of 1. Amazon ECS gives sequential revision numbers to each task - // definition that you add. - Family *string + // The container instance attributes required by your task. This field is not valid + // if you are using the Fargate launch type for your task. + RequiresAttributes []*Attribute - // The full Amazon Resource Name (ARN) of the task definition. - TaskDefinitionArn *string + // The launch type the task requires. If no value is specified, it will default to + // EC2. Valid values include EC2 and FARGATE. + RequiresCompatibilities []Compatibility // The revision of the task in a particular family. The revision is a version // number of a task definition in a family. When you register a task definition for @@ -2988,6 +2961,33 @@ type TaskDefinition struct { // a task definition in the same family, the revision value always increases by // one, even if you have deregistered previous revisions in this family. Revision *int32 + + // The status of the task definition. + Status TaskDefinitionStatus + + // The full Amazon Resource Name (ARN) of the task definition. + TaskDefinitionArn *string + + // The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access + // Management (IAM) role that grants containers in the task permission to call AWS + // APIs on your behalf. For more information, see Amazon ECS Task Role + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) + // in the Amazon Elastic Container Service Developer Guide. IAM roles for tasks on + // Windows require that the -EnableTaskIAMRole option is set when you launch the + // Amazon ECS-optimized Windows AMI. Your containers must also run some + // configuration code in order to take advantage of the feature. For more + // information, see Windows IAM Roles for Tasks + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) + // in the Amazon Elastic Container Service Developer Guide. + TaskRoleArn *string + + // The list of volume definitions for the task. If your tasks are using the Fargate + // launch type, the host and sourcePath parameters are not supported. For more + // information about volume definition parameters and defaults, see Amazon ECS Task + // Definitions + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html) + // in the Amazon Elastic Container Service Developer Guide. + Volumes []*Volume } // An object representing a constraint on task placement in the task definition. @@ -2997,40 +2997,40 @@ type TaskDefinition struct { // Fargate launch type, task placement constraints are not supported. type TaskDefinitionPlacementConstraint struct { - // The type of constraint. The MemberOf constraint restricts selection to be from a - // group of valid candidates. - Type TaskDefinitionPlacementConstraintType - // A cluster query language expression to apply to the constraint. For more // information, see Cluster Query Language // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) // in the Amazon Elastic Container Service Developer Guide. Expression *string + + // The type of constraint. The MemberOf constraint restricts selection to be from a + // group of valid candidates. + Type TaskDefinitionPlacementConstraintType } // The overrides associated with a task. type TaskOverride struct { - // The Amazon Resource Name (ARN) of the IAM role that containers in this task can - // assume. All containers in this task are granted the permissions that are - // specified in this role. - TaskRoleArn *string - - // The Elastic Inference accelerator override for the task. - InferenceAcceleratorOverrides []*InferenceAcceleratorOverride - // One or more container overrides sent to a task. ContainerOverrides []*ContainerOverride - // The memory override for the task. - Memory *string + // The cpu override for the task. + Cpu *string // The Amazon Resource Name (ARN) of the task execution IAM role override for the // task. ExecutionRoleArn *string - // The cpu override for the task. - Cpu *string + // The Elastic Inference accelerator override for the task. + InferenceAcceleratorOverrides []*InferenceAcceleratorOverride + + // The memory override for the task. + Memory *string + + // The Amazon Resource Name (ARN) of the IAM role that containers in this task can + // assume. All containers in this task are granted the permissions that are + // specified in this role. + TaskRoleArn *string } // Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an @@ -3039,68 +3039,74 @@ type TaskOverride struct { // production traffic. type TaskSet struct { - // The Unix timestamp for when the task set stability status was retrieved. - StabilityStatusAt *time.Time + // The capacity provider strategy associated with the task set. + CapacityProviderStrategy []*CapacityProviderStrategyItem // The Amazon Resource Name (ARN) of the cluster that the service that hosts the // task set exists in. ClusterArn *string + // The computed desired count for the task set. This is calculated by multiplying + // the service's desiredCount by the task set's scale percentage. The result is + // always rounded up. For example, if the computed desired count is 1.2, it rounds + // up to 2 tasks. + ComputedDesiredCount *int32 + // The Unix timestamp for when the task set was created. CreatedAt *time.Time + // The external ID associated with the task set. If a task set is created by an AWS + // CodeDeploy deployment, the externalId parameter contains the AWS CodeDeploy + // deployment ID. If a task set is created for an external deployment and is + // associated with a service discovery registry, the externalId parameter contains + // the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute. + ExternalId *string + + // The ID of the task set. + Id *string + + // The launch type the tasks in the task set are using. For more information, see + // Amazon ECS Launch Types + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) + // in the Amazon Elastic Container Service Developer Guide. + LaunchType LaunchType + + // Details on a load balancer that is used with a task set. + LoadBalancers []*LoadBalancer + + // The network configuration for the task set. + NetworkConfiguration *NetworkConfiguration + // The number of tasks in the task set that are in the PENDING status during a // deployment. A task in the PENDING state is preparing to enter the RUNNING state. // A task set enters the PENDING status when it launches for the first time or when // it is restarted after being in the STOPPED state. PendingCount *int32 - // The details of the service discovery registries to assign to this task set. For - // more information, see Service Discovery - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). - ServiceRegistries []*ServiceRegistry - - // The metadata that you apply to the task set to help you categorize and organize - // them. Each tag consists of a key and an optional value, both of which you - // define. The following basic restrictions apply to tags: - // - // * Maximum number of - // tags per resource - 50 - // - // * For each resource, each tag key must be unique, - // and each tag key can have only one value. - // - // * Maximum key length - 128 - // Unicode characters in UTF-8 - // - // * Maximum value length - 256 Unicode characters - // in UTF-8 - // - // * If your tagging schema is used across multiple services and - // resources, remember that other services may have restrictions on allowed - // characters. Generally allowed characters are: letters, numbers, and spaces - // representable in UTF-8, and the following characters: + - = . _ : / @. - // - // * - // Tag keys and values are case-sensitive. - // - // * Do not use aws:, AWS:, or any - // upper or lowercase combination of such as a prefix for either keys or values as - // it is reserved for AWS use. You cannot edit or delete tag keys or values with - // this prefix. Tags with this prefix do not count against your tags per resource - // limit. - Tags []*Tag + // The platform version on which the tasks in the task set are running. A platform + // version is only specified for tasks using the Fargate launch type. If one is not + // specified, the LATEST platform version is used by default. For more information, + // see AWS Fargate Platform Versions + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // in the Amazon Elastic Container Service Developer Guide. + PlatformVersion *string - // The computed desired count for the task set. This is calculated by multiplying - // the service's desiredCount by the task set's scale percentage. The result is - // always rounded up. For example, if the computed desired count is 1.2, it rounds - // up to 2 tasks. - ComputedDesiredCount *int32 + // The number of tasks in the task set that are in the RUNNING status during a + // deployment. A task in the RUNNING state is running and ready for use. + RunningCount *int32 // A floating-point percentage of the desired number of tasks to place and keep // running in the task set. Scale *Scale + // The Amazon Resource Name (ARN) of the service the task set exists in. + ServiceArn *string + + // The details of the service discovery registries to assign to this task set. For + // more information, see Service Discovery + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). + ServiceRegistries []*ServiceRegistry + // The stability status, which indicates whether the task set has reached a steady // state. If the following conditions are met, the task set will be in // STEADY_STATE: @@ -3121,65 +3127,59 @@ type TaskSet struct { // status returns STABILIZING. StabilityStatus StabilityStatus - // The launch type the tasks in the task set are using. For more information, see - // Amazon ECS Launch Types - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) - // in the Amazon Elastic Container Service Developer Guide. - LaunchType LaunchType - - // The capacity provider strategy associated with the task set. - CapacityProviderStrategy []*CapacityProviderStrategyItem - - // The Unix timestamp for when the task set was last updated. - UpdatedAt *time.Time - - // The network configuration for the task set. - NetworkConfiguration *NetworkConfiguration + // The Unix timestamp for when the task set stability status was retrieved. + StabilityStatusAt *time.Time // The tag specified when a task set is started. If the task set is created by an // AWS CodeDeploy deployment, the startedBy parameter is CODE_DEPLOY. For a task // set created for an external deployment, the startedBy field isn't used. StartedBy *string - // The Amazon Resource Name (ARN) of the service the task set exists in. - ServiceArn *string - - // The external ID associated with the task set. If a task set is created by an AWS - // CodeDeploy deployment, the externalId parameter contains the AWS CodeDeploy - // deployment ID. If a task set is created for an external deployment and is - // associated with a service discovery registry, the externalId parameter contains - // the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute. - ExternalId *string - - // Details on a load balancer that is used with a task set. - LoadBalancers []*LoadBalancer - - // The platform version on which the tasks in the task set are running. A platform - // version is only specified for tasks using the Fargate launch type. If one is not - // specified, the LATEST platform version is used by default. For more information, - // see AWS Fargate Platform Versions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) - // in the Amazon Elastic Container Service Developer Guide. - PlatformVersion *string - - // The number of tasks in the task set that are in the RUNNING status during a - // deployment. A task in the RUNNING state is running and ready for use. - RunningCount *int32 - // The status of the task set. The following describes each state: PRIMARY The task // set is serving production traffic. ACTIVE The task set is not serving production // traffic. DRAINING The tasks in the task set are being stopped and their // corresponding targets are being deregistered from their target group. Status *string - // The Amazon Resource Name (ARN) of the task set. - TaskSetArn *string - - // The ID of the task set. - Id *string + // The metadata that you apply to the task set to help you categorize and organize + // them. Each tag consists of a key and an optional value, both of which you + // define. The following basic restrictions apply to tags: + // + // * Maximum number of + // tags per resource - 50 + // + // * For each resource, each tag key must be unique, + // and each tag key can have only one value. + // + // * Maximum key length - 128 + // Unicode characters in UTF-8 + // + // * Maximum value length - 256 Unicode characters + // in UTF-8 + // + // * If your tagging schema is used across multiple services and + // resources, remember that other services may have restrictions on allowed + // characters. Generally allowed characters are: letters, numbers, and spaces + // representable in UTF-8, and the following characters: + - = . _ : / @. + // + // * + // Tag keys and values are case-sensitive. + // + // * Do not use aws:, AWS:, or any + // upper or lowercase combination of such as a prefix for either keys or values as + // it is reserved for AWS use. You cannot edit or delete tag keys or values with + // this prefix. Tags with this prefix do not count against your tags per resource + // limit. + Tags []*Tag // The task definition the task set is using. TaskDefinition *string + + // The Amazon Resource Name (ARN) of the task set. + TaskSetArn *string + + // The Unix timestamp for when the task set was last updated. + UpdatedAt *time.Time } // The container path, mount options, and size of the tmpfs mount. @@ -3190,6 +3190,11 @@ type Tmpfs struct { // This member is required. ContainerPath *string + // The size (in MiB) of the tmpfs volume. + // + // This member is required. + Size *int32 + // The list of tmpfs volume mount options. Valid values: "defaults" | "ro" | "rw" | // "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | // "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | @@ -3198,30 +3203,25 @@ type Tmpfs struct { // "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | // "nr_inodes" | "nr_blocks" | "mpol" MountOptions []*string - - // The size (in MiB) of the tmpfs volume. - // - // This member is required. - Size *int32 } // The ulimit settings to pass to the container. type Ulimit struct { - // The soft limit for the ulimit type. + // The hard limit for the ulimit type. // // This member is required. - SoftLimit *int32 + HardLimit *int32 // The type of the ulimit. // // This member is required. Name UlimitName - // The hard limit for the ulimit type. + // The soft limit for the ulimit type. // // This member is required. - HardLimit *int32 + SoftLimit *int32 } // The Docker and Amazon ECS container agent version information about a container @@ -3233,11 +3233,11 @@ type VersionInfo struct { // GitHub repository. AgentHash *string - // The Docker version running on the container instance. - DockerVersion *string - // The version number of the Amazon ECS container agent. AgentVersion *string + + // The Docker version running on the container instance. + DockerVersion *string } // A data volume used in a task definition. For tasks that use Amazon Elastic File @@ -3248,11 +3248,6 @@ type VersionInfo struct { // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html). type Volume struct { - // The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, - // and hyphens are allowed. This name is referenced in the sourceVolume parameter - // of container definition mountPoints. - Name *string - // This parameter is specified when you are using Docker volumes. Docker volumes // are only supported when you are using the EC2 launch type. Windows containers // only support the use of the local driver. To use bind mounts, specify the host @@ -3274,17 +3269,22 @@ type Volume struct { // example, you can mount C:\my\path:C:\my\path and D:\:D:\, but not // D:\my\path:C:\my\path or D:\:C:\my\path. Host *HostVolumeProperties + + // The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, + // and hyphens are allowed. This name is referenced in the sourceVolume parameter + // of container definition mountPoints. + Name *string } // Details on a data volume from another container in the same task definition. type VolumeFrom struct { - // The name of another container within the same task definition from which to - // mount volumes. - SourceContainer *string - // If this value is true, the container has read-only access to the volume. If this // value is false, then the container can write to the volume. The default value is // false. ReadOnly *bool + + // The name of another container within the same task definition from which to + // mount volumes. + SourceContainer *string } diff --git a/service/efs/api_op_CreateAccessPoint.go b/service/efs/api_op_CreateAccessPoint.go index 0b08a12fa7a..159902e8a5f 100644 --- a/service/efs/api_op_CreateAccessPoint.go +++ b/service/efs/api_op_CreateAccessPoint.go @@ -68,30 +68,30 @@ func (c *Client) CreateAccessPoint(ctx context.Context, params *CreateAccessPoin type CreateAccessPointInput struct { - // Specifies the directory on the Amazon EFS file system that the access point - // exposes as the root directory of your file system to NFS clients using the - // access point. The clients using the access point can only access the root - // directory and below. If the RootDirectory > Path specified does not exist, EFS - // creates it and applies the CreationInfo settings when a client connects to an - // access point. When specifying a RootDirectory, you need to provide the Path, and - // the CreationInfo is optional. - RootDirectory *types.RootDirectory - - // The ID of the EFS file system that the access point provides access to. - // - // This member is required. - FileSystemId *string - // A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent // creation. // // This member is required. ClientToken *string + // The ID of the EFS file system that the access point provides access to. + // + // This member is required. + FileSystemId *string + // The operating system user and group applied to all file system requests made // using the access point. PosixUser *types.PosixUser + // Specifies the directory on the Amazon EFS file system that the access point + // exposes as the root directory of your file system to NFS clients using the + // access point. The clients using the access point can only access the root + // directory and below. If the RootDirectory > Path specified does not exist, EFS + // creates it and applies the CreationInfo settings when a client connects to an + // access point. When specifying a RootDirectory, you need to provide the Path, and + // the CreationInfo is optional. + RootDirectory *types.RootDirectory + // Creates tags associated with the access point. Each tag is a key-value pair. Tags []*types.Tag } @@ -102,35 +102,35 @@ type CreateAccessPointOutput struct { // The unique Amazon Resource Name (ARN) associated with the access point. AccessPointArn *string - // Identified the AWS account that owns the access point resource. - OwnerId *string - // The ID of the access point, assigned by Amazon EFS. AccessPointId *string + // The opaque string specified in the request to ensure idempotent creation. + ClientToken *string + + // The ID of the EFS file system that the access point applies to. + FileSystemId *string + // Identifies the lifecycle phase of the access point. LifeCycleState types.LifeCycleState // The name of the access point. This is the value of the Name tag. Name *string - // The ID of the EFS file system that the access point applies to. - FileSystemId *string + // Identified the AWS account that owns the access point resource. + OwnerId *string - // The tags associated with the access point, presented as an array of Tag objects. - Tags []*types.Tag + // The full POSIX identity, including the user ID, group ID, and secondary group + // IDs on the access point that is used for all file operations by NFS clients + // using the access point. + PosixUser *types.PosixUser // The directory on the Amazon EFS file system that the access point exposes as the // root directory to NFS clients using the access point. RootDirectory *types.RootDirectory - // The opaque string specified in the request to ensure idempotent creation. - ClientToken *string - - // The full POSIX identity, including the user ID, group ID, and secondary group - // IDs on the access point that is used for all file operations by NFS clients - // using the access point. - PosixUser *types.PosixUser + // The tags associated with the access point, presented as an array of Tag objects. + Tags []*types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/efs/api_op_CreateFileSystem.go b/service/efs/api_op_CreateFileSystem.go index 2f79463ad06..c5e40b45f22 100644 --- a/service/efs/api_op_CreateFileSystem.go +++ b/service/efs/api_op_CreateFileSystem.go @@ -102,37 +102,11 @@ func (c *Client) CreateFileSystem(ctx context.Context, params *CreateFileSystemI type CreateFileSystemInput struct { - // The throughput, measured in MiB/s, that you want to provision for a file system - // that you're creating. Valid values are 1-1024. Required if ThroughputMode is set - // to provisioned. The upper limit for throughput is 1024 MiB/s. You can get this - // limit increased by contacting AWS Support. For more information, see Amazon EFS - // Limits That You Can Increase - // (https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the - // Amazon EFS User Guide. - ProvisionedThroughputInMibps *float64 - - // A value that specifies to create one or more tags associated with the file - // system. Each tag is a user-defined key-value pair. Name your file system on - // creation by including a "Key":"Name","Value":"{value}" key-value pair. - Tags []*types.Tag - - // The throughput mode for the file system to be created. There are two throughput - // modes to choose from for your file system: bursting and provisioned. If you set - // ThroughputMode to provisioned, you must also set a value for - // ProvisionedThroughPutInMibps. You can decrease your file system's throughput in - // Provisioned Throughput mode or change between the throughput modes as long as - // it’s been more than 24 hours since the last decrease or throughput mode change. - // For more, see Specifying Throughput with Provisioned Mode - // (https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) - // in the Amazon EFS User Guide. - ThroughputMode types.ThroughputMode - - // The performance mode of the file system. We recommend generalPurpose performance - // mode for most file systems. File systems using the maxIO performance mode can - // scale to higher levels of aggregate throughput and operations per second with a - // tradeoff of slightly higher latencies for most file operations. The performance - // mode can't be changed after the file system has been created. - PerformanceMode types.PerformanceMode + // A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent + // creation. + // + // This member is required. + CreationToken *string // A Boolean value that, if true, creates an encrypted file system. When creating // an encrypted file system, you have the option of specifying @@ -142,12 +116,6 @@ type CreateFileSystemInput struct { // encrypted file system. Encrypted *bool - // A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent - // creation. - // - // This member is required. - CreationToken *string - // The ID of the AWS KMS CMK to be used to protect the encrypted file system. This // parameter is only required if you want to use a nondefault CMK. If this // parameter is not specified, the default CMK for Amazon EFS is used. This ID can @@ -172,40 +140,63 @@ type CreateFileSystemInput struct { // accepts only symmetric CMKs. You cannot use asymmetric CMKs with EFS file // systems. KmsKeyId *string + + // The performance mode of the file system. We recommend generalPurpose performance + // mode for most file systems. File systems using the maxIO performance mode can + // scale to higher levels of aggregate throughput and operations per second with a + // tradeoff of slightly higher latencies for most file operations. The performance + // mode can't be changed after the file system has been created. + PerformanceMode types.PerformanceMode + + // The throughput, measured in MiB/s, that you want to provision for a file system + // that you're creating. Valid values are 1-1024. Required if ThroughputMode is set + // to provisioned. The upper limit for throughput is 1024 MiB/s. You can get this + // limit increased by contacting AWS Support. For more information, see Amazon EFS + // Limits That You Can Increase + // (https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the + // Amazon EFS User Guide. + ProvisionedThroughputInMibps *float64 + + // A value that specifies to create one or more tags associated with the file + // system. Each tag is a user-defined key-value pair. Name your file system on + // creation by including a "Key":"Name","Value":"{value}" key-value pair. + Tags []*types.Tag + + // The throughput mode for the file system to be created. There are two throughput + // modes to choose from for your file system: bursting and provisioned. If you set + // ThroughputMode to provisioned, you must also set a value for + // ProvisionedThroughPutInMibps. You can decrease your file system's throughput in + // Provisioned Throughput mode or change between the throughput modes as long as + // it’s been more than 24 hours since the last decrease or throughput mode change. + // For more, see Specifying Throughput with Provisioned Mode + // (https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) + // in the Amazon EFS User Guide. + ThroughputMode types.ThroughputMode } // A description of the file system. type CreateFileSystemOutput struct { - // The latest known metered size (in bytes) of data stored in the file system, in - // its Value field, and the time at which that size was determined in its Timestamp - // field. The Timestamp value is the integer number of seconds since - // 1970-01-01T00:00:00Z. The SizeInBytes value doesn't represent the size of a - // consistent snapshot of the file system, but it is eventually consistent when - // there are no writes to the file system. That is, SizeInBytes represents actual - // size only if the file system is not modified for a period longer than a couple - // of hours. Otherwise, the value is not the exact size that the file system was at - // any point in time. - // - // This member is required. - SizeInBytes *types.FileSystemSize - // The time that the file system was created, in seconds (since // 1970-01-01T00:00:00Z). // // This member is required. CreationTime *time.Time - // The AWS account that created the file system. If the file system was created by - // an IAM user, the parent account to which the user belongs is the owner. + // The opaque string specified in the request. // // This member is required. - OwnerId *string + CreationToken *string - // The tags associated with the file system, presented as an array of Tag objects. + // The ID of the file system, assigned by Amazon EFS. // // This member is required. - Tags []*types.Tag + FileSystemId *string + + // The lifecycle phase of the file system. + // + // This member is required. + LifeCycleState types.LifeCycleState // The current number of mount targets that the file system has. For more // information, see CreateMountTarget (). @@ -213,19 +204,53 @@ type CreateFileSystemOutput struct { // This member is required. NumberOfMountTargets *int32 + // The AWS account that created the file system. If the file system was created by + // an IAM user, the parent account to which the user belongs is the owner. + // + // This member is required. + OwnerId *string + // The performance mode of the file system. // // This member is required. PerformanceMode types.PerformanceMode - // The opaque string specified in the request. + // The latest known metered size (in bytes) of data stored in the file system, in + // its Value field, and the time at which that size was determined in its Timestamp + // field. The Timestamp value is the integer number of seconds since + // 1970-01-01T00:00:00Z. The SizeInBytes value doesn't represent the size of a + // consistent snapshot of the file system, but it is eventually consistent when + // there are no writes to the file system. That is, SizeInBytes represents actual + // size only if the file system is not modified for a period longer than a couple + // of hours. Otherwise, the value is not the exact size that the file system was at + // any point in time. // // This member is required. - CreationToken *string + SizeInBytes *types.FileSystemSize + + // The tags associated with the file system, presented as an array of Tag objects. + // + // This member is required. + Tags []*types.Tag // A Boolean value that, if true, indicates that the file system is encrypted. Encrypted *bool + // The Amazon Resource Name (ARN) for the EFS file system, in the format + // arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . Example + // with sample data: + // arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567 + FileSystemArn *string + + // The ID of an AWS Key Management Service (AWS KMS) customer master key (CMK) that + // was used to protect the encrypted file system. + KmsKeyId *string + + // You can add tags to a file system, including a Name tag. For more information, + // see CreateFileSystem (). If the file system has a Name tag, Amazon EFS returns + // the value in this field. + Name *string + // The throughput, measured in MiB/s, that you want to provision for a file system. // Valid values are 1-1024. Required if ThroughputMode is set to provisioned. The // limit on throughput is 1024 MiB/s. You can get these limits increased by @@ -234,21 +259,6 @@ type CreateFileSystemOutput struct { // the Amazon EFS User Guide. ProvisionedThroughputInMibps *float64 - // The lifecycle phase of the file system. - // - // This member is required. - LifeCycleState types.LifeCycleState - - // The ID of the file system, assigned by Amazon EFS. - // - // This member is required. - FileSystemId *string - - // You can add tags to a file system, including a Name tag. For more information, - // see CreateFileSystem (). If the file system has a Name tag, Amazon EFS returns - // the value in this field. - Name *string - // The throughput mode for a file system. There are two throughput modes to choose // from for your file system: bursting and provisioned. If you set ThroughputMode // to provisioned, you must also set a value for ProvisionedThroughPutInMibps. You @@ -257,16 +267,6 @@ type CreateFileSystemOutput struct { // since the last decrease or throughput mode change. ThroughputMode types.ThroughputMode - // The Amazon Resource Name (ARN) for the EFS file system, in the format - // arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . Example - // with sample data: - // arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567 - FileSystemArn *string - - // The ID of an AWS Key Management Service (AWS KMS) customer master key (CMK) that - // was used to protect the encrypted file system. - KmsKeyId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/efs/api_op_CreateMountTarget.go b/service/efs/api_op_CreateMountTarget.go index e95eab9c405..f7c95998d3e 100644 --- a/service/efs/api_op_CreateMountTarget.go +++ b/service/efs/api_op_CreateMountTarget.go @@ -135,6 +135,11 @@ func (c *Client) CreateMountTarget(ctx context.Context, params *CreateMountTarge // type CreateMountTargetInput struct { + // The ID of the file system for which to create the mount target. + // + // This member is required. + FileSystemId *string + // The ID of the subnet to add the mount target in. // // This member is required. @@ -146,27 +151,31 @@ type CreateMountTargetInput struct { // Up to five VPC security group IDs, of the form sg-xxxxxxxx. These must be for // the same VPC as subnet specified. SecurityGroups []*string - - // The ID of the file system for which to create the mount target. - // - // This member is required. - FileSystemId *string } // Provides a description of a mount target. type CreateMountTargetOutput struct { - // Address at which the file system can be mounted by using the mount target. - IpAddress *string - - // AWS account ID that owns the resource. - OwnerId *string + // The ID of the file system for which the mount target is intended. + // + // This member is required. + FileSystemId *string // Lifecycle state of the mount target. // // This member is required. LifeCycleState types.LifeCycleState + // System-assigned mount target ID. + // + // This member is required. + MountTargetId *string + + // The ID of the mount target's subnet. + // + // This member is required. + SubnetId *string + // The unique and consistent identifier of the Availability Zone (AZ) that the // mount target resides in. For example, use1-az1 is an AZ ID for the us-east-1 // Region and it has the same location in every AWS account. @@ -178,24 +187,15 @@ type CreateMountTargetOutput struct { // as us-east-1a for another AWS account. AvailabilityZoneName *string - // The ID of the mount target's subnet. - // - // This member is required. - SubnetId *string - - // System-assigned mount target ID. - // - // This member is required. - MountTargetId *string + // Address at which the file system can be mounted by using the mount target. + IpAddress *string // The ID of the network interface that Amazon EFS created when it created the // mount target. NetworkInterfaceId *string - // The ID of the file system for which the mount target is intended. - // - // This member is required. - FileSystemId *string + // AWS account ID that owns the resource. + OwnerId *string // The Virtual Private Cloud (VPC) ID that the mount target is configured in. VpcId *string diff --git a/service/efs/api_op_DeleteTags.go b/service/efs/api_op_DeleteTags.go index 5fb06ba19c0..5b099328d9b 100644 --- a/service/efs/api_op_DeleteTags.go +++ b/service/efs/api_op_DeleteTags.go @@ -63,15 +63,15 @@ func (c *Client) DeleteTags(ctx context.Context, params *DeleteTagsInput, optFns // type DeleteTagsInput struct { - // A list of tag keys to delete. + // The ID of the file system whose tags you want to delete (String). // // This member is required. - TagKeys []*string + FileSystemId *string - // The ID of the file system whose tags you want to delete (String). + // A list of tag keys to delete. // // This member is required. - FileSystemId *string + TagKeys []*string } type DeleteTagsOutput struct { diff --git a/service/efs/api_op_DescribeAccessPoints.go b/service/efs/api_op_DescribeAccessPoints.go index a79edee79d4..da7c1f15e4d 100644 --- a/service/efs/api_op_DescribeAccessPoints.go +++ b/service/efs/api_op_DescribeAccessPoints.go @@ -60,6 +60,14 @@ func (c *Client) DescribeAccessPoints(ctx context.Context, params *DescribeAcces type DescribeAccessPointsInput struct { + // (Optional) Specifies an EFS access point to describe in the response; mutually + // exclusive with FileSystemId. + AccessPointId *string + + // (Optional) If you provide a FileSystemId, EFS returns all access points for that + // file system; mutually exclusive with AccessPointId. + FileSystemId *string + // (Optional) When retrieving all access points for a file system, you can // optionally specify the MaxItems parameter to limit the number of objects // returned in a response. The default value is 100. @@ -68,14 +76,6 @@ type DescribeAccessPointsInput struct { // NextToken is present if the response is paginated. You can use NextMarker in the // subsequent request to fetch the next page of access point descriptions. NextToken *string - - // (Optional) Specifies an EFS access point to describe in the response; mutually - // exclusive with FileSystemId. - AccessPointId *string - - // (Optional) If you provide a FileSystemId, EFS returns all access points for that - // file system; mutually exclusive with AccessPointId. - FileSystemId *string } type DescribeAccessPointsOutput struct { diff --git a/service/efs/api_op_DescribeFileSystems.go b/service/efs/api_op_DescribeFileSystems.go index 41047115131..328b61dfbb7 100644 --- a/service/efs/api_op_DescribeFileSystems.go +++ b/service/efs/api_op_DescribeFileSystems.go @@ -81,15 +81,15 @@ type DescribeFileSystemsInput struct { // system. CreationToken *string + // (Optional) ID of the file system whose description you want to retrieve + // (String). + FileSystemId *string + // (Optional) Opaque pagination token returned from a previous DescribeFileSystems // operation (String). If present, specifies to continue the list from where the // returning call had left off. Marker *string - // (Optional) ID of the file system whose description you want to retrieve - // (String). - FileSystemId *string - // (Optional) Specifies the maximum number of file systems to return in the // response (integer). This number is automatically set to 100. The response is // paginated at 100 per page if you have more than 100 file systems. @@ -98,16 +98,16 @@ type DescribeFileSystemsInput struct { type DescribeFileSystemsOutput struct { - // Present if there are more file systems than returned in the response (String). - // You can use the NextMarker in the subsequent request to fetch the descriptions. - NextMarker *string - // An array of file system descriptions. FileSystems []*types.FileSystemDescription // Present if provided by caller in the request (String). Marker *string + // Present if there are more file systems than returned in the response (String). + // You can use the NextMarker in the subsequent request to fetch the descriptions. + NextMarker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/efs/api_op_DescribeMountTargets.go b/service/efs/api_op_DescribeMountTargets.go index 4aedea472f9..51c39f0ef11 100644 --- a/service/efs/api_op_DescribeMountTargets.go +++ b/service/efs/api_op_DescribeMountTargets.go @@ -63,43 +63,43 @@ func (c *Client) DescribeMountTargets(ctx context.Context, params *DescribeMount // type DescribeMountTargetsInput struct { - // (Optional) ID of the mount target that you want to have described (String). It - // must be included in your request if FileSystemId is not included. Accepts either - // a mount target ID or ARN as input. - MountTargetId *string + // (Optional) The ID of the access point whose mount targets that you want to list. + // It must be included in your request if a FileSystemId or MountTargetId is not + // included in your request. Accepts either an access point ID or ARN as input. + AccessPointId *string // (Optional) ID of the file system whose mount targets you want to list (String). // It must be included in your request if an AccessPointId or MountTargetId is not // included. Accepts either a file system ID or ARN as input. FileSystemId *string + // (Optional) Opaque pagination token returned from a previous DescribeMountTargets + // operation (String). If present, it specifies to continue the list from where the + // previous returning call left off. + Marker *string + // (Optional) Maximum number of mount targets to return in the response. Currently, // this number is automatically set to 10, and other values are ignored. The // response is paginated at 100 per page if you have more than 100 mount targets. MaxItems *int32 - // (Optional) The ID of the access point whose mount targets that you want to list. - // It must be included in your request if a FileSystemId or MountTargetId is not - // included in your request. Accepts either an access point ID or ARN as input. - AccessPointId *string - - // (Optional) Opaque pagination token returned from a previous DescribeMountTargets - // operation (String). If present, it specifies to continue the list from where the - // previous returning call left off. - Marker *string + // (Optional) ID of the mount target that you want to have described (String). It + // must be included in your request if FileSystemId is not included. Accepts either + // a mount target ID or ARN as input. + MountTargetId *string } // type DescribeMountTargetsOutput struct { - // Returns the file system's mount targets as an array of MountTargetDescription - // objects. - MountTargets []*types.MountTargetDescription - // If the request included the Marker, the response returns that value in this // field. Marker *string + // Returns the file system's mount targets as an array of MountTargetDescription + // objects. + MountTargets []*types.MountTargetDescription + // If a value is present, there are more mount targets to return. In a subsequent // request, you can provide Marker in your request with this value to retrieve the // next set of mount targets. diff --git a/service/efs/api_op_DescribeTags.go b/service/efs/api_op_DescribeTags.go index f43fe81c383..60e14f91dcb 100644 --- a/service/efs/api_op_DescribeTags.go +++ b/service/efs/api_op_DescribeTags.go @@ -62,39 +62,39 @@ func (c *Client) DescribeTags(ctx context.Context, params *DescribeTagsInput, op // type DescribeTagsInput struct { - // (Optional) The maximum number of file system tags to return in the response. - // Currently, this number is automatically set to 100, and other values are - // ignored. The response is paginated at 100 per page if you have more than 100 - // tags. - MaxItems *int32 + // The ID of the file system whose tag set you want to retrieve. + // + // This member is required. + FileSystemId *string // (Optional) An opaque pagination token returned from a previous DescribeTags // operation (String). If present, it specifies to continue the list from where the // previous call left off. Marker *string - // The ID of the file system whose tag set you want to retrieve. - // - // This member is required. - FileSystemId *string + // (Optional) The maximum number of file system tags to return in the response. + // Currently, this number is automatically set to 100, and other values are + // ignored. The response is paginated at 100 per page if you have more than 100 + // tags. + MaxItems *int32 } // type DescribeTagsOutput struct { - // If a value is present, there are more tags to return. In a subsequent request, - // you can provide the value of NextMarker as the value of the Marker parameter in - // your next request to retrieve the next set of tags. - NextMarker *string - - // If the request included a Marker, the response returns that value in this field. - Marker *string - // Returns tags associated with the file system as an array of Tag objects. // // This member is required. Tags []*types.Tag + // If the request included a Marker, the response returns that value in this field. + Marker *string + + // If a value is present, there are more tags to return. In a subsequent request, + // you can provide the value of NextMarker as the value of the Marker parameter in + // your next request to retrieve the next set of tags. + NextMarker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/efs/api_op_ListTagsForResource.go b/service/efs/api_op_ListTagsForResource.go index dcbf1c475e7..616f239b375 100644 --- a/service/efs/api_op_ListTagsForResource.go +++ b/service/efs/api_op_ListTagsForResource.go @@ -59,30 +59,30 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // You can use NextToken in a subsequent request to fetch the next page of access - // point descriptions if the response payload was paginated. - NextToken *string - - // (Optional) Specifies the maximum number of tag objects to return in the - // response. The default value is 100. - MaxResults *int32 - // Specifies the EFS resource you want to retrieve tags for. You can retrieve tags // for EFS file systems and access points using this API endpoint. // // This member is required. ResourceId *string + + // (Optional) Specifies the maximum number of tag objects to return in the + // response. The default value is 100. + MaxResults *int32 + + // You can use NextToken in a subsequent request to fetch the next page of access + // point descriptions if the response payload was paginated. + NextToken *string } type ListTagsForResourceOutput struct { - // An array of the tags for the specified EFS resource. - Tags []*types.Tag - // NextToken is present if the response payload is paginated. You can use NextToken // in a subsequent request to fetch the next page of access point descriptions. NextToken *string + // An array of the tags for the specified EFS resource. + Tags []*types.Tag + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/efs/api_op_ModifyMountTargetSecurityGroups.go b/service/efs/api_op_ModifyMountTargetSecurityGroups.go index 67a28656e76..76dd1469a30 100644 --- a/service/efs/api_op_ModifyMountTargetSecurityGroups.go +++ b/service/efs/api_op_ModifyMountTargetSecurityGroups.go @@ -71,13 +71,13 @@ func (c *Client) ModifyMountTargetSecurityGroups(ctx context.Context, params *Mo // type ModifyMountTargetSecurityGroupsInput struct { - // An array of up to five VPC security group IDs. - SecurityGroups []*string - // The ID of the mount target whose security groups you want to modify. // // This member is required. MountTargetId *string + + // An array of up to five VPC security group IDs. + SecurityGroups []*string } type ModifyMountTargetSecurityGroupsOutput struct { diff --git a/service/efs/api_op_PutFileSystemPolicy.go b/service/efs/api_op_PutFileSystemPolicy.go index b4e3a8ece55..4ec98ec85c4 100644 --- a/service/efs/api_op_PutFileSystemPolicy.go +++ b/service/efs/api_op_PutFileSystemPolicy.go @@ -71,6 +71,14 @@ type PutFileSystemPolicyInput struct { // This member is required. FileSystemId *string + // The FileSystemPolicy that you're creating. Accepts a JSON formatted policy + // definition. To find out more about the elements that make up a file system + // policy, see EFS Resource-based Policies + // (https://docs.aws.amazon.com/efs/latest/ug/access-control-overview.html#access-control-manage-access-intro-resource-policies). + // + // This member is required. + Policy *string + // (Optional) A flag to indicate whether to bypass the FileSystemPolicy lockout // safety check. The policy lockout safety check determines whether the policy in // the request will prevent the principal making the request will be locked out @@ -79,14 +87,6 @@ type PutFileSystemPolicyInput struct { // principal that is making the request from making a subsequent // PutFileSystemPolicy request on the file system. The default value is False. BypassPolicyLockoutSafetyCheck *bool - - // The FileSystemPolicy that you're creating. Accepts a JSON formatted policy - // definition. To find out more about the elements that make up a file system - // policy, see EFS Resource-based Policies - // (https://docs.aws.amazon.com/efs/latest/ug/access-control-overview.html#access-control-manage-access-intro-resource-policies). - // - // This member is required. - Policy *string } type PutFileSystemPolicyOutput struct { diff --git a/service/efs/api_op_TagResource.go b/service/efs/api_op_TagResource.go index edb386a1700..ea393a51fb5 100644 --- a/service/efs/api_op_TagResource.go +++ b/service/efs/api_op_TagResource.go @@ -59,15 +59,15 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // + // The ID specifying the EFS resource that you want to create a tag for. // // This member is required. - Tags []*types.Tag + ResourceId *string - // The ID specifying the EFS resource that you want to create a tag for. + // // // This member is required. - ResourceId *string + Tags []*types.Tag } type TagResourceOutput struct { diff --git a/service/efs/api_op_UpdateFileSystem.go b/service/efs/api_op_UpdateFileSystem.go index 983c8f90280..7e4e5c661b5 100644 --- a/service/efs/api_op_UpdateFileSystem.go +++ b/service/efs/api_op_UpdateFileSystem.go @@ -59,11 +59,10 @@ func (c *Client) UpdateFileSystem(ctx context.Context, params *UpdateFileSystemI type UpdateFileSystemInput struct { - // (Optional) The throughput mode that you want your file system to use. If you're - // not updating your throughput mode, you don't need to provide this value in your - // request. If you are changing the ThroughputMode to provisioned, you must also - // set a value for ProvisionedThroughputInMibps. - ThroughputMode types.ThroughputMode + // The ID of the file system that you want to update. + // + // This member is required. + FileSystemId *string // (Optional) The amount of throughput, in MiB/s, that you want to provision for // your file system. Valid values are 1-1024. Required if ThroughputMode is changed @@ -72,44 +71,36 @@ type UpdateFileSystemInput struct { // request. ProvisionedThroughputInMibps *float64 - // The ID of the file system that you want to update. - // - // This member is required. - FileSystemId *string + // (Optional) The throughput mode that you want your file system to use. If you're + // not updating your throughput mode, you don't need to provide this value in your + // request. If you are changing the ThroughputMode to provisioned, you must also + // set a value for ProvisionedThroughputInMibps. + ThroughputMode types.ThroughputMode } // A description of the file system. type UpdateFileSystemOutput struct { - // The latest known metered size (in bytes) of data stored in the file system, in - // its Value field, and the time at which that size was determined in its Timestamp - // field. The Timestamp value is the integer number of seconds since - // 1970-01-01T00:00:00Z. The SizeInBytes value doesn't represent the size of a - // consistent snapshot of the file system, but it is eventually consistent when - // there are no writes to the file system. That is, SizeInBytes represents actual - // size only if the file system is not modified for a period longer than a couple - // of hours. Otherwise, the value is not the exact size that the file system was at - // any point in time. - // - // This member is required. - SizeInBytes *types.FileSystemSize - // The time that the file system was created, in seconds (since // 1970-01-01T00:00:00Z). // // This member is required. CreationTime *time.Time - // The AWS account that created the file system. If the file system was created by - // an IAM user, the parent account to which the user belongs is the owner. + // The opaque string specified in the request. // // This member is required. - OwnerId *string + CreationToken *string - // The tags associated with the file system, presented as an array of Tag objects. + // The ID of the file system, assigned by Amazon EFS. // // This member is required. - Tags []*types.Tag + FileSystemId *string + + // The lifecycle phase of the file system. + // + // This member is required. + LifeCycleState types.LifeCycleState // The current number of mount targets that the file system has. For more // information, see CreateMountTarget (). @@ -117,19 +108,53 @@ type UpdateFileSystemOutput struct { // This member is required. NumberOfMountTargets *int32 + // The AWS account that created the file system. If the file system was created by + // an IAM user, the parent account to which the user belongs is the owner. + // + // This member is required. + OwnerId *string + // The performance mode of the file system. // // This member is required. PerformanceMode types.PerformanceMode - // The opaque string specified in the request. + // The latest known metered size (in bytes) of data stored in the file system, in + // its Value field, and the time at which that size was determined in its Timestamp + // field. The Timestamp value is the integer number of seconds since + // 1970-01-01T00:00:00Z. The SizeInBytes value doesn't represent the size of a + // consistent snapshot of the file system, but it is eventually consistent when + // there are no writes to the file system. That is, SizeInBytes represents actual + // size only if the file system is not modified for a period longer than a couple + // of hours. Otherwise, the value is not the exact size that the file system was at + // any point in time. // // This member is required. - CreationToken *string + SizeInBytes *types.FileSystemSize + + // The tags associated with the file system, presented as an array of Tag objects. + // + // This member is required. + Tags []*types.Tag // A Boolean value that, if true, indicates that the file system is encrypted. Encrypted *bool + // The Amazon Resource Name (ARN) for the EFS file system, in the format + // arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . Example + // with sample data: + // arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567 + FileSystemArn *string + + // The ID of an AWS Key Management Service (AWS KMS) customer master key (CMK) that + // was used to protect the encrypted file system. + KmsKeyId *string + + // You can add tags to a file system, including a Name tag. For more information, + // see CreateFileSystem (). If the file system has a Name tag, Amazon EFS returns + // the value in this field. + Name *string + // The throughput, measured in MiB/s, that you want to provision for a file system. // Valid values are 1-1024. Required if ThroughputMode is set to provisioned. The // limit on throughput is 1024 MiB/s. You can get these limits increased by @@ -138,21 +163,6 @@ type UpdateFileSystemOutput struct { // the Amazon EFS User Guide. ProvisionedThroughputInMibps *float64 - // The lifecycle phase of the file system. - // - // This member is required. - LifeCycleState types.LifeCycleState - - // The ID of the file system, assigned by Amazon EFS. - // - // This member is required. - FileSystemId *string - - // You can add tags to a file system, including a Name tag. For more information, - // see CreateFileSystem (). If the file system has a Name tag, Amazon EFS returns - // the value in this field. - Name *string - // The throughput mode for a file system. There are two throughput modes to choose // from for your file system: bursting and provisioned. If you set ThroughputMode // to provisioned, you must also set a value for ProvisionedThroughPutInMibps. You @@ -161,16 +171,6 @@ type UpdateFileSystemOutput struct { // since the last decrease or throughput mode change. ThroughputMode types.ThroughputMode - // The Amazon Resource Name (ARN) for the EFS file system, in the format - // arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . Example - // with sample data: - // arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567 - FileSystemArn *string - - // The ID of an AWS Key Management Service (AWS KMS) customer master key (CMK) that - // was used to protect the encrypted file system. - KmsKeyId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/efs/go.mod b/service/efs/go.mod index 9ca1eb389d6..d8c1c872d96 100644 --- a/service/efs/go.mod +++ b/service/efs/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/efs go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/efs/types/types.go b/service/efs/types/types.go index d34456bbb65..bdb849f34dd 100644 --- a/service/efs/types/types.go +++ b/service/efs/types/types.go @@ -12,35 +12,35 @@ type AccessPointDescription struct { // The unique Amazon Resource Name (ARN) associated with the access point. AccessPointArn *string - // Identified the AWS account that owns the access point resource. - OwnerId *string - // The ID of the access point, assigned by Amazon EFS. AccessPointId *string + // The opaque string specified in the request to ensure idempotent creation. + ClientToken *string + + // The ID of the EFS file system that the access point applies to. + FileSystemId *string + // Identifies the lifecycle phase of the access point. LifeCycleState LifeCycleState // The name of the access point. This is the value of the Name tag. Name *string - // The ID of the EFS file system that the access point applies to. - FileSystemId *string + // Identified the AWS account that owns the access point resource. + OwnerId *string - // The tags associated with the access point, presented as an array of Tag objects. - Tags []*Tag + // The full POSIX identity, including the user ID, group ID, and secondary group + // IDs on the access point that is used for all file operations by NFS clients + // using the access point. + PosixUser *PosixUser // The directory on the Amazon EFS file system that the access point exposes as the // root directory to NFS clients using the access point. RootDirectory *RootDirectory - // The opaque string specified in the request to ensure idempotent creation. - ClientToken *string - - // The full POSIX identity, including the user ID, group ID, and secondary group - // IDs on the access point that is used for all file operations by NFS clients - // using the access point. - PosixUser *PosixUser + // The tags associated with the access point, presented as an array of Tag objects. + Tags []*Tag } // The backup policy for the file system, showing the curent status. If ENABLED, @@ -96,35 +96,26 @@ type CreationInfo struct { // A description of the file system. type FileSystemDescription struct { - // The latest known metered size (in bytes) of data stored in the file system, in - // its Value field, and the time at which that size was determined in its Timestamp - // field. The Timestamp value is the integer number of seconds since - // 1970-01-01T00:00:00Z. The SizeInBytes value doesn't represent the size of a - // consistent snapshot of the file system, but it is eventually consistent when - // there are no writes to the file system. That is, SizeInBytes represents actual - // size only if the file system is not modified for a period longer than a couple - // of hours. Otherwise, the value is not the exact size that the file system was at - // any point in time. - // - // This member is required. - SizeInBytes *FileSystemSize - // The time that the file system was created, in seconds (since // 1970-01-01T00:00:00Z). // // This member is required. CreationTime *time.Time - // The AWS account that created the file system. If the file system was created by - // an IAM user, the parent account to which the user belongs is the owner. + // The opaque string specified in the request. // // This member is required. - OwnerId *string + CreationToken *string - // The tags associated with the file system, presented as an array of Tag objects. + // The ID of the file system, assigned by Amazon EFS. // // This member is required. - Tags []*Tag + FileSystemId *string + + // The lifecycle phase of the file system. + // + // This member is required. + LifeCycleState LifeCycleState // The current number of mount targets that the file system has. For more // information, see CreateMountTarget (). @@ -132,19 +123,53 @@ type FileSystemDescription struct { // This member is required. NumberOfMountTargets *int32 + // The AWS account that created the file system. If the file system was created by + // an IAM user, the parent account to which the user belongs is the owner. + // + // This member is required. + OwnerId *string + // The performance mode of the file system. // // This member is required. PerformanceMode PerformanceMode - // The opaque string specified in the request. + // The latest known metered size (in bytes) of data stored in the file system, in + // its Value field, and the time at which that size was determined in its Timestamp + // field. The Timestamp value is the integer number of seconds since + // 1970-01-01T00:00:00Z. The SizeInBytes value doesn't represent the size of a + // consistent snapshot of the file system, but it is eventually consistent when + // there are no writes to the file system. That is, SizeInBytes represents actual + // size only if the file system is not modified for a period longer than a couple + // of hours. Otherwise, the value is not the exact size that the file system was at + // any point in time. // // This member is required. - CreationToken *string + SizeInBytes *FileSystemSize + + // The tags associated with the file system, presented as an array of Tag objects. + // + // This member is required. + Tags []*Tag // A Boolean value that, if true, indicates that the file system is encrypted. Encrypted *bool + // The Amazon Resource Name (ARN) for the EFS file system, in the format + // arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . Example + // with sample data: + // arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567 + FileSystemArn *string + + // The ID of an AWS Key Management Service (AWS KMS) customer master key (CMK) that + // was used to protect the encrypted file system. + KmsKeyId *string + + // You can add tags to a file system, including a Name tag. For more information, + // see CreateFileSystem (). If the file system has a Name tag, Amazon EFS returns + // the value in this field. + Name *string + // The throughput, measured in MiB/s, that you want to provision for a file system. // Valid values are 1-1024. Required if ThroughputMode is set to provisioned. The // limit on throughput is 1024 MiB/s. You can get these limits increased by @@ -153,21 +178,6 @@ type FileSystemDescription struct { // the Amazon EFS User Guide. ProvisionedThroughputInMibps *float64 - // The lifecycle phase of the file system. - // - // This member is required. - LifeCycleState LifeCycleState - - // The ID of the file system, assigned by Amazon EFS. - // - // This member is required. - FileSystemId *string - - // You can add tags to a file system, including a Name tag. For more information, - // see CreateFileSystem (). If the file system has a Name tag, Amazon EFS returns - // the value in this field. - Name *string - // The throughput mode for a file system. There are two throughput modes to choose // from for your file system: bursting and provisioned. If you set ThroughputMode // to provisioned, you must also set a value for ProvisionedThroughPutInMibps. You @@ -175,16 +185,6 @@ type FileSystemDescription struct { // change between the throughput modes as long as it’s been more than 24 hours // since the last decrease or throughput mode change. ThroughputMode ThroughputMode - - // The Amazon Resource Name (ARN) for the EFS file system, in the format - // arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . Example - // with sample data: - // arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567 - FileSystemArn *string - - // The ID of an AWS Key Management Service (AWS KMS) customer master key (CMK) that - // was used to protect the encrypted file system. - KmsKeyId *string } // The latest known metered size (in bytes) of data stored in the file system, in @@ -201,6 +201,10 @@ type FileSystemSize struct { // This member is required. Value *int64 + // The time at which the size of data, returned in the Value field, was determined. + // The value is the integer number of seconds since 1970-01-01T00:00:00Z. + Timestamp *time.Time + // The latest known metered size (in bytes) of data stored in the Infrequent Access // storage class. ValueInIA *int64 @@ -208,10 +212,6 @@ type FileSystemSize struct { // The latest known metered size (in bytes) of data stored in the Standard storage // class. ValueInStandard *int64 - - // The time at which the size of data, returned in the Value field, was determined. - // The value is the integer number of seconds since 1970-01-01T00:00:00Z. - Timestamp *time.Time } // Describes a policy used by EFS lifecycle management to transition files to the @@ -227,17 +227,26 @@ type LifecyclePolicy struct { // Provides a description of a mount target. type MountTargetDescription struct { - // Address at which the file system can be mounted by using the mount target. - IpAddress *string - - // AWS account ID that owns the resource. - OwnerId *string + // The ID of the file system for which the mount target is intended. + // + // This member is required. + FileSystemId *string // Lifecycle state of the mount target. // // This member is required. LifeCycleState LifeCycleState + // System-assigned mount target ID. + // + // This member is required. + MountTargetId *string + + // The ID of the mount target's subnet. + // + // This member is required. + SubnetId *string + // The unique and consistent identifier of the Availability Zone (AZ) that the // mount target resides in. For example, use1-az1 is an AZ ID for the us-east-1 // Region and it has the same location in every AWS account. @@ -249,24 +258,15 @@ type MountTargetDescription struct { // as us-east-1a for another AWS account. AvailabilityZoneName *string - // The ID of the mount target's subnet. - // - // This member is required. - SubnetId *string - - // System-assigned mount target ID. - // - // This member is required. - MountTargetId *string + // Address at which the file system can be mounted by using the mount target. + IpAddress *string // The ID of the network interface that Amazon EFS created when it created the // mount target. NetworkInterfaceId *string - // The ID of the file system for which the mount target is intended. - // - // This member is required. - FileSystemId *string + // AWS account ID that owns the resource. + OwnerId *string // The Virtual Private Cloud (VPC) ID that the mount target is configured in. VpcId *string diff --git a/service/eks/api_op_CreateCluster.go b/service/eks/api_op_CreateCluster.go index b57c60b3796..7e1cf8fa000 100644 --- a/service/eks/api_op_CreateCluster.go +++ b/service/eks/api_op_CreateCluster.go @@ -92,20 +92,33 @@ func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, type CreateClusterInput struct { - // Enable or disable exporting the Kubernetes control plane logs for your cluster - // to CloudWatch Logs. By default, cluster control plane logs aren't exported to - // CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs - // (https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html) in - // the Amazon EKS User Guide . CloudWatch Logs ingestion, archive storage, and data - // scanning rates apply to exported control plane logs. For more information, see - // Amazon CloudWatch Pricing (http://aws.amazon.com/cloudwatch/pricing/). - Logging *types.Logging - // The unique name to give to your cluster. // // This member is required. Name *string + // The VPC configuration used by the cluster control plane. Amazon EKS VPC + // resources have specific requirements to work properly with Kubernetes. For more + // information, see Cluster VPC Considerations + // (https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html) and Cluster + // Security Group Considerations + // (https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) in the + // Amazon EKS User Guide. You must specify at least two subnets. You can specify up + // to five security groups, but we recommend that you use a dedicated security + // group for your cluster control plane. + // + // This member is required. + ResourcesVpcConfig *types.VpcConfigRequest + + // The Amazon Resource Name (ARN) of the IAM role that provides permissions for + // Amazon EKS to make calls to other AWS API operations on your behalf. For more + // information, see Amazon EKS Service IAM Role + // (https://docs.aws.amazon.com/eks/latest/userguide/service_IAM_role.html) in the + // Amazon EKS User Guide . + // + // This member is required. + RoleArn *string + // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. ClientRequestToken *string @@ -113,6 +126,15 @@ type CreateClusterInput struct { // The encryption configuration for the cluster. EncryptionConfig []*types.EncryptionConfig + // Enable or disable exporting the Kubernetes control plane logs for your cluster + // to CloudWatch Logs. By default, cluster control plane logs aren't exported to + // CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs + // (https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html) in + // the Amazon EKS User Guide . CloudWatch Logs ingestion, archive storage, and data + // scanning rates apply to exported control plane logs. For more information, see + // Amazon CloudWatch Pricing (http://aws.amazon.com/cloudwatch/pricing/). + Logging *types.Logging + // The metadata to apply to the cluster to assist with categorization and // organization. Each tag consists of a key and an optional value, both of which // you define. @@ -121,28 +143,6 @@ type CreateClusterInput struct { // The desired Kubernetes version for your cluster. If you don't specify a value // here, the latest version available in Amazon EKS is used. Version *string - - // The Amazon Resource Name (ARN) of the IAM role that provides permissions for - // Amazon EKS to make calls to other AWS API operations on your behalf. For more - // information, see Amazon EKS Service IAM Role - // (https://docs.aws.amazon.com/eks/latest/userguide/service_IAM_role.html) in the - // Amazon EKS User Guide . - // - // This member is required. - RoleArn *string - - // The VPC configuration used by the cluster control plane. Amazon EKS VPC - // resources have specific requirements to work properly with Kubernetes. For more - // information, see Cluster VPC Considerations - // (https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html) and Cluster - // Security Group Considerations - // (https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) in the - // Amazon EKS User Guide. You must specify at least two subnets. You can specify up - // to five security groups, but we recommend that you use a dedicated security - // group for your cluster control plane. - // - // This member is required. - ResourcesVpcConfig *types.VpcConfigRequest } type CreateClusterOutput struct { diff --git a/service/eks/api_op_CreateFargateProfile.go b/service/eks/api_op_CreateFargateProfile.go index e2e1b48b34e..2bd74498876 100644 --- a/service/eks/api_op_CreateFargateProfile.go +++ b/service/eks/api_op_CreateFargateProfile.go @@ -85,22 +85,15 @@ func (c *Client) CreateFargateProfile(ctx context.Context, params *CreateFargate type CreateFargateProfileInput struct { - // The IDs of subnets to launch your pods into. At this time, pods running on - // Fargate are not assigned public IP addresses, so only private subnets (with no - // direct route to an Internet Gateway) are accepted for this parameter. - Subnets []*string - - // The selectors to match for pods to use this Fargate profile. Each selector must - // have an associated namespace. Optionally, you can also specify labels for a - // namespace. You may specify up to five selectors in a Fargate profile. - Selectors []*types.FargateProfileSelector + // The name of the Amazon EKS cluster to apply the Fargate profile to. + // + // This member is required. + ClusterName *string - // The metadata to apply to the Fargate profile to assist with categorization and - // organization. Each tag consists of a key and an optional value, both of which - // you define. Fargate profile tags do not propagate to any other resources - // associated with the Fargate profile, such as the pods that are scheduled with - // it. - Tags map[string]*string + // The name of the Fargate profile. + // + // This member is required. + FargateProfileName *string // The Amazon Resource Name (ARN) of the pod execution role to use for pods that // match the selectors in the Fargate profile. The pod execution role allows @@ -113,19 +106,26 @@ type CreateFargateProfileInput struct { // This member is required. PodExecutionRoleArn *string - // The name of the Fargate profile. - // - // This member is required. - FargateProfileName *string - - // The name of the Amazon EKS cluster to apply the Fargate profile to. - // - // This member is required. - ClusterName *string - // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. ClientRequestToken *string + + // The selectors to match for pods to use this Fargate profile. Each selector must + // have an associated namespace. Optionally, you can also specify labels for a + // namespace. You may specify up to five selectors in a Fargate profile. + Selectors []*types.FargateProfileSelector + + // The IDs of subnets to launch your pods into. At this time, pods running on + // Fargate are not assigned public IP addresses, so only private subnets (with no + // direct route to an Internet Gateway) are accepted for this parameter. + Subnets []*string + + // The metadata to apply to the Fargate profile to assist with categorization and + // organization. Each tag consists of a key and an optional value, both of which + // you define. Fargate profile tags do not propagate to any other resources + // associated with the Fargate profile, such as the pods that are scheduled with + // it. + Tags map[string]*string } type CreateFargateProfileOutput struct { diff --git a/service/eks/api_op_CreateNodegroup.go b/service/eks/api_op_CreateNodegroup.go index 0087306e97c..224ce049e3a 100644 --- a/service/eks/api_op_CreateNodegroup.go +++ b/service/eks/api_op_CreateNodegroup.go @@ -68,24 +68,10 @@ func (c *Client) CreateNodegroup(ctx context.Context, params *CreateNodegroupInp type CreateNodegroupInput struct { - // The subnets to use for the Auto Scaling group that is created for your node - // group. These subnets must have the tag key kubernetes.io/cluster/CLUSTER_NAME - // with a value of shared, where CLUSTER_NAME is replaced with the name of your - // cluster. - // - // This member is required. - Subnets []*string - - // The unique name to give your node group. + // The name of the cluster to create the node group in. // // This member is required. - NodegroupName *string - - // The AMI type for your node group. GPU instance types should use the - // AL2_x86_64_GPU AMI type, which uses the Amazon EKS-optimized Linux AMI with GPU - // support. Non-GPU instances should use the AL2_x86_64 AMI type, which uses the - // Amazon EKS-optimized Linux AMI. - AmiType types.AMITypes + ClusterName *string // The Amazon Resource Name (ARN) of the IAM role to associate with your node // group. The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your @@ -100,12 +86,43 @@ type CreateNodegroupInput struct { // This member is required. NodeRole *string + // The unique name to give your node group. + // + // This member is required. + NodegroupName *string + + // The subnets to use for the Auto Scaling group that is created for your node + // group. These subnets must have the tag key kubernetes.io/cluster/CLUSTER_NAME + // with a value of shared, where CLUSTER_NAME is replaced with the name of your + // cluster. + // + // This member is required. + Subnets []*string + + // The AMI type for your node group. GPU instance types should use the + // AL2_x86_64_GPU AMI type, which uses the Amazon EKS-optimized Linux AMI with GPU + // support. Non-GPU instances should use the AL2_x86_64 AMI type, which uses the + // Amazon EKS-optimized Linux AMI. + AmiType types.AMITypes + + // Unique, case-sensitive identifier that you provide to ensure the idempotency of + // the request. + ClientRequestToken *string + + // The root device disk size (in GiB) for your node group instances. The default + // disk size is 20 GiB. + DiskSize *int32 + // The instance type to use for your node group. Currently, you can specify a // single instance type for a node group. The default value for this parameter is // t3.medium. If you choose a GPU instance type, be sure to specify the // AL2_x86_64_GPU with the amiType parameter. InstanceTypes []*string + // The Kubernetes labels to be applied to the nodes in the node group when they are + // created. + Labels map[string]*string + // The AMI version of the Amazon EKS-optimized AMI to use with your node group. By // default, the latest available AMI version for the node group's current // Kubernetes version is used. For more information, see Amazon EKS-Optimized Linux @@ -121,32 +138,15 @@ type CreateNodegroupInput struct { // your node group. ScalingConfig *types.NodegroupScalingConfig - // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. - ClientRequestToken *string - - // The name of the cluster to create the node group in. - // - // This member is required. - ClusterName *string - - // The root device disk size (in GiB) for your node group instances. The default - // disk size is 20 GiB. - DiskSize *int32 - - // The Kubernetes version to use for your managed nodes. By default, the Kubernetes - // version of the cluster is used, and this is the only accepted specified value. - Version *string - // The metadata to apply to the node group to assist with categorization and // organization. Each tag consists of a key and an optional value, both of which // you define. Node group tags do not propagate to any other resources associated // with the node group, such as the Amazon EC2 instances or subnets. Tags map[string]*string - // The Kubernetes labels to be applied to the nodes in the node group when they are - // created. - Labels map[string]*string + // The Kubernetes version to use for your managed nodes. By default, the Kubernetes + // version of the cluster is used, and this is the only accepted specified value. + Version *string } type CreateNodegroupOutput struct { diff --git a/service/eks/api_op_DeleteFargateProfile.go b/service/eks/api_op_DeleteFargateProfile.go index eb40221640c..a847087102f 100644 --- a/service/eks/api_op_DeleteFargateProfile.go +++ b/service/eks/api_op_DeleteFargateProfile.go @@ -64,16 +64,16 @@ func (c *Client) DeleteFargateProfile(ctx context.Context, params *DeleteFargate type DeleteFargateProfileInput struct { - // The name of the Fargate profile to delete. - // - // This member is required. - FargateProfileName *string - // The name of the Amazon EKS cluster associated with the Fargate profile to // delete. // // This member is required. ClusterName *string + + // The name of the Fargate profile to delete. + // + // This member is required. + FargateProfileName *string } type DeleteFargateProfileOutput struct { diff --git a/service/eks/api_op_DeleteNodegroup.go b/service/eks/api_op_DeleteNodegroup.go index 5e68c33fc00..dccd1b9288b 100644 --- a/service/eks/api_op_DeleteNodegroup.go +++ b/service/eks/api_op_DeleteNodegroup.go @@ -57,15 +57,15 @@ func (c *Client) DeleteNodegroup(ctx context.Context, params *DeleteNodegroupInp type DeleteNodegroupInput struct { - // The name of the node group to delete. + // The name of the Amazon EKS cluster that is associated with your node group. // // This member is required. - NodegroupName *string + ClusterName *string - // The name of the Amazon EKS cluster that is associated with your node group. + // The name of the node group to delete. // // This member is required. - ClusterName *string + NodegroupName *string } type DeleteNodegroupOutput struct { diff --git a/service/eks/api_op_DescribeFargateProfile.go b/service/eks/api_op_DescribeFargateProfile.go index cf94077ccbd..54f56a63822 100644 --- a/service/eks/api_op_DescribeFargateProfile.go +++ b/service/eks/api_op_DescribeFargateProfile.go @@ -57,15 +57,15 @@ func (c *Client) DescribeFargateProfile(ctx context.Context, params *DescribeFar type DescribeFargateProfileInput struct { - // The name of the Fargate profile to describe. + // The name of the Amazon EKS cluster associated with the Fargate profile. // // This member is required. - FargateProfileName *string + ClusterName *string - // The name of the Amazon EKS cluster associated with the Fargate profile. + // The name of the Fargate profile to describe. // // This member is required. - ClusterName *string + FargateProfileName *string } type DescribeFargateProfileOutput struct { diff --git a/service/eks/api_op_DescribeNodegroup.go b/service/eks/api_op_DescribeNodegroup.go index a7b2068eeab..396c9cd4b21 100644 --- a/service/eks/api_op_DescribeNodegroup.go +++ b/service/eks/api_op_DescribeNodegroup.go @@ -57,15 +57,15 @@ func (c *Client) DescribeNodegroup(ctx context.Context, params *DescribeNodegrou type DescribeNodegroupInput struct { - // The name of the node group to describe. + // The name of the Amazon EKS cluster associated with the node group. // // This member is required. - NodegroupName *string + ClusterName *string - // The name of the Amazon EKS cluster associated with the node group. + // The name of the node group to describe. // // This member is required. - ClusterName *string + NodegroupName *string } type DescribeNodegroupOutput struct { diff --git a/service/eks/api_op_DescribeUpdate.go b/service/eks/api_op_DescribeUpdate.go index cbe92229491..b3950f6955a 100644 --- a/service/eks/api_op_DescribeUpdate.go +++ b/service/eks/api_op_DescribeUpdate.go @@ -60,6 +60,11 @@ func (c *Client) DescribeUpdate(ctx context.Context, params *DescribeUpdateInput type DescribeUpdateInput struct { + // The name of the Amazon EKS cluster associated with the update. + // + // This member is required. + Name *string + // The ID of the update to describe. // // This member is required. @@ -67,11 +72,6 @@ type DescribeUpdateInput struct { // The name of the Amazon EKS node group associated with the update. NodegroupName *string - - // The name of the Amazon EKS cluster associated with the update. - // - // This member is required. - Name *string } type DescribeUpdateOutput struct { diff --git a/service/eks/api_op_ListFargateProfiles.go b/service/eks/api_op_ListFargateProfiles.go index 4d186979991..d8cb7bbd726 100644 --- a/service/eks/api_op_ListFargateProfiles.go +++ b/service/eks/api_op_ListFargateProfiles.go @@ -81,15 +81,15 @@ type ListFargateProfilesInput struct { type ListFargateProfilesOutput struct { + // A list of all of the Fargate profiles associated with the specified cluster. + FargateProfileNames []*string + // The nextToken value to include in a future ListFargateProfiles request. When the // results of a ListFargateProfiles request exceed maxResults, you can use this // value to retrieve the next page of results. This value is null when there are no // more results to return. NextToken *string - // A list of all of the Fargate profiles associated with the specified cluster. - FargateProfileNames []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/eks/api_op_ListNodegroups.go b/service/eks/api_op_ListNodegroups.go index 533001bc898..660bc05c877 100644 --- a/service/eks/api_op_ListNodegroups.go +++ b/service/eks/api_op_ListNodegroups.go @@ -58,12 +58,6 @@ func (c *Client) ListNodegroups(ctx context.Context, params *ListNodegroupsInput type ListNodegroupsInput struct { - // The nextToken value returned from a previous paginated ListNodegroups request - // where maxResults was used and the results exceeded the value of that parameter. - // Pagination continues from the end of the previous results that returned the - // nextToken value. - NextToken *string - // The name of the Amazon EKS cluster that you would like to list node groups in. // // This member is required. @@ -77,19 +71,25 @@ type ListNodegroupsInput struct { // If you don't use this parameter, ListNodegroups returns up to 100 results and a // nextToken value if applicable. MaxResults *int32 + + // The nextToken value returned from a previous paginated ListNodegroups request + // where maxResults was used and the results exceeded the value of that parameter. + // Pagination continues from the end of the previous results that returned the + // nextToken value. + NextToken *string } type ListNodegroupsOutput struct { - // A list of all of the node groups associated with the specified cluster. - Nodegroups []*string - // The nextToken value to include in a future ListNodegroups request. When the // results of a ListNodegroups request exceed maxResults, you can use this value to // retrieve the next page of results. This value is null when there are no more // results to return. NextToken *string + // A list of all of the node groups associated with the specified cluster. + Nodegroups []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/eks/api_op_ListUpdates.go b/service/eks/api_op_ListUpdates.go index 6bbc900f4cb..7dbb09d632e 100644 --- a/service/eks/api_op_ListUpdates.go +++ b/service/eks/api_op_ListUpdates.go @@ -57,11 +57,10 @@ func (c *Client) ListUpdates(ctx context.Context, params *ListUpdatesInput, optF type ListUpdatesInput struct { - // The nextToken value returned from a previous paginated ListUpdates request where - // maxResults was used and the results exceeded the value of that parameter. - // Pagination continues from the end of the previous results that returned the - // nextToken value. - NextToken *string + // The name of the Amazon EKS cluster to list updates for. + // + // This member is required. + Name *string // The maximum number of update results returned by ListUpdates in paginated // output. When you use this parameter, ListUpdates returns only maxResults results @@ -72,13 +71,14 @@ type ListUpdatesInput struct { // value if applicable. MaxResults *int32 + // The nextToken value returned from a previous paginated ListUpdates request where + // maxResults was used and the results exceeded the value of that parameter. + // Pagination continues from the end of the previous results that returned the + // nextToken value. + NextToken *string + // The name of the Amazon EKS managed node group to list updates for. NodegroupName *string - - // The name of the Amazon EKS cluster to list updates for. - // - // This member is required. - Name *string } type ListUpdatesOutput struct { diff --git a/service/eks/api_op_TagResource.go b/service/eks/api_op_TagResource.go index e749764659e..10d2c1fdd7c 100644 --- a/service/eks/api_op_TagResource.go +++ b/service/eks/api_op_TagResource.go @@ -62,16 +62,16 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The tags to add to the resource. A tag is an array of key-value pairs. - // - // This member is required. - Tags map[string]*string - // The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, // the supported resources are Amazon EKS clusters and managed node groups. // // This member is required. ResourceArn *string + + // The tags to add to the resource. A tag is an array of key-value pairs. + // + // This member is required. + Tags map[string]*string } type TagResourceOutput struct { diff --git a/service/eks/api_op_UpdateClusterConfig.go b/service/eks/api_op_UpdateClusterConfig.go index 5f46cb19a63..22fba6d6490 100644 --- a/service/eks/api_op_UpdateClusterConfig.go +++ b/service/eks/api_op_UpdateClusterConfig.go @@ -79,8 +79,10 @@ func (c *Client) UpdateClusterConfig(ctx context.Context, params *UpdateClusterC type UpdateClusterConfigInput struct { - // An object representing the VPC configuration to use for an Amazon EKS cluster. - ResourcesVpcConfig *types.VpcConfigRequest + // The name of the Amazon EKS cluster to update. + // + // This member is required. + Name *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. @@ -95,10 +97,8 @@ type UpdateClusterConfigInput struct { // Amazon CloudWatch Pricing (http://aws.amazon.com/cloudwatch/pricing/). Logging *types.Logging - // The name of the Amazon EKS cluster to update. - // - // This member is required. - Name *string + // An object representing the VPC configuration to use for an Amazon EKS cluster. + ResourcesVpcConfig *types.VpcConfigRequest } type UpdateClusterConfigOutput struct { diff --git a/service/eks/api_op_UpdateNodegroupConfig.go b/service/eks/api_op_UpdateNodegroupConfig.go index 0df6756d920..62628648722 100644 --- a/service/eks/api_op_UpdateNodegroupConfig.go +++ b/service/eks/api_op_UpdateNodegroupConfig.go @@ -63,26 +63,26 @@ func (c *Client) UpdateNodegroupConfig(ctx context.Context, params *UpdateNodegr type UpdateNodegroupConfigInput struct { - // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. - ClientRequestToken *string - - // The scaling configuration details for the Auto Scaling group after the update. - ScalingConfig *types.NodegroupScalingConfig + // The name of the Amazon EKS cluster that the managed node group resides in. + // + // This member is required. + ClusterName *string // The name of the managed node group to update. // // This member is required. NodegroupName *string + // Unique, case-sensitive identifier that you provide to ensure the idempotency of + // the request. + ClientRequestToken *string + // The Kubernetes labels to be applied to the nodes in the node group after the // update. Labels *types.UpdateLabelsPayload - // The name of the Amazon EKS cluster that the managed node group resides in. - // - // This member is required. - ClusterName *string + // The scaling configuration details for the Auto Scaling group after the update. + ScalingConfig *types.NodegroupScalingConfig } type UpdateNodegroupConfigOutput struct { diff --git a/service/eks/api_op_UpdateNodegroupVersion.go b/service/eks/api_op_UpdateNodegroupVersion.go index eb820e0b854..6fc498759b6 100644 --- a/service/eks/api_op_UpdateNodegroupVersion.go +++ b/service/eks/api_op_UpdateNodegroupVersion.go @@ -71,13 +71,20 @@ func (c *Client) UpdateNodegroupVersion(ctx context.Context, params *UpdateNodeg type UpdateNodegroupVersionInput struct { - // The AMI version of the Amazon EKS-optimized AMI to use for the update. By - // default, the latest available AMI version for the node group's Kubernetes - // version is used. For more information, see Amazon EKS-Optimized Linux AMI - // Versions - // (https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html) - // in the Amazon EKS User Guide. - ReleaseVersion *string + // The name of the Amazon EKS cluster that is associated with the managed node + // group to update. + // + // This member is required. + ClusterName *string + + // The name of the managed node group to update. + // + // This member is required. + NodegroupName *string + + // Unique, case-sensitive identifier that you provide to ensure the idempotency of + // the request. + ClientRequestToken *string // Force the update if the existing node group's pods are unable to be drained due // to a pod disruption budget issue. If an update fails because pods could not be @@ -85,26 +92,19 @@ type UpdateNodegroupVersionInput struct { // whether or not any pods are running on the node. Force *bool - // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. - ClientRequestToken *string + // The AMI version of the Amazon EKS-optimized AMI to use for the update. By + // default, the latest available AMI version for the node group's Kubernetes + // version is used. For more information, see Amazon EKS-Optimized Linux AMI + // Versions + // (https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html) + // in the Amazon EKS User Guide. + ReleaseVersion *string // The Kubernetes version to update to. If no version is specified, then the // Kubernetes version of the node group does not change. You can specify the // Kubernetes version of the cluster to update the node group to the latest AMI // version of the cluster's Kubernetes version. Version *string - - // The name of the Amazon EKS cluster that is associated with the managed node - // group to update. - // - // This member is required. - ClusterName *string - - // The name of the managed node group to update. - // - // This member is required. - NodegroupName *string } type UpdateNodegroupVersionOutput struct { diff --git a/service/eks/go.mod b/service/eks/go.mod index 8625fb24328..12a5255d9a5 100644 --- a/service/eks/go.mod +++ b/service/eks/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/eks go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/eks/types/types.go b/service/eks/types/types.go index d763c5bdfc0..fa149232ba7 100644 --- a/service/eks/types/types.go +++ b/service/eks/types/types.go @@ -26,35 +26,40 @@ type Certificate struct { // An object representing an Amazon EKS cluster. type Cluster struct { + // The Amazon Resource Name (ARN) of the cluster. + Arn *string + + // The certificate-authority-data for your cluster. + CertificateAuthority *Certificate + // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. ClientRequestToken *string - // The identity provider information for the cluster. - Identity *Identity + // The Unix epoch timestamp in seconds for when the cluster was created. + CreatedAt *time.Time - // The platform version of your Amazon EKS cluster. For more information, see - // Platform Versions - // (https://docs.aws.amazon.com/eks/latest/userguide/platform-versions.html) in the - // Amazon EKS User Guide . - PlatformVersion *string + // The encryption configuration for the cluster. + EncryptionConfig []*EncryptionConfig - // The Amazon Resource Name (ARN) of the IAM role that provides permissions for the - // Kubernetes control plane to make calls to AWS API operations on your behalf. - RoleArn *string + // The endpoint for your Kubernetes API server. + Endpoint *string - // The Unix epoch timestamp in seconds for when the cluster was created. - CreatedAt *time.Time + // The identity provider information for the cluster. + Identity *Identity // The logging configuration for your cluster. Logging *Logging - // The Amazon Resource Name (ARN) of the cluster. - Arn *string - // The name of the cluster. Name *string + // The platform version of your Amazon EKS cluster. For more information, see + // Platform Versions + // (https://docs.aws.amazon.com/eks/latest/userguide/platform-versions.html) in the + // Amazon EKS User Guide . + PlatformVersion *string + // The VPC configuration used by the cluster control plane. Amazon EKS VPC // resources have specific requirements to work properly with Kubernetes. For more // information, see Cluster VPC Considerations @@ -64,11 +69,9 @@ type Cluster struct { // Amazon EKS User Guide. ResourcesVpcConfig *VpcConfigResponse - // The endpoint for your Kubernetes API server. - Endpoint *string - - // The certificate-authority-data for your cluster. - CertificateAuthority *Certificate + // The Amazon Resource Name (ARN) of the IAM role that provides permissions for the + // Kubernetes control plane to make calls to AWS API operations on your behalf. + RoleArn *string // The current status of the cluster. Status ClusterStatus @@ -79,9 +82,6 @@ type Cluster struct { // the cluster. Tags map[string]*string - // The encryption configuration for the cluster. - EncryptionConfig []*EncryptionConfig - // The Kubernetes server version for the cluster. Version *string } @@ -100,12 +100,6 @@ type EncryptionConfig struct { // An object representing an error when an asynchronous operation fails. type ErrorDetail struct { - // An optional field that contains the resource IDs associated with the error. - ResourceIds []*string - - // A more complete description of the error. - ErrorMessage *string - // A brief description of the error. // // * SubnetNotFound: We couldn't find one of @@ -131,32 +125,28 @@ type ErrorDetail struct { // * VpcIdNotFound: We couldn't find the VPC associated with the // cluster. ErrorCode ErrorCode + + // A more complete description of the error. + ErrorMessage *string + + // An optional field that contains the resource IDs associated with the error. + ResourceIds []*string } // An object representing an AWS Fargate profile. type FargateProfile struct { - // The full Amazon Resource Name (ARN) of the Fargate profile. - FargateProfileArn *string - - // The IDs of subnets to launch pods into. - Subnets []*string - - // The name of the Fargate profile. - FargateProfileName *string + // The name of the Amazon EKS cluster that the Fargate profile belongs to. + ClusterName *string // The Unix epoch timestamp in seconds for when the Fargate profile was created. CreatedAt *time.Time - // The name of the Amazon EKS cluster that the Fargate profile belongs to. - ClusterName *string + // The full Amazon Resource Name (ARN) of the Fargate profile. + FargateProfileArn *string - // The metadata applied to the Fargate profile to assist with categorization and - // organization. Each tag consists of a key and an optional value, both of which - // you define. Fargate profile tags do not propagate to any other resources - // associated with the Fargate profile, such as the pods that are scheduled with - // it. - Tags map[string]*string + // The name of the Fargate profile. + FargateProfileName *string // The Amazon Resource Name (ARN) of the pod execution role to use for pods that // match the selectors in the Fargate profile. For more information, see Pod @@ -165,22 +155,32 @@ type FargateProfile struct { // the Amazon EKS User Guide. PodExecutionRoleArn *string + // The selectors to match for pods to use this Fargate profile. + Selectors []*FargateProfileSelector + // The current status of the Fargate profile. Status FargateProfileStatus - // The selectors to match for pods to use this Fargate profile. - Selectors []*FargateProfileSelector + // The IDs of subnets to launch pods into. + Subnets []*string + + // The metadata applied to the Fargate profile to assist with categorization and + // organization. Each tag consists of a key and an optional value, both of which + // you define. Fargate profile tags do not propagate to any other resources + // associated with the Fargate profile, such as the pods that are scheduled with + // it. + Tags map[string]*string } // An object representing an AWS Fargate profile selector. type FargateProfileSelector struct { - // The Kubernetes namespace that the selector should match. - Namespace *string - // The Kubernetes labels that the selector should match. A pod must contain all of // the labels that are specified in the selector for it to be considered a match. Labels map[string]*string + + // The Kubernetes namespace that the selector should match. + Namespace *string } // An object representing an identity provider for authentication credentials. @@ -284,39 +284,38 @@ type LogSetup struct { // An object representing an Amazon EKS managed node group. type Nodegroup struct { - // The resources associated with the node group, such as Auto Scaling groups and - // security groups for remote access. - Resources *NodegroupResources + // The AMI type associated with your node group. GPU instance types should use the + // AL2_x86_64_GPU AMI type, which uses the Amazon EKS-optimized Linux AMI with GPU + // support. Non-GPU instances should use the AL2_x86_64 AMI type, which uses the + // Amazon EKS-optimized Linux AMI. + AmiType AMITypes - // The AMI version of the managed node group. For more information, see Amazon - // EKS-Optimized Linux AMI Versions - // (https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html) - // in the Amazon EKS User Guide. - ReleaseVersion *string + // The name of the cluster that the managed node group resides in. + ClusterName *string + + // The Unix epoch timestamp in seconds for when the managed node group was created. + CreatedAt *time.Time // The root device disk size (in GiB) for your node group instances. The default // disk size is 20 GiB. DiskSize *int32 - // The remote access (SSH) configuration that is associated with the node group. - RemoteAccess *RemoteAccessConfig + // The health status of the node group. If there are issues with your node group's + // health, they are listed here. + Health *NodegroupHealth + + // The instance types associated with your node group. + InstanceTypes []*string // The Kubernetes labels applied to the nodes in the node group. Only labels that // are applied with the Amazon EKS API are shown here. There may be other // Kubernetes labels applied to the nodes in this group. Labels map[string]*string - // The name of the cluster that the managed node group resides in. - ClusterName *string - // The Unix epoch timestamp in seconds for when the managed node group was last // modified. ModifiedAt *time.Time - // The scaling configuration details for the Auto Scaling group that is associated - // with your node group. - ScalingConfig *NodegroupScalingConfig - // The IAM role associated with your node group. The Amazon EKS worker node kubelet // daemon makes calls to AWS APIs on your behalf. Worker nodes receive permissions // for these API calls through an IAM instance profile and associated policies. @@ -327,30 +326,31 @@ type Nodegroup struct { // the Amazon EKS User Guide . NodeRole *string - // The current status of the managed node group. - Status NodegroupStatus + // The Amazon Resource Name (ARN) associated with the managed node group. + NodegroupArn *string - // The health status of the node group. If there are issues with your node group's - // health, they are listed here. - Health *NodegroupHealth + // The name associated with an Amazon EKS managed node group. + NodegroupName *string - // The metadata applied to the node group to assist with categorization and - // organization. Each tag consists of a key and an optional value, both of which - // you define. Node group tags do not propagate to any other resources associated - // with the node group, such as the Amazon EC2 instances or subnets. - Tags map[string]*string + // The AMI version of the managed node group. For more information, see Amazon + // EKS-Optimized Linux AMI Versions + // (https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html) + // in the Amazon EKS User Guide. + ReleaseVersion *string - // The Kubernetes version of the managed node group. - Version *string + // The remote access (SSH) configuration that is associated with the node group. + RemoteAccess *RemoteAccessConfig - // The Amazon Resource Name (ARN) associated with the managed node group. - NodegroupArn *string + // The resources associated with the node group, such as Auto Scaling groups and + // security groups for remote access. + Resources *NodegroupResources - // The AMI type associated with your node group. GPU instance types should use the - // AL2_x86_64_GPU AMI type, which uses the Amazon EKS-optimized Linux AMI with GPU - // support. Non-GPU instances should use the AL2_x86_64 AMI type, which uses the - // Amazon EKS-optimized Linux AMI. - AmiType AMITypes + // The scaling configuration details for the Auto Scaling group that is associated + // with your node group. + ScalingConfig *NodegroupScalingConfig + + // The current status of the managed node group. + Status NodegroupStatus // The subnets allowed for the Auto Scaling group that is associated with your node // group. These subnets must have the following tag: @@ -358,14 +358,14 @@ type Nodegroup struct { // of your cluster. Subnets []*string - // The name associated with an Amazon EKS managed node group. - NodegroupName *string - - // The Unix epoch timestamp in seconds for when the managed node group was created. - CreatedAt *time.Time + // The metadata applied to the node group to assist with categorization and + // organization. Each tag consists of a key and an optional value, both of which + // you define. Node group tags do not propagate to any other resources associated + // with the node group, such as the Amazon EC2 instances or subnets. + Tags map[string]*string - // The instance types associated with your node group. - InstanceTypes []*string + // The Kubernetes version of the managed node group. + Version *string } // An object representing the health status of the node group. @@ -391,13 +391,13 @@ type NodegroupResources struct { // group that is associated with your node group. type NodegroupScalingConfig struct { + // The current number of worker nodes that the managed node group should maintain. + DesiredSize *int32 + // The maximum number of worker nodes that the managed node group can scale out to. // Managed node groups can support up to 100 nodes by default. MaxSize *int32 - // The current number of worker nodes that the managed node group should maintain. - DesiredSize *int32 - // The minimum number of worker nodes that the managed node group can scale in to. // This number must be greater than zero. MinSize *int32 @@ -428,6 +428,12 @@ type Provider struct { // group. type RemoteAccessConfig struct { + // The Amazon EC2 SSH key that provides access for SSH communication with the + // worker nodes in the managed node group. For more information, see Amazon EC2 Key + // Pairs (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) + // in the Amazon Elastic Compute Cloud User Guide for Linux Instances. + Ec2SshKey *string + // The security groups that are allowed SSH access (port 22) to the worker nodes. // If you specify an Amazon EC2 SSH key but do not specify a source security group // when you create a managed node group, then port 22 on the worker nodes is opened @@ -435,44 +441,38 @@ type RemoteAccessConfig struct { // VPC (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) // in the Amazon Virtual Private Cloud User Guide. SourceSecurityGroups []*string - - // The Amazon EC2 SSH key that provides access for SSH communication with the - // worker nodes in the managed node group. For more information, see Amazon EC2 Key - // Pairs (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) - // in the Amazon Elastic Compute Cloud User Guide for Linux Instances. - Ec2SshKey *string } // An object representing an asynchronous update. type Update struct { - // A key-value map that contains the parameters associated with the update. - Params []*UpdateParam + // The Unix epoch timestamp in seconds for when the update was created. + CreatedAt *time.Time + + // Any errors associated with a Failed update. + Errors []*ErrorDetail // A UUID that is used to track the update. Id *string + // A key-value map that contains the parameters associated with the update. + Params []*UpdateParam + // The current status of the update. Status UpdateStatus // The type of the update. Type UpdateType - - // Any errors associated with a Failed update. - Errors []*ErrorDetail - - // The Unix epoch timestamp in seconds for when the update was created. - CreatedAt *time.Time } // An object representing a Kubernetes label change for a managed node group. type UpdateLabelsPayload struct { - // Kubernetes labels to be removed. - RemoveLabels []*string - // Kubernetes labels to be added or updated. AddOrUpdateLabels map[string]*string + + // Kubernetes labels to be removed. + RemoveLabels []*string } // An object representing the details of an update request. @@ -488,16 +488,6 @@ type UpdateParam struct { // An object representing the VPC configuration to use for an Amazon EKS cluster. type VpcConfigRequest struct { - // The CIDR blocks that are allowed access to your cluster's public Kubernetes API - // server endpoint. Communication to the endpoint from addresses outside of the - // CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If - // you've disabled private endpoint access and you have worker nodes or AWS Fargate - // pods in the cluster, then ensure that you specify the necessary CIDR blocks. For - // more information, see Amazon EKS Cluster Endpoint Access Control - // (https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the - // Amazon EKS User Guide . - PublicAccessCidrs []*string - // Set this value to true to enable private access for your cluster's Kubernetes // API server endpoint. If you enable private access, Kubernetes API requests from // within your cluster's VPC use the private VPC endpoint. The default value for @@ -510,6 +500,25 @@ type VpcConfigRequest struct { // Amazon EKS User Guide . EndpointPrivateAccess *bool + // Set this value to false to disable public access to your cluster's Kubernetes + // API server endpoint. If you disable public access, your cluster's Kubernetes API + // server can only receive requests from within the cluster VPC. The default value + // for this parameter is true, which enables public access for your Kubernetes API + // server. For more information, see Amazon EKS Cluster Endpoint Access Control + // (https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the + // Amazon EKS User Guide . + EndpointPublicAccess *bool + + // The CIDR blocks that are allowed access to your cluster's public Kubernetes API + // server endpoint. Communication to the endpoint from addresses outside of the + // CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If + // you've disabled private endpoint access and you have worker nodes or AWS Fargate + // pods in the cluster, then ensure that you specify the necessary CIDR blocks. For + // more information, see Amazon EKS Cluster Endpoint Access Control + // (https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the + // Amazon EKS User Guide . + PublicAccessCidrs []*string + // Specify one or more security groups for the cross-account elastic network // interfaces that Amazon EKS creates to use to allow communication between your // worker nodes and the Kubernetes control plane. If you don't specify a security @@ -520,20 +529,16 @@ type VpcConfigRequest struct { // cross-account elastic network interfaces in these subnets to allow communication // between your worker nodes and the Kubernetes control plane. SubnetIds []*string - - // Set this value to false to disable public access to your cluster's Kubernetes - // API server endpoint. If you disable public access, your cluster's Kubernetes API - // server can only receive requests from within the cluster VPC. The default value - // for this parameter is true, which enables public access for your Kubernetes API - // server. For more information, see Amazon EKS Cluster Endpoint Access Control - // (https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the - // Amazon EKS User Guide . - EndpointPublicAccess *bool } // An object representing an Amazon EKS cluster VPC configuration response. type VpcConfigResponse struct { + // The cluster security group that was created by Amazon EKS for the cluster. + // Managed node groups use this security group for control-plane-to-data-plane + // communication. + ClusterSecurityGroupId *string + // This parameter indicates whether the Amazon EKS private API server endpoint is // enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes // API requests that originate from within your cluster's VPC use the private VPC @@ -546,13 +551,11 @@ type VpcConfigResponse struct { // Amazon EKS User Guide . EndpointPrivateAccess *bool - // The security groups associated with the cross-account elastic network interfaces - // that are used to allow communication between your worker nodes and the - // Kubernetes control plane. - SecurityGroupIds []*string - - // The VPC associated with your cluster. - VpcId *string + // This parameter indicates whether the Amazon EKS public API server endpoint is + // enabled. If the Amazon EKS public API server endpoint is disabled, your + // cluster's Kubernetes API server can only receive requests that originate from + // within the cluster VPC. + EndpointPublicAccess *bool // The CIDR blocks that are allowed access to your cluster's public Kubernetes API // server endpoint. Communication to the endpoint from addresses outside of the @@ -564,17 +567,14 @@ type VpcConfigResponse struct { // Amazon EKS User Guide . PublicAccessCidrs []*string - // This parameter indicates whether the Amazon EKS public API server endpoint is - // enabled. If the Amazon EKS public API server endpoint is disabled, your - // cluster's Kubernetes API server can only receive requests that originate from - // within the cluster VPC. - EndpointPublicAccess *bool - - // The cluster security group that was created by Amazon EKS for the cluster. - // Managed node groups use this security group for control-plane-to-data-plane - // communication. - ClusterSecurityGroupId *string + // The security groups associated with the cross-account elastic network interfaces + // that are used to allow communication between your worker nodes and the + // Kubernetes control plane. + SecurityGroupIds []*string // The subnets associated with your cluster. SubnetIds []*string + + // The VPC associated with your cluster. + VpcId *string } diff --git a/service/elasticache/api_op_AddTagsToResource.go b/service/elasticache/api_op_AddTagsToResource.go index e1d3784045b..0f4cfd8b9bb 100644 --- a/service/elasticache/api_op_AddTagsToResource.go +++ b/service/elasticache/api_op_AddTagsToResource.go @@ -68,12 +68,6 @@ func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourc // Represents the input of an AddTagsToResource operation. type AddTagsToResourceInput struct { - // A list of cost allocation tags to be added to this resource. A tag is a - // key-value pair. A tag key must be accompanied by a tag value. - // - // This member is required. - Tags []*types.Tag - // The Amazon Resource Name (ARN) of the resource to which the tags are to be // added, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or // arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. ElastiCache @@ -83,6 +77,12 @@ type AddTagsToResourceInput struct { // // This member is required. ResourceName *string + + // A list of cost allocation tags to be added to this resource. A tag is a + // key-value pair. A tag key must be accompanied by a tag value. + // + // This member is required. + Tags []*types.Tag } // Represents the output from the AddTagsToResource, ListTagsForResource, and diff --git a/service/elasticache/api_op_AuthorizeCacheSecurityGroupIngress.go b/service/elasticache/api_op_AuthorizeCacheSecurityGroupIngress.go index 90413441cf5..f33442d4707 100644 --- a/service/elasticache/api_op_AuthorizeCacheSecurityGroupIngress.go +++ b/service/elasticache/api_op_AuthorizeCacheSecurityGroupIngress.go @@ -61,12 +61,10 @@ func (c *Client) AuthorizeCacheSecurityGroupIngress(ctx context.Context, params // Represents the input of an AuthorizeCacheSecurityGroupIngress operation. type AuthorizeCacheSecurityGroupIngressInput struct { - // The AWS account number of the Amazon EC2 security group owner. Note that this is - // not the same thing as an AWS access key ID - you must provide a valid AWS - // account number for this parameter. + // The cache security group that allows network ingress. // // This member is required. - EC2SecurityGroupOwnerId *string + CacheSecurityGroupName *string // The Amazon EC2 security group to be authorized for ingress to the cache security // group. @@ -74,10 +72,12 @@ type AuthorizeCacheSecurityGroupIngressInput struct { // This member is required. EC2SecurityGroupName *string - // The cache security group that allows network ingress. + // The AWS account number of the Amazon EC2 security group owner. Note that this is + // not the same thing as an AWS access key ID - you must provide a valid AWS + // account number for this parameter. // // This member is required. - CacheSecurityGroupName *string + EC2SecurityGroupOwnerId *string } type AuthorizeCacheSecurityGroupIngressOutput struct { diff --git a/service/elasticache/api_op_BatchApplyUpdateAction.go b/service/elasticache/api_op_BatchApplyUpdateAction.go index f4ba36f191c..e56331d28be 100644 --- a/service/elasticache/api_op_BatchApplyUpdateAction.go +++ b/service/elasticache/api_op_BatchApplyUpdateAction.go @@ -59,26 +59,26 @@ func (c *Client) BatchApplyUpdateAction(ctx context.Context, params *BatchApplyU type BatchApplyUpdateActionInput struct { - // The replication group IDs - ReplicationGroupIds []*string - - // The cache cluster IDs - CacheClusterIds []*string - // The unique ID of the service update // // This member is required. ServiceUpdateName *string + + // The cache cluster IDs + CacheClusterIds []*string + + // The replication group IDs + ReplicationGroupIds []*string } type BatchApplyUpdateActionOutput struct { - // Update actions that haven't been processed successfully - UnprocessedUpdateActions []*types.UnprocessedUpdateAction - // Update actions that have been processed successfully ProcessedUpdateActions []*types.ProcessedUpdateAction + // Update actions that haven't been processed successfully + UnprocessedUpdateActions []*types.UnprocessedUpdateAction + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticache/api_op_BatchStopUpdateAction.go b/service/elasticache/api_op_BatchStopUpdateAction.go index e9a38c17a08..d801b99bf6a 100644 --- a/service/elasticache/api_op_BatchStopUpdateAction.go +++ b/service/elasticache/api_op_BatchStopUpdateAction.go @@ -59,26 +59,26 @@ func (c *Client) BatchStopUpdateAction(ctx context.Context, params *BatchStopUpd type BatchStopUpdateActionInput struct { - // The replication group IDs - ReplicationGroupIds []*string - - // The cache cluster IDs - CacheClusterIds []*string - // The unique ID of the service update // // This member is required. ServiceUpdateName *string + + // The cache cluster IDs + CacheClusterIds []*string + + // The replication group IDs + ReplicationGroupIds []*string } type BatchStopUpdateActionOutput struct { - // Update actions that haven't been processed successfully - UnprocessedUpdateActions []*types.UnprocessedUpdateAction - // Update actions that have been processed successfully ProcessedUpdateActions []*types.ProcessedUpdateAction + // Update actions that haven't been processed successfully + UnprocessedUpdateActions []*types.UnprocessedUpdateAction + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticache/api_op_CompleteMigration.go b/service/elasticache/api_op_CompleteMigration.go index 804476c89ff..c21467ac24a 100644 --- a/service/elasticache/api_op_CompleteMigration.go +++ b/service/elasticache/api_op_CompleteMigration.go @@ -57,15 +57,15 @@ func (c *Client) CompleteMigration(ctx context.Context, params *CompleteMigratio type CompleteMigrationInput struct { - // Forces the migration to stop without ensuring that data is in sync. It is - // recommended to use this option only to abort the migration and not recommended - // when application wants to continue migration to ElastiCache. - Force *bool - // The ID of the replication group to which data is being migrated. // // This member is required. ReplicationGroupId *string + + // Forces the migration to stop without ensuring that data is in sync. It is + // recommended to use this option only to abort the migration and not recommended + // when application wants to continue migration to ElastiCache. + Force *bool } type CompleteMigrationOutput struct { diff --git a/service/elasticache/api_op_CopySnapshot.go b/service/elasticache/api_op_CopySnapshot.go index 6606e6bd64c..7ee15e4feca 100644 --- a/service/elasticache/api_op_CopySnapshot.go +++ b/service/elasticache/api_op_CopySnapshot.go @@ -108,14 +108,21 @@ func (c *Client) CopySnapshot(ctx context.Context, params *CopySnapshotInput, op // Represents the input of a CopySnapshotMessage operation. type CopySnapshotInput struct { - // The ID of the KMS key used to encrypt the target snapshot. - KmsKeyId *string - // The name of an existing snapshot from which to make a copy. // // This member is required. SourceSnapshotName *string + // A name for the snapshot copy. ElastiCache does not permit overwriting a + // snapshot, therefore this name must be unique within its context - ElastiCache or + // an Amazon S3 bucket if exporting. + // + // This member is required. + TargetSnapshotName *string + + // The ID of the KMS key used to encrypt the target snapshot. + KmsKeyId *string + // The Amazon S3 bucket to which the snapshot is exported. This parameter is used // only when exporting a snapshot for external access. When using this parameter to // export a snapshot, be sure Amazon ElastiCache has the needed permissions to this @@ -126,13 +133,6 @@ type CopySnapshotInput struct { // href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Snapshots.Exporting.html">Exporting // a Snapshot in the Amazon ElastiCache User Guide.

    TargetBucket *string - - // A name for the snapshot copy. ElastiCache does not permit overwriting a - // snapshot, therefore this name must be unique within its context - ElastiCache or - // an Amazon S3 bucket if exporting. - // - // This member is required. - TargetSnapshotName *string } type CopySnapshotOutput struct { diff --git a/service/elasticache/api_op_CreateCacheCluster.go b/service/elasticache/api_op_CreateCacheCluster.go index cb548ca505d..6cfdab5de86 100644 --- a/service/elasticache/api_op_CreateCacheCluster.go +++ b/service/elasticache/api_op_CreateCacheCluster.go @@ -60,24 +60,6 @@ func (c *Client) CreateCacheCluster(ctx context.Context, params *CreateCacheClus // Represents the input of a CreateCacheCluster operation. type CreateCacheClusterInput struct { - // The EC2 Availability Zone in which the cluster is created. All nodes belonging - // to this cluster are placed in the preferred Availability Zone. If you want to - // create your nodes across multiple Availability Zones, use - // PreferredAvailabilityZones. Default: System chosen Availability Zone. - PreferredAvailabilityZone *string - - // The name of the cache engine to be used for this cluster. Valid values for this - // parameter are: memcached | redis - Engine *string - - // A list of security group names to associate with this cluster. Use this - // parameter only when you are creating a cluster outside of an Amazon Virtual - // Private Cloud (Amazon VPC). - CacheSecurityGroupNames []*string - - // The port number on which each of the cache nodes accepts connections. - Port *int32 - // The node group (shard) identifier. This parameter is stored as a lowercase // string. Constraints: // @@ -92,85 +74,33 @@ type CreateCacheClusterInput struct { // This member is required. CacheClusterId *string - // The name of a Redis snapshot from which to restore data into the new node group - // (shard). The snapshot status changes to restoring while the new node group - // (shard) is being created. This parameter is only valid if the Engine parameter - // is redis. - SnapshotName *string - - // A list of the Availability Zones in which cache nodes are created. The order of - // the zones in the list is not important. This option is only supported on - // Memcached. If you are creating your cluster in an Amazon VPC (recommended) you - // can only locate nodes in Availability Zones that are associated with the subnets - // in the selected subnet group. The number of Availability Zones listed must equal - // the value of NumCacheNodes. If you want all the nodes in the same Availability - // Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone - // multiple times in the list. Default: System chosen Availability Zones. - PreferredAvailabilityZones []*string + // Specifies whether the nodes in this Memcached cluster are created in a single + // Availability Zone or created across multiple Availability Zones in the cluster's + // region. This parameter is only supported for Memcached clusters. If the AZMode + // and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az + // mode. + AZMode types.AZMode - // Specifies the weekly time range during which maintenance on the cluster is - // performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H - // Clock UTC). The minimum maintenance window is a 60 minute period. Valid values - // for ddd are:

    Specifies the weekly time range during which maintenance on - // the cluster is performed. It is specified as a range in the format - // ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 - // minute period. Valid values for ddd are: - // - // * sun - // - // * mon + // Reserved parameter. The password used to access a password protected server. + // Password constraints: // - // * tue + // * Must be only printable ASCII characters. // // * - // wed - // - // * thu - // - // * fri + // Must be at least 16 characters and no more than 128 characters in length. // - // * sat + // * + // The only permitted printable special characters are !, &, #, $, ^, <, >, and -. + // Other printable special characters cannot be used in the AUTH token. // - // Example: sun:23:00-mon:01:30 - PreferredMaintenanceWindow *string + // For more + // information, see AUTH password (http://redis.io/commands/AUTH) at + // http://redis.io/commands/AUTH. + AuthToken *string // This parameter is currently disabled. AutoMinorVersionUpgrade *bool - // The version number of the cache engine to be used for this cluster. To view the - // supported cache engine versions, use the DescribeCacheEngineVersions operation. - //

    Important: You can upgrade to a newer engine version (see Selecting - // a Cache Engine and Version), but you cannot downgrade to an earlier engine - // version. If you want to use an earlier engine version, you must delete the - // existing cluster or replication group and create it anew with the earlier engine - // version.

    - EngineVersion *string - - // The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) - // topic to which notifications are sent. The Amazon SNS topic owner must be the - // same as the cluster owner. - NotificationTopicArn *string - - // One or more VPC security groups associated with the cluster. Use this parameter - // only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon - // VPC). - SecurityGroupIds []*string - - // The name of the parameter group to associate with this cluster. If this argument - // is omitted, the default parameter group for the specified engine is used. You - // cannot use any parameter group which has cluster-enabled='yes' when creating a - // cluster. - CacheParameterGroupName *string - - // The initial number of cache nodes that the cluster has. For clusters running - // Redis, this value must be 1. For clusters running Memcached, this value must be - // between 1 and 20. If you need more than 20 nodes for your Memcached cluster, - // please fill out the ElastiCache Limit Increase Request form at - // http://aws.amazon.com/contact-us/elasticache-node-limit-request/ - // (http://aws.amazon.com/contact-us/elasticache-node-limit-request/). - NumCacheNodes *int32 - // The compute and memory capacity of the nodes in the node group (shard). The // following node types are supported by ElastiCache. Generally speaking, the // current generation types provide more memory and computational power at lower @@ -220,14 +150,96 @@ type CreateCacheClusterInput struct { // later.

    CacheNodeType *string - // The daily time range (in UTC) during which ElastiCache begins taking a daily - // snapshot of your node group (shard). Example: 05:00-09:00 If you do not specify - // this parameter, ElastiCache automatically chooses an appropriate time range. - // This parameter is only valid if the Engine parameter is redis. - SnapshotWindow *string + // The name of the parameter group to associate with this cluster. If this argument + // is omitted, the default parameter group for the specified engine is used. You + // cannot use any parameter group which has cluster-enabled='yes' when creating a + // cluster. + CacheParameterGroupName *string - // A list of cost allocation tags to be added to this resource. - Tags []*types.Tag + // A list of security group names to associate with this cluster. Use this + // parameter only when you are creating a cluster outside of an Amazon Virtual + // Private Cloud (Amazon VPC). + CacheSecurityGroupNames []*string + + // The name of the subnet group to be used for the cluster. Use this parameter only + // when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC). + // If you're going to launch your cluster in an Amazon VPC, you need to create a + // subnet group before you start creating a cluster. For more information, see + // Subnets and Subnet Groups + // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.html). + CacheSubnetGroupName *string + + // The name of the cache engine to be used for this cluster. Valid values for this + // parameter are: memcached | redis + Engine *string + + // The version number of the cache engine to be used for this cluster. To view the + // supported cache engine versions, use the DescribeCacheEngineVersions operation. + //

    Important: You can upgrade to a newer engine version (see Selecting + // a Cache Engine and Version), but you cannot downgrade to an earlier engine + // version. If you want to use an earlier engine version, you must delete the + // existing cluster or replication group and create it anew with the earlier engine + // version.

    + EngineVersion *string + + // The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) + // topic to which notifications are sent. The Amazon SNS topic owner must be the + // same as the cluster owner. + NotificationTopicArn *string + + // The initial number of cache nodes that the cluster has. For clusters running + // Redis, this value must be 1. For clusters running Memcached, this value must be + // between 1 and 20. If you need more than 20 nodes for your Memcached cluster, + // please fill out the ElastiCache Limit Increase Request form at + // http://aws.amazon.com/contact-us/elasticache-node-limit-request/ + // (http://aws.amazon.com/contact-us/elasticache-node-limit-request/). + NumCacheNodes *int32 + + // The port number on which each of the cache nodes accepts connections. + Port *int32 + + // The EC2 Availability Zone in which the cluster is created. All nodes belonging + // to this cluster are placed in the preferred Availability Zone. If you want to + // create your nodes across multiple Availability Zones, use + // PreferredAvailabilityZones. Default: System chosen Availability Zone. + PreferredAvailabilityZone *string + + // A list of the Availability Zones in which cache nodes are created. The order of + // the zones in the list is not important. This option is only supported on + // Memcached. If you are creating your cluster in an Amazon VPC (recommended) you + // can only locate nodes in Availability Zones that are associated with the subnets + // in the selected subnet group. The number of Availability Zones listed must equal + // the value of NumCacheNodes. If you want all the nodes in the same Availability + // Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone + // multiple times in the list. Default: System chosen Availability Zones. + PreferredAvailabilityZones []*string + + // Specifies the weekly time range during which maintenance on the cluster is + // performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H + // Clock UTC). The minimum maintenance window is a 60 minute period. Valid values + // for ddd are:

    Specifies the weekly time range during which maintenance on + // the cluster is performed. It is specified as a range in the format + // ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 + // minute period. Valid values for ddd are: + // + // * sun + // + // * mon + // + // * tue + // + // * + // wed + // + // * thu + // + // * fri + // + // * sat + // + // Example: sun:23:00-mon:01:30 + PreferredMaintenanceWindow *string // The ID of the replication group to which this cluster should belong. If this // parameter is specified, the cluster is added to the specified replication group @@ -239,37 +251,10 @@ type CreateCacheClusterInput struct { // redis. ReplicationGroupId *string - // The number of days for which ElastiCache retains automatic snapshots before - // deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot - // taken today is retained for 5 days before being deleted. This parameter is only - // valid if the Engine parameter is redis. Default: 0 (i.e., automatic backups are - // disabled for this cache cluster). - SnapshotRetentionLimit *int32 - - // Reserved parameter. The password used to access a password protected server. - // Password constraints: - // - // * Must be only printable ASCII characters. - // - // * - // Must be at least 16 characters and no more than 128 characters in length. - // - // * - // The only permitted printable special characters are !, &, #, $, ^, <, >, and -. - // Other printable special characters cannot be used in the AUTH token. - // - // For more - // information, see AUTH password (http://redis.io/commands/AUTH) at - // http://redis.io/commands/AUTH. - AuthToken *string - - // The name of the subnet group to be used for the cluster. Use this parameter only - // when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC). - // If you're going to launch your cluster in an Amazon VPC, you need to create a - // subnet group before you start creating a cluster. For more information, see - // Subnets and Subnet Groups - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.html). - CacheSubnetGroupName *string + // One or more VPC security groups associated with the cluster. Use this parameter + // only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon + // VPC). + SecurityGroupIds []*string // A single-element string list containing an Amazon Resource Name (ARN) that // uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot @@ -279,12 +264,27 @@ type CreateCacheClusterInput struct { // arn:aws:s3:::my_bucket/snapshot1.rdb SnapshotArns []*string - // Specifies whether the nodes in this Memcached cluster are created in a single - // Availability Zone or created across multiple Availability Zones in the cluster's - // region. This parameter is only supported for Memcached clusters. If the AZMode - // and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az - // mode. - AZMode types.AZMode + // The name of a Redis snapshot from which to restore data into the new node group + // (shard). The snapshot status changes to restoring while the new node group + // (shard) is being created. This parameter is only valid if the Engine parameter + // is redis. + SnapshotName *string + + // The number of days for which ElastiCache retains automatic snapshots before + // deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot + // taken today is retained for 5 days before being deleted. This parameter is only + // valid if the Engine parameter is redis. Default: 0 (i.e., automatic backups are + // disabled for this cache cluster). + SnapshotRetentionLimit *int32 + + // The daily time range (in UTC) during which ElastiCache begins taking a daily + // snapshot of your node group (shard). Example: 05:00-09:00 If you do not specify + // this parameter, ElastiCache automatically chooses an appropriate time range. + // This parameter is only valid if the Engine parameter is redis. + SnapshotWindow *string + + // A list of cost allocation tags to be added to this resource. + Tags []*types.Tag } type CreateCacheClusterOutput struct { diff --git a/service/elasticache/api_op_CreateCacheParameterGroup.go b/service/elasticache/api_op_CreateCacheParameterGroup.go index 8837a88aaeb..ca4e5cffc1a 100644 --- a/service/elasticache/api_op_CreateCacheParameterGroup.go +++ b/service/elasticache/api_op_CreateCacheParameterGroup.go @@ -72,11 +72,6 @@ func (c *Client) CreateCacheParameterGroup(ctx context.Context, params *CreateCa // Represents the input of a CreateCacheParameterGroup operation. type CreateCacheParameterGroupInput struct { - // A user-specified name for the cache parameter group. - // - // This member is required. - CacheParameterGroupName *string - // The name of the cache parameter group family that the cache parameter group can // be used with. Valid values are: memcached1.4 | memcached1.5 | redis2.6 | // redis2.8 | redis3.2 | redis4.0 | redis5.0 | @@ -84,6 +79,11 @@ type CreateCacheParameterGroupInput struct { // This member is required. CacheParameterGroupFamily *string + // A user-specified name for the cache parameter group. + // + // This member is required. + CacheParameterGroupName *string + // A user-specified description for the cache parameter group. // // This member is required. diff --git a/service/elasticache/api_op_CreateCacheSubnetGroup.go b/service/elasticache/api_op_CreateCacheSubnetGroup.go index 67967815fc5..8ccdec3dff5 100644 --- a/service/elasticache/api_op_CreateCacheSubnetGroup.go +++ b/service/elasticache/api_op_CreateCacheSubnetGroup.go @@ -59,11 +59,6 @@ func (c *Client) CreateCacheSubnetGroup(ctx context.Context, params *CreateCache // Represents the input of a CreateCacheSubnetGroup operation. type CreateCacheSubnetGroupInput struct { - // A list of VPC subnet IDs for the cache subnet group. - // - // This member is required. - SubnetIds []*string - // A description for the cache subnet group. // // This member is required. @@ -75,6 +70,11 @@ type CreateCacheSubnetGroupInput struct { // // This member is required. CacheSubnetGroupName *string + + // A list of VPC subnet IDs for the cache subnet group. + // + // This member is required. + SubnetIds []*string } type CreateCacheSubnetGroupOutput struct { diff --git a/service/elasticache/api_op_CreateReplicationGroup.go b/service/elasticache/api_op_CreateReplicationGroup.go index ff0253cf967..a7ab3b20ee5 100644 --- a/service/elasticache/api_op_CreateReplicationGroup.go +++ b/service/elasticache/api_op_CreateReplicationGroup.go @@ -75,26 +75,27 @@ func (c *Client) CreateReplicationGroup(ctx context.Context, params *CreateRepli // Represents the input of a CreateReplicationGroup operation. type CreateReplicationGroupInput struct { - // A flag that enables in-transit encryption when set to true. You cannot modify - // the value of TransitEncryptionEnabled after the cluster is created. To enable - // in-transit encryption on a cluster you must set TransitEncryptionEnabled to true - // when you create a cluster. This parameter is valid only if the Engine parameter - // is redis, the EngineVersion parameter is 3.2.6, 4.x or later, and the cluster is - // being created in an Amazon VPC. If you enable in-transit encryption, you must - // also specify a value for CacheSubnetGroup. Required: Only available when - // creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or - // later. Default: false For HIPAA compliance, you must specify - // TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup. - TransitEncryptionEnabled *bool + // A user-created description for the replication group. + // + // This member is required. + ReplicationGroupDescription *string - // The name of the cache engine to be used for the clusters in this replication - // group. - Engine *string + // The replication group identifier. This parameter is stored as a lowercase + // string.

    Constraints:

    • A name must contain from 1 to 40 + // alphanumeric characters or hyphens.

    • The first character must + // be a letter.

    • A name cannot end with a hyphen or contain two + // consecutive hyphens.

    + // + // This member is required. + ReplicationGroupId *string - // The daily time range (in UTC) during which ElastiCache begins taking a daily - // snapshot of your node group (shard). Example: 05:00-09:00 If you do not specify - // this parameter, ElastiCache automatically chooses an appropriate time range. - SnapshotWindow *string + // A flag that enables encryption at rest when set to true. You cannot modify the + // value of AtRestEncryptionEnabled after the replication group is created. To + // enable encryption at rest on a replication group you must set + // AtRestEncryptionEnabled to true when you create the replication group. Required: + // Only available when creating a replication group in an Amazon VPC using redis + // version 3.2.6, 4.x or later. Default: false + AtRestEncryptionEnabled *bool // Reserved parameter. The password used to access a password protected server. // AuthToken can be specified only on replication groups where @@ -116,33 +117,8 @@ type CreateReplicationGroupInput struct { // http://redis.io/commands/AUTH. AuthToken *string - // The name of the cache subnet group to be used for the replication group. If - // you're going to launch your cluster in an Amazon VPC, you need to create a - // subnet group before you start creating a cluster. For more information, see - // Subnets and Subnet Groups - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.html). - CacheSubnetGroupName *string - - // The port number on which each member of the replication group accepts - // connections. - Port *int32 - - // A flag that enables encryption at rest when set to true. You cannot modify the - // value of AtRestEncryptionEnabled after the replication group is created. To - // enable encryption at rest on a replication group you must set - // AtRestEncryptionEnabled to true when you create the replication group. Required: - // Only available when creating a replication group in an Amazon VPC using redis - // version 3.2.6, 4.x or later. Default: false - AtRestEncryptionEnabled *bool - - // The identifier of the cluster that serves as the primary for this replication - // group. This cluster must already exist and have a status of available. This - // parameter is not required if NumCacheClusters, NumNodeGroups, or - // ReplicasPerNodeGroup is specified. - PrimaryClusterId *string - - // The name of the Global Datastore - GlobalReplicationGroupId *string + // This parameter is currently disabled. + AutoMinorVersionUpgrade *bool // Specifies whether a read-only replica is automatically promoted to read/write // primary if the existing primary fails.

    @@ -150,38 +126,6 @@ type CreateReplicationGroupInput struct { // enabled) replication groups.

    Default: false

    AutomaticFailoverEnabled *bool - // A list of EC2 Availability Zones in which the replication group's clusters are - // created. The order of the Availability Zones in the list is the order in which - // clusters are allocated. The primary cluster is created in the first AZ in the - // list. This parameter is not used if there is more than one node group (shard). - // You should use NodeGroupConfiguration instead. If you are creating your - // replication group in an Amazon VPC (recommended), you can only locate clusters - // in Availability Zones associated with the subnets in the selected subnet group. - // The number of Availability Zones listed must equal the value of - // NumCacheClusters. Default: system chosen Availability Zones. - PreferredCacheClusterAZs []*string - - // A user-created description for the replication group. - // - // This member is required. - ReplicationGroupDescription *string - - // One or more Amazon VPC security groups associated with this replication group. - // Use this parameter only when you are creating a replication group in an Amazon - // Virtual Private Cloud (Amazon VPC). - SecurityGroupIds []*string - - // The version number of the cache engine to be used for the clusters in this - // replication group. To view the supported cache engine versions, use the - // DescribeCacheEngineVersions operation.

    Important: You can upgrade to - // a newer engine version (see Selecting - // a Cache Engine and Version) in the ElastiCache User Guide, but you - // cannot downgrade to an earlier engine version. If you want to use an earlier - // engine version, you must delete the existing cluster or replication group and - // create it anew with the earlier engine version.

    - EngineVersion *string - // The compute and memory capacity of the nodes in the node group (shard). The // following node types are supported by ElastiCache. Generally speaking, the // current generation types provide more memory and computational power at lower @@ -231,43 +175,58 @@ type CreateReplicationGroupInput struct { // later.

    CacheNodeType *string - // The name of a snapshot from which to restore data into the new replication - // group. The snapshot status changes to restoring while the new replication group - // is being created. - SnapshotName *string + // The name of the parameter group to associate with this replication group. If + // this argument is omitted, the default cache parameter group for the specified + // engine is used. If you are restoring to an engine version that is different than + // the original, you must specify the default version of that version. For example, + // CacheParameterGroupName=default.redis4.0. If you are running Redis version 3.2.4 + // or later, only one node group (shard), and want to use a default parameter + // group, we recommend that you specify the parameter group by name. + // + // * To + // create a Redis (cluster mode disabled) replication group, use + // CacheParameterGroupName=default.redis3.2. + // + // * To create a Redis (cluster mode + // enabled) replication group, use + // CacheParameterGroupName=default.redis3.2.cluster.on. + CacheParameterGroupName *string - // The number of days for which ElastiCache retains automatic snapshots before - // deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot - // that was taken today is retained for 5 days before being deleted. Default: 0 - // (i.e., automatic backups are disabled for this cluster). - SnapshotRetentionLimit *int32 + // A list of cache security group names to associate with this replication group. + CacheSecurityGroupNames []*string - // An optional parameter that specifies the number of replica nodes in each node - // group (shard). Valid values are 0 to 5. - ReplicasPerNodeGroup *int32 + // The name of the cache subnet group to be used for the replication group. If + // you're going to launch your cluster in an Amazon VPC, you need to create a + // subnet group before you start creating a cluster. For more information, see + // Subnets and Subnet Groups + // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.html). + CacheSubnetGroupName *string - // The number of clusters this replication group initially has. This parameter is - // not used if there is more than one node group (shard). You should use - // ReplicasPerNodeGroup instead. If AutomaticFailoverEnabled is true, the value of - // this parameter must be at least 2. If AutomaticFailoverEnabled is false you can - // omit this parameter (it will default to 1), or you can explicitly set it to a - // value between 2 and 6. The maximum permitted value for NumCacheClusters is 6 (1 - // primary plus 5 replicas). - NumCacheClusters *int32 + // The name of the cache engine to be used for the clusters in this replication + // group. + Engine *string - // A list of cost allocation tags to be added to this resource. Tags are - // comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can - // include multiple tags as shown following: Key=myKey, Value=myKeyValue - // Key=mySecondKey, Value=mySecondKeyValue. - Tags []*types.Tag + // The version number of the cache engine to be used for the clusters in this + // replication group. To view the supported cache engine versions, use the + // DescribeCacheEngineVersions operation.

    Important: You can upgrade to + // a newer engine version (see Selecting + // a Cache Engine and Version) in the ElastiCache User Guide, but you + // cannot downgrade to an earlier engine version. If you want to use an earlier + // engine version, you must delete the existing cluster or replication group and + // create it anew with the earlier engine version.

    + EngineVersion *string - // An optional parameter that specifies the number of node groups (shards) for this - // Redis (cluster mode enabled) replication group. For Redis (cluster mode - // disabled) either omit this parameter or set it to 1. Default: 1 - NumNodeGroups *int32 + // The name of the Global Datastore + GlobalReplicationGroupId *string - // A list of cache security group names to associate with this replication group. - CacheSecurityGroupNames []*string + // The ID of the KMS key used to encrypt the disk in the cluster. + KmsKeyId *string + + // A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For + // more information, see Minimizing Downtime: Multi-AZ + // (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html). + MultiAZEnabled *bool // A list of node group (shard) configuration options. Each node group (shard) // configuration has the following members: PrimaryAvailabilityZone, @@ -280,53 +239,39 @@ type CreateReplicationGroupInput struct { // group. NodeGroupConfiguration []*types.NodeGroupConfiguration - // The ID of the KMS key used to encrypt the disk in the cluster. - KmsKeyId *string - - // A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB - // snapshot files stored in Amazon S3. The snapshot files are used to populate the - // new replication group. The Amazon S3 object name in the ARN cannot contain any - // commas. The new replication group will have the number of node groups (console: - // shards) specified by the parameter NumNodeGroups or the number of node groups - // configured by NodeGroupConfiguration regardless of the number of ARNs specified - // here. Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb - SnapshotArns []*string - - // The name of the parameter group to associate with this replication group. If - // this argument is omitted, the default cache parameter group for the specified - // engine is used. If you are restoring to an engine version that is different than - // the original, you must specify the default version of that version. For example, - // CacheParameterGroupName=default.redis4.0. If you are running Redis version 3.2.4 - // or later, only one node group (shard), and want to use a default parameter - // group, we recommend that you specify the parameter group by name. - // - // * To - // create a Redis (cluster mode disabled) replication group, use - // CacheParameterGroupName=default.redis3.2. - // - // * To create a Redis (cluster mode - // enabled) replication group, use - // CacheParameterGroupName=default.redis3.2.cluster.on. - CacheParameterGroupName *string - // The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) // topic to which notifications are sent. The Amazon SNS topic owner must be the // same as the cluster owner. NotificationTopicArn *string - // A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For - // more information, see Minimizing Downtime: Multi-AZ - // (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html). - MultiAZEnabled *bool + // The number of clusters this replication group initially has. This parameter is + // not used if there is more than one node group (shard). You should use + // ReplicasPerNodeGroup instead. If AutomaticFailoverEnabled is true, the value of + // this parameter must be at least 2. If AutomaticFailoverEnabled is false you can + // omit this parameter (it will default to 1), or you can explicitly set it to a + // value between 2 and 6. The maximum permitted value for NumCacheClusters is 6 (1 + // primary plus 5 replicas). + NumCacheClusters *int32 - // The replication group identifier. This parameter is stored as a lowercase - // string.

    Constraints:

    • A name must contain from 1 to 40 - // alphanumeric characters or hyphens.

    • The first character must - // be a letter.

    • A name cannot end with a hyphen or contain two - // consecutive hyphens.

    - // - // This member is required. - ReplicationGroupId *string + // An optional parameter that specifies the number of node groups (shards) for this + // Redis (cluster mode enabled) replication group. For Redis (cluster mode + // disabled) either omit this parameter or set it to 1. Default: 1 + NumNodeGroups *int32 + + // The port number on which each member of the replication group accepts + // connections. + Port *int32 + + // A list of EC2 Availability Zones in which the replication group's clusters are + // created. The order of the Availability Zones in the list is the order in which + // clusters are allocated. The primary cluster is created in the first AZ in the + // list. This parameter is not used if there is more than one node group (shard). + // You should use NodeGroupConfiguration instead. If you are creating your + // replication group in an Amazon VPC (recommended), you can only locate clusters + // in Availability Zones associated with the subnets in the selected subnet group. + // The number of Availability Zones listed must equal the value of + // NumCacheClusters. Default: system chosen Availability Zones. + PreferredCacheClusterAZs []*string // Specifies the weekly time range during which maintenance on the cluster is // performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H @@ -354,8 +299,63 @@ type CreateReplicationGroupInput struct { // Example: sun:23:00-mon:01:30 PreferredMaintenanceWindow *string - // This parameter is currently disabled. - AutoMinorVersionUpgrade *bool + // The identifier of the cluster that serves as the primary for this replication + // group. This cluster must already exist and have a status of available. This + // parameter is not required if NumCacheClusters, NumNodeGroups, or + // ReplicasPerNodeGroup is specified. + PrimaryClusterId *string + + // An optional parameter that specifies the number of replica nodes in each node + // group (shard). Valid values are 0 to 5. + ReplicasPerNodeGroup *int32 + + // One or more Amazon VPC security groups associated with this replication group. + // Use this parameter only when you are creating a replication group in an Amazon + // Virtual Private Cloud (Amazon VPC). + SecurityGroupIds []*string + + // A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB + // snapshot files stored in Amazon S3. The snapshot files are used to populate the + // new replication group. The Amazon S3 object name in the ARN cannot contain any + // commas. The new replication group will have the number of node groups (console: + // shards) specified by the parameter NumNodeGroups or the number of node groups + // configured by NodeGroupConfiguration regardless of the number of ARNs specified + // here. Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb + SnapshotArns []*string + + // The name of a snapshot from which to restore data into the new replication + // group. The snapshot status changes to restoring while the new replication group + // is being created. + SnapshotName *string + + // The number of days for which ElastiCache retains automatic snapshots before + // deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot + // that was taken today is retained for 5 days before being deleted. Default: 0 + // (i.e., automatic backups are disabled for this cluster). + SnapshotRetentionLimit *int32 + + // The daily time range (in UTC) during which ElastiCache begins taking a daily + // snapshot of your node group (shard). Example: 05:00-09:00 If you do not specify + // this parameter, ElastiCache automatically chooses an appropriate time range. + SnapshotWindow *string + + // A list of cost allocation tags to be added to this resource. Tags are + // comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can + // include multiple tags as shown following: Key=myKey, Value=myKeyValue + // Key=mySecondKey, Value=mySecondKeyValue. + Tags []*types.Tag + + // A flag that enables in-transit encryption when set to true. You cannot modify + // the value of TransitEncryptionEnabled after the cluster is created. To enable + // in-transit encryption on a cluster you must set TransitEncryptionEnabled to true + // when you create a cluster. This parameter is valid only if the Engine parameter + // is redis, the EngineVersion parameter is 3.2.6, 4.x or later, and the cluster is + // being created in an Amazon VPC. If you enable in-transit encryption, you must + // also specify a value for CacheSubnetGroup. Required: Only available when + // creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or + // later. Default: false For HIPAA compliance, you must specify + // TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup. + TransitEncryptionEnabled *bool } type CreateReplicationGroupOutput struct { diff --git a/service/elasticache/api_op_CreateSnapshot.go b/service/elasticache/api_op_CreateSnapshot.go index 6d7f5b357e4..4e6554f3dd0 100644 --- a/service/elasticache/api_op_CreateSnapshot.go +++ b/service/elasticache/api_op_CreateSnapshot.go @@ -59,15 +59,15 @@ func (c *Client) CreateSnapshot(ctx context.Context, params *CreateSnapshotInput // Represents the input of a CreateSnapshot operation. type CreateSnapshotInput struct { - // The identifier of an existing cluster. The snapshot is created from this - // cluster. - CacheClusterId *string - // A name for the snapshot being created. // // This member is required. SnapshotName *string + // The identifier of an existing cluster. The snapshot is created from this + // cluster. + CacheClusterId *string + // The ID of the KMS key used to encrypt the snapshot. KmsKeyId *string diff --git a/service/elasticache/api_op_DecreaseNodeGroupsInGlobalReplicationGroup.go b/service/elasticache/api_op_DecreaseNodeGroupsInGlobalReplicationGroup.go index 0a949adb5da..9ac464404de 100644 --- a/service/elasticache/api_op_DecreaseNodeGroupsInGlobalReplicationGroup.go +++ b/service/elasticache/api_op_DecreaseNodeGroupsInGlobalReplicationGroup.go @@ -57,30 +57,30 @@ func (c *Client) DecreaseNodeGroupsInGlobalReplicationGroup(ctx context.Context, type DecreaseNodeGroupsInGlobalReplicationGroupInput struct { - // If the value of NodeGroupCount is less than the current number of node groups - // (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. - // NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. - // ElastiCache for Redis will attempt to remove all node groups listed by - // NodeGroupsToRemove from the cluster.

    - GlobalNodeGroupsToRemove []*string - - // The name of the Global Datastore - // - // This member is required. - GlobalReplicationGroupId *string - // Indicates that the shard reconfiguration process begins immediately. At present, // the only permitted value for this parameter is true. // // This member is required. ApplyImmediately *bool + // The name of the Global Datastore + // + // This member is required. + GlobalReplicationGroupId *string + // The number of node groups (shards) that results from the modification of the // shard configuration // // This member is required. NodeGroupCount *int32 + // If the value of NodeGroupCount is less than the current number of node groups + // (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. + // NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. + // ElastiCache for Redis will attempt to remove all node groups listed by + // NodeGroupsToRemove from the cluster.

    + GlobalNodeGroupsToRemove []*string + // If the value of NodeGroupCount is less than the current number of node groups // (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. // NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. diff --git a/service/elasticache/api_op_DecreaseReplicaCount.go b/service/elasticache/api_op_DecreaseReplicaCount.go index c6d2c164178..014b5690d1e 100644 --- a/service/elasticache/api_op_DecreaseReplicaCount.go +++ b/service/elasticache/api_op_DecreaseReplicaCount.go @@ -60,16 +60,17 @@ func (c *Client) DecreaseReplicaCount(ctx context.Context, params *DecreaseRepli type DecreaseReplicaCountInput struct { - // A list of the node ids to remove from the replication group or node group - // (shard). - ReplicasToRemove []*string - // If True, the number of replica nodes is decreased immediately. // ApplyImmediately=False is not currently supported.

    // // This member is required. ApplyImmediately *bool + // The id of the replication group from which you want to remove replica nodes. + // + // This member is required. + ReplicationGroupId *string + // The number of read replica nodes you want at the completion of this operation. // For Redis (cluster mode disabled) replication groups, this is the number of // replica nodes in the replication group. For Redis (cluster mode enabled) @@ -94,10 +95,9 @@ type DecreaseReplicaCountInput struct { // members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones. ReplicaConfiguration []*types.ConfigureShard - // The id of the replication group from which you want to remove replica nodes. - // - // This member is required. - ReplicationGroupId *string + // A list of the node ids to remove from the replication group or node group + // (shard). + ReplicasToRemove []*string } type DecreaseReplicaCountOutput struct { diff --git a/service/elasticache/api_op_DeleteCacheCluster.go b/service/elasticache/api_op_DeleteCacheCluster.go index 7df2d7d60f6..2d8114d2c20 100644 --- a/service/elasticache/api_op_DeleteCacheCluster.go +++ b/service/elasticache/api_op_DeleteCacheCluster.go @@ -75,16 +75,16 @@ func (c *Client) DeleteCacheCluster(ctx context.Context, params *DeleteCacheClus // Represents the input of a DeleteCacheCluster operation. type DeleteCacheClusterInput struct { - // The user-supplied name of a final cluster snapshot. This is the unique name that - // identifies the snapshot. ElastiCache creates the snapshot, and then deletes the - // cluster immediately afterward. - FinalSnapshotIdentifier *string - // The cluster identifier for the cluster to be deleted. This parameter is not case // sensitive. // // This member is required. CacheClusterId *string + + // The user-supplied name of a final cluster snapshot. This is the unique name that + // identifies the snapshot. ElastiCache creates the snapshot, and then deletes the + // cluster immediately afterward. + FinalSnapshotIdentifier *string } type DeleteCacheClusterOutput struct { diff --git a/service/elasticache/api_op_DeleteReplicationGroup.go b/service/elasticache/api_op_DeleteReplicationGroup.go index 27320e85071..20b36e02125 100644 --- a/service/elasticache/api_op_DeleteReplicationGroup.go +++ b/service/elasticache/api_op_DeleteReplicationGroup.go @@ -65,10 +65,6 @@ func (c *Client) DeleteReplicationGroup(ctx context.Context, params *DeleteRepli // Represents the input of a DeleteReplicationGroup operation. type DeleteReplicationGroupInput struct { - // If set to true, all of the read replicas are deleted, but the primary node is - // retained. - RetainPrimaryCluster *bool - // The identifier for the cluster to be deleted. This parameter is not case // sensitive. // @@ -80,6 +76,10 @@ type DeleteReplicationGroupInput struct { // this is to ensure that it captures the freshest data. After the final snapshot // is taken, the replication group is immediately deleted. FinalSnapshotIdentifier *string + + // If set to true, all of the read replicas are deleted, but the primary node is + // retained. + RetainPrimaryCluster *bool } type DeleteReplicationGroupOutput struct { diff --git a/service/elasticache/api_op_DescribeCacheClusters.go b/service/elasticache/api_op_DescribeCacheClusters.go index 0c9cf893903..bec8e761688 100644 --- a/service/elasticache/api_op_DescribeCacheClusters.go +++ b/service/elasticache/api_op_DescribeCacheClusters.go @@ -70,14 +70,16 @@ func (c *Client) DescribeCacheClusters(ctx context.Context, params *DescribeCach // Represents the input of a DescribeCacheClusters operation. type DescribeCacheClustersInput struct { - // An optional flag that can be included in the DescribeCacheCluster request to - // retrieve information about the individual cache nodes. - ShowCacheNodeInfo *bool + // The user-supplied cluster identifier. If this parameter is specified, only + // information about that specific cluster is returned. This parameter isn't case + // sensitive. + CacheClusterId *string - // An optional flag that can be included in the DescribeCacheCluster request to - // show only nodes (API/CLI: clusters) that are not members of a replication group. - // In practice, this mean Memcached and single node Redis clusters. - ShowCacheClustersNotInReplicationGroups *bool + // An optional marker returned from a prior request. Use this marker for pagination + // of results from this operation. If this parameter is specified, the response + // includes only records beyond the marker, up to the value specified by + // MaxRecords. + Marker *string // The maximum number of records to include in the response. If more records exist // than the specified MaxRecords value, a marker is included in the response so @@ -85,16 +87,14 @@ type DescribeCacheClustersInput struct { //

    Constraints: minimum 20; maximum 100.

    MaxRecords *int32 - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by - // MaxRecords. - Marker *string + // An optional flag that can be included in the DescribeCacheCluster request to + // show only nodes (API/CLI: clusters) that are not members of a replication group. + // In practice, this mean Memcached and single node Redis clusters. + ShowCacheClustersNotInReplicationGroups *bool - // The user-supplied cluster identifier. If this parameter is specified, only - // information about that specific cluster is returned. This parameter isn't case - // sensitive. - CacheClusterId *string + // An optional flag that can be included in the DescribeCacheCluster request to + // retrieve information about the individual cache nodes. + ShowCacheNodeInfo *bool } // Represents the output of a DescribeCacheClusters operation. diff --git a/service/elasticache/api_op_DescribeCacheEngineVersions.go b/service/elasticache/api_op_DescribeCacheEngineVersions.go index 444dc842938..19b248aec80 100644 --- a/service/elasticache/api_op_DescribeCacheEngineVersions.go +++ b/service/elasticache/api_op_DescribeCacheEngineVersions.go @@ -57,8 +57,18 @@ func (c *Client) DescribeCacheEngineVersions(ctx context.Context, params *Descri // Represents the input of a DescribeCacheEngineVersions operation. type DescribeCacheEngineVersionsInput struct { - // The cache engine version to return. Example: 1.4.14 - EngineVersion *string + // The name of a specific cache parameter group family to return details for. Valid + // values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | + // redis4.0 | redis5.0 | Constraints: + // + // * Must be 1 to 255 alphanumeric + // characters + // + // * First character must be a letter + // + // * Cannot end with a + // hyphen or contain two consecutive hyphens + CacheParameterGroupFamily *string // If true, specifies that only the default version of the specified engine or // engine and major version combination is to be returned. @@ -67,25 +77,15 @@ type DescribeCacheEngineVersionsInput struct { // The cache engine to return. Valid values: memcached | redis Engine *string + // The cache engine version to return. Example: 1.4.14 + EngineVersion *string + // An optional marker returned from a prior request. Use this marker for pagination // of results from this operation. If this parameter is specified, the response // includes only records beyond the marker, up to the value specified by // MaxRecords. Marker *string - // The name of a specific cache parameter group family to return details for. Valid - // values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | - // redis4.0 | redis5.0 | Constraints: - // - // * Must be 1 to 255 alphanumeric - // characters - // - // * First character must be a letter - // - // * Cannot end with a - // hyphen or contain two consecutive hyphens - CacheParameterGroupFamily *string - // The maximum number of records to include in the response. If more records exist // than the specified MaxRecords value, a marker is included in the response so // that the remaining results can be retrieved.

    Default: 100

    @@ -96,13 +96,13 @@ type DescribeCacheEngineVersionsInput struct { // Represents the output of a DescribeCacheEngineVersions () operation. type DescribeCacheEngineVersionsOutput struct { - // Provides an identifier to allow retrieval of paginated results. - Marker *string - // A list of cache engine version details. Each element in the list contains // detailed information about one cache engine version. CacheEngineVersions []*types.CacheEngineVersion + // Provides an identifier to allow retrieval of paginated results. + Marker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticache/api_op_DescribeCacheParameterGroups.go b/service/elasticache/api_op_DescribeCacheParameterGroups.go index f4e293fd05c..92614a1dac6 100644 --- a/service/elasticache/api_op_DescribeCacheParameterGroups.go +++ b/service/elasticache/api_op_DescribeCacheParameterGroups.go @@ -58,11 +58,8 @@ func (c *Client) DescribeCacheParameterGroups(ctx context.Context, params *Descr // Represents the input of a DescribeCacheParameterGroups operation. type DescribeCacheParameterGroupsInput struct { - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a marker is included in the response so - // that the remaining results can be retrieved.

    Default: 100

    - //

    Constraints: minimum 20; maximum 100.

    - MaxRecords *int32 + // The name of a specific cache parameter group to return details for. + CacheParameterGroupName *string // An optional marker returned from a prior request. Use this marker for pagination // of results from this operation. If this parameter is specified, the response @@ -70,20 +67,23 @@ type DescribeCacheParameterGroupsInput struct { // MaxRecords. Marker *string - // The name of a specific cache parameter group to return details for. - CacheParameterGroupName *string + // The maximum number of records to include in the response. If more records exist + // than the specified MaxRecords value, a marker is included in the response so + // that the remaining results can be retrieved.

    Default: 100

    + //

    Constraints: minimum 20; maximum 100.

    + MaxRecords *int32 } // Represents the output of a DescribeCacheParameterGroups operation. type DescribeCacheParameterGroupsOutput struct { - // Provides an identifier to allow retrieval of paginated results. - Marker *string - // A list of cache parameter groups. Each element in the list contains detailed // information about one cache parameter group. CacheParameterGroups []*types.CacheParameterGroup + // Provides an identifier to allow retrieval of paginated results. + Marker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticache/api_op_DescribeCacheParameters.go b/service/elasticache/api_op_DescribeCacheParameters.go index c3b501fca39..2f1f0ab74e9 100644 --- a/service/elasticache/api_op_DescribeCacheParameters.go +++ b/service/elasticache/api_op_DescribeCacheParameters.go @@ -58,15 +58,6 @@ func (c *Client) DescribeCacheParameters(ctx context.Context, params *DescribeCa // Represents the input of a DescribeCacheParameters operation. type DescribeCacheParametersInput struct { - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a marker is included in the response so - // that the remaining results can be retrieved.

    Default: 100

    - //

    Constraints: minimum 20; maximum 100.

    - MaxRecords *int32 - - // The parameter types to return. Valid values: user | system | engine-default - Source *string - // The name of a specific cache parameter group to return details for. // // This member is required. @@ -77,20 +68,29 @@ type DescribeCacheParametersInput struct { // includes only records beyond the marker, up to the value specified by // MaxRecords. Marker *string + + // The maximum number of records to include in the response. If more records exist + // than the specified MaxRecords value, a marker is included in the response so + // that the remaining results can be retrieved.

    Default: 100

    + //

    Constraints: minimum 20; maximum 100.

    + MaxRecords *int32 + + // The parameter types to return. Valid values: user | system | engine-default + Source *string } // Represents the output of a DescribeCacheParameters operation. type DescribeCacheParametersOutput struct { - // A list of Parameter () instances. - Parameters []*types.Parameter + // A list of parameters specific to a particular cache node type. Each element in + // the list contains detailed information about one parameter. + CacheNodeTypeSpecificParameters []*types.CacheNodeTypeSpecificParameter // Provides an identifier to allow retrieval of paginated results. Marker *string - // A list of parameters specific to a particular cache node type. Each element in - // the list contains detailed information about one parameter. - CacheNodeTypeSpecificParameters []*types.CacheNodeTypeSpecificParameter + // A list of Parameter () instances. + Parameters []*types.Parameter // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/elasticache/api_op_DescribeCacheSecurityGroups.go b/service/elasticache/api_op_DescribeCacheSecurityGroups.go index fb1f46165ad..c2aa5e15e53 100644 --- a/service/elasticache/api_op_DescribeCacheSecurityGroups.go +++ b/service/elasticache/api_op_DescribeCacheSecurityGroups.go @@ -59,11 +59,8 @@ func (c *Client) DescribeCacheSecurityGroups(ctx context.Context, params *Descri // Represents the input of a DescribeCacheSecurityGroups operation. type DescribeCacheSecurityGroupsInput struct { - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a marker is included in the response so - // that the remaining results can be retrieved.

    Default: 100

    - //

    Constraints: minimum 20; maximum 100.

    - MaxRecords *int32 + // The name of the cache security group to return details for. + CacheSecurityGroupName *string // An optional marker returned from a prior request. Use this marker for pagination // of results from this operation. If this parameter is specified, the response @@ -71,8 +68,11 @@ type DescribeCacheSecurityGroupsInput struct { // MaxRecords. Marker *string - // The name of the cache security group to return details for. - CacheSecurityGroupName *string + // The maximum number of records to include in the response. If more records exist + // than the specified MaxRecords value, a marker is included in the response so + // that the remaining results can be retrieved.

    Default: 100

    + //

    Constraints: minimum 20; maximum 100.

    + MaxRecords *int32 } // Represents the output of a DescribeCacheSecurityGroups operation. diff --git a/service/elasticache/api_op_DescribeCacheSubnetGroups.go b/service/elasticache/api_op_DescribeCacheSubnetGroups.go index 89122311c5b..df68c015f4b 100644 --- a/service/elasticache/api_op_DescribeCacheSubnetGroups.go +++ b/service/elasticache/api_op_DescribeCacheSubnetGroups.go @@ -60,11 +60,8 @@ func (c *Client) DescribeCacheSubnetGroups(ctx context.Context, params *Describe // Represents the input of a DescribeCacheSubnetGroups operation. type DescribeCacheSubnetGroupsInput struct { - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a marker is included in the response so - // that the remaining results can be retrieved.

    Default: 100

    - //

    Constraints: minimum 20; maximum 100.

    - MaxRecords *int32 + // The name of the cache subnet group to return details for. + CacheSubnetGroupName *string // An optional marker returned from a prior request. Use this marker for pagination // of results from this operation. If this parameter is specified, the response @@ -72,8 +69,11 @@ type DescribeCacheSubnetGroupsInput struct { // MaxRecords. Marker *string - // The name of the cache subnet group to return details for. - CacheSubnetGroupName *string + // The maximum number of records to include in the response. If more records exist + // than the specified MaxRecords value, a marker is included in the response so + // that the remaining results can be retrieved.

    Default: 100

    + //

    Constraints: minimum 20; maximum 100.

    + MaxRecords *int32 } // Represents the output of a DescribeCacheSubnetGroups operation. diff --git a/service/elasticache/api_op_DescribeEvents.go b/service/elasticache/api_op_DescribeEvents.go index 342c63e19b9..a344afd3993 100644 --- a/service/elasticache/api_op_DescribeEvents.go +++ b/service/elasticache/api_op_DescribeEvents.go @@ -62,21 +62,28 @@ func (c *Client) DescribeEvents(ctx context.Context, params *DescribeEventsInput // Represents the input of a DescribeEvents operation. type DescribeEventsInput struct { + // The number of minutes worth of events to retrieve. + Duration *int32 + // The end of the time interval for which to retrieve events, specified in ISO 8601 // format. Example: 2017-03-30T07:03:49.555Z EndTime *time.Time + // An optional marker returned from a prior request. Use this marker for pagination + // of results from this operation. If this parameter is specified, the response + // includes only records beyond the marker, up to the value specified by + // MaxRecords. + Marker *string + // The maximum number of records to include in the response. If more records exist // than the specified MaxRecords value, a marker is included in the response so // that the remaining results can be retrieved.

    Default: 100

    //

    Constraints: minimum 20; maximum 100.

    MaxRecords *int32 - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by - // MaxRecords. - Marker *string + // The identifier of the event source for which events are returned. If not + // specified, all sources are included in the response. + SourceIdentifier *string // The event source to retrieve events for. If no value is specified, all events // are returned. @@ -85,25 +92,18 @@ type DescribeEventsInput struct { // The beginning of the time interval to retrieve events for, specified in ISO 8601 // format. Example: 2017-03-30T07:03:49.555Z StartTime *time.Time - - // The identifier of the event source for which events are returned. If not - // specified, all sources are included in the response. - SourceIdentifier *string - - // The number of minutes worth of events to retrieve. - Duration *int32 } // Represents the output of a DescribeEvents operation. type DescribeEventsOutput struct { - // Provides an identifier to allow retrieval of paginated results. - Marker *string - // A list of events. Each element in the list contains detailed information about // one event. Events []*types.Event + // Provides an identifier to allow retrieval of paginated results. + Marker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticache/api_op_DescribeGlobalReplicationGroups.go b/service/elasticache/api_op_DescribeGlobalReplicationGroups.go index 08c44f72aea..2a3fb45246b 100644 --- a/service/elasticache/api_op_DescribeGlobalReplicationGroups.go +++ b/service/elasticache/api_op_DescribeGlobalReplicationGroups.go @@ -57,14 +57,6 @@ func (c *Client) DescribeGlobalReplicationGroups(ctx context.Context, params *De type DescribeGlobalReplicationGroupsInput struct { - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a marker is included in the response so - // that the remaining results can be retrieved. - MaxRecords *int32 - - // Returns the list of members that comprise the Global Datastore. - ShowMemberInfo *bool - // The name of the Global Datastore GlobalReplicationGroupId *string @@ -73,19 +65,27 @@ type DescribeGlobalReplicationGroupsInput struct { // includes only records beyond the marker, up to the value specified by // MaxRecords. Marker *string + + // The maximum number of records to include in the response. If more records exist + // than the specified MaxRecords value, a marker is included in the response so + // that the remaining results can be retrieved. + MaxRecords *int32 + + // Returns the list of members that comprise the Global Datastore. + ShowMemberInfo *bool } type DescribeGlobalReplicationGroupsOutput struct { + // Indicates the slot configuration and global identifier for each slice group. + GlobalReplicationGroups []*types.GlobalReplicationGroup + // An optional marker returned from a prior request. Use this marker for pagination // of results from this operation. If this parameter is specified, the response // includes only records beyond the marker, up to the value specified by // MaxRecords. > Marker *string - // Indicates the slot configuration and global identifier for each slice group. - GlobalReplicationGroups []*types.GlobalReplicationGroup - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticache/api_op_DescribeReplicationGroups.go b/service/elasticache/api_op_DescribeReplicationGroups.go index 6a14ec73b6f..76884976adb 100644 --- a/service/elasticache/api_op_DescribeReplicationGroups.go +++ b/service/elasticache/api_op_DescribeReplicationGroups.go @@ -59,10 +59,11 @@ func (c *Client) DescribeReplicationGroups(ctx context.Context, params *Describe // Represents the input of a DescribeReplicationGroups operation. type DescribeReplicationGroupsInput struct { - // The identifier for the replication group to be described. This parameter is not - // case sensitive. If you do not specify this parameter, information about all - // replication groups is returned. - ReplicationGroupId *string + // An optional marker returned from a prior request. Use this marker for pagination + // of results from this operation. If this parameter is specified, the response + // includes only records beyond the marker, up to the value specified by + // MaxRecords. + Marker *string // The maximum number of records to include in the response. If more records exist // than the specified MaxRecords value, a marker is included in the response so @@ -70,23 +71,22 @@ type DescribeReplicationGroupsInput struct { //

    Constraints: minimum 20; maximum 100.

    MaxRecords *int32 - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by - // MaxRecords. - Marker *string + // The identifier for the replication group to be described. This parameter is not + // case sensitive. If you do not specify this parameter, information about all + // replication groups is returned. + ReplicationGroupId *string } // Represents the output of a DescribeReplicationGroups operation. type DescribeReplicationGroupsOutput struct { + // Provides an identifier to allow retrieval of paginated results. + Marker *string + // A list of replication groups. Each item in the list contains detailed // information about one replication group. ReplicationGroups []*types.ReplicationGroup - // Provides an identifier to allow retrieval of paginated results. - Marker *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticache/api_op_DescribeReservedCacheNodes.go b/service/elasticache/api_op_DescribeReservedCacheNodes.go index 24122ca1690..8b690fb4a8c 100644 --- a/service/elasticache/api_op_DescribeReservedCacheNodes.go +++ b/service/elasticache/api_op_DescribeReservedCacheNodes.go @@ -58,34 +58,6 @@ func (c *Client) DescribeReservedCacheNodes(ctx context.Context, params *Describ // Represents the input of a DescribeReservedCacheNodes operation. type DescribeReservedCacheNodesInput struct { - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a marker is included in the response so - // that the remaining results can be retrieved.

    Default: 100

    - //

    Constraints: minimum 20; maximum 100.

    - MaxRecords *int32 - - // The offering identifier filter value. Use this parameter to show only purchased - // reservations matching the specified offering identifier. - ReservedCacheNodesOfferingId *string - - // The offering type filter value. Use this parameter to show only the available - // offerings matching the specified offering type. Valid values: "Light - // Utilization"|"Medium Utilization"|"Heavy Utilization" - OfferingType *string - - // The reserved cache node identifier filter value. Use this parameter to show only - // the reservation that matches the specified reservation ID. - ReservedCacheNodeId *string - - // The product description filter value. Use this parameter to show only those - // reservations matching the specified product description. - ProductDescription *string - - // The duration filter value, specified in years or seconds. Use this parameter to - // show only reservations for this duration. Valid Values: 1 | 3 | 31536000 | - // 94608000 - Duration *string - // The cache node type filter value. Use this parameter to show only those // reservations matching the specified cache node type.

    The following node // types are supported by ElastiCache. Generally speaking, the current generation @@ -132,23 +104,51 @@ type DescribeReservedCacheNodesInput struct { // later.

    CacheNodeType *string + // The duration filter value, specified in years or seconds. Use this parameter to + // show only reservations for this duration. Valid Values: 1 | 3 | 31536000 | + // 94608000 + Duration *string + // An optional marker returned from a prior request. Use this marker for pagination // of results from this operation. If this parameter is specified, the response // includes only records beyond the marker, up to the value specified by // MaxRecords. Marker *string + + // The maximum number of records to include in the response. If more records exist + // than the specified MaxRecords value, a marker is included in the response so + // that the remaining results can be retrieved.

    Default: 100

    + //

    Constraints: minimum 20; maximum 100.

    + MaxRecords *int32 + + // The offering type filter value. Use this parameter to show only the available + // offerings matching the specified offering type. Valid values: "Light + // Utilization"|"Medium Utilization"|"Heavy Utilization" + OfferingType *string + + // The product description filter value. Use this parameter to show only those + // reservations matching the specified product description. + ProductDescription *string + + // The reserved cache node identifier filter value. Use this parameter to show only + // the reservation that matches the specified reservation ID. + ReservedCacheNodeId *string + + // The offering identifier filter value. Use this parameter to show only purchased + // reservations matching the specified offering identifier. + ReservedCacheNodesOfferingId *string } // Represents the output of a DescribeReservedCacheNodes operation. type DescribeReservedCacheNodesOutput struct { + // Provides an identifier to allow retrieval of paginated results. + Marker *string + // A list of reserved cache nodes. Each element in the list contains detailed // information about one node. ReservedCacheNodes []*types.ReservedCacheNode - // Provides an identifier to allow retrieval of paginated results. - Marker *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticache/api_op_DescribeReservedCacheNodesOfferings.go b/service/elasticache/api_op_DescribeReservedCacheNodesOfferings.go index 3b3d33c0972..410985a27d1 100644 --- a/service/elasticache/api_op_DescribeReservedCacheNodesOfferings.go +++ b/service/elasticache/api_op_DescribeReservedCacheNodesOfferings.go @@ -103,25 +103,11 @@ type DescribeReservedCacheNodesOfferingsInput struct { // later.

    CacheNodeType *string - // The offering type filter value. Use this parameter to show only the available - // offerings matching the specified offering type. Valid Values: "Light - // Utilization"|"Medium Utilization"|"Heavy Utilization" - OfferingType *string - - // The offering identifier filter value. Use this parameter to show only the - // available offering that matches the specified reservation identifier. Example: - // 438012d3-4052-4cc7-b2e3-8d3372e0e706 - ReservedCacheNodesOfferingId *string - // Duration filter value, specified in years or seconds. Use this parameter to show // only reservations for a given duration. Valid Values: 1 | 3 | 31536000 | // 94608000 Duration *string - // The product description filter value. Use this parameter to show only the - // available offerings matching the specified product description. - ProductDescription *string - // An optional marker returned from a prior request. Use this marker for pagination // of results from this operation. If this parameter is specified, the response // includes only records beyond the marker, up to the value specified by @@ -133,6 +119,20 @@ type DescribeReservedCacheNodesOfferingsInput struct { // that the remaining results can be retrieved.

    Default: 100

    //

    Constraints: minimum 20; maximum 100.

    MaxRecords *int32 + + // The offering type filter value. Use this parameter to show only the available + // offerings matching the specified offering type. Valid Values: "Light + // Utilization"|"Medium Utilization"|"Heavy Utilization" + OfferingType *string + + // The product description filter value. Use this parameter to show only the + // available offerings matching the specified product description. + ProductDescription *string + + // The offering identifier filter value. Use this parameter to show only the + // available offering that matches the specified reservation identifier. Example: + // 438012d3-4052-4cc7-b2e3-8d3372e0e706 + ReservedCacheNodesOfferingId *string } // Represents the output of a DescribeReservedCacheNodesOfferings operation. diff --git a/service/elasticache/api_op_DescribeServiceUpdates.go b/service/elasticache/api_op_DescribeServiceUpdates.go index 323c3dc5bc0..f0ead30c274 100644 --- a/service/elasticache/api_op_DescribeServiceUpdates.go +++ b/service/elasticache/api_op_DescribeServiceUpdates.go @@ -62,27 +62,27 @@ type DescribeServiceUpdatesInput struct { // MaxRecords. Marker *string - // The status of the service update - ServiceUpdateStatus []types.ServiceUpdateStatus - // The maximum number of records to include in the response MaxRecords *int32 // The unique ID of the service update ServiceUpdateName *string + + // The status of the service update + ServiceUpdateStatus []types.ServiceUpdateStatus } type DescribeServiceUpdatesOutput struct { - // A list of service updates - ServiceUpdates []*types.ServiceUpdate - // An optional marker returned from a prior request. Use this marker for pagination // of results from this operation. If this parameter is specified, the response // includes only records beyond the marker, up to the value specified by // MaxRecords. Marker *string + // A list of service updates + ServiceUpdates []*types.ServiceUpdate + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticache/api_op_DescribeSnapshots.go b/service/elasticache/api_op_DescribeSnapshots.go index 40873bb64a6..f3a27575682 100644 --- a/service/elasticache/api_op_DescribeSnapshots.go +++ b/service/elasticache/api_op_DescribeSnapshots.go @@ -60,19 +60,9 @@ func (c *Client) DescribeSnapshots(ctx context.Context, params *DescribeSnapshot // Represents the input of a DescribeSnapshotsMessage operation. type DescribeSnapshotsInput struct { - // A Boolean value which if true, the node group (shard) configuration is included - // in the snapshot description. - ShowNodeGroupConfig *bool - - // A user-supplied replication group identifier. If this parameter is specified, - // only snapshots associated with that specific replication group are described. - ReplicationGroupId *string - - // If set to system, the output shows snapshots that were automatically created by - // ElastiCache. If set to user the output shows snapshots that were manually - // created. If omitted, the output shows both automatically and manually created - // snapshots. - SnapshotSource *string + // A user-supplied cluster identifier. If this parameter is specified, only + // snapshots associated with that specific cluster are described. + CacheClusterId *string // An optional marker returned from a prior request. Use this marker for pagination // of results from this operation. If this parameter is specified, the response @@ -80,19 +70,29 @@ type DescribeSnapshotsInput struct { // MaxRecords. Marker *string - // A user-supplied cluster identifier. If this parameter is specified, only - // snapshots associated with that specific cluster are described. - CacheClusterId *string - - // A user-supplied name of the snapshot. If this parameter is specified, only this - // snapshot are described. - SnapshotName *string - // The maximum number of records to include in the response. If more records exist // than the specified MaxRecords value, a marker is included in the response so // that the remaining results can be retrieved. Default: 50 Constraints: minimum // 20; maximum 50. MaxRecords *int32 + + // A user-supplied replication group identifier. If this parameter is specified, + // only snapshots associated with that specific replication group are described. + ReplicationGroupId *string + + // A Boolean value which if true, the node group (shard) configuration is included + // in the snapshot description. + ShowNodeGroupConfig *bool + + // A user-supplied name of the snapshot. If this parameter is specified, only this + // snapshot are described. + SnapshotName *string + + // If set to system, the output shows snapshots that were automatically created by + // ElastiCache. If set to user the output shows snapshots that were manually + // created. If omitted, the output shows both automatically and manually created + // snapshots. + SnapshotSource *string } // Represents the output of a DescribeSnapshots operation. diff --git a/service/elasticache/api_op_DescribeUpdateActions.go b/service/elasticache/api_op_DescribeUpdateActions.go index 9cc690d652d..05f15818f1f 100644 --- a/service/elasticache/api_op_DescribeUpdateActions.go +++ b/service/elasticache/api_op_DescribeUpdateActions.go @@ -56,27 +56,18 @@ func (c *Client) DescribeUpdateActions(ctx context.Context, params *DescribeUpda type DescribeUpdateActionsInput struct { - // Dictates whether to include node level update status in the response - ShowNodeLevelUpdateStatus *bool + // The cache cluster IDs + CacheClusterIds []*string // The Elasticache engine to which the update applies. Either Redis or Memcached Engine *string - // The status of the update action. - UpdateActionStatus []types.UpdateActionStatus - - // The cache cluster IDs - CacheClusterIds []*string - // An optional marker returned from a prior request. Use this marker for pagination // of results from this operation. If this parameter is specified, the response // includes only records beyond the marker, up to the value specified by // MaxRecords. Marker *string - // The status of the service update - ServiceUpdateStatus []types.ServiceUpdateStatus - // The maximum number of records to include in the response MaxRecords *int32 @@ -86,9 +77,18 @@ type DescribeUpdateActionsInput struct { // The unique ID of the service update ServiceUpdateName *string + // The status of the service update + ServiceUpdateStatus []types.ServiceUpdateStatus + // The range of time specified to search for service updates that are in available // status ServiceUpdateTimeRange *types.TimeRangeFilter + + // Dictates whether to include node level update status in the response + ShowNodeLevelUpdateStatus *bool + + // The status of the update action. + UpdateActionStatus []types.UpdateActionStatus } type DescribeUpdateActionsOutput struct { diff --git a/service/elasticache/api_op_DisassociateGlobalReplicationGroup.go b/service/elasticache/api_op_DisassociateGlobalReplicationGroup.go index 0acb9397620..bb47de9640f 100644 --- a/service/elasticache/api_op_DisassociateGlobalReplicationGroup.go +++ b/service/elasticache/api_op_DisassociateGlobalReplicationGroup.go @@ -59,6 +59,11 @@ func (c *Client) DisassociateGlobalReplicationGroup(ctx context.Context, params type DisassociateGlobalReplicationGroupInput struct { + // The name of the Global Datastore + // + // This member is required. + GlobalReplicationGroupId *string + // The name of the secondary cluster you wish to remove from the Global Datastore // // This member is required. @@ -68,11 +73,6 @@ type DisassociateGlobalReplicationGroupInput struct { // // This member is required. ReplicationGroupRegion *string - - // The name of the Global Datastore - // - // This member is required. - GlobalReplicationGroupId *string } type DisassociateGlobalReplicationGroupOutput struct { diff --git a/service/elasticache/api_op_FailoverGlobalReplicationGroup.go b/service/elasticache/api_op_FailoverGlobalReplicationGroup.go index 1a57c02550c..edf8d660c22 100644 --- a/service/elasticache/api_op_FailoverGlobalReplicationGroup.go +++ b/service/elasticache/api_op_FailoverGlobalReplicationGroup.go @@ -59,11 +59,6 @@ func (c *Client) FailoverGlobalReplicationGroup(ctx context.Context, params *Fai type FailoverGlobalReplicationGroupInput struct { - // The name of the primary replication group - // - // This member is required. - PrimaryReplicationGroupId *string - // The name of the Global Datastore // // This member is required. @@ -73,6 +68,11 @@ type FailoverGlobalReplicationGroupInput struct { // // This member is required. PrimaryRegion *string + + // The name of the primary replication group + // + // This member is required. + PrimaryReplicationGroupId *string } type FailoverGlobalReplicationGroupOutput struct { diff --git a/service/elasticache/api_op_IncreaseNodeGroupsInGlobalReplicationGroup.go b/service/elasticache/api_op_IncreaseNodeGroupsInGlobalReplicationGroup.go index 7f0a95f9530..1a5417a9d62 100644 --- a/service/elasticache/api_op_IncreaseNodeGroupsInGlobalReplicationGroup.go +++ b/service/elasticache/api_op_IncreaseNodeGroupsInGlobalReplicationGroup.go @@ -57,25 +57,25 @@ func (c *Client) IncreaseNodeGroupsInGlobalReplicationGroup(ctx context.Context, type IncreaseNodeGroupsInGlobalReplicationGroupInput struct { - // The number of node groups you wish to add - // - // This member is required. - NodeGroupCount *int32 - // Indicates that the process begins immediately. At present, the only permitted // value for this parameter is true. // // This member is required. ApplyImmediately *bool - // Describes the replication group IDs, the AWS regions where they are stored and - // the shard configuration for each that comprise the Global Datastore - RegionalConfigurations []*types.RegionalConfiguration - // The name of the Global Datastore // // This member is required. GlobalReplicationGroupId *string + + // The number of node groups you wish to add + // + // This member is required. + NodeGroupCount *int32 + + // Describes the replication group IDs, the AWS regions where they are stored and + // the shard configuration for each that comprise the Global Datastore + RegionalConfigurations []*types.RegionalConfiguration } type IncreaseNodeGroupsInGlobalReplicationGroupOutput struct { diff --git a/service/elasticache/api_op_IncreaseReplicaCount.go b/service/elasticache/api_op_IncreaseReplicaCount.go index 1779a08fc01..4f6cbe58c95 100644 --- a/service/elasticache/api_op_IncreaseReplicaCount.go +++ b/service/elasticache/api_op_IncreaseReplicaCount.go @@ -60,10 +60,11 @@ func (c *Client) IncreaseReplicaCount(ctx context.Context, params *IncreaseRepli type IncreaseReplicaCountInput struct { - // A list of ConfigureShard objects that can be used to configure each shard in a - // Redis (cluster mode enabled) replication group. The ConfigureShard has three - // members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones. - ReplicaConfiguration []*types.ConfigureShard + // If True, the number of replica nodes is increased immediately. + // ApplyImmediately=False is not currently supported.

    + // + // This member is required. + ApplyImmediately *bool // The id of the replication group to which you want to add replica nodes. // @@ -77,11 +78,10 @@ type IncreaseReplicaCountInput struct { // replication group's node groups. NewReplicaCount *int32 - // If True, the number of replica nodes is increased immediately. - // ApplyImmediately=False is not currently supported.

    - // - // This member is required. - ApplyImmediately *bool + // A list of ConfigureShard objects that can be used to configure each shard in a + // Redis (cluster mode enabled) replication group. The ConfigureShard has three + // members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones. + ReplicaConfiguration []*types.ConfigureShard } type IncreaseReplicaCountOutput struct { diff --git a/service/elasticache/api_op_ListAllowedNodeTypeModifications.go b/service/elasticache/api_op_ListAllowedNodeTypeModifications.go index 47ba64b513b..7f2de205ea2 100644 --- a/service/elasticache/api_op_ListAllowedNodeTypeModifications.go +++ b/service/elasticache/api_op_ListAllowedNodeTypeModifications.go @@ -61,14 +61,6 @@ func (c *Client) ListAllowedNodeTypeModifications(ctx context.Context, params *L // The input parameters for the ListAllowedNodeTypeModifications operation. type ListAllowedNodeTypeModificationsInput struct { - // The name of the replication group want to scale up to a larger node type. - // ElastiCache uses the replication group id to identify the current node type - // being used by this replication group, and from that to create a list of node - // types you can scale up to.

    You must provide a value for either - // the CacheClusterId or the ReplicationGroupId.

    - //     - ReplicationGroupId *string - // The name of the cluster you want to scale up to a larger node instanced type. // ElastiCache uses the cluster id to identify the current node type of this // cluster and from that to create a list of node types you can scale up to. @@ -76,24 +68,32 @@ type ListAllowedNodeTypeModificationsInput struct { // CacheClusterId or the ReplicationGroupId.

    // CacheClusterId *string + + // The name of the replication group want to scale up to a larger node type. + // ElastiCache uses the replication group id to identify the current node type + // being used by this replication group, and from that to create a list of node + // types you can scale up to.

    You must provide a value for either + // the CacheClusterId or the ReplicationGroupId.

    + //     + ReplicationGroupId *string } // Represents the allowed node types you can use to modify your cluster or // replication group. type ListAllowedNodeTypeModificationsOutput struct { - // A string list, each element of which specifies a cache node type which you can - // use to scale your cluster or replication group. When scaling up a Redis cluster - // or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a - // value from this list for the CacheNodeType parameter. - ScaleUpModifications []*string - // A string list, each element of which specifies a cache node type which you can // use to scale your cluster or replication group. When scaling down a Redis // cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, // use a value from this list for the CacheNodeType parameter.

    ScaleDownModifications []*string + // A string list, each element of which specifies a cache node type which you can + // use to scale your cluster or replication group. When scaling up a Redis cluster + // or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a + // value from this list for the CacheNodeType parameter. + ScaleUpModifications []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticache/api_op_ModifyCacheCluster.go b/service/elasticache/api_op_ModifyCacheCluster.go index 75960927659..ee7c0da9067 100644 --- a/service/elasticache/api_op_ModifyCacheCluster.go +++ b/service/elasticache/api_op_ModifyCacheCluster.go @@ -60,20 +60,19 @@ func (c *Client) ModifyCacheCluster(ctx context.Context, params *ModifyCacheClus // Represents the input of a ModifyCacheCluster operation. type ModifyCacheClusterInput struct { - // The upgraded version of the cache engine to be run on the cache nodes.

    - // Important: You can upgrade to a newer engine version (see Selecting - // a Cache Engine and Version), but you cannot downgrade to an earlier engine - // version. If you want to use an earlier engine version, you must delete the - // existing cluster and create it anew with the earlier engine version.

    - EngineVersion *string + // The cluster identifier. This value is stored as a lowercase string. + // + // This member is required. + CacheClusterId *string - // A list of cache security group names to authorize on this cluster. This change - // is asynchronously applied as soon as possible. You can use this parameter only - // with clusters that are created outside of an Amazon Virtual Private Cloud - // (Amazon VPC). Constraints: Must contain no more than 255 alphanumeric - // characters. Must not be "Default". - CacheSecurityGroupNames []*string + // Specifies whether the new nodes in this Memcached cluster are all created in a + // single Availability Zone or created across multiple Availability Zones. Valid + // values: single-az | cross-az. This option is only supported for Memcached + // clusters. You cannot specify single-az if the Memcached cluster already has + // cache nodes in different Availability Zones. If cross-az is specified, existing + // Memcached nodes remain in their current Availability Zone. Only newly created + // nodes are located in different Availability Zones. + AZMode types.AZMode // If true, this parameter causes the modifications in this request and any pending // modifications to be applied, asynchronously and as soon as possible, regardless @@ -84,36 +83,70 @@ type ModifyCacheClusterInput struct { // newer modification. Valid values: true | false Default: false ApplyImmediately *bool + // Reserved parameter. The password used to access a password protected server. + // This parameter must be specified with the auth-token-update parameter. Password + // constraints: + // + // * Must be only printable ASCII characters + // + // * Must be at + // least 16 characters and no more than 128 characters in length + // + // * Cannot + // contain any of the following characters: '/', '"', or '@', '%' + // + // For more + // information, see AUTH password at AUTH.

    + AuthToken *string + + // Specifies the strategy to use to update the AUTH token. This parameter must be + // specified with the auth-token parameter. Possible values: + // + // * Rotate + // + // * + // Set + // + // For more information, see Authenticating Users with Redis AUTH + // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html) + AuthTokenUpdateStrategy types.AuthTokenUpdateStrategyType + // This parameter is currently disabled. AutoMinorVersionUpgrade *bool + // A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, + // 0002, etc.). This parameter is only valid when NumCacheNodes is less than the + // existing number of cache nodes. The number of cache node IDs supplied in this + // parameter must match the difference between the existing number of cache nodes + // in the cluster or pending cache nodes, whichever is greater, and the value of + // NumCacheNodes in the request. For example: If you have 3 active cache nodes, 7 + // pending cache nodes, and the number of cache nodes in this ModifyCacheCluster + // call is 5, you must list 2 (7 - 5) cache node IDs to remove. + CacheNodeIdsToRemove []*string + + // A valid cache node type that you want to scale this cluster up to. + CacheNodeType *string + // The name of the cache parameter group to apply to this cluster. This change is // asynchronously applied as soon as possible for parameters when the // ApplyImmediately parameter is specified as true for this request. CacheParameterGroupName *string - // Specifies the weekly time range during which maintenance on the cluster is - // performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H - // Clock UTC). The minimum maintenance window is a 60 minute period. Valid values - // for ddd are: - // - // * sun - // - // * mon - // - // * tue - // - // * wed - // - // * thu - // - // * fri - // - // - // * sat - // - // Example: sun:23:00-mon:01:30 - PreferredMaintenanceWindow *string + // A list of cache security group names to authorize on this cluster. This change + // is asynchronously applied as soon as possible. You can use this parameter only + // with clusters that are created outside of an Amazon Virtual Private Cloud + // (Amazon VPC). Constraints: Must contain no more than 255 alphanumeric + // characters. Must not be "Default". + CacheSecurityGroupNames []*string + + // The upgraded version of the cache engine to be run on the cache nodes.

    + // Important: You can upgrade to a newer engine version (see Selecting + // a Cache Engine and Version), but you cannot downgrade to an earlier engine + // version. If you want to use an earlier engine version, you must delete the + // existing cluster and create it anew with the earlier engine version.

    + EngineVersion *string // The list of Availability Zones where the new Memcached cache nodes are created. // This parameter is only valid when NumCacheNodes in the request is greater than @@ -166,10 +199,9 @@ type ModifyCacheClusterInput struct { // are sent. The Amazon SNS topic owner must be same as the cluster owner. NotificationTopicArn *string - // Specifies the VPC Security Groups associated with the cluster. This parameter - // can be used only with clusters that are created in an Amazon Virtual Private - // Cloud (Amazon VPC). - SecurityGroupIds []*string + // The status of the Amazon SNS notification topic. Notifications are sent only if + // the status is active. Valid values: active | inactive + NotificationTopicStatus *string // The number of cache nodes that the cluster should have. If the value for // NumCacheNodes is greater than the sum of the number of current cache nodes and @@ -199,75 +231,43 @@ type ModifyCacheClusterInput struct { // to the number of cache nodes currently in the cluster.

    NumCacheNodes *int32 - // A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, - // 0002, etc.). This parameter is only valid when NumCacheNodes is less than the - // existing number of cache nodes. The number of cache node IDs supplied in this - // parameter must match the difference between the existing number of cache nodes - // in the cluster or pending cache nodes, whichever is greater, and the value of - // NumCacheNodes in the request. For example: If you have 3 active cache nodes, 7 - // pending cache nodes, and the number of cache nodes in this ModifyCacheCluster - // call is 5, you must list 2 (7 - 5) cache node IDs to remove. - CacheNodeIdsToRemove []*string - - // A valid cache node type that you want to scale this cluster up to. - CacheNodeType *string - - // The cluster identifier. This value is stored as a lowercase string. + // Specifies the weekly time range during which maintenance on the cluster is + // performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H + // Clock UTC). The minimum maintenance window is a 60 minute period. Valid values + // for ddd are: // - // This member is required. - CacheClusterId *string - - // The daily time range (in UTC) during which ElastiCache begins taking a daily - // snapshot of your cluster. - SnapshotWindow *string - - // The number of days for which ElastiCache retains automatic cluster snapshots - // before deleting them. For example, if you set SnapshotRetentionLimit to 5, a - // snapshot that was taken today is retained for 5 days before being deleted. If - // the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. - SnapshotRetentionLimit *int32 - - // The status of the Amazon SNS notification topic. Notifications are sent only if - // the status is active. Valid values: active | inactive - NotificationTopicStatus *string - - // Specifies the strategy to use to update the AUTH token. This parameter must be - // specified with the auth-token parameter. Possible values: + // * sun // - // * Rotate + // * mon // - // * - // Set + // * tue // - // For more information, see Authenticating Users with Redis AUTH - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html) - AuthTokenUpdateStrategy types.AuthTokenUpdateStrategyType - - // Reserved parameter. The password used to access a password protected server. - // This parameter must be specified with the auth-token-update parameter. Password - // constraints: + // * wed // - // * Must be only printable ASCII characters + // * thu // - // * Must be at - // least 16 characters and no more than 128 characters in length + // * fri // - // * Cannot - // contain any of the following characters: '/', '"', or '@', '%' // - // For more - // information, see AUTH password at AUTH.

    - AuthToken *string + // * sat + // + // Example: sun:23:00-mon:01:30 + PreferredMaintenanceWindow *string - // Specifies whether the new nodes in this Memcached cluster are all created in a - // single Availability Zone or created across multiple Availability Zones. Valid - // values: single-az | cross-az. This option is only supported for Memcached - // clusters. You cannot specify single-az if the Memcached cluster already has - // cache nodes in different Availability Zones. If cross-az is specified, existing - // Memcached nodes remain in their current Availability Zone. Only newly created - // nodes are located in different Availability Zones. - AZMode types.AZMode + // Specifies the VPC Security Groups associated with the cluster. This parameter + // can be used only with clusters that are created in an Amazon Virtual Private + // Cloud (Amazon VPC). + SecurityGroupIds []*string + + // The number of days for which ElastiCache retains automatic cluster snapshots + // before deleting them. For example, if you set SnapshotRetentionLimit to 5, a + // snapshot that was taken today is retained for 5 days before being deleted. If + // the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. + SnapshotRetentionLimit *int32 + + // The daily time range (in UTC) during which ElastiCache begins taking a daily + // snapshot of your cluster. + SnapshotWindow *string } type ModifyCacheClusterOutput struct { diff --git a/service/elasticache/api_op_ModifyCacheParameterGroup.go b/service/elasticache/api_op_ModifyCacheParameterGroup.go index 81c7c2b1901..3464244688f 100644 --- a/service/elasticache/api_op_ModifyCacheParameterGroup.go +++ b/service/elasticache/api_op_ModifyCacheParameterGroup.go @@ -60,17 +60,17 @@ func (c *Client) ModifyCacheParameterGroup(ctx context.Context, params *ModifyCa // Represents the input of a ModifyCacheParameterGroup operation. type ModifyCacheParameterGroupInput struct { + // The name of the cache parameter group to modify. + // + // This member is required. + CacheParameterGroupName *string + // An array of parameter names and values for the parameter update. You must supply // at least one parameter name and value; subsequent arguments are optional. A // maximum of 20 parameters may be modified per request. // // This member is required. ParameterNameValues []*types.ParameterNameValue - - // The name of the cache parameter group to modify. - // - // This member is required. - CacheParameterGroupName *string } // Represents the output of one of the following operations: diff --git a/service/elasticache/api_op_ModifyCacheSubnetGroup.go b/service/elasticache/api_op_ModifyCacheSubnetGroup.go index 0a46cf945ee..1e95bd52013 100644 --- a/service/elasticache/api_op_ModifyCacheSubnetGroup.go +++ b/service/elasticache/api_op_ModifyCacheSubnetGroup.go @@ -65,11 +65,11 @@ type ModifyCacheSubnetGroupInput struct { // This member is required. CacheSubnetGroupName *string - // The EC2 subnet IDs for the cache subnet group. - SubnetIds []*string - // A description of the cache subnet group. CacheSubnetGroupDescription *string + + // The EC2 subnet IDs for the cache subnet group. + SubnetIds []*string } type ModifyCacheSubnetGroupOutput struct { diff --git a/service/elasticache/api_op_ModifyGlobalReplicationGroup.go b/service/elasticache/api_op_ModifyGlobalReplicationGroup.go index 26e111bf86d..0c00a5e069a 100644 --- a/service/elasticache/api_op_ModifyGlobalReplicationGroup.go +++ b/service/elasticache/api_op_ModifyGlobalReplicationGroup.go @@ -57,21 +57,6 @@ func (c *Client) ModifyGlobalReplicationGroup(ctx context.Context, params *Modif type ModifyGlobalReplicationGroupInput struct { - // A valid cache node type that you want to scale this Global Datastore to. - CacheNodeType *string - - // The upgraded version of the cache engine to be run on the clusters in the Global - // Datastore. - EngineVersion *string - - // The name of the Global Datastore - // - // This member is required. - GlobalReplicationGroupId *string - - // A description of the Global Datastore - GlobalReplicationGroupDescription *string - // This parameter causes the modifications in this request and any pending // modifications to be applied, asynchronously and as soon as possible. // Modifications to Global Replication Groups cannot be requested to be applied in @@ -80,9 +65,24 @@ type ModifyGlobalReplicationGroupInput struct { // This member is required. ApplyImmediately *bool + // The name of the Global Datastore + // + // This member is required. + GlobalReplicationGroupId *string + // Determines whether a read replica is automatically promoted to read/write // primary if the existing primary encounters a failure. AutomaticFailoverEnabled *bool + + // A valid cache node type that you want to scale this Global Datastore to. + CacheNodeType *string + + // The upgraded version of the cache engine to be run on the clusters in the Global + // Datastore. + EngineVersion *string + + // A description of the Global Datastore + GlobalReplicationGroupDescription *string } type ModifyGlobalReplicationGroupOutput struct { diff --git a/service/elasticache/api_op_ModifyReplicationGroup.go b/service/elasticache/api_op_ModifyReplicationGroup.go index a39122b31fa..da33ab4cc2c 100644 --- a/service/elasticache/api_op_ModifyReplicationGroup.go +++ b/service/elasticache/api_op_ModifyReplicationGroup.go @@ -64,31 +64,18 @@ func (c *Client) ModifyReplicationGroup(ctx context.Context, params *ModifyRepli // Represents the input of a ModifyReplicationGroups operation. type ModifyReplicationGroupInput struct { - // The daily time range (in UTC) during which ElastiCache begins taking a daily - // snapshot of the node group (shard) specified by SnapshottingClusterId. Example: - // 05:00-09:00 If you do not specify this parameter, ElastiCache automatically - // chooses an appropriate time range. - SnapshotWindow *string - - // The number of days for which ElastiCache retains automatic node group (shard) - // snapshots before deleting them. For example, if you set SnapshotRetentionLimit - // to 5, a snapshot that was taken today is retained for 5 days before being - // deleted. Important If the value of SnapshotRetentionLimit is set to zero (0), - // backups are turned off. - SnapshotRetentionLimit *int32 - - // A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For - // more information, see Minimizing Downtime: Multi-AZ - // (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html). - MultiAZEnabled *bool - - // A valid cache node type that you want to scale this replication group to. - CacheNodeType *string + // The identifier of the replication group to modify. + // + // This member is required. + ReplicationGroupId *string - // The cluster ID that is used as the daily snapshot source for the replication - // group. This parameter cannot be set for Redis (cluster mode enabled) replication - // groups. - SnapshottingClusterId *string + // If true, this parameter causes the modifications in this request and any pending + // modifications to be applied, asynchronously and as soon as possible, regardless + // of the PreferredMaintenanceWindow setting for the replication group. If false, + // changes to the nodes in the replication group are applied on the next + // maintenance reboot, or the next failure reboot, whichever occurs first. Valid + // values: true | false Default: false + ApplyImmediately *bool // Reserved parameter. The password used to access a password protected server. // This parameter must be specified with the auth-token-update-strategy parameter. @@ -107,6 +94,18 @@ type ModifyReplicationGroupInput struct { // href="http://redis.io/commands/AUTH">AUTH.

    AuthToken *string + // Specifies the strategy to use to update the AUTH token. This parameter must be + // specified with the auth-token parameter. Possible values: + // + // * Rotate + // + // * + // Set + // + // For more information, see Authenticating Users with Redis AUTH + // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html) + AuthTokenUpdateStrategy types.AuthTokenUpdateStrategyType + // This parameter is currently disabled. AutoMinorVersionUpgrade *bool @@ -114,10 +113,8 @@ type ModifyReplicationGroupInput struct { // primary if the existing primary encounters a failure. Valid values: true | false AutomaticFailoverEnabled *bool - // The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications - // are sent. The Amazon SNS topic owner must be same as the replication group - // owner. - NotificationTopicArn *string + // A valid cache node type that you want to scale this replication group to. + CacheNodeType *string // The name of the cache parameter group to apply to all of the clusters in this // replication group. This change is asynchronously applied as soon as possible for @@ -125,6 +122,41 @@ type ModifyReplicationGroupInput struct { // request. CacheParameterGroupName *string + // A list of cache security group names to authorize for the clusters in this + // replication group. This change is asynchronously applied as soon as possible. + // This parameter can be used only with replication group containing clusters + // running outside of an Amazon Virtual Private Cloud (Amazon VPC). Constraints: + // Must contain no more than 255 alphanumeric characters. Must not be Default. + CacheSecurityGroupNames []*string + + // The upgraded version of the cache engine to be run on the clusters in the + // replication group.

    Important: You can upgrade to a newer engine + // version (see Selecting + // a Cache Engine and Version), but you cannot downgrade to an earlier engine + // version. If you want to use an earlier engine version, you must delete the + // existing replication group and create it anew with the earlier engine version. + //

    + EngineVersion *string + + // A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For + // more information, see Minimizing Downtime: Multi-AZ + // (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html). + MultiAZEnabled *bool + + // Deprecated. This parameter is not used. + NodeGroupId *string + + // The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications + // are sent. The Amazon SNS topic owner must be same as the replication group + // owner. + NotificationTopicArn *string + + // The status of the Amazon SNS notification topic for the replication group. + // Notifications are sent only if the status is active. Valid values: active | + // inactive + NotificationTopicStatus *string + // Specifies the weekly time range during which maintenance on the cluster is // performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H // Clock UTC). The minimum maintenance window is a 60 minute period. Valid values @@ -148,11 +180,6 @@ type ModifyReplicationGroupInput struct { // Example: sun:23:00-mon:01:30 PreferredMaintenanceWindow *string - // Specifies the VPC Security Groups associated with the clusters in the - // replication group. This parameter can be used only with replication group - // containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC). - SecurityGroupIds []*string - // For replication groups with a single primary, if this parameter is specified, // ElastiCache promotes the specified cluster in the specified replication group to // the primary role. The nodes of all other clusters in the replication group are @@ -162,55 +189,28 @@ type ModifyReplicationGroupInput struct { // A description for the replication group. Maximum length is 255 characters. ReplicationGroupDescription *string - // The upgraded version of the cache engine to be run on the clusters in the - // replication group.

    Important: You can upgrade to a newer engine - // version (see Selecting - // a Cache Engine and Version), but you cannot downgrade to an earlier engine - // version. If you want to use an earlier engine version, you must delete the - // existing replication group and create it anew with the earlier engine version. - //

    - EngineVersion *string - - // A list of cache security group names to authorize for the clusters in this - // replication group. This change is asynchronously applied as soon as possible. - // This parameter can be used only with replication group containing clusters - // running outside of an Amazon Virtual Private Cloud (Amazon VPC). Constraints: - // Must contain no more than 255 alphanumeric characters. Must not be Default. - CacheSecurityGroupNames []*string - - // If true, this parameter causes the modifications in this request and any pending - // modifications to be applied, asynchronously and as soon as possible, regardless - // of the PreferredMaintenanceWindow setting for the replication group. If false, - // changes to the nodes in the replication group are applied on the next - // maintenance reboot, or the next failure reboot, whichever occurs first. Valid - // values: true | false Default: false - ApplyImmediately *bool - - // Specifies the strategy to use to update the AUTH token. This parameter must be - // specified with the auth-token parameter. Possible values: - // - // * Rotate - // - // * - // Set - // - // For more information, see Authenticating Users with Redis AUTH - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html) - AuthTokenUpdateStrategy types.AuthTokenUpdateStrategyType + // Specifies the VPC Security Groups associated with the clusters in the + // replication group. This parameter can be used only with replication group + // containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC). + SecurityGroupIds []*string - // Deprecated. This parameter is not used. - NodeGroupId *string + // The number of days for which ElastiCache retains automatic node group (shard) + // snapshots before deleting them. For example, if you set SnapshotRetentionLimit + // to 5, a snapshot that was taken today is retained for 5 days before being + // deleted. Important If the value of SnapshotRetentionLimit is set to zero (0), + // backups are turned off. + SnapshotRetentionLimit *int32 - // The identifier of the replication group to modify. - // - // This member is required. - ReplicationGroupId *string + // The daily time range (in UTC) during which ElastiCache begins taking a daily + // snapshot of the node group (shard) specified by SnapshottingClusterId. Example: + // 05:00-09:00 If you do not specify this parameter, ElastiCache automatically + // chooses an appropriate time range. + SnapshotWindow *string - // The status of the Amazon SNS notification topic for the replication group. - // Notifications are sent only if the status is active. Valid values: active | - // inactive - NotificationTopicStatus *string + // The cluster ID that is used as the daily snapshot source for the replication + // group. This parameter cannot be set for Redis (cluster mode enabled) replication + // groups. + SnapshottingClusterId *string } type ModifyReplicationGroupOutput struct { diff --git a/service/elasticache/api_op_ModifyReplicationGroupShardConfiguration.go b/service/elasticache/api_op_ModifyReplicationGroupShardConfiguration.go index ceb1bfd2e5f..b914c4c164d 100644 --- a/service/elasticache/api_op_ModifyReplicationGroupShardConfiguration.go +++ b/service/elasticache/api_op_ModifyReplicationGroupShardConfiguration.go @@ -59,26 +59,12 @@ func (c *Client) ModifyReplicationGroupShardConfiguration(ctx context.Context, p // Represents the input for a ModifyReplicationGroupShardConfiguration operation. type ModifyReplicationGroupShardConfigurationInput struct { - // If the value of NodeGroupCount is less than the current number of node groups - // (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. - // NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster. - // ElastiCache for Redis will attempt to remove all node groups except those listed - // by NodeGroupsToRetain from the cluster. - NodeGroupsToRetain []*string - // Indicates that the shard reconfiguration process begins immediately. At present, // the only permitted value for this parameter is true. Value: true // // This member is required. ApplyImmediately *bool - // If the value of NodeGroupCount is less than the current number of node groups - // (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. - // NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. - // ElastiCache for Redis will attempt to remove all node groups listed by - // NodeGroupsToRemove from the cluster. - NodeGroupsToRemove []*string - // The number of node groups (shards) that results from the modification of the // shard configuration. // @@ -91,6 +77,20 @@ type ModifyReplicationGroupShardConfigurationInput struct { // This member is required. ReplicationGroupId *string + // If the value of NodeGroupCount is less than the current number of node groups + // (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. + // NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. + // ElastiCache for Redis will attempt to remove all node groups listed by + // NodeGroupsToRemove from the cluster. + NodeGroupsToRemove []*string + + // If the value of NodeGroupCount is less than the current number of node groups + // (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. + // NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster. + // ElastiCache for Redis will attempt to remove all node groups except those listed + // by NodeGroupsToRetain from the cluster. + NodeGroupsToRetain []*string + // Specifies the preferred availability zones for each node group in the cluster. // If the value of NodeGroupCount is greater than the current number of node groups // (shards), you can use this parameter to specify the preferred availability zones diff --git a/service/elasticache/api_op_RebalanceSlotsInGlobalReplicationGroup.go b/service/elasticache/api_op_RebalanceSlotsInGlobalReplicationGroup.go index 9aea340c3be..93b6801401c 100644 --- a/service/elasticache/api_op_RebalanceSlotsInGlobalReplicationGroup.go +++ b/service/elasticache/api_op_RebalanceSlotsInGlobalReplicationGroup.go @@ -58,15 +58,15 @@ func (c *Client) RebalanceSlotsInGlobalReplicationGroup(ctx context.Context, par type RebalanceSlotsInGlobalReplicationGroupInput struct { - // The name of the Global Datastore + // If True, redistribution is applied immediately. // // This member is required. - GlobalReplicationGroupId *string + ApplyImmediately *bool - // If True, redistribution is applied immediately. + // The name of the Global Datastore // // This member is required. - ApplyImmediately *bool + GlobalReplicationGroupId *string } type RebalanceSlotsInGlobalReplicationGroupOutput struct { diff --git a/service/elasticache/api_op_ResetCacheParameterGroup.go b/service/elasticache/api_op_ResetCacheParameterGroup.go index e3a3af14aeb..c1476c17268 100644 --- a/service/elasticache/api_op_ResetCacheParameterGroup.go +++ b/service/elasticache/api_op_ResetCacheParameterGroup.go @@ -66,16 +66,16 @@ type ResetCacheParameterGroupInput struct { // This member is required. CacheParameterGroupName *string - // If true, all parameters in the cache parameter group are reset to their default - // values. If false, only the parameters listed by ParameterNameValues are reset to - // their default values. Valid values: true | false - ResetAllParameters *bool - // An array of parameter names to reset to their default values. If // ResetAllParameters is true, do not use ParameterNameValues. If // ResetAllParameters is false, you must specify the name of at least one parameter // to reset. ParameterNameValues []*types.ParameterNameValue + + // If true, all parameters in the cache parameter group are reset to their default + // values. If false, only the parameters listed by ParameterNameValues are reset to + // their default values. Valid values: true | false + ResetAllParameters *bool } // Represents the output of one of the following operations: diff --git a/service/elasticache/go.mod b/service/elasticache/go.mod index b02573a39d9..6e76ae76307 100644 --- a/service/elasticache/go.mod +++ b/service/elasticache/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/elasticache go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/elasticache/types/types.go b/service/elasticache/types/types.go index 10bbce09ec1..4d3078c77c4 100644 --- a/service/elasticache/types/types.go +++ b/service/elasticache/types/types.go @@ -16,124 +16,37 @@ type AvailabilityZone struct { // Contains all of the attributes of a specific cluster. type CacheCluster struct { - // The URL of the web page where you can download the latest ElastiCache client - // library. - ClientDownloadLandingPage *string - - // Represents a Memcached cluster endpoint which, if Automatic Discovery is enabled - // on the cluster, can be used by an application to connect to any node in the - // cluster. The configuration endpoint will always have .cfg in it. Example: - // mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211 - ConfigurationEndpoint *Endpoint - - // A group of settings that are applied to the cluster in the future, or that are - // currently being applied. - PendingModifiedValues *PendingModifiedValues - - // The number of days for which ElastiCache retains automatic cluster snapshots - // before deleting them. For example, if you set SnapshotRetentionLimit to 5, a - // snapshot that was taken today is retained for 5 days before being deleted. If - // the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. - SnapshotRetentionLimit *int32 - - // The date and time when the cluster was created. - CacheClusterCreateTime *time.Time - // The ARN (Amazon Resource Name) of the cache cluster. ARN *string + // A flag that enables encryption at-rest when set to true. You cannot modify the + // value of AtRestEncryptionEnabled after the cluster is created. To enable at-rest + // encryption on a cluster you must set AtRestEncryptionEnabled to true when you + // create a cluster. Required: Only available when creating a replication group in + // an Amazon VPC using redis version 3.2.6, 4.x or later. Default: false + AtRestEncryptionEnabled *bool + // A flag that enables using an AuthToken (password) when issuing Redis commands. // Default: false AuthTokenEnabled *bool - // The replication group to which this cluster belongs. If this field is empty, the - // cluster is not associated with any replication group. - ReplicationGroupId *string + // The date the auth token was last modified + AuthTokenLastModifiedDate *time.Time - // The current state of this cluster, one of the following values: available, - // creating, deleted, deleting, incompatible-network, modifying, rebooting cluster - // nodes, restore-failed, or snapshotting. - CacheClusterStatus *string + // This parameter is currently disabled. + AutoMinorVersionUpgrade *bool - // A list of VPC Security Groups associated with the cluster. - SecurityGroups []*SecurityGroupMembership + // The date and time when the cluster was created. + CacheClusterCreateTime *time.Time // The user-supplied identifier of the cluster. This identifier is a unique key // that identifies a cluster. CacheClusterId *string - // A flag that enables in-transit encryption when set to true. You cannot modify - // the value of TransitEncryptionEnabled after the cluster is created. To enable - // in-transit encryption on a cluster you must set TransitEncryptionEnabled to true - // when you create a cluster. Required: Only available when creating a replication - // group in an Amazon VPC using redis version 3.2.6, 4.x or later. Default: false - TransitEncryptionEnabled *bool - - // A list of cache security group elements, composed of name and status - // sub-elements. - CacheSecurityGroups []*CacheSecurityGroupMembership - - // The number of cache nodes in the cluster. For clusters running Redis, this value - // must be 1. For clusters running Memcached, this value must be between 1 and 20. - NumCacheNodes *int32 - - // Specifies the weekly time range during which maintenance on the cluster is - // performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H - // Clock UTC). The minimum maintenance window is a 60 minute period. Valid values - // for ddd are: - // - // * sun - // - // * mon - // - // * tue - // - // * wed - // - // * thu - // - // * fri - // - // - // * sat - // - // Example: sun:23:00-mon:01:30 - PreferredMaintenanceWindow *string - - // The name of the Availability Zone in which the cluster is located or "Multiple" - // if the cache nodes are located in different Availability Zones. - PreferredAvailabilityZone *string - - // This parameter is currently disabled. - AutoMinorVersionUpgrade *bool - - // Describes a notification topic and its status. Notification topics are used for - // publishing ElastiCache events to subscribers using Amazon Simple Notification - // Service (SNS). - NotificationConfiguration *NotificationConfiguration - - // The date the auth token was last modified - AuthTokenLastModifiedDate *time.Time - - // The daily time range (in UTC) during which ElastiCache begins taking a daily - // snapshot of your cluster. Example: 05:00-09:00 - SnapshotWindow *string - - // The name of the cache subnet group associated with the cluster. - CacheSubnetGroupName *string - - // The name of the cache engine (memcached or redis) to be used for this cluster. - Engine *string - - // Status of the cache parameter group. - CacheParameterGroup *CacheParameterGroupStatus - - // A flag that enables encryption at-rest when set to true. You cannot modify the - // value of AtRestEncryptionEnabled after the cluster is created. To enable at-rest - // encryption on a cluster you must set AtRestEncryptionEnabled to true when you - // create a cluster. Required: Only available when creating a replication group in - // an Amazon VPC using redis version 3.2.6, 4.x or later. Default: false - AtRestEncryptionEnabled *bool + // The current state of this cluster, one of the following values: available, + // creating, deleted, deleting, incompatible-network, modifying, rebooting cluster + // nodes, restore-failed, or snapshotting. + CacheClusterStatus *string // The name of the compute and memory capacity node type for the cluster.

    The // following node types are supported by ElastiCache. Generally speaking, the @@ -180,29 +93,116 @@ type CacheCluster struct { // later.

    CacheNodeType *string + // A list of cache nodes that are members of the cluster. + CacheNodes []*CacheNode + + // Status of the cache parameter group. + CacheParameterGroup *CacheParameterGroupStatus + + // A list of cache security group elements, composed of name and status + // sub-elements. + CacheSecurityGroups []*CacheSecurityGroupMembership + + // The name of the cache subnet group associated with the cluster. + CacheSubnetGroupName *string + + // The URL of the web page where you can download the latest ElastiCache client + // library. + ClientDownloadLandingPage *string + + // Represents a Memcached cluster endpoint which, if Automatic Discovery is enabled + // on the cluster, can be used by an application to connect to any node in the + // cluster. The configuration endpoint will always have .cfg in it. Example: + // mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211 + ConfigurationEndpoint *Endpoint + + // The name of the cache engine (memcached or redis) to be used for this cluster. + Engine *string + // The version of the cache engine that is used in this cluster. EngineVersion *string - // A list of cache nodes that are members of the cluster. - CacheNodes []*CacheNode + // Describes a notification topic and its status. Notification topics are used for + // publishing ElastiCache events to subscribers using Amazon Simple Notification + // Service (SNS). + NotificationConfiguration *NotificationConfiguration + + // The number of cache nodes in the cluster. For clusters running Redis, this value + // must be 1. For clusters running Memcached, this value must be between 1 and 20. + NumCacheNodes *int32 + + // A group of settings that are applied to the cluster in the future, or that are + // currently being applied. + PendingModifiedValues *PendingModifiedValues + + // The name of the Availability Zone in which the cluster is located or "Multiple" + // if the cache nodes are located in different Availability Zones. + PreferredAvailabilityZone *string + + // Specifies the weekly time range during which maintenance on the cluster is + // performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H + // Clock UTC). The minimum maintenance window is a 60 minute period. Valid values + // for ddd are: + // + // * sun + // + // * mon + // + // * tue + // + // * wed + // + // * thu + // + // * fri + // + // + // * sat + // + // Example: sun:23:00-mon:01:30 + PreferredMaintenanceWindow *string + + // The replication group to which this cluster belongs. If this field is empty, the + // cluster is not associated with any replication group. + ReplicationGroupId *string + + // A list of VPC Security Groups associated with the cluster. + SecurityGroups []*SecurityGroupMembership + + // The number of days for which ElastiCache retains automatic cluster snapshots + // before deleting them. For example, if you set SnapshotRetentionLimit to 5, a + // snapshot that was taken today is retained for 5 days before being deleted. If + // the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. + SnapshotRetentionLimit *int32 + + // The daily time range (in UTC) during which ElastiCache begins taking a daily + // snapshot of your cluster. Example: 05:00-09:00 + SnapshotWindow *string + + // A flag that enables in-transit encryption when set to true. You cannot modify + // the value of TransitEncryptionEnabled after the cluster is created. To enable + // in-transit encryption on a cluster you must set TransitEncryptionEnabled to true + // when you create a cluster. Required: Only available when creating a replication + // group in an Amazon VPC using redis version 3.2.6, 4.x or later. Default: false + TransitEncryptionEnabled *bool } // Provides all of the details about a particular cache engine version. type CacheEngineVersion struct { - // The name of the cache engine. - Engine *string - // The description of the cache engine. CacheEngineDescription *string + // The description of the cache engine version. + CacheEngineVersionDescription *string + // The name of the cache parameter group family associated with this cache engine. // Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | // redis4.0 | redis5.0 | CacheParameterGroupFamily *string - // The description of the cache engine version. - CacheEngineVersionDescription *string + // The name of the cache engine. + Engine *string // The version number of the cache engine. EngineVersion *string @@ -255,16 +255,9 @@ type CacheEngineVersion struct { // later.

    type CacheNode struct { - // The ID of the primary node to which this read replica node is synchronized. If - // this field is empty, this node is not associated with a primary cluster. - SourceCacheNodeId *string - // The date and time when the cache node was created. CacheNodeCreateTime *time.Time - // The status of the parameter group applied to this cache node. - ParameterGroupStatus *string - // The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). // The combination of cluster ID and node ID uniquely identifies every cache node // used in a customer's AWS account. @@ -274,11 +267,18 @@ type CacheNode struct { // creating, rebooting, or deleting. CacheNodeStatus *string + // The Availability Zone where this node was created and now resides. + CustomerAvailabilityZone *string + // The hostname for connecting to this cache node. Endpoint *Endpoint - // The Availability Zone where this node was created and now resides. - CustomerAvailabilityZone *string + // The status of the parameter group applied to this cache node. + ParameterGroupStatus *string + + // The ID of the primary node to which this read replica node is synchronized. If + // this field is empty, this node is not associated with a primary cluster. + SourceCacheNodeId *string } // A parameter that has a different value for each cache node type it is applied @@ -286,8 +286,11 @@ type CacheNode struct { // a larger maxmemory value than a cache.m1.small type. type CacheNodeTypeSpecificParameter struct { - // A description of the parameter. - Description *string + // The valid range of values for the parameter. + AllowedValues *string + + // A list of cache node types and their corresponding values for this parameter. + CacheNodeTypeSpecificValues []*CacheNodeTypeSpecificValue // Indicates whether a change to the parameter is applied immediately or requires a // reboot for the change to be applied. You can force a reboot or wait until the @@ -295,28 +298,25 @@ type CacheNodeTypeSpecificParameter struct { // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.Rebooting.html). ChangeType ChangeType + // The valid data type for the parameter. + DataType *string + + // A description of the parameter. + Description *string + // Indicates whether (true) or not (false) the parameter can be modified. Some // parameters have security or operational implications that prevent them from // being changed. IsModifiable *bool + // The earliest cache engine version to which the parameter can apply. + MinimumEngineVersion *string + // The name of the parameter. ParameterName *string // The source of the parameter value. Source *string - - // The valid data type for the parameter. - DataType *string - - // The earliest cache engine version to which the parameter can apply. - MinimumEngineVersion *string - - // A list of cache node types and their corresponding values for this parameter. - CacheNodeTypeSpecificValues []*CacheNodeTypeSpecificValue - - // The valid range of values for the parameter. - AllowedValues *string } // A value that applies only to a certain cache node type. @@ -332,18 +332,15 @@ type CacheNodeTypeSpecificValue struct { // The status of the service update on the cache node type CacheNodeUpdateStatus struct { - // The date when the NodeUpdateStatus was last modified> - NodeUpdateStatusModifiedDate *time.Time + // The node ID of the cache cluster + CacheNodeId *string - // The update status of the node - NodeUpdateStatus NodeUpdateStatus + // The deletion date of the node + NodeDeletionDate *time.Time // The end date of the update for a node NodeUpdateEndDate *time.Time - // The start date of the update for a node - NodeUpdateStartDate *time.Time - // Reflects whether the update was initiated by the customer or automatically // applied NodeUpdateInitiatedBy NodeUpdateInitiatedBy @@ -351,46 +348,49 @@ type CacheNodeUpdateStatus struct { // The date when the update is triggered NodeUpdateInitiatedDate *time.Time - // The node ID of the cache cluster - CacheNodeId *string + // The start date of the update for a node + NodeUpdateStartDate *time.Time - // The deletion date of the node - NodeDeletionDate *time.Time + // The update status of the node + NodeUpdateStatus NodeUpdateStatus + + // The date when the NodeUpdateStatus was last modified> + NodeUpdateStatusModifiedDate *time.Time } // Represents the output of a CreateCacheParameterGroup operation. type CacheParameterGroup struct { - // The description for this cache parameter group. - Description *string - - // The name of the cache parameter group. - CacheParameterGroupName *string - - // Indicates whether the parameter group is associated with a Global Datastore - IsGlobal *bool + // The ARN (Amazon Resource Name) of the cache parameter group. + ARN *string // The name of the cache parameter group family that this cache parameter group is // compatible with. Valid values are: memcached1.4 | memcached1.5 | redis2.6 | // redis2.8 | redis3.2 | redis4.0 | redis5.0 | CacheParameterGroupFamily *string - // The ARN (Amazon Resource Name) of the cache parameter group. - ARN *string + // The name of the cache parameter group. + CacheParameterGroupName *string + + // The description for this cache parameter group. + Description *string + + // Indicates whether the parameter group is associated with a Global Datastore + IsGlobal *bool } // Status of the cache parameter group. type CacheParameterGroupStatus struct { + // A list of the cache node IDs which need to be rebooted for parameter changes to + // be applied. A node ID is a numeric identifier (0001, 0002, etc.). + CacheNodeIdsToReboot []*string + // The name of the cache parameter group. CacheParameterGroupName *string // The status of parameter updates. ParameterApplyStatus *string - - // A list of the cache node IDs which need to be rebooted for parameter changes to - // be applied. A node ID is a numeric identifier (0001, 0002, etc.). - CacheNodeIdsToReboot []*string } // Represents the output of one of the following operations: @@ -404,14 +404,11 @@ type CacheParameterGroupStatus struct { // RevokeCacheSecurityGroupIngress type CacheSecurityGroup struct { - // The name of the cache security group. - CacheSecurityGroupName *string - // The ARN (Amazon Resource Name) of the cache security group. ARN *string - // The AWS account ID of the cache security group owner. - OwnerId *string + // The name of the cache security group. + CacheSecurityGroupName *string // The description of the cache security group. Description *string @@ -419,18 +416,21 @@ type CacheSecurityGroup struct { // A list of Amazon EC2 security groups that are associated with this cache // security group. EC2SecurityGroups []*EC2SecurityGroup + + // The AWS account ID of the cache security group owner. + OwnerId *string } // Represents a cluster's status within a particular cache security group. type CacheSecurityGroupMembership struct { + // The name of the cache security group. + CacheSecurityGroupName *string + // The membership status in the cache security group. The status changes when a // cache security group is modified, or when the cache security groups assigned to // a cluster are modified. Status *string - - // The name of the cache security group. - CacheSecurityGroupName *string } // Represents the output of one of the following operations: @@ -441,18 +441,18 @@ type CacheSecurityGroupMembership struct { // * ModifyCacheSubnetGroup type CacheSubnetGroup struct { - // A list of subnets associated with the cache subnet group. - Subnets []*Subnet - - // The name of the cache subnet group. - CacheSubnetGroupName *string - // The ARN (Amazon Resource Name) of the cache subnet group. ARN *string // The description of the cache subnet group. CacheSubnetGroupDescription *string + // The name of the cache subnet group. + CacheSubnetGroupName *string + + // A list of subnets associated with the cache subnet group. + Subnets []*Subnet + // The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group. VpcId *string } @@ -462,14 +462,6 @@ type CacheSubnetGroup struct { // NewReplicaCount, and PreferredAvailabilityZones. type ConfigureShard struct { - // A list of PreferredAvailabilityZone strings that specify which availability - // zones the replication group's nodes are to be in. The nummber of - // PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 - // to account for the primary node. If this member of ReplicaConfiguration is - // omitted, ElastiCache for Redis selects the availability zone for each of the - // replicas. - PreferredAvailabilityZones []*string - // The number of replicas you want in this node group at the end of this operation. // The maximum value for NewReplicaCount is 5. The minimum value depends upon the // type of Redis replication group you are working with. The minimum number of @@ -496,6 +488,14 @@ type ConfigureShard struct { // // This member is required. NodeGroupId *string + + // A list of PreferredAvailabilityZone strings that specify which availability + // zones the replication group's nodes are to be in. The nummber of + // PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 + // to account for the primary node. If this member of ReplicaConfiguration is + // omitted, ElastiCache for Redis selects the availability zone for each of the + // replicas. + PreferredAvailabilityZones []*string } // The endpoint from which data should be migrated. @@ -514,27 +514,31 @@ type EC2SecurityGroup struct { // The name of the Amazon EC2 security group. EC2SecurityGroupName *string - // The status of the Amazon EC2 security group. - Status *string - // The AWS account ID of the Amazon EC2 security group owner. EC2SecurityGroupOwnerId *string + + // The status of the Amazon EC2 security group. + Status *string } // Represents the information required for client programs to connect to a cache // node. type Endpoint struct { - // The port number that the cache engine is listening on. - Port *int32 - // The DNS hostname of the cache node. Address *string + + // The port number that the cache engine is listening on. + Port *int32 } // Represents the output of a DescribeEngineDefaultParameters operation. type EngineDefaults struct { + // A list of parameters specific to a particular cache node type. Each element in + // the list contains detailed information about one parameter. + CacheNodeTypeSpecificParameters []*CacheNodeTypeSpecificParameter + // Specifies the name of the cache parameter group family to which the engine // default parameters apply. Valid values are: memcached1.4 | memcached1.5 | // redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | @@ -543,10 +547,6 @@ type EngineDefaults struct { // Provides an identifier to allow retrieval of paginated results. Marker *string - // A list of parameters specific to a particular cache node type. Each element in - // the list contains detailed information about one parameter. - CacheNodeTypeSpecificParameters []*CacheNodeTypeSpecificParameter - // Contains a list of engine default parameters. Parameters []*Parameter } @@ -559,6 +559,9 @@ type Event struct { // The date and time when the event occurred. Date *time.Time + // The text of the event. + Message *string + // The identifier for the source of the event. For example, if the event occurred // at the cluster level, the identifier would be the name of the cluster. SourceIdentifier *string @@ -566,19 +569,16 @@ type Event struct { // Specifies the origin of this event - a cluster, a parameter group, a security // group, etc. SourceType SourceType - - // The text of the event. - Message *string } // Indicates the slot configuration and global identifier for a slice group. type GlobalNodeGroup struct { - // The keyspace for this node group - Slots *string - // The name of the global node group GlobalNodeGroupId *string + + // The keyspace for this node group + Slots *string } // Consists of a primary cluster that accepts writes and an associated secondary @@ -589,30 +589,9 @@ type GlobalNodeGroup struct { // a secondary cluster.

    type GlobalReplicationGroup struct { - // A flag that enables in-transit encryption when set to true. You cannot modify - // the value of TransitEncryptionEnabled after the cluster is created. - // To enable in-transit encryption on a cluster you must set - // TransitEncryptionEnabled to true when you create a cluster.

    - TransitEncryptionEnabled *bool - - // A flag that indicates whether the Global Datastore is cluster enabled. - ClusterEnabled *bool - - // The optional description of the Global Datastore - GlobalReplicationGroupDescription *string - - // The replication groups that comprise the Global Datastore. - Members []*GlobalReplicationGroupMember - - // The name of the Global Datastore - GlobalReplicationGroupId *string - // The ARN (Amazon Resource Name) of the global replication group. ARN *string - // The Elasticache engine. For Redis only. - Engine *string - // A flag that enables encryption at rest when set to true. You cannot modify the // value of AtRestEncryptionEnabled after the replication group is created. To // enable encryption at rest on a replication group you must set @@ -625,50 +604,71 @@ type GlobalReplicationGroup struct { // Default: false AuthTokenEnabled *bool - // The status of the Global Datastore - Status *string + // The cache node type of the Global Datastore + CacheNodeType *string - // Indicates the slot configuration and global identifier for each slice group. - GlobalNodeGroups []*GlobalNodeGroup + // A flag that indicates whether the Global Datastore is cluster enabled. + ClusterEnabled *bool + + // The Elasticache engine. For Redis only. + Engine *string // The Elasticache Redis engine version. For preview, it is Redis version 5.0.5 // only. EngineVersion *string - // The cache node type of the Global Datastore - CacheNodeType *string + // Indicates the slot configuration and global identifier for each slice group. + GlobalNodeGroups []*GlobalNodeGroup + + // The optional description of the Global Datastore + GlobalReplicationGroupDescription *string + + // The name of the Global Datastore + GlobalReplicationGroupId *string + + // The replication groups that comprise the Global Datastore. + Members []*GlobalReplicationGroupMember + + // The status of the Global Datastore + Status *string + + // A flag that enables in-transit encryption when set to true. You cannot modify + // the value of TransitEncryptionEnabled after the cluster is created. + // To enable in-transit encryption on a cluster you must set + // TransitEncryptionEnabled to true when you create a cluster.

    + TransitEncryptionEnabled *bool } // The name of the Global Datastore and role of this replication group in the // Global Datastore. type GlobalReplicationGroupInfo struct { + // The name of the Global Datastore + GlobalReplicationGroupId *string + // The role of the replication group in a Global Datastore. Can be primary or // secondary. GlobalReplicationGroupMemberRole *string - - // The name of the Global Datastore - GlobalReplicationGroupId *string } // A member of a Global Datastore. It contains the Replication Group Id, the AWS // region and the role of the replication group. type GlobalReplicationGroupMember struct { - // Indicates the role of the replication group, primary or secondary. - Role *string + // Indicates whether automatic failover is enabled for the replication group. + AutomaticFailover AutomaticFailoverStatus + + // The replication group id of the Global Datastore member. + ReplicationGroupId *string // The AWS region of the Global Datastore member. ReplicationGroupRegion *string + // Indicates the role of the replication group, primary or secondary. + Role *string + // The status of the membership of the replication group. Status *string - - // The replication group id of the Global Datastore member. - ReplicationGroupId *string - - // Indicates whether automatic failover is enabled for the replication group. - AutomaticFailover AutomaticFailoverStatus } // Represents a collection of cache nodes in a replication group. One node in the @@ -676,6 +676,13 @@ type GlobalReplicationGroupMember struct { // Replica nodes. type NodeGroup struct { + // The identifier for the node group (shard). A Redis (cluster mode disabled) + // replication group contains only 1 node group; therefore, the node group ID is + // 0001. A Redis (cluster mode enabled) replication group contains 1 to 90 node + // groups numbered 0001 to 0090. Optionally, the user can provide the id for a node + // group. + NodeGroupId *string + // A list containing information about individual nodes within the node group // (shard). NodeGroupMembers []*NodeGroupMember @@ -683,22 +690,15 @@ type NodeGroup struct { // The endpoint of the primary node in this node group (shard). PrimaryEndpoint *Endpoint + // The endpoint of the replica nodes in this node group (shard). + ReaderEndpoint *Endpoint + // The keyspace for this node group (shard). Slots *string // The current state of this replication group - creating, available, modifying, // deleting. Status *string - - // The identifier for the node group (shard). A Redis (cluster mode disabled) - // replication group contains only 1 node group; therefore, the node group ID is - // 0001. A Redis (cluster mode enabled) replication group contains 1 to 90 node - // groups numbered 0001 to 0090. Optionally, the user can provide the id for a node - // group. - NodeGroupId *string - - // The endpoint of the replica nodes in this node group (shard). - ReaderEndpoint *Endpoint } // Node group (shard) configuration options. Each node group (shard) configuration @@ -710,6 +710,10 @@ type NodeGroupConfiguration struct { // the node group these configuration values apply to. NodeGroupId *string + // The Availability Zone where the primary node of this node group (shard) is + // launched. + PrimaryAvailabilityZone *string + // A list of Availability Zones to be used for the read replicas. The number of // Availability Zones in this list must match the value of ReplicaCount or // ReplicasPerNodeGroup if not specified. @@ -718,10 +722,6 @@ type NodeGroupConfiguration struct { // The number of read replica nodes in this node group (shard). ReplicaCount *int32 - // The Availability Zone where the primary node of this node group (shard) is - // launched. - PrimaryAvailabilityZone *string - // A string that specifies the keyspace for a particular node group. Keyspaces // range from 0 to 16,383. The string is in the format startkey-endkey. Example: // "0-3999" @@ -731,14 +731,17 @@ type NodeGroupConfiguration struct { // Represents a single node within a node group (shard). type NodeGroupMember struct { - // The role that is currently assigned to the node - primary or replica. This - // member is only applicable for Redis (cluster mode disabled) replication groups. - CurrentRole *string + // The ID of the cluster to which the node belongs. + CacheClusterId *string // The ID of the node within its cluster. A node ID is a numeric identifier (0001, // 0002, etc.). CacheNodeId *string + // The role that is currently assigned to the node - primary or replica. This + // member is only applicable for Redis (cluster mode disabled) replication groups. + CurrentRole *string + // The name of the Availability Zone in which the node is located. PreferredAvailabilityZone *string @@ -746,41 +749,38 @@ type NodeGroupMember struct { // operations. The read endpoint is only applicable on Redis (cluster mode // disabled) clusters. ReadEndpoint *Endpoint - - // The ID of the cluster to which the node belongs. - CacheClusterId *string } // The status of the service update on the node group member type NodeGroupMemberUpdateStatus struct { - // The update status of the node - NodeUpdateStatus NodeUpdateStatus - - // The start date of the update for a node - NodeUpdateStartDate *time.Time - // The cache cluster ID CacheClusterId *string + // The node ID of the cache cluster + CacheNodeId *string + // The deletion date of the node NodeDeletionDate *time.Time - // The date when the NodeUpdateStatus was last modified - NodeUpdateStatusModifiedDate *time.Time + // The end date of the update for a node + NodeUpdateEndDate *time.Time // Reflects whether the update was initiated by the customer or automatically // applied NodeUpdateInitiatedBy NodeUpdateInitiatedBy - // The node ID of the cache cluster - CacheNodeId *string - // The date when the update is triggered NodeUpdateInitiatedDate *time.Time - // The end date of the update for a node - NodeUpdateEndDate *time.Time + // The start date of the update for a node + NodeUpdateStartDate *time.Time + + // The update status of the node + NodeUpdateStatus NodeUpdateStatus + + // The date when the NodeUpdateStatus was last modified + NodeUpdateStatusModifiedDate *time.Time } // The status of the service update on the node group @@ -796,27 +796,27 @@ type NodeGroupUpdateStatus struct { // Represents an individual cache node in a snapshot of a cluster. type NodeSnapshot struct { + // A unique identifier for the source cluster. + CacheClusterId *string + + // The date and time when the cache node was created in the source cluster. + CacheNodeCreateTime *time.Time + // The cache node identifier for the node in the source cluster. CacheNodeId *string - // The date and time when the source node's metadata and cache data set was - // obtained for the snapshot. - SnapshotCreateTime *time.Time + // The size of the cache on the source cache node. + CacheSize *string // The configuration for the source node group (shard). NodeGroupConfiguration *NodeGroupConfiguration - // The date and time when the cache node was created in the source cluster. - CacheNodeCreateTime *time.Time - - // A unique identifier for the source cluster. - CacheClusterId *string - // A unique identifier for the source node group (shard). NodeGroupId *string - // The size of the cache on the source cache node. - CacheSize *string + // The date and time when the source node's metadata and cache data set was + // obtained for the snapshot. + SnapshotCreateTime *time.Time } // Describes a notification topic and its status. Notification topics are used for @@ -824,19 +824,19 @@ type NodeSnapshot struct { // Service (SNS). type NotificationConfiguration struct { - // The current state of the topic. - TopicStatus *string - // The Amazon Resource Name (ARN) that identifies the topic. TopicArn *string + + // The current state of the topic. + TopicStatus *string } // Describes an individual setting that controls some aspect of ElastiCache // behavior. type Parameter struct { - // A description of the parameter. - Description *string + // The valid range of values for the parameter. + AllowedValues *string // Indicates whether a change to the parameter is applied immediately or requires a // reboot for the change to be applied. You can force a reboot or wait until the @@ -844,75 +844,75 @@ type Parameter struct { // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.Rebooting.html). ChangeType ChangeType + // The valid data type for the parameter. + DataType *string + + // A description of the parameter. + Description *string + // Indicates whether (true) or not (false) the parameter can be modified. Some // parameters have security or operational implications that prevent them from // being changed. IsModifiable *bool - // The name of the parameter. - ParameterName *string - - // The source of the parameter. - Source *string - - // The valid data type for the parameter. - DataType *string - // The earliest cache engine version to which the parameter can apply. MinimumEngineVersion *string - // The valid range of values for the parameter. - AllowedValues *string + // The name of the parameter. + ParameterName *string // The value of the parameter. ParameterValue *string + + // The source of the parameter. + Source *string } // Describes a name-value pair that is used to update the value of a parameter. type ParameterNameValue struct { - // The value of the parameter. - ParameterValue *string - // The name of the parameter. ParameterName *string + + // The value of the parameter. + ParameterValue *string } // A group of settings that are applied to the cluster in the future, or that are // currently being applied. type PendingModifiedValues struct { - // The new number of cache nodes for the cluster. For clusters running Redis, this - // value must be 1. For clusters running Memcached, this value must be between 1 - // and 20. - NumCacheNodes *int32 + // The auth token status + AuthTokenStatus AuthTokenUpdateStatus // A list of cache node IDs that are being removed (or will be removed) from the // cluster. A node ID is a 4-digit numeric identifier (0001, 0002, etc.). CacheNodeIdsToRemove []*string - // The new cache engine version that the cluster runs. - EngineVersion *string - // The cache node type that this cluster or replication group is scaled to. CacheNodeType *string - // The auth token status - AuthTokenStatus AuthTokenUpdateStatus + // The new cache engine version that the cluster runs. + EngineVersion *string + + // The new number of cache nodes for the cluster. For clusters running Redis, this + // value must be 1. For clusters running Memcached, this value must be between 1 + // and 20. + NumCacheNodes *int32 } // Update action that has been processed for the corresponding apply/stop request type ProcessedUpdateAction struct { - // The unique ID of the service update - ServiceUpdateName *string - // The ID of the cache cluster CacheClusterId *string // The ID of the replication group ReplicationGroupId *string + // The unique ID of the service update + ServiceUpdateName *string + // The status of the update action on the Redis cluster UpdateActionStatus UpdateActionStatus } @@ -931,6 +931,11 @@ type RecurringCharge struct { // A list of the replication groups type RegionalConfiguration struct { + // The name of the secondary cluster + // + // This member is required. + ReplicationGroupId *string + // The AWS region where the cluster is stored // // This member is required. @@ -941,141 +946,126 @@ type RegionalConfiguration struct { // // This member is required. ReshardingConfiguration []*ReshardingConfiguration - - // The name of the secondary cluster - // - // This member is required. - ReplicationGroupId *string } // Contains all of the attributes of a specific Redis replication group. type ReplicationGroup struct { - // Indicates the status of automatic failover for this Redis replication group. - AutomaticFailover AutomaticFailoverStatus + // The ARN (Amazon Resource Name) of the replication group. + ARN *string + + // A flag that enables encryption at-rest when set to true. You cannot modify the + // value of AtRestEncryptionEnabled after the cluster is created. To enable + // encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true + // when you create a cluster. Required: Only available when creating a replication + // group in an Amazon VPC using redis version 3.2.6, 4.x or later. Default: false + AtRestEncryptionEnabled *bool + + // A flag that enables using an AuthToken (password) when issuing Redis commands. + // Default: false + AuthTokenEnabled *bool // The date the auth token was last modified AuthTokenLastModifiedDate *time.Time + // Indicates the status of automatic failover for this Redis replication group. + AutomaticFailover AutomaticFailoverStatus + + // The name of the compute and memory capacity node type for each node in the + // replication group. + CacheNodeType *string + + // A flag indicating whether or not this replication group is cluster enabled; + // i.e., whether its data can be partitioned across multiple shards (API/CLI: node + // groups). Valid values: true | false + ClusterEnabled *bool + // The configuration endpoint for this replication group. Use the configuration // endpoint to connect to this replication group. ConfigurationEndpoint *Endpoint - // The names of all the cache clusters that are part of this replication group. - MemberClusters []*string + // The user supplied description of the replication group. + Description *string // The name of the Global Datastore and role of this replication group in the // Global Datastore. GlobalReplicationGroupInfo *GlobalReplicationGroupInfo - // The current state of this replication group - creating, available, modifying, - // deleting, create-failed, snapshotting. - Status *string + // The ID of the KMS key used to encrypt the disk in the cluster. + KmsKeyId *string + + // The names of all the cache clusters that are part of this replication group. + MemberClusters []*string // A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For // more information, see Minimizing Downtime: Multi-AZ // (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html) MultiAZ MultiAZStatus - // The name of the compute and memory capacity node type for each node in the - // replication group. - CacheNodeType *string - - // A flag that enables in-transit encryption when set to true. You cannot modify - // the value of TransitEncryptionEnabled after the cluster is created. To enable - // in-transit encryption on a cluster you must set TransitEncryptionEnabled to true - // when you create a cluster. Required: Only available when creating a replication - // group in an Amazon VPC using redis version 3.2.6, 4.x or later. Default: false - TransitEncryptionEnabled *bool - - // The identifier for the replication group. - ReplicationGroupId *string - - // A flag that enables encryption at-rest when set to true. You cannot modify the - // value of AtRestEncryptionEnabled after the cluster is created. To enable - // encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true - // when you create a cluster. Required: Only available when creating a replication - // group in an Amazon VPC using redis version 3.2.6, 4.x or later. Default: false - AtRestEncryptionEnabled *bool - - // A flag that enables using an AuthToken (password) when issuing Redis commands. - // Default: false - AuthTokenEnabled *bool - - // The user supplied description of the replication group. - Description *string - // A list of node groups in this replication group. For Redis (cluster mode // disabled) replication groups, this is a single-element list. For Redis (cluster // mode enabled) replication groups, the list contains an entry for each node group // (shard). NodeGroups []*NodeGroup - // The ARN (Amazon Resource Name) of the replication group. - ARN *string - - // The daily time range (in UTC) during which ElastiCache begins taking a daily - // snapshot of your node group (shard). Example: 05:00-09:00 If you do not specify - // this parameter, ElastiCache automatically chooses an appropriate time range. - // This parameter is only valid if the Engine parameter is redis. - SnapshotWindow *string - - // A flag indicating whether or not this replication group is cluster enabled; - // i.e., whether its data can be partitioned across multiple shards (API/CLI: node - // groups). Valid values: true | false - ClusterEnabled *bool - // A group of settings to be applied to the replication group, either immediately // or during the next maintenance window. PendingModifiedValues *ReplicationGroupPendingModifiedValues + // The identifier for the replication group. + ReplicationGroupId *string + // The number of days for which ElastiCache retains automatic cluster snapshots // before deleting them. For example, if you set SnapshotRetentionLimit to 5, a // snapshot that was taken today is retained for 5 days before being deleted. If // the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. SnapshotRetentionLimit *int32 + // The daily time range (in UTC) during which ElastiCache begins taking a daily + // snapshot of your node group (shard). Example: 05:00-09:00 If you do not specify + // this parameter, ElastiCache automatically chooses an appropriate time range. + // This parameter is only valid if the Engine parameter is redis. + SnapshotWindow *string + // The cluster ID that is used as the daily snapshot source for the replication // group. SnapshottingClusterId *string - // The ID of the KMS key used to encrypt the disk in the cluster. - KmsKeyId *string + // The current state of this replication group - creating, available, modifying, + // deleting, create-failed, snapshotting. + Status *string + + // A flag that enables in-transit encryption when set to true. You cannot modify + // the value of TransitEncryptionEnabled after the cluster is created. To enable + // in-transit encryption on a cluster you must set TransitEncryptionEnabled to true + // when you create a cluster. Required: Only available when creating a replication + // group in an Amazon VPC using redis version 3.2.6, 4.x or later. Default: false + TransitEncryptionEnabled *bool } // The settings to be applied to the Redis replication group, either immediately or // during the next maintenance window. type ReplicationGroupPendingModifiedValues struct { - // The status of an online resharding operation. - Resharding *ReshardingStatus + // The auth token status + AuthTokenStatus AuthTokenUpdateStatus + + // Indicates the status of automatic failover for this Redis replication group. + AutomaticFailoverStatus PendingAutomaticFailoverStatus // The primary cluster ID that is applied immediately (if --apply-immediately was // specified), or during the next maintenance window. PrimaryClusterId *string - // Indicates the status of automatic failover for this Redis replication group. - AutomaticFailoverStatus PendingAutomaticFailoverStatus - - // The auth token status - AuthTokenStatus AuthTokenUpdateStatus + // The status of an online resharding operation. + Resharding *ReshardingStatus } // Represents the output of a PurchaseReservedCacheNodesOffering operation. type ReservedCacheNode struct { - // The fixed price charged for this reserved cache node. - FixedPrice *float64 - - // The Amazon Resource Name (ARN) of the reserved cache node. Example: - // arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582 - ReservationARN *string - - // The time the reservation started. - StartTime *time.Time - - // The state of the reserved cache node. - State *string + // The number of cache nodes that have been reserved. + CacheNodeCount *int32 // The cache node type for the reserved cache nodes.

    The following node types // are supported by ElastiCache. Generally speaking, the current generation types @@ -1122,29 +1112,39 @@ type ReservedCacheNode struct { // later.

    CacheNodeType *string + // The duration of the reservation in seconds. + Duration *int32 + + // The fixed price charged for this reserved cache node. + FixedPrice *float64 + // The offering type of this reserved cache node. OfferingType *string - // The offering identifier. - ReservedCacheNodesOfferingId *string - - // The duration of the reservation in seconds. - Duration *int32 + // The description of the reserved cache node. + ProductDescription *string - // The hourly price charged for this reserved cache node. - UsagePrice *float64 + // The recurring price charged to run this reserved cache node. + RecurringCharges []*RecurringCharge - // The number of cache nodes that have been reserved. - CacheNodeCount *int32 + // The Amazon Resource Name (ARN) of the reserved cache node. Example: + // arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582 + ReservationARN *string // The unique identifier for the reservation. ReservedCacheNodeId *string - // The recurring price charged to run this reserved cache node. - RecurringCharges []*RecurringCharge + // The offering identifier. + ReservedCacheNodesOfferingId *string - // The description of the reserved cache node. - ProductDescription *string + // The time the reservation started. + StartTime *time.Time + + // The state of the reserved cache node. + State *string + + // The hourly price charged for this reserved cache node. + UsagePrice *float64 } // Describes all of the attributes of a reserved cache node offering. @@ -1202,18 +1202,18 @@ type ReservedCacheNodesOffering struct { // The duration of the offering. in seconds. Duration *int32 + // The fixed price charged for this offering. + FixedPrice *float64 + + // The offering type. + OfferingType *string + // The cache engine used by the offering. ProductDescription *string // The recurring price charged to run this reserved cache node. RecurringCharges []*RecurringCharge - // The offering type. - OfferingType *string - - // The fixed price charged for this offering. - FixedPrice *float64 - // A unique identifier for the reserved cache node offering. ReservedCacheNodesOfferingId *string @@ -1259,41 +1259,41 @@ type ServiceUpdate struct { // recommended apply-by date has expired. AutoUpdateAfterRecommendedApplyByDate *bool - // The severity of the service update - ServiceUpdateSeverity ServiceUpdateSeverity - - // The date after which the service update is no longer available - ServiceUpdateEndDate *time.Time - // The Elasticache engine to which the update applies. Either Redis or Memcached Engine *string - // The unique ID of the service update - ServiceUpdateName *string - // The Elasticache engine version to which the update applies. Either Redis or // Memcached engine version EngineVersion *string - // The status of the service update - ServiceUpdateStatus ServiceUpdateStatus - - // The date when the service update is initially available - ServiceUpdateReleaseDate *time.Time - - // Reflects the nature of the service update - ServiceUpdateType ServiceUpdateType + // The estimated length of time the service update will take + EstimatedUpdateTime *string // Provides details of the service update ServiceUpdateDescription *string + // The date after which the service update is no longer available + ServiceUpdateEndDate *time.Time + + // The unique ID of the service update + ServiceUpdateName *string + // The recommendend date to apply the service update in order to ensure compliance. // For information on compliance, see Self-Service Security Updates for Compliance // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/elasticache-compliance.html#elasticache-compliance-self-service). ServiceUpdateRecommendedApplyByDate *time.Time - // The estimated length of time the service update will take - EstimatedUpdateTime *string + // The date when the service update is initially available + ServiceUpdateReleaseDate *time.Time + + // The severity of the service update + ServiceUpdateSeverity ServiceUpdateSeverity + + // The status of the service update + ServiceUpdateStatus ServiceUpdateStatus + + // Reflects the nature of the service update + ServiceUpdateType ServiceUpdateType } // Represents the progress of an online resharding operation. @@ -1307,69 +1307,21 @@ type SlotMigration struct { // was taken. type Snapshot struct { - // The name of the cache subnet group associated with the source cluster. - CacheSubnetGroupName *string - - // The ID of the KMS key used to encrypt the snapshot. - KmsKeyId *string - - // The version of the cache engine version that is used by the source cluster. - EngineVersion *string - - // Indicates whether the snapshot is from an automatic backup (automated) or was - // created manually (manual). - SnapshotSource *string - - // The name of the Availability Zone in which the source cluster is located. - PreferredAvailabilityZone *string - - // Specifies the weekly time range during which maintenance on the cluster is - // performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H - // Clock UTC). The minimum maintenance window is a 60 minute period. Valid values - // for ddd are: - // - // * sun - // - // * mon - // - // * tue - // - // * wed - // - // * thu - // - // * fri - // - // - // * sat - // - // Example: sun:23:00-mon:01:30 - PreferredMaintenanceWindow *string + // The ARN (Amazon Resource Name) of the snapshot. + ARN *string // This parameter is currently disabled. AutoMinorVersionUpgrade *bool - // The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group - // for the source cluster. - VpcId *string - - // The cache parameter group that is associated with the source cluster. - CacheParameterGroupName *string + // Indicates the status of automatic failover for the source Redis replication + // group. + AutomaticFailover AutomaticFailoverStatus // The date and time when the source cluster was created. CacheClusterCreateTime *time.Time - // For an automatic snapshot, the number of days for which ElastiCache retains the - // snapshot before deleting it. For manual snapshots, this field reflects the - // SnapshotRetentionLimit for the source cluster when the snapshot was created. - // This field is otherwise ignored: Manual snapshots do not expire, and can only be - // deleted using the DeleteSnapshot operation. Important If the value of - // SnapshotRetentionLimit is set to zero (0), backups are turned off. - SnapshotRetentionLimit *int32 - - // The status of the snapshot. Valid values: creating | available | restoring | - // copying | deleting. - SnapshotStatus *string + // The user-supplied identifier of the source cluster. + CacheClusterId *string // The name of the compute and memory capacity node type for the source cluster. //

    The following node types are supported by ElastiCache. Generally speaking, @@ -1417,9 +1369,20 @@ type Snapshot struct { // later.

    CacheNodeType *string - // The daily time range during which ElastiCache takes daily snapshots of the - // source cluster. - SnapshotWindow *string + // The cache parameter group that is associated with the source cluster. + CacheParameterGroupName *string + + // The name of the cache subnet group associated with the source cluster. + CacheSubnetGroupName *string + + // The name of the cache engine (memcached or redis) used by the source cluster. + Engine *string + + // The version of the cache engine version that is used by the source cluster. + EngineVersion *string + + // The ID of the KMS key used to encrypt the snapshot. + KmsKeyId *string // A list of the cache nodes in the source cluster. NodeSnapshots []*NodeSnapshot @@ -1429,40 +1392,77 @@ type Snapshot struct { // 1 and 20. NumCacheNodes *int32 - // The ARN (Amazon Resource Name) of the snapshot. - ARN *string - - // The user-supplied identifier of the source cluster. - CacheClusterId *string - - // The Amazon Resource Name (ARN) for the topic used by the source cluster for - // publishing notifications. - TopicArn *string - - // The port number used by each cache nodes in the source cluster. - Port *int32 - // The number of node groups (shards) in this snapshot. When restoring from a // snapshot, the number of node groups (shards) in the snapshot and in the restored // replication group must be the same. NumNodeGroups *int32 - // Indicates the status of automatic failover for the source Redis replication - // group. - AutomaticFailover AutomaticFailoverStatus + // The port number used by each cache nodes in the source cluster. + Port *int32 + + // The name of the Availability Zone in which the source cluster is located. + PreferredAvailabilityZone *string + + // Specifies the weekly time range during which maintenance on the cluster is + // performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H + // Clock UTC). The minimum maintenance window is a 60 minute period. Valid values + // for ddd are: + // + // * sun + // + // * mon + // + // * tue + // + // * wed + // + // * thu + // + // * fri + // + // + // * sat + // + // Example: sun:23:00-mon:01:30 + PreferredMaintenanceWindow *string // A description of the source replication group. ReplicationGroupDescription *string + // The unique identifier of the source replication group. + ReplicationGroupId *string + // The name of a snapshot. For an automatic snapshot, the name is system-generated. // For a manual snapshot, this is the user-provided name. SnapshotName *string - // The name of the cache engine (memcached or redis) used by the source cluster. - Engine *string + // For an automatic snapshot, the number of days for which ElastiCache retains the + // snapshot before deleting it. For manual snapshots, this field reflects the + // SnapshotRetentionLimit for the source cluster when the snapshot was created. + // This field is otherwise ignored: Manual snapshots do not expire, and can only be + // deleted using the DeleteSnapshot operation. Important If the value of + // SnapshotRetentionLimit is set to zero (0), backups are turned off. + SnapshotRetentionLimit *int32 - // The unique identifier of the source replication group. - ReplicationGroupId *string + // Indicates whether the snapshot is from an automatic backup (automated) or was + // created manually (manual). + SnapshotSource *string + + // The status of the snapshot. Valid values: creating | available | restoring | + // copying | deleting. + SnapshotStatus *string + + // The daily time range during which ElastiCache takes daily snapshots of the + // source cluster. + SnapshotWindow *string + + // The Amazon Resource Name (ARN) for the topic used by the source cluster for + // publishing notifications. + TopicArn *string + + // The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group + // for the source cluster. + VpcId *string } // Represents the subnet associated with a cluster. This parameter refers to @@ -1470,11 +1470,11 @@ type Snapshot struct { // ElastiCache. type Subnet struct { - // The unique identifier for the subnet. - SubnetIdentifier *string - // The Availability Zone associated with the subnet. SubnetAvailabilityZone *AvailabilityZone + + // The unique identifier for the subnet. + SubnetIdentifier *string } // A cost allocation Tag that can be added to an ElastiCache cluster or replication @@ -1493,23 +1493,17 @@ type Tag struct { // during the time range. type TimeRangeFilter struct { - // The start time of the time range filter - StartTime *time.Time - // The end time of the time range filter EndTime *time.Time + + // The start time of the time range filter + StartTime *time.Time } // Update action that has failed to be processed for the corresponding apply/stop // request type UnprocessedUpdateAction struct { - // The replication group ID - ReplicationGroupId *string - - // The unique ID of the service update - ServiceUpdateName *string - // The ID of the cache cluster CacheClusterId *string @@ -1518,54 +1512,57 @@ type UnprocessedUpdateAction struct { // The error type for requests that are not processed ErrorType *string + + // The replication group ID + ReplicationGroupId *string + + // The unique ID of the service update + ServiceUpdateName *string } // The status of the service update for a specific replication group type UpdateAction struct { - // Reflects the nature of the service update - ServiceUpdateType ServiceUpdateType - - // The date when the UpdateActionStatus was last modified - UpdateActionStatusModifiedDate *time.Time - - // The severity of the service update - ServiceUpdateSeverity ServiceUpdateSeverity - - // The unique ID of the service update - ServiceUpdateName *string + // The ID of the cache cluster + CacheClusterId *string // The status of the service update on the cache node CacheNodeUpdateStatus []*CacheNodeUpdateStatus - // The date that the service update is available to a replication group - UpdateActionAvailableDate *time.Time + // The Elasticache engine to which the update applies. Either Redis or Memcached + Engine *string + + // The estimated length of time for the update to complete + EstimatedUpdateTime *string + + // The status of the service update on the node group + NodeGroupUpdateStatus []*NodeGroupUpdateStatus // The progress of the service update on the replication group NodesUpdated *string - // The status of the service update - ServiceUpdateStatus ServiceUpdateStatus + // The ID of the replication group + ReplicationGroupId *string - // The ID of the cache cluster - CacheClusterId *string + // The unique ID of the service update + ServiceUpdateName *string // The recommended date to apply the service update to ensure compliance. For // information on compliance, see Self-Service Security Updates for Compliance // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/elasticache-compliance.html#elasticache-compliance-self-service). ServiceUpdateRecommendedApplyByDate *time.Time - // The status of the update action - UpdateActionStatus UpdateActionStatus - // The date the update is first available ServiceUpdateReleaseDate *time.Time - // The ID of the replication group - ReplicationGroupId *string + // The severity of the service update + ServiceUpdateSeverity ServiceUpdateSeverity - // The estimated length of time for the update to complete - EstimatedUpdateTime *string + // The status of the service update + ServiceUpdateStatus ServiceUpdateStatus + + // Reflects the nature of the service update + ServiceUpdateType ServiceUpdateType // If yes, all nodes in the replication group have been updated by the recommended // apply-by date. If no, at least one node in the replication group have not been @@ -1573,9 +1570,12 @@ type UpdateAction struct { // created after the recommended apply-by date. SlaMet SlaMet - // The Elasticache engine to which the update applies. Either Redis or Memcached - Engine *string + // The date that the service update is available to a replication group + UpdateActionAvailableDate *time.Time - // The status of the service update on the node group - NodeGroupUpdateStatus []*NodeGroupUpdateStatus + // The status of the update action + UpdateActionStatus UpdateActionStatus + + // The date when the UpdateActionStatus was last modified + UpdateActionStatusModifiedDate *time.Time } diff --git a/service/elasticbeanstalk/api_op_ApplyEnvironmentManagedAction.go b/service/elasticbeanstalk/api_op_ApplyEnvironmentManagedAction.go index f6a35e49a91..88cad5f72d8 100644 --- a/service/elasticbeanstalk/api_op_ApplyEnvironmentManagedAction.go +++ b/service/elasticbeanstalk/api_op_ApplyEnvironmentManagedAction.go @@ -60,32 +60,32 @@ func (c *Client) ApplyEnvironmentManagedAction(ctx context.Context, params *Appl // Request to execute a scheduled managed action immediately. type ApplyEnvironmentManagedActionInput struct { + // The action ID of the scheduled managed action to execute. + // + // This member is required. + ActionId *string + // The environment ID of the target environment. EnvironmentId *string // The name of the target environment. EnvironmentName *string - - // The action ID of the scheduled managed action to execute. - // - // This member is required. - ActionId *string } // The result message containing information about the managed action. type ApplyEnvironmentManagedActionOutput struct { - // The status of the managed action. - Status *string - // A description of the managed action. ActionDescription *string + // The action ID of the managed action. + ActionId *string + // The type of managed action. ActionType types.ActionType - // The action ID of the managed action. - ActionId *string + // The status of the managed action. + Status *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/elasticbeanstalk/api_op_AssociateEnvironmentOperationsRole.go b/service/elasticbeanstalk/api_op_AssociateEnvironmentOperationsRole.go index 3c8cd254ef0..530a9134d88 100644 --- a/service/elasticbeanstalk/api_op_AssociateEnvironmentOperationsRole.go +++ b/service/elasticbeanstalk/api_op_AssociateEnvironmentOperationsRole.go @@ -62,16 +62,16 @@ func (c *Client) AssociateEnvironmentOperationsRole(ctx context.Context, params // Request to add or change the operations role used by an environment. type AssociateEnvironmentOperationsRoleInput struct { - // The Amazon Resource Name (ARN) of an existing IAM role to be used as the - // environment's operations role. + // The name of the environment to which to set the operations role. // // This member is required. - OperationsRole *string + EnvironmentName *string - // The name of the environment to which to set the operations role. + // The Amazon Resource Name (ARN) of an existing IAM role to be used as the + // environment's operations role. // // This member is required. - EnvironmentName *string + OperationsRole *string } type AssociateEnvironmentOperationsRoleOutput struct { diff --git a/service/elasticbeanstalk/api_op_ComposeEnvironments.go b/service/elasticbeanstalk/api_op_ComposeEnvironments.go index 9ca88b421ef..ee2c4d20dc0 100644 --- a/service/elasticbeanstalk/api_op_ComposeEnvironments.go +++ b/service/elasticbeanstalk/api_op_ComposeEnvironments.go @@ -63,12 +63,6 @@ func (c *Client) ComposeEnvironments(ctx context.Context, params *ComposeEnviron // Request to create or update a group of environments. type ComposeEnvironmentsInput struct { - // A list of version labels, specifying one or more application source bundles that - // belong to the target application. Each source bundle must include an environment - // manifest that specifies the name of the environment and the name of the solution - // stack to use, and optionally can specify environment links to create. - VersionLabels []*string - // The name of the application to which the specified source bundles belong. ApplicationName *string @@ -78,6 +72,12 @@ type ComposeEnvironmentsInput struct { // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html) // for details. GroupName *string + + // A list of version labels, specifying one or more application source bundles that + // belong to the target application. Each source bundle must include an environment + // manifest that specifies the name of the environment and the name of the solution + // stack to use, and optionally can specify environment links to create. + VersionLabels []*string } // Result message containing a list of environment descriptions. diff --git a/service/elasticbeanstalk/api_op_CreateApplication.go b/service/elasticbeanstalk/api_op_CreateApplication.go index 6b78b0337b7..593088395c6 100644 --- a/service/elasticbeanstalk/api_op_CreateApplication.go +++ b/service/elasticbeanstalk/api_op_CreateApplication.go @@ -59,22 +59,22 @@ func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicatio // Request to create an application. type CreateApplicationInput struct { - // Specifies an application resource lifecycle configuration to prevent your - // application from accumulating too many versions. - ResourceLifecycleConfig *types.ApplicationResourceLifecycleConfig + // The name of the application. Must be unique within your account. + // + // This member is required. + ApplicationName *string // Your description of the application. Description *string + // Specifies an application resource lifecycle configuration to prevent your + // application from accumulating too many versions. + ResourceLifecycleConfig *types.ApplicationResourceLifecycleConfig + // Specifies the tags applied to the application. Elastic Beanstalk applies these // tags only to the application. Environments that you create in the application // don't inherit the tags. Tags []*types.Tag - - // The name of the application. Must be unique within your account. - // - // This member is required. - ApplicationName *string } // Result message containing a single description of an application. diff --git a/service/elasticbeanstalk/api_op_CreateApplicationVersion.go b/service/elasticbeanstalk/api_op_CreateApplicationVersion.go index 248a36fe0a5..69840affc55 100644 --- a/service/elasticbeanstalk/api_op_CreateApplicationVersion.go +++ b/service/elasticbeanstalk/api_op_CreateApplicationVersion.go @@ -68,8 +68,18 @@ func (c *Client) CreateApplicationVersion(ctx context.Context, params *CreateApp // type CreateApplicationVersionInput struct { - // A description of this application version. - Description *string + // The name of the application. If no application is found with this name, and + // AutoCreateApplication is false, returns an InvalidParameterValue error. + // + // This member is required. + ApplicationName *string + + // A label identifying this version. Constraint: Must be unique per application. If + // an application version already exists with this label for the specified + // application, AWS Elastic Beanstalk returns an InvalidParameterValue error. + // + // This member is required. + VersionLabel *string // Set to true to create an application with the specified name if it doesn't // already exist. @@ -78,6 +88,9 @@ type CreateApplicationVersionInput struct { // Settings for an AWS CodeBuild build. BuildConfiguration *types.BuildConfiguration + // A description of this application version. + Description *string + // Pre-processes and validates the environment manifest (env.yaml) and // configuration files (*.config files in the .ebextensions folder) in the source // bundle. Validating configuration files can identify issues prior to deploying @@ -89,17 +102,6 @@ type CreateApplicationVersionInput struct { // Docker configuration. Process *bool - // Specifies the tags applied to the application version. Elastic Beanstalk applies - // these tags only to the application version. Environments that use the - // application version don't inherit the tags. - Tags []*types.Tag - - // The name of the application. If no application is found with this name, and - // AutoCreateApplication is false, returns an InvalidParameterValue error. - // - // This member is required. - ApplicationName *string - // Specify a commit in an AWS CodeCommit Git repository to use as the source code // for the application version. SourceBuildInformation *types.SourceBuildInformation @@ -112,12 +114,10 @@ type CreateApplicationVersionInput struct { // application. SourceBundle *types.S3Location - // A label identifying this version. Constraint: Must be unique per application. If - // an application version already exists with this label for the specified - // application, AWS Elastic Beanstalk returns an InvalidParameterValue error. - // - // This member is required. - VersionLabel *string + // Specifies the tags applied to the application version. Elastic Beanstalk applies + // these tags only to the application version. Environments that use the + // application version don't inherit the tags. + Tags []*types.Tag } // Result message wrapping a single description of an application version. diff --git a/service/elasticbeanstalk/api_op_CreateConfigurationTemplate.go b/service/elasticbeanstalk/api_op_CreateConfigurationTemplate.go index d55a701d2ce..98de5f14a65 100644 --- a/service/elasticbeanstalk/api_op_CreateConfigurationTemplate.go +++ b/service/elasticbeanstalk/api_op_CreateConfigurationTemplate.go @@ -72,40 +72,41 @@ func (c *Client) CreateConfigurationTemplate(ctx context.Context, params *Create // Request to create a configuration template. type CreateConfigurationTemplateInput struct { - // Specifies the tags applied to the configuration template. - Tags []*types.Tag - // The name of the Elastic Beanstalk application to associate with this // configuration template. // // This member is required. ApplicationName *string - // The Amazon Resource Name (ARN) of the custom platform. For more information, see - // Custom Platforms - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) - // in the AWS Elastic Beanstalk Developer Guide.

    If you specify - // PlatformArn, then don't specify SolutionStackName.

    - // - PlatformArn *string + // The name of the configuration template. Constraint: This name must be unique per + // application. + // + // This member is required. + TemplateName *string + + // An optional description for this configuration. + Description *string // The ID of an environment whose settings you want to use to create the // configuration template. You must specify EnvironmentId if you don't specify // PlatformArn, SolutionStackName, or SourceConfiguration. EnvironmentId *string - // An optional description for this configuration. - Description *string + // Option values for the Elastic Beanstalk configuration, such as the instance + // type. If specified, these values override the values obtained from the solution + // stack or the source configuration template. For a complete list of Elastic + // Beanstalk configuration options, see Option Values + // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in + // the AWS Elastic Beanstalk Developer Guide. + OptionSettings []*types.ConfigurationOptionSetting - // An Elastic Beanstalk configuration template to base this one on. If specified, - // Elastic Beanstalk uses the configuration values from the specified configuration - // template to create a new configuration. Values specified in OptionSettings - // override any values obtained from the SourceConfiguration. You must specify - // SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or - // SolutionStackName. Constraint: If both solution stack name and source - // configuration are specified, the solution stack of the source configuration - // template must match the specified solution stack name. - SourceConfiguration *types.SourceConfiguration + // The Amazon Resource Name (ARN) of the custom platform. For more information, see + // Custom Platforms + // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) + // in the AWS Elastic Beanstalk Developer Guide.

    If you specify + // PlatformArn, then don't specify SolutionStackName.

    + // + PlatformArn *string // The name of an Elastic Beanstalk solution stack (platform version) that this // configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 @@ -121,19 +122,18 @@ type CreateConfigurationTemplateInput struct { // API to obtain a list of available solution stacks. SolutionStackName *string - // The name of the configuration template. Constraint: This name must be unique per - // application. - // - // This member is required. - TemplateName *string + // An Elastic Beanstalk configuration template to base this one on. If specified, + // Elastic Beanstalk uses the configuration values from the specified configuration + // template to create a new configuration. Values specified in OptionSettings + // override any values obtained from the SourceConfiguration. You must specify + // SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or + // SolutionStackName. Constraint: If both solution stack name and source + // configuration are specified, the solution stack of the source configuration + // template must match the specified solution stack name. + SourceConfiguration *types.SourceConfiguration - // Option values for the Elastic Beanstalk configuration, such as the instance - // type. If specified, these values override the values obtained from the solution - // stack or the source configuration template. For a complete list of Elastic - // Beanstalk configuration options, see Option Values - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in - // the AWS Elastic Beanstalk Developer Guide. - OptionSettings []*types.ConfigurationOptionSetting + // Specifies the tags applied to the configuration template. + Tags []*types.Tag } // Describes the settings for a configuration set. @@ -142,26 +142,11 @@ type CreateConfigurationTemplateOutput struct { // The name of the application associated with this configuration set. ApplicationName *string - // If not null, the name of the environment for this configuration set. - EnvironmentName *string - - // The ARN of the platform version. - PlatformArn *string - - // The date (in UTC time) when this configuration set was last modified. - DateUpdated *time.Time - // The date (in UTC time) when this configuration set was created. DateCreated *time.Time - // The name of the solution stack this configuration set uses. - SolutionStackName *string - - // Describes this configuration set. - Description *string - - // A list of the configuration options and their values in this configuration set. - OptionSettings []*types.ConfigurationOptionSetting + // The date (in UTC time) when this configuration set was last modified. + DateUpdated *time.Time // If this configuration set is associated with an environment, the // DeploymentStatus parameter indicates the deployment status of this configuration @@ -181,6 +166,21 @@ type CreateConfigurationTemplateOutput struct { // successfully deploy. DeploymentStatus types.ConfigurationDeploymentStatus + // Describes this configuration set. + Description *string + + // If not null, the name of the environment for this configuration set. + EnvironmentName *string + + // A list of the configuration options and their values in this configuration set. + OptionSettings []*types.ConfigurationOptionSetting + + // The ARN of the platform version. + PlatformArn *string + + // The name of the solution stack this configuration set uses. + SolutionStackName *string + // If not null, the name of the configuration template for this configuration set. TemplateName *string diff --git a/service/elasticbeanstalk/api_op_CreateEnvironment.go b/service/elasticbeanstalk/api_op_CreateEnvironment.go index 48c1fde0cd7..749c3320c52 100644 --- a/service/elasticbeanstalk/api_op_CreateEnvironment.go +++ b/service/elasticbeanstalk/api_op_CreateEnvironment.go @@ -60,24 +60,10 @@ func (c *Client) CreateEnvironment(ctx context.Context, params *CreateEnvironmen // type CreateEnvironmentInput struct { - // If specified, AWS Elastic Beanstalk sets the specified configuration options to - // the requested value in the configuration set for the new environment. These - // override the values obtained from the solution stack or the configuration - // template. - OptionSettings []*types.ConfigurationOptionSetting - - // The name of the Elastic Beanstalk configuration template to use with the - // environment. If you specify TemplateName, then don't specify SolutionStackName. - TemplateName *string - - // The name of an Elastic Beanstalk solution stack (platform version) to use with - // the environment. If specified, Elastic Beanstalk sets the configuration values - // to the default values associated with the specified solution stack. For a list - // of current solution stacks, see Elastic Beanstalk Supported Platforms - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/platforms/platforms-supported.html) - // in the AWS Elastic Beanstalk Platforms guide. If you specify SolutionStackName, - // don't specify PlatformArn or TemplateName. - SolutionStackName *string + // The name of the application that is associated with this environment. + // + // This member is required. + ApplicationName *string // If specified, the environment attempts to use this value as the prefix for the // CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is @@ -85,27 +71,9 @@ type CreateEnvironmentInput struct { // environment name. CNAMEPrefix *string - // Specifies the tags applied to resources in the environment. - Tags []*types.Tag - - // The name of the group to which the target environment belongs. Specify a group - // name only if the environment's name is specified in an environment manifest and - // not with the environment name parameter. See Environment Manifest (env.yaml) - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html) - // for details. - GroupName *string - // Your description for this environment. Description *string - // The Amazon Resource Name (ARN) of the custom platform to use with the - // environment. For more information, see Custom Platforms - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) - // in the AWS Elastic Beanstalk Developer Guide.

    If you specify - // PlatformArn, don't specify SolutionStackName.

    - // - PlatformArn *string - // A unique name for the environment. Constraint: Must be from 4 to 40 characters // in length. The name can contain only letters, numbers, and hyphens. It can't // start or end with a hyphen. This name must be unique within a region in your @@ -115,18 +83,12 @@ type CreateEnvironmentInput struct { // the visible URL for your application. EnvironmentName *string - // The name of the application that is associated with this environment. - // - // This member is required. - ApplicationName *string - - // The name of the application version to deploy. Default: If not specified, - // Elastic Beanstalk attempts to deploy the sample application. - VersionLabel *string - - // A list of custom user-defined configuration options to remove from the - // configuration set for this new environment. - OptionsToRemove []*types.OptionSpecification + // The name of the group to which the target environment belongs. Specify a group + // name only if the environment's name is specified in an environment manifest and + // not with the environment name parameter. See Environment Manifest (env.yaml) + // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html) + // for details. + GroupName *string // The Amazon Resource Name (ARN) of an existing IAM role to be used as the // environment's operations role. If specified, Elastic Beanstalk uses the @@ -138,79 +100,90 @@ type CreateEnvironmentInput struct { // in the AWS Elastic Beanstalk Developer Guide. OperationsRole *string + // If specified, AWS Elastic Beanstalk sets the specified configuration options to + // the requested value in the configuration set for the new environment. These + // override the values obtained from the solution stack or the configuration + // template. + OptionSettings []*types.ConfigurationOptionSetting + + // A list of custom user-defined configuration options to remove from the + // configuration set for this new environment. + OptionsToRemove []*types.OptionSpecification + + // The Amazon Resource Name (ARN) of the custom platform to use with the + // environment. For more information, see Custom Platforms + // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) + // in the AWS Elastic Beanstalk Developer Guide.

    If you specify + // PlatformArn, don't specify SolutionStackName.

    + // + PlatformArn *string + + // The name of an Elastic Beanstalk solution stack (platform version) to use with + // the environment. If specified, Elastic Beanstalk sets the configuration values + // to the default values associated with the specified solution stack. For a list + // of current solution stacks, see Elastic Beanstalk Supported Platforms + // (https://docs.aws.amazon.com/elasticbeanstalk/latest/platforms/platforms-supported.html) + // in the AWS Elastic Beanstalk Platforms guide. If you specify SolutionStackName, + // don't specify PlatformArn or TemplateName. + SolutionStackName *string + + // Specifies the tags applied to resources in the environment. + Tags []*types.Tag + + // The name of the Elastic Beanstalk configuration template to use with the + // environment. If you specify TemplateName, then don't specify SolutionStackName. + TemplateName *string + // Specifies the tier to use in creating this environment. The environment tier // that you choose determines whether Elastic Beanstalk provisions resources to // support a web application that handles HTTP(S) requests or a web application // that handles background-processing tasks. Tier *types.EnvironmentTier + + // The name of the application version to deploy. Default: If not specified, + // Elastic Beanstalk attempts to deploy the sample application. + VersionLabel *string } // Describes the properties of an environment. type CreateEnvironmentOutput struct { - // A list of links to other environments in the same group. - EnvironmentLinks []*types.EnvironmentLink - - // Returns the health status of the application running in your environment. For - // more information, see Health Colors and Statuses - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html). - HealthStatus types.EnvironmentHealthStatus - - // For load-balanced, autoscaling environments, the URL to the LoadBalancer. For - // single-instance environments, the IP address of the instance. - EndpointURL *string - - // The ARN of the platform version. - PlatformArn *string - - // The ID of this environment. - EnvironmentId *string - - // The name of the application associated with this environment. - ApplicationName *string - // Indicates if there is an in-progress environment configuration update or // application version deployment that you can cancel. true: There is an update in // progress. false: There are no updates currently in progress. AbortableOperationInProgress *bool - // The creation date for this environment. - DateCreated *time.Time - - // The Amazon Resource Name (ARN) of the environment's operations role. For more - // information, see Operations roles - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html) - // in the AWS Elastic Beanstalk Developer Guide. - OperationsRole *string - - // Describes the current tier of this environment. - Tier *types.EnvironmentTier + // The name of the application associated with this environment. + ApplicationName *string // The URL to the CNAME for this environment. CNAME *string + // The creation date for this environment. + DateCreated *time.Time + + // The last modified date for this environment. + DateUpdated *time.Time + // Describes this environment. Description *string - // The name of the SolutionStack deployed with this environment. - SolutionStackName *string - - // The current operational status of the environment:

    • - // Launching: Environment is in the process of initial deployment.

      - //

    • Updating: Environment is in the process of updating - // its configuration settings or application version.

    • - // Ready: Environment is available to have an action performed on it, - // such as update or terminate.

    • Terminating: - // Environment is in the shut-down process.

    • - // Terminated: Environment is not running.

    - Status types.EnvironmentStatus + // For load-balanced, autoscaling environments, the URL to the LoadBalancer. For + // single-instance environments, the IP address of the instance. + EndpointURL *string // The environment's Amazon Resource Name (ARN), which can be used in other API // requests that require an ARN. EnvironmentArn *string - // The last modified date for this environment. - DateUpdated *time.Time + // The ID of this environment. + EnvironmentId *string + + // A list of links to other environments in the same group. + EnvironmentLinks []*types.EnvironmentLink + + // The name of this environment. + EnvironmentName *string // Describes the health status of the environment. AWS Elastic Beanstalk indicates // the failure levels for a running environment: @@ -233,19 +206,46 @@ type CreateEnvironmentOutput struct { // Default: Grey Health types.EnvironmentHealth - // The application version deployed in this environment. - VersionLabel *string + // Returns the health status of the application running in your environment. For + // more information, see Health Colors and Statuses + // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html). + HealthStatus types.EnvironmentHealthStatus - // The name of this environment. - EnvironmentName *string + // The Amazon Resource Name (ARN) of the environment's operations role. For more + // information, see Operations roles + // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html) + // in the AWS Elastic Beanstalk Developer Guide. + OperationsRole *string + + // The ARN of the platform version. + PlatformArn *string // The description of the AWS resources used by this environment. Resources *types.EnvironmentResourcesDescription + // The name of the SolutionStack deployed with this environment. + SolutionStackName *string + + // The current operational status of the environment:

    • + // Launching: Environment is in the process of initial deployment.

      + //

    • Updating: Environment is in the process of updating + // its configuration settings or application version.

    • + // Ready: Environment is available to have an action performed on it, + // such as update or terminate.

    • Terminating: + // Environment is in the shut-down process.

    • + // Terminated: Environment is not running.

    + Status types.EnvironmentStatus + // The name of the configuration template used to originally launch this // environment. TemplateName *string + // Describes the current tier of this environment. + Tier *types.EnvironmentTier + + // The application version deployed in this environment. + VersionLabel *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticbeanstalk/api_op_CreatePlatformVersion.go b/service/elasticbeanstalk/api_op_CreatePlatformVersion.go index f7f61da28a0..3dcc4f64eb3 100644 --- a/service/elasticbeanstalk/api_op_CreatePlatformVersion.go +++ b/service/elasticbeanstalk/api_op_CreatePlatformVersion.go @@ -58,11 +58,6 @@ func (c *Client) CreatePlatformVersion(ctx context.Context, params *CreatePlatfo // Request to create a new platform version. type CreatePlatformVersionInput struct { - // The number, such as 1.0.2, for the new platform version. - // - // This member is required. - PlatformVersion *string - // The location of the platform definition archive in Amazon S3. // // This member is required. @@ -73,6 +68,11 @@ type CreatePlatformVersionInput struct { // This member is required. PlatformName *string + // The number, such as 1.0.2, for the new platform version. + // + // This member is required. + PlatformVersion *string + // The name of the builder environment. EnvironmentName *string @@ -87,12 +87,12 @@ type CreatePlatformVersionInput struct { type CreatePlatformVersionOutput struct { - // Detailed information about the new version of the custom platform. - PlatformSummary *types.PlatformSummary - // The builder used to create the custom platform. Builder *types.Builder + // Detailed information about the new version of the custom platform. + PlatformSummary *types.PlatformSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticbeanstalk/api_op_DeleteApplicationVersion.go b/service/elasticbeanstalk/api_op_DeleteApplicationVersion.go index 8e21b25e65b..34fc07d0c56 100644 --- a/service/elasticbeanstalk/api_op_DeleteApplicationVersion.go +++ b/service/elasticbeanstalk/api_op_DeleteApplicationVersion.go @@ -58,11 +58,6 @@ func (c *Client) DeleteApplicationVersion(ctx context.Context, params *DeleteApp // Request to delete an application version. type DeleteApplicationVersionInput struct { - // Set to true to delete the source bundle from your storage bucket. Otherwise, the - // application version is deleted only from Elastic Beanstalk and the source bundle - // remains in Amazon S3. - DeleteSourceBundle *bool - // The name of the application to which the version belongs. // // This member is required. @@ -72,6 +67,11 @@ type DeleteApplicationVersionInput struct { // // This member is required. VersionLabel *string + + // Set to true to delete the source bundle from your storage bucket. Otherwise, the + // application version is deleted only from Elastic Beanstalk and the source bundle + // remains in Amazon S3. + DeleteSourceBundle *bool } type DeleteApplicationVersionOutput struct { diff --git a/service/elasticbeanstalk/api_op_DescribeApplicationVersions.go b/service/elasticbeanstalk/api_op_DescribeApplicationVersions.go index a102e8b05c8..98a969448f1 100644 --- a/service/elasticbeanstalk/api_op_DescribeApplicationVersions.go +++ b/service/elasticbeanstalk/api_op_DescribeApplicationVersions.go @@ -61,17 +61,17 @@ type DescribeApplicationVersionsInput struct { // application. ApplicationName *string + // For a paginated request. Specify a maximum number of application versions to + // include in each response. If no MaxRecords is specified, all available + // application versions are retrieved in a single response. + MaxRecords *int32 + // For a paginated request. Specify a token from a previous response page to // retrieve the next response page. All other parameter values must be identical to // the ones specified in the initial request. If no NextToken is specified, the // first page is retrieved. NextToken *string - // For a paginated request. Specify a maximum number of application versions to - // include in each response. If no MaxRecords is specified, all available - // application versions are retrieved in a single response. - MaxRecords *int32 - // Specify a version label to show a specific application version. VersionLabels []*string } diff --git a/service/elasticbeanstalk/api_op_DescribeConfigurationOptions.go b/service/elasticbeanstalk/api_op_DescribeConfigurationOptions.go index 0aff43bb3ed..1a0b3bb7709 100644 --- a/service/elasticbeanstalk/api_op_DescribeConfigurationOptions.go +++ b/service/elasticbeanstalk/api_op_DescribeConfigurationOptions.go @@ -61,40 +61,40 @@ func (c *Client) DescribeConfigurationOptions(ctx context.Context, params *Descr // Result message containing a list of application version descriptions. type DescribeConfigurationOptionsInput struct { + // The name of the application associated with the configuration template or + // environment. Only needed if you want to describe the configuration options + // associated with either the configuration template or environment. + ApplicationName *string + + // The name of the environment whose configuration options you want to describe. + EnvironmentName *string + // If specified, restricts the descriptions to only the specified options. Options []*types.OptionSpecification // The ARN of the custom platform. PlatformArn *string - // The name of the configuration template whose configuration options you want to - // describe. - TemplateName *string - // The name of the solution stack whose configuration options you want to describe. SolutionStackName *string - // The name of the application associated with the configuration template or - // environment. Only needed if you want to describe the configuration options - // associated with either the configuration template or environment. - ApplicationName *string - - // The name of the environment whose configuration options you want to describe. - EnvironmentName *string + // The name of the configuration template whose configuration options you want to + // describe. + TemplateName *string } // Describes the settings for a specified configuration set. type DescribeConfigurationOptionsOutput struct { - // The name of the solution stack these configuration options belong to. - SolutionStackName *string - // A list of ConfigurationOptionDescription (). Options []*types.ConfigurationOptionDescription // The ARN of the platform version. PlatformArn *string + // The name of the solution stack these configuration options belong to. + SolutionStackName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticbeanstalk/api_op_DescribeEnvironmentHealth.go b/service/elasticbeanstalk/api_op_DescribeEnvironmentHealth.go index fd2874f1eae..3966edfd3b4 100644 --- a/service/elasticbeanstalk/api_op_DescribeEnvironmentHealth.go +++ b/service/elasticbeanstalk/api_op_DescribeEnvironmentHealth.go @@ -60,29 +60,22 @@ func (c *Client) DescribeEnvironmentHealth(ctx context.Context, params *Describe // See the example below to learn how to create a request body. type DescribeEnvironmentHealthInput struct { - // Specify the environment by name. You must specify either this or an - // EnvironmentName, or both. - EnvironmentName *string + // Specify the response elements to return. To retrieve all attributes, set to All. + // If no attribute names are specified, returns the name of the environment. + AttributeNames []types.EnvironmentHealthAttribute // Specify the environment by ID. You must specify either this or an // EnvironmentName, or both. EnvironmentId *string - // Specify the response elements to return. To retrieve all attributes, set to All. - // If no attribute names are specified, returns the name of the environment. - AttributeNames []types.EnvironmentHealthAttribute + // Specify the environment by name. You must specify either this or an + // EnvironmentName, or both. + EnvironmentName *string } // Health details for an AWS Elastic Beanstalk environment. type DescribeEnvironmentHealthOutput struct { - // The environment's name. - EnvironmentName *string - - // The environment's operational status. Ready, Launching, Updating, Terminating, - // or Terminated. - Status types.EnvironmentHealth - // Application request metrics for the environment. ApplicationMetrics *types.ApplicationMetrics @@ -90,21 +83,28 @@ type DescribeEnvironmentHealthOutput struct { // status. Causes []*string - // The date and time that the health information was retrieved. - RefreshedAt *time.Time + // The health color + // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html) + // of the environment. + Color *string - // Summary health information for the instances in the environment. - InstancesHealth *types.InstanceHealthSummary + // The environment's name. + EnvironmentName *string // The health status // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html) // of the environment. For example, Ok. HealthStatus *string - // The health color - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html) - // of the environment. - Color *string + // Summary health information for the instances in the environment. + InstancesHealth *types.InstanceHealthSummary + + // The date and time that the health information was retrieved. + RefreshedAt *time.Time + + // The environment's operational status. Ready, Launching, Updating, Terminating, + // or Terminated. + Status types.EnvironmentHealth // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/elasticbeanstalk/api_op_DescribeEnvironmentManagedActionHistory.go b/service/elasticbeanstalk/api_op_DescribeEnvironmentManagedActionHistory.go index 1010e38515a..420d535883d 100644 --- a/service/elasticbeanstalk/api_op_DescribeEnvironmentManagedActionHistory.go +++ b/service/elasticbeanstalk/api_op_DescribeEnvironmentManagedActionHistory.go @@ -63,11 +63,11 @@ type DescribeEnvironmentManagedActionHistoryInput struct { // The name of the target environment. EnvironmentName *string - // The pagination token returned by a previous request. - NextToken *string - // The maximum number of items to return for a single request. MaxItems *int32 + + // The pagination token returned by a previous request. + NextToken *string } // A result message containing a list of completed and failed managed actions. diff --git a/service/elasticbeanstalk/api_op_DescribeEnvironmentManagedActions.go b/service/elasticbeanstalk/api_op_DescribeEnvironmentManagedActions.go index 43d3de43f07..b475caa7780 100644 --- a/service/elasticbeanstalk/api_op_DescribeEnvironmentManagedActions.go +++ b/service/elasticbeanstalk/api_op_DescribeEnvironmentManagedActions.go @@ -57,12 +57,12 @@ func (c *Client) DescribeEnvironmentManagedActions(ctx context.Context, params * // Request to list an environment's upcoming and in-progress managed actions. type DescribeEnvironmentManagedActionsInput struct { - // The name of the target environment. - EnvironmentName *string - // The environment ID of the target environment. EnvironmentId *string + // The name of the target environment. + EnvironmentName *string + // To show only actions with a particular status, specify a status. Status types.ActionStatus } diff --git a/service/elasticbeanstalk/api_op_DescribeEnvironmentResources.go b/service/elasticbeanstalk/api_op_DescribeEnvironmentResources.go index 83b314551d6..89376a0a007 100644 --- a/service/elasticbeanstalk/api_op_DescribeEnvironmentResources.go +++ b/service/elasticbeanstalk/api_op_DescribeEnvironmentResources.go @@ -57,15 +57,15 @@ func (c *Client) DescribeEnvironmentResources(ctx context.Context, params *Descr // Request to describe the resources in an environment. type DescribeEnvironmentResourcesInput struct { - // The name of the environment to retrieve AWS resource usage data. Condition: You - // must specify either this or an EnvironmentId, or both. If you do not specify - // either, AWS Elastic Beanstalk returns MissingRequiredParameter error. - EnvironmentName *string - // The ID of the environment to retrieve AWS resource usage data. Condition: You // must specify either this or an EnvironmentName, or both. If you do not specify // either, AWS Elastic Beanstalk returns MissingRequiredParameter error. EnvironmentId *string + + // The name of the environment to retrieve AWS resource usage data. Condition: You + // must specify either this or an EnvironmentId, or both. If you do not specify + // either, AWS Elastic Beanstalk returns MissingRequiredParameter error. + EnvironmentName *string } // Result message containing a list of environment resource descriptions. diff --git a/service/elasticbeanstalk/api_op_DescribeEnvironments.go b/service/elasticbeanstalk/api_op_DescribeEnvironments.go index 00d6e8ef04e..f5646835344 100644 --- a/service/elasticbeanstalk/api_op_DescribeEnvironments.go +++ b/service/elasticbeanstalk/api_op_DescribeEnvironments.go @@ -58,6 +58,14 @@ func (c *Client) DescribeEnvironments(ctx context.Context, params *DescribeEnvir // Request to describe one or more environments. type DescribeEnvironmentsInput struct { + // If specified, AWS Elastic Beanstalk restricts the returned descriptions to + // include only those that are associated with this application. + ApplicationName *string + + // If specified, AWS Elastic Beanstalk restricts the returned descriptions to + // include only those that have the specified IDs. + EnvironmentIds []*string + // If specified, AWS Elastic Beanstalk restricts the returned descriptions to // include only those that have the specified names. EnvironmentNames []*string @@ -67,22 +75,14 @@ type DescribeEnvironmentsInput struct { // deleted environments. IncludeDeleted *bool - // For a paginated request. Specify a maximum number of environments to include in - // each response. If no MaxRecords is specified, all available environments are - // retrieved in a single response. - MaxRecords *int32 - // If specified when IncludeDeleted is set to true, then environments deleted after // this date are displayed. IncludedDeletedBackTo *time.Time - // If specified, AWS Elastic Beanstalk restricts the returned descriptions to - // include only those that have the specified IDs. - EnvironmentIds []*string - - // If specified, AWS Elastic Beanstalk restricts the returned descriptions to - // include only those that are associated with this application. - ApplicationName *string + // For a paginated request. Specify a maximum number of environments to include in + // each response. If no MaxRecords is specified, all available environments are + // retrieved in a single response. + MaxRecords *int32 // For a paginated request. Specify a token from a previous response page to // retrieve the next response page. All other parameter values must be identical to diff --git a/service/elasticbeanstalk/api_op_DescribeEvents.go b/service/elasticbeanstalk/api_op_DescribeEvents.go index 74fd2d92a8d..18c9c448a2b 100644 --- a/service/elasticbeanstalk/api_op_DescribeEvents.go +++ b/service/elasticbeanstalk/api_op_DescribeEvents.go @@ -59,65 +59,65 @@ func (c *Client) DescribeEvents(ctx context.Context, params *DescribeEventsInput // Request to retrieve a list of events for an environment. type DescribeEventsInput struct { - // If specified, AWS Elastic Beanstalk restricts the described events to include - // only those associated with this request ID. - RequestId *string + // If specified, AWS Elastic Beanstalk restricts the returned descriptions to + // include only those associated with this application. + ApplicationName *string // If specified, AWS Elastic Beanstalk restricts the returned descriptions to those - // that are associated with this environment configuration. - TemplateName *string + // that occur up to, but not including, the EndTime. + EndTime *time.Time + + // If specified, AWS Elastic Beanstalk restricts the returned descriptions to those + // associated with this environment. + EnvironmentId *string + + // If specified, AWS Elastic Beanstalk restricts the returned descriptions to those + // associated with this environment. + EnvironmentName *string // Specifies the maximum number of events that can be returned, beginning with the // most recent event. MaxRecords *int32 - // If specified, AWS Elastic Beanstalk restricts the returned descriptions to those - // that occur on or after this time. - StartTime *time.Time + // Pagination token. If specified, the events return the next batch of results. + NextToken *string - // If specified, AWS Elastic Beanstalk restricts the returned descriptions to those - // that occur up to, but not including, the EndTime. - EndTime *time.Time + // The ARN of a custom platform version. If specified, AWS Elastic Beanstalk + // restricts the returned descriptions to those associated with this custom + // platform version. + PlatformArn *string + + // If specified, AWS Elastic Beanstalk restricts the described events to include + // only those associated with this request ID. + RequestId *string // If specified, limits the events returned from this call to include only those // with the specified severity or higher. Severity types.EventSeverity - // If specified, AWS Elastic Beanstalk restricts the returned descriptions to - // include only those associated with this application. - ApplicationName *string - // If specified, AWS Elastic Beanstalk restricts the returned descriptions to those - // associated with this environment. - EnvironmentName *string + // that occur on or after this time. + StartTime *time.Time // If specified, AWS Elastic Beanstalk restricts the returned descriptions to those - // associated with this environment. - EnvironmentId *string - - // The ARN of a custom platform version. If specified, AWS Elastic Beanstalk - // restricts the returned descriptions to those associated with this custom - // platform version. - PlatformArn *string + // that are associated with this environment configuration. + TemplateName *string // If specified, AWS Elastic Beanstalk restricts the returned descriptions to those // associated with this application version. VersionLabel *string - - // Pagination token. If specified, the events return the next batch of results. - NextToken *string } // Result message wrapping a list of event descriptions. type DescribeEventsOutput struct { + // A list of EventDescription (). + Events []*types.EventDescription + // If returned, this indicates that there are more results to obtain. Use this // token in the next DescribeEvents () call to get the next batch of events. NextToken *string - // A list of EventDescription (). - Events []*types.EventDescription - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticbeanstalk/api_op_DescribeInstancesHealth.go b/service/elasticbeanstalk/api_op_DescribeInstancesHealth.go index 866f0cc6304..d1c5a07f8fe 100644 --- a/service/elasticbeanstalk/api_op_DescribeInstancesHealth.go +++ b/service/elasticbeanstalk/api_op_DescribeInstancesHealth.go @@ -60,6 +60,10 @@ func (c *Client) DescribeInstancesHealth(ctx context.Context, params *DescribeIn // Parameters for a call to DescribeInstancesHealth. type DescribeInstancesHealthInput struct { + // Specifies the response elements you wish to receive. To retrieve all attributes, + // set to All. If no attribute names are specified, returns a list of instances. + AttributeNames []types.InstancesHealthAttribute + // Specify the AWS Elastic Beanstalk environment by ID. EnvironmentId *string @@ -68,10 +72,6 @@ type DescribeInstancesHealthInput struct { // Specify the pagination token returned by a previous call. NextToken *string - - // Specifies the response elements you wish to receive. To retrieve all attributes, - // set to All. If no attribute names are specified, returns a list of instances. - AttributeNames []types.InstancesHealthAttribute } // Detailed health information about the Amazon EC2 instances in an AWS Elastic diff --git a/service/elasticbeanstalk/api_op_ListPlatformBranches.go b/service/elasticbeanstalk/api_op_ListPlatformBranches.go index 744b728c033..eb92f897fe8 100644 --- a/service/elasticbeanstalk/api_op_ListPlatformBranches.go +++ b/service/elasticbeanstalk/api_op_ListPlatformBranches.go @@ -96,25 +96,25 @@ type ListPlatformBranchesInput struct { // objects. Within each SearchFilter item, the Values array is limited to 10 items. Filters []*types.SearchFilter + // The maximum number of platform branch values returned in one call. + MaxRecords *int32 + // For a paginated request. Specify a token from a previous response page to // retrieve the next response page. All other parameter values must be identical to // the ones specified in the initial request. If no NextToken is specified, the // first page is retrieved. NextToken *string - - // The maximum number of platform branch values returned in one call. - MaxRecords *int32 } type ListPlatformBranchesOutput struct { - // Summary information about the platform branches. - PlatformBranchSummaryList []*types.PlatformBranchSummary - // In a paginated request, if this value isn't null, it's the token that you can // pass in a subsequent request to get the next response page. NextToken *string + // Summary information about the platform branches. + PlatformBranchSummaryList []*types.PlatformBranchSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticbeanstalk/api_op_ListPlatformVersions.go b/service/elasticbeanstalk/api_op_ListPlatformVersions.go index 9440d765c5d..ef4794fdd9e 100644 --- a/service/elasticbeanstalk/api_op_ListPlatformVersions.go +++ b/service/elasticbeanstalk/api_op_ListPlatformVersions.go @@ -61,13 +61,13 @@ func (c *Client) ListPlatformVersions(ctx context.Context, params *ListPlatformV type ListPlatformVersionsInput struct { - // The maximum number of platform version values returned in one call. - MaxRecords *int32 - // Criteria for restricting the resulting list of platform versions. The filter is // interpreted as a logical conjunction (AND) of the separate PlatformFilter terms. Filters []*types.PlatformFilter + // The maximum number of platform version values returned in one call. + MaxRecords *int32 + // For a paginated request. Specify a token from a previous response page to // retrieve the next response page. All other parameter values must be identical to // the ones specified in the initial request. If no NextToken is specified, the diff --git a/service/elasticbeanstalk/api_op_RebuildEnvironment.go b/service/elasticbeanstalk/api_op_RebuildEnvironment.go index aad68a31f3b..00a2bb6ca4c 100644 --- a/service/elasticbeanstalk/api_op_RebuildEnvironment.go +++ b/service/elasticbeanstalk/api_op_RebuildEnvironment.go @@ -57,15 +57,15 @@ func (c *Client) RebuildEnvironment(ctx context.Context, params *RebuildEnvironm // type RebuildEnvironmentInput struct { - // The name of the environment to rebuild. Condition: You must specify either this - // or an EnvironmentId, or both. If you do not specify either, AWS Elastic - // Beanstalk returns MissingRequiredParameter error. - EnvironmentName *string - // The ID of the environment to rebuild. Condition: You must specify either this or // an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk // returns MissingRequiredParameter error. EnvironmentId *string + + // The name of the environment to rebuild. Condition: You must specify either this + // or an EnvironmentId, or both. If you do not specify either, AWS Elastic + // Beanstalk returns MissingRequiredParameter error. + EnvironmentName *string } type RebuildEnvironmentOutput struct { diff --git a/service/elasticbeanstalk/api_op_RequestEnvironmentInfo.go b/service/elasticbeanstalk/api_op_RequestEnvironmentInfo.go index 11a5a242ea9..efa2dff3c6e 100644 --- a/service/elasticbeanstalk/api_op_RequestEnvironmentInfo.go +++ b/service/elasticbeanstalk/api_op_RequestEnvironmentInfo.go @@ -72,17 +72,17 @@ type RequestEnvironmentInfoInput struct { // This member is required. InfoType types.EnvironmentInfoType - // The name of the environment of the requested data. If no such environment is - // found, RequestEnvironmentInfo returns an InvalidParameterValue error. Condition: - // You must specify either this or an EnvironmentId, or both. If you do not specify - // either, AWS Elastic Beanstalk returns MissingRequiredParameter error. - EnvironmentName *string - // The ID of the environment of the requested data. If no such environment is // found, RequestEnvironmentInfo returns an InvalidParameterValue error. Condition: // You must specify either this or an EnvironmentName, or both. If you do not // specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. EnvironmentId *string + + // The name of the environment of the requested data. If no such environment is + // found, RequestEnvironmentInfo returns an InvalidParameterValue error. Condition: + // You must specify either this or an EnvironmentId, or both. If you do not specify + // either, AWS Elastic Beanstalk returns MissingRequiredParameter error. + EnvironmentName *string } type RequestEnvironmentInfoOutput struct { diff --git a/service/elasticbeanstalk/api_op_RetrieveEnvironmentInfo.go b/service/elasticbeanstalk/api_op_RetrieveEnvironmentInfo.go index c1d7bfd291f..bf03de2b771 100644 --- a/service/elasticbeanstalk/api_op_RetrieveEnvironmentInfo.go +++ b/service/elasticbeanstalk/api_op_RetrieveEnvironmentInfo.go @@ -61,6 +61,11 @@ func (c *Client) RetrieveEnvironmentInfo(ctx context.Context, params *RetrieveEn // Request to download logs retrieved with RequestEnvironmentInfo (). type RetrieveEnvironmentInfoInput struct { + // The type of information to retrieve. + // + // This member is required. + InfoType types.EnvironmentInfoType + // The ID of the data's environment. If no such environment is found, returns an // InvalidParameterValue error. Condition: You must specify either this or an // EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk @@ -72,11 +77,6 @@ type RetrieveEnvironmentInfoInput struct { // EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk // returns MissingRequiredParameter error. EnvironmentName *string - - // The type of information to retrieve. - // - // This member is required. - InfoType types.EnvironmentInfoType } // Result message containing a description of the requested environment info. diff --git a/service/elasticbeanstalk/api_op_SwapEnvironmentCNAMEs.go b/service/elasticbeanstalk/api_op_SwapEnvironmentCNAMEs.go index 11910c476a5..10e73b1195b 100644 --- a/service/elasticbeanstalk/api_op_SwapEnvironmentCNAMEs.go +++ b/service/elasticbeanstalk/api_op_SwapEnvironmentCNAMEs.go @@ -56,11 +56,11 @@ func (c *Client) SwapEnvironmentCNAMEs(ctx context.Context, params *SwapEnvironm // Swaps the CNAMEs of two environments. type SwapEnvironmentCNAMEsInput struct { - // The ID of the source environment. Condition: You must specify at least the - // SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If - // you specify the SourceEnvironmentId, you must specify the + // The ID of the destination environment. Condition: You must specify at least the + // DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify + // both. You must specify the SourceEnvironmentId with the // DestinationEnvironmentId. - SourceEnvironmentId *string + DestinationEnvironmentId *string // The name of the destination environment. Condition: You must specify at least // the DestinationEnvironmentID or the DestinationEnvironmentName. You may also @@ -68,11 +68,11 @@ type SwapEnvironmentCNAMEsInput struct { // DestinationEnvironmentName. DestinationEnvironmentName *string - // The ID of the destination environment. Condition: You must specify at least the - // DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify - // both. You must specify the SourceEnvironmentId with the + // The ID of the source environment. Condition: You must specify at least the + // SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If + // you specify the SourceEnvironmentId, you must specify the // DestinationEnvironmentId. - DestinationEnvironmentId *string + SourceEnvironmentId *string // The name of the source environment. Condition: You must specify at least the // SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If diff --git a/service/elasticbeanstalk/api_op_TerminateEnvironment.go b/service/elasticbeanstalk/api_op_TerminateEnvironment.go index d135c4c9355..6904a4528b7 100644 --- a/service/elasticbeanstalk/api_op_TerminateEnvironment.go +++ b/service/elasticbeanstalk/api_op_TerminateEnvironment.go @@ -58,10 +58,6 @@ func (c *Client) TerminateEnvironment(ctx context.Context, params *TerminateEnvi // Request to terminate an environment. type TerminateEnvironmentInput struct { - // Terminates the target environment even if another environment in the same group - // is dependent on it. - ForceTerminate *bool - // The ID of the environment to terminate. Condition: You must specify either this // or an EnvironmentName, or both. If you do not specify either, AWS Elastic // Beanstalk returns MissingRequiredParameter error. @@ -72,6 +68,10 @@ type TerminateEnvironmentInput struct { // Beanstalk returns MissingRequiredParameter error. EnvironmentName *string + // Terminates the target environment even if another environment in the same group + // is dependent on it. + ForceTerminate *bool + // Indicates whether the associated AWS resources should shut down when the // environment is terminated: // @@ -92,69 +92,42 @@ type TerminateEnvironmentInput struct { // Describes the properties of an environment. type TerminateEnvironmentOutput struct { - // A list of links to other environments in the same group. - EnvironmentLinks []*types.EnvironmentLink - - // Returns the health status of the application running in your environment. For - // more information, see Health Colors and Statuses - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html). - HealthStatus types.EnvironmentHealthStatus - - // For load-balanced, autoscaling environments, the URL to the LoadBalancer. For - // single-instance environments, the IP address of the instance. - EndpointURL *string - - // The ARN of the platform version. - PlatformArn *string - - // The ID of this environment. - EnvironmentId *string - - // The name of the application associated with this environment. - ApplicationName *string - // Indicates if there is an in-progress environment configuration update or // application version deployment that you can cancel. true: There is an update in // progress. false: There are no updates currently in progress. AbortableOperationInProgress *bool - // The creation date for this environment. - DateCreated *time.Time - - // The Amazon Resource Name (ARN) of the environment's operations role. For more - // information, see Operations roles - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html) - // in the AWS Elastic Beanstalk Developer Guide. - OperationsRole *string - - // Describes the current tier of this environment. - Tier *types.EnvironmentTier + // The name of the application associated with this environment. + ApplicationName *string // The URL to the CNAME for this environment. CNAME *string + // The creation date for this environment. + DateCreated *time.Time + + // The last modified date for this environment. + DateUpdated *time.Time + // Describes this environment. Description *string - // The name of the SolutionStack deployed with this environment. - SolutionStackName *string - - // The current operational status of the environment:

    • - // Launching: Environment is in the process of initial deployment.

      - //

    • Updating: Environment is in the process of updating - // its configuration settings or application version.

    • - // Ready: Environment is available to have an action performed on it, - // such as update or terminate.

    • Terminating: - // Environment is in the shut-down process.

    • - // Terminated: Environment is not running.

    - Status types.EnvironmentStatus + // For load-balanced, autoscaling environments, the URL to the LoadBalancer. For + // single-instance environments, the IP address of the instance. + EndpointURL *string // The environment's Amazon Resource Name (ARN), which can be used in other API // requests that require an ARN. EnvironmentArn *string - // The last modified date for this environment. - DateUpdated *time.Time + // The ID of this environment. + EnvironmentId *string + + // A list of links to other environments in the same group. + EnvironmentLinks []*types.EnvironmentLink + + // The name of this environment. + EnvironmentName *string // Describes the health status of the environment. AWS Elastic Beanstalk indicates // the failure levels for a running environment: @@ -177,19 +150,46 @@ type TerminateEnvironmentOutput struct { // Default: Grey Health types.EnvironmentHealth - // The application version deployed in this environment. - VersionLabel *string + // Returns the health status of the application running in your environment. For + // more information, see Health Colors and Statuses + // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html). + HealthStatus types.EnvironmentHealthStatus - // The name of this environment. - EnvironmentName *string + // The Amazon Resource Name (ARN) of the environment's operations role. For more + // information, see Operations roles + // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html) + // in the AWS Elastic Beanstalk Developer Guide. + OperationsRole *string + + // The ARN of the platform version. + PlatformArn *string // The description of the AWS resources used by this environment. Resources *types.EnvironmentResourcesDescription + // The name of the SolutionStack deployed with this environment. + SolutionStackName *string + + // The current operational status of the environment:

    • + // Launching: Environment is in the process of initial deployment.

      + //

    • Updating: Environment is in the process of updating + // its configuration settings or application version.

    • + // Ready: Environment is available to have an action performed on it, + // such as update or terminate.

    • Terminating: + // Environment is in the shut-down process.

    • + // Terminated: Environment is not running.

    + Status types.EnvironmentStatus + // The name of the configuration template used to originally launch this // environment. TemplateName *string + // Describes the current tier of this environment. + Tier *types.EnvironmentTier + + // The application version deployed in this environment. + VersionLabel *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticbeanstalk/api_op_UpdateApplication.go b/service/elasticbeanstalk/api_op_UpdateApplication.go index 19768a87457..4fcc71a2bb1 100644 --- a/service/elasticbeanstalk/api_op_UpdateApplication.go +++ b/service/elasticbeanstalk/api_op_UpdateApplication.go @@ -60,15 +60,15 @@ func (c *Client) UpdateApplication(ctx context.Context, params *UpdateApplicatio // Request to update an application. type UpdateApplicationInput struct { - // A new description for the application. Default: If not specified, AWS Elastic - // Beanstalk does not update the description. - Description *string - // The name of the application to update. If no such application is found, // UpdateApplication returns an InvalidParameterValue error. // // This member is required. ApplicationName *string + + // A new description for the application. Default: If not specified, AWS Elastic + // Beanstalk does not update the description. + Description *string } // Result message containing a single description of an application. diff --git a/service/elasticbeanstalk/api_op_UpdateApplicationResourceLifecycle.go b/service/elasticbeanstalk/api_op_UpdateApplicationResourceLifecycle.go index 345b1e4cecf..4d2cccbd3be 100644 --- a/service/elasticbeanstalk/api_op_UpdateApplicationResourceLifecycle.go +++ b/service/elasticbeanstalk/api_op_UpdateApplicationResourceLifecycle.go @@ -57,15 +57,15 @@ func (c *Client) UpdateApplicationResourceLifecycle(ctx context.Context, params type UpdateApplicationResourceLifecycleInput struct { - // The lifecycle configuration. + // The name of the application. // // This member is required. - ResourceLifecycleConfig *types.ApplicationResourceLifecycleConfig + ApplicationName *string - // The name of the application. + // The lifecycle configuration. // // This member is required. - ApplicationName *string + ResourceLifecycleConfig *types.ApplicationResourceLifecycleConfig } type UpdateApplicationResourceLifecycleOutput struct { diff --git a/service/elasticbeanstalk/api_op_UpdateApplicationVersion.go b/service/elasticbeanstalk/api_op_UpdateApplicationVersion.go index a11cfb2dff4..4c1b56a7e39 100644 --- a/service/elasticbeanstalk/api_op_UpdateApplicationVersion.go +++ b/service/elasticbeanstalk/api_op_UpdateApplicationVersion.go @@ -60,9 +60,6 @@ func (c *Client) UpdateApplicationVersion(ctx context.Context, params *UpdateApp // type UpdateApplicationVersionInput struct { - // A new description for this version. - Description *string - // The name of the application associated with this version. If no application is // found with this name, UpdateApplication returns an InvalidParameterValue error. // @@ -74,6 +71,9 @@ type UpdateApplicationVersionInput struct { // // This member is required. VersionLabel *string + + // A new description for this version. + Description *string } // Result message wrapping a single description of an application version. diff --git a/service/elasticbeanstalk/api_op_UpdateConfigurationTemplate.go b/service/elasticbeanstalk/api_op_UpdateConfigurationTemplate.go index 6fa5cc9b8bd..18e9d0aa872 100644 --- a/service/elasticbeanstalk/api_op_UpdateConfigurationTemplate.go +++ b/service/elasticbeanstalk/api_op_UpdateConfigurationTemplate.go @@ -64,14 +64,6 @@ func (c *Client) UpdateConfigurationTemplate(ctx context.Context, params *Update // The result message containing the options for the specified solution stack. type UpdateConfigurationTemplateInput struct { - // A list of configuration option settings to update with the new specified option - // value. - OptionSettings []*types.ConfigurationOptionSetting - - // A list of configuration options to remove from the configuration set. - // Constraint: You can remove only UserDefined configuration options. - OptionsToRemove []*types.OptionSpecification - // The name of the application associated with the configuration template to // update. If no application is found with this name, UpdateConfigurationTemplate // returns an InvalidParameterValue error. @@ -88,6 +80,14 @@ type UpdateConfigurationTemplateInput struct { // A new description for the configuration. Description *string + + // A list of configuration option settings to update with the new specified option + // value. + OptionSettings []*types.ConfigurationOptionSetting + + // A list of configuration options to remove from the configuration set. + // Constraint: You can remove only UserDefined configuration options. + OptionsToRemove []*types.OptionSpecification } // Describes the settings for a configuration set. @@ -96,26 +96,11 @@ type UpdateConfigurationTemplateOutput struct { // The name of the application associated with this configuration set. ApplicationName *string - // If not null, the name of the environment for this configuration set. - EnvironmentName *string - - // The ARN of the platform version. - PlatformArn *string - - // The date (in UTC time) when this configuration set was last modified. - DateUpdated *time.Time - // The date (in UTC time) when this configuration set was created. DateCreated *time.Time - // The name of the solution stack this configuration set uses. - SolutionStackName *string - - // Describes this configuration set. - Description *string - - // A list of the configuration options and their values in this configuration set. - OptionSettings []*types.ConfigurationOptionSetting + // The date (in UTC time) when this configuration set was last modified. + DateUpdated *time.Time // If this configuration set is associated with an environment, the // DeploymentStatus parameter indicates the deployment status of this configuration @@ -135,6 +120,21 @@ type UpdateConfigurationTemplateOutput struct { // successfully deploy. DeploymentStatus types.ConfigurationDeploymentStatus + // Describes this configuration set. + Description *string + + // If not null, the name of the environment for this configuration set. + EnvironmentName *string + + // A list of the configuration options and their values in this configuration set. + OptionSettings []*types.ConfigurationOptionSetting + + // The ARN of the platform version. + PlatformArn *string + + // The name of the solution stack this configuration set uses. + SolutionStackName *string + // If not null, the name of the configuration template for this configuration set. TemplateName *string diff --git a/service/elasticbeanstalk/api_op_UpdateEnvironment.go b/service/elasticbeanstalk/api_op_UpdateEnvironment.go index 5d4c2b58c11..80418b48a81 100644 --- a/service/elasticbeanstalk/api_op_UpdateEnvironment.go +++ b/service/elasticbeanstalk/api_op_UpdateEnvironment.go @@ -66,25 +66,24 @@ func (c *Client) UpdateEnvironment(ctx context.Context, params *UpdateEnvironmen // Request to update an environment. type UpdateEnvironmentInput struct { - // A list of custom user-defined configuration options to remove from the - // configuration set for this environment. - OptionsToRemove []*types.OptionSpecification - - // If this parameter is specified, AWS Elastic Beanstalk deploys this configuration - // template to the environment. If no such configuration template is found, AWS - // Elastic Beanstalk returns an InvalidParameterValue error. - TemplateName *string - - // If specified, AWS Elastic Beanstalk updates the configuration set associated - // with the running environment and sets the specified configuration options to the - // requested value. - OptionSettings []*types.ConfigurationOptionSetting - // The name of the application with which the environment is associated. ApplicationName *string - // The ARN of the platform, if used. - PlatformArn *string + // If this parameter is specified, AWS Elastic Beanstalk updates the description of + // this environment. + Description *string + + // The ID of the environment to update. If no environment with this ID exists, AWS + // Elastic Beanstalk returns an InvalidParameterValue error. Condition: You must + // specify either this or an EnvironmentName, or both. If you do not specify + // either, AWS Elastic Beanstalk returns MissingRequiredParameter error. + EnvironmentId *string + + // The name of the environment to update. If no environment with this name exists, + // AWS Elastic Beanstalk returns an InvalidParameterValue error. Condition: You + // must specify either this or an EnvironmentId, or both. If you do not specify + // either, AWS Elastic Beanstalk returns MissingRequiredParameter error. + EnvironmentName *string // The name of the group to which the target environment belongs. Specify a group // name only if the environment's name is specified in an environment manifest and @@ -94,103 +93,77 @@ type UpdateEnvironmentInput struct { // for details. GroupName *string - // If this parameter is specified, AWS Elastic Beanstalk deploys the named - // application version to the environment. If no such application version is found, - // returns an InvalidParameterValue error. - VersionLabel *string + // If specified, AWS Elastic Beanstalk updates the configuration set associated + // with the running environment and sets the specified configuration options to the + // requested value. + OptionSettings []*types.ConfigurationOptionSetting - // The name of the environment to update. If no environment with this name exists, - // AWS Elastic Beanstalk returns an InvalidParameterValue error. Condition: You - // must specify either this or an EnvironmentId, or both. If you do not specify - // either, AWS Elastic Beanstalk returns MissingRequiredParameter error. - EnvironmentName *string + // A list of custom user-defined configuration options to remove from the + // configuration set for this environment. + OptionsToRemove []*types.OptionSpecification - // The ID of the environment to update. If no environment with this ID exists, AWS - // Elastic Beanstalk returns an InvalidParameterValue error. Condition: You must - // specify either this or an EnvironmentName, or both. If you do not specify - // either, AWS Elastic Beanstalk returns MissingRequiredParameter error. - EnvironmentId *string + // The ARN of the platform, if used. + PlatformArn *string + + // This specifies the platform version that the environment will run after the + // environment is updated. + SolutionStackName *string + + // If this parameter is specified, AWS Elastic Beanstalk deploys this configuration + // template to the environment. If no such configuration template is found, AWS + // Elastic Beanstalk returns an InvalidParameterValue error. + TemplateName *string // This specifies the tier to use to update the environment. Condition: At this // time, if you change the tier version, name, or type, AWS Elastic Beanstalk // returns InvalidParameterValue error. Tier *types.EnvironmentTier - // If this parameter is specified, AWS Elastic Beanstalk updates the description of - // this environment. - Description *string - - // This specifies the platform version that the environment will run after the - // environment is updated. - SolutionStackName *string + // If this parameter is specified, AWS Elastic Beanstalk deploys the named + // application version to the environment. If no such application version is found, + // returns an InvalidParameterValue error. + VersionLabel *string } // Describes the properties of an environment. type UpdateEnvironmentOutput struct { - // A list of links to other environments in the same group. - EnvironmentLinks []*types.EnvironmentLink - - // Returns the health status of the application running in your environment. For - // more information, see Health Colors and Statuses - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html). - HealthStatus types.EnvironmentHealthStatus - - // For load-balanced, autoscaling environments, the URL to the LoadBalancer. For - // single-instance environments, the IP address of the instance. - EndpointURL *string - - // The ARN of the platform version. - PlatformArn *string - - // The ID of this environment. - EnvironmentId *string - - // The name of the application associated with this environment. - ApplicationName *string - // Indicates if there is an in-progress environment configuration update or // application version deployment that you can cancel. true: There is an update in // progress. false: There are no updates currently in progress. AbortableOperationInProgress *bool - // The creation date for this environment. - DateCreated *time.Time - - // The Amazon Resource Name (ARN) of the environment's operations role. For more - // information, see Operations roles - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html) - // in the AWS Elastic Beanstalk Developer Guide. - OperationsRole *string - - // Describes the current tier of this environment. - Tier *types.EnvironmentTier + // The name of the application associated with this environment. + ApplicationName *string // The URL to the CNAME for this environment. CNAME *string + // The creation date for this environment. + DateCreated *time.Time + + // The last modified date for this environment. + DateUpdated *time.Time + // Describes this environment. Description *string - // The name of the SolutionStack deployed with this environment. - SolutionStackName *string - - // The current operational status of the environment:

    • - // Launching: Environment is in the process of initial deployment.

      - //

    • Updating: Environment is in the process of updating - // its configuration settings or application version.

    • - // Ready: Environment is available to have an action performed on it, - // such as update or terminate.

    • Terminating: - // Environment is in the shut-down process.

    • - // Terminated: Environment is not running.

    - Status types.EnvironmentStatus + // For load-balanced, autoscaling environments, the URL to the LoadBalancer. For + // single-instance environments, the IP address of the instance. + EndpointURL *string // The environment's Amazon Resource Name (ARN), which can be used in other API // requests that require an ARN. EnvironmentArn *string - // The last modified date for this environment. - DateUpdated *time.Time + // The ID of this environment. + EnvironmentId *string + + // A list of links to other environments in the same group. + EnvironmentLinks []*types.EnvironmentLink + + // The name of this environment. + EnvironmentName *string // Describes the health status of the environment. AWS Elastic Beanstalk indicates // the failure levels for a running environment: @@ -213,19 +186,46 @@ type UpdateEnvironmentOutput struct { // Default: Grey Health types.EnvironmentHealth - // The application version deployed in this environment. - VersionLabel *string + // Returns the health status of the application running in your environment. For + // more information, see Health Colors and Statuses + // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html). + HealthStatus types.EnvironmentHealthStatus - // The name of this environment. - EnvironmentName *string + // The Amazon Resource Name (ARN) of the environment's operations role. For more + // information, see Operations roles + // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html) + // in the AWS Elastic Beanstalk Developer Guide. + OperationsRole *string + + // The ARN of the platform version. + PlatformArn *string // The description of the AWS resources used by this environment. Resources *types.EnvironmentResourcesDescription + // The name of the SolutionStack deployed with this environment. + SolutionStackName *string + + // The current operational status of the environment:

    • + // Launching: Environment is in the process of initial deployment.

      + //

    • Updating: Environment is in the process of updating + // its configuration settings or application version.

    • + // Ready: Environment is available to have an action performed on it, + // such as update or terminate.

    • Terminating: + // Environment is in the shut-down process.

    • + // Terminated: Environment is not running.

    + Status types.EnvironmentStatus + // The name of the configuration template used to originally launch this // environment. TemplateName *string + // Describes the current tier of this environment. + Tier *types.EnvironmentTier + + // The application version deployed in this environment. + VersionLabel *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticbeanstalk/api_op_UpdateTagsForResource.go b/service/elasticbeanstalk/api_op_UpdateTagsForResource.go index 4b6eb8f379f..b2397c0dd5a 100644 --- a/service/elasticbeanstalk/api_op_UpdateTagsForResource.go +++ b/service/elasticbeanstalk/api_op_UpdateTagsForResource.go @@ -69,6 +69,12 @@ func (c *Client) UpdateTagsForResource(ctx context.Context, params *UpdateTagsFo type UpdateTagsForResourceInput struct { + // The Amazon Resource Name (ARN) of the resouce to be updated. Must be the ARN of + // an Elastic Beanstalk resource. + // + // This member is required. + ResourceArn *string + // A list of tags to add or update. If a key of an existing tag is added, the tag's // value is updated. Specify at least one of these parameters: TagsToAdd, // TagsToRemove. @@ -77,12 +83,6 @@ type UpdateTagsForResourceInput struct { // A list of tag keys to remove. If a tag key doesn't exist, it is silently // ignored. Specify at least one of these parameters: TagsToAdd, TagsToRemove. TagsToRemove []*string - - // The Amazon Resource Name (ARN) of the resouce to be updated. Must be the ARN of - // an Elastic Beanstalk resource. - // - // This member is required. - ResourceArn *string } type UpdateTagsForResourceOutput struct { diff --git a/service/elasticbeanstalk/api_op_ValidateConfigurationSettings.go b/service/elasticbeanstalk/api_op_ValidateConfigurationSettings.go index fcdee8441b3..5e8abdec5ad 100644 --- a/service/elasticbeanstalk/api_op_ValidateConfigurationSettings.go +++ b/service/elasticbeanstalk/api_op_ValidateConfigurationSettings.go @@ -61,14 +61,6 @@ func (c *Client) ValidateConfigurationSettings(ctx context.Context, params *Vali // A list of validation messages for a specified configuration template. type ValidateConfigurationSettingsInput struct { - // The name of the environment to validate the settings against. Condition: You - // cannot specify both this and a configuration template name. - EnvironmentName *string - - // The name of the configuration template to validate the settings against. - // Condition: You cannot specify both this and an environment name. - TemplateName *string - // The name of the application that the configuration template or environment // belongs to. // @@ -79,6 +71,14 @@ type ValidateConfigurationSettingsInput struct { // // This member is required. OptionSettings []*types.ConfigurationOptionSetting + + // The name of the environment to validate the settings against. Condition: You + // cannot specify both this and a configuration template name. + EnvironmentName *string + + // The name of the configuration template to validate the settings against. + // Condition: You cannot specify both this and an environment name. + TemplateName *string } // Provides a list of validation messages. diff --git a/service/elasticbeanstalk/go.mod b/service/elasticbeanstalk/go.mod index 4b625e0007c..5fb7d9516a8 100644 --- a/service/elasticbeanstalk/go.mod +++ b/service/elasticbeanstalk/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/elasticbeanstalk go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/elasticbeanstalk/types/types.go b/service/elasticbeanstalk/types/types.go index 40646592ff5..22f222ede69 100644 --- a/service/elasticbeanstalk/types/types.go +++ b/service/elasticbeanstalk/types/types.go @@ -9,50 +9,50 @@ import ( // Describes the properties of an application. type ApplicationDescription struct { + // The Amazon Resource Name (ARN) of the application. + ApplicationArn *string + // The name of the application. ApplicationName *string - // The lifecycle settings for the application. - ResourceLifecycleConfig *ApplicationResourceLifecycleConfig - - // The names of the versions for this application. - Versions []*string + // The names of the configuration templates associated with this application. + ConfigurationTemplates []*string // The date when the application was created. DateCreated *time.Time - // The Amazon Resource Name (ARN) of the application. - ApplicationArn *string - // The date when the application was last modified. DateUpdated *time.Time // User-defined description of the application. Description *string - // The names of the configuration templates associated with this application. - ConfigurationTemplates []*string + // The lifecycle settings for the application. + ResourceLifecycleConfig *ApplicationResourceLifecycleConfig + + // The names of the versions for this application. + Versions []*string } // Application request metrics for an AWS Elastic Beanstalk environment. type ApplicationMetrics struct { - // Represents the average latency for the slowest X percent of requests over the - // last 10 seconds. Latencies are in seconds with one millisecond resolution. - Latency *Latency - - // Represents the percentage of requests over the last 10 seconds that resulted in - // each type of status code response. - StatusCodes *StatusCodes - // The amount of time that the metrics cover (usually 10 seconds). For example, you // might have 5 requests (request_count) within the most recent time slice of 10 // seconds (duration). Duration *int32 + // Represents the average latency for the slowest X percent of requests over the + // last 10 seconds. Latencies are in seconds with one millisecond resolution. + Latency *Latency + // Average number of requests handled by the web server per second over the last 10 // seconds. RequestCount *int32 + + // Represents the percentage of requests over the last 10 seconds that resulted in + // each type of status code response. + StatusCodes *StatusCodes } // The resource lifecycle configuration for an application. Defines lifecycle @@ -78,34 +78,31 @@ type ApplicationResourceLifecycleConfig struct { // Describes the properties of an application version. type ApplicationVersionDescription struct { - // The storage location of the application version's source bundle in Amazon S3. - SourceBundle *S3Location - // The name of the application to which the application version belongs. ApplicationName *string - // A unique identifier for the application version. - VersionLabel *string + // The Amazon Resource Name (ARN) of the application version. + ApplicationVersionArn *string + + // Reference to the artifact from the AWS CodeBuild build. + BuildArn *string // The creation date of the application version. DateCreated *time.Time - // The Amazon Resource Name (ARN) of the application version. - ApplicationVersionArn *string - // The last modified date of the application version. DateUpdated *time.Time // The description of the application version. Description *string - // Reference to the artifact from the AWS CodeBuild build. - BuildArn *string - // If the version's source code was retrieved from AWS CodeCommit, the location of // the source code for the application version. SourceBuildInformation *SourceBuildInformation + // The storage location of the application version's source bundle in Amazon S3. + SourceBundle *S3Location + // The processing status of the application version. Reflects the state of the // application version during its creation. Many of the values are only applicable // if you specified True for the Process parameter of the CreateApplicationVersion @@ -129,6 +126,9 @@ type ApplicationVersionDescription struct { // CodeBuild build failed or configuration files didn't pass validation. This // application version isn't usable. Status ApplicationVersionStatus + + // A unique identifier for the application version. + VersionLabel *string } // The application version lifecycle settings for an application. Defines the rules @@ -139,13 +139,13 @@ type ApplicationVersionDescription struct { // the rule to delete it. type ApplicationVersionLifecycleConfig struct { - // Specify a max count rule to restrict the number of application versions that are - // retained for an application. - MaxCountRule *MaxCountRule - // Specify a max age rule to restrict the length of time that application versions // are retained for an application. MaxAgeRule *MaxAgeRule + + // Specify a max count rule to restrict the number of application versions that are + // retained for an application. + MaxCountRule *MaxCountRule } // Describes an Auto Scaling launch configuration. @@ -158,23 +158,6 @@ type AutoScalingGroup struct { // Settings for an AWS CodeBuild build. type BuildConfiguration struct { - // How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until - // timing out any related build that does not get marked as completed. The default - // is 60 minutes. - TimeoutInMinutes *int32 - - // Information about the compute resources the build project will use. - // - // * - // BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds - // - // * - // BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds - // - // * - // BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds - ComputeType ComputeType - // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) // role that enables AWS CodeBuild to interact with dependent AWS services on // behalf of the AWS account. @@ -193,6 +176,23 @@ type BuildConfiguration struct { // If not provided, Elastic Beanstalk stores the build artifact in the S3 location // S3-bucket/resources/application-name/codebuild/codebuild-version-label.zip. ArtifactName *string + + // Information about the compute resources the build project will use. + // + // * + // BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds + // + // * + // BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds + // + // * + // BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds + ComputeType ComputeType + + // How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until + // timing out any related build that does not get marked as completed. The default + // is 60 minutes. + TimeoutInMinutes *int32 } // The builder used to build the custom platform. @@ -221,8 +221,30 @@ type ConfigurationOptionDescription struct { // running Amazon EC2 instances are restarted. ChangeSeverity *string - // If specified, values for the configuration option are selected from this list. - ValueOptions []*string + // The default value for this configuration option. + DefaultValue *string + + // If specified, the configuration option must be a string value no longer than + // this value. + MaxLength *int32 + + // If specified, the configuration option must be a numeric value less than this + // value. + MaxValue *int32 + + // If specified, the configuration option must be a numeric value greater than this + // value. + MinValue *int32 + + // The name of the configuration option. + Name *string + + // A unique namespace identifying the option's associated AWS resource. + Namespace *string + + // If specified, the configuration option must be a string value that satisfies + // this regular expression. + Regex *OptionRestrictionRegex // An indication of whether the user defined this configuration option: // @@ -238,6 +260,9 @@ type ConfigurationOptionDescription struct { // Valid Values: true | false UserDefined *bool + // If specified, values for the configuration option are selected from this list. + ValueOptions []*string + // An indication of which type of values this option has and whether it is // allowable to select one or more than one of the possible values: // @@ -255,31 +280,6 @@ type ConfigurationOptionDescription struct { // * Json : Values for this option are a JSON representation of a // ConfigDocument. ValueType ConfigurationOptionValueType - - // The default value for this configuration option. - DefaultValue *string - - // If specified, the configuration option must be a numeric value greater than this - // value. - MinValue *int32 - - // A unique namespace identifying the option's associated AWS resource. - Namespace *string - - // The name of the configuration option. - Name *string - - // If specified, the configuration option must be a string value no longer than - // this value. - MaxLength *int32 - - // If specified, the configuration option must be a numeric value less than this - // value. - MaxValue *int32 - - // If specified, the configuration option must be a string value that satisfies - // this regular expression. - Regex *OptionRestrictionRegex } // A specification identifying an individual configuration option along with its @@ -289,18 +289,18 @@ type ConfigurationOptionDescription struct { // the AWS Elastic Beanstalk Developer Guide. type ConfigurationOptionSetting struct { + // A unique namespace that identifies the option's associated AWS resource. + Namespace *string + // The name of the configuration option. OptionName *string - // The current value for the configuration option. - Value *string - // A unique resource name for the option setting. Use it for a time–based scaling // configuration option. ResourceName *string - // A unique namespace that identifies the option's associated AWS resource. - Namespace *string + // The current value for the configuration option. + Value *string } // Describes the settings for a configuration set. @@ -309,26 +309,11 @@ type ConfigurationSettingsDescription struct { // The name of the application associated with this configuration set. ApplicationName *string - // If not null, the name of the environment for this configuration set. - EnvironmentName *string - - // The ARN of the platform version. - PlatformArn *string - - // The date (in UTC time) when this configuration set was last modified. - DateUpdated *time.Time - // The date (in UTC time) when this configuration set was created. DateCreated *time.Time - // The name of the solution stack this configuration set uses. - SolutionStackName *string - - // Describes this configuration set. - Description *string - - // A list of the configuration options and their values in this configuration set. - OptionSettings []*ConfigurationOptionSetting + // The date (in UTC time) when this configuration set was last modified. + DateUpdated *time.Time // If this configuration set is associated with an environment, the // DeploymentStatus parameter indicates the deployment status of this configuration @@ -348,6 +333,21 @@ type ConfigurationSettingsDescription struct { // successfully deploy. DeploymentStatus ConfigurationDeploymentStatus + // Describes this configuration set. + Description *string + + // If not null, the name of the environment for this configuration set. + EnvironmentName *string + + // A list of the configuration options and their values in this configuration set. + OptionSettings []*ConfigurationOptionSetting + + // The ARN of the platform version. + PlatformArn *string + + // The name of the solution stack this configuration set uses. + SolutionStackName *string + // If not null, the name of the configuration template for this configuration set. TemplateName *string } @@ -355,25 +355,17 @@ type ConfigurationSettingsDescription struct { // CPU utilization metrics for an instance. type CPUUtilization struct { - // Percentage of time that the CPU has spent in the Idle state over the last 10 - // seconds. - Idle *float64 - - // Percentage of time that the CPU has spent in the User state over the last 10 - // seconds. - User *float64 - // Available on Linux environments only. Percentage of time that the CPU has spent - // in the System state over the last 10 seconds. - System *float64 + // in the I/O Wait state over the last 10 seconds. + IOWait *float64 // Available on Linux environments only. Percentage of time that the CPU has spent - // in the SoftIRQ state over the last 10 seconds. - SoftIRQ *float64 + // in the IRQ state over the last 10 seconds. + IRQ *float64 - // Available on Linux environments only. Percentage of time that the CPU has spent - // in the I/O Wait state over the last 10 seconds. - IOWait *float64 + // Percentage of time that the CPU has spent in the Idle state over the last 10 + // seconds. + Idle *float64 // Available on Linux environments only. Percentage of time that the CPU has spent // in the Nice state over the last 10 seconds. @@ -384,8 +376,16 @@ type CPUUtilization struct { Privileged *float64 // Available on Linux environments only. Percentage of time that the CPU has spent - // in the IRQ state over the last 10 seconds. - IRQ *float64 + // in the SoftIRQ state over the last 10 seconds. + SoftIRQ *float64 + + // Available on Linux environments only. Percentage of time that the CPU has spent + // in the System state over the last 10 seconds. + System *float64 + + // Percentage of time that the CPU has spent in the User state over the last 10 + // seconds. + User *float64 } // A custom AMI available to platforms. @@ -405,6 +405,10 @@ type Deployment struct { // source code or change instance configuration settings. DeploymentId *int64 + // For in-progress deployments, the time that the deployment started. For completed + // deployments, the time that the deployment ended. + DeploymentTime *time.Time + // The status of the deployment: // // * In Progress : The deployment is in @@ -418,78 +422,47 @@ type Deployment struct { // The version label of the application version in the deployment. VersionLabel *string - - // For in-progress deployments, the time that the deployment started. For completed - // deployments, the time that the deployment ended. - DeploymentTime *time.Time } // Describes the properties of an environment. type EnvironmentDescription struct { - // A list of links to other environments in the same group. - EnvironmentLinks []*EnvironmentLink - - // Returns the health status of the application running in your environment. For - // more information, see Health Colors and Statuses - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html). - HealthStatus EnvironmentHealthStatus + // Indicates if there is an in-progress environment configuration update or + // application version deployment that you can cancel. true: There is an update in + // progress. false: There are no updates currently in progress. + AbortableOperationInProgress *bool - // For load-balanced, autoscaling environments, the URL to the LoadBalancer. For - // single-instance environments, the IP address of the instance. - EndpointURL *string + // The name of the application associated with this environment. + ApplicationName *string - // The ARN of the platform version. - PlatformArn *string - - // The ID of this environment. - EnvironmentId *string - - // The name of the application associated with this environment. - ApplicationName *string - - // Indicates if there is an in-progress environment configuration update or - // application version deployment that you can cancel. true: There is an update in - // progress. false: There are no updates currently in progress. - AbortableOperationInProgress *bool + // The URL to the CNAME for this environment. + CNAME *string // The creation date for this environment. DateCreated *time.Time - // The Amazon Resource Name (ARN) of the environment's operations role. For more - // information, see Operations roles - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html) - // in the AWS Elastic Beanstalk Developer Guide. - OperationsRole *string - - // Describes the current tier of this environment. - Tier *EnvironmentTier - - // The URL to the CNAME for this environment. - CNAME *string + // The last modified date for this environment. + DateUpdated *time.Time // Describes this environment. Description *string - // The name of the SolutionStack deployed with this environment. - SolutionStackName *string - - // The current operational status of the environment:

    • - // Launching: Environment is in the process of initial deployment.

      - //

    • Updating: Environment is in the process of updating - // its configuration settings or application version.

    • - // Ready: Environment is available to have an action performed on it, - // such as update or terminate.

    • Terminating: - // Environment is in the shut-down process.

    • - // Terminated: Environment is not running.

    - Status EnvironmentStatus + // For load-balanced, autoscaling environments, the URL to the LoadBalancer. For + // single-instance environments, the IP address of the instance. + EndpointURL *string // The environment's Amazon Resource Name (ARN), which can be used in other API // requests that require an ARN. EnvironmentArn *string - // The last modified date for this environment. - DateUpdated *time.Time + // The ID of this environment. + EnvironmentId *string + + // A list of links to other environments in the same group. + EnvironmentLinks []*EnvironmentLink + + // The name of this environment. + EnvironmentName *string // Describes the health status of the environment. AWS Elastic Beanstalk indicates // the failure levels for a running environment: @@ -512,23 +485,53 @@ type EnvironmentDescription struct { // Default: Grey Health EnvironmentHealth - // The application version deployed in this environment. - VersionLabel *string + // Returns the health status of the application running in your environment. For + // more information, see Health Colors and Statuses + // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html). + HealthStatus EnvironmentHealthStatus - // The name of this environment. - EnvironmentName *string + // The Amazon Resource Name (ARN) of the environment's operations role. For more + // information, see Operations roles + // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html) + // in the AWS Elastic Beanstalk Developer Guide. + OperationsRole *string + + // The ARN of the platform version. + PlatformArn *string // The description of the AWS resources used by this environment. Resources *EnvironmentResourcesDescription + // The name of the SolutionStack deployed with this environment. + SolutionStackName *string + + // The current operational status of the environment:

    • + // Launching: Environment is in the process of initial deployment.

      + //

    • Updating: Environment is in the process of updating + // its configuration settings or application version.

    • + // Ready: Environment is available to have an action performed on it, + // such as update or terminate.

    • Terminating: + // Environment is in the shut-down process.

    • + // Terminated: Environment is not running.

    + Status EnvironmentStatus + // The name of the configuration template used to originally launch this // environment. TemplateName *string + + // Describes the current tier of this environment. + Tier *EnvironmentTier + + // The application version deployed in this environment. + VersionLabel *string } // The information retrieved from the Amazon EC2 instances. type EnvironmentInfoDescription struct { + // The Amazon EC2 Instance ID for this information. + Ec2InstanceId *string + // The type of information retrieved. InfoType EnvironmentInfoType @@ -538,9 +541,6 @@ type EnvironmentInfoDescription struct { // parties. Message *string - // The Amazon EC2 Instance ID for this information. - Ec2InstanceId *string - // The time stamp when this information was retrieved. SampleTimestamp *time.Time } @@ -552,39 +552,39 @@ type EnvironmentInfoDescription struct { // for details. type EnvironmentLink struct { - // The name of the link. - LinkName *string - // The name of the linked environment (the dependency). EnvironmentName *string + + // The name of the link. + LinkName *string } // Describes the AWS resources in use by this environment. This data is live. type EnvironmentResourceDescription struct { - // The Auto Scaling launch configurations in use by this environment. - LaunchConfigurations []*LaunchConfiguration + // The AutoScalingGroups used by this environment. + AutoScalingGroups []*AutoScalingGroup + + // The name of the environment. + EnvironmentName *string // The Amazon EC2 instances used by this environment. Instances []*Instance + // The Auto Scaling launch configurations in use by this environment. + LaunchConfigurations []*LaunchConfiguration + // The Amazon EC2 launch templates in use by this environment. LaunchTemplates []*LaunchTemplate // The LoadBalancers in use by this environment. LoadBalancers []*LoadBalancer - // The AutoScaling triggers in use by this environment. - Triggers []*Trigger - // The queues used by this environment. Queues []*Queue - // The name of the environment. - EnvironmentName *string - - // The AutoScalingGroups used by this environment. - AutoScalingGroups []*AutoScalingGroup + // The AutoScaling triggers in use by this environment. + Triggers []*Trigger } // Describes the AWS resources in use by this environment. This data is not live @@ -606,12 +606,6 @@ type EnvironmentTier struct { // * For Worker tier – Worker Name *string - // The version of this environment tier. When you don't set a value to it, Elastic - // Beanstalk uses the latest compatible worker tier version. This member is - // deprecated. Any specific version that you set may become out of date. We - // recommend leaving it unspecified. - Version *string - // The type of this environment tier. Valid values: // // * For Web server tier – @@ -619,37 +613,43 @@ type EnvironmentTier struct { // // * For Worker tier – SQS/HTTP Type *string + + // The version of this environment tier. When you don't set a value to it, Elastic + // Beanstalk uses the latest compatible worker tier version. This member is + // deprecated. Any specific version that you set may become out of date. We + // recommend leaving it unspecified. + Version *string } // Describes an event. type EventDescription struct { - // The severity level of this event. - Severity EventSeverity - - // The event message. - Message *string + // The application associated with the event. + ApplicationName *string // The name of the environment associated with this event. EnvironmentName *string - // The web service request ID for the activity of this event. - RequestId *string + // The date when the event occurred. + EventDate *time.Time + + // The event message. + Message *string // The ARN of the platform version. PlatformArn *string - // The release label for the application version associated with this event. - VersionLabel *string - - // The application associated with the event. - ApplicationName *string + // The web service request ID for the activity of this event. + RequestId *string - // The date when the event occurred. - EventDate *time.Time + // The severity level of this event. + Severity EventSeverity // The name of the configuration associated with this event. TemplateName *string + + // The release label for the application version associated with this event. + VersionLabel *string } // The description of an Amazon EC2 instance. @@ -668,68 +668,68 @@ type InstanceHealthSummary struct { // issues for an instance or environment. Degraded *int32 - // Yellow. The health agent is reporting a moderate number of request failures or - // other issues for an instance or environment. - Warning *int32 + // Green. An operation is in progress on an instance. + Info *int32 + + // Grey. AWS Elastic Beanstalk and the health agent are reporting no data on an + // instance. + NoData *int32 // Green. An instance is passing health checks and the health agent is not // reporting any problems. Ok *int32 - // Grey. AWS Elastic Beanstalk and the health agent are reporting an insufficient - // amount of data on an instance. - Unknown *int32 + // Grey. An operation is in progress on an instance within the command timeout. + Pending *int32 // Red. The health agent is reporting a very high number of request failures or // other issues for an instance or environment. Severe *int32 - // Grey. An operation is in progress on an instance within the command timeout. - Pending *int32 - - // Green. An operation is in progress on an instance. - Info *int32 + // Grey. AWS Elastic Beanstalk and the health agent are reporting an insufficient + // amount of data on an instance. + Unknown *int32 - // Grey. AWS Elastic Beanstalk and the health agent are reporting no data on an - // instance. - NoData *int32 + // Yellow. The health agent is reporting a moderate number of request failures or + // other issues for an instance or environment. + Warning *int32 } // Represents the average latency for the slowest X percent of requests over the // last 10 seconds. type Latency struct { - // The average latency for the slowest 50 percent of requests over the last 10 - // seconds. - P50 *float64 - - // The average latency for the slowest 5 percent of requests over the last 10 - // seconds. - P95 *float64 - // The average latency for the slowest 90 percent of requests over the last 10 // seconds. P10 *float64 - // The average latency for the slowest 1 percent of requests over the last 10 + // The average latency for the slowest 50 percent of requests over the last 10 // seconds. - P99 *float64 + P50 *float64 + + // The average latency for the slowest 25 percent of requests over the last 10 + // seconds. + P75 *float64 // The average latency for the slowest 15 percent of requests over the last 10 // seconds. P85 *float64 - // The average latency for the slowest 0.1 percent of requests over the last 10 + // The average latency for the slowest 10 percent of requests over the last 10 // seconds. - P999 *float64 + P90 *float64 - // The average latency for the slowest 25 percent of requests over the last 10 + // The average latency for the slowest 5 percent of requests over the last 10 // seconds. - P75 *float64 + P95 *float64 - // The average latency for the slowest 10 percent of requests over the last 10 + // The average latency for the slowest 1 percent of requests over the last 10 // seconds. - P90 *float64 + P99 *float64 + + // The average latency for the slowest 0.1 percent of requests over the last 10 + // seconds. + P999 *float64 } // Describes an Auto Scaling launch configuration. @@ -749,11 +749,11 @@ type LaunchTemplate struct { // Describes the properties of a Listener for the LoadBalancer. type Listener struct { - // The protocol that is used by the Listener. - Protocol *string - // The port that is used by the Listener. Port *int32 + + // The protocol that is used by the Listener. + Protocol *string } // Describes a LoadBalancer. @@ -766,63 +766,63 @@ type LoadBalancer struct { // Describes the details of a LoadBalancer. type LoadBalancerDescription struct { + // The domain name of the LoadBalancer. + Domain *string + // A list of Listeners used by the LoadBalancer. Listeners []*Listener // The name of the LoadBalancer. LoadBalancerName *string - - // The domain name of the LoadBalancer. - Domain *string } // The record of an upcoming or in-progress managed action. type ManagedAction struct { + // A description of the managed action. + ActionDescription *string + // A unique identifier for the managed action. ActionId *string // The type of managed action. ActionType ActionType - // The start time of the maintenance window in which the managed action will - // execute. - WindowStartTime *time.Time - // The status of the managed action. If the action is Scheduled, you can apply it // immediately with ApplyEnvironmentManagedAction (). Status ActionStatus - // A description of the managed action. - ActionDescription *string + // The start time of the maintenance window in which the managed action will + // execute. + WindowStartTime *time.Time } // The record of a completed or failed managed action. type ManagedActionHistoryItem struct { - // If the action failed, the type of failure. - FailureType FailureType - - // The status of the action. - Status ActionHistoryStatus + // A description of the managed action. + ActionDescription *string // A unique identifier for the managed action. ActionId *string - // If the action failed, a description of the failure. - FailureDescription *string - - // The date and time that the action finished executing. - FinishedTime *time.Time - // The type of the managed action. ActionType ActionType // The date and time that the action started executing. ExecutedTime *time.Time - // A description of the managed action. - ActionDescription *string + // If the action failed, a description of the failure. + FailureDescription *string + + // If the action failed, the type of failure. + FailureType FailureType + + // The date and time that the action finished executing. + FinishedTime *time.Time + + // The status of the action. + Status ActionHistoryStatus } // A lifecycle rule that deletes application versions after the specified number of @@ -834,27 +834,27 @@ type MaxAgeRule struct { // This member is required. Enabled *bool - // Specify the number of days to retain an application versions. - MaxAgeInDays *int32 - // Set to true to delete a version's source bundle from Amazon S3 when Elastic // Beanstalk deletes the application version. DeleteSourceFromS3 *bool + + // Specify the number of days to retain an application versions. + MaxAgeInDays *int32 } // A lifecycle rule that deletes the oldest application version when the maximum // count is exceeded. type MaxCountRule struct { - // Set to true to delete a version's source bundle from Amazon S3 when Elastic - // Beanstalk deletes the application version. - DeleteSourceFromS3 *bool - // Specify true to apply the rule, or false to disable it. // // This member is required. Enabled *bool + // Set to true to delete a version's source bundle from Amazon S3 when Elastic + // Beanstalk deletes the application version. + DeleteSourceFromS3 *bool + // Specify the maximum number of application versions to retain. MaxCount *int32 } @@ -877,22 +877,18 @@ type OptionSpecification struct { // A unique namespace identifying the option's associated AWS resource. Namespace *string - // A unique resource name for a time-based scaling configuration option. - ResourceName *string - // The name of the configuration option. OptionName *string + + // A unique resource name for a time-based scaling configuration option. + ResourceName *string } // Summary information about a platform branch. type PlatformBranchSummary struct { - // The environment tiers that platform versions in this branch support. Possible - // values: WebServer/Standard | Worker/SQS/HTTP - SupportedTierList []*string - - // The name of the platform to which this platform branch belongs. - PlatformName *string + // The name of the platform branch. + BranchName *string // An ordinal number that designates the order in which platform branches have been // added to a platform. This can be helpful, for example, if your code calls the @@ -904,85 +900,99 @@ type PlatformBranchSummary struct { // supported | deprecated | retired LifecycleState *string - // The name of the platform branch. - BranchName *string + // The name of the platform to which this platform branch belongs. + PlatformName *string + + // The environment tiers that platform versions in this branch support. Possible + // values: WebServer/Standard | Worker/SQS/HTTP + SupportedTierList []*string } // Detailed information about a platform version. type PlatformDescription struct { - // The status of the platform version. - PlatformStatus PlatformStatus - - // The state of the platform version in its lifecycle. Possible values: Recommended - // | null If a null value is returned, the platform version isn't the recommended - // one for its branch. Each platform branch has a single recommended platform - // version, typically the most recent one. - PlatformLifecycleState *string + // The custom AMIs supported by the platform version. + CustomAmiList []*CustomAmi - // Information about the maintainer of the platform version. - Maintainer *string + // The date when the platform version was created. + DateCreated *time.Time - // The platform branch to which the platform version belongs. - PlatformBranchName *string + // The date when the platform version was last updated. + DateUpdated *time.Time - // The AWS account ID of the person who created the platform version. - PlatformOwner *string + // The description of the platform version. + Description *string // The frameworks supported by the platform version. Frameworks []*PlatformFramework + // Information about the maintainer of the platform version. + Maintainer *string + + // The operating system used by the platform version. + OperatingSystemName *string + // The version of the operating system used by the platform version. OperatingSystemVersion *string - // The tiers supported by the platform version. - SupportedTierList []*string - - // The name of the platform version. - PlatformName *string + // The ARN of the platform version. + PlatformArn *string - // The date when the platform version was created. - DateCreated *time.Time + // The state of the platform version's branch in its lifecycle. Possible values: + // Beta | Supported | Deprecated | Retired + PlatformBranchLifecycleState *string - // The custom AMIs supported by the platform version. - CustomAmiList []*CustomAmi + // The platform branch to which the platform version belongs. + PlatformBranchName *string - // The description of the platform version. - Description *string + // The category of the platform version. + PlatformCategory *string - // The version of the platform version. - PlatformVersion *string + // The state of the platform version in its lifecycle. Possible values: Recommended + // | null If a null value is returned, the platform version isn't the recommended + // one for its branch. Each platform branch has a single recommended platform + // version, typically the most recent one. + PlatformLifecycleState *string - // The ARN of the platform version. - PlatformArn *string + // The name of the platform version. + PlatformName *string - // The date when the platform version was last updated. - DateUpdated *time.Time + // The AWS account ID of the person who created the platform version. + PlatformOwner *string - // The operating system used by the platform version. - OperatingSystemName *string + // The status of the platform version. + PlatformStatus PlatformStatus - // The category of the platform version. - PlatformCategory *string + // The version of the platform version. + PlatformVersion *string // The programming languages supported by the platform version. ProgrammingLanguages []*PlatformProgrammingLanguage - // The state of the platform version's branch in its lifecycle. Possible values: - // Beta | Supported | Deprecated | Retired - PlatformBranchLifecycleState *string - // The name of the solution stack used by the platform version. SolutionStackName *string // The additions supported by the platform version. SupportedAddonList []*string + + // The tiers supported by the platform version. + SupportedTierList []*string } // Describes criteria to restrict the results when listing platform versions. The // filter is evaluated as follows: Type Operator Values[1] type PlatformFilter struct { + // The operator to apply to the Type with each of the Values. Valid values: = | != + // | < | <= | > | >= | contains | begins_with | ends_with + Operator *string + + // The platform version attribute to which the filter values are applied. Valid + // values: PlatformName | PlatformVersion | PlatformStatus | PlatformBranchName | + // PlatformLifecycleState | PlatformOwner | SupportedTier | SupportedAddon | + // ProgrammingLanguageName | OperatingSystemName + Type *string + // The list of values applied to the filtering platform version attribute. Only one // value is supported for all current operators. The following list shows valid // filter values for some filter attributes. @@ -998,16 +1008,6 @@ type PlatformFilter struct { // * SupportedAddon: // Log/S3 | Monitoring/Healthd | WorkerDaemon/SQSD Values []*string - - // The operator to apply to the Type with each of the Values. Valid values: = | != - // | < | <= | > | >= | contains | begins_with | ends_with - Operator *string - - // The platform version attribute to which the filter values are applied. Valid - // values: PlatformName | PlatformVersion | PlatformStatus | PlatformBranchName | - // PlatformLifecycleState | PlatformOwner | SupportedTier | SupportedAddon | - // ProgrammingLanguageName | OperatingSystemName - Type *string } // A framework supported by the platform. @@ -1033,18 +1033,24 @@ type PlatformProgrammingLanguage struct { // Summary information about a platform version. type PlatformSummary struct { - // The state of the platform version's branch in its lifecycle. Possible values: - // beta | supported | deprecated | retired - PlatformBranchLifecycleState *string + // The operating system used by the platform version. + OperatingSystemName *string // The version of the operating system used by the platform version. OperatingSystemVersion *string - // The additions associated with the platform version. - SupportedAddonList []*string + // The ARN of the platform version. + PlatformArn *string - // The tiers in which the platform version runs. - SupportedTierList []*string + // The state of the platform version's branch in its lifecycle. Possible values: + // beta | supported | deprecated | retired + PlatformBranchLifecycleState *string + + // The platform branch to which the platform version belongs. + PlatformBranchName *string + + // The category of platform version. + PlatformCategory *string // The state of the platform version in its lifecycle. Possible values: recommended // | empty If an empty value is returned, the platform version is supported but @@ -1054,9 +1060,6 @@ type PlatformSummary struct { // The AWS account ID of the person who created the platform version. PlatformOwner *string - // The platform branch to which the platform version belongs. - PlatformBranchName *string - // The status of the platform version. You can create an environment from the // platform version once it is ready. PlatformStatus PlatformStatus @@ -1064,14 +1067,11 @@ type PlatformSummary struct { // The version string of the platform version. PlatformVersion *string - // The operating system used by the platform version. - OperatingSystemName *string - - // The category of platform version. - PlatformCategory *string + // The additions associated with the platform version. + SupportedAddonList []*string - // The ARN of the platform version. - PlatformArn *string + // The tiers in which the platform version runs. + SupportedTierList []*string } // Describes a queue. @@ -1097,11 +1097,8 @@ type ResourceQuota struct { // account. They reflect Elastic Beanstalk resource limits for this account. type ResourceQuotas struct { - // The quota for environments in the AWS account. - EnvironmentQuota *ResourceQuota - - // The quota for custom platforms in the AWS account. - CustomPlatformQuota *ResourceQuota + // The quota for applications in the AWS account. + ApplicationQuota *ResourceQuota // The quota for application versions in the AWS account. ApplicationVersionQuota *ResourceQuota @@ -1109,8 +1106,11 @@ type ResourceQuotas struct { // The quota for configuration templates in the AWS account. ConfigurationTemplateQuota *ResourceQuota - // The quota for applications in the AWS account. - ApplicationQuota *ResourceQuota + // The quota for custom platforms in the AWS account. + CustomPlatformQuota *ResourceQuota + + // The quota for environments in the AWS account. + EnvironmentQuota *ResourceQuota } // The bucket and key of an item stored in Amazon S3. @@ -1134,6 +1134,10 @@ type S3Location struct { // parameter. type SearchFilter struct { + // The result attribute to which the filter values are applied. Valid values vary + // by API action. + Attribute *string + // The operator to apply to the Attribute with each of the Values. Valid values // vary by Attribute. Operator *string @@ -1141,33 +1145,18 @@ type SearchFilter struct { // The list of values applied to the Attribute and Operator attributes. Number of // values and valid values vary by Attribute. Values []*string - - // The result attribute to which the filter values are applied. Valid values vary - // by API action. - Attribute *string } // Detailed health information about an Amazon EC2 instance in your Elastic // Beanstalk environment. type SingleInstanceHealth struct { - // The ID of the Amazon EC2 instance. - InstanceId *string - - // The time at which the EC2 instance was launched. - LaunchedAt *time.Time - - // The instance's type. - InstanceType *string + // Request metrics from your application. + ApplicationMetrics *ApplicationMetrics // The availability zone in which the instance runs. AvailabilityZone *string - // Returns the health status of the specified instance. For more information, see - // Health Colors and Statuses - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html). - HealthStatus *string - // Represents the causes, which provide more information about the current health // status. Causes []*string @@ -1177,24 +1166,35 @@ type SingleInstanceHealth struct { // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html). Color *string - // Request metrics from your application. - ApplicationMetrics *ApplicationMetrics + // Information about the most recent deployment to an instance. + Deployment *Deployment + + // Returns the health status of the specified instance. For more information, see + // Health Colors and Statuses + // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html). + HealthStatus *string + + // The ID of the Amazon EC2 instance. + InstanceId *string + + // The instance's type. + InstanceType *string + + // The time at which the EC2 instance was launched. + LaunchedAt *time.Time // Operating system metrics from the instance. System *SystemStatus - - // Information about the most recent deployment to an instance. - Deployment *Deployment } // Describes the solution stack. type SolutionStackDescription struct { - // The name of the solution stack. - SolutionStackName *string - // The permitted file types allowed for a solution stack. PermittedFileTypes []*string + + // The name of the solution stack. + SolutionStackName *string } // Location of the source code for an application version. @@ -1214,33 +1214,33 @@ type SourceBuildInformation struct { // This member is required. SourceLocation *string - // The type of repository. + // Location where the repository is stored. // - // * Git + // * CodeCommit // - // * Zip + // * S3 // // This member is required. - SourceType SourceType + SourceRepository SourceRepository - // Location where the repository is stored. + // The type of repository. // - // * CodeCommit + // * Git // - // * S3 + // * Zip // // This member is required. - SourceRepository SourceRepository + SourceType SourceType } // A specification for an environment configuration. type SourceConfiguration struct { - // The name of the configuration template. - TemplateName *string - // The name of the application associated with the configuration. ApplicationName *string + + // The name of the configuration template. + TemplateName *string } // Represents the percentage of requests over the last 10 seconds that resulted in @@ -1252,14 +1252,14 @@ type StatusCodes struct { // 201, etc.) status code. Status2xx *int32 - // The percentage of requests over the last 10 seconds that resulted in a 4xx (400, - // 401, etc.) status code. - Status4xx *int32 - // The percentage of requests over the last 10 seconds that resulted in a 3xx (300, // 301, etc.) status code. Status3xx *int32 + // The percentage of requests over the last 10 seconds that resulted in a 4xx (400, + // 401, etc.) status code. + Status4xx *int32 + // The percentage of requests over the last 10 seconds that resulted in a 5xx (500, // 501, etc.) status code. Status5xx *int32 @@ -1268,23 +1268,23 @@ type StatusCodes struct { // CPU utilization and load average metrics for an Amazon EC2 instance. type SystemStatus struct { + // CPU utilization metrics for the instance. + CPUUtilization *CPUUtilization + // Load average in the last 1-minute, 5-minute, and 15-minute periods. For more // information, see Operating System Metrics // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-metrics.html#health-enhanced-metrics-os). LoadAverage []*float64 - - // CPU utilization metrics for the instance. - CPUUtilization *CPUUtilization } // Describes a tag applied to a resource in an environment. type Tag struct { - // The value of the tag. - Value *string - // The key of the tag. Key *string + + // The value of the tag. + Value *string } // Describes a trigger. @@ -1303,6 +1303,9 @@ type ValidationMessage struct { // The namespace to which the option belongs. Namespace *string + // The name of the option. + OptionName *string + // An indication of the severity of this message: // // * error: This message @@ -1311,7 +1314,4 @@ type ValidationMessage struct { // * warning: This // message is providing information you should take into account. Severity ValidationSeverity - - // The name of the option. - OptionName *string } diff --git a/service/elasticinference/api_op_DescribeAccelerators.go b/service/elasticinference/api_op_DescribeAccelerators.go index 74d4804b263..2936b0d9854 100644 --- a/service/elasticinference/api_op_DescribeAccelerators.go +++ b/service/elasticinference/api_op_DescribeAccelerators.go @@ -57,6 +57,9 @@ func (c *Client) DescribeAccelerators(ctx context.Context, params *DescribeAccel type DescribeAcceleratorsInput struct { + // The IDs of the accelerators to describe. + AcceleratorIds []*string + // One or more filters. Filter names and values are case-sensitive. Valid filter // names are: accelerator-types: can provide a list of accelerator type names to // filter for. instance-id: can provide a list of EC2 instance ids to filter for. @@ -72,9 +75,6 @@ type DescribeAcceleratorsInput struct { // A token to specify where to start paginating. This is the NextToken from a // previously truncated response. NextToken *string - - // The IDs of the accelerators to describe. - AcceleratorIds []*string } type DescribeAcceleratorsOutput struct { diff --git a/service/elasticinference/api_op_TagResource.go b/service/elasticinference/api_op_TagResource.go index 5d3f2aaed23..8e735fd40fa 100644 --- a/service/elasticinference/api_op_TagResource.go +++ b/service/elasticinference/api_op_TagResource.go @@ -56,15 +56,15 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The tags to add to the Elastic Inference Accelerator. + // The ARN of the Elastic Inference Accelerator to tag. // // This member is required. - Tags map[string]*string + ResourceArn *string - // The ARN of the Elastic Inference Accelerator to tag. + // The tags to add to the Elastic Inference Accelerator. // // This member is required. - ResourceArn *string + Tags map[string]*string } type TagResourceOutput struct { diff --git a/service/elasticinference/api_op_UntagResource.go b/service/elasticinference/api_op_UntagResource.go index c8ecdd94e5e..04fad5e6040 100644 --- a/service/elasticinference/api_op_UntagResource.go +++ b/service/elasticinference/api_op_UntagResource.go @@ -56,15 +56,15 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The list of tags to remove from the Elastic Inference Accelerator. + // The ARN of the Elastic Inference Accelerator to untag. // // This member is required. - TagKeys []*string + ResourceArn *string - // The ARN of the Elastic Inference Accelerator to untag. + // The list of tags to remove from the Elastic Inference Accelerator. // // This member is required. - ResourceArn *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/elasticinference/go.mod b/service/elasticinference/go.mod index 3f8f3fca040..f34bd6d9844 100644 --- a/service/elasticinference/go.mod +++ b/service/elasticinference/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/elasticinference go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/elasticinference/types/types.go b/service/elasticinference/types/types.go index b9b6f096d8e..a9ac785b2dd 100644 --- a/service/elasticinference/types/types.go +++ b/service/elasticinference/types/types.go @@ -5,14 +5,14 @@ package types // The details of an Elastic Inference Accelerator type. type AcceleratorType struct { - // The throughput information of the Elastic Inference Accelerator type. - ThroughputInfo []*KeyValuePair - // The name of the Elastic Inference Accelerator type. AcceleratorTypeName *string // The memory information of the Elastic Inference Accelerator type. MemoryInfo *MemoryInfo + + // The throughput information of the Elastic Inference Accelerator type. + ThroughputInfo []*KeyValuePair } // The offering for an Elastic Inference Accelerator type. @@ -37,20 +37,20 @@ type AcceleratorTypeOffering struct { // The details of an Elastic Inference Accelerator. type ElasticInferenceAccelerator struct { - // The type of the Elastic Inference Accelerator. - AcceleratorType *string - - // The availability zone where the Elastic Inference Accelerator is present. - AvailabilityZone *string + // The health of the Elastic Inference Accelerator. + AcceleratorHealth *ElasticInferenceAcceleratorHealth // The ID of the Elastic Inference Accelerator. AcceleratorId *string + // The type of the Elastic Inference Accelerator. + AcceleratorType *string + // The ARN of the resource that the Elastic Inference Accelerator is attached to. AttachedResource *string - // The health of the Elastic Inference Accelerator. - AcceleratorHealth *ElasticInferenceAcceleratorHealth + // The availability zone where the Elastic Inference Accelerator is present. + AvailabilityZone *string } // The health details of an Elastic Inference Accelerator. @@ -63,13 +63,13 @@ type ElasticInferenceAcceleratorHealth struct { // A filter expression for the Elastic Inference Accelerator list. type Filter struct { - // The values for the filter of the Elastic Inference Accelerator list. - Values []*string - // The filter name for the Elastic Inference Accelerator list. It can assume the // following values: accelerator-type: the type of Elastic Inference Accelerator to // filter for. instance-id: an EC2 instance id to filter for. Name *string + + // The values for the filter of the Elastic Inference Accelerator list. + Values []*string } // A throughput entry for an Elastic Inference Accelerator type. diff --git a/service/elasticloadbalancing/api_op_AddTags.go b/service/elasticloadbalancing/api_op_AddTags.go index 2fda7cfa6a8..49e552e34df 100644 --- a/service/elasticloadbalancing/api_op_AddTags.go +++ b/service/elasticloadbalancing/api_op_AddTags.go @@ -63,15 +63,15 @@ func (c *Client) AddTags(ctx context.Context, params *AddTagsInput, optFns ...fu // Contains the parameters for AddTags. type AddTagsInput struct { - // The tags. + // The name of the load balancer. You can specify one load balancer only. // // This member is required. - Tags []*types.Tag + LoadBalancerNames []*string - // The name of the load balancer. You can specify one load balancer only. + // The tags. // // This member is required. - LoadBalancerNames []*string + Tags []*types.Tag } // Contains the output of AddTags. diff --git a/service/elasticloadbalancing/api_op_ApplySecurityGroupsToLoadBalancer.go b/service/elasticloadbalancing/api_op_ApplySecurityGroupsToLoadBalancer.go index a05a0f0a97d..d3372ec0e90 100644 --- a/service/elasticloadbalancing/api_op_ApplySecurityGroupsToLoadBalancer.go +++ b/service/elasticloadbalancing/api_op_ApplySecurityGroupsToLoadBalancer.go @@ -62,16 +62,16 @@ func (c *Client) ApplySecurityGroupsToLoadBalancer(ctx context.Context, params * // Contains the parameters for ApplySecurityGroupsToLoadBalancer. type ApplySecurityGroupsToLoadBalancerInput struct { - // The IDs of the security groups to associate with the load balancer. Note that - // you cannot specify the name of the security group. + // The name of the load balancer. // // This member is required. - SecurityGroups []*string + LoadBalancerName *string - // The name of the load balancer. + // The IDs of the security groups to associate with the load balancer. Note that + // you cannot specify the name of the security group. // // This member is required. - LoadBalancerName *string + SecurityGroups []*string } // Contains the output of ApplySecurityGroupsToLoadBalancer. diff --git a/service/elasticloadbalancing/api_op_AttachLoadBalancerToSubnets.go b/service/elasticloadbalancing/api_op_AttachLoadBalancerToSubnets.go index 17283781f35..4358d515054 100644 --- a/service/elasticloadbalancing/api_op_AttachLoadBalancerToSubnets.go +++ b/service/elasticloadbalancing/api_op_AttachLoadBalancerToSubnets.go @@ -62,16 +62,16 @@ func (c *Client) AttachLoadBalancerToSubnets(ctx context.Context, params *Attach // Contains the parameters for AttachLoaBalancerToSubnets. type AttachLoadBalancerToSubnetsInput struct { - // The IDs of the subnets to add. You can add only one subnet per Availability - // Zone. + // The name of the load balancer. // // This member is required. - Subnets []*string + LoadBalancerName *string - // The name of the load balancer. + // The IDs of the subnets to add. You can add only one subnet per Availability + // Zone. // // This member is required. - LoadBalancerName *string + Subnets []*string } // Contains the output of AttachLoadBalancerToSubnets. diff --git a/service/elasticloadbalancing/api_op_CreateLBCookieStickinessPolicy.go b/service/elasticloadbalancing/api_op_CreateLBCookieStickinessPolicy.go index 64ec5484e1b..d2050dfaa79 100644 --- a/service/elasticloadbalancing/api_op_CreateLBCookieStickinessPolicy.go +++ b/service/elasticloadbalancing/api_op_CreateLBCookieStickinessPolicy.go @@ -70,6 +70,11 @@ func (c *Client) CreateLBCookieStickinessPolicy(ctx context.Context, params *Cre // Contains the parameters for CreateLBCookieStickinessPolicy. type CreateLBCookieStickinessPolicyInput struct { + // The name of the load balancer. + // + // This member is required. + LoadBalancerName *string + // The name of the policy being created. Policy names must consist of alphanumeric // characters and dashes (-). This name must be unique within the set of policies // for this load balancer. @@ -81,11 +86,6 @@ type CreateLBCookieStickinessPolicyInput struct { // If you do not specify this parameter, the default value is 0, which indicates // that the sticky session should last for the duration of the browser session. CookieExpirationPeriod *int64 - - // The name of the load balancer. - // - // This member is required. - LoadBalancerName *string } // Contains the output for CreateLBCookieStickinessPolicy. diff --git a/service/elasticloadbalancing/api_op_CreateLoadBalancer.go b/service/elasticloadbalancing/api_op_CreateLoadBalancer.go index 35281346ac1..1fa4fa760b5 100644 --- a/service/elasticloadbalancing/api_op_CreateLoadBalancer.go +++ b/service/elasticloadbalancing/api_op_CreateLoadBalancer.go @@ -69,19 +69,6 @@ func (c *Client) CreateLoadBalancer(ctx context.Context, params *CreateLoadBalan // Contains the parameters for CreateLoadBalancer. type CreateLoadBalancerInput struct { - // The name of the load balancer. This name must be unique within your set of load - // balancers for the region, must have a maximum of 32 characters, must contain - // only alphanumeric characters or hyphens, and cannot begin or end with a hyphen. - // - // This member is required. - LoadBalancerName *string - - // A list of tags to assign to the load balancer. For more information about - // tagging your load balancer, see Tag Your Classic Load Balancer - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/add-remove-tags.html) - // in the Classic Load Balancers Guide. - Tags []*types.Tag - // The listeners. For more information, see Listeners for Your Classic Load // Balancer // (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-listener-config.html) @@ -90,8 +77,18 @@ type CreateLoadBalancerInput struct { // This member is required. Listeners []*types.Listener - // The IDs of the security groups to assign to the load balancer. - SecurityGroups []*string + // The name of the load balancer. This name must be unique within your set of load + // balancers for the region, must have a maximum of 32 characters, must contain + // only alphanumeric characters or hyphens, and cannot begin or end with a hyphen. + // + // This member is required. + LoadBalancerName *string + + // One or more Availability Zones from the same region as the load balancer. You + // must specify at least one Availability Zone. You can add more Availability Zones + // after you create the load balancer using EnableAvailabilityZonesForLoadBalancer + // (). + AvailabilityZones []*string // The type of a load balancer. Valid only for load balancers in a VPC. By default, // Elastic Load Balancing creates an Internet-facing load balancer with a DNS name @@ -102,15 +99,18 @@ type CreateLoadBalancerInput struct { // balancer with a DNS name that resolves to private IP addresses. Scheme *string + // The IDs of the security groups to assign to the load balancer. + SecurityGroups []*string + // The IDs of the subnets in your VPC to attach to the load balancer. Specify one // subnet per Availability Zone specified in AvailabilityZones. Subnets []*string - // One or more Availability Zones from the same region as the load balancer. You - // must specify at least one Availability Zone. You can add more Availability Zones - // after you create the load balancer using EnableAvailabilityZonesForLoadBalancer - // (). - AvailabilityZones []*string + // A list of tags to assign to the load balancer. For more information about + // tagging your load balancer, see Tag Your Classic Load Balancer + // (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/add-remove-tags.html) + // in the Classic Load Balancers Guide. + Tags []*types.Tag } // Contains the output for CreateLoadBalancer. diff --git a/service/elasticloadbalancing/api_op_CreateLoadBalancerListeners.go b/service/elasticloadbalancing/api_op_CreateLoadBalancerListeners.go index 152305581ba..1b2afa4b832 100644 --- a/service/elasticloadbalancing/api_op_CreateLoadBalancerListeners.go +++ b/service/elasticloadbalancing/api_op_CreateLoadBalancerListeners.go @@ -63,15 +63,15 @@ func (c *Client) CreateLoadBalancerListeners(ctx context.Context, params *Create // Contains the parameters for CreateLoadBalancerListeners. type CreateLoadBalancerListenersInput struct { - // The name of the load balancer. + // The listeners. // // This member is required. - LoadBalancerName *string + Listeners []*types.Listener - // The listeners. + // The name of the load balancer. // // This member is required. - Listeners []*types.Listener + LoadBalancerName *string } // Contains the parameters for CreateLoadBalancerListener. diff --git a/service/elasticloadbalancing/api_op_DeleteLoadBalancerListeners.go b/service/elasticloadbalancing/api_op_DeleteLoadBalancerListeners.go index 6aea66f3813..98ef385269a 100644 --- a/service/elasticloadbalancing/api_op_DeleteLoadBalancerListeners.go +++ b/service/elasticloadbalancing/api_op_DeleteLoadBalancerListeners.go @@ -57,15 +57,15 @@ func (c *Client) DeleteLoadBalancerListeners(ctx context.Context, params *Delete // Contains the parameters for DeleteLoadBalancerListeners. type DeleteLoadBalancerListenersInput struct { - // The client port numbers of the listeners. + // The name of the load balancer. // // This member is required. - LoadBalancerPorts []*int32 + LoadBalancerName *string - // The name of the load balancer. + // The client port numbers of the listeners. // // This member is required. - LoadBalancerName *string + LoadBalancerPorts []*int32 } // Contains the output of DeleteLoadBalancerListeners. diff --git a/service/elasticloadbalancing/api_op_DeleteLoadBalancerPolicy.go b/service/elasticloadbalancing/api_op_DeleteLoadBalancerPolicy.go index 24b2ea8a0cc..096cea66528 100644 --- a/service/elasticloadbalancing/api_op_DeleteLoadBalancerPolicy.go +++ b/service/elasticloadbalancing/api_op_DeleteLoadBalancerPolicy.go @@ -58,15 +58,15 @@ func (c *Client) DeleteLoadBalancerPolicy(ctx context.Context, params *DeleteLoa // Contains the parameters for DeleteLoadBalancerPolicy. type DeleteLoadBalancerPolicyInput struct { - // The name of the policy. + // The name of the load balancer. // // This member is required. - PolicyName *string + LoadBalancerName *string - // The name of the load balancer. + // The name of the policy. // // This member is required. - LoadBalancerName *string + PolicyName *string } // Contains the output of DeleteLoadBalancerPolicy. diff --git a/service/elasticloadbalancing/api_op_DeregisterInstancesFromLoadBalancer.go b/service/elasticloadbalancing/api_op_DeregisterInstancesFromLoadBalancer.go index 49fe34205ea..dd38e944812 100644 --- a/service/elasticloadbalancing/api_op_DeregisterInstancesFromLoadBalancer.go +++ b/service/elasticloadbalancing/api_op_DeregisterInstancesFromLoadBalancer.go @@ -63,15 +63,15 @@ func (c *Client) DeregisterInstancesFromLoadBalancer(ctx context.Context, params // Contains the parameters for DeregisterInstancesFromLoadBalancer. type DeregisterInstancesFromLoadBalancerInput struct { - // The name of the load balancer. + // The IDs of the instances. // // This member is required. - LoadBalancerName *string + Instances []*types.Instance - // The IDs of the instances. + // The name of the load balancer. // // This member is required. - Instances []*types.Instance + LoadBalancerName *string } // Contains the output of DeregisterInstancesFromLoadBalancer. diff --git a/service/elasticloadbalancing/api_op_DescribeAccountLimits.go b/service/elasticloadbalancing/api_op_DescribeAccountLimits.go index 0b2cfba46b9..1e7144abb73 100644 --- a/service/elasticloadbalancing/api_op_DescribeAccountLimits.go +++ b/service/elasticloadbalancing/api_op_DescribeAccountLimits.go @@ -59,23 +59,23 @@ func (c *Client) DescribeAccountLimits(ctx context.Context, params *DescribeAcco type DescribeAccountLimitsInput struct { - // The maximum number of results to return with this call. - PageSize *int32 - // The marker for the next set of results. (You received this marker from a // previous call.) Marker *string + + // The maximum number of results to return with this call. + PageSize *int32 } type DescribeAccountLimitsOutput struct { + // Information about the limits. + Limits []*types.Limit + // The marker to use when requesting the next set of results. If there are no // additional results, the string is empty. NextMarker *string - // Information about the limits. - Limits []*types.Limit - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticloadbalancing/api_op_DescribeLoadBalancers.go b/service/elasticloadbalancing/api_op_DescribeLoadBalancers.go index 8c18ea26764..451186f0cb6 100644 --- a/service/elasticloadbalancing/api_op_DescribeLoadBalancers.go +++ b/service/elasticloadbalancing/api_op_DescribeLoadBalancers.go @@ -73,13 +73,13 @@ type DescribeLoadBalancersInput struct { // Contains the parameters for DescribeLoadBalancers. type DescribeLoadBalancersOutput struct { + // Information about the load balancers. + LoadBalancerDescriptions []*types.LoadBalancerDescription + // The marker to use when requesting the next set of results. If there are no // additional results, the string is empty. NextMarker *string - // Information about the load balancers. - LoadBalancerDescriptions []*types.LoadBalancerDescription - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticloadbalancing/api_op_DisableAvailabilityZonesForLoadBalancer.go b/service/elasticloadbalancing/api_op_DisableAvailabilityZonesForLoadBalancer.go index 1a12a1469f4..25d1bf198eb 100644 --- a/service/elasticloadbalancing/api_op_DisableAvailabilityZonesForLoadBalancer.go +++ b/service/elasticloadbalancing/api_op_DisableAvailabilityZonesForLoadBalancer.go @@ -66,15 +66,15 @@ func (c *Client) DisableAvailabilityZonesForLoadBalancer(ctx context.Context, pa // Contains the parameters for DisableAvailabilityZonesForLoadBalancer. type DisableAvailabilityZonesForLoadBalancerInput struct { - // The name of the load balancer. + // The Availability Zones. // // This member is required. - LoadBalancerName *string + AvailabilityZones []*string - // The Availability Zones. + // The name of the load balancer. // // This member is required. - AvailabilityZones []*string + LoadBalancerName *string } // Contains the output for DisableAvailabilityZonesForLoadBalancer. diff --git a/service/elasticloadbalancing/api_op_ModifyLoadBalancerAttributes.go b/service/elasticloadbalancing/api_op_ModifyLoadBalancerAttributes.go index 908ee6b0261..7a734e52c6d 100644 --- a/service/elasticloadbalancing/api_op_ModifyLoadBalancerAttributes.go +++ b/service/elasticloadbalancing/api_op_ModifyLoadBalancerAttributes.go @@ -78,26 +78,26 @@ func (c *Client) ModifyLoadBalancerAttributes(ctx context.Context, params *Modif // Contains the parameters for ModifyLoadBalancerAttributes. type ModifyLoadBalancerAttributesInput struct { - // The name of the load balancer. + // The attributes for the load balancer. // // This member is required. - LoadBalancerName *string + LoadBalancerAttributes *types.LoadBalancerAttributes - // The attributes for the load balancer. + // The name of the load balancer. // // This member is required. - LoadBalancerAttributes *types.LoadBalancerAttributes + LoadBalancerName *string } // Contains the output of ModifyLoadBalancerAttributes. type ModifyLoadBalancerAttributesOutput struct { - // The name of the load balancer. - LoadBalancerName *string - // Information about the load balancer attributes. LoadBalancerAttributes *types.LoadBalancerAttributes + // The name of the load balancer. + LoadBalancerName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticloadbalancing/api_op_RegisterInstancesWithLoadBalancer.go b/service/elasticloadbalancing/api_op_RegisterInstancesWithLoadBalancer.go index 06521b99a06..b927c607ba0 100644 --- a/service/elasticloadbalancing/api_op_RegisterInstancesWithLoadBalancer.go +++ b/service/elasticloadbalancing/api_op_RegisterInstancesWithLoadBalancer.go @@ -75,15 +75,15 @@ func (c *Client) RegisterInstancesWithLoadBalancer(ctx context.Context, params * // Contains the parameters for RegisterInstancesWithLoadBalancer. type RegisterInstancesWithLoadBalancerInput struct { - // The name of the load balancer. + // The IDs of the instances. // // This member is required. - LoadBalancerName *string + Instances []*types.Instance - // The IDs of the instances. + // The name of the load balancer. // // This member is required. - Instances []*types.Instance + LoadBalancerName *string } // Contains the output of RegisterInstancesWithLoadBalancer. diff --git a/service/elasticloadbalancing/api_op_SetLoadBalancerListenerSSLCertificate.go b/service/elasticloadbalancing/api_op_SetLoadBalancerListenerSSLCertificate.go index 7fb032083da..c237cccb034 100644 --- a/service/elasticloadbalancing/api_op_SetLoadBalancerListenerSSLCertificate.go +++ b/service/elasticloadbalancing/api_op_SetLoadBalancerListenerSSLCertificate.go @@ -68,15 +68,15 @@ type SetLoadBalancerListenerSSLCertificateInput struct { // This member is required. LoadBalancerName *string - // The Amazon Resource Name (ARN) of the SSL certificate. + // The port that uses the specified SSL certificate. // // This member is required. - SSLCertificateId *string + LoadBalancerPort *int32 - // The port that uses the specified SSL certificate. + // The Amazon Resource Name (ARN) of the SSL certificate. // // This member is required. - LoadBalancerPort *int32 + SSLCertificateId *string } // Contains the output of SetLoadBalancerListenerSSLCertificate. diff --git a/service/elasticloadbalancing/api_op_SetLoadBalancerPoliciesOfListener.go b/service/elasticloadbalancing/api_op_SetLoadBalancerPoliciesOfListener.go index 3fce5a2395e..e39d51e41cf 100644 --- a/service/elasticloadbalancing/api_op_SetLoadBalancerPoliciesOfListener.go +++ b/service/elasticloadbalancing/api_op_SetLoadBalancerPoliciesOfListener.go @@ -66,6 +66,11 @@ func (c *Client) SetLoadBalancerPoliciesOfListener(ctx context.Context, params * // Contains the parameters for SetLoadBalancePoliciesOfListener. type SetLoadBalancerPoliciesOfListenerInput struct { + // The name of the load balancer. + // + // This member is required. + LoadBalancerName *string + // The external port of the load balancer. // // This member is required. @@ -77,11 +82,6 @@ type SetLoadBalancerPoliciesOfListenerInput struct { // // This member is required. PolicyNames []*string - - // The name of the load balancer. - // - // This member is required. - LoadBalancerName *string } // Contains the output of SetLoadBalancePoliciesOfListener. diff --git a/service/elasticloadbalancing/go.mod b/service/elasticloadbalancing/go.mod index dcc4ecf5d8a..44ad8807d59 100644 --- a/service/elasticloadbalancing/go.mod +++ b/service/elasticloadbalancing/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/elasticloadbalancing go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/elasticloadbalancing/types/types.go b/service/elasticloadbalancing/types/types.go index de400070a57..8f3aed32576 100644 --- a/service/elasticloadbalancing/types/types.go +++ b/service/elasticloadbalancing/types/types.go @@ -9,6 +9,11 @@ import ( // Information about the AccessLog attribute. type AccessLog struct { + // Specifies whether access logs are enabled for the load balancer. + // + // This member is required. + Enabled *bool + // The interval for publishing the access logs. You can specify an interval of // either 5 minutes or 60 minutes. Default: 60 minutes EmitInterval *int32 @@ -20,42 +25,37 @@ type AccessLog struct { // my-bucket-prefix/prod. If the prefix is not provided, the log is placed at the // root level of the bucket. S3BucketPrefix *string - - // Specifies whether access logs are enabled for the load balancer. - // - // This member is required. - Enabled *bool } // This data type is reserved. type AdditionalAttribute struct { // This parameter is reserved. - Value *string + Key *string // This parameter is reserved. - Key *string + Value *string } // Information about a policy for application-controlled session stickiness. type AppCookieStickinessPolicy struct { + // The name of the application cookie used for stickiness. + CookieName *string + // The mnemonic name for the policy being created. The name must be unique within a // set of policies for this load balancer. PolicyName *string - - // The name of the application cookie used for stickiness. - CookieName *string } // Information about the configuration of an EC2 instance. type BackendServerDescription struct { - // The names of the policies enabled for the EC2 instance. - PolicyNames []*string - // The port on which the EC2 instance is listening. InstancePort *int32 + + // The names of the policies enabled for the EC2 instance. + PolicyNames []*string } // Information about the ConnectionDraining attribute. @@ -93,6 +93,18 @@ type CrossZoneLoadBalancing struct { // Information about a health check. type HealthCheck struct { + // The number of consecutive health checks successes required before moving the + // instance to the Healthy state. + // + // This member is required. + HealthyThreshold *int32 + + // The approximate interval, in seconds, between health checks of an individual + // instance. + // + // This member is required. + Interval *int32 + // The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The // range of valid ports is one (1) through 65535. TCP is the default, specified as // a TCP: port pair, for example "TCP:5000". In this case, a health check simply @@ -109,29 +121,17 @@ type HealthCheck struct { // This member is required. Target *string - // The number of consecutive health checks successes required before moving the - // instance to the Healthy state. - // - // This member is required. - HealthyThreshold *int32 - - // The number of consecutive health check failures required before moving the - // instance to the Unhealthy state. - // - // This member is required. - UnhealthyThreshold *int32 - // The amount of time, in seconds, during which no response means a failed health // check. This value must be less than the Interval value. // // This member is required. Timeout *int32 - // The approximate interval, in seconds, between health checks of an individual - // instance. + // The number of consecutive health check failures required before moving the + // instance to the Unhealthy state. // // This member is required. - Interval *int32 + UnhealthyThreshold *int32 } // The ID of an EC2 instance. @@ -184,14 +184,14 @@ type InstanceState struct { // The ID of the instance. InstanceId *string - // The current state of the instance. Valid values: InService | OutOfService | - // Unknown - State *string - // Information about the cause of OutOfService instances. Specifically, whether the // cause is Elastic Load Balancing or the instance. Valid values: ELB | Instance | // N/A ReasonCode *string + + // The current state of the instance. Valid values: InService | OutOfService | + // Unknown + State *string } // Information about a policy for duration-based session stickiness. @@ -210,6 +210,9 @@ type LBCookieStickinessPolicy struct { // Information about an Elastic Load Balancing resource limit for your AWS account. type Limit struct { + // The maximum value of the limit. + Max *string + // The name of the limit. The possible values are: // // * classic-listeners @@ -219,9 +222,6 @@ type Limit struct { // // * classic-registered-instances Name *string - - // The maximum value of the limit. - Max *string } // Information about a listener. For information about the protocols and the ports @@ -231,8 +231,10 @@ type Limit struct { // in the Classic Load Balancers Guide. type Listener struct { - // The Amazon Resource Name (ARN) of the server certificate. - SSLCertificateId *string + // The port on which the instance is listening. + // + // This member is required. + InstancePort *int32 // The port on which the load balancer is listening. On EC2-VPC, you can specify // any port from the range 1-65535. On EC2-Classic, you can specify any port from @@ -241,6 +243,12 @@ type Listener struct { // This member is required. LoadBalancerPort *int32 + // The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or + // SSL. + // + // This member is required. + Protocol *string + // The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL. // If the front-end protocol is HTTP, HTTPS, TCP, or SSL, InstanceProtocol must be // at the same protocol. If there is another listener with the same InstancePort @@ -250,16 +258,8 @@ type Listener struct { // InstanceProtocol must be HTTP or TCP. InstanceProtocol *string - // The port on which the instance is listening. - // - // This member is required. - InstancePort *int32 - - // The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or - // SSL. - // - // This member is required. - Protocol *string + // The Amazon Resource Name (ARN) of the server certificate. + SSLCertificateId *string } // The policies enabled for a listener. @@ -275,15 +275,6 @@ type ListenerDescription struct { // The attributes for a load balancer. type LoadBalancerAttributes struct { - // If enabled, the load balancer allows the connections to remain idle (no data is - // sent over the connection) for the specified duration. By default, Elastic Load - // Balancing maintains a 60-second idle connection timeout for both front-end and - // back-end connections of your load balancer. For more information, see Configure - // Idle Connection Timeout - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-idle-timeout.html) - // in the Classic Load Balancers Guide. - ConnectionSettings *ConnectionSettings - // If enabled, the load balancer captures detailed information of all requests and // delivers the information to the Amazon S3 bucket that you specify. For more // information, see Enable Access Logs @@ -294,43 +285,39 @@ type LoadBalancerAttributes struct { // This parameter is reserved. AdditionalAttributes []*AdditionalAttribute - // If enabled, the load balancer routes the request traffic evenly across all - // instances regardless of the Availability Zones. For more information, see - // Configure Cross-Zone Load Balancing - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-crosszone-lb.html) - // in the Classic Load Balancers Guide. - CrossZoneLoadBalancing *CrossZoneLoadBalancing - // If enabled, the load balancer allows existing requests to complete before the // load balancer shifts traffic away from a deregistered or unhealthy instance. For // more information, see Configure Connection Draining // (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-conn-drain.html) // in the Classic Load Balancers Guide. ConnectionDraining *ConnectionDraining + + // If enabled, the load balancer allows the connections to remain idle (no data is + // sent over the connection) for the specified duration. By default, Elastic Load + // Balancing maintains a 60-second idle connection timeout for both front-end and + // back-end connections of your load balancer. For more information, see Configure + // Idle Connection Timeout + // (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-idle-timeout.html) + // in the Classic Load Balancers Guide. + ConnectionSettings *ConnectionSettings + + // If enabled, the load balancer routes the request traffic evenly across all + // instances regardless of the Availability Zones. For more information, see + // Configure Cross-Zone Load Balancing + // (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-crosszone-lb.html) + // in the Classic Load Balancers Guide. + CrossZoneLoadBalancing *CrossZoneLoadBalancing } // Information about a load balancer. type LoadBalancerDescription struct { + // The Availability Zones for the load balancer. + AvailabilityZones []*string + // Information about your EC2 instances. BackendServerDescriptions []*BackendServerDescription - // The DNS name of the load balancer. - DNSName *string - - // The date and time the load balancer was created. - CreatedTime *time.Time - - // The type of load balancer. Valid only for load balancers in a VPC. If Scheme is - // internet-facing, the load balancer has a public DNS name that resolves to a - // public IP address. If Scheme is internal, the load balancer has a public DNS - // name that resolves to a private IP address. - Scheme *string - - // The security groups for the load balancer. Valid only for load balancers in a - // VPC. - SecurityGroups []*string - // The DNS name of the load balancer. For more information, see Configure a Custom // Domain Name // (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/using-domain-names-with-elb.html) @@ -340,17 +327,36 @@ type LoadBalancerDescription struct { // The ID of the Amazon Route 53 hosted zone for the load balancer. CanonicalHostedZoneNameID *string + // The date and time the load balancer was created. + CreatedTime *time.Time + + // The DNS name of the load balancer. + DNSName *string + + // Information about the health checks conducted on the load balancer. + HealthCheck *HealthCheck + // The IDs of the instances for the load balancer. Instances []*Instance // The listeners for the load balancer. ListenerDescriptions []*ListenerDescription - // Information about the health checks conducted on the load balancer. - HealthCheck *HealthCheck + // The name of the load balancer. + LoadBalancerName *string - // The Availability Zones for the load balancer. - AvailabilityZones []*string + // The policies defined for the load balancer. + Policies *Policies + + // The type of load balancer. Valid only for load balancers in a VPC. If Scheme is + // internet-facing, the load balancer has a public DNS name that resolves to a + // public IP address. If Scheme is internal, the load balancer has a public DNS + // name that resolves to a private IP address. + Scheme *string + + // The security groups for the load balancer. Valid only for load balancers in a + // VPC. + SecurityGroups []*string // The security group for the load balancer, which you can use as part of your // inbound rules for your registered instances. To only allow traffic from load @@ -358,40 +364,34 @@ type LoadBalancerDescription struct { // as the inbound source. SourceSecurityGroup *SourceSecurityGroup - // The ID of the VPC for the load balancer. - VPCId *string - - // The policies defined for the load balancer. - Policies *Policies - - // The name of the load balancer. - LoadBalancerName *string - // The IDs of the subnets for the load balancer. Subnets []*string + + // The ID of the VPC for the load balancer. + VPCId *string } // The policies for a load balancer. type Policies struct { - // The policies other than the stickiness policies. - OtherPolicies []*string + // The stickiness policies created using CreateAppCookieStickinessPolicy (). + AppCookieStickinessPolicies []*AppCookieStickinessPolicy // The stickiness policies created using CreateLBCookieStickinessPolicy (). LBCookieStickinessPolicies []*LBCookieStickinessPolicy - // The stickiness policies created using CreateAppCookieStickinessPolicy (). - AppCookieStickinessPolicies []*AppCookieStickinessPolicy + // The policies other than the stickiness policies. + OtherPolicies []*string } // Information about a policy attribute. type PolicyAttribute struct { - // The value of the attribute. - AttributeValue *string - // The name of the attribute. AttributeName *string + + // The value of the attribute. + AttributeValue *string } // Information about a policy attribute. @@ -407,14 +407,11 @@ type PolicyAttributeDescription struct { // Information about a policy attribute type. type PolicyAttributeTypeDescription struct { - // The type of the attribute. For example, Boolean or Integer. - AttributeType *string - // The name of the attribute. AttributeName *string - // The default value of the attribute, if applicable. - DefaultValue *string + // The type of the attribute. For example, Boolean or Integer. + AttributeType *string // The cardinality of the attribute. Valid values: // @@ -430,6 +427,9 @@ type PolicyAttributeTypeDescription struct { // ONE_OR_MORE(1..*0) : Required. Multiple values are allowed Cardinality *string + // The default value of the attribute, if applicable. + DefaultValue *string + // A description of the attribute. Description *string } @@ -437,14 +437,14 @@ type PolicyAttributeTypeDescription struct { // Information about a policy. type PolicyDescription struct { - // The name of the policy type. - PolicyTypeName *string + // The policy attributes. + PolicyAttributeDescriptions []*PolicyAttributeDescription // The name of the policy. PolicyName *string - // The policy attributes. - PolicyAttributeDescriptions []*PolicyAttributeDescription + // The name of the policy type. + PolicyTypeName *string } // Information about a policy type. @@ -464,33 +464,33 @@ type PolicyTypeDescription struct { // Information about a source security group. type SourceSecurityGroup struct { - // The owner of the security group. - OwnerAlias *string - // The name of the security group. GroupName *string + + // The owner of the security group. + OwnerAlias *string } // Information about a tag. type Tag struct { - // The value of the tag. - Value *string - // The key of the tag. // // This member is required. Key *string + + // The value of the tag. + Value *string } // The tags associated with a load balancer. type TagDescription struct { - // The tags. - Tags []*Tag - // The name of the load balancer. LoadBalancerName *string + + // The tags. + Tags []*Tag } // The key of a tag. diff --git a/service/elasticloadbalancingv2/api_op_AddListenerCertificates.go b/service/elasticloadbalancingv2/api_op_AddListenerCertificates.go index 25a366506e3..ef571233e80 100644 --- a/service/elasticloadbalancingv2/api_op_AddListenerCertificates.go +++ b/service/elasticloadbalancingv2/api_op_AddListenerCertificates.go @@ -65,16 +65,16 @@ func (c *Client) AddListenerCertificates(ctx context.Context, params *AddListene type AddListenerCertificatesInput struct { - // The Amazon Resource Name (ARN) of the listener. - // - // This member is required. - ListenerArn *string - // The certificate to add. You can specify one certificate per call. Set // CertificateArn to the certificate ARN but do not set IsDefault. // // This member is required. Certificates []*types.Certificate + + // The Amazon Resource Name (ARN) of the listener. + // + // This member is required. + ListenerArn *string } type AddListenerCertificatesOutput struct { diff --git a/service/elasticloadbalancingv2/api_op_AddTags.go b/service/elasticloadbalancingv2/api_op_AddTags.go index c51aeed1cd7..c5234f476f1 100644 --- a/service/elasticloadbalancingv2/api_op_AddTags.go +++ b/service/elasticloadbalancingv2/api_op_AddTags.go @@ -62,15 +62,15 @@ func (c *Client) AddTags(ctx context.Context, params *AddTagsInput, optFns ...fu type AddTagsInput struct { - // The tags. + // The Amazon Resource Name (ARN) of the resource. // // This member is required. - Tags []*types.Tag + ResourceArns []*string - // The Amazon Resource Name (ARN) of the resource. + // The tags. // // This member is required. - ResourceArns []*string + Tags []*types.Tag } type AddTagsOutput struct { diff --git a/service/elasticloadbalancingv2/api_op_CreateListener.go b/service/elasticloadbalancingv2/api_op_CreateListener.go index cb35d743d9a..ffb2f03aef5 100644 --- a/service/elasticloadbalancingv2/api_op_CreateListener.go +++ b/service/elasticloadbalancingv2/api_op_CreateListener.go @@ -69,50 +69,6 @@ func (c *Client) CreateListener(ctx context.Context, params *CreateListenerInput type CreateListenerInput struct { - // The Amazon Resource Name (ARN) of the load balancer. - // - // This member is required. - LoadBalancerArn *string - - // [HTTPS and TLS listeners] The security policy that defines which protocols and - // ciphers are supported. The following are the possible values: - // - // * - // ELBSecurityPolicy-2016-08 - // - // * ELBSecurityPolicy-TLS-1-0-2015-04 - // - // * - // ELBSecurityPolicy-TLS-1-1-2017-01 - // - // * ELBSecurityPolicy-TLS-1-2-2017-01 - // - // - // * ELBSecurityPolicy-TLS-1-2-Ext-2018-06 - // - // * ELBSecurityPolicy-FS-2018-06 - // - // - // * ELBSecurityPolicy-FS-1-1-2019-08 - // - // * ELBSecurityPolicy-FS-1-2-2019-08 - // - // - // * ELBSecurityPolicy-FS-1-2-Res-2019-08 - // - // For more information, see Security - // Policies - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) - // in the Application Load Balancers Guide and Security Policies - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) - // in the Network Load Balancers Guide. - SslPolicy *string - - // The port on which the load balancer is listening. - // - // This member is required. - Port *int32 - // The actions for the default rule. The rule must include one forward action or // one or more fixed-response actions. If the action type is forward, you specify // one or more target groups. The protocol of the target group must be HTTP or @@ -129,6 +85,23 @@ type CreateListenerInput struct { // This member is required. DefaultActions []*types.Action + // The Amazon Resource Name (ARN) of the load balancer. + // + // This member is required. + LoadBalancerArn *string + + // The port on which the load balancer is listening. + // + // This member is required. + Port *int32 + + // The protocol for connections from clients to the load balancer. For Application + // Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load + // Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. + // + // This member is required. + Protocol types.ProtocolEnum + // [TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) // policy. You can specify one policy name. The following are the possible // values: @@ -149,18 +122,45 @@ type CreateListenerInput struct { // in the Network Load Balancers Guide. AlpnPolicy []*string - // The protocol for connections from clients to the load balancer. For Application - // Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load - // Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. - // - // This member is required. - Protocol types.ProtocolEnum - // [HTTPS and TLS listeners] The default certificate for the listener. You must // provide exactly one certificate. Set CertificateArn to the certificate ARN but // do not set IsDefault. To create a certificate list for the listener, use // AddListenerCertificates (). Certificates []*types.Certificate + + // [HTTPS and TLS listeners] The security policy that defines which protocols and + // ciphers are supported. The following are the possible values: + // + // * + // ELBSecurityPolicy-2016-08 + // + // * ELBSecurityPolicy-TLS-1-0-2015-04 + // + // * + // ELBSecurityPolicy-TLS-1-1-2017-01 + // + // * ELBSecurityPolicy-TLS-1-2-2017-01 + // + // + // * ELBSecurityPolicy-TLS-1-2-Ext-2018-06 + // + // * ELBSecurityPolicy-FS-2018-06 + // + // + // * ELBSecurityPolicy-FS-1-1-2019-08 + // + // * ELBSecurityPolicy-FS-1-2-2019-08 + // + // + // * ELBSecurityPolicy-FS-1-2-Res-2019-08 + // + // For more information, see Security + // Policies + // (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) + // in the Application Load Balancers Guide and Security Policies + // (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) + // in the Network Load Balancers Guide. + SslPolicy *string } type CreateListenerOutput struct { diff --git a/service/elasticloadbalancingv2/api_op_CreateLoadBalancer.go b/service/elasticloadbalancingv2/api_op_CreateLoadBalancer.go index f90c505d1f9..23138ab5a9b 100644 --- a/service/elasticloadbalancingv2/api_op_CreateLoadBalancer.go +++ b/service/elasticloadbalancingv2/api_op_CreateLoadBalancer.go @@ -76,21 +76,19 @@ func (c *Client) CreateLoadBalancer(ctx context.Context, params *CreateLoadBalan type CreateLoadBalancerInput struct { + // The name of the load balancer. This name must be unique per region per account, + // can have a maximum of 32 characters, must contain only alphanumeric characters + // or hyphens, must not begin or end with a hyphen, and must not begin with + // "internal-". + // + // This member is required. + Name *string + // [Application Load Balancers] The type of IP addresses used by the subnets for // your load balancer. The possible values are ipv4 (for IPv4 addresses) and // dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use ipv4. IpAddressType types.IpAddressType - // One or more tags to assign to the load balancer. - Tags []*types.Tag - - // The type of load balancer. The default is application. - Type types.LoadBalancerTypeEnum - - // [Application Load Balancers] The IDs of the security groups for the load - // balancer. - SecurityGroups []*string - // The nodes of an Internet-facing load balancer have public IP addresses. The DNS // name of an Internet-facing load balancer is publicly resolvable to the public IP // addresses of the nodes. Therefore, Internet-facing load balancers can route @@ -101,12 +99,9 @@ type CreateLoadBalancerInput struct { // VPC for the load balancer. The default is an Internet-facing load balancer. Scheme types.LoadBalancerSchemeEnum - // The IDs of the public subnets. You can specify only one subnet per Availability - // Zone. You must specify either subnets or subnet mappings. [Application Load - // Balancers] You must specify subnets from at least two Availability Zones. - // [Network Load Balancers] You can specify subnets from one or more Availability - // Zones. - Subnets []*string + // [Application Load Balancers] The IDs of the security groups for the load + // balancer. + SecurityGroups []*string // The IDs of the public subnets. You can specify only one subnet per Availability // Zone. You must specify either subnets or subnet mappings. [Application Load @@ -118,13 +113,18 @@ type CreateLoadBalancerInput struct { // private IP address per subnet from the IPv4 range of the subnet. SubnetMappings []*types.SubnetMapping - // The name of the load balancer. This name must be unique per region per account, - // can have a maximum of 32 characters, must contain only alphanumeric characters - // or hyphens, must not begin or end with a hyphen, and must not begin with - // "internal-". - // - // This member is required. - Name *string + // The IDs of the public subnets. You can specify only one subnet per Availability + // Zone. You must specify either subnets or subnet mappings. [Application Load + // Balancers] You must specify subnets from at least two Availability Zones. + // [Network Load Balancers] You can specify subnets from one or more Availability + // Zones. + Subnets []*string + + // One or more tags to assign to the load balancer. + Tags []*types.Tag + + // The type of load balancer. The default is application. + Type types.LoadBalancerTypeEnum } type CreateLoadBalancerOutput struct { diff --git a/service/elasticloadbalancingv2/api_op_CreateRule.go b/service/elasticloadbalancingv2/api_op_CreateRule.go index ed78ba20789..4c1babd314b 100644 --- a/service/elasticloadbalancingv2/api_op_CreateRule.go +++ b/service/elasticloadbalancingv2/api_op_CreateRule.go @@ -89,15 +89,15 @@ type CreateRuleInput struct { // This member is required. Conditions []*types.RuleCondition - // The rule priority. A listener can't have multiple rules with the same priority. + // The Amazon Resource Name (ARN) of the listener. // // This member is required. - Priority *int32 + ListenerArn *string - // The Amazon Resource Name (ARN) of the listener. + // The rule priority. A listener can't have multiple rules with the same priority. // // This member is required. - ListenerArn *string + Priority *int32 } type CreateRuleOutput struct { diff --git a/service/elasticloadbalancingv2/api_op_CreateTargetGroup.go b/service/elasticloadbalancingv2/api_op_CreateTargetGroup.go index acb05c05b5d..b1b6a11ad64 100644 --- a/service/elasticloadbalancingv2/api_op_CreateTargetGroup.go +++ b/service/elasticloadbalancingv2/api_op_CreateTargetGroup.go @@ -70,40 +70,18 @@ func (c *Client) CreateTargetGroup(ctx context.Context, params *CreateTargetGrou type CreateTargetGroupInput struct { - // [HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful - // response from a target. - Matcher *types.Matcher + // The name of the target group. This name must be unique per region per account, + // can have a maximum of 32 characters, must contain only alphanumeric characters + // or hyphens, and must not begin or end with a hyphen. + // + // This member is required. + Name *string // Indicates whether health checks are enabled. If the target type is lambda, // health checks are disabled by default but can be enabled. If the target type is // instance or ip, health checks are always enabled and cannot be disabled. HealthCheckEnabled *bool - // The type of target that you must specify when registering targets with this - // target group. You can't specify targets for a target group using more than one - // target type. - // - // * instance - Targets are specified by instance ID. This is the - // default value. If the target group protocol is UDP or TCP_UDP, the target type - // must be instance. - // - // * ip - Targets are specified by IP address. You can - // specify IP addresses from the subnets of the virtual private cloud (VPC) for the - // target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and - // 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify - // publicly routable IP addresses. - // - // * lambda - The target groups contains a - // single Lambda function. - TargetType types.TargetTypeEnum - - // The number of consecutive health check failures required before considering a - // target unhealthy. For target groups with a protocol of HTTP or HTTPS, the - // default is 2. For target groups with a protocol of TCP or TLS, this value must - // be the same as the healthy threshold count. If the target type is lambda, the - // default is 2. - UnhealthyThresholdCount *int32 - // The approximate amount of time, in seconds, between health checks of an // individual target. For HTTP and HTTPS health checks, the range is 5–300 seconds. // For TCP health checks, the supported values are 10 and 30 seconds. If the target @@ -111,6 +89,10 @@ type CreateTargetGroupInput struct { // the default is 35 seconds. HealthCheckIntervalSeconds *int32 + // [HTTP/HTTPS health checks] The ping path that is the destination on the targets + // for health checks. The default is /. + HealthCheckPath *string + // The port the load balancer uses when performing health checks on targets. The // default is traffic-port, which is the port on which each target receives traffic // from the load balancer. @@ -123,9 +105,22 @@ type CreateTargetGroupInput struct { // TCP_UDP protocols are not supported for health checks. HealthCheckProtocol types.ProtocolEnum - // [HTTP/HTTPS health checks] The ping path that is the destination on the targets - // for health checks. The default is /. - HealthCheckPath *string + // The amount of time, in seconds, during which no response from a target means a + // failed health check. For target groups with a protocol of HTTP or HTTPS, the + // default is 5 seconds. For target groups with a protocol of TCP or TLS, this + // value must be 6 seconds for HTTP health checks and 10 seconds for TCP and HTTPS + // health checks. If the target type is lambda, the default is 30 seconds. + HealthCheckTimeoutSeconds *int32 + + // The number of consecutive health checks successes required before considering an + // unhealthy target healthy. For target groups with a protocol of HTTP or HTTPS, + // the default is 5. For target groups with a protocol of TCP or TLS, the default + // is 3. If the target type is lambda, the default is 5. + HealthyThresholdCount *int32 + + // [HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful + // response from a target. + Matcher *types.Matcher // The port on which the targets receive traffic. This port is used unless you // specify a port override when registering the target. If the target is a Lambda @@ -139,25 +134,30 @@ type CreateTargetGroupInput struct { // Lambda function, this parameter does not apply. Protocol types.ProtocolEnum - // The amount of time, in seconds, during which no response from a target means a - // failed health check. For target groups with a protocol of HTTP or HTTPS, the - // default is 5 seconds. For target groups with a protocol of TCP or TLS, this - // value must be 6 seconds for HTTP health checks and 10 seconds for TCP and HTTPS - // health checks. If the target type is lambda, the default is 30 seconds. - HealthCheckTimeoutSeconds *int32 - - // The name of the target group. This name must be unique per region per account, - // can have a maximum of 32 characters, must contain only alphanumeric characters - // or hyphens, and must not begin or end with a hyphen. + // The type of target that you must specify when registering targets with this + // target group. You can't specify targets for a target group using more than one + // target type. // - // This member is required. - Name *string + // * instance - Targets are specified by instance ID. This is the + // default value. If the target group protocol is UDP or TCP_UDP, the target type + // must be instance. + // + // * ip - Targets are specified by IP address. You can + // specify IP addresses from the subnets of the virtual private cloud (VPC) for the + // target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and + // 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify + // publicly routable IP addresses. + // + // * lambda - The target groups contains a + // single Lambda function. + TargetType types.TargetTypeEnum - // The number of consecutive health checks successes required before considering an - // unhealthy target healthy. For target groups with a protocol of HTTP or HTTPS, - // the default is 5. For target groups with a protocol of TCP or TLS, the default - // is 3. If the target type is lambda, the default is 5. - HealthyThresholdCount *int32 + // The number of consecutive health check failures required before considering a + // target unhealthy. For target groups with a protocol of HTTP or HTTPS, the + // default is 2. For target groups with a protocol of TCP or TLS, this value must + // be the same as the healthy threshold count. If the target type is lambda, the + // default is 2. + UnhealthyThresholdCount *int32 // The identifier of the virtual private cloud (VPC). If the target is a Lambda // function, this parameter does not apply. Otherwise, this parameter is required. diff --git a/service/elasticloadbalancingv2/api_op_DeregisterTargets.go b/service/elasticloadbalancingv2/api_op_DeregisterTargets.go index b47925bfe5e..ba2d3737b22 100644 --- a/service/elasticloadbalancingv2/api_op_DeregisterTargets.go +++ b/service/elasticloadbalancingv2/api_op_DeregisterTargets.go @@ -58,16 +58,16 @@ func (c *Client) DeregisterTargets(ctx context.Context, params *DeregisterTarget type DeregisterTargetsInput struct { - // The targets. If you specified a port override when you registered a target, you - // must specify both the target ID and the port when you deregister it. + // The Amazon Resource Name (ARN) of the target group. // // This member is required. - Targets []*types.TargetDescription + TargetGroupArn *string - // The Amazon Resource Name (ARN) of the target group. + // The targets. If you specified a port override when you registered a target, you + // must specify both the target ID and the port when you deregister it. // // This member is required. - TargetGroupArn *string + Targets []*types.TargetDescription } type DeregisterTargetsOutput struct { diff --git a/service/elasticloadbalancingv2/api_op_DescribeListenerCertificates.go b/service/elasticloadbalancingv2/api_op_DescribeListenerCertificates.go index 99a41ce4b6e..0896e251df6 100644 --- a/service/elasticloadbalancingv2/api_op_DescribeListenerCertificates.go +++ b/service/elasticloadbalancingv2/api_op_DescribeListenerCertificates.go @@ -62,17 +62,17 @@ func (c *Client) DescribeListenerCertificates(ctx context.Context, params *Descr type DescribeListenerCertificatesInput struct { + // The Amazon Resource Names (ARN) of the listener. + // + // This member is required. + ListenerArn *string + // The marker for the next set of results. (You received this marker from a // previous call.) Marker *string // The maximum number of results to return with this call. PageSize *int32 - - // The Amazon Resource Names (ARN) of the listener. - // - // This member is required. - ListenerArn *string } type DescribeListenerCertificatesOutput struct { diff --git a/service/elasticloadbalancingv2/api_op_DescribeListeners.go b/service/elasticloadbalancingv2/api_op_DescribeListeners.go index 390fb5334eb..51ea2ef9799 100644 --- a/service/elasticloadbalancingv2/api_op_DescribeListeners.go +++ b/service/elasticloadbalancingv2/api_op_DescribeListeners.go @@ -60,18 +60,18 @@ func (c *Client) DescribeListeners(ctx context.Context, params *DescribeListener type DescribeListenersInput struct { + // The Amazon Resource Names (ARN) of the listeners. + ListenerArns []*string + + // The Amazon Resource Name (ARN) of the load balancer. + LoadBalancerArn *string + // The marker for the next set of results. (You received this marker from a // previous call.) Marker *string - // The Amazon Resource Names (ARN) of the listeners. - ListenerArns []*string - // The maximum number of results to return with this call. PageSize *int32 - - // The Amazon Resource Name (ARN) of the load balancer. - LoadBalancerArn *string } type DescribeListenersOutput struct { diff --git a/service/elasticloadbalancingv2/api_op_DescribeLoadBalancers.go b/service/elasticloadbalancingv2/api_op_DescribeLoadBalancers.go index 8d32ef2220c..ee6f71e9fd3 100644 --- a/service/elasticloadbalancingv2/api_op_DescribeLoadBalancers.go +++ b/service/elasticloadbalancingv2/api_op_DescribeLoadBalancers.go @@ -59,19 +59,19 @@ func (c *Client) DescribeLoadBalancers(ctx context.Context, params *DescribeLoad type DescribeLoadBalancersInput struct { + // The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 + // load balancers in a single call. + LoadBalancerArns []*string + // The marker for the next set of results. (You received this marker from a // previous call.) Marker *string - // The maximum number of results to return with this call. - PageSize *int32 - // The names of the load balancers. Names []*string - // The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 - // load balancers in a single call. - LoadBalancerArns []*string + // The maximum number of results to return with this call. + PageSize *int32 } type DescribeLoadBalancersOutput struct { diff --git a/service/elasticloadbalancingv2/api_op_DescribeRules.go b/service/elasticloadbalancingv2/api_op_DescribeRules.go index 5acd0c23466..8d1675df12d 100644 --- a/service/elasticloadbalancingv2/api_op_DescribeRules.go +++ b/service/elasticloadbalancingv2/api_op_DescribeRules.go @@ -57,6 +57,9 @@ func (c *Client) DescribeRules(ctx context.Context, params *DescribeRulesInput, type DescribeRulesInput struct { + // The Amazon Resource Name (ARN) of the listener. + ListenerArn *string + // The marker for the next set of results. (You received this marker from a // previous call.) Marker *string @@ -66,20 +69,17 @@ type DescribeRulesInput struct { // The Amazon Resource Names (ARN) of the rules. RuleArns []*string - - // The Amazon Resource Name (ARN) of the listener. - ListenerArn *string } type DescribeRulesOutput struct { - // Information about the rules. - Rules []*types.Rule - // If there are additional results, this is the marker for the next set of results. // Otherwise, this is null. NextMarker *string + // Information about the rules. + Rules []*types.Rule + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticloadbalancingv2/api_op_DescribeSSLPolicies.go b/service/elasticloadbalancingv2/api_op_DescribeSSLPolicies.go index c0875dc40c1..9c5a05b4f00 100644 --- a/service/elasticloadbalancingv2/api_op_DescribeSSLPolicies.go +++ b/service/elasticloadbalancingv2/api_op_DescribeSSLPolicies.go @@ -63,22 +63,22 @@ type DescribeSSLPoliciesInput struct { // previous call.) Marker *string - // The maximum number of results to return with this call. - PageSize *int32 - // The names of the policies. Names []*string + + // The maximum number of results to return with this call. + PageSize *int32 } type DescribeSSLPoliciesOutput struct { - // Information about the security policies. - SslPolicies []*types.SslPolicy - // If there are additional results, this is the marker for the next set of results. // Otherwise, this is null. NextMarker *string + // Information about the security policies. + SslPolicies []*types.SslPolicy + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticloadbalancingv2/api_op_DescribeTargetGroups.go b/service/elasticloadbalancingv2/api_op_DescribeTargetGroups.go index c4c9437d5e1..3e3dcaf0d44 100644 --- a/service/elasticloadbalancingv2/api_op_DescribeTargetGroups.go +++ b/service/elasticloadbalancingv2/api_op_DescribeTargetGroups.go @@ -61,6 +61,9 @@ func (c *Client) DescribeTargetGroups(ctx context.Context, params *DescribeTarge type DescribeTargetGroupsInput struct { + // The Amazon Resource Name (ARN) of the load balancer. + LoadBalancerArn *string + // The marker for the next set of results. (You received this marker from a // previous call.) Marker *string @@ -68,9 +71,6 @@ type DescribeTargetGroupsInput struct { // The names of the target groups. Names []*string - // The Amazon Resource Name (ARN) of the load balancer. - LoadBalancerArn *string - // The maximum number of results to return with this call. PageSize *int32 diff --git a/service/elasticloadbalancingv2/api_op_DescribeTargetHealth.go b/service/elasticloadbalancingv2/api_op_DescribeTargetHealth.go index fcd8d3adbaf..c6dd7f39699 100644 --- a/service/elasticloadbalancingv2/api_op_DescribeTargetHealth.go +++ b/service/elasticloadbalancingv2/api_op_DescribeTargetHealth.go @@ -57,13 +57,13 @@ func (c *Client) DescribeTargetHealth(ctx context.Context, params *DescribeTarge type DescribeTargetHealthInput struct { - // The targets. - Targets []*types.TargetDescription - // The Amazon Resource Name (ARN) of the target group. // // This member is required. TargetGroupArn *string + + // The targets. + Targets []*types.TargetDescription } type DescribeTargetHealthOutput struct { diff --git a/service/elasticloadbalancingv2/api_op_ModifyListener.go b/service/elasticloadbalancingv2/api_op_ModifyListener.go index 8323d068ea4..388fbe1ac7d 100644 --- a/service/elasticloadbalancingv2/api_op_ModifyListener.go +++ b/service/elasticloadbalancingv2/api_op_ModifyListener.go @@ -64,8 +64,36 @@ func (c *Client) ModifyListener(ctx context.Context, params *ModifyListenerInput type ModifyListenerInput struct { - // The port for connections from clients to the load balancer. - Port *int32 + // The Amazon Resource Name (ARN) of the listener. + // + // This member is required. + ListenerArn *string + + // [TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) + // policy. You can specify one policy name. The following are the possible + // values: + // + // * HTTP1Only + // + // * HTTP2Only + // + // * HTTP2Optional + // + // * + // HTTP2Preferred + // + // * None + // + // For more information, see ALPN Policies + // (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#alpn-policies) + // in the Network Load Balancers Guide. + AlpnPolicy []*string + + // [HTTPS and TLS listeners] The default certificate for the listener. You must + // provide exactly one certificate. Set CertificateArn to the certificate ARN but + // do not set IsDefault. To create a certificate list, use AddListenerCertificates + // (). + Certificates []*types.Certificate // The actions for the default rule. The rule must include one forward action or // one or more fixed-response actions. If the action type is forward, you specify @@ -81,6 +109,14 @@ type ModifyListenerInput struct { // drop specified client requests and return a custom HTTP response. DefaultActions []*types.Action + // The port for connections from clients to the load balancer. + Port *int32 + + // The protocol for connections from clients to the load balancer. Application Load + // Balancers support the HTTP and HTTPS protocols. Network Load Balancers support + // the TCP, TLS, UDP, and TCP_UDP protocols. + Protocol types.ProtocolEnum + // [HTTPS and TLS listeners] The security policy that defines which protocols and // ciphers are supported. The following are the possible values: // @@ -114,42 +150,6 @@ type ModifyListenerInput struct { // (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) // in the Network Load Balancers Guide. SslPolicy *string - - // The protocol for connections from clients to the load balancer. Application Load - // Balancers support the HTTP and HTTPS protocols. Network Load Balancers support - // the TCP, TLS, UDP, and TCP_UDP protocols. - Protocol types.ProtocolEnum - - // [TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) - // policy. You can specify one policy name. The following are the possible - // values: - // - // * HTTP1Only - // - // * HTTP2Only - // - // * HTTP2Optional - // - // * - // HTTP2Preferred - // - // * None - // - // For more information, see ALPN Policies - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#alpn-policies) - // in the Network Load Balancers Guide. - AlpnPolicy []*string - - // The Amazon Resource Name (ARN) of the listener. - // - // This member is required. - ListenerArn *string - - // [HTTPS and TLS listeners] The default certificate for the listener. You must - // provide exactly one certificate. Set CertificateArn to the certificate ARN but - // do not set IsDefault. To create a certificate list, use AddListenerCertificates - // (). - Certificates []*types.Certificate } type ModifyListenerOutput struct { diff --git a/service/elasticloadbalancingv2/api_op_ModifyRule.go b/service/elasticloadbalancingv2/api_op_ModifyRule.go index 102b9efa675..7d132b3e015 100644 --- a/service/elasticloadbalancingv2/api_op_ModifyRule.go +++ b/service/elasticloadbalancingv2/api_op_ModifyRule.go @@ -66,11 +66,6 @@ type ModifyRuleInput struct { // This member is required. RuleArn *string - // The conditions. Each rule can include zero or one of the following conditions: - // http-request-method, host-header, path-pattern, and source-ip, and zero or more - // of the following conditions: http-header and query-string. - Conditions []*types.RuleCondition - // The actions. Each rule must include exactly one of the following types of // actions: forward, fixed-response, or redirect, and it must be the last action to // be performed. If the action type is forward, you specify one or more target @@ -85,6 +80,11 @@ type ModifyRuleInput struct { // Balancer] If the action type is fixed-response, you drop specified client // requests and return a custom HTTP response. Actions []*types.Action + + // The conditions. Each rule can include zero or one of the following conditions: + // http-request-method, host-header, path-pattern, and source-ip, and zero or more + // of the following conditions: http-header and query-string. + Conditions []*types.RuleCondition } type ModifyRuleOutput struct { diff --git a/service/elasticloadbalancingv2/api_op_ModifyTargetGroup.go b/service/elasticloadbalancingv2/api_op_ModifyTargetGroup.go index ab76eb37f29..f67a1f4c039 100644 --- a/service/elasticloadbalancingv2/api_op_ModifyTargetGroup.go +++ b/service/elasticloadbalancingv2/api_op_ModifyTargetGroup.go @@ -59,15 +59,13 @@ func (c *Client) ModifyTargetGroup(ctx context.Context, params *ModifyTargetGrou type ModifyTargetGroupInput struct { - // The number of consecutive health check failures required before considering the - // target unhealthy. For Network Load Balancers, this value must be the same as the - // healthy threshold count. - UnhealthyThresholdCount *int32 + // The Amazon Resource Name (ARN) of the target group. + // + // This member is required. + TargetGroupArn *string - // [HTTP/HTTPS health checks] The amount of time, in seconds, during which no - // response means a failed health check. With Network Load Balancers, you can't - // modify this setting. - HealthCheckTimeoutSeconds *int32 + // Indicates whether health checks are enabled. + HealthCheckEnabled *bool // The approximate amount of time, in seconds, between health checks of an // individual target. For Application Load Balancers, the range is 5 to 300 @@ -75,26 +73,12 @@ type ModifyTargetGroupInput struct { // With Network Load Balancers, you can't modify this setting. HealthCheckIntervalSeconds *int32 - // Indicates whether health checks are enabled. - HealthCheckEnabled *bool - - // [HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful - // response from a target. With Network Load Balancers, you can't modify this - // setting. - Matcher *types.Matcher - - // The number of consecutive health checks successes required before considering an - // unhealthy target healthy. - HealthyThresholdCount *int32 - // [HTTP/HTTPS health checks] The ping path that is the destination for the health // check request. HealthCheckPath *string - // The Amazon Resource Name (ARN) of the target group. - // - // This member is required. - TargetGroupArn *string + // The port the load balancer uses when performing health checks on targets. + HealthCheckPort *string // The protocol the load balancer uses when performing health checks on targets. // The TCP protocol is supported for health checks only if the protocol of the @@ -103,8 +87,24 @@ type ModifyTargetGroupInput struct { // modify this setting. HealthCheckProtocol types.ProtocolEnum - // The port the load balancer uses when performing health checks on targets. - HealthCheckPort *string + // [HTTP/HTTPS health checks] The amount of time, in seconds, during which no + // response means a failed health check. With Network Load Balancers, you can't + // modify this setting. + HealthCheckTimeoutSeconds *int32 + + // The number of consecutive health checks successes required before considering an + // unhealthy target healthy. + HealthyThresholdCount *int32 + + // [HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful + // response from a target. With Network Load Balancers, you can't modify this + // setting. + Matcher *types.Matcher + + // The number of consecutive health check failures required before considering the + // target unhealthy. For Network Load Balancers, this value must be the same as the + // healthy threshold count. + UnhealthyThresholdCount *int32 } type ModifyTargetGroupOutput struct { diff --git a/service/elasticloadbalancingv2/api_op_ModifyTargetGroupAttributes.go b/service/elasticloadbalancingv2/api_op_ModifyTargetGroupAttributes.go index 33c6732ad08..8ec805eb84b 100644 --- a/service/elasticloadbalancingv2/api_op_ModifyTargetGroupAttributes.go +++ b/service/elasticloadbalancingv2/api_op_ModifyTargetGroupAttributes.go @@ -57,15 +57,15 @@ func (c *Client) ModifyTargetGroupAttributes(ctx context.Context, params *Modify type ModifyTargetGroupAttributesInput struct { - // The Amazon Resource Name (ARN) of the target group. + // The attributes. // // This member is required. - TargetGroupArn *string + Attributes []*types.TargetGroupAttribute - // The attributes. + // The Amazon Resource Name (ARN) of the target group. // // This member is required. - Attributes []*types.TargetGroupAttribute + TargetGroupArn *string } type ModifyTargetGroupAttributesOutput struct { diff --git a/service/elasticloadbalancingv2/api_op_RegisterTargets.go b/service/elasticloadbalancingv2/api_op_RegisterTargets.go index b8f1c44de89..e8355ecce54 100644 --- a/service/elasticloadbalancingv2/api_op_RegisterTargets.go +++ b/service/elasticloadbalancingv2/api_op_RegisterTargets.go @@ -67,17 +67,17 @@ func (c *Client) RegisterTargets(ctx context.Context, params *RegisterTargetsInp type RegisterTargetsInput struct { + // The Amazon Resource Name (ARN) of the target group. + // + // This member is required. + TargetGroupArn *string + // The targets. To register a target by instance ID, specify the instance ID. To // register a target by IP address, specify the IP address. To register a Lambda // function, specify the ARN of the Lambda function. // // This member is required. Targets []*types.TargetDescription - - // The Amazon Resource Name (ARN) of the target group. - // - // This member is required. - TargetGroupArn *string } type RegisterTargetsOutput struct { diff --git a/service/elasticloadbalancingv2/api_op_RemoveTags.go b/service/elasticloadbalancingv2/api_op_RemoveTags.go index f91257a96b4..92b230601d7 100644 --- a/service/elasticloadbalancingv2/api_op_RemoveTags.go +++ b/service/elasticloadbalancingv2/api_op_RemoveTags.go @@ -57,15 +57,15 @@ func (c *Client) RemoveTags(ctx context.Context, params *RemoveTagsInput, optFns type RemoveTagsInput struct { - // The tag keys for the tags to remove. + // The Amazon Resource Name (ARN) of the resource. // // This member is required. - TagKeys []*string + ResourceArns []*string - // The Amazon Resource Name (ARN) of the resource. + // The tag keys for the tags to remove. // // This member is required. - ResourceArns []*string + TagKeys []*string } type RemoveTagsOutput struct { diff --git a/service/elasticloadbalancingv2/api_op_SetIpAddressType.go b/service/elasticloadbalancingv2/api_op_SetIpAddressType.go index 06c9f565d48..59b70f63d70 100644 --- a/service/elasticloadbalancingv2/api_op_SetIpAddressType.go +++ b/service/elasticloadbalancingv2/api_op_SetIpAddressType.go @@ -58,17 +58,17 @@ func (c *Client) SetIpAddressType(ctx context.Context, params *SetIpAddressTypeI type SetIpAddressTypeInput struct { - // The Amazon Resource Name (ARN) of the load balancer. - // - // This member is required. - LoadBalancerArn *string - // The IP address type. The possible values are ipv4 (for IPv4 addresses) and // dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use ipv4. // Network Load Balancers must use ipv4. // // This member is required. IpAddressType types.IpAddressType + + // The Amazon Resource Name (ARN) of the load balancer. + // + // This member is required. + LoadBalancerArn *string } type SetIpAddressTypeOutput struct { diff --git a/service/elasticloadbalancingv2/api_op_SetSubnets.go b/service/elasticloadbalancingv2/api_op_SetSubnets.go index 5b4b3041391..b7b4da82f9c 100644 --- a/service/elasticloadbalancingv2/api_op_SetSubnets.go +++ b/service/elasticloadbalancingv2/api_op_SetSubnets.go @@ -66,11 +66,6 @@ type SetSubnetsInput struct { // This member is required. LoadBalancerArn *string - // The IDs of the public subnets. You must specify subnets from at least two - // Availability Zones. You can specify only one subnet per Availability Zone. You - // must specify either subnets or subnet mappings. - Subnets []*string - // The IDs of the public subnets. You can specify only one subnet per Availability // Zone. You must specify either subnets or subnet mappings. [Application Load // Balancers] You must specify subnets from at least two Availability Zones. You @@ -80,6 +75,11 @@ type SetSubnetsInput struct { // IP address per subnet. For internal load balancers, you can specify one private // IP address per subnet from the IPv4 range of the subnet. SubnetMappings []*types.SubnetMapping + + // The IDs of the public subnets. You must specify subnets from at least two + // Availability Zones. You can specify only one subnet per Availability Zone. You + // must specify either subnets or subnet mappings. + Subnets []*string } type SetSubnetsOutput struct { diff --git a/service/elasticloadbalancingv2/go.mod b/service/elasticloadbalancingv2/go.mod index 708ad0b638f..950766db928 100644 --- a/service/elasticloadbalancingv2/go.mod +++ b/service/elasticloadbalancingv2/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/elasticloadbalancingv2 go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/elasticloadbalancingv2/types/types.go b/service/elasticloadbalancingv2/types/types.go index a13fb256202..ea36828c30f 100644 --- a/service/elasticloadbalancingv2/types/types.go +++ b/service/elasticloadbalancingv2/types/types.go @@ -9,6 +9,23 @@ import ( // Information about an action. type Action struct { + // The type of action. + // + // This member is required. + Type ActionTypeEnum + + // [HTTPS listeners] Information for using Amazon Cognito to authenticate users. + // Specify only when Type is authenticate-cognito. + AuthenticateCognitoConfig *AuthenticateCognitoActionConfig + + // [HTTPS listeners] Information about an identity provider that is compliant with + // OpenID Connect (OIDC). Specify only when Type is authenticate-oidc. + AuthenticateOidcConfig *AuthenticateOidcActionConfig + + // [Application Load Balancer] Information for creating an action that returns a + // custom HTTP response. Specify only when Type is fixed-response. + FixedResponseConfig *FixedResponseActionConfig + // Information for creating an action that distributes requests among one or more // target groups. For Network Load Balancers, you can specify a single target // group. Specify only when Type is forward. If you specify both ForwardConfig and @@ -16,47 +33,26 @@ type Action struct { // must be the same target group specified in TargetGroupArn. ForwardConfig *ForwardActionConfig + // The order for the action. This value is required for rules with multiple + // actions. The action with the lowest value for order is performed first. The last + // action to be performed must be one of the following types of actions: a forward, + // fixed-response, or redirect. + Order *int32 + // [Application Load Balancer] Information for creating a redirect action. Specify // only when Type is redirect. RedirectConfig *RedirectActionConfig - // [Application Load Balancer] Information for creating an action that returns a - // custom HTTP response. Specify only when Type is fixed-response. - FixedResponseConfig *FixedResponseActionConfig - // The Amazon Resource Name (ARN) of the target group. Specify only when Type is // forward and you want to route to a single target group. To route to one or more // target groups, use ForwardConfig instead. TargetGroupArn *string - - // The order for the action. This value is required for rules with multiple - // actions. The action with the lowest value for order is performed first. The last - // action to be performed must be one of the following types of actions: a forward, - // fixed-response, or redirect. - Order *int32 - - // [HTTPS listeners] Information for using Amazon Cognito to authenticate users. - // Specify only when Type is authenticate-cognito. - AuthenticateCognitoConfig *AuthenticateCognitoActionConfig - - // The type of action. - // - // This member is required. - Type ActionTypeEnum - - // [HTTPS listeners] Information about an identity provider that is compliant with - // OpenID Connect (OIDC). Specify only when Type is authenticate-oidc. - AuthenticateOidcConfig *AuthenticateOidcActionConfig } // Request parameters to use when integrating with Amazon Cognito to authenticate // users. type AuthenticateCognitoActionConfig struct { - // The query parameters (up to 10) to include in the redirect request to the - // authorization endpoint. - AuthenticationRequestExtraParams map[string]*string - // The Amazon Resource Name (ARN) of the Amazon Cognito user pool. // // This member is required. @@ -67,24 +63,15 @@ type AuthenticateCognitoActionConfig struct { // This member is required. UserPoolClientId *string - // The maximum duration of the authentication session, in seconds. The default is - // 604800 seconds (7 days). - SessionTimeout *int64 - - // The set of user claims to be requested from the IdP. The default is openid. To - // verify which scope values your IdP supports and how to separate multiple values, - // see the documentation for your IdP. - Scope *string - // The domain prefix or fully-qualified domain name of the Amazon Cognito user // pool. // // This member is required. UserPoolDomain *string - // The name of the cookie used to maintain session information. The default is - // AWSELBAuthSessionCookie. - SessionCookieName *string + // The query parameters (up to 10) to include in the redirect request to the + // authorization endpoint. + AuthenticationRequestExtraParams map[string]*string // The behavior if the user is not authenticated. The following are possible // values: @@ -97,22 +84,35 @@ type AuthenticateCognitoActionConfig struct { // * authenticate - Redirect // the request to the IdP authorization endpoint. This is the default value. OnUnauthenticatedRequest AuthenticateCognitoActionConditionalBehaviorEnum + + // The set of user claims to be requested from the IdP. The default is openid. To + // verify which scope values your IdP supports and how to separate multiple values, + // see the documentation for your IdP. + Scope *string + + // The name of the cookie used to maintain session information. The default is + // AWSELBAuthSessionCookie. + SessionCookieName *string + + // The maximum duration of the authentication session, in seconds. The default is + // 604800 seconds (7 days). + SessionTimeout *int64 } // Request parameters when using an identity provider (IdP) that is compliant with // OpenID Connect (OIDC) to authenticate users. type AuthenticateOidcActionConfig struct { - // The OAuth 2.0 client secret. This parameter is required if you are creating a - // rule. If you are modifying a rule, you can omit this parameter if you set - // UseExistingClientSecret to true. - ClientSecret *string + // The authorization endpoint of the IdP. This must be a full URL, including the + // HTTPS protocol, the domain, and the path. + // + // This member is required. + AuthorizationEndpoint *string - // The token endpoint of the IdP. This must be a full URL, including the HTTPS - // protocol, the domain, and the path. + // The OAuth 2.0 client identifier. // // This member is required. - TokenEndpoint *string + ClientId *string // The OIDC issuer identifier of the IdP. This must be a full URL, including the // HTTPS protocol, the domain, and the path. @@ -120,20 +120,27 @@ type AuthenticateOidcActionConfig struct { // This member is required. Issuer *string - // The authorization endpoint of the IdP. This must be a full URL, including the - // HTTPS protocol, the domain, and the path. + // The token endpoint of the IdP. This must be a full URL, including the HTTPS + // protocol, the domain, and the path. // // This member is required. - AuthorizationEndpoint *string + TokenEndpoint *string - // The maximum duration of the authentication session, in seconds. The default is - // 604800 seconds (7 days). - SessionTimeout *int64 + // The user info endpoint of the IdP. This must be a full URL, including the HTTPS + // protocol, the domain, and the path. + // + // This member is required. + UserInfoEndpoint *string // The query parameters (up to 10) to include in the redirect request to the // authorization endpoint. AuthenticationRequestExtraParams map[string]*string + // The OAuth 2.0 client secret. This parameter is required if you are creating a + // rule. If you are modifying a rule, you can omit this parameter if you set + // UseExistingClientSecret to true. + ClientSecret *string + // The behavior if the user is not authenticated. The following are possible // values: // @@ -146,25 +153,18 @@ type AuthenticateOidcActionConfig struct { // the request to the IdP authorization endpoint. This is the default value. OnUnauthenticatedRequest AuthenticateOidcActionConditionalBehaviorEnum - // The name of the cookie used to maintain session information. The default is - // AWSELBAuthSessionCookie. - SessionCookieName *string - // The set of user claims to be requested from the IdP. The default is openid. To // verify which scope values your IdP supports and how to separate multiple values, // see the documentation for your IdP. Scope *string - // The user info endpoint of the IdP. This must be a full URL, including the HTTPS - // protocol, the domain, and the path. - // - // This member is required. - UserInfoEndpoint *string + // The name of the cookie used to maintain session information. The default is + // AWSELBAuthSessionCookie. + SessionCookieName *string - // The OAuth 2.0 client identifier. - // - // This member is required. - ClientId *string + // The maximum duration of the authentication session, in seconds. The default is + // 604800 seconds (7 days). + SessionTimeout *int64 // Indicates whether to use the existing client secret when modifying a rule. If // you are creating a rule, you can omit this parameter or set it to false. @@ -190,14 +190,14 @@ type AvailabilityZone struct { // Information about an SSL server certificate. type Certificate struct { + // The Amazon Resource Name (ARN) of the certificate. + CertificateArn *string + // Indicates whether the certificate is the default certificate. Do not set this // value when specifying a certificate as an input. This value is not included in // the output when describing a listener, but is included when describing listener // certificates. IsDefault *bool - - // The Amazon Resource Name (ARN) of the certificate. - CertificateArn *string } // Information about a cipher used in a policy. @@ -218,12 +218,12 @@ type FixedResponseActionConfig struct { // This member is required. StatusCode *string - // The message. - MessageBody *string - // The content type. Valid Values: text/plain | text/css | text/html | // application/javascript | application/json ContentType *string + + // The message. + MessageBody *string } // Information about a forward action. @@ -333,9 +333,22 @@ type Limit struct { // Information about a listener. type Listener struct { + // [TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) + // policy. + AlpnPolicy []*string + // [HTTPS or TLS listener] The default certificate for the listener. Certificates []*Certificate + // The default actions for the listener. + DefaultActions []*Action + + // The Amazon Resource Name (ARN) of the listener. + ListenerArn *string + + // The Amazon Resource Name (ARN) of the load balancer. + LoadBalancerArn *string + // The port on which the load balancer is listening. Port *int32 @@ -345,36 +358,34 @@ type Listener struct { // [HTTPS or TLS listener] The security policy that defines which protocols and // ciphers are supported. SslPolicy *string - - // The default actions for the listener. - DefaultActions []*Action - - // The Amazon Resource Name (ARN) of the load balancer. - LoadBalancerArn *string - - // [TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) - // policy. - AlpnPolicy []*string - - // The Amazon Resource Name (ARN) of the listener. - ListenerArn *string } // Information about a load balancer. type LoadBalancer struct { - // The state of the load balancer. - State *LoadBalancerState + // The Availability Zones for the load balancer. + AvailabilityZones []*AvailabilityZone // The ID of the Amazon Route 53 hosted zone associated with the load balancer. CanonicalHostedZoneId *string - // The name of the load balancer. - LoadBalancerName *string + // The date and time the load balancer was created. + CreatedTime *time.Time // The public DNS name of the load balancer. DNSName *string + // The type of IP addresses used by the subnets for your load balancer. The + // possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 + // addresses). + IpAddressType IpAddressType + + // The Amazon Resource Name (ARN) of the load balancer. + LoadBalancerArn *string + + // The name of the load balancer. + LoadBalancerName *string + // The nodes of an Internet-facing load balancer have public IP addresses. The DNS // name of an Internet-facing load balancer is publicly resolvable to the public IP // addresses of the nodes. Therefore, Internet-facing load balancers can route @@ -385,26 +396,15 @@ type LoadBalancer struct { // VPC for the load balancer. Scheme LoadBalancerSchemeEnum - // The date and time the load balancer was created. - CreatedTime *time.Time - // The IDs of the security groups for the load balancer. SecurityGroups []*string - // The type of IP addresses used by the subnets for your load balancer. The - // possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 - // addresses). - IpAddressType IpAddressType - - // The Availability Zones for the load balancer. - AvailabilityZones []*AvailabilityZone + // The state of the load balancer. + State *LoadBalancerState // The type of load balancer. Type LoadBalancerTypeEnum - // The Amazon Resource Name (ARN) of the load balancer. - LoadBalancerArn *string - // The ID of the VPC for the load balancer. VpcId *string } @@ -412,13 +412,13 @@ type LoadBalancer struct { // Information about a static IP address for a load balancer. type LoadBalancerAddress struct { - // The static IP address. - IpAddress *string - // [Network Load Balancers] The allocation ID of the Elastic IP address for an // internal-facing load balancer. AllocationId *string + // The static IP address. + IpAddress *string + // [Network Load Balancers] The private IPv4 address for an internal load balancer. PrivateIPv4Address *string } @@ -561,24 +561,12 @@ type QueryStringKeyValuePair struct { // "#{query}&value=xyz". type RedirectActionConfig struct { - // The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP - // to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP. - Protocol *string - // The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary // (HTTP 302). // // This member is required. StatusCode RedirectActionStatusCodeEnum - // The query parameters, URL-encoded when necessary, but not percent-encoded. Do - // not include the leading "?", as it is automatically added. You can specify any - // of the reserved keywords. - Query *string - - // The port. You can specify a value from 1 to 65535 or #{port}. - Port *string - // The hostname. This component is not percent-encoded. The hostname can contain // #{host}. Host *string @@ -586,19 +574,22 @@ type RedirectActionConfig struct { // The absolute path, starting with the leading "/". This component is not // percent-encoded. The path can contain #{host}, #{path}, and #{port}. Path *string -} -// Information about a rule. -type Rule struct { + // The port. You can specify a value from 1 to 65535 or #{port}. + Port *string - // Indicates whether this is the default rule. - IsDefault *bool + // The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP + // to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP. + Protocol *string - // The Amazon Resource Name (ARN) of the rule. - RuleArn *string + // The query parameters, URL-encoded when necessary, but not percent-encoded. Do + // not include the leading "?", as it is automatically added. You can specify any + // of the reserved keywords. + Query *string +} - // The priority. - Priority *string +// Information about a rule. +type Rule struct { // The actions. Each rule must include exactly one of the following types of // actions: forward, redirect, or fixed-response, and it must be the last action to @@ -609,11 +600,40 @@ type Rule struct { // http-request-method, host-header, path-pattern, and source-ip, and zero or more // of the following conditions: http-header and query-string. Conditions []*RuleCondition + + // Indicates whether this is the default rule. + IsDefault *bool + + // The priority. + Priority *string + + // The Amazon Resource Name (ARN) of the rule. + RuleArn *string } // Information about a condition for a rule. type RuleCondition struct { + // The field in the HTTP request. The following are the possible values: + // + // * + // http-header + // + // * http-request-method + // + // * host-header + // + // * path-pattern + // + // + // * query-string + // + // * source-ip + Field *string + + // Information for a host header condition. Specify only when Field is host-header. + HostHeaderConfig *HostHeaderConditionConfig + // Information for an HTTP header condition. Specify only when Field is // http-header. HttpHeaderConfig *HttpHeaderConditionConfig @@ -622,6 +642,17 @@ type RuleCondition struct { // http-request-method. HttpRequestMethodConfig *HttpRequestMethodConditionConfig + // Information for a path pattern condition. Specify only when Field is + // path-pattern. + PathPatternConfig *PathPatternConditionConfig + + // Information for a query string condition. Specify only when Field is + // query-string. + QueryStringConfig *QueryStringConditionConfig + + // Information for a source IP condition. Specify only when Field is source-ip. + SourceIpConfig *SourceIpConditionConfig + // The condition value. You can use Values if the rule contains only host-header // and path-pattern conditions. Otherwise, you can use HostHeaderConfig for // host-header conditions and PathPatternConfig for path-pattern conditions. If @@ -655,37 +686,6 @@ type RuleCondition struct { // // * ? (matches exactly 1 character) Values []*string - - // Information for a source IP condition. Specify only when Field is source-ip. - SourceIpConfig *SourceIpConditionConfig - - // Information for a query string condition. Specify only when Field is - // query-string. - QueryStringConfig *QueryStringConditionConfig - - // Information for a path pattern condition. Specify only when Field is - // path-pattern. - PathPatternConfig *PathPatternConditionConfig - - // The field in the HTTP request. The following are the possible values: - // - // * - // http-header - // - // * http-request-method - // - // * host-header - // - // * path-pattern - // - // - // * query-string - // - // * source-ip - Field *string - - // Information for a host header condition. Specify only when Field is host-header. - HostHeaderConfig *HostHeaderConditionConfig } // Information about the priorities for the rules for a listener. @@ -719,11 +719,11 @@ type SslPolicy struct { // The ciphers. Ciphers []*Cipher - // The protocols. - SslProtocols []*string - // The name of the policy. Name *string + + // The protocols. + SslProtocols []*string } // Information about a subnet mapping. @@ -733,23 +733,23 @@ type SubnetMapping struct { // internet-facing load balancer. AllocationId *string - // The ID of the subnet. - SubnetId *string - // [Network Load Balancers] The private IPv4 address for an internal load balancer. PrivateIPv4Address *string + + // The ID of the subnet. + SubnetId *string } // Information about a tag. type Tag struct { - // The value of the tag. - Value *string - // The key of the tag. // // This member is required. Key *string + + // The value of the tag. + Value *string } // The tags associated with a resource. @@ -772,10 +772,6 @@ type TargetDescription struct { // This member is required. Id *string - // The port on which the target is listening. Not used if the target is a Lambda - // function. - Port *int32 - // An Availability Zone or all. This determines whether the target receives traffic // from the load balancer nodes in the specified Availability Zone or from all // enabled Availability Zones for the load balancer. This parameter is not @@ -788,14 +784,30 @@ type TargetDescription struct { // target type is lambda, this parameter is optional and the only supported value // is all. AvailabilityZone *string + + // The port on which the target is listening. Not used if the target is a Lambda + // function. + Port *int32 } // Information about a target group. type TargetGroup struct { - // The number of consecutive health check failures required before considering the - // target unhealthy. - UnhealthyThresholdCount *int32 + // Indicates whether health checks are enabled. + HealthCheckEnabled *bool + + // The approximate amount of time, in seconds, between health checks of an + // individual target. + HealthCheckIntervalSeconds *int32 + + // The destination for the health check request. + HealthCheckPath *string + + // The port to use to connect with the target. + HealthCheckPort *string + + // The protocol to use to connect with the target. + HealthCheckProtocol ProtocolEnum // The amount of time, in seconds, during which no response means a failed health // check. @@ -805,19 +817,23 @@ type TargetGroup struct { // unhealthy target healthy. HealthyThresholdCount *int32 - // The approximate amount of time, in seconds, between health checks of an - // individual target. - HealthCheckIntervalSeconds *int32 + // The Amazon Resource Names (ARN) of the load balancers that route traffic to this + // target group. + LoadBalancerArns []*string - // Indicates whether health checks are enabled. - HealthCheckEnabled *bool + // The HTTP codes to use when checking for a successful response from a target. + Matcher *Matcher - // The ID of the VPC for the targets. - VpcId *string + // The port on which the targets are listening. Not used if the target is a Lambda + // function. + Port *int32 // The protocol to use for routing traffic to the targets. Protocol ProtocolEnum + // The Amazon Resource Name (ARN) of the target group. + TargetGroupArn *string + // The name of the target group. TargetGroupName *string @@ -826,36 +842,17 @@ type TargetGroup struct { // instance ID) or ip (targets are specified by IP address). TargetType TargetTypeEnum - // The HTTP codes to use when checking for a successful response from a target. - Matcher *Matcher - - // The destination for the health check request. - HealthCheckPath *string - - // The Amazon Resource Name (ARN) of the target group. - TargetGroupArn *string - - // The port on which the targets are listening. Not used if the target is a Lambda - // function. - Port *int32 - - // The protocol to use to connect with the target. - HealthCheckProtocol ProtocolEnum - - // The port to use to connect with the target. - HealthCheckPort *string + // The number of consecutive health check failures required before considering the + // target unhealthy. + UnhealthyThresholdCount *int32 - // The Amazon Resource Names (ARN) of the load balancers that route traffic to this - // target group. - LoadBalancerArns []*string + // The ID of the VPC for the targets. + VpcId *string } // Information about a target group attribute. type TargetGroupAttribute struct { - // The value of the attribute. - Value *string - // The name of the attribute.

    The following attributes are supported by both // Application Load Balancers and Network Load Balancers:

    • // deregistration_delay.timeout_seconds - The amount of time, in @@ -899,17 +896,20 @@ type TargetGroupAttribute struct { // true or false. The default is false.

      //
    Key *string + + // The value of the attribute. + Value *string } // Information about the target group stickiness for a rule. type TargetGroupStickinessConfig struct { - // Indicates whether target group stickiness is enabled. - Enabled *bool - // The time period, in seconds, during which requests from a client should be // routed to the same target group. The range is 1-604800 seconds (7 days). DurationSeconds *int32 + + // Indicates whether target group stickiness is enabled. + Enabled *bool } // Information about how traffic will be distributed between multiple target groups @@ -926,6 +926,10 @@ type TargetGroupTuple struct { // Information about the current health of a target. type TargetHealth struct { + // A description of the target health that provides additional details. If the + // state is healthy, a description is not provided. + Description *string + // The reason code.

    If the target state is healthy, a reason code // is not provided.

    If the target state is initial, the reason // code can be one of the following values:

    • @@ -963,10 +967,6 @@ type TargetHealth struct { // error. Applies only to Network Load Balancers.

    Reason TargetHealthReasonEnum - // A description of the target health that provides additional details. If the - // state is healthy, a description is not provided. - Description *string - // The state of the target. State TargetHealthStateEnum } diff --git a/service/elasticsearchservice/api_op_CreateElasticsearchDomain.go b/service/elasticsearchservice/api_op_CreateElasticsearchDomain.go index fffb9b68653..eb4b52ca031 100644 --- a/service/elasticsearchservice/api_op_CreateElasticsearchDomain.go +++ b/service/elasticsearchservice/api_op_CreateElasticsearchDomain.go @@ -60,63 +60,63 @@ func (c *Client) CreateElasticsearchDomain(ctx context.Context, params *CreateEl type CreateElasticsearchDomainInput struct { + // The name of the Elasticsearch domain that you are creating. Domain names are + // unique across the domains owned by an account within an AWS region. Domain names + // must start with a lowercase letter and can contain the following characters: a-z + // (lowercase), 0-9, and - (hyphen). + // + // This member is required. + DomainName *string + // IAM access policy as a JSON-formatted string. AccessPolicies *string + // Option to allow references to indices in an HTTP request body. Must be false + // when configuring access to individual sub-resources. By default, the value is + // true. See Configuration Advanced Options + // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options) + // for more information. + AdvancedOptions map[string]*string + + // Specifies advanced security options. + AdvancedSecurityOptions *types.AdvancedSecurityOptionsInput + + // Options to specify the Cognito user and identity pools for Kibana + // authentication. For more information, see Amazon Cognito Authentication for + // Kibana + // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html). + CognitoOptions *types.CognitoOptions + // Options to specify configuration that will be applied to the domain endpoint. DomainEndpointOptions *types.DomainEndpointOptions // Options to enable, disable and specify the type and size of EBS storage volumes. EBSOptions *types.EBSOptions + // Configuration options for an Elasticsearch domain. Specifies the instance type + // and number of instances in the domain cluster. + ElasticsearchClusterConfig *types.ElasticsearchClusterConfig + // String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" // or "2.3". For more information, see Creating Elasticsearch Domains // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains) // in the Amazon Elasticsearch Service Developer Guide. ElasticsearchVersion *string - // Configuration options for an Elasticsearch domain. Specifies the instance type - // and number of instances in the domain cluster. - ElasticsearchClusterConfig *types.ElasticsearchClusterConfig - - // Option to set time, in UTC format, of the daily automated snapshot. Default - // value is 0 hours. - SnapshotOptions *types.SnapshotOptions - - // Specifies advanced security options. - AdvancedSecurityOptions *types.AdvancedSecurityOptionsInput + // Specifies the Encryption At Rest Options. + EncryptionAtRestOptions *types.EncryptionAtRestOptions // Map of LogType and LogPublishingOption, each containing options to publish a // given type of Elasticsearch log. LogPublishingOptions map[string]*types.LogPublishingOption - // Specifies the Encryption At Rest Options. - EncryptionAtRestOptions *types.EncryptionAtRestOptions - - // Options to specify the Cognito user and identity pools for Kibana - // authentication. For more information, see Amazon Cognito Authentication for - // Kibana - // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html). - CognitoOptions *types.CognitoOptions - - // The name of the Elasticsearch domain that you are creating. Domain names are - // unique across the domains owned by an account within an AWS region. Domain names - // must start with a lowercase letter and can contain the following characters: a-z - // (lowercase), 0-9, and - (hyphen). - // - // This member is required. - DomainName *string - - // Option to allow references to indices in an HTTP request body. Must be false - // when configuring access to individual sub-resources. By default, the value is - // true. See Configuration Advanced Options - // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options) - // for more information. - AdvancedOptions map[string]*string - // Specifies the NodeToNodeEncryptionOptions. NodeToNodeEncryptionOptions *types.NodeToNodeEncryptionOptions + // Option to set time, in UTC format, of the daily automated snapshot. Default + // value is 0 hours. + SnapshotOptions *types.SnapshotOptions + // Options to specify the subnets and security groups for VPC endpoint. For more // information, see Creating a VPC // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-creating-vpc) diff --git a/service/elasticsearchservice/api_op_CreateOutboundCrossClusterSearchConnection.go b/service/elasticsearchservice/api_op_CreateOutboundCrossClusterSearchConnection.go index 467048615e3..8691b3fba7e 100644 --- a/service/elasticsearchservice/api_op_CreateOutboundCrossClusterSearchConnection.go +++ b/service/elasticsearchservice/api_op_CreateOutboundCrossClusterSearchConnection.go @@ -60,11 +60,6 @@ func (c *Client) CreateOutboundCrossClusterSearchConnection(ctx context.Context, // () operation. type CreateOutboundCrossClusterSearchConnectionInput struct { - // Specifies the DomainInformation () for the source Elasticsearch domain. - // - // This member is required. - SourceDomainInfo *types.DomainInformation - // Specifies the connection alias that will be used by the customer for this // connection. // @@ -75,17 +70,19 @@ type CreateOutboundCrossClusterSearchConnectionInput struct { // // This member is required. DestinationDomainInfo *types.DomainInformation + + // Specifies the DomainInformation () for the source Elasticsearch domain. + // + // This member is required. + SourceDomainInfo *types.DomainInformation } // The result of a CreateOutboundCrossClusterSearchConnection () request. Contains // the details of the newly created cross-cluster search connection. type CreateOutboundCrossClusterSearchConnectionOutput struct { - // Specifies the DomainInformation () for the source Elasticsearch domain. - SourceDomainInfo *types.DomainInformation - - // Specifies the DomainInformation () for the destination Elasticsearch domain. - DestinationDomainInfo *types.DomainInformation + // Specifies the connection alias provided during the create connection request. + ConnectionAlias *string // Specifies the OutboundCrossClusterSearchConnectionStatus () for the newly // created connection. @@ -95,8 +92,11 @@ type CreateOutboundCrossClusterSearchConnectionOutput struct { // operations on connection. CrossClusterSearchConnectionId *string - // Specifies the connection alias provided during the create connection request. - ConnectionAlias *string + // Specifies the DomainInformation () for the destination Elasticsearch domain. + DestinationDomainInfo *types.DomainInformation + + // Specifies the DomainInformation () for the source Elasticsearch domain. + SourceDomainInfo *types.DomainInformation // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/elasticsearchservice/api_op_CreatePackage.go b/service/elasticsearchservice/api_op_CreatePackage.go index 5f5456ce0a6..07a58420446 100644 --- a/service/elasticsearchservice/api_op_CreatePackage.go +++ b/service/elasticsearchservice/api_op_CreatePackage.go @@ -58,23 +58,23 @@ func (c *Client) CreatePackage(ctx context.Context, params *CreatePackageInput, // Container for request parameters to CreatePackage () operation. type CreatePackageInput struct { - // The customer S3 location PackageSource for importing the package. + // Unique identifier for the package. // // This member is required. - PackageSource *types.PackageSource - - // Description of the package. - PackageDescription *string + PackageName *string - // Unique identifier for the package. + // The customer S3 location PackageSource for importing the package. // // This member is required. - PackageName *string + PackageSource *types.PackageSource // Type of package. Currently supports only TXT-DICTIONARY. // // This member is required. PackageType types.PackageType + + // Description of the package. + PackageDescription *string } // Container for response returned by CreatePackage () operation. diff --git a/service/elasticsearchservice/api_op_DescribeElasticsearchInstanceTypeLimits.go b/service/elasticsearchservice/api_op_DescribeElasticsearchInstanceTypeLimits.go index a2c3951bf1d..4f2c4638519 100644 --- a/service/elasticsearchservice/api_op_DescribeElasticsearchInstanceTypeLimits.go +++ b/service/elasticsearchservice/api_op_DescribeElasticsearchInstanceTypeLimits.go @@ -61,16 +61,16 @@ func (c *Client) DescribeElasticsearchInstanceTypeLimits(ctx context.Context, pa // operation. type DescribeElasticsearchInstanceTypeLimitsInput struct { - // The instance type for an Elasticsearch cluster for which Elasticsearch Limits () - // are needed. + // Version of Elasticsearch for which Limits () are needed. // // This member is required. - InstanceType types.ESPartitionInstanceType + ElasticsearchVersion *string - // Version of Elasticsearch for which Limits () are needed. + // The instance type for an Elasticsearch cluster for which Elasticsearch Limits () + // are needed. // // This member is required. - ElasticsearchVersion *string + InstanceType types.ESPartitionInstanceType // DomainName represents the name of the Domain that we are trying to modify. This // should be present only if we are querying for Elasticsearch Limits () for diff --git a/service/elasticsearchservice/api_op_DescribeInboundCrossClusterSearchConnections.go b/service/elasticsearchservice/api_op_DescribeInboundCrossClusterSearchConnections.go index 94465b2c18c..501a64202f6 100644 --- a/service/elasticsearchservice/api_op_DescribeInboundCrossClusterSearchConnections.go +++ b/service/elasticsearchservice/api_op_DescribeInboundCrossClusterSearchConnections.go @@ -58,14 +58,6 @@ func (c *Client) DescribeInboundCrossClusterSearchConnections(ctx context.Contex // () operation. type DescribeInboundCrossClusterSearchConnectionsInput struct { - // NextToken is sent in case the earlier API call results contain the NextToken. It - // is used for pagination. - NextToken *string - - // Set this value to limit the number of results returned. If not specified, - // defaults to 100. - MaxResults *int32 - // A list of filters used to match properties for inbound cross-cluster search // connection. Available Filter () names for this operation are: // @@ -82,20 +74,28 @@ type DescribeInboundCrossClusterSearchConnectionsInput struct { // * // destination-domain-info.domain-name Filters []*types.Filter + + // Set this value to limit the number of results returned. If not specified, + // defaults to 100. + MaxResults *int32 + + // NextToken is sent in case the earlier API call results contain the NextToken. It + // is used for pagination. + NextToken *string } // The result of a DescribeInboundCrossClusterSearchConnections () request. // Contains the list of connections matching the filter criteria. type DescribeInboundCrossClusterSearchConnectionsOutput struct { - // If more results are available and NextToken is present, make the next request to - // the same API with the received NextToken to paginate the remaining results. - NextToken *string - // Consists of list of InboundCrossClusterSearchConnection () matching the // specified filter criteria. CrossClusterSearchConnections []*types.InboundCrossClusterSearchConnection + // If more results are available and NextToken is present, make the next request to + // the same API with the received NextToken to paginate the remaining results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticsearchservice/api_op_DescribeOutboundCrossClusterSearchConnections.go b/service/elasticsearchservice/api_op_DescribeOutboundCrossClusterSearchConnections.go index 1d78445bcf9..374c2e569de 100644 --- a/service/elasticsearchservice/api_op_DescribeOutboundCrossClusterSearchConnections.go +++ b/service/elasticsearchservice/api_op_DescribeOutboundCrossClusterSearchConnections.go @@ -58,14 +58,6 @@ func (c *Client) DescribeOutboundCrossClusterSearchConnections(ctx context.Conte // DescribeOutboundCrossClusterSearchConnections () operation. type DescribeOutboundCrossClusterSearchConnectionsInput struct { - // Set this value to limit the number of results returned. If not specified, - // defaults to 100. - MaxResults *int32 - - // NextToken is sent in case the earlier API call results contain the NextToken. It - // is used for pagination. - NextToken *string - // A list of filters used to match properties for outbound cross-cluster search // connection. Available Filter () names for this operation are: // @@ -82,20 +74,28 @@ type DescribeOutboundCrossClusterSearchConnectionsInput struct { // * // source-domain-info.domain-name Filters []*types.Filter + + // Set this value to limit the number of results returned. If not specified, + // defaults to 100. + MaxResults *int32 + + // NextToken is sent in case the earlier API call results contain the NextToken. It + // is used for pagination. + NextToken *string } // The result of a DescribeOutboundCrossClusterSearchConnections () request. // Contains the list of connections matching the filter criteria. type DescribeOutboundCrossClusterSearchConnectionsOutput struct { - // If more results are available and NextToken is present, make the next request to - // the same API with the received NextToken to paginate the remaining results. - NextToken *string - // Consists of list of OutboundCrossClusterSearchConnection () matching the // specified filter criteria. CrossClusterSearchConnections []*types.OutboundCrossClusterSearchConnection + // If more results are available and NextToken is present, make the next request to + // the same API with the received NextToken to paginate the remaining results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticsearchservice/api_op_DescribePackages.go b/service/elasticsearchservice/api_op_DescribePackages.go index ed0aa2fbe13..2e796ec002b 100644 --- a/service/elasticsearchservice/api_op_DescribePackages.go +++ b/service/elasticsearchservice/api_op_DescribePackages.go @@ -58,25 +58,24 @@ func (c *Client) DescribePackages(ctx context.Context, params *DescribePackagesI // Container for request parameters to DescribePackage () operation. type DescribePackagesInput struct { + // Only returns packages that match the DescribePackagesFilterList values. + Filters []*types.DescribePackagesFilter + // Limits results to a maximum number of packages. MaxResults *int32 // Used for pagination. Only necessary if a previous API call includes a non-null // NextToken value. If provided, returns results for the next page. NextToken *string - - // Only returns packages that match the DescribePackagesFilterList values. - Filters []*types.DescribePackagesFilter } // Container for response returned by DescribePackages () operation. type DescribePackagesOutput struct { + NextToken *string // List of PackageDetails objects. PackageDetailsList []*types.PackageDetails - NextToken *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticsearchservice/api_op_DescribeReservedElasticsearchInstanceOfferings.go b/service/elasticsearchservice/api_op_DescribeReservedElasticsearchInstanceOfferings.go index 4b0d5afc58d..f7c16f6240f 100644 --- a/service/elasticsearchservice/api_op_DescribeReservedElasticsearchInstanceOfferings.go +++ b/service/elasticsearchservice/api_op_DescribeReservedElasticsearchInstanceOfferings.go @@ -57,14 +57,14 @@ func (c *Client) DescribeReservedElasticsearchInstanceOfferings(ctx context.Cont // Container for parameters to DescribeReservedElasticsearchInstanceOfferings type DescribeReservedElasticsearchInstanceOfferingsInput struct { - // NextToken should be sent in case if earlier API call produced result containing - // NextToken. It is used for pagination. - NextToken *string - // Set this value to limit the number of results returned. If not specified, // defaults to 100. MaxResults *int32 + // NextToken should be sent in case if earlier API call produced result containing + // NextToken. It is used for pagination. + NextToken *string + // The offering identifier filter value. Use this parameter to show only the // available offering that matches the specified reservation identifier. ReservedElasticsearchInstanceOfferingId *string @@ -73,12 +73,12 @@ type DescribeReservedElasticsearchInstanceOfferingsInput struct { // Container for results from DescribeReservedElasticsearchInstanceOfferings type DescribeReservedElasticsearchInstanceOfferingsOutput struct { - // List of reserved Elasticsearch instance offerings - ReservedElasticsearchInstanceOfferings []*types.ReservedElasticsearchInstanceOffering - // Provides an identifier to allow retrieval of paginated results. NextToken *string + // List of reserved Elasticsearch instance offerings + ReservedElasticsearchInstanceOfferings []*types.ReservedElasticsearchInstanceOffering + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticsearchservice/api_op_DescribeReservedElasticsearchInstances.go b/service/elasticsearchservice/api_op_DescribeReservedElasticsearchInstances.go index 2af4a2a5263..878efbfbe8d 100644 --- a/service/elasticsearchservice/api_op_DescribeReservedElasticsearchInstances.go +++ b/service/elasticsearchservice/api_op_DescribeReservedElasticsearchInstances.go @@ -57,6 +57,10 @@ func (c *Client) DescribeReservedElasticsearchInstances(ctx context.Context, par // Container for parameters to DescribeReservedElasticsearchInstances type DescribeReservedElasticsearchInstancesInput struct { + // Set this value to limit the number of results returned. If not specified, + // defaults to 100. + MaxResults *int32 + // NextToken should be sent in case if earlier API call produced result containing // NextToken. It is used for pagination. NextToken *string @@ -64,10 +68,6 @@ type DescribeReservedElasticsearchInstancesInput struct { // The reserved instance identifier filter value. Use this parameter to show only // the reservation that matches the specified reserved Elasticsearch instance ID. ReservedElasticsearchInstanceId *string - - // Set this value to limit the number of results returned. If not specified, - // defaults to 100. - MaxResults *int32 } // Container for results from DescribeReservedElasticsearchInstances diff --git a/service/elasticsearchservice/api_op_DissociatePackage.go b/service/elasticsearchservice/api_op_DissociatePackage.go index 8f4ef9b71fe..0c945adfd24 100644 --- a/service/elasticsearchservice/api_op_DissociatePackage.go +++ b/service/elasticsearchservice/api_op_DissociatePackage.go @@ -58,16 +58,16 @@ func (c *Client) DissociatePackage(ctx context.Context, params *DissociatePackag // Container for request parameters to DissociatePackage () operation. type DissociatePackageInput struct { - // Internal ID of the package that you want to associate with a domain. Use - // DescribePackages to find this value. + // Name of the domain that you want to associate the package with. // // This member is required. - PackageID *string + DomainName *string - // Name of the domain that you want to associate the package with. + // Internal ID of the package that you want to associate with a domain. Use + // DescribePackages to find this value. // // This member is required. - DomainName *string + PackageID *string } // Container for response returned by DissociatePackage () operation. diff --git a/service/elasticsearchservice/api_op_GetUpgradeHistory.go b/service/elasticsearchservice/api_op_GetUpgradeHistory.go index f7cfa36289c..4f5bfd47df3 100644 --- a/service/elasticsearchservice/api_op_GetUpgradeHistory.go +++ b/service/elasticsearchservice/api_op_GetUpgradeHistory.go @@ -59,9 +59,6 @@ func (c *Client) GetUpgradeHistory(ctx context.Context, params *GetUpgradeHistor // Container for request parameters to GetUpgradeHistory () operation. type GetUpgradeHistoryInput struct { - // Set this value to limit the number of results returned. - MaxResults *int32 - // The name of an Elasticsearch domain. Domain names are unique across the domains // owned by an account within an AWS region. Domain names start with a letter or // number and can contain the following characters: a-z (lowercase), 0-9, and - @@ -70,6 +67,9 @@ type GetUpgradeHistoryInput struct { // This member is required. DomainName *string + // Set this value to limit the number of results returned. + MaxResults *int32 + // Paginated APIs accepts NextToken input to returns next page results and provides // a NextToken output in the response which can be used by the client to retrieve // more results. diff --git a/service/elasticsearchservice/api_op_GetUpgradeStatus.go b/service/elasticsearchservice/api_op_GetUpgradeStatus.go index 96c62b222f7..6d68a3eccb8 100644 --- a/service/elasticsearchservice/api_op_GetUpgradeStatus.go +++ b/service/elasticsearchservice/api_op_GetUpgradeStatus.go @@ -71,19 +71,6 @@ type GetUpgradeStatusInput struct { // Container for response returned by GetUpgradeStatus () operation. type GetUpgradeStatusOutput struct { - // A string that describes the update briefly - UpgradeName *string - - // Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does - // through: - // - // * PreUpgradeCheck - // - // * Snapshot - // - // * Upgrade - UpgradeStep types.UpgradeStep - // One of 4 statuses that a step can go through returned as part of the // GetUpgradeStatusResponse () object. The status can take one of the following // values: @@ -98,6 +85,19 @@ type GetUpgradeStatusOutput struct { // Failed StepStatus types.UpgradeStatus + // A string that describes the update briefly + UpgradeName *string + + // Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does + // through: + // + // * PreUpgradeCheck + // + // * Snapshot + // + // * Upgrade + UpgradeStep types.UpgradeStep + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticsearchservice/api_op_ListDomainsForPackage.go b/service/elasticsearchservice/api_op_ListDomainsForPackage.go index 43cd0ad30ff..0499c569ef3 100644 --- a/service/elasticsearchservice/api_op_ListDomainsForPackage.go +++ b/service/elasticsearchservice/api_op_ListDomainsForPackage.go @@ -58,26 +58,27 @@ func (c *Client) ListDomainsForPackage(ctx context.Context, params *ListDomainsF // Container for request parameters to ListDomainsForPackage () operation. type ListDomainsForPackageInput struct { - // Used for pagination. Only necessary if a previous API call includes a non-null - // NextToken value. If provided, returns results for the next page. - NextToken *string - - // Limits results to a maximum number of domains. - MaxResults *int32 - // The package for which to list domains. // // This member is required. PackageID *string + + // Limits results to a maximum number of domains. + MaxResults *int32 + + // Used for pagination. Only necessary if a previous API call includes a non-null + // NextToken value. If provided, returns results for the next page. + NextToken *string } // Container for response parameters to ListDomainsForPackage () operation. type ListDomainsForPackageOutput struct { - NextToken *string // List of DomainPackageDetails objects. DomainPackageDetailsList []*types.DomainPackageDetails + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticsearchservice/api_op_ListElasticsearchInstanceTypes.go b/service/elasticsearchservice/api_op_ListElasticsearchInstanceTypes.go index 9a713da4593..99fedc17b49 100644 --- a/service/elasticsearchservice/api_op_ListElasticsearchInstanceTypes.go +++ b/service/elasticsearchservice/api_op_ListElasticsearchInstanceTypes.go @@ -59,9 +59,11 @@ func (c *Client) ListElasticsearchInstanceTypes(ctx context.Context, params *Lis // Container for the parameters to the ListElasticsearchInstanceTypes () operation. type ListElasticsearchInstanceTypesInput struct { - // NextToken should be sent in case if earlier API call produced result containing - // NextToken. It is used for pagination. - NextToken *string + // Version of Elasticsearch for which list of supported elasticsearch instance + // types are needed. + // + // This member is required. + ElasticsearchVersion *string // DomainName represents the name of the Domain that we are trying to modify. This // should be present only if we are querying for list of available Elasticsearch @@ -72,11 +74,9 @@ type ListElasticsearchInstanceTypesInput struct { // greater than 30 else it wont be honored. MaxResults *int32 - // Version of Elasticsearch for which list of supported elasticsearch instance - // types are needed. - // - // This member is required. - ElasticsearchVersion *string + // NextToken should be sent in case if earlier API call produced result containing + // NextToken. It is used for pagination. + NextToken *string } // Container for the parameters returned by ListElasticsearchInstanceTypes () diff --git a/service/elasticsearchservice/api_op_ListElasticsearchVersions.go b/service/elasticsearchservice/api_op_ListElasticsearchVersions.go index cda6d504f9c..b2de4875594 100644 --- a/service/elasticsearchservice/api_op_ListElasticsearchVersions.go +++ b/service/elasticsearchservice/api_op_ListElasticsearchVersions.go @@ -74,14 +74,14 @@ type ListElasticsearchVersionsInput struct { // ListElasticsearchVersions () operation. type ListElasticsearchVersionsOutput struct { + // List of supported elastic search versions. + ElasticsearchVersions []*string + // Paginated APIs accepts NextToken input to returns next page results and provides // a NextToken output in the response which can be used by the client to retrieve // more results. NextToken *string - // List of supported elastic search versions. - ElasticsearchVersions []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticsearchservice/api_op_ListPackagesForDomain.go b/service/elasticsearchservice/api_op_ListPackagesForDomain.go index cf7993fc09f..82f702db1fd 100644 --- a/service/elasticsearchservice/api_op_ListPackagesForDomain.go +++ b/service/elasticsearchservice/api_op_ListPackagesForDomain.go @@ -74,13 +74,13 @@ type ListPackagesForDomainInput struct { // Container for response parameters to ListPackagesForDomain () operation. type ListPackagesForDomainOutput struct { + // List of DomainPackageDetails objects. + DomainPackageDetailsList []*types.DomainPackageDetails + // Pagination token that needs to be supplied to the next call to get the next page // of results. NextToken *string - // List of DomainPackageDetails objects. - DomainPackageDetailsList []*types.DomainPackageDetails - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticsearchservice/api_op_PurchaseReservedElasticsearchInstanceOffering.go b/service/elasticsearchservice/api_op_PurchaseReservedElasticsearchInstanceOffering.go index 8012a2e044a..1ab6f292360 100644 --- a/service/elasticsearchservice/api_op_PurchaseReservedElasticsearchInstanceOffering.go +++ b/service/elasticsearchservice/api_op_PurchaseReservedElasticsearchInstanceOffering.go @@ -57,30 +57,30 @@ func (c *Client) PurchaseReservedElasticsearchInstanceOffering(ctx context.Conte // Container for parameters to PurchaseReservedElasticsearchInstanceOffering type PurchaseReservedElasticsearchInstanceOfferingInput struct { - // The number of Elasticsearch instances to reserve. - InstanceCount *int32 + // A customer-specified identifier to track this reservation. + // + // This member is required. + ReservationName *string // The ID of the reserved Elasticsearch instance offering to purchase. // // This member is required. ReservedElasticsearchInstanceOfferingId *string - // A customer-specified identifier to track this reservation. - // - // This member is required. - ReservationName *string + // The number of Elasticsearch instances to reserve. + InstanceCount *int32 } // Represents the output of a PurchaseReservedElasticsearchInstanceOffering // operation. type PurchaseReservedElasticsearchInstanceOfferingOutput struct { - // Details of the reserved Elasticsearch instance which was purchased. - ReservedElasticsearchInstanceId *string - // The customer-specified identifier used to track this reservation. ReservationName *string + // Details of the reserved Elasticsearch instance which was purchased. + ReservedElasticsearchInstanceId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticsearchservice/api_op_UpdateElasticsearchDomainConfig.go b/service/elasticsearchservice/api_op_UpdateElasticsearchDomainConfig.go index 926084c3841..6797cb507a9 100644 --- a/service/elasticsearchservice/api_op_UpdateElasticsearchDomainConfig.go +++ b/service/elasticsearchservice/api_op_UpdateElasticsearchDomainConfig.go @@ -60,32 +60,23 @@ func (c *Client) UpdateElasticsearchDomainConfig(ctx context.Context, params *Up // Specifies the type and number of instances in the domain cluster. type UpdateElasticsearchDomainConfigInput struct { - // Specifies advanced security options. - AdvancedSecurityOptions *types.AdvancedSecurityOptionsInput - - // IAM access policy as a JSON-formatted string. - AccessPolicies *string - - // Options to specify configuration that will be applied to the domain endpoint. - DomainEndpointOptions *types.DomainEndpointOptions - - // Options to specify the subnets and security groups for VPC endpoint. For more - // information, see Creating a VPC - // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-creating-vpc) - // in VPC Endpoints for Amazon Elasticsearch Service Domains - VPCOptions *types.VPCOptions - - // The type and number of instances to instantiate for the domain cluster. - ElasticsearchClusterConfig *types.ElasticsearchClusterConfig - // The name of the Elasticsearch domain that you are updating. // // This member is required. DomainName *string - // Option to set the time, in UTC format, for the daily automated snapshot. Default - // value is 0 hours. - SnapshotOptions *types.SnapshotOptions + // IAM access policy as a JSON-formatted string. + AccessPolicies *string + + // Modifies the advanced option to allow references to indices in an HTTP request + // body. Must be false when configuring access to individual sub-resources. By + // default, the value is true. See Configuration Advanced Options + // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options) + // for more information. + AdvancedOptions map[string]*string + + // Specifies advanced security options. + AdvancedSecurityOptions *types.AdvancedSecurityOptionsInput // Options to specify the Cognito user and identity pools for Kibana // authentication. For more information, see Amazon Cognito Authentication for @@ -93,19 +84,28 @@ type UpdateElasticsearchDomainConfigInput struct { // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html). CognitoOptions *types.CognitoOptions + // Options to specify configuration that will be applied to the domain endpoint. + DomainEndpointOptions *types.DomainEndpointOptions + + // Specify the type and size of the EBS volume that you want to use. + EBSOptions *types.EBSOptions + + // The type and number of instances to instantiate for the domain cluster. + ElasticsearchClusterConfig *types.ElasticsearchClusterConfig + // Map of LogType and LogPublishingOption, each containing options to publish a // given type of Elasticsearch log. LogPublishingOptions map[string]*types.LogPublishingOption - // Modifies the advanced option to allow references to indices in an HTTP request - // body. Must be false when configuring access to individual sub-resources. By - // default, the value is true. See Configuration Advanced Options - // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options) - // for more information. - AdvancedOptions map[string]*string + // Option to set the time, in UTC format, for the daily automated snapshot. Default + // value is 0 hours. + SnapshotOptions *types.SnapshotOptions - // Specify the type and size of the EBS volume that you want to use. - EBSOptions *types.EBSOptions + // Options to specify the subnets and security groups for VPC endpoint. For more + // information, see Creating a VPC + // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-creating-vpc) + // in VPC Endpoints for Amazon Elasticsearch Service Domains + VPCOptions *types.VPCOptions } // The result of an UpdateElasticsearchDomain request. Contains the status of the diff --git a/service/elasticsearchservice/api_op_UpgradeElasticsearchDomain.go b/service/elasticsearchservice/api_op_UpgradeElasticsearchDomain.go index 43fed8549ae..d508be65993 100644 --- a/service/elasticsearchservice/api_op_UpgradeElasticsearchDomain.go +++ b/service/elasticsearchservice/api_op_UpgradeElasticsearchDomain.go @@ -58,15 +58,6 @@ func (c *Client) UpgradeElasticsearchDomain(ctx context.Context, params *Upgrade // Container for request parameters to UpgradeElasticsearchDomain () operation. type UpgradeElasticsearchDomainInput struct { - // This flag, when set to True, indicates that an Upgrade Eligibility Check needs - // to be performed. This will not actually perform the Upgrade. - PerformCheckOnly *bool - - // The version of Elasticsearch that you intend to upgrade the domain to. - // - // This member is required. - TargetVersion *string - // The name of an Elasticsearch domain. Domain names are unique across the domains // owned by an account within an AWS region. Domain names start with a letter or // number and can contain the following characters: a-z (lowercase), 0-9, and - @@ -74,17 +65,19 @@ type UpgradeElasticsearchDomainInput struct { // // This member is required. DomainName *string -} -// Container for response returned by UpgradeElasticsearchDomain () operation. -type UpgradeElasticsearchDomainOutput struct { + // The version of Elasticsearch that you intend to upgrade the domain to. + // + // This member is required. + TargetVersion *string // This flag, when set to True, indicates that an Upgrade Eligibility Check needs // to be performed. This will not actually perform the Upgrade. PerformCheckOnly *bool +} - // The version of Elasticsearch that you intend to upgrade the domain to. - TargetVersion *string +// Container for response returned by UpgradeElasticsearchDomain () operation. +type UpgradeElasticsearchDomainOutput struct { // The name of an Elasticsearch domain. Domain names are unique across the domains // owned by an account within an AWS region. Domain names start with a letter or @@ -92,6 +85,13 @@ type UpgradeElasticsearchDomainOutput struct { // (hyphen). DomainName *string + // This flag, when set to True, indicates that an Upgrade Eligibility Check needs + // to be performed. This will not actually perform the Upgrade. + PerformCheckOnly *bool + + // The version of Elasticsearch that you intend to upgrade the domain to. + TargetVersion *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elasticsearchservice/go.mod b/service/elasticsearchservice/go.mod index afb7e83350c..d659840e7cd 100644 --- a/service/elasticsearchservice/go.mod +++ b/service/elasticsearchservice/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/elasticsearchservice go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/elasticsearchservice/types/types.go b/service/elasticsearchservice/types/types.go index 650a3ae2ff4..f4ca0e6bbe8 100644 --- a/service/elasticsearchservice/types/types.go +++ b/service/elasticsearchservice/types/types.go @@ -10,12 +10,6 @@ import ( // the current status of those rules. type AccessPoliciesStatus struct { - // The status of the access policy for the Elasticsearch domain. See OptionStatus - // for the status information that's included. - // - // This member is required. - Status *OptionStatus - // The access policy configured for the Elasticsearch domain. Access policies may // be resource-based, IP-based, or IAM-based. See Configuring Access Policies // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-access-policies)for @@ -23,6 +17,12 @@ type AccessPoliciesStatus struct { // // This member is required. Options *string + + // The status of the access policy for the Elasticsearch domain. See OptionStatus + // for the status information that's included. + // + // This member is required. + Status *OptionStatus } // List of limits that are specific to a given InstanceType and for each of it's @@ -68,16 +68,16 @@ type AdditionalLimit struct { // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options). type AdvancedOptionsStatus struct { - // Specifies the status of OptionStatus for advanced options for the specified - // Elasticsearch domain. + // Specifies the status of advanced options for the specified Elasticsearch domain. // // This member is required. - Status *OptionStatus + Options map[string]*string - // Specifies the status of advanced options for the specified Elasticsearch domain. + // Specifies the status of OptionStatus for advanced options for the specified + // Elasticsearch domain. // // This member is required. - Options map[string]*string + Status *OptionStatus } // Specifies the advanced security configuration: whether advanced security is @@ -97,29 +97,29 @@ type AdvancedSecurityOptions struct { // enabled). type AdvancedSecurityOptionsInput struct { - // Credentials for the master user: username and password, ARN, or both. - MasterUserOptions *MasterUserOptions + // True if advanced security is enabled. + Enabled *bool // True if the internal user database is enabled. InternalUserDatabaseEnabled *bool - // True if advanced security is enabled. - Enabled *bool + // Credentials for the master user: username and password, ARN, or both. + MasterUserOptions *MasterUserOptions } // Specifies the status of advanced security options for the specified // Elasticsearch domain. type AdvancedSecurityOptionsStatus struct { - // Status of the advanced security options for the specified Elasticsearch domain. + // Specifies advanced security options for the specified Elasticsearch domain. // // This member is required. - Status *OptionStatus + Options *AdvancedSecurityOptions - // Specifies advanced security options for the specified Elasticsearch domain. + // Status of the advanced security options for the specified Elasticsearch domain. // // This member is required. - Options *AdvancedSecurityOptions + Status *OptionStatus } // Options to specify the Cognito user and identity pools for Kibana @@ -128,12 +128,12 @@ type AdvancedSecurityOptionsStatus struct { // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html). type CognitoOptions struct { - // Specifies the Cognito identity pool ID for Kibana authentication. - IdentityPoolId *string - // Specifies the option to enable Cognito for Kibana authentication. Enabled *bool + // Specifies the Cognito identity pool ID for Kibana authentication. + IdentityPoolId *string + // Specifies the role ARN that provides Elasticsearch permissions for accessing // Cognito resources. RoleArn *string @@ -161,26 +161,29 @@ type CognitoOptionsStatus struct { // ElasticsearchVersion () s to which the domain can be upgraded. type CompatibleVersionsMap struct { - // List of supported elastic search versions. - TargetVersions []*string - // The current version of Elasticsearch on which a domain is. SourceVersion *string + + // List of supported elastic search versions. + TargetVersions []*string } // Filter to apply in DescribePackage response. type DescribePackagesFilter struct { - // A list of values for the specified field. - Value []*string - // Any field from PackageDetails. Name DescribePackagesFilterName + + // A list of values for the specified field. + Value []*string } // Options to configure endpoint for the Elasticsearch domain. type DomainEndpointOptions struct { + // Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain. + EnforceHTTPS *bool + // Specify the TLS security policy that needs to be applied to the HTTPS endpoint // of Elasticsearch domain. // @@ -193,9 +196,6 @@ type DomainEndpointOptions struct { // * Policy-Min-TLS-1-2-2019-07: TLS security policy which supports // only TLSv1.2 TLSSecurityPolicy TLSSecurityPolicy - - // Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain. - EnforceHTTPS *bool } // The configured endpoint options for the domain and their current status. @@ -237,31 +237,31 @@ type DomainInformation struct { // Information on a package that is associated with a domain. type DomainPackageDetails struct { - // User specified name of the package. - PackageName *string + // Name of the domain you've associated a package with. + DomainName *string + + // State of the association. Values are + // ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED. + DomainPackageStatus DomainPackageStatus // Additional information if the package is in an error state. Null otherwise. ErrorDetails *ErrorDetails + // Timestamp of the most-recent update to the association status. + LastUpdated *time.Time + + // Internal ID of the package. + PackageID *string + + // User specified name of the package. + PackageName *string + // Currently supports only TXT-DICTIONARY. PackageType PackageType - // Name of the domain you've associated a package with. - DomainName *string - // The relative path on Amazon ES nodes, which can be used as synonym_path when the // package is synonym file. ReferencePath *string - - // Internal ID of the package. - PackageID *string - - // Timestamp of the most-recent update to the association status. - LastUpdated *time.Time - - // State of the association. Values are - // ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED. - DomainPackageStatus DomainPackageStatus } // Options to enable, disable, and specify the properties of EBS storage volumes. @@ -269,17 +269,17 @@ type DomainPackageDetails struct { // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs). type EBSOptions struct { + // Specifies whether EBS-based storage is enabled. + EBSEnabled *bool + // Specifies the IOPD for a Provisioned IOPS EBS volume (SSD). Iops *int32 - // Specifies the volume type for EBS-based storage. - VolumeType VolumeType - // Integer to specify the size of an EBS volume. VolumeSize *int32 - // Specifies whether EBS-based storage is enabled. - EBSEnabled *bool + // Specifies the volume type for EBS-based storage. + VolumeType VolumeType } // Status of the EBS options for the specified Elasticsearch domain. @@ -300,17 +300,8 @@ type EBSOptionsStatus struct { // of instances. type ElasticsearchClusterConfig struct { - // A boolean value to indicate whether zone awareness is enabled. See About Zone - // Awareness - // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-zoneawareness) - // for more information. - ZoneAwarenessEnabled *bool - - // True to enable warm storage. - WarmEnabled *bool - - // The number of instances in the specified domain cluster. - InstanceCount *int32 + // Total number of dedicated master nodes, active and on standby, for the cluster. + DedicatedMasterCount *int32 // A boolean value to indicate whether a dedicated master node is enabled. See // About Dedicated Master Nodes @@ -318,25 +309,34 @@ type ElasticsearchClusterConfig struct { // for more information. DedicatedMasterEnabled *bool + // The instance type for a dedicated master node. + DedicatedMasterType ESPartitionInstanceType + + // The number of instances in the specified domain cluster. + InstanceCount *int32 + + // The instance type for an Elasticsearch cluster. UltraWarm instance types are not + // supported for data instances. + InstanceType ESPartitionInstanceType + // The number of warm nodes in the cluster. WarmCount *int32 - // Specifies the zone awareness configuration for a domain when zone awareness is - // enabled. - ZoneAwarenessConfig *ZoneAwarenessConfig + // True to enable warm storage. + WarmEnabled *bool // The instance type for the Elasticsearch cluster's warm nodes. WarmType ESWarmPartitionInstanceType - // The instance type for an Elasticsearch cluster. UltraWarm instance types are not - // supported for data instances. - InstanceType ESPartitionInstanceType - - // Total number of dedicated master nodes, active and on standby, for the cluster. - DedicatedMasterCount *int32 + // Specifies the zone awareness configuration for a domain when zone awareness is + // enabled. + ZoneAwarenessConfig *ZoneAwarenessConfig - // The instance type for a dedicated master node. - DedicatedMasterType ESPartitionInstanceType + // A boolean value to indicate whether zone awareness is enabled. See About Zone + // Awareness + // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-zoneawareness) + // for more information. + ZoneAwarenessEnabled *bool } // Specifies the configuration status for the specified Elasticsearch domain. @@ -357,57 +357,67 @@ type ElasticsearchClusterConfigStatus struct { // The configuration of an Elasticsearch domain. type ElasticsearchDomainConfig struct { - // Specifies the ElasticsearchClusterConfig for the Elasticsearch domain. - ElasticsearchClusterConfig *ElasticsearchClusterConfigStatus - - // Specifies the DomainEndpointOptions for the Elasticsearch domain. - DomainEndpointOptions *DomainEndpointOptionsStatus - - // Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain. - NodeToNodeEncryptionOptions *NodeToNodeEncryptionOptionsStatus - - // Specifies the SnapshotOptions for the Elasticsearch domain. - SnapshotOptions *SnapshotOptionsStatus - // IAM access policy as a JSON-formatted string. AccessPolicies *AccessPoliciesStatus - // Specifies AdvancedSecurityOptions for the domain. - AdvancedSecurityOptions *AdvancedSecurityOptionsStatus - // Specifies the AdvancedOptions for the domain. See Configuring Advanced Options // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options) // for more information. AdvancedOptions *AdvancedOptionsStatus - // Log publishing options for the given domain. - LogPublishingOptions *LogPublishingOptionsStatus + // Specifies AdvancedSecurityOptions for the domain. + AdvancedSecurityOptions *AdvancedSecurityOptionsStatus // The CognitoOptions for the specified domain. For more information, see Amazon // Cognito Authentication for Kibana // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html). CognitoOptions *CognitoOptionsStatus - // The VPCOptions for the specified domain. For more information, see VPC Endpoints - // for Amazon Elasticsearch Service Domains - // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html). - VPCOptions *VPCDerivedInfoStatus + // Specifies the DomainEndpointOptions for the Elasticsearch domain. + DomainEndpointOptions *DomainEndpointOptionsStatus - // Specifies the EncryptionAtRestOptions for the Elasticsearch domain. - EncryptionAtRestOptions *EncryptionAtRestOptionsStatus + // Specifies the EBSOptions for the Elasticsearch domain. + EBSOptions *EBSOptionsStatus + + // Specifies the ElasticsearchClusterConfig for the Elasticsearch domain. + ElasticsearchClusterConfig *ElasticsearchClusterConfigStatus // String of format X.Y to specify version for the Elasticsearch domain. ElasticsearchVersion *ElasticsearchVersionStatus - // Specifies the EBSOptions for the Elasticsearch domain. - EBSOptions *EBSOptionsStatus + // Specifies the EncryptionAtRestOptions for the Elasticsearch domain. + EncryptionAtRestOptions *EncryptionAtRestOptionsStatus + + // Log publishing options for the given domain. + LogPublishingOptions *LogPublishingOptionsStatus + + // Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain. + NodeToNodeEncryptionOptions *NodeToNodeEncryptionOptionsStatus + + // Specifies the SnapshotOptions for the Elasticsearch domain. + SnapshotOptions *SnapshotOptionsStatus + + // The VPCOptions for the specified domain. For more information, see VPC Endpoints + // for Amazon Elasticsearch Service Domains + // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html). + VPCOptions *VPCDerivedInfoStatus } // The current status of an Elasticsearch domain. type ElasticsearchDomainStatus struct { - // Specifies the status of the NodeToNodeEncryptionOptions. - NodeToNodeEncryptionOptions *NodeToNodeEncryptionOptions + // The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for + // IAM Entities + // (http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html) + // in Using AWS Identity and Access Management for more information. + // + // This member is required. + ARN *string + + // The unique identifier for the specified Elasticsearch domain. + // + // This member is required. + DomainId *string // The name of an Elasticsearch domain. Domain names are unique across the domains // owned by an account within an AWS region. Domain names start with a letter or @@ -422,104 +432,94 @@ type ElasticsearchDomainStatus struct { // This member is required. ElasticsearchClusterConfig *ElasticsearchClusterConfig + // IAM access policy as a JSON-formatted string. + AccessPolicies *string + + // Specifies the status of the AdvancedOptions + AdvancedOptions map[string]*string + + // The current status of the Elasticsearch domain's advanced security options. + AdvancedSecurityOptions *AdvancedSecurityOptions + + // The CognitoOptions for the specified domain. For more information, see Amazon + // Cognito Authentication for Kibana + // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html). + CognitoOptions *CognitoOptions + // The domain creation status. True if the creation of an Elasticsearch domain is // complete. False if domain creation is still in progress. Created *bool + // The domain deletion status. True if a delete request has been received for the + // domain but resource cleanup is still in progress. False if the domain has not + // been deleted. Once domain deletion is complete, the status of the domain is no + // longer returned. + Deleted *bool + // The current status of the Elasticsearch domain's endpoint options. DomainEndpointOptions *DomainEndpointOptions - // Specifies the status of the SnapshotOptions - SnapshotOptions *SnapshotOptions - - // The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for - // IAM Entities - // (http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html) - // in Using AWS Identity and Access Management for more information. - // - // This member is required. - ARN *string - - // IAM access policy as a JSON-formatted string. - AccessPolicies *string - - // The current status of the Elasticsearch domain's advanced security options. - AdvancedSecurityOptions *AdvancedSecurityOptions + // The EBSOptions for the specified domain. See Configuring EBS-based Storage + // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs) + // for more information. + EBSOptions *EBSOptions - // Specifies the status of the AdvancedOptions - AdvancedOptions map[string]*string + ElasticsearchVersion *string - // Log publishing options for the given domain. - LogPublishingOptions map[string]*LogPublishingOption + // Specifies the status of the EncryptionAtRestOptions. + EncryptionAtRestOptions *EncryptionAtRestOptions // The Elasticsearch domain endpoint that you use to submit index and search // requests. Endpoint *string - // The unique identifier for the specified Elasticsearch domain. - // - // This member is required. - DomainId *string - // Map containing the Elasticsearch domain endpoints used to submit index and // search requests. Example key, value: // 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'. Endpoints map[string]*string - // The CognitoOptions for the specified domain. For more information, see Amazon - // Cognito Authentication for Kibana - // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html). - CognitoOptions *CognitoOptions + // Log publishing options for the given domain. + LogPublishingOptions map[string]*LogPublishingOption - // The domain deletion status. True if a delete request has been received for the - // domain but resource cleanup is still in progress. False if the domain has not - // been deleted. Once domain deletion is complete, the status of the domain is no - // longer returned. - Deleted *bool + // Specifies the status of the NodeToNodeEncryptionOptions. + NodeToNodeEncryptionOptions *NodeToNodeEncryptionOptions // The status of the Elasticsearch domain configuration. True if Amazon // Elasticsearch Service is processing configuration changes. False if the // configuration is active. Processing *bool + // The current status of the Elasticsearch domain's service software. + ServiceSoftwareOptions *ServiceSoftwareOptions + + // Specifies the status of the SnapshotOptions + SnapshotOptions *SnapshotOptions + // The status of an Elasticsearch domain version upgrade. True if Amazon // Elasticsearch Service is undergoing a version upgrade. False if the // configuration is active. UpgradeProcessing *bool - // Specifies the status of the EncryptionAtRestOptions. - EncryptionAtRestOptions *EncryptionAtRestOptions - - // The current status of the Elasticsearch domain's service software. - ServiceSoftwareOptions *ServiceSoftwareOptions - // The VPCOptions for the specified domain. For more information, see VPC Endpoints // for Amazon Elasticsearch Service Domains // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html). VPCOptions *VPCDerivedInfo - - ElasticsearchVersion *string - - // The EBSOptions for the specified domain. See Configuring EBS-based Storage - // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs) - // for more information. - EBSOptions *EBSOptions } // Status of the Elasticsearch version options for the specified Elasticsearch // domain. type ElasticsearchVersionStatus struct { - // Specifies the status of the Elasticsearch version options for the specified - // Elasticsearch domain. + // Specifies the Elasticsearch version for the specified Elasticsearch domain. // // This member is required. - Status *OptionStatus + Options *string - // Specifies the Elasticsearch version for the specified Elasticsearch domain. + // Specifies the status of the Elasticsearch version options for the specified + // Elasticsearch domain. // // This member is required. - Options *string + Status *OptionStatus } // Specifies the Encryption At Rest Options. @@ -535,22 +535,22 @@ type EncryptionAtRestOptions struct { // Status of the Encryption At Rest options for the specified Elasticsearch domain. type EncryptionAtRestOptionsStatus struct { - // Specifies the status of the Encryption At Rest options for the specified - // Elasticsearch domain. + // Specifies the Encryption At Rest options for the specified Elasticsearch domain. // // This member is required. - Status *OptionStatus + Options *EncryptionAtRestOptions - // Specifies the Encryption At Rest options for the specified Elasticsearch domain. + // Specifies the status of the Encryption At Rest options for the specified + // Elasticsearch domain. // // This member is required. - Options *EncryptionAtRestOptions + Status *OptionStatus } type ErrorDetails struct { - ErrorType *string - ErrorMessage *string + + ErrorType *string } // A filter used to limit results when describing inbound or outbound cross-cluster @@ -573,12 +573,12 @@ type InboundCrossClusterSearchConnection struct { // connection. ConnectionStatus *InboundCrossClusterSearchConnectionStatus - // Specifies the DomainInformation () for the destination Elasticsearch domain. - DestinationDomainInfo *DomainInformation - // Specifies the connection id for the inbound cross-cluster search connection. CrossClusterSearchConnectionId *string + // Specifies the DomainInformation () for the destination Elasticsearch domain. + DestinationDomainInfo *DomainInformation + // Specifies the DomainInformation () for the source Elasticsearch domain. SourceDomainInfo *DomainInformation } @@ -586,6 +586,9 @@ type InboundCrossClusterSearchConnection struct { // Specifies the coonection status of an inbound cross-cluster search connection. type InboundCrossClusterSearchConnectionStatus struct { + // Specifies verbose information for the inbound connection status. + Message *string + // The state code for inbound connection. This can be one of the following: // // * @@ -604,22 +607,19 @@ type InboundCrossClusterSearchConnectionStatus struct { // deletion is in progress. // // * DELETED: Inbound connection is deleted and - // cannot be used further. - StatusCode InboundCrossClusterSearchConnectionStatusCode - - // Specifies verbose information for the inbound connection status. - Message *string + // cannot be used further. + StatusCode InboundCrossClusterSearchConnectionStatusCode } // InstanceCountLimits represents the limits on number of instances that be created // in Amazon Elasticsearch for given InstanceType. type InstanceCountLimits struct { - // Minimum number of Instances that can be instantiated for given InstanceType. - MinimumInstanceCount *int32 - // Maximum number of Instances that can be instantiated for given InstanceType. MaximumInstanceCount *int32 + + // Minimum number of Instances that can be instantiated for given InstanceType. + MinimumInstanceCount *int32 } // InstanceLimits represents the list of instance related attributes that are @@ -637,10 +637,6 @@ type InstanceLimits struct { // following StorageTypes, ()InstanceLimits () and AdditionalLimits () type Limits struct { - // StorageType represents the list of storage related types and attributes that are - // available for given InstanceType. - StorageTypes []*StorageType - // List of additional limits that are specific to a given InstanceType and for each // of it's InstanceRole () . AdditionalLimits []*AdditionalLimit @@ -648,6 +644,10 @@ type Limits struct { // InstanceLimits represents the list of instance related attributes that are // available for given InstanceType. InstanceLimits *InstanceLimits + + // StorageType represents the list of storage related types and attributes that are + // available for given InstanceType. + StorageTypes []*StorageType } // Log Publishing option that is set for given domain. @@ -662,37 +662,37 @@ type Limits struct { // given log type is enabled or not type LogPublishingOption struct { - // Specifies whether given log publishing option is enabled or not. - Enabled *bool - // ARN of the Cloudwatch log group to which log needs to be published. CloudWatchLogsLogGroupArn *string + + // Specifies whether given log publishing option is enabled or not. + Enabled *bool } // The configured log publishing options for the domain and their current status. type LogPublishingOptionsStatus struct { + // The log publishing options configured for the Elasticsearch domain. + Options map[string]*LogPublishingOption + // The status of the log publishing options for the Elasticsearch domain. See // OptionStatus for the status information that's included. Status *OptionStatus - - // The log publishing options configured for the Elasticsearch domain. - Options map[string]*LogPublishingOption } // Credentials for the master user: username and password, ARN, or both. type MasterUserOptions struct { - // The master user's password, which is stored in the Amazon Elasticsearch Service - // domain's internal database. - MasterUserPassword *string - // ARN for the master user (if IAM is enabled). MasterUserARN *string // The master user's username, which is stored in the Amazon Elasticsearch Service // domain's internal database. MasterUserName *string + + // The master user's password, which is stored in the Amazon Elasticsearch Service + // domain's internal database. + MasterUserPassword *string } // Specifies the node-to-node encryption options. @@ -727,12 +727,6 @@ type OptionStatus struct { // This member is required. CreationDate *time.Time - // Indicates whether the Elasticsearch domain is being deleted. - PendingDeletion *bool - - // Specifies the latest version for the entity. - UpdateVersion *int32 - // Provides the OptionState for the Elasticsearch domain. // // This member is required. @@ -742,17 +736,17 @@ type OptionStatus struct { // // This member is required. UpdateDate *time.Time + + // Indicates whether the Elasticsearch domain is being deleted. + PendingDeletion *bool + + // Specifies the latest version for the entity. + UpdateVersion *int32 } // Specifies details of an outbound connection. type OutboundCrossClusterSearchConnection struct { - // Specifies the connection id for the outbound cross-cluster search connection. - CrossClusterSearchConnectionId *string - - // Specifies the DomainInformation () for the source Elasticsearch domain. - SourceDomainInfo *DomainInformation - // Specifies the connection alias for the outbound cross-cluster search connection. ConnectionAlias *string @@ -760,8 +754,14 @@ type OutboundCrossClusterSearchConnection struct { // connection. ConnectionStatus *OutboundCrossClusterSearchConnectionStatus + // Specifies the connection id for the outbound cross-cluster search connection. + CrossClusterSearchConnectionId *string + // Specifies the DomainInformation () for the destination Elasticsearch domain. DestinationDomainInfo *DomainInformation + + // Specifies the DomainInformation () for the source Elasticsearch domain. + SourceDomainInfo *DomainInformation } // Specifies the connection status of an outbound cross-cluster search connection. @@ -801,27 +801,27 @@ type OutboundCrossClusterSearchConnectionStatus struct { // Basic information about a package. type PackageDetails struct { - // Currently supports only TXT-DICTIONARY. - PackageType PackageType + // Timestamp which tells creation date of the package. + CreatedAt *time.Time // Additional information if the package is in an error state. Null otherwise. ErrorDetails *ErrorDetails - // User specified name of the package. - PackageName *string - - // Timestamp which tells creation date of the package. - CreatedAt *time.Time + // User-specified description of the package. + PackageDescription *string // Internal ID of the package. PackageID *string + // User specified name of the package. + PackageName *string + // Current state of the package. Values are // COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED PackageStatus PackageStatus - // User-specified description of the package. - PackageDescription *string + // Currently supports only TXT-DICTIONARY. + PackageType PackageType } // The S3 location for importing the package specified as S3BucketName and S3Key @@ -838,42 +838,32 @@ type PackageSource struct { // Elasticsearch instance, or for a reserved Elasticsearch instance offering. type RecurringCharge struct { - // The frequency of the recurring charge. - RecurringChargeFrequency *string - // The monetary amount of the recurring charge. RecurringChargeAmount *float64 + + // The frequency of the recurring charge. + RecurringChargeFrequency *string } // Details of a reserved Elasticsearch instance. type ReservedElasticsearchInstance struct { - // The state of the reserved Elasticsearch instance. - State *string + // The currency code for the reserved Elasticsearch instance offering. + CurrencyCode *string - // The customer-specified identifier to track this reservation. - ReservationName *string + // The duration, in seconds, for which the Elasticsearch instance is reserved. + Duration *int32 - // The time the reservation started. - StartTime *time.Time + // The number of Elasticsearch instances that have been reserved. + ElasticsearchInstanceCount *int32 + + // The Elasticsearch instance type offered by the reserved instance offering. + ElasticsearchInstanceType ESPartitionInstanceType // The upfront fixed charge you will paid to purchase the specific reserved // Elasticsearch instance offering. FixedPrice *float64 - // The currency code for the reserved Elasticsearch instance offering. - CurrencyCode *string - - // The unique identifier for the reservation. - ReservedElasticsearchInstanceId *string - - // The rate you are charged for each hour for the domain that is using this - // reserved instance. - UsagePrice *float64 - - // The duration, in seconds, for which the Elasticsearch instance is reserved. - Duration *int32 - // The payment option as defined in the reserved Elasticsearch instance offering. PaymentOption ReservedElasticsearchInstancePaymentOption @@ -881,79 +871,89 @@ type ReservedElasticsearchInstance struct { // using the instance offering. RecurringCharges []*RecurringCharge + // The customer-specified identifier to track this reservation. + ReservationName *string + + // The unique identifier for the reservation. + ReservedElasticsearchInstanceId *string + // The offering identifier. ReservedElasticsearchInstanceOfferingId *string - // The Elasticsearch instance type offered by the reserved instance offering. - ElasticsearchInstanceType ESPartitionInstanceType + // The time the reservation started. + StartTime *time.Time - // The number of Elasticsearch instances that have been reserved. - ElasticsearchInstanceCount *int32 + // The state of the reserved Elasticsearch instance. + State *string + + // The rate you are charged for each hour for the domain that is using this + // reserved instance. + UsagePrice *float64 } // Details of a reserved Elasticsearch instance offering. type ReservedElasticsearchInstanceOffering struct { - // Payment option for the reserved Elasticsearch instance offering - PaymentOption ReservedElasticsearchInstancePaymentOption - - // The charge to your account regardless of whether you are creating any domains - // using the instance offering. - RecurringCharges []*RecurringCharge - - // The Elasticsearch reserved instance offering identifier. - ReservedElasticsearchInstanceOfferingId *string + // The currency code for the reserved Elasticsearch instance offering. + CurrencyCode *string // The duration, in seconds, for which the offering will reserve the Elasticsearch // instance. Duration *int32 + // The Elasticsearch instance type offered by the reserved instance offering. + ElasticsearchInstanceType ESPartitionInstanceType + // The upfront fixed charge you will pay to purchase the specific reserved // Elasticsearch instance offering. FixedPrice *float64 - // The currency code for the reserved Elasticsearch instance offering. - CurrencyCode *string + // Payment option for the reserved Elasticsearch instance offering + PaymentOption ReservedElasticsearchInstancePaymentOption + + // The charge to your account regardless of whether you are creating any domains + // using the instance offering. + RecurringCharges []*RecurringCharge + + // The Elasticsearch reserved instance offering identifier. + ReservedElasticsearchInstanceOfferingId *string // The rate you are charged for each hour the domain that is using the offering is // running. UsagePrice *float64 - - // The Elasticsearch instance type offered by the reserved instance offering. - ElasticsearchInstanceType ESPartitionInstanceType } // The current options of an Elasticsearch domain service software options. type ServiceSoftwareOptions struct { - // True if you are able to update you service software version. False if you are - // not able to update your service software version. - UpdateAvailable *bool + // Timestamp, in Epoch time, until which you can manually request a service + // software update. After this date, we automatically update your service software. + AutomatedUpdateDate *time.Time // True if you are able to cancel your service software version update. False if // you are not able to cancel your service software version. Cancellable *bool - // The new service software version if one is available. - NewVersion *string + // The current service software version that is present on the domain. + CurrentVersion *string - // The status of your service software update. This field can take the following - // values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE. - UpdateStatus DeploymentStatus + // The description of the UpdateStatus. + Description *string - // Timestamp, in Epoch time, until which you can manually request a service - // software update. After this date, we automatically update your service software. - AutomatedUpdateDate *time.Time + // The new service software version if one is available. + NewVersion *string // True if a service software is never automatically updated. False if a service // software is automatically updated after AutomatedUpdateDate. OptionalDeployment *bool - // The current service software version that is present on the domain. - CurrentVersion *string + // True if you are able to update you service software version. False if you are + // not able to update your service software version. + UpdateAvailable *bool - // The description of the UpdateStatus. - Description *string + // The status of your service software update. This field can take the following + // values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE. + UpdateStatus DeploymentStatus } // Specifies the time, in UTC format, when the service takes a daily automated @@ -968,15 +968,15 @@ type SnapshotOptions struct { // Status of a daily automated snapshot. type SnapshotOptionsStatus struct { - // Specifies the status of a daily automated snapshot. + // Specifies the daily snapshot options specified for the Elasticsearch domain. // // This member is required. - Status *OptionStatus + Options *SnapshotOptions - // Specifies the daily snapshot options specified for the Elasticsearch domain. + // Specifies the status of a daily automated snapshot. // // This member is required. - Options *SnapshotOptions + Status *OptionStatus } // StorageTypes represents the list of storage related types and their attributes @@ -998,6 +998,9 @@ type StorageType struct { // storage options. StorageSubTypeName *string + // List of limits that are applicable for given storage type. + StorageTypeLimits []*StorageTypeLimit + // Type of the storage. List of available storage options: // // * instance @@ -1007,17 +1010,11 @@ type StorageType struct { // Elastic block // storage that would be attached to the given Instance StorageTypeName *string - - // List of limits that are applicable for given storage type. - StorageTypeLimits []*StorageTypeLimit } // Limits that are applicable for given storage type. type StorageTypeLimit struct { - // Values for the StorageTypeLimit$LimitName () . - LimitValues []*string - // Name of storage limits that are applicable for given storage type. If // StorageType () is ebs, following storage options are applicable // @@ -1037,6 +1034,9 @@ type StorageTypeLimit struct { // Minimum amount of Iops that is // applicable for given storage type.It can be empty if it is not applicable. LimitName *string + + // Values for the StorageTypeLimit$LimitName () . + LimitValues []*string } // Specifies a key value pair for a resource tag. @@ -1060,10 +1060,17 @@ type Tag struct { // History of the last 10 Upgrades and Upgrade Eligibility Checks. type UpgradeHistory struct { + // UTC Timestamp at which the Upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" + // format. + StartTimestamp *time.Time + // A list of UpgradeStepItem () s representing information about each step // performed as pard of a specific Upgrade or Upgrade Eligibility Check. StepsList []*UpgradeStepItem + // A string that describes the update briefly + UpgradeName *string + // The overall status of the update. The status can take one of the following // values: // @@ -1076,31 +1083,11 @@ type UpgradeHistory struct { // * // Failed UpgradeStatus UpgradeStatus - - // A string that describes the update briefly - UpgradeName *string - - // UTC Timestamp at which the Upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" - // format. - StartTimestamp *time.Time } // Represents a single step of the Upgrade or Upgrade Eligibility Check workflow. type UpgradeStepItem struct { - // The status of a particular step during an upgrade. The status can take one of - // the following values: - // - // * In Progress - // - // * Succeeded - // - // * Succeeded with - // Issues - // - // * Failed - UpgradeStepStatus UpgradeStatus - // A list of strings containing detailed information about the errors encountered // in a particular step. Issues []*string @@ -1117,6 +1104,19 @@ type UpgradeStepItem struct { // // * Upgrade UpgradeStep UpgradeStep + + // The status of a particular step during an upgrade. The status can take one of + // the following values: + // + // * In Progress + // + // * Succeeded + // + // * Succeeded with + // Issues + // + // * Failed + UpgradeStepStatus UpgradeStatus } // Options to specify the subnets and security groups for VPC endpoint. For more @@ -1124,10 +1124,6 @@ type UpgradeStepItem struct { // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html). type VPCDerivedInfo struct { - // The VPC Id for the Elasticsearch domain. Exists only if the domain was created - // with VPCOptions. - VPCId *string - // The availability zones for the Elasticsearch domain. Exists only if the domain // was created with VPCOptions. AvailabilityZones []*string @@ -1137,6 +1133,10 @@ type VPCDerivedInfo struct { // Specifies the subnets for VPC endpoint. SubnetIds []*string + + // The VPC Id for the Elasticsearch domain. Exists only if the domain was created + // with VPCOptions. + VPCId *string } // Status of the VPC options for the specified Elasticsearch domain. diff --git a/service/elastictranscoder/api_op_CreateJob.go b/service/elastictranscoder/api_op_CreateJob.go index afa263e50b3..98bf2087b8b 100644 --- a/service/elastictranscoder/api_op_CreateJob.go +++ b/service/elastictranscoder/api_op_CreateJob.go @@ -62,12 +62,6 @@ func (c *Client) CreateJob(ctx context.Context, params *CreateJobInput, optFns . // The CreateJobRequest structure. type CreateJobInput struct { - // If you specify a preset in PresetId for which the value of Container is fmp4 - // (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the - // master playlists that you want Elastic Transcoder to create. The maximum number - // of master playlists in a job is 30. - Playlists []*types.CreateJobPlaylist - // The Id of the pipeline that you want Elastic Transcoder to use for transcoding. // The pipeline determines several settings, including the Amazon S3 bucket from // which Elastic Transcoder gets the files to transcode and the bucket into which @@ -76,34 +70,40 @@ type CreateJobInput struct { // This member is required. PipelineId *string - // The value, if any, that you want Elastic Transcoder to prepend to the names of - // all files that this job creates, including output files, thumbnails, and - // playlists. - OutputKeyPrefix *string - // A section of the request body that provides information about the file that is // being transcoded. Input *types.JobInput + // A section of the request body that provides information about the files that are + // being transcoded. + Inputs []*types.JobInput + // A section of the request body that provides information about the transcoded // (target) file. We strongly recommend that you use the Outputs syntax instead of // the Output syntax. Output *types.CreateJobOutput + // The value, if any, that you want Elastic Transcoder to prepend to the names of + // all files that this job creates, including output files, thumbnails, and + // playlists. + OutputKeyPrefix *string + // A section of the request body that provides information about the transcoded // (target) files. We recommend that you use the Outputs syntax instead of the // Output syntax. Outputs []*types.CreateJobOutput + // If you specify a preset in PresetId for which the value of Container is fmp4 + // (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the + // master playlists that you want Elastic Transcoder to create. The maximum number + // of master playlists in a job is 30. + Playlists []*types.CreateJobPlaylist + // User-defined metadata that you want to associate with an Elastic Transcoder job. // You specify metadata in key/value pairs, and you can add up to 10 key/value // pairs per job. Elastic Transcoder does not guarantee that key/value pairs are // returned in the same order in which you specify them. UserMetadata map[string]*string - - // A section of the request body that provides information about the files that are - // being transcoded. - Inputs []*types.JobInput } // The CreateJobResponse structure. diff --git a/service/elastictranscoder/api_op_CreatePipeline.go b/service/elastictranscoder/api_op_CreatePipeline.go index 31bc4c04ebd..320fef0c106 100644 --- a/service/elastictranscoder/api_op_CreatePipeline.go +++ b/service/elastictranscoder/api_op_CreatePipeline.go @@ -58,12 +58,32 @@ func (c *Client) CreatePipeline(ctx context.Context, params *CreatePipelineInput // The CreatePipelineRequest structure. type CreatePipelineInput struct { + // The Amazon S3 bucket in which you saved the media files that you want to + // transcode. + // + // This member is required. + InputBucket *string + // The name of the pipeline. We recommend that the name be unique within the AWS // account, but uniqueness is not enforced. Constraints: Maximum 40 characters. // // This member is required. Name *string + // The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder + // to use to create the pipeline. + // + // This member is required. + Role *string + + // The AWS Key Management Service (AWS KMS) key that you want to use with this + // pipeline. If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't + // need to provide a key with your job because a default key, known as an AWS-KMS + // key, is created for you automatically. You need to provide an AWS-KMS key only + // if you want to use a non-default AWS-KMS key, or if you are using an + // Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm. + AwsKmsKeyArn *string + // The optional ContentConfig object specifies information about the Amazon S3 // bucket in which you want Elastic Transcoder to save transcoded files and // playlists: which bucket to use, which users you want to have access to the @@ -158,11 +178,29 @@ type CreatePipelineInput struct { // pipeline. This is the ARN that Amazon SNS returned when you created the topic. Notifications *types.Notifications - // The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder - // to use to create the pipeline. + // The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded + // files. (Use this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.) + // Specify this value when all of the following are true: // - // This member is required. - Role *string + // * You want to save + // transcoded files, thumbnails (if any), and playlists (if any) together in one + // bucket. + // + // * You do not want to specify the users or groups who have access to + // the transcoded files, thumbnails, and playlists. + // + // * You do not want to + // specify the permissions that Elastic Transcoder grants to the files.

    + //

    When Elastic Transcoder saves files in OutputBucket, + // it grants full control over the files only to the AWS account that owns the role + // that is specified by Role.

  • You want + // to associate the transcoded files and thumbnails with the Amazon S3 Standard + // storage class.

    • If you want to save transcoded files and + // playlists in one bucket and thumbnails in another bucket, specify which users + // can access the transcoded files or the permissions the users have, or change the + // Amazon S3 storage class, omit OutputBucket and specify values for + // ContentConfig and ThumbnailConfig instead.

    + OutputBucket *string // The ThumbnailConfig object specifies several values, including the Amazon S3 // bucket in which you want Elastic Transcoder to save thumbnail files, which users @@ -226,44 +264,6 @@ type CreatePipelineInput struct { // storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder // to assign to the thumbnails that it stores in your Amazon S3 bucket. ThumbnailConfig *types.PipelineOutputConfig - - // The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded - // files. (Use this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.) - // Specify this value when all of the following are true: - // - // * You want to save - // transcoded files, thumbnails (if any), and playlists (if any) together in one - // bucket. - // - // * You do not want to specify the users or groups who have access to - // the transcoded files, thumbnails, and playlists. - // - // * You do not want to - // specify the permissions that Elastic Transcoder grants to the files.

    - //

    When Elastic Transcoder saves files in OutputBucket, - // it grants full control over the files only to the AWS account that owns the role - // that is specified by Role.

  • You want - // to associate the transcoded files and thumbnails with the Amazon S3 Standard - // storage class.

    • If you want to save transcoded files and - // playlists in one bucket and thumbnails in another bucket, specify which users - // can access the transcoded files or the permissions the users have, or change the - // Amazon S3 storage class, omit OutputBucket and specify values for - // ContentConfig and ThumbnailConfig instead.

    - OutputBucket *string - - // The Amazon S3 bucket in which you saved the media files that you want to - // transcode. - // - // This member is required. - InputBucket *string - - // The AWS Key Management Service (AWS KMS) key that you want to use with this - // pipeline. If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't - // need to provide a key with your job because a default key, known as an AWS-KMS - // key, is created for you automatically. You need to provide an AWS-KMS key only - // if you want to use a non-default AWS-KMS key, or if you are using an - // Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm. - AwsKmsKeyArn *string } // When you create a pipeline, Elastic Transcoder returns the values that you diff --git a/service/elastictranscoder/api_op_CreatePreset.go b/service/elastictranscoder/api_op_CreatePreset.go index b8ec0fafbb3..a143d8142d5 100644 --- a/service/elastictranscoder/api_op_CreatePreset.go +++ b/service/elastictranscoder/api_op_CreatePreset.go @@ -70,29 +70,29 @@ func (c *Client) CreatePreset(ctx context.Context, params *CreatePresetInput, op // The CreatePresetRequest structure. type CreatePresetInput struct { + // The container type for the output file. Valid values include flac, flv, fmp4, + // gif, mp3, mp4, mpg, mxf, oga, ogg, ts, and webm. + // + // This member is required. + Container *string + // The name of the preset. We recommend that the name be unique within the AWS // account, but uniqueness is not enforced. // // This member is required. Name *string + // A section of the request body that specifies the audio parameters. + Audio *types.AudioParameters + // A description of the preset. Description *string - // The container type for the output file. Valid values include flac, flv, fmp4, - // gif, mp3, mp4, mpg, mxf, oga, ogg, ts, and webm. - // - // This member is required. - Container *string - - // A section of the request body that specifies the video parameters. - Video *types.VideoParameters - // A section of the request body that specifies the thumbnail parameters, if any. Thumbnails *types.Thumbnails - // A section of the request body that specifies the audio parameters. - Audio *types.AudioParameters + // A section of the request body that specifies the video parameters. + Video *types.VideoParameters } // The CreatePresetResponse structure. diff --git a/service/elastictranscoder/api_op_ListJobsByPipeline.go b/service/elastictranscoder/api_op_ListJobsByPipeline.go index d7e141c849a..4edee7b954e 100644 --- a/service/elastictranscoder/api_op_ListJobsByPipeline.go +++ b/service/elastictranscoder/api_op_ListJobsByPipeline.go @@ -61,15 +61,15 @@ func (c *Client) ListJobsByPipeline(ctx context.Context, params *ListJobsByPipel // The ListJobsByPipelineRequest structure. type ListJobsByPipelineInput struct { - // To list jobs in chronological order by the date and time that they were - // submitted, enter true. To list jobs in reverse chronological order, enter false. - Ascending *string - // The ID of the pipeline for which you want to get job information. // // This member is required. PipelineId *string + // To list jobs in chronological order by the date and time that they were + // submitted, enter true. To list jobs in reverse chronological order, enter false. + Ascending *string + // When Elastic Transcoder returns more than one page of results, use pageToken in // subsequent GET requests to get each successive page of results. PageToken *string @@ -78,14 +78,14 @@ type ListJobsByPipelineInput struct { // The ListJobsByPipelineResponse structure. type ListJobsByPipelineOutput struct { + // An array of Job objects that are in the specified pipeline. + Jobs []*types.Job + // A value that you use to access the second and subsequent pages of results, if // any. When the jobs in the specified pipeline fit on one page or when you've // reached the last page of results, the value of NextPageToken is null. NextPageToken *string - // An array of Job objects that are in the specified pipeline. - Jobs []*types.Job - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elastictranscoder/api_op_ListJobsByStatus.go b/service/elastictranscoder/api_op_ListJobsByStatus.go index 1c2f37bdfdc..e7f9cb5b0ec 100644 --- a/service/elastictranscoder/api_op_ListJobsByStatus.go +++ b/service/elastictranscoder/api_op_ListJobsByStatus.go @@ -60,10 +60,6 @@ func (c *Client) ListJobsByStatus(ctx context.Context, params *ListJobsByStatusI // The ListJobsByStatusRequest structure. type ListJobsByStatusInput struct { - // To list jobs in chronological order by the date and time that they were - // submitted, enter true. To list jobs in reverse chronological order, enter false. - Ascending *string - // To get information about all of the jobs associated with the current AWS account // that have a given status, specify the following status: Submitted, Progressing, // Complete, Canceled, or Error. @@ -71,6 +67,10 @@ type ListJobsByStatusInput struct { // This member is required. Status *string + // To list jobs in chronological order by the date and time that they were + // submitted, enter true. To list jobs in reverse chronological order, enter false. + Ascending *string + // When Elastic Transcoder returns more than one page of results, use pageToken in // subsequent GET requests to get each successive page of results. PageToken *string diff --git a/service/elastictranscoder/api_op_ListPipelines.go b/service/elastictranscoder/api_op_ListPipelines.go index 2c7772dabb1..1888fd3190f 100644 --- a/service/elastictranscoder/api_op_ListPipelines.go +++ b/service/elastictranscoder/api_op_ListPipelines.go @@ -71,14 +71,14 @@ type ListPipelinesInput struct { // A list of the pipelines associated with the current AWS account. type ListPipelinesOutput struct { - // An array of Pipeline objects. - Pipelines []*types.Pipeline - // A value that you use to access the second and subsequent pages of results, if // any. When the pipelines fit on one page or when you've reached the last page of // results, the value of NextPageToken is null. NextPageToken *string + // An array of Pipeline objects. + Pipelines []*types.Pipeline + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elastictranscoder/api_op_ListPresets.go b/service/elastictranscoder/api_op_ListPresets.go index 2b88fa609ee..f36b9c47dcb 100644 --- a/service/elastictranscoder/api_op_ListPresets.go +++ b/service/elastictranscoder/api_op_ListPresets.go @@ -58,27 +58,27 @@ func (c *Client) ListPresets(ctx context.Context, params *ListPresetsInput, optF // The ListPresetsRequest structure. type ListPresetsInput struct { - // When Elastic Transcoder returns more than one page of results, use pageToken in - // subsequent GET requests to get each successive page of results. - PageToken *string - // To list presets in chronological order by the date and time that they were // created, enter true. To list presets in reverse chronological order, enter // false. Ascending *string + + // When Elastic Transcoder returns more than one page of results, use pageToken in + // subsequent GET requests to get each successive page of results. + PageToken *string } // The ListPresetsResponse structure. type ListPresetsOutput struct { - // An array of Preset objects. - Presets []*types.Preset - // A value that you use to access the second and subsequent pages of results, if // any. When the presets fit on one page or when you've reached the last page of // results, the value of NextPageToken is null. NextPageToken *string + // An array of Preset objects. + Presets []*types.Preset + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elastictranscoder/api_op_TestRole.go b/service/elastictranscoder/api_op_TestRole.go index dbce0baf005..1c8d7ac8c2c 100644 --- a/service/elastictranscoder/api_op_TestRole.go +++ b/service/elastictranscoder/api_op_TestRole.go @@ -62,11 +62,11 @@ func (c *Client) TestRole(ctx context.Context, params *TestRoleInput, optFns ... // The TestRoleRequest structure. type TestRoleInput struct { - // The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder - // to test. + // The Amazon S3 bucket that contains media files to be transcoded. The action + // attempts to read from this bucket. // // This member is required. - Role *string + InputBucket *string // The Amazon S3 bucket that Elastic Transcoder writes transcoded media files to. // The action attempts to read from this bucket. @@ -74,30 +74,30 @@ type TestRoleInput struct { // This member is required. OutputBucket *string - // The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics - // that you want the action to send a test notification to. + // The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder + // to test. // // This member is required. - Topics []*string + Role *string - // The Amazon S3 bucket that contains media files to be transcoded. The action - // attempts to read from this bucket. + // The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics + // that you want the action to send a test notification to. // // This member is required. - InputBucket *string + Topics []*string } // The TestRoleResponse structure. type TestRoleOutput struct { - // If the operation is successful, this value is true; otherwise, the value is - // false. - Success *string - // If the Success element contains false, this value is an array of one or more // error messages that were generated during the test process. Messages []*string + // If the operation is successful, this value is true; otherwise, the value is + // false. + Success *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elastictranscoder/api_op_UpdatePipeline.go b/service/elastictranscoder/api_op_UpdatePipeline.go index bb93fec42ac..7ce9744cc83 100644 --- a/service/elastictranscoder/api_op_UpdatePipeline.go +++ b/service/elastictranscoder/api_op_UpdatePipeline.go @@ -74,97 +74,6 @@ type UpdatePipelineInput struct { // Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm. AwsKmsKeyArn *string - // The ThumbnailConfig object specifies several values, including the Amazon S3 - // bucket in which you want Elastic Transcoder to save thumbnail files, which users - // you want to have access to the files, the type of access you want users to have, - // and the storage class that you want to assign to the files. If you specify - // values for ContentConfig, you must also specify values for ThumbnailConfig even - // if you don't want to create thumbnails. If you specify values for ContentConfig - // and ThumbnailConfig, omit the OutputBucket object. - // - // * Bucket: The Amazon S3 - // bucket in which you want Elastic Transcoder to save thumbnail files. - // - // * - // Permissions (Optional): The Permissions object specifies which users and/or - // predefined Amazon S3 groups you want to have access to thumbnail files, and the - // type of access you want them to have. You can grant permissions to a maximum of - // 30 users and/or predefined Amazon S3 groups. - // - // * GranteeType: Specify the - // type of value that appears in the Grantee object: - // - // * Canonical: The - // value in the Grantee object is either the canonical user ID for an AWS account - // or an origin access identity for an Amazon CloudFront distribution. A canonical - // user ID is not the same as an AWS account number. - // - // * Email: The value in - // the Grantee object is the registered email address of an AWS account. - // - // * - // Group: The value in the Grantee object is one of the following predefined Amazon - // S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery. - // - // * Grantee: The AWS - // user or group that you want to have access to thumbnail files. To identify the - // user or group, you can specify the canonical user ID for an AWS account, an - // origin access identity for a CloudFront distribution, the registered email - // address of an AWS account, or a predefined Amazon S3 group. - // - // * Access: The - // permission that you want to give to the AWS user that you specified in Grantee. - // Permissions are granted on the thumbnail files that Elastic Transcoder adds to - // the bucket. Valid values include: - // - // * READ: The grantee can read the - // thumbnails and metadata for objects that Elastic Transcoder adds to the Amazon - // S3 bucket. - // - // * READ_ACP: The grantee can read the object ACL for - // thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. - // - // * - // WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic - // Transcoder adds to the Amazon S3 bucket. - // - // * FULL_CONTROL: The grantee - // has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic - // Transcoder adds to the Amazon S3 bucket. - // - // * StorageClass: The Amazon S3 - // storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder - // to assign to the thumbnails that it stores in your Amazon S3 bucket. - ThumbnailConfig *types.PipelineOutputConfig - - // The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that - // you want to notify to report job status. To receive notifications, you must also - // subscribe to the new topic in the Amazon SNS console. - // - // * Progressing: The - // topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you - // want to notify when Elastic Transcoder has started to process jobs that are - // added to this pipeline. This is the ARN that Amazon SNS returned when you - // created the topic. - // - // * Complete: The topic ARN for the Amazon SNS topic that - // you want to notify when Elastic Transcoder has finished processing a job. This - // is the ARN that Amazon SNS returned when you created the topic. - // - // * Warning: - // The topic ARN for the Amazon SNS topic that you want to notify when Elastic - // Transcoder encounters a warning condition. This is the ARN that Amazon SNS - // returned when you created the topic. - // - // * Error: The topic ARN for the Amazon - // SNS topic that you want to notify when Elastic Transcoder encounters an error - // condition. This is the ARN that Amazon SNS returned when you created the topic. - Notifications *types.Notifications - - // The Amazon S3 bucket in which you saved the media files that you want to - // transcode and the graphics that you want to use as watermarks. - InputBucket *string - // The optional ContentConfig object specifies information about the Amazon S3 // bucket in which you want Elastic Transcoder to save transcoded files and // playlists: which bucket to use, which users you want to have access to the @@ -233,28 +142,119 @@ type UpdatePipelineInput struct { // video files and playlists that it stores in your Amazon S3 bucket. ContentConfig *types.PipelineOutputConfig + // The Amazon S3 bucket in which you saved the media files that you want to + // transcode and the graphics that you want to use as watermarks. + InputBucket *string + // The name of the pipeline. We recommend that the name be unique within the AWS // account, but uniqueness is not enforced. Constraints: Maximum 40 characters Name *string + // The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that + // you want to notify to report job status. To receive notifications, you must also + // subscribe to the new topic in the Amazon SNS console. + // + // * Progressing: The + // topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you + // want to notify when Elastic Transcoder has started to process jobs that are + // added to this pipeline. This is the ARN that Amazon SNS returned when you + // created the topic. + // + // * Complete: The topic ARN for the Amazon SNS topic that + // you want to notify when Elastic Transcoder has finished processing a job. This + // is the ARN that Amazon SNS returned when you created the topic. + // + // * Warning: + // The topic ARN for the Amazon SNS topic that you want to notify when Elastic + // Transcoder encounters a warning condition. This is the ARN that Amazon SNS + // returned when you created the topic. + // + // * Error: The topic ARN for the Amazon + // SNS topic that you want to notify when Elastic Transcoder encounters an error + // condition. This is the ARN that Amazon SNS returned when you created the topic. + Notifications *types.Notifications + // The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder // to use to transcode jobs for this pipeline. Role *string + + // The ThumbnailConfig object specifies several values, including the Amazon S3 + // bucket in which you want Elastic Transcoder to save thumbnail files, which users + // you want to have access to the files, the type of access you want users to have, + // and the storage class that you want to assign to the files. If you specify + // values for ContentConfig, you must also specify values for ThumbnailConfig even + // if you don't want to create thumbnails. If you specify values for ContentConfig + // and ThumbnailConfig, omit the OutputBucket object. + // + // * Bucket: The Amazon S3 + // bucket in which you want Elastic Transcoder to save thumbnail files. + // + // * + // Permissions (Optional): The Permissions object specifies which users and/or + // predefined Amazon S3 groups you want to have access to thumbnail files, and the + // type of access you want them to have. You can grant permissions to a maximum of + // 30 users and/or predefined Amazon S3 groups. + // + // * GranteeType: Specify the + // type of value that appears in the Grantee object: + // + // * Canonical: The + // value in the Grantee object is either the canonical user ID for an AWS account + // or an origin access identity for an Amazon CloudFront distribution. A canonical + // user ID is not the same as an AWS account number. + // + // * Email: The value in + // the Grantee object is the registered email address of an AWS account. + // + // * + // Group: The value in the Grantee object is one of the following predefined Amazon + // S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery. + // + // * Grantee: The AWS + // user or group that you want to have access to thumbnail files. To identify the + // user or group, you can specify the canonical user ID for an AWS account, an + // origin access identity for a CloudFront distribution, the registered email + // address of an AWS account, or a predefined Amazon S3 group. + // + // * Access: The + // permission that you want to give to the AWS user that you specified in Grantee. + // Permissions are granted on the thumbnail files that Elastic Transcoder adds to + // the bucket. Valid values include: + // + // * READ: The grantee can read the + // thumbnails and metadata for objects that Elastic Transcoder adds to the Amazon + // S3 bucket. + // + // * READ_ACP: The grantee can read the object ACL for + // thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. + // + // * + // WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic + // Transcoder adds to the Amazon S3 bucket. + // + // * FULL_CONTROL: The grantee + // has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic + // Transcoder adds to the Amazon S3 bucket. + // + // * StorageClass: The Amazon S3 + // storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder + // to assign to the thumbnails that it stores in your Amazon S3 bucket. + ThumbnailConfig *types.PipelineOutputConfig } // When you update a pipeline, Elastic Transcoder returns the values that you // specified in the request. type UpdatePipelineOutput struct { + // The pipeline updated by this UpdatePipelineResponse call. + Pipeline *types.Pipeline + // Elastic Transcoder returns a warning if the resources used by your pipeline are // not in the same region as the pipeline. Using resources in the same region, such // as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, // reduces processing time and prevents cross-regional charges. Warnings []*types.Warning - // The pipeline updated by this UpdatePipelineResponse call. - Pipeline *types.Pipeline - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/elastictranscoder/go.mod b/service/elastictranscoder/go.mod index 91495002394..8b4644fc58d 100644 --- a/service/elastictranscoder/go.mod +++ b/service/elastictranscoder/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/elastictranscoder go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/elastictranscoder/types/types.go b/service/elastictranscoder/types/types.go index 76e412dc707..51c7e1c5acb 100644 --- a/service/elastictranscoder/types/types.go +++ b/service/elastictranscoder/types/types.go @@ -10,6 +10,13 @@ package types // array. type Artwork struct { + // The format of album art, if any. Valid formats are .jpg and .png. + AlbumArtFormat *string + + // The encryption settings, if any, that you want Elastic Transcoder to apply to + // your artwork. + Encryption *Encryption + // The name of the file to be used as album art. To determine which Amazon S3 // bucket contains the specified file, Elastic Transcoder checks the pipeline // specified by PipelineId; the InputBucket object in that pipeline identifies the @@ -18,6 +25,16 @@ type Artwork struct { // Elastic Transcoder returns an error. InputKey *string + // The maximum height of the output album art in pixels. If you specify auto, + // Elastic Transcoder uses 600 as the default value. If you specify a numeric + // value, enter an even integer between 32 and 3072, inclusive. + MaxHeight *string + + // The maximum width of the output album art in pixels. If you specify auto, + // Elastic Transcoder uses 600 as the default value. If you specify a numeric + // value, enter an even integer between 32 and 4096, inclusive. + MaxWidth *string + // When you set PaddingPolicy to Pad, Elastic Transcoder may add white bars to the // top and bottom and/or left and right sides of the output album art to make the // total size of the output art match the values that you specified for MaxWidth @@ -50,28 +67,23 @@ type Artwork struct { // either value. If you specify this option, Elastic Transcoder does not scale the // art up.

    SizingPolicy *string - - // The encryption settings, if any, that you want Elastic Transcoder to apply to - // your artwork. - Encryption *Encryption - - // The format of album art, if any. Valid formats are .jpg and .png. - AlbumArtFormat *string - - // The maximum height of the output album art in pixels. If you specify auto, - // Elastic Transcoder uses 600 as the default value. If you specify a numeric - // value, enter an even integer between 32 and 3072, inclusive. - MaxHeight *string - - // The maximum width of the output album art in pixels. If you specify auto, - // Elastic Transcoder uses 600 as the default value. If you specify a numeric - // value, enter an even integer between 32 and 4096, inclusive. - MaxWidth *string } // Options associated with your audio codec. type AudioCodecOptions struct { + // You can only choose an audio bit depth when you specify flac or pcm for the + // value of Audio:Codec. The bit depth of a sample is how many bits of information + // are included in the audio samples. The higher the bit depth, the better the + // audio, but the larger the file. Valid values are 16 and 24. The most common bit + // depth is 24. + BitDepth *string + + // You can only choose an audio bit order when you specify pcm for the value of + // Audio:Codec. The order the bits of a PCM sample are stored in. The supported + // value is LittleEndian. + BitOrder *string + // You can only choose an audio profile when you specify AAC for the value of // Audio:Codec. Specify the AAC profile for the output file. Elastic Transcoder // supports the following profiles: @@ -100,46 +112,11 @@ type AudioCodecOptions struct { // and positive numbers (signed) or only positive numbers (unsigned). The supported // value is Signed. Signed *string - - // You can only choose an audio bit order when you specify pcm for the value of - // Audio:Codec. The order the bits of a PCM sample are stored in. The supported - // value is LittleEndian. - BitOrder *string - - // You can only choose an audio bit depth when you specify flac or pcm for the - // value of Audio:Codec. The bit depth of a sample is how many bits of information - // are included in the audio samples. The higher the bit depth, the better the - // audio, but the larger the file. Valid values are 16 and 24. The most common bit - // depth is 24. - BitDepth *string } // Parameters required for transcoding audio. type AudioParameters struct { - // The number of audio channels in the output file. The following values are valid: - // auto, 0, 1, 2 One channel carries the information played by a single speaker. - // For example, a stereo track with two channels sends one channel to the left - // speaker, and the other channel to the right speaker. The output channels are - // organized into tracks. If you want Elastic Transcoder to automatically detect - // the number of audio channels in the input file and use that value for the output - // file, select auto.

    The output of a specific channel value and inputs are as - // follows:

    • auto channel specified, with any - // input: Pass through up to eight input channels.

    • - // 0 channels specified, with any input: Audio omitted from - // the output.

    • 1 channel specified, with at - // least one input channel: Mono sound.

    • 2 - // channels specified, with any input: Two identical mono channels or stereo. - // For more information about tracks, see Audio:AudioPackingMode.

      - //

    For more information about how Elastic Transcoder organizes - // channels and tracks, see Audio:AudioPackingMode.

    - Channels *string - - // The sample rate of the audio stream in the output file, in Hertz. Valid values - // include: auto, 22050, 32000, 44100, 48000, 96000 If you specify auto, Elastic - // Transcoder automatically detects the sample rate. - SampleRate *string - // The method of organizing audio channels and tracks. Use Audio:Channels to // specify the number of channels in your output, and Audio:AudioPackingMode to // specify the number of tracks and their relation to the channels. If you do not @@ -208,24 +185,51 @@ type AudioParameters struct { // AudioPackingMode *string - // If you specified AAC for Audio:Codec, this is the AAC compression profile to - // use. Valid values include: auto, AAC-LC, HE-AAC, HE-AACv2 If you specify auto, - // Elastic Transcoder chooses a profile based on the bit rate of the output file. - CodecOptions *AudioCodecOptions - // The bit rate of the audio stream in the output file, in kilobits/second. Enter // an integer between 64 and 320, inclusive. BitRate *string + // The number of audio channels in the output file. The following values are valid: + // auto, 0, 1, 2 One channel carries the information played by a single speaker. + // For example, a stereo track with two channels sends one channel to the left + // speaker, and the other channel to the right speaker. The output channels are + // organized into tracks. If you want Elastic Transcoder to automatically detect + // the number of audio channels in the input file and use that value for the output + // file, select auto.

    The output of a specific channel value and inputs are as + // follows:

    • auto channel specified, with any + // input: Pass through up to eight input channels.

    • + // 0 channels specified, with any input: Audio omitted from + // the output.

    • 1 channel specified, with at + // least one input channel: Mono sound.

    • 2 + // channels specified, with any input: Two identical mono channels or stereo. + // For more information about tracks, see Audio:AudioPackingMode.

      + //

    For more information about how Elastic Transcoder organizes + // channels and tracks, see Audio:AudioPackingMode.

    + Channels *string + // The audio codec for the output file. Valid values include aac, flac, mp2, mp3, // pcm, and vorbis. Codec *string + + // If you specified AAC for Audio:Codec, this is the AAC compression profile to + // use. Valid values include: auto, AAC-LC, HE-AAC, HE-AACv2 If you specify auto, + // Elastic Transcoder chooses a profile based on the bit rate of the output file. + CodecOptions *AudioCodecOptions + + // The sample rate of the audio stream in the output file, in Hertz. Valid values + // include: auto, 22050, 32000, 44100, 48000, 96000 If you specify auto, Elastic + // Transcoder automatically detects the sample rate. + SampleRate *string } // The file format of the output captions. If you leave this value blank, Elastic // Transcoder returns an error. type CaptionFormat struct { + // The encryption settings, if any, that you want Elastic Transcoder to apply to + // your caption formats. + Encryption *Encryption + // The format you specify determines whether Elastic Transcoder generates an // embedded or sidecar caption for this output. // @@ -276,15 +280,19 @@ type CaptionFormat struct { // "Sydney-{language}-sunrise", and the language of the captions is English (en), // the name of the first caption file is be Sydney-en-sunrise00000.srt. Pattern *string - - // The encryption settings, if any, that you want Elastic Transcoder to apply to - // your caption formats. - Encryption *Encryption } // The captions to be created, if any. type Captions struct { + // The array of file formats for the output captions. If you leave this value + // blank, Elastic Transcoder returns an error. + CaptionFormats []*CaptionFormat + + // Source files for the input sidecar captions used during the transcoding process. + // To omit all sidecar captions, leave CaptionSources blank. + CaptionSources []*CaptionSource + // A policy that determines how Elastic Transcoder handles the existence of // multiple captions. // @@ -306,31 +314,12 @@ type Captions struct { // // MergePolicy cannot be null. MergePolicy *string - - // The array of file formats for the output captions. If you leave this value - // blank, Elastic Transcoder returns an error. - CaptionFormats []*CaptionFormat - - // Source files for the input sidecar captions used during the transcoding process. - // To omit all sidecar captions, leave CaptionSources blank. - CaptionSources []*CaptionSource } // A source file for the input sidecar captions used during the transcoding // process. type CaptionSource struct { - // The label of the caption shown in the player when choosing a language. We - // recommend that you put the caption language name here, in the language of the - // captions. - Label *string - - // For clip generation or captions that do not start at the same time as the - // associated video file, the TimeOffset tells Elastic Transcoder how much of the - // video to encode before including captions. Specify the TimeOffset in the form - // [+-]SS.sss or [+-]HH:mm:SS.ss. - TimeOffset *string - // The encryption settings, if any, that Elastic Transcoder needs to decyrpt your // caption sources, or that you want Elastic Transcoder to apply to your caption // sources. @@ -340,6 +329,11 @@ type CaptionSource struct { // in the output file. Key *string + // The label of the caption shown in the player when choosing a language. We + // recommend that you put the caption language name here, in the language of the + // captions. + Label *string + // A string that specifies the language of the caption. If you specified multiple // inputs with captions, the caption language must match in order to be included in // the output. Specify this as one of: @@ -352,6 +346,12 @@ type CaptionSource struct { // For more information on ISO language codes and // language names, see the List of ISO 639-1 codes. Language *string + + // For clip generation or captions that do not start at the same time as the + // associated video file, the TimeOffset tells Elastic Transcoder how much of the + // video to encode before including captions. Specify the TimeOffset in the form + // [+-]SS.sss or [+-]HH:mm:SS.ss. + TimeOffset *string } // Settings for one clip in a composition. All jobs in a playlist must have the @@ -365,91 +365,12 @@ type Clip struct { // The CreateJobOutput structure. type CreateJobOutput struct { - // Whether you want Elastic Transcoder to create thumbnails for your videos and, if - // so, how you want Elastic Transcoder to name the files. If you don't want Elastic - // Transcoder to create thumbnails, specify "". If you do want Elastic Transcoder - // to create thumbnails, specify the information that you want to include in the - // file name for each thumbnail. You can specify the following values in any - // sequence: - // - // * {count} (Required): If you want to create thumbnails, you must - // include {count} in the ThumbnailPattern object. Wherever you specify {count}, - // Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to - // thumbnail file names. The number indicates where a given thumbnail appears in - // the sequence of thumbnails for a transcoded file. If you specify a literal value - // and/or {resolution} but you omit {count}, Elastic Transcoder returns a - // validation error and does not create the job. - // - // * Literal values (Optional): - // You can specify literal values anywhere in the ThumbnailPattern object. For - // example, you can include them as a file name prefix or as a delimiter between - // {resolution} and {count}. - // - // * {resolution} (Optional): If you want Elastic - // Transcoder to include the resolution in the file name, include {resolution} in - // the ThumbnailPattern object. - // - // When creating thumbnails, Elastic Transcoder - // automatically saves the files in the format (.jpg or .png) that appears in the - // preset that you specified in the PresetID value of CreateJobOutput. Elastic - // Transcoder also appends the applicable file name extension. - ThumbnailPattern *string - - // The encryption settings, if any, that you want Elastic Transcoder to apply to - // your thumbnail. - ThumbnailEncryption *Encryption - - // You can create an output file that contains an excerpt from the input file. This - // excerpt, called a clip, can come from the beginning, middle, or end of the file. - // The Composition object contains settings for the clips that make up an output - // file. For the current release, you can only specify settings for a single clip - // per output file. The Composition object cannot be null. - Composition []*Clip - // Information about the album art that you want Elastic Transcoder to add to the // file during transcoding. You can specify up to twenty album artworks for each // output. Settings for each artwork must be defined in the job for the current // output. AlbumArt *JobAlbumArt - // The name to assign to the transcoded file. Elastic Transcoder saves the file in - // the Amazon S3 bucket specified by the OutputBucket object in the pipeline that - // is specified by the pipeline ID. If a file with the specified name already - // exists in the output bucket, the job fails. - Key *string - - // (Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset in - // PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts - // (MPEG-TS), SegmentDuration is the target maximum duration of each segment in - // seconds. For HLSv3 format playlists, each media segment is stored in a separate - // .ts file. For HLSv4 and Smooth playlists, all media segments for an output are - // stored in a single file. Each segment is approximately the length of the - // SegmentDuration, though individual segments might be shorter or longer.

    The - // range of valid values is 1 to 60 seconds. If the duration of the video is not - // evenly divisible by SegmentDuration, the duration of the last - // segment is the remainder of total length/SegmentDuration.

    Elastic - // Transcoder creates an output-specific playlist for each output HLS - // output that you specify in OutputKeys. To add an output to the master playlist - // for this job, include it in the OutputKeys of the associated - // playlist.

    - SegmentDuration *string - - // The number of degrees clockwise by which you want Elastic Transcoder to rotate - // the output relative to the input. Enter one of the following values: auto, 0, - // 90, 180, 270. The value auto generally works only if the file that you're - // transcoding contains rotation metadata. - Rotate *string - - // You can specify encryption settings for any output files that you want to use - // for a transcoding job. This includes the output file and any watermarks, - // thumbnails, album art, or captions that you want to use. You must specify - // encryption settings for each file individually. - Encryption *Encryption - - // The Id of the preset to use for this job. The preset determines the audio, - // video, and thumbnail settings that Elastic Transcoder uses for transcoding. - PresetId *string - // You can configure Elastic Transcoder to transcode captions, or subtitles, from // one format to another. All captions must be in UTF-8. Elastic Transcoder // supports two types of captions: @@ -483,24 +404,103 @@ type CreateJobOutput struct { // Extensible Metadata Platform and Sidecar file Wikipedia pages. Captions *Captions - // Information about the watermarks that you want Elastic Transcoder to add to the - // video during transcoding. You can specify up to four watermarks for each output. - // Settings for each watermark must be defined in the preset for the current - // output. - Watermarks []*JobWatermark -} - -// Information about the master playlist. -type CreateJobPlaylist struct { + // You can create an output file that contains an excerpt from the input file. This + // excerpt, called a clip, can come from the beginning, middle, or end of the file. + // The Composition object contains settings for the clips that make up an output + // file. For the current release, you can only specify settings for a single clip + // per output file. The Composition object cannot be null. + Composition []*Clip - // The DRM settings, if any, that you want Elastic Transcoder to apply to the - // output files associated with this playlist. - PlayReadyDrm *PlayReadyDrm + // You can specify encryption settings for any output files that you want to use + // for a transcoding job. This includes the output file and any watermarks, + // thumbnails, album art, or captions that you want to use. You must specify + // encryption settings for each file individually. + Encryption *Encryption + + // The name to assign to the transcoded file. Elastic Transcoder saves the file in + // the Amazon S3 bucket specified by the OutputBucket object in the pipeline that + // is specified by the pipeline ID. If a file with the specified name already + // exists in the output bucket, the job fails. + Key *string + + // The Id of the preset to use for this job. The preset determines the audio, + // video, and thumbnail settings that Elastic Transcoder uses for transcoding. + PresetId *string + + // The number of degrees clockwise by which you want Elastic Transcoder to rotate + // the output relative to the input. Enter one of the following values: auto, 0, + // 90, 180, 270. The value auto generally works only if the file that you're + // transcoding contains rotation metadata. + Rotate *string + + // (Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset in + // PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts + // (MPEG-TS), SegmentDuration is the target maximum duration of each segment in + // seconds. For HLSv3 format playlists, each media segment is stored in a separate + // .ts file. For HLSv4 and Smooth playlists, all media segments for an output are + // stored in a single file. Each segment is approximately the length of the + // SegmentDuration, though individual segments might be shorter or longer.

    The + // range of valid values is 1 to 60 seconds. If the duration of the video is not + // evenly divisible by SegmentDuration, the duration of the last + // segment is the remainder of total length/SegmentDuration.

    Elastic + // Transcoder creates an output-specific playlist for each output HLS + // output that you specify in OutputKeys. To add an output to the master playlist + // for this job, include it in the OutputKeys of the associated + // playlist.

    + SegmentDuration *string + + // The encryption settings, if any, that you want Elastic Transcoder to apply to + // your thumbnail. + ThumbnailEncryption *Encryption + + // Whether you want Elastic Transcoder to create thumbnails for your videos and, if + // so, how you want Elastic Transcoder to name the files. If you don't want Elastic + // Transcoder to create thumbnails, specify "". If you do want Elastic Transcoder + // to create thumbnails, specify the information that you want to include in the + // file name for each thumbnail. You can specify the following values in any + // sequence: + // + // * {count} (Required): If you want to create thumbnails, you must + // include {count} in the ThumbnailPattern object. Wherever you specify {count}, + // Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to + // thumbnail file names. The number indicates where a given thumbnail appears in + // the sequence of thumbnails for a transcoded file. If you specify a literal value + // and/or {resolution} but you omit {count}, Elastic Transcoder returns a + // validation error and does not create the job. + // + // * Literal values (Optional): + // You can specify literal values anywhere in the ThumbnailPattern object. For + // example, you can include them as a file name prefix or as a delimiter between + // {resolution} and {count}. + // + // * {resolution} (Optional): If you want Elastic + // Transcoder to include the resolution in the file name, include {resolution} in + // the ThumbnailPattern object. + // + // When creating thumbnails, Elastic Transcoder + // automatically saves the files in the format (.jpg or .png) that appears in the + // preset that you specified in the PresetID value of CreateJobOutput. Elastic + // Transcoder also appends the applicable file name extension. + ThumbnailPattern *string + + // Information about the watermarks that you want Elastic Transcoder to add to the + // video during transcoding. You can specify up to four watermarks for each output. + // Settings for each watermark must be defined in the preset for the current + // output. + Watermarks []*JobWatermark +} + +// Information about the master playlist. +type CreateJobPlaylist struct { // The format of the output playlist. Valid formats include HLSv3, HLSv4, and // Smooth. Format *string + // The HLS content protection settings, if any, that you want Elastic Transcoder to + // apply to the output files associated with this playlist. + HlsContentProtection *HlsContentProtection + // The name that you want Elastic Transcoder to assign to the master playlist, for // example, nyc-vacation.m3u8. If the name includes a / character, the section of // the name before the last / must be identical for all Name objects. If you create @@ -543,29 +543,29 @@ type CreateJobPlaylist struct { // be the same for all outputs.

    OutputKeys []*string - // The HLS content protection settings, if any, that you want Elastic Transcoder to - // apply to the output files associated with this playlist. - HlsContentProtection *HlsContentProtection + // The DRM settings, if any, that you want Elastic Transcoder to apply to the + // output files associated with this playlist. + PlayReadyDrm *PlayReadyDrm } // The detected properties of the input file. Elastic Transcoder identifies these // values from the input file. type DetectedProperties struct { - // The detected width of the input file, in pixels. - Width *int32 + // The detected duration of the input file, in milliseconds. + DurationMillis *int64 // The detected file size of the input file, in bytes. FileSize *int64 + // The detected frame rate of the input file, in frames per second. + FrameRate *string + // The detected height of the input file, in pixels. Height *int32 - // The detected duration of the input file, in milliseconds. - DurationMillis *int64 - - // The detected frame rate of the input file, in frames per second. - FrameRate *string + // The detected width of the input file, in pixels. + Width *int32 } // The encryption settings, if any, that are used for decrypting your input files @@ -575,6 +575,27 @@ type DetectedProperties struct { // output files. type Encryption struct { + // The series of random bits created by a random bit generator, unique for every + // encryption operation, that you used to encrypt your input files or that you want + // Elastic Transcoder to use to encrypt your output files. The initialization + // vector must be base64-encoded, and it must be exactly 16 bytes long before being + // base64-encoded. + InitializationVector *string + + // The data encryption key that you want Elastic Transcoder to use to encrypt your + // output file, or that was used to encrypt your input file. The key must be + // base64-encoded and it must be one of the following bit lengths before being + // base64-encoded: 128, 192, or 256. The key must also be encrypted by using the + // Amazon Key Management Service. + Key *string + + // The MD5 digest of the key that you used to encrypt your input file, or that you + // want Elastic Transcoder to use to encrypt your output file. Elastic Transcoder + // uses the key digest as a checksum to make sure your key was not corrupted in + // transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes + // long before being base64-encoded. + KeyMd5 *string + // The specific server-side encryption mode that you want Elastic Transcoder to use // when decrypting your input files or encrypting your output files. Elastic // Transcoder supports the following options: @@ -613,27 +634,6 @@ type Encryption struct { // important that you safely manage your encryption keys. If you lose them, you // won't be able to unencrypt your data. Mode *string - - // The data encryption key that you want Elastic Transcoder to use to encrypt your - // output file, or that was used to encrypt your input file. The key must be - // base64-encoded and it must be one of the following bit lengths before being - // base64-encoded: 128, 192, or 256. The key must also be encrypted by using the - // Amazon Key Management Service. - Key *string - - // The MD5 digest of the key that you used to encrypt your input file, or that you - // want Elastic Transcoder to use to encrypt your output file. Elastic Transcoder - // uses the key digest as a checksum to make sure your key was not corrupted in - // transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes - // long before being base64-encoded. - KeyMd5 *string - - // The series of random bits created by a random bit generator, unique for every - // encryption operation, that you used to encrypt your input files or that you want - // Elastic Transcoder to use to encrypt your output files. The initialization - // vector must be base64-encoded, and it must be exactly 16 bytes long before being - // base64-encoded. - InitializationVector *string } // The HLS content protection settings, if any, that you want Elastic Transcoder to @@ -641,16 +641,11 @@ type Encryption struct { type HlsContentProtection struct { // If Elastic Transcoder is generating your key for you, you must leave this field - // blank. The MD5 digest of the key that you want Elastic Transcoder to use to - // encrypt your output file, and that you want Elastic Transcoder to use as a - // checksum to make sure your key was not corrupted in transit. The key MD5 must be - // base64-encoded, and it must be exactly 16 bytes before being base64- encoded. - KeyMd5 *string - - // The location of the license key required to decrypt your HLS playlist. The URL - // must be an absolute path, and is referenced in the URI attribute of the - // EXT-X-KEY metadata tag in the playlist file. - LicenseAcquisitionUrl *string + // blank. The series of random bits created by a random bit generator, unique for + // every encryption operation, that you want Elastic Transcoder to use to encrypt + // your output files. The initialization vector must be base64-encoded, and it must + // be exactly 16 bytes before being base64-encoded. + InitializationVector *string // If you want Elastic Transcoder to generate a key for you, leave this field // blank. If you choose to supply your own key, you must encrypt the key by using @@ -658,23 +653,28 @@ type HlsContentProtection struct { // lengths before being base64-encoded: 128, 192, or 256. Key *string + // If Elastic Transcoder is generating your key for you, you must leave this field + // blank. The MD5 digest of the key that you want Elastic Transcoder to use to + // encrypt your output file, and that you want Elastic Transcoder to use as a + // checksum to make sure your key was not corrupted in transit. The key MD5 must be + // base64-encoded, and it must be exactly 16 bytes before being base64- encoded. + KeyMd5 *string + // Specify whether you want Elastic Transcoder to write your HLS license key to an // Amazon S3 bucket. If you choose WithVariantPlaylists, LicenseAcquisitionUrl must // be left blank and Elastic Transcoder writes your data key into the same bucket // as the associated playlist. KeyStoragePolicy *string + // The location of the license key required to decrypt your HLS playlist. The URL + // must be an absolute path, and is referenced in the URI attribute of the + // EXT-X-KEY metadata tag in the playlist file. + LicenseAcquisitionUrl *string + // The content protection method for your output. The only valid value is: aes-128. // This value is written into the method attribute of the EXT-X-KEY metadata tag in // the output playlist. Method *string - - // If Elastic Transcoder is generating your key for you, you must leave this field - // blank. The series of random bits created by a random bit generator, unique for - // every encryption operation, that you want Elastic Transcoder to use to encrypt - // your output files. The initialization vector must be base64-encoded, and it must - // be exactly 16 bytes before being base64-encoded. - InitializationVector *string } // The captions to be created, if any. @@ -711,6 +711,13 @@ type InputCaptions struct { // created. type Job struct { + // The Amazon Resource Name (ARN) for the job. + Arn *string + + // The identifier that Elastic Transcoder assigned to the job. You use this value + // to get settings for the job or to delete the job. + Id *string + // A section of the request or response body that provides information about the // file that is being transcoded. Input *JobInput @@ -720,12 +727,19 @@ type Job struct { // output. Inputs []*JobInput - // The Amazon Resource Name (ARN) for the job. - Arn *string + // If you specified one output for a job, information about that output. If you + // specified multiple outputs for a job, the Output object lists information about + // the first output. This duplicates the information that is listed for the first + // output in the Outputs object. Outputs recommended instead. A section of the + // request or response body that provides information about the transcoded (target) + // file. + Output *JobOutput - // The identifier that Elastic Transcoder assigned to the job. You use this value - // to get settings for the job or to delete the job. - Id *string + // The value, if any, that you want Elastic Transcoder to prepend to the names of + // all files that this job creates, including output files, thumbnails, and + // playlists. We recommend that you add a / or some other delimiter to the end of + // the OutputKeyPrefix. + OutputKeyPrefix *string // Information about the output files. We recommend that you use the Outputs syntax // for all jobs, even when you want Elastic Transcoder to transcode a file into @@ -735,6 +749,25 @@ type Job struct { // in the order in which you specify them in the job. Outputs []*JobOutput + // The Id of the pipeline that you want Elastic Transcoder to use for transcoding. + // The pipeline determines several settings, including the Amazon S3 bucket from + // which Elastic Transcoder gets the files to transcode and the bucket into which + // Elastic Transcoder puts the transcoded files. + PipelineId *string + + // Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset in + // PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts + // (MPEG-TS), Playlists contains information about the master playlists that you + // want Elastic Transcoder to create. The maximum number of master playlists in a + // job is 30. + Playlists []*Playlist + + // The status of the job: Submitted, Progressing, Complete, Canceled, or Error. + Status *string + + // Details about the timing of a job. + Timing *Timing + // User-defined metadata that you want to associate with an Elastic Transcoder job. // You specify metadata in key/value pairs, and you can add up to 10 key/value // pairs per job. Elastic Transcoder does not guarantee that key/value pairs are @@ -750,74 +783,36 @@ type Job struct { // // * The following symbols: _.:/=+-%@ UserMetadata map[string]*string +} - // Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset in - // PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts - // (MPEG-TS), Playlists contains information about the master playlists that you - // want Elastic Transcoder to create. The maximum number of master playlists in a - // job is 30. - Playlists []*Playlist +// The .jpg or .png file associated with an audio file. +type JobAlbumArt struct { - // Details about the timing of a job. - Timing *Timing + // The file to be used as album art. There can be multiple artworks associated with + // an audio file, to a maximum of 20. Valid formats are .jpg and .png + Artwork []*Artwork - // The Id of the pipeline that you want Elastic Transcoder to use for transcoding. - // The pipeline determines several settings, including the Amazon S3 bucket from - // which Elastic Transcoder gets the files to transcode and the bucket into which - // Elastic Transcoder puts the transcoded files. - PipelineId *string - - // If you specified one output for a job, information about that output. If you - // specified multiple outputs for a job, the Output object lists information about - // the first output. This duplicates the information that is listed for the first - // output in the Outputs object. Outputs recommended instead. A section of the - // request or response body that provides information about the transcoded (target) - // file. - Output *JobOutput - - // The value, if any, that you want Elastic Transcoder to prepend to the names of - // all files that this job creates, including output files, thumbnails, and - // playlists. We recommend that you add a / or some other delimiter to the end of - // the OutputKeyPrefix. - OutputKeyPrefix *string - - // The status of the job: Submitted, Progressing, Complete, Canceled, or Error. - Status *string -} - -// The .jpg or .png file associated with an audio file. -type JobAlbumArt struct { - - // The file to be used as album art. There can be multiple artworks associated with - // an audio file, to a maximum of 20. Valid formats are .jpg and .png - Artwork []*Artwork - - // A policy that determines how Elastic Transcoder handles the existence of - // multiple album artwork files.

    • Replace: The specified - // album art replaces any existing album art.

    • - // Prepend: The specified album art is placed in front of any existing - // album art.

    • Append: The specified album art is - // placed after any existing album art.

    • Fallback: - // If the original input file contains artwork, Elastic Transcoder uses that - // artwork for the output. If the original input does not contain artwork, Elastic - // Transcoder uses the specified album art file.

    - MergePolicy *string -} + // A policy that determines how Elastic Transcoder handles the existence of + // multiple album artwork files.

    • Replace: The specified + // album art replaces any existing album art.

    • + // Prepend: The specified album art is placed in front of any existing + // album art.

    • Append: The specified album art is + // placed after any existing album art.

    • Fallback: + // If the original input file contains artwork, Elastic Transcoder uses that + // artwork for the output. If the original input does not contain artwork, Elastic + // Transcoder uses the specified album art file.

    + MergePolicy *string +} // Information about the file that you're transcoding. type JobInput struct { - // The encryption settings, if any, that are used for decrypting your input files. - // If your input file is encrypted, you must specify the mode that Elastic - // Transcoder uses to decrypt your file. - Encryption *Encryption - - // This value must be auto, which causes Elastic Transcoder to automatically detect - // the resolution of the input file. - Resolution *string - - // Settings for clipping an input. Each input can have different clip settings. - TimeSpan *TimeSpan + // The aspect ratio of the input file. If you want Elastic Transcoder to + // automatically detect the aspect ratio of the input file, specify auto. If you + // want to specify the aspect ratio for the output file, enter one of the following + // values: 1:1, 4:3, 3:2, 16:9 If you specify a value other than auto, Elastic + // Transcoder disables automatic detection of the aspect ratio. + AspectRatio *string // The container type for the input file. If you want Elastic Transcoder to // automatically detect the container type of the input file, specify auto. If you @@ -826,30 +821,13 @@ type JobInput struct { // mpeg-ps, mpeg-ts, mxf, ogg, vob, wav, webm Container *string - // The name of the file to transcode. Elsewhere in the body of the JSON block is - // the the ID of the pipeline to use for processing the job. The InputBucket object - // in that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file - // from. If the file name includes a prefix, such as cooking/lasagna.mpg, include - // the prefix in the key. If the file isn't in the specified bucket, Elastic - // Transcoder returns an error. - Key *string - // The detected properties of the input file. DetectedProperties *DetectedProperties - // Whether the input file is interlaced. If you want Elastic Transcoder to - // automatically detect whether the input file is interlaced, specify auto. If you - // want to specify whether the input file is interlaced, enter one of the following - // values: true, false If you specify a value other than auto, Elastic Transcoder - // disables automatic detection of interlacing. - Interlaced *string - - // The aspect ratio of the input file. If you want Elastic Transcoder to - // automatically detect the aspect ratio of the input file, specify auto. If you - // want to specify the aspect ratio for the output file, enter one of the following - // values: 1:1, 4:3, 3:2, 16:9 If you specify a value other than auto, Elastic - // Transcoder disables automatic detection of the aspect ratio. - AspectRatio *string + // The encryption settings, if any, that are used for decrypting your input files. + // If your input file is encrypted, you must specify the mode that Elastic + // Transcoder uses to decrypt your file. + Encryption *Encryption // The frame rate of the input file. If you want Elastic Transcoder to // automatically detect the frame rate of the input file, specify auto. If you want @@ -890,6 +868,28 @@ type JobInput struct { // Subtitles Wikipedia page. For more information on sidecar files, see the // Extensible Metadata Platform and Sidecar file Wikipedia pages. InputCaptions *InputCaptions + + // Whether the input file is interlaced. If you want Elastic Transcoder to + // automatically detect whether the input file is interlaced, specify auto. If you + // want to specify whether the input file is interlaced, enter one of the following + // values: true, false If you specify a value other than auto, Elastic Transcoder + // disables automatic detection of interlacing. + Interlaced *string + + // The name of the file to transcode. Elsewhere in the body of the JSON block is + // the the ID of the pipeline to use for processing the job. The InputBucket object + // in that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file + // from. If the file name includes a prefix, such as cooking/lasagna.mpg, include + // the prefix in the key. If the file isn't in the specified bucket, Elastic + // Transcoder returns an error. + Key *string + + // This value must be auto, which causes Elastic Transcoder to automatically detect + // the resolution of the input file. + Resolution *string + + // Settings for clipping an input. Each input can have different clip settings. + TimeSpan *TimeSpan } // Outputs recommended instead. If you specified one output for a job, information @@ -898,12 +898,14 @@ type JobInput struct { // that is listed for the first output in the Outputs object. type JobOutput struct { - // The encryption settings, if any, that you want Elastic Transcoder to apply to - // your thumbnail. - ThumbnailEncryption *Encryption + // The album art to be associated with the output file, if any. + AlbumArt *JobAlbumArt - // Duration of the output file, in seconds. - Duration *int64 + // If Elastic Transcoder used a preset with a ColorSpaceConversionMode to transcode + // the output file, the AppliedColorSpaceConversion parameter shows the conversion + // used. If no ColorSpaceConversionMode was defined in the preset, this parameter + // is not be included in the job response. + AppliedColorSpaceConversion *string // You can configure Elastic Transcoder to transcode captions, or subtitles, from // one format to another. All captions must be in UTF-8. Elastic Transcoder @@ -938,20 +940,18 @@ type JobOutput struct { // Extensible Metadata Platform and Sidecar file Wikipedia pages. Captions *Captions - // Information about the watermarks that you want Elastic Transcoder to add to the - // video during transcoding. You can specify up to four watermarks for each output. - // Settings for each watermark must be defined in the preset that you specify in - // Preset for the current output. Watermarks are added to the output video in the - // sequence in which you list them in the job output—the first watermark in the - // list is added to the output video first, the second watermark in the list is - // added next, and so on. As a result, if the settings in a preset cause Elastic - // Transcoder to place all watermarks in the same location, the second watermark - // that you add covers the first one, the third one covers the second, and the - // fourth one covers the third. - Watermarks []*JobWatermark + // You can create an output file that contains an excerpt from the input file. This + // excerpt, called a clip, can come from the beginning, middle, or end of the file. + // The Composition object contains settings for the clips that make up an output + // file. For the current release, you can only specify settings for a single clip + // per output file. The Composition object cannot be null. + Composition []*Clip - // Information that further explains Status. - StatusDetail *string + // Duration of the output file, in seconds. + Duration *int64 + + // Duration of the output file, in milliseconds. + DurationMillis *int64 // The encryption settings, if any, that you want Elastic Transcoder to apply to // your output files. If you choose to use encryption, you must specify a mode to @@ -959,6 +959,38 @@ type JobOutput struct { // unencrypted file to your Amazon S3 bucket. Encryption *Encryption + // File size of the output file, in bytes. + FileSize *int64 + + // Frame rate of the output file, in frames per second. + FrameRate *string + + // Height of the output file, in pixels. + Height *int32 + + // A sequential counter, starting with 1, that identifies an output among the + // outputs from the current job. In the Output syntax, this value is always 1. + Id *string + + // The name to assign to the transcoded file. Elastic Transcoder saves the file in + // the Amazon S3 bucket specified by the OutputBucket object in the pipeline that + // is specified by the pipeline ID. + Key *string + + // The value of the Id object for the preset that you want to use for this job. The + // preset determines the audio, video, and thumbnail settings that Elastic + // Transcoder uses for transcoding. To use a preset that you created, specify the + // preset ID that Elastic Transcoder returned in the response when you created the + // preset. You can also use the Elastic Transcoder system presets, which you can + // get with ListPresets. + PresetId *string + + // The number of degrees clockwise by which you want Elastic Transcoder to rotate + // the output relative to the input. Enter one of the following values: auto, 0, + // 90, 180, 270 The value auto generally works only if the file that you're + // transcoding contains rotation metadata. + Rotate *string + // (Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset in // PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts // (MPEG-TS), SegmentDuration is the target maximum duration of each segment in @@ -975,16 +1007,6 @@ type JobOutput struct { // playlist.

    SegmentDuration *string - // Duration of the output file, in milliseconds. - DurationMillis *int64 - - // You can create an output file that contains an excerpt from the input file. This - // excerpt, called a clip, can come from the beginning, middle, or end of the file. - // The Composition object contains settings for the clips that make up an output - // file. For the current release, you can only specify settings for a single clip - // per output file. The Composition object cannot be null. - Composition []*Clip - // The status of one output in a job. If you specified only one output for the job, // Outputs:Status is always the same as Job:Status. If you specified more than one // output: @@ -1010,6 +1032,13 @@ type JobOutput struct { // the following: Submitted, Progressing, Complete, Canceled, or Error. Status *string + // Information that further explains Status. + StatusDetail *string + + // The encryption settings, if any, that you want Elastic Transcoder to apply to + // your thumbnail. + ThumbnailEncryption *Encryption + // Whether you want Elastic Transcoder to create thumbnails for your videos and, if // so, how you want Elastic Transcoder to name the files. If you don't want Elastic // Transcoder to create thumbnails, specify "". If you do want Elastic Transcoder @@ -1040,55 +1069,30 @@ type JobOutput struct { // Transcoder also appends the applicable file name extension. ThumbnailPattern *string + // Information about the watermarks that you want Elastic Transcoder to add to the + // video during transcoding. You can specify up to four watermarks for each output. + // Settings for each watermark must be defined in the preset that you specify in + // Preset for the current output. Watermarks are added to the output video in the + // sequence in which you list them in the job output—the first watermark in the + // list is added to the output video first, the second watermark in the list is + // added next, and so on. As a result, if the settings in a preset cause Elastic + // Transcoder to place all watermarks in the same location, the second watermark + // that you add covers the first one, the third one covers the second, and the + // fourth one covers the third. + Watermarks []*JobWatermark + // Specifies the width of the output file in pixels. Width *int32 - - // If Elastic Transcoder used a preset with a ColorSpaceConversionMode to transcode - // the output file, the AppliedColorSpaceConversion parameter shows the conversion - // used. If no ColorSpaceConversionMode was defined in the preset, this parameter - // is not be included in the job response. - AppliedColorSpaceConversion *string - - // A sequential counter, starting with 1, that identifies an output among the - // outputs from the current job. In the Output syntax, this value is always 1. - Id *string - - // The number of degrees clockwise by which you want Elastic Transcoder to rotate - // the output relative to the input. Enter one of the following values: auto, 0, - // 90, 180, 270 The value auto generally works only if the file that you're - // transcoding contains rotation metadata. - Rotate *string - - // Frame rate of the output file, in frames per second. - FrameRate *string - - // The value of the Id object for the preset that you want to use for this job. The - // preset determines the audio, video, and thumbnail settings that Elastic - // Transcoder uses for transcoding. To use a preset that you created, specify the - // preset ID that Elastic Transcoder returned in the response when you created the - // preset. You can also use the Elastic Transcoder system presets, which you can - // get with ListPresets. - PresetId *string - - // Height of the output file, in pixels. - Height *int32 - - // File size of the output file, in bytes. - FileSize *int64 - - // The album art to be associated with the output file, if any. - AlbumArt *JobAlbumArt - - // The name to assign to the transcoded file. Elastic Transcoder saves the file in - // the Amazon S3 bucket specified by the OutputBucket object in the pipeline that - // is specified by the pipeline ID. - Key *string } // Watermarks can be in .png or .jpg format. If you want to display a watermark // that is not rectangular, use the .png format, which supports transparency. type JobWatermark struct { + // The encryption settings, if any, that you want Elastic Transcoder to apply to + // your watermarks. + Encryption *Encryption + // The name of the .png or .jpg file that you want to use for the watermark. To // determine which Amazon S3 bucket contains the specified file, Elastic Transcoder // checks the pipeline specified by Pipeline; the Input Bucket object in that @@ -1097,10 +1101,6 @@ type JobWatermark struct { // specified bucket, Elastic Transcoder returns an error. InputKey *string - // The encryption settings, if any, that you want Elastic Transcoder to apply to - // your watermarks. - Encryption *Encryption - // The ID of the watermark settings that Elastic Transcoder uses to add watermarks // to the video during transcoding. The settings are in the preset specified by // Preset for the current output. In that preset, the value of Watermarks Id tells @@ -1113,10 +1113,6 @@ type JobWatermark struct { // the new topic in the Amazon SNS console. type Notifications struct { - // The Amazon Simple Notification Service (Amazon SNS) topic that you want to - // notify when Elastic Transcoder has started to process the job. - Progressing *string - // The Amazon SNS topic that you want to notify when Elastic Transcoder has // finished processing the job. Completed *string @@ -1125,6 +1121,10 @@ type Notifications struct { // an error condition. Error *string + // The Amazon Simple Notification Service (Amazon SNS) topic that you want to + // notify when Elastic Transcoder has started to process the job. + Progressing *string + // The Amazon SNS topic that you want to notify when Elastic Transcoder encounters // a warning condition. Warning *string @@ -1133,26 +1133,6 @@ type Notifications struct { // The Permission structure. type Permission struct { - // The AWS user or group that you want to have access to transcoded files and - // playlists. To identify the user or group, you can specify the canonical user ID - // for an AWS account, an origin access identity for a CloudFront distribution, the - // registered email address of an AWS account, or a predefined Amazon S3 group. - Grantee *string - - // The type of value that appears in the Grantee object: - // - // * Canonical: Either - // the canonical user ID for an AWS account or an origin access identity for an - // Amazon CloudFront distribution. A canonical user ID is not the same as an AWS - // account number. - // - // * Email: The registered email address of an AWS account. - // - // - // * Group: One of the following predefined Amazon S3 groups: AllUsers, - // AuthenticatedUsers, or LogDelivery. - GranteeType *string - // The permission that you want to give to the AWS user that is listed in Grantee. // Valid values include: // @@ -1171,67 +1151,41 @@ type Permission struct { // permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 // bucket. Access []*string -} -// The pipeline (queue) that is used to manage jobs. -type Pipeline struct { + // The AWS user or group that you want to have access to transcoded files and + // playlists. To identify the user or group, you can specify the canonical user ID + // for an AWS account, an origin access identity for a CloudFront distribution, the + // registered email address of an AWS account, or a predefined Amazon S3 group. + Grantee *string - // Information about the Amazon S3 bucket in which you want Elastic Transcoder to - // save thumbnail files. Either you specify both ContentConfig and ThumbnailConfig, - // or you specify OutputBucket. - // - // * Bucket: The Amazon S3 bucket in which you - // want Elastic Transcoder to save thumbnail files. - // - // * Permissions: A list of - // the users and/or predefined Amazon S3 groups you want to have access to - // thumbnail files, and the type of access that you want them to have. - // - // * - // GranteeType: The type of value that appears in the Grantee object: - // - // - // * Canonical: Either the canonical user ID for an AWS account or an origin access - // identity for an Amazon CloudFront distribution. A canonical user ID is not the - // same as an AWS account number. - // - // * Email: The registered email - // address of an AWS account. - // - // * Group: One of the following predefined - // Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery. - // - // * - // Grantee: The AWS user or group that you want to have access to thumbnail - // files. - // - // * Access: The permission that you want to give to the AWS user - // that is listed in Grantee. Valid values include: - // - // * READ: The - // grantee can read the thumbnails and metadata for thumbnails that Elastic - // Transcoder adds to the Amazon S3 bucket. - // - // * READ_ACP: The grantee - // can read the object ACL for thumbnails that Elastic Transcoder adds to the - // Amazon S3 bucket. + // The type of value that appears in the Grantee object: // - // * WRITE_ACP: The grantee can write the ACL for - // the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. + // * Canonical: Either + // the canonical user ID for an AWS account or an origin access identity for an + // Amazon CloudFront distribution. A canonical user ID is not the same as an AWS + // account number. // + // * Email: The registered email address of an AWS account. // - // * FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for - // the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. // - // * - // StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that - // you want Elastic Transcoder to assign to the thumbnails that it stores in your - // Amazon S3 bucket. - ThumbnailConfig *PipelineOutputConfig + // * Group: One of the following predefined Amazon S3 groups: AllUsers, + // AuthenticatedUsers, or LogDelivery. + GranteeType *string +} - // The name of the pipeline. We recommend that the name be unique within the AWS - // account, but uniqueness is not enforced. Constraints: Maximum 40 characters - Name *string +// The pipeline (queue) that is used to manage jobs. +type Pipeline struct { + + // The Amazon Resource Name (ARN) for the pipeline. + Arn *string + + // The AWS Key Management Service (AWS KMS) key that you want to use with this + // pipeline. If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't + // need to provide a key with your job because a default key, known as an AWS-KMS + // key, is created for you automatically. You need to provide an AWS-KMS key only + // if you want to use a non-default AWS-KMS key, or if you are using an + // Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm. + AwsKmsKeyArn *string // Information about the Amazon S3 bucket in which you want Elastic Transcoder to // save transcoded files and playlists. Either you specify both ContentConfig and @@ -1286,6 +1240,19 @@ type Pipeline struct { // Amazon S3 bucket. ContentConfig *PipelineOutputConfig + // The identifier for the pipeline. You use this value to identify the pipeline in + // which you want to perform a variety of operations, such as creating a job or a + // preset. + Id *string + + // The Amazon S3 bucket from which Elastic Transcoder gets media files for + // transcoding and the graphics files, if any, that you want to use for watermarks. + InputBucket *string + + // The name of the pipeline. We recommend that the name be unique within the AWS + // account, but uniqueness is not enforced. Constraints: Maximum 40 characters + Name *string + // The Amazon Simple Notification Service (Amazon SNS) topic that you want to // notify to report job status. To receive notifications, you must also subscribe // to the new topic in the Amazon SNS console. @@ -1306,35 +1273,15 @@ type Pipeline struct { // when Elastic Transcoder encounters an error condition. Notifications *Notifications - // The identifier for the pipeline. You use this value to identify the pipeline in - // which you want to perform a variety of operations, such as creating a job or a - // preset. - Id *string - - // The Amazon Resource Name (ARN) for the pipeline. - Arn *string - - // The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to - // transcode jobs for this pipeline. - Role *string - - // The AWS Key Management Service (AWS KMS) key that you want to use with this - // pipeline. If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't - // need to provide a key with your job because a default key, known as an AWS-KMS - // key, is created for you automatically. You need to provide an AWS-KMS key only - // if you want to use a non-default AWS-KMS key, or if you are using an - // Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm. - AwsKmsKeyArn *string - - // The Amazon S3 bucket from which Elastic Transcoder gets media files for - // transcoding and the graphics files, if any, that you want to use for watermarks. - InputBucket *string - // The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded // files, thumbnails, and playlists. Either you specify this value, or you specify // both ContentConfig and ThumbnailConfig. OutputBucket *string + // The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to + // transcode jobs for this pipeline. + Role *string + // The current status of the pipeline: // // * Active: The pipeline is processing @@ -1342,23 +1289,64 @@ type Pipeline struct { // // * Paused: The pipeline is not currently processing jobs. Status *string + + // Information about the Amazon S3 bucket in which you want Elastic Transcoder to + // save thumbnail files. Either you specify both ContentConfig and ThumbnailConfig, + // or you specify OutputBucket. + // + // * Bucket: The Amazon S3 bucket in which you + // want Elastic Transcoder to save thumbnail files. + // + // * Permissions: A list of + // the users and/or predefined Amazon S3 groups you want to have access to + // thumbnail files, and the type of access that you want them to have. + // + // * + // GranteeType: The type of value that appears in the Grantee object: + // + // + // * Canonical: Either the canonical user ID for an AWS account or an origin access + // identity for an Amazon CloudFront distribution. A canonical user ID is not the + // same as an AWS account number. + // + // * Email: The registered email + // address of an AWS account. + // + // * Group: One of the following predefined + // Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery. + // + // * + // Grantee: The AWS user or group that you want to have access to thumbnail + // files. + // + // * Access: The permission that you want to give to the AWS user + // that is listed in Grantee. Valid values include: + // + // * READ: The + // grantee can read the thumbnails and metadata for thumbnails that Elastic + // Transcoder adds to the Amazon S3 bucket. + // + // * READ_ACP: The grantee + // can read the object ACL for thumbnails that Elastic Transcoder adds to the + // Amazon S3 bucket. + // + // * WRITE_ACP: The grantee can write the ACL for + // the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. + // + // + // * FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for + // the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. + // + // * + // StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that + // you want Elastic Transcoder to assign to the thumbnails that it stores in your + // Amazon S3 bucket. + ThumbnailConfig *PipelineOutputConfig } // The PipelineOutputConfig structure. type PipelineOutputConfig struct { - // Optional. The Permissions object specifies which users and/or predefined Amazon - // S3 groups you want to have access to transcoded files and playlists, and the - // type of access you want them to have. You can grant permissions to a maximum of - // 30 users and/or predefined Amazon S3 groups. If you include Permissions, Elastic - // Transcoder grants only the permissions that you specify. It does not grant full - // permissions to the owner of the role specified by Role. If you want that user to - // have full control, you must explicitly grant full control to the user. If you - // omit Permissions, Elastic Transcoder grants full control over the transcoded - // files and playlists to the owner of the role specified by Role, and grants no - // other permissions to any other user or group. - Permissions []*Permission - // The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded // files. Specify this value when all of the following are true: // @@ -1383,6 +1371,18 @@ type PipelineOutputConfig struct { // ThumbnailConfig instead. Bucket *string + // Optional. The Permissions object specifies which users and/or predefined Amazon + // S3 groups you want to have access to transcoded files and playlists, and the + // type of access you want them to have. You can grant permissions to a maximum of + // 30 users and/or predefined Amazon S3 groups. If you include Permissions, Elastic + // Transcoder grants only the permissions that you specify. It does not grant full + // permissions to the owner of the role specified by Role. If you want that user to + // have full control, you must explicitly grant full control to the user. If you + // omit Permissions, Elastic Transcoder grants full control over the transcoded + // files and playlists to the owner of the role specified by Role, and grants no + // other permissions to any other user or group. + Permissions []*Permission + // The Amazon S3 storage class, Standard or ReducedRedundancy, that you want // Elastic Transcoder to assign to the video files and playlists that it stores in // your Amazon S3 bucket. @@ -1396,33 +1396,23 @@ type PipelineOutputConfig struct { // format. The maximum number of master playlists in a job is 30. type Playlist struct { - // The name that you want Elastic Transcoder to assign to the master playlist, for - // example, nyc-vacation.m3u8. If the name includes a / character, the section of - // the name before the last / must be identical for all Name objects. If you create - // more than one master playlist, the values of all Name objects must be unique. - // Elastic Transcoder automatically appends the relevant file extension to the file - // name (.m3u8 for HLSv3 and HLSv4 playlists, and .ism and .ismc for Smooth - // playlists). If you include a file extension in Name, the file name will have two - // extensions. - Name *string - // The format of the output playlist. Valid formats include HLSv3, HLSv4, and // Smooth. Format *string - // The DRM settings, if any, that you want Elastic Transcoder to apply to the - // output files associated with this playlist. - PlayReadyDrm *PlayReadyDrm - - // The status of the job with which the playlist is associated. - Status *string - // The HLS content protection settings, if any, that you want Elastic Transcoder to // apply to the output files associated with this playlist. HlsContentProtection *HlsContentProtection - // Information that further explains the status. - StatusDetail *string + // The name that you want Elastic Transcoder to assign to the master playlist, for + // example, nyc-vacation.m3u8. If the name includes a / character, the section of + // the name before the last / must be identical for all Name objects. If you create + // more than one master playlist, the values of all Name objects must be unique. + // Elastic Transcoder automatically appends the relevant file extension to the file + // name (.m3u8 for HLSv3 and HLSv4 playlists, and .ism and .ismc for Smooth + // playlists). If you include a file extension in Name, the file name will have two + // extensions. + Name *string // For each output in this job that you want to include in a master playlist, the // value of the Outputs:Key object. @@ -1455,6 +1445,16 @@ type Playlist struct { // Video:FrameRate to Video:KeyframesMaxDist ratio must // be the same for all outputs.

    OutputKeys []*string + + // The DRM settings, if any, that you want Elastic Transcoder to apply to the + // output files associated with this playlist. + PlayReadyDrm *PlayReadyDrm + + // The status of the job with which the playlist is associated. + Status *string + + // Information that further explains the status. + StatusDetail *string } // The PlayReady DRM settings, if any, that you want Elastic Transcoder to apply to @@ -1467,14 +1467,6 @@ type PlayReadyDrm struct { // files associated with this playlist. Format *string - // The location of the license key required to play DRM content. The URL must be an - // absolute path, and is referenced by the PlayReady header. The PlayReady header - // is referenced in the protection header of the client manifest for Smooth - // Streaming outputs, and in the EXT-X-DXDRM and EXT-XDXDRMINFO metadata tags for - // HLS playlist outputs. An example URL looks like this: - // https://www.example.com/exampleKey/ - LicenseAcquisitionUrl *string - // The series of random bits created by a random bit generator, unique for every // encryption operation, that you want Elastic Transcoder to use to encrypt your // files. The initialization vector must be base64-encoded, and it must be exactly @@ -1482,6 +1474,12 @@ type PlayReadyDrm struct { // provided, Elastic Transcoder generates one for you. InitializationVector *string + // The DRM key for your file, provided by your DRM license provider. The key must + // be base64-encoded, and it must be one of the following bit lengths before being + // base64-encoded: 128, 192, or 256. The key must also be encrypted by using AWS + // KMS. + Key *string + // The ID for your DRM key, so that your DRM license provider knows which key to // provide. The key ID must be provided in big endian, and Elastic Transcoder // converts it to little endian before inserting it into the PlayReady DRM headers. @@ -1495,11 +1493,13 @@ type PlayReadyDrm struct { // before being base64-encoded. KeyMd5 *string - // The DRM key for your file, provided by your DRM license provider. The key must - // be base64-encoded, and it must be one of the following bit lengths before being - // base64-encoded: 128, 192, or 256. The key must also be encrypted by using AWS - // KMS. - Key *string + // The location of the license key required to play DRM content. The URL must be an + // absolute path, and is referenced by the PlayReady header. The PlayReady header + // is referenced in the protection header of the client manifest for Smooth + // Streaming outputs, and in the EXT-X-DXDRM and EXT-XDXDRMINFO metadata tags for + // HLS playlist outputs. An example URL looks like this: + // https://www.example.com/exampleKey/ + LicenseAcquisitionUrl *string } // Presets are templates that contain most of the settings for transcoding media @@ -1509,22 +1509,17 @@ type PlayReadyDrm struct { // default presets. You specify which preset you want to use when you create a job. type Preset struct { - // Whether the preset is a default preset provided by Elastic Transcoder (System) - // or a preset that you have defined (Custom). - Type *string + // The Amazon Resource Name (ARN) for the preset. + Arn *string - // A section of the response body that provides information about the video preset + // A section of the response body that provides information about the audio preset // values. - Video *VideoParameters + Audio *AudioParameters // The container type for the output file. Valid values include flac, flv, fmp4, // gif, mp3, mp4, mpg, mxf, oga, ogg, ts, and webm. Container *string - // A section of the response body that provides information about the thumbnail - // preset values, if any. - Thumbnails *Thumbnails - // A description of the preset. Description *string @@ -1532,15 +1527,20 @@ type Preset struct { // or to delete it. Id *string - // The Amazon Resource Name (ARN) for the preset. - Arn *string - - // A section of the response body that provides information about the audio preset - // values. - Audio *AudioParameters - // The name of the preset. Name *string + + // A section of the response body that provides information about the thumbnail + // preset values, if any. + Thumbnails *Thumbnails + + // Whether the preset is a default preset provided by Elastic Transcoder (System) + // or a preset that you have defined (Custom). + Type *string + + // A section of the response body that provides information about the video preset + // values. + Video *VideoParameters } // Settings for the size, location, and opacity of graphics that you want Elastic @@ -1569,19 +1569,6 @@ type PresetWatermark struct { // centered between the left and right borders. HorizontalAlign *string - // The maximum width of the watermark in one of the following formats: - // - // * - // number of pixels (px): The minimum value is 16 pixels, and the maximum value is - // the value of MaxWidth. - // - // * integer percentage (%): The range of valid values - // is 0 to 100. Use the value of Target to specify whether you want Elastic - // Transcoder to include the black bars that are added by Elastic Transcoder, if - // any, in the calculation. If you specify the value in pixels, it must be less - // than or equal to the value of MaxWidth. - MaxWidth *string - // The amount by which you want the horizontal position of the watermark to be // offset from the position specified by HorizontalAlign: // @@ -1604,23 +1591,6 @@ type PresetWatermark struct { // in the offset calculation. HorizontalOffset *string - // A value that determines how Elastic Transcoder interprets values that you - // specified for HorizontalOffset, VerticalOffset, MaxWidth, and MaxHeight: - // - // * - // Content: HorizontalOffset and VerticalOffset values are calculated based on the - // borders of the video excluding black bars added by Elastic Transcoder, if any. - // In addition, MaxWidth and MaxHeight, if specified as a percentage, are - // calculated based on the borders of the video excluding black bars added by - // Elastic Transcoder, if any. - // - // * Frame: HorizontalOffset and VerticalOffset - // values are calculated based on the borders of the video including black bars - // added by Elastic Transcoder, if any. In addition, MaxWidth and MaxHeight, if - // specified as a percentage, are calculated based on the borders of the video - // including black bars added by Elastic Transcoder, if any. - Target *string - // A unique identifier for the settings for one watermark. The value of Id can be // up to 40 characters long. Id *string @@ -1640,6 +1610,19 @@ type PresetWatermark struct { // than or equal to the value of MaxHeight. MaxHeight *string + // The maximum width of the watermark in one of the following formats: + // + // * + // number of pixels (px): The minimum value is 16 pixels, and the maximum value is + // the value of MaxWidth. + // + // * integer percentage (%): The range of valid values + // is 0 to 100. Use the value of Target to specify whether you want Elastic + // Transcoder to include the black bars that are added by Elastic Transcoder, if + // any, in the calculation. If you specify the value in pixels, it must be less + // than or equal to the value of MaxWidth. + MaxWidth *string + // A percentage that indicates how much you want a watermark to obscure the video // in the location where it appears. Valid values are 0 (the watermark is // invisible) to 100 (the watermark completely obscures the video in the specified @@ -1667,6 +1650,23 @@ type PresetWatermark struct { // option, Elastic Transcoder does not scale the watermark up. SizingPolicy *string + // A value that determines how Elastic Transcoder interprets values that you + // specified for HorizontalOffset, VerticalOffset, MaxWidth, and MaxHeight: + // + // * + // Content: HorizontalOffset and VerticalOffset values are calculated based on the + // borders of the video excluding black bars added by Elastic Transcoder, if any. + // In addition, MaxWidth and MaxHeight, if specified as a percentage, are + // calculated based on the borders of the video excluding black bars added by + // Elastic Transcoder, if any. + // + // * Frame: HorizontalOffset and VerticalOffset + // values are calculated based on the borders of the video including black bars + // added by Elastic Transcoder, if any. In addition, MaxWidth and MaxHeight, if + // specified as a percentage, are calculated based on the borders of the video + // including black bars added by Elastic Transcoder, if any. + Target *string + // The vertical position of the watermark unless you specify a non-zero value for // VerticalOffset: // @@ -1706,6 +1706,18 @@ type PresetWatermark struct { // Thumbnails for videos. type Thumbnails struct { + // To better control resolution and aspect ratio of thumbnails, we recommend that + // you use the values MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead + // of Resolution and AspectRatio. The two groups of settings are mutually + // exclusive. Do not use them together. The aspect ratio of thumbnails. Valid + // values include: auto, 1:1, 4:3, 3:2, 16:9 If you specify auto, Elastic + // Transcoder tries to preserve the aspect ratio of the video in the output file. + AspectRatio *string + + // The format of thumbnails, if any. Valid values are jpg and png. You specify + // whether you want Elastic Transcoder to create thumbnails when you create a job. + Format *string + // The approximate number of seconds between thumbnails. Specify an integer value. Interval *string @@ -1719,6 +1731,12 @@ type Thumbnails struct { // value, enter an even integer between 32 and 4096. MaxWidth *string + // When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to the + // top and bottom and/or left and right sides of thumbnails to make the total size + // of the thumbnails match the values that you specified for thumbnail MaxWidth and + // MaxHeight settings. + PaddingPolicy *string + // To better control resolution and aspect ratio of thumbnails, we recommend that // you use the values MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead // of Resolution and AspectRatio. The two groups of settings are mutually @@ -1754,24 +1772,6 @@ type Thumbnails struct { // value. If you specify this option, Elastic Transcoder does not scale thumbnails // up.

    SizingPolicy *string - - // The format of thumbnails, if any. Valid values are jpg and png. You specify - // whether you want Elastic Transcoder to create thumbnails when you create a job. - Format *string - - // When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to the - // top and bottom and/or left and right sides of thumbnails to make the total size - // of the thumbnails match the values that you specified for thumbnail MaxWidth and - // MaxHeight settings. - PaddingPolicy *string - - // To better control resolution and aspect ratio of thumbnails, we recommend that - // you use the values MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead - // of Resolution and AspectRatio. The two groups of settings are mutually - // exclusive. Do not use them together. The aspect ratio of thumbnails. Valid - // values include: auto, 1:1, 4:3, 3:2, 16:9 If you specify auto, Elastic - // Transcoder tries to preserve the aspect ratio of the video in the output file. - AspectRatio *string } // Settings that determine when a clip begins and how long it lasts. @@ -1795,12 +1795,12 @@ type TimeSpan struct { // Details about the timing of a job. type Timing struct { - // The time the job began transcoding, in epoch milliseconds. - StartTimeMillis *int64 - // The time the job finished transcoding, in epoch milliseconds. FinishTimeMillis *int64 + // The time the job began transcoding, in epoch milliseconds. + StartTimeMillis *int64 + // The time the job was submitted to Elastic Transcoder, in epoch milliseconds. SubmitTimeMillis *int64 } @@ -1808,69 +1808,56 @@ type Timing struct { // The VideoParameters structure. type VideoParameters struct { - // The frames per second for the video stream in the output file. Valid values - // include: auto, 10, 15, 23.97, 24, 25, 29.97, 30, 60 If you specify auto, Elastic - // Transcoder uses the detected frame rate of the input source. If you specify a - // frame rate, we recommend that you perform the following calculation: Frame rate - // = maximum recommended decoding speed in luma samples/second / (width in pixels * - // height in pixels) where: - // - // * width in pixels and height in pixels represent - // the Resolution of the output video. - // - // * maximum recommended decoding speed in - // Luma samples/second is less than or equal to the maximum value listed in the - // following table, based on the value that you specified for Level. - // - // The maximum - // recommended decoding speed in Luma samples/second for each level is described in - // the following list (Level - Decoding speed): + // To better control resolution and aspect ratio of output videos, we recommend + // that you use the values MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and + // DisplayAspectRatio instead of Resolution and AspectRatio. The two groups of + // settings are mutually exclusive. Do not use them together. The display aspect + // ratio of the video in the output file. Valid values include: auto, 1:1, 4:3, + // 3:2, 16:9 If you specify auto, Elastic Transcoder tries to preserve the aspect + // ratio of the input file. If you specify an aspect ratio for the output file that + // differs from aspect ratio of the input file, Elastic Transcoder adds + // pillarboxing (black bars on the sides) or letterboxing (black bars on the top + // and bottom) to maintain the aspect ratio of the active region of the video. + AspectRatio *string + + // The bit rate of the video stream in the output file, in kilobits/second. Valid + // values depend on the values of Level and Profile. If you specify auto, Elastic + // Transcoder uses the detected bit rate of the input source. If you specify a + // value other than auto, we recommend that you specify a value less than or equal + // to the maximum H.264-compliant value listed for your level and profile: Level - + // Maximum video bit rate in kilobits/second (baseline and main Profile) : maximum + // video bit rate in kilobits/second (high Profile) // - // * 1 - 380160 + // * 1 - 64 : 80 // // * 1b - - // 380160 - // - // * 1.1 - 76800 - // - // * 1.2 - 1536000 - // - // * 1.3 - 3041280 - // - // * 2 - - // 3041280 - // - // * 2.1 - 5068800 + // 128 : 160 // - // * 2.2 - 5184000 + // * 1.1 - 192 : 240 // - // * 3 - 10368000 + // * 1.2 - 384 : 480 // - // * 3.1 - // - 27648000 + // * 1.3 - 768 : 960 // - // * 3.2 - 55296000 // - // * 4 - 62914560 + // * 2 - 2000 : 2500 // - // * 4.1 - 62914560 - FrameRate *string - - // Applicable only when the value of Video:Codec is one of H.264, MPEG2, or VP8. - // The maximum number of frames between key frames. Key frames are fully encoded - // frames; the frames between key frames are encoded based, in part, on the content - // of the key frames. The value is an integer formatted as a string; valid values - // are between 1 (every frame is a key frame) and 100000, inclusive. A higher value - // results in higher compression but may also discernibly decrease video quality. - // For Smooth outputs, the FrameRate must have a constant ratio to the - // KeyframesMaxDist. This allows Smooth playlists to switch between different - // quality levels while the file is being played. For example, an input file can - // have a FrameRate of 30 with a KeyframesMaxDist of 90. The output file then needs - // to have a ratio of 1:3. Valid outputs would have FrameRate of 30, 25, and 10, - // and KeyframesMaxDist of 90, 75, and 30, respectively. Alternately, this can be - // achieved by setting FrameRate to auto and having the same values for - // MaxFrameRate and KeyframesMaxDist. - KeyframesMaxDist *string + // * 3 - 10000 : 12500 + // + // * 3.1 - 14000 : 17500 + // + // * 3.2 + // - 20000 : 25000 + // + // * 4 - 20000 : 25000 + // + // * 4.1 - 50000 : 62500 + BitRate *string + + // The video codec for the output file. Valid values include gif, H.264, mpeg2, + // vp8, and vp9. You can only specify vp8 and vp9 when the container type is webm, + // gif when the container type is gif, and mpeg2 when the container type is mpg. + Codec *string // Profile (H.264/VP8/VP9 Only) The H.264 profile that you want to use for the // output file. Elastic Transcoder supports the following profiles: @@ -1986,38 +1973,110 @@ type VideoParameters struct { // 0 and 100, inclusive.

    CodecOptions map[string]*string - // Specify one of the following values to control scaling of the output video: - //

    • Fit: Elastic Transcoder scales the output video so it - // matches the value that you specified in either MaxWidth or - // MaxHeight without exceeding the other value.

    • - // Fill: Elastic Transcoder scales the output video so it matches the - // value that you specified in either MaxWidth or - // MaxHeight and matches or exceeds the other value. Elastic - // Transcoder centers the output video and then crops it in the dimension (if any) - // that exceeds the maximum value.

    • Stretch: Elastic - // Transcoder stretches the output video to match the values that you specified for - // MaxWidth and MaxHeight. If the relative proportions of - // the input video and the output video are different, the output video will be - // distorted.

    • Keep: Elastic Transcoder does not - // scale the output video. If either dimension of the input video exceeds the - // values that you specified for MaxWidth and MaxHeight, - // Elastic Transcoder crops the output video.

    • - // ShrinkToFit: Elastic Transcoder scales the output video down so - // that its dimensions match the values that you specified for at least one of - // MaxWidth and MaxHeight without exceeding either value. - // If you specify this option, Elastic Transcoder does not scale the video up.

      - //

    • ShrinkToFill: Elastic Transcoder scales the output - // video down so that its dimensions match the values that you specified for at - // least one of MaxWidth and MaxHeight without dropping - // below either value. If you specify this option, Elastic Transcoder does not - // scale the video up.

    - SizingPolicy *string + // The value that Elastic Transcoder adds to the metadata in the output file. + DisplayAspectRatio *string + + // Applicable only when the value of Video:Codec is one of H.264, MPEG2, or VP8. + // Whether to use a fixed value for FixedGOP. Valid values are true and false: + // + // + // * true: Elastic Transcoder uses the value of KeyframesMaxDist for the distance + // between key frames (the number of frames in a group of pictures, or GOP). + // + // * + // false: The distance between key frames can vary. + // + // FixedGOP must be set to true + // for fmp4 containers. + FixedGOP *string + + // The frames per second for the video stream in the output file. Valid values + // include: auto, 10, 15, 23.97, 24, 25, 29.97, 30, 60 If you specify auto, Elastic + // Transcoder uses the detected frame rate of the input source. If you specify a + // frame rate, we recommend that you perform the following calculation: Frame rate + // = maximum recommended decoding speed in luma samples/second / (width in pixels * + // height in pixels) where: + // + // * width in pixels and height in pixels represent + // the Resolution of the output video. + // + // * maximum recommended decoding speed in + // Luma samples/second is less than or equal to the maximum value listed in the + // following table, based on the value that you specified for Level. + // + // The maximum + // recommended decoding speed in Luma samples/second for each level is described in + // the following list (Level - Decoding speed): + // + // * 1 - 380160 + // + // * 1b - + // 380160 + // + // * 1.1 - 76800 + // + // * 1.2 - 1536000 + // + // * 1.3 - 3041280 + // + // * 2 - + // 3041280 + // + // * 2.1 - 5068800 + // + // * 2.2 - 5184000 + // + // * 3 - 10368000 + // + // * 3.1 + // - 27648000 + // + // * 3.2 - 55296000 + // + // * 4 - 62914560 + // + // * 4.1 - 62914560 + FrameRate *string + + // Applicable only when the value of Video:Codec is one of H.264, MPEG2, or VP8. + // The maximum number of frames between key frames. Key frames are fully encoded + // frames; the frames between key frames are encoded based, in part, on the content + // of the key frames. The value is an integer formatted as a string; valid values + // are between 1 (every frame is a key frame) and 100000, inclusive. A higher value + // results in higher compression but may also discernibly decrease video quality. + // For Smooth outputs, the FrameRate must have a constant ratio to the + // KeyframesMaxDist. This allows Smooth playlists to switch between different + // quality levels while the file is being played. For example, an input file can + // have a FrameRate of 30 with a KeyframesMaxDist of 90. The output file then needs + // to have a ratio of 1:3. Valid outputs would have FrameRate of 30, 25, and 10, + // and KeyframesMaxDist of 90, 75, and 30, respectively. Alternately, this can be + // achieved by setting FrameRate to auto and having the same values for + // MaxFrameRate and KeyframesMaxDist. + KeyframesMaxDist *string + + // If you specify auto for FrameRate, Elastic Transcoder uses the frame rate of the + // input video for the frame rate of the output video. Specify the maximum frame + // rate that you want Elastic Transcoder to use when the frame rate of the input + // video is greater than the desired maximum frame rate of the output video. Valid + // values include: 10, 15, 23.97, 24, 25, 29.97, 30, 60. + MaxFrameRate *string // The maximum height of the output video in pixels. If you specify auto, Elastic // Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric // value, enter an even integer between 96 and 3072. MaxHeight *string + // The maximum width of the output video in pixels. If you specify auto, Elastic + // Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric + // value, enter an even integer between 128 and 4096. + MaxWidth *string + + // When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to the + // top and bottom and/or left and right sides of the output video to make the total + // size of the output video match the values that you specified for MaxWidth and + // MaxHeight. + PaddingPolicy *string + // To better control resolution and aspect ratio of output videos, we recommend // that you use the values MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and // DisplayAspectRatio instead of Resolution and AspectRatio. The two groups of @@ -2083,91 +2142,32 @@ type VideoParameters struct { // * 4.1 - 2097152 Resolution *string - // The bit rate of the video stream in the output file, in kilobits/second. Valid - // values depend on the values of Level and Profile. If you specify auto, Elastic - // Transcoder uses the detected bit rate of the input source. If you specify a - // value other than auto, we recommend that you specify a value less than or equal - // to the maximum H.264-compliant value listed for your level and profile: Level - - // Maximum video bit rate in kilobits/second (baseline and main Profile) : maximum - // video bit rate in kilobits/second (high Profile) - // - // * 1 - 64 : 80 - // - // * 1b - - // 128 : 160 - // - // * 1.1 - 192 : 240 - // - // * 1.2 - 384 : 480 - // - // * 1.3 - 768 : 960 - // - // - // * 2 - 2000 : 2500 - // - // * 3 - 10000 : 12500 - // - // * 3.1 - 14000 : 17500 - // - // * 3.2 - // - 20000 : 25000 - // - // * 4 - 20000 : 25000 - // - // * 4.1 - 50000 : 62500 - BitRate *string - - // If you specify auto for FrameRate, Elastic Transcoder uses the frame rate of the - // input video for the frame rate of the output video. Specify the maximum frame - // rate that you want Elastic Transcoder to use when the frame rate of the input - // video is greater than the desired maximum frame rate of the output video. Valid - // values include: 10, 15, 23.97, 24, 25, 29.97, 30, 60. - MaxFrameRate *string - - // When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to the - // top and bottom and/or left and right sides of the output video to make the total - // size of the output video match the values that you specified for MaxWidth and - // MaxHeight. - PaddingPolicy *string - - // The maximum width of the output video in pixels. If you specify auto, Elastic - // Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric - // value, enter an even integer between 128 and 4096. - MaxWidth *string - - // To better control resolution and aspect ratio of output videos, we recommend - // that you use the values MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and - // DisplayAspectRatio instead of Resolution and AspectRatio. The two groups of - // settings are mutually exclusive. Do not use them together. The display aspect - // ratio of the video in the output file. Valid values include: auto, 1:1, 4:3, - // 3:2, 16:9 If you specify auto, Elastic Transcoder tries to preserve the aspect - // ratio of the input file. If you specify an aspect ratio for the output file that - // differs from aspect ratio of the input file, Elastic Transcoder adds - // pillarboxing (black bars on the sides) or letterboxing (black bars on the top - // and bottom) to maintain the aspect ratio of the active region of the video. - AspectRatio *string - - // The value that Elastic Transcoder adds to the metadata in the output file. - DisplayAspectRatio *string - - // Applicable only when the value of Video:Codec is one of H.264, MPEG2, or VP8. - // Whether to use a fixed value for FixedGOP. Valid values are true and false: - // - // - // * true: Elastic Transcoder uses the value of KeyframesMaxDist for the distance - // between key frames (the number of frames in a group of pictures, or GOP). - // - // * - // false: The distance between key frames can vary. - // - // FixedGOP must be set to true - // for fmp4 containers. - FixedGOP *string - - // The video codec for the output file. Valid values include gif, H.264, mpeg2, - // vp8, and vp9. You can only specify vp8 and vp9 when the container type is webm, - // gif when the container type is gif, and mpeg2 when the container type is mpg. - Codec *string + // Specify one of the following values to control scaling of the output video: + //

    • Fit: Elastic Transcoder scales the output video so it + // matches the value that you specified in either MaxWidth or + // MaxHeight without exceeding the other value.

    • + // Fill: Elastic Transcoder scales the output video so it matches the + // value that you specified in either MaxWidth or + // MaxHeight and matches or exceeds the other value. Elastic + // Transcoder centers the output video and then crops it in the dimension (if any) + // that exceeds the maximum value.

    • Stretch: Elastic + // Transcoder stretches the output video to match the values that you specified for + // MaxWidth and MaxHeight. If the relative proportions of + // the input video and the output video are different, the output video will be + // distorted.

    • Keep: Elastic Transcoder does not + // scale the output video. If either dimension of the input video exceeds the + // values that you specified for MaxWidth and MaxHeight, + // Elastic Transcoder crops the output video.

    • + // ShrinkToFit: Elastic Transcoder scales the output video down so + // that its dimensions match the values that you specified for at least one of + // MaxWidth and MaxHeight without exceeding either value. + // If you specify this option, Elastic Transcoder does not scale the video up.

      + //

    • ShrinkToFill: Elastic Transcoder scales the output + // video down so that its dimensions match the values that you specified for at + // least one of MaxWidth and MaxHeight without dropping + // below either value. If you specify this option, Elastic Transcoder does not + // scale the video up.

    + SizingPolicy *string // Settings for the size, location, and opacity of graphics that you want Elastic // Transcoder to overlay over videos that are transcoded using this preset. You can @@ -2189,10 +2189,10 @@ type VideoParameters struct { // reduces processing time and prevents cross-regional charges. type Warning struct { + // The code of the cross-regional warning. + Code *string + // The message explaining what resources are in a different region from the // pipeline. AWS KMS keys must be in the same region as the pipeline. Message *string - - // The code of the cross-regional warning. - Code *string } diff --git a/service/emr/api_op_AddInstanceFleet.go b/service/emr/api_op_AddInstanceFleet.go index 407f83a8cf7..69bfb524040 100644 --- a/service/emr/api_op_AddInstanceFleet.go +++ b/service/emr/api_op_AddInstanceFleet.go @@ -58,15 +58,15 @@ func (c *Client) AddInstanceFleet(ctx context.Context, params *AddInstanceFleetI type AddInstanceFleetInput struct { - // Specifies the configuration of the instance fleet. + // The unique identifier of the cluster. // // This member is required. - InstanceFleet *types.InstanceFleetConfig + ClusterId *string - // The unique identifier of the cluster. + // Specifies the configuration of the instance fleet. // // This member is required. - ClusterId *string + InstanceFleet *types.InstanceFleetConfig } type AddInstanceFleetOutput struct { diff --git a/service/emr/api_op_AddInstanceGroups.go b/service/emr/api_op_AddInstanceGroups.go index 7fa0582fb0a..66b8a354519 100644 --- a/service/emr/api_op_AddInstanceGroups.go +++ b/service/emr/api_op_AddInstanceGroups.go @@ -58,28 +58,28 @@ func (c *Client) AddInstanceGroups(ctx context.Context, params *AddInstanceGroup // Input to an AddInstanceGroups call. type AddInstanceGroupsInput struct { - // Job flow in which to add the instance groups. + // Instance groups to add. // // This member is required. - JobFlowId *string + InstanceGroups []*types.InstanceGroupConfig - // Instance groups to add. + // Job flow in which to add the instance groups. // // This member is required. - InstanceGroups []*types.InstanceGroupConfig + JobFlowId *string } // Output from an AddInstanceGroups call. type AddInstanceGroupsOutput struct { - // The job flow ID in which the instance groups are added. - JobFlowId *string + // The Amazon Resource Name of the cluster. + ClusterArn *string // Instance group IDs of the newly created instance groups. InstanceGroupIds []*string - // The Amazon Resource Name of the cluster. - ClusterArn *string + // The job flow ID in which the instance groups are added. + JobFlowId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/emr/api_op_AddTags.go b/service/emr/api_op_AddTags.go index 44b4acd7144..a4885459def 100644 --- a/service/emr/api_op_AddTags.go +++ b/service/emr/api_op_AddTags.go @@ -61,6 +61,12 @@ func (c *Client) AddTags(ctx context.Context, params *AddTagsInput, optFns ...fu // This input identifies a cluster and a list of tags to attach. type AddTagsInput struct { + // The Amazon EMR resource identifier to which tags will be added. This value must + // be a cluster identifier. + // + // This member is required. + ResourceId *string + // A list of tags to associate with a cluster and propagate to EC2 instances. Tags // are user-defined key/value pairs that consist of a required key string with a // maximum of 128 characters, and an optional value string with a maximum of 256 @@ -68,12 +74,6 @@ type AddTagsInput struct { // // This member is required. Tags []*types.Tag - - // The Amazon EMR resource identifier to which tags will be added. This value must - // be a cluster identifier. - // - // This member is required. - ResourceId *string } // This output indicates the result of adding tags to a resource. diff --git a/service/emr/api_op_CreateSecurityConfiguration.go b/service/emr/api_op_CreateSecurityConfiguration.go index de7be87f18d..0e32b8fcf7a 100644 --- a/service/emr/api_op_CreateSecurityConfiguration.go +++ b/service/emr/api_op_CreateSecurityConfiguration.go @@ -58,6 +58,11 @@ func (c *Client) CreateSecurityConfiguration(ctx context.Context, params *Create type CreateSecurityConfigurationInput struct { + // The name of the security configuration. + // + // This member is required. + Name *string + // The security configuration details in JSON format. For JSON parameters and // examples, see Use Security Configurations to Set Up Cluster Security // (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-security-configurations.html) @@ -65,11 +70,6 @@ type CreateSecurityConfigurationInput struct { // // This member is required. SecurityConfiguration *string - - // The name of the security configuration. - // - // This member is required. - Name *string } type CreateSecurityConfigurationOutput struct { diff --git a/service/emr/api_op_DescribeJobFlows.go b/service/emr/api_op_DescribeJobFlows.go index 3a0eadc071b..914f548d912 100644 --- a/service/emr/api_op_DescribeJobFlows.go +++ b/service/emr/api_op_DescribeJobFlows.go @@ -74,8 +74,8 @@ func (c *Client) DescribeJobFlows(ctx context.Context, params *DescribeJobFlowsI // The input for the DescribeJobFlows () operation. type DescribeJobFlowsInput struct { - // Return only job flows whose state is contained in this list. - JobFlowStates []types.JobFlowExecutionState + // Return only job flows created after this date and time. + CreatedAfter *time.Time // Return only job flows created before this date and time. CreatedBefore *time.Time @@ -83,8 +83,8 @@ type DescribeJobFlowsInput struct { // Return only job flows whose job flow ID is contained in this list. JobFlowIds []*string - // Return only job flows created after this date and time. - CreatedAfter *time.Time + // Return only job flows whose state is contained in this list. + JobFlowStates []types.JobFlowExecutionState } // The output for the DescribeJobFlows () operation. diff --git a/service/emr/api_op_DescribeSecurityConfiguration.go b/service/emr/api_op_DescribeSecurityConfiguration.go index 0d9837885dd..efbd70afd2c 100644 --- a/service/emr/api_op_DescribeSecurityConfiguration.go +++ b/service/emr/api_op_DescribeSecurityConfiguration.go @@ -66,15 +66,15 @@ type DescribeSecurityConfigurationInput struct { type DescribeSecurityConfigurationOutput struct { + // The date and time the security configuration was created + CreationDateTime *time.Time + // The name of the security configuration. Name *string // The security configuration details in JSON format. SecurityConfiguration *string - // The date and time the security configuration was created - CreationDateTime *time.Time - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/emr/api_op_DescribeStep.go b/service/emr/api_op_DescribeStep.go index 779493cf371..2620431e384 100644 --- a/service/emr/api_op_DescribeStep.go +++ b/service/emr/api_op_DescribeStep.go @@ -58,15 +58,15 @@ func (c *Client) DescribeStep(ctx context.Context, params *DescribeStepInput, op // This input determines which step to describe. type DescribeStepInput struct { - // The identifier of the step to describe. + // The identifier of the cluster with steps to describe. // // This member is required. - StepId *string + ClusterId *string - // The identifier of the cluster with steps to describe. + // The identifier of the step to describe. // // This member is required. - ClusterId *string + StepId *string } // This output contains the description of the cluster step. diff --git a/service/emr/api_op_GetBlockPublicAccessConfiguration.go b/service/emr/api_op_GetBlockPublicAccessConfiguration.go index 048f7cf62f5..67200e0ed6d 100644 --- a/service/emr/api_op_GetBlockPublicAccessConfiguration.go +++ b/service/emr/api_op_GetBlockPublicAccessConfiguration.go @@ -63,15 +63,6 @@ type GetBlockPublicAccessConfigurationInput struct { type GetBlockPublicAccessConfigurationOutput struct { - // Properties that describe the AWS principal that created the - // BlockPublicAccessConfiguration using the PutBlockPublicAccessConfiguration - // action as well as the date and time that the configuration was created. Each - // time a configuration for block public access is updated, Amazon EMR updates this - // metadata. - // - // This member is required. - BlockPublicAccessConfigurationMetadata *types.BlockPublicAccessConfigurationMetadata - // A configuration for Amazon EMR block public access. The configuration applies to // all clusters created in your account for the current Region. The configuration // specifies whether block public access is enabled. If block public access is @@ -89,6 +80,15 @@ type GetBlockPublicAccessConfigurationOutput struct { // This member is required. BlockPublicAccessConfiguration *types.BlockPublicAccessConfiguration + // Properties that describe the AWS principal that created the + // BlockPublicAccessConfiguration using the PutBlockPublicAccessConfiguration + // action as well as the date and time that the configuration was created. Each + // time a configuration for block public access is updated, Amazon EMR updates this + // metadata. + // + // This member is required. + BlockPublicAccessConfigurationMetadata *types.BlockPublicAccessConfigurationMetadata + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/emr/api_op_ListBootstrapActions.go b/service/emr/api_op_ListBootstrapActions.go index 5fcd617fa9b..aab0bbd96ca 100644 --- a/service/emr/api_op_ListBootstrapActions.go +++ b/service/emr/api_op_ListBootstrapActions.go @@ -58,24 +58,24 @@ func (c *Client) ListBootstrapActions(ctx context.Context, params *ListBootstrap // This input determines which bootstrap actions to retrieve. type ListBootstrapActionsInput struct { - // The pagination token that indicates the next set of results to retrieve. - Marker *string - // The cluster identifier for the bootstrap actions to list. // // This member is required. ClusterId *string + + // The pagination token that indicates the next set of results to retrieve. + Marker *string } // This output contains the bootstrap actions detail. type ListBootstrapActionsOutput struct { - // The pagination token that indicates the next set of results to retrieve. - Marker *string - // The bootstrap actions associated with the cluster. BootstrapActions []*types.Command + // The pagination token that indicates the next set of results to retrieve. + Marker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/emr/api_op_ListClusters.go b/service/emr/api_op_ListClusters.go index 8f266f841f7..d0316f2f81d 100644 --- a/service/emr/api_op_ListClusters.go +++ b/service/emr/api_op_ListClusters.go @@ -63,6 +63,9 @@ func (c *Client) ListClusters(ctx context.Context, params *ListClustersInput, op // that it returns. type ListClustersInput struct { + // The cluster state filters to apply when listing clusters. + ClusterStates []types.ClusterState + // The creation date and time beginning value filter for listing clusters. CreatedAfter *time.Time @@ -71,21 +74,18 @@ type ListClustersInput struct { // The pagination token that indicates the next set of results to retrieve. Marker *string - - // The cluster state filters to apply when listing clusters. - ClusterStates []types.ClusterState } // This contains a ClusterSummaryList with the cluster details; for example, the // cluster IDs, names, and status. type ListClustersOutput struct { - // The pagination token that indicates the next set of results to retrieve. - Marker *string - // The list of clusters for the account based on the given filters. Clusters []*types.ClusterSummary + // The pagination token that indicates the next set of results to retrieve. + Marker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/emr/api_op_ListInstanceFleets.go b/service/emr/api_op_ListInstanceFleets.go index 5681407520f..d7fb9b2a655 100644 --- a/service/emr/api_op_ListInstanceFleets.go +++ b/service/emr/api_op_ListInstanceFleets.go @@ -59,13 +59,13 @@ func (c *Client) ListInstanceFleets(ctx context.Context, params *ListInstanceFle type ListInstanceFleetsInput struct { - // The pagination token that indicates the next set of results to retrieve. - Marker *string - // The unique identifier of the cluster. // // This member is required. ClusterId *string + + // The pagination token that indicates the next set of results to retrieve. + Marker *string } type ListInstanceFleetsOutput struct { diff --git a/service/emr/api_op_ListInstanceGroups.go b/service/emr/api_op_ListInstanceGroups.go index 962594a6de0..ea32c7a2e5f 100644 --- a/service/emr/api_op_ListInstanceGroups.go +++ b/service/emr/api_op_ListInstanceGroups.go @@ -58,24 +58,24 @@ func (c *Client) ListInstanceGroups(ctx context.Context, params *ListInstanceGro // This input determines which instance groups to retrieve. type ListInstanceGroupsInput struct { - // The pagination token that indicates the next set of results to retrieve. - Marker *string - // The identifier of the cluster for which to list the instance groups. // // This member is required. ClusterId *string + + // The pagination token that indicates the next set of results to retrieve. + Marker *string } // This input determines which instance groups to retrieve. type ListInstanceGroupsOutput struct { - // The pagination token that indicates the next set of results to retrieve. - Marker *string - // The list of instance groups for the cluster and given filters. InstanceGroups []*types.InstanceGroup + // The pagination token that indicates the next set of results to retrieve. + Marker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/emr/api_op_ListInstances.go b/service/emr/api_op_ListInstances.go index 93fa23231cc..0d7cb8e8b8e 100644 --- a/service/emr/api_op_ListInstances.go +++ b/service/emr/api_op_ListInstances.go @@ -61,29 +61,29 @@ func (c *Client) ListInstances(ctx context.Context, params *ListInstancesInput, // This input determines which instances to list. type ListInstancesInput struct { + // The identifier of the cluster for which to list the instances. + // + // This member is required. + ClusterId *string + + // The unique identifier of the instance fleet. + InstanceFleetId *string + // The node type of the instance fleet. For example MASTER, CORE, or TASK. InstanceFleetType types.InstanceFleetType - // The pagination token that indicates the next set of results to retrieve. - Marker *string + // The identifier of the instance group for which to list the instances. + InstanceGroupId *string // The type of instance group for which to list the instances. InstanceGroupTypes []types.InstanceGroupType - // The identifier of the instance group for which to list the instances. - InstanceGroupId *string - // A list of instance states that will filter the instances returned with this // request. InstanceStates []types.InstanceState - // The identifier of the cluster for which to list the instances. - // - // This member is required. - ClusterId *string - - // The unique identifier of the instance fleet. - InstanceFleetId *string + // The pagination token that indicates the next set of results to retrieve. + Marker *string } // This output contains the list of instances. diff --git a/service/emr/api_op_ListSecurityConfigurations.go b/service/emr/api_op_ListSecurityConfigurations.go index fc3b1d273a1..15367300076 100644 --- a/service/emr/api_op_ListSecurityConfigurations.go +++ b/service/emr/api_op_ListSecurityConfigurations.go @@ -65,14 +65,14 @@ type ListSecurityConfigurationsInput struct { type ListSecurityConfigurationsOutput struct { - // The creation date and time, and name, of each security configuration. - SecurityConfigurations []*types.SecurityConfigurationSummary - // A pagination token that indicates the next set of results to retrieve. Include // the marker in the next ListSecurityConfiguration call to retrieve the next page // of results, if required. Marker *string + // The creation date and time, and name, of each security configuration. + SecurityConfigurations []*types.SecurityConfigurationSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/emr/api_op_ListSteps.go b/service/emr/api_op_ListSteps.go index 7257fe7c5a3..19a612fb09c 100644 --- a/service/emr/api_op_ListSteps.go +++ b/service/emr/api_op_ListSteps.go @@ -60,33 +60,33 @@ func (c *Client) ListSteps(ctx context.Context, params *ListStepsInput, optFns . // This input determines which steps to list. type ListStepsInput struct { - // The pagination token that indicates the next set of results to retrieve. - Marker *string - - // The filter to limit the step list based on certain states. - StepStates []types.StepState - // The identifier of the cluster for which to list the steps. // // This member is required. ClusterId *string + // The pagination token that indicates the next set of results to retrieve. + Marker *string + // The filter to limit the step list based on the identifier of the steps. You can // specify a maximum of ten Step IDs. The character constraint applies to the // overall length of the array. StepIds []*string + + // The filter to limit the step list based on certain states. + StepStates []types.StepState } // This output contains the list of steps returned in reverse order. This means // that the last step is the first element in the list. type ListStepsOutput struct { - // The filtered list of steps for the cluster. - Steps []*types.StepSummary - // The pagination token that indicates the next set of results to retrieve. Marker *string + // The filtered list of steps for the cluster. + Steps []*types.StepSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/emr/api_op_PutAutoScalingPolicy.go b/service/emr/api_op_PutAutoScalingPolicy.go index dbad2c0a21b..1e689a82a86 100644 --- a/service/emr/api_op_PutAutoScalingPolicy.go +++ b/service/emr/api_op_PutAutoScalingPolicy.go @@ -60,11 +60,10 @@ func (c *Client) PutAutoScalingPolicy(ctx context.Context, params *PutAutoScalin type PutAutoScalingPolicyInput struct { - // Specifies the ID of the instance group to which the automatic scaling policy is - // applied. + // Specifies the definition of the automatic scaling policy. // // This member is required. - InstanceGroupId *string + AutoScalingPolicy *types.AutoScalingPolicy // Specifies the ID of a cluster. The instance group to which the automatic scaling // policy is applied is within this cluster. @@ -72,14 +71,21 @@ type PutAutoScalingPolicyInput struct { // This member is required. ClusterId *string - // Specifies the definition of the automatic scaling policy. + // Specifies the ID of the instance group to which the automatic scaling policy is + // applied. // // This member is required. - AutoScalingPolicy *types.AutoScalingPolicy + InstanceGroupId *string } type PutAutoScalingPolicyOutput struct { + // The automatic scaling policy definition. + AutoScalingPolicy *types.AutoScalingPolicyDescription + + // The Amazon Resource Name of the cluster. + ClusterArn *string + // Specifies the ID of a cluster. The instance group to which the automatic scaling // policy is applied is within this cluster. ClusterId *string @@ -87,12 +93,6 @@ type PutAutoScalingPolicyOutput struct { // Specifies the ID of the instance group to which the scaling policy is applied. InstanceGroupId *string - // The Amazon Resource Name of the cluster. - ClusterArn *string - - // The automatic scaling policy definition. - AutoScalingPolicy *types.AutoScalingPolicyDescription - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/emr/api_op_PutManagedScalingPolicy.go b/service/emr/api_op_PutManagedScalingPolicy.go index d133348bbd2..576b641241f 100644 --- a/service/emr/api_op_PutManagedScalingPolicy.go +++ b/service/emr/api_op_PutManagedScalingPolicy.go @@ -61,15 +61,15 @@ func (c *Client) PutManagedScalingPolicy(ctx context.Context, params *PutManaged type PutManagedScalingPolicyInput struct { - // Specifies the constraints for the managed scaling policy. + // Specifies the ID of an EMR cluster where the managed scaling policy is attached. // // This member is required. - ManagedScalingPolicy *types.ManagedScalingPolicy + ClusterId *string - // Specifies the ID of an EMR cluster where the managed scaling policy is attached. + // Specifies the constraints for the managed scaling policy. // // This member is required. - ClusterId *string + ManagedScalingPolicy *types.ManagedScalingPolicy } type PutManagedScalingPolicyOutput struct { diff --git a/service/emr/api_op_RunJobFlow.go b/service/emr/api_op_RunJobFlow.go index 05c3c57110f..5cbebb69822 100644 --- a/service/emr/api_op_RunJobFlow.go +++ b/service/emr/api_op_RunJobFlow.go @@ -80,21 +80,43 @@ func (c *Client) RunJobFlow(ctx context.Context, params *RunJobFlowInput, optFns // Input to the RunJobFlow () operation. type RunJobFlowInput struct { - // The AWS KMS customer master key (CMK) used for encrypting log files. If a value - // is not provided, the logs will remain encrypted by AES-256. This attribute is - // only available with EMR version 5.30.0 and later, excluding EMR 6.0.0. - LogEncryptionKmsKeyId *string + // A specification of the number and type of Amazon EC2 instances. + // + // This member is required. + Instances *types.JobFlowInstancesConfig - // Attributes for Kerberos configuration when Kerberos authentication is enabled - // using a security configuration. For more information see Use Kerberos - // Authentication - // (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-kerberos.html) in - // the EMR Management Guide. - KerberosAttributes *types.KerberosAttributes + // The name of the job flow. + // + // This member is required. + Name *string // A JSON string for selecting additional features. AdditionalInfo *string + // Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 + // and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID. + AmiVersion *string + + // Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of + // applications for Amazon EMR to install and configure when launching the cluster. + // For a list of applications available for each Amazon EMR release version, see + // the Amazon EMR Release Guide + // (https://docs.aws.amazon.com/emr/latest/ReleaseGuide/). + Applications []*types.Application + + // An IAM role for automatic scaling policies. The default role is + // EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the + // automatic scaling feature requires to launch and terminate EC2 instances in an + // instance group. + AutoScalingRole *string + + // A list of bootstrap actions to run before Hadoop starts on the cluster nodes. + BootstrapActions []*types.BootstrapActionConfig + + // For Amazon EMR releases 4.0 and later. The list of configurations supplied for + // the EMR cluster you are creating. + Configurations []*types.Configuration + // Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon // EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches // cluster EC2 instances. For more information about custom AMIs in Amazon EMR, see @@ -110,45 +132,27 @@ type RunJobFlowInput struct { // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html). CustomAmiId *string - // An IAM role for automatic scaling policies. The default role is - // EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the - // automatic scaling feature requires to launch and terminate EC2 instances in an - // instance group. - AutoScalingRole *string - - // Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of - // applications for Amazon EMR to install and configure when launching the cluster. - // For a list of applications available for each Amazon EMR release version, see - // the Amazon EMR Release Guide - // (https://docs.aws.amazon.com/emr/latest/ReleaseGuide/). - Applications []*types.Application - - // Specifies the way that individual Amazon EC2 instances terminate when an - // automatic scale-in activity occurs or an instance group is resized. - // TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the - // instance-hour boundary, regardless of when the request to terminate the instance - // was submitted. This option is only available with Amazon EMR 5.1.0 and later and - // is the default for clusters created using that version. - // TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains - // tasks from nodes before terminating the Amazon EC2 instances, regardless of the - // instance-hour boundary. With either behavior, Amazon EMR removes the least - // active nodes first and blocks instance termination if it could lead to HDFS - // corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version - // 4.1.0 and later, and is the default for versions of Amazon EMR earlier than - // 5.1.0. - ScaleDownBehavior types.ScaleDownBehavior + // The size, in GiB, of the EBS root device volume of the Linux AMI that is used + // for each EC2 instance. Available in Amazon EMR version 4.x and later. + EbsRootVolumeSize *int32 - // Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 - // and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID. - AmiVersion *string + // Also called instance profile and EC2 role. An IAM role for an EMR cluster. The + // EC2 instances of the cluster assume this role. The default role is + // EMR_EC2_DefaultRole. In order to use the default role, you must have already + // created it using the CLI or console. + JobFlowRole *string - // A list of tags to associate with a cluster and propagate to Amazon EC2 - // instances. - Tags []*types.Tag + // Attributes for Kerberos configuration when Kerberos authentication is enabled + // using a security configuration. For more information see Use Kerberos + // Authentication + // (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-kerberos.html) in + // the EMR Management Guide. + KerberosAttributes *types.KerberosAttributes - // The IAM role that will be assumed by the Amazon EMR service to access AWS - // resources on your behalf. - ServiceRole *string + // The AWS KMS customer master key (CMK) used for encrypting log files. If a value + // is not provided, the logs will remain encrypted by AES-256. This attribute is + // only available with EMR version 5.30.0 and later, excluding EMR 6.0.0. + LogEncryptionKmsKeyId *string // The location in Amazon S3 to write the log files of the job flow. If a value is // not provided, logs are not created. @@ -157,62 +161,6 @@ type RunJobFlowInput struct { // The specified managed scaling policy for an Amazon EMR cluster. ManagedScalingPolicy *types.ManagedScalingPolicy - // For Amazon EMR releases 4.0 and later. The list of configurations supplied for - // the EMR cluster you are creating. - Configurations []*types.Configuration - - // The Amazon EMR release label, which determines the version of open-source - // application packages installed on the cluster. Release labels are in the form - // emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For - // more information about Amazon EMR release versions and included application - // versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/ - // (https://docs.aws.amazon.com/emr/latest/ReleaseGuide/). The release label - // applies only to Amazon EMR releases version 4.0 and later. Earlier versions use - // AmiVersion. - ReleaseLabel *string - - // For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use - // Applications. A list of strings that indicates third-party software to use. For - // more information, see the Amazon EMR Developer Guide - // (https://docs.aws.amazon.com/emr/latest/DeveloperGuide/emr-dg.pdf). Currently - // supported values are: - // - // * "mapr-m3" - launch the job flow using MapR M3 - // Edition. - // - // * "mapr-m5" - launch the job flow using MapR M5 Edition. - SupportedProducts []*string - - // A list of steps to run. - Steps []*types.StepConfig - - // A list of bootstrap actions to run before Hadoop starts on the cluster nodes. - BootstrapActions []*types.BootstrapActionConfig - - // The name of the job flow. - // - // This member is required. - Name *string - - // Specifies the number of steps that can be executed concurrently. The default - // value is 1. The maximum value is 256. - StepConcurrencyLevel *int32 - - // The size, in GiB, of the EBS root device volume of the Linux AMI that is used - // for each EC2 instance. Available in Amazon EMR version 4.x and later. - EbsRootVolumeSize *int32 - - // A specification of the number and type of Amazon EC2 instances. - // - // This member is required. - Instances *types.JobFlowInstancesConfig - - // A value of true indicates that all IAM users in the AWS account can perform - // cluster actions if they have the proper IAM policy permissions. This is the - // default. A value of false indicates that only the IAM user who created the - // cluster can perform actions. - VisibleToAllUsers *bool - // For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use // Applications. A list of strings that indicates third-party software to use with // the job flow that accepts a user argument list. EMR accepts and forwards the @@ -246,14 +194,15 @@ type RunJobFlowInput struct { // launch the cluster with the Ganglia Monitoring System installed. NewSupportedProducts []*types.SupportedProductConfig - // The name of a security configuration to apply to the cluster. - SecurityConfiguration *string - - // Also called instance profile and EC2 role. An IAM role for an EMR cluster. The - // EC2 instances of the cluster assume this role. The default role is - // EMR_EC2_DefaultRole. In order to use the default role, you must have already - // created it using the CLI or console. - JobFlowRole *string + // The Amazon EMR release label, which determines the version of open-source + // application packages installed on the cluster. Release labels are in the form + // emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For + // more information about Amazon EMR release versions and included application + // versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/ + // (https://docs.aws.amazon.com/emr/latest/ReleaseGuide/). The release label + // applies only to Amazon EMR releases version 4.0 and later. Earlier versions use + // AmiVersion. + ReleaseLabel *string // Applies only when CustomAmiID is used. Specifies which updates from the Amazon // Linux AMI package repositories to apply automatically when the instance boots @@ -261,6 +210,57 @@ type RunJobFlowInput struct { // security updates are applied. If NONE is specified, no updates are applied, and // all updates must be applied manually. RepoUpgradeOnBoot types.RepoUpgradeOnBoot + + // Specifies the way that individual Amazon EC2 instances terminate when an + // automatic scale-in activity occurs or an instance group is resized. + // TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the + // instance-hour boundary, regardless of when the request to terminate the instance + // was submitted. This option is only available with Amazon EMR 5.1.0 and later and + // is the default for clusters created using that version. + // TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains + // tasks from nodes before terminating the Amazon EC2 instances, regardless of the + // instance-hour boundary. With either behavior, Amazon EMR removes the least + // active nodes first and blocks instance termination if it could lead to HDFS + // corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version + // 4.1.0 and later, and is the default for versions of Amazon EMR earlier than + // 5.1.0. + ScaleDownBehavior types.ScaleDownBehavior + + // The name of a security configuration to apply to the cluster. + SecurityConfiguration *string + + // The IAM role that will be assumed by the Amazon EMR service to access AWS + // resources on your behalf. + ServiceRole *string + + // Specifies the number of steps that can be executed concurrently. The default + // value is 1. The maximum value is 256. + StepConcurrencyLevel *int32 + + // A list of steps to run. + Steps []*types.StepConfig + + // For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use + // Applications. A list of strings that indicates third-party software to use. For + // more information, see the Amazon EMR Developer Guide + // (https://docs.aws.amazon.com/emr/latest/DeveloperGuide/emr-dg.pdf). Currently + // supported values are: + // + // * "mapr-m3" - launch the job flow using MapR M3 + // Edition. + // + // * "mapr-m5" - launch the job flow using MapR M5 Edition. + SupportedProducts []*string + + // A list of tags to associate with a cluster and propagate to Amazon EC2 + // instances. + Tags []*types.Tag + + // A value of true indicates that all IAM users in the AWS account can perform + // cluster actions if they have the proper IAM policy permissions. This is the + // default. A value of false indicates that only the IAM user who created the + // cluster can perform actions. + VisibleToAllUsers *bool } // The result of the RunJobFlow () operation. diff --git a/service/emr/api_op_SetTerminationProtection.go b/service/emr/api_op_SetTerminationProtection.go index 0e076048c99..094df7458bc 100644 --- a/service/emr/api_op_SetTerminationProtection.go +++ b/service/emr/api_op_SetTerminationProtection.go @@ -71,19 +71,19 @@ func (c *Client) SetTerminationProtection(ctx context.Context, params *SetTermin // The input argument to the TerminationProtection () operation. type SetTerminationProtectionInput struct { - // A Boolean that indicates whether to protect the cluster and prevent the Amazon - // EC2 instances in the cluster from shutting down due to API calls, user - // intervention, or job-flow error. - // - // This member is required. - TerminationProtected *bool - // A list of strings that uniquely identify the clusters to protect. This // identifier is returned by RunJobFlow () and can also be obtained from // DescribeJobFlows () . // // This member is required. JobFlowIds []*string + + // A Boolean that indicates whether to protect the cluster and prevent the Amazon + // EC2 instances in the cluster from shutting down due to API calls, user + // intervention, or job-flow error. + // + // This member is required. + TerminationProtected *bool } type SetTerminationProtectionOutput struct { diff --git a/service/emr/go.mod b/service/emr/go.mod index 7f05efc4199..479821c6bca 100644 --- a/service/emr/go.mod +++ b/service/emr/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/emr go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/emr/types/types.go b/service/emr/types/types.go index 81598c31be5..a8718d6c671 100644 --- a/service/emr/types/types.go +++ b/service/emr/types/types.go @@ -22,14 +22,14 @@ type Application struct { // third-party applications that third-party vendors use for testing purposes. AdditionalInfo map[string]*string - // The version of the application. - Version *string + // Arguments for Amazon EMR to pass to the application. + Args []*string // The name of the application. Name *string - // Arguments for Amazon EMR to pass to the application. - Args []*string + // The version of the application. + Version *string } // An automatic scaling policy for a core instance group or task instance group in @@ -38,17 +38,17 @@ type Application struct { // CloudWatch metric. See PutAutoScalingPolicy (). type AutoScalingPolicy struct { - // The scale-in and scale-out rules that comprise the automatic scaling policy. - // - // This member is required. - Rules []*ScalingRule - // The upper and lower EC2 instance limits for an automatic scaling policy. // Automatic scaling activity will not cause an instance group to grow above or // below these limits. // // This member is required. Constraints *ScalingConstraints + + // The scale-in and scale-out rules that comprise the automatic scaling policy. + // + // This member is required. + Rules []*ScalingRule } // An automatic scaling policy for a core instance group or task instance group in @@ -57,16 +57,16 @@ type AutoScalingPolicy struct { // a CloudWatch metric. See PutAutoScalingPolicy (). type AutoScalingPolicyDescription struct { - // The status of an automatic scaling policy. - Status *AutoScalingPolicyStatus - - // The scale-in and scale-out rules that comprise the automatic scaling policy. - Rules []*ScalingRule - // The upper and lower EC2 instance limits for an automatic scaling policy. // Automatic scaling activity will not cause an instance group to grow above or // below these limits. Constraints *ScalingConstraints + + // The scale-in and scale-out rules that comprise the automatic scaling policy. + Rules []*ScalingRule + + // The status of an automatic scaling policy. + Status *AutoScalingPolicyStatus } // The reason for an AutoScalingPolicyStatus () change. @@ -86,11 +86,11 @@ type AutoScalingPolicyStateChangeReason struct { // The status of an automatic scaling policy. type AutoScalingPolicyStatus struct { - // The reason for a change in status. - StateChangeReason *AutoScalingPolicyStateChangeReason - // Indicates the status of the automatic scaling policy. State AutoScalingPolicyState + + // The reason for a change in status. + StateChangeReason *AutoScalingPolicyStateChangeReason } // A configuration for Amazon EMR block public access. When @@ -100,12 +100,6 @@ type AutoScalingPolicyStatus struct { // exception using PermittedPublicSecurityGroupRuleRanges. type BlockPublicAccessConfiguration struct { - // A set of properties specified within a configuration classification. - Properties map[string]*string - - // A list of additional configurations to apply within a configuration object. - Configurations []*Configuration - // Indicates whether EMR block public access is enabled (true) or disabled (false). // By default, the value is false for accounts that have created EMR clusters // before July 2019. For accounts created after this, the default is true. @@ -113,6 +107,12 @@ type BlockPublicAccessConfiguration struct { // This member is required. BlockPublicSecurityGroupRules *bool + // The classification within a configuration. + Classification *string + + // A list of additional configurations to apply within a configuration object. + Configurations []*Configuration + // Specifies ports and port ranges that are permitted to have security group rules // that allow inbound traffic from all public sources. For example, if Port 23 // (Telnet) is specified for PermittedPublicSecurityGroupRuleRanges, Amazon EMR @@ -122,8 +122,8 @@ type BlockPublicAccessConfiguration struct { // cluster EC2 instances, is in the list of PermittedPublicSecurityGroupRuleRanges. PermittedPublicSecurityGroupRuleRanges []*PortRange - // The classification within a configuration. - Classification *string + // A set of properties specified within a configuration classification. + Properties map[string]*string } // Properties that describe the AWS principal that created the @@ -147,15 +147,15 @@ type BlockPublicAccessConfigurationMetadata struct { // Configuration of a bootstrap action. type BootstrapActionConfig struct { - // The script run by the bootstrap action. + // The name of the bootstrap action. // // This member is required. - ScriptBootstrapAction *ScriptBootstrapActionConfig + Name *string - // The name of the bootstrap action. + // The script run by the bootstrap action. // // This member is required. - Name *string + ScriptBootstrapAction *ScriptBootstrapActionConfig } // Reports the configuration of a bootstrap action in a cluster (job flow). @@ -169,14 +169,14 @@ type BootstrapActionDetail struct { // EMR version 4.8.0 and later, excluding version 5.0.0. type CancelStepsInfo struct { - // The encrypted StepId of a step. - StepId *string + // The reason for the failure if the CancelSteps request fails. + Reason *string // The status of a CancelSteps Request. The value may be SUBMITTED or FAILED. Status CancelStepsRequestStatus - // The reason for the failure if the CancelSteps request fails. - Reason *string + // The encrypted StepId of a step. + StepId *string } // The definition of a CloudWatch metric alarm, which determines when an automatic @@ -184,6 +184,18 @@ type CancelStepsInfo struct { // scaling activity begins. type CloudWatchAlarmDefinition struct { + // Determines how the metric specified by MetricName is compared to the value + // specified by Threshold. + // + // This member is required. + ComparisonOperator ComparisonOperator + + // The name of the CloudWatch metric that is watched to determine an alarm + // condition. + // + // This member is required. + MetricName *string + // The period, in seconds, over which the statistic is applied. EMR CloudWatch // metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch // metric is specified, specify 300. @@ -196,62 +208,70 @@ type CloudWatchAlarmDefinition struct { // This member is required. Threshold *float64 + // A CloudWatch metric dimension. + Dimensions []*MetricDimension + // The number of periods, in five-minute increments, during which the alarm // condition must exist before the alarm triggers automatic scaling activity. The // default value is 1. EvaluationPeriods *int32 - // A CloudWatch metric dimension. - Dimensions []*MetricDimension - // The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce. Namespace *string - // Determines how the metric specified by MetricName is compared to the value - // specified by Threshold. - // - // This member is required. - ComparisonOperator ComparisonOperator + // The statistic to apply to the metric associated with the alarm. The default is + // AVERAGE. + Statistic Statistic // The unit of measure associated with the CloudWatch metric being watched. The // value specified for Unit must correspond to the units specified in the // CloudWatch metric. Unit Unit - - // The name of the CloudWatch metric that is watched to determine an alarm - // condition. - // - // This member is required. - MetricName *string - - // The statistic to apply to the metric associated with the alarm. The default is - // AVERAGE. - Statistic Statistic } // The detailed description of the cluster. type Cluster struct { - // A list of tags associated with a cluster. - Tags []*Tag + // The applications installed on this cluster. + Applications []*Application - // The Amazon Resource Name (ARN) of the Outpost where the cluster is launched. - OutpostArn *string + // An IAM role for automatic scaling policies. The default role is + // EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the + // automatic scaling feature requires to launch and terminate EC2 instances in an + // instance group. + AutoScalingRole *string + + // Specifies whether the cluster should terminate after completing all steps. + AutoTerminate *bool + + // The Amazon Resource Name of the cluster. + ClusterArn *string // Applies only to Amazon EMR releases 4.x and later. The list of Configurations // supplied to the EMR cluster. Configurations []*Configuration - // The current status details about the cluster. - Status *ClusterStatus + // Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon + // EBS-backed Linux AMI if the cluster uses a custom AMI. + CustomAmiId *string - // The Amazon Resource Name of the cluster. - ClusterArn *string + // The size, in GiB, of the EBS root device volume of the Linux AMI that is used + // for each EC2 instance. Available in Amazon EMR version 4.x and later. + EbsRootVolumeSize *int32 - // The AWS KMS customer master key (CMK) used for encrypting log files. This - // attribute is only available with EMR version 5.30.0 and later, excluding EMR - // 6.0.0. - LogEncryptionKmsKeyId *string + // Provides information about the EC2 instances in a cluster grouped by category. + // For example, key name, subnet ID, IAM instance profile, and so on. + Ec2InstanceAttributes *Ec2InstanceAttributes + + // The unique identifier for the cluster. + Id *string + + // The instance fleet configuration is available only in Amazon EMR versions 4.8.0 + // and later, excluding 5.0.x versions. The instance group configuration of the + // cluster. A value of INSTANCE_GROUP indicates a uniform instance group + // configuration. A value of INSTANCE_FLEET indicates an instance fleets + // configuration. + InstanceCollectionType InstanceCollectionType // Attributes for Kerberos configuration when Kerberos authentication is enabled // using a security configuration. For more information see Use Kerberos @@ -260,21 +280,53 @@ type Cluster struct { // the EMR Management Guide. KerberosAttributes *KerberosAttributes - // Provides information about the EC2 instances in a cluster grouped by category. - // For example, key name, subnet ID, IAM instance profile, and so on. - Ec2InstanceAttributes *Ec2InstanceAttributes + // The AWS KMS customer master key (CMK) used for encrypting log files. This + // attribute is only available with EMR version 5.30.0 and later, excluding EMR + // 6.0.0. + LogEncryptionKmsKeyId *string - // Specifies whether the cluster should terminate after completing all steps. - AutoTerminate *bool + // The path to the Amazon S3 location where logs for this cluster are stored. + LogUri *string - // Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances - // from being terminated by an API call or user intervention, or in the event of a - // cluster error. - TerminationProtected *bool + // The DNS name of the master node. If the cluster is on a private subnet, this is + // the private DNS name. On a public subnet, this is the public DNS name. + MasterPublicDnsName *string // The name of the cluster. Name *string + // An approximation of the cost of the cluster, represented in m1.small/hours. This + // value is incremented one time for every hour an m1.small instance runs. Larger + // instances are weighted more, so an EC2 instance that is roughly four times more + // expensive would result in the normalized instance hours being incremented by + // four. This result is only an approximation and does not reflect the actual + // billing rate. + NormalizedInstanceHours *int32 + + // The Amazon Resource Name (ARN) of the Outpost where the cluster is launched. + OutpostArn *string + + // The Amazon EMR release label, which determines the version of open-source + // application packages installed on the cluster. Release labels are in the form + // emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For + // more information about Amazon EMR release versions and included application + // versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/ + // (https://docs.aws.amazon.com/emr/latest/ReleaseGuide/). The release label + // applies only to Amazon EMR releases version 4.0 and later. Earlier versions use + // AmiVersion. + ReleaseLabel *string + + // Applies only when CustomAmiID is used. Specifies the type of updates that are + // applied from the Amazon Linux AMI package repositories when an instance boots + // using the AMI. + RepoUpgradeOnBoot RepoUpgradeOnBoot + + // The AMI version requested for this cluster. + RequestedAmiVersion *string + + // The AMI version running on this cluster. + RunningAmiVersion *string + // The way that individual Amazon EC2 instances terminate when an automatic // scale-in activity occurs or an instance group is resized. // TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the @@ -290,6 +342,27 @@ type Cluster struct { // 5.1.0. ScaleDownBehavior ScaleDownBehavior + // The name of the security configuration applied to the cluster. + SecurityConfiguration *string + + // The IAM role that will be assumed by the Amazon EMR service to access AWS + // resources on your behalf. + ServiceRole *string + + // The current status details about the cluster. + Status *ClusterStatus + + // Specifies the number of steps that can be executed concurrently. + StepConcurrencyLevel *int32 + + // A list of tags associated with a cluster. + Tags []*Tag + + // Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances + // from being terminated by an API call or user intervention, or in the event of a + // cluster error. + TerminationProtected *bool + // Indicates whether the cluster is visible to all IAM users of the AWS account // associated with the cluster. The default value, true, indicates that all IAM // users in the AWS account can perform cluster actions if they have the proper IAM @@ -299,99 +372,26 @@ type Cluster struct { // true when you create a cluster by using the VisibleToAllUsers parameter of the // RunJobFlow action. VisibleToAllUsers *bool +} - // The path to the Amazon S3 location where logs for this cluster are stored. - LogUri *string +// The reason that the cluster changed to its current state. +type ClusterStateChangeReason struct { - // The IAM role that will be assumed by the Amazon EMR service to access AWS - // resources on your behalf. - ServiceRole *string + // The programmatic code for the state change reason. + Code ClusterStateChangeReasonCode - // The name of the security configuration applied to the cluster. - SecurityConfiguration *string + // The descriptive message for the state change reason. + Message *string +} - // Applies only when CustomAmiID is used. Specifies the type of updates that are - // applied from the Amazon Linux AMI package repositories when an instance boots - // using the AMI. - RepoUpgradeOnBoot RepoUpgradeOnBoot +// The detailed status of the cluster. +type ClusterStatus struct { - // The Amazon EMR release label, which determines the version of open-source - // application packages installed on the cluster. Release labels are in the form - // emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For - // more information about Amazon EMR release versions and included application - // versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/ - // (https://docs.aws.amazon.com/emr/latest/ReleaseGuide/). The release label - // applies only to Amazon EMR releases version 4.0 and later. Earlier versions use - // AmiVersion. - ReleaseLabel *string + // The current state of the cluster. + State ClusterState - // The unique identifier for the cluster. - Id *string - - // The AMI version requested for this cluster. - RequestedAmiVersion *string - - // The instance fleet configuration is available only in Amazon EMR versions 4.8.0 - // and later, excluding 5.0.x versions. The instance group configuration of the - // cluster. A value of INSTANCE_GROUP indicates a uniform instance group - // configuration. A value of INSTANCE_FLEET indicates an instance fleets - // configuration. - InstanceCollectionType InstanceCollectionType - - // The DNS name of the master node. If the cluster is on a private subnet, this is - // the private DNS name. On a public subnet, this is the public DNS name. - MasterPublicDnsName *string - - // Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon - // EBS-backed Linux AMI if the cluster uses a custom AMI. - CustomAmiId *string - - // An IAM role for automatic scaling policies. The default role is - // EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the - // automatic scaling feature requires to launch and terminate EC2 instances in an - // instance group. - AutoScalingRole *string - - // Specifies the number of steps that can be executed concurrently. - StepConcurrencyLevel *int32 - - // The AMI version running on this cluster. - RunningAmiVersion *string - - // An approximation of the cost of the cluster, represented in m1.small/hours. This - // value is incremented one time for every hour an m1.small instance runs. Larger - // instances are weighted more, so an EC2 instance that is roughly four times more - // expensive would result in the normalized instance hours being incremented by - // four. This result is only an approximation and does not reflect the actual - // billing rate. - NormalizedInstanceHours *int32 - - // The applications installed on this cluster. - Applications []*Application - - // The size, in GiB, of the EBS root device volume of the Linux AMI that is used - // for each EC2 instance. Available in Amazon EMR version 4.x and later. - EbsRootVolumeSize *int32 -} - -// The reason that the cluster changed to its current state. -type ClusterStateChangeReason struct { - - // The programmatic code for the state change reason. - Code ClusterStateChangeReasonCode - - // The descriptive message for the state change reason. - Message *string -} - -// The detailed status of the cluster. -type ClusterStatus struct { - - // The current state of the cluster. - State ClusterState - - // The reason for the cluster status change. - StateChangeReason *ClusterStateChangeReason + // The reason for the cluster status change. + StateChangeReason *ClusterStateChangeReason // A timeline that represents the status of a cluster over the lifetime of the // cluster. @@ -401,6 +401,15 @@ type ClusterStatus struct { // The summary description of the cluster. type ClusterSummary struct { + // The Amazon Resource Name of the cluster. + ClusterArn *string + + // The unique identifier for the cluster. + Id *string + + // The name of the cluster. + Name *string + // An approximation of the cost of the cluster, represented in m1.small/hours. This // value is incremented one time for every hour an m1.small instance runs. Larger // instances are weighted more, so an EC2 instance that is roughly four times more @@ -409,15 +418,6 @@ type ClusterSummary struct { // billing rate. NormalizedInstanceHours *int32 - // The name of the cluster. - Name *string - - // The unique identifier for the cluster. - Id *string - - // The Amazon Resource Name of the cluster. - ClusterArn *string - // The Amazon Resource Name (ARN) of the Outpost where the cluster is launched. OutpostArn *string @@ -428,25 +428,25 @@ type ClusterSummary struct { // Represents the timeline of the cluster's lifecycle. type ClusterTimeline struct { - // The date and time when the cluster was ready to execute steps. - ReadyDateTime *time.Time + // The creation date and time of the cluster. + CreationDateTime *time.Time // The date and time when the cluster was terminated. EndDateTime *time.Time - // The creation date and time of the cluster. - CreationDateTime *time.Time + // The date and time when the cluster was ready to execute steps. + ReadyDateTime *time.Time } // An entity describing an executable that runs on a cluster. type Command struct { - // The name of the command. - Name *string - // Arguments for Amazon EMR to pass to the command for execution. Args []*string + // The name of the command. + Name *string + // The Amazon S3 location of the command script. ScriptPath *string } @@ -457,6 +457,24 @@ type Command struct { // configuration. type ComputeLimits struct { + // The upper boundary of EC2 units. It is measured through VCPU cores or instances + // for instance groups and measured through units for instance fleets. Managed + // scaling activities are not allowed beyond this boundary. The limit only applies + // to the core and task nodes. The master node cannot be scaled after initial + // configuration. + // + // This member is required. + MaximumCapacityUnits *int32 + + // The lower boundary of EC2 units. It is measured through VCPU cores or instances + // for instance groups and measured through units for instance fleets. Managed + // scaling activities are not allowed beyond this boundary. The limit only applies + // to the core and task nodes. The master node cannot be scaled after initial + // configuration. + // + // This member is required. + MinimumCapacityUnits *int32 + // The unit type used for specifying a managed scaling policy. // // This member is required. @@ -474,24 +492,6 @@ type ComputeLimits struct { // The On-Demand units are not allowed to scale beyond this boundary. The parameter // is used to split capacity allocation between On-Demand and Spot instances. MaximumOnDemandCapacityUnits *int32 - - // The lower boundary of EC2 units. It is measured through VCPU cores or instances - // for instance groups and measured through units for instance fleets. Managed - // scaling activities are not allowed beyond this boundary. The limit only applies - // to the core and task nodes. The master node cannot be scaled after initial - // configuration. - // - // This member is required. - MinimumCapacityUnits *int32 - - // The upper boundary of EC2 units. It is measured through VCPU cores or instances - // for instance groups and measured through units for instance fleets. Managed - // scaling activities are not allowed beyond this boundary. The limit only applies - // to the core and task nodes. The master node cannot be scaled after initial - // configuration. - // - // This member is required. - MaximumCapacityUnits *int32 } // Amazon EMR releases 4.x or later. An optional configuration specification to be @@ -517,12 +517,12 @@ type Configuration struct { // Configuration of requested EBS block device associated with the instance group. type EbsBlockDevice struct { + // The device name that is exposed to the instance, such as /dev/sdh. + Device *string + // EBS volume specifications such as volume type, IOPS, and size (GiB) that will be // requested for the EBS volume attached to an EC2 instance in the cluster. VolumeSpecification *VolumeSpecification - - // The device name that is exposed to the instance, such as /dev/sdh. - Device *string } // Configuration of requested EBS block device associated with the instance group @@ -543,11 +543,11 @@ type EbsBlockDeviceConfig struct { // The Amazon EBS configuration of a cluster instance. type EbsConfiguration struct { - // Indicates whether an Amazon EBS volume is EBS-optimized. - EbsOptimized *bool - // An array of Amazon EBS volume specifications attached to a cluster instance. EbsBlockDeviceConfigs []*EbsBlockDeviceConfig + + // Indicates whether an Amazon EBS volume is EBS-optimized. + EbsOptimized *bool } // EBS block device that's attached to an EC2 instance. @@ -564,6 +564,19 @@ type EbsVolume struct { // For example, key name, subnet ID, IAM instance profile, and so on. type Ec2InstanceAttributes struct { + // A list of additional Amazon EC2 security group IDs for the master node. + AdditionalMasterSecurityGroups []*string + + // A list of additional Amazon EC2 security group IDs for the core and task nodes. + AdditionalSlaveSecurityGroups []*string + + // The Availability Zone in which the cluster will run. + Ec2AvailabilityZone *string + + // The name of the Amazon EC2 key pair to use when connecting with SSH into the + // master node as a user named "hadoop". + Ec2KeyName *string + // Set this parameter to the identifier of the Amazon VPC subnet where you want the // cluster to launch. If you do not specify this value, and your account supports // EC2-Classic, the cluster launches in EC2-Classic. @@ -572,13 +585,23 @@ type Ec2InstanceAttributes struct { // The identifier of the Amazon EC2 security group for the master node. EmrManagedMasterSecurityGroup *string - // The name of the Amazon EC2 key pair to use when connecting with SSH into the - // master node as a user named "hadoop". - Ec2KeyName *string - // The identifier of the Amazon EC2 security group for the core and task nodes. EmrManagedSlaveSecurityGroup *string + // The IAM role that was specified when the cluster was launched. The EC2 instances + // of the cluster assume this role. + IamInstanceProfile *string + + // Applies to clusters configured with the instance fleets option. Specifies one or + // more Availability Zones in which to launch EC2 cluster instances when the + // EC2-Classic network configuration is supported. Amazon EMR chooses the + // Availability Zone with the best fit from among the list of + // RequestedEc2AvailabilityZones, and then launches all cluster instances within + // that Availability Zone. If you do not specify this value, Amazon EMR chooses the + // Availability Zone for you. RequestedEc2SubnetIDs and + // RequestedEc2AvailabilityZones cannot be specified together. + RequestedEc2AvailabilityZones []*string + // Applies to clusters configured with the instance fleets option. Specifies the // unique identifier of one or more Amazon EC2 subnets in which to launch EC2 // cluster instances. Subnets must exist within the same VPC. Amazon EMR chooses @@ -592,29 +615,6 @@ type Ec2InstanceAttributes struct { // together. RequestedEc2SubnetIds []*string - // Applies to clusters configured with the instance fleets option. Specifies one or - // more Availability Zones in which to launch EC2 cluster instances when the - // EC2-Classic network configuration is supported. Amazon EMR chooses the - // Availability Zone with the best fit from among the list of - // RequestedEc2AvailabilityZones, and then launches all cluster instances within - // that Availability Zone. If you do not specify this value, Amazon EMR chooses the - // Availability Zone for you. RequestedEc2SubnetIDs and - // RequestedEc2AvailabilityZones cannot be specified together. - RequestedEc2AvailabilityZones []*string - - // The Availability Zone in which the cluster will run. - Ec2AvailabilityZone *string - - // The IAM role that was specified when the cluster was launched. The EC2 instances - // of the cluster assume this role. - IamInstanceProfile *string - - // A list of additional Amazon EC2 security group IDs for the core and task nodes. - AdditionalSlaveSecurityGroups []*string - - // A list of additional Amazon EC2 security group IDs for the master node. - AdditionalMasterSecurityGroups []*string - // The identifier of the Amazon EC2 security group for the Amazon EMR service to // access clusters in VPC private subnets. ServiceAccessSecurityGroup *string @@ -628,15 +628,15 @@ type FailureDetails struct { // recorded. LogFile *string - // The reason for the step failure. In the case where the service cannot - // successfully determine the root cause of the failure, it returns "Unknown Error" - // as a reason. - Reason *string - // The descriptive message including the error the EMR service has identified as // the cause of step failure. This is text from an error log that describes the // root cause of the failure. Message *string + + // The reason for the step failure. In the case where the service cannot + // successfully determine the root cause of the failure, it returns "Unknown Error" + // as a reason. + Reason *string } // A job flow step consisting of a JAR file whose main function will be executed. @@ -644,10 +644,6 @@ type FailureDetails struct { // finish or fail. type HadoopJarStepConfig struct { - // The name of the main class in the specified Java file. If not specified, the JAR - // file should specify a Main-Class in its manifest file. - MainClass *string - // A path to a JAR file run during the step. // // This member is required. @@ -657,6 +653,10 @@ type HadoopJarStepConfig struct { // executed. Args []*string + // The name of the main class in the specified Java file. If not specified, the JAR + // file should specify a Main-Class in its manifest file. + MainClass *string + // A list of Java properties that are set when the step runs. You can use these // properties to pass key value pairs to your main function. Properties []*KeyValue @@ -667,36 +667,45 @@ type HadoopJarStepConfig struct { // finish or fail. type HadoopStepConfig struct { - // The list of Java properties that are set when the step runs. You can use these - // properties to pass key value pairs to your main function. - Properties map[string]*string - - // The name of the main class in the specified Java file. If not specified, the JAR - // file should specify a main class in its manifest file. - MainClass *string - // The list of command line arguments to pass to the JAR file's main function for // execution. Args []*string // The path to the JAR file that runs during the step. Jar *string + + // The name of the main class in the specified Java file. If not specified, the JAR + // file should specify a main class in its manifest file. + MainClass *string + + // The list of Java properties that are set when the step runs. You can use these + // properties to pass key value pairs to your main function. + Properties map[string]*string } // Represents an EC2 instance provisioned as part of cluster. type Instance struct { - // The identifier of the instance group to which this instance belongs. - InstanceGroupId *string + // The list of EBS volumes that are attached to this instance. + EbsVolumes []*EbsVolume + + // The unique identifier of the instance in Amazon EC2. + Ec2InstanceId *string // The unique identifier for the instance in Amazon EMR. Id *string - // The public IP address of the instance. - PublicIpAddress *string + // The unique identifier of the instance fleet to which an EC2 instance belongs. + InstanceFleetId *string - // The unique identifier of the instance in Amazon EC2. - Ec2InstanceId *string + // The identifier of the instance group to which this instance belongs. + InstanceGroupId *string + + // The EC2 instance type, for example m3.xlarge. + InstanceType *string + + // The instance purchasing option. Valid values are ON_DEMAND or SPOT. + Market MarketType // The private DNS name of the instance. PrivateDnsName *string @@ -704,23 +713,14 @@ type Instance struct { // The private IP address of the instance. PrivateIpAddress *string - // The current status of the instance. - Status *InstanceStatus - - // The instance purchasing option. Valid values are ON_DEMAND or SPOT. - Market MarketType - - // The EC2 instance type, for example m3.xlarge. - InstanceType *string - - // The list of EBS volumes that are attached to this instance. - EbsVolumes []*EbsVolume - // The public DNS name of the instance. PublicDnsName *string - // The unique identifier of the instance fleet to which an EC2 instance belongs. - InstanceFleetId *string + // The public IP address of the instance. + PublicIpAddress *string + + // The current status of the instance. + Status *InstanceStatus } // Describes an instance fleet, which is a group of EC2 instances that host a @@ -731,13 +731,35 @@ type Instance struct { // excluding 5.0.x versions. type InstanceFleet struct { + // The unique identifier of the instance fleet. + Id *string + + // The node type that the instance fleet hosts. Valid values are MASTER, CORE, or + // TASK. + InstanceFleetType InstanceFleetType + + // The specification for the instance types that comprise an instance fleet. Up to + // five unique instance specifications may be defined for each instance fleet. + InstanceTypeSpecifications []*InstanceTypeSpecification + + // Describes the launch specification for an instance fleet. + LaunchSpecifications *InstanceFleetProvisioningSpecifications + + // A friendly name for the instance fleet. + Name *string + + // The number of On-Demand units that have been provisioned for the instance fleet + // to fulfill TargetOnDemandCapacity. This provisioned capacity might be less than + // or greater than TargetOnDemandCapacity. + ProvisionedOnDemandCapacity *int32 + // The number of Spot units that have been provisioned for this instance fleet to // fulfill TargetSpotCapacity. This provisioned capacity might be less than or // greater than TargetSpotCapacity. ProvisionedSpotCapacity *int32 - // The unique identifier of the instance fleet. - Id *string + // The current status of the instance fleet. + Status *InstanceFleetStatus // The target capacity of On-Demand units for the instance fleet, which determines // how many On-Demand instances to provision. When the instance fleet launches, @@ -758,28 +780,6 @@ type InstanceFleet struct { // its value must be 1. TargetOnDemandCapacity *int32 - // A friendly name for the instance fleet. - Name *string - - // The number of On-Demand units that have been provisioned for the instance fleet - // to fulfill TargetOnDemandCapacity. This provisioned capacity might be less than - // or greater than TargetOnDemandCapacity. - ProvisionedOnDemandCapacity *int32 - - // The specification for the instance types that comprise an instance fleet. Up to - // five unique instance specifications may be defined for each instance fleet. - InstanceTypeSpecifications []*InstanceTypeSpecification - - // Describes the launch specification for an instance fleet. - LaunchSpecifications *InstanceFleetProvisioningSpecifications - - // The current status of the instance fleet. - Status *InstanceFleetStatus - - // The node type that the instance fleet hosts. Valid values are MASTER, CORE, or - // TASK. - InstanceFleetType InstanceFleetType - // The target capacity of Spot units for the instance fleet, which determines how // many Spot instances to provision. When the instance fleet launches, Amazon EMR // tries to provision Spot instances as specified by InstanceTypeConfig (). Each @@ -804,8 +804,11 @@ type InstanceFleet struct { // excluding 5.0.x versions. type InstanceFleetConfig struct { - // The friendly name of the instance fleet. - Name *string + // The node type that the instance fleet hosts. Valid values are MASTER,CORE,and + // TASK. + // + // This member is required. + InstanceFleetType InstanceFleetType // The instance type configurations that define the EC2 instances in the instance // fleet. @@ -814,6 +817,9 @@ type InstanceFleetConfig struct { // The launch specification for the instance fleet. LaunchSpecifications *InstanceFleetProvisioningSpecifications + // The friendly name of the instance fleet. + Name *string + // The target capacity of On-Demand units for the instance fleet, which determines // how many On-Demand instances to provision. When the instance fleet launches, // Amazon EMR tries to provision On-Demand instances as specified by @@ -831,12 +837,6 @@ type InstanceFleetConfig struct { // its value must be 1. TargetOnDemandCapacity *int32 - // The node type that the instance fleet hosts. Valid values are MASTER,CORE,and - // TASK. - // - // This member is required. - InstanceFleetType InstanceFleetType - // The target capacity of Spot units for the instance fleet, which determines how // many Spot instances to provision. When the instance fleet launches, Amazon EMR // tries to provision Spot instances as specified by InstanceTypeConfig (). Each @@ -864,13 +864,13 @@ type InstanceFleetModifyConfig struct { // This member is required. InstanceFleetId *string - // The target capacity of Spot units for the instance fleet. For more information, - // see InstanceFleetConfig$TargetSpotCapacity (). - TargetSpotCapacity *int32 - // The target capacity of On-Demand units for the instance fleet. For more // information see InstanceFleetConfig$TargetOnDemandCapacity (). TargetOnDemandCapacity *int32 + + // The target capacity of Spot units for the instance fleet. For more information, + // see InstanceFleetConfig$TargetSpotCapacity (). + TargetSpotCapacity *int32 } // The launch specification for Spot instances in the fleet, which determines the @@ -897,11 +897,11 @@ type InstanceFleetProvisioningSpecifications struct { // excluding 5.0.x versions. type InstanceFleetStateChangeReason struct { - // An explanatory message. - Message *string - // A code corresponding to the reason the state change occurred. Code InstanceFleetStateChangeReasonCode + + // An explanatory message. + Message *string } // The status of the instance fleet. The instance fleet configuration is available @@ -963,124 +963,128 @@ type InstanceFleetTimeline struct { // have common purpose. For example, CORE instance group is used for HDFS. type InstanceGroup struct { - // The marketplace to provision instances for this group. Valid values are - // ON_DEMAND or SPOT. - Market MarketType - - // The version number of a configuration specification that was successfully - // applied for an instance group last time. - LastSuccessfullyAppliedConfigurationsVersion *int64 - - // The name of the instance group. - Name *string + // An automatic scaling policy for a core instance group or task instance group in + // an Amazon EMR cluster. The automatic scaling policy defines how an instance + // group dynamically adds and terminates EC2 instances in response to the value of + // a CloudWatch metric. See PutAutoScalingPolicy. + AutoScalingPolicy *AutoScalingPolicyDescription // The bid price for each EC2 Spot instance type as defined by InstanceType. // Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is // provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%. BidPrice *string - // A list of configurations that were successfully applied for an instance group - // last time. - LastSuccessfullyAppliedConfigurations []*Configuration + // Amazon EMR releases 4.x or later. The list of configurations supplied for an EMR + // cluster instance group. You can specify a separate configuration for each + // instance group (master, core, and task). + Configurations []*Configuration - // The number of instances currently running in this instance group. - RunningInstanceCount *int32 + // The version number of the requested configuration specification for this + // instance group. + ConfigurationsVersion *int64 - // An automatic scaling policy for a core instance group or task instance group in - // an Amazon EMR cluster. The automatic scaling policy defines how an instance - // group dynamically adds and terminates EC2 instances in response to the value of - // a CloudWatch metric. See PutAutoScalingPolicy. - AutoScalingPolicy *AutoScalingPolicyDescription + // The EBS block devices that are mapped to this instance group. + EbsBlockDevices []*EbsBlockDevice - // The EC2 instance type for all instances in the instance group. - InstanceType *string + // If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an + // optimized configuration stack and provides additional, dedicated capacity for + // Amazon EBS I/O. + EbsOptimized *bool - // The current status of the instance group. - Status *InstanceGroupStatus + // The identifier of the instance group. + Id *string // The type of the instance group. Valid values are MASTER, CORE or TASK. InstanceGroupType InstanceGroupType - // The EBS block devices that are mapped to this instance group. - EbsBlockDevices []*EbsBlockDevice + // The EC2 instance type for all instances in the instance group. + InstanceType *string - // The target number of instances for the instance group. - RequestedInstanceCount *int32 + // A list of configurations that were successfully applied for an instance group + // last time. + LastSuccessfullyAppliedConfigurations []*Configuration - // Amazon EMR releases 4.x or later. The list of configurations supplied for an EMR - // cluster instance group. You can specify a separate configuration for each - // instance group (master, core, and task). - Configurations []*Configuration + // The version number of a configuration specification that was successfully + // applied for an instance group last time. + LastSuccessfullyAppliedConfigurationsVersion *int64 - // The identifier of the instance group. - Id *string + // The marketplace to provision instances for this group. Valid values are + // ON_DEMAND or SPOT. + Market MarketType - // If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an - // optimized configuration stack and provides additional, dedicated capacity for - // Amazon EBS I/O. - EbsOptimized *bool + // The name of the instance group. + Name *string + + // The target number of instances for the instance group. + RequestedInstanceCount *int32 + + // The number of instances currently running in this instance group. + RunningInstanceCount *int32 // Policy for customizing shrink operations. ShrinkPolicy *ShrinkPolicy - // The version number of the requested configuration specification for this - // instance group. - ConfigurationsVersion *int64 + // The current status of the instance group. + Status *InstanceGroupStatus } // Configuration defining a new instance group. type InstanceGroupConfig struct { - // An automatic scaling policy for a core instance group or task instance group in - // an Amazon EMR cluster. The automatic scaling policy defines how an instance - // group dynamically adds and terminates EC2 instances in response to the value of - // a CloudWatch metric. See PutAutoScalingPolicy (). - AutoScalingPolicy *AutoScalingPolicy - - // Amazon EMR releases 4.x or later. The list of configurations supplied for an EMR - // cluster instance group. You can specify a separate configuration for each - // instance group (master, core, and task). - Configurations []*Configuration - - // Friendly name given to the instance group. - Name *string + // Target number of instances for the instance group. + // + // This member is required. + InstanceCount *int32 // The role of the instance group in the cluster. // // This member is required. InstanceRole InstanceRoleType - // Market type of the EC2 instances used to create a cluster node. - Market MarketType - // The EC2 instance type for all instances in the instance group. // // This member is required. InstanceType *string - // EBS configurations that will be attached to each EC2 instance in the instance - // group. - EbsConfiguration *EbsConfiguration - - // Target number of instances for the instance group. - // - // This member is required. - InstanceCount *int32 + // An automatic scaling policy for a core instance group or task instance group in + // an Amazon EMR cluster. The automatic scaling policy defines how an instance + // group dynamically adds and terminates EC2 instances in response to the value of + // a CloudWatch metric. See PutAutoScalingPolicy (). + AutoScalingPolicy *AutoScalingPolicy // The bid price for each EC2 Spot instance type as defined by InstanceType. // Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is // provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%. BidPrice *string + + // Amazon EMR releases 4.x or later. The list of configurations supplied for an EMR + // cluster instance group. You can specify a separate configuration for each + // instance group (master, core, and task). + Configurations []*Configuration + + // EBS configurations that will be attached to each EC2 instance in the instance + // group. + EbsConfiguration *EbsConfiguration + + // Market type of the EC2 instances used to create a cluster node. + Market MarketType + + // Friendly name given to the instance group. + Name *string } // Detailed information about an instance group. type InstanceGroupDetail struct { - // Details regarding the state of the instance group. - LastStateChangeReason *string + // The date/time the instance group was created. + // + // This member is required. + CreationDateTime *time.Time - // The date/time the instance group was terminated. - EndDateTime *time.Time + // Target number of instances to run in the instance group. + // + // This member is required. + InstanceRequestCount *int32 // Instance group role in the cluster // @@ -1092,19 +1096,15 @@ type InstanceGroupDetail struct { // This member is required. InstanceRunningCount *int32 - // Unique identifier for the instance group. - InstanceGroupId *string - - // The date/time the instance group was available to the cluster. - ReadyDateTime *time.Time - - // Friendly name for the instance group. - Name *string + // EC2 instance type. + // + // This member is required. + InstanceType *string - // Target number of instances to run in the instance group. + // Market type of the EC2 instances used to create a cluster node. // // This member is required. - InstanceRequestCount *int32 + Market MarketType // State of instance group. The following values are deprecated: STARTING, // TERMINATED, and FAILED. @@ -1112,71 +1112,71 @@ type InstanceGroupDetail struct { // This member is required. State InstanceGroupState - // Market type of the EC2 instances used to create a cluster node. - // - // This member is required. - Market MarketType - - // The date/time the instance group was started. - StartDateTime *time.Time - // The bid price for each EC2 Spot instance type as defined by InstanceType. // Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is // provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%. BidPrice *string - // EC2 instance type. - // - // This member is required. - InstanceType *string + // The date/time the instance group was terminated. + EndDateTime *time.Time - // The date/time the instance group was created. - // - // This member is required. - CreationDateTime *time.Time + // Unique identifier for the instance group. + InstanceGroupId *string + + // Details regarding the state of the instance group. + LastStateChangeReason *string + + // Friendly name for the instance group. + Name *string + + // The date/time the instance group was available to the cluster. + ReadyDateTime *time.Time + + // The date/time the instance group was started. + StartDateTime *time.Time } // Modify the size or configurations of an instance group. type InstanceGroupModifyConfig struct { - // Target size for the instance group. - InstanceCount *int32 + // Unique ID of the instance group to expand or shrink. + // + // This member is required. + InstanceGroupId *string + + // A list of new or modified configurations to apply for an instance group. + Configurations []*Configuration // The EC2 InstanceIds to terminate. After you terminate the instances, the // instance group will not return to its original requested size. EC2InstanceIdsToTerminate []*string - // A list of new or modified configurations to apply for an instance group. - Configurations []*Configuration + // Target size for the instance group. + InstanceCount *int32 // Policy for customizing shrink operations. ShrinkPolicy *ShrinkPolicy - - // Unique ID of the instance group to expand or shrink. - // - // This member is required. - InstanceGroupId *string } // The status change reason details for the instance group. type InstanceGroupStateChangeReason struct { - // The status change reason description. - Message *string - // The programmable code for the state change reason. Code InstanceGroupStateChangeReasonCode + + // The status change reason description. + Message *string } // The details of the instance group status. type InstanceGroupStatus struct { - // The status change reason details for the instance group. - StateChangeReason *InstanceGroupStateChangeReason - // The current state of the instance group. State InstanceGroupState + // The status change reason details for the instance group. + StateChangeReason *InstanceGroupStateChangeReason + // The timeline of the instance group status over time. Timeline *InstanceGroupTimeline } @@ -1184,12 +1184,12 @@ type InstanceGroupStatus struct { // The timeline of the instance group lifecycle. type InstanceGroupTimeline struct { - // The date and time when the instance group terminated. - EndDateTime *time.Time - // The creation date and time of the instance group. CreationDateTime *time.Time + // The date and time when the instance group terminated. + EndDateTime *time.Time + // The date and time when the instance group became ready to perform tasks. ReadyDateTime *time.Time } @@ -1202,11 +1202,11 @@ type InstanceResizePolicy struct { // terminated. InstanceTerminationTimeout *int32 - // Specific list of instances to be terminated when shrinking an instance group. - InstancesToTerminate []*string - // Specific list of instances to be protected when shrinking an instance group. InstancesToProtect []*string + + // Specific list of instances to be terminated when shrinking an instance group. + InstancesToTerminate []*string } // The details of the status change reason for the instance. @@ -1238,11 +1238,11 @@ type InstanceTimeline struct { // The creation date and time of the instance. CreationDateTime *time.Time - // The date and time when the instance was ready to perform tasks. - ReadyDateTime *time.Time - // The date and time when the instance was terminated. EndDateTime *time.Time + + // The date and time when the instance was ready to perform tasks. + ReadyDateTime *time.Time } // An instance type configuration for each instance type in an instance fleet, @@ -1252,20 +1252,10 @@ type InstanceTimeline struct { // Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. type InstanceTypeConfig struct { - // The configuration of Amazon Elastic Block Storage (EBS) attached to each - // instance as defined by InstanceType. - EbsConfiguration *EbsConfiguration - - // The number of units that a provisioned instance of this type provides toward - // fulfilling the target capacities defined in InstanceFleetConfig (). This value - // is 1 for a master instance fleet, and must be 1 or greater for core and task - // instance fleets. Defaults to 1 if not specified. - WeightedCapacity *int32 - - // A configuration classification that applies when provisioning cluster instances, - // which can include configurations for applications and software that run on the - // cluster. - Configurations []*Configuration + // An EC2 instance type, such as m3.xlarge. + // + // This member is required. + InstanceType *string // The bid price for each EC2 Spot instance type as defined by InstanceType. // Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is @@ -1278,10 +1268,20 @@ type InstanceTypeConfig struct { // BidPriceAsPercentageOfOnDemandPrice defaults to 100%. BidPriceAsPercentageOfOnDemandPrice *float64 - // An EC2 instance type, such as m3.xlarge. - // - // This member is required. - InstanceType *string + // A configuration classification that applies when provisioning cluster instances, + // which can include configurations for applications and software that run on the + // cluster. + Configurations []*Configuration + + // The configuration of Amazon Elastic Block Storage (EBS) attached to each + // instance as defined by InstanceType. + EbsConfiguration *EbsConfiguration + + // The number of units that a provisioned instance of this type provides toward + // fulfilling the target capacities defined in InstanceFleetConfig (). This value + // is 1 for a master instance fleet, and must be 1 or greater for core and task + // instance fleets. Defaults to 1 if not specified. + WeightedCapacity *int32 } // The configuration specification for each instance type in an instance fleet. The @@ -1289,8 +1289,9 @@ type InstanceTypeConfig struct { // later, excluding 5.0.x versions. type InstanceTypeSpecification struct { - // Evaluates to TRUE when the specified InstanceType is EBS-optimized. - EbsOptimized *bool + // The bid price for each EC2 Spot instance type as defined by InstanceType. + // Expressed in USD. + BidPrice *string // The bid price, as a percentage of On-Demand price, for each EC2 Spot instance as // defined by InstanceType. Expressed as a number (for example, 20 specifies 20%). @@ -1305,13 +1306,12 @@ type InstanceTypeSpecification struct { // instance as defined by InstanceType. EbsBlockDevices []*EbsBlockDevice + // Evaluates to TRUE when the specified InstanceType is EBS-optimized. + EbsOptimized *bool + // The EC2 instance type, for example m3.xlarge. InstanceType *string - // The bid price for each EC2 Spot instance type as defined by InstanceType. - // Expressed in USD. - BidPrice *string - // The number of units that a provisioned instance of this type provides toward // fulfilling the target capacities defined in InstanceFleetConfig (). Capacity // values represent performance characteristics such as vCPUs, memory, or I/O. If @@ -1327,18 +1327,45 @@ type JobFlowDetail struct { // This member is required. ExecutionStatusDetail *JobFlowExecutionStatusDetail - // A list of the bootstrap actions run by the job flow. - BootstrapActions []*BootstrapActionDetail + // Describes the Amazon EC2 instances of the job flow. + // + // This member is required. + Instances *JobFlowInstancesDetail // The job flow identifier. // // This member is required. JobFlowId *string - // Describes the Amazon EC2 instances of the job flow. + // The name of the job flow. // // This member is required. - Instances *JobFlowInstancesDetail + Name *string + + // Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 + // and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID. + AmiVersion *string + + // An IAM role for automatic scaling policies. The default role is + // EMR_AutoScaling_DefaultRole. The IAM role provides a way for the automatic + // scaling feature to get the required permissions it needs to launch and terminate + // EC2 instances in an instance group. + AutoScalingRole *string + + // A list of the bootstrap actions run by the job flow. + BootstrapActions []*BootstrapActionDetail + + // The IAM role that was specified when the job flow was launched. The EC2 + // instances of the job flow assume this role. + JobFlowRole *string + + // The AWS KMS customer master key (CMK) used for encrypting log files. This + // attribute is only available with EMR version 5.30.0 and later, excluding EMR + // 6.0.0. + LogEncryptionKmsKeyId *string + + // The location in Amazon S3 where log files for the job are stored. + LogUri *string // The way that individual Amazon EC2 instances terminate when an automatic // scale-in activity occurs or an instance group is resized. @@ -1355,30 +1382,17 @@ type JobFlowDetail struct { // 5.1.0. ScaleDownBehavior ScaleDownBehavior + // The IAM role that will be assumed by the Amazon EMR service to access AWS + // resources on your behalf. + ServiceRole *string + // A list of steps run by the job flow. Steps []*StepDetail - // The name of the job flow. - // - // This member is required. - Name *string - - // The IAM role that was specified when the job flow was launched. The EC2 - // instances of the job flow assume this role. - JobFlowRole *string - - // Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 - // and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID. - AmiVersion *string - - // The location in Amazon S3 where log files for the job are stored. - LogUri *string - - // An IAM role for automatic scaling policies. The default role is - // EMR_AutoScaling_DefaultRole. The IAM role provides a way for the automatic - // scaling feature to get the required permissions it needs to launch and terminate - // EC2 instances in an instance group. - AutoScalingRole *string + // A list of strings set by third party software when the job flow is launched. If + // you are not using third party software to manage the job flow this value is + // empty. + SupportedProducts []*string // Indicates whether the cluster is visible to all IAM users of the AWS account // associated with the cluster. The default value, true, indicates that all IAM @@ -1389,47 +1403,33 @@ type JobFlowDetail struct { // true when you create a cluster by using the VisibleToAllUsers parameter of the // RunJobFlow action. VisibleToAllUsers *bool - - // The IAM role that will be assumed by the Amazon EMR service to access AWS - // resources on your behalf. - ServiceRole *string - - // A list of strings set by third party software when the job flow is launched. If - // you are not using third party software to manage the job flow this value is - // empty. - SupportedProducts []*string - - // The AWS KMS customer master key (CMK) used for encrypting log files. This - // attribute is only available with EMR version 5.30.0 and later, excluding EMR - // 6.0.0. - LogEncryptionKmsKeyId *string } // Describes the status of the cluster (job flow). type JobFlowExecutionStatusDetail struct { + // The creation date and time of the job flow. + // + // This member is required. + CreationDateTime *time.Time + // The state of the job flow. // // This member is required. State JobFlowExecutionState + // The completion date and time of the job flow. + EndDateTime *time.Time + + // Description of the job flow last changed state. + LastStateChangeReason *string + // The date and time when the job flow was ready to start running bootstrap // actions. ReadyDateTime *time.Time - // The completion date and time of the job flow. - EndDateTime *time.Time - // The start date and time of the job flow. StartDateTime *time.Time - - // The creation date and time of the job flow. - // - // This member is required. - CreationDateTime *time.Time - - // Description of the job flow last changed state. - LastStateChangeReason *string } // A description of the Amazon EC2 instance on which the cluster (job flow) runs. A @@ -1440,45 +1440,16 @@ type JobFlowExecutionStatusDetail struct { // configuration. type JobFlowInstancesConfig struct { - // The instance fleet configuration is available only in Amazon EMR versions 4.8.0 - // and later, excluding 5.0.x versions. Describes the EC2 instances and instance - // configurations for clusters that use the instance fleet configuration. - InstanceFleets []*InstanceFleetConfig - - // Applies to clusters that use the instance fleet configuration. When multiple EC2 - // subnet IDs are specified, Amazon EMR evaluates them and launches instances in - // the optimal subnet. The instance fleet configuration is available only in Amazon - // EMR versions 4.8.0 and later, excluding 5.0.x versions. - Ec2SubnetIds []*string - - // The EC2 instance type of the core and task nodes. - SlaveInstanceType *string - - // Configuration for the instance groups in a cluster. - InstanceGroups []*InstanceGroupConfig + // A list of additional Amazon EC2 security group IDs for the master node. + AdditionalMasterSecurityGroups []*string // A list of additional Amazon EC2 security group IDs for the core and task nodes. AdditionalSlaveSecurityGroups []*string - // Specifies whether to lock the cluster to prevent the Amazon EC2 instances from - // being terminated by API call, user intervention, or in the event of a job-flow - // error. - TerminationProtected *bool - // The name of the EC2 key pair that can be used to ssh to the master node as the // user called "hadoop." Ec2KeyName *string - // Specifies whether the cluster should remain available after completing all - // steps. - KeepJobFlowAliveWhenNoSteps *bool - - // The EC2 instance type of the master node. - MasterInstanceType *string - - // The Availability Zone in which the cluster runs. - Placement *PlacementType - // Applies to clusters that use the uniform instance group configuration. To launch // the cluster in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to // the identifier of the Amazon VPC subnet where you want the cluster to launch. If @@ -1486,6 +1457,18 @@ type JobFlowInstancesConfig struct { // launches in EC2-Classic. Ec2SubnetId *string + // Applies to clusters that use the instance fleet configuration. When multiple EC2 + // subnet IDs are specified, Amazon EMR evaluates them and launches instances in + // the optimal subnet. The instance fleet configuration is available only in Amazon + // EMR versions 4.8.0 and later, excluding 5.0.x versions. + Ec2SubnetIds []*string + + // The identifier of the Amazon EC2 security group for the master node. + EmrManagedMasterSecurityGroup *string + + // The identifier of the Amazon EC2 security group for the core and task nodes. + EmrManagedSlaveSecurityGroup *string + // Applies only to Amazon EMR release versions earlier than 4.0. The Hadoop version // for the cluster. Valid inputs are "0.18" (deprecated), "0.20" (deprecated), // "0.20.205" (deprecated), "1.0.3", "2.2.0", or "2.4.0". If you do not set this @@ -1497,53 +1480,81 @@ type JobFlowInstancesConfig struct { // The number of EC2 instances in the cluster. InstanceCount *int32 - // The identifier of the Amazon EC2 security group for the core and task nodes. - EmrManagedSlaveSecurityGroup *string + // The instance fleet configuration is available only in Amazon EMR versions 4.8.0 + // and later, excluding 5.0.x versions. Describes the EC2 instances and instance + // configurations for clusters that use the instance fleet configuration. + InstanceFleets []*InstanceFleetConfig - // A list of additional Amazon EC2 security group IDs for the master node. - AdditionalMasterSecurityGroups []*string + // Configuration for the instance groups in a cluster. + InstanceGroups []*InstanceGroupConfig + + // Specifies whether the cluster should remain available after completing all + // steps. + KeepJobFlowAliveWhenNoSteps *bool + + // The EC2 instance type of the master node. + MasterInstanceType *string + + // The Availability Zone in which the cluster runs. + Placement *PlacementType // The identifier of the Amazon EC2 security group for the Amazon EMR service to // access clusters in VPC private subnets. ServiceAccessSecurityGroup *string - // The identifier of the Amazon EC2 security group for the master node. - EmrManagedMasterSecurityGroup *string + // The EC2 instance type of the core and task nodes. + SlaveInstanceType *string + + // Specifies whether to lock the cluster to prevent the Amazon EC2 instances from + // being terminated by API call, user intervention, or in the event of a job-flow + // error. + TerminationProtected *bool } // Specify the type of Amazon EC2 instances that the cluster (job flow) runs on. type JobFlowInstancesDetail struct { - // The Hadoop version for the cluster. - HadoopVersion *string + // The number of Amazon EC2 instances in the cluster. If the value is 1, the same + // instance serves as both the master and core and task node. If the value is + // greater than 1, one instance is the master node and all others are core and task + // nodes. + // + // This member is required. + InstanceCount *int32 - // The Amazon EC2 Availability Zone for the cluster. - Placement *PlacementType + // The Amazon EC2 master node instance type. + // + // This member is required. + MasterInstanceType *string - // The Amazon EC2 instance identifier of the master node. - MasterInstanceId *string + // The Amazon EC2 core and task node instance type. + // + // This member is required. + SlaveInstanceType *string + + // The name of an Amazon EC2 key pair that can be used to ssh to the master node. + Ec2KeyName *string // For clusters launched within Amazon Virtual Private Cloud, this is the // identifier of the subnet where the cluster was launched. Ec2SubnetId *string - // The number of Amazon EC2 instances in the cluster. If the value is 1, the same - // instance serves as both the master and core and task node. If the value is - // greater than 1, one instance is the master node and all others are core and task - // nodes. - // - // This member is required. - InstanceCount *int32 + // The Hadoop version for the cluster. + HadoopVersion *string + + // Details about the instance groups in a cluster. + InstanceGroups []*InstanceGroupDetail + + // Specifies whether the cluster should remain available after completing all + // steps. + KeepJobFlowAliveWhenNoSteps *bool - // The Amazon EC2 core and task node instance type. - // - // This member is required. - SlaveInstanceType *string + // The Amazon EC2 instance identifier of the master node. + MasterInstanceId *string - // The Amazon EC2 master node instance type. - // - // This member is required. - MasterInstanceType *string + // The DNS name of the master node. If the cluster is on a private subnet, this is + // the private DNS name. On a public subnet, this is the public DNS name. + MasterPublicDnsName *string // An approximation of the cost of the cluster, represented in m1.small/hours. This // value is incremented one time for every hour that an m1.small runs. Larger @@ -1553,24 +1564,13 @@ type JobFlowInstancesDetail struct { // the actual billing rate. NormalizedInstanceHours *int32 - // The DNS name of the master node. If the cluster is on a private subnet, this is - // the private DNS name. On a public subnet, this is the public DNS name. - MasterPublicDnsName *string - - // Details about the instance groups in a cluster. - InstanceGroups []*InstanceGroupDetail + // The Amazon EC2 Availability Zone for the cluster. + Placement *PlacementType // Specifies whether the Amazon EC2 instances in the cluster are protected from // termination by API calls, user intervention, or in the event of a job-flow // error. TerminationProtected *bool - - // The name of an Amazon EC2 key pair that can be used to ssh to the master node. - Ec2KeyName *string - - // Specifies whether the cluster should remain available after completing all - // steps. - KeepJobFlowAliveWhenNoSteps *bool } // Attributes for Kerberos configuration when Kerberos authentication is enabled @@ -1580,30 +1580,30 @@ type JobFlowInstancesDetail struct { // the EMR Management Guide. type KerberosAttributes struct { + // The password used within the cluster for the kadmin service on the + // cluster-dedicated KDC, which maintains Kerberos principals, password policies, + // and keytabs for the cluster. + // + // This member is required. + KdcAdminPassword *string + // The name of the Kerberos realm to which all nodes in a cluster belong. For // example, EC2.INTERNAL. // // This member is required. Realm *string - // Required only when establishing a cross-realm trust with a KDC in a different - // realm. The cross-realm principal password, which must be identical across - // realms. - CrossRealmTrustPrincipalPassword *string + // The Active Directory password for ADDomainJoinUser. + ADDomainJoinPassword *string // Required only when establishing a cross-realm trust with an Active Directory // domain. A user with sufficient privileges to join resources to the domain. ADDomainJoinUser *string - // The password used within the cluster for the kadmin service on the - // cluster-dedicated KDC, which maintains Kerberos principals, password policies, - // and keytabs for the cluster. - // - // This member is required. - KdcAdminPassword *string - - // The Active Directory password for ADDomainJoinUser. - ADDomainJoinPassword *string + // Required only when establishing a cross-realm trust with a KDC in a different + // realm. The cross-realm principal password, which must be identical across + // realms. + CrossRealmTrustPrincipalPassword *string } // A key value pair. @@ -1679,28 +1679,28 @@ type PlacementType struct { // and MaxRange. type PortRange struct { - // The smallest port number in a specified range of port numbers. - MaxRange *int32 - // The smallest port number in a specified range of port numbers. // // This member is required. MinRange *int32 + + // The smallest port number in a specified range of port numbers. + MaxRange *int32 } // The type of adjustment the automatic scaling activity makes when triggered, and // the periodicity of the adjustment. type ScalingAction struct { - // Not available for instance groups. Instance groups use the market type specified - // for the group. - Market MarketType - // The type of adjustment the automatic scaling activity makes when triggered, and // the periodicity of the adjustment. // // This member is required. SimpleScalingPolicyConfiguration *SimpleScalingPolicyConfiguration + + // Not available for instance groups. Instance groups use the market type specified + // for the group. + Market MarketType } // The upper and lower EC2 instance limits for an automatic scaling policy. @@ -1729,11 +1729,10 @@ type ScalingConstraints struct { // instance group can comprise one or more automatic scaling rules. type ScalingRule struct { - // The CloudWatch alarm definition that determines when automatic scaling activity - // is triggered. + // The conditions that trigger an automatic scaling activity. // // This member is required. - Trigger *ScalingTrigger + Action *ScalingAction // The name used to identify an automatic scaling rule. Rule names must be unique // within a scaling policy. @@ -1741,13 +1740,14 @@ type ScalingRule struct { // This member is required. Name *string - // A friendly, more verbose description of the automatic scaling rule. - Description *string - - // The conditions that trigger an automatic scaling activity. + // The CloudWatch alarm definition that determines when automatic scaling activity + // is triggered. // // This member is required. - Action *ScalingAction + Trigger *ScalingTrigger + + // A friendly, more verbose description of the automatic scaling rule. + Description *string } // The conditions that trigger an automatic scaling activity. @@ -1763,14 +1763,14 @@ type ScalingTrigger struct { // Configuration of the script to run during a bootstrap action. type ScriptBootstrapActionConfig struct { - // A list of command line arguments to pass to the bootstrap action script. - Args []*string - // Location of the script to run during a bootstrap action. Can be either a // location in Amazon S3 or on a local file system. // // This member is required. Path *string + + // A list of command line arguments to pass to the bootstrap action script. + Args []*string } // The creation date and time, and name, of a security configuration. @@ -1787,13 +1787,13 @@ type SecurityConfigurationSummary struct { // decommissioning timeout and targeted instance shrinking. type ShrinkPolicy struct { - // Custom policy for requesting termination protection or termination of specific - // instances when shrinking an instance group. - InstanceResizePolicy *InstanceResizePolicy - // The desired timeout for decommissioning an instance. Overrides the default YARN // decommissioning timeout. DecommissionTimeout *int32 + + // Custom policy for requesting termination protection or termination of specific + // instances when shrinking an instance group. + InstanceResizePolicy *InstanceResizePolicy } // An automatic scaling configuration, which describes how the policy adds or @@ -1801,6 +1801,17 @@ type ShrinkPolicy struct { // will be added each time the CloudWatch metric alarm condition is satisfied. type SimpleScalingPolicyConfiguration struct { + // The amount by which to scale in or scale out, based on the specified + // AdjustmentType. A positive value adds to the instance group's EC2 instance count + // while a negative number removes instances. If AdjustmentType is set to + // EXACT_CAPACITY, the number should only be a positive integer. If AdjustmentType + // is set to PERCENT_CHANGE_IN_CAPACITY, the value should express the percentage as + // an integer. For example, -20 indicates a decrease in 20% increments of cluster + // capacity. + // + // This member is required. + ScalingAdjustment *int32 + // The way in which EC2 instances are added (if ScalingAdjustment is a positive // number) or terminated (if ScalingAdjustment is a negative number) each time the // scaling activity is triggered. CHANGE_IN_CAPACITY is the default. @@ -1817,17 +1828,6 @@ type SimpleScalingPolicyConfiguration struct { // The amount of time, in seconds, after a scaling activity completes before any // further trigger-related scaling activities can start. The default value is 0. CoolDown *int32 - - // The amount by which to scale in or scale out, based on the specified - // AdjustmentType. A positive value adds to the instance group's EC2 instance count - // while a negative number removes instances. If AdjustmentType is set to - // EXACT_CAPACITY, the number should only be a positive integer. If AdjustmentType - // is set to PERCENT_CHANGE_IN_CAPACITY, the value should express the percentage as - // an integer. For example, -20 indicates a decrease in 20% increments of cluster - // capacity. - // - // This member is required. - ScalingAdjustment *int32 } // The launch specification for Spot instances in the instance fleet, which @@ -1847,15 +1847,6 @@ type SpotProvisioningSpecification struct { // This member is required. TimeoutAction SpotProvisioningTimeoutAction - // The defined duration for Spot instances (also known as Spot blocks) in minutes. - // When specified, the Spot instance does not terminate before the defined duration - // expires, and defined duration pricing for Spot instances applies. Valid values - // are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot - // instance receives its instance ID. At the end of the duration, Amazon EC2 marks - // the Spot instance for termination and provides a Spot instance termination - // notice, which gives the instance a two-minute warning before it terminates. - BlockDurationMinutes *int32 - // The spot provisioning timeout period in minutes. If Spot instances are not // provisioned within this time period, the TimeOutAction is taken. Minimum value // is 5 and maximum value is 1440. The timeout applies only during initial @@ -1869,27 +1860,36 @@ type SpotProvisioningSpecification struct { // Spot instance pools with optimal capacity for the number of instances that are // launching. AllocationStrategy SpotProvisioningAllocationStrategy + + // The defined duration for Spot instances (also known as Spot blocks) in minutes. + // When specified, the Spot instance does not terminate before the defined duration + // expires, and defined duration pricing for Spot instances applies. Valid values + // are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot + // instance receives its instance ID. At the end of the duration, Amazon EC2 marks + // the Spot instance for termination and provides a Spot instance termination + // notice, which gives the instance a two-minute warning before it terminates. + BlockDurationMinutes *int32 } // This represents a step in a cluster. type Step struct { - // The Hadoop job configuration of the cluster step. - Config *HadoopStepConfig - - // The current execution status details of the cluster step. - Status *StepStatus - - // The name of the cluster step. - Name *string - // The action to take when the cluster step fails. Possible values are // TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided // for backward compatibility. We recommend using TERMINATE_CLUSTER instead. ActionOnFailure ActionOnFailure + // The Hadoop job configuration of the cluster step. + Config *HadoopStepConfig + // The identifier of the cluster step. Id *string + + // The name of the cluster step. + Name *string + + // The current execution status details of the cluster step. + Status *StepStatus } // Specification of a cluster (job flow) step. @@ -1900,15 +1900,15 @@ type StepConfig struct { // This member is required. HadoopJarStep *HadoopJarStepConfig - // The action to take when the cluster step fails. Possible values are - // TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided - // for backward compatibility. We recommend using TERMINATE_CLUSTER instead. - ActionOnFailure ActionOnFailure - // The name of the step. // // This member is required. Name *string + + // The action to take when the cluster step fails. Possible values are + // TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided + // for backward compatibility. We recommend using TERMINATE_CLUSTER instead. + ActionOnFailure ActionOnFailure } // Combines the execution state and configuration of a step. @@ -1928,8 +1928,15 @@ type StepDetail struct { // The execution state of a step. type StepExecutionStatusDetail struct { - // The start date and time of the step. - StartDateTime *time.Time + // The creation date and time of the step. + // + // This member is required. + CreationDateTime *time.Time + + // The state of the step. + // + // This member is required. + State StepExecutionState // The completion date and time of the step. EndDateTime *time.Time @@ -1937,15 +1944,8 @@ type StepExecutionStatusDetail struct { // A description of the step's current state. LastStateChangeReason *string - // The state of the step. - // - // This member is required. - State StepExecutionState - - // The creation date and time of the step. - // - // This member is required. - CreationDateTime *time.Time + // The start date and time of the step. + StartDateTime *time.Time } // The details of the step state change reason. @@ -1962,26 +1962,23 @@ type StepStateChangeReason struct { // The execution status details of the cluster step. type StepStatus struct { - // The reason for the step execution status change. - StateChangeReason *StepStateChangeReason + // The details for the step failure including reason, message, and log file path + // where the root cause was identified. + FailureDetails *FailureDetails // The execution state of the cluster step. State StepState + // The reason for the step execution status change. + StateChangeReason *StepStateChangeReason + // The timeline of the cluster step status over time. Timeline *StepTimeline - - // The details for the step failure including reason, message, and log file path - // where the root cause was identified. - FailureDetails *FailureDetails } // The summary of the cluster step. type StepSummary struct { - // The current execution status details of the cluster step. - Status *StepStatus - // The action to take when the cluster step fails. Possible values are // TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is // available for backward compatibility. We recommend using TERMINATE_CLUSTER @@ -1991,24 +1988,27 @@ type StepSummary struct { // The Hadoop job configuration of the cluster step. Config *HadoopStepConfig + // The identifier of the cluster step. + Id *string + // The name of the cluster step. Name *string - // The identifier of the cluster step. - Id *string + // The current execution status details of the cluster step. + Status *StepStatus } // The timeline of the cluster step lifecycle. type StepTimeline struct { - // The date and time when the cluster step execution started. - StartDateTime *time.Time + // The date and time when the cluster step was created. + CreationDateTime *time.Time // The date and time when the cluster step execution completed or failed. EndDateTime *time.Time - // The date and time when the cluster step was created. - CreationDateTime *time.Time + // The date and time when the cluster step execution started. + StartDateTime *time.Time } // The list of supported product configurations which allow user-supplied @@ -2016,11 +2016,11 @@ type StepTimeline struct { // installation script as bootstrap action arguments. type SupportedProductConfig struct { - // The name of the product configuration. - Name *string - // The list of user-supplied arguments. Args []*string + + // The name of the product configuration. + Name *string } // A key/value pair containing user-defined metadata that you can associate with an @@ -2030,21 +2030,27 @@ type SupportedProductConfig struct { // (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html). type Tag struct { - // A user-defined value, which is optional in a tag. For more information, see Tag - // Clusters - // (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html). - Value *string - // A user-defined key, which is the minimum required information for a valid tag. // For more information, see Tag // (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html). Key *string + + // A user-defined value, which is optional in a tag. For more information, see Tag + // Clusters + // (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html). + Value *string } // EBS volume specifications such as volume type, IOPS, and size (GiB) that will be // requested for the EBS volume attached to an EC2 instance in the cluster. type VolumeSpecification struct { + // The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the + // volume type is EBS-optimized, the minimum value is 10. + // + // This member is required. + SizeInGB *int32 + // The volume type. Volume types supported are gp2, io1, standard. // // This member is required. @@ -2052,10 +2058,4 @@ type VolumeSpecification struct { // The number of I/O operations per second (IOPS) that the volume supports. Iops *int32 - - // The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the - // volume type is EBS-optimized, the minimum value is 10. - // - // This member is required. - SizeInGB *int32 } diff --git a/service/eventbridge/api_op_CreateEventBus.go b/service/eventbridge/api_op_CreateEventBus.go index 13bd6572bfa..c180dbc3d1f 100644 --- a/service/eventbridge/api_op_CreateEventBus.go +++ b/service/eventbridge/api_op_CreateEventBus.go @@ -59,10 +59,6 @@ func (c *Client) CreateEventBus(ctx context.Context, params *CreateEventBusInput type CreateEventBusInput struct { - // If you are creating a partner event bus, this specifies the partner event source - // that the new event bus will be matched with. - EventSourceName *string - // The name of the new event bus. Event bus names cannot contain the / character. // You can't use the name default for a custom event bus, as this name is already // used for your account's default event bus. If this is a partner event bus, the @@ -72,6 +68,10 @@ type CreateEventBusInput struct { // This member is required. Name *string + // If you are creating a partner event bus, this specifies the partner event source + // that the new event bus will be matched with. + EventSourceName *string + // Tags to associate with the event bus. Tags []*types.Tag } diff --git a/service/eventbridge/api_op_CreatePartnerEventSource.go b/service/eventbridge/api_op_CreatePartnerEventSource.go index 6129b0c2a5b..fd383cdd312 100644 --- a/service/eventbridge/api_op_CreatePartnerEventSource.go +++ b/service/eventbridge/api_op_CreatePartnerEventSource.go @@ -71,6 +71,12 @@ func (c *Client) CreatePartnerEventSource(ctx context.Context, params *CreatePar type CreatePartnerEventSourceInput struct { + // The AWS account ID that is permitted to create a matching partner event bus for + // this partner event source. + // + // This member is required. + Account *string + // The name of the partner event source. This name must be unique and must be in // the format partner_name/event_namespace/event_name . The AWS account that wants // to use this partner event source must create a partner event bus with a name @@ -78,12 +84,6 @@ type CreatePartnerEventSourceInput struct { // // This member is required. Name *string - - // The AWS account ID that is permitted to create a matching partner event bus for - // this partner event source. - // - // This member is required. - Account *string } type CreatePartnerEventSourceOutput struct { diff --git a/service/eventbridge/api_op_DeleteRule.go b/service/eventbridge/api_op_DeleteRule.go index 1dfd930148b..36f0db6a22d 100644 --- a/service/eventbridge/api_op_DeleteRule.go +++ b/service/eventbridge/api_op_DeleteRule.go @@ -63,15 +63,15 @@ func (c *Client) DeleteRule(ctx context.Context, params *DeleteRuleInput, optFns type DeleteRuleInput struct { - // The event bus associated with the rule. If you omit this, the default event bus - // is used. - EventBusName *string - // The name of the rule. // // This member is required. Name *string + // The event bus associated with the rule. If you omit this, the default event bus + // is used. + EventBusName *string + // If this is a managed rule, created by an AWS service on your behalf, you must // specify Force as True to delete the rule. This parameter is ignored for rules // that are not managed rules. You can check whether a rule is a managed rule by diff --git a/service/eventbridge/api_op_DescribeEventBus.go b/service/eventbridge/api_op_DescribeEventBus.go index aa8f4717bfd..e6ad3097303 100644 --- a/service/eventbridge/api_op_DescribeEventBus.go +++ b/service/eventbridge/api_op_DescribeEventBus.go @@ -68,13 +68,13 @@ type DescribeEventBusInput struct { type DescribeEventBusOutput struct { - // The name of the event bus. Currently, this is always default. - Name *string - // The Amazon Resource Name (ARN) of the account permitted to write events to the // current account. Arn *string + // The name of the event bus. Currently, this is always default. + Name *string + // The policy that enables the external account to send events to your account. Policy *string diff --git a/service/eventbridge/api_op_DescribeEventSource.go b/service/eventbridge/api_op_DescribeEventSource.go index 95abb31b499..b8f2e4b3f10 100644 --- a/service/eventbridge/api_op_DescribeEventSource.go +++ b/service/eventbridge/api_op_DescribeEventSource.go @@ -67,18 +67,21 @@ type DescribeEventSourceInput struct { type DescribeEventSourceOutput struct { + // The ARN of the partner event source. + Arn *string + // The name of the SaaS partner that created the event source. CreatedBy *string - // The name of the partner event source. - Name *string + // The date and time that the event source was created. + CreationTime *time.Time // The date and time that the event source will expire if you do not create a // matching event bus. ExpirationTime *time.Time - // The ARN of the partner event source. - Arn *string + // The name of the partner event source. + Name *string // The state of the event source. If it is ACTIVE, you have already created a // matching event bus for this event source, and that event bus is active. If it is @@ -87,9 +90,6 @@ type DescribeEventSourceOutput struct { // event source has since been deleted. State types.EventSourceState - // The date and time that the event source was created. - CreationTime *time.Time - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/eventbridge/api_op_DescribeRule.go b/service/eventbridge/api_op_DescribeRule.go index c00e72328e5..cb292c52e1c 100644 --- a/service/eventbridge/api_op_DescribeRule.go +++ b/service/eventbridge/api_op_DescribeRule.go @@ -58,36 +58,27 @@ func (c *Client) DescribeRule(ctx context.Context, params *DescribeRuleInput, op type DescribeRuleInput struct { - // The event bus associated with the rule. If you omit this, the default event bus - // is used. - EventBusName *string - // The name of the rule. // // This member is required. Name *string + + // The event bus associated with the rule. If you omit this, the default event bus + // is used. + EventBusName *string } type DescribeRuleOutput struct { - // The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". - ScheduleExpression *string - - // The name of the rule. - Name *string + // The Amazon Resource Name (ARN) of the rule. + Arn *string - // The Amazon Resource Name (ARN) of the IAM role associated with the rule. - RoleArn *string + // The description of the rule. + Description *string // The event bus associated with the rule. EventBusName *string - // Specifies whether the rule is enabled or disabled. - State types.RuleState - - // The Amazon Resource Name (ARN) of the rule. - Arn *string - // The event pattern. For more information, see Events and Event Patterns // (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) // in the Amazon EventBridge User Guide. @@ -97,8 +88,17 @@ type DescribeRuleOutput struct { // displays the principal name of the AWS service that created the rule. ManagedBy *string - // The description of the rule. - Description *string + // The name of the rule. + Name *string + + // The Amazon Resource Name (ARN) of the IAM role associated with the rule. + RoleArn *string + + // The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". + ScheduleExpression *string + + // Specifies whether the rule is enabled or disabled. + State types.RuleState // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/eventbridge/api_op_DisableRule.go b/service/eventbridge/api_op_DisableRule.go index c9169009fda..054df47ada6 100644 --- a/service/eventbridge/api_op_DisableRule.go +++ b/service/eventbridge/api_op_DisableRule.go @@ -59,14 +59,14 @@ func (c *Client) DisableRule(ctx context.Context, params *DisableRuleInput, optF type DisableRuleInput struct { - // The event bus associated with the rule. If you omit this, the default event bus - // is used. - EventBusName *string - // The name of the rule. // // This member is required. Name *string + + // The event bus associated with the rule. If you omit this, the default event bus + // is used. + EventBusName *string } type DisableRuleOutput struct { diff --git a/service/eventbridge/api_op_EnableRule.go b/service/eventbridge/api_op_EnableRule.go index 7abe9f9edd1..3fb18024749 100644 --- a/service/eventbridge/api_op_EnableRule.go +++ b/service/eventbridge/api_op_EnableRule.go @@ -59,14 +59,14 @@ func (c *Client) EnableRule(ctx context.Context, params *EnableRuleInput, optFns type EnableRuleInput struct { - // The event bus associated with the rule. If you omit this, the default event bus - // is used. - EventBusName *string - // The name of the rule. // // This member is required. Name *string + + // The event bus associated with the rule. If you omit this, the default event bus + // is used. + EventBusName *string } type EnableRuleOutput struct { diff --git a/service/eventbridge/api_op_ListEventBuses.go b/service/eventbridge/api_op_ListEventBuses.go index 7541f1451e4..905e7c7c437 100644 --- a/service/eventbridge/api_op_ListEventBuses.go +++ b/service/eventbridge/api_op_ListEventBuses.go @@ -57,17 +57,17 @@ func (c *Client) ListEventBuses(ctx context.Context, params *ListEventBusesInput type ListEventBusesInput struct { + // Specifying this limits the number of results returned by this operation. The + // operation also returns a NextToken which you can use in a subsequent operation + // to retrieve the next set of results. + Limit *int32 + // Specifying this limits the results to only those event buses with names that // start with the specified prefix. NamePrefix *string // The token returned by a previous call to retrieve the next set of results. NextToken *string - - // Specifying this limits the number of results returned by this operation. The - // operation also returns a NextToken which you can use in a subsequent operation - // to retrieve the next set of results. - Limit *int32 } type ListEventBusesOutput struct { diff --git a/service/eventbridge/api_op_ListEventSources.go b/service/eventbridge/api_op_ListEventSources.go index d7920ac816c..a8ce5936ffc 100644 --- a/service/eventbridge/api_op_ListEventSources.go +++ b/service/eventbridge/api_op_ListEventSources.go @@ -58,28 +58,28 @@ func (c *Client) ListEventSources(ctx context.Context, params *ListEventSourcesI type ListEventSourcesInput struct { - // Specifying this limits the results to only those partner event sources with - // names that start with the specified prefix. - NamePrefix *string - // Specifying this limits the number of results returned by this operation. The // operation also returns a NextToken which you can use in a subsequent operation // to retrieve the next set of results. Limit *int32 + // Specifying this limits the results to only those partner event sources with + // names that start with the specified prefix. + NamePrefix *string + // The token returned by a previous call to retrieve the next set of results. NextToken *string } type ListEventSourcesOutput struct { + // The list of event sources. + EventSources []*types.EventSource + // A token you can use in a subsequent operation to retrieve the next set of // results. NextToken *string - // The list of event sources. - EventSources []*types.EventSource - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/eventbridge/api_op_ListPartnerEventSourceAccounts.go b/service/eventbridge/api_op_ListPartnerEventSourceAccounts.go index 87235cf5112..68075d2b3d3 100644 --- a/service/eventbridge/api_op_ListPartnerEventSourceAccounts.go +++ b/service/eventbridge/api_op_ListPartnerEventSourceAccounts.go @@ -59,10 +59,6 @@ func (c *Client) ListPartnerEventSourceAccounts(ctx context.Context, params *Lis type ListPartnerEventSourceAccountsInput struct { - // The token returned by a previous call to this operation. Specifying this - // retrieves the next set of results. - NextToken *string - // The name of the partner event source to display account information about. // // This member is required. @@ -72,17 +68,21 @@ type ListPartnerEventSourceAccountsInput struct { // operation also returns a NextToken which you can use in a subsequent operation // to retrieve the next set of results. Limit *int32 + + // The token returned by a previous call to this operation. Specifying this + // retrieves the next set of results. + NextToken *string } type ListPartnerEventSourceAccountsOutput struct { - // The list of partner event sources returned by the operation. - PartnerEventSourceAccounts []*types.PartnerEventSourceAccount - // A token you can use in a subsequent operation to retrieve the next set of // results. NextToken *string + // The list of partner event sources returned by the operation. + PartnerEventSourceAccounts []*types.PartnerEventSourceAccount + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/eventbridge/api_op_ListPartnerEventSources.go b/service/eventbridge/api_op_ListPartnerEventSources.go index 47b62755ca7..c8a8281aaf6 100644 --- a/service/eventbridge/api_op_ListPartnerEventSources.go +++ b/service/eventbridge/api_op_ListPartnerEventSources.go @@ -76,13 +76,13 @@ type ListPartnerEventSourcesInput struct { type ListPartnerEventSourcesOutput struct { - // The list of partner event sources returned by the operation. - PartnerEventSources []*types.PartnerEventSource - // A token you can use in a subsequent operation to retrieve the next set of // results. NextToken *string + // The list of partner event sources returned by the operation. + PartnerEventSources []*types.PartnerEventSource + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/eventbridge/api_op_ListRuleNamesByTarget.go b/service/eventbridge/api_op_ListRuleNamesByTarget.go index e6f05928e78..52479e94b9d 100644 --- a/service/eventbridge/api_op_ListRuleNamesByTarget.go +++ b/service/eventbridge/api_op_ListRuleNamesByTarget.go @@ -57,31 +57,31 @@ func (c *Client) ListRuleNamesByTarget(ctx context.Context, params *ListRuleName type ListRuleNamesByTargetInput struct { - // The maximum number of results to return. - Limit *int32 - - // The token returned by a previous call to retrieve the next set of results. - NextToken *string + // The Amazon Resource Name (ARN) of the target resource. + // + // This member is required. + TargetArn *string // Limits the results to show only the rules associated with the specified event // bus. EventBusName *string - // The Amazon Resource Name (ARN) of the target resource. - // - // This member is required. - TargetArn *string + // The maximum number of results to return. + Limit *int32 + + // The token returned by a previous call to retrieve the next set of results. + NextToken *string } type ListRuleNamesByTargetOutput struct { - // The names of the rules that can invoke the given target. - RuleNames []*string - // Indicates whether there are additional results to retrieve. If there are no more // results, the value is null. NextToken *string + // The names of the rules that can invoke the given target. + RuleNames []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/eventbridge/api_op_ListRules.go b/service/eventbridge/api_op_ListRules.go index 8eebd13c6d9..69ee8c510df 100644 --- a/service/eventbridge/api_op_ListRules.go +++ b/service/eventbridge/api_op_ListRules.go @@ -59,29 +59,29 @@ func (c *Client) ListRules(ctx context.Context, params *ListRulesInput, optFns . type ListRulesInput struct { - // The token returned by a previous call to retrieve the next set of results. - NextToken *string - // Limits the results to show only the rules associated with the specified event // bus. EventBusName *string + // The maximum number of results to return. + Limit *int32 + // The prefix matching the rule name. NamePrefix *string - // The maximum number of results to return. - Limit *int32 + // The token returned by a previous call to retrieve the next set of results. + NextToken *string } type ListRulesOutput struct { - // The rules that match the specified criteria. - Rules []*types.Rule - // Indicates whether there are additional results to retrieve. If there are no more // results, the value is null. NextToken *string + // The rules that match the specified criteria. + Rules []*types.Rule + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/eventbridge/api_op_ListTargetsByRule.go b/service/eventbridge/api_op_ListTargetsByRule.go index 0329ae95941..21a3510a543 100644 --- a/service/eventbridge/api_op_ListTargetsByRule.go +++ b/service/eventbridge/api_op_ListTargetsByRule.go @@ -57,20 +57,20 @@ func (c *Client) ListTargetsByRule(ctx context.Context, params *ListTargetsByRul type ListTargetsByRuleInput struct { - // The event bus associated with the rule. If you omit this, the default event bus - // is used. - EventBusName *string - - // The token returned by a previous call to retrieve the next set of results. - NextToken *string - // The name of the rule. // // This member is required. Rule *string + // The event bus associated with the rule. If you omit this, the default event bus + // is used. + EventBusName *string + // The maximum number of results to return. Limit *int32 + + // The token returned by a previous call to retrieve the next set of results. + NextToken *string } type ListTargetsByRuleOutput struct { diff --git a/service/eventbridge/api_op_PutEvents.go b/service/eventbridge/api_op_PutEvents.go index 6ce537e1154..9ec4fc8c41d 100644 --- a/service/eventbridge/api_op_PutEvents.go +++ b/service/eventbridge/api_op_PutEvents.go @@ -67,14 +67,14 @@ type PutEventsInput struct { type PutEventsOutput struct { - // The number of failed entries. - FailedEntryCount *int32 - // The successfully and unsuccessfully ingested events results. If the ingestion // was successful, the entry has the event ID in it. Otherwise, you can use the // error code and error message to identify the problem with the entry. Entries []*types.PutEventsResultEntry + // The number of failed entries. + FailedEntryCount *int32 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/eventbridge/api_op_PutPartnerEvents.go b/service/eventbridge/api_op_PutPartnerEvents.go index 4edce89787e..02922af3cf3 100644 --- a/service/eventbridge/api_op_PutPartnerEvents.go +++ b/service/eventbridge/api_op_PutPartnerEvents.go @@ -66,14 +66,14 @@ type PutPartnerEventsInput struct { type PutPartnerEventsOutput struct { - // The number of events from this operation that could not be written to the - // partner event bus. - FailedEntryCount *int32 - // The list of events from this operation that were successfully written to the // partner event bus. Entries []*types.PutPartnerEventsResultEntry + // The number of events from this operation that could not be written to the + // partner event bus. + FailedEntryCount *int32 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/eventbridge/api_op_PutPermission.go b/service/eventbridge/api_op_PutPermission.go index 2f6219b855d..a9921837f39 100644 --- a/service/eventbridge/api_op_PutPermission.go +++ b/service/eventbridge/api_op_PutPermission.go @@ -81,10 +81,6 @@ type PutPermissionInput struct { // This member is required. Action *string - // The event bus associated with the rule. If you omit this, the default event bus - // is used. - EventBusName *string - // The 12-digit AWS account ID that you are permitting to put events to your // default event bus. Specify "*" to permit any account to put events to your // default event bus.

    If you specify "*" without specifying @@ -97,6 +93,13 @@ type PutPermissionInput struct { // This member is required. Principal *string + // An identifier string for the external account that you are granting permissions + // to. If you later want to revoke the permission for this external account, + // specify this StatementId when you run RemovePermission (). + // + // This member is required. + StatementId *string + // This parameter enables you to limit the permission to accounts that fulfill a // certain condition, such as being a member of a certain AWS organization. For // more information about AWS Organizations, see What Is AWS Organizations @@ -108,12 +111,9 @@ type PutPermissionInput struct { // Key, and Value fields.

    Condition *types.Condition - // An identifier string for the external account that you are granting permissions - // to. If you later want to revoke the permission for this external account, - // specify this StatementId when you run RemovePermission (). - // - // This member is required. - StatementId *string + // The event bus associated with the rule. If you omit this, the default event bus + // is used. + EventBusName *string } type PutPermissionOutput struct { diff --git a/service/eventbridge/api_op_PutRule.go b/service/eventbridge/api_op_PutRule.go index 59fa78f3f81..de92f5b0220 100644 --- a/service/eventbridge/api_op_PutRule.go +++ b/service/eventbridge/api_op_PutRule.go @@ -99,35 +99,35 @@ func (c *Client) PutRule(ctx context.Context, params *PutRuleInput, optFns ...fu type PutRuleInput struct { - // The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 - // minutes)". - ScheduleExpression *string - - // Indicates whether the rule is enabled or disabled. - State types.RuleState + // The name of the rule that you are creating or updating. + // + // This member is required. + Name *string // A description of the rule. Description *string - // The event pattern. For more information, see Events and Event Patterns - // (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) - // in the Amazon EventBridge User Guide. - EventPattern *string - // The event bus to associate with this rule. If you omit this, the default event // bus is used. EventBusName *string - // The list of key-value pairs to associate with the rule. - Tags []*types.Tag + // The event pattern. For more information, see Events and Event Patterns + // (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + // in the Amazon EventBridge User Guide. + EventPattern *string // The Amazon Resource Name (ARN) of the IAM role associated with the rule. RoleArn *string - // The name of the rule that you are creating or updating. - // - // This member is required. - Name *string + // The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 + // minutes)". + ScheduleExpression *string + + // Indicates whether the rule is enabled or disabled. + State types.RuleState + + // The list of key-value pairs to associate with the rule. + Tags []*types.Tag } type PutRuleOutput struct { diff --git a/service/eventbridge/api_op_PutTargets.go b/service/eventbridge/api_op_PutTargets.go index 056e78f4678..0fae8639aee 100644 --- a/service/eventbridge/api_op_PutTargets.go +++ b/service/eventbridge/api_op_PutTargets.go @@ -128,10 +128,6 @@ func (c *Client) PutTargets(ctx context.Context, params *PutTargetsInput, optFns type PutTargetsInput struct { - // The name of the event bus associated with the rule. If you omit this, the - // default event bus is used. - EventBusName *string - // The name of the rule. // // This member is required. @@ -141,6 +137,10 @@ type PutTargetsInput struct { // // This member is required. Targets []*types.Target + + // The name of the event bus associated with the rule. If you omit this, the + // default event bus is used. + EventBusName *string } type PutTargetsOutput struct { diff --git a/service/eventbridge/api_op_RemoveTargets.go b/service/eventbridge/api_op_RemoveTargets.go index 022d9cd6d9b..a0a455a62d1 100644 --- a/service/eventbridge/api_op_RemoveTargets.go +++ b/service/eventbridge/api_op_RemoveTargets.go @@ -64,13 +64,6 @@ func (c *Client) RemoveTargets(ctx context.Context, params *RemoveTargetsInput, type RemoveTargetsInput struct { - // If this is a managed rule, created by an AWS service on your behalf, you must - // specify Force as True to remove targets. This parameter is ignored for rules - // that are not managed rules. You can check whether a rule is a managed rule by - // using DescribeRule or ListRules and checking the ManagedBy field of the - // response. - Force *bool - // The IDs of the targets to remove from the rule. // // This member is required. @@ -83,16 +76,23 @@ type RemoveTargetsInput struct { // The name of the event bus associated with the rule. EventBusName *string + + // If this is a managed rule, created by an AWS service on your behalf, you must + // specify Force as True to remove targets. This parameter is ignored for rules + // that are not managed rules. You can check whether a rule is a managed rule by + // using DescribeRule or ListRules and checking the ManagedBy field of the + // response. + Force *bool } type RemoveTargetsOutput struct { - // The number of failed entries. - FailedEntryCount *int32 - // The failed target entries. FailedEntries []*types.RemoveTargetsResultEntry + // The number of failed entries. + FailedEntryCount *int32 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/eventbridge/go.mod b/service/eventbridge/go.mod index e72a40bdaf8..82ed326004f 100644 --- a/service/eventbridge/go.mod +++ b/service/eventbridge/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/eventbridge go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/eventbridge/types/types.go b/service/eventbridge/types/types.go index f0634f4a1e0..32174b76d33 100644 --- a/service/eventbridge/types/types.go +++ b/service/eventbridge/types/types.go @@ -11,6 +11,12 @@ import ( // ECS tasks that use the awsvpc network mode. type AwsVpcConfiguration struct { + // Specifies the subnets associated with the task. These subnets must all be in the + // same VPC. You can specify as many as 16 subnets. + // + // This member is required. + Subnets []*string + // Specifies whether the task's elastic network interface receives a public IP // address. You can specify ENABLED only when LaunchType in EcsParameters is set to // FARGATE. @@ -21,12 +27,6 @@ type AwsVpcConfiguration struct { // you do not specify a security group, the default security group for the VPC is // used. SecurityGroups []*string - - // Specifies the subnets associated with the task. These subnets must all be in the - // same VPC. You can specify as many as 16 subnets. - // - // This member is required. - Subnets []*string } // The array properties for the submitted job, such as the size of the array. The @@ -43,12 +43,6 @@ type BatchArrayProperties struct { // The custom parameters to be used when the target is an AWS Batch job. type BatchParameters struct { - // The array properties for the submitted job, such as the size of the array. The - // array size can be between 2 and 10,000. If you specify array properties for a - // job, it becomes an array job. This parameter is used only if the target is an - // AWS Batch job. - ArrayProperties *BatchArrayProperties - // The ARN or name of the job definition to use if the event target is an AWS Batch // job. This job definition must already exist. // @@ -61,6 +55,12 @@ type BatchParameters struct { // This member is required. JobName *string + // The array properties for the submitted job, such as the size of the array. The + // array size can be between 2 and 10,000. If you specify array properties for a + // job, it becomes an array job. This parameter is used only if the target is an + // AWS Batch job. + ArrayProperties *BatchArrayProperties + // The retry strategy to use for failed jobs, if the target is an AWS Batch job. // The retry strategy is the number of times to retry the failed job execution. // Valid values are 1–10. When you specify a retry strategy here, it overrides the @@ -86,6 +86,12 @@ type BatchRetryStrategy struct { // "StringEquals", "Key": "aws:PrincipalOrgID", "Value": "o-1234567890"}' type Condition struct { + // Specifies the key for the condition. Currently the only supported key is + // aws:PrincipalOrgID. + // + // This member is required. + Key *string + // Specifies the type of condition. Currently the only supported value is // StringEquals. // @@ -97,30 +103,27 @@ type Condition struct { // // This member is required. Value *string - - // Specifies the key for the condition. Currently the only supported key is - // aws:PrincipalOrgID. - // - // This member is required. - Key *string } // The custom parameters to be used when the target is an Amazon ECS task. type EcsParameters struct { + // The ARN of the task definition to use if the event target is an Amazon ECS task. + // + // This member is required. + TaskDefinitionArn *string + // Specifies an ECS task group for the task. The maximum length is 255 characters. Group *string - // The number of tasks to create based on TaskDefinition. The default is 1. - TaskCount *int32 - - // Specifies the platform version for the task. Specify only the numeric portion of - // the platform version, such as 1.1.0. This structure is used only if LaunchType - // is FARGATE. For more information about valid platform versions, see AWS Fargate - // Platform Versions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // Specifies the launch type on which your task is running. The launch type that + // you specify here must match one of the launch type (compatibilities) of the + // target task. The FARGATE value is supported only in the Regions where AWS + // Fargate with Amazon ECS is supported. For more information, see AWS Fargate on + // Amazon ECS + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html) // in the Amazon Elastic Container Service Developer Guide. - PlatformVersion *string + LaunchType LaunchType // Use this structure if the ECS task uses the awsvpc network mode. This structure // specifies the VPC subnets and security groups associated with the task, and @@ -130,19 +133,16 @@ type EcsParameters struct { // awsvpc network mode, the task fails. NetworkConfiguration *NetworkConfiguration - // The ARN of the task definition to use if the event target is an Amazon ECS task. - // - // This member is required. - TaskDefinitionArn *string - - // Specifies the launch type on which your task is running. The launch type that - // you specify here must match one of the launch type (compatibilities) of the - // target task. The FARGATE value is supported only in the Regions where AWS - // Fargate with Amazon ECS is supported. For more information, see AWS Fargate on - // Amazon ECS - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html) + // Specifies the platform version for the task. Specify only the numeric portion of + // the platform version, such as 1.1.0. This structure is used only if LaunchType + // is FARGATE. For more information about valid platform versions, see AWS Fargate + // Platform Versions + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) // in the Amazon Elastic Container Service Developer Guide. - LaunchType LaunchType + PlatformVersion *string + + // The number of tasks to create based on TaskDefinition. The default is 1. + TaskCount *int32 } // An event bus receives events from a source and routes them to rules associated @@ -169,15 +169,8 @@ type EventBus struct { // events from the partner's applications or services. type EventSource struct { - // The name of the event source. - Name *string - - // The state of the event source. If it is ACTIVE, you have already created a - // matching event bus for this event source, and that event bus is active. If it is - // PENDING, either you haven't yet created a matching event bus, or that event bus - // is deactivated. If it is DELETED, you have created a matching event bus, but the - // event source has since been deleted. - State EventSourceState + // The ARN of the event source. + Arn *string // The name of the partner that created the event source. CreatedBy *string @@ -189,8 +182,15 @@ type EventSource struct { // create a matching event bus for it. ExpirationTime *time.Time - // The ARN of the event source. - Arn *string + // The name of the event source. + Name *string + + // The state of the event source. If it is ACTIVE, you have already created a + // matching event bus for this event source, and that event bus is active. If it is + // PENDING, either you haven't yet created a matching event bus, or that event bus + // is deactivated. If it is DELETED, you have created a matching event bus, but the + // event source has since been deleted. + State EventSourceState } // These are custom parameter to be used when the target is an API Gateway REST @@ -273,16 +273,19 @@ type NetworkConfiguration struct { // events from the partner's applications or services. type PartnerEventSource struct { - // The name of the partner event source. - Name *string - // The ARN of the partner event source. Arn *string + + // The name of the partner event source. + Name *string } // The AWS account that a partner event source has been offered to. type PartnerEventSourceAccount struct { + // The AWS account ID that the partner event source was offered to. + Account *string + // The date and time the event source was created. CreationTime *time.Time @@ -290,9 +293,6 @@ type PartnerEventSourceAccount struct { // create a matching event bus for it. ExpirationTime *time.Time - // The AWS account ID that the partner event source was offered to. - Account *string - // The state of the event source. If it is ACTIVE, you have already created a // matching event bus for this event source, and that event bus is active. If it is // PENDING, either you haven't yet created a matching event bus, or that event bus @@ -304,28 +304,28 @@ type PartnerEventSourceAccount struct { // Represents an event to be submitted. type PutEventsRequestEntry struct { - // The source of the event. - Source *string - - // The time stamp of the event, per RFC3339 - // (https://www.rfc-editor.org/rfc/rfc3339.txt). If no time stamp is provided, the - // time stamp of the PutEvents () call is used. - Time *time.Time - - // AWS resources, identified by Amazon Resource Name (ARN), which the event - // primarily concerns. Any number, including zero, may be present. - Resources []*string - - // Free-form string used to decide what fields to expect in the event detail. - DetailType *string - // A valid JSON string. There is no other schema imposed. The JSON string may // contain fields and nested subobjects. Detail *string + // Free-form string used to decide what fields to expect in the event detail. + DetailType *string + // The event bus that will receive the event. Only the rules that are associated // with this event bus will be able to match the event. EventBusName *string + + // AWS resources, identified by Amazon Resource Name (ARN), which the event + // primarily concerns. Any number, including zero, may be present. + Resources []*string + + // The source of the event. + Source *string + + // The time stamp of the event, per RFC3339 + // (https://www.rfc-editor.org/rfc/rfc3339.txt). If no time stamp is provided, the + // time stamp of the PutEvents () call is used. + Time *time.Time } // Represents an event that failed to be submitted. @@ -334,11 +334,11 @@ type PutEventsResultEntry struct { // The error code that indicates why the event submission failed. ErrorCode *string - // The ID of the event. - EventId *string - // The error message that explains why the event submission failed. ErrorMessage *string + + // The ID of the event. + EventId *string } // The details about an event generated by an SaaS partner. @@ -351,40 +351,40 @@ type PutPartnerEventsRequestEntry struct { // A free-form string used to decide what fields to expect in the event detail. DetailType *string + // AWS resources, identified by Amazon Resource Name (ARN), which the event + // primarily concerns. Any number, including zero, may be present. + Resources []*string + // The event source that is generating the evntry. Source *string // The date and time of the event. Time *time.Time - - // AWS resources, identified by Amazon Resource Name (ARN), which the event - // primarily concerns. Any number, including zero, may be present. - Resources []*string } // Represents an event that a partner tried to generate, but failed. type PutPartnerEventsResultEntry struct { + // The error code that indicates why the event submission failed. + ErrorCode *string + // The error message that explains why the event submission failed. ErrorMessage *string // The ID of the event. EventId *string - - // The error code that indicates why the event submission failed. - ErrorCode *string } // Represents a target that failed to be added to a rule. type PutTargetsResultEntry struct { - // The error message that explains why the target addition failed. - ErrorMessage *string - // The error code that indicates why the target addition failed. If the value is // ConcurrentModificationException, too many requests were made at the same time. ErrorCode *string + // The error message that explains why the target addition failed. + ErrorMessage *string + // The ID of the target. TargetId *string } @@ -396,46 +396,46 @@ type RemoveTargetsResultEntry struct { // ConcurrentModificationException, too many requests were made at the same time. ErrorCode *string - // The ID of the target. - TargetId *string - // The error message that explains why the target removal failed. ErrorMessage *string + + // The ID of the target. + TargetId *string } // Contains information about a rule in Amazon EventBridge. type Rule struct { - // The state of the rule. - State RuleState - - // The Amazon Resource Name (ARN) of the role that is used for target invocation. - RoleArn *string - // The Amazon Resource Name (ARN) of the rule. Arn *string + // The description of the rule. + Description *string + + // The event bus associated with the rule. + EventBusName *string + // The event pattern of the rule. For more information, see Events and Event // Patterns // (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) // in the Amazon EventBridge User Guide. EventPattern *string - // The event bus associated with the rule. - EventBusName *string - // If the rule was created on behalf of your account by an AWS service, this field // displays the principal name of the service that created the rule. ManagedBy *string - // The description of the rule. - Description *string + // The name of the rule. + Name *string + + // The Amazon Resource Name (ARN) of the role that is used for target invocation. + RoleArn *string // The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". ScheduleExpression *string - // The name of the rule. - Name *string + // The state of the rule. + State RuleState } // This parameter contains the criteria (either InstanceIds or a tag) used to @@ -454,16 +454,16 @@ type RunCommandParameters struct { // this key may specify multiple values. type RunCommandTarget struct { - // If Key is tag: tag-key, Values is a list of tag values. If Key is InstanceIds, - // Values is a list of Amazon EC2 instance IDs. + // Can be either tag: tag-key or InstanceIds. // // This member is required. - Values []*string + Key *string - // Can be either tag: tag-key or InstanceIds. + // If Key is tag: tag-key, Values is a list of tag values. If Key is InstanceIds, + // Values is a list of Amazon EC2 instance IDs. // // This member is required. - Key *string + Values []*string } // This structure includes the custom parameter to be used when the target is an @@ -478,16 +478,16 @@ type SqsParameters struct { // event buses support tagging. type Tag struct { - // The value for the specified tag key. - // - // This member is required. - Value *string - // A string you can use to assign a value. The combination of tag keys and values // can help you organize and categorize your resources. // // This member is required. Key *string + + // The value for the specified tag key. + // + // This member is required. + Value *string } // Targets are the resources to be invoked when a rule is triggered. For a complete @@ -502,6 +502,35 @@ type Tag struct { // Guide    .

    type Target struct { + // The Amazon Resource Name (ARN) of the target. + // + // This member is required. + Arn *string + + // The ID of the target. + // + // This member is required. + Id *string + + // If the event target is an AWS Batch job, this contains the job definition, job + // name, and other parameters. For more information, see Jobs + // (https://docs.aws.amazon.com/batch/latest/userguide/jobs.html) in the AWS Batch + // User Guide. + BatchParameters *BatchParameters + + // Contains the Amazon ECS task definition and task count to be used, if the event + // target is an Amazon ECS task. For more information about Amazon ECS tasks, see + // Task Definitions + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) + // in the Amazon EC2 Container Service Developer Guide. + EcsParameters *EcsParameters + + // Contains the HTTP parameters to use when the target is a API Gateway REST + // endpoint. If you specify an API Gateway REST API as a target, you can use this + // parameter to specify headers, path parameter, query string keys/values as part + // of your target invoking request. + HttpParameters *HttpParameters + // Valid JSON text passed to the target. In this case, nothing from the event // itself is passed to the target. For more information, see The JavaScript Object // Notation (JSON) Data Interchange Format @@ -514,11 +543,10 @@ type Target struct { // (http://goessner.net/articles/JsonPath/). InputPath *string - // If the event target is an AWS Batch job, this contains the job definition, job - // name, and other parameters. For more information, see Jobs - // (https://docs.aws.amazon.com/batch/latest/userguide/jobs.html) in the AWS Batch - // User Guide. - BatchParameters *BatchParameters + // Settings to enable you to provide custom input to a target based on certain + // event data. You can extract one or more key-value pairs from the event and then + // use that data to send customized input to the target. + InputTransformer *InputTransformer // The custom parameter you can use to control the shard assignment, when the // target is a Kinesis data stream. If you do not include this parameter, the @@ -530,39 +558,11 @@ type Target struct { // different IAM role for each target. RoleArn *string - // The ID of the target. - // - // This member is required. - Id *string - - // Settings to enable you to provide custom input to a target based on certain - // event data. You can extract one or more key-value pairs from the event and then - // use that data to send customized input to the target. - InputTransformer *InputTransformer - - // The Amazon Resource Name (ARN) of the target. - // - // This member is required. - Arn *string - // Parameters used when you are using the rule to invoke Amazon EC2 Run Command. RunCommandParameters *RunCommandParameters - // Contains the HTTP parameters to use when the target is a API Gateway REST - // endpoint. If you specify an API Gateway REST API as a target, you can use this - // parameter to specify headers, path parameter, query string keys/values as part - // of your target invoking request. - HttpParameters *HttpParameters - // Contains the message group ID to use when the target is a FIFO queue. If you // specify an SQS FIFO queue as a target, the queue must have content-based // deduplication enabled. SqsParameters *SqsParameters - - // Contains the Amazon ECS task definition and task count to be used, if the event - // target is an Amazon ECS task. For more information about Amazon ECS tasks, see - // Task Definitions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) - // in the Amazon EC2 Container Service Developer Guide. - EcsParameters *EcsParameters } diff --git a/service/firehose/api_op_CreateDeliveryStream.go b/service/firehose/api_op_CreateDeliveryStream.go index f4afdd0fa47..77be9961573 100644 --- a/service/firehose/api_op_CreateDeliveryStream.go +++ b/service/firehose/api_op_CreateDeliveryStream.go @@ -117,11 +117,16 @@ func (c *Client) CreateDeliveryStream(ctx context.Context, params *CreateDeliver type CreateDeliveryStreamInput struct { - // The destination in Amazon Redshift. You can specify only one destination. - RedshiftDestinationConfiguration *types.RedshiftDestinationConfiguration + // The name of the delivery stream. This name must be unique per AWS account in the + // same AWS Region. If the delivery streams are in different accounts or different + // Regions, you can have multiple delivery streams with the same name. + // + // This member is required. + DeliveryStreamName *string - // [Deprecated] The destination in Amazon S3. You can specify only one destination. - S3DestinationConfiguration *types.S3DestinationConfiguration + // Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed + // for Server-Side Encryption (SSE). + DeliveryStreamEncryptionConfigurationInput *types.DeliveryStreamEncryptionConfigurationInput // The delivery stream type. This parameter can be one of the following values: // @@ -133,31 +138,29 @@ type CreateDeliveryStreamInput struct { // source. DeliveryStreamType types.DeliveryStreamType - // The destination in Splunk. You can specify only one destination. - SplunkDestinationConfiguration *types.SplunkDestinationConfiguration + // The destination in Amazon ES. You can specify only one destination. + ElasticsearchDestinationConfiguration *types.ElasticsearchDestinationConfiguration - // The name of the delivery stream. This name must be unique per AWS account in the - // same AWS Region. If the delivery streams are in different accounts or different - // Regions, you can have multiple delivery streams with the same name. - // - // This member is required. - DeliveryStreamName *string + // The destination in Amazon S3. You can specify only one destination. + ExtendedS3DestinationConfiguration *types.ExtendedS3DestinationConfiguration + + // Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint + // destination. You can specify only one destination. + HttpEndpointDestinationConfiguration *types.HttpEndpointDestinationConfiguration // When a Kinesis data stream is used as the source for the delivery stream, a // KinesisStreamSourceConfiguration () containing the Kinesis data stream Amazon // Resource Name (ARN) and the role ARN for the source stream. KinesisStreamSourceConfiguration *types.KinesisStreamSourceConfiguration - // The destination in Amazon ES. You can specify only one destination. - ElasticsearchDestinationConfiguration *types.ElasticsearchDestinationConfiguration + // The destination in Amazon Redshift. You can specify only one destination. + RedshiftDestinationConfiguration *types.RedshiftDestinationConfiguration - // Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed - // for Server-Side Encryption (SSE). - DeliveryStreamEncryptionConfigurationInput *types.DeliveryStreamEncryptionConfigurationInput + // [Deprecated] The destination in Amazon S3. You can specify only one destination. + S3DestinationConfiguration *types.S3DestinationConfiguration - // Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint - // destination. You can specify only one destination. - HttpEndpointDestinationConfiguration *types.HttpEndpointDestinationConfiguration + // The destination in Splunk. You can specify only one destination. + SplunkDestinationConfiguration *types.SplunkDestinationConfiguration // A set of tags to assign to the delivery stream. A tag is a key-value pair that // you can define and assign to AWS resources. Tags are metadata. For example, you @@ -168,9 +171,6 @@ type CreateDeliveryStreamInput struct { // in the AWS Billing and Cost Management User Guide.

    You can specify up to 50 // tags when creating a delivery stream.

    Tags []*types.Tag - - // The destination in Amazon S3. You can specify only one destination. - ExtendedS3DestinationConfiguration *types.ExtendedS3DestinationConfiguration } type CreateDeliveryStreamOutput struct { diff --git a/service/firehose/api_op_DescribeDeliveryStream.go b/service/firehose/api_op_DescribeDeliveryStream.go index 21e018f8c3d..de5c30ffc0a 100644 --- a/service/firehose/api_op_DescribeDeliveryStream.go +++ b/service/firehose/api_op_DescribeDeliveryStream.go @@ -64,18 +64,18 @@ func (c *Client) DescribeDeliveryStream(ctx context.Context, params *DescribeDel type DescribeDeliveryStreamInput struct { - // The limit on the number of destinations to return. You can have one destination - // per delivery stream. - Limit *int32 + // The name of the delivery stream. + // + // This member is required. + DeliveryStreamName *string // The ID of the destination to start returning the destination information. // Kinesis Data Firehose supports one destination per delivery stream. ExclusiveStartDestinationId *string - // The name of the delivery stream. - // - // This member is required. - DeliveryStreamName *string + // The limit on the number of destinations to return. You can have one destination + // per delivery stream. + Limit *int32 } type DescribeDeliveryStreamOutput struct { diff --git a/service/firehose/api_op_ListDeliveryStreams.go b/service/firehose/api_op_ListDeliveryStreams.go index 2d10d1b2636..f3b2c3be998 100644 --- a/service/firehose/api_op_ListDeliveryStreams.go +++ b/service/firehose/api_op_ListDeliveryStreams.go @@ -63,11 +63,6 @@ func (c *Client) ListDeliveryStreams(ctx context.Context, params *ListDeliverySt type ListDeliveryStreamsInput struct { - // The list of delivery streams returned by this call to ListDeliveryStreams will - // start with the delivery stream whose name comes alphabetically immediately after - // the name you specify in ExclusiveStartDeliveryStreamName. - ExclusiveStartDeliveryStreamName *string - // The delivery stream type. This can be one of the following values: // // * @@ -81,21 +76,26 @@ type ListDeliveryStreamsInput struct { // streams of all types are returned. DeliveryStreamType types.DeliveryStreamType + // The list of delivery streams returned by this call to ListDeliveryStreams will + // start with the delivery stream whose name comes alphabetically immediately after + // the name you specify in ExclusiveStartDeliveryStreamName. + ExclusiveStartDeliveryStreamName *string + // The maximum number of delivery streams to list. The default value is 10. Limit *int32 } type ListDeliveryStreamsOutput struct { - // Indicates whether there are more delivery streams available to list. + // The names of the delivery streams. // // This member is required. - HasMoreDeliveryStreams *bool + DeliveryStreamNames []*string - // The names of the delivery streams. + // Indicates whether there are more delivery streams available to list. // // This member is required. - DeliveryStreamNames []*string + HasMoreDeliveryStreams *bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/firehose/api_op_ListTagsForDeliveryStream.go b/service/firehose/api_op_ListTagsForDeliveryStream.go index 98e85456ec3..c38d9ce008c 100644 --- a/service/firehose/api_op_ListTagsForDeliveryStream.go +++ b/service/firehose/api_op_ListTagsForDeliveryStream.go @@ -58,6 +58,11 @@ func (c *Client) ListTagsForDeliveryStream(ctx context.Context, params *ListTags type ListTagsForDeliveryStreamInput struct { + // The name of the delivery stream whose tags you want to list. + // + // This member is required. + DeliveryStreamName *string + // The key to use as the starting point for the list of tags. If you set this // parameter, ListTagsForDeliveryStream gets all tags that occur after // ExclusiveStartTagKey. @@ -68,21 +73,10 @@ type ListTagsForDeliveryStreamInput struct { // response. To list additional tags, set ExclusiveStartTagKey to the last key in // the response. Limit *int32 - - // The name of the delivery stream whose tags you want to list. - // - // This member is required. - DeliveryStreamName *string } type ListTagsForDeliveryStreamOutput struct { - // A list of tags associated with DeliveryStreamName, starting with the first tag - // after ExclusiveStartTagKey and up to the specified Limit. - // - // This member is required. - Tags []*types.Tag - // If this is true in the response, more tags are available. To list the remaining // tags, set ExclusiveStartTagKey to the key of the last tag returned and call // ListTagsForDeliveryStream again. @@ -90,6 +84,12 @@ type ListTagsForDeliveryStreamOutput struct { // This member is required. HasMoreTags *bool + // A list of tags associated with DeliveryStreamName, starting with the first tag + // after ExclusiveStartTagKey and up to the specified Limit. + // + // This member is required. + Tags []*types.Tag + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/firehose/api_op_PutRecord.go b/service/firehose/api_op_PutRecord.go index 4ef870791c1..792b6c4b447 100644 --- a/service/firehose/api_op_PutRecord.go +++ b/service/firehose/api_op_PutRecord.go @@ -85,15 +85,15 @@ func (c *Client) PutRecord(ctx context.Context, params *PutRecordInput, optFns . type PutRecordInput struct { - // The record. + // The name of the delivery stream. // // This member is required. - Record *types.Record + DeliveryStreamName *string - // The name of the delivery stream. + // The record. // // This member is required. - DeliveryStreamName *string + Record *types.Record } type PutRecordOutput struct { diff --git a/service/firehose/api_op_PutRecordBatch.go b/service/firehose/api_op_PutRecordBatch.go index 4fe8f78c3d2..6075d30f059 100644 --- a/service/firehose/api_op_PutRecordBatch.go +++ b/service/firehose/api_op_PutRecordBatch.go @@ -103,23 +103,19 @@ func (c *Client) PutRecordBatch(ctx context.Context, params *PutRecordBatchInput type PutRecordBatchInput struct { - // One or more records. + // The name of the delivery stream. // // This member is required. - Records []*types.Record + DeliveryStreamName *string - // The name of the delivery stream. + // One or more records. // // This member is required. - DeliveryStreamName *string + Records []*types.Record } type PutRecordBatchOutput struct { - // Indicates whether server-side encryption (SSE) was enabled during this - // operation. - Encrypted *bool - // The number of records that might have failed processing. This number might be // greater than 0 even if the PutRecordBatch () call succeeds. Check FailedPutCount // to determine whether there are records that you need to resend. @@ -133,6 +129,10 @@ type PutRecordBatchOutput struct { // This member is required. RequestResponses []*types.PutRecordBatchResponseEntry + // Indicates whether server-side encryption (SSE) was enabled during this + // operation. + Encrypted *bool + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/firehose/api_op_UntagDeliveryStream.go b/service/firehose/api_op_UntagDeliveryStream.go index 060a3fe2304..34ab4425ab0 100644 --- a/service/firehose/api_op_UntagDeliveryStream.go +++ b/service/firehose/api_op_UntagDeliveryStream.go @@ -59,15 +59,15 @@ func (c *Client) UntagDeliveryStream(ctx context.Context, params *UntagDeliveryS type UntagDeliveryStreamInput struct { - // A list of tag keys. Each corresponding tag is removed from the delivery stream. + // The name of the delivery stream. // // This member is required. - TagKeys []*string + DeliveryStreamName *string - // The name of the delivery stream. + // A list of tag keys. Each corresponding tag is removed from the delivery stream. // // This member is required. - DeliveryStreamName *string + TagKeys []*string } type UntagDeliveryStreamOutput struct { diff --git a/service/firehose/api_op_UpdateDestination.go b/service/firehose/api_op_UpdateDestination.go index 2c98528446f..5653155be4e 100644 --- a/service/firehose/api_op_UpdateDestination.go +++ b/service/firehose/api_op_UpdateDestination.go @@ -82,43 +82,43 @@ func (c *Client) UpdateDestination(ctx context.Context, params *UpdateDestinatio type UpdateDestinationInput struct { - // Describes an update to the specified HTTP endpoint destination. - HttpEndpointDestinationUpdate *types.HttpEndpointDestinationUpdate + // Obtain this value from the VersionId result of DeliveryStreamDescription (). + // This value is required, and helps the service perform conditional operations. + // For example, if there is an interleaving update and this value is null, then the + // update destination fails. After the update is successful, the VersionId value is + // updated. The service then performs a merge of the old configuration with the new + // configuration. + // + // This member is required. + CurrentDeliveryStreamVersionId *string // The name of the delivery stream. // // This member is required. DeliveryStreamName *string + // The ID of the destination. + // + // This member is required. + DestinationId *string + // Describes an update for a destination in Amazon ES. ElasticsearchDestinationUpdate *types.ElasticsearchDestinationUpdate // Describes an update for a destination in Amazon S3. ExtendedS3DestinationUpdate *types.ExtendedS3DestinationUpdate - // [Deprecated] Describes an update for a destination in Amazon S3. - S3DestinationUpdate *types.S3DestinationUpdate + // Describes an update to the specified HTTP endpoint destination. + HttpEndpointDestinationUpdate *types.HttpEndpointDestinationUpdate // Describes an update for a destination in Amazon Redshift. RedshiftDestinationUpdate *types.RedshiftDestinationUpdate - // Obtain this value from the VersionId result of DeliveryStreamDescription (). - // This value is required, and helps the service perform conditional operations. - // For example, if there is an interleaving update and this value is null, then the - // update destination fails. After the update is successful, the VersionId value is - // updated. The service then performs a merge of the old configuration with the new - // configuration. - // - // This member is required. - CurrentDeliveryStreamVersionId *string + // [Deprecated] Describes an update for a destination in Amazon S3. + S3DestinationUpdate *types.S3DestinationUpdate // Describes an update for a destination in Splunk. SplunkDestinationUpdate *types.SplunkDestinationUpdate - - // The ID of the destination. - // - // This member is required. - DestinationId *string } type UpdateDestinationOutput struct { diff --git a/service/firehose/go.mod b/service/firehose/go.mod index fee45291e63..d1e87015cff 100644 --- a/service/firehose/go.mod +++ b/service/firehose/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/firehose go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/firehose/types/types.go b/service/firehose/types/types.go index f744de6aa4c..1ad7cd263ce 100644 --- a/service/firehose/types/types.go +++ b/service/firehose/types/types.go @@ -13,6 +13,12 @@ import ( // one of them, you must also provide a value for the other. type BufferingHints struct { + // Buffer incoming data for the specified period of time, in seconds, before + // delivering it to the destination. The default value is 300. This parameter is + // optional but if you specify a value for it, you must also specify a value for + // SizeInMBs, and vice versa. + IntervalInSeconds *int32 + // Buffer incoming data to the specified size, in MiBs, before delivering it to the // destination. The default value is 5. This parameter is optional but if you // specify a value for it, you must also specify a value for IntervalInSeconds, and @@ -21,27 +27,21 @@ type BufferingHints struct { // example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB // or higher. SizeInMBs *int32 - - // Buffer incoming data for the specified period of time, in seconds, before - // delivering it to the destination. The default value is 300. This parameter is - // optional but if you specify a value for it, you must also specify a value for - // SizeInMBs, and vice versa. - IntervalInSeconds *int32 } // Describes the Amazon CloudWatch logging options for your delivery stream. type CloudWatchLoggingOptions struct { - // The CloudWatch log stream name for logging. This value is required if CloudWatch - // logging is enabled. - LogStreamName *string - // Enables or disables CloudWatch logging. Enabled *bool // The CloudWatch group name for logging. This value is required if CloudWatch // logging is enabled. LogGroupName *string + + // The CloudWatch log stream name for logging. This value is required if CloudWatch + // logging is enabled. + LogStreamName *string } // Describes a COPY command for Amazon Redshift. @@ -80,11 +80,6 @@ type CopyCommand struct { // (https://docs.aws.amazon.com/firehose/latest/dev/record-format-conversion.html). type DataFormatConversionConfiguration struct { - // Specifies the serializer that you want Kinesis Data Firehose to use to convert - // the format of your data to the Parquet or ORC format. This parameter is required - // if Enabled is set to true. - OutputFormatConfiguration *OutputFormatConfiguration - // Defaults to true. Set it to false if you want to disable format conversion while // preserving the configuration details. Enabled *bool @@ -94,6 +89,11 @@ type DataFormatConversionConfiguration struct { // to true. InputFormatConfiguration *InputFormatConfiguration + // Specifies the serializer that you want Kinesis Data Firehose to use to convert + // the format of your data to the Parquet or ORC format. This parameter is required + // if Enabled is set to true. + OutputFormatConfiguration *OutputFormatConfiguration + // Specifies the AWS Glue Data Catalog table that contains the column information. // This parameter is required if Enabled is set to true. SchemaConfiguration *SchemaConfiguration @@ -102,22 +102,25 @@ type DataFormatConversionConfiguration struct { // Contains information about a delivery stream. type DeliveryStreamDescription struct { - // The name of the delivery stream. + // The Amazon Resource Name (ARN) of the delivery stream. For more information, see + // Amazon Resource Names (ARNs) and AWS Service Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). // // This member is required. - DeliveryStreamName *string + DeliveryStreamARN *string - // The destinations. + // The name of the delivery stream. // // This member is required. - Destinations []*DestinationDescription + DeliveryStreamName *string - // The Amazon Resource Name (ARN) of the delivery stream. For more information, see - // Amazon Resource Names (ARNs) and AWS Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // The status of the delivery stream. If the status of a delivery stream is + // CREATING_FAILED, this status doesn't change, and you can't invoke + // CreateDeliveryStream again on it. However, you can invoke the + // DeleteDeliveryStream () operation to delete it. // // This member is required. - DeliveryStreamARN *string + DeliveryStreamStatus DeliveryStreamStatus // The delivery stream type. This can be one of the following values: // @@ -131,6 +134,16 @@ type DeliveryStreamDescription struct { // This member is required. DeliveryStreamType DeliveryStreamType + // The destinations. + // + // This member is required. + Destinations []*DestinationDescription + + // Indicates whether there are more destinations available to list. + // + // This member is required. + HasMoreDestinations *bool + // Each time the destination is updated for a delivery stream, the version ID is // changed, and the current version ID is required when updating the destination. // This is so that the service knows it is applying the changes to the correct @@ -139,30 +152,17 @@ type DeliveryStreamDescription struct { // This member is required. VersionId *string - // The status of the delivery stream. If the status of a delivery stream is - // CREATING_FAILED, this status doesn't change, and you can't invoke - // CreateDeliveryStream again on it. However, you can invoke the - // DeleteDeliveryStream () operation to delete it. - // - // This member is required. - DeliveryStreamStatus DeliveryStreamStatus - // The date and time that the delivery stream was created. CreateTimestamp *time.Time - // Indicates whether there are more destinations available to list. - // - // This member is required. - HasMoreDestinations *bool + // Indicates the server-side encryption (SSE) status for the delivery stream. + DeliveryStreamEncryptionConfiguration *DeliveryStreamEncryptionConfiguration // Provides details in case one of the following operations fails due to an error // related to KMS: CreateDeliveryStream (), DeleteDeliveryStream (), // StartDeliveryStreamEncryption (), StopDeliveryStreamEncryption (). FailureDescription *FailureDescription - // Indicates the server-side encryption (SSE) status for the delivery stream. - DeliveryStreamEncryptionConfiguration *DeliveryStreamEncryptionConfiguration - // The date and time that the delivery stream was last updated. LastUpdateTimestamp *time.Time @@ -262,44 +262,44 @@ type Deserializer struct { // Describes the destination for a delivery stream. type DestinationDescription struct { - // The destination in Amazon Redshift. - RedshiftDestinationDescription *RedshiftDestinationDescription - // The ID of the destination. // // This member is required. DestinationId *string - // Describes the specified HTTP endpoint destination. - HttpEndpointDestinationDescription *HttpEndpointDestinationDescription - // The destination in Amazon ES. ElasticsearchDestinationDescription *ElasticsearchDestinationDescription - // The destination in Splunk. - SplunkDestinationDescription *SplunkDestinationDescription + // The destination in Amazon S3. + ExtendedS3DestinationDescription *ExtendedS3DestinationDescription + + // Describes the specified HTTP endpoint destination. + HttpEndpointDestinationDescription *HttpEndpointDestinationDescription + + // The destination in Amazon Redshift. + RedshiftDestinationDescription *RedshiftDestinationDescription // [Deprecated] The destination in Amazon S3. S3DestinationDescription *S3DestinationDescription - // The destination in Amazon S3. - ExtendedS3DestinationDescription *ExtendedS3DestinationDescription + // The destination in Splunk. + SplunkDestinationDescription *SplunkDestinationDescription } // Describes the buffering to perform before delivering data to the Amazon ES // destination. type ElasticsearchBufferingHints struct { + // Buffer incoming data for the specified period of time, in seconds, before + // delivering it to the destination. The default value is 300 (5 minutes). + IntervalInSeconds *int32 + // Buffer incoming data to the specified size, in MBs, before delivering it to the // destination. The default value is 5. We recommend setting this parameter to a // value greater than the amount of data you typically ingest into the delivery // stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the // value should be 10 MB or higher. SizeInMBs *int32 - - // Buffer incoming data for the specified period of time, in seconds, before - // delivering it to the destination. The default value is 300 (5 minutes). - IntervalInSeconds *int32 } // Describes the configuration of a destination in Amazon ES. @@ -310,9 +310,16 @@ type ElasticsearchDestinationConfiguration struct { // This member is required. IndexName *string - // The endpoint to use when communicating with the cluster. Specify either this - // ClusterEndpoint or the DomainARN field. - ClusterEndpoint *string + // The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data + // Firehose for calling the Amazon ES Configuration API and for indexing documents. + // For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 + // Destination + // (https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3) + // and Amazon Resource Names (ARNs) and AWS Service Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // + // This member is required. + RoleARN *string // The configuration for the backup Amazon S3 location. // @@ -323,32 +330,21 @@ type ElasticsearchDestinationConfiguration struct { // ElasticsearchBufferingHints are used. BufferingHints *ElasticsearchBufferingHints - // The details of the VPC of the Amazon ES destination. - VpcConfiguration *VpcConfiguration - - // The retry behavior in case Kinesis Data Firehose is unable to deliver documents - // to Amazon ES. The default value is 300 (5 minutes). - RetryOptions *ElasticsearchRetryOptions - // The Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions - // The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type - // per index. If you try to specify a new type for an existing index that already - // has another type, Kinesis Data Firehose returns an error during run time. - //

    For Elasticsearch 7.x, don't specify a TypeName.

    - TypeName *string + // The endpoint to use when communicating with the cluster. Specify either this + // ClusterEndpoint or the DomainARN field. + ClusterEndpoint *string - // The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data - // Firehose for calling the Amazon ES Configuration API and for indexing documents. - // For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 - // Destination - // (https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3) - // and Amazon Resource Names (ARNs) and AWS Service Namespaces + // The ARN of the Amazon ES domain. The IAM role must have permissions for + // DescribeElasticsearchDomain, DescribeElasticsearchDomains, and + // DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN. + // For more information, see Amazon Resource Names (ARNs) and AWS Service + // Namespaces // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). - // - // This member is required. - RoleARN *string + //

    Specify either ClusterEndpoint or DomainARN.

    + DomainARN *string // The Elasticsearch index rotation period. Index rotation appends a timestamp to // the IndexName to facilitate the expiration of old data. For more information, @@ -360,6 +356,10 @@ type ElasticsearchDestinationConfiguration struct { // The data processing configuration. ProcessingConfiguration *ProcessingConfiguration + // The retry behavior in case Kinesis Data Firehose is unable to deliver documents + // to Amazon ES. The default value is 300 (5 minutes). + RetryOptions *ElasticsearchRetryOptions + // Defines how documents should be delivered to Amazon S3. When it is set to // FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not // be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ @@ -372,54 +372,30 @@ type ElasticsearchDestinationConfiguration struct { // you create the delivery stream. S3BackupMode ElasticsearchS3BackupMode - // The ARN of the Amazon ES domain. The IAM role must have permissions for - // DescribeElasticsearchDomain, DescribeElasticsearchDomains, and - // DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN. - // For more information, see Amazon Resource Names (ARNs) and AWS Service - // Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). - //

    Specify either ClusterEndpoint or DomainARN.

    - DomainARN *string + // The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type + // per index. If you try to specify a new type for an existing index that already + // has another type, Kinesis Data Firehose returns an error during run time. + //

    For Elasticsearch 7.x, don't specify a TypeName.

    + TypeName *string + + // The details of the VPC of the Amazon ES destination. + VpcConfiguration *VpcConfiguration } // The destination description in Amazon ES. type ElasticsearchDestinationDescription struct { - // The Amazon CloudWatch logging options. - CloudWatchLoggingOptions *CloudWatchLoggingOptions - - // The Elasticsearch index name. - IndexName *string - - // The details of the VPC of the Amazon ES destination. - VpcConfigurationDescription *VpcConfigurationDescription - - // The data processing configuration. - ProcessingConfiguration *ProcessingConfiguration - // The buffering options. BufferingHints *ElasticsearchBufferingHints - // The Amazon S3 backup mode. - S3BackupMode ElasticsearchS3BackupMode - - // The Elasticsearch index rotation period - IndexRotationPeriod ElasticsearchIndexRotationPeriod + // The Amazon CloudWatch logging options. + CloudWatchLoggingOptions *CloudWatchLoggingOptions // The endpoint to use when communicating with the cluster. Kinesis Data Firehose // uses either this ClusterEndpoint or the DomainARN field to send data to Amazon // ES. ClusterEndpoint *string - // The Elasticsearch type name. This applies to Elasticsearch 6.x and lower - // versions. For Elasticsearch 7.x, there's no value for TypeName. - TypeName *string - - // The Amazon Resource Name (ARN) of the AWS credentials. For more information, see - // Amazon Resource Names (ARNs) and AWS Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). - RoleARN *string - // The ARN of the Amazon ES domain. For more information, see Amazon Resource Names // (ARNs) and AWS Service Namespaces // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). @@ -427,40 +403,50 @@ type ElasticsearchDestinationDescription struct { // DomainARN to send data to Amazon ES.

    DomainARN *string + // The Elasticsearch index name. + IndexName *string + + // The Elasticsearch index rotation period + IndexRotationPeriod ElasticsearchIndexRotationPeriod + + // The data processing configuration. + ProcessingConfiguration *ProcessingConfiguration + // The Amazon ES retry options. RetryOptions *ElasticsearchRetryOptions + // The Amazon Resource Name (ARN) of the AWS credentials. For more information, see + // Amazon Resource Names (ARNs) and AWS Service Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + RoleARN *string + + // The Amazon S3 backup mode. + S3BackupMode ElasticsearchS3BackupMode + // The Amazon S3 destination. S3DestinationDescription *S3DestinationDescription + + // The Elasticsearch type name. This applies to Elasticsearch 6.x and lower + // versions. For Elasticsearch 7.x, there's no value for TypeName. + TypeName *string + + // The details of the VPC of the Amazon ES destination. + VpcConfigurationDescription *VpcConfigurationDescription } // Describes an update for a destination in Amazon ES. type ElasticsearchDestinationUpdate struct { - // The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type - // per index. If you try to specify a new type for an existing index that already - // has another type, Kinesis Data Firehose returns an error during runtime.

    If - // you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, - // Kinesis Data Firehose still delivers data to Elasticsearch with the old index - // name and type name. If you want to update your delivery stream with a new index - // name, provide an empty string for TypeName.

    - TypeName *string - - // The endpoint to use when communicating with the cluster. Specify either this - // ClusterEndpoint or the DomainARN field. - ClusterEndpoint *string + // The buffering options. If no value is specified, ElasticsearchBufferingHints + // object default values are used. + BufferingHints *ElasticsearchBufferingHints // The CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions - // The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data - // Firehose for calling the Amazon ES Configuration API and for indexing documents. - // For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 - // Destination - // (https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3) - // and Amazon Resource Names (ARNs) and AWS Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). - RoleARN *string + // The endpoint to use when communicating with the cluster. Specify either this + // ClusterEndpoint or the DomainARN field. + ClusterEndpoint *string // The ARN of the Amazon ES domain. The IAM role must have permissions for // DescribeElasticsearchDomain, DescribeElasticsearchDomains, and @@ -471,29 +457,43 @@ type ElasticsearchDestinationUpdate struct { //

    Specify either ClusterEndpoint or DomainARN.

    DomainARN *string - // The data processing configuration. - ProcessingConfiguration *ProcessingConfiguration - - // The Amazon S3 destination. - S3Update *S3DestinationUpdate - - // The retry behavior in case Kinesis Data Firehose is unable to deliver documents - // to Amazon ES. The default value is 300 (5 minutes). - RetryOptions *ElasticsearchRetryOptions - // The Elasticsearch index name. IndexName *string - // The buffering options. If no value is specified, ElasticsearchBufferingHints - // object default values are used. - BufferingHints *ElasticsearchBufferingHints - // The Elasticsearch index rotation period. Index rotation appends a timestamp to // IndexName to facilitate the expiration of old data. For more information, see // Index Rotation for the Amazon ES Destination // (https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation). // Default value is OneDay. IndexRotationPeriod ElasticsearchIndexRotationPeriod + + // The data processing configuration. + ProcessingConfiguration *ProcessingConfiguration + + // The retry behavior in case Kinesis Data Firehose is unable to deliver documents + // to Amazon ES. The default value is 300 (5 minutes). + RetryOptions *ElasticsearchRetryOptions + + // The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data + // Firehose for calling the Amazon ES Configuration API and for indexing documents. + // For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 + // Destination + // (https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3) + // and Amazon Resource Names (ARNs) and AWS Service Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + RoleARN *string + + // The Amazon S3 destination. + S3Update *S3DestinationUpdate + + // The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type + // per index. If you try to specify a new type for an existing index that already + // has another type, Kinesis Data Firehose returns an error during runtime.

    If + // you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, + // Kinesis Data Firehose still delivers data to Elasticsearch with the old index + // name and type name. If you want to update your delivery stream with a new index + // name, provide an empty string for TypeName.

    + TypeName *string } // Configures retry behavior in case Kinesis Data Firehose is unable to deliver @@ -522,8 +522,12 @@ type EncryptionConfiguration struct { // Describes the configuration of a destination in Amazon S3. type ExtendedS3DestinationConfiguration struct { - // The configuration for backup in Amazon S3. - S3BackupConfiguration *S3DestinationConfiguration + // The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) + // and AWS Service Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // + // This member is required. + BucketARN *string // The Amazon Resource Name (ARN) of the AWS credentials. For more information, see // Amazon Resource Names (ARNs) and AWS Service Namespaces @@ -532,22 +536,29 @@ type ExtendedS3DestinationConfiguration struct { // This member is required. RoleARN *string - // The encryption configuration. If no value is specified, the default is no - // encryption. - EncryptionConfiguration *EncryptionConfiguration - - // The Amazon S3 backup mode. After you create a delivery stream, you can update it - // to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't - // update the delivery stream to disable it. - S3BackupMode S3BackupMode + // The buffering option. + BufferingHints *BufferingHints // The Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions + // The compression format. If no value is specified, the default is UNCOMPRESSED. + CompressionFormat CompressionFormat + // The serializer, deserializer, and schema for converting data from the JSON // format to the Parquet or ORC format before writing it to Amazon S3. DataFormatConversionConfiguration *DataFormatConversionConfiguration + // The encryption configuration. If no value is specified, the default is no + // encryption. + EncryptionConfiguration *EncryptionConfiguration + + // A prefix that Kinesis Data Firehose evaluates and adds to failed records before + // writing them to S3. This prefix appears immediately following the bucket name. + // For information about how to specify this prefix, see Custom Prefixes for Amazon + // S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). + ErrorOutputPrefix *string + // The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered // Amazon S3 files. You can also specify a custom prefix, as described in Custom // Prefixes for Amazon S3 Objects @@ -557,11 +568,17 @@ type ExtendedS3DestinationConfiguration struct { // The data processing configuration. ProcessingConfiguration *ProcessingConfiguration - // The buffering option. - BufferingHints *BufferingHints + // The configuration for backup in Amazon S3. + S3BackupConfiguration *S3DestinationConfiguration - // The compression format. If no value is specified, the default is UNCOMPRESSED. - CompressionFormat CompressionFormat + // The Amazon S3 backup mode. After you create a delivery stream, you can update it + // to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't + // update the delivery stream to disable it. + S3BackupMode S3BackupMode +} + +// Describes a destination in Amazon S3. +type ExtendedS3DestinationDescription struct { // The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) // and AWS Service Namespaces @@ -570,30 +587,22 @@ type ExtendedS3DestinationConfiguration struct { // This member is required. BucketARN *string - // A prefix that Kinesis Data Firehose evaluates and adds to failed records before - // writing them to S3. This prefix appears immediately following the bucket name. - // For information about how to specify this prefix, see Custom Prefixes for Amazon - // S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). - ErrorOutputPrefix *string -} - -// Describes a destination in Amazon S3. -type ExtendedS3DestinationDescription struct { - // The buffering option. // // This member is required. BufferingHints *BufferingHints + // The compression format. If no value is specified, the default is UNCOMPRESSED. + // + // This member is required. + CompressionFormat CompressionFormat + // The encryption configuration. If no value is specified, the default is no // encryption. // // This member is required. EncryptionConfiguration *EncryptionConfiguration - // The Amazon S3 backup mode. - S3BackupMode S3BackupMode - // The Amazon Resource Name (ARN) of the AWS credentials. For more information, see // Amazon Resource Names (ARNs) and AWS Service Namespaces // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). @@ -601,23 +610,24 @@ type ExtendedS3DestinationDescription struct { // This member is required. RoleARN *string + // The Amazon CloudWatch logging options for your delivery stream. + CloudWatchLoggingOptions *CloudWatchLoggingOptions + + // The serializer, deserializer, and schema for converting data from the JSON + // format to the Parquet or ORC format before writing it to Amazon S3. + DataFormatConversionConfiguration *DataFormatConversionConfiguration + // A prefix that Kinesis Data Firehose evaluates and adds to failed records before // writing them to S3. This prefix appears immediately following the bucket name. // For information about how to specify this prefix, see Custom Prefixes for Amazon // S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). ErrorOutputPrefix *string - // The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) - // and AWS Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). - // - // This member is required. - BucketARN *string - - // The compression format. If no value is specified, the default is UNCOMPRESSED. - // - // This member is required. - CompressionFormat CompressionFormat + // The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered + // Amazon S3 files. You can also specify a custom prefix, as described in Custom + // Prefixes for Amazon S3 Objects + // (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). + Prefix *string // The data processing configuration. ProcessingConfiguration *ProcessingConfiguration @@ -625,48 +635,23 @@ type ExtendedS3DestinationDescription struct { // The configuration for backup in Amazon S3. S3BackupDescription *S3DestinationDescription - // The Amazon CloudWatch logging options for your delivery stream. - CloudWatchLoggingOptions *CloudWatchLoggingOptions - - // The serializer, deserializer, and schema for converting data from the JSON - // format to the Parquet or ORC format before writing it to Amazon S3. - DataFormatConversionConfiguration *DataFormatConversionConfiguration - - // The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered - // Amazon S3 files. You can also specify a custom prefix, as described in Custom - // Prefixes for Amazon S3 Objects - // (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). - Prefix *string + // The Amazon S3 backup mode. + S3BackupMode S3BackupMode } // Describes an update for a destination in Amazon S3. type ExtendedS3DestinationUpdate struct { - // The encryption configuration. If no value is specified, the default is no - // encryption. - EncryptionConfiguration *EncryptionConfiguration - - // The buffering option. - BufferingHints *BufferingHints - - // The Amazon Resource Name (ARN) of the AWS credentials. For more information, see - // Amazon Resource Names (ARNs) and AWS Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). - RoleARN *string - - // The Amazon S3 destination for backup. - S3BackupUpdate *S3DestinationUpdate - // The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) // and AWS Service Namespaces // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). BucketARN *string - // A prefix that Kinesis Data Firehose evaluates and adds to failed records before - // writing them to S3. This prefix appears immediately following the bucket name. - // For information about how to specify this prefix, see Custom Prefixes for Amazon - // S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). - ErrorOutputPrefix *string + // The buffering option. + BufferingHints *BufferingHints + + // The Amazon CloudWatch logging options for your delivery stream. + CloudWatchLoggingOptions *CloudWatchLoggingOptions // The compression format. If no value is specified, the default is UNCOMPRESSED. CompressionFormat CompressionFormat @@ -675,8 +660,15 @@ type ExtendedS3DestinationUpdate struct { // format to the Parquet or ORC format before writing it to Amazon S3. DataFormatConversionConfiguration *DataFormatConversionConfiguration - // The data processing configuration. - ProcessingConfiguration *ProcessingConfiguration + // The encryption configuration. If no value is specified, the default is no + // encryption. + EncryptionConfiguration *EncryptionConfiguration + + // A prefix that Kinesis Data Firehose evaluates and adds to failed records before + // writing them to S3. This prefix appears immediately following the bucket name. + // For information about how to specify this prefix, see Custom Prefixes for Amazon + // S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). + ErrorOutputPrefix *string // The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered // Amazon S3 files. You can also specify a custom prefix, as described in Custom @@ -684,12 +676,20 @@ type ExtendedS3DestinationUpdate struct { // (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). Prefix *string - // The Amazon CloudWatch logging options for your delivery stream. - CloudWatchLoggingOptions *CloudWatchLoggingOptions + // The data processing configuration. + ProcessingConfiguration *ProcessingConfiguration + + // The Amazon Resource Name (ARN) of the AWS credentials. For more information, see + // Amazon Resource Names (ARNs) and AWS Service Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + RoleARN *string // You can update a delivery stream to enable Amazon S3 backup if it is disabled. // If backup is enabled, you can't update the delivery stream to disable it. S3BackupMode S3BackupMode + + // The Amazon S3 destination for backup. + S3BackupUpdate *S3DestinationUpdate } // Provides details in case one of the following operations fails due to an error @@ -697,15 +697,15 @@ type ExtendedS3DestinationUpdate struct { // StartDeliveryStreamEncryption (), StopDeliveryStreamEncryption (). type FailureDescription struct { - // The type of error that caused the failure. + // A message providing details about the error that caused the failure. // // This member is required. - Type DeliveryStreamFailureType + Details *string - // A message providing details about the error that caused the failure. + // The type of error that caused the failure. // // This member is required. - Details *string + Type DeliveryStreamFailureType } // The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for @@ -764,15 +764,15 @@ type HttpEndpointCommonAttribute struct { // delivers data. type HttpEndpointConfiguration struct { - // The access key required for Kinesis Firehose to authenticate with the HTTP - // endpoint selected as the destination. - AccessKey *string - // The URL of the HTTP endpoint selected as the destination. // // This member is required. Url *string + // The access key required for Kinesis Firehose to authenticate with the HTTP + // endpoint selected as the destination. + AccessKey *string + // The name of the HTTP endpoint selected as the destination. Name *string } @@ -790,36 +790,11 @@ type HttpEndpointDescription struct { // Describes the configuration of the HTTP endpoint destination. type HttpEndpointDestinationConfiguration struct { - // Describes a data processing configuration. - ProcessingConfiguration *ProcessingConfiguration - - // Describes the retry behavior in case Kinesis Data Firehose is unable to deliver - // data to the specified HTTP endpoint destination, or if it doesn't receive a - // valid acknowledgment of receipt from the specified HTTP endpoint destination. - RetryOptions *HttpEndpointRetryOptions - // The configuration of the HTTP endpoint selected as the destination. // // This member is required. EndpointConfiguration *HttpEndpointConfiguration - // The configuration of the requeste sent to the HTTP endpoint specified as the - // destination. - RequestConfiguration *HttpEndpointRequestConfiguration - - // Describes the S3 bucket backup options for the data that Kinesis Data Firehose - // delivers to the HTTP endpoint destination. You can back up all documents - // (AllData) or only the documents that Kinesis Data Firehose could not deliver to - // the specified HTTP endpoint destination (FailedDataOnly). - S3BackupMode HttpEndpointS3BackupMode - - // Describes the Amazon CloudWatch logging options for your delivery stream. - CloudWatchLoggingOptions *CloudWatchLoggingOptions - - // Kinesis Data Firehose uses this IAM role for all the permissions that the - // delivery stream needs. - RoleARN *string - // Describes the configuration of a destination in Amazon S3. // // This member is required. @@ -831,34 +806,35 @@ type HttpEndpointDestinationConfiguration struct { // parameters are optional. However, if you specify a value for one of them, you // must also provide a value for the other. BufferingHints *HttpEndpointBufferingHints -} -// Describes the HTTP endpoint destination. -type HttpEndpointDestinationDescription struct { + // Describes the Amazon CloudWatch logging options for your delivery stream. + CloudWatchLoggingOptions *CloudWatchLoggingOptions - // Describes a destination in Amazon S3. - S3DestinationDescription *S3DestinationDescription + // Describes a data processing configuration. + ProcessingConfiguration *ProcessingConfiguration + + // The configuration of the requeste sent to the HTTP endpoint specified as the + // destination. + RequestConfiguration *HttpEndpointRequestConfiguration // Describes the retry behavior in case Kinesis Data Firehose is unable to deliver // data to the specified HTTP endpoint destination, or if it doesn't receive a // valid acknowledgment of receipt from the specified HTTP endpoint destination. RetryOptions *HttpEndpointRetryOptions - // Describes the Amazon CloudWatch logging options for your delivery stream. - CloudWatchLoggingOptions *CloudWatchLoggingOptions - - // Describes a data processing configuration. - ProcessingConfiguration *ProcessingConfiguration - // Kinesis Data Firehose uses this IAM role for all the permissions that the // delivery stream needs. RoleARN *string - // Describes the S3 bucket backup options for the data that Kinesis Firehose + // Describes the S3 bucket backup options for the data that Kinesis Data Firehose // delivers to the HTTP endpoint destination. You can back up all documents // (AllData) or only the documents that Kinesis Data Firehose could not deliver to // the specified HTTP endpoint destination (FailedDataOnly). S3BackupMode HttpEndpointS3BackupMode +} + +// Describes the HTTP endpoint destination. +type HttpEndpointDestinationDescription struct { // Describes buffering options that can be applied to the data before it is // delivered to the HTTPS endpoint destination. Kinesis Data Firehose teats these @@ -867,22 +843,18 @@ type HttpEndpointDestinationDescription struct { // one of them, you must also provide a value for the other. BufferingHints *HttpEndpointBufferingHints - // The configuration of request sent to the HTTP endpoint specified as the - // destination. - RequestConfiguration *HttpEndpointRequestConfiguration + // Describes the Amazon CloudWatch logging options for your delivery stream. + CloudWatchLoggingOptions *CloudWatchLoggingOptions // The configuration of the specified HTTP endpoint destination. EndpointConfiguration *HttpEndpointDescription -} -// Updates the specified HTTP endpoint destination. -type HttpEndpointDestinationUpdate struct { + // Describes a data processing configuration. + ProcessingConfiguration *ProcessingConfiguration - // Describes the configuration of the HTTP endpoint destination. - EndpointConfiguration *HttpEndpointConfiguration - - // Describes a data processing configuration. - ProcessingConfiguration *ProcessingConfiguration + // The configuration of request sent to the HTTP endpoint specified as the + // destination. + RequestConfiguration *HttpEndpointRequestConfiguration // Describes the retry behavior in case Kinesis Data Firehose is unable to deliver // data to the specified HTTP endpoint destination, or if it doesn't receive a @@ -893,6 +865,19 @@ type HttpEndpointDestinationUpdate struct { // delivery stream needs. RoleARN *string + // Describes the S3 bucket backup options for the data that Kinesis Firehose + // delivers to the HTTP endpoint destination. You can back up all documents + // (AllData) or only the documents that Kinesis Data Firehose could not deliver to + // the specified HTTP endpoint destination (FailedDataOnly). + S3BackupMode HttpEndpointS3BackupMode + + // Describes a destination in Amazon S3. + S3DestinationDescription *S3DestinationDescription +} + +// Updates the specified HTTP endpoint destination. +type HttpEndpointDestinationUpdate struct { + // Describes buffering options that can be applied to the data before it is // delivered to the HTTPS endpoint destination. Kinesis Data Firehose teats these // options as hints, and it might choose to use more optimal values. The SizeInMBs @@ -900,12 +885,27 @@ type HttpEndpointDestinationUpdate struct { // one of them, you must also provide a value for the other. BufferingHints *HttpEndpointBufferingHints + // Describes the Amazon CloudWatch logging options for your delivery stream. + CloudWatchLoggingOptions *CloudWatchLoggingOptions + + // Describes the configuration of the HTTP endpoint destination. + EndpointConfiguration *HttpEndpointConfiguration + + // Describes a data processing configuration. + ProcessingConfiguration *ProcessingConfiguration + // The configuration of the request sent to the HTTP endpoint specified as the // destination. RequestConfiguration *HttpEndpointRequestConfiguration - // Describes the Amazon CloudWatch logging options for your delivery stream. - CloudWatchLoggingOptions *CloudWatchLoggingOptions + // Describes the retry behavior in case Kinesis Data Firehose is unable to deliver + // data to the specified HTTP endpoint destination, or if it doesn't receive a + // valid acknowledgment of receipt from the specified HTTP endpoint destination. + RetryOptions *HttpEndpointRetryOptions + + // Kinesis Data Firehose uses this IAM role for all the permissions that the + // delivery stream needs. + RoleARN *string // Describes the S3 bucket backup options for the data that Kinesis Firehose // delivers to the HTTP endpoint destination. You can back up all documents @@ -920,15 +920,15 @@ type HttpEndpointDestinationUpdate struct { // The configuration of the HTTP endpoint request. type HttpEndpointRequestConfiguration struct { + // Describes the metadata sent to the HTTP endpoint destination. + CommonAttributes []*HttpEndpointCommonAttribute + // Kinesis Data Firehose uses the content encoding to compress the body of a // request before sending the request to the destination. For more information, see // Content-Encoding // (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding) in // MDN Web Docs, the official Mozilla documentation. ContentEncoding ContentEncoding - - // Describes the metadata sent to the HTTP endpoint destination. - CommonAttributes []*HttpEndpointCommonAttribute } // Describes the retry behavior in case Kinesis Data Firehose is unable to deliver @@ -958,19 +958,19 @@ type InputFormatConfiguration struct { // as the source for a delivery stream. type KinesisStreamSourceConfiguration struct { - // The ARN of the role that provides access to the source Kinesis data stream. For - // more information, see AWS Identity and Access Management (IAM) ARN Format - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam). - // - // This member is required. - RoleARN *string - // The ARN of the source Kinesis data stream. For more information, see Amazon // Kinesis Data Streams ARN Format // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams). // // This member is required. KinesisStreamARN *string + + // The ARN of the role that provides access to the source Kinesis data stream. For + // more information, see AWS Identity and Access Management (IAM) ARN Format + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam). + // + // This member is required. + RoleARN *string } // Details about a Kinesis data stream used as the source for a Kinesis Data @@ -1011,16 +1011,16 @@ type KMSEncryptionConfig struct { // the native Hive / HCatalog JsonSerDe. type OpenXJsonSerDe struct { + // When set to true, which is the default, Kinesis Data Firehose converts JSON keys + // to lowercase before deserializing them. + CaseInsensitive *bool + // Maps column names to JSON keys that aren't identical to the column names. This // is useful when the JSON contains keys that are Hive keywords. For example, // timestamp is a Hive keyword. If you have a JSON key named timestamp, set this // parameter to {"ts": "timestamp"} to map this key to a column named ts. ColumnToJsonKeyMappings map[string]*string - // When set to true, which is the default, Kinesis Data Firehose converts JSON keys - // to lowercase before deserializing them. - CaseInsensitive *bool - // When set to true, specifies that the names of the keys include dots and that you // want Kinesis Data Firehose to replace them with underscores. This is useful // because Apache Hive does not allow dots in column names. For example, if the @@ -1033,10 +1033,39 @@ type OpenXJsonSerDe struct { // Amazon S3. For more information, see Apache ORC (https://orc.apache.org/docs/). type OrcSerDe struct { + // The Hadoop Distributed File System (HDFS) block size. This is useful if you + // intend to copy the data from Amazon S3 to HDFS before querying. The default is + // 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for + // padding calculations. + BlockSizeBytes *int32 + // The column names for which you want Kinesis Data Firehose to create bloom // filters. The default is null. BloomFilterColumns []*string + // The Bloom filter false positive probability (FPP). The lower the FPP, the bigger + // the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum + // is 1. + BloomFilterFalsePositiveProbability *float64 + + // The compression code to use over data blocks. The default is SNAPPY. + Compression OrcCompression + + // Represents the fraction of the total number of non-null rows. To turn off + // dictionary encoding, set this fraction to a number that is less than the number + // of distinct keys in a dictionary. To always use dictionary encoding, set this + // threshold to 1. + DictionaryKeyThreshold *float64 + + // Set this to true to indicate that you want stripes to be padded to the HDFS + // block boundaries. This is useful if you intend to copy the data from Amazon S3 + // to HDFS before querying. The default is false. + EnablePadding *bool + + // The version of the file to write. The possible values are V0_11 and V0_12. The + // default is V0_12. + FormatVersion OrcFormatVersion + // A number between 0 and 1 that defines the tolerance for block padding as a // decimal fraction of stripe size. The default value is 0.05, which means 5 // percent of stripe size. For the default values of 64 MiB ORC stripes and 256 MiB @@ -1048,18 +1077,6 @@ type OrcSerDe struct { // Firehose ignores this parameter when OrcSerDe$EnablePadding () is false. PaddingTolerance *float64 - // Represents the fraction of the total number of non-null rows. To turn off - // dictionary encoding, set this fraction to a number that is less than the number - // of distinct keys in a dictionary. To always use dictionary encoding, set this - // threshold to 1. - DictionaryKeyThreshold *float64 - - // The Hadoop Distributed File System (HDFS) block size. This is useful if you - // intend to copy the data from Amazon S3 to HDFS before querying. The default is - // 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for - // padding calculations. - BlockSizeBytes *int32 - // The number of rows between index entries. The default is 10,000 and the minimum // is 1,000. RowIndexStride *int32 @@ -1067,23 +1084,6 @@ type OrcSerDe struct { // The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 // MiB. StripeSizeBytes *int32 - - // The version of the file to write. The possible values are V0_11 and V0_12. The - // default is V0_12. - FormatVersion OrcFormatVersion - - // The compression code to use over data blocks. The default is SNAPPY. - Compression OrcCompression - - // The Bloom filter false positive probability (FPP). The lower the FPP, the bigger - // the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum - // is 1. - BloomFilterFalsePositiveProbability *float64 - - // Set this to true to indicate that you want stripes to be padded to the HDFS - // block boundaries. This is useful if you intend to copy the data from Amazon S3 - // to HDFS before querying. The default is false. - EnablePadding *bool } // Specifies the serializer that you want Kinesis Data Firehose to use to convert @@ -1101,17 +1101,24 @@ type OutputFormatConfiguration struct { // (https://parquet.apache.org/documentation/latest/). type ParquetSerDe struct { + // The Hadoop Distributed File System (HDFS) block size. This is useful if you + // intend to copy the data from Amazon S3 to HDFS before querying. The default is + // 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for + // padding calculations. + BlockSizeBytes *int32 + // The compression code to use over data blocks. The possible values are // UNCOMPRESSED, SNAPPY, and GZIP, with the default being SNAPPY. Use SNAPPY for // higher decompression speed. Use GZIP if the compression ratio is more important // than speed. Compression ParquetCompression - // The Hadoop Distributed File System (HDFS) block size. This is useful if you - // intend to copy the data from Amazon S3 to HDFS before querying. The default is - // 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for - // padding calculations. - BlockSizeBytes *int32 + // Indicates whether to enable dictionary compression. + EnableDictionaryCompression *bool + + // The maximum amount of padding to apply. This is useful if you intend to copy the + // data from Amazon S3 to HDFS before querying. The default is 0. + MaxPaddingBytes *int32 // The Parquet page size. Column chunks are divided into pages. A page is // conceptually an indivisible unit (in terms of compression and encoding). The @@ -1121,13 +1128,6 @@ type ParquetSerDe struct { // Indicates the version of row format to output. The possible values are V1 and // V2. The default is V1. WriterVersion ParquetWriterVersion - - // Indicates whether to enable dictionary compression. - EnableDictionaryCompression *bool - - // The maximum amount of padding to apply. This is useful if you intend to copy the - // data from Amazon S3 to HDFS before querying. The default is 0. - MaxPaddingBytes *int32 } // Describes a data processing configuration. @@ -1172,14 +1172,14 @@ type ProcessorParameter struct { // includes an error code and an error message. type PutRecordBatchResponseEntry struct { + // The error code for an individual record result. + ErrorCode *string + // The error message for an individual record result. ErrorMessage *string // The ID of the record. RecordId *string - - // The error code for an individual record result. - ErrorCode *string } // The unit of data in a delivery stream. @@ -1195,20 +1195,20 @@ type Record struct { // Describes the configuration of a destination in Amazon Redshift. type RedshiftDestinationConfiguration struct { - // The configuration for the intermediate Amazon S3 location from which Amazon - // Redshift obtains data. Restrictions are described in the topic for - // CreateDeliveryStream (). The compression formats SNAPPY or ZIP cannot be - // specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon - // Redshift COPY operation that reads from the S3 bucket doesn't support these - // compression formats. + // The database connection string. // // This member is required. - S3Configuration *S3DestinationConfiguration + ClusterJDBCURL *string - // The name of the user. + // The COPY command. // // This member is required. - Username *string + CopyCommand *CopyCommand + + // The user password. + // + // This member is required. + Password *string // The Amazon Resource Name (ARN) of the AWS credentials. For more information, see // Amazon Resource Names (ARNs) and AWS Service Namespaces @@ -1217,26 +1217,23 @@ type RedshiftDestinationConfiguration struct { // This member is required. RoleARN *string - // The configuration for backup in Amazon S3. - S3BackupConfiguration *S3DestinationConfiguration - - // The CloudWatch logging options for your delivery stream. - CloudWatchLoggingOptions *CloudWatchLoggingOptions - - // The database connection string. + // The configuration for the intermediate Amazon S3 location from which Amazon + // Redshift obtains data. Restrictions are described in the topic for + // CreateDeliveryStream (). The compression formats SNAPPY or ZIP cannot be + // specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon + // Redshift COPY operation that reads from the S3 bucket doesn't support these + // compression formats. // // This member is required. - ClusterJDBCURL *string + S3Configuration *S3DestinationConfiguration - // The user password. + // The name of the user. // // This member is required. - Password *string + Username *string - // The Amazon S3 backup mode. After you create a delivery stream, you can update it - // to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't - // update the delivery stream to disable it. - S3BackupMode RedshiftS3BackupMode + // The CloudWatch logging options for your delivery stream. + CloudWatchLoggingOptions *CloudWatchLoggingOptions // The data processing configuration. ProcessingConfiguration *ProcessingConfiguration @@ -1245,17 +1242,27 @@ type RedshiftDestinationConfiguration struct { // to Amazon Redshift. Default value is 3600 (60 minutes). RetryOptions *RedshiftRetryOptions - // The COPY command. - // - // This member is required. - CopyCommand *CopyCommand + // The configuration for backup in Amazon S3. + S3BackupConfiguration *S3DestinationConfiguration + + // The Amazon S3 backup mode. After you create a delivery stream, you can update it + // to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't + // update the delivery stream to disable it. + S3BackupMode RedshiftS3BackupMode } // Describes a destination in Amazon Redshift. type RedshiftDestinationDescription struct { - // The Amazon S3 backup mode. - S3BackupMode RedshiftS3BackupMode + // The database connection string. + // + // This member is required. + ClusterJDBCURL *string + + // The COPY command. + // + // This member is required. + CopyCommand *CopyCommand // The Amazon Resource Name (ARN) of the AWS credentials. For more information, see // Amazon Resource Names (ARNs) and AWS Service Namespaces @@ -1269,77 +1276,70 @@ type RedshiftDestinationDescription struct { // This member is required. S3DestinationDescription *S3DestinationDescription - // The retry behavior in case Kinesis Data Firehose is unable to deliver documents - // to Amazon Redshift. Default value is 3600 (60 minutes). - RetryOptions *RedshiftRetryOptions - - // The COPY command. + // The name of the user. // // This member is required. - CopyCommand *CopyCommand - - // The data processing configuration. - ProcessingConfiguration *ProcessingConfiguration + Username *string // The Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions - // The name of the user. - // - // This member is required. - Username *string + // The data processing configuration. + ProcessingConfiguration *ProcessingConfiguration - // The database connection string. - // - // This member is required. - ClusterJDBCURL *string + // The retry behavior in case Kinesis Data Firehose is unable to deliver documents + // to Amazon Redshift. Default value is 3600 (60 minutes). + RetryOptions *RedshiftRetryOptions // The configuration for backup in Amazon S3. S3BackupDescription *S3DestinationDescription + + // The Amazon S3 backup mode. + S3BackupMode RedshiftS3BackupMode } // Describes an update for a destination in Amazon Redshift. type RedshiftDestinationUpdate struct { - // The Amazon S3 destination for backup. - S3BackupUpdate *S3DestinationUpdate + // The Amazon CloudWatch logging options for your delivery stream. + CloudWatchLoggingOptions *CloudWatchLoggingOptions + + // The database connection string. + ClusterJDBCURL *string // The COPY command. CopyCommand *CopyCommand - // The retry behavior in case Kinesis Data Firehose is unable to deliver documents - // to Amazon Redshift. Default value is 3600 (60 minutes). - RetryOptions *RedshiftRetryOptions + // The user password. + Password *string // The data processing configuration. ProcessingConfiguration *ProcessingConfiguration - // The name of the user. - Username *string - - // The Amazon S3 destination. The compression formats SNAPPY or ZIP cannot be - // specified in RedshiftDestinationUpdate.S3Update because the Amazon Redshift COPY - // operation that reads from the S3 bucket doesn't support these compression - // formats. - S3Update *S3DestinationUpdate - - // The user password. - Password *string + // The retry behavior in case Kinesis Data Firehose is unable to deliver documents + // to Amazon Redshift. Default value is 3600 (60 minutes). + RetryOptions *RedshiftRetryOptions // The Amazon Resource Name (ARN) of the AWS credentials. For more information, see // Amazon Resource Names (ARNs) and AWS Service Namespaces // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). RoleARN *string - // The Amazon CloudWatch logging options for your delivery stream. - CloudWatchLoggingOptions *CloudWatchLoggingOptions - - // The database connection string. - ClusterJDBCURL *string - // You can update a delivery stream to enable Amazon S3 backup if it is disabled. // If backup is enabled, you can't update the delivery stream to disable it. S3BackupMode RedshiftS3BackupMode + + // The Amazon S3 destination for backup. + S3BackupUpdate *S3DestinationUpdate + + // The Amazon S3 destination. The compression formats SNAPPY or ZIP cannot be + // specified in RedshiftDestinationUpdate.S3Update because the Amazon Redshift COPY + // operation that reads from the S3 bucket doesn't support these compression + // formats. + S3Update *S3DestinationUpdate + + // The name of the user. + Username *string } // Configures retry behavior in case Kinesis Data Firehose is unable to deliver @@ -1357,62 +1357,53 @@ type RedshiftRetryOptions struct { // Describes the configuration of a destination in Amazon S3. type S3DestinationConfiguration struct { - // The compression format. If no value is specified, the default is UNCOMPRESSED. - // The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift - // destinations because they are not supported by the Amazon Redshift COPY - // operation that reads from the S3 bucket. - CompressionFormat CompressionFormat + // The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) + // and AWS Service Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // + // This member is required. + BucketARN *string - // The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered - // Amazon S3 files. You can also specify a custom prefix, as described in Custom - // Prefixes for Amazon S3 Objects - // (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). - Prefix *string + // The Amazon Resource Name (ARN) of the AWS credentials. For more information, see + // Amazon Resource Names (ARNs) and AWS Service Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // + // This member is required. + RoleARN *string // The buffering option. If no value is specified, BufferingHints object default // values are used. BufferingHints *BufferingHints + // The CloudWatch logging options for your delivery stream. + CloudWatchLoggingOptions *CloudWatchLoggingOptions + + // The compression format. If no value is specified, the default is UNCOMPRESSED. + // The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift + // destinations because they are not supported by the Amazon Redshift COPY + // operation that reads from the S3 bucket. + CompressionFormat CompressionFormat + // The encryption configuration. If no value is specified, the default is no // encryption. EncryptionConfiguration *EncryptionConfiguration - // The Amazon Resource Name (ARN) of the AWS credentials. For more information, see - // Amazon Resource Names (ARNs) and AWS Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). - // - // This member is required. - RoleARN *string - // A prefix that Kinesis Data Firehose evaluates and adds to failed records before // writing them to S3. This prefix appears immediately following the bucket name. // For information about how to specify this prefix, see Custom Prefixes for Amazon // S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). ErrorOutputPrefix *string - // The CloudWatch logging options for your delivery stream. - CloudWatchLoggingOptions *CloudWatchLoggingOptions - - // The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) - // and AWS Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). - // - // This member is required. - BucketARN *string + // The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered + // Amazon S3 files. You can also specify a custom prefix, as described in Custom + // Prefixes for Amazon S3 Objects + // (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). + Prefix *string } // Describes a destination in Amazon S3. type S3DestinationDescription struct { - // The Amazon CloudWatch logging options for your delivery stream. - CloudWatchLoggingOptions *CloudWatchLoggingOptions - - // A prefix that Kinesis Data Firehose evaluates and adds to failed records before - // writing them to S3. This prefix appears immediately following the bucket name. - // For information about how to specify this prefix, see Custom Prefixes for Amazon - // S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). - ErrorOutputPrefix *string - // The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) // and AWS Service Namespaces // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). @@ -1420,11 +1411,23 @@ type S3DestinationDescription struct { // This member is required. BucketARN *string + // The buffering option. If no value is specified, BufferingHints object default + // values are used. + // + // This member is required. + BufferingHints *BufferingHints + // The compression format. If no value is specified, the default is UNCOMPRESSED. // // This member is required. CompressionFormat CompressionFormat + // The encryption configuration. If no value is specified, the default is no + // encryption. + // + // This member is required. + EncryptionConfiguration *EncryptionConfiguration + // The Amazon Resource Name (ARN) of the AWS credentials. For more information, see // Amazon Resource Names (ARNs) and AWS Service Namespaces // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). @@ -1432,51 +1435,36 @@ type S3DestinationDescription struct { // This member is required. RoleARN *string + // The Amazon CloudWatch logging options for your delivery stream. + CloudWatchLoggingOptions *CloudWatchLoggingOptions + + // A prefix that Kinesis Data Firehose evaluates and adds to failed records before + // writing them to S3. This prefix appears immediately following the bucket name. + // For information about how to specify this prefix, see Custom Prefixes for Amazon + // S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). + ErrorOutputPrefix *string + // The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered // Amazon S3 files. You can also specify a custom prefix, as described in Custom // Prefixes for Amazon S3 Objects // (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). Prefix *string - - // The buffering option. If no value is specified, BufferingHints object default - // values are used. - // - // This member is required. - BufferingHints *BufferingHints - - // The encryption configuration. If no value is specified, the default is no - // encryption. - // - // This member is required. - EncryptionConfiguration *EncryptionConfiguration } // Describes an update for a destination in Amazon S3. type S3DestinationUpdate struct { - // The encryption configuration. If no value is specified, the default is no - // encryption. - EncryptionConfiguration *EncryptionConfiguration - - // The buffering option. If no value is specified, BufferingHints object default - // values are used. - BufferingHints *BufferingHints - - // The Amazon Resource Name (ARN) of the AWS credentials. For more information, see - // Amazon Resource Names (ARNs) and AWS Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). - RoleARN *string - // The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) // and AWS Service Namespaces // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). BucketARN *string - // A prefix that Kinesis Data Firehose evaluates and adds to failed records before - // writing them to S3. This prefix appears immediately following the bucket name. - // For information about how to specify this prefix, see Custom Prefixes for Amazon - // S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). - ErrorOutputPrefix *string + // The buffering option. If no value is specified, BufferingHints object default + // values are used. + BufferingHints *BufferingHints + + // The CloudWatch logging options for your delivery stream. + CloudWatchLoggingOptions *CloudWatchLoggingOptions // The compression format. If no value is specified, the default is UNCOMPRESSED. // The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift @@ -1484,14 +1472,26 @@ type S3DestinationUpdate struct { // operation that reads from the S3 bucket. CompressionFormat CompressionFormat - // The CloudWatch logging options for your delivery stream. - CloudWatchLoggingOptions *CloudWatchLoggingOptions + // The encryption configuration. If no value is specified, the default is no + // encryption. + EncryptionConfiguration *EncryptionConfiguration + + // A prefix that Kinesis Data Firehose evaluates and adds to failed records before + // writing them to S3. This prefix appears immediately following the bucket name. + // For information about how to specify this prefix, see Custom Prefixes for Amazon + // S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). + ErrorOutputPrefix *string // The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered // Amazon S3 files. You can also specify a custom prefix, as described in Custom // Prefixes for Amazon S3 Objects // (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). Prefix *string + + // The Amazon Resource Name (ARN) of the AWS credentials. For more information, see + // Amazon Resource Names (ARNs) and AWS Service Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + RoleARN *string } // Specifies the schema to which you want Kinesis Data Firehose to configure your @@ -1499,10 +1499,17 @@ type S3DestinationUpdate struct { // set to true. type SchemaConfiguration struct { + // The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account + // ID is used by default. + CatalogId *string + // Specifies the name of the AWS Glue database that contains the schema for the // output data. DatabaseName *string + // If you don't specify an AWS Region, the default is the current Region. + Region *string + // The role that Kinesis Data Firehose can use to access AWS Glue. This role must // be in the same account you use for Kinesis Data Firehose. Cross-account roles // aren't allowed. @@ -1512,13 +1519,6 @@ type SchemaConfiguration struct { // constitutes your data schema. TableName *string - // If you don't specify an AWS Region, the default is the current Region. - Region *string - - // The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account - // ID is used by default. - CatalogId *string - // Specifies the table version for the output data schema. If you don't specify // this version ID, or if you set it to LATEST, Kinesis Data Firehose uses the most // recent version. This means that any updates to the table are automatically @@ -1555,11 +1555,16 @@ type SourceDescription struct { // Describes the configuration of a destination in Splunk. type SplunkDestinationConfiguration struct { - // The amount of time that Kinesis Data Firehose waits to receive an acknowledgment - // from Splunk after it sends it data. At the end of the timeout period, Kinesis - // Data Firehose either tries to send the data again or considers it an error, - // based on your retry settings. - HECAcknowledgmentTimeoutInSeconds *int32 + // The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends + // your data. + // + // This member is required. + HECEndpoint *string + + // This type can be either "Raw" or "Event." + // + // This member is required. + HECEndpointType HECEndpointType // This is a GUID that you obtain from your Splunk cluster when you create a new // HEC endpoint. @@ -1567,18 +1572,27 @@ type SplunkDestinationConfiguration struct { // This member is required. HECToken *string - // The retry behavior in case Kinesis Data Firehose is unable to deliver data to - // Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk. - RetryOptions *SplunkRetryOptions - - // This type can be either "Raw" or "Event." + // The configuration for the backup Amazon S3 location. // // This member is required. - HECEndpointType HECEndpointType + S3Configuration *S3DestinationConfiguration + + // The Amazon CloudWatch logging options for your delivery stream. + CloudWatchLoggingOptions *CloudWatchLoggingOptions + + // The amount of time that Kinesis Data Firehose waits to receive an acknowledgment + // from Splunk after it sends it data. At the end of the timeout period, Kinesis + // Data Firehose either tries to send the data again or considers it an error, + // based on your retry settings. + HECAcknowledgmentTimeoutInSeconds *int32 // The data processing configuration. ProcessingConfiguration *ProcessingConfiguration + // The retry behavior in case Kinesis Data Firehose is unable to deliver data to + // Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk. + RetryOptions *SplunkRetryOptions + // Defines how documents should be delivered to Amazon S3. When set to // FailedEventsOnly, Kinesis Data Firehose writes any data that could not be // indexed to the configured Amazon S3 destination. When set to AllEvents, Kinesis @@ -1587,57 +1601,43 @@ type SplunkDestinationConfiguration struct { // this backup mode from FailedEventsOnly to AllEvents. You can't update it from // AllEvents to FailedEventsOnly. S3BackupMode SplunkS3BackupMode +} + +// Describes a destination in Splunk. +type SplunkDestinationDescription struct { // The Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions - // The configuration for the backup Amazon S3 location. - // - // This member is required. - S3Configuration *S3DestinationConfiguration + // The amount of time that Kinesis Data Firehose waits to receive an acknowledgment + // from Splunk after it sends it data. At the end of the timeout period, Kinesis + // Data Firehose either tries to send the data again or considers it an error, + // based on your retry settings. + HECAcknowledgmentTimeoutInSeconds *int32 // The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends // your data. - // - // This member is required. HECEndpoint *string -} - -// Describes a destination in Splunk. -type SplunkDestinationDescription struct { - - // Defines how documents should be delivered to Amazon S3. When set to - // FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be - // indexed to the configured Amazon S3 destination. When set to AllDocuments, - // Kinesis Data Firehose delivers all incoming records to Amazon S3, and also - // writes failed documents to Amazon S3. Default value is FailedDocumentsOnly. - S3BackupMode SplunkS3BackupMode - - // A GUID you obtain from your Splunk cluster when you create a new HEC endpoint. - HECToken *string - - // The retry behavior in case Kinesis Data Firehose is unable to deliver data to - // Splunk or if it doesn't receive an acknowledgment of receipt from Splunk. - RetryOptions *SplunkRetryOptions // This type can be either "Raw" or "Event." HECEndpointType HECEndpointType - // The amount of time that Kinesis Data Firehose waits to receive an acknowledgment - // from Splunk after it sends it data. At the end of the timeout period, Kinesis - // Data Firehose either tries to send the data again or considers it an error, - // based on your retry settings. - HECAcknowledgmentTimeoutInSeconds *int32 + // A GUID you obtain from your Splunk cluster when you create a new HEC endpoint. + HECToken *string // The data processing configuration. ProcessingConfiguration *ProcessingConfiguration - // The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends - // your data. - HECEndpoint *string + // The retry behavior in case Kinesis Data Firehose is unable to deliver data to + // Splunk or if it doesn't receive an acknowledgment of receipt from Splunk. + RetryOptions *SplunkRetryOptions - // The Amazon CloudWatch logging options for your delivery stream. - CloudWatchLoggingOptions *CloudWatchLoggingOptions + // Defines how documents should be delivered to Amazon S3. When set to + // FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be + // indexed to the configured Amazon S3 destination. When set to AllDocuments, + // Kinesis Data Firehose delivers all incoming records to Amazon S3, and also + // writes failed documents to Amazon S3. Default value is FailedDocumentsOnly. + S3BackupMode SplunkS3BackupMode // The Amazon S3 destination.> S3DestinationDescription *S3DestinationDescription @@ -1649,32 +1649,29 @@ type SplunkDestinationUpdate struct { // The Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions + // The amount of time that Kinesis Data Firehose waits to receive an acknowledgment + // from Splunk after it sends data. At the end of the timeout period, Kinesis Data + // Firehose either tries to send the data again or considers it an error, based on + // your retry settings. + HECAcknowledgmentTimeoutInSeconds *int32 + // The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends // your data. HECEndpoint *string - // The data processing configuration. - ProcessingConfiguration *ProcessingConfiguration - // This type can be either "Raw" or "Event." HECEndpointType HECEndpointType - // The retry behavior in case Kinesis Data Firehose is unable to deliver data to - // Splunk or if it doesn't receive an acknowledgment of receipt from Splunk. - RetryOptions *SplunkRetryOptions - - // The amount of time that Kinesis Data Firehose waits to receive an acknowledgment - // from Splunk after it sends data. At the end of the timeout period, Kinesis Data - // Firehose either tries to send the data again or considers it an error, based on - // your retry settings. - HECAcknowledgmentTimeoutInSeconds *int32 - // A GUID that you obtain from your Splunk cluster when you create a new HEC // endpoint. HECToken *string - // Your update to the configuration of the backup Amazon S3 location. - S3Update *S3DestinationUpdate + // The data processing configuration. + ProcessingConfiguration *ProcessingConfiguration + + // The retry behavior in case Kinesis Data Firehose is unable to deliver data to + // Splunk or if it doesn't receive an acknowledgment of receipt from Splunk. + RetryOptions *SplunkRetryOptions // Specifies how you want Kinesis Data Firehose to back up documents to Amazon S3. // When set to FailedDocumentsOnly, Kinesis Data Firehose writes any data that @@ -1684,6 +1681,9 @@ type SplunkDestinationUpdate struct { // FailedEventsOnly. You can update this backup mode from FailedEventsOnly to // AllEvents. You can't update it from AllEvents to FailedEventsOnly. S3BackupMode SplunkS3BackupMode + + // Your update to the configuration of the backup Amazon S3 location. + S3Update *S3DestinationUpdate } // Configures retry behavior in case Kinesis Data Firehose is unable to deliver @@ -1701,54 +1701,21 @@ type SplunkRetryOptions struct { // pair. type Tag struct { - // An optional string, which you can use to describe or define the tag. Maximum - // length: 256 characters. Valid characters: Unicode letters, digits, white space, - // _ . / = + - % @ - Value *string - // A unique identifier for the tag. Maximum length: 128 characters. Valid // characters: Unicode letters, digits, white space, _ . / = + - % @ // // This member is required. Key *string + + // An optional string, which you can use to describe or define the tag. Maximum + // length: 256 characters. Valid characters: Unicode letters, digits, white space, + // _ . / = + - % @ + Value *string } // The details of the VPC of the Amazon ES destination. type VpcConfiguration struct { - // The IDs of the security groups that you want Kinesis Data Firehose to use when - // it creates ENIs in the VPC of the Amazon ES destination. You can use the same - // security group that the Amazon ES domain uses or different ones. If you specify - // different security groups here, ensure that they allow outbound HTTPS traffic to - // the Amazon ES domain's security group. Also ensure that the Amazon ES domain's - // security group allows HTTPS traffic from the security groups specified here. If - // you use the same security group for both your delivery stream and the Amazon ES - // domain, make sure the security group inbound rule allows HTTPS traffic. For more - // information about security group rules, see Security group rules - // (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#SecurityGroupRules) - // in the Amazon VPC documentation. - // - // This member is required. - SecurityGroupIds []*string - - // The IDs of the subnets that you want Kinesis Data Firehose to use to create ENIs - // in the VPC of the Amazon ES destination. Make sure that the routing tables and - // inbound and outbound rules allow traffic to flow from the subnets whose IDs are - // specified here to the subnets that have the destination Amazon ES endpoints. - // Kinesis Data Firehose creates at least one ENI in each of the subnets that are - // specified here. Do not delete or modify these ENIs. The number of ENIs that - // Kinesis Data Firehose creates in the subnets specified here scales up and down - // automatically based on throughput. To enable Kinesis Data Firehose to scale up - // the number of ENIs to match throughput, ensure that you have sufficient quota. - // To help you calculate the quota you need, assume that Kinesis Data Firehose can - // create up to three ENIs for this delivery stream for each of the subnets - // specified here. For more information about ENI quota, see Network Interfaces - // (https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-enis) - // in the Amazon VPC Quotas topic. - // - // This member is required. - SubnetIds []*string - // The ARN of the IAM role that you want the delivery stream to use to create // endpoints in the destination VPC. You can use your existing Kinesis Data // Firehose delivery role or you can specify a new role. In either case, make sure @@ -1781,43 +1748,43 @@ type VpcConfiguration struct { // // This member is required. RoleARN *string -} -// The details of the VPC of the Amazon ES destination. -type VpcConfigurationDescription struct { + // The IDs of the security groups that you want Kinesis Data Firehose to use when + // it creates ENIs in the VPC of the Amazon ES destination. You can use the same + // security group that the Amazon ES domain uses or different ones. If you specify + // different security groups here, ensure that they allow outbound HTTPS traffic to + // the Amazon ES domain's security group. Also ensure that the Amazon ES domain's + // security group allows HTTPS traffic from the security groups specified here. If + // you use the same security group for both your delivery stream and the Amazon ES + // domain, make sure the security group inbound rule allows HTTPS traffic. For more + // information about security group rules, see Security group rules + // (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#SecurityGroupRules) + // in the Amazon VPC documentation. + // + // This member is required. + SecurityGroupIds []*string - // The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the VPC - // of the Amazon ES destination. Make sure that the routing tables and inbound and - // outbound rules allow traffic to flow from the subnets whose IDs are specified - // here to the subnets that have the destination Amazon ES endpoints. Kinesis Data - // Firehose creates at least one ENI in each of the subnets that are specified - // here. Do not delete or modify these ENIs. The number of ENIs that Kinesis Data - // Firehose creates in the subnets specified here scales up and down automatically - // based on throughput. To enable Kinesis Data Firehose to scale up the number of - // ENIs to match throughput, ensure that you have sufficient quota. To help you - // calculate the quota you need, assume that Kinesis Data Firehose can create up to - // three ENIs for this delivery stream for each of the subnets specified here. For - // more information about ENI quota, see Network Interfaces + // The IDs of the subnets that you want Kinesis Data Firehose to use to create ENIs + // in the VPC of the Amazon ES destination. Make sure that the routing tables and + // inbound and outbound rules allow traffic to flow from the subnets whose IDs are + // specified here to the subnets that have the destination Amazon ES endpoints. + // Kinesis Data Firehose creates at least one ENI in each of the subnets that are + // specified here. Do not delete or modify these ENIs. The number of ENIs that + // Kinesis Data Firehose creates in the subnets specified here scales up and down + // automatically based on throughput. To enable Kinesis Data Firehose to scale up + // the number of ENIs to match throughput, ensure that you have sufficient quota. + // To help you calculate the quota you need, assume that Kinesis Data Firehose can + // create up to three ENIs for this delivery stream for each of the subnets + // specified here. For more information about ENI quota, see Network Interfaces // (https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-enis) // in the Amazon VPC Quotas topic. // // This member is required. SubnetIds []*string +} - // The IDs of the security groups that Kinesis Data Firehose uses when it creates - // ENIs in the VPC of the Amazon ES destination. You can use the same security - // group that the Amazon ES domain uses or different ones. If you specify different - // security groups, ensure that they allow outbound HTTPS traffic to the Amazon ES - // domain's security group. Also ensure that the Amazon ES domain's security group - // allows HTTPS traffic from the security groups specified here. If you use the - // same security group for both your delivery stream and the Amazon ES domain, make - // sure the security group inbound rule allows HTTPS traffic. For more information - // about security group rules, see Security group rules - // (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#SecurityGroupRules) - // in the Amazon VPC documentation. - // - // This member is required. - SecurityGroupIds []*string +// The details of the VPC of the Amazon ES destination. +type VpcConfigurationDescription struct { // The ARN of the IAM role that the delivery stream uses to create endpoints in the // destination VPC. You can use your existing Kinesis Data Firehose delivery role @@ -1852,6 +1819,39 @@ type VpcConfigurationDescription struct { // This member is required. RoleARN *string + // The IDs of the security groups that Kinesis Data Firehose uses when it creates + // ENIs in the VPC of the Amazon ES destination. You can use the same security + // group that the Amazon ES domain uses or different ones. If you specify different + // security groups, ensure that they allow outbound HTTPS traffic to the Amazon ES + // domain's security group. Also ensure that the Amazon ES domain's security group + // allows HTTPS traffic from the security groups specified here. If you use the + // same security group for both your delivery stream and the Amazon ES domain, make + // sure the security group inbound rule allows HTTPS traffic. For more information + // about security group rules, see Security group rules + // (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#SecurityGroupRules) + // in the Amazon VPC documentation. + // + // This member is required. + SecurityGroupIds []*string + + // The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the VPC + // of the Amazon ES destination. Make sure that the routing tables and inbound and + // outbound rules allow traffic to flow from the subnets whose IDs are specified + // here to the subnets that have the destination Amazon ES endpoints. Kinesis Data + // Firehose creates at least one ENI in each of the subnets that are specified + // here. Do not delete or modify these ENIs. The number of ENIs that Kinesis Data + // Firehose creates in the subnets specified here scales up and down automatically + // based on throughput. To enable Kinesis Data Firehose to scale up the number of + // ENIs to match throughput, ensure that you have sufficient quota. To help you + // calculate the quota you need, assume that Kinesis Data Firehose can create up to + // three ENIs for this delivery stream for each of the subnets specified here. For + // more information about ENI quota, see Network Interfaces + // (https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-enis) + // in the Amazon VPC Quotas topic. + // + // This member is required. + SubnetIds []*string + // The ID of the Amazon ES destination's VPC. // // This member is required. diff --git a/service/fms/api_op_DeletePolicy.go b/service/fms/api_op_DeletePolicy.go index a72f62dbd76..1f9c52facf1 100644 --- a/service/fms/api_op_DeletePolicy.go +++ b/service/fms/api_op_DeletePolicy.go @@ -56,6 +56,12 @@ func (c *Client) DeletePolicy(ctx context.Context, params *DeletePolicyInput, op type DeletePolicyInput struct { + // The ID of the policy that you want to delete. You can retrieve this ID from + // PutPolicy and ListPolicies. + // + // This member is required. + PolicyId *string + // If True, the request performs cleanup according to the policy type. For AWS WAF // and Shield Advanced policies, the cleanup does the following: // @@ -86,12 +92,6 @@ type DeletePolicyInput struct { // accounts and resources are handled by the policy. All others are out of scope. // If you don't specify tags or accounts, all resources are in scope. DeleteAllPolicyResources *bool - - // The ID of the policy that you want to delete. You can retrieve this ID from - // PutPolicy and ListPolicies. - // - // This member is required. - PolicyId *string } type DeletePolicyOutput struct { diff --git a/service/fms/api_op_GetComplianceDetail.go b/service/fms/api_op_GetComplianceDetail.go index 086048ab0ae..a1a132bc1e8 100644 --- a/service/fms/api_op_GetComplianceDetail.go +++ b/service/fms/api_op_GetComplianceDetail.go @@ -63,16 +63,16 @@ func (c *Client) GetComplianceDetail(ctx context.Context, params *GetComplianceD type GetComplianceDetailInput struct { - // The ID of the policy that you want to get the details for. PolicyId is returned - // by PutPolicy and by ListPolicies. + // The AWS account that owns the resources that you want to get the details for. // // This member is required. - PolicyId *string + MemberAccount *string - // The AWS account that owns the resources that you want to get the details for. + // The ID of the policy that you want to get the details for. PolicyId is returned + // by PutPolicy and by ListPolicies. // // This member is required. - MemberAccount *string + PolicyId *string } type GetComplianceDetailOutput struct { diff --git a/service/fms/api_op_GetNotificationChannel.go b/service/fms/api_op_GetNotificationChannel.go index dc7aa6a56ff..3f54a1a9390 100644 --- a/service/fms/api_op_GetNotificationChannel.go +++ b/service/fms/api_op_GetNotificationChannel.go @@ -59,12 +59,12 @@ type GetNotificationChannelInput struct { type GetNotificationChannelOutput struct { - // The SNS topic that records AWS Firewall Manager activity. - SnsTopicArn *string - // The IAM role that is used by AWS Firewall Manager to record activity to SNS. SnsRoleName *string + // The SNS topic that records AWS Firewall Manager activity. + SnsTopicArn *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/fms/api_op_GetProtectionStatus.go b/service/fms/api_op_GetProtectionStatus.go index 814c9d5b67f..9ec0cc66a23 100644 --- a/service/fms/api_op_GetProtectionStatus.go +++ b/service/fms/api_op_GetProtectionStatus.go @@ -60,11 +60,10 @@ func (c *Client) GetProtectionStatus(ctx context.Context, params *GetProtectionS type GetProtectionStatusInput struct { - // Specifies the number of objects that you want AWS Firewall Manager to return for - // this request. If you have more objects than the number that you specify for - // MaxResults, the response includes a NextToken value that you can use to get - // another batch of objects. - MaxResults *int32 + // The ID of the policy for which you want to get the attack information. + // + // This member is required. + PolicyId *string // The end of the time period to query for the attacks. This is a timestamp type. // The request syntax listing indicates a number type because the default used by @@ -72,21 +71,16 @@ type GetProtectionStatusInput struct { // format is allowed. EndTime *time.Time + // Specifies the number of objects that you want AWS Firewall Manager to return for + // this request. If you have more objects than the number that you specify for + // MaxResults, the response includes a NextToken value that you can use to get + // another batch of objects. + MaxResults *int32 + // The AWS account that is in scope of the policy that you want to get the details // for. MemberAccountId *string - // The ID of the policy for which you want to get the attack information. - // - // This member is required. - PolicyId *string - - // The start of the time period to query for the attacks. This is a timestamp type. - // The request syntax listing indicates a number type because the default used by - // AWS Firewall Manager is Unix time in seconds. However, any valid timestamp - // format is allowed. - StartTime *time.Time - // If you specify a value for MaxResults and you have more objects than the number // that you specify for MaxResults, AWS Firewall Manager returns a NextToken value // in the response, which you can use to retrieve another group of objects. For the @@ -94,20 +88,16 @@ type GetProtectionStatusInput struct { // NextToken from the previous response to get information about another batch of // objects. NextToken *string + + // The start of the time period to query for the attacks. This is a timestamp type. + // The request syntax listing indicates a number type because the default used by + // AWS Firewall Manager is Unix time in seconds. However, any valid timestamp + // format is allowed. + StartTime *time.Time } type GetProtectionStatusOutput struct { - // If you have more objects than the number that you specified for MaxResults in - // the request, the response includes a NextToken value. To list more objects, - // submit another GetProtectionStatus request, and specify the NextToken value from - // the response in the NextToken value in the next request. AWS SDKs provide - // auto-pagination that identify NextToken in a response and make subsequent - // request calls automatically on your behalf. However, this feature is not - // supported by GetProtectionStatus. You must submit subsequent requests with - // NextToken using your own processes. - NextToken *string - // The ID of the AWS Firewall administrator account for this policy. AdminAccountId *string @@ -129,6 +119,16 @@ type GetProtectionStatusOutput struct { // details are in JSON format. Data *string + // If you have more objects than the number that you specified for MaxResults in + // the request, the response includes a NextToken value. To list more objects, + // submit another GetProtectionStatus request, and specify the NextToken value from + // the response in the NextToken value in the next request. AWS SDKs provide + // auto-pagination that identify NextToken in a response and make subsequent + // request calls automatically on your behalf. However, this feature is not + // supported by GetProtectionStatus. You must submit subsequent requests with + // NextToken using your own processes. + NextToken *string + // The service type that is protected by the policy. Currently, this is always // SHIELD_ADVANCED. ServiceType types.SecurityServiceType diff --git a/service/fms/api_op_GetViolationDetails.go b/service/fms/api_op_GetViolationDetails.go index 43e4f5d900f..326be77ecab 100644 --- a/service/fms/api_op_GetViolationDetails.go +++ b/service/fms/api_op_GetViolationDetails.go @@ -58,10 +58,10 @@ func (c *Client) GetViolationDetails(ctx context.Context, params *GetViolationDe type GetViolationDetailsInput struct { - // The ID of the resource that has violations. + // The AWS account ID that you want the details for. // // This member is required. - ResourceId *string + MemberAccount *string // The ID of the AWS Firewall Manager policy that you want the details for. This // currently only supports security group content audit policies. @@ -69,10 +69,10 @@ type GetViolationDetailsInput struct { // This member is required. PolicyId *string - // The AWS account ID that you want the details for. + // The ID of the resource that has violations. // // This member is required. - MemberAccount *string + ResourceId *string // The resource type. This is in the format shown in the AWS Resource Types // Reference diff --git a/service/fms/api_op_ListAppsLists.go b/service/fms/api_op_ListAppsLists.go index b2bf3d99ed2..38deb383514 100644 --- a/service/fms/api_op_ListAppsLists.go +++ b/service/fms/api_op_ListAppsLists.go @@ -57,16 +57,6 @@ func (c *Client) ListAppsLists(ctx context.Context, params *ListAppsListsInput, type ListAppsListsInput struct { - // If you specify a value for MaxResults in your list request, and you have more - // objects than the maximum, AWS Firewall Manager returns this token in the - // response. For all but the first request, you provide the token returned by the - // prior request in the request parameters, to retrieve the next batch of objects. - NextToken *string - - // Specifies whether the lists to retrieve are default lists owned by AWS Firewall - // Manager. - DefaultLists *bool - // The maximum number of objects that you want AWS Firewall Manager to return for // this request. If more objects are available, in the response, AWS Firewall // Manager provides a NextToken value that you can use in a subsequent call to get @@ -75,6 +65,16 @@ type ListAppsListsInput struct { // // This member is required. MaxResults *int32 + + // Specifies whether the lists to retrieve are default lists owned by AWS Firewall + // Manager. + DefaultLists *bool + + // If you specify a value for MaxResults in your list request, and you have more + // objects than the maximum, AWS Firewall Manager returns this token in the + // response. For all but the first request, you provide the token returned by the + // prior request in the request parameters, to retrieve the next batch of objects. + NextToken *string } type ListAppsListsOutput struct { diff --git a/service/fms/api_op_ListComplianceStatus.go b/service/fms/api_op_ListComplianceStatus.go index 780fac62dea..a8abb18877e 100644 --- a/service/fms/api_op_ListComplianceStatus.go +++ b/service/fms/api_op_ListComplianceStatus.go @@ -63,6 +63,13 @@ type ListComplianceStatusInput struct { // This member is required. PolicyId *string + // Specifies the number of PolicyComplianceStatus objects that you want AWS + // Firewall Manager to return for this request. If you have more + // PolicyComplianceStatus objects than the number that you specify for MaxResults, + // the response includes a NextToken value that you can use to get another batch of + // PolicyComplianceStatus objects. + MaxResults *int32 + // If you specify a value for MaxResults and you have more PolicyComplianceStatus // objects than the number that you specify for MaxResults, AWS Firewall Manager // returns a NextToken value in the response that allows you to list another group @@ -71,13 +78,6 @@ type ListComplianceStatusInput struct { // response to get information about another batch of PolicyComplianceStatus // objects. NextToken *string - - // Specifies the number of PolicyComplianceStatus objects that you want AWS - // Firewall Manager to return for this request. If you have more - // PolicyComplianceStatus objects than the number that you specify for MaxResults, - // the response includes a NextToken value that you can use to get another batch of - // PolicyComplianceStatus objects. - MaxResults *int32 } type ListComplianceStatusOutput struct { diff --git a/service/fms/api_op_ListMemberAccounts.go b/service/fms/api_op_ListMemberAccounts.go index 212df875d57..ccce9bfb36e 100644 --- a/service/fms/api_op_ListMemberAccounts.go +++ b/service/fms/api_op_ListMemberAccounts.go @@ -74,15 +74,15 @@ type ListMemberAccountsInput struct { type ListMemberAccountsOutput struct { + // An array of account IDs. + MemberAccounts []*string + // If you have more member account IDs than the number that you specified for // MaxResults in the request, the response includes a NextToken value. To list more // IDs, submit another ListMemberAccounts request, and specify the NextToken value // from the response in the NextToken value in the next request. NextToken *string - // An array of account IDs. - MemberAccounts []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/fms/api_op_ListPolicies.go b/service/fms/api_op_ListPolicies.go index 16be11eb166..e50a8f5aed1 100644 --- a/service/fms/api_op_ListPolicies.go +++ b/service/fms/api_op_ListPolicies.go @@ -73,15 +73,15 @@ type ListPoliciesInput struct { type ListPoliciesOutput struct { - // An array of PolicySummary objects. - PolicyList []*types.PolicySummary - // If you have more PolicySummary objects than the number that you specified for // MaxResults in the request, the response includes a NextToken value. To list more // PolicySummary objects, submit another ListPolicies request, and specify the // NextToken value from the response in the NextToken value in the next request. NextToken *string + // An array of PolicySummary objects. + PolicyList []*types.PolicySummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/fms/api_op_ListProtocolsLists.go b/service/fms/api_op_ListProtocolsLists.go index 5a2d0b0be0a..0d3dbf4e6cd 100644 --- a/service/fms/api_op_ListProtocolsLists.go +++ b/service/fms/api_op_ListProtocolsLists.go @@ -79,15 +79,15 @@ type ListProtocolsListsInput struct { type ListProtocolsListsOutput struct { - // An array of ProtocolsListDataSummary objects. - ProtocolsLists []*types.ProtocolsListDataSummary - // If you specify a value for MaxResults in your list request, and you have more // objects than the maximum, AWS Firewall Manager returns this token in the // response. You can use this token in subsequent requests to retrieve the next // batch of objects. NextToken *string + // An array of ProtocolsListDataSummary objects. + ProtocolsLists []*types.ProtocolsListDataSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/fms/api_op_PutNotificationChannel.go b/service/fms/api_op_PutNotificationChannel.go index 79ea8647a1e..249d8a0408a 100644 --- a/service/fms/api_op_PutNotificationChannel.go +++ b/service/fms/api_op_PutNotificationChannel.go @@ -57,17 +57,17 @@ func (c *Client) PutNotificationChannel(ctx context.Context, params *PutNotifica type PutNotificationChannelInput struct { - // The Amazon Resource Name (ARN) of the SNS topic that collects notifications from - // AWS Firewall Manager. - // - // This member is required. - SnsTopicArn *string - // The Amazon Resource Name (ARN) of the IAM role that allows Amazon SNS to record // AWS Firewall Manager activity. // // This member is required. SnsRoleName *string + + // The Amazon Resource Name (ARN) of the SNS topic that collects notifications from + // AWS Firewall Manager. + // + // This member is required. + SnsTopicArn *string } type PutNotificationChannelOutput struct { diff --git a/service/fms/api_op_PutProtocolsList.go b/service/fms/api_op_PutProtocolsList.go index 2062378ff93..2c3aed7b6fc 100644 --- a/service/fms/api_op_PutProtocolsList.go +++ b/service/fms/api_op_PutProtocolsList.go @@ -68,12 +68,12 @@ type PutProtocolsListInput struct { type PutProtocolsListOutput struct { - // The Amazon Resource Name (ARN) of the protocols list. - ProtocolsListArn *string - // The details of the AWS Firewall Manager protocols list. ProtocolsList *types.ProtocolsListData + // The Amazon Resource Name (ARN) of the protocols list. + ProtocolsListArn *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/fms/api_op_TagResource.go b/service/fms/api_op_TagResource.go index 52b75513a27..7fd47f04385 100644 --- a/service/fms/api_op_TagResource.go +++ b/service/fms/api_op_TagResource.go @@ -57,17 +57,17 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The tags to add to the resource. - // - // This member is required. - TagList []*types.Tag - // The Amazon Resource Name (ARN) of the resource to return tags for. The AWS // Firewall Manager resources that support tagging are policies, applications // lists, and protocols lists. // // This member is required. ResourceArn *string + + // The tags to add to the resource. + // + // This member is required. + TagList []*types.Tag } type TagResourceOutput struct { diff --git a/service/fms/go.mod b/service/fms/go.mod index 02cd68af166..287e6132823 100644 --- a/service/fms/go.mod +++ b/service/fms/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/fms go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/fms/types/types.go b/service/fms/types/types.go index a388fd1c146..c7619519cca 100644 --- a/service/fms/types/types.go +++ b/service/fms/types/types.go @@ -9,13 +9,6 @@ import ( // An individual AWS Firewall Manager application. type App struct { - // The IP protocol name or number. The name can be one of tcp, udp, or icmp. For - // information on possible numbers, see Protocol Numbers - // (https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). - // - // This member is required. - Protocol *string - // The application's name. // // This member is required. @@ -25,53 +18,60 @@ type App struct { // // This member is required. Port *int64 + + // The IP protocol name or number. The name can be one of tcp, udp, or icmp. For + // information on possible numbers, see Protocol Numbers + // (https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). + // + // This member is required. + Protocol *string } // An AWS Firewall Manager applications list. type AppsListData struct { - // A map of previous version numbers to their corresponding App object arrays. - PreviousAppsList map[string][]*App - // An array of applications in the AWS Firewall Manager applications list. // // This member is required. AppsList []*App - // A unique identifier for each update to the list. When you update the list, the - // update token must match the token of the current version of the application - // list. You can retrieve the update token by getting the list. - ListUpdateToken *string - // The name of the AWS Firewall Manager applications list. // // This member is required. ListName *string + // The time that the AWS Firewall Manager applications list was created. + CreateTime *time.Time + // The time that the AWS Firewall Manager applications list was last updated. LastUpdateTime *time.Time // The ID of the AWS Firewall Manager applications list. ListId *string - // The time that the AWS Firewall Manager applications list was created. - CreateTime *time.Time + // A unique identifier for each update to the list. When you update the list, the + // update token must match the token of the current version of the application + // list. You can retrieve the update token by getting the list. + ListUpdateToken *string + + // A map of previous version numbers to their corresponding App object arrays. + PreviousAppsList map[string][]*App } // Details of the AWS Firewall Manager applications list. type AppsListDataSummary struct { - // The name of the applications list. - ListName *string - - // The ID of the applications list. - ListId *string + // An array of App objects in the AWS Firewall Manager applications list. + AppsList []*App // The Amazon Resource Name (ARN) of the applications list. ListArn *string - // An array of App objects in the AWS Firewall Manager applications list. - AppsList []*App + // The ID of the applications list. + ListId *string + + // The name of the applications list. + ListName *string } // Violations for an EC2 instance resource. @@ -99,26 +99,23 @@ type AwsEc2NetworkInterfaceViolation struct { // security group of the AWS Firewall Manager policy. type AwsVPCSecurityGroupViolation struct { - // A description of the security group that violates the policy. - ViolationTargetDescription *string - // List of rules specified in the security group of the AWS Firewall Manager policy // that partially match the ViolationTarget rule. PartialMatches []*PartialMatch + // Remediation options for the rule specified in the ViolationTarget. + PossibleSecurityGroupRemediationActions []*SecurityGroupRemediationAction + // The security group rule that is being evaluated. ViolationTarget *string - // Remediation options for the rule specified in the ViolationTarget. - PossibleSecurityGroupRemediationActions []*SecurityGroupRemediationAction + // A description of the security group that violates the policy. + ViolationTargetDescription *string } // Details of the resource that is not protected by the policy. type ComplianceViolator struct { - // The reason that the resource is not protected by the policy. - ViolationReason ViolationReason - // The resource ID. ResourceId *string @@ -128,6 +125,9 @@ type ComplianceViolator struct { // For example: AWS::ElasticLoadBalancingV2::LoadBalancer or // AWS::CloudFront::Distribution. ResourceType *string + + // The reason that the resource is not protected by the policy. + ViolationReason ViolationReason } // Describes the compliance status for the account. An account is considered @@ -138,88 +138,49 @@ type EvaluationResult struct { // Describes an AWS account's compliance with the AWS Firewall Manager policy. ComplianceStatus PolicyComplianceStatusType + // Indicates that over 100 resources are noncompliant with the AWS Firewall Manager + // policy. + EvaluationLimitExceeded *bool + // The number of resources that are noncompliant with the specified policy. For AWS // WAF and Shield Advanced policies, a resource is considered noncompliant if it is // not associated with the policy. For security group policies, a resource is // considered noncompliant if it doesn't comply with the rules of the policy and // remediation is disabled or not possible. ViolatorCount *int64 - - // Indicates that over 100 resources are noncompliant with the AWS Firewall Manager - // policy. - EvaluationLimitExceeded *bool } // The reference rule that partially matches the ViolationTarget rule and violation // reason. type PartialMatch struct { - // The violation reason. - TargetViolationReasons []*string - // The reference rule from the master security group of the AWS Firewall Manager // policy. Reference *string + + // The violation reason. + TargetViolationReasons []*string } // An AWS Firewall Manager policy. type Policy struct { - // A unique identifier for each update to the policy. When issuing a PutPolicy - // request, the PolicyUpdateToken in the request must match the PolicyUpdateToken - // of the current policy version. To get the PolicyUpdateToken of the current - // policy version, use a GetPolicy request. - PolicyUpdateToken *string - - // Specifies the AWS account IDs and AWS Organizations organizational units (OUs) - // to include in the policy. Specifying an OU is the equivalent of specifying all - // accounts in the OU and in any of its child OUs, including any child OUs and - // accounts that are added at a later time. You can specify inclusions or - // exclusions, but not both. If you specify an IncludeMap, AWS Firewall Manager - // applies the policy to all accounts specified by the IncludeMap, and does not - // evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, - // then Firewall Manager applies the policy to all accounts except for those - // specified by the ExcludeMap. You can specify account IDs, OUs, or a - // combination: - // - // * Specify account IDs by setting the key to ACCOUNT. For - // example, the following is a valid map: {“ACCOUNT” : [“accountID1”, - // “accountID2”]}. - // - // * Specify OUs by setting the key to ORG_UNIT. For example, - // the following is a valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}. + // If set to True, resources with the tags that are specified in the ResourceTag + // array are not in scope of the policy. If set to False, and the ResourceTag array + // is not null, only resources with the specified tags are in scope of the policy. // - // * - // Specify accounts and OUs together in a single map, separated with a comma. For - // example, the following is a valid map: {“ACCOUNT” : [“accountID1”, - // “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}. - IncludeMap map[string][]*string + // This member is required. + ExcludeResourceTags *bool // The name of the AWS Firewall Manager policy. // // This member is required. PolicyName *string - // An array of ResourceType. - ResourceTypeList []*string - - // Details about the security service that is being used to protect the resources. - // - // This member is required. - SecurityServicePolicyData *SecurityServicePolicyData - - // If set to True, resources with the tags that are specified in the ResourceTag - // array are not in scope of the policy. If set to False, and the ResourceTag array - // is not null, only resources with the specified tags are in scope of the policy. + // Indicates if the policy should be automatically applied to new resources. // // This member is required. - ExcludeResourceTags *bool - - // The ID of the AWS Firewall Manager policy. - PolicyId *string - - // An array of ResourceTag objects. - ResourceTags []*ResourceTag + RemediationEnabled *bool // The type of resource protected by or in scope of the policy. This is in the // format shown in the AWS Resource Types Reference @@ -234,6 +195,11 @@ type Policy struct { // This member is required. ResourceType *string + // Details about the security service that is being used to protect the resources. + // + // This member is required. + SecurityServicePolicyData *SecurityServicePolicyData + // Specifies the AWS account IDs and AWS Organizations organizational units (OUs) // to exclude from the policy. Specifying an OU is the equivalent of specifying all // accounts in the OU and in any of its child OUs, including any child OUs and @@ -258,10 +224,44 @@ type Policy struct { // “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}. ExcludeMap map[string][]*string - // Indicates if the policy should be automatically applied to new resources. + // Specifies the AWS account IDs and AWS Organizations organizational units (OUs) + // to include in the policy. Specifying an OU is the equivalent of specifying all + // accounts in the OU and in any of its child OUs, including any child OUs and + // accounts that are added at a later time. You can specify inclusions or + // exclusions, but not both. If you specify an IncludeMap, AWS Firewall Manager + // applies the policy to all accounts specified by the IncludeMap, and does not + // evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, + // then Firewall Manager applies the policy to all accounts except for those + // specified by the ExcludeMap. You can specify account IDs, OUs, or a + // combination: // - // This member is required. - RemediationEnabled *bool + // * Specify account IDs by setting the key to ACCOUNT. For + // example, the following is a valid map: {“ACCOUNT” : [“accountID1”, + // “accountID2”]}. + // + // * Specify OUs by setting the key to ORG_UNIT. For example, + // the following is a valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}. + // + // * + // Specify accounts and OUs together in a single map, separated with a comma. For + // example, the following is a valid map: {“ACCOUNT” : [“accountID1”, + // “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}. + IncludeMap map[string][]*string + + // The ID of the AWS Firewall Manager policy. + PolicyId *string + + // A unique identifier for each update to the policy. When issuing a PutPolicy + // request, the PolicyUpdateToken in the request must match the PolicyUpdateToken + // of the current policy version. To get the PolicyUpdateToken of the current + // policy version, use a GetPolicy request. + PolicyUpdateToken *string + + // An array of ResourceTag objects. + ResourceTags []*ResourceTag + + // An array of ResourceType. + ResourceTypeList []*string } // Describes the noncompliant resources in a member account for a specific AWS @@ -269,32 +269,32 @@ type Policy struct { // 100 resources are noncompliant, EvaluationLimitExceeded is set to True. type PolicyComplianceDetail struct { - // The AWS account ID. - MemberAccount *string - - // An array of resources that aren't protected by the AWS WAF or Shield Advanced - // policy or that aren't in compliance with the security group policy. - Violators []*ComplianceViolator + // Indicates if over 100 resources are noncompliant with the AWS Firewall Manager + // policy. + EvaluationLimitExceeded *bool // A timestamp that indicates when the returned information should be considered // out of date. ExpiredAt *time.Time - // The ID of the AWS Firewall Manager policy. - PolicyId *string - // Details about problems with dependent services, such as AWS WAF or AWS Config, // that are causing a resource to be noncompliant. The details include the name of // the dependent service and the error message received that indicates the problem // with the service. IssueInfoMap map[string]*string - // Indicates if over 100 resources are noncompliant with the AWS Firewall Manager - // policy. - EvaluationLimitExceeded *bool + // The AWS account ID. + MemberAccount *string + + // The ID of the AWS Firewall Manager policy. + PolicyId *string // The AWS account that created the AWS Firewall Manager policy. PolicyOwner *string + + // An array of resources that aren't protected by the AWS WAF or Shield Advanced + // policy or that aren't in compliance with the security group policy. + Violators []*ComplianceViolator } // Indicates whether the account is compliant with the specified policy. An account @@ -303,27 +303,27 @@ type PolicyComplianceDetail struct { // with the policy, for security group policies. type PolicyComplianceStatus struct { - // The member account ID. - MemberAccount *string - - // Timestamp of the last update to the EvaluationResult objects. - LastUpdated *time.Time - // An array of EvaluationResult objects. EvaluationResults []*EvaluationResult - // The name of the AWS Firewall Manager policy. - PolicyName *string - // Details about problems with dependent services, such as AWS WAF or AWS Config, // that are causing a resource to be noncompliant. The details include the name of // the dependent service and the error message received that indicates the problem // with the service. IssueInfoMap map[string]*string + // Timestamp of the last update to the EvaluationResult objects. + LastUpdated *time.Time + + // The member account ID. + MemberAccount *string + // The ID of the AWS Firewall Manager policy. PolicyId *string + // The name of the AWS Firewall Manager policy. + PolicyName *string + // The AWS account that created the AWS Firewall Manager policy. PolicyOwner *string } @@ -331,20 +331,18 @@ type PolicyComplianceStatus struct { // Details of the AWS Firewall Manager policy. type PolicySummary struct { + // The Amazon Resource Name (ARN) of the specified policy. + PolicyArn *string + // The ID of the specified policy. PolicyId *string + // The name of the specified policy. + PolicyName *string + // Indicates if the policy should be automatically applied to new resources. RemediationEnabled *bool - // The service that the policy is using to protect the resources. This specifies - // the type of policy that is created, either an AWS WAF policy, a Shield Advanced - // policy, or a security group policy. - SecurityServiceType SecurityServiceType - - // The Amazon Resource Name (ARN) of the specified policy. - PolicyArn *string - // The type of resource protected by or in scope of the policy. This is in the // format shown in the AWS Resource Types Reference // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html). @@ -356,47 +354,46 @@ type PolicySummary struct { // a security group usage audit policy, the value is AWS::EC2::SecurityGroup. ResourceType *string - // The name of the specified policy. - PolicyName *string + // The service that the policy is using to protect the resources. This specifies + // the type of policy that is created, either an AWS WAF policy, a Shield Advanced + // policy, or a security group policy. + SecurityServiceType SecurityServiceType } // An AWS Firewall Manager protocols list. type ProtocolsListData struct { - // A map of previous version numbers to their corresponding protocol arrays. - PreviousProtocolsList map[string][]*string + // The name of the AWS Firewall Manager protocols list. + // + // This member is required. + ListName *string // An array of protocols in the AWS Firewall Manager protocols list. // // This member is required. ProtocolsList []*string - // A unique identifier for each update to the list. When you update the list, the - // update token must match the token of the current version of the application - // list. You can retrieve the update token by getting the list. - ListUpdateToken *string - // The time that the AWS Firewall Manager protocols list was created. CreateTime *time.Time + // The time that the AWS Firewall Manager protocols list was last updated. + LastUpdateTime *time.Time + // The ID of the AWS Firewall Manager protocols list. ListId *string - // The time that the AWS Firewall Manager protocols list was last updated. - LastUpdateTime *time.Time + // A unique identifier for each update to the list. When you update the list, the + // update token must match the token of the current version of the application + // list. You can retrieve the update token by getting the list. + ListUpdateToken *string - // The name of the AWS Firewall Manager protocols list. - // - // This member is required. - ListName *string + // A map of previous version numbers to their corresponding protocol arrays. + PreviousProtocolsList map[string][]*string } // Details of the AWS Firewall Manager protocols list. type ProtocolsListDataSummary struct { - // An array of protocols in the AWS Firewall Manager protocols list. - ProtocolsList []*string - // The Amazon Resource Name (ARN) of the specified protocols list. ListArn *string @@ -405,6 +402,9 @@ type ProtocolsListDataSummary struct { // The name of the specified protocols list. ListName *string + + // An array of protocols in the AWS Firewall Manager protocols list. + ProtocolsList []*string } // The resource tags that AWS Firewall Manager uses to determine if a particular @@ -417,13 +417,13 @@ type ProtocolsListDataSummary struct { // (https://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/tag-editor.html). type ResourceTag struct { - // The resource tag value. - Value *string - // The resource tag key. // // This member is required. Key *string + + // The resource tag value. + Value *string } // Violation detail based on resource type. @@ -432,28 +432,28 @@ type ResourceViolation struct { // Violation details for an EC2 instance. AwsEc2InstanceViolation *AwsEc2InstanceViolation - // Violation details for security groups. - AwsVPCSecurityGroupViolation *AwsVPCSecurityGroupViolation - // Violation details for network interface. AwsEc2NetworkInterfaceViolation *AwsEc2NetworkInterfaceViolation + + // Violation details for security groups. + AwsVPCSecurityGroupViolation *AwsVPCSecurityGroupViolation } // Remediation option for the rule specified in the ViolationTarget. type SecurityGroupRemediationAction struct { - // The remediation action that will be performed. - RemediationActionType RemediationActionType - // Brief description of the action that will be performed. Description *string + // Indicates if the current action is the default action. + IsDefaultAction *bool + + // The remediation action that will be performed. + RemediationActionType RemediationActionType + // The final state of the rule specified in the ViolationTarget after it is // remediated. RemediationResult *SecurityGroupRuleDescription - - // Indicates if the current action is the default action. - IsDefaultAction *bool } // Describes a set of permissions for a security group rule. @@ -463,21 +463,21 @@ type SecurityGroupRuleDescription struct { // type number. A value of -1 indicates all ICMP/ICMPv6 types. FromPort *int64 - // The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. - // A value of -1 indicates all ICMP/ICMPv6 codes. - ToPort *int64 - - // The ID of the prefix list for the security group rule. - PrefixListId *string + // The IPv4 ranges for the security group rule. + IPV4Range *string // The IPv6 ranges for the security group rule. IPV6Range *string + // The ID of the prefix list for the security group rule. + PrefixListId *string + // The IP protocol name (tcp, udp, icmp, icmpv6) or number. Protocol *string - // The IPv4 ranges for the security group rule. - IPV4Range *string + // The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. + // A value of -1 indicates all ICMP/ICMPv6 codes. + ToPort *int64 } // Details about the security service that is being used to protect the resources. @@ -553,35 +553,35 @@ type Tag struct { // AWS account. type ViolationDetail struct { - // The resource type that the violation details were requested for. - // - // This member is required. - ResourceType *string - - // The ResourceTag objects associated with the resource. - ResourceTags []*Tag - // The AWS account that the violation details were requested for. // // This member is required. MemberAccount *string - // List of violations for the requested resource. + // The ID of the AWS Firewall Manager policy that the violation details were + // requested for. // // This member is required. - ResourceViolations []*ResourceViolation - - // Brief description for the requested resource. - ResourceDescription *string + PolicyId *string // The resource ID that the violation details were requested for. // // This member is required. ResourceId *string - // The ID of the AWS Firewall Manager policy that the violation details were - // requested for. + // The resource type that the violation details were requested for. // // This member is required. - PolicyId *string + ResourceType *string + + // List of violations for the requested resource. + // + // This member is required. + ResourceViolations []*ResourceViolation + + // Brief description for the requested resource. + ResourceDescription *string + + // The ResourceTag objects associated with the resource. + ResourceTags []*Tag } diff --git a/service/forecast/api_op_CreateDataset.go b/service/forecast/api_op_CreateDataset.go index bf14013fd9d..4d1c8f00dbd 100644 --- a/service/forecast/api_op_CreateDataset.go +++ b/service/forecast/api_op_CreateDataset.go @@ -81,42 +81,15 @@ func (c *Client) CreateDataset(ctx context.Context, params *CreateDatasetInput, type CreateDatasetInput struct { - // The optional metadata that you apply to the dataset to help you categorize and - // organize them. Each tag consists of a key and an optional value, both of which - // you define. The following basic restrictions apply to tags: - // - // * Maximum - // number of tags per resource - 50. - // - // * For each resource, each tag key must be - // unique, and each tag key can have only one value. - // - // * Maximum key length - - // 128 Unicode characters in UTF-8. - // - // * Maximum value length - 256 Unicode - // characters in UTF-8. - // - // * If your tagging schema is used across multiple - // services and resources, remember that other services may have restrictions on - // allowed characters. Generally allowed characters are: letters, numbers, and - // spaces representable in UTF-8, and the following characters: + - = . _ : / @. - // - // - // * Tag keys and values are case sensitive. + // A name for the dataset. // - // * Do not use aws:, AWS:, or any - // upper or lowercase combination of such as a prefix for keys as it is reserved - // for AWS use. You cannot edit or delete tag keys with this prefix. Values can - // have this prefix. If a tag value has aws as its prefix but the key does not, - // then Forecast considers it to be a user tag and will count against the limit of - // 50 tags. Tags with only the key prefix of aws do not count against your tags per - // resource limit. - Tags []*types.Tag + // This member is required. + DatasetName *string - // An AWS Key Management Service (KMS) key and the AWS Identity and Access - // Management (IAM) role that Amazon Forecast can assume to access the key. - EncryptionConfig *types.EncryptionConfig + // The dataset type. Valid values depend on the chosen Domain. + // + // This member is required. + DatasetType types.DatasetType // The domain associated with the dataset. When you add a dataset to a dataset // group, this value and the value specified for the Domain parameter of the @@ -130,11 +103,6 @@ type CreateDatasetInput struct { // This member is required. Domain types.Domain - // A name for the dataset. - // - // This member is required. - DatasetName *string - // The schema for the dataset. The schema attributes and their order must match the // fields in your data. The dataset Domain and DatasetType that you choose // determine the minimum required fields in your training data. For information @@ -151,10 +119,42 @@ type CreateDatasetInput struct { // "15min" indicates every 15 minutes. DataFrequency *string - // The dataset type. Valid values depend on the chosen Domain. + // An AWS Key Management Service (KMS) key and the AWS Identity and Access + // Management (IAM) role that Amazon Forecast can assume to access the key. + EncryptionConfig *types.EncryptionConfig + + // The optional metadata that you apply to the dataset to help you categorize and + // organize them. Each tag consists of a key and an optional value, both of which + // you define. The following basic restrictions apply to tags: // - // This member is required. - DatasetType types.DatasetType + // * Maximum + // number of tags per resource - 50. + // + // * For each resource, each tag key must be + // unique, and each tag key can have only one value. + // + // * Maximum key length - + // 128 Unicode characters in UTF-8. + // + // * Maximum value length - 256 Unicode + // characters in UTF-8. + // + // * If your tagging schema is used across multiple + // services and resources, remember that other services may have restrictions on + // allowed characters. Generally allowed characters are: letters, numbers, and + // spaces representable in UTF-8, and the following characters: + - = . _ : / @. + // + // + // * Tag keys and values are case sensitive. + // + // * Do not use aws:, AWS:, or any + // upper or lowercase combination of such as a prefix for keys as it is reserved + // for AWS use. You cannot edit or delete tag keys with this prefix. Values can + // have this prefix. If a tag value has aws as its prefix but the key does not, + // then Forecast considers it to be a user tag and will count against the limit of + // 50 tags. Tags with only the key prefix of aws do not count against your tags per + // resource limit. + Tags []*types.Tag } type CreateDatasetOutput struct { diff --git a/service/forecast/api_op_CreateDatasetGroup.go b/service/forecast/api_op_CreateDatasetGroup.go index 8ff0ab26810..1d948aa6a3b 100644 --- a/service/forecast/api_op_CreateDatasetGroup.go +++ b/service/forecast/api_op_CreateDatasetGroup.go @@ -69,6 +69,22 @@ type CreateDatasetGroupInput struct { // This member is required. DatasetGroupName *string + // The domain associated with the dataset group. When you add a dataset to a + // dataset group, this value and the value specified for the Domain parameter of + // the CreateDataset () operation must match. The Domain and DatasetType that you + // choose determine the fields that must be present in training data that you + // import to a dataset. For example, if you choose the RETAIL domain and + // TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires that item_id, + // timestamp, and demand fields are present in your data. For more information, see + // howitworks-datasets-groups (). + // + // This member is required. + Domain types.Domain + + // An array of Amazon Resource Names (ARNs) of the datasets that you want to + // include in the dataset group. + DatasetArns []*string + // The optional metadata that you apply to the dataset group to help you categorize // and organize them. Each tag consists of a key and an optional value, both of // which you define. The following basic restrictions apply to tags: @@ -101,22 +117,6 @@ type CreateDatasetGroupInput struct { // 50 tags. Tags with only the key prefix of aws do not count against your tags per // resource limit. Tags []*types.Tag - - // The domain associated with the dataset group. When you add a dataset to a - // dataset group, this value and the value specified for the Domain parameter of - // the CreateDataset () operation must match. The Domain and DatasetType that you - // choose determine the fields that must be present in training data that you - // import to a dataset. For example, if you choose the RETAIL domain and - // TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires that item_id, - // timestamp, and demand fields are present in your data. For more information, see - // howitworks-datasets-groups (). - // - // This member is required. - Domain types.Domain - - // An array of Amazon Resource Names (ARNs) of the datasets that you want to - // include in the dataset group. - DatasetArns []*string } type CreateDatasetGroupOutput struct { diff --git a/service/forecast/api_op_CreateForecastExportJob.go b/service/forecast/api_op_CreateForecastExportJob.go index 126d1c1f9e0..a06da461313 100644 --- a/service/forecast/api_op_CreateForecastExportJob.go +++ b/service/forecast/api_op_CreateForecastExportJob.go @@ -67,24 +67,24 @@ func (c *Client) CreateForecastExportJob(ctx context.Context, params *CreateFore type CreateForecastExportJobInput struct { - // The name for the forecast export job. + // The location where you want to save the forecast and an AWS Identity and Access + // Management (IAM) role that Amazon Forecast can assume to access the location. + // The forecast must be exported to an Amazon S3 bucket. If encryption is used, + // Destination must include an AWS Key Management Service (KMS) key. The IAM role + // must allow Amazon Forecast permission to access the key. // // This member is required. - ForecastExportJobName *string + Destination *types.DataDestination // The Amazon Resource Name (ARN) of the forecast that you want to export. // // This member is required. ForecastArn *string - // The location where you want to save the forecast and an AWS Identity and Access - // Management (IAM) role that Amazon Forecast can assume to access the location. - // The forecast must be exported to an Amazon S3 bucket. If encryption is used, - // Destination must include an AWS Key Management Service (KMS) key. The IAM role - // must allow Amazon Forecast permission to access the key. + // The name for the forecast export job. // // This member is required. - Destination *types.DataDestination + ForecastExportJobName *string // The optional metadata that you apply to the forecast export job to help you // categorize and organize them. Each tag consists of a key and an optional value, diff --git a/service/forecast/api_op_CreatePredictor.go b/service/forecast/api_op_CreatePredictor.go index 179d20315dc..5b6eca3dcd7 100644 --- a/service/forecast/api_op_CreatePredictor.go +++ b/service/forecast/api_op_CreatePredictor.go @@ -93,11 +93,67 @@ func (c *Client) CreatePredictor(ctx context.Context, params *CreatePredictorInp type CreatePredictorInput struct { + // The featurization configuration. + // + // This member is required. + FeaturizationConfig *types.FeaturizationConfig + + // Specifies the number of time-steps that the model is trained to predict. The + // forecast horizon is also called the prediction length. For example, if you + // configure a dataset for daily data collection (using the DataFrequency parameter + // of the CreateDataset () operation) and set the forecast horizon to 10, the model + // returns predictions for 10 days. The maximum forecast horizon is the lesser of + // 500 time-steps or 1/3 of the TARGET_TIME_SERIES dataset length. + // + // This member is required. + ForecastHorizon *int32 + + // Describes the dataset group that contains the data to use to train the + // predictor. + // + // This member is required. + InputDataConfig *types.InputDataConfig + // A name for the predictor. // // This member is required. PredictorName *string + // The Amazon Resource Name (ARN) of the algorithm to use for model training. + // Required if PerformAutoML is not set to true. Supported algorithms: + // + // * + // arn:aws:forecast:::algorithm/ARIMA + // + // * + // arn:aws:forecast:::algorithm/Deep_AR_Plus Supports hyperparameter optimization + // (HPO) + // + // * arn:aws:forecast:::algorithm/ETS + // + // * + // arn:aws:forecast:::algorithm/NPTS + // + // * arn:aws:forecast:::algorithm/Prophet + AlgorithmArn *string + + // An AWS Key Management Service (KMS) key and the AWS Identity and Access + // Management (IAM) role that Amazon Forecast can assume to access the key. + EncryptionConfig *types.EncryptionConfig + + // Used to override the default evaluation parameters of the specified algorithm. + // Amazon Forecast evaluates a predictor by splitting a dataset into training data + // and testing data. The evaluation parameters define how to perform the split and + // the number of iterations. + EvaluationParameters *types.EvaluationParameters + + // Provides hyperparameter override values for the algorithm. If you don't provide + // this parameter, Amazon Forecast uses default values. The individual algorithms + // specify which hyperparameters support hyperparameter optimization (HPO). For + // more information, see aws-forecast-choosing-recipes (). If you included the + // HPOConfig object, you must set PerformHPO to true. + HPOConfig *types.HyperParameterTuningJobConfig + // Whether to perform AutoML. When Amazon Forecast performs AutoML, it evaluates // the algorithms it provides and chooses the best algorithm and configuration for // your training dataset. The default value is false. In this case, you are @@ -107,10 +163,19 @@ type CreatePredictorInput struct { // false. PerformAutoML *bool - // The hyperparameters to override for model training. The hyperparameters that you - // can override are listed in the individual algorithms. For the list of supported - // algorithms, see aws-forecast-choosing-recipes (). - TrainingParameters map[string]*string + // Whether to perform hyperparameter optimization (HPO). HPO finds optimal + // hyperparameter values for your training data. The process of performing HPO is + // known as running a hyperparameter tuning job. The default value is false. In + // this case, Amazon Forecast uses default hyperparameter values from the chosen + // algorithm. To override the default values, set PerformHPO to true and, + // optionally, supply the HyperParameterTuningJobConfig () object. The tuning job + // specifies a metric to optimize, which hyperparameters participate in tuning, and + // the valid range for each tunable hyperparameter. In this case, you are required + // to specify an algorithm and PerformAutoML must be false. The following algorithm + // supports HPO: + // + // * DeepAR+ + PerformHPO *bool // The optional metadata that you apply to the predictor to help you categorize and // organize them. Each tag consists of a key and an optional value, both of which @@ -145,75 +210,10 @@ type CreatePredictorInput struct { // resource limit. Tags []*types.Tag - // An AWS Key Management Service (KMS) key and the AWS Identity and Access - // Management (IAM) role that Amazon Forecast can assume to access the key. - EncryptionConfig *types.EncryptionConfig - - // The Amazon Resource Name (ARN) of the algorithm to use for model training. - // Required if PerformAutoML is not set to true. Supported algorithms: - // - // * - // arn:aws:forecast:::algorithm/ARIMA - // - // * - // arn:aws:forecast:::algorithm/Deep_AR_Plus Supports hyperparameter optimization - // (HPO) - // - // * arn:aws:forecast:::algorithm/ETS - // - // * - // arn:aws:forecast:::algorithm/NPTS - // - // * arn:aws:forecast:::algorithm/Prophet - AlgorithmArn *string - - // Whether to perform hyperparameter optimization (HPO). HPO finds optimal - // hyperparameter values for your training data. The process of performing HPO is - // known as running a hyperparameter tuning job. The default value is false. In - // this case, Amazon Forecast uses default hyperparameter values from the chosen - // algorithm. To override the default values, set PerformHPO to true and, - // optionally, supply the HyperParameterTuningJobConfig () object. The tuning job - // specifies a metric to optimize, which hyperparameters participate in tuning, and - // the valid range for each tunable hyperparameter. In this case, you are required - // to specify an algorithm and PerformAutoML must be false. The following algorithm - // supports HPO: - // - // * DeepAR+ - PerformHPO *bool - - // Used to override the default evaluation parameters of the specified algorithm. - // Amazon Forecast evaluates a predictor by splitting a dataset into training data - // and testing data. The evaluation parameters define how to perform the split and - // the number of iterations. - EvaluationParameters *types.EvaluationParameters - - // Describes the dataset group that contains the data to use to train the - // predictor. - // - // This member is required. - InputDataConfig *types.InputDataConfig - - // The featurization configuration. - // - // This member is required. - FeaturizationConfig *types.FeaturizationConfig - - // Specifies the number of time-steps that the model is trained to predict. The - // forecast horizon is also called the prediction length. For example, if you - // configure a dataset for daily data collection (using the DataFrequency parameter - // of the CreateDataset () operation) and set the forecast horizon to 10, the model - // returns predictions for 10 days. The maximum forecast horizon is the lesser of - // 500 time-steps or 1/3 of the TARGET_TIME_SERIES dataset length. - // - // This member is required. - ForecastHorizon *int32 - - // Provides hyperparameter override values for the algorithm. If you don't provide - // this parameter, Amazon Forecast uses default values. The individual algorithms - // specify which hyperparameters support hyperparameter optimization (HPO). For - // more information, see aws-forecast-choosing-recipes (). If you included the - // HPOConfig object, you must set PerformHPO to true. - HPOConfig *types.HyperParameterTuningJobConfig + // The hyperparameters to override for model training. The hyperparameters that you + // can override are listed in the individual algorithms. For the list of supported + // algorithms, see aws-forecast-choosing-recipes (). + TrainingParameters map[string]*string } type CreatePredictorOutput struct { diff --git a/service/forecast/api_op_DescribeDataset.go b/service/forecast/api_op_DescribeDataset.go index 1aad728b38f..15740a29869 100644 --- a/service/forecast/api_op_DescribeDataset.go +++ b/service/forecast/api_op_DescribeDataset.go @@ -75,12 +75,41 @@ type DescribeDatasetInput struct { type DescribeDatasetOutput struct { + // When the dataset was created. + CreationTime *time.Time + + // The frequency of data collection. Valid intervals are Y (Year), M (Month), W + // (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 + // minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" indicates + // every month and "30min" indicates every 30 minutes. + DataFrequency *string + + // The Amazon Resource Name (ARN) of the dataset. + DatasetArn *string + + // The name of the dataset. + DatasetName *string + + // The dataset type. + DatasetType types.DatasetType + + // The domain associated with the dataset. + Domain types.Domain + + // The AWS Key Management Service (KMS) key and the AWS Identity and Access + // Management (IAM) role that Amazon Forecast can assume to access the key. + EncryptionConfig *types.EncryptionConfig + // When you create a dataset, LastModificationTime is the same as CreationTime. // While data is being imported to the dataset, LastModificationTime is the current // time of the DescribeDataset call. After a CreateDatasetImportJob () operation // has finished, LastModificationTime is when the import job completed or failed. LastModificationTime *time.Time + // An array of SchemaAttribute objects that specify the dataset fields. Each + // SchemaAttribute specifies the name and data type of a field. + Schema *types.Schema + // The status of the dataset. States include: // // * ACTIVE @@ -101,35 +130,6 @@ type DescribeDatasetOutput struct { // before you can import training data. Status *string - // The name of the dataset. - DatasetName *string - - // The Amazon Resource Name (ARN) of the dataset. - DatasetArn *string - - // The AWS Key Management Service (KMS) key and the AWS Identity and Access - // Management (IAM) role that Amazon Forecast can assume to access the key. - EncryptionConfig *types.EncryptionConfig - - // When the dataset was created. - CreationTime *time.Time - - // The domain associated with the dataset. - Domain types.Domain - - // An array of SchemaAttribute objects that specify the dataset fields. Each - // SchemaAttribute specifies the name and data type of a field. - Schema *types.Schema - - // The frequency of data collection. Valid intervals are Y (Year), M (Month), W - // (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 - // minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" indicates - // every month and "30min" indicates every 30 minutes. - DataFrequency *string - - // The dataset type. - DatasetType types.DatasetType - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/forecast/api_op_DescribeDatasetGroup.go b/service/forecast/api_op_DescribeDatasetGroup.go index 9c66b394c64..d14d5fef4fd 100644 --- a/service/forecast/api_op_DescribeDatasetGroup.go +++ b/service/forecast/api_op_DescribeDatasetGroup.go @@ -78,6 +78,22 @@ type DescribeDatasetGroupInput struct { type DescribeDatasetGroupOutput struct { + // When the dataset group was created. + CreationTime *time.Time + + // An array of Amazon Resource Names (ARNs) of the datasets contained in the + // dataset group. + DatasetArns []*string + + // The ARN of the dataset group. + DatasetGroupArn *string + + // The name of the dataset group. + DatasetGroupName *string + + // The domain associated with the dataset group. + Domain types.Domain + // When the dataset group was created or last updated from a call to the // UpdateDatasetGroup () operation. While the dataset group is being updated, // LastModificationTime is the current time of the DescribeDatasetGroup call. @@ -101,22 +117,6 @@ type DescribeDatasetGroupOutput struct { // dataset group to create a predictor. Status *string - // An array of Amazon Resource Names (ARNs) of the datasets contained in the - // dataset group. - DatasetArns []*string - - // The name of the dataset group. - DatasetGroupName *string - - // The ARN of the dataset group. - DatasetGroupArn *string - - // The domain associated with the dataset group. - Domain types.Domain - - // When the dataset group was created. - CreationTime *time.Time - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/forecast/api_op_DescribeDatasetImportJob.go b/service/forecast/api_op_DescribeDatasetImportJob.go index 063ee94ffd4..5f9d5278c3a 100644 --- a/service/forecast/api_op_DescribeDatasetImportJob.go +++ b/service/forecast/api_op_DescribeDatasetImportJob.go @@ -83,16 +83,45 @@ type DescribeDatasetImportJobInput struct { type DescribeDatasetImportJobOutput struct { + // When the dataset import job was created. + CreationTime *time.Time + // The size of the dataset in gigabytes (GB) after the import job has finished. DataSize *float64 - // Statistical information about each field in the input data. - FieldStatistics map[string]*types.Statistics + // The location of the training data to import and an AWS Identity and Access + // Management (IAM) role that Amazon Forecast can assume to access the data. If + // encryption is used, DataSource includes an AWS Key Management Service (KMS) key. + DataSource *types.DataSource // The Amazon Resource Name (ARN) of the dataset that the training data was // imported to. DatasetArn *string + // The ARN of the dataset import job. + DatasetImportJobArn *string + + // The name of the dataset import job. + DatasetImportJobName *string + + // Statistical information about each field in the input data. + FieldStatistics map[string]*types.Statistics + + // The last time that the dataset was modified. The time depends on the status of + // the job, as follows: + // + // * CREATE_PENDING - The same time as CreationTime. + // + // + // * CREATE_IN_PROGRESS - The current timestamp. + // + // * ACTIVE or CREATE_FAILED - + // When the job finished or failed. + LastModificationTime *time.Time + + // If an error occurred, an informational message about the error. + Message *string + // The status of the dataset import job. The status is reflected in the status of // the dataset. For example, when the import job status is CREATE_IN_PROGRESS, the // status of the dataset is UPDATE_IN_PROGRESS. States include: @@ -117,35 +146,6 @@ type DescribeDatasetImportJobOutput struct { // 15min, and 1min; and optionally, for: Y, M, W, and D TimestampFormat *string - // The ARN of the dataset import job. - DatasetImportJobArn *string - - // If an error occurred, an informational message about the error. - Message *string - - // The location of the training data to import and an AWS Identity and Access - // Management (IAM) role that Amazon Forecast can assume to access the data. If - // encryption is used, DataSource includes an AWS Key Management Service (KMS) key. - DataSource *types.DataSource - - // When the dataset import job was created. - CreationTime *time.Time - - // The name of the dataset import job. - DatasetImportJobName *string - - // The last time that the dataset was modified. The time depends on the status of - // the job, as follows: - // - // * CREATE_PENDING - The same time as CreationTime. - // - // - // * CREATE_IN_PROGRESS - The current timestamp. - // - // * ACTIVE or CREATE_FAILED - - // When the job finished or failed. - LastModificationTime *time.Time - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/forecast/api_op_DescribeForecast.go b/service/forecast/api_op_DescribeForecast.go index eb04c029c61..1fe6bfe8b52 100644 --- a/service/forecast/api_op_DescribeForecast.go +++ b/service/forecast/api_op_DescribeForecast.go @@ -79,30 +79,33 @@ type DescribeForecastInput struct { type DescribeForecastOutput struct { + // When the forecast creation task was created. + CreationTime *time.Time + // The ARN of the dataset group that provided the data used to train the predictor. DatasetGroupArn *string // The forecast ARN as specified in the request. ForecastArn *string - // The ARN of the predictor used to generate the forecast. - PredictorArn *string - - // If an error occurred, an informational message about the error. - Message *string + // The name of the forecast. + ForecastName *string // The quantiles at which probabilistic forecasts were generated. ForecastTypes []*string - // The name of the forecast. - ForecastName *string - // Initially, the same as CreationTime (status is CREATE_PENDING). Updated when // inference (creating the forecast) starts (status changed to CREATE_IN_PROGRESS), // and when inference is complete (status changed to ACTIVE) or fails (status // changed to CREATE_FAILED). LastModificationTime *time.Time + // If an error occurred, an informational message about the error. + Message *string + + // The ARN of the predictor used to generate the forecast. + PredictorArn *string + // The status of the forecast. States include: // // * ACTIVE @@ -117,9 +120,6 @@ type DescribeForecastOutput struct { // export the forecast. Status *string - // When the forecast creation task was created. - CreationTime *time.Time - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/forecast/api_op_DescribeForecastExportJob.go b/service/forecast/api_op_DescribeForecastExportJob.go index 21abd5623b8..8d7410e011a 100644 --- a/service/forecast/api_op_DescribeForecastExportJob.go +++ b/service/forecast/api_op_DescribeForecastExportJob.go @@ -78,28 +78,28 @@ type DescribeForecastExportJobInput struct { type DescribeForecastExportJobOutput struct { - // The Amazon Resource Name (ARN) of the exported forecast. - ForecastArn *string - // When the forecast export job was created. CreationTime *time.Time - // The name of the forecast export job. - ForecastExportJobName *string - - // If an error occurred, an informational message about the error. - Message *string - // The path to the Amazon Simple Storage Service (Amazon S3) bucket where the // forecast is exported. Destination *types.DataDestination - // When the last successful export job finished. - LastModificationTime *time.Time + // The Amazon Resource Name (ARN) of the exported forecast. + ForecastArn *string // The ARN of the forecast export job. ForecastExportJobArn *string + // The name of the forecast export job. + ForecastExportJobName *string + + // When the last successful export job finished. + LastModificationTime *time.Time + + // If an error occurred, an informational message about the error. + Message *string + // The status of the forecast export job. States include: // // * ACTIVE diff --git a/service/forecast/api_op_DescribePredictor.go b/service/forecast/api_op_DescribePredictor.go index 9e9742643b8..fe006ad04e4 100644 --- a/service/forecast/api_op_DescribePredictor.go +++ b/service/forecast/api_op_DescribePredictor.go @@ -84,61 +84,32 @@ type DescribePredictorInput struct { type DescribePredictorOutput struct { - // If an error occurred, an informational message about the error. - Message *string + // The Amazon Resource Name (ARN) of the algorithm used for model training. + AlgorithmArn *string // When PerformAutoML is specified, the ARN of the chosen algorithm. AutoMLAlgorithmArns []*string - // The status of the predictor. States include: - // - // * ACTIVE - // - // * - // CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED - // - // * DELETE_PENDING, - // DELETE_IN_PROGRESS, DELETE_FAILED - // - // * UPDATE_PENDING, UPDATE_IN_PROGRESS, - // UPDATE_FAILED - // - // The Status of the predictor must be ACTIVE before you can use the - // predictor to create a forecast. - Status *string + // When the model training task was created. + CreationTime *time.Time + + // An array of the ARNs of the dataset import jobs used to import training data for + // the predictor. + DatasetImportJobArns []*string // An AWS Key Management Service (KMS) key and the AWS Identity and Access // Management (IAM) role that Amazon Forecast can assume to access the key. EncryptionConfig *types.EncryptionConfig - // The Amazon Resource Name (ARN) of the algorithm used for model training. - AlgorithmArn *string - - // Describes the dataset group that contains the data to use to train the - // predictor. - InputDataConfig *types.InputDataConfig - - // Details on the the status and results of the backtests performed to evaluate the - // accuracy of the predictor. You specify the number of backtests to perform when - // you call the operation. - PredictorExecutionDetails *types.PredictorExecutionDetails - - // The name of the predictor. - PredictorName *string + // Used to override the default evaluation parameters of the specified algorithm. + // Amazon Forecast evaluates a predictor by splitting a dataset into training data + // and testing data. The evaluation parameters define how to perform the split and + // the number of iterations. + EvaluationParameters *types.EvaluationParameters // The featurization configuration. FeaturizationConfig *types.FeaturizationConfig - // An array of the ARNs of the dataset import jobs used to import training data for - // the predictor. - DatasetImportJobArns []*string - - // The default training parameters or overrides selected during model training. If - // using the AutoML algorithm or if HPO is turned on while using the DeepAR+ - // algorithms, the optimized values for the chosen hyperparameters are returned. - // For more information, see aws-forecast-choosing-recipes (). - TrainingParameters map[string]*string - // The number of time-steps of the forecast. The forecast horizon is also called // the prediction length. ForecastHorizon *int32 @@ -146,14 +117,9 @@ type DescribePredictorOutput struct { // The hyperparameter override values for the algorithm. HPOConfig *types.HyperParameterTuningJobConfig - // The ARN of the predictor. - PredictorArn *string - - // Whether the predictor is set to perform AutoML. - PerformAutoML *bool - - // When the model training task was created. - CreationTime *time.Time + // Describes the dataset group that contains the data to use to train the + // predictor. + InputDataConfig *types.InputDataConfig // Initially, the same as CreationTime (when the status is CREATE_PENDING). This // value is updated when training starts (when the status changes to @@ -161,14 +127,48 @@ type DescribePredictorOutput struct { // ACTIVE) or fails (when the status changes to CREATE_FAILED). LastModificationTime *time.Time + // If an error occurred, an informational message about the error. + Message *string + + // Whether the predictor is set to perform AutoML. + PerformAutoML *bool + // Whether the predictor is set to perform hyperparameter optimization (HPO). PerformHPO *bool - // Used to override the default evaluation parameters of the specified algorithm. - // Amazon Forecast evaluates a predictor by splitting a dataset into training data - // and testing data. The evaluation parameters define how to perform the split and - // the number of iterations. - EvaluationParameters *types.EvaluationParameters + // The ARN of the predictor. + PredictorArn *string + + // Details on the the status and results of the backtests performed to evaluate the + // accuracy of the predictor. You specify the number of backtests to perform when + // you call the operation. + PredictorExecutionDetails *types.PredictorExecutionDetails + + // The name of the predictor. + PredictorName *string + + // The status of the predictor. States include: + // + // * ACTIVE + // + // * + // CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED + // + // * DELETE_PENDING, + // DELETE_IN_PROGRESS, DELETE_FAILED + // + // * UPDATE_PENDING, UPDATE_IN_PROGRESS, + // UPDATE_FAILED + // + // The Status of the predictor must be ACTIVE before you can use the + // predictor to create a forecast. + Status *string + + // The default training parameters or overrides selected during model training. If + // using the AutoML algorithm or if HPO is turned on while using the DeepAR+ + // algorithms, the optimized values for the chosen hyperparameters are returned. + // For more information, see aws-forecast-choosing-recipes (). + TrainingParameters map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/forecast/api_op_ListDatasetGroups.go b/service/forecast/api_op_ListDatasetGroups.go index d7c64c997a6..4b35ab00796 100644 --- a/service/forecast/api_op_ListDatasetGroups.go +++ b/service/forecast/api_op_ListDatasetGroups.go @@ -71,13 +71,13 @@ type ListDatasetGroupsInput struct { type ListDatasetGroupsOutput struct { + // An array of objects that summarize each dataset group's properties. + DatasetGroups []*types.DatasetGroupSummary + // If the response is truncated, Amazon Forecast returns this token. To retrieve // the next set of results, use the token in the next request. NextToken *string - // An array of objects that summarize each dataset group's properties. - DatasetGroups []*types.DatasetGroupSummary - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/forecast/api_op_ListDatasets.go b/service/forecast/api_op_ListDatasets.go index 37cfcc9deca..d12d4eeef62 100644 --- a/service/forecast/api_op_ListDatasets.go +++ b/service/forecast/api_op_ListDatasets.go @@ -59,24 +59,24 @@ func (c *Client) ListDatasets(ctx context.Context, params *ListDatasetsInput, op type ListDatasetsInput struct { + // The number of items to return in the response. + MaxResults *int32 + // If the result of the previous request was truncated, the response includes a // NextToken. To retrieve the next set of results, use the token in the next // request. Tokens expire after 24 hours. NextToken *string - - // The number of items to return in the response. - MaxResults *int32 } type ListDatasetsOutput struct { + // An array of objects that summarize each dataset's properties. + Datasets []*types.DatasetSummary + // If the response is truncated, Amazon Forecast returns this token. To retrieve // the next set of results, use the token in the next request. NextToken *string - // An array of objects that summarize each dataset's properties. - Datasets []*types.DatasetSummary - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/forecast/api_op_ListForecastExportJobs.go b/service/forecast/api_op_ListForecastExportJobs.go index c404701ba41..0a43e7c1891 100644 --- a/service/forecast/api_op_ListForecastExportJobs.go +++ b/service/forecast/api_op_ListForecastExportJobs.go @@ -61,14 +61,6 @@ func (c *Client) ListForecastExportJobs(ctx context.Context, params *ListForecas type ListForecastExportJobsInput struct { - // The number of items to return in the response. - MaxResults *int32 - - // If the result of the previous request was truncated, the response includes a - // NextToken. To retrieve the next set of results, use the token in the next - // request. Tokens expire after 24 hours. - NextToken *string - // An array of filters. For each filter, you provide a condition and a match // statement. The condition is either IS or IS_NOT, which specifies whether to // include or exclude the forecast export jobs that match the statement from the @@ -90,6 +82,14 @@ type ListForecastExportJobsInput struct { // "Condition": "IS", "Key": "ForecastArn", "Value": // "arn:aws:forecast:us-west-2::forecast/electricityforecast" } ] Filters []*types.Filter + + // The number of items to return in the response. + MaxResults *int32 + + // If the result of the previous request was truncated, the response includes a + // NextToken. To retrieve the next set of results, use the token in the next + // request. Tokens expire after 24 hours. + NextToken *string } type ListForecastExportJobsOutput struct { diff --git a/service/forecast/api_op_ListForecasts.go b/service/forecast/api_op_ListForecasts.go index f18ea382c35..f0fecc707e7 100644 --- a/service/forecast/api_op_ListForecasts.go +++ b/service/forecast/api_op_ListForecasts.go @@ -93,13 +93,13 @@ type ListForecastsInput struct { type ListForecastsOutput struct { + // An array of objects that summarize each forecast's properties. + Forecasts []*types.ForecastSummary + // If the response is truncated, Amazon Forecast returns this token. To retrieve // the next set of results, use the token in the next request. NextToken *string - // An array of objects that summarize each forecast's properties. - Forecasts []*types.ForecastSummary - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/forecast/api_op_ListPredictors.go b/service/forecast/api_op_ListPredictors.go index b44507015b5..81b4bf5ba99 100644 --- a/service/forecast/api_op_ListPredictors.go +++ b/service/forecast/api_op_ListPredictors.go @@ -61,14 +61,6 @@ func (c *Client) ListPredictors(ctx context.Context, params *ListPredictorsInput type ListPredictorsInput struct { - // The number of items to return in the response. - MaxResults *int32 - - // If the result of the previous request was truncated, the response includes a - // NextToken. To retrieve the next set of results, use the token in the next - // request. Tokens expire after 24 hours. - NextToken *string - // An array of filters. For each filter, you provide a condition and a match // statement. The condition is either IS or IS_NOT, which specifies whether to // include or exclude the predictors that match the statement from the list, @@ -89,6 +81,14 @@ type ListPredictorsInput struct { // ACTIVE, you would specify: "Filters": [ { "Condition": "IS", "Key": "Status", // "Value": "ACTIVE" } ] Filters []*types.Filter + + // The number of items to return in the response. + MaxResults *int32 + + // If the result of the previous request was truncated, the response includes a + // NextToken. To retrieve the next set of results, use the token in the next + // request. Tokens expire after 24 hours. + NextToken *string } type ListPredictorsOutput struct { diff --git a/service/forecast/api_op_TagResource.go b/service/forecast/api_op_TagResource.go index 7054d4c3859..7d7f0811439 100644 --- a/service/forecast/api_op_TagResource.go +++ b/service/forecast/api_op_TagResource.go @@ -60,6 +60,13 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { + // The Amazon Resource Name (ARN) that identifies the resource for which to list + // the tags. Currently, the supported resources are Forecast dataset groups, + // datasets, dataset import jobs, predictors, forecasts, and forecast export jobs. + // + // This member is required. + ResourceArn *string + // The tags to add to the resource. A tag is an array of key-value pairs. The // following basic restrictions apply to tags: // @@ -93,13 +100,6 @@ type TagResourceInput struct { // // This member is required. Tags []*types.Tag - - // The Amazon Resource Name (ARN) that identifies the resource for which to list - // the tags. Currently, the supported resources are Forecast dataset groups, - // datasets, dataset import jobs, predictors, forecasts, and forecast export jobs. - // - // This member is required. - ResourceArn *string } type TagResourceOutput struct { diff --git a/service/forecast/api_op_UntagResource.go b/service/forecast/api_op_UntagResource.go index 7de397ddcff..c25e106c7ea 100644 --- a/service/forecast/api_op_UntagResource.go +++ b/service/forecast/api_op_UntagResource.go @@ -56,17 +56,17 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The keys of the tags to be removed. - // - // This member is required. - TagKeys []*string - // The Amazon Resource Name (ARN) that identifies the resource for which to list // the tags. Currently, the supported resources are Forecast dataset groups, // datasets, dataset import jobs, predictors, forecasts, and forecast exports. // // This member is required. ResourceArn *string + + // The keys of the tags to be removed. + // + // This member is required. + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/forecast/go.mod b/service/forecast/go.mod index 08e4329fa49..f44f37999d3 100644 --- a/service/forecast/go.mod +++ b/service/forecast/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/forecast go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/forecast/types/types.go b/service/forecast/types/types.go index 994230523b0..bdfca9c30a1 100644 --- a/service/forecast/types/types.go +++ b/service/forecast/types/types.go @@ -10,31 +10,36 @@ import ( // object is part of the ParameterRanges () object. type CategoricalParameterRange struct { - // A list of the tunable categories for the hyperparameter. + // The name of the categorical hyperparameter to tune. // // This member is required. - Values []*string + Name *string - // The name of the categorical hyperparameter to tune. + // A list of the tunable categories for the hyperparameter. // // This member is required. - Name *string + Values []*string } // Specifies a continuous hyperparameter and it's range of tunable values. This // object is part of the ParameterRanges () object. type ContinuousParameterRange struct { - // The name of the hyperparameter to tune. + // The maximum tunable value of the hyperparameter. // // This member is required. - Name *string + MaxValue *float64 // The minimum tunable value of the hyperparameter. // // This member is required. MinValue *float64 + // The name of the hyperparameter to tune. + // + // This member is required. + Name *string + // The scale that hyperparameter tuning uses to search the hyperparameter range. // Valid values: Auto Amazon Forecast hyperparameter tuning chooses the best scale // for the hyperparameter. Linear Hyperparameter tuning searches the values in the @@ -49,11 +54,6 @@ type ContinuousParameterRange struct { // (http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type). // One of the following values: ScalingType ScalingType - - // The maximum tunable value of the hyperparameter. - // - // This member is required. - MaxValue *float64 } // The destination for an exported forecast, an AWS Identity and Access Management @@ -77,12 +77,12 @@ type DatasetGroupSummary struct { // When the dataset group was created. CreationTime *time.Time - // The name of the dataset group. - DatasetGroupName *string - // The Amazon Resource Name (ARN) of the dataset group. DatasetGroupArn *string + // The name of the dataset group. + DatasetGroupName *string + // When the dataset group was created or last updated from a call to the // UpdateDatasetGroup () operation. While the dataset group is being updated, // LastModificationTime is the current time of the ListDatasetGroups call. @@ -94,12 +94,21 @@ type DatasetGroupSummary struct { // the DescribeDatasetImportJob () operation, and provide the DatasetImportJobArn. type DatasetImportJobSummary struct { - // If an error occurred, an informational message about the error. - Message *string - // When the dataset import job was created. CreationTime *time.Time + // The location of the training data to import and an AWS Identity and Access + // Management (IAM) role that Amazon Forecast can assume to access the data. The + // training data must be stored in an Amazon S3 bucket. If encryption is used, + // DataSource includes an AWS Key Management Service (KMS) key. + DataSource *DataSource + + // The Amazon Resource Name (ARN) of the dataset import job. + DatasetImportJobArn *string + + // The name of the dataset import job. + DatasetImportJobName *string + // The last time that the dataset was modified. The time depends on the status of // the job, as follows: // @@ -112,17 +121,8 @@ type DatasetImportJobSummary struct { // When the job finished or failed. LastModificationTime *time.Time - // The name of the dataset import job. - DatasetImportJobName *string - - // The location of the training data to import and an AWS Identity and Access - // Management (IAM) role that Amazon Forecast can assume to access the data. The - // training data must be stored in an Amazon S3 bucket. If encryption is used, - // DataSource includes an AWS Key Management Service (KMS) key. - DataSource *DataSource - - // The Amazon Resource Name (ARN) of the dataset import job. - DatasetImportJobArn *string + // If an error occurred, an informational message about the error. + Message *string // The status of the dataset import job. The status is reflected in the status of // the dataset. For example, when the import job status is CREATE_IN_PROGRESS, the @@ -146,18 +146,18 @@ type DatasetSummary struct { // When the dataset was created. CreationTime *time.Time + // The Amazon Resource Name (ARN) of the dataset. + DatasetArn *string + + // The name of the dataset. + DatasetName *string + // The dataset type. DatasetType DatasetType // The domain associated with the dataset. Domain Domain - // The name of the dataset. - DatasetName *string - - // The Amazon Resource Name (ARN) of the dataset. - DatasetArn *string - // When you create a dataset, LastModificationTime is the same as CreationTime. // While data is being imported to the dataset, LastModificationTime is the current // time of the ListDatasets call. After a CreateDatasetImportJob () operation has @@ -184,17 +184,17 @@ type DataSource struct { // requests. type EncryptionConfig struct { + // The Amazon Resource Name (ARN) of the KMS key. + // + // This member is required. + KMSKeyArn *string + // The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS // key. Passing a role across AWS accounts is not allowed. If you pass a role that // isn't in your account, you get an InvalidInputException error. // // This member is required. RoleArn *string - - // The Amazon Resource Name (ARN) of the KMS key. - // - // This member is required. - KMSKeyArn *string } // Parameters that define how to split a dataset into training data and testing @@ -221,13 +221,13 @@ type EvaluationParameters struct { // GetAccuracyMetrics () response. type EvaluationResult struct { + // The Amazon Resource Name (ARN) of the algorithm that was evaluated. + AlgorithmArn *string + // The array of test windows used for evaluating the algorithm. The // NumberOfBacktestWindows from the EvaluationParameters () object determines the // number of windows in the array. TestWindows []*WindowSummary - - // The Amazon Resource Name (ARN) of the algorithm that was evaluated. - AlgorithmArn *string } // Provides featurization (transformation) information for a dataset field. This @@ -270,16 +270,6 @@ type Featurization struct { // configurations. type FeaturizationConfig struct { - // An array of dimension (field) names that specify how to group the generated - // forecast. For example, suppose that you are generating a forecast for item sales - // across all of your stores, and your dataset contains a store_id field. If you - // want the sales forecast for each item by store, you would specify store_id as - // the dimension. All forecast dimensions specified in the TARGET_TIME_SERIES - // dataset don't need to be specified in the CreatePredictor request. All forecast - // dimensions specified in the RELATED_TIME_SERIES dataset must be specified in the - // CreatePredictor request. - ForecastDimensions []*string - // The frequency of predictions in a forecast. Valid intervals are Y (Year), M // (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), // 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" @@ -294,6 +284,16 @@ type FeaturizationConfig struct { // An array of featurization (transformation) information for the fields of a // dataset. Featurizations []*Featurization + + // An array of dimension (field) names that specify how to group the generated + // forecast. For example, suppose that you are generating a forecast for item sales + // across all of your stores, and your dataset contains a store_id field. If you + // want the sales forecast for each item by store, you would specify store_id as + // the dimension. All forecast dimensions specified in the TARGET_TIME_SERIES + // dataset don't need to be specified in the CreatePredictor request. All forecast + // dimensions specified in the RELATED_TIME_SERIES dataset must be specified in the + // CreatePredictor request. + ForecastDimensions []*string } // Provides information about the method that featurizes (transforms) a dataset @@ -349,17 +349,17 @@ type FeaturizationMethod struct { // respectively. The match statement consists of a key and a value. type Filter struct { - // The name of the parameter to filter on. - // - // This member is required. - Key *string - // The condition to apply. To include the objects that match the statement, specify // IS. To exclude matching objects, specify IS_NOT. // // This member is required. Condition FilterConditionString + // The name of the parameter to filter on. + // + // This member is required. + Key *string + // The value to match. // // This member is required. @@ -375,12 +375,22 @@ type ForecastExportJobSummary struct { // When the forecast export job was created. CreationTime *time.Time - // The name of the forecast export job. - ForecastExportJobName *string + // The path to the Amazon Simple Storage Service (Amazon S3) bucket where the + // forecast is exported. + Destination *DataDestination // The Amazon Resource Name (ARN) of the forecast export job. ForecastExportJobArn *string + // The name of the forecast export job. + ForecastExportJobName *string + + // When the last successful export job finished. + LastModificationTime *time.Time + + // If an error occurred, an informational message about the error. + Message *string + // The status of the forecast export job. States include: // // * ACTIVE @@ -394,16 +404,6 @@ type ForecastExportJobSummary struct { // The Status of the forecast export job must be // ACTIVE before you can access the forecast in your S3 bucket. Status *string - - // When the last successful export job finished. - LastModificationTime *time.Time - - // If an error occurred, an informational message about the error. - Message *string - - // The path to the Amazon Simple Storage Service (Amazon S3) bucket where the - // forecast is exported. - Destination *DataDestination } // Provides a summary of the forecast properties used in the ListForecasts () @@ -411,30 +411,13 @@ type ForecastExportJobSummary struct { // operation, and provide the ForecastArn that is listed in the summary. type ForecastSummary struct { - // If an error occurred, an informational message about the error. - Message *string + // When the forecast creation task was created. + CreationTime *time.Time // The Amazon Resource Name (ARN) of the dataset group that provided the data used // to train the predictor. DatasetGroupArn *string - // When the forecast creation task was created. - CreationTime *time.Time - - // The status of the forecast. States include: - // - // * ACTIVE - // - // * CREATE_PENDING, - // CREATE_IN_PROGRESS, CREATE_FAILED - // - // * DELETE_PENDING, DELETE_IN_PROGRESS, - // DELETE_FAILED - // - // The Status of the forecast must be ACTIVE before you can query or - // export the forecast. - Status *string - // The ARN of the forecast. ForecastArn *string @@ -447,8 +430,25 @@ type ForecastSummary struct { // changed to CREATE_FAILED). LastModificationTime *time.Time + // If an error occurred, an informational message about the error. + Message *string + // The ARN of the predictor used to generate the forecast. PredictorArn *string + + // The status of the forecast. States include: + // + // * ACTIVE + // + // * CREATE_PENDING, + // CREATE_IN_PROGRESS, CREATE_FAILED + // + // * DELETE_PENDING, DELETE_IN_PROGRESS, + // DELETE_FAILED + // + // The Status of the forecast must be ACTIVE before you can query or + // export the forecast. + Status *string } // Configuration information for a hyperparameter tuning job. You specify this @@ -486,20 +486,6 @@ type InputDataConfig struct { // object is part of the ParameterRanges () object. type IntegerParameterRange struct { - // The scale that hyperparameter tuning uses to search the hyperparameter range. - // Valid values: Auto Amazon Forecast hyperparameter tuning chooses the best scale - // for the hyperparameter. Linear Hyperparameter tuning searches the values in the - // hyperparameter range by using a linear scale. Logarithmic Hyperparameter tuning - // searches the values in the hyperparameter range by using a logarithmic scale. - // Logarithmic scaling works only for ranges that have values greater than 0. - // ReverseLogarithmic Not supported for IntegerParameterRange. Reverse logarithmic - // scaling works only for ranges that are entirely within the range 0 <= x < 1.0. - // For information about choosing a hyperparameter scale, see Hyperparameter - // Scaling - // (http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type). - // One of the following values: - ScalingType ScalingType - // The maximum tunable value of the hyperparameter. // // This member is required. @@ -514,6 +500,20 @@ type IntegerParameterRange struct { // // This member is required. Name *string + + // The scale that hyperparameter tuning uses to search the hyperparameter range. + // Valid values: Auto Amazon Forecast hyperparameter tuning chooses the best scale + // for the hyperparameter. Linear Hyperparameter tuning searches the values in the + // hyperparameter range by using a linear scale. Logarithmic Hyperparameter tuning + // searches the values in the hyperparameter range by using a logarithmic scale. + // Logarithmic scaling works only for ranges that have values greater than 0. + // ReverseLogarithmic Not supported for IntegerParameterRange. Reverse logarithmic + // scaling works only for ranges that are entirely within the range 0 <= x < 1.0. + // For information about choosing a hyperparameter scale, see Hyperparameter + // Scaling + // (http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type). + // One of the following values: + ScalingType ScalingType } // Provides metrics that are used to evaluate the performance of a predictor. This @@ -535,12 +535,12 @@ type Metrics struct { // This object is part of the HyperParameterTuningJobConfig () object. type ParameterRanges struct { - // Specifies the tunable range for each continuous hyperparameter. - ContinuousParameterRanges []*ContinuousParameterRange - // Specifies the tunable range for each categorical hyperparameter. CategoricalParameterRanges []*CategoricalParameterRange + // Specifies the tunable range for each continuous hyperparameter. + ContinuousParameterRanges []*ContinuousParameterRange + // Specifies the tunable range for each integer hyperparameter. IntegerParameterRanges []*IntegerParameterRange } @@ -548,13 +548,13 @@ type ParameterRanges struct { // The algorithm used to perform a backtest and the status of those tests. type PredictorExecution struct { + // The ARN of the algorithm used to test the predictor. + AlgorithmArn *string + // An array of test windows used to evaluate the algorithm. The // NumberOfBacktestWindows from the object determines the number of windows in the // array. TestWindows []*TestWindowSummary - - // The ARN of the algorithm used to test the predictor. - AlgorithmArn *string } // Contains details on the backtests performed to evaluate the accuracy of the @@ -581,6 +581,20 @@ type PredictorSummary struct { // to train the predictor. DatasetGroupArn *string + // Initially, the same as CreationTime (status is CREATE_PENDING). Updated when + // training starts (status changed to CREATE_IN_PROGRESS), and when training is + // complete (status changed to ACTIVE) or fails (status changed to CREATE_FAILED). + LastModificationTime *time.Time + + // If an error occurred, an informational message about the error. + Message *string + + // The ARN of the predictor. + PredictorArn *string + + // The name of the predictor. + PredictorName *string + // The status of the predictor. States include: // // * ACTIVE @@ -597,20 +611,6 @@ type PredictorSummary struct { // The Status of the predictor must be ACTIVE before you can use the // predictor to create a forecast. Status *string - - // The name of the predictor. - PredictorName *string - - // Initially, the same as CreationTime (status is CREATE_PENDING). Updated when - // training starts (status changed to CREATE_IN_PROGRESS), and when training is - // complete (status changed to ACTIVE) or fails (status changed to CREATE_FAILED). - LastModificationTime *time.Time - - // The ARN of the predictor. - PredictorArn *string - - // If an error occurred, an informational message about the error. - Message *string } // The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, @@ -621,6 +621,12 @@ type PredictorSummary struct { // that is submitted in the CreateForecastExportJob () request. type S3Config struct { + // The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an + // Amazon S3 bucket. + // + // This member is required. + Path *string + // The ARN of the AWS Identity and Access Management (IAM) role that Amazon // Forecast can assume to access the Amazon S3 bucket or files. If you provide a // value for the KMSKeyArn key, the role must allow access to the key. Passing a @@ -632,12 +638,6 @@ type S3Config struct { // The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key. KMSKeyArn *string - - // The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an - // Amazon S3 bucket. - // - // This member is required. - Path *string } // Defines the fields of a dataset. You specify this object in the CreateDataset () @@ -664,29 +664,29 @@ type SchemaAttribute struct { // dataset with the CreateDatasetImportJob () operation. type Statistics struct { - // The number of NAN (not a number) values in the field. - CountNan *int32 - - // For a numeric field, the standard deviation. - Stddev *float64 - - // For a numeric field, the minimum value in the field. - Min *string - // For a numeric field, the average value in the field. Avg *float64 - // For a numeric field, the maximum value in the field. - Max *string - - // The number of null values in the field. - CountNull *int32 - // The number of values in the field. Count *int32 // The number of distinct values in the field. CountDistinct *int32 + + // The number of NAN (not a number) values in the field. + CountNan *int32 + + // The number of null values in the field. + CountNull *int32 + + // For a numeric field, the maximum value in the field. + Max *string + + // For a numeric field, the minimum value in the field. + Min *string + + // For a numeric field, the standard deviation. + Stddev *float64 } // Describes a supplementary feature of a dataset group. This object is part of the @@ -861,8 +861,8 @@ type Tag struct { // if applicable. type TestWindowSummary struct { - // The time at which the test ended. - TestWindowEnd *time.Time + // If the test failed, the reason why it failed. + Message *string // The status of the test. Possible status values are: // @@ -874,11 +874,11 @@ type TestWindowSummary struct { // * CREATE_FAILED Status *string + // The time at which the test ended. + TestWindowEnd *time.Time + // The time at which the test began. TestWindowStart *time.Time - - // If the test failed, the reason why it failed. - Message *string } // The weighted loss value for a quantile. This object is part of the Metrics () @@ -909,15 +909,15 @@ type WindowSummary struct { // * COMPUTED - The metrics for the specified window. EvaluationType EvaluationType + // The number of data points within the window. + ItemCount *int32 + // Provides metrics used to evaluate the performance of a predictor. Metrics *Metrics - // The timestamp that defines the start of the window. - TestWindowStart *time.Time - // The timestamp that defines the end of the window. TestWindowEnd *time.Time - // The number of data points within the window. - ItemCount *int32 + // The timestamp that defines the start of the window. + TestWindowStart *time.Time } diff --git a/service/forecastquery/api_op_QueryForecast.go b/service/forecastquery/api_op_QueryForecast.go index df827997ae8..fe1c05c2d48 100644 --- a/service/forecastquery/api_op_QueryForecast.go +++ b/service/forecastquery/api_op_QueryForecast.go @@ -76,23 +76,23 @@ type QueryForecastInput struct { // This member is required. Filters map[string]*string - // If the result of the previous request was truncated, the response includes a - // NextToken. To retrieve the next set of results, use the token in the next - // request. Tokens expire after 24 hours. - NextToken *string - // The Amazon Resource Name (ARN) of the forecast to query. // // This member is required. ForecastArn *string - // The start date for the forecast. Specify the date using this format: - // yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00. - StartDate *string - // The end date for the forecast. Specify the date using this format: // yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00. EndDate *string + + // If the result of the previous request was truncated, the response includes a + // NextToken. To retrieve the next set of results, use the token in the next + // request. Tokens expire after 24 hours. + NextToken *string + + // The start date for the forecast. Specify the date using this format: + // yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00. + StartDate *string } type QueryForecastOutput struct { diff --git a/service/forecastquery/go.mod b/service/forecastquery/go.mod index 867f6cfb9af..1b699464452 100644 --- a/service/forecastquery/go.mod +++ b/service/forecastquery/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/forecastquery go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/forecastquery/types/types.go b/service/forecastquery/types/types.go index 4b367f49a2a..c328f9bb6fd 100644 --- a/service/forecastquery/types/types.go +++ b/service/forecastquery/types/types.go @@ -5,11 +5,11 @@ package types // The forecast value for a specific date. Part of the Forecast () object. type DataPoint struct { - // The forecast value. - Value *float64 - // The timestamp of the specific forecast. Timestamp *string + + // The forecast value. + Value *float64 } // Provides information about a forecast. Returned as part of the QueryForecast () diff --git a/service/frauddetector/api_op_BatchCreateVariable.go b/service/frauddetector/api_op_BatchCreateVariable.go index 075a73c55e7..473aeffe6a7 100644 --- a/service/frauddetector/api_op_BatchCreateVariable.go +++ b/service/frauddetector/api_op_BatchCreateVariable.go @@ -57,13 +57,13 @@ func (c *Client) BatchCreateVariable(ctx context.Context, params *BatchCreateVar type BatchCreateVariableInput struct { - // A collection of key and value pairs. - Tags []*types.Tag - // The list of variables for the batch create variable request. // // This member is required. VariableEntries []*types.VariableEntry + + // A collection of key and value pairs. + Tags []*types.Tag } type BatchCreateVariableOutput struct { diff --git a/service/frauddetector/api_op_BatchGetVariable.go b/service/frauddetector/api_op_BatchGetVariable.go index af70fad0c5e..da00e9e7875 100644 --- a/service/frauddetector/api_op_BatchGetVariable.go +++ b/service/frauddetector/api_op_BatchGetVariable.go @@ -65,12 +65,12 @@ type BatchGetVariableInput struct { type BatchGetVariableOutput struct { - // The returned variables. - Variables []*types.Variable - // The errors from the request. Errors []*types.BatchGetVariableError + // The returned variables. + Variables []*types.Variable + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/frauddetector/api_op_CreateDetectorVersion.go b/service/frauddetector/api_op_CreateDetectorVersion.go index 47ca6bd9e0a..b163f534fd1 100644 --- a/service/frauddetector/api_op_CreateDetectorVersion.go +++ b/service/frauddetector/api_op_CreateDetectorVersion.go @@ -57,23 +57,25 @@ func (c *Client) CreateDetectorVersion(ctx context.Context, params *CreateDetect type CreateDetectorVersionInput struct { + // The ID of the detector under which you want to create a new version. + // + // This member is required. + DetectorId *string + + // The rules to include in the detector version. + // + // This member is required. + Rules []*types.Rule + // The description of the detector version. Description *string - // A collection of key and value pairs. - Tags []*types.Tag - // The Amazon Sagemaker model endpoints to include in the detector version. ExternalModelEndpoints []*string // The model versions to include in the detector version. ModelVersions []*types.ModelVersion - // The ID of the detector under which you want to create a new version. - // - // This member is required. - DetectorId *string - // The rule execution mode for the rules included in the detector version. You can // define and edit the rule mode at the detector version level, when it is in draft // status. If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules @@ -83,23 +85,21 @@ type CreateDetectorVersionInput struct { // for all matched rules. The default behavior is FIRST_MATCHED. RuleExecutionMode types.RuleExecutionMode - // The rules to include in the detector version. - // - // This member is required. - Rules []*types.Rule + // A collection of key and value pairs. + Tags []*types.Tag } type CreateDetectorVersionOutput struct { - // The status of the detector version. - Status types.DetectorVersionStatus - // The ID for the created version's parent detector. DetectorId *string // The ID for the created detector. DetectorVersionId *string + // The status of the detector version. + Status types.DetectorVersionStatus + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/frauddetector/api_op_CreateModel.go b/service/frauddetector/api_op_CreateModel.go index 72f006974a8..e94562fffd4 100644 --- a/service/frauddetector/api_op_CreateModel.go +++ b/service/frauddetector/api_op_CreateModel.go @@ -57,9 +57,6 @@ func (c *Client) CreateModel(ctx context.Context, params *CreateModelInput, optF type CreateModelInput struct { - // A collection of key and value pairs. - Tags []*types.Tag - // The name of the event type. // // This member is required. @@ -77,6 +74,9 @@ type CreateModelInput struct { // The model description. Description *string + + // A collection of key and value pairs. + Tags []*types.Tag } type CreateModelOutput struct { diff --git a/service/frauddetector/api_op_CreateModelVersion.go b/service/frauddetector/api_op_CreateModelVersion.go index baf309dcfa7..c3acc9f922b 100644 --- a/service/frauddetector/api_op_CreateModelVersion.go +++ b/service/frauddetector/api_op_CreateModelVersion.go @@ -57,32 +57,32 @@ func (c *Client) CreateModelVersion(ctx context.Context, params *CreateModelVers type CreateModelVersionInput struct { - // The model type. + // The model ID. // // This member is required. - ModelType types.ModelTypeEnum + ModelId *string - // The training data source location in Amazon S3. + // The model type. // // This member is required. - TrainingDataSource types.TrainingDataSourceEnum - - // A collection of key and value pairs. - Tags []*types.Tag + ModelType types.ModelTypeEnum - // The model ID. + // The training data schema. // // This member is required. - ModelId *string + TrainingDataSchema *types.TrainingDataSchema - // The training data schema. + // The training data source location in Amazon S3. // // This member is required. - TrainingDataSchema *types.TrainingDataSchema + TrainingDataSource types.TrainingDataSourceEnum // Details for the external events data used for model version training. Required // if trainingDataSource is EXTERNAL_EVENTS. ExternalEventsDetail *types.ExternalEventsDetail + + // A collection of key and value pairs. + Tags []*types.Tag } type CreateModelVersionOutput struct { @@ -90,14 +90,14 @@ type CreateModelVersionOutput struct { // The model ID. ModelId *string - // The model version status. - Status *string + // The model type. + ModelType types.ModelTypeEnum // The model version number of the model version created. ModelVersionNumber *string - // The model type. - ModelType types.ModelTypeEnum + // The model version status. + Status *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/frauddetector/api_op_CreateRule.go b/service/frauddetector/api_op_CreateRule.go index e34c96592e7..2b8cd208620 100644 --- a/service/frauddetector/api_op_CreateRule.go +++ b/service/frauddetector/api_op_CreateRule.go @@ -57,36 +57,36 @@ func (c *Client) CreateRule(ctx context.Context, params *CreateRuleInput, optFns type CreateRuleInput struct { - // The language of the rule. + // The detector ID for the rule's parent detector. // // This member is required. - Language types.Language - - // The rule description. - Description *string + DetectorId *string - // A collection of key and value pairs. - Tags []*types.Tag + // The rule expression. + // + // This member is required. + Expression *string - // The outcome or outcomes returned when the rule expression matches. + // The language of the rule. // // This member is required. - Outcomes []*string + Language types.Language - // The detector ID for the rule's parent detector. + // The outcome or outcomes returned when the rule expression matches. // // This member is required. - DetectorId *string + Outcomes []*string // The rule ID. // // This member is required. RuleId *string - // The rule expression. - // - // This member is required. - Expression *string + // The rule description. + Description *string + + // A collection of key and value pairs. + Tags []*types.Tag } type CreateRuleOutput struct { diff --git a/service/frauddetector/api_op_CreateVariable.go b/service/frauddetector/api_op_CreateVariable.go index 2a8d4584367..895244461c3 100644 --- a/service/frauddetector/api_op_CreateVariable.go +++ b/service/frauddetector/api_op_CreateVariable.go @@ -57,15 +57,31 @@ func (c *Client) CreateVariable(ctx context.Context, params *CreateVariableInput type CreateVariableInput struct { + // The source of the data. + // + // This member is required. + DataSource types.DataSource + + // The data type. + // + // This member is required. + DataType types.DataType + // The default value for the variable when no value is received. // // This member is required. DefaultValue *string - // The source of the data. + // The name of the variable. // // This member is required. - DataSource types.DataSource + Name *string + + // The description. + Description *string + + // A collection of key and value pairs. + Tags []*types.Tag // The variable type. For more information see Variable types // (https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types). @@ -78,22 +94,6 @@ type CreateVariableInput struct { // SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT | SHIPPING_ZIP | // USERAGENT VariableType *string - - // A collection of key and value pairs. - Tags []*types.Tag - - // The data type. - // - // This member is required. - DataType types.DataType - - // The name of the variable. - // - // This member is required. - Name *string - - // The description. - Description *string } type CreateVariableOutput struct { diff --git a/service/frauddetector/api_op_DeleteDetectorVersion.go b/service/frauddetector/api_op_DeleteDetectorVersion.go index 9e089b0df96..3eaaa384695 100644 --- a/service/frauddetector/api_op_DeleteDetectorVersion.go +++ b/service/frauddetector/api_op_DeleteDetectorVersion.go @@ -57,15 +57,15 @@ func (c *Client) DeleteDetectorVersion(ctx context.Context, params *DeleteDetect type DeleteDetectorVersionInput struct { - // The ID of the detector version to delete. + // The ID of the parent detector for the detector version to delete. // // This member is required. - DetectorVersionId *string + DetectorId *string - // The ID of the parent detector for the detector version to delete. + // The ID of the detector version to delete. // // This member is required. - DetectorId *string + DetectorVersionId *string } type DeleteDetectorVersionOutput struct { diff --git a/service/frauddetector/api_op_DescribeDetector.go b/service/frauddetector/api_op_DescribeDetector.go index d528033493c..fdba90f64f6 100644 --- a/service/frauddetector/api_op_DescribeDetector.go +++ b/service/frauddetector/api_op_DescribeDetector.go @@ -71,15 +71,15 @@ type DescribeDetectorInput struct { type DescribeDetectorOutput struct { - // The status and description for each detector version. - DetectorVersionSummaries []*types.DetectorVersionSummary - // The detector ARN. Arn *string // The detector ID. DetectorId *string + // The status and description for each detector version. + DetectorVersionSummaries []*types.DetectorVersionSummary + // The next token to be used for subsequent requests. NextToken *string diff --git a/service/frauddetector/api_op_DescribeModelVersions.go b/service/frauddetector/api_op_DescribeModelVersions.go index da4ff8fbff0..6b2225aca6a 100644 --- a/service/frauddetector/api_op_DescribeModelVersions.go +++ b/service/frauddetector/api_op_DescribeModelVersions.go @@ -61,14 +61,14 @@ type DescribeModelVersionsInput struct { // The maximum number of results to return. MaxResults *int32 - // The model version number. - ModelVersionNumber *string + // The model ID. + ModelId *string // The model type. ModelType types.ModelTypeEnum - // The model ID. - ModelId *string + // The model version number. + ModelVersionNumber *string // The next token from the previous results. NextToken *string @@ -76,12 +76,12 @@ type DescribeModelVersionsInput struct { type DescribeModelVersionsOutput struct { - // The next token. - NextToken *string - // The model version details. ModelVersionDetails []*types.ModelVersionDetail + // The next token. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/frauddetector/api_op_GetDetectorVersion.go b/service/frauddetector/api_op_GetDetectorVersion.go index d5449acb27d..8f774aec0da 100644 --- a/service/frauddetector/api_op_GetDetectorVersion.go +++ b/service/frauddetector/api_op_GetDetectorVersion.go @@ -57,56 +57,56 @@ func (c *Client) GetDetectorVersion(ctx context.Context, params *GetDetectorVers type GetDetectorVersionInput struct { - // The detector version ID. + // The detector ID. // // This member is required. - DetectorVersionId *string + DetectorId *string - // The detector ID. + // The detector version ID. // // This member is required. - DetectorId *string + DetectorVersionId *string } type GetDetectorVersionOutput struct { - // The Amazon SageMaker model endpoints included in the detector version. - ExternalModelEndpoints []*string - - // The execution mode of the rule in the dectector FIRST_MATCHED indicates that - // Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at - // the first matched rule. Amazon Fraud dectector then provides the outcomes for - // that single rule. ALL_MATCHED indicates that Amazon Fraud Detector evaluates all - // rules and returns the outcomes for all matched rules. You can define and edit - // the rule mode at the detector version level, when it is in draft status. - RuleExecutionMode types.RuleExecutionMode + // The detector version ARN. + Arn *string - // The detector version ID. - DetectorVersionId *string + // The timestamp when the detector version was created. + CreatedTime *string // The detector version description. Description *string - // The detector version ARN. - Arn *string + // The detector ID. + DetectorId *string - // The status of the detector version. - Status types.DetectorVersionStatus + // The detector version ID. + DetectorVersionId *string - // The rules included in the detector version. - Rules []*types.Rule + // The Amazon SageMaker model endpoints included in the detector version. + ExternalModelEndpoints []*string // The timestamp when the detector version was last updated. LastUpdatedTime *string - // The timestamp when the detector version was created. - CreatedTime *string - // The model versions included in the detector version. ModelVersions []*types.ModelVersion - // The detector ID. - DetectorId *string + // The execution mode of the rule in the dectector FIRST_MATCHED indicates that + // Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at + // the first matched rule. Amazon Fraud dectector then provides the outcomes for + // that single rule. ALL_MATCHED indicates that Amazon Fraud Detector evaluates all + // rules and returns the outcomes for all matched rules. You can define and edit + // the rule mode at the detector version level, when it is in draft status. + RuleExecutionMode types.RuleExecutionMode + + // The rules included in the detector version. + Rules []*types.Rule + + // The status of the detector version. + Status types.DetectorVersionStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/frauddetector/api_op_GetDetectors.go b/service/frauddetector/api_op_GetDetectors.go index e64aca49548..91aabd42e35 100644 --- a/service/frauddetector/api_op_GetDetectors.go +++ b/service/frauddetector/api_op_GetDetectors.go @@ -61,12 +61,12 @@ func (c *Client) GetDetectors(ctx context.Context, params *GetDetectorsInput, op type GetDetectorsInput struct { - // The maximum number of objects to return for the request. - MaxResults *int32 - // The detector ID. DetectorId *string + // The maximum number of objects to return for the request. + MaxResults *int32 + // The next token for the subsequent request. NextToken *string } diff --git a/service/frauddetector/api_op_GetEntityTypes.go b/service/frauddetector/api_op_GetEntityTypes.go index 8cf8ac2a4b0..3790a2869ac 100644 --- a/service/frauddetector/api_op_GetEntityTypes.go +++ b/service/frauddetector/api_op_GetEntityTypes.go @@ -61,24 +61,24 @@ func (c *Client) GetEntityTypes(ctx context.Context, params *GetEntityTypesInput type GetEntityTypesInput struct { - // The name. - Name *string - // The maximum number of objects to return for the request. MaxResults *int32 + // The name. + Name *string + // The next token for the subsequent request. NextToken *string } type GetEntityTypesOutput struct { - // The next page token. - NextToken *string - // An array of entity types. EntityTypes []*types.EntityType + // The next page token. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/frauddetector/api_op_GetEventPrediction.go b/service/frauddetector/api_op_GetEventPrediction.go index ea9a7b15710..cf9c8a9cef4 100644 --- a/service/frauddetector/api_op_GetEventPrediction.go +++ b/service/frauddetector/api_op_GetEventPrediction.go @@ -58,45 +58,45 @@ func (c *Client) GetEventPrediction(ctx context.Context, params *GetEventPredict type GetEventPredictionInput struct { - // The unique ID used to identify the event. + // The detector ID. // // This member is required. - EventId *string + DetectorId *string - // Names of the event type's variables you defined in Amazon Fraud Detector to - // represent data elements and their corresponding values for the event you are - // sending for evaluation. + // The entity type (associated with the detector's event type) and specific entity + // ID representing who performed the event. If an entity id is not available, use + // "UNKNOWN." // // This member is required. - EventVariables map[string]*string - - // The detector version ID. - DetectorVersionId *string - - // The Amazon SageMaker model endpoint input data blobs. - ExternalModelEndpointDataBlobs map[string]*types.ModelEndpointDataBlob + Entities []*types.Entity - // The event type associated with the detector specified for the prediction. + // The unique ID used to identify the event. // // This member is required. - EventTypeName *string + EventId *string // Timestamp that defines when the event under evaluation occurred. // // This member is required. EventTimestamp *string - // The detector ID. + // The event type associated with the detector specified for the prediction. // // This member is required. - DetectorId *string + EventTypeName *string - // The entity type (associated with the detector's event type) and specific entity - // ID representing who performed the event. If an entity id is not available, use - // "UNKNOWN." + // Names of the event type's variables you defined in Amazon Fraud Detector to + // represent data elements and their corresponding values for the event you are + // sending for evaluation. // // This member is required. - Entities []*types.Entity + EventVariables map[string]*string + + // The detector version ID. + DetectorVersionId *string + + // The Amazon SageMaker model endpoint input data blobs. + ExternalModelEndpointDataBlobs map[string]*types.ModelEndpointDataBlob } type GetEventPredictionOutput struct { diff --git a/service/frauddetector/api_op_GetEventTypes.go b/service/frauddetector/api_op_GetEventTypes.go index 1543f8b8d1c..18ce2a5a759 100644 --- a/service/frauddetector/api_op_GetEventTypes.go +++ b/service/frauddetector/api_op_GetEventTypes.go @@ -64,21 +64,21 @@ type GetEventTypesInput struct { // The maximum number of objects to return for the request. MaxResults *int32 - // The next token for the subsequent request. - NextToken *string - // The name. Name *string + + // The next token for the subsequent request. + NextToken *string } type GetEventTypesOutput struct { - // The next page token. - NextToken *string - // An array of event types. EventTypes []*types.EventType + // The next page token. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/frauddetector/api_op_GetExternalModels.go b/service/frauddetector/api_op_GetExternalModels.go index ef42c0aa5cc..cdc7129e17e 100644 --- a/service/frauddetector/api_op_GetExternalModels.go +++ b/service/frauddetector/api_op_GetExternalModels.go @@ -73,12 +73,12 @@ type GetExternalModelsInput struct { type GetExternalModelsOutput struct { - // The next page token to be used in subsequent requests. - NextToken *string - // Gets the Amazon SageMaker models. ExternalModels []*types.ExternalModel + // The next page token to be used in subsequent requests. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/frauddetector/api_op_GetLabels.go b/service/frauddetector/api_op_GetLabels.go index 0e62c494459..84a03a7c874 100644 --- a/service/frauddetector/api_op_GetLabels.go +++ b/service/frauddetector/api_op_GetLabels.go @@ -61,24 +61,24 @@ func (c *Client) GetLabels(ctx context.Context, params *GetLabelsInput, optFns . type GetLabelsInput struct { - // The name of the label or labels to get. - Name *string - // The maximum number of objects to return for the request. MaxResults *int32 + // The name of the label or labels to get. + Name *string + // The next token for the subsequent request. NextToken *string } type GetLabelsOutput struct { - // The next page token. - NextToken *string - // An array of labels. Labels []*types.Label + // The next page token. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/frauddetector/api_op_GetModelVersion.go b/service/frauddetector/api_op_GetModelVersion.go index 931f34ec9b6..979e5bcf6fd 100644 --- a/service/frauddetector/api_op_GetModelVersion.go +++ b/service/frauddetector/api_op_GetModelVersion.go @@ -78,26 +78,26 @@ type GetModelVersionOutput struct { // The model version ARN. Arn *string - // The training data source. - TrainingDataSource types.TrainingDataSourceEnum - - // The training data schema. - TrainingDataSchema *types.TrainingDataSchema - - // The model version status. - Status *string + // The event details. + ExternalEventsDetail *types.ExternalEventsDetail // The model ID. ModelId *string + // The model type. + ModelType types.ModelTypeEnum + // The model version number. ModelVersionNumber *string - // The event details. - ExternalEventsDetail *types.ExternalEventsDetail + // The model version status. + Status *string - // The model type. - ModelType types.ModelTypeEnum + // The training data schema. + TrainingDataSchema *types.TrainingDataSchema + + // The training data source. + TrainingDataSource types.TrainingDataSourceEnum // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/frauddetector/api_op_GetModels.go b/service/frauddetector/api_op_GetModels.go index 93782e0995a..d689a9fe483 100644 --- a/service/frauddetector/api_op_GetModels.go +++ b/service/frauddetector/api_op_GetModels.go @@ -63,27 +63,27 @@ func (c *Client) GetModels(ctx context.Context, params *GetModelsInput, optFns . type GetModelsInput struct { - // The model type. - ModelType types.ModelTypeEnum - - // The next token for the subsequent request. - NextToken *string - // The maximum number of objects to return for the request. MaxResults *int32 // The model ID. ModelId *string -} -type GetModelsOutput struct { + // The model type. + ModelType types.ModelTypeEnum - // The next page token to be used in subsequent requests. + // The next token for the subsequent request. NextToken *string +} + +type GetModelsOutput struct { // The array of models. Models []*types.Model + // The next page token to be used in subsequent requests. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/frauddetector/api_op_GetOutcomes.go b/service/frauddetector/api_op_GetOutcomes.go index d5c2da7ccea..3d81f54f8b3 100644 --- a/service/frauddetector/api_op_GetOutcomes.go +++ b/service/frauddetector/api_op_GetOutcomes.go @@ -60,14 +60,14 @@ func (c *Client) GetOutcomes(ctx context.Context, params *GetOutcomesInput, optF type GetOutcomesInput struct { + // The maximum number of objects to return for the request. + MaxResults *int32 + // The name of the outcome or outcomes to get. Name *string // The next page token for the request. NextToken *string - - // The maximum number of objects to return for the request. - MaxResults *int32 } type GetOutcomesOutput struct { diff --git a/service/frauddetector/api_op_GetRules.go b/service/frauddetector/api_op_GetRules.go index d8e43f76601..d1a51699748 100644 --- a/service/frauddetector/api_op_GetRules.go +++ b/service/frauddetector/api_op_GetRules.go @@ -64,32 +64,32 @@ func (c *Client) GetRules(ctx context.Context, params *GetRulesInput, optFns ... type GetRulesInput struct { - // The maximum number of rules to return for the request. - MaxResults *int32 - // The detector ID. // // This member is required. DetectorId *string - // The rule version. - RuleVersion *string + // The maximum number of rules to return for the request. + MaxResults *int32 // The next page token. NextToken *string // The rule ID. RuleId *string + + // The rule version. + RuleVersion *string } type GetRulesOutput struct { - // The details of the requested rule. - RuleDetails []*types.RuleDetail - // The next page token to be used in subsequent requests. NextToken *string + // The details of the requested rule. + RuleDetails []*types.RuleDetail + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/frauddetector/api_op_GetVariables.go b/service/frauddetector/api_op_GetVariables.go index efd5286a4a2..2b9fd37d36c 100644 --- a/service/frauddetector/api_op_GetVariables.go +++ b/service/frauddetector/api_op_GetVariables.go @@ -61,24 +61,24 @@ func (c *Client) GetVariables(ctx context.Context, params *GetVariablesInput, op type GetVariablesInput struct { - // The name of the variable. - Name *string - // The max size per page determined for the get variable request. MaxResults *int32 + // The name of the variable. + Name *string + // The next page token of the get variable request. NextToken *string } type GetVariablesOutput struct { - // The names of the variables returned. - Variables []*types.Variable - // The next page token to be used in subsequent requests. NextToken *string + // The names of the variables returned. + Variables []*types.Variable + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/frauddetector/api_op_ListTagsForResource.go b/service/frauddetector/api_op_ListTagsForResource.go index 3672bf382a2..1af4f99561c 100644 --- a/service/frauddetector/api_op_ListTagsForResource.go +++ b/service/frauddetector/api_op_ListTagsForResource.go @@ -59,26 +59,26 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The next token from the previous results. - NextToken *string - - // The maximum number of objects to return for the request. - MaxResults *int32 - // The ARN that specifies the resource whose tags you want to list. // // This member is required. ResourceARN *string + + // The maximum number of objects to return for the request. + MaxResults *int32 + + // The next token from the previous results. + NextToken *string } type ListTagsForResourceOutput struct { - // A collection of key and value pairs. - Tags []*types.Tag - // The next token for subsequent requests. NextToken *string + // A collection of key and value pairs. + Tags []*types.Tag + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/frauddetector/api_op_PutDetector.go b/service/frauddetector/api_op_PutDetector.go index ed2f43344ba..f56e45a02b1 100644 --- a/service/frauddetector/api_op_PutDetector.go +++ b/service/frauddetector/api_op_PutDetector.go @@ -57,21 +57,21 @@ func (c *Client) PutDetector(ctx context.Context, params *PutDetectorInput, optF type PutDetectorInput struct { - // A collection of key and value pairs. - Tags []*types.Tag - - // The description of the detector. - Description *string + // The detector ID. + // + // This member is required. + DetectorId *string // The name of the event type. // // This member is required. EventTypeName *string - // The detector ID. - // - // This member is required. - DetectorId *string + // The description of the detector. + Description *string + + // A collection of key and value pairs. + Tags []*types.Tag } type PutDetectorOutput struct { diff --git a/service/frauddetector/api_op_PutEventType.go b/service/frauddetector/api_op_PutEventType.go index 002db161d2b..a688141345d 100644 --- a/service/frauddetector/api_op_PutEventType.go +++ b/service/frauddetector/api_op_PutEventType.go @@ -63,30 +63,30 @@ func (c *Client) PutEventType(ctx context.Context, params *PutEventTypeInput, op type PutEventTypeInput struct { - // The event type labels. - Labels []*string + // The entity type for the event type. Example entity types: customer, merchant, + // account. + // + // This member is required. + EntityTypes []*string // The event type variables. // // This member is required. EventVariables []*string - // A collection of key and value pairs. - Tags []*types.Tag - - // The entity type for the event type. Example entity types: customer, merchant, - // account. + // The name. // // This member is required. - EntityTypes []*string + Name *string // The description of the event type. Description *string - // The name. - // - // This member is required. - Name *string + // The event type labels. + Labels []*string + + // A collection of key and value pairs. + Tags []*types.Tag } type PutEventTypeOutput struct { diff --git a/service/frauddetector/api_op_PutExternalModel.go b/service/frauddetector/api_op_PutExternalModel.go index 77fe416915e..19c3bd54312 100644 --- a/service/frauddetector/api_op_PutExternalModel.go +++ b/service/frauddetector/api_op_PutExternalModel.go @@ -59,28 +59,25 @@ func (c *Client) PutExternalModel(ctx context.Context, params *PutExternalModelI type PutExternalModelInput struct { - // The IAM role used to invoke the model endpoint. - // - // This member is required. - InvokeModelEndpointRoleArn *string - - // The model endpoint’s status in Amazon Fraud Detector. + // The model endpoint input configuration. // // This member is required. - ModelEndpointStatus types.ModelEndpointStatus + InputConfiguration *types.ModelInputConfiguration - // The model endpoint input configuration. + // The IAM role used to invoke the model endpoint. // // This member is required. - InputConfiguration *types.ModelInputConfiguration + InvokeModelEndpointRoleArn *string // The model endpoints name. // // This member is required. ModelEndpoint *string - // A collection of key and value pairs. - Tags []*types.Tag + // The model endpoint’s status in Amazon Fraud Detector. + // + // This member is required. + ModelEndpointStatus types.ModelEndpointStatus // The source of the model. // @@ -91,6 +88,9 @@ type PutExternalModelInput struct { // // This member is required. OutputConfiguration *types.ModelOutputConfiguration + + // A collection of key and value pairs. + Tags []*types.Tag } type PutExternalModelOutput struct { diff --git a/service/frauddetector/api_op_PutLabel.go b/service/frauddetector/api_op_PutLabel.go index 5476805f501..7a9c816f8d6 100644 --- a/service/frauddetector/api_op_PutLabel.go +++ b/service/frauddetector/api_op_PutLabel.go @@ -59,9 +59,6 @@ func (c *Client) PutLabel(ctx context.Context, params *PutLabelInput, optFns ... type PutLabelInput struct { - // - Tags []*types.Tag - // The label name. // // This member is required. @@ -69,6 +66,9 @@ type PutLabelInput struct { // The label description. Description *string + + // + Tags []*types.Tag } type PutLabelOutput struct { diff --git a/service/frauddetector/api_op_PutOutcome.go b/service/frauddetector/api_op_PutOutcome.go index f59f4ed8c29..979b444d6a2 100644 --- a/service/frauddetector/api_op_PutOutcome.go +++ b/service/frauddetector/api_op_PutOutcome.go @@ -57,16 +57,16 @@ func (c *Client) PutOutcome(ctx context.Context, params *PutOutcomeInput, optFns type PutOutcomeInput struct { + // The name of the outcome. + // + // This member is required. + Name *string + // The outcome description. Description *string // A collection of key and value pairs. Tags []*types.Tag - - // The name of the outcome. - // - // This member is required. - Name *string } type PutOutcomeOutput struct { diff --git a/service/frauddetector/api_op_UpdateDetectorVersion.go b/service/frauddetector/api_op_UpdateDetectorVersion.go index 4913c2178c3..00b2acc0a28 100644 --- a/service/frauddetector/api_op_UpdateDetectorVersion.go +++ b/service/frauddetector/api_op_UpdateDetectorVersion.go @@ -59,31 +59,31 @@ func (c *Client) UpdateDetectorVersion(ctx context.Context, params *UpdateDetect type UpdateDetectorVersionInput struct { + // The parent detector ID for the detector version you want to update. + // + // This member is required. + DetectorId *string + // The detector version ID. // // This member is required. DetectorVersionId *string - // The model versions to include in the detector version. - ModelVersions []*types.ModelVersion - - // The parent detector ID for the detector version you want to update. + // The Amazon SageMaker model endpoints to include in the detector version. // // This member is required. - DetectorId *string - - // The detector version description. - Description *string + ExternalModelEndpoints []*string // The rules to include in the detector version. // // This member is required. Rules []*types.Rule - // The Amazon SageMaker model endpoints to include in the detector version. - // - // This member is required. - ExternalModelEndpoints []*string + // The detector version description. + Description *string + + // The model versions to include in the detector version. + ModelVersions []*types.ModelVersion // The rule execution mode to add to the detector. If you specify FIRST_MATCHED, // Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at diff --git a/service/frauddetector/api_op_UpdateDetectorVersionMetadata.go b/service/frauddetector/api_op_UpdateDetectorVersionMetadata.go index d17e78dbf5e..50b8e36a949 100644 --- a/service/frauddetector/api_op_UpdateDetectorVersionMetadata.go +++ b/service/frauddetector/api_op_UpdateDetectorVersionMetadata.go @@ -57,20 +57,20 @@ func (c *Client) UpdateDetectorVersionMetadata(ctx context.Context, params *Upda type UpdateDetectorVersionMetadataInput struct { - // The detector version ID. + // The description. // // This member is required. - DetectorVersionId *string + Description *string // The detector ID. // // This member is required. DetectorId *string - // The description. + // The detector version ID. // // This member is required. - Description *string + DetectorVersionId *string } type UpdateDetectorVersionMetadataOutput struct { diff --git a/service/frauddetector/api_op_UpdateDetectorVersionStatus.go b/service/frauddetector/api_op_UpdateDetectorVersionStatus.go index e9b39b4e136..6d141452bb7 100644 --- a/service/frauddetector/api_op_UpdateDetectorVersionStatus.go +++ b/service/frauddetector/api_op_UpdateDetectorVersionStatus.go @@ -64,15 +64,15 @@ type UpdateDetectorVersionStatusInput struct { // This member is required. DetectorId *string - // The new status. + // The detector version ID. // // This member is required. - Status types.DetectorVersionStatus + DetectorVersionId *string - // The detector version ID. + // The new status. // // This member is required. - DetectorVersionId *string + Status types.DetectorVersionStatus } type UpdateDetectorVersionStatusOutput struct { diff --git a/service/frauddetector/api_op_UpdateModel.go b/service/frauddetector/api_op_UpdateModel.go index cb2aef3f693..63c762a2a3f 100644 --- a/service/frauddetector/api_op_UpdateModel.go +++ b/service/frauddetector/api_op_UpdateModel.go @@ -57,15 +57,15 @@ func (c *Client) UpdateModel(ctx context.Context, params *UpdateModelInput, optF type UpdateModelInput struct { - // The model type. + // The model ID. // // This member is required. - ModelType types.ModelTypeEnum + ModelId *string - // The model ID. + // The model type. // // This member is required. - ModelId *string + ModelType types.ModelTypeEnum // The new model description. Description *string diff --git a/service/frauddetector/api_op_UpdateModelVersion.go b/service/frauddetector/api_op_UpdateModelVersion.go index feed6d4853b..ca699978450 100644 --- a/service/frauddetector/api_op_UpdateModelVersion.go +++ b/service/frauddetector/api_op_UpdateModelVersion.go @@ -61,9 +61,6 @@ func (c *Client) UpdateModelVersion(ctx context.Context, params *UpdateModelVers type UpdateModelVersionInput struct { - // A collection of key and value pairs. - Tags []*types.Tag - // The major version number. // // This member is required. @@ -81,22 +78,25 @@ type UpdateModelVersionInput struct { // The event details. ExternalEventsDetail *types.ExternalEventsDetail + + // A collection of key and value pairs. + Tags []*types.Tag } type UpdateModelVersionOutput struct { - // The model type. - ModelType types.ModelTypeEnum - - // The status of the updated model version. - Status *string - // The model ID. ModelId *string + // The model type. + ModelType types.ModelTypeEnum + // The model version number of the model version updated. ModelVersionNumber *string + // The status of the updated model version. + Status *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/frauddetector/api_op_UpdateModelVersionStatus.go b/service/frauddetector/api_op_UpdateModelVersionStatus.go index 8fb16bbbd18..b57a20b1e77 100644 --- a/service/frauddetector/api_op_UpdateModelVersionStatus.go +++ b/service/frauddetector/api_op_UpdateModelVersionStatus.go @@ -68,15 +68,15 @@ type UpdateModelVersionStatusInput struct { // This member is required. ModelId *string - // The model version number. + // The model type. // // This member is required. - ModelVersionNumber *string + ModelType types.ModelTypeEnum - // The model type. + // The model version number. // // This member is required. - ModelType types.ModelTypeEnum + ModelVersionNumber *string // The model version status. // diff --git a/service/frauddetector/api_op_UpdateRuleMetadata.go b/service/frauddetector/api_op_UpdateRuleMetadata.go index 347de7098b5..2fa138409e3 100644 --- a/service/frauddetector/api_op_UpdateRuleMetadata.go +++ b/service/frauddetector/api_op_UpdateRuleMetadata.go @@ -57,15 +57,15 @@ func (c *Client) UpdateRuleMetadata(ctx context.Context, params *UpdateRuleMetad type UpdateRuleMetadataInput struct { - // The rule to update. + // The rule description. // // This member is required. - Rule *types.Rule + Description *string - // The rule description. + // The rule to update. // // This member is required. - Description *string + Rule *types.Rule } type UpdateRuleMetadataOutput struct { diff --git a/service/frauddetector/api_op_UpdateRuleVersion.go b/service/frauddetector/api_op_UpdateRuleVersion.go index 487de5cfc8c..d4d2fa2fead 100644 --- a/service/frauddetector/api_op_UpdateRuleVersion.go +++ b/service/frauddetector/api_op_UpdateRuleVersion.go @@ -58,8 +58,10 @@ func (c *Client) UpdateRuleVersion(ctx context.Context, params *UpdateRuleVersio type UpdateRuleVersionInput struct { - // The tags to assign to the rule version. - Tags []*types.Tag + // The rule expression. + // + // This member is required. + Expression *string // The language. // @@ -71,18 +73,16 @@ type UpdateRuleVersionInput struct { // This member is required. Outcomes []*string - // The rule expression. + // The rule to update. // // This member is required. - Expression *string + Rule *types.Rule // The description. Description *string - // The rule to update. - // - // This member is required. - Rule *types.Rule + // The tags to assign to the rule version. + Tags []*types.Tag } type UpdateRuleVersionOutput struct { diff --git a/service/frauddetector/api_op_UpdateVariable.go b/service/frauddetector/api_op_UpdateVariable.go index cb181b90c51..14c8c7b6866 100644 --- a/service/frauddetector/api_op_UpdateVariable.go +++ b/service/frauddetector/api_op_UpdateVariable.go @@ -56,13 +56,6 @@ func (c *Client) UpdateVariable(ctx context.Context, params *UpdateVariableInput type UpdateVariableInput struct { - // The variable type. For more information see Variable types - // (https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types). - VariableType *string - - // The new description. - Description *string - // The name of the variable. // // This member is required. @@ -70,6 +63,13 @@ type UpdateVariableInput struct { // The new default value of the variable. DefaultValue *string + + // The new description. + Description *string + + // The variable type. For more information see Variable types + // (https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types). + VariableType *string } type UpdateVariableOutput struct { diff --git a/service/frauddetector/go.mod b/service/frauddetector/go.mod index ab5cc32d27b..9df3f882228 100644 --- a/service/frauddetector/go.mod +++ b/service/frauddetector/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/frauddetector go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/frauddetector/types/types.go b/service/frauddetector/types/types.go index 421bf3cac41..2e6f4853198 100644 --- a/service/frauddetector/types/types.go +++ b/service/frauddetector/types/types.go @@ -8,24 +8,24 @@ type BatchCreateVariableError struct { // The error code. Code *int32 - // The name. - Name *string - // The error message. Message *string + + // The name. + Name *string } // Provides the error of the batch get variable API. type BatchGetVariableError struct { - // The error name. - Name *string - // The error code. Code *int32 // The error message. Message *string + + // The error name. + Name *string } // The model training validation messages. @@ -41,20 +41,20 @@ type DataValidationMetrics struct { // The detector. type Detector struct { + // The detector ARN. + Arn *string + // Timestamp of when the detector was created. CreatedTime *string - // The name of the event type. - EventTypeName *string - // The detector description. Description *string // The detector ID. DetectorId *string - // The detector ARN. - Arn *string + // The name of the event type. + EventTypeName *string // Timestamp of when the detector was last updated. LastUpdatedTime *string @@ -63,8 +63,8 @@ type Detector struct { // The summary of the detector version. type DetectorVersionSummary struct { - // The detector version status. - Status DetectorVersionStatus + // The detector version description. + Description *string // The detector version ID. DetectorVersionId *string @@ -72,8 +72,8 @@ type DetectorVersionSummary struct { // Timestamp of when the detector version was last updated. LastUpdatedTime *string - // The detector version description. - Description *string + // The detector version status. + Status DetectorVersionStatus } // The entity details. @@ -97,45 +97,45 @@ type EntityType struct { // The entity type ARN. Arn *string - // Timestamp of when the entity type was last updated. - LastUpdatedTime *string + // Timestamp of when the entity type was created. + CreatedTime *string // The entity type description. Description *string + // Timestamp of when the entity type was last updated. + LastUpdatedTime *string + // The entity type name. Name *string - - // Timestamp of when the entity type was created. - CreatedTime *string } // The event type details. type EventType struct { - // The event type description. - Description *string - - // The event type name. - Name *string + // The entity type ARN. + Arn *string // Timestamp of when the event type was created. CreatedTime *string + // The event type description. + Description *string + // The event type entity types. EntityTypes []*string + // The event type event variables. + EventVariables []*string + // The event type labels. Labels []*string - // The entity type ARN. - Arn *string - // Timestamp of when the event type was last updated. LastUpdatedTime *string - // The event type event variables. - EventVariables []*string + // The event type name. + Name *string } // Details for the external events data used for model version training. @@ -159,26 +159,26 @@ type ExternalModel struct { // The model ARN. Arn *string - // The Amazon SageMaker model endpoints. - ModelEndpoint *string + // Timestamp of when the model was last created. + CreatedTime *string // The input configuration. InputConfiguration *ModelInputConfiguration - // Timestamp of when the model was last updated. - LastUpdatedTime *string - // The role used to invoke the model. InvokeModelEndpointRoleArn *string - // The source of the model. - ModelSource ModelSource + // Timestamp of when the model was last updated. + LastUpdatedTime *string + + // The Amazon SageMaker model endpoints. + ModelEndpoint *string // The Amazon Fraud Detector status for the external model endpoint ModelEndpointStatus ModelEndpointStatus - // Timestamp of when the model was last created. - CreatedTime *string + // The source of the model. + ModelSource ModelSource // The output configuration. OutputConfiguration *ModelOutputConfiguration @@ -187,8 +187,8 @@ type ExternalModel struct { // The message details. type FieldValidationMessage struct { - // The message type. - Type *string + // The message content. + Content *string // The field name. FieldName *string @@ -196,11 +196,11 @@ type FieldValidationMessage struct { // The message ID. Identifier *string - // The message content. - Content *string - // The message title. Title *string + + // The message type. + Type *string } // The message details. @@ -209,11 +209,11 @@ type FileValidationMessage struct { // The message content. Content *string - // The message type. - Type *string - // The message title. Title *string + + // The message type. + Type *string } // The KMS key details. @@ -226,20 +226,20 @@ type KMSKey struct { // The label details. type Label struct { - // Timestamp of when the label was last updated. - LastUpdatedTime *string - // The label ARN. Arn *string + // Timestamp of when the event type was created. + CreatedTime *string + // The label description. Description *string + // Timestamp of when the label was last updated. + LastUpdatedTime *string + // The label name. Name *string - - // Timestamp of when the event type was created. - CreatedTime *string } // The label schema. @@ -260,27 +260,33 @@ type LabelSchema struct { // Model performance metrics data points. type MetricDataPoint struct { + // The false positive rate. This is the percentage of total legitimate events that + // are incorrectly predicted as fraud. + Fpr *float32 + + // The percentage of fraud events correctly predicted as fraudulent as compared to + // all events predicted as fraudulent. + Precision *float32 + // The model threshold that specifies an acceptable fraud capture rate. For // example, a threshold of 500 means any model score 500 or above is labeled as // fraud. Threshold *float32 - // The false positive rate. This is the percentage of total legitimate events that - // are incorrectly predicted as fraud. - Fpr *float32 - // The true positive rate. This is the percentage of total fraud the model detects. // Also known as capture rate. Tpr *float32 - - // The percentage of fraud events correctly predicted as fraudulent as compared to - // all events predicted as fraudulent. - Precision *float32 } // The model. type Model struct { + // The ARN of the model. + Arn *string + + // Timestamp of when the model was created. + CreatedTime *string + // The model description. Description *string @@ -290,17 +296,11 @@ type Model struct { // Timestamp of last time the model was updated. LastUpdatedTime *string - // The model type. - ModelType ModelTypeEnum - - // The ARN of the model. - Arn *string - // The model ID. ModelId *string - // Timestamp of when the model was created. - CreatedTime *string + // The model type. + ModelType ModelTypeEnum } // A pre-formed Amazon SageMaker model input you can include if your detector @@ -308,21 +308,29 @@ type Model struct { // input configuration. type ModelEndpointDataBlob struct { - // The content type of the Amazon SageMaker model endpoint input data blob. - ContentType *string - // The byte buffer of the Amazon SageMaker model endpoint input data blob. ByteBuffer []byte + + // The content type of the Amazon SageMaker model endpoint input data blob. + ContentType *string } // The Amazon SageMaker model input configuration. type ModelInputConfiguration struct { + // The event variables. + // + // This member is required. + UseEventVariables *bool + // Template for constructing the CSV input-data sent to SageMaker. At // event-evaluation, the placeholders for variable-names in the template will be // replaced with the variable values before being sent to SageMaker. CsvInputTemplate *string + // The event type name. + EventTypeName *string + // The format of the model input configuration. The format differs depending on if // it is passed through to SageMaker or constructed by Amazon Fraud Detector. Format ModelInputDataFormat @@ -331,19 +339,16 @@ type ModelInputConfiguration struct { // event-evaluation, the placeholders for variable names in the template will be // replaced with the variable values before being sent to SageMaker. JsonInputTemplate *string - - // The event type name. - EventTypeName *string - - // The event variables. - // - // This member is required. - UseEventVariables *bool } // Provides the Amazon Sagemaker model output configuration. type ModelOutputConfiguration struct { + // The format of the model output configuration. + // + // This member is required. + Format ModelOutputDataFormat + // A map of CSV index values in the SageMaker response to the Amazon Fraud Detector // variables. CsvIndexToVariableMap map[string]*string @@ -351,21 +356,16 @@ type ModelOutputConfiguration struct { // A map of JSON keys in response from SageMaker to the Amazon Fraud Detector // variables. JsonKeyToVariableMap map[string]*string - - // The format of the model output configuration. - // - // This member is required. - Format ModelOutputDataFormat } // The fraud prediction scores. type ModelScores struct { - // The model's fraud prediction scores. - Scores map[string]*float32 - // The model version. ModelVersion *ModelVersion + + // The model's fraud prediction scores. + Scores map[string]*float32 } // The model version. @@ -376,6 +376,11 @@ type ModelVersion struct { // This member is required. ModelId *string + // The model type. + // + // This member is required. + ModelType ModelTypeEnum + // The model version number. // // This member is required. @@ -383,55 +388,50 @@ type ModelVersion struct { // The model version ARN. Arn *string - - // The model type. - // - // This member is required. - ModelType ModelTypeEnum } // The details of the model version. type ModelVersionDetail struct { - // The model version number. - ModelVersionNumber *string + // The model version ARN. + Arn *string // The timestamp when the model was created. CreatedTime *string - // The status of the model version. - Status *string + // The event details. + ExternalEventsDetail *ExternalEventsDetail + + // The timestamp when the model was last updated. + LastUpdatedTime *string + + // The model ID. + ModelId *string // The model type. ModelType ModelTypeEnum - // The timestamp when the model was last updated. - LastUpdatedTime *string + // The model version number. + ModelVersionNumber *string - // The model version ARN. - Arn *string + // The status of the model version. + Status *string + + // The training data schema. + TrainingDataSchema *TrainingDataSchema // The model version training data source. TrainingDataSource TrainingDataSourceEnum // The training results. TrainingResult *TrainingResult - - // The event details. - ExternalEventsDetail *ExternalEventsDetail - - // The model ID. - ModelId *string - - // The training data schema. - TrainingDataSchema *TrainingDataSchema } // The outcome. type Outcome struct { - // The timestamp when the outcome was last updated. - LastUpdatedTime *string + // The outcome ARN. + Arn *string // The timestamp when the outcome was created. CreatedTime *string @@ -439,11 +439,11 @@ type Outcome struct { // The outcome description. Description *string + // The timestamp when the outcome was last updated. + LastUpdatedTime *string + // The outcome name. Name *string - - // The outcome ARN. - Arn *string } // A rule. @@ -468,35 +468,35 @@ type Rule struct { // The details of the rule. type RuleDetail struct { - // The rule language. - Language Language - - // The rule description. - Description *string + // The rule ARN. + Arn *string // The timestamp of when the rule was created. CreatedTime *string - // The rule ID. - RuleId *string + // The rule description. + Description *string + + // The detector for which the rule is associated. + DetectorId *string // The rule expression. Expression *string - // The detector for which the rule is associated. - DetectorId *string + // The rule language. + Language Language + + // Timestamp of the last time the rule was updated. + LastUpdatedTime *string // The rule outcomes. Outcomes []*string - // The rule ARN. - Arn *string + // The rule ID. + RuleId *string // The rule version. RuleVersion *string - - // Timestamp of the last time the rule was updated. - LastUpdatedTime *string } // The rule results. @@ -512,29 +512,29 @@ type RuleResult struct { // A key and value pair. type Tag struct { - // A value assigned to a tag key. + // A tag key. // // This member is required. - Value *string + Key *string - // A tag key. + // A value assigned to a tag key. // // This member is required. - Key *string + Value *string } // The training data schema. type TrainingDataSchema struct { - // The training data schema variables. + // The label schema. // // This member is required. - ModelVariables []*string + LabelSchema *LabelSchema - // The label schema. + // The training data schema variables. // // This member is required. - LabelSchema *LabelSchema + ModelVariables []*string } // The training metric details. @@ -562,18 +562,24 @@ type TrainingResult struct { // The variable. type Variable struct { - // The default value of the variable. - DefaultValue *string + // The ARN of the variable. + Arn *string + + // The time when the variable was created. + CreatedTime *string + + // The data source of the variable. + DataSource DataSource // The data type of the variable. For more information see Variable types // (https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types). DataType DataType - // The ARN of the variable. - Arn *string + // The default value of the variable. + DefaultValue *string - // The data source of the variable. - DataSource DataSource + // The description of the variable. + Description *string // The time when variable was last updated. LastUpdatedTime *string @@ -590,25 +596,25 @@ type Variable struct { // SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | // SHIPPING_STATE | SHIPPING_ZIP | USERAGENT | SHIPPING_ZIP | USERAGENT VariableType *string - - // The time when the variable was created. - CreatedTime *string - - // The description of the variable. - Description *string } // A variable in the list of variables for the batch create variable request. type VariableEntry struct { - // The name of the variable. - Name *string + // The data source of the variable. + DataSource *string + + // The data type of the variable. + DataType *string + + // The default value of the variable. + DefaultValue *string // The description of the variable. Description *string - // The data source of the variable. - DataSource *string + // The name of the variable. + Name *string // The type of the variable. For more information see Variable types // (https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types). @@ -621,10 +627,4 @@ type VariableEntry struct { // SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT | SHIPPING_ZIP | // USERAGENT VariableType *string - - // The default value of the variable. - DefaultValue *string - - // The data type of the variable. - DataType *string } diff --git a/service/fsx/api_op_CreateBackup.go b/service/fsx/api_op_CreateBackup.go index 6fedc314aa1..15f152167ef 100644 --- a/service/fsx/api_op_CreateBackup.go +++ b/service/fsx/api_op_CreateBackup.go @@ -93,21 +93,21 @@ func (c *Client) CreateBackup(ctx context.Context, params *CreateBackupInput, op // The request object for the CreateBackup operation. type CreateBackupInput struct { - // The tags to apply to the backup at backup creation. The key value of the Name - // tag appears in the console as the backup name. If you have set CopyTagsToBackups - // to true, and you specify one or more tags using the CreateBackup action, no - // existing tags on the file system are copied from the file system to the backup. - Tags []*types.Tag + // The ID of the file system to back up. + // + // This member is required. + FileSystemId *string // A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent // creation. This string is automatically filled on your behalf when you use the // AWS Command Line Interface (AWS CLI) or an AWS SDK. ClientRequestToken *string - // The ID of the file system to back up. - // - // This member is required. - FileSystemId *string + // The tags to apply to the backup at backup creation. The key value of the Name + // tag appears in the console as the backup name. If you have set CopyTagsToBackups + // to true, and you specify one or more tags using the CreateBackup action, no + // existing tags on the file system are copied from the file system to the backup. + Tags []*types.Tag } // The response object for the CreateBackup operation. diff --git a/service/fsx/api_op_CreateDataRepositoryTask.go b/service/fsx/api_op_CreateDataRepositoryTask.go index 841f32169e9..666578cee8c 100644 --- a/service/fsx/api_op_CreateDataRepositoryTask.go +++ b/service/fsx/api_op_CreateDataRepositoryTask.go @@ -75,35 +75,35 @@ type CreateDataRepositoryTaskInput struct { // This member is required. FileSystemId *string - // (Optional) The path or paths on the Amazon FSx file system to use when the data - // repository task is processed. The default path is the file system root - // directory. The paths you provide need to be relative to the mount point of the - // file system. If the mount point is /mnt/fsx and /mnt/fsx/path1 is a directory or - // file on the file system you want to export, then the path to provide is path1. - // If a path that you provide isn't valid, the task fails. - Paths []*string + // Defines whether or not Amazon FSx provides a CompletionReport once the task has + // completed. A CompletionReport provides a detailed report on the files that + // Amazon FSx processed that meet the criteria specified by the Scope parameter. + // For more information, see Working with Task Completion Reports + // (https://docs.aws.amazon.com/fsx/latest/LustreGuide/task-completion-report.html). + // + // This member is required. + Report *types.CompletionReport // Specifies the type of data repository task to create. // // This member is required. Type types.DataRepositoryTaskType - // A list of Tag values, with a maximum of 50 elements. - Tags []*types.Tag - // (Optional) An idempotency token for resource creation, in a string of up to 64 // ASCII characters. This token is automatically filled on your behalf when you use // the AWS Command Line Interface (AWS CLI) or an AWS SDK. ClientRequestToken *string - // Defines whether or not Amazon FSx provides a CompletionReport once the task has - // completed. A CompletionReport provides a detailed report on the files that - // Amazon FSx processed that meet the criteria specified by the Scope parameter. - // For more information, see Working with Task Completion Reports - // (https://docs.aws.amazon.com/fsx/latest/LustreGuide/task-completion-report.html). - // - // This member is required. - Report *types.CompletionReport + // (Optional) The path or paths on the Amazon FSx file system to use when the data + // repository task is processed. The default path is the file system root + // directory. The paths you provide need to be relative to the mount point of the + // file system. If the mount point is /mnt/fsx and /mnt/fsx/path1 is a directory or + // file on the file system you want to export, then the path to provide is path1. + // If a path that you provide isn't valid, the task fails. + Paths []*string + + // A list of Tag values, with a maximum of 50 elements. + Tags []*types.Tag } type CreateDataRepositoryTaskOutput struct { diff --git a/service/fsx/api_op_CreateFileSystem.go b/service/fsx/api_op_CreateFileSystem.go index 2c1e8cefe6e..f58253f1794 100644 --- a/service/fsx/api_op_CreateFileSystem.go +++ b/service/fsx/api_op_CreateFileSystem.go @@ -82,34 +82,6 @@ func (c *Client) CreateFileSystem(ctx context.Context, params *CreateFileSystemI // The request object used to create a new Amazon FSx file system. type CreateFileSystemInput struct { - // The Microsoft Windows configuration for the file system being created. - WindowsConfiguration *types.CreateFileSystemWindowsConfiguration - - // Specifies the IDs of the subnets that the file system will be accessible from. - // For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet - // IDs, one for the preferred file server and one for the standby file server. You - // specify one of these subnets as the preferred subnet using the - // WindowsConfiguration > PreferredSubnetID property. For Windows SINGLE_AZ_1 and - // SINGLE_AZ_2 file system deployment types and Lustre file systems, provide - // exactly one subnet ID. The file server is launched in that subnet's Availability - // Zone. - // - // This member is required. - SubnetIds []*string - - // A list of IDs specifying the security groups to apply to all network interfaces - // created for file system access. This list isn't returned in later requests to - // describe the file system. - SecurityGroupIds []*string - - // A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent - // creation. This string is automatically filled on your behalf when you use the - // AWS Command Line Interface (AWS CLI) or an AWS SDK. - ClientRequestToken *string - - // The Lustre configuration for the file system being created. - LustreConfiguration *types.CreateFileSystemLustreConfiguration - // The type of Amazon FSx file system to create, either WINDOWS or LUSTRE. // // This member is required. @@ -136,6 +108,23 @@ type CreateFileSystemInput struct { // This member is required. StorageCapacity *int32 + // Specifies the IDs of the subnets that the file system will be accessible from. + // For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet + // IDs, one for the preferred file server and one for the standby file server. You + // specify one of these subnets as the preferred subnet using the + // WindowsConfiguration > PreferredSubnetID property. For Windows SINGLE_AZ_1 and + // SINGLE_AZ_2 file system deployment types and Lustre file systems, provide + // exactly one subnet ID. The file server is launched in that subnet's Availability + // Zone. + // + // This member is required. + SubnetIds []*string + + // A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent + // creation. This string is automatically filled on your behalf when you use the + // AWS Command Line Interface (AWS CLI) or an AWS SDK. + ClientRequestToken *string + // The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file // system's data for Amazon FSx for Windows File Server file systems and Amazon FSx // for Lustre PERSISTENT_1 file systems at rest. In either case, if not specified, @@ -146,6 +135,14 @@ type CreateFileSystemInput struct { // AWS Key Management Service API Reference. KmsKeyId *string + // The Lustre configuration for the file system being created. + LustreConfiguration *types.CreateFileSystemLustreConfiguration + + // A list of IDs specifying the security groups to apply to all network interfaces + // created for file system access. This list isn't returned in later requests to + // describe the file system. + SecurityGroupIds []*string + // Sets the storage type for the Amazon FSx for Windows file system you're // creating. Valid values are SSD and HDD. // @@ -165,6 +162,9 @@ type CreateFileSystemInput struct { // The tags to apply to the file system being created. The key value of the Name // tag appears in the console as the file system name. Tags []*types.Tag + + // The Microsoft Windows configuration for the file system being created. + WindowsConfiguration *types.CreateFileSystemWindowsConfiguration } // The response object returned after the file system is created. diff --git a/service/fsx/api_op_CreateFileSystemFromBackup.go b/service/fsx/api_op_CreateFileSystemFromBackup.go index 611daaea5e0..55ae12be195 100644 --- a/service/fsx/api_op_CreateFileSystemFromBackup.go +++ b/service/fsx/api_op_CreateFileSystemFromBackup.go @@ -82,14 +82,11 @@ func (c *Client) CreateFileSystemFromBackup(ctx context.Context, params *CreateF // The request object for the CreateFileSystemFromBackup operation. type CreateFileSystemFromBackupInput struct { - // A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent - // creation. This string is automatically filled on your behalf when you use the - // AWS Command Line Interface (AWS CLI) or an AWS SDK. - ClientRequestToken *string - - // The tags to be applied to the file system at file system creation. The key value - // of the Name tag appears in the console as the file system name. - Tags []*types.Tag + // The ID of the backup. Specifies the backup to use if you're creating a file + // system from an existing backup. + // + // This member is required. + BackupId *string // Specifies the IDs of the subnets that the file system will be accessible from. // For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet @@ -102,18 +99,14 @@ type CreateFileSystemFromBackupInput struct { // This member is required. SubnetIds []*string + // A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent + // creation. This string is automatically filled on your behalf when you use the + // AWS Command Line Interface (AWS CLI) or an AWS SDK. + ClientRequestToken *string + // The Lustre configuration for the file system being created. LustreConfiguration *types.CreateFileSystemLustreConfiguration - // The ID of the backup. Specifies the backup to use if you're creating a file - // system from an existing backup. - // - // This member is required. - BackupId *string - - // The configuration for this Microsoft Windows file system. - WindowsConfiguration *types.CreateFileSystemWindowsConfiguration - // A list of IDs for the security groups that apply to the specified network // interfaces created for file system access. These security groups apply to all // network interfaces. This value isn't returned in later DescribeFileSystem @@ -137,6 +130,13 @@ type CreateFileSystemFromBackupInput struct { // storage only if the original SSD file system had a storage capacity of at least // 2000 GiB. StorageType types.StorageType + + // The tags to be applied to the file system at file system creation. The key value + // of the Name tag appears in the console as the file system name. + Tags []*types.Tag + + // The configuration for this Microsoft Windows file system. + WindowsConfiguration *types.CreateFileSystemWindowsConfiguration } // The response object for the CreateFileSystemFromBackup operation. diff --git a/service/fsx/api_op_DeleteBackup.go b/service/fsx/api_op_DeleteBackup.go index 066fec3fce2..bcc67123e45 100644 --- a/service/fsx/api_op_DeleteBackup.go +++ b/service/fsx/api_op_DeleteBackup.go @@ -78,12 +78,12 @@ type DeleteBackupInput struct { // The response object for DeleteBackup operation. type DeleteBackupOutput struct { - // The lifecycle of the backup. Should be DELETED. - Lifecycle types.BackupLifecycle - // The ID of the backup deleted. BackupId *string + // The lifecycle of the backup. Should be DELETED. + Lifecycle types.BackupLifecycle + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/fsx/api_op_DeleteFileSystem.go b/service/fsx/api_op_DeleteFileSystem.go index fc64904b51d..bc20be1e7f0 100644 --- a/service/fsx/api_op_DeleteFileSystem.go +++ b/service/fsx/api_op_DeleteFileSystem.go @@ -74,23 +74,23 @@ func (c *Client) DeleteFileSystem(ctx context.Context, params *DeleteFileSystemI // The request object for DeleteFileSystem operation. type DeleteFileSystemInput struct { - // The configuration object for the Microsoft Windows file system used in the - // DeleteFileSystem operation. - WindowsConfiguration *types.DeleteFileSystemWindowsConfiguration + // The ID of the file system you want to delete. + // + // This member is required. + FileSystemId *string // A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent // deletion. This is automatically filled on your behalf when using the AWS CLI or // SDK. ClientRequestToken *string - // The ID of the file system you want to delete. - // - // This member is required. - FileSystemId *string - // The configuration object for the Amazon FSx for Lustre file system being deleted // in the DeleteFileSystem operation. LustreConfiguration *types.DeleteFileSystemLustreConfiguration + + // The configuration object for the Microsoft Windows file system used in the + // DeleteFileSystem operation. + WindowsConfiguration *types.DeleteFileSystemWindowsConfiguration } // The response object for the DeleteFileSystem operation. @@ -102,14 +102,14 @@ type DeleteFileSystemOutput struct { // The file system lifecycle for the deletion request. Should be DELETING. Lifecycle types.FileSystemLifecycle - // The response object for the Microsoft Windows file system used in the - // DeleteFileSystem operation. - WindowsResponse *types.DeleteFileSystemWindowsResponse - // The response object for the Amazon FSx for Lustre file system being deleted in // the DeleteFileSystem operation. LustreResponse *types.DeleteFileSystemLustreResponse + // The response object for the Microsoft Windows file system used in the + // DeleteFileSystem operation. + WindowsResponse *types.DeleteFileSystemWindowsResponse + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/fsx/api_op_DescribeBackups.go b/service/fsx/api_op_DescribeBackups.go index d7ab1f80aa1..079a5e9775c 100644 --- a/service/fsx/api_op_DescribeBackups.go +++ b/service/fsx/api_op_DescribeBackups.go @@ -75,23 +75,23 @@ func (c *Client) DescribeBackups(ctx context.Context, params *DescribeBackupsInp // The request object for DescribeBackups operation. type DescribeBackupsInput struct { - // Opaque pagination token returned from a previous DescribeBackups operation - // (String). If a token present, the action continues the list from where the - // returning call left off. - NextToken *string - - // Filters structure. Supported names are file-system-id and backup-type. - Filters []*types.Filter - // IDs of the backups you want to retrieve (String). This overrides any filters. If // any IDs are not found, BackupNotFound will be thrown. BackupIds []*string + // Filters structure. Supported names are file-system-id and backup-type. + Filters []*types.Filter + // Maximum number of backups to return in the response (integer). This parameter // value must be greater than 0. The number of items that Amazon FSx returns is the // minimum of the MaxResults parameter specified in the request and the service's // internal maximum number of items per page. MaxResults *int32 + + // Opaque pagination token returned from a previous DescribeBackups operation + // (String). If a token present, the action continues the list from where the + // returning call left off. + NextToken *string } // Response object for DescribeBackups operation. diff --git a/service/fsx/api_op_DescribeDataRepositoryTasks.go b/service/fsx/api_op_DescribeDataRepositoryTasks.go index 870d31f962c..4e79a82e8b0 100644 --- a/service/fsx/api_op_DescribeDataRepositoryTasks.go +++ b/service/fsx/api_op_DescribeDataRepositoryTasks.go @@ -66,11 +66,6 @@ func (c *Client) DescribeDataRepositoryTasks(ctx context.Context, params *Descri type DescribeDataRepositoryTasksInput struct { - // (Optional) Opaque pagination token returned from a previous operation (String). - // If present, this token indicates from what point you can continue processing the - // request, where the previous NextToken value left off. - NextToken *string - // (Optional) You can use filters to narrow the DescribeDataRepositoryTasks // response to include just tasks for specific file systems, or tasks in a specific // lifecycle state. @@ -80,20 +75,25 @@ type DescribeDataRepositoryTasksInput struct { // integer greater than zero. MaxResults *int32 + // (Optional) Opaque pagination token returned from a previous operation (String). + // If present, this token indicates from what point you can continue processing the + // request, where the previous NextToken value left off. + NextToken *string + // (Optional) IDs of the tasks whose descriptions you want to retrieve (String). TaskIds []*string } type DescribeDataRepositoryTasksOutput struct { + // The collection of data repository task descriptions returned. + DataRepositoryTasks []*types.DataRepositoryTask + // (Optional) Opaque pagination token returned from a previous operation (String). // If present, this token indicates from what point you can continue processing the // request, where the previous NextToken value left off. NextToken *string - // The collection of data repository task descriptions returned. - DataRepositoryTasks []*types.DataRepositoryTask - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/fsx/api_op_ListTagsForResource.go b/service/fsx/api_op_ListTagsForResource.go index fdff36896e8..0dd9e71a77f 100644 --- a/service/fsx/api_op_ListTagsForResource.go +++ b/service/fsx/api_op_ListTagsForResource.go @@ -75,11 +75,6 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes // The request object for ListTagsForResource operation. type ListTagsForResourceInput struct { - // Opaque pagination token returned from a previous ListTagsForResource operation - // (String). If a token present, the action continues the list from where the - // returning call left off. - NextToken *string - // The ARN of the Amazon FSx resource that will have its tags listed. // // This member is required. @@ -90,6 +85,11 @@ type ListTagsForResourceInput struct { // minimum of the MaxResults parameter specified in the request and the service's // internal maximum number of items per page. MaxResults *int32 + + // Opaque pagination token returned from a previous ListTagsForResource operation + // (String). If a token present, the action continues the list from where the + // returning call left off. + NextToken *string } // The response object for ListTagsForResource operation. diff --git a/service/fsx/api_op_TagResource.go b/service/fsx/api_op_TagResource.go index 64b763bef0a..f80cae2570f 100644 --- a/service/fsx/api_op_TagResource.go +++ b/service/fsx/api_op_TagResource.go @@ -58,16 +58,16 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF // The request object for the TagResource operation. type TagResourceInput struct { - // A list of tags for the resource. If a tag with a given key already exists, the - // value is replaced by the one specified in this parameter. + // The Amazon Resource Name (ARN) of the Amazon FSx resource that you want to tag. // // This member is required. - Tags []*types.Tag + ResourceARN *string - // The Amazon Resource Name (ARN) of the Amazon FSx resource that you want to tag. + // A list of tags for the resource. If a tag with a given key already exists, the + // value is replaced by the one specified in this parameter. // // This member is required. - ResourceARN *string + Tags []*types.Tag } // The response object for the TagResource operation. diff --git a/service/fsx/api_op_UntagResource.go b/service/fsx/api_op_UntagResource.go index 1e60c37f39e..ec8aa4b6979 100644 --- a/service/fsx/api_op_UntagResource.go +++ b/service/fsx/api_op_UntagResource.go @@ -57,16 +57,16 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, // The request object for UntagResource action. type UntagResourceInput struct { - // A list of keys of tags on the resource to untag. In case the tag key doesn't - // exist, the call will still succeed to be idempotent. + // The ARN of the Amazon FSx resource to untag. // // This member is required. - TagKeys []*string + ResourceARN *string - // The ARN of the Amazon FSx resource to untag. + // A list of keys of tags on the resource to untag. In case the tag key doesn't + // exist, the call will still succeed to be idempotent. // // This member is required. - ResourceARN *string + TagKeys []*string } // The response object for UntagResource action. diff --git a/service/fsx/api_op_UpdateFileSystem.go b/service/fsx/api_op_UpdateFileSystem.go index f49c077cb30..7a994e001d6 100644 --- a/service/fsx/api_op_UpdateFileSystem.go +++ b/service/fsx/api_op_UpdateFileSystem.go @@ -90,11 +90,20 @@ func (c *Client) UpdateFileSystem(ctx context.Context, params *UpdateFileSystemI // The request object for the UpdateFileSystem operation. type UpdateFileSystemInput struct { + // Identifies the file system that you are updating. + // + // This member is required. + FileSystemId *string + // A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent // updates. This string is automatically filled on your behalf when you use the AWS // Command Line Interface (AWS CLI) or an AWS SDK. ClientRequestToken *string + // The configuration object for Amazon FSx for Lustre file systems used in the + // UpdateFileSystem operation. + LustreConfiguration *types.UpdateFileSystemLustreConfiguration + // Use this parameter to increase the storage capacity of an Amazon FSx for Windows // File Server file system. Specifies the storage capacity target value, GiB, for // the file system you're updating. The storage capacity target value must be at @@ -106,17 +115,8 @@ type UpdateFileSystemInput struct { // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html). StorageCapacity *int32 - // Identifies the file system that you are updating. - // - // This member is required. - FileSystemId *string - // The configuration updates for an Amazon FSx for Windows File Server file system. WindowsConfiguration *types.UpdateFileSystemWindowsConfiguration - - // The configuration object for Amazon FSx for Lustre file systems used in the - // UpdateFileSystem operation. - LustreConfiguration *types.UpdateFileSystemLustreConfiguration } // The response object for the UpdateFileSystem operation. diff --git a/service/fsx/go.mod b/service/fsx/go.mod index 641b7ef7331..2a591ecb975 100644 --- a/service/fsx/go.mod +++ b/service/fsx/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/fsx go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/fsx/types/types.go b/service/fsx/types/types.go index f6dcbc34272..bd26f71d5ad 100644 --- a/service/fsx/types/types.go +++ b/service/fsx/types/types.go @@ -22,20 +22,6 @@ type ActiveDirectoryBackupAttributes struct { // file system. type AdministrativeAction struct { - // Time that the administrative action request was received. - RequestTime *time.Time - - // Describes the target StorageCapacity or ThroughputCapacity value provided in the - // UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative - // actions. - TargetFileSystemValues *FileSystem - - // Provides the percent complete of a STORAGE_OPTIMIZATION administrative action. - ProgressPercent *int32 - - // Provides information about a failed administrative action. - FailureDetails *AdministrativeActionFailureDetails - // Describes the type of administrative action, as follows: // // * @@ -54,6 +40,15 @@ type AdministrativeAction struct { // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html). AdministrativeActionType AdministrativeActionType + // Provides information about a failed administrative action. + FailureDetails *AdministrativeActionFailureDetails + + // Provides the percent complete of a STORAGE_OPTIMIZATION administrative action. + ProgressPercent *int32 + + // Time that the administrative action request was received. + RequestTime *time.Time + // Describes the status of the administrative action, as follows: // // * FAILED - @@ -75,6 +70,11 @@ type AdministrativeAction struct { // Capacity // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html). Status Status + + // Describes the target StorageCapacity or ThroughputCapacity value provided in the + // UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative + // actions. + TargetFileSystemValues *FileSystem } // Provides information about a failed administrative action. @@ -87,52 +87,52 @@ type AdministrativeActionFailureDetails struct { // A backup of an Amazon FSx for file system. type Backup struct { + // The ID of the backup. + // + // This member is required. + BackupId *string + // The time when a particular backup was created. // // This member is required. CreationTime *time.Time - // The ID of the backup. + // Metadata of the file system associated with the backup. This metadata is + // persisted even if the file system is deleted. // // This member is required. - BackupId *string - - // Details explaining any failures that occur when creating a backup. - FailureDetails *BackupFailureDetails - - // The current percent of progress of an asynchronous task. - ProgressPercent *int32 - - // Tags associated with a particular file system. - Tags []*Tag + FileSystem *FileSystem - // The Amazon Resource Name (ARN) for the backup resource. - ResourceARN *string + // The lifecycle status of the backup. + // + // This member is required. + Lifecycle BackupLifecycle // The type of the file system backup. // // This member is required. Type BackupType + // The configuration of the self-managed Microsoft Active Directory (AD) to which + // the Windows File Server instance is joined. + DirectoryInformation *ActiveDirectoryBackupAttributes + + // Details explaining any failures that occur when creating a backup. + FailureDetails *BackupFailureDetails + // The ID of the AWS Key Management Service (AWS KMS) key used to encrypt this // backup of the Amazon FSx for Windows file system's data at rest. Amazon FSx for // Lustre does not support KMS encryption. KmsKeyId *string - // The configuration of the self-managed Microsoft Active Directory (AD) to which - // the Windows File Server instance is joined. - DirectoryInformation *ActiveDirectoryBackupAttributes + // The current percent of progress of an asynchronous task. + ProgressPercent *int32 - // The lifecycle status of the backup. - // - // This member is required. - Lifecycle BackupLifecycle + // The Amazon Resource Name (ARN) for the backup resource. + ResourceARN *string - // Metadata of the file system associated with the backup. This metadata is - // persisted even if the file system is deleted. - // - // This member is required. - FileSystem *FileSystem + // Tags associated with a particular file system. + Tags []*Tag } // If backup creation fails, this structure contains the details of that failure. @@ -157,11 +157,11 @@ type CompletionReport struct { // This member is required. Enabled *bool - // Required if Enabled is set to true. Specifies the scope of the CompletionReport; - // FAILED_FILES_ONLY is the only scope currently supported. When Scope is set to - // FAILED_FILES_ONLY, the CompletionReport only contains information about files - // that the data repository task failed to process. - Scope ReportScope + // Required if Enabled is set to true. Specifies the format of the + // CompletionReport. REPORT_CSV_20191124 is the only format currently supported. + // When Format is set to REPORT_CSV_20191124, the CompletionReport is provided in + // CSV format, and is delivered to {path}/task-{id}/failures.csv. + Format ReportFormat // Required if Enabled is set to true. Specifies the location of the report on the // file system's linked S3 data repository. An absolute path that defines where the @@ -172,16 +172,63 @@ type CompletionReport struct { // ErrorCode. To learn more about a file system's ExportPath, see . Path *string - // Required if Enabled is set to true. Specifies the format of the - // CompletionReport. REPORT_CSV_20191124 is the only format currently supported. - // When Format is set to REPORT_CSV_20191124, the CompletionReport is provided in - // CSV format, and is delivered to {path}/task-{id}/failures.csv. - Format ReportFormat + // Required if Enabled is set to true. Specifies the scope of the CompletionReport; + // FAILED_FILES_ONLY is the only scope currently supported. When Scope is set to + // FAILED_FILES_ONLY, the CompletionReport only contains information about files + // that the data repository task failed to process. + Scope ReportScope } // The Lustre configuration for the file system being created. type CreateFileSystemLustreConfiguration struct { + // (Optional) Use this property to configure the AutoImport feature on the file + // system's linked Amazon S3 data repository. You use AutoImport to update the + // contents of your FSx for Lustre file system automatically with changes that + // occur in the linked S3 data repository. AutoImportPolicy can have the following + // values: + // + // * NONE - (Default) AutoImport is off. Changes in the linked data + // repository are not reflected on the FSx file system. + // + // * NEW - AutoImport is + // on. New files in the linked data repository that do not currently exist in the + // FSx file system are automatically imported. Updates to existing FSx files are + // not imported to the FSx file system. Files deleted from the linked data + // repository are not deleted from the FSx file system. + // + // * NEW_CHANGED - + // AutoImport is on. New files in the linked S3 data repository that do not + // currently exist in the FSx file system are automatically imported. Changes to + // existing FSx files in the linked repository are also automatically imported to + // the FSx file system. Files deleted from the linked data repository are not + // deleted from the FSx file system. + // + // For more information, see Automatically + // import updates from your S3 bucket + // (https://docs.aws.amazon.com/fsx/latest/LustreGuide/autoimport-data-repo.html). + AutoImportPolicy AutoImportPolicyType + + // The number of days to retain automatic backups. Setting this to 0 disables + // automatic backups. You can retain automatic backups for a maximum of 35 days. + // The default is 0. + AutomaticBackupRetentionDays *int32 + + // A boolean flag indicating whether tags for the file system should be copied to + // backups. This value defaults to false. If it's set to true, all tags for the + // file system are copied to all automatic and user-initiated backups where the + // user doesn't specify tags. If this value is true, and you specify one or more + // tags, only the specified tags are copied to backups. If you specify one or more + // tags when creating a user-initiated backup, no tags are copied from the file + // system, regardless of this value. For more information, see Working with backups + // (https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html). + CopyTagsToBackups *bool + + // A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the + // day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 + // specifies 5 AM daily. + DailyAutomaticBackupStartTime *string + // Choose SCRATCH_1 and SCRATCH_2 deployment types when you need temporary storage // and shorter-term processing of data. The SCRATCH_2 deployment type provides // in-transit encryption of data and higher burst throughput capacity than @@ -201,34 +248,6 @@ type CreateFileSystemLustreConfiguration struct { // Data in Transit.

    DeploymentType LustreDeploymentType - // (Optional) For files imported from a data repository, this value determines the - // stripe count and maximum amount of data per file (in MiB) stored on a single - // physical disk. The maximum number of disks that a single file can be striped - // across is limited by the total number of disks that make up the file system. - //

    The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB - // (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

    - ImportedFileChunkSize *int32 - - // A boolean flag indicating whether tags for the file system should be copied to - // backups. This value defaults to false. If it's set to true, all tags for the - // file system are copied to all automatic and user-initiated backups where the - // user doesn't specify tags. If this value is true, and you specify one or more - // tags, only the specified tags are copied to backups. If you specify one or more - // tags when creating a user-initiated backup, no tags are copied from the file - // system, regardless of this value. For more information, see Working with backups - // (https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html). - CopyTagsToBackups *bool - - // A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the - // day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 - // specifies 5 AM daily. - DailyAutomaticBackupStartTime *string - - // The number of days to retain automatic backups. Setting this to 0 disables - // automatic backups. You can retain automatic backups for a maximum of 35 days. - // The default is 0. - AutomaticBackupRetentionDays *int32 - // (Optional) The path in Amazon S3 where the root of your Amazon FSx file system // is exported. The path must use the same Amazon S3 bucket as specified in // ImportPath. You can provide an optional prefix to which new and changed data is @@ -245,6 +264,22 @@ type CreateFileSystemLustreConfiguration struct { // contents of your file system to that export prefix in the Amazon S3 bucket.

    ExportPath *string + // (Optional) The path to the Amazon S3 bucket (including the optional prefix) that + // you're using as the data repository for your Amazon FSx for Lustre file system. + // The root of your FSx for Lustre file system will be mapped to the root of the + // Amazon S3 bucket you select. An example is s3://import-bucket/optional-prefix. + // If you specify a prefix after the Amazon S3 bucket name, only object keys with + // that prefix are loaded into the file system. + ImportPath *string + + // (Optional) For files imported from a data repository, this value determines the + // stripe count and maximum amount of data per file (in MiB) stored on a single + // physical disk. The maximum number of disks that a single file can be striped + // across is limited by the total number of disks that make up the file system. + //

    The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB + // (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

    + ImportedFileChunkSize *int32 + // Required for the PERSISTENT_1 deployment type, describes the amount of read and // write throughput for each 1 tebibyte of storage, in MB/s/TiB. File system // throughput capacity is calculated by multiplying file system storage capacity @@ -254,45 +289,10 @@ type CreateFileSystemLustreConfiguration struct { // Valid values are 50, 100, 200. PerUnitStorageThroughput *int32 - // (Optional) The path to the Amazon S3 bucket (including the optional prefix) that - // you're using as the data repository for your Amazon FSx for Lustre file system. - // The root of your FSx for Lustre file system will be mapped to the root of the - // Amazon S3 bucket you select. An example is s3://import-bucket/optional-prefix. - // If you specify a prefix after the Amazon S3 bucket name, only object keys with - // that prefix are loaded into the file system. - ImportPath *string - // The preferred start time to perform weekly maintenance, formatted d:HH:MM in the // UTC time zone, where d is the weekday number, from 1 through 7, beginning with // Monday and ending with Sunday. WeeklyMaintenanceStartTime *string - - // (Optional) Use this property to configure the AutoImport feature on the file - // system's linked Amazon S3 data repository. You use AutoImport to update the - // contents of your FSx for Lustre file system automatically with changes that - // occur in the linked S3 data repository. AutoImportPolicy can have the following - // values: - // - // * NONE - (Default) AutoImport is off. Changes in the linked data - // repository are not reflected on the FSx file system. - // - // * NEW - AutoImport is - // on. New files in the linked data repository that do not currently exist in the - // FSx file system are automatically imported. Updates to existing FSx files are - // not imported to the FSx file system. Files deleted from the linked data - // repository are not deleted from the FSx file system. - // - // * NEW_CHANGED - - // AutoImport is on. New files in the linked S3 data repository that do not - // currently exist in the FSx file system are automatically imported. Changes to - // existing FSx files in the linked repository are also automatically imported to - // the FSx file system. Files deleted from the linked data repository are not - // deleted from the FSx file system. - // - // For more information, see Automatically - // import updates from your S3 bucket - // (https://docs.aws.amazon.com/fsx/latest/LustreGuide/autoimport-data-repo.html). - AutoImportPolicy AutoImportPolicyType } // The configuration object for the Microsoft Windows file system used in @@ -309,6 +309,11 @@ type CreateFileSystemWindowsConfiguration struct { // the file system should join when it's created. ActiveDirectoryId *string + // The number of days to retain automatic backups. The default is to retain backups + // for 7 days. Setting this value to 0 disables the creation of automatic backups. + // The maximum retention period for backups is 35 days. + AutomaticBackupRetentionDays *int32 + // A boolean flag indicating whether tags for the file system should be copied to // backups. This value defaults to false. If it's set to true, all tags for the // file system are copied to all automatic and user-initiated backups where the @@ -322,28 +327,6 @@ type CreateFileSystemWindowsConfiguration struct { // time zone. DailyAutomaticBackupStartTime *string - // The preferred start time to perform weekly maintenance, formatted d:HH:MM in the - // UTC time zone, where d is the weekday number, from 1 through 7, beginning with - // Monday and ending with Sunday. - WeeklyMaintenanceStartTime *string - - // The number of days to retain automatic backups. The default is to retain backups - // for 7 days. Setting this value to 0 disables the creation of automatic backups. - // The maximum retention period for backups is 35 days. - AutomaticBackupRetentionDays *int32 - - // Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in - // which you want the preferred file server to be located. For in-AWS applications, - // we recommend that you launch your clients in the same Availability Zone (AZ) as - // your preferred file server to reduce cross-AZ data transfer costs and minimize - // latency. - PreferredSubnetId *string - - // The configuration that Amazon FSx uses to join the Windows File Server instance - // to your self-managed (including on-premises) Microsoft Active Directory (AD) - // directory. - SelfManagedActiveDirectoryConfiguration *SelfManagedActiveDirectoryConfiguration - // Specifies the file system deployment type, valid values are the following: // // @@ -364,11 +347,28 @@ type CreateFileSystemWindowsConfiguration struct { // Single-AZ and Multi-AZ File Systems // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html). DeploymentType WindowsDeploymentType -} - -// The data repository configuration object for Lustre file systems returned in the -// response of the CreateFileSystem operation. -type DataRepositoryConfiguration struct { + + // Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in + // which you want the preferred file server to be located. For in-AWS applications, + // we recommend that you launch your clients in the same Availability Zone (AZ) as + // your preferred file server to reduce cross-AZ data transfer costs and minimize + // latency. + PreferredSubnetId *string + + // The configuration that Amazon FSx uses to join the Windows File Server instance + // to your self-managed (including on-premises) Microsoft Active Directory (AD) + // directory. + SelfManagedActiveDirectoryConfiguration *SelfManagedActiveDirectoryConfiguration + + // The preferred start time to perform weekly maintenance, formatted d:HH:MM in the + // UTC time zone, where d is the weekday number, from 1 through 7, beginning with + // Monday and ending with Sunday. + WeeklyMaintenanceStartTime *string +} + +// The data repository configuration object for Lustre file systems returned in the +// response of the CreateFileSystem operation. +type DataRepositoryConfiguration struct { // Describes the file system's linked S3 data repository's AutoImportPolicy. The // AutoImportPolicy configures how your FSx for Lustre file system automatically @@ -395,10 +395,20 @@ type DataRepositoryConfiguration struct { // import updates from your S3 bucket.

    AutoImportPolicy AutoImportPolicyType + // The export path to the Amazon S3 bucket (and prefix) that you are using to store + // new and changed Lustre file system files in S3. + ExportPath *string + // Provides detailed information about the data respository if its Lifecycle is set // to MISCONFIGURED. FailureDetails *DataRepositoryFailureDetails + // The import path to the Amazon S3 bucket (and optional prefix) that you're using + // as the data repository for your FSx for Lustre file system, for example + // s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 + // bucket name, only object keys with that prefix are loaded into the file system. + ImportPath *string + // For files imported from a data repository, this value determines the stripe // count and maximum amount of data per file (in MiB) stored on a single physical // disk. The maximum number of disks that a single file can be striped across is @@ -407,16 +417,6 @@ type DataRepositoryConfiguration struct { // GiB). Amazon S3 objects have a maximum size of 5 TB.

    ImportedFileChunkSize *int32 - // The export path to the Amazon S3 bucket (and prefix) that you are using to store - // new and changed Lustre file system files in S3. - ExportPath *string - - // The import path to the Amazon S3 bucket (and optional prefix) that you're using - // as the data repository for your FSx for Lustre file system, for example - // s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 - // bucket name, only object keys with that prefix are loaded into the file system. - ImportPath *string - // Describes the state of the file system's S3 durable data repository, if it is // configured with an S3 repository. The lifecycle can have the following values: // @@ -452,65 +452,17 @@ type DataRepositoryFailureDetails struct { // linked data repository. type DataRepositoryTask struct { - // The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify AWS - // resources. We require an ARN when you need to specify a resource unambiguously - // across all of AWS. For more information, see Amazon Resource Names (ARNs) and - // AWS Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference. - ResourceARN *string - - // The type of data repository task; EXPORT_TO_REPOSITORY is the only type - // currently supported. + // The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), + // also known as Unix time. // // This member is required. - Type DataRepositoryTaskType - - // A list of Tag values, with a maximum of 50 elements. - Tags []*Tag - - // Provides a report detailing the data repository task results of the files - // processed that match the criteria specified in the report Scope parameter. FSx - // delivers the report to the file system's linked data repository in Amazon S3, - // using the path specified in the report Path parameter. You can specify whether - // or not a report gets generated for a task using the Enabled parameter. - Report *CompletionReport - - // Failure message describing why the task failed, it is populated only when - // Lifecycle is set to FAILED. - FailureDetails *DataRepositoryTaskFailureDetails + CreationTime *time.Time // The globally unique ID of the file system, assigned by Amazon FSx. // // This member is required. FileSystemId *string - // Provides the status of the number of files that the task has processed - // successfully and failed to process. - Status *DataRepositoryTaskStatus - - // The system-generated, unique 17-digit ID of the data repository task. - // - // This member is required. - TaskId *string - - // The time that Amazon FSx completed processing the task, populated after the task - // is complete. - EndTime *time.Time - - // An array of paths on the Amazon FSx for Lustre file system that specify the data - // for the data repository task to process. For example, in an EXPORT_TO_REPOSITORY - // task, the paths specify which data to export to the linked data repository. - // (Default) If Paths is not specified, Amazon FSx uses the file system root - // directory. - Paths []*string - - // The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), - // also known as Unix time. - // - // This member is required. - CreationTime *time.Time - // The lifecycle status of the data repository task, as follows: // // * PENDING - @@ -542,8 +494,56 @@ type DataRepositoryTask struct { // This member is required. Lifecycle DataRepositoryTaskLifecycle + // The system-generated, unique 17-digit ID of the data repository task. + // + // This member is required. + TaskId *string + + // The type of data repository task; EXPORT_TO_REPOSITORY is the only type + // currently supported. + // + // This member is required. + Type DataRepositoryTaskType + + // The time that Amazon FSx completed processing the task, populated after the task + // is complete. + EndTime *time.Time + + // Failure message describing why the task failed, it is populated only when + // Lifecycle is set to FAILED. + FailureDetails *DataRepositoryTaskFailureDetails + + // An array of paths on the Amazon FSx for Lustre file system that specify the data + // for the data repository task to process. For example, in an EXPORT_TO_REPOSITORY + // task, the paths specify which data to export to the linked data repository. + // (Default) If Paths is not specified, Amazon FSx uses the file system root + // directory. + Paths []*string + + // Provides a report detailing the data repository task results of the files + // processed that match the criteria specified in the report Scope parameter. FSx + // delivers the report to the file system's linked data repository in Amazon S3, + // using the path specified in the report Path parameter. You can specify whether + // or not a report gets generated for a task using the Enabled parameter. + Report *CompletionReport + + // The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify AWS + // resources. We require an ARN when you need to specify a resource unambiguously + // across all of AWS. For more information, see Amazon Resource Names (ARNs) and + // AWS Service Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in + // the AWS General Reference. + ResourceARN *string + // The time that Amazon FSx began processing the task. StartTime *time.Time + + // Provides the status of the number of files that the task has processed + // successfully and failed to process. + Status *DataRepositoryTaskStatus + + // A list of Tag values, with a maximum of 50 elements. + Tags []*Tag } // Provides information about why a data repository task failed. Only populated @@ -561,10 +561,6 @@ type DataRepositoryTaskFailureDetails struct { // the filter. type DataRepositoryTaskFilter struct { - // Use Values to include the specific file system IDs and task lifecycle states for - // the filters you are using. - Values []*string - // Name of the task property to use in filtering the tasks returned in the // response. // @@ -575,6 +571,10 @@ type DataRepositoryTaskFilter struct { // tasks with one or more specific lifecycle states, as follows: CANCELED, // EXECUTING, FAILED, PENDING, and SUCCEEDED. Name DataRepositoryTaskFilterName + + // Use Values to include the specific file system IDs and task lifecycle states for + // the filters you are using. + Values []*string } // Provides the task status showing a running total of the total number of files to @@ -601,16 +601,16 @@ type DataRepositoryTaskStatus struct { // in the DeleteFileSystem operation. type DeleteFileSystemLustreConfiguration struct { - // Set SkipFinalBackup to false if you want to take a final backup of the file - // system you are deleting. By default, Amazon FSx will not take a final backup on - // your behalf when the DeleteFileSystem operation is invoked. (Default = true) - SkipFinalBackup *bool - // Use if SkipFinalBackup is set to false, and you want to apply an array of tags // to the final backup. If you have set the file system property CopyTagsToBackups // to true, and you specify one or more FinalBackupTags when deleting a file // system, Amazon FSx will not copy any existing file system tags to the backup. FinalBackupTags []*Tag + + // Set SkipFinalBackup to false if you want to take a final backup of the file + // system you are deleting. By default, Amazon FSx will not take a final backup on + // your behalf when the DeleteFileSystem operation is invoked. (Default = true) + SkipFinalBackup *bool } // The response object for the Amazon FSx for Lustre file system being deleted in @@ -628,103 +628,52 @@ type DeleteFileSystemLustreResponse struct { // DeleteFileSystem operation. type DeleteFileSystemWindowsConfiguration struct { + // A set of tags for your final backup. + FinalBackupTags []*Tag + // By default, Amazon FSx for Windows takes a final backup on your behalf when the // DeleteFileSystem operation is invoked. Doing this helps protect you from data // loss, and we highly recommend taking the final backup. If you want to skip this // backup, use this flag to do so. SkipFinalBackup *bool - - // A set of tags for your final backup. - FinalBackupTags []*Tag } // The response object for the Microsoft Windows file system used in the // DeleteFileSystem operation. type DeleteFileSystemWindowsResponse struct { - // The set of tags applied to the final backup. - FinalBackupTags []*Tag - // The ID of the final backup for this file system. FinalBackupId *string + + // The set of tags applied to the final backup. + FinalBackupTags []*Tag } // A description of a specific Amazon FSx file system. type FileSystem struct { - // A structure providing details of any failures that occur when creating the file - // system has failed. - FailureDetails *FileSystemFailureDetails - - // The storage capacity of the file system in gigabytes (GB). - StorageCapacity *int32 - - // The IDs of the elastic network interface from which a specific file system is - // accessible. The elastic network interface is automatically created in the same - // VPC that the Amazon FSx file system was created in. For more information, see - // Elastic Network Interfaces - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html) in the - // Amazon EC2 User Guide.

    For an Amazon FSx for Windows File Server file - // system, you can have one network interface ID. For an Amazon FSx for Lustre file - // system, you can have more than one.

    - NetworkInterfaceIds []*string - - // The system-generated, unique 17-digit ID of the file system. - FileSystemId *string - - // Specifies the IDs of the subnets that the file system is accessible from. For - // Windows MULTI_AZ_1 file system deployment type, there are two subnet IDs, one - // for the preferred file server and one for the standby file server. The preferred - // file server subnet identified in the PreferredSubnetID property. All other file - // systems have only one subnet ID. For Lustre file systems, and Single-AZ Windows - // file systems, this is the ID of the subnet that contains the endpoint for the - // file system. For MULTI_AZ_1 Windows file systems, the endpoint for the file - // system is available in the PreferredSubnetID. - SubnetIds []*string - // A list of administrative actions for the file system that are in process or // waiting to be processed. Administrative actions describe changes to the Windows // file system that you have initiated using the UpdateFileSystem action. AdministrativeActions []*AdministrativeAction + // The time that the file system was created, in seconds (since + // 1970-01-01T00:00:00Z), also known as Unix time. + CreationTime *time.Time + // The DNS name for the file system. DNSName *string - // The configuration for the Amazon FSx for Lustre file system. - LustreConfiguration *LustreFileSystemConfiguration - - // The storage type of the file system. Valid values are SSD and HDD. If set to - // SSD, the file system uses solid state drive storage. If set to HDD, the file - // system uses hard disk drive storage. - StorageType StorageType - - // The tags to associate with the file system. For more information, see Tagging - // Your Amazon EC2 Resources - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) in the - // Amazon EC2 User Guide. - Tags []*Tag - - // The Amazon Resource Name (ARN) for the file system resource. - ResourceARN *string + // A structure providing details of any failures that occur when creating the file + // system has failed. + FailureDetails *FileSystemFailureDetails - // The AWS account that created the file system. If the file system was created by - // an AWS Identity and Access Management (IAM) user, the AWS account to which the - // IAM user belongs is the owner. - OwnerId *string + // The system-generated, unique 17-digit ID of the file system. + FileSystemId *string // The type of Amazon FSx file system, either LUSTRE or WINDOWS. FileSystemType FileSystemType - // The configuration for this Microsoft Windows file system. - WindowsConfiguration *WindowsFileSystemConfiguration - - // The ID of the primary VPC for the file system. - VpcId *string - - // The time that the file system was created, in seconds (since - // 1970-01-01T00:00:00Z), also known as Unix time. - CreationTime *time.Time - // The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file // system's data for Amazon FSx for Windows File Server file systems and persistent // Amazon FSx for Lustre file systems at rest. In either case, if not specified, @@ -757,6 +706,57 @@ type FileSystem struct { // * UPDATING indicates that the file system is // undergoing a customer initiated update. Lifecycle FileSystemLifecycle + + // The configuration for the Amazon FSx for Lustre file system. + LustreConfiguration *LustreFileSystemConfiguration + + // The IDs of the elastic network interface from which a specific file system is + // accessible. The elastic network interface is automatically created in the same + // VPC that the Amazon FSx file system was created in. For more information, see + // Elastic Network Interfaces + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html) in the + // Amazon EC2 User Guide.

    For an Amazon FSx for Windows File Server file + // system, you can have one network interface ID. For an Amazon FSx for Lustre file + // system, you can have more than one.

    + NetworkInterfaceIds []*string + + // The AWS account that created the file system. If the file system was created by + // an AWS Identity and Access Management (IAM) user, the AWS account to which the + // IAM user belongs is the owner. + OwnerId *string + + // The Amazon Resource Name (ARN) for the file system resource. + ResourceARN *string + + // The storage capacity of the file system in gigabytes (GB). + StorageCapacity *int32 + + // The storage type of the file system. Valid values are SSD and HDD. If set to + // SSD, the file system uses solid state drive storage. If set to HDD, the file + // system uses hard disk drive storage. + StorageType StorageType + + // Specifies the IDs of the subnets that the file system is accessible from. For + // Windows MULTI_AZ_1 file system deployment type, there are two subnet IDs, one + // for the preferred file server and one for the standby file server. The preferred + // file server subnet identified in the PreferredSubnetID property. All other file + // systems have only one subnet ID. For Lustre file systems, and Single-AZ Windows + // file systems, this is the ID of the subnet that contains the endpoint for the + // file system. For MULTI_AZ_1 Windows file systems, the endpoint for the file + // system is available in the PreferredSubnetID. + SubnetIds []*string + + // The tags to associate with the file system. For more information, see Tagging + // Your Amazon EC2 Resources + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) in the + // Amazon EC2 User Guide. + Tags []*Tag + + // The ID of the primary VPC for the file system. + VpcId *string + + // The configuration for this Microsoft Windows file system. + WindowsConfiguration *WindowsFileSystemConfiguration } // A structure providing details of any failures that occur when creating the file @@ -771,44 +771,21 @@ type FileSystemFailureDetails struct { // filters to return results that meet all applied filter requirements. type Filter struct { - // The values of the filter. These are all the values for any of the applied - // filters. - Values []*string - // The name for this filter. Name FilterName -} - -// The configuration for the Amazon FSx for Lustre file system. -type LustreFileSystemConfiguration struct { - - // You use the MountName value when mounting the file system. For the SCRATCH_1 - // deployment type, this value is always "fsx". For SCRATCH_2 and PERSISTENT_1 - // deployment types, this value is a string that is unique within an AWS Region. - //

    - MountName *string - // The deployment type of the FSX for Lustre file system. Scratch deployment type - // is designed for temporary storage and shorter-term processing of data. SCRATCH_1 - // and SCRATCH_2 deployment types are best suited for when you need temporary - // storage and shorter-term processing of data. The SCRATCH_2 deployment type - // provides in-transit encryption of data and higher burst throughput capacity than - // SCRATCH_1. The PERSISTENT_1 deployment type is used for longer-term storage and - // workloads and encryption of data in transit. To learn more about deployment - // types, see FSx for Lustre Deployment Options - // (https://docs.aws.amazon.com/fsx/latest/LustreGuide/lustre-deployment-types.html). - // (Default = SCRATCH_1) - DeploymentType LustreDeploymentType + // The values of the filter. These are all the values for any of the applied + // filters. + Values []*string +} - // The preferred start time to perform weekly maintenance, formatted d:HH:MM in the - // UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday - // and ending with Sunday. - WeeklyMaintenanceStartTime *string +// The configuration for the Amazon FSx for Lustre file system. +type LustreFileSystemConfiguration struct { - // A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the - // day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 - // specifies 5 AM daily. - DailyAutomaticBackupStartTime *string + // The number of days to retain automatic backups. Setting this to 0 disables + // automatic backups. You can retain automatic backups for a maximum of 35 days. + // The default is 0. + AutomaticBackupRetentionDays *int32 // A boolean flag indicating whether tags on the file system should be copied to // backups. If it's set to true, all tags on the file system are copied to all @@ -819,14 +796,32 @@ type LustreFileSystemConfiguration struct { // regardless of this value. (Default = false) CopyTagsToBackups *bool + // A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the + // day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 + // specifies 5 AM daily. + DailyAutomaticBackupStartTime *string + // The data repository configuration object for Lustre file systems returned in the // response of the CreateFileSystem operation. DataRepositoryConfiguration *DataRepositoryConfiguration - // The number of days to retain automatic backups. Setting this to 0 disables - // automatic backups. You can retain automatic backups for a maximum of 35 days. - // The default is 0. - AutomaticBackupRetentionDays *int32 + // The deployment type of the FSX for Lustre file system. Scratch deployment type + // is designed for temporary storage and shorter-term processing of data. SCRATCH_1 + // and SCRATCH_2 deployment types are best suited for when you need temporary + // storage and shorter-term processing of data. The SCRATCH_2 deployment type + // provides in-transit encryption of data and higher burst throughput capacity than + // SCRATCH_1. The PERSISTENT_1 deployment type is used for longer-term storage and + // workloads and encryption of data in transit. To learn more about deployment + // types, see FSx for Lustre Deployment Options + // (https://docs.aws.amazon.com/fsx/latest/LustreGuide/lustre-deployment-types.html). + // (Default = SCRATCH_1) + DeploymentType LustreDeploymentType + + // You use the MountName value when mounting the file system. For the SCRATCH_1 + // deployment type, this value is always "fsx". For SCRATCH_2 and PERSISTENT_1 + // deployment types, this value is a string that is unique within an AWS Region. + //

    + MountName *string // Per unit storage throughput represents the megabytes per second of read or write // throughput per 1 tebibyte of storage provisioned. File system throughput @@ -834,27 +829,32 @@ type LustreFileSystemConfiguration struct { // (MB/s/TiB). This option is only valid for PERSISTENT_1 deployment types. Valid // values are 50, 100, 200. PerUnitStorageThroughput *int32 + + // The preferred start time to perform weekly maintenance, formatted d:HH:MM in the + // UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday + // and ending with Sunday. + WeeklyMaintenanceStartTime *string } // The configuration of the self-managed Microsoft Active Directory (AD) directory // to which the Windows File Server instance is joined. type SelfManagedActiveDirectoryAttributes struct { - // The fully qualified domain name of the self-managed AD directory. - DomainName *string - - // The fully qualified distinguished name of the organizational unit within the - // self-managed AD directory to which the Windows File Server instance is joined. - OrganizationalUnitDistinguishedName *string - // A list of up to two IP addresses of DNS servers or domain controllers in the // self-managed AD directory. DnsIps []*string + // The fully qualified domain name of the self-managed AD directory. + DomainName *string + // The name of the domain group whose members have administrative privileges for // the FSx file system. FileSystemAdministratorsGroup *string + // The fully qualified distinguished name of the organizational unit within the + // self-managed AD directory to which the Windows File Server instance is joined. + OrganizationalUnitDistinguishedName *string + // The user name for the service account on your self-managed AD domain that FSx // uses to join to your AD domain. UserName *string @@ -865,29 +865,6 @@ type SelfManagedActiveDirectoryAttributes struct { // directory. type SelfManagedActiveDirectoryConfiguration struct { - // (Optional) The name of the domain group whose members are granted administrative - // privileges for the file system. Administrative privileges include taking - // ownership of files and folders, setting audit controls (audit ACLs) on files and - // folders, and administering the file system remotely by using the FSx Remote - // PowerShell. The group that you specify must already exist in your domain. If you - // don't provide one, your AD domain's Domain Admins group is used. - FileSystemAdministratorsGroup *string - - // The user name for the service account on your self-managed AD domain that Amazon - // FSx will use to join to your AD domain. This account must have the permission to - // join computers to the domain in the organizational unit provided in - // OrganizationalUnitDistinguishedName, or in the default location of your AD - // domain. - // - // This member is required. - UserName *string - - // The fully qualified domain name of the self-managed AD directory, such as - // corp.example.com. - // - // This member is required. - DomainName *string - // A list of up to two IP addresses of DNS servers or domain controllers in the // self-managed AD directory. The IP addresses need to be either in the same VPC // CIDR range as the one in which your Amazon FSx file system is being created, or @@ -905,12 +882,35 @@ type SelfManagedActiveDirectoryConfiguration struct { // This member is required. DnsIps []*string + // The fully qualified domain name of the self-managed AD directory, such as + // corp.example.com. + // + // This member is required. + DomainName *string + // The password for the service account on your self-managed AD domain that Amazon // FSx will use to join to your AD domain. // // This member is required. Password *string + // The user name for the service account on your self-managed AD domain that Amazon + // FSx will use to join to your AD domain. This account must have the permission to + // join computers to the domain in the organizational unit provided in + // OrganizationalUnitDistinguishedName, or in the default location of your AD + // domain. + // + // This member is required. + UserName *string + + // (Optional) The name of the domain group whose members are granted administrative + // privileges for the file system. Administrative privileges include taking + // ownership of files and folders, setting audit controls (audit ACLs) on files and + // folders, and administering the file system remotely by using the FSx Remote + // PowerShell. The group that you specify must already exist in your domain. If you + // don't provide one, your AD domain's Domain Admins group is used. + FileSystemAdministratorsGroup *string + // (Optional) The fully qualified distinguished name of the organizational unit // within your self-managed AD directory that the Windows File Server instance will // join. Amazon FSx only accepts OU as the direct parent of the file system. An @@ -926,19 +926,19 @@ type SelfManagedActiveDirectoryConfiguration struct { // to a self-managed Microsoft Active Directory (AD) directory. type SelfManagedActiveDirectoryConfigurationUpdates struct { - // The user name for the service account on your self-managed AD domain that Amazon - // FSx will use to join to your AD domain. This account must have the permission to - // join computers to the domain in the organizational unit provided in - // OrganizationalUnitDistinguishedName. - UserName *string + // A list of up to two IP addresses of DNS servers or domain controllers in the + // self-managed AD directory. + DnsIps []*string // The password for the service account on your self-managed AD domain that Amazon // FSx will use to join to your AD domain. Password *string - // A list of up to two IP addresses of DNS servers or domain controllers in the - // self-managed AD directory. - DnsIps []*string + // The user name for the service account on your self-managed AD domain that Amazon + // FSx will use to join to your AD domain. This account must have the permission to + // join computers to the domain in the organizational unit provided in + // OrganizationalUnitDistinguishedName. + UserName *string } // Specifies a key-value pair for a resource tag. @@ -963,16 +963,6 @@ type Tag struct { // UpdateFileSystem operation. type UpdateFileSystemLustreConfiguration struct { - // The number of days to retain automatic backups. Setting this to 0 disables - // automatic backups. You can retain automatic backups for a maximum of 35 days. - // The default is 0. - AutomaticBackupRetentionDays *int32 - - // A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the - // day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 - // specifies 5 AM daily. - DailyAutomaticBackupStartTime *string - // (Optional) Use this property to configure the AutoImport feature on the file // system's linked Amazon S3 data repository. You use AutoImport to update the // contents of your FSx for Lustre file system automatically with changes that @@ -1000,6 +990,16 @@ type UpdateFileSystemLustreConfiguration struct { // (https://docs.aws.amazon.com/fsx/latest/LustreGuide/autoimport-data-repo.html). AutoImportPolicy AutoImportPolicyType + // The number of days to retain automatic backups. Setting this to 0 disables + // automatic backups. You can retain automatic backups for a maximum of 35 days. + // The default is 0. + AutomaticBackupRetentionDays *int32 + + // A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the + // day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 + // specifies 5 AM daily. + DailyAutomaticBackupStartTime *string + // The preferred start time to perform weekly maintenance, formatted d:HH:MM in the // UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday // and ending with Sunday. @@ -1011,13 +1011,16 @@ type UpdateFileSystemLustreConfiguration struct { // provided in the request. type UpdateFileSystemWindowsConfiguration struct { - // Sets the target value for a file system's throughput capacity, in MB/s, that you - // are updating the file system to. Valid values are 8, 16, 32, 64, 128, 256, 512, - // 1024, 2048. You cannot make a throughput capacity update request if there is an - // existing throughput capacity update request in progress. For more information, - // see Managing Throughput Capacity - // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-throughput-capacity.html). - ThroughputCapacity *int32 + // The number of days to retain automatic daily backups. Setting this to zero (0) + // disables automatic daily backups. You can retain automatic daily backups for a + // maximum of 35 days. For more information, see Working with Automatic Daily + // Backups + // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html#automatic-backups). + AutomaticBackupRetentionDays *int32 + + // The preferred time to start the daily automatic backup, in the UTC time zone, + // for example, 02:00 + DailyAutomaticBackupStartTime *string // The configuration Amazon FSx uses to join the Windows File Server instance to // the self-managed Microsoft AD directory. You cannot make a self-managed @@ -1025,28 +1028,42 @@ type UpdateFileSystemWindowsConfiguration struct { // update request in progress. SelfManagedActiveDirectoryConfiguration *SelfManagedActiveDirectoryConfigurationUpdates - // The preferred time to start the daily automatic backup, in the UTC time zone, - // for example, 02:00 - DailyAutomaticBackupStartTime *string + // Sets the target value for a file system's throughput capacity, in MB/s, that you + // are updating the file system to. Valid values are 8, 16, 32, 64, 128, 256, 512, + // 1024, 2048. You cannot make a throughput capacity update request if there is an + // existing throughput capacity update request in progress. For more information, + // see Managing Throughput Capacity + // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-throughput-capacity.html). + ThroughputCapacity *int32 // The preferred start time to perform weekly maintenance, formatted d:HH:MM in the // UTC time zone. Where d is the weekday number, from 1 through 7, with 1 = Monday // and 7 = Sunday. WeeklyMaintenanceStartTime *string - - // The number of days to retain automatic daily backups. Setting this to zero (0) - // disables automatic daily backups. You can retain automatic daily backups for a - // maximum of 35 days. For more information, see Working with Automatic Daily - // Backups - // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html#automatic-backups). - AutomaticBackupRetentionDays *int32 } // The configuration for this Microsoft Windows file system. type WindowsFileSystemConfiguration struct { - // The list of maintenance operations in progress for this file system. - MaintenanceOperationsInProgress []FileSystemMaintenanceOperation + // The ID for an existing Microsoft Active Directory instance that the file system + // should join when it's created. + ActiveDirectoryId *string + + // The number of days to retain automatic backups. Setting this to 0 disables + // automatic backups. You can retain automatic backups for a maximum of 35 days. + AutomaticBackupRetentionDays *int32 + + // A boolean flag indicating whether tags on the file system should be copied to + // backups. This value defaults to false. If it's set to true, all tags on the file + // system are copied to all automatic backups and any user-initiated backups where + // the user doesn't specify any tags. If this value is true, and you specify one or + // more tags, only the specified tags are copied to backups. If you specify one or + // more tags when creating a user-initiated backup, no tags are copied from the + // file system, regardless of this value. + CopyTagsToBackups *bool + + // The preferred time to take daily automatic backups, in the UTC time zone. + DailyAutomaticBackupStartTime *string // Specifies the file system deployment type, valid values are the following: // @@ -1067,8 +1084,8 @@ type WindowsFileSystemConfiguration struct { // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html). DeploymentType WindowsDeploymentType - // The preferred time to take daily automatic backups, in the UTC time zone. - DailyAutomaticBackupStartTime *string + // The list of maintenance operations in progress for this file system. + MaintenanceOperationsInProgress []FileSystemMaintenanceOperation // For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, // file server. Use this IP address when mounting the file system on Linux SMB @@ -1081,22 +1098,6 @@ type WindowsFileSystemConfiguration struct { // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/accessing-file-shares.html). PreferredFileServerIp *string - // The configuration of the self-managed Microsoft Active Directory (AD) directory - // to which the Windows File Server instance is joined. - SelfManagedActiveDirectoryConfiguration *SelfManagedActiveDirectoryAttributes - - // The ID for an existing Microsoft Active Directory instance that the file system - // should join when it's created. - ActiveDirectoryId *string - - // The preferred start time to perform weekly maintenance, formatted d:HH:MM in the - // UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday - // and ending with Sunday. - WeeklyMaintenanceStartTime *string - - // The throughput of an Amazon FSx file system, measured in megabytes per second. - ThroughputCapacity *int32 - // For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the // preferred file server is located. Must be one of the two subnet IDs specified in // SubnetIds property. Amazon FSx serves traffic from this subnet except in the @@ -1107,23 +1108,22 @@ type WindowsFileSystemConfiguration struct { // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html#single-multi-az-resources) PreferredSubnetId *string - // The number of days to retain automatic backups. Setting this to 0 disables - // automatic backups. You can retain automatic backups for a maximum of 35 days. - AutomaticBackupRetentionDays *int32 - - // A boolean flag indicating whether tags on the file system should be copied to - // backups. This value defaults to false. If it's set to true, all tags on the file - // system are copied to all automatic backups and any user-initiated backups where - // the user doesn't specify any tags. If this value is true, and you specify one or - // more tags, only the specified tags are copied to backups. If you specify one or - // more tags when creating a user-initiated backup, no tags are copied from the - // file system, regardless of this value. - CopyTagsToBackups *bool - // For MULTI_AZ_1 deployment types, use this endpoint when performing // administrative tasks on the file system using Amazon FSx Remote PowerShell. For // SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file // system. This endpoint is temporarily unavailable when the file system is // undergoing maintenance. RemoteAdministrationEndpoint *string + + // The configuration of the self-managed Microsoft Active Directory (AD) directory + // to which the Windows File Server instance is joined. + SelfManagedActiveDirectoryConfiguration *SelfManagedActiveDirectoryAttributes + + // The throughput of an Amazon FSx file system, measured in megabytes per second. + ThroughputCapacity *int32 + + // The preferred start time to perform weekly maintenance, formatted d:HH:MM in the + // UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday + // and ending with Sunday. + WeeklyMaintenanceStartTime *string } diff --git a/service/gamelift/api_op_AcceptMatch.go b/service/gamelift/api_op_AcceptMatch.go index 551abce45c5..9c8956b7670 100644 --- a/service/gamelift/api_op_AcceptMatch.go +++ b/service/gamelift/api_op_AcceptMatch.go @@ -90,11 +90,10 @@ func (c *Client) AcceptMatch(ctx context.Context, params *AcceptMatchInput, optF // Represents the input for a request action. type AcceptMatchInput struct { - // A unique identifier for a matchmaking ticket. The ticket must be in status - // REQUIRES_ACCEPTANCE; otherwise this request will fail. + // Player response to the proposed match. // // This member is required. - TicketId *string + AcceptanceType types.AcceptanceType // A unique identifier for a player delivering the response. This parameter can // include one or multiple player IDs. @@ -102,10 +101,11 @@ type AcceptMatchInput struct { // This member is required. PlayerIds []*string - // Player response to the proposed match. + // A unique identifier for a matchmaking ticket. The ticket must be in status + // REQUIRES_ACCEPTANCE; otherwise this request will fail. // // This member is required. - AcceptanceType types.AcceptanceType + TicketId *string } type AcceptMatchOutput struct { diff --git a/service/gamelift/api_op_CreateAlias.go b/service/gamelift/api_op_CreateAlias.go index b8c4a845f81..a82c6237a30 100644 --- a/service/gamelift/api_op_CreateAlias.go +++ b/service/gamelift/api_op_CreateAlias.go @@ -90,6 +90,15 @@ type CreateAliasInput struct { // This member is required. Name *string + // The routing configuration, including routing type and fleet target, for the + // alias. + // + // This member is required. + RoutingStrategy *types.RoutingStrategy + + // A human-readable description of the alias. + Description *string + // A list of labels to assign to the new alias resource. Tags are developer-defined // key-value pairs. Tagging AWS resources are useful for resource management, // access management and cost allocation. For more information, see Tagging AWS @@ -99,15 +108,6 @@ type CreateAliasInput struct { // The maximum tag limit may be lower than stated. See the AWS General Reference // for actual tagging limits. Tags []*types.Tag - - // A human-readable description of the alias. - Description *string - - // The routing configuration, including routing type and fleet target, for the - // alias. - // - // This member is required. - RoutingStrategy *types.RoutingStrategy } // Represents the returned data in response to a request action. diff --git a/service/gamelift/api_op_CreateBuild.go b/service/gamelift/api_op_CreateBuild.go index a1151ed23df..42121958041 100644 --- a/service/gamelift/api_op_CreateBuild.go +++ b/service/gamelift/api_op_CreateBuild.go @@ -102,13 +102,6 @@ func (c *Client) CreateBuild(ctx context.Context, params *CreateBuildInput, optF // Represents the input for a request action. type CreateBuildInput struct { - // Information indicating where your game build files are stored. Use this - // parameter only when creating a build with files stored in an S3 bucket that you - // own. The storage location must specify an S3 bucket name and key. The location - // must also specify a role ARN that you set up to allow Amazon GameLift to access - // your S3 bucket. The S3 bucket and your new build must be in the same Region. - StorageLocation *types.S3Location - // A descriptive label that is associated with a build. Build names do not need to // be unique. You can use UpdateBuild () to change this value later. Name *string @@ -121,6 +114,13 @@ type CreateBuildInput struct { // changed later. OperatingSystem types.OperatingSystem + // Information indicating where your game build files are stored. Use this + // parameter only when creating a build with files stored in an S3 bucket that you + // own. The storage location must specify an S3 bucket name and key. The location + // must also specify a role ARN that you set up to allow Amazon GameLift to access + // your S3 bucket. The S3 bucket and your new build must be in the same Region. + StorageLocation *types.S3Location + // A list of labels to assign to the new build resource. Tags are developer-defined // key-value pairs. Tagging AWS resources are useful for resource management, // access management and cost allocation. For more information, see Tagging AWS @@ -139,12 +139,12 @@ type CreateBuildInput struct { // Represents the returned data in response to a request action. type CreateBuildOutput struct { - // Amazon S3 location for your game build file, including bucket name and key. - StorageLocation *types.S3Location - // The newly created build resource, including a unique build IDs and status. Build *types.Build + // Amazon S3 location for your game build file, including bucket name and key. + StorageLocation *types.S3Location + // This element is returned only when the operation is called without a storage // location. It contains credentials to use when you are uploading a build file to // an S3 bucket that is owned by Amazon GameLift. Credentials have a limited life diff --git a/service/gamelift/api_op_CreateFleet.go b/service/gamelift/api_op_CreateFleet.go index 904dcc47b2e..6a2d8b340c4 100644 --- a/service/gamelift/api_op_CreateFleet.go +++ b/service/gamelift/api_op_CreateFleet.go @@ -89,24 +89,63 @@ func (c *Client) CreateFleet(ctx context.Context, params *CreateFleetInput, optF // Represents the input for a request action. type CreateFleetInput struct { - // A unique identifier for the AWS account with the VPC that you want to peer your - // Amazon GameLift fleet with. You can find your account ID in the AWS Management - // Console under account settings. - PeerVpcAwsAccountId *string + // The name of an EC2 instance type that is supported in Amazon GameLift. A fleet + // instance type determines the computing resources of each instance in the fleet, + // including CPU, memory, storage, and networking capacity. Amazon GameLift + // supports the following EC2 instance types. See Amazon EC2 Instance Types + // (http://aws.amazon.com/ec2/instance-types/) for detailed descriptions. + // + // This member is required. + EC2InstanceType types.EC2InstanceType - // Instructions for launching server processes on each instance in the fleet. - // Server processes run either a custom game build executable or a Realtime script. - // The runtime configuration defines the server executables or launch script file, - // launch parameters, and the number of processes to run concurrently on each - // instance. When creating a fleet, the runtime configuration must have at least - // one server process configuration; otherwise the request fails with an invalid - // request exception. (This parameter replaces the parameters ServerLaunchPath and - // ServerLaunchParameters, although requests that contain values for these - // parameters instead of a runtime configuration will continue to work.) This - // parameter is required unless the parameters ServerLaunchPath and - // ServerLaunchParameters are defined. Runtime configuration replaced these - // parameters, but fleets that use them will continue to work. - RuntimeConfiguration *types.RuntimeConfiguration + // A descriptive label that is associated with a fleet. Fleet names do not need to + // be unique. + // + // This member is required. + Name *string + + // A unique identifier for a build to be deployed on the new fleet. You can use + // either the build ID or ARN value. The custom game server build must have been + // successfully uploaded to Amazon GameLift and be in a READY status. This fleet + // setting cannot be changed once the fleet is created. + BuildId *string + + // Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS + // certificates are used for encrypting traffic between game clients and game + // servers running on GameLift. If this parameter is not specified, the default + // value, DISABLED, is used. This fleet setting cannot be changed once the fleet is + // created. Learn more at Securing Client/Server Communication + // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-howitworks.html#gamelift-howitworks-security). + // Note: This feature requires the AWS Certificate Manager (ACM) service, which is + // available in the AWS global partition but not in all other partitions. When + // working in a partition that does not support this feature, a request for a new + // fleet with certificate generation results fails with a 4xx unsupported Region + // error. Valid values include: + // + // * GENERATED - Generate a TLS/SSL certificate + // for this fleet. + // + // * DISABLED - (default) Do not generate a TLS/SSL + // certificate for this fleet. + CertificateConfiguration *types.CertificateConfiguration + + // A human-readable description of a fleet. + Description *string + + // Range of IP addresses and port settings that permit inbound traffic to access + // game sessions that are running on the fleet. For fleets using a custom game + // build, this parameter is required before game sessions running on the fleet can + // accept connections. For Realtime Servers fleets, Amazon GameLift automatically + // sets TCP and UDP ranges for use by the Realtime servers. You can specify + // multiple permission settings or add more by updating the fleet. + EC2InboundPermissions []*types.IpPermission + + // Indicates whether to use On-Demand instances or Spot instances for this fleet. + // If empty, the default is ON_DEMAND. Both categories of instances use identical + // hardware and configurations based on the instance type selected for this fleet. + // Learn more about On-Demand versus Spot Instances + // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot). + FleetType types.FleetType // A unique identifier for an AWS IAM role that manages access to your AWS // services. With an instance role ARN set, any application that runs on an @@ -118,15 +157,12 @@ type CreateFleetInput struct { // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html). InstanceRoleArn *string - // A list of labels to assign to the new fleet resource. Tags are developer-defined - // key-value pairs. Tagging AWS resources are useful for resource management, - // access management and cost allocation. For more information, see Tagging AWS - // Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in - // the AWS General Reference. Once the resource is created, you can use TagResource - // (), UntagResource (), and ListTagsForResource () to add, remove, and view tags. - // The maximum tag limit may be lower than stated. See the AWS General Reference - // for actual tagging limits. - Tags []*types.Tag + // This parameter is no longer used. Instead, to specify where Amazon GameLift + // should store log files once a server process shuts down, use the Amazon GameLift + // server API ProcessReady() and specify one or more directory paths in + // logParameters. See more information in the Server API Reference + // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api-ref.html#gamelift-sdk-server-api-ref-dataypes-process). + LogPaths []*string // The name of an Amazon CloudWatch metric group to add this fleet to. A metric // group aggregates the metrics for all fleets in the group. Specify an existing @@ -134,16 +170,6 @@ type CreateFleetInput struct { // can only be included in one metric group at a time. MetricGroups []*string - // A policy that limits the number of game sessions an individual player can create - // over a span of time for this fleet. - ResourceCreationLimitPolicy *types.ResourceCreationLimitPolicy - - // A unique identifier for a build to be deployed on the new fleet. You can use - // either the build ID or ARN value. The custom game server build must have been - // successfully uploaded to Amazon GameLift and be in a READY status. This fleet - // setting cannot be changed once the fleet is created. - BuildId *string - // A game session protection policy to apply to all instances in this fleet. If // this parameter is not set, instances in this fleet default to no protection. You // can change a fleet's protection policy using UpdateFleetAttributes (), but this @@ -158,88 +184,62 @@ type CreateFleetInput struct { // terminated during a scale-down event. NewGameSessionProtectionPolicy types.ProtectionPolicy + // A unique identifier for the AWS account with the VPC that you want to peer your + // Amazon GameLift fleet with. You can find your account ID in the AWS Management + // Console under account settings. + PeerVpcAwsAccountId *string + + // A unique identifier for a VPC with resources to be accessed by your Amazon + // GameLift fleet. The VPC must be in the same Region as your fleet. To look up a + // VPC ID, use the VPC Dashboard (https://console.aws.amazon.com/vpc/) in the AWS + // Management Console. Learn more about VPC peering in VPC Peering with Amazon + // GameLift Fleets + // (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). + PeerVpcId *string + + // A policy that limits the number of game sessions an individual player can create + // over a span of time for this fleet. + ResourceCreationLimitPolicy *types.ResourceCreationLimitPolicy + + // Instructions for launching server processes on each instance in the fleet. + // Server processes run either a custom game build executable or a Realtime script. + // The runtime configuration defines the server executables or launch script file, + // launch parameters, and the number of processes to run concurrently on each + // instance. When creating a fleet, the runtime configuration must have at least + // one server process configuration; otherwise the request fails with an invalid + // request exception. (This parameter replaces the parameters ServerLaunchPath and + // ServerLaunchParameters, although requests that contain values for these + // parameters instead of a runtime configuration will continue to work.) This + // parameter is required unless the parameters ServerLaunchPath and + // ServerLaunchParameters are defined. Runtime configuration replaced these + // parameters, but fleets that use them will continue to work. + RuntimeConfiguration *types.RuntimeConfiguration + // A unique identifier for a Realtime script to be deployed on the new fleet. You // can use either the script ID or ARN value. The Realtime script must have been // successfully uploaded to Amazon GameLift. This fleet setting cannot be changed // once the fleet is created. ScriptId *string - // Range of IP addresses and port settings that permit inbound traffic to access - // game sessions that are running on the fleet. For fleets using a custom game - // build, this parameter is required before game sessions running on the fleet can - // accept connections. For Realtime Servers fleets, Amazon GameLift automatically - // sets TCP and UDP ranges for use by the Realtime servers. You can specify - // multiple permission settings or add more by updating the fleet. - EC2InboundPermissions []*types.IpPermission - - // The name of an EC2 instance type that is supported in Amazon GameLift. A fleet - // instance type determines the computing resources of each instance in the fleet, - // including CPU, memory, storage, and networking capacity. Amazon GameLift - // supports the following EC2 instance types. See Amazon EC2 Instance Types - // (http://aws.amazon.com/ec2/instance-types/) for detailed descriptions. - // - // This member is required. - EC2InstanceType types.EC2InstanceType - - // A human-readable description of a fleet. - Description *string - // This parameter is no longer used. Instead, specify server launch parameters in // the RuntimeConfiguration parameter. (Requests that specify a server launch path // and launch parameters instead of a runtime configuration will continue to work.) ServerLaunchParameters *string - // Indicates whether to use On-Demand instances or Spot instances for this fleet. - // If empty, the default is ON_DEMAND. Both categories of instances use identical - // hardware and configurations based on the instance type selected for this fleet. - // Learn more about On-Demand versus Spot Instances - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot). - FleetType types.FleetType - - // Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS - // certificates are used for encrypting traffic between game clients and game - // servers running on GameLift. If this parameter is not specified, the default - // value, DISABLED, is used. This fleet setting cannot be changed once the fleet is - // created. Learn more at Securing Client/Server Communication - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-howitworks.html#gamelift-howitworks-security). - // Note: This feature requires the AWS Certificate Manager (ACM) service, which is - // available in the AWS global partition but not in all other partitions. When - // working in a partition that does not support this feature, a request for a new - // fleet with certificate generation results fails with a 4xx unsupported Region - // error. Valid values include: - // - // * GENERATED - Generate a TLS/SSL certificate - // for this fleet. - // - // * DISABLED - (default) Do not generate a TLS/SSL - // certificate for this fleet. - CertificateConfiguration *types.CertificateConfiguration - // This parameter is no longer used. Instead, specify a server launch path using // the RuntimeConfiguration parameter. Requests that specify a server launch path // and launch parameters instead of a runtime configuration will continue to work. ServerLaunchPath *string - // A descriptive label that is associated with a fleet. Fleet names do not need to - // be unique. - // - // This member is required. - Name *string - - // This parameter is no longer used. Instead, to specify where Amazon GameLift - // should store log files once a server process shuts down, use the Amazon GameLift - // server API ProcessReady() and specify one or more directory paths in - // logParameters. See more information in the Server API Reference - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api-ref.html#gamelift-sdk-server-api-ref-dataypes-process). - LogPaths []*string - - // A unique identifier for a VPC with resources to be accessed by your Amazon - // GameLift fleet. The VPC must be in the same Region as your fleet. To look up a - // VPC ID, use the VPC Dashboard (https://console.aws.amazon.com/vpc/) in the AWS - // Management Console. Learn more about VPC peering in VPC Peering with Amazon - // GameLift Fleets - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). - PeerVpcId *string + // A list of labels to assign to the new fleet resource. Tags are developer-defined + // key-value pairs. Tagging AWS resources are useful for resource management, + // access management and cost allocation. For more information, see Tagging AWS + // Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in + // the AWS General Reference. Once the resource is created, you can use TagResource + // (), UntagResource (), and ListTagsForResource () to add, remove, and view tags. + // The maximum tag limit may be lower than stated. See the AWS General Reference + // for actual tagging limits. + Tags []*types.Tag } // Represents the returned data in response to a request action. diff --git a/service/gamelift/api_op_CreateGameServerGroup.go b/service/gamelift/api_op_CreateGameServerGroup.go index ae7c82820ac..9e44c64746f 100644 --- a/service/gamelift/api_op_CreateGameServerGroup.go +++ b/service/gamelift/api_op_CreateGameServerGroup.go @@ -114,17 +114,12 @@ func (c *Client) CreateGameServerGroup(ctx context.Context, params *CreateGameSe type CreateGameServerGroupInput struct { - // The maximum number of instances allowed in the EC2 Auto Scaling group. During - // autoscaling events, GameLift FleetIQ and EC2 do not scale up the group above - // this maximum. + // An identifier for the new game server group. This value is used to generate + // unique ARN identifiers for the EC2 Auto Scaling group and the GameLift FleetIQ + // game server group. The name must be unique per Region per AWS account. // // This member is required. - MaxSize *int32 - - // A list of virtual private cloud (VPC) subnets to use with instances in the game - // server group. By default, all GameLift FleetIQ-supported availability zones are - // used; this parameter allows you to specify VPCs that you've set up. - VpcSubnets []*string + GameServerGroupName *string // A set of EC2 instance types to use when creating instances in the group. The // instance definitions must specify at least two different instance types that are @@ -136,16 +131,29 @@ type CreateGameServerGroupInput struct { // This member is required. InstanceDefinitions []*types.InstanceDefinition - // A list of labels to assign to the new game server group resource. Tags are - // developer-defined key-value pairs. Tagging AWS resources are useful for resource - // management, access management, and cost allocation. For more information, see - // Tagging AWS Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the AWS - // General Reference. Once the resource is created, you can use TagResource (), - // UntagResource (), and ListTagsForResource () to add, remove, and view tags. The - // maximum tag limit may be lower than stated. See the AWS General Reference for - // actual tagging limits. - Tags []*types.Tag + // The EC2 launch template that contains configuration settings and game server + // code to be deployed to all instances in the game server group. You can specify + // the template using either the template name or ID. For help with creating a + // launch template, see Creating a Launch Template for an Auto Scaling Group + // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) + // in the Amazon EC2 Auto Scaling User Guide. + // + // This member is required. + LaunchTemplate *types.LaunchTemplateSpecification + + // The maximum number of instances allowed in the EC2 Auto Scaling group. During + // autoscaling events, GameLift FleetIQ and EC2 do not scale up the group above + // this maximum. + // + // This member is required. + MaxSize *int32 + + // The minimum number of instances allowed in the EC2 Auto Scaling group. During + // autoscaling events, GameLift FleetIQ and EC2 do not scale down the group below + // this minimum. In production, this value should be set to at least 1. + // + // This member is required. + MinSize *int32 // The Amazon Resource Name (ARN // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) for an IAM @@ -156,6 +164,14 @@ type CreateGameServerGroupInput struct { // This member is required. RoleArn *string + // Configuration settings to define a scaling policy for the Auto Scaling group + // that is optimized for game hosting. The scaling policy uses the metric + // "PercentUtilizedGameServers" to maintain a buffer of idle game servers that can + // immediately accommodate new games and players. Once the game server and Auto + // Scaling groups are created, you can update the scaling policy settings directly + // in Auto Scaling Groups. + AutoScalingPolicy *types.GameServerGroupAutoScalingPolicy + // The fallback balancing method to use for the game server group when Spot // instances in a Region become unavailable or are not viable for game hosting. // Once triggered, this method remains active until Spot instances can once again @@ -173,38 +189,6 @@ type CreateGameServerGroupInput struct { // instances. BalancingStrategy types.BalancingStrategy - // An identifier for the new game server group. This value is used to generate - // unique ARN identifiers for the EC2 Auto Scaling group and the GameLift FleetIQ - // game server group. The name must be unique per Region per AWS account. - // - // This member is required. - GameServerGroupName *string - - // The minimum number of instances allowed in the EC2 Auto Scaling group. During - // autoscaling events, GameLift FleetIQ and EC2 do not scale down the group below - // this minimum. In production, this value should be set to at least 1. - // - // This member is required. - MinSize *int32 - - // Configuration settings to define a scaling policy for the Auto Scaling group - // that is optimized for game hosting. The scaling policy uses the metric - // "PercentUtilizedGameServers" to maintain a buffer of idle game servers that can - // immediately accommodate new games and players. Once the game server and Auto - // Scaling groups are created, you can update the scaling policy settings directly - // in Auto Scaling Groups. - AutoScalingPolicy *types.GameServerGroupAutoScalingPolicy - - // The EC2 launch template that contains configuration settings and game server - // code to be deployed to all instances in the game server group. You can specify - // the template using either the template name or ID. For help with creating a - // launch template, see Creating a Launch Template for an Auto Scaling Group - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) - // in the Amazon EC2 Auto Scaling User Guide. - // - // This member is required. - LaunchTemplate *types.LaunchTemplateSpecification - // A flag that indicates whether instances in the game server group are protected // from early termination. Unprotected instances that have active game servers // running may by terminated during a scale-down event, causing players to be @@ -213,6 +197,22 @@ type CreateGameServerGroupInput struct { // be terminated by AWS regardless of protection status. This property is set to // NO_PROTECTION by default. GameServerProtectionPolicy types.GameServerProtectionPolicy + + // A list of labels to assign to the new game server group resource. Tags are + // developer-defined key-value pairs. Tagging AWS resources are useful for resource + // management, access management, and cost allocation. For more information, see + // Tagging AWS Resources + // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the AWS + // General Reference. Once the resource is created, you can use TagResource (), + // UntagResource (), and ListTagsForResource () to add, remove, and view tags. The + // maximum tag limit may be lower than stated. See the AWS General Reference for + // actual tagging limits. + Tags []*types.Tag + + // A list of virtual private cloud (VPC) subnets to use with instances in the game + // server group. By default, all GameLift FleetIQ-supported availability zones are + // used; this parameter allows you to specify VPCs that you've set up. + VpcSubnets []*string } type CreateGameServerGroupOutput struct { diff --git a/service/gamelift/api_op_CreateGameSession.go b/service/gamelift/api_op_CreateGameSession.go index c3682b03f55..d4a7b711663 100644 --- a/service/gamelift/api_op_CreateGameSession.go +++ b/service/gamelift/api_op_CreateGameSession.go @@ -119,9 +119,10 @@ type CreateGameSessionInput struct { // number of concurrent active game sessions one player can have. CreatorId *string - // A descriptive label that is associated with a game session. Session names do not - // need to be unique. - Name *string + // A unique identifier for a fleet to create a game session in. You can use either + // the fleet ID or ARN value. Each request must reference either a fleet ID or + // alias ID, but not both. + FleetId *string // Set of custom properties for a game session, formatted as key:value pairs. These // properties are passed to a game server process in the GameSession () object with @@ -142,11 +143,6 @@ type CreateGameSessionInput struct { // arn:aws:gamelift:::gamesession//.) GameSessionId *string - // A unique identifier for a fleet to create a game session in. You can use either - // the fleet ID or ARN value. Each request must reference either a fleet ID or - // alias ID, but not both. - FleetId *string - // Custom string that uniquely identifies a request for a new game session. Maximum // token length is 48 characters. If provided, this string is included in the new // game session's ID. (A game session ARN has the following format: @@ -154,6 +150,10 @@ type CreateGameSessionInput struct { // after a game session has ended; game session objects are retained for this time // period and then deleted. IdempotencyToken *string + + // A descriptive label that is associated with a game session. Session names do not + // need to be unique. + Name *string } // Represents the returned data in response to a request action. diff --git a/service/gamelift/api_op_CreateGameSessionQueue.go b/service/gamelift/api_op_CreateGameSessionQueue.go index 3d5404efe20..5ffc380eff8 100644 --- a/service/gamelift/api_op_CreateGameSessionQueue.go +++ b/service/gamelift/api_op_CreateGameSessionQueue.go @@ -97,17 +97,6 @@ func (c *Client) CreateGameSessionQueue(ctx context.Context, params *CreateGameS // Represents the input for a request action. type CreateGameSessionQueueInput struct { - // A list of labels to assign to the new game session queue resource. Tags are - // developer-defined key-value pairs. Tagging AWS resources are useful for resource - // management, access management and cost allocation. For more information, see - // Tagging AWS Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the AWS - // General Reference. Once the resource is created, you can use TagResource (), - // UntagResource (), and ListTagsForResource () to add, remove, and view tags. The - // maximum tag limit may be lower than stated. See the AWS General Reference for - // actual tagging limits. - Tags []*types.Tag - // A descriptive label that is associated with game session queue. Queue names must // be unique within each Region. // @@ -119,11 +108,6 @@ type CreateGameSessionQueueInput struct { // Destinations are listed in default preference order. Destinations []*types.GameSessionQueueDestination - // The maximum time, in seconds, that a new game session placement request remains - // in the queue. When a request exceeds this time, the game session placement - // changes to a TIMED_OUT status. - TimeoutInSeconds *int32 - // A collection of latency policies to apply when processing game sessions // placement requests with player latency information. Multiple policies are // evaluated in order of the maximum latency value, starting with the lowest @@ -135,6 +119,22 @@ type CreateGameSessionQueueInput struct { // value for MaximumIndividualPlayerLatencyMilliseconds. If none is set, this API // request fails. PlayerLatencyPolicies []*types.PlayerLatencyPolicy + + // A list of labels to assign to the new game session queue resource. Tags are + // developer-defined key-value pairs. Tagging AWS resources are useful for resource + // management, access management and cost allocation. For more information, see + // Tagging AWS Resources + // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the AWS + // General Reference. Once the resource is created, you can use TagResource (), + // UntagResource (), and ListTagsForResource () to add, remove, and view tags. The + // maximum tag limit may be lower than stated. See the AWS General Reference for + // actual tagging limits. + Tags []*types.Tag + + // The maximum time, in seconds, that a new game session placement request remains + // in the queue. When a request exceeds this time, the game session placement + // changes to a TIMED_OUT status. + TimeoutInSeconds *int32 } // Represents the returned data in response to a request action. diff --git a/service/gamelift/api_op_CreateMatchmakingConfiguration.go b/service/gamelift/api_op_CreateMatchmakingConfiguration.go index 153c9aea5c9..5dc4a730256 100644 --- a/service/gamelift/api_op_CreateMatchmakingConfiguration.go +++ b/service/gamelift/api_op_CreateMatchmakingConfiguration.go @@ -98,19 +98,21 @@ func (c *Client) CreateMatchmakingConfiguration(ctx context.Context, params *Cre // Represents the input for a request action. type CreateMatchmakingConfigurationInput struct { - // A human-readable description of the matchmaking configuration. - Description *string - - // A set of custom properties for a game session, formatted as key-value pairs. - // These properties are passed to a game server process in the GameSession () - // object with a request to start a new game session (see Start a Game Session - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). - // This information is added to the new GameSession () object that is created for a - // successful match. - GameProperties []*types.GameProperty + // A flag that determines whether a match that was created with this configuration + // must be accepted by the matched players. To require acceptance, set to TRUE. + // + // This member is required. + AcceptanceRequired *bool - // An SNS topic ARN that is set up to receive matchmaking notifications. - NotificationTarget *string + // Amazon Resource Name (ARN + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) + // that is assigned to a GameLift game session queue resource and uniquely + // identifies it. ARNs are unique across all Regions. These queues are used when + // placing game sessions for matches that are created with this matchmaking + // configuration. Queues can be located in any Region. + // + // This member is required. + GameSessionQueueArns []*string // A unique identifier for a matchmaking configuration. This name is used to // identify the configuration associated with a matchmaking request or ticket. @@ -118,9 +120,6 @@ type CreateMatchmakingConfigurationInput struct { // This member is required. Name *string - // Information to be added to all events related to this matchmaking configuration. - CustomEventData *string - // The maximum duration, in seconds, that a matchmaking ticket can remain in // process before timing out. Requests that fail due to timing out can be // resubmitted as needed. @@ -128,6 +127,24 @@ type CreateMatchmakingConfigurationInput struct { // This member is required. RequestTimeoutSeconds *int32 + // A unique identifier for a matchmaking rule set to use with this configuration. + // You can use either the rule set name or ARN value. A matchmaking configuration + // can only use rule sets that are defined in the same Region. + // + // This member is required. + RuleSetName *string + + // The length of time (in seconds) to wait for players to accept a proposed match. + // If any player rejects the match or fails to accept before the timeout, the + // ticket continues to look for an acceptable match. + AcceptanceTimeoutSeconds *int32 + + // The number of player slots in a match to keep open for future players. For + // example, assume that the configuration's rule set specifies a match for a single + // 12-person team. If the additional player count is set to 2, only 10 players are + // initially selected for the match. + AdditionalPlayerCount *int32 + // The method used to backfill game sessions that are created with this matchmaking // configuration. Specify MANUAL when your game manages backfill requests manually // or does not use the match backfill feature. Specify AUTOMATIC to have GameLift @@ -137,23 +154,19 @@ type CreateMatchmakingConfigurationInput struct { // (https://docs.aws.amazon.com/gamelift/latest/developerguide/match-backfill.html). BackfillMode types.BackfillMode - // The length of time (in seconds) to wait for players to accept a proposed match. - // If any player rejects the match or fails to accept before the timeout, the - // ticket continues to look for an acceptable match. - AcceptanceTimeoutSeconds *int32 + // Information to be added to all events related to this matchmaking configuration. + CustomEventData *string - // A unique identifier for a matchmaking rule set to use with this configuration. - // You can use either the rule set name or ARN value. A matchmaking configuration - // can only use rule sets that are defined in the same Region. - // - // This member is required. - RuleSetName *string + // A human-readable description of the matchmaking configuration. + Description *string - // A flag that determines whether a match that was created with this configuration - // must be accepted by the matched players. To require acceptance, set to TRUE. - // - // This member is required. - AcceptanceRequired *bool + // A set of custom properties for a game session, formatted as key-value pairs. + // These properties are passed to a game server process in the GameSession () + // object with a request to start a new game session (see Start a Game Session + // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). + // This information is added to the new GameSession () object that is created for a + // successful match. + GameProperties []*types.GameProperty // A set of custom game session properties, formatted as a single string value. // This data is passed to a game server process in the GameSession () object with a @@ -163,11 +176,8 @@ type CreateMatchmakingConfigurationInput struct { // successful match. GameSessionData *string - // The number of player slots in a match to keep open for future players. For - // example, assume that the configuration's rule set specifies a match for a single - // 12-person team. If the additional player count is set to 2, only 10 players are - // initially selected for the match. - AdditionalPlayerCount *int32 + // An SNS topic ARN that is set up to receive matchmaking notifications. + NotificationTarget *string // A list of labels to assign to the new matchmaking configuration resource. Tags // are developer-defined key-value pairs. Tagging AWS resources are useful for @@ -179,16 +189,6 @@ type CreateMatchmakingConfigurationInput struct { // maximum tag limit may be lower than stated. See the AWS General Reference for // actual tagging limits. Tags []*types.Tag - - // Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) - // that is assigned to a GameLift game session queue resource and uniquely - // identifies it. ARNs are unique across all Regions. These queues are used when - // placing game sessions for matches that are created with this matchmaking - // configuration. Queues can be located in any Region. - // - // This member is required. - GameSessionQueueArns []*string } // Represents the returned data in response to a request action. diff --git a/service/gamelift/api_op_CreateMatchmakingRuleSet.go b/service/gamelift/api_op_CreateMatchmakingRuleSet.go index d9a62a769eb..94af8997602 100644 --- a/service/gamelift/api_op_CreateMatchmakingRuleSet.go +++ b/service/gamelift/api_op_CreateMatchmakingRuleSet.go @@ -100,6 +100,19 @@ func (c *Client) CreateMatchmakingRuleSet(ctx context.Context, params *CreateMat // Represents the input for a request action. type CreateMatchmakingRuleSetInput struct { + // A unique identifier for a matchmaking rule set. A matchmaking configuration + // identifies the rule set it uses by this name value. Note that the rule set name + // is different from the optional name field in the rule set body. + // + // This member is required. + Name *string + + // A collection of matchmaking rules, formatted as a JSON string. Comments are not + // allowed in JSON, but most elements support a description field. + // + // This member is required. + RuleSetBody *string + // A list of labels to assign to the new matchmaking rule set resource. Tags are // developer-defined key-value pairs. Tagging AWS resources are useful for resource // management, access management and cost allocation. For more information, see @@ -110,19 +123,6 @@ type CreateMatchmakingRuleSetInput struct { // maximum tag limit may be lower than stated. See the AWS General Reference for // actual tagging limits. Tags []*types.Tag - - // A collection of matchmaking rules, formatted as a JSON string. Comments are not - // allowed in JSON, but most elements support a description field. - // - // This member is required. - RuleSetBody *string - - // A unique identifier for a matchmaking rule set. A matchmaking configuration - // identifies the rule set it uses by this name value. Note that the rule set name - // is different from the optional name field in the rule set body. - // - // This member is required. - Name *string } // Represents the returned data in response to a request action. diff --git a/service/gamelift/api_op_CreatePlayerSession.go b/service/gamelift/api_op_CreatePlayerSession.go index 49f04564ade..25c8890e998 100644 --- a/service/gamelift/api_op_CreatePlayerSession.go +++ b/service/gamelift/api_op_CreatePlayerSession.go @@ -84,10 +84,6 @@ func (c *Client) CreatePlayerSession(ctx context.Context, params *CreatePlayerSe // Represents the input for a request action. type CreatePlayerSessionInput struct { - // Developer-defined information related to a player. Amazon GameLift does not use - // this data, so it can be formatted as needed for use in the game. - PlayerData *string - // A unique identifier for the game session to add a player to. // // This member is required. @@ -97,6 +93,10 @@ type CreatePlayerSessionInput struct { // // This member is required. PlayerId *string + + // Developer-defined information related to a player. Amazon GameLift does not use + // this data, so it can be formatted as needed for use in the game. + PlayerData *string } // Represents the returned data in response to a request action. diff --git a/service/gamelift/api_op_CreateScript.go b/service/gamelift/api_op_CreateScript.go index 3a03b659248..8b5d847efd5 100644 --- a/service/gamelift/api_op_CreateScript.go +++ b/service/gamelift/api_op_CreateScript.go @@ -86,14 +86,20 @@ func (c *Client) CreateScript(ctx context.Context, params *CreateScriptInput, op type CreateScriptInput struct { - // The version that is associated with a build or script. Version strings do not - // need to be unique. You can use UpdateScript () to change this value later. - Version *string - // A descriptive label that is associated with a script. Script names do not need // to be unique. You can use UpdateScript () to change this value later. Name *string + // The location of the Amazon S3 bucket where a zipped file containing your + // Realtime scripts is stored. The storage location must specify the Amazon S3 + // bucket name, the zip file name (the "key"), and a role ARN that allows Amazon + // GameLift to access the Amazon S3 storage location. The S3 bucket must be in the + // same Region where you want to create a new script. By default, Amazon GameLift + // uploads the latest version of the zip file; if you have S3 object versioning + // turned on, you can use the ObjectVersion parameter to specify an earlier + // version. + StorageLocation *types.S3Location + // A list of labels to assign to the new script resource. Tags are // developer-defined key-value pairs. Tagging AWS resources are useful for resource // management, access management and cost allocation. For more information, see @@ -105,6 +111,10 @@ type CreateScriptInput struct { // actual tagging limits. Tags []*types.Tag + // The version that is associated with a build or script. Version strings do not + // need to be unique. You can use UpdateScript () to change this value later. + Version *string + // A data object containing your Realtime scripts and dependencies as a zip file. // The zip file can have one or multiple files. Maximum size of a zip file is 5 MB. // When using the AWS CLI tool to create a script, this parameter is set to the zip @@ -112,16 +122,6 @@ type CreateScriptInput struct { // file data is a binary object. For example: --zip-file // fileb://myRealtimeScript.zip. ZipFile []byte - - // The location of the Amazon S3 bucket where a zipped file containing your - // Realtime scripts is stored. The storage location must specify the Amazon S3 - // bucket name, the zip file name (the "key"), and a role ARN that allows Amazon - // GameLift to access the Amazon S3 storage location. The S3 bucket must be in the - // same Region where you want to create a new script. By default, Amazon GameLift - // uploads the latest version of the zip file; if you have S3 object versioning - // turned on, you can use the ObjectVersion parameter to specify an earlier - // version. - StorageLocation *types.S3Location } type CreateScriptOutput struct { diff --git a/service/gamelift/api_op_CreateVpcPeeringAuthorization.go b/service/gamelift/api_op_CreateVpcPeeringAuthorization.go index a99a9beadae..1547757264d 100644 --- a/service/gamelift/api_op_CreateVpcPeeringAuthorization.go +++ b/service/gamelift/api_op_CreateVpcPeeringAuthorization.go @@ -95,6 +95,13 @@ func (c *Client) CreateVpcPeeringAuthorization(ctx context.Context, params *Crea // Represents the input for a request action. type CreateVpcPeeringAuthorizationInput struct { + // A unique identifier for the AWS account that you use to manage your Amazon + // GameLift fleet. You can find your Account ID in the AWS Management Console under + // account settings. + // + // This member is required. + GameLiftAwsAccountId *string + // A unique identifier for a VPC with resources to be accessed by your Amazon // GameLift fleet. The VPC must be in the same Region where your fleet is deployed. // Look up a VPC ID using the VPC Dashboard (https://console.aws.amazon.com/vpc/) @@ -104,13 +111,6 @@ type CreateVpcPeeringAuthorizationInput struct { // // This member is required. PeerVpcId *string - - // A unique identifier for the AWS account that you use to manage your Amazon - // GameLift fleet. You can find your Account ID in the AWS Management Console under - // account settings. - // - // This member is required. - GameLiftAwsAccountId *string } // Represents the returned data in response to a request action. diff --git a/service/gamelift/api_op_CreateVpcPeeringConnection.go b/service/gamelift/api_op_CreateVpcPeeringConnection.go index 7eae890568c..2247711c631 100644 --- a/service/gamelift/api_op_CreateVpcPeeringConnection.go +++ b/service/gamelift/api_op_CreateVpcPeeringConnection.go @@ -98,6 +98,13 @@ type CreateVpcPeeringConnectionInput struct { // This member is required. FleetId *string + // A unique identifier for the AWS account with the VPC that you want to peer your + // Amazon GameLift fleet with. You can find your Account ID in the AWS Management + // Console under account settings. + // + // This member is required. + PeerVpcAwsAccountId *string + // A unique identifier for a VPC with resources to be accessed by your Amazon // GameLift fleet. The VPC must be in the same Region where your fleet is deployed. // Look up a VPC ID using the VPC Dashboard (https://console.aws.amazon.com/vpc/) @@ -107,13 +114,6 @@ type CreateVpcPeeringConnectionInput struct { // // This member is required. PeerVpcId *string - - // A unique identifier for the AWS account with the VPC that you want to peer your - // Amazon GameLift fleet with. You can find your Account ID in the AWS Management - // Console under account settings. - // - // This member is required. - PeerVpcAwsAccountId *string } type CreateVpcPeeringConnectionOutput struct { diff --git a/service/gamelift/api_op_DeleteGameServerGroup.go b/service/gamelift/api_op_DeleteGameServerGroup.go index ed1e80e4e99..983cabb5553 100644 --- a/service/gamelift/api_op_DeleteGameServerGroup.go +++ b/service/gamelift/api_op_DeleteGameServerGroup.go @@ -91,6 +91,12 @@ func (c *Client) DeleteGameServerGroup(ctx context.Context, params *DeleteGameSe type DeleteGameServerGroupInput struct { + // The unique identifier of the game server group to delete. Use either the + // GameServerGroup () name or ARN value. + // + // This member is required. + GameServerGroupName *string + // The type of delete to perform. Options include: // // * SAFE_DELETE – Terminates @@ -104,12 +110,6 @@ type DeleteGameServerGroupInput struct { // * RETAIN – Does a safe delete of // the game server group but retains the EC2 Auto Scaling group as is. DeleteOption types.GameServerGroupDeleteOption - - // The unique identifier of the game server group to delete. Use either the - // GameServerGroup () name or ARN value. - // - // This member is required. - GameServerGroupName *string } type DeleteGameServerGroupOutput struct { diff --git a/service/gamelift/api_op_DeleteScalingPolicy.go b/service/gamelift/api_op_DeleteScalingPolicy.go index 5b3b6c68945..1ae420d0fed 100644 --- a/service/gamelift/api_op_DeleteScalingPolicy.go +++ b/service/gamelift/api_op_DeleteScalingPolicy.go @@ -86,17 +86,17 @@ func (c *Client) DeleteScalingPolicy(ctx context.Context, params *DeleteScalingP // Represents the input for a request action. type DeleteScalingPolicyInput struct { - // A descriptive label that is associated with a scaling policy. Policy names do - // not need to be unique. - // - // This member is required. - Name *string - // A unique identifier for a fleet to be deleted. You can use either the fleet ID // or ARN value. // // This member is required. FleetId *string + + // A descriptive label that is associated with a scaling policy. Policy names do + // not need to be unique. + // + // This member is required. + Name *string } type DeleteScalingPolicyOutput struct { diff --git a/service/gamelift/api_op_DeleteVpcPeeringConnection.go b/service/gamelift/api_op_DeleteVpcPeeringConnection.go index 343fb1622c1..b50f43484f9 100644 --- a/service/gamelift/api_op_DeleteVpcPeeringConnection.go +++ b/service/gamelift/api_op_DeleteVpcPeeringConnection.go @@ -78,19 +78,19 @@ func (c *Client) DeleteVpcPeeringConnection(ctx context.Context, params *DeleteV // Represents the input for a request action. type DeleteVpcPeeringConnectionInput struct { - // A unique identifier for a VPC peering connection. This value is included in the - // VpcPeeringConnection () object, which can be retrieved by calling - // DescribeVpcPeeringConnections (). - // - // This member is required. - VpcPeeringConnectionId *string - // A unique identifier for a fleet. This fleet specified must match the fleet // referenced in the VPC peering connection record. You can use either the fleet ID // or ARN value. // // This member is required. FleetId *string + + // A unique identifier for a VPC peering connection. This value is included in the + // VpcPeeringConnection () object, which can be retrieved by calling + // DescribeVpcPeeringConnections (). + // + // This member is required. + VpcPeeringConnectionId *string } type DeleteVpcPeeringConnectionOutput struct { diff --git a/service/gamelift/api_op_DescribeFleetCapacity.go b/service/gamelift/api_op_DescribeFleetCapacity.go index bd2233e90bf..d9dcf8a680c 100644 --- a/service/gamelift/api_op_DescribeFleetCapacity.go +++ b/service/gamelift/api_op_DescribeFleetCapacity.go @@ -103,15 +103,15 @@ func (c *Client) DescribeFleetCapacity(ctx context.Context, params *DescribeFlee // Represents the input for a request action. type DescribeFleetCapacityInput struct { + // A unique identifier for a fleet(s) to retrieve capacity information for. You can + // use either the fleet ID or ARN value. + FleetIds []*string + // The maximum number of results to return. Use this parameter with NextToken to // get results as a set of sequential pages. This parameter is ignored when the // request specifies one or a list of fleet IDs. Limit *int32 - // A unique identifier for a fleet(s) to retrieve capacity information for. You can - // use either the fleet ID or ARN value. - FleetIds []*string - // Token that indicates the start of the next sequential page of results. Use the // token that is returned with a previous call to this action. To start at the // beginning of the result set, do not specify a value. This parameter is ignored diff --git a/service/gamelift/api_op_DescribeFleetEvents.go b/service/gamelift/api_op_DescribeFleetEvents.go index d94a14b6069..ad9d54fc846 100644 --- a/service/gamelift/api_op_DescribeFleetEvents.go +++ b/service/gamelift/api_op_DescribeFleetEvents.go @@ -95,11 +95,21 @@ func (c *Client) DescribeFleetEvents(ctx context.Context, params *DescribeFleetE // Represents the input for a request action. type DescribeFleetEventsInput struct { + // A unique identifier for a fleet to get event logs for. You can use either the + // fleet ID or ARN value. + // + // This member is required. + FleetId *string + // Most recent date to retrieve event logs for. If no end time is specified, this // call returns entries from the specified start time up to the present. Format is // a number expressed in Unix time as milliseconds (ex: "1469498468.057"). EndTime *time.Time + // The maximum number of results to return. Use this parameter with NextToken to + // get results as a set of sequential pages. + Limit *int32 + // Token that indicates the start of the next sequential page of results. Use the // token that is returned with a previous call to this action. To start at the // beginning of the result set, do not specify a value. @@ -110,28 +120,18 @@ type DescribeFleetEventsInput struct { // end time. Format is a number expressed in Unix time as milliseconds (ex: // "1469498468.057"). StartTime *time.Time - - // A unique identifier for a fleet to get event logs for. You can use either the - // fleet ID or ARN value. - // - // This member is required. - FleetId *string - - // The maximum number of results to return. Use this parameter with NextToken to - // get results as a set of sequential pages. - Limit *int32 } // Represents the returned data in response to a request action. type DescribeFleetEventsOutput struct { + // A collection of objects containing event log entries for the specified fleet. + Events []*types.Event + // Token that indicates where to resume retrieving results on the next call to this // action. If no token is returned, these results represent the end of the list. NextToken *string - // A collection of objects containing event log entries for the specified fleet. - Events []*types.Event - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/gamelift/api_op_DescribeFleetUtilization.go b/service/gamelift/api_op_DescribeFleetUtilization.go index 7df92f6490e..dce8c38c7b1 100644 --- a/service/gamelift/api_op_DescribeFleetUtilization.go +++ b/service/gamelift/api_op_DescribeFleetUtilization.go @@ -102,6 +102,13 @@ func (c *Client) DescribeFleetUtilization(ctx context.Context, params *DescribeF // Represents the input for a request action. type DescribeFleetUtilizationInput struct { + // A unique identifier for a fleet(s) to retrieve utilization data for. You can use + // either the fleet ID or ARN value. To retrieve attributes for all current fleets, + // do not include this parameter. If the list of fleet identifiers includes fleets + // that don't currently exist, the request succeeds but no attributes for that + // fleet are returned. + FleetIds []*string + // The maximum number of results to return. Use this parameter with NextToken to // get results as a set of sequential pages. This parameter is ignored when the // request specifies one or a list of fleet IDs. @@ -112,26 +119,19 @@ type DescribeFleetUtilizationInput struct { // beginning of the result set, do not specify a value. This parameter is ignored // when the request specifies one or a list of fleet IDs. NextToken *string - - // A unique identifier for a fleet(s) to retrieve utilization data for. You can use - // either the fleet ID or ARN value. To retrieve attributes for all current fleets, - // do not include this parameter. If the list of fleet identifiers includes fleets - // that don't currently exist, the request succeeds but no attributes for that - // fleet are returned. - FleetIds []*string } // Represents the returned data in response to a request action. type DescribeFleetUtilizationOutput struct { - // Token that indicates where to resume retrieving results on the next call to this - // action. If no token is returned, these results represent the end of the list. - NextToken *string - // A collection of objects containing utilization information for each requested // fleet ID. FleetUtilization []*types.FleetUtilization + // Token that indicates where to resume retrieving results on the next call to this + // action. If no token is returned, these results represent the end of the list. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/gamelift/api_op_DescribeGameServer.go b/service/gamelift/api_op_DescribeGameServer.go index 37468c9a987..f029cd9b97e 100644 --- a/service/gamelift/api_op_DescribeGameServer.go +++ b/service/gamelift/api_op_DescribeGameServer.go @@ -78,16 +78,16 @@ func (c *Client) DescribeGameServer(ctx context.Context, params *DescribeGameSer type DescribeGameServerInput struct { - // The identifier for the game server to be retrieved. - // - // This member is required. - GameServerId *string - // An identifier for the game server group where the game server is running. Use // either the GameServerGroup () name or ARN value. // // This member is required. GameServerGroupName *string + + // The identifier for the game server to be retrieved. + // + // This member is required. + GameServerId *string } type DescribeGameServerOutput struct { diff --git a/service/gamelift/api_op_DescribeGameSessionDetails.go b/service/gamelift/api_op_DescribeGameSessionDetails.go index e1e9bd49318..58c4c83323d 100644 --- a/service/gamelift/api_op_DescribeGameSessionDetails.go +++ b/service/gamelift/api_op_DescribeGameSessionDetails.go @@ -90,42 +90,42 @@ func (c *Client) DescribeGameSessionDetails(ctx context.Context, params *Describ // Represents the input for a request action. type DescribeGameSessionDetailsInput struct { + // A unique identifier for an alias associated with the fleet to retrieve all game + // sessions for. You can use either the alias ID or ARN value. + AliasId *string + // A unique identifier for a fleet to retrieve all game sessions active on the // fleet. You can use either the fleet ID or ARN value. FleetId *string - // A unique identifier for an alias associated with the fleet to retrieve all game - // sessions for. You can use either the alias ID or ARN value. - AliasId *string + // A unique identifier for the game session to retrieve. + GameSessionId *string - // Game session status to filter results on. Possible game session statuses include - // ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory). - StatusFilter *string + // The maximum number of results to return. Use this parameter with NextToken to + // get results as a set of sequential pages. + Limit *int32 // Token that indicates the start of the next sequential page of results. Use the // token that is returned with a previous call to this action. To start at the // beginning of the result set, do not specify a value. NextToken *string - // The maximum number of results to return. Use this parameter with NextToken to - // get results as a set of sequential pages. - Limit *int32 - - // A unique identifier for the game session to retrieve. - GameSessionId *string + // Game session status to filter results on. Possible game session statuses include + // ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory). + StatusFilter *string } // Represents the returned data in response to a request action. type DescribeGameSessionDetailsOutput struct { - // Token that indicates where to resume retrieving results on the next call to this - // action. If no token is returned, these results represent the end of the list. - NextToken *string - // A collection of objects containing game session properties and the protection // policy currently in force for each session matching the request. GameSessionDetails []*types.GameSessionDetail + // Token that indicates where to resume retrieving results on the next call to this + // action. If no token is returned, these results represent the end of the list. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/gamelift/api_op_DescribeGameSessionQueues.go b/service/gamelift/api_op_DescribeGameSessionQueues.go index d9a0a06d9e7..4e4abc78c7d 100644 --- a/service/gamelift/api_op_DescribeGameSessionQueues.go +++ b/service/gamelift/api_op_DescribeGameSessionQueues.go @@ -73,14 +73,14 @@ func (c *Client) DescribeGameSessionQueues(ctx context.Context, params *Describe // Represents the input for a request action. type DescribeGameSessionQueuesInput struct { - // A list of queue names to retrieve information for. You can use either the queue - // ID or ARN value. To request settings for all queues, leave this parameter empty. - Names []*string - // The maximum number of results to return. Use this parameter with NextToken to // get results as a set of sequential pages. Limit *int32 + // A list of queue names to retrieve information for. You can use either the queue + // ID or ARN value. To request settings for all queues, leave this parameter empty. + Names []*string + // A token that indicates the start of the next sequential page of results. Use the // token that is returned with a previous call to this action. To start at the // beginning of the result set, do not specify a value. diff --git a/service/gamelift/api_op_DescribeGameSessions.go b/service/gamelift/api_op_DescribeGameSessions.go index c6144afdbec..ad3555c6471 100644 --- a/service/gamelift/api_op_DescribeGameSessions.go +++ b/service/gamelift/api_op_DescribeGameSessions.go @@ -90,10 +90,17 @@ func (c *Client) DescribeGameSessions(ctx context.Context, params *DescribeGameS // Represents the input for a request action. type DescribeGameSessionsInput struct { + // A unique identifier for an alias associated with the fleet to retrieve all game + // sessions for. You can use either the alias ID or ARN value. + AliasId *string + // A unique identifier for a fleet to retrieve all game sessions for. You can use // either the fleet ID or ARN value. FleetId *string + // A unique identifier for the game session to retrieve. + GameSessionId *string + // The maximum number of results to return. Use this parameter with NextToken to // get results as a set of sequential pages. Limit *int32 @@ -103,16 +110,9 @@ type DescribeGameSessionsInput struct { // beginning of the result set, do not specify a value. NextToken *string - // A unique identifier for the game session to retrieve. - GameSessionId *string - // Game session status to filter results on. Possible game session statuses include // ACTIVE, TERMINATED, ACTIVATING, and TERMINATING (the last two are transitory). StatusFilter *string - - // A unique identifier for an alias associated with the fleet to retrieve all game - // sessions for. You can use either the alias ID or ARN value. - AliasId *string } // Represents the returned data in response to a request action. diff --git a/service/gamelift/api_op_DescribeInstances.go b/service/gamelift/api_op_DescribeInstances.go index dd1343624a0..1151ccf38c3 100644 --- a/service/gamelift/api_op_DescribeInstances.go +++ b/service/gamelift/api_op_DescribeInstances.go @@ -72,11 +72,6 @@ func (c *Client) DescribeInstances(ctx context.Context, params *DescribeInstance // Represents the input for a request action. type DescribeInstancesInput struct { - // Token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this action. To start at the - // beginning of the result set, do not specify a value. - NextToken *string - // A unique identifier for a fleet to retrieve instance information for. You can // use either the fleet ID or ARN value. // @@ -90,6 +85,11 @@ type DescribeInstancesInput struct { // The maximum number of results to return. Use this parameter with NextToken to // get results as a set of sequential pages. Limit *int32 + + // Token that indicates the start of the next sequential page of results. Use the + // token that is returned with a previous call to this action. To start at the + // beginning of the result set, do not specify a value. + NextToken *string } // Represents the returned data in response to a request action. diff --git a/service/gamelift/api_op_DescribeMatchmakingConfigurations.go b/service/gamelift/api_op_DescribeMatchmakingConfigurations.go index d51a1a3e854..1e2b0198d4a 100644 --- a/service/gamelift/api_op_DescribeMatchmakingConfigurations.go +++ b/service/gamelift/api_op_DescribeMatchmakingConfigurations.go @@ -90,6 +90,11 @@ type DescribeMatchmakingConfigurationsInput struct { // get results as a set of sequential pages. This parameter is limited to 10. Limit *int32 + // A unique identifier for a matchmaking configuration(s) to retrieve. You can use + // either the configuration name or ARN value. To request all existing + // configurations, leave this parameter empty. + Names []*string + // A token that indicates the start of the next sequential page of results. Use the // token that is returned with a previous call to this action. To start at the // beginning of the result set, do not specify a value. @@ -99,24 +104,19 @@ type DescribeMatchmakingConfigurationsInput struct { // name or ARN value. Use this parameter to retrieve all matchmaking configurations // that use this rule set. RuleSetName *string - - // A unique identifier for a matchmaking configuration(s) to retrieve. You can use - // either the configuration name or ARN value. To request all existing - // configurations, leave this parameter empty. - Names []*string } // Represents the returned data in response to a request action. type DescribeMatchmakingConfigurationsOutput struct { + // A collection of requested matchmaking configurations. + Configurations []*types.MatchmakingConfiguration + // A token that indicates where to resume retrieving results on the next call to // this action. If no token is returned, these results represent the end of the // list. NextToken *string - // A collection of requested matchmaking configurations. - Configurations []*types.MatchmakingConfiguration - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/gamelift/api_op_DescribeMatchmakingRuleSets.go b/service/gamelift/api_op_DescribeMatchmakingRuleSets.go index fed81bf9e44..391cea49c9b 100644 --- a/service/gamelift/api_op_DescribeMatchmakingRuleSets.go +++ b/service/gamelift/api_op_DescribeMatchmakingRuleSets.go @@ -87,6 +87,10 @@ func (c *Client) DescribeMatchmakingRuleSets(ctx context.Context, params *Descri // Represents the input for a request action. type DescribeMatchmakingRuleSetsInput struct { + // The maximum number of results to return. Use this parameter with NextToken to + // get results as a set of sequential pages. + Limit *int32 + // A list of one or more matchmaking rule set names to retrieve details for. (Note: // The rule set name is different from the optional "name" field in the rule set // body.) You can use either the rule set name or ARN value. @@ -96,10 +100,6 @@ type DescribeMatchmakingRuleSetsInput struct { // token that is returned with a previous call to this action. To start at the // beginning of the result set, do not specify a value. NextToken *string - - // The maximum number of results to return. Use this parameter with NextToken to - // get results as a set of sequential pages. - Limit *int32 } // Represents the returned data in response to a request action. diff --git a/service/gamelift/api_op_DescribePlayerSessions.go b/service/gamelift/api_op_DescribePlayerSessions.go index 464aa7711af..b171969fcdd 100644 --- a/service/gamelift/api_op_DescribePlayerSessions.go +++ b/service/gamelift/api_op_DescribePlayerSessions.go @@ -84,14 +84,26 @@ func (c *Client) DescribePlayerSessions(ctx context.Context, params *DescribePla // Represents the input for a request action. type DescribePlayerSessionsInput struct { + // A unique identifier for the game session to retrieve player sessions for. + GameSessionId *string + // The maximum number of results to return. Use this parameter with NextToken to // get results as a set of sequential pages. If a player session ID is specified, // this parameter is ignored. Limit *int32 + // Token that indicates the start of the next sequential page of results. Use the + // token that is returned with a previous call to this action. To start at the + // beginning of the result set, do not specify a value. If a player session ID is + // specified, this parameter is ignored. + NextToken *string + // A unique identifier for a player to retrieve player sessions for. PlayerId *string + // A unique identifier for a player session to retrieve. + PlayerSessionId *string + // Player session status to filter results on. Possible player session statuses // include the following: // @@ -109,18 +121,6 @@ type DescribePlayerSessionsInput struct { // player did not connect and/or was not validated within the timeout limit (60 // seconds). PlayerSessionStatusFilter *string - - // Token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this action. To start at the - // beginning of the result set, do not specify a value. If a player session ID is - // specified, this parameter is ignored. - NextToken *string - - // A unique identifier for the game session to retrieve player sessions for. - GameSessionId *string - - // A unique identifier for a player session to retrieve. - PlayerSessionId *string } // Represents the returned data in response to a request action. diff --git a/service/gamelift/api_op_DescribeScalingPolicies.go b/service/gamelift/api_op_DescribeScalingPolicies.go index e29210f36d7..ffce9ed6249 100644 --- a/service/gamelift/api_op_DescribeScalingPolicies.go +++ b/service/gamelift/api_op_DescribeScalingPolicies.go @@ -134,13 +134,13 @@ type DescribeScalingPoliciesInput struct { // Represents the returned data in response to a request action. type DescribeScalingPoliciesOutput struct { - // A collection of objects containing the scaling policies matching the request. - ScalingPolicies []*types.ScalingPolicy - // Token that indicates where to resume retrieving results on the next call to this // action. If no token is returned, these results represent the end of the list. NextToken *string + // A collection of objects containing the scaling policies matching the request. + ScalingPolicies []*types.ScalingPolicy + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/gamelift/api_op_ListAliases.go b/service/gamelift/api_op_ListAliases.go index 1d1a2d50b6b..69ca27827c1 100644 --- a/service/gamelift/api_op_ListAliases.go +++ b/service/gamelift/api_op_ListAliases.go @@ -74,6 +74,19 @@ func (c *Client) ListAliases(ctx context.Context, params *ListAliasesInput, optF // Represents the input for a request action. type ListAliasesInput struct { + // The maximum number of results to return. Use this parameter with NextToken to + // get results as a set of sequential pages. + Limit *int32 + + // A descriptive label that is associated with an alias. Alias names do not need to + // be unique. + Name *string + + // A token that indicates the start of the next sequential page of results. Use the + // token that is returned with a previous call to this action. To start at the + // beginning of the result set, do not specify a value. + NextToken *string + // The routing type to filter results on. Use this parameter to retrieve only // aliases with a certain routing type. To retrieve all aliases, leave this // parameter empty. Possible routing types include the following: @@ -86,32 +99,19 @@ type ListAliasesInput struct { // be used to display a message to the user. A terminal alias throws a // TerminalRoutingStrategyException with the RoutingStrategy () message embedded. RoutingStrategyType types.RoutingStrategyType - - // A descriptive label that is associated with an alias. Alias names do not need to - // be unique. - Name *string - - // The maximum number of results to return. Use this parameter with NextToken to - // get results as a set of sequential pages. - Limit *int32 - - // A token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this action. To start at the - // beginning of the result set, do not specify a value. - NextToken *string } // Represents the returned data in response to a request action. type ListAliasesOutput struct { + // A collection of alias resources that match the request parameters. + Aliases []*types.Alias + // A token that indicates where to resume retrieving results on the next call to // this action. If no token is returned, these results represent the end of the // list. NextToken *string - // A collection of alias resources that match the request parameters. - Aliases []*types.Alias - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/gamelift/api_op_ListBuilds.go b/service/gamelift/api_op_ListBuilds.go index 53447dad39e..9c8e0d6ed2e 100644 --- a/service/gamelift/api_op_ListBuilds.go +++ b/service/gamelift/api_op_ListBuilds.go @@ -78,6 +78,11 @@ type ListBuildsInput struct { // get results as a set of sequential pages. Limit *int32 + // Token that indicates the start of the next sequential page of results. Use the + // token that is returned with a previous call to this action. To start at the + // beginning of the result set, do not specify a value. + NextToken *string + // Build status to filter results by. To retrieve all builds, leave this parameter // empty. Possible build statuses include the following: // @@ -93,11 +98,6 @@ type ListBuildsInput struct { // FAILED -- The game build upload failed. You cannot create new fleets for this // build. Status types.BuildStatus - - // Token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this action. To start at the - // beginning of the result set, do not specify a value. - NextToken *string } // Represents the returned data in response to a request action. diff --git a/service/gamelift/api_op_ListFleets.go b/service/gamelift/api_op_ListFleets.go index 2795505c470..6fd286d385e 100644 --- a/service/gamelift/api_op_ListFleets.go +++ b/service/gamelift/api_op_ListFleets.go @@ -76,11 +76,6 @@ func (c *Client) ListFleets(ctx context.Context, params *ListFleetsInput, optFns // Represents the input for a request action. type ListFleetsInput struct { - // A unique identifier for a Realtime script to return fleets for. Use this - // parameter to return only fleets using a specified script. Use either the script - // ID or ARN value. To retrieve all fleets, leave this parameter empty. - ScriptId *string - // A unique identifier for a build to return fleets for. Use this parameter to // return only fleets using a specified build. Use either the build ID or ARN // value. To retrieve all fleets, do not include either a BuildId and ScriptID @@ -95,21 +90,26 @@ type ListFleetsInput struct { // token that is returned with a previous call to this action. To start at the // beginning of the result set, do not specify a value. NextToken *string + + // A unique identifier for a Realtime script to return fleets for. Use this + // parameter to return only fleets using a specified script. Use either the script + // ID or ARN value. To retrieve all fleets, leave this parameter empty. + ScriptId *string } // Represents the returned data in response to a request action. type ListFleetsOutput struct { - // Token that indicates where to resume retrieving results on the next call to this - // action. If no token is returned, these results represent the end of the list. - NextToken *string - // Set of fleet IDs matching the list request. You can retrieve additional // information about all returned fleets by passing this result set to a call to // DescribeFleetAttributes (), DescribeFleetCapacity (), or // DescribeFleetUtilization (). FleetIds []*string + // Token that indicates where to resume retrieving results on the next call to this + // action. If no token is returned, these results represent the end of the list. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/gamelift/api_op_ListGameServers.go b/service/gamelift/api_op_ListGameServers.go index 955353f55fa..4f9dcc7881d 100644 --- a/service/gamelift/api_op_ListGameServers.go +++ b/service/gamelift/api_op_ListGameServers.go @@ -78,6 +78,16 @@ func (c *Client) ListGameServers(ctx context.Context, params *ListGameServersInp type ListGameServersInput struct { + // An identifier for the game server group for the game server you want to list. + // Use either the GameServerGroup () name or ARN value. + // + // This member is required. + GameServerGroupName *string + + // The maximum number of results to return. Use this parameter with NextToken to + // get results as a set of sequential pages. + Limit *int32 + // A token that indicates the start of the next sequential page of results. Use the // token that is returned with a previous call to this action. To start at the // beginning of the result set, do not specify a value. @@ -87,16 +97,6 @@ type ListGameServersInput struct { // sort value. If this parameter is left empty, the list of game servers is // returned in no particular order. SortOrder types.SortOrder - - // The maximum number of results to return. Use this parameter with NextToken to - // get results as a set of sequential pages. - Limit *int32 - - // An identifier for the game server group for the game server you want to list. - // Use either the GameServerGroup () name or ARN value. - // - // This member is required. - GameServerGroupName *string } type ListGameServersOutput struct { diff --git a/service/gamelift/api_op_ListScripts.go b/service/gamelift/api_op_ListScripts.go index 242bcc8358e..fd79f886a1e 100644 --- a/service/gamelift/api_op_ListScripts.go +++ b/service/gamelift/api_op_ListScripts.go @@ -82,14 +82,14 @@ type ListScriptsInput struct { type ListScriptsOutput struct { - // A set of properties describing the requested script. - Scripts []*types.Script - // A token that indicates where to resume retrieving results on the next call to // this action. If no token is returned, these results represent the end of the // list. NextToken *string + // A set of properties describing the requested script. + Scripts []*types.Script + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/gamelift/api_op_PutScalingPolicy.go b/service/gamelift/api_op_PutScalingPolicy.go index d346a8aadc8..15c1e1c111c 100644 --- a/service/gamelift/api_op_PutScalingPolicy.go +++ b/service/gamelift/api_op_PutScalingPolicy.go @@ -136,52 +136,12 @@ func (c *Client) PutScalingPolicy(ctx context.Context, params *PutScalingPolicyI // Represents the input for a request action. type PutScalingPolicyInput struct { - // Amount of adjustment to make, based on the scaling adjustment type. - ScalingAdjustment *int32 - - // A descriptive label that is associated with a scaling policy. Policy names do - // not need to be unique. A fleet can have only one scaling policy with the same - // name. + // A unique identifier for a fleet to apply this policy to. You can use either the + // fleet ID or ARN value. The fleet cannot be in any of the following statuses: + // ERROR or DELETING. // // This member is required. - Name *string - - // The type of adjustment to make to a fleet's instance count (see FleetCapacity - // ()): - // - // * ChangeInCapacity -- add (or subtract) the scaling adjustment value - // from the current instance count. Positive values scale up while negative values - // scale down. - // - // * ExactCapacity -- set the instance count to the scaling - // adjustment value. - // - // * PercentChangeInCapacity -- increase or reduce the - // current instance count by the scaling adjustment, read as a percentage. Positive - // values scale up while negative values scale down; for example, a value of "-10" - // scales the fleet down by 10%. - ScalingAdjustmentType types.ScalingAdjustmentType - - // Metric value used to trigger a scaling event. - Threshold *float64 - - // Comparison operator to use when measuring the metric against the threshold - // value. - ComparisonOperator types.ComparisonOperatorType - - // The type of scaling policy to create. For a target-based policy, set the - // parameter MetricName to 'PercentAvailableGameSessions' and specify a - // TargetConfiguration. For a rule-based policy set the following parameters: - // MetricName, ComparisonOperator, Threshold, EvaluationPeriods, - // ScalingAdjustmentType, and ScalingAdjustment. - PolicyType types.PolicyType - - // The settings for a target-based scaling policy. - TargetConfiguration *types.TargetConfiguration - - // Length of time (in minutes) the metric must be at or beyond the threshold before - // a scaling event is triggered. - EvaluationPeriods *int32 + FleetId *string // Name of the Amazon GameLift-defined metric that is used to trigger a scaling // adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon @@ -232,12 +192,52 @@ type PutScalingPolicyInput struct { // This member is required. MetricName types.MetricName - // A unique identifier for a fleet to apply this policy to. You can use either the - // fleet ID or ARN value. The fleet cannot be in any of the following statuses: - // ERROR or DELETING. + // A descriptive label that is associated with a scaling policy. Policy names do + // not need to be unique. A fleet can have only one scaling policy with the same + // name. // // This member is required. - FleetId *string + Name *string + + // Comparison operator to use when measuring the metric against the threshold + // value. + ComparisonOperator types.ComparisonOperatorType + + // Length of time (in minutes) the metric must be at or beyond the threshold before + // a scaling event is triggered. + EvaluationPeriods *int32 + + // The type of scaling policy to create. For a target-based policy, set the + // parameter MetricName to 'PercentAvailableGameSessions' and specify a + // TargetConfiguration. For a rule-based policy set the following parameters: + // MetricName, ComparisonOperator, Threshold, EvaluationPeriods, + // ScalingAdjustmentType, and ScalingAdjustment. + PolicyType types.PolicyType + + // Amount of adjustment to make, based on the scaling adjustment type. + ScalingAdjustment *int32 + + // The type of adjustment to make to a fleet's instance count (see FleetCapacity + // ()): + // + // * ChangeInCapacity -- add (or subtract) the scaling adjustment value + // from the current instance count. Positive values scale up while negative values + // scale down. + // + // * ExactCapacity -- set the instance count to the scaling + // adjustment value. + // + // * PercentChangeInCapacity -- increase or reduce the + // current instance count by the scaling adjustment, read as a percentage. Positive + // values scale up while negative values scale down; for example, a value of "-10" + // scales the fleet down by 10%. + ScalingAdjustmentType types.ScalingAdjustmentType + + // The settings for a target-based scaling policy. + TargetConfiguration *types.TargetConfiguration + + // Metric value used to trigger a scaling event. + Threshold *float64 } // Represents the returned data in response to a request action. diff --git a/service/gamelift/api_op_RegisterGameServer.go b/service/gamelift/api_op_RegisterGameServer.go index b69998b30cc..c372f7aa9b3 100644 --- a/service/gamelift/api_op_RegisterGameServer.go +++ b/service/gamelift/api_op_RegisterGameServer.go @@ -87,16 +87,11 @@ func (c *Client) RegisterGameServer(ctx context.Context, params *RegisterGameSer type RegisterGameServerInput struct { - // A list of labels to assign to the new game server resource. Tags are - // developer-defined key-value pairs. Tagging AWS resources are useful for resource - // management, access management, and cost allocation. For more information, see - // Tagging AWS Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the AWS - // General Reference. Once the resource is created, you can use TagResource (), - // UntagResource (), and ListTagsForResource () to add, remove, and view tags. The - // maximum tag limit may be lower than stated. See the AWS General Reference for - // actual tagging limits. - Tags []*types.Tag + // An identifier for the game server group where the game server is running. You + // can use either the GameServerGroup () name or ARN value. + // + // This member is required. + GameServerGroupName *string // A custom string that uniquely identifies the new game server. Game server IDs // are developer-defined and must be unique across all game server groups in your @@ -105,31 +100,36 @@ type RegisterGameServerInput struct { // This member is required. GameServerId *string - // A set of custom game server properties, formatted as a single string value. This - // data is passed to a game client or service when it requests information on a - // game servers using ListGameServers () or ClaimGameServer (). - GameServerData *string + // The unique identifier for the instance where the game server is running. This ID + // is available in the instance metadata. + // + // This member is required. + InstanceId *string + + // Information needed to make inbound client connections to the game server. This + // might include IP address and port, DNS name, etc. + ConnectionInfo *string // A game server tag that can be used to request sorted lists of game servers using // ListGameServers (). Custom sort keys are developer-defined based on how you want // to organize the retrieved game server information. CustomSortKey *string - // Information needed to make inbound client connections to the game server. This - // might include IP address and port, DNS name, etc. - ConnectionInfo *string - - // The unique identifier for the instance where the game server is running. This ID - // is available in the instance metadata. - // - // This member is required. - InstanceId *string + // A set of custom game server properties, formatted as a single string value. This + // data is passed to a game client or service when it requests information on a + // game servers using ListGameServers () or ClaimGameServer (). + GameServerData *string - // An identifier for the game server group where the game server is running. You - // can use either the GameServerGroup () name or ARN value. - // - // This member is required. - GameServerGroupName *string + // A list of labels to assign to the new game server resource. Tags are + // developer-defined key-value pairs. Tagging AWS resources are useful for resource + // management, access management, and cost allocation. For more information, see + // Tagging AWS Resources + // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the AWS + // General Reference. Once the resource is created, you can use TagResource (), + // UntagResource (), and ListTagsForResource () to add, remove, and view tags. The + // maximum tag limit may be lower than stated. See the AWS General Reference for + // actual tagging limits. + Tags []*types.Tag } type RegisterGameServerOutput struct { diff --git a/service/gamelift/api_op_RequestUploadCredentials.go b/service/gamelift/api_op_RequestUploadCredentials.go index 9afa9263d33..607145b8de9 100644 --- a/service/gamelift/api_op_RequestUploadCredentials.go +++ b/service/gamelift/api_op_RequestUploadCredentials.go @@ -86,14 +86,14 @@ type RequestUploadCredentialsInput struct { // Represents the returned data in response to a request action. type RequestUploadCredentialsOutput struct { + // Amazon S3 path and key, identifying where the game build files are stored. + StorageLocation *types.S3Location + // AWS credentials required when uploading a game build to the storage location. // These credentials have a limited lifespan and are valid only for the build they // were issued for. UploadCredentials *types.AwsCredentials - // Amazon S3 path and key, identifying where the game build files are stored. - StorageLocation *types.S3Location - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/gamelift/api_op_ResolveAlias.go b/service/gamelift/api_op_ResolveAlias.go index f5496d550ee..185864e3059 100644 --- a/service/gamelift/api_op_ResolveAlias.go +++ b/service/gamelift/api_op_ResolveAlias.go @@ -81,14 +81,14 @@ type ResolveAliasInput struct { // Represents the returned data in response to a request action. type ResolveAliasOutput struct { - // The fleet identifier that the alias is pointing to. - FleetId *string - // The Amazon Resource Name (ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) // associated with the GameLift fleet resource that this alias points to. FleetArn *string + // The fleet identifier that the alias is pointing to. + FleetId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/gamelift/api_op_ResumeGameServerGroup.go b/service/gamelift/api_op_ResumeGameServerGroup.go index 4893d8f6d5b..46bd940882c 100644 --- a/service/gamelift/api_op_ResumeGameServerGroup.go +++ b/service/gamelift/api_op_ResumeGameServerGroup.go @@ -84,16 +84,16 @@ func (c *Client) ResumeGameServerGroup(ctx context.Context, params *ResumeGameSe type ResumeGameServerGroupInput struct { - // The action to resume for this game server group. - // - // This member is required. - ResumeActions []types.GameServerGroupAction - // The unique identifier of the game server group to resume activity on. Use either // the GameServerGroup () name or ARN value. // // This member is required. GameServerGroupName *string + + // The action to resume for this game server group. + // + // This member is required. + ResumeActions []types.GameServerGroupAction } type ResumeGameServerGroupOutput struct { diff --git a/service/gamelift/api_op_SearchGameSessions.go b/service/gamelift/api_op_SearchGameSessions.go index 2225d8a1347..b513a520703 100644 --- a/service/gamelift/api_op_SearchGameSessions.go +++ b/service/gamelift/api_op_SearchGameSessions.go @@ -132,6 +132,11 @@ func (c *Client) SearchGameSessions(ctx context.Context, params *SearchGameSessi // Represents the input for a request action. type SearchGameSessionsInput struct { + // A unique identifier for an alias associated with the fleet to search for active + // game sessions. You can use either the alias ID or ARN value. Each request must + // reference either a fleet ID or alias ID, but not both. + AliasId *string + // String containing the search criteria for the session search. If no filter // expression is included, the request returns results for all game sessions in the // fleet that are in ACTIVE status. A filter expression can contain one or multiple @@ -174,6 +179,21 @@ type SearchGameSessionsInput struct { // slot: "maximumSessions>=10 AND hasAvailablePlayerSessions=true". FilterExpression *string + // A unique identifier for a fleet to search for active game sessions. You can use + // either the fleet ID or ARN value. Each request must reference either a fleet ID + // or alias ID, but not both. + FleetId *string + + // The maximum number of results to return. Use this parameter with NextToken to + // get results as a set of sequential pages. The maximum number of results returned + // is 20, even if this value is not set or is set higher than 20. + Limit *int32 + + // Token that indicates the start of the next sequential page of results. Use the + // token that is returned with a previous call to this action. To start at the + // beginning of the result set, do not specify a value. + NextToken *string + // Instructions on how to sort the search results. If no sort expression is // included, the request returns results in random order. A sort expression // consists of the following elements: @@ -191,39 +211,19 @@ type SearchGameSessionsInput struct { // Results with a null value for the sort operand are returned at the end of the // list. SortExpression *string - - // Token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this action. To start at the - // beginning of the result set, do not specify a value. - NextToken *string - - // The maximum number of results to return. Use this parameter with NextToken to - // get results as a set of sequential pages. The maximum number of results returned - // is 20, even if this value is not set or is set higher than 20. - Limit *int32 - - // A unique identifier for a fleet to search for active game sessions. You can use - // either the fleet ID or ARN value. Each request must reference either a fleet ID - // or alias ID, but not both. - FleetId *string - - // A unique identifier for an alias associated with the fleet to search for active - // game sessions. You can use either the alias ID or ARN value. Each request must - // reference either a fleet ID or alias ID, but not both. - AliasId *string } // Represents the returned data in response to a request action. type SearchGameSessionsOutput struct { - // Token that indicates where to resume retrieving results on the next call to this - // action. If no token is returned, these results represent the end of the list. - NextToken *string - // A collection of objects containing game session properties for each session // matching the request. GameSessions []*types.GameSession + // Token that indicates where to resume retrieving results on the next call to this + // action. If no token is returned, these results represent the end of the list. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/gamelift/api_op_StartGameSessionPlacement.go b/service/gamelift/api_op_StartGameSessionPlacement.go index 53953510444..ca2925224fb 100644 --- a/service/gamelift/api_op_StartGameSessionPlacement.go +++ b/service/gamelift/api_op_StartGameSessionPlacement.go @@ -119,31 +119,6 @@ func (c *Client) StartGameSessionPlacement(ctx context.Context, params *StartGam // Represents the input for a request action. type StartGameSessionPlacementInput struct { - // Set of custom game session properties, formatted as a single string value. This - // data is passed to a game server process in the GameSession () object with a - // request to start a new game session (see Start a Game Session - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). - GameSessionData *string - - // A descriptive label that is associated with a game session. Session names do not - // need to be unique. - GameSessionName *string - - // Set of custom properties for a game session, formatted as key:value pairs. These - // properties are passed to a game server process in the GameSession () object with - // a request to start a new game session (see Start a Game Session - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). - GameProperties []*types.GameProperty - - // Set of values, expressed in milliseconds, indicating the amount of latency that - // a player experiences when connected to AWS Regions. This information is used to - // try to place the new game session where it can offer the best possible gameplay - // experience for the players. - PlayerLatencies []*types.PlayerLatency - - // Set of information on each player to create a player session for. - DesiredPlayerSessions []*types.DesiredPlayerSession - // Name of the queue to use to place the new game session. You can use either the // queue name or ARN value. // @@ -162,6 +137,31 @@ type StartGameSessionPlacementInput struct { // // This member is required. PlacementId *string + + // Set of information on each player to create a player session for. + DesiredPlayerSessions []*types.DesiredPlayerSession + + // Set of custom properties for a game session, formatted as key:value pairs. These + // properties are passed to a game server process in the GameSession () object with + // a request to start a new game session (see Start a Game Session + // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). + GameProperties []*types.GameProperty + + // Set of custom game session properties, formatted as a single string value. This + // data is passed to a game server process in the GameSession () object with a + // request to start a new game session (see Start a Game Session + // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). + GameSessionData *string + + // A descriptive label that is associated with a game session. Session names do not + // need to be unique. + GameSessionName *string + + // Set of values, expressed in milliseconds, indicating the amount of latency that + // a player experiences when connected to AWS Regions. This information is used to + // try to place the new game session where it can offer the best possible gameplay + // experience for the players. + PlayerLatencies []*types.PlayerLatency } // Represents the returned data in response to a request action. diff --git a/service/gamelift/api_op_StartMatchBackfill.go b/service/gamelift/api_op_StartMatchBackfill.go index 948656e8f2b..d2ba21a68e4 100644 --- a/service/gamelift/api_op_StartMatchBackfill.go +++ b/service/gamelift/api_op_StartMatchBackfill.go @@ -94,6 +94,22 @@ func (c *Client) StartMatchBackfill(ctx context.Context, params *StartMatchBackf // Represents the input for a request action. type StartMatchBackfillInput struct { + // Name of the matchmaker to use for this request. You can use either the + // configuration name or ARN value. The ARN of the matchmaker that was used with + // the original game session is listed in the GameSession () object, MatchmakerData + // property. + // + // This member is required. + ConfigurationName *string + + // Amazon Resource Name (ARN + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) + // that is assigned to a game session and uniquely identifies it. This is the same + // as the game session ID. + // + // This member is required. + GameSessionArn *string + // Match information on all players that are currently assigned to the game // session. This information is used by the matchmaker to find new players and add // them to the existing game. @@ -112,22 +128,6 @@ type StartMatchBackfillInput struct { // This member is required. Players []*types.Player - // Name of the matchmaker to use for this request. You can use either the - // configuration name or ARN value. The ARN of the matchmaker that was used with - // the original game session is listed in the GameSession () object, MatchmakerData - // property. - // - // This member is required. - ConfigurationName *string - - // Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) - // that is assigned to a game session and uniquely identifies it. This is the same - // as the game session ID. - // - // This member is required. - GameSessionArn *string - // A unique identifier for a matchmaking ticket. If no ticket ID is specified here, // Amazon GameLift will generate one in the form of a UUID. Use this identifier to // track the match backfill ticket status and retrieve match results. diff --git a/service/gamelift/api_op_StartMatchmaking.go b/service/gamelift/api_op_StartMatchmaking.go index 3d44786b3fd..8f9d9cf5a1f 100644 --- a/service/gamelift/api_op_StartMatchmaking.go +++ b/service/gamelift/api_op_StartMatchmaking.go @@ -144,11 +144,6 @@ type StartMatchmakingInput struct { // This member is required. ConfigurationName *string - // A unique identifier for a matchmaking ticket. If no ticket ID is specified here, - // Amazon GameLift will generate one in the form of a UUID. Use this identifier to - // track the matchmaking ticket status and retrieve match results. - TicketId *string - // Information on each player to be matched. This information must include a player // ID, and may contain player attributes and latency data to be used in the // matchmaking process. After a successful match, Player objects contain the name @@ -156,6 +151,11 @@ type StartMatchmakingInput struct { // // This member is required. Players []*types.Player + + // A unique identifier for a matchmaking ticket. If no ticket ID is specified here, + // Amazon GameLift will generate one in the form of a UUID. Use this identifier to + // track the matchmaking ticket status and retrieve match results. + TicketId *string } // Represents the returned data in response to a request action. diff --git a/service/gamelift/api_op_SuspendGameServerGroup.go b/service/gamelift/api_op_SuspendGameServerGroup.go index 49c36ca01ee..25bb15c5626 100644 --- a/service/gamelift/api_op_SuspendGameServerGroup.go +++ b/service/gamelift/api_op_SuspendGameServerGroup.go @@ -93,16 +93,16 @@ func (c *Client) SuspendGameServerGroup(ctx context.Context, params *SuspendGame type SuspendGameServerGroupInput struct { - // The action to suspend for this game server group. - // - // This member is required. - SuspendActions []types.GameServerGroupAction - // The unique identifier of the game server group to stop activity on. Use either // the GameServerGroup () name or ARN value. // // This member is required. GameServerGroupName *string + + // The action to suspend for this game server group. + // + // This member is required. + SuspendActions []types.GameServerGroupAction } type SuspendGameServerGroupOutput struct { diff --git a/service/gamelift/api_op_TagResource.go b/service/gamelift/api_op_TagResource.go index c67940d72a5..da082a250b8 100644 --- a/service/gamelift/api_op_TagResource.go +++ b/service/gamelift/api_op_TagResource.go @@ -93,15 +93,6 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // A list of one or more tags to assign to the specified GameLift resource. Tags - // are developer-defined and structured as key-value pairs. The maximum tag limit - // may be lower than stated. See Tagging AWS Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for actual - // tagging limits. - // - // This member is required. - Tags []*types.Tag - // The Amazon Resource Name (ARN // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is // assigned to and uniquely identifies the GameLift resource that you want to @@ -111,6 +102,15 @@ type TagResourceInput struct { // // This member is required. ResourceARN *string + + // A list of one or more tags to assign to the specified GameLift resource. Tags + // are developer-defined and structured as key-value pairs. The maximum tag limit + // may be lower than stated. See Tagging AWS Resources + // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for actual + // tagging limits. + // + // This member is required. + Tags []*types.Tag } type TagResourceOutput struct { diff --git a/service/gamelift/api_op_UpdateAlias.go b/service/gamelift/api_op_UpdateAlias.go index 10ab82da26a..442466704b7 100644 --- a/service/gamelift/api_op_UpdateAlias.go +++ b/service/gamelift/api_op_UpdateAlias.go @@ -75,9 +75,11 @@ func (c *Client) UpdateAlias(ctx context.Context, params *UpdateAliasInput, optF // Represents the input for a request action. type UpdateAliasInput struct { - // The routing configuration, including routing type and fleet target, for the - // alias. - RoutingStrategy *types.RoutingStrategy + // A unique identifier for the alias that you want to update. You can use either + // the alias ID or ARN value. + // + // This member is required. + AliasId *string // A human-readable description of the alias. Description *string @@ -86,11 +88,9 @@ type UpdateAliasInput struct { // be unique. Name *string - // A unique identifier for the alias that you want to update. You can use either - // the alias ID or ARN value. - // - // This member is required. - AliasId *string + // The routing configuration, including routing type and fleet target, for the + // alias. + RoutingStrategy *types.RoutingStrategy } // Represents the returned data in response to a request action. diff --git a/service/gamelift/api_op_UpdateBuild.go b/service/gamelift/api_op_UpdateBuild.go index 2586dcaddcc..54f19952b4d 100644 --- a/service/gamelift/api_op_UpdateBuild.go +++ b/service/gamelift/api_op_UpdateBuild.go @@ -80,13 +80,13 @@ type UpdateBuildInput struct { // This member is required. BuildId *string - // Version information that is associated with a build or script. Version strings - // do not need to be unique. - Version *string - // A descriptive label that is associated with a build. Build names do not need to // be unique. Name *string + + // Version information that is associated with a build or script. Version strings + // do not need to be unique. + Version *string } // Represents the returned data in response to a request action. diff --git a/service/gamelift/api_op_UpdateFleetAttributes.go b/service/gamelift/api_op_UpdateFleetAttributes.go index ba461a72208..bacd990f9d6 100644 --- a/service/gamelift/api_op_UpdateFleetAttributes.go +++ b/service/gamelift/api_op_UpdateFleetAttributes.go @@ -87,6 +87,15 @@ func (c *Client) UpdateFleetAttributes(ctx context.Context, params *UpdateFleetA // Represents the input for a request action. type UpdateFleetAttributesInput struct { + // A unique identifier for a fleet to update attribute metadata for. You can use + // either the fleet ID or ARN value. + // + // This member is required. + FleetId *string + + // Human-readable description of a fleet. + Description *string + // Names of metric groups to include this fleet in. Amazon CloudWatch uses a fleet // metric group is to aggregate metrics from multiple fleets. Use an existing // metric group name to add this fleet to the group. Or use a new name to create a @@ -109,15 +118,6 @@ type UpdateFleetAttributesInput struct { // scale-down event. NewGameSessionProtectionPolicy types.ProtectionPolicy - // Human-readable description of a fleet. - Description *string - - // A unique identifier for a fleet to update attribute metadata for. You can use - // either the fleet ID or ARN value. - // - // This member is required. - FleetId *string - // Policy that limits the number of game sessions an individual player can create // over a span of time. ResourceCreationLimitPolicy *types.ResourceCreationLimitPolicy diff --git a/service/gamelift/api_op_UpdateFleetCapacity.go b/service/gamelift/api_op_UpdateFleetCapacity.go index 5f18ad9d520..a17aff0e90f 100644 --- a/service/gamelift/api_op_UpdateFleetCapacity.go +++ b/service/gamelift/api_op_UpdateFleetCapacity.go @@ -96,22 +96,22 @@ func (c *Client) UpdateFleetCapacity(ctx context.Context, params *UpdateFleetCap // Represents the input for a request action. type UpdateFleetCapacityInput struct { - // The maximum value allowed for the fleet's instance count. Default if not set is - // 1. - MaxSize *int32 - // A unique identifier for a fleet to update capacity for. You can use either the // fleet ID or ARN value. // // This member is required. FleetId *string + // Number of EC2 instances you want this fleet to host. + DesiredInstances *int32 + + // The maximum value allowed for the fleet's instance count. Default if not set is + // 1. + MaxSize *int32 + // The minimum value allowed for the fleet's instance count. Default if not set is // 0. MinSize *int32 - - // Number of EC2 instances you want this fleet to host. - DesiredInstances *int32 } // Represents the returned data in response to a request action. diff --git a/service/gamelift/api_op_UpdateFleetPortSettings.go b/service/gamelift/api_op_UpdateFleetPortSettings.go index 0bc4cb1372e..b5b7f192a93 100644 --- a/service/gamelift/api_op_UpdateFleetPortSettings.go +++ b/service/gamelift/api_op_UpdateFleetPortSettings.go @@ -89,17 +89,17 @@ func (c *Client) UpdateFleetPortSettings(ctx context.Context, params *UpdateFlee // Represents the input for a request action. type UpdateFleetPortSettingsInput struct { - // A collection of port settings to be added to the fleet resource. - InboundPermissionAuthorizations []*types.IpPermission - - // A collection of port settings to be removed from the fleet resource. - InboundPermissionRevocations []*types.IpPermission - // A unique identifier for a fleet to update port settings for. You can use either // the fleet ID or ARN value. // // This member is required. FleetId *string + + // A collection of port settings to be added to the fleet resource. + InboundPermissionAuthorizations []*types.IpPermission + + // A collection of port settings to be removed from the fleet resource. + InboundPermissionRevocations []*types.IpPermission } // Represents the returned data in response to a request action. diff --git a/service/gamelift/api_op_UpdateGameServer.go b/service/gamelift/api_op_UpdateGameServer.go index 264401bf08d..2790944109b 100644 --- a/service/gamelift/api_op_UpdateGameServer.go +++ b/service/gamelift/api_op_UpdateGameServer.go @@ -101,33 +101,33 @@ func (c *Client) UpdateGameServer(ctx context.Context, params *UpdateGameServerI type UpdateGameServerInput struct { - // Indicates whether the game server is available or is currently hosting gameplay. - UtilizationStatus types.GameServerUtilizationStatus - - // Indicates health status of the game server. An update that explicitly includes - // this parameter updates the game server's LastHealthCheckTime time stamp. - HealthCheck types.GameServerHealthCheck + // An identifier for the game server group where the game server is running. Use + // either the GameServerGroup () name or ARN value. + // + // This member is required. + GameServerGroupName *string // The identifier for the game server to be updated. // // This member is required. GameServerId *string + // A game server tag that can be used to request sorted lists of game servers using + // ListGameServers (). Custom sort keys are developer-defined based on how you want + // to organize the retrieved game server information. + CustomSortKey *string + // A set of custom game server properties, formatted as a single string value. This // data is passed to a game client or service when it requests information on a // game servers using DescribeGameServer () or ClaimGameServer (). GameServerData *string - // An identifier for the game server group where the game server is running. Use - // either the GameServerGroup () name or ARN value. - // - // This member is required. - GameServerGroupName *string + // Indicates health status of the game server. An update that explicitly includes + // this parameter updates the game server's LastHealthCheckTime time stamp. + HealthCheck types.GameServerHealthCheck - // A game server tag that can be used to request sorted lists of game servers using - // ListGameServers (). Custom sort keys are developer-defined based on how you want - // to organize the retrieved game server information. - CustomSortKey *string + // Indicates whether the game server is available or is currently hosting gameplay. + UtilizationStatus types.GameServerUtilizationStatus } type UpdateGameServerOutput struct { diff --git a/service/gamelift/api_op_UpdateGameServerGroup.go b/service/gamelift/api_op_UpdateGameServerGroup.go index 5ed6a87db01..8d765a884db 100644 --- a/service/gamelift/api_op_UpdateGameServerGroup.go +++ b/service/gamelift/api_op_UpdateGameServerGroup.go @@ -88,6 +88,12 @@ func (c *Client) UpdateGameServerGroup(ctx context.Context, params *UpdateGameSe type UpdateGameServerGroupInput struct { + // The unique identifier of the game server group to update. Use either the + // GameServerGroup () name or ARN value. + // + // This member is required. + GameServerGroupName *string + // The fallback balancing method to use for the game server group when Spot // instances in a Region become unavailable or are not viable for game hosting. // Once triggered, this method remains active until Spot instances can once again @@ -105,12 +111,14 @@ type UpdateGameServerGroupInput struct { // instances. BalancingStrategy types.BalancingStrategy - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) for an IAM - // role that allows Amazon GameLift to access your EC2 Auto Scaling groups. The - // submitted role is validated to ensure that it contains the necessary permissions - // for game server groups. - RoleArn *string + // A flag that indicates whether instances in the game server group are protected + // from early termination. Unprotected instances that have active game servers + // running may by terminated during a scale-down event, causing players to be + // dropped from the game. Protected instances cannot be terminated while there are + // active game servers running. An exception to this is Spot Instances, which may + // be terminated by AWS regardless of protection status. This property is set to + // NO_PROTECTION by default. + GameServerProtectionPolicy types.GameServerProtectionPolicy // An updated list of EC2 instance types to use when creating instances in the // group. The instance definition must specify instance types that are supported by @@ -121,20 +129,12 @@ type UpdateGameServerGroupInput struct { // Amazon EC2 User Guide.. InstanceDefinitions []*types.InstanceDefinition - // A flag that indicates whether instances in the game server group are protected - // from early termination. Unprotected instances that have active game servers - // running may by terminated during a scale-down event, causing players to be - // dropped from the game. Protected instances cannot be terminated while there are - // active game servers running. An exception to this is Spot Instances, which may - // be terminated by AWS regardless of protection status. This property is set to - // NO_PROTECTION by default. - GameServerProtectionPolicy types.GameServerProtectionPolicy - - // The unique identifier of the game server group to update. Use either the - // GameServerGroup () name or ARN value. - // - // This member is required. - GameServerGroupName *string + // The Amazon Resource Name (ARN + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) for an IAM + // role that allows Amazon GameLift to access your EC2 Auto Scaling groups. The + // submitted role is validated to ensure that it contains the necessary permissions + // for game server groups. + RoleArn *string } type UpdateGameServerGroupOutput struct { diff --git a/service/gamelift/api_op_UpdateGameSession.go b/service/gamelift/api_op_UpdateGameSession.go index dc548a9c63e..a203ee34104 100644 --- a/service/gamelift/api_op_UpdateGameSession.go +++ b/service/gamelift/api_op_UpdateGameSession.go @@ -88,31 +88,31 @@ func (c *Client) UpdateGameSession(ctx context.Context, params *UpdateGameSessio // Represents the input for a request action. type UpdateGameSessionInput struct { - // Game session protection policy to apply to this game session only. - // - // * - // NoProtection -- The game session can be terminated during a scale-down event. - // + // A unique identifier for the game session to update. // - // * FullProtection -- If the game session is in an ACTIVE status, it cannot be - // terminated during a scale-down event. - ProtectionPolicy types.ProtectionPolicy + // This member is required. + GameSessionId *string - // Policy determining whether or not the game session accepts new players. - PlayerSessionCreationPolicy types.PlayerSessionCreationPolicy + // The maximum number of players that can be connected simultaneously to the game + // session. + MaximumPlayerSessionCount *int32 // A descriptive label that is associated with a game session. Session names do not // need to be unique. Name *string - // The maximum number of players that can be connected simultaneously to the game - // session. - MaximumPlayerSessionCount *int32 + // Policy determining whether or not the game session accepts new players. + PlayerSessionCreationPolicy types.PlayerSessionCreationPolicy - // A unique identifier for the game session to update. + // Game session protection policy to apply to this game session only. // - // This member is required. - GameSessionId *string + // * + // NoProtection -- The game session can be terminated during a scale-down event. + // + // + // * FullProtection -- If the game session is in an ACTIVE status, it cannot be + // terminated during a scale-down event. + ProtectionPolicy types.ProtectionPolicy } // Represents the returned data in response to a request action. diff --git a/service/gamelift/api_op_UpdateGameSessionQueue.go b/service/gamelift/api_op_UpdateGameSessionQueue.go index b3cbcb0b223..9e56a578677 100644 --- a/service/gamelift/api_op_UpdateGameSessionQueue.go +++ b/service/gamelift/api_op_UpdateGameSessionQueue.go @@ -73,6 +73,18 @@ func (c *Client) UpdateGameSessionQueue(ctx context.Context, params *UpdateGameS // Represents the input for a request action. type UpdateGameSessionQueueInput struct { + // A descriptive label that is associated with game session queue. Queue names must + // be unique within each Region. You can use either the queue ID or ARN value. + // + // This member is required. + Name *string + + // A list of fleets that can be used to fulfill game session placement requests in + // the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. + // Destinations are listed in default preference order. When updating this list, + // provide a complete list of destinations. + Destinations []*types.GameSessionQueueDestination + // A collection of latency policies to apply when processing game sessions // placement requests with player latency information. Multiple policies are // evaluated in order of the maximum latency value, starting with the lowest @@ -88,18 +100,6 @@ type UpdateGameSessionQueueInput struct { // in the queue. When a request exceeds this time, the game session placement // changes to a TIMED_OUT status. TimeoutInSeconds *int32 - - // A list of fleets that can be used to fulfill game session placement requests in - // the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. - // Destinations are listed in default preference order. When updating this list, - // provide a complete list of destinations. - Destinations []*types.GameSessionQueueDestination - - // A descriptive label that is associated with game session queue. Queue names must - // be unique within each Region. You can use either the queue ID or ARN value. - // - // This member is required. - Name *string } // Represents the returned data in response to a request action. diff --git a/service/gamelift/api_op_UpdateMatchmakingConfiguration.go b/service/gamelift/api_op_UpdateMatchmakingConfiguration.go index f4fd5654f99..bbfff6e5f78 100644 --- a/service/gamelift/api_op_UpdateMatchmakingConfiguration.go +++ b/service/gamelift/api_op_UpdateMatchmakingConfiguration.go @@ -83,23 +83,41 @@ func (c *Client) UpdateMatchmakingConfiguration(ctx context.Context, params *Upd // Represents the input for a request action. type UpdateMatchmakingConfigurationInput struct { - // A unique identifier for a matchmaking rule set to use with this configuration. - // You can use either the rule set name or ARN value. A matchmaking configuration - // can only use rule sets that are defined in the same Region. - RuleSetName *string + // A unique identifier for a matchmaking configuration to update. You can use + // either the configuration name or ARN value. + // + // This member is required. + Name *string + + // A flag that indicates whether a match that was created with this configuration + // must be accepted by the matched players. To require acceptance, set to TRUE. + AcceptanceRequired *bool // The length of time (in seconds) to wait for players to accept a proposed match. // If any player rejects the match or fails to accept before the timeout, the // ticket continues to look for an acceptable match. AcceptanceTimeoutSeconds *int32 - // A set of custom game session properties, formatted as a single string value. - // This data is passed to a game server process in the GameSession () object with a - // request to start a new game session (see Start a Game Session - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). - // This information is added to the new GameSession () object that is created for a - // successful match. - GameSessionData *string + // The number of player slots in a match to keep open for future players. For + // example, assume that the configuration's rule set specifies a match for a single + // 12-person team. If the additional player count is set to 2, only 10 players are + // initially selected for the match. + AdditionalPlayerCount *int32 + + // The method that is used to backfill game sessions created with this matchmaking + // configuration. Specify MANUAL when your game manages backfill requests manually + // or does not use the match backfill feature. Specify AUTOMATIC to have GameLift + // create a StartMatchBackfill () request whenever a game session has one or more + // open slots. Learn more about manual and automatic backfill in Backfill Existing + // Games with FlexMatch + // (https://docs.aws.amazon.com/gamelift/latest/developerguide/match-backfill.html). + BackfillMode types.BackfillMode + + // Information to add to all events related to the matchmaking configuration. + CustomEventData *string + + // A descriptive label that is associated with matchmaking configuration. + Description *string // A set of custom properties for a game session, formatted as key-value pairs. // These properties are passed to a game server process in the GameSession () @@ -109,8 +127,13 @@ type UpdateMatchmakingConfigurationInput struct { // successful match. GameProperties []*types.GameProperty - // A descriptive label that is associated with matchmaking configuration. - Description *string + // A set of custom game session properties, formatted as a single string value. + // This data is passed to a game server process in the GameSession () object with a + // request to start a new game session (see Start a Game Session + // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). + // This information is added to the new GameSession () object that is created for a + // successful match. + GameSessionData *string // Amazon Resource Name (ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) @@ -120,44 +143,21 @@ type UpdateMatchmakingConfigurationInput struct { // configuration. Queues can be located in any Region. GameSessionQueueArns []*string - // A flag that indicates whether a match that was created with this configuration - // must be accepted by the matched players. To require acceptance, set to TRUE. - AcceptanceRequired *bool - - // The number of player slots in a match to keep open for future players. For - // example, assume that the configuration's rule set specifies a match for a single - // 12-person team. If the additional player count is set to 2, only 10 players are - // initially selected for the match. - AdditionalPlayerCount *int32 - - // The maximum duration, in seconds, that a matchmaking ticket can remain in - // process before timing out. Requests that fail due to timing out can be - // resubmitted as needed. - RequestTimeoutSeconds *int32 - - // The method that is used to backfill game sessions created with this matchmaking - // configuration. Specify MANUAL when your game manages backfill requests manually - // or does not use the match backfill feature. Specify AUTOMATIC to have GameLift - // create a StartMatchBackfill () request whenever a game session has one or more - // open slots. Learn more about manual and automatic backfill in Backfill Existing - // Games with FlexMatch - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/match-backfill.html). - BackfillMode types.BackfillMode - // An SNS topic ARN that is set up to receive matchmaking notifications. See // Setting up Notifications for Matchmaking // (https://docs.aws.amazon.com/gamelift/latest/developerguide/match-notification.html) // for more information. NotificationTarget *string - // A unique identifier for a matchmaking configuration to update. You can use - // either the configuration name or ARN value. - // - // This member is required. - Name *string + // The maximum duration, in seconds, that a matchmaking ticket can remain in + // process before timing out. Requests that fail due to timing out can be + // resubmitted as needed. + RequestTimeoutSeconds *int32 - // Information to add to all events related to the matchmaking configuration. - CustomEventData *string + // A unique identifier for a matchmaking rule set to use with this configuration. + // You can use either the rule set name or ARN value. A matchmaking configuration + // can only use rule sets that are defined in the same Region. + RuleSetName *string } // Represents the returned data in response to a request action. diff --git a/service/gamelift/api_op_UpdateRuntimeConfiguration.go b/service/gamelift/api_op_UpdateRuntimeConfiguration.go index fe82a2ffe06..17239005d2e 100644 --- a/service/gamelift/api_op_UpdateRuntimeConfiguration.go +++ b/service/gamelift/api_op_UpdateRuntimeConfiguration.go @@ -95,6 +95,12 @@ func (c *Client) UpdateRuntimeConfiguration(ctx context.Context, params *UpdateR // Represents the input for a request action. type UpdateRuntimeConfigurationInput struct { + // A unique identifier for a fleet to update runtime configuration for. You can use + // either the fleet ID or ARN value. + // + // This member is required. + FleetId *string + // Instructions for launching server processes on each instance in the fleet. // Server processes run either a custom game build executable or a Realtime Servers // script. The runtime configuration lists the types of server processes to run on @@ -105,12 +111,6 @@ type UpdateRuntimeConfigurationInput struct { // // This member is required. RuntimeConfiguration *types.RuntimeConfiguration - - // A unique identifier for a fleet to update runtime configuration for. You can use - // either the fleet ID or ARN value. - // - // This member is required. - FleetId *string } // Represents the returned data in response to a request action. diff --git a/service/gamelift/api_op_UpdateScript.go b/service/gamelift/api_op_UpdateScript.go index c8be0cf1a54..a77bc039041 100644 --- a/service/gamelift/api_op_UpdateScript.go +++ b/service/gamelift/api_op_UpdateScript.go @@ -78,23 +78,15 @@ func (c *Client) UpdateScript(ctx context.Context, params *UpdateScriptInput, op type UpdateScriptInput struct { - // The version that is associated with a build or script. Version strings do not - // need to be unique. - Version *string - // A unique identifier for a Realtime script to update. You can use either the // script ID or ARN value. // // This member is required. ScriptId *string - // A data object containing your Realtime scripts and dependencies as a zip file. - // The zip file can have one or multiple files. Maximum size of a zip file is 5 MB. - // When using the AWS CLI tool to create a script, this parameter is set to the zip - // file name. It must be prepended with the string "fileb://" to indicate that the - // file data is a binary object. For example: --zip-file - // fileb://myRealtimeScript.zip. - ZipFile []byte + // A descriptive label that is associated with a script. Script names do not need + // to be unique. + Name *string // The location of the Amazon S3 bucket where a zipped file containing your // Realtime scripts is stored. The storage location must specify the Amazon S3 @@ -106,9 +98,17 @@ type UpdateScriptInput struct { // version. StorageLocation *types.S3Location - // A descriptive label that is associated with a script. Script names do not need - // to be unique. - Name *string + // The version that is associated with a build or script. Version strings do not + // need to be unique. + Version *string + + // A data object containing your Realtime scripts and dependencies as a zip file. + // The zip file can have one or multiple files. Maximum size of a zip file is 5 MB. + // When using the AWS CLI tool to create a script, this parameter is set to the zip + // file name. It must be prepended with the string "fileb://" to indicate that the + // file data is a binary object. For example: --zip-file + // fileb://myRealtimeScript.zip. + ZipFile []byte } type UpdateScriptOutput struct { diff --git a/service/gamelift/go.mod b/service/gamelift/go.mod index df747d96c2c..935c781725f 100644 --- a/service/gamelift/go.mod +++ b/service/gamelift/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/gamelift go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/gamelift/types/types.go b/service/gamelift/types/types.go index cbf079e994d..ee8642beca7 100644 --- a/service/gamelift/types/types.go +++ b/service/gamelift/types/types.go @@ -23,21 +23,16 @@ import ( // * ResolveAlias () type Alias struct { - // The routing configuration, including routing type and fleet target, for the - // alias. - RoutingStrategy *RoutingStrategy - - // The time that this data object was last modified. Format is a number expressed - // in Unix time as milliseconds (for example "1469498468.057"). - LastUpdatedTime *time.Time + // Amazon Resource Name (ARN + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) + // that is assigned to a GameLift alias resource and uniquely identifies it. ARNs + // are unique across all Regions. In a GameLift alias ARN, the resource ID matches + // the alias ID value. + AliasArn *string // A unique identifier for an alias. Alias IDs are unique within a Region. AliasId *string - // A descriptive label that is associated with an alias. Alias names do not need to - // be unique. - Name *string - // A time stamp indicating when this data object was created. Format is a number // expressed in Unix time as milliseconds (for example "1469498468.057"). CreationTime *time.Time @@ -45,12 +40,17 @@ type Alias struct { // A human-readable description of an alias. Description *string - // Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) - // that is assigned to a GameLift alias resource and uniquely identifies it. ARNs - // are unique across all Regions. In a GameLift alias ARN, the resource ID matches - // the alias ID value. - AliasArn *string + // The time that this data object was last modified. Format is a number expressed + // in Unix time as milliseconds (for example "1469498468.057"). + LastUpdatedTime *time.Time + + // A descriptive label that is associated with an alias. Alias names do not need to + // be unique. + Name *string + + // The routing configuration, including routing type and fleet target, for the + // alias. + RoutingStrategy *RoutingStrategy } // Values for use in Player () attribute key-value pairs. This object lets you @@ -59,20 +59,20 @@ type Alias struct { // available properties. type AttributeValue struct { - // For a list of up to 10 strings. Maximum length for each string is 100 - // characters. Duplicate values are not recognized; all occurrences of the repeated - // value after the first of a repeated value are ignored. - SL []*string + // For number values, expressed as double. + N *float64 + + // For single string values. Maximum string length is 100 characters. + S *string // For a map of up to 10 data type:value pairs. Maximum length for each string // value is 100 characters. SDM map[string]*float64 - // For single string values. Maximum string length is 100 characters. - S *string - - // For number values, expressed as double. - N *float64 + // For a list of up to 10 strings. Maximum length for each string is 100 + // characters. Duplicate values are not recognized; all occurrences of the repeated + // value after the first of a repeated value are ignored. + SL []*string } // Temporary access credentials used for uploading game build files to Amazon @@ -83,12 +83,12 @@ type AwsCredentials struct { // Temporary key allowing access to the Amazon GameLift S3 account. AccessKeyId *string + // Temporary secret key allowing access to the Amazon GameLift S3 account. + SecretAccessKey *string + // Token used to associate a specific build ID with the files uploaded using these // credentials. SessionToken *string - - // Temporary secret key allowing access to the Amazon GameLift S3 account. - SecretAccessKey *string } // Properties describing a custom game build. Related operations @@ -106,9 +106,32 @@ type AwsCredentials struct { // DeleteBuild () type Build struct { + // Amazon Resource Name (ARN + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) + // that is assigned to a GameLift build resource and uniquely identifies it. ARNs + // are unique across all Regions. In a GameLift build ARN, the resource ID matches + // the BuildId value. + BuildArn *string + // A unique identifier for a build. BuildId *string + // Time stamp indicating when this data object was created. Format is a number + // expressed in Unix time as milliseconds (for example "1469498468.057"). + CreationTime *time.Time + + // A descriptive label that is associated with a build. Build names do not need to + // be unique. It can be set using CreateBuild () or UpdateBuild (). + Name *string + + // Operating system that the game server binaries are built to run on. This value + // determines the type of fleet resources that you can use for this build. + OperatingSystem OperatingSystem + + // File size of the uploaded game build, expressed in bytes. When the build status + // is INITIALIZED, this value is 0. + SizeOnDisk *int64 + // Current status of the build. Possible build statuses include the following: // // @@ -128,29 +151,6 @@ type Build struct { // do not need to be unique. This value can be set using CreateBuild () or // UpdateBuild (). Version *string - - // A descriptive label that is associated with a build. Build names do not need to - // be unique. It can be set using CreateBuild () or UpdateBuild (). - Name *string - - // Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) - // that is assigned to a GameLift build resource and uniquely identifies it. ARNs - // are unique across all Regions. In a GameLift build ARN, the resource ID matches - // the BuildId value. - BuildArn *string - - // Time stamp indicating when this data object was created. Format is a number - // expressed in Unix time as milliseconds (for example "1469498468.057"). - CreationTime *time.Time - - // File size of the uploaded game build, expressed in bytes. When the build status - // is INITIALIZED, this value is 0. - SizeOnDisk *int64 - - // Operating system that the game server binaries are built to run on. This value - // determines the type of fleet resources that you can use for this build. - OperatingSystem OperatingSystem } // Information about the use of a TLS/SSL certificate for a fleet. TLS certificate @@ -201,13 +201,12 @@ type DesiredPlayerSession struct { // StartFleetActions () or StopFleetActions () type EC2InstanceCounts struct { - // Number of instances in the fleet that are no longer active but haven't yet been - // terminated. - TERMINATING *int32 - // Actual number of active instances in the fleet. ACTIVE *int32 + // Ideal number of active instances in the fleet. + DESIRED *int32 + // Number of active instances in the fleet that are not currently hosting a game // session. IDLE *int32 @@ -215,14 +214,15 @@ type EC2InstanceCounts struct { // The maximum value allowed for the fleet's instance count. MAXIMUM *int32 + // The minimum value allowed for the fleet's instance count. + MINIMUM *int32 + // Number of instances in the fleet that are starting but not yet active. PENDING *int32 - // Ideal number of active instances in the fleet. - DESIRED *int32 - - // The minimum value allowed for the fleet's instance count. - MINIMUM *int32 + // Number of instances in the fleet that are no longer active but haven't yet been + // terminated. + TERMINATING *int32 } // The maximum number of instances allowed based on the Amazon Elastic Compute @@ -250,24 +250,6 @@ type EC2InstanceLimit struct { // additional information for troubleshooting and debugging problems. type Event struct { - // A unique identifier for a fleet event. - EventId *string - - // Location of stored logs with additional detail that is related to the event. - // This is useful for debugging issues. The URL is valid for 15 minutes. You can - // also access fleet creation logs through the Amazon GameLift console. - PreSignedLogUrl *string - - // A unique identifier for an event resource, such as a fleet ID. - ResourceId *string - - // Additional information related to the event. - Message *string - - // Time stamp indicating when this event occurred. Format is a number expressed in - // Unix time as milliseconds (for example "1469498468.057"). - EventTime *time.Time - // The type of event being logged. Fleet creation events (ordered by fleet creation // activity): // @@ -346,6 +328,24 @@ type Event struct { // delete a fleet was initiated.

  • GENERIC_EVENT -- An unspecified // event has occurred.

    • EventCode EventCode + + // A unique identifier for a fleet event. + EventId *string + + // Time stamp indicating when this event occurred. Format is a number expressed in + // Unix time as milliseconds (for example "1469498468.057"). + EventTime *time.Time + + // Additional information related to the event. + Message *string + + // Location of stored logs with additional detail that is related to the event. + // This is useful for debugging issues. The URL is valid for 15 minutes. You can + // also access fleet creation logs through the Amazon GameLift console. + PreSignedLogUrl *string + + // A unique identifier for an event resource, such as a fleet ID. + ResourceId *string } // General properties describing a fleet. @@ -365,62 +365,54 @@ type Event struct { // * StartFleetActions () or StopFleetActions () type FleetAttributes struct { - // List of fleet actions that have been suspended using StopFleetActions (). This - // includes auto-scaling. - StoppedActions []FleetAction + // The Amazon Resource Name (ARN + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) + // associated with the GameLift build resource that is deployed on instances in + // this fleet. In a GameLift build ARN, the resource ID matches the BuildId value. + BuildArn *string - // Current status of the fleet. Possible fleet statuses include the following: - // - // - // * NEW -- A new fleet has been defined and desired instances is set to 1. - // - // * - // DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting up the - // new fleet, creating new instances with the game build or Realtime script and - // starting server processes. - // - // * ACTIVE -- Hosts can now accept game - // sessions. - // - // * ERROR -- An error occurred when downloading, validating, - // building, or activating the fleet. - // - // * DELETING -- Hosts are responding to a - // delete fleet request. - // - // * TERMINATED -- The fleet no longer exists. - Status FleetStatus + // A unique identifier for a build. + BuildId *string + + // Indicates whether a TLS/SSL certificate was generated for the fleet. + CertificateConfiguration *CertificateConfiguration + + // Time stamp indicating when this data object was created. Format is a number + // expressed in Unix time as milliseconds (for example "1469498468.057"). + CreationTime *time.Time // Human-readable description of the fleet. Description *string // The Amazon Resource Name (ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) - // associated with the GameLift script resource that is deployed on instances in - // this fleet. In a GameLift script ARN, the resource ID matches the ScriptId - // value. - ScriptArn *string + // that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs + // are unique across all Regions. In a GameLift fleet ARN, the resource ID matches + // the FleetId value. + FleetArn *string + + // A unique identifier for a fleet. + FleetId *string // Indicates whether the fleet uses on-demand or spot instances. A spot instance in // use may be interrupted with a two-minute notification. FleetType FleetType - // The type of game session protection to set for all new instances started in the - // fleet. - // - // * NoProtection -- The game session can be terminated during a - // scale-down event. - // - // * FullProtection -- If the game session is in an ACTIVE - // status, it cannot be terminated during a scale-down event. - NewGameSessionProtectionPolicy ProtectionPolicy - - // Fleet policy to limit the number of game sessions an individual player can - // create over a span of time. - ResourceCreationLimitPolicy *ResourceCreationLimitPolicy + // A unique identifier for an AWS IAM role that manages access to your AWS + // services. With an instance role ARN set, any application that runs on an + // instance in this fleet can assume the role, including install scripts, server + // processes, and daemons (background processes). Create a role or look up a role's + // ARN from the IAM dashboard (https://console.aws.amazon.com/iam/) in the AWS + // Management Console. Learn more about using on-box credentials for your game + // servers at Access external resources from a game server + // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html). + InstanceRoleArn *string - // A unique identifier for a Realtime script. - ScriptId *string + // EC2 instance type indicating the computing resources of each instance in the + // fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 + // Instance Types (http://aws.amazon.com/ec2/instance-types/) for detailed + // descriptions. + InstanceType EC2InstanceType // Location of default log files. When a server process is shut down, Amazon // GameLift captures and stores any log files in this location. These logs are in @@ -433,76 +425,84 @@ type FleetAttributes struct { // logs. LogPaths []*string - // Time stamp indicating when this data object was terminated. Format is a number - // expressed in Unix time as milliseconds (for example "1469498468.057"). - TerminationTime *time.Time - - // Path to a game server executable in the fleet's build, specified for fleets - // created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for - // fleets created after this date are specified in the fleet's RuntimeConfiguration - // (). - ServerLaunchPath *string - - // A descriptive label that is associated with a fleet. Fleet names do not need to - // be unique. - Name *string - // Names of metric groups that this fleet is included in. In Amazon CloudWatch, you // can view metrics for an individual fleet or aggregated metrics for fleets that // are in a fleet metric group. A fleet can be included in only one metric group at // a time. MetricGroups []*string - // A unique identifier for a build. - BuildId *string + // A descriptive label that is associated with a fleet. Fleet names do not need to + // be unique. + Name *string - // A unique identifier for a fleet. - FleetId *string + // The type of game session protection to set for all new instances started in the + // fleet. + // + // * NoProtection -- The game session can be terminated during a + // scale-down event. + // + // * FullProtection -- If the game session is in an ACTIVE + // status, it cannot be terminated during a scale-down event. + NewGameSessionProtectionPolicy ProtectionPolicy - // A unique identifier for an AWS IAM role that manages access to your AWS - // services. With an instance role ARN set, any application that runs on an - // instance in this fleet can assume the role, including install scripts, server - // processes, and daemons (background processes). Create a role or look up a role's - // ARN from the IAM dashboard (https://console.aws.amazon.com/iam/) in the AWS - // Management Console. Learn more about using on-box credentials for your game - // servers at Access external resources from a game server - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html). - InstanceRoleArn *string + // Operating system of the fleet's computing resources. A fleet's operating system + // depends on the OS specified for the build that is deployed on this fleet. + OperatingSystem OperatingSystem + + // Fleet policy to limit the number of game sessions an individual player can + // create over a span of time. + ResourceCreationLimitPolicy *ResourceCreationLimitPolicy // The Amazon Resource Name (ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) - // associated with the GameLift build resource that is deployed on instances in - // this fleet. In a GameLift build ARN, the resource ID matches the BuildId value. - BuildArn *string + // associated with the GameLift script resource that is deployed on instances in + // this fleet. In a GameLift script ARN, the resource ID matches the ScriptId + // value. + ScriptArn *string - // Indicates whether a TLS/SSL certificate was generated for the fleet. - CertificateConfiguration *CertificateConfiguration + // A unique identifier for a Realtime script. + ScriptId *string // Game server launch parameters specified for fleets created before 2016-08-04 (or // AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date // are specified in the fleet's RuntimeConfiguration (). ServerLaunchParameters *string - // EC2 instance type indicating the computing resources of each instance in the - // fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 - // Instance Types (http://aws.amazon.com/ec2/instance-types/) for detailed - // descriptions. - InstanceType EC2InstanceType + // Path to a game server executable in the fleet's build, specified for fleets + // created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for + // fleets created after this date are specified in the fleet's RuntimeConfiguration + // (). + ServerLaunchPath *string - // Operating system of the fleet's computing resources. A fleet's operating system - // depends on the OS specified for the build that is deployed on this fleet. - OperatingSystem OperatingSystem + // Current status of the fleet. Possible fleet statuses include the following: + // + // + // * NEW -- A new fleet has been defined and desired instances is set to 1. + // + // * + // DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting up the + // new fleet, creating new instances with the game build or Realtime script and + // starting server processes. + // + // * ACTIVE -- Hosts can now accept game + // sessions. + // + // * ERROR -- An error occurred when downloading, validating, + // building, or activating the fleet. + // + // * DELETING -- Hosts are responding to a + // delete fleet request. + // + // * TERMINATED -- The fleet no longer exists. + Status FleetStatus - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) - // that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs - // are unique across all Regions. In a GameLift fleet ARN, the resource ID matches - // the FleetId value. - FleetArn *string + // List of fleet actions that have been suspended using StopFleetActions (). This + // includes auto-scaling. + StoppedActions []FleetAction - // Time stamp indicating when this data object was created. Format is a number + // Time stamp indicating when this data object was terminated. Format is a number // expressed in Unix time as milliseconds (for example "1469498468.057"). - CreationTime *time.Time + TerminationTime *time.Time } // Information about the fleet's capacity. Fleet capacity is measured in EC2 @@ -525,6 +525,9 @@ type FleetAttributes struct { // * StartFleetActions () or StopFleetActions () type FleetCapacity struct { + // A unique identifier for a fleet. + FleetId *string + // Current status of fleet capacity. InstanceCounts *EC2InstanceCounts @@ -534,9 +537,6 @@ type FleetCapacity struct { // supports the following EC2 instance types. See Amazon EC2 Instance Types // (http://aws.amazon.com/ec2/instance-types/) for detailed descriptions. InstanceType EC2InstanceType - - // A unique identifier for a fleet. - FleetId *string } // Current status of fleet utilization, including the number of game and player @@ -557,9 +557,13 @@ type FleetCapacity struct { // * StartFleetActions () or StopFleetActions () type FleetUtilization struct { - // The maximum number of players allowed across all game sessions currently being - // hosted on all instances in the fleet. - MaximumPlayerSessionCount *int32 + // Number of active game sessions currently being hosted on all instances in the + // fleet. + ActiveGameSessionCount *int32 + + // Number of server processes in an ACTIVE status currently running across all + // instances in the fleet + ActiveServerProcessCount *int32 // Number of active player sessions currently being hosted on all instances in the // fleet. @@ -568,13 +572,9 @@ type FleetUtilization struct { // A unique identifier for a fleet. FleetId *string - // Number of active game sessions currently being hosted on all instances in the - // fleet. - ActiveGameSessionCount *int32 - - // Number of server processes in an ACTIVE status currently running across all - // instances in the fleet - ActiveServerProcessCount *int32 + // The maximum number of players allowed across all game sessions currently being + // hosted on all instances in the fleet. + MaximumPlayerSessionCount *int32 } // Set of key-value pairs that contain information about a game session. When @@ -586,15 +586,15 @@ type FleetUtilization struct { // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-create). type GameProperty struct { - // The game property value. + // The game property identifier. // // This member is required. - Value *string + Key *string - // The game property identifier. + // The game property value. // // This member is required. - Key *string + Value *string } // This data type is part of Amazon GameLift FleetIQ with game server groups, which @@ -603,40 +603,6 @@ type GameProperty struct { // RegisterGameServer () and deleted by calling DeregisterGameServer (). type GameServer struct { - // The unique identifier for the instance where the game server is located. - InstanceId *string - - // Time stamp indicating when the game server resource was created with a - // RegisterGameServer () request. Format is a number expressed in Unix time as - // milliseconds (for example "1469498468.057"). - RegistrationTime *time.Time - - // Indicates whether the game server is currently available for new games or is - // busy. Possible statuses include: - // - // * AVAILABLE - The game server is available - // to be claimed. A game server that has been claimed remains in this status until - // it reports game hosting activity. - // - // * IN_USE - The game server is currently - // hosting a game session with players. - UtilizationStatus GameServerUtilizationStatus - - // A custom string that uniquely identifies the game server. Game server IDs are - // developer-defined and are unique across all game server groups in an AWS - // account. - GameServerId *string - - // The ARN identifier for the game server group where the game server is located. - GameServerGroupArn *string - - // Time stamp indicating the last time the game server was updated with health - // status using an UpdateGameServer () request. Format is a number expressed in - // Unix time as milliseconds (for example "1469498468.057"). After game server - // registration, this property is only changed when a game server update specifies - // a health check value. - LastHealthCheckTime *time.Time - // Indicates when an available game server has been reserved but has not yet // started hosting a game. Once it is claimed, game server remains in CLAIMED // status for a maximum of one minute. During this time, game clients must connect @@ -649,25 +615,59 @@ type GameServer struct { // the game server. ConnectionInfo *string + // A game server tag that can be used to request sorted lists of game servers when + // calling ListGameServers (). Custom sort keys are developer-defined. This + // property can be updated using UpdateGameServer (). + CustomSortKey *string + // A set of custom game server properties, formatted as a single string value. This // data is passed to a game client or service in response to requests // ListGameServers () or ClaimGameServer (). This property can be updated using // UpdateGameServer (). GameServerData *string + // The ARN identifier for the game server group where the game server is located. + GameServerGroupArn *string + // The name identifier for the game server group where the game server is located. GameServerGroupName *string + // A custom string that uniquely identifies the game server. Game server IDs are + // developer-defined and are unique across all game server groups in an AWS + // account. + GameServerId *string + + // The unique identifier for the instance where the game server is located. + InstanceId *string + // Time stamp indicating the last time the game server was claimed with a // ClaimGameServer () request. Format is a number expressed in Unix time as // milliseconds (for example "1469498468.057"). This value is used to calculate // when the game server's claim status. LastClaimTime *time.Time - // A game server tag that can be used to request sorted lists of game servers when - // calling ListGameServers (). Custom sort keys are developer-defined. This - // property can be updated using UpdateGameServer (). - CustomSortKey *string + // Time stamp indicating the last time the game server was updated with health + // status using an UpdateGameServer () request. Format is a number expressed in + // Unix time as milliseconds (for example "1469498468.057"). After game server + // registration, this property is only changed when a game server update specifies + // a health check value. + LastHealthCheckTime *time.Time + + // Time stamp indicating when the game server resource was created with a + // RegisterGameServer () request. Format is a number expressed in Unix time as + // milliseconds (for example "1469498468.057"). + RegistrationTime *time.Time + + // Indicates whether the game server is currently available for new games or is + // busy. Possible statuses include: + // + // * AVAILABLE - The game server is available + // to be claimed. A game server that has been claimed remains in this status until + // it reports game hosting activity. + // + // * IN_USE - The game server is currently + // hosting a game session with players. + UtilizationStatus GameServerUtilizationStatus } // This data type is part of Amazon GameLift FleetIQ with game server groups, which @@ -680,19 +680,9 @@ type GameServer struct { // ResumeGameServerGroup (). type GameServerGroup struct { - // A time stamp indicating when this game server group was last updated. - LastUpdatedTime *time.Time - - // Additional information about the current game server group status. This - // information may provide additional insight on groups that in ERROR status. - StatusReason *string - - // A generated unique ID for the game server group. - GameServerGroupArn *string - - // A developer-defined identifier for the game server group. The name is unique per - // Region per AWS account. - GameServerGroupName *string + // A generated unique ID for the EC2 Auto Scaling group with is associated with + // this game server group. + AutoScalingGroupArn *string // The fallback balancing method to use for the game server group when Spot // instances in a Region become unavailable or are not viable for game hosting. @@ -711,9 +701,16 @@ type GameServerGroup struct { // instances. BalancingStrategy BalancingStrategy - // A generated unique ID for the EC2 Auto Scaling group with is associated with - // this game server group. - AutoScalingGroupArn *string + // A time stamp indicating when this data object was created. Format is a number + // expressed in Unix time as milliseconds (for example "1469498468.057"). + CreationTime *time.Time + + // A generated unique ID for the game server group. + GameServerGroupArn *string + + // A developer-defined identifier for the game server group. The name is unique per + // Region per AWS account. + GameServerGroupName *string // A flag that indicates whether instances in the game server group are protected // from early termination. Unprotected instances that have active game servers @@ -724,6 +721,20 @@ type GameServerGroup struct { // which may be terminated by AWS regardless of protection status. GameServerProtectionPolicy GameServerProtectionPolicy + // The set of EC2 instance types that GameLift FleetIQ can use when rebalancing and + // autoscaling instances in the group. + InstanceDefinitions []*InstanceDefinition + + // A time stamp indicating when this game server group was last updated. + LastUpdatedTime *time.Time + + // The Amazon Resource Name (ARN + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) for an IAM + // role that allows Amazon GameLift to access your EC2 Auto Scaling groups. The + // submitted role is validated to ensure that it contains the necessary permissions + // for game server groups. + RoleArn *string + // The current status of the game server group. Possible statuses include: // // * @@ -752,24 +763,13 @@ type GameServerGroup struct { // state. Status GameServerGroupStatus + // Additional information about the current game server group status. This + // information may provide additional insight on groups that in ERROR status. + StatusReason *string + // A list of activities that are currently suspended for this game server group. If // this property is empty, all activities are occurring. SuspendedActions []GameServerGroupAction - - // The set of EC2 instance types that GameLift FleetIQ can use when rebalancing and - // autoscaling instances in the group. - InstanceDefinitions []*InstanceDefinition - - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) for an IAM - // role that allows Amazon GameLift to access your EC2 Auto Scaling groups. The - // submitted role is validated to ensure that it contains the necessary permissions - // for game server groups. - RoleArn *string - - // A time stamp indicating when this data object was created. Format is a number - // expressed in Unix time as milliseconds (for example "1469498468.057"). - CreationTime *time.Time } // This data type is part of Amazon GameLift FleetIQ with game server groups, which @@ -828,23 +828,17 @@ type GameServerGroupAutoScalingPolicy struct { // * StopGameSessionPlacement () type GameSession struct { - // Set of custom game session properties, formatted as a single string value. This - // data is passed to a game server process in the GameSession () object with a - // request to start a new game session (see Start a Game Session - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). - GameSessionData *string + // Time stamp indicating when this data object was created. Format is a number + // expressed in Unix time as milliseconds (for example "1469498468.057"). + CreationTime *time.Time - // Current status of the game session. A game session must have an ACTIVE status to - // have player sessions. - Status GameSessionStatus + // A unique identifier for a player. This ID is used to enforce a resource + // protection policy (if one exists), that limits the number of game sessions a + // player can create. + CreatorId *string - // Set of custom properties for a game session, formatted as key:value pairs. These - // properties are passed to a game server process in the GameSession () object with - // a request to start a new game session (see Start a Game Session - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). - // You can search for active game sessions based on this custom data with - // SearchGameSessions (). - GameProperties []*GameProperty + // Number of players currently in the game session. + CurrentPlayerSessionCount *int32 // DNS identifier assigned to the instance that is running the game session. Values // have the following format: @@ -866,6 +860,32 @@ type GameSession struct { // associated with the GameLift fleet that this game session is running on. FleetArn *string + // A unique identifier for a fleet that the game session is running on. + FleetId *string + + // Set of custom properties for a game session, formatted as key:value pairs. These + // properties are passed to a game server process in the GameSession () object with + // a request to start a new game session (see Start a Game Session + // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). + // You can search for active game sessions based on this custom data with + // SearchGameSessions (). + GameProperties []*GameProperty + + // Set of custom game session properties, formatted as a single string value. This + // data is passed to a game server process in the GameSession () object with a + // request to start a new game session (see Start a Game Session + // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). + GameSessionData *string + + // A unique identifier for the game session. A game session ARN has the following + // format: arn:aws:gamelift:::gamesession//. + GameSessionId *string + + // IP address of the instance that is running the game session. When connecting to + // a Amazon GameLift game server, a client needs to reference an IP address (or DNS + // name) and port number. + IpAddress *string + // Information about the matchmaking process that was used to create the game // session. It is in JSON syntax, formatted as a string. In addition the // matchmaking configuration used, it contains data on all players assigned to the @@ -877,53 +897,33 @@ type GameSession struct { // StartMatchBackfill ()). MatchmakerData *string + // The maximum number of players that can be connected simultaneously to the game + // session. + MaximumPlayerSessionCount *int32 + // A descriptive label that is associated with a game session. Session names do not // need to be unique. Name *string - // Number of players currently in the game session. - CurrentPlayerSessionCount *int32 + // Indicates whether or not the game session is accepting new players. + PlayerSessionCreationPolicy PlayerSessionCreationPolicy - // A unique identifier for the game session. A game session ARN has the following - // format: arn:aws:gamelift:::gamesession//. - GameSessionId *string + // Port number for the game session. To connect to a Amazon GameLift game server, + // an app needs both the IP address and port number. + Port *int32 - // Time stamp indicating when this data object was terminated. Format is a number - // expressed in Unix time as milliseconds (for example "1469498468.057"). - TerminationTime *time.Time + // Current status of the game session. A game session must have an ACTIVE status to + // have player sessions. + Status GameSessionStatus // Provides additional information about game session status. INTERRUPTED indicates // that the game session was hosted on a spot instance that was reclaimed, causing // the active game session to be terminated. StatusReason GameSessionStatusReason - // Indicates whether or not the game session is accepting new players. - PlayerSessionCreationPolicy PlayerSessionCreationPolicy - - // The maximum number of players that can be connected simultaneously to the game - // session. - MaximumPlayerSessionCount *int32 - - // Time stamp indicating when this data object was created. Format is a number + // Time stamp indicating when this data object was terminated. Format is a number // expressed in Unix time as milliseconds (for example "1469498468.057"). - CreationTime *time.Time - - // A unique identifier for a player. This ID is used to enforce a resource - // protection policy (if one exists), that limits the number of game sessions a - // player can create. - CreatorId *string - - // Port number for the game session. To connect to a Amazon GameLift game server, - // an app needs both the IP address and port number. - Port *int32 - - // A unique identifier for a fleet that the game session is running on. - FleetId *string - - // IP address of the instance that is running the game session. When connecting to - // a Amazon GameLift game server, a client needs to reference an IP address (or DNS - // name) and port number. - IpAddress *string + TerminationTime *time.Time } // Connection information for the new game session that is created with @@ -934,10 +934,6 @@ type GameSession struct { // retrieved by calling DescribeMatchmaking (). type GameSessionConnectionInfo struct { - // Port number for the game session. To connect to a Amazon GameLift game server, - // an app needs both the IP address and port number. - Port *int32 - // DNS identifier assigned to the instance that is running the game session. Values // have the following format: // @@ -953,10 +949,6 @@ type GameSessionConnectionInfo struct { // use the DNS name, not the IP address. DnsName *string - // A collection of player session IDs, one for each player ID that was included in - // the original matchmaking request. - MatchedPlayerSessions []*MatchedPlayerSession - // Amazon Resource Name (ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) // that is assigned to a game session and uniquely identifies it. @@ -966,6 +958,14 @@ type GameSessionConnectionInfo struct { // a Amazon GameLift game server, a client needs to reference an IP address (or DNS // name) and port number. IpAddress *string + + // A collection of player session IDs, one for each player ID that was included in + // the original matchmaking request. + MatchedPlayerSessions []*MatchedPlayerSession + + // Port number for the game session. To connect to a Amazon GameLift game server, + // an app needs both the IP address and port number. + Port *int32 } // A game session's properties plus the protection policy currently in force. @@ -998,35 +998,6 @@ type GameSessionDetail struct { // StopGameSessionPlacement () type GameSessionPlacement struct { - // A descriptive label that is associated with game session queue. Queue names must - // be unique within each Region. - GameSessionQueueName *string - - // Identifier for the game session created by this placement request. This value is - // set once the new game session is placed (placement status is FULFILLED). This - // identifier is unique across all Regions. You can use this value as a - // GameSessionId value as needed. - GameSessionArn *string - - // The maximum number of players that can be connected simultaneously to the game - // session. - MaximumPlayerSessionCount *int32 - - // A unique identifier for a game session placement. - PlacementId *string - - // Information on the matchmaking process for this game. Data is in JSON syntax, - // formatted as a string. It identifies the matchmaking configuration used to - // create the match, and contains data on all players assigned to the match, - // including player attributes and team assignments. For more details on matchmaker - // data, see Match Data - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/match-server.html#match-server-data). - MatchmakerData *string - - // A unique identifier for the game session. This value is set once the new game - // session is placed (placement status is FULFILLED). - GameSessionId *string - // DNS identifier assigned to the instance that is running the game session. Values // have the following format: // @@ -1042,14 +1013,38 @@ type GameSessionPlacement struct { // use the DNS name, not the IP address. DnsName *string + // Time stamp indicating when this request was completed, canceled, or timed out. + EndTime *time.Time + + // Set of custom properties for a game session, formatted as key:value pairs. These + // properties are passed to a game server process in the GameSession () object with + // a request to start a new game session (see Start a Game Session + // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). + GameProperties []*GameProperty + + // Identifier for the game session created by this placement request. This value is + // set once the new game session is placed (placement status is FULFILLED). This + // identifier is unique across all Regions. You can use this value as a + // GameSessionId value as needed. + GameSessionArn *string + + // Set of custom game session properties, formatted as a single string value. This + // data is passed to a game server process in the GameSession () object with a + // request to start a new game session (see Start a Game Session + // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). + GameSessionData *string + + // A unique identifier for the game session. This value is set once the new game + // session is placed (placement status is FULFILLED). + GameSessionId *string + // A descriptive label that is associated with a game session. Session names do not // need to be unique. GameSessionName *string - // Port number for the game session. To connect to a Amazon GameLift game server, - // an app needs both the IP address and port number. This value is set once the new - // game session is placed (placement status is FULFILLED). - Port *int32 + // A descriptive label that is associated with game session queue. Queue names must + // be unique within each Region. + GameSessionQueueName *string // Name of the Region where the game session created by this placement request is // running. This value is set once the new game session is placed (placement status @@ -1062,6 +1057,42 @@ type GameSessionPlacement struct { // (placement status is FULFILLED). IpAddress *string + // Information on the matchmaking process for this game. Data is in JSON syntax, + // formatted as a string. It identifies the matchmaking configuration used to + // create the match, and contains data on all players assigned to the match, + // including player attributes and team assignments. For more details on matchmaker + // data, see Match Data + // (https://docs.aws.amazon.com/gamelift/latest/developerguide/match-server.html#match-server-data). + MatchmakerData *string + + // The maximum number of players that can be connected simultaneously to the game + // session. + MaximumPlayerSessionCount *int32 + + // A collection of information on player sessions created in response to the game + // session placement request. These player sessions are created only once a new + // game session is successfully placed (placement status is FULFILLED). This + // information includes the player ID (as provided in the placement request) and + // the corresponding player session ID. Retrieve full player sessions by calling + // DescribePlayerSessions () with the player session ID. + PlacedPlayerSessions []*PlacedPlayerSession + + // A unique identifier for a game session placement. + PlacementId *string + + // Set of values, expressed in milliseconds, indicating the amount of latency that + // a player experiences when connected to AWS Regions. + PlayerLatencies []*PlayerLatency + + // Port number for the game session. To connect to a Amazon GameLift game server, + // an app needs both the IP address and port number. This value is set once the new + // game session is placed (placement status is FULFILLED). + Port *int32 + + // Time stamp indicating when this request was placed in the queue. Format is a + // number expressed in Unix time as milliseconds (for example "1469498468.057"). + StartTime *time.Time + // Current status of the game session placement request. // // * PENDING -- The @@ -1084,37 +1115,6 @@ type GameSessionPlacement struct { // terminated before the placement process was completed, or an unexpected internal // error. Status GameSessionPlacementState - - // Set of custom properties for a game session, formatted as key:value pairs. These - // properties are passed to a game server process in the GameSession () object with - // a request to start a new game session (see Start a Game Session - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). - GameProperties []*GameProperty - - // Set of custom game session properties, formatted as a single string value. This - // data is passed to a game server process in the GameSession () object with a - // request to start a new game session (see Start a Game Session - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). - GameSessionData *string - - // Time stamp indicating when this request was placed in the queue. Format is a - // number expressed in Unix time as milliseconds (for example "1469498468.057"). - StartTime *time.Time - - // A collection of information on player sessions created in response to the game - // session placement request. These player sessions are created only once a new - // game session is successfully placed (placement status is FULFILLED). This - // information includes the player ID (as provided in the placement request) and - // the corresponding player session ID. Retrieve full player sessions by calling - // DescribePlayerSessions () with the player session ID. - PlacedPlayerSessions []*PlacedPlayerSession - - // Set of values, expressed in milliseconds, indicating the amount of latency that - // a player experiences when connected to AWS Regions. - PlayerLatencies []*PlayerLatency - - // Time stamp indicating when this request was completed, canceled, or timed out. - EndTime *time.Time } // Configuration of a queue that is used to process game session placement @@ -1146,6 +1146,18 @@ type GameSessionPlacement struct { // DeleteGameSessionQueue () type GameSessionQueue struct { + // A list of fleets that can be used to fulfill game session placement requests in + // the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. + // Destinations are listed in default preference order. + Destinations []*GameSessionQueueDestination + + // Amazon Resource Name (ARN + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) + // that is assigned to a GameLift game session queue resource and uniquely + // identifies it. ARNs are unique across all Regions. In a GameLift game session + // queue ARN, the resource ID matches the Name value. + GameSessionQueueArn *string + // A descriptive label that is associated with game session queue. Queue names must // be unique within each Region. Name *string @@ -1160,18 +1172,6 @@ type GameSessionQueue struct { // policy for the remainder of the placement. PlayerLatencyPolicies []*PlayerLatencyPolicy - // Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) - // that is assigned to a GameLift game session queue resource and uniquely - // identifies it. ARNs are unique across all Regions. In a GameLift game session - // queue ARN, the resource ID matches the Name value. - GameSessionQueueArn *string - - // A list of fleets that can be used to fulfill game session placement requests in - // the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. - // Destinations are listed in default preference order. - Destinations []*GameSessionQueueDestination - // The maximum time, in seconds, that a new game session placement request remains // in the queue. When a request exceeds this time, the game session placement // changes to a TIMED_OUT status. @@ -1203,25 +1203,9 @@ type GameSessionQueueDestination struct { // one or more game servers. A fleet may contain zero or more instances. type Instance struct { - // EC2 instance type that defines the computing resources of this instance. - Type EC2InstanceType - - // Current status of the instance. Possible statuses include the following: - // - // * - // PENDING -- The instance is in the process of being created and launching server - // processes as defined in the fleet's run-time configuration. - // - // * ACTIVE -- The - // instance has been successfully created and at least one server process has - // successfully launched and reported back to Amazon GameLift that it is ready to - // host a game session. The instance is now considered ready to host game - // sessions. - // - // * TERMINATING -- The instance is in the process of shutting down. - // This may happen to reduce capacity during a scaling down event or to recycle - // resources in the event of a problem. - Status InstanceStatus + // Time stamp indicating when this data object was created. Format is a number + // expressed in Unix time as milliseconds (for example "1469498468.057"). + CreationTime *time.Time // DNS identifier assigned to the instance that is running the game session. Values // have the following format: @@ -1238,41 +1222,57 @@ type Instance struct { // use the DNS name, not the IP address. DnsName *string - // IP address that is assigned to the instance. - IpAddress *string - // A unique identifier for a fleet that the instance is in. FleetId *string // A unique identifier for an instance. InstanceId *string + // IP address that is assigned to the instance. + IpAddress *string + // Operating system that is running on this instance. OperatingSystem OperatingSystem - // Time stamp indicating when this data object was created. Format is a number - // expressed in Unix time as milliseconds (for example "1469498468.057"). - CreationTime *time.Time + // Current status of the instance. Possible statuses include the following: + // + // * + // PENDING -- The instance is in the process of being created and launching server + // processes as defined in the fleet's run-time configuration. + // + // * ACTIVE -- The + // instance has been successfully created and at least one server process has + // successfully launched and reported back to Amazon GameLift that it is ready to + // host a game session. The instance is now considered ready to host game + // sessions. + // + // * TERMINATING -- The instance is in the process of shutting down. + // This may happen to reduce capacity during a scaling down event or to recycle + // resources in the event of a problem. + Status InstanceStatus + + // EC2 instance type that defines the computing resources of this instance. + Type EC2InstanceType } // Information required to remotely connect to a fleet instance. Access is // requested by calling GetInstanceAccess (). type InstanceAccess struct { - // Operating system that is running on the instance. - OperatingSystem OperatingSystem - // Credentials required to access the instance. Credentials *InstanceCredentials + // A unique identifier for a fleet containing the instance being accessed. + FleetId *string + // A unique identifier for an instance being accessed. InstanceId *string // IP address that is assigned to the instance. IpAddress *string - // A unique identifier for a fleet containing the instance being accessed. - FleetId *string + // Operating system that is running on the instance. + OperatingSystem OperatingSystem } // Set of credentials required to remotely access a fleet instance. Access @@ -1280,13 +1280,13 @@ type InstanceAccess struct { // InstanceAccess () object. type InstanceCredentials struct { - // User login string. - UserName *string - // Secret string. For Windows instances, the secret is a password for use with // Windows Remote Desktop. For Linux instances, it is a private key (which must be // saved as a .pem file) for use with SSH. Secret *string + + // User login string. + UserName *string } // This data type is part of Amazon GameLift FleetIQ with game server groups, which @@ -1296,6 +1296,11 @@ type InstanceCredentials struct { // list of viable instance types. type InstanceDefinition struct { + // An EC2 instance type designation. + // + // This member is required. + InstanceType GameServerGroupInstanceType + // Instance weighting that indicates how much this instance type contributes to the // total capacity of a game server group. Instance weights are used by GameLift // FleetIQ to calculate the instance type's cost per unit hour and better identify @@ -1304,11 +1309,6 @@ type InstanceDefinition struct { // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html) // in the Amazon EC2 Auto Scaling User Guide. Default value is "1". WeightedCapacity *string - - // An EC2 instance type designation. - // - // This member is required. - InstanceType GameServerGroupInstanceType } // A range of IP addresses and port settings that allow inbound traffic to connect @@ -1321,6 +1321,11 @@ type InstanceDefinition struct { // servers. type IpPermission struct { + // A starting value for a range of allowed port numbers. + // + // This member is required. + FromPort *int32 + // A range of allowed IP addresses. This value must be expressed in CIDR notation. // Example: "000.000.000.000/[subnet mask]" or optionally the shortened version // "0.0.0.0/[subnet mask]". @@ -1328,21 +1333,16 @@ type IpPermission struct { // This member is required. IpRange *string - // An ending value for a range of allowed port numbers. Port numbers are - // end-inclusive. This value must be higher than FromPort. - // - // This member is required. - ToPort *int32 - // The network communication protocol used by the fleet. // // This member is required. Protocol IpProtocol - // A starting value for a range of allowed port numbers. + // An ending value for a range of allowed port numbers. Port numbers are + // end-inclusive. This value must be higher than FromPort. // // This member is required. - FromPort *int32 + ToPort *int32 } // This data type is part of Amazon GameLift FleetIQ with game server groups, which @@ -1351,6 +1351,9 @@ type IpPermission struct { // instances in a game server group. type LaunchTemplateSpecification struct { + // A unique identifier for an existing EC2 launch template. + LaunchTemplateId *string + // A readable identifier for an existing EC2 launch template. LaunchTemplateName *string @@ -1358,9 +1361,6 @@ type LaunchTemplateSpecification struct { // default version will be used. EC2 allows you to specify a default version for a // launch template, if none is set, the default is the first version created. Version *string - - // A unique identifier for an existing EC2 launch template. - LaunchTemplateId *string } // Represents a new player session that is created as a result of a successful @@ -1381,6 +1381,21 @@ type MatchedPlayerSession struct { // requests must specify a matchmaking configuration. type MatchmakingConfiguration struct { + // A flag that indicates whether a match that was created with this configuration + // must be accepted by the matched players. To require acceptance, set to TRUE. + AcceptanceRequired *bool + + // The length of time (in seconds) to wait for players to accept a proposed match. + // If any player rejects the match or fails to accept before the timeout, the + // ticket continues to look for an acceptable match. + AcceptanceTimeoutSeconds *int32 + + // The number of player slots in a match to keep open for future players. For + // example, assume that the configuration's rule set specifies a match for a single + // 12-person team. If the additional player count is set to 2, only 10 players are + // initially selected for the match. + AdditionalPlayerCount *int32 + // The method used to backfill game sessions created with this matchmaking // configuration. MANUAL indicates that the game makes backfill requests or does // not use the match backfill feature. AUTOMATIC indicates that GameLift creates @@ -1390,10 +1405,6 @@ type MatchmakingConfiguration struct { // (https://docs.aws.amazon.com/gamelift/latest/developerguide/match-backfill.html). BackfillMode BackfillMode - // A flag that indicates whether a match that was created with this configuration - // must be accepted by the matched players. To require acceptance, set to TRUE. - AcceptanceRequired *bool - // Amazon Resource Name (ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) // that is assigned to a GameLift matchmaking configuration resource and uniquely @@ -1405,16 +1416,19 @@ type MatchmakingConfiguration struct { // number expressed in Unix time as milliseconds (for example "1469498468.057"). CreationTime *time.Time + // Information to attach to all events related to the matchmaking configuration. + CustomEventData *string + // A descriptive label that is associated with matchmaking configuration. Description *string - // Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) - // that is assigned to a GameLift game session queue resource and uniquely - // identifies it. ARNs are unique across all Regions. GameLift uses the listed - // queues when placing game sessions for matches that are created with this - // matchmaking configuration. Queues can be located in any Region. - GameSessionQueueArns []*string + // A set of custom properties for a game session, formatted as key-value pairs. + // These properties are passed to a game server process in the GameSession () + // object with a request to start a new game session (see Start a Game Session + // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). + // This information is added to the new GameSession () object that is created for a + // successful match. + GameProperties []*GameProperty // A set of custom game session properties, formatted as a single string value. // This data is passed to a game server process in the GameSession () object with a @@ -1424,35 +1438,17 @@ type MatchmakingConfiguration struct { // successful match. GameSessionData *string - // The Amazon Resource Name (ARN + // Amazon Resource Name (ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) - // associated with the GameLift matchmaking rule set resource that this - // configuration uses. - RuleSetArn *string - - // The number of player slots in a match to keep open for future players. For - // example, assume that the configuration's rule set specifies a match for a single - // 12-person team. If the additional player count is set to 2, only 10 players are - // initially selected for the match. - AdditionalPlayerCount *int32 - - // A unique identifier for a matchmaking rule set to use with this configuration. A - // matchmaking configuration can only use rule sets that are defined in the same - // Region. - RuleSetName *string - - // A set of custom properties for a game session, formatted as key-value pairs. - // These properties are passed to a game server process in the GameSession () - // object with a request to start a new game session (see Start a Game Session - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). - // This information is added to the new GameSession () object that is created for a - // successful match. - GameProperties []*GameProperty + // that is assigned to a GameLift game session queue resource and uniquely + // identifies it. ARNs are unique across all Regions. GameLift uses the listed + // queues when placing game sessions for matches that are created with this + // matchmaking configuration. Queues can be located in any Region. + GameSessionQueueArns []*string - // The length of time (in seconds) to wait for players to accept a proposed match. - // If any player rejects the match or fails to accept before the timeout, the - // ticket continues to look for an acceptable match. - AcceptanceTimeoutSeconds *int32 + // A unique identifier for a matchmaking configuration. This name is used to + // identify the configuration associated with a matchmaking request or ticket. + Name *string // An SNS topic ARN that is set up to receive matchmaking notifications. NotificationTarget *string @@ -1462,12 +1458,16 @@ type MatchmakingConfiguration struct { // resubmitted as needed. RequestTimeoutSeconds *int32 - // Information to attach to all events related to the matchmaking configuration. - CustomEventData *string + // The Amazon Resource Name (ARN + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) + // associated with the GameLift matchmaking rule set resource that this + // configuration uses. + RuleSetArn *string - // A unique identifier for a matchmaking configuration. This name is used to - // identify the configuration associated with a matchmaking request or ticket. - Name *string + // A unique identifier for a matchmaking rule set to use with this configuration. A + // matchmaking configuration can only use rule sets that are defined in the same + // Region. + RuleSetName *string } // Set of rule statements, used with FlexMatch, that determine how to build your @@ -1506,9 +1506,6 @@ type MatchmakingConfiguration struct { // between players after 30 seconds. type MatchmakingRuleSet struct { - // A unique identifier for a matchmaking rule set - RuleSetName *string - // A collection of matchmaking rules, formatted as a JSON string. Comments are not // allowed in JSON, but most elements support a description field. // @@ -1525,6 +1522,9 @@ type MatchmakingRuleSet struct { // identifies it. ARNs are unique across all Regions. In a GameLift rule set ARN, // the resource ID matches the RuleSetName value. RuleSetArn *string + + // A unique identifier for a matchmaking rule set + RuleSetName *string } // Ticket generated to track the progress of a matchmaking request. Each ticket is @@ -1533,14 +1533,22 @@ type MatchmakingRuleSet struct { // calling DescribeMatchmaking () with the ticket ID. type MatchmakingTicket struct { - // A unique identifier for a matchmaking ticket. - TicketId *string + // The Amazon Resource Name (ARN + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) + // associated with the GameLift matchmaking configuration resource that is used + // with this ticket. + ConfigurationArn *string // Name of the MatchmakingConfiguration () that is used with this ticket. // Matchmaking configurations determine how players are grouped into a match and // how a new game session is created for the match. ConfigurationName *string + // Time stamp indicating when this matchmaking request stopped being processed due + // to success, failure, or cancellation. Format is a number expressed in Unix time + // as milliseconds (for example "1469498468.057"). + EndTime *time.Time + // Average amount of time (in seconds) that players are currently waiting for a // match. If there is not enough recent data, this property may be empty. EstimatedWaitTime *int32 @@ -1550,6 +1558,16 @@ type MatchmakingTicket struct { // been successfully completed. GameSessionConnectionInfo *GameSessionConnectionInfo + // A set of Player objects, each representing a player to find matches for. Players + // are identified by a unique player ID and may include latency data for use during + // matchmaking. If the ticket is in status COMPLETED, the Player objects include + // the team the players were assigned to in the resulting match. + Players []*Player + + // Time stamp indicating when this matchmaking request was received. Format is a + // number expressed in Unix time as milliseconds (for example "1469498468.057"). + StartTime *time.Time + // Current status of the matchmaking request. // // * QUEUED -- The matchmaking @@ -1587,34 +1605,16 @@ type MatchmakingTicket struct { // requests with new ticket IDs. Status MatchmakingConfigurationStatus - // Time stamp indicating when this matchmaking request was received. Format is a - // number expressed in Unix time as milliseconds (for example "1469498468.057"). - StartTime *time.Time + // Additional information about the current status. + StatusMessage *string // Code to explain the current status. For example, a status reason may indicate // when a ticket has returned to SEARCHING status after a proposed match fails to // receive player acceptances. StatusReason *string - // Additional information about the current status. - StatusMessage *string - - // Time stamp indicating when this matchmaking request stopped being processed due - // to success, failure, or cancellation. Format is a number expressed in Unix time - // as milliseconds (for example "1469498468.057"). - EndTime *time.Time - - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) - // associated with the GameLift matchmaking configuration resource that is used - // with this ticket. - ConfigurationArn *string - - // A set of Player objects, each representing a player to find matches for. Players - // are identified by a unique player ID and may include latency data for use during - // matchmaking. If the ticket is in status COMPLETED, the Player objects include - // the team the players were assigned to in the resulting match. - Players []*Player + // A unique identifier for a matchmaking ticket. + TicketId *string } // Information about a player session that was created as part of a @@ -1667,12 +1667,12 @@ type Player struct { // "gameMode": {"S": "deathmatch"}}. PlayerAttributes map[string]*AttributeValue + // A unique identifier for a player + PlayerId *string + // Name of the team that the player is assigned to in a match. Team names are // defined in a matchmaking rule set. Team *string - - // A unique identifier for a player - PlayerId *string } // Regional latency information for a player, used when requesting a new game @@ -1683,13 +1683,13 @@ type Player struct { // session for the player. type PlayerLatency struct { - // A unique identifier for a player associated with the latency data. - PlayerId *string - // Amount of time that represents the time lag experienced by the player when // connected to the specified Region. LatencyInMilliseconds *float32 + // A unique identifier for a player associated with the latency data. + PlayerId *string + // Name of the Region that is associated with the latency value. RegionIdentifier *string } @@ -1749,37 +1749,9 @@ type PlayerLatencyPolicy struct { // * StopGameSessionPlacement () type PlayerSession struct { - // A unique identifier for the game session that the player session is connected - // to. - GameSessionId *string - - // Current status of the player session. Possible player session statuses include - // the following: - // - // * RESERVED -- The player session request has been received, - // but the player has not yet connected to the server process and/or been - // validated. - // - // * ACTIVE -- The player has been validated by the server process - // and is currently connected. - // - // * COMPLETED -- The player connection has been - // dropped. - // - // * TIMEDOUT -- A player session request was received, but the - // player did not connect and/or was not validated within the timeout limit (60 - // seconds). - Status PlayerSessionStatus - - // Port number for the game session. To connect to a Amazon GameLift server - // process, an app needs both the IP address and port number. - Port *int32 - - // A unique identifier for a player that is associated with this player session. - PlayerId *string - - // A unique identifier for a fleet that the player's game session is running on. - FleetId *string + // Time stamp indicating when this data object was created. Format is a number + // expressed in Unix time as milliseconds (for example "1469498468.057"). + CreationTime *time.Time // DNS identifier assigned to the instance that is running the game session. Values // have the following format: @@ -1796,16 +1768,17 @@ type PlayerSession struct { // use the DNS name, not the IP address. DnsName *string - // A unique identifier for a player session. - PlayerSessionId *string + // The Amazon Resource Name (ARN + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) + // associated with the GameLift fleet that the player's game session is running on. + FleetArn *string - // Time stamp indicating when this data object was created. Format is a number - // expressed in Unix time as milliseconds (for example "1469498468.057"). - CreationTime *time.Time + // A unique identifier for a fleet that the player's game session is running on. + FleetId *string - // Time stamp indicating when this data object was terminated. Format is a number - // expressed in Unix time as milliseconds (for example "1469498468.057"). - TerminationTime *time.Time + // A unique identifier for the game session that the player session is connected + // to. + GameSessionId *string // IP address of the instance that is running the game session. When connecting to // a Amazon GameLift game server, a client needs to reference an IP address (or DNS @@ -1816,10 +1789,37 @@ type PlayerSession struct { // this data, so it can be formatted as needed for use in the game. PlayerData *string - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) - // associated with the GameLift fleet that the player's game session is running on. - FleetArn *string + // A unique identifier for a player that is associated with this player session. + PlayerId *string + + // A unique identifier for a player session. + PlayerSessionId *string + + // Port number for the game session. To connect to a Amazon GameLift server + // process, an app needs both the IP address and port number. + Port *int32 + + // Current status of the player session. Possible player session statuses include + // the following: + // + // * RESERVED -- The player session request has been received, + // but the player has not yet connected to the server process and/or been + // validated. + // + // * ACTIVE -- The player has been validated by the server process + // and is currently connected. + // + // * COMPLETED -- The player connection has been + // dropped. + // + // * TIMEDOUT -- A player session request was received, but the + // player did not connect and/or was not validated within the timeout limit (60 + // seconds). + Status PlayerSessionStatus + + // Time stamp indicating when this data object was terminated. Format is a number + // expressed in Unix time as milliseconds (for example "1469498468.057"). + TerminationTime *time.Time } // A policy that limits the number of game sessions a player can create on the same @@ -1858,6 +1858,13 @@ type ResourceCreationLimitPolicy struct { // * ResolveAlias () type RoutingStrategy struct { + // The unique identifier for a fleet that the alias points to. This value is the + // fleet ID, not the fleet ARN. + FleetId *string + + // The message text to be used with a terminal routing strategy. + Message *string + // The type of routing strategy for the alias. Possible routing types include the // following: // @@ -1869,13 +1876,6 @@ type RoutingStrategy struct { // alias throws a TerminalRoutingStrategyException with the RoutingStrategy () // message embedded. Type RoutingStrategyType - - // The unique identifier for a fleet that the alias points to. This value is the - // fleet ID, not the fleet ARN. - FleetId *string - - // The message text to be used with a terminal routing strategy. - Message *string } // A collection of server process configurations that describe what processes to @@ -1907,6 +1907,11 @@ type RoutingStrategy struct { // StartFleetActions () or StopFleetActions () type RuntimeConfiguration struct { + // The maximum amount of time (in seconds) that a game session can remain in status + // ACTIVATING. If the game session is not active before the timeout, activation is + // terminated and the game session status is changed to TERMINATED. + GameSessionActivationTimeoutSeconds *int32 + // The maximum number of game sessions with status ACTIVATING to allow on an // instance simultaneously. This setting limits the amount of instance resources // that can be used for new game activations at any one time. @@ -1915,11 +1920,6 @@ type RuntimeConfiguration struct { // A collection of server process configurations that describe which server // processes to run on each instance in a fleet. ServerProcesses []*ServerProcess - - // The maximum amount of time (in seconds) that a game session can remain in status - // ACTIVATING. If the game session is not active before the timeout, activation is - // terminated and the game session status is changed to TERMINATED. - GameSessionActivationTimeoutSeconds *int32 } // The location in S3 where build or script files are stored for access by Amazon @@ -1933,16 +1933,16 @@ type S3Location struct { // The name of the zip file that contains the build files or script files. Key *string - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) for an IAM - // role that allows Amazon GameLift to access the S3 bucket. - RoleArn *string - // The version of the file, if object versioning is turned on for the bucket. // Amazon GameLift uses this information when retrieving files from an S3 bucket // that you own. Use this parameter to specify a specific version of the file. If // not set, the latest version of the file is retrieved. ObjectVersion *string + + // The Amazon Resource Name (ARN + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) for an IAM + // role that allows Amazon GameLift to access the S3 bucket. + RoleArn *string } // Rule that controls how a fleet is scaled. Scaling policies are uniquely @@ -1974,6 +1974,16 @@ type S3Location struct { // * StopFleetActions () type ScalingPolicy struct { + // Comparison operator to use when measuring a metric against the threshold value. + ComparisonOperator ComparisonOperatorType + + // Length of time (in minutes) the metric must be at or beyond the threshold before + // a scaling event is triggered. + EvaluationPeriods *int32 + + // A unique identifier for a fleet that is associated with this scaling policy. + FleetId *string + // Name of the Amazon GameLift-defined metric that is used to trigger a scaling // adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon // GameLift with Amazon CloudWatch @@ -2021,9 +2031,35 @@ type ScalingPolicy struct { // destination. MetricName MetricName + // A descriptive label that is associated with a scaling policy. Policy names do + // not need to be unique. + Name *string + + // The type of scaling policy to create. For a target-based policy, set the + // parameter MetricName to 'PercentAvailableGameSessions' and specify a + // TargetConfiguration. For a rule-based policy set the following parameters: + // MetricName, ComparisonOperator, Threshold, EvaluationPeriods, + // ScalingAdjustmentType, and ScalingAdjustment. + PolicyType PolicyType + // Amount of adjustment to make, based on the scaling adjustment type. ScalingAdjustment *int32 + // The type of adjustment to make to a fleet's instance count (see FleetCapacity + // ()): + // + // * ChangeInCapacity -- add (or subtract) the scaling adjustment value + // from the current instance count. Positive values scale up while negative values + // scale down. + // + // * ExactCapacity -- set the instance count to the scaling + // adjustment value. + // + // * PercentChangeInCapacity -- increase or reduce the + // current instance count by the scaling adjustment, read as a percentage. Positive + // values scale up while negative values scale down. + ScalingAdjustmentType ScalingAdjustmentType + // Current status of the scaling policy. The scaling policy can be in force only // when in an ACTIVE status. Scaling policies can be suspended for individual // fleets (see StopFleetActions (); if suspended for a fleet, the policy status @@ -2054,44 +2090,8 @@ type ScalingPolicy struct { // The settings for a target-based scaling policy. TargetConfiguration *TargetConfiguration - // Comparison operator to use when measuring a metric against the threshold value. - ComparisonOperator ComparisonOperatorType - - // A descriptive label that is associated with a scaling policy. Policy names do - // not need to be unique. - Name *string - // Metric value used to trigger a scaling event. Threshold *float64 - - // The type of adjustment to make to a fleet's instance count (see FleetCapacity - // ()): - // - // * ChangeInCapacity -- add (or subtract) the scaling adjustment value - // from the current instance count. Positive values scale up while negative values - // scale down. - // - // * ExactCapacity -- set the instance count to the scaling - // adjustment value. - // - // * PercentChangeInCapacity -- increase or reduce the - // current instance count by the scaling adjustment, read as a percentage. Positive - // values scale up while negative values scale down. - ScalingAdjustmentType ScalingAdjustmentType - - // Length of time (in minutes) the metric must be at or beyond the threshold before - // a scaling event is triggered. - EvaluationPeriods *int32 - - // The type of scaling policy to create. For a target-based policy, set the - // parameter MetricName to 'PercentAvailableGameSessions' and specify a - // TargetConfiguration. For a rule-based policy set the following parameters: - // MetricName, ComparisonOperator, Threshold, EvaluationPeriods, - // ScalingAdjustmentType, and ScalingAdjustment. - PolicyType PolicyType - - // A unique identifier for a fleet that is associated with this scaling policy. - FleetId *string } // Properties describing a Realtime script. Related operations @@ -2109,14 +2109,13 @@ type ScalingPolicy struct { // DeleteScript () type Script struct { - // The location in S3 where build or script files are stored for access by Amazon - // GameLift. This location is specified in CreateBuild (), CreateScript (), and - // UpdateScript () requests. - StorageLocation *S3Location + // A time stamp indicating when this data object was created. The format is a + // number expressed in Unix time as milliseconds (for example "1469498468.057"). + CreationTime *time.Time - // The file size of the uploaded Realtime script, expressed in bytes. When files - // are uploaded from an S3 location, this value remains at "0". - SizeOnDisk *int64 + // A descriptive label that is associated with a script. Script names do not need + // to be unique. + Name *string // Amazon Resource Name (ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) @@ -2125,20 +2124,21 @@ type Script struct { // the ScriptId value. ScriptArn *string - // The version that is associated with a build or script. Version strings do not - // need to be unique. - Version *string + // A unique identifier for a Realtime script + ScriptId *string - // A time stamp indicating when this data object was created. The format is a - // number expressed in Unix time as milliseconds (for example "1469498468.057"). - CreationTime *time.Time + // The file size of the uploaded Realtime script, expressed in bytes. When files + // are uploaded from an S3 location, this value remains at "0". + SizeOnDisk *int64 - // A descriptive label that is associated with a script. Script names do not need - // to be unique. - Name *string + // The location in S3 where build or script files are stored for access by Amazon + // GameLift. This location is specified in CreateBuild (), CreateScript (), and + // UpdateScript () requests. + StorageLocation *S3Location - // A unique identifier for a Realtime script - ScriptId *string + // The version that is associated with a build or script. Version strings do not + // need to be unique. + Version *string } // A set of instructions for launching server processes on each instance in a @@ -2156,10 +2156,6 @@ type ServerProcess struct { // This member is required. ConcurrentExecutions *int32 - // An optional list of parameters to pass to the server executable or Realtime - // script on launch. - Parameters *string - // The location of the server executable in a custom game build or the name of the // Realtime script file that contains the Init() function. Game builds and Realtime // scripts are installed on instances at the root: @@ -2173,6 +2169,10 @@ type ServerProcess struct { // // This member is required. LaunchPath *string + + // An optional list of parameters to pass to the server executable or Realtime + // script on launch. + Parameters *string } // A label that can be assigned to a GameLift resource. Learn more Tagging AWS @@ -2278,17 +2278,22 @@ type TargetTrackingConfiguration struct { // * DeleteVpcPeeringConnection () type VpcPeeringAuthorization struct { - // - PeerVpcAwsAccountId *string + // Time stamp indicating when this authorization was issued. Format is a number + // expressed in Unix time as milliseconds (for example "1469498468.057"). + CreationTime *time.Time // Time stamp indicating when this authorization expires (24 hours after issuance). // Format is a number expressed in Unix time as milliseconds (for example // "1469498468.057"). ExpirationTime *time.Time - // Time stamp indicating when this authorization was issued. Format is a number - // expressed in Unix time as milliseconds (for example "1469498468.057"). - CreationTime *time.Time + // A unique identifier for the AWS account that you use to manage your Amazon + // GameLift fleet. You can find your Account ID in the AWS Management Console under + // account settings. + GameLiftAwsAccountId *string + + // + PeerVpcAwsAccountId *string // A unique identifier for a VPC with resources to be accessed by your Amazon // GameLift fleet. The VPC must be in the same Region where your fleet is deployed. @@ -2297,11 +2302,6 @@ type VpcPeeringAuthorization struct { // Amazon GameLift Fleets // (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). PeerVpcId *string - - // A unique identifier for the AWS account that you use to manage your Amazon - // GameLift fleet. You can find your Account ID in the AWS Management Console under - // account settings. - GameLiftAwsAccountId *string } // Represents a peering connection between a VPC on one of your AWS accounts and @@ -2324,33 +2324,24 @@ type VpcPeeringAuthorization struct { // * DeleteVpcPeeringConnection () type VpcPeeringConnection struct { - // The status information about the connection. Status indicates if a connection is - // pending, successful, or failed. - Status *VpcPeeringConnectionStatus - - // A unique identifier that is automatically assigned to the connection record. - // This ID is referenced in VPC peering connection events, and is used when - // deleting a connection with DeleteVpcPeeringConnection (). - VpcPeeringConnectionId *string - // The Amazon Resource Name (ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) // associated with the GameLift fleet resource for this connection. FleetArn *string - // CIDR block of IPv4 addresses assigned to the VPC peering connection for the - // GameLift VPC. The peered VPC also has an IPv4 CIDR block associated with it; - // these blocks cannot overlap or the peering connection cannot be created. - IpV4CidrBlock *string + // A unique identifier for a fleet. This ID determines the ID of the Amazon + // GameLift VPC for your fleet. + FleetId *string // A unique identifier for the VPC that contains the Amazon GameLift fleet for this // connection. This VPC is managed by Amazon GameLift and does not appear in your // AWS account. GameLiftVpcId *string - // A unique identifier for a fleet. This ID determines the ID of the Amazon - // GameLift VPC for your fleet. - FleetId *string + // CIDR block of IPv4 addresses assigned to the VPC peering connection for the + // GameLift VPC. The peered VPC also has an IPv4 CIDR block associated with it; + // these blocks cannot overlap or the peering connection cannot be created. + IpV4CidrBlock *string // A unique identifier for a VPC with resources to be accessed by your Amazon // GameLift fleet. The VPC must be in the same Region where your fleet is deployed. @@ -2359,6 +2350,15 @@ type VpcPeeringConnection struct { // Amazon GameLift Fleets // (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). PeerVpcId *string + + // The status information about the connection. Status indicates if a connection is + // pending, successful, or failed. + Status *VpcPeeringConnectionStatus + + // A unique identifier that is automatically assigned to the connection record. + // This ID is referenced in VPC peering connection events, and is used when + // deleting a connection with DeleteVpcPeeringConnection (). + VpcPeeringConnectionId *string } // Represents status information for a VPC peering connection. Status is associated diff --git a/service/glacier/api_op_AbortMultipartUpload.go b/service/glacier/api_op_AbortMultipartUpload.go index b2e7039f715..7d3d8157fdb 100644 --- a/service/glacier/api_op_AbortMultipartUpload.go +++ b/service/glacier/api_op_AbortMultipartUpload.go @@ -83,11 +83,6 @@ func (c *Client) AbortMultipartUpload(ctx context.Context, params *AbortMultipar // with Archives in Amazon S3 Glacier.

    type AbortMultipartUploadInput struct { - // The name of the vault. - // - // This member is required. - VaultName *string - // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), in // which case Amazon S3 Glacier uses the AWS account ID associated with the @@ -101,6 +96,11 @@ type AbortMultipartUploadInput struct { // // This member is required. UploadId *string + + // The name of the vault. + // + // This member is required. + VaultName *string } type AbortMultipartUploadOutput struct { diff --git a/service/glacier/api_op_AddTagsToVault.go b/service/glacier/api_op_AddTagsToVault.go index 2dd3f5172f3..a4a0c6f9804 100644 --- a/service/glacier/api_op_AddTagsToVault.go +++ b/service/glacier/api_op_AddTagsToVault.go @@ -67,15 +67,6 @@ func (c *Client) AddTagsToVault(ctx context.Context, params *AddTagsToVaultInput // The input values for AddTagsToVault. type AddTagsToVaultInput struct { - // The tags to add to the vault. Each tag is composed of a key and a value. The - // value can be an empty string. - Tags map[string]*string - - // The name of the vault. - // - // This member is required. - VaultName *string - // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), in // which case Amazon S3 Glacier uses the AWS account ID associated with the @@ -84,6 +75,15 @@ type AddTagsToVaultInput struct { // // This member is required. AccountId *string + + // The name of the vault. + // + // This member is required. + VaultName *string + + // The tags to add to the vault. Each tag is composed of a key and a value. The + // value can be an empty string. + Tags map[string]*string } type AddTagsToVaultOutput struct { diff --git a/service/glacier/api_op_CompleteMultipartUpload.go b/service/glacier/api_op_CompleteMultipartUpload.go index 727fe17f19e..d3ead880722 100644 --- a/service/glacier/api_op_CompleteMultipartUpload.go +++ b/service/glacier/api_op_CompleteMultipartUpload.go @@ -140,12 +140,12 @@ type CompleteMultipartUploadInput struct { // (https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html). type CompleteMultipartUploadOutput struct { - // The checksum of the archive computed by Amazon S3 Glacier. - Checksum *string - // The ID of the archive. This value is also included as part of the location. ArchiveId *string + // The checksum of the archive computed by Amazon S3 Glacier. + Checksum *string + // The relative URI path of the newly added archive resource. Location *string diff --git a/service/glacier/api_op_CompleteVaultLock.go b/service/glacier/api_op_CompleteVaultLock.go index ea0902162f6..7ec8e342907 100644 --- a/service/glacier/api_op_CompleteVaultLock.go +++ b/service/glacier/api_op_CompleteVaultLock.go @@ -73,25 +73,25 @@ func (c *Client) CompleteVaultLock(ctx context.Context, params *CompleteVaultLoc // The input values for CompleteVaultLock. type CompleteVaultLockInput struct { - // The name of the vault. + // The AccountId value is the AWS account ID. This value must match the AWS account + // ID associated with the credentials used to sign the request. You can either + // specify an AWS account ID or optionally a single '-' (hyphen), in which case + // Amazon Glacier uses the AWS account ID associated with the credentials used to + // sign the request. If you specify your account ID, do not include any hyphens + // ('-') in the ID. // // This member is required. - VaultName *string + AccountId *string // The lockId value is the lock ID obtained from a InitiateVaultLock () request. // // This member is required. LockId *string - // The AccountId value is the AWS account ID. This value must match the AWS account - // ID associated with the credentials used to sign the request. You can either - // specify an AWS account ID or optionally a single '-' (hyphen), in which case - // Amazon Glacier uses the AWS account ID associated with the credentials used to - // sign the request. If you specify your account ID, do not include any hyphens - // ('-') in the ID. + // The name of the vault. // // This member is required. - AccountId *string + VaultName *string } type CompleteVaultLockOutput struct { diff --git a/service/glacier/api_op_DeleteArchive.go b/service/glacier/api_op_DeleteArchive.go index 4e2f85242d3..3a356ff1091 100644 --- a/service/glacier/api_op_DeleteArchive.go +++ b/service/glacier/api_op_DeleteArchive.go @@ -86,24 +86,24 @@ func (c *Client) DeleteArchive(ctx context.Context, params *DeleteArchiveInput, // Provides options for deleting an archive from an Amazon S3 Glacier vault. type DeleteArchiveInput struct { - // The name of the vault. + // The AccountId value is the AWS account ID of the account that owns the vault. + // You can either specify an AWS account ID or optionally a single '-' (hyphen), in + // which case Amazon S3 Glacier uses the AWS account ID associated with the + // credentials used to sign the request. If you use an account ID, do not include + // any hyphens ('-') in the ID. // // This member is required. - VaultName *string + AccountId *string // The ID of the archive to delete. // // This member is required. ArchiveId *string - // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the - // credentials used to sign the request. If you use an account ID, do not include - // any hyphens ('-') in the ID. + // The name of the vault. // // This member is required. - AccountId *string + VaultName *string } type DeleteArchiveOutput struct { diff --git a/service/glacier/api_op_DescribeJob.go b/service/glacier/api_op_DescribeJob.go index 223252a4cc0..7a1a2aad21a 100644 --- a/service/glacier/api_op_DescribeJob.go +++ b/service/glacier/api_op_DescribeJob.go @@ -80,11 +80,6 @@ func (c *Client) DescribeJob(ctx context.Context, params *DescribeJobInput, optF // Provides options for retrieving a job description. type DescribeJobInput struct { - // The ID of the job to describe. - // - // This member is required. - JobId *string - // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), in // which case Amazon S3 Glacier uses the AWS account ID associated with the @@ -94,6 +89,11 @@ type DescribeJobInput struct { // This member is required. AccountId *string + // The ID of the job to describe. + // + // This member is required. + JobId *string + // The name of the vault. // // This member is required. @@ -103,45 +103,26 @@ type DescribeJobInput struct { // Contains the description of an Amazon S3 Glacier job. type DescribeJobOutput struct { - // An opaque string that identifies an Amazon S3 Glacier job. - JobId *string - - // The status code can be InProgress, Succeeded, or Failed, and indicates the - // status of the job. - StatusCode types.StatusCode - - // Contains the job output location. - JobOutputPath *string - - // The job description provided when initiating the job. - JobDescription *string - - // The SHA256 tree hash of the entire archive for an archive retrieval. For - // inventory retrieval or select jobs, this field is null. - ArchiveSHA256TreeHash *string - - // The retrieved byte range for archive retrieval jobs in the form - // StartByteValue-EndByteValue. If no range was specified in the archive retrieval, - // then the whole archive is retrieved. In this case, StartByteValue equals 0 and - // EndByteValue equals the size of the archive minus 1. For inventory retrieval or - // select jobs, this field is null. - RetrievalByteRange *string + // The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or + // Select. + Action types.ActionCode // The archive ID requested for a select job or archive retrieval. Otherwise, this // field is null. ArchiveId *string - // The job status. When a job is completed, you get the job's output using Get Job - // Output (GET output). - Completed *bool + // The SHA256 tree hash of the entire archive for an archive retrieval. For + // inventory retrieval or select jobs, this field is null. + ArchiveSHA256TreeHash *string // For an archive retrieval job, this value is the size in bytes of the archive // being requested for download. For an inventory retrieval or select job, this // value is null. ArchiveSizeInBytes *int64 - // Contains the parameters used for a select. - SelectParameters *types.SelectParameters + // The job status. When a job is completed, you get the job's output using Get Job + // Output (GET output). + Completed *bool // The UTC time that the job request completed. While the job is in progress, the // value is null. @@ -151,28 +132,32 @@ type DescribeJobOutput struct { // ISO 8601 date format, for example "2012-03-20T17:03:43.221Z". CreationDate *string - // A friendly message that describes the job status. - StatusMessage *string - - // The Amazon Resource Name (ARN) of the vault from which an archive retrieval was - // requested. - VaultARN *string - - // The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or - // Select. - Action types.ActionCode - - // The tier to use for a select or an archive retrieval. Valid values are - // Expedited, Standard, or Bulk. Standard is the default. - Tier *string + // Parameters used for range inventory retrieval. + InventoryRetrievalParameters *types.InventoryRetrievalJobDescription // For an inventory retrieval job, this value is the size in bytes of the inventory // requested for download. For an archive retrieval or select job, this value is // null. InventorySizeInBytes *int64 - // Parameters used for range inventory retrieval. - InventoryRetrievalParameters *types.InventoryRetrievalJobDescription + // The job description provided when initiating the job. + JobDescription *string + + // An opaque string that identifies an Amazon S3 Glacier job. + JobId *string + + // Contains the job output location. + JobOutputPath *string + + // Contains the location where the data from the select job is stored. + OutputLocation *types.OutputLocation + + // The retrieved byte range for archive retrieval jobs in the form + // StartByteValue-EndByteValue. If no range was specified in the archive retrieval, + // then the whole archive is retrieved. In this case, StartByteValue equals 0 and + // EndByteValue equals the size of the archive minus 1. For inventory retrieval or + // select jobs, this field is null. + RetrievalByteRange *string // For an archive retrieval job, this value is the checksum of the archive. // Otherwise, this value is null. The SHA256 tree hash value for the requested @@ -193,12 +178,27 @@ type DescribeJobOutput struct { // * Select jobs SHA256TreeHash *string - // Contains the location where the data from the select job is stored. - OutputLocation *types.OutputLocation - // An Amazon SNS topic that receives notification. SNSTopic *string + // Contains the parameters used for a select. + SelectParameters *types.SelectParameters + + // The status code can be InProgress, Succeeded, or Failed, and indicates the + // status of the job. + StatusCode types.StatusCode + + // A friendly message that describes the job status. + StatusMessage *string + + // The tier to use for a select or an archive retrieval. Valid values are + // Expedited, Standard, or Bulk. Standard is the default. + Tier *string + + // The Amazon Resource Name (ARN) of the vault from which an archive retrieval was + // requested. + VaultARN *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/glacier/api_op_DescribeVault.go b/service/glacier/api_op_DescribeVault.go index 5650be47aaf..bc726442f60 100644 --- a/service/glacier/api_op_DescribeVault.go +++ b/service/glacier/api_op_DescribeVault.go @@ -81,11 +81,6 @@ func (c *Client) DescribeVault(ctx context.Context, params *DescribeVaultInput, // Provides options for retrieving metadata for a specific vault in Amazon Glacier. type DescribeVaultInput struct { - // The name of the vault. - // - // This member is required. - VaultName *string - // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), in // which case Amazon S3 Glacier uses the AWS account ID associated with the @@ -94,36 +89,41 @@ type DescribeVaultInput struct { // // This member is required. AccountId *string + + // The name of the vault. + // + // This member is required. + VaultName *string } // Contains the Amazon S3 Glacier response to your request. type DescribeVaultOutput struct { - // Total size, in bytes, of the archives in the vault as of the last inventory - // date. This field will return null if an inventory has not yet run on the vault, - // for example if you just created the vault. - SizeInBytes *int64 + // The Universal Coordinated Time (UTC) date when the vault was created. This value + // should be a string in the ISO 8601 date format, for example + // 2012-03-20T17:03:43.221Z. + CreationDate *string // The Universal Coordinated Time (UTC) date when Amazon S3 Glacier completed the // last vault inventory. This value should be a string in the ISO 8601 date format, // for example 2012-03-20T17:03:43.221Z. LastInventoryDate *string - // The name of the vault. - VaultName *string - - // The Amazon Resource Name (ARN) of the vault. - VaultARN *string - // The number of archives in the vault as of the last inventory date. This field // will return null if an inventory has not yet run on the vault, for example if // you just created the vault. NumberOfArchives *int64 - // The Universal Coordinated Time (UTC) date when the vault was created. This value - // should be a string in the ISO 8601 date format, for example - // 2012-03-20T17:03:43.221Z. - CreationDate *string + // Total size, in bytes, of the archives in the vault as of the last inventory + // date. This field will return null if an inventory has not yet run on the vault, + // for example if you just created the vault. + SizeInBytes *int64 + + // The Amazon Resource Name (ARN) of the vault. + VaultARN *string + + // The name of the vault. + VaultName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/glacier/api_op_GetJobOutput.go b/service/glacier/api_op_GetJobOutput.go index 97c26c8d8eb..67e55cbff6e 100644 --- a/service/glacier/api_op_GetJobOutput.go +++ b/service/glacier/api_op_GetJobOutput.go @@ -98,11 +98,6 @@ func (c *Client) GetJobOutput(ctx context.Context, params *GetJobOutputInput, op // Provides options for downloading output of an Amazon S3 Glacier job. type GetJobOutputInput struct { - // The name of the vault. - // - // This member is required. - VaultName *string - // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), in // which case Amazon S3 Glacier uses the AWS account ID associated with the @@ -117,6 +112,11 @@ type GetJobOutputInput struct { // This member is required. JobId *string + // The name of the vault. + // + // This member is required. + VaultName *string + // The range of bytes to retrieve from the output. For example, if you want to // download the first 1,048,576 bytes, specify the range as bytes=0-1048575. By // default, this operation downloads the entire output.

    If the job output is @@ -149,18 +149,6 @@ type GetJobOutputOutput struct { // (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). AcceptRanges *string - // The Content-Type depends on whether the job output is an archive or a vault - // inventory. For archive data, the Content-Type is application/octet-stream. For - // vault inventory, if you requested CSV format when you initiated the job, the - // Content-Type is text/csv. Otherwise, by default, vault inventory is returned as - // JSON, and the Content-Type is application/json. - ContentType *string - - // The range of bytes returned by Amazon S3 Glacier. If only partial output is - // downloaded, the response provides the range of bytes Amazon S3 Glacier returned. - // For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB. - ContentRange *string - // The description of an archive. ArchiveDescription *string @@ -186,6 +174,18 @@ type GetJobOutputOutput struct { // x-amz-sha256-tree-hash is returned as a response header. Checksum *string + // The range of bytes returned by Amazon S3 Glacier. If only partial output is + // downloaded, the response provides the range of bytes Amazon S3 Glacier returned. + // For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB. + ContentRange *string + + // The Content-Type depends on whether the job output is an archive or a vault + // inventory. For archive data, the Content-Type is application/octet-stream. For + // vault inventory, if you requested CSV format when you initiated the job, the + // Content-Type is text/csv. Otherwise, by default, vault inventory is returned as + // JSON, and the Content-Type is application/json. + ContentType *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/glacier/api_op_GetVaultAccessPolicy.go b/service/glacier/api_op_GetVaultAccessPolicy.go index 3aa578ca8ba..79fd393d394 100644 --- a/service/glacier/api_op_GetVaultAccessPolicy.go +++ b/service/glacier/api_op_GetVaultAccessPolicy.go @@ -69,11 +69,6 @@ func (c *Client) GetVaultAccessPolicy(ctx context.Context, params *GetVaultAcces // Input for GetVaultAccessPolicy. type GetVaultAccessPolicyInput struct { - // The name of the vault. - // - // This member is required. - VaultName *string - // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), in // which case Amazon S3 Glacier uses the AWS account ID associated with the @@ -82,6 +77,11 @@ type GetVaultAccessPolicyInput struct { // // This member is required. AccountId *string + + // The name of the vault. + // + // This member is required. + VaultName *string } // Output for GetVaultAccessPolicy. diff --git a/service/glacier/api_op_GetVaultLock.go b/service/glacier/api_op_GetVaultLock.go index f49b0dc0f9b..7550897696b 100644 --- a/service/glacier/api_op_GetVaultLock.go +++ b/service/glacier/api_op_GetVaultLock.go @@ -104,18 +104,18 @@ type GetVaultLockInput struct { // Contains the Amazon S3 Glacier response to your request. type GetVaultLockOutput struct { - // The state of the vault lock. InProgress or Locked. - State *string - - // The vault lock policy as a JSON string, which uses "\" as an escape character. - Policy *string + // The UTC date and time at which the vault lock was put into the InProgress state. + CreationDate *string // The UTC date and time at which the lock ID expires. This value can be null if // the vault lock is in a Locked state. ExpirationDate *string - // The UTC date and time at which the vault lock was put into the InProgress state. - CreationDate *string + // The vault lock policy as a JSON string, which uses "\" as an escape character. + Policy *string + + // The state of the vault lock. InProgress or Locked. + State *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/glacier/api_op_GetVaultNotifications.go b/service/glacier/api_op_GetVaultNotifications.go index 490ef2e37de..a520ef5c7db 100644 --- a/service/glacier/api_op_GetVaultNotifications.go +++ b/service/glacier/api_op_GetVaultNotifications.go @@ -81,11 +81,6 @@ func (c *Client) GetVaultNotifications(ctx context.Context, params *GetVaultNoti // Glacier vault. type GetVaultNotificationsInput struct { - // The name of the vault. - // - // This member is required. - VaultName *string - // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), in // which case Amazon S3 Glacier uses the AWS account ID associated with the @@ -94,6 +89,11 @@ type GetVaultNotificationsInput struct { // // This member is required. AccountId *string + + // The name of the vault. + // + // This member is required. + VaultName *string } // Contains the Amazon S3 Glacier response to your request. diff --git a/service/glacier/api_op_InitiateJob.go b/service/glacier/api_op_InitiateJob.go index 8b83fdd2f29..05068231e9d 100644 --- a/service/glacier/api_op_InitiateJob.go +++ b/service/glacier/api_op_InitiateJob.go @@ -65,11 +65,6 @@ func (c *Client) InitiateJob(ctx context.Context, params *InitiateJobInput, optF // Provides options for initiating an Amazon S3 Glacier job. type InitiateJobInput struct { - // The name of the vault. - // - // This member is required. - VaultName *string - // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), in // which case Amazon S3 Glacier uses the AWS account ID associated with the @@ -79,6 +74,11 @@ type InitiateJobInput struct { // This member is required. AccountId *string + // The name of the vault. + // + // This member is required. + VaultName *string + // Provides options for specifying job information. JobParameters *types.JobParameters } @@ -86,15 +86,15 @@ type InitiateJobInput struct { // Contains the Amazon S3 Glacier response to your request. type InitiateJobOutput struct { - // The relative URI path of the job. - Location *string - // The ID of the job. JobId *string // The path to the location of where the select results are stored. JobOutputPath *string + // The relative URI path of the job. + Location *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/glacier/api_op_InitiateMultipartUpload.go b/service/glacier/api_op_InitiateMultipartUpload.go index 8e8e60f14eb..9de26cf4cad 100644 --- a/service/glacier/api_op_InitiateMultipartUpload.go +++ b/service/glacier/api_op_InitiateMultipartUpload.go @@ -90,9 +90,14 @@ func (c *Client) InitiateMultipartUpload(ctx context.Context, params *InitiateMu // vault. type InitiateMultipartUploadInput struct { - // The size of each part except the last, in bytes. The last part can be smaller - // than this part size. - PartSize *string + // The AccountId value is the AWS account ID of the account that owns the vault. + // You can either specify an AWS account ID or optionally a single '-' (hyphen), in + // which case Amazon S3 Glacier uses the AWS account ID associated with the + // credentials used to sign the request. If you use an account ID, do not include + // any hyphens ('-') in the ID. + // + // This member is required. + AccountId *string // The name of the vault. // @@ -105,14 +110,9 @@ type InitiateMultipartUploadInput struct { // part size is 1 MB, and the maximum is 4 GB (4096 MB). ArchiveDescription *string - // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the - // credentials used to sign the request. If you use an account ID, do not include - // any hyphens ('-') in the ID. - // - // This member is required. - AccountId *string + // The size of each part except the last, in bytes. The last part can be smaller + // than this part size. + PartSize *string } // The Amazon S3 Glacier response to your request. diff --git a/service/glacier/api_op_InitiateVaultLock.go b/service/glacier/api_op_InitiateVaultLock.go index 87834d2c2d4..f77d9dd3a6f 100644 --- a/service/glacier/api_op_InitiateVaultLock.go +++ b/service/glacier/api_op_InitiateVaultLock.go @@ -93,14 +93,6 @@ func (c *Client) InitiateVaultLock(ctx context.Context, params *InitiateVaultLoc // The input values for InitiateVaultLock. type InitiateVaultLockInput struct { - // The name of the vault. - // - // This member is required. - VaultName *string - - // The vault lock policy as a JSON string, which uses "\" as an escape character. - Policy *types.VaultLockPolicy - // The AccountId value is the AWS account ID. This value must match the AWS account // ID associated with the credentials used to sign the request. You can either // specify an AWS account ID or optionally a single '-' (hyphen), in which case @@ -110,6 +102,14 @@ type InitiateVaultLockInput struct { // // This member is required. AccountId *string + + // The name of the vault. + // + // This member is required. + VaultName *string + + // The vault lock policy as a JSON string, which uses "\" as an escape character. + Policy *types.VaultLockPolicy } // Contains the Amazon S3 Glacier response to your request. diff --git a/service/glacier/api_op_ListJobs.go b/service/glacier/api_op_ListJobs.go index 47035421c65..743ed8fcec3 100644 --- a/service/glacier/api_op_ListJobs.go +++ b/service/glacier/api_op_ListJobs.go @@ -93,9 +93,6 @@ func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ... // Provides options for retrieving a job list for an Amazon S3 Glacier vault. type ListJobsInput struct { - // The state of the jobs to return. You can specify true or false. - Completed *string - // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), in // which case Amazon S3 Glacier uses the AWS account ID associated with the @@ -105,39 +102,42 @@ type ListJobsInput struct { // This member is required. AccountId *string - // An opaque string used for pagination. This value specifies the job at which the - // listing of jobs should begin. Get the marker value from a previous List Jobs - // response. You only need to include the marker if you are continuing the - // pagination of results started in a previous List Jobs request. - Marker *string - // The name of the vault. // // This member is required. VaultName *string - // The type of job status to return. You can specify the following values: - // InProgress, Succeeded, or Failed. - Statuscode *string + // The state of the jobs to return. You can specify true or false. + Completed *string // The maximum number of jobs to be returned. The default limit is 50. The number // of jobs returned might be fewer than the specified limit, but the number of // returned jobs never exceeds the limit. Limit *string + + // An opaque string used for pagination. This value specifies the job at which the + // listing of jobs should begin. Get the marker value from a previous List Jobs + // response. You only need to include the marker if you are continuing the + // pagination of results started in a previous List Jobs request. + Marker *string + + // The type of job status to return. You can specify the following values: + // InProgress, Succeeded, or Failed. + Statuscode *string } // Contains the Amazon S3 Glacier response to your request. type ListJobsOutput struct { + // A list of job objects. Each job object contains metadata describing the job. + JobList []*types.GlacierJobDescription + // An opaque string used for pagination that specifies the job at which the listing // of jobs should begin. You get the marker value from a previous List Jobs // response. You only need to include the marker if you are continuing the // pagination of the results started in a previous List Jobs request. Marker *string - // A list of job objects. Each job object contains metadata describing the job. - JobList []*types.GlacierJobDescription - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/glacier/api_op_ListParts.go b/service/glacier/api_op_ListParts.go index fac7b03dcb2..7b7ba2c6c06 100644 --- a/service/glacier/api_op_ListParts.go +++ b/service/glacier/api_op_ListParts.go @@ -85,12 +85,6 @@ func (c *Client) ListParts(ctx context.Context, params *ListPartsInput, optFns . // uploaded in a specific multipart upload. type ListPartsInput struct { - // An opaque string used for pagination. This value specifies the part at which the - // listing of parts should begin. Get the marker value from the response of a - // previous List Parts response. You need only include the marker if you are - // continuing the pagination of results started in a previous List Parts request. - Marker *string - // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), in // which case Amazon S3 Glacier uses the AWS account ID associated with the @@ -114,29 +108,31 @@ type ListPartsInput struct { // of parts returned might be fewer than the specified limit, but the number of // returned parts never exceeds the limit. Limit *string + + // An opaque string used for pagination. This value specifies the part at which the + // listing of parts should begin. Get the marker value from the response of a + // previous List Parts response. You need only include the marker if you are + // continuing the pagination of results started in a previous List Parts request. + Marker *string } // Contains the Amazon S3 Glacier response to your request. type ListPartsOutput struct { - // The Amazon Resource Name (ARN) of the vault to which the multipart upload was - // initiated. - VaultARN *string - // The description of the archive that was specified in the Initiate Multipart // Upload request. ArchiveDescription *string - // The ID of the upload to which the parts are associated. - MultipartUploadId *string + // The UTC time at which the multipart upload was initiated. + CreationDate *string // An opaque string that represents where to continue pagination of the results. // You use the marker in a new List Parts request to obtain more jobs in the list. // If there are no more parts, this value is null. Marker *string - // The UTC time at which the multipart upload was initiated. - CreationDate *string + // The ID of the upload to which the parts are associated. + MultipartUploadId *string // The part size in bytes. This is the same value that you specified in the // Initiate Multipart Upload request. @@ -146,6 +142,10 @@ type ListPartsOutput struct { // contains a RangeBytes and sha256-tree-hash name/value pair. Parts []*types.PartListElement + // The Amazon Resource Name (ARN) of the vault to which the multipart upload was + // initiated. + VaultARN *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/glacier/api_op_ListVaults.go b/service/glacier/api_op_ListVaults.go index 93ffb775fd6..640781e3f7b 100644 --- a/service/glacier/api_op_ListVaults.go +++ b/service/glacier/api_op_ListVaults.go @@ -106,13 +106,13 @@ type ListVaultsInput struct { // Contains the Amazon S3 Glacier response to your request. type ListVaultsOutput struct { - // List of vaults. - VaultList []*types.DescribeVaultOutput - // The vault ARN at which to continue pagination of the results. You use the marker // in another List Vaults request to obtain more vaults in the list. Marker *string + // List of vaults. + VaultList []*types.DescribeVaultOutput + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/glacier/api_op_RemoveTagsFromVault.go b/service/glacier/api_op_RemoveTagsFromVault.go index 409428a5c1f..87b24682c42 100644 --- a/service/glacier/api_op_RemoveTagsFromVault.go +++ b/service/glacier/api_op_RemoveTagsFromVault.go @@ -65,14 +65,6 @@ func (c *Client) RemoveTagsFromVault(ctx context.Context, params *RemoveTagsFrom // The input value for RemoveTagsFromVaultInput. type RemoveTagsFromVaultInput struct { - // The name of the vault. - // - // This member is required. - VaultName *string - - // A list of tag keys. Each corresponding tag is removed from the vault. - TagKeys []*string - // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), in // which case Amazon S3 Glacier uses the AWS account ID associated with the @@ -81,6 +73,14 @@ type RemoveTagsFromVaultInput struct { // // This member is required. AccountId *string + + // The name of the vault. + // + // This member is required. + VaultName *string + + // A list of tag keys. Each corresponding tag is removed from the vault. + TagKeys []*string } type RemoveTagsFromVaultOutput struct { diff --git a/service/glacier/api_op_SetDataRetrievalPolicy.go b/service/glacier/api_op_SetDataRetrievalPolicy.go index 45f66003047..d73e8115a18 100644 --- a/service/glacier/api_op_SetDataRetrievalPolicy.go +++ b/service/glacier/api_op_SetDataRetrievalPolicy.go @@ -68,9 +68,6 @@ func (c *Client) SetDataRetrievalPolicy(ctx context.Context, params *SetDataRetr // SetDataRetrievalPolicy input. type SetDataRetrievalPolicyInput struct { - // The data retrieval policy in JSON format. - Policy *types.DataRetrievalPolicy - // The AccountId value is the AWS account ID. This value must match the AWS account // ID associated with the credentials used to sign the request. You can either // specify an AWS account ID or optionally a single '-' (hyphen), in which case @@ -80,6 +77,9 @@ type SetDataRetrievalPolicyInput struct { // // This member is required. AccountId *string + + // The data retrieval policy in JSON format. + Policy *types.DataRetrievalPolicy } type SetDataRetrievalPolicyOutput struct { diff --git a/service/glacier/api_op_SetVaultAccessPolicy.go b/service/glacier/api_op_SetVaultAccessPolicy.go index a6759636373..80a8807b841 100644 --- a/service/glacier/api_op_SetVaultAccessPolicy.go +++ b/service/glacier/api_op_SetVaultAccessPolicy.go @@ -68,9 +68,6 @@ func (c *Client) SetVaultAccessPolicy(ctx context.Context, params *SetVaultAcces // SetVaultAccessPolicy input. type SetVaultAccessPolicyInput struct { - // The vault access policy as a JSON string. - Policy *types.VaultAccessPolicy - // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), in // which case Amazon S3 Glacier uses the AWS account ID associated with the @@ -84,6 +81,9 @@ type SetVaultAccessPolicyInput struct { // // This member is required. VaultName *string + + // The vault access policy as a JSON string. + Policy *types.VaultAccessPolicy } type SetVaultAccessPolicyOutput struct { diff --git a/service/glacier/api_op_SetVaultNotifications.go b/service/glacier/api_op_SetVaultNotifications.go index 4d061539849..83c878b8993 100644 --- a/service/glacier/api_op_SetVaultNotifications.go +++ b/service/glacier/api_op_SetVaultNotifications.go @@ -91,11 +91,6 @@ func (c *Client) SetVaultNotifications(ctx context.Context, params *SetVaultNoti // events happen to a vault. type SetVaultNotificationsInput struct { - // The name of the vault. - // - // This member is required. - VaultName *string - // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), in // which case Amazon S3 Glacier uses the AWS account ID associated with the @@ -105,6 +100,11 @@ type SetVaultNotificationsInput struct { // This member is required. AccountId *string + // The name of the vault. + // + // This member is required. + VaultName *string + // Provides options for specifying notification configuration. VaultNotificationConfig *types.VaultNotificationConfig } diff --git a/service/glacier/api_op_UploadArchive.go b/service/glacier/api_op_UploadArchive.go index 57e95b27fbd..08353097bb1 100644 --- a/service/glacier/api_op_UploadArchive.go +++ b/service/glacier/api_op_UploadArchive.go @@ -93,17 +93,6 @@ func (c *Client) UploadArchive(ctx context.Context, params *UploadArchiveInput, // Provides options to add an archive to a vault. type UploadArchiveInput struct { - // The data to upload. - Body io.Reader - - // The name of the vault. - // - // This member is required. - VaultName *string - - // The SHA256 tree hash of the data being uploaded. - Checksum *string - // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), in // which case Amazon S3 Glacier uses the AWS account ID associated with the @@ -113,8 +102,19 @@ type UploadArchiveInput struct { // This member is required. AccountId *string + // The name of the vault. + // + // This member is required. + VaultName *string + // The optional description of the archive you are uploading. ArchiveDescription *string + + // The data to upload. + Body io.Reader + + // The SHA256 tree hash of the data being uploaded. + Checksum *string } // Contains the Amazon S3 Glacier response to your request. For information about @@ -124,12 +124,12 @@ type UploadArchiveInput struct { // (https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html). type UploadArchiveOutput struct { - // The checksum of the archive computed by Amazon S3 Glacier. - Checksum *string - // The ID of the archive. This value is also included as part of the location. ArchiveId *string + // The checksum of the archive computed by Amazon S3 Glacier. + Checksum *string + // The relative URI path of the newly added archive resource. Location *string diff --git a/service/glacier/api_op_UploadMultipartPart.go b/service/glacier/api_op_UploadMultipartPart.go index c06feaada6b..695e73ade5d 100644 --- a/service/glacier/api_op_UploadMultipartPart.go +++ b/service/glacier/api_op_UploadMultipartPart.go @@ -97,36 +97,36 @@ func (c *Client) UploadMultipartPart(ctx context.Context, params *UploadMultipar // Provides options to upload a part of an archive in a multipart upload operation. type UploadMultipartPartInput struct { - // The SHA256 tree hash of the data being uploaded. - Checksum *string - - // The name of the vault. + // The AccountId value is the AWS account ID of the account that owns the vault. + // You can either specify an AWS account ID or optionally a single '-' (hyphen), in + // which case Amazon S3 Glacier uses the AWS account ID associated with the + // credentials used to sign the request. If you use an account ID, do not include + // any hyphens ('-') in the ID. // // This member is required. - VaultName *string + AccountId *string // The upload ID of the multipart upload. // // This member is required. UploadId *string + // The name of the vault. + // + // This member is required. + VaultName *string + // The data to upload. Body io.Reader + // The SHA256 tree hash of the data being uploaded. + Checksum *string + // Identifies the range of bytes in the assembled archive that will be uploaded in // this part. Amazon S3 Glacier uses this information to assemble the archive in // the proper sequence. The format of this header follows RFC 2616. An example // header is Content-Range:bytes 0-4194303/*. Range *string - - // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the - // credentials used to sign the request. If you use an account ID, do not include - // any hyphens ('-') in the ID. - // - // This member is required. - AccountId *string } // Contains the Amazon S3 Glacier response to your request. diff --git a/service/glacier/go.mod b/service/glacier/go.mod index f9952196e68..c6e18902a3b 100644 --- a/service/glacier/go.mod +++ b/service/glacier/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/glacier go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/glacier/types/types.go b/service/glacier/types/types.go index 6f0df2c19cd..e6998042e49 100644 --- a/service/glacier/types/types.go +++ b/service/glacier/types/types.go @@ -5,24 +5,24 @@ package types // Contains information about the comma-separated value (CSV) file to select from. type CSVInput struct { - // Describes the first line of input. Valid values are None, Ignore, and Use. - FileHeaderInfo FileHeaderInfo - - // A value used to separate individual fields from each other within a record. - FieldDelimiter *string - // A single character used to indicate that a row should be ignored when the // character is present at the start of that row. Comments *string - // A single character used for escaping the quotation-mark character inside an - // already escaped value. - QuoteEscapeCharacter *string + // A value used to separate individual fields from each other within a record. + FieldDelimiter *string + + // Describes the first line of input. Valid values are None, Ignore, and Use. + FileHeaderInfo FileHeaderInfo // A value used as an escape character where the field delimiter is part of the // value. QuoteCharacter *string + // A single character used for escaping the quotation-mark character inside an + // already escaped value. + QuoteEscapeCharacter *string + // A value used to separate individual records from each other. RecordDelimiter *string } @@ -31,8 +31,8 @@ type CSVInput struct { // results are stored in. type CSVOutput struct { - // A value used to separate individual records from each other. - RecordDelimiter *string + // A value used to separate individual fields from each other within a record. + FieldDelimiter *string // A value used as an escape character where the field delimiter is part of the // value. @@ -42,12 +42,12 @@ type CSVOutput struct { // already escaped value. QuoteEscapeCharacter *string - // A value used to separate individual fields from each other within a record. - FieldDelimiter *string - // A value that indicates whether all output fields should be contained within // quotation marks. QuoteFields QuoteFields + + // A value used to separate individual records from each other. + RecordDelimiter *string } // Data retrieval policy. @@ -75,45 +75,45 @@ type DataRetrievalRule struct { // Contains the Amazon S3 Glacier response to your request. type DescribeVaultOutput struct { - // Total size, in bytes, of the archives in the vault as of the last inventory - // date. This field will return null if an inventory has not yet run on the vault, - // for example if you just created the vault. - SizeInBytes *int64 + // The Universal Coordinated Time (UTC) date when the vault was created. This value + // should be a string in the ISO 8601 date format, for example + // 2012-03-20T17:03:43.221Z. + CreationDate *string // The Universal Coordinated Time (UTC) date when Amazon S3 Glacier completed the // last vault inventory. This value should be a string in the ISO 8601 date format, // for example 2012-03-20T17:03:43.221Z. LastInventoryDate *string - // The name of the vault. - VaultName *string - - // The Amazon Resource Name (ARN) of the vault. - VaultARN *string - // The number of archives in the vault as of the last inventory date. This field // will return null if an inventory has not yet run on the vault, for example if // you just created the vault. NumberOfArchives *int64 - // The Universal Coordinated Time (UTC) date when the vault was created. This value - // should be a string in the ISO 8601 date format, for example - // 2012-03-20T17:03:43.221Z. - CreationDate *string + // Total size, in bytes, of the archives in the vault as of the last inventory + // date. This field will return null if an inventory has not yet run on the vault, + // for example if you just created the vault. + SizeInBytes *int64 + + // The Amazon Resource Name (ARN) of the vault. + VaultARN *string + + // The name of the vault. + VaultName *string } // Contains information about the encryption used to store the job results in // Amazon S3. type Encryption struct { - // Optional. If the encryption type is aws:kms, you can use this value to specify - // the encryption context for the job results. - KMSContext *string - // The server-side encryption algorithm used when storing job results in Amazon S3, // for example AES256 or aws:kms. EncryptionType EncryptionType + // Optional. If the encryption type is aws:kms, you can use this value to specify + // the encryption context for the job results. + KMSContext *string + // The AWS KMS key ID to use for object encryption. All GET and PUT requests for an // object protected by AWS KMS fail if not made by using Secure Sockets Layer (SSL) // or Signature Version 4. @@ -123,45 +123,26 @@ type Encryption struct { // Contains the description of an Amazon S3 Glacier job. type GlacierJobDescription struct { - // An opaque string that identifies an Amazon S3 Glacier job. - JobId *string - - // The status code can be InProgress, Succeeded, or Failed, and indicates the - // status of the job. - StatusCode StatusCode - - // Contains the job output location. - JobOutputPath *string - - // The job description provided when initiating the job. - JobDescription *string - - // The SHA256 tree hash of the entire archive for an archive retrieval. For - // inventory retrieval or select jobs, this field is null. - ArchiveSHA256TreeHash *string - - // The retrieved byte range for archive retrieval jobs in the form - // StartByteValue-EndByteValue. If no range was specified in the archive retrieval, - // then the whole archive is retrieved. In this case, StartByteValue equals 0 and - // EndByteValue equals the size of the archive minus 1. For inventory retrieval or - // select jobs, this field is null. - RetrievalByteRange *string + // The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or + // Select. + Action ActionCode // The archive ID requested for a select job or archive retrieval. Otherwise, this // field is null. ArchiveId *string - // The job status. When a job is completed, you get the job's output using Get Job - // Output (GET output). - Completed *bool + // The SHA256 tree hash of the entire archive for an archive retrieval. For + // inventory retrieval or select jobs, this field is null. + ArchiveSHA256TreeHash *string // For an archive retrieval job, this value is the size in bytes of the archive // being requested for download. For an inventory retrieval or select job, this // value is null. ArchiveSizeInBytes *int64 - // Contains the parameters used for a select. - SelectParameters *SelectParameters + // The job status. When a job is completed, you get the job's output using Get Job + // Output (GET output). + Completed *bool // The UTC time that the job request completed. While the job is in progress, the // value is null. @@ -171,28 +152,32 @@ type GlacierJobDescription struct { // ISO 8601 date format, for example "2012-03-20T17:03:43.221Z". CreationDate *string - // A friendly message that describes the job status. - StatusMessage *string - - // The Amazon Resource Name (ARN) of the vault from which an archive retrieval was - // requested. - VaultARN *string - - // The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or - // Select. - Action ActionCode - - // The tier to use for a select or an archive retrieval. Valid values are - // Expedited, Standard, or Bulk. Standard is the default. - Tier *string + // Parameters used for range inventory retrieval. + InventoryRetrievalParameters *InventoryRetrievalJobDescription // For an inventory retrieval job, this value is the size in bytes of the inventory // requested for download. For an archive retrieval or select job, this value is // null. InventorySizeInBytes *int64 - // Parameters used for range inventory retrieval. - InventoryRetrievalParameters *InventoryRetrievalJobDescription + // The job description provided when initiating the job. + JobDescription *string + + // An opaque string that identifies an Amazon S3 Glacier job. + JobId *string + + // Contains the job output location. + JobOutputPath *string + + // Contains the location where the data from the select job is stored. + OutputLocation *OutputLocation + + // The retrieved byte range for archive retrieval jobs in the form + // StartByteValue-EndByteValue. If no range was specified in the archive retrieval, + // then the whole archive is retrieved. In this case, StartByteValue equals 0 and + // EndByteValue equals the size of the archive minus 1. For inventory retrieval or + // select jobs, this field is null. + RetrievalByteRange *string // For an archive retrieval job, this value is the checksum of the archive. // Otherwise, this value is null. The SHA256 tree hash value for the requested @@ -213,42 +198,57 @@ type GlacierJobDescription struct { // * Select jobs SHA256TreeHash *string - // Contains the location where the data from the select job is stored. - OutputLocation *OutputLocation - // An Amazon SNS topic that receives notification. SNSTopic *string + + // Contains the parameters used for a select. + SelectParameters *SelectParameters + + // The status code can be InProgress, Succeeded, or Failed, and indicates the + // status of the job. + StatusCode StatusCode + + // A friendly message that describes the job status. + StatusMessage *string + + // The tier to use for a select or an archive retrieval. Valid values are + // Expedited, Standard, or Bulk. Standard is the default. + Tier *string + + // The Amazon Resource Name (ARN) of the vault from which an archive retrieval was + // requested. + VaultARN *string } // Contains information about a grant. type Grant struct { - // Specifies the permission given to the grantee. - Permission Permission - // The grantee. Grantee *Grantee + + // Specifies the permission given to the grantee. + Permission Permission } // Contains information about the grantee. type Grantee struct { - // The canonical user ID of the grantee. - ID *string - - // Screen name of the grantee. - DisplayName *string - // Type of grantee // // This member is required. Type Type - // URI of the grantee group. - URI *string + // Screen name of the grantee. + DisplayName *string // Email address of the grantee. EmailAddress *string + + // The canonical user ID of the grantee. + ID *string + + // URI of the grantee group. + URI *string } // Describes how the archive is serialized. @@ -261,6 +261,11 @@ type InputSerialization struct { // Describes the options for a range inventory retrieval job. type InventoryRetrievalJobDescription struct { + // The end of the date range in UTC for vault inventory retrieval that includes + // archives created before this date. This value should be a string in the ISO 8601 + // date format, for example 2013-03-20T17:03:43Z. + EndDate *string + // The output format for the vault inventory list, which is set by the InitiateJob // request when initiating a job to retrieve a vault inventory. Valid values are // CSV and JSON. @@ -283,11 +288,6 @@ type InventoryRetrievalJobDescription struct { // value should be a string in the ISO 8601 date format, for example // 2013-03-20T17:03:43Z. StartDate *string - - // The end of the date range in UTC for vault inventory retrieval that includes - // archives created before this date. This value should be a string in the ISO 8601 - // date format, for example 2013-03-20T17:03:43Z. - EndDate *string } // Provides options for specifying a range inventory retrieval job. @@ -298,11 +298,6 @@ type InventoryRetrievalJobInput struct { // date format, for example 2013-03-20T17:03:43Z. EndDate *string - // The start of the date range in UTC for vault inventory retrieval that includes - // archives created on or after this date. This value should be a string in the ISO - // 8601 date format, for example 2013-03-20T17:03:43Z. - StartDate *string - // Specifies the maximum number of inventory items returned per vault inventory // retrieval request. Valid values are greater than or equal to 1. Limit *string @@ -312,11 +307,38 @@ type InventoryRetrievalJobInput struct { // obtain additional inventory items. If there are no more inventory items, this // value is null. Marker *string + + // The start of the date range in UTC for vault inventory retrieval that includes + // archives created on or after this date. This value should be a string in the ISO + // 8601 date format, for example 2013-03-20T17:03:43Z. + StartDate *string } // Provides options for defining a job. type JobParameters struct { + // The ID of the archive that you want to retrieve. This field is required only if + // Type is set to select or archive-retrievalcode>. An error occurs if you specify + // this request parameter for an inventory retrieval job request. + ArchiveId *string + + // The optional description for the job. The description must be less than or equal + // to 1,024 bytes. The allowable characters are 7-bit ASCII without control + // codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal. + Description *string + + // When initiating a job to retrieve a vault inventory, you can optionally add this + // parameter to your request to specify the output format. If you are initiating an + // inventory job and do not specify a Format field, JSON is the default format. + // Valid values are "CSV" and "JSON". + Format *string + + // Input parameters used for range inventory retrieval. + InventoryRetrievalParameters *InventoryRetrievalJobInput + + // Contains information about the location where the select job results are stored. + OutputLocation *OutputLocation + // The byte range to retrieve for an archive retrieval. in the form // "StartByteValue-EndByteValue" If not specified, the whole archive is retrieved. // If specified, the byte range must be megabyte (1024*1024) aligned which means @@ -327,44 +349,22 @@ type JobParameters struct { // an inventory retrieval job request. RetrievalByteRange *string - // Input parameters used for range inventory retrieval. - InventoryRetrievalParameters *InventoryRetrievalJobInput - - // When initiating a job to retrieve a vault inventory, you can optionally add this - // parameter to your request to specify the output format. If you are initiating an - // inventory job and do not specify a Format field, JSON is the default format. - // Valid values are "CSV" and "JSON". - Format *string + // The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when + // the job is completed and the output is ready for you to download. The specified + // topic publishes the notification to its subscribers. The SNS topic must exist. + SNSTopic *string - // The optional description for the job. The description must be less than or equal - // to 1,024 bytes. The allowable characters are 7-bit ASCII without control - // codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal. - Description *string + // Contains the parameters that define a job. + SelectParameters *SelectParameters // The tier to use for a select or an archive retrieval job. Valid values are // Expedited, Standard, or Bulk. Standard is the default. Tier *string - // Contains information about the location where the select job results are stored. - OutputLocation *OutputLocation - // The job type. You can initiate a job to perform a select query on an archive, // retrieve an archive, or get an inventory of a vault. Valid values are "select", // "archive-retrieval" and "inventory-retrieval". Type *string - - // Contains the parameters that define a job. - SelectParameters *SelectParameters - - // The ID of the archive that you want to retrieve. This field is required only if - // Type is set to select or archive-retrievalcode>. An error occurs if you specify - // this request parameter for an inventory retrieval job request. - ArchiveId *string - - // The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when - // the job is completed and the output is ready for you to download. The specified - // topic publishes the notification to its subscribers. The SNS topic must exist. - SNSTopic *string } // Contains information about the location where the select job results are stored. @@ -395,6 +395,9 @@ type PartListElement struct { // The definition for a provisioned capacity unit. type ProvisionedCapacityDescription struct { + // The ID that identifies the provisioned capacity unit. + CapacityId *string + // The date that the provisioned capacity unit expires, in Universal Coordinated // Time (UTC). ExpirationDate *string @@ -402,53 +405,50 @@ type ProvisionedCapacityDescription struct { // The date that the provisioned capacity unit was purchased, in Universal // Coordinated Time (UTC). StartDate *string - - // The ID that identifies the provisioned capacity unit. - CapacityId *string } // Contains information about the location in Amazon S3 where the select job // results are stored. type S3Location struct { - // The canned access control list (ACL) to apply to the job results. - CannedACL CannedACL - - // The storage class used to store the job results. - StorageClass StorageClass - // A list of grants that control access to the staged results. AccessControlList []*Grant - // A map of metadata to store with the job results in Amazon S3. - UserMetadata map[string]*string - - // The prefix that is prepended to the results for this request. - Prefix *string - // The name of the Amazon S3 bucket where the job results are stored. BucketName *string + // The canned access control list (ACL) to apply to the job results. + CannedACL CannedACL + // Contains information about the encryption used to store the job results in // Amazon S3. Encryption *Encryption + // The prefix that is prepended to the results for this request. + Prefix *string + + // The storage class used to store the job results. + StorageClass StorageClass + // The tag-set that is applied to the job results. Tagging map[string]*string + + // A map of metadata to store with the job results in Amazon S3. + UserMetadata map[string]*string } // Contains information about the parameters used for a select. type SelectParameters struct { + // The expression that is used to select the object. + Expression *string + // The type of the provided expression, for example SQL. ExpressionType ExpressionType // Describes the serialization format of the object. InputSerialization *InputSerialization - // The expression that is used to select the object. - Expression *string - // Describes how the results of the select job are serialized. OutputSerialization *OutputSerialization } @@ -456,23 +456,23 @@ type SelectParameters struct { // A list of in-progress multipart uploads for a vault. type UploadListElement struct { + // The description of the archive that was specified in the Initiate Multipart + // Upload request. + ArchiveDescription *string + + // The UTC time at which the multipart upload was initiated. + CreationDate *string + + // The ID of a multipart upload. + MultipartUploadId *string + // The part size, in bytes, specified in the Initiate Multipart Upload request. // This is the size of all the parts in the upload except the last part, which may // be smaller than this size. PartSizeInBytes *int64 - // The ID of a multipart upload. - MultipartUploadId *string - // The Amazon Resource Name (ARN) of the vault that contains the archive. VaultARN *string - - // The description of the archive that was specified in the Initiate Multipart - // Upload request. - ArchiveDescription *string - - // The UTC time at which the multipart upload was initiated. - CreationDate *string } // Contains the vault access policy. diff --git a/service/globalaccelerator/api_op_CreateAccelerator.go b/service/globalaccelerator/api_op_CreateAccelerator.go index 48be07c4d31..339f265b706 100644 --- a/service/globalaccelerator/api_op_CreateAccelerator.go +++ b/service/globalaccelerator/api_op_CreateAccelerator.go @@ -73,15 +73,6 @@ type CreateAcceleratorInput struct { // This member is required. IdempotencyToken *string - // Create tags for an accelerator. For more information, see Tagging in AWS Global - // Accelerator - // (https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html) - // in the AWS Global Accelerator Developer Guide. - Tags []*types.Tag - - // The value for the address type must be IPv4. - IpAddressType types.IpAddressType - // The name of an accelerator. The name can have a maximum of 32 characters, must // contain only alphanumeric characters or hyphens (-), and must not begin or end // with a hyphen. @@ -94,6 +85,9 @@ type CreateAcceleratorInput struct { // deleted. If set to false, the accelerator can be deleted. Enabled *bool + // The value for the address type must be IPv4. + IpAddressType types.IpAddressType + // Optionally, if you've added your own IP address pool to Global Accelerator, you // can choose IP addresses from your own pool to use for the accelerator's static // IP addresses. You can specify one or two addresses, separated by a comma. Do not @@ -104,6 +98,12 @@ type CreateAcceleratorInput struct { // (https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) in // the AWS Global Accelerator Developer Guide. IpAddresses []*string + + // Create tags for an accelerator. For more information, see Tagging in AWS Global + // Accelerator + // (https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html) + // in the AWS Global Accelerator Developer Guide. + Tags []*types.Tag } type CreateAcceleratorOutput struct { diff --git a/service/globalaccelerator/api_op_CreateEndpointGroup.go b/service/globalaccelerator/api_op_CreateEndpointGroup.go index a1e3ace0b72..6229100e6c1 100644 --- a/service/globalaccelerator/api_op_CreateEndpointGroup.go +++ b/service/globalaccelerator/api_op_CreateEndpointGroup.go @@ -61,10 +61,11 @@ func (c *Client) CreateEndpointGroup(ctx context.Context, params *CreateEndpoint type CreateEndpointGroupInput struct { - // The Amazon Resource Name (ARN) of the listener. + // The name of the AWS Region where the endpoint group is located. A listener can + // have only one endpoint group in a specific Region. // // This member is required. - ListenerArn *string + EndpointGroupRegion *string // A unique, case-sensitive identifier that you provide to ensure the // idempotency—that is, the uniqueness—of the request. @@ -72,20 +73,21 @@ type CreateEndpointGroupInput struct { // This member is required. IdempotencyToken *string - // The name of the AWS Region where the endpoint group is located. A listener can - // have only one endpoint group in a specific Region. + // The Amazon Resource Name (ARN) of the listener. // // This member is required. - EndpointGroupRegion *string + ListenerArn *string + + // The list of endpoint objects. + EndpointConfigurations []*types.EndpointConfiguration // The time—10 seconds or 30 seconds—between each health check for an endpoint. The // default value is 30. HealthCheckIntervalSeconds *int32 - // The number of consecutive health checks required to set the state of a healthy - // endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default - // value is 3. - ThresholdCount *int32 + // If the protocol is HTTP/S, then this specifies the path that is the destination + // for health check targets. The default value is slash (/). + HealthCheckPath *string // The port that AWS Global Accelerator uses to check the health of endpoints that // are part of this endpoint group. The default port is the listener port that this @@ -97,12 +99,10 @@ type CreateEndpointGroupInput struct { // that are part of this endpoint group. The default value is TCP. HealthCheckProtocol types.HealthCheckProtocol - // The list of endpoint objects. - EndpointConfigurations []*types.EndpointConfiguration - - // If the protocol is HTTP/S, then this specifies the path that is the destination - // for health check targets. The default value is slash (/). - HealthCheckPath *string + // The number of consecutive health checks required to set the state of a healthy + // endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default + // value is 3. + ThresholdCount *int32 // The percentage of traffic to send to an AWS Region. Additional traffic is // distributed to other endpoint groups for this listener. Use this action to diff --git a/service/globalaccelerator/api_op_CreateListener.go b/service/globalaccelerator/api_op_CreateListener.go index 147a92d6487..07138fd805b 100644 --- a/service/globalaccelerator/api_op_CreateListener.go +++ b/service/globalaccelerator/api_op_CreateListener.go @@ -62,6 +62,28 @@ func (c *Client) CreateListener(ctx context.Context, params *CreateListenerInput type CreateListenerInput struct { + // The Amazon Resource Name (ARN) of your accelerator. + // + // This member is required. + AcceleratorArn *string + + // A unique, case-sensitive identifier that you provide to ensure the + // idempotency—that is, the uniqueness—of the request. + // + // This member is required. + IdempotencyToken *string + + // The list of port ranges to support for connections from clients to your + // accelerator. + // + // This member is required. + PortRanges []*types.PortRange + + // The protocol for connections from clients to your accelerator. + // + // This member is required. + Protocol types.Protocol + // Client affinity lets you direct all requests from a user to the same endpoint, // if you have stateful applications, regardless of the port and protocol of the // client request. Clienty affinity gives you control over whether to always route @@ -78,28 +100,6 @@ type CreateListenerInput struct { // (2-tuple) properties— source (client) IP address and destination IP address—to // select the hash value. The default value is NONE. ClientAffinity types.ClientAffinity - - // The list of port ranges to support for connections from clients to your - // accelerator. - // - // This member is required. - PortRanges []*types.PortRange - - // The Amazon Resource Name (ARN) of your accelerator. - // - // This member is required. - AcceleratorArn *string - - // The protocol for connections from clients to your accelerator. - // - // This member is required. - Protocol types.Protocol - - // A unique, case-sensitive identifier that you provide to ensure the - // idempotency—that is, the uniqueness—of the request. - // - // This member is required. - IdempotencyToken *string } type CreateListenerOutput struct { diff --git a/service/globalaccelerator/api_op_ListByoipCidrs.go b/service/globalaccelerator/api_op_ListByoipCidrs.go index 63ba7e721b2..e6fc9244966 100644 --- a/service/globalaccelerator/api_op_ListByoipCidrs.go +++ b/service/globalaccelerator/api_op_ListByoipCidrs.go @@ -69,12 +69,12 @@ type ListByoipCidrsInput struct { type ListByoipCidrsOutput struct { - // The token for the next page of results. - NextToken *string - // Information about your address ranges. ByoipCidrs []*types.ByoipCidr + // The token for the next page of results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/globalaccelerator/api_op_ListEndpointGroups.go b/service/globalaccelerator/api_op_ListEndpointGroups.go index 63f68a1f6c8..99756eae4fd 100644 --- a/service/globalaccelerator/api_op_ListEndpointGroups.go +++ b/service/globalaccelerator/api_op_ListEndpointGroups.go @@ -63,13 +63,13 @@ type ListEndpointGroupsInput struct { // This member is required. ListenerArn *string - // The token for the next set of results. You receive this token from a previous - // call. - NextToken *string - // The number of endpoint group objects that you want to return with this call. The // default value is 10. MaxResults *int32 + + // The token for the next set of results. You receive this token from a previous + // call. + NextToken *string } type ListEndpointGroupsOutput struct { diff --git a/service/globalaccelerator/api_op_ListListeners.go b/service/globalaccelerator/api_op_ListListeners.go index 7726b101695..52da8894163 100644 --- a/service/globalaccelerator/api_op_ListListeners.go +++ b/service/globalaccelerator/api_op_ListListeners.go @@ -64,24 +64,24 @@ type ListListenersInput struct { // This member is required. AcceleratorArn *string - // The token for the next set of results. You receive this token from a previous - // call. - NextToken *string - // The number of listener objects that you want to return with this call. The // default value is 10. MaxResults *int32 -} - -type ListListenersOutput struct { // The token for the next set of results. You receive this token from a previous // call. NextToken *string +} + +type ListListenersOutput struct { // The list of listeners for an accelerator. Listeners []*types.Listener + // The token for the next set of results. You receive this token from a previous + // call. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/globalaccelerator/api_op_UntagResource.go b/service/globalaccelerator/api_op_UntagResource.go index a93678785ad..8c9544d2a77 100644 --- a/service/globalaccelerator/api_op_UntagResource.go +++ b/service/globalaccelerator/api_op_UntagResource.go @@ -62,16 +62,16 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The tag key pairs that you want to remove from the specified resources. - // - // This member is required. - TagKeys []*string - // The Amazon Resource Name (ARN) of the Global Accelerator resource to remove tags // from. An ARN uniquely identifies a resource. // // This member is required. ResourceArn *string + + // The tag key pairs that you want to remove from the specified resources. + // + // This member is required. + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/globalaccelerator/api_op_UpdateAccelerator.go b/service/globalaccelerator/api_op_UpdateAccelerator.go index fdda9c16920..0e94997faa4 100644 --- a/service/globalaccelerator/api_op_UpdateAccelerator.go +++ b/service/globalaccelerator/api_op_UpdateAccelerator.go @@ -59,23 +59,23 @@ func (c *Client) UpdateAccelerator(ctx context.Context, params *UpdateAccelerato type UpdateAcceleratorInput struct { + // The Amazon Resource Name (ARN) of the accelerator to update. + // + // This member is required. + AcceleratorArn *string + // Indicates whether an accelerator is enabled. The value is true or false. The // default value is true. If the value is set to true, the accelerator cannot be // deleted. If set to false, the accelerator can be deleted. Enabled *bool + // The value for the address type must be IPv4. + IpAddressType types.IpAddressType + // The name of the accelerator. The name can have a maximum of 32 characters, must // contain only alphanumeric characters or hyphens (-), and must not begin or end // with a hyphen. Name *string - - // The Amazon Resource Name (ARN) of the accelerator to update. - // - // This member is required. - AcceleratorArn *string - - // The value for the address type must be IPv4. - IpAddressType types.IpAddressType } type UpdateAcceleratorOutput struct { diff --git a/service/globalaccelerator/api_op_UpdateAcceleratorAttributes.go b/service/globalaccelerator/api_op_UpdateAcceleratorAttributes.go index 1f10b250769..593cfca5ae3 100644 --- a/service/globalaccelerator/api_op_UpdateAcceleratorAttributes.go +++ b/service/globalaccelerator/api_op_UpdateAcceleratorAttributes.go @@ -58,18 +58,6 @@ func (c *Client) UpdateAcceleratorAttributes(ctx context.Context, params *Update type UpdateAcceleratorAttributesInput struct { - // Update the prefix for the location in the Amazon S3 bucket for the flow logs. - // Attribute is required if FlowLogsEnabled is true. If you don’t specify a prefix, - // the flow logs are stored in the root of the bucket. If you specify slash (/) for - // the S3 bucket prefix, the log file bucket folder structure will include a double - // slash (//), like the following: s3-bucket_name//AWSLogs/aws_account_id - FlowLogsS3Prefix *string - - // The name of the Amazon S3 bucket for the flow logs. Attribute is required if - // FlowLogsEnabled is true. The bucket must exist and have a bucket policy that - // grants AWS Global Accelerator permission to write to the bucket. - FlowLogsS3Bucket *string - // The Amazon Resource Name (ARN) of the accelerator that you want to update. // // This member is required. @@ -81,6 +69,18 @@ type UpdateAcceleratorAttributesInput struct { // (https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html) // in the AWS Global Accelerator Developer Guide. FlowLogsEnabled *bool + + // The name of the Amazon S3 bucket for the flow logs. Attribute is required if + // FlowLogsEnabled is true. The bucket must exist and have a bucket policy that + // grants AWS Global Accelerator permission to write to the bucket. + FlowLogsS3Bucket *string + + // Update the prefix for the location in the Amazon S3 bucket for the flow logs. + // Attribute is required if FlowLogsEnabled is true. If you don’t specify a prefix, + // the flow logs are stored in the root of the bucket. If you specify slash (/) for + // the S3 bucket prefix, the log file bucket folder structure will include a double + // slash (//), like the following: s3-bucket_name//AWSLogs/aws_account_id + FlowLogsS3Prefix *string } type UpdateAcceleratorAttributesOutput struct { diff --git a/service/globalaccelerator/api_op_UpdateEndpointGroup.go b/service/globalaccelerator/api_op_UpdateEndpointGroup.go index bfa504c8ab0..de46b880f14 100644 --- a/service/globalaccelerator/api_op_UpdateEndpointGroup.go +++ b/service/globalaccelerator/api_op_UpdateEndpointGroup.go @@ -58,6 +58,11 @@ func (c *Client) UpdateEndpointGroup(ctx context.Context, params *UpdateEndpoint type UpdateEndpointGroupInput struct { + // The Amazon Resource Name (ARN) of the endpoint group. + // + // This member is required. + EndpointGroupArn *string + // The list of endpoint objects. EndpointConfigurations []*types.EndpointConfiguration @@ -65,19 +70,9 @@ type UpdateEndpointGroupInput struct { // default value is 30. HealthCheckIntervalSeconds *int32 - // The number of consecutive health checks required to set the state of a healthy - // endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default - // value is 3. - ThresholdCount *int32 - - // The protocol that AWS Global Accelerator uses to check the health of endpoints - // that are part of this endpoint group. The default value is TCP. - HealthCheckProtocol types.HealthCheckProtocol - - // The Amazon Resource Name (ARN) of the endpoint group. - // - // This member is required. - EndpointGroupArn *string + // If the protocol is HTTP/S, then this specifies the path that is the destination + // for health check targets. The default value is slash (/). + HealthCheckPath *string // The port that AWS Global Accelerator uses to check the health of endpoints that // are part of this endpoint group. The default port is the listener port that this @@ -85,16 +80,21 @@ type UpdateEndpointGroupInput struct { // Global Accelerator uses the first port in the list. HealthCheckPort *int32 + // The protocol that AWS Global Accelerator uses to check the health of endpoints + // that are part of this endpoint group. The default value is TCP. + HealthCheckProtocol types.HealthCheckProtocol + + // The number of consecutive health checks required to set the state of a healthy + // endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default + // value is 3. + ThresholdCount *int32 + // The percentage of traffic to send to an AWS Region. Additional traffic is // distributed to other endpoint groups for this listener. Use this action to // increase (dial up) or decrease (dial down) traffic to a specific Region. The // percentage is applied to the traffic that would otherwise have been routed to // the Region based on optimal routing. The default value is 100. TrafficDialPercentage *float32 - - // If the protocol is HTTP/S, then this specifies the path that is the destination - // for health check targets. The default value is slash (/). - HealthCheckPath *string } type UpdateEndpointGroupOutput struct { diff --git a/service/globalaccelerator/api_op_UpdateListener.go b/service/globalaccelerator/api_op_UpdateListener.go index f0ef0561f60..7dd47c054fc 100644 --- a/service/globalaccelerator/api_op_UpdateListener.go +++ b/service/globalaccelerator/api_op_UpdateListener.go @@ -58,6 +58,11 @@ func (c *Client) UpdateListener(ctx context.Context, params *UpdateListenerInput type UpdateListenerInput struct { + // The Amazon Resource Name (ARN) of the listener to update. + // + // This member is required. + ListenerArn *string + // Client affinity lets you direct all requests from a user to the same endpoint, // if you have stateful applications, regardless of the port and protocol of the // client request. Clienty affinity gives you control over whether to always route @@ -75,17 +80,12 @@ type UpdateListenerInput struct { // select the hash value. The default value is NONE. ClientAffinity types.ClientAffinity - // The updated protocol for the connections from clients to the accelerator. - Protocol types.Protocol - - // The Amazon Resource Name (ARN) of the listener to update. - // - // This member is required. - ListenerArn *string - // The updated list of port ranges for the connections from clients to the // accelerator. PortRanges []*types.PortRange + + // The updated protocol for the connections from clients to the accelerator. + Protocol types.Protocol } type UpdateListenerOutput struct { diff --git a/service/globalaccelerator/go.mod b/service/globalaccelerator/go.mod index 7af74c4b71c..7fb9e477073 100644 --- a/service/globalaccelerator/go.mod +++ b/service/globalaccelerator/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/globalaccelerator go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/globalaccelerator/types/types.go b/service/globalaccelerator/types/types.go index aa9773f67a2..fde9077a55c 100644 --- a/service/globalaccelerator/types/types.go +++ b/service/globalaccelerator/types/types.go @@ -11,20 +11,8 @@ import ( // groups, each of which includes endpoints, such as load balancers. type Accelerator struct { - // The name of the accelerator. The name must contain only alphanumeric characters - // or hyphens (-), and must not begin or end with a hyphen. - Name *string - - // Describes the deployment status of the accelerator. - Status AcceleratorStatus - - // Indicates whether the accelerator is enabled. The value is true or false. The - // default value is true. If the value is set to true, the accelerator cannot be - // deleted. If set to false, accelerator can be deleted. - Enabled *bool - - // The date and time that the accelerator was last modified. - LastModifiedTime *time.Time + // The Amazon Resource Name (ARN) of the accelerator. + AcceleratorArn *string // The date and time that the accelerator was created. CreatedTime *time.Time @@ -39,37 +27,49 @@ type Accelerator struct { // in the AWS Global Accelerator Developer Guide. DnsName *string + // Indicates whether the accelerator is enabled. The value is true or false. The + // default value is true. If the value is set to true, the accelerator cannot be + // deleted. If set to false, accelerator can be deleted. + Enabled *bool + // The value for the address type must be IPv4. IpAddressType IpAddressType // The static IP addresses that Global Accelerator associates with the accelerator. IpSets []*IpSet - // The Amazon Resource Name (ARN) of the accelerator. - AcceleratorArn *string + // The date and time that the accelerator was last modified. + LastModifiedTime *time.Time + + // The name of the accelerator. The name must contain only alphanumeric characters + // or hyphens (-), and must not begin or end with a hyphen. + Name *string + + // Describes the deployment status of the accelerator. + Status AcceleratorStatus } // Attributes of an accelerator. type AcceleratorAttributes struct { - // The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute - // is required if FlowLogsEnabled is true. If you don’t specify a prefix, the flow - // logs are stored in the root of the bucket. If you specify slash (/) for the S3 - // bucket prefix, the log file bucket folder structure will include a double slash - // (//), like the following: s3-bucket_name//AWSLogs/aws_account_id - FlowLogsS3Prefix *string - - // The name of the Amazon S3 bucket for the flow logs. Attribute is required if - // FlowLogsEnabled is true. The bucket must exist and have a bucket policy that - // grants AWS Global Accelerator permission to write to the bucket. - FlowLogsS3Bucket *string - // Indicates whether flow logs are enabled. The default value is false. If the // value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified. For more // information, see Flow Logs // (https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html) // in the AWS Global Accelerator Developer Guide. FlowLogsEnabled *bool + + // The name of the Amazon S3 bucket for the flow logs. Attribute is required if + // FlowLogsEnabled is true. The bucket must exist and have a bucket policy that + // grants AWS Global Accelerator permission to write to the bucket. + FlowLogsS3Bucket *string + + // The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute + // is required if FlowLogsEnabled is true. If you don’t specify a prefix, the flow + // logs are stored in the root of the bucket. If you specify slash (/) for the S3 + // bucket prefix, the log file bucket folder structure will include a double slash + // (//), like the following: s3-bucket_name//AWSLogs/aws_account_id + FlowLogsS3Prefix *string } // Information about an IP address range that is provisioned for use with your AWS @@ -140,14 +140,14 @@ type ByoipCidr struct { // Accelerator through bring your own IP address (BYOIP). type ByoipCidrEvent struct { - // A timestamp when you make a status change for an IP address range that you bring - // to AWS Global Accelerator through bring your own IP address (BYOIP). - Timestamp *time.Time - // A string that contains an Event message describing changes that you make in the // status of an IP address range that you bring to AWS Global Accelerator through // bring your own IP address (BYOIP). Message *string + + // A timestamp when you make a status change for an IP address range that you bring + // to AWS Global Accelerator through bring your own IP address (BYOIP). + Timestamp *time.Time } // Provides authorization for Amazon to bring a specific IP address range to a @@ -171,23 +171,6 @@ type CidrAuthorizationContext struct { // A complex type for endpoints. type EndpointConfiguration struct { - // The weight associated with the endpoint. When you add weights to endpoints, you - // configure AWS Global Accelerator to route traffic based on proportions that you - // specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 - // (sum=20). The result is that 4/20 of your traffic, on average, is routed to the - // first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 - // is routed to the last endpoint. For more information, see Endpoint Weights - // (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html) - // in the AWS Global Accelerator Developer Guide. - Weight *int32 - - // An ID for the endpoint. If the endpoint is a Network Load Balancer or - // Application Load Balancer, this is the Amazon Resource Name (ARN) of the - // resource. If the endpoint is an Elastic IP address, this is the Elastic IP - // address allocation ID. For EC2 instances, this is the EC2 instance ID. An - // Application Load Balancer can be either internal or internet-facing. - EndpointId *string - // Indicates whether client IP address preservation is enabled for an Application // Load Balancer endpoint. The value is true or false. The default value is true // for new accelerators. If the value is set to true, the client's IP address is @@ -198,6 +181,23 @@ type EndpointConfiguration struct { // (https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html) // in the AWS Global Accelerator Developer Guide. ClientIPPreservationEnabled *bool + + // An ID for the endpoint. If the endpoint is a Network Load Balancer or + // Application Load Balancer, this is the Amazon Resource Name (ARN) of the + // resource. If the endpoint is an Elastic IP address, this is the Elastic IP + // address allocation ID. For EC2 instances, this is the EC2 instance ID. An + // Application Load Balancer can be either internal or internet-facing. + EndpointId *string + + // The weight associated with the endpoint. When you add weights to endpoints, you + // configure AWS Global Accelerator to route traffic based on proportions that you + // specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 + // (sum=20). The result is that 4/20 of your traffic, on average, is routed to the + // first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 + // is routed to the last endpoint. For more information, see Endpoint Weights + // (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html) + // in the AWS Global Accelerator Developer Guide. + Weight *int32 } // A complex type for an endpoint. Each endpoint group can include one or more @@ -222,16 +222,6 @@ type EndpointDescription struct { // Application Load Balancer can be either internal or internet-facing. EndpointId *string - // The weight associated with the endpoint. When you add weights to endpoints, you - // configure AWS Global Accelerator to route traffic based on proportions that you - // specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 - // (sum=20). The result is that 4/20 of your traffic, on average, is routed to the - // first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 - // is routed to the last endpoint. For more information, see Endpoint Weights - // (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html) - // in the AWS Global Accelerator Developer Guide. - Weight *int32 - // The reason code associated with why the endpoint is not healthy. If the endpoint // state is healthy, a reason code is not provided. If the endpoint state is // unhealthy, the reason code can be one of the following values: @@ -256,12 +246,31 @@ type EndpointDescription struct { // The health status of the endpoint. HealthState HealthState + + // The weight associated with the endpoint. When you add weights to endpoints, you + // configure AWS Global Accelerator to route traffic based on proportions that you + // specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 + // (sum=20). The result is that 4/20 of your traffic, on average, is routed to the + // first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 + // is routed to the last endpoint. For more information, see Endpoint Weights + // (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html) + // in the AWS Global Accelerator Developer Guide. + Weight *int32 } // A complex type for the endpoint group. An AWS Region can have only one endpoint // group for a specific listener. type EndpointGroup struct { + // The list of endpoint objects. + EndpointDescriptions []*EndpointDescription + + // The Amazon Resource Name (ARN) of the endpoint group. + EndpointGroupArn *string + + // The AWS Region that this endpoint group belongs. + EndpointGroupRegion *string + // The time—10 seconds or 30 seconds—between health checks for each endpoint. The // default value is 30. HealthCheckIntervalSeconds *int32 @@ -271,29 +280,20 @@ type EndpointGroup struct { // default is slash (/). HealthCheckPath *string - // The AWS Region that this endpoint group belongs. - EndpointGroupRegion *string - - // The list of endpoint objects. - EndpointDescriptions []*EndpointDescription - // The port that Global Accelerator uses to perform health checks on endpoints that // are part of this endpoint group.

    The default port is the port for the // listener that this endpoint group is associated with. If the listener port is a // list, Global Accelerator uses the first specified port in the list of ports.

    HealthCheckPort *int32 - // The number of consecutive health checks required to set the state of a healthy - // endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default - // value is 3. - ThresholdCount *int32 - // The protocol that Global Accelerator uses to perform health checks on endpoints // that are part of this endpoint group. The default value is TCP. HealthCheckProtocol HealthCheckProtocol - // The Amazon Resource Name (ARN) of the endpoint group. - EndpointGroupArn *string + // The number of consecutive health checks required to set the state of a healthy + // endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default + // value is 3. + ThresholdCount *int32 // The percentage of traffic to send to an AWS Region. Additional traffic is // distributed to other endpoint groups for this listener. Use this action to @@ -306,12 +306,12 @@ type EndpointGroup struct { // A complex type for the set of IP addresses for an accelerator. type IpSet struct { - // The types of IP addresses included in this IP set. - IpFamily *string - // The array of IP addresses in the IP address set. An IP address set can have a // maximum of two IP addresses. IpAddresses []*string + + // The types of IP addresses included in this IP set. + IpFamily *string } // A complex type for a listener. @@ -334,24 +334,24 @@ type Listener struct { // select the hash value. The default value is NONE. ClientAffinity ClientAffinity - // The protocol for the connections from clients to the accelerator. - Protocol Protocol - // The Amazon Resource Name (ARN) of the listener. ListenerArn *string // The list of port ranges for the connections from clients to the accelerator. PortRanges []*PortRange + + // The protocol for the connections from clients to the accelerator. + Protocol Protocol } // A complex type for a range of ports for a listener. type PortRange struct { - // The last port in the range of ports, inclusive. - ToPort *int32 - // The first port in the range of ports, inclusive. FromPort *int32 + + // The last port in the range of ports, inclusive. + ToPort *int32 } // A complex type that contains a Tag key and Tag value. diff --git a/service/glue/api_op_BatchCreatePartition.go b/service/glue/api_op_BatchCreatePartition.go index 42ae5bfa87d..f364953d010 100644 --- a/service/glue/api_op_BatchCreatePartition.go +++ b/service/glue/api_op_BatchCreatePartition.go @@ -57,24 +57,24 @@ func (c *Client) BatchCreatePartition(ctx context.Context, params *BatchCreatePa type BatchCreatePartitionInput struct { - // The ID of the catalog in which the partition is to be created. Currently, this - // should be the AWS account ID. - CatalogId *string - // The name of the metadata database in which the partition is to be created. // // This member is required. DatabaseName *string - // The name of the metadata table in which the partition is to be created. + // A list of PartitionInput structures that define the partitions to be created. // // This member is required. - TableName *string + PartitionInputList []*types.PartitionInput - // A list of PartitionInput structures that define the partitions to be created. + // The name of the metadata table in which the partition is to be created. // // This member is required. - PartitionInputList []*types.PartitionInput + TableName *string + + // The ID of the catalog in which the partition is to be created. Currently, this + // should be the AWS account ID. + CatalogId *string } type BatchCreatePartitionOutput struct { diff --git a/service/glue/api_op_BatchDeletePartition.go b/service/glue/api_op_BatchDeletePartition.go index a9fc5d79c25..1e4683c7c65 100644 --- a/service/glue/api_op_BatchDeletePartition.go +++ b/service/glue/api_op_BatchDeletePartition.go @@ -62,15 +62,15 @@ type BatchDeletePartitionInput struct { // This member is required. DatabaseName *string - // The name of the table that contains the partitions to be deleted. + // A list of PartitionInput structures that define the partitions to be deleted. // // This member is required. - TableName *string + PartitionsToDelete []*types.PartitionValueList - // A list of PartitionInput structures that define the partitions to be deleted. + // The name of the table that contains the partitions to be deleted. // // This member is required. - PartitionsToDelete []*types.PartitionValueList + TableName *string // The ID of the Data Catalog where the partition to be deleted resides. If none is // provided, the AWS account ID is used by default. diff --git a/service/glue/api_op_BatchDeleteTable.go b/service/glue/api_op_BatchDeleteTable.go index b8e9ffb2adf..1bc995f6c40 100644 --- a/service/glue/api_op_BatchDeleteTable.go +++ b/service/glue/api_op_BatchDeleteTable.go @@ -63,17 +63,17 @@ func (c *Client) BatchDeleteTable(ctx context.Context, params *BatchDeleteTableI type BatchDeleteTableInput struct { - // A list of the table to delete. - // - // This member is required. - TablesToDelete []*string - // The name of the catalog database in which the tables to delete reside. For Hive // compatibility, this name is entirely lowercase. // // This member is required. DatabaseName *string + // A list of the table to delete. + // + // This member is required. + TablesToDelete []*string + // The ID of the Data Catalog where the table resides. If none is provided, the AWS // account ID is used by default. CatalogId *string diff --git a/service/glue/api_op_BatchDeleteTableVersion.go b/service/glue/api_op_BatchDeleteTableVersion.go index 763f1362e28..fc9b8e889c4 100644 --- a/service/glue/api_op_BatchDeleteTableVersion.go +++ b/service/glue/api_op_BatchDeleteTableVersion.go @@ -63,6 +63,11 @@ type BatchDeleteTableVersionInput struct { // This member is required. DatabaseName *string + // The name of the table. For Hive compatibility, this name is entirely lowercase. + // + // This member is required. + TableName *string + // A list of the IDs of versions to be deleted. A VersionId is a string // representation of an integer. Each version is incremented by 1. // @@ -72,11 +77,6 @@ type BatchDeleteTableVersionInput struct { // The ID of the Data Catalog where the tables reside. If none is provided, the AWS // account ID is used by default. CatalogId *string - - // The name of the table. For Hive compatibility, this name is entirely lowercase. - // - // This member is required. - TableName *string } type BatchDeleteTableVersionOutput struct { diff --git a/service/glue/api_op_BatchGetJobs.go b/service/glue/api_op_BatchGetJobs.go index fd5f3b21dcb..6cc95eea0b9 100644 --- a/service/glue/api_op_BatchGetJobs.go +++ b/service/glue/api_op_BatchGetJobs.go @@ -69,12 +69,12 @@ type BatchGetJobsInput struct { type BatchGetJobsOutput struct { - // A list of names of jobs not found. - JobsNotFound []*string - // A list of job definitions. Jobs []*types.Job + // A list of names of jobs not found. + JobsNotFound []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/glue/api_op_BatchGetPartition.go b/service/glue/api_op_BatchGetPartition.go index 2d7be7cdea9..a0c33022850 100644 --- a/service/glue/api_op_BatchGetPartition.go +++ b/service/glue/api_op_BatchGetPartition.go @@ -57,35 +57,35 @@ func (c *Client) BatchGetPartition(ctx context.Context, params *BatchGetPartitio type BatchGetPartitionInput struct { - // The ID of the Data Catalog where the partitions in question reside. If none is - // supplied, the AWS account ID is used by default. - CatalogId *string - - // A list of partition values identifying the partitions to retrieve. + // The name of the catalog database where the partitions reside. // // This member is required. - PartitionsToGet []*types.PartitionValueList + DatabaseName *string - // The name of the catalog database where the partitions reside. + // A list of partition values identifying the partitions to retrieve. // // This member is required. - DatabaseName *string + PartitionsToGet []*types.PartitionValueList // The name of the partitions' table. // // This member is required. TableName *string + + // The ID of the Data Catalog where the partitions in question reside. If none is + // supplied, the AWS account ID is used by default. + CatalogId *string } type BatchGetPartitionOutput struct { + // A list of the requested partitions. + Partitions []*types.Partition + // A list of the partition values in the request for which partitions were not // returned. UnprocessedKeys []*types.PartitionValueList - // A list of the requested partitions. - Partitions []*types.Partition - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/glue/api_op_BatchGetWorkflows.go b/service/glue/api_op_BatchGetWorkflows.go index 20520c91b81..9854938dcb8 100644 --- a/service/glue/api_op_BatchGetWorkflows.go +++ b/service/glue/api_op_BatchGetWorkflows.go @@ -73,12 +73,12 @@ type BatchGetWorkflowsInput struct { type BatchGetWorkflowsOutput struct { - // A list of workflow resource metadata. - Workflows []*types.Workflow - // A list of names of workflows not found. MissingWorkflows []*string + // A list of workflow resource metadata. + Workflows []*types.Workflow + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/glue/api_op_CancelMLTaskRun.go b/service/glue/api_op_CancelMLTaskRun.go index d893c835f6d..ad254158b94 100644 --- a/service/glue/api_op_CancelMLTaskRun.go +++ b/service/glue/api_op_CancelMLTaskRun.go @@ -61,27 +61,27 @@ func (c *Client) CancelMLTaskRun(ctx context.Context, params *CancelMLTaskRunInp type CancelMLTaskRunInput struct { - // The unique identifier of the machine learning transform. + // A unique identifier for the task run. // // This member is required. - TransformId *string + TaskRunId *string - // A unique identifier for the task run. + // The unique identifier of the machine learning transform. // // This member is required. - TaskRunId *string + TransformId *string } type CancelMLTaskRunOutput struct { - // The unique identifier of the machine learning transform. - TransformId *string + // The status for this run. + Status types.TaskStatusType // The unique identifier for the task run. TaskRunId *string - // The status for this run. - Status types.TaskStatusType + // The unique identifier of the machine learning transform. + TransformId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/glue/api_op_CreateClassifier.go b/service/glue/api_op_CreateClassifier.go index 45b83408440..040cb145d48 100644 --- a/service/glue/api_op_CreateClassifier.go +++ b/service/glue/api_op_CreateClassifier.go @@ -59,17 +59,17 @@ func (c *Client) CreateClassifier(ctx context.Context, params *CreateClassifierI type CreateClassifierInput struct { - // A JsonClassifier object specifying the classifier to create. - JsonClassifier *types.CreateJsonClassifierRequest - // A CsvClassifier object specifying the classifier to create. CsvClassifier *types.CreateCsvClassifierRequest - // An XMLClassifier object specifying the classifier to create. - XMLClassifier *types.CreateXMLClassifierRequest - // A GrokClassifier object specifying the classifier to create. GrokClassifier *types.CreateGrokClassifierRequest + + // A JsonClassifier object specifying the classifier to create. + JsonClassifier *types.CreateJsonClassifierRequest + + // An XMLClassifier object specifying the classifier to create. + XMLClassifier *types.CreateXMLClassifierRequest } type CreateClassifierOutput struct { diff --git a/service/glue/api_op_CreateConnection.go b/service/glue/api_op_CreateConnection.go index 3123e39bc75..caad0bafac2 100644 --- a/service/glue/api_op_CreateConnection.go +++ b/service/glue/api_op_CreateConnection.go @@ -57,14 +57,14 @@ func (c *Client) CreateConnection(ctx context.Context, params *CreateConnectionI type CreateConnectionInput struct { - // The ID of the Data Catalog in which to create the connection. If none is - // provided, the AWS account ID is used by default. - CatalogId *string - // A ConnectionInput object defining the connection to create. // // This member is required. ConnectionInput *types.ConnectionInput + + // The ID of the Data Catalog in which to create the connection. If none is + // provided, the AWS account ID is used by default. + CatalogId *string } type CreateConnectionOutput struct { diff --git a/service/glue/api_op_CreateCrawler.go b/service/glue/api_op_CreateCrawler.go index 02846ec52d7..5d72d0a0e88 100644 --- a/service/glue/api_op_CreateCrawler.go +++ b/service/glue/api_op_CreateCrawler.go @@ -59,25 +59,31 @@ func (c *Client) CreateCrawler(ctx context.Context, params *CreateCrawlerInput, type CreateCrawlerInput struct { + // Name of the new crawler. + // + // This member is required. + Name *string + // The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new // crawler to access customer resources. // // This member is required. Role *string - // The tags to use with this crawler request. You may use tags to limit access to - // the crawler. For more information about tags in AWS Glue, see AWS Tags in AWS - // Glue (https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html) in the - // developer guide. - Tags map[string]*string + // A list of collection of targets to crawl. + // + // This member is required. + Targets *types.CrawlerTargets // A list of custom classifiers that the user has registered. By default, all // built-in classifiers are included in a crawl, but these custom classifiers // always override the default classifiers for a given classification. Classifiers []*string - // The table prefix used for catalog tables that are created. - TablePrefix *string + // Crawler configuration information. This versioned JSON string allows users to + // specify aspects of a crawler's behavior. For more information, see Configuring a + // Crawler (https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html). + Configuration *string // The name of the SecurityConfiguration structure to be used by this crawler. CrawlerSecurityConfiguration *string @@ -86,6 +92,9 @@ type CreateCrawlerInput struct { // arn:aws:daylight:us-east-1::database/sometable/*. DatabaseName *string + // A description of the new crawler. + Description *string + // A cron expression used to specify the schedule (see Time-Based Schedules for // Jobs and Crawlers // (https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). @@ -93,26 +102,17 @@ type CreateCrawlerInput struct { // 12 * * ? *). Schedule *string - // Name of the new crawler. - // - // This member is required. - Name *string - - // A description of the new crawler. - Description *string - - // Crawler configuration information. This versioned JSON string allows users to - // specify aspects of a crawler's behavior. For more information, see Configuring a - // Crawler (https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html). - Configuration *string - - // A list of collection of targets to crawl. - // - // This member is required. - Targets *types.CrawlerTargets - // The policy for the crawler's update and deletion behavior. SchemaChangePolicy *types.SchemaChangePolicy + + // The table prefix used for catalog tables that are created. + TablePrefix *string + + // The tags to use with this crawler request. You may use tags to limit access to + // the crawler. For more information about tags in AWS Glue, see AWS Tags in AWS + // Glue (https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html) in the + // developer guide. + Tags map[string]*string } type CreateCrawlerOutput struct { diff --git a/service/glue/api_op_CreateDevEndpoint.go b/service/glue/api_op_CreateDevEndpoint.go index a7c8f610218..7fdb46f4818 100644 --- a/service/glue/api_op_CreateDevEndpoint.go +++ b/service/glue/api_op_CreateDevEndpoint.go @@ -58,23 +58,57 @@ func (c *Client) CreateDevEndpoint(ctx context.Context, params *CreateDevEndpoin type CreateDevEndpointInput struct { - // The subnet ID for the new DevEndpoint to use. - SubnetId *string + // The name to be assigned to the new DevEndpoint. + // + // This member is required. + EndpointName *string - // The name of the SecurityConfiguration structure to be used with this + // The IAM role for the DevEndpoint. + // + // This member is required. + RoleArn *string + + // A map of arguments used to configure the DevEndpoint. + Arguments map[string]*string + + // The path to one or more Java .jar files in an S3 bucket that should be loaded in + // your DevEndpoint. + ExtraJarsS3Path *string + + // The paths to one or more Python libraries in an Amazon S3 bucket that should be + // loaded in your DevEndpoint. Multiple values must be complete paths separated by + // a comma. You can only use pure Python libraries with a DevEndpoint. Libraries + // that rely on C extensions, such as the pandas (http://pandas.pydata.org/) Python + // data analysis library, are not yet supported. + ExtraPythonLibsS3Path *string + + // Glue version determines the versions of Apache Spark and Python that AWS Glue + // supports. The Python version indicates the version supported for running your + // ETL scripts on development endpoints.

    For more information about the + // available AWS Glue versions and corresponding Spark and Python versions, see Glue version + // in the developer guide.

    Development endpoints that are created without + // specifying a Glue version default to Glue 0.9.

    You can specify a version + // of Python support for development endpoints by using the Arguments + // parameter in the CreateDevEndpoint or + // UpdateDevEndpoint APIs. If no arguments are provided, the version + // defaults to Python 2.

    + GlueVersion *string + + // The number of AWS Glue Data Processing Units (DPUs) to allocate to this // DevEndpoint. - SecurityConfiguration *string + NumberOfNodes *int32 + + // The number of workers of a defined workerType that are allocated to the + // development endpoint.

    The maximum number of workers you can define are 299 + // for G.1X, and 149 for G.2X.

    + NumberOfWorkers *int32 // The public key to be used by this DevEndpoint for authentication. This attribute // is provided for backward compatibility because the recommended attribute to use // is public keys. PublicKey *string - // The name to be assigned to the new DevEndpoint. - // - // This member is required. - EndpointName *string - // A list of public keys to be used by the development endpoints for // authentication. The use of this attribute is preferred over a single public key // because the public keys allow you to have a different private key per client. @@ -85,47 +119,22 @@ type CreateDevEndpointInput struct { // addPublicKeys attribute.

    PublicKeys []*string - // The IAM role for the DevEndpoint. - // - // This member is required. - RoleArn *string - - // The number of AWS Glue Data Processing Units (DPUs) to allocate to this + // The name of the SecurityConfiguration structure to be used with this // DevEndpoint. - NumberOfNodes *int32 + SecurityConfiguration *string // Security group IDs for the security groups to be used by the new DevEndpoint. SecurityGroupIds []*string + // The subnet ID for the new DevEndpoint to use. + SubnetId *string + // The tags to use with this DevEndpoint. You may use tags to limit access to the // DevEndpoint. For more information about tags in AWS Glue, see AWS Tags in AWS // Glue (https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html) in the // developer guide. Tags map[string]*string - // A map of arguments used to configure the DevEndpoint. - Arguments map[string]*string - - // Glue version determines the versions of Apache Spark and Python that AWS Glue - // supports. The Python version indicates the version supported for running your - // ETL scripts on development endpoints.

    For more information about the - // available AWS Glue versions and corresponding Spark and Python versions, see Glue version - // in the developer guide.

    Development endpoints that are created without - // specifying a Glue version default to Glue 0.9.

    You can specify a version - // of Python support for development endpoints by using the Arguments - // parameter in the CreateDevEndpoint or - // UpdateDevEndpoint APIs. If no arguments are provided, the version - // defaults to Python 2.

    - GlueVersion *string - - // The paths to one or more Python libraries in an Amazon S3 bucket that should be - // loaded in your DevEndpoint. Multiple values must be complete paths separated by - // a comma. You can only use pure Python libraries with a DevEndpoint. Libraries - // that rely on C extensions, such as the pandas (http://pandas.pydata.org/) Python - // data analysis library, are not yet supported. - ExtraPythonLibsS3Path *string - // The type of predefined worker that is allocated to the development endpoint. // Accepts a value of Standard, G.1X, or G.2X. // @@ -146,39 +155,10 @@ type CreateDevEndpointInput struct { // G.2XWorkerType configuration, the Spark drivers for the development endpoint // will run on 4 vCPU, 16 GB of memory, and a 64 GB disk. WorkerType types.WorkerType - - // The path to one or more Java .jar files in an S3 bucket that should be loaded in - // your DevEndpoint. - ExtraJarsS3Path *string - - // The number of workers of a defined workerType that are allocated to the - // development endpoint.

    The maximum number of workers you can define are 299 - // for G.1X, and 149 for G.2X.

    - NumberOfWorkers *int32 } type CreateDevEndpointOutput struct { - // The AWS Availability Zone where this DevEndpoint is located. - AvailabilityZone *string - - // The number of AWS Glue Data Processing Units (DPUs) allocated to this - // DevEndpoint. - NumberOfNodes *int32 - - // The Apache Zeppelin port for the remote Apache Spark interpreter. - ZeppelinRemoteSparkInterpreterPort *int32 - - // The reason for a current failure in this DevEndpoint. - FailureReason *string - - // The paths to one or more Python libraries in an S3 bucket that will be loaded in - // your DevEndpoint. - ExtraPythonLibsS3Path *string - - // The current status of the new DevEndpoint. - Status *string - // The map of arguments used to configure this DevEndpoint.

    Valid arguments // are:

    MaxCapacity *float64 - // Description of the job being defined. - Description *string + // The maximum number of times to retry this job if it fails. + MaxRetries *int32 - // The name you assign to this job definition. It must be unique in your account. - // - // This member is required. - Name *string + // Non-overridable arguments for this job, specified as name-value pairs. + NonOverridableArguments map[string]*string // Specifies configuration properties of a job notification. NotificationProperty *types.NotificationProperty + + // The number of workers of a defined workerType that are allocated when a job + // runs.

    The maximum number of workers you can define are 299 for + // G.1X, and 149 for G.2X.

    + NumberOfWorkers *int32 + + // The name of the SecurityConfiguration structure to be used with this job. + SecurityConfiguration *string + + // The tags to use with this job. You may use tags to limit access to the job. For + // more information about tags in AWS Glue, see AWS Tags in AWS Glue + // (https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html) in the developer + // guide. + Tags map[string]*string + + // The job timeout in minutes. This is the maximum time that a job run can consume + // resources before it is terminated and enters TIMEOUT status. The default is + // 2,880 minutes (48 hours). + Timeout *int32 + + // The type of predefined worker that is allocated when a job runs. Accepts a value + // of Standard, G.1X, or G.2X. + // + // * For the Standard worker type, each worker + // provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. + // + // + // * For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, + // 64 GB disk), and provides 1 executor per worker. We recommend this worker type + // for memory-intensive jobs. + // + // * For the G.2X worker type, each worker maps to + // 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per + // worker. We recommend this worker type for memory-intensive jobs. + WorkerType types.WorkerType } type CreateJobOutput struct { diff --git a/service/glue/api_op_CreateMLTransform.go b/service/glue/api_op_CreateMLTransform.go index 5c2711bac53..4895265016c 100644 --- a/service/glue/api_op_CreateMLTransform.go +++ b/service/glue/api_op_CreateMLTransform.go @@ -67,9 +67,21 @@ func (c *Client) CreateMLTransform(ctx context.Context, params *CreateMLTransfor type CreateMLTransformInput struct { - // The maximum number of times to retry a task for this transform after a task run - // fails. - MaxRetries *int32 + // A list of AWS Glue table definitions used by the transform. + // + // This member is required. + InputRecordTables []*types.GlueTable + + // The unique name that you give the transform when you create it. + // + // This member is required. + Name *string + + // The algorithmic parameters that are specific to the transform type used. + // Conditionally dependent on the transform type. + // + // This member is required. + Parameters *types.TransformParameters // The name or Amazon Resource Name (ARN) of the IAM role with the required // permissions. The required permissions include both AWS Glue service role @@ -85,50 +97,17 @@ type CreateMLTransformInput struct { // This member is required. Role *string - // The type of predefined worker that is allocated when this task runs. Accepts a - // value of Standard, G.1X, or G.2X. - // - // * For the Standard worker type, each - // worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per - // worker. - // - // * For the G.1X worker type, each worker provides 4 vCPU, 16 GB of - // memory and a 64GB disk, and 1 executor per worker. - // - // * For the G.2X worker - // type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 - // executor per worker. - // - //

    MaxCapacity is a mutually exclusive - // option with NumberOfWorkers and WorkerType.

    - WorkerType types.WorkerType - // A description of the machine learning transform that is being defined. The // default is an empty string. Description *string - // The algorithmic parameters that are specific to the transform type used. - // Conditionally dependent on the transform type. - // - // This member is required. - Parameters *types.TransformParameters - - // The number of workers of a defined workerType that are allocated when this task - // runs.

    If WorkerType is set, then NumberOfWorkers - // is required (and vice versa).

    - NumberOfWorkers *int32 - - // A list of AWS Glue table definitions used by the transform. - // - // This member is required. - InputRecordTables []*types.GlueTable + // This value determines which version of AWS Glue this machine learning transform + // is compatible with. Glue 1.0 is recommended for most customers. If the value is + // not set, the Glue compatibility defaults to Glue 0.9. For more information, see + // AWS Glue Versions + // (https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions) + // in the developer guide. + GlueVersion *string // The number of AWS Glue data processing units (DPUs) that are allocated to task // runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. @@ -151,6 +130,15 @@ type CreateMLTransformInput struct { // and becomes read-only.

    MaxCapacity *float64 + // The maximum number of times to retry a task for this transform after a task run + // fails. + MaxRetries *int32 + + // The number of workers of a defined workerType that are allocated when this task + // runs.

    If WorkerType is set, then NumberOfWorkers + // is required (and vice versa).

    + NumberOfWorkers *int32 + // The tags to use with this machine learning transform. You may use tags to limit // access to the machine learning transform. For more information about tags in AWS // Glue, see AWS Tags in AWS Glue @@ -158,23 +146,35 @@ type CreateMLTransformInput struct { // guide. Tags map[string]*string - // The unique name that you give the transform when you create it. - // - // This member is required. - Name *string - // The timeout of the task run for this transform in minutes. This is the maximum // time that a task run for this transform can consume resources before it is // terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). Timeout *int32 - // This value determines which version of AWS Glue this machine learning transform - // is compatible with. Glue 1.0 is recommended for most customers. If the value is - // not set, the Glue compatibility defaults to Glue 0.9. For more information, see - // AWS Glue Versions - // (https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions) - // in the developer guide. - GlueVersion *string + // The type of predefined worker that is allocated when this task runs. Accepts a + // value of Standard, G.1X, or G.2X. + // + // * For the Standard worker type, each + // worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per + // worker. + // + // * For the G.1X worker type, each worker provides 4 vCPU, 16 GB of + // memory and a 64GB disk, and 1 executor per worker. + // + // * For the G.2X worker + // type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 + // executor per worker. + // + //

    MaxCapacity is a mutually exclusive + // option with NumberOfWorkers and WorkerType.

    + WorkerType types.WorkerType } type CreateMLTransformOutput struct { diff --git a/service/glue/api_op_CreatePartition.go b/service/glue/api_op_CreatePartition.go index 3f850338132..78bd1f20440 100644 --- a/service/glue/api_op_CreatePartition.go +++ b/service/glue/api_op_CreatePartition.go @@ -57,23 +57,23 @@ func (c *Client) CreatePartition(ctx context.Context, params *CreatePartitionInp type CreatePartitionInput struct { - // The name of the metadata table in which the partition is to be created. - // - // This member is required. - TableName *string - // The name of the metadata database in which the partition is to be created. // // This member is required. DatabaseName *string - // The AWS account ID of the catalog in which the partition is to be created. - CatalogId *string - // A PartitionInput structure defining the partition to be created. // // This member is required. PartitionInput *types.PartitionInput + + // The name of the metadata table in which the partition is to be created. + // + // This member is required. + TableName *string + + // The AWS account ID of the catalog in which the partition is to be created. + CatalogId *string } type CreatePartitionOutput struct { diff --git a/service/glue/api_op_CreateScript.go b/service/glue/api_op_CreateScript.go index 2505eae61fc..e83a3e94fdf 100644 --- a/service/glue/api_op_CreateScript.go +++ b/service/glue/api_op_CreateScript.go @@ -57,24 +57,24 @@ func (c *Client) CreateScript(ctx context.Context, params *CreateScriptInput, op type CreateScriptInput struct { + // A list of the edges in the DAG. + DagEdges []*types.CodeGenEdge + // A list of the nodes in the DAG. DagNodes []*types.CodeGenNode // The programming language of the resulting code from the DAG. Language types.Language - - // A list of the edges in the DAG. - DagEdges []*types.CodeGenEdge } type CreateScriptOutput struct { - // The Scala code generated from the DAG. - ScalaCode *string - // The Python script generated from the DAG. PythonScript *string + // The Scala code generated from the DAG. + ScalaCode *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/glue/api_op_CreateSecurityConfiguration.go b/service/glue/api_op_CreateSecurityConfiguration.go index ad48cd8a361..b986f347154 100644 --- a/service/glue/api_op_CreateSecurityConfiguration.go +++ b/service/glue/api_op_CreateSecurityConfiguration.go @@ -63,15 +63,15 @@ func (c *Client) CreateSecurityConfiguration(ctx context.Context, params *Create type CreateSecurityConfigurationInput struct { - // The name for the new security configuration. + // The encryption configuration for the new security configuration. // // This member is required. - Name *string + EncryptionConfiguration *types.EncryptionConfiguration - // The encryption configuration for the new security configuration. + // The name for the new security configuration. // // This member is required. - EncryptionConfiguration *types.EncryptionConfiguration + Name *string } type CreateSecurityConfigurationOutput struct { diff --git a/service/glue/api_op_CreateTable.go b/service/glue/api_op_CreateTable.go index 500162fc5a0..547ba40aced 100644 --- a/service/glue/api_op_CreateTable.go +++ b/service/glue/api_op_CreateTable.go @@ -57,10 +57,6 @@ func (c *Client) CreateTable(ctx context.Context, params *CreateTableInput, optF type CreateTableInput struct { - // The ID of the Data Catalog in which to create the Table. If none is supplied, - // the AWS account ID is used by default. - CatalogId *string - // The catalog database in which to create the new table. For Hive compatibility, // this name is entirely lowercase. // @@ -71,6 +67,10 @@ type CreateTableInput struct { // // This member is required. TableInput *types.TableInput + + // The ID of the Data Catalog in which to create the Table. If none is supplied, + // the AWS account ID is used by default. + CatalogId *string } type CreateTableOutput struct { diff --git a/service/glue/api_op_CreateTrigger.go b/service/glue/api_op_CreateTrigger.go index 049098965f0..4f9bfd3c761 100644 --- a/service/glue/api_op_CreateTrigger.go +++ b/service/glue/api_op_CreateTrigger.go @@ -57,12 +57,27 @@ func (c *Client) CreateTrigger(ctx context.Context, params *CreateTriggerInput, type CreateTriggerInput struct { + // The actions initiated by this trigger when it fires. + // + // This member is required. + Actions []*types.Action + + // The name of the trigger. + // + // This member is required. + Name *string + + // The type of the new trigger. + // + // This member is required. + Type types.TriggerType + // A description of the new trigger. Description *string - // Set to true to start SCHEDULED and CONDITIONAL triggers when created. True is - // not supported for ON_DEMAND triggers. - StartOnCreation *bool + // A predicate to specify when the new trigger should fire. This field is required + // when the trigger type is CONDITIONAL. + Predicate *types.Predicate // A cron expression used to specify the schedule (see Time-Based Schedules for // Jobs and Crawlers @@ -71,18 +86,9 @@ type CreateTriggerInput struct { // 12 * * ? *). This field is required when the trigger type is SCHEDULED. Schedule *string - // The name of the workflow associated with the trigger. - WorkflowName *string - - // The actions initiated by this trigger when it fires. - // - // This member is required. - Actions []*types.Action - - // The type of the new trigger. - // - // This member is required. - Type types.TriggerType + // Set to true to start SCHEDULED and CONDITIONAL triggers when created. True is + // not supported for ON_DEMAND triggers. + StartOnCreation *bool // The tags to use with this trigger. You may use tags to limit access to the // trigger. For more information about tags in AWS Glue, see AWS Tags in AWS Glue @@ -90,14 +96,8 @@ type CreateTriggerInput struct { // guide. Tags map[string]*string - // The name of the trigger. - // - // This member is required. - Name *string - - // A predicate to specify when the new trigger should fire. This field is required - // when the trigger type is CONDITIONAL. - Predicate *types.Predicate + // The name of the workflow associated with the trigger. + WorkflowName *string } type CreateTriggerOutput struct { diff --git a/service/glue/api_op_CreateWorkflow.go b/service/glue/api_op_CreateWorkflow.go index 7ccdac7b2f9..57205d1c861 100644 --- a/service/glue/api_op_CreateWorkflow.go +++ b/service/glue/api_op_CreateWorkflow.go @@ -62,14 +62,14 @@ type CreateWorkflowInput struct { // This member is required. Name *string - // The tags to be used with this workflow. - Tags map[string]*string + // A collection of properties to be used as part of each execution of the workflow. + DefaultRunProperties map[string]*string // A description of the workflow. Description *string - // A collection of properties to be used as part of each execution of the workflow. - DefaultRunProperties map[string]*string + // The tags to be used with this workflow. + Tags map[string]*string } type CreateWorkflowOutput struct { diff --git a/service/glue/api_op_DeleteColumnStatisticsForPartition.go b/service/glue/api_op_DeleteColumnStatisticsForPartition.go index cba711027f3..4b367f5e225 100644 --- a/service/glue/api_op_DeleteColumnStatisticsForPartition.go +++ b/service/glue/api_op_DeleteColumnStatisticsForPartition.go @@ -56,11 +56,6 @@ func (c *Client) DeleteColumnStatisticsForPartition(ctx context.Context, params type DeleteColumnStatisticsForPartitionInput struct { - // The name of the partitions' table. - // - // This member is required. - TableName *string - // Name of the column. // // This member is required. @@ -71,14 +66,19 @@ type DeleteColumnStatisticsForPartitionInput struct { // This member is required. DatabaseName *string - // The ID of the Data Catalog where the partitions in question reside. If none is - // supplied, the AWS account ID is used by default. - CatalogId *string - // A list of partition values identifying the partition. // // This member is required. PartitionValues []*string + + // The name of the partitions' table. + // + // This member is required. + TableName *string + + // The ID of the Data Catalog where the partitions in question reside. If none is + // supplied, the AWS account ID is used by default. + CatalogId *string } type DeleteColumnStatisticsForPartitionOutput struct { diff --git a/service/glue/api_op_DeleteColumnStatisticsForTable.go b/service/glue/api_op_DeleteColumnStatisticsForTable.go index 9445f33d541..f9d62dc114b 100644 --- a/service/glue/api_op_DeleteColumnStatisticsForTable.go +++ b/service/glue/api_op_DeleteColumnStatisticsForTable.go @@ -56,24 +56,24 @@ func (c *Client) DeleteColumnStatisticsForTable(ctx context.Context, params *Del type DeleteColumnStatisticsForTableInput struct { - // The name of the partitions' table. - // - // This member is required. - TableName *string - // The name of the column. // // This member is required. ColumnName *string - // The ID of the Data Catalog where the partitions in question reside. If none is - // supplied, the AWS account ID is used by default. - CatalogId *string - // The name of the catalog database where the partitions reside. // // This member is required. DatabaseName *string + + // The name of the partitions' table. + // + // This member is required. + TableName *string + + // The ID of the Data Catalog where the partitions in question reside. If none is + // supplied, the AWS account ID is used by default. + CatalogId *string } type DeleteColumnStatisticsForTableOutput struct { diff --git a/service/glue/api_op_DeleteDatabase.go b/service/glue/api_op_DeleteDatabase.go index 436dcdeb20b..197494d5f44 100644 --- a/service/glue/api_op_DeleteDatabase.go +++ b/service/glue/api_op_DeleteDatabase.go @@ -64,15 +64,15 @@ func (c *Client) DeleteDatabase(ctx context.Context, params *DeleteDatabaseInput type DeleteDatabaseInput struct { - // The ID of the Data Catalog in which the database resides. If none is provided, - // the AWS account ID is used by default. - CatalogId *string - // The name of the database to delete. For Hive compatibility, this must be all // lowercase. // // This member is required. Name *string + + // The ID of the Data Catalog in which the database resides. If none is provided, + // the AWS account ID is used by default. + CatalogId *string } type DeleteDatabaseOutput struct { diff --git a/service/glue/api_op_DeletePartition.go b/service/glue/api_op_DeletePartition.go index 28014933701..f2aa202ce9c 100644 --- a/service/glue/api_op_DeletePartition.go +++ b/service/glue/api_op_DeletePartition.go @@ -56,20 +56,20 @@ func (c *Client) DeletePartition(ctx context.Context, params *DeletePartitionInp type DeletePartitionInput struct { - // The name of the table that contains the partition to be deleted. + // The name of the catalog database in which the table in question resides. // // This member is required. - TableName *string + DatabaseName *string // The values that define the partition. // // This member is required. PartitionValues []*string - // The name of the catalog database in which the table in question resides. + // The name of the table that contains the partition to be deleted. // // This member is required. - DatabaseName *string + TableName *string // The ID of the Data Catalog where the partition to be deleted resides. If none is // provided, the AWS account ID is used by default. diff --git a/service/glue/api_op_DeleteResourcePolicy.go b/service/glue/api_op_DeleteResourcePolicy.go index 610a640d978..f14b2ea8303 100644 --- a/service/glue/api_op_DeleteResourcePolicy.go +++ b/service/glue/api_op_DeleteResourcePolicy.go @@ -55,11 +55,11 @@ func (c *Client) DeleteResourcePolicy(ctx context.Context, params *DeleteResourc type DeleteResourcePolicyInput struct { - // The ARN of the AWS Glue resource for the resource policy to be deleted. - ResourceArn *string - // The hash value returned when this policy was set. PolicyHashCondition *string + + // The ARN of the AWS Glue resource for the resource policy to be deleted. + ResourceArn *string } type DeleteResourcePolicyOutput struct { diff --git a/service/glue/api_op_DeleteTable.go b/service/glue/api_op_DeleteTable.go index e382fd20f10..bff2a1420bb 100644 --- a/service/glue/api_op_DeleteTable.go +++ b/service/glue/api_op_DeleteTable.go @@ -62,9 +62,11 @@ func (c *Client) DeleteTable(ctx context.Context, params *DeleteTableInput, optF type DeleteTableInput struct { - // The ID of the Data Catalog where the table resides. If none is provided, the AWS - // account ID is used by default. - CatalogId *string + // The name of the catalog database in which the table resides. For Hive + // compatibility, this name is entirely lowercase. + // + // This member is required. + DatabaseName *string // The name of the table to be deleted. For Hive compatibility, this name is // entirely lowercase. @@ -72,11 +74,9 @@ type DeleteTableInput struct { // This member is required. Name *string - // The name of the catalog database in which the table resides. For Hive - // compatibility, this name is entirely lowercase. - // - // This member is required. - DatabaseName *string + // The ID of the Data Catalog where the table resides. If none is provided, the AWS + // account ID is used by default. + CatalogId *string } type DeleteTableOutput struct { diff --git a/service/glue/api_op_DeleteTableVersion.go b/service/glue/api_op_DeleteTableVersion.go index ee2716baf25..c2df366ca05 100644 --- a/service/glue/api_op_DeleteTableVersion.go +++ b/service/glue/api_op_DeleteTableVersion.go @@ -56,26 +56,26 @@ func (c *Client) DeleteTableVersion(ctx context.Context, params *DeleteTableVers type DeleteTableVersionInput struct { + // The database in the catalog in which the table resides. For Hive compatibility, + // this name is entirely lowercase. + // + // This member is required. + DatabaseName *string + // The name of the table. For Hive compatibility, this name is entirely lowercase. // // This member is required. TableName *string - // The ID of the Data Catalog where the tables reside. If none is provided, the AWS - // account ID is used by default. - CatalogId *string - // The ID of the table version to be deleted. A VersionID is a string // representation of an integer. Each version is incremented by 1. // // This member is required. VersionId *string - // The database in the catalog in which the table resides. For Hive compatibility, - // this name is entirely lowercase. - // - // This member is required. - DatabaseName *string + // The ID of the Data Catalog where the tables reside. If none is provided, the AWS + // account ID is used by default. + CatalogId *string } type DeleteTableVersionOutput struct { diff --git a/service/glue/api_op_DeleteUserDefinedFunction.go b/service/glue/api_op_DeleteUserDefinedFunction.go index a29ab861c39..ad2c853233b 100644 --- a/service/glue/api_op_DeleteUserDefinedFunction.go +++ b/service/glue/api_op_DeleteUserDefinedFunction.go @@ -56,19 +56,19 @@ func (c *Client) DeleteUserDefinedFunction(ctx context.Context, params *DeleteUs type DeleteUserDefinedFunctionInput struct { - // The ID of the Data Catalog where the function to be deleted is located. If none - // is supplied, the AWS account ID is used by default. - CatalogId *string + // The name of the catalog database where the function is located. + // + // This member is required. + DatabaseName *string // The name of the function definition to be deleted. // // This member is required. FunctionName *string - // The name of the catalog database where the function is located. - // - // This member is required. - DatabaseName *string + // The ID of the Data Catalog where the function to be deleted is located. If none + // is supplied, the AWS account ID is used by default. + CatalogId *string } type DeleteUserDefinedFunctionOutput struct { diff --git a/service/glue/api_op_GetClassifiers.go b/service/glue/api_op_GetClassifiers.go index 95761a37fad..2a1f3f591d3 100644 --- a/service/glue/api_op_GetClassifiers.go +++ b/service/glue/api_op_GetClassifiers.go @@ -56,11 +56,11 @@ func (c *Client) GetClassifiers(ctx context.Context, params *GetClassifiersInput type GetClassifiersInput struct { - // An optional continuation token. - NextToken *string - // The size of the list to return (optional). MaxResults *int32 + + // An optional continuation token. + NextToken *string } type GetClassifiersOutput struct { diff --git a/service/glue/api_op_GetColumnStatisticsForPartition.go b/service/glue/api_op_GetColumnStatisticsForPartition.go index 8f602e5a0a9..d5e53315061 100644 --- a/service/glue/api_op_GetColumnStatisticsForPartition.go +++ b/service/glue/api_op_GetColumnStatisticsForPartition.go @@ -57,11 +57,6 @@ func (c *Client) GetColumnStatisticsForPartition(ctx context.Context, params *Ge type GetColumnStatisticsForPartitionInput struct { - // The name of the partitions' table. - // - // This member is required. - TableName *string - // A list of the column names. // // This member is required. @@ -77,6 +72,11 @@ type GetColumnStatisticsForPartitionInput struct { // This member is required. PartitionValues []*string + // The name of the partitions' table. + // + // This member is required. + TableName *string + // The ID of the Data Catalog where the partitions in question reside. If none is // supplied, the AWS account ID is used by default. CatalogId *string diff --git a/service/glue/api_op_GetColumnStatisticsForTable.go b/service/glue/api_op_GetColumnStatisticsForTable.go index 32a9bbdbdfa..2ac8e72e590 100644 --- a/service/glue/api_op_GetColumnStatisticsForTable.go +++ b/service/glue/api_op_GetColumnStatisticsForTable.go @@ -57,20 +57,20 @@ func (c *Client) GetColumnStatisticsForTable(ctx context.Context, params *GetCol type GetColumnStatisticsForTableInput struct { - // The name of the partitions' table. + // A list of the column names. // // This member is required. - TableName *string + ColumnNames []*string // The name of the catalog database where the partitions reside. // // This member is required. DatabaseName *string - // A list of the column names. + // The name of the partitions' table. // // This member is required. - ColumnNames []*string + TableName *string // The ID of the Data Catalog where the partitions in question reside. If none is // supplied, the AWS account ID is used by default. @@ -80,10 +80,10 @@ type GetColumnStatisticsForTableInput struct { type GetColumnStatisticsForTableOutput struct { // List of ColumnStatistics that failed to be retrieved. - Errors []*types.ColumnError + ColumnStatisticsList []*types.ColumnStatistics // List of ColumnStatistics that failed to be retrieved. - ColumnStatisticsList []*types.ColumnStatistics + Errors []*types.ColumnError // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/glue/api_op_GetConnections.go b/service/glue/api_op_GetConnections.go index 68bc346ca60..85da3ee709d 100644 --- a/service/glue/api_op_GetConnections.go +++ b/service/glue/api_op_GetConnections.go @@ -56,6 +56,13 @@ func (c *Client) GetConnections(ctx context.Context, params *GetConnectionsInput type GetConnectionsInput struct { + // The ID of the Data Catalog in which the connections reside. If none is provided, + // the AWS account ID is used by default. + CatalogId *string + + // A filter that controls which connections are returned. + Filter *types.GetConnectionsFilter + // Allows you to retrieve the connection metadata without returning the password. // For instance, the AWS Glue console uses this flag to retrieve the connection, // and does not display the password. Set this parameter when the caller might not @@ -63,29 +70,22 @@ type GetConnectionsInput struct { // permission to access the rest of the connection properties. HidePassword *bool - // A continuation token, if this is a continuation call. - NextToken *string - // The maximum number of connections to return in one response. MaxResults *int32 - // A filter that controls which connections are returned. - Filter *types.GetConnectionsFilter - - // The ID of the Data Catalog in which the connections reside. If none is provided, - // the AWS account ID is used by default. - CatalogId *string + // A continuation token, if this is a continuation call. + NextToken *string } type GetConnectionsOutput struct { + // A list of requested connection definitions. + ConnectionList []*types.Connection + // A continuation token, if the list of connections returned does not include the // last of the filtered connections. NextToken *string - // A list of requested connection definitions. - ConnectionList []*types.Connection - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/glue/api_op_GetCrawlerMetrics.go b/service/glue/api_op_GetCrawlerMetrics.go index 53738d53c0f..19107929a59 100644 --- a/service/glue/api_op_GetCrawlerMetrics.go +++ b/service/glue/api_op_GetCrawlerMetrics.go @@ -68,13 +68,13 @@ type GetCrawlerMetricsInput struct { type GetCrawlerMetricsOutput struct { + // A list of metrics for the specified crawler. + CrawlerMetricsList []*types.CrawlerMetrics + // A continuation token, if the returned list does not contain the last metric // available. NextToken *string - // A list of metrics for the specified crawler. - CrawlerMetricsList []*types.CrawlerMetrics - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/glue/api_op_GetCrawlers.go b/service/glue/api_op_GetCrawlers.go index d27d3ae3c42..2f704798ff0 100644 --- a/service/glue/api_op_GetCrawlers.go +++ b/service/glue/api_op_GetCrawlers.go @@ -65,13 +65,13 @@ type GetCrawlersInput struct { type GetCrawlersOutput struct { + // A list of crawler metadata. + Crawlers []*types.Crawler + // A continuation token, if the returned list has not reached the end of those // defined in this customer account. NextToken *string - // A list of crawler metadata. - Crawlers []*types.Crawler - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/glue/api_op_GetDatabases.go b/service/glue/api_op_GetDatabases.go index 83316570099..4e2fb98bb7c 100644 --- a/service/glue/api_op_GetDatabases.go +++ b/service/glue/api_op_GetDatabases.go @@ -56,6 +56,13 @@ func (c *Client) GetDatabases(ctx context.Context, params *GetDatabasesInput, op type GetDatabasesInput struct { + // The ID of the Data Catalog from which to retrieve Databases. If none is + // provided, the AWS account ID is used by default. + CatalogId *string + + // The maximum number of databases to return in one response. + MaxResults *int32 + // A continuation token, if this is a continuation call. NextToken *string @@ -65,13 +72,6 @@ type GetDatabasesInput struct { //

  • If set to ALL, will list the databases shared with // your account, as well as the databases in yor local account.

    • ResourceShareType types.ResourceShareType - - // The maximum number of databases to return in one response. - MaxResults *int32 - - // The ID of the Data Catalog from which to retrieve Databases. If none is - // provided, the AWS account ID is used by default. - CatalogId *string } type GetDatabasesOutput struct { diff --git a/service/glue/api_op_GetJobRun.go b/service/glue/api_op_GetJobRun.go index 72f0addcf20..b2ab992e709 100644 --- a/service/glue/api_op_GetJobRun.go +++ b/service/glue/api_op_GetJobRun.go @@ -57,15 +57,15 @@ func (c *Client) GetJobRun(ctx context.Context, params *GetJobRunInput, optFns . type GetJobRunInput struct { - // The ID of the job run. + // Name of the job definition being run. // // This member is required. - RunId *string + JobName *string - // Name of the job definition being run. + // The ID of the job run. // // This member is required. - JobName *string + RunId *string // True if a list of predecessor runs should be returned. PredecessorsIncluded *bool diff --git a/service/glue/api_op_GetJobRuns.go b/service/glue/api_op_GetJobRuns.go index eb291cd7746..e019aef904f 100644 --- a/service/glue/api_op_GetJobRuns.go +++ b/service/glue/api_op_GetJobRuns.go @@ -71,12 +71,12 @@ type GetJobRunsInput struct { type GetJobRunsOutput struct { - // A continuation token, if not all requested job runs have been returned. - NextToken *string - // A list of job-run metadata objects. JobRuns []*types.JobRun + // A continuation token, if not all requested job runs have been returned. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/glue/api_op_GetJobs.go b/service/glue/api_op_GetJobs.go index 6cf2d91695b..b350a1bd6fc 100644 --- a/service/glue/api_op_GetJobs.go +++ b/service/glue/api_op_GetJobs.go @@ -56,11 +56,11 @@ func (c *Client) GetJobs(ctx context.Context, params *GetJobsInput, optFns ...fu type GetJobsInput struct { - // A continuation token, if this is a continuation call. - NextToken *string - // The maximum size of the response. MaxResults *int32 + + // A continuation token, if this is a continuation call. + NextToken *string } type GetJobsOutput struct { diff --git a/service/glue/api_op_GetMLTaskRun.go b/service/glue/api_op_GetMLTaskRun.go index e41a1da0f78..673e711c6b6 100644 --- a/service/glue/api_op_GetMLTaskRun.go +++ b/service/glue/api_op_GetMLTaskRun.go @@ -62,30 +62,27 @@ func (c *Client) GetMLTaskRun(ctx context.Context, params *GetMLTaskRunInput, op type GetMLTaskRunInput struct { - // The unique identifier of the machine learning transform. + // The unique identifier of the task run. // // This member is required. - TransformId *string + TaskRunId *string - // The unique identifier of the task run. + // The unique identifier of the machine learning transform. // // This member is required. - TaskRunId *string + TransformId *string } type GetMLTaskRunOutput struct { - // The amount of time (in seconds) that the task run consumed resources. - ExecutionTime *int32 - - // The status for this task run. - Status types.TaskStatusType + // The date and time when this task run was completed. + CompletedOn *time.Time - // The list of properties that are associated with the task run. - Properties *types.TaskRunProperties + // The error strings that are associated with the task run. + ErrorString *string - // The unique run identifier associated with this run. - TaskRunId *string + // The amount of time (in seconds) that the task run consumed resources. + ExecutionTime *int32 // The date and time when this task run was last modified. LastModifiedOn *time.Time @@ -93,18 +90,21 @@ type GetMLTaskRunOutput struct { // The names of the log groups that are associated with the task run. LogGroupName *string - // The date and time when this task run was completed. - CompletedOn *time.Time - - // The unique identifier of the task run. - TransformId *string - - // The error strings that are associated with the task run. - ErrorString *string + // The list of properties that are associated with the task run. + Properties *types.TaskRunProperties // The date and time when this task run started. StartedOn *time.Time + // The status for this task run. + Status types.TaskStatusType + + // The unique run identifier associated with this run. + TaskRunId *string + + // The unique identifier of the task run. + TransformId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/glue/api_op_GetMLTaskRuns.go b/service/glue/api_op_GetMLTaskRuns.go index 98f5d65a3e9..80b3208ff85 100644 --- a/service/glue/api_op_GetMLTaskRuns.go +++ b/service/glue/api_op_GetMLTaskRuns.go @@ -62,22 +62,22 @@ func (c *Client) GetMLTaskRuns(ctx context.Context, params *GetMLTaskRunsInput, type GetMLTaskRunsInput struct { - // The sorting criteria, in the TaskRunSortCriteria structure, for the task run. - Sort *types.TaskRunSortCriteria + // The unique identifier of the machine learning transform. + // + // This member is required. + TransformId *string - // A token for pagination of the results. The default is empty. - NextToken *string + // The filter criteria, in the TaskRunFilterCriteria structure, for the task run. + Filter *types.TaskRunFilterCriteria // The maximum number of results to return. MaxResults *int32 - // The filter criteria, in the TaskRunFilterCriteria structure, for the task run. - Filter *types.TaskRunFilterCriteria + // A token for pagination of the results. The default is empty. + NextToken *string - // The unique identifier of the machine learning transform. - // - // This member is required. - TransformId *string + // The sorting criteria, in the TaskRunSortCriteria structure, for the task run. + Sort *types.TaskRunSortCriteria } type GetMLTaskRunsOutput struct { diff --git a/service/glue/api_op_GetMLTransform.go b/service/glue/api_op_GetMLTransform.go index c2b5dbdff35..0f312e569e8 100644 --- a/service/glue/api_op_GetMLTransform.go +++ b/service/glue/api_op_GetMLTransform.go @@ -71,43 +71,14 @@ type GetMLTransformInput struct { type GetMLTransformOutput struct { - // The unique name given to the transform when it was created. - Name *string - - // The date and time when the transform was last modified. - LastModifiedOn *time.Time - - // The number of labels available for this transform. - LabelCount *int32 - // The date and time when the transform was created. CreatedOn *time.Time - // The configuration parameters that are specific to the algorithm used. - Parameters *types.TransformParameters - - // The maximum number of times to retry a task for this transform after a task run - // fails. - MaxRetries *int32 - - // The last known status of the transform (to indicate whether it can be used or - // not). One of "NOT_READY", "READY", or "DELETING". - Status types.TransformStatusType + // A description of the transform. + Description *string - // The type of predefined worker that is allocated when this task runs. Accepts a - // value of Standard, G.1X, or G.2X. - // - // * For the Standard worker type, each - // worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per - // worker. - // - // * For the G.1X worker type, each worker provides 4 vCPU, 16 GB of - // memory and a 64GB disk, and 1 executor per worker. - // - // * For the G.2X worker - // type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 - // executor per worker. - WorkerType types.WorkerType + // The latest evaluation metrics. + EvaluationMetrics *types.EvaluationMetrics // This value determines which version of AWS Glue this machine learning transform // is compatible with. Glue 1.0 is recommended for most customers. If the value is @@ -117,6 +88,15 @@ type GetMLTransformOutput struct { // in the developer guide. GlueVersion *string + // A list of AWS Glue table definitions used by the transform. + InputRecordTables []*types.GlueTable + + // The number of labels available for this transform. + LabelCount *int32 + + // The date and time when the transform was last modified. + LastModifiedOn *time.Time + // The number of AWS Glue data processing units (DPUs) that are allocated to task // runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. // A DPU is a relative measure of processing power that consists of 4 vCPUs of @@ -127,35 +107,55 @@ type GetMLTransformOutput struct { // and becomes read-only.

    MaxCapacity *float64 - // A description of the transform. - Description *string - - // The unique identifier of the transform, generated at the time that the transform - // was created. - TransformId *string + // The maximum number of times to retry a task for this transform after a task run + // fails. + MaxRetries *int32 - // A list of AWS Glue table definitions used by the transform. - InputRecordTables []*types.GlueTable + // The unique name given to the transform when it was created. + Name *string // The number of workers of a defined workerType that are allocated when this task // runs. NumberOfWorkers *int32 + // The configuration parameters that are specific to the algorithm used. + Parameters *types.TransformParameters + // The name or Amazon Resource Name (ARN) of the IAM role with the required // permissions. Role *string + // The Map object that represents the schema that this transform accepts. Has an + // upper bound of 100 columns. + Schema []*types.SchemaColumn + + // The last known status of the transform (to indicate whether it can be used or + // not). One of "NOT_READY", "READY", or "DELETING". + Status types.TransformStatusType + // The timeout for a task run for this transform in minutes. This is the maximum // time that a task run for this transform can consume resources before it is // terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). Timeout *int32 - // The Map object that represents the schema that this transform accepts. Has an - // upper bound of 100 columns. - Schema []*types.SchemaColumn + // The unique identifier of the transform, generated at the time that the transform + // was created. + TransformId *string - // The latest evaluation metrics. - EvaluationMetrics *types.EvaluationMetrics + // The type of predefined worker that is allocated when this task runs. Accepts a + // value of Standard, G.1X, or G.2X. + // + // * For the Standard worker type, each + // worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per + // worker. + // + // * For the G.1X worker type, each worker provides 4 vCPU, 16 GB of + // memory and a 64GB disk, and 1 executor per worker. + // + // * For the G.2X worker + // type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 + // executor per worker. + WorkerType types.WorkerType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/glue/api_op_GetMLTransforms.go b/service/glue/api_op_GetMLTransforms.go index ebbd2a553eb..973db1b3be6 100644 --- a/service/glue/api_op_GetMLTransforms.go +++ b/service/glue/api_op_GetMLTransforms.go @@ -61,12 +61,12 @@ func (c *Client) GetMLTransforms(ctx context.Context, params *GetMLTransformsInp type GetMLTransformsInput struct { - // The maximum number of results to return. - MaxResults *int32 - // The filter transformation criteria. Filter *types.TransformFilterCriteria + // The maximum number of results to return. + MaxResults *int32 + // A paginated token to offset the results. NextToken *string diff --git a/service/glue/api_op_GetMapping.go b/service/glue/api_op_GetMapping.go index 725d4706238..772336c2f31 100644 --- a/service/glue/api_op_GetMapping.go +++ b/service/glue/api_op_GetMapping.go @@ -57,9 +57,6 @@ func (c *Client) GetMapping(ctx context.Context, params *GetMappingInput, optFns type GetMappingInput struct { - // A list of target tables. - Sinks []*types.CatalogEntry - // Specifies the source table. // // This member is required. @@ -67,6 +64,9 @@ type GetMappingInput struct { // Parameters for the mapping. Location *types.Location + + // A list of target tables. + Sinks []*types.CatalogEntry } type GetMappingOutput struct { diff --git a/service/glue/api_op_GetPartition.go b/service/glue/api_op_GetPartition.go index 7e38a1fe5b6..90de9c4d0de 100644 --- a/service/glue/api_op_GetPartition.go +++ b/service/glue/api_op_GetPartition.go @@ -57,24 +57,24 @@ func (c *Client) GetPartition(ctx context.Context, params *GetPartitionInput, op type GetPartitionInput struct { - // The values that define the partition. + // The name of the catalog database where the partition resides. // // This member is required. - PartitionValues []*string - - // The ID of the Data Catalog where the partition in question resides. If none is - // provided, the AWS account ID is used by default. - CatalogId *string + DatabaseName *string - // The name of the catalog database where the partition resides. + // The values that define the partition. // // This member is required. - DatabaseName *string + PartitionValues []*string // The name of the partition's table. // // This member is required. TableName *string + + // The ID of the Data Catalog where the partition in question resides. If none is + // provided, the AWS account ID is used by default. + CatalogId *string } type GetPartitionOutput struct { diff --git a/service/glue/api_op_GetPartitions.go b/service/glue/api_op_GetPartitions.go index d27df7c66f9..0591ee12025 100644 --- a/service/glue/api_op_GetPartitions.go +++ b/service/glue/api_op_GetPartitions.go @@ -57,13 +57,6 @@ func (c *Client) GetPartitions(ctx context.Context, params *GetPartitionsInput, type GetPartitionsInput struct { - // A continuation token, if this is not the first call to retrieve these - // partitions. - NextToken *string - - // The segment of the table's partitions to scan in this request. - Segment *types.Segment - // The name of the catalog database where the partitions reside. // // This member is required. @@ -74,8 +67,9 @@ type GetPartitionsInput struct { // This member is required. TableName *string - // The maximum number of partitions to return in a single response. - MaxResults *int32 + // The ID of the Data Catalog where the partitions in question reside. If none is + // provided, the AWS account ID is used by default. + CatalogId *string // An expression that filters the partitions to be returned. The expression uses // SQL syntax similar to the SQL WHERE filter clause. The SQL statement parser @@ -123,9 +117,15 @@ type GetPartitionsInput struct { // compatible with the catalog partitions.

    Sample API Call:

    Expression *string - // The ID of the Data Catalog where the partitions in question reside. If none is - // provided, the AWS account ID is used by default. - CatalogId *string + // The maximum number of partitions to return in a single response. + MaxResults *int32 + + // A continuation token, if this is not the first call to retrieve these + // partitions. + NextToken *string + + // The segment of the table's partitions to scan in this request. + Segment *types.Segment } type GetPartitionsOutput struct { diff --git a/service/glue/api_op_GetPlan.go b/service/glue/api_op_GetPlan.go index 20085cf5e90..b1f75561186 100644 --- a/service/glue/api_op_GetPlan.go +++ b/service/glue/api_op_GetPlan.go @@ -62,19 +62,19 @@ type GetPlanInput struct { // This member is required. Mapping []*types.MappingEntry - // The programming language of the code to perform the mapping. - Language types.Language - - // The target tables. - Sinks []*types.CatalogEntry - // The source table. // // This member is required. Source *types.CatalogEntry + // The programming language of the code to perform the mapping. + Language types.Language + // The parameters for the mapping. Location *types.Location + + // The target tables. + Sinks []*types.CatalogEntry } type GetPlanOutput struct { diff --git a/service/glue/api_op_GetResourcePolicies.go b/service/glue/api_op_GetResourcePolicies.go index 9471910f60a..8f1bdaa250b 100644 --- a/service/glue/api_op_GetResourcePolicies.go +++ b/service/glue/api_op_GetResourcePolicies.go @@ -60,11 +60,11 @@ func (c *Client) GetResourcePolicies(ctx context.Context, params *GetResourcePol type GetResourcePoliciesInput struct { - // A continuation token, if this is a continuation request. - NextToken *string - // The maximum size of a list to return. MaxResults *int32 + + // A continuation token, if this is a continuation request. + NextToken *string } type GetResourcePoliciesOutput struct { diff --git a/service/glue/api_op_GetResourcePolicy.go b/service/glue/api_op_GetResourcePolicy.go index 1dfab58a030..3ebc6c1b2a2 100644 --- a/service/glue/api_op_GetResourcePolicy.go +++ b/service/glue/api_op_GetResourcePolicy.go @@ -65,17 +65,17 @@ type GetResourcePolicyInput struct { type GetResourcePolicyOutput struct { + // The date and time at which the policy was created. + CreateTime *time.Time + // Contains the hash value associated with this policy. PolicyHash *string - // The date and time at which the policy was last updated. - UpdateTime *time.Time - // Contains the requested policy document, in JSON format. PolicyInJson *string - // The date and time at which the policy was created. - CreateTime *time.Time + // The date and time at which the policy was last updated. + UpdateTime *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/glue/api_op_GetSecurityConfigurations.go b/service/glue/api_op_GetSecurityConfigurations.go index 83a8f2c27d7..393cb69d8b4 100644 --- a/service/glue/api_op_GetSecurityConfigurations.go +++ b/service/glue/api_op_GetSecurityConfigurations.go @@ -56,21 +56,21 @@ func (c *Client) GetSecurityConfigurations(ctx context.Context, params *GetSecur type GetSecurityConfigurationsInput struct { - // A continuation token, if this is a continuation call. - NextToken *string - // The maximum number of results to return. MaxResults *int32 + + // A continuation token, if this is a continuation call. + NextToken *string } type GetSecurityConfigurationsOutput struct { - // A list of security configurations. - SecurityConfigurations []*types.SecurityConfiguration - // A continuation token, if there are more security configurations to return. NextToken *string + // A list of security configurations. + SecurityConfigurations []*types.SecurityConfiguration + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/glue/api_op_GetTable.go b/service/glue/api_op_GetTable.go index a0f6c4c485c..2cd0018584f 100644 --- a/service/glue/api_op_GetTable.go +++ b/service/glue/api_op_GetTable.go @@ -57,21 +57,21 @@ func (c *Client) GetTable(ctx context.Context, params *GetTableInput, optFns ... type GetTableInput struct { - // The ID of the Data Catalog where the table resides. If none is provided, the AWS - // account ID is used by default. - CatalogId *string - - // The name of the table for which to retrieve the definition. For Hive + // The name of the database in the catalog in which the table resides. For Hive // compatibility, this name is entirely lowercase. // // This member is required. - Name *string + DatabaseName *string - // The name of the database in the catalog in which the table resides. For Hive + // The name of the table for which to retrieve the definition. For Hive // compatibility, this name is entirely lowercase. // // This member is required. - DatabaseName *string + Name *string + + // The ID of the Data Catalog where the table resides. If none is provided, the AWS + // account ID is used by default. + CatalogId *string } type GetTableOutput struct { diff --git a/service/glue/api_op_GetTableVersion.go b/service/glue/api_op_GetTableVersion.go index b8259ebc824..006c7cb7cdd 100644 --- a/service/glue/api_op_GetTableVersion.go +++ b/service/glue/api_op_GetTableVersion.go @@ -68,13 +68,13 @@ type GetTableVersionInput struct { // This member is required. TableName *string - // The ID value of the table version to be retrieved. A VersionID is a string - // representation of an integer. Each version is incremented by 1. - VersionId *string - // The ID of the Data Catalog where the tables reside. If none is provided, the AWS // account ID is used by default. CatalogId *string + + // The ID value of the table version to be retrieved. A VersionID is a string + // representation of an integer. Each version is incremented by 1. + VersionId *string } type GetTableVersionOutput struct { diff --git a/service/glue/api_op_GetTableVersions.go b/service/glue/api_op_GetTableVersions.go index d005051c4d1..333ddbc7106 100644 --- a/service/glue/api_op_GetTableVersions.go +++ b/service/glue/api_op_GetTableVersions.go @@ -58,13 +58,6 @@ func (c *Client) GetTableVersions(ctx context.Context, params *GetTableVersionsI type GetTableVersionsInput struct { - // The ID of the Data Catalog where the tables reside. If none is provided, the AWS - // account ID is used by default. - CatalogId *string - - // The maximum number of table versions to return in one response. - MaxResults *int32 - // The database in the catalog in which the table resides. For Hive compatibility, // this name is entirely lowercase. // @@ -76,6 +69,13 @@ type GetTableVersionsInput struct { // This member is required. TableName *string + // The ID of the Data Catalog where the tables reside. If none is provided, the AWS + // account ID is used by default. + CatalogId *string + + // The maximum number of table versions to return in one response. + MaxResults *int32 + // A continuation token, if this is not the first call. NextToken *string } diff --git a/service/glue/api_op_GetTables.go b/service/glue/api_op_GetTables.go index 236cb2d185a..a0f529e41f3 100644 --- a/service/glue/api_op_GetTables.go +++ b/service/glue/api_op_GetTables.go @@ -57,35 +57,35 @@ func (c *Client) GetTables(ctx context.Context, params *GetTablesInput, optFns . type GetTablesInput struct { - // The ID of the Data Catalog where the tables reside. If none is provided, the AWS - // account ID is used by default. - CatalogId *string - // The database in the catalog whose tables to list. For Hive compatibility, this // name is entirely lowercase. // // This member is required. DatabaseName *string - // A continuation token, included if this is a continuation call. - NextToken *string - - // The maximum number of tables to return in a single response. - MaxResults *int32 + // The ID of the Data Catalog where the tables reside. If none is provided, the AWS + // account ID is used by default. + CatalogId *string // A regular expression pattern. If present, only those tables whose names match // the pattern are returned. Expression *string + + // The maximum number of tables to return in a single response. + MaxResults *int32 + + // A continuation token, included if this is a continuation call. + NextToken *string } type GetTablesOutput struct { - // A list of the requested Table objects. - TableList []*types.Table - // A continuation token, present if the current list segment is not the last. NextToken *string + // A list of the requested Table objects. + TableList []*types.Table + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/glue/api_op_GetTriggers.go b/service/glue/api_op_GetTriggers.go index 86465af6dd6..ce8b1f5e881 100644 --- a/service/glue/api_op_GetTriggers.go +++ b/service/glue/api_op_GetTriggers.go @@ -69,12 +69,12 @@ type GetTriggersInput struct { type GetTriggersOutput struct { - // A list of triggers for the specified job. - Triggers []*types.Trigger - // A continuation token, if not all the requested triggers have yet been returned. NextToken *string + // A list of triggers for the specified job. + Triggers []*types.Trigger + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/glue/api_op_GetUserDefinedFunctions.go b/service/glue/api_op_GetUserDefinedFunctions.go index bcb3fb5ee1b..d210a0f73fd 100644 --- a/service/glue/api_op_GetUserDefinedFunctions.go +++ b/service/glue/api_op_GetUserDefinedFunctions.go @@ -57,36 +57,36 @@ func (c *Client) GetUserDefinedFunctions(ctx context.Context, params *GetUserDef type GetUserDefinedFunctionsInput struct { + // An optional function-name pattern string that filters the function definitions + // returned. + // + // This member is required. + Pattern *string + + // The ID of the Data Catalog where the functions to be retrieved are located. If + // none is provided, the AWS account ID is used by default. + CatalogId *string + // The name of the catalog database where the functions are located. If none is // provided, functions from all the databases across the catalog will be returned. DatabaseName *string - // A continuation token, if this is a continuation call. - NextToken *string - // The maximum number of functions to return in one response. MaxResults *int32 - // The ID of the Data Catalog where the functions to be retrieved are located. If - // none is provided, the AWS account ID is used by default. - CatalogId *string - - // An optional function-name pattern string that filters the function definitions - // returned. - // - // This member is required. - Pattern *string + // A continuation token, if this is a continuation call. + NextToken *string } type GetUserDefinedFunctionsOutput struct { - // A list of requested function definitions. - UserDefinedFunctions []*types.UserDefinedFunction - // A continuation token, if the list of functions returned does not include the // last requested function. NextToken *string + // A list of requested function definitions. + UserDefinedFunctions []*types.UserDefinedFunction + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/glue/api_op_GetWorkflow.go b/service/glue/api_op_GetWorkflow.go index 1ad66f14030..b94092fa114 100644 --- a/service/glue/api_op_GetWorkflow.go +++ b/service/glue/api_op_GetWorkflow.go @@ -57,14 +57,14 @@ func (c *Client) GetWorkflow(ctx context.Context, params *GetWorkflowInput, optF type GetWorkflowInput struct { - // Specifies whether to include a graph when returning the workflow resource - // metadata. - IncludeGraph *bool - // The name of the workflow to retrieve. // // This member is required. Name *string + + // Specifies whether to include a graph when returning the workflow resource + // metadata. + IncludeGraph *bool } type GetWorkflowOutput struct { diff --git a/service/glue/api_op_GetWorkflowRun.go b/service/glue/api_op_GetWorkflowRun.go index 5cefc8bff9f..8399099f23d 100644 --- a/service/glue/api_op_GetWorkflowRun.go +++ b/service/glue/api_op_GetWorkflowRun.go @@ -57,6 +57,11 @@ func (c *Client) GetWorkflowRun(ctx context.Context, params *GetWorkflowRunInput type GetWorkflowRunInput struct { + // Name of the workflow being run. + // + // This member is required. + Name *string + // The ID of the workflow run. // // This member is required. @@ -64,11 +69,6 @@ type GetWorkflowRunInput struct { // Specifies whether to include the workflow graph in response or not. IncludeGraph *bool - - // Name of the workflow being run. - // - // This member is required. - Name *string } type GetWorkflowRunOutput struct { diff --git a/service/glue/api_op_GetWorkflowRuns.go b/service/glue/api_op_GetWorkflowRuns.go index 881c03a83dc..c749d60fd89 100644 --- a/service/glue/api_op_GetWorkflowRuns.go +++ b/service/glue/api_op_GetWorkflowRuns.go @@ -62,14 +62,14 @@ type GetWorkflowRunsInput struct { // This member is required. Name *string - // The maximum size of the response. - NextToken *string - // Specifies whether to include the workflow graph in response or not. IncludeGraph *bool // The maximum number of workflow runs to be included in the response. MaxResults *int32 + + // The maximum size of the response. + NextToken *string } type GetWorkflowRunsOutput struct { diff --git a/service/glue/api_op_ListCrawlers.go b/service/glue/api_op_ListCrawlers.go index 85d008860f6..0acce227cc2 100644 --- a/service/glue/api_op_ListCrawlers.go +++ b/service/glue/api_op_ListCrawlers.go @@ -72,14 +72,14 @@ type ListCrawlersInput struct { type ListCrawlersOutput struct { - // A continuation token, if the returned list does not contain the last metric - // available. - NextToken *string - // The names of all crawlers in the account, or the crawlers with the specified // tags. CrawlerNames []*string + // A continuation token, if the returned list does not contain the last metric + // available. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/glue/api_op_ListDevEndpoints.go b/service/glue/api_op_ListDevEndpoints.go index f86ffcbc07f..0d64f88c979 100644 --- a/service/glue/api_op_ListDevEndpoints.go +++ b/service/glue/api_op_ListDevEndpoints.go @@ -63,11 +63,11 @@ type ListDevEndpointsInput struct { // The maximum size of a list to return. MaxResults *int32 - // Specifies to return only these tagged resources. - Tags map[string]*string - // A continuation token, if this is a continuation request. NextToken *string + + // Specifies to return only these tagged resources. + Tags map[string]*string } type ListDevEndpointsOutput struct { diff --git a/service/glue/api_op_ListJobs.go b/service/glue/api_op_ListJobs.go index a8a0ba29921..40be57219c2 100644 --- a/service/glue/api_op_ListJobs.go +++ b/service/glue/api_op_ListJobs.go @@ -60,14 +60,14 @@ func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ... type ListJobsInput struct { + // The maximum size of a list to return. + MaxResults *int32 + // A continuation token, if this is a continuation request. NextToken *string // Specifies to return only these tagged resources. Tags map[string]*string - - // The maximum size of a list to return. - MaxResults *int32 } type ListJobsOutput struct { diff --git a/service/glue/api_op_ListMLTransforms.go b/service/glue/api_op_ListMLTransforms.go index d3248b455a8..a2e52109915 100644 --- a/service/glue/api_op_ListMLTransforms.go +++ b/service/glue/api_op_ListMLTransforms.go @@ -67,14 +67,14 @@ type ListMLTransformsInput struct { // The maximum size of a list to return. MaxResults *int32 - // Specifies to return only these tagged resources. - Tags map[string]*string - // A continuation token, if this is a continuation request. NextToken *string // A TransformSortCriteria used to sort the machine learning transforms. Sort *types.TransformSortCriteria + + // Specifies to return only these tagged resources. + Tags map[string]*string } type ListMLTransformsOutput struct { diff --git a/service/glue/api_op_ListTriggers.go b/service/glue/api_op_ListTriggers.go index 315418966a2..97562c4da0a 100644 --- a/service/glue/api_op_ListTriggers.go +++ b/service/glue/api_op_ListTriggers.go @@ -67,23 +67,23 @@ type ListTriggersInput struct { // The maximum size of a list to return. MaxResults *int32 - // Specifies to return only these tagged resources. - Tags map[string]*string - // A continuation token, if this is a continuation request. NextToken *string + + // Specifies to return only these tagged resources. + Tags map[string]*string } type ListTriggersOutput struct { - // The names of all triggers in the account, or the triggers with the specified - // tags. - TriggerNames []*string - // A continuation token, if the returned list does not contain the last metric // available. NextToken *string + // The names of all triggers in the account, or the triggers with the specified + // tags. + TriggerNames []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/glue/api_op_PutResourcePolicy.go b/service/glue/api_op_PutResourcePolicy.go index 80d428648d0..33731d19880 100644 --- a/service/glue/api_op_PutResourcePolicy.go +++ b/service/glue/api_op_PutResourcePolicy.go @@ -57,10 +57,10 @@ func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolic type PutResourcePolicyInput struct { - // The hash value returned when the previous policy was set using - // PutResourcePolicy. Its purpose is to prevent concurrent modifications of a - // policy. Do not use this parameter if no previous policy has been set. - PolicyHashCondition *string + // Contains the policy document to set, in JSON format. + // + // This member is required. + PolicyInJson *string // Allows you to specify if you want to use both resource-level and // account/catalog-level resource policies. A resource-level policy is a policy @@ -71,16 +71,16 @@ type PutResourcePolicyInput struct { // allowed.

    EnableHybrid types.EnableHybridValues - // Contains the policy document to set, in JSON format. - // - // This member is required. - PolicyInJson *string - // A value of MUST_EXIST is used to update a policy. A value of NOT_EXIST is used // to create a new policy. If a value of NONE or a null value is used, the call // will not depend on the existence of a policy. PolicyExistsCondition types.ExistCondition + // The hash value returned when the previous policy was set using + // PutResourcePolicy. Its purpose is to prevent concurrent modifications of a + // policy. Do not use this parameter if no previous policy has been set. + PolicyHashCondition *string + // The ARN of the AWS Glue resource for the resource policy to be set. For more // information about AWS Glue resource ARNs, see the AWS Glue ARN string pattern // (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-common.html#aws-glue-api-regex-aws-glue-arn-id) diff --git a/service/glue/api_op_ResetJobBookmark.go b/service/glue/api_op_ResetJobBookmark.go index a317de6bfd7..b808232d7de 100644 --- a/service/glue/api_op_ResetJobBookmark.go +++ b/service/glue/api_op_ResetJobBookmark.go @@ -57,13 +57,13 @@ func (c *Client) ResetJobBookmark(ctx context.Context, params *ResetJobBookmarkI type ResetJobBookmarkInput struct { - // The unique run identifier associated with this job run. - RunId *string - // The name of the job in question. // // This member is required. JobName *string + + // The unique run identifier associated with this job run. + RunId *string } type ResetJobBookmarkOutput struct { diff --git a/service/glue/api_op_ResumeWorkflowRun.go b/service/glue/api_op_ResumeWorkflowRun.go index 68b957bc0da..d0482cb6ade 100644 --- a/service/glue/api_op_ResumeWorkflowRun.go +++ b/service/glue/api_op_ResumeWorkflowRun.go @@ -61,16 +61,16 @@ type ResumeWorkflowRunInput struct { // This member is required. Name *string - // The ID of the workflow run to resume. - // - // This member is required. - RunId *string - // A list of the node IDs for the nodes you want to restart. The nodes that are to // be restarted must have an execution attempt in the original run. // // This member is required. NodeIds []*string + + // The ID of the workflow run to resume. + // + // This member is required. + RunId *string } type ResumeWorkflowRunOutput struct { diff --git a/service/glue/api_op_SearchTables.go b/service/glue/api_op_SearchTables.go index 63da9eebbeb..2fe6eacc940 100644 --- a/service/glue/api_op_SearchTables.go +++ b/service/glue/api_op_SearchTables.go @@ -64,9 +64,8 @@ func (c *Client) SearchTables(ctx context.Context, params *SearchTablesInput, op type SearchTablesInput struct { - // A list of criteria for sorting the results by a field name, in an ascending or - // descending order. - SortCriteria []*types.SortCriterion + // A unique identifier, consisting of account_id . + CatalogId *string // A list of key-value pairs, and a comparator used to filter the search results. // Returns all entities matching the predicate.

    The Comparator @@ -82,8 +81,11 @@ type SearchTablesInput struct { // returned.

    Filters []*types.PropertyPredicate - // A unique identifier, consisting of account_id . - CatalogId *string + // The maximum number of tables to return in a single response. + MaxResults *int32 + + // A continuation token, included if this is a continuation call. + NextToken *string // Allows you to specify that you want to search the tables shared with your // account. The allowable values are FOREIGN or ALL. ResourceShareType types.ResourceShareType - // The maximum number of tables to return in a single response. - MaxResults *int32 - - // A continuation token, included if this is a continuation call. - NextToken *string - // A string used for a text search. Specifying a value in quotes filters based on // an exact match to the value. SearchText *string + + // A list of criteria for sorting the results by a field name, in an ascending or + // descending order. + SortCriteria []*types.SortCriterion } type SearchTablesOutput struct { diff --git a/service/glue/api_op_StartImportLabelsTaskRun.go b/service/glue/api_op_StartImportLabelsTaskRun.go index 4f3d5dc58ca..a103bdcfb4d 100644 --- a/service/glue/api_op_StartImportLabelsTaskRun.go +++ b/service/glue/api_op_StartImportLabelsTaskRun.go @@ -79,9 +79,6 @@ func (c *Client) StartImportLabelsTaskRun(ctx context.Context, params *StartImpo type StartImportLabelsTaskRunInput struct { - // Indicates whether to overwrite your existing labels. - ReplaceAllLabels *bool - // The Amazon Simple Storage Service (Amazon S3) path from where you import the // labels. // @@ -92,6 +89,9 @@ type StartImportLabelsTaskRunInput struct { // // This member is required. TransformId *string + + // Indicates whether to overwrite your existing labels. + ReplaceAllLabels *bool } type StartImportLabelsTaskRunOutput struct { diff --git a/service/glue/api_op_StartJobRun.go b/service/glue/api_op_StartJobRun.go index b230279c35b..9311b06712d 100644 --- a/service/glue/api_op_StartJobRun.go +++ b/service/glue/api_op_StartJobRun.go @@ -62,18 +62,6 @@ type StartJobRunInput struct { // This member is required. JobName *string - // The ID of a previous JobRun to retry. - JobRunId *string - - // The name of the SecurityConfiguration structure to be used with this job run. - SecurityConfiguration *string - - // The JobRun timeout in minutes. This is the maximum time that a job run can - // consume resources before it is terminated and enters TIMEOUT status. The default - // is 2,880 minutes (48 hours). This overrides the timeout value set in the parent - // job. - Timeout *int32 - // This field is deprecated. Use MaxCapacity instead.

    The number of AWS Glue // data processing units (DPUs) to allocate to this JobRun. From 2 to 100 DPUs can // be allocated; the default is 10. A DPU is a relative measure of processing power @@ -95,6 +83,9 @@ type StartJobRunInput struct { // topic in the developer guide. Arguments map[string]*string + // The ID of a previous JobRun to retry. + JobRunId *string + // The number of AWS Glue data processing units (DPUs) that can be allocated when // this job runs. A DPU is a relative measure of processing power that consists of // 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the @@ -114,6 +105,20 @@ type StartJobRunInput struct { // Specifies configuration properties of a job run notification. NotificationProperty *types.NotificationProperty + // The number of workers of a defined workerType that are allocated when a job + // runs.

    The maximum number of workers you can define are 299 for + // G.1X, and 149 for G.2X.

    + NumberOfWorkers *int32 + + // The name of the SecurityConfiguration structure to be used with this job run. + SecurityConfiguration *string + + // The JobRun timeout in minutes. This is the maximum time that a job run can + // consume resources before it is terminated and enters TIMEOUT status. The default + // is 2,880 minutes (48 hours). This overrides the timeout value set in the parent + // job. + Timeout *int32 + // The type of predefined worker that is allocated when a job runs. Accepts a value // of Standard, G.1X, or G.2X. // @@ -128,11 +133,6 @@ type StartJobRunInput struct { // worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per // worker. WorkerType types.WorkerType - - // The number of workers of a defined workerType that are allocated when a job - // runs.

    The maximum number of workers you can define are 299 for - // G.1X, and 149 for G.2X.

    - NumberOfWorkers *int32 } type StartJobRunOutput struct { diff --git a/service/glue/api_op_StartMLLabelingSetGenerationTaskRun.go b/service/glue/api_op_StartMLLabelingSetGenerationTaskRun.go index a0773fbb5ab..5699be235f8 100644 --- a/service/glue/api_op_StartMLLabelingSetGenerationTaskRun.go +++ b/service/glue/api_op_StartMLLabelingSetGenerationTaskRun.go @@ -67,16 +67,16 @@ func (c *Client) StartMLLabelingSetGenerationTaskRun(ctx context.Context, params type StartMLLabelingSetGenerationTaskRunInput struct { - // The unique identifier of the machine learning transform. - // - // This member is required. - TransformId *string - // The Amazon Simple Storage Service (Amazon S3) path where you generate the // labeling set. // // This member is required. OutputS3Path *string + + // The unique identifier of the machine learning transform. + // + // This member is required. + TransformId *string } type StartMLLabelingSetGenerationTaskRunOutput struct { diff --git a/service/glue/api_op_StopWorkflowRun.go b/service/glue/api_op_StopWorkflowRun.go index 859be3bc90d..66b153e06e1 100644 --- a/service/glue/api_op_StopWorkflowRun.go +++ b/service/glue/api_op_StopWorkflowRun.go @@ -56,15 +56,15 @@ func (c *Client) StopWorkflowRun(ctx context.Context, params *StopWorkflowRunInp type StopWorkflowRunInput struct { - // The ID of the workflow run to stop. + // The name of the workflow to stop. // // This member is required. - RunId *string + Name *string - // The name of the workflow to stop. + // The ID of the workflow run to stop. // // This member is required. - Name *string + RunId *string } type StopWorkflowRunOutput struct { diff --git a/service/glue/api_op_TagResource.go b/service/glue/api_op_TagResource.go index 1c04f059c92..50949fc1442 100644 --- a/service/glue/api_op_TagResource.go +++ b/service/glue/api_op_TagResource.go @@ -59,17 +59,17 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // Tags to add to this resource. - // - // This member is required. - TagsToAdd map[string]*string - // The ARN of the AWS Glue resource to which to add the tags. For more information // about AWS Glue resource ARNs, see the AWS Glue ARN string pattern // (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-common.html#aws-glue-api-regex-aws-glue-arn-id). // // This member is required. ResourceArn *string + + // Tags to add to this resource. + // + // This member is required. + TagsToAdd map[string]*string } type TagResourceOutput struct { diff --git a/service/glue/api_op_UntagResource.go b/service/glue/api_op_UntagResource.go index 252a72a775c..3a59ec13ba0 100644 --- a/service/glue/api_op_UntagResource.go +++ b/service/glue/api_op_UntagResource.go @@ -56,15 +56,15 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // Tags to remove from this resource. + // The Amazon Resource Name (ARN) of the resource from which to remove the tags. // // This member is required. - TagsToRemove []*string + ResourceArn *string - // The Amazon Resource Name (ARN) of the resource from which to remove the tags. + // Tags to remove from this resource. // // This member is required. - ResourceArn *string + TagsToRemove []*string } type UntagResourceOutput struct { diff --git a/service/glue/api_op_UpdateClassifier.go b/service/glue/api_op_UpdateClassifier.go index 800b70a061d..7e190dd1349 100644 --- a/service/glue/api_op_UpdateClassifier.go +++ b/service/glue/api_op_UpdateClassifier.go @@ -58,17 +58,17 @@ func (c *Client) UpdateClassifier(ctx context.Context, params *UpdateClassifierI type UpdateClassifierInput struct { - // A GrokClassifier object with updated fields. - GrokClassifier *types.UpdateGrokClassifierRequest - // A CsvClassifier object with updated fields. CsvClassifier *types.UpdateCsvClassifierRequest - // An XMLClassifier object with updated fields. - XMLClassifier *types.UpdateXMLClassifierRequest + // A GrokClassifier object with updated fields. + GrokClassifier *types.UpdateGrokClassifierRequest // A JsonClassifier object with updated fields. JsonClassifier *types.UpdateJsonClassifierRequest + + // An XMLClassifier object with updated fields. + XMLClassifier *types.UpdateXMLClassifierRequest } type UpdateClassifierOutput struct { diff --git a/service/glue/api_op_UpdateColumnStatisticsForPartition.go b/service/glue/api_op_UpdateColumnStatisticsForPartition.go index cc4702a545e..6826da01fa4 100644 --- a/service/glue/api_op_UpdateColumnStatisticsForPartition.go +++ b/service/glue/api_op_UpdateColumnStatisticsForPartition.go @@ -57,19 +57,15 @@ func (c *Client) UpdateColumnStatisticsForPartition(ctx context.Context, params type UpdateColumnStatisticsForPartitionInput struct { - // The name of the catalog database where the partitions reside. - // - // This member is required. - DatabaseName *string - // A list of the column statistics. // // This member is required. ColumnStatisticsList []*types.ColumnStatistics - // The ID of the Data Catalog where the partitions in question reside. If none is - // supplied, the AWS account ID is used by default. - CatalogId *string + // The name of the catalog database where the partitions reside. + // + // This member is required. + DatabaseName *string // A list of partition values identifying the partition. // @@ -80,6 +76,10 @@ type UpdateColumnStatisticsForPartitionInput struct { // // This member is required. TableName *string + + // The ID of the Data Catalog where the partitions in question reside. If none is + // supplied, the AWS account ID is used by default. + CatalogId *string } type UpdateColumnStatisticsForPartitionOutput struct { diff --git a/service/glue/api_op_UpdateColumnStatisticsForTable.go b/service/glue/api_op_UpdateColumnStatisticsForTable.go index bce41099ec2..1f6b09e5ddd 100644 --- a/service/glue/api_op_UpdateColumnStatisticsForTable.go +++ b/service/glue/api_op_UpdateColumnStatisticsForTable.go @@ -57,24 +57,24 @@ func (c *Client) UpdateColumnStatisticsForTable(ctx context.Context, params *Upd type UpdateColumnStatisticsForTableInput struct { + // A list of the column statistics. + // + // This member is required. + ColumnStatisticsList []*types.ColumnStatistics + // The name of the catalog database where the partitions reside. // // This member is required. DatabaseName *string - // The ID of the Data Catalog where the partitions in question reside. If none is - // supplied, the AWS account ID is used by default. - CatalogId *string - // The name of the partitions' table. // // This member is required. TableName *string - // A list of the column statistics. - // - // This member is required. - ColumnStatisticsList []*types.ColumnStatistics + // The ID of the Data Catalog where the partitions in question reside. If none is + // supplied, the AWS account ID is used by default. + CatalogId *string } type UpdateColumnStatisticsForTableOutput struct { diff --git a/service/glue/api_op_UpdateConnection.go b/service/glue/api_op_UpdateConnection.go index b023194a634..d0a7feec7b5 100644 --- a/service/glue/api_op_UpdateConnection.go +++ b/service/glue/api_op_UpdateConnection.go @@ -57,19 +57,19 @@ func (c *Client) UpdateConnection(ctx context.Context, params *UpdateConnectionI type UpdateConnectionInput struct { - // The ID of the Data Catalog in which the connection resides. If none is provided, - // the AWS account ID is used by default. - CatalogId *string + // A ConnectionInput object that redefines the connection in question. + // + // This member is required. + ConnectionInput *types.ConnectionInput // The name of the connection definition to update. // // This member is required. Name *string - // A ConnectionInput object that redefines the connection in question. - // - // This member is required. - ConnectionInput *types.ConnectionInput + // The ID of the Data Catalog in which the connection resides. If none is provided, + // the AWS account ID is used by default. + CatalogId *string } type UpdateConnectionOutput struct { diff --git a/service/glue/api_op_UpdateCrawler.go b/service/glue/api_op_UpdateCrawler.go index 536768340e3..b945053513d 100644 --- a/service/glue/api_op_UpdateCrawler.go +++ b/service/glue/api_op_UpdateCrawler.go @@ -58,26 +58,24 @@ func (c *Client) UpdateCrawler(ctx context.Context, params *UpdateCrawlerInput, type UpdateCrawlerInput struct { - // The name of the SecurityConfiguration structure to be used by this crawler. - CrawlerSecurityConfiguration *string - // Name of the new crawler. // // This member is required. Name *string - // A cron expression used to specify the schedule (see Time-Based Schedules for - // Jobs and Crawlers - // (https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). - // For example, to run something every day at 12:15 UTC, you would specify: cron(15 - // 12 * * ? *). - Schedule *string + // A list of custom classifiers that the user has registered. By default, all + // built-in classifiers are included in a crawl, but these custom classifiers + // always override the default classifiers for a given classification. + Classifiers []*string // Crawler configuration information. This versioned JSON string allows users to // specify aspects of a crawler's behavior. For more information, see Configuring a // Crawler (https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html). Configuration *string + // The name of the SecurityConfiguration structure to be used by this crawler. + CrawlerSecurityConfiguration *string + // The AWS Glue database where results are stored, such as: // arn:aws:daylight:us-east-1::database/sometable/*. DatabaseName *string @@ -85,23 +83,25 @@ type UpdateCrawlerInput struct { // A description of the new crawler. Description *string - // A list of custom classifiers that the user has registered. By default, all - // built-in classifiers are included in a crawl, but these custom classifiers - // always override the default classifiers for a given classification. - Classifiers []*string - - // The table prefix used for catalog tables that are created. - TablePrefix *string - - // A list of targets to crawl. - Targets *types.CrawlerTargets - // The IAM role or Amazon Resource Name (ARN) of an IAM role that is used by the // new crawler to access customer resources. Role *string + // A cron expression used to specify the schedule (see Time-Based Schedules for + // Jobs and Crawlers + // (https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). + // For example, to run something every day at 12:15 UTC, you would specify: cron(15 + // 12 * * ? *). + Schedule *string + // The policy for the crawler's update and deletion behavior. SchemaChangePolicy *types.SchemaChangePolicy + + // The table prefix used for catalog tables that are created. + TablePrefix *string + + // A list of targets to crawl. + Targets *types.CrawlerTargets } type UpdateCrawlerOutput struct { diff --git a/service/glue/api_op_UpdateDatabase.go b/service/glue/api_op_UpdateDatabase.go index 7653c396e7e..12e41bec5d5 100644 --- a/service/glue/api_op_UpdateDatabase.go +++ b/service/glue/api_op_UpdateDatabase.go @@ -57,10 +57,6 @@ func (c *Client) UpdateDatabase(ctx context.Context, params *UpdateDatabaseInput type UpdateDatabaseInput struct { - // The ID of the Data Catalog in which the metadata database resides. If none is - // provided, the AWS account ID is used by default. - CatalogId *string - // A DatabaseInput object specifying the new definition of the metadata database in // the catalog. // @@ -72,6 +68,10 @@ type UpdateDatabaseInput struct { // // This member is required. Name *string + + // The ID of the Data Catalog in which the metadata database resides. If none is + // provided, the AWS account ID is used by default. + CatalogId *string } type UpdateDatabaseOutput struct { diff --git a/service/glue/api_op_UpdateDevEndpoint.go b/service/glue/api_op_UpdateDevEndpoint.go index 885eef9bd1c..ab4ca49ad1e 100644 --- a/service/glue/api_op_UpdateDevEndpoint.go +++ b/service/glue/api_op_UpdateDevEndpoint.go @@ -62,19 +62,6 @@ type UpdateDevEndpointInput struct { // This member is required. EndpointName *string - // The list of public keys to be deleted from the DevEndpoint. - DeletePublicKeys []*string - - // The list of argument keys to be deleted from the map of arguments used to - // configure the DevEndpoint. - DeleteArguments []*string - - // The list of public keys for the DevEndpoint to use. - AddPublicKeys []*string - - // The public key for the DevEndpoint to use. - PublicKey *string - // The map of arguments to add the map of arguments used to configure the // DevEndpoint.

    Valid arguments are:

    MaxCapacity *float64 - // Non-overridable arguments for this job, specified as name-value pairs. - NonOverridableArguments map[string]*string - // The maximum number of times to retry this job after a JobRun fails. MaxRetries *int32 - // An ExecutionProperty specifying the maximum number of concurrent runs allowed - // for this job. - ExecutionProperty *ExecutionProperty + // The name you assign to this job definition. + Name *string - // The last point in time when this job definition was modified. - LastModifiedOn *time.Time + // Non-overridable arguments for this job, specified as name-value pairs. + NonOverridableArguments map[string]*string - // The default arguments for this job, specified as name-value pairs. You can - // specify arguments here that your own job-execution script consumes, as well as - // arguments that AWS Glue itself consumes. For information about how to specify - // and consume your own Job arguments, see the Calling AWS Glue APIs in Python - // (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) - // topic in the developer guide. For information about the key-value pairs that AWS - // Glue consumes to set up your job, see the Special Parameters Used by AWS Glue - // (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) - // topic in the developer guide. - DefaultArguments map[string]*string + // Specifies configuration properties of a job notification. + NotificationProperty *NotificationProperty + + // The number of workers of a defined workerType that are allocated when a job + // runs.

    The maximum number of workers you can define are 299 for + // G.1X, and 149 for G.2X.

    + NumberOfWorkers *int32 // The name or Amazon Resource Name (ARN) of the IAM role associated with this job. Role *string - // A description of the job. - Description *string + // The name of the SecurityConfiguration structure to be used with this job. + SecurityConfiguration *string + + // The job timeout in minutes. This is the maximum time that a job run can consume + // resources before it is terminated and enters TIMEOUT status. The default is + // 2,880 minutes (48 hours). + Timeout *int32 + + // The type of predefined worker that is allocated when a job runs. Accepts a value + // of Standard, G.1X, or G.2X. + // + // * For the Standard worker type, each worker + // provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. + // + // + // * For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, + // 64 GB disk), and provides 1 executor per worker. We recommend this worker type + // for memory-intensive jobs. + // + // * For the G.2X worker type, each worker maps to + // 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per + // worker. We recommend this worker type for memory-intensive jobs. + WorkerType WorkerType } // Defines a point that a job can resume processing. type JobBookmarkEntry struct { + // The attempt ID number. + Attempt *int32 + // The bookmark itself. JobBookmark *string + // The name of the job in question. + JobName *string + + // The unique run identifier associated with the previous job run. + PreviousRunId *string + // The run ID number. Run *int32 // The run ID number. RunId *string - // The name of the job in question. - JobName *string - // The version of the job. Version *int32 - - // The unique run identifier associated with the previous job run. - PreviousRunId *string - - // The attempt ID number. - Attempt *int32 } // Specifies how job bookmark data should be encrypted. @@ -1603,13 +1603,13 @@ type JobCommand struct { // ETL job, this must be gluestreaming. Name *string - // Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that - // executes a job. - ScriptLocation *string - // The Python version being used to execute a Python shell job. Allowed values are // 2 or 3. PythonVersion *string + + // Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that + // executes a job. + ScriptLocation *string } // The details of a Job node present in the workflow. @@ -1622,9 +1622,38 @@ type JobNodeDetails struct { // Contains information about a job run. type JobRun struct { + // This field is deprecated. Use MaxCapacity instead.

    The number of AWS Glue + // data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be + // allocated; the default is 10. A DPU is a relative measure of processing power + // that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more + // information, see the AWS Glue + // pricing page.

    + AllocatedCapacity *int32 + + // The job arguments associated with this run. For this job run, they replace the + // default arguments set in the job definition itself. You can specify arguments + // here that your own job-execution script consumes, as well as arguments that AWS + // Glue itself consumes. For information about how to specify and consume your own + // job arguments, see the Calling AWS Glue APIs in Python + // (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) + // topic in the developer guide. For information about the key-value pairs that AWS + // Glue consumes to set up your job, see the Special Parameters Used by AWS Glue + // (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) + // topic in the developer guide. + Arguments map[string]*string + // The number of the attempt to run this job. Attempt *int32 + // The date and time that this job run completed. + CompletedOn *time.Time + + // An error message associated with this job run. + ErrorMessage *string + + // The amount of time (in seconds) that the job run consumed resources. + ExecutionTime *int32 + // Glue version determines the versions of Apache Spark and Python that AWS Glue // supports. The Python version indicates the version supported for jobs of type // Spark.

    For more information about the available AWS Glue versions and @@ -1634,33 +1663,25 @@ type JobRun struct { // version default to Glue 0.9.

    GlueVersion *string - // The date and time at which this job run was started. - StartedOn *time.Time - - // The number of workers of a defined workerType that are allocated when a job - // runs.

    The maximum number of workers you can define are 299 for - // G.1X, and 149 for G.2X.

    - NumberOfWorkers *int32 + // The ID of this job run. + Id *string - // The amount of time (in seconds) that the job run consumed resources. - ExecutionTime *int32 + // The name of the job definition being used in this run. + JobName *string - // This field is deprecated. Use MaxCapacity instead.

    The number of AWS Glue - // data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be - // allocated; the default is 10. A DPU is a relative measure of processing power - // that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more - // information, see the AWS Glue - // pricing page.

    - AllocatedCapacity *int32 + // The current state of the job run. + JobRunState JobRunState - // A list of predecessors to this job run. - PredecessorRuns []*Predecessor + // The last time that this job run was modified. + LastModifiedOn *time.Time - // The JobRun timeout in minutes. This is the maximum time that a job run can - // consume resources before it is terminated and enters TIMEOUT status. The default - // is 2,880 minutes (48 hours). This overrides the timeout value set in the parent - // job. - Timeout *int32 + // The name of the log group for secure logging that can be server-side encrypted + // in Amazon CloudWatch using AWS KMS. This name can be /aws-glue/jobs/, in which + // case the default encryption is NONE. If you add a role name and + // SecurityConfiguration name (in other words, + // /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/), then that security + // configuration is used to encrypt the log group. + LogGroupName *string // The number of AWS Glue data processing units (DPUs) that can be allocated when // this job runs. A DPU is a relative measure of processing power that consists of @@ -1678,8 +1699,35 @@ type JobRun struct { // allocation.

    MaxCapacity *float64 - // The current state of the job run. - JobRunState JobRunState + // Specifies configuration properties of a job run notification. + NotificationProperty *NotificationProperty + + // The number of workers of a defined workerType that are allocated when a job + // runs.

    The maximum number of workers you can define are 299 for + // G.1X, and 149 for G.2X.

    + NumberOfWorkers *int32 + + // A list of predecessors to this job run. + PredecessorRuns []*Predecessor + + // The ID of the previous run of this job. For example, the JobRunId specified in + // the StartJobRun action. + PreviousRunId *string + + // The name of the SecurityConfiguration structure to be used with this job run. + SecurityConfiguration *string + + // The date and time at which this job run was started. + StartedOn *time.Time + + // The JobRun timeout in minutes. This is the maximum time that a job run can + // consume resources before it is terminated and enters TIMEOUT status. The default + // is 2,880 minutes (48 hours). This overrides the timeout value set in the parent + // job. + Timeout *int32 + + // The name of the trigger that started this job run. + TriggerName *string // The type of predefined worker that is allocated when a job runs. Accepts a value // of Standard, G.1X, or G.2X. @@ -1695,64 +1743,12 @@ type JobRun struct { // worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per // worker. WorkerType WorkerType - - // An error message associated with this job run. - ErrorMessage *string - - // The name of the log group for secure logging that can be server-side encrypted - // in Amazon CloudWatch using AWS KMS. This name can be /aws-glue/jobs/, in which - // case the default encryption is NONE. If you add a role name and - // SecurityConfiguration name (in other words, - // /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/), then that security - // configuration is used to encrypt the log group. - LogGroupName *string - - // The name of the SecurityConfiguration structure to be used with this job run. - SecurityConfiguration *string - - // The date and time that this job run completed. - CompletedOn *time.Time - - // The name of the job definition being used in this run. - JobName *string - - // The ID of this job run. - Id *string - - // The ID of the previous run of this job. For example, the JobRunId specified in - // the StartJobRun action. - PreviousRunId *string - - // Specifies configuration properties of a job run notification. - NotificationProperty *NotificationProperty - - // The last time that this job run was modified. - LastModifiedOn *time.Time - - // The job arguments associated with this run. For this job run, they replace the - // default arguments set in the job definition itself. You can specify arguments - // here that your own job-execution script consumes, as well as arguments that AWS - // Glue itself consumes. For information about how to specify and consume your own - // job arguments, see the Calling AWS Glue APIs in Python - // (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) - // topic in the developer guide. For information about the key-value pairs that AWS - // Glue consumes to set up your job, see the Special Parameters Used by AWS Glue - // (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) - // topic in the developer guide. - Arguments map[string]*string - - // The name of the trigger that started this job run. - TriggerName *string } // Specifies information used to update an existing job definition. The previous // job definition is completely overwritten by this information. type JobUpdate struct { - // An ExecutionProperty specifying the maximum number of concurrent runs allowed - // for this job. - ExecutionProperty *ExecutionProperty - // This field is deprecated. Use MaxCapacity instead.

    The number of AWS Glue // data processing units (DPUs) to allocate to this job. You can allocate from 2 to // 100 DPUs; the default is 10. A DPU is a relative measure of processing power @@ -1761,28 +1757,11 @@ type JobUpdate struct { // pricing page.

    AllocatedCapacity *int32 - // The job timeout in minutes. This is the maximum time that a job run can consume - // resources before it is terminated and enters TIMEOUT status. The default is - // 2,880 minutes (48 hours). - Timeout *int32 - - // The connections used for this job. - Connections *ConnectionsList - - // Specifies the configuration properties of a job notification. - NotificationProperty *NotificationProperty - // The JobCommand that executes this job (required). Command *JobCommand - // The name of the SecurityConfiguration structure to be used with this job. - SecurityConfiguration *string - - // This field is reserved for future use. - LogUri *string - - // Non-overridable arguments for this job, specified as name-value pairs. - NonOverridableArguments map[string]*string + // The connections used for this job. + Connections *ConnectionsList // The default arguments for this job. You can specify arguments here that your own // job-execution script consumes, as well as arguments that AWS Glue itself @@ -1795,8 +1774,12 @@ type JobUpdate struct { // topic in the developer guide. DefaultArguments map[string]*string - // The maximum number of times to retry this job if it fails. - MaxRetries *int32 + // Description of the job being defined. + Description *string + + // An ExecutionProperty specifying the maximum number of concurrent runs allowed + // for this job. + ExecutionProperty *ExecutionProperty // Glue version determines the versions of Apache Spark and Python that AWS Glue // supports. The Python version indicates the version supported for jobs of type @@ -1806,24 +1789,8 @@ type JobUpdate struct { // in the developer guide.

    GlueVersion *string - // The type of predefined worker that is allocated when a job runs. Accepts a value - // of Standard, G.1X, or G.2X. - // - // * For the Standard worker type, each worker - // provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. - // - // - // * For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, - // 64 GB disk), and provides 1 executor per worker. We recommend this worker type - // for memory-intensive jobs. - // - // * For the G.2X worker type, each worker maps to - // 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per - // worker. We recommend this worker type for memory-intensive jobs. - WorkerType WorkerType - - // Description of the job being defined. - Description *string + // This field is reserved for future use. + LogUri *string // The number of AWS Glue data processing units (DPUs) that can be allocated when // this job runs. A DPU is a relative measure of processing power that consists of @@ -1841,6 +1808,15 @@ type JobUpdate struct { // allocation.

    MaxCapacity *float64 + // The maximum number of times to retry this job if it fails. + MaxRetries *int32 + + // Non-overridable arguments for this job, specified as name-value pairs. + NonOverridableArguments map[string]*string + + // Specifies the configuration properties of a job notification. + NotificationProperty *NotificationProperty + // The number of workers of a defined workerType that are allocated when a job // runs.

    The maximum number of workers you can define are 299 for // G.1X, and 149 for G.2X.

    @@ -1849,6 +1825,30 @@ type JobUpdate struct { // The name or Amazon Resource Name (ARN) of the IAM role associated with this job // (required). Role *string + + // The name of the SecurityConfiguration structure to be used with this job. + SecurityConfiguration *string + + // The job timeout in minutes. This is the maximum time that a job run can consume + // resources before it is terminated and enters TIMEOUT status. The default is + // 2,880 minutes (48 hours). + Timeout *int32 + + // The type of predefined worker that is allocated when a job runs. Accepts a value + // of Standard, G.1X, or G.2X. + // + // * For the Standard worker type, each worker + // provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. + // + // + // * For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, + // 64 GB disk), and provides 1 executor per worker. We recommend this worker type + // for memory-intensive jobs. + // + // * For the G.2X worker type, each worker maps to + // 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per + // worker. We recommend this worker type for memory-intensive jobs. + WorkerType WorkerType } // A classifier for JSON content. @@ -1862,14 +1862,14 @@ type JsonClassifier struct { // This member is required. JsonPath *string - // The time that this classifier was registered. - CreationTime *time.Time - // The name of the classifier. // // This member is required. Name *string + // The time that this classifier was registered. + CreationTime *time.Time + // The time that this classifier was last updated. LastUpdated *time.Time @@ -1888,41 +1888,46 @@ type LabelingSetGenerationTaskRunProperties struct { // Status and error information about the most recent crawl. type LastCrawlInfo struct { - // The time at which the crawl started. - StartTime *time.Time + // If an error occurred, the error information about the last crawl. + ErrorMessage *string // The log group for the last crawl. LogGroup *string + // The log stream for the last crawl. + LogStream *string + // The prefix for a message about this crawl. MessagePrefix *string - // The log stream for the last crawl. - LogStream *string + // The time at which the crawl started. + StartTime *time.Time // Status of the last crawl. Status LastCrawlStatus - - // If an error occurred, the error information about the last crawl. - ErrorMessage *string } // The location of resources. type Location struct { - // An Amazon Simple Storage Service (Amazon S3) location. - S3 []*CodeGenNodeArg - // An Amazon DynamoDB table location. DynamoDB []*CodeGenNodeArg // A JDBC location. Jdbc []*CodeGenNodeArg + + // An Amazon Simple Storage Service (Amazon S3) location. + S3 []*CodeGenNodeArg } // Defines a long column statistics data. type LongColumnStatisticsData struct { + // Number of distinct values. + // + // This member is required. + NumberOfDistinctValues *int64 + // Number of nulls. // // This member is required. @@ -1931,11 +1936,6 @@ type LongColumnStatisticsData struct { // Maximum value of the column. MaximumValue *int64 - // Number of distinct values. - // - // This member is required. - NumberOfDistinctValues *int64 - // Minimum value of the column. MinimumValue *int64 } @@ -1943,42 +1943,38 @@ type LongColumnStatisticsData struct { // Defines a mapping. type MappingEntry struct { + // The source path. + SourcePath *string + // The name of the source table. SourceTable *string - // The target type. - TargetType *string - - // The target table. - TargetTable *string - - // The source path. - SourcePath *string + // The source type. + SourceType *string // The target path. TargetPath *string - // The source type. - SourceType *string + // The target table. + TargetTable *string + + // The target type. + TargetType *string } // A structure for a machine learning transform. type MLTransform struct { - // A count identifier for the labeling files generated by AWS Glue for this - // transform. As you create a better transform, you can iteratively download, - // label, and upload the labeling file. - LabelCount *int32 + // A timestamp. The time and date that this machine learning transform was created. + CreatedOn *time.Time - // A timestamp. The last point in time when this machine learning transform was - // modified. - LastModifiedOn *time.Time + // A user-defined, long-form description text for the machine learning transform. + // Descriptions are not guaranteed to be unique and can be changed at any time. + Description *string - // A TransformParameters object. You can use parameters to tune (customize) the - // behavior of the machine learning transform by specifying what data it learns - // from and your preference on various tradeoffs (such as precious vs. recall, or - // accuracy vs. cost). - Parameters *TransformParameters + // An EvaluationMetrics object. Evaluation metrics provide an estimate of the + // quality of your machine learning transform. + EvaluationMetrics *EvaluationMetrics // This value determines which version of AWS Glue this machine learning transform // is compatible with. Glue 1.0 is recommended for most customers. If the value is @@ -1988,37 +1984,55 @@ type MLTransform struct { // in the developer guide. GlueVersion *string - // A user-defined name for the machine learning transform. Names are not guaranteed - // unique and can be changed at any time. - Name *string - - // An EvaluationMetrics object. Evaluation metrics provide an estimate of the - // quality of your machine learning transform. - EvaluationMetrics *EvaluationMetrics - - // A map of key-value pairs representing the columns and data types that this - // transform can run against. Has an upper bound of 100 columns. - Schema []*SchemaColumn + // A list of AWS Glue table definitions used by the transform. + InputRecordTables []*GlueTable - // A user-defined, long-form description text for the machine learning transform. - // Descriptions are not guaranteed to be unique and can be changed at any time. - Description *string + // A count identifier for the labeling files generated by AWS Glue for this + // transform. As you create a better transform, you can iteratively download, + // label, and upload the labeling file. + LabelCount *int32 - // The timeout in minutes of the machine learning transform. - Timeout *int32 + // A timestamp. The last point in time when this machine learning transform was + // modified. + LastModifiedOn *time.Time - // A list of AWS Glue table definitions used by the transform. - InputRecordTables []*GlueTable + // The number of AWS Glue data processing units (DPUs) that are allocated to task + // runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. + // A DPU is a relative measure of processing power that consists of 4 vCPUs of + // compute capacity and 16 GB of memory. For more information, see the AWS Glue + // pricing page (http://aws.amazon.com/glue/pricing/).

    + // MaxCapacity is a mutually exclusive option with + // NumberOfWorkers and WorkerType.

    When the WorkerType field is + // set to a value other than Standard, the MaxCapacity + // field is set automatically and becomes read-only.

    + MaxCapacity *float64 // The maximum number of times to retry after an MLTaskRun of the machine learning // transform fails. MaxRetries *int32 + // A user-defined name for the machine learning transform. Names are not guaranteed + // unique and can be changed at any time. + Name *string + // The number of workers of a defined workerType that are allocated when a task of // the transform runs.

    If WorkerType is set, then // NumberOfWorkers is required (and vice versa).

    NumberOfWorkers *int32 + // A TransformParameters object. You can use parameters to tune (customize) the + // behavior of the machine learning transform by specifying what data it learns + // from and your preference on various tradeoffs (such as precious vs. recall, or + // accuracy vs. cost). + Parameters *TransformParameters + // The name or Amazon Resource Name (ARN) of the IAM role with the required // permissions. The required permissions include both AWS Glue service role // permissions to AWS Glue resources, and Amazon S3 permissions required by the @@ -2031,34 +2045,20 @@ type MLTransform struct { // for this transform.

    Role *string + // A map of key-value pairs representing the columns and data types that this + // transform can run against. Has an upper bound of 100 columns. + Schema []*SchemaColumn + // The current status of the machine learning transform. Status TransformStatusType + // The timeout in minutes of the machine learning transform. + Timeout *int32 + // The unique transform ID that is generated for the machine learning transform. // The ID is guaranteed to be unique and does not change. TransformId *string - // A timestamp. The time and date that this machine learning transform was created. - CreatedOn *time.Time - - // The number of AWS Glue data processing units (DPUs) that are allocated to task - // runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. - // A DPU is a relative measure of processing power that consists of 4 vCPUs of - // compute capacity and 16 GB of memory. For more information, see the AWS Glue - // pricing page (http://aws.amazon.com/glue/pricing/).

    - // MaxCapacity is a mutually exclusive option with - // NumberOfWorkers and WorkerType.

    When the WorkerType field is - // set to a value other than Standard, the MaxCapacity - // field is set automatically and becomes read-only.

    - MaxCapacity *float64 - // The type of predefined worker that is allocated when a task of this transform // runs. Accepts a value of Standard, G.1X, or G.2X. // @@ -2089,23 +2089,23 @@ type MLTransform struct { // part of a workflow. type Node struct { + // Details of the crawler when the node represents a crawler. + CrawlerDetails *CrawlerNodeDetails + // Details of the Job when the node represents a Job. JobDetails *JobNodeDetails - // Details of the Trigger when the node represents a Trigger. - TriggerDetails *TriggerNodeDetails - - // The unique Id assigned to the node within the workflow. - UniqueId *string - // The name of the AWS Glue component represented by the node. Name *string - // Details of the crawler when the node represents a crawler. - CrawlerDetails *CrawlerNodeDetails + // Details of the Trigger when the node represents a Trigger. + TriggerDetails *TriggerNodeDetails // The type of AWS Glue component represented by the node. Type NodeType + + // The unique Id assigned to the node within the workflow. + UniqueId *string } // Specifies configuration properties of a notification. @@ -2134,65 +2134,65 @@ type Order struct { // Represents a slice of table data. type Partition struct { - // The last time at which the partition was accessed. - LastAccessTime *time.Time + // The ID of the Data Catalog in which the partition resides. + CatalogId *string + + // The time at which the partition was created. + CreationTime *time.Time // The name of the catalog database in which to create the partition. DatabaseName *string + // The last time at which the partition was accessed. + LastAccessTime *time.Time + // The last time at which column statistics were computed for this partition. LastAnalyzedTime *time.Time // These key-value pairs define partition parameters. Parameters map[string]*string - // The time at which the partition was created. - CreationTime *time.Time - // Provides information about the physical location where the partition is stored. StorageDescriptor *StorageDescriptor - // The values of the partition. - Values []*string - // The name of the database table in which to create the partition. TableName *string - // The ID of the Data Catalog in which the partition resides. - CatalogId *string + // The values of the partition. + Values []*string } // Contains information about a partition error. type PartitionError struct { - // The values that define the partition. - PartitionValues []*string - // The details about the partition error. ErrorDetail *ErrorDetail + + // The values that define the partition. + PartitionValues []*string } // The structure used to create and update a partition. type PartitionInput struct { + // The last time at which the partition was accessed. + LastAccessTime *time.Time + // The last time at which column statistics were computed for this partition. LastAnalyzedTime *time.Time + // These key-value pairs define partition parameters. + Parameters map[string]*string + + // Provides information about the physical location where the partition is stored. + StorageDescriptor *StorageDescriptor + // The values of the partition. Although this parameter is not required by the SDK, // you must specify this parameter for a valid input.

    The values for the keys // for the new partition must be passed as an array of String objects that must be // ordered in the same order as the partition keys appearing in the Amazon S3 // prefix. Otherwise AWS Glue will add the values to the wrong keys.

    Values []*string - - // Provides information about the physical location where the partition is stored. - StorageDescriptor *StorageDescriptor - - // These key-value pairs define partition parameters. - Parameters map[string]*string - - // The last time at which the partition was accessed. - LastAccessTime *time.Time } // Contains a list of values defining partitions. @@ -2207,16 +2207,16 @@ type PartitionValueList struct { // Specifies the physical requirements for a connection. type PhysicalConnectionRequirements struct { + // The connection's Availability Zone. This field is redundant because the + // specified subnet implies the Availability Zone to be used. Currently the field + // must be populated, but it will be deprecated in the future. + AvailabilityZone *string + // The security group ID list used by the connection. SecurityGroupIdList []*string // The subnet ID used by the connection. SubnetId *string - - // The connection's Availability Zone. This field is redundant because the - // specified subnet implies the Availability Zone to be used. Currently the field - // must be populated, but it will be deprecated in the future. - AvailabilityZone *string } // A job run that was used in the predicate of a conditional trigger that triggered @@ -2233,12 +2233,12 @@ type Predecessor struct { // Defines the predicate of the trigger, which determines when it fires. type Predicate struct { + // A list of the conditions that determine when the trigger will fire. + Conditions []*Condition + // An optional field if only one condition is listed. If multiple conditions are // listed, then this field is required. Logical Logical - - // A list of the conditions that determine when the trigger will fire. - Conditions []*Condition } // Permissions granted to a principal. @@ -2254,24 +2254,24 @@ type PrincipalPermissions struct { // Defines a property predicate. type PropertyPredicate struct { - // The value of the property. - Value *string - // The comparator used to compare this property to others. Comparator Comparator // The key of the property. Key *string + + // The value of the property. + Value *string } // The URIs for function resources. type ResourceUri struct { - // The URI for accessing the resource. - Uri *string - // The type of the resource. ResourceType ResourceType + + // The URI for accessing the resource. + Uri *string } // Specifies how Amazon Simple Storage Service (Amazon S3) data should be @@ -2300,15 +2300,15 @@ type S3Target struct { // A scheduling object using a cron statement to schedule an event. type Schedule struct { - // The state of the schedule. - State ScheduleState - // A cron expression used to specify the schedule (see Time-Based Schedules for // Jobs and Crawlers // (https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). // For example, to run something every day at 12:15 UTC, you would specify: cron(15 // 12 * * ? *). ScheduleExpression *string + + // The state of the schedule. + State ScheduleState } // A policy that specifies update and deletion behaviors for the crawler. @@ -2326,24 +2326,24 @@ type SchemaChangePolicy struct { // structures. type SchemaColumn struct { - // The name of the column. - Name *string - // The type of data in the column. DataType *string + + // The name of the column. + Name *string } // Specifies a security configuration. type SecurityConfiguration struct { + // The time at which this security configuration was created. + CreatedTimeStamp *time.Time + // The encryption configuration associated with this security configuration. EncryptionConfiguration *EncryptionConfiguration // The name of the security configuration. Name *string - - // The time at which this security configuration was created. - CreatedTimeStamp *time.Time } // Defines a non-overlapping region of a table's partitions, allowing multiple @@ -2366,15 +2366,15 @@ type Segment struct { // an extractor and loader. type SerDeInfo struct { - // Usually the class that implements the SerDe. An example is - // org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe. - SerializationLibrary *string - // Name of the SerDe. Name *string // These key-value pairs define initialization parameters for the SerDe. Parameters map[string]*string + + // Usually the class that implements the SerDe. An example is + // org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe. + SerializationLibrary *string } // Specifies skewed values in a table. Skewed values are those that occur with very @@ -2394,54 +2394,54 @@ type SkewedInfo struct { // Specifies a field to sort by and a sort order. type SortCriterion struct { - // An ascending or descending sort. - Sort Sort - // The name of the field on which to sort. FieldName *string + + // An ascending or descending sort. + Sort Sort } // Describes the physical storage of table data. type StorageDescriptor struct { - // The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a - // custom format. - InputFormat *string + // A list of reducer grouping columns, clustering columns, and bucketing columns in + // the table. + BucketColumns []*string // A list of the Columns in the table. Columns []*Column - // Must be specified if the table contains any dimension columns. - NumberOfBuckets *int32 + // True if the data in the table is compressed, or False if not. + Compressed *bool + + // The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a + // custom format. + InputFormat *string // The physical location of the table. By default, this takes the form of the // warehouse location, followed by the database location in the warehouse, followed // by the table name. Location *string - // The information about values that appear frequently in a column (skewed values). - SkewedInfo *SkewedInfo + // Must be specified if the table contains any dimension columns. + NumberOfBuckets *int32 // The output format: SequenceFileOutputFormat (binary), or // IgnoreKeyTextOutputFormat, or a custom format. OutputFormat *string - // A list of reducer grouping columns, clustering columns, and bucketing columns in - // the table. - BucketColumns []*string - // The user-supplied properties in key-value form. Parameters map[string]*string - // True if the data in the table is compressed, or False if not. - Compressed *bool + // The serialization/deserialization (SerDe) information. + SerdeInfo *SerDeInfo + + // The information about values that appear frequently in a column (skewed values). + SkewedInfo *SkewedInfo // A list specifying the sort order of each bucket in the table. SortColumns []*Order - // The serialization/deserialization (SerDe) information. - SerdeInfo *SerDeInfo - // True if the table data is stored in subdirectories, or False if not. StoredAsSubDirectories *bool } @@ -2454,15 +2454,15 @@ type StringColumnStatisticsData struct { // This member is required. AverageLength *float64 - // Number of distinct values. + // Maximum value of the column. // // This member is required. - NumberOfDistinctValues *int64 + MaximumLength *int64 - // Maximum value of the column. + // Number of distinct values. // // This member is required. - MaximumLength *int64 + NumberOfDistinctValues *int64 // Number of nulls. // @@ -2473,43 +2473,48 @@ type StringColumnStatisticsData struct { // Represents a collection of related data organized in columns and rows. type Table struct { - // The last time that the table was accessed. This is usually taken from HDFS, and - // might not be reliable. - LastAccessTime *time.Time + // The table name. For Hive compatibility, this must be entirely lowercase. + // + // This member is required. + Name *string // The ID of the Data Catalog in which the table resides. CatalogId *string - // A list of columns by which the table is partitioned. Only primitive types are - // supported as partition keys. When you create a table used by Amazon Athena, and - // you do not specify any partitionKeys, you must at least set the value of - // partitionKeys to an empty list. For example: "PartitionKeys": [] - PartitionKeys []*Column + // The time when the table definition was created in the Data Catalog. + CreateTime *time.Time - // A description of the table. - Description *string + // The person or entity who created the table. + CreatedBy *string // The name of the database where the table metadata resides. For Hive // compatibility, this must be all lowercase. DatabaseName *string - // The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). - TableType *string + // A description of the table. + Description *string - // A TableIdentifier structure that describes a target table for resource linking. - TargetTable *TableIdentifier + // Indicates whether the table has been registered with AWS Lake Formation. + IsRegisteredWithLakeFormation *bool - // The person or entity who created the table. - CreatedBy *string + // The last time that the table was accessed. This is usually taken from HDFS, and + // might not be reliable. + LastAccessTime *time.Time + + // The last time that column statistics were computed for this table. + LastAnalyzedTime *time.Time + + // The owner of the table. + Owner *string // These key-value pairs define properties associated with the table. Parameters map[string]*string - // The time when the table definition was created in the Data Catalog. - CreateTime *time.Time - - // If the table is a view, the expanded text of the view; otherwise null. - ViewExpandedText *string + // A list of columns by which the table is partitioned. Only primitive types are + // supported as partition keys. When you create a table used by Amazon Athena, and + // you do not specify any partitionKeys, you must at least set the value of + // partitionKeys to an empty list. For example: "PartitionKeys": [] + PartitionKeys []*Column // The retention time for this table. Retention *int32 @@ -2518,25 +2523,20 @@ type Table struct { // table. StorageDescriptor *StorageDescriptor - // The table name. For Hive compatibility, this must be entirely lowercase. - // - // This member is required. - Name *string - - // Indicates whether the table has been registered with AWS Lake Formation. - IsRegisteredWithLakeFormation *bool - - // If the table is a view, the original text of the view; otherwise null. - ViewOriginalText *string + // The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). + TableType *string - // The owner of the table. - Owner *string + // A TableIdentifier structure that describes a target table for resource linking. + TargetTable *TableIdentifier // The last time that the table was updated. UpdateTime *time.Time - // The last time that column statistics were computed for this table. - LastAnalyzedTime *time.Time + // If the table is a view, the expanded text of the view; otherwise null. + ViewExpandedText *string + + // If the table is a view, the original text of the view; otherwise null. + ViewOriginalText *string } // An error record for table operations. @@ -2565,51 +2565,51 @@ type TableIdentifier struct { // A structure used to define a table. type TableInput struct { - // If the table is a view, the expanded text of the view; otherwise null. - ViewExpandedText *string - - // The retention time for this table. - Retention *int32 - - // The last time that column statistics were computed for this table. - LastAnalyzedTime *time.Time - // The table name. For Hive compatibility, this is folded to lowercase when it is // stored. // // This member is required. Name *string - // A storage descriptor containing information about the physical storage of this - // table. - StorageDescriptor *StorageDescriptor - - // The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). - TableType *string + // A description of the table. + Description *string - // These key-value pairs define properties associated with the table. - Parameters map[string]*string + // The last time that the table was accessed. + LastAccessTime *time.Time - // If the table is a view, the original text of the view; otherwise null. - ViewOriginalText *string + // The last time that column statistics were computed for this table. + LastAnalyzedTime *time.Time // The table owner. Owner *string + // These key-value pairs define properties associated with the table. + Parameters map[string]*string + // A list of columns by which the table is partitioned. Only primitive types are // supported as partition keys. When you create a table used by Amazon Athena, and // you do not specify any partitionKeys, you must at least set the value of // partitionKeys to an empty list. For example: "PartitionKeys": [] PartitionKeys []*Column + // The retention time for this table. + Retention *int32 + + // A storage descriptor containing information about the physical storage of this + // table. + StorageDescriptor *StorageDescriptor + + // The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). + TableType *string + // A TableIdentifier structure that describes a target table for resource linking. TargetTable *TableIdentifier - // The last time that the table was accessed. - LastAccessTime *time.Time + // If the table is a view, the expanded text of the view; otherwise null. + ViewExpandedText *string - // A description of the table. - Description *string + // If the table is a view, the original text of the view; otherwise null. + ViewOriginalText *string } // Specifies a version of a table. @@ -2629,123 +2629,110 @@ type TableVersionError struct { // The details about the error. ErrorDetail *ErrorDetail + // The name of the table in question. + TableName *string + // The ID value of the version in question. A VersionID is a string representation // of an integer. Each version is incremented by 1. VersionId *string - - // The name of the table in question. - TableName *string } // The sampling parameters that are associated with the machine learning transform. type TaskRun struct { - // The date and time that this task run started. - StartedOn *time.Time + // The last point in time that the requested task run was completed. + CompletedOn *time.Time + + // The list of error strings associated with this task run. + ErrorString *string // The amount of time (in seconds) that the task run consumed resources. ExecutionTime *int32 - // The current status of the requested task run. - Status TaskStatusType + // The last point in time that the requested task run was updated. + LastModifiedOn *time.Time + + // The names of the log group for secure logging, associated with this task run. + LogGroupName *string // Specifies configuration properties associated with this task run. Properties *TaskRunProperties - // The unique identifier for the transform. - TransformId *string - - // The last point in time that the requested task run was completed. - CompletedOn *time.Time - - // The list of error strings associated with this task run. - ErrorString *string + // The date and time that this task run started. + StartedOn *time.Time - // The names of the log group for secure logging, associated with this task run. - LogGroupName *string + // The current status of the requested task run. + Status TaskStatusType // The unique identifier for this task run. TaskRunId *string - // The last point in time that the requested task run was updated. - LastModifiedOn *time.Time + // The unique identifier for the transform. + TransformId *string } // The criteria that are used to filter the task runs for the machine learning // transform. type TaskRunFilterCriteria struct { - // Filter on task runs started before this date. - StartedBefore *time.Time - // Filter on task runs started after this date. StartedAfter *time.Time - // The type of task run. - TaskRunType TaskType + // Filter on task runs started before this date. + StartedBefore *time.Time // The current status of the task run. Status TaskStatusType + + // The type of task run. + TaskRunType TaskType } // The configuration properties for the task run. type TaskRunProperties struct { - // The type of task run. - TaskType TaskType + // The configuration properties for an exporting labels task run. + ExportLabelsTaskRunProperties *ExportLabelsTaskRunProperties - // The configuration properties for a labeling set generation task run. - LabelingSetGenerationTaskRunProperties *LabelingSetGenerationTaskRunProperties + // The configuration properties for a find matches task run. + FindMatchesTaskRunProperties *FindMatchesTaskRunProperties // The configuration properties for an importing labels task run. ImportLabelsTaskRunProperties *ImportLabelsTaskRunProperties - // The configuration properties for a find matches task run. - FindMatchesTaskRunProperties *FindMatchesTaskRunProperties + // The configuration properties for a labeling set generation task run. + LabelingSetGenerationTaskRunProperties *LabelingSetGenerationTaskRunProperties - // The configuration properties for an exporting labels task run. - ExportLabelsTaskRunProperties *ExportLabelsTaskRunProperties + // The type of task run. + TaskType TaskType } // The sorting criteria that are used to sort the list of task runs for the machine // learning transform. type TaskRunSortCriteria struct { - // The sort direction to be used to sort the list of task runs for the machine - // learning transform. - // - // This member is required. - SortDirection SortDirectionType - // The column to be used to sort the list of task runs for the machine learning // transform. // // This member is required. Column TaskRunSortColumnType -} - -// The criteria used to filter the machine learning transforms. -type TransformFilterCriteria struct { - - // Filters on datasets with a specific schema. The Map object is an array of - // key-value pairs representing the schema this transform accepts, where Column is - // the name of a column, and Type is the type of the data such as an integer or - // string. Has an upper bound of 100 columns. - Schema []*SchemaColumn - - // A unique transform name that is used to filter the machine learning transforms. - Name *string - // The type of machine learning transform that is used to filter the machine - // learning transforms. - TransformType TransformType + // The sort direction to be used to sort the list of task runs for the machine + // learning transform. + // + // This member is required. + SortDirection SortDirectionType +} - // Filter on transforms last modified before this date. - LastModifiedBefore *time.Time +// The criteria used to filter the machine learning transforms. +type TransformFilterCriteria struct { // The time and date after which the transforms were created. CreatedAfter *time.Time + // The time and date before which the transforms were created. + CreatedBefore *time.Time + // This value determines which version of AWS Glue this machine learning transform // is compatible with. Glue 1.0 is recommended for most customers. If the value is // not set, the Glue compatibility defaults to Glue 0.9. For more information, see @@ -2754,31 +2741,44 @@ type TransformFilterCriteria struct { // in the developer guide. GlueVersion *string - // The time and date before which the transforms were created. - CreatedBefore *time.Time + // Filter on transforms last modified after this date. + LastModifiedAfter *time.Time + + // Filter on transforms last modified before this date. + LastModifiedBefore *time.Time + + // A unique transform name that is used to filter the machine learning transforms. + Name *string + + // Filters on datasets with a specific schema. The Map object is an array of + // key-value pairs representing the schema this transform accepts, where Column is + // the name of a column, and Type is the type of the data such as an integer or + // string. Has an upper bound of 100 columns. + Schema []*SchemaColumn // Filters the list of machine learning transforms by the last known status of the // transforms (to indicate whether a transform can be used or not). One of // "NOT_READY", "READY", or "DELETING". Status TransformStatusType - // Filter on transforms last modified after this date. - LastModifiedAfter *time.Time + // The type of machine learning transform that is used to filter the machine + // learning transforms. + TransformType TransformType } // The algorithm-specific parameters that are associated with the machine learning // transform. type TransformParameters struct { - // The parameters for the find matches algorithm. - FindMatchesParameters *FindMatchesParameters - // The type of machine learning transform. For information about the types of // machine learning transforms, see Creating Machine Learning Transforms // (http://docs.aws.amazon.com/glue/latest/dg/add-job-machine-learning-transform.html). // // This member is required. TransformType TransformType + + // The parameters for the find matches algorithm. + FindMatchesParameters *FindMatchesParameters } // The sorting criteria that are associated with the machine learning transform. @@ -2800,26 +2800,20 @@ type TransformSortCriteria struct { // Information about a specific trigger. type Trigger struct { - // The predicate of this trigger, which defines when it will fire. - Predicate *Predicate - - // The type of trigger that this is. - Type TriggerType - - // The name of the trigger. - Name *string - - // The name of the workflow associated with the trigger. - WorkflowName *string - // The actions initiated by this trigger. Actions []*Action + // A description of this trigger. + Description *string + // Reserved for future use. Id *string - // A description of this trigger. - Description *string + // The name of the trigger. + Name *string + + // The predicate of this trigger, which defines when it will fire. + Predicate *Predicate // A cron expression used to specify the schedule (see Time-Based Schedules for // Jobs and Crawlers @@ -2830,6 +2824,12 @@ type Trigger struct { // The current state of the trigger. State TriggerState + + // The type of trigger that this is. + Type TriggerType + + // The name of the workflow associated with the trigger. + WorkflowName *string } // The details of a Trigger node present in the workflow. @@ -2843,18 +2843,18 @@ type TriggerNodeDetails struct { // updates the previous trigger definition by overwriting it completely. type TriggerUpdate struct { - // The predicate of this trigger, which defines when it will fire. - Predicate *Predicate + // The actions initiated by this trigger. + Actions []*Action // A description of this trigger. Description *string - // The actions initiated by this trigger. - Actions []*Action - // Reserved for future use. Name *string + // The predicate of this trigger, which defines when it will fire. + Predicate *Predicate + // A cron expression used to specify the schedule (see Time-Based Schedules for // Jobs and Crawlers // (https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). @@ -2866,68 +2866,73 @@ type TriggerUpdate struct { // Specifies a custom CSV classifier to be updated. type UpdateCsvClassifierRequest struct { - // Specifies not to trim values before identifying the type of column values. The - // default value is true. - DisableValueTrimming *bool + // The name of the classifier. + // + // This member is required. + Name *string + + // Enables the processing of files that contain only one column. + AllowSingleColumn *bool + + // Indicates whether the CSV file contains a header. + ContainsHeader CsvHeaderOption // A custom symbol to denote what separates each column entry in the row. Delimiter *string + // Specifies not to trim values before identifying the type of column values. The + // default value is true. + DisableValueTrimming *bool + // A list of strings representing column names. Header []*string - // Enables the processing of files that contain only one column. - AllowSingleColumn *bool - - // The name of the classifier. - // - // This member is required. - Name *string - // A custom symbol to denote what combines content into a single column value. It // must be different from the column delimiter. QuoteSymbol *string - - // Indicates whether the CSV file contains a header. - ContainsHeader CsvHeaderOption } // Specifies a grok classifier to update when passed to UpdateClassifier. type UpdateGrokClassifierRequest struct { + // The name of the GrokClassifier. + // + // This member is required. + Name *string + + // An identifier of the data format that the classifier matches, such as Twitter, + // JSON, Omniture logs, Amazon CloudWatch Logs, and so on. + Classification *string + // Optional custom grok patterns used by this classifier. CustomPatterns *string // The grok pattern used by this classifier. GrokPattern *string +} - // An identifier of the data format that the classifier matches, such as Twitter, - // JSON, Omniture logs, Amazon CloudWatch Logs, and so on. - Classification *string +// Specifies a JSON classifier to be updated. +type UpdateJsonClassifierRequest struct { - // The name of the GrokClassifier. + // The name of the classifier. // // This member is required. Name *string -} - -// Specifies a JSON classifier to be updated. -type UpdateJsonClassifierRequest struct { // A JsonPath string defining the JSON data for the classifier to classify. AWS // Glue supports a subset of JsonPath, as described in Writing JsonPath Custom // Classifiers // (https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json). JsonPath *string +} + +// Specifies an XML classifier to be updated. +type UpdateXMLClassifierRequest struct { // The name of the classifier. // // This member is required. Name *string -} - -// Specifies an XML classifier to be updated. -type UpdateXMLClassifierRequest struct { // An identifier of the data format that the classifier matches. Classification *string @@ -2937,67 +2942,61 @@ type UpdateXMLClassifierRequest struct { // empty row element that contains only attributes can be parsed as long as it ends // with a closing tag (for example, is okay, but is not). RowTag *string - - // The name of the classifier. - // - // This member is required. - Name *string } // Represents the equivalent of a Hive user-defined function (UDF) definition. type UserDefinedFunction struct { - // The name of the catalog database that contains the function. - DatabaseName *string + // The ID of the Data Catalog in which the function resides. + CatalogId *string // The Java class that contains the function code. ClassName *string - // The ID of the Data Catalog in which the function resides. - CatalogId *string - // The time at which the function was created. CreateTime *time.Time + // The name of the catalog database that contains the function. + DatabaseName *string + // The name of the function. FunctionName *string - // The resource URIs for the function. - ResourceUris []*ResourceUri - // The owner of the function. OwnerName *string // The owner type. OwnerType PrincipalType + + // The resource URIs for the function. + ResourceUris []*ResourceUri } // A structure used to create or update a user-defined function. type UserDefinedFunctionInput struct { - // The owner type. - OwnerType PrincipalType + // The Java class that contains the function code. + ClassName *string // The name of the function. FunctionName *string - // The resource URIs for the function. - ResourceUris []*ResourceUri - - // The Java class that contains the function code. - ClassName *string - // The owner of the function. OwnerName *string + + // The owner type. + OwnerType PrincipalType + + // The resource URIs for the function. + ResourceUris []*ResourceUri } // A workflow represents a flow in which AWS Glue components should be executed to // complete a logical task. type Workflow struct { - // The graph representing all the AWS Glue components that belong to the workflow - // as nodes and directed connections between them as edges. - Graph *WorkflowGraph + // The date and time when the workflow was created. + CreatedOn *time.Time // A collection of properties to be used as part of each execution of the workflow. DefaultRunProperties map[string]*string @@ -3005,8 +3004,9 @@ type Workflow struct { // A description of the workflow. Description *string - // The name of the workflow representing the flow. - Name *string + // The graph representing all the AWS Glue components that belong to the workflow + // as nodes and directed connections between them as edges. + Graph *WorkflowGraph // The date and time when the workflow was last modified. LastModifiedOn *time.Time @@ -3014,8 +3014,8 @@ type Workflow struct { // The information about the last execution of the workflow. LastRun *WorkflowRun - // The date and time when the workflow was created. - CreatedOn *time.Time + // The name of the workflow representing the flow. + Name *string } // A workflow graph represents the complete workflow containing all the AWS Glue @@ -3036,12 +3036,6 @@ type WorkflowGraph struct { // information. type WorkflowRun struct { - // The statistics of the run. - Statistics *WorkflowRunStatistics - - // Name of the workflow that was executed. - Name *string - // The date and time when the workflow run completed. CompletedOn *time.Time @@ -3049,39 +3043,45 @@ type WorkflowRun struct { // as nodes and directed connections between them as edges. Graph *WorkflowGraph + // Name of the workflow that was executed. + Name *string + + // The ID of the previous workflow run. + PreviousRunId *string + // The date and time when the workflow run was started. StartedOn *time.Time - // The workflow run properties which were set during the run. - WorkflowRunProperties map[string]*string + // The statistics of the run. + Statistics *WorkflowRunStatistics + + // The status of the workflow run. + Status WorkflowRunStatus // The ID of this workflow run. WorkflowRunId *string - // The ID of the previous workflow run. - PreviousRunId *string - - // The status of the workflow run. - Status WorkflowRunStatus + // The workflow run properties which were set during the run. + WorkflowRunProperties map[string]*string } // Workflow run statistics provides statistics about the workflow run. type WorkflowRunStatistics struct { - // Total number of Actions that timed out. - TimeoutActions *int32 + // Total number of Actions that have failed. + FailedActions *int32 // Total number Actions in running state. RunningActions *int32 + // Total number of Actions that have stopped. + StoppedActions *int32 + // Total number of Actions that have succeeded. SucceededActions *int32 - // Total number of Actions that have failed. - FailedActions *int32 - - // Total number of Actions that have stopped. - StoppedActions *int32 + // Total number of Actions that timed out. + TimeoutActions *int32 // Total number of Actions in the workflow run. TotalActions *int32 @@ -3090,17 +3090,10 @@ type WorkflowRunStatistics struct { // A classifier for XML content. type XMLClassifier struct { - // The XML tag designating the element that contains each record in an XML document - // being parsed. This can't identify a self-closing element (closed by />). An - // empty row element that contains only attributes can be parsed as long as it ends - // with a closing tag (for example, is okay, but is not). - RowTag *string - - // The version of this classifier. - Version *int64 - - // The time that this classifier was last updated. - LastUpdated *time.Time + // An identifier of the data format that the classifier matches. + // + // This member is required. + Classification *string // The name of the classifier. // @@ -3110,8 +3103,15 @@ type XMLClassifier struct { // The time that this classifier was registered. CreationTime *time.Time - // An identifier of the data format that the classifier matches. - // - // This member is required. - Classification *string + // The time that this classifier was last updated. + LastUpdated *time.Time + + // The XML tag designating the element that contains each record in an XML document + // being parsed. This can't identify a self-closing element (closed by />). An + // empty row element that contains only attributes can be parsed as long as it ends + // with a closing tag (for example, is okay, but is not). + RowTag *string + + // The version of this classifier. + Version *int64 } diff --git a/service/greengrass/api_op_CreateConnectorDefinition.go b/service/greengrass/api_op_CreateConnectorDefinition.go index f08463d4048..ef66b558eaf 100644 --- a/service/greengrass/api_op_CreateConnectorDefinition.go +++ b/service/greengrass/api_op_CreateConnectorDefinition.go @@ -59,42 +59,42 @@ func (c *Client) CreateConnectorDefinition(ctx context.Context, params *CreateCo type CreateConnectorDefinitionInput struct { + // A client token used to correlate requests and responses. + AmznClientToken *string + + // Information about the initial version of the connector definition. + InitialVersion *types.ConnectorDefinitionVersion + // The name of the connector definition. Name *string // Tag(s) to add to the new resource. Tags map[string]*string - - // Information about the initial version of the connector definition. - InitialVersion *types.ConnectorDefinitionVersion - - // A client token used to correlate requests and responses. - AmznClientToken *string } type CreateConnectorDefinitionOutput struct { - // The ID of the definition. - Id *string - - // The time, in milliseconds since the epoch, when the definition was last updated. - LastUpdatedTimestamp *string - - // The name of the definition. - Name *string - // The ARN of the definition. Arn *string // The time, in milliseconds since the epoch, when the definition was created. CreationTimestamp *string + // The ID of the definition. + Id *string + + // The time, in milliseconds since the epoch, when the definition was last updated. + LastUpdatedTimestamp *string + // The ID of the latest version associated with the definition. LatestVersion *string // The ARN of the latest version associated with the definition. LatestVersionArn *string + // The name of the definition. + Name *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_CreateConnectorDefinitionVersion.go b/service/greengrass/api_op_CreateConnectorDefinitionVersion.go index 93f3c6f8c51..84f56be5266 100644 --- a/service/greengrass/api_op_CreateConnectorDefinitionVersion.go +++ b/service/greengrass/api_op_CreateConnectorDefinitionVersion.go @@ -57,32 +57,32 @@ func (c *Client) CreateConnectorDefinitionVersion(ctx context.Context, params *C type CreateConnectorDefinitionVersionInput struct { - // A list of references to connectors in this version, with their corresponding - // configuration settings. - Connectors []*types.Connector - - // A client token used to correlate requests and responses. - AmznClientToken *string - // The ID of the connector definition. // // This member is required. ConnectorDefinitionId *string + + // A client token used to correlate requests and responses. + AmznClientToken *string + + // A list of references to connectors in this version, with their corresponding + // configuration settings. + Connectors []*types.Connector } type CreateConnectorDefinitionVersionOutput struct { + // The ARN of the version. + Arn *string + // The time, in milliseconds since the epoch, when the version was created. CreationTimestamp *string - // The ID of the version. - Version *string - // The ID of the parent definition that the version is associated with. Id *string - // The ARN of the version. - Arn *string + // The ID of the version. + Version *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/greengrass/api_op_CreateCoreDefinition.go b/service/greengrass/api_op_CreateCoreDefinition.go index 645c36ce427..c0c32c13f05 100644 --- a/service/greengrass/api_op_CreateCoreDefinition.go +++ b/service/greengrass/api_op_CreateCoreDefinition.go @@ -60,23 +60,29 @@ func (c *Client) CreateCoreDefinition(ctx context.Context, params *CreateCoreDef // Information needed to create a core definition. type CreateCoreDefinitionInput struct { + // A client token used to correlate requests and responses. + AmznClientToken *string + // Information about the initial version of the core definition. InitialVersion *types.CoreDefinitionVersion - // Tag(s) to add to the new resource. - Tags map[string]*string - // The name of the core definition. Name *string - // A client token used to correlate requests and responses. - AmznClientToken *string + // Tag(s) to add to the new resource. + Tags map[string]*string } type CreateCoreDefinitionOutput struct { - // The ARN of the latest version associated with the definition. - LatestVersionArn *string + // The ARN of the definition. + Arn *string + + // The time, in milliseconds since the epoch, when the definition was created. + CreationTimestamp *string + + // The ID of the definition. + Id *string // The time, in milliseconds since the epoch, when the definition was last updated. LastUpdatedTimestamp *string @@ -84,18 +90,12 @@ type CreateCoreDefinitionOutput struct { // The ID of the latest version associated with the definition. LatestVersion *string + // The ARN of the latest version associated with the definition. + LatestVersionArn *string + // The name of the definition. Name *string - // The ARN of the definition. - Arn *string - - // The time, in milliseconds since the epoch, when the definition was created. - CreationTimestamp *string - - // The ID of the definition. - Id *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_CreateCoreDefinitionVersion.go b/service/greengrass/api_op_CreateCoreDefinitionVersion.go index fcd8aae981b..c14fef3ebca 100644 --- a/service/greengrass/api_op_CreateCoreDefinitionVersion.go +++ b/service/greengrass/api_op_CreateCoreDefinitionVersion.go @@ -58,29 +58,29 @@ func (c *Client) CreateCoreDefinitionVersion(ctx context.Context, params *Create type CreateCoreDefinitionVersionInput struct { + // The ID of the core definition. + // + // This member is required. + CoreDefinitionId *string + // A client token used to correlate requests and responses. AmznClientToken *string // A list of cores in the core definition version. Cores []*types.Core - - // The ID of the core definition. - // - // This member is required. - CoreDefinitionId *string } type CreateCoreDefinitionVersionOutput struct { - // The ID of the parent definition that the version is associated with. - Id *string - // The ARN of the version. Arn *string // The time, in milliseconds since the epoch, when the version was created. CreationTimestamp *string + // The ID of the parent definition that the version is associated with. + Id *string + // The ID of the version. Version *string diff --git a/service/greengrass/api_op_CreateDeployment.go b/service/greengrass/api_op_CreateDeployment.go index de141bd2094..b547752c576 100644 --- a/service/greengrass/api_op_CreateDeployment.go +++ b/service/greengrass/api_op_CreateDeployment.go @@ -58,25 +58,25 @@ func (c *Client) CreateDeployment(ctx context.Context, params *CreateDeploymentI type CreateDeploymentInput struct { + // The type of deployment. When used for ''CreateDeployment'', only + // ''NewDeployment'' and ''Redeployment'' are valid. + // + // This member is required. + DeploymentType types.DeploymentType + // The ID of the Greengrass group. // // This member is required. GroupId *string - // The ID of the group version to be deployed. - GroupVersionId *string + // A client token used to correlate requests and responses. + AmznClientToken *string // The ID of the deployment if you wish to redeploy a previous deployment. DeploymentId *string - // The type of deployment. When used for ''CreateDeployment'', only - // ''NewDeployment'' and ''Redeployment'' are valid. - // - // This member is required. - DeploymentType types.DeploymentType - - // A client token used to correlate requests and responses. - AmznClientToken *string + // The ID of the group version to be deployed. + GroupVersionId *string } type CreateDeploymentOutput struct { diff --git a/service/greengrass/api_op_CreateDeviceDefinition.go b/service/greengrass/api_op_CreateDeviceDefinition.go index 3f6e01ddf22..520e8bb996c 100644 --- a/service/greengrass/api_op_CreateDeviceDefinition.go +++ b/service/greengrass/api_op_CreateDeviceDefinition.go @@ -58,39 +58,39 @@ func (c *Client) CreateDeviceDefinition(ctx context.Context, params *CreateDevic type CreateDeviceDefinitionInput struct { - // The name of the device definition. - Name *string - // A client token used to correlate requests and responses. AmznClientToken *string // Information about the initial version of the device definition. InitialVersion *types.DeviceDefinitionVersion + // The name of the device definition. + Name *string + // Tag(s) to add to the new resource. Tags map[string]*string } type CreateDeviceDefinitionOutput struct { - // The ID of the latest version associated with the definition. - LatestVersion *string + // The ARN of the definition. + Arn *string - // The time, in milliseconds since the epoch, when the definition was last updated. - LastUpdatedTimestamp *string + // The time, in milliseconds since the epoch, when the definition was created. + CreationTimestamp *string // The ID of the definition. Id *string - // The time, in milliseconds since the epoch, when the definition was created. - CreationTimestamp *string + // The time, in milliseconds since the epoch, when the definition was last updated. + LastUpdatedTimestamp *string + + // The ID of the latest version associated with the definition. + LatestVersion *string // The ARN of the latest version associated with the definition. LatestVersionArn *string - // The ARN of the definition. - Arn *string - // The name of the definition. Name *string diff --git a/service/greengrass/api_op_CreateDeviceDefinitionVersion.go b/service/greengrass/api_op_CreateDeviceDefinitionVersion.go index fc63c73c34c..c8565ad83d8 100644 --- a/service/greengrass/api_op_CreateDeviceDefinitionVersion.go +++ b/service/greengrass/api_op_CreateDeviceDefinitionVersion.go @@ -71,8 +71,8 @@ type CreateDeviceDefinitionVersionInput struct { type CreateDeviceDefinitionVersionOutput struct { - // The ID of the version. - Version *string + // The ARN of the version. + Arn *string // The time, in milliseconds since the epoch, when the version was created. CreationTimestamp *string @@ -80,8 +80,8 @@ type CreateDeviceDefinitionVersionOutput struct { // The ID of the parent definition that the version is associated with. Id *string - // The ARN of the version. - Arn *string + // The ID of the version. + Version *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/greengrass/api_op_CreateFunctionDefinition.go b/service/greengrass/api_op_CreateFunctionDefinition.go index c24f4780e04..4d65f55a1b7 100644 --- a/service/greengrass/api_op_CreateFunctionDefinition.go +++ b/service/greengrass/api_op_CreateFunctionDefinition.go @@ -60,23 +60,29 @@ func (c *Client) CreateFunctionDefinition(ctx context.Context, params *CreateFun type CreateFunctionDefinitionInput struct { + // A client token used to correlate requests and responses. + AmznClientToken *string + // Information about the initial version of the function definition. InitialVersion *types.FunctionDefinitionVersion // The name of the function definition. Name *string - // A client token used to correlate requests and responses. - AmznClientToken *string - // Tag(s) to add to the new resource. Tags map[string]*string } type CreateFunctionDefinitionOutput struct { - // The ARN of the latest version associated with the definition. - LatestVersionArn *string + // The ARN of the definition. + Arn *string + + // The time, in milliseconds since the epoch, when the definition was created. + CreationTimestamp *string + + // The ID of the definition. + Id *string // The time, in milliseconds since the epoch, when the definition was last updated. LastUpdatedTimestamp *string @@ -84,18 +90,12 @@ type CreateFunctionDefinitionOutput struct { // The ID of the latest version associated with the definition. LatestVersion *string + // The ARN of the latest version associated with the definition. + LatestVersionArn *string + // The name of the definition. Name *string - // The ID of the definition. - Id *string - - // The ARN of the definition. - Arn *string - - // The time, in milliseconds since the epoch, when the definition was created. - CreationTimestamp *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_CreateFunctionDefinitionVersion.go b/service/greengrass/api_op_CreateFunctionDefinitionVersion.go index 01cd99f14f5..d6adb6724a0 100644 --- a/service/greengrass/api_op_CreateFunctionDefinitionVersion.go +++ b/service/greengrass/api_op_CreateFunctionDefinitionVersion.go @@ -58,10 +58,6 @@ func (c *Client) CreateFunctionDefinitionVersion(ctx context.Context, params *Cr // Information needed to create a function definition version. type CreateFunctionDefinitionVersionInput struct { - // The default configuration that applies to all Lambda functions in this function - // definition version. Individual Lambda functions can override these settings. - DefaultConfig *types.FunctionDefaultConfig - // The ID of the Lambda function definition. // // This member is required. @@ -70,18 +66,22 @@ type CreateFunctionDefinitionVersionInput struct { // A client token used to correlate requests and responses. AmznClientToken *string + // The default configuration that applies to all Lambda functions in this function + // definition version. Individual Lambda functions can override these settings. + DefaultConfig *types.FunctionDefaultConfig + // A list of Lambda functions in this function definition version. Functions []*types.Function } type CreateFunctionDefinitionVersionOutput struct { - // The time, in milliseconds since the epoch, when the version was created. - CreationTimestamp *string - // The ARN of the version. Arn *string + // The time, in milliseconds since the epoch, when the version was created. + CreationTimestamp *string + // The ID of the parent definition that the version is associated with. Id *string diff --git a/service/greengrass/api_op_CreateGroup.go b/service/greengrass/api_op_CreateGroup.go index d48def458ae..632e5a86216 100644 --- a/service/greengrass/api_op_CreateGroup.go +++ b/service/greengrass/api_op_CreateGroup.go @@ -59,41 +59,41 @@ func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optF type CreateGroupInput struct { - // The name of the group. - Name *string + // A client token used to correlate requests and responses. + AmznClientToken *string // Information about the initial version of the group. InitialVersion *types.GroupVersion + // The name of the group. + Name *string + // Tag(s) to add to the new resource. Tags map[string]*string - - // A client token used to correlate requests and responses. - AmznClientToken *string } type CreateGroupOutput struct { - // The time, in milliseconds since the epoch, when the definition was last updated. - LastUpdatedTimestamp *string + // The ARN of the definition. + Arn *string + + // The time, in milliseconds since the epoch, when the definition was created. + CreationTimestamp *string // The ID of the definition. Id *string - // The ARN of the definition. - Arn *string + // The time, in milliseconds since the epoch, when the definition was last updated. + LastUpdatedTimestamp *string // The ID of the latest version associated with the definition. LatestVersion *string - // The name of the definition. - Name *string - // The ARN of the latest version associated with the definition. LatestVersionArn *string - // The time, in milliseconds since the epoch, when the definition was created. - CreationTimestamp *string + // The name of the definition. + Name *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/greengrass/api_op_CreateGroupVersion.go b/service/greengrass/api_op_CreateGroupVersion.go index 01097b9dc79..c5dc9094e6b 100644 --- a/service/greengrass/api_op_CreateGroupVersion.go +++ b/service/greengrass/api_op_CreateGroupVersion.go @@ -61,29 +61,29 @@ type CreateGroupVersionInput struct { // This member is required. GroupId *string - // The ARN of the device definition version for this group. - DeviceDefinitionVersionArn *string + // A client token used to correlate requests and responses. + AmznClientToken *string + + // The ARN of the connector definition version for this group. + ConnectorDefinitionVersionArn *string // The ARN of the core definition version for this group. CoreDefinitionVersionArn *string - // A client token used to correlate requests and responses. - AmznClientToken *string + // The ARN of the device definition version for this group. + DeviceDefinitionVersionArn *string // The ARN of the function definition version for this group. FunctionDefinitionVersionArn *string - // The ARN of the connector definition version for this group. - ConnectorDefinitionVersionArn *string + // The ARN of the logger definition version for this group. + LoggerDefinitionVersionArn *string // The ARN of the resource definition version for this group. ResourceDefinitionVersionArn *string // The ARN of the subscription definition version for this group. SubscriptionDefinitionVersionArn *string - - // The ARN of the logger definition version for this group. - LoggerDefinitionVersionArn *string } type CreateGroupVersionOutput struct { @@ -91,14 +91,14 @@ type CreateGroupVersionOutput struct { // The ARN of the version. Arn *string - // The ID of the version. - Version *string + // The time, in milliseconds since the epoch, when the version was created. + CreationTimestamp *string // The ID of the parent definition that the version is associated with. Id *string - // The time, in milliseconds since the epoch, when the version was created. - CreationTimestamp *string + // The ID of the version. + Version *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/greengrass/api_op_CreateLoggerDefinition.go b/service/greengrass/api_op_CreateLoggerDefinition.go index 4d8aa287229..ae70b0f5966 100644 --- a/service/greengrass/api_op_CreateLoggerDefinition.go +++ b/service/greengrass/api_op_CreateLoggerDefinition.go @@ -58,27 +58,21 @@ func (c *Client) CreateLoggerDefinition(ctx context.Context, params *CreateLogge type CreateLoggerDefinitionInput struct { + // A client token used to correlate requests and responses. + AmznClientToken *string + // Information about the initial version of the logger definition. InitialVersion *types.LoggerDefinitionVersion // The name of the logger definition. Name *string - // A client token used to correlate requests and responses. - AmznClientToken *string - // Tag(s) to add to the new resource. Tags map[string]*string } type CreateLoggerDefinitionOutput struct { - // The name of the definition. - Name *string - - // The time, in milliseconds since the epoch, when the definition was last updated. - LastUpdatedTimestamp *string - // The ARN of the definition. Arn *string @@ -88,12 +82,18 @@ type CreateLoggerDefinitionOutput struct { // The ID of the definition. Id *string - // The ARN of the latest version associated with the definition. - LatestVersionArn *string + // The time, in milliseconds since the epoch, when the definition was last updated. + LastUpdatedTimestamp *string // The ID of the latest version associated with the definition. LatestVersion *string + // The ARN of the latest version associated with the definition. + LatestVersionArn *string + + // The name of the definition. + Name *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_CreateLoggerDefinitionVersion.go b/service/greengrass/api_op_CreateLoggerDefinitionVersion.go index 6c15c70a486..88b9d4894e0 100644 --- a/service/greengrass/api_op_CreateLoggerDefinitionVersion.go +++ b/service/greengrass/api_op_CreateLoggerDefinitionVersion.go @@ -62,11 +62,11 @@ type CreateLoggerDefinitionVersionInput struct { // This member is required. LoggerDefinitionId *string - // A list of loggers. - Loggers []*types.Logger - // A client token used to correlate requests and responses. AmznClientToken *string + + // A list of loggers. + Loggers []*types.Logger } type CreateLoggerDefinitionVersionOutput struct { @@ -74,14 +74,14 @@ type CreateLoggerDefinitionVersionOutput struct { // The ARN of the version. Arn *string - // The ID of the version. - Version *string + // The time, in milliseconds since the epoch, when the version was created. + CreationTimestamp *string // The ID of the parent definition that the version is associated with. Id *string - // The time, in milliseconds since the epoch, when the version was created. - CreationTimestamp *string + // The ID of the version. + Version *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/greengrass/api_op_CreateResourceDefinition.go b/service/greengrass/api_op_CreateResourceDefinition.go index a071fe5864d..b708a041374 100644 --- a/service/greengrass/api_op_CreateResourceDefinition.go +++ b/service/greengrass/api_op_CreateResourceDefinition.go @@ -59,42 +59,42 @@ func (c *Client) CreateResourceDefinition(ctx context.Context, params *CreateRes type CreateResourceDefinitionInput struct { + // A client token used to correlate requests and responses. + AmznClientToken *string + + // Information about the initial version of the resource definition. + InitialVersion *types.ResourceDefinitionVersion + // The name of the resource definition. Name *string // Tag(s) to add to the new resource. Tags map[string]*string - - // Information about the initial version of the resource definition. - InitialVersion *types.ResourceDefinitionVersion - - // A client token used to correlate requests and responses. - AmznClientToken *string } type CreateResourceDefinitionOutput struct { + // The ARN of the definition. + Arn *string + // The time, in milliseconds since the epoch, when the definition was created. CreationTimestamp *string - // The ID of the latest version associated with the definition. - LatestVersion *string + // The ID of the definition. + Id *string // The time, in milliseconds since the epoch, when the definition was last updated. LastUpdatedTimestamp *string + // The ID of the latest version associated with the definition. + LatestVersion *string + // The ARN of the latest version associated with the definition. LatestVersionArn *string - // The ID of the definition. - Id *string - // The name of the definition. Name *string - // The ARN of the definition. - Arn *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_CreateResourceDefinitionVersion.go b/service/greengrass/api_op_CreateResourceDefinitionVersion.go index 2fe983985e7..e6464ce671d 100644 --- a/service/greengrass/api_op_CreateResourceDefinitionVersion.go +++ b/service/greengrass/api_op_CreateResourceDefinitionVersion.go @@ -57,14 +57,14 @@ func (c *Client) CreateResourceDefinitionVersion(ctx context.Context, params *Cr type CreateResourceDefinitionVersionInput struct { - // A client token used to correlate requests and responses. - AmznClientToken *string - // The ID of the resource definition. // // This member is required. ResourceDefinitionId *string + // A client token used to correlate requests and responses. + AmznClientToken *string + // A list of resources. Resources []*types.Resource } diff --git a/service/greengrass/api_op_CreateSoftwareUpdateJob.go b/service/greengrass/api_op_CreateSoftwareUpdateJob.go index 9aab323e17b..e5cd4e79746 100644 --- a/service/greengrass/api_op_CreateSoftwareUpdateJob.go +++ b/service/greengrass/api_op_CreateSoftwareUpdateJob.go @@ -60,24 +60,17 @@ func (c *Client) CreateSoftwareUpdateJob(ctx context.Context, params *CreateSoft type CreateSoftwareUpdateJobInput struct { - // The operating system of the cores which are the targets of an update. - // - // This member is required. - UpdateTargetsOperatingSystem types.UpdateTargetsOperatingSystem - - // The minimum level of log statements that should be logged by the OTA Agent - // during an update. - UpdateAgentLogLevel types.UpdateAgentLogLevel - - // A client token used to correlate requests and responses. - AmznClientToken *string - // The IAM Role that Greengrass will use to create pre-signed URLs pointing towards // the update artifact. // // This member is required. S3UrlSignerRole *string + // The piece of software on the Greengrass core that will be updated. + // + // This member is required. + SoftwareToUpdate types.SoftwareToUpdate + // The ARNs of the targets (IoT things or IoT thing groups) that this update will // be applied to. // @@ -89,23 +82,30 @@ type CreateSoftwareUpdateJobInput struct { // This member is required. UpdateTargetsArchitecture types.UpdateTargetsArchitecture - // The piece of software on the Greengrass core that will be updated. + // The operating system of the cores which are the targets of an update. // // This member is required. - SoftwareToUpdate types.SoftwareToUpdate + UpdateTargetsOperatingSystem types.UpdateTargetsOperatingSystem + + // A client token used to correlate requests and responses. + AmznClientToken *string + + // The minimum level of log statements that should be logged by the OTA Agent + // during an update. + UpdateAgentLogLevel types.UpdateAgentLogLevel } type CreateSoftwareUpdateJobOutput struct { - // The software version installed on the device or devices after the update. - PlatformSoftwareVersion *string - // The IoT Job ARN corresponding to this update. IotJobArn *string // The IoT Job Id corresponding to this update. IotJobId *string + // The software version installed on the device or devices after the update. + PlatformSoftwareVersion *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_CreateSubscriptionDefinition.go b/service/greengrass/api_op_CreateSubscriptionDefinition.go index b0a3e449b99..e13dc8ceae2 100644 --- a/service/greengrass/api_op_CreateSubscriptionDefinition.go +++ b/service/greengrass/api_op_CreateSubscriptionDefinition.go @@ -59,41 +59,41 @@ func (c *Client) CreateSubscriptionDefinition(ctx context.Context, params *Creat type CreateSubscriptionDefinitionInput struct { + // A client token used to correlate requests and responses. + AmznClientToken *string + + // Information about the initial version of the subscription definition. + InitialVersion *types.SubscriptionDefinitionVersion + // The name of the subscription definition. Name *string // Tag(s) to add to the new resource. Tags map[string]*string - - // Information about the initial version of the subscription definition. - InitialVersion *types.SubscriptionDefinitionVersion - - // A client token used to correlate requests and responses. - AmznClientToken *string } type CreateSubscriptionDefinitionOutput struct { + // The ARN of the definition. + Arn *string + // The time, in milliseconds since the epoch, when the definition was created. CreationTimestamp *string - // The name of the definition. - Name *string + // The ID of the definition. + Id *string - // The ARN of the latest version associated with the definition. - LatestVersionArn *string + // The time, in milliseconds since the epoch, when the definition was last updated. + LastUpdatedTimestamp *string // The ID of the latest version associated with the definition. LatestVersion *string - // The ARN of the definition. - Arn *string - - // The ID of the definition. - Id *string + // The ARN of the latest version associated with the definition. + LatestVersionArn *string - // The time, in milliseconds since the epoch, when the definition was last updated. - LastUpdatedTimestamp *string + // The name of the definition. + Name *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/greengrass/api_op_CreateSubscriptionDefinitionVersion.go b/service/greengrass/api_op_CreateSubscriptionDefinitionVersion.go index c48d7772b81..9b40f94140e 100644 --- a/service/greengrass/api_op_CreateSubscriptionDefinitionVersion.go +++ b/service/greengrass/api_op_CreateSubscriptionDefinitionVersion.go @@ -57,9 +57,6 @@ func (c *Client) CreateSubscriptionDefinitionVersion(ctx context.Context, params type CreateSubscriptionDefinitionVersionInput struct { - // A list of subscriptions. - Subscriptions []*types.Subscription - // The ID of the subscription definition. // // This member is required. @@ -67,6 +64,9 @@ type CreateSubscriptionDefinitionVersionInput struct { // A client token used to correlate requests and responses. AmznClientToken *string + + // A list of subscriptions. + Subscriptions []*types.Subscription } type CreateSubscriptionDefinitionVersionOutput struct { diff --git a/service/greengrass/api_op_GetAssociatedRole.go b/service/greengrass/api_op_GetAssociatedRole.go index 20dd8f3b136..970bfa4dba5 100644 --- a/service/greengrass/api_op_GetAssociatedRole.go +++ b/service/greengrass/api_op_GetAssociatedRole.go @@ -64,12 +64,12 @@ type GetAssociatedRoleInput struct { type GetAssociatedRoleOutput struct { - // The ARN of the role that is associated with the group. - RoleArn *string - // The time when the role was associated with the group. AssociatedAt *string + // The ARN of the role that is associated with the group. + RoleArn *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_GetBulkDeploymentStatus.go b/service/greengrass/api_op_GetBulkDeploymentStatus.go index e89e113d947..b3325bdd6e0 100644 --- a/service/greengrass/api_op_GetBulkDeploymentStatus.go +++ b/service/greengrass/api_op_GetBulkDeploymentStatus.go @@ -65,24 +65,24 @@ type GetBulkDeploymentStatusInput struct { type GetBulkDeploymentStatusOutput struct { - // Tag(s) attached to the resource arn. - Tags map[string]*string - - // The time, in ISO format, when the deployment was created. - CreatedAt *string - - // Error message - ErrorMessage *string + // Relevant metrics on input records processed during bulk deployment. + BulkDeploymentMetrics *types.BulkDeploymentMetrics // The status of the bulk deployment. BulkDeploymentStatus types.BulkDeploymentStatus - // Relevant metrics on input records processed during bulk deployment. - BulkDeploymentMetrics *types.BulkDeploymentMetrics + // The time, in ISO format, when the deployment was created. + CreatedAt *string // Error details ErrorDetails []*types.ErrorDetail + // Error message + ErrorMessage *string + + // Tag(s) attached to the resource arn. + Tags map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_GetConnectivityInfo.go b/service/greengrass/api_op_GetConnectivityInfo.go index d7cc0dd6af5..c4643fba583 100644 --- a/service/greengrass/api_op_GetConnectivityInfo.go +++ b/service/greengrass/api_op_GetConnectivityInfo.go @@ -65,12 +65,12 @@ type GetConnectivityInfoInput struct { type GetConnectivityInfoOutput struct { - // A message about the connectivity info request. - Message *string - // Connectivity info list. ConnectivityInfo []*types.ConnectivityInfo + // A message about the connectivity info request. + Message *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_GetConnectorDefinition.go b/service/greengrass/api_op_GetConnectorDefinition.go index 16ed292734a..cbbbcc4df74 100644 --- a/service/greengrass/api_op_GetConnectorDefinition.go +++ b/service/greengrass/api_op_GetConnectorDefinition.go @@ -64,11 +64,8 @@ type GetConnectorDefinitionInput struct { type GetConnectorDefinitionOutput struct { - // Tag(s) attached to the resource arn. - Tags map[string]*string - - // The ARN of the latest version associated with the definition. - LatestVersionArn *string + // The ARN of the definition. + Arn *string // The time, in milliseconds since the epoch, when the definition was created. CreationTimestamp *string @@ -76,17 +73,20 @@ type GetConnectorDefinitionOutput struct { // The ID of the definition. Id *string - // The ARN of the definition. - Arn *string - // The time, in milliseconds since the epoch, when the definition was last updated. LastUpdatedTimestamp *string + // The ID of the latest version associated with the definition. + LatestVersion *string + + // The ARN of the latest version associated with the definition. + LatestVersionArn *string + // The name of the definition. Name *string - // The ID of the latest version associated with the definition. - LatestVersion *string + // Tag(s) attached to the resource arn. + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/greengrass/api_op_GetConnectorDefinitionVersion.go b/service/greengrass/api_op_GetConnectorDefinitionVersion.go index d2a08011e57..07c67d47950 100644 --- a/service/greengrass/api_op_GetConnectorDefinitionVersion.go +++ b/service/greengrass/api_op_GetConnectorDefinitionVersion.go @@ -60,6 +60,11 @@ func (c *Client) GetConnectorDefinitionVersion(ctx context.Context, params *GetC type GetConnectorDefinitionVersionInput struct { + // The ID of the connector definition. + // + // This member is required. + ConnectorDefinitionId *string + // The ID of the connector definition version. This value maps to the ''Version'' // property of the corresponding ''VersionInformation'' object, which is returned // by ''ListConnectorDefinitionVersions'' requests. If the version is the last one @@ -73,35 +78,30 @@ type GetConnectorDefinitionVersionInput struct { // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string - - // The ID of the connector definition. - // - // This member is required. - ConnectorDefinitionId *string } type GetConnectorDefinitionVersionOutput struct { + // The ARN of the connector definition version. + Arn *string + // The time, in milliseconds since the epoch, when the connector definition version // was created. CreationTimestamp *string - // The ID of the connector definition version. - Id *string - - // The ARN of the connector definition version. - Arn *string - // Information about the connector definition version. Definition *types.ConnectorDefinitionVersion - // The version of the connector definition version. - Version *string + // The ID of the connector definition version. + Id *string // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string + // The version of the connector definition version. + Version *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_GetCoreDefinition.go b/service/greengrass/api_op_GetCoreDefinition.go index 11abd8795e4..1d0537cfb65 100644 --- a/service/greengrass/api_op_GetCoreDefinition.go +++ b/service/greengrass/api_op_GetCoreDefinition.go @@ -67,20 +67,20 @@ type GetCoreDefinitionOutput struct { // The ARN of the definition. Arn *string + // The time, in milliseconds since the epoch, when the definition was created. + CreationTimestamp *string + // The ID of the definition. Id *string // The time, in milliseconds since the epoch, when the definition was last updated. LastUpdatedTimestamp *string - // The ARN of the latest version associated with the definition. - LatestVersionArn *string - // The ID of the latest version associated with the definition. LatestVersion *string - // The time, in milliseconds since the epoch, when the definition was created. - CreationTimestamp *string + // The ARN of the latest version associated with the definition. + LatestVersionArn *string // The name of the definition. Name *string diff --git a/service/greengrass/api_op_GetCoreDefinitionVersion.go b/service/greengrass/api_op_GetCoreDefinitionVersion.go index d6df288b7a2..857bf9c188d 100644 --- a/service/greengrass/api_op_GetCoreDefinitionVersion.go +++ b/service/greengrass/api_op_GetCoreDefinitionVersion.go @@ -75,19 +75,16 @@ type GetCoreDefinitionVersionInput struct { type GetCoreDefinitionVersionOutput struct { + // The ARN of the core definition version. + Arn *string + // The time, in milliseconds since the epoch, when the core definition version was // created. CreationTimestamp *string - // The ARN of the core definition version. - Arn *string - // Information about the core definition version. Definition *types.CoreDefinitionVersion - // The version of the core definition version. - Version *string - // The ID of the core definition version. Id *string @@ -95,6 +92,9 @@ type GetCoreDefinitionVersionOutput struct { // results. NextToken *string + // The version of the core definition version. + Version *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_GetDeploymentStatus.go b/service/greengrass/api_op_GetDeploymentStatus.go index 43964ba71f2..d772d75543f 100644 --- a/service/greengrass/api_op_GetDeploymentStatus.go +++ b/service/greengrass/api_op_GetDeploymentStatus.go @@ -70,6 +70,10 @@ type GetDeploymentStatusInput struct { type GetDeploymentStatusOutput struct { + // The status of the deployment: ''InProgress'', ''Building'', ''Success'', or + // ''Failure''. + DeploymentStatus *string + // The type of the deployment. DeploymentType types.DeploymentType @@ -83,10 +87,6 @@ type GetDeploymentStatusOutput struct { // updated. UpdatedAt *string - // The status of the deployment: ''InProgress'', ''Building'', ''Success'', or - // ''Failure''. - DeploymentStatus *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_GetDeviceDefinition.go b/service/greengrass/api_op_GetDeviceDefinition.go index f3f6f8517ee..d2e31ff4a5c 100644 --- a/service/greengrass/api_op_GetDeviceDefinition.go +++ b/service/greengrass/api_op_GetDeviceDefinition.go @@ -64,30 +64,30 @@ type GetDeviceDefinitionInput struct { type GetDeviceDefinitionOutput struct { + // The ARN of the definition. + Arn *string + + // The time, in milliseconds since the epoch, when the definition was created. + CreationTimestamp *string + // The ID of the definition. Id *string // The time, in milliseconds since the epoch, when the definition was last updated. LastUpdatedTimestamp *string - // The ARN of the definition. - Arn *string - // The ID of the latest version associated with the definition. LatestVersion *string // The ARN of the latest version associated with the definition. LatestVersionArn *string - // Tag(s) attached to the resource arn. - Tags map[string]*string - - // The time, in milliseconds since the epoch, when the definition was created. - CreationTimestamp *string - // The name of the definition. Name *string + // Tag(s) attached to the resource arn. + Tags map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_GetDeviceDefinitionVersion.go b/service/greengrass/api_op_GetDeviceDefinitionVersion.go index 18da12cb2f1..1f83e79a504 100644 --- a/service/greengrass/api_op_GetDeviceDefinitionVersion.go +++ b/service/greengrass/api_op_GetDeviceDefinitionVersion.go @@ -57,6 +57,11 @@ func (c *Client) GetDeviceDefinitionVersion(ctx context.Context, params *GetDevi type GetDeviceDefinitionVersionInput struct { + // The ID of the device definition. + // + // This member is required. + DeviceDefinitionId *string + // The ID of the device definition version. This value maps to the ''Version'' // property of the corresponding ''VersionInformation'' object, which is returned // by ''ListDeviceDefinitionVersions'' requests. If the version is the last one @@ -70,34 +75,29 @@ type GetDeviceDefinitionVersionInput struct { // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string - - // The ID of the device definition. - // - // This member is required. - DeviceDefinitionId *string } type GetDeviceDefinitionVersionOutput struct { - // The version of the device definition version. - Version *string - - // The ID of the device definition version. - Id *string + // The ARN of the device definition version. + Arn *string // The time, in milliseconds since the epoch, when the device definition version // was created. CreationTimestamp *string + // Information about the device definition version. + Definition *types.DeviceDefinitionVersion + + // The ID of the device definition version. + Id *string + // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string - // Information about the device definition version. - Definition *types.DeviceDefinitionVersion - - // The ARN of the device definition version. - Arn *string + // The version of the device definition version. + Version *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/greengrass/api_op_GetFunctionDefinition.go b/service/greengrass/api_op_GetFunctionDefinition.go index c1816a36323..d7f370d4921 100644 --- a/service/greengrass/api_op_GetFunctionDefinition.go +++ b/service/greengrass/api_op_GetFunctionDefinition.go @@ -65,6 +65,12 @@ type GetFunctionDefinitionInput struct { type GetFunctionDefinitionOutput struct { + // The ARN of the definition. + Arn *string + + // The time, in milliseconds since the epoch, when the definition was created. + CreationTimestamp *string + // The ID of the definition. Id *string @@ -74,20 +80,14 @@ type GetFunctionDefinitionOutput struct { // The ID of the latest version associated with the definition. LatestVersion *string - // Tag(s) attached to the resource arn. - Tags map[string]*string - - // The time, in milliseconds since the epoch, when the definition was created. - CreationTimestamp *string - // The ARN of the latest version associated with the definition. LatestVersionArn *string // The name of the definition. Name *string - // The ARN of the definition. - Arn *string + // Tag(s) attached to the resource arn. + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/greengrass/api_op_GetFunctionDefinitionVersion.go b/service/greengrass/api_op_GetFunctionDefinitionVersion.go index 5b7b2215bd3..86318edfcba 100644 --- a/service/greengrass/api_op_GetFunctionDefinitionVersion.go +++ b/service/greengrass/api_op_GetFunctionDefinitionVersion.go @@ -58,6 +58,11 @@ func (c *Client) GetFunctionDefinitionVersion(ctx context.Context, params *GetFu type GetFunctionDefinitionVersionInput struct { + // The ID of the Lambda function definition. + // + // This member is required. + FunctionDefinitionId *string + // The ID of the function definition version. This value maps to the ''Version'' // property of the corresponding ''VersionInformation'' object, which is returned // by ''ListFunctionDefinitionVersions'' requests. If the version is the last one @@ -71,34 +76,29 @@ type GetFunctionDefinitionVersionInput struct { // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string - - // The ID of the Lambda function definition. - // - // This member is required. - FunctionDefinitionId *string } type GetFunctionDefinitionVersionOutput struct { - // The ID of the function definition version. - Id *string + // The ARN of the function definition version. + Arn *string + + // The time, in milliseconds since the epoch, when the function definition version + // was created. + CreationTimestamp *string // Information on the definition. Definition *types.FunctionDefinitionVersion - // The ARN of the function definition version. - Arn *string - - // The version of the function definition version. - Version *string + // The ID of the function definition version. + Id *string // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string - // The time, in milliseconds since the epoch, when the function definition version - // was created. - CreationTimestamp *string + // The version of the function definition version. + Version *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/greengrass/api_op_GetGroup.go b/service/greengrass/api_op_GetGroup.go index 5121beca372..8f2f796055b 100644 --- a/service/greengrass/api_op_GetGroup.go +++ b/service/greengrass/api_op_GetGroup.go @@ -64,30 +64,30 @@ type GetGroupInput struct { type GetGroupOutput struct { - // The time, in milliseconds since the epoch, when the definition was last updated. - LastUpdatedTimestamp *string - - // The ID of the definition. - Id *string + // The ARN of the definition. + Arn *string // The time, in milliseconds since the epoch, when the definition was created. CreationTimestamp *string - // The ARN of the latest version associated with the definition. - LatestVersionArn *string + // The ID of the definition. + Id *string + + // The time, in milliseconds since the epoch, when the definition was last updated. + LastUpdatedTimestamp *string // The ID of the latest version associated with the definition. LatestVersion *string - // Tag(s) attached to the resource arn. - Tags map[string]*string - - // The ARN of the definition. - Arn *string + // The ARN of the latest version associated with the definition. + LatestVersionArn *string // The name of the definition. Name *string + // Tag(s) attached to the resource arn. + Tags map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_GetGroupCertificateAuthority.go b/service/greengrass/api_op_GetGroupCertificateAuthority.go index d29e3bcd392..a86b9543c38 100644 --- a/service/greengrass/api_op_GetGroupCertificateAuthority.go +++ b/service/greengrass/api_op_GetGroupCertificateAuthority.go @@ -72,12 +72,12 @@ type GetGroupCertificateAuthorityOutput struct { // The ARN of the certificate authority for the group. GroupCertificateAuthorityArn *string - // The PEM encoded certificate for the group. - PemEncodedCertificate *string - // The ID of the certificate authority for the group. GroupCertificateAuthorityId *string + // The PEM encoded certificate for the group. + PemEncodedCertificate *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_GetGroupCertificateConfiguration.go b/service/greengrass/api_op_GetGroupCertificateConfiguration.go index e8e458f7e9c..55307ffe8be 100644 --- a/service/greengrass/api_op_GetGroupCertificateConfiguration.go +++ b/service/greengrass/api_op_GetGroupCertificateConfiguration.go @@ -64,13 +64,13 @@ type GetGroupCertificateConfigurationInput struct { type GetGroupCertificateConfigurationOutput struct { - // The amount of time remaining before the certificate expires, in milliseconds. - CertificateExpiryInMilliseconds *string - // The amount of time remaining before the certificate authority expires, in // milliseconds. CertificateAuthorityExpiryInMilliseconds *string + // The amount of time remaining before the certificate expires, in milliseconds. + CertificateExpiryInMilliseconds *string + // The ID of the group certificate configuration. GroupId *string diff --git a/service/greengrass/api_op_GetGroupVersion.go b/service/greengrass/api_op_GetGroupVersion.go index b8d43cca253..378369a3cb7 100644 --- a/service/greengrass/api_op_GetGroupVersion.go +++ b/service/greengrass/api_op_GetGroupVersion.go @@ -74,21 +74,21 @@ type GetGroupVersionInput struct { type GetGroupVersionOutput struct { - // The ID of the group version. - Version *string - - // Information about the group version definition. - Definition *types.GroupVersion - // The ARN of the group version. Arn *string // The time, in milliseconds since the epoch, when the group version was created. CreationTimestamp *string + // Information about the group version definition. + Definition *types.GroupVersion + // The ID of the group that the version is associated with. Id *string + // The ID of the group version. + Version *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_GetLoggerDefinition.go b/service/greengrass/api_op_GetLoggerDefinition.go index 703e715ed75..a16f34a400f 100644 --- a/service/greengrass/api_op_GetLoggerDefinition.go +++ b/service/greengrass/api_op_GetLoggerDefinition.go @@ -64,29 +64,29 @@ type GetLoggerDefinitionInput struct { type GetLoggerDefinitionOutput struct { + // The ARN of the definition. + Arn *string + // The time, in milliseconds since the epoch, when the definition was created. CreationTimestamp *string - // The name of the definition. - Name *string - - // The ARN of the latest version associated with the definition. - LatestVersionArn *string - - // Tag(s) attached to the resource arn. - Tags map[string]*string - // The ID of the definition. Id *string - // The ARN of the definition. - Arn *string + // The time, in milliseconds since the epoch, when the definition was last updated. + LastUpdatedTimestamp *string // The ID of the latest version associated with the definition. LatestVersion *string - // The time, in milliseconds since the epoch, when the definition was last updated. - LastUpdatedTimestamp *string + // The ARN of the latest version associated with the definition. + LatestVersionArn *string + + // The name of the definition. + Name *string + + // Tag(s) attached to the resource arn. + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/greengrass/api_op_GetLoggerDefinitionVersion.go b/service/greengrass/api_op_GetLoggerDefinitionVersion.go index 357020afda4..dda419187c1 100644 --- a/service/greengrass/api_op_GetLoggerDefinitionVersion.go +++ b/service/greengrass/api_op_GetLoggerDefinitionVersion.go @@ -62,10 +62,6 @@ type GetLoggerDefinitionVersionInput struct { // This member is required. LoggerDefinitionId *string - // The token for the next set of results, or ''null'' if there are no additional - // results. - NextToken *string - // The ID of the logger definition version. This value maps to the ''Version'' // property of the corresponding ''VersionInformation'' object, which is returned // by ''ListLoggerDefinitionVersions'' requests. If the version is the last one @@ -75,26 +71,30 @@ type GetLoggerDefinitionVersionInput struct { // // This member is required. LoggerDefinitionVersionId *string + + // The token for the next set of results, or ''null'' if there are no additional + // results. + NextToken *string } type GetLoggerDefinitionVersionOutput struct { - // The version of the logger definition version. - Version *string - - // The ID of the logger definition version. - Id *string - // The ARN of the logger definition version. Arn *string - // Information about the logger definition version. - Definition *types.LoggerDefinitionVersion - // The time, in milliseconds since the epoch, when the logger definition version // was created. CreationTimestamp *string + // Information about the logger definition version. + Definition *types.LoggerDefinitionVersion + + // The ID of the logger definition version. + Id *string + + // The version of the logger definition version. + Version *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_GetResourceDefinition.go b/service/greengrass/api_op_GetResourceDefinition.go index c8ef14c003f..eb9f2671cbf 100644 --- a/service/greengrass/api_op_GetResourceDefinition.go +++ b/service/greengrass/api_op_GetResourceDefinition.go @@ -68,8 +68,8 @@ type GetResourceDefinitionOutput struct { // The ARN of the definition. Arn *string - // The ID of the latest version associated with the definition. - LatestVersion *string + // The time, in milliseconds since the epoch, when the definition was created. + CreationTimestamp *string // The ID of the definition. Id *string @@ -77,12 +77,12 @@ type GetResourceDefinitionOutput struct { // The time, in milliseconds since the epoch, when the definition was last updated. LastUpdatedTimestamp *string + // The ID of the latest version associated with the definition. + LatestVersion *string + // The ARN of the latest version associated with the definition. LatestVersionArn *string - // The time, in milliseconds since the epoch, when the definition was created. - CreationTimestamp *string - // The name of the definition. Name *string diff --git a/service/greengrass/api_op_GetResourceDefinitionVersion.go b/service/greengrass/api_op_GetResourceDefinitionVersion.go index 86917553144..36128bf023c 100644 --- a/service/greengrass/api_op_GetResourceDefinitionVersion.go +++ b/service/greengrass/api_op_GetResourceDefinitionVersion.go @@ -58,6 +58,11 @@ func (c *Client) GetResourceDefinitionVersion(ctx context.Context, params *GetRe type GetResourceDefinitionVersionInput struct { + // The ID of the resource definition. + // + // This member is required. + ResourceDefinitionId *string + // The ID of the resource definition version. This value maps to the ''Version'' // property of the corresponding ''VersionInformation'' object, which is returned // by ''ListResourceDefinitionVersions'' requests. If the version is the last one @@ -67,22 +72,17 @@ type GetResourceDefinitionVersionInput struct { // // This member is required. ResourceDefinitionVersionId *string - - // The ID of the resource definition. - // - // This member is required. - ResourceDefinitionId *string } type GetResourceDefinitionVersionOutput struct { + // Arn of the resource definition version. + Arn *string + // The time, in milliseconds since the epoch, when the resource definition version // was created. CreationTimestamp *string - // Arn of the resource definition version. - Arn *string - // Information about the definition. Definition *types.ResourceDefinitionVersion diff --git a/service/greengrass/api_op_GetServiceRoleForAccount.go b/service/greengrass/api_op_GetServiceRoleForAccount.go index 3d7b9e97871..cc1efaf1a75 100644 --- a/service/greengrass/api_op_GetServiceRoleForAccount.go +++ b/service/greengrass/api_op_GetServiceRoleForAccount.go @@ -58,12 +58,12 @@ type GetServiceRoleForAccountInput struct { type GetServiceRoleForAccountOutput struct { - // The ARN of the role which is associated with the account. - RoleArn *string - // The time when the service role was associated with the account. AssociatedAt *string + // The ARN of the role which is associated with the account. + RoleArn *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_GetSubscriptionDefinition.go b/service/greengrass/api_op_GetSubscriptionDefinition.go index fc68112ca1d..2958f46bf32 100644 --- a/service/greengrass/api_op_GetSubscriptionDefinition.go +++ b/service/greengrass/api_op_GetSubscriptionDefinition.go @@ -64,26 +64,26 @@ type GetSubscriptionDefinitionInput struct { type GetSubscriptionDefinitionOutput struct { - // The ID of the latest version associated with the definition. - LatestVersion *string + // The ARN of the definition. + Arn *string + + // The time, in milliseconds since the epoch, when the definition was created. + CreationTimestamp *string // The ID of the definition. Id *string - // The ARN of the latest version associated with the definition. - LatestVersionArn *string - // The time, in milliseconds since the epoch, when the definition was last updated. LastUpdatedTimestamp *string - // The name of the definition. - Name *string + // The ID of the latest version associated with the definition. + LatestVersion *string - // The time, in milliseconds since the epoch, when the definition was created. - CreationTimestamp *string + // The ARN of the latest version associated with the definition. + LatestVersionArn *string - // The ARN of the definition. - Arn *string + // The name of the definition. + Name *string // Tag(s) attached to the resource arn. Tags map[string]*string diff --git a/service/greengrass/api_op_GetSubscriptionDefinitionVersion.go b/service/greengrass/api_op_GetSubscriptionDefinitionVersion.go index efb73fb6183..ebf298b0b85 100644 --- a/service/greengrass/api_op_GetSubscriptionDefinitionVersion.go +++ b/service/greengrass/api_op_GetSubscriptionDefinitionVersion.go @@ -57,10 +57,6 @@ func (c *Client) GetSubscriptionDefinitionVersion(ctx context.Context, params *G type GetSubscriptionDefinitionVersionInput struct { - // The token for the next set of results, or ''null'' if there are no additional - // results. - NextToken *string - // The ID of the subscription definition. // // This member is required. @@ -75,23 +71,27 @@ type GetSubscriptionDefinitionVersionInput struct { // // This member is required. SubscriptionDefinitionVersionId *string + + // The token for the next set of results, or ''null'' if there are no additional + // results. + NextToken *string } type GetSubscriptionDefinitionVersionOutput struct { - // The ID of the subscription definition version. - Id *string - // The ARN of the subscription definition version. Arn *string - // Information about the subscription definition version. - Definition *types.SubscriptionDefinitionVersion - // The time, in milliseconds since the epoch, when the subscription definition // version was created. CreationTimestamp *string + // Information about the subscription definition version. + Definition *types.SubscriptionDefinitionVersion + + // The ID of the subscription definition version. + Id *string + // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string diff --git a/service/greengrass/api_op_ListBulkDeploymentDetailedReports.go b/service/greengrass/api_op_ListBulkDeploymentDetailedReports.go index b1f85b954da..7468933ea4c 100644 --- a/service/greengrass/api_op_ListBulkDeploymentDetailedReports.go +++ b/service/greengrass/api_op_ListBulkDeploymentDetailedReports.go @@ -58,17 +58,17 @@ func (c *Client) ListBulkDeploymentDetailedReports(ctx context.Context, params * type ListBulkDeploymentDetailedReportsInput struct { - // The token for the next set of results, or ''null'' if there are no additional - // results. - NextToken *string - - // The maximum number of results to be returned per request. - MaxResults *string - // The ID of the bulk deployment. // // This member is required. BulkDeploymentId *string + + // The maximum number of results to be returned per request. + MaxResults *string + + // The token for the next set of results, or ''null'' if there are no additional + // results. + NextToken *string } type ListBulkDeploymentDetailedReportsOutput struct { diff --git a/service/greengrass/api_op_ListBulkDeployments.go b/service/greengrass/api_op_ListBulkDeployments.go index f992e805c76..f1afc91660c 100644 --- a/service/greengrass/api_op_ListBulkDeployments.go +++ b/service/greengrass/api_op_ListBulkDeployments.go @@ -56,12 +56,12 @@ func (c *Client) ListBulkDeployments(ctx context.Context, params *ListBulkDeploy type ListBulkDeploymentsInput struct { + // The maximum number of results to be returned per request. + MaxResults *string + // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string - - // The maximum number of results to be returned per request. - MaxResults *string } type ListBulkDeploymentsOutput struct { diff --git a/service/greengrass/api_op_ListConnectorDefinitionVersions.go b/service/greengrass/api_op_ListConnectorDefinitionVersions.go index 3fb97928adc..bc7a2c629ee 100644 --- a/service/greengrass/api_op_ListConnectorDefinitionVersions.go +++ b/service/greengrass/api_op_ListConnectorDefinitionVersions.go @@ -60,10 +60,6 @@ func (c *Client) ListConnectorDefinitionVersions(ctx context.Context, params *Li type ListConnectorDefinitionVersionsInput struct { - // The token for the next set of results, or ''null'' if there are no additional - // results. - NextToken *string - // The ID of the connector definition. // // This member is required. @@ -71,6 +67,10 @@ type ListConnectorDefinitionVersionsInput struct { // The maximum number of results to be returned per request. MaxResults *string + + // The token for the next set of results, or ''null'' if there are no additional + // results. + NextToken *string } type ListConnectorDefinitionVersionsOutput struct { diff --git a/service/greengrass/api_op_ListConnectorDefinitions.go b/service/greengrass/api_op_ListConnectorDefinitions.go index 6fb8603f655..a216030e831 100644 --- a/service/greengrass/api_op_ListConnectorDefinitions.go +++ b/service/greengrass/api_op_ListConnectorDefinitions.go @@ -56,12 +56,12 @@ func (c *Client) ListConnectorDefinitions(ctx context.Context, params *ListConne type ListConnectorDefinitionsInput struct { + // The maximum number of results to be returned per request. + MaxResults *string + // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string - - // The maximum number of results to be returned per request. - MaxResults *string } type ListConnectorDefinitionsOutput struct { diff --git a/service/greengrass/api_op_ListCoreDefinitionVersions.go b/service/greengrass/api_op_ListCoreDefinitionVersions.go index e725d89da68..de220130d28 100644 --- a/service/greengrass/api_op_ListCoreDefinitionVersions.go +++ b/service/greengrass/api_op_ListCoreDefinitionVersions.go @@ -57,17 +57,17 @@ func (c *Client) ListCoreDefinitionVersions(ctx context.Context, params *ListCor type ListCoreDefinitionVersionsInput struct { - // The token for the next set of results, or ''null'' if there are no additional - // results. - NextToken *string - - // The maximum number of results to be returned per request. - MaxResults *string - // The ID of the core definition. // // This member is required. CoreDefinitionId *string + + // The maximum number of results to be returned per request. + MaxResults *string + + // The token for the next set of results, or ''null'' if there are no additional + // results. + NextToken *string } type ListCoreDefinitionVersionsOutput struct { diff --git a/service/greengrass/api_op_ListDeployments.go b/service/greengrass/api_op_ListDeployments.go index 7c03032b818..ee9076c9891 100644 --- a/service/greengrass/api_op_ListDeployments.go +++ b/service/greengrass/api_op_ListDeployments.go @@ -57,28 +57,28 @@ func (c *Client) ListDeployments(ctx context.Context, params *ListDeploymentsInp type ListDeploymentsInput struct { - // The token for the next set of results, or ''null'' if there are no additional - // results. - NextToken *string - - // The maximum number of results to be returned per request. - MaxResults *string - // The ID of the Greengrass group. // // This member is required. GroupId *string -} -type ListDeploymentsOutput struct { + // The maximum number of results to be returned per request. + MaxResults *string // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string +} + +type ListDeploymentsOutput struct { // A list of deployments for the requested groups. Deployments []*types.Deployment + // The token for the next set of results, or ''null'' if there are no additional + // results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_ListDeviceDefinitionVersions.go b/service/greengrass/api_op_ListDeviceDefinitionVersions.go index ba2c00686e3..e021bef13ad 100644 --- a/service/greengrass/api_op_ListDeviceDefinitionVersions.go +++ b/service/greengrass/api_op_ListDeviceDefinitionVersions.go @@ -62,23 +62,23 @@ type ListDeviceDefinitionVersionsInput struct { // This member is required. DeviceDefinitionId *string + // The maximum number of results to be returned per request. + MaxResults *string + // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string - - // The maximum number of results to be returned per request. - MaxResults *string } type ListDeviceDefinitionVersionsOutput struct { - // Information about a version. - Versions []*types.VersionInformation - // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string + // Information about a version. + Versions []*types.VersionInformation + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_ListDeviceDefinitions.go b/service/greengrass/api_op_ListDeviceDefinitions.go index 7bbfb396bb5..368e02a34a2 100644 --- a/service/greengrass/api_op_ListDeviceDefinitions.go +++ b/service/greengrass/api_op_ListDeviceDefinitions.go @@ -66,13 +66,13 @@ type ListDeviceDefinitionsInput struct { type ListDeviceDefinitionsOutput struct { + // Information about a definition. + Definitions []*types.DefinitionInformation + // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string - // Information about a definition. - Definitions []*types.DefinitionInformation - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_ListFunctionDefinitionVersions.go b/service/greengrass/api_op_ListFunctionDefinitionVersions.go index bed4fc8f8e6..abce5dd176f 100644 --- a/service/greengrass/api_op_ListFunctionDefinitionVersions.go +++ b/service/greengrass/api_op_ListFunctionDefinitionVersions.go @@ -72,13 +72,13 @@ type ListFunctionDefinitionVersionsInput struct { type ListFunctionDefinitionVersionsOutput struct { - // Information about a version. - Versions []*types.VersionInformation - // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string + // Information about a version. + Versions []*types.VersionInformation + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_ListGroupVersions.go b/service/greengrass/api_op_ListGroupVersions.go index ec3412b2be3..942573e74ab 100644 --- a/service/greengrass/api_op_ListGroupVersions.go +++ b/service/greengrass/api_op_ListGroupVersions.go @@ -62,12 +62,12 @@ type ListGroupVersionsInput struct { // This member is required. GroupId *string + // The maximum number of results to be returned per request. + MaxResults *string + // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string - - // The maximum number of results to be returned per request. - MaxResults *string } type ListGroupVersionsOutput struct { diff --git a/service/greengrass/api_op_ListGroups.go b/service/greengrass/api_op_ListGroups.go index f4fb2c70099..95a37eb6d17 100644 --- a/service/greengrass/api_op_ListGroups.go +++ b/service/greengrass/api_op_ListGroups.go @@ -56,23 +56,23 @@ func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns type ListGroupsInput struct { + // The maximum number of results to be returned per request. + MaxResults *string + // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string - - // The maximum number of results to be returned per request. - MaxResults *string } type ListGroupsOutput struct { + // Information about a group. + Groups []*types.GroupInformation + // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string - // Information about a group. - Groups []*types.GroupInformation - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_ListLoggerDefinitionVersions.go b/service/greengrass/api_op_ListLoggerDefinitionVersions.go index 0dd793f8db7..97f946b39ef 100644 --- a/service/greengrass/api_op_ListLoggerDefinitionVersions.go +++ b/service/greengrass/api_op_ListLoggerDefinitionVersions.go @@ -57,10 +57,6 @@ func (c *Client) ListLoggerDefinitionVersions(ctx context.Context, params *ListL type ListLoggerDefinitionVersionsInput struct { - // The token for the next set of results, or ''null'' if there are no additional - // results. - NextToken *string - // The ID of the logger definition. // // This member is required. @@ -68,17 +64,21 @@ type ListLoggerDefinitionVersionsInput struct { // The maximum number of results to be returned per request. MaxResults *string + + // The token for the next set of results, or ''null'' if there are no additional + // results. + NextToken *string } type ListLoggerDefinitionVersionsOutput struct { - // Information about a version. - Versions []*types.VersionInformation - // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string + // Information about a version. + Versions []*types.VersionInformation + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_ListLoggerDefinitions.go b/service/greengrass/api_op_ListLoggerDefinitions.go index 03fd78ea6b9..385771e3438 100644 --- a/service/greengrass/api_op_ListLoggerDefinitions.go +++ b/service/greengrass/api_op_ListLoggerDefinitions.go @@ -56,23 +56,23 @@ func (c *Client) ListLoggerDefinitions(ctx context.Context, params *ListLoggerDe type ListLoggerDefinitionsInput struct { + // The maximum number of results to be returned per request. + MaxResults *string + // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string - - // The maximum number of results to be returned per request. - MaxResults *string } type ListLoggerDefinitionsOutput struct { + // Information about a definition. + Definitions []*types.DefinitionInformation + // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string - // Information about a definition. - Definitions []*types.DefinitionInformation - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_ListResourceDefinitionVersions.go b/service/greengrass/api_op_ListResourceDefinitionVersions.go index 4cc20bb6454..e9c2a28b1d8 100644 --- a/service/greengrass/api_op_ListResourceDefinitionVersions.go +++ b/service/greengrass/api_op_ListResourceDefinitionVersions.go @@ -57,14 +57,14 @@ func (c *Client) ListResourceDefinitionVersions(ctx context.Context, params *Lis type ListResourceDefinitionVersionsInput struct { - // The maximum number of results to be returned per request. - MaxResults *string - // The ID of the resource definition. // // This member is required. ResourceDefinitionId *string + // The maximum number of results to be returned per request. + MaxResults *string + // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string diff --git a/service/greengrass/api_op_ListResourceDefinitions.go b/service/greengrass/api_op_ListResourceDefinitions.go index 5aa2cbb13e8..d72ce4596cf 100644 --- a/service/greengrass/api_op_ListResourceDefinitions.go +++ b/service/greengrass/api_op_ListResourceDefinitions.go @@ -56,23 +56,23 @@ func (c *Client) ListResourceDefinitions(ctx context.Context, params *ListResour type ListResourceDefinitionsInput struct { + // The maximum number of results to be returned per request. + MaxResults *string + // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string - - // The maximum number of results to be returned per request. - MaxResults *string } type ListResourceDefinitionsOutput struct { + // Information about a definition. + Definitions []*types.DefinitionInformation + // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string - // Information about a definition. - Definitions []*types.DefinitionInformation - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_ListSubscriptionDefinitionVersions.go b/service/greengrass/api_op_ListSubscriptionDefinitionVersions.go index 8a49e9d4ff5..8ecc470bd38 100644 --- a/service/greengrass/api_op_ListSubscriptionDefinitionVersions.go +++ b/service/greengrass/api_op_ListSubscriptionDefinitionVersions.go @@ -57,14 +57,14 @@ func (c *Client) ListSubscriptionDefinitionVersions(ctx context.Context, params type ListSubscriptionDefinitionVersionsInput struct { - // The maximum number of results to be returned per request. - MaxResults *string - // The ID of the subscription definition. // // This member is required. SubscriptionDefinitionId *string + // The maximum number of results to be returned per request. + MaxResults *string + // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string @@ -72,13 +72,13 @@ type ListSubscriptionDefinitionVersionsInput struct { type ListSubscriptionDefinitionVersionsOutput struct { - // Information about a version. - Versions []*types.VersionInformation - // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string + // Information about a version. + Versions []*types.VersionInformation + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_ListSubscriptionDefinitions.go b/service/greengrass/api_op_ListSubscriptionDefinitions.go index bee22a28af6..9e588065f97 100644 --- a/service/greengrass/api_op_ListSubscriptionDefinitions.go +++ b/service/greengrass/api_op_ListSubscriptionDefinitions.go @@ -56,12 +56,12 @@ func (c *Client) ListSubscriptionDefinitions(ctx context.Context, params *ListSu type ListSubscriptionDefinitionsInput struct { + // The maximum number of results to be returned per request. + MaxResults *string + // The token for the next set of results, or ''null'' if there are no additional // results. NextToken *string - - // The maximum number of results to be returned per request. - MaxResults *string } type ListSubscriptionDefinitionsOutput struct { diff --git a/service/greengrass/api_op_ResetDeployments.go b/service/greengrass/api_op_ResetDeployments.go index a1dbd79e280..066e0dbf34f 100644 --- a/service/greengrass/api_op_ResetDeployments.go +++ b/service/greengrass/api_op_ResetDeployments.go @@ -57,26 +57,26 @@ func (c *Client) ResetDeployments(ctx context.Context, params *ResetDeploymentsI // Information needed to reset deployments. type ResetDeploymentsInput struct { - // A client token used to correlate requests and responses. - AmznClientToken *string - // The ID of the Greengrass group. // // This member is required. GroupId *string + // A client token used to correlate requests and responses. + AmznClientToken *string + // If true, performs a best-effort only core reset. Force *bool } type ResetDeploymentsOutput struct { - // The ID of the deployment. - DeploymentId *string - // The ARN of the deployment. DeploymentArn *string + // The ID of the deployment. + DeploymentId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_StartBulkDeployment.go b/service/greengrass/api_op_StartBulkDeployment.go index b7310aab933..a25c6f15ec2 100644 --- a/service/greengrass/api_op_StartBulkDeployment.go +++ b/service/greengrass/api_op_StartBulkDeployment.go @@ -61,6 +61,14 @@ func (c *Client) StartBulkDeployment(ctx context.Context, params *StartBulkDeplo type StartBulkDeploymentInput struct { + // The ARN of the execution role to associate with the bulk deployment operation. + // This IAM role must allow the ''greengrass:CreateDeployment'' action for all + // group versions that are listed in the input file. This IAM role must have access + // to the S3 bucket containing the input file. + // + // This member is required. + ExecutionRoleArn *string + // The URI of the input file contained in the S3 bucket. The execution role must // have ''getObject'' permissions on this bucket to access the input file. The // input file is a JSON-serialized, line delimited file with UTF-8 encoding that @@ -71,29 +79,21 @@ type StartBulkDeploymentInput struct { // This member is required. InputFileUri *string - // Tag(s) to add to the new resource. - Tags map[string]*string - - // The ARN of the execution role to associate with the bulk deployment operation. - // This IAM role must allow the ''greengrass:CreateDeployment'' action for all - // group versions that are listed in the input file. This IAM role must have access - // to the S3 bucket containing the input file. - // - // This member is required. - ExecutionRoleArn *string - // A client token used to correlate requests and responses. AmznClientToken *string + + // Tag(s) to add to the new resource. + Tags map[string]*string } type StartBulkDeploymentOutput struct { - // The ID of the bulk deployment. - BulkDeploymentId *string - // The ARN of the bulk deployment. BulkDeploymentArn *string + // The ID of the bulk deployment. + BulkDeploymentId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_UpdateConnectivityInfo.go b/service/greengrass/api_op_UpdateConnectivityInfo.go index 5c67d50ecab..2c25f662831 100644 --- a/service/greengrass/api_op_UpdateConnectivityInfo.go +++ b/service/greengrass/api_op_UpdateConnectivityInfo.go @@ -60,23 +60,23 @@ func (c *Client) UpdateConnectivityInfo(ctx context.Context, params *UpdateConne // Connectivity information. type UpdateConnectivityInfoInput struct { - // A list of connectivity info. - ConnectivityInfo []*types.ConnectivityInfo - // The thing name. // // This member is required. ThingName *string + + // A list of connectivity info. + ConnectivityInfo []*types.ConnectivityInfo } type UpdateConnectivityInfoOutput struct { - // The new version of the connectivity info. - Version *string - // A message about the connectivity info update request. Message *string + // The new version of the connectivity info. + Version *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/api_op_UpdateDeviceDefinition.go b/service/greengrass/api_op_UpdateDeviceDefinition.go index 67efdb5b1b2..15921992b71 100644 --- a/service/greengrass/api_op_UpdateDeviceDefinition.go +++ b/service/greengrass/api_op_UpdateDeviceDefinition.go @@ -56,13 +56,13 @@ func (c *Client) UpdateDeviceDefinition(ctx context.Context, params *UpdateDevic type UpdateDeviceDefinitionInput struct { - // The name of the definition. - Name *string - // The ID of the device definition. // // This member is required. DeviceDefinitionId *string + + // The name of the definition. + Name *string } type UpdateDeviceDefinitionOutput struct { diff --git a/service/greengrass/api_op_UpdateGroup.go b/service/greengrass/api_op_UpdateGroup.go index dc4f56dca92..14a286e7371 100644 --- a/service/greengrass/api_op_UpdateGroup.go +++ b/service/greengrass/api_op_UpdateGroup.go @@ -56,13 +56,13 @@ func (c *Client) UpdateGroup(ctx context.Context, params *UpdateGroupInput, optF type UpdateGroupInput struct { - // The name of the definition. - Name *string - // The ID of the Greengrass group. // // This member is required. GroupId *string + + // The name of the definition. + Name *string } type UpdateGroupOutput struct { diff --git a/service/greengrass/api_op_UpdateGroupCertificateConfiguration.go b/service/greengrass/api_op_UpdateGroupCertificateConfiguration.go index 959890af3cc..0d3e092a6b3 100644 --- a/service/greengrass/api_op_UpdateGroupCertificateConfiguration.go +++ b/service/greengrass/api_op_UpdateGroupCertificateConfiguration.go @@ -56,20 +56,17 @@ func (c *Client) UpdateGroupCertificateConfiguration(ctx context.Context, params type UpdateGroupCertificateConfigurationInput struct { - // The amount of time remaining before the certificate expires, in milliseconds. - CertificateExpiryInMilliseconds *string - // The ID of the Greengrass group. // // This member is required. GroupId *string + + // The amount of time remaining before the certificate expires, in milliseconds. + CertificateExpiryInMilliseconds *string } type UpdateGroupCertificateConfigurationOutput struct { - // The ID of the group certificate configuration. - GroupId *string - // The amount of time remaining before the certificate authority expires, in // milliseconds. CertificateAuthorityExpiryInMilliseconds *string @@ -77,6 +74,9 @@ type UpdateGroupCertificateConfigurationOutput struct { // The amount of time remaining before the certificate expires, in milliseconds. CertificateExpiryInMilliseconds *string + // The ID of the group certificate configuration. + GroupId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/greengrass/go.mod b/service/greengrass/go.mod index 2f4039f1378..82641266be9 100644 --- a/service/greengrass/go.mod +++ b/service/greengrass/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/greengrass go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/greengrass/types/types.go b/service/greengrass/types/types.go index 40b1e7d4f6d..c2258f68ed9 100644 --- a/service/greengrass/types/types.go +++ b/service/greengrass/types/types.go @@ -19,6 +19,12 @@ type BulkDeployment struct { // Relevant metrics on input records processed during bulk deployment. type BulkDeploymentMetrics struct { + // The total number of records that returned a non-retryable error. For example, + // this can occur if a group record from the input file uses an invalid format or + // specifies a nonexistent group version, or if the execution role doesn't grant + // permission to deploy a group or group version. + InvalidInputRecords *int32 + // The total number of group records from the input file that have been processed // so far, or attempted. RecordsProcessed *int32 @@ -28,38 +34,32 @@ type BulkDeploymentMetrics struct { // throttling error. ''StartBulkDeployment'' retries a group deployment up to five // times. RetryAttempts *int32 - - // The total number of records that returned a non-retryable error. For example, - // this can occur if a group record from the input file uses an invalid format or - // specifies a nonexistent group version, or if the execution role doesn't grant - // permission to deploy a group or group version. - InvalidInputRecords *int32 } // Information about an individual group deployment in a bulk deployment operation. type BulkDeploymentResult struct { - // The current status of the group deployment: ''InProgress'', ''Building'', - // ''Success'', or ''Failure''. - DeploymentStatus *string + // The time, in ISO format, when the deployment was created. + CreatedAt *string - // The error message for a failed deployment - ErrorMessage *string + // The ARN of the group deployment. + DeploymentArn *string // The ID of the group deployment. DeploymentId *string - // Details about the error. - ErrorDetails []*ErrorDetail + // The current status of the group deployment: ''InProgress'', ''Building'', + // ''Success'', or ''Failure''. + DeploymentStatus *string // The type of the deployment. DeploymentType DeploymentType - // The time, in ISO format, when the deployment was created. - CreatedAt *string + // Details about the error. + ErrorDetails []*ErrorDetail - // The ARN of the group deployment. - DeploymentArn *string + // The error message for a failed deployment + ErrorMessage *string // The ARN of the Greengrass group. GroupArn *string @@ -74,11 +74,11 @@ type ConnectivityInfo struct { // The ID of the connectivity information. Id *string - // The port of the Greengrass core. Usually 8883. - PortNumber *int32 - // Metadata for this endpoint. Metadata *string + + // The port of the Greengrass core. Usually 8883. + PortNumber *int32 } // Information about a connector. Connectors run on the Greengrass core and contain @@ -86,9 +86,6 @@ type ConnectivityInfo struct { // cloud services. type Connector struct { - // The parameters or configuration that the connector uses. - Parameters map[string]*string - // The ARN of the connector. // // This member is required. @@ -100,6 +97,9 @@ type Connector struct { // // This member is required. Id *string + + // The parameters or configuration that the connector uses. + Parameters map[string]*string } // Information about the connector definition version, which is a container for @@ -126,13 +126,13 @@ type Core struct { // This member is required. Id *string - // If true, the core's local shadow is automatically synced with the cloud. - SyncShadow *bool - // The ARN of the thing which is the core. // // This member is required. ThingArn *string + + // If true, the core's local shadow is automatically synced with the cloud. + SyncShadow *bool } // Information about a core definition version. @@ -145,39 +145,36 @@ type CoreDefinitionVersion struct { // Information about a definition. type DefinitionInformation struct { - // The name of the definition. - Name *string + // The ARN of the definition. + Arn *string + + // The time, in milliseconds since the epoch, when the definition was created. + CreationTimestamp *string // The ID of the definition. Id *string - // The time, in milliseconds since the epoch, when the definition was created. - CreationTimestamp *string + // The time, in milliseconds since the epoch, when the definition was last updated. + LastUpdatedTimestamp *string // The ID of the latest version associated with the definition. LatestVersion *string - // The ARN of the definition. - Arn *string + // The ARN of the latest version associated with the definition. + LatestVersionArn *string - // The time, in milliseconds since the epoch, when the definition was last updated. - LastUpdatedTimestamp *string + // The name of the definition. + Name *string // Tag(s) attached to the resource arn. Tags map[string]*string - - // The ARN of the latest version associated with the definition. - LatestVersionArn *string } // Information about a deployment. type Deployment struct { - // The ARN of the group for this deployment. - GroupArn *string - - // The type of the deployment. - DeploymentType DeploymentType + // The time, in milliseconds since the epoch, when the deployment was created. + CreatedAt *string // The ARN of the deployment. DeploymentArn *string @@ -185,20 +182,20 @@ type Deployment struct { // The ID of the deployment. DeploymentId *string - // The time, in milliseconds since the epoch, when the deployment was created. - CreatedAt *string + // The type of the deployment. + DeploymentType DeploymentType + + // The ARN of the group for this deployment. + GroupArn *string } // Information about a device. type Device struct { - // If true, the device's local shadow will be automatically synced with the cloud. - SyncShadow *bool - - // The thing ARN of the device. + // The ARN of the certificate associated with the device. // // This member is required. - ThingArn *string + CertificateArn *string // A descriptive or arbitrary ID for the device. This value must be unique within // the device definition version. Max length is 128 characters with pattern @@ -207,10 +204,13 @@ type Device struct { // This member is required. Id *string - // The ARN of the certificate associated with the device. + // The thing ARN of the device. // // This member is required. - CertificateArn *string + ThingArn *string + + // If true, the device's local shadow will be automatically synced with the cloud. + SyncShadow *bool } // Information about a device definition version. @@ -233,9 +233,6 @@ type ErrorDetail struct { // Information about a Lambda function. type Function struct { - // The configuration of the Lambda function. - FunctionConfiguration *FunctionConfiguration - // A descriptive or arbitrary ID for the function. This value must be unique within // the function definition version. Max length is 128 characters with pattern // ''[a-zA-Z0-9:_-]+''. @@ -245,51 +242,45 @@ type Function struct { // The ARN of the Lambda function. FunctionArn *string + + // The configuration of the Lambda function. + FunctionConfiguration *FunctionConfiguration } // The configuration of the Lambda function. type FunctionConfiguration struct { - // The allowed function execution time, after which Lambda should terminate the - // function. This timeout still applies to pinned Lambda functions for each - // request. - Timeout *int32 - - // True if the function is pinned. Pinned means the function is long-lived and - // starts when the core starts. - Pinned *bool - // The expected encoding type of the input payload for the function. The default is // ''json''. EncodingType EncodingType - // The name of the function executable. - Executable *string - // The environment configuration of the function. Environment *FunctionConfigurationEnvironment + // The execution arguments. + ExecArgs *string + + // The name of the function executable. + Executable *string + // The memory size, in KB, which the function requires. This setting is not // applicable and should be cleared when you run the Lambda function without // containerization. MemorySize *int32 - // The execution arguments. - ExecArgs *string + // True if the function is pinned. Pinned means the function is long-lived and + // starts when the core starts. + Pinned *bool + + // The allowed function execution time, after which Lambda should terminate the + // function. This timeout still applies to pinned Lambda functions for each + // request. + Timeout *int32 } // The environment configuration of the function. type FunctionConfigurationEnvironment struct { - // Environment variables for the Lambda function's configuration. - Variables map[string]*string - - // A list of the resources, with their permissions, to which the Lambda function - // will be granted access. A Lambda function can have at most 10 resources. - // ResourceAccessPolicies apply only when you run the Lambda function in a - // Greengrass container. - ResourceAccessPolicies []*ResourceAccessPolicy - // If true, the Lambda function is allowed to access the host's /sys folder. Use // this when the Lambda function needs to read device information from /sys. This // setting applies only when you run the Lambda function in a Greengrass container. @@ -297,6 +288,15 @@ type FunctionConfigurationEnvironment struct { // Configuration related to executing the Lambda function Execution *FunctionExecutionConfig + + // A list of the resources, with their permissions, to which the Lambda function + // will be granted access. A Lambda function can have at most 10 resources. + // ResourceAccessPolicies apply only when you run the Lambda function in a + // Greengrass container. + ResourceAccessPolicies []*ResourceAccessPolicy + + // Environment variables for the Lambda function's configuration. + Variables map[string]*string } // The default configuration that applies to all Lambda functions in the group. @@ -310,6 +310,13 @@ type FunctionDefaultConfig struct { // Configuration information that specifies how a Lambda function runs. type FunctionDefaultExecutionConfig struct { + // Specifies whether the Lambda function runs in a Greengrass container (default) + // or without containerization. Unless your scenario requires that you run without + // containerization, we recommend that you run in a Greengrass container. Omit this + // value to run the Lambda function with the default containerization for the + // group. + IsolationMode FunctionIsolationMode + // Specifies the user and group whose permissions are used when running the Lambda // function. You can specify one or both values to override the default values. We // recommend that you avoid running as root unless absolutely necessary to minimize @@ -317,24 +324,17 @@ type FunctionDefaultExecutionConfig struct { // set ''IsolationMode'' to ''NoContainer'' and update config.json in // ''greengrass-root/config'' to set ''allowFunctionsToRunAsRoot'' to ''yes''. RunAs *FunctionRunAsConfig - - // Specifies whether the Lambda function runs in a Greengrass container (default) - // or without containerization. Unless your scenario requires that you run without - // containerization, we recommend that you run in a Greengrass container. Omit this - // value to run the Lambda function with the default containerization for the - // group. - IsolationMode FunctionIsolationMode } // Information about a function definition version. type FunctionDefinitionVersion struct { - // A list of Lambda functions in this function definition version. - Functions []*Function - // The default configuration that applies to all Lambda functions in this function // definition version. Individual Lambda functions can override these settings. DefaultConfig *FunctionDefaultConfig + + // A list of Lambda functions in this function definition version. + Functions []*Function } // Configuration information that specifies how a Lambda function runs. @@ -374,36 +374,36 @@ type FunctionRunAsConfig struct { // Information about a certificate authority for a group. type GroupCertificateAuthorityProperties struct { - // The ID of the certificate authority for the group. - GroupCertificateAuthorityId *string - // The ARN of the certificate authority for the group. GroupCertificateAuthorityArn *string + + // The ID of the certificate authority for the group. + GroupCertificateAuthorityId *string } // Information about a group. type GroupInformation struct { + // The ARN of the group. + Arn *string + // The time, in milliseconds since the epoch, when the group was created. CreationTimestamp *string + // The ID of the group. + Id *string + + // The time, in milliseconds since the epoch, when the group was last updated. + LastUpdatedTimestamp *string + // The ID of the latest version associated with the group. LatestVersion *string // The ARN of the latest version associated with the group. LatestVersionArn *string - // The time, in milliseconds since the epoch, when the group was last updated. - LastUpdatedTimestamp *string - - // The ID of the group. - Id *string - // The name of the group. Name *string - - // The ARN of the group. - Arn *string } // Group owner related settings for local resources. @@ -422,26 +422,26 @@ type GroupOwnerSetting struct { // Information about a group version. type GroupVersion struct { - // The ARN of the subscription definition version for this group. - SubscriptionDefinitionVersionArn *string - - // The ARN of the logger definition version for this group. - LoggerDefinitionVersionArn *string - // The ARN of the connector definition version for this group. ConnectorDefinitionVersionArn *string // The ARN of the core definition version for this group. CoreDefinitionVersionArn *string - // The ARN of the resource definition version for this group. - ResourceDefinitionVersionArn *string - // The ARN of the device definition version for this group. DeviceDefinitionVersionArn *string // The ARN of the function definition version for this group. FunctionDefinitionVersionArn *string + + // The ARN of the logger definition version for this group. + LoggerDefinitionVersionArn *string + + // The ARN of the resource definition version for this group. + ResourceDefinitionVersionArn *string + + // The ARN of the subscription definition version for this group. + SubscriptionDefinitionVersionArn *string } // Attributes that define a local device resource. @@ -461,43 +461,43 @@ type LocalVolumeResourceData struct { // The absolute local path of the resource inside the Lambda environment. DestinationPath *string - // The local absolute path of the volume resource on the host. The source path for - // a volume resource type cannot start with ''/sys''. - SourcePath *string - // Allows you to configure additional group privileges for the Lambda process. This // field is optional. GroupOwnerSetting *GroupOwnerSetting + + // The local absolute path of the volume resource on the host. The source path for + // a volume resource type cannot start with ''/sys''. + SourcePath *string } // Information about a logger type Logger struct { - // The amount of file space, in KB, to use if the local file system is used for - // logging purposes. - Space *int32 + // The component that will be subject to logging. + // + // This member is required. + Component LoggerComponent - // The type of log output which will be used. + // A descriptive or arbitrary ID for the logger. This value must be unique within + // the logger definition version. Max length is 128 characters with pattern + // ''[a-zA-Z0-9:_-]+''. // // This member is required. - Type LoggerType + Id *string // The level of the logs. // // This member is required. Level LoggerLevel - // The component that will be subject to logging. + // The type of log output which will be used. // // This member is required. - Component LoggerComponent + Type LoggerType - // A descriptive or arbitrary ID for the logger. This value must be unique within - // the logger definition version. Max length is 128 characters with pattern - // ''[a-zA-Z0-9:_-]+''. - // - // This member is required. - Id *string + // The amount of file space, in KB, to use if the local file system is used for + // logging purposes. + Space *int32 } // Information about a logger definition version. @@ -510,11 +510,6 @@ type LoggerDefinitionVersion struct { // Information about a resource. type Resource struct { - // A container of data for all resource types. - // - // This member is required. - ResourceDataContainer *ResourceDataContainer - // The resource ID, used to refer to a resource in the Lambda function // configuration. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''. // This must be unique within a Greengrass group. @@ -528,20 +523,25 @@ type Resource struct { // // This member is required. Name *string + + // A container of data for all resource types. + // + // This member is required. + ResourceDataContainer *ResourceDataContainer } // A policy used by the function to access a resource. type ResourceAccessPolicy struct { - // The permissions that the Lambda function has to the resource. Can be one of - // ''rw'' (read/write) or ''ro'' (read-only). - Permission Permission - // The ID of the resource. (This ID is assigned to the resource when you create the // resource definiton.) // // This member is required. ResourceId *string + + // The permissions that the Lambda function has to the resource. Can be one of + // ''rw'' (read/write) or ''ro'' (read-only). + Permission Permission } // A container for resource data. The container takes only one of the following @@ -550,21 +550,21 @@ type ResourceAccessPolicy struct { // ''S3MachineLearningModelResourceData'', ''SecretsManagerSecretResourceData''. type ResourceDataContainer struct { - // Attributes that define an Amazon SageMaker machine learning resource. - SageMakerMachineLearningModelResourceData *SageMakerMachineLearningModelResourceData + // Attributes that define the local device resource. + LocalDeviceResourceData *LocalDeviceResourceData - // Attributes that define a secret resource, which references a secret from AWS - // Secrets Manager. - SecretsManagerSecretResourceData *SecretsManagerSecretResourceData + // Attributes that define the local volume resource. + LocalVolumeResourceData *LocalVolumeResourceData // Attributes that define an Amazon S3 machine learning resource. S3MachineLearningModelResourceData *S3MachineLearningModelResourceData - // Attributes that define the local volume resource. - LocalVolumeResourceData *LocalVolumeResourceData + // Attributes that define an Amazon SageMaker machine learning resource. + SageMakerMachineLearningModelResourceData *SageMakerMachineLearningModelResourceData - // Attributes that define the local device resource. - LocalDeviceResourceData *LocalDeviceResourceData + // Attributes that define a secret resource, which references a secret from AWS + // Secrets Manager. + SecretsManagerSecretResourceData *SecretsManagerSecretResourceData } // Information about a resource definition version. @@ -577,44 +577,44 @@ type ResourceDefinitionVersion struct { // The owner setting for downloaded machine learning resources. type ResourceDownloadOwnerSetting struct { - // The permissions that the group owner has to the resource. Valid values are - // ''rw'' (read/write) or ''ro'' (read-only). - // - // This member is required. - GroupPermission Permission - // The group owner of the resource. This is the name of an existing Linux OS group // on the system or a GID. The group's permissions are added to the Lambda process. // // This member is required. GroupOwner *string + + // The permissions that the group owner has to the resource. Valid values are + // ''rw'' (read/write) or ''ro'' (read-only). + // + // This member is required. + GroupPermission Permission } // Attributes that define an Amazon S3 machine learning resource. type S3MachineLearningModelResourceData struct { - // The URI of the source model in an S3 bucket. The model package must be in tar.gz - // or .zip format. - S3Uri *string - // The absolute local path of the resource inside the Lambda environment. DestinationPath *string // The owner setting for downloaded machine learning resources. OwnerSetting *ResourceDownloadOwnerSetting + + // The URI of the source model in an S3 bucket. The model package must be in tar.gz + // or .zip format. + S3Uri *string } // Attributes that define an Amazon SageMaker machine learning resource. type SageMakerMachineLearningModelResourceData struct { - // The ARN of the Amazon SageMaker training job that represents the source model. - SageMakerJobArn *string + // The absolute local path of the resource inside the Lambda environment. + DestinationPath *string // The owner setting for downloaded machine learning resources. OwnerSetting *ResourceDownloadOwnerSetting - // The absolute local path of the resource inside the Lambda environment. - DestinationPath *string + // The ARN of the Amazon SageMaker training job that represents the source model. + SageMakerJobArn *string } // Attributes that define a secret resource, which references a secret from AWS @@ -636,31 +636,31 @@ type SecretsManagerSecretResourceData struct { // Information about a subscription. type Subscription struct { - // The source of the subscription. Can be a thing ARN, a Lambda function ARN, a - // connector ARN, 'cloud' (which represents the AWS IoT cloud), or - // 'GGShadowService'. + // A descriptive or arbitrary ID for the subscription. This value must be unique + // within the subscription definition version. Max length is 128 characters with + // pattern ''[a-zA-Z0-9:_-]+''. // // This member is required. - Source *string + Id *string - // Where the message is sent to. Can be a thing ARN, a Lambda function ARN, a + // The source of the subscription. Can be a thing ARN, a Lambda function ARN, a // connector ARN, 'cloud' (which represents the AWS IoT cloud), or // 'GGShadowService'. // // This member is required. - Target *string + Source *string // The MQTT topic used to route the message. // // This member is required. Subject *string - // A descriptive or arbitrary ID for the subscription. This value must be unique - // within the subscription definition version. Max length is 128 characters with - // pattern ''[a-zA-Z0-9:_-]+''. + // Where the message is sent to. Can be a thing ARN, a Lambda function ARN, a + // connector ARN, 'cloud' (which represents the AWS IoT cloud), or + // 'GGShadowService'. // // This member is required. - Id *string + Target *string } // Information about a subscription definition version. @@ -673,8 +673,8 @@ type SubscriptionDefinitionVersion struct { // Information about a version. type VersionInformation struct { - // The ID of the version. - Version *string + // The ARN of the version. + Arn *string // The time, in milliseconds since the epoch, when the version was created. CreationTimestamp *string @@ -682,6 +682,6 @@ type VersionInformation struct { // The ID of the parent definition that the version is associated with. Id *string - // The ARN of the version. - Arn *string + // The ID of the version. + Version *string } diff --git a/service/groundstation/api_op_CreateMissionProfile.go b/service/groundstation/api_op_CreateMissionProfile.go index 0540782bdac..433a7bd6938 100644 --- a/service/groundstation/api_op_CreateMissionProfile.go +++ b/service/groundstation/api_op_CreateMissionProfile.go @@ -57,14 +57,6 @@ func (c *Client) CreateMissionProfile(ctx context.Context, params *CreateMission // type CreateMissionProfileInput struct { - // Amount of time after a contact ends that you’d like to receive a CloudWatch - // event indicating the pass has finished. - ContactPostPassDurationSeconds *int32 - - // Amount of time prior to contact start you’d like to receive a CloudWatch event - // indicating an upcoming pass. - ContactPrePassDurationSeconds *int32 - // A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a // to Config. // @@ -83,13 +75,21 @@ type CreateMissionProfileInput struct { // This member is required. Name *string - // Tags assigned to a mission profile. - Tags map[string]*string - // ARN of a tracking Config. // // This member is required. TrackingConfigArn *string + + // Amount of time after a contact ends that you’d like to receive a CloudWatch + // event indicating the pass has finished. + ContactPostPassDurationSeconds *int32 + + // Amount of time prior to contact start you’d like to receive a CloudWatch event + // indicating an upcoming pass. + ContactPrePassDurationSeconds *int32 + + // Tags assigned to a mission profile. + Tags map[string]*string } // diff --git a/service/groundstation/api_op_GetConfig.go b/service/groundstation/api_op_GetConfig.go index 17b83dd0f8d..67cebc05f56 100644 --- a/service/groundstation/api_op_GetConfig.go +++ b/service/groundstation/api_op_GetConfig.go @@ -86,14 +86,14 @@ type GetConfigOutput struct { // This member is required. ConfigId *string - // Type of a Config. - ConfigType types.ConfigCapabilityType - // Name of a Config. // // This member is required. Name *string + // Type of a Config. + ConfigType types.ConfigCapabilityType + // Tags assigned to a Config. Tags map[string]*string diff --git a/service/groundstation/api_op_ListContacts.go b/service/groundstation/api_op_ListContacts.go index ee211157c3a..78b45b8cbb3 100644 --- a/service/groundstation/api_op_ListContacts.go +++ b/service/groundstation/api_op_ListContacts.go @@ -64,6 +64,16 @@ type ListContactsInput struct { // This member is required. EndTime *time.Time + // Start time of a contact. + // + // This member is required. + StartTime *time.Time + + // Status of a contact reservation. + // + // This member is required. + StatusList []types.ContactStatus + // Name of a ground station. GroundStation *string @@ -79,16 +89,6 @@ type ListContactsInput struct { // ARN of a satellite. SatelliteArn *string - - // Start time of a contact. - // - // This member is required. - StartTime *time.Time - - // Status of a contact reservation. - // - // This member is required. - StatusList []types.ContactStatus } // diff --git a/service/groundstation/api_op_UpdateMissionProfile.go b/service/groundstation/api_op_UpdateMissionProfile.go index a7838b6eac0..1072274636b 100644 --- a/service/groundstation/api_op_UpdateMissionProfile.go +++ b/service/groundstation/api_op_UpdateMissionProfile.go @@ -57,6 +57,11 @@ func (c *Client) UpdateMissionProfile(ctx context.Context, params *UpdateMission // type UpdateMissionProfileInput struct { + // UUID of a mission profile. + // + // This member is required. + MissionProfileId *string + // Amount of time after a contact ends that you’d like to receive a CloudWatch // event indicating the pass has finished. ContactPostPassDurationSeconds *int32 @@ -74,11 +79,6 @@ type UpdateMissionProfileInput struct { // duration. MinimumViableContactDurationSeconds *int32 - // UUID of a mission profile. - // - // This member is required. - MissionProfileId *string - // Name of a mission profile. Name *string diff --git a/service/groundstation/go.mod b/service/groundstation/go.mod index bbfce0f7d4b..b70be795ff1 100644 --- a/service/groundstation/go.mod +++ b/service/groundstation/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/groundstation go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/guardduty/api_op_CreateDetector.go b/service/guardduty/api_op_CreateDetector.go index 57dd8a00256..328474c657b 100644 --- a/service/guardduty/api_op_CreateDetector.go +++ b/service/guardduty/api_op_CreateDetector.go @@ -63,22 +63,22 @@ func (c *Client) CreateDetector(ctx context.Context, params *CreateDetectorInput type CreateDetectorInput struct { - // An object that describes which data sources will be enabled for the detector. - DataSources *types.DataSourceConfigurations + // A Boolean value that specifies whether the detector is to be enabled. + // + // This member is required. + Enable *bool // The idempotency token for the create request. ClientToken *string - // The tags to be added to a new detector resource. - Tags map[string]*string + // An object that describes which data sources will be enabled for the detector. + DataSources *types.DataSourceConfigurations // An enum value that specifies how frequently updated findings are exported. FindingPublishingFrequency types.FindingPublishingFrequency - // A Boolean value that specifies whether the detector is to be enabled. - // - // This member is required. - Enable *bool + // The tags to be added to a new detector resource. + Tags map[string]*string } type CreateDetectorOutput struct { diff --git a/service/guardduty/api_op_CreateFilter.go b/service/guardduty/api_op_CreateFilter.go index 84e6f108a61..5d3d9b97954 100644 --- a/service/guardduty/api_op_CreateFilter.go +++ b/service/guardduty/api_op_CreateFilter.go @@ -65,9 +65,6 @@ type CreateFilterInput struct { // This member is required. DetectorId *string - // The idempotency token for the create request. - ClientToken *string - // Represents the criteria to be used in the filter for querying findings. You can // only use the following attributes to query findings: // @@ -217,24 +214,27 @@ type CreateFilterInput struct { // This member is required. FindingCriteria *types.FindingCriteria - // The description of the filter. - Description *string + // The name of the filter. + // + // This member is required. + Name *string // Specifies the action that is to be applied to the findings that match the // filter. Action types.FilterAction - // The name of the filter. - // - // This member is required. - Name *string + // The idempotency token for the create request. + ClientToken *string - // The tags to be added to a new filter resource. - Tags map[string]*string + // The description of the filter. + Description *string // Specifies the position of the filter in the list of current filters. Also // specifies the order in which this filter is applied to the findings. Rank *int32 + + // The tags to be added to a new filter resource. + Tags map[string]*string } type CreateFilterOutput struct { diff --git a/service/guardduty/api_op_CreateIPSet.go b/service/guardduty/api_op_CreateIPSet.go index ed35d97372d..bc7975f588b 100644 --- a/service/guardduty/api_op_CreateIPSet.go +++ b/service/guardduty/api_op_CreateIPSet.go @@ -63,29 +63,29 @@ func (c *Client) CreateIPSet(ctx context.Context, params *CreateIPSetInput, optF type CreateIPSetInput struct { - // The format of the file that contains the IPSet. - // - // This member is required. - Format types.IpSetFormat - // A Boolean value that indicates whether GuardDuty is to start using the uploaded // IPSet. // // This member is required. Activate *bool - // The URI of the file that contains the IPSet. For example: - // https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key. - // - // This member is required. - Location *string - // The unique ID of the detector of the GuardDuty account that you want to create // an IPSet for. // // This member is required. DetectorId *string + // The format of the file that contains the IPSet. + // + // This member is required. + Format types.IpSetFormat + + // The URI of the file that contains the IPSet. For example: + // https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key. + // + // This member is required. + Location *string + // The user-friendly name to identify the IPSet. Allowed characters are // alphanumerics, spaces, hyphens (-), and underscores (_). // diff --git a/service/guardduty/api_op_CreatePublishingDestination.go b/service/guardduty/api_op_CreatePublishingDestination.go index ecc8acf8666..e8a164e2a5c 100644 --- a/service/guardduty/api_op_CreatePublishingDestination.go +++ b/service/guardduty/api_op_CreatePublishingDestination.go @@ -60,6 +60,12 @@ func (c *Client) CreatePublishingDestination(ctx context.Context, params *Create type CreatePublishingDestinationInput struct { + // The properties of the publishing destination, including the ARNs for the + // destination and the KMS key used for encryption. + // + // This member is required. + DestinationProperties *types.DestinationProperties + // The type of resource for the publishing destination. Currently only Amazon S3 // buckets are supported. // @@ -73,12 +79,6 @@ type CreatePublishingDestinationInput struct { // The idempotency token for the request. ClientToken *string - - // The properties of the publishing destination, including the ARNs for the - // destination and the KMS key used for encryption. - // - // This member is required. - DestinationProperties *types.DestinationProperties } type CreatePublishingDestinationOutput struct { diff --git a/service/guardduty/api_op_CreateThreatIntelSet.go b/service/guardduty/api_op_CreateThreatIntelSet.go index 6659d0b508e..9c86b43570d 100644 --- a/service/guardduty/api_op_CreateThreatIntelSet.go +++ b/service/guardduty/api_op_CreateThreatIntelSet.go @@ -61,40 +61,40 @@ func (c *Client) CreateThreatIntelSet(ctx context.Context, params *CreateThreatI type CreateThreatIntelSetInput struct { - // The idempotency token for the create request. - ClientToken *string - - // The URI of the file that contains the ThreatIntelSet. For example: - // https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key. + // A Boolean value that indicates whether GuardDuty is to start using the uploaded + // ThreatIntelSet. // // This member is required. - Location *string - - // The tags to be added to a new threat list resource. - Tags map[string]*string + Activate *bool - // A user-friendly ThreatIntelSet name displayed in all findings that are generated - // by activity that involves IP addresses included in this ThreatIntelSet. + // The unique ID of the detector of the GuardDuty account that you want to create a + // threatIntelSet for. // // This member is required. - Name *string + DetectorId *string // The format of the file that contains the ThreatIntelSet. // // This member is required. Format types.ThreatIntelSetFormat - // The unique ID of the detector of the GuardDuty account that you want to create a - // threatIntelSet for. + // The URI of the file that contains the ThreatIntelSet. For example: + // https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key. // // This member is required. - DetectorId *string + Location *string - // A Boolean value that indicates whether GuardDuty is to start using the uploaded - // ThreatIntelSet. + // A user-friendly ThreatIntelSet name displayed in all findings that are generated + // by activity that involves IP addresses included in this ThreatIntelSet. // // This member is required. - Activate *bool + Name *string + + // The idempotency token for the create request. + ClientToken *string + + // The tags to be added to a new threat list resource. + Tags map[string]*string } type CreateThreatIntelSetOutput struct { diff --git a/service/guardduty/api_op_DeleteMembers.go b/service/guardduty/api_op_DeleteMembers.go index eef145b0fdb..be618e7c4a1 100644 --- a/service/guardduty/api_op_DeleteMembers.go +++ b/service/guardduty/api_op_DeleteMembers.go @@ -58,16 +58,16 @@ func (c *Client) DeleteMembers(ctx context.Context, params *DeleteMembersInput, type DeleteMembersInput struct { - // The unique ID of the detector of the GuardDuty account whose members you want to - // delete. + // A list of account IDs of the GuardDuty member accounts that you want to delete. // // This member is required. - DetectorId *string + AccountIds []*string - // A list of account IDs of the GuardDuty member accounts that you want to delete. + // The unique ID of the detector of the GuardDuty account whose members you want to + // delete. // // This member is required. - AccountIds []*string + DetectorId *string } type DeleteMembersOutput struct { diff --git a/service/guardduty/api_op_DescribeOrganizationConfiguration.go b/service/guardduty/api_op_DescribeOrganizationConfiguration.go index 1ffe631ef50..f72e02b041b 100644 --- a/service/guardduty/api_op_DescribeOrganizationConfiguration.go +++ b/service/guardduty/api_op_DescribeOrganizationConfiguration.go @@ -73,16 +73,16 @@ type DescribeOrganizationConfigurationOutput struct { // This member is required. AutoEnable *bool - // An object that describes which data sources are enabled automatically for member - // accounts. - DataSources *types.OrganizationDataSourceConfigurationsResult - // Indicates whether the maximum number of allowed member accounts are already // associated with the delegated administrator master account. // // This member is required. MemberAccountLimitReached *bool + // An object that describes which data sources are enabled automatically for member + // accounts. + DataSources *types.OrganizationDataSourceConfigurationsResult + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/guardduty/api_op_DescribePublishingDestination.go b/service/guardduty/api_op_DescribePublishingDestination.go index c505d08b6e5..2ed33a11075 100644 --- a/service/guardduty/api_op_DescribePublishingDestination.go +++ b/service/guardduty/api_op_DescribePublishingDestination.go @@ -77,17 +77,6 @@ type DescribePublishingDestinationOutput struct { // This member is required. DestinationId *string - // The time, in epoch millisecond format, at which GuardDuty was first unable to - // publish findings to the destination. - // - // This member is required. - PublishingFailureStartTimestamp *int64 - - // The status of the publishing destination. - // - // This member is required. - Status types.PublishingStatus - // A DestinationProperties object that includes the DestinationArn and KmsKeyArn of // the publishing destination. // @@ -100,6 +89,17 @@ type DescribePublishingDestinationOutput struct { // This member is required. DestinationType types.DestinationType + // The time, in epoch millisecond format, at which GuardDuty was first unable to + // publish findings to the destination. + // + // This member is required. + PublishingFailureStartTimestamp *int64 + + // The status of the publishing destination. + // + // This member is required. + Status types.PublishingStatus + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/guardduty/api_op_GetDetector.go b/service/guardduty/api_op_GetDetector.go index d83e957c32a..4d15d0b9f3f 100644 --- a/service/guardduty/api_op_GetDetector.go +++ b/service/guardduty/api_op_GetDetector.go @@ -65,18 +65,6 @@ type GetDetectorInput struct { type GetDetectorOutput struct { - // The last-updated timestamp for the detector. - UpdatedAt *string - - // The timestamp of when the detector was created. - CreatedAt *string - - // The tags of the detector resource. - Tags map[string]*string - - // An object that describes which data sources are enabled for the detector. - DataSources *types.DataSourceConfigurationsResult - // The GuardDuty service role. // // This member is required. @@ -87,9 +75,21 @@ type GetDetectorOutput struct { // This member is required. Status types.DetectorStatus + // The timestamp of when the detector was created. + CreatedAt *string + + // An object that describes which data sources are enabled for the detector. + DataSources *types.DataSourceConfigurationsResult + // The publishing frequency of the finding. FindingPublishingFrequency types.FindingPublishingFrequency + // The tags of the detector resource. + Tags map[string]*string + + // The last-updated timestamp for the detector. + UpdatedAt *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/guardduty/api_op_GetFilter.go b/service/guardduty/api_op_GetFilter.go index 5d78459c5bf..01244879e74 100644 --- a/service/guardduty/api_op_GetFilter.go +++ b/service/guardduty/api_op_GetFilter.go @@ -57,26 +57,18 @@ func (c *Client) GetFilter(ctx context.Context, params *GetFilterInput, optFns . type GetFilterInput struct { - // The name of the filter you want to get. - // - // This member is required. - FilterName *string - // The unique ID of the detector that the filter is associated with. // // This member is required. DetectorId *string -} - -type GetFilterOutput struct { - // Represents the criteria to be used in the filter for querying findings. + // The name of the filter you want to get. // // This member is required. - FindingCriteria *types.FindingCriteria + FilterName *string +} - // The description of the filter. - Description *string +type GetFilterOutput struct { // Specifies the action that is to be applied to the findings that match the // filter. @@ -84,18 +76,26 @@ type GetFilterOutput struct { // This member is required. Action types.FilterAction + // Represents the criteria to be used in the filter for querying findings. + // + // This member is required. + FindingCriteria *types.FindingCriteria + // The name of the filter. // // This member is required. Name *string - // The tags of the filter resource. - Tags map[string]*string + // The description of the filter. + Description *string // Specifies the position of the filter in the list of current filters. Also // specifies the order in which this filter is applied to the findings. Rank *int32 + // The tags of the filter resource. + Tags map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/guardduty/api_op_GetFindings.go b/service/guardduty/api_op_GetFindings.go index 6886db7da5b..24f3f1723e9 100644 --- a/service/guardduty/api_op_GetFindings.go +++ b/service/guardduty/api_op_GetFindings.go @@ -57,19 +57,19 @@ func (c *Client) GetFindings(ctx context.Context, params *GetFindingsInput, optF type GetFindingsInput struct { - // Represents the criteria used for sorting findings. - SortCriteria *types.SortCriteria + // The ID of the detector that specifies the GuardDuty service whose findings you + // want to retrieve. + // + // This member is required. + DetectorId *string // The IDs of the findings that you want to retrieve. // // This member is required. FindingIds []*string - // The ID of the detector that specifies the GuardDuty service whose findings you - // want to retrieve. - // - // This member is required. - DetectorId *string + // Represents the criteria used for sorting findings. + SortCriteria *types.SortCriteria } type GetFindingsOutput struct { diff --git a/service/guardduty/api_op_GetIPSet.go b/service/guardduty/api_op_GetIPSet.go index f86e5a2b56f..0add0fd244a 100644 --- a/service/guardduty/api_op_GetIPSet.go +++ b/service/guardduty/api_op_GetIPSet.go @@ -70,29 +70,29 @@ type GetIPSetInput struct { type GetIPSetOutput struct { - // The URI of the file that contains the IPSet. For example: - // https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key. + // The format of the file that contains the IPSet. // // This member is required. - Location *string + Format types.IpSetFormat - // The status of IPSet file that was uploaded. + // The URI of the file that contains the IPSet. For example: + // https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key. // // This member is required. - Status types.IpSetStatus - - // The tags of the IPSet resource. - Tags map[string]*string + Location *string // The user-friendly name for the IPSet. // // This member is required. Name *string - // The format of the file that contains the IPSet. + // The status of IPSet file that was uploaded. // // This member is required. - Format types.IpSetFormat + Status types.IpSetStatus + + // The tags of the IPSet resource. + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/guardduty/api_op_GetMemberDetectors.go b/service/guardduty/api_op_GetMemberDetectors.go index 95f4ef72610..6b3a69d3cdf 100644 --- a/service/guardduty/api_op_GetMemberDetectors.go +++ b/service/guardduty/api_op_GetMemberDetectors.go @@ -57,29 +57,29 @@ func (c *Client) GetMemberDetectors(ctx context.Context, params *GetMemberDetect type GetMemberDetectorsInput struct { - // The detector ID for the master account. + // The account ID of the member account. // // This member is required. - DetectorId *string + AccountIds []*string - // The account ID of the member account. + // The detector ID for the master account. // // This member is required. - AccountIds []*string + DetectorId *string } type GetMemberDetectorsOutput struct { - // A list of member account IDs that were unable to be processed along with an - // explanation for why they were not processed. + // An object that describes which data sources are enabled for a member account. // // This member is required. - UnprocessedAccounts []*types.UnprocessedAccount + MemberDataSourceConfigurations []*types.MemberDataSourceConfiguration - // An object that describes which data sources are enabled for a member account. + // A list of member account IDs that were unable to be processed along with an + // explanation for why they were not processed. // // This member is required. - MemberDataSourceConfigurations []*types.MemberDataSourceConfiguration + UnprocessedAccounts []*types.UnprocessedAccount // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/guardduty/api_op_GetMembers.go b/service/guardduty/api_op_GetMembers.go index 9c0b8709e6f..16eca215009 100644 --- a/service/guardduty/api_op_GetMembers.go +++ b/service/guardduty/api_op_GetMembers.go @@ -58,17 +58,17 @@ func (c *Client) GetMembers(ctx context.Context, params *GetMembersInput, optFns type GetMembersInput struct { - // The unique ID of the detector of the GuardDuty account whose members you want to - // retrieve. - // - // This member is required. - DetectorId *string - // A list of account IDs of the GuardDuty member accounts that you want to // describe. // // This member is required. AccountIds []*string + + // The unique ID of the detector of the GuardDuty account whose members you want to + // retrieve. + // + // This member is required. + DetectorId *string } type GetMembersOutput struct { diff --git a/service/guardduty/api_op_GetThreatIntelSet.go b/service/guardduty/api_op_GetThreatIntelSet.go index 9a049bab23c..a839c13e09d 100644 --- a/service/guardduty/api_op_GetThreatIntelSet.go +++ b/service/guardduty/api_op_GetThreatIntelSet.go @@ -57,40 +57,40 @@ func (c *Client) GetThreatIntelSet(ctx context.Context, params *GetThreatIntelSe type GetThreatIntelSetInput struct { - // The unique ID of the threatIntelSet that you want to get. + // The unique ID of the detector that the threatIntelSet is associated with. // // This member is required. - ThreatIntelSetId *string + DetectorId *string - // The unique ID of the detector that the threatIntelSet is associated with. + // The unique ID of the threatIntelSet that you want to get. // // This member is required. - DetectorId *string + ThreatIntelSetId *string } type GetThreatIntelSetOutput struct { - // A user-friendly ThreatIntelSet name displayed in all findings that are generated - // by activity that involves IP addresses included in this ThreatIntelSet. + // The format of the threatIntelSet. // // This member is required. - Name *string + Format types.ThreatIntelSetFormat - // The format of the threatIntelSet. + // The URI of the file that contains the ThreatIntelSet. For example: + // https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key. // // This member is required. - Format types.ThreatIntelSetFormat + Location *string - // The status of threatIntelSet file uploaded. + // A user-friendly ThreatIntelSet name displayed in all findings that are generated + // by activity that involves IP addresses included in this ThreatIntelSet. // // This member is required. - Status types.ThreatIntelSetStatus + Name *string - // The URI of the file that contains the ThreatIntelSet. For example: - // https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key. + // The status of threatIntelSet file uploaded. // // This member is required. - Location *string + Status types.ThreatIntelSetStatus // The tags of the threat list resource. Tags map[string]*string diff --git a/service/guardduty/api_op_GetUsageStatistics.go b/service/guardduty/api_op_GetUsageStatistics.go index f931775822e..433bd20bd76 100644 --- a/service/guardduty/api_op_GetUsageStatistics.go +++ b/service/guardduty/api_op_GetUsageStatistics.go @@ -63,6 +63,12 @@ func (c *Client) GetUsageStatistics(ctx context.Context, params *GetUsageStatist type GetUsageStatisticsInput struct { + // The ID of the detector that specifies the GuardDuty service whose usage + // statistics you want to retrieve. + // + // This member is required. + DetectorId *string + // Represents the criteria used for querying usage. // // This member is required. @@ -73,16 +79,6 @@ type GetUsageStatisticsInput struct { // This member is required. UsageStatisticType types.UsageStatisticType - // The ID of the detector that specifies the GuardDuty service whose usage - // statistics you want to retrieve. - // - // This member is required. - DetectorId *string - - // The currency unit you would like to view your usage statistics in. Current valid - // values are USD. - Unit *string - // The maximum number of results to return in the response. MaxResults *int32 @@ -91,6 +87,10 @@ type GetUsageStatisticsInput struct { // subsequent calls, use the NextToken value returned from the previous request to // continue listing results after the first page. NextToken *string + + // The currency unit you would like to view your usage statistics in. Current valid + // values are USD. + Unit *string } type GetUsageStatisticsOutput struct { diff --git a/service/guardduty/api_op_InviteMembers.go b/service/guardduty/api_op_InviteMembers.go index 7fb6a4687d0..e2510362137 100644 --- a/service/guardduty/api_op_InviteMembers.go +++ b/service/guardduty/api_op_InviteMembers.go @@ -60,14 +60,6 @@ func (c *Client) InviteMembers(ctx context.Context, params *InviteMembersInput, type InviteMembersInput struct { - // A Boolean value that specifies whether you want to disable email notification to - // the accounts that you are inviting to GuardDuty as members. - DisableEmailNotification *bool - - // The invitation message that you want to send to the accounts that you're - // inviting to GuardDuty as members. - Message *string - // A list of account IDs of the accounts that you want to invite to GuardDuty as // members. // @@ -79,6 +71,14 @@ type InviteMembersInput struct { // // This member is required. DetectorId *string + + // A Boolean value that specifies whether you want to disable email notification to + // the accounts that you are inviting to GuardDuty as members. + DisableEmailNotification *bool + + // The invitation message that you want to send to the accounts that you're + // inviting to GuardDuty as members. + Message *string } type InviteMembersOutput struct { diff --git a/service/guardduty/api_op_ListFindings.go b/service/guardduty/api_op_ListFindings.go index d2a09eb5da8..185da9306fd 100644 --- a/service/guardduty/api_op_ListFindings.go +++ b/service/guardduty/api_op_ListFindings.go @@ -63,16 +63,6 @@ type ListFindingsInput struct { // This member is required. DetectorId *string - // You can use this parameter to indicate the maximum number of items you want in - // the response. The default value is 50. The maximum value is 50. - MaxResults *int32 - - // You can use this parameter when paginating results. Set the value of this - // parameter to null on your first call to the list action. For subsequent calls to - // the action, fill nextToken in the request with the value of NextToken from the - // previous response to continue listing data. - NextToken *string - // Represents the criteria used for querying findings. Valid values include: // // * @@ -215,6 +205,16 @@ type ListFindingsInput struct { // 1486685375000 FindingCriteria *types.FindingCriteria + // You can use this parameter to indicate the maximum number of items you want in + // the response. The default value is 50. The maximum value is 50. + MaxResults *int32 + + // You can use this parameter when paginating results. Set the value of this + // parameter to null on your first call to the list action. For subsequent calls to + // the action, fill nextToken in the request with the value of NextToken from the + // previous response to continue listing data. + NextToken *string + // Represents the criteria used for sorting findings. SortCriteria *types.SortCriteria } diff --git a/service/guardduty/api_op_ListIPSets.go b/service/guardduty/api_op_ListIPSets.go index 9cb2520b841..c95c9a7ac01 100644 --- a/service/guardduty/api_op_ListIPSets.go +++ b/service/guardduty/api_op_ListIPSets.go @@ -63,28 +63,28 @@ type ListIPSetsInput struct { // This member is required. DetectorId *string + // You can use this parameter to indicate the maximum number of items you want in + // the response. The default value is 50. The maximum value is 50. + MaxResults *int32 + // You can use this parameter when paginating results. Set the value of this // parameter to null on your first call to the list action. For subsequent calls to // the action, fill nextToken in the request with the value of NextToken from the // previous response to continue listing data. NextToken *string - - // You can use this parameter to indicate the maximum number of items you want in - // the response. The default value is 50. The maximum value is 50. - MaxResults *int32 } type ListIPSetsOutput struct { - // The pagination parameter to be used on the next list operation to retrieve more - // items. - NextToken *string - // The IDs of the IPSet resources. // // This member is required. IpSetIds []*string + // The pagination parameter to be used on the next list operation to retrieve more + // items. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/guardduty/api_op_ListInvitations.go b/service/guardduty/api_op_ListInvitations.go index 98ecdbb1fe0..ab3368d2edf 100644 --- a/service/guardduty/api_op_ListInvitations.go +++ b/service/guardduty/api_op_ListInvitations.go @@ -57,26 +57,26 @@ func (c *Client) ListInvitations(ctx context.Context, params *ListInvitationsInp type ListInvitationsInput struct { + // You can use this parameter to indicate the maximum number of items that you want + // in the response. The default value is 50. The maximum value is 50. + MaxResults *int32 + // You can use this parameter when paginating results. Set the value of this // parameter to null on your first call to the list action. For subsequent calls to // the action, fill nextToken in the request with the value of NextToken from the // previous response to continue listing data. NextToken *string - - // You can use this parameter to indicate the maximum number of items that you want - // in the response. The default value is 50. The maximum value is 50. - MaxResults *int32 } type ListInvitationsOutput struct { + // A list of invitation descriptions. + Invitations []*types.Invitation + // The pagination parameter to be used on the next list operation to retrieve more // items. NextToken *string - // A list of invitation descriptions. - Invitations []*types.Invitation - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/guardduty/api_op_ListMembers.go b/service/guardduty/api_op_ListMembers.go index cf69f96a061..816d4a546c9 100644 --- a/service/guardduty/api_op_ListMembers.go +++ b/service/guardduty/api_op_ListMembers.go @@ -58,15 +58,15 @@ func (c *Client) ListMembers(ctx context.Context, params *ListMembersInput, optF type ListMembersInput struct { - // You can use this parameter to indicate the maximum number of items you want in - // the response. The default value is 50. The maximum value is 50. - MaxResults *int32 - // The unique ID of the detector the member is associated with. // // This member is required. DetectorId *string + // You can use this parameter to indicate the maximum number of items you want in + // the response. The default value is 50. The maximum value is 50. + MaxResults *int32 + // You can use this parameter when paginating results. Set the value of this // parameter to null on your first call to the list action. For subsequent calls to // the action, fill nextToken in the request with the value of NextToken from the @@ -80,13 +80,13 @@ type ListMembersInput struct { type ListMembersOutput struct { + // A list of members. + Members []*types.Member + // The pagination parameter to be used on the next list operation to retrieve more // items. NextToken *string - // A list of members. - Members []*types.Member - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/guardduty/api_op_ListOrganizationAdminAccounts.go b/service/guardduty/api_op_ListOrganizationAdminAccounts.go index 61944618b45..42e926df82f 100644 --- a/service/guardduty/api_op_ListOrganizationAdminAccounts.go +++ b/service/guardduty/api_op_ListOrganizationAdminAccounts.go @@ -68,14 +68,14 @@ type ListOrganizationAdminAccountsInput struct { type ListOrganizationAdminAccountsOutput struct { - // The pagination parameter to be used on the next list operation to retrieve more - // items. - NextToken *string - // An AdminAccounts object that includes a list of accounts configured as GuardDuty // delegated administrators. AdminAccounts []*types.AdminAccount + // The pagination parameter to be used on the next list operation to retrieve more + // items. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/guardduty/api_op_ListThreatIntelSets.go b/service/guardduty/api_op_ListThreatIntelSets.go index d1644f1a646..cdee224357e 100644 --- a/service/guardduty/api_op_ListThreatIntelSets.go +++ b/service/guardduty/api_op_ListThreatIntelSets.go @@ -58,12 +58,6 @@ func (c *Client) ListThreatIntelSets(ctx context.Context, params *ListThreatInte type ListThreatIntelSetsInput struct { - // You can use this parameter to paginate results in the response. Set the value of - // this parameter to null on your first call to the list action. For subsequent - // calls to the action, fill nextToken in the request with the value of NextToken - // from the previous response to continue listing data. - NextToken *string - // The unique ID of the detector that the threatIntelSet is associated with. // // This member is required. @@ -72,6 +66,12 @@ type ListThreatIntelSetsInput struct { // You can use this parameter to indicate the maximum number of items that you want // in the response. The default value is 50. The maximum value is 50. MaxResults *int32 + + // You can use this parameter to paginate results in the response. Set the value of + // this parameter to null on your first call to the list action. For subsequent + // calls to the action, fill nextToken in the request with the value of NextToken + // from the previous response to continue listing data. + NextToken *string } type ListThreatIntelSetsOutput struct { diff --git a/service/guardduty/api_op_UnarchiveFindings.go b/service/guardduty/api_op_UnarchiveFindings.go index 059aaba6b33..ecf73577fc8 100644 --- a/service/guardduty/api_op_UnarchiveFindings.go +++ b/service/guardduty/api_op_UnarchiveFindings.go @@ -56,15 +56,15 @@ func (c *Client) UnarchiveFindings(ctx context.Context, params *UnarchiveFinding type UnarchiveFindingsInput struct { - // The IDs of the findings to unarchive. + // The ID of the detector associated with the findings to unarchive. // // This member is required. - FindingIds []*string + DetectorId *string - // The ID of the detector associated with the findings to unarchive. + // The IDs of the findings to unarchive. // // This member is required. - DetectorId *string + FindingIds []*string } type UnarchiveFindingsOutput struct { diff --git a/service/guardduty/api_op_UntagResource.go b/service/guardduty/api_op_UntagResource.go index ab97a7323ab..de8d463448e 100644 --- a/service/guardduty/api_op_UntagResource.go +++ b/service/guardduty/api_op_UntagResource.go @@ -56,15 +56,15 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The tag keys to remove from the resource. + // The Amazon Resource Name (ARN) for the resource to remove tags from. // // This member is required. - TagKeys []*string + ResourceArn *string - // The Amazon Resource Name (ARN) for the resource to remove tags from. + // The tag keys to remove from the resource. // // This member is required. - ResourceArn *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/guardduty/api_op_UpdateDetector.go b/service/guardduty/api_op_UpdateDetector.go index 641e72f5886..1fb8d671ab2 100644 --- a/service/guardduty/api_op_UpdateDetector.go +++ b/service/guardduty/api_op_UpdateDetector.go @@ -57,14 +57,14 @@ func (c *Client) UpdateDetector(ctx context.Context, params *UpdateDetectorInput type UpdateDetectorInput struct { - // An object that describes which data sources will be updated. - DataSources *types.DataSourceConfigurations - // The unique ID of the detector to update. // // This member is required. DetectorId *string + // An object that describes which data sources will be updated. + DataSources *types.DataSourceConfigurations + // Specifies whether the detector is enabled or not enabled. Enable *bool diff --git a/service/guardduty/api_op_UpdateFilter.go b/service/guardduty/api_op_UpdateFilter.go index 6fb8ebd1462..ce4232cb3d9 100644 --- a/service/guardduty/api_op_UpdateFilter.go +++ b/service/guardduty/api_op_UpdateFilter.go @@ -57,19 +57,17 @@ func (c *Client) UpdateFilter(ctx context.Context, params *UpdateFilterInput, op type UpdateFilterInput struct { - // Represents the criteria to be used in the filter for querying findings. - FindingCriteria *types.FindingCriteria - - // Specifies the position of the filter in the list of current filters. Also - // specifies the order in which this filter is applied to the findings. - Rank *int32 - // The unique ID of the detector that specifies the GuardDuty service where you // want to update a filter. // // This member is required. DetectorId *string + // The name of the filter. + // + // This member is required. + FilterName *string + // Specifies the action that is to be applied to the findings that match the // filter. Action types.FilterAction @@ -77,10 +75,12 @@ type UpdateFilterInput struct { // The description of the filter. Description *string - // The name of the filter. - // - // This member is required. - FilterName *string + // Represents the criteria to be used in the filter for querying findings. + FindingCriteria *types.FindingCriteria + + // Specifies the position of the filter in the list of current filters. Also + // specifies the order in which this filter is applied to the findings. + Rank *int32 } type UpdateFilterOutput struct { diff --git a/service/guardduty/api_op_UpdateFindingsFeedback.go b/service/guardduty/api_op_UpdateFindingsFeedback.go index c9ee6336fc1..235d9a9d077 100644 --- a/service/guardduty/api_op_UpdateFindingsFeedback.go +++ b/service/guardduty/api_op_UpdateFindingsFeedback.go @@ -62,15 +62,15 @@ type UpdateFindingsFeedbackInput struct { // This member is required. DetectorId *string - // The IDs of the findings that you want to mark as useful or not useful. + // The feedback for the finding. // // This member is required. - FindingIds []*string + Feedback types.Feedback - // The feedback for the finding. + // The IDs of the findings that you want to mark as useful or not useful. // // This member is required. - Feedback types.Feedback + FindingIds []*string // Additional feedback about the GuardDuty findings. Comments *string diff --git a/service/guardduty/api_op_UpdateIPSet.go b/service/guardduty/api_op_UpdateIPSet.go index 6806cf49c0e..a1553718f0f 100644 --- a/service/guardduty/api_op_UpdateIPSet.go +++ b/service/guardduty/api_op_UpdateIPSet.go @@ -56,8 +56,11 @@ func (c *Client) UpdateIPSet(ctx context.Context, params *UpdateIPSetInput, optF type UpdateIPSetInput struct { - // The unique ID that specifies the IPSet that you want to update. - Name *string + // The detectorID that specifies the GuardDuty service whose IPSet you want to + // update. + // + // This member is required. + DetectorId *string // The unique ID that specifies the IPSet that you want to update. // @@ -67,15 +70,12 @@ type UpdateIPSetInput struct { // The updated Boolean value that specifies whether the IPSet is active or not. Activate *bool - // The detectorID that specifies the GuardDuty service whose IPSet you want to - // update. - // - // This member is required. - DetectorId *string - // The updated URI of the file that contains the IPSet. For example: // https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key. Location *string + + // The unique ID that specifies the IPSet that you want to update. + Name *string } type UpdateIPSetOutput struct { diff --git a/service/guardduty/api_op_UpdateOrganizationConfiguration.go b/service/guardduty/api_op_UpdateOrganizationConfiguration.go index 6c712248333..97da5c19472 100644 --- a/service/guardduty/api_op_UpdateOrganizationConfiguration.go +++ b/service/guardduty/api_op_UpdateOrganizationConfiguration.go @@ -57,15 +57,15 @@ func (c *Client) UpdateOrganizationConfiguration(ctx context.Context, params *Up type UpdateOrganizationConfigurationInput struct { - // The ID of the detector to update the delegated administrator for. + // Indicates whether to automatically enable member accounts in the organization. // // This member is required. - DetectorId *string + AutoEnable *bool - // Indicates whether to automatically enable member accounts in the organization. + // The ID of the detector to update the delegated administrator for. // // This member is required. - AutoEnable *bool + DetectorId *string // An object describes which data sources will be updated. DataSources *types.OrganizationDataSourceConfigurations diff --git a/service/guardduty/api_op_UpdatePublishingDestination.go b/service/guardduty/api_op_UpdatePublishingDestination.go index bcbb95e25ea..4725136f6fd 100644 --- a/service/guardduty/api_op_UpdatePublishingDestination.go +++ b/service/guardduty/api_op_UpdatePublishingDestination.go @@ -58,10 +58,6 @@ func (c *Client) UpdatePublishingDestination(ctx context.Context, params *Update type UpdatePublishingDestinationInput struct { - // A DestinationProperties object that includes the DestinationArn and KmsKeyArn of - // the publishing destination. - DestinationProperties *types.DestinationProperties - // The ID of the publishing destination to update. // // This member is required. @@ -71,6 +67,10 @@ type UpdatePublishingDestinationInput struct { // // This member is required. DetectorId *string + + // A DestinationProperties object that includes the DestinationArn and KmsKeyArn of + // the publishing destination. + DestinationProperties *types.DestinationProperties } type UpdatePublishingDestinationOutput struct { diff --git a/service/guardduty/api_op_UpdateThreatIntelSet.go b/service/guardduty/api_op_UpdateThreatIntelSet.go index 146c838513a..c9c64bbbbfb 100644 --- a/service/guardduty/api_op_UpdateThreatIntelSet.go +++ b/service/guardduty/api_op_UpdateThreatIntelSet.go @@ -56,27 +56,27 @@ func (c *Client) UpdateThreatIntelSet(ctx context.Context, params *UpdateThreatI type UpdateThreatIntelSetInput struct { - // The updated Boolean value that specifies whether the ThreateIntelSet is active - // or not. - Activate *bool - - // The unique ID that specifies the ThreatIntelSet that you want to update. + // The detectorID that specifies the GuardDuty service whose ThreatIntelSet you + // want to update. // // This member is required. - ThreatIntelSetId *string + DetectorId *string // The unique ID that specifies the ThreatIntelSet that you want to update. - Name *string - - // The detectorID that specifies the GuardDuty service whose ThreatIntelSet you - // want to update. // // This member is required. - DetectorId *string + ThreatIntelSetId *string + + // The updated Boolean value that specifies whether the ThreateIntelSet is active + // or not. + Activate *bool // The updated URI of the file that contains the ThreateIntelSet. For example: // https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key. Location *string + + // The unique ID that specifies the ThreatIntelSet that you want to update. + Name *string } type UpdateThreatIntelSetOutput struct { diff --git a/service/guardduty/go.mod b/service/guardduty/go.mod index 9e0957ae2e9..36a1cf9d5a1 100644 --- a/service/guardduty/go.mod +++ b/service/guardduty/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/guardduty go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/guardduty/types/types.go b/service/guardduty/types/types.go index fdb4867ca42..cdc44b66aca 100644 --- a/service/guardduty/types/types.go +++ b/service/guardduty/types/types.go @@ -21,31 +21,31 @@ type AccessControlList struct { // Contains information about the access keys. type AccessKeyDetails struct { + // The access key ID of the user. + AccessKeyId *string + + // The principal ID of the user. + PrincipalId *string + // The name of the user. UserName *string // The type of the user. UserType *string - - // The principal ID of the user. - PrincipalId *string - - // The access key ID of the user. - AccessKeyId *string } // Contains information about the account. type AccountDetail struct { - // The email address of the member account. + // The member account ID. // // This member is required. - Email *string + AccountId *string - // The member account ID. + // The email address of the member account. // // This member is required. - AccountId *string + Email *string } // Contains information about the account level permissions on the S3 bucket. @@ -58,50 +58,50 @@ type AccountLevelPermissions struct { // Contains information about actions. type Action struct { + // The GuardDuty finding activity type. + ActionType *string + // Information about the AWS_API_CALL action described in this finding. AwsApiCallAction *AwsApiCallAction + // Information about the DNS_REQUEST action described in this finding. + DnsRequestAction *DnsRequestAction + // Information about the NETWORK_CONNECTION action described in this finding. NetworkConnectionAction *NetworkConnectionAction // Information about the PORT_PROBE action described in this finding. PortProbeAction *PortProbeAction - - // The GuardDuty finding activity type. - ActionType *string - - // Information about the DNS_REQUEST action described in this finding. - DnsRequestAction *DnsRequestAction } // The account within the organization specified as the GuardDuty delegated // administrator. type AdminAccount struct { - // Indicates whether the account is enabled as the delegated administrator. - AdminStatus AdminStatus - // The AWS account ID for the account. AdminAccountId *string + + // Indicates whether the account is enabled as the delegated administrator. + AdminStatus AdminStatus } // Contains information about the API operation. type AwsApiCallAction struct { - // The remote IP information of the connection. - RemoteIpDetails *RemoteIpDetails - - // The AWS service name whose API was invoked. - ServiceName *string + // The AWS API name. + Api *string // The AWS API caller type. CallerType *string - // The AWS API name. - Api *string - // The domain information for the AWS API call. DomainDetails *DomainDetails + + // The remote IP information of the connection. + RemoteIpDetails *RemoteIpDetails + + // The AWS service name whose API was invoked. + ServiceName *string } // Contains information on how the bucker owner's S3 Block Public Access settings @@ -110,17 +110,17 @@ type AwsApiCallAction struct { // for more information. type BlockPublicAccess struct { - // Indicates if S3 Block Public Access is set to BlockPublicPolicy. - BlockPublicPolicy *bool - - // Indicates if S3 Block Public Access is set to RestrictPublicBuckets. - RestrictPublicBuckets *bool - // Indicates if S3 Block Public Access is set to BlockPublicAcls. BlockPublicAcls *bool + // Indicates if S3 Block Public Access is set to BlockPublicPolicy. + BlockPublicPolicy *bool + // Indicates if S3 Block Public Access is set to IgnorePublicAcls. IgnorePublicAcls *bool + + // Indicates if S3 Block Public Access is set to RestrictPublicBuckets. + RestrictPublicBuckets *bool } // Contains information about the bucket level permissions for the S3 bucket. @@ -129,12 +129,12 @@ type BucketLevelPermissions struct { // Contains information on how Access Control Policies are applied to the bucket. AccessControlList *AccessControlList - // Contains information on the bucket policies for the S3 bucket. - BucketPolicy *BucketPolicy - // Contains information on which account level S3 Block Public Access settings are // applied to the S3 bucket. BlockPublicAccess *BlockPublicAccess + + // Contains information on the bucket policies for the S3 bucket. + BucketPolicy *BucketPolicy } // Contains information on the current bucket policies for the S3 bucket. @@ -169,63 +169,63 @@ type CloudTrailConfigurationResult struct { // Contains information about the condition. type Condition struct { + // Represents the equal condition to be applied to a single field when querying for + // findings. + Eq []*string + + // Represents an equal condition to be applied to a single field when querying for + // findings. + Equals []*string + + // Represents a greater than condition to be applied to a single field when + // querying for findings. + GreaterThan *int64 + // Represents a greater than or equal condition to be applied to a single field // when querying for findings. - Gte *int32 + GreaterThanOrEqual *int64 - // Represents a less than condition to be applied to a single field when querying - // for findings. - Lt *int32 + // Represents a greater than condition to be applied to a single field when + // querying for findings. + Gt *int32 // Represents a greater than or equal condition to be applied to a single field // when querying for findings. - GreaterThanOrEqual *int64 + Gte *int32 - // Represents the not equal condition to be applied to a single field when querying + // Represents a less than condition to be applied to a single field when querying // for findings. - Neq []*string + LessThan *int64 // Represents a less than or equal condition to be applied to a single field when // querying for findings. LessThanOrEqual *int64 - // Represents the equal condition to be applied to a single field when querying for - // findings. - Eq []*string - - // Represents an equal condition to be applied to a single field when querying for - // findings. - Equals []*string - - // Represents a greater than condition to be applied to a single field when - // querying for findings. - Gt *int32 - - // Represents a not equal condition to be applied to a single field when querying + // Represents a less than condition to be applied to a single field when querying // for findings. - NotEquals []*string + Lt *int32 // Represents a less than or equal condition to be applied to a single field when // querying for findings. Lte *int32 - // Represents a greater than condition to be applied to a single field when - // querying for findings. - GreaterThan *int64 + // Represents the not equal condition to be applied to a single field when querying + // for findings. + Neq []*string - // Represents a less than condition to be applied to a single field when querying + // Represents a not equal condition to be applied to a single field when querying // for findings. - LessThan *int64 + NotEquals []*string } // Contains information about the country where the remote IP address is located. type Country struct { - // The country name of the remote IP address. - CountryName *string - // The country code of the remote IP address. CountryCode *string + + // The country name of the remote IP address. + CountryName *string } // Contains information about which data sources are enabled. @@ -268,22 +268,22 @@ type DataSourceConfigurationsResult struct { // more information. type DefaultServerSideEncryption struct { + // The type of encryption used for objects within the S3 bucket. + EncryptionType *string + // The Amazon Resource Name (ARN) of the KMS encryption key. Only available if the // bucket EncryptionType is aws:kms. KmsMasterKeyArn *string - - // The type of encryption used for objects within the S3 bucket. - EncryptionType *string } // Contains information about the publishing destination, including the ID, type, // and status. type Destination struct { - // The status of the publishing destination. + // The unique ID of the publishing destination. // // This member is required. - Status PublishingStatus + DestinationId *string // The type of resource used for the publishing destination. Currently, only Amazon // S3 buckets are supported. @@ -291,10 +291,10 @@ type Destination struct { // This member is required. DestinationType DestinationType - // The unique ID of the publishing destination. + // The status of the publishing destination. // // This member is required. - DestinationId *string + Status PublishingStatus } // Contains the Amazon Resource Name (ARN) of the resource to publish to, such as @@ -342,44 +342,30 @@ type Evidence struct { // suspicious activity is detected. type Finding struct { - // The type of finding. - // - // This member is required. - Type *string - - // Contains additional information about the generated finding. - Service *Service - // The ID of the account in which the finding was generated. // // This member is required. AccountId *string - // The confidence score for the finding. - Confidence *float64 - - // The version of the schema used for the finding. + // The ARN of the finding. // // This member is required. - SchemaVersion *string + Arn *string - // The severity of the finding. + // The time and date when the finding was created. // // This member is required. - Severity *float64 - - // The title of the finding. - Title *string + CreatedAt *string - // The Region where the finding was generated. + // The ID of the finding. // // This member is required. - Region *string + Id *string - // The time and date when the finding was last updated. + // The Region where the finding was generated. // // This member is required. - UpdatedAt *string + Region *string // Contains information about the AWS resource associated with the activity that // prompted GuardDuty to generate a finding. @@ -387,26 +373,40 @@ type Finding struct { // This member is required. Resource *Resource - // The partition associated with the finding. - Partition *string + // The version of the schema used for the finding. + // + // This member is required. + SchemaVersion *string - // The ARN of the finding. + // The severity of the finding. // // This member is required. - Arn *string + Severity *float64 - // The time and date when the finding was created. + // The type of finding. // // This member is required. - CreatedAt *string + Type *string + + // The time and date when the finding was last updated. + // + // This member is required. + UpdatedAt *string + + // The confidence score for the finding. + Confidence *float64 // The description of the finding. Description *string - // The ID of the finding. - // - // This member is required. - Id *string + // The partition associated with the finding. + Partition *string + + // Contains additional information about the generated finding. + Service *Service + + // The title of the finding. + Title *string } // Contains information about the criteria used for querying findings. @@ -436,73 +436,70 @@ type FlowLogsConfigurationResult struct { // Contains information about the location of the remote IP address. type GeoLocation struct { - // The longitude information of the remote IP address. - Lon *float64 - // The latitude information of the remote IP address. Lat *float64 + + // The longitude information of the remote IP address. + Lon *float64 } // Contains information about the EC2 instance profile. type IamInstanceProfile struct { - // The profile ID of the EC2 instance. - Id *string - // The profile ARN of the EC2 instance. Arn *string + + // The profile ID of the EC2 instance. + Id *string } // Contains information about the details of an instance. type InstanceDetails struct { - // The product code of the EC2 instance. - ProductCodes []*ProductCode - - // The image description of the EC2 instance. - ImageDescription *string + // The Availability Zone of the EC2 instance. + AvailabilityZone *string // The profile information of the EC2 instance. IamInstanceProfile *IamInstanceProfile - // The Amazon Resource Name (ARN) of the AWS Outpost. Only applicable to AWS - // Outposts instances. - OutpostArn *string + // The image description of the EC2 instance. + ImageDescription *string - // The Availability Zone of the EC2 instance. - AvailabilityZone *string + // The image ID of the EC2 instance. + ImageId *string - // The tags of the EC2 instance. - Tags []*Tag + // The ID of the EC2 instance. + InstanceId *string + + // The state of the EC2 instance. + InstanceState *string // The type of the EC2 instance. InstanceType *string - // The platform of the EC2 instance. - Platform *string - // The launch time of the EC2 instance. LaunchTime *string - // The state of the EC2 instance. - InstanceState *string - - // The image ID of the EC2 instance. - ImageId *string - // The elastic network interface information of the EC2 instance. NetworkInterfaces []*NetworkInterface - // The ID of the EC2 instance. - InstanceId *string + // The Amazon Resource Name (ARN) of the AWS Outpost. Only applicable to AWS + // Outposts instances. + OutpostArn *string + + // The platform of the EC2 instance. + Platform *string + + // The product code of the EC2 instance. + ProductCodes []*ProductCode + + // The tags of the EC2 instance. + Tags []*Tag } // Contains information about the invitation to become a member account. type Invitation struct { - // The timestamp when the invitation was sent. - InvitedAt *string - // The ID of the account that the invitation was sent from. AccountId *string @@ -510,6 +507,9 @@ type Invitation struct { // the member account. InvitationId *string + // The timestamp when the invitation was sent. + InvitedAt *string + // The status of the relationship between the inviter and invitee accounts. RelationshipStatus *string } @@ -537,33 +537,38 @@ type Master struct { // The ID of the account used as the master account. AccountId *string + // The value used to validate the master account to the member account. + InvitationId *string + // The timestamp when the invitation was sent. InvitedAt *string // The status of the relationship between the master and member accounts. RelationshipStatus *string - - // The value used to validate the master account to the member account. - InvitationId *string } // Contains information about the member account. type Member struct { - // The status of the relationship between the member and the master. + // The ID of the member account. // // This member is required. - RelationshipStatus *string + AccountId *string + + // The email address of the member account. + // + // This member is required. + Email *string // The master account ID. // // This member is required. MasterId *string - // The ID of the member account. + // The status of the relationship between the member and the master. // // This member is required. - AccountId *string + RelationshipStatus *string // The last-updated timestamp of the member. // @@ -575,25 +580,20 @@ type Member struct { // The timestamp when the invitation was sent. InvitedAt *string - - // The email address of the member account. - // - // This member is required. - Email *string } // Contains information on which data sources are enabled for a member account. type MemberDataSourceConfiguration struct { - // Contains information on the status of data sources for the account. + // The account ID for the member account. // // This member is required. - DataSources *DataSourceConfigurationsResult + AccountId *string - // The account ID for the member account. + // Contains information on the status of data sources for the account. // // This member is required. - AccountId *string + DataSources *DataSourceConfigurationsResult } // Contains information about the NETWORK_CONNECTION action described in the @@ -603,74 +603,74 @@ type NetworkConnectionAction struct { // Indicates whether EC2 blocked the network connection to your instance. Blocked *bool - // The local IP information of the connection. - LocalIpDetails *LocalIpDetails - - // The network connection protocol. - Protocol *string - // The network connection direction. ConnectionDirection *string + // The local IP information of the connection. + LocalIpDetails *LocalIpDetails + // The local port information of the connection. LocalPortDetails *LocalPortDetails - // The remote port information of the connection. - RemotePortDetails *RemotePortDetails + // The network connection protocol. + Protocol *string // The remote IP information of the connection. RemoteIpDetails *RemoteIpDetails + + // The remote port information of the connection. + RemotePortDetails *RemotePortDetails } // Contains information about the elastic network interface of the EC2 instance. type NetworkInterface struct { - // The subnet ID of the EC2 instance. - SubnetId *string - - // The public DNS name of the EC2 instance. - PublicDnsName *string - - // The VPC ID of the EC2 instance. - VpcId *string - - // The private IP address of the EC2 instance. - PrivateIpAddress *string + // A list of IPv6 addresses for the EC2 instance. + Ipv6Addresses []*string // The ID of the network interface. NetworkInterfaceId *string - // A list of IPv6 addresses for the EC2 instance. - Ipv6Addresses []*string - // The private DNS name of the EC2 instance. PrivateDnsName *string - // The public IP address of the EC2 instance. - PublicIp *string + // The private IP address of the EC2 instance. + PrivateIpAddress *string // Other private IP address information of the EC2 instance. PrivateIpAddresses []*PrivateIpAddressDetails + // The public DNS name of the EC2 instance. + PublicDnsName *string + + // The public IP address of the EC2 instance. + PublicIp *string + // The security groups associated with the EC2 instance. SecurityGroups []*SecurityGroup + + // The subnet ID of the EC2 instance. + SubnetId *string + + // The VPC ID of the EC2 instance. + VpcId *string } // Contains information about the ISP organization of the remote IP address. type Organization struct { - // The name of the internet provider. - Org *string - - // The ISP information for the internet provider. - Isp *string + // The Autonomous System Number (ASN) of the internet provider of the remote IP + // address. + Asn *string // The organization that registered this ASN. AsnOrg *string - // The Autonomous System Number (ASN) of the internet provider of the remote IP - // address. - Asn *string + // The ISP information for the internet provider. + Isp *string + + // The name of the internet provider. + Org *string } // An object that contains information on which data sources will be configured to @@ -736,23 +736,23 @@ type PermissionConfiguration struct { // Contains information about the PORT_PROBE action described in the finding. type PortProbeAction struct { - // A list of objects related to port probe details. - PortProbeDetails []*PortProbeDetail - // Indicates whether EC2 blocked the port probe to the instance, such as with an // ACL. Blocked *bool + + // A list of objects related to port probe details. + PortProbeDetails []*PortProbeDetail } // Contains information about the port probe details. type PortProbeDetail struct { - // The local port information of the connection. - LocalPortDetails *LocalPortDetails - // The local IP information of the connection. LocalIpDetails *LocalIpDetails + // The local port information of the connection. + LocalPortDetails *LocalPortDetails + // The remote IP information of the connection. RemoteIpDetails *RemoteIpDetails } @@ -780,17 +780,23 @@ type ProductCode struct { // Describes the public access policies that apply to the S3 bucket. type PublicAccess struct { - // Contains information about how permissions are configured for the S3 bucket. - PermissionConfiguration *PermissionConfiguration - // Describes the effective permission on this bucket after factoring all attached // policies. EffectivePermission *string + + // Contains information about how permissions are configured for the S3 bucket. + PermissionConfiguration *PermissionConfiguration } // Contains information about the remote IP address of the connection. type RemoteIpDetails struct { + // The city information of the remote IP address. + City *City + + // The country code of the remote IP address. + Country *Country + // The location information of the remote IP address. GeoLocation *GeoLocation @@ -799,34 +805,22 @@ type RemoteIpDetails struct { // The ISP organization information of the remote IP address. Organization *Organization - - // The country code of the remote IP address. - Country *Country - - // The city information of the remote IP address. - City *City } // Contains information about the remote port. type RemotePortDetails struct { - // The port name of the remote connection. - PortName *string - // The port number of the remote connection. Port *int32 + + // The port name of the remote connection. + PortName *string } // Contains information about the AWS resource associated with the activity that // prompted GuardDuty to generate a finding. type Resource struct { - // The type of AWS resource. - ResourceType *string - - // Contains information on the S3 bucket. - S3BucketDetails []*S3BucketDetail - // The IAM access key details (IAM user information) of a user that engaged in the // activity that prompted GuardDuty to generate a finding. AccessKeyDetails *AccessKeyDetails @@ -834,6 +828,12 @@ type Resource struct { // The information about the EC2 instance associated with the activity that // prompted GuardDuty to generate a finding. InstanceDetails *InstanceDetails + + // The type of AWS resource. + ResourceType *string + + // Contains information on the S3 bucket. + S3BucketDetails []*S3BucketDetail } // Contains information on the S3 bucket. @@ -845,23 +845,23 @@ type S3BucketDetail struct { // The date and time the bucket was created at. CreatedAt *time.Time - // Describes the public access policies that apply to the S3 bucket. - PublicAccess *PublicAccess - - // The owner of the S3 bucket. - Owner *Owner - // Describes the server side encryption method used in the S3 bucket. DefaultServerSideEncryption *DefaultServerSideEncryption // The name of the S3 bucket. Name *string - // Describes whether the bucket is a source or destination bucket. - Type *string + // The owner of the S3 bucket. + Owner *Owner + + // Describes the public access policies that apply to the S3 bucket. + PublicAccess *PublicAccess // All tags attached to the S3 bucket Tags []*Tag + + // Describes whether the bucket is a source or destination bucket. + Type *string } // Describes whether S3 data event logs will be enabled as a data source. @@ -886,47 +886,47 @@ type S3LogsConfigurationResult struct { // Contains information about the security groups associated with the EC2 instance. type SecurityGroup struct { - // The security group name of the EC2 instance. - GroupName *string - // The security group ID of the EC2 instance. GroupId *string + + // The security group name of the EC2 instance. + GroupName *string } // Contains additional information about the generated finding. type Service struct { - // The detector ID for the GuardDuty service. - DetectorId *string + // Information about the activity that is described in a finding. + Action *Action - // The name of the AWS service (GuardDuty) that generated a finding. - ServiceName *string + // Indicates whether this finding is archived. + Archived *bool // The total count of the occurrences of this finding type. Count *int32 - // An evidence object associated with the service. - Evidence *Evidence + // The detector ID for the GuardDuty service. + DetectorId *string + + // The first-seen timestamp of the activity that prompted GuardDuty to generate + // this finding. + EventFirstSeen *string // The last-seen timestamp of the activity that prompted GuardDuty to generate this // finding. EventLastSeen *string + // An evidence object associated with the service. + Evidence *Evidence + // The resource role information for this finding. ResourceRole *string + // The name of the AWS service (GuardDuty) that generated a finding. + ServiceName *string + // Feedback that was submitted about the finding. UserFeedback *string - - // Information about the activity that is described in a finding. - Action *Action - - // Indicates whether this finding is archived. - Archived *bool - - // The first-seen timestamp of the activity that prompted GuardDuty to generate - // this finding. - EventFirstSeen *string } // Contains information about the criteria used for sorting findings. @@ -942,47 +942,47 @@ type SortCriteria struct { // Contains information about a tag associated with the EC2 instance. type Tag struct { - // The EC2 instance tag value. - Value *string - // The EC2 instance tag key. Key *string + + // The EC2 instance tag value. + Value *string } // An instance of a threat intelligence detail that constitutes evidence for the // finding. type ThreatIntelligenceDetail struct { + // The name of the threat intelligence list that triggered the finding. + ThreatListName *string + // A list of names of the threats in the threat intelligence list that triggered // the finding. ThreatNames []*string - - // The name of the threat intelligence list that triggered the finding. - ThreatListName *string } // Contains the total usage with the corresponding currency unit for that value. type Total struct { - // The currency unit that the amount is given in. - Unit *string - // The total usage. Amount *string + + // The currency unit that the amount is given in. + Unit *string } // Contains information about the accounts that weren't processed. type UnprocessedAccount struct { - // A reason why the account hasn't been processed. + // The AWS account ID. // // This member is required. - Result *string + AccountId *string - // The AWS account ID. + // A reason why the account hasn't been processed. // // This member is required. - AccountId *string + Result *string } // Contains information on the total of usage based on account IDs. @@ -1014,30 +1014,29 @@ type UsageCriteria struct { // Contains information on the result of usage based on data source type. type UsageDataSourceResult struct { - // Represents the total of usage for the specified data source. - Total *Total - // The data source type that generated usage. DataSource DataSource + + // Represents the total of usage for the specified data source. + Total *Total } // Contains information on the sum of usage based on an AWS resource. type UsageResourceResult struct { - // Represents the sum total of usage for the specified resource type. - Total *Total - // The AWS resource that generated usage. Resource *string + + // Represents the sum total of usage for the specified resource type. + Total *Total } // Contains the result of GuardDuty usage. If a UsageStatisticType is provided the // result for other types will be null. type UsageStatistics struct { - // Lists the top 50 resources that have generated the most GuardDuty usage, in - // order from most to least expensive. - TopResources []*UsageResourceResult + // The usage statistic sum organized by account ID. + SumByAccount []*UsageAccountResult // The usage statistic sum organized by on data source. SumByDataSource []*UsageDataSourceResult @@ -1045,6 +1044,7 @@ type UsageStatistics struct { // The usage statistic sum organized by resource. SumByResource []*UsageResourceResult - // The usage statistic sum organized by account ID. - SumByAccount []*UsageAccountResult + // Lists the top 50 resources that have generated the most GuardDuty usage, in + // order from most to least expensive. + TopResources []*UsageResourceResult } diff --git a/service/health/api_op_DescribeAffectedAccountsForOrganization.go b/service/health/api_op_DescribeAffectedAccountsForOrganization.go index 7d4873d6789..521e1f689a3 100644 --- a/service/health/api_op_DescribeAffectedAccountsForOrganization.go +++ b/service/health/api_op_DescribeAffectedAccountsForOrganization.go @@ -83,6 +83,11 @@ type DescribeAffectedAccountsForOrganizationInput struct { type DescribeAffectedAccountsForOrganizationOutput struct { + // A JSON set of elements of the affected accounts. + AffectedAccounts []*string + + EventScopeCode types.EventScopeCode + // If the results of a search are large, only a portion of the results are // returned, and a nextToken pagination token is returned in the response. To // retrieve the next batch of results, reissue the search request and include the @@ -90,11 +95,6 @@ type DescribeAffectedAccountsForOrganizationOutput struct { // contain a pagination token value. NextToken *string - EventScopeCode types.EventScopeCode - - // A JSON set of elements of the affected accounts. - AffectedAccounts []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/health/api_op_DescribeAffectedEntities.go b/service/health/api_op_DescribeAffectedEntities.go index 319f3207e2d..106e725a764 100644 --- a/service/health/api_op_DescribeAffectedEntities.go +++ b/service/health/api_op_DescribeAffectedEntities.go @@ -63,6 +63,11 @@ func (c *Client) DescribeAffectedEntities(ctx context.Context, params *DescribeA type DescribeAffectedEntitiesInput struct { + // Values to narrow the results returned. At least one event ARN is required. + // + // This member is required. + Filter *types.EntityFilter + // The locale (language) to return information in. English (en) is the default and // the only supported value at this time. Locale *string @@ -77,15 +82,13 @@ type DescribeAffectedEntitiesInput struct { // returned token. When all results have been returned, the response does not // contain a pagination token value. NextToken *string - - // Values to narrow the results returned. At least one event ARN is required. - // - // This member is required. - Filter *types.EntityFilter } type DescribeAffectedEntitiesOutput struct { + // The entities that match the filter criteria. + Entities []*types.AffectedEntity + // If the results of a search are large, only a portion of the results are // returned, and a nextToken pagination token is returned in the response. To // retrieve the next batch of results, reissue the search request and include the @@ -93,9 +96,6 @@ type DescribeAffectedEntitiesOutput struct { // contain a pagination token value. NextToken *string - // The entities that match the filter criteria. - Entities []*types.AffectedEntity - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/health/api_op_DescribeAffectedEntitiesForOrganization.go b/service/health/api_op_DescribeAffectedEntitiesForOrganization.go index d3f712ad0c1..4e1c22b4c4d 100644 --- a/service/health/api_op_DescribeAffectedEntitiesForOrganization.go +++ b/service/health/api_op_DescribeAffectedEntitiesForOrganization.go @@ -65,28 +65,18 @@ func (c *Client) DescribeAffectedEntitiesForOrganization(ctx context.Context, pa type DescribeAffectedEntitiesForOrganizationInput struct { - // The locale (language) to return information in. English (en) is the default and - // the only supported value at this time. - Locale *string - // A JSON set of elements including the awsAccountId and the eventArn. // // This member is required. OrganizationEntityFilters []*types.EventAccountFilter - // If the results of a search are large, only a portion of the results are - // returned, and a nextToken pagination token is returned in the response. To - // retrieve the next batch of results, reissue the search request and include the - // returned token. When all results have been returned, the response does not - // contain a pagination token value. - NextToken *string + // The locale (language) to return information in. English (en) is the default and + // the only supported value at this time. + Locale *string // The maximum number of items to return in one batch, between 10 and 100, // inclusive. MaxResults *int32 -} - -type DescribeAffectedEntitiesForOrganizationOutput struct { // If the results of a search are large, only a portion of the results are // returned, and a nextToken pagination token is returned in the response. To @@ -94,6 +84,9 @@ type DescribeAffectedEntitiesForOrganizationOutput struct { // returned token. When all results have been returned, the response does not // contain a pagination token value. NextToken *string +} + +type DescribeAffectedEntitiesForOrganizationOutput struct { // A JSON set of elements including the awsAccountId and its entityArn, entityValue // and its entityArn, lastUpdatedTime, statusCode, and tags. @@ -103,6 +96,13 @@ type DescribeAffectedEntitiesForOrganizationOutput struct { // errorMessage, errorName, and eventArn. FailedSet []*types.OrganizationAffectedEntitiesErrorItem + // If the results of a search are large, only a portion of the results are + // returned, and a nextToken pagination token is returned in the response. To + // retrieve the next batch of results, reissue the search request and include the + // returned token. When all results have been returned, the response does not + // contain a pagination token value. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/health/api_op_DescribeEventAggregates.go b/service/health/api_op_DescribeEventAggregates.go index 1ed8598aa27..1efd584bfce 100644 --- a/service/health/api_op_DescribeEventAggregates.go +++ b/service/health/api_op_DescribeEventAggregates.go @@ -59,28 +59,31 @@ func (c *Client) DescribeEventAggregates(ctx context.Context, params *DescribeEv type DescribeEventAggregatesInput struct { - // If the results of a search are large, only a portion of the results are - // returned, and a nextToken pagination token is returned in the response. To - // retrieve the next batch of results, reissue the search request and include the - // returned token. When all results have been returned, the response does not - // contain a pagination token value. - NextToken *string - // The only currently supported value is eventTypeCategory. // // This member is required. AggregateField types.EventAggregateField + // Values to narrow the results returned. + Filter *types.EventFilter + // The maximum number of items to return in one batch, between 10 and 100, // inclusive. MaxResults *int32 - // Values to narrow the results returned. - Filter *types.EventFilter + // If the results of a search are large, only a portion of the results are + // returned, and a nextToken pagination token is returned in the response. To + // retrieve the next batch of results, reissue the search request and include the + // returned token. When all results have been returned, the response does not + // contain a pagination token value. + NextToken *string } type DescribeEventAggregatesOutput struct { + // The number of events in each category that meet the optional filter criteria. + EventAggregates []*types.EventAggregate + // If the results of a search are large, only a portion of the results are // returned, and a nextToken pagination token is returned in the response. To // retrieve the next batch of results, reissue the search request and include the @@ -88,9 +91,6 @@ type DescribeEventAggregatesOutput struct { // contain a pagination token value. NextToken *string - // The number of events in each category that meet the optional filter criteria. - EventAggregates []*types.EventAggregate - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/health/api_op_DescribeEventDetailsForOrganization.go b/service/health/api_op_DescribeEventDetailsForOrganization.go index d40879aa235..a809146edde 100644 --- a/service/health/api_op_DescribeEventDetailsForOrganization.go +++ b/service/health/api_op_DescribeEventDetailsForOrganization.go @@ -65,14 +65,14 @@ func (c *Client) DescribeEventDetailsForOrganization(ctx context.Context, params type DescribeEventDetailsForOrganizationInput struct { - // The locale (language) to return information in. English (en) is the default and - // the only supported value at this time. - Locale *string - // A set of JSON elements that includes the awsAccountId and the eventArn. // // This member is required. OrganizationEventDetailFilters []*types.EventAccountFilter + + // The locale (language) to return information in. English (en) is the default and + // the only supported value at this time. + Locale *string } type DescribeEventDetailsForOrganizationOutput struct { diff --git a/service/health/api_op_DescribeEventTypes.go b/service/health/api_op_DescribeEventTypes.go index 0478c45ec02..fc39f65b4a5 100644 --- a/service/health/api_op_DescribeEventTypes.go +++ b/service/health/api_op_DescribeEventTypes.go @@ -64,19 +64,9 @@ type DescribeEventTypesInput struct { // the only supported value at this time. Locale *string - // If the results of a search are large, only a portion of the results are - // returned, and a nextToken pagination token is returned in the response. To - // retrieve the next batch of results, reissue the search request and include the - // returned token. When all results have been returned, the response does not - // contain a pagination token value. - NextToken *string - // The maximum number of items to return in one batch, between 10 and 100, // inclusive. MaxResults *int32 -} - -type DescribeEventTypesOutput struct { // If the results of a search are large, only a portion of the results are // returned, and a nextToken pagination token is returned in the response. To @@ -84,6 +74,9 @@ type DescribeEventTypesOutput struct { // returned token. When all results have been returned, the response does not // contain a pagination token value. NextToken *string +} + +type DescribeEventTypesOutput struct { // A list of event types that match the filter criteria. Event types have a // category (issue, accountNotification, or scheduledChange), a service (for @@ -91,6 +84,13 @@ type DescribeEventTypesOutput struct { // AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT). EventTypes []*types.EventType + // If the results of a search are large, only a portion of the results are + // returned, and a nextToken pagination token is returned in the response. To + // retrieve the next batch of results, reissue the search request and include the + // returned token. When all results have been returned, the response does not + // contain a pagination token value. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/health/api_op_DescribeEvents.go b/service/health/api_op_DescribeEvents.go index 240c91e556f..f7195491458 100644 --- a/service/health/api_op_DescribeEvents.go +++ b/service/health/api_op_DescribeEvents.go @@ -62,27 +62,30 @@ func (c *Client) DescribeEvents(ctx context.Context, params *DescribeEventsInput type DescribeEventsInput struct { + // Values to narrow the results returned. + Filter *types.EventFilter + + // The locale (language) to return information in. English (en) is the default and + // the only supported value at this time. + Locale *string + + // The maximum number of items to return in one batch, between 10 and 100, + // inclusive. + MaxResults *int32 + // If the results of a search are large, only a portion of the results are // returned, and a nextToken pagination token is returned in the response. To // retrieve the next batch of results, reissue the search request and include the // returned token. When all results have been returned, the response does not // contain a pagination token value. NextToken *string - - // The maximum number of items to return in one batch, between 10 and 100, - // inclusive. - MaxResults *int32 - - // The locale (language) to return information in. English (en) is the default and - // the only supported value at this time. - Locale *string - - // Values to narrow the results returned. - Filter *types.EventFilter } type DescribeEventsOutput struct { + // The events that match the specified filter criteria. + Events []*types.Event + // If the results of a search are large, only a portion of the results are // returned, and a nextToken pagination token is returned in the response. To // retrieve the next batch of results, reissue the search request and include the @@ -90,9 +93,6 @@ type DescribeEventsOutput struct { // contain a pagination token value. NextToken *string - // The events that match the specified filter criteria. - Events []*types.Event - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/health/api_op_DescribeEventsForOrganization.go b/service/health/api_op_DescribeEventsForOrganization.go index a0025f521c7..2ed9134fdb3 100644 --- a/service/health/api_op_DescribeEventsForOrganization.go +++ b/service/health/api_op_DescribeEventsForOrganization.go @@ -67,26 +67,16 @@ func (c *Client) DescribeEventsForOrganization(ctx context.Context, params *Desc type DescribeEventsForOrganizationInput struct { - // If the results of a search are large, only a portion of the results are - // returned, and a nextToken pagination token is returned in the response. To - // retrieve the next batch of results, reissue the search request and include the - // returned token. When all results have been returned, the response does not - // contain a pagination token value. - NextToken *string + // Values to narrow the results returned. + Filter *types.OrganizationEventFilter // The locale (language) to return information in. English (en) is the default and // the only supported value at this time. Locale *string - // Values to narrow the results returned. - Filter *types.OrganizationEventFilter - // The maximum number of items to return in one batch, between 10 and 100, // inclusive. MaxResults *int32 -} - -type DescribeEventsForOrganizationOutput struct { // If the results of a search are large, only a portion of the results are // returned, and a nextToken pagination token is returned in the response. To @@ -94,10 +84,20 @@ type DescribeEventsForOrganizationOutput struct { // returned token. When all results have been returned, the response does not // contain a pagination token value. NextToken *string +} + +type DescribeEventsForOrganizationOutput struct { // The events that match the specified filter criteria. Events []*types.OrganizationEvent + // If the results of a search are large, only a portion of the results are + // returned, and a nextToken pagination token is returned in the response. To + // retrieve the next batch of results, reissue the search request and include the + // returned token. When all results have been returned, the response does not + // contain a pagination token value. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/health/go.mod b/service/health/go.mod index 89a005eb5ef..b9e928fe37e 100644 --- a/service/health/go.mod +++ b/service/health/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/health go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/health/types/types.go b/service/health/types/types.go index f866c8df521..a3e9cae63f0 100644 --- a/service/health/types/types.go +++ b/service/health/types/types.go @@ -12,32 +12,32 @@ type AffectedEntity struct { // The 12-digit AWS account number that contains the affected entity. AwsAccountId *string - // A map of entity tags attached to the affected entity. - Tags map[string]*string - - // The URL of the affected entity. - EntityUrl *string - // The unique identifier for the entity. Format: // arn:aws:health:entity-region:aws-account:entity/entity-id . Example: // arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K EntityArn *string + // The URL of the affected entity. + EntityUrl *string + + // The ID of the affected entity. + EntityValue *string + // The unique identifier for the event. Format: // arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . // Example: Example: // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 EventArn *string + // The most recent time that the entity was updated. + LastUpdatedTime *time.Time + // The most recent status of the entity affected by the event. The possible values // are IMPAIRED, UNIMPAIRED, and UNKNOWN. StatusCode EntityStatusCode - // The most recent time that the entity was updated. - LastUpdatedTime *time.Time - - // The ID of the affected entity. - EntityValue *string + // A map of entity tags attached to the affected entity. + Tags map[string]*string } // A range of dates and times that is used by the EventFilter () and EntityFilter @@ -48,11 +48,11 @@ type AffectedEntity struct { // value is equal to or before to. type DateTimeRange struct { - // The ending date and time of a time range. - To *time.Time - // The starting date and time of a time range. From *time.Time + + // The ending date and time of a time range. + To *time.Time } // The number of entities that are affected by one or more events. Returned by the @@ -73,69 +73,69 @@ type EntityAggregate struct { // operation. type EntityFilter struct { - // A map of entity tags attached to the affected entity. - Tags []map[string]*string - - // A list of entity status codes (IMPAIRED, UNIMPAIRED, or UNKNOWN). - StatusCodes []EntityStatusCode + // A list of event ARNs (unique identifiers). For example: + // "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", + // "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101" + // + // This member is required. + EventArns []*string // A list of entity ARNs (unique identifiers). EntityArns []*string + // A list of IDs for affected entities. + EntityValues []*string + // A list of the most recent dates and times that the entity was updated. LastUpdatedTimes []*DateTimeRange - // A list of IDs for affected entities. - EntityValues []*string + // A list of entity status codes (IMPAIRED, UNIMPAIRED, or UNKNOWN). + StatusCodes []EntityStatusCode - // A list of event ARNs (unique identifiers). For example: - // "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", - // "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101" - // - // This member is required. - EventArns []*string + // A map of entity tags attached to the affected entity. + Tags []map[string]*string } // Summary information about an AWS Health event. type Event struct { + // The unique identifier for the event. Format: + // arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . + // Example: Example: + // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 + Arn *string + + // The AWS Availability Zone of the event. For example, us-east-1a. + AvailabilityZone *string + // The date and time that the event ended. EndTime *time.Time - // The AWS service that is affected by the event. For example, EC2, RDS. - Service *string + EventScopeCode EventScopeCode // The category of the event. Possible values are issue, scheduledChange, and // accountNotification. EventTypeCategory EventTypeCategory + // The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION + // ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT. + EventTypeCode *string + // The most recent date and time that the event was updated. LastUpdatedTime *time.Time // The AWS region name of the event. Region *string - // The AWS Availability Zone of the event. For example, us-east-1a. - AvailabilityZone *string + // The AWS service that is affected by the event. For example, EC2, RDS. + Service *string - // The unique identifier for the event. Format: - // arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . - // Example: Example: - // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 - Arn *string + // The date and time that the event began. + StartTime *time.Time // The most recent status of the event. Possible values are open, closed, and // upcoming. StatusCode EventStatusCode - - // The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION - // ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT. - EventTypeCode *string - - // The date and time that the event began. - StartTime *time.Time - - EventScopeCode EventScopeCode } // The values used to filter results from the DescribeEventDetailsForOrganization @@ -178,12 +178,12 @@ type EventDescription struct { // the DescribeEventDetails () operation. type EventDetails struct { - // The most recent description of the event. - EventDescription *EventDescription - // Summary information about the event. Event *Event + // The most recent description of the event. + EventDescription *EventDescription + // Additional metadata about the event. EventMetadata map[string]*string } @@ -195,63 +195,63 @@ type EventDetailsErrorItem struct { // A message that describes the error. ErrorMessage *string + // The name of the error. + ErrorName *string + // The unique identifier for the event. Format: // arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . // Example: Example: // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 EventArn *string - - // The name of the error. - ErrorName *string } // The values to use to filter results from the DescribeEvents () and // DescribeEventAggregates () operations. type EventFilter struct { - // A list of unique identifiers for event types. For example, - // "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED". - EventTypeCodes []*string + // A list of AWS availability zones. + AvailabilityZones []*string // A list of dates and times that the event ended. EndTimes []*DateTimeRange + // A list of entity ARNs (unique identifiers). + EntityArns []*string + // A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS // volumes (vol-426ab23e). EntityValues []*string - // A list of dates and times that the event began. - StartTimes []*DateTimeRange - - // The AWS services associated with the event. For example, EC2, RDS. - Services []*string + // A list of event ARNs (unique identifiers). For example: + // "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", + // "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101" + EventArns []*string // A list of event status codes. EventStatusCodes []EventStatusCode - // A list of AWS regions. - Regions []*string - - // A map of entity tags attached to the affected entity. - Tags []map[string]*string + // A list of event type category codes (issue, scheduledChange, or + // accountNotification). + EventTypeCategories []EventTypeCategory - // A list of AWS availability zones. - AvailabilityZones []*string + // A list of unique identifiers for event types. For example, + // "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED". + EventTypeCodes []*string // A list of dates and times that the event was last updated. LastUpdatedTimes []*DateTimeRange - // A list of event ARNs (unique identifiers). For example: - // "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", - // "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101" - EventArns []*string + // A list of AWS regions. + Regions []*string - // A list of entity ARNs (unique identifiers). - EntityArns []*string + // The AWS services associated with the event. For example, EC2, RDS. + Services []*string - // A list of event type category codes (issue, scheduledChange, or - // accountNotification). - EventTypeCategories []EventTypeCategory + // A list of dates and times that the event began. + StartTimes []*DateTimeRange + + // A map of entity tags attached to the affected entity. + Tags []map[string]*string } // Metadata about a type of event that is reported by AWS Health. Data consists of @@ -259,14 +259,14 @@ type EventFilter struct { // type code (for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT). type EventType struct { - // The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION - // ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT. - Code *string - // A list of event type category codes (issue, scheduledChange, or // accountNotification). Category EventTypeCategory + // The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION + // ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT. + Code *string + // The AWS service that is affected by the event. For example, EC2, RDS. Service *string } @@ -289,60 +289,60 @@ type EventTypeFilter struct { // operation cannot find or process a specific entity. type OrganizationAffectedEntitiesErrorItem struct { + // The 12-digit AWS account numbers that contains the affected entities. + AwsAccountId *string + // The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION. // For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT. ErrorMessage *string + // The name of the error. + ErrorName *string + // The unique identifier for the event. Format: // arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . // Example: Example: // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 EventArn *string - - // The name of the error. - ErrorName *string - - // The 12-digit AWS account numbers that contains the affected entities. - AwsAccountId *string } // Summary information about an event, returned by the // DescribeEventsForOrganization () operation. type OrganizationEvent struct { - // The category of the event type. - EventTypeCategory EventTypeCategory + // The unique identifier for the event. Format: + // arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . + // Example: Example: + // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 + Arn *string - // The AWS service that is affected by the event. For example, EC2, RDS. - Service *string + // The date and time that the event ended. + EndTime *time.Time EventScopeCode EventScopeCode - // The date and time that the event began. - StartTime *time.Time + // The category of the event type. + EventTypeCategory EventTypeCategory // The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION. // For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT. EventTypeCode *string - // The unique identifier for the event. Format: - // arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . - // Example: Example: - // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 - Arn *string + // The most recent date and time that the event was updated. + LastUpdatedTime *time.Time // The AWS Region name of the event. Region *string + // The AWS service that is affected by the event. For example, EC2, RDS. + Service *string + + // The date and time that the event began. + StartTime *time.Time + // The most recent status of the event. Possible values are open, closed, and // upcoming. StatusCode EventStatusCode - - // The most recent date and time that the event was updated. - LastUpdatedTime *time.Time - - // The date and time that the event ended. - EndTime *time.Time } // Detailed information about an event. A combination of an Event () object, an @@ -353,42 +353,45 @@ type OrganizationEventDetails struct { // The 12-digit AWS account numbers that contains the affected entities. AwsAccountId *string - // Additional metadata about the event. - EventMetadata map[string]*string - // Summary information about an AWS Health event. Event *Event // The detailed description of the event. Included in the information returned by // the DescribeEventDetails () operation. EventDescription *EventDescription + + // Additional metadata about the event. + EventMetadata map[string]*string } // Error information returned when a DescribeEventDetailsForOrganization () // operation cannot find a specified event. type OrganizationEventDetailsErrorItem struct { + // Error information returned when a DescribeEventDetailsForOrganization () + // operation cannot find a specified event. + AwsAccountId *string + // A message that describes the error. ErrorMessage *string + // The name of the error. + ErrorName *string + // The unique identifier for the event. Format: // arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . // Example: Example: // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 EventArn *string - - // Error information returned when a DescribeEventDetailsForOrganization () - // operation cannot find a specified event. - AwsAccountId *string - - // The name of the error. - ErrorName *string } // The values to filter results from the DescribeEventsForOrganization () // operation. type OrganizationEventFilter struct { + // A list of 12-digit AWS account numbers that contains the affected entities. + AwsAccountIds []*string + // A range of dates and times that is used by the EventFilter () and EntityFilter // () objects. If from is set and to is set: match items where the timestamp // (startTime, endTime, or lastUpdatedTime) is between from and to inclusive. If @@ -397,14 +400,18 @@ type OrganizationEventFilter struct { // value is equal to or before to. EndTime *DateTimeRange - // A list of 12-digit AWS account numbers that contains the affected entities. - AwsAccountIds []*string + // REPLACEME + EntityArns []*string + + // A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS + // volumes (vol-426ab23e). + EntityValues []*string // A list of event status codes. EventStatusCodes []EventStatusCode - // The AWS services associated with the event. For example, EC2, RDS. - Services []*string + // REPLACEME + EventTypeCategories []EventTypeCategory // A list of unique identifiers for event types. For example, // "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED". @@ -416,20 +423,13 @@ type OrganizationEventFilter struct { // from is set and to is not set: match items where the timestamp value is equal to // or after from. If from is not set and to is set: match items where the timestamp // value is equal to or before to. - StartTime *DateTimeRange - - // A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS - // volumes (vol-426ab23e). - EntityValues []*string - - // REPLACEME - EventTypeCategories []EventTypeCategory + LastUpdatedTime *DateTimeRange // A list of AWS Regions. Regions []*string - // REPLACEME - EntityArns []*string + // The AWS services associated with the event. For example, EC2, RDS. + Services []*string // A range of dates and times that is used by the EventFilter () and EntityFilter // () objects. If from is set and to is set: match items where the timestamp @@ -437,5 +437,5 @@ type OrganizationEventFilter struct { // from is set and to is not set: match items where the timestamp value is equal to // or after from. If from is not set and to is set: match items where the timestamp // value is equal to or before to. - LastUpdatedTime *DateTimeRange + StartTime *DateTimeRange } diff --git a/service/honeycode/api_op_GetScreenData.go b/service/honeycode/api_op_GetScreenData.go index bb426a27e2a..7749d766308 100644 --- a/service/honeycode/api_op_GetScreenData.go +++ b/service/honeycode/api_op_GetScreenData.go @@ -59,29 +59,11 @@ func (c *Client) GetScreenData(ctx context.Context, params *GetScreenDataInput, type GetScreenDataInput struct { - // Variables are optional and are needed only if the screen requires them to render - // correctly. Variables are specified as a map where the key is the name of the - // variable as defined on the screen. The value is an object which currently has - // only one property, rawValue, which holds the value of the variable to be passed - // to the screen. - Variables map[string]*types.VariableValue - - // This parameter is optional. If a nextToken is not specified, the API returns the - // first page of data. Pagination tokens expire after 1 hour. If you use a token - // that was returned more than an hour back, the API will throw - // ValidationException. - NextToken *string - // The ID of the app that contains the screem. // // This member is required. AppId *string - // The number of results to be returned on a single page. Specify a number between - // 1 and 100. The maximum value is 100. This parameter is optional. If you don't - // specify this parameter, the default page size is 100. - MaxResults *int32 - // The ID of the screen. // // This member is required. @@ -91,14 +73,32 @@ type GetScreenDataInput struct { // // This member is required. WorkbookId *string + + // The number of results to be returned on a single page. Specify a number between + // 1 and 100. The maximum value is 100. This parameter is optional. If you don't + // specify this parameter, the default page size is 100. + MaxResults *int32 + + // This parameter is optional. If a nextToken is not specified, the API returns the + // first page of data. Pagination tokens expire after 1 hour. If you use a token + // that was returned more than an hour back, the API will throw + // ValidationException. + NextToken *string + + // Variables are optional and are needed only if the screen requires them to render + // correctly. Variables are specified as a map where the key is the name of the + // variable as defined on the screen. The value is an object which currently has + // only one property, rawValue, which holds the value of the variable to be passed + // to the screen. + Variables map[string]*types.VariableValue } type GetScreenDataOutput struct { - // Provides the pagination token to load the next page if there are more results - // matching the request. If a pagination token is not present in the response, it - // means that all data matching the query has been loaded. - NextToken *string + // A map of all the rows on the screen keyed by block name. + // + // This member is required. + Results map[string]*types.ResultSet // Indicates the cursor of the workbook at which the data returned by this workbook // is read. Workbook cursor keeps increasing with every update and the increments @@ -107,10 +107,10 @@ type GetScreenDataOutput struct { // This member is required. WorkbookCursor *int64 - // A map of all the rows on the screen keyed by block name. - // - // This member is required. - Results map[string]*types.ResultSet + // Provides the pagination token to load the next page if there are more results + // matching the request. If a pagination token is not present in the response, it + // means that all data matching the query has been loaded. + NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/honeycode/api_op_InvokeScreenAutomation.go b/service/honeycode/api_op_InvokeScreenAutomation.go index 2ff045a032c..d13314bff63 100644 --- a/service/honeycode/api_op_InvokeScreenAutomation.go +++ b/service/honeycode/api_op_InvokeScreenAutomation.go @@ -60,15 +60,25 @@ func (c *Client) InvokeScreenAutomation(ctx context.Context, params *InvokeScree type InvokeScreenAutomationInput struct { + // The ID of the app that contains the screen automation. + // + // This member is required. + AppId *string + // The ID of the automation action to be performed. // // This member is required. ScreenAutomationId *string - // The ID of the app that contains the screen automation. + // The ID of the screen that contains the screen automation. // // This member is required. - AppId *string + ScreenId *string + + // The ID of the workbook that contains the screen automation. + // + // This member is required. + WorkbookId *string // The request token for performing the automation action. Request tokens help to // identify duplicate requests. If a call times out or fails due to a transient @@ -80,10 +90,9 @@ type InvokeScreenAutomationInput struct { // requests spanning hours or days. ClientRequestToken *string - // The ID of the workbook that contains the screen automation. - // - // This member is required. - WorkbookId *string + // The row ID for the automation if the automation is defined inside a block with + // source or list. + RowId *string // Variables are optional and are needed only if the screen requires them to render // correctly. Variables are specified as a map where the key is the name of the @@ -91,15 +100,6 @@ type InvokeScreenAutomationInput struct { // only one property, rawValue, which holds the value of the variable to be passed // to the screen. Variables map[string]*types.VariableValue - - // The row ID for the automation if the automation is defined inside a block with - // source or list. - RowId *string - - // The ID of the screen that contains the screen automation. - // - // This member is required. - ScreenId *string } type InvokeScreenAutomationOutput struct { diff --git a/service/honeycode/go.mod b/service/honeycode/go.mod index 31a22d7a741..9a42481f560 100644 --- a/service/honeycode/go.mod +++ b/service/honeycode/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/honeycode go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/honeycode/types/types.go b/service/honeycode/types/types.go index 65e81813af7..f68b81fbe6f 100644 --- a/service/honeycode/types/types.go +++ b/service/honeycode/types/types.go @@ -5,15 +5,15 @@ package types // Metadata for column in the table. type ColumnMetadata struct { - // The name of the column. + // The format of the column. // // This member is required. - Name *string + Format Format - // The format of the column. + // The name of the column. // // This member is required. - Format Format + Name *string } // The data in a particular data cell defined on the screen. @@ -34,13 +34,13 @@ type DataItem struct { // A single row in the ResultSet. type ResultRow struct { - // The ID for a particular row. - RowId *string - // List of all the data cells in a row. // // This member is required. DataItems []*DataItem + + // The ID for a particular row. + RowId *string } // ResultSet contains the results of the request for a single block or list defined diff --git a/service/iam/api_op_AddRoleToInstanceProfile.go b/service/iam/api_op_AddRoleToInstanceProfile.go index 6ce78716445..5005da939df 100644 --- a/service/iam/api_op_AddRoleToInstanceProfile.go +++ b/service/iam/api_op_AddRoleToInstanceProfile.go @@ -73,14 +73,6 @@ func (c *Client) AddRoleToInstanceProfile(ctx context.Context, params *AddRoleTo type AddRoleToInstanceProfileInput struct { - // The name of the role to add. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- - // - // This member is required. - RoleName *string - // The name of the instance profile to update. This parameter allows (through its // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters // consisting of upper and lowercase alphanumeric characters with no spaces. You @@ -88,6 +80,14 @@ type AddRoleToInstanceProfileInput struct { // // This member is required. InstanceProfileName *string + + // The name of the role to add. This parameter allows (through its regex pattern + // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // This member is required. + RoleName *string } type AddRoleToInstanceProfileOutput struct { diff --git a/service/iam/api_op_AddUserToGroup.go b/service/iam/api_op_AddUserToGroup.go index 22696ebf473..a5b71174ad0 100644 --- a/service/iam/api_op_AddUserToGroup.go +++ b/service/iam/api_op_AddUserToGroup.go @@ -56,14 +56,6 @@ func (c *Client) AddUserToGroup(ctx context.Context, params *AddUserToGroupInput type AddUserToGroupInput struct { - // The name of the user to add. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- - // - // This member is required. - UserName *string - // The name of the group to update. This parameter allows (through its regex // pattern (http://wikipedia.org/wiki/regex)) a string of characters consisting of // upper and lowercase alphanumeric characters with no spaces. You can also include @@ -71,6 +63,14 @@ type AddUserToGroupInput struct { // // This member is required. GroupName *string + + // The name of the user to add. This parameter allows (through its regex pattern + // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // This member is required. + UserName *string } type AddUserToGroupOutput struct { diff --git a/service/iam/api_op_AttachGroupPolicy.go b/service/iam/api_op_AttachGroupPolicy.go index ba4f867e765..14836c6bff8 100644 --- a/service/iam/api_op_AttachGroupPolicy.go +++ b/service/iam/api_op_AttachGroupPolicy.go @@ -61,6 +61,14 @@ func (c *Client) AttachGroupPolicy(ctx context.Context, params *AttachGroupPolic type AttachGroupPolicyInput struct { + // The name (friendly name, not ARN) of the group to attach the policy to. This + // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a + // string of characters consisting of upper and lowercase alphanumeric characters + // with no spaces. You can also include any of the following characters: _+=,.@- + // + // This member is required. + GroupName *string + // The Amazon Resource Name (ARN) of the IAM policy you want to attach. For more // information about ARNs, see Amazon Resource Names (ARNs) and AWS Service // Namespaces @@ -69,14 +77,6 @@ type AttachGroupPolicyInput struct { // // This member is required. PolicyArn *string - - // The name (friendly name, not ARN) of the group to attach the policy to. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of upper and lowercase alphanumeric characters - // with no spaces. You can also include any of the following characters: _+=,.@- - // - // This member is required. - GroupName *string } type AttachGroupPolicyOutput struct { diff --git a/service/iam/api_op_AttachUserPolicy.go b/service/iam/api_op_AttachUserPolicy.go index c0afafebe61..1240a4fab4f 100644 --- a/service/iam/api_op_AttachUserPolicy.go +++ b/service/iam/api_op_AttachUserPolicy.go @@ -61,14 +61,6 @@ func (c *Client) AttachUserPolicy(ctx context.Context, params *AttachUserPolicyI type AttachUserPolicyInput struct { - // The name (friendly name, not ARN) of the IAM user to attach the policy to. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of upper and lowercase alphanumeric characters - // with no spaces. You can also include any of the following characters: _+=,.@- - // - // This member is required. - UserName *string - // The Amazon Resource Name (ARN) of the IAM policy you want to attach. For more // information about ARNs, see Amazon Resource Names (ARNs) and AWS Service // Namespaces @@ -77,6 +69,14 @@ type AttachUserPolicyInput struct { // // This member is required. PolicyArn *string + + // The name (friendly name, not ARN) of the IAM user to attach the policy to. This + // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a + // string of characters consisting of upper and lowercase alphanumeric characters + // with no spaces. You can also include any of the following characters: _+=,.@- + // + // This member is required. + UserName *string } type AttachUserPolicyOutput struct { diff --git a/service/iam/api_op_ChangePassword.go b/service/iam/api_op_ChangePassword.go index 4556f010a0a..9d7634ca4ee 100644 --- a/service/iam/api_op_ChangePassword.go +++ b/service/iam/api_op_ChangePassword.go @@ -61,11 +61,6 @@ func (c *Client) ChangePassword(ctx context.Context, params *ChangePasswordInput type ChangePasswordInput struct { - // The IAM user's current password. - // - // This member is required. - OldPassword *string - // The new password. The new password must conform to the AWS account's password // policy, if one exists. The regex pattern (http://wikipedia.org/wiki/regex) that // is used to validate this parameter is a string of characters. That string can @@ -78,6 +73,11 @@ type ChangePasswordInput struct { // // This member is required. NewPassword *string + + // The IAM user's current password. + // + // This member is required. + OldPassword *string } type ChangePasswordOutput struct { diff --git a/service/iam/api_op_CreateLoginProfile.go b/service/iam/api_op_CreateLoginProfile.go index d3d7618dbc5..af2692eda5e 100644 --- a/service/iam/api_op_CreateLoginProfile.go +++ b/service/iam/api_op_CreateLoginProfile.go @@ -61,15 +61,6 @@ func (c *Client) CreateLoginProfile(ctx context.Context, params *CreateLoginProf type CreateLoginProfileInput struct { - // The name of the IAM user to create a password for. The user must already exist. - // This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- - // - // This member is required. - UserName *string - // The new password for the user. The regex pattern // (http://wikipedia.org/wiki/regex) that is used to validate this parameter is a // string of characters. That string can include almost any printable ASCII @@ -83,6 +74,15 @@ type CreateLoginProfileInput struct { // This member is required. Password *string + // The name of the IAM user to create a password for. The user must already exist. + // This parameter allows (through its regex pattern + // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // This member is required. + UserName *string + // Specifies whether the user is required to set a new password on next sign-in. PasswordResetRequired *bool } diff --git a/service/iam/api_op_CreateOpenIDConnectProvider.go b/service/iam/api_op_CreateOpenIDConnectProvider.go index 99fdb969cc5..320d84b3131 100644 --- a/service/iam/api_op_CreateOpenIDConnectProvider.go +++ b/service/iam/api_op_CreateOpenIDConnectProvider.go @@ -76,17 +76,6 @@ func (c *Client) CreateOpenIDConnectProvider(ctx context.Context, params *Create type CreateOpenIDConnectProviderInput struct { - // The URL of the identity provider. The URL must begin with https:// and should - // correspond to the iss claim in the provider's OpenID Connect ID tokens. Per the - // OIDC standard, path components are allowed but query parameters are not. - // Typically the URL consists of only a hostname, like https://server.example.org - // or https://example.com. You cannot register the same provider multiple times in - // a single AWS account. If you try to submit a URL that has already been used for - // an OpenID Connect provider in the AWS account, you will get an error. - // - // This member is required. - Url *string - // A list of server certificate thumbprints for the OpenID Connect (OIDC) identity // provider's server certificates. Typically this list includes only one entry. // However, IAM lets you have up to five thumbprints for an OIDC provider. This @@ -107,6 +96,17 @@ type CreateOpenIDConnectProviderInput struct { // This member is required. ThumbprintList []*string + // The URL of the identity provider. The URL must begin with https:// and should + // correspond to the iss claim in the provider's OpenID Connect ID tokens. Per the + // OIDC standard, path components are allowed but query parameters are not. + // Typically the URL consists of only a hostname, like https://server.example.org + // or https://example.com. You cannot register the same provider multiple times in + // a single AWS account. If you try to submit a URL that has already been used for + // an OpenID Connect provider in the AWS account, you will get an error. + // + // This member is required. + Url *string + // A list of client IDs (also known as audiences). When a mobile or web app // registers with an OpenID Connect provider, they establish a value that // identifies the application. (This is the value that's sent as the client_id diff --git a/service/iam/api_op_CreatePolicy.go b/service/iam/api_op_CreatePolicy.go index e692a76b16b..19802807987 100644 --- a/service/iam/api_op_CreatePolicy.go +++ b/service/iam/api_op_CreatePolicy.go @@ -65,24 +65,6 @@ func (c *Client) CreatePolicy(ctx context.Context, params *CreatePolicyInput, op type CreatePolicyInput struct { - // The friendly name of the policy. IAM user, group, role, and policy names must be - // unique within the account. Names are not distinguished by case. For example, you - // cannot create resources named both "MyResource" and "myresource". - // - // This member is required. - PolicyName *string - - // The path for the policy. For more information about paths, see IAM Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. This parameter is optional. If it is not included, it defaults - // to a slash (/). This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of either a - // forward slash (/) by itself or a string that must begin and end with forward - // slashes. In addition, it can contain any ASCII character from the ! (\u0021) - // through the DEL character (\u007F), including most punctuation characters, - // digits, and upper and lowercased letters. - Path *string - // The JSON policy document that you want to use as the content for the new policy. // You must provide policies in JSON format in IAM. However, for AWS CloudFormation // templates formatted in YAML, you can provide the policy in JSON or YAML format. @@ -104,11 +86,29 @@ type CreatePolicyInput struct { // This member is required. PolicyDocument *string + // The friendly name of the policy. IAM user, group, role, and policy names must be + // unique within the account. Names are not distinguished by case. For example, you + // cannot create resources named both "MyResource" and "myresource". + // + // This member is required. + PolicyName *string + // A friendly description of the policy. Typically used to store information about // the permissions defined in the policy. For example, "Grants access to production // DynamoDB tables." The policy description is immutable. After a value is // assigned, it cannot be changed. Description *string + + // The path for the policy. For more information about paths, see IAM Identifiers + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the + // IAM User Guide. This parameter is optional. If it is not included, it defaults + // to a slash (/). This parameter allows (through its regex pattern + // (http://wikipedia.org/wiki/regex)) a string of characters consisting of either a + // forward slash (/) by itself or a string that must begin and end with forward + // slashes. In addition, it can contain any ASCII character from the ! (\u0021) + // through the DEL character (\u007F), including most punctuation characters, + // digits, and upper and lowercased letters. + Path *string } // Contains the response to a successful CreatePolicy () request. diff --git a/service/iam/api_op_CreatePolicyVersion.go b/service/iam/api_op_CreatePolicyVersion.go index ac5a6dc740b..6896dc4bee1 100644 --- a/service/iam/api_op_CreatePolicyVersion.go +++ b/service/iam/api_op_CreatePolicyVersion.go @@ -66,6 +66,15 @@ func (c *Client) CreatePolicyVersion(ctx context.Context, params *CreatePolicyVe type CreatePolicyVersionInput struct { + // The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new + // version. For more information about ARNs, see Amazon Resource Names (ARNs) and + // AWS Service Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in + // the AWS General Reference. + // + // This member is required. + PolicyArn *string + // The JSON policy document that you want to use as the content for this new // version of the policy. You must provide policies in JSON format in IAM. However, // for AWS CloudFormation templates formatted in YAML, you can provide the policy @@ -95,15 +104,6 @@ type CreatePolicyVersionInput struct { // (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) // in the IAM User Guide. SetAsDefault *bool - - // The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new - // version. For more information about ARNs, see Amazon Resource Names (ARNs) and - // AWS Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference. - // - // This member is required. - PolicyArn *string } // Contains the response to a successful CreatePolicyVersion () request. diff --git a/service/iam/api_op_CreateRole.go b/service/iam/api_op_CreateRole.go index ec470a457f0..7ed67aef2c2 100644 --- a/service/iam/api_op_CreateRole.go +++ b/service/iam/api_op_CreateRole.go @@ -63,50 +63,6 @@ func (c *Client) CreateRole(ctx context.Context, params *CreateRoleInput, optFns type CreateRoleInput struct { - // A list of tags that you want to attach to the newly created role. Each tag - // consists of a key name and an associated value. For more information about - // tagging, see Tagging IAM Identities - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User - // Guide. If any one of the tags is invalid or if you exceed the allowed number of - // tags per role, then the entire request fails and the role is not created. - Tags []*types.Tag - - // The path to the role. For more information about paths, see IAM Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. This parameter is optional. If it is not included, it defaults - // to a slash (/). This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of either a - // forward slash (/) by itself or a string that must begin and end with forward - // slashes. In addition, it can contain any ASCII character from the ! (\u0021) - // through the DEL character (\u007F), including most punctuation characters, - // digits, and upper and lowercased letters. - Path *string - - // The maximum session duration (in seconds) that you want to set for the specified - // role. If you do not specify a value for this setting, the default maximum of one - // hour is applied. This setting can have a value from 1 hour to 12 hours. Anyone - // who assumes the role from the AWS CLI or API can use the DurationSeconds API - // parameter or the duration-seconds CLI parameter to request a longer session. The - // MaxSessionDuration setting determines the maximum duration that can be requested - // using the DurationSeconds parameter. If users don't specify a value for the - // DurationSeconds parameter, their security credentials are valid for one hour by - // default. This applies when you use the AssumeRole* API operations or the - // assume-role* CLI operations but does not apply when you use those operations to - // create a console URL. For more information, see Using IAM Roles - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the IAM - // User Guide. - MaxSessionDuration *int32 - - // The name of the role to create. IAM user, group, role, and policy names must be - // unique within the account. Names are not distinguished by case. For example, you - // cannot create resources named both "MyResource" and "myresource". - // - // This member is required. - RoleName *string - - // A description of the role. - Description *string - // The trust relationship policy document that grants an entity permission to // assume the role.

    In IAM, you must provide a JSON policy that has been // converted to a string. However, for AWS CloudFormation templates formatted in @@ -125,8 +81,52 @@ type CreateRoleInput struct { // This member is required. AssumeRolePolicyDocument *string + // The name of the role to create. IAM user, group, role, and policy names must be + // unique within the account. Names are not distinguished by case. For example, you + // cannot create resources named both "MyResource" and "myresource". + // + // This member is required. + RoleName *string + + // A description of the role. + Description *string + + // The maximum session duration (in seconds) that you want to set for the specified + // role. If you do not specify a value for this setting, the default maximum of one + // hour is applied. This setting can have a value from 1 hour to 12 hours. Anyone + // who assumes the role from the AWS CLI or API can use the DurationSeconds API + // parameter or the duration-seconds CLI parameter to request a longer session. The + // MaxSessionDuration setting determines the maximum duration that can be requested + // using the DurationSeconds parameter. If users don't specify a value for the + // DurationSeconds parameter, their security credentials are valid for one hour by + // default. This applies when you use the AssumeRole* API operations or the + // assume-role* CLI operations but does not apply when you use those operations to + // create a console URL. For more information, see Using IAM Roles + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the IAM + // User Guide. + MaxSessionDuration *int32 + + // The path to the role. For more information about paths, see IAM Identifiers + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the + // IAM User Guide. This parameter is optional. If it is not included, it defaults + // to a slash (/). This parameter allows (through its regex pattern + // (http://wikipedia.org/wiki/regex)) a string of characters consisting of either a + // forward slash (/) by itself or a string that must begin and end with forward + // slashes. In addition, it can contain any ASCII character from the ! (\u0021) + // through the DEL character (\u007F), including most punctuation characters, + // digits, and upper and lowercased letters. + Path *string + // The ARN of the policy that is used to set the permissions boundary for the role. PermissionsBoundary *string + + // A list of tags that you want to attach to the newly created role. Each tag + // consists of a key name and an associated value. For more information about + // tagging, see Tagging IAM Identities + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User + // Guide. If any one of the tags is invalid or if you exceed the allowed number of + // tags per role, then the entire request fails and the role is not created. + Tags []*types.Tag } // Contains the response to a successful CreateRole () request. diff --git a/service/iam/api_op_CreateSAMLProvider.go b/service/iam/api_op_CreateSAMLProvider.go index c55a074d696..e62ec75b272 100644 --- a/service/iam/api_op_CreateSAMLProvider.go +++ b/service/iam/api_op_CreateSAMLProvider.go @@ -74,6 +74,14 @@ func (c *Client) CreateSAMLProvider(ctx context.Context, params *CreateSAMLProvi type CreateSAMLProviderInput struct { + // The name of the provider to create. This parameter allows (through its regex + // pattern (http://wikipedia.org/wiki/regex)) a string of characters consisting of + // upper and lowercase alphanumeric characters with no spaces. You can also include + // any of the following characters: _+=,.@- + // + // This member is required. + Name *string + // An XML document generated by an identity provider (IdP) that supports SAML 2.0. // The document includes the issuer's name, expiration information, and keys that // can be used to validate the SAML authentication response (assertions) that are @@ -85,14 +93,6 @@ type CreateSAMLProviderInput struct { // // This member is required. SAMLMetadataDocument *string - - // The name of the provider to create. This parameter allows (through its regex - // pattern (http://wikipedia.org/wiki/regex)) a string of characters consisting of - // upper and lowercase alphanumeric characters with no spaces. You can also include - // any of the following characters: _+=,.@- - // - // This member is required. - Name *string } // Contains the response to a successful CreateSAMLProvider () request. diff --git a/service/iam/api_op_CreateServiceLinkedRole.go b/service/iam/api_op_CreateServiceLinkedRole.go index 1e400084ae6..475105e2312 100644 --- a/service/iam/api_op_CreateServiceLinkedRole.go +++ b/service/iam/api_op_CreateServiceLinkedRole.go @@ -79,9 +79,6 @@ type CreateServiceLinkedRoleInput struct { // This member is required. AWSServiceName *string - // The description of the role. - Description *string - // A string that you provide, which is combined with the service-provided prefix to // form the complete role name. If you make multiple requests for the same service, // then you must supply a different CustomSuffix for each request. Otherwise the @@ -90,6 +87,9 @@ type CreateServiceLinkedRoleInput struct { // If you provide an optional suffix and the operation fails, try the operation // again without the suffix. CustomSuffix *string + + // The description of the role. + Description *string } type CreateServiceLinkedRoleOutput struct { diff --git a/service/iam/api_op_CreateUser.go b/service/iam/api_op_CreateUser.go index a4ee88babf9..5589a0dad71 100644 --- a/service/iam/api_op_CreateUser.go +++ b/service/iam/api_op_CreateUser.go @@ -61,6 +61,13 @@ func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns type CreateUserInput struct { + // The name of the user to create. IAM user, group, role, and policy names must be + // unique within the account. Names are not distinguished by case. For example, you + // cannot create resources named both "MyResource" and "myresource". + // + // This member is required. + UserName *string + // The path for the user name. For more information about paths, see IAM // Identifiers // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the @@ -73,12 +80,8 @@ type CreateUserInput struct { // digits, and upper and lowercased letters. Path *string - // The name of the user to create. IAM user, group, role, and policy names must be - // unique within the account. Names are not distinguished by case. For example, you - // cannot create resources named both "MyResource" and "myresource". - // - // This member is required. - UserName *string + // The ARN of the policy that is used to set the permissions boundary for the user. + PermissionsBoundary *string // A list of tags that you want to attach to the newly created user. Each tag // consists of a key name and an associated value. For more information about @@ -87,9 +90,6 @@ type CreateUserInput struct { // Guide. If any one of the tags is invalid or if you exceed the allowed number of // tags per user, then the entire request fails and the user is not created. Tags []*types.Tag - - // The ARN of the policy that is used to set the permissions boundary for the user. - PermissionsBoundary *string } // Contains the response to a successful CreateUser () request. diff --git a/service/iam/api_op_DeactivateMFADevice.go b/service/iam/api_op_DeactivateMFADevice.go index 97b45c7e3ef..2821a06d50a 100644 --- a/service/iam/api_op_DeactivateMFADevice.go +++ b/service/iam/api_op_DeactivateMFADevice.go @@ -61,14 +61,6 @@ func (c *Client) DeactivateMFADevice(ctx context.Context, params *DeactivateMFAD type DeactivateMFADeviceInput struct { - // The name of the user whose MFA device you want to deactivate. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no - // spaces. You can also include any of the following characters: _+=,.@- - // - // This member is required. - UserName *string - // The serial number that uniquely identifies the MFA device. For virtual MFA // devices, the serial number is the device ARN. This parameter allows (through its // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters @@ -77,6 +69,14 @@ type DeactivateMFADeviceInput struct { // // This member is required. SerialNumber *string + + // The name of the user whose MFA device you want to deactivate. This parameter + // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // characters consisting of upper and lowercase alphanumeric characters with no + // spaces. You can also include any of the following characters: _+=,.@- + // + // This member is required. + UserName *string } type DeactivateMFADeviceOutput struct { diff --git a/service/iam/api_op_DeleteAccessKey.go b/service/iam/api_op_DeleteAccessKey.go index 57dc3bb281a..49ac40b6b2d 100644 --- a/service/iam/api_op_DeleteAccessKey.go +++ b/service/iam/api_op_DeleteAccessKey.go @@ -60,12 +60,6 @@ func (c *Client) DeleteAccessKey(ctx context.Context, params *DeleteAccessKeyInp type DeleteAccessKeyInput struct { - // The name of the user whose access key pair you want to delete. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no - // spaces. You can also include any of the following characters: _+=,.@- - UserName *string - // The access key ID for the access key ID and secret access key you want to // delete. This parameter allows (through its regex pattern // (http://wikipedia.org/wiki/regex)) a string of characters that can consist of @@ -73,6 +67,12 @@ type DeleteAccessKeyInput struct { // // This member is required. AccessKeyId *string + + // The name of the user whose access key pair you want to delete. This parameter + // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // characters consisting of upper and lowercase alphanumeric characters with no + // spaces. You can also include any of the following characters: _+=,.@- + UserName *string } type DeleteAccessKeyOutput struct { diff --git a/service/iam/api_op_DeleteGroupPolicy.go b/service/iam/api_op_DeleteGroupPolicy.go index 1bec8381cb6..4cbf67d11c6 100644 --- a/service/iam/api_op_DeleteGroupPolicy.go +++ b/service/iam/api_op_DeleteGroupPolicy.go @@ -61,14 +61,6 @@ func (c *Client) DeleteGroupPolicy(ctx context.Context, params *DeleteGroupPolic type DeleteGroupPolicyInput struct { - // The name identifying the policy document to delete. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no - // spaces. You can also include any of the following characters: _+=,.@- - // - // This member is required. - PolicyName *string - // The name (friendly name, not ARN) identifying the group that the policy is // embedded in. This parameter allows (through its regex pattern // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper @@ -77,6 +69,14 @@ type DeleteGroupPolicyInput struct { // // This member is required. GroupName *string + + // The name identifying the policy document to delete. This parameter allows + // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // characters consisting of upper and lowercase alphanumeric characters with no + // spaces. You can also include any of the following characters: _+=,.@- + // + // This member is required. + PolicyName *string } type DeleteGroupPolicyOutput struct { diff --git a/service/iam/api_op_DeletePolicyVersion.go b/service/iam/api_op_DeletePolicyVersion.go index 23fc84a9c0f..934b8e00379 100644 --- a/service/iam/api_op_DeletePolicyVersion.go +++ b/service/iam/api_op_DeletePolicyVersion.go @@ -63,6 +63,15 @@ func (c *Client) DeletePolicyVersion(ctx context.Context, params *DeletePolicyVe type DeletePolicyVersionInput struct { + // The Amazon Resource Name (ARN) of the IAM policy from which you want to delete a + // version. For more information about ARNs, see Amazon Resource Names (ARNs) and + // AWS Service Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in + // the AWS General Reference. + // + // This member is required. + PolicyArn *string + // The policy version to delete. This parameter allows (through its regex pattern // (http://wikipedia.org/wiki/regex)) a string of characters that consists of the // lowercase letter 'v' followed by one or two digits, and optionally followed by a @@ -73,15 +82,6 @@ type DeletePolicyVersionInput struct { // // This member is required. VersionId *string - - // The Amazon Resource Name (ARN) of the IAM policy from which you want to delete a - // version. For more information about ARNs, see Amazon Resource Names (ARNs) and - // AWS Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference. - // - // This member is required. - PolicyArn *string } type DeletePolicyVersionOutput struct { diff --git a/service/iam/api_op_DeleteServiceSpecificCredential.go b/service/iam/api_op_DeleteServiceSpecificCredential.go index bba6000c379..9867473e957 100644 --- a/service/iam/api_op_DeleteServiceSpecificCredential.go +++ b/service/iam/api_op_DeleteServiceSpecificCredential.go @@ -56,14 +56,6 @@ func (c *Client) DeleteServiceSpecificCredential(ctx context.Context, params *De type DeleteServiceSpecificCredentialInput struct { - // The name of the IAM user associated with the service-specific credential. If - // this value is not specified, then the operation assumes the user whose - // credentials are used to call the operation. This parameter allows (through its - // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters - // consisting of upper and lowercase alphanumeric characters with no spaces. You - // can also include any of the following characters: _+=,.@- - UserName *string - // The unique identifier of the service-specific credential. You can get this value // by calling ListServiceSpecificCredentials (). This parameter allows (through its // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters that can @@ -71,6 +63,14 @@ type DeleteServiceSpecificCredentialInput struct { // // This member is required. ServiceSpecificCredentialId *string + + // The name of the IAM user associated with the service-specific credential. If + // this value is not specified, then the operation assumes the user whose + // credentials are used to call the operation. This parameter allows (through its + // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters + // consisting of upper and lowercase alphanumeric characters with no spaces. You + // can also include any of the following characters: _+=,.@- + UserName *string } type DeleteServiceSpecificCredentialOutput struct { diff --git a/service/iam/api_op_DeleteSigningCertificate.go b/service/iam/api_op_DeleteSigningCertificate.go index 69e2e5b6757..c242e01ebe0 100644 --- a/service/iam/api_op_DeleteSigningCertificate.go +++ b/service/iam/api_op_DeleteSigningCertificate.go @@ -61,18 +61,18 @@ func (c *Client) DeleteSigningCertificate(ctx context.Context, params *DeleteSig type DeleteSigningCertificateInput struct { - // The name of the user the signing certificate belongs to. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no - // spaces. You can also include any of the following characters: _+=,.@- - UserName *string - // The ID of the signing certificate to delete. The format of this parameter, as // described by its regex (http://wikipedia.org/wiki/regex) pattern, is a string of // characters that can be upper- or lower-cased letters or digits. // // This member is required. CertificateId *string + + // The name of the user the signing certificate belongs to. This parameter allows + // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // characters consisting of upper and lowercase alphanumeric characters with no + // spaces. You can also include any of the following characters: _+=,.@- + UserName *string } type DeleteSigningCertificateOutput struct { diff --git a/service/iam/api_op_DeleteUserPolicy.go b/service/iam/api_op_DeleteUserPolicy.go index 8f903b4e983..8e062716c62 100644 --- a/service/iam/api_op_DeleteUserPolicy.go +++ b/service/iam/api_op_DeleteUserPolicy.go @@ -61,6 +61,14 @@ func (c *Client) DeleteUserPolicy(ctx context.Context, params *DeleteUserPolicyI type DeleteUserPolicyInput struct { + // The name identifying the policy document to delete. This parameter allows + // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // characters consisting of upper and lowercase alphanumeric characters with no + // spaces. You can also include any of the following characters: _+=,.@- + // + // This member is required. + PolicyName *string + // The name (friendly name, not ARN) identifying the user that the policy is // embedded in. This parameter allows (through its regex pattern // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper @@ -69,14 +77,6 @@ type DeleteUserPolicyInput struct { // // This member is required. UserName *string - - // The name identifying the policy document to delete. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no - // spaces. You can also include any of the following characters: _+=,.@- - // - // This member is required. - PolicyName *string } type DeleteUserPolicyOutput struct { diff --git a/service/iam/api_op_DetachGroupPolicy.go b/service/iam/api_op_DetachGroupPolicy.go index 6368045ad32..ff80e35ca09 100644 --- a/service/iam/api_op_DetachGroupPolicy.go +++ b/service/iam/api_op_DetachGroupPolicy.go @@ -61,15 +61,6 @@ func (c *Client) DetachGroupPolicy(ctx context.Context, params *DetachGroupPolic type DetachGroupPolicyInput struct { - // The Amazon Resource Name (ARN) of the IAM policy you want to detach. For more - // information about ARNs, see Amazon Resource Names (ARNs) and AWS Service - // Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference. - // - // This member is required. - PolicyArn *string - // The name (friendly name, not ARN) of the IAM group to detach the policy from. // This parameter allows (through its regex pattern // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper @@ -78,6 +69,15 @@ type DetachGroupPolicyInput struct { // // This member is required. GroupName *string + + // The Amazon Resource Name (ARN) of the IAM policy you want to detach. For more + // information about ARNs, see Amazon Resource Names (ARNs) and AWS Service + // Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in + // the AWS General Reference. + // + // This member is required. + PolicyArn *string } type DetachGroupPolicyOutput struct { diff --git a/service/iam/api_op_DetachRolePolicy.go b/service/iam/api_op_DetachRolePolicy.go index 569d796c503..d4f09cc955c 100644 --- a/service/iam/api_op_DetachRolePolicy.go +++ b/service/iam/api_op_DetachRolePolicy.go @@ -61,15 +61,6 @@ func (c *Client) DetachRolePolicy(ctx context.Context, params *DetachRolePolicyI type DetachRolePolicyInput struct { - // The name (friendly name, not ARN) of the IAM role to detach the policy from. - // This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- - // - // This member is required. - RoleName *string - // The Amazon Resource Name (ARN) of the IAM policy you want to detach. For more // information about ARNs, see Amazon Resource Names (ARNs) and AWS Service // Namespaces @@ -78,6 +69,15 @@ type DetachRolePolicyInput struct { // // This member is required. PolicyArn *string + + // The name (friendly name, not ARN) of the IAM role to detach the policy from. + // This parameter allows (through its regex pattern + // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // This member is required. + RoleName *string } type DetachRolePolicyOutput struct { diff --git a/service/iam/api_op_EnableMFADevice.go b/service/iam/api_op_EnableMFADevice.go index 87e3e94ebae..483004cecf5 100644 --- a/service/iam/api_op_EnableMFADevice.go +++ b/service/iam/api_op_EnableMFADevice.go @@ -58,15 +58,6 @@ func (c *Client) EnableMFADevice(ctx context.Context, params *EnableMFADeviceInp type EnableMFADeviceInput struct { - // The serial number that uniquely identifies the MFA device. For virtual MFA - // devices, the serial number is the device ARN. This parameter allows (through its - // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters - // consisting of upper and lowercase alphanumeric characters with no spaces. You - // can also include any of the following characters: =,.@:/- - // - // This member is required. - SerialNumber *string - // An authentication code emitted by the device. The format for this parameter is a // string of six digits. Submit your request immediately after generating the // authentication codes. If you generate the codes and then wait too long to submit @@ -91,6 +82,15 @@ type EnableMFADeviceInput struct { // This member is required. AuthenticationCode2 *string + // The serial number that uniquely identifies the MFA device. For virtual MFA + // devices, the serial number is the device ARN. This parameter allows (through its + // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters + // consisting of upper and lowercase alphanumeric characters with no spaces. You + // can also include any of the following characters: =,.@:/- + // + // This member is required. + SerialNumber *string + // The name of the IAM user for whom you want to enable the MFA device. This // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a // string of characters consisting of upper and lowercase alphanumeric characters diff --git a/service/iam/api_op_GenerateCredentialReport.go b/service/iam/api_op_GenerateCredentialReport.go index a7ac576345e..cc3cd43a53e 100644 --- a/service/iam/api_op_GenerateCredentialReport.go +++ b/service/iam/api_op_GenerateCredentialReport.go @@ -63,12 +63,12 @@ type GenerateCredentialReportInput struct { // Contains the response to a successful GenerateCredentialReport () request. type GenerateCredentialReportOutput struct { - // Information about the state of the credential report. - State types.ReportStateType - // Information about the credential report. Description *string + // Information about the state of the credential report. + State types.ReportStateType + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iam/api_op_GenerateOrganizationsAccessReport.go b/service/iam/api_op_GenerateOrganizationsAccessReport.go index 3f2c130cc5c..14719bb8e33 100644 --- a/service/iam/api_op_GenerateOrganizationsAccessReport.go +++ b/service/iam/api_op_GenerateOrganizationsAccessReport.go @@ -163,11 +163,6 @@ func (c *Client) GenerateOrganizationsAccessReport(ctx context.Context, params * type GenerateOrganizationsAccessReportInput struct { - // The identifier of the AWS Organizations service control policy (SCP). This - // parameter is optional. This ID is used to generate information about when an - // account principal that is limited by the SCP attempted to access an AWS service. - OrganizationsPolicyId *string - // The path of the AWS Organizations entity (root, OU, or account). You can build // an entity path using the known structure of your organization. For example, // assume that your account ID is 123456789012 and its parent OU ID is @@ -177,6 +172,11 @@ type GenerateOrganizationsAccessReportInput struct { // // This member is required. EntityPath *string + + // The identifier of the AWS Organizations service control policy (SCP). This + // parameter is optional. This ID is used to generate information about when an + // account principal that is limited by the SCP attempted to access an AWS service. + OrganizationsPolicyId *string } type GenerateOrganizationsAccessReportOutput struct { diff --git a/service/iam/api_op_GetAccountAuthorizationDetails.go b/service/iam/api_op_GetAccountAuthorizationDetails.go index ef952a9c069..44f410f19a5 100644 --- a/service/iam/api_op_GetAccountAuthorizationDetails.go +++ b/service/iam/api_op_GetAccountAuthorizationDetails.go @@ -91,8 +91,8 @@ type GetAccountAuthorizationDetailsInput struct { // Contains the response to a successful GetAccountAuthorizationDetails () request. type GetAccountAuthorizationDetailsOutput struct { - // A list containing information about IAM roles. - RoleDetailList []*types.RoleDetail + // A list containing information about IAM groups. + GroupDetailList []*types.GroupDetail // A flag that indicates whether there are more items to return. If your results // were truncated, you can make a subsequent pagination request using the Marker @@ -102,9 +102,6 @@ type GetAccountAuthorizationDetailsOutput struct { // all your results. IsTruncated *bool - // A list containing information about IAM users. - UserDetailList []*types.UserDetail - // When IsTruncated is true, this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -112,8 +109,11 @@ type GetAccountAuthorizationDetailsOutput struct { // A list containing information about managed policies. Policies []*types.ManagedPolicyDetail - // A list containing information about IAM groups. - GroupDetailList []*types.GroupDetail + // A list containing information about IAM roles. + RoleDetailList []*types.RoleDetail + + // A list containing information about IAM users. + UserDetailList []*types.UserDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/iam/api_op_GetCredentialReport.go b/service/iam/api_op_GetCredentialReport.go index 0822855d3a3..bce4d4dd3a6 100644 --- a/service/iam/api_op_GetCredentialReport.go +++ b/service/iam/api_op_GetCredentialReport.go @@ -67,13 +67,13 @@ type GetCredentialReportOutput struct { // Contains the credential report. The report is Base64-encoded. Content []byte - // The format (MIME type) of the credential report. - ReportFormat types.ReportFormatType - // The date and time when the credential report was created, in ISO 8601 date-time // format (http://www.iso.org/iso/iso8601). GeneratedTime *time.Time + // The format (MIME type) of the credential report. + ReportFormat types.ReportFormatType + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iam/api_op_GetGroup.go b/service/iam/api_op_GetGroup.go index e4273d479ba..f1d77d8141b 100644 --- a/service/iam/api_op_GetGroup.go +++ b/service/iam/api_op_GetGroup.go @@ -58,15 +58,6 @@ func (c *Client) GetGroup(ctx context.Context, params *GetGroupInput, optFns ... type GetGroupInput struct { - // Use this only when paginating results to indicate the maximum number of items - // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this - // parameter, the number of items defaults to 100. Note that IAM might return fewer - // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to - // include in the subsequent call that tells the service where to continue from. - MaxItems *int32 - // The name of the group. This parameter allows (through its regex pattern // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any @@ -80,6 +71,15 @@ type GetGroupInput struct { // Marker element in the response that you received to indicate where the next call // should start. Marker *string + + // Use this only when paginating results to indicate the maximum number of items + // you want in the response. If additional items exist beyond the maximum you + // specify, the IsTruncated response element is true. If you do not include this + // parameter, the number of items defaults to 100. Note that IAM might return fewer + // results, even when there are more results available. In that case, the + // IsTruncated response element returns true, and Marker contains a value to + // include in the subsequent call that tells the service where to continue from. + MaxItems *int32 } // Contains the response to a successful GetGroup () request. @@ -90,10 +90,6 @@ type GetGroupOutput struct { // This member is required. Group *types.Group - // When IsTruncated is true, this element is present and contains the value to use - // for the Marker parameter in a subsequent pagination request. - Marker *string - // A list of users in the group. // // This member is required. @@ -107,6 +103,10 @@ type GetGroupOutput struct { // all your results. IsTruncated *bool + // When IsTruncated is true, this element is present and contains the value to use + // for the Marker parameter in a subsequent pagination request. + Marker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iam/api_op_GetGroupPolicy.go b/service/iam/api_op_GetGroupPolicy.go index a7e8241c07e..ac04aed0812 100644 --- a/service/iam/api_op_GetGroupPolicy.go +++ b/service/iam/api_op_GetGroupPolicy.go @@ -67,14 +67,6 @@ func (c *Client) GetGroupPolicy(ctx context.Context, params *GetGroupPolicyInput type GetGroupPolicyInput struct { - // The name of the policy document to get. This parameter allows (through its regex - // pattern (http://wikipedia.org/wiki/regex)) a string of characters consisting of - // upper and lowercase alphanumeric characters with no spaces. You can also include - // any of the following characters: _+=,.@- - // - // This member is required. - PolicyName *string - // The name of the group the policy is associated with. This parameter allows // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of // characters consisting of upper and lowercase alphanumeric characters with no @@ -82,11 +74,24 @@ type GetGroupPolicyInput struct { // // This member is required. GroupName *string + + // The name of the policy document to get. This parameter allows (through its regex + // pattern (http://wikipedia.org/wiki/regex)) a string of characters consisting of + // upper and lowercase alphanumeric characters with no spaces. You can also include + // any of the following characters: _+=,.@- + // + // This member is required. + PolicyName *string } // Contains the response to a successful GetGroupPolicy () request. type GetGroupPolicyOutput struct { + // The group the policy is associated with. + // + // This member is required. + GroupName *string + // The policy document. IAM stores policies in JSON format. However, resources that // were created using AWS CloudFormation templates can be formatted in YAML. AWS // CloudFormation always converts a YAML policy to JSON format before submitting it @@ -100,11 +105,6 @@ type GetGroupPolicyOutput struct { // This member is required. PolicyName *string - // The group the policy is associated with. - // - // This member is required. - GroupName *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iam/api_op_GetOpenIDConnectProvider.go b/service/iam/api_op_GetOpenIDConnectProvider.go index f4205f65b48..674908c0774 100644 --- a/service/iam/api_op_GetOpenIDConnectProvider.go +++ b/service/iam/api_op_GetOpenIDConnectProvider.go @@ -72,6 +72,15 @@ type GetOpenIDConnectProviderInput struct { // Contains the response to a successful GetOpenIDConnectProvider () request. type GetOpenIDConnectProviderOutput struct { + // A list of client IDs (also known as audiences) that are associated with the + // specified IAM OIDC provider resource object. For more information, see + // CreateOpenIDConnectProvider (). + ClientIDList []*string + + // The date and time when the IAM OIDC provider resource object was created in the + // AWS account. + CreateDate *time.Time + // A list of certificate thumbprints that are associated with the specified IAM // OIDC provider resource object. For more information, see // CreateOpenIDConnectProvider (). @@ -81,15 +90,6 @@ type GetOpenIDConnectProviderOutput struct { // information, see CreateOpenIDConnectProvider (). Url *string - // The date and time when the IAM OIDC provider resource object was created in the - // AWS account. - CreateDate *time.Time - - // A list of client IDs (also known as audiences) that are associated with the - // specified IAM OIDC provider resource object. For more information, see - // CreateOpenIDConnectProvider (). - ClientIDList []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iam/api_op_GetOrganizationsAccessReport.go b/service/iam/api_op_GetOrganizationsAccessReport.go index 0b5d4f08294..6ce512c8104 100644 --- a/service/iam/api_op_GetOrganizationsAccessReport.go +++ b/service/iam/api_op_GetOrganizationsAccessReport.go @@ -73,23 +73,18 @@ func (c *Client) GetOrganizationsAccessReport(ctx context.Context, params *GetOr type GetOrganizationsAccessReportInput struct { - // Use this parameter only when paginating results and only after you receive a - // response indicating that the results are truncated. Set it to the value of the - // Marker element in the response that you received to indicate where the next call - // should start. - Marker *string - - // The key that is used to sort the results. If you choose the namespace key, the - // results are returned in alphabetical order. If you choose the time key, the - // results are sorted numerically by the date and time. - SortKey types.SortKeyType - // The identifier of the request generated by the GenerateOrganizationsAccessReport // () operation. // // This member is required. JobId *string + // Use this parameter only when paginating results and only after you receive a + // response indicating that the results are truncated. Set it to the value of the + // Marker element in the response that you received to indicate where the next call + // should start. + Marker *string + // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you // specify, the IsTruncated response element is true. If you do not include this @@ -98,6 +93,11 @@ type GetOrganizationsAccessReportInput struct { // IsTruncated response element returns true, and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 + + // The key that is used to sort the results. If you choose the namespace key, the + // results are returned in alphabetical order. If you choose the time key, the + // results are sorted numerically by the date and time. + SortKey types.SortKeyType } type GetOrganizationsAccessReportOutput struct { @@ -113,6 +113,16 @@ type GetOrganizationsAccessReportOutput struct { // This member is required. JobStatus types.JobStatusType + // An object that contains details about the most recent attempt to access the + // service. + AccessDetails []*types.AccessDetail + + // Contains information about the reason that the operation failed. This data type + // is used as a response element in the GetOrganizationsAccessReport (), + // GetServiceLastAccessedDetails (), and GetServiceLastAccessedDetailsWithEntities + // () operations. + ErrorDetails *types.ErrorDetails + // A flag that indicates whether there are more items to return. If your results // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than @@ -121,34 +131,24 @@ type GetOrganizationsAccessReportOutput struct { // all your results. IsTruncated *bool - // The number of services that the applicable SCPs allow account principals to - // access. - NumberOfServicesAccessible *int32 + // The date and time, in ISO 8601 date-time format + // (http://www.iso.org/iso/iso8601), when the generated report job was completed or + // failed. This field is null if the job is still in progress, as indicated by a + // job status value of IN_PROGRESS. + JobCompletionDate *time.Time // When IsTruncated is true, this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string - // Contains information about the reason that the operation failed. This data type - // is used as a response element in the GetOrganizationsAccessReport (), - // GetServiceLastAccessedDetails (), and GetServiceLastAccessedDetailsWithEntities - // () operations. - ErrorDetails *types.ErrorDetails + // The number of services that the applicable SCPs allow account principals to + // access. + NumberOfServicesAccessible *int32 // The number of services that account principals are allowed but did not attempt // to access. NumberOfServicesNotAccessed *int32 - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the generated report job was completed or - // failed. This field is null if the job is still in progress, as indicated by a - // job status value of IN_PROGRESS. - JobCompletionDate *time.Time - - // An object that contains details about the most recent attempt to access the - // service. - AccessDetails []*types.AccessDetail - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iam/api_op_GetPolicyVersion.go b/service/iam/api_op_GetPolicyVersion.go index d3ce25036a4..762e0d4772f 100644 --- a/service/iam/api_op_GetPolicyVersion.go +++ b/service/iam/api_op_GetPolicyVersion.go @@ -73,14 +73,6 @@ func (c *Client) GetPolicyVersion(ctx context.Context, params *GetPolicyVersionI type GetPolicyVersionInput struct { - // Identifies the policy version to retrieve. This parameter allows (through its - // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters that - // consists of the lowercase letter 'v' followed by one or two digits, and - // optionally followed by a period '.' and a string of letters and digits. - // - // This member is required. - VersionId *string - // The Amazon Resource Name (ARN) of the managed policy that you want information // about. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS // Service Namespaces @@ -89,6 +81,14 @@ type GetPolicyVersionInput struct { // // This member is required. PolicyArn *string + + // Identifies the policy version to retrieve. This parameter allows (through its + // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters that + // consists of the lowercase letter 'v' followed by one or two digits, and + // optionally followed by a period '.' and a string of letters and digits. + // + // This member is required. + VersionId *string } // Contains the response to a successful GetPolicyVersion () request. diff --git a/service/iam/api_op_GetRolePolicy.go b/service/iam/api_op_GetRolePolicy.go index ef6759d114b..cc27cedaa8f 100644 --- a/service/iam/api_op_GetRolePolicy.go +++ b/service/iam/api_op_GetRolePolicy.go @@ -89,11 +89,6 @@ type GetRolePolicyInput struct { // Contains the response to a successful GetRolePolicy () request. type GetRolePolicyOutput struct { - // The name of the policy. - // - // This member is required. - PolicyName *string - // The policy document. IAM stores policies in JSON format. However, resources that // were created using AWS CloudFormation templates can be formatted in YAML. AWS // CloudFormation always converts a YAML policy to JSON format before submitting it @@ -102,6 +97,11 @@ type GetRolePolicyOutput struct { // This member is required. PolicyDocument *string + // The name of the policy. + // + // This member is required. + PolicyName *string + // The role the policy is associated with. // // This member is required. diff --git a/service/iam/api_op_GetSAMLProvider.go b/service/iam/api_op_GetSAMLProvider.go index d05c70ea4f6..08f121366e1 100644 --- a/service/iam/api_op_GetSAMLProvider.go +++ b/service/iam/api_op_GetSAMLProvider.go @@ -73,14 +73,14 @@ type GetSAMLProviderInput struct { // Contains the response to a successful GetSAMLProvider () request. type GetSAMLProviderOutput struct { - // The expiration date and time for the SAML provider. - ValidUntil *time.Time + // The date and time when the SAML provider was created. + CreateDate *time.Time // The XML metadata document that includes information about an identity provider. SAMLMetadataDocument *string - // The date and time when the SAML provider was created. - CreateDate *time.Time + // The expiration date and time for the SAML provider. + ValidUntil *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/iam/api_op_GetSSHPublicKey.go b/service/iam/api_op_GetSSHPublicKey.go index bed5b514d4a..8a91a3804c2 100644 --- a/service/iam/api_op_GetSSHPublicKey.go +++ b/service/iam/api_op_GetSSHPublicKey.go @@ -63,13 +63,12 @@ func (c *Client) GetSSHPublicKey(ctx context.Context, params *GetSSHPublicKeyInp type GetSSHPublicKeyInput struct { - // The name of the IAM user associated with the SSH public key. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no - // spaces. You can also include any of the following characters: _+=,.@- + // Specifies the public key encoding format to use in the response. To retrieve the + // public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, + // use PEM. // // This member is required. - UserName *string + Encoding types.EncodingType // The unique identifier for the SSH public key. This parameter allows (through its // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters that can @@ -78,12 +77,13 @@ type GetSSHPublicKeyInput struct { // This member is required. SSHPublicKeyId *string - // Specifies the public key encoding format to use in the response. To retrieve the - // public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, - // use PEM. + // The name of the IAM user associated with the SSH public key. This parameter + // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // characters consisting of upper and lowercase alphanumeric characters with no + // spaces. You can also include any of the following characters: _+=,.@- // // This member is required. - Encoding types.EncodingType + UserName *string } // Contains the response to a successful GetSSHPublicKey () request. diff --git a/service/iam/api_op_GetServiceLastAccessedDetails.go b/service/iam/api_op_GetServiceLastAccessedDetails.go index e40d89b9269..cd0b1b5c229 100644 --- a/service/iam/api_op_GetServiceLastAccessedDetails.go +++ b/service/iam/api_op_GetServiceLastAccessedDetails.go @@ -109,6 +109,12 @@ type GetServiceLastAccessedDetailsInput struct { // This member is required. JobId *string + // Use this parameter only when paginating results and only after you receive a + // response indicating that the results are truncated. Set it to the value of the + // Marker element in the response that you received to indicate where the next call + // should start. + Marker *string + // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you // specify, the IsTruncated response element is true. If you do not include this @@ -117,32 +123,37 @@ type GetServiceLastAccessedDetailsInput struct { // IsTruncated response element returns true, and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 - - // Use this parameter only when paginating results and only after you receive a - // response indicating that the results are truncated. Set it to the value of the - // Marker element in the response that you received to indicate where the next call - // should start. - Marker *string } type GetServiceLastAccessedDetailsOutput struct { + // The date and time, in ISO 8601 date-time format + // (http://www.iso.org/iso/iso8601), when the generated report job was completed or + // failed. This field is null if the job is still in progress, as indicated by a + // job status value of IN_PROGRESS. + // + // This member is required. + JobCompletionDate *time.Time + // The date and time, in ISO 8601 date-time format // (http://www.iso.org/iso/iso8601), when the report job was created. // // This member is required. JobCreationDate *time.Time + // The status of the job. + // + // This member is required. + JobStatus types.JobStatusType + // A ServiceLastAccessed object that contains details about the most recent attempt // to access the service. // // This member is required. ServicesLastAccessed []*types.ServiceLastAccessed - // The status of the job. - // - // This member is required. - JobStatus types.JobStatusType + // An object that contains details about the reason the operation failed. + Error *types.ErrorDetails // A flag that indicates whether there are more items to return. If your results // were truncated, you can make a subsequent pagination request using the Marker @@ -161,17 +172,6 @@ type GetServiceLastAccessedDetailsOutput struct { // for the Marker parameter in a subsequent pagination request. Marker *string - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the generated report job was completed or - // failed. This field is null if the job is still in progress, as indicated by a - // job status value of IN_PROGRESS. - // - // This member is required. - JobCompletionDate *time.Time - - // An object that contains details about the reason the operation failed. - Error *types.ErrorDetails - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iam/api_op_GetServiceLastAccessedDetailsWithEntities.go b/service/iam/api_op_GetServiceLastAccessedDetailsWithEntities.go index fd1948fb9cc..ffc0fde92c5 100644 --- a/service/iam/api_op_GetServiceLastAccessedDetailsWithEntities.go +++ b/service/iam/api_op_GetServiceLastAccessedDetailsWithEntities.go @@ -97,6 +97,12 @@ type GetServiceLastAccessedDetailsWithEntitiesInput struct { // This member is required. ServiceNamespace *string + // Use this parameter only when paginating results and only after you receive a + // response indicating that the results are truncated. Set it to the value of the + // Marker element in the response that you received to indicate where the next call + // should start. + Marker *string + // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you // specify, the IsTruncated response element is true. If you do not include this @@ -105,26 +111,16 @@ type GetServiceLastAccessedDetailsWithEntitiesInput struct { // IsTruncated response element returns true, and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 - - // Use this parameter only when paginating results and only after you receive a - // response indicating that the results are truncated. Set it to the value of the - // Marker element in the response that you received to indicate where the next call - // should start. - Marker *string } type GetServiceLastAccessedDetailsWithEntitiesOutput struct { - // A flag that indicates whether there are more items to return. If your results - // were truncated, you can make a subsequent pagination request using the Marker - // request parameter to retrieve more items. Note that IAM might return fewer than - // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. - IsTruncated *bool - - // An object that contains details about the reason the operation failed. - Error *types.ErrorDetails + // An EntityDetailsList object that contains details about when an IAM entity (user + // or role) used group or policy permissions in an attempt to access the specified + // AWS service. + // + // This member is required. + EntityDetailsList []*types.EntityDetails // The date and time, in ISO 8601 date-time format // (http://www.iso.org/iso/iso8601), when the generated report job was completed or @@ -134,10 +130,6 @@ type GetServiceLastAccessedDetailsWithEntitiesOutput struct { // This member is required. JobCompletionDate *time.Time - // When IsTruncated is true, this element is present and contains the value to use - // for the Marker parameter in a subsequent pagination request. - Marker *string - // The date and time, in ISO 8601 date-time format // (http://www.iso.org/iso/iso8601), when the report job was created. // @@ -149,12 +141,20 @@ type GetServiceLastAccessedDetailsWithEntitiesOutput struct { // This member is required. JobStatus types.JobStatusType - // An EntityDetailsList object that contains details about when an IAM entity (user - // or role) used group or policy permissions in an attempt to access the specified - // AWS service. - // - // This member is required. - EntityDetailsList []*types.EntityDetails + // An object that contains details about the reason the operation failed. + Error *types.ErrorDetails + + // A flag that indicates whether there are more items to return. If your results + // were truncated, you can make a subsequent pagination request using the Marker + // request parameter to retrieve more items. Note that IAM might return fewer than + // the MaxItems number of results even when there are more results available. We + // recommend that you check IsTruncated after every call to ensure that you receive + // all your results. + IsTruncated *bool + + // When IsTruncated is true, this element is present and contains the value to use + // for the Marker parameter in a subsequent pagination request. + Marker *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/iam/api_op_GetServiceLinkedRoleDeletionStatus.go b/service/iam/api_op_GetServiceLinkedRoleDeletionStatus.go index 998c06ae9e6..b66edf0a839 100644 --- a/service/iam/api_op_GetServiceLinkedRoleDeletionStatus.go +++ b/service/iam/api_op_GetServiceLinkedRoleDeletionStatus.go @@ -71,14 +71,14 @@ type GetServiceLinkedRoleDeletionStatusInput struct { type GetServiceLinkedRoleDeletionStatusOutput struct { - // An object that contains details about the reason the deletion failed. - Reason *types.DeletionTaskFailureReasonType - // The status of the deletion. // // This member is required. Status types.DeletionTaskStatusType + // An object that contains details about the reason the deletion failed. + Reason *types.DeletionTaskFailureReasonType + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iam/api_op_ListAccessKeys.go b/service/iam/api_op_ListAccessKeys.go index bd5da650d00..264d14093c4 100644 --- a/service/iam/api_op_ListAccessKeys.go +++ b/service/iam/api_op_ListAccessKeys.go @@ -65,6 +65,12 @@ func (c *Client) ListAccessKeys(ctx context.Context, params *ListAccessKeysInput type ListAccessKeysInput struct { + // Use this parameter only when paginating results and only after you receive a + // response indicating that the results are truncated. Set it to the value of the + // Marker element in the response that you received to indicate where the next call + // should start. + Marker *string + // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you // specify, the IsTruncated response element is true. If you do not include this @@ -74,12 +80,6 @@ type ListAccessKeysInput struct { // include in the subsequent call that tells the service where to continue from. MaxItems *int32 - // Use this parameter only when paginating results and only after you receive a - // response indicating that the results are truncated. Set it to the value of the - // Marker element in the response that you received to indicate where the next call - // should start. - Marker *string - // The name of the user. This parameter allows (through its regex pattern // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any @@ -95,10 +95,6 @@ type ListAccessKeysOutput struct { // This member is required. AccessKeyMetadata []*types.AccessKeyMetadata - // When IsTruncated is true, this element is present and contains the value to use - // for the Marker parameter in a subsequent pagination request. - Marker *string - // A flag that indicates whether there are more items to return. If your results // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than @@ -107,6 +103,10 @@ type ListAccessKeysOutput struct { // all your results. IsTruncated *bool + // When IsTruncated is true, this element is present and contains the value to use + // for the Marker parameter in a subsequent pagination request. + Marker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iam/api_op_ListAccountAliases.go b/service/iam/api_op_ListAccountAliases.go index 147d5085651..678ac6d682d 100644 --- a/service/iam/api_op_ListAccountAliases.go +++ b/service/iam/api_op_ListAccountAliases.go @@ -59,6 +59,12 @@ func (c *Client) ListAccountAliases(ctx context.Context, params *ListAccountAlia type ListAccountAliasesInput struct { + // Use this parameter only when paginating results and only after you receive a + // response indicating that the results are truncated. Set it to the value of the + // Marker element in the response that you received to indicate where the next call + // should start. + Marker *string + // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you // specify, the IsTruncated response element is true. If you do not include this @@ -67,17 +73,17 @@ type ListAccountAliasesInput struct { // IsTruncated response element returns true, and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 - - // Use this parameter only when paginating results and only after you receive a - // response indicating that the results are truncated. Set it to the value of the - // Marker element in the response that you received to indicate where the next call - // should start. - Marker *string } // Contains the response to a successful ListAccountAliases () request. type ListAccountAliasesOutput struct { + // A list of aliases associated with the account. AWS supports only one alias per + // account. + // + // This member is required. + AccountAliases []*string + // A flag that indicates whether there are more items to return. If your results // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than @@ -86,12 +92,6 @@ type ListAccountAliasesOutput struct { // all your results. IsTruncated *bool - // A list of aliases associated with the account. AWS supports only one alias per - // account. - // - // This member is required. - AccountAliases []*string - // When IsTruncated is true, this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string diff --git a/service/iam/api_op_ListAttachedGroupPolicies.go b/service/iam/api_op_ListAttachedGroupPolicies.go index d51ac72ec36..3ba3812e886 100644 --- a/service/iam/api_op_ListAttachedGroupPolicies.go +++ b/service/iam/api_op_ListAttachedGroupPolicies.go @@ -75,14 +75,11 @@ type ListAttachedGroupPoliciesInput struct { // This member is required. GroupName *string - // The path prefix for filtering the results. This parameter is optional. If it is - // not included, it defaults to a slash (/), listing all policies. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of either a forward slash (/) by itself or a string that - // must begin and end with forward slashes. In addition, it can contain any ASCII - // character from the ! (\u0021) through the DEL character (\u007F), including most - // punctuation characters, digits, and upper and lowercased letters. - PathPrefix *string + // Use this parameter only when paginating results and only after you receive a + // response indicating that the results are truncated. Set it to the value of the + // Marker element in the response that you received to indicate where the next call + // should start. + Marker *string // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you @@ -93,19 +90,21 @@ type ListAttachedGroupPoliciesInput struct { // include in the subsequent call that tells the service where to continue from. MaxItems *int32 - // Use this parameter only when paginating results and only after you receive a - // response indicating that the results are truncated. Set it to the value of the - // Marker element in the response that you received to indicate where the next call - // should start. - Marker *string + // The path prefix for filtering the results. This parameter is optional. If it is + // not included, it defaults to a slash (/), listing all policies. This parameter + // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // characters consisting of either a forward slash (/) by itself or a string that + // must begin and end with forward slashes. In addition, it can contain any ASCII + // character from the ! (\u0021) through the DEL character (\u007F), including most + // punctuation characters, digits, and upper and lowercased letters. + PathPrefix *string } // Contains the response to a successful ListAttachedGroupPolicies () request. type ListAttachedGroupPoliciesOutput struct { - // When IsTruncated is true, this element is present and contains the value to use - // for the Marker parameter in a subsequent pagination request. - Marker *string + // A list of the attached policies. + AttachedPolicies []*types.AttachedPolicy // A flag that indicates whether there are more items to return. If your results // were truncated, you can make a subsequent pagination request using the Marker @@ -115,8 +114,9 @@ type ListAttachedGroupPoliciesOutput struct { // all your results. IsTruncated *bool - // A list of the attached policies. - AttachedPolicies []*types.AttachedPolicy + // When IsTruncated is true, this element is present and contains the value to use + // for the Marker parameter in a subsequent pagination request. + Marker *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/iam/api_op_ListAttachedRolePolicies.go b/service/iam/api_op_ListAttachedRolePolicies.go index 02f2ab54ced..69f05cb7cae 100644 --- a/service/iam/api_op_ListAttachedRolePolicies.go +++ b/service/iam/api_op_ListAttachedRolePolicies.go @@ -66,15 +66,6 @@ func (c *Client) ListAttachedRolePolicies(ctx context.Context, params *ListAttac type ListAttachedRolePoliciesInput struct { - // The path prefix for filtering the results. This parameter is optional. If it is - // not included, it defaults to a slash (/), listing all policies. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of either a forward slash (/) by itself or a string that - // must begin and end with forward slashes. In addition, it can contain any ASCII - // character from the ! (\u0021) through the DEL character (\u007F), including most - // punctuation characters, digits, and upper and lowercased letters. - PathPrefix *string - // The name (friendly name, not ARN) of the role to list attached policies for. // This parameter allows (through its regex pattern // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper @@ -98,6 +89,15 @@ type ListAttachedRolePoliciesInput struct { // IsTruncated response element returns true, and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 + + // The path prefix for filtering the results. This parameter is optional. If it is + // not included, it defaults to a slash (/), listing all policies. This parameter + // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // characters consisting of either a forward slash (/) by itself or a string that + // must begin and end with forward slashes. In addition, it can contain any ASCII + // character from the ! (\u0021) through the DEL character (\u007F), including most + // punctuation characters, digits, and upper and lowercased letters. + PathPrefix *string } // Contains the response to a successful ListAttachedRolePolicies () request. diff --git a/service/iam/api_op_ListAttachedUserPolicies.go b/service/iam/api_op_ListAttachedUserPolicies.go index 21f598d1cfa..709f88cb854 100644 --- a/service/iam/api_op_ListAttachedUserPolicies.go +++ b/service/iam/api_op_ListAttachedUserPolicies.go @@ -66,21 +66,21 @@ func (c *Client) ListAttachedUserPolicies(ctx context.Context, params *ListAttac type ListAttachedUserPoliciesInput struct { + // The name (friendly name, not ARN) of the user to list attached policies for. + // This parameter allows (through its regex pattern + // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // This member is required. + UserName *string + // Use this parameter only when paginating results and only after you receive a // response indicating that the results are truncated. Set it to the value of the // Marker element in the response that you received to indicate where the next call // should start. Marker *string - // The path prefix for filtering the results. This parameter is optional. If it is - // not included, it defaults to a slash (/), listing all policies. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of either a forward slash (/) by itself or a string that - // must begin and end with forward slashes. In addition, it can contain any ASCII - // character from the ! (\u0021) through the DEL character (\u007F), including most - // punctuation characters, digits, and upper and lowercased letters. - PathPrefix *string - // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you // specify, the IsTruncated response element is true. If you do not include this @@ -90,23 +90,19 @@ type ListAttachedUserPoliciesInput struct { // include in the subsequent call that tells the service where to continue from. MaxItems *int32 - // The name (friendly name, not ARN) of the user to list attached policies for. - // This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- - // - // This member is required. - UserName *string + // The path prefix for filtering the results. This parameter is optional. If it is + // not included, it defaults to a slash (/), listing all policies. This parameter + // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // characters consisting of either a forward slash (/) by itself or a string that + // must begin and end with forward slashes. In addition, it can contain any ASCII + // character from the ! (\u0021) through the DEL character (\u007F), including most + // punctuation characters, digits, and upper and lowercased letters. + PathPrefix *string } // Contains the response to a successful ListAttachedUserPolicies () request. type ListAttachedUserPoliciesOutput struct { - // When IsTruncated is true, this element is present and contains the value to use - // for the Marker parameter in a subsequent pagination request. - Marker *string - // A list of the attached policies. AttachedPolicies []*types.AttachedPolicy @@ -118,6 +114,10 @@ type ListAttachedUserPoliciesOutput struct { // all your results. IsTruncated *bool + // When IsTruncated is true, this element is present and contains the value to use + // for the Marker parameter in a subsequent pagination request. + Marker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iam/api_op_ListEntitiesForPolicy.go b/service/iam/api_op_ListEntitiesForPolicy.go index ad5a9033c47..4ae25c65e0f 100644 --- a/service/iam/api_op_ListEntitiesForPolicy.go +++ b/service/iam/api_op_ListEntitiesForPolicy.go @@ -62,21 +62,14 @@ func (c *Client) ListEntitiesForPolicy(ctx context.Context, params *ListEntities type ListEntitiesForPolicyInput struct { - // The path prefix for filtering the results. This parameter is optional. If it is - // not included, it defaults to a slash (/), listing all entities. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of either a forward slash (/) by itself or a string that - // must begin and end with forward slashes. In addition, it can contain any ASCII - // character from the ! (\u0021) through the DEL character (\u007F), including most - // punctuation characters, digits, and upper and lowercased letters. - PathPrefix *string - - // The policy usage method to use for filtering the results. To list only - // permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only - // the policies used to set permissions boundaries, set the value to - // PermissionsBoundary. This parameter is optional. If it is not included, all - // policies are returned. - PolicyUsageFilter types.PolicyUsageType + // The Amazon Resource Name (ARN) of the IAM policy for which you want the + // versions. For more information about ARNs, see Amazon Resource Names (ARNs) and + // AWS Service Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in + // the AWS General Reference. + // + // This member is required. + PolicyArn *string // The entity type to use for filtering the results. For example, when EntityFilter // is Role, only the roles that are attached to the specified policy are returned. @@ -85,6 +78,12 @@ type ListEntitiesForPolicyInput struct { // the valid values listed below. EntityFilter types.EntityType + // Use this parameter only when paginating results and only after you receive a + // response indicating that the results are truncated. Set it to the value of the + // Marker element in the response that you received to indicate where the next call + // should start. + Marker *string + // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you // specify, the IsTruncated response element is true. If you do not include this @@ -94,32 +93,26 @@ type ListEntitiesForPolicyInput struct { // include in the subsequent call that tells the service where to continue from. MaxItems *int32 - // Use this parameter only when paginating results and only after you receive a - // response indicating that the results are truncated. Set it to the value of the - // Marker element in the response that you received to indicate where the next call - // should start. - Marker *string + // The path prefix for filtering the results. This parameter is optional. If it is + // not included, it defaults to a slash (/), listing all entities. This parameter + // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // characters consisting of either a forward slash (/) by itself or a string that + // must begin and end with forward slashes. In addition, it can contain any ASCII + // character from the ! (\u0021) through the DEL character (\u007F), including most + // punctuation characters, digits, and upper and lowercased letters. + PathPrefix *string - // The Amazon Resource Name (ARN) of the IAM policy for which you want the - // versions. For more information about ARNs, see Amazon Resource Names (ARNs) and - // AWS Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference. - // - // This member is required. - PolicyArn *string + // The policy usage method to use for filtering the results. To list only + // permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only + // the policies used to set permissions boundaries, set the value to + // PermissionsBoundary. This parameter is optional. If it is not included, all + // policies are returned. + PolicyUsageFilter types.PolicyUsageType } // Contains the response to a successful ListEntitiesForPolicy () request. type ListEntitiesForPolicyOutput struct { - // When IsTruncated is true, this element is present and contains the value to use - // for the Marker parameter in a subsequent pagination request. - Marker *string - - // A list of IAM users that the policy is attached to. - PolicyUsers []*types.PolicyUser - // A flag that indicates whether there are more items to return. If your results // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than @@ -128,12 +121,19 @@ type ListEntitiesForPolicyOutput struct { // all your results. IsTruncated *bool - // A list of IAM roles that the policy is attached to. - PolicyRoles []*types.PolicyRole + // When IsTruncated is true, this element is present and contains the value to use + // for the Marker parameter in a subsequent pagination request. + Marker *string // A list of IAM groups that the policy is attached to. PolicyGroups []*types.PolicyGroup + // A list of IAM roles that the policy is attached to. + PolicyRoles []*types.PolicyRole + + // A list of IAM users that the policy is attached to. + PolicyUsers []*types.PolicyUser + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iam/api_op_ListGroupPolicies.go b/service/iam/api_op_ListGroupPolicies.go index e51e95912ca..5795b3fc939 100644 --- a/service/iam/api_op_ListGroupPolicies.go +++ b/service/iam/api_op_ListGroupPolicies.go @@ -63,6 +63,14 @@ func (c *Client) ListGroupPolicies(ctx context.Context, params *ListGroupPolicie type ListGroupPoliciesInput struct { + // The name of the group to list policies for. This parameter allows (through its + // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters + // consisting of upper and lowercase alphanumeric characters with no spaces. You + // can also include any of the following characters: _+=,.@- + // + // This member is required. + GroupName *string + // Use this parameter only when paginating results and only after you receive a // response indicating that the results are truncated. Set it to the value of the // Marker element in the response that you received to indicate where the next call @@ -77,14 +85,6 @@ type ListGroupPoliciesInput struct { // IsTruncated response element returns true, and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 - - // The name of the group to list policies for. This parameter allows (through its - // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters - // consisting of upper and lowercase alphanumeric characters with no spaces. You - // can also include any of the following characters: _+=,.@- - // - // This member is required. - GroupName *string } // Contains the response to a successful ListGroupPolicies () request. @@ -98,10 +98,6 @@ type ListGroupPoliciesOutput struct { // This member is required. PolicyNames []*string - // When IsTruncated is true, this element is present and contains the value to use - // for the Marker parameter in a subsequent pagination request. - Marker *string - // A flag that indicates whether there are more items to return. If your results // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than @@ -110,6 +106,10 @@ type ListGroupPoliciesOutput struct { // all your results. IsTruncated *bool + // When IsTruncated is true, this element is present and contains the value to use + // for the Marker parameter in a subsequent pagination request. + Marker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iam/api_op_ListGroups.go b/service/iam/api_op_ListGroups.go index e444a6b0668..1e8eefda6d1 100644 --- a/service/iam/api_op_ListGroups.go +++ b/service/iam/api_op_ListGroups.go @@ -57,6 +57,12 @@ func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns type ListGroupsInput struct { + // Use this parameter only when paginating results and only after you receive a + // response indicating that the results are truncated. Set it to the value of the + // Marker element in the response that you received to indicate where the next call + // should start. + Marker *string + // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you // specify, the IsTruncated response element is true. If you do not include this @@ -76,20 +82,15 @@ type ListGroupsInput struct { // character from the ! (\u0021) through the DEL character (\u007F), including most // punctuation characters, digits, and upper and lowercased letters. PathPrefix *string - - // Use this parameter only when paginating results and only after you receive a - // response indicating that the results are truncated. Set it to the value of the - // Marker element in the response that you received to indicate where the next call - // should start. - Marker *string } // Contains the response to a successful ListGroups () request. type ListGroupsOutput struct { - // When IsTruncated is true, this element is present and contains the value to use - // for the Marker parameter in a subsequent pagination request. - Marker *string + // A list of groups. + // + // This member is required. + Groups []*types.Group // A flag that indicates whether there are more items to return. If your results // were truncated, you can make a subsequent pagination request using the Marker @@ -99,10 +100,9 @@ type ListGroupsOutput struct { // all your results. IsTruncated *bool - // A list of groups. - // - // This member is required. - Groups []*types.Group + // When IsTruncated is true, this element is present and contains the value to use + // for the Marker parameter in a subsequent pagination request. + Marker *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/iam/api_op_ListGroupsForUser.go b/service/iam/api_op_ListGroupsForUser.go index a5adb3a6d9a..47682ebc897 100644 --- a/service/iam/api_op_ListGroupsForUser.go +++ b/service/iam/api_op_ListGroupsForUser.go @@ -58,15 +58,6 @@ func (c *Client) ListGroupsForUser(ctx context.Context, params *ListGroupsForUse type ListGroupsForUserInput struct { - // Use this only when paginating results to indicate the maximum number of items - // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this - // parameter, the number of items defaults to 100. Note that IAM might return fewer - // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to - // include in the subsequent call that tells the service where to continue from. - MaxItems *int32 - // The name of the user to list groups for. This parameter allows (through its // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters // consisting of upper and lowercase alphanumeric characters with no spaces. You @@ -80,11 +71,25 @@ type ListGroupsForUserInput struct { // Marker element in the response that you received to indicate where the next call // should start. Marker *string + + // Use this only when paginating results to indicate the maximum number of items + // you want in the response. If additional items exist beyond the maximum you + // specify, the IsTruncated response element is true. If you do not include this + // parameter, the number of items defaults to 100. Note that IAM might return fewer + // results, even when there are more results available. In that case, the + // IsTruncated response element returns true, and Marker contains a value to + // include in the subsequent call that tells the service where to continue from. + MaxItems *int32 } // Contains the response to a successful ListGroupsForUser () request. type ListGroupsForUserOutput struct { + // A list of groups. + // + // This member is required. + Groups []*types.Group + // A flag that indicates whether there are more items to return. If your results // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than @@ -93,11 +98,6 @@ type ListGroupsForUserOutput struct { // all your results. IsTruncated *bool - // A list of groups. - // - // This member is required. - Groups []*types.Group - // When IsTruncated is true, this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string diff --git a/service/iam/api_op_ListInstanceProfiles.go b/service/iam/api_op_ListInstanceProfiles.go index 13c7271cec5..9cdbf0e46de 100644 --- a/service/iam/api_op_ListInstanceProfiles.go +++ b/service/iam/api_op_ListInstanceProfiles.go @@ -66,6 +66,15 @@ type ListInstanceProfilesInput struct { // should start. Marker *string + // Use this only when paginating results to indicate the maximum number of items + // you want in the response. If additional items exist beyond the maximum you + // specify, the IsTruncated response element is true. If you do not include this + // parameter, the number of items defaults to 100. Note that IAM might return fewer + // results, even when there are more results available. In that case, the + // IsTruncated response element returns true, and Marker contains a value to + // include in the subsequent call that tells the service where to continue from. + MaxItems *int32 + // The path prefix for filtering the results. For example, the prefix // /application_abc/component_xyz/ gets all instance profiles whose path starts // with /application_abc/component_xyz/. This parameter is optional. If it is not @@ -76,24 +85,11 @@ type ListInstanceProfilesInput struct { // any ASCII character from the ! (\u0021) through the DEL character (\u007F), // including most punctuation characters, digits, and upper and lowercased letters. PathPrefix *string - - // Use this only when paginating results to indicate the maximum number of items - // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this - // parameter, the number of items defaults to 100. Note that IAM might return fewer - // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to - // include in the subsequent call that tells the service where to continue from. - MaxItems *int32 } // Contains the response to a successful ListInstanceProfiles () request. type ListInstanceProfilesOutput struct { - // When IsTruncated is true, this element is present and contains the value to use - // for the Marker parameter in a subsequent pagination request. - Marker *string - // A list of instance profiles. // // This member is required. @@ -107,6 +103,10 @@ type ListInstanceProfilesOutput struct { // all your results. IsTruncated *bool + // When IsTruncated is true, this element is present and contains the value to use + // for the Marker parameter in a subsequent pagination request. + Marker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iam/api_op_ListInstanceProfilesForRole.go b/service/iam/api_op_ListInstanceProfilesForRole.go index f036fb0a229..a833a35af47 100644 --- a/service/iam/api_op_ListInstanceProfilesForRole.go +++ b/service/iam/api_op_ListInstanceProfilesForRole.go @@ -93,10 +93,6 @@ type ListInstanceProfilesForRoleOutput struct { // This member is required. InstanceProfiles []*types.InstanceProfile - // When IsTruncated is true, this element is present and contains the value to use - // for the Marker parameter in a subsequent pagination request. - Marker *string - // A flag that indicates whether there are more items to return. If your results // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than @@ -105,6 +101,10 @@ type ListInstanceProfilesForRoleOutput struct { // all your results. IsTruncated *bool + // When IsTruncated is true, this element is present and contains the value to use + // for the Marker parameter in a subsequent pagination request. + Marker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iam/api_op_ListMFADevices.go b/service/iam/api_op_ListMFADevices.go index dad2845979b..88ced1ebf9b 100644 --- a/service/iam/api_op_ListMFADevices.go +++ b/service/iam/api_op_ListMFADevices.go @@ -60,12 +60,6 @@ func (c *Client) ListMFADevices(ctx context.Context, params *ListMFADevicesInput type ListMFADevicesInput struct { - // The name of the user whose MFA devices you want to list. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no - // spaces. You can also include any of the following characters: _+=,.@- - UserName *string - // Use this parameter only when paginating results and only after you receive a // response indicating that the results are truncated. Set it to the value of the // Marker element in the response that you received to indicate where the next call @@ -80,6 +74,12 @@ type ListMFADevicesInput struct { // IsTruncated response element returns true, and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 + + // The name of the user whose MFA devices you want to list. This parameter allows + // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // characters consisting of upper and lowercase alphanumeric characters with no + // spaces. You can also include any of the following characters: _+=,.@- + UserName *string } // Contains the response to a successful ListMFADevices () request. @@ -90,10 +90,6 @@ type ListMFADevicesOutput struct { // This member is required. MFADevices []*types.MFADevice - // When IsTruncated is true, this element is present and contains the value to use - // for the Marker parameter in a subsequent pagination request. - Marker *string - // A flag that indicates whether there are more items to return. If your results // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than @@ -102,6 +98,10 @@ type ListMFADevicesOutput struct { // all your results. IsTruncated *bool + // When IsTruncated is true, this element is present and contains the value to use + // for the Marker parameter in a subsequent pagination request. + Marker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iam/api_op_ListPolicies.go b/service/iam/api_op_ListPolicies.go index 5f9da5f11d1..67556c685a0 100644 --- a/service/iam/api_op_ListPolicies.go +++ b/service/iam/api_op_ListPolicies.go @@ -65,6 +65,12 @@ func (c *Client) ListPolicies(ctx context.Context, params *ListPoliciesInput, op type ListPoliciesInput struct { + // Use this parameter only when paginating results and only after you receive a + // response indicating that the results are truncated. Set it to the value of the + // Marker element in the response that you received to indicate where the next call + // should start. + Marker *string + // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you // specify, the IsTruncated response element is true. If you do not include this @@ -74,18 +80,11 @@ type ListPoliciesInput struct { // include in the subsequent call that tells the service where to continue from. MaxItems *int32 - // Use this parameter only when paginating results and only after you receive a - // response indicating that the results are truncated. Set it to the value of the - // Marker element in the response that you received to indicate where the next call - // should start. - Marker *string - - // The policy usage method to use for filtering the results. To list only - // permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only - // the policies used to set permissions boundaries, set the value to - // PermissionsBoundary. This parameter is optional. If it is not included, all - // policies are returned. - PolicyUsageFilter types.PolicyUsageType + // A flag to filter the results to only the attached policies. When OnlyAttached is + // true, the returned list contains only the policies that are attached to an IAM + // user, group, or role. When OnlyAttached is false, or when the parameter is not + // included, all policies are returned. + OnlyAttached *bool // The path prefix for filtering the results. This parameter is optional. If it is // not included, it defaults to a slash (/), listing all policies. This parameter @@ -96,11 +95,12 @@ type ListPoliciesInput struct { // punctuation characters, digits, and upper and lowercased letters. PathPrefix *string - // A flag to filter the results to only the attached policies. When OnlyAttached is - // true, the returned list contains only the policies that are attached to an IAM - // user, group, or role. When OnlyAttached is false, or when the parameter is not - // included, all policies are returned. - OnlyAttached *bool + // The policy usage method to use for filtering the results. To list only + // permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only + // the policies used to set permissions boundaries, set the value to + // PermissionsBoundary. This parameter is optional. If it is not included, all + // policies are returned. + PolicyUsageFilter types.PolicyUsageType // The scope to use for filtering the results. To list only AWS managed policies, // set Scope to AWS. To list only the customer managed policies in your AWS @@ -112,10 +112,6 @@ type ListPoliciesInput struct { // Contains the response to a successful ListPolicies () request. type ListPoliciesOutput struct { - // When IsTruncated is true, this element is present and contains the value to use - // for the Marker parameter in a subsequent pagination request. - Marker *string - // A flag that indicates whether there are more items to return. If your results // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than @@ -124,6 +120,10 @@ type ListPoliciesOutput struct { // all your results. IsTruncated *bool + // When IsTruncated is true, this element is present and contains the value to use + // for the Marker parameter in a subsequent pagination request. + Marker *string + // A list of policies. Policies []*types.Policy diff --git a/service/iam/api_op_ListPolicyVersions.go b/service/iam/api_op_ListPolicyVersions.go index cf86d191275..422cce43989 100644 --- a/service/iam/api_op_ListPolicyVersions.go +++ b/service/iam/api_op_ListPolicyVersions.go @@ -61,6 +61,15 @@ func (c *Client) ListPolicyVersions(ctx context.Context, params *ListPolicyVersi type ListPolicyVersionsInput struct { + // The Amazon Resource Name (ARN) of the IAM policy for which you want the + // versions. For more information about ARNs, see Amazon Resource Names (ARNs) and + // AWS Service Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in + // the AWS General Reference. + // + // This member is required. + PolicyArn *string + // Use this parameter only when paginating results and only after you receive a // response indicating that the results are truncated. Set it to the value of the // Marker element in the response that you received to indicate where the next call @@ -75,15 +84,6 @@ type ListPolicyVersionsInput struct { // IsTruncated response element returns true, and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 - - // The Amazon Resource Name (ARN) of the IAM policy for which you want the - // versions. For more information about ARNs, see Amazon Resource Names (ARNs) and - // AWS Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference. - // - // This member is required. - PolicyArn *string } // Contains the response to a successful ListPolicyVersions () request. @@ -97,16 +97,16 @@ type ListPolicyVersionsOutput struct { // all your results. IsTruncated *bool + // When IsTruncated is true, this element is present and contains the value to use + // for the Marker parameter in a subsequent pagination request. + Marker *string + // A list of policy versions. For more information about managed policy versions, // see Versioning for Managed Policies // (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) // in the IAM User Guide. Versions []*types.PolicyVersion - // When IsTruncated is true, this element is present and contains the value to use - // for the Marker parameter in a subsequent pagination request. - Marker *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iam/api_op_ListRolePolicies.go b/service/iam/api_op_ListRolePolicies.go index e1ec986fe3e..e7d64ed288f 100644 --- a/service/iam/api_op_ListRolePolicies.go +++ b/service/iam/api_op_ListRolePolicies.go @@ -63,12 +63,6 @@ func (c *Client) ListRolePolicies(ctx context.Context, params *ListRolePoliciesI type ListRolePoliciesInput struct { - // Use this parameter only when paginating results and only after you receive a - // response indicating that the results are truncated. Set it to the value of the - // Marker element in the response that you received to indicate where the next call - // should start. - Marker *string - // The name of the role to list policies for. This parameter allows (through its // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters // consisting of upper and lowercase alphanumeric characters with no spaces. You @@ -77,6 +71,12 @@ type ListRolePoliciesInput struct { // This member is required. RoleName *string + // Use this parameter only when paginating results and only after you receive a + // response indicating that the results are truncated. Set it to the value of the + // Marker element in the response that you received to indicate where the next call + // should start. + Marker *string + // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you // specify, the IsTruncated response element is true. If you do not include this @@ -95,10 +95,6 @@ type ListRolePoliciesOutput struct { // This member is required. PolicyNames []*string - // When IsTruncated is true, this element is present and contains the value to use - // for the Marker parameter in a subsequent pagination request. - Marker *string - // A flag that indicates whether there are more items to return. If your results // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than @@ -107,6 +103,10 @@ type ListRolePoliciesOutput struct { // all your results. IsTruncated *bool + // When IsTruncated is true, this element is present and contains the value to use + // for the Marker parameter in a subsequent pagination request. + Marker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iam/api_op_ListRoleTags.go b/service/iam/api_op_ListRoleTags.go index f3616673b2e..f8d4e76727b 100644 --- a/service/iam/api_op_ListRoleTags.go +++ b/service/iam/api_op_ListRoleTags.go @@ -69,6 +69,12 @@ type ListRoleTagsInput struct { // This member is required. RoleName *string + // Use this parameter only when paginating results and only after you receive a + // response indicating that the results are truncated. Set it to the value of the + // Marker element in the response that you received to indicate where the next call + // should start. + Marker *string + // (Optional) Use this only when paginating results to indicate the maximum number // of items that you want in the response. If additional items exist beyond the // maximum that you specify, the IsTruncated response element is true. If you do @@ -77,16 +83,17 @@ type ListRoleTagsInput struct { // response element returns true, and Marker contains a value to include in the // subsequent call that tells the service where to continue from. MaxItems *int32 - - // Use this parameter only when paginating results and only after you receive a - // response indicating that the results are truncated. Set it to the value of the - // Marker element in the response that you received to indicate where the next call - // should start. - Marker *string } type ListRoleTagsOutput struct { + // The list of tags currently that is attached to the role. Each tag consists of a + // key name and an associated value. If no tags are attached to the specified role, + // the response contains an empty list. + // + // This member is required. + Tags []*types.Tag + // A flag that indicates whether there are more items to return. If your results // were truncated, you can use the Marker request parameter to make a subsequent // pagination request that retrieves more items. Note that IAM might return fewer @@ -98,13 +105,6 @@ type ListRoleTagsOutput struct { // for the Marker parameter in a subsequent pagination request. Marker *string - // The list of tags currently that is attached to the role. Each tag consists of a - // key name and an associated value. If no tags are attached to the specified role, - // the response contains an empty list. - // - // This member is required. - Tags []*types.Tag - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iam/api_op_ListRoles.go b/service/iam/api_op_ListRoles.go index 220f7abb4f2..991cb1983d2 100644 --- a/service/iam/api_op_ListRoles.go +++ b/service/iam/api_op_ListRoles.go @@ -60,6 +60,12 @@ func (c *Client) ListRoles(ctx context.Context, params *ListRolesInput, optFns . type ListRolesInput struct { + // Use this parameter only when paginating results and only after you receive a + // response indicating that the results are truncated. Set it to the value of the + // Marker element in the response that you received to indicate where the next call + // should start. + Marker *string + // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you // specify, the IsTruncated response element is true. If you do not include this @@ -79,20 +85,15 @@ type ListRolesInput struct { // character from the ! (\u0021) through the DEL character (\u007F), including most // punctuation characters, digits, and upper and lowercased letters. PathPrefix *string - - // Use this parameter only when paginating results and only after you receive a - // response indicating that the results are truncated. Set it to the value of the - // Marker element in the response that you received to indicate where the next call - // should start. - Marker *string } // Contains the response to a successful ListRoles () request. type ListRolesOutput struct { - // When IsTruncated is true, this element is present and contains the value to use - // for the Marker parameter in a subsequent pagination request. - Marker *string + // A list of roles. + // + // This member is required. + Roles []*types.Role // A flag that indicates whether there are more items to return. If your results // were truncated, you can make a subsequent pagination request using the Marker @@ -102,10 +103,9 @@ type ListRolesOutput struct { // all your results. IsTruncated *bool - // A list of roles. - // - // This member is required. - Roles []*types.Role + // When IsTruncated is true, this element is present and contains the value to use + // for the Marker parameter in a subsequent pagination request. + Marker *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/iam/api_op_ListSSHPublicKeys.go b/service/iam/api_op_ListSSHPublicKeys.go index f67fb5154ce..643a311b64b 100644 --- a/service/iam/api_op_ListSSHPublicKeys.go +++ b/service/iam/api_op_ListSSHPublicKeys.go @@ -65,6 +65,12 @@ func (c *Client) ListSSHPublicKeys(ctx context.Context, params *ListSSHPublicKey type ListSSHPublicKeysInput struct { + // Use this parameter only when paginating results and only after you receive a + // response indicating that the results are truncated. Set it to the value of the + // Marker element in the response that you received to indicate where the next call + // should start. + Marker *string + // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you // specify, the IsTruncated response element is true. If you do not include this @@ -74,12 +80,6 @@ type ListSSHPublicKeysInput struct { // include in the subsequent call that tells the service where to continue from. MaxItems *int32 - // Use this parameter only when paginating results and only after you receive a - // response indicating that the results are truncated. Set it to the value of the - // Marker element in the response that you received to indicate where the next call - // should start. - Marker *string - // The name of the IAM user to list SSH public keys for. If none is specified, the // UserName field is determined implicitly based on the AWS access key used to sign // the request. This parameter allows (through its regex pattern diff --git a/service/iam/api_op_ListServerCertificates.go b/service/iam/api_op_ListServerCertificates.go index 64128eab5a0..cba28a3aa45 100644 --- a/service/iam/api_op_ListServerCertificates.go +++ b/service/iam/api_op_ListServerCertificates.go @@ -68,6 +68,15 @@ type ListServerCertificatesInput struct { // should start. Marker *string + // Use this only when paginating results to indicate the maximum number of items + // you want in the response. If additional items exist beyond the maximum you + // specify, the IsTruncated response element is true. If you do not include this + // parameter, the number of items defaults to 100. Note that IAM might return fewer + // results, even when there are more results available. In that case, the + // IsTruncated response element returns true, and Marker contains a value to + // include in the subsequent call that tells the service where to continue from. + MaxItems *int32 + // The path prefix for filtering the results. For example: /company/servercerts // would get all server certificates for which the path starts with // /company/servercerts. This parameter is optional. If it is not included, it @@ -78,15 +87,6 @@ type ListServerCertificatesInput struct { // character from the ! (\u0021) through the DEL character (\u007F), including most // punctuation characters, digits, and upper and lowercased letters. PathPrefix *string - - // Use this only when paginating results to indicate the maximum number of items - // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this - // parameter, the number of items defaults to 100. Note that IAM might return fewer - // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to - // include in the subsequent call that tells the service where to continue from. - MaxItems *int32 } // Contains the response to a successful ListServerCertificates () request. diff --git a/service/iam/api_op_ListServiceSpecificCredentials.go b/service/iam/api_op_ListServiceSpecificCredentials.go index f63a19d1678..eb42a67f7a1 100644 --- a/service/iam/api_op_ListServiceSpecificCredentials.go +++ b/service/iam/api_op_ListServiceSpecificCredentials.go @@ -63,6 +63,10 @@ func (c *Client) ListServiceSpecificCredentials(ctx context.Context, params *Lis type ListServiceSpecificCredentialsInput struct { + // Filters the returned results to only those for the specified AWS service. If not + // specified, then AWS returns service-specific credentials for all services. + ServiceName *string + // The name of the user whose service-specific credentials you want information // about. If this value is not specified, then the operation assumes the user whose // credentials are used to call the operation. This parameter allows (through its @@ -70,10 +74,6 @@ type ListServiceSpecificCredentialsInput struct { // consisting of upper and lowercase alphanumeric characters with no spaces. You // can also include any of the following characters: _+=,.@- UserName *string - - // Filters the returned results to only those for the specified AWS service. If not - // specified, then AWS returns service-specific credentials for all services. - ServiceName *string } type ListServiceSpecificCredentialsOutput struct { diff --git a/service/iam/api_op_ListSigningCertificates.go b/service/iam/api_op_ListSigningCertificates.go index fe95ed22a29..25b6072b8af 100644 --- a/service/iam/api_op_ListSigningCertificates.go +++ b/service/iam/api_op_ListSigningCertificates.go @@ -64,11 +64,11 @@ func (c *Client) ListSigningCertificates(ctx context.Context, params *ListSignin type ListSigningCertificatesInput struct { - // The name of the IAM user whose signing certificates you want to examine. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of upper and lowercase alphanumeric characters - // with no spaces. You can also include any of the following characters: _+=,.@- - UserName *string + // Use this parameter only when paginating results and only after you receive a + // response indicating that the results are truncated. Set it to the value of the + // Marker element in the response that you received to indicate where the next call + // should start. + Marker *string // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you @@ -79,20 +79,16 @@ type ListSigningCertificatesInput struct { // include in the subsequent call that tells the service where to continue from. MaxItems *int32 - // Use this parameter only when paginating results and only after you receive a - // response indicating that the results are truncated. Set it to the value of the - // Marker element in the response that you received to indicate where the next call - // should start. - Marker *string + // The name of the IAM user whose signing certificates you want to examine. This + // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a + // string of characters consisting of upper and lowercase alphanumeric characters + // with no spaces. You can also include any of the following characters: _+=,.@- + UserName *string } // Contains the response to a successful ListSigningCertificates () request. type ListSigningCertificatesOutput struct { - // When IsTruncated is true, this element is present and contains the value to use - // for the Marker parameter in a subsequent pagination request. - Marker *string - // A list of the user's signing certificate information. // // This member is required. @@ -106,6 +102,10 @@ type ListSigningCertificatesOutput struct { // all your results. IsTruncated *bool + // When IsTruncated is true, this element is present and contains the value to use + // for the Marker parameter in a subsequent pagination request. + Marker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iam/api_op_ListUserPolicies.go b/service/iam/api_op_ListUserPolicies.go index 9f751bce1d9..06ded7c932a 100644 --- a/service/iam/api_op_ListUserPolicies.go +++ b/service/iam/api_op_ListUserPolicies.go @@ -71,6 +71,12 @@ type ListUserPoliciesInput struct { // This member is required. UserName *string + // Use this parameter only when paginating results and only after you receive a + // response indicating that the results are truncated. Set it to the value of the + // Marker element in the response that you received to indicate where the next call + // should start. + Marker *string + // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you // specify, the IsTruncated response element is true. If you do not include this @@ -79,12 +85,6 @@ type ListUserPoliciesInput struct { // IsTruncated response element returns true, and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 - - // Use this parameter only when paginating results and only after you receive a - // response indicating that the results are truncated. Set it to the value of the - // Marker element in the response that you received to indicate where the next call - // should start. - Marker *string } // Contains the response to a successful ListUserPolicies () request. diff --git a/service/iam/api_op_ListUserTags.go b/service/iam/api_op_ListUserTags.go index d35a220e196..ca5db55ff43 100644 --- a/service/iam/api_op_ListUserTags.go +++ b/service/iam/api_op_ListUserTags.go @@ -60,15 +60,6 @@ func (c *Client) ListUserTags(ctx context.Context, params *ListUserTagsInput, op type ListUserTagsInput struct { - // (Optional) Use this only when paginating results to indicate the maximum number - // of items that you want in the response. If additional items exist beyond the - // maximum that you specify, the IsTruncated response element is true. If you do - // not include this parameter, it defaults to 100. Note that IAM might return fewer - // results, even when more results are available. In that case, the IsTruncated - // response element returns true, and Marker contains a value to include in the - // subsequent call that tells the service where to continue from. - MaxItems *int32 - // The name of the IAM user whose tags you want to see. This parameter accepts // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of // characters that consist of upper and lowercase alphanumeric characters with no @@ -82,6 +73,15 @@ type ListUserTagsInput struct { // Marker element in the response that you received to indicate where the next call // should start. Marker *string + + // (Optional) Use this only when paginating results to indicate the maximum number + // of items that you want in the response. If additional items exist beyond the + // maximum that you specify, the IsTruncated response element is true. If you do + // not include this parameter, it defaults to 100. Note that IAM might return fewer + // results, even when more results are available. In that case, the IsTruncated + // response element returns true, and Marker contains a value to include in the + // subsequent call that tells the service where to continue from. + MaxItems *int32 } type ListUserTagsOutput struct { diff --git a/service/iam/api_op_ListUsers.go b/service/iam/api_op_ListUsers.go index a6c13cee8fa..036792e71bf 100644 --- a/service/iam/api_op_ListUsers.go +++ b/service/iam/api_op_ListUsers.go @@ -59,6 +59,12 @@ func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns . type ListUsersInput struct { + // Use this parameter only when paginating results and only after you receive a + // response indicating that the results are truncated. Set it to the value of the + // Marker element in the response that you received to indicate where the next call + // should start. + Marker *string + // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you // specify, the IsTruncated response element is true. If you do not include this @@ -68,12 +74,6 @@ type ListUsersInput struct { // include in the subsequent call that tells the service where to continue from. MaxItems *int32 - // Use this parameter only when paginating results and only after you receive a - // response indicating that the results are truncated. Set it to the value of the - // Marker element in the response that you received to indicate where the next call - // should start. - Marker *string - // The path prefix for filtering the results. For example: // /division_abc/subdivision_xyz/, which would get all user names whose path starts // with /division_abc/subdivision_xyz/. This parameter is optional. If it is not @@ -94,10 +94,6 @@ type ListUsersOutput struct { // This member is required. Users []*types.User - // When IsTruncated is true, this element is present and contains the value to use - // for the Marker parameter in a subsequent pagination request. - Marker *string - // A flag that indicates whether there are more items to return. If your results // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than @@ -106,6 +102,10 @@ type ListUsersOutput struct { // all your results. IsTruncated *bool + // When IsTruncated is true, this element is present and contains the value to use + // for the Marker parameter in a subsequent pagination request. + Marker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iam/api_op_ListVirtualMFADevices.go b/service/iam/api_op_ListVirtualMFADevices.go index 44fd87f9d22..771aa13a5ff 100644 --- a/service/iam/api_op_ListVirtualMFADevices.go +++ b/service/iam/api_op_ListVirtualMFADevices.go @@ -64,6 +64,12 @@ type ListVirtualMFADevicesInput struct { // assigned and unassigned virtual MFA devices., AssignmentStatus types.AssignmentStatusType + // Use this parameter only when paginating results and only after you receive a + // response indicating that the results are truncated. Set it to the value of the + // Marker element in the response that you received to indicate where the next call + // should start. + Marker *string + // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you // specify, the IsTruncated response element is true. If you do not include this @@ -72,17 +78,17 @@ type ListVirtualMFADevicesInput struct { // IsTruncated response element returns true, and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 - - // Use this parameter only when paginating results and only after you receive a - // response indicating that the results are truncated. Set it to the value of the - // Marker element in the response that you received to indicate where the next call - // should start. - Marker *string } // Contains the response to a successful ListVirtualMFADevices () request. type ListVirtualMFADevicesOutput struct { + // The list of virtual MFA devices in the current account that match the + // AssignmentStatus value that was passed in the request. + // + // This member is required. + VirtualMFADevices []*types.VirtualMFADevice + // A flag that indicates whether there are more items to return. If your results // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than @@ -91,12 +97,6 @@ type ListVirtualMFADevicesOutput struct { // all your results. IsTruncated *bool - // The list of virtual MFA devices in the current account that match the - // AssignmentStatus value that was passed in the request. - // - // This member is required. - VirtualMFADevices []*types.VirtualMFADevice - // When IsTruncated is true, this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string diff --git a/service/iam/api_op_PutGroupPolicy.go b/service/iam/api_op_PutGroupPolicy.go index 3f1691b99bc..c03ee99444e 100644 --- a/service/iam/api_op_PutGroupPolicy.go +++ b/service/iam/api_op_PutGroupPolicy.go @@ -69,14 +69,6 @@ func (c *Client) PutGroupPolicy(ctx context.Context, params *PutGroupPolicyInput type PutGroupPolicyInput struct { - // The name of the policy document. This parameter allows (through its regex - // pattern (http://wikipedia.org/wiki/regex)) a string of characters consisting of - // upper and lowercase alphanumeric characters with no spaces. You can also include - // any of the following characters: _+=,.@- - // - // This member is required. - PolicyName *string - // The name of the group to associate the policy with. This parameter allows // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of // characters consisting of upper and lowercase alphanumeric characters with no @@ -104,6 +96,14 @@ type PutGroupPolicyInput struct { // // This member is required. PolicyDocument *string + + // The name of the policy document. This parameter allows (through its regex + // pattern (http://wikipedia.org/wiki/regex)) a string of characters consisting of + // upper and lowercase alphanumeric characters with no spaces. You can also include + // any of the following characters: _+=,.@- + // + // This member is required. + PolicyName *string } type PutGroupPolicyOutput struct { diff --git a/service/iam/api_op_PutRolePolicy.go b/service/iam/api_op_PutRolePolicy.go index dfb80e19fee..a953a444099 100644 --- a/service/iam/api_op_PutRolePolicy.go +++ b/service/iam/api_op_PutRolePolicy.go @@ -74,22 +74,6 @@ func (c *Client) PutRolePolicy(ctx context.Context, params *PutRolePolicyInput, type PutRolePolicyInput struct { - // The name of the policy document. This parameter allows (through its regex - // pattern (http://wikipedia.org/wiki/regex)) a string of characters consisting of - // upper and lowercase alphanumeric characters with no spaces. You can also include - // any of the following characters: _+=,.@- - // - // This member is required. - PolicyName *string - - // The name of the role to associate the policy with. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no - // spaces. You can also include any of the following characters: _+=,.@- - // - // This member is required. - RoleName *string - // The policy document. You must provide policies in JSON format in IAM. However, // for AWS CloudFormation templates formatted in YAML, you can provide the policy // in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON @@ -109,6 +93,22 @@ type PutRolePolicyInput struct { // // This member is required. PolicyDocument *string + + // The name of the policy document. This parameter allows (through its regex + // pattern (http://wikipedia.org/wiki/regex)) a string of characters consisting of + // upper and lowercase alphanumeric characters with no spaces. You can also include + // any of the following characters: _+=,.@- + // + // This member is required. + PolicyName *string + + // The name of the role to associate the policy with. This parameter allows + // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // characters consisting of upper and lowercase alphanumeric characters with no + // spaces. You can also include any of the following characters: _+=,.@- + // + // This member is required. + RoleName *string } type PutRolePolicyOutput struct { diff --git a/service/iam/api_op_PutUserPermissionsBoundary.go b/service/iam/api_op_PutUserPermissionsBoundary.go index b631271cbb6..cf502da2b32 100644 --- a/service/iam/api_op_PutUserPermissionsBoundary.go +++ b/service/iam/api_op_PutUserPermissionsBoundary.go @@ -65,16 +65,16 @@ func (c *Client) PutUserPermissionsBoundary(ctx context.Context, params *PutUser type PutUserPermissionsBoundaryInput struct { - // The name (friendly name, not ARN) of the IAM user for which you want to set the - // permissions boundary. + // The ARN of the policy that is used to set the permissions boundary for the user. // // This member is required. - UserName *string + PermissionsBoundary *string - // The ARN of the policy that is used to set the permissions boundary for the user. + // The name (friendly name, not ARN) of the IAM user for which you want to set the + // permissions boundary. // // This member is required. - PermissionsBoundary *string + UserName *string } type PutUserPermissionsBoundaryOutput struct { diff --git a/service/iam/api_op_PutUserPolicy.go b/service/iam/api_op_PutUserPolicy.go index 5b45584c4df..f0e8b149483 100644 --- a/service/iam/api_op_PutUserPolicy.go +++ b/service/iam/api_op_PutUserPolicy.go @@ -69,22 +69,6 @@ func (c *Client) PutUserPolicy(ctx context.Context, params *PutUserPolicyInput, type PutUserPolicyInput struct { - // The name of the user to associate the policy with. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no - // spaces. You can also include any of the following characters: _+=,.@- - // - // This member is required. - UserName *string - - // The name of the policy document. This parameter allows (through its regex - // pattern (http://wikipedia.org/wiki/regex)) a string of characters consisting of - // upper and lowercase alphanumeric characters with no spaces. You can also include - // any of the following characters: _+=,.@- - // - // This member is required. - PolicyName *string - // The policy document. You must provide policies in JSON format in IAM. However, // for AWS CloudFormation templates formatted in YAML, you can provide the policy // in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON @@ -104,6 +88,22 @@ type PutUserPolicyInput struct { // // This member is required. PolicyDocument *string + + // The name of the policy document. This parameter allows (through its regex + // pattern (http://wikipedia.org/wiki/regex)) a string of characters consisting of + // upper and lowercase alphanumeric characters with no spaces. You can also include + // any of the following characters: _+=,.@- + // + // This member is required. + PolicyName *string + + // The name of the user to associate the policy with. This parameter allows + // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // characters consisting of upper and lowercase alphanumeric characters with no + // spaces. You can also include any of the following characters: _+=,.@- + // + // This member is required. + UserName *string } type PutUserPolicyOutput struct { diff --git a/service/iam/api_op_RemoveUserFromGroup.go b/service/iam/api_op_RemoveUserFromGroup.go index aafb5fb343a..0f5554d1152 100644 --- a/service/iam/api_op_RemoveUserFromGroup.go +++ b/service/iam/api_op_RemoveUserFromGroup.go @@ -56,14 +56,6 @@ func (c *Client) RemoveUserFromGroup(ctx context.Context, params *RemoveUserFrom type RemoveUserFromGroupInput struct { - // The name of the user to remove. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- - // - // This member is required. - UserName *string - // The name of the group to update. This parameter allows (through its regex // pattern (http://wikipedia.org/wiki/regex)) a string of characters consisting of // upper and lowercase alphanumeric characters with no spaces. You can also include @@ -71,6 +63,14 @@ type RemoveUserFromGroupInput struct { // // This member is required. GroupName *string + + // The name of the user to remove. This parameter allows (through its regex pattern + // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // This member is required. + UserName *string } type RemoveUserFromGroupOutput struct { diff --git a/service/iam/api_op_ResyncMFADevice.go b/service/iam/api_op_ResyncMFADevice.go index 45cd39d6817..af4ec905e68 100644 --- a/service/iam/api_op_ResyncMFADevice.go +++ b/service/iam/api_op_ResyncMFADevice.go @@ -60,13 +60,17 @@ func (c *Client) ResyncMFADevice(ctx context.Context, params *ResyncMFADeviceInp type ResyncMFADeviceInput struct { - // The name of the user whose MFA device you want to resynchronize. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no - // spaces. You can also include any of the following characters: _+=,.@- + // An authentication code emitted by the device. The format for this parameter is a + // sequence of six digits. // // This member is required. - UserName *string + AuthenticationCode1 *string + + // A subsequent authentication code emitted by the device. The format for this + // parameter is a sequence of six digits. + // + // This member is required. + AuthenticationCode2 *string // Serial number that uniquely identifies the MFA device. This parameter allows // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of @@ -76,17 +80,13 @@ type ResyncMFADeviceInput struct { // This member is required. SerialNumber *string - // An authentication code emitted by the device. The format for this parameter is a - // sequence of six digits. - // - // This member is required. - AuthenticationCode1 *string - - // A subsequent authentication code emitted by the device. The format for this - // parameter is a sequence of six digits. + // The name of the user whose MFA device you want to resynchronize. This parameter + // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // characters consisting of upper and lowercase alphanumeric characters with no + // spaces. You can also include any of the following characters: _+=,.@- // // This member is required. - AuthenticationCode2 *string + UserName *string } type ResyncMFADeviceOutput struct { diff --git a/service/iam/api_op_SimulateCustomPolicy.go b/service/iam/api_op_SimulateCustomPolicy.go index 58c59e25d1e..bc7db9ff9e6 100644 --- a/service/iam/api_op_SimulateCustomPolicy.go +++ b/service/iam/api_op_SimulateCustomPolicy.go @@ -68,11 +68,6 @@ func (c *Client) SimulateCustomPolicy(ctx context.Context, params *SimulateCusto type SimulateCustomPolicyInput struct { - // A list of context keys and corresponding values for the simulation to use. - // Whenever a context key is evaluated in one of the simulated IAM permissions - // policies, the corresponding value is supplied. - ContextEntries []*types.ContextEntry - // A list of names of API operations to evaluate in the simulation. Each operation // is evaluated against each resource. Each operation must include the service // identifier, such as iam:CreateUser. This operation does not support using @@ -81,81 +76,6 @@ type SimulateCustomPolicyInput struct { // This member is required. ActionNames []*string - // An ARN representing the AWS account ID that specifies the owner of any simulated - // resource that does not identify its owner in the resource ARN. Examples of - // resource ARNs include an S3 bucket or object. If ResourceOwner is specified, it - // is also used as the account owner of any ResourcePolicy included in the - // simulation. If the ResourceOwner parameter is not specified, then the owner of - // the resources and the resource policy defaults to the account of the identity - // provided in CallerArn. This parameter is required only if you specify a - // resource-based policy and account that owns the resource is different from the - // account that owns the simulated calling user CallerArn. The ARN for an account - // uses the following syntax: arn:aws:iam::AWS-account-ID:root. For example, to - // represent the account with the 112233445566 ID, use the following ARN: - // arn:aws:iam::112233445566-ID:root. - ResourceOwner *string - - // Specifies the type of simulation to run. Different API operations that support - // resource-based policies require different combinations of resources. By - // specifying the type of simulation to run, you enable the policy simulator to - // enforce the presence of the required resources to ensure reliable simulation - // results. If your simulation does not match one of the following scenarios, then - // you can omit this parameter. The following list shows each of the supported - // scenario values and the resources that you must define to run the simulation. - // Each of the EC2 scenarios requires that you specify instance, image, and - // security-group resources. If your scenario includes an EBS volume, then you must - // specify that volume as a resource. If the EC2 scenario includes VPC, then you - // must supply the network-interface resource. If it includes an IP subnet, then - // you must specify the subnet resource. For more information on the EC2 scenario - // options, see Supported Platforms - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html) - // in the Amazon EC2 User Guide. - // - // * EC2-Classic-InstanceStore instance, image, - // security-group - // - // * EC2-Classic-EBS instance, image, security-group, volume - // - // - // * EC2-VPC-InstanceStore instance, image, security-group, network-interface - // - // - // * EC2-VPC-InstanceStore-Subnet instance, image, security-group, - // network-interface, subnet - // - // * EC2-VPC-EBS instance, image, security-group, - // network-interface, volume - // - // * EC2-VPC-EBS-Subnet instance, image, - // security-group, network-interface, subnet, volume - ResourceHandlingOption *string - - // Use this only when paginating results to indicate the maximum number of items - // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this - // parameter, the number of items defaults to 100. Note that IAM might return fewer - // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to - // include in the subsequent call that tells the service where to continue from. - MaxItems *int32 - - // A resource-based policy to include in the simulation provided as a string. Each - // resource in the simulation is treated as if it had this policy attached. You can - // include only one resource-based policy in a simulation. The regex pattern - // (http://wikipedia.org/wiki/regex) used to validate this parameter is a string of - // characters consisting of the following: - // - // * Any printable ASCII character - // ranging from the space character (\u0020) through the end of the ASCII character - // range - // - // * The printable characters in the Basic Latin and Latin-1 Supplement - // character set (through \u00FF) - // - // * The special characters tab (\u0009), line - // feed (\u000A), and carriage return (\u000D) - ResourcePolicy *string - // A list of policy documents to include in the simulation. Each document is // specified as a string containing the complete, valid JSON text of an IAM policy. // Do not include any resource-based policies in this parameter. Any resource-based @@ -183,12 +103,6 @@ type SimulateCustomPolicyInput struct { // This member is required. PolicyInputList []*string - // Use this parameter only when paginating results and only after you receive a - // response indicating that the results are truncated. Set it to the value of the - // Marker element in the response that you received to indicate where the next call - // should start. - Marker *string - // The ARN of the IAM user that you want to use as the simulated caller of the API // operations. CallerArn is required if you include a ResourcePolicy so that the // policy's Principal element has a value to use in evaluating the policy. You can @@ -196,20 +110,25 @@ type SimulateCustomPolicyInput struct { // role, federated user, or a service principal. CallerArn *string - // A list of ARNs of AWS resources to include in the simulation. If this parameter - // is not provided, then the value defaults to * (all resources). Each API in the - // ActionNames parameter is evaluated for each resource in this list. The - // simulation determines the access result (allowed or denied) of each combination - // and reports it in the response. The simulation does not automatically retrieve - // policies for the specified resources. If you want to include a resource policy - // in the simulation, then you must include the policy as a string in the - // ResourcePolicy parameter. If you include a ResourcePolicy, then it must be - // applicable to all of the resources included in the simulation or you receive an - // invalid input error. For more information about ARNs, see Amazon Resource Names - // (ARNs) and AWS Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference. - ResourceArns []*string + // A list of context keys and corresponding values for the simulation to use. + // Whenever a context key is evaluated in one of the simulated IAM permissions + // policies, the corresponding value is supplied. + ContextEntries []*types.ContextEntry + + // Use this parameter only when paginating results and only after you receive a + // response indicating that the results are truncated. Set it to the value of the + // Marker element in the response that you received to indicate where the next call + // should start. + Marker *string + + // Use this only when paginating results to indicate the maximum number of items + // you want in the response. If additional items exist beyond the maximum you + // specify, the IsTruncated response element is true. If you do not include this + // parameter, the number of items defaults to 100. Note that IAM might return fewer + // results, even when there are more results available. In that case, the + // IsTruncated response element returns true, and Marker contains a value to + // include in the subsequent call that tells the service where to continue from. + MaxItems *int32 // The IAM permissions boundary policy to simulate. The permissions boundary sets // the maximum permissions that an IAM entity can have. You can input only one @@ -232,12 +151,96 @@ type SimulateCustomPolicyInput struct { // * The special characters tab // (\u0009), line feed (\u000A), and carriage return (\u000D) PermissionsBoundaryPolicyInputList []*string + + // A list of ARNs of AWS resources to include in the simulation. If this parameter + // is not provided, then the value defaults to * (all resources). Each API in the + // ActionNames parameter is evaluated for each resource in this list. The + // simulation determines the access result (allowed or denied) of each combination + // and reports it in the response. The simulation does not automatically retrieve + // policies for the specified resources. If you want to include a resource policy + // in the simulation, then you must include the policy as a string in the + // ResourcePolicy parameter. If you include a ResourcePolicy, then it must be + // applicable to all of the resources included in the simulation or you receive an + // invalid input error. For more information about ARNs, see Amazon Resource Names + // (ARNs) and AWS Service Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in + // the AWS General Reference. + ResourceArns []*string + + // Specifies the type of simulation to run. Different API operations that support + // resource-based policies require different combinations of resources. By + // specifying the type of simulation to run, you enable the policy simulator to + // enforce the presence of the required resources to ensure reliable simulation + // results. If your simulation does not match one of the following scenarios, then + // you can omit this parameter. The following list shows each of the supported + // scenario values and the resources that you must define to run the simulation. + // Each of the EC2 scenarios requires that you specify instance, image, and + // security-group resources. If your scenario includes an EBS volume, then you must + // specify that volume as a resource. If the EC2 scenario includes VPC, then you + // must supply the network-interface resource. If it includes an IP subnet, then + // you must specify the subnet resource. For more information on the EC2 scenario + // options, see Supported Platforms + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html) + // in the Amazon EC2 User Guide. + // + // * EC2-Classic-InstanceStore instance, image, + // security-group + // + // * EC2-Classic-EBS instance, image, security-group, volume + // + // + // * EC2-VPC-InstanceStore instance, image, security-group, network-interface + // + // + // * EC2-VPC-InstanceStore-Subnet instance, image, security-group, + // network-interface, subnet + // + // * EC2-VPC-EBS instance, image, security-group, + // network-interface, volume + // + // * EC2-VPC-EBS-Subnet instance, image, + // security-group, network-interface, subnet, volume + ResourceHandlingOption *string + + // An ARN representing the AWS account ID that specifies the owner of any simulated + // resource that does not identify its owner in the resource ARN. Examples of + // resource ARNs include an S3 bucket or object. If ResourceOwner is specified, it + // is also used as the account owner of any ResourcePolicy included in the + // simulation. If the ResourceOwner parameter is not specified, then the owner of + // the resources and the resource policy defaults to the account of the identity + // provided in CallerArn. This parameter is required only if you specify a + // resource-based policy and account that owns the resource is different from the + // account that owns the simulated calling user CallerArn. The ARN for an account + // uses the following syntax: arn:aws:iam::AWS-account-ID:root. For example, to + // represent the account with the 112233445566 ID, use the following ARN: + // arn:aws:iam::112233445566-ID:root. + ResourceOwner *string + + // A resource-based policy to include in the simulation provided as a string. Each + // resource in the simulation is treated as if it had this policy attached. You can + // include only one resource-based policy in a simulation. The regex pattern + // (http://wikipedia.org/wiki/regex) used to validate this parameter is a string of + // characters consisting of the following: + // + // * Any printable ASCII character + // ranging from the space character (\u0020) through the end of the ASCII character + // range + // + // * The printable characters in the Basic Latin and Latin-1 Supplement + // character set (through \u00FF) + // + // * The special characters tab (\u0009), line + // feed (\u000A), and carriage return (\u000D) + ResourcePolicy *string } // Contains the response to a successful SimulatePrincipalPolicy () or // SimulateCustomPolicy () request. type SimulateCustomPolicyOutput struct { + // The results of the simulation. + EvaluationResults []*types.EvaluationResult + // A flag that indicates whether there are more items to return. If your results // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than @@ -250,9 +253,6 @@ type SimulateCustomPolicyOutput struct { // for the Marker parameter in a subsequent pagination request. Marker *string - // The results of the simulation. - EvaluationResults []*types.EvaluationResult - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iam/api_op_SimulatePrincipalPolicy.go b/service/iam/api_op_SimulatePrincipalPolicy.go index 6f7e0e7363e..e20a0cb6e3f 100644 --- a/service/iam/api_op_SimulatePrincipalPolicy.go +++ b/service/iam/api_op_SimulatePrincipalPolicy.go @@ -76,11 +76,62 @@ func (c *Client) SimulatePrincipalPolicy(ctx context.Context, params *SimulatePr type SimulatePrincipalPolicyInput struct { + // A list of names of API operations to evaluate in the simulation. Each operation + // is evaluated for each resource. Each operation must include the service + // identifier, such as iam:CreateUser. + // + // This member is required. + ActionNames []*string + + // The Amazon Resource Name (ARN) of a user, group, or role whose policies you want + // to include in the simulation. If you specify a user, group, or role, the + // simulation includes all policies that are associated with that entity. If you + // specify a user, the simulation also includes all policies that are attached to + // any groups the user belongs to. For more information about ARNs, see Amazon + // Resource Names (ARNs) and AWS Service Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in + // the AWS General Reference. + // + // This member is required. + PolicySourceArn *string + + // The ARN of the IAM user that you want to specify as the simulated caller of the + // API operations. If you do not specify a CallerArn, it defaults to the ARN of the + // user that you specify in PolicySourceArn, if you specified a user. If you + // include both a PolicySourceArn (for example, + // arn:aws:iam::123456789012:user/David) and a CallerArn (for example, + // arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the + // API operations as Bob, as if Bob had David's policies. You can specify only the + // ARN of an IAM user. You cannot specify the ARN of an assumed role, federated + // user, or a service principal. CallerArn is required if you include a + // ResourcePolicy and the PolicySourceArn is not the ARN for an IAM user. This is + // required so that the resource-based policy's Principal element has a value to + // use in evaluating the policy. For more information about ARNs, see Amazon + // Resource Names (ARNs) and AWS Service Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in + // the AWS General Reference. + CallerArn *string + // A list of context keys and corresponding values for the simulation to use. // Whenever a context key is evaluated in one of the simulated IAM permissions // policies, the corresponding value is supplied. ContextEntries []*types.ContextEntry + // Use this parameter only when paginating results and only after you receive a + // response indicating that the results are truncated. Set it to the value of the + // Marker element in the response that you received to indicate where the next call + // should start. + Marker *string + + // Use this only when paginating results to indicate the maximum number of items + // you want in the response. If additional items exist beyond the maximum you + // specify, the IsTruncated response element is true. If you do not include this + // parameter, the number of items defaults to 100. Note that IAM might return fewer + // results, even when there are more results available. In that case, the + // IsTruncated response element returns true, and Marker contains a value to + // include in the subsequent call that tells the service where to continue from. + MaxItems *int32 + // The IAM permissions boundary policy to simulate. The permissions boundary sets // the maximum permissions that the entity can have. You can input only one // permissions boundary when you pass a policy to this operation. An IAM entity can @@ -106,6 +157,23 @@ type SimulatePrincipalPolicyInput struct { // feed (\u000A), and carriage return (\u000D) PermissionsBoundaryPolicyInputList []*string + // An optional list of additional policy documents to include in the simulation. + // Each document is specified as a string containing the complete, valid JSON text + // of an IAM policy. The regex pattern (http://wikipedia.org/wiki/regex) used to + // validate this parameter is a string of characters consisting of the following: + // + // + // * Any printable ASCII character ranging from the space character (\u0020) + // through the end of the ASCII character range + // + // * The printable characters in + // the Basic Latin and Latin-1 Supplement character set (through \u00FF) + // + // * The + // special characters tab (\u0009), line feed (\u000A), and carriage return + // (\u000D) + PolicyInputList []*string + // A list of ARNs of AWS resources to include in the simulation. If this parameter // is not provided, then the value defaults to * (all resources). Each API in the // ActionNames parameter is evaluated for each resource in this list. The @@ -119,67 +187,6 @@ type SimulatePrincipalPolicyInput struct { // the AWS General Reference. ResourceArns []*string - // The ARN of the IAM user that you want to specify as the simulated caller of the - // API operations. If you do not specify a CallerArn, it defaults to the ARN of the - // user that you specify in PolicySourceArn, if you specified a user. If you - // include both a PolicySourceArn (for example, - // arn:aws:iam::123456789012:user/David) and a CallerArn (for example, - // arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the - // API operations as Bob, as if Bob had David's policies. You can specify only the - // ARN of an IAM user. You cannot specify the ARN of an assumed role, federated - // user, or a service principal. CallerArn is required if you include a - // ResourcePolicy and the PolicySourceArn is not the ARN for an IAM user. This is - // required so that the resource-based policy's Principal element has a value to - // use in evaluating the policy. For more information about ARNs, see Amazon - // Resource Names (ARNs) and AWS Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference. - CallerArn *string - - // A resource-based policy to include in the simulation provided as a string. Each - // resource in the simulation is treated as if it had this policy attached. You can - // include only one resource-based policy in a simulation. The regex pattern - // (http://wikipedia.org/wiki/regex) used to validate this parameter is a string of - // characters consisting of the following: - // - // * Any printable ASCII character - // ranging from the space character (\u0020) through the end of the ASCII character - // range - // - // * The printable characters in the Basic Latin and Latin-1 Supplement - // character set (through \u00FF) - // - // * The special characters tab (\u0009), line - // feed (\u000A), and carriage return (\u000D) - ResourcePolicy *string - - // The Amazon Resource Name (ARN) of a user, group, or role whose policies you want - // to include in the simulation. If you specify a user, group, or role, the - // simulation includes all policies that are associated with that entity. If you - // specify a user, the simulation also includes all policies that are attached to - // any groups the user belongs to. For more information about ARNs, see Amazon - // Resource Names (ARNs) and AWS Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference. - // - // This member is required. - PolicySourceArn *string - - // Use this only when paginating results to indicate the maximum number of items - // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this - // parameter, the number of items defaults to 100. Note that IAM might return fewer - // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to - // include in the subsequent call that tells the service where to continue from. - MaxItems *int32 - - // Use this parameter only when paginating results and only after you receive a - // response indicating that the results are truncated. Set it to the value of the - // Marker element in the response that you received to indicate where the next call - // should start. - Marker *string - // Specifies the type of simulation to run. Different API operations that support // resource-based policies require different combinations of resources. By // specifying the type of simulation to run, you enable the policy simulator to @@ -215,30 +222,6 @@ type SimulatePrincipalPolicyInput struct { // network interface, subnet, volume ResourceHandlingOption *string - // A list of names of API operations to evaluate in the simulation. Each operation - // is evaluated for each resource. Each operation must include the service - // identifier, such as iam:CreateUser. - // - // This member is required. - ActionNames []*string - - // An optional list of additional policy documents to include in the simulation. - // Each document is specified as a string containing the complete, valid JSON text - // of an IAM policy. The regex pattern (http://wikipedia.org/wiki/regex) used to - // validate this parameter is a string of characters consisting of the following: - // - // - // * Any printable ASCII character ranging from the space character (\u0020) - // through the end of the ASCII character range - // - // * The printable characters in - // the Basic Latin and Latin-1 Supplement character set (through \u00FF) - // - // * The - // special characters tab (\u0009), line feed (\u000A), and carriage return - // (\u000D) - PolicyInputList []*string - // An AWS account ID that specifies the owner of any simulated resource that does // not identify its owner in the resource ARN. Examples of resource ARNs include an // S3 bucket or object. If ResourceOwner is specified, it is also used as the @@ -249,12 +232,32 @@ type SimulatePrincipalPolicyInput struct { // policy and account that owns the resource is different from the account that // owns the simulated calling user CallerArn. ResourceOwner *string + + // A resource-based policy to include in the simulation provided as a string. Each + // resource in the simulation is treated as if it had this policy attached. You can + // include only one resource-based policy in a simulation. The regex pattern + // (http://wikipedia.org/wiki/regex) used to validate this parameter is a string of + // characters consisting of the following: + // + // * Any printable ASCII character + // ranging from the space character (\u0020) through the end of the ASCII character + // range + // + // * The printable characters in the Basic Latin and Latin-1 Supplement + // character set (through \u00FF) + // + // * The special characters tab (\u0009), line + // feed (\u000A), and carriage return (\u000D) + ResourcePolicy *string } // Contains the response to a successful SimulatePrincipalPolicy () or // SimulateCustomPolicy () request. type SimulatePrincipalPolicyOutput struct { + // The results of the simulation. + EvaluationResults []*types.EvaluationResult + // A flag that indicates whether there are more items to return. If your results // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than @@ -267,9 +270,6 @@ type SimulatePrincipalPolicyOutput struct { // for the Marker parameter in a subsequent pagination request. Marker *string - // The results of the simulation. - EvaluationResults []*types.EvaluationResult - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iam/api_op_TagRole.go b/service/iam/api_op_TagRole.go index faf3d170005..d368495ef9e 100644 --- a/service/iam/api_op_TagRole.go +++ b/service/iam/api_op_TagRole.go @@ -92,12 +92,6 @@ func (c *Client) TagRole(ctx context.Context, params *TagRoleInput, optFns ...fu type TagRoleInput struct { - // The list of tags that you want to attach to the role. Each tag consists of a key - // name and an associated value. You can specify this with a JSON string. - // - // This member is required. - Tags []*types.Tag - // The name of the role that you want to add tags to. This parameter accepts // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of // characters that consist of upper and lowercase alphanumeric characters with no @@ -105,6 +99,12 @@ type TagRoleInput struct { // // This member is required. RoleName *string + + // The list of tags that you want to attach to the role. Each tag consists of a key + // name and an associated value. You can specify this with a JSON string. + // + // This member is required. + Tags []*types.Tag } type TagRoleOutput struct { diff --git a/service/iam/api_op_UntagUser.go b/service/iam/api_op_UntagUser.go index 616530f897e..e56ab634a0b 100644 --- a/service/iam/api_op_UntagUser.go +++ b/service/iam/api_op_UntagUser.go @@ -59,6 +59,12 @@ func (c *Client) UntagUser(ctx context.Context, params *UntagUserInput, optFns . type UntagUserInput struct { + // A list of key names as a simple array of strings. The tags with matching keys + // are removed from the specified user. + // + // This member is required. + TagKeys []*string + // The name of the IAM user from which you want to remove tags. This parameter // accepts (through its regex pattern (http://wikipedia.org/wiki/regex)) a string // of characters that consist of upper and lowercase alphanumeric characters with @@ -66,12 +72,6 @@ type UntagUserInput struct { // // This member is required. UserName *string - - // A list of key names as a simple array of strings. The tags with matching keys - // are removed from the specified user. - // - // This member is required. - TagKeys []*string } type UntagUserOutput struct { diff --git a/service/iam/api_op_UpdateAccessKey.go b/service/iam/api_op_UpdateAccessKey.go index 1895d5bc1e1..ad53eb0118d 100644 --- a/service/iam/api_op_UpdateAccessKey.go +++ b/service/iam/api_op_UpdateAccessKey.go @@ -66,11 +66,12 @@ func (c *Client) UpdateAccessKey(ctx context.Context, params *UpdateAccessKeyInp type UpdateAccessKeyInput struct { - // The name of the user whose key you want to update. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no - // spaces. You can also include any of the following characters: _+=,.@- - UserName *string + // The access key ID of the secret access key you want to update. This parameter + // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // characters that can consist of any upper or lowercased letter or digit. + // + // This member is required. + AccessKeyId *string // The status you want to assign to the secret access key. Active means that the // key can be used for API calls to AWS, while Inactive means that the key cannot @@ -79,12 +80,11 @@ type UpdateAccessKeyInput struct { // This member is required. Status types.StatusType - // The access key ID of the secret access key you want to update. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters that can consist of any upper or lowercased letter or digit. - // - // This member is required. - AccessKeyId *string + // The name of the user whose key you want to update. This parameter allows + // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // characters consisting of upper and lowercase alphanumeric characters with no + // spaces. You can also include any of the following characters: _+=,.@- + UserName *string } type UpdateAccessKeyOutput struct { diff --git a/service/iam/api_op_UpdateAccountPasswordPolicy.go b/service/iam/api_op_UpdateAccountPasswordPolicy.go index bc17b0032d4..790ad844a5c 100644 --- a/service/iam/api_op_UpdateAccountPasswordPolicy.go +++ b/service/iam/api_op_UpdateAccountPasswordPolicy.go @@ -68,6 +68,15 @@ func (c *Client) UpdateAccountPasswordPolicy(ctx context.Context, params *Update type UpdateAccountPasswordPolicyInput struct { + // Allows all IAM users in your account to use the AWS Management Console to change + // their own passwords. For more information, see Letting IAM Users Change Their + // Own Passwords + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/HowToPwdIAMUser.html) in the + // IAM User Guide. If you do not specify a value for this parameter, then the + // operation uses the default value of false. The result is that IAM users in the + // account do not automatically have permissions to change their own password. + AllowUsersToChangePassword *bool + // Prevents IAM users from setting a new password after their password has expired. // The IAM user cannot be accessed until an administrator resets the password. If // you do not specify a value for this parameter, then the operation uses the @@ -75,24 +84,10 @@ type UpdateAccountPasswordPolicyInput struct { // after they expire and continue to sign in as the user. HardExpiry *bool - // Specifies whether IAM user passwords must contain at least one uppercase - // character from the ISO basic Latin alphabet (A to Z). If you do not specify a - // value for this parameter, then the operation uses the default value of false. - // The result is that passwords do not require at least one uppercase character. - RequireUppercaseCharacters *bool - - // Specifies whether IAM user passwords must contain at least one numeric character - // (0 to 9). If you do not specify a value for this parameter, then the operation - // uses the default value of false. The result is that passwords do not require at - // least one numeric character. - RequireNumbers *bool - - // Specifies whether IAM user passwords must contain at least one of the following - // non-alphanumeric characters: ! @ # $ % ^ & * ( ) _ + - = [ ] { } | ' If you do - // not specify a value for this parameter, then the operation uses the default - // value of false. The result is that passwords do not require at least one symbol - // character. - RequireSymbols *bool + // The number of days that an IAM user password is valid. If you do not specify a + // value for this parameter, then the operation uses the default value of 0. The + // result is that IAM user passwords never expire. + MaxPasswordAge *int32 // The minimum number of characters allowed in an IAM user password. If you do not // specify a value for this parameter, then the operation uses the default value of @@ -105,25 +100,30 @@ type UpdateAccountPasswordPolicyInput struct { // reusing previous passwords. PasswordReusePrevention *int32 - // Allows all IAM users in your account to use the AWS Management Console to change - // their own passwords. For more information, see Letting IAM Users Change Their - // Own Passwords - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/HowToPwdIAMUser.html) in the - // IAM User Guide. If you do not specify a value for this parameter, then the - // operation uses the default value of false. The result is that IAM users in the - // account do not automatically have permissions to change their own password. - AllowUsersToChangePassword *bool - - // The number of days that an IAM user password is valid. If you do not specify a - // value for this parameter, then the operation uses the default value of 0. The - // result is that IAM user passwords never expire. - MaxPasswordAge *int32 - // Specifies whether IAM user passwords must contain at least one lowercase // character from the ISO basic Latin alphabet (a to z). If you do not specify a // value for this parameter, then the operation uses the default value of false. // The result is that passwords do not require at least one lowercase character. RequireLowercaseCharacters *bool + + // Specifies whether IAM user passwords must contain at least one numeric character + // (0 to 9). If you do not specify a value for this parameter, then the operation + // uses the default value of false. The result is that passwords do not require at + // least one numeric character. + RequireNumbers *bool + + // Specifies whether IAM user passwords must contain at least one of the following + // non-alphanumeric characters: ! @ # $ % ^ & * ( ) _ + - = [ ] { } | ' If you do + // not specify a value for this parameter, then the operation uses the default + // value of false. The result is that passwords do not require at least one symbol + // character. + RequireSymbols *bool + + // Specifies whether IAM user passwords must contain at least one uppercase + // character from the ISO basic Latin alphabet (A to Z). If you do not specify a + // value for this parameter, then the operation uses the default value of false. + // The result is that passwords do not require at least one uppercase character. + RequireUppercaseCharacters *bool } type UpdateAccountPasswordPolicyOutput struct { diff --git a/service/iam/api_op_UpdateGroup.go b/service/iam/api_op_UpdateGroup.go index 51f9085aaea..9fa87d6803e 100644 --- a/service/iam/api_op_UpdateGroup.go +++ b/service/iam/api_op_UpdateGroup.go @@ -66,14 +66,6 @@ func (c *Client) UpdateGroup(ctx context.Context, params *UpdateGroupInput, optF type UpdateGroupInput struct { - // New path for the IAM group. Only include this if changing the group's path. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of either a forward slash (/) by itself or a - // string that must begin and end with forward slashes. In addition, it can contain - // any ASCII character from the ! (\u0021) through the DEL character (\u007F), - // including most punctuation characters, digits, and upper and lowercased letters. - NewPath *string - // Name of the IAM group to update. If you're changing the name of the group, this // is the original name. This parameter allows (through its regex pattern // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper @@ -88,6 +80,14 @@ type UpdateGroupInput struct { // not distinguished by case. For example, you cannot create resources named both // "MyResource" and "myresource". NewGroupName *string + + // New path for the IAM group. Only include this if changing the group's path. This + // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a + // string of characters consisting of either a forward slash (/) by itself or a + // string that must begin and end with forward slashes. In addition, it can contain + // any ASCII character from the ! (\u0021) through the DEL character (\u007F), + // including most punctuation characters, digits, and upper and lowercased letters. + NewPath *string } type UpdateGroupOutput struct { diff --git a/service/iam/api_op_UpdateLoginProfile.go b/service/iam/api_op_UpdateLoginProfile.go index 2cd6f347a17..a4f79a722ab 100644 --- a/service/iam/api_op_UpdateLoginProfile.go +++ b/service/iam/api_op_UpdateLoginProfile.go @@ -60,6 +60,14 @@ func (c *Client) UpdateLoginProfile(ctx context.Context, params *UpdateLoginProf type UpdateLoginProfileInput struct { + // The name of the user whose password you want to update. This parameter allows + // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // characters consisting of upper and lowercase alphanumeric characters with no + // spaces. You can also include any of the following characters: _+=,.@- + // + // This member is required. + UserName *string + // The new password for the specified IAM user. The regex pattern // (http://wikipedia.org/wiki/regex) used to validate this parameter is a string of // characters consisting of the following: @@ -82,14 +90,6 @@ type UpdateLoginProfileInput struct { // Allows this new password to be used only once by requiring the specified IAM // user to set a new password on next sign-in. PasswordResetRequired *bool - - // The name of the user whose password you want to update. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no - // spaces. You can also include any of the following characters: _+=,.@- - // - // This member is required. - UserName *string } type UpdateLoginProfileOutput struct { diff --git a/service/iam/api_op_UpdateRole.go b/service/iam/api_op_UpdateRole.go index d250a21aa34..df5366f0005 100644 --- a/service/iam/api_op_UpdateRole.go +++ b/service/iam/api_op_UpdateRole.go @@ -56,6 +56,11 @@ func (c *Client) UpdateRole(ctx context.Context, params *UpdateRoleInput, optFns type UpdateRoleInput struct { + // The name of the role that you want to modify. + // + // This member is required. + RoleName *string + // The new description that you want to apply to the specified role. Description *string @@ -73,11 +78,6 @@ type UpdateRoleInput struct { // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the IAM // User Guide. MaxSessionDuration *int32 - - // The name of the role that you want to modify. - // - // This member is required. - RoleName *string } type UpdateRoleOutput struct { diff --git a/service/iam/api_op_UpdateRoleDescription.go b/service/iam/api_op_UpdateRoleDescription.go index 8405f2833fd..170de9ad91a 100644 --- a/service/iam/api_op_UpdateRoleDescription.go +++ b/service/iam/api_op_UpdateRoleDescription.go @@ -59,15 +59,15 @@ func (c *Client) UpdateRoleDescription(ctx context.Context, params *UpdateRoleDe type UpdateRoleDescriptionInput struct { - // The name of the role that you want to modify. + // The new description that you want to apply to the specified role. // // This member is required. - RoleName *string + Description *string - // The new description that you want to apply to the specified role. + // The name of the role that you want to modify. // // This member is required. - Description *string + RoleName *string } type UpdateRoleDescriptionOutput struct { diff --git a/service/iam/api_op_UpdateSSHPublicKey.go b/service/iam/api_op_UpdateSSHPublicKey.go index eeb6d72625e..be546dd2b3a 100644 --- a/service/iam/api_op_UpdateSSHPublicKey.go +++ b/service/iam/api_op_UpdateSSHPublicKey.go @@ -65,6 +65,13 @@ func (c *Client) UpdateSSHPublicKey(ctx context.Context, params *UpdateSSHPublic type UpdateSSHPublicKeyInput struct { + // The unique identifier for the SSH public key. This parameter allows (through its + // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters that can + // consist of any upper or lowercased letter or digit. + // + // This member is required. + SSHPublicKeyId *string + // The status to assign to the SSH public key. Active means that the key can be // used for authentication with an AWS CodeCommit repository. Inactive means that // the key cannot be used. @@ -79,13 +86,6 @@ type UpdateSSHPublicKeyInput struct { // // This member is required. UserName *string - - // The unique identifier for the SSH public key. This parameter allows (through its - // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters that can - // consist of any upper or lowercased letter or digit. - // - // This member is required. - SSHPublicKeyId *string } type UpdateSSHPublicKeyOutput struct { diff --git a/service/iam/api_op_UpdateServerCertificate.go b/service/iam/api_op_UpdateServerCertificate.go index bf4907ae14c..44ae2e5e45d 100644 --- a/service/iam/api_op_UpdateServerCertificate.go +++ b/service/iam/api_op_UpdateServerCertificate.go @@ -73,13 +73,13 @@ func (c *Client) UpdateServerCertificate(ctx context.Context, params *UpdateServ type UpdateServerCertificateInput struct { - // The new name for the server certificate. Include this only if you are updating - // the server certificate's name. The name of the certificate cannot contain any - // spaces. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- - NewServerCertificateName *string + // The name of the server certificate that you want to update. This parameter + // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // characters consisting of upper and lowercase alphanumeric characters with no + // spaces. You can also include any of the following characters: _+=,.@- + // + // This member is required. + ServerCertificateName *string // The new path for the server certificate. Include this only if you are updating // the server certificate's path. This parameter allows (through its regex pattern @@ -90,13 +90,13 @@ type UpdateServerCertificateInput struct { // digits, and upper and lowercased letters. NewPath *string - // The name of the server certificate that you want to update. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no - // spaces. You can also include any of the following characters: _+=,.@- - // - // This member is required. - ServerCertificateName *string + // The new name for the server certificate. Include this only if you are updating + // the server certificate's name. The name of the certificate cannot contain any + // spaces. This parameter allows (through its regex pattern + // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + NewServerCertificateName *string } type UpdateServerCertificateOutput struct { diff --git a/service/iam/api_op_UpdateServiceSpecificCredential.go b/service/iam/api_op_UpdateServiceSpecificCredential.go index 37366bd7d4b..fdf884efea9 100644 --- a/service/iam/api_op_UpdateServiceSpecificCredential.go +++ b/service/iam/api_op_UpdateServiceSpecificCredential.go @@ -60,6 +60,13 @@ func (c *Client) UpdateServiceSpecificCredential(ctx context.Context, params *Up type UpdateServiceSpecificCredentialInput struct { + // The unique identifier of the service-specific credential. This parameter allows + // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // characters that can consist of any upper or lowercased letter or digit. + // + // This member is required. + ServiceSpecificCredentialId *string + // The status to be assigned to the service-specific credential. // // This member is required. @@ -72,13 +79,6 @@ type UpdateServiceSpecificCredentialInput struct { // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- UserName *string - - // The unique identifier of the service-specific credential. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters that can consist of any upper or lowercased letter or digit. - // - // This member is required. - ServiceSpecificCredentialId *string } type UpdateServiceSpecificCredentialOutput struct { diff --git a/service/iam/api_op_UpdateSigningCertificate.go b/service/iam/api_op_UpdateSigningCertificate.go index ab8c7df6cd2..7fb8a677d0e 100644 --- a/service/iam/api_op_UpdateSigningCertificate.go +++ b/service/iam/api_op_UpdateSigningCertificate.go @@ -63,11 +63,12 @@ func (c *Client) UpdateSigningCertificate(ctx context.Context, params *UpdateSig type UpdateSigningCertificateInput struct { - // The name of the IAM user the signing certificate belongs to. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no - // spaces. You can also include any of the following characters: _+=,.@- - UserName *string + // The ID of the signing certificate you want to update. This parameter allows + // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // characters that can consist of any upper or lowercased letter or digit. + // + // This member is required. + CertificateId *string // The status you want to assign to the certificate. Active means that the // certificate can be used for API calls to AWS Inactive means that the certificate @@ -76,12 +77,11 @@ type UpdateSigningCertificateInput struct { // This member is required. Status types.StatusType - // The ID of the signing certificate you want to update. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters that can consist of any upper or lowercased letter or digit. - // - // This member is required. - CertificateId *string + // The name of the IAM user the signing certificate belongs to. This parameter + // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // characters consisting of upper and lowercase alphanumeric characters with no + // spaces. You can also include any of the following characters: _+=,.@- + UserName *string } type UpdateSigningCertificateOutput struct { diff --git a/service/iam/api_op_UpdateUser.go b/service/iam/api_op_UpdateUser.go index 1d2244c80dd..e718f00296a 100644 --- a/service/iam/api_op_UpdateUser.go +++ b/service/iam/api_op_UpdateUser.go @@ -67,15 +67,6 @@ func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns type UpdateUserInput struct { - // New path for the IAM user. Include this parameter only if you're changing the - // user's path. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of either a - // forward slash (/) by itself or a string that must begin and end with forward - // slashes. In addition, it can contain any ASCII character from the ! (\u0021) - // through the DEL character (\u007F), including most punctuation characters, - // digits, and upper and lowercased letters. - NewPath *string - // Name of the user to update. If you're changing the name of the user, this is the // original user name. This parameter allows (through its regex pattern // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper @@ -85,6 +76,15 @@ type UpdateUserInput struct { // This member is required. UserName *string + // New path for the IAM user. Include this parameter only if you're changing the + // user's path. This parameter allows (through its regex pattern + // (http://wikipedia.org/wiki/regex)) a string of characters consisting of either a + // forward slash (/) by itself or a string that must begin and end with forward + // slashes. In addition, it can contain any ASCII character from the ! (\u0021) + // through the DEL character (\u007F), including most punctuation characters, + // digits, and upper and lowercased letters. + NewPath *string + // New name for the user. Include this parameter only if you're changing the user's // name. IAM user, group, role, and policy names must be unique within the account. // Names are not distinguished by case. For example, you cannot create resources diff --git a/service/iam/api_op_UploadSSHPublicKey.go b/service/iam/api_op_UploadSSHPublicKey.go index aad1d5997bc..92e57d708ef 100644 --- a/service/iam/api_op_UploadSSHPublicKey.go +++ b/service/iam/api_op_UploadSSHPublicKey.go @@ -63,14 +63,6 @@ func (c *Client) UploadSSHPublicKey(ctx context.Context, params *UploadSSHPublic type UploadSSHPublicKeyInput struct { - // The name of the IAM user to associate the SSH public key with. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no - // spaces. You can also include any of the following characters: _+=,.@- - // - // This member is required. - UserName *string - // The SSH public key. The public key must be encoded in ssh-rsa format or PEM // format. The minimum bit-length of the public key is 2048 bits. For example, you // can generate a 2048-bit key, and the resulting PEM file is 1679 bytes long. The @@ -89,6 +81,14 @@ type UploadSSHPublicKeyInput struct { // // This member is required. SSHPublicKeyBody *string + + // The name of the IAM user to associate the SSH public key with. This parameter + // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // characters consisting of upper and lowercase alphanumeric characters with no + // spaces. You can also include any of the following characters: _+=,.@- + // + // This member is required. + UserName *string } // Contains the response to a successful UploadSSHPublicKey () request. diff --git a/service/iam/api_op_UploadServerCertificate.go b/service/iam/api_op_UploadServerCertificate.go index 95373291306..20815668746 100644 --- a/service/iam/api_op_UploadServerCertificate.go +++ b/service/iam/api_op_UploadServerCertificate.go @@ -81,38 +81,6 @@ func (c *Client) UploadServerCertificate(ctx context.Context, params *UploadServ type UploadServerCertificateInput struct { - // The contents of the private key in PEM-encoded format. The regex pattern - // (http://wikipedia.org/wiki/regex) used to validate this parameter is a string of - // characters consisting of the following: - // - // * Any printable ASCII character - // ranging from the space character (\u0020) through the end of the ASCII character - // range - // - // * The printable characters in the Basic Latin and Latin-1 Supplement - // character set (through \u00FF) - // - // * The special characters tab (\u0009), line - // feed (\u000A), and carriage return (\u000D) - // - // This member is required. - PrivateKey *string - - // The path for the server certificate. For more information about paths, see IAM - // Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. This parameter is optional. If it is not included, it defaults - // to a slash (/). This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of either a - // forward slash (/) by itself or a string that must begin and end with forward - // slashes. In addition, it can contain any ASCII character from the ! (\u0021) - // through the DEL character (\u007F), including most punctuation characters, - // digits, and upper and lowercased letters. If you are uploading a server - // certificate specifically for use with Amazon CloudFront distributions, you must - // specify a path using the path parameter. The path must begin with /cloudfront - // and must include a trailing slash (for example, /cloudfront/test/). - Path *string - // The contents of the public key certificate in PEM-encoded format. The regex // pattern (http://wikipedia.org/wiki/regex) used to validate this parameter is a // string of characters consisting of the following: @@ -130,8 +98,7 @@ type UploadServerCertificateInput struct { // This member is required. CertificateBody *string - // The contents of the certificate chain. This is typically a concatenation of the - // PEM-encoded public key certificates of the chain. The regex pattern + // The contents of the private key in PEM-encoded format. The regex pattern // (http://wikipedia.org/wiki/regex) used to validate this parameter is a string of // characters consisting of the following: // @@ -144,7 +111,9 @@ type UploadServerCertificateInput struct { // // * The special characters tab (\u0009), line // feed (\u000A), and carriage return (\u000D) - CertificateChain *string + // + // This member is required. + PrivateKey *string // The name for the server certificate. Do not include the path in this value. The // name of the certificate cannot contain any spaces. This parameter allows @@ -154,6 +123,37 @@ type UploadServerCertificateInput struct { // // This member is required. ServerCertificateName *string + + // The contents of the certificate chain. This is typically a concatenation of the + // PEM-encoded public key certificates of the chain. The regex pattern + // (http://wikipedia.org/wiki/regex) used to validate this parameter is a string of + // characters consisting of the following: + // + // * Any printable ASCII character + // ranging from the space character (\u0020) through the end of the ASCII character + // range + // + // * The printable characters in the Basic Latin and Latin-1 Supplement + // character set (through \u00FF) + // + // * The special characters tab (\u0009), line + // feed (\u000A), and carriage return (\u000D) + CertificateChain *string + + // The path for the server certificate. For more information about paths, see IAM + // Identifiers + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the + // IAM User Guide. This parameter is optional. If it is not included, it defaults + // to a slash (/). This parameter allows (through its regex pattern + // (http://wikipedia.org/wiki/regex)) a string of characters consisting of either a + // forward slash (/) by itself or a string that must begin and end with forward + // slashes. In addition, it can contain any ASCII character from the ! (\u0021) + // through the DEL character (\u007F), including most punctuation characters, + // digits, and upper and lowercased letters. If you are uploading a server + // certificate specifically for use with Amazon CloudFront distributions, you must + // specify a path using the path parameter. The path must begin with /cloudfront + // and must include a trailing slash (for example, /cloudfront/test/). + Path *string } // Contains the response to a successful UploadServerCertificate () request. diff --git a/service/iam/go.mod b/service/iam/go.mod index d17e60098dc..89522dc6976 100644 --- a/service/iam/go.mod +++ b/service/iam/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/iam go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/iam/types/types.go b/service/iam/types/types.go index 14edfd19993..dfaff51659a 100644 --- a/service/iam/types/types.go +++ b/service/iam/types/types.go @@ -18,6 +18,20 @@ type AccessDetail struct { // This member is required. ServiceName *string + // The namespace of the service in which access was attempted. To learn the service + // namespace of a service, go to Actions, Resources, and Condition Keys for AWS + // Services + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_actions-resources-contextkeys.html) + // in the IAM User Guide. Choose the name of the service to view details for that + // service. In the first paragraph, find the service prefix. For example, (service + // prefix: a4b). For more information about service namespaces, see AWS Service + // Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) + // in the AWS General Reference. + // + // This member is required. + ServiceNamespace *string + // The path of the Organizations entity (root, organizational unit, or account) // from which an authenticated principal last attempted to access the service. AWS // does not report unauthenticated requests. This field is null if no principals @@ -26,16 +40,6 @@ type AccessDetail struct { // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). EntityPath *string - // The number of accounts with authenticated principals (root users, IAM users, and - // IAM roles) that attempted to access the service in the reporting period. - TotalAuthenticatedEntities *int32 - - // The Region where the last service access attempt occurred. This field is null if - // no principals in the reported Organizations entity attempted to access the - // service within the reporting period - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). - Region *string - // The date and time, in ISO 8601 date-time format // (http://www.iso.org/iso/iso8601), when an authenticated principal most recently // attempted to access the service. AWS does not report unauthenticated requests. @@ -44,19 +48,15 @@ type AccessDetail struct { // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). LastAuthenticatedTime *time.Time - // The namespace of the service in which access was attempted. To learn the service - // namespace of a service, go to Actions, Resources, and Condition Keys for AWS - // Services - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_actions-resources-contextkeys.html) - // in the IAM User Guide. Choose the name of the service to view details for that - // service. In the first paragraph, find the service prefix. For example, (service - // prefix: a4b). For more information about service namespaces, see AWS Service - // Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) - // in the AWS General Reference. - // - // This member is required. - ServiceNamespace *string + // The Region where the last service access attempt occurred. This field is null if + // no principals in the reported Organizations entity attempted to access the + // service within the reporting period + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). + Region *string + + // The number of accounts with authenticated principals (root users, IAM users, and + // IAM roles) that attempted to access the service in the reporting period. + TotalAuthenticatedEntities *int32 } // Contains information about an AWS access key. This data type is used as a @@ -72,16 +72,16 @@ type AccessKey struct { // This member is required. AccessKeyId *string - // The status of the access key. Active means that the key is valid for API calls, - // while Inactive means it is not. + // The secret key used to sign requests. // // This member is required. - Status StatusType + SecretAccessKey *string - // The secret key used to sign requests. + // The status of the access key. Active means that the key is valid for API calls, + // while Inactive means it is not. // // This member is required. - SecretAccessKey *string + Status StatusType // The name of the IAM user that the access key is associated with. // @@ -97,21 +97,6 @@ type AccessKey struct { // response element in the GetAccessKeyLastUsed () operation. type AccessKeyLastUsed struct { - // The name of the AWS service with which this access key was most recently used. - // The value of this field is "N/A" in the following situations: - // - // * The user - // does not have an access key. - // - // * An access key exists but has not been used - // since IAM started tracking this information. - // - // * There is no sign-in data - // associated with the user. - // - // This member is required. - ServiceName *string - // The date and time, in ISO 8601 date-time format // (http://www.iso.org/iso/iso8601), when the access key was most recently used. // This field is null in the following situations: @@ -146,6 +131,21 @@ type AccessKeyLastUsed struct { // // This member is required. Region *string + + // The name of the AWS service with which this access key was most recently used. + // The value of this field is "N/A" in the following situations: + // + // * The user + // does not have an access key. + // + // * An access key exists but has not been used + // since IAM started tracking this information. + // + // * There is no sign-in data + // associated with the user. + // + // This member is required. + ServiceName *string } // Contains information about an AWS access key, without its secret key. This data @@ -155,15 +155,15 @@ type AccessKeyMetadata struct { // The ID for this access key. AccessKeyId *string - // The name of the IAM user that the key is associated with. - UserName *string + // The date when the access key was created. + CreateDate *time.Time // The status of the access key. Active means that the key is valid for API calls; // Inactive means it is not. Status StatusType - // The date when the access key was created. - CreateDate *time.Time + // The name of the IAM user that the key is associated with. + UserName *string } // Contains information about an attached permissions boundary. An attached @@ -193,15 +193,15 @@ type AttachedPermissionsBoundary struct { // in the IAM User Guide. type AttachedPolicy struct { - // The friendly name of the attached policy. - PolicyName *string - // The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources. // For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS // Service Namespaces // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in // the AWS General Reference. PolicyArn *string + + // The friendly name of the attached policy. + PolicyName *string } // Contains information about a condition context key. It includes the name of the @@ -211,6 +211,10 @@ type AttachedPolicy struct { // parameter to SimulateCustomPolicy () and SimulatePrincipalPolicy (). type ContextEntry struct { + // The full name of a condition context key, including the service prefix. For + // example, aws:SourceIp or s3:VersionId. + ContextKeyName *string + // The data type of the value (or values) specified in the ContextKeyValues // parameter. ContextKeyType ContextKeyTypeEnum @@ -219,10 +223,6 @@ type ContextEntry struct { // provide to the simulation when the key is referenced by a Condition element in // an input policy. ContextKeyValues []*string - - // The full name of a condition context key, including the service prefix. For - // example, aws:SourceIp or s3:VersionId. - ContextKeyName *string } // The reason that the service-linked role deletion failed. This data type is used @@ -264,35 +264,35 @@ type EntityDetails struct { // element of the EntityDetails () object. type EntityInfo struct { - // The name of the entity (user or role). + // The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources. + // For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS + // Service Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in + // the AWS General Reference. // // This member is required. - Name *string + Arn *string // The identifier of the entity (user or role). // // This member is required. Id *string - // The path to the entity (user or role). For more information about paths, see IAM - // Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. - Path *string - - // The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources. - // For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS - // Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference. + // The name of the entity (user or role). // // This member is required. - Arn *string + Name *string // The type of entity (user or role). // // This member is required. Type PolicyOwnerEntityType + + // The path to the entity (user or role). For more information about paths, see IAM + // Identifiers + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the + // IAM User Guide. + Path *string } // Contains information about the reason that the operation failed. This data type @@ -316,15 +316,15 @@ type ErrorDetails struct { // parameter of SimulateCustomPolicy () and SimulatePrincipalPolicy (). type EvaluationResult struct { - // The result of the simulation. + // The name of the API operation tested on the indicated resource. // // This member is required. - EvalDecision PolicyEvaluationDecisionType + EvalActionName *string - // The name of the API operation tested on the indicated resource. + // The result of the simulation. // // This member is required. - EvalActionName *string + EvalDecision PolicyEvaluationDecisionType // Additional details about the results of the cross-account evaluation decision. // This parameter is populated for only cross-account simulations. It contains a @@ -343,11 +343,6 @@ type EvaluationResult struct { // and this parameter is not returned. EvalDecisionDetails map[string]PolicyEvaluationDecisionType - // A structure that details how Organizations and its service control policies - // affect the results of the simulation. Only applies if the simulated user's - // account is part of an organization. - OrganizationsDecisionDetail *OrganizationsDecisionDetail - // The ARN of the resource that the indicated API operation was tested on. EvalResourceName *string @@ -367,6 +362,11 @@ type EvaluationResult struct { // GetContextKeysForCustomPolicy () or GetContextKeysForPrincipalPolicy (). MissingContextValues []*string + // A structure that details how Organizations and its service control policies + // affect the results of the simulation. Only applies if the simulated user's + // account is part of an organization. + OrganizationsDecisionDetail *OrganizationsDecisionDetail + // Contains information about the effect that a permissions boundary has on a // policy simulation when the boundary is applied to an IAM entity. PermissionsBoundaryDecisionDetail *PermissionsBoundaryDecisionDetail @@ -387,6 +387,14 @@ type EvaluationResult struct { // * ListGroups () type Group struct { + // The Amazon Resource Name (ARN) specifying the group. For more information about + // ARNs and how to use them in policies, see IAM Identifiers + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the + // IAM User Guide. + // + // This member is required. + Arn *string + // The date and time, in ISO 8601 date-time format // (http://www.iso.org/iso/iso8601), when the group was created. // @@ -406,14 +414,6 @@ type Group struct { // This member is required. GroupName *string - // The Amazon Resource Name (ARN) specifying the group. For more information about - // ARNs and how to use them in policies, see IAM Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. - // - // This member is required. - Arn *string - // The path to the group. For more information about paths, see IAM Identifiers // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the // IAM User Guide. @@ -434,29 +434,29 @@ type GroupDetail struct { // the AWS General Reference. Arn *string - // A list of the inline policies embedded in the group. - GroupPolicyList []*PolicyDetail - - // The path to the group. For more information about paths, see IAM Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. - Path *string + // A list of the managed policies attached to the group. + AttachedManagedPolicies []*AttachedPolicy // The date and time, in ISO 8601 date-time format // (http://www.iso.org/iso/iso8601), when the group was created. CreateDate *time.Time - // A list of the managed policies attached to the group. - AttachedManagedPolicies []*AttachedPolicy + // The stable and unique string identifying the group. For more information about + // IDs, see IAM Identifiers + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the + // IAM User Guide. + GroupId *string // The friendly name that identifies the group. GroupName *string - // The stable and unique string identifying the group. For more information about - // IDs, see IAM Identifiers + // A list of the inline policies embedded in the group. + GroupPolicyList []*PolicyDetail + + // The path to the group. For more information about paths, see IAM Identifiers // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the // IAM User Guide. - GroupId *string + Path *string } // Contains information about an instance profile. This data type is used as a @@ -481,18 +481,10 @@ type InstanceProfile struct { // This member is required. Arn *string - // The name identifying the instance profile. - // - // This member is required. - InstanceProfileName *string - - // The path to the instance profile. For more information about paths, see IAM - // Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. + // The date when the instance profile was created. // // This member is required. - Path *string + CreateDate *time.Time // The stable and unique string identifying the instance profile. For more // information about IDs, see IAM Identifiers @@ -502,10 +494,18 @@ type InstanceProfile struct { // This member is required. InstanceProfileId *string - // The date when the instance profile was created. + // The name identifying the instance profile. // // This member is required. - CreateDate *time.Time + InstanceProfileName *string + + // The path to the instance profile. For more information about paths, see IAM + // Identifiers + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the + // IAM User Guide. + // + // This member is required. + Path *string // The role associated with the instance profile. // @@ -518,6 +518,9 @@ type InstanceProfile struct { // element in the ListPoliciesGrantingServiceAccess () operation. type ListPoliciesGrantingServiceAccessEntry struct { + // The PoliciesGrantingServiceAccess object that contains details about the policy. + Policies []*PolicyGrantingServiceAccess + // The namespace of the service that was accessed. To learn the service namespace // of a service, go to Actions, Resources, and Condition Keys for AWS Services // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_actions-resources-contextkeys.html) @@ -528,9 +531,6 @@ type ListPoliciesGrantingServiceAccessEntry struct { // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the AWS General Reference. ServiceNamespace *string - - // The PoliciesGrantingServiceAccess object that contains details about the policy. - Policies []*PolicyGrantingServiceAccess } // Contains the user name and password create date for a user. This data type is @@ -543,14 +543,14 @@ type LoginProfile struct { // This member is required. CreateDate *time.Time - // Specifies whether the user is required to set a new password on next sign-in. - PasswordResetRequired *bool - // The name of the user, which can be used for signing in to the AWS Management // Console. // // This member is required. UserName *string + + // Specifies whether the user is required to set a new password on next sign-in. + PasswordResetRequired *bool } // Contains information about a managed policy, including the policy's ARN, @@ -562,13 +562,31 @@ type LoginProfile struct { // in the IAM User Guide. type ManagedPolicyDetail struct { - // The friendly name (not ARN) identifying the policy. - PolicyName *string + // The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources. + // For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS + // Service Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in + // the AWS General Reference. + Arn *string + + // The number of principal entities (users, groups, and roles) that the policy is + // attached to. + AttachmentCount *int32 // The date and time, in ISO 8601 date-time format // (http://www.iso.org/iso/iso8601), when the policy was created. CreateDate *time.Time + // The identifier for the version of the policy that is set as the default + // (operative) version. For more information about policy versions, see Versioning + // for Managed Policies + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) + // in the IAM User Guide. + DefaultVersionId *string + + // A friendly description of the policy. + Description *string + // Specifies whether the policy can be attached to an IAM user, group, or role. IsAttachable *bool @@ -577,9 +595,6 @@ type ManagedPolicyDetail struct { // IAM User Guide. Path *string - // A friendly description of the policy. - Description *string - // The number of entities (users and roles) for which the policy is used as the // permissions boundary. For more information about permissions boundaries, see // Permissions Boundaries for IAM Identities @@ -587,22 +602,17 @@ type ManagedPolicyDetail struct { // in the IAM User Guide. PermissionsBoundaryUsageCount *int32 - // A list containing information about the versions of the policy. - PolicyVersionList []*PolicyVersion + // The stable and unique string identifying the policy. For more information about + // IDs, see IAM Identifiers + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the + // IAM User Guide. + PolicyId *string - // The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources. - // For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS - // Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference. - Arn *string + // The friendly name (not ARN) identifying the policy. + PolicyName *string - // The identifier for the version of the policy that is set as the default - // (operative) version. For more information about policy versions, see Versioning - // for Managed Policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) - // in the IAM User Guide. - DefaultVersionId *string + // A list containing information about the versions of the policy. + PolicyVersionList []*PolicyVersion // The date and time, in ISO 8601 date-time format // (http://www.iso.org/iso/iso8601), when the policy was last updated. When a @@ -610,26 +620,16 @@ type ManagedPolicyDetail struct { // policy was created. When a policy has more than one version, this field contains // the date and time when the most recent policy version was created. UpdateDate *time.Time - - // The stable and unique string identifying the policy. For more information about - // IDs, see IAM Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. - PolicyId *string - - // The number of principal entities (users, groups, and roles) that the policy is - // attached to. - AttachmentCount *int32 } // Contains information about an MFA device. This data type is used as a response // element in the ListMFADevices () operation. type MFADevice struct { - // The user with whom the MFA device is associated. + // The date when the MFA device was enabled for the user. // // This member is required. - UserName *string + EnableDate *time.Time // The serial number that uniquely identifies the MFA device. For virtual MFA // devices, the serial number is the device ARN. @@ -637,10 +637,10 @@ type MFADevice struct { // This member is required. SerialNumber *string - // The date when the MFA device was enabled for the user. + // The user with whom the MFA device is associated. // // This member is required. - EnableDate *time.Time + UserName *string } // Contains the Amazon Resource Name (ARN) for an IAM OpenID Connect provider. @@ -667,24 +667,14 @@ type OrganizationsDecisionDetail struct { // as a response element in the GetAccountPasswordPolicy () operation. type PasswordPolicy struct { - // Specifies whether to require lowercase characters for IAM user passwords. - RequireLowercaseCharacters *bool - - // Minimum length to require for IAM user passwords. - MinimumPasswordLength *int32 - - // Specifies whether to require numbers for IAM user passwords. - RequireNumbers *bool + // Specifies whether IAM users are allowed to change their own password. + AllowUsersToChangePassword *bool // Indicates whether passwords in the account expire. Returns true if // MaxPasswordAge contains a value greater than 0. Returns false if MaxPasswordAge // is 0 or not present. ExpirePasswords *bool - // Specifies the number of previous passwords that IAM users are prevented from - // reusing. - PasswordReusePrevention *int32 - // Specifies whether IAM users are prevented from setting a new password after // their password has expired. HardExpiry *bool @@ -692,14 +682,24 @@ type PasswordPolicy struct { // The number of days that an IAM user password is valid. MaxPasswordAge *int32 - // Specifies whether to require uppercase characters for IAM user passwords. - RequireUppercaseCharacters *bool + // Minimum length to require for IAM user passwords. + MinimumPasswordLength *int32 - // Specifies whether IAM users are allowed to change their own password. - AllowUsersToChangePassword *bool + // Specifies the number of previous passwords that IAM users are prevented from + // reusing. + PasswordReusePrevention *int32 + + // Specifies whether to require lowercase characters for IAM user passwords. + RequireLowercaseCharacters *bool + + // Specifies whether to require numbers for IAM user passwords. + RequireNumbers *bool // Specifies whether to require symbols for IAM user passwords. RequireSymbols *bool + + // Specifies whether to require uppercase characters for IAM user passwords. + RequireUppercaseCharacters *bool } // Contains information about the effect that a permissions boundary has on a @@ -732,33 +732,45 @@ type Policy struct { // the AWS General Reference. Arn *string - // The stable and unique string identifying the policy. For more information about - // IDs, see IAM Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. - PolicyId *string + // The number of entities (users, groups, and roles) that the policy is attached + // to. + AttachmentCount *int32 // The date and time, in ISO 8601 date-time format // (http://www.iso.org/iso/iso8601), when the policy was created. CreateDate *time.Time - // The number of entities (users, groups, and roles) that the policy is attached - // to. - AttachmentCount *int32 + // The identifier for the version of the policy that is set as the default version. + DefaultVersionId *string + + // A friendly description of the policy. This element is included in the response + // to the GetPolicy () operation. It is not included in the response to the + // ListPolicies () operation. + Description *string // Specifies whether the policy can be attached to an IAM user, group, or role. IsAttachable *bool - // The friendly name (not ARN) identifying the policy. - PolicyName *string - // The path to the policy. For more information about paths, see IAM Identifiers // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the // IAM User Guide. Path *string - // The identifier for the version of the policy that is set as the default version. - DefaultVersionId *string + // The number of entities (users and roles) for which the policy is used to set the + // permissions boundary. For more information about permissions boundaries, see + // Permissions Boundaries for IAM Identities + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) + // in the IAM User Guide. + PermissionsBoundaryUsageCount *int32 + + // The stable and unique string identifying the policy. For more information about + // IDs, see IAM Identifiers + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the + // IAM User Guide. + PolicyId *string + + // The friendly name (not ARN) identifying the policy. + PolicyName *string // The date and time, in ISO 8601 date-time format // (http://www.iso.org/iso/iso8601), when the policy was last updated. When a @@ -766,18 +778,6 @@ type Policy struct { // policy was created. When a policy has more than one version, this field contains // the date and time when the most recent policy version was created. UpdateDate *time.Time - - // A friendly description of the policy. This element is included in the response - // to the GetPolicy () operation. It is not included in the response to the - // ListPolicies () operation. - Description *string - - // The number of entities (users and roles) for which the policy is used to set the - // permissions boundary. For more information about permissions boundaries, see - // Permissions Boundaries for IAM Identities - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) - // in the IAM User Guide. - PermissionsBoundaryUsageCount *int32 } // Contains information about an IAM policy, including the policy document. This @@ -797,6 +797,11 @@ type PolicyDetail struct { // ListPoliciesGrantingServiceAccessEntry () object. type PolicyGrantingServiceAccess struct { + // The policy name. + // + // This member is required. + PolicyName *string + // The policy type. For more information about these policy types, see Managed // Policies and Inline Policies // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html) @@ -805,11 +810,6 @@ type PolicyGrantingServiceAccess struct { // This member is required. PolicyType PolicyType - // The policy name. - // - // This member is required. - PolicyName *string - // The name of the entity (user or role) to which the inline policy is attached. // This field is null for managed policies. For more information about these policy // types, see Managed Policies and Inline Policies @@ -817,13 +817,6 @@ type PolicyGrantingServiceAccess struct { // in the IAM User Guide. EntityName *string - // The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources. - // For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS - // Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference. - PolicyArn *string - // The type of entity (user or role) that used the policy to access the service to // which the inline policy is attached. This field is null for managed policies. // For more information about these policy types, see Managed Policies and Inline @@ -831,6 +824,13 @@ type PolicyGrantingServiceAccess struct { // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html) // in the IAM User Guide. EntityType PolicyOwnerEntityType + + // The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources. + // For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS + // Service Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in + // the AWS General Reference. + PolicyArn *string } // Contains information about a group that a managed policy is attached to. This @@ -859,14 +859,14 @@ type PolicyGroup struct { // in the IAM User Guide. type PolicyRole struct { - // The name (friendly name, not ARN) identifying the role. - RoleName *string - // The stable and unique string identifying the role. For more information about // IDs, see IAM Identifiers // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in // the IAM User Guide. RoleId *string + + // The name (friendly name, not ARN) identifying the role. + RoleName *string } // Contains information about a user that a managed policy is attached to. This @@ -877,14 +877,14 @@ type PolicyRole struct { // in the IAM User Guide. type PolicyUser struct { - // The name (friendly name, not ARN) identifying the user. - UserName *string - // The stable and unique string identifying the user. For more information about // IDs, see IAM Identifiers // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in // the IAM User Guide. UserId *string + + // The name (friendly name, not ARN) identifying the user. + UserName *string } // Contains information about a version of a managed policy. This data type is used @@ -896,8 +896,9 @@ type PolicyUser struct { // in the IAM User Guide. type PolicyVersion struct { - // Specifies whether the policy version is set as the policy's default version. - IsDefaultVersion *bool + // The date and time, in ISO 8601 date-time format + // (http://www.iso.org/iso/iso8601), when the policy version was created. + CreateDate *time.Time // The policy document. The policy document is returned in the response to the // GetPolicyVersion () and GetAccountAuthorizationDetails () operations. It is not @@ -909,9 +910,8 @@ type PolicyVersion struct { // class in the Java SDK. Other languages and SDKs provide similar functionality. Document *string - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the policy version was created. - CreateDate *time.Time + // Specifies whether the policy version is set as the policy's default version. + IsDefaultVersion *bool // The identifier for the policy version. Policy version identifiers always begin // with v (always lowercase). When a policy is created, the first policy version is @@ -935,19 +935,16 @@ type Position struct { // type. type ResourceSpecificResult struct { - // Contains information about the effect that a permissions boundary has on a - // policy simulation when that boundary is applied to an IAM entity. - PermissionsBoundaryDecisionDetail *PermissionsBoundaryDecisionDetail + // The result of the simulation of the simulated API operation on the resource + // specified in EvalResourceName. + // + // This member is required. + EvalResourceDecision PolicyEvaluationDecisionType - // A list of context keys that are required by the included input policies but that - // were not provided by one of the input parameters. This list is used when a list - // of ARNs is included in the ResourceArns parameter instead of "*". If you do not - // specify individual resources, by setting ResourceArns to "*" or by not including - // the ResourceArns parameter, then any missing context values are instead included - // under the EvaluationResults section. To discover the context keys used by a set - // of policies, you can call GetContextKeysForCustomPolicy () or - // GetContextKeysForPrincipalPolicy (). - MissingContextValues []*string + // The name of the simulated resource, in Amazon Resource Name (ARN) format. + // + // This member is required. + EvalResourceName *string // Additional details about the results of the evaluation decision on a single // resource. This parameter is returned only for cross-account simulations. This @@ -955,11 +952,6 @@ type ResourceSpecificResult struct { // evaluation decision. EvalDecisionDetails map[string]PolicyEvaluationDecisionType - // The name of the simulated resource, in Amazon Resource Name (ARN) format. - // - // This member is required. - EvalResourceName *string - // A list of the statements in the input policies that determine the result for // this part of the simulation. Remember that even if multiple statements allow the // operation on the resource, if any statement denies that operation, then the @@ -967,53 +959,38 @@ type ResourceSpecificResult struct { // entry included in the result. MatchedStatements []*Statement - // The result of the simulation of the simulated API operation on the resource - // specified in EvalResourceName. - // - // This member is required. - EvalResourceDecision PolicyEvaluationDecisionType + // A list of context keys that are required by the included input policies but that + // were not provided by one of the input parameters. This list is used when a list + // of ARNs is included in the ResourceArns parameter instead of "*". If you do not + // specify individual resources, by setting ResourceArns to "*" or by not including + // the ResourceArns parameter, then any missing context values are instead included + // under the EvaluationResults section. To discover the context keys used by a set + // of policies, you can call GetContextKeysForCustomPolicy () or + // GetContextKeysForPrincipalPolicy (). + MissingContextValues []*string + + // Contains information about the effect that a permissions boundary has on a + // policy simulation when that boundary is applied to an IAM entity. + PermissionsBoundaryDecisionDetail *PermissionsBoundaryDecisionDetail } // Contains information about an IAM role. This structure is returned as a response // element in several API operations that interact with roles. type Role struct { - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the role was created. + // The Amazon Resource Name (ARN) specifying the role. For more information about + // ARNs and how to use them in policies, see IAM Identifiers + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the + // IAM User Guide guide. // // This member is required. - CreateDate *time.Time - - // A list of tags that are attached to the specified role. For more information - // about tagging, see Tagging IAM Identities - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User - // Guide. - Tags []*Tag - - // The policy that grants an entity permission to assume the role. - AssumeRolePolicyDocument *string - - // Contains information about the last time that an IAM role was used. This - // includes the date and time and the Region in which the role was last used. - // Activity is only reported for the trailing 400 days. This period can be shorter - // if your Region began supporting these features within the last year. The role - // might have been used more than 400 days ago. For more information, see Regions - // Where Data Is Tracked - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period) - // in the IAM User Guide. - RoleLastUsed *RoleLastUsed + Arn *string - // The friendly name that identifies the role. + // The date and time, in ISO 8601 date-time format + // (http://www.iso.org/iso/iso8601), when the role was created. // // This member is required. - RoleName *string - - // The ARN of the policy used to set the permissions boundary for the role. For - // more information about permissions boundaries, see Permissions Boundaries for - // IAM Identities - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) - // in the IAM User Guide. - PermissionsBoundary *AttachedPermissionsBoundary + CreateDate *time.Time // The path to the role. For more information about paths, see IAM Identifiers // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the @@ -1022,17 +999,6 @@ type Role struct { // This member is required. Path *string - // A description of the role that you provide. - Description *string - - // The Amazon Resource Name (ARN) specifying the role. For more information about - // ARNs and how to use them in policies, see IAM Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide guide. - // - // This member is required. - Arn *string - // The stable and unique string identifying the role. For more information about // IDs, see IAM Identifiers // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the @@ -1041,16 +1007,21 @@ type Role struct { // This member is required. RoleId *string + // The friendly name that identifies the role. + // + // This member is required. + RoleName *string + + // The policy that grants an entity permission to assume the role. + AssumeRolePolicyDocument *string + + // A description of the role that you provide. + Description *string + // The maximum session duration (in seconds) for the specified role. Anyone who // uses the AWS CLI, or API to assume the role can specify the duration using the // optional DurationSeconds API parameter or duration-seconds CLI parameter. MaxSessionDuration *int32 -} - -// Contains information about an IAM role, including all of the role's policies. -// This data type is used as a response element in the -// GetAccountAuthorizationDetails () operation. -type RoleDetail struct { // The ARN of the policy used to set the permissions boundary for the role. For // more information about permissions boundaries, see Permissions Boundaries for @@ -1059,8 +1030,27 @@ type RoleDetail struct { // in the IAM User Guide. PermissionsBoundary *AttachedPermissionsBoundary - // The friendly name that identifies the role. - RoleName *string + // Contains information about the last time that an IAM role was used. This + // includes the date and time and the Region in which the role was last used. + // Activity is only reported for the trailing 400 days. This period can be shorter + // if your Region began supporting these features within the last year. The role + // might have been used more than 400 days ago. For more information, see Regions + // Where Data Is Tracked + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period) + // in the IAM User Guide. + RoleLastUsed *RoleLastUsed + + // A list of tags that are attached to the specified role. For more information + // about tagging, see Tagging IAM Identities + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User + // Guide. + Tags []*Tag +} + +// Contains information about an IAM role, including all of the role's policies. +// This data type is used as a response element in the +// GetAccountAuthorizationDetails () operation. +type RoleDetail struct { // The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources. // For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS @@ -1069,25 +1059,31 @@ type RoleDetail struct { // the AWS General Reference. Arn *string - // The path to the role. For more information about paths, see IAM Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. - Path *string - // The trust policy that grants permission to assume the role. AssumeRolePolicyDocument *string + // A list of managed policies attached to the role. These policies are the role's + // access (permissions) policies. + AttachedManagedPolicies []*AttachedPolicy + // The date and time, in ISO 8601 date-time format // (http://www.iso.org/iso/iso8601), when the role was created. CreateDate *time.Time - // A list of inline policies embedded in the role. These policies are the role's - // access (permissions) policies. - RolePolicyList []*PolicyDetail + // A list of instance profiles that contain this role. + InstanceProfileList []*InstanceProfile - // A list of managed policies attached to the role. These policies are the role's - // access (permissions) policies. - AttachedManagedPolicies []*AttachedPolicy + // The path to the role. For more information about paths, see IAM Identifiers + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the + // IAM User Guide. + Path *string + + // The ARN of the policy used to set the permissions boundary for the role. For + // more information about permissions boundaries, see Permissions Boundaries for + // IAM Identities + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) + // in the IAM User Guide. + PermissionsBoundary *AttachedPermissionsBoundary // The stable and unique string identifying the role. For more information about // IDs, see IAM Identifiers @@ -1095,9 +1091,6 @@ type RoleDetail struct { // IAM User Guide. RoleId *string - // A list of instance profiles that contain this role. - InstanceProfileList []*InstanceProfile - // Contains information about the last time that an IAM role was used. This // includes the date and time and the Region in which the role was last used. // Activity is only reported for the trailing 400 days. This period can be shorter @@ -1108,6 +1101,13 @@ type RoleDetail struct { // in the IAM User Guide. RoleLastUsed *RoleLastUsed + // The friendly name that identifies the role. + RoleName *string + + // A list of inline policies embedded in the role. These policies are the role's + // access (permissions) policies. + RolePolicyList []*PolicyDetail + // A list of tags that are attached to the specified role. For more information // about tagging, see Tagging IAM Identities // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User @@ -1126,9 +1126,6 @@ type RoleDetail struct { // GetRole () and GetAccountAuthorizationDetails () operations. type RoleLastUsed struct { - // The name of the AWS Region in which the role was last used. - Region *string - // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) // that the role was last used. This field is null if the role has not been used // within the IAM tracking period. For more information about the tracking period, @@ -1136,6 +1133,9 @@ type RoleLastUsed struct { // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period) // in the IAM User Guide. LastUsedDate *time.Time + + // The name of the AWS Region in which the role was last used. + Region *string } // An object that contains details about how a service-linked role is used, if that @@ -1143,11 +1143,11 @@ type RoleLastUsed struct { // element in the GetServiceLinkedRoleDeletionStatus () operation. type RoleUsageType struct { - // The name of the resource that is using the service-linked role. - Resources []*string - // The name of the Region where the service-linked role is being used. Region *string + + // The name of the resource that is using the service-linked role. + Resources []*string } // Contains the list of SAML providers for this account. @@ -1167,6 +1167,11 @@ type SAMLProviderListEntry struct { // response element in the GetServerCertificate () operation. type ServerCertificate struct { + // The contents of the public key certificate. + // + // This member is required. + CertificateBody *string + // The meta information of the server certificate, such as its name, path, ID, and // ARN. // @@ -1175,11 +1180,6 @@ type ServerCertificate struct { // The contents of the public key certificate chain. CertificateChain *string - - // The contents of the public key certificate. - // - // This member is required. - CertificateBody *string } // Contains information about a server certificate without its certificate body, @@ -1187,6 +1187,22 @@ type ServerCertificate struct { // in the UploadServerCertificate () and ListServerCertificates () operations. type ServerCertificateMetadata struct { + // The Amazon Resource Name (ARN) specifying the server certificate. For more + // information about ARNs and how to use them in policies, see IAM Identifiers + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the + // IAM User Guide. + // + // This member is required. + Arn *string + + // The path to the server certificate. For more information about paths, see IAM + // Identifiers + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the + // IAM User Guide. + // + // This member is required. + Path *string + // The stable and unique string identifying the server certificate. For more // information about IDs, see IAM Identifiers // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the @@ -1203,24 +1219,8 @@ type ServerCertificateMetadata struct { // The date on which the certificate is set to expire. Expiration *time.Time - // The path to the server certificate. For more information about paths, see IAM - // Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. - // - // This member is required. - Path *string - // The date when the server certificate was uploaded. UploadDate *time.Time - - // The Amazon Resource Name (ARN) specifying the server certificate. For more - // information about ARNs and how to use them in policies, see IAM Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. - // - // This member is required. - Arn *string } // Contains details about the most recent attempt to access the service. This data @@ -1228,35 +1228,10 @@ type ServerCertificateMetadata struct { // operation. type ServiceLastAccessed struct { - // An object that contains details about the most recent attempt to access a - // tracked action within the service. This field is null if there no tracked - // actions or if the principal did not use the tracked actions within the reporting - // period - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). - // This field is also null if the report was generated at the service level and not - // the action level. For more information, see the Granularity field in - // GenerateServiceLastAccessedDetails (). - TrackedActionsLastAccessed []*TrackedActionLastAccessed - // The name of the service in which access was attempted. // // This member is required. - ServiceName *string - - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when an authenticated entity most recently - // attempted to access the service. AWS does not report unauthenticated requests. - // This field is null if no IAM entities attempted to access the service within the - // reporting period - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). - LastAuthenticated *time.Time - - // The Region from which the authenticated entity (user or role) last attempted to - // access the service. AWS does not report unauthenticated requests. This field is - // null if no IAM entities attempted to access the service within the reporting - // period - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). - LastAuthenticatedRegion *string + ServiceName *string // The namespace of the service in which access was attempted. To learn the service // namespace of a service, go to Actions, Resources, and Condition Keys for AWS @@ -1272,27 +1247,47 @@ type ServiceLastAccessed struct { // This member is required. ServiceNamespace *string + // The date and time, in ISO 8601 date-time format + // (http://www.iso.org/iso/iso8601), when an authenticated entity most recently + // attempted to access the service. AWS does not report unauthenticated requests. + // This field is null if no IAM entities attempted to access the service within the + // reporting period + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). + LastAuthenticated *time.Time + // The ARN of the authenticated entity (user or role) that last attempted to access // the service. AWS does not report unauthenticated requests. This field is null if // no IAM entities attempted to access the service within the reporting period // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). LastAuthenticatedEntity *string + // The Region from which the authenticated entity (user or role) last attempted to + // access the service. AWS does not report unauthenticated requests. This field is + // null if no IAM entities attempted to access the service within the reporting + // period + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). + LastAuthenticatedRegion *string + // The total number of authenticated principals (root user, IAM users, or IAM // roles) that have attempted to access the service. This field is null if no // principals attempted to access the service within the reporting period // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). TotalAuthenticatedEntities *int32 + + // An object that contains details about the most recent attempt to access a + // tracked action within the service. This field is null if there no tracked + // actions or if the principal did not use the tracked actions within the reporting + // period + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). + // This field is also null if the report was generated at the service level and not + // the action level. For more information, see the Granularity field in + // GenerateServiceLastAccessedDetails (). + TrackedActionsLastAccessed []*TrackedActionLastAccessed } // Contains the details of a service-specific credential. type ServiceSpecificCredential struct { - // The name of the IAM user associated with the service-specific credential. - // - // This member is required. - UserName *string - // The date and time, in ISO 8601 date-time format // (http://www.iso.org/iso/iso8601), when the service-specific credential were // created. @@ -1300,6 +1295,21 @@ type ServiceSpecificCredential struct { // This member is required. CreateDate *time.Time + // The name of the service associated with the service-specific credential. + // + // This member is required. + ServiceName *string + + // The generated password for the service-specific credential. + // + // This member is required. + ServicePassword *string + + // The unique identifier for the service-specific credential. + // + // This member is required. + ServiceSpecificCredentialId *string + // The generated user name for the service-specific credential. This value is // generated by combining the IAM user's name combined with the ID number of the // AWS account, as in jane-at-123456789012, for example. This value cannot be @@ -1314,46 +1324,36 @@ type ServiceSpecificCredential struct { // This member is required. Status StatusType - // The name of the service associated with the service-specific credential. - // - // This member is required. - ServiceName *string - - // The generated password for the service-specific credential. - // - // This member is required. - ServicePassword *string - - // The unique identifier for the service-specific credential. + // The name of the IAM user associated with the service-specific credential. // // This member is required. - ServiceSpecificCredentialId *string + UserName *string } // Contains additional details about a service-specific credential. type ServiceSpecificCredentialMetadata struct { - // The unique identifier for the service-specific credential. + // The date and time, in ISO 8601 date-time format + // (http://www.iso.org/iso/iso8601), when the service-specific credential were + // created. // // This member is required. - ServiceSpecificCredentialId *string + CreateDate *time.Time - // The generated user name for the service-specific credential. + // The name of the service associated with the service-specific credential. // // This member is required. - ServiceUserName *string + ServiceName *string - // The name of the service associated with the service-specific credential. + // The unique identifier for the service-specific credential. // // This member is required. - ServiceName *string + ServiceSpecificCredentialId *string - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the service-specific credential were - // created. + // The generated user name for the service-specific credential. // // This member is required. - CreateDate *time.Time + ServiceUserName *string // The status of the service-specific credential. Active means that the key is // valid for API calls, while Inactive means it is not. @@ -1401,36 +1401,36 @@ type SigningCertificate struct { // response element in the GetSSHPublicKey () and UploadSSHPublicKey () operations. type SSHPublicKey struct { - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the SSH public key was uploaded. - UploadDate *time.Time - - // The name of the IAM user associated with the SSH public key. + // The MD5 message digest of the SSH public key. // // This member is required. - UserName *string + Fingerprint *string - // The status of the SSH public key. Active means that the key can be used for - // authentication with an AWS CodeCommit repository. Inactive means that the key - // cannot be used. + // The SSH public key. // // This member is required. - Status StatusType + SSHPublicKeyBody *string - // The SSH public key. + // The unique identifier for the SSH public key. // // This member is required. - SSHPublicKeyBody *string + SSHPublicKeyId *string - // The MD5 message digest of the SSH public key. + // The status of the SSH public key. Active means that the key can be used for + // authentication with an AWS CodeCommit repository. Inactive means that the key + // cannot be used. // // This member is required. - Fingerprint *string + Status StatusType - // The unique identifier for the SSH public key. + // The name of the IAM user associated with the SSH public key. // // This member is required. - SSHPublicKeyId *string + UserName *string + + // The date and time, in ISO 8601 date-time format + // (http://www.iso.org/iso/iso8601), when the SSH public key was uploaded. + UploadDate *time.Time } // Contains information about an SSH public key, without the key's body or @@ -1438,11 +1438,10 @@ type SSHPublicKey struct { // ListSSHPublicKeys () operation. type SSHPublicKeyMetadata struct { - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the SSH public key was uploaded. + // The unique identifier for the SSH public key. // // This member is required. - UploadDate *time.Time + SSHPublicKeyId *string // The status of the SSH public key. Active means that the key can be used for // authentication with an AWS CodeCommit repository. Inactive means that the key @@ -1451,15 +1450,16 @@ type SSHPublicKeyMetadata struct { // This member is required. Status StatusType - // The name of the IAM user associated with the SSH public key. + // The date and time, in ISO 8601 date-time format + // (http://www.iso.org/iso/iso8601), when the SSH public key was uploaded. // // This member is required. - UserName *string + UploadDate *time.Time - // The unique identifier for the SSH public key. + // The name of the IAM user associated with the SSH public key. // // This member is required. - SSHPublicKeyId *string + UserName *string } // Contains a reference to a Statement element in a policy document that determines @@ -1467,12 +1467,12 @@ type SSHPublicKeyMetadata struct { // member of the EvaluationResult () type. type Statement struct { - // The identifier of the policy that was provided as an input. - SourcePolicyId *string - // The row and column of the end of a Statement in an IAM policy. EndPosition *Position + // The identifier of the policy that was provided as an input. + SourcePolicyId *string + // The type of the policy. SourcePolicyType PolicySourceType @@ -1511,13 +1511,9 @@ type Tag struct { // GetServiceLastAccessedDetails () operation. type TrackedActionLastAccessed struct { - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when an authenticated entity most recently - // attempted to access the tracked service. AWS does not report unauthenticated - // requests. This field is null if no IAM entities attempted to access the service - // within the reporting period - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). - LastAccessedTime *time.Time + // The name of the tracked action to which access was attempted. Tracked actions + // are actions that report activity to IAM. + ActionName *string // The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources. // For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS @@ -1533,9 +1529,13 @@ type TrackedActionLastAccessed struct { // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). LastAccessedRegion *string - // The name of the tracked action to which access was attempted. Tracked actions - // are actions that report activity to IAM. - ActionName *string + // The date and time, in ISO 8601 date-time format + // (http://www.iso.org/iso/iso8601), when an authenticated entity most recently + // attempted to access the tracked service. AWS does not report unauthenticated + // requests. This field is null if no IAM entities attempted to access the service + // within the reporting period + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). + LastAccessedTime *time.Time } // Contains information about an IAM user entity. This data type is used as a @@ -1549,6 +1549,27 @@ type TrackedActionLastAccessed struct { // * ListUsers () type User struct { + // The Amazon Resource Name (ARN) that identifies the user. For more information + // about ARNs and how to use ARNs in policies, see IAM Identifiers + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the + // IAM User Guide. + // + // This member is required. + Arn *string + + // The date and time, in ISO 8601 date-time format + // (http://www.iso.org/iso/iso8601), when the user was created. + // + // This member is required. + CreateDate *time.Time + + // The path to the user. For more information about paths, see IAM Identifiers + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the + // IAM User Guide. + // + // This member is required. + Path *string + // The stable and unique string identifying the user. For more information about // IDs, see IAM Identifiers // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the @@ -1591,32 +1612,11 @@ type User struct { // in the IAM User Guide. PermissionsBoundary *AttachedPermissionsBoundary - // The Amazon Resource Name (ARN) that identifies the user. For more information - // about ARNs and how to use ARNs in policies, see IAM Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. - // - // This member is required. - Arn *string - - // The path to the user. For more information about paths, see IAM Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. - // - // This member is required. - Path *string - // A list of tags that are associated with the specified user. For more information // about tagging, see Tagging IAM Identities // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User // Guide. Tags []*Tag - - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the user was created. - // - // This member is required. - CreateDate *time.Time } // Contains information about an IAM user, including all the user's policies and @@ -1631,6 +1631,21 @@ type UserDetail struct { // the AWS General Reference. Arn *string + // A list of the managed policies attached to the user. + AttachedManagedPolicies []*AttachedPolicy + + // The date and time, in ISO 8601 date-time format + // (http://www.iso.org/iso/iso8601), when the user was created. + CreateDate *time.Time + + // A list of IAM groups that the user is in. + GroupList []*string + + // The path to the user. For more information about paths, see IAM Identifiers + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the + // IAM User Guide. + Path *string + // The ARN of the policy used to set the permissions boundary for the user. For // more information about permissions boundaries, see Permissions Boundaries for // IAM Identities @@ -1644,47 +1659,22 @@ type UserDetail struct { // Guide. Tags []*Tag - // A list of IAM groups that the user is in. - GroupList []*string - - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the user was created. - CreateDate *time.Time - - // A list of the inline policies embedded in the user. - UserPolicyList []*PolicyDetail - - // A list of the managed policies attached to the user. - AttachedManagedPolicies []*AttachedPolicy - - // The friendly name identifying the user. - UserName *string - - // The path to the user. For more information about paths, see IAM Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. - Path *string - // The stable and unique string identifying the user. For more information about // IDs, see IAM Identifiers // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the // IAM User Guide. UserId *string + + // The friendly name identifying the user. + UserName *string + + // A list of the inline policies embedded in the user. + UserPolicyList []*PolicyDetail } // Contains information about a virtual MFA device. type VirtualMFADevice struct { - // A QR code PNG image that encodes - // otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String where - // $virtualMFADeviceName is one of the create call arguments. AccountName is the - // user name if set (otherwise, the account ID otherwise), and Base32String is the - // seed in base32 format. The Base32String value is base64-encoded. - QRCodePNG []byte - - // The date and time on which the virtual MFA device was enabled. - EnableDate *time.Time - // The serial number associated with VirtualMFADevice. // // This member is required. @@ -1695,6 +1685,16 @@ type VirtualMFADevice struct { // base64-encoded. Base32StringSeed []byte + // The date and time on which the virtual MFA device was enabled. + EnableDate *time.Time + + // A QR code PNG image that encodes + // otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String where + // $virtualMFADeviceName is one of the create call arguments. AccountName is the + // user name if set (otherwise, the account ID otherwise), and Base32String is the + // seed in base32 format. The Base32String value is base64-encoded. + QRCodePNG []byte + // The IAM user associated with this virtual MFA device. User *User } diff --git a/service/imagebuilder/api_op_CancelImageCreation.go b/service/imagebuilder/api_op_CancelImageCreation.go index ea625b542c5..21800c06159 100644 --- a/service/imagebuilder/api_op_CancelImageCreation.go +++ b/service/imagebuilder/api_op_CancelImageCreation.go @@ -59,28 +59,28 @@ func (c *Client) CancelImageCreation(ctx context.Context, params *CancelImageCre type CancelImageCreationInput struct { - // The Amazon Resource Name (ARN) of the image whose creation you want to cancel. + // The idempotency token used to make this request idempotent. // // This member is required. - ImageBuildVersionArn *string + ClientToken *string - // The idempotency token used to make this request idempotent. + // The Amazon Resource Name (ARN) of the image whose creation you want to cancel. // // This member is required. - ClientToken *string + ImageBuildVersionArn *string } type CancelImageCreationOutput struct { - // The request ID that uniquely identifies this request. - RequestId *string - // The idempotency token used to make this request idempotent. ClientToken *string // The Amazon Resource Name (ARN) of the image whose creation has been cancelled. ImageBuildVersionArn *string + // The request ID that uniquely identifies this request. + RequestId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/imagebuilder/api_op_CreateComponent.go b/service/imagebuilder/api_op_CreateComponent.go index 440773b6f9a..cadbb548b30 100644 --- a/service/imagebuilder/api_op_CreateComponent.go +++ b/service/imagebuilder/api_op_CreateComponent.go @@ -60,13 +60,20 @@ func (c *Client) CreateComponent(ctx context.Context, params *CreateComponentInp type CreateComponentInput struct { - // The tags of the component. - Tags map[string]*string + // The idempotency token of the component. + // + // This member is required. + ClientToken *string - // The operating system (OS) version supported by the component. If the OS - // information is available, a prefix match is performed against the parent image - // OS version during image recipe creation. - SupportedOsVersions []*string + // The name of the component. + // + // This member is required. + Name *string + + // The platform of the component. + // + // This member is required. + Platform types.Platform // The semantic version of the component. This version follows the semantic version // syntax. For example, major.minor.patch. This could be versioned like software @@ -75,52 +82,45 @@ type CreateComponentInput struct { // This member is required. SemanticVersion *string - // The ID of the KMS key that should be used to encrypt this component. - KmsKeyId *string - // The change description of the component. Describes what change has been made in // this version, or what makes this version different from other versions of this // component. ChangeDescription *string - // The uri of the component. Must be an S3 URL and the requester must have - // permission to access the S3 bucket. If you use S3, you can specify component - // content up to your service quota. Either data or uri can be used to specify the - // data within the component. - Uri *string - - // The name of the component. - // - // This member is required. - Name *string - // The data of the component. Used to specify the data inline. Either data or uri // can be used to specify the data within the component. Data *string - // The platform of the component. - // - // This member is required. - Platform types.Platform - - // The idempotency token of the component. - // - // This member is required. - ClientToken *string - // The description of the component. Describes the contents of the component. Description *string + + // The ID of the KMS key that should be used to encrypt this component. + KmsKeyId *string + + // The operating system (OS) version supported by the component. If the OS + // information is available, a prefix match is performed against the parent image + // OS version during image recipe creation. + SupportedOsVersions []*string + + // The tags of the component. + Tags map[string]*string + + // The uri of the component. Must be an S3 URL and the requester must have + // permission to access the S3 bucket. If you use S3, you can specify component + // content up to your service quota. Either data or uri can be used to specify the + // data within the component. + Uri *string } type CreateComponentOutput struct { + // The idempotency token used to make this request idempotent. + ClientToken *string + // The Amazon Resource Name (ARN) of the component that was created by this // request. ComponentBuildVersionArn *string - // The idempotency token used to make this request idempotent. - ClientToken *string - // The request ID that uniquely identifies this request. RequestId *string diff --git a/service/imagebuilder/api_op_CreateDistributionConfiguration.go b/service/imagebuilder/api_op_CreateDistributionConfiguration.go index 0d15a1bc01d..b815f7099e4 100644 --- a/service/imagebuilder/api_op_CreateDistributionConfiguration.go +++ b/service/imagebuilder/api_op_CreateDistributionConfiguration.go @@ -60,26 +60,26 @@ func (c *Client) CreateDistributionConfiguration(ctx context.Context, params *Cr type CreateDistributionConfigurationInput struct { - // The description of the distribution configuration. - Description *string - // The idempotency token of the distribution configuration. // // This member is required. ClientToken *string + // The distributions of the distribution configuration. + // + // This member is required. + Distributions []*types.Distribution + // The name of the distribution configuration. // // This member is required. Name *string + // The description of the distribution configuration. + Description *string + // The tags of the distribution configuration. Tags map[string]*string - - // The distributions of the distribution configuration. - // - // This member is required. - Distributions []*types.Distribution } type CreateDistributionConfigurationOutput struct { @@ -87,13 +87,13 @@ type CreateDistributionConfigurationOutput struct { // The idempotency token used to make this request idempotent. ClientToken *string - // The request ID that uniquely identifies this request. - RequestId *string - // The Amazon Resource Name (ARN) of the distribution configuration that was // created by this request. DistributionConfigurationArn *string + // The request ID that uniquely identifies this request. + RequestId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/imagebuilder/api_op_CreateImage.go b/service/imagebuilder/api_op_CreateImage.go index 412422f7b15..644b09ac523 100644 --- a/service/imagebuilder/api_op_CreateImage.go +++ b/service/imagebuilder/api_op_CreateImage.go @@ -60,6 +60,17 @@ func (c *Client) CreateImage(ctx context.Context, params *CreateImageInput, optF type CreateImageInput struct { + // The idempotency token used to make this request idempotent. + // + // This member is required. + ClientToken *string + + // The Amazon Resource Name (ARN) of the image recipe that defines how images are + // configured, tested, and assessed. + // + // This member is required. + ImageRecipeArn *string + // The Amazon Resource Name (ARN) of the infrastructure configuration that defines // the environment in which your image will be built and tested. // @@ -75,22 +86,11 @@ type CreateImageInput struct { // enhance the overall experience of using EC2 Image Builder. Enabled by default. EnhancedImageMetadataEnabled *bool - // The tags of the image. - Tags map[string]*string - // The image tests configuration of the image. ImageTestsConfiguration *types.ImageTestsConfiguration - // The Amazon Resource Name (ARN) of the image recipe that defines how images are - // configured, tested, and assessed. - // - // This member is required. - ImageRecipeArn *string - - // The idempotency token used to make this request idempotent. - // - // This member is required. - ClientToken *string + // The tags of the image. + Tags map[string]*string } type CreateImageOutput struct { @@ -98,12 +98,12 @@ type CreateImageOutput struct { // The idempotency token used to make this request idempotent. ClientToken *string - // The request ID that uniquely identifies this request. - RequestId *string - // The Amazon Resource Name (ARN) of the image that was created by this request. ImageBuildVersionArn *string + // The request ID that uniquely identifies this request. + RequestId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/imagebuilder/api_op_CreateImagePipeline.go b/service/imagebuilder/api_op_CreateImagePipeline.go index fd5d3940abd..e36e5b7c544 100644 --- a/service/imagebuilder/api_op_CreateImagePipeline.go +++ b/service/imagebuilder/api_op_CreateImagePipeline.go @@ -60,8 +60,10 @@ func (c *Client) CreateImagePipeline(ctx context.Context, params *CreateImagePip type CreateImagePipelineInput struct { - // The tags of the image pipeline. - Tags map[string]*string + // The idempotency token used to make this request idempotent. + // + // This member is required. + ClientToken *string // The Amazon Resource Name (ARN) of the image recipe that will be used to // configure images created by this image pipeline. @@ -69,35 +71,12 @@ type CreateImagePipelineInput struct { // This member is required. ImageRecipeArn *string - // The status of the image pipeline. - Status types.PipelineStatus - - // The idempotency token used to make this request idempotent. - // - // This member is required. - ClientToken *string - - // The schedule of the image pipeline. - Schedule *types.Schedule - - // The image test configuration of the image pipeline. - ImageTestsConfiguration *types.ImageTestsConfiguration - // The Amazon Resource Name (ARN) of the infrastructure configuration that will be // used to build images created by this image pipeline. // // This member is required. InfrastructureConfigurationArn *string - // Collects additional information about the image being created, including the - // operating system (OS) version and package list. This information is used to - // enhance the overall experience of using EC2 Image Builder. Enabled by default. - EnhancedImageMetadataEnabled *bool - - // The Amazon Resource Name (ARN) of the distribution configuration that will be - // used to configure and distribute images created by this image pipeline. - DistributionConfigurationArn *string - // The name of the image pipeline. // // This member is required. @@ -105,6 +84,27 @@ type CreateImagePipelineInput struct { // The description of the image pipeline. Description *string + + // The Amazon Resource Name (ARN) of the distribution configuration that will be + // used to configure and distribute images created by this image pipeline. + DistributionConfigurationArn *string + + // Collects additional information about the image being created, including the + // operating system (OS) version and package list. This information is used to + // enhance the overall experience of using EC2 Image Builder. Enabled by default. + EnhancedImageMetadataEnabled *bool + + // The image test configuration of the image pipeline. + ImageTestsConfiguration *types.ImageTestsConfiguration + + // The schedule of the image pipeline. + Schedule *types.Schedule + + // The status of the image pipeline. + Status types.PipelineStatus + + // The tags of the image pipeline. + Tags map[string]*string } type CreateImagePipelineOutput struct { diff --git a/service/imagebuilder/api_op_CreateImageRecipe.go b/service/imagebuilder/api_op_CreateImageRecipe.go index 0f446b75193..eaa776c2f1a 100644 --- a/service/imagebuilder/api_op_CreateImageRecipe.go +++ b/service/imagebuilder/api_op_CreateImageRecipe.go @@ -60,21 +60,20 @@ func (c *Client) CreateImageRecipe(ctx context.Context, params *CreateImageRecip type CreateImageRecipeInput struct { + // The idempotency token used to make this request idempotent. + // + // This member is required. + ClientToken *string + // The components of the image recipe. // // This member is required. Components []*types.ComponentConfiguration - // The idempotency token used to make this request idempotent. + // The name of the image recipe. // // This member is required. - ClientToken *string - - // The working directory to be used during build and test workflows. - WorkingDirectory *string - - // The block device mappings of the image recipe. - BlockDeviceMappings []*types.InstanceBlockDeviceMapping + Name *string // The parent image of the image recipe. The value of the string can be the ARN of // the parent image or an AMI ID. The format for the ARN follows this example: @@ -88,10 +87,13 @@ type CreateImageRecipeInput struct { // This member is required. ParentImage *string - // The name of the image recipe. + // The semantic version of the image recipe. // // This member is required. - Name *string + SemanticVersion *string + + // The block device mappings of the image recipe. + BlockDeviceMappings []*types.InstanceBlockDeviceMapping // The description of the image recipe. Description *string @@ -99,23 +101,21 @@ type CreateImageRecipeInput struct { // The tags of the image recipe. Tags map[string]*string - // The semantic version of the image recipe. - // - // This member is required. - SemanticVersion *string + // The working directory to be used during build and test workflows. + WorkingDirectory *string } type CreateImageRecipeOutput struct { - // The request ID that uniquely identifies this request. - RequestId *string + // The idempotency token used to make this request idempotent. + ClientToken *string // The Amazon Resource Name (ARN) of the image recipe that was created by this // request. ImageRecipeArn *string - // The idempotency token used to make this request idempotent. - ClientToken *string + // The request ID that uniquely identifies this request. + RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/imagebuilder/api_op_CreateInfrastructureConfiguration.go b/service/imagebuilder/api_op_CreateInfrastructureConfiguration.go index f28fa47fc8b..cf8532b738a 100644 --- a/service/imagebuilder/api_op_CreateInfrastructureConfiguration.go +++ b/service/imagebuilder/api_op_CreateInfrastructureConfiguration.go @@ -60,57 +60,57 @@ func (c *Client) CreateInfrastructureConfiguration(ctx context.Context, params * type CreateInfrastructureConfigurationInput struct { - // The subnet ID in which to place the instance used to customize your EC2 AMI. - SubnetId *string - - // The description of the infrastructure configuration. - Description *string - // The idempotency token used to make this request idempotent. // // This member is required. ClientToken *string - // The tags of the infrastructure configuration. - Tags map[string]*string - - // The terminate instance on failure setting of the infrastructure configuration. - // Set to false if you want Image Builder to retain the instance used to configure - // your AMI if the build or test phase of your workflow fails. - TerminateInstanceOnFailure *bool - - // The tags attached to the resource created by Image Builder. - ResourceTags map[string]*string - - // The SNS topic on which to send image build events. - SnsTopicArn *string - - // The security group IDs to associate with the instance used to customize your EC2 - // AMI. - SecurityGroupIds []*string - // The instance profile to associate with the instance used to customize your EC2 // AMI. // // This member is required. InstanceProfileName *string - // The key pair of the infrastructure configuration. This can be used to log on to - // and debug the instance used to create your image. - KeyPair *string - - // The logging configuration of the infrastructure configuration. - Logging *types.Logging - // The name of the infrastructure configuration. // // This member is required. Name *string + // The description of the infrastructure configuration. + Description *string + // The instance types of the infrastructure configuration. You can specify one or // more instance types to use for this build. The service will pick one of these // instance types based on availability. InstanceTypes []*string + + // The key pair of the infrastructure configuration. This can be used to log on to + // and debug the instance used to create your image. + KeyPair *string + + // The logging configuration of the infrastructure configuration. + Logging *types.Logging + + // The tags attached to the resource created by Image Builder. + ResourceTags map[string]*string + + // The security group IDs to associate with the instance used to customize your EC2 + // AMI. + SecurityGroupIds []*string + + // The SNS topic on which to send image build events. + SnsTopicArn *string + + // The subnet ID in which to place the instance used to customize your EC2 AMI. + SubnetId *string + + // The tags of the infrastructure configuration. + Tags map[string]*string + + // The terminate instance on failure setting of the infrastructure configuration. + // Set to false if you want Image Builder to retain the instance used to configure + // your AMI if the build or test phase of your workflow fails. + TerminateInstanceOnFailure *bool } type CreateInfrastructureConfigurationOutput struct { @@ -118,13 +118,13 @@ type CreateInfrastructureConfigurationOutput struct { // The idempotency token used to make this request idempotent. ClientToken *string - // The request ID that uniquely identifies this request. - RequestId *string - // The Amazon Resource Name (ARN) of the infrastructure configuration that was // created by this request. InfrastructureConfigurationArn *string + // The request ID that uniquely identifies this request. + RequestId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/imagebuilder/api_op_DeleteComponent.go b/service/imagebuilder/api_op_DeleteComponent.go index b5a0d99c8bf..c30651dd29a 100644 --- a/service/imagebuilder/api_op_DeleteComponent.go +++ b/service/imagebuilder/api_op_DeleteComponent.go @@ -64,12 +64,12 @@ type DeleteComponentInput struct { type DeleteComponentOutput struct { - // The request ID that uniquely identifies this request. - RequestId *string - // The Amazon Resource Name (ARN) of the component build version that was deleted. ComponentBuildVersionArn *string + // The request ID that uniquely identifies this request. + RequestId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/imagebuilder/api_op_DeleteDistributionConfiguration.go b/service/imagebuilder/api_op_DeleteDistributionConfiguration.go index 004a4dcc1c9..ea1e3818134 100644 --- a/service/imagebuilder/api_op_DeleteDistributionConfiguration.go +++ b/service/imagebuilder/api_op_DeleteDistributionConfiguration.go @@ -64,13 +64,13 @@ type DeleteDistributionConfigurationInput struct { type DeleteDistributionConfigurationOutput struct { - // The request ID that uniquely identifies this request. - RequestId *string - // The Amazon Resource Name (ARN) of the distribution configuration that was // deleted. DistributionConfigurationArn *string + // The request ID that uniquely identifies this request. + RequestId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/imagebuilder/api_op_DeleteImage.go b/service/imagebuilder/api_op_DeleteImage.go index f65000570f4..f3f8cbdaa0d 100644 --- a/service/imagebuilder/api_op_DeleteImage.go +++ b/service/imagebuilder/api_op_DeleteImage.go @@ -64,12 +64,12 @@ type DeleteImageInput struct { type DeleteImageOutput struct { - // The request ID that uniquely identifies this request. - RequestId *string - // The Amazon Resource Name (ARN) of the image that was deleted. ImageBuildVersionArn *string + // The request ID that uniquely identifies this request. + RequestId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/imagebuilder/api_op_DeleteInfrastructureConfiguration.go b/service/imagebuilder/api_op_DeleteInfrastructureConfiguration.go index 90680039b4a..91082a44a43 100644 --- a/service/imagebuilder/api_op_DeleteInfrastructureConfiguration.go +++ b/service/imagebuilder/api_op_DeleteInfrastructureConfiguration.go @@ -64,13 +64,13 @@ type DeleteInfrastructureConfigurationInput struct { type DeleteInfrastructureConfigurationOutput struct { - // The request ID that uniquely identifies this request. - RequestId *string - // The Amazon Resource Name (ARN) of the infrastructure configuration that was // deleted. InfrastructureConfigurationArn *string + // The request ID that uniquely identifies this request. + RequestId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/imagebuilder/api_op_GetDistributionConfiguration.go b/service/imagebuilder/api_op_GetDistributionConfiguration.go index 9b875d0f480..1a0d4048488 100644 --- a/service/imagebuilder/api_op_GetDistributionConfiguration.go +++ b/service/imagebuilder/api_op_GetDistributionConfiguration.go @@ -66,12 +66,12 @@ type GetDistributionConfigurationInput struct { type GetDistributionConfigurationOutput struct { - // The request ID that uniquely identifies this request. - RequestId *string - // The distribution configuration object. DistributionConfiguration *types.DistributionConfiguration + // The request ID that uniquely identifies this request. + RequestId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/imagebuilder/api_op_GetImagePipeline.go b/service/imagebuilder/api_op_GetImagePipeline.go index 44849372f64..ea01deef6a2 100644 --- a/service/imagebuilder/api_op_GetImagePipeline.go +++ b/service/imagebuilder/api_op_GetImagePipeline.go @@ -65,12 +65,12 @@ type GetImagePipelineInput struct { type GetImagePipelineOutput struct { - // The request ID that uniquely identifies this request. - RequestId *string - // The image pipeline object. ImagePipeline *types.ImagePipeline + // The request ID that uniquely identifies this request. + RequestId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/imagebuilder/api_op_GetImagePolicy.go b/service/imagebuilder/api_op_GetImagePolicy.go index 8e8f1eaf02e..8a91f095c8c 100644 --- a/service/imagebuilder/api_op_GetImagePolicy.go +++ b/service/imagebuilder/api_op_GetImagePolicy.go @@ -64,12 +64,12 @@ type GetImagePolicyInput struct { type GetImagePolicyOutput struct { - // The request ID that uniquely identifies this request. - RequestId *string - // The image policy object. Policy *string + // The request ID that uniquely identifies this request. + RequestId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/imagebuilder/api_op_GetImageRecipe.go b/service/imagebuilder/api_op_GetImageRecipe.go index ebbce646490..c0c4c790e4a 100644 --- a/service/imagebuilder/api_op_GetImageRecipe.go +++ b/service/imagebuilder/api_op_GetImageRecipe.go @@ -65,12 +65,12 @@ type GetImageRecipeInput struct { type GetImageRecipeOutput struct { - // The request ID that uniquely identifies this request. - RequestId *string - // The image recipe object. ImageRecipe *types.ImageRecipe + // The request ID that uniquely identifies this request. + RequestId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/imagebuilder/api_op_GetImageRecipePolicy.go b/service/imagebuilder/api_op_GetImageRecipePolicy.go index 0edd4392f66..4a51d6c88e2 100644 --- a/service/imagebuilder/api_op_GetImageRecipePolicy.go +++ b/service/imagebuilder/api_op_GetImageRecipePolicy.go @@ -65,12 +65,12 @@ type GetImageRecipePolicyInput struct { type GetImageRecipePolicyOutput struct { - // The request ID that uniquely identifies this request. - RequestId *string - // The image recipe policy object. Policy *string + // The request ID that uniquely identifies this request. + RequestId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/imagebuilder/api_op_ImportComponent.go b/service/imagebuilder/api_op_ImportComponent.go index d12e92ee83d..5f17bb9a23e 100644 --- a/service/imagebuilder/api_op_ImportComponent.go +++ b/service/imagebuilder/api_op_ImportComponent.go @@ -59,75 +59,75 @@ func (c *Client) ImportComponent(ctx context.Context, params *ImportComponentInp type ImportComponentInput struct { - // The semantic version of the component. This version follows the semantic version - // syntax. For example, major.minor.patch. This could be versioned like software - // (2.0.1) or like a date (2019.12.01). + // The idempotency token of the component. // // This member is required. - SemanticVersion *string + ClientToken *string + + // The format of the resource that you want to import as a component. + // + // This member is required. + Format types.ComponentFormat // The name of the component. // // This member is required. Name *string - // The uri of the component. Must be an S3 URL and the requester must have - // permission to access the S3 bucket. If you use S3, you can specify component - // content up to your service quota. Either data or uri can be used to specify the - // data within the component. - Uri *string - // The platform of the component. // // This member is required. Platform types.Platform - // The type of the component denotes whether the component is used to build the - // image or only to test it. + // The semantic version of the component. This version follows the semantic version + // syntax. For example, major.minor.patch. This could be versioned like software + // (2.0.1) or like a date (2019.12.01). // // This member is required. - Type types.ComponentType - - // The description of the component. Describes the contents of the component. - Description *string - - // The tags of the component. - Tags map[string]*string + SemanticVersion *string - // The idempotency token of the component. + // The type of the component denotes whether the component is used to build the + // image or only to test it. // // This member is required. - ClientToken *string + Type types.ComponentType // The change description of the component. Describes what change has been made in // this version, or what makes this version different from other versions of this // component. ChangeDescription *string + // The data of the component. Used to specify the data inline. Either data or uri + // can be used to specify the data within the component. + Data *string + + // The description of the component. Describes the contents of the component. + Description *string + // The ID of the KMS key that should be used to encrypt this component. KmsKeyId *string - // The format of the resource that you want to import as a component. - // - // This member is required. - Format types.ComponentFormat + // The tags of the component. + Tags map[string]*string - // The data of the component. Used to specify the data inline. Either data or uri - // can be used to specify the data within the component. - Data *string + // The uri of the component. Must be an S3 URL and the requester must have + // permission to access the S3 bucket. If you use S3, you can specify component + // content up to your service quota. Either data or uri can be used to specify the + // data within the component. + Uri *string } type ImportComponentOutput struct { - // The request ID that uniquely identifies this request. - RequestId *string - // The idempotency token used to make this request idempotent. ClientToken *string // The Amazon Resource Name (ARN) of the imported component. ComponentBuildVersionArn *string + // The request ID that uniquely identifies this request. + RequestId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/imagebuilder/api_op_ListComponentBuildVersions.go b/service/imagebuilder/api_op_ListComponentBuildVersions.go index 45590d2d79a..df873efe580 100644 --- a/service/imagebuilder/api_op_ListComponentBuildVersions.go +++ b/service/imagebuilder/api_op_ListComponentBuildVersions.go @@ -57,32 +57,32 @@ func (c *Client) ListComponentBuildVersions(ctx context.Context, params *ListCom type ListComponentBuildVersionsInput struct { + // The component version Amazon Resource Name (ARN) whose versions you want to + // list. + // + // This member is required. + ComponentVersionArn *string + // The maximum items to return in a request. MaxResults *int32 // A token to specify where to start paginating. This is the NextToken from a // previously truncated response. NextToken *string - - // The component version Amazon Resource Name (ARN) whose versions you want to - // list. - // - // This member is required. - ComponentVersionArn *string } type ListComponentBuildVersionsOutput struct { - // The request ID that uniquely identifies this request. - RequestId *string + // The list of component summaries for the specified semantic version. + ComponentSummaryList []*types.ComponentSummary // The next token used for paginated responses. When this is not empty, there are // additional elements that the service has not included in this request. Use this // token with the next request to retrieve additional objects. NextToken *string - // The list of component summaries for the specified semantic version. - ComponentSummaryList []*types.ComponentSummary + // The request ID that uniquely identifies this request. + RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/imagebuilder/api_op_ListComponents.go b/service/imagebuilder/api_op_ListComponents.go index 6cc11c3b2cb..09295bc30eb 100644 --- a/service/imagebuilder/api_op_ListComponents.go +++ b/service/imagebuilder/api_op_ListComponents.go @@ -56,21 +56,21 @@ func (c *Client) ListComponents(ctx context.Context, params *ListComponentsInput type ListComponentsInput struct { + // The filters. + Filters []*types.Filter + // The maximum items to return in a request. MaxResults *int32 + // A token to specify where to start paginating. This is the NextToken from a + // previously truncated response. + NextToken *string + // The owner defines which components you want to list. By default, this request // will only show components owned by your account. You can use this field to // specify if you want to view components owned by yourself, by Amazon, or those // components that have been shared with you by other customers. Owner types.Ownership - - // A token to specify where to start paginating. This is the NextToken from a - // previously truncated response. - NextToken *string - - // The filters. - Filters []*types.Filter } type ListComponentsOutput struct { @@ -78,14 +78,14 @@ type ListComponentsOutput struct { // The list of component semantic versions. ComponentVersionList []*types.ComponentVersion - // The request ID that uniquely identifies this request. - RequestId *string - // The next token used for paginated responses. When this is not empty, there are // additional elements that the service has not included in this request. Use this // token with the next request to retrieve additional objects. NextToken *string + // The request ID that uniquely identifies this request. + RequestId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/imagebuilder/api_op_ListDistributionConfigurations.go b/service/imagebuilder/api_op_ListDistributionConfigurations.go index 8d9936f9277..cf301ca8443 100644 --- a/service/imagebuilder/api_op_ListDistributionConfigurations.go +++ b/service/imagebuilder/api_op_ListDistributionConfigurations.go @@ -56,29 +56,29 @@ func (c *Client) ListDistributionConfigurations(ctx context.Context, params *Lis type ListDistributionConfigurationsInput struct { + // The filters. + // + // * name - The name of this distribution configuration. + Filters []*types.Filter + // The maximum items to return in a request. MaxResults *int32 // A token to specify where to start paginating. This is the NextToken from a // previously truncated response. NextToken *string - - // The filters. - // - // * name - The name of this distribution configuration. - Filters []*types.Filter } type ListDistributionConfigurationsOutput struct { + // The list of distributions. + DistributionConfigurationSummaryList []*types.DistributionConfigurationSummary + // The next token used for paginated responses. When this is not empty, there are // additional elements that the service has not included in this request. Use this // token with the next request to retrieve additional objects. NextToken *string - // The list of distributions. - DistributionConfigurationSummaryList []*types.DistributionConfigurationSummary - // The request ID that uniquely identifies this request. RequestId *string diff --git a/service/imagebuilder/api_op_ListImageBuildVersions.go b/service/imagebuilder/api_op_ListImageBuildVersions.go index 635df576390..c3eaea9fc69 100644 --- a/service/imagebuilder/api_op_ListImageBuildVersions.go +++ b/service/imagebuilder/api_op_ListImageBuildVersions.go @@ -57,21 +57,21 @@ func (c *Client) ListImageBuildVersions(ctx context.Context, params *ListImageBu type ListImageBuildVersionsInput struct { - // A token to specify where to start paginating. This is the NextToken from a - // previously truncated response. - NextToken *string - - // The filters. - Filters []*types.Filter - // The Amazon Resource Name (ARN) of the image whose build versions you want to // retrieve. // // This member is required. ImageVersionArn *string + // The filters. + Filters []*types.Filter + // The maximum items to return in a request. MaxResults *int32 + + // A token to specify where to start paginating. This is the NextToken from a + // previously truncated response. + NextToken *string } type ListImageBuildVersionsOutput struct { diff --git a/service/imagebuilder/api_op_ListImagePipelineImages.go b/service/imagebuilder/api_op_ListImagePipelineImages.go index 33352c8df0f..469b564e649 100644 --- a/service/imagebuilder/api_op_ListImagePipelineImages.go +++ b/service/imagebuilder/api_op_ListImagePipelineImages.go @@ -57,9 +57,6 @@ func (c *Client) ListImagePipelineImages(ctx context.Context, params *ListImageP type ListImagePipelineImagesInput struct { - // The maximum items to return in a request. - MaxResults *int32 - // The Amazon Resource Name (ARN) of the image pipeline whose images you want to // view. // @@ -69,6 +66,9 @@ type ListImagePipelineImagesInput struct { // The filters. Filters []*types.Filter + // The maximum items to return in a request. + MaxResults *int32 + // A token to specify where to start paginating. This is the NextToken from a // previously truncated response. NextToken *string @@ -76,16 +76,16 @@ type ListImagePipelineImagesInput struct { type ListImagePipelineImagesOutput struct { - // The request ID that uniquely identifies this request. - RequestId *string + // The list of images built by this pipeline. + ImageSummaryList []*types.ImageSummary // The next token used for paginated responses. When this is not empty, there are // additional elements that the service has not included in this request. Use this // token with the next request to retrieve additional objects. NextToken *string - // The list of images built by this pipeline. - ImageSummaryList []*types.ImageSummary + // The request ID that uniquely identifies this request. + RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/imagebuilder/api_op_ListImagePipelines.go b/service/imagebuilder/api_op_ListImagePipelines.go index c843c619c29..6344506ed37 100644 --- a/service/imagebuilder/api_op_ListImagePipelines.go +++ b/service/imagebuilder/api_op_ListImagePipelines.go @@ -56,29 +56,29 @@ func (c *Client) ListImagePipelines(ctx context.Context, params *ListImagePipeli type ListImagePipelinesInput struct { - // A token to specify where to start paginating. This is the NextToken from a - // previously truncated response. - NextToken *string - // The filters. Filters []*types.Filter // The maximum items to return in a request. MaxResults *int32 + + // A token to specify where to start paginating. This is the NextToken from a + // previously truncated response. + NextToken *string } type ListImagePipelinesOutput struct { - // The request ID that uniquely identifies this request. - RequestId *string + // The list of image pipelines. + ImagePipelineList []*types.ImagePipeline // The next token used for paginated responses. When this is not empty, there are // additional elements that the service has not included in this request. Use this // token with the next request to retrieve additional objects. NextToken *string - // The list of image pipelines. - ImagePipelineList []*types.ImagePipeline + // The request ID that uniquely identifies this request. + RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/imagebuilder/api_op_ListImageRecipes.go b/service/imagebuilder/api_op_ListImageRecipes.go index d05837127b7..4ef37f05c68 100644 --- a/service/imagebuilder/api_op_ListImageRecipes.go +++ b/service/imagebuilder/api_op_ListImageRecipes.go @@ -56,35 +56,35 @@ func (c *Client) ListImageRecipes(ctx context.Context, params *ListImageRecipesI type ListImageRecipesInput struct { + // The filters. + Filters []*types.Filter + // The maximum items to return in a request. MaxResults *int32 + // A token to specify where to start paginating. This is the NextToken from a + // previously truncated response. + NextToken *string + // The owner defines which image recipes you want to list. By default, this request // will only show image recipes owned by your account. You can use this field to // specify if you want to view image recipes owned by yourself, by Amazon, or those // image recipes that have been shared with you by other customers. Owner types.Ownership - - // The filters. - Filters []*types.Filter - - // A token to specify where to start paginating. This is the NextToken from a - // previously truncated response. - NextToken *string } type ListImageRecipesOutput struct { - // The request ID that uniquely identifies this request. - RequestId *string + // The list of image pipelines. + ImageRecipeSummaryList []*types.ImageRecipeSummary // The next token used for paginated responses. When this is not empty, there are // additional elements that the service has not included in this request. Use this // token with the next request to retrieve additional objects. NextToken *string - // The list of image pipelines. - ImageRecipeSummaryList []*types.ImageRecipeSummary + // The request ID that uniquely identifies this request. + RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/imagebuilder/api_op_ListImages.go b/service/imagebuilder/api_op_ListImages.go index f0b2edab064..d40d3bca94d 100644 --- a/service/imagebuilder/api_op_ListImages.go +++ b/service/imagebuilder/api_op_ListImages.go @@ -56,28 +56,25 @@ func (c *Client) ListImages(ctx context.Context, params *ListImagesInput, optFns type ListImagesInput struct { - // A token to specify where to start paginating. This is the NextToken from a - // previously truncated response. - NextToken *string + // The filters. + Filters []*types.Filter // The maximum items to return in a request. MaxResults *int32 + // A token to specify where to start paginating. This is the NextToken from a + // previously truncated response. + NextToken *string + // The owner defines which images you want to list. By default, this request will // only show images owned by your account. You can use this field to specify if you // want to view images owned by yourself, by Amazon, or those images that have been // shared with you by other customers. Owner types.Ownership - - // The filters. - Filters []*types.Filter } type ListImagesOutput struct { - // The request ID that uniquely identifies this request. - RequestId *string - // The list of image semantic versions. ImageVersionList []*types.ImageVersion @@ -86,6 +83,9 @@ type ListImagesOutput struct { // token with the next request to retrieve additional objects. NextToken *string + // The request ID that uniquely identifies this request. + RequestId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/imagebuilder/api_op_ListInfrastructureConfigurations.go b/service/imagebuilder/api_op_ListInfrastructureConfigurations.go index f7c947020bb..4d3a6c7f1a9 100644 --- a/service/imagebuilder/api_op_ListInfrastructureConfigurations.go +++ b/service/imagebuilder/api_op_ListInfrastructureConfigurations.go @@ -56,12 +56,12 @@ func (c *Client) ListInfrastructureConfigurations(ctx context.Context, params *L type ListInfrastructureConfigurationsInput struct { - // The maximum items to return in a request. - MaxResults *int32 - // The filters. Filters []*types.Filter + // The maximum items to return in a request. + MaxResults *int32 + // A token to specify where to start paginating. This is the NextToken from a // previously truncated response. NextToken *string @@ -69,9 +69,6 @@ type ListInfrastructureConfigurationsInput struct { type ListInfrastructureConfigurationsOutput struct { - // The request ID that uniquely identifies this request. - RequestId *string - // The list of infrastructure configurations. InfrastructureConfigurationSummaryList []*types.InfrastructureConfigurationSummary @@ -80,6 +77,9 @@ type ListInfrastructureConfigurationsOutput struct { // token with the next request to retrieve additional objects. NextToken *string + // The request ID that uniquely identifies this request. + RequestId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/imagebuilder/api_op_PutComponentPolicy.go b/service/imagebuilder/api_op_PutComponentPolicy.go index 1538373d5ff..d6081360ee3 100644 --- a/service/imagebuilder/api_op_PutComponentPolicy.go +++ b/service/imagebuilder/api_op_PutComponentPolicy.go @@ -63,26 +63,26 @@ func (c *Client) PutComponentPolicy(ctx context.Context, params *PutComponentPol type PutComponentPolicyInput struct { - // The policy to apply. - // - // This member is required. - Policy *string - // The Amazon Resource Name (ARN) of the component that this policy should be // applied to. // // This member is required. ComponentArn *string + + // The policy to apply. + // + // This member is required. + Policy *string } type PutComponentPolicyOutput struct { - // The request ID that uniquely identifies this request. - RequestId *string - // The Amazon Resource Name (ARN) of the component that this policy was applied to. ComponentArn *string + // The request ID that uniquely identifies this request. + RequestId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/imagebuilder/api_op_PutImageRecipePolicy.go b/service/imagebuilder/api_op_PutImageRecipePolicy.go index 0a7ecb884ce..d7d225e326e 100644 --- a/service/imagebuilder/api_op_PutImageRecipePolicy.go +++ b/service/imagebuilder/api_op_PutImageRecipePolicy.go @@ -63,16 +63,16 @@ func (c *Client) PutImageRecipePolicy(ctx context.Context, params *PutImageRecip type PutImageRecipePolicyInput struct { - // The policy to apply. - // - // This member is required. - Policy *string - // The Amazon Resource Name (ARN) of the image recipe that this policy should be // applied to. // // This member is required. ImageRecipeArn *string + + // The policy to apply. + // + // This member is required. + Policy *string } type PutImageRecipePolicyOutput struct { diff --git a/service/imagebuilder/api_op_StartImagePipelineExecution.go b/service/imagebuilder/api_op_StartImagePipelineExecution.go index 2af1e587007..2a3c6296779 100644 --- a/service/imagebuilder/api_op_StartImagePipelineExecution.go +++ b/service/imagebuilder/api_op_StartImagePipelineExecution.go @@ -75,12 +75,12 @@ type StartImagePipelineExecutionOutput struct { // The idempotency token used to make this request idempotent. ClientToken *string - // The request ID that uniquely identifies this request. - RequestId *string - // The Amazon Resource Name (ARN) of the image that was created by this request. ImageBuildVersionArn *string + // The request ID that uniquely identifies this request. + RequestId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/imagebuilder/api_op_UntagResource.go b/service/imagebuilder/api_op_UntagResource.go index b96e91a5a60..0b4ab8bd939 100644 --- a/service/imagebuilder/api_op_UntagResource.go +++ b/service/imagebuilder/api_op_UntagResource.go @@ -56,15 +56,15 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The tag keys to remove from the resource. + // The Amazon Resource Name (ARN) of the resource that you want to untag. // // This member is required. - TagKeys []*string + ResourceArn *string - // The Amazon Resource Name (ARN) of the resource that you want to untag. + // The tag keys to remove from the resource. // // This member is required. - ResourceArn *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/imagebuilder/api_op_UpdateDistributionConfiguration.go b/service/imagebuilder/api_op_UpdateDistributionConfiguration.go index 18bb32c2458..362d8c4412f 100644 --- a/service/imagebuilder/api_op_UpdateDistributionConfiguration.go +++ b/service/imagebuilder/api_op_UpdateDistributionConfiguration.go @@ -60,28 +60,31 @@ func (c *Client) UpdateDistributionConfiguration(ctx context.Context, params *Up type UpdateDistributionConfigurationInput struct { + // The idempotency token of the distribution configuration. + // + // This member is required. + ClientToken *string + // The Amazon Resource Name (ARN) of the distribution configuration that you want // to update. // // This member is required. DistributionConfigurationArn *string - // The description of the distribution configuration. - Description *string - // The distributions of the distribution configuration. // // This member is required. Distributions []*types.Distribution - // The idempotency token of the distribution configuration. - // - // This member is required. - ClientToken *string + // The description of the distribution configuration. + Description *string } type UpdateDistributionConfigurationOutput struct { + // The idempotency token used to make this request idempotent. + ClientToken *string + // The Amazon Resource Name (ARN) of the distribution configuration that was // updated by this request. DistributionConfigurationArn *string @@ -89,9 +92,6 @@ type UpdateDistributionConfigurationOutput struct { // The request ID that uniquely identifies this request. RequestId *string - // The idempotency token used to make this request idempotent. - ClientToken *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/imagebuilder/api_op_UpdateImagePipeline.go b/service/imagebuilder/api_op_UpdateImagePipeline.go index 5fedd1e90cc..7bc00ff7ef0 100644 --- a/service/imagebuilder/api_op_UpdateImagePipeline.go +++ b/service/imagebuilder/api_op_UpdateImagePipeline.go @@ -60,28 +60,21 @@ func (c *Client) UpdateImagePipeline(ctx context.Context, params *UpdateImagePip type UpdateImagePipelineInput struct { - // The description of the image pipeline. - Description *string - // The idempotency token used to make this request idempotent. // // This member is required. ClientToken *string - // The status of the image pipeline. - Status types.PipelineStatus - - // The image test configuration of the image pipeline. - ImageTestsConfiguration *types.ImageTestsConfiguration - - // Collects additional information about the image being created, including the - // operating system (OS) version and package list. This information is used to - // enhance the overall experience of using EC2 Image Builder. Enabled by default. - EnhancedImageMetadataEnabled *bool + // The Amazon Resource Name (ARN) of the image pipeline that you want to update. + // + // This member is required. + ImagePipelineArn *string - // The Amazon Resource Name (ARN) of the distribution configuration that will be - // used to configure and distribute images updated by this image pipeline. - DistributionConfigurationArn *string + // The Amazon Resource Name (ARN) of the image recipe that will be used to + // configure images updated by this image pipeline. + // + // This member is required. + ImageRecipeArn *string // The Amazon Resource Name (ARN) of the infrastructure configuration that will be // used to build images updated by this image pipeline. @@ -89,19 +82,26 @@ type UpdateImagePipelineInput struct { // This member is required. InfrastructureConfigurationArn *string - // The Amazon Resource Name (ARN) of the image pipeline that you want to update. - // - // This member is required. - ImagePipelineArn *string + // The description of the image pipeline. + Description *string + + // The Amazon Resource Name (ARN) of the distribution configuration that will be + // used to configure and distribute images updated by this image pipeline. + DistributionConfigurationArn *string + + // Collects additional information about the image being created, including the + // operating system (OS) version and package list. This information is used to + // enhance the overall experience of using EC2 Image Builder. Enabled by default. + EnhancedImageMetadataEnabled *bool + + // The image test configuration of the image pipeline. + ImageTestsConfiguration *types.ImageTestsConfiguration // The schedule of the image pipeline. Schedule *types.Schedule - // The Amazon Resource Name (ARN) of the image recipe that will be used to - // configure images updated by this image pipeline. - // - // This member is required. - ImageRecipeArn *string + // The status of the image pipeline. + Status types.PipelineStatus } type UpdateImagePipelineOutput struct { @@ -109,13 +109,13 @@ type UpdateImagePipelineOutput struct { // The idempotency token used to make this request idempotent. ClientToken *string - // The request ID that uniquely identifies this request. - RequestId *string - // The Amazon Resource Name (ARN) of the image pipeline that was updated by this // request. ImagePipelineArn *string + // The request ID that uniquely identifies this request. + RequestId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/imagebuilder/api_op_UpdateInfrastructureConfiguration.go b/service/imagebuilder/api_op_UpdateInfrastructureConfiguration.go index 20b332e130b..75c8d644f07 100644 --- a/service/imagebuilder/api_op_UpdateInfrastructureConfiguration.go +++ b/service/imagebuilder/api_op_UpdateInfrastructureConfiguration.go @@ -60,23 +60,16 @@ func (c *Client) UpdateInfrastructureConfiguration(ctx context.Context, params * type UpdateInfrastructureConfigurationInput struct { - // The terminate instance on failure setting of the infrastructure configuration. - // Set to false if you want Image Builder to retain the instance used to configure - // your AMI if the build or test phase of your workflow fails. - TerminateInstanceOnFailure *bool - - // The tags attached to the resource created by Image Builder. - ResourceTags map[string]*string - - // The subnet ID to place the instance used to customize your EC2 AMI in. - SubnetId *string - - // The description of the infrastructure configuration. - Description *string + // The idempotency token used to make this request idempotent. + // + // This member is required. + ClientToken *string - // The key pair of the infrastructure configuration. This can be used to log on to - // and debug the instance used to create your image. - KeyPair *string + // The Amazon Resource Name (ARN) of the infrastructure configuration that you want + // to update. + // + // This member is required. + InfrastructureConfigurationArn *string // The instance profile to associate with the instance used to customize your EC2 // AMI. @@ -84,31 +77,38 @@ type UpdateInfrastructureConfigurationInput struct { // This member is required. InstanceProfileName *string - // The idempotency token used to make this request idempotent. - // - // This member is required. - ClientToken *string - - // The logging configuration of the infrastructure configuration. - Logging *types.Logging + // The description of the infrastructure configuration. + Description *string // The instance types of the infrastructure configuration. You can specify one or // more instance types to use for this build. The service will pick one of these // instance types based on availability. InstanceTypes []*string - // The SNS topic on which to send image build events. - SnsTopicArn *string + // The key pair of the infrastructure configuration. This can be used to log on to + // and debug the instance used to create your image. + KeyPair *string - // The Amazon Resource Name (ARN) of the infrastructure configuration that you want - // to update. - // - // This member is required. - InfrastructureConfigurationArn *string + // The logging configuration of the infrastructure configuration. + Logging *types.Logging + + // The tags attached to the resource created by Image Builder. + ResourceTags map[string]*string // The security group IDs to associate with the instance used to customize your EC2 // AMI. SecurityGroupIds []*string + + // The SNS topic on which to send image build events. + SnsTopicArn *string + + // The subnet ID to place the instance used to customize your EC2 AMI in. + SubnetId *string + + // The terminate instance on failure setting of the infrastructure configuration. + // Set to false if you want Image Builder to retain the instance used to configure + // your AMI if the build or test phase of your workflow fails. + TerminateInstanceOnFailure *bool } type UpdateInfrastructureConfigurationOutput struct { diff --git a/service/imagebuilder/go.mod b/service/imagebuilder/go.mod index da243eed35e..01172dd5cd0 100644 --- a/service/imagebuilder/go.mod +++ b/service/imagebuilder/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/imagebuilder go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/imagebuilder/types/types.go b/service/imagebuilder/types/types.go index 97e05bc3ec1..828bff9eba6 100644 --- a/service/imagebuilder/types/types.go +++ b/service/imagebuilder/types/types.go @@ -11,14 +11,14 @@ type Ami struct { // The AMI ID of the EC2 AMI. Image *string - // Image state shows the image status and the reason for that status. - State *ImageState - // The name of the EC2 AMI. Name *string // The AWS Region of the EC2 AMI. Region *string + + // Image state shows the image status and the reason for that status. + State *ImageState } // Define and configure the output AMIs of the pipeline. @@ -30,46 +30,28 @@ type AmiDistributionConfiguration struct { // The description of the distribution configuration. Description *string - // The name of the distribution configuration. - Name *string + // The KMS key identifier used to encrypt the distributed image. + KmsKeyId *string // Launch permissions can be used to configure which AWS accounts can use the AMI // to launch instances. LaunchPermission *LaunchPermissionConfiguration - // The KMS key identifier used to encrypt the distributed image. - KmsKeyId *string + // The name of the distribution configuration. + Name *string } // A detailed view of a component. type Component struct { - // The owner of the component. - Owner *string - - // The change description of the component. - ChangeDescription *string - // The Amazon Resource Name (ARN) of the component. Arn *string - // The tags associated with the component. - Tags map[string]*string - - // The type of the component denotes whether the component is used to build the - // image or only to test it. - Type ComponentType - - // The platform of the component. - Platform Platform - - // The version of the component. - Version *string + // The change description of the component. + ChangeDescription *string - // The operating system (OS) version supported by the component. If the OS - // information is available, a prefix match is performed against the parent image - // OS version during image recipe creation. - SupportedOsVersions []*string + // The data of the component. + Data *string // The date that the component was created. DateCreated *string @@ -77,17 +59,35 @@ type Component struct { // The description of the component. Description *string + // The encryption status of the component. + Encrypted *bool + // The KMS key identifier used to encrypt the component. KmsKeyId *string // The name of the component. Name *string - // The encryption status of the component. - Encrypted *bool + // The owner of the component. + Owner *string - // The data of the component. - Data *string + // The platform of the component. + Platform Platform + + // The operating system (OS) version supported by the component. If the OS + // information is available, a prefix match is performed against the parent image + // OS version during image recipe creation. + SupportedOsVersions []*string + + // The tags associated with the component. + Tags map[string]*string + + // The type of the component denotes whether the component is used to build the + // image or only to test it. + Type ComponentType + + // The version of the component. + Version *string } // Configuration details of the component. @@ -102,59 +102,48 @@ type ComponentConfiguration struct { // A high-level summary of a component. type ComponentSummary struct { - // The name of the component. - Name *string - - // The description of the component. - Description *string - - // The type of the component denotes whether the component is used to build the - // image or only to test it. - Type ComponentType - - // The tags associated with the component. - Tags map[string]*string - - // The version of the component. - Version *string - // The Amazon Resource Name (ARN) of the component. Arn *string - // The platform of the component. - Platform Platform - - // The owner of the component. - Owner *string - // The change description of the component. ChangeDescription *string // The date that the component was created. DateCreated *string - // The operating system (OS) version supported by the component. If the OS - // information is available, a prefix match is performed against the parent image - // OS version during image recipe creation. - SupportedOsVersions []*string -} - -// A high-level overview of a component semantic version. -type ComponentVersion struct { + // The description of the component. + Description *string - // The Amazon Resource Name (ARN) of the component. - Arn *string + // The name of the component. + Name *string // The owner of the component. Owner *string + // The platform of the component. + Platform Platform + // The operating system (OS) version supported by the component. If the OS // information is available, a prefix match is performed against the parent image // OS version during image recipe creation. SupportedOsVersions []*string - // The semantic version of the component. + // The tags associated with the component. + Tags map[string]*string + + // The type of the component denotes whether the component is used to build the + // image or only to test it. + Type ComponentType + + // The version of the component. Version *string +} + +// A high-level overview of a component semantic version. +type ComponentVersion struct { + + // The Amazon Resource Name (ARN) of the component. + Arn *string // The date that the component was created. DateCreated *string @@ -165,58 +154,69 @@ type ComponentVersion struct { // The name of the component. Name *string + // The owner of the component. + Owner *string + // The platform of the component. Platform Platform + // The operating system (OS) version supported by the component. If the OS + // information is available, a prefix match is performed against the parent image + // OS version during image recipe creation. + SupportedOsVersions []*string + // The type of the component denotes whether the component is used to build the // image or only to test it. Type ComponentType + + // The semantic version of the component. + Version *string } // Defines the settings for a specific Region. type Distribution struct { + // The target Region. + // + // This member is required. + Region *string + // The specific AMI settings (for example, launch permissions, AMI tags). AmiDistributionConfiguration *AmiDistributionConfiguration // The License Manager Configuration to associate with the AMI in the specified // Region. LicenseConfigurationArns []*string - - // The target Region. - // - // This member is required. - Region *string } // A distribution configuration. type DistributionConfiguration struct { - // The description of the distribution configuration. - Description *string - // The maximum duration in minutes for this distribution configuration. // // This member is required. TimeoutMinutes *int32 - // The name of the distribution configuration. - Name *string - // The Amazon Resource Name (ARN) of the distribution configuration. Arn *string + // The date on which this distribution configuration was created. + DateCreated *string + // The date on which this distribution configuration was last updated. DateUpdated *string - // The tags of the distribution configuration. - Tags map[string]*string + // The description of the distribution configuration. + Description *string // The distributions of the distribution configuration. Distributions []*Distribution - // The date on which this distribution configuration was created. - DateCreated *string + // The name of the distribution configuration. + Name *string + + // The tags of the distribution configuration. + Tags map[string]*string } // A high-level overview of a distribution configuration. @@ -225,12 +225,12 @@ type DistributionConfigurationSummary struct { // The Amazon Resource Name (ARN) of the distribution configuration. Arn *string - // The date on which the distribution configuration was updated. - DateUpdated *string - // The date on which the distribution configuration was created. DateCreated *string + // The date on which the distribution configuration was updated. + DateUpdated *string + // The description of the distribution configuration. Description *string @@ -247,23 +247,23 @@ type EbsInstanceBlockDeviceSpecification struct { // Use to configure delete on termination of the associated device. DeleteOnTermination *bool - // Use to override the device's volume type. - VolumeType EbsVolumeType - - // Use to configure the KMS key to use when encrypting the device. - KmsKeyId *string + // Use to configure device encryption. + Encrypted *bool // Use to configure device IOPS. Iops *int32 + // Use to configure the KMS key to use when encrypting the device. + KmsKeyId *string + // The snapshot that defines the device contents. SnapshotId *string - // Use to configure device encryption. - Encrypted *bool - // Use to override the device's volume size. VolumeSize *int32 + + // Use to override the device's volume type. + VolumeType EbsVolumeType } // A filter name and value pair that is used to return a more specific list of @@ -281,26 +281,22 @@ type Filter struct { // An image build version. type Image struct { - // The distribution configuration used when creating this image. - DistributionConfiguration *DistributionConfiguration - - // The name of the image pipeline that created this image. - SourcePipelineName *string - - // The output resources produced when creating this image. - OutputResources *OutputResources + // The Amazon Resource Name (ARN) of the image. + Arn *string - // The Amazon Resource Name (ARN) of the image pipeline that created this image. - SourcePipelineArn *string + // The date on which this image was created. + DateCreated *string - // The platform of the image. - Platform Platform + // The distribution configuration used when creating this image. + DistributionConfiguration *DistributionConfiguration - // The tags of the image. - Tags map[string]*string + // Collects additional information about the image being created, including the + // operating system (OS) version and package list. This information is used to + // enhance the overall experience of using EC2 Image Builder. Enabled by default. + EnhancedImageMetadataEnabled *bool - // The semantic version of the image. - Version *string + // The image recipe used when creating the image. + ImageRecipe *ImageRecipe // The image tests configuration used when creating this image. ImageTestsConfiguration *ImageTestsConfiguration @@ -308,29 +304,33 @@ type Image struct { // The infrastructure used when creating this image. InfrastructureConfiguration *InfrastructureConfiguration - // The image recipe used when creating the image. - ImageRecipe *ImageRecipe - - // The date on which this image was created. - DateCreated *string + // The name of the image. + Name *string // The operating system version of the instance. For example, Amazon Linux 2, // Ubuntu 18, or Microsoft Windows Server 2019. OsVersion *string + // The output resources produced when creating this image. + OutputResources *OutputResources + + // The platform of the image. + Platform Platform + + // The Amazon Resource Name (ARN) of the image pipeline that created this image. + SourcePipelineArn *string + + // The name of the image pipeline that created this image. + SourcePipelineName *string + // The state of the image. State *ImageState - // The name of the image. - Name *string - - // Collects additional information about the image being created, including the - // operating system (OS) version and package list. This information is used to - // enhance the overall experience of using EC2 Image Builder. Enabled by default. - EnhancedImageMetadataEnabled *bool + // The tags of the image. + Tags map[string]*string - // The Amazon Resource Name (ARN) of the image. - Arn *string + // The semantic version of the image. + Version *string } // Details of an image pipeline. @@ -339,290 +339,290 @@ type ImagePipeline struct { // The Amazon Resource Name (ARN) of the image pipeline. Arn *string - // The status of the image pipeline. - Status PipelineStatus + // The date on which this image pipeline was created. + DateCreated *string - // Collects additional information about the image being created, including the - // operating system (OS) version and package list. This information is used to - // enhance the overall experience of using EC2 Image Builder. Enabled by default. - EnhancedImageMetadataEnabled *bool + // The date on which this image pipeline was last run. + DateLastRun *string - // The tags of this image pipeline. - Tags map[string]*string + // The date on which this image pipeline will next be run. + DateNextRun *string + + // The date on which this image pipeline was last updated. + DateUpdated *string + + // The description of the image pipeline. + Description *string // The Amazon Resource Name (ARN) of the distribution configuration associated with // this image pipeline. DistributionConfigurationArn *string - // The date on which this image pipeline was created. - DateCreated *string + // Collects additional information about the image being created, including the + // operating system (OS) version and package list. This information is used to + // enhance the overall experience of using EC2 Image Builder. Enabled by default. + EnhancedImageMetadataEnabled *bool - // The schedule of the image pipeline. - Schedule *Schedule + // The Amazon Resource Name (ARN) of the image recipe associated with this image + // pipeline. + ImageRecipeArn *string // The image tests configuration of the image pipeline. ImageTestsConfiguration *ImageTestsConfiguration - // The platform of the image pipeline. - Platform Platform - - // The date on which this image pipeline was last updated. - DateUpdated *string + // The Amazon Resource Name (ARN) of the infrastructure configuration associated + // with this image pipeline. + InfrastructureConfigurationArn *string // The name of the image pipeline. Name *string - // The date on which this image pipeline will next be run. - DateNextRun *string - - // The description of the image pipeline. - Description *string + // The platform of the image pipeline. + Platform Platform - // The date on which this image pipeline was last run. - DateLastRun *string + // The schedule of the image pipeline. + Schedule *Schedule - // The Amazon Resource Name (ARN) of the infrastructure configuration associated - // with this image pipeline. - InfrastructureConfigurationArn *string + // The status of the image pipeline. + Status PipelineStatus - // The Amazon Resource Name (ARN) of the image recipe associated with this image - // pipeline. - ImageRecipeArn *string + // The tags of this image pipeline. + Tags map[string]*string } // An image recipe. type ImageRecipe struct { - // The owner of the image recipe. - Owner *string - - // The date on which this image recipe was created. - DateCreated *string + // The Amazon Resource Name (ARN) of the image recipe. + Arn *string // The block device mappings to apply when creating images from this recipe. BlockDeviceMappings []*InstanceBlockDeviceMapping - // The working directory to be used during build and test workflows. - WorkingDirectory *string - // The components of the image recipe. Components []*ComponentConfiguration + // The date on which this image recipe was created. + DateCreated *string + // The description of the image recipe. Description *string // The name of the image recipe. Name *string + // The owner of the image recipe. + Owner *string + // The parent image of the image recipe. ParentImage *string + // The platform of the image recipe. + Platform Platform + // The tags of the image recipe. Tags map[string]*string // The version of the image recipe. Version *string - // The Amazon Resource Name (ARN) of the image recipe. - Arn *string - - // The platform of the image recipe. - Platform Platform + // The working directory to be used during build and test workflows. + WorkingDirectory *string } // A summary of an image recipe. type ImageRecipeSummary struct { - // The platform of the image recipe. - Platform Platform + // The Amazon Resource Name (ARN) of the image recipe. + Arn *string - // The tags of the image recipe. - Tags map[string]*string + // The date on which this image recipe was created. + DateCreated *string // The name of the image recipe. Name *string - // The parent image of the image recipe. - ParentImage *string - // The owner of the image recipe. Owner *string - // The Amazon Resource Name (ARN) of the image recipe. - Arn *string + // The parent image of the image recipe. + ParentImage *string - // The date on which this image recipe was created. - DateCreated *string + // The platform of the image recipe. + Platform Platform + + // The tags of the image recipe. + Tags map[string]*string } // Image state shows the image status and the reason for that status. type ImageState struct { - // The status of the image. - Status ImageStatus - // The reason for the image's status. Reason *string + + // The status of the image. + Status ImageStatus } // An image summary. type ImageSummary struct { + // The Amazon Resource Name (ARN) of the image. + Arn *string + // The date on which this image was created. DateCreated *string - // The output resources produced when creating this image. - OutputResources *OutputResources - - // The tags of the image. - Tags map[string]*string - - // The owner of the image. - Owner *string + // The name of the image. + Name *string // The operating system version of the instance. For example, Amazon Linux 2, // Ubuntu 18, or Microsoft Windows Server 2019. OsVersion *string - // The version of the image. - Version *string + // The output resources produced when creating this image. + OutputResources *OutputResources + + // The owner of the image. + Owner *string // The platform of the image. Platform Platform - // The Amazon Resource Name (ARN) of the image. - Arn *string - - // The name of the image. - Name *string - // The state of the image. State *ImageState + + // The tags of the image. + Tags map[string]*string + + // The version of the image. + Version *string } // Image tests configuration. type ImageTestsConfiguration struct { - // The maximum time in minutes that tests are permitted to run. - TimeoutMinutes *int32 - // Defines if tests should be executed when building this image. ImageTestsEnabled *bool + + // The maximum time in minutes that tests are permitted to run. + TimeoutMinutes *int32 } // An image semantic version. type ImageVersion struct { - // The platform of the image semantic version. - Platform Platform + // The Amazon Resource Name (ARN) of the image semantic version. + Arn *string - // The operating system version of the instance. For example, Amazon Linux 2, - // Ubuntu 18, or Microsoft Windows Server 2019. - OsVersion *string + // The date at which this image semantic version was created. + DateCreated *string // The name of the image semantic version. Name *string - // The semantic version of the image semantic version. - Version *string - - // The Amazon Resource Name (ARN) of the image semantic version. - Arn *string + // The operating system version of the instance. For example, Amazon Linux 2, + // Ubuntu 18, or Microsoft Windows Server 2019. + OsVersion *string // The owner of the image semantic version. Owner *string - // The date at which this image semantic version was created. - DateCreated *string + // The platform of the image semantic version. + Platform Platform + + // The semantic version of the image semantic version. + Version *string } // Details of the infrastructure configuration. type InfrastructureConfiguration struct { - // The description of the infrastructure configuration. - Description *string - - // The security group IDs of the infrastructure configuration. - SecurityGroupIds []*string + // The Amazon Resource Name (ARN) of the infrastructure configuration. + Arn *string - // The tags of the infrastructure configuration. - Tags map[string]*string + // The date on which the infrastructure configuration was created. + DateCreated *string // The date on which the infrastructure configuration was last updated. DateUpdated *string - // The terminate instance on failure configuration of the infrastructure - // configuration. - TerminateInstanceOnFailure *bool - - // The subnet ID of the infrastructure configuration. - SubnetId *string + // The description of the infrastructure configuration. + Description *string // The instance profile of the infrastructure configuration. InstanceProfileName *string + // The instance types of the infrastructure configuration. + InstanceTypes []*string + // The EC2 key pair of the infrastructure configuration. KeyPair *string + // The logging configuration of the infrastructure configuration. + Logging *Logging + // The name of the infrastructure configuration. Name *string - // The SNS topic Amazon Resource Name (ARN) of the infrastructure configuration. - SnsTopicArn *string - - // The Amazon Resource Name (ARN) of the infrastructure configuration. - Arn *string - // The tags attached to the resource created by Image Builder. ResourceTags map[string]*string - // The date on which the infrastructure configuration was created. - DateCreated *string + // The security group IDs of the infrastructure configuration. + SecurityGroupIds []*string - // The logging configuration of the infrastructure configuration. - Logging *Logging + // The SNS topic Amazon Resource Name (ARN) of the infrastructure configuration. + SnsTopicArn *string - // The instance types of the infrastructure configuration. - InstanceTypes []*string + // The subnet ID of the infrastructure configuration. + SubnetId *string + + // The tags of the infrastructure configuration. + Tags map[string]*string + + // The terminate instance on failure configuration of the infrastructure + // configuration. + TerminateInstanceOnFailure *bool } // The infrastructure used when building EC2 AMIs. type InfrastructureConfigurationSummary struct { - // The description of the infrastructure configuration. - Description *string + // The Amazon Resource Name (ARN) of the infrastructure configuration. + Arn *string - // The tags of the infrastructure configuration. - Tags map[string]*string + // The date on which the infrastructure configuration was created. + DateCreated *string // The date on which the infrastructure configuration was last updated. DateUpdated *string + // The description of the infrastructure configuration. + Description *string + // The name of the infrastructure configuration. Name *string - // The Amazon Resource Name (ARN) of the infrastructure configuration. - Arn *string - // The tags attached to the image created by Image Builder. ResourceTags map[string]*string - // The date on which the infrastructure configuration was created. - DateCreated *string + // The tags of the infrastructure configuration. + Tags map[string]*string } // Defines block device mappings for the instance used to configure your image. type InstanceBlockDeviceMapping struct { - // Use to remove a mapping from the parent image. - NoDevice *string - // The device to which these mappings apply. DeviceName *string // Use to manage Amazon EBS-specific configuration for this mapping. Ebs *EbsInstanceBlockDeviceSpecification + // Use to remove a mapping from the parent image. + NoDevice *string + // Use to manage instance ephemeral devices. VirtualName *string } @@ -660,21 +660,17 @@ type OutputResources struct { // Amazon S3 logging configuration. type S3Logs struct { - // The Amazon S3 path in which to store the logs. - S3KeyPrefix *string - // The Amazon S3 bucket in which to store the logs. S3BucketName *string + + // The Amazon S3 path in which to store the logs. + S3KeyPrefix *string } // A schedule configures how often and when a pipeline will automatically create a // new image. type Schedule struct { - // The expression determines how often EC2 Image Builder evaluates your - // pipelineExecutionStartCondition. - ScheduleExpression *string - // The condition configures when the pipeline should trigger a new image build. // When the pipelineExecutionStartCondition is set to // EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, EC2 Image Builder will build @@ -682,4 +678,8 @@ type Schedule struct { // EXPRESSION_MATCH_ONLY, it will build a new image every time the CRON expression // matches the current time. PipelineExecutionStartCondition PipelineExecutionStartCondition + + // The expression determines how often EC2 Image Builder evaluates your + // pipelineExecutionStartCondition. + ScheduleExpression *string } diff --git a/service/inspector/api_op_AddAttributesToFindings.go b/service/inspector/api_op_AddAttributesToFindings.go index 9d690335568..3a92180924c 100644 --- a/service/inspector/api_op_AddAttributesToFindings.go +++ b/service/inspector/api_op_AddAttributesToFindings.go @@ -58,15 +58,15 @@ func (c *Client) AddAttributesToFindings(ctx context.Context, params *AddAttribu type AddAttributesToFindingsInput struct { - // The ARNs that specify the findings that you want to assign attributes to. + // The array of attributes that you want to assign to specified findings. // // This member is required. - FindingArns []*string + Attributes []*types.Attribute - // The array of attributes that you want to assign to specified findings. + // The ARNs that specify the findings that you want to assign attributes to. // // This member is required. - Attributes []*types.Attribute + FindingArns []*string } type AddAttributesToFindingsOutput struct { diff --git a/service/inspector/api_op_CreateAssessmentTarget.go b/service/inspector/api_op_CreateAssessmentTarget.go index bcbac3fc2fd..586e9ddb24e 100644 --- a/service/inspector/api_op_CreateAssessmentTarget.go +++ b/service/inspector/api_op_CreateAssessmentTarget.go @@ -66,16 +66,16 @@ func (c *Client) CreateAssessmentTarget(ctx context.Context, params *CreateAsses type CreateAssessmentTargetInput struct { - // The ARN that specifies the resource group that is used to create the assessment - // target. If resourceGroupArn is not specified, all EC2 instances in the current - // AWS account and region are included in the assessment target. - ResourceGroupArn *string - // The user-defined name that identifies the assessment target that you want to // create. The name must be unique within the AWS account. // // This member is required. AssessmentTargetName *string + + // The ARN that specifies the resource group that is used to create the assessment + // target. If resourceGroupArn is not specified, all EC2 instances in the current + // AWS account and region are included in the assessment target. + ResourceGroupArn *string } type CreateAssessmentTargetOutput struct { diff --git a/service/inspector/api_op_CreateAssessmentTemplate.go b/service/inspector/api_op_CreateAssessmentTemplate.go index 22e5d1e2f23..4aa7b6b1189 100644 --- a/service/inspector/api_op_CreateAssessmentTemplate.go +++ b/service/inspector/api_op_CreateAssessmentTemplate.go @@ -62,11 +62,11 @@ func (c *Client) CreateAssessmentTemplate(ctx context.Context, params *CreateAss type CreateAssessmentTemplateInput struct { - // The ARNs that specify the rules packages that you want to attach to the + // The ARN that specifies the assessment target for which you want to create the // assessment template. // // This member is required. - RulesPackageArns []*string + AssessmentTargetArn *string // The user-defined name that identifies the assessment template that you want to // create. You can create several assessment templates for an assessment target. @@ -76,22 +76,22 @@ type CreateAssessmentTemplateInput struct { // This member is required. AssessmentTemplateName *string - // The ARN that specifies the assessment target for which you want to create the + // The duration of the assessment run in seconds. + // + // This member is required. + DurationInSeconds *int32 + + // The ARNs that specify the rules packages that you want to attach to the // assessment template. // // This member is required. - AssessmentTargetArn *string + RulesPackageArns []*string // The user-defined attributes that are assigned to every finding that is generated // by the assessment run that uses this assessment template. An attribute is a key // and value pair (an Attribute () object). Within an assessment template, each key // must be unique. UserAttributesForFindings []*types.Attribute - - // The duration of the assessment run in seconds. - // - // This member is required. - DurationInSeconds *int32 } type CreateAssessmentTemplateOutput struct { diff --git a/service/inspector/api_op_DescribeAssessmentTargets.go b/service/inspector/api_op_DescribeAssessmentTargets.go index 6f9759e3225..b2146fcf0e0 100644 --- a/service/inspector/api_op_DescribeAssessmentTargets.go +++ b/service/inspector/api_op_DescribeAssessmentTargets.go @@ -66,16 +66,16 @@ type DescribeAssessmentTargetsInput struct { type DescribeAssessmentTargetsOutput struct { - // Assessment target details that cannot be described. An error code is provided - // for each failed item. + // Information about the assessment targets. // // This member is required. - FailedItems map[string]*types.FailedItemDetails + AssessmentTargets []*types.AssessmentTarget - // Information about the assessment targets. + // Assessment target details that cannot be described. An error code is provided + // for each failed item. // // This member is required. - AssessmentTargets []*types.AssessmentTarget + FailedItems map[string]*types.FailedItemDetails // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/inspector/api_op_DescribeCrossAccountAccessRole.go b/service/inspector/api_op_DescribeCrossAccountAccessRole.go index 5de2223ac88..3a518439130 100644 --- a/service/inspector/api_op_DescribeCrossAccountAccessRole.go +++ b/service/inspector/api_op_DescribeCrossAccountAccessRole.go @@ -59,11 +59,10 @@ type DescribeCrossAccountAccessRoleInput struct { type DescribeCrossAccountAccessRoleOutput struct { - // A Boolean value that specifies whether the IAM role has the necessary policies - // attached to enable Amazon Inspector to access your AWS account. + // The date when the cross-account access role was registered. // // This member is required. - Valid *bool + RegisteredAt *time.Time // The ARN that specifies the IAM role that Amazon Inspector uses to access your // AWS account. @@ -71,10 +70,11 @@ type DescribeCrossAccountAccessRoleOutput struct { // This member is required. RoleArn *string - // The date when the cross-account access role was registered. + // A Boolean value that specifies whether the IAM role has the necessary policies + // attached to enable Amazon Inspector to access your AWS account. // // This member is required. - RegisteredAt *time.Time + Valid *bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/inspector/api_op_DescribeFindings.go b/service/inspector/api_op_DescribeFindings.go index 1c3f6543915..decfe7f3dcf 100644 --- a/service/inspector/api_op_DescribeFindings.go +++ b/service/inspector/api_op_DescribeFindings.go @@ -57,29 +57,29 @@ func (c *Client) DescribeFindings(ctx context.Context, params *DescribeFindingsI type DescribeFindingsInput struct { - // The locale into which you want to translate a finding description, - // recommendation, and the short description that identifies the finding. - Locale types.Locale - // The ARN that specifies the finding that you want to describe. // // This member is required. FindingArns []*string + + // The locale into which you want to translate a finding description, + // recommendation, and the short description that identifies the finding. + Locale types.Locale } type DescribeFindingsOutput struct { - // Information about the finding. - // - // This member is required. - Findings []*types.Finding - // Finding details that cannot be described. An error code is provided for each // failed item. // // This member is required. FailedItems map[string]*types.FailedItemDetails + // Information about the finding. + // + // This member is required. + Findings []*types.Finding + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/inspector/api_op_DescribeRulesPackages.go b/service/inspector/api_op_DescribeRulesPackages.go index 57b2ff41bfb..7b98ec83c91 100644 --- a/service/inspector/api_op_DescribeRulesPackages.go +++ b/service/inspector/api_op_DescribeRulesPackages.go @@ -58,28 +58,28 @@ func (c *Client) DescribeRulesPackages(ctx context.Context, params *DescribeRule type DescribeRulesPackagesInput struct { - // The locale that you want to translate a rules package description into. - Locale types.Locale - // The ARN that specifies the rules package that you want to describe. // // This member is required. RulesPackageArns []*string + + // The locale that you want to translate a rules package description into. + Locale types.Locale } type DescribeRulesPackagesOutput struct { - // Information about the rules package. - // - // This member is required. - RulesPackages []*types.RulesPackage - // Rules package details that cannot be described. An error code is provided for // each failed item. // // This member is required. FailedItems map[string]*types.FailedItemDetails + // Information about the rules package. + // + // This member is required. + RulesPackages []*types.RulesPackage + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/inspector/api_op_GetAssessmentReport.go b/service/inspector/api_op_GetAssessmentReport.go index a023f9a4724..ac0932463ae 100644 --- a/service/inspector/api_op_GetAssessmentReport.go +++ b/service/inspector/api_op_GetAssessmentReport.go @@ -58,18 +58,18 @@ func (c *Client) GetAssessmentReport(ctx context.Context, params *GetAssessmentR type GetAssessmentReportInput struct { - // Specifies the file format (html or pdf) of the assessment report that you want - // to generate. - // - // This member is required. - ReportFileFormat types.ReportFileFormat - // The ARN that specifies the assessment run for which you want to generate a // report. // // This member is required. AssessmentRunArn *string + // Specifies the file format (html or pdf) of the assessment report that you want + // to generate. + // + // This member is required. + ReportFileFormat types.ReportFileFormat + // Specifies the type of the assessment report that you want to generate. There are // two types of assessment reports: a finding report and a full report. For more // information, see Assessment Reports diff --git a/service/inspector/api_op_GetExclusionsPreview.go b/service/inspector/api_op_GetExclusionsPreview.go index 5933ab44a4c..6668e1b952d 100644 --- a/service/inspector/api_op_GetExclusionsPreview.go +++ b/service/inspector/api_op_GetExclusionsPreview.go @@ -65,28 +65,33 @@ type GetExclusionsPreviewInput struct { // This member is required. AssessmentTemplateArn *string - // The locale into which you want to translate the exclusion's title, description, - // and recommendation. - Locale types.Locale - // The unique identifier associated of the exclusions preview. // // This member is required. PreviewToken *string + // The locale into which you want to translate the exclusion's title, description, + // and recommendation. + Locale types.Locale + + // You can use this parameter to indicate the maximum number of items you want in + // the response. The default value is 100. The maximum value is 500. + MaxResults *int32 + // You can use this parameter when paginating results. Set the value of this // parameter to null on your first call to the GetExclusionsPreviewRequest action. // Subsequent calls to the action fill nextToken in the request with the value of // nextToken from the previous response to continue listing data. NextToken *string - - // You can use this parameter to indicate the maximum number of items you want in - // the response. The default value is 100. The maximum value is 500. - MaxResults *int32 } type GetExclusionsPreviewOutput struct { + // Specifies the status of the request to generate an exclusions preview. + // + // This member is required. + PreviewStatus types.PreviewStatus + // Information about the exclusions included in the preview. ExclusionPreviews []*types.ExclusionPreview @@ -96,11 +101,6 @@ type GetExclusionsPreviewOutput struct { // to be listed, this parameter is set to null. NextToken *string - // Specifies the status of the request to generate an exclusions preview. - // - // This member is required. - PreviewStatus types.PreviewStatus - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/inspector/api_op_ListAssessmentRunAgents.go b/service/inspector/api_op_ListAssessmentRunAgents.go index 64f02e020f3..45a13c96b87 100644 --- a/service/inspector/api_op_ListAssessmentRunAgents.go +++ b/service/inspector/api_op_ListAssessmentRunAgents.go @@ -58,16 +58,6 @@ func (c *Client) ListAssessmentRunAgents(ctx context.Context, params *ListAssess type ListAssessmentRunAgentsInput struct { - // You can use this parameter when paginating results. Set the value of this - // parameter to null on your first call to the ListAssessmentRunAgents action. - // Subsequent calls to the action fill nextToken in the request with the value of - // NextToken from the previous response to continue listing data. - NextToken *string - - // You can use this parameter to indicate the maximum number of items that you want - // in the response. The default value is 10. The maximum value is 500. - MaxResults *int32 - // The ARN that specifies the assessment run whose agents you want to list. // // This member is required. @@ -78,6 +68,16 @@ type ListAssessmentRunAgentsInput struct { // attributes must match. When multiple values are specified for a filter // attribute, any of the values can match. Filter *types.AgentFilter + + // You can use this parameter to indicate the maximum number of items that you want + // in the response. The default value is 10. The maximum value is 500. + MaxResults *int32 + + // You can use this parameter when paginating results. Set the value of this + // parameter to null on your first call to the ListAssessmentRunAgents action. + // Subsequent calls to the action fill nextToken in the request with the value of + // NextToken from the previous response to continue listing data. + NextToken *string } type ListAssessmentRunAgentsOutput struct { diff --git a/service/inspector/api_op_ListAssessmentRuns.go b/service/inspector/api_op_ListAssessmentRuns.go index d233262b233..2e00a2adbe2 100644 --- a/service/inspector/api_op_ListAssessmentRuns.go +++ b/service/inspector/api_op_ListAssessmentRuns.go @@ -57,6 +57,10 @@ func (c *Client) ListAssessmentRuns(ctx context.Context, params *ListAssessmentR type ListAssessmentRunsInput struct { + // The ARNs that specify the assessment templates whose assessment runs you want to + // list. + AssessmentTemplateArns []*string + // You can use this parameter to specify a subset of data to be included in the // action's response. For a record to match a filter, all specified filter // attributes must match. When multiple values are specified for a filter @@ -72,26 +76,22 @@ type ListAssessmentRunsInput struct { // Subsequent calls to the action fill nextToken in the request with the value of // NextToken from the previous response to continue listing data. NextToken *string - - // The ARNs that specify the assessment templates whose assessment runs you want to - // list. - AssessmentTemplateArns []*string } type ListAssessmentRunsOutput struct { - // When a response is generated, if there is more data to be listed, this parameter - // is present in the response and contains the value to use for the nextToken - // parameter in a subsequent pagination request. If there is no more data to be - // listed, this parameter is set to null. - NextToken *string - // A list of ARNs that specifies the assessment runs that are returned by the // action. // // This member is required. AssessmentRunArns []*string + // When a response is generated, if there is more data to be listed, this parameter + // is present in the response and contains the value to use for the nextToken + // parameter in a subsequent pagination request. If there is no more data to be + // listed, this parameter is set to null. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/inspector/api_op_ListAssessmentTargets.go b/service/inspector/api_op_ListAssessmentTargets.go index 4a413ccefa5..356178b9785 100644 --- a/service/inspector/api_op_ListAssessmentTargets.go +++ b/service/inspector/api_op_ListAssessmentTargets.go @@ -58,21 +58,21 @@ func (c *Client) ListAssessmentTargets(ctx context.Context, params *ListAssessme type ListAssessmentTargetsInput struct { - // You can use this parameter when paginating results. Set the value of this - // parameter to null on your first call to the ListAssessmentTargets action. - // Subsequent calls to the action fill nextToken in the request with the value of - // NextToken from the previous response to continue listing data. - NextToken *string - - // You can use this parameter to indicate the maximum number of items you want in - // the response. The default value is 10. The maximum value is 500. - MaxResults *int32 - // You can use this parameter to specify a subset of data to be included in the // action's response. For a record to match a filter, all specified filter // attributes must match. When multiple values are specified for a filter // attribute, any of the values can match. Filter *types.AssessmentTargetFilter + + // You can use this parameter to indicate the maximum number of items you want in + // the response. The default value is 10. The maximum value is 500. + MaxResults *int32 + + // You can use this parameter when paginating results. Set the value of this + // parameter to null on your first call to the ListAssessmentTargets action. + // Subsequent calls to the action fill nextToken in the request with the value of + // NextToken from the previous response to continue listing data. + NextToken *string } type ListAssessmentTargetsOutput struct { diff --git a/service/inspector/api_op_ListEventSubscriptions.go b/service/inspector/api_op_ListEventSubscriptions.go index f5046d1e4ef..271d96728dd 100644 --- a/service/inspector/api_op_ListEventSubscriptions.go +++ b/service/inspector/api_op_ListEventSubscriptions.go @@ -58,16 +58,16 @@ func (c *Client) ListEventSubscriptions(ctx context.Context, params *ListEventSu type ListEventSubscriptionsInput struct { + // You can use this parameter to indicate the maximum number of items you want in + // the response. The default value is 10. The maximum value is 500. + MaxResults *int32 + // You can use this parameter when paginating results. Set the value of this // parameter to null on your first call to the ListEventSubscriptions action. // Subsequent calls to the action fill nextToken in the request with the value of // NextToken from the previous response to continue listing data. NextToken *string - // You can use this parameter to indicate the maximum number of items you want in - // the response. The default value is 10. The maximum value is 500. - MaxResults *int32 - // The ARN of the assessment template for which you want to list the existing event // subscriptions. ResourceArn *string diff --git a/service/inspector/api_op_ListExclusions.go b/service/inspector/api_op_ListExclusions.go index 236ff8af50c..87e62491efe 100644 --- a/service/inspector/api_op_ListExclusions.go +++ b/service/inspector/api_op_ListExclusions.go @@ -56,6 +56,12 @@ func (c *Client) ListExclusions(ctx context.Context, params *ListExclusionsInput type ListExclusionsInput struct { + // The ARN of the assessment run that generated the exclusions that you want to + // list. + // + // This member is required. + AssessmentRunArn *string + // You can use this parameter to indicate the maximum number of items you want in // the response. The default value is 100. The maximum value is 500. MaxResults *int32 @@ -65,12 +71,6 @@ type ListExclusionsInput struct { // Subsequent calls to the action fill nextToken in the request with the value of // nextToken from the previous response to continue listing data. NextToken *string - - // The ARN of the assessment run that generated the exclusions that you want to - // list. - // - // This member is required. - AssessmentRunArn *string } type ListExclusionsOutput struct { diff --git a/service/inspector/api_op_ListFindings.go b/service/inspector/api_op_ListFindings.go index 7dd9da10e7a..e455bc702e9 100644 --- a/service/inspector/api_op_ListFindings.go +++ b/service/inspector/api_op_ListFindings.go @@ -58,40 +58,40 @@ func (c *Client) ListFindings(ctx context.Context, params *ListFindingsInput, op type ListFindingsInput struct { - // You can use this parameter when paginating results. Set the value of this - // parameter to null on your first call to the ListFindings action. Subsequent - // calls to the action fill nextToken in the request with the value of NextToken - // from the previous response to continue listing data. - NextToken *string - // The ARNs of the assessment runs that generate the findings that you want to // list. AssessmentRunArns []*string - // You can use this parameter to indicate the maximum number of items you want in - // the response. The default value is 10. The maximum value is 500. - MaxResults *int32 - // You can use this parameter to specify a subset of data to be included in the // action's response. For a record to match a filter, all specified filter // attributes must match. When multiple values are specified for a filter // attribute, any of the values can match. Filter *types.FindingFilter + + // You can use this parameter to indicate the maximum number of items you want in + // the response. The default value is 10. The maximum value is 500. + MaxResults *int32 + + // You can use this parameter when paginating results. Set the value of this + // parameter to null on your first call to the ListFindings action. Subsequent + // calls to the action fill nextToken in the request with the value of NextToken + // from the previous response to continue listing data. + NextToken *string } type ListFindingsOutput struct { + // A list of ARNs that specifies the findings returned by the action. + // + // This member is required. + FindingArns []*string + // When a response is generated, if there is more data to be listed, this parameter // is present in the response and contains the value to use for the nextToken // parameter in a subsequent pagination request. If there is no more data to be // listed, this parameter is set to null. NextToken *string - // A list of ARNs that specifies the findings returned by the action. - // - // This member is required. - FindingArns []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/inspector/api_op_ListRulesPackages.go b/service/inspector/api_op_ListRulesPackages.go index 6a8672e41ec..0912ac59241 100644 --- a/service/inspector/api_op_ListRulesPackages.go +++ b/service/inspector/api_op_ListRulesPackages.go @@ -55,30 +55,30 @@ func (c *Client) ListRulesPackages(ctx context.Context, params *ListRulesPackage type ListRulesPackagesInput struct { + // You can use this parameter to indicate the maximum number of items you want in + // the response. The default value is 10. The maximum value is 500. + MaxResults *int32 + // You can use this parameter when paginating results. Set the value of this // parameter to null on your first call to the ListRulesPackages action. Subsequent // calls to the action fill nextToken in the request with the value of NextToken // from the previous response to continue listing data. NextToken *string - - // You can use this parameter to indicate the maximum number of items you want in - // the response. The default value is 10. The maximum value is 500. - MaxResults *int32 } type ListRulesPackagesOutput struct { + // The list of ARNs that specifies the rules packages returned by the action. + // + // This member is required. + RulesPackageArns []*string + // When a response is generated, if there is more data to be listed, this parameter // is present in the response and contains the value to use for the nextToken // parameter in a subsequent pagination request. If there is no more data to be // listed, this parameter is set to null. NextToken *string - // The list of ARNs that specifies the rules packages returned by the action. - // - // This member is required. - RulesPackageArns []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/inspector/api_op_PreviewAgents.go b/service/inspector/api_op_PreviewAgents.go index 2a3eb8f2643..4d8787b697b 100644 --- a/service/inspector/api_op_PreviewAgents.go +++ b/service/inspector/api_op_PreviewAgents.go @@ -76,17 +76,17 @@ type PreviewAgentsInput struct { type PreviewAgentsOutput struct { + // The resulting list of agents. + // + // This member is required. + AgentPreviews []*types.AgentPreview + // When a response is generated, if there is more data to be listed, this parameter // is present in the response and contains the value to use for the nextToken // parameter in a subsequent pagination request. If there is no more data to be // listed, this parameter is set to null. NextToken *string - // The resulting list of agents. - // - // This member is required. - AgentPreviews []*types.AgentPreview - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/inspector/api_op_RemoveAttributesFromFindings.go b/service/inspector/api_op_RemoveAttributesFromFindings.go index 0b102a15355..a6e1076f3f1 100644 --- a/service/inspector/api_op_RemoveAttributesFromFindings.go +++ b/service/inspector/api_op_RemoveAttributesFromFindings.go @@ -59,15 +59,15 @@ func (c *Client) RemoveAttributesFromFindings(ctx context.Context, params *Remov type RemoveAttributesFromFindingsInput struct { - // The ARNs that specify the findings that you want to remove attributes from. + // The array of attribute keys that you want to remove from specified findings. // // This member is required. - FindingArns []*string + AttributeKeys []*string - // The array of attribute keys that you want to remove from specified findings. + // The ARNs that specify the findings that you want to remove attributes from. // // This member is required. - AttributeKeys []*string + FindingArns []*string } type RemoveAttributesFromFindingsOutput struct { diff --git a/service/inspector/api_op_SetTagsForResource.go b/service/inspector/api_op_SetTagsForResource.go index 9f5d9a12e89..d016ff82e34 100644 --- a/service/inspector/api_op_SetTagsForResource.go +++ b/service/inspector/api_op_SetTagsForResource.go @@ -58,14 +58,14 @@ func (c *Client) SetTagsForResource(ctx context.Context, params *SetTagsForResou type SetTagsForResourceInput struct { - // A collection of key and value pairs that you want to set to the assessment - // template. - Tags []*types.Tag - // The ARN of the assessment template that you want to set tags to. // // This member is required. ResourceArn *string + + // A collection of key and value pairs that you want to set to the assessment + // template. + Tags []*types.Tag } type SetTagsForResourceOutput struct { diff --git a/service/inspector/api_op_SubscribeToEvent.go b/service/inspector/api_op_SubscribeToEvent.go index 970e45e4a7e..eff5e6cbe25 100644 --- a/service/inspector/api_op_SubscribeToEvent.go +++ b/service/inspector/api_op_SubscribeToEvent.go @@ -58,11 +58,6 @@ func (c *Client) SubscribeToEvent(ctx context.Context, params *SubscribeToEventI type SubscribeToEventInput struct { - // The ARN of the SNS topic to which the SNS notifications are sent. - // - // This member is required. - TopicArn *string - // The event for which you want to receive SNS notifications. // // This member is required. @@ -73,6 +68,11 @@ type SubscribeToEventInput struct { // // This member is required. ResourceArn *string + + // The ARN of the SNS topic to which the SNS notifications are sent. + // + // This member is required. + TopicArn *string } type SubscribeToEventOutput struct { diff --git a/service/inspector/api_op_UnsubscribeFromEvent.go b/service/inspector/api_op_UnsubscribeFromEvent.go index 9ca9edfc275..56f14da0bce 100644 --- a/service/inspector/api_op_UnsubscribeFromEvent.go +++ b/service/inspector/api_op_UnsubscribeFromEvent.go @@ -58,16 +58,16 @@ func (c *Client) UnsubscribeFromEvent(ctx context.Context, params *UnsubscribeFr type UnsubscribeFromEventInput struct { - // The ARN of the assessment template that is used during the event for which you - // want to stop receiving SNS notifications. + // The event for which you want to stop receiving SNS notifications. // // This member is required. - ResourceArn *string + Event types.InspectorEvent - // The event for which you want to stop receiving SNS notifications. + // The ARN of the assessment template that is used during the event for which you + // want to stop receiving SNS notifications. // // This member is required. - Event types.InspectorEvent + ResourceArn *string // The ARN of the SNS topic to which SNS notifications are sent. // diff --git a/service/inspector/api_op_UpdateAssessmentTarget.go b/service/inspector/api_op_UpdateAssessmentTarget.go index e154612d3e6..3f8396a901d 100644 --- a/service/inspector/api_op_UpdateAssessmentTarget.go +++ b/service/inspector/api_op_UpdateAssessmentTarget.go @@ -63,14 +63,14 @@ type UpdateAssessmentTargetInput struct { // This member is required. AssessmentTargetArn *string - // The ARN of the resource group that is used to specify the new resource group to - // associate with the assessment target. - ResourceGroupArn *string - // The name of the assessment target that you want to update. // // This member is required. AssessmentTargetName *string + + // The ARN of the resource group that is used to specify the new resource group to + // associate with the assessment target. + ResourceGroupArn *string } type UpdateAssessmentTargetOutput struct { diff --git a/service/inspector/go.mod b/service/inspector/go.mod index d5ed8f3742f..6653c29519c 100644 --- a/service/inspector/go.mod +++ b/service/inspector/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/inspector go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/inspector/types/types.go b/service/inspector/types/types.go index 5b97da59dde..9225b5ca88b 100644 --- a/service/inspector/types/types.go +++ b/service/inspector/types/types.go @@ -43,35 +43,35 @@ type AgentFilter struct { // Used as a response element in the PreviewAgents () action. type AgentPreview struct { + // The ID of the EC2 instance where the agent is installed. + // + // This member is required. + AgentId *string + // The health status of the Amazon Inspector Agent. AgentHealth AgentHealth - // The kernel version of the operating system running on the EC2 instance on which - // the Amazon Inspector Agent is installed. - KernelVersion *string - - // The operating system running on the EC2 instance on which the Amazon Inspector - // Agent is installed. - OperatingSystem *string + // The version of the Amazon Inspector Agent. + AgentVersion *string // The Auto Scaling group for the EC2 instance where the agent is installed. AutoScalingGroup *string - // The version of the Amazon Inspector Agent. - AgentVersion *string + // The hostname of the EC2 instance on which the Amazon Inspector Agent is + // installed. + Hostname *string // The IP address of the EC2 instance on which the Amazon Inspector Agent is // installed. Ipv4Address *string - // The hostname of the EC2 instance on which the Amazon Inspector Agent is - // installed. - Hostname *string + // The kernel version of the operating system running on the EC2 instance on which + // the Amazon Inspector Agent is installed. + KernelVersion *string - // The ID of the EC2 instance where the agent is installed. - // - // This member is required. - AgentId *string + // The operating system running on the EC2 instance on which the Amazon Inspector + // Agent is installed. + OperatingSystem *string } // A snapshot of an Amazon Inspector assessment run that contains the findings of @@ -79,107 +79,104 @@ type AgentPreview struct { // () action. type AssessmentRun struct { - // Provides a total count of generated findings per severity. - // - // This member is required. - FindingCounts map[string]*int32 - - // The user-defined attributes that are assigned to every generated finding. - // - // This member is required. - UserAttributesForFindings []*Attribute - - // The rules packages selected for the assessment run. + // The ARN of the assessment run. // // This member is required. - RulesPackageArns []*string + Arn *string // The ARN of the assessment template that is associated with the assessment run. // // This member is required. AssessmentTemplateArn *string - // A list of notifications for the event subscriptions. A notification about a - // particular generated finding is added to this list only once. + // The time when StartAssessmentRun () was called. // // This member is required. - Notifications []*AssessmentRunNotification + CreatedAt *time.Time - // The state of the assessment run. + // A Boolean value (true or false) that specifies whether the process of collecting + // data from the agents is completed. // // This member is required. - State AssessmentRunState + DataCollected *bool - // The assessment run completion time that corresponds to the rules packages - // evaluation completion time or failure. - CompletedAt *time.Time + // The duration of the assessment run. + // + // This member is required. + DurationInSeconds *int32 - // The last time when the assessment run's state changed. + // Provides a total count of generated findings per severity. // // This member is required. - StateChangedAt *time.Time + FindingCounts map[string]*int32 // The auto-generated name for the assessment run. // // This member is required. Name *string - // The ARN of the assessment run. + // A list of notifications for the event subscriptions. A notification about a + // particular generated finding is added to this list only once. // // This member is required. - Arn *string + Notifications []*AssessmentRunNotification - // The time when StartAssessmentRun () was called. - StartedAt *time.Time + // The rules packages selected for the assessment run. + // + // This member is required. + RulesPackageArns []*string - // A list of the assessment run state changes. + // The state of the assessment run. // // This member is required. - StateChanges []*AssessmentRunStateChange + State AssessmentRunState - // The duration of the assessment run. + // The last time when the assessment run's state changed. // // This member is required. - DurationInSeconds *int32 + StateChangedAt *time.Time - // The time when StartAssessmentRun () was called. + // A list of the assessment run state changes. // // This member is required. - CreatedAt *time.Time + StateChanges []*AssessmentRunStateChange - // A Boolean value (true or false) that specifies whether the process of collecting - // data from the agents is completed. + // The user-defined attributes that are assigned to every generated finding. // // This member is required. - DataCollected *bool + UserAttributesForFindings []*Attribute + + // The assessment run completion time that corresponds to the rules packages + // evaluation completion time or failure. + CompletedAt *time.Time + + // The time when StartAssessmentRun () was called. + StartedAt *time.Time } // Contains information about an Amazon Inspector agent. This data type is used as // a response element in the ListAssessmentRunAgents () action. type AssessmentRunAgent struct { - // The ARN of the assessment run that is associated with the agent. + // The current health state of the agent. // // This member is required. - AssessmentRunArn *string + AgentHealth AgentHealth // The detailed health state of the agent. // // This member is required. AgentHealthCode AgentHealthCode - // The Auto Scaling group of the EC2 instance that is specified by the agent ID. - AutoScalingGroup *string - // The AWS account of the EC2 instance where the agent is installed. // // This member is required. AgentId *string - // The current health state of the agent. + // The ARN of the assessment run that is associated with the agent. // // This member is required. - AgentHealth AgentHealth + AssessmentRunArn *string // The Amazon Inspector application data metrics that are collected by the agent. // @@ -188,25 +185,18 @@ type AssessmentRunAgent struct { // The description for the agent health code. AgentHealthDetails *string + + // The Auto Scaling group of the EC2 instance that is specified by the agent ID. + AutoScalingGroup *string } // Used as the request parameter in the ListAssessmentRuns () action. type AssessmentRunFilter struct { - // For a record to match a filter, an explicit value or a string containing a - // wildcard that is specified for this data type property must match the value of - // the assessmentRunName property of the AssessmentRun () data type. - NamePattern *string - - // For a record to match a filter, one of the values specified for this data type - // property must be the exact match of the value of the assessmentRunState property - // of the AssessmentRun () data type. - States []AssessmentRunState - // For a record to match a filter, the value that is specified for this data type // property must inclusively match any value between the specified minimum and - // maximum values of the startTime property of the AssessmentRun () data type. - StartTimeRange *TimestampRange + // maximum values of the completedAt property of the AssessmentRun () data type. + CompletionTimeRange *TimestampRange // For a record to match a filter, the value that is specified for this data type // property must inclusively match any value between the specified minimum and @@ -214,48 +204,58 @@ type AssessmentRunFilter struct { // type. DurationRange *DurationRange + // For a record to match a filter, an explicit value or a string containing a + // wildcard that is specified for this data type property must match the value of + // the assessmentRunName property of the AssessmentRun () data type. + NamePattern *string + // For a record to match a filter, the value that is specified for this data type // property must be contained in the list of values of the rulesPackages property // of the AssessmentRun () data type. RulesPackageArns []*string + // For a record to match a filter, the value that is specified for this data type + // property must inclusively match any value between the specified minimum and + // maximum values of the startTime property of the AssessmentRun () data type. + StartTimeRange *TimestampRange + // For a record to match a filter, the value that is specified for this data type // property must match the stateChangedAt property of the AssessmentRun () data // type. StateChangeTimeRange *TimestampRange - // For a record to match a filter, the value that is specified for this data type - // property must inclusively match any value between the specified minimum and - // maximum values of the completedAt property of the AssessmentRun () data type. - CompletionTimeRange *TimestampRange + // For a record to match a filter, one of the values specified for this data type + // property must be the exact match of the value of the assessmentRunState property + // of the AssessmentRun () data type. + States []AssessmentRunState } // Used as one of the elements of the AssessmentRun () data type. type AssessmentRunNotification struct { - // The message included in the notification. - Message *string - // The date of the notification. // // This member is required. Date *time.Time - // The status code of the SNS notification. - SnsPublishStatusCode AssessmentRunNotificationSnsStatusCode + // The Boolean value that specifies whether the notification represents an error. + // + // This member is required. + Error *bool // The event for which a notification is sent. // // This member is required. Event InspectorEvent + // The message included in the notification. + Message *string + + // The status code of the SNS notification. + SnsPublishStatusCode AssessmentRunNotificationSnsStatusCode + // The SNS topic to which the SNS notification is sent. SnsTopicArn *string - - // The Boolean value that specifies whether the notification represents an error. - // - // This member is required. - Error *bool } // Used as one of the elements of the AssessmentRun () data type. @@ -281,24 +281,24 @@ type AssessmentTarget struct { // This member is required. Arn *string - // The time at which UpdateAssessmentTarget () is called. + // The time at which the assessment target is created. // // This member is required. - UpdatedAt *time.Time - - // The ARN that specifies the resource group that is associated with the assessment - // target. - ResourceGroupArn *string + CreatedAt *time.Time // The name of the Amazon Inspector assessment target. // // This member is required. Name *string - // The time at which the assessment target is created. + // The time at which UpdateAssessmentTarget () is called. // // This member is required. - CreatedAt *time.Time + UpdatedAt *time.Time + + // The ARN that specifies the resource group that is associated with the assessment + // target. + ResourceGroupArn *string } // Used as the request parameter in the ListAssessmentTargets () action. @@ -315,32 +315,37 @@ type AssessmentTargetFilter struct { // action. type AssessmentTemplate struct { - // The ARN of the assessment target that corresponds to this assessment template. + // The ARN of the assessment template. // // This member is required. - AssessmentTargetArn *string + Arn *string - // The duration in seconds specified for this assessment template. The default - // value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day). + // The number of existing assessment runs associated with this assessment template. + // This value can be zero or a positive integer. // // This member is required. - DurationInSeconds *int32 + AssessmentRunCount *int32 - // The Amazon Resource Name (ARN) of the most recent assessment run associated with - // this assessment template. This value exists only when the value of - // assessmentRunCount is greaterpa than zero. - LastAssessmentRunArn *string + // The ARN of the assessment target that corresponds to this assessment template. + // + // This member is required. + AssessmentTargetArn *string // The time at which the assessment template is created. // // This member is required. CreatedAt *time.Time - // The number of existing assessment runs associated with this assessment template. - // This value can be zero or a positive integer. + // The duration in seconds specified for this assessment template. The default + // value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day). // // This member is required. - AssessmentRunCount *int32 + DurationInSeconds *int32 + + // The name of the assessment template. + // + // This member is required. + Name *string // The rules packages that are specified for this assessment template. // @@ -353,20 +358,20 @@ type AssessmentTemplate struct { // This member is required. UserAttributesForFindings []*Attribute - // The ARN of the assessment template. - // - // This member is required. - Arn *string - - // The name of the assessment template. - // - // This member is required. - Name *string + // The Amazon Resource Name (ARN) of the most recent assessment run associated with + // this assessment template. This value exists only when the value of + // assessmentRunCount is greaterpa than zero. + LastAssessmentRunArn *string } // Used as the request parameter in the ListAssessmentTemplates () action. type AssessmentTemplateFilter struct { + // For a record to match a filter, the value specified for this data type property + // must inclusively match any value between the specified minimum and maximum + // values of the durationInSeconds property of the AssessmentTemplate () data type. + DurationRange *DurationRange + // For a record to match a filter, an explicit value or a string that contains a // wildcard that is specified for this data type property must match the value of // the assessmentTemplateName property of the AssessmentTemplate () data type. @@ -376,44 +381,39 @@ type AssessmentTemplateFilter struct { // property must be contained in the list of values of the rulesPackageArns // property of the AssessmentTemplate () data type. RulesPackageArns []*string - - // For a record to match a filter, the value specified for this data type property - // must inclusively match any value between the specified minimum and maximum - // values of the durationInSeconds property of the AssessmentTemplate () data type. - DurationRange *DurationRange } // A collection of attributes of the host from which the finding is generated. type AssetAttributes struct { - // The ID of the Amazon Machine Image (AMI) that is installed on the EC2 instance - // where the finding is generated. - AmiId *string - - // The hostname of the EC2 instance where the finding is generated. - Hostname *string - - // An array of the network interfaces interacting with the EC2 instance where the - // finding is generated. - NetworkInterfaces []*NetworkInterface + // The schema version of this data type. + // + // This member is required. + SchemaVersion *int32 // The ID of the agent that is installed on the EC2 instance where the finding is // generated. AgentId *string - // The tags related to the EC2 instance where the finding is generated. - Tags []*Tag + // The ID of the Amazon Machine Image (AMI) that is installed on the EC2 instance + // where the finding is generated. + AmiId *string // The Auto Scaling group of the EC2 instance where the finding is generated. AutoScalingGroup *string + // The hostname of the EC2 instance where the finding is generated. + Hostname *string + // The list of IP v4 addresses of the EC2 instance where the finding is generated. Ipv4Addresses []*string - // The schema version of this data type. - // - // This member is required. - SchemaVersion *int32 + // An array of the network interfaces interacting with the EC2 instance where the + // finding is generated. + NetworkInterfaces []*NetworkInterface + + // The tags related to the EC2 instance where the finding is generated. + Tags []*Tag } // This data type is used as a request parameter in the AddAttributesToFindings () @@ -443,48 +443,48 @@ type DurationRange struct { // This data type is used in the Subscription () data type. type EventSubscription struct { - // The time at which SubscribeToEvent () is called. - // - // This member is required. - SubscribedAt *time.Time - // The event for which Amazon Simple Notification Service (SNS) notifications are // sent. // // This member is required. Event InspectorEvent + + // The time at which SubscribeToEvent () is called. + // + // This member is required. + SubscribedAt *time.Time } // Contains information about what was excluded from an assessment run. type Exclusion struct { - // The description of the exclusion. + // The ARN that specifies the exclusion. // // This member is required. - Description *string + Arn *string - // The AWS resources for which the exclusion pertains. + // The description of the exclusion. // // This member is required. - Scopes []*Scope - - // The system-defined attributes for the exclusion. - Attributes []*Attribute + Description *string // The recommendation for the exclusion. // // This member is required. Recommendation *string - // The ARN that specifies the exclusion. + // The AWS resources for which the exclusion pertains. // // This member is required. - Arn *string + Scopes []*Scope // The name of the exclusion. // // This member is required. Title *string + + // The system-defined attributes for the exclusion. + Attributes []*Attribute } // Contains information about what is excluded from an assessment run given the @@ -506,111 +506,119 @@ type ExclusionPreview struct { // This member is required. Scopes []*Scope - // The system-defined attributes for the exclusion preview. - Attributes []*Attribute - // The name of the exclusion preview. // // This member is required. Title *string + + // The system-defined attributes for the exclusion preview. + Attributes []*Attribute } // Includes details about the failed items. type FailedItemDetails struct { - // Indicates whether you can immediately retry a request for this item for a - // specified resource. + // The status code of a failed item. // // This member is required. - Retryable *bool + FailureCode FailedItemErrorCode - // The status code of a failed item. + // Indicates whether you can immediately retry a request for this item for a + // specified resource. // // This member is required. - FailureCode FailedItemErrorCode + Retryable *bool } // Contains information about an Amazon Inspector finding. This data type is used // as the response element in the DescribeFindings () action. type Finding struct { - // The finding severity. Values can be set to High, Medium, Low, and Informational. - Severity Severity - - // The numeric value of the finding severity. - NumericSeverity *float64 - - // The name of the finding. - Title *string - // The ARN that specifies the finding. // // This member is required. Arn *string - // The type of the host from which the finding is generated. - AssetType AssetType - - // The schema version of this data type. - SchemaVersion *int32 - - // The ID of the finding. - Id *string - - // The time when AddAttributesToFindings () is called. + // The system-defined attributes for the finding. // // This member is required. - UpdatedAt *time.Time - - // This data type is used in the Finding () data type. - ServiceAttributes *InspectorServiceAttributes - - // The recommendation for the finding. - Recommendation *string + Attributes []*Attribute - // The user-defined attributes that are assigned to the finding. + // The time when the finding was generated. // // This member is required. - UserAttributes []*Attribute + CreatedAt *time.Time - // The system-defined attributes for the finding. + // The time when AddAttributesToFindings () is called. // // This member is required. - Attributes []*Attribute + UpdatedAt *time.Time - // The time when the finding was generated. + // The user-defined attributes that are assigned to the finding. // // This member is required. - CreatedAt *time.Time + UserAttributes []*Attribute // A collection of attributes of the host from which the finding is generated. AssetAttributes *AssetAttributes - // The data element is set to "Inspector". - Service *string + // The type of the host from which the finding is generated. + AssetType AssetType // This data element is currently not used. - IndicatorOfCompromise *bool + Confidence *int32 // The description of the finding. Description *string + // The ID of the finding. + Id *string + // This data element is currently not used. - Confidence *int32 + IndicatorOfCompromise *bool + + // The numeric value of the finding severity. + NumericSeverity *float64 + + // The recommendation for the finding. + Recommendation *string + + // The schema version of this data type. + SchemaVersion *int32 + + // The data element is set to "Inspector". + Service *string + + // This data type is used in the Finding () data type. + ServiceAttributes *InspectorServiceAttributes + + // The finding severity. Values can be set to High, Medium, Low, and Informational. + Severity Severity + + // The name of the finding. + Title *string } // This data type is used as a request parameter in the ListFindings () action. type FindingFilter struct { // For a record to match a filter, one of the values that is specified for this - // data type property must be the exact match of the value of the rulesPackageArn + // data type property must be the exact match of the value of the agentId property + // of the Finding () data type. + AgentIds []*string + + // For a record to match a filter, the list of values that are specified for this + // data type property must be contained in the list of values of the attributes // property of the Finding () data type. - RulesPackageArns []*string + Attributes []*Attribute // For a record to match a filter, one of the values that is specified for this - // data type property must be the exact match of the value of the severity property - // of the Finding () data type. - Severities []Severity + // data type property must be the exact match of the value of the autoScalingGroup + // property of the Finding () data type. + AutoScalingGroups []*string + + // The time range during which the finding is generated. + CreationTimeRange *TimestampRange // For a record to match a filter, one of the values that is specified for this // data type property must be the exact match of the value of the ruleName property @@ -618,40 +626,32 @@ type FindingFilter struct { RuleNames []*string // For a record to match a filter, one of the values that is specified for this - // data type property must be the exact match of the value of the autoScalingGroup - // property of the Finding () data type. - AutoScalingGroups []*string - - // For a record to match a filter, the list of values that are specified for this - // data type property must be contained in the list of values of the attributes + // data type property must be the exact match of the value of the rulesPackageArn // property of the Finding () data type. - Attributes []*Attribute + RulesPackageArns []*string // For a record to match a filter, one of the values that is specified for this - // data type property must be the exact match of the value of the agentId property + // data type property must be the exact match of the value of the severity property // of the Finding () data type. - AgentIds []*string + Severities []Severity // For a record to match a filter, the value that is specified for this data type // property must be contained in the list of values of the userAttributes property // of the Finding () data type. UserAttributes []*Attribute - - // The time range during which the finding is generated. - CreationTimeRange *TimestampRange } // This data type is used in the Finding () data type. type InspectorServiceAttributes struct { - // The ARN of the assessment run during which the finding is generated. - AssessmentRunArn *string - // The schema version of this data type. // // This member is required. SchemaVersion *int32 + // The ARN of the assessment run during which the finding is generated. + AssessmentRunArn *string + // The ARN of the rules package that is used to generate the finding. RulesPackageArn *string } @@ -661,24 +661,11 @@ type InspectorServiceAttributes struct { // () data type. type NetworkInterface struct { - // The ID of the network interface. - NetworkInterfaceId *string - - // The ID of a subnet associated with the network interface. - SubnetId *string - - // A list of the private IP addresses associated with the network interface. - // Includes the privateDnsName and privateIpAddress. - PrivateIpAddresses []*PrivateIp - - // The ID of a VPC associated with the network interface. - VpcId *string - // The IP addresses associated with the network interface. Ipv6Addresses []*string - // The public IP address from which the network interface is reachable. - PublicIp *string + // The ID of the network interface. + NetworkInterfaceId *string // The name of a private DNS associated with the network interface. PrivateDnsName *string @@ -686,12 +673,25 @@ type NetworkInterface struct { // The private IP address associated with the network interface. PrivateIpAddress *string + // A list of the private IP addresses associated with the network interface. + // Includes the privateDnsName and privateIpAddress. + PrivateIpAddresses []*PrivateIp + // The name of a public DNS associated with the network interface. PublicDnsName *string + // The public IP address from which the network interface is reachable. + PublicIp *string + // A list of the security groups associated with the network interface. Includes // the groupId and groupName. SecurityGroups []*SecurityGroup + + // The ID of a subnet associated with the network interface. + SubnetId *string + + // The ID of a VPC associated with the network interface. + VpcId *string } // Contains information about a private IP address associated with a network @@ -699,11 +699,11 @@ type NetworkInterface struct { // () action. type PrivateIp struct { - // The full IP address of the network inteface. - PrivateIpAddress *string - // The DNS name of the private IP address. PrivateDnsName *string + + // The full IP address of the network inteface. + PrivateIpAddress *string } // Contains information about a resource group. The resource group defines a set of @@ -712,21 +712,21 @@ type PrivateIp struct { // DescribeResourceGroups () action. type ResourceGroup struct { - // The tags (key and value pairs) of the resource group. This data type property is - // used in the CreateResourceGroup () action. + // The ARN of the resource group. // // This member is required. - Tags []*ResourceGroupTag + Arn *string // The time at which resource group is created. // // This member is required. CreatedAt *time.Time - // The ARN of the resource group. + // The tags (key and value pairs) of the resource group. This data type property is + // used in the CreateResourceGroup () action. // // This member is required. - Arn *string + Tags []*ResourceGroupTag } // This data type is used as one of the elements of the ResourceGroup () data type. @@ -745,6 +745,11 @@ type ResourceGroupTag struct { // used as the response element in the DescribeRulesPackages () action. type RulesPackage struct { + // The ARN of the rules package. + // + // This member is required. + Arn *string + // The name of the rules package. // // This member is required. @@ -760,11 +765,6 @@ type RulesPackage struct { // This member is required. Version *string - // The ARN of the rules package. - // - // This member is required. - Arn *string - // The description of the rules package. Description *string } @@ -772,11 +772,11 @@ type RulesPackage struct { // This data type contains key-value pairs that identify various Amazon resources. type Scope struct { - // The resource identifier for the specified scope type. - Value *string - // The type of the scope. Key ScopeType + + // The resource identifier for the specified scope type. + Value *string } // Contains information about a security group associated with a network interface. @@ -784,11 +784,11 @@ type Scope struct { // type. type SecurityGroup struct { - // The name of the security group. - GroupName *string - // The ID of the security group. GroupId *string + + // The name of the security group. + GroupName *string } // This data type is used as a response element in the ListEventSubscriptions () @@ -800,17 +800,17 @@ type Subscription struct { // This member is required. EventSubscriptions []*EventSubscription - // The ARN of the Amazon Simple Notification Service (SNS) topic to which the SNS - // notifications are sent. - // - // This member is required. - TopicArn *string - // The ARN of the assessment template that is used during the event for which the // SNS notification is sent. // // This member is required. ResourceArn *string + + // The ARN of the Amazon Simple Notification Service (SNS) topic to which the SNS + // notifications are sent. + // + // This member is required. + TopicArn *string } // A key and value pair. This data type is used as a request parameter in the @@ -818,13 +818,13 @@ type Subscription struct { // () action. type Tag struct { - // A value assigned to a tag key. - Value *string - // A tag key. // // This member is required. Key *string + + // A value assigned to a tag key. + Value *string } // The metadata about the Amazon Inspector application data metrics collected by @@ -837,21 +837,21 @@ type TelemetryMetadata struct { // This member is required. Count *int64 - // The data size of messages that the agent sends to the Amazon Inspector service. - DataSize *int64 - // A specific type of behavioral data that is collected by the agent. // // This member is required. MessageType *string + + // The data size of messages that the agent sends to the Amazon Inspector service. + DataSize *int64 } // This data type is used in the AssessmentRunFilter () data type. type TimestampRange struct { - // The maximum value of the timestamp range. - EndDate *time.Time - // The minimum value of the timestamp range. BeginDate *time.Time + + // The maximum value of the timestamp range. + EndDate *time.Time } diff --git a/service/internal/benchmark/go.mod b/service/internal/benchmark/go.mod index a3b9eab0e92..05a41926d0e 100644 --- a/service/internal/benchmark/go.mod +++ b/service/internal/benchmark/go.mod @@ -6,9 +6,9 @@ require ( github.com/aws/aws-sdk-go v1.34.33 github.com/aws/aws-sdk-go-v2 v0.26.0 github.com/aws/aws-sdk-go-v2/service/dynamodb v0.26.0 + github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v0.1.0 // indirect github.com/aws/aws-sdk-go-v2/service/lexruntimeservice v0.26.0 github.com/awslabs/smithy-go v0.1.1 - github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v0.1.0 ) replace github.com/aws/aws-sdk-go-v2 => ../../../ @@ -16,3 +16,5 @@ replace github.com/aws/aws-sdk-go-v2 => ../../../ replace github.com/aws/aws-sdk-go-v2/service/dynamodb => ../../../service/dynamodb/ replace github.com/aws/aws-sdk-go-v2/service/lexruntimeservice => ../../../service/lexruntimeservice/ + +replace github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding => ../../../service/internal/accept-encoding/ diff --git a/service/internal/benchmark/go.sum b/service/internal/benchmark/go.sum index 23ebef5fa07..27081a9ae92 100644 --- a/service/internal/benchmark/go.sum +++ b/service/internal/benchmark/go.sum @@ -1,7 +1,5 @@ github.com/aws/aws-sdk-go v1.34.33 h1:ymkFm0rNPEOlgjyX3ojEd4zqzW6kGICBkqWs7LqgHtU= github.com/aws/aws-sdk-go v1.34.33/go.mod h1:H7NKnBqNVzoTJpGfLrQkkD+ytBA93eiDYi/+8rV9s48= -github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v0.0.0-20200930084954-897dfb99530c h1:v1H0WQmb+pNOZ/xDXGT3wXn6aceSN3I2wqK0VpQM/ZM= -github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v0.0.0-20200930084954-897dfb99530c/go.mod h1:GRJ/IvA6A00/2tAw9KgMTM8as5gAlNI0FVCKBc+aRnA= github.com/awslabs/smithy-go v0.0.0-20200930175536-2cd7f70a8c2f/go.mod h1:hPOQwnmBLHsUphH13tVSjQhTAFma0/0XoZGbBcOuABI= github.com/awslabs/smithy-go v0.1.0 h1:yltioxA96yA1Fv+fE+5FFXnbFgw3ngpeEV++TUUktiM= github.com/awslabs/smithy-go v0.1.0/go.mod h1:hPOQwnmBLHsUphH13tVSjQhTAFma0/0XoZGbBcOuABI= diff --git a/service/internal/integrationtest/go.mod b/service/internal/integrationtest/go.mod index 09792189eac..fa216277f00 100644 --- a/service/internal/integrationtest/go.mod +++ b/service/internal/integrationtest/go.mod @@ -50,6 +50,8 @@ require ( github.com/aws/aws-sdk-go-v2/service/health v0.26.0 github.com/aws/aws-sdk-go-v2/service/iam v0.26.0 github.com/aws/aws-sdk-go-v2/service/inspector v0.26.0 + github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v0.1.0 // indirect + github.com/aws/aws-sdk-go-v2/service/internal/s3shared v0.1.1 // indirect github.com/aws/aws-sdk-go-v2/service/iot v0.26.0 github.com/aws/aws-sdk-go-v2/service/kinesis v0.26.0 github.com/aws/aws-sdk-go-v2/service/kms v0.26.0 @@ -84,10 +86,6 @@ require ( github.com/aws/aws-sdk-go-v2/service/wafv2 v0.26.0 github.com/aws/aws-sdk-go-v2/service/workspaces v0.26.0 github.com/awslabs/smithy-go v0.1.1 - github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v0.1.0 - github.com/aws/aws-sdk-go-v2/credentials v0.1.1 - github.com/aws/aws-sdk-go-v2/ec2imds v0.1.1 - github.com/aws/aws-sdk-go-v2/service/internal/s3shared v0.1.1 ) go 1.15 @@ -261,3 +259,5 @@ replace github.com/aws/aws-sdk-go-v2/credentials => ../../../credentials/ replace github.com/aws/aws-sdk-go-v2/ec2imds => ../../../ec2imds/ replace github.com/aws/aws-sdk-go-v2/service/internal/s3shared => ../../../service/internal/s3shared/ + +replace github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding => ../../../service/internal/accept-encoding/ diff --git a/service/internal/integrationtest/go.sum b/service/internal/integrationtest/go.sum index 77e5beae7eb..6355e414a1e 100644 --- a/service/internal/integrationtest/go.sum +++ b/service/internal/integrationtest/go.sum @@ -1,5 +1,3 @@ -github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v0.0.0-20200930084954-897dfb99530c h1:v1H0WQmb+pNOZ/xDXGT3wXn6aceSN3I2wqK0VpQM/ZM= -github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v0.0.0-20200930084954-897dfb99530c/go.mod h1:GRJ/IvA6A00/2tAw9KgMTM8as5gAlNI0FVCKBc+aRnA= github.com/awslabs/smithy-go v0.0.0-20200930175536-2cd7f70a8c2f/go.mod h1:hPOQwnmBLHsUphH13tVSjQhTAFma0/0XoZGbBcOuABI= github.com/awslabs/smithy-go v0.1.0 h1:yltioxA96yA1Fv+fE+5FFXnbFgw3ngpeEV++TUUktiM= github.com/awslabs/smithy-go v0.1.0/go.mod h1:hPOQwnmBLHsUphH13tVSjQhTAFma0/0XoZGbBcOuABI= diff --git a/service/iot/api_op_AddThingToBillingGroup.go b/service/iot/api_op_AddThingToBillingGroup.go index d68fd831bbe..f65307023d6 100644 --- a/service/iot/api_op_AddThingToBillingGroup.go +++ b/service/iot/api_op_AddThingToBillingGroup.go @@ -58,14 +58,14 @@ type AddThingToBillingGroupInput struct { // The ARN of the billing group. BillingGroupArn *string - // The name of the thing to be added to the billing group. - ThingName *string + // The name of the billing group. + BillingGroupName *string // The ARN of the thing to be added to the billing group. ThingArn *string - // The name of the billing group. - BillingGroupName *string + // The name of the thing to be added to the billing group. + ThingName *string } type AddThingToBillingGroupOutput struct { diff --git a/service/iot/api_op_AddThingToThingGroup.go b/service/iot/api_op_AddThingToThingGroup.go index bd189fdc382..696ce192771 100644 --- a/service/iot/api_op_AddThingToThingGroup.go +++ b/service/iot/api_op_AddThingToThingGroup.go @@ -55,12 +55,6 @@ func (c *Client) AddThingToThingGroup(ctx context.Context, params *AddThingToThi type AddThingToThingGroupInput struct { - // The name of the thing to add to a group. - ThingName *string - - // The name of the group to which you are adding a thing. - ThingGroupName *string - // Override dynamic thing groups with static thing groups when 10-group limit is // reached. If a thing belongs to 10 thing groups, and one or more of those groups // are dynamic thing groups, adding a thing to a static group removes the thing @@ -72,6 +66,12 @@ type AddThingToThingGroupInput struct { // The ARN of the group to which you are adding a thing. ThingGroupArn *string + + // The name of the group to which you are adding a thing. + ThingGroupName *string + + // The name of the thing to add to a group. + ThingName *string } type AddThingToThingGroupOutput struct { diff --git a/service/iot/api_op_AssociateTargetsWithJob.go b/service/iot/api_op_AssociateTargetsWithJob.go index 172d3a495b4..7242bf1d1d0 100644 --- a/service/iot/api_op_AssociateTargetsWithJob.go +++ b/service/iot/api_op_AssociateTargetsWithJob.go @@ -82,12 +82,12 @@ type AssociateTargetsWithJobInput struct { type AssociateTargetsWithJobOutput struct { - // An ARN identifying the job. - JobArn *string - // A short text description of the job. Description *string + // An ARN identifying the job. + JobArn *string + // The unique identifier you assigned to this job when it was created. JobId *string diff --git a/service/iot/api_op_AttachPolicy.go b/service/iot/api_op_AttachPolicy.go index 0c06bda858a..923f003783d 100644 --- a/service/iot/api_op_AttachPolicy.go +++ b/service/iot/api_op_AttachPolicy.go @@ -56,17 +56,17 @@ func (c *Client) AttachPolicy(ctx context.Context, params *AttachPolicyInput, op type AttachPolicyInput struct { + // The name of the policy to attach. + // + // This member is required. + PolicyName *string + // The identity // (https://docs.aws.amazon.com/iot/latest/developerguide/security-iam.html) to // which the policy is attached. // // This member is required. Target *string - - // The name of the policy to attach. - // - // This member is required. - PolicyName *string } type AttachPolicyOutput struct { diff --git a/service/iot/api_op_AttachSecurityProfile.go b/service/iot/api_op_AttachSecurityProfile.go index 88610279bef..b6b8aaaa6cd 100644 --- a/service/iot/api_op_AttachSecurityProfile.go +++ b/service/iot/api_op_AttachSecurityProfile.go @@ -58,15 +58,15 @@ func (c *Client) AttachSecurityProfile(ctx context.Context, params *AttachSecuri type AttachSecurityProfileInput struct { - // The ARN of the target (thing group) to which the security profile is attached. + // The security profile that is attached. // // This member is required. - SecurityProfileTargetArn *string + SecurityProfileName *string - // The security profile that is attached. + // The ARN of the target (thing group) to which the security profile is attached. // // This member is required. - SecurityProfileName *string + SecurityProfileTargetArn *string } type AttachSecurityProfileOutput struct { diff --git a/service/iot/api_op_CancelJob.go b/service/iot/api_op_CancelJob.go index 2b1b853d8f4..cbedd3e8360 100644 --- a/service/iot/api_op_CancelJob.go +++ b/service/iot/api_op_CancelJob.go @@ -64,9 +64,6 @@ type CancelJobInput struct { // An optional comment string describing why the job was canceled. Comment *string - // (Optional)A reason code string that explains why the job was canceled. - ReasonCode *string - // (Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are // canceled, otherwise only job executions with status "QUEUED" are canceled. The // default is false. Canceling a job which is "IN_PROGRESS", will cause a device @@ -74,18 +71,21 @@ type CancelJobInput struct { // caution and ensure that each device executing a job which is canceled is able to // recover to a valid state. Force *bool + + // (Optional)A reason code string that explains why the job was canceled. + ReasonCode *string } type CancelJobOutput struct { - // The unique identifier you assigned to this job when it was created. - JobId *string + // A short text description of the job. + Description *string // The job ARN. JobArn *string - // A short text description of the job. - Description *string + // The unique identifier you assigned to this job when it was created. + JobId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/iot/api_op_CancelJobExecution.go b/service/iot/api_op_CancelJobExecution.go index edeeeb02913..7582a9ca541 100644 --- a/service/iot/api_op_CancelJobExecution.go +++ b/service/iot/api_op_CancelJobExecution.go @@ -56,20 +56,15 @@ func (c *Client) CancelJobExecution(ctx context.Context, params *CancelJobExecut type CancelJobExecutionInput struct { - // A collection of name/value pairs that describe the status of the job execution. - // If not specified, the statusDetails are unchanged. You can specify at most 10 - // name/value pairs. - StatusDetails map[string]*string + // The ID of the job to be canceled. + // + // This member is required. + JobId *string - // (Optional) If true the job execution will be canceled if it has status - // IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it - // has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, - // and you do not set force to true, then an InvalidStateTransitionException will - // be thrown. The default is false. Canceling a job execution which is - // "IN_PROGRESS", will cause the device to be unable to update the job execution - // status. Use caution and ensure that the device is able to recover to a valid - // state. - Force *bool + // The name of the thing whose execution of the job will be canceled. + // + // This member is required. + ThingName *string // (Optional) The expected current version of the job execution. Each time you // update the job execution, its version is incremented. If the version of the job @@ -80,15 +75,20 @@ type CancelJobExecutionInput struct { // status data.) ExpectedVersion *int64 - // The ID of the job to be canceled. - // - // This member is required. - JobId *string + // (Optional) If true the job execution will be canceled if it has status + // IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it + // has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, + // and you do not set force to true, then an InvalidStateTransitionException will + // be thrown. The default is false. Canceling a job execution which is + // "IN_PROGRESS", will cause the device to be unable to update the job execution + // status. Use caution and ensure that the device is able to recover to a valid + // state. + Force *bool - // The name of the thing whose execution of the job will be canceled. - // - // This member is required. - ThingName *string + // A collection of name/value pairs that describe the status of the job execution. + // If not specified, the statusDetails are unchanged. You can specify at most 10 + // name/value pairs. + StatusDetails map[string]*string } type CancelJobExecutionOutput struct { diff --git a/service/iot/api_op_CreateAuthorizer.go b/service/iot/api_op_CreateAuthorizer.go index dc0c816cf2b..8e60c5eb5b1 100644 --- a/service/iot/api_op_CreateAuthorizer.go +++ b/service/iot/api_op_CreateAuthorizer.go @@ -57,35 +57,35 @@ func (c *Client) CreateAuthorizer(ctx context.Context, params *CreateAuthorizerI type CreateAuthorizerInput struct { - // The public keys used to verify the digital signature returned by your custom - // authentication service. - TokenSigningPublicKeys map[string]*string - - // The name of the token key used to extract the token from the HTTP headers. - TokenKeyName *string - - // Specifies whether AWS IoT validates the token signature in an authorization - // request. - SigningDisabled *bool + // The ARN of the authorizer's Lambda function. + // + // This member is required. + AuthorizerFunctionArn *string // The authorizer name. // // This member is required. AuthorizerName *string + // Specifies whether AWS IoT validates the token signature in an authorization + // request. + SigningDisabled *bool + // The status of the create authorizer request. Status types.AuthorizerStatus - // The ARN of the authorizer's Lambda function. - // - // This member is required. - AuthorizerFunctionArn *string - // Metadata which can be used to manage the custom authorizer. For URI Request // parameters use format: ...key1=value1&key2=value2... For the CLI command-line // parameter use format: &&tags "key1=value1&key2=value2..." For the cli-input-json // file use format: "tags": "key1=value1&key2=value2..." Tags []*types.Tag + + // The name of the token key used to extract the token from the HTTP headers. + TokenKeyName *string + + // The public keys used to verify the digital signature returned by your custom + // authentication service. + TokenSigningPublicKeys map[string]*string } type CreateAuthorizerOutput struct { diff --git a/service/iot/api_op_CreateBillingGroup.go b/service/iot/api_op_CreateBillingGroup.go index 0e2e9b535d2..7b3058baeb4 100644 --- a/service/iot/api_op_CreateBillingGroup.go +++ b/service/iot/api_op_CreateBillingGroup.go @@ -57,29 +57,29 @@ func (c *Client) CreateBillingGroup(ctx context.Context, params *CreateBillingGr type CreateBillingGroupInput struct { - // Metadata which can be used to manage the billing group. - Tags []*types.Tag - - // The properties of the billing group. - BillingGroupProperties *types.BillingGroupProperties - // The name you wish to give to the billing group. // // This member is required. BillingGroupName *string + + // The properties of the billing group. + BillingGroupProperties *types.BillingGroupProperties + + // Metadata which can be used to manage the billing group. + Tags []*types.Tag } type CreateBillingGroupOutput struct { + // The ARN of the billing group. + BillingGroupArn *string + // The ID of the billing group. BillingGroupId *string // The name you gave to the billing group. BillingGroupName *string - // The ARN of the billing group. - BillingGroupArn *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_CreateCertificateFromCsr.go b/service/iot/api_op_CreateCertificateFromCsr.go index f7f6f6cd943..de96523e928 100644 --- a/service/iot/api_op_CreateCertificateFromCsr.go +++ b/service/iot/api_op_CreateCertificateFromCsr.go @@ -81,28 +81,28 @@ func (c *Client) CreateCertificateFromCsr(ctx context.Context, params *CreateCer // The input for the CreateCertificateFromCsr operation. type CreateCertificateFromCsrInput struct { - // Specifies whether the certificate is active. - SetAsActive *bool - // The certificate signing request (CSR). // // This member is required. CertificateSigningRequest *string + + // Specifies whether the certificate is active. + SetAsActive *bool } // The output from the CreateCertificateFromCsr operation. type CreateCertificateFromCsrOutput struct { - // The certificate data, in PEM format. - CertificatePem *string + // The Amazon Resource Name (ARN) of the certificate. You can use the ARN as a + // principal for policy operations. + CertificateArn *string // The ID of the certificate. Certificate management operations only take a // certificateId. CertificateId *string - // The Amazon Resource Name (ARN) of the certificate. You can use the ARN as a - // principal for policy operations. - CertificateArn *string + // The certificate data, in PEM format. + CertificatePem *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/iot/api_op_CreateDimension.go b/service/iot/api_op_CreateDimension.go index a87e0f1a44a..cf3922b85f6 100644 --- a/service/iot/api_op_CreateDimension.go +++ b/service/iot/api_op_CreateDimension.go @@ -62,16 +62,6 @@ func (c *Client) CreateDimension(ctx context.Context, params *CreateDimensionInp type CreateDimensionInput struct { - // Specifies the value or list of values for the dimension. For TOPIC_FILTER - // dimensions, this is a pattern used to match the MQTT topic (for example, - // "admin/#"). - // - // This member is required. - StringValues []*string - - // Metadata that can be used to manage the dimension. - Tags []*types.Tag - // Each dimension must have a unique client request token. If you try to create a // new dimension with the same token as a dimension that already exists, an // exception occurs. If you omit this value, AWS SDKs will automatically generate a @@ -80,26 +70,36 @@ type CreateDimensionInput struct { // This member is required. ClientRequestToken *string - // Specifies the type of dimension. Supported types: TOPIC_FILTER. - // - // This member is required. - Type types.DimensionType - // A unique identifier for the dimension. Choose something that describes the type // and value to make it easy to remember what it does. // // This member is required. Name *string + + // Specifies the value or list of values for the dimension. For TOPIC_FILTER + // dimensions, this is a pattern used to match the MQTT topic (for example, + // "admin/#"). + // + // This member is required. + StringValues []*string + + // Specifies the type of dimension. Supported types: TOPIC_FILTER. + // + // This member is required. + Type types.DimensionType + + // Metadata that can be used to manage the dimension. + Tags []*types.Tag } type CreateDimensionOutput struct { - // A unique identifier for the dimension. - Name *string - // The ARN (Amazon resource name) of the created dimension. Arn *string + // A unique identifier for the dimension. + Name *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_CreateDomainConfiguration.go b/service/iot/api_op_CreateDomainConfiguration.go index db55514d4e7..3d2ce734616 100644 --- a/service/iot/api_op_CreateDomainConfiguration.go +++ b/service/iot/api_op_CreateDomainConfiguration.go @@ -63,22 +63,17 @@ type CreateDomainConfigurationInput struct { // This member is required. DomainConfigurationName *string + // An object that specifies the authorization service for a domain. + AuthorizerConfig *types.AuthorizerConfig + // The name of the domain. DomainName *string - // The certificate used to validate the server certificate and prove domain name - // ownership. This certificate must be signed by a public certificate authority. - // This value is not required for AWS-managed domains. - ValidationCertificateArn *string - // The ARNs of the certificates that AWS IoT passes to the device during the TLS // handshake. Currently you can specify only one certificate ARN. This value is not // required for AWS-managed domains. ServerCertificateArns []*string - // An object that specifies the authorization service for a domain. - AuthorizerConfig *types.AuthorizerConfig - // The type of service delivered by the endpoint. AWS IoT Core currently supports // only the DATA service type. ServiceType types.ServiceType @@ -88,16 +83,21 @@ type CreateDomainConfigurationInput struct { // parameter use format: &&tags "key1=value1&key2=value2..." For the cli-input-json // file use format: "tags": "key1=value1&key2=value2..." Tags []*types.Tag + + // The certificate used to validate the server certificate and prove domain name + // ownership. This certificate must be signed by a public certificate authority. + // This value is not required for AWS-managed domains. + ValidationCertificateArn *string } type CreateDomainConfigurationOutput struct { - // The name of the domain configuration. - DomainConfigurationName *string - // The ARN of the domain configuration. DomainConfigurationArn *string + // The name of the domain configuration. + DomainConfigurationName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_CreateDynamicThingGroup.go b/service/iot/api_op_CreateDynamicThingGroup.go index d6335e81a81..ae35e073b50 100644 --- a/service/iot/api_op_CreateDynamicThingGroup.go +++ b/service/iot/api_op_CreateDynamicThingGroup.go @@ -57,17 +57,6 @@ func (c *Client) CreateDynamicThingGroup(ctx context.Context, params *CreateDyna type CreateDynamicThingGroupInput struct { - // The dynamic thing group query version. Currently one query version is supported: - // "2017-09-30". If not specified, the query version defaults to this value. - QueryVersion *string - - // The dynamic thing group index name. Currently one index is supported: - // "AWS_Things". - IndexName *string - - // The dynamic thing group properties. - ThingGroupProperties *types.ThingGroupProperties - // The dynamic thing group search query string. See Query Syntax // (https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html) for // information about query string syntax. @@ -80,14 +69,25 @@ type CreateDynamicThingGroupInput struct { // This member is required. ThingGroupName *string + // The dynamic thing group index name. Currently one index is supported: + // "AWS_Things". + IndexName *string + + // The dynamic thing group query version. Currently one query version is supported: + // "2017-09-30". If not specified, the query version defaults to this value. + QueryVersion *string + // Metadata which can be used to manage the dynamic thing group. Tags []*types.Tag + + // The dynamic thing group properties. + ThingGroupProperties *types.ThingGroupProperties } type CreateDynamicThingGroupOutput struct { - // The dynamic thing group ARN. - ThingGroupArn *string + // The dynamic thing group index name. + IndexName *string // The dynamic thing group search query string. QueryString *string @@ -95,15 +95,15 @@ type CreateDynamicThingGroupOutput struct { // The dynamic thing group query version. QueryVersion *string - // The dynamic thing group name. - ThingGroupName *string - - // The dynamic thing group index name. - IndexName *string + // The dynamic thing group ARN. + ThingGroupArn *string // The dynamic thing group ID. ThingGroupId *string + // The dynamic thing group name. + ThingGroupName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_CreateJob.go b/service/iot/api_op_CreateJob.go index 97b241938ca..af3f0b12978 100644 --- a/service/iot/api_op_CreateJob.go +++ b/service/iot/api_op_CreateJob.go @@ -57,42 +57,42 @@ func (c *Client) CreateJob(ctx context.Context, params *CreateJobInput, optFns . type CreateJobInput struct { - // The job document. If the job document resides in an S3 bucket, you must use a - // placeholder link when specifying the document. The placeholder link is of the - // following form: ${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key} - // where bucket is your bucket name and key is the object in the bucket to which - // you are linking. - Document *string - // A job identifier which must be unique for your AWS account. We recommend using a // UUID. Alpha-numeric characters, "-" and "_" are valid for use here. // // This member is required. JobId *string - // Specifies the amount of time each device has to finish its execution of the job. - // The timer is started when the job execution status is set to IN_PROGRESS. If the - // job execution status is not set to another terminal state before the time - // expires, it will be automatically set to TIMED_OUT. - TimeoutConfig *types.TimeoutConfig - // A list of things and thing groups to which the job should be sent. // // This member is required. Targets []*string - // Metadata which can be used to manage the job. - Tags []*types.Tag - - // An S3 link to the job document. - DocumentSource *string - // Allows you to create criteria to abort a job. AbortConfig *types.AbortConfig // A short text description of the job. Description *string + // The job document. If the job document resides in an S3 bucket, you must use a + // placeholder link when specifying the document. The placeholder link is of the + // following form: ${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key} + // where bucket is your bucket name and key is the object in the bucket to which + // you are linking. + Document *string + + // An S3 link to the job document. + DocumentSource *string + + // Allows you to create a staged rollout of the job. + JobExecutionsRolloutConfig *types.JobExecutionsRolloutConfig + + // Configuration information for pre-signed S3 URLs. + PresignedUrlConfig *types.PresignedUrlConfig + + // Metadata which can be used to manage the job. + Tags []*types.Tag + // Specifies whether the job will continue to run (CONTINUOUS), or will be complete // after all those things specified as targets have completed the job (SNAPSHOT). // If continuous, the job may also be run on a thing when a change is detected in a @@ -101,24 +101,24 @@ type CreateJobInput struct { // group. TargetSelection types.TargetSelection - // Allows you to create a staged rollout of the job. - JobExecutionsRolloutConfig *types.JobExecutionsRolloutConfig - - // Configuration information for pre-signed S3 URLs. - PresignedUrlConfig *types.PresignedUrlConfig + // Specifies the amount of time each device has to finish its execution of the job. + // The timer is started when the job execution status is set to IN_PROGRESS. If the + // job execution status is not set to another terminal state before the time + // expires, it will be automatically set to TIMED_OUT. + TimeoutConfig *types.TimeoutConfig } type CreateJobOutput struct { - // The unique identifier you assigned to this job. - JobId *string - // The job description. Description *string // The job ARN. JobArn *string + // The unique identifier you assigned to this job. + JobId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_CreateKeysAndCertificate.go b/service/iot/api_op_CreateKeysAndCertificate.go index 3fddbd9240a..62717044452 100644 --- a/service/iot/api_op_CreateKeysAndCertificate.go +++ b/service/iot/api_op_CreateKeysAndCertificate.go @@ -72,9 +72,6 @@ type CreateKeysAndCertificateOutput struct { // The ARN of the certificate. CertificateArn *string - // The generated key pair. - KeyPair *types.KeyPair - // The ID of the certificate. AWS IoT issues a default subject name for the // certificate (for example, AWS IoT Certificate). CertificateId *string @@ -82,6 +79,9 @@ type CreateKeysAndCertificateOutput struct { // The certificate data, in PEM format. CertificatePem *string + // The generated key pair. + KeyPair *types.KeyPair + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_CreateMitigationAction.go b/service/iot/api_op_CreateMitigationAction.go index 239528e3cc4..e707f81b396 100644 --- a/service/iot/api_op_CreateMitigationAction.go +++ b/service/iot/api_op_CreateMitigationAction.go @@ -59,34 +59,34 @@ func (c *Client) CreateMitigationAction(ctx context.Context, params *CreateMitig type CreateMitigationActionInput struct { - // Metadata that can be used to manage the mitigation action. - Tags []*types.Tag - // A friendly name for the action. Choose a friendly name that accurately describes // the action (for example, EnableLoggingAction). // // This member is required. ActionName *string - // The ARN of the IAM role that is used to apply the mitigation action. + // Defines the type of action and the parameters for that action. // // This member is required. - RoleArn *string + ActionParams *types.MitigationActionParams - // Defines the type of action and the parameters for that action. + // The ARN of the IAM role that is used to apply the mitigation action. // // This member is required. - ActionParams *types.MitigationActionParams + RoleArn *string + + // Metadata that can be used to manage the mitigation action. + Tags []*types.Tag } type CreateMitigationActionOutput struct { - // A unique identifier for the new mitigation action. - ActionId *string - // The ARN for the new mitigation action. ActionArn *string + // A unique identifier for the new mitigation action. + ActionId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_CreateOTAUpdate.go b/service/iot/api_op_CreateOTAUpdate.go index 8d797fb67d4..59e0d5a4e72 100644 --- a/service/iot/api_op_CreateOTAUpdate.go +++ b/service/iot/api_op_CreateOTAUpdate.go @@ -57,8 +57,15 @@ func (c *Client) CreateOTAUpdate(ctx context.Context, params *CreateOTAUpdateInp type CreateOTAUpdateInput struct { - // Configuration for the rollout of OTA updates. - AwsJobExecutionsRolloutConfig *types.AwsJobExecutionsRolloutConfig + // The files to be streamed by the OTA update. + // + // This member is required. + Files []*types.OTAUpdateFile + + // The ID of the OTA update to be created. + // + // This member is required. + OtaUpdateId *string // The IAM role that grants AWS IoT access to the Amazon S3, AWS IoT jobs and AWS // Code Signing resources to create an OTA update job. @@ -71,22 +78,17 @@ type CreateOTAUpdateInput struct { // This member is required. Targets []*string - // The protocol used to transfer the OTA update image. Valid values are [HTTP], - // [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device - // can choose the protocol. - Protocols []types.Protocol - - // Configuration information for pre-signed URLs. - AwsJobPresignedUrlConfig *types.AwsJobPresignedUrlConfig + // A list of additional OTA update parameters which are name-value pairs. + AdditionalParameters map[string]*string // The criteria that determine when and how a job abort takes place. AwsJobAbortConfig *types.AwsJobAbortConfig - // A list of additional OTA update parameters which are name-value pairs. - AdditionalParameters map[string]*string + // Configuration for the rollout of OTA updates. + AwsJobExecutionsRolloutConfig *types.AwsJobExecutionsRolloutConfig - // The description of the OTA update. - Description *string + // Configuration information for pre-signed URLs. + AwsJobPresignedUrlConfig *types.AwsJobPresignedUrlConfig // Specifies the amount of time each device has to finish its execution of the job. // A timer is started when the job execution status is set to IN_PROGRESS. If the @@ -94,10 +96,13 @@ type CreateOTAUpdateInput struct { // expires, it will be automatically set to TIMED_OUT. AwsJobTimeoutConfig *types.AwsJobTimeoutConfig - // The files to be streamed by the OTA update. - // - // This member is required. - Files []*types.OTAUpdateFile + // The description of the OTA update. + Description *string + + // The protocol used to transfer the OTA update image. Valid values are [HTTP], + // [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device + // can choose the protocol. + Protocols []types.Protocol // Metadata which can be used to manage updates. Tags []*types.Tag @@ -109,17 +114,12 @@ type CreateOTAUpdateInput struct { // thing is added to a target group, even after the update was completed by all // things originally in the group. Valid values: CONTINUOUS | SNAPSHOT. TargetSelection types.TargetSelection - - // The ID of the OTA update to be created. - // - // This member is required. - OtaUpdateId *string } type CreateOTAUpdateOutput struct { - // The OTA update ID. - OtaUpdateId *string + // The AWS IoT job ARN associated with the OTA update. + AwsIotJobArn *string // The AWS IoT job ID associated with the OTA update. AwsIotJobId *string @@ -127,12 +127,12 @@ type CreateOTAUpdateOutput struct { // The OTA update ARN. OtaUpdateArn *string + // The OTA update ID. + OtaUpdateId *string + // The OTA update status. OtaUpdateStatus types.OTAUpdateStatus - // The AWS IoT job ARN associated with the OTA update. - AwsIotJobArn *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_CreatePolicy.go b/service/iot/api_op_CreatePolicy.go index 9ceb5173f49..8b86eb535b4 100644 --- a/service/iot/api_op_CreatePolicy.go +++ b/service/iot/api_op_CreatePolicy.go @@ -60,27 +60,30 @@ func (c *Client) CreatePolicy(ctx context.Context, params *CreatePolicyInput, op // The input for the CreatePolicy operation. type CreatePolicyInput struct { - // Metadata which can be used to manage the policy. For URI Request parameters use - // format: ...key1=value1&key2=value2... For the CLI command-line parameter use - // format: &&tags "key1=value1&key2=value2..." For the cli-input-json file use - // format: "tags": "key1=value1&key2=value2..." - Tags []*types.Tag + // The JSON document that describes the policy. policyDocument must have a minimum + // length of 1, with a maximum length of 2048, excluding whitespace. + // + // This member is required. + PolicyDocument *string // The policy name. // // This member is required. PolicyName *string - // The JSON document that describes the policy. policyDocument must have a minimum - // length of 1, with a maximum length of 2048, excluding whitespace. - // - // This member is required. - PolicyDocument *string + // Metadata which can be used to manage the policy. For URI Request parameters use + // format: ...key1=value1&key2=value2... For the CLI command-line parameter use + // format: &&tags "key1=value1&key2=value2..." For the cli-input-json file use + // format: "tags": "key1=value1&key2=value2..." + Tags []*types.Tag } // The output from the CreatePolicy operation. type CreatePolicyOutput struct { + // The policy ARN. + PolicyArn *string + // The JSON document that describes the policy. PolicyDocument *string @@ -90,9 +93,6 @@ type CreatePolicyOutput struct { // The policy version ID. PolicyVersionId *string - // The policy ARN. - PolicyArn *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_CreatePolicyVersion.go b/service/iot/api_op_CreatePolicyVersion.go index 6da11d3b0ed..ae02215d4fb 100644 --- a/service/iot/api_op_CreatePolicyVersion.go +++ b/service/iot/api_op_CreatePolicyVersion.go @@ -63,11 +63,6 @@ func (c *Client) CreatePolicyVersion(ctx context.Context, params *CreatePolicyVe // The input for the CreatePolicyVersion operation. type CreatePolicyVersionInput struct { - // Specifies whether the policy version is set as the default. When this parameter - // is true, the new policy version becomes the operative version (that is, the - // version that is in effect for the certificates to which the policy is attached). - SetAsDefault *bool - // The JSON document that describes the policy. Minimum length of 1. Maximum length // of 2048, excluding whitespace. // @@ -78,23 +73,28 @@ type CreatePolicyVersionInput struct { // // This member is required. PolicyName *string + + // Specifies whether the policy version is set as the default. When this parameter + // is true, the new policy version becomes the operative version (that is, the + // version that is in effect for the certificates to which the policy is attached). + SetAsDefault *bool } // The output of the CreatePolicyVersion operation. type CreatePolicyVersionOutput struct { - // The JSON document that describes the policy. - PolicyDocument *string - // Specifies whether the policy version is the default. IsDefaultVersion *bool - // The policy version ID. - PolicyVersionId *string - // The policy ARN. PolicyArn *string + // The JSON document that describes the policy. + PolicyDocument *string + + // The policy version ID. + PolicyVersionId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_CreateProvisioningClaim.go b/service/iot/api_op_CreateProvisioningClaim.go index 05b9205ba60..36c8c0aff83 100644 --- a/service/iot/api_op_CreateProvisioningClaim.go +++ b/service/iot/api_op_CreateProvisioningClaim.go @@ -66,15 +66,15 @@ type CreateProvisioningClaimInput struct { type CreateProvisioningClaimOutput struct { + // The ID of the certificate. + CertificateId *string + // The provisioning claim certificate. CertificatePem *string // The provisioning claim expiration time. Expiration *time.Time - // The ID of the certificate. - CertificateId *string - // The provisioning claim key pair. KeyPair *types.KeyPair diff --git a/service/iot/api_op_CreateProvisioningTemplate.go b/service/iot/api_op_CreateProvisioningTemplate.go index fddd20c67a2..1e624de8950 100644 --- a/service/iot/api_op_CreateProvisioningTemplate.go +++ b/service/iot/api_op_CreateProvisioningTemplate.go @@ -57,49 +57,49 @@ func (c *Client) CreateProvisioningTemplate(ctx context.Context, params *CreateP type CreateProvisioningTemplateInput struct { - // The description of the fleet provisioning template. - Description *string - - // True to enable the fleet provisioning template, otherwise false. - Enabled *bool - // The role ARN for the role associated with the fleet provisioning template. This // IoT role grants permission to provision a device. // // This member is required. ProvisioningRoleArn *string - // Metadata which can be used to manage the fleet provisioning template. For URI - // Request parameters use format: ...key1=value1&key2=value2... For the CLI - // command-line parameter use format: &&tags "key1=value1&key2=value2..." For the - // cli-input-json file use format: "tags": "key1=value1&key2=value2..." - Tags []*types.Tag - - // Creates a pre-provisioning hook template. - PreProvisioningHook *types.ProvisioningHook + // The JSON formatted contents of the fleet provisioning template. + // + // This member is required. + TemplateBody *string // The name of the fleet provisioning template. // // This member is required. TemplateName *string - // The JSON formatted contents of the fleet provisioning template. - // - // This member is required. - TemplateBody *string + // The description of the fleet provisioning template. + Description *string + + // True to enable the fleet provisioning template, otherwise false. + Enabled *bool + + // Creates a pre-provisioning hook template. + PreProvisioningHook *types.ProvisioningHook + + // Metadata which can be used to manage the fleet provisioning template. For URI + // Request parameters use format: ...key1=value1&key2=value2... For the CLI + // command-line parameter use format: &&tags "key1=value1&key2=value2..." For the + // cli-input-json file use format: "tags": "key1=value1&key2=value2..." + Tags []*types.Tag } type CreateProvisioningTemplateOutput struct { - // The name of the fleet provisioning template. - TemplateName *string - // The default version of the fleet provisioning template. DefaultVersionId *int32 // The ARN that identifies the provisioning template. TemplateArn *string + // The name of the fleet provisioning template. + TemplateName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_CreateProvisioningTemplateVersion.go b/service/iot/api_op_CreateProvisioningTemplateVersion.go index d9906c8292f..74ef7cf2807 100644 --- a/service/iot/api_op_CreateProvisioningTemplateVersion.go +++ b/service/iot/api_op_CreateProvisioningTemplateVersion.go @@ -56,18 +56,18 @@ func (c *Client) CreateProvisioningTemplateVersion(ctx context.Context, params * type CreateProvisioningTemplateVersionInput struct { - // Sets a fleet provision template version as the default version. - SetAsDefault *bool + // The JSON formatted contents of the fleet provisioning template. + // + // This member is required. + TemplateBody *string // The name of the fleet provisioning template. // // This member is required. TemplateName *string - // The JSON formatted contents of the fleet provisioning template. - // - // This member is required. - TemplateBody *string + // Sets a fleet provision template version as the default version. + SetAsDefault *bool } type CreateProvisioningTemplateVersionOutput struct { @@ -76,15 +76,15 @@ type CreateProvisioningTemplateVersionOutput struct { // otherwise false. IsDefaultVersion *bool + // The ARN that identifies the provisioning template. + TemplateArn *string + // The name of the fleet provisioning template. TemplateName *string // The version of the fleet provisioning template. VersionId *int32 - // The ARN that identifies the provisioning template. - TemplateArn *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_CreateRoleAlias.go b/service/iot/api_op_CreateRoleAlias.go index 42984cfbe21..def55277ba4 100644 --- a/service/iot/api_op_CreateRoleAlias.go +++ b/service/iot/api_op_CreateRoleAlias.go @@ -57,6 +57,12 @@ func (c *Client) CreateRoleAlias(ctx context.Context, params *CreateRoleAliasInp type CreateRoleAliasInput struct { + // The role alias that points to a role ARN. This allows you to change the role + // without having to update the device. + // + // This member is required. + RoleAlias *string + // The role ARN. // // This member is required. @@ -65,12 +71,6 @@ type CreateRoleAliasInput struct { // How long (in seconds) the credentials will be valid. CredentialDurationSeconds *int32 - // The role alias that points to a role ARN. This allows you to change the role - // without having to update the device. - // - // This member is required. - RoleAlias *string - // Metadata which can be used to manage the role alias. For URI Request parameters // use format: ...key1=value1&key2=value2... For the CLI command-line parameter use // format: &&tags "key1=value1&key2=value2..." For the cli-input-json file use @@ -80,12 +80,12 @@ type CreateRoleAliasInput struct { type CreateRoleAliasOutput struct { - // The role alias ARN. - RoleAliasArn *string - // The role alias. RoleAlias *string + // The role alias ARN. + RoleAliasArn *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_CreateScheduledAudit.go b/service/iot/api_op_CreateScheduledAudit.go index 76d096d7fe7..948a9ad78cd 100644 --- a/service/iot/api_op_CreateScheduledAudit.go +++ b/service/iot/api_op_CreateScheduledAudit.go @@ -57,14 +57,6 @@ func (c *Client) CreateScheduledAudit(ctx context.Context, params *CreateSchedul type CreateScheduledAuditInput struct { - // The day of the week on which the scheduled audit takes place. Can be one of - // "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT". This field is required if - // the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY". - DayOfWeek types.DayOfWeek - - // Metadata that can be used to manage the scheduled audit. - Tags []*types.Tag - // How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY", // "BIWEEKLY" or "MONTHLY". The start time of each audit is determined by the // system. @@ -72,12 +64,6 @@ type CreateScheduledAuditInput struct { // This member is required. Frequency types.AuditFrequency - // The day of the month on which the scheduled audit takes place. Can be "1" - // through "31" or "LAST". This field is required if the "frequency" parameter is - // set to "MONTHLY". If days 29-31 are specified, and the month does not have that - // many days, the audit takes place on the "LAST" day of the month. - DayOfMonth *string - // The name you want to give to the scheduled audit. (Max. 128 chars) // // This member is required. @@ -90,6 +76,20 @@ type CreateScheduledAuditInput struct { // // This member is required. TargetCheckNames []*string + + // The day of the month on which the scheduled audit takes place. Can be "1" + // through "31" or "LAST". This field is required if the "frequency" parameter is + // set to "MONTHLY". If days 29-31 are specified, and the month does not have that + // many days, the audit takes place on the "LAST" day of the month. + DayOfMonth *string + + // The day of the week on which the scheduled audit takes place. Can be one of + // "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT". This field is required if + // the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY". + DayOfWeek types.DayOfWeek + + // Metadata that can be used to manage the scheduled audit. + Tags []*types.Tag } type CreateScheduledAuditOutput struct { diff --git a/service/iot/api_op_CreateSecurityProfile.go b/service/iot/api_op_CreateSecurityProfile.go index e411c145f18..31cd7f72a5b 100644 --- a/service/iot/api_op_CreateSecurityProfile.go +++ b/service/iot/api_op_CreateSecurityProfile.go @@ -57,12 +57,10 @@ func (c *Client) CreateSecurityProfile(ctx context.Context, params *CreateSecuri type CreateSecurityProfileInput struct { - // Specifies the destinations to which alerts are sent. (Alerts are always sent to - // the console.) Alerts are generated when a device (thing) violates a behavior. - AlertTargets map[string]*types.AlertTarget - - // Metadata that can be used to manage the security profile. - Tags []*types.Tag + // The name you are giving to the security profile. + // + // This member is required. + SecurityProfileName *string // A list of metrics whose data is retained (stored). By default, data is retained // for any metric used in the profile's behaviors, but it is also retained for any @@ -70,21 +68,23 @@ type CreateSecurityProfileInput struct { // CreateSecurityProfileRequest$additionalMetricsToRetainV2 () instead. AdditionalMetricsToRetain []*string - // The name you are giving to the security profile. - // - // This member is required. - SecurityProfileName *string - - // A description of the security profile. - SecurityProfileDescription *string - // A list of metrics whose data is retained (stored). By default, data is retained // for any metric used in the profile's behaviors, but it is also retained for any // metric specified here. AdditionalMetricsToRetainV2 []*types.MetricToRetain + // Specifies the destinations to which alerts are sent. (Alerts are always sent to + // the console.) Alerts are generated when a device (thing) violates a behavior. + AlertTargets map[string]*types.AlertTarget + // Specifies the behaviors that, when violated by a device (thing), cause an alert. Behaviors []*types.Behavior + + // A description of the security profile. + SecurityProfileDescription *string + + // Metadata that can be used to manage the security profile. + Tags []*types.Tag } type CreateSecurityProfileOutput struct { diff --git a/service/iot/api_op_CreateStream.go b/service/iot/api_op_CreateStream.go index a239b3c997d..c9e5257854a 100644 --- a/service/iot/api_op_CreateStream.go +++ b/service/iot/api_op_CreateStream.go @@ -59,16 +59,10 @@ func (c *Client) CreateStream(ctx context.Context, params *CreateStreamInput, op type CreateStreamInput struct { - // The stream ID. + // The files to stream. // // This member is required. - StreamId *string - - // A description of the stream. - Description *string - - // Metadata which can be used to manage streams. - Tags []*types.Tag + Files []*types.StreamFile // An IAM role that allows the IoT service principal assumes to access your S3 // files. @@ -76,23 +70,29 @@ type CreateStreamInput struct { // This member is required. RoleArn *string - // The files to stream. + // The stream ID. // // This member is required. - Files []*types.StreamFile + StreamId *string + + // A description of the stream. + Description *string + + // Metadata which can be used to manage streams. + Tags []*types.Tag } type CreateStreamOutput struct { + // A description of the stream. + Description *string + // The stream ARN. StreamArn *string // The stream ID. StreamId *string - // A description of the stream. - Description *string - // The version of the stream. StreamVersion *int32 diff --git a/service/iot/api_op_CreateThing.go b/service/iot/api_op_CreateThing.go index ccf893e4bfb..543e2f6d6ba 100644 --- a/service/iot/api_op_CreateThing.go +++ b/service/iot/api_op_CreateThing.go @@ -64,9 +64,6 @@ func (c *Client) CreateThing(ctx context.Context, params *CreateThingInput, optF // The input for the CreateThing operation. type CreateThingInput struct { - // The name of the billing group the thing will be added to. - BillingGroupName *string - // The name of the thing to create. You can't change a thing's name after you // create it. To change a thing's name, you must create a new thing, give it the // new name, and then delete the old thing. @@ -74,12 +71,15 @@ type CreateThingInput struct { // This member is required. ThingName *string - // The name of the thing type associated with the new thing. - ThingTypeName *string - // The attribute payload, which consists of up to three name/value pairs in a JSON // document. For example: {\"attributes\":{\"string1\":\"string2\"}} AttributePayload *types.AttributePayload + + // The name of the billing group the thing will be added to. + BillingGroupName *string + + // The name of the thing type associated with the new thing. + ThingTypeName *string } // The output of the CreateThing operation. diff --git a/service/iot/api_op_CreateThingGroup.go b/service/iot/api_op_CreateThingGroup.go index 7d1d782402a..9cc76b5e0c6 100644 --- a/service/iot/api_op_CreateThingGroup.go +++ b/service/iot/api_op_CreateThingGroup.go @@ -59,6 +59,11 @@ func (c *Client) CreateThingGroup(ctx context.Context, params *CreateThingGroupI type CreateThingGroupInput struct { + // The thing group name to create. + // + // This member is required. + ThingGroupName *string + // The name of the parent thing group. ParentGroupName *string @@ -67,21 +72,16 @@ type CreateThingGroupInput struct { // The thing group properties. ThingGroupProperties *types.ThingGroupProperties - - // The thing group name to create. - // - // This member is required. - ThingGroupName *string } type CreateThingGroupOutput struct { - // The thing group ID. - ThingGroupId *string - // The thing group ARN. ThingGroupArn *string + // The thing group ID. + ThingGroupId *string + // The thing group name. ThingGroupName *string diff --git a/service/iot/api_op_CreateThingType.go b/service/iot/api_op_CreateThingType.go index 5be6f19fec3..23e40d7fa41 100644 --- a/service/iot/api_op_CreateThingType.go +++ b/service/iot/api_op_CreateThingType.go @@ -58,11 +58,6 @@ func (c *Client) CreateThingType(ctx context.Context, params *CreateThingTypeInp // The input for the CreateThingType operation. type CreateThingTypeInput struct { - // The ThingTypeProperties for the thing type to create. It contains information - // about the new thing type including a description, and a list of searchable thing - // attribute names. - ThingTypeProperties *types.ThingTypeProperties - // The name of the thing type. // // This member is required. @@ -70,20 +65,25 @@ type CreateThingTypeInput struct { // Metadata which can be used to manage the thing type. Tags []*types.Tag + + // The ThingTypeProperties for the thing type to create. It contains information + // about the new thing type including a description, and a list of searchable thing + // attribute names. + ThingTypeProperties *types.ThingTypeProperties } // The output of the CreateThingType operation. type CreateThingTypeOutput struct { + // The Amazon Resource Name (ARN) of the thing type. + ThingTypeArn *string + // The thing type ID. ThingTypeId *string // The name of the thing type. ThingTypeName *string - // The Amazon Resource Name (ARN) of the thing type. - ThingTypeArn *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_CreateTopicRule.go b/service/iot/api_op_CreateTopicRule.go index 646b06d8607..0760ce6f7b0 100644 --- a/service/iot/api_op_CreateTopicRule.go +++ b/service/iot/api_op_CreateTopicRule.go @@ -60,15 +60,15 @@ func (c *Client) CreateTopicRule(ctx context.Context, params *CreateTopicRuleInp // The input for the CreateTopicRule operation. type CreateTopicRuleInput struct { - // The rule payload. + // The name of the rule. // // This member is required. - TopicRulePayload *types.TopicRulePayload + RuleName *string - // The name of the rule. + // The rule payload. // // This member is required. - RuleName *string + TopicRulePayload *types.TopicRulePayload // Metadata which can be used to manage the topic rule. For URI Request parameters // use format: ...key1=value1&key2=value2... For the CLI command-line parameter use diff --git a/service/iot/api_op_DeleteBillingGroup.go b/service/iot/api_op_DeleteBillingGroup.go index 24cdd7a02d9..5d3929fafeb 100644 --- a/service/iot/api_op_DeleteBillingGroup.go +++ b/service/iot/api_op_DeleteBillingGroup.go @@ -56,15 +56,15 @@ func (c *Client) DeleteBillingGroup(ctx context.Context, params *DeleteBillingGr type DeleteBillingGroupInput struct { - // The expected version of the billing group. If the version of the billing group - // does not match the expected version specified in the request, the - // DeleteBillingGroup request is rejected with a VersionConflictException. - ExpectedVersion *int64 - // The name of the billing group. // // This member is required. BillingGroupName *string + + // The expected version of the billing group. If the version of the billing group + // does not match the expected version specified in the request, the + // DeleteBillingGroup request is rejected with a VersionConflictException. + ExpectedVersion *int64 } type DeleteBillingGroupOutput struct { diff --git a/service/iot/api_op_DeleteDynamicThingGroup.go b/service/iot/api_op_DeleteDynamicThingGroup.go index 193e800ed26..bcb8e82acd5 100644 --- a/service/iot/api_op_DeleteDynamicThingGroup.go +++ b/service/iot/api_op_DeleteDynamicThingGroup.go @@ -56,13 +56,13 @@ func (c *Client) DeleteDynamicThingGroup(ctx context.Context, params *DeleteDyna type DeleteDynamicThingGroupInput struct { - // The expected version of the dynamic thing group to delete. - ExpectedVersion *int64 - // The name of the dynamic thing group to delete. // // This member is required. ThingGroupName *string + + // The expected version of the dynamic thing group to delete. + ExpectedVersion *int64 } type DeleteDynamicThingGroupOutput struct { diff --git a/service/iot/api_op_DeleteJob.go b/service/iot/api_op_DeleteJob.go index 83d89a6caa4..da5f2959fe3 100644 --- a/service/iot/api_op_DeleteJob.go +++ b/service/iot/api_op_DeleteJob.go @@ -62,6 +62,14 @@ func (c *Client) DeleteJob(ctx context.Context, params *DeleteJobInput, optFns . type DeleteJobInput struct { + // The ID of the job to be deleted. After a job deletion is completed, you may + // reuse this jobId when you create a new job. However, this is not recommended, + // and you must ensure that your devices are not using the jobId to refer to the + // deleted job. + // + // This member is required. + JobId *string + // (Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, // you can only delete a job which is in a terminal state ("COMPLETED" or // "CANCELED") or an exception will occur. The default is false. Deleting a job @@ -70,14 +78,6 @@ type DeleteJobInput struct { // and ensure that each device executing a job which is deleted is able to recover // to a valid state. Force *bool - - // The ID of the job to be deleted. After a job deletion is completed, you may - // reuse this jobId when you create a new job. However, this is not recommended, - // and you must ensure that your devices are not using the jobId to refer to the - // deleted job. - // - // This member is required. - JobId *string } type DeleteJobOutput struct { diff --git a/service/iot/api_op_DeleteJobExecution.go b/service/iot/api_op_DeleteJobExecution.go index f6fa3accffb..63000b6b046 100644 --- a/service/iot/api_op_DeleteJobExecution.go +++ b/service/iot/api_op_DeleteJobExecution.go @@ -56,11 +56,24 @@ func (c *Client) DeleteJobExecution(ctx context.Context, params *DeleteJobExecut type DeleteJobExecutionInput struct { + // The ID of the job execution to be deleted. The executionNumber refers to the + // execution of a particular job on a particular device. Note that once a job + // execution is deleted, the executionNumber may be reused by IoT, so be sure you + // get and use the correct value here. + // + // This member is required. + ExecutionNumber *int64 + // The ID of the job whose execution on a particular device will be deleted. // // This member is required. JobId *string + // The name of the thing whose job execution will be deleted. + // + // This member is required. + ThingName *string + // (Optional) When true, you can delete a job execution which is "IN_PROGRESS". // Otherwise, you can only delete a job execution which is in a terminal state // ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception @@ -69,19 +82,6 @@ type DeleteJobExecutionInput struct { // update the job execution status. Use caution and ensure that the device is able // to recover to a valid state. Force *bool - - // The name of the thing whose job execution will be deleted. - // - // This member is required. - ThingName *string - - // The ID of the job execution to be deleted. The executionNumber refers to the - // execution of a particular job on a particular device. Note that once a job - // execution is deleted, the executionNumber may be reused by IoT, so be sure you - // get and use the correct value here. - // - // This member is required. - ExecutionNumber *int64 } type DeleteJobExecutionOutput struct { diff --git a/service/iot/api_op_DeleteOTAUpdate.go b/service/iot/api_op_DeleteOTAUpdate.go index fb68418f19e..e4479aab624 100644 --- a/service/iot/api_op_DeleteOTAUpdate.go +++ b/service/iot/api_op_DeleteOTAUpdate.go @@ -56,6 +56,11 @@ func (c *Client) DeleteOTAUpdate(ctx context.Context, params *DeleteOTAUpdateInp type DeleteOTAUpdateInput struct { + // The ID of the OTA update to delete. + // + // This member is required. + OtaUpdateId *string + // Specifies if the stream associated with an OTA update should be deleted when the // OTA update is deleted. DeleteStream *bool @@ -63,11 +68,6 @@ type DeleteOTAUpdateInput struct { // Specifies if the AWS Job associated with the OTA update should be deleted when // the OTA update is deleted. ForceDeleteAWSJob *bool - - // The ID of the OTA update to delete. - // - // This member is required. - OtaUpdateId *string } type DeleteOTAUpdateOutput struct { diff --git a/service/iot/api_op_DeletePolicyVersion.go b/service/iot/api_op_DeletePolicyVersion.go index 67d68e83e50..2dc3b24bfd0 100644 --- a/service/iot/api_op_DeletePolicyVersion.go +++ b/service/iot/api_op_DeletePolicyVersion.go @@ -60,15 +60,15 @@ func (c *Client) DeletePolicyVersion(ctx context.Context, params *DeletePolicyVe // The input for the DeletePolicyVersion operation. type DeletePolicyVersionInput struct { - // The policy version ID. + // The name of the policy. // // This member is required. - PolicyVersionId *string + PolicyName *string - // The name of the policy. + // The policy version ID. // // This member is required. - PolicyName *string + PolicyVersionId *string } type DeletePolicyVersionOutput struct { diff --git a/service/iot/api_op_DeleteSecurityProfile.go b/service/iot/api_op_DeleteSecurityProfile.go index ac4aadb160e..4d0da018f43 100644 --- a/service/iot/api_op_DeleteSecurityProfile.go +++ b/service/iot/api_op_DeleteSecurityProfile.go @@ -56,15 +56,15 @@ func (c *Client) DeleteSecurityProfile(ctx context.Context, params *DeleteSecuri type DeleteSecurityProfileInput struct { - // The expected version of the security profile. A new version is generated - // whenever the security profile is updated. If you specify a value that is - // different from the actual version, a VersionConflictException is thrown. - ExpectedVersion *int64 - // The name of the security profile to be deleted. // // This member is required. SecurityProfileName *string + + // The expected version of the security profile. A new version is generated + // whenever the security profile is updated. If you specify a value that is + // different from the actual version, a VersionConflictException is thrown. + ExpectedVersion *int64 } type DeleteSecurityProfileOutput struct { diff --git a/service/iot/api_op_DeleteThingGroup.go b/service/iot/api_op_DeleteThingGroup.go index 7ee1ae9d045..27043b44aa5 100644 --- a/service/iot/api_op_DeleteThingGroup.go +++ b/service/iot/api_op_DeleteThingGroup.go @@ -56,13 +56,13 @@ func (c *Client) DeleteThingGroup(ctx context.Context, params *DeleteThingGroupI type DeleteThingGroupInput struct { - // The expected version of the thing group to delete. - ExpectedVersion *int64 - // The name of the thing group to delete. // // This member is required. ThingGroupName *string + + // The expected version of the thing group to delete. + ExpectedVersion *int64 } type DeleteThingGroupOutput struct { diff --git a/service/iot/api_op_DeleteV2LoggingLevel.go b/service/iot/api_op_DeleteV2LoggingLevel.go index 07d0916b6d9..3eaa0710084 100644 --- a/service/iot/api_op_DeleteV2LoggingLevel.go +++ b/service/iot/api_op_DeleteV2LoggingLevel.go @@ -57,15 +57,15 @@ func (c *Client) DeleteV2LoggingLevel(ctx context.Context, params *DeleteV2Loggi type DeleteV2LoggingLevelInput struct { - // The type of resource for which you are configuring logging. Must be THING_Group. + // The name of the resource for which you are configuring logging. // // This member is required. - TargetType types.LogTargetType + TargetName *string - // The name of the resource for which you are configuring logging. + // The type of resource for which you are configuring logging. Must be THING_Group. // // This member is required. - TargetName *string + TargetType types.LogTargetType } type DeleteV2LoggingLevelOutput struct { diff --git a/service/iot/api_op_DeprecateThingType.go b/service/iot/api_op_DeprecateThingType.go index b29393e29ae..50b4598cb68 100644 --- a/service/iot/api_op_DeprecateThingType.go +++ b/service/iot/api_op_DeprecateThingType.go @@ -58,14 +58,14 @@ func (c *Client) DeprecateThingType(ctx context.Context, params *DeprecateThingT // The input for the DeprecateThingType operation. type DeprecateThingTypeInput struct { - // Whether to undeprecate a deprecated thing type. If true, the thing type will not - // be deprecated anymore and you can associate it with things. - UndoDeprecate *bool - // The name of the thing type to deprecate. // // This member is required. ThingTypeName *string + + // Whether to undeprecate a deprecated thing type. If true, the thing type will not + // be deprecated anymore and you can associate it with things. + UndoDeprecate *bool } // The output for the DeprecateThingType operation. diff --git a/service/iot/api_op_DescribeAccountAuditConfiguration.go b/service/iot/api_op_DescribeAccountAuditConfiguration.go index 74d88fd668f..b6f6cf9ee8b 100644 --- a/service/iot/api_op_DescribeAccountAuditConfiguration.go +++ b/service/iot/api_op_DescribeAccountAuditConfiguration.go @@ -61,12 +61,6 @@ type DescribeAccountAuditConfigurationInput struct { type DescribeAccountAuditConfigurationOutput struct { - // The ARN of the role that grants permission to AWS IoT to access information - // about your devices, policies, certificates, and other items as required when - // performing an audit. On the first call to UpdateAccountAuditConfiguration, this - // parameter is required. - RoleArn *string - // Which audit checks are enabled and disabled for this account. AuditCheckConfigurations map[string]*types.AuditCheckConfiguration @@ -74,6 +68,12 @@ type DescribeAccountAuditConfigurationOutput struct { // account. AuditNotificationTargetConfigurations map[string]*types.AuditNotificationTarget + // The ARN of the role that grants permission to AWS IoT to access information + // about your devices, policies, certificates, and other items as required when + // performing an audit. On the first call to UpdateAccountAuditConfiguration, this + // parameter is required. + RoleArn *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_DescribeAuditMitigationActionsTask.go b/service/iot/api_op_DescribeAuditMitigationActionsTask.go index e9f0afb95a4..32c0540fb59 100644 --- a/service/iot/api_op_DescribeAuditMitigationActionsTask.go +++ b/service/iot/api_op_DescribeAuditMitigationActionsTask.go @@ -69,6 +69,10 @@ type DescribeAuditMitigationActionsTaskInput struct { type DescribeAuditMitigationActionsTaskOutput struct { + // Specifies the mitigation actions and their parameters that are applied as part + // of this task. + ActionsDefinition []*types.MitigationAction + // Specifies the mitigation actions that should be applied to specific audit // checks. AuditCheckToActionsMapping map[string][]*string @@ -76,6 +80,9 @@ type DescribeAuditMitigationActionsTaskOutput struct { // The date and time when the task was completed or canceled. EndTime *time.Time + // The date and time when the task was started. + StartTime *time.Time + // Identifies the findings to which the mitigation actions are applied. This can be // by audit checks, by audit task, or a set of findings. Target *types.AuditMitigationActionsTaskTarget @@ -87,13 +94,6 @@ type DescribeAuditMitigationActionsTaskOutput struct { // The current status of the task. TaskStatus types.AuditMitigationActionsTaskStatus - // Specifies the mitigation actions and their parameters that are applied as part - // of this task. - ActionsDefinition []*types.MitigationAction - - // The date and time when the task was started. - StartTime *time.Time - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_DescribeAuditTask.go b/service/iot/api_op_DescribeAuditTask.go index 92d18b41958..c611dc9ef96 100644 --- a/service/iot/api_op_DescribeAuditTask.go +++ b/service/iot/api_op_DescribeAuditTask.go @@ -69,21 +69,21 @@ type DescribeAuditTaskOutput struct { // Detailed information about each check performed during this audit. AuditDetails map[string]*types.AuditCheckDetails - // The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or - // "CANCELED". - TaskStatus types.AuditTaskStatus - // The name of the scheduled audit (only if the audit was a scheduled audit). ScheduledAuditName *string - // The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK". - TaskType types.AuditTaskType + // The time the audit started. + TaskStartTime *time.Time // Statistical information about the audit. TaskStatistics *types.TaskStatistics - // The time the audit started. - TaskStartTime *time.Time + // The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or + // "CANCELED". + TaskStatus types.AuditTaskStatus + + // The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK". + TaskType types.AuditTaskType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/iot/api_op_DescribeBillingGroup.go b/service/iot/api_op_DescribeBillingGroup.go index 07ae5d415bf..18f5ab1b6b0 100644 --- a/service/iot/api_op_DescribeBillingGroup.go +++ b/service/iot/api_op_DescribeBillingGroup.go @@ -65,23 +65,23 @@ type DescribeBillingGroupInput struct { type DescribeBillingGroupOutput struct { - // The version of the billing group. - Version *int64 + // The ARN of the billing group. + BillingGroupArn *string - // The properties of the billing group. - BillingGroupProperties *types.BillingGroupProperties + // The ID of the billing group. + BillingGroupId *string // Additional information about the billing group. BillingGroupMetadata *types.BillingGroupMetadata - // The ID of the billing group. - BillingGroupId *string - // The name of the billing group. BillingGroupName *string - // The ARN of the billing group. - BillingGroupArn *string + // The properties of the billing group. + BillingGroupProperties *types.BillingGroupProperties + + // The version of the billing group. + Version *int64 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/iot/api_op_DescribeCACertificate.go b/service/iot/api_op_DescribeCACertificate.go index 05d3baae844..73048275b6a 100644 --- a/service/iot/api_op_DescribeCACertificate.go +++ b/service/iot/api_op_DescribeCACertificate.go @@ -67,12 +67,12 @@ type DescribeCACertificateInput struct { // The output from the DescribeCACertificate operation. type DescribeCACertificateOutput struct { - // Information about the registration configuration. - RegistrationConfig *types.RegistrationConfig - // The CA certificate description. CertificateDescription *types.CACertificateDescription + // Information about the registration configuration. + RegistrationConfig *types.RegistrationConfig + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_DescribeDimension.go b/service/iot/api_op_DescribeDimension.go index 84b6660c8ba..b77b684d3f1 100644 --- a/service/iot/api_op_DescribeDimension.go +++ b/service/iot/api_op_DescribeDimension.go @@ -66,25 +66,25 @@ type DescribeDimensionInput struct { type DescribeDimensionOutput struct { + // The ARN (Amazon resource name) for the dimension. + Arn *string + + // The date the dimension was created. + CreationDate *time.Time + // The date the dimension was last modified. LastModifiedDate *time.Time - // The type of the dimension. - Type types.DimensionType - // The unique identifier for the dimension. Name *string - // The date the dimension was created. - CreationDate *time.Time - - // The ARN (Amazon resource name) for the dimension. - Arn *string - // The value or list of values used to scope the dimension. For example, for topic // filters, this is the pattern used to match the MQTT topic name. StringValues []*string + // The type of the dimension. + Type types.DimensionType + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_DescribeDomainConfiguration.go b/service/iot/api_op_DescribeDomainConfiguration.go index 4c127babbcb..dfd6bc4345f 100644 --- a/service/iot/api_op_DescribeDomainConfiguration.go +++ b/service/iot/api_op_DescribeDomainConfiguration.go @@ -69,28 +69,28 @@ type DescribeDomainConfigurationOutput struct { // An object that specifies the authorization service for a domain. AuthorizerConfig *types.AuthorizerConfig - // The name of the domain. - DomainName *string + // The ARN of the domain configuration. + DomainConfigurationArn *string + + // The name of the domain configuration. + DomainConfigurationName *string // A Boolean value that specifies the current state of the domain configuration. DomainConfigurationStatus types.DomainConfigurationStatus - // A list containing summary information about the server certificate included in - // the domain configuration. - ServerCertificates []*types.ServerCertificateSummary - - // The ARN of the domain configuration. - DomainConfigurationArn *string + // The name of the domain. + DomainName *string // The type of the domain. DomainType types.DomainType + // A list containing summary information about the server certificate included in + // the domain configuration. + ServerCertificates []*types.ServerCertificateSummary + // The type of service delivered by the endpoint. ServiceType types.ServiceType - // The name of the domain configuration. - DomainConfigurationName *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_DescribeEventConfigurations.go b/service/iot/api_op_DescribeEventConfigurations.go index c519e0405ef..8d286a0092b 100644 --- a/service/iot/api_op_DescribeEventConfigurations.go +++ b/service/iot/api_op_DescribeEventConfigurations.go @@ -60,14 +60,14 @@ type DescribeEventConfigurationsInput struct { type DescribeEventConfigurationsOutput struct { - // The date the event configurations were last modified. - LastModifiedDate *time.Time + // The creation date of the event configuration. + CreationDate *time.Time // The event configurations. EventConfigurations map[string]*types.Configuration - // The creation date of the event configuration. - CreationDate *time.Time + // The date the event configurations were last modified. + LastModifiedDate *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/iot/api_op_DescribeIndex.go b/service/iot/api_op_DescribeIndex.go index 420140b52f0..899abc58b5c 100644 --- a/service/iot/api_op_DescribeIndex.go +++ b/service/iot/api_op_DescribeIndex.go @@ -65,12 +65,12 @@ type DescribeIndexInput struct { type DescribeIndexOutput struct { - // The index status. - IndexStatus types.IndexStatus - // The index name. IndexName *string + // The index status. + IndexStatus types.IndexStatus + // Contains a value that specifies the type of indexing performed. Valid values // are: // diff --git a/service/iot/api_op_DescribeMitigationAction.go b/service/iot/api_op_DescribeMitigationAction.go index f1122275d5b..f75f7c1d22a 100644 --- a/service/iot/api_op_DescribeMitigationAction.go +++ b/service/iot/api_op_DescribeMitigationAction.go @@ -66,30 +66,30 @@ type DescribeMitigationActionInput struct { type DescribeMitigationActionOutput struct { - // The ARN of the IAM role used to apply this action. - RoleArn *string - // The ARN that identifies this migration action. ActionArn *string - // The date and time when the mitigation action was last changed. - LastModifiedDate *time.Time + // A unique identifier for this action. + ActionId *string + + // The friendly name that uniquely identifies the mitigation action. + ActionName *string // Parameters that control how the mitigation action is applied, specific to the // type of mitigation action. ActionParams *types.MitigationActionParams - // The friendly name that uniquely identifies the mitigation action. - ActionName *string - // The type of mitigation action. ActionType types.MitigationActionType // The date and time when the mitigation action was added to your AWS account. CreationDate *time.Time - // A unique identifier for this action. - ActionId *string + // The date and time when the mitigation action was last changed. + LastModifiedDate *time.Time + + // The ARN of the IAM role used to apply this action. + RoleArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/iot/api_op_DescribeProvisioningTemplate.go b/service/iot/api_op_DescribeProvisioningTemplate.go index 204c7be6ce4..36067767de9 100644 --- a/service/iot/api_op_DescribeProvisioningTemplate.go +++ b/service/iot/api_op_DescribeProvisioningTemplate.go @@ -66,36 +66,36 @@ type DescribeProvisioningTemplateInput struct { type DescribeProvisioningTemplateOutput struct { + // The date when the fleet provisioning template was created. + CreationDate *time.Time + + // The default fleet template version ID. + DefaultVersionId *int32 + // The description of the fleet provisioning template. Description *string + // True if the fleet provisioning template is enabled, otherwise false. + Enabled *bool + // The date when the fleet provisioning template was last modified. LastModifiedDate *time.Time - // The ARN of the fleet provisioning template. - TemplateArn *string - - // The date when the fleet provisioning template was created. - CreationDate *time.Time + // Gets information about a pre-provisioned hook. + PreProvisioningHook *types.ProvisioningHook // The ARN of the role associated with the provisioning template. This IoT role // grants permission to provision a device. ProvisioningRoleArn *string - // True if the fleet provisioning template is enabled, otherwise false. - Enabled *bool - - // The name of the fleet provisioning template. - TemplateName *string - - // Gets information about a pre-provisioned hook. - PreProvisioningHook *types.ProvisioningHook + // The ARN of the fleet provisioning template. + TemplateArn *string // The JSON formatted contents of the fleet provisioning template. TemplateBody *string - // The default fleet template version ID. - DefaultVersionId *int32 + // The name of the fleet provisioning template. + TemplateName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/iot/api_op_DescribeProvisioningTemplateVersion.go b/service/iot/api_op_DescribeProvisioningTemplateVersion.go index 98ef52b3855..c971a197e6e 100644 --- a/service/iot/api_op_DescribeProvisioningTemplateVersion.go +++ b/service/iot/api_op_DescribeProvisioningTemplateVersion.go @@ -70,15 +70,15 @@ type DescribeProvisioningTemplateVersionInput struct { type DescribeProvisioningTemplateVersionOutput struct { - // The JSON formatted contents of the fleet provisioning template version. - TemplateBody *string - // The date when the fleet provisioning template version was created. CreationDate *time.Time // True if the fleet provisioning template version is the default version. IsDefaultVersion *bool + // The JSON formatted contents of the fleet provisioning template version. + TemplateBody *string + // The fleet provisioning template version ID. VersionId *int32 diff --git a/service/iot/api_op_DescribeScheduledAudit.go b/service/iot/api_op_DescribeScheduledAudit.go index 5de857654d4..04ebdbe0201 100644 --- a/service/iot/api_op_DescribeScheduledAudit.go +++ b/service/iot/api_op_DescribeScheduledAudit.go @@ -65,22 +65,22 @@ type DescribeScheduledAuditInput struct { type DescribeScheduledAuditOutput struct { - // How often the scheduled audit takes place. One of "DAILY", "WEEKLY", "BIWEEKLY", - // or "MONTHLY". The start time of each audit is determined by the system. - Frequency types.AuditFrequency + // The day of the month on which the scheduled audit takes place. Will be "1" + // through "31" or "LAST". If days 29-31 are specified, and the month does not have + // that many days, the audit takes place on the "LAST" day of the month. + DayOfMonth *string // The day of the week on which the scheduled audit takes place. One of "SUN", // "MON", "TUE", "WED", "THU", "FRI", or "SAT". DayOfWeek types.DayOfWeek + // How often the scheduled audit takes place. One of "DAILY", "WEEKLY", "BIWEEKLY", + // or "MONTHLY". The start time of each audit is determined by the system. + Frequency types.AuditFrequency + // The ARN of the scheduled audit. ScheduledAuditArn *string - // The day of the month on which the scheduled audit takes place. Will be "1" - // through "31" or "LAST". If days 29-31 are specified, and the month does not have - // that many days, the audit takes place on the "LAST" day of the month. - DayOfMonth *string - // The name of the scheduled audit. ScheduledAuditName *string diff --git a/service/iot/api_op_DescribeSecurityProfile.go b/service/iot/api_op_DescribeSecurityProfile.go index 3850553dd76..5f5e3817cf1 100644 --- a/service/iot/api_op_DescribeSecurityProfile.go +++ b/service/iot/api_op_DescribeSecurityProfile.go @@ -66,25 +66,16 @@ type DescribeSecurityProfileInput struct { type DescribeSecurityProfileOutput struct { - // The name of the security profile. - SecurityProfileName *string - // A list of metrics whose data is retained (stored). By default, data is retained // for any metric used in the profile's behaviors, but it is also retained for any // metric specified here. Note: This API field is deprecated. Please use // DescribeSecurityProfileResponse$additionalMetricsToRetainV2 () instead. AdditionalMetricsToRetain []*string - // A description of the security profile (associated with the security profile when - // it was created or updated). - SecurityProfileDescription *string - - // The version of the security profile. A new version is generated whenever the - // security profile is updated. - Version *int64 - - // The time the security profile was created. - CreationDate *time.Time + // A list of metrics whose data is retained (stored). By default, data is retained + // for any metric used in the profile's behaviors, but it is also retained for any + // metric specified here. + AdditionalMetricsToRetainV2 []*types.MetricToRetain // Where the alerts are sent. (Alerts are always sent to the console.) AlertTargets map[string]*types.AlertTarget @@ -92,10 +83,8 @@ type DescribeSecurityProfileOutput struct { // Specifies the behaviors that, when violated by a device (thing), cause an alert. Behaviors []*types.Behavior - // A list of metrics whose data is retained (stored). By default, data is retained - // for any metric used in the profile's behaviors, but it is also retained for any - // metric specified here. - AdditionalMetricsToRetainV2 []*types.MetricToRetain + // The time the security profile was created. + CreationDate *time.Time // The time the security profile was last modified. LastModifiedDate *time.Time @@ -103,6 +92,17 @@ type DescribeSecurityProfileOutput struct { // The ARN of the security profile. SecurityProfileArn *string + // A description of the security profile (associated with the security profile when + // it was created or updated). + SecurityProfileDescription *string + + // The name of the security profile. + SecurityProfileName *string + + // The version of the security profile. A new version is generated whenever the + // security profile is updated. + Version *int64 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_DescribeThing.go b/service/iot/api_op_DescribeThing.go index 5fdeb927eea..60f40b24b7a 100644 --- a/service/iot/api_op_DescribeThing.go +++ b/service/iot/api_op_DescribeThing.go @@ -66,18 +66,12 @@ type DescribeThingInput struct { // The output from the DescribeThing operation. type DescribeThingOutput struct { - // The ARN of the thing to describe. - ThingArn *string - - // The thing type name. - ThingTypeName *string + // The thing attributes. + Attributes map[string]*string // The name of the billing group the thing belongs to. BillingGroupName *string - // The name of the thing. - ThingName *string - // The default MQTT client ID. For a typical device, the thing name is also used as // the default MQTT client ID. Although we don’t require a mapping between a // thing's registry name and its use of MQTT client IDs, certificates, or shadow @@ -87,17 +81,23 @@ type DescribeThingOutput struct { // certificate model or shadows. DefaultClientId *string - // The thing attributes. - Attributes map[string]*string + // The ARN of the thing to describe. + ThingArn *string + + // The ID of the thing to describe. + ThingId *string + + // The name of the thing. + ThingName *string + + // The thing type name. + ThingTypeName *string // The current version of the thing record in the registry. To avoid unintentional // changes to the information in the registry, you can pass the version information // in the expectedVersion parameter of the UpdateThing and DeleteThing calls. Version *int64 - // The ID of the thing to describe. - ThingId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_DescribeThingGroup.go b/service/iot/api_op_DescribeThingGroup.go index a38f9d6c1bb..31b9162abcc 100644 --- a/service/iot/api_op_DescribeThingGroup.go +++ b/service/iot/api_op_DescribeThingGroup.go @@ -65,33 +65,33 @@ type DescribeThingGroupInput struct { type DescribeThingGroupOutput struct { + // The dynamic thing group index name. + IndexName *string + + // The dynamic thing group search query string. + QueryString *string + // The dynamic thing group query version. QueryVersion *string - // The thing group ID. - ThingGroupId *string - - // The dynamic thing group index name. - IndexName *string + // The dynamic thing group status. + Status types.DynamicGroupStatus // The thing group ARN. ThingGroupArn *string - // The name of the thing group. - ThingGroupName *string + // The thing group ID. + ThingGroupId *string // Thing group metadata. ThingGroupMetadata *types.ThingGroupMetadata + // The name of the thing group. + ThingGroupName *string + // The thing group properties. ThingGroupProperties *types.ThingGroupProperties - // The dynamic thing group status. - Status types.DynamicGroupStatus - - // The dynamic thing group search query string. - QueryString *string - // The version of the thing group. Version *int64 diff --git a/service/iot/api_op_DescribeThingRegistrationTask.go b/service/iot/api_op_DescribeThingRegistrationTask.go index c8fcd6313b7..0f08bc535df 100644 --- a/service/iot/api_op_DescribeThingRegistrationTask.go +++ b/service/iot/api_op_DescribeThingRegistrationTask.go @@ -66,41 +66,41 @@ type DescribeThingRegistrationTaskInput struct { type DescribeThingRegistrationTaskOutput struct { + // The task creation date. + CreationDate *time.Time + + // The number of things that failed to be provisioned. + FailureCount *int32 + + // The S3 bucket that contains the input file. + InputFileBucket *string + // The input file key. InputFileKey *string // The date when the task was last modified. LastModifiedDate *time.Time - // The status of the bulk thing provisioning task. - Status types.Status + // The message. + Message *string + + // The progress of the bulk provisioning task expressed as a percentage. + PercentageProgress *int32 // The role ARN that grants access to the input file bucket. RoleArn *string + // The status of the bulk thing provisioning task. + Status types.Status + // The number of things successfully provisioned. SuccessCount *int32 - // The S3 bucket that contains the input file. - InputFileBucket *string - - // The task's template. - TemplateBody *string - - // The message. - Message *string - - // The number of things that failed to be provisioned. - FailureCount *int32 - - // The progress of the bulk provisioning task expressed as a percentage. - PercentageProgress *int32 - // The task ID. TaskId *string - // The task creation date. - CreationDate *time.Time + // The task's template. + TemplateBody *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/iot/api_op_DescribeThingType.go b/service/iot/api_op_DescribeThingType.go index 9820180d23d..4a3e7cebc40 100644 --- a/service/iot/api_op_DescribeThingType.go +++ b/service/iot/api_op_DescribeThingType.go @@ -67,6 +67,9 @@ type DescribeThingTypeInput struct { // The output for the DescribeThingType operation. type DescribeThingTypeOutput struct { + // The thing type ARN. + ThingTypeArn *string + // The thing type ID. ThingTypeId *string @@ -78,9 +81,6 @@ type DescribeThingTypeOutput struct { // The name of the thing type. ThingTypeName *string - // The thing type ARN. - ThingTypeArn *string - // The ThingTypeProperties contains information about the thing type including // description, and a list of searchable thing attribute names. ThingTypeProperties *types.ThingTypeProperties diff --git a/service/iot/api_op_DetachPolicy.go b/service/iot/api_op_DetachPolicy.go index 547220f6f62..0117891e1c9 100644 --- a/service/iot/api_op_DetachPolicy.go +++ b/service/iot/api_op_DetachPolicy.go @@ -56,15 +56,15 @@ func (c *Client) DetachPolicy(ctx context.Context, params *DetachPolicyInput, op type DetachPolicyInput struct { - // The target from which the policy will be detached. + // The policy to detach. // // This member is required. - Target *string + PolicyName *string - // The policy to detach. + // The target from which the policy will be detached. // // This member is required. - PolicyName *string + Target *string } type DetachPolicyOutput struct { diff --git a/service/iot/api_op_DetachPrincipalPolicy.go b/service/iot/api_op_DetachPrincipalPolicy.go index a4102956b90..6d5efd6e12e 100644 --- a/service/iot/api_op_DetachPrincipalPolicy.go +++ b/service/iot/api_op_DetachPrincipalPolicy.go @@ -58,16 +58,16 @@ func (c *Client) DetachPrincipalPolicy(ctx context.Context, params *DetachPrinci // The input for the DetachPrincipalPolicy operation. type DetachPrincipalPolicyInput struct { - // The principal. If the principal is a certificate, specify the certificate ARN. - // If the principal is an Amazon Cognito identity, specify the identity ID. + // The name of the policy to detach. // // This member is required. - Principal *string + PolicyName *string - // The name of the policy to detach. + // The principal. If the principal is a certificate, specify the certificate ARN. + // If the principal is an Amazon Cognito identity, specify the identity ID. // // This member is required. - PolicyName *string + Principal *string } type DetachPrincipalPolicyOutput struct { diff --git a/service/iot/api_op_DetachThingPrincipal.go b/service/iot/api_op_DetachThingPrincipal.go index a4ad0398c19..44c511a7a80 100644 --- a/service/iot/api_op_DetachThingPrincipal.go +++ b/service/iot/api_op_DetachThingPrincipal.go @@ -60,17 +60,17 @@ func (c *Client) DetachThingPrincipal(ctx context.Context, params *DetachThingPr // The input for the DetachThingPrincipal operation. type DetachThingPrincipalInput struct { - // The name of the thing. - // - // This member is required. - ThingName *string - // If the principal is a certificate, this value must be ARN of the certificate. If // the principal is an Amazon Cognito identity, this value must be the ID of the // Amazon Cognito identity. // // This member is required. Principal *string + + // The name of the thing. + // + // This member is required. + ThingName *string } // The output from the DetachThingPrincipal operation. diff --git a/service/iot/api_op_GetCardinality.go b/service/iot/api_op_GetCardinality.go index 37e9ef093df..1754ea4629c 100644 --- a/service/iot/api_op_GetCardinality.go +++ b/service/iot/api_op_GetCardinality.go @@ -56,9 +56,6 @@ func (c *Client) GetCardinality(ctx context.Context, params *GetCardinalityInput type GetCardinalityInput struct { - // The query version. - QueryVersion *string - // The search query. // // This member is required. @@ -69,6 +66,9 @@ type GetCardinalityInput struct { // The name of the index to search. IndexName *string + + // The query version. + QueryVersion *string } type GetCardinalityOutput struct { diff --git a/service/iot/api_op_GetEffectivePolicies.go b/service/iot/api_op_GetEffectivePolicies.go index 2b320a63136..ee0bd97eb98 100644 --- a/service/iot/api_op_GetEffectivePolicies.go +++ b/service/iot/api_op_GetEffectivePolicies.go @@ -57,14 +57,14 @@ func (c *Client) GetEffectivePolicies(ctx context.Context, params *GetEffectiveP type GetEffectivePoliciesInput struct { - // The thing name. - ThingName *string - // The Cognito identity pool ID. CognitoIdentityPoolId *string // The principal. Principal *string + + // The thing name. + ThingName *string } type GetEffectivePoliciesOutput struct { diff --git a/service/iot/api_op_GetIndexingConfiguration.go b/service/iot/api_op_GetIndexingConfiguration.go index fc301e52e80..3a11e93dcc9 100644 --- a/service/iot/api_op_GetIndexingConfiguration.go +++ b/service/iot/api_op_GetIndexingConfiguration.go @@ -59,12 +59,12 @@ type GetIndexingConfigurationInput struct { type GetIndexingConfigurationOutput struct { - // Thing indexing configuration. - ThingIndexingConfiguration *types.ThingIndexingConfiguration - // The index configuration. ThingGroupIndexingConfiguration *types.ThingGroupIndexingConfiguration + // Thing indexing configuration. + ThingIndexingConfiguration *types.ThingIndexingConfiguration + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_GetPercentiles.go b/service/iot/api_op_GetPercentiles.go index 6df04efd7d9..3bc9487bb03 100644 --- a/service/iot/api_op_GetPercentiles.go +++ b/service/iot/api_op_GetPercentiles.go @@ -65,15 +65,6 @@ func (c *Client) GetPercentiles(ctx context.Context, params *GetPercentilesInput type GetPercentilesInput struct { - // The percentile groups returned. - Percents []*float64 - - // The name of the index to search. - IndexName *string - - // The query version. - QueryVersion *string - // The query string. // // This member is required. @@ -81,6 +72,15 @@ type GetPercentilesInput struct { // The field to aggregate. AggregationField *string + + // The name of the index to search. + IndexName *string + + // The percentile groups returned. + Percents []*float64 + + // The query version. + QueryVersion *string } type GetPercentilesOutput struct { diff --git a/service/iot/api_op_GetPolicy.go b/service/iot/api_op_GetPolicy.go index 7e2ca2539d3..4617f0546bf 100644 --- a/service/iot/api_op_GetPolicy.go +++ b/service/iot/api_op_GetPolicy.go @@ -71,8 +71,11 @@ type GetPolicyOutput struct { // The date the policy was created. CreationDate *time.Time - // The policy name. - PolicyName *string + // The default policy version ID. + DefaultVersionId *string + + // The generation ID of the policy. + GenerationId *string // The date the policy was last modified. LastModifiedDate *time.Time @@ -80,15 +83,12 @@ type GetPolicyOutput struct { // The policy ARN. PolicyArn *string - // The generation ID of the policy. - GenerationId *string - - // The default policy version ID. - DefaultVersionId *string - // The JSON document that describes the policy. PolicyDocument *string + // The policy name. + PolicyName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_GetPolicyVersion.go b/service/iot/api_op_GetPolicyVersion.go index 807f6a8a963..7154b296e3c 100644 --- a/service/iot/api_op_GetPolicyVersion.go +++ b/service/iot/api_op_GetPolicyVersion.go @@ -58,28 +58,25 @@ func (c *Client) GetPolicyVersion(ctx context.Context, params *GetPolicyVersionI // The input for the GetPolicyVersion operation. type GetPolicyVersionInput struct { - // The policy version ID. + // The name of the policy. // // This member is required. - PolicyVersionId *string + PolicyName *string - // The name of the policy. + // The policy version ID. // // This member is required. - PolicyName *string + PolicyVersionId *string } // The output from the GetPolicyVersion operation. type GetPolicyVersionOutput struct { - // The policy version ID. - PolicyVersionId *string - - // The policy ARN. - PolicyArn *string + // The date the policy was created. + CreationDate *time.Time - // The policy name. - PolicyName *string + // The generation ID of the policy version. + GenerationId *string // Specifies whether the policy version is the default. IsDefaultVersion *bool @@ -87,14 +84,17 @@ type GetPolicyVersionOutput struct { // The date the policy was last modified. LastModifiedDate *time.Time - // The generation ID of the policy version. - GenerationId *string + // The policy ARN. + PolicyArn *string // The JSON document that describes the policy. PolicyDocument *string - // The date the policy was created. - CreationDate *time.Time + // The policy name. + PolicyName *string + + // The policy version ID. + PolicyVersionId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/iot/api_op_GetStatistics.go b/service/iot/api_op_GetStatistics.go index 0b20438cb19..170543916d8 100644 --- a/service/iot/api_op_GetStatistics.go +++ b/service/iot/api_op_GetStatistics.go @@ -59,20 +59,20 @@ func (c *Client) GetStatistics(ctx context.Context, params *GetStatisticsInput, type GetStatisticsInput struct { - // The name of the index to search. The default value is AWS_Things. - IndexName *string - // The query used to search. You can specify "*" for the query string to get the // count of all indexed things in your AWS account. // // This member is required. QueryString *string - // The version of the query used to search. - QueryVersion *string - // The aggregation field name. AggregationField *string + + // The name of the index to search. The default value is AWS_Things. + IndexName *string + + // The version of the query used to search. + QueryVersion *string } type GetStatisticsOutput struct { diff --git a/service/iot/api_op_GetV2LoggingOptions.go b/service/iot/api_op_GetV2LoggingOptions.go index 9e1365d5c58..bf69f08d8eb 100644 --- a/service/iot/api_op_GetV2LoggingOptions.go +++ b/service/iot/api_op_GetV2LoggingOptions.go @@ -62,12 +62,12 @@ type GetV2LoggingOptionsOutput struct { // The default log level. DefaultLogLevel types.LogLevel - // The IAM role ARN AWS IoT uses to write to your CloudWatch logs. - RoleArn *string - // Disables all logs. DisableAllLogs *bool + // The IAM role ARN AWS IoT uses to write to your CloudWatch logs. + RoleArn *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_ListActiveViolations.go b/service/iot/api_op_ListActiveViolations.go index e0b7fab01ce..f7ae07d14a9 100644 --- a/service/iot/api_op_ListActiveViolations.go +++ b/service/iot/api_op_ListActiveViolations.go @@ -56,9 +56,6 @@ func (c *Client) ListActiveViolations(ctx context.Context, params *ListActiveVio type ListActiveViolationsInput struct { - // The name of the thing whose active violations are listed. - ThingName *string - // The maximum number of results to return at one time. MaxResults *int32 @@ -68,6 +65,9 @@ type ListActiveViolationsInput struct { // The name of the Device Defender security profile for which violations are // listed. SecurityProfileName *string + + // The name of the thing whose active violations are listed. + ThingName *string } type ListActiveViolationsOutput struct { diff --git a/service/iot/api_op_ListAttachedPolicies.go b/service/iot/api_op_ListAttachedPolicies.go index daeadc2a8a5..e16be0e98ec 100644 --- a/service/iot/api_op_ListAttachedPolicies.go +++ b/service/iot/api_op_ListAttachedPolicies.go @@ -57,30 +57,30 @@ func (c *Client) ListAttachedPolicies(ctx context.Context, params *ListAttachedP type ListAttachedPoliciesInput struct { + // The group or principal for which the policies will be listed. + // + // This member is required. + Target *string + // The token to retrieve the next set of results. Marker *string - // When true, recursively list attached policies. - Recursive *bool - // The maximum number of results to be returned per request. PageSize *int32 - // The group or principal for which the policies will be listed. - // - // This member is required. - Target *string + // When true, recursively list attached policies. + Recursive *bool } type ListAttachedPoliciesOutput struct { - // The policies. - Policies []*types.Policy - // The token to retrieve the next set of results, or ``null`` if there are no more // results. NextMarker *string + // The policies. + Policies []*types.Policy + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_ListAuditFindings.go b/service/iot/api_op_ListAuditFindings.go index b4411eb2861..5582ab605cf 100644 --- a/service/iot/api_op_ListAuditFindings.go +++ b/service/iot/api_op_ListAuditFindings.go @@ -58,29 +58,29 @@ func (c *Client) ListAuditFindings(ctx context.Context, params *ListAuditFinding type ListAuditFindingsInput struct { - // The token for the next set of results. - NextToken *string - - // A filter to limit results to those found after the specified time. You must - // specify either the startTime and endTime or the taskId, but not both. - StartTime *time.Time - // A filter to limit results to the findings for the specified audit check. CheckName *string + // A filter to limit results to those found before the specified time. You must + // specify either the startTime and endTime or the taskId, but not both. + EndTime *time.Time + // The maximum number of results to return at one time. The default is 25. MaxResults *int32 - // A filter to limit results to the audit with the specified ID. You must specify - // either the taskId or the startTime and endTime, but not both. - TaskId *string + // The token for the next set of results. + NextToken *string // Information identifying the noncompliant resource. ResourceIdentifier *types.ResourceIdentifier - // A filter to limit results to those found before the specified time. You must + // A filter to limit results to those found after the specified time. You must // specify either the startTime and endTime or the taskId, but not both. - EndTime *time.Time + StartTime *time.Time + + // A filter to limit results to the audit with the specified ID. You must specify + // either the taskId or the startTime and endTime, but not both. + TaskId *string } type ListAuditFindingsOutput struct { diff --git a/service/iot/api_op_ListAuditMitigationActionsExecutions.go b/service/iot/api_op_ListAuditMitigationActionsExecutions.go index c476e09868c..b0669743345 100644 --- a/service/iot/api_op_ListAuditMitigationActionsExecutions.go +++ b/service/iot/api_op_ListAuditMitigationActionsExecutions.go @@ -63,12 +63,6 @@ type ListAuditMitigationActionsExecutionsInput struct { // This member is required. FindingId *string - // The token for the next set of results. - NextToken *string - - // The maximum number of results to return at one time. The default is 25. - MaxResults *int32 - // Specify this filter to limit results to actions for a specific audit mitigation // actions task. // @@ -77,17 +71,23 @@ type ListAuditMitigationActionsExecutionsInput struct { // Specify this filter to limit results to those with a specific status. ActionStatus types.AuditMitigationActionsExecutionStatus -} -type ListAuditMitigationActionsExecutionsOutput struct { + // The maximum number of results to return at one time. The default is 25. + MaxResults *int32 // The token for the next set of results. NextToken *string +} + +type ListAuditMitigationActionsExecutionsOutput struct { // A set of task execution results based on the input parameters. Details include // the mitigation action applied, start time, and task status. ActionsExecutions []*types.AuditMitigationActionExecutionMetadata + // The token for the next set of results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_ListAuditMitigationActionsTasks.go b/service/iot/api_op_ListAuditMitigationActionsTasks.go index e4af377c962..e1a7558f677 100644 --- a/service/iot/api_op_ListAuditMitigationActionsTasks.go +++ b/service/iot/api_op_ListAuditMitigationActionsTasks.go @@ -58,18 +58,11 @@ func (c *Client) ListAuditMitigationActionsTasks(ctx context.Context, params *Li type ListAuditMitigationActionsTasksInput struct { - // Specify this filter to limit results to tasks that were applied to results for a - // specific audit. - AuditTaskId *string - - // Specify this filter to limit results to tasks that are in a specific state. - TaskStatus types.AuditMitigationActionsTaskStatus - - // The token for the next set of results. - NextToken *string - - // The maximum number of results to return at one time. The default is 25. - MaxResults *int32 + // Specify this filter to limit results to tasks that were completed or canceled on + // or before a specific date and time. + // + // This member is required. + EndTime *time.Time // Specify this filter to limit results to tasks that began on or after a specific // date and time. @@ -77,25 +70,32 @@ type ListAuditMitigationActionsTasksInput struct { // This member is required. StartTime *time.Time + // Specify this filter to limit results to tasks that were applied to results for a + // specific audit. + AuditTaskId *string + // Specify this filter to limit results to tasks that were applied to a specific // audit finding. FindingId *string - // Specify this filter to limit results to tasks that were completed or canceled on - // or before a specific date and time. - // - // This member is required. - EndTime *time.Time + // The maximum number of results to return at one time. The default is 25. + MaxResults *int32 + + // The token for the next set of results. + NextToken *string + + // Specify this filter to limit results to tasks that are in a specific state. + TaskStatus types.AuditMitigationActionsTaskStatus } type ListAuditMitigationActionsTasksOutput struct { - // The collection of audit mitigation tasks that matched the filter criteria. - Tasks []*types.AuditMitigationActionsTaskMetadata - // The token for the next set of results. NextToken *string + // The collection of audit mitigation tasks that matched the filter criteria. + Tasks []*types.AuditMitigationActionsTaskMetadata + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_ListAuditTasks.go b/service/iot/api_op_ListAuditTasks.go index 51e0f3e883e..68b3d1dcba4 100644 --- a/service/iot/api_op_ListAuditTasks.go +++ b/service/iot/api_op_ListAuditTasks.go @@ -59,10 +59,6 @@ func (c *Client) ListAuditTasks(ctx context.Context, params *ListAuditTasksInput type ListAuditTasksInput struct { - // A filter to limit the output to the specified type of audit: can be one of - // "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK". - TaskType types.AuditTaskType - // The end of the time period. // // This member is required. @@ -75,15 +71,19 @@ type ListAuditTasksInput struct { // This member is required. StartTime *time.Time - // A filter to limit the output to audits with the specified completion status: can - // be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED". - TaskStatus types.AuditTaskStatus + // The maximum number of results to return at one time. The default is 25. + MaxResults *int32 // The token for the next set of results. NextToken *string - // The maximum number of results to return at one time. The default is 25. - MaxResults *int32 + // A filter to limit the output to audits with the specified completion status: can + // be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED". + TaskStatus types.AuditTaskStatus + + // A filter to limit the output to the specified type of audit: can be one of + // "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK". + TaskType types.AuditTaskType } type ListAuditTasksOutput struct { diff --git a/service/iot/api_op_ListAuthorizers.go b/service/iot/api_op_ListAuthorizers.go index d12fa303307..1c87d2d2a30 100644 --- a/service/iot/api_op_ListAuthorizers.go +++ b/service/iot/api_op_ListAuthorizers.go @@ -56,8 +56,8 @@ func (c *Client) ListAuthorizers(ctx context.Context, params *ListAuthorizersInp type ListAuthorizersInput struct { - // The status of the list authorizers request. - Status types.AuthorizerStatus + // Return the list of authorizers in ascending alphabetical order. + AscendingOrder *bool // A marker used to get the next set of results. Marker *string @@ -65,8 +65,8 @@ type ListAuthorizersInput struct { // The maximum number of results to return at one time. PageSize *int32 - // Return the list of authorizers in ascending alphabetical order. - AscendingOrder *bool + // The status of the list authorizers request. + Status types.AuthorizerStatus } type ListAuthorizersOutput struct { diff --git a/service/iot/api_op_ListBillingGroups.go b/service/iot/api_op_ListBillingGroups.go index 0541433bb83..ab0c5248237 100644 --- a/service/iot/api_op_ListBillingGroups.go +++ b/service/iot/api_op_ListBillingGroups.go @@ -68,13 +68,13 @@ type ListBillingGroupsInput struct { type ListBillingGroupsOutput struct { + // The list of billing groups. + BillingGroups []*types.GroupNameAndArn + // The token used to get the next set of results, or null if there are no // additional results. NextToken *string - // The list of billing groups. - BillingGroups []*types.GroupNameAndArn - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_ListCertificates.go b/service/iot/api_op_ListCertificates.go index 5bdedf0f00b..50068d37214 100644 --- a/service/iot/api_op_ListCertificates.go +++ b/service/iot/api_op_ListCertificates.go @@ -63,23 +63,23 @@ type ListCertificatesInput struct { // order, based on the creation date. AscendingOrder *bool - // The result page size. - PageSize *int32 - // The marker for the next set of results. Marker *string + + // The result page size. + PageSize *int32 } // The output of the ListCertificates operation. type ListCertificatesOutput struct { + // The descriptions of the certificates. + Certificates []*types.Certificate + // The marker for the next set of results, or null if there are no additional // results. NextMarker *string - // The descriptions of the certificates. - Certificates []*types.Certificate - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_ListCertificatesByCA.go b/service/iot/api_op_ListCertificatesByCA.go index f4fbd6cb87d..8075fd684e1 100644 --- a/service/iot/api_op_ListCertificatesByCA.go +++ b/service/iot/api_op_ListCertificatesByCA.go @@ -58,33 +58,33 @@ func (c *Client) ListCertificatesByCA(ctx context.Context, params *ListCertifica // The input to the ListCertificatesByCA operation. type ListCertificatesByCAInput struct { - // The result page size. - PageSize *int32 - - // The marker for the next set of results. - Marker *string - - // Specifies the order for results. If True, the results are returned in ascending - // order, based on the creation date. - AscendingOrder *bool - // The ID of the CA certificate. This operation will list all registered device // certificate that were signed by this CA certificate. // // This member is required. CaCertificateId *string + + // Specifies the order for results. If True, the results are returned in ascending + // order, based on the creation date. + AscendingOrder *bool + + // The marker for the next set of results. + Marker *string + + // The result page size. + PageSize *int32 } // The output of the ListCertificatesByCA operation. type ListCertificatesByCAOutput struct { + // The device certificates signed by the specified CA certificate. + Certificates []*types.Certificate + // The marker for the next set of results, or null if there are no additional // results. NextMarker *string - // The device certificates signed by the specified CA certificate. - Certificates []*types.Certificate - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_ListDimensions.go b/service/iot/api_op_ListDimensions.go index 4cee583266c..db1896503e1 100644 --- a/service/iot/api_op_ListDimensions.go +++ b/service/iot/api_op_ListDimensions.go @@ -55,11 +55,11 @@ func (c *Client) ListDimensions(ctx context.Context, params *ListDimensionsInput type ListDimensionsInput struct { - // The token for the next set of results. - NextToken *string - // The maximum number of results to retrieve at one time. MaxResults *int32 + + // The token for the next set of results. + NextToken *string } type ListDimensionsOutput struct { diff --git a/service/iot/api_op_ListDomainConfigurations.go b/service/iot/api_op_ListDomainConfigurations.go index 7bfd48156ad..d73d4fb849e 100644 --- a/service/iot/api_op_ListDomainConfigurations.go +++ b/service/iot/api_op_ListDomainConfigurations.go @@ -61,22 +61,22 @@ type ListDomainConfigurationsInput struct { // The marker for the next set of results. Marker *string - // The type of service delivered by the endpoint. - ServiceType types.ServiceType - // The result page size. PageSize *int32 + + // The type of service delivered by the endpoint. + ServiceType types.ServiceType } type ListDomainConfigurationsOutput struct { - // The marker for the next set of results. - NextMarker *string - // A list of objects that contain summary information about the user's domain // configurations. DomainConfigurations []*types.DomainConfigurationSummary + // The marker for the next set of results. + NextMarker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_ListIndices.go b/service/iot/api_op_ListIndices.go index d611b98a224..9ad603c4124 100644 --- a/service/iot/api_op_ListIndices.go +++ b/service/iot/api_op_ListIndices.go @@ -55,12 +55,12 @@ func (c *Client) ListIndices(ctx context.Context, params *ListIndicesInput, optF type ListIndicesInput struct { + // The maximum number of results to return at one time. + MaxResults *int32 + // The token used to get the next set of results, or null if there are no // additional results. NextToken *string - - // The maximum number of results to return at one time. - MaxResults *int32 } type ListIndicesOutput struct { diff --git a/service/iot/api_op_ListJobExecutionsForJob.go b/service/iot/api_op_ListJobExecutionsForJob.go index 3c75350ad2a..57b814ca513 100644 --- a/service/iot/api_op_ListJobExecutionsForJob.go +++ b/service/iot/api_op_ListJobExecutionsForJob.go @@ -57,30 +57,30 @@ func (c *Client) ListJobExecutionsForJob(ctx context.Context, params *ListJobExe type ListJobExecutionsForJobInput struct { - // The maximum number of results to be returned per request. - MaxResults *int32 - // The unique identifier you assigned to this job when it was created. // // This member is required. JobId *string - // The status of the job. - Status types.JobExecutionStatus + // The maximum number of results to be returned per request. + MaxResults *int32 // The token to retrieve the next set of results. NextToken *string + + // The status of the job. + Status types.JobExecutionStatus } type ListJobExecutionsForJobOutput struct { + // A list of job execution summaries. + ExecutionSummaries []*types.JobExecutionSummaryForJob + // The token for the next set of results, or null if there are no additional // results. NextToken *string - // A list of job execution summaries. - ExecutionSummaries []*types.JobExecutionSummaryForJob - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_ListJobExecutionsForThing.go b/service/iot/api_op_ListJobExecutionsForThing.go index 1bf2e01b5cf..c67284f4be3 100644 --- a/service/iot/api_op_ListJobExecutionsForThing.go +++ b/service/iot/api_op_ListJobExecutionsForThing.go @@ -57,30 +57,30 @@ func (c *Client) ListJobExecutionsForThing(ctx context.Context, params *ListJobE type ListJobExecutionsForThingInput struct { + // The thing name. + // + // This member is required. + ThingName *string + // The maximum number of results to be returned per request. MaxResults *int32 // The token to retrieve the next set of results. NextToken *string - // The thing name. - // - // This member is required. - ThingName *string - // An optional filter that lets you search for jobs that have the specified status. Status types.JobExecutionStatus } type ListJobExecutionsForThingOutput struct { + // A list of job execution summaries. + ExecutionSummaries []*types.JobExecutionSummaryForThing + // The token for the next set of results, or null if there are no additional // results. NextToken *string - // A list of job execution summaries. - ExecutionSummaries []*types.JobExecutionSummaryForThing - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_ListJobs.go b/service/iot/api_op_ListJobs.go index 4bd92c84975..7e56ddf66de 100644 --- a/service/iot/api_op_ListJobs.go +++ b/service/iot/api_op_ListJobs.go @@ -56,12 +56,15 @@ func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ... type ListJobsInput struct { - // An optional filter that lets you search for jobs that have the specified status. - Status types.JobStatus + // The maximum number of results to return per request. + MaxResults *int32 // The token to retrieve the next set of results. NextToken *string + // An optional filter that lets you search for jobs that have the specified status. + Status types.JobStatus + // Specifies whether the job will continue to run (CONTINUOUS), or will be complete // after all those things specified as targets have completed the job (SNAPSHOT). // If continuous, the job may also be run on a thing when a change is detected in a @@ -70,25 +73,22 @@ type ListJobsInput struct { // group. TargetSelection types.TargetSelection - // The maximum number of results to return per request. - MaxResults *int32 - // A filter that limits the returned jobs to those for the specified group. - ThingGroupName *string + ThingGroupId *string // A filter that limits the returned jobs to those for the specified group. - ThingGroupId *string + ThingGroupName *string } type ListJobsOutput struct { + // A list of jobs. + Jobs []*types.JobSummary + // The token for the next set of results, or null if there are no additional // results. NextToken *string - // A list of jobs. - Jobs []*types.JobSummary - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_ListOTAUpdates.go b/service/iot/api_op_ListOTAUpdates.go index 897e2ede6e8..db6b5fe882b 100644 --- a/service/iot/api_op_ListOTAUpdates.go +++ b/service/iot/api_op_ListOTAUpdates.go @@ -56,14 +56,14 @@ func (c *Client) ListOTAUpdates(ctx context.Context, params *ListOTAUpdatesInput type ListOTAUpdatesInput struct { - // The OTA update job status. - OtaUpdateStatus types.OTAUpdateStatus + // The maximum number of results to return at one time. + MaxResults *int32 // A token used to retrieve the next set of results. NextToken *string - // The maximum number of results to return at one time. - MaxResults *int32 + // The OTA update job status. + OtaUpdateStatus types.OTAUpdateStatus } type ListOTAUpdatesOutput struct { diff --git a/service/iot/api_op_ListPolicies.go b/service/iot/api_op_ListPolicies.go index 7e74b6e0933..b9dfb120bba 100644 --- a/service/iot/api_op_ListPolicies.go +++ b/service/iot/api_op_ListPolicies.go @@ -57,27 +57,27 @@ func (c *Client) ListPolicies(ctx context.Context, params *ListPoliciesInput, op // The input for the ListPolicies operation. type ListPoliciesInput struct { - // The result page size. - PageSize *int32 + // Specifies the order for results. If true, the results are returned in ascending + // creation order. + AscendingOrder *bool // The marker for the next set of results. Marker *string - // Specifies the order for results. If true, the results are returned in ascending - // creation order. - AscendingOrder *bool + // The result page size. + PageSize *int32 } // The output from the ListPolicies operation. type ListPoliciesOutput struct { - // The descriptions of the policies. - Policies []*types.Policy - // The marker for the next set of results, or null if there are no additional // results. NextMarker *string + // The descriptions of the policies. + Policies []*types.Policy + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_ListPolicyPrincipals.go b/service/iot/api_op_ListPolicyPrincipals.go index 75fb1e15513..25deb73d58e 100644 --- a/service/iot/api_op_ListPolicyPrincipals.go +++ b/service/iot/api_op_ListPolicyPrincipals.go @@ -58,9 +58,6 @@ func (c *Client) ListPolicyPrincipals(ctx context.Context, params *ListPolicyPri // The input for the ListPolicyPrincipals operation. type ListPolicyPrincipalsInput struct { - // The result page size. - PageSize *int32 - // The policy name. // // This member is required. @@ -72,6 +69,9 @@ type ListPolicyPrincipalsInput struct { // The marker for the next set of results. Marker *string + + // The result page size. + PageSize *int32 } // The output from the ListPolicyPrincipals operation. diff --git a/service/iot/api_op_ListPrincipalPolicies.go b/service/iot/api_op_ListPrincipalPolicies.go index 06cede6cd2d..0f16b28358c 100644 --- a/service/iot/api_op_ListPrincipalPolicies.go +++ b/service/iot/api_op_ListPrincipalPolicies.go @@ -61,12 +61,6 @@ func (c *Client) ListPrincipalPolicies(ctx context.Context, params *ListPrincipa // The input for the ListPrincipalPolicies operation. type ListPrincipalPoliciesInput struct { - // The marker for the next set of results. - Marker *string - - // The result page size. - PageSize *int32 - // The principal. // // This member is required. @@ -75,18 +69,24 @@ type ListPrincipalPoliciesInput struct { // Specifies the order for results. If true, results are returned in ascending // creation order. AscendingOrder *bool + + // The marker for the next set of results. + Marker *string + + // The result page size. + PageSize *int32 } // The output from the ListPrincipalPolicies operation. type ListPrincipalPoliciesOutput struct { - // The policies. - Policies []*types.Policy - // The marker for the next set of results, or null if there are no additional // results. NextMarker *string + // The policies. + Policies []*types.Policy + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_ListProvisioningTemplateVersions.go b/service/iot/api_op_ListProvisioningTemplateVersions.go index 2b608b8a51c..361a7f2245f 100644 --- a/service/iot/api_op_ListProvisioningTemplateVersions.go +++ b/service/iot/api_op_ListProvisioningTemplateVersions.go @@ -57,9 +57,6 @@ func (c *Client) ListProvisioningTemplateVersions(ctx context.Context, params *L type ListProvisioningTemplateVersionsInput struct { - // A token to retrieve the next set of results. - NextToken *string - // The name of the fleet provisioning template. // // This member is required. @@ -67,6 +64,9 @@ type ListProvisioningTemplateVersionsInput struct { // The maximum number of results to return at one time. MaxResults *int32 + + // A token to retrieve the next set of results. + NextToken *string } type ListProvisioningTemplateVersionsOutput struct { diff --git a/service/iot/api_op_ListRoleAliases.go b/service/iot/api_op_ListRoleAliases.go index ce59e9b88ba..155e5329a26 100644 --- a/service/iot/api_op_ListRoleAliases.go +++ b/service/iot/api_op_ListRoleAliases.go @@ -58,21 +58,21 @@ type ListRoleAliasesInput struct { // Return the list of role aliases in ascending alphabetical order. AscendingOrder *bool - // The maximum number of results to return at one time. - PageSize *int32 - // A marker used to get the next set of results. Marker *string + + // The maximum number of results to return at one time. + PageSize *int32 } type ListRoleAliasesOutput struct { - // The role aliases. - RoleAliases []*string - // A marker used to get the next set of results. NextMarker *string + // The role aliases. + RoleAliases []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_ListScheduledAudits.go b/service/iot/api_op_ListScheduledAudits.go index 192b3c12539..245359cbf3c 100644 --- a/service/iot/api_op_ListScheduledAudits.go +++ b/service/iot/api_op_ListScheduledAudits.go @@ -56,11 +56,11 @@ func (c *Client) ListScheduledAudits(ctx context.Context, params *ListScheduledA type ListScheduledAuditsInput struct { - // The token for the next set of results. - NextToken *string - // The maximum number of results to return at one time. The default is 25. MaxResults *int32 + + // The token for the next set of results. + NextToken *string } type ListScheduledAuditsOutput struct { diff --git a/service/iot/api_op_ListSecurityProfiles.go b/service/iot/api_op_ListSecurityProfiles.go index 53684dc8741..736807264be 100644 --- a/service/iot/api_op_ListSecurityProfiles.go +++ b/service/iot/api_op_ListSecurityProfiles.go @@ -58,15 +58,15 @@ func (c *Client) ListSecurityProfiles(ctx context.Context, params *ListSecurityP type ListSecurityProfilesInput struct { - // The token for the next set of results. - NextToken *string + // A filter to limit results to the security profiles that use the defined + // dimension. + DimensionName *string // The maximum number of results to return at one time. MaxResults *int32 - // A filter to limit results to the security profiles that use the defined - // dimension. - DimensionName *string + // The token for the next set of results. + NextToken *string } type ListSecurityProfilesOutput struct { diff --git a/service/iot/api_op_ListSecurityProfilesForTarget.go b/service/iot/api_op_ListSecurityProfilesForTarget.go index 74f940c0220..b3a5f76542d 100644 --- a/service/iot/api_op_ListSecurityProfilesForTarget.go +++ b/service/iot/api_op_ListSecurityProfilesForTarget.go @@ -57,20 +57,20 @@ func (c *Client) ListSecurityProfilesForTarget(ctx context.Context, params *List type ListSecurityProfilesForTargetInput struct { + // The ARN of the target (thing group) whose attached security profiles you want to + // get. + // + // This member is required. + SecurityProfileTargetArn *string + // The maximum number of results to return at one time. MaxResults *int32 - // If true, return child groups too. - Recursive *bool - // The token for the next set of results. NextToken *string - // The ARN of the target (thing group) whose attached security profiles you want to - // get. - // - // This member is required. - SecurityProfileTargetArn *string + // If true, return child groups too. + Recursive *bool } type ListSecurityProfilesForTargetOutput struct { diff --git a/service/iot/api_op_ListStreams.go b/service/iot/api_op_ListStreams.go index 32d41e676bb..9292fdbbabc 100644 --- a/service/iot/api_op_ListStreams.go +++ b/service/iot/api_op_ListStreams.go @@ -59,11 +59,11 @@ type ListStreamsInput struct { // Set to true to return the list of streams in ascending order. AscendingOrder *bool - // A token used to get the next set of results. - NextToken *string - // The maximum number of results to return at a time. MaxResults *int32 + + // A token used to get the next set of results. + NextToken *string } type ListStreamsOutput struct { diff --git a/service/iot/api_op_ListTagsForResource.go b/service/iot/api_op_ListTagsForResource.go index 9e58c2e3941..01ed557c641 100644 --- a/service/iot/api_op_ListTagsForResource.go +++ b/service/iot/api_op_ListTagsForResource.go @@ -57,24 +57,24 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The token to retrieve the next set of results. - NextToken *string - // The ARN of the resource. // // This member is required. ResourceArn *string + + // The token to retrieve the next set of results. + NextToken *string } type ListTagsForResourceOutput struct { - // The list of tags assigned to the resource. - Tags []*types.Tag - // The token used to get the next set of results, or null if there are no // additional results. NextToken *string + // The list of tags assigned to the resource. + Tags []*types.Tag + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_ListTargetsForPolicy.go b/service/iot/api_op_ListTargetsForPolicy.go index ab8cbeccd5d..492f370ce2f 100644 --- a/service/iot/api_op_ListTargetsForPolicy.go +++ b/service/iot/api_op_ListTargetsForPolicy.go @@ -61,21 +61,21 @@ type ListTargetsForPolicyInput struct { // This member is required. PolicyName *string - // The maximum number of results to return at one time. - PageSize *int32 - // A marker used to get the next set of results. Marker *string + + // The maximum number of results to return at one time. + PageSize *int32 } type ListTargetsForPolicyOutput struct { - // The policy targets. - Targets []*string - // A marker used to get the next set of results. NextMarker *string + // The policy targets. + Targets []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_ListTargetsForSecurityProfile.go b/service/iot/api_op_ListTargetsForSecurityProfile.go index 887524145b9..673a369f0f6 100644 --- a/service/iot/api_op_ListTargetsForSecurityProfile.go +++ b/service/iot/api_op_ListTargetsForSecurityProfile.go @@ -63,11 +63,11 @@ type ListTargetsForSecurityProfileInput struct { // This member is required. SecurityProfileName *string - // The token for the next set of results. - NextToken *string - // The maximum number of results to return at one time. MaxResults *int32 + + // The token for the next set of results. + NextToken *string } type ListTargetsForSecurityProfileOutput struct { diff --git a/service/iot/api_op_ListThingGroups.go b/service/iot/api_op_ListThingGroups.go index bb2b04101e0..a1b9fd727d6 100644 --- a/service/iot/api_op_ListThingGroups.go +++ b/service/iot/api_op_ListThingGroups.go @@ -59,12 +59,12 @@ type ListThingGroupsInput struct { // The maximum number of results to return at one time. MaxResults *int32 - // The token to retrieve the next set of results. - NextToken *string - // A filter that limits the results to those with the specified name prefix. NamePrefixFilter *string + // The token to retrieve the next set of results. + NextToken *string + // A filter that limits the results to those with the specified parent group. ParentGroup *string diff --git a/service/iot/api_op_ListThingGroupsForThing.go b/service/iot/api_op_ListThingGroupsForThing.go index c3e34c4344f..47d24584574 100644 --- a/service/iot/api_op_ListThingGroupsForThing.go +++ b/service/iot/api_op_ListThingGroupsForThing.go @@ -57,14 +57,14 @@ func (c *Client) ListThingGroupsForThing(ctx context.Context, params *ListThingG type ListThingGroupsForThingInput struct { - // The maximum number of results to return at one time. - MaxResults *int32 - // The thing name. // // This member is required. ThingName *string + // The maximum number of results to return at one time. + MaxResults *int32 + // The token to retrieve the next set of results. NextToken *string } diff --git a/service/iot/api_op_ListThingRegistrationTaskReports.go b/service/iot/api_op_ListThingRegistrationTaskReports.go index f82cf6dcb66..006061866af 100644 --- a/service/iot/api_op_ListThingRegistrationTaskReports.go +++ b/service/iot/api_op_ListThingRegistrationTaskReports.go @@ -57,21 +57,21 @@ func (c *Client) ListThingRegistrationTaskReports(ctx context.Context, params *L type ListThingRegistrationTaskReportsInput struct { - // The maximum number of results to return per request. - MaxResults *int32 - - // The token to retrieve the next set of results. - NextToken *string + // The type of task report. + // + // This member is required. + ReportType types.ReportType // The id of the task. // // This member is required. TaskId *string - // The type of task report. - // - // This member is required. - ReportType types.ReportType + // The maximum number of results to return per request. + MaxResults *int32 + + // The token to retrieve the next set of results. + NextToken *string } type ListThingRegistrationTaskReportsOutput struct { diff --git a/service/iot/api_op_ListThingRegistrationTasks.go b/service/iot/api_op_ListThingRegistrationTasks.go index 2ff072d81cc..623edc76a69 100644 --- a/service/iot/api_op_ListThingRegistrationTasks.go +++ b/service/iot/api_op_ListThingRegistrationTasks.go @@ -68,13 +68,13 @@ type ListThingRegistrationTasksInput struct { type ListThingRegistrationTasksOutput struct { - // A list of bulk thing provisioning task IDs. - TaskIds []*string - // The token used to get the next set of results, or null if there are no // additional results. NextToken *string + // A list of bulk thing provisioning task IDs. + TaskIds []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_ListThingTypes.go b/service/iot/api_op_ListThingTypes.go index 40b4078e120..7dddc3b4290 100644 --- a/service/iot/api_op_ListThingTypes.go +++ b/service/iot/api_op_ListThingTypes.go @@ -57,26 +57,26 @@ func (c *Client) ListThingTypes(ctx context.Context, params *ListThingTypesInput // The input for the ListThingTypes operation. type ListThingTypesInput struct { - // The name of the thing type. - ThingTypeName *string + // The maximum number of results to return in this operation. + MaxResults *int32 // The token to retrieve the next set of results. NextToken *string - // The maximum number of results to return in this operation. - MaxResults *int32 + // The name of the thing type. + ThingTypeName *string } // The output for the ListThingTypes operation. type ListThingTypesOutput struct { - // The thing types. - ThingTypes []*types.ThingTypeDefinition - // The token for the next set of results, or null if there are no additional // results. NextToken *string + // The thing types. + ThingTypes []*types.ThingTypeDefinition + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_ListThings.go b/service/iot/api_op_ListThings.go index 0e959db1c5b..978daf09077 100644 --- a/service/iot/api_op_ListThings.go +++ b/service/iot/api_op_ListThings.go @@ -60,20 +60,20 @@ func (c *Client) ListThings(ctx context.Context, params *ListThingsInput, optFns // The input for the ListThings operation. type ListThingsInput struct { + // The attribute name used to search for things. + AttributeName *string + // The attribute value used to search for things. AttributeValue *string - // The name of the thing type used to search for things. - ThingTypeName *string - // The maximum number of results to return in this operation. MaxResults *int32 // The token to retrieve the next set of results. NextToken *string - // The attribute name used to search for things. - AttributeName *string + // The name of the thing type used to search for things. + ThingTypeName *string } // The output from the ListThings operation. diff --git a/service/iot/api_op_ListThingsInBillingGroup.go b/service/iot/api_op_ListThingsInBillingGroup.go index 760836aa2e4..0ba6bbe7c5f 100644 --- a/service/iot/api_op_ListThingsInBillingGroup.go +++ b/service/iot/api_op_ListThingsInBillingGroup.go @@ -61,11 +61,11 @@ type ListThingsInBillingGroupInput struct { // This member is required. BillingGroupName *string - // The token to retrieve the next set of results. - NextToken *string - // The maximum number of results to return per request. MaxResults *int32 + + // The token to retrieve the next set of results. + NextToken *string } type ListThingsInBillingGroupOutput struct { diff --git a/service/iot/api_op_ListThingsInThingGroup.go b/service/iot/api_op_ListThingsInThingGroup.go index 8d844b81a78..54fb59f3a17 100644 --- a/service/iot/api_op_ListThingsInThingGroup.go +++ b/service/iot/api_op_ListThingsInThingGroup.go @@ -56,12 +56,6 @@ func (c *Client) ListThingsInThingGroup(ctx context.Context, params *ListThingsI type ListThingsInThingGroupInput struct { - // The token to retrieve the next set of results. - NextToken *string - - // When true, list things in this thing group and in all child groups as well. - Recursive *bool - // The thing group name. // // This member is required. @@ -69,17 +63,23 @@ type ListThingsInThingGroupInput struct { // The maximum number of results to return at one time. MaxResults *int32 + + // The token to retrieve the next set of results. + NextToken *string + + // When true, list things in this thing group and in all child groups as well. + Recursive *bool } type ListThingsInThingGroupOutput struct { - // The things in the specified thing group. - Things []*string - // The token used to get the next set of results, or null if there are no // additional results. NextToken *string + // The things in the specified thing group. + Things []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_ListTopicRuleDestinations.go b/service/iot/api_op_ListTopicRuleDestinations.go index c6d9193d66a..3cce89215a4 100644 --- a/service/iot/api_op_ListTopicRuleDestinations.go +++ b/service/iot/api_op_ListTopicRuleDestinations.go @@ -56,11 +56,11 @@ func (c *Client) ListTopicRuleDestinations(ctx context.Context, params *ListTopi type ListTopicRuleDestinationsInput struct { - // The token to retrieve the next set of results. - NextToken *string - // The maximum number of results to return at one time. MaxResults *int32 + + // The token to retrieve the next set of results. + NextToken *string } type ListTopicRuleDestinationsOutput struct { diff --git a/service/iot/api_op_ListTopicRules.go b/service/iot/api_op_ListTopicRules.go index 3a517827eed..01ca1b5e73d 100644 --- a/service/iot/api_op_ListTopicRules.go +++ b/service/iot/api_op_ListTopicRules.go @@ -57,8 +57,8 @@ func (c *Client) ListTopicRules(ctx context.Context, params *ListTopicRulesInput // The input for the ListTopicRules operation. type ListTopicRulesInput struct { - // The topic. - Topic *string + // The maximum number of results to return. + MaxResults *int32 // A token used to retrieve the next value. NextToken *string @@ -66,8 +66,8 @@ type ListTopicRulesInput struct { // Specifies whether the rule is disabled. RuleDisabled *bool - // The maximum number of results to return. - MaxResults *int32 + // The topic. + Topic *string } // The output from the ListTopicRules operation. diff --git a/service/iot/api_op_ListV2LoggingLevels.go b/service/iot/api_op_ListV2LoggingLevels.go index 6deea247ca6..8cf0dfea970 100644 --- a/service/iot/api_op_ListV2LoggingLevels.go +++ b/service/iot/api_op_ListV2LoggingLevels.go @@ -56,13 +56,13 @@ func (c *Client) ListV2LoggingLevels(ctx context.Context, params *ListV2LoggingL type ListV2LoggingLevelsInput struct { + // The maximum number of results to return at one time. + MaxResults *int32 + // The token used to get the next set of results, or null if there are no // additional results. NextToken *string - // The maximum number of results to return at one time. - MaxResults *int32 - // The type of resource for which you are configuring logging. Must be THING_Group. TargetType types.LogTargetType } diff --git a/service/iot/api_op_ListViolationEvents.go b/service/iot/api_op_ListViolationEvents.go index 11996110814..6de26d6626f 100644 --- a/service/iot/api_op_ListViolationEvents.go +++ b/service/iot/api_op_ListViolationEvents.go @@ -60,28 +60,28 @@ func (c *Client) ListViolationEvents(ctx context.Context, params *ListViolationE type ListViolationEventsInput struct { - // The maximum number of results to return at one time. - MaxResults *int32 - // The end time for the alerts to be listed. // // This member is required. EndTime *time.Time - // A filter to limit results to those alerts generated by the specified security - // profile. - SecurityProfileName *string - - // A filter to limit results to those alerts caused by the specified thing. - ThingName *string - // The start time for the alerts to be listed. // // This member is required. StartTime *time.Time + // The maximum number of results to return at one time. + MaxResults *int32 + // The token for the next set of results. NextToken *string + + // A filter to limit results to those alerts generated by the specified security + // profile. + SecurityProfileName *string + + // A filter to limit results to those alerts caused by the specified thing. + ThingName *string } type ListViolationEventsOutput struct { diff --git a/service/iot/api_op_RegisterCACertificate.go b/service/iot/api_op_RegisterCACertificate.go index 3dd50f91d1d..0aefc99d610 100644 --- a/service/iot/api_op_RegisterCACertificate.go +++ b/service/iot/api_op_RegisterCACertificate.go @@ -64,15 +64,6 @@ func (c *Client) RegisterCACertificate(ctx context.Context, params *RegisterCACe // The input to the RegisterCACertificate operation. type RegisterCACertificateInput struct { - // Metadata which can be used to manage the CA certificate. For URI Request - // parameters use format: ...key1=value1&key2=value2... For the CLI command-line - // parameter use format: &&tags "key1=value1&key2=value2..." For the cli-input-json - // file use format: "tags": "key1=value1&key2=value2..." - Tags []*types.Tag - - // Information about the registration configuration. - RegistrationConfig *types.RegistrationConfig - // The CA certificate. // // This member is required. @@ -87,8 +78,17 @@ type RegisterCACertificateInput struct { // certificates. AllowAutoRegistration *bool + // Information about the registration configuration. + RegistrationConfig *types.RegistrationConfig + // A boolean value that specifies if the CA certificate is set to active. SetAsActive *bool + + // Metadata which can be used to manage the CA certificate. For URI Request + // parameters use format: ...key1=value1&key2=value2... For the CLI command-line + // parameter use format: &&tags "key1=value1&key2=value2..." For the cli-input-json + // file use format: "tags": "key1=value1&key2=value2..." + Tags []*types.Tag } // The output from the RegisterCACertificateResponse operation. diff --git a/service/iot/api_op_RegisterCertificate.go b/service/iot/api_op_RegisterCertificate.go index de4ccc85348..0f2faab01fc 100644 --- a/service/iot/api_op_RegisterCertificate.go +++ b/service/iot/api_op_RegisterCertificate.go @@ -60,19 +60,19 @@ func (c *Client) RegisterCertificate(ctx context.Context, params *RegisterCertif // The input to the RegisterCertificate operation. type RegisterCertificateInput struct { - // The status of the register certificate request. - Status types.CertificateStatus - - // A boolean value that specifies if the certificate is set to active. - SetAsActive *bool - - // The CA certificate used to sign the device certificate being registered. - CaCertificatePem *string - // The certificate data, in PEM format. // // This member is required. CertificatePem *string + + // The CA certificate used to sign the device certificate being registered. + CaCertificatePem *string + + // A boolean value that specifies if the certificate is set to active. + SetAsActive *bool + + // The status of the register certificate request. + Status types.CertificateStatus } // The output from the RegisterCertificate operation. diff --git a/service/iot/api_op_RegisterCertificateWithoutCA.go b/service/iot/api_op_RegisterCertificateWithoutCA.go index 41affdbdba7..c6c8a9e733b 100644 --- a/service/iot/api_op_RegisterCertificateWithoutCA.go +++ b/service/iot/api_op_RegisterCertificateWithoutCA.go @@ -68,13 +68,13 @@ type RegisterCertificateWithoutCAInput struct { type RegisterCertificateWithoutCAOutput struct { + // The Amazon Resource Name (ARN) of the registered certificate. + CertificateArn *string + // The ID of the registered certificate. (The last part of the certificate ARN // contains the certificate ID. CertificateId *string - // The Amazon Resource Name (ARN) of the registered certificate. - CertificateArn *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_RegisterThing.go b/service/iot/api_op_RegisterThing.go index a6a965e73ec..662668adf42 100644 --- a/service/iot/api_op_RegisterThing.go +++ b/service/iot/api_op_RegisterThing.go @@ -62,11 +62,6 @@ func (c *Client) RegisterThing(ctx context.Context, params *RegisterThingInput, type RegisterThingInput struct { - // The parameters for provisioning a thing. See Provisioning Templates - // (https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html) - // for more information. - Parameters map[string]*string - // The provisioning template. See Provisioning Devices That Have Device // Certificates // (https://docs.aws.amazon.com/iot/latest/developerguide/provision-w-cert.html) @@ -74,16 +69,21 @@ type RegisterThingInput struct { // // This member is required. TemplateBody *string + + // The parameters for provisioning a thing. See Provisioning Templates + // (https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html) + // for more information. + Parameters map[string]*string } type RegisterThingOutput struct { - // ARNs for the generated resources. - ResourceArns map[string]*string - // The certificate data, in PEM format. CertificatePem *string + // ARNs for the generated resources. + ResourceArns map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_RejectCertificateTransfer.go b/service/iot/api_op_RejectCertificateTransfer.go index 0fe03c940fd..1813e5c73b1 100644 --- a/service/iot/api_op_RejectCertificateTransfer.go +++ b/service/iot/api_op_RejectCertificateTransfer.go @@ -62,14 +62,14 @@ func (c *Client) RejectCertificateTransfer(ctx context.Context, params *RejectCe // The input for the RejectCertificateTransfer operation. type RejectCertificateTransferInput struct { - // The reason the certificate transfer was rejected. - RejectReason *string - // The ID of the certificate. (The last part of the certificate ARN contains the // certificate ID.) // // This member is required. CertificateId *string + + // The reason the certificate transfer was rejected. + RejectReason *string } type RejectCertificateTransferOutput struct { diff --git a/service/iot/api_op_RemoveThingFromBillingGroup.go b/service/iot/api_op_RemoveThingFromBillingGroup.go index 68d04ce0adf..3b193c2985a 100644 --- a/service/iot/api_op_RemoveThingFromBillingGroup.go +++ b/service/iot/api_op_RemoveThingFromBillingGroup.go @@ -55,17 +55,17 @@ func (c *Client) RemoveThingFromBillingGroup(ctx context.Context, params *Remove type RemoveThingFromBillingGroupInput struct { - // The ARN of the thing to be removed from the billing group. - ThingArn *string - - // The name of the thing to be removed from the billing group. - ThingName *string - // The ARN of the billing group. BillingGroupArn *string // The name of the billing group. BillingGroupName *string + + // The ARN of the thing to be removed from the billing group. + ThingArn *string + + // The name of the thing to be removed from the billing group. + ThingName *string } type RemoveThingFromBillingGroupOutput struct { diff --git a/service/iot/api_op_RemoveThingFromThingGroup.go b/service/iot/api_op_RemoveThingFromThingGroup.go index cea203bb6c9..c505c08208c 100644 --- a/service/iot/api_op_RemoveThingFromThingGroup.go +++ b/service/iot/api_op_RemoveThingFromThingGroup.go @@ -60,14 +60,14 @@ type RemoveThingFromThingGroupInput struct { // The ARN of the thing to remove from the group. ThingArn *string - // The name of the thing to remove from the group. - ThingName *string + // The group ARN. + ThingGroupArn *string // The group name. ThingGroupName *string - // The group ARN. - ThingGroupArn *string + // The name of the thing to remove from the group. + ThingName *string } type RemoveThingFromThingGroupOutput struct { diff --git a/service/iot/api_op_ReplaceTopicRule.go b/service/iot/api_op_ReplaceTopicRule.go index 6bd66096152..501366fba73 100644 --- a/service/iot/api_op_ReplaceTopicRule.go +++ b/service/iot/api_op_ReplaceTopicRule.go @@ -60,15 +60,15 @@ func (c *Client) ReplaceTopicRule(ctx context.Context, params *ReplaceTopicRuleI // The input for the ReplaceTopicRule operation. type ReplaceTopicRuleInput struct { - // The rule payload. + // The name of the rule. // // This member is required. - TopicRulePayload *types.TopicRulePayload + RuleName *string - // The name of the rule. + // The rule payload. // // This member is required. - RuleName *string + TopicRulePayload *types.TopicRulePayload } type ReplaceTopicRuleOutput struct { diff --git a/service/iot/api_op_SearchIndex.go b/service/iot/api_op_SearchIndex.go index e9797f05e7e..cd53d3df850 100644 --- a/service/iot/api_op_SearchIndex.go +++ b/service/iot/api_op_SearchIndex.go @@ -62,18 +62,18 @@ type SearchIndexInput struct { // This member is required. QueryString *string - // The query version. - QueryVersion *string - // The search index name. IndexName *string + // The maximum number of results to return at one time. + MaxResults *int32 + // The token used to get the next set of results, or null if there are no // additional results. NextToken *string - // The maximum number of results to return at one time. - MaxResults *int32 + // The query version. + QueryVersion *string } type SearchIndexOutput struct { @@ -82,12 +82,12 @@ type SearchIndexOutput struct { // additional results. NextToken *string - // The things that match the search query. - Things []*types.ThingDocument - // The thing groups that match the search query. ThingGroups []*types.ThingGroupDocument + // The things that match the search query. + Things []*types.ThingDocument + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_SetDefaultAuthorizer.go b/service/iot/api_op_SetDefaultAuthorizer.go index 223a81b1de3..95f7697dc34 100644 --- a/service/iot/api_op_SetDefaultAuthorizer.go +++ b/service/iot/api_op_SetDefaultAuthorizer.go @@ -65,12 +65,12 @@ type SetDefaultAuthorizerInput struct { type SetDefaultAuthorizerOutput struct { - // The authorizer name. - AuthorizerName *string - // The authorizer ARN. AuthorizerArn *string + // The authorizer name. + AuthorizerName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_SetV2LoggingOptions.go b/service/iot/api_op_SetV2LoggingOptions.go index 06aedd4b549..1b57d35b1c0 100644 --- a/service/iot/api_op_SetV2LoggingOptions.go +++ b/service/iot/api_op_SetV2LoggingOptions.go @@ -59,11 +59,11 @@ type SetV2LoggingOptionsInput struct { // The default logging level. DefaultLogLevel types.LogLevel - // The ARN of the role that allows IoT to write to Cloudwatch logs. - RoleArn *string - // If true all logs are disabled. The default is false. DisableAllLogs *bool + + // The ARN of the role that allows IoT to write to Cloudwatch logs. + RoleArn *string } type SetV2LoggingOptionsOutput struct { diff --git a/service/iot/api_op_StartAuditMitigationActionsTask.go b/service/iot/api_op_StartAuditMitigationActionsTask.go index 28a19935859..201aef94d96 100644 --- a/service/iot/api_op_StartAuditMitigationActionsTask.go +++ b/service/iot/api_op_StartAuditMitigationActionsTask.go @@ -59,6 +59,12 @@ func (c *Client) StartAuditMitigationActionsTask(ctx context.Context, params *St type StartAuditMitigationActionsTaskInput struct { + // For an audit check, specifies which mitigation actions to apply. Those actions + // must be defined in your AWS account. + // + // This member is required. + AuditCheckToActionsMapping map[string][]*string + // Each audit mitigation task must have a unique client request token. If you try // to start a new task with the same token as a task that already exists, an // exception occurs. If you omit this value, a unique client request token is @@ -79,12 +85,6 @@ type StartAuditMitigationActionsTaskInput struct { // // This member is required. TaskId *string - - // For an audit check, specifies which mitigation actions to apply. Those actions - // must be defined in your AWS account. - // - // This member is required. - AuditCheckToActionsMapping map[string][]*string } type StartAuditMitigationActionsTaskOutput struct { diff --git a/service/iot/api_op_StartThingRegistrationTask.go b/service/iot/api_op_StartThingRegistrationTask.go index e989b7d086b..a6c96186bcc 100644 --- a/service/iot/api_op_StartThingRegistrationTask.go +++ b/service/iot/api_op_StartThingRegistrationTask.go @@ -56,10 +56,10 @@ func (c *Client) StartThingRegistrationTask(ctx context.Context, params *StartTh type StartThingRegistrationTaskInput struct { - // The IAM role ARN that grants permission the input file. + // The S3 bucket that contains the input file. // // This member is required. - RoleArn *string + InputFileBucket *string // The name of input file within the S3 bucket. This file contains a newline // delimited JSON file. Each line contains the parameter values to provision one @@ -68,10 +68,10 @@ type StartThingRegistrationTaskInput struct { // This member is required. InputFileKey *string - // The S3 bucket that contains the input file. + // The IAM role ARN that grants permission the input file. // // This member is required. - InputFileBucket *string + RoleArn *string // The provisioning template. // diff --git a/service/iot/api_op_TagResource.go b/service/iot/api_op_TagResource.go index fc32c88d7e9..ec1ee42a1ed 100644 --- a/service/iot/api_op_TagResource.go +++ b/service/iot/api_op_TagResource.go @@ -58,15 +58,15 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The new or modified tags for the resource. + // The ARN of the resource. // // This member is required. - Tags []*types.Tag + ResourceArn *string - // The ARN of the resource. + // The new or modified tags for the resource. // // This member is required. - ResourceArn *string + Tags []*types.Tag } type TagResourceOutput struct { diff --git a/service/iot/api_op_TestAuthorization.go b/service/iot/api_op_TestAuthorization.go index 6762533e680..ff532172dde 100644 --- a/service/iot/api_op_TestAuthorization.go +++ b/service/iot/api_op_TestAuthorization.go @@ -59,6 +59,18 @@ func (c *Client) TestAuthorization(ctx context.Context, params *TestAuthorizatio type TestAuthorizationInput struct { + // A list of authorization info objects. Simulating authorization will create a + // response for each authInfo object in the list. + // + // This member is required. + AuthInfos []*types.AuthInfo + + // The MQTT client ID. + ClientId *string + + // The Cognito identity pool ID. + CognitoIdentityPoolId *string + // When testing custom authorization, the policies specified here are treated as if // they are attached to the principal being authorized. PolicyNamesToAdd []*string @@ -69,18 +81,6 @@ type TestAuthorizationInput struct { // The principal. Principal *string - - // The Cognito identity pool ID. - CognitoIdentityPoolId *string - - // The MQTT client ID. - ClientId *string - - // A list of authorization info objects. Simulating authorization will create a - // response for each authInfo object in the list. - // - // This member is required. - AuthInfos []*types.AuthInfo } type TestAuthorizationOutput struct { diff --git a/service/iot/api_op_TestInvokeAuthorizer.go b/service/iot/api_op_TestInvokeAuthorizer.go index 56395c67347..5194a16b6ce 100644 --- a/service/iot/api_op_TestInvokeAuthorizer.go +++ b/service/iot/api_op_TestInvokeAuthorizer.go @@ -59,45 +59,45 @@ func (c *Client) TestInvokeAuthorizer(ctx context.Context, params *TestInvokeAut type TestInvokeAuthorizerInput struct { - // The token returned by your custom authentication service. - Token *string - - // The signature made with the token and your custom authentication service's - // private key. This value must be Base-64-encoded. - TokenSignature *string - - // Specifies a test MQTT authorization request. - MqttContext *types.MqttContext - // The custom authorizer name. // // This member is required. AuthorizerName *string + // Specifies a test HTTP authorization request. + HttpContext *types.HttpContext + + // Specifies a test MQTT authorization request. + MqttContext *types.MqttContext + // Specifies a test TLS authorization request. TlsContext *types.TlsContext - // Specifies a test HTTP authorization request. - HttpContext *types.HttpContext + // The token returned by your custom authentication service. + Token *string + + // The signature made with the token and your custom authentication service's + // private key. This value must be Base-64-encoded. + TokenSignature *string } type TestInvokeAuthorizerOutput struct { - // IAM policy documents. - PolicyDocuments []*string - - // The number of seconds after which the temporary credentials are refreshed. - RefreshAfterInSeconds *int32 + // The number of seconds after which the connection is terminated. + DisconnectAfterInSeconds *int32 // True if the token is authenticated, otherwise false. IsAuthenticated *bool - // The number of seconds after which the connection is terminated. - DisconnectAfterInSeconds *int32 + // IAM policy documents. + PolicyDocuments []*string // The principal ID. PrincipalId *string + // The number of seconds after which the temporary credentials are refreshed. + RefreshAfterInSeconds *int32 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_TransferCertificate.go b/service/iot/api_op_TransferCertificate.go index 8ef1f1d873a..04445ce5cb2 100644 --- a/service/iot/api_op_TransferCertificate.go +++ b/service/iot/api_op_TransferCertificate.go @@ -69,13 +69,13 @@ type TransferCertificateInput struct { // This member is required. CertificateId *string - // The transfer message. - TransferMessage *string - // The AWS account. // // This member is required. TargetAwsAccount *string + + // The transfer message. + TransferMessage *string } // The output from the TransferCertificate operation. diff --git a/service/iot/api_op_UntagResource.go b/service/iot/api_op_UntagResource.go index 27810de538c..86cb4530ee2 100644 --- a/service/iot/api_op_UntagResource.go +++ b/service/iot/api_op_UntagResource.go @@ -56,15 +56,15 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // A list of the keys of the tags to be removed from the resource. + // The ARN of the resource. // // This member is required. - TagKeys []*string + ResourceArn *string - // The ARN of the resource. + // A list of the keys of the tags to be removed from the resource. // // This member is required. - ResourceArn *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/iot/api_op_UpdateAuthorizer.go b/service/iot/api_op_UpdateAuthorizer.go index 05c39fab061..d019046047e 100644 --- a/service/iot/api_op_UpdateAuthorizer.go +++ b/service/iot/api_op_UpdateAuthorizer.go @@ -57,32 +57,32 @@ func (c *Client) UpdateAuthorizer(ctx context.Context, params *UpdateAuthorizerI type UpdateAuthorizerInput struct { + // The authorizer name. + // + // This member is required. + AuthorizerName *string + // The ARN of the authorizer's Lambda function. AuthorizerFunctionArn *string + // The status of the update authorizer request. + Status types.AuthorizerStatus + // The key used to extract the token from the HTTP headers. TokenKeyName *string // The public keys used to verify the token signature. TokenSigningPublicKeys map[string]*string - - // The status of the update authorizer request. - Status types.AuthorizerStatus - - // The authorizer name. - // - // This member is required. - AuthorizerName *string } type UpdateAuthorizerOutput struct { - // The authorizer name. - AuthorizerName *string - // The authorizer ARN. AuthorizerArn *string + // The authorizer name. + AuthorizerName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_UpdateBillingGroup.go b/service/iot/api_op_UpdateBillingGroup.go index 3445498df8a..b314b943f67 100644 --- a/service/iot/api_op_UpdateBillingGroup.go +++ b/service/iot/api_op_UpdateBillingGroup.go @@ -57,6 +57,11 @@ func (c *Client) UpdateBillingGroup(ctx context.Context, params *UpdateBillingGr type UpdateBillingGroupInput struct { + // The name of the billing group. + // + // This member is required. + BillingGroupName *string + // The properties of the billing group. // // This member is required. @@ -66,11 +71,6 @@ type UpdateBillingGroupInput struct { // does not match the expected version specified in the request, the // UpdateBillingGroup request is rejected with a VersionConflictException. ExpectedVersion *int64 - - // The name of the billing group. - // - // This member is required. - BillingGroupName *string } type UpdateBillingGroupOutput struct { diff --git a/service/iot/api_op_UpdateCACertificate.go b/service/iot/api_op_UpdateCACertificate.go index dc28719d3dd..017bb031366 100644 --- a/service/iot/api_op_UpdateCACertificate.go +++ b/service/iot/api_op_UpdateCACertificate.go @@ -58,24 +58,24 @@ func (c *Client) UpdateCACertificate(ctx context.Context, params *UpdateCACertif // The input to the UpdateCACertificate operation. type UpdateCACertificateInput struct { - // If true, removes auto registration. - RemoveAutoRegistration *bool - // The CA certificate identifier. // // This member is required. CertificateId *string - // The updated status of the CA certificate. Note: The status value - // REGISTER_INACTIVE is deprecated and should not be used. - NewStatus types.CACertificateStatus - // The new value for the auto registration status. Valid values are: "ENABLE" or // "DISABLE". NewAutoRegistrationStatus types.AutoRegistrationStatus + // The updated status of the CA certificate. Note: The status value + // REGISTER_INACTIVE is deprecated and should not be used. + NewStatus types.CACertificateStatus + // Information about the registration configuration. RegistrationConfig *types.RegistrationConfig + + // If true, removes auto registration. + RemoveAutoRegistration *bool } type UpdateCACertificateOutput struct { diff --git a/service/iot/api_op_UpdateDimension.go b/service/iot/api_op_UpdateDimension.go index 60efd2a8244..0b57ab2747d 100644 --- a/service/iot/api_op_UpdateDimension.go +++ b/service/iot/api_op_UpdateDimension.go @@ -75,26 +75,26 @@ type UpdateDimensionInput struct { type UpdateDimensionOutput struct { - // The value or list of values used to scope the dimension. For example, for topic - // filters, this is the pattern used to match the MQTT topic name. - StringValues []*string - - // The type of the dimension. - Type types.DimensionType + // The ARN (Amazon resource name) of the created dimension. + Arn *string // The date and time, in milliseconds since epoch, when the dimension was initially // created. CreationDate *time.Time + // The date and time, in milliseconds since epoch, when the dimension was most + // recently updated. + LastModifiedDate *time.Time + // A unique identifier for the dimension. Name *string - // The ARN (Amazon resource name) of the created dimension. - Arn *string + // The value or list of values used to scope the dimension. For example, for topic + // filters, this is the pattern used to match the MQTT topic name. + StringValues []*string - // The date and time, in milliseconds since epoch, when the dimension was most - // recently updated. - LastModifiedDate *time.Time + // The type of the dimension. + Type types.DimensionType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/iot/api_op_UpdateDomainConfiguration.go b/service/iot/api_op_UpdateDomainConfiguration.go index 7874796b2d3..38b5da2abf4 100644 --- a/service/iot/api_op_UpdateDomainConfiguration.go +++ b/service/iot/api_op_UpdateDomainConfiguration.go @@ -64,24 +64,24 @@ type UpdateDomainConfigurationInput struct { // This member is required. DomainConfigurationName *string - // The status to which the domain configuration should be updated. - DomainConfigurationStatus types.DomainConfigurationStatus - // An object that specifies the authorization service for a domain. AuthorizerConfig *types.AuthorizerConfig + // The status to which the domain configuration should be updated. + DomainConfigurationStatus types.DomainConfigurationStatus + // Removes the authorization configuration from a domain. RemoveAuthorizerConfig *bool } type UpdateDomainConfigurationOutput struct { - // The name of the domain configuration that was updated. - DomainConfigurationName *string - // The ARN of the domain configuration that was updated. DomainConfigurationArn *string + // The name of the domain configuration that was updated. + DomainConfigurationName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_UpdateIndexingConfiguration.go b/service/iot/api_op_UpdateIndexingConfiguration.go index f20c47adfc0..74fb5cc32c6 100644 --- a/service/iot/api_op_UpdateIndexingConfiguration.go +++ b/service/iot/api_op_UpdateIndexingConfiguration.go @@ -57,11 +57,11 @@ func (c *Client) UpdateIndexingConfiguration(ctx context.Context, params *Update type UpdateIndexingConfigurationInput struct { - // Thing indexing configuration. - ThingIndexingConfiguration *types.ThingIndexingConfiguration - // Thing group indexing configuration. ThingGroupIndexingConfiguration *types.ThingGroupIndexingConfiguration + + // Thing indexing configuration. + ThingIndexingConfiguration *types.ThingIndexingConfiguration } type UpdateIndexingConfigurationOutput struct { diff --git a/service/iot/api_op_UpdateJob.go b/service/iot/api_op_UpdateJob.go index 9f7fc259efd..47d1c16a55d 100644 --- a/service/iot/api_op_UpdateJob.go +++ b/service/iot/api_op_UpdateJob.go @@ -62,6 +62,15 @@ type UpdateJobInput struct { // This member is required. JobId *string + // Allows you to create criteria to abort a job. + AbortConfig *types.AbortConfig + + // A short text description of the job. + Description *string + + // Allows you to create a staged rollout of the job. + JobExecutionsRolloutConfig *types.JobExecutionsRolloutConfig + // Configuration information for pre-signed S3 URLs. PresignedUrlConfig *types.PresignedUrlConfig @@ -70,15 +79,6 @@ type UpdateJobInput struct { // job execution status is not set to another terminal state before the time // expires, it will be automatically set to TIMED_OUT. TimeoutConfig *types.TimeoutConfig - - // A short text description of the job. - Description *string - - // Allows you to create a staged rollout of the job. - JobExecutionsRolloutConfig *types.JobExecutionsRolloutConfig - - // Allows you to create criteria to abort a job. - AbortConfig *types.AbortConfig } type UpdateJobOutput struct { diff --git a/service/iot/api_op_UpdateMitigationAction.go b/service/iot/api_op_UpdateMitigationAction.go index de40e94aa44..72e23eb6b8a 100644 --- a/service/iot/api_op_UpdateMitigationAction.go +++ b/service/iot/api_op_UpdateMitigationAction.go @@ -57,28 +57,28 @@ func (c *Client) UpdateMitigationAction(ctx context.Context, params *UpdateMitig type UpdateMitigationActionInput struct { - // The ARN of the IAM role that is used to apply the mitigation action. - RoleArn *string - - // Defines the type of action and the parameters for that action. - ActionParams *types.MitigationActionParams - // The friendly name for the mitigation action. You can't change the name by using // UpdateMitigationAction. Instead, you must delete and re-create the mitigation // action with the new name. // // This member is required. ActionName *string + + // Defines the type of action and the parameters for that action. + ActionParams *types.MitigationActionParams + + // The ARN of the IAM role that is used to apply the mitigation action. + RoleArn *string } type UpdateMitigationActionOutput struct { - // A unique identifier for the mitigation action. - ActionId *string - // The ARN for the new mitigation action. ActionArn *string + // A unique identifier for the mitigation action. + ActionId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_UpdateProvisioningTemplate.go b/service/iot/api_op_UpdateProvisioningTemplate.go index 0b81882ca72..41a5783f939 100644 --- a/service/iot/api_op_UpdateProvisioningTemplate.go +++ b/service/iot/api_op_UpdateProvisioningTemplate.go @@ -62,24 +62,24 @@ type UpdateProvisioningTemplateInput struct { // This member is required. TemplateName *string - // True to enable the fleet provisioning template, otherwise false. - Enabled *bool - - // Removes pre-provisioning hook template. - RemovePreProvisioningHook *bool - - // Updates the pre-provisioning hook template. - PreProvisioningHook *types.ProvisioningHook - // The ID of the default provisioning template version. DefaultVersionId *int32 // The description of the fleet provisioning template. Description *string + // True to enable the fleet provisioning template, otherwise false. + Enabled *bool + + // Updates the pre-provisioning hook template. + PreProvisioningHook *types.ProvisioningHook + // The ARN of the role associated with the provisioning template. This IoT role // grants permission to provision a device. ProvisioningRoleArn *string + + // Removes pre-provisioning hook template. + RemovePreProvisioningHook *bool } type UpdateProvisioningTemplateOutput struct { diff --git a/service/iot/api_op_UpdateRoleAlias.go b/service/iot/api_op_UpdateRoleAlias.go index cfdb199d99f..610a2ceb179 100644 --- a/service/iot/api_op_UpdateRoleAlias.go +++ b/service/iot/api_op_UpdateRoleAlias.go @@ -56,9 +56,6 @@ func (c *Client) UpdateRoleAlias(ctx context.Context, params *UpdateRoleAliasInp type UpdateRoleAliasInput struct { - // The role ARN. - RoleArn *string - // The role alias to update. // // This member is required. @@ -66,16 +63,19 @@ type UpdateRoleAliasInput struct { // The number of seconds the credential will be valid. CredentialDurationSeconds *int32 + + // The role ARN. + RoleArn *string } type UpdateRoleAliasOutput struct { - // The role alias ARN. - RoleAliasArn *string - // The role alias. RoleAlias *string + // The role alias ARN. + RoleAliasArn *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_UpdateScheduledAudit.go b/service/iot/api_op_UpdateScheduledAudit.go index 20ce3761de0..6e599bbded7 100644 --- a/service/iot/api_op_UpdateScheduledAudit.go +++ b/service/iot/api_op_UpdateScheduledAudit.go @@ -58,32 +58,32 @@ func (c *Client) UpdateScheduledAudit(ctx context.Context, params *UpdateSchedul type UpdateScheduledAuditInput struct { - // The day of the week on which the scheduled audit takes place. Can be one of - // "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT". This field is required if - // the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY". - DayOfWeek types.DayOfWeek - // The name of the scheduled audit. (Max. 128 chars) // // This member is required. ScheduledAuditName *string - // Which checks are performed during the scheduled audit. Checks must be enabled - // for your account. (Use DescribeAccountAuditConfiguration to see the list of all - // checks, including those that are enabled or use UpdateAccountAuditConfiguration - // to select which checks are enabled.) - TargetCheckNames []*string - // The day of the month on which the scheduled audit takes place. Can be "1" // through "31" or "LAST". This field is required if the "frequency" parameter is // set to "MONTHLY". If days 29-31 are specified, and the month does not have that // many days, the audit takes place on the "LAST" day of the month. DayOfMonth *string + // The day of the week on which the scheduled audit takes place. Can be one of + // "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT". This field is required if + // the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY". + DayOfWeek types.DayOfWeek + // How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY", // "BIWEEKLY", or "MONTHLY". The start time of each audit is determined by the // system. Frequency types.AuditFrequency + + // Which checks are performed during the scheduled audit. Checks must be enabled + // for your account. (Use DescribeAccountAuditConfiguration to see the list of all + // checks, including those that are enabled or use UpdateAccountAuditConfiguration + // to select which checks are enabled.) + TargetCheckNames []*string } type UpdateScheduledAuditOutput struct { diff --git a/service/iot/api_op_UpdateSecurityProfile.go b/service/iot/api_op_UpdateSecurityProfile.go index 26c9f7ad65a..9fb67b6f7f8 100644 --- a/service/iot/api_op_UpdateSecurityProfile.go +++ b/service/iot/api_op_UpdateSecurityProfile.go @@ -58,18 +58,6 @@ func (c *Client) UpdateSecurityProfile(ctx context.Context, params *UpdateSecuri type UpdateSecurityProfileInput struct { - // If true, delete all behaviors defined for this security profile. If any - // behaviors are defined in the current invocation, an exception occurs. - DeleteBehaviors *bool - - // A description of the security profile. - SecurityProfileDescription *string - - // The expected version of the security profile. A new version is generated - // whenever the security profile is updated. If you specify a value that is - // different from the actual version, a VersionConflictException is thrown. - ExpectedVersion *int64 - // The name of the security profile you want to update. // // This member is required. @@ -81,25 +69,37 @@ type UpdateSecurityProfileInput struct { // UpdateSecurityProfileRequest$additionalMetricsToRetainV2 () instead. AdditionalMetricsToRetain []*string + // A list of metrics whose data is retained (stored). By default, data is retained + // for any metric used in the profile's behaviors, but it is also retained for any + // metric specified here. + AdditionalMetricsToRetainV2 []*types.MetricToRetain + + // Where the alerts are sent. (Alerts are always sent to the console.) + AlertTargets map[string]*types.AlertTarget + + // Specifies the behaviors that, when violated by a device (thing), cause an alert. + Behaviors []*types.Behavior + // If true, delete all additionalMetricsToRetain defined for this security profile. // If any additionalMetricsToRetain are defined in the current invocation, an // exception occurs. DeleteAdditionalMetricsToRetain *bool - // Specifies the behaviors that, when violated by a device (thing), cause an alert. - Behaviors []*types.Behavior - // If true, delete all alertTargets defined for this security profile. If any // alertTargets are defined in the current invocation, an exception occurs. DeleteAlertTargets *bool - // Where the alerts are sent. (Alerts are always sent to the console.) - AlertTargets map[string]*types.AlertTarget + // If true, delete all behaviors defined for this security profile. If any + // behaviors are defined in the current invocation, an exception occurs. + DeleteBehaviors *bool - // A list of metrics whose data is retained (stored). By default, data is retained - // for any metric used in the profile's behaviors, but it is also retained for any - // metric specified here. - AdditionalMetricsToRetainV2 []*types.MetricToRetain + // The expected version of the security profile. A new version is generated + // whenever the security profile is updated. If you specify a value that is + // different from the actual version, a VersionConflictException is thrown. + ExpectedVersion *int64 + + // A description of the security profile. + SecurityProfileDescription *string } type UpdateSecurityProfileOutput struct { @@ -110,35 +110,35 @@ type UpdateSecurityProfileOutput struct { // UpdateSecurityProfileResponse$additionalMetricsToRetainV2 () instead. AdditionalMetricsToRetain []*string - // The time the security profile was created. - CreationDate *time.Time - // A list of metrics whose data is retained (stored). By default, data is retained // for any metric used in the profile's behaviors, but it is also retained for any // metric specified here. AdditionalMetricsToRetainV2 []*types.MetricToRetain + // Where the alerts are sent. (Alerts are always sent to the console.) + AlertTargets map[string]*types.AlertTarget + // Specifies the behaviors that, when violated by a device (thing), cause an alert. Behaviors []*types.Behavior - // The name of the security profile that was updated. - SecurityProfileName *string + // The time the security profile was created. + CreationDate *time.Time - // The description of the security profile. - SecurityProfileDescription *string + // The time the security profile was last modified. + LastModifiedDate *time.Time // The ARN of the security profile that was updated. SecurityProfileArn *string - // The time the security profile was last modified. - LastModifiedDate *time.Time + // The description of the security profile. + SecurityProfileDescription *string + + // The name of the security profile that was updated. + SecurityProfileName *string // The updated version of the security profile. Version *int64 - // Where the alerts are sent. (Alerts are always sent to the console.) - AlertTargets map[string]*types.AlertTarget - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot/api_op_UpdateStream.go b/service/iot/api_op_UpdateStream.go index 9c7cd923308..21c1709affe 100644 --- a/service/iot/api_op_UpdateStream.go +++ b/service/iot/api_op_UpdateStream.go @@ -57,13 +57,6 @@ func (c *Client) UpdateStream(ctx context.Context, params *UpdateStreamInput, op type UpdateStreamInput struct { - // An IAM role that allows the IoT service principal assumes to access your S3 - // files. - RoleArn *string - - // The files associated with the stream. - Files []*types.StreamFile - // The stream ID. // // This member is required. @@ -71,18 +64,25 @@ type UpdateStreamInput struct { // The description of the stream. Description *string + + // The files associated with the stream. + Files []*types.StreamFile + + // An IAM role that allows the IoT service principal assumes to access your S3 + // files. + RoleArn *string } type UpdateStreamOutput struct { - // The stream ID. - StreamId *string + // A description of the stream. + Description *string // The stream ARN. StreamArn *string - // A description of the stream. - Description *string + // The stream ID. + StreamId *string // The stream version. StreamVersion *int32 diff --git a/service/iot/api_op_UpdateThing.go b/service/iot/api_op_UpdateThing.go index d0fd39026ea..7dff5660025 100644 --- a/service/iot/api_op_UpdateThing.go +++ b/service/iot/api_op_UpdateThing.go @@ -58,14 +58,6 @@ func (c *Client) UpdateThing(ctx context.Context, params *UpdateThingInput, optF // The input for the UpdateThing operation. type UpdateThingInput struct { - // The name of the thing type. - ThingTypeName *string - - // The expected version of the thing record in the registry. If the version of the - // record in the registry does not match the expected version specified in the - // request, the UpdateThing request is rejected with a VersionConflictException. - ExpectedVersion *int64 - // The name of the thing to update. You can't change a thing's name. To change a // thing's name, you must create a new thing, give it the new name, and then delete // the old thing. @@ -78,8 +70,16 @@ type UpdateThingInput struct { // attributes or update existing attributes. AttributePayload *types.AttributePayload + // The expected version of the thing record in the registry. If the version of the + // record in the registry does not match the expected version specified in the + // request, the UpdateThing request is rejected with a VersionConflictException. + ExpectedVersion *int64 + // Remove a thing type association. If true, the association is removed. RemoveThingType *bool + + // The name of the thing type. + ThingTypeName *string } // The output from the UpdateThing operation. diff --git a/service/iot/api_op_UpdateThingGroup.go b/service/iot/api_op_UpdateThingGroup.go index 98eb4ba63a1..b6a640deaa1 100644 --- a/service/iot/api_op_UpdateThingGroup.go +++ b/service/iot/api_op_UpdateThingGroup.go @@ -62,14 +62,14 @@ type UpdateThingGroupInput struct { // This member is required. ThingGroupName *string - // The expected version of the thing group. If this does not match the version of - // the thing group being updated, the update will fail. - ExpectedVersion *int64 - // The thing group properties. // // This member is required. ThingGroupProperties *types.ThingGroupProperties + + // The expected version of the thing group. If this does not match the version of + // the thing group being updated, the update will fail. + ExpectedVersion *int64 } type UpdateThingGroupOutput struct { diff --git a/service/iot/api_op_UpdateThingGroupsForThing.go b/service/iot/api_op_UpdateThingGroupsForThing.go index cddc2217d85..404242d2791 100644 --- a/service/iot/api_op_UpdateThingGroupsForThing.go +++ b/service/iot/api_op_UpdateThingGroupsForThing.go @@ -61,14 +61,14 @@ type UpdateThingGroupsForThingInput struct { // from the last dynamic group. OverrideDynamicGroups *bool + // The groups to which the thing will be added. + ThingGroupsToAdd []*string + // The groups from which the thing will be removed. ThingGroupsToRemove []*string // The thing whose group memberships will be updated. ThingName *string - - // The groups to which the thing will be added. - ThingGroupsToAdd []*string } type UpdateThingGroupsForThingOutput struct { diff --git a/service/iot/go.mod b/service/iot/go.mod index 89dabdd5687..1808aea4a45 100644 --- a/service/iot/go.mod +++ b/service/iot/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/iot go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/iot/types/types.go b/service/iot/types/types.go index 8eda692a647..6d3ff9882f0 100644 --- a/service/iot/types/types.go +++ b/service/iot/types/types.go @@ -23,16 +23,16 @@ type AbortCriteria struct { // This member is required. Action AbortAction - // The minimum number of things which must receive job execution notifications - // before the job can be aborted. + // The type of job execution failures that can initiate a job abort. // // This member is required. - MinNumberOfExecutedThings *int32 + FailureType JobExecutionFailureType - // The type of job execution failures that can initiate a job abort. + // The minimum number of things which must receive job execution notifications + // before the job can be aborted. // // This member is required. - FailureType JobExecutionFailureType + MinNumberOfExecutedThings *int32 // The minimum percentage of job execution failures that must occur to initiate the // job abort. AWS IoT supports up to two digits after the decimal (for example, @@ -45,46 +45,34 @@ type AbortCriteria struct { // Describes the actions associated with a rule. type Action struct { - // Starts execution of a Step Functions state machine. - StepFunctions *StepFunctionsAction + // Change the state of a CloudWatch alarm. + CloudwatchAlarm *CloudwatchAlarmAction - // Write data to an Amazon Kinesis stream. - Kinesis *KinesisAction + // Send data to CloudWatch Logs. + CloudwatchLogs *CloudwatchLogsAction - // Write to an Amazon Kinesis Firehose stream. - Firehose *FirehoseAction + // Capture a CloudWatch metric. + CloudwatchMetric *CloudwatchMetricAction - // Write to an Amazon S3 bucket. - S3 *S3Action + // Write to a DynamoDB table. + DynamoDB *DynamoDBAction // Write to a DynamoDB table. This is a new version of the DynamoDB action. It // allows you to write each attribute in an MQTT message payload into a separate // DynamoDB column. DynamoDBv2 *DynamoDBv2Action - // Capture a CloudWatch metric. - CloudwatchMetric *CloudwatchMetricAction - - // Publish to another MQTT topic. - Republish *RepublishAction + // Write data to an Amazon Elasticsearch Service domain. + Elasticsearch *ElasticsearchAction - // Publish to an Amazon SNS topic. - Sns *SnsAction + // Write to an Amazon Kinesis Firehose stream. + Firehose *FirehoseAction // Send data to an HTTPS endpoint. Http *HttpAction - // Publish to an Amazon SQS queue. - Sqs *SqsAction - - // Write data to an Amazon Elasticsearch Service domain. - Elasticsearch *ElasticsearchAction - - // Invoke a Lambda function. - Lambda *LambdaAction - - // Change the state of a CloudWatch alarm. - CloudwatchAlarm *CloudwatchAlarmAction + // Sends message data to an AWS IoT Analytics channel. + IotAnalytics *IotAnalyticsAction // Sends an input to an AWS IoT Events detector. IotEvents *IotEventsAction @@ -93,59 +81,71 @@ type Action struct { // asset properties. IotSiteWise *IotSiteWiseAction - // Send data to CloudWatch Logs. - CloudwatchLogs *CloudwatchLogsAction + // Write data to an Amazon Kinesis stream. + Kinesis *KinesisAction + + // Invoke a Lambda function. + Lambda *LambdaAction + + // Publish to another MQTT topic. + Republish *RepublishAction + + // Write to an Amazon S3 bucket. + S3 *S3Action // Send a message to a Salesforce IoT Cloud Input Stream. Salesforce *SalesforceAction - // Write to a DynamoDB table. - DynamoDB *DynamoDBAction + // Publish to an Amazon SNS topic. + Sns *SnsAction - // Sends message data to an AWS IoT Analytics channel. - IotAnalytics *IotAnalyticsAction + // Publish to an Amazon SQS queue. + Sqs *SqsAction + + // Starts execution of a Step Functions state machine. + StepFunctions *StepFunctionsAction } // Information about an active Device Defender security profile behavior violation. type ActiveViolation struct { - // The name of the thing responsible for the active violation. - ThingName *string - - // The time the violation started. - ViolationStartTime *time.Time - // The behavior which is being violated. Behavior *Behavior - // The ID of the active violation. - ViolationId *string - - // The security profile whose behavior is in violation. - SecurityProfileName *string + // The time the most recent violation occurred. + LastViolationTime *time.Time // The value of the metric (the measurement) which caused the most recent // violation. LastViolationValue *MetricValue - // The time the most recent violation occurred. - LastViolationTime *time.Time + // The security profile whose behavior is in violation. + SecurityProfileName *string + + // The name of the thing responsible for the active violation. + ThingName *string + + // The ID of the active violation. + ViolationId *string + + // The time the violation started. + ViolationStartTime *time.Time } // Parameters used when defining a mitigation action that move a set of things to a // thing group. type AddThingsToThingGroupParams struct { - // Specifies if this mitigation action can move the things that triggered the - // mitigation action even if they are part of one or more dynamic things groups. - OverrideDynamicGroups *bool - // The list of groups to which you want to add the things that triggered the // mitigation action. You can add a thing to a maximum of 10 groups, but you cannot // add a thing to more than one group in the same hierarchy. // // This member is required. ThingGroupNames []*string + + // Specifies if this mitigation action can move the things that triggered the + // mitigation action even if they are part of one or more dynamic things groups. + OverrideDynamicGroups *bool } // A structure containing the alert target ARN and the role ARN. @@ -187,10 +187,6 @@ type AssetPropertyTimestamp struct { // An asset property value entry containing the following information. type AssetPropertyValue struct { - // Optional. A string that describes the quality of the value. Accepts substitution - // templates. Must be GOOD, BAD, or UNCERTAIN. - Quality *string - // The asset property value timestamp. // // This member is required. @@ -200,25 +196,29 @@ type AssetPropertyValue struct { // // This member is required. Value *AssetPropertyVariant + + // Optional. A string that describes the quality of the value. Accepts substitution + // templates. Must be GOOD, BAD, or UNCERTAIN. + Quality *string } // Contains an asset property value (of a single type). type AssetPropertyVariant struct { - // Optional. The string value of the value entry. Accepts substitution templates. - StringValue *string - - // Optional. A string that contains the integer value of the value entry. Accepts - // substitution templates. - IntegerValue *string + // Optional. A string that contains the boolean value (true or false) of the value + // entry. Accepts substitution templates. + BooleanValue *string // Optional. A string that contains the double value of the value entry. Accepts // substitution templates. DoubleValue *string - // Optional. A string that contains the boolean value (true or false) of the value - // entry. Accepts substitution templates. - BooleanValue *string + // Optional. A string that contains the integer value of the value entry. Accepts + // substitution templates. + IntegerValue *string + + // Optional. The string value of the value entry. Accepts substitution templates. + StringValue *string } // The attribute payload. @@ -245,25 +245,25 @@ type AuditCheckConfiguration struct { // Information about the audit check. type AuditCheckDetails struct { - // The number of resources that were found noncompliant during the check. - NonCompliantResourcesCount *int64 - - // The message associated with any error encountered when this check is performed - // during this audit. - Message *string - // True if the check is complete and found all resources compliant. CheckCompliant *bool - // The code of any error encountered when this check is performed during this - // audit. One of "INSUFFICIENT_PERMISSIONS" or "AUDIT_CHECK_DISABLED". - ErrorCode *string - // The completion status of this check. One of "IN_PROGRESS", // "WAITING_FOR_DATA_COLLECTION", "CANCELED", "COMPLETED_COMPLIANT", // "COMPLETED_NON_COMPLIANT", or "FAILED". CheckRunStatus AuditCheckRunStatus + // The code of any error encountered when this check is performed during this + // audit. One of "INSUFFICIENT_PERMISSIONS" or "AUDIT_CHECK_DISABLED". + ErrorCode *string + + // The message associated with any error encountered when this check is performed + // during this audit. + Message *string + + // The number of resources that were found noncompliant during the check. + NonCompliantResourcesCount *int64 + // The number of resources on which the check was performed. TotalResourcesCount *int64 } @@ -274,51 +274,55 @@ type AuditFinding struct { // The audit check that generated this result. CheckName *string - // The time the audit started. - TaskStartTime *time.Time + // A unique identifier for this set of audit findings. This identifier is used to + // apply mitigation tasks to one or more sets of findings. + FindingId *string - // The list of related resources. - RelatedResources []*RelatedResource + // The time the result (finding) was discovered. + FindingTime *time.Time + + // The resource that was found to be noncompliant with the audit check. + NonCompliantResource *NonCompliantResource // The reason the resource was noncompliant. ReasonForNonCompliance *string - // The severity of the result (finding). - Severity AuditFindingSeverity - - // The time the result (finding) was discovered. - FindingTime *time.Time - // A code that indicates the reason that the resource was noncompliant. ReasonForNonComplianceCode *string + // The list of related resources. + RelatedResources []*RelatedResource + + // The severity of the result (finding). + Severity AuditFindingSeverity + // The ID of the audit that generated this result (finding). TaskId *string - // A unique identifier for this set of audit findings. This identifier is used to - // apply mitigation tasks to one or more sets of findings. - FindingId *string - - // The resource that was found to be noncompliant with the audit check. - NonCompliantResource *NonCompliantResource + // The time the audit started. + TaskStartTime *time.Time } // Returned by ListAuditMitigationActionsTask, this object contains information // that describes a mitigation action that has been started. type AuditMitigationActionExecutionMetadata struct { - // The unique identifier for the findings to which the task and associated - // mitigation action are applied. - FindingId *string - // The unique identifier for the mitigation action being applied by the task. ActionId *string + // The friendly name of the mitigation action being applied by the task. + ActionName *string + + // The date and time when the task was completed or canceled. Blank if the task is + // still running. + EndTime *time.Time + // If an error occurred, the code that indicates which type of error occurred. ErrorCode *string - // The current status of the task being executed. - Status AuditMitigationActionsExecutionStatus + // The unique identifier for the findings to which the task and associated + // mitigation action are applied. + FindingId *string // If an error occurred, a message that describes the error. Message *string @@ -326,27 +330,23 @@ type AuditMitigationActionExecutionMetadata struct { // The date and time when the task was started. StartTime *time.Time + // The current status of the task being executed. + Status AuditMitigationActionsExecutionStatus + // The unique identifier for the task that applies the mitigation action. TaskId *string - - // The friendly name of the mitigation action being applied by the task. - ActionName *string - - // The date and time when the task was completed or canceled. Blank if the task is - // still running. - EndTime *time.Time } // Information about an audit mitigation actions task that is returned by // ListAuditMitigationActionsTasks. type AuditMitigationActionsTaskMetadata struct { - // The unique identifier for the task. - TaskId *string - // The time at which the audit mitigation actions task was started. StartTime *time.Time + // The unique identifier for the task. + TaskId *string + // The current state of the audit mitigation actions task. TaskStatus AuditMitigationActionsTaskStatus } @@ -355,10 +355,6 @@ type AuditMitigationActionsTaskMetadata struct { // to which the mitigation actions are applied. Only one entry appears. type AuditMitigationActionsTaskTarget struct { - // If the task will apply a mitigation action to one or more listed findings, this - // value uniquely identifies those findings. - FindingIds []*string - // Specifies a filter in the form of an audit check and set of reason codes that // identify the findings from the audit to which the audit mitigation actions task // apply. @@ -367,31 +363,35 @@ type AuditMitigationActionsTaskTarget struct { // If the task will apply a mitigation action to findings from a specific audit, // this value uniquely identifies the audit. AuditTaskId *string + + // If the task will apply a mitigation action to one or more listed findings, this + // value uniquely identifies those findings. + FindingIds []*string } // Information about the targets to which audit notifications are sent. type AuditNotificationTarget struct { + // True if notifications to the target are enabled. + Enabled *bool + // The ARN of the role that grants permission to send notifications to the target. RoleArn *string // The ARN of the target (SNS topic) to which audit notifications are sent. TargetArn *string - - // True if notifications to the target are enabled. - Enabled *bool } // The audits that were performed. type AuditTaskMetadata struct { + // The ID of this audit. + TaskId *string + // The status of this audit. One of "IN_PROGRESS", "COMPLETED", "FAILED", or // "CANCELED". TaskStatus AuditTaskStatus - // The ID of this audit. - TaskId *string - // The type of this audit. One of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK". TaskType AuditTaskType } @@ -399,58 +399,58 @@ type AuditTaskMetadata struct { // A collection of authorization information. type AuthInfo struct { - // The type of action for which the principal is being authorized. - ActionType ActionType - // The resources for which the principal is being authorized to perform the // specified action. // // This member is required. Resources []*string + + // The type of action for which the principal is being authorized. + ActionType ActionType } // An object that specifies the authorization service for a domain. type AuthorizerConfig struct { - // The name of the authorization service for a domain configuration. - DefaultAuthorizerName *string - // A Boolean that specifies whether the domain configuration's authorization // service can be overridden. AllowAuthorizerOverride *bool + + // The name of the authorization service for a domain configuration. + DefaultAuthorizerName *string } // The authorizer description. type AuthorizerDescription struct { - // The status of the authorizer. - Status AuthorizerStatus - // The authorizer ARN. AuthorizerArn *string - // The UNIX timestamp of when the authorizer was last updated. - LastModifiedDate *time.Time - // The authorizer's Lambda function ARN. AuthorizerFunctionArn *string // The authorizer name. AuthorizerName *string - // The public keys used to validate the token signature returned by your custom - // authentication service. - TokenSigningPublicKeys map[string]*string - // The UNIX timestamp of when the authorizer was created. CreationDate *time.Time - // The key used to extract the token from the HTTP headers. - TokenKeyName *string + // The UNIX timestamp of when the authorizer was last updated. + LastModifiedDate *time.Time // Specifies whether AWS IoT validates the token signature in an authorization // request. SigningDisabled *bool + + // The status of the authorizer. + Status AuthorizerStatus + + // The key used to extract the token from the HTTP headers. + TokenKeyName *string + + // The public keys used to validate the token signature returned by your custom + // authentication service. + TokenSigningPublicKeys map[string]*string } // The authorizer summary. @@ -466,8 +466,8 @@ type AuthorizerSummary struct { // The authorizer result. type AuthResult struct { - // The policies and statements that denied the specified action. - Denied *Denied + // The policies and statements that allowed the specified action. + Allowed *Allowed // The final authorization decision of this scenario. Multiple statements are taken // into account when determining the authorization decision. An explicit deny @@ -477,11 +477,11 @@ type AuthResult struct { // Authorization information. AuthInfo *AuthInfo + // The policies and statements that denied the specified action. + Denied *Denied + // Contains any missing context values found while evaluating policy. MissingContextValues []*string - - // The policies and statements that allowed the specified action. - Allowed *Allowed } // The criteria that determine when and how a job abort takes place. @@ -506,40 +506,40 @@ type AwsJobAbortCriteria struct { // This member is required. FailureType AwsJobAbortCriteriaFailureType + // The minimum number of things which must receive job execution notifications + // before the job can be aborted. + // + // This member is required. + MinNumberOfExecutedThings *int32 + // The minimum percentage of job execution failures that must occur to initiate the // job abort. AWS IoT supports up to two digits after the decimal (for example, // 10.9 and 10.99, but not 10.999). // // This member is required. ThresholdPercentage *float64 - - // The minimum number of things which must receive job execution notifications - // before the job can be aborted. - // - // This member is required. - MinNumberOfExecutedThings *int32 } // Configuration for the rollout of OTA updates. type AwsJobExecutionsRolloutConfig struct { - // The maximum number of OTA update job executions started per minute. - MaximumPerMinute *int32 - // The rate of increase for a job rollout. This parameter allows you to define an // exponential rate increase for a job rollout. ExponentialRate *AwsJobExponentialRolloutRate + + // The maximum number of OTA update job executions started per minute. + MaximumPerMinute *int32 } // The rate of increase for a job rollout. This parameter allows you to define an // exponential rate increase for a job rollout. type AwsJobExponentialRolloutRate struct { - // The criteria to initiate the increase in rate of rollout for a job. AWS IoT - // supports up to one digit after the decimal (for example, 1.5, but not 1.55). + // The minimum number of things that will be notified of a pending job, per minute, + // at the start of the job rollout. This is the initial rate of the rollout. // // This member is required. - RateIncreaseCriteria *AwsJobRateIncreaseCriteria + BaseRatePerMinute *int32 // The rate of increase for a job rollout. The number of things notified is // multiplied by this factor. @@ -547,11 +547,11 @@ type AwsJobExponentialRolloutRate struct { // This member is required. IncrementFactor *float64 - // The minimum number of things that will be notified of a pending job, per minute, - // at the start of the job rollout. This is the initial rate of the rollout. + // The criteria to initiate the increase in rate of rollout for a job. AWS IoT + // supports up to one digit after the decimal (for example, 1.5, but not 1.55). // // This member is required. - BaseRatePerMinute *int32 + RateIncreaseCriteria *AwsJobRateIncreaseCriteria } // Configuration information for pre-signed URLs. Valid when protocols contains @@ -567,13 +567,13 @@ type AwsJobPresignedUrlConfig struct { // The criteria to initiate the increase in rate of rollout for a job. type AwsJobRateIncreaseCriteria struct { - // When this number of things have succeeded in their job execution, it will - // initiate an increase in the rollout rate. - NumberOfSucceededThings *int32 - // When this number of things have been notified, it will initiate an increase in // the rollout rate. NumberOfNotifiedThings *int32 + + // When this number of things have succeeded in their job execution, it will + // initiate an increase in the rollout rate. + NumberOfSucceededThings *int32 } // Specifies the amount of time each device has to finish its execution of the job. @@ -594,27 +594,31 @@ type AwsJobTimeoutConfig struct { // A Device Defender security profile behavior. type Behavior struct { - // The criteria that determine if a device is behaving normally in regard to the - // metric. - Criteria *BehaviorCriteria - // The name you have given to the behavior. // // This member is required. Name *string + // The criteria that determine if a device is behaving normally in regard to the + // metric. + Criteria *BehaviorCriteria + + // What is measured by the behavior. + Metric *string + // The dimension for a metric in your behavior. For example, using a TOPIC_FILTER // dimension, you can narrow down the scope of the metric only to MQTT topics whose // name match the pattern specified in the dimension. MetricDimension *MetricDimension - - // What is measured by the behavior. - Metric *string } // The criteria by which the behavior is determined to be normal. type BehaviorCriteria struct { + // The operator that relates the thing measured (metric) to the criteria + // (containing a value or statisticalThreshold). + ComparisonOperator ComparisonOperator + // If a device is in violation of the behavior for the specified number of // consecutive datapoints, an alarm occurs. If not specified, the default is 1. ConsecutiveDatapointsToAlarm *int32 @@ -632,16 +636,12 @@ type BehaviorCriteria struct { // time duration before being given a percentile rank. DurationSeconds *int32 - // The value to be compared with the metric. - Value *MetricValue - - // The operator that relates the thing measured (metric) to the criteria - // (containing a value or statisticalThreshold). - ComparisonOperator ComparisonOperator - // A statistical ranking (percentile) which indicates a threshold value by which a // behavior is determined to be in compliance or in violation of the behavior. StatisticalThreshold *StatisticalThreshold + + // The value to be compared with the metric. + Value *MetricValue } // Additional information about the billing group. @@ -661,15 +661,15 @@ type BillingGroupProperties struct { // A CA certificate. type CACertificate struct { + // The ARN of the CA certificate. + CertificateArn *string + // The ID of the CA certificate. CertificateId *string // The date the CA certificate was created. CreationDate *time.Time - // The ARN of the CA certificate. - CertificateArn *string - // The status of the CA certificate. The status value REGISTER_INACTIVE is // deprecated and should not be used. Status CACertificateStatus @@ -678,21 +678,6 @@ type CACertificate struct { // Describes a CA certificate. type CACertificateDescription struct { - // When the CA certificate is valid. - Validity *CertificateValidity - - // The status of a CA certificate. - Status CACertificateStatus - - // The date the CA certificate was created. - CreationDate *time.Time - - // The owner of the CA certificate. - OwnedBy *string - - // The customer version of the CA certificate. - CustomerVersion *int32 - // Whether the CA certificate configured for auto registration of device // certificates. Valid values are "ENABLE" and "DISABLE" AutoRegistrationStatus AutoRegistrationStatus @@ -700,17 +685,32 @@ type CACertificateDescription struct { // The CA certificate ARN. CertificateArn *string + // The CA certificate ID. + CertificateId *string + // The CA certificate data, in PEM format. CertificatePem *string - // The CA certificate ID. - CertificateId *string + // The date the CA certificate was created. + CreationDate *time.Time - // The date the CA certificate was last modified. - LastModifiedDate *time.Time + // The customer version of the CA certificate. + CustomerVersion *int32 // The generation ID of the CA certificate. GenerationId *string + + // The date the CA certificate was last modified. + LastModifiedDate *time.Time + + // The owner of the CA certificate. + OwnedBy *string + + // The status of a CA certificate. + Status CACertificateStatus + + // When the CA certificate is valid. + Validity *CertificateValidity } // Information about a certificate. @@ -719,65 +719,65 @@ type Certificate struct { // The ARN of the certificate. CertificateArn *string - // The status of the certificate. The status value REGISTER_INACTIVE is deprecated - // and should not be used. - Status CertificateStatus - - // The date and time the certificate was created. - CreationDate *time.Time - // The ID of the certificate. (The last part of the certificate ARN contains the // certificate ID.) CertificateId *string // The mode of the certificate. CertificateMode CertificateMode + + // The date and time the certificate was created. + CreationDate *time.Time + + // The status of the certificate. The status value REGISTER_INACTIVE is deprecated + // and should not be used. + Status CertificateStatus } // Describes a certificate. type CertificateDescription struct { + // The certificate ID of the CA certificate used to sign this certificate. + CaCertificateId *string + + // The ARN of the certificate. + CertificateArn *string + + // The ID of the certificate. + CertificateId *string + // The mode of the certificate. CertificateMode CertificateMode // The certificate data, in PEM format. CertificatePem *string - // The certificate ID of the CA certificate used to sign this certificate. - CaCertificateId *string - // The date and time the certificate was created. CreationDate *time.Time - // The ID of the certificate. - CertificateId *string - - // The transfer data. - TransferData *TransferData + // The customer version of the certificate. + CustomerVersion *int32 - // The ID of the AWS account of the previous owner of the certificate. - PreviousOwnedBy *string + // The generation ID of the certificate. + GenerationId *string // The date and time the certificate was last modified. LastModifiedDate *time.Time - // The generation ID of the certificate. - GenerationId *string + // The ID of the AWS account that owns the certificate. + OwnedBy *string - // The customer version of the certificate. - CustomerVersion *int32 + // The ID of the AWS account of the previous owner of the certificate. + PreviousOwnedBy *string // The status of the certificate. Status CertificateStatus - // The ID of the AWS account that owns the certificate. - OwnedBy *string + // The transfer data. + TransferData *TransferData // When the certificate is valid. Validity *CertificateValidity - - // The ARN of the certificate. - CertificateArn *string } // When the certificate is valid. @@ -818,20 +818,25 @@ type CloudwatchAlarmAction struct { // Describes an action that sends data to CloudWatch Logs. type CloudwatchLogsAction struct { - // The IAM role that allows access to the CloudWatch log. + // The CloudWatch log group to which the action sends data. // // This member is required. - RoleArn *string + LogGroupName *string - // The CloudWatch log group to which the action sends data. + // The IAM role that allows access to the CloudWatch log. // // This member is required. - LogGroupName *string + RoleArn *string } // Describes an action that captures a CloudWatch metric. type CloudwatchMetricAction struct { + // The CloudWatch metric name. + // + // This member is required. + MetricName *string + // The CloudWatch metric namespace name. // // This member is required. @@ -844,10 +849,10 @@ type CloudwatchMetricAction struct { // This member is required. MetricUnit *string - // The CloudWatch metric name. + // The CloudWatch metric value. // // This member is required. - MetricName *string + MetricValue *string // The IAM role that allows access to the CloudWatch metric. // @@ -857,24 +862,19 @@ type CloudwatchMetricAction struct { // An optional Unix timestamp // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp). MetricTimestamp *string - - // The CloudWatch metric value. - // - // This member is required. - MetricValue *string } // Describes the method to use when code signing a file. type CodeSigning struct { + // The ID of the AWSSignerJob which was created to sign the file. + AwsSignerJobId *string + // A custom method for code signing a file. CustomCodeSigning *CustomCodeSigning // Describes the code-signing job. StartSigningJobParameter *StartSigningJobParameter - - // The ID of the AWSSignerJob which was created to sign the file. - AwsSignerJobId *string } // Describes the certificate chain being used when code signing a file. @@ -904,9 +904,6 @@ type Configuration struct { // Describes a custom method used to code sign a file. type CustomCodeSigning struct { - // The signature algorithm used to code sign the file. - SignatureAlgorithm *string - // The certificate chain. CertificateChain *CodeSigningCertificateChain @@ -915,6 +912,9 @@ type CustomCodeSigning struct { // The signature for the file. Signature *CodeSigningSignature + + // The signature algorithm used to code sign the file. + SignatureAlgorithm *string } // Contains information that denied the authorization. @@ -952,14 +952,14 @@ type Destination struct { // configuration feature is in public preview and is subject to change. type DomainConfigurationSummary struct { - // The type of service delivered by the endpoint. - ServiceType ServiceType + // The ARN of the domain configuration. + DomainConfigurationArn *string // The name of the domain configuration. This value must be unique to a region. DomainConfigurationName *string - // The ARN of the domain configuration. - DomainConfigurationArn *string + // The type of service delivered by the endpoint. + ServiceType ServiceType } // Describes an action to write to a DynamoDB table. The tableName, hashKeyField, @@ -973,27 +973,21 @@ type DomainConfigurationSummary struct { // "${timestamp()}" type DynamoDBAction struct { + // The hash key name. + // + // This member is required. + HashKeyField *string + // The hash key value. // // This member is required. HashKeyValue *string - // The range key name. - RangeKeyField *string - - // The type of operation to be performed. This follows the substitution template, - // so it can be ${operation}, but the substitution must result in one of the - // following: INSERT, UPDATE, or DELETE. - Operation *string - // The ARN of the IAM role that grants access to the DynamoDB table. // // This member is required. RoleArn *string - // The action payload. This name can be customized. - PayloadField *string - // The name of the DynamoDB table. // // This member is required. @@ -1002,16 +996,22 @@ type DynamoDBAction struct { // The hash key type. Valid values are "STRING" or "NUMBER" HashKeyType DynamoKeyType - // The hash key name. - // - // This member is required. - HashKeyField *string + // The type of operation to be performed. This follows the substitution template, + // so it can be ${operation}, but the substitution must result in one of the + // following: INSERT, UPDATE, or DELETE. + Operation *string - // The range key value. - RangeKeyValue *string + // The action payload. This name can be customized. + PayloadField *string + + // The range key name. + RangeKeyField *string // The range key type. Valid values are "STRING" or "NUMBER" RangeKeyType DynamoKeyType + + // The range key value. + RangeKeyValue *string } // Describes an action to write to a DynamoDB table. This DynamoDB action writes @@ -1036,24 +1036,19 @@ type DynamoDBv2Action struct { // The policy that has the effect on the authorization results. type EffectivePolicy struct { - // The policy name. - PolicyName *string - // The policy ARN. PolicyArn *string // The IAM policy document. PolicyDocument *string + + // The policy name. + PolicyName *string } // Describes an action that writes data to an Amazon Elasticsearch Service domain. type ElasticsearchAction struct { - // The Elasticsearch index where you want to store your data. - // - // This member is required. - Index *string - // The endpoint of your Elasticsearch domain. // // This member is required. @@ -1064,29 +1059,34 @@ type ElasticsearchAction struct { // This member is required. Id *string - // The type of document you are storing. + // The Elasticsearch index where you want to store your data. // // This member is required. - Type *string + Index *string // The IAM role ARN that has access to Elasticsearch. // // This member is required. RoleArn *string + + // The type of document you are storing. + // + // This member is required. + Type *string } // Parameters used when defining a mitigation action that enable AWS IoT logging. type EnableIoTLoggingParams struct { - // The ARN of the IAM role used for logging. + // Specifies the types of information to be logged. // // This member is required. - RoleArnForLogging *string + LogLevel LogLevel - // Specifies the types of information to be logged. + // The ARN of the IAM role used for logging. // // This member is required. - LogLevel LogLevel + RoleArnForLogging *string } // Error information. @@ -1109,12 +1109,6 @@ type ExplicitDeny struct { // Allows you to create an exponential rate of rollout for a job. type ExponentialRolloutRate struct { - // The criteria to initiate the increase in rate of rollout for a job. AWS IoT - // supports up to one digit after the decimal (for example, 1.5, but not 1.55). - // - // This member is required. - RateIncreaseCriteria *RateIncreaseCriteria - // The minimum number of things that will be notified of a pending job, per minute // at the start of job rollout. This parameter allows you to define the initial // rate of rollout. @@ -1126,16 +1120,22 @@ type ExponentialRolloutRate struct { // // This member is required. IncrementFactor *float64 + + // The criteria to initiate the increase in rate of rollout for a job. AWS IoT + // supports up to one digit after the decimal (for example, 1.5, but not 1.55). + // + // This member is required. + RateIncreaseCriteria *RateIncreaseCriteria } // Describes the name and data type at a field. type Field struct { - // The datatype of the field. - Type FieldType - // The name of the field. Name *string + + // The datatype of the field. + Type FieldType } // The location of the OTA update. @@ -1151,6 +1151,11 @@ type FileLocation struct { // Describes an action that writes data to an Amazon Kinesis Firehose stream. type FirehoseAction struct { + // The delivery stream name. + // + // This member is required. + DeliveryStreamName *string + // The IAM role that grants access to the Amazon Kinesis Firehose stream. // // This member is required. @@ -1160,11 +1165,6 @@ type FirehoseAction struct { // Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows // newline), ',' (comma). Separator *string - - // The delivery stream name. - // - // This member is required. - DeliveryStreamName *string } // The name and ARN of a group. @@ -1180,9 +1180,6 @@ type GroupNameAndArn struct { // Send data to an HTTPS endpoint. type HttpAction struct { - // The HTTP headers to send with the message data. - Headers []*HttpActionHeader - // The endpoint URL. If substitution templates are used in the URL, you must also // specify a confirmationUrl. If this is a new destination, a new // TopicRuleDestination is created if possible. @@ -1200,20 +1197,23 @@ type HttpAction struct { // topic rule destinations that match each possible value of the substitution // template before traffic is allowed to your endpoint URL. ConfirmationUrl *string + + // The HTTP headers to send with the message data. + Headers []*HttpActionHeader } // The HTTP action header. type HttpActionHeader struct { - // The HTTP header value. Substitution templates are supported. + // The HTTP header key. // // This member is required. - Value *string + Key *string - // The HTTP header key. + // The HTTP header value. Substitution templates are supported. // // This member is required. - Key *string + Value *string } // The authorization method used to send messages. @@ -1272,21 +1272,26 @@ type ImplicitDeny struct { // Sends message data to an AWS IoT Analytics channel. type IotAnalyticsAction struct { + // (deprecated) The ARN of the IoT Analytics channel to which message data will be + // sent. + ChannelArn *string + // The name of the IoT Analytics channel to which message data will be sent. ChannelName *string // The ARN of the role which has a policy that grants IoT Analytics permission to // send message data via IoT Analytics (iotanalytics:BatchPutMessage). RoleArn *string - - // (deprecated) The ARN of the IoT Analytics channel to which message data will be - // sent. - ChannelArn *string } // Sends an input to an AWS IoT Events detector. type IotEventsAction struct { + // The name of the AWS IoT Events input. + // + // This member is required. + InputName *string + // The ARN of the role that grants AWS IoT permission to send an input to an AWS // IoT Events detector. ("Action":"iotevents:BatchPutMessage"). // @@ -1296,50 +1301,71 @@ type IotEventsAction struct { // [Optional] Use this to ensure that only one input (message) with a given // messageId will be processed by an AWS IoT Events detector. MessageId *string - - // The name of the AWS IoT Events input. - // - // This member is required. - InputName *string } // Describes an action to send data from an MQTT message that triggered the rule to // AWS IoT SiteWise asset properties. type IotSiteWiseAction struct { + // A list of asset property value entries. + // + // This member is required. + PutAssetPropertyValueEntries []*PutAssetPropertyValueEntry + // The ARN of the role that grants AWS IoT permission to send an asset property // value to AWS IoTSiteWise. ("Action": "iotsitewise:BatchPutAssetPropertyValue"). // The trust policy can restrict access to specific asset hierarchy paths. // // This member is required. RoleArn *string - - // A list of asset property value entries. - // - // This member is required. - PutAssetPropertyValueEntries []*PutAssetPropertyValueEntry } // The Job object contains details about a job. type Job struct { - // Configuration for pre-signed S3 URLs. - PresignedUrlConfig *PresignedUrlConfig + // Configuration for criteria to abort the job. + AbortConfig *AbortConfig + + // If the job was updated, describes the reason for the update. + Comment *string + + // The time, in seconds since the epoch, when the job was completed. + CompletedAt *time.Time + + // The time, in seconds since the epoch, when the job was created. + CreatedAt *time.Time + + // A short text description of the job. + Description *string + + // Will be true if the job was canceled with the optional force parameter set to + // true. + ForceCanceled *bool + + // An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId". + JobArn *string // Allows you to create a staged rollout of a job. JobExecutionsRolloutConfig *JobExecutionsRolloutConfig - // If the job was updated, provides the reason code for the update. - ReasonCode *string - - // A list of IoT things and thing groups to which the job should be sent. - Targets []*string + // The unique identifier you assigned to this job when it was created. + JobId *string // Details about the job process. JobProcessDetails *JobProcessDetails - // A short text description of the job. - Description *string + // The time, in seconds since the epoch, when the job was last updated. + LastUpdatedAt *time.Time + + // Configuration for pre-signed S3 URLs. + PresignedUrlConfig *PresignedUrlConfig + + // If the job was updated, provides the reason code for the update. + ReasonCode *string + + // The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or + // COMPLETED. + Status JobStatus // Specifies whether the job will continue to run (CONTINUOUS), or will be complete // after all those things specified as targets have completed the job (SNAPSHOT). @@ -1349,49 +1375,35 @@ type Job struct { // things originally in the group. TargetSelection TargetSelection - // If the job was updated, describes the reason for the update. - Comment *string - - // The time, in seconds since the epoch, when the job was last updated. - LastUpdatedAt *time.Time - - // An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId". - JobArn *string + // A list of IoT things and thing groups to which the job should be sent. + Targets []*string // Specifies the amount of time each device has to finish its execution of the job. // A timer is started when the job execution status is set to IN_PROGRESS. If the // job execution status is not set to another terminal state before the timer // expires, it will be automatically set to TIMED_OUT. TimeoutConfig *TimeoutConfig - - // The time, in seconds since the epoch, when the job was created. - CreatedAt *time.Time - - // The time, in seconds since the epoch, when the job was completed. - CompletedAt *time.Time - - // The unique identifier you assigned to this job when it was created. - JobId *string - - // Will be true if the job was canceled with the optional force parameter set to - // true. - ForceCanceled *bool - - // The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or - // COMPLETED. - Status JobStatus - - // Configuration for criteria to abort the job. - AbortConfig *AbortConfig } // The job execution object represents the execution of a job on a particular // device. type JobExecution struct { - // The version of the job execution. Job execution versions are incremented each - // time they are updated by a device. - VersionNumber *int64 + // The estimated number of seconds that remain before the job execution status will + // be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute + // and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up + // to 60 seconds later than the estimated duration. This value will not be included + // if the job execution has reached a terminal status. + ApproximateSecondsBeforeTimedOut *int64 + + // A string (consisting of the digits "0" through "9") which identifies this + // particular job execution on this particular device. It can be used in commands + // which return or update job execution information. + ExecutionNumber *int64 + + // Will be true if the job execution was canceled with the optional force parameter + // set to true. + ForceCanceled *bool // The unique identifier you assigned to the job when it was created. JobId *string @@ -1399,37 +1411,25 @@ type JobExecution struct { // The time, in seconds since the epoch, when the job execution was last updated. LastUpdatedAt *time.Time - // Will be true if the job execution was canceled with the optional force parameter - // set to true. - ForceCanceled *bool - - // A collection of name/value pairs that describe the status of the job execution. - StatusDetails *JobExecutionStatusDetails + // The time, in seconds since the epoch, when the job execution was queued. + QueuedAt *time.Time // The time, in seconds since the epoch, when the job execution started. StartedAt *time.Time - // A string (consisting of the digits "0" through "9") which identifies this - // particular job execution on this particular device. It can be used in commands - // which return or update job execution information. - ExecutionNumber *int64 - - // The ARN of the thing on which the job execution is running. - ThingArn *string - // The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, // TIMED_OUT, CANCELED, or REJECTED). Status JobExecutionStatus - // The estimated number of seconds that remain before the job execution status will - // be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute - // and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up - // to 60 seconds later than the estimated duration. This value will not be included - // if the job execution has reached a terminal status. - ApproximateSecondsBeforeTimedOut *int64 + // A collection of name/value pairs that describe the status of the job execution. + StatusDetails *JobExecutionStatusDetails - // The time, in seconds since the epoch, when the job execution was queued. - QueuedAt *time.Time + // The ARN of the thing on which the job execution is running. + ThingArn *string + + // The version of the job execution. Job execution versions are incremented each + // time they are updated by a device. + VersionNumber *int64 } // Allows you to create a staged rollout of a job. @@ -1454,17 +1454,17 @@ type JobExecutionStatusDetails struct { // The job execution summary. type JobExecutionSummary struct { - // The time, in seconds since the epoch, when the job execution was queued. - QueuedAt *time.Time - - // The time, in seconds since the epoch, when the job execution was last updated. - LastUpdatedAt *time.Time - // A string (consisting of the digits "0" through "9") which identifies this // particular job execution on this particular device. It can be used later in // commands which return or update job execution information. ExecutionNumber *int64 + // The time, in seconds since the epoch, when the job execution was last updated. + LastUpdatedAt *time.Time + + // The time, in seconds since the epoch, when the job execution was queued. + QueuedAt *time.Time + // The time, in seconds since the epoch, when the job execution started. StartedAt *time.Time @@ -1475,31 +1475,31 @@ type JobExecutionSummary struct { // Contains a summary of information about job executions for a specific job. type JobExecutionSummaryForJob struct { - // The ARN of the thing on which the job execution is running. - ThingArn *string - // Contains a subset of information about a job execution. JobExecutionSummary *JobExecutionSummary + + // The ARN of the thing on which the job execution is running. + ThingArn *string } // The job execution summary for a thing. type JobExecutionSummaryForThing struct { - // The unique identifier you assigned to this job when it was created. - JobId *string - // Contains a subset of information about a job execution. JobExecutionSummary *JobExecutionSummary + + // The unique identifier you assigned to this job when it was created. + JobId *string } // The job process details. type JobProcessDetails struct { - // The number of things that rejected the job. - NumberOfRejectedThings *int32 + // The number of things that cancelled the job. + NumberOfCanceledThings *int32 - // The number of things whose job execution status is TIMED_OUT. - NumberOfTimedOutThings *int32 + // The number of things that failed executing the job. + NumberOfFailedThings *int32 // The number of things currently executing the job. NumberOfInProgressThings *int32 @@ -1507,29 +1507,47 @@ type JobProcessDetails struct { // The number of things that are awaiting execution of the job. NumberOfQueuedThings *int32 - // The target devices to which the job execution is being rolled out. This value - // will be null after the job execution has finished rolling out to all the target - // devices. - ProcessingTargets []*string + // The number of things that rejected the job. + NumberOfRejectedThings *int32 // The number of things that are no longer scheduled to execute the job because // they have been deleted or have been removed from the group that was a target of // the job. NumberOfRemovedThings *int32 - // The number of things that failed executing the job. - NumberOfFailedThings *int32 - // The number of things which successfully completed the job. NumberOfSucceededThings *int32 - // The number of things that cancelled the job. - NumberOfCanceledThings *int32 + // The number of things whose job execution status is TIMED_OUT. + NumberOfTimedOutThings *int32 + + // The target devices to which the job execution is being rolled out. This value + // will be null after the job execution has finished rolling out to all the target + // devices. + ProcessingTargets []*string } // The job summary. type JobSummary struct { + // The time, in seconds since the epoch, when the job completed. + CompletedAt *time.Time + + // The time, in seconds since the epoch, when the job was created. + CreatedAt *time.Time + + // The job ARN. + JobArn *string + + // The unique identifier you assigned to this job when it was created. + JobId *string + + // The time, in seconds since the epoch, when the job was last updated. + LastUpdatedAt *time.Time + + // The job summary status. + Status JobStatus + // Specifies whether the job will continue to run (CONTINUOUS), or will be complete // after all those things specified as targets have completed the job (SNAPSHOT). // If continuous, the job may also be run on a thing when a change is detected in a @@ -1538,26 +1556,8 @@ type JobSummary struct { // group. TargetSelection TargetSelection - // The time, in seconds since the epoch, when the job was last updated. - LastUpdatedAt *time.Time - - // The job summary status. - Status JobStatus - // The ID of the thing group. ThingGroupId *string - - // The unique identifier you assigned to this job when it was created. - JobId *string - - // The time, in seconds since the epoch, when the job was created. - CreatedAt *time.Time - - // The job ARN. - JobArn *string - - // The time, in seconds since the epoch, when the job completed. - CompletedAt *time.Time } // Describes a key pair. @@ -1573,15 +1573,15 @@ type KeyPair struct { // Describes an action to write data to an Amazon Kinesis stream. type KinesisAction struct { - // The name of the Amazon Kinesis stream. + // The ARN of the IAM role that grants access to the Amazon Kinesis stream. // // This member is required. - StreamName *string + RoleArn *string - // The ARN of the IAM role that grants access to the Amazon Kinesis stream. + // The name of the Amazon Kinesis stream. // // This member is required. - RoleArn *string + StreamName *string // The partition key. PartitionKey *string @@ -1611,13 +1611,13 @@ type LoggingOptionsPayload struct { // A log target. type LogTarget struct { - // The target name. - TargetName *string - // The target type. // // This member is required. TargetType LogTargetType + + // The target name. + TargetName *string } // The target configuration. @@ -1633,17 +1633,17 @@ type LogTargetConfiguration struct { // The dimension of a metric. type MetricDimension struct { + // A unique identifier for the dimension. + // + // This member is required. + DimensionName *string + // Defines how the dimensionValues of a dimension are interpreted. For example, for // dimension type TOPIC_FILTER, the IN operator, a message will be counted only if // its topic matches one of the topic filters. With NOT_IN operator, a message will // be counted only if it doesn't match any of the topic filters. The operator is // optional: if it's not provided (is null), it will be interpreted as IN. Operator DimensionValueOperator - - // A unique identifier for the dimension. - // - // This member is required. - DimensionName *string } // The metric you want to retain. Dimensions are optional. @@ -1661,10 +1661,6 @@ type MetricToRetain struct { // The value to be compared with the metric. type MetricValue struct { - // If the comparisonOperator calls for a set of ports, use this to specify that set - // to be compared with the metric. - Ports []*int32 - // If the comparisonOperator calls for a set of CIDRs, use this to specify that set // to be compared with the metric. Cidrs []*string @@ -1672,6 +1668,10 @@ type MetricValue struct { // If the comparisonOperator calls for a numeric value, use this to specify that // numeric value to be compared with the metric. Count *int64 + + // If the comparisonOperator calls for a set of ports, use this to specify that set + // to be compared with the metric. + Ports []*int32 } // Describes which changes should be applied as part of a mitigation action. @@ -1684,23 +1684,23 @@ type MitigationAction struct { // A unique identifier for the mitigation action. Id *string - // The IAM role ARN used to apply this mitigation action. - RoleArn *string - // A user-friendly name for the mitigation action. Name *string + + // The IAM role ARN used to apply this mitigation action. + RoleArn *string } // Information that identifies a mitigation action. This information is returned by // ListMitigationActions. type MitigationActionIdentifier struct { - // The friendly name of the mitigation action. - ActionName *string - // The IAM role ARN used to apply this mitigation action. ActionArn *string + // The friendly name of the mitigation action. + ActionName *string + // The date when this mitigation action was created. CreationDate *time.Time } @@ -1714,10 +1714,6 @@ type MitigationActionParams struct { // certificate to one or more specified thing groups, typically for quarantine. AddThingsToThingGroupParams *AddThingsToThingGroupParams - // Parameters to define a mitigation action that changes the state of the device - // certificate to inactive. - UpdateDeviceCertificateParams *UpdateDeviceCertificateParams - // Parameters to define a mitigation action that enables AWS IoT logging at a // specified level of detail. EnableIoTLoggingParams *EnableIoTLoggingParams @@ -1727,26 +1723,30 @@ type MitigationActionParams struct { // messages. PublishFindingToSnsParams *PublishFindingToSnsParams + // Parameters to define a mitigation action that adds a blank policy to restrict + // permissions. + ReplaceDefaultPolicyVersionParams *ReplaceDefaultPolicyVersionParams + // Parameters to define a mitigation action that changes the state of the CA // certificate to inactive. UpdateCACertificateParams *UpdateCACertificateParams - // Parameters to define a mitigation action that adds a blank policy to restrict - // permissions. - ReplaceDefaultPolicyVersionParams *ReplaceDefaultPolicyVersionParams + // Parameters to define a mitigation action that changes the state of the device + // certificate to inactive. + UpdateDeviceCertificateParams *UpdateDeviceCertificateParams } // Specifies the MQTT context to use for the test authorizer request type MqttContext struct { - // The value of the username key in an MQTT authorization request. - Username *string - // The value of the clientId key in an MQTT authorization request. ClientId *string // The value of the password key in an MQTT authorization request. Password []byte + + // The value of the username key in an MQTT authorization request. + Username *string } // Information about the resource that was noncompliant with the audit check. @@ -1768,8 +1768,8 @@ type OTAUpdateFile struct { // A list of name/attribute pairs. Attributes map[string]*string - // The file version. - FileVersion *string + // The code signing method of the file. + CodeSigning *CodeSigning // The location of the updated firmware. FileLocation *FileLocation @@ -1777,61 +1777,58 @@ type OTAUpdateFile struct { // The name of the file. FileName *string - // The code signing method of the file. - CodeSigning *CodeSigning + // The file version. + FileVersion *string } // Information about an OTA update. type OTAUpdateInfo struct { + // A collection of name/value pairs + AdditionalParameters map[string]*string + + // The AWS IoT job ARN associated with the OTA update. + AwsIotJobArn *string + // The AWS IoT job ID associated with the OTA update. AwsIotJobId *string - // A list of files associated with the OTA update. - OtaUpdateFiles []*OTAUpdateFile + // Configuration for the rollout of OTA updates. + AwsJobExecutionsRolloutConfig *AwsJobExecutionsRolloutConfig + + // Configuration information for pre-signed URLs. Valid when protocols contains + // HTTP. + AwsJobPresignedUrlConfig *AwsJobPresignedUrlConfig + + // The date when the OTA update was created. + CreationDate *time.Time // A description of the OTA update. Description *string - // The OTA update ARN. - OtaUpdateArn *string + // Error information associated with the OTA update. + ErrorInfo *ErrorInfo // The date when the OTA update was last updated. LastModifiedDate *time.Time - // A collection of name/value pairs - AdditionalParameters map[string]*string - - // Error information associated with the OTA update. - ErrorInfo *ErrorInfo + // The OTA update ARN. + OtaUpdateArn *string - // Configuration for the rollout of OTA updates. - AwsJobExecutionsRolloutConfig *AwsJobExecutionsRolloutConfig + // A list of files associated with the OTA update. + OtaUpdateFiles []*OTAUpdateFile - // The AWS IoT job ARN associated with the OTA update. - AwsIotJobArn *string + // The OTA update ID. + OtaUpdateId *string // The status of the OTA update. OtaUpdateStatus OTAUpdateStatus - // Configuration information for pre-signed URLs. Valid when protocols contains - // HTTP. - AwsJobPresignedUrlConfig *AwsJobPresignedUrlConfig - - // The OTA update ID. - OtaUpdateId *string - // The protocol used to transfer the OTA update image. Valid values are [HTTP], // [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device // can choose the protocol. Protocols []Protocol - // The date when the OTA update was created. - CreationDate *time.Time - - // The targets of the OTA update. - Targets []*string - // Specifies whether the OTA update will continue to run (CONTINUOUS), or will be // complete after all those things specified as targets have completed the OTA // update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when @@ -1839,17 +1836,20 @@ type OTAUpdateInfo struct { // when the thing is added to a target group, even after the OTA update was // completed by all things originally in the group. TargetSelection TargetSelection + + // The targets of the OTA update. + Targets []*string } // An OTA update summary. type OTAUpdateSummary struct { - // The OTA update ARN. - OtaUpdateArn *string - // The date when the OTA update was created. CreationDate *time.Time + // The OTA update ARN. + OtaUpdateArn *string + // The OTA update ID. OtaUpdateId *string } @@ -1863,9 +1863,6 @@ type OutgoingCertificate struct { // The certificate ID. CertificateId *string - // The AWS account to which the transfer was made. - TransferredTo *string - // The certificate creation date. CreationDate *time.Time @@ -1874,6 +1871,9 @@ type OutgoingCertificate struct { // The transfer message. TransferMessage *string + + // The AWS account to which the transfer was made. + TransferredTo *string } // Describes the percentile and percentile value. @@ -1889,11 +1889,11 @@ type PercentPair struct { // Describes an AWS IoT policy. type Policy struct { - // The policy name. - PolicyName *string - // The policy ARN. PolicyArn *string + + // The policy name. + PolicyName *string } // Describes a policy version. @@ -1936,51 +1936,51 @@ type PresignedUrlConfig struct { // Structure that contains payloadVersion and targetArn. type ProvisioningHook struct { - // The payload that was sent to the target function. Note: Only Lambda functions - // are currently supported. - PayloadVersion *string - // The ARN of the target function. Note: Only Lambda functions are currently // supported. // // This member is required. TargetArn *string + + // The payload that was sent to the target function. Note: Only Lambda functions + // are currently supported. + PayloadVersion *string } // A summary of information about a fleet provisioning template. type ProvisioningTemplateSummary struct { - // True if the fleet provision template is enabled, otherwise false. - Enabled *bool - // The date when the fleet provisioning template summary was created. CreationDate *time.Time - // The ARN of the fleet provisioning template. - TemplateArn *string - // The description of the fleet provisioning template. Description *string - // The name of the fleet provisioning template. - TemplateName *string + // True if the fleet provision template is enabled, otherwise false. + Enabled *bool // The date when the fleet provisioning template summary was last modified. LastModifiedDate *time.Time + + // The ARN of the fleet provisioning template. + TemplateArn *string + + // The name of the fleet provisioning template. + TemplateName *string } // A summary of information about a fleet provision template version. type ProvisioningTemplateVersionSummary struct { - // The ID of the fleet privisioning template version. - VersionId *int32 + // The date when the fleet provisioning template version was created + CreationDate *time.Time // True if the fleet provisioning template version is the default version, // otherwise false. IsDefaultVersion *bool - // The date when the fleet provisioning template version was created - CreationDate *time.Time + // The ID of the fleet privisioning template version. + VersionId *int32 } // Parameters to define a mitigation action that publishes findings to Amazon SNS. @@ -2003,15 +2003,15 @@ type PutAssetPropertyValueEntry struct { // This member is required. PropertyValues []*AssetPropertyValue + // The ID of the AWS IoT SiteWise asset. You must specify either a propertyAlias or + // both an aliasId and a propertyId. Accepts substitution templates. + AssetId *string + // Optional. A unique identifier for this entry that you can define to better track // which message caused an error in case of failure. Accepts substitution // templates. Defaults to a new UUID. EntryId *string - // The ID of the AWS IoT SiteWise asset. You must specify either a propertyAlias or - // both an aliasId and a propertyId. Accepts substitution templates. - AssetId *string - // The name of the property alias associated with your asset property. You must // specify either a propertyAlias or both an aliasId and a propertyId. Accepts // substitution templates. @@ -2048,22 +2048,22 @@ type RateIncreaseCriteria struct { // The registration configuration. type RegistrationConfig struct { - // The template body. - TemplateBody *string - // The ARN of the role. RoleArn *string + + // The template body. + TemplateBody *string } // Information about a related resource. type RelatedResource struct { - // Information that identifies the resource. - ResourceIdentifier *ResourceIdentifier - // Other information about the resource. AdditionalInfo map[string]*string + // Information that identifies the resource. + ResourceIdentifier *ResourceIdentifier + // The type of resource. ResourceType ResourceType } @@ -2087,49 +2087,52 @@ type RepublishAction struct { // This member is required. RoleArn *string - // The Quality of Service (QoS) level to use when republishing messages. The - // default value is 0. - Qos *int32 - // The name of the MQTT topic. // // This member is required. Topic *string + + // The Quality of Service (QoS) level to use when republishing messages. The + // default value is 0. + Qos *int32 } // Information that identifies the noncompliant resource. type ResourceIdentifier struct { - // The version of the policy associated with the resource. - PolicyVersionIdentifier *PolicyVersionIdentifier - // The account with which the resource is associated. Account *string + // The ID of the CA certificate used to authorize the certificate. + CaCertificateId *string + + // The client ID. + ClientId *string + + // The ID of the Amazon Cognito identity pool. + CognitoIdentityPoolId *string + // The ID of the certificate attached to the resource. DeviceCertificateId *string // The ARN of the IAM role that has overly permissive actions. IamRoleArn *string + // The version of the policy associated with the resource. + PolicyVersionIdentifier *PolicyVersionIdentifier + // The ARN of the role alias that has overly permissive actions. RoleAliasArn *string - - // The client ID. - ClientId *string - - // The ID of the CA certificate used to authorize the certificate. - CaCertificateId *string - - // The ID of the Amazon Cognito identity pool. - CognitoIdentityPoolId *string } // Role alias description. type RoleAliasDescription struct { - // The role ARN. - RoleArn *string + // The UNIX timestamp of when the role alias was created. + CreationDate *time.Time + + // The number of seconds for which the credential is valid. + CredentialDurationSeconds *int32 // The UNIX timestamp of when the role alias was last modified. LastModifiedDate *time.Time @@ -2140,19 +2143,21 @@ type RoleAliasDescription struct { // The role alias. RoleAlias *string - // The number of seconds for which the credential is valid. - CredentialDurationSeconds *int32 - - // The UNIX timestamp of when the role alias was created. - CreationDate *time.Time - // The ARN of the role alias. RoleAliasArn *string + + // The role ARN. + RoleArn *string } // Describes an action to write data to an Amazon S3 bucket. type S3Action struct { + // The Amazon S3 bucket. + // + // This member is required. + BucketName *string + // The object key. // // This member is required. @@ -2167,21 +2172,16 @@ type S3Action struct { // object key. For more information, see S3 canned ACLs // (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl). CannedAcl CannedAccessControlList - - // The Amazon S3 bucket. - // - // This member is required. - BucketName *string } // Describes the location of updated firmware in S3. type S3Destination struct { - // The S3 prefix. - Prefix *string - // The S3 bucket that contains the updated firmware. Bucket *string + + // The S3 prefix. + Prefix *string } // The S3 location. @@ -2190,11 +2190,11 @@ type S3Location struct { // The S3 bucket. Bucket *string - // The S3 bucket version. - Version *string - // The S3 key. Key *string + + // The S3 bucket version. + Version *string } // Describes an action to write a message to a Salesforce IoT Cloud Input Stream. @@ -2226,14 +2226,14 @@ type ScheduledAuditMetadata struct { // "WEEKLY" or "BIWEEKLY"). DayOfWeek DayOfWeek + // How often the scheduled audit occurs. + Frequency AuditFrequency + // The ARN of the scheduled audit. ScheduledAuditArn *string // The name of the scheduled audit. ScheduledAuditName *string - - // How often the scheduled audit occurs. - Frequency AuditFrequency } // Identifying information for a Device Defender security profile. @@ -2262,24 +2262,24 @@ type SecurityProfileTarget struct { // Information about a security profile and the target associated with it. type SecurityProfileTargetMapping struct { - // Information about the target (thing group) associated with the security profile. - Target *SecurityProfileTarget - // Information that identifies the security profile. SecurityProfileIdentifier *SecurityProfileIdentifier + + // Information about the target (thing group) associated with the security profile. + Target *SecurityProfileTarget } // An object that contains information about a server certificate. type ServerCertificateSummary struct { - // Details that explain the status of the server certificate. - ServerCertificateStatusDetail *string + // The ARN of the server certificate. + ServerCertificateArn *string // The status of the server certificate. ServerCertificateStatus ServerCertificateStatus - // The ARN of the server certificate. - ServerCertificateArn *string + // Details that explain the status of the server certificate. + ServerCertificateStatusDetail *string } // Describes the code-signing profile. @@ -2298,6 +2298,11 @@ type SigningProfileParameter struct { // Use Sig V4 authorization. type SigV4Authorization struct { + // The ARN of the signing role. + // + // This member is required. + RoleArn *string + // The service name to use while signing with Sig V4. // // This member is required. @@ -2307,11 +2312,6 @@ type SigV4Authorization struct { // // This member is required. SigningRegion *string - - // The ARN of the signing role. - // - // This member is required. - RoleArn *string } // Describes an action to publish to an Amazon SNS topic. @@ -2322,6 +2322,11 @@ type SnsAction struct { // This member is required. RoleArn *string + // The ARN of the SNS topic. + // + // This member is required. + TargetArn *string + // (Optional) The message format of the message to publish. Accepted values are // "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this // setting to determine if the payload should be parsed and relevant @@ -2331,16 +2336,16 @@ type SnsAction struct { // (https://docs.aws.amazon.com/sns/latest/dg/json-formats.html) refer to their // official documentation. MessageFormat MessageFormat - - // The ARN of the SNS topic. - // - // This member is required. - TargetArn *string } // Describes an action to publish data to an Amazon SQS queue. type SqsAction struct { + // The URL of the Amazon SQS queue. + // + // This member is required. + QueueUrl *string + // The ARN of the IAM role that grants access. // // This member is required. @@ -2348,24 +2353,19 @@ type SqsAction struct { // Specifies whether to use Base64 encoding. UseBase64 *bool - - // The URL of the Amazon SQS queue. - // - // This member is required. - QueueUrl *string } // Information required to start a signing job. type StartSigningJobParameter struct { - // Describes the code-signing profile. - SigningProfileParameter *SigningProfileParameter + // The location to write the code-signed file. + Destination *Destination // The code-signing profile name. SigningProfileName *string - // The location to write the code-signed file. - Destination *Destination + // Describes the code-signing profile. + SigningProfileParameter *SigningProfileParameter } // A statistical ranking (percentile) which indicates a threshold value by which a @@ -2387,12 +2387,18 @@ type StatisticalThreshold struct { // supported. type Statistics struct { - // The maximum aggregated field value. - Maximum *float64 + // The average of the aggregated field values. + Average *float64 // The count of things that match the query. Count *int32 + // The maximum aggregated field value. + Maximum *float64 + + // The minimum aggregated field value. + Minimum *float64 + // The standard deviation of the aggregated field values. StdDeviation *float64 @@ -2402,23 +2408,12 @@ type Statistics struct { // The sum of the squares of the aggregated field values. SumOfSquares *float64 - // The average of the aggregated field values. - Average *float64 - - // The minimum aggregated field value. - Minimum *float64 - // The variance of the aggregated field values. Variance *float64 } // Starts execution of a Step Functions state machine. -type StepFunctionsAction struct { - - // (Optional) A name will be given to the state machine execution consisting of - // this prefix followed by a UUID. Step Functions automatically creates a unique - // name for each state machine execution if one is not provided. - ExecutionNamePrefix *string +type StepFunctionsAction struct { // The ARN of the role that grants IoT permission to start execution of a state // machine ("Action":"states:StartExecution"). @@ -2430,6 +2425,11 @@ type StepFunctionsAction struct { // // This member is required. StateMachineName *string + + // (Optional) A name will be given to the state machine execution consisting of + // this prefix followed by a UUID. Step Functions automatically creates a unique + // name for each state machine execution if one is not provided. + ExecutionNamePrefix *string } // Describes a group of files that can be streamed. @@ -2455,26 +2455,26 @@ type StreamFile struct { // Information about a stream. type StreamInfo struct { - // The date when the stream was last updated. - LastUpdatedAt *time.Time + // The date when the stream was created. + CreatedAt *time.Time + + // The description of the stream. + Description *string // The files to stream. Files []*StreamFile - // The stream ID. - StreamId *string + // The date when the stream was last updated. + LastUpdatedAt *time.Time // An IAM role AWS IoT assumes to access your S3 files. RoleArn *string - // The date when the stream was created. - CreatedAt *time.Time - // The stream ARN. StreamArn *string - // The description of the stream. - Description *string + // The stream ID. + StreamId *string // The stream version. StreamVersion *int32 @@ -2483,15 +2483,15 @@ type StreamInfo struct { // A summary of a stream. type StreamSummary struct { - // The stream ID. - StreamId *string - // A description of the stream. Description *string // The stream ARN. StreamArn *string + // The stream ID. + StreamId *string + // The stream version. StreamVersion *int32 } @@ -2511,26 +2511,26 @@ type Tag struct { // Statistics for the checks performed during the audit. type TaskStatistics struct { - // The number of checks in this audit. - TotalChecks *int32 + // The number of checks that did not run because the audit was canceled. + CanceledChecks *int32 // The number of checks that found compliant resources. CompliantChecks *int32 - // The number of checks that found noncompliant resources. - NonCompliantChecks *int32 - // The number of checks. FailedChecks *int32 - // The number of checks waiting for data collection. - WaitingForDataCollectionChecks *int32 - // The number of checks in progress. InProgressChecks *int32 - // The number of checks that did not run because the audit was canceled. - CanceledChecks *int32 + // The number of checks that found noncompliant resources. + NonCompliantChecks *int32 + + // The number of checks in this audit. + TotalChecks *int32 + + // The number of checks waiting for data collection. + WaitingForDataCollectionChecks *int32 } // Provides summary counts of how many tasks for findings are in a particular @@ -2538,21 +2538,21 @@ type TaskStatistics struct { // DescribeAuditMitigationActionsTask. type TaskStatisticsForAuditCheck struct { - // The number of findings for which at least one of the actions failed when - // applied. - FailedFindingsCount *int64 - // The number of findings to which the mitigation action task was canceled when // applied. CanceledFindingsCount *int64 - // The number of findings for which all mitigation actions succeeded when applied. - SucceededFindingsCount *int64 + // The number of findings for which at least one of the actions failed when + // applied. + FailedFindingsCount *int64 // The number of findings skipped because of filter conditions provided in the // parameters to the command. SkippedFindingsCount *int64 + // The number of findings for which all mitigation actions succeeded when applied. + SucceededFindingsCount *int64 + // The total number of findings to which a task is being applied. TotalFindingsCount *int64 } @@ -2561,8 +2561,11 @@ type TaskStatisticsForAuditCheck struct { // of thing attributes. type ThingAttribute struct { - // The version of the thing record in the registry. - Version *int64 + // A list of thing attributes which are name-value pairs. + Attributes map[string]*string + + // The thing ARN. + ThingArn *string // The name of the thing. ThingName *string @@ -2570,11 +2573,8 @@ type ThingAttribute struct { // The name of the thing type, if the thing has been associated with a type. ThingTypeName *string - // The thing ARN. - ThingArn *string - - // A list of thing attributes which are name-value pairs. - Attributes map[string]*string + // The version of the thing record in the registry. + Version *int64 } // The connectivity status of the thing. @@ -2593,42 +2593,42 @@ type ThingConnectivity struct { // The thing search index document. type ThingDocument struct { - // Thing group names. - ThingGroupNames []*string + // The attributes. + Attributes map[string]*string + + // Indicates whether the thing is connected to the AWS IoT service. + Connectivity *ThingConnectivity // The shadow. Shadow *string - // Indicates whether the thing is connected to the AWS IoT service. - Connectivity *ThingConnectivity + // Thing group names. + ThingGroupNames []*string - // The thing type name. - ThingTypeName *string + // The thing ID. + ThingId *string // The thing name. ThingName *string - // The attributes. - Attributes map[string]*string - - // The thing ID. - ThingId *string + // The thing type name. + ThingTypeName *string } // The thing group search index document. type ThingGroupDocument struct { - // The thing group ID. - ThingGroupId *string - // The thing group attributes. Attributes map[string]*string + // Parent group names. + ParentGroupNames []*string + // The thing group description. ThingGroupDescription *string - // Parent group names. - ParentGroupNames []*string + // The thing group ID. + ThingGroupId *string // The thing group name. ThingGroupName *string @@ -2637,19 +2637,19 @@ type ThingGroupDocument struct { // Thing group indexing configuration. type ThingGroupIndexingConfiguration struct { - // Contains fields that are indexed and whose types are already known by the Fleet - // Indexing service. - ManagedFields []*Field + // Thing group indexing mode. + // + // This member is required. + ThingGroupIndexingMode ThingGroupIndexingMode // A list of thing group fields to index. This list cannot contain any managed // fields. Use the GetIndexingConfiguration API to get a list of managed fields. // Contains custom field names and their data type. CustomFields []*Field - // Thing group indexing mode. - // - // This member is required. - ThingGroupIndexingMode ThingGroupIndexingMode + // Contains fields that are indexed and whose types are already known by the Fleet + // Indexing service. + ManagedFields []*Field } // Thing group metadata. @@ -2668,11 +2668,11 @@ type ThingGroupMetadata struct { // Thing group properties. type ThingGroupProperties struct { - // The thing group description. - ThingGroupDescription *string - // The thing group attributes in JSON format. AttributePayload *AttributePayload + + // The thing group description. + ThingGroupDescription *string } // The thing indexing configuration. For more information, see Managing Thing @@ -2680,10 +2680,6 @@ type ThingGroupProperties struct { // (https://docs.aws.amazon.com/iot/latest/developerguide/managing-index.html). type ThingIndexingConfiguration struct { - // Contains fields that are indexed and whose types are already known by the Fleet - // Indexing service. - ManagedFields []*Field - // Thing indexing mode. Valid values are: // // * REGISTRY – Your thing index @@ -2697,6 +2693,13 @@ type ThingIndexingConfiguration struct { // This member is required. ThingIndexingMode ThingIndexingMode + // Contains custom field names and their data type. + CustomFields []*Field + + // Contains fields that are indexed and whose types are already known by the Fleet + // Indexing service. + ManagedFields []*Field + // Thing connectivity indexing mode. Valid values are: // // * STATUS – Your thing @@ -2706,24 +2709,21 @@ type ThingIndexingConfiguration struct { // * OFF - Thing connectivity status // indexing is disabled. ThingConnectivityIndexingMode ThingConnectivityIndexingMode - - // Contains custom field names and their data type. - CustomFields []*Field } // The definition of the thing type, including thing type name and description. type ThingTypeDefinition struct { - // The name of the thing type. - ThingTypeName *string + // The thing type ARN. + ThingTypeArn *string // The ThingTypeMetadata contains additional information about the thing type // including: creation date and time, a value indicating whether the thing type is // deprecated, and a date and time when it was deprecated. ThingTypeMetadata *ThingTypeMetadata - // The thing type ARN. - ThingTypeArn *string + // The name of the thing type. + ThingTypeName *string // The ThingTypeProperties for the thing type. ThingTypeProperties *ThingTypeProperties @@ -2734,13 +2734,13 @@ type ThingTypeDefinition struct { // deprecated, and a date and time when time was deprecated. type ThingTypeMetadata struct { + // The date and time when the thing type was created. + CreationDate *time.Time + // Whether the thing type is deprecated. If true, no new things could be associated // with this type. Deprecated *bool - // The date and time when the thing type was created. - CreationDate *time.Time - // The date and time when the thing type was deprecated. DeprecationDate *time.Time } @@ -2749,11 +2749,11 @@ type ThingTypeMetadata struct { // thing type description, and a list of searchable thing attribute names. type ThingTypeProperties struct { - // The description of the thing type. - ThingTypeDescription *string - // A list of searchable thing attribute names. SearchableAttributes []*string + + // The description of the thing type. + ThingTypeDescription *string } // Specifies the amount of time each device has to finish its execution of the job. @@ -2781,30 +2781,30 @@ type TlsContext struct { // Describes a rule. type TopicRule struct { - // Specifies whether the rule is disabled. - RuleDisabled *bool - - // The SQL statement used to query the topic. When using a SQL query with multiple - // lines, be sure to escape the newline characters. - Sql *string - // The actions associated with the rule. Actions []*Action - // The description of the rule. - Description *string + // The version of the SQL rules engine to use when evaluating the rule. + AwsIotSqlVersion *string // The date and time the rule was created. CreatedAt *time.Time + // The description of the rule. + Description *string + // The action to perform when an error occurs. ErrorAction *Action + // Specifies whether the rule is disabled. + RuleDisabled *bool + // The name of the rule. RuleName *string - // The version of the SQL rules engine to use when evaluating the rule. - AwsIotSqlVersion *string + // The SQL statement used to query the topic. When using a SQL query with multiple + // lines, be sure to escape the newline characters. + Sql *string } // A topic rule destination. @@ -2813,9 +2813,8 @@ type TopicRuleDestination struct { // The topic rule destination URL. Arn *string - // Additional details or reason why the topic rule destination is in the current - // status. - StatusReason *string + // Properties of the HTTP URL. + HttpUrlProperties *HttpUrlDestinationProperties // The status of the topic rule destination. Valid values are: IN_PROGRESS A topic // rule destination was created but has not been confirmed. You can set status to @@ -2832,8 +2831,9 @@ type TopicRuleDestination struct { // confirmation challenge to be sent to your confirmation endpoint. Status TopicRuleDestinationStatus - // Properties of the HTTP URL. - HttpUrlProperties *HttpUrlDestinationProperties + // Additional details or reason why the topic rule destination is in the current + // status. + StatusReason *string } // Configuration of the topic rule destination. @@ -2846,6 +2846,12 @@ type TopicRuleDestinationConfiguration struct { // Information about the topic rule destination. type TopicRuleDestinationSummary struct { + // The topic rule destination ARN. + Arn *string + + // Information about the HTTP URL. + HttpUrlSummary *HttpUrlDestinationSummary + // The status of the topic rule destination. Valid values are: IN_PROGRESS A topic // rule destination was created but has not been confirmed. You can set status to // IN_PROGRESS by calling UpdateTopicRuleDestination. Calling @@ -2861,12 +2867,6 @@ type TopicRuleDestinationSummary struct { // confirmation challenge to be sent to your confirmation endpoint. Status TopicRuleDestinationStatus - // The topic rule destination ARN. - Arn *string - - // Information about the HTTP URL. - HttpUrlSummary *HttpUrlDestinationSummary - // The reason the topic rule destination is in the current status. StatusReason *string } @@ -2874,25 +2874,30 @@ type TopicRuleDestinationSummary struct { // Describes a rule. type TopicRuleListItem struct { + // The date and time the rule was created. + CreatedAt *time.Time + + // The rule ARN. + RuleArn *string + // Specifies whether the rule is disabled. RuleDisabled *bool // The name of the rule. RuleName *string - // The date and time the rule was created. - CreatedAt *time.Time - // The pattern for the topic names that apply. TopicPattern *string - - // The rule ARN. - RuleArn *string } // Describes a rule. type TopicRulePayload struct { + // The actions associated with the rule. + // + // This member is required. + Actions []*Action + // The SQL statement used to query the topic. For more information, see AWS IoT SQL // Reference // (https://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference) @@ -2904,26 +2909,21 @@ type TopicRulePayload struct { // The version of the SQL rules engine to use when evaluating the rule. AwsIotSqlVersion *string - // Specifies whether the rule is disabled. - RuleDisabled *bool - - // The actions associated with the rule. - // - // This member is required. - Actions []*Action + // The description of the rule. + Description *string // The action to take when an error occurs. ErrorAction *Action - // The description of the rule. - Description *string + // Specifies whether the rule is disabled. + RuleDisabled *bool } // Data used to transfer a certificate to an AWS account. type TransferData struct { - // The date the transfer took place. - TransferDate *time.Time + // The date the transfer was accepted. + AcceptDate *time.Time // The date the transfer was rejected. RejectDate *time.Time @@ -2931,8 +2931,8 @@ type TransferData struct { // The reason why the transfer was rejected. RejectReason *string - // The date the transfer was accepted. - AcceptDate *time.Time + // The date the transfer took place. + TransferDate *time.Time // The transfer message. TransferMessage *string @@ -2970,12 +2970,6 @@ type ValidationError struct { // Information about a Device Defender security profile behavior violation. type ViolationEvent struct { - // The time the violation event occurred. - ViolationEventTime *time.Time - - // The ID of the violation event. - ViolationId *string - // The behavior which was violated. Behavior *Behavior @@ -2988,6 +2982,12 @@ type ViolationEvent struct { // The name of the thing responsible for the violation event. ThingName *string + // The time the violation event occurred. + ViolationEventTime *time.Time + // The type of violation event. ViolationEventType ViolationEventType + + // The ID of the violation event. + ViolationId *string } diff --git a/service/iot1clickdevicesservice/api_op_InvokeDeviceMethod.go b/service/iot1clickdevicesservice/api_op_InvokeDeviceMethod.go index e16d27cb0b3..97b01184872 100644 --- a/service/iot1clickdevicesservice/api_op_InvokeDeviceMethod.go +++ b/service/iot1clickdevicesservice/api_op_InvokeDeviceMethod.go @@ -58,14 +58,14 @@ func (c *Client) InvokeDeviceMethod(ctx context.Context, params *InvokeDeviceMet type InvokeDeviceMethodInput struct { - // The device method to invoke. - DeviceMethod *types.DeviceMethod - // The unique identifier of the device. // // This member is required. DeviceId *string + // The device method to invoke. + DeviceMethod *types.DeviceMethod + // A JSON encoded string containing the device method request parameters. DeviceMethodParameters *string } diff --git a/service/iot1clickdevicesservice/api_op_ListDeviceEvents.go b/service/iot1clickdevicesservice/api_op_ListDeviceEvents.go index 38b5e2d089f..46ef95001bd 100644 --- a/service/iot1clickdevicesservice/api_op_ListDeviceEvents.go +++ b/service/iot1clickdevicesservice/api_op_ListDeviceEvents.go @@ -64,10 +64,6 @@ type ListDeviceEventsInput struct { // This member is required. DeviceId *string - // The maximum number of results to return per request. If not set, a default value - // of 100 is used. - MaxResults *int32 - // The start date for the device event query, in ISO8061 format. For example, // 2018-03-28T15:45:12.880Z // @@ -80,6 +76,10 @@ type ListDeviceEventsInput struct { // This member is required. ToTimeStamp *time.Time + // The maximum number of results to return per request. If not set, a default value + // of 100 is used. + MaxResults *int32 + // The token to retrieve the next set of results. NextToken *string } diff --git a/service/iot1clickdevicesservice/api_op_ListDevices.go b/service/iot1clickdevicesservice/api_op_ListDevices.go index e7441404cb5..9df4dfd1a05 100644 --- a/service/iot1clickdevicesservice/api_op_ListDevices.go +++ b/service/iot1clickdevicesservice/api_op_ListDevices.go @@ -56,25 +56,25 @@ func (c *Client) ListDevices(ctx context.Context, params *ListDevicesInput, optF type ListDevicesInput struct { - // The token to retrieve the next set of results. - NextToken *string - // The type of the device, such as "button". DeviceType *string // The maximum number of results to return per request. If not set, a default value // of 100 is used. MaxResults *int32 -} - -type ListDevicesOutput struct { // The token to retrieve the next set of results. NextToken *string +} + +type ListDevicesOutput struct { // A list of devices. Devices []*types.DeviceDescription + // The token to retrieve the next set of results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot1clickdevicesservice/api_op_UpdateDeviceState.go b/service/iot1clickdevicesservice/api_op_UpdateDeviceState.go index cf180b39b41..a4c900b103d 100644 --- a/service/iot1clickdevicesservice/api_op_UpdateDeviceState.go +++ b/service/iot1clickdevicesservice/api_op_UpdateDeviceState.go @@ -57,13 +57,13 @@ func (c *Client) UpdateDeviceState(ctx context.Context, params *UpdateDeviceStat type UpdateDeviceStateInput struct { - // If true, the device is enabled. If false, the device is disabled. - Enabled *bool - // The unique identifier of the device. // // This member is required. DeviceId *string + + // If true, the device is enabled. If false, the device is disabled. + Enabled *bool } type UpdateDeviceStateOutput struct { diff --git a/service/iot1clickdevicesservice/go.mod b/service/iot1clickdevicesservice/go.mod index 79dbf6fa992..ad68a54041f 100644 --- a/service/iot1clickdevicesservice/go.mod +++ b/service/iot1clickdevicesservice/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/iot1clickdevicesservice go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/iot1clickdevicesservice/types/types.go b/service/iot1clickdevicesservice/types/types.go index 6dd73bf777d..224438537d6 100644 --- a/service/iot1clickdevicesservice/types/types.go +++ b/service/iot1clickdevicesservice/types/types.go @@ -7,21 +7,18 @@ type Attributes struct { type Device struct { - // The device type, such as "button". - Type *string + // The user specified attributes associated with the device for an event. + Attributes *Attributes // The unique identifier of the device. DeviceId *string - // The user specified attributes associated with the device for an event. - Attributes *Attributes + // The device type, such as "button". + Type *string } type DeviceDescription struct { - // The unique identifier of the device. - DeviceId *string - // The ARN of the device. Arn *string @@ -29,6 +26,9 @@ type DeviceDescription struct { // specified device attributes. Attributes map[string]*string + // The unique identifier of the device. + DeviceId *string + // A Boolean value indicating whether or not the device is enabled. Enabled *bool @@ -54,9 +54,9 @@ type DeviceEvent struct { type DeviceMethod struct { - // The name of the method applicable to the deviceType. - MethodName *string - // The type of the device, such as "button". DeviceType *string + + // The name of the method applicable to the deviceType. + MethodName *string } diff --git a/service/iot1clickprojects/api_op_AssociateDeviceWithPlacement.go b/service/iot1clickprojects/api_op_AssociateDeviceWithPlacement.go index a97a9293384..e9bb5bc0703 100644 --- a/service/iot1clickprojects/api_op_AssociateDeviceWithPlacement.go +++ b/service/iot1clickprojects/api_op_AssociateDeviceWithPlacement.go @@ -56,17 +56,6 @@ func (c *Client) AssociateDeviceWithPlacement(ctx context.Context, params *Assoc type AssociateDeviceWithPlacementInput struct { - // The name of the project containing the placement in which to associate the - // device. - // - // This member is required. - ProjectName *string - - // The name of the placement in which to associate the device. - // - // This member is required. - PlacementName *string - // The ID of the physical device to be associated with the given placement in the // project. Note that a mandatory 4 character prefix is required for all deviceId // values. @@ -78,6 +67,17 @@ type AssociateDeviceWithPlacementInput struct { // // This member is required. DeviceTemplateName *string + + // The name of the placement in which to associate the device. + // + // This member is required. + PlacementName *string + + // The name of the project containing the placement in which to associate the + // device. + // + // This member is required. + ProjectName *string } type AssociateDeviceWithPlacementOutput struct { diff --git a/service/iot1clickprojects/api_op_CreatePlacement.go b/service/iot1clickprojects/api_op_CreatePlacement.go index e1ae444e75f..67946ee7a38 100644 --- a/service/iot1clickprojects/api_op_CreatePlacement.go +++ b/service/iot1clickprojects/api_op_CreatePlacement.go @@ -56,15 +56,15 @@ func (c *Client) CreatePlacement(ctx context.Context, params *CreatePlacementInp type CreatePlacementInput struct { - // The name of the project in which to create the placement. + // The name of the placement to be created. // // This member is required. - ProjectName *string + PlacementName *string - // The name of the placement to be created. + // The name of the project in which to create the placement. // // This member is required. - PlacementName *string + ProjectName *string // Optional user-defined key/value pairs providing contextual data (such as // location or function) for the placement. diff --git a/service/iot1clickprojects/api_op_DisassociateDeviceFromPlacement.go b/service/iot1clickprojects/api_op_DisassociateDeviceFromPlacement.go index cd7aaa1ed15..933eee7fa26 100644 --- a/service/iot1clickprojects/api_op_DisassociateDeviceFromPlacement.go +++ b/service/iot1clickprojects/api_op_DisassociateDeviceFromPlacement.go @@ -56,11 +56,6 @@ func (c *Client) DisassociateDeviceFromPlacement(ctx context.Context, params *Di type DisassociateDeviceFromPlacementInput struct { - // The name of the project that contains the placement. - // - // This member is required. - ProjectName *string - // The device ID that should be removed from the placement. // // This member is required. @@ -70,6 +65,11 @@ type DisassociateDeviceFromPlacementInput struct { // // This member is required. PlacementName *string + + // The name of the project that contains the placement. + // + // This member is required. + ProjectName *string } type DisassociateDeviceFromPlacementOutput struct { diff --git a/service/iot1clickprojects/api_op_GetDevicesInPlacement.go b/service/iot1clickprojects/api_op_GetDevicesInPlacement.go index 2604b3ae23d..cda1272fde6 100644 --- a/service/iot1clickprojects/api_op_GetDevicesInPlacement.go +++ b/service/iot1clickprojects/api_op_GetDevicesInPlacement.go @@ -56,15 +56,15 @@ func (c *Client) GetDevicesInPlacement(ctx context.Context, params *GetDevicesIn type GetDevicesInPlacementInput struct { - // The name of the project containing the placement. + // The name of the placement to get the devices from. // // This member is required. - ProjectName *string + PlacementName *string - // The name of the placement to get the devices from. + // The name of the project containing the placement. // // This member is required. - PlacementName *string + ProjectName *string } type GetDevicesInPlacementOutput struct { diff --git a/service/iot1clickprojects/api_op_ListPlacements.go b/service/iot1clickprojects/api_op_ListPlacements.go index 4583ebb0987..15fc30a43eb 100644 --- a/service/iot1clickprojects/api_op_ListPlacements.go +++ b/service/iot1clickprojects/api_op_ListPlacements.go @@ -62,25 +62,25 @@ type ListPlacementsInput struct { // This member is required. ProjectName *string - // The token to retrieve the next set of results. - NextToken *string - // The maximum number of results to return per request. If not set, a default value // of 100 is used. MaxResults *int32 + + // The token to retrieve the next set of results. + NextToken *string } type ListPlacementsOutput struct { - // The token used to retrieve the next set of results - will be effectively empty - // if there are no further results. - NextToken *string - // An object listing the requested placements. // // This member is required. Placements []*types.PlacementSummary + // The token used to retrieve the next set of results - will be effectively empty + // if there are no further results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot1clickprojects/api_op_ListProjects.go b/service/iot1clickprojects/api_op_ListProjects.go index 8ddd348aa14..fe3eb1418be 100644 --- a/service/iot1clickprojects/api_op_ListProjects.go +++ b/service/iot1clickprojects/api_op_ListProjects.go @@ -67,15 +67,15 @@ type ListProjectsInput struct { type ListProjectsOutput struct { - // The token used to retrieve the next set of results - will be effectively empty - // if there are no further results. - NextToken *string - // An object containing the list of projects. // // This member is required. Projects []*types.ProjectSummary + // The token used to retrieve the next set of results - will be effectively empty + // if there are no further results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iot1clickprojects/api_op_TagResource.go b/service/iot1clickprojects/api_op_TagResource.go index 771dcdbcded..918caf1917b 100644 --- a/service/iot1clickprojects/api_op_TagResource.go +++ b/service/iot1clickprojects/api_op_TagResource.go @@ -59,17 +59,17 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { + // The ARN of the resouce for which tag(s) should be added or modified. + // + // This member is required. + ResourceArn *string + // The new or modifying tag(s) for the resource. See AWS IoT 1-Click Service Limits // (https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-appendix.html#1click-limits) // for the maximum number of tags allowed per resource. // // This member is required. Tags map[string]*string - - // The ARN of the resouce for which tag(s) should be added or modified. - // - // This member is required. - ResourceArn *string } type TagResourceOutput struct { diff --git a/service/iot1clickprojects/api_op_UpdateProject.go b/service/iot1clickprojects/api_op_UpdateProject.go index dd1b9f32a76..c5f93744f94 100644 --- a/service/iot1clickprojects/api_op_UpdateProject.go +++ b/service/iot1clickprojects/api_op_UpdateProject.go @@ -60,6 +60,11 @@ func (c *Client) UpdateProject(ctx context.Context, params *UpdateProjectInput, type UpdateProjectInput struct { + // The name of the project to be updated. + // + // This member is required. + ProjectName *string + // An optional user-defined description for the project. Description *string @@ -68,11 +73,6 @@ type UpdateProjectInput struct { // placementTemplate, you can update the associated callbackOverrides for the // device definition using this API. PlacementTemplate *types.PlacementTemplate - - // The name of the project to be updated. - // - // This member is required. - ProjectName *string } type UpdateProjectOutput struct { diff --git a/service/iot1clickprojects/go.mod b/service/iot1clickprojects/go.mod index 8cdaf5b1843..e1efdde3b19 100644 --- a/service/iot1clickprojects/go.mod +++ b/service/iot1clickprojects/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/iot1clickprojects go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/iot1clickprojects/types/types.go b/service/iot1clickprojects/types/types.go index 0e415298220..f2dbc708402 100644 --- a/service/iot1clickprojects/types/types.go +++ b/service/iot1clickprojects/types/types.go @@ -21,6 +21,11 @@ type DeviceTemplate struct { // An object describing a project's placement. type PlacementDescription struct { + // The user-defined attributes associated with the placement. + // + // This member is required. + Attributes map[string]*string + // The date when the placement was initially created, in UNIX epoch time format. // // This member is required. @@ -31,21 +36,16 @@ type PlacementDescription struct { // This member is required. PlacementName *string - // The user-defined attributes associated with the placement. + // The name of the project containing the placement. // // This member is required. - Attributes map[string]*string + ProjectName *string // The date when the placement was last updated, in UNIX epoch time format. If the // placement was not updated, then createdDate and updatedDate are the same. // // This member is required. UpdatedDate *time.Time - - // The name of the project containing the placement. - // - // This member is required. - ProjectName *string } // An object providing summary information for a particular placement. @@ -56,33 +56,33 @@ type PlacementSummary struct { // This member is required. CreatedDate *time.Time - // The date when the placement was last updated, in UNIX epoch time format. If the - // placement was not updated, then createdDate and updatedDate are the same. + // The name of the placement being summarized. // // This member is required. - UpdatedDate *time.Time + PlacementName *string // The name of the project containing the placement. // // This member is required. ProjectName *string - // The name of the placement being summarized. + // The date when the placement was last updated, in UNIX epoch time format. If the + // placement was not updated, then createdDate and updatedDate are the same. // // This member is required. - PlacementName *string + UpdatedDate *time.Time } // An object defining the template for a placement. type PlacementTemplate struct { - // An object specifying the DeviceTemplate () for all placements using this - // (PlacementTemplate ()) template. - DeviceTemplates map[string]*DeviceTemplate - // The default attributes (key/value pairs) to be applied to all placements using // this template. DefaultAttributes map[string]*string + + // An object specifying the DeviceTemplate () for all placements using this + // (PlacementTemplate ()) template. + DeviceTemplates map[string]*DeviceTemplate } // An object providing detailed information for a particular project associated @@ -99,41 +99,38 @@ type ProjectDescription struct { // This member is required. ProjectName *string - // The tags (metadata key/value pairs) associated with the project. - Tags map[string]*string - - // The ARN of the project. - Arn *string - // The date when the project was last updated, in UNIX epoch time format. If the // project was not updated, then createdDate and updatedDate are the same. // // This member is required. UpdatedDate *time.Time + // The ARN of the project. + Arn *string + // The description of the project. Description *string // An object describing the project's placement specifications. PlacementTemplate *PlacementTemplate + + // The tags (metadata key/value pairs) associated with the project. + Tags map[string]*string } // An object providing summary information for a particular project for an // associated AWS account and region. type ProjectSummary struct { - // The ARN of the project. - Arn *string - - // The name of the project being summarized. + // The date when the project was originally created, in UNIX epoch time format. // // This member is required. - ProjectName *string + CreatedDate *time.Time - // The date when the project was originally created, in UNIX epoch time format. + // The name of the project being summarized. // // This member is required. - CreatedDate *time.Time + ProjectName *string // The date when the project was last updated, in UNIX epoch time format. If the // project was not updated, then createdDate and updatedDate are the same. @@ -141,6 +138,9 @@ type ProjectSummary struct { // This member is required. UpdatedDate *time.Time + // The ARN of the project. + Arn *string + // The tags (metadata key/value pairs) associated with the project. Tags map[string]*string } diff --git a/service/iotanalytics/api_op_BatchPutMessage.go b/service/iotanalytics/api_op_BatchPutMessage.go index e2f4403d22d..ebfefb895cf 100644 --- a/service/iotanalytics/api_op_BatchPutMessage.go +++ b/service/iotanalytics/api_op_BatchPutMessage.go @@ -57,6 +57,11 @@ func (c *Client) BatchPutMessage(ctx context.Context, params *BatchPutMessageInp type BatchPutMessageInput struct { + // The name of the channel where the messages are sent. + // + // This member is required. + ChannelName *string + // The list of messages to be sent. Each message has format: '{ "messageId": // "string", "payload": "string"}'. Note that the field names of message payloads // (data) that you send to AWS IoT Analytics: @@ -85,11 +90,6 @@ type BatchPutMessageInput struct { // // This member is required. Messages []*types.Message - - // The name of the channel where the messages are sent. - // - // This member is required. - ChannelName *string } type BatchPutMessageOutput struct { diff --git a/service/iotanalytics/api_op_CreateChannel.go b/service/iotanalytics/api_op_CreateChannel.go index 316cb986a81..667ce32b9be 100644 --- a/service/iotanalytics/api_op_CreateChannel.go +++ b/service/iotanalytics/api_op_CreateChannel.go @@ -58,6 +58,11 @@ func (c *Client) CreateChannel(ctx context.Context, params *CreateChannelInput, type CreateChannelInput struct { + // The name of the channel. + // + // This member is required. + ChannelName *string + // Where channel data is stored. You may choose one of "serviceManagedS3" or // "customerManagedS3" storage. If not specified, the default is // "serviceManagedS3". This cannot be changed after creation of the channel. @@ -69,24 +74,19 @@ type CreateChannelInput struct { // Metadata which can be used to manage the channel. Tags []*types.Tag - - // The name of the channel. - // - // This member is required. - ChannelName *string } type CreateChannelOutput struct { - // How long, in days, message data is kept for the channel. - RetentionPeriod *types.RetentionPeriod - // The ARN of the channel. ChannelArn *string // The name of the channel. ChannelName *string + // How long, in days, message data is kept for the channel. + RetentionPeriod *types.RetentionPeriod + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotanalytics/api_op_CreateDataset.go b/service/iotanalytics/api_op_CreateDataset.go index fbc3c77f823..7e6b8866ba4 100644 --- a/service/iotanalytics/api_op_CreateDataset.go +++ b/service/iotanalytics/api_op_CreateDataset.go @@ -61,34 +61,19 @@ func (c *Client) CreateDataset(ctx context.Context, params *CreateDatasetInput, type CreateDatasetInput struct { - // [Optional] How many versions of data set contents are kept. If not specified or - // set to null, only the latest version plus the latest succeeded version (if they - // are different) are kept for the time period specified by the "retentionPeriod" - // parameter. (For more information, see - // https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions) - VersioningConfiguration *types.VersioningConfiguration - // A list of actions that create the data set contents. // // This member is required. Actions []*types.DatasetAction - // When data set contents are created they are delivered to destinations specified - // here. - ContentDeliveryRules []*types.DatasetContentDeliveryRule - // The name of the data set. // // This member is required. DatasetName *string - // A list of triggers. A trigger causes data set contents to be populated at a - // specified time interval or when another data set's contents are created. The - // list of triggers can be empty or contain up to five DataSetTrigger objects. - Triggers []*types.DatasetTrigger - - // Metadata which can be used to manage the data set. - Tags []*types.Tag + // When data set contents are created they are delivered to destinations specified + // here. + ContentDeliveryRules []*types.DatasetContentDeliveryRule // [Optional] How long, in days, versions of data set contents are kept for the // data set. If not specified or set to null, versions of data set contents are @@ -97,18 +82,33 @@ type CreateDatasetInput struct { // information, see // https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions) RetentionPeriod *types.RetentionPeriod + + // Metadata which can be used to manage the data set. + Tags []*types.Tag + + // A list of triggers. A trigger causes data set contents to be populated at a + // specified time interval or when another data set's contents are created. The + // list of triggers can be empty or contain up to five DataSetTrigger objects. + Triggers []*types.DatasetTrigger + + // [Optional] How many versions of data set contents are kept. If not specified or + // set to null, only the latest version plus the latest succeeded version (if they + // are different) are kept for the time period specified by the "retentionPeriod" + // parameter. (For more information, see + // https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions) + VersioningConfiguration *types.VersioningConfiguration } type CreateDatasetOutput struct { - // How long, in days, data set contents are kept for the data set. - RetentionPeriod *types.RetentionPeriod + // The ARN of the data set. + DatasetArn *string // The name of the data set. DatasetName *string - // The ARN of the data set. - DatasetArn *string + // How long, in days, data set contents are kept for the data set. + RetentionPeriod *types.RetentionPeriod // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/iotanalytics/api_op_CreateDatastore.go b/service/iotanalytics/api_op_CreateDatastore.go index 2e04999d09f..e80c13a856d 100644 --- a/service/iotanalytics/api_op_CreateDatastore.go +++ b/service/iotanalytics/api_op_CreateDatastore.go @@ -57,22 +57,22 @@ func (c *Client) CreateDatastore(ctx context.Context, params *CreateDatastoreInp type CreateDatastoreInput struct { - // How long, in days, message data is kept for the data store. When - // "customerManagedS3" storage is selected, this parameter is ignored. - RetentionPeriod *types.RetentionPeriod - // The name of the data store. // // This member is required. DatastoreName *string - // Metadata which can be used to manage the data store. - Tags []*types.Tag - // Where data store data is stored. You may choose one of "serviceManagedS3" or // "customerManagedS3" storage. If not specified, the default is // "serviceManagedS3". This cannot be changed after the data store is created. DatastoreStorage *types.DatastoreStorage + + // How long, in days, message data is kept for the data store. When + // "customerManagedS3" storage is selected, this parameter is ignored. + RetentionPeriod *types.RetentionPeriod + + // Metadata which can be used to manage the data store. + Tags []*types.Tag } type CreateDatastoreOutput struct { @@ -80,12 +80,12 @@ type CreateDatastoreOutput struct { // The ARN of the data store. DatastoreArn *string - // How long, in days, message data is kept for the data store. - RetentionPeriod *types.RetentionPeriod - // The name of the data store. DatastoreName *string + // How long, in days, message data is kept for the data store. + RetentionPeriod *types.RetentionPeriod + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotanalytics/api_op_CreatePipeline.go b/service/iotanalytics/api_op_CreatePipeline.go index ec9732bb092..35876e16310 100644 --- a/service/iotanalytics/api_op_CreatePipeline.go +++ b/service/iotanalytics/api_op_CreatePipeline.go @@ -60,9 +60,6 @@ func (c *Client) CreatePipeline(ctx context.Context, params *CreatePipelineInput type CreatePipelineInput struct { - // Metadata which can be used to manage the pipeline. - Tags []*types.Tag - // A list of "PipelineActivity" objects. Activities perform transformations on your // messages, such as removing, renaming or adding message attributes; filtering // messages based on attribute values; invoking your Lambda functions on messages @@ -79,16 +76,19 @@ type CreatePipelineInput struct { // // This member is required. PipelineName *string + + // Metadata which can be used to manage the pipeline. + Tags []*types.Tag } type CreatePipelineOutput struct { - // The name of the pipeline. - PipelineName *string - // The ARN of the pipeline. PipelineArn *string + // The name of the pipeline. + PipelineName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotanalytics/api_op_DescribeChannel.go b/service/iotanalytics/api_op_DescribeChannel.go index 1c6aead6a46..727a5bb4830 100644 --- a/service/iotanalytics/api_op_DescribeChannel.go +++ b/service/iotanalytics/api_op_DescribeChannel.go @@ -70,13 +70,13 @@ type DescribeChannelInput struct { type DescribeChannelOutput struct { + // An object that contains information about the channel. + Channel *types.Channel + // Statistics about the channel. Included if the 'includeStatistics' parameter is // set to true in the request. Statistics *types.ChannelStatistics - // An object that contains information about the channel. - Channel *types.Channel - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotanalytics/api_op_GetDatasetContent.go b/service/iotanalytics/api_op_GetDatasetContent.go index c22abfb47af..04907ebf5ce 100644 --- a/service/iotanalytics/api_op_GetDatasetContent.go +++ b/service/iotanalytics/api_op_GetDatasetContent.go @@ -75,12 +75,12 @@ type GetDatasetContentOutput struct { // A list of "DatasetEntry" objects. Entries []*types.DatasetEntry - // The time when the request was made. - Timestamp *time.Time - // The status of the data set content. Status *types.DatasetContentStatus + // The time when the request was made. + Timestamp *time.Time + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotanalytics/api_op_ListDatasetContents.go b/service/iotanalytics/api_op_ListDatasetContents.go index 45ce118aef3..f2bd8e0d5c7 100644 --- a/service/iotanalytics/api_op_ListDatasetContents.go +++ b/service/iotanalytics/api_op_ListDatasetContents.go @@ -58,26 +58,26 @@ func (c *Client) ListDatasetContents(ctx context.Context, params *ListDatasetCon type ListDatasetContentsInput struct { - // The token for the next set of results. - NextToken *string - // The name of the data set whose contents information you want to list. // // This member is required. DatasetName *string - // A filter to limit results to those data set contents whose creation is scheduled - // on or after the given time. See the field triggers.schedule in the CreateDataset - // request. (timestamp) - ScheduledOnOrAfter *time.Time - // The maximum number of results to return in this request. MaxResults *int32 + // The token for the next set of results. + NextToken *string + // A filter to limit results to those data set contents whose creation is scheduled // before the given time. See the field triggers.schedule in the CreateDataset // request. (timestamp) ScheduledBefore *time.Time + + // A filter to limit results to those data set contents whose creation is scheduled + // on or after the given time. See the field triggers.schedule in the CreateDataset + // request. (timestamp) + ScheduledOnOrAfter *time.Time } type ListDatasetContentsOutput struct { diff --git a/service/iotanalytics/api_op_ListDatasets.go b/service/iotanalytics/api_op_ListDatasets.go index 539f6e40821..5ce53be916b 100644 --- a/service/iotanalytics/api_op_ListDatasets.go +++ b/service/iotanalytics/api_op_ListDatasets.go @@ -56,23 +56,23 @@ func (c *Client) ListDatasets(ctx context.Context, params *ListDatasetsInput, op type ListDatasetsInput struct { - // The token for the next set of results. - NextToken *string - // The maximum number of results to return in this request. The default value is // 100. MaxResults *int32 + + // The token for the next set of results. + NextToken *string } type ListDatasetsOutput struct { + // A list of "DatasetSummary" objects. + DatasetSummaries []*types.DatasetSummary + // The token to retrieve the next set of results, or null if there are no more // results. NextToken *string - // A list of "DatasetSummary" objects. - DatasetSummaries []*types.DatasetSummary - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotanalytics/api_op_ListDatastores.go b/service/iotanalytics/api_op_ListDatastores.go index 2395f728234..36699fc2193 100644 --- a/service/iotanalytics/api_op_ListDatastores.go +++ b/service/iotanalytics/api_op_ListDatastores.go @@ -56,12 +56,12 @@ func (c *Client) ListDatastores(ctx context.Context, params *ListDatastoresInput type ListDatastoresInput struct { - // The token for the next set of results. - NextToken *string - // The maximum number of results to return in this request. The default value is // 100. MaxResults *int32 + + // The token for the next set of results. + NextToken *string } type ListDatastoresOutput struct { diff --git a/service/iotanalytics/api_op_ListPipelines.go b/service/iotanalytics/api_op_ListPipelines.go index bd8c2cd2590..b50fc952f8c 100644 --- a/service/iotanalytics/api_op_ListPipelines.go +++ b/service/iotanalytics/api_op_ListPipelines.go @@ -56,12 +56,12 @@ func (c *Client) ListPipelines(ctx context.Context, params *ListPipelinesInput, type ListPipelinesInput struct { - // The token for the next set of results. - NextToken *string - // The maximum number of results to return in this request. The default value is // 100. MaxResults *int32 + + // The token for the next set of results. + NextToken *string } type ListPipelinesOutput struct { diff --git a/service/iotanalytics/api_op_RunPipelineActivity.go b/service/iotanalytics/api_op_RunPipelineActivity.go index 20e02c3896e..a342a8a26f9 100644 --- a/service/iotanalytics/api_op_RunPipelineActivity.go +++ b/service/iotanalytics/api_op_RunPipelineActivity.go @@ -57,6 +57,11 @@ func (c *Client) RunPipelineActivity(ctx context.Context, params *RunPipelineAct type RunPipelineActivityInput struct { + // The sample message payloads on which the pipeline activity is run. + // + // This member is required. + Payloads [][]byte + // The pipeline activity that is run. This must not be a 'channel' activity or a // 'datastore' activity because these activities are used in a pipeline only to // load the original message and to store the (possibly) transformed message. If a @@ -65,23 +70,18 @@ type RunPipelineActivityInput struct { // // This member is required. PipelineActivity *types.PipelineActivity - - // The sample message payloads on which the pipeline activity is run. - // - // This member is required. - Payloads [][]byte } type RunPipelineActivityOutput struct { + // In case the pipeline activity fails, the log message that is generated. + LogResult *string + // The enriched or transformed sample message payloads as base64-encoded strings. // (The results of running the pipeline activity on each input sample message // payload, encoded in base64.) Payloads [][]byte - // In case the pipeline activity fails, the log message that is generated. - LogResult *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotanalytics/api_op_SampleChannelData.go b/service/iotanalytics/api_op_SampleChannelData.go index d033ceee629..0608b1c8906 100644 --- a/service/iotanalytics/api_op_SampleChannelData.go +++ b/service/iotanalytics/api_op_SampleChannelData.go @@ -58,20 +58,20 @@ func (c *Client) SampleChannelData(ctx context.Context, params *SampleChannelDat type SampleChannelDataInput struct { - // The end of the time window from which sample messages are retrieved. - EndTime *time.Time - - // The start of the time window from which sample messages are retrieved. - StartTime *time.Time - // The name of the channel whose message samples are retrieved. // // This member is required. ChannelName *string + // The end of the time window from which sample messages are retrieved. + EndTime *time.Time + // The number of sample messages to be retrieved. The limit is 10, the default is // also 10. MaxMessages *int32 + + // The start of the time window from which sample messages are retrieved. + StartTime *time.Time } type SampleChannelDataOutput struct { diff --git a/service/iotanalytics/api_op_StartPipelineReprocessing.go b/service/iotanalytics/api_op_StartPipelineReprocessing.go index e086ba7c73f..a2189cbe97d 100644 --- a/service/iotanalytics/api_op_StartPipelineReprocessing.go +++ b/service/iotanalytics/api_op_StartPipelineReprocessing.go @@ -57,14 +57,14 @@ func (c *Client) StartPipelineReprocessing(ctx context.Context, params *StartPip type StartPipelineReprocessingInput struct { - // The end time (exclusive) of raw message data that is reprocessed. - EndTime *time.Time - // The name of the pipeline on which to start reprocessing. // // This member is required. PipelineName *string + // The end time (exclusive) of raw message data that is reprocessed. + EndTime *time.Time + // The start time (inclusive) of raw message data that is reprocessed. StartTime *time.Time } diff --git a/service/iotanalytics/api_op_TagResource.go b/service/iotanalytics/api_op_TagResource.go index 5b8ac6eefbe..e025ae0ea23 100644 --- a/service/iotanalytics/api_op_TagResource.go +++ b/service/iotanalytics/api_op_TagResource.go @@ -58,15 +58,15 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The new or modified tags for the resource. + // The ARN of the resource whose tags you want to modify. // // This member is required. - Tags []*types.Tag + ResourceArn *string - // The ARN of the resource whose tags you want to modify. + // The new or modified tags for the resource. // // This member is required. - ResourceArn *string + Tags []*types.Tag } type TagResourceOutput struct { diff --git a/service/iotanalytics/api_op_UntagResource.go b/service/iotanalytics/api_op_UntagResource.go index 4e321924a85..c146e2d9891 100644 --- a/service/iotanalytics/api_op_UntagResource.go +++ b/service/iotanalytics/api_op_UntagResource.go @@ -56,15 +56,15 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The keys of those tags which you want to remove. + // The ARN of the resource whose tags you want to remove. // // This member is required. - TagKeys []*string + ResourceArn *string - // The ARN of the resource whose tags you want to remove. + // The keys of those tags which you want to remove. // // This member is required. - ResourceArn *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/iotanalytics/api_op_UpdateChannel.go b/service/iotanalytics/api_op_UpdateChannel.go index 79eb5e0fe25..2f113b5df8d 100644 --- a/service/iotanalytics/api_op_UpdateChannel.go +++ b/service/iotanalytics/api_op_UpdateChannel.go @@ -62,14 +62,14 @@ type UpdateChannelInput struct { // This member is required. ChannelName *string - // How long, in days, message data is kept for the channel. The retention period - // cannot be updated if the channel's S3 storage is customer-managed. - RetentionPeriod *types.RetentionPeriod - // Where channel data is stored. You may choose one of "serviceManagedS3" or // "customerManagedS3" storage. If not specified, the default is // "serviceManagedS3". This cannot be changed after creation of the channel. ChannelStorage *types.ChannelStorage + + // How long, in days, message data is kept for the channel. The retention period + // cannot be updated if the channel's S3 storage is customer-managed. + RetentionPeriod *types.RetentionPeriod } type UpdateChannelOutput struct { diff --git a/service/iotanalytics/api_op_UpdateDataset.go b/service/iotanalytics/api_op_UpdateDataset.go index f01943f16d4..c6c20ca25fa 100644 --- a/service/iotanalytics/api_op_UpdateDataset.go +++ b/service/iotanalytics/api_op_UpdateDataset.go @@ -57,33 +57,33 @@ func (c *Client) UpdateDataset(ctx context.Context, params *UpdateDatasetInput, type UpdateDatasetInput struct { + // A list of "DatasetAction" objects. + // + // This member is required. + Actions []*types.DatasetAction + // The name of the data set to update. // // This member is required. DatasetName *string - // [Optional] How many versions of data set contents are kept. If not specified or - // set to null, only the latest version plus the latest succeeded version (if they - // are different) are kept for the time period specified by the "retentionPeriod" - // parameter. (For more information, see - // https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions) - VersioningConfiguration *types.VersioningConfiguration - // When data set contents are created they are delivered to destinations specified // here. ContentDeliveryRules []*types.DatasetContentDeliveryRule - // A list of "DatasetAction" objects. - // - // This member is required. - Actions []*types.DatasetAction - // How long, in days, data set contents are kept for the data set. RetentionPeriod *types.RetentionPeriod // A list of "DatasetTrigger" objects. The list can be empty or can contain up to // five DataSetTrigger objects. Triggers []*types.DatasetTrigger + + // [Optional] How many versions of data set contents are kept. If not specified or + // set to null, only the latest version plus the latest succeeded version (if they + // are different) are kept for the time period specified by the "retentionPeriod" + // parameter. (For more information, see + // https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions) + VersioningConfiguration *types.VersioningConfiguration } type UpdateDatasetOutput struct { diff --git a/service/iotanalytics/api_op_UpdatePipeline.go b/service/iotanalytics/api_op_UpdatePipeline.go index 36d73305363..81b4f2a24dd 100644 --- a/service/iotanalytics/api_op_UpdatePipeline.go +++ b/service/iotanalytics/api_op_UpdatePipeline.go @@ -59,11 +59,6 @@ func (c *Client) UpdatePipeline(ctx context.Context, params *UpdatePipelineInput type UpdatePipelineInput struct { - // The name of the pipeline to update. - // - // This member is required. - PipelineName *string - // A list of "PipelineActivity" objects. Activities perform transformations on your // messages, such as removing, renaming or adding message attributes; filtering // messages based on attribute values; invoking your Lambda functions on messages @@ -75,6 +70,11 @@ type UpdatePipelineInput struct { // // This member is required. PipelineActivities []*types.PipelineActivity + + // The name of the pipeline to update. + // + // This member is required. + PipelineName *string } type UpdatePipelineOutput struct { diff --git a/service/iotanalytics/go.mod b/service/iotanalytics/go.mod index 18cd0f1b90e..5e1b4df3eeb 100644 --- a/service/iotanalytics/go.mod +++ b/service/iotanalytics/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/iotanalytics go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/iotanalytics/types/types.go b/service/iotanalytics/types/types.go index e86fe9ae699..6f86ba8cb41 100644 --- a/service/iotanalytics/types/types.go +++ b/service/iotanalytics/types/types.go @@ -10,11 +10,6 @@ import ( // message. type AddAttributesActivity struct { - // The name of the 'addAttributes' activity. - // - // This member is required. - Name *string - // A list of 1-50 "AttributeNameMapping" objects that map an existing attribute to // a new attribute. The existing attributes remain in the message, so if you want // to remove the originals, use "RemoveAttributeActivity". @@ -22,6 +17,11 @@ type AddAttributesActivity struct { // This member is required. Attributes map[string]*string + // The name of the 'addAttributes' activity. + // + // This member is required. + Name *string + // The next activity in the pipeline. Next *string } @@ -29,57 +29,57 @@ type AddAttributesActivity struct { // Contains informations about errors. type BatchPutMessageErrorEntry struct { + // The code associated with the error. + ErrorCode *string + // The message associated with the error. ErrorMessage *string // The ID of the message that caused the error. (See the value corresponding to the // "messageId" key in the message object.) MessageId *string - - // The code associated with the error. - ErrorCode *string } // A collection of data from an MQTT topic. Channels archive the raw, unprocessed // messages before publishing the data to a pipeline. type Channel struct { + // The ARN of the channel. + Arn *string + + // When the channel was created. + CreationTime *time.Time + // When the channel was last updated. LastUpdateTime *time.Time - // Where channel data is stored. You may choose one of "serviceManagedS3" or - // "customerManagedS3" storage. If not specified, the default is - // "serviceManagedS3". This cannot be changed after creation of the channel. - Storage *ChannelStorage - // The name of the channel. Name *string - // The ARN of the channel. - Arn *string + // How long, in days, message data is kept for the channel. + RetentionPeriod *RetentionPeriod // The status of the channel. Status ChannelStatus - // How long, in days, message data is kept for the channel. - RetentionPeriod *RetentionPeriod - - // When the channel was created. - CreationTime *time.Time + // Where channel data is stored. You may choose one of "serviceManagedS3" or + // "customerManagedS3" storage. If not specified, the default is + // "serviceManagedS3". This cannot be changed after creation of the channel. + Storage *ChannelStorage } // The activity that determines the source of the messages to be processed. type ChannelActivity struct { - // The name of the 'channel' activity. + // The name of the channel from which the messages are processed. // // This member is required. - Name *string + ChannelName *string - // The name of the channel from which the messages are processed. + // The name of the 'channel' activity. // // This member is required. - ChannelName *string + Name *string // The next activity in the pipeline. Next *string @@ -97,46 +97,46 @@ type ChannelStatistics struct { // "serviceManagedS3". This cannot be changed after creation of the channel. type ChannelStorage struct { - // Use this to store channel data in an S3 bucket managed by the AWS IoT Analytics - // service. The choice of service-managed or customer-managed S3 storage cannot be - // changed after creation of the channel. - ServiceManagedS3 *ServiceManagedChannelS3Storage - // Use this to store channel data in an S3 bucket that you manage. If customer // managed storage is selected, the "retentionPeriod" parameter is ignored. The // choice of service-managed or customer-managed S3 storage cannot be changed after // creation of the channel. CustomerManagedS3 *CustomerManagedChannelS3Storage + + // Use this to store channel data in an S3 bucket managed by the AWS IoT Analytics + // service. The choice of service-managed or customer-managed S3 storage cannot be + // changed after creation of the channel. + ServiceManagedS3 *ServiceManagedChannelS3Storage } // Where channel data is stored. type ChannelStorageSummary struct { + // Used to store channel data in an S3 bucket that you manage. + CustomerManagedS3 *CustomerManagedChannelS3StorageSummary + // Used to store channel data in an S3 bucket managed by the AWS IoT Analytics // service. ServiceManagedS3 *ServiceManagedChannelS3StorageSummary - - // Used to store channel data in an S3 bucket that you manage. - CustomerManagedS3 *CustomerManagedChannelS3StorageSummary } // A summary of information about a channel. type ChannelSummary struct { - // The status of the channel. - Status ChannelStatus - - // When the channel was created. - CreationTime *time.Time + // The name of the channel. + ChannelName *string // Where channel data is stored. ChannelStorage *ChannelStorageSummary - // The name of the channel. - ChannelName *string + // When the channel was created. + CreationTime *time.Time // The last time the channel was updated. LastUpdateTime *time.Time + + // The status of the channel. + Status ChannelStatus } // Information needed to run the "containerAction" to produce data set contents. @@ -150,23 +150,23 @@ type ContainerDatasetAction struct { // This member is required. ExecutionRoleArn *string - // The values of variables used within the context of the execution of the - // containerized application (basically, parameters passed to the application). - // Each variable must have a name and a value given by one of "stringValue", - // "datasetContentVersionValue", or "outputFileUriValue". - Variables []*Variable - - // Configuration of the resource which executes the "containerAction". - // - // This member is required. - ResourceConfiguration *ResourceConfiguration - // The ARN of the Docker container stored in your account. The Docker container // contains an application and needed support libraries and is used to generate // data set contents. // // This member is required. Image *string + + // Configuration of the resource which executes the "containerAction". + // + // This member is required. + ResourceConfiguration *ResourceConfiguration + + // The values of variables used within the context of the execution of the + // containerized application (basically, parameters passed to the application). + // Each variable must have a name and a value given by one of "stringValue", + // "datasetContentVersionValue", or "outputFileUriValue". + Variables []*Variable } // Use this to store channel data in an S3 bucket that you manage. If customer @@ -180,25 +180,24 @@ type CustomerManagedChannelS3Storage struct { // This member is required. Bucket *string - // [Optional] The prefix used to create the keys of the channel data objects. Each - // object in an Amazon S3 bucket has a key that is its unique identifier within the - // bucket (each object in a bucket has exactly one key). The prefix must end with a - // '/'. - KeyPrefix *string - // The ARN of the role which grants AWS IoT Analytics permission to interact with // your Amazon S3 resources. // // This member is required. RoleArn *string + + // [Optional] The prefix used to create the keys of the channel data objects. Each + // object in an Amazon S3 bucket has a key that is its unique identifier within the + // bucket (each object in a bucket has exactly one key). The prefix must end with a + // '/'. + KeyPrefix *string } // Used to store channel data in an S3 bucket that you manage. type CustomerManagedChannelS3StorageSummary struct { - // The ARN of the role which grants AWS IoT Analytics permission to interact with - // your Amazon S3 resources. - RoleArn *string + // The name of the Amazon S3 bucket in which channel data is stored. + Bucket *string // [Optional] The prefix used to create the keys of the channel data objects. Each // object in an Amazon S3 bucket has a key that is its unique identifier within the @@ -206,8 +205,9 @@ type CustomerManagedChannelS3StorageSummary struct { // '/'. KeyPrefix *string - // The name of the Amazon S3 bucket in which channel data is stored. - Bucket *string + // The ARN of the role which grants AWS IoT Analytics permission to interact with + // your Amazon S3 resources. + RoleArn *string } // Use this to store data store data in an S3 bucket that you manage. When customer @@ -216,6 +216,11 @@ type CustomerManagedChannelS3StorageSummary struct { // creation of the data store. type CustomerManagedDatastoreS3Storage struct { + // The name of the Amazon S3 bucket in which data store data is stored. + // + // This member is required. + Bucket *string + // The ARN of the role which grants AWS IoT Analytics permission to interact with // your Amazon S3 resources. // @@ -227,11 +232,6 @@ type CustomerManagedDatastoreS3Storage struct { // within the bucket (each object in a bucket has exactly one key). The prefix must // end with a '/'. KeyPrefix *string - - // The name of the Amazon S3 bucket in which data store data is stored. - // - // This member is required. - Bucket *string } // Used to store data store data in an S3 bucket that you manage. @@ -254,47 +254,51 @@ type CustomerManagedDatastoreS3StorageSummary struct { // Information about a data set. type Dataset struct { - // [Optional] How many versions of data set contents are kept. If not specified or - // set to null, only the latest version plus the latest succeeded version (if they - // are different) are kept for the time period specified by the "retentionPeriod" - // parameter. (For more information, see - // https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions) - VersioningConfiguration *VersioningConfiguration - - // The status of the data set. - Status DatasetStatus - - // The "DatasetTrigger" objects that specify when the data set is automatically - // updated. - Triggers []*DatasetTrigger - - // [Optional] How long, in days, message data is kept for the data set. - RetentionPeriod *RetentionPeriod - - // The name of the data set. - Name *string - // The "DatasetAction" objects that automatically create the data set contents. Actions []*DatasetAction // The ARN of the data set. Arn *string - // The last time the data set was updated. - LastUpdateTime *time.Time - // When data set contents are created they are delivered to destinations specified // here. ContentDeliveryRules []*DatasetContentDeliveryRule // When the data set was created. CreationTime *time.Time + + // The last time the data set was updated. + LastUpdateTime *time.Time + + // The name of the data set. + Name *string + + // [Optional] How long, in days, message data is kept for the data set. + RetentionPeriod *RetentionPeriod + + // The status of the data set. + Status DatasetStatus + + // The "DatasetTrigger" objects that specify when the data set is automatically + // updated. + Triggers []*DatasetTrigger + + // [Optional] How many versions of data set contents are kept. If not specified or + // set to null, only the latest version plus the latest succeeded version (if they + // are different) are kept for the time period specified by the "retentionPeriod" + // parameter. (For more information, see + // https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions) + VersioningConfiguration *VersioningConfiguration } // A "DatasetAction" object that specifies how data set contents are automatically // created. type DatasetAction struct { + // The name of the data set action by which data set contents are automatically + // created. + ActionName *string + // Information which allows the system to run a containerized application in order // to create the data set contents. The application must be in a Docker container // along with any needed support libraries. @@ -303,31 +307,27 @@ type DatasetAction struct { // An "SqlQueryDatasetAction" object that uses an SQL query to automatically create // data set contents. QueryAction *SqlQueryDatasetAction - - // The name of the data set action by which data set contents are automatically - // created. - ActionName *string } // Information about the action which automatically creates the data set's // contents. type DatasetActionSummary struct { - // The type of action by which the data set's contents are automatically created. - ActionType DatasetActionType - // The name of the action which automatically creates the data set's contents. ActionName *string + + // The type of action by which the data set's contents are automatically created. + ActionType DatasetActionType } // The destination to which data set contents are delivered. type DatasetContentDeliveryDestination struct { - // Configuration information for delivery of data set contents to Amazon S3. - S3DestinationConfiguration *S3DestinationConfiguration - // Configuration information for delivery of data set contents to AWS IoT Events. IotEventsDestinationConfiguration *IotEventsDestinationConfiguration + + // Configuration information for delivery of data set contents to Amazon S3. + S3DestinationConfiguration *S3DestinationConfiguration } // When data set contents are created they are delivered to destination specified @@ -357,20 +357,20 @@ type DatasetContentStatus struct { // Summary information about data set contents. type DatasetContentSummary struct { - // The status of the data set contents. - Status *DatasetContentStatus - - // The version of the data set contents. - Version *string - // The time the dataset content status was updated to SUCCEEDED or FAILED. CompletionTime *time.Time + // The actual time the creation of the data set contents was started. + CreationTime *time.Time + // The time the creation of the data set contents was scheduled to start. ScheduleTime *time.Time - // The actual time the creation of the data set contents was started. - CreationTime *time.Time + // The status of the data set contents. + Status *DatasetContentStatus + + // The version of the data set contents. + Version *string } // The data set whose latest contents are used as input to the notebook or @@ -387,19 +387,28 @@ type DatasetContentVersionValue struct { // The reference to a data set entry. type DatasetEntry struct { - // The name of the data set item. - EntryName *string - // The pre-signed URI of the data set item. DataURI *string + + // The name of the data set item. + EntryName *string } // A summary of information about a data set. type DatasetSummary struct { + // A list of "DataActionSummary" objects. + Actions []*DatasetActionSummary + // The time the data set was created. CreationTime *time.Time + // The name of the data set. + DatasetName *string + + // The last time the data set was updated. + LastUpdateTime *time.Time + // The status of the data set. Status DatasetStatus @@ -407,48 +416,34 @@ type DatasetSummary struct { // specified time interval or when another data set is populated. The list of // triggers can be empty or contain up to five DataSetTrigger objects Triggers []*DatasetTrigger - - // The last time the data set was updated. - LastUpdateTime *time.Time - - // The name of the data set. - DatasetName *string - - // A list of "DataActionSummary" objects. - Actions []*DatasetActionSummary } // The "DatasetTrigger" that specifies when the data set is automatically updated. type DatasetTrigger struct { - // The "Schedule" when the trigger is initiated. - Schedule *Schedule - // The data set whose content creation triggers the creation of this data set's // contents. Dataset *TriggeringDataset + + // The "Schedule" when the trigger is initiated. + Schedule *Schedule } // Information about a data store. type Datastore struct { - // Where data store data is stored. You may choose one of "serviceManagedS3" or - // "customerManagedS3" storage. If not specified, the default is - // "serviceManagedS3". This cannot be changed after the data store is created. - Storage *DatastoreStorage + // The ARN of the data store. + Arn *string // When the data store was created. CreationTime *time.Time - // The name of the data store. - Name *string - - // The ARN of the data store. - Arn *string - // The last time the data store was updated. LastUpdateTime *time.Time + // The name of the data store. + Name *string + // How long, in days, message data is kept for the data store. When // "customerManagedS3" storage is selected, this parameter is ignored. RetentionPeriod *RetentionPeriod @@ -457,6 +452,11 @@ type Datastore struct { // data store has been created and can be used. DELETING The data store is being // deleted. Status DatastoreStatus + + // Where data store data is stored. You may choose one of "serviceManagedS3" or + // "customerManagedS3" storage. If not specified, the default is + // "serviceManagedS3". This cannot be changed after the data store is created. + Storage *DatastoreStorage } // The 'datastore' activity that specifies where to store the processed data. @@ -511,20 +511,20 @@ type DatastoreStorageSummary struct { // A summary of information about a data store. type DatastoreSummary struct { - // Where data store data is stored. - DatastoreStorage *DatastoreStorageSummary - // When the data store was created. CreationTime *time.Time - // The status of the data store. - Status DatastoreStatus + // The name of the data store. + DatastoreName *string + + // Where data store data is stored. + DatastoreStorage *DatastoreStorageSummary // The last time the data store was updated. LastUpdateTime *time.Time - // The name of the data store. - DatastoreName *string + // The status of the data store. + Status DatastoreStatus } // Used to limit data to that which has arrived since the last execution of the @@ -559,15 +559,15 @@ type DeviceRegistryEnrichActivity struct { // This member is required. Attribute *string - // The ARN of the role that allows access to the device's registry information. + // The name of the 'deviceRegistryEnrich' activity. // // This member is required. - RoleArn *string + Name *string - // The name of the 'deviceRegistryEnrich' activity. + // The ARN of the role that allows access to the device's registry information. // // This member is required. - Name *string + RoleArn *string // The name of the IoT device whose registry information is added to the message. // @@ -582,25 +582,25 @@ type DeviceRegistryEnrichActivity struct { // message. type DeviceShadowEnrichActivity struct { - // The name of the 'deviceShadowEnrich' activity. + // The name of the attribute that is added to the message. // // This member is required. - Name *string + Attribute *string - // The name of the IoT device whose shadow information is added to the message. + // The name of the 'deviceShadowEnrich' activity. // // This member is required. - ThingName *string + Name *string // The ARN of the role that allows access to the device's shadow. // // This member is required. RoleArn *string - // The name of the attribute that is added to the message. + // The name of the IoT device whose shadow information is added to the message. // // This member is required. - Attribute *string + ThingName *string // The next activity in the pipeline. Next *string @@ -625,13 +625,13 @@ type FilterActivity struct { // This member is required. Filter *string - // The next activity in the pipeline. - Next *string - // The name of the 'filter' activity. // // This member is required. Name *string + + // The next activity in the pipeline. + Next *string } // Configuration information for coordination with the AWS Glue ETL (extract, @@ -655,24 +655,21 @@ type GlueConfiguration struct { // Configuration information for delivery of data set contents to AWS IoT Events. type IotEventsDestinationConfiguration struct { - // The ARN of the role which grants AWS IoT Analytics permission to deliver data - // set contents to an AWS IoT Events input. + // The name of the AWS IoT Events input to which data set contents are delivered. // // This member is required. - RoleArn *string + InputName *string - // The name of the AWS IoT Events input to which data set contents are delivered. + // The ARN of the role which grants AWS IoT Analytics permission to deliver data + // set contents to an AWS IoT Events input. // // This member is required. - InputName *string + RoleArn *string } // An activity that runs a Lambda function to modify the message. type LambdaActivity struct { - // The next activity in the pipeline. - Next *string - // The number of messages passed to the Lambda function for processing. The AWS // Lambda function must be able to process all of these messages within five // minutes, which is the maximum timeout duration for Lambda functions. @@ -680,29 +677,32 @@ type LambdaActivity struct { // This member is required. BatchSize *int32 - // The name of the 'lambda' activity. + // The name of the Lambda function that is run on the message. // // This member is required. - Name *string + LambdaName *string - // The name of the Lambda function that is run on the message. + // The name of the 'lambda' activity. // // This member is required. - LambdaName *string + Name *string + + // The next activity in the pipeline. + Next *string } // Information about logging options. type LoggingOptions struct { - // The logging level. Currently, only "ERROR" is supported. + // If true, logging is enabled for AWS IoT Analytics. // // This member is required. - Level LoggingLevel + Enabled *bool - // If true, logging is enabled for AWS IoT Analytics. + // The logging level. Currently, only "ERROR" is supported. // // This member is required. - Enabled *bool + Level LoggingLevel // The ARN of the role that grants permission to AWS IoT Analytics to perform // logging. @@ -765,21 +765,21 @@ type OutputFileUriValue struct { // Contains information about a pipeline. type Pipeline struct { - // When the pipeline was created. - CreationTime *time.Time - // The activities that perform transformations on the messages. Activities []*PipelineActivity // The ARN of the pipeline. Arn *string - // The name of the pipeline. - Name *string + // When the pipeline was created. + CreationTime *time.Time // The last time the pipeline was updated. LastUpdateTime *time.Time + // The name of the pipeline. + Name *string + // A summary of information about the pipeline reprocessing. ReprocessingSummaries []*ReprocessingSummary } @@ -787,12 +787,27 @@ type Pipeline struct { // An activity that performs a transformation on a message. type PipelineActivity struct { + // Adds other attributes based on existing attributes in the message. + AddAttributes *AddAttributesActivity + + // Determines the source of the messages to be processed. + Channel *ChannelActivity + + // Specifies where to store the processed message data. + Datastore *DatastoreActivity + + // Adds data from the AWS IoT device registry to your message. + DeviceRegistryEnrich *DeviceRegistryEnrichActivity + // Adds information from the AWS IoT Device Shadows service to a message. DeviceShadowEnrich *DeviceShadowEnrichActivity // Filters a message based on its attributes. Filter *FilterActivity + // Runs a Lambda function to modify the message. + Lambda *LambdaActivity + // Computes an arithmetic expression using the message's attributes and adds it to // the message. Math *MathActivity @@ -800,24 +815,9 @@ type PipelineActivity struct { // Removes attributes from a message. RemoveAttributes *RemoveAttributesActivity - // Runs a Lambda function to modify the message. - Lambda *LambdaActivity - - // Determines the source of the messages to be processed. - Channel *ChannelActivity - - // Adds other attributes based on existing attributes in the message. - AddAttributes *AddAttributesActivity - - // Specifies where to store the processed message data. - Datastore *DatastoreActivity - // Creates a new message using only the specified attributes from the original // message. SelectAttributes *SelectAttributesActivity - - // Adds data from the AWS IoT device registry to your message. - DeviceRegistryEnrich *DeviceRegistryEnrichActivity } // A summary of information about a pipeline. @@ -829,11 +829,11 @@ type PipelineSummary struct { // When the pipeline was last updated. LastUpdateTime *time.Time - // A summary of information about the pipeline reprocessing. - ReprocessingSummaries []*ReprocessingSummary - // The name of the pipeline. PipelineName *string + + // A summary of information about the pipeline reprocessing. + ReprocessingSummaries []*ReprocessingSummary } // Information which is used to filter message data, to segregate it according to @@ -848,9 +848,6 @@ type QueryFilter struct { // An activity that removes attributes from a message. type RemoveAttributesActivity struct { - // The next activity in the pipeline. - Next *string - // A list of 1-50 attributes to remove from the message. // // This member is required. @@ -860,60 +857,58 @@ type RemoveAttributesActivity struct { // // This member is required. Name *string + + // The next activity in the pipeline. + Next *string } // Information about pipeline reprocessing. type ReprocessingSummary struct { - // The status of the pipeline reprocessing. - Status ReprocessingStatus + // The time the pipeline reprocessing was created. + CreationTime *time.Time // The 'reprocessingId' returned by "StartPipelineReprocessing". Id *string - // The time the pipeline reprocessing was created. - CreationTime *time.Time + // The status of the pipeline reprocessing. + Status ReprocessingStatus } // The configuration of the resource used to execute the "containerAction". type ResourceConfiguration struct { - // The size (in GB) of the persistent storage available to the resource instance - // used to execute the "containerAction" (min: 1, max: 50). - // - // This member is required. - VolumeSizeInGB *int32 - // The type of the compute resource used to execute the "containerAction". Possible // values are: ACU_1 (vCPU=4, memory=16GiB) or ACU_2 (vCPU=8, memory=32GiB). // // This member is required. ComputeType ComputeType + + // The size (in GB) of the persistent storage available to the resource instance + // used to execute the "containerAction" (min: 1, max: 50). + // + // This member is required. + VolumeSizeInGB *int32 } // How long, in days, message data is kept. type RetentionPeriod struct { - // If true, message data is kept indefinitely. - Unlimited *bool - // The number of days that message data is kept. The "unlimited" parameter must be // false. NumberOfDays *int32 + + // If true, message data is kept indefinitely. + Unlimited *bool } // Configuration information for delivery of data set contents to Amazon S3. type S3DestinationConfiguration struct { - // Configuration information for coordination with the AWS Glue ETL (extract, - // transform and load) service. - GlueConfiguration *GlueConfiguration - - // The ARN of the role which grants AWS IoT Analytics permission to interact with - // your Amazon S3 and AWS Glue resources. + // The name of the Amazon S3 bucket to which data set contents are delivered. // // This member is required. - RoleArn *string + Bucket *string // The key of the data set contents object. Each object in an Amazon S3 bucket has // a key that is its unique identifier within the bucket (each object in a bucket @@ -926,10 +921,15 @@ type S3DestinationConfiguration struct { // This member is required. Key *string - // The name of the Amazon S3 bucket to which data set contents are delivered. + // The ARN of the role which grants AWS IoT Analytics permission to interact with + // your Amazon S3 and AWS Glue resources. // // This member is required. - Bucket *string + RoleArn *string + + // Configuration information for coordination with the AWS Glue ETL (extract, + // transform and load) service. + GlueConfiguration *GlueConfiguration } // The schedule for when to trigger an update. @@ -946,15 +946,15 @@ type Schedule struct { // message. type SelectAttributesActivity struct { - // The name of the 'selectAttributes' activity. + // A list of the attributes to select from the message. // // This member is required. - Name *string + Attributes []*string - // A list of the attributes to select from the message. + // The name of the 'selectAttributes' activity. // // This member is required. - Attributes []*string + Name *string // The next activity in the pipeline. Next *string @@ -985,27 +985,27 @@ type ServiceManagedDatastoreS3StorageSummary struct { // The SQL query to modify the message. type SqlQueryDatasetAction struct { - // Pre-filters applied to message data. - Filters []*QueryFilter - // A SQL query string. // // This member is required. SqlQuery *string + + // Pre-filters applied to message data. + Filters []*QueryFilter } // A set of key/value pairs which are used to manage the resource. type Tag struct { - // The tag's value. + // The tag's key. // // This member is required. - Value *string + Key *string - // The tag's key. + // The tag's value. // // This member is required. - Key *string + Value *string } // Information about the data set whose content generation triggers the new data @@ -1024,23 +1024,23 @@ type TriggeringDataset struct { // "datasetContentVersionValue", or "outputFileUriValue". type Variable struct { - // The value of the variable as a string. - StringValue *string + // The name of the variable. + // + // This member is required. + Name *string - // The value of the variable as a structure that specifies an output file URI. - OutputFileUriValue *OutputFileUriValue + // The value of the variable as a structure that specifies a data set content + // version. + DatasetContentVersionValue *DatasetContentVersionValue // The value of the variable as a double (numeric). DoubleValue *float64 - // The value of the variable as a structure that specifies a data set content - // version. - DatasetContentVersionValue *DatasetContentVersionValue + // The value of the variable as a structure that specifies an output file URI. + OutputFileUriValue *OutputFileUriValue - // The name of the variable. - // - // This member is required. - Name *string + // The value of the variable as a string. + StringValue *string } // Information about the versioning of data set contents. diff --git a/service/iotdataplane/api_op_DeleteThingShadow.go b/service/iotdataplane/api_op_DeleteThingShadow.go index 4a086f7f77d..518bb9fd66e 100644 --- a/service/iotdataplane/api_op_DeleteThingShadow.go +++ b/service/iotdataplane/api_op_DeleteThingShadow.go @@ -60,13 +60,13 @@ func (c *Client) DeleteThingShadow(ctx context.Context, params *DeleteThingShado // The input for the DeleteThingShadow operation. type DeleteThingShadowInput struct { - // The name of the shadow. - ShadowName *string - // The name of the thing. // // This member is required. ThingName *string + + // The name of the shadow. + ShadowName *string } // The output from the DeleteThingShadow operation. diff --git a/service/iotdataplane/api_op_ListNamedShadowsForThing.go b/service/iotdataplane/api_op_ListNamedShadowsForThing.go index b8977b25dce..218288cf754 100644 --- a/service/iotdataplane/api_op_ListNamedShadowsForThing.go +++ b/service/iotdataplane/api_op_ListNamedShadowsForThing.go @@ -56,14 +56,14 @@ func (c *Client) ListNamedShadowsForThing(ctx context.Context, params *ListNamed type ListNamedShadowsForThingInput struct { - // The token to retrieve the next set of results. - NextToken *string - // The name of the thing. // // This member is required. ThingName *string + // The token to retrieve the next set of results. + NextToken *string + // The result page size. PageSize *int32 } diff --git a/service/iotdataplane/api_op_Publish.go b/service/iotdataplane/api_op_Publish.go index 109c04a08c5..7cb0893a6af 100644 --- a/service/iotdataplane/api_op_Publish.go +++ b/service/iotdataplane/api_op_Publish.go @@ -64,11 +64,11 @@ type PublishInput struct { // This member is required. Topic *string - // The Quality of Service (QoS) level. - Qos *int32 - // The state information, in JSON format. Payload []byte + + // The Quality of Service (QoS) level. + Qos *int32 } type PublishOutput struct { diff --git a/service/iotdataplane/api_op_UpdateThingShadow.go b/service/iotdataplane/api_op_UpdateThingShadow.go index 349be689354..632d66bbe3a 100644 --- a/service/iotdataplane/api_op_UpdateThingShadow.go +++ b/service/iotdataplane/api_op_UpdateThingShadow.go @@ -60,9 +60,6 @@ func (c *Client) UpdateThingShadow(ctx context.Context, params *UpdateThingShado // The input for the UpdateThingShadow operation. type UpdateThingShadowInput struct { - // The name of the shadow. - ShadowName *string - // The state information, in JSON format. // // This member is required. @@ -72,6 +69,9 @@ type UpdateThingShadowInput struct { // // This member is required. ThingName *string + + // The name of the shadow. + ShadowName *string } // The output from the UpdateThingShadow operation. diff --git a/service/iotdataplane/go.mod b/service/iotdataplane/go.mod index e96f41f29a2..927def8eec5 100644 --- a/service/iotdataplane/go.mod +++ b/service/iotdataplane/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/iotdataplane go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/iotevents/api_op_CreateDetectorModel.go b/service/iotevents/api_op_CreateDetectorModel.go index 0bc0e04a41c..7694026b8db 100644 --- a/service/iotevents/api_op_CreateDetectorModel.go +++ b/service/iotevents/api_op_CreateDetectorModel.go @@ -57,6 +57,25 @@ func (c *Client) CreateDetectorModel(ctx context.Context, params *CreateDetector type CreateDetectorModelInput struct { + // Information that defines how the detectors operate. + // + // This member is required. + DetectorModelDefinition *types.DetectorModelDefinition + + // The name of the detector model. + // + // This member is required. + DetectorModelName *string + + // The ARN of the role that grants permission to AWS IoT Events to perform its + // operations. + // + // This member is required. + RoleArn *string + + // A brief description of the detector model. + DetectorModelDescription *string + // Information about the order in which events are evaluated and how actions are // executed. EvaluationMethod types.EvaluationMethod @@ -68,27 +87,8 @@ type CreateDetectorModelInput struct { // used to identify the device associated with the input. Key *string - // A brief description of the detector model. - DetectorModelDescription *string - - // Information that defines how the detectors operate. - // - // This member is required. - DetectorModelDefinition *types.DetectorModelDefinition - // Metadata that can be used to manage the detector model. Tags []*types.Tag - - // The ARN of the role that grants permission to AWS IoT Events to perform its - // operations. - // - // This member is required. - RoleArn *string - - // The name of the detector model. - // - // This member is required. - DetectorModelName *string } type CreateDetectorModelOutput struct { diff --git a/service/iotevents/api_op_CreateInput.go b/service/iotevents/api_op_CreateInput.go index 58ff766e7b9..91c805958e2 100644 --- a/service/iotevents/api_op_CreateInput.go +++ b/service/iotevents/api_op_CreateInput.go @@ -57,21 +57,21 @@ func (c *Client) CreateInput(ctx context.Context, params *CreateInputInput, optF type CreateInputInput struct { - // A brief description of the input. - InputDescription *string + // The definition of the input. + // + // This member is required. + InputDefinition *types.InputDefinition // The name you want to give to the input. // // This member is required. InputName *string + // A brief description of the input. + InputDescription *string + // Metadata that can be used to manage the input. Tags []*types.Tag - - // The definition of the input. - // - // This member is required. - InputDefinition *types.InputDefinition } type CreateInputOutput struct { diff --git a/service/iotevents/api_op_DescribeDetectorModel.go b/service/iotevents/api_op_DescribeDetectorModel.go index 60e9567278c..32a8a77863e 100644 --- a/service/iotevents/api_op_DescribeDetectorModel.go +++ b/service/iotevents/api_op_DescribeDetectorModel.go @@ -58,13 +58,13 @@ func (c *Client) DescribeDetectorModel(ctx context.Context, params *DescribeDete type DescribeDetectorModelInput struct { - // The version of the detector model. - DetectorModelVersion *string - // The name of the detector model. // // This member is required. DetectorModelName *string + + // The version of the detector model. + DetectorModelVersion *string } type DescribeDetectorModelOutput struct { diff --git a/service/iotevents/api_op_ListDetectorModelVersions.go b/service/iotevents/api_op_ListDetectorModelVersions.go index a5a17de78b3..acda1c35ccd 100644 --- a/service/iotevents/api_op_ListDetectorModelVersions.go +++ b/service/iotevents/api_op_ListDetectorModelVersions.go @@ -63,22 +63,22 @@ type ListDetectorModelVersionsInput struct { // This member is required. DetectorModelName *string - // The token for the next set of results. - NextToken *string - // The maximum number of results to return at one time. MaxResults *int32 + + // The token for the next set of results. + NextToken *string } type ListDetectorModelVersionsOutput struct { + // Summary information about the detector model versions. + DetectorModelVersionSummaries []*types.DetectorModelVersionSummary + // A token to retrieve the next set of results, or null if there are no additional // results. NextToken *string - // Summary information about the detector model versions. - DetectorModelVersionSummaries []*types.DetectorModelVersionSummary - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotevents/api_op_ListDetectorModels.go b/service/iotevents/api_op_ListDetectorModels.go index 95abe633f8e..43e5213ed8a 100644 --- a/service/iotevents/api_op_ListDetectorModels.go +++ b/service/iotevents/api_op_ListDetectorModels.go @@ -57,11 +57,11 @@ func (c *Client) ListDetectorModels(ctx context.Context, params *ListDetectorMod type ListDetectorModelsInput struct { - // The token for the next set of results. - NextToken *string - // The maximum number of results to return at one time. MaxResults *int32 + + // The token for the next set of results. + NextToken *string } type ListDetectorModelsOutput struct { diff --git a/service/iotevents/api_op_ListInputs.go b/service/iotevents/api_op_ListInputs.go index ca9cde3741a..5928a746d7d 100644 --- a/service/iotevents/api_op_ListInputs.go +++ b/service/iotevents/api_op_ListInputs.go @@ -56,11 +56,11 @@ func (c *Client) ListInputs(ctx context.Context, params *ListInputsInput, optFns type ListInputsInput struct { - // The token for the next set of results. - NextToken *string - // The maximum number of results to return at one time. MaxResults *int32 + + // The token for the next set of results. + NextToken *string } type ListInputsOutput struct { diff --git a/service/iotevents/api_op_UntagResource.go b/service/iotevents/api_op_UntagResource.go index 34efa3e7f21..7f634388d06 100644 --- a/service/iotevents/api_op_UntagResource.go +++ b/service/iotevents/api_op_UntagResource.go @@ -56,15 +56,15 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // A list of the keys of the tags to be removed from the resource. + // The ARN of the resource. // // This member is required. - TagKeys []*string + ResourceArn *string - // The ARN of the resource. + // A list of the keys of the tags to be removed from the resource. // // This member is required. - ResourceArn *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/iotevents/api_op_UpdateDetectorModel.go b/service/iotevents/api_op_UpdateDetectorModel.go index 407bd5df6e0..9a957344002 100644 --- a/service/iotevents/api_op_UpdateDetectorModel.go +++ b/service/iotevents/api_op_UpdateDetectorModel.go @@ -58,9 +58,6 @@ func (c *Client) UpdateDetectorModel(ctx context.Context, params *UpdateDetector type UpdateDetectorModelInput struct { - // A brief description of the detector model. - DetectorModelDescription *string - // Information that defines how a detector operates. // // This member is required. @@ -71,15 +68,18 @@ type UpdateDetectorModelInput struct { // This member is required. DetectorModelName *string - // Information about the order in which events are evaluated and how actions are - // executed. - EvaluationMethod types.EvaluationMethod - // The ARN of the role that grants permission to AWS IoT Events to perform its // operations. // // This member is required. RoleArn *string + + // A brief description of the detector model. + DetectorModelDescription *string + + // Information about the order in which events are evaluated and how actions are + // executed. + EvaluationMethod types.EvaluationMethod } type UpdateDetectorModelOutput struct { diff --git a/service/iotevents/api_op_UpdateInput.go b/service/iotevents/api_op_UpdateInput.go index 99cc8d2e7db..a5433192b4b 100644 --- a/service/iotevents/api_op_UpdateInput.go +++ b/service/iotevents/api_op_UpdateInput.go @@ -57,6 +57,11 @@ func (c *Client) UpdateInput(ctx context.Context, params *UpdateInputInput, optF type UpdateInputInput struct { + // The definition of the input. + // + // This member is required. + InputDefinition *types.InputDefinition + // The name of the input you want to update. // // This member is required. @@ -64,11 +69,6 @@ type UpdateInputInput struct { // A brief description of the input. InputDescription *string - - // The definition of the input. - // - // This member is required. - InputDefinition *types.InputDefinition } type UpdateInputOutput struct { diff --git a/service/iotevents/go.mod b/service/iotevents/go.mod index 0e09d749bbf..cfcbfbd34f3 100644 --- a/service/iotevents/go.mod +++ b/service/iotevents/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/iotevents go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/iotevents/types/types.go b/service/iotevents/types/types.go index 26b0cb15215..e56252c9c38 100644 --- a/service/iotevents/types/types.go +++ b/service/iotevents/types/types.go @@ -9,65 +9,65 @@ import ( // An action to be performed when the condition is TRUE. type Action struct { - // Sends information about the detector model instance and the event that triggered - // the action to an Amazon Kinesis Data Firehose delivery stream. - Firehose *FirehoseAction - - // Publishes an MQTT message with the given topic to the AWS IoT message broker. - IotTopicPublish *IotTopicPublishAction + // Information needed to clear the timer. + ClearTimer *ClearTimerAction // Writes to the DynamoDB table that you created. The default action payload // contains all attribute-value pairs that have the information about the detector // model instance and the event that triggered the action. You can also customize // the payload - // (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A - // separate column of the DynamoDB table receives one attribute-value pair in the + // (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). + // One column of the DynamoDB table receives all attribute-value pairs in the // payload that you specify. For more information, see Actions // (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html) // in AWS IoT Events Developer Guide. - DynamoDBv2 *DynamoDBv2Action - - // Information needed to set the timer. - SetTimer *SetTimerAction - - // Information needed to clear the timer. - ClearTimer *ClearTimerAction + DynamoDB *DynamoDBAction // Writes to the DynamoDB table that you created. The default action payload // contains all attribute-value pairs that have the information about the detector // model instance and the event that triggered the action. You can also customize // the payload - // (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). - // One column of the DynamoDB table receives all attribute-value pairs in the + // (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A + // separate column of the DynamoDB table receives one attribute-value pair in the // payload that you specify. For more information, see Actions // (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html) // in AWS IoT Events Developer Guide. - DynamoDB *DynamoDBAction - - // Information needed to reset the timer. - ResetTimer *ResetTimerAction + DynamoDBv2 *DynamoDBv2Action - // Sends an Amazon SNS message. - Sns *SNSTopicPublishAction + // Sends information about the detector model instance and the event that triggered + // the action to an Amazon Kinesis Data Firehose delivery stream. + Firehose *FirehoseAction - // Sets a variable to a specified value. - SetVariable *SetVariableAction + // Sends AWS IoT Events input, which passes information about the detector model + // instance and the event that triggered the action. + IotEvents *IotEventsAction // Sends information about the detector model instance and the event that triggered - // the action to an Amazon SQS queue. - Sqs *SqsAction + // the action to an asset property in AWS IoT SiteWise . + IotSiteWise *IotSiteWiseAction + + // Publishes an MQTT message with the given topic to the AWS IoT message broker. + IotTopicPublish *IotTopicPublishAction // Calls a Lambda function, passing in information about the detector model // instance and the event that triggered the action. Lambda *LambdaAction - // Sends AWS IoT Events input, which passes information about the detector model - // instance and the event that triggered the action. - IotEvents *IotEventsAction + // Information needed to reset the timer. + ResetTimer *ResetTimerAction + + // Information needed to set the timer. + SetTimer *SetTimerAction + + // Sets a variable to a specified value. + SetVariable *SetVariableAction + + // Sends an Amazon SNS message. + Sns *SNSTopicPublishAction // Sends information about the detector model instance and the event that triggered - // the action to an asset property in AWS IoT SiteWise . - IotSiteWise *IotSiteWiseAction + // the action to an Amazon SQS queue. + Sqs *SqsAction } // A structure that contains timestamp information. For more information, see @@ -87,15 +87,15 @@ type Action struct { // in the AWS IoT Events Developer Guide. type AssetPropertyTimestamp struct { - // The nanosecond offset converted from timeInSeconds. The valid range is between - // 0-999999999. You can also specify an expression. - OffsetInNanos *string - // The timestamp, in seconds, in the Unix epoch format. The valid range is between // 1-31556889864403199. You can also specify an expression. // // This member is required. TimeInSeconds *string + + // The nanosecond offset converted from timeInSeconds. The valid range is between + // 0-999999999. You can also specify an expression. + OffsetInNanos *string } // A structure that contains value information. For more information, see @@ -119,13 +119,13 @@ type AssetPropertyValue struct { // This member is required. Value *AssetPropertyVariant - // The timestamp associated with the asset property value. The default is the - // current event time. - Timestamp *AssetPropertyTimestamp - // The quality of the asset property value. The value must be GOOD, BAD, or // UNCERTAIN. You can also specify an expression. Quality *string + + // The timestamp associated with the asset property value. The default is the + // current event time. + Timestamp *AssetPropertyTimestamp } // A structure that contains an asset property value. For more information, see @@ -157,13 +157,13 @@ type AssetPropertyVariant struct { // use an expression, the evaluated result should be a double. DoubleValue *string - // The asset property value is a string. You can also specify an expression. If you - // use an expression, the evaluated result should be a string. - StringValue *string - // The asset property value is an integer. You can also specify an expression. If // you use an expression, the evaluated result should be an integer. IntegerValue *string + + // The asset property value is a string. You can also specify an expression. If you + // use an expression, the evaluated result should be a string. + StringValue *string } // The attributes from the JSON payload that are made available by the input. @@ -197,14 +197,14 @@ type ClearTimerAction struct { // level is given. type DetectorDebugOption struct { - // The value of the input attribute key used to create the detector (the instance - // of the detector model). - KeyValue *string - // The name of the detector model. // // This member is required. DetectorModelName *string + + // The value of the input attribute key used to create the detector (the instance + // of the detector model). + KeyValue *string } // Information about the detector model. @@ -223,23 +223,22 @@ type DetectorModelConfiguration struct { // The time the detector model was created. CreationTime *time.Time - // Information about the order in which events are evaluated and how actions are - // executed. - EvaluationMethod EvaluationMethod - - // The ARN of the role that grants permission to AWS IoT Events to perform its - // operations. - RoleArn *string - - // The version of the detector model. - DetectorModelVersion *string - // The ARN of the detector model. DetectorModelArn *string + // A brief description of the detector model. + DetectorModelDescription *string + // The name of the detector model. DetectorModelName *string + // The version of the detector model. + DetectorModelVersion *string + + // Information about the order in which events are evaluated and how actions are + // executed. + EvaluationMethod EvaluationMethod + // The value used to identify a detector instance. When a device or system sends // input, a new detector instance with a unique key value is created. AWS IoT // Events can continue to route input to its corresponding detector instance based @@ -249,14 +248,15 @@ type DetectorModelConfiguration struct { // device must send a message payload that contains the same attribute-value. Key *string - // A brief description of the detector model. - DetectorModelDescription *string + // The time the detector model was last updated. + LastUpdateTime *time.Time + + // The ARN of the role that grants permission to AWS IoT Events to perform its + // operations. + RoleArn *string // The status of the detector model. Status DetectorModelVersionStatus - - // The time the detector model was last updated. - LastUpdateTime *time.Time } // Information that defines how a detector operates. @@ -289,11 +289,8 @@ type DetectorModelSummary struct { // Information about the detector model version. type DetectorModelVersionSummary struct { - // The last time the detector model version was updated. - LastUpdateTime *time.Time - - // The status of the detector model version. - Status DetectorModelVersionStatus + // The time the detector model version was created. + CreationTime *time.Time // The ARN of the detector model version. DetectorModelArn *string @@ -308,12 +305,15 @@ type DetectorModelVersionSummary struct { // executed. EvaluationMethod EvaluationMethod - // The time the detector model version was created. - CreationTime *time.Time + // The last time the detector model version was updated. + LastUpdateTime *time.Time // The ARN of the role that grants the detector model permission to perform its // tasks. RoleArn *string + + // The status of the detector model version. + Status DetectorModelVersionStatus } // Defines an action to write to the Amazon DynamoDB table that you created. The @@ -336,29 +336,20 @@ type DetectorModelVersionSummary struct { // _raw. type DynamoDBAction struct { - // The value of the range key (also called the sort key). - RangeKeyValue *string - - // The name of the DynamoDB column that receives the action payload. If you don't - // specify this parameter, the name of the DynamoDB column is payload. - PayloadField *string - - // The name of the DynamoDB table. + // The name of the hash key (also called the partition key). // // This member is required. - TableName *string + HashKeyField *string // The value of the hash key (also called the partition key). // // This member is required. HashKeyValue *string - // Information needed to configure the payload. By default, AWS IoT Events - // generates a standard payload in JSON for any action. This action payload - // contains all attribute-value pairs that have the information about the detector - // model instance and the event triggered the action. To configure the action - // payload, you can use contentExpression. - Payload *Payload + // The name of the DynamoDB table. + // + // This member is required. + TableName *string // The data type for the hash key (also called the partition key). You can specify // the following values: @@ -372,23 +363,6 @@ type DynamoDBAction struct { // is STRING. HashKeyType *string - // The name of the hash key (also called the partition key). - // - // This member is required. - HashKeyField *string - - // The data type for the range key (also called the sort key), You can specify the - // following values: - // - // * STRING - The range key is a string. - // - // * NUMBER - The - // range key is number. - // - // If you don't specify rangeKeyField, the default value is - // STRING. - RangeKeyType *string - // The type of operation to perform. You can specify the following values: // // * @@ -409,8 +383,34 @@ type DynamoDBAction struct { // parameter, AWS IoT Events triggers the INSERT operation. Operation *string + // Information needed to configure the payload. By default, AWS IoT Events + // generates a standard payload in JSON for any action. This action payload + // contains all attribute-value pairs that have the information about the detector + // model instance and the event triggered the action. To configure the action + // payload, you can use contentExpression. + Payload *Payload + + // The name of the DynamoDB column that receives the action payload. If you don't + // specify this parameter, the name of the DynamoDB column is payload. + PayloadField *string + // The name of the range key (also called the sort key). RangeKeyField *string + + // The data type for the range key (also called the sort key), You can specify the + // following values: + // + // * STRING - The range key is a string. + // + // * NUMBER - The + // range key is number. + // + // If you don't specify rangeKeyField, the default value is + // STRING. + RangeKeyType *string + + // The value of the range key (also called the sort key). + RangeKeyValue *string } // Defines an action to write to the Amazon DynamoDB table that you created. The @@ -488,6 +488,11 @@ type Input struct { // Information about the configuration of an input. type InputConfiguration struct { + // The time the input was created. + // + // This member is required. + CreationTime *time.Time + // The ARN of the input. // // This member is required. @@ -498,23 +503,18 @@ type InputConfiguration struct { // This member is required. InputName *string - // The status of the input. + // The last time the input was updated. // // This member is required. - Status InputStatus + LastUpdateTime *time.Time - // The last time the input was updated. + // The status of the input. // // This member is required. - LastUpdateTime *time.Time + Status InputStatus // A brief description of the input. InputDescription *string - - // The time the input was created. - // - // This member is required. - CreationTime *time.Time } // The definition of the input. @@ -533,37 +533,37 @@ type InputDefinition struct { // Information about the input. type InputSummary struct { + // The time the input was created. + CreationTime *time.Time + // The ARN of the input. InputArn *string - // The time the input was created. - CreationTime *time.Time + // A brief description of the input. + InputDescription *string // The name of the input. InputName *string - // The status of the input. - Status InputStatus - // The last time the input was updated. LastUpdateTime *time.Time - // A brief description of the input. - InputDescription *string + // The status of the input. + Status InputStatus } // Sends an AWS IoT Events input, passing in information about the detector model // instance and the event that triggered the action. type IotEventsAction struct { - // You can configure the action payload when you send a message to an AWS IoT - // Events input. - Payload *Payload - // The name of the AWS IoT Events input where the data is sent. // // This member is required. InputName *string + + // You can configure the action payload when you send a message to an AWS IoT + // Events input. + Payload *Payload } // Sends information about the detector model instance and the event that triggered @@ -583,78 +583,78 @@ type IotEventsAction struct { // in the AWS IoT Events Developer Guide. type IotSiteWiseAction struct { - // The ID of the asset property. You can specify an expression. - PropertyId *string - - // A unique identifier for this entry. You can use the entry ID to track which data - // entry causes an error in case of failure. The default is a new unique - // identifier. You can also specify an expression. - EntryId *string - // The value to send to the asset property. This value contains timestamp, quality, // and value (TQV) information. // // This member is required. PropertyValue *AssetPropertyValue - // The alias of the asset property. You can also specify an expression. - PropertyAlias *string - // The ID of the asset that has the specified property. You can specify an // expression. AssetId *string + + // A unique identifier for this entry. You can use the entry ID to track which data + // entry causes an error in case of failure. The default is a new unique + // identifier. You can also specify an expression. + EntryId *string + + // The alias of the asset property. You can also specify an expression. + PropertyAlias *string + + // The ID of the asset property. You can specify an expression. + PropertyId *string } // Information required to publish the MQTT message through the AWS IoT message // broker. type IotTopicPublishAction struct { - // You can configure the action payload when you publish a message to an AWS IoT - // Core topic. - Payload *Payload - // The MQTT topic of the message. You can use a string expression that includes // variables ($variable.) and input values ($input..) as the topic string. // // This member is required. MqttTopic *string + + // You can configure the action payload when you publish a message to an AWS IoT + // Core topic. + Payload *Payload } // Calls a Lambda function, passing in information about the detector model // instance and the event that triggered the action. type LambdaAction struct { - // You can configure the action payload when you send a message to a Lambda - // function. - Payload *Payload - // The ARN of the Lambda function that is executed. // // This member is required. FunctionArn *string + + // You can configure the action payload when you send a message to a Lambda + // function. + Payload *Payload } // The values of the AWS IoT Events logging options. type LoggingOptions struct { - // The ARN of the role that grants permission to AWS IoT Events to perform logging. + // If TRUE, logging is enabled for AWS IoT Events. // // This member is required. - RoleArn *string + Enabled *bool // The logging level. // // This member is required. Level LoggingLevel + // The ARN of the role that grants permission to AWS IoT Events to perform logging. + // + // This member is required. + RoleArn *string + // Information that identifies those detector models and their detectors // (instances) for which the logging level is given. DetectorDebugOptions []*DetectorDebugOption - - // If TRUE, logging is enabled for AWS IoT Events. - // - // This member is required. - Enabled *bool } // When entering this state, perform these actions if the condition is TRUE. @@ -677,12 +677,12 @@ type OnExitLifecycle struct { // Specifies the actions performed when the condition evaluates to TRUE. type OnInputLifecycle struct { + // Specifies the actions performed when the condition evaluates to TRUE. + Events []*Event + // Specifies the actions performed, and the next state entered, when a condition // evaluates to TRUE. TransitionEvents []*TransitionEvent - - // Specifies the actions performed when the condition evaluates to TRUE. - Events []*Event } // Information needed to configure the payload. By default, AWS IoT Events @@ -720,10 +720,6 @@ type ResetTimerAction struct { // Information needed to set the timer. type SetTimerAction struct { - // The number of seconds until the timer expires. The minimum value is 60 seconds - // to ensure accuracy. The maximum value is 31622400 seconds. - Seconds *int32 - // The name of the timer. // // This member is required. @@ -735,6 +731,10 @@ type SetTimerAction struct { // the minimum duration is 60 seconds. The evaluated result of the duration is // rounded down to the nearest whole number. DurationExpression *string + + // The number of seconds until the timer expires. The minimum value is 60 seconds + // to ensure accuracy. The maximum value is 31622400 seconds. + Seconds *int32 } // Information about the variable and its new value. @@ -754,20 +754,25 @@ type SetVariableAction struct { // Information required to publish the Amazon SNS message. type SNSTopicPublishAction struct { - // You can configure the action payload when you send a message as an Amazon SNS - // push notification. - Payload *Payload - // The ARN of the Amazon SNS target where the message is sent. // // This member is required. TargetArn *string + + // You can configure the action payload when you send a message as an Amazon SNS + // push notification. + Payload *Payload } // Sends information about the detector model instance and the event that triggered // the action to an Amazon SQS queue. type SqsAction struct { + // The URL of the SQS queue where the data is written. + // + // This member is required. + QueueUrl *string + // You can configure the action payload when you send a message to an Amazon SQS // queue. Payload *Payload @@ -775,45 +780,40 @@ type SqsAction struct { // Set this to TRUE if you want the data to be base-64 encoded before it is written // to the queue. Otherwise, set this to FALSE. UseBase64 *bool - - // The URL of the SQS queue where the data is written. - // - // This member is required. - QueueUrl *string } // Information that defines a state of a detector. type State struct { - // When entering this state, perform these actions if the condition is TRUE. - OnEnter *OnEnterLifecycle - - // When an input is received and the condition is TRUE, perform the specified - // actions. - OnInput *OnInputLifecycle - // The name of the state. // // This member is required. StateName *string + // When entering this state, perform these actions if the condition is TRUE. + OnEnter *OnEnterLifecycle + // When exiting this state, perform these actions if the specified condition is // TRUE. OnExit *OnExitLifecycle + + // When an input is received and the condition is TRUE, perform the specified + // actions. + OnInput *OnInputLifecycle } // Metadata that can be used to manage the resource. type Tag struct { - // The tag's value. + // The tag's key. // // This member is required. - Value *string + Key *string - // The tag's key. + // The tag's value. // // This member is required. - Key *string + Value *string } // Specifies the actions performed and the next state entered when a condition @@ -831,11 +831,11 @@ type TransitionEvent struct { // This member is required. EventName *string - // The actions to be performed. - Actions []*Action - // The next state to enter. // // This member is required. NextState *string + + // The actions to be performed. + Actions []*Action } diff --git a/service/ioteventsdata/api_op_ListDetectors.go b/service/ioteventsdata/api_op_ListDetectors.go index 3b9d1073024..573ecb21a76 100644 --- a/service/ioteventsdata/api_op_ListDetectors.go +++ b/service/ioteventsdata/api_op_ListDetectors.go @@ -57,19 +57,19 @@ func (c *Client) ListDetectors(ctx context.Context, params *ListDetectorsInput, type ListDetectorsInput struct { - // A filter that limits results to those detectors (instances) in the given state. - StateName *string - // The name of the detector model whose detectors (instances) are listed. // // This member is required. DetectorModelName *string + // The maximum number of results to return at one time. + MaxResults *int32 + // The token for the next set of results. NextToken *string - // The maximum number of results to return at one time. - MaxResults *int32 + // A filter that limits results to those detectors (instances) in the given state. + StateName *string } type ListDetectorsOutput struct { diff --git a/service/ioteventsdata/go.mod b/service/ioteventsdata/go.mod index 6fc2527e774..820bb22e5d3 100644 --- a/service/ioteventsdata/go.mod +++ b/service/ioteventsdata/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/ioteventsdata go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/ioteventsdata/types/types.go b/service/ioteventsdata/types/types.go index 2f15bc5da8d..561545fbc95 100644 --- a/service/ioteventsdata/types/types.go +++ b/service/ioteventsdata/types/types.go @@ -9,26 +9,26 @@ import ( // Contains information about the errors encountered. type BatchPutMessageErrorEntry struct { - // The ID of the message that caused the error. (See the value corresponding to the - // "messageId" key in the "message" object.) - MessageId *string - // The code associated with the error. ErrorCode ErrorCode // More information about the error. ErrorMessage *string + + // The ID of the message that caused the error. (See the value corresponding to the + // "messageId" key in the "message" object.) + MessageId *string } // Information about the error that occured when attempting to update a detector. type BatchUpdateDetectorErrorEntry struct { - // A message describing the error. - ErrorMessage *string - // The code of the error. ErrorCode ErrorCode + // A message describing the error. + ErrorMessage *string + // The "messageId" of the update request that caused the error. (The value of the // "messageId" in the update request "Detector" object.) MessageId *string @@ -37,16 +37,6 @@ type BatchUpdateDetectorErrorEntry struct { // Information about the detector (instance). type Detector struct { - // The time the detector (instance) was last updated. - LastUpdateTime *time.Time - - // The current state of the detector (instance). - State *DetectorState - - // The value of the key (identifying the device or system) that caused the creation - // of this detector (instance). - KeyValue *string - // The time the detector (instance) was created. CreationTime *time.Time @@ -55,6 +45,16 @@ type Detector struct { // The version of the detector model that created this detector (instance). DetectorModelVersion *string + + // The value of the key (identifying the device or system) that caused the creation + // of this detector (instance). + KeyValue *string + + // The time the detector (instance) was last updated. + LastUpdateTime *time.Time + + // The current state of the detector (instance). + State *DetectorState } // Information about the current state of the detector instance. @@ -79,11 +79,10 @@ type DetectorState struct { // The new state, variable values, and timer settings of the detector (instance). type DetectorStateDefinition struct { - // The new values of the detector's variables. Any variable whose value isn't - // specified is cleared. + // The name of the new state of the detector (instance). // // This member is required. - Variables []*VariableDefinition + StateName *string // The new values of the detector's timers. Any timer whose value isn't specified // is cleared, and its timeout event won't occur. @@ -91,10 +90,11 @@ type DetectorStateDefinition struct { // This member is required. Timers []*TimerDefinition - // The name of the new state of the detector (instance). + // The new values of the detector's variables. Any variable whose value isn't + // specified is cleared. // // This member is required. - StateName *string + Variables []*VariableDefinition } // Information about the detector state. @@ -110,8 +110,11 @@ type DetectorSummary struct { // The time the detector (instance) was created. CreationTime *time.Time - // The current state of the detector (instance). - State *DetectorStateSummary + // The name of the detector model that created this detector (instance). + DetectorModelName *string + + // The version of the detector model that created this detector (instance). + DetectorModelVersion *string // The value of the key (identifying the device or system) that caused the creation // of this detector (instance). @@ -120,16 +123,18 @@ type DetectorSummary struct { // The time the detector (instance) was last updated. LastUpdateTime *time.Time - // The name of the detector model that created this detector (instance). - DetectorModelName *string - - // The version of the detector model that created this detector (instance). - DetectorModelVersion *string + // The current state of the detector (instance). + State *DetectorStateSummary } // Information about a message. type Message struct { + // The name of the input into which the message payload is transformed. + // + // This member is required. + InputName *string + // The ID to assign to the message. Within each batch sent, each "messageId" must // be unique. // @@ -141,44 +146,44 @@ type Message struct { // // This member is required. Payload []byte - - // The name of the input into which the message payload is transformed. - // - // This member is required. - InputName *string } // The current state of a timer. type Timer struct { - // The number of seconds which have elapsed on the timer. + // The name of the timer. // // This member is required. - Timestamp *time.Time + Name *string - // The name of the timer. + // The number of seconds which have elapsed on the timer. // // This member is required. - Name *string + Timestamp *time.Time } // The new setting of a timer. type TimerDefinition struct { - // The new setting of the timer (the number of seconds before the timer elapses). + // The name of the timer. // // This member is required. - Seconds *int32 + Name *string - // The name of the timer. + // The new setting of the timer (the number of seconds before the timer elapses). // // This member is required. - Name *string + Seconds *int32 } // Information used to update the detector (instance). type UpdateDetectorRequest struct { + // The name of the detector model that created the detectors (instances). + // + // This member is required. + DetectorModelName *string + // The ID to assign to the detector update "message". Each "messageId" must be // unique within each batch sent. // @@ -193,11 +198,6 @@ type UpdateDetectorRequest struct { // The value of the input key attribute (identifying the device or system) that // caused the creation of this detector (instance). KeyValue *string - - // The name of the detector model that created the detectors (instances). - // - // This member is required. - DetectorModelName *string } // The current state of the variable. @@ -217,13 +217,13 @@ type Variable struct { // The new value of the variable. type VariableDefinition struct { - // The new value of the variable. + // The name of the variable. // // This member is required. - Value *string + Name *string - // The name of the variable. + // The new value of the variable. // // This member is required. - Name *string + Value *string } diff --git a/service/iotjobsdataplane/api_op_DescribeJobExecution.go b/service/iotjobsdataplane/api_op_DescribeJobExecution.go index d5d49501cb6..76071b7ab7e 100644 --- a/service/iotjobsdataplane/api_op_DescribeJobExecution.go +++ b/service/iotjobsdataplane/api_op_DescribeJobExecution.go @@ -62,15 +62,15 @@ type DescribeJobExecutionInput struct { // This member is required. JobId *string - // Optional. A number that identifies a particular job execution on a particular - // device. If not specified, the latest job execution is returned. - ExecutionNumber *int64 - // The thing name associated with the device the job execution is running on. // // This member is required. ThingName *string + // Optional. A number that identifies a particular job execution on a particular + // device. If not specified, the latest job execution is returned. + ExecutionNumber *int64 + // Optional. When set to true, the response contains the job document. The default // is false. IncludeJobDocument *bool diff --git a/service/iotjobsdataplane/api_op_StartNextPendingJobExecution.go b/service/iotjobsdataplane/api_op_StartNextPendingJobExecution.go index 14ef1b8b2af..051004d21bc 100644 --- a/service/iotjobsdataplane/api_op_StartNextPendingJobExecution.go +++ b/service/iotjobsdataplane/api_op_StartNextPendingJobExecution.go @@ -58,6 +58,15 @@ func (c *Client) StartNextPendingJobExecution(ctx context.Context, params *Start type StartNextPendingJobExecutionInput struct { + // The name of the thing associated with the device. + // + // This member is required. + ThingName *string + + // A collection of name/value pairs that describe the status of the job execution. + // If not specified, the statusDetails are unchanged. + StatusDetails map[string]*string + // Specifies the amount of time this device has to finish execution of this job. If // the job execution status is not set to a terminal state before this timer // expires, or before the timer is reset (by calling UpdateJobExecution, setting @@ -67,15 +76,6 @@ type StartNextPendingJobExecutionInput struct { // timeout which may have been specified when the job was created (CreateJob using // field timeoutConfig). StepTimeoutInMinutes *int64 - - // The name of the thing associated with the device. - // - // This member is required. - ThingName *string - - // A collection of name/value pairs that describe the status of the job execution. - // If not specified, the statusDetails are unchanged. - StatusDetails map[string]*string } type StartNextPendingJobExecutionOutput struct { diff --git a/service/iotjobsdataplane/api_op_UpdateJobExecution.go b/service/iotjobsdataplane/api_op_UpdateJobExecution.go index 748bba1ad7a..fdc72649bc1 100644 --- a/service/iotjobsdataplane/api_op_UpdateJobExecution.go +++ b/service/iotjobsdataplane/api_op_UpdateJobExecution.go @@ -68,9 +68,14 @@ type UpdateJobExecutionInput struct { // This member is required. Status types.JobExecutionStatus - // Optional. A collection of name/value pairs that describe the status of the job - // execution. If not specified, the statusDetails are unchanged. - StatusDetails map[string]*string + // The name of the thing associated with the device. + // + // This member is required. + ThingName *string + + // Optional. A number that identifies a particular job execution on a particular + // device. + ExecutionNumber *int64 // Optional. The expected current version of the job execution. Each time you // update the job execution, its version is incremented. If the version of the job @@ -81,13 +86,17 @@ type UpdateJobExecutionInput struct { // status data.) ExpectedVersion *int64 + // Optional. When set to true, the response contains the job document. The default + // is false. + IncludeJobDocument *bool + // Optional. When included and set to true, the response contains the // JobExecutionState data. The default is false. IncludeJobExecutionState *bool - // Optional. When set to true, the response contains the job document. The default - // is false. - IncludeJobDocument *bool + // Optional. A collection of name/value pairs that describe the status of the job + // execution. If not specified, the statusDetails are unchanged. + StatusDetails map[string]*string // Specifies the amount of time this device has to finish execution of this job. If // the job execution status is not set to a terminal state before this timer @@ -98,15 +107,6 @@ type UpdateJobExecutionInput struct { // timeout which may have been specified when the job was created (CreateJob using // field timeoutConfig). StepTimeoutInMinutes *int64 - - // Optional. A number that identifies a particular job execution on a particular - // device. - ExecutionNumber *int64 - - // The name of the thing associated with the device. - // - // This member is required. - ThingName *string } type UpdateJobExecutionOutput struct { diff --git a/service/iotjobsdataplane/go.mod b/service/iotjobsdataplane/go.mod index 856b6412a3f..680706051bd 100644 --- a/service/iotjobsdataplane/go.mod +++ b/service/iotjobsdataplane/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/iotjobsdataplane go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/iotjobsdataplane/types/types.go b/service/iotjobsdataplane/types/types.go index 426945f1d78..d506d75260b 100644 --- a/service/iotjobsdataplane/types/types.go +++ b/service/iotjobsdataplane/types/types.go @@ -5,55 +5,55 @@ package types // Contains data about a job execution. type JobExecution struct { - // The version of the job execution. Job execution versions are incremented each - // time they are updated by a device. - VersionNumber *int64 - - // The unique identifier you assigned to this job when it was created. - JobId *string + // The estimated number of seconds that remain before the job execution status will + // be changed to TIMED_OUT. + ApproximateSecondsBeforeTimedOut *int64 - // The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", - // "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED". - Status JobExecutionStatus + // A number that identifies a particular job execution on a particular device. It + // can be used later in commands that return or update job execution information. + ExecutionNumber *int64 // The content of the job document. JobDocument *string + // The unique identifier you assigned to this job when it was created. + JobId *string + + // The time, in milliseconds since the epoch, when the job execution was last + // updated. + LastUpdatedAt *int64 + // The time, in milliseconds since the epoch, when the job execution was enqueued. QueuedAt *int64 - // A collection of name/value pairs that describe the status of the job execution. - StatusDetails map[string]*string - // The time, in milliseconds since the epoch, when the job execution was started. StartedAt *int64 - // The estimated number of seconds that remain before the job execution status will - // be changed to TIMED_OUT. - ApproximateSecondsBeforeTimedOut *int64 + // The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", + // "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED". + Status JobExecutionStatus + + // A collection of name/value pairs that describe the status of the job execution. + StatusDetails map[string]*string // The name of the thing that is executing the job. ThingName *string - // A number that identifies a particular job execution on a particular device. It - // can be used later in commands that return or update job execution information. - ExecutionNumber *int64 - - // The time, in milliseconds since the epoch, when the job execution was last - // updated. - LastUpdatedAt *int64 + // The version of the job execution. Job execution versions are incremented each + // time they are updated by a device. + VersionNumber *int64 } // Contains data about the state of a job execution. type JobExecutionState struct { - // A collection of name/value pairs that describe the status of the job execution. - StatusDetails map[string]*string - // The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", // "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED". Status JobExecutionStatus + // A collection of name/value pairs that describe the status of the job execution. + StatusDetails map[string]*string + // The version of the job execution. Job execution versions are incremented each // time they are updated by a device. VersionNumber *int64 @@ -62,23 +62,23 @@ type JobExecutionState struct { // Contains a subset of information about a job execution. type JobExecutionSummary struct { + // A number that identifies a particular job execution on a particular device. + ExecutionNumber *int64 + // The unique identifier you assigned to this job when it was created. JobId *string + // The time, in milliseconds since the epoch, when the job execution was last + // updated. + LastUpdatedAt *int64 + // The time, in milliseconds since the epoch, when the job execution was enqueued. QueuedAt *int64 - // The version of the job execution. Job execution versions are incremented each - // time AWS IoT Jobs receives an update from a device. - VersionNumber *int64 - // The time, in milliseconds since the epoch, when the job execution started. StartedAt *int64 - // A number that identifies a particular job execution on a particular device. - ExecutionNumber *int64 - - // The time, in milliseconds since the epoch, when the job execution was last - // updated. - LastUpdatedAt *int64 + // The version of the job execution. Job execution versions are incremented each + // time AWS IoT Jobs receives an update from a device. + VersionNumber *int64 } diff --git a/service/iotsecuretunneling/api_op_ListTunnels.go b/service/iotsecuretunneling/api_op_ListTunnels.go index 00cc7205532..03b3195c49a 100644 --- a/service/iotsecuretunneling/api_op_ListTunnels.go +++ b/service/iotsecuretunneling/api_op_ListTunnels.go @@ -57,14 +57,14 @@ func (c *Client) ListTunnels(ctx context.Context, params *ListTunnelsInput, optF type ListTunnelsInput struct { - // The name of the IoT thing associated with the destination device. - ThingName *string - // The maximum number of results to return at once. MaxResults *int32 // A token to retrieve the next set of results. NextToken *string + + // The name of the IoT thing associated with the destination device. + ThingName *string } type ListTunnelsOutput struct { diff --git a/service/iotsecuretunneling/api_op_OpenTunnel.go b/service/iotsecuretunneling/api_op_OpenTunnel.go index ef99f877f19..939965a83b1 100644 --- a/service/iotsecuretunneling/api_op_OpenTunnel.go +++ b/service/iotsecuretunneling/api_op_OpenTunnel.go @@ -58,25 +58,21 @@ func (c *Client) OpenTunnel(ctx context.Context, params *OpenTunnelInput, optFns type OpenTunnelInput struct { + // A short text description of the tunnel. + Description *string + + // The destination configuration for the OpenTunnel request. + DestinationConfig *types.DestinationConfig + // A collection of tag metadata. Tags []*types.Tag // Timeout configuration for a tunnel. TimeoutConfig *types.TimeoutConfig - - // The destination configuration for the OpenTunnel request. - DestinationConfig *types.DestinationConfig - - // A short text description of the tunnel. - Description *string } type OpenTunnelOutput struct { - // The Amazon Resource Name for the tunnel. The tunnel ARN format is - // arn:aws:tunnel:::tunnel/ - TunnelArn *string - // The access token the destination local proxy uses to connect to AWS IoT Secure // Tunneling. DestinationAccessToken *string @@ -85,6 +81,10 @@ type OpenTunnelOutput struct { // Tunneling. SourceAccessToken *string + // The Amazon Resource Name for the tunnel. The tunnel ARN format is + // arn:aws:tunnel:::tunnel/ + TunnelArn *string + // A unique alpha-numeric tunnel ID. TunnelId *string diff --git a/service/iotsecuretunneling/api_op_TagResource.go b/service/iotsecuretunneling/api_op_TagResource.go index 9e7a8057487..eb69a2c8a72 100644 --- a/service/iotsecuretunneling/api_op_TagResource.go +++ b/service/iotsecuretunneling/api_op_TagResource.go @@ -57,15 +57,15 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The tags for the resource. + // The ARN of the resource. // // This member is required. - Tags []*types.Tag + ResourceArn *string - // The ARN of the resource. + // The tags for the resource. // // This member is required. - ResourceArn *string + Tags []*types.Tag } type TagResourceOutput struct { diff --git a/service/iotsecuretunneling/api_op_UntagResource.go b/service/iotsecuretunneling/api_op_UntagResource.go index 8405371e4a6..03cb100ef28 100644 --- a/service/iotsecuretunneling/api_op_UntagResource.go +++ b/service/iotsecuretunneling/api_op_UntagResource.go @@ -56,15 +56,15 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The keys of the tags to remove. + // The resource ARN. // // This member is required. - TagKeys []*string + ResourceArn *string - // The resource ARN. + // The keys of the tags to remove. // // This member is required. - ResourceArn *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/iotsecuretunneling/go.mod b/service/iotsecuretunneling/go.mod index 35c0d0e6952..2bb95c46ab1 100644 --- a/service/iotsecuretunneling/go.mod +++ b/service/iotsecuretunneling/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/iotsecuretunneling go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/iotsecuretunneling/types/types.go b/service/iotsecuretunneling/types/types.go index 4b524b780ae..0aa894ed319 100644 --- a/service/iotsecuretunneling/types/types.go +++ b/service/iotsecuretunneling/types/types.go @@ -9,22 +9,17 @@ import ( // The state of a connection. type ConnectionState struct { + // The last time the connection status was updated. + LastUpdatedAt *time.Time + // The connection status of the tunnel. Valid values are CONNECTED and // DISCONNECTED. Status ConnectionStatus - - // The last time the connection status was updated. - LastUpdatedAt *time.Time } // The destination configuration. type DestinationConfig struct { - // The name of the IoT thing to which you want to connect. - // - // This member is required. - ThingName *string - // A list of service names that identity the target application. Currently, you can // only specify a single name. The AWS IoT client running on the destination device // reads this value and uses it to look up a port or an IP address and a port. The @@ -33,6 +28,11 @@ type DestinationConfig struct { // // This member is required. Services []*string + + // The name of the IoT thing to which you want to connect. + // + // This member is required. + ThingName *string } // An arbitary key/value pair used to add searchable metadata to secure tunnel @@ -65,12 +65,16 @@ type Tunnel struct { // The time when the tunnel was created. CreatedAt *time.Time - // Timeout configuration for the tunnel. - TimeoutConfig *TimeoutConfig + // A description of the tunnel. + Description *string - // The Amazon Resource Name (ARN) of a tunnel. The tunnel ARN format is - // arn:aws:tunnel:::tunnel/ - TunnelArn *string + // The destination configuration that specifies the thing name of the destination + // device and a service name that the local proxy uses to connect to the + // destination application. + DestinationConfig *DestinationConfig + + // The connection state of the destination application. + DestinationConnectionState *ConnectionState // The last time the tunnel was updated. LastUpdatedAt *time.Time @@ -78,30 +82,32 @@ type Tunnel struct { // The connection state of the source application. SourceConnectionState *ConnectionState - // A unique alpha-numeric ID that identifies a tunnel. - TunnelId *string - - // The connection state of the destination application. - DestinationConnectionState *ConnectionState - - // A description of the tunnel. - Description *string - // The status of a tunnel. Valid values are: Open and Closed. Status TunnelStatus - // The destination configuration that specifies the thing name of the destination - // device and a service name that the local proxy uses to connect to the - // destination application. - DestinationConfig *DestinationConfig - // A list of tag metadata associated with the secure tunnel. Tags []*Tag + + // Timeout configuration for the tunnel. + TimeoutConfig *TimeoutConfig + + // The Amazon Resource Name (ARN) of a tunnel. The tunnel ARN format is + // arn:aws:tunnel:::tunnel/ + TunnelArn *string + + // A unique alpha-numeric ID that identifies a tunnel. + TunnelId *string } // Information about the tunnel. type TunnelSummary struct { + // The time the tunnel was created. + CreatedAt *time.Time + + // A description of the tunnel. + Description *string + // The time the tunnel was last updated. LastUpdatedAt *time.Time @@ -112,12 +118,6 @@ type TunnelSummary struct { // arn:aws:tunnel:::tunnel/ TunnelArn *string - // A description of the tunnel. - Description *string - - // The time the tunnel was created. - CreatedAt *time.Time - // The unique alpha-numeric identifier for the tunnel. TunnelId *string } diff --git a/service/iotsitewise/api_op_AssociateAssets.go b/service/iotsitewise/api_op_AssociateAssets.go index 86214c4b82c..64fdbabb5c0 100644 --- a/service/iotsitewise/api_op_AssociateAssets.go +++ b/service/iotsitewise/api_op_AssociateAssets.go @@ -61,6 +61,11 @@ func (c *Client) AssociateAssets(ctx context.Context, params *AssociateAssetsInp type AssociateAssetsInput struct { + // The ID of the parent asset. + // + // This member is required. + AssetId *string + // The ID of the child asset to be associated. // // This member is required. @@ -79,11 +84,6 @@ type AssociateAssetsInput struct { // idempotency of the request. Don't reuse this client token if a new idempotent // request is required. ClientToken *string - - // The ID of the parent asset. - // - // This member is required. - AssetId *string } type AssociateAssetsOutput struct { diff --git a/service/iotsitewise/api_op_BatchDisassociateProjectAssets.go b/service/iotsitewise/api_op_BatchDisassociateProjectAssets.go index aece7eb4f78..3dcd78e06dc 100644 --- a/service/iotsitewise/api_op_BatchDisassociateProjectAssets.go +++ b/service/iotsitewise/api_op_BatchDisassociateProjectAssets.go @@ -60,15 +60,15 @@ func (c *Client) BatchDisassociateProjectAssets(ctx context.Context, params *Bat type BatchDisassociateProjectAssetsInput struct { - // The ID of the project from which to disassociate the assets. + // The IDs of the assets to be disassociated from the project. // // This member is required. - ProjectId *string + AssetIds []*string - // The IDs of the assets to be disassociated from the project. + // The ID of the project from which to disassociate the assets. // // This member is required. - AssetIds []*string + ProjectId *string // A unique case-sensitive identifier that you can provide to ensure the // idempotency of the request. Don't reuse this client token if a new idempotent diff --git a/service/iotsitewise/api_op_CreateAccessPolicy.go b/service/iotsitewise/api_op_CreateAccessPolicy.go index 58fd5670266..0802575f69f 100644 --- a/service/iotsitewise/api_op_CreateAccessPolicy.go +++ b/service/iotsitewise/api_op_CreateAccessPolicy.go @@ -67,10 +67,11 @@ type CreateAccessPolicyInput struct { // This member is required. AccessPolicyIdentity *types.Identity - // A unique case-sensitive identifier that you can provide to ensure the - // idempotency of the request. Don't reuse this client token if a new idempotent - // request is required. - ClientToken *string + // The permission level for this access policy. Note that a project ADMINISTRATOR + // is also known as a project owner. + // + // This member is required. + AccessPolicyPermission types.Permission // The AWS IoT SiteWise Monitor resource for this access policy. Choose either // portal or project but not both. @@ -78,11 +79,10 @@ type CreateAccessPolicyInput struct { // This member is required. AccessPolicyResource *types.Resource - // The permission level for this access policy. Note that a project ADMINISTRATOR - // is also known as a project owner. - // - // This member is required. - AccessPolicyPermission types.Permission + // A unique case-sensitive identifier that you can provide to ensure the + // idempotency of the request. Don't reuse this client token if a new idempotent + // request is required. + ClientToken *string // A list of key-value pairs that contain metadata for the access policy. For more // information, see Tagging your AWS IoT SiteWise resources @@ -93,11 +93,6 @@ type CreateAccessPolicyInput struct { type CreateAccessPolicyOutput struct { - // The ID of the access policy. - // - // This member is required. - AccessPolicyId *string - // The ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the access policy, which has the following format. @@ -106,6 +101,11 @@ type CreateAccessPolicyOutput struct { // This member is required. AccessPolicyArn *string + // The ID of the access policy. + // + // This member is required. + AccessPolicyId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotsitewise/api_op_CreateAsset.go b/service/iotsitewise/api_op_CreateAsset.go index 05be7dd13ad..5133a10fcea 100644 --- a/service/iotsitewise/api_op_CreateAsset.go +++ b/service/iotsitewise/api_op_CreateAsset.go @@ -62,30 +62,38 @@ func (c *Client) CreateAsset(ctx context.Context, params *CreateAssetInput, optF type CreateAssetInput struct { - // A unique case-sensitive identifier that you can provide to ensure the - // idempotency of the request. Don't reuse this client token if a new idempotent - // request is required. - ClientToken *string - // The ID of the asset model from which to create the asset. // // This member is required. AssetModelId *string + // A unique, friendly name for the asset. + // + // This member is required. + AssetName *string + + // A unique case-sensitive identifier that you can provide to ensure the + // idempotency of the request. Don't reuse this client token if a new idempotent + // request is required. + ClientToken *string + // A list of key-value pairs that contain metadata for the asset. For more // information, see Tagging your AWS IoT SiteWise resources // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) // in the AWS IoT SiteWise User Guide. Tags map[string]*string - - // A unique, friendly name for the asset. - // - // This member is required. - AssetName *string } type CreateAssetOutput struct { + // The ARN + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of + // the asset, which has the following format. + // arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} + // + // This member is required. + AssetArn *string + // The ID of the asset. This ID uniquely identifies the asset within AWS IoT // SiteWise and can be used with other AWS IoT SiteWise APIs. // @@ -98,14 +106,6 @@ type CreateAssetOutput struct { // This member is required. AssetStatus *types.AssetStatus - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the asset, which has the following format. - // arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} - // - // This member is required. - AssetArn *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotsitewise/api_op_CreateAssetModel.go b/service/iotsitewise/api_op_CreateAssetModel.go index e84a86c4c34..442de355c55 100644 --- a/service/iotsitewise/api_op_CreateAssetModel.go +++ b/service/iotsitewise/api_op_CreateAssetModel.go @@ -65,9 +65,24 @@ func (c *Client) CreateAssetModel(ctx context.Context, params *CreateAssetModelI type CreateAssetModelInput struct { + // A unique, friendly name for the asset model. + // + // This member is required. + AssetModelName *string + // A description for the asset model. AssetModelDescription *string + // The hierarchy definitions of the asset model. Each hierarchy specifies an asset + // model whose assets can be children of any other assets created from this asset + // model. For more information, see Asset Hierarchies + // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) + // in the AWS IoT SiteWise User Guide. You can specify up to 10 hierarchies per + // asset model. For more information, see Quotas + // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the + // AWS IoT SiteWise User Guide. + AssetModelHierarchies []*types.AssetModelHierarchyDefinition + // The property definitions of the asset model. For more information, see Asset // Properties // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html) @@ -82,26 +97,11 @@ type CreateAssetModelInput struct { // request is required. ClientToken *string - // A unique, friendly name for the asset model. - // - // This member is required. - AssetModelName *string - // A list of key-value pairs that contain metadata for the asset model. For more // information, see Tagging your AWS IoT SiteWise resources // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) // in the AWS IoT SiteWise User Guide. Tags map[string]*string - - // The hierarchy definitions of the asset model. Each hierarchy specifies an asset - // model whose assets can be children of any other assets created from this asset - // model. For more information, see Asset Hierarchies - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) - // in the AWS IoT SiteWise User Guide. You can specify up to 10 hierarchies per - // asset model. For more information, see Quotas - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the - // AWS IoT SiteWise User Guide. - AssetModelHierarchies []*types.AssetModelHierarchyDefinition } type CreateAssetModelOutput struct { @@ -114,18 +114,18 @@ type CreateAssetModelOutput struct { // This member is required. AssetModelArn *string - // The status of the asset model, which contains a state (CREATING after - // successfully calling this operation) and any error message. - // - // This member is required. - AssetModelStatus *types.AssetModelStatus - // The ID of the asset model. You can use this ID when you call other AWS IoT // SiteWise APIs. // // This member is required. AssetModelId *string + // The status of the asset model, which contains a state (CREATING after + // successfully calling this operation) and any error message. + // + // This member is required. + AssetModelStatus *types.AssetModelStatus + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotsitewise/api_op_CreateDashboard.go b/service/iotsitewise/api_op_CreateDashboard.go index 0b565f09e04..d0a0557381c 100644 --- a/service/iotsitewise/api_op_CreateDashboard.go +++ b/service/iotsitewise/api_op_CreateDashboard.go @@ -58,11 +58,6 @@ func (c *Client) CreateDashboard(ctx context.Context, params *CreateDashboardInp type CreateDashboardInput struct { - // A unique case-sensitive identifier that you can provide to ensure the - // idempotency of the request. Don't reuse this client token if a new idempotent - // request is required. - ClientToken *string - // The dashboard definition specified in a JSON literal. For detailed information, // see Creating Dashboards (CLI) // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html) @@ -71,12 +66,6 @@ type CreateDashboardInput struct { // This member is required. DashboardDefinition *string - // A list of key-value pairs that contain metadata for the dashboard. For more - // information, see Tagging your AWS IoT SiteWise resources - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) - // in the AWS IoT SiteWise User Guide. - Tags map[string]*string - // A friendly name for the dashboard. // // This member is required. @@ -87,17 +76,23 @@ type CreateDashboardInput struct { // This member is required. ProjectId *string + // A unique case-sensitive identifier that you can provide to ensure the + // idempotency of the request. Don't reuse this client token if a new idempotent + // request is required. + ClientToken *string + // A description for the dashboard. DashboardDescription *string + + // A list of key-value pairs that contain metadata for the dashboard. For more + // information, see Tagging your AWS IoT SiteWise resources + // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) + // in the AWS IoT SiteWise User Guide. + Tags map[string]*string } type CreateDashboardOutput struct { - // The ID of the dashboard. - // - // This member is required. - DashboardId *string - // The ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the dashboard, which has the following format. @@ -106,6 +101,11 @@ type CreateDashboardOutput struct { // This member is required. DashboardArn *string + // The ID of the dashboard. + // + // This member is required. + DashboardId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotsitewise/api_op_CreateGateway.go b/service/iotsitewise/api_op_CreateGateway.go index d2036c98810..c8e520e50e9 100644 --- a/service/iotsitewise/api_op_CreateGateway.go +++ b/service/iotsitewise/api_op_CreateGateway.go @@ -61,6 +61,11 @@ func (c *Client) CreateGateway(ctx context.Context, params *CreateGatewayInput, type CreateGatewayInput struct { + // A unique, friendly name for the gateway. + // + // This member is required. + GatewayName *string + // The gateway's platform. You can only specify one platform in a gateway. // // This member is required. @@ -71,21 +76,10 @@ type CreateGatewayInput struct { // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) // in the AWS IoT SiteWise User Guide. Tags map[string]*string - - // A unique, friendly name for the gateway. - // - // This member is required. - GatewayName *string } type CreateGatewayOutput struct { - // The ID of the gateway device. You can use this ID when you call other AWS IoT - // SiteWise APIs. - // - // This member is required. - GatewayId *string - // The ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the gateway, which has the following format. @@ -94,6 +88,12 @@ type CreateGatewayOutput struct { // This member is required. GatewayArn *string + // The ID of the gateway device. You can use this ID when you call other AWS IoT + // SiteWise APIs. + // + // This member is required. + GatewayId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotsitewise/api_op_CreatePortal.go b/service/iotsitewise/api_op_CreatePortal.go index e4cc89e854a..fcadb466644 100644 --- a/service/iotsitewise/api_op_CreatePortal.go +++ b/service/iotsitewise/api_op_CreatePortal.go @@ -68,22 +68,16 @@ func (c *Client) CreatePortal(ctx context.Context, params *CreatePortalInput, op type CreatePortalInput struct { - // A list of key-value pairs that contain metadata for the portal. For more - // information, see Tagging your AWS IoT SiteWise resources - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) - // in the AWS IoT SiteWise User Guide. - Tags map[string]*string + // The AWS administrator's contact email address. + // + // This member is required. + PortalContactEmail *string // A friendly name for the portal. // // This member is required. PortalName *string - // A unique case-sensitive identifier that you can provide to ensure the - // idempotency of the request. Don't reuse this client token if a new idempotent - // request is required. - ClientToken *string - // The ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // a service role that allows the portal's users to access your AWS IoT SiteWise @@ -95,32 +89,27 @@ type CreatePortalInput struct { // This member is required. RoleArn *string - // The AWS administrator's contact email address. - // - // This member is required. - PortalContactEmail *string + // A unique case-sensitive identifier that you can provide to ensure the + // idempotency of the request. Don't reuse this client token if a new idempotent + // request is required. + ClientToken *string + + // A description for the portal. + PortalDescription *string // A logo image to display in the portal. Upload a square, high-resolution image. // The image is displayed on a dark background. PortalLogoImageFile *types.ImageFile - // A description for the portal. - PortalDescription *string + // A list of key-value pairs that contain metadata for the portal. For more + // information, see Tagging your AWS IoT SiteWise resources + // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) + // in the AWS IoT SiteWise User Guide. + Tags map[string]*string } type CreatePortalOutput struct { - // The associated AWS SSO application Id. - // - // This member is required. - SsoApplicationId *string - - // The status of the portal, which contains a state (CREATING after successfully - // calling this operation) and any error message. - // - // This member is required. - PortalStatus *types.PortalStatus - // The ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the portal, which has the following format. @@ -129,15 +118,26 @@ type CreatePortalOutput struct { // This member is required. PortalArn *string + // The ID of the created portal. + // + // This member is required. + PortalId *string + // The public URL for the AWS IoT SiteWise Monitor portal. // // This member is required. PortalStartUrl *string - // The ID of the created portal. + // The status of the portal, which contains a state (CREATING after successfully + // calling this operation) and any error message. // // This member is required. - PortalId *string + PortalStatus *types.PortalStatus + + // The associated AWS SSO application Id. + // + // This member is required. + SsoApplicationId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/iotsitewise/api_op_CreateProject.go b/service/iotsitewise/api_op_CreateProject.go index 080fee0a65c..db22b1e1ccd 100644 --- a/service/iotsitewise/api_op_CreateProject.go +++ b/service/iotsitewise/api_op_CreateProject.go @@ -58,29 +58,29 @@ func (c *Client) CreateProject(ctx context.Context, params *CreateProjectInput, type CreateProjectInput struct { - // A list of key-value pairs that contain metadata for the project. For more - // information, see Tagging your AWS IoT SiteWise resources - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) - // in the AWS IoT SiteWise User Guide. - Tags map[string]*string - - // A description for the project. - ProjectDescription *string - - // A friendly name for the project. + // The ID of the portal in which to create the project. // // This member is required. - ProjectName *string + PortalId *string - // The ID of the portal in which to create the project. + // A friendly name for the project. // // This member is required. - PortalId *string + ProjectName *string // A unique case-sensitive identifier that you can provide to ensure the // idempotency of the request. Don't reuse this client token if a new idempotent // request is required. ClientToken *string + + // A description for the project. + ProjectDescription *string + + // A list of key-value pairs that contain metadata for the project. For more + // information, see Tagging your AWS IoT SiteWise resources + // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) + // in the AWS IoT SiteWise User Guide. + Tags map[string]*string } type CreateProjectOutput struct { diff --git a/service/iotsitewise/api_op_DeleteAsset.go b/service/iotsitewise/api_op_DeleteAsset.go index dcec8794cbd..d77a9e50025 100644 --- a/service/iotsitewise/api_op_DeleteAsset.go +++ b/service/iotsitewise/api_op_DeleteAsset.go @@ -64,15 +64,15 @@ func (c *Client) DeleteAsset(ctx context.Context, params *DeleteAssetInput, optF type DeleteAssetInput struct { - // A unique case-sensitive identifier that you can provide to ensure the - // idempotency of the request. Don't reuse this client token if a new idempotent - // request is required. - ClientToken *string - // The ID of the asset to delete. // // This member is required. AssetId *string + + // A unique case-sensitive identifier that you can provide to ensure the + // idempotency of the request. Don't reuse this client token if a new idempotent + // request is required. + ClientToken *string } type DeleteAssetOutput struct { diff --git a/service/iotsitewise/api_op_DeleteAssetModel.go b/service/iotsitewise/api_op_DeleteAssetModel.go index c1db0158b95..2b8f6d85aad 100644 --- a/service/iotsitewise/api_op_DeleteAssetModel.go +++ b/service/iotsitewise/api_op_DeleteAssetModel.go @@ -65,15 +65,15 @@ func (c *Client) DeleteAssetModel(ctx context.Context, params *DeleteAssetModelI type DeleteAssetModelInput struct { - // A unique case-sensitive identifier that you can provide to ensure the - // idempotency of the request. Don't reuse this client token if a new idempotent - // request is required. - ClientToken *string - // The ID of the asset model to delete. // // This member is required. AssetModelId *string + + // A unique case-sensitive identifier that you can provide to ensure the + // idempotency of the request. Don't reuse this client token if a new idempotent + // request is required. + ClientToken *string } type DeleteAssetModelOutput struct { diff --git a/service/iotsitewise/api_op_DeleteProject.go b/service/iotsitewise/api_op_DeleteProject.go index 2c4283d9c77..67c17dbd02d 100644 --- a/service/iotsitewise/api_op_DeleteProject.go +++ b/service/iotsitewise/api_op_DeleteProject.go @@ -58,15 +58,15 @@ func (c *Client) DeleteProject(ctx context.Context, params *DeleteProjectInput, type DeleteProjectInput struct { - // A unique case-sensitive identifier that you can provide to ensure the - // idempotency of the request. Don't reuse this client token if a new idempotent - // request is required. - ClientToken *string - // The ID of the project. // // This member is required. ProjectId *string + + // A unique case-sensitive identifier that you can provide to ensure the + // idempotency of the request. Don't reuse this client token if a new idempotent + // request is required. + ClientToken *string } type DeleteProjectOutput struct { diff --git a/service/iotsitewise/api_op_DescribeAccessPolicy.go b/service/iotsitewise/api_op_DescribeAccessPolicy.go index 792ca282c95..ea4a467b234 100644 --- a/service/iotsitewise/api_op_DescribeAccessPolicy.go +++ b/service/iotsitewise/api_op_DescribeAccessPolicy.go @@ -67,11 +67,29 @@ type DescribeAccessPolicyInput struct { type DescribeAccessPolicyOutput struct { + // The ARN + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of + // the access policy, which has the following format. + // arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId} + // + // This member is required. + AccessPolicyArn *string + // The date the access policy was created, in Unix epoch time. // // This member is required. AccessPolicyCreationDate *time.Time + // The ID of the access policy. + // + // This member is required. + AccessPolicyId *string + + // The AWS SSO identity (user or group) to which this access policy applies. + // + // This member is required. + AccessPolicyIdentity *types.Identity + // The date the access policy was last updated, in Unix epoch time. // // This member is required. @@ -83,30 +101,12 @@ type DescribeAccessPolicyOutput struct { // This member is required. AccessPolicyPermission types.Permission - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the access policy, which has the following format. - // arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId} - // - // This member is required. - AccessPolicyArn *string - // The AWS IoT SiteWise Monitor resource (portal or project) to which this access // policy provides access. // // This member is required. AccessPolicyResource *types.Resource - // The ID of the access policy. - // - // This member is required. - AccessPolicyId *string - - // The AWS SSO identity (user or group) to which this access policy applies. - // - // This member is required. - AccessPolicyIdentity *types.Identity - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotsitewise/api_op_DescribeAsset.go b/service/iotsitewise/api_op_DescribeAsset.go index 2fba92006b5..97868e2b766 100644 --- a/service/iotsitewise/api_op_DescribeAsset.go +++ b/service/iotsitewise/api_op_DescribeAsset.go @@ -66,54 +66,54 @@ type DescribeAssetInput struct { type DescribeAssetOutput struct { - // A list of asset hierarchies that each contain a hierarchyId. A hierarchy - // specifies allowed parent/child asset relationships. + // The ARN + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of + // the asset, which has the following format. + // arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} // // This member is required. - AssetHierarchies []*types.AssetHierarchy + AssetArn *string - // The date the asset was last updated, in Unix epoch time. + // The date the asset was created, in Unix epoch time. // // This member is required. - AssetLastUpdateDate *time.Time + AssetCreationDate *time.Time - // The date the asset was created, in Unix epoch time. + // A list of asset hierarchies that each contain a hierarchyId. A hierarchy + // specifies allowed parent/child asset relationships. // // This member is required. - AssetCreationDate *time.Time + AssetHierarchies []*types.AssetHierarchy - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the asset, which has the following format. - // arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} + // The ID of the asset. // // This member is required. - AssetArn *string + AssetId *string - // The name of the asset. + // The date the asset was last updated, in Unix epoch time. // // This member is required. - AssetName *string + AssetLastUpdateDate *time.Time // The ID of the asset model that was used to create the asset. // // This member is required. AssetModelId *string - // The current status of the asset, which contains a state and any error message. + // The name of the asset. // // This member is required. - AssetStatus *types.AssetStatus + AssetName *string // The list of asset properties for the asset. // // This member is required. AssetProperties []*types.AssetProperty - // The ID of the asset. + // The current status of the asset, which contains a state and any error message. // // This member is required. - AssetId *string + AssetStatus *types.AssetStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/iotsitewise/api_op_DescribeAssetModel.go b/service/iotsitewise/api_op_DescribeAssetModel.go index c4dd495d746..5bfe66e311f 100644 --- a/service/iotsitewise/api_op_DescribeAssetModel.go +++ b/service/iotsitewise/api_op_DescribeAssetModel.go @@ -66,6 +66,24 @@ type DescribeAssetModelInput struct { type DescribeAssetModelOutput struct { + // The ARN + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of + // the asset model, which has the following format. + // arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId} + // + // This member is required. + AssetModelArn *string + + // The date the asset model was created, in Unix epoch time. + // + // This member is required. + AssetModelCreationDate *time.Time + + // The asset model's description. + // + // This member is required. + AssetModelDescription *string + // A list of asset model hierarchies that each contain a childAssetModelId and a // hierarchyId (named id). A hierarchy specifies allowed parent/child asset // relationships for an asset model. @@ -78,45 +96,27 @@ type DescribeAssetModelOutput struct { // This member is required. AssetModelId *string - // The name of the asset model. - // - // This member is required. - AssetModelName *string - // The date the asset model was last updated, in Unix epoch time. // // This member is required. AssetModelLastUpdateDate *time.Time - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the asset model, which has the following format. - // arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId} + // The name of the asset model. // // This member is required. - AssetModelArn *string + AssetModelName *string // The list of asset properties for the asset model. // // This member is required. AssetModelProperties []*types.AssetModelProperty - // The asset model's description. - // - // This member is required. - AssetModelDescription *string - // The current status of the asset model, which contains a state and any error // message. // // This member is required. AssetModelStatus *types.AssetModelStatus - // The date the asset model was created, in Unix epoch time. - // - // This member is required. - AssetModelCreationDate *time.Time - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotsitewise/api_op_DescribeAssetProperty.go b/service/iotsitewise/api_op_DescribeAssetProperty.go index 134d7a396e8..cf618cf1894 100644 --- a/service/iotsitewise/api_op_DescribeAssetProperty.go +++ b/service/iotsitewise/api_op_DescribeAssetProperty.go @@ -57,15 +57,15 @@ func (c *Client) DescribeAssetProperty(ctx context.Context, params *DescribeAsse type DescribeAssetPropertyInput struct { - // The ID of the asset property. + // The ID of the asset. // // This member is required. - PropertyId *string + AssetId *string - // The ID of the asset. + // The ID of the asset property. // // This member is required. - AssetId *string + PropertyId *string } type DescribeAssetPropertyOutput struct { @@ -80,15 +80,15 @@ type DescribeAssetPropertyOutput struct { // This member is required. AssetModelId *string - // The asset property's definition, alias, and notification state. + // The name of the asset. // // This member is required. - AssetProperty *types.Property + AssetName *string - // The name of the asset. + // The asset property's definition, alias, and notification state. // // This member is required. - AssetName *string + AssetProperty *types.Property // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/iotsitewise/api_op_DescribeDashboard.go b/service/iotsitewise/api_op_DescribeDashboard.go index d53dbacf795..cf5f9d5b6bb 100644 --- a/service/iotsitewise/api_op_DescribeDashboard.go +++ b/service/iotsitewise/api_op_DescribeDashboard.go @@ -65,49 +65,49 @@ type DescribeDashboardInput struct { type DescribeDashboardOutput struct { - // The ID of the project that the dashboard is in. + // The ARN + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of + // the dashboard, which has the following format. + // arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId} // // This member is required. - ProjectId *string + DashboardArn *string // The date the dashboard was created, in Unix epoch time. // // This member is required. DashboardCreationDate *time.Time + // The dashboard's definition JSON literal. For detailed information, see Creating + // Dashboards (CLI) + // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html) + // in the AWS IoT SiteWise User Guide. + // + // This member is required. + DashboardDefinition *string + // The ID of the dashboard. // // This member is required. DashboardId *string - // The dashboard's description. - DashboardDescription *string - // The date the dashboard was last updated, in Unix epoch time. // // This member is required. DashboardLastUpdateDate *time.Time - // The dashboard's definition JSON literal. For detailed information, see Creating - // Dashboards (CLI) - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html) - // in the AWS IoT SiteWise User Guide. + // The name of the dashboard. // // This member is required. - DashboardDefinition *string + DashboardName *string - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the dashboard, which has the following format. - // arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId} + // The ID of the project that the dashboard is in. // // This member is required. - DashboardArn *string + ProjectId *string - // The name of the dashboard. - // - // This member is required. - DashboardName *string + // The dashboard's description. + DashboardDescription *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/iotsitewise/api_op_DescribeGateway.go b/service/iotsitewise/api_op_DescribeGateway.go index 1ec4594a37a..4bcaa9cf54e 100644 --- a/service/iotsitewise/api_op_DescribeGateway.go +++ b/service/iotsitewise/api_op_DescribeGateway.go @@ -66,10 +66,10 @@ type DescribeGatewayInput struct { type DescribeGatewayOutput struct { - // The name of the gateway. + // The date the gateway was created, in Unix epoch time. // // This member is required. - GatewayName *string + CreationDate *time.Time // The ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of @@ -79,11 +79,25 @@ type DescribeGatewayOutput struct { // This member is required. GatewayArn *string + // A list of gateway capability summaries that each contain a namespace and status. + // Each gateway capability defines data sources for the gateway. To retrieve a + // capability configuration's definition, use + // DescribeGatewayCapabilityConfiguration + // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html). + // + // This member is required. + GatewayCapabilitySummaries []*types.GatewayCapabilitySummary + // The ID of the gateway device. // // This member is required. GatewayId *string + // The name of the gateway. + // + // This member is required. + GatewayName *string + // The date the gateway was last updated, in Unix epoch time. // // This member is required. @@ -92,20 +106,6 @@ type DescribeGatewayOutput struct { // The gateway's platform. GatewayPlatform *types.GatewayPlatform - // The date the gateway was created, in Unix epoch time. - // - // This member is required. - CreationDate *time.Time - - // A list of gateway capability summaries that each contain a namespace and status. - // Each gateway capability defines data sources for the gateway. To retrieve a - // capability configuration's definition, use - // DescribeGatewayCapabilityConfiguration - // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html). - // - // This member is required. - GatewayCapabilitySummaries []*types.GatewayCapabilitySummary - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotsitewise/api_op_DescribeGatewayCapabilityConfiguration.go b/service/iotsitewise/api_op_DescribeGatewayCapabilityConfiguration.go index 89e01312f45..1d6e6a4671f 100644 --- a/service/iotsitewise/api_op_DescribeGatewayCapabilityConfiguration.go +++ b/service/iotsitewise/api_op_DescribeGatewayCapabilityConfiguration.go @@ -79,11 +79,6 @@ type DescribeGatewayCapabilityConfigurationInput struct { type DescribeGatewayCapabilityConfigurationOutput struct { - // The namespace of the gateway capability. - // - // This member is required. - CapabilityNamespace *string - // The JSON document that defines the gateway capability's configuration. For more // information, see Configuring data sources (CLI) // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli) @@ -92,6 +87,11 @@ type DescribeGatewayCapabilityConfigurationOutput struct { // This member is required. CapabilityConfiguration *string + // The namespace of the gateway capability. + // + // This member is required. + CapabilityNamespace *string + // The synchronization status of the capability configuration. The sync status can // be one of the following: // diff --git a/service/iotsitewise/api_op_DescribePortal.go b/service/iotsitewise/api_op_DescribePortal.go index f56b3283667..c07e6e1bf20 100644 --- a/service/iotsitewise/api_op_DescribePortal.go +++ b/service/iotsitewise/api_op_DescribePortal.go @@ -66,16 +66,6 @@ type DescribePortalInput struct { type DescribePortalOutput struct { - // The date the portal was created, in Unix epoch time. - // - // This member is required. - PortalCreationDate *time.Time - - // The date the portal was last updated, in Unix epoch time. - // - // This member is required. - PortalLastUpdateDate *time.Time - // The ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the portal, which has the following format. @@ -84,9 +74,6 @@ type DescribePortalOutput struct { // This member is required. PortalArn *string - // The portal's logo image, which is available at a URL. - PortalLogoImageLocation *types.ImageLocation - // The AWS SSO application generated client ID (used with AWS SSO APIs). // // This member is required. @@ -97,30 +84,31 @@ type DescribePortalOutput struct { // This member is required. PortalContactEmail *string + // The date the portal was created, in Unix epoch time. + // + // This member is required. + PortalCreationDate *time.Time + // The ID of the portal. // // This member is required. PortalId *string - // The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal. + // The date the portal was last updated, in Unix epoch time. // // This member is required. - PortalStartUrl *string - - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the service role that allows the portal's users to access your AWS IoT SiteWise - // resources on your behalf. For more information, see Using service roles for AWS - // IoT SiteWise Monitor - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) - // in the AWS IoT SiteWise User Guide. - RoleArn *string + PortalLastUpdateDate *time.Time // The name of the portal. // // This member is required. PortalName *string + // The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal. + // + // This member is required. + PortalStartUrl *string + // The current status of the portal, which contains a state and any error message. // // This member is required. @@ -129,6 +117,18 @@ type DescribePortalOutput struct { // The portal's description. PortalDescription *string + // The portal's logo image, which is available at a URL. + PortalLogoImageLocation *types.ImageLocation + + // The ARN + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of + // the service role that allows the portal's users to access your AWS IoT SiteWise + // resources on your behalf. For more information, see Using service roles for AWS + // IoT SiteWise Monitor + // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) + // in the AWS IoT SiteWise User Guide. + RoleArn *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotsitewise/api_op_DescribeProject.go b/service/iotsitewise/api_op_DescribeProject.go index e1603f104e1..88cd72590bf 100644 --- a/service/iotsitewise/api_op_DescribeProject.go +++ b/service/iotsitewise/api_op_DescribeProject.go @@ -65,41 +65,41 @@ type DescribeProjectInput struct { type DescribeProjectOutput struct { - // The date the project was last updated, in Unix epoch time. - // - // This member is required. - ProjectLastUpdateDate *time.Time - // The ID of the portal that the project is in. // // This member is required. PortalId *string - // The project's description. - ProjectDescription *string + // The ARN + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of + // the project, which has the following format. + // arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId} + // + // This member is required. + ProjectArn *string // The date the project was created, in Unix epoch time. // // This member is required. ProjectCreationDate *time.Time - // The name of the project. + // The ID of the project. // // This member is required. - ProjectName *string + ProjectId *string - // The ID of the project. + // The date the project was last updated, in Unix epoch time. // // This member is required. - ProjectId *string + ProjectLastUpdateDate *time.Time - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the project, which has the following format. - // arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId} + // The name of the project. // // This member is required. - ProjectArn *string + ProjectName *string + + // The project's description. + ProjectDescription *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/iotsitewise/api_op_DisassociateAssets.go b/service/iotsitewise/api_op_DisassociateAssets.go index afe2c702e39..924cded5c7e 100644 --- a/service/iotsitewise/api_op_DisassociateAssets.go +++ b/service/iotsitewise/api_op_DisassociateAssets.go @@ -59,10 +59,15 @@ func (c *Client) DisassociateAssets(ctx context.Context, params *DisassociateAss type DisassociateAssetsInput struct { - // A unique case-sensitive identifier that you can provide to ensure the - // idempotency of the request. Don't reuse this client token if a new idempotent - // request is required. - ClientToken *string + // The ID of the parent asset from which to disassociate the child asset. + // + // This member is required. + AssetId *string + + // The ID of the child asset to disassociate. + // + // This member is required. + ChildAssetId *string // The ID of a hierarchy in the parent asset's model. Hierarchies allow different // groupings of assets to be formed that all come from the same asset model. You @@ -74,15 +79,10 @@ type DisassociateAssetsInput struct { // This member is required. HierarchyId *string - // The ID of the parent asset from which to disassociate the child asset. - // - // This member is required. - AssetId *string - - // The ID of the child asset to disassociate. - // - // This member is required. - ChildAssetId *string + // A unique case-sensitive identifier that you can provide to ensure the + // idempotency of the request. Don't reuse this client token if a new idempotent + // request is required. + ClientToken *string } type DisassociateAssetsOutput struct { diff --git a/service/iotsitewise/api_op_GetAssetPropertyAggregates.go b/service/iotsitewise/api_op_GetAssetPropertyAggregates.go index 72900367149..d10d839d872 100644 --- a/service/iotsitewise/api_op_GetAssetPropertyAggregates.go +++ b/service/iotsitewise/api_op_GetAssetPropertyAggregates.go @@ -70,17 +70,10 @@ func (c *Client) GetAssetPropertyAggregates(ctx context.Context, params *GetAsse type GetAssetPropertyAggregatesInput struct { - // The ID of the asset property. - PropertyId *string - - // The exclusive start of the range from which to query historical data, expressed - // in seconds in Unix epoch time. + // The data aggregating function. // // This member is required. - StartDate *time.Time - - // The maximum number of results to be returned per paginated request. - MaxResults *int32 + AggregateTypes []types.AggregateType // The inclusive end of the range from which to query historical data, expressed in // seconds in Unix epoch time. @@ -88,14 +81,26 @@ type GetAssetPropertyAggregatesInput struct { // This member is required. EndDate *time.Time - // The data aggregating function. + // The time interval over which to aggregate data. // // This member is required. - AggregateTypes []types.AggregateType + Resolution *string + + // The exclusive start of the range from which to query historical data, expressed + // in seconds in Unix epoch time. + // + // This member is required. + StartDate *time.Time // The ID of the asset. AssetId *string + // The maximum number of results to be returned per paginated request. + MaxResults *int32 + + // The token to be used for the next set of paginated results. + NextToken *string + // The property alias that identifies the property, such as an OPC-UA server data // stream path (for example, /company/windfarm/3/turbine/7/temperature). For more // information, see Mapping Industrial Data Streams to Asset Properties @@ -103,19 +108,14 @@ type GetAssetPropertyAggregatesInput struct { // in the AWS IoT SiteWise User Guide. PropertyAlias *string - // The time interval over which to aggregate data. - // - // This member is required. - Resolution *string + // The ID of the asset property. + PropertyId *string - // The token to be used for the next set of paginated results. - NextToken *string + // The quality by which to filter asset data. + Qualities []types.Quality // The chronological sorting order of the requested information. TimeOrdering types.TimeOrdering - - // The quality by which to filter asset data. - Qualities []types.Quality } type GetAssetPropertyAggregatesOutput struct { diff --git a/service/iotsitewise/api_op_GetAssetPropertyValueHistory.go b/service/iotsitewise/api_op_GetAssetPropertyValueHistory.go index 720f9fa3880..6fcdf76e5f9 100644 --- a/service/iotsitewise/api_op_GetAssetPropertyValueHistory.go +++ b/service/iotsitewise/api_op_GetAssetPropertyValueHistory.go @@ -69,11 +69,18 @@ func (c *Client) GetAssetPropertyValueHistory(ctx context.Context, params *GetAs type GetAssetPropertyValueHistoryInput struct { - // The quality by which to filter asset data. - Qualities []types.Quality + // The ID of the asset. + AssetId *string - // The chronological sorting order of the requested information. - TimeOrdering types.TimeOrdering + // The inclusive end of the range from which to query historical data, expressed in + // seconds in Unix epoch time. + EndDate *time.Time + + // The maximum number of results to be returned per paginated request. + MaxResults *int32 + + // The token to be used for the next set of paginated results. + NextToken *string // The property alias that identifies the property, such as an OPC-UA server data // stream path (for example, /company/windfarm/3/turbine/7/temperature). For more @@ -85,22 +92,15 @@ type GetAssetPropertyValueHistoryInput struct { // The ID of the asset property. PropertyId *string + // The quality by which to filter asset data. + Qualities []types.Quality + // The exclusive start of the range from which to query historical data, expressed // in seconds in Unix epoch time. StartDate *time.Time - // The maximum number of results to be returned per paginated request. - MaxResults *int32 - - // The ID of the asset. - AssetId *string - - // The inclusive end of the range from which to query historical data, expressed in - // seconds in Unix epoch time. - EndDate *time.Time - - // The token to be used for the next set of paginated results. - NextToken *string + // The chronological sorting order of the requested information. + TimeOrdering types.TimeOrdering } type GetAssetPropertyValueHistoryOutput struct { diff --git a/service/iotsitewise/api_op_ListAccessPolicies.go b/service/iotsitewise/api_op_ListAccessPolicies.go index c629f62ebbe..4576dfcf653 100644 --- a/service/iotsitewise/api_op_ListAccessPolicies.go +++ b/service/iotsitewise/api_op_ListAccessPolicies.go @@ -64,6 +64,9 @@ type ListAccessPoliciesInput struct { // identityId. IdentityType types.IdentityType + // The maximum number of results to be returned per paginated request. + MaxResults *int32 + // The token to be used for the next set of paginated results. NextToken *string @@ -73,22 +76,19 @@ type ListAccessPoliciesInput struct { // The type of resource (portal or project). This parameter is required if you // specify resourceId. ResourceType types.ResourceType - - // The maximum number of results to be returned per paginated request. - MaxResults *int32 } type ListAccessPoliciesOutput struct { - // The token for the next set of results, or null if there are no additional - // results. - NextToken *string - // A list that summarizes each access policy. // // This member is required. AccessPolicySummaries []*types.AccessPolicySummary + // The token for the next set of results, or null if there are no additional + // results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotsitewise/api_op_ListAssetModels.go b/service/iotsitewise/api_op_ListAssetModels.go index e1b0058a292..8d21374da70 100644 --- a/service/iotsitewise/api_op_ListAssetModels.go +++ b/service/iotsitewise/api_op_ListAssetModels.go @@ -56,11 +56,11 @@ func (c *Client) ListAssetModels(ctx context.Context, params *ListAssetModelsInp type ListAssetModelsInput struct { - // The token to be used for the next set of paginated results. - NextToken *string - // The maximum number of results to be returned per paginated request. MaxResults *int32 + + // The token to be used for the next set of paginated results. + NextToken *string } type ListAssetModelsOutput struct { diff --git a/service/iotsitewise/api_op_ListAssets.go b/service/iotsitewise/api_op_ListAssets.go index 8c8334a1b6e..6f03790d94f 100644 --- a/service/iotsitewise/api_op_ListAssets.go +++ b/service/iotsitewise/api_op_ListAssets.go @@ -83,11 +83,11 @@ type ListAssetsInput struct { // tree. Filter types.ListAssetsFilter - // The token to be used for the next set of paginated results. - NextToken *string - // The maximum number of results to be returned per paginated request. MaxResults *int32 + + // The token to be used for the next set of paginated results. + NextToken *string } type ListAssetsOutput struct { diff --git a/service/iotsitewise/api_op_ListAssociatedAssets.go b/service/iotsitewise/api_op_ListAssociatedAssets.go index 4ccbabcbc09..4bc8a2ef651 100644 --- a/service/iotsitewise/api_op_ListAssociatedAssets.go +++ b/service/iotsitewise/api_op_ListAssociatedAssets.go @@ -63,9 +63,6 @@ type ListAssociatedAssetsInput struct { // This member is required. AssetId *string - // The maximum number of results to be returned per paginated request. - MaxResults *int32 - // The hierarchy ID (of the parent asset model) whose associated assets are // returned. To find a hierarchy ID, use the DescribeAsset // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html) @@ -78,21 +75,24 @@ type ListAssociatedAssetsInput struct { // This member is required. HierarchyId *string + // The maximum number of results to be returned per paginated request. + MaxResults *int32 + // The token to be used for the next set of paginated results. NextToken *string } type ListAssociatedAssetsOutput struct { - // The token for the next set of results, or null if there are no additional - // results. - NextToken *string - // A list that summarizes the associated assets. // // This member is required. AssetSummaries []*types.AssociatedAssetsSummary + // The token for the next set of results, or null if there are no additional + // results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotsitewise/api_op_ListDashboards.go b/service/iotsitewise/api_op_ListDashboards.go index 5811cb52141..a1a3369cc41 100644 --- a/service/iotsitewise/api_op_ListDashboards.go +++ b/service/iotsitewise/api_op_ListDashboards.go @@ -72,15 +72,15 @@ type ListDashboardsInput struct { type ListDashboardsOutput struct { - // The token for the next set of results, or null if there are no additional - // results. - NextToken *string - // A list that summarizes each dashboard in the project. // // This member is required. DashboardSummaries []*types.DashboardSummary + // The token for the next set of results, or null if there are no additional + // results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotsitewise/api_op_ListGateways.go b/service/iotsitewise/api_op_ListGateways.go index 6d6d256617d..e828d8b38ee 100644 --- a/service/iotsitewise/api_op_ListGateways.go +++ b/service/iotsitewise/api_op_ListGateways.go @@ -56,11 +56,11 @@ func (c *Client) ListGateways(ctx context.Context, params *ListGatewaysInput, op type ListGatewaysInput struct { - // The token to be used for the next set of paginated results. - NextToken *string - // The maximum number of results to be returned per paginated request. MaxResults *int32 + + // The token to be used for the next set of paginated results. + NextToken *string } type ListGatewaysOutput struct { diff --git a/service/iotsitewise/api_op_ListProjectAssets.go b/service/iotsitewise/api_op_ListProjectAssets.go index 781f12e5385..74a63b48b0a 100644 --- a/service/iotsitewise/api_op_ListProjectAssets.go +++ b/service/iotsitewise/api_op_ListProjectAssets.go @@ -57,29 +57,29 @@ func (c *Client) ListProjectAssets(ctx context.Context, params *ListProjectAsset type ListProjectAssetsInput struct { - // The maximum number of results to be returned per paginated request. - MaxResults *int32 - // The ID of the project. // // This member is required. ProjectId *string + // The maximum number of results to be returned per paginated request. + MaxResults *int32 + // The token to be used for the next set of paginated results. NextToken *string } type ListProjectAssetsOutput struct { - // The token for the next set of results, or null if there are no additional - // results. - NextToken *string - // A list that contains the IDs of each asset associated with the project. // // This member is required. AssetIds []*string + // The token for the next set of results, or null if there are no additional + // results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotsitewise/api_op_ListProjects.go b/service/iotsitewise/api_op_ListProjects.go index ac125521089..d8c42dff9f4 100644 --- a/service/iotsitewise/api_op_ListProjects.go +++ b/service/iotsitewise/api_op_ListProjects.go @@ -62,24 +62,24 @@ type ListProjectsInput struct { // This member is required. PortalId *string - // The token to be used for the next set of paginated results. - NextToken *string - // The maximum number of results to be returned per paginated request. MaxResults *int32 + + // The token to be used for the next set of paginated results. + NextToken *string } type ListProjectsOutput struct { - // The token for the next set of results, or null if there are no additional - // results. - NextToken *string - // A list that summarizes each project in the portal. // // This member is required. ProjectSummaries []*types.ProjectSummary + // The token for the next set of results, or null if there are no additional + // results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotsitewise/api_op_UntagResource.go b/service/iotsitewise/api_op_UntagResource.go index 82eab15ebfc..a2474d42649 100644 --- a/service/iotsitewise/api_op_UntagResource.go +++ b/service/iotsitewise/api_op_UntagResource.go @@ -56,17 +56,17 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // A list of keys for tags to remove from the resource. - // - // This member is required. - TagKeys []*string - // The ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the resource to untag. // // This member is required. ResourceArn *string + + // A list of keys for tags to remove from the resource. + // + // This member is required. + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/iotsitewise/api_op_UpdateAccessPolicy.go b/service/iotsitewise/api_op_UpdateAccessPolicy.go index a9825cbdc40..fbc96c72cba 100644 --- a/service/iotsitewise/api_op_UpdateAccessPolicy.go +++ b/service/iotsitewise/api_op_UpdateAccessPolicy.go @@ -60,21 +60,22 @@ func (c *Client) UpdateAccessPolicy(ctx context.Context, params *UpdateAccessPol type UpdateAccessPolicyInput struct { - // The permission level for this access policy. Note that a project ADMINISTRATOR - // is also known as a project owner. + // The ID of the access policy. // // This member is required. - AccessPolicyPermission types.Permission + AccessPolicyId *string - // A unique case-sensitive identifier that you can provide to ensure the - // idempotency of the request. Don't reuse this client token if a new idempotent - // request is required. - ClientToken *string + // The identity for this access policy. Choose either a user or a group but not + // both. + // + // This member is required. + AccessPolicyIdentity *types.Identity - // The ID of the access policy. + // The permission level for this access policy. Note that a project ADMINISTRATOR + // is also known as a project owner. // // This member is required. - AccessPolicyId *string + AccessPolicyPermission types.Permission // The AWS IoT SiteWise Monitor resource for this access policy. Choose either // portal or project but not both. @@ -82,11 +83,10 @@ type UpdateAccessPolicyInput struct { // This member is required. AccessPolicyResource *types.Resource - // The identity for this access policy. Choose either a user or a group but not - // both. - // - // This member is required. - AccessPolicyIdentity *types.Identity + // A unique case-sensitive identifier that you can provide to ensure the + // idempotency of the request. Don't reuse this client token if a new idempotent + // request is required. + ClientToken *string } type UpdateAccessPolicyOutput struct { diff --git a/service/iotsitewise/api_op_UpdateAsset.go b/service/iotsitewise/api_op_UpdateAsset.go index 5c82e7cd33e..114bcaf5f6b 100644 --- a/service/iotsitewise/api_op_UpdateAsset.go +++ b/service/iotsitewise/api_op_UpdateAsset.go @@ -61,15 +61,15 @@ func (c *Client) UpdateAsset(ctx context.Context, params *UpdateAssetInput, optF type UpdateAssetInput struct { - // A unique, friendly name for the asset. + // The ID of the asset to update. // // This member is required. - AssetName *string + AssetId *string - // The ID of the asset to update. + // A unique, friendly name for the asset. // // This member is required. - AssetId *string + AssetName *string // A unique case-sensitive identifier that you can provide to ensure the // idempotency of the request. Don't reuse this client token if a new idempotent diff --git a/service/iotsitewise/api_op_UpdateAssetModel.go b/service/iotsitewise/api_op_UpdateAssetModel.go index d7f381eb6a6..4bf0eb36c42 100644 --- a/service/iotsitewise/api_op_UpdateAssetModel.go +++ b/service/iotsitewise/api_op_UpdateAssetModel.go @@ -82,23 +82,9 @@ type UpdateAssetModelInput struct { // This member is required. AssetModelName *string - // A unique case-sensitive identifier that you can provide to ensure the - // idempotency of the request. Don't reuse this client token if a new idempotent - // request is required. - ClientToken *string - // A description for the asset model. AssetModelDescription *string - // The updated property definitions of the asset model. For more information, see - // Asset Properties - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html) - // in the AWS IoT SiteWise User Guide. You can specify up to 200 properties per - // asset model. For more information, see Quotas - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the - // AWS IoT SiteWise User Guide. - AssetModelProperties []*types.AssetModelProperty - // The updated hierarchy definitions of the asset model. Each hierarchy specifies // an asset model whose assets can be children of any other assets created from // this asset model. For more information, see Asset Hierarchies @@ -108,6 +94,20 @@ type UpdateAssetModelInput struct { // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the // AWS IoT SiteWise User Guide. AssetModelHierarchies []*types.AssetModelHierarchy + + // The updated property definitions of the asset model. For more information, see + // Asset Properties + // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html) + // in the AWS IoT SiteWise User Guide. You can specify up to 200 properties per + // asset model. For more information, see Quotas + // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the + // AWS IoT SiteWise User Guide. + AssetModelProperties []*types.AssetModelProperty + + // A unique case-sensitive identifier that you can provide to ensure the + // idempotency of the request. Don't reuse this client token if a new idempotent + // request is required. + ClientToken *string } type UpdateAssetModelOutput struct { diff --git a/service/iotsitewise/api_op_UpdateAssetProperty.go b/service/iotsitewise/api_op_UpdateAssetProperty.go index 091319a1f43..f57007f71ee 100644 --- a/service/iotsitewise/api_op_UpdateAssetProperty.go +++ b/service/iotsitewise/api_op_UpdateAssetProperty.go @@ -64,6 +64,16 @@ func (c *Client) UpdateAssetProperty(ctx context.Context, params *UpdateAssetPro type UpdateAssetPropertyInput struct { + // The ID of the asset to be updated. + // + // This member is required. + AssetId *string + + // The ID of the asset property to be updated. + // + // This member is required. + PropertyId *string + // A unique case-sensitive identifier that you can provide to ensure the // idempotency of the request. Don't reuse this client token if a new idempotent // request is required. @@ -77,16 +87,6 @@ type UpdateAssetPropertyInput struct { // removed from the property. PropertyAlias *string - // The ID of the asset property to be updated. - // - // This member is required. - PropertyId *string - - // The ID of the asset to be updated. - // - // This member is required. - AssetId *string - // The MQTT notification state (enabled or disabled) for this asset property. When // the notification state is enabled, AWS IoT SiteWise publishes property value // updates to a unique MQTT topic. For more information, see Interacting with Other diff --git a/service/iotsitewise/api_op_UpdateDashboard.go b/service/iotsitewise/api_op_UpdateDashboard.go index cb57fef99c8..0eb47fd1238 100644 --- a/service/iotsitewise/api_op_UpdateDashboard.go +++ b/service/iotsitewise/api_op_UpdateDashboard.go @@ -58,31 +58,31 @@ func (c *Client) UpdateDashboard(ctx context.Context, params *UpdateDashboardInp type UpdateDashboardInput struct { - // A new friendly name for the dashboard. + // The new dashboard definition, as specified in a JSON literal. For detailed + // information, see Creating Dashboards (CLI) + // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html) + // in the AWS IoT SiteWise User Guide. // // This member is required. - DashboardName *string + DashboardDefinition *string // The ID of the dashboard to update. // // This member is required. DashboardId *string - // A new description for the dashboard. - DashboardDescription *string - - // The new dashboard definition, as specified in a JSON literal. For detailed - // information, see Creating Dashboards (CLI) - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html) - // in the AWS IoT SiteWise User Guide. + // A new friendly name for the dashboard. // // This member is required. - DashboardDefinition *string + DashboardName *string // A unique case-sensitive identifier that you can provide to ensure the // idempotency of the request. Don't reuse this client token if a new idempotent // request is required. ClientToken *string + + // A new description for the dashboard. + DashboardDescription *string } type UpdateDashboardOutput struct { diff --git a/service/iotsitewise/api_op_UpdateGateway.go b/service/iotsitewise/api_op_UpdateGateway.go index b69ed1763c8..197b7846803 100644 --- a/service/iotsitewise/api_op_UpdateGateway.go +++ b/service/iotsitewise/api_op_UpdateGateway.go @@ -56,15 +56,15 @@ func (c *Client) UpdateGateway(ctx context.Context, params *UpdateGatewayInput, type UpdateGatewayInput struct { - // A unique, friendly name for the gateway. + // The ID of the gateway to update. // // This member is required. - GatewayName *string + GatewayId *string - // The ID of the gateway to update. + // A unique, friendly name for the gateway. // // This member is required. - GatewayId *string + GatewayName *string } type UpdateGatewayOutput struct { diff --git a/service/iotsitewise/api_op_UpdateGatewayCapabilityConfiguration.go b/service/iotsitewise/api_op_UpdateGatewayCapabilityConfiguration.go index c7aa134f0b3..1af84641457 100644 --- a/service/iotsitewise/api_op_UpdateGatewayCapabilityConfiguration.go +++ b/service/iotsitewise/api_op_UpdateGatewayCapabilityConfiguration.go @@ -63,14 +63,6 @@ func (c *Client) UpdateGatewayCapabilityConfiguration(ctx context.Context, param type UpdateGatewayCapabilityConfigurationInput struct { - // The namespace of the gateway capability configuration to be updated. For - // example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your - // OPC-UA capability configuration has the namespace - // iotsitewise:opcuacollector:version, where version is a number such as 1. - // - // This member is required. - CapabilityNamespace *string - // The JSON document that defines the configuration for the gateway capability. For // more information, see Configuring data sources (CLI) // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli) @@ -79,6 +71,14 @@ type UpdateGatewayCapabilityConfigurationInput struct { // This member is required. CapabilityConfiguration *string + // The namespace of the gateway capability configuration to be updated. For + // example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your + // OPC-UA capability configuration has the namespace + // iotsitewise:opcuacollector:version, where version is a number such as 1. + // + // This member is required. + CapabilityNamespace *string + // The ID of the gateway to be updated. // // This member is required. @@ -87,6 +87,11 @@ type UpdateGatewayCapabilityConfigurationInput struct { type UpdateGatewayCapabilityConfigurationOutput struct { + // The namespace of the gateway capability. + // + // This member is required. + CapabilityNamespace *string + // The synchronization status of the capability configuration. The sync status can // be one of the following: // @@ -106,11 +111,6 @@ type UpdateGatewayCapabilityConfigurationOutput struct { // This member is required. CapabilitySyncStatus types.CapabilitySyncStatus - // The namespace of the gateway capability. - // - // This member is required. - CapabilityNamespace *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotsitewise/api_op_UpdatePortal.go b/service/iotsitewise/api_op_UpdatePortal.go index dba80e1255b..96dd4b3749d 100644 --- a/service/iotsitewise/api_op_UpdatePortal.go +++ b/service/iotsitewise/api_op_UpdatePortal.go @@ -59,37 +59,20 @@ func (c *Client) UpdatePortal(ctx context.Context, params *UpdatePortalInput, op type UpdatePortalInput struct { - // A new friendly name for the portal. + // The AWS administrator's contact email address. // // This member is required. - PortalName *string - - // A new description for the portal. - PortalDescription *string - - // Contains an image that is one of the following: - // - // * An image file. Choose - // this option to upload a new image. - // - // * The ID of an existing image. Choose - // this option to keep an existing image. - PortalLogoImage *types.Image - - // A unique case-sensitive identifier that you can provide to ensure the - // idempotency of the request. Don't reuse this client token if a new idempotent - // request is required. - ClientToken *string + PortalContactEmail *string // The ID of the portal to update. // // This member is required. PortalId *string - // The AWS administrator's contact email address. + // A new friendly name for the portal. // // This member is required. - PortalContactEmail *string + PortalName *string // The ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of @@ -101,6 +84,23 @@ type UpdatePortalInput struct { // // This member is required. RoleArn *string + + // A unique case-sensitive identifier that you can provide to ensure the + // idempotency of the request. Don't reuse this client token if a new idempotent + // request is required. + ClientToken *string + + // A new description for the portal. + PortalDescription *string + + // Contains an image that is one of the following: + // + // * An image file. Choose + // this option to upload a new image. + // + // * The ID of an existing image. Choose + // this option to keep an existing image. + PortalLogoImage *types.Image } type UpdatePortalOutput struct { diff --git a/service/iotsitewise/api_op_UpdateProject.go b/service/iotsitewise/api_op_UpdateProject.go index 7c09a056ce2..bd9b17b13b6 100644 --- a/service/iotsitewise/api_op_UpdateProject.go +++ b/service/iotsitewise/api_op_UpdateProject.go @@ -58,23 +58,23 @@ func (c *Client) UpdateProject(ctx context.Context, params *UpdateProjectInput, type UpdateProjectInput struct { - // A new description for the project. - ProjectDescription *string - - // A new friendly name for the project. + // The ID of the project to update. // // This member is required. - ProjectName *string + ProjectId *string - // The ID of the project to update. + // A new friendly name for the project. // // This member is required. - ProjectId *string + ProjectName *string // A unique case-sensitive identifier that you can provide to ensure the // idempotency of the request. Don't reuse this client token if a new idempotent // request is required. ClientToken *string + + // A new description for the project. + ProjectDescription *string } type UpdateProjectOutput struct { diff --git a/service/iotsitewise/go.mod b/service/iotsitewise/go.mod index 9ba31cd4561..5d1ed7bd733 100644 --- a/service/iotsitewise/go.mod +++ b/service/iotsitewise/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/iotsitewise go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/iotsitewise/types/types.go b/service/iotsitewise/types/types.go index d4d03e55c5a..d75edcccb46 100644 --- a/service/iotsitewise/types/types.go +++ b/service/iotsitewise/types/types.go @@ -10,13 +10,10 @@ import ( // IoT SiteWise Monitor resource. type AccessPolicySummary struct { - // The AWS IoT SiteWise Monitor resource (a portal or project). + // The ID of the access policy. // // This member is required. - Resource *Resource - - // The date the access policy was last updated, in Unix epoch time. - LastUpdateDate *time.Time + Id *string // The AWS SSO identity (a user or group). // @@ -29,28 +26,31 @@ type AccessPolicySummary struct { // This member is required. Permission Permission - // The ID of the access policy. + // The AWS IoT SiteWise Monitor resource (a portal or project). // // This member is required. - Id *string + Resource *Resource // The date the access policy was created, in Unix epoch time. CreationDate *time.Time + + // The date the access policy was last updated, in Unix epoch time. + LastUpdateDate *time.Time } // Contains aggregated asset property values (for example, average, minimum, and // maximum). type AggregatedValue struct { - // The value of the aggregates. + // The date the aggregating computations occurred, in Unix epoch time. // // This member is required. - Value *Aggregates + Timestamp *time.Time - // The date the aggregating computations occurred, in Unix epoch time. + // The value of the aggregates. // // This member is required. - Timestamp *time.Time + Value *Aggregates // The quality of the aggregated data. Quality Quality @@ -59,28 +59,33 @@ type AggregatedValue struct { // Contains the (pre-calculated) aggregate values for an asset property. type Aggregates struct { - // The sum of the time series over a time interval window. - Sum *float64 - // The average (mean) value of the time series over a time interval window. Average *float64 + // The count of data points in the time series over a time interval window. + Count *float64 + // The maximum value of the time series over a time interval window. Maximum *float64 - // The count of data points in the time series over a time interval window. - Count *float64 + // The minimum value of the time series over a time interval window. + Minimum *float64 // The standard deviation of the time series over a time interval window. StandardDeviation *float64 - // The minimum value of the time series over a time interval window. - Minimum *float64 + // The sum of the time series over a time interval window. + Sum *float64 } // Contains error details for the requested associate project asset action. type AssetErrorDetails struct { + // The ID of the asset. + // + // This member is required. + AssetId *string + // The error code. // // This member is required. @@ -90,11 +95,6 @@ type AssetErrorDetails struct { // // This member is required. Message *string - - // The ID of the asset. - // - // This member is required. - AssetId *string } // Describes an asset hierarchy that contains a hierarchy's name and ID. @@ -123,9 +123,6 @@ type AssetModelHierarchy struct { // This member is required. ChildAssetModelId *string - // The ID of the asset model hierarchy. This ID is a hierarchyId. - Id *string - // The name of the asset model hierarchy that you specify by using the // CreateAssetModel // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html) @@ -135,6 +132,9 @@ type AssetModelHierarchy struct { // // This member is required. Name *string + + // The ID of the asset model hierarchy. This ID is a hierarchyId. + Id *string } // Contains an asset model hierarchy used in asset model creation. An asset model @@ -159,11 +159,10 @@ type AssetModelHierarchyDefinition struct { // Contains information about an asset model property. type AssetModelProperty struct { - // The ID of the asset model property. - Id *string - - // The unit of the asset model property, such as Newtons or RPM. - Unit *string + // The data type of the asset model property. + // + // This member is required. + DataType PropertyDataType // The name of the asset model property. // @@ -175,22 +174,17 @@ type AssetModelProperty struct { // This member is required. Type *PropertyType - // The data type of the asset model property. - // - // This member is required. - DataType PropertyDataType + // The ID of the asset model property. + Id *string + + // The unit of the asset model property, such as Newtons or RPM. + Unit *string } // Contains an asset model property definition. This property definition is applied // to all assets created from the asset model. type AssetModelPropertyDefinition struct { - // The property definition type (see PropertyType). You can only specify one type - // in a property definition. - // - // This member is required. - Type *PropertyType - // The data type of the property definition. // // This member is required. @@ -201,6 +195,12 @@ type AssetModelPropertyDefinition struct { // This member is required. Name *string + // The property definition type (see PropertyType). You can only specify one type + // in a property definition. + // + // This member is required. + Type *PropertyType + // The unit of the property definition, such as Newtons or RPM. Unit *string } @@ -223,11 +223,6 @@ type AssetModelStatus struct { // Contains a summary of an asset model. type AssetModelSummary struct { - // The date the asset model was created, in Unix epoch time. - // - // This member is required. - CreationDate *time.Time - // The ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the asset model, which has the following format. @@ -236,55 +231,45 @@ type AssetModelSummary struct { // This member is required. Arn *string - // The ID of the asset model (used with AWS IoT SiteWise APIs). - // - // This member is required. - Id *string - - // The name of the asset model. + // The date the asset model was created, in Unix epoch time. // // This member is required. - Name *string + CreationDate *time.Time // The asset model description. // // This member is required. Description *string - // The current status of the asset model. + // The ID of the asset model (used with AWS IoT SiteWise APIs). // // This member is required. - Status *AssetModelStatus + Id *string // The date the asset model was last updated, in Unix epoch time. // // This member is required. LastUpdateDate *time.Time + + // The name of the asset model. + // + // This member is required. + Name *string + + // The current status of the asset model. + // + // This member is required. + Status *AssetModelStatus } // Contains asset property information. type AssetProperty struct { - // The asset property's notification topic and state. For more information, see - // UpdateAssetProperty - // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html) - Notification *PropertyNotification - // The data type of the asset property. // // This member is required. DataType PropertyDataType - // The unit (such as Newtons or RPM) of the asset property. - Unit *string - - // The property alias that identifies the property, such as an OPC-UA server data - // stream path (for example, /company/windfarm/3/turbine/7/temperature). For more - // information, see Mapping Industrial Data Streams to Asset Properties - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) - // in the AWS IoT SiteWise User Guide. - Alias *string - // The ID of the asset property. // // This member is required. @@ -294,20 +279,35 @@ type AssetProperty struct { // // This member is required. Name *string + + // The property alias that identifies the property, such as an OPC-UA server data + // stream path (for example, /company/windfarm/3/turbine/7/temperature). For more + // information, see Mapping Industrial Data Streams to Asset Properties + // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) + // in the AWS IoT SiteWise User Guide. + Alias *string + + // The asset property's notification topic and state. For more information, see + // UpdateAssetProperty + // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html) + Notification *PropertyNotification + + // The unit (such as Newtons or RPM) of the asset property. + Unit *string } // Contains asset property value information. type AssetPropertyValue struct { - // The value of the asset property (see Variant). + // The timestamp of the asset property value. // // This member is required. - Value *Variant + Timestamp *TimeInNanos - // The timestamp of the asset property value. + // The value of the asset property (see Variant). // // This member is required. - Timestamp *TimeInNanos + Value *Variant // The quality of the asset property value. Quality Quality @@ -319,34 +319,18 @@ type AssetPropertyValue struct { // in the AWS IoT SiteWise User Guide. type AssetStatus struct { - // Contains associated error information, if any. - Error *ErrorDetails - // The current status of the asset. // // This member is required. State AssetState + + // Contains associated error information, if any. + Error *ErrorDetails } // Contains a summary of an asset. type AssetSummary struct { - // A list of asset hierarchies that each contain a hierarchyId. A hierarchy - // specifies allowed parent/child asset relationships. - // - // This member is required. - Hierarchies []*AssetHierarchy - - // The ID of the asset. - // - // This member is required. - Id *string - - // The name of the asset. - // - // This member is required. - Name *string - // The ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the asset, which has the following format. @@ -355,44 +339,45 @@ type AssetSummary struct { // This member is required. Arn *string + // The ID of the asset model used to create this asset. + // + // This member is required. + AssetModelId *string + // The date the asset was created, in Unix epoch time. // // This member is required. CreationDate *time.Time - // The current status of the asset. + // A list of asset hierarchies that each contain a hierarchyId. A hierarchy + // specifies allowed parent/child asset relationships. // // This member is required. - Status *AssetStatus + Hierarchies []*AssetHierarchy - // The ID of the asset model used to create this asset. + // The ID of the asset. // // This member is required. - AssetModelId *string + Id *string // The date the asset was last updated, in Unix epoch time. // // This member is required. LastUpdateDate *time.Time -} -// Contains a summary of an associated asset. -type AssociatedAssetsSummary struct { - - // The date the asset was created, in Unix epoch time. + // The name of the asset. // // This member is required. - CreationDate *time.Time + Name *string - // The ID of the asset model used to create the asset. + // The current status of the asset. // // This member is required. - AssetModelId *string + Status *AssetStatus +} - // The name of the asset. - // - // This member is required. - Name *string +// Contains a summary of an associated asset. +type AssociatedAssetsSummary struct { // The ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of @@ -402,15 +387,15 @@ type AssociatedAssetsSummary struct { // This member is required. Arn *string - // The date the asset was last updated, in Unix epoch time. + // The ID of the asset model used to create the asset. // // This member is required. - LastUpdateDate *time.Time + AssetModelId *string - // The current status of the asset. + // The date the asset was created, in Unix epoch time. // // This member is required. - Status *AssetStatus + CreationDate *time.Time // A list of asset hierarchies that each contain a hierarchyId. A hierarchy // specifies allowed parent/child asset relationships. @@ -422,6 +407,21 @@ type AssociatedAssetsSummary struct { // // This member is required. Id *string + + // The date the asset was last updated, in Unix epoch time. + // + // This member is required. + LastUpdateDate *time.Time + + // The name of the asset. + // + // This member is required. + Name *string + + // The current status of the asset. + // + // This member is required. + Status *AssetStatus } // Contains an asset attribute property. For more information, see Attributes @@ -441,11 +441,6 @@ type Attribute struct { // Contains error information from updating a batch of asset property values. type BatchPutAssetPropertyError struct { - // A list of timestamps for each error, if any. - // - // This member is required. - Timestamps []*TimeInNanos - // The error code. // // This member is required. @@ -455,6 +450,11 @@ type BatchPutAssetPropertyError struct { // // This member is required. ErrorMessage *string + + // A list of timestamps for each error, if any. + // + // This member is required. + Timestamps []*TimeInNanos } // Contains error information for asset property value entries that are associated @@ -463,15 +463,15 @@ type BatchPutAssetPropertyError struct { // API. type BatchPutAssetPropertyErrorEntry struct { - // The list of update property value errors. + // The ID of the failed entry. // // This member is required. - Errors []*BatchPutAssetPropertyError + EntryId *string - // The ID of the failed entry. + // The list of update property value errors. // // This member is required. - EntryId *string + Errors []*BatchPutAssetPropertyError } // Contains a dashboard summary. @@ -482,19 +482,19 @@ type DashboardSummary struct { // This member is required. Id *string + // The name of the dashboard + // + // This member is required. + Name *string + // The date the dashboard was created, in Unix epoch time. CreationDate *time.Time - // The date the dashboard was last updated, in Unix epoch time. - LastUpdateDate *time.Time - // The dashboard's description. Description *string - // The name of the dashboard - // - // This member is required. - Name *string + // The date the dashboard was last updated, in Unix epoch time. + LastUpdateDate *time.Time } // Contains the details of an AWS IoT SiteWise error. @@ -514,15 +514,15 @@ type ErrorDetails struct { // Contains expression variable information. type ExpressionVariable struct { - // The variable that identifies an asset property from which to use values. + // The friendly name of the variable to be used in the expression. // // This member is required. - Value *VariableValue + Name *string - // The friendly name of the variable to be used in the expression. + // The variable that identifies an asset property from which to use values. // // This member is required. - Name *string + Value *VariableValue } // Contains a summary of a gateway capability configuration. @@ -564,20 +564,25 @@ type GatewayPlatform struct { // Contains a summary of a gateway. type GatewaySummary struct { - // The date the gateway was last updated, in Unix epoch time. + // The date the gateway was created, in Unix epoch time. // // This member is required. - LastUpdateDate *time.Time + CreationDate *time.Time + + // The ID of the gateway device. + // + // This member is required. + GatewayId *string // The name of the asset. // // This member is required. GatewayName *string - // The date the gateway was created, in Unix epoch time. + // The date the gateway was last updated, in Unix epoch time. // // This member is required. - CreationDate *time.Time + LastUpdateDate *time.Time // A list of gateway capability summaries that each contain a namespace and status. // Each gateway capability defines data sources for the gateway. To retrieve a @@ -585,11 +590,6 @@ type GatewaySummary struct { // DescribeGatewayCapabilityConfiguration // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html). GatewayCapabilitySummaries []*GatewayCapabilitySummary - - // The ID of the gateway device. - // - // This member is required. - GatewayId *string } // Contains details for a gateway that runs on AWS IoT Greengrass. To create a @@ -645,11 +645,11 @@ type Identity struct { // this option to keep an existing image. type Image struct { - // The ID of an existing image. Specify this parameter to keep an existing image. - Id *string - // Contains an image file. File *ImageFile + + // The ID of an existing image. Specify this parameter to keep an existing image. + Id *string } // Contains an image file. @@ -670,16 +670,16 @@ type ImageFile struct { // Contains an image that is uploaded to AWS IoT SiteWise and available at a URL. type ImageLocation struct { - // The URL where the image is available. The URL is valid for 15 minutes so that - // you can view and download the image + // The ID of the image. // // This member is required. - Url *string + Id *string - // The ID of the image. + // The URL where the image is available. The URL is valid for 15 minutes so that + // you can view and download the image // // This member is required. - Id *string + Url *string } // Contains logging options. @@ -710,25 +710,25 @@ type Measurement struct { // in the AWS IoT SiteWise User Guide. type Metric struct { - // The window (time interval) over which AWS IoT SiteWise computes the metric's - // aggregation expression. AWS IoT SiteWise computes one data point per window. + // The mathematical expression that defines the metric aggregation function. You + // can specify up to 10 variables per expression. You can specify up to 10 + // functions per expression. For more information, see Quotas + // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the + // AWS IoT SiteWise User Guide. // // This member is required. - Window *MetricWindow + Expression *string // The list of variables used in the expression. // // This member is required. Variables []*ExpressionVariable - // The mathematical expression that defines the metric aggregation function. You - // can specify up to 10 variables per expression. You can specify up to 10 - // functions per expression. For more information, see Quotas - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the - // AWS IoT SiteWise User Guide. + // The window (time interval) over which AWS IoT SiteWise computes the metric's + // aggregation expression. AWS IoT SiteWise computes one data point per window. // // This member is required. - Expression *string + Window *MetricWindow } // Contains a time interval window used for data aggregate computations (for @@ -742,11 +742,11 @@ type MetricWindow struct { // Contains AWS IoT SiteWise Monitor error details. type MonitorErrorDetails struct { - // The error message. - Message *string - // The error code. Code MonitorErrorCode + + // The error message. + Message *string } // Identifies an AWS IoT SiteWise Monitor portal. @@ -761,18 +761,36 @@ type PortalResource struct { // Contains information about the current status of a portal. type PortalStatus struct { - // Contains associated error information, if any. - Error *MonitorErrorDetails - // The current state of the portal. // // This member is required. State PortalState + + // Contains associated error information, if any. + Error *MonitorErrorDetails } // Contains a portal summary. type PortalSummary struct { + // The ID of the portal. + // + // This member is required. + Id *string + + // The name of the portal. + // + // This member is required. + Name *string + + // The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal. + // + // This member is required. + StartUrl *string + + // The date the portal was created, in Unix epoch time. + CreationDate *time.Time + // The portal's description. Description *string @@ -787,24 +805,6 @@ type PortalSummary struct { // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) // in the AWS IoT SiteWise User Guide. RoleArn *string - - // The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal. - // - // This member is required. - StartUrl *string - - // The name of the portal. - // - // This member is required. - Name *string - - // The ID of the portal. - // - // This member is required. - Id *string - - // The date the portal was created, in Unix epoch time. - CreationDate *time.Time } // Identifies a specific AWS IoT SiteWise Monitor project. @@ -819,29 +819,44 @@ type ProjectResource struct { // Contains project summary information. type ProjectSummary struct { - // The project's description. - Description *string - - // The date the project was last updated, in Unix epoch time. - LastUpdateDate *time.Time - // The ID of the project. // // This member is required. Id *string - // The date the project was created, in Unix epoch time. - CreationDate *time.Time - // The name of the project. // // This member is required. Name *string + + // The date the project was created, in Unix epoch time. + CreationDate *time.Time + + // The project's description. + Description *string + + // The date the project was last updated, in Unix epoch time. + LastUpdateDate *time.Time } // Contains asset property information. type Property struct { + // The property data type. + // + // This member is required. + DataType PropertyDataType + + // The ID of the asset property. + // + // This member is required. + Id *string + + // The name of the property. + // + // This member is required. + Name *string + // The property alias that identifies the property, such as an OPC-UA server data // stream path (for example, /company/windfarm/3/turbine/7/temperature). For more // information, see Mapping Industrial Data Streams to Asset Properties @@ -849,31 +864,16 @@ type Property struct { // in the AWS IoT SiteWise User Guide. Alias *string - // The property data type. - // - // This member is required. - DataType PropertyDataType - // The asset property's notification topic and state. For more information, see // UpdateAssetProperty // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html) Notification *PropertyNotification - // The unit (such as Newtons or RPM) of the asset property. - Unit *string - - // The ID of the asset property. - // - // This member is required. - Id *string - // The property type (see PropertyType). A property contains one type. Type *PropertyType - // The name of the property. - // - // This member is required. - Name *string + // The unit (such as Newtons or RPM) of the asset property. + Unit *string } // Contains asset property value notification information. When the notification @@ -899,6 +899,12 @@ type PropertyNotification struct { // transform. type PropertyType struct { + // Specifies an asset attribute property. An attribute generally contains static + // information, such as the serial number of an IIoT + // (https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications) wind + // turbine. + Attribute *Attribute + // Specifies an asset measurement property. A measurement represents a device's raw // sensor data stream, such as timestamped temperature values or timestamped power // values. @@ -910,12 +916,6 @@ type PropertyType struct { // temperature. Metric *Metric - // Specifies an asset attribute property. An attribute generally contains static - // information, such as the serial number of an IIoT - // (https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications) wind - // turbine. - Attribute *Attribute - // Specifies an asset transform property. A transform contains a mathematical // expression that maps a property's data points from one form to another, such as // a unit conversion from Celsius to Fahrenheit. @@ -928,15 +928,11 @@ type PropertyType struct { // API. type PutAssetPropertyValueEntry struct { - // The ID of the asset property for this entry. - PropertyId *string - - // The property alias that identifies the property, such as an OPC-UA server data - // stream path (for example, /company/windfarm/3/turbine/7/temperature). For more - // information, see Mapping Industrial Data Streams to Asset Properties - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) - // in the AWS IoT SiteWise User Guide. - PropertyAlias *string + // The user specified ID for the entry. You can use this ID to identify which + // entries failed. + // + // This member is required. + EntryId *string // The list of property values to upload. You can specify up to 10 propertyValues // array elements. @@ -944,14 +940,18 @@ type PutAssetPropertyValueEntry struct { // This member is required. PropertyValues []*AssetPropertyValue - // The user specified ID for the entry. You can use this ID to identify which - // entries failed. - // - // This member is required. - EntryId *string - // The ID of the asset to update. AssetId *string + + // The property alias that identifies the property, such as an OPC-UA server data + // stream path (for example, /company/windfarm/3/turbine/7/temperature). For more + // information, see Mapping Industrial Data Streams to Asset Properties + // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) + // in the AWS IoT SiteWise User Guide. + PropertyAlias *string + + // The ID of the asset property for this entry. + PropertyId *string } // Contains an AWS IoT SiteWise Monitor resource ID for a portal or project. @@ -967,14 +967,14 @@ type Resource struct { // Contains a timestamp with optional nanosecond granularity. type TimeInNanos struct { - // The nanosecond offset from timeInSeconds. - OffsetInNanos *int32 - // The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond // data is provided by offsetInNanos. // // This member is required. TimeInSeconds *int64 + + // The nanosecond offset from timeInSeconds. + OffsetInNanos *int32 } // Contains an asset transform property. A transform is a one-to-one mapping of a @@ -1052,15 +1052,15 @@ type VariableValue struct { // Contains an asset property value (of a single type only). type Variant struct { - // Asset property data of type string (sequence of characters). - StringValue *string - // Asset property data of type Boolean (true or false). BooleanValue *bool + // Asset property data of type double (floating point number). + DoubleValue *float64 + // Asset property data of type integer (whole number). IntegerValue *int32 - // Asset property data of type double (floating point number). - DoubleValue *float64 + // Asset property data of type string (sequence of characters). + StringValue *string } diff --git a/service/iotthingsgraph/api_op_AssociateEntityToThing.go b/service/iotthingsgraph/api_op_AssociateEntityToThing.go index 9380f183c99..00f78590401 100644 --- a/service/iotthingsgraph/api_op_AssociateEntityToThing.go +++ b/service/iotthingsgraph/api_op_AssociateEntityToThing.go @@ -58,20 +58,20 @@ func (c *Client) AssociateEntityToThing(ctx context.Context, params *AssociateEn type AssociateEntityToThingInput struct { - // The version of the user's namespace. Defaults to the latest version of the - // user's namespace. - NamespaceVersion *int64 + // The ID of the device to be associated with the thing. The ID should be in the + // following format. urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME + // + // This member is required. + EntityId *string // The name of the thing to which the entity is to be associated. // // This member is required. ThingName *string - // The ID of the device to be associated with the thing. The ID should be in the - // following format. urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME - // - // This member is required. - EntityId *string + // The version of the user's namespace. Defaults to the latest version of the + // user's namespace. + NamespaceVersion *int64 } type AssociateEntityToThingOutput struct { diff --git a/service/iotthingsgraph/api_op_CreateSystemInstance.go b/service/iotthingsgraph/api_op_CreateSystemInstance.go index 6e6adaf07d6..04bce7ed0ad 100644 --- a/service/iotthingsgraph/api_op_CreateSystemInstance.go +++ b/service/iotthingsgraph/api_op_CreateSystemInstance.go @@ -69,38 +69,38 @@ func (c *Client) CreateSystemInstance(ctx context.Context, params *CreateSystemI type CreateSystemInstanceInput struct { - // The name of the Amazon Simple Storage Service bucket that will be used to store - // and deploy the system instance's resource file. This value is required if the - // value of the target parameter is GREENGRASS. - S3BucketName *string - - // An object that specifies whether cloud metrics are collected in a deployment - // and, if so, what role is used to collect metrics. - MetricsConfiguration *types.MetricsConfiguration - - // The name of the Greengrass group where the system instance will be deployed. - // This value is required if the value of the target parameter is GREENGRASS. - GreengrassGroupName *string - - // Metadata, consisting of key-value pairs, that can be used to categorize your - // system instances. - Tags []*types.Tag - - // The target type of the deployment. Valid values are GREENGRASS and CLOUD. + // A document that defines an entity. // // This member is required. - Target types.DeploymentTarget + Definition *types.DefinitionDocument - // A document that defines an entity. + // The target type of the deployment. Valid values are GREENGRASS and CLOUD. // // This member is required. - Definition *types.DefinitionDocument + Target types.DeploymentTarget // The ARN of the IAM role that AWS IoT Things Graph will assume when it executes // the flow. This role must have read and write access to AWS Lambda and AWS IoT // and any other AWS services that the flow uses when it executes. This value is // required if the value of the target parameter is CLOUD. FlowActionsRoleArn *string + + // The name of the Greengrass group where the system instance will be deployed. + // This value is required if the value of the target parameter is GREENGRASS. + GreengrassGroupName *string + + // An object that specifies whether cloud metrics are collected in a deployment + // and, if so, what role is used to collect metrics. + MetricsConfiguration *types.MetricsConfiguration + + // The name of the Amazon Simple Storage Service bucket that will be used to store + // and deploy the system instance's resource file. This value is required if the + // value of the target parameter is GREENGRASS. + S3BucketName *string + + // Metadata, consisting of key-value pairs, that can be used to categorize your + // system instances. + Tags []*types.Tag } type CreateSystemInstanceOutput struct { diff --git a/service/iotthingsgraph/api_op_DeleteNamespace.go b/service/iotthingsgraph/api_op_DeleteNamespace.go index 87f7ae398ed..272c269afd7 100644 --- a/service/iotthingsgraph/api_op_DeleteNamespace.go +++ b/service/iotthingsgraph/api_op_DeleteNamespace.go @@ -60,12 +60,12 @@ type DeleteNamespaceInput struct { type DeleteNamespaceOutput struct { - // The name of the namespace to be deleted. - NamespaceName *string - // The ARN of the namespace to be deleted. NamespaceArn *string + // The name of the namespace to be deleted. + NamespaceName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotthingsgraph/api_op_DeploySystemInstance.go b/service/iotthingsgraph/api_op_DeploySystemInstance.go index b35732fb0bd..a6aa642e10c 100644 --- a/service/iotthingsgraph/api_op_DeploySystemInstance.go +++ b/service/iotthingsgraph/api_op_DeploySystemInstance.go @@ -74,15 +74,15 @@ type DeploySystemInstanceInput struct { type DeploySystemInstanceOutput struct { - // The ID of the Greengrass deployment used to deploy the system instance. - GreengrassDeploymentId *string - // An object that contains summary information about a system instance that was // deployed. // // This member is required. Summary *types.SystemInstanceSummary + // The ID of the Greengrass deployment used to deploy the system instance. + GreengrassDeploymentId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotthingsgraph/api_op_DescribeNamespace.go b/service/iotthingsgraph/api_op_DescribeNamespace.go index 7d1ab85252b..50020ba71c4 100644 --- a/service/iotthingsgraph/api_op_DescribeNamespace.go +++ b/service/iotthingsgraph/api_op_DescribeNamespace.go @@ -62,20 +62,20 @@ type DescribeNamespaceInput struct { type DescribeNamespaceOutput struct { - // The version of the public namespace that the latest version is tracking. - TrackingNamespaceVersion *int64 + // The ARN of the namespace. + NamespaceArn *string - // The name of the public namespace that the latest namespace version is tracking. - TrackingNamespaceName *string + // The name of the namespace. + NamespaceName *string // The version of the user's namespace to describe. NamespaceVersion *int64 - // The name of the namespace. - NamespaceName *string + // The name of the public namespace that the latest namespace version is tracking. + TrackingNamespaceName *string - // The ARN of the namespace. - NamespaceArn *string + // The version of the public namespace that the latest version is tracking. + TrackingNamespaceVersion *int64 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/iotthingsgraph/api_op_GetEntities.go b/service/iotthingsgraph/api_op_GetEntities.go index e3ab554cd80..a698bd292a4 100644 --- a/service/iotthingsgraph/api_op_GetEntities.go +++ b/service/iotthingsgraph/api_op_GetEntities.go @@ -81,15 +81,15 @@ func (c *Client) GetEntities(ctx context.Context, params *GetEntitiesInput, optF type GetEntitiesInput struct { - // The version of the user's namespace. Defaults to the latest version of the - // user's namespace. - NamespaceVersion *int64 - // An array of entity IDs. The IDs should be in the following format. // urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME // // This member is required. Ids []*string + + // The version of the user's namespace. Defaults to the latest version of the + // user's namespace. + NamespaceVersion *int64 } type GetEntitiesOutput struct { diff --git a/service/iotthingsgraph/api_op_GetFlowTemplateRevisions.go b/service/iotthingsgraph/api_op_GetFlowTemplateRevisions.go index e41db2b2005..96cb1af77c6 100644 --- a/service/iotthingsgraph/api_op_GetFlowTemplateRevisions.go +++ b/service/iotthingsgraph/api_op_GetFlowTemplateRevisions.go @@ -60,28 +60,28 @@ func (c *Client) GetFlowTemplateRevisions(ctx context.Context, params *GetFlowTe type GetFlowTemplateRevisionsInput struct { - // The string that specifies the next page of results. Use this when you're - // paginating results. - NextToken *string - - // The maximum number of results to return in the response. - MaxResults *int32 - // The ID of the workflow. The ID should be in the following format. // urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME // // This member is required. Id *string + + // The maximum number of results to return in the response. + MaxResults *int32 + + // The string that specifies the next page of results. Use this when you're + // paginating results. + NextToken *string } type GetFlowTemplateRevisionsOutput struct { - // An array of objects that provide summary data about each revision. - Summaries []*types.FlowTemplateSummary - // The string to specify as nextToken when you request the next page of results. NextToken *string + // An array of objects that provide summary data about each revision. + Summaries []*types.FlowTemplateSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotthingsgraph/api_op_GetNamespaceDeletionStatus.go b/service/iotthingsgraph/api_op_GetNamespaceDeletionStatus.go index fa1d8f41a06..4c670f1f754 100644 --- a/service/iotthingsgraph/api_op_GetNamespaceDeletionStatus.go +++ b/service/iotthingsgraph/api_op_GetNamespaceDeletionStatus.go @@ -59,20 +59,20 @@ type GetNamespaceDeletionStatusInput struct { type GetNamespaceDeletionStatusOutput struct { - // The name of the namespace that is being deleted. - NamespaceName *string - // An error code returned by the namespace deletion task. ErrorCode types.NamespaceDeletionStatusErrorCodes - // The status of the deletion request. - Status types.NamespaceDeletionStatus + // An error code returned by the namespace deletion task. + ErrorMessage *string // The ARN of the namespace that is being deleted. NamespaceArn *string - // An error code returned by the namespace deletion task. - ErrorMessage *string + // The name of the namespace that is being deleted. + NamespaceName *string + + // The status of the deletion request. + Status types.NamespaceDeletionStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/iotthingsgraph/api_op_GetSystemTemplate.go b/service/iotthingsgraph/api_op_GetSystemTemplate.go index ac15d955d99..1b1be17981c 100644 --- a/service/iotthingsgraph/api_op_GetSystemTemplate.go +++ b/service/iotthingsgraph/api_op_GetSystemTemplate.go @@ -57,15 +57,15 @@ func (c *Client) GetSystemTemplate(ctx context.Context, params *GetSystemTemplat type GetSystemTemplateInput struct { - // The number that specifies the revision of the system to get. - RevisionNumber *int64 - // The ID of the system to get. This ID must be in the user's namespace. The ID // should be in the following format. urn:tdm:REGION/ACCOUNT // ID/default:system:SYSTEMNAME // // This member is required. Id *string + + // The number that specifies the revision of the system to get. + RevisionNumber *int64 } type GetSystemTemplateOutput struct { diff --git a/service/iotthingsgraph/api_op_GetSystemTemplateRevisions.go b/service/iotthingsgraph/api_op_GetSystemTemplateRevisions.go index b266d954faf..10f1e79b3a0 100644 --- a/service/iotthingsgraph/api_op_GetSystemTemplateRevisions.go +++ b/service/iotthingsgraph/api_op_GetSystemTemplateRevisions.go @@ -76,13 +76,13 @@ type GetSystemTemplateRevisionsInput struct { type GetSystemTemplateRevisionsOutput struct { + // The string to specify as nextToken when you request the next page of results. + NextToken *string + // An array of objects that contain summary data about the system template // revisions. Summaries []*types.SystemTemplateSummary - // The string to specify as nextToken when you request the next page of results. - NextToken *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotthingsgraph/api_op_GetUploadStatus.go b/service/iotthingsgraph/api_op_GetUploadStatus.go index e665a1f4db5..3d198b693a0 100644 --- a/service/iotthingsgraph/api_op_GetUploadStatus.go +++ b/service/iotthingsgraph/api_op_GetUploadStatus.go @@ -67,34 +67,34 @@ type GetUploadStatusInput struct { type GetUploadStatusOutput struct { - // The ARN of the upload. - NamespaceArn *string - - // The reason for an upload failure. - FailureReason []*string + // The date at which the upload was created. + // + // This member is required. + CreatedDate *time.Time // The ID of the upload. // // This member is required. UploadId *string - // The name of the upload's namespace. - NamespaceName *string - - // The version of the user's namespace. Defaults to the latest version of the - // user's namespace. - NamespaceVersion *int64 - // The status of the upload. The initial status is IN_PROGRESS. The response show // all validation failures if the upload fails. // // This member is required. UploadStatus types.UploadStatus - // The date at which the upload was created. - // - // This member is required. - CreatedDate *time.Time + // The reason for an upload failure. + FailureReason []*string + + // The ARN of the upload. + NamespaceArn *string + + // The name of the upload's namespace. + NamespaceName *string + + // The version of the user's namespace. Defaults to the latest version of the + // user's namespace. + NamespaceVersion *int64 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/iotthingsgraph/api_op_ListFlowExecutionMessages.go b/service/iotthingsgraph/api_op_ListFlowExecutionMessages.go index 83572bcf40b..6ad9a3a3171 100644 --- a/service/iotthingsgraph/api_op_ListFlowExecutionMessages.go +++ b/service/iotthingsgraph/api_op_ListFlowExecutionMessages.go @@ -58,14 +58,14 @@ func (c *Client) ListFlowExecutionMessages(ctx context.Context, params *ListFlow type ListFlowExecutionMessagesInput struct { - // The maximum number of results to return in the response. - MaxResults *int32 - // The ID of the flow execution. // // This member is required. FlowExecutionId *string + // The maximum number of results to return in the response. + MaxResults *int32 + // The string that specifies the next page of results. Use this when you're // paginating results. NextToken *string diff --git a/service/iotthingsgraph/api_op_ListTagsForResource.go b/service/iotthingsgraph/api_op_ListTagsForResource.go index 1a672d5d417..b12d78bb86e 100644 --- a/service/iotthingsgraph/api_op_ListTagsForResource.go +++ b/service/iotthingsgraph/api_op_ListTagsForResource.go @@ -57,14 +57,14 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The maximum number of tags to return. - MaxResults *int32 - // The Amazon Resource Name (ARN) of the resource whose tags are to be returned. // // This member is required. ResourceArn *string + // The maximum number of tags to return. + MaxResults *int32 + // The token that specifies the next page of results to return. NextToken *string } diff --git a/service/iotthingsgraph/api_op_SearchEntities.go b/service/iotthingsgraph/api_op_SearchEntities.go index 1c6dd68fb6f..cf040c4e687 100644 --- a/service/iotthingsgraph/api_op_SearchEntities.go +++ b/service/iotthingsgraph/api_op_SearchEntities.go @@ -58,6 +58,11 @@ func (c *Client) SearchEntities(ctx context.Context, params *SearchEntitiesInput type SearchEntitiesInput struct { + // The entity types for which to search. + // + // This member is required. + EntityTypes []types.EntityType + // Optional filter to apply to the search. Valid filters are NAMENAMESPACE, // SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on // entities that are used by the entity in the result set. For example, you can @@ -66,18 +71,13 @@ type SearchEntitiesInput struct { // function as AND criteria. Filters []*types.EntityFilter - // The entity types for which to search. - // - // This member is required. - EntityTypes []types.EntityType + // The maximum number of results to return in the response. + MaxResults *int32 // The version of the user's namespace. Defaults to the latest version of the // user's namespace. NamespaceVersion *int64 - // The maximum number of results to return in the response. - MaxResults *int32 - // The string that specifies the next page of results. Use this when you're // paginating results. NextToken *string @@ -85,12 +85,12 @@ type SearchEntitiesInput struct { type SearchEntitiesOutput struct { - // The string to specify as nextToken when you request the next page of results. - NextToken *string - // An array of descriptions for each entity returned in the search result. Descriptions []*types.EntityDescription + // The string to specify as nextToken when you request the next page of results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotthingsgraph/api_op_SearchFlowExecutions.go b/service/iotthingsgraph/api_op_SearchFlowExecutions.go index 8a6ecea79e8..669b895d88f 100644 --- a/service/iotthingsgraph/api_op_SearchFlowExecutions.go +++ b/service/iotthingsgraph/api_op_SearchFlowExecutions.go @@ -58,26 +58,26 @@ func (c *Client) SearchFlowExecutions(ctx context.Context, params *SearchFlowExe type SearchFlowExecutionsInput struct { - // The maximum number of results to return in the response. - MaxResults *int32 + // The ID of the system instance that contains the flow. + // + // This member is required. + SystemInstanceId *string - // The date and time of the earliest flow execution to return. - StartTime *time.Time + // The date and time of the latest flow execution to return. + EndTime *time.Time // The ID of a flow execution. FlowExecutionId *string + // The maximum number of results to return in the response. + MaxResults *int32 + // The string that specifies the next page of results. Use this when you're // paginating results. NextToken *string - // The ID of the system instance that contains the flow. - // - // This member is required. - SystemInstanceId *string - - // The date and time of the latest flow execution to return. - EndTime *time.Time + // The date and time of the earliest flow execution to return. + StartTime *time.Time } type SearchFlowExecutionsOutput struct { diff --git a/service/iotthingsgraph/api_op_SearchFlowTemplates.go b/service/iotthingsgraph/api_op_SearchFlowTemplates.go index 6411e8dfff1..daf35b6b726 100644 --- a/service/iotthingsgraph/api_op_SearchFlowTemplates.go +++ b/service/iotthingsgraph/api_op_SearchFlowTemplates.go @@ -57,27 +57,27 @@ func (c *Client) SearchFlowTemplates(ctx context.Context, params *SearchFlowTemp type SearchFlowTemplatesInput struct { - // The string that specifies the next page of results. Use this when you're - // paginating results. - NextToken *string + // An array of objects that limit the result set. The only valid filter is + // DEVICE_MODEL_ID. + Filters []*types.FlowTemplateFilter // The maximum number of results to return in the response. MaxResults *int32 - // An array of objects that limit the result set. The only valid filter is - // DEVICE_MODEL_ID. - Filters []*types.FlowTemplateFilter + // The string that specifies the next page of results. Use this when you're + // paginating results. + NextToken *string } type SearchFlowTemplatesOutput struct { + // The string to specify as nextToken when you request the next page of results. + NextToken *string + // An array of objects that contain summary information about each workflow in the // result set. Summaries []*types.FlowTemplateSummary - // The string to specify as nextToken when you request the next page of results. - NextToken *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotthingsgraph/api_op_SearchSystemInstances.go b/service/iotthingsgraph/api_op_SearchSystemInstances.go index 968c45cf947..d01215c7a14 100644 --- a/service/iotthingsgraph/api_op_SearchSystemInstances.go +++ b/service/iotthingsgraph/api_op_SearchSystemInstances.go @@ -56,17 +56,17 @@ func (c *Client) SearchSystemInstances(ctx context.Context, params *SearchSystem type SearchSystemInstancesInput struct { + // Optional filter to apply to the search. Valid filters are SYSTEM_TEMPLATE_ID, + // STATUS, and GREENGRASS_GROUP_NAME. Multiple filters function as OR criteria in + // the query. Multiple values passed inside the filter function as AND criteria. + Filters []*types.SystemInstanceFilter + // The maximum number of results to return in the response. MaxResults *int32 // The string that specifies the next page of results. Use this when you're // paginating results. NextToken *string - - // Optional filter to apply to the search. Valid filters are SYSTEM_TEMPLATE_ID, - // STATUS, and GREENGRASS_GROUP_NAME. Multiple filters function as OR criteria in - // the query. Multiple values passed inside the filter function as AND criteria. - Filters []*types.SystemInstanceFilter } type SearchSystemInstancesOutput struct { diff --git a/service/iotthingsgraph/api_op_SearchSystemTemplates.go b/service/iotthingsgraph/api_op_SearchSystemTemplates.go index 1cf6581837c..7687b73bac5 100644 --- a/service/iotthingsgraph/api_op_SearchSystemTemplates.go +++ b/service/iotthingsgraph/api_op_SearchSystemTemplates.go @@ -59,16 +59,16 @@ func (c *Client) SearchSystemTemplates(ctx context.Context, params *SearchSystem type SearchSystemTemplatesInput struct { - // The string that specifies the next page of results. Use this when you're - // paginating results. - NextToken *string - // An array of filters that limit the result set. The only valid filter is // FLOW_TEMPLATE_ID. Filters []*types.SystemTemplateFilter // The maximum number of results to return in the response. MaxResults *int32 + + // The string that specifies the next page of results. Use this when you're + // paginating results. + NextToken *string } type SearchSystemTemplatesOutput struct { diff --git a/service/iotthingsgraph/api_op_SearchThings.go b/service/iotthingsgraph/api_op_SearchThings.go index c29f4908716..9ba22d5d63e 100644 --- a/service/iotthingsgraph/api_op_SearchThings.go +++ b/service/iotthingsgraph/api_op_SearchThings.go @@ -71,23 +71,23 @@ type SearchThingsInput struct { // The maximum number of results to return in the response. MaxResults *int32 - // The string that specifies the next page of results. Use this when you're - // paginating results. - NextToken *string - // The version of the user's namespace. Defaults to the latest version of the // user's namespace. NamespaceVersion *int64 + + // The string that specifies the next page of results. Use this when you're + // paginating results. + NextToken *string } type SearchThingsOutput struct { - // An array of things in the result set. - Things []*types.Thing - // The string to specify as nextToken when you request the next page of results. NextToken *string + // An array of things in the result set. + Things []*types.Thing + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/iotthingsgraph/api_op_UntagResource.go b/service/iotthingsgraph/api_op_UntagResource.go index 03e73980152..c2b6107bfaf 100644 --- a/service/iotthingsgraph/api_op_UntagResource.go +++ b/service/iotthingsgraph/api_op_UntagResource.go @@ -56,6 +56,11 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { + // The Amazon Resource Name (ARN) of the resource whose tags are to be removed. + // + // This member is required. + ResourceArn *string + // A list of tag key names to remove from the resource. You don't specify the // value. Both the key and its associated value are removed. This parameter to the // API requires a JSON text string argument. For information on how to format a @@ -66,11 +71,6 @@ type UntagResourceInput struct { // // This member is required. TagKeys []*string - - // The Amazon Resource Name (ARN) of the resource whose tags are to be removed. - // - // This member is required. - ResourceArn *string } type UntagResourceOutput struct { diff --git a/service/iotthingsgraph/api_op_UpdateFlowTemplate.go b/service/iotthingsgraph/api_op_UpdateFlowTemplate.go index b3561dfeecc..0edf69d9f0f 100644 --- a/service/iotthingsgraph/api_op_UpdateFlowTemplate.go +++ b/service/iotthingsgraph/api_op_UpdateFlowTemplate.go @@ -66,16 +66,16 @@ type UpdateFlowTemplateInput struct { // This member is required. Definition *types.DefinitionDocument - // The version of the user's namespace. If no value is specified, the latest - // version is used by default. Use the GetFlowTemplateRevisions if you want to find - // earlier revisions of the flow to update. - CompatibleNamespaceVersion *int64 - // The ID of the workflow to be updated. The ID should be in the following format. // urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME // // This member is required. Id *string + + // The version of the user's namespace. If no value is specified, the latest + // version is used by default. Use the GetFlowTemplateRevisions if you want to find + // earlier revisions of the flow to update. + CompatibleNamespaceVersion *int64 } type UpdateFlowTemplateOutput struct { diff --git a/service/iotthingsgraph/api_op_UpdateSystemTemplate.go b/service/iotthingsgraph/api_op_UpdateSystemTemplate.go index 08031efad85..cb8898fd261 100644 --- a/service/iotthingsgraph/api_op_UpdateSystemTemplate.go +++ b/service/iotthingsgraph/api_op_UpdateSystemTemplate.go @@ -64,16 +64,16 @@ type UpdateSystemTemplateInput struct { // This member is required. Definition *types.DefinitionDocument - // The version of the user's namespace. Defaults to the latest version of the - // user's namespace. If no value is specified, the latest version is used by - // default. - CompatibleNamespaceVersion *int64 - // The ID of the system to be updated. The ID should be in the following format. // urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME // // This member is required. Id *string + + // The version of the user's namespace. Defaults to the latest version of the + // user's namespace. If no value is specified, the latest version is used by + // default. + CompatibleNamespaceVersion *int64 } type UpdateSystemTemplateOutput struct { diff --git a/service/iotthingsgraph/go.mod b/service/iotthingsgraph/go.mod index 227e96b9f92..2d7cb56c3d9 100644 --- a/service/iotthingsgraph/go.mod +++ b/service/iotthingsgraph/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/iotthingsgraph go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/iotthingsgraph/types/types.go b/service/iotthingsgraph/types/types.go index 16cfb3b4e4c..797838c4160 100644 --- a/service/iotthingsgraph/types/types.go +++ b/service/iotthingsgraph/types/types.go @@ -34,20 +34,20 @@ type DependencyRevision struct { // Describes the properties of an entity. type EntityDescription struct { - // The entity ID. - Id *string - // The entity ARN. Arn *string // The time at which the entity was created. CreatedAt *time.Time - // The entity type. - Type EntityType - // The definition document of the entity. Definition *DefinitionDocument + + // The entity ID. + Id *string + + // The entity type. + Type EntityType } // An object that filters an entity search. Multiple filters function as OR @@ -56,14 +56,14 @@ type EntityDescription struct { // that use the entity specified by the value of REFERENCED_ENTITY_ID. type EntityFilter struct { - // An array of string values for the search filter field. Multiple values function - // as AND criteria in the search. - Value []*string - // The name of the entity search filter field. REFERENCED_ENTITY_ID filters on // entities that are used by the entity in the result set. For example, you can // filter on the ID of a property that is used in a state. Name EntityFilterName + + // An array of string values for the search filter field. Multiple values function + // as AND criteria in the search. + Value []*string } // An object that contains information about a flow event. @@ -85,23 +85,23 @@ type FlowExecutionMessage struct { // An object that contains summary information about a flow execution. type FlowExecutionSummary struct { - // The ID of the flow. - FlowTemplateId *string - - // The date and time when the flow execution summary was last updated. - UpdatedAt *time.Time - // The date and time when the flow execution summary was created. CreatedAt *time.Time // The ID of the flow execution. FlowExecutionId *string - // The ID of the system instance that contains the flow. - SystemInstanceId *string + // The ID of the flow. + FlowTemplateId *string // The current status of the flow execution. Status FlowExecutionStatus + + // The ID of the system instance that contains the flow. + SystemInstanceId *string + + // The date and time when the flow execution summary was last updated. + UpdatedAt *time.Time } // An object that contains a workflow's definition and summary information. @@ -110,66 +110,61 @@ type FlowTemplateDescription struct { // A workflow's definition document. Definition *DefinitionDocument + // An object that contains summary information about a workflow. + Summary *FlowTemplateSummary + // The version of the user's namespace against which the workflow was validated. // Use this value in your system instance. ValidatedNamespaceVersion *int64 - - // An object that contains summary information about a workflow. - Summary *FlowTemplateSummary } // An object that filters a workflow search. type FlowTemplateFilter struct { - // An array of string values for the search filter field. Multiple values function - // as AND criteria in the search. + // The name of the search filter field. // // This member is required. - Value []*string + Name FlowTemplateFilterName - // The name of the search filter field. + // An array of string values for the search filter field. Multiple values function + // as AND criteria in the search. // // This member is required. - Name FlowTemplateFilterName + Value []*string } // An object that contains summary information about a workflow. type FlowTemplateSummary struct { + // The ARN of the workflow. + Arn *string + // The date when the workflow was created. CreatedAt *time.Time - // The revision number of the workflow. - RevisionNumber *int64 - // The ID of the workflow. Id *string - // The ARN of the workflow. - Arn *string + // The revision number of the workflow. + RevisionNumber *int64 } // An object that specifies whether cloud metrics are collected in a deployment // and, if so, what role is used to collect metrics. type MetricsConfiguration struct { - // The ARN of the role that is used to collect cloud metrics. - MetricRuleRoleArn *string - // A Boolean that specifies whether cloud metrics are collected. CloudMetricEnabled *bool + + // The ARN of the role that is used to collect cloud metrics. + MetricRuleRoleArn *string } // An object that contains a system instance definition and summary information. type SystemInstanceDescription struct { - // A list of objects that contain all of the IDs and revision numbers of workflows - // and systems that are used in a system instance. - ValidatedDependencyRevisions []*DependencyRevision - - // The Amazon Simple Storage Service bucket where information about a system - // instance is stored. - S3BucketName *string + // A document that defines an entity. + Definition *DefinitionDocument // The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph // assumes during flow execution in a cloud deployment. This role must have read @@ -181,15 +176,20 @@ type SystemInstanceDescription struct { // and, if so, what role is used to collect metrics. MetricsConfiguration *MetricsConfiguration - // The version of the user's namespace against which the system instance was - // validated. - ValidatedNamespaceVersion *int64 + // The Amazon Simple Storage Service bucket where information about a system + // instance is stored. + S3BucketName *string // An object that contains summary information about a system instance. Summary *SystemInstanceSummary - // A document that defines an entity. - Definition *DefinitionDocument + // A list of objects that contain all of the IDs and revision numbers of workflows + // and systems that are used in a system instance. + ValidatedDependencyRevisions []*DependencyRevision + + // The version of the user's namespace against which the system instance was + // validated. + ValidatedNamespaceVersion *int64 } // An object that filters a system instance search. Multiple filters function as OR @@ -198,57 +198,57 @@ type SystemInstanceDescription struct { // specified Greengrass group that have the specified status. type SystemInstanceFilter struct { + // The name of the search filter field. + Name SystemInstanceFilterName + // An array of string values for the search filter field. Multiple values function // as AND criteria in the search. Value []*string - - // The name of the search filter field. - Name SystemInstanceFilterName } // An object that contains summary information about a system instance. type SystemInstanceSummary struct { - // The ID of the Greengrass group where the system instance is deployed. - GreengrassGroupId *string + // The ARN of the system instance. + Arn *string // The date when the system instance was created. CreatedAt *time.Time + // The ID of the Greengrass group where the system instance is deployed. + GreengrassGroupId *string + + // The ID of the Greengrass group where the system instance is deployed. + GreengrassGroupName *string + // The version of the Greengrass group where the system instance is deployed. GreengrassGroupVersionId *string - // The ARN of the system instance. - Arn *string - - // The date and time when the system instance was last updated.

    - UpdatedAt *time.Time + // The ID of the system instance. + Id *string // The status of the system instance. Status SystemInstanceDeploymentStatus - // The ID of the system instance. - Id *string - // The target of the system instance. Target DeploymentTarget - // The ID of the Greengrass group where the system instance is deployed. - GreengrassGroupName *string + // The date and time when the system instance was last updated.

    + UpdatedAt *time.Time } // An object that contains a system's definition document and summary information. type SystemTemplateDescription struct { - // The namespace version against which the system was validated. Use this value in - // your system instance. - ValidatedNamespaceVersion *int64 - // The definition document of a system. Definition *DefinitionDocument // An object that contains summary information about a system. Summary *SystemTemplateSummary + + // The namespace version against which the system was validated. Use this value in + // your system instance. + ValidatedNamespaceVersion *int64 } // An object that filters a system search. @@ -269,42 +269,42 @@ type SystemTemplateFilter struct { // An object that contains information about a system. type SystemTemplateSummary struct { - // The revision number of the system. - RevisionNumber *int64 - - // The ID of the system. - Id *string - // The ARN of the system. Arn *string // The date when the system was created. CreatedAt *time.Time + + // The ID of the system. + Id *string + + // The revision number of the system. + RevisionNumber *int64 } // Metadata assigned to an AWS IoT Things Graph resource consisting of a key-value // pair. type Tag struct { - // The optional value of the tag. The string value can be from 1 to 256 Unicode + // The required name of the tag. The string value can be from 1 to 128 Unicode // characters in length. // // This member is required. - Value *string + Key *string - // The required name of the tag. The string value can be from 1 to 128 Unicode + // The optional value of the tag. The string value can be from 1 to 256 Unicode // characters in length. // // This member is required. - Key *string + Value *string } // An AWS IoT thing. type Thing struct { - // The name of the thing. - ThingName *string - // The ARN of the thing. ThingArn *string + + // The name of the thing. + ThingName *string } diff --git a/service/ivs/api_op_BatchGetChannel.go b/service/ivs/api_op_BatchGetChannel.go index 1d33911b9c3..2b0bdc5d865 100644 --- a/service/ivs/api_op_BatchGetChannel.go +++ b/service/ivs/api_op_BatchGetChannel.go @@ -64,12 +64,11 @@ type BatchGetChannelInput struct { } type BatchGetChannelOutput struct { + Channels []*types.Channel // Each error object is related to a specific ARN in the request. Errors []*types.BatchError - Channels []*types.Channel - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ivs/api_op_BatchGetStreamKey.go b/service/ivs/api_op_BatchGetStreamKey.go index bd4855f9e5e..6e927ea9bb6 100644 --- a/service/ivs/api_op_BatchGetStreamKey.go +++ b/service/ivs/api_op_BatchGetStreamKey.go @@ -64,10 +64,10 @@ type BatchGetStreamKeyInput struct { } type BatchGetStreamKeyOutput struct { - StreamKeys []*types.StreamKey - Errors []*types.BatchError + StreamKeys []*types.StreamKey + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ivs/api_op_CreateChannel.go b/service/ivs/api_op_CreateChannel.go index 308f22ccce8..574ffc589d6 100644 --- a/service/ivs/api_op_CreateChannel.go +++ b/service/ivs/api_op_CreateChannel.go @@ -56,6 +56,9 @@ func (c *Client) CreateChannel(ctx context.Context, params *CreateChannelInput, type CreateChannelInput struct { + // Channel latency mode. Default: LOW. + LatencyMode types.ChannelLatencyMode + // Channel name. Name *string @@ -78,9 +81,6 @@ type CreateChannelInput struct { // // Default: STANDARD. Type types.ChannelType - - // Channel latency mode. Default: LOW. - LatencyMode types.ChannelLatencyMode } type CreateChannelOutput struct { diff --git a/service/ivs/api_op_ListChannels.go b/service/ivs/api_op_ListChannels.go index b8ff9310272..45ad102e35c 100644 --- a/service/ivs/api_op_ListChannels.go +++ b/service/ivs/api_op_ListChannels.go @@ -58,15 +58,15 @@ func (c *Client) ListChannels(ctx context.Context, params *ListChannelsInput, op type ListChannelsInput struct { + // Filters the channel list to match the specified name. + FilterByName *string + // Maximum number of channels to return. MaxResults *int32 // The first channel to retrieve. This is used for pagination; see the nextToken // response field. NextToken *string - - // Filters the channel list to match the specified name. - FilterByName *string } type ListChannelsOutput struct { diff --git a/service/ivs/api_op_ListTagsForResource.go b/service/ivs/api_op_ListTagsForResource.go index 8ada301748b..aa685e1526d 100644 --- a/service/ivs/api_op_ListTagsForResource.go +++ b/service/ivs/api_op_ListTagsForResource.go @@ -56,27 +56,26 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The first tag to retrieve. This is used for pagination; see the nextToken - // response field. - NextToken *string - - // Maximum number of tags to return. - MaxResults *int32 - // The ARN of the resource to be retrieved. // // This member is required. ResourceArn *string + + // Maximum number of tags to return. + MaxResults *int32 + + // The first tag to retrieve. This is used for pagination; see the nextToken + // response field. + NextToken *string } type ListTagsForResourceOutput struct { + Tags map[string]*string // If there are more tags than maxResults, use nextToken in the request to get the // next set. NextToken *string - Tags map[string]*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ivs/api_op_PutMetadata.go b/service/ivs/api_op_PutMetadata.go index 0a396763e8a..bc2db71d503 100644 --- a/service/ivs/api_op_PutMetadata.go +++ b/service/ivs/api_op_PutMetadata.go @@ -57,16 +57,16 @@ func (c *Client) PutMetadata(ctx context.Context, params *PutMetadataInput, optF type PutMetadataInput struct { - // Metadata to insert into the stream. Maximum: 1 KB per request. - // - // This member is required. - Metadata *string - // ARN of the channel into which metadata is inserted. This channel must have an // active stream. // // This member is required. ChannelArn *string + + // Metadata to insert into the stream. Maximum: 1 KB per request. + // + // This member is required. + Metadata *string } type PutMetadataOutput struct { diff --git a/service/ivs/api_op_UpdateChannel.go b/service/ivs/api_op_UpdateChannel.go index 47d68c95d59..c2d7666758e 100644 --- a/service/ivs/api_op_UpdateChannel.go +++ b/service/ivs/api_op_UpdateChannel.go @@ -59,14 +59,14 @@ func (c *Client) UpdateChannel(ctx context.Context, params *UpdateChannelInput, type UpdateChannelInput struct { - // Channel latency mode. Default: LOW. - LatencyMode types.ChannelLatencyMode - // ARN of the channel to be updated. // // This member is required. Arn *string + // Channel latency mode. Default: LOW. + LatencyMode types.ChannelLatencyMode + // Channel name. Name *string diff --git a/service/ivs/go.mod b/service/ivs/go.mod index feffff44a8c..d6193e30fa4 100644 --- a/service/ivs/go.mod +++ b/service/ivs/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/ivs go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/ivs/types/types.go b/service/ivs/types/types.go index 897de958be1..dc84ee5fb7a 100644 --- a/service/ivs/types/types.go +++ b/service/ivs/types/types.go @@ -9,12 +9,12 @@ import ( // Error related to a specific channel, specified by its ARN. type BatchError struct { - // Error code. - Code *string - // Channel ARN. Arn *string + // Error code. + Code *string + // Error message, determined by the application. Message *string } @@ -22,9 +22,25 @@ type BatchError struct { // Object specifying a channel. type Channel struct { + // Channel ARN. + Arn *string + + // Channel ingest endpoint, part of the definition of an ingest server, used when + // you set up streaming software. + IngestEndpoint *string + + // Channel latency mode. Default: LOW. + LatencyMode ChannelLatencyMode + + // Channel name. + Name *string + // Channel playback URL. PlaybackUrl *string + // Array of 1-50 maps, each of the form string:string (key:value). + Tags map[string]*string + // Channel type, which determines the allowable resolution and bitrate. If you // exceed the allowable resolution or bitrate, the stream probably will disconnect // immediately. Valid values: @@ -41,22 +57,6 @@ type Channel struct { // // Default: STANDARD. Type ChannelType - - // Channel ingest endpoint, part of the definition of an ingest server, used when - // you set up streaming software. - IngestEndpoint *string - - // Channel ARN. - Arn *string - - // Array of 1-50 maps, each of the form string:string (key:value). - Tags map[string]*string - - // Channel name. - Name *string - - // Channel latency mode. Default: LOW. - LatencyMode ChannelLatencyMode } // Summary information about a channel. @@ -68,80 +68,80 @@ type ChannelSummary struct { // Channel latency mode. Default: LOW. LatencyMode ChannelLatencyMode - // Array of 1-50 maps, each of the form string:string (key:value). - Tags map[string]*string - // Channel name. Name *string + + // Array of 1-50 maps, each of the form string:string (key:value). + Tags map[string]*string } // Specifies a live video stream that has been ingested and distributed. type Stream struct { - // ISO-8601 formatted timestamp of the stream’s start. - StartTime *time.Time + // Channel ARN for the stream. + ChannelArn *string + + // The stream’s health. + Health StreamHealth // URL of the video master manifest, required by the video player to play the HLS // stream. PlaybackUrl *string + // ISO-8601 formatted timestamp of the stream’s start. + StartTime *time.Time + // The stream’s state. State StreamState // Number of current viewers of the stream. ViewerCount *int64 - - // Channel ARN for the stream. - ChannelArn *string - - // The stream’s health. - Health StreamHealth } // Object specifying a stream key. type StreamKey struct { - // Channel ARN for the stream. - ChannelArn *string - // Stream-key ARN. Arn *string - // Stream-key value. - Value *string + // Channel ARN for the stream. + ChannelArn *string // Array of 1-50 maps, each of the form string:string (key:value) Tags map[string]*string + + // Stream-key value. + Value *string } // Summary information about a stream key. type StreamKeySummary struct { + // Stream-key ARN. + Arn *string + // Channel ARN for the stream. ChannelArn *string // Array of 1-50 maps, each of the form string:string (key:value) Tags map[string]*string - - // Stream-key ARN. - Arn *string } // Summary information about a stream. type StreamSummary struct { - // The stream’s state. - State StreamState + // Channel ARN for the stream. + ChannelArn *string // The stream’s health. Health StreamHealth - // Channel ARN for the stream. - ChannelArn *string + // ISO-8601 formatted timestamp of the stream’s start. + StartTime *time.Time + + // The stream’s state. + State StreamState // Number of current viewers of the stream. ViewerCount *int64 - - // ISO-8601 formatted timestamp of the stream’s start. - StartTime *time.Time } diff --git a/service/kafka/api_op_CreateCluster.go b/service/kafka/api_op_CreateCluster.go index a551c197a7e..e7082536782 100644 --- a/service/kafka/api_op_CreateCluster.go +++ b/service/kafka/api_op_CreateCluster.go @@ -57,60 +57,60 @@ func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, type CreateClusterInput struct { - // Includes all client authentication related information. - ClientAuthentication *types.ClientAuthentication - - // The version of Apache Kafka. + // Information about the broker nodes in the cluster. // // This member is required. - KafkaVersion *string + BrokerNodeGroupInfo *types.BrokerNodeGroupInfo // The name of the cluster. // // This member is required. ClusterName *string - // Specifies the level of monitoring for the MSK cluster. The possible values are - // DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. - EnhancedMonitoring types.EnhancedMonitoring - - // Create tags when creating the cluster. - Tags map[string]*string - - // Represents the configuration that you want MSK to use for the brokers in a - // cluster. - ConfigurationInfo *types.ConfigurationInfo + // The version of Apache Kafka. + // + // This member is required. + KafkaVersion *string // The number of broker nodes in the cluster. // // This member is required. NumberOfBrokerNodes *int32 - LoggingInfo *types.LoggingInfo + // Includes all client authentication related information. + ClientAuthentication *types.ClientAuthentication - // Information about the broker nodes in the cluster. - // - // This member is required. - BrokerNodeGroupInfo *types.BrokerNodeGroupInfo + // Represents the configuration that you want MSK to use for the brokers in a + // cluster. + ConfigurationInfo *types.ConfigurationInfo // Includes all encryption-related information. EncryptionInfo *types.EncryptionInfo + // Specifies the level of monitoring for the MSK cluster. The possible values are + // DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. + EnhancedMonitoring types.EnhancedMonitoring + + LoggingInfo *types.LoggingInfo + // The settings for open monitoring. OpenMonitoring *types.OpenMonitoringInfo + + // Create tags when creating the cluster. + Tags map[string]*string } type CreateClusterOutput struct { + // The Amazon Resource Name (ARN) of the cluster. + ClusterArn *string + // The name of the MSK cluster. ClusterName *string // The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED. State types.ClusterState - // The Amazon Resource Name (ARN) of the cluster. - ClusterArn *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kafka/api_op_CreateConfiguration.go b/service/kafka/api_op_CreateConfiguration.go index a4d1c605b37..6dd46e51fd7 100644 --- a/service/kafka/api_op_CreateConfiguration.go +++ b/service/kafka/api_op_CreateConfiguration.go @@ -58,6 +58,11 @@ func (c *Client) CreateConfiguration(ctx context.Context, params *CreateConfigur type CreateConfigurationInput struct { + // The name of the configuration. + // + // This member is required. + Name *string + // Contents of the server.properties file. When using the API, you must ensure that // the contents of the file are base64 encoded. When using the AWS Management // Console, the SDK, or the AWS CLI, the contents of server.properties can be in @@ -66,23 +71,15 @@ type CreateConfigurationInput struct { // This member is required. ServerProperties []byte - // The versions of Apache Kafka with which you can use this MSK configuration. - KafkaVersions []*string - // The description of the configuration. Description *string - // The name of the configuration. - // - // This member is required. - Name *string + // The versions of Apache Kafka with which you can use this MSK configuration. + KafkaVersions []*string } type CreateConfigurationOutput struct { - // The name of the configuration. - Name *string - // The Amazon Resource Name (ARN) of the configuration. Arn *string @@ -92,6 +89,9 @@ type CreateConfigurationOutput struct { // Latest revision of the configuration. LatestRevision *types.ConfigurationRevision + // The name of the configuration. + Name *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kafka/api_op_DeleteCluster.go b/service/kafka/api_op_DeleteCluster.go index a97d64ef1bb..66ec9854d87 100644 --- a/service/kafka/api_op_DeleteCluster.go +++ b/service/kafka/api_op_DeleteCluster.go @@ -69,12 +69,12 @@ type DeleteClusterInput struct { type DeleteClusterOutput struct { - // The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED. - State types.ClusterState - // The Amazon Resource Name (ARN) of the cluster. ClusterArn *string + // The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED. + State types.ClusterState + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kafka/api_op_DescribeConfiguration.go b/service/kafka/api_op_DescribeConfiguration.go index 3a8640e55b4..c0cdbadd79f 100644 --- a/service/kafka/api_op_DescribeConfiguration.go +++ b/service/kafka/api_op_DescribeConfiguration.go @@ -67,24 +67,24 @@ type DescribeConfigurationInput struct { type DescribeConfigurationOutput struct { - // The versions of Apache Kafka with which you can use this MSK configuration. - KafkaVersions []*string + // The Amazon Resource Name (ARN) of the configuration. + Arn *string - // Latest revision of the configuration. - LatestRevision *types.ConfigurationRevision + // The time when the configuration was created. + CreationTime *time.Time // The description of the configuration. Description *string - // The Amazon Resource Name (ARN) of the configuration. - Arn *string + // The versions of Apache Kafka with which you can use this MSK configuration. + KafkaVersions []*string + + // Latest revision of the configuration. + LatestRevision *types.ConfigurationRevision // The name of the configuration. Name *string - // The time when the configuration was created. - CreationTime *time.Time - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kafka/api_op_GetBootstrapBrokers.go b/service/kafka/api_op_GetBootstrapBrokers.go index 3166ea81438..efb95ab049e 100644 --- a/service/kafka/api_op_GetBootstrapBrokers.go +++ b/service/kafka/api_op_GetBootstrapBrokers.go @@ -64,12 +64,12 @@ type GetBootstrapBrokersInput struct { type GetBootstrapBrokersOutput struct { - // A string containing one or more DNS names (or IP) and TLS port pairs. - BootstrapBrokerStringTls *string - // A string containing one or more hostname:port pairs. BootstrapBrokerString *string + // A string containing one or more DNS names (or IP) and TLS port pairs. + BootstrapBrokerStringTls *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kafka/api_op_ListClusterOperations.go b/service/kafka/api_op_ListClusterOperations.go index c6233721bee..64af41c8d26 100644 --- a/service/kafka/api_op_ListClusterOperations.go +++ b/service/kafka/api_op_ListClusterOperations.go @@ -58,19 +58,19 @@ func (c *Client) ListClusterOperations(ctx context.Context, params *ListClusterO type ListClusterOperationsInput struct { - // The paginated results marker. When the result of the operation is truncated, the - // call returns NextToken in the response. To get the next batch, provide this - // token in your next request. - NextToken *string + // The Amazon Resource Name (ARN) that uniquely identifies the cluster. + // + // This member is required. + ClusterArn *string // The maximum number of results to return in the response. If there are more // results, the response includes a NextToken parameter. MaxResults *int32 - // The Amazon Resource Name (ARN) that uniquely identifies the cluster. - // - // This member is required. - ClusterArn *string + // The paginated results marker. When the result of the operation is truncated, the + // call returns NextToken in the response. To get the next batch, provide this + // token in your next request. + NextToken *string } type ListClusterOperationsOutput struct { diff --git a/service/kafka/api_op_ListClusters.go b/service/kafka/api_op_ListClusters.go index 39f2af0c151..ec98e3ea514 100644 --- a/service/kafka/api_op_ListClusters.go +++ b/service/kafka/api_op_ListClusters.go @@ -56,11 +56,6 @@ func (c *Client) ListClusters(ctx context.Context, params *ListClustersInput, op type ListClustersInput struct { - // The paginated results marker. When the result of the operation is truncated, the - // call returns NextToken in the response. To get the next batch, provide this - // token in your next request. - NextToken *string - // Specify a prefix of the name of the clusters that you want to list. The service // lists all the clusters whose names start with this prefix. ClusterNameFilter *string @@ -68,6 +63,11 @@ type ListClustersInput struct { // The maximum number of results to return in the response. If there are more // results, the response includes a NextToken parameter. MaxResults *int32 + + // The paginated results marker. When the result of the operation is truncated, the + // call returns NextToken in the response. To get the next batch, provide this + // token in your next request. + NextToken *string } type ListClustersOutput struct { diff --git a/service/kafka/api_op_ListConfigurationRevisions.go b/service/kafka/api_op_ListConfigurationRevisions.go index ad2f2bfdb55..27b230d1714 100644 --- a/service/kafka/api_op_ListConfigurationRevisions.go +++ b/service/kafka/api_op_ListConfigurationRevisions.go @@ -57,20 +57,20 @@ func (c *Client) ListConfigurationRevisions(ctx context.Context, params *ListCon type ListConfigurationRevisionsInput struct { - // The paginated results marker. When the result of the operation is truncated, the - // call returns NextToken in the response. To get the next batch, provide this - // token in your next request. - NextToken *string - - // The maximum number of results to return in the response. If there are more - // results, the response includes a NextToken parameter. - MaxResults *int32 - // The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and // all of its revisions. // // This member is required. Arn *string + + // The maximum number of results to return in the response. If there are more + // results, the response includes a NextToken parameter. + MaxResults *int32 + + // The paginated results marker. When the result of the operation is truncated, the + // call returns NextToken in the response. To get the next batch, provide this + // token in your next request. + NextToken *string } type ListConfigurationRevisionsOutput struct { diff --git a/service/kafka/api_op_ListConfigurations.go b/service/kafka/api_op_ListConfigurations.go index e26cd565fa1..bd69073dc32 100644 --- a/service/kafka/api_op_ListConfigurations.go +++ b/service/kafka/api_op_ListConfigurations.go @@ -56,26 +56,26 @@ func (c *Client) ListConfigurations(ctx context.Context, params *ListConfigurati type ListConfigurationsInput struct { + // The maximum number of results to return in the response. If there are more + // results, the response includes a NextToken parameter. + MaxResults *int32 + // The paginated results marker. When the result of the operation is truncated, the // call returns NextToken in the response. To get the next batch, provide this // token in your next request. NextToken *string - - // The maximum number of results to return in the response. If there are more - // results, the response includes a NextToken parameter. - MaxResults *int32 } type ListConfigurationsOutput struct { + // An array of MSK configurations. + Configurations []*types.Configuration + // The paginated results marker. When the result of a ListConfigurations operation // is truncated, the call returns NextToken in the response. To get another batch // of configurations, provide this token in your next request. NextToken *string - // An array of MSK configurations. - Configurations []*types.Configuration - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kafka/api_op_ListKafkaVersions.go b/service/kafka/api_op_ListKafkaVersions.go index aa9334d9243..0c22824cb6f 100644 --- a/service/kafka/api_op_ListKafkaVersions.go +++ b/service/kafka/api_op_ListKafkaVersions.go @@ -67,10 +67,10 @@ type ListKafkaVersionsInput struct { } type ListKafkaVersionsOutput struct { - NextToken *string - KafkaVersions []*types.KafkaVersion + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kafka/api_op_ListNodes.go b/service/kafka/api_op_ListNodes.go index bdb7ba0cc8c..3483a19a3ba 100644 --- a/service/kafka/api_op_ListNodes.go +++ b/service/kafka/api_op_ListNodes.go @@ -57,11 +57,6 @@ func (c *Client) ListNodes(ctx context.Context, params *ListNodesInput, optFns . type ListNodesInput struct { - // The paginated results marker. When the result of the operation is truncated, the - // call returns NextToken in the response. To get the next batch, provide this - // token in your next request. - NextToken *string - // The Amazon Resource Name (ARN) that uniquely identifies the cluster. // // This member is required. @@ -70,18 +65,23 @@ type ListNodesInput struct { // The maximum number of results to return in the response. If there are more // results, the response includes a NextToken parameter. MaxResults *int32 + + // The paginated results marker. When the result of the operation is truncated, the + // call returns NextToken in the response. To get the next batch, provide this + // token in your next request. + NextToken *string } type ListNodesOutput struct { - // List containing a NodeInfo object. - NodeInfoList []*types.NodeInfo - // The paginated results marker. When the result of a ListNodes operation is // truncated, the call returns NextToken in the response. To get another batch of // nodes, provide this token in your next request. NextToken *string + // List containing a NodeInfo object. + NodeInfoList []*types.NodeInfo + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kafka/api_op_UntagResource.go b/service/kafka/api_op_UntagResource.go index 450e3611a0c..0885411b55d 100644 --- a/service/kafka/api_op_UntagResource.go +++ b/service/kafka/api_op_UntagResource.go @@ -56,6 +56,12 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { + // The Amazon Resource Name (ARN) that uniquely identifies the resource that's + // associated with the tags. + // + // This member is required. + ResourceArn *string + // Tag keys must be unique for a given cluster. In addition, the following // restrictions apply: // @@ -76,12 +82,6 @@ type UntagResourceInput struct { // // This member is required. TagKeys []*string - - // The Amazon Resource Name (ARN) that uniquely identifies the resource that's - // associated with the tags. - // - // This member is required. - ResourceArn *string } type UntagResourceOutput struct { diff --git a/service/kafka/api_op_UpdateBrokerCount.go b/service/kafka/api_op_UpdateBrokerCount.go index 80527b38cb3..37eff7535a8 100644 --- a/service/kafka/api_op_UpdateBrokerCount.go +++ b/service/kafka/api_op_UpdateBrokerCount.go @@ -56,6 +56,11 @@ func (c *Client) UpdateBrokerCount(ctx context.Context, params *UpdateBrokerCoun type UpdateBrokerCountInput struct { + // The Amazon Resource Name (ARN) that uniquely identifies the cluster. + // + // This member is required. + ClusterArn *string + // The version of cluster to update from. A successful operation will then generate // a new version. // @@ -67,11 +72,6 @@ type UpdateBrokerCountInput struct { // // This member is required. TargetNumberOfBrokerNodes *int32 - - // The Amazon Resource Name (ARN) that uniquely identifies the cluster. - // - // This member is required. - ClusterArn *string } type UpdateBrokerCountOutput struct { diff --git a/service/kafka/api_op_UpdateBrokerStorage.go b/service/kafka/api_op_UpdateBrokerStorage.go index f3df361fb92..e18fe02d8e0 100644 --- a/service/kafka/api_op_UpdateBrokerStorage.go +++ b/service/kafka/api_op_UpdateBrokerStorage.go @@ -57,12 +57,6 @@ func (c *Client) UpdateBrokerStorage(ctx context.Context, params *UpdateBrokerSt type UpdateBrokerStorageInput struct { - // Describes the target volume size and the ID of the broker to apply the update - // to. - // - // This member is required. - TargetBrokerEBSVolumeInfo []*types.BrokerEBSVolumeInfo - // The Amazon Resource Name (ARN) that uniquely identifies the cluster. // // This member is required. @@ -73,16 +67,22 @@ type UpdateBrokerStorageInput struct { // // This member is required. CurrentVersion *string + + // Describes the target volume size and the ID of the broker to apply the update + // to. + // + // This member is required. + TargetBrokerEBSVolumeInfo []*types.BrokerEBSVolumeInfo } type UpdateBrokerStorageOutput struct { - // The Amazon Resource Name (ARN) of the cluster operation. - ClusterOperationArn *string - // The Amazon Resource Name (ARN) of the cluster. ClusterArn *string + // The Amazon Resource Name (ARN) of the cluster operation. + ClusterOperationArn *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kafka/api_op_UpdateClusterConfiguration.go b/service/kafka/api_op_UpdateClusterConfiguration.go index ca8da01048b..f40d3a5121b 100644 --- a/service/kafka/api_op_UpdateClusterConfiguration.go +++ b/service/kafka/api_op_UpdateClusterConfiguration.go @@ -63,26 +63,26 @@ type UpdateClusterConfigurationInput struct { // This member is required. ClusterArn *string - // The version of the cluster that needs to be updated. - // - // This member is required. - CurrentVersion *string - // Represents the configuration that you want MSK to use for the brokers in a // cluster. // // This member is required. ConfigurationInfo *types.ConfigurationInfo + + // The version of the cluster that needs to be updated. + // + // This member is required. + CurrentVersion *string } type UpdateClusterConfigurationOutput struct { - // The Amazon Resource Name (ARN) of the cluster operation. - ClusterOperationArn *string - // The Amazon Resource Name (ARN) of the cluster. ClusterArn *string + // The Amazon Resource Name (ARN) of the cluster operation. + ClusterOperationArn *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kafka/api_op_UpdateClusterKafkaVersion.go b/service/kafka/api_op_UpdateClusterKafkaVersion.go index af0d6f68277..db8609db871 100644 --- a/service/kafka/api_op_UpdateClusterKafkaVersion.go +++ b/service/kafka/api_op_UpdateClusterKafkaVersion.go @@ -78,12 +78,12 @@ type UpdateClusterKafkaVersionInput struct { type UpdateClusterKafkaVersionOutput struct { - // The Amazon Resource Name (ARN) of the cluster operation. - ClusterOperationArn *string - // The Amazon Resource Name (ARN) of the cluster. ClusterArn *string + // The Amazon Resource Name (ARN) of the cluster operation. + ClusterOperationArn *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kafka/api_op_UpdateMonitoring.go b/service/kafka/api_op_UpdateMonitoring.go index 1746793d5b5..38cc3fb6e85 100644 --- a/service/kafka/api_op_UpdateMonitoring.go +++ b/service/kafka/api_op_UpdateMonitoring.go @@ -60,36 +60,36 @@ func (c *Client) UpdateMonitoring(ctx context.Context, params *UpdateMonitoringI // Request body for UpdateMonitoring. type UpdateMonitoringInput struct { - // Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon - // CloudWatch for this cluster. - EnhancedMonitoring types.EnhancedMonitoring - - LoggingInfo *types.LoggingInfo - // The Amazon Resource Name (ARN) that uniquely identifies the cluster. // // This member is required. ClusterArn *string - // The settings for open monitoring. - OpenMonitoring *types.OpenMonitoringInfo - // The version of the MSK cluster to update. Cluster versions aren't simple // numbers. You can describe an MSK cluster to find its version. When this update // operation is successful, it generates a new cluster version. // // This member is required. CurrentVersion *string + + // Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon + // CloudWatch for this cluster. + EnhancedMonitoring types.EnhancedMonitoring + + LoggingInfo *types.LoggingInfo + + // The settings for open monitoring. + OpenMonitoring *types.OpenMonitoringInfo } type UpdateMonitoringOutput struct { - // The Amazon Resource Name (ARN) of the cluster operation. - ClusterOperationArn *string - // The Amazon Resource Name (ARN) of the cluster. ClusterArn *string + // The Amazon Resource Name (ARN) of the cluster operation. + ClusterOperationArn *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kafka/go.mod b/service/kafka/go.mod index 971bbe6b1ad..65570ccbc1b 100644 --- a/service/kafka/go.mod +++ b/service/kafka/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/kafka go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/kafka/types/types.go b/service/kafka/types/types.go index fdddaff3e70..8c8196f7df1 100644 --- a/service/kafka/types/types.go +++ b/service/kafka/types/types.go @@ -23,10 +23,10 @@ type BrokerEBSVolumeInfo struct { } type BrokerLogs struct { - Firehose *Firehose - CloudWatchLogs *CloudWatchLogs + Firehose *Firehose + S3 *S3 } @@ -48,9 +48,6 @@ type BrokerNodeGroupInfo struct { // This member is required. InstanceType *string - // Contains information about storage volumes attached to MSK broker nodes. - StorageInfo *StorageInfo - // The distribution of broker nodes across Availability Zones. This is an optional // parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You // can also explicitly set this parameter to the value DEFAULT. No other values are @@ -64,44 +61,47 @@ type BrokerNodeGroupInfo struct { // If you don't specify a security group, Amazon MSK uses the default security // group associated with the VPC. SecurityGroups []*string + + // Contains information about storage volumes attached to MSK broker nodes. + StorageInfo *StorageInfo } // BrokerNodeInfo type BrokerNodeInfo struct { - // Information about the version of software currently deployed on the Kafka - // brokers in the cluster. - CurrentBrokerSoftwareInfo *BrokerSoftwareInfo - // The attached elastic network interface of the broker. AttachedENIId *string - // Endpoints for accessing the broker. - Endpoints []*string - - // The virtual private cloud (VPC) of the client. - ClientVpcIpAddress *string - // The ID of the broker. BrokerId *float64 // The client subnet to which this broker node belongs. ClientSubnet *string + + // The virtual private cloud (VPC) of the client. + ClientVpcIpAddress *string + + // Information about the version of software currently deployed on the Kafka + // brokers in the cluster. + CurrentBrokerSoftwareInfo *BrokerSoftwareInfo + + // Endpoints for accessing the broker. + Endpoints []*string } // Information about the current software installed on the cluster. type BrokerSoftwareInfo struct { - // The version of Apache Kafka. - KafkaVersion *string + // The Amazon Resource Name (ARN) of the configuration used for the cluster. This + // field isn't visible in this preview release. + ConfigurationArn *string // The revision of the configuration to use. This field isn't visible in this // preview release. ConfigurationRevision *int64 - // The Amazon Resource Name (ARN) of the configuration used for the cluster. This - // field isn't visible in this preview release. - ConfigurationArn *string + // The version of Apache Kafka. + KafkaVersion *string } // Includes all client authentication information. @@ -119,29 +119,34 @@ type CloudWatchLogs struct { // Returns information about a cluster. type ClusterInfo struct { - LoggingInfo *LoggingInfo - // Includes all encryption-related information. - EncryptionInfo *EncryptionInfo + // Arn of active cluster operation. + ActiveOperationArn *string - // The number of broker nodes in the cluster. - NumberOfBrokerNodes *int32 + // Information about the broker nodes. + BrokerNodeGroupInfo *BrokerNodeGroupInfo - // Information about the version of software currently deployed on the Kafka - // brokers in the cluster. - CurrentBrokerSoftwareInfo *BrokerSoftwareInfo + // Includes all client authentication information. + ClientAuthentication *ClientAuthentication // The Amazon Resource Name (ARN) that uniquely identifies the cluster. ClusterArn *string - // The connection string to use to connect to the Apache ZooKeeper cluster. - ZookeeperConnectString *string + // The name of the cluster. + ClusterName *string - // Settings for open monitoring using Prometheus. - OpenMonitoring *OpenMonitoring + // The time when the cluster was created. + CreationTime *time.Time - // Arn of active cluster operation. - ActiveOperationArn *string + // Information about the version of software currently deployed on the Kafka + // brokers in the cluster. + CurrentBrokerSoftwareInfo *BrokerSoftwareInfo + + // The current version of the MSK cluster. + CurrentVersion *string + + // Includes all encryption-related information. + EncryptionInfo *EncryptionInfo // Specifies which metrics are gathered for the MSK cluster. This property has // three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. For a list @@ -150,63 +155,59 @@ type ClusterInfo struct { // (https://docs.aws.amazon.com/msk/latest/developerguide/monitoring.html). EnhancedMonitoring EnhancedMonitoring - // Information about the broker nodes. - BrokerNodeGroupInfo *BrokerNodeGroupInfo + LoggingInfo *LoggingInfo + + // The number of broker nodes in the cluster. + NumberOfBrokerNodes *int32 + + // Settings for open monitoring using Prometheus. + OpenMonitoring *OpenMonitoring // The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED. State ClusterState - // The current version of the MSK cluster. - CurrentVersion *string - StateInfo *StateInfo - // Includes all client authentication information. - ClientAuthentication *ClientAuthentication - // Tags attached to the cluster. Tags map[string]*string - // The name of the cluster. - ClusterName *string - - // The time when the cluster was created. - CreationTime *time.Time + // The connection string to use to connect to the Apache ZooKeeper cluster. + ZookeeperConnectString *string } // Returns information about a cluster operation. type ClusterOperationInfo struct { - // ARN of the cluster operation. - OperationArn *string - // The ID of the API request that triggered this operation. ClientRequestId *string - // Information about cluster attributes before a cluster is updated. - SourceClusterInfo *MutableClusterInfo + // ARN of the cluster. + ClusterArn *string + + // The time that the operation was created. + CreationTime *time.Time + + // The time at which the operation finished. + EndTime *time.Time // Describes the error if the operation fails. ErrorInfo *ErrorInfo - // Type of the cluster operation. - OperationType *string + // ARN of the cluster operation. + OperationArn *string // State of the cluster operation. OperationState *string - // The time that the operation was created. - CreationTime *time.Time - - // ARN of the cluster. - ClusterArn *string - - // The time at which the operation finished. - EndTime *time.Time - // Steps completed during the operation. OperationSteps []*ClusterOperationStep + // Type of the cluster operation. + OperationType *string + + // Information about cluster attributes before a cluster is updated. + SourceClusterInfo *MutableClusterInfo + // Information about cluster attributes after a cluster is updated. TargetClusterInfo *MutableClusterInfo } @@ -214,11 +215,11 @@ type ClusterOperationInfo struct { // Step taken during a cluster operation. type ClusterOperationStep struct { - // The name of the step. - StepName *string - // Information about the step and its status. StepInfo *ClusterOperationStepInfo + + // The name of the step. + StepName *string } // State information about the operation step. @@ -241,20 +242,20 @@ type CompatibleKafkaVersion struct { // Represents an MSK Configuration. type Configuration struct { - // Latest revision of the configuration. + // The Amazon Resource Name (ARN) of the configuration. // // This member is required. - LatestRevision *ConfigurationRevision + Arn *string - // The description of the configuration. + // The time when the configuration was created. // // This member is required. - Description *string + CreationTime *time.Time - // The name of the configuration. + // The description of the configuration. // // This member is required. - Name *string + Description *string // An array of the versions of Apache Kafka with which you can use this MSK // configuration. You can use this configuration for an MSK cluster only if the @@ -263,29 +264,29 @@ type Configuration struct { // This member is required. KafkaVersions []*string - // The Amazon Resource Name (ARN) of the configuration. + // Latest revision of the configuration. // // This member is required. - Arn *string + LatestRevision *ConfigurationRevision - // The time when the configuration was created. + // The name of the configuration. // // This member is required. - CreationTime *time.Time + Name *string } // Specifies the configuration to use for the brokers. type ConfigurationInfo struct { - // The revision of the configuration to use. + // ARN of the configuration to use. // // This member is required. - Revision *int64 + Arn *string - // ARN of the configuration to use. + // The revision of the configuration to use. // // This member is required. - Arn *string + Revision *int64 } // Describes a configuration revision. @@ -296,13 +297,13 @@ type ConfigurationRevision struct { // This member is required. CreationTime *time.Time - // The description of the configuration revision. - Description *string - // The revision number. // // This member is required. Revision *int64 + + // The description of the configuration revision. + Description *string } // Contains information about the EBS storage volumes attached to Kafka broker @@ -328,11 +329,11 @@ type EncryptionAtRest struct { // transit. type EncryptionInfo struct { - // The details for encryption in transit. - EncryptionInTransit *EncryptionInTransit - // The data-volume encryption details. EncryptionAtRest *EncryptionAtRest + + // The details for encryption in transit. + EncryptionInTransit *EncryptionInTransit } // The settings for encrypting data in transit. @@ -398,26 +399,27 @@ type LoggingInfo struct { // Information about cluster attributes that can be updated via update APIs. type MutableClusterInfo struct { - LoggingInfo *LoggingInfo + + // Specifies the size of the EBS volume and the ID of the associated broker. + BrokerEBSVolumeInfo []*BrokerEBSVolumeInfo + + // Information about the changes in the configuration of the brokers. + ConfigurationInfo *ConfigurationInfo // Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon // CloudWatch for this cluster. EnhancedMonitoring EnhancedMonitoring - // The settings for open monitoring. - OpenMonitoring *OpenMonitoring - // The Kafka version. KafkaVersion *string + LoggingInfo *LoggingInfo + // The number of broker nodes in the cluster. NumberOfBrokerNodes *int32 - // Specifies the size of the EBS volume and the ID of the associated broker. - BrokerEBSVolumeInfo []*BrokerEBSVolumeInfo - - // Information about the changes in the configuration of the brokers. - ConfigurationInfo *ConfigurationInfo + // The settings for open monitoring. + OpenMonitoring *OpenMonitoring } // Indicates whether you want to enable or disable the Node Exporter. @@ -441,20 +443,20 @@ type NodeExporterInfo struct { // The node information object. type NodeInfo struct { - // The node type. - NodeType NodeType - // The start time. AddedToClusterTime *string + // The broker node info. + BrokerNodeInfo *BrokerNodeInfo + // The instance type. InstanceType *string // The Amazon Resource Name (ARN) of the node. NodeARN *string - // The broker node info. - BrokerNodeInfo *BrokerNodeInfo + // The node type. + NodeType NodeType // The ZookeeperNodeInfo. ZookeeperNodeInfo *ZookeeperNodeInfo @@ -481,29 +483,29 @@ type OpenMonitoringInfo struct { // Prometheus settings. type Prometheus struct { - // Indicates whether you want to enable or disable the Node Exporter. - NodeExporter *NodeExporter - // Indicates whether you want to enable or disable the JMX Exporter. JmxExporter *JmxExporter + + // Indicates whether you want to enable or disable the Node Exporter. + NodeExporter *NodeExporter } // Prometheus settings. type PrometheusInfo struct { - // Indicates whether you want to enable or disable the Node Exporter. - NodeExporter *NodeExporterInfo - // Indicates whether you want to enable or disable the JMX Exporter. JmxExporter *JmxExporterInfo + + // Indicates whether you want to enable or disable the Node Exporter. + NodeExporter *NodeExporterInfo } type S3 struct { - Prefix *string - Enabled *bool Bucket *string + + Prefix *string } type StateInfo struct { @@ -529,18 +531,18 @@ type Tls struct { // Zookeeper node information. type ZookeeperNodeInfo struct { - // The role-specific ID for Zookeeper. - ZookeeperId *float64 + // The attached elastic network interface of the broker. + AttachedENIId *string // The virtual private cloud (VPC) IP address of the client. ClientVpcIpAddress *string - // The version of Zookeeper. - ZookeeperVersion *string - - // The attached elastic network interface of the broker. - AttachedENIId *string - // Endpoints for accessing the ZooKeeper. Endpoints []*string + + // The role-specific ID for Zookeeper. + ZookeeperId *float64 + + // The version of Zookeeper. + ZookeeperVersion *string } diff --git a/service/kendra/api_op_BatchDeleteDocument.go b/service/kendra/api_op_BatchDeleteDocument.go index 1706b4d3218..046e7c96568 100644 --- a/service/kendra/api_op_BatchDeleteDocument.go +++ b/service/kendra/api_op_BatchDeleteDocument.go @@ -61,6 +61,11 @@ func (c *Client) BatchDeleteDocument(ctx context.Context, params *BatchDeleteDoc type BatchDeleteDocumentInput struct { + // One or more identifiers for documents to delete from the index. + // + // This member is required. + DocumentIdList []*string + // The identifier of the index that contains the documents to delete. // // This member is required. @@ -68,11 +73,6 @@ type BatchDeleteDocumentInput struct { // Maps a particular data source sync job to a particular data source. DataSourceSyncJobMetricTarget *types.DataSourceSyncJobMetricTarget - - // One or more identifiers for documents to delete from the index. - // - // This member is required. - DocumentIdList []*string } type BatchDeleteDocumentOutput struct { diff --git a/service/kendra/api_op_BatchPutDocument.go b/service/kendra/api_op_BatchPutDocument.go index 8b0db31de8d..7f541c6c3c1 100644 --- a/service/kendra/api_op_BatchPutDocument.go +++ b/service/kendra/api_op_BatchPutDocument.go @@ -81,16 +81,16 @@ type BatchPutDocumentInput struct { // This member is required. Documents []*types.Document - // The Amazon Resource Name (ARN) of a role that is allowed to run the - // BatchPutDocument operation. For more information, see IAM Roles for Amazon - // Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). - RoleArn *string - // The identifier of the index to add the documents to. You need to create the // index first using the CreateIndex () operation. // // This member is required. IndexId *string + + // The Amazon Resource Name (ARN) of a role that is allowed to run the + // BatchPutDocument operation. For more information, see IAM Roles for Amazon + // Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). + RoleArn *string } type BatchPutDocumentOutput struct { diff --git a/service/kendra/api_op_CreateDataSource.go b/service/kendra/api_op_CreateDataSource.go index 887a4855efe..18c0ac7b42b 100644 --- a/service/kendra/api_op_CreateDataSource.go +++ b/service/kendra/api_op_CreateDataSource.go @@ -63,17 +63,22 @@ func (c *Client) CreateDataSource(ctx context.Context, params *CreateDataSourceI type CreateDataSourceInput struct { - // A description for the data source. - Description *string + // The connector configuration information that is required to access the + // repository. + // + // This member is required. + Configuration *types.DataSourceConfiguration - // The type of repository that contains the data source. + // The identifier of the index that should be associated with this data source. // // This member is required. - Type types.DataSourceType + IndexId *string - // A list of key-value pairs that identify the data source. You can use the tags to - // identify and organize your resources and to control access to resources. - Tags []*types.Tag + // A unique name for the data source. A data source name can't be changed without + // deleting and recreating the data source. + // + // This member is required. + Name *string // The Amazon Resource Name (ARN) of a role with permission to access the data // source. For more information, see IAM Roles for Amazon Kendra @@ -82,11 +87,13 @@ type CreateDataSourceInput struct { // This member is required. RoleArn *string - // A unique name for the data source. A data source name can't be changed without - // deleting and recreating the data source. + // The type of repository that contains the data source. // // This member is required. - Name *string + Type types.DataSourceType + + // A description for the data source. + Description *string // Sets the frequency that Amazon Kendra will check the documents in your // repository and update the index. If you don't set a schedule Amazon Kendra will @@ -94,16 +101,9 @@ type CreateDataSourceInput struct { // operation to update the index. Schedule *string - // The identifier of the index that should be associated with this data source. - // - // This member is required. - IndexId *string - - // The connector configuration information that is required to access the - // repository. - // - // This member is required. - Configuration *types.DataSourceConfiguration + // A list of key-value pairs that identify the data source. You can use the tags to + // identify and organize your resources and to control access to resources. + Tags []*types.Tag } type CreateDataSourceOutput struct { diff --git a/service/kendra/api_op_CreateFaq.go b/service/kendra/api_op_CreateFaq.go index cc045c37e2f..617b4d7bcef 100644 --- a/service/kendra/api_op_CreateFaq.go +++ b/service/kendra/api_op_CreateFaq.go @@ -57,19 +57,22 @@ func (c *Client) CreateFaq(ctx context.Context, params *CreateFaqInput, optFns . type CreateFaqInput struct { + // The identifier of the index that contains the FAQ. + // + // This member is required. + IndexId *string + // The name that should be associated with the FAQ. // // This member is required. Name *string - // A list of key-value pairs that identify the FAQ. You can use the tags to - // identify and organize your resources and to control access to resources. - Tags []*types.Tag - - // The identifier of the index that contains the FAQ. + // The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket + // that contains the FAQs. For more information, see IAM Roles for Amazon Kendra + // (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). // // This member is required. - IndexId *string + RoleArn *string // The S3 location of the FAQ input data. // @@ -79,12 +82,9 @@ type CreateFaqInput struct { // A description of the FAQ. Description *string - // The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket - // that contains the FAQs. For more information, see IAM Roles for Amazon Kendra - // (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). - // - // This member is required. - RoleArn *string + // A list of key-value pairs that identify the FAQ. You can use the tags to + // identify and organize your resources and to control access to resources. + Tags []*types.Tag } type CreateFaqOutput struct { diff --git a/service/kendra/api_op_CreateIndex.go b/service/kendra/api_op_CreateIndex.go index 821455634ea..6a6730b23df 100644 --- a/service/kendra/api_op_CreateIndex.go +++ b/service/kendra/api_op_CreateIndex.go @@ -63,28 +63,11 @@ func (c *Client) CreateIndex(ctx context.Context, params *CreateIndexInput, optF type CreateIndexInput struct { - // The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data - // indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs. - ServerSideEncryptionConfiguration *types.ServerSideEncryptionConfiguration - // The name for the new index. // // This member is required. Name *string - // A list of key-value pairs that identify the index. You can use the tags to - // identify and organize your resources and to control access to resources. - Tags []*types.Tag - - // The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for - // indexes intended for development, testing, or proof of concept. Use - // ENTERPRISE_EDITION for your production databases. Once you set the edition for - // an index, it can't be changed. - Edition types.IndexEdition - - // A description for the index. - Description *string - // An IAM role that gives Amazon Kendra permissions to access your Amazon // CloudWatch logs and metrics. This is also the role used when you use the // BatchPutDocument operation to index documents from an Amazon S3 bucket. @@ -96,6 +79,23 @@ type CreateIndexInput struct { // calls to the CreateIndex operation with the same client token will create only // one index.” ClientToken *string + + // A description for the index. + Description *string + + // The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for + // indexes intended for development, testing, or proof of concept. Use + // ENTERPRISE_EDITION for your production databases. Once you set the edition for + // an index, it can't be changed. + Edition types.IndexEdition + + // The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data + // indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs. + ServerSideEncryptionConfiguration *types.ServerSideEncryptionConfiguration + + // A list of key-value pairs that identify the index. You can use the tags to + // identify and organize your resources and to control access to resources. + Tags []*types.Tag } type CreateIndexOutput struct { diff --git a/service/kendra/api_op_DeleteFaq.go b/service/kendra/api_op_DeleteFaq.go index 9655c12364d..0eb8ae00d70 100644 --- a/service/kendra/api_op_DeleteFaq.go +++ b/service/kendra/api_op_DeleteFaq.go @@ -56,15 +56,15 @@ func (c *Client) DeleteFaq(ctx context.Context, params *DeleteFaqInput, optFns . type DeleteFaqInput struct { - // The index to remove the FAQ from. + // The identifier of the FAQ to remove. // // This member is required. - IndexId *string + Id *string - // The identifier of the FAQ to remove. + // The index to remove the FAQ from. // // This member is required. - Id *string + IndexId *string } type DeleteFaqOutput struct { diff --git a/service/kendra/api_op_DescribeDataSource.go b/service/kendra/api_op_DescribeDataSource.go index 99c5665edb7..ae10011a9f6 100644 --- a/service/kendra/api_op_DescribeDataSource.go +++ b/service/kendra/api_op_DescribeDataSource.go @@ -71,48 +71,48 @@ type DescribeDataSourceInput struct { type DescribeDataSourceOutput struct { - // The identifier of the index that contains the data source. - IndexId *string - - // The current status of the data source. When the status is ACTIVE the data source - // is ready to use. When the status is FAILED, the ErrorMessage field contains the - // reason that the data source failed. - Status types.DataSourceStatus - - // The description of the data source. - Description *string - - // The identifier of the data source. - Id *string - - // The schedule that Amazon Kendra will update the data source. - Schedule *string - - // The Unix timestamp of when the data source was created. - CreatedAt *time.Time - // Information that describes where the data source is located and how the data // source is configured. The specific information in the description depends on the // data source provider. Configuration *types.DataSourceConfiguration + // The Unix timestamp of when the data source was created. + CreatedAt *time.Time + + // The description of the data source. + Description *string + // When the Status field value is FAILED, the ErrorMessage field contains a // description of the error that caused the data source to fail. ErrorMessage *string - // The Unix timestamp of when the data source was last updated. - UpdatedAt *time.Time + // The identifier of the data source. + Id *string + + // The identifier of the index that contains the data source. + IndexId *string // The name that you gave the data source when it was created. Name *string - // The type of the data source. - Type types.DataSourceType - // The Amazon Resource Name (ARN) of the role that enables the data source to // access its resources. RoleArn *string + // The schedule that Amazon Kendra will update the data source. + Schedule *string + + // The current status of the data source. When the status is ACTIVE the data source + // is ready to use. When the status is FAILED, the ErrorMessage field contains the + // reason that the data source failed. + Status types.DataSourceStatus + + // The type of the data source. + Type types.DataSourceType + + // The Unix timestamp of when the data source was last updated. + UpdatedAt *time.Time + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kendra/api_op_DescribeFaq.go b/service/kendra/api_op_DescribeFaq.go index 19718c9fcb7..17af25b08ce 100644 --- a/service/kendra/api_op_DescribeFaq.go +++ b/service/kendra/api_op_DescribeFaq.go @@ -71,24 +71,22 @@ type DescribeFaqInput struct { type DescribeFaqOutput struct { - // The identifier of the FAQ. - Id *string + // The date and time that the FAQ was created. + CreatedAt *time.Time // The description of the FAQ that you provided when it was created. Description *string - // Information required to find a specific file in an Amazon S3 bucket. - S3Path *types.S3Path + // If the Status field is FAILED, the ErrorMessage field contains the reason why + // the FAQ failed. + ErrorMessage *string - // The date and time that the FAQ was created. - CreatedAt *time.Time + // The identifier of the FAQ. + Id *string // The identifier of the index that contains the FAQ. IndexId *string - // The status of the FAQ. It is ready to use when the status is ACTIVE. - Status types.FaqStatus - // The name that you gave the FAQ when it was created. Name *string @@ -96,9 +94,11 @@ type DescribeFaqOutput struct { // containing the input files for the FAQ. RoleArn *string - // If the Status field is FAILED, the ErrorMessage field contains the reason why - // the FAQ failed. - ErrorMessage *string + // Information required to find a specific file in an Amazon S3 bucket. + S3Path *types.S3Path + + // The status of the FAQ. It is ready to use when the status is ACTIVE. + Status types.FaqStatus // The date and time that the FAQ was last updated. UpdatedAt *time.Time diff --git a/service/kendra/api_op_DescribeIndex.go b/service/kendra/api_op_DescribeIndex.go index b25cbc67960..a7c3b8b8b69 100644 --- a/service/kendra/api_op_DescribeIndex.go +++ b/service/kendra/api_op_DescribeIndex.go @@ -66,45 +66,42 @@ type DescribeIndexInput struct { type DescribeIndexOutput struct { - // When th eStatus field value is FAILED, the ErrorMessage field contains a message - // that explains why. - ErrorMessage *string + // For enterprise edtion indexes, you can choose to use additional capacity to meet + // the needs of your application. This contains the capacity units used for the + // index. A 0 for the query capacity or the storage capacity indicates that the + // index is using the default capacity for the index. + CapacityUnits *types.CapacityUnitsConfiguration - // The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra - // permission to write to your Amazon Cloudwatch logs. - RoleArn *string + // The Unix datetime that the index was created. + CreatedAt *time.Time + + // The description of the index. + Description *string // Configuration settings for any metadata applied to the documents in the index. DocumentMetadataConfigurations []*types.DocumentMetadataConfiguration - // the name of the index. - Id *string + // The Amazon Kendra edition used for the index. You decide the edition when you + // create the index. + Edition types.IndexEdition - // The description of the index. - Description *string + // When th eStatus field value is FAILED, the ErrorMessage field contains a message + // that explains why. + ErrorMessage *string - // For enterprise edtion indexes, you can choose to use additional capacity to meet - // the needs of your application. This contains the capacity units used for the - // index. A 0 for the query capacity or the storage capacity indicates that the - // index is using the default capacity for the index. - CapacityUnits *types.CapacityUnitsConfiguration + // the name of the index. + Id *string // Provides information about the number of FAQ questions and answers and the // number of text documents indexed. IndexStatistics *types.IndexStatistics - // The Unix datetime that the index was created. - CreatedAt *time.Time - - // The Unix datetime that the index was last updated. - UpdatedAt *time.Time - // The name of the index. Name *string - // The Amazon Kendra edition used for the index. You decide the edition when you - // create the index. - Edition types.IndexEdition + // The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra + // permission to write to your Amazon Cloudwatch logs. + RoleArn *string // The identifier of the AWS KMS customer master key (CMK) used to encrypt your // data. Amazon Kendra doesn't support asymmetric CMKs. @@ -115,6 +112,9 @@ type DescribeIndexOutput struct { // message that explains why. Status types.IndexStatus + // The Unix datetime that the index was last updated. + UpdatedAt *time.Time + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kendra/api_op_ListDataSourceSyncJobs.go b/service/kendra/api_op_ListDataSourceSyncJobs.go index 5bde747ef85..ccde21f7890 100644 --- a/service/kendra/api_op_ListDataSourceSyncJobs.go +++ b/service/kendra/api_op_ListDataSourceSyncJobs.go @@ -67,14 +67,14 @@ type ListDataSourceSyncJobsInput struct { // This member is required. IndexId *string - // If the result of the previous request to GetDataSourceSyncJobHistory was - // truncated, include the NextToken to fetch the next set of jobs. - NextToken *string - // The maximum number of synchronization jobs to return in the response. If there // are fewer results in the list, this response contains only the actual results. MaxResults *int32 + // If the result of the previous request to GetDataSourceSyncJobHistory was + // truncated, include the NextToken to fetch the next set of jobs. + NextToken *string + // When specified, the synchronization jobs returned in the list are limited to // jobs between the specified dates. StartTimeFilter *types.TimeRange diff --git a/service/kendra/api_op_ListIndices.go b/service/kendra/api_op_ListIndices.go index cad1f879d12..8960f52f70d 100644 --- a/service/kendra/api_op_ListIndices.go +++ b/service/kendra/api_op_ListIndices.go @@ -56,14 +56,14 @@ func (c *Client) ListIndices(ctx context.Context, params *ListIndicesInput, optF type ListIndicesInput struct { + // The maximum number of data sources to return. + MaxResults *int32 + // If the previous response was incomplete (because there is more data to // retrieve), Amazon Kendra returns a pagination token in the response. You can use // this pagination token to retrieve the next set of indexes // (DataSourceSummaryItems). NextToken *string - - // The maximum number of data sources to return. - MaxResults *int32 } type ListIndicesOutput struct { diff --git a/service/kendra/api_op_Query.go b/service/kendra/api_op_Query.go index 92e618c0cdf..a7034b18c73 100644 --- a/service/kendra/api_op_Query.go +++ b/service/kendra/api_op_Query.go @@ -73,14 +73,6 @@ func (c *Client) Query(ctx context.Context, params *QueryInput, optFns ...func(* type QueryInput struct { - // Provides information that determines how the results of the query are sorted. - // You can set the field that Amazon Kendra should sort the results on, and specify - // whether the results should be sorted in ascending or descending order. In the - // case of ties in sorting the results, the results are sorted by relevance. If you - // don't provide sorting configuration, the results are sorted by the relevance - // that Amazon Kendra determines for the result. - SortingConfiguration *types.SortingConfiguration - // The unique identifier of the index to search. The identifier is returned in the // response from the operation. // @@ -99,6 +91,11 @@ type QueryInput struct { // be included in the query results. AttributeFilter *types.AttributeFilter + // An array of documents attributes. Amazon Kendra returns a count for each + // attribute key specified. You can use this information to help narrow the search + // for your user. + Facets []*types.Facet + // Query results are returned in pages the size of the PageSize parameter. By // default, Amazon Kendra returns the first page of results. Use this parameter to // get result pages after the first one. @@ -109,11 +106,6 @@ type QueryInput struct { // ask for more than 100 results, only 100 are returned. PageSize *int32 - // An array of documents attributes. Amazon Kendra returns a count for each - // attribute key specified. You can use this information to help narrow the search - // for your user. - Facets []*types.Facet - // Sets the type of query. Only results for the specified query type are returned. QueryResultTypeFilter types.QueryResultType @@ -121,25 +113,33 @@ type QueryInput struct { // attributes are included in the response. By default all document attributes are // included in the response. RequestedDocumentAttributes []*string + + // Provides information that determines how the results of the query are sorted. + // You can set the field that Amazon Kendra should sort the results on, and specify + // whether the results should be sorted in ascending or descending order. In the + // case of ties in sorting the results, the results are sorted by relevance. If you + // don't provide sorting configuration, the results are sorted by the relevance + // that Amazon Kendra determines for the result. + SortingConfiguration *types.SortingConfiguration } type QueryOutput struct { - // The results of the search. - ResultItems []*types.QueryResultItem - // Contains the facet results. A FacetResult contains the counts for each attribute // key that was specified in the Facets input parameter. FacetResults []*types.FacetResult - // The number of items returned by the search. Use this to determine when you have - // requested the last set of results. - TotalNumberOfResults *int32 - // The unique identifier for the search. You use QueryId to identify the search // when using the feedback API. QueryId *string + // The results of the search. + ResultItems []*types.QueryResultItem + + // The number of items returned by the search. Use this to determine when you have + // requested the last set of results. + TotalNumberOfResults *int32 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kendra/api_op_SubmitFeedback.go b/service/kendra/api_op_SubmitFeedback.go index f33a3257eaa..dafc3c4e8e0 100644 --- a/service/kendra/api_op_SubmitFeedback.go +++ b/service/kendra/api_op_SubmitFeedback.go @@ -69,12 +69,12 @@ type SubmitFeedbackInput struct { // This member is required. QueryId *string + // Tells Amazon Kendra that a particular search result link was chosen by the user. + ClickFeedbackItems []*types.ClickFeedback + // Provides Amazon Kendra with relevant or not relevant feedback for whether a // particular item was relevant to the search. RelevanceFeedbackItems []*types.RelevanceFeedback - - // Tells Amazon Kendra that a particular search result link was chosen by the user. - ClickFeedbackItems []*types.ClickFeedback } type SubmitFeedbackOutput struct { diff --git a/service/kendra/api_op_UpdateDataSource.go b/service/kendra/api_op_UpdateDataSource.go index 9a7526922a5..6b00993fa24 100644 --- a/service/kendra/api_op_UpdateDataSource.go +++ b/service/kendra/api_op_UpdateDataSource.go @@ -62,25 +62,25 @@ type UpdateDataSourceInput struct { // This member is required. Id *string - // The Amazon Resource Name (ARN) of the new role to use when the data source is - // accessing resources on your behalf. - RoleArn *string - - // The name of the data source to update. The name of the data source can't be - // updated. To rename a data source you must delete the data source and re-create - // it. - Name *string - // The identifier of the index that contains the data source to update. // // This member is required. IndexId *string + // Configuration information for a Amazon Kendra data source. + Configuration *types.DataSourceConfiguration + // The new description for the data source. Description *string - // Configuration information for a Amazon Kendra data source. - Configuration *types.DataSourceConfiguration + // The name of the data source to update. The name of the data source can't be + // updated. To rename a data source you must delete the data source and re-create + // it. + Name *string + + // The Amazon Resource Name (ARN) of the new role to use when the data source is + // accessing resources on your behalf. + RoleArn *string // The new update schedule for the data source. Schedule *string diff --git a/service/kendra/api_op_UpdateIndex.go b/service/kendra/api_op_UpdateIndex.go index 8e4ca81d1d5..0c3424b2044 100644 --- a/service/kendra/api_op_UpdateIndex.go +++ b/service/kendra/api_op_UpdateIndex.go @@ -57,29 +57,29 @@ func (c *Client) UpdateIndex(ctx context.Context, params *UpdateIndexInput, optF type UpdateIndexInput struct { + // The identifier of the index to update. + // + // This member is required. + Id *string + // Sets the number of addtional storage and query capacity units that should be // used by the index. You can change the capacity of the index up to 5 times per // day. If you are using extra storage units, you can't reduce the storage capacity // below that required to meet the storage needs for your index. CapacityUnits *types.CapacityUnitsConfiguration - // The identifier of the index to update. - // - // This member is required. - Id *string + // A new description for the index. + Description *string // The document metadata to update. DocumentMetadataConfigurationUpdates []*types.DocumentMetadataConfiguration - // A new description for the index. - Description *string + // The name of the index to update. + Name *string // A new IAM role that gives Amazon Kendra permission to access your Amazon // CloudWatch logs. RoleArn *string - - // The name of the index to update. - Name *string } type UpdateIndexOutput struct { diff --git a/service/kendra/go.mod b/service/kendra/go.mod index f0bafc19804..2bd6a673b4b 100644 --- a/service/kendra/go.mod +++ b/service/kendra/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/kendra go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/kendra/types/types.go b/service/kendra/types/types.go index c439a304475..1d857407276 100644 --- a/service/kendra/types/types.go +++ b/service/kendra/types/types.go @@ -61,41 +61,41 @@ type AdditionalResultAttributeValue struct { // have a depth of more than 2." type AttributeFilter struct { - // Performs an equals operation on two document attributes. - EqualsTo *DocumentAttribute - // Performs a logical AND operation on all supplied filters. AndAllFilters []*AttributeFilter - // Performs a greater than operation on two document attributes. Use with a - // document attribute of type Integer or Long. - GreaterThan *DocumentAttribute + // Returns true when a document contains all of the specified document attributes. + // This filter is only appicable to StringListValue metadata. + ContainsAll *DocumentAttribute // Returns true when a document contains any of the specified document // attributes.This filter is only appicable to StringListValue metadata. ContainsAny *DocumentAttribute - // Performs a less than or equals operation on two document attributes. Use with a - // document attribute of type Integer or Long. - LessThanOrEquals *DocumentAttribute + // Performs an equals operation on two document attributes. + EqualsTo *DocumentAttribute - // Performs a logical NOT operation on all supplied filters. - NotFilter *AttributeFilter + // Performs a greater than operation on two document attributes. Use with a + // document attribute of type Integer or Long. + GreaterThan *DocumentAttribute // Performs a greater or equals than operation on two document attributes. Use with // a document attribute of type Integer or Long. GreaterThanOrEquals *DocumentAttribute - // Performs a logical OR operation on all supplied filters. - OrAllFilters []*AttributeFilter - - // Returns true when a document contains all of the specified document attributes. - // This filter is only appicable to StringListValue metadata. - ContainsAll *DocumentAttribute - // Performs a less than operation on two document attributes. Use with a document // attribute of type Integer or Long. LessThan *DocumentAttribute + + // Performs a less than or equals operation on two document attributes. Use with a + // document attribute of type Integer or Long. + LessThanOrEquals *DocumentAttribute + + // Performs a logical NOT operation on all supplied filters. + NotFilter *AttributeFilter + + // Performs a logical OR operation on all supplied filters. + OrAllFilters []*AttributeFilter } // Provides information about documents that could not be removed from an index by @@ -171,14 +171,14 @@ type ColumnConfiguration struct { // This member is required. DocumentDataColumnName *string - // The column that contains the title of the document. - DocumentTitleColumnName *string - // The column that provides the document's unique identifier. // // This member is required. DocumentIdColumnName *string + // The column that contains the title of the document. + DocumentTitleColumnName *string + // An array of objects that map database column names to the corresponding fields // in an index. You must first create the fields in the index using the UpdateIndex // () operation. @@ -188,16 +188,11 @@ type ColumnConfiguration struct { // Provides the information necessary to connect to a database. type ConnectionConfiguration struct { - // The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The - // credentials should be a user/password pair. For more information, see Using a - // Database Data Source - // (https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html). For - // more information about AWS Secrets Manager, see What Is AWS Secrets Manager - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) in the - // AWS Secrets Manager user guide. + // The name of the host for the database. Can be either a string + // (host.subdomain.domain.tld) or an IPv4 or IPv6 address. // // This member is required. - SecretArn *string + DatabaseHost *string // The name of the database containing the document data. // @@ -209,11 +204,16 @@ type ConnectionConfiguration struct { // This member is required. DatabasePort *int32 - // The name of the host for the database. Can be either a string - // (host.subdomain.domain.tld) or an IPv4 or IPv6 address. + // The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The + // credentials should be a user/password pair. For more information, see Using a + // Database Data Source + // (https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html). For + // more information about AWS Secrets Manager, see What Is AWS Secrets Manager + // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) in the + // AWS Secrets Manager user guide. // // This member is required. - DatabaseHost *string + SecretArn *string // The name of the table that contains the document data. // @@ -224,40 +224,46 @@ type ConnectionConfiguration struct { // Provides the information necessary to connect a database to an index. type DatabaseConfiguration struct { - // The information necessary to connect to a database. - // - // This member is required. - ConnectionConfiguration *ConnectionConfiguration - // Information about where the index should get the document information from the // database. // // This member is required. ColumnConfiguration *ColumnConfiguration - // Provides information for connecting to an Amazon VPC. - VpcConfiguration *DataSourceVpcConfiguration - - // Information about the database column that provides information for user context - // filtering. - AclConfiguration *AclConfiguration + // The information necessary to connect to a database. + // + // This member is required. + ConnectionConfiguration *ConnectionConfiguration // The type of database engine that runs the database. // // This member is required. DatabaseEngineType DatabaseEngineType + // Information about the database column that provides information for user context + // filtering. + AclConfiguration *AclConfiguration + // Provides information about how Amazon Kendra uses quote marks around SQL // identifiers when querying a database data source. SqlConfiguration *SqlConfiguration + + // Provides information for connecting to an Amazon VPC. + VpcConfiguration *DataSourceVpcConfiguration } // Configuration information for a Amazon Kendra data source. type DataSourceConfiguration struct { - // Provides information necessary to create a connector for a Microsoft SharePoint - // site. - SharePointConfiguration *SharePointConfiguration + // Provides information necessary to create a connector for a database. + DatabaseConfiguration *DatabaseConfiguration + + // Provided configuration for data sources that connect to Microsoft OneDrive. + OneDriveConfiguration *OneDriveConfiguration + + // Provides information to create a connector for a document repository in an + // Amazon S3 bucket. + S3Configuration *S3DataSourceConfiguration // Provides configuration information for data sources that connect to a Salesforce // site. @@ -266,78 +272,80 @@ type DataSourceConfiguration struct { // Provides configuration for data sources that connect to ServiceNow instances. ServiceNowConfiguration *ServiceNowConfiguration - // Provided configuration for data sources that connect to Microsoft OneDrive. - OneDriveConfiguration *OneDriveConfiguration - - // Provides information necessary to create a connector for a database. - DatabaseConfiguration *DatabaseConfiguration - - // Provides information to create a connector for a document repository in an - // Amazon S3 bucket. - S3Configuration *S3DataSourceConfiguration + // Provides information necessary to create a connector for a Microsoft SharePoint + // site. + SharePointConfiguration *SharePointConfiguration } // Summary information for a Amazon Kendra data source. Returned in a call to . type DataSourceSummary struct { + // The UNIX datetime that the data source was created. + CreatedAt *time.Time + // The unique identifier for the data source. Id *string - // The UNIX datetime that the data source was lasted updated. - UpdatedAt *time.Time - // The name of the data source. Name *string - // The type of the data source. - Type DataSourceType - // The status of the data source. When the status is ATIVE the data source is ready // to use. Status DataSourceStatus - // The UNIX datetime that the data source was created. - CreatedAt *time.Time + // The type of the data source. + Type DataSourceType + + // The UNIX datetime that the data source was lasted updated. + UpdatedAt *time.Time } // Provides information about a synchronization job. type DataSourceSyncJob struct { - // The UNIX datetime that the synchronization job was started. - StartTime *time.Time - - // A unique identifier for the synchronization job. - ExecutionId *string - // If the reason that the synchronization failed is due to an error with the // underlying data source, this field contains a code that identifies the error. DataSourceErrorCode *string + // The UNIX datetime that the synchronization job was completed. + EndTime *time.Time + + // If the Status field is set to FAILED, the ErrorCode field contains a the reason + // that the synchronization failed. + ErrorCode ErrorCode + // If the Status field is set to ERROR, the ErrorMessage field contains a // description of the error that caused the synchronization to fail. ErrorMessage *string + // A unique identifier for the synchronization job. + ExecutionId *string + // Maps a batch delete document request to a specific data source sync job. This is // optional and should only be supplied when documents are deleted by a connector. Metrics *DataSourceSyncJobMetrics + // The UNIX datetime that the synchronization job was started. + StartTime *time.Time + // The execution status of the synchronization job. When the Status field is set to // SUCCEEDED, the synchronization job is done. If the status code is set to FAILED, // the ErrorCode and ErrorMessage fields give you the reason for the failure. Status DataSourceSyncJobStatus - - // The UNIX datetime that the synchronization job was completed. - EndTime *time.Time - - // If the Status field is set to FAILED, the ErrorCode field contains a the reason - // that the synchronization failed. - ErrorCode ErrorCode } // Maps a batch delete document request to a specific data source sync job. This is // optional and should only be supplied when documents are deleted by a connector. type DataSourceSyncJobMetrics struct { + // The number of documents added from the data source up to now in the data source + // sync. + DocumentsAdded *string + + // The number of documents deleted from the data source up to now in the data + // source sync run. + DocumentsDeleted *string + // The number of documents that failed to sync from the data source up to now in // the data source sync run. DocumentsFailed *string @@ -349,14 +357,6 @@ type DataSourceSyncJobMetrics struct { // The current number of documents crawled by the current sync job in the data // source. DocumentsScanned *string - - // The number of documents deleted from the data source up to now in the data - // source sync run. - DocumentsDeleted *string - - // The number of documents added from the data source up to now in the data source - // sync. - DocumentsAdded *string } // Maps a particular data source sync job to a particular data source. @@ -382,13 +382,13 @@ type DataSourceToIndexFieldMapping struct { // This member is required. DataSourceFieldName *string - // The type of data stored in the column or attribute. - DateFieldFormat *string - // The name of the field in the index. // // This member is required. IndexFieldName *string + + // The type of data stored in the column or attribute. + DateFieldFormat *string } // Provides information for connecting to an Amazon VPC. @@ -411,19 +411,18 @@ type DataSourceVpcConfiguration struct { // A document in an index. type Document struct { - // Information to use for user context filtering. - AccessControlList []*Principal - - // The file type of the document in the Blob field. - ContentType ContentType - // A unique identifier of the document in the index. // // This member is required. Id *string - // Information required to find a specific file in an Amazon S3 bucket. - S3Path *S3Path + // Information to use for user context filtering. + AccessControlList []*Principal + + // Custom attributes to apply to the document. Use the custom attributes to provide + // additional information for searching, to provide facets for refining searches, + // and to provide additional information in the query response. + Attributes []*DocumentAttribute // The contents of the document. Documents passed to the Blob parameter must be // base64 encoded. Your code might not need to encode the document file bytes if @@ -432,10 +431,11 @@ type Document struct { // before sending. Blob []byte - // Custom attributes to apply to the document. Use the custom attributes to provide - // additional information for searching, to provide facets for refining searches, - // and to provide additional information in the query response. - Attributes []*DocumentAttribute + // The file type of the document in the Blob field. + ContentType ContentType + + // Information required to find a specific file in an Amazon S3 bucket. + S3Path *S3Path // The title of the document. Title *string @@ -444,24 +444,21 @@ type Document struct { // A custom attribute value assigned to a document. type DocumentAttribute struct { - // The value of the attribute. + // The identifier for the attribute. // // This member is required. - Value *DocumentAttributeValue + Key *string - // The identifier for the attribute. + // The value of the attribute. // // This member is required. - Key *string + Value *DocumentAttributeValue } // The value of a custom document attribute. You can only provide one value for a // custom attribute. type DocumentAttributeValue struct { - // A string, such as "department". - StringValue *string - // A date expressed as an ISO 8601 string. DateValue *time.Time @@ -470,6 +467,9 @@ type DocumentAttributeValue struct { // A list of strings. StringListValue []*string + + // A string, such as "department". + StringValue *string } // Provides the count of documents that match a particular attribute when doing a @@ -487,22 +487,22 @@ type DocumentAttributeValueCountPair struct { // Specifies the properties of a custom index field. type DocumentMetadataConfiguration struct { - // Provides information about how the field is used during a search. - Search *Search - // The name of the index field. // // This member is required. Name *string - // Provides manual tuning parameters to determine how the field affects the search - // results. - Relevance *Relevance - // The data type of the index field. // // This member is required. Type DocumentAttributeValueType + + // Provides manual tuning parameters to determine how the field affects the search + // results. + Relevance *Relevance + + // Provides information about how the field is used during a search. + Search *Search } // Document metadata files that contain information such as the document access @@ -526,13 +526,13 @@ type Facet struct { // The facet values for the documents in the response. type FacetResult struct { - // An array of key/value pairs, where the key is the value of the attribute and the - // count is the number of documents that share the key value. - DocumentAttributeValueCountPairs []*DocumentAttributeValueCountPair - // The key for the facet values. This is the same as the DocumentAttributeKey // provided in the query. DocumentAttributeKey *string + + // An array of key/value pairs, where the key is the value of the attribute and the + // count is the number of documents that share the key value. + DocumentAttributeValueCountPairs []*DocumentAttributeValueCountPair } // Provides statistical information about the FAQ questions and answers contained @@ -549,8 +549,8 @@ type FaqStatistics struct { // an index. type FaqSummary struct { - // The UNIX datetime that the FAQ was last updated. - UpdatedAt *time.Time + // The UNIX datetime that the FAQ was added to the index. + CreatedAt *time.Time // The unique identifier of the FAQ. Id *string @@ -562,35 +562,42 @@ type FaqSummary struct { // use. Status FaqStatus - // The UNIX datetime that the FAQ was added to the index. - CreatedAt *time.Time + // The UNIX datetime that the FAQ was last updated. + UpdatedAt *time.Time } // Provides information that you can use to highlight a search result so that your // users can quickly identify terms in the response. type Highlight struct { - // Indicates whether the response is the best response. True if this is the best - // response; otherwise, false. - TopAnswer *bool + // The zero-based location in the response string where the highlight starts. + // + // This member is required. + BeginOffset *int32 // The zero-based location in the response string where the highlight ends. // // This member is required. EndOffset *int32 - // The zero-based location in the response string where the highlight starts. - // - // This member is required. - BeginOffset *int32 + // Indicates whether the response is the best response. True if this is the best + // response; otherwise, false. + TopAnswer *bool } // A summary of information about an index. type IndexConfigurationSummary struct { - // A unique identifier for the index. Use this to identify the index when you are - // using operations such as Query, DescribeIndex, UpdateIndex, and DeleteIndex. - Id *string + // The Unix timestamp when the index was created. + // + // This member is required. + CreatedAt *time.Time + + // The current status of the index. When the status is ACTIVE, the index is ready + // to search. + // + // This member is required. + Status IndexStatus // The Unix timestamp when the index was last updated by the UpdateIndex operation. // @@ -601,19 +608,12 @@ type IndexConfigurationSummary struct { // index. Edition IndexEdition + // A unique identifier for the index. Use this to identify the index when you are + // using operations such as Query, DescribeIndex, UpdateIndex, and DeleteIndex. + Id *string + // The name of the index. Name *string - - // The Unix timestamp when the index was created. - // - // This member is required. - CreatedAt *time.Time - - // The current status of the index. When the status is ACTIVE, the index is ready - // to search. - // - // This member is required. - Status IndexStatus } // Provides information about the number of documents and the number of questions @@ -634,6 +634,11 @@ type IndexStatistics struct { // Provides configuration information for data sources that connect to OneDrive. type OneDriveConfiguration struct { + // A list of user accounts whose documents should be indexed. + // + // This member is required. + OneDriveUsers *OneDriveUsers + // The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains // the user name and password to connect to OneDrive. The user namd should be the // application ID for the OneDrive application, and the password is the application @@ -653,10 +658,10 @@ type OneDriveConfiguration struct { // The exclusion pattern is applied to the file name. ExclusionPatterns []*string - // A list of user accounts whose documents should be indexed. - // - // This member is required. - OneDriveUsers *OneDriveUsers + // A list of DataSourceToIndexFieldMapping objects that map Microsoft OneDrive + // fields to custom fields in the Amazon Kendra index. You must first create the + // index fields before you map OneDrive fields. + FieldMappings []*DataSourceToIndexFieldMapping // A list of regular expression patterns. Documents that match the pattern are // included in the index. Documents that don't match the pattern are excluded from @@ -664,11 +669,6 @@ type OneDriveConfiguration struct { // pattern, the document is not included in the index. The exclusion pattern is // applied to the file name. InclusionPatterns []*string - - // A list of DataSourceToIndexFieldMapping objects that map Microsoft OneDrive - // fields to custom fields in the Amazon Kendra index. You must first create the - // index fields before you map OneDrive fields. - FieldMappings []*DataSourceToIndexFieldMapping } // User accounts whose documents should be indexed. @@ -688,20 +688,20 @@ type OneDriveUsers struct { // Provides user and group information for document access filtering. type Principal struct { - // The type of principal. + // Whether to allow or deny access to the principal. // // This member is required. - Type PrincipalType + Access ReadAccessType // The name of the user or group. // // This member is required. Name *string - // Whether to allow or deny access to the principal. + // The type of principal. // // This member is required. - Access ReadAccessType + Type PrincipalType } // A single query result. A query result contains information about a document @@ -710,33 +710,33 @@ type Principal struct { // that satisfies the query. type QueryResultItem struct { - // The unique identifier for the query result. - Id *string - - // The title of the document. Contains the text of the title and information for - // highlighting the relevant terms in the title. - DocumentTitle *TextWithHighlights - - // The URI of the original location of the document. - DocumentURI *string + // One or more additional attribues associated with the query result. + AdditionalAttributes []*AdditionalResultAttribute // An array of document attributes for the document that the query result maps to. // For example, the document author (Author) or the source URI (SourceUri) of the // document. DocumentAttributes []*DocumentAttribute - // The type of document. - Type QueryResultType + // An extract of the text in the document. Contains information about highlighting + // the relevant terms in the excerpt. + DocumentExcerpt *TextWithHighlights // The unique identifier for the document. DocumentId *string - // One or more additional attribues associated with the query result. - AdditionalAttributes []*AdditionalResultAttribute + // The title of the document. Contains the text of the title and information for + // highlighting the relevant terms in the title. + DocumentTitle *TextWithHighlights - // An extract of the text in the document. Contains information about highlighting - // the relevant terms in the excerpt. - DocumentExcerpt *TextWithHighlights + // The URI of the original location of the document. + DocumentURI *string + + // The unique identifier for the query result. + Id *string + + // The type of document. + Type QueryResultType } // Provides information for manually tuning the relevance of a field in a search. @@ -744,22 +744,6 @@ type QueryResultItem struct { // in the response based on these tuning parameters. type Relevance struct { - // Indicates that this field determines how "fresh" a document is. For example, if - // document 1 was created on November 5, and document 2 was created on October 31, - // document 1 is "fresher" than document 2. You can only set the Freshness field on - // one DATE type field. Only applies to DATE fields. - Freshness *bool - - // A list of values that should be given a different boost when they appear in the - // result list. For example, if you are boosting a field called "department," query - // terms that match the department field are boosted in the result. However, you - // can add entries from the department field to boost documents with those values - // higher. For example, you can add entries to the map with names of departments. - // If you add "HR",5 and "Legal",3 those departments are given special attention - // when they appear in the metadata of a document. When those terms appear they are - // given the specified importance instead of the regular importance for the boost. - ValueImportanceMap map[string]*int32 - // Specifies the time period that the boost applies to. For example, to make the // boost apply to documents with the field value within the last month, you would // use "2628000s". Once the field value is beyond the specified range, the effect @@ -769,6 +753,16 @@ type Relevance struct { // for one day, or "604800s" for one week. Only applies to DATE fields. Duration *string + // Indicates that this field determines how "fresh" a document is. For example, if + // document 1 was created on November 5, and document 2 was created on October 31, + // document 1 is "fresher" than document 2. You can only set the Freshness field on + // one DATE type field. Only applies to DATE fields. + Freshness *bool + + // The relative importance of the field in the search. Larger numbers provide more + // of a boost than smaller numbers. + Importance *int32 + // Determines how values should be interpreted. When the RankOrder field is // ASCENDING, higher numbers are better. For example, a document with a rating // score of 10 is higher ranking than a document with a rating score of 1. When the @@ -777,79 +771,79 @@ type Relevance struct { // task. Only applies to LONG and DOUBLE fields. RankOrder Order - // The relative importance of the field in the search. Larger numbers provide more - // of a boost than smaller numbers. - Importance *int32 + // A list of values that should be given a different boost when they appear in the + // result list. For example, if you are boosting a field called "department," query + // terms that match the department field are boosted in the result. However, you + // can add entries from the department field to boost documents with those values + // higher. For example, you can add entries to the map with names of departments. + // If you add "HR",5 and "Legal",3 those departments are given special attention + // when they appear in the metadata of a document. When those terms appear they are + // given the specified importance instead of the regular importance for the boost. + ValueImportanceMap map[string]*int32 } // Provides feedback on how relevant a document is to a search. Your application // uses the SubmitFeedback () operation to provide relevance information. type RelevanceFeedback struct { - // The unique identifier of the search result that the user provided relevance - // feedback for. + // Whether to document was relevant or not relevant to the search. // // This member is required. - ResultId *string + RelevanceValue RelevanceType - // Whether to document was relevant or not relevant to the search. + // The unique identifier of the search result that the user provided relevance + // feedback for. // // This member is required. - RelevanceValue RelevanceType + ResultId *string } // Provides configuration information for a data source to index documents in an // Amazon S3 bucket. type S3DataSourceConfiguration struct { - // A list of glob patterns for documents that should not be indexed. If a document - // that matches an inclusion prefix also matches an exclusion pattern, the document - // is not indexed. For more information about glob patterns, see glob (programming) - // (https://en.wikipedia.org/wiki/Glob_(programming)) in Wikipedia. - ExclusionPatterns []*string - - // A list of S3 prefixes for the documents that should be included in the index. - InclusionPrefixes []*string - - // Provides the path to the S3 bucket that contains the user context filtering - // files for the data source. - AccessControlListConfiguration *AccessControlListConfiguration - // The name of the bucket that contains the documents. // // This member is required. BucketName *string + // Provides the path to the S3 bucket that contains the user context filtering + // files for the data source. + AccessControlListConfiguration *AccessControlListConfiguration + // Document metadata files that contain information such as the document access // control information, source URI, document author, and custom attributes. Each // metadata file contains metadata about a single document. DocumentsMetadataConfiguration *DocumentsMetadataConfiguration + + // A list of glob patterns for documents that should not be indexed. If a document + // that matches an inclusion prefix also matches an exclusion pattern, the document + // is not indexed. For more information about glob patterns, see glob (programming) + // (https://en.wikipedia.org/wiki/Glob_(programming)) in Wikipedia. + ExclusionPatterns []*string + + // A list of S3 prefixes for the documents that should be included in the index. + InclusionPrefixes []*string } // Information required to find a specific file in an Amazon S3 bucket. type S3Path struct { - // The name of the file. + // The name of the S3 bucket that contains the file. // // This member is required. - Key *string + Bucket *string - // The name of the S3 bucket that contains the file. + // The name of the file. // // This member is required. - Bucket *string + Key *string } // Defines configuration for syncing a Salesforce chatter feed. The contents of the // object comes from the Salesforce FeedItem table. type SalesforceChatterFeedConfiguration struct { - // Filters the documents in the feed based on status of the user. When you specify - // ACTIVE_USERS only documents from users who have an active account are indexed. - // When you specify STANDARD_USER only documents for Salesforce standard users are - // documented. You can specify both. - IncludeFilterTypes []SalesforceChatterFeedIncludeFilterType - // The name of the column in the Salesforce FeedItem table that contains the // content to index. Typically this is the Body column. // @@ -862,18 +856,17 @@ type SalesforceChatterFeedConfiguration struct { // Maps fields from a Salesforce chatter feed into Amazon Kendra index fields. FieldMappings []*DataSourceToIndexFieldMapping + + // Filters the documents in the feed based on status of the user. When you specify + // ACTIVE_USERS only documents from users who have an active account are indexed. + // When you specify STANDARD_USER only documents for Salesforce standard users are + // documented. You can specify both. + IncludeFilterTypes []SalesforceChatterFeedIncludeFilterType } // Provides configuration information for connecting to a Salesforce data source. type SalesforceConfiguration struct { - // A list of regular expression patterns. Documents that match the patterns are - // included in the index. Documents that don't match the patterns are excluded from - // the index. If a document matches both an inclusion pattern and an exclusion - // pattern, the document is not included in the index. The regex is applied to the - // name of the attached file. - IncludeAttachmentFilePatterns []*string - // The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains // the key/value pairs required to connect to your Salesforce instance. The secret // must contain a JSON structure with the following keys: @@ -906,9 +899,26 @@ type SalesforceConfiguration struct { // This member is required. ServerUrl *string + // Specifies configuration information for Salesforce chatter feeds. + ChatterFeedConfiguration *SalesforceChatterFeedConfiguration + // Indicates whether Amazon Kendra should index attachments to Salesforce objects. CrawlAttachments *bool + // A list of regular expression patterns. Documents that match the patterns are + // excluded from the index. Documents that don't match the patterns are included in + // the index. If a document matches both an exclusion pattern and an inclusion + // pattern, the document is not included in the index. The regex is applied to the + // name of the attached file. + ExcludeAttachmentFilePatterns []*string + + // A list of regular expression patterns. Documents that match the patterns are + // included in the index. Documents that don't match the patterns are excluded from + // the index. If a document matches both an inclusion pattern and an exclusion + // pattern, the document is not included in the index. The regex is applied to the + // name of the attached file. + IncludeAttachmentFilePatterns []*string + // Specifies configuration information for the knowlege article types that Amazon // Kendra indexes. Amazon Kendra indexes standard knowledge articles and the // standard fields of knowledge articles, or the custom fields of custom knowledge @@ -919,27 +929,13 @@ type SalesforceConfiguration struct { // standard objects. StandardObjectAttachmentConfiguration *SalesforceStandardObjectAttachmentConfiguration - // A list of regular expression patterns. Documents that match the patterns are - // excluded from the index. Documents that don't match the patterns are included in - // the index. If a document matches both an exclusion pattern and an inclusion - // pattern, the document is not included in the index. The regex is applied to the - // name of the attached file. - ExcludeAttachmentFilePatterns []*string - // Specifies the Salesforce standard objects that Amazon Kendra indexes. StandardObjectConfigurations []*SalesforceStandardObjectConfiguration - - // Specifies configuration information for Salesforce chatter feeds. - ChatterFeedConfiguration *SalesforceChatterFeedConfiguration } // Provides configuration information for indexing Salesforce custom articles. type SalesforceCustomKnowledgeArticleTypeConfiguration struct { - // One or more objects that map fields in the custom knowledge article to fields in - // the Amazon Kendra index. - FieldMappings []*DataSourceToIndexFieldMapping - // The name of the field in the custom knowledge article that contains the document // data to index. // @@ -954,6 +950,10 @@ type SalesforceCustomKnowledgeArticleTypeConfiguration struct { // The name of the field in the custom knowledge article that contains the document // title. DocumentTitleFieldName *string + + // One or more objects that map fields in the custom knowledge article to fields in + // the Amazon Kendra index. + FieldMappings []*DataSourceToIndexFieldMapping } // Specifies configuration information for the knowlege article types that Amazon @@ -962,9 +962,6 @@ type SalesforceCustomKnowledgeArticleTypeConfiguration struct { // articles, but not both type SalesforceKnowledgeArticleConfiguration struct { - // Provides configuration information for standard Salesforce knowledge articles. - StandardKnowledgeArticleTypeConfiguration *SalesforceStandardKnowledgeArticleTypeConfiguration - // Specifies the document states that should be included when Amazon Kendra indexes // knowledge articles. You must specify at least one state. // @@ -973,11 +970,19 @@ type SalesforceKnowledgeArticleConfiguration struct { // Provides configuration information for custom Salesforce knowledge articles. CustomKnowledgeArticleTypeConfigurations []*SalesforceCustomKnowledgeArticleTypeConfiguration + + // Provides configuration information for standard Salesforce knowledge articles. + StandardKnowledgeArticleTypeConfiguration *SalesforceStandardKnowledgeArticleTypeConfiguration } // Provides configuration information for standard Salesforce knowledge articles. type SalesforceStandardKnowledgeArticleTypeConfiguration struct { + // The name of the field that contains the document data to index. + // + // This member is required. + DocumentDataFieldName *string + // The name of the field that contains the document title. DocumentTitleFieldName *string @@ -985,11 +990,6 @@ type SalesforceStandardKnowledgeArticleTypeConfiguration struct { // index fields. The index field must exist before you can map a Salesforce field // to it. FieldMappings []*DataSourceToIndexFieldMapping - - // The name of the field that contains the document data to index. - // - // This member is required. - DocumentDataFieldName *string } // Provides configuration information for processing attachments to Salesforce @@ -1008,13 +1008,10 @@ type SalesforceStandardObjectAttachmentConfiguration struct { type SalesforceStandardObjectConfiguration struct { // The name of the field in the standard object table that contains the document - // titleB. - DocumentTitleFieldName *string - - // One or more objects that map fields in the standard object to Amazon Kendra - // index fields. The index field must exist before you can map a Salesforce field - // to it. - FieldMappings []*DataSourceToIndexFieldMapping + // contents. + // + // This member is required. + DocumentDataFieldName *string // The name of the standard object. // @@ -1022,33 +1019,36 @@ type SalesforceStandardObjectConfiguration struct { Name SalesforceStandardObjectName // The name of the field in the standard object table that contains the document - // contents. - // - // This member is required. - DocumentDataFieldName *string + // titleB. + DocumentTitleFieldName *string + + // One or more objects that map fields in the standard object to Amazon Kendra + // index fields. The index field must exist before you can map a Salesforce field + // to it. + FieldMappings []*DataSourceToIndexFieldMapping } // Provides information about how a custom index field is used during a search. type Search struct { - // Indicates that the field can be used to create search facets, a count of results - // for each value in the field. The default is false . - Facetable *bool - // Determines whether the field is returned in the query response. The default is // true. Displayable *bool - // Determines whether the field can be used to sort the results of a query. If you - // specify sorting on a field that does not have Sortable set to true, Amazon - // Kendra returns an exception. The default is false. - Sortable *bool + // Indicates that the field can be used to create search facets, a count of results + // for each value in the field. The default is false . + Facetable *bool // Determines whether the field is used in the search. If the Searchable field is // true, you can use relevance tuning to manually tune how Amazon Kendra weights // the field in the search. The default is true for string fields and false for // number and date fields. Searchable *bool + + // Determines whether the field can be used to sort the results of a query. If you + // specify sorting on a field that does not have Sortable set to true, Amazon + // Kendra returns an exception. The default is false. + Sortable *bool } // Provides the identifier of the AWS KMS customer master key (CMK) used to encrypt @@ -1064,15 +1064,11 @@ type ServerSideEncryptionConfiguration struct { // source. type ServiceNowConfiguration struct { - // The identifier of the release that the ServiceNow host is running. If the host - // is not running the LONDON release, use OTHERS. + // The ServiceNow instance that the data source connects to. The host endpoint + // should look like the following: {instance}.service-now.com. // // This member is required. - ServiceNowBuildVersion ServiceNowBuildVersionType - - // Provides configuration information for crawling service catalogs in the - // ServiceNow site. - ServiceCatalogConfiguration *ServiceNowServiceCatalogConfiguration + HostUrl *string // The Amazon Resource Name (ARN) of the AWS Secret Manager secret that contains // the user name and password required to connect to the ServiceNow instance. @@ -1080,30 +1076,25 @@ type ServiceNowConfiguration struct { // This member is required. SecretArn *string - // The ServiceNow instance that the data source connects to. The host endpoint - // should look like the following: {instance}.service-now.com. + // The identifier of the release that the ServiceNow host is running. If the host + // is not running the LONDON release, use OTHERS. // // This member is required. - HostUrl *string + ServiceNowBuildVersion ServiceNowBuildVersionType // Provides configuration information for crawling knowledge articles in the // ServiceNow site. KnowledgeArticleConfiguration *ServiceNowKnowledgeArticleConfiguration + + // Provides configuration information for crawling service catalogs in the + // ServiceNow site. + ServiceCatalogConfiguration *ServiceNowServiceCatalogConfiguration } // Provides configuration information for crawling knowledge articles in the // ServiceNow site. type ServiceNowKnowledgeArticleConfiguration struct { - // The name of the ServiceNow field that is mapped to the index document title - // field. - DocumentTitleFieldName *string - - // List of regular expressions applied to knowledge articles. Items that don't - // match the inclusion pattern are not indexed. The regex is applied to the field - // specified in the PatternTargetField - ExcludeAttachmentFilePatterns []*string - // The name of the ServiceNow field that is mapped to the index document contents // field in the Amazon Kendra index. // @@ -1113,6 +1104,15 @@ type ServiceNowKnowledgeArticleConfiguration struct { // Indicates whether Amazon Kendra should index attachments to knowledge articles. CrawlAttachments *bool + // The name of the ServiceNow field that is mapped to the index document title + // field. + DocumentTitleFieldName *string + + // List of regular expressions applied to knowledge articles. Items that don't + // match the inclusion pattern are not indexed. The regex is applied to the field + // specified in the PatternTargetField + ExcludeAttachmentFilePatterns []*string + // Mapping between ServiceNow fields and Amazon Kendra index fields. You must // create the index field before you map the field. FieldMappings []*DataSourceToIndexFieldMapping @@ -1127,10 +1127,6 @@ type ServiceNowKnowledgeArticleConfiguration struct { // ServiceNow site type ServiceNowServiceCatalogConfiguration struct { - // The name of the ServiceNow field that is mapped to the index document title - // field. - DocumentTitleFieldName *string - // The name of the ServiceNow field that is mapped to the index document contents // field in the Amazon Kendra index. // @@ -1141,28 +1137,25 @@ type ServiceNowServiceCatalogConfiguration struct { // items. CrawlAttachments *bool + // The name of the ServiceNow field that is mapped to the index document title + // field. + DocumentTitleFieldName *string + // Determines the types of file attachments that are excluded from the index. ExcludeAttachmentFilePatterns []*string - // Determines the types of file attachments that are included in the index. - IncludeAttachmentFilePatterns []*string - // Mapping between ServiceNow fields and Amazon Kendra index fields. You must // create the index field before you map the field. FieldMappings []*DataSourceToIndexFieldMapping + + // Determines the types of file attachments that are included in the index. + IncludeAttachmentFilePatterns []*string } // Provides configuration information for connecting to a Microsoft SharePoint data // source. type SharePointConfiguration struct { - // A list of regular expression patterns. Documents that match the patterns are - // excluded from the index. Documents that don't match the patterns are included in - // the index. If a document matches both an exclusion pattern and an inclusion - // pattern, the document is not included in the index. The regex is applied to the - // display URL of the SharePoint document. - ExclusionPatterns []*string - // The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The // credentials should be a user/password pair. For more information, see Using a // Microsoft SharePoint Data Source @@ -1174,6 +1167,11 @@ type SharePointConfiguration struct { // This member is required. SecretArn *string + // The version of Microsoft SharePoint that you are using as a data source. + // + // This member is required. + SharePointVersion SharePointVersion + // The URLs of the Microsoft SharePoint site that contains the documents that // should be indexed. // @@ -1184,12 +1182,16 @@ type SharePointConfiguration struct { // site in the index; otherwise, FALSE. CrawlAttachments *bool - // Set to TRUE to use the Microsoft SharePoint change log to determine the - // documents that need to be updated in the index. Depending on the size of the - // SharePoint change log, it may take longer for Amazon Kendra to use the change - // log than it takes it to determine the changed documents using the Amazon Kendra - // document crawler. - UseChangeLog *bool + // The Microsoft SharePoint attribute field that contains the title of the + // document. + DocumentTitleFieldName *string + + // A list of regular expression patterns. Documents that match the patterns are + // excluded from the index. Documents that don't match the patterns are included in + // the index. If a document matches both an exclusion pattern and an inclusion + // pattern, the document is not included in the index. The regex is applied to the + // display URL of the SharePoint document. + ExclusionPatterns []*string // A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint // attributes to custom fields in the Amazon Kendra index. You must first create @@ -1198,24 +1200,22 @@ type SharePointConfiguration struct { // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). FieldMappings []*DataSourceToIndexFieldMapping - // The version of Microsoft SharePoint that you are using as a data source. - // - // This member is required. - SharePointVersion SharePointVersion - - // The Microsoft SharePoint attribute field that contains the title of the - // document. - DocumentTitleFieldName *string - - // Provides information for connecting to an Amazon VPC. - VpcConfiguration *DataSourceVpcConfiguration - // A list of regular expression patterns. Documents that match the patterns are // included in the index. Documents that don't match the patterns are excluded from // the index. If a document matches both an inclusion pattern and an exclusion // pattern, the document is not included in the index. The regex is applied to the // display URL of the SharePoint document. InclusionPatterns []*string + + // Set to TRUE to use the Microsoft SharePoint change log to determine the + // documents that need to be updated in the index. Depending on the size of the + // SharePoint change log, it may take longer for Amazon Kendra to use the change + // log than it takes it to determine the changed documents using the Amazon Kendra + // document crawler. + UseChangeLog *bool + + // Provides information for connecting to an Amazon VPC. + VpcConfiguration *DataSourceVpcConfiguration } // Specifies the document attribute to use to sort the response to a Amazon Kendra @@ -1223,12 +1223,6 @@ type SharePointConfiguration struct { // the Sortable flag set to true, otherwise Amazon Kendra returns an exception. type SortingConfiguration struct { - // The order that the results should be returned in. In case of ties, the relevance - // assigned to the result by Amazon Kendra is used as the tie-breaker. - // - // This member is required. - SortOrder SortOrder - // The name of the document attribute used to sort the response. You can use any // field that has the Sortable flag set to true. You can also sort by any of the // following built-in attributes: @@ -1246,6 +1240,12 @@ type SortingConfiguration struct { // // This member is required. DocumentAttributeKey *string + + // The order that the results should be returned in. In case of ties, the relevance + // assigned to the result by Amazon Kendra is used as the tie-breaker. + // + // This member is required. + SortOrder SortOrder } // Provides information that configures Amazon Kendra to use a SQL database. @@ -1267,31 +1267,31 @@ type SqlConfiguration struct { // following symbols: _ . : / = + - @. type Tag struct { - // The value associated with the tag. The value may be an empty string but it can't - // be null. - // - // This member is required. - Value *string - // The key for the tag. Keys are not case sensitive and must be unique for the // index, FAQ, or data source. // // This member is required. Key *string + + // The value associated with the tag. The value may be an empty string but it can't + // be null. + // + // This member is required. + Value *string } // Provides information about text documents indexed in an index. type TextDocumentStatistics struct { - // The number of text documents indexed. + // The total size, in bytes, of the indexed documents. // // This member is required. - IndexedTextDocumentsCount *int32 + IndexedTextBytes *int64 - // The total size, in bytes, of the indexed documents. + // The number of text documents indexed. // // This member is required. - IndexedTextBytes *int64 + IndexedTextDocumentsCount *int32 } // Provides text and information about where to highlight the text. @@ -1307,9 +1307,9 @@ type TextWithHighlights struct { // Provides a range of time. type TimeRange struct { - // The UNIX datetime of the beginning of the time range. - StartTime *time.Time - // The UNIX datetime of the end of the time range. EndTime *time.Time + + // The UNIX datetime of the beginning of the time range. + StartTime *time.Time } diff --git a/service/kinesis/api_op_DecreaseStreamRetentionPeriod.go b/service/kinesis/api_op_DecreaseStreamRetentionPeriod.go index ac0f780a122..b0100d0aa0a 100644 --- a/service/kinesis/api_op_DecreaseStreamRetentionPeriod.go +++ b/service/kinesis/api_op_DecreaseStreamRetentionPeriod.go @@ -62,16 +62,16 @@ func (c *Client) DecreaseStreamRetentionPeriod(ctx context.Context, params *Decr // Represents the input for DecreaseStreamRetentionPeriod (). type DecreaseStreamRetentionPeriodInput struct { - // The name of the stream to modify. - // - // This member is required. - StreamName *string - // The new retention period of the stream, in hours. Must be less than the current // retention period. // // This member is required. RetentionPeriodHours *int32 + + // The name of the stream to modify. + // + // This member is required. + StreamName *string } type DecreaseStreamRetentionPeriodOutput struct { diff --git a/service/kinesis/api_op_DeregisterStreamConsumer.go b/service/kinesis/api_op_DeregisterStreamConsumer.go index 2522dcb308a..b47b8cef81c 100644 --- a/service/kinesis/api_op_DeregisterStreamConsumer.go +++ b/service/kinesis/api_op_DeregisterStreamConsumer.go @@ -62,11 +62,6 @@ func (c *Client) DeregisterStreamConsumer(ctx context.Context, params *Deregiste type DeregisterStreamConsumerInput struct { - // The ARN of the Kinesis data stream that the consumer is registered with. For - // more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams). - StreamARN *string - // The ARN returned by Kinesis Data Streams when you registered the consumer. If // you don't know the ARN of the consumer that you want to deregister, you can use // the ListStreamConsumers operation to get a list of the descriptions of all the @@ -76,6 +71,11 @@ type DeregisterStreamConsumerInput struct { // The name that you gave to the consumer. ConsumerName *string + + // The ARN of the Kinesis data stream that the consumer is registered with. For + // more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams). + StreamARN *string } type DeregisterStreamConsumerOutput struct { diff --git a/service/kinesis/api_op_DescribeStream.go b/service/kinesis/api_op_DescribeStream.go index 5174da1ce45..fb8ce265834 100644 --- a/service/kinesis/api_op_DescribeStream.go +++ b/service/kinesis/api_op_DescribeStream.go @@ -71,17 +71,17 @@ func (c *Client) DescribeStream(ctx context.Context, params *DescribeStreamInput // Represents the input for DescribeStream. type DescribeStreamInput struct { - // The maximum number of shards to return in a single call. The default value is - // 100. If you specify a value greater than 100, at most 100 shards are returned. - Limit *int32 - - // The shard ID of the shard to start with. - ExclusiveStartShardId *string - // The name of the stream to describe. // // This member is required. StreamName *string + + // The shard ID of the shard to start with. + ExclusiveStartShardId *string + + // The maximum number of shards to return in a single call. The default value is + // 100. If you specify a value greater than 100, at most 100 shards are returned. + Limit *int32 } // Represents the output for DescribeStream. diff --git a/service/kinesis/api_op_DescribeStreamConsumer.go b/service/kinesis/api_op_DescribeStreamConsumer.go index 7ddc6ed2796..44bbb0ac01d 100644 --- a/service/kinesis/api_op_DescribeStreamConsumer.go +++ b/service/kinesis/api_op_DescribeStreamConsumer.go @@ -63,6 +63,9 @@ func (c *Client) DescribeStreamConsumer(ctx context.Context, params *DescribeStr type DescribeStreamConsumerInput struct { + // The ARN returned by Kinesis Data Streams when you registered the consumer. + ConsumerARN *string + // The name that you gave to the consumer. ConsumerName *string @@ -70,9 +73,6 @@ type DescribeStreamConsumerInput struct { // more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams). StreamARN *string - - // The ARN returned by Kinesis Data Streams when you registered the consumer. - ConsumerARN *string } type DescribeStreamConsumerOutput struct { diff --git a/service/kinesis/api_op_DisableEnhancedMonitoring.go b/service/kinesis/api_op_DisableEnhancedMonitoring.go index 2310f85528d..e27bf494349 100644 --- a/service/kinesis/api_op_DisableEnhancedMonitoring.go +++ b/service/kinesis/api_op_DisableEnhancedMonitoring.go @@ -58,11 +58,6 @@ func (c *Client) DisableEnhancedMonitoring(ctx context.Context, params *DisableE // Represents the input for DisableEnhancedMonitoring (). type DisableEnhancedMonitoringInput struct { - // The name of the Kinesis data stream for which to disable enhanced monitoring. - // - // This member is required. - StreamName *string - // List of shard-level metrics to disable. The following are the valid shard-level // metrics. The value "ALL" disables every metric. // @@ -92,15 +87,17 @@ type DisableEnhancedMonitoringInput struct { // // This member is required. ShardLevelMetrics []types.MetricsName + + // The name of the Kinesis data stream for which to disable enhanced monitoring. + // + // This member is required. + StreamName *string } // Represents the output for EnableEnhancedMonitoring () and // DisableEnhancedMonitoring (). type DisableEnhancedMonitoringOutput struct { - // The name of the Kinesis data stream. - StreamName *string - // Represents the current state of the metrics that are in the enhanced state // before the operation. CurrentShardLevelMetrics []types.MetricsName @@ -109,6 +106,9 @@ type DisableEnhancedMonitoringOutput struct { // the operation. DesiredShardLevelMetrics []types.MetricsName + // The name of the Kinesis data stream. + StreamName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kinesis/api_op_EnableEnhancedMonitoring.go b/service/kinesis/api_op_EnableEnhancedMonitoring.go index c8e42b790e3..55ae82c3e58 100644 --- a/service/kinesis/api_op_EnableEnhancedMonitoring.go +++ b/service/kinesis/api_op_EnableEnhancedMonitoring.go @@ -58,11 +58,6 @@ func (c *Client) EnableEnhancedMonitoring(ctx context.Context, params *EnableEnh // Represents the input for EnableEnhancedMonitoring (). type EnableEnhancedMonitoringInput struct { - // The name of the stream for which to enable enhanced monitoring. - // - // This member is required. - StreamName *string - // List of shard-level metrics to enable. The following are the valid shard-level // metrics. The value "ALL" enables every metric. // @@ -92,15 +87,17 @@ type EnableEnhancedMonitoringInput struct { // // This member is required. ShardLevelMetrics []types.MetricsName + + // The name of the stream for which to enable enhanced monitoring. + // + // This member is required. + StreamName *string } // Represents the output for EnableEnhancedMonitoring () and // DisableEnhancedMonitoring (). type EnableEnhancedMonitoringOutput struct { - // The name of the Kinesis data stream. - StreamName *string - // Represents the current state of the metrics that are in the enhanced state // before the operation. CurrentShardLevelMetrics []types.MetricsName @@ -109,6 +106,9 @@ type EnableEnhancedMonitoringOutput struct { // the operation. DesiredShardLevelMetrics []types.MetricsName + // The name of the Kinesis data stream. + StreamName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kinesis/api_op_GetRecords.go b/service/kinesis/api_op_GetRecords.go index 7a4ac8b79b8..da02c39cdbb 100644 --- a/service/kinesis/api_op_GetRecords.go +++ b/service/kinesis/api_op_GetRecords.go @@ -107,22 +107,27 @@ func (c *Client) GetRecords(ctx context.Context, params *GetRecordsInput, optFns // Represents the input for GetRecords (). type GetRecordsInput struct { - // The maximum number of records to return. Specify a value of up to 10,000. If you - // specify a value that is greater than 10,000, GetRecords () throws - // InvalidArgumentException. - Limit *int32 - // The position in the shard from which you want to start sequentially reading data // records. A shard iterator specifies this position using the sequence number of a // data record in the shard. // // This member is required. ShardIterator *string + + // The maximum number of records to return. Specify a value of up to 10,000. If you + // specify a value that is greater than 10,000, GetRecords () throws + // InvalidArgumentException. + Limit *int32 } // Represents the output for GetRecords (). type GetRecordsOutput struct { + // The data records retrieved from the shard. + // + // This member is required. + Records []*types.Record + // The number of milliseconds the GetRecords () response is from the tip of the // stream, indicating how far behind current time the consumer is. A value of zero // indicates that record processing is caught up, and there are no new records to @@ -134,11 +139,6 @@ type GetRecordsOutput struct { // does not return any more data. NextShardIterator *string - // The data records retrieved from the shard. - // - // This member is required. - Records []*types.Record - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kinesis/api_op_GetShardIterator.go b/service/kinesis/api_op_GetShardIterator.go index 4b54199fcad..93ee3c06a1c 100644 --- a/service/kinesis/api_op_GetShardIterator.go +++ b/service/kinesis/api_op_GetShardIterator.go @@ -89,10 +89,10 @@ func (c *Client) GetShardIterator(ctx context.Context, params *GetShardIteratorI // Represents the input for GetShardIterator. type GetShardIteratorInput struct { - // The name of the Amazon Kinesis data stream. + // The shard ID of the Kinesis Data Streams shard to get the iterator for. // // This member is required. - StreamName *string + ShardId *string // Determines how the shard iterator is used to start reading data records from the // shard. The following are the valid Amazon Kinesis shard iterator types: @@ -119,6 +119,15 @@ type GetShardIteratorInput struct { // This member is required. ShardIteratorType types.ShardIteratorType + // The name of the Amazon Kinesis data stream. + // + // This member is required. + StreamName *string + + // The sequence number of the data record in the shard from which to start reading. + // Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER. + StartingSequenceNumber *string + // The time stamp of the data record from which to start reading. Used with shard // iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision // in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. @@ -127,15 +136,6 @@ type GetShardIteratorInput struct { // horizon, the iterator returned is for the oldest untrimmed data record // (TRIM_HORIZON). Timestamp *time.Time - - // The shard ID of the Kinesis Data Streams shard to get the iterator for. - // - // This member is required. - ShardId *string - - // The sequence number of the data record in the shard from which to start reading. - // Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER. - StartingSequenceNumber *string } // Represents the output for GetShardIterator. diff --git a/service/kinesis/api_op_ListShards.go b/service/kinesis/api_op_ListShards.go index fe01e4d8352..02f7f1e5e06 100644 --- a/service/kinesis/api_op_ListShards.go +++ b/service/kinesis/api_op_ListShards.go @@ -63,6 +63,13 @@ func (c *Client) ListShards(ctx context.Context, params *ListShardsInput, optFns type ListShardsInput struct { + // Specify this parameter to indicate that you want to list the shards starting + // with the shard whose ID immediately follows ExclusiveStartShardId. If you don't + // specify this parameter, the default behavior is for ListShards to list the + // shards starting with the first one in the stream. You cannot specify this + // parameter if you specify NextToken. + ExclusiveStartShardId *string + // The maximum number of shards to return in a single call to ListShards. The // minimum value you can specify for this parameter is 1, and the maximum is 1,000, // which is also the default. When the number of shards to be listed is greater @@ -94,13 +101,6 @@ type ListShardsInput struct { // specify this parameter if you specify the NextToken parameter. StreamCreationTimestamp *time.Time - // Specify this parameter to indicate that you want to list the shards starting - // with the shard whose ID immediately follows ExclusiveStartShardId. If you don't - // specify this parameter, the default behavior is for ListShards to list the - // shards starting with the first one in the stream. You cannot specify this - // parameter if you specify NextToken. - ExclusiveStartShardId *string - // The name of the data stream whose shards you want to list. You cannot specify // this parameter if you specify the NextToken parameter. StreamName *string diff --git a/service/kinesis/api_op_ListStreamConsumers.go b/service/kinesis/api_op_ListStreamConsumers.go index 12af84f8a29..6b7624bc6db 100644 --- a/service/kinesis/api_op_ListStreamConsumers.go +++ b/service/kinesis/api_op_ListStreamConsumers.go @@ -60,12 +60,17 @@ func (c *Client) ListStreamConsumers(ctx context.Context, params *ListStreamCons type ListStreamConsumersInput struct { - // Specify this input parameter to distinguish data streams that have the same - // name. For example, if you create a data stream and then delete it, and you later - // create another data stream with the same name, you can use this input parameter - // to specify which of the two streams you want to list the consumers for. You - // can't specify this parameter if you specify the NextToken parameter. - StreamCreationTimestamp *time.Time + // The ARN of the Kinesis data stream for which you want to list the registered + // consumers. For more information, see Amazon Resource Names (ARNs) and AWS + // Service Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams). + // + // This member is required. + StreamARN *string + + // The maximum number of consumers that you want a single call of + // ListStreamConsumers to return. + MaxResults *int32 // When the number of consumers that are registered with the data stream is greater // than the default value for the MaxResults parameter, or if you explicitly @@ -86,21 +91,19 @@ type ListStreamConsumersInput struct { // ExpiredNextTokenException. NextToken *string - // The maximum number of consumers that you want a single call of - // ListStreamConsumers to return. - MaxResults *int32 - - // The ARN of the Kinesis data stream for which you want to list the registered - // consumers. For more information, see Amazon Resource Names (ARNs) and AWS - // Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams). - // - // This member is required. - StreamARN *string + // Specify this input parameter to distinguish data streams that have the same + // name. For example, if you create a data stream and then delete it, and you later + // create another data stream with the same name, you can use this input parameter + // to specify which of the two streams you want to list the consumers for. You + // can't specify this parameter if you specify the NextToken parameter. + StreamCreationTimestamp *time.Time } type ListStreamConsumersOutput struct { + // An array of JSON objects. Each object represents one registered consumer. + Consumers []*types.Consumer + // When the number of consumers that are registered with the data stream is greater // than the default value for the MaxResults parameter, or if you explicitly // specify a value for MaxResults that is less than the number of registered @@ -114,9 +117,6 @@ type ListStreamConsumersOutput struct { // call to ListStreamConsumers, you get ExpiredNextTokenException. NextToken *string - // An array of JSON objects. Each object represents one registered consumer. - Consumers []*types.Consumer - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kinesis/api_op_ListTagsForStream.go b/service/kinesis/api_op_ListTagsForStream.go index e04f391f774..640e0385e53 100644 --- a/service/kinesis/api_op_ListTagsForStream.go +++ b/service/kinesis/api_op_ListTagsForStream.go @@ -64,14 +64,14 @@ type ListTagsForStreamInput struct { // This member is required. StreamName *string + // The key to use as the starting point for the list of tags. If this parameter is + // set, ListTagsForStream gets all tags that occur after ExclusiveStartTagKey. + ExclusiveStartTagKey *string + // The number of tags to return. If this number is less than the total number of // tags associated with the stream, HasMoreTags is set to true. To list additional // tags, set ExclusiveStartTagKey to the last key in the response. Limit *int32 - - // The key to use as the starting point for the list of tags. If this parameter is - // set, ListTagsForStream gets all tags that occur after ExclusiveStartTagKey. - ExclusiveStartTagKey *string } // Represents the output for ListTagsForStream. diff --git a/service/kinesis/api_op_PutRecord.go b/service/kinesis/api_op_PutRecord.go index b4febf09854..c9ae7d4aae4 100644 --- a/service/kinesis/api_op_PutRecord.go +++ b/service/kinesis/api_op_PutRecord.go @@ -90,21 +90,13 @@ func (c *Client) PutRecord(ctx context.Context, params *PutRecordInput, optFns . // Represents the input for PutRecord. type PutRecordInput struct { - // Guarantees strictly increasing sequence numbers, for puts from the same client - // and to the same partition key. Usage: set the SequenceNumberForOrdering of - // record n to the sequence number of record n-1 (as returned in the result when - // putting record n-1). If this parameter is not set, records are coarsely ordered - // based on arrival time. - SequenceNumberForOrdering *string - - // The name of the stream to put the data record into. + // The data blob to put into the record, which is base64-encoded when the blob is + // serialized. When the data blob (the payload before base64-encoding) is added to + // the partition key size, the total size must not exceed the maximum record size + // (1 MB). // // This member is required. - StreamName *string - - // The hash value used to explicitly determine the shard the data record is - // assigned to by overriding the partition key hash. - ExplicitHashKey *string + Data []byte // Determines which shard in the stream the data record is assigned to. Partition // keys are Unicode strings with a maximum length limit of 256 characters for each @@ -118,18 +110,39 @@ type PutRecordInput struct { // This member is required. PartitionKey *string - // The data blob to put into the record, which is base64-encoded when the blob is - // serialized. When the data blob (the payload before base64-encoding) is added to - // the partition key size, the total size must not exceed the maximum record size - // (1 MB). + // The name of the stream to put the data record into. // // This member is required. - Data []byte + StreamName *string + + // The hash value used to explicitly determine the shard the data record is + // assigned to by overriding the partition key hash. + ExplicitHashKey *string + + // Guarantees strictly increasing sequence numbers, for puts from the same client + // and to the same partition key. Usage: set the SequenceNumberForOrdering of + // record n to the sequence number of record n-1 (as returned in the result when + // putting record n-1). If this parameter is not set, records are coarsely ordered + // based on arrival time. + SequenceNumberForOrdering *string } // Represents the output for PutRecord. type PutRecordOutput struct { + // The sequence number identifier that was assigned to the put data record. The + // sequence number for the record is unique across all records in the stream. A + // sequence number is the identifier associated with every record put into the + // stream. + // + // This member is required. + SequenceNumber *string + + // The shard ID of the shard where the data record was placed. + // + // This member is required. + ShardId *string + // The encryption type to use on the record. This parameter can be one of the // following values: // @@ -140,19 +153,6 @@ type PutRecordOutput struct { // customer-managed AWS KMS key. EncryptionType types.EncryptionType - // The shard ID of the shard where the data record was placed. - // - // This member is required. - ShardId *string - - // The sequence number identifier that was assigned to the put data record. The - // sequence number for the record is unique across all records in the stream. A - // sequence number is the identifier associated with every record put into the - // stream. - // - // This member is required. - SequenceNumber *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kinesis/api_op_PutRecords.go b/service/kinesis/api_op_PutRecords.go index 650a1575e38..35e2dcd45c5 100644 --- a/service/kinesis/api_op_PutRecords.go +++ b/service/kinesis/api_op_PutRecords.go @@ -106,20 +106,28 @@ func (c *Client) PutRecords(ctx context.Context, params *PutRecordsInput, optFns // A PutRecords request. type PutRecordsInput struct { - // The stream name associated with the request. + // The records associated with the request. // // This member is required. - StreamName *string + Records []*types.PutRecordsRequestEntry - // The records associated with the request. + // The stream name associated with the request. // // This member is required. - Records []*types.PutRecordsRequestEntry + StreamName *string } // PutRecords results. type PutRecordsOutput struct { + // An array of successfully and unsuccessfully processed record results, correlated + // with the request by natural ordering. A record that is successfully added to a + // stream includes SequenceNumber and ShardId in the result. A record that fails to + // be added to a stream includes ErrorCode and ErrorMessage in the result. + // + // This member is required. + Records []*types.PutRecordsResultEntry + // The encryption type used on the records. This parameter can be one of the // following values: // @@ -132,14 +140,6 @@ type PutRecordsOutput struct { // The number of unsuccessfully processed records in a PutRecords request. FailedRecordCount *int32 - // An array of successfully and unsuccessfully processed record results, correlated - // with the request by natural ordering. A record that is successfully added to a - // stream includes SequenceNumber and ShardId in the result. A record that fails to - // be added to a stream includes ErrorCode and ErrorMessage in the result. - // - // This member is required. - Records []*types.PutRecordsResultEntry - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kinesis/api_op_RegisterStreamConsumer.go b/service/kinesis/api_op_RegisterStreamConsumer.go index a0996d16399..1596e57ce9d 100644 --- a/service/kinesis/api_op_RegisterStreamConsumer.go +++ b/service/kinesis/api_op_RegisterStreamConsumer.go @@ -62,18 +62,18 @@ func (c *Client) RegisterStreamConsumer(ctx context.Context, params *RegisterStr type RegisterStreamConsumerInput struct { + // For a given Kinesis data stream, each consumer must have a unique name. However, + // consumer names don't have to be unique across data streams. + // + // This member is required. + ConsumerName *string + // The ARN of the Kinesis data stream that you want to register the consumer with. // For more info, see Amazon Resource Names (ARNs) and AWS Service Namespaces // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams). // // This member is required. StreamARN *string - - // For a given Kinesis data stream, each consumer must have a unique name. However, - // consumer names don't have to be unique across data streams. - // - // This member is required. - ConsumerName *string } type RegisterStreamConsumerOutput struct { diff --git a/service/kinesis/api_op_RemoveTagsFromStream.go b/service/kinesis/api_op_RemoveTagsFromStream.go index ee1e99a07a1..5d069a0098a 100644 --- a/service/kinesis/api_op_RemoveTagsFromStream.go +++ b/service/kinesis/api_op_RemoveTagsFromStream.go @@ -60,15 +60,15 @@ func (c *Client) RemoveTagsFromStream(ctx context.Context, params *RemoveTagsFro // Represents the input for RemoveTagsFromStream. type RemoveTagsFromStreamInput struct { - // A list of tag keys. Each corresponding tag is removed from the stream. + // The name of the stream. // // This member is required. - TagKeys []*string + StreamName *string - // The name of the stream. + // A list of tag keys. Each corresponding tag is removed from the stream. // // This member is required. - StreamName *string + TagKeys []*string } type RemoveTagsFromStreamOutput struct { diff --git a/service/kinesis/api_op_StartStreamEncryption.go b/service/kinesis/api_op_StartStreamEncryption.go index 3ff1ba93b97..7ecc823759e 100644 --- a/service/kinesis/api_op_StartStreamEncryption.go +++ b/service/kinesis/api_op_StartStreamEncryption.go @@ -70,6 +70,11 @@ func (c *Client) StartStreamEncryption(ctx context.Context, params *StartStreamE type StartStreamEncryptionInput struct { + // The encryption type to use. The only valid value is KMS. + // + // This member is required. + EncryptionType types.EncryptionType + // The GUID for the customer-managed AWS KMS key to use for encryption. This value // can be a globally unique identifier, a fully specified Amazon Resource Name // (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can @@ -94,11 +99,6 @@ type StartStreamEncryptionInput struct { // This member is required. KeyId *string - // The encryption type to use. The only valid value is KMS. - // - // This member is required. - EncryptionType types.EncryptionType - // The name of the stream for which to start encrypting records. // // This member is required. diff --git a/service/kinesis/api_op_StopStreamEncryption.go b/service/kinesis/api_op_StopStreamEncryption.go index 7586097f28f..379294aa94c 100644 --- a/service/kinesis/api_op_StopStreamEncryption.go +++ b/service/kinesis/api_op_StopStreamEncryption.go @@ -69,6 +69,11 @@ func (c *Client) StopStreamEncryption(ctx context.Context, params *StopStreamEnc type StopStreamEncryptionInput struct { + // The encryption type. The only valid value is KMS. + // + // This member is required. + EncryptionType types.EncryptionType + // The GUID for the customer-managed AWS KMS key to use for encryption. This value // can be a globally unique identifier, a fully specified Amazon Resource Name // (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can @@ -97,11 +102,6 @@ type StopStreamEncryptionInput struct { // // This member is required. StreamName *string - - // The encryption type. The only valid value is KMS. - // - // This member is required. - EncryptionType types.EncryptionType } type StopStreamEncryptionOutput struct { diff --git a/service/kinesis/api_op_UpdateShardCount.go b/service/kinesis/api_op_UpdateShardCount.go index 9391c8c3487..b5d722b0e0c 100644 --- a/service/kinesis/api_op_UpdateShardCount.go +++ b/service/kinesis/api_op_UpdateShardCount.go @@ -93,6 +93,11 @@ func (c *Client) UpdateShardCount(ctx context.Context, params *UpdateShardCountI type UpdateShardCountInput struct { + // The scaling type. Uniform scaling creates shards of equal size. + // + // This member is required. + ScalingType types.ScalingType + // The name of the stream. // // This member is required. @@ -102,11 +107,6 @@ type UpdateShardCountInput struct { // // This member is required. TargetShardCount *int32 - - // The scaling type. Uniform scaling creates shards of equal size. - // - // This member is required. - ScalingType types.ScalingType } type UpdateShardCountOutput struct { diff --git a/service/kinesis/go.mod b/service/kinesis/go.mod index d8cb7b959ac..905bab74e36 100644 --- a/service/kinesis/go.mod +++ b/service/kinesis/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/kinesis go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/kinesis/types/types.go b/service/kinesis/types/types.go index e313be62e25..58f3112062a 100644 --- a/service/kinesis/types/types.go +++ b/service/kinesis/types/types.go @@ -18,53 +18,53 @@ type Consumer struct { // This member is required. ConsumerARN *string - // A consumer can't read data while in the CREATING or DELETING states. + // // // This member is required. - ConsumerStatus ConsumerStatus + ConsumerCreationTimestamp *time.Time // The name of the consumer is something you choose when you register the consumer. // // This member is required. ConsumerName *string - // + // A consumer can't read data while in the CREATING or DELETING states. // // This member is required. - ConsumerCreationTimestamp *time.Time + ConsumerStatus ConsumerStatus } // An object that represents the details of a registered consumer. type ConsumerDescription struct { + // When you register a consumer, Kinesis Data Streams generates an ARN for it. You + // need this ARN to be able to call SubscribeToShard (). If you delete a consumer + // and then create a new one with the same name, it won't have the same ARN. That's + // because consumer ARNs contain the creation timestamp. This is important to keep + // in mind if you have IAM policies that reference consumer ARNs. + // + // This member is required. + ConsumerARN *string + // // // This member is required. ConsumerCreationTimestamp *time.Time - // The ARN of the stream with which you registered the consumer. + // The name of the consumer is something you choose when you register the consumer. // // This member is required. - StreamARN *string + ConsumerName *string // A consumer can't read data while in the CREATING or DELETING states. // // This member is required. ConsumerStatus ConsumerStatus - // When you register a consumer, Kinesis Data Streams generates an ARN for it. You - // need this ARN to be able to call SubscribeToShard (). If you delete a consumer - // and then create a new one with the same name, it won't have the same ARN. That's - // because consumer ARNs contain the creation timestamp. This is important to keep - // in mind if you have IAM policies that reference consumer ARNs. - // - // This member is required. - ConsumerARN *string - - // The name of the consumer is something you choose when you register the consumer. + // The ARN of the stream with which you registered the consumer. // // This member is required. - ConsumerName *string + StreamARN *string } // Represents enhanced metrics types. @@ -117,6 +117,14 @@ type HashKeyRange struct { // Represents the output for PutRecords. type PutRecordsRequestEntry struct { + // The data blob to put into the record, which is base64-encoded when the blob is + // serialized. When the data blob (the payload before base64-encoding) is added to + // the partition key size, the total size must not exceed the maximum record size + // (1 MB). + // + // This member is required. + Data []byte + // Determines which shard in the stream the data record is assigned to. Partition // keys are Unicode strings with a maximum length limit of 256 characters for each // key. Amazon Kinesis Data Streams uses the partition key as input to a hash @@ -129,14 +137,6 @@ type PutRecordsRequestEntry struct { // This member is required. PartitionKey *string - // The data blob to put into the record, which is base64-encoded when the blob is - // serialized. When the data blob (the payload before base64-encoding) is added to - // the partition key size, the total size must not exceed the maximum record size - // (1 MB). - // - // This member is required. - Data []byte - // The hash value used to determine explicitly the shard that the data record is // assigned to by overriding the partition key hash. ExplicitHashKey *string @@ -148,12 +148,6 @@ type PutRecordsRequestEntry struct { // ErrorCode and ErrorMessage in the result. type PutRecordsResultEntry struct { - // The shard ID for an individual record result. - ShardId *string - - // The sequence number for an individual record result. - SequenceNumber *string - // The error code for an individual record result. ErrorCodes can be either // ProvisionedThroughputExceededException or InternalFailure. ErrorCode *string @@ -163,17 +157,18 @@ type PutRecordsResultEntry struct { // account ID, stream name, and shard ID. An ErrorCode value of InternalFailure has // the error message "Internal Service Failure". ErrorMessage *string + + // The sequence number for an individual record result. + SequenceNumber *string + + // The shard ID for an individual record result. + ShardId *string } // The unit of data of the Kinesis data stream, which is composed of a sequence // number, a partition key, and a data blob. type Record struct { - // Identifies which shard in the stream the data record is assigned to. - // - // This member is required. - PartitionKey *string - // The data blob. The data in the blob is both opaque and immutable to Kinesis Data // Streams, which does not inspect, interpret, or change the data in the blob in // any way. When the data blob (the payload before base64-encoding) is added to the @@ -183,11 +178,19 @@ type Record struct { // This member is required. Data []byte + // Identifies which shard in the stream the data record is assigned to. + // + // This member is required. + PartitionKey *string + // The unique identifier of the record within its shard. // // This member is required. SequenceNumber *string + // The approximate time that the record was inserted into the stream. + ApproximateArrivalTimestamp *time.Time + // The encryption type used on the record. This parameter can be one of the // following values: // @@ -197,107 +200,92 @@ type Record struct { // KMS: Use server-side encryption on the records in the stream using a // customer-managed AWS KMS key. EncryptionType EncryptionType - - // The approximate time that the record was inserted into the stream. - ApproximateArrivalTimestamp *time.Time } // The range of possible sequence numbers for the shard. type SequenceNumberRange struct { - // The ending sequence number for the range. Shards that are in the OPEN state have - // an ending sequence number of null. - EndingSequenceNumber *string - // The starting sequence number for the range. // // This member is required. StartingSequenceNumber *string + + // The ending sequence number for the range. Shards that are in the OPEN state have + // an ending sequence number of null. + EndingSequenceNumber *string } // A uniquely identified group of data records in a Kinesis data stream. type Shard struct { - // The shard ID of the shard's parent. - ParentShardId *string - - // The shard ID of the shard adjacent to the shard's parent. - AdjacentParentShardId *string - - // The range of possible sequence numbers for the shard. - // - // This member is required. - SequenceNumberRange *SequenceNumberRange - // The range of possible hash key values for the shard, which is a set of ordered // contiguous positive integers. // // This member is required. HashKeyRange *HashKeyRange + // The range of possible sequence numbers for the shard. + // + // This member is required. + SequenceNumberRange *SequenceNumberRange + // The unique identifier of the shard within the stream. // // This member is required. ShardId *string + + // The shard ID of the shard adjacent to the shard's parent. + AdjacentParentShardId *string + + // The shard ID of the shard's parent. + ParentShardId *string } type StartingPosition struct { - SequenceNumber *string - Type ShardIteratorType + SequenceNumber *string + Timestamp *time.Time } // Represents the output for DescribeStream (). type StreamDescription struct { - // The server-side encryption type used on the stream. This parameter can be one of - // the following values: - // - // * NONE: Do not encrypt the records in the stream. - // + // Represents the current enhanced monitoring settings of the stream. // - // * KMS: Use server-side encryption on the records in the stream using a - // customer-managed AWS KMS key. - EncryptionType EncryptionType + // This member is required. + EnhancedMonitoring []*EnhancedMetrics - // The name of the stream being described. + // If set to true, more shards in the stream are available to describe. // // This member is required. - StreamName *string + HasMoreShards *bool - // The approximate time that the stream was created. + // The current retention period, in hours. // // This member is required. - StreamCreationTimestamp *time.Time + RetentionPeriodHours *int32 - // If set to true, more shards in the stream are available to describe. + // The shards that comprise the stream. // // This member is required. - HasMoreShards *bool + Shards []*Shard - // The GUID for the customer-managed AWS KMS key to use for encryption. This value - // can be a globally unique identifier, a fully specified ARN to either an alias or - // a key, or an alias name prefixed by "alias/".You can also use a master key owned - // by Kinesis Data Streams by specifying the alias aws/kinesis. - // - // * Key ARN - // example: - // arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 - // - // - // * Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName + // The Amazon Resource Name (ARN) for the stream being described. // - // * - // Globally unique key ID example: 12345678-1234-1234-1234-123456789012 + // This member is required. + StreamARN *string + + // The approximate time that the stream was created. // - // * - // Alias name example: alias/MyAliasName + // This member is required. + StreamCreationTimestamp *time.Time + + // The name of the stream being described. // - // * Master key owned by Kinesis Data - // Streams: alias/aws/kinesis - KeyId *string + // This member is required. + StreamName *string // The current status of the stream being described. The stream status is one of // the following states: @@ -320,29 +308,15 @@ type StreamDescription struct { // This member is required. StreamStatus StreamStatus - // The shards that comprise the stream. - // - // This member is required. - Shards []*Shard - - // The Amazon Resource Name (ARN) for the stream being described. + // The server-side encryption type used on the stream. This parameter can be one of + // the following values: // - // This member is required. - StreamARN *string - - // The current retention period, in hours. + // * NONE: Do not encrypt the records in the stream. // - // This member is required. - RetentionPeriodHours *int32 - - // Represents the current enhanced monitoring settings of the stream. // - // This member is required. - EnhancedMonitoring []*EnhancedMetrics -} - -// Represents the output for DescribeStreamSummary () -type StreamDescriptionSummary struct { + // * KMS: Use server-side encryption on the records in the stream using a + // customer-managed AWS KMS key. + EncryptionType EncryptionType // The GUID for the customer-managed AWS KMS key to use for encryption. This value // can be a globally unique identifier, a fully specified ARN to either an alias or @@ -354,10 +328,10 @@ type StreamDescriptionSummary struct { // arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 // // - // * Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName - // + // * Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName // - // * Globally unique key ID example: 12345678-1234-1234-1234-123456789012 + // * + // Globally unique key ID example: 12345678-1234-1234-1234-123456789012 // // * // Alias name example: alias/MyAliasName @@ -365,6 +339,40 @@ type StreamDescriptionSummary struct { // * Master key owned by Kinesis Data // Streams: alias/aws/kinesis KeyId *string +} + +// Represents the output for DescribeStreamSummary () +type StreamDescriptionSummary struct { + + // Represents the current enhanced monitoring settings of the stream. + // + // This member is required. + EnhancedMonitoring []*EnhancedMetrics + + // The number of open shards in the stream. + // + // This member is required. + OpenShardCount *int32 + + // The current retention period, in hours. + // + // This member is required. + RetentionPeriodHours *int32 + + // The Amazon Resource Name (ARN) for the stream being described. + // + // This member is required. + StreamARN *string + + // The approximate time that the stream was created. + // + // This member is required. + StreamCreationTimestamp *time.Time + + // The name of the stream being described. + // + // This member is required. + StreamName *string // The current status of the stream being described. The stream status is one of // the following states: @@ -387,20 +395,8 @@ type StreamDescriptionSummary struct { // This member is required. StreamStatus StreamStatus - // The Amazon Resource Name (ARN) for the stream being described. - // - // This member is required. - StreamARN *string - - // The current retention period, in hours. - // - // This member is required. - RetentionPeriodHours *int32 - - // Represents the current enhanced monitoring settings of the stream. - // - // This member is required. - EnhancedMonitoring []*EnhancedMetrics + // The number of enhanced fan-out consumers registered with the stream. + ConsumerCount *int32 // The encryption type used. This value is one of the following: // @@ -410,29 +406,38 @@ type StreamDescriptionSummary struct { // NONE EncryptionType EncryptionType - // The name of the stream being described. + // The GUID for the customer-managed AWS KMS key to use for encryption. This value + // can be a globally unique identifier, a fully specified ARN to either an alias or + // a key, or an alias name prefixed by "alias/".You can also use a master key owned + // by Kinesis Data Streams by specifying the alias aws/kinesis. // - // This member is required. - StreamName *string - - // The approximate time that the stream was created. + // * Key ARN + // example: + // arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 // - // This member is required. - StreamCreationTimestamp *time.Time - - // The number of enhanced fan-out consumers registered with the stream. - ConsumerCount *int32 - - // The number of open shards in the stream. // - // This member is required. - OpenShardCount *int32 + // * Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName + // + // + // * Globally unique key ID example: 12345678-1234-1234-1234-123456789012 + // + // * + // Alias name example: alias/MyAliasName + // + // * Master key owned by Kinesis Data + // Streams: alias/aws/kinesis + KeyId *string } // After you call SubscribeToShard (), Kinesis Data Streams sends events of this // type to your consumer. type SubscribeToShardEvent struct { + // Use this as StartingSequenceNumber in the next call to SubscribeToShard (). + // + // This member is required. + ContinuationSequenceNumber *string + // The number of milliseconds the read records are from the tip of the stream, // indicating how far behind current time the consumer is. A value of zero // indicates that record processing is caught up, and there are no new records to @@ -445,11 +450,6 @@ type SubscribeToShardEvent struct { // // This member is required. Records []*Record - - // Use this as StartingSequenceNumber in the next call to SubscribeToShard (). - // - // This member is required. - ContinuationSequenceNumber *string } type SubscribeToShardEventStream interface { diff --git a/service/kinesisanalytics/api_op_AddApplicationCloudWatchLoggingOption.go b/service/kinesisanalytics/api_op_AddApplicationCloudWatchLoggingOption.go index f8d243274c2..143335af834 100644 --- a/service/kinesisanalytics/api_op_AddApplicationCloudWatchLoggingOption.go +++ b/service/kinesisanalytics/api_op_AddApplicationCloudWatchLoggingOption.go @@ -69,17 +69,17 @@ type AddApplicationCloudWatchLoggingOptionInput struct { // This member is required. ApplicationName *string - // The version ID of the Kinesis Analytics application. - // - // This member is required. - CurrentApplicationVersionId *int64 - // Provides the CloudWatch log stream Amazon Resource Name (ARN) and the IAM role // ARN. Note: To write application messages to CloudWatch, the IAM role that is // used must have the PutLogEvents policy action enabled. // // This member is required. CloudWatchLoggingOption *types.CloudWatchLoggingOption + + // The version ID of the Kinesis Analytics application. + // + // This member is required. + CurrentApplicationVersionId *int64 } type AddApplicationCloudWatchLoggingOptionOutput struct { diff --git a/service/kinesisanalytics/api_op_AddApplicationInput.go b/service/kinesisanalytics/api_op_AddApplicationInput.go index dab10c9721d..e9d8d96c144 100644 --- a/service/kinesisanalytics/api_op_AddApplicationInput.go +++ b/service/kinesisanalytics/api_op_AddApplicationInput.go @@ -74,6 +74,12 @@ func (c *Client) AddApplicationInput(ctx context.Context, params *AddApplication // type AddApplicationInputInput struct { + // Name of your existing Amazon Kinesis Analytics application to which you want to + // add the streaming source. + // + // This member is required. + ApplicationName *string + // Current version of your Amazon Kinesis Analytics application. You can use the // DescribeApplication // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) @@ -82,12 +88,6 @@ type AddApplicationInputInput struct { // This member is required. CurrentApplicationVersionId *int64 - // Name of your existing Amazon Kinesis Analytics application to which you want to - // add the streaming source. - // - // This member is required. - ApplicationName *string - // The Input // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_Input.html) to add. // diff --git a/service/kinesisanalytics/api_op_AddApplicationInputProcessingConfiguration.go b/service/kinesisanalytics/api_op_AddApplicationInputProcessingConfiguration.go index 08b1bac6655..f7d9f3da0e2 100644 --- a/service/kinesisanalytics/api_op_AddApplicationInputProcessingConfiguration.go +++ b/service/kinesisanalytics/api_op_AddApplicationInputProcessingConfiguration.go @@ -64,6 +64,12 @@ func (c *Client) AddApplicationInputProcessingConfiguration(ctx context.Context, type AddApplicationInputProcessingConfigurationInput struct { + // Name of the application to which you want to add the input processing + // configuration. + // + // This member is required. + ApplicationName *string + // Version of the application to which you want to add the input processing // configuration. You can use the DescribeApplication // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) @@ -73,12 +79,6 @@ type AddApplicationInputProcessingConfigurationInput struct { // This member is required. CurrentApplicationVersionId *int64 - // Name of the application to which you want to add the input processing - // configuration. - // - // This member is required. - ApplicationName *string - // The ID of the input configuration to add the input processing configuration to. // You can get a list of the input IDs for an application using the // DescribeApplication diff --git a/service/kinesisanalytics/api_op_AddApplicationOutput.go b/service/kinesisanalytics/api_op_AddApplicationOutput.go index d0b6f690282..812d89f5506 100644 --- a/service/kinesisanalytics/api_op_AddApplicationOutput.go +++ b/service/kinesisanalytics/api_op_AddApplicationOutput.go @@ -81,6 +81,11 @@ func (c *Client) AddApplicationOutput(ctx context.Context, params *AddApplicatio // type AddApplicationOutputInput struct { + // Name of the application to which you want to add the output configuration. + // + // This member is required. + ApplicationName *string + // Version of the application to which you want to add the output configuration. // You can use the DescribeApplication // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) @@ -90,11 +95,6 @@ type AddApplicationOutputInput struct { // This member is required. CurrentApplicationVersionId *int64 - // Name of the application to which you want to add the output configuration. - // - // This member is required. - ApplicationName *string - // An array of objects, each describing one output configuration. In the output // configuration, you specify the name of an in-application stream, a destination // (that is, an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, diff --git a/service/kinesisanalytics/api_op_AddApplicationReferenceDataSource.go b/service/kinesisanalytics/api_op_AddApplicationReferenceDataSource.go index b749499f387..32a397c47e4 100644 --- a/service/kinesisanalytics/api_op_AddApplicationReferenceDataSource.go +++ b/service/kinesisanalytics/api_op_AddApplicationReferenceDataSource.go @@ -73,6 +73,11 @@ func (c *Client) AddApplicationReferenceDataSource(ctx context.Context, params * // type AddApplicationReferenceDataSourceInput struct { + // Name of an existing application. + // + // This member is required. + ApplicationName *string + // Version of the application for which you are adding the reference data source. // You can use the DescribeApplication // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) @@ -91,11 +96,6 @@ type AddApplicationReferenceDataSourceInput struct { // // This member is required. ReferenceDataSource *types.ReferenceDataSource - - // Name of an existing application. - // - // This member is required. - ApplicationName *string } // diff --git a/service/kinesisanalytics/api_op_CreateApplication.go b/service/kinesisanalytics/api_op_CreateApplication.go index 97e0108fc00..28f191de1dd 100644 --- a/service/kinesisanalytics/api_op_CreateApplication.go +++ b/service/kinesisanalytics/api_op_CreateApplication.go @@ -82,8 +82,10 @@ func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicatio // TBD type CreateApplicationInput struct { - // Summary description of the application. - ApplicationDescription *string + // Name of your Amazon Kinesis Analytics application (for example, sample-app). + // + // This member is required. + ApplicationName *string // One or more SQL statements that read input data, transform it, and generate // output. For example, you can write a SQL statement that reads data from one @@ -101,26 +103,8 @@ type CreateApplicationInput struct { // your application code must create these streams.

    ApplicationCode *string - // You can configure application output to write data from any of the - // in-application streams to up to three destinations. These destinations can be - // Amazon Kinesis streams, Amazon Kinesis Firehose delivery streams, AWS Lambda - // destinations, or any combination of the three. In the configuration, you specify - // the in-application stream name, the destination stream or Lambda function Amazon - // Resource Name (ARN), and the format to use when writing data. You must also - // provide an IAM role that Amazon Kinesis Analytics can assume to write to the - // destination stream or Lambda function on your behalf. In the output - // configuration, you also provide the output stream or Lambda function ARN. For - // stream destinations, you provide the format of data in the stream (for example, - // JSON, CSV). You also must provide an IAM role that Amazon Kinesis Analytics can - // assume to write to the stream or Lambda function on your behalf. - Outputs []*types.Output - - // A list of one or more tags to assign to the application. A tag is a key-value - // pair that identifies an application. Note that the maximum number of application - // tags includes system tags. The maximum number of user-defined application tags - // is 50. For more information, see Using Tagging - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html). - Tags []*types.Tag + // Summary description of the application. + ApplicationDescription *string // Use this parameter to configure a CloudWatch log stream to monitor application // configuration errors. For more information, see Working with Amazon CloudWatch @@ -128,11 +112,6 @@ type CreateApplicationInput struct { // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html). CloudWatchLoggingOptions []*types.CloudWatchLoggingOption - // Name of your Amazon Kinesis Analytics application (for example, sample-app). - // - // This member is required. - ApplicationName *string - // Use this parameter to configure the application input. You can configure your // application to receive input from a single streaming source. In this // configuration, you map this streaming source to an in-application stream that is @@ -146,6 +125,27 @@ type CreateApplicationInput struct { // necessary mapping of the data elements in the streaming source to record columns // in the in-app stream. Inputs []*types.Input + + // You can configure application output to write data from any of the + // in-application streams to up to three destinations. These destinations can be + // Amazon Kinesis streams, Amazon Kinesis Firehose delivery streams, AWS Lambda + // destinations, or any combination of the three. In the configuration, you specify + // the in-application stream name, the destination stream or Lambda function Amazon + // Resource Name (ARN), and the format to use when writing data. You must also + // provide an IAM role that Amazon Kinesis Analytics can assume to write to the + // destination stream or Lambda function on your behalf. In the output + // configuration, you also provide the output stream or Lambda function ARN. For + // stream destinations, you provide the format of data in the stream (for example, + // JSON, CSV). You also must provide an IAM role that Amazon Kinesis Analytics can + // assume to write to the stream or Lambda function on your behalf. + Outputs []*types.Output + + // A list of one or more tags to assign to the application. A tag is a key-value + // pair that identifies an application. Note that the maximum number of application + // tags includes system tags. The maximum number of user-defined application tags + // is 50. For more information, see Using Tagging + // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html). + Tags []*types.Tag } // TBD diff --git a/service/kinesisanalytics/api_op_DeleteApplication.go b/service/kinesisanalytics/api_op_DeleteApplication.go index dcf7f2053d8..5f561eee1ae 100644 --- a/service/kinesisanalytics/api_op_DeleteApplication.go +++ b/service/kinesisanalytics/api_op_DeleteApplication.go @@ -65,15 +65,15 @@ func (c *Client) DeleteApplication(ctx context.Context, params *DeleteApplicatio // type DeleteApplicationInput struct { - // You can use the DescribeApplication operation to get this value. + // Name of the Amazon Kinesis Analytics application to delete. // // This member is required. - CreateTimestamp *time.Time + ApplicationName *string - // Name of the Amazon Kinesis Analytics application to delete. + // You can use the DescribeApplication operation to get this value. // // This member is required. - ApplicationName *string + CreateTimestamp *time.Time } // diff --git a/service/kinesisanalytics/api_op_DeleteApplicationCloudWatchLoggingOption.go b/service/kinesisanalytics/api_op_DeleteApplicationCloudWatchLoggingOption.go index 11fb5f79da1..5aba89edb2b 100644 --- a/service/kinesisanalytics/api_op_DeleteApplicationCloudWatchLoggingOption.go +++ b/service/kinesisanalytics/api_op_DeleteApplicationCloudWatchLoggingOption.go @@ -62,11 +62,6 @@ func (c *Client) DeleteApplicationCloudWatchLoggingOption(ctx context.Context, p type DeleteApplicationCloudWatchLoggingOptionInput struct { - // The version ID of the Kinesis Analytics application. - // - // This member is required. - CurrentApplicationVersionId *int64 - // The Kinesis Analytics application name. // // This member is required. @@ -79,6 +74,11 @@ type DeleteApplicationCloudWatchLoggingOptionInput struct { // // This member is required. CloudWatchLoggingOptionId *string + + // The version ID of the Kinesis Analytics application. + // + // This member is required. + CurrentApplicationVersionId *int64 } type DeleteApplicationCloudWatchLoggingOptionOutput struct { diff --git a/service/kinesisanalytics/api_op_DeleteApplicationOutput.go b/service/kinesisanalytics/api_op_DeleteApplicationOutput.go index 100876f3df5..d823ac2abb3 100644 --- a/service/kinesisanalytics/api_op_DeleteApplicationOutput.go +++ b/service/kinesisanalytics/api_op_DeleteApplicationOutput.go @@ -64,6 +64,11 @@ func (c *Client) DeleteApplicationOutput(ctx context.Context, params *DeleteAppl // type DeleteApplicationOutputInput struct { + // Amazon Kinesis Analytics application name. + // + // This member is required. + ApplicationName *string + // Amazon Kinesis Analytics application version. You can use the // DescribeApplication // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) @@ -73,11 +78,6 @@ type DeleteApplicationOutputInput struct { // This member is required. CurrentApplicationVersionId *int64 - // Amazon Kinesis Analytics application name. - // - // This member is required. - ApplicationName *string - // The ID of the configuration to delete. Each output configuration that is added // to the application, either when the application is created or later using the // AddApplicationOutput diff --git a/service/kinesisanalytics/api_op_DeleteApplicationReferenceDataSource.go b/service/kinesisanalytics/api_op_DeleteApplicationReferenceDataSource.go index bbb93181665..2dab95f68d5 100644 --- a/service/kinesisanalytics/api_op_DeleteApplicationReferenceDataSource.go +++ b/service/kinesisanalytics/api_op_DeleteApplicationReferenceDataSource.go @@ -70,6 +70,14 @@ type DeleteApplicationReferenceDataSourceInput struct { // This member is required. ApplicationName *string + // Version of the application. You can use the DescribeApplication + // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) + // operation to get the current application version. If the version specified is + // not the current version, the ConcurrentModificationException is returned. + // + // This member is required. + CurrentApplicationVersionId *int64 + // ID of the reference data source. When you add a reference data source to your // application using the AddApplicationReferenceDataSource // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html), @@ -79,14 +87,6 @@ type DeleteApplicationReferenceDataSourceInput struct { // // This member is required. ReferenceId *string - - // Version of the application. You can use the DescribeApplication - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) - // operation to get the current application version. If the version specified is - // not the current version, the ConcurrentModificationException is returned. - // - // This member is required. - CurrentApplicationVersionId *int64 } type DeleteApplicationReferenceDataSourceOutput struct { diff --git a/service/kinesisanalytics/api_op_DiscoverInputSchema.go b/service/kinesisanalytics/api_op_DiscoverInputSchema.go index f616756c746..3ca1ba4a31c 100644 --- a/service/kinesisanalytics/api_op_DiscoverInputSchema.go +++ b/service/kinesisanalytics/api_op_DiscoverInputSchema.go @@ -71,10 +71,6 @@ func (c *Client) DiscoverInputSchema(ctx context.Context, params *DiscoverInputS type DiscoverInputSchemaInput struct { - // ARN of the IAM role that Amazon Kinesis Analytics can assume to access the - // stream on your behalf. - RoleARN *string - // The InputProcessingConfiguration // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) // to use to preprocess the records before discovering the schema of the records. @@ -84,16 +80,25 @@ type DiscoverInputSchemaInput struct { // the specified streaming source discovery purposes. InputStartingPositionConfiguration *types.InputStartingPositionConfiguration - // Specify this parameter to discover a schema from data in an Amazon S3 object. - S3Configuration *types.S3Configuration - // Amazon Resource Name (ARN) of the streaming source. ResourceARN *string + + // ARN of the IAM role that Amazon Kinesis Analytics can assume to access the + // stream on your behalf. + RoleARN *string + + // Specify this parameter to discover a schema from data in an Amazon S3 object. + S3Configuration *types.S3Configuration } // type DiscoverInputSchemaOutput struct { + // Schema inferred from the streaming source. It identifies the format of the data + // in the streaming source and how each data element maps to corresponding columns + // in the in-application stream that you can create. + InputSchema *types.SourceSchema + // An array of elements, where each element corresponds to a row in a stream record // (a stream record can have more than one row). ParsedInputRecords [][]*string @@ -102,11 +107,6 @@ type DiscoverInputSchemaOutput struct { // InputProcessingConfiguration parameter. ProcessedInputRecords []*string - // Schema inferred from the streaming source. It identifies the format of the data - // in the streaming source and how each data element maps to corresponding columns - // in the in-application stream that you can create. - InputSchema *types.SourceSchema - // Raw stream data that was sampled to infer the schema. RawInputRecords []*string diff --git a/service/kinesisanalytics/api_op_ListApplications.go b/service/kinesisanalytics/api_op_ListApplications.go index 8966c741689..f14e866b4aa 100644 --- a/service/kinesisanalytics/api_op_ListApplications.go +++ b/service/kinesisanalytics/api_op_ListApplications.go @@ -70,14 +70,14 @@ func (c *Client) ListApplications(ctx context.Context, params *ListApplicationsI // type ListApplicationsInput struct { - // Maximum number of applications to list. - Limit *int32 - // Name of the application to start the list with. When using pagination to // retrieve the list, you don't need to specify this parameter in the first // request. However, in subsequent requests, you add the last application name from // the previous response to get the next page of applications. ExclusiveStartApplicationName *string + + // Maximum number of applications to list. + Limit *int32 } // diff --git a/service/kinesisanalytics/api_op_StartApplication.go b/service/kinesisanalytics/api_op_StartApplication.go index 2b5239409ed..38aa2af2396 100644 --- a/service/kinesisanalytics/api_op_StartApplication.go +++ b/service/kinesisanalytics/api_op_StartApplication.go @@ -73,6 +73,11 @@ func (c *Client) StartApplication(ctx context.Context, params *StartApplicationI // type StartApplicationInput struct { + // Name of the application. + // + // This member is required. + ApplicationName *string + // Identifies the specific input, by ID, that the application starts consuming. // Amazon Kinesis Analytics starts reading the streaming source associated with the // input. You can also specify where in the streaming source you want Amazon @@ -80,11 +85,6 @@ type StartApplicationInput struct { // // This member is required. InputConfigurations []*types.InputConfiguration - - // Name of the application. - // - // This member is required. - ApplicationName *string } // diff --git a/service/kinesisanalytics/api_op_UntagResource.go b/service/kinesisanalytics/api_op_UntagResource.go index 01ddfaf4df7..553e79d2e80 100644 --- a/service/kinesisanalytics/api_op_UntagResource.go +++ b/service/kinesisanalytics/api_op_UntagResource.go @@ -58,15 +58,15 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // A list of keys of tags to remove from the specified application. + // The ARN of the Kinesis Analytics application from which to remove the tags. // // This member is required. - TagKeys []*string + ResourceARN *string - // The ARN of the Kinesis Analytics application from which to remove the tags. + // A list of keys of tags to remove from the specified application. // // This member is required. - ResourceARN *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/kinesisanalytics/go.mod b/service/kinesisanalytics/go.mod index f5933099e22..b80500f740b 100644 --- a/service/kinesisanalytics/go.mod +++ b/service/kinesisanalytics/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/kinesisanalytics go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/kinesisanalytics/types/types.go b/service/kinesisanalytics/types/types.go index 4f115252f3b..e3eade7cc7d 100644 --- a/service/kinesisanalytics/types/types.go +++ b/service/kinesisanalytics/types/types.go @@ -14,32 +14,25 @@ import ( // and input and output configuration. type ApplicationDetail struct { - // Describes the application input configuration. For more information, see - // Configuring Application Input - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). - //

    - InputDescriptions []*InputDescription + // ARN of the application. + // + // This member is required. + ApplicationARN *string // Name of the application. // // This member is required. ApplicationName *string - // Time stamp when the application version was created. - CreateTimestamp *time.Time - - // Provides the current application version. + // Status of the application. // // This member is required. - ApplicationVersionId *int64 - - // Time stamp when the application was last updated. - LastUpdateTimestamp *time.Time + ApplicationStatus ApplicationStatus - // Status of the application. + // Provides the current application version. // // This member is required. - ApplicationStatus ApplicationStatus + ApplicationVersionId *int64 // Returns the application code that you provided to perform data analysis on any // of the in-application streams in your application. @@ -48,28 +41,35 @@ type ApplicationDetail struct { // Description of the application. ApplicationDescription *string - // Describes reference data sources configured for the application. For more - // information, see Configuring - // Application Input.

    - ReferenceDataSourceDescriptions []*ReferenceDataSourceDescription - - // ARN of the application. - // - // This member is required. - ApplicationARN *string - // Describes the CloudWatch log streams that are configured to receive application // messages. For more information about using CloudWatch log streams with Amazon // Kinesis Analytics applications, see Working with Amazon CloudWatch Logs // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html). CloudWatchLoggingOptionDescriptions []*CloudWatchLoggingOptionDescription + // Time stamp when the application version was created. + CreateTimestamp *time.Time + + // Describes the application input configuration. For more information, see + // Configuring Application Input + // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). + //

    + InputDescriptions []*InputDescription + + // Time stamp when the application was last updated. + LastUpdateTimestamp *time.Time + // Describes the application output configuration. For more information, see // Configuring Application Output // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html). //

    OutputDescriptions []*OutputDescription + + // Describes reference data sources configured for the application. For more + // information, see Configuring + // Application Input.

    + ReferenceDataSourceDescriptions []*ReferenceDataSourceDescription } // This documentation is for version 1 of the Amazon Kinesis Data Analytics API, @@ -84,34 +84,34 @@ type ApplicationSummary struct { // This member is required. ApplicationARN *string - // Status of the application. + // Name of the application. // // This member is required. - ApplicationStatus ApplicationStatus + ApplicationName *string - // Name of the application. + // Status of the application. // // This member is required. - ApplicationName *string + ApplicationStatus ApplicationStatus } // Describes updates to apply to an existing Amazon Kinesis Analytics application. type ApplicationUpdate struct { - // Describes application input configuration updates. - InputUpdates []*InputUpdate - // Describes application code updates. ApplicationCodeUpdate *string // Describes application CloudWatch logging option updates. CloudWatchLoggingOptionUpdates []*CloudWatchLoggingOptionUpdate - // Describes application reference data source updates. - ReferenceDataSourceUpdates []*ReferenceDataSourceUpdate + // Describes application input configuration updates. + InputUpdates []*InputUpdate // Describes application output configuration updates. OutputUpdates []*OutputUpdate + + // Describes application reference data source updates. + ReferenceDataSourceUpdates []*ReferenceDataSourceUpdate } // Provides a description of CloudWatch logging options, including the log stream @@ -139,32 +139,32 @@ type CloudWatchLoggingOptionDescription struct { // This member is required. LogStreamARN *string - // ID of the CloudWatch logging option description. - CloudWatchLoggingOptionId *string - // IAM ARN of the role to use to send application messages. Note: To write // application messages to CloudWatch, the IAM role used must have the PutLogEvents // policy action enabled. // // This member is required. RoleARN *string + + // ID of the CloudWatch logging option description. + CloudWatchLoggingOptionId *string } // Describes CloudWatch logging option updates. type CloudWatchLoggingOptionUpdate struct { - // IAM ARN of the role to use to send application messages. Note: To write - // application messages to CloudWatch, the IAM role used must have the PutLogEvents - // policy action enabled. - RoleARNUpdate *string - - // ARN of the CloudWatch log to receive application messages. - LogStreamARNUpdate *string - // ID of the CloudWatch logging option to update // // This member is required. CloudWatchLoggingOptionId *string + + // ARN of the CloudWatch log to receive application messages. + LogStreamARNUpdate *string + + // IAM ARN of the role to use to send application messages. Note: To write + // application messages to CloudWatch, the IAM role used must have the PutLogEvents + // policy action enabled. + RoleARNUpdate *string } // Provides additional mapping information when the record format uses delimiters, @@ -204,17 +204,12 @@ type DestinationSchema struct { // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). type Input struct { - // Describes the number of in-application streams to create. Data from your source - // is routed to these in-application input streams. (see Configuring Application - // Input - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). - InputParallelism *InputParallelism - - // If the streaming source is an Amazon Kinesis stream, identifies the stream's - // Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics - // to access the stream on your behalf. Note: Either KinesisStreamsInput or - // KinesisFirehoseInput is required. - KinesisStreamsInput *KinesisStreamsInput + // Describes the format of the data in the streaming source, and how each data + // element maps to corresponding columns in the in-application stream that is being + // created. Also used to describe the format of the reference data source. + // + // This member is required. + InputSchema *SourceSchema // Name prefix to use when creating an in-application stream. Suppose that you // specify a prefix "MyInApplicationStream." Amazon Kinesis Analytics then creates @@ -225,18 +220,11 @@ type Input struct { // This member is required. NamePrefix *string - // If the streaming source is an Amazon Kinesis Firehose delivery stream, - // identifies the delivery stream's ARN and an IAM role that enables Amazon Kinesis - // Analytics to access the stream on your behalf. Note: Either KinesisStreamsInput - // or KinesisFirehoseInput is required. - KinesisFirehoseInput *KinesisFirehoseInput - - // Describes the format of the data in the streaming source, and how each data - // element maps to corresponding columns in the in-application stream that is being - // created. Also used to describe the format of the reference data source. - // - // This member is required. - InputSchema *SourceSchema + // Describes the number of in-application streams to create. Data from your source + // is routed to these in-application input streams. (see Configuring Application + // Input + // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). + InputParallelism *InputParallelism // The InputProcessingConfiguration // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) @@ -245,6 +233,18 @@ type Input struct { // input processing configuration available is InputLambdaProcessor // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html). InputProcessingConfiguration *InputProcessingConfiguration + + // If the streaming source is an Amazon Kinesis Firehose delivery stream, + // identifies the delivery stream's ARN and an IAM role that enables Amazon Kinesis + // Analytics to access the stream on your behalf. Note: Either KinesisStreamsInput + // or KinesisFirehoseInput is required. + KinesisFirehoseInput *KinesisFirehoseInput + + // If the streaming source is an Amazon Kinesis stream, identifies the stream's + // Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics + // to access the stream on your behalf. Note: Either KinesisStreamsInput or + // KinesisFirehoseInput is required. + KinesisStreamsInput *KinesisStreamsInput } // When you start your application, you provide this configuration, which @@ -271,24 +271,17 @@ type InputConfiguration struct { // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). type InputDescription struct { - // If an Amazon Kinesis stream is configured as streaming source, provides Amazon - // Kinesis stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon - // Kinesis Analytics to access the stream on your behalf. - KinesisStreamsInputDescription *KinesisStreamsInputDescription - - // Point at which the application is configured to read from the input stream. - InputStartingPositionConfiguration *InputStartingPositionConfiguration - - // If an Amazon Kinesis Firehose delivery stream is configured as a streaming - // source, provides the delivery stream's ARN and an IAM role that enables Amazon - // Kinesis Analytics to access the stream on your behalf. - KinesisFirehoseInputDescription *KinesisFirehoseInputDescription - // Returns the in-application stream names that are mapped to the stream source. InAppStreamNames []*string - // In-application name prefix. - NamePrefix *string + // Input ID associated with the application input. This is the ID that Amazon + // Kinesis Analytics assigns to each input configuration you add to your + // application. + InputId *string + + // Describes the configured parallelism (number of in-application streams mapped to + // the streaming source). + InputParallelism *InputParallelism // The description of the preprocessor that executes on records in this input // before the application's code is run. @@ -299,14 +292,21 @@ type InputDescription struct { // created. InputSchema *SourceSchema - // Input ID associated with the application input. This is the ID that Amazon - // Kinesis Analytics assigns to each input configuration you add to your - // application. - InputId *string + // Point at which the application is configured to read from the input stream. + InputStartingPositionConfiguration *InputStartingPositionConfiguration - // Describes the configured parallelism (number of in-application streams mapped to - // the streaming source). - InputParallelism *InputParallelism + // If an Amazon Kinesis Firehose delivery stream is configured as a streaming + // source, provides the delivery stream's ARN and an IAM role that enables Amazon + // Kinesis Analytics to access the stream on your behalf. + KinesisFirehoseInputDescription *KinesisFirehoseInputDescription + + // If an Amazon Kinesis stream is configured as streaming source, provides Amazon + // Kinesis stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon + // Kinesis Analytics to access the stream on your behalf. + KinesisStreamsInputDescription *KinesisStreamsInputDescription + + // In-application name prefix. + NamePrefix *string } // An object that contains the Amazon Resource Name (ARN) of the AWS Lambda @@ -349,15 +349,15 @@ type InputLambdaProcessorDescription struct { // that is used to preprocess the records in the stream. type InputLambdaProcessorUpdate struct { - // The ARN of the new IAM role that is used to access the AWS Lambda function. - RoleARNUpdate *string - // The Amazon Resource Name (ARN) of the new AWS Lambda // (https://docs.aws.amazon.com/lambda/) function that is used to preprocess the // records in the stream. To specify an earlier version of the Lambda function than // the latest, include the Lambda function version in the Lambda function ARN. For // more information about Lambda ARNs, see Example ARNs: AWS Lambda () ResourceARNUpdate *string + + // The ARN of the new IAM role that is used to access the AWS Lambda function. + RoleARNUpdate *string } // Describes the number of in-application streams to create for a given streaming @@ -415,17 +415,17 @@ type InputProcessingConfigurationUpdate struct { // Describes updates for the application's input schema. type InputSchemaUpdate struct { + // A list of RecordColumn objects. Each object describes the mapping of the + // streaming source element to the corresponding column in the in-application + // stream. + RecordColumnUpdates []*RecordColumn + // Specifies the encoding of the records in the streaming source. For example, // UTF-8. RecordEncodingUpdate *string // Specifies the format of the records on the streaming source. RecordFormatUpdate *RecordFormat - - // A list of RecordColumn objects. Each object describes the mapping of the - // streaming source element to the corresponding column in the in-application - // stream. - RecordColumnUpdates []*RecordColumn } // Describes the point at which the application reads from the streaming source. @@ -447,18 +447,14 @@ type InputStartingPositionConfiguration struct { // of an application). type InputUpdate struct { - // Name prefix for in-application streams that Amazon Kinesis Analytics creates for - // the specific streaming source. - NamePrefixUpdate *string - // Input ID of the application input to be updated. // // This member is required. InputId *string - // If an Amazon Kinesis stream is the streaming source to be updated, provides an - // updated stream Amazon Resource Name (ARN) and IAM role ARN. - KinesisStreamsInputUpdate *KinesisStreamsInputUpdate + // Describes the parallelism updates (the number in-application streams Amazon + // Kinesis Analytics creates for the specific streaming source). + InputParallelismUpdate *InputParallelismUpdate // Describes updates for an input processing configuration. InputProcessingConfigurationUpdate *InputProcessingConfigurationUpdate @@ -472,9 +468,13 @@ type InputUpdate struct { // updated, provides an updated stream ARN and IAM role ARN. KinesisFirehoseInputUpdate *KinesisFirehoseInputUpdate - // Describes the parallelism updates (the number in-application streams Amazon - // Kinesis Analytics creates for the specific streaming source). - InputParallelismUpdate *InputParallelismUpdate + // If an Amazon Kinesis stream is the streaming source to be updated, provides an + // updated stream Amazon Resource Name (ARN) and IAM role ARN. + KinesisStreamsInputUpdate *KinesisStreamsInputUpdate + + // Name prefix for in-application streams that Amazon Kinesis Analytics creates for + // the specific streaming source. + NamePrefixUpdate *string } // Provides additional mapping information when JSON is the record format on the @@ -535,29 +535,29 @@ type KinesisFirehoseInputUpdate struct { // stream on your behalf. type KinesisFirehoseOutput struct { + // ARN of the destination Amazon Kinesis Firehose delivery stream to write to. + // + // This member is required. + ResourceARN *string + // ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the // destination stream on your behalf. You need to grant the necessary permissions // to this role. // // This member is required. RoleARN *string - - // ARN of the destination Amazon Kinesis Firehose delivery stream to write to. - // - // This member is required. - ResourceARN *string } // For an application output, describes the Amazon Kinesis Firehose delivery stream // configured as its destination. type KinesisFirehoseOutputDescription struct { + // Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream. + ResourceARN *string + // ARN of the IAM role that Amazon Kinesis Analytics can assume to access the // stream. RoleARN *string - - // Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream. - ResourceARN *string } // When updating an output configuration using the UpdateApplication @@ -580,40 +580,40 @@ type KinesisFirehoseOutputUpdate struct { // Kinesis Analytics to access the stream on your behalf. type KinesisStreamsInput struct { - // ARN of the IAM role that Amazon Kinesis Analytics can assume to access the - // stream on your behalf. You need to grant the necessary permissions to this role. + // ARN of the input Amazon Kinesis stream to read. // // This member is required. - RoleARN *string + ResourceARN *string - // ARN of the input Amazon Kinesis stream to read. + // ARN of the IAM role that Amazon Kinesis Analytics can assume to access the + // stream on your behalf. You need to grant the necessary permissions to this role. // // This member is required. - ResourceARN *string + RoleARN *string } // Describes the Amazon Kinesis stream that is configured as the streaming source // in the application input configuration. type KinesisStreamsInputDescription struct { + // Amazon Resource Name (ARN) of the Amazon Kinesis stream. + ResourceARN *string + // ARN of the IAM role that Amazon Kinesis Analytics can assume to access the // stream. RoleARN *string - - // Amazon Resource Name (ARN) of the Amazon Kinesis stream. - ResourceARN *string } // When updating application input configuration, provides information about an // Amazon Kinesis stream as the streaming source. type KinesisStreamsInputUpdate struct { + // Amazon Resource Name (ARN) of the input Amazon Kinesis stream to read. + ResourceARNUpdate *string + // ARN of the IAM role that Amazon Kinesis Analytics can assume to access the // stream on your behalf. You need to grant the necessary permissions to this role. RoleARNUpdate *string - - // Amazon Resource Name (ARN) of the input Amazon Kinesis stream to read. - ResourceARNUpdate *string } // When configuring application output, identifies an Amazon Kinesis stream as the @@ -639,12 +639,12 @@ type KinesisStreamsOutput struct { // destination. type KinesisStreamsOutputDescription struct { + // Amazon Resource Name (ARN) of the Amazon Kinesis stream. + ResourceARN *string + // ARN of the IAM role that Amazon Kinesis Analytics can assume to access the // stream. RoleARN *string - - // Amazon Resource Name (ARN) of the Amazon Kinesis stream. - ResourceARN *string } // When updating an output configuration using the UpdateApplication @@ -668,13 +668,6 @@ type KinesisStreamsOutputUpdate struct { // behalf. type LambdaOutput struct { - // ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the - // destination function on your behalf. You need to grant the necessary permissions - // to this role. - // - // This member is required. - RoleARN *string - // Amazon Resource Name (ARN) of the destination Lambda function to write to. To // specify an earlier version of the Lambda function than the latest, include the // Lambda function version in the Lambda function ARN. For more information about @@ -682,6 +675,13 @@ type LambdaOutput struct { // // This member is required. ResourceARN *string + + // ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the + // destination function on your behalf. You need to grant the necessary permissions + // to this role. + // + // This member is required. + RoleARN *string } // For an application output, describes the AWS Lambda function configured as its @@ -720,13 +720,13 @@ type LambdaOutputUpdate struct { // streaming source. type MappingParameters struct { - // Provides additional mapping information when JSON is the record format on the - // streaming source. - JSONMappingParameters *JSONMappingParameters - // Provides additional mapping information when the record format uses delimiters // (for example, CSV). CSVMappingParameters *CSVMappingParameters + + // Provides additional mapping information when JSON is the record format on the + // streaming source. + JSONMappingParameters *JSONMappingParameters } // Describes application output configuration in which you identify an @@ -738,6 +738,13 @@ type MappingParameters struct { //

    type Output struct { + // Describes the data format when records are written to the destination. For more + // information, see Configuring Application Output + // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html). + // + // This member is required. + DestinationSchema *DestinationSchema + // Name of the in-application stream. // // This member is required. @@ -746,18 +753,11 @@ type Output struct { // Identifies an Amazon Kinesis Firehose delivery stream as the destination. KinesisFirehoseOutput *KinesisFirehoseOutput - // Identifies an AWS Lambda function as the destination. - LambdaOutput *LambdaOutput - // Identifies an Amazon Kinesis stream as the destination. KinesisStreamsOutput *KinesisStreamsOutput - // Describes the data format when records are written to the destination. For more - // information, see Configuring Application Output - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html). - // - // This member is required. - DestinationSchema *DestinationSchema + // Identifies an AWS Lambda function as the destination. + LambdaOutput *LambdaOutput } // Describes the application output configuration, which includes the @@ -766,54 +766,54 @@ type Output struct { // delivery stream. type OutputDescription struct { + // Data format used for writing data to the destination. + DestinationSchema *DestinationSchema + // Describes the Amazon Kinesis Firehose delivery stream configured as the // destination where output is written. KinesisFirehoseOutputDescription *KinesisFirehoseOutputDescription - // Name of the in-application stream configured as output. - Name *string + // Describes Amazon Kinesis stream configured as the destination where output is + // written. + KinesisStreamsOutputDescription *KinesisStreamsOutputDescription // Describes the AWS Lambda function configured as the destination where output is // written. LambdaOutputDescription *LambdaOutputDescription - // Data format used for writing data to the destination. - DestinationSchema *DestinationSchema + // Name of the in-application stream configured as output. + Name *string // A unique identifier for the output configuration. OutputId *string - - // Describes Amazon Kinesis stream configured as the destination where output is - // written. - KinesisStreamsOutputDescription *KinesisStreamsOutputDescription } // Describes updates to the output configuration identified by the OutputId. type OutputUpdate struct { - // If you want to specify a different in-application stream for this output - // configuration, use this field to specify the new in-application stream name. - NameUpdate *string - - // Describes an Amazon Kinesis Firehose delivery stream as the destination for the - // output. - KinesisFirehoseOutputUpdate *KinesisFirehoseOutputUpdate + // Identifies the specific output configuration that you want to update. + // + // This member is required. + OutputId *string // Describes the data format when records are written to the destination. For more // information, see Configuring Application Output // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html). DestinationSchemaUpdate *DestinationSchema - // Describes an AWS Lambda function as the destination for the output. - LambdaOutputUpdate *LambdaOutputUpdate + // Describes an Amazon Kinesis Firehose delivery stream as the destination for the + // output. + KinesisFirehoseOutputUpdate *KinesisFirehoseOutputUpdate // Describes an Amazon Kinesis stream as the destination for the output. KinesisStreamsOutputUpdate *KinesisStreamsOutputUpdate - // Identifies the specific output configuration that you want to update. - // - // This member is required. - OutputId *string + // Describes an AWS Lambda function as the destination for the output. + LambdaOutputUpdate *LambdaOutputUpdate + + // If you want to specify a different in-application stream for this output + // configuration, use this field to specify the new in-application stream name. + NameUpdate *string } // Describes the mapping of each data element in the streaming source to the @@ -821,12 +821,6 @@ type OutputUpdate struct { // format of the reference data source. type RecordColumn struct { - // Reference to the data element in the streaming input or the reference data - // source. This element is required if the RecordFormatType - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_RecordFormat.html#analytics-Type-RecordFormat-RecordFormatTypel) - // is JSON. - Mapping *string - // Name of the column created in the in-application input stream or reference // table. // @@ -837,22 +831,28 @@ type RecordColumn struct { // // This member is required. SqlType *string + + // Reference to the data element in the streaming input or the reference data + // source. This element is required if the RecordFormatType + // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_RecordFormat.html#analytics-Type-RecordFormat-RecordFormatTypel) + // is JSON. + Mapping *string } // Describes the record format and relevant mapping information that should be // applied to schematize the records on the stream. type RecordFormat struct { + // The type of record format. + // + // This member is required. + RecordFormatType RecordFormatType + // When configuring application input at the time of creating or updating an // application, provides additional mapping information specific to the record // format (such as JSON, CSV, or record fields delimited by some delimiter) on the // streaming source. MappingParameters *MappingParameters - - // The type of record format. - // - // This member is required. - RecordFormatType RecordFormatType } // Describes the reference data source by providing the source information (S3 @@ -861,38 +861,28 @@ type RecordFormat struct { // object to the in-application table. type ReferenceDataSource struct { - // Identifies the S3 bucket and object that contains the reference data. Also - // identifies the IAM role Amazon Kinesis Analytics can assume to read this object - // on your behalf. An Amazon Kinesis Analytics application loads reference data - // only once. If the data changes, you call the UpdateApplication - // operation to trigger reloading of data into your application.

    - S3ReferenceDataSource *S3ReferenceDataSource + // Describes the format of the data in the streaming source, and how each data + // element maps to corresponding columns created in the in-application stream. + // + // This member is required. + ReferenceSchema *SourceSchema // Name of the in-application table to create. // // This member is required. TableName *string - // Describes the format of the data in the streaming source, and how each data - // element maps to corresponding columns created in the in-application stream. - // - // This member is required. - ReferenceSchema *SourceSchema + // Identifies the S3 bucket and object that contains the reference data. Also + // identifies the IAM role Amazon Kinesis Analytics can assume to read this object + // on your behalf. An Amazon Kinesis Analytics application loads reference data + // only once. If the data changes, you call the UpdateApplication + // operation to trigger reloading of data into your application.

    + S3ReferenceDataSource *S3ReferenceDataSource } // Describes the reference data source configured for an application. type ReferenceDataSourceDescription struct { - // Describes the format of the data in the streaming source, and how each data - // element maps to corresponding columns created in the in-application stream. - ReferenceSchema *SourceSchema - - // The in-application table name created by the specific reference data source - // configuration. - // - // This member is required. - TableName *string - // ID of the reference data source. This is the ID that Amazon Kinesis Analytics // assigns when you add the reference data source to your application using the // AddApplicationReferenceDataSource @@ -909,6 +899,16 @@ type ReferenceDataSourceDescription struct { // // This member is required. S3ReferenceDataSourceDescription *S3ReferenceDataSourceDescription + + // The in-application table name created by the specific reference data source + // configuration. + // + // This member is required. + TableName *string + + // Describes the format of the data in the streaming source, and how each data + // element maps to corresponding columns created in the in-application stream. + ReferenceSchema *SourceSchema } // When you update a reference data source configuration for an application, this @@ -926,17 +926,17 @@ type ReferenceDataSourceUpdate struct { // This member is required. ReferenceId *string - // In-application table name that is created by this update. - TableNameUpdate *string + // Describes the format of the data in the streaming source, and how each data + // element maps to corresponding columns created in the in-application stream. + ReferenceSchemaUpdate *SourceSchema // Describes the S3 bucket name, object key name, and IAM role that Amazon Kinesis // Analytics can assume to read the Amazon S3 object on your behalf and populate // the in-application reference table. S3ReferenceDataSourceUpdate *S3ReferenceDataSourceUpdate - // Describes the format of the data in the streaming source, and how each data - // element maps to corresponding columns created in the in-application stream. - ReferenceSchemaUpdate *SourceSchema + // In-application table name that is created by this update. + TableNameUpdate *string } // Provides a description of an Amazon S3 data source, including the Amazon @@ -990,15 +990,15 @@ type S3ReferenceDataSource struct { // Provides the bucket name and object key name that stores the reference data. type S3ReferenceDataSourceDescription struct { - // Amazon S3 object key name. + // Amazon Resource Name (ARN) of the S3 bucket. // // This member is required. - FileKey *string + BucketARN *string - // Amazon Resource Name (ARN) of the S3 bucket. + // Amazon S3 object key name. // // This member is required. - BucketARN *string + FileKey *string // ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon // S3 object on your behalf to populate the in-application reference table. @@ -1027,10 +1027,6 @@ type S3ReferenceDataSourceUpdate struct { // element maps to corresponding columns created in the in-application stream. type SourceSchema struct { - // Specifies the encoding of the records in the streaming source. For example, - // UTF-8. - RecordEncoding *string - // A list of RecordColumn objects. // // This member is required. @@ -1040,6 +1036,10 @@ type SourceSchema struct { // // This member is required. RecordFormat *RecordFormat + + // Specifies the encoding of the records in the streaming source. For example, + // UTF-8. + RecordEncoding *string } // A key-value pair (the value is optional) that you can define and assign to AWS diff --git a/service/kinesisanalyticsv2/api_op_AddApplicationCloudWatchLoggingOption.go b/service/kinesisanalyticsv2/api_op_AddApplicationCloudWatchLoggingOption.go index 0f749378310..ecf6fe01a08 100644 --- a/service/kinesisanalyticsv2/api_op_AddApplicationCloudWatchLoggingOption.go +++ b/service/kinesisanalyticsv2/api_op_AddApplicationCloudWatchLoggingOption.go @@ -58,15 +58,15 @@ func (c *Client) AddApplicationCloudWatchLoggingOption(ctx context.Context, para type AddApplicationCloudWatchLoggingOptionInput struct { - // Provides the Amazon CloudWatch log stream Amazon Resource Name (ARN). + // The Kinesis Data Analytics application name. // // This member is required. - CloudWatchLoggingOption *types.CloudWatchLoggingOption + ApplicationName *string - // The Kinesis Data Analytics application name. + // Provides the Amazon CloudWatch log stream Amazon Resource Name (ARN). // // This member is required. - ApplicationName *string + CloudWatchLoggingOption *types.CloudWatchLoggingOption // The version ID of the Kinesis Data Analytics application. You can retrieve the // application version ID using DescribeApplication (). @@ -80,15 +80,15 @@ type AddApplicationCloudWatchLoggingOptionOutput struct { // The application's ARN. ApplicationARN *string - // The descriptions of the current CloudWatch logging options for the Kinesis Data - // Analytics application. - CloudWatchLoggingOptionDescriptions []*types.CloudWatchLoggingOptionDescription - // The new version ID of the Kinesis Data Analytics application. Kinesis Data // Analytics updates the ApplicationVersionId each time you change the CloudWatch // logging options. ApplicationVersionId *int64 + // The descriptions of the current CloudWatch logging options for the Kinesis Data + // Analytics application. + CloudWatchLoggingOptionDescriptions []*types.CloudWatchLoggingOptionDescription + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kinesisanalyticsv2/api_op_AddApplicationInput.go b/service/kinesisanalyticsv2/api_op_AddApplicationInput.go index fa56832f24e..ce6ae9e6194 100644 --- a/service/kinesisanalyticsv2/api_op_AddApplicationInput.go +++ b/service/kinesisanalyticsv2/api_op_AddApplicationInput.go @@ -63,11 +63,6 @@ func (c *Client) AddApplicationInput(ctx context.Context, params *AddApplication type AddApplicationInputInput struct { - // The Input () to add. - // - // This member is required. - Input *types.Input - // The name of your existing application to which you want to add the streaming // source. // @@ -79,18 +74,23 @@ type AddApplicationInputInput struct { // // This member is required. CurrentApplicationVersionId *int64 + + // The Input () to add. + // + // This member is required. + Input *types.Input } type AddApplicationInputOutput struct { - // Describes the application input configuration.

    - InputDescriptions []*types.InputDescription + // The Amazon Resource Name (ARN) of the application. + ApplicationARN *string // Provides the current application version. ApplicationVersionId *int64 - // The Amazon Resource Name (ARN) of the application. - ApplicationARN *string + // Describes the application input configuration.

    + InputDescriptions []*types.InputDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/kinesisanalyticsv2/api_op_AddApplicationInputProcessingConfiguration.go b/service/kinesisanalyticsv2/api_op_AddApplicationInputProcessingConfiguration.go index 3a19d9b865a..c676846831a 100644 --- a/service/kinesisanalyticsv2/api_op_AddApplicationInputProcessingConfiguration.go +++ b/service/kinesisanalyticsv2/api_op_AddApplicationInputProcessingConfiguration.go @@ -60,6 +60,12 @@ func (c *Client) AddApplicationInputProcessingConfiguration(ctx context.Context, type AddApplicationInputProcessingConfigurationInput struct { + // The name of the application to which you want to add the input processing + // configuration. + // + // This member is required. + ApplicationName *string + // The version of the application to which you want to add the input processing // configuration. You can use the DescribeApplication () operation to get the // current application version. If the version specified is not the current @@ -68,11 +74,6 @@ type AddApplicationInputProcessingConfigurationInput struct { // This member is required. CurrentApplicationVersionId *int64 - // The InputProcessingConfiguration () to add to the application. - // - // This member is required. - InputProcessingConfiguration *types.InputProcessingConfiguration - // The ID of the input configuration to add the input processing configuration to. // You can get a list of the input IDs for an application using the // DescribeApplication () operation. @@ -80,19 +81,14 @@ type AddApplicationInputProcessingConfigurationInput struct { // This member is required. InputId *string - // The name of the application to which you want to add the input processing - // configuration. + // The InputProcessingConfiguration () to add to the application. // // This member is required. - ApplicationName *string + InputProcessingConfiguration *types.InputProcessingConfiguration } type AddApplicationInputProcessingConfigurationOutput struct { - // The description of the preprocessor that executes on records in this input - // before the application's code is run. - InputProcessingConfigurationDescription *types.InputProcessingConfigurationDescription - // The Amazon Resource Name (ARN) of the application. ApplicationARN *string @@ -104,6 +100,10 @@ type AddApplicationInputProcessingConfigurationOutput struct { // to your application. InputId *string + // The description of the preprocessor that executes on records in this input + // before the application's code is run. + InputProcessingConfigurationDescription *types.InputProcessingConfigurationDescription + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kinesisanalyticsv2/api_op_AddApplicationOutput.go b/service/kinesisanalyticsv2/api_op_AddApplicationOutput.go index add0fafbe07..f0f4b3c2446 100644 --- a/service/kinesisanalyticsv2/api_op_AddApplicationOutput.go +++ b/service/kinesisanalyticsv2/api_op_AddApplicationOutput.go @@ -73,6 +73,14 @@ type AddApplicationOutputInput struct { // This member is required. ApplicationName *string + // The version of the application to which you want to add the output + // configuration. You can use the DescribeApplication () operation to get the + // current application version. If the version specified is not the current + // version, the ConcurrentModificationException is returned. + // + // This member is required. + CurrentApplicationVersionId *int64 + // An array of objects, each describing one output configuration. In the output // configuration, you specify the name of an in-application stream, a destination // (that is, a Kinesis data stream, a Kinesis Data Firehose delivery stream, or an @@ -81,25 +89,17 @@ type AddApplicationOutputInput struct { // // This member is required. Output *types.Output - - // The version of the application to which you want to add the output - // configuration. You can use the DescribeApplication () operation to get the - // current application version. If the version specified is not the current - // version, the ConcurrentModificationException is returned. - // - // This member is required. - CurrentApplicationVersionId *int64 } type AddApplicationOutputOutput struct { + // The application Amazon Resource Name (ARN). + ApplicationARN *string + // The updated application version ID. Kinesis Data Analytics increments this ID // when the application is updated. ApplicationVersionId *int64 - // The application Amazon Resource Name (ARN). - ApplicationARN *string - // Describes the application output configuration. For more information, see // Configuring Application Output // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html). diff --git a/service/kinesisanalyticsv2/api_op_AddApplicationReferenceDataSource.go b/service/kinesisanalyticsv2/api_op_AddApplicationReferenceDataSource.go index 3c0099185a2..85cc53d5aa5 100644 --- a/service/kinesisanalyticsv2/api_op_AddApplicationReferenceDataSource.go +++ b/service/kinesisanalyticsv2/api_op_AddApplicationReferenceDataSource.go @@ -68,14 +68,6 @@ type AddApplicationReferenceDataSourceInput struct { // This member is required. ApplicationName *string - // The reference data source can be an object in your Amazon S3 bucket. Kinesis - // Data Analytics reads the object and copies the data into the in-application - // table that is created. You provide an S3 bucket, object key name, and the - // resulting in-application table that is created. - // - // This member is required. - ReferenceDataSource *types.ReferenceDataSource - // The version of the application for which you are adding the reference data // source. You can use the DescribeApplication () operation to get the current // application version. If the version specified is not the current version, the @@ -83,10 +75,21 @@ type AddApplicationReferenceDataSourceInput struct { // // This member is required. CurrentApplicationVersionId *int64 + + // The reference data source can be an object in your Amazon S3 bucket. Kinesis + // Data Analytics reads the object and copies the data into the in-application + // table that is created. You provide an S3 bucket, object key name, and the + // resulting in-application table that is created. + // + // This member is required. + ReferenceDataSource *types.ReferenceDataSource } type AddApplicationReferenceDataSourceOutput struct { + // The application Amazon Resource Name (ARN). + ApplicationARN *string + // The updated application version ID. Amazon Kinesis Data Analytics increments // this ID when the application is updated. ApplicationVersionId *int64 @@ -94,9 +97,6 @@ type AddApplicationReferenceDataSourceOutput struct { // Describes reference data sources configured for the application.

    ReferenceDataSourceDescriptions []*types.ReferenceDataSourceDescription - // The application Amazon Resource Name (ARN). - ApplicationARN *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kinesisanalyticsv2/api_op_AddApplicationVpcConfiguration.go b/service/kinesisanalyticsv2/api_op_AddApplicationVpcConfiguration.go index 738f372361c..a544bddc8bc 100644 --- a/service/kinesisanalyticsv2/api_op_AddApplicationVpcConfiguration.go +++ b/service/kinesisanalyticsv2/api_op_AddApplicationVpcConfiguration.go @@ -72,11 +72,6 @@ type AddApplicationVpcConfigurationInput struct { // This member is required. ApplicationName *string - // Description of the VPC to add to the application. - // - // This member is required. - VpcConfiguration *types.VpcConfiguration - // The version of the application to which you want to add the input processing // configuration. You can use the DescribeApplication () operation to get the // current application version. If the version specified is not the current @@ -84,10 +79,18 @@ type AddApplicationVpcConfigurationInput struct { // // This member is required. CurrentApplicationVersionId *int64 + + // Description of the VPC to add to the application. + // + // This member is required. + VpcConfiguration *types.VpcConfiguration } type AddApplicationVpcConfigurationOutput struct { + // The ARN of the application. + ApplicationARN *string + // Provides the current application version. Kinesis Data Analytics updates the // ApplicationVersionId each time you update the application. ApplicationVersionId *int64 @@ -95,9 +98,6 @@ type AddApplicationVpcConfigurationOutput struct { // The parameters of the new VPC configuration. VpcConfigurationDescription *types.VpcConfigurationDescription - // The ARN of the application. - ApplicationARN *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kinesisanalyticsv2/api_op_CreateApplication.go b/service/kinesisanalyticsv2/api_op_CreateApplication.go index 98af6c277ab..a46847056fd 100644 --- a/service/kinesisanalyticsv2/api_op_CreateApplication.go +++ b/service/kinesisanalyticsv2/api_op_CreateApplication.go @@ -69,18 +69,18 @@ type CreateApplicationInput struct { // This member is required. RuntimeEnvironment types.RuntimeEnvironment - // A summary description of the application. - ApplicationDescription *string - - // Use this parameter to configure the application. - ApplicationConfiguration *types.ApplicationConfiguration - // The IAM role used by the application to access Kinesis data streams, Kinesis // Data Firehose delivery streams, Amazon S3 objects, and other external resources. // // This member is required. ServiceExecutionRole *string + // Use this parameter to configure the application. + ApplicationConfiguration *types.ApplicationConfiguration + + // A summary description of the application. + ApplicationDescription *string + // Use this parameter to configure an Amazon CloudWatch log stream to monitor // application configuration errors. CloudWatchLoggingOptions []*types.CloudWatchLoggingOption diff --git a/service/kinesisanalyticsv2/api_op_CreateApplicationSnapshot.go b/service/kinesisanalyticsv2/api_op_CreateApplicationSnapshot.go index 70b3e9b6a55..60254b77117 100644 --- a/service/kinesisanalyticsv2/api_op_CreateApplicationSnapshot.go +++ b/service/kinesisanalyticsv2/api_op_CreateApplicationSnapshot.go @@ -56,15 +56,15 @@ func (c *Client) CreateApplicationSnapshot(ctx context.Context, params *CreateAp type CreateApplicationSnapshotInput struct { - // An identifier for the application snapshot. + // The name of an existing application // // This member is required. - SnapshotName *string + ApplicationName *string - // The name of an existing application + // An identifier for the application snapshot. // // This member is required. - ApplicationName *string + SnapshotName *string } type CreateApplicationSnapshotOutput struct { diff --git a/service/kinesisanalyticsv2/api_op_DeleteApplication.go b/service/kinesisanalyticsv2/api_op_DeleteApplication.go index 061657765ab..ef46a750f59 100644 --- a/service/kinesisanalyticsv2/api_op_DeleteApplication.go +++ b/service/kinesisanalyticsv2/api_op_DeleteApplication.go @@ -58,15 +58,15 @@ func (c *Client) DeleteApplication(ctx context.Context, params *DeleteApplicatio type DeleteApplicationInput struct { - // Use the DescribeApplication operation to get this value. + // The name of the application to delete. // // This member is required. - CreateTimestamp *time.Time + ApplicationName *string - // The name of the application to delete. + // Use the DescribeApplication operation to get this value. // // This member is required. - ApplicationName *string + CreateTimestamp *time.Time } type DeleteApplicationOutput struct { diff --git a/service/kinesisanalyticsv2/api_op_DeleteApplicationCloudWatchLoggingOption.go b/service/kinesisanalyticsv2/api_op_DeleteApplicationCloudWatchLoggingOption.go index af37d3979ce..695b5200b31 100644 --- a/service/kinesisanalyticsv2/api_op_DeleteApplicationCloudWatchLoggingOption.go +++ b/service/kinesisanalyticsv2/api_op_DeleteApplicationCloudWatchLoggingOption.go @@ -79,6 +79,9 @@ type DeleteApplicationCloudWatchLoggingOptionInput struct { type DeleteApplicationCloudWatchLoggingOptionOutput struct { + // The application's Amazon Resource Name (ARN). + ApplicationARN *string + // The version ID of the application. Kinesis Data Analytics updates the // ApplicationVersionId each time you change the CloudWatch logging options. ApplicationVersionId *int64 @@ -87,9 +90,6 @@ type DeleteApplicationCloudWatchLoggingOptionOutput struct { // application. CloudWatchLoggingOptionDescriptions []*types.CloudWatchLoggingOptionDescription - // The application's Amazon Resource Name (ARN). - ApplicationARN *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kinesisanalyticsv2/api_op_DeleteApplicationInputProcessingConfiguration.go b/service/kinesisanalyticsv2/api_op_DeleteApplicationInputProcessingConfiguration.go index 2cec40a0b79..28e335e15e3 100644 --- a/service/kinesisanalyticsv2/api_op_DeleteApplicationInputProcessingConfiguration.go +++ b/service/kinesisanalyticsv2/api_op_DeleteApplicationInputProcessingConfiguration.go @@ -56,12 +56,10 @@ func (c *Client) DeleteApplicationInputProcessingConfiguration(ctx context.Conte type DeleteApplicationInputProcessingConfigurationInput struct { - // The ID of the input configuration from which to delete the input processing - // configuration. You can get a list of the input IDs for an application by using - // the DescribeApplication () operation. + // The name of the application. // // This member is required. - InputId *string + ApplicationName *string // The application version. You can use the DescribeApplication () operation to get // the current application version. If the version specified is not the current @@ -70,20 +68,22 @@ type DeleteApplicationInputProcessingConfigurationInput struct { // This member is required. CurrentApplicationVersionId *int64 - // The name of the application. + // The ID of the input configuration from which to delete the input processing + // configuration. You can get a list of the input IDs for an application by using + // the DescribeApplication () operation. // // This member is required. - ApplicationName *string + InputId *string } type DeleteApplicationInputProcessingConfigurationOutput struct { - // The current application version ID. - ApplicationVersionId *int64 - // The Amazon Resource Name (ARN) of the application. ApplicationARN *string + // The current application version ID. + ApplicationVersionId *int64 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kinesisanalyticsv2/api_op_DeleteApplicationOutput.go b/service/kinesisanalyticsv2/api_op_DeleteApplicationOutput.go index 89373385dd5..034e278f56e 100644 --- a/service/kinesisanalyticsv2/api_op_DeleteApplicationOutput.go +++ b/service/kinesisanalyticsv2/api_op_DeleteApplicationOutput.go @@ -59,16 +59,6 @@ func (c *Client) DeleteApplicationOutput(ctx context.Context, params *DeleteAppl type DeleteApplicationOutputInput struct { - // The ID of the configuration to delete. Each output configuration that is added - // to the application (either when the application is created or later) using the - // AddApplicationOutput () operation has a unique ID. You need to provide the ID to - // uniquely identify the output configuration that you want to delete from the - // application configuration. You can use the DescribeApplication () operation to - // get the specific OutputId. - // - // This member is required. - OutputId *string - // The application name. // // This member is required. @@ -80,16 +70,26 @@ type DeleteApplicationOutputInput struct { // // This member is required. CurrentApplicationVersionId *int64 + + // The ID of the configuration to delete. Each output configuration that is added + // to the application (either when the application is created or later) using the + // AddApplicationOutput () operation has a unique ID. You need to provide the ID to + // uniquely identify the output configuration that you want to delete from the + // application configuration. You can use the DescribeApplication () operation to + // get the specific OutputId. + // + // This member is required. + OutputId *string } type DeleteApplicationOutputOutput struct { - // The current application version ID. - ApplicationVersionId *int64 - // The application Amazon Resource Name (ARN). ApplicationARN *string + // The current application version ID. + ApplicationVersionId *int64 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kinesisanalyticsv2/api_op_DeleteApplicationReferenceDataSource.go b/service/kinesisanalyticsv2/api_op_DeleteApplicationReferenceDataSource.go index a5f09df5ab7..2ffbc2ae999 100644 --- a/service/kinesisanalyticsv2/api_op_DeleteApplicationReferenceDataSource.go +++ b/service/kinesisanalyticsv2/api_op_DeleteApplicationReferenceDataSource.go @@ -59,14 +59,6 @@ func (c *Client) DeleteApplicationReferenceDataSource(ctx context.Context, param type DeleteApplicationReferenceDataSourceInput struct { - // The ID of the reference data source. When you add a reference data source to - // your application using the AddApplicationReferenceDataSource (), Kinesis Data - // Analytics assigns an ID. You can use the DescribeApplication () operation to get - // the reference ID. - // - // This member is required. - ReferenceId *string - // The name of an existing application. // // This member is required. @@ -78,16 +70,24 @@ type DeleteApplicationReferenceDataSourceInput struct { // // This member is required. CurrentApplicationVersionId *int64 + + // The ID of the reference data source. When you add a reference data source to + // your application using the AddApplicationReferenceDataSource (), Kinesis Data + // Analytics assigns an ID. You can use the DescribeApplication () operation to get + // the reference ID. + // + // This member is required. + ReferenceId *string } type DeleteApplicationReferenceDataSourceOutput struct { - // The updated version ID of the application. - ApplicationVersionId *int64 - // The application Amazon Resource Name (ARN). ApplicationARN *string + // The updated version ID of the application. + ApplicationVersionId *int64 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kinesisanalyticsv2/api_op_DeleteApplicationSnapshot.go b/service/kinesisanalyticsv2/api_op_DeleteApplicationSnapshot.go index 35177511500..8327b745e9a 100644 --- a/service/kinesisanalyticsv2/api_op_DeleteApplicationSnapshot.go +++ b/service/kinesisanalyticsv2/api_op_DeleteApplicationSnapshot.go @@ -57,16 +57,16 @@ func (c *Client) DeleteApplicationSnapshot(ctx context.Context, params *DeleteAp type DeleteApplicationSnapshotInput struct { - // The creation timestamp of the application snapshot to delete. You can retrieve - // this value using or . + // The name of an existing application. // // This member is required. - SnapshotCreationTimestamp *time.Time + ApplicationName *string - // The name of an existing application. + // The creation timestamp of the application snapshot to delete. You can retrieve + // this value using or . // // This member is required. - ApplicationName *string + SnapshotCreationTimestamp *time.Time // The identifier for the snapshot delete. // diff --git a/service/kinesisanalyticsv2/api_op_DeleteApplicationVpcConfiguration.go b/service/kinesisanalyticsv2/api_op_DeleteApplicationVpcConfiguration.go index 3992b8f98ae..7bce1522a52 100644 --- a/service/kinesisanalyticsv2/api_op_DeleteApplicationVpcConfiguration.go +++ b/service/kinesisanalyticsv2/api_op_DeleteApplicationVpcConfiguration.go @@ -56,6 +56,11 @@ func (c *Client) DeleteApplicationVpcConfiguration(ctx context.Context, params * type DeleteApplicationVpcConfigurationInput struct { + // The name of an existing application. + // + // This member is required. + ApplicationName *string + // The current application version ID. You can retrieve the application version ID // using DescribeApplication (). // @@ -66,11 +71,6 @@ type DeleteApplicationVpcConfigurationInput struct { // // This member is required. VpcConfigurationId *string - - // The name of an existing application. - // - // This member is required. - ApplicationName *string } type DeleteApplicationVpcConfigurationOutput struct { diff --git a/service/kinesisanalyticsv2/api_op_DescribeApplication.go b/service/kinesisanalyticsv2/api_op_DescribeApplication.go index ced883def1d..201face4232 100644 --- a/service/kinesisanalyticsv2/api_op_DescribeApplication.go +++ b/service/kinesisanalyticsv2/api_op_DescribeApplication.go @@ -59,14 +59,14 @@ func (c *Client) DescribeApplication(ctx context.Context, params *DescribeApplic type DescribeApplicationInput struct { - // Displays verbose information about a Kinesis Data Analytics application, - // including the application's job plan. - IncludeAdditionalDetails *bool - // The name of the application. // // This member is required. ApplicationName *string + + // Displays verbose information about a Kinesis Data Analytics application, + // including the application's job plan. + IncludeAdditionalDetails *bool } type DescribeApplicationOutput struct { diff --git a/service/kinesisanalyticsv2/api_op_DiscoverInputSchema.go b/service/kinesisanalyticsv2/api_op_DiscoverInputSchema.go index 15537b04746..9f731b42361 100644 --- a/service/kinesisanalyticsv2/api_op_DiscoverInputSchema.go +++ b/service/kinesisanalyticsv2/api_op_DiscoverInputSchema.go @@ -64,12 +64,6 @@ func (c *Client) DiscoverInputSchema(ctx context.Context, params *DiscoverInputS type DiscoverInputSchemaInput struct { - // The Amazon Resource Name (ARN) of the streaming source. - ResourceARN *string - - // Specify this parameter to discover a schema from data in an Amazon S3 object. - S3Configuration *types.S3Configuration - // The ARN of the role that is used to access the streaming source. // // This member is required. @@ -82,6 +76,12 @@ type DiscoverInputSchemaInput struct { // The point at which you want Kinesis Data Analytics to start reading records from // the specified streaming source discovery purposes. InputStartingPositionConfiguration *types.InputStartingPositionConfiguration + + // The Amazon Resource Name (ARN) of the streaming source. + ResourceARN *string + + // Specify this parameter to discover a schema from data in an Amazon S3 object. + S3Configuration *types.S3Configuration } type DiscoverInputSchemaOutput struct { @@ -91,6 +91,10 @@ type DiscoverInputSchemaOutput struct { // columns in the in-application stream that you can create. InputSchema *types.SourceSchema + // An array of elements, where each element corresponds to a row in a stream record + // (a stream record can have more than one row). + ParsedInputRecords [][]*string + // The stream data that was modified by the processor specified in the // InputProcessingConfiguration parameter. ProcessedInputRecords []*string @@ -98,10 +102,6 @@ type DiscoverInputSchemaOutput struct { // The raw stream data that was sampled to infer the schema. RawInputRecords []*string - // An array of elements, where each element corresponds to a row in a stream record - // (a stream record can have more than one row). - ParsedInputRecords [][]*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kinesisanalyticsv2/api_op_ListApplicationSnapshots.go b/service/kinesisanalyticsv2/api_op_ListApplicationSnapshots.go index 19a2778347a..2897ac8dddc 100644 --- a/service/kinesisanalyticsv2/api_op_ListApplicationSnapshots.go +++ b/service/kinesisanalyticsv2/api_op_ListApplicationSnapshots.go @@ -57,6 +57,11 @@ func (c *Client) ListApplicationSnapshots(ctx context.Context, params *ListAppli type ListApplicationSnapshotsInput struct { + // The name of an existing application. + // + // This member is required. + ApplicationName *string + // The maximum number of application snapshots to list. Limit *int32 @@ -65,22 +70,17 @@ type ListApplicationSnapshotsInput struct { // previous call's NextToken response to indicate where the output should continue // from. NextToken *string - - // The name of an existing application. - // - // This member is required. - ApplicationName *string } type ListApplicationSnapshotsOutput struct { - // A collection of objects containing information about the application snapshots. - SnapshotSummaries []*types.SnapshotDetails - // The token for the next set of results, or null if there are no additional // results. NextToken *string + // A collection of objects containing information about the application snapshots. + SnapshotSummaries []*types.SnapshotDetails + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kinesisanalyticsv2/api_op_ListApplications.go b/service/kinesisanalyticsv2/api_op_ListApplications.go index 8be7a55a9c6..f54967bb0dd 100644 --- a/service/kinesisanalyticsv2/api_op_ListApplications.go +++ b/service/kinesisanalyticsv2/api_op_ListApplications.go @@ -71,6 +71,11 @@ type ListApplicationsInput struct { type ListApplicationsOutput struct { + // A list of ApplicationSummary objects. + // + // This member is required. + ApplicationSummaries []*types.ApplicationSummary + // The pagination token for the next set of results, or null if there are no // additional results. Pass this token into a subsequent command to retrieve the // next set of items For more information about pagination, see Using the AWS @@ -78,11 +83,6 @@ type ListApplicationsOutput struct { // (https://docs.aws.amazon.com/cli/latest/userguide/pagination.html). NextToken *string - // A list of ApplicationSummary objects. - // - // This member is required. - ApplicationSummaries []*types.ApplicationSummary - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kinesisanalyticsv2/api_op_TagResource.go b/service/kinesisanalyticsv2/api_op_TagResource.go index e690d326427..f8ee9b5cd2f 100644 --- a/service/kinesisanalyticsv2/api_op_TagResource.go +++ b/service/kinesisanalyticsv2/api_op_TagResource.go @@ -60,15 +60,15 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The key-value tags to assign to the application. + // The ARN of the application to assign the tags. // // This member is required. - Tags []*types.Tag + ResourceARN *string - // The ARN of the application to assign the tags. + // The key-value tags to assign to the application. // // This member is required. - ResourceARN *string + Tags []*types.Tag } type TagResourceOutput struct { diff --git a/service/kinesisanalyticsv2/api_op_UpdateApplication.go b/service/kinesisanalyticsv2/api_op_UpdateApplication.go index ee688cc42bc..ddb36a074d5 100644 --- a/service/kinesisanalyticsv2/api_op_UpdateApplication.go +++ b/service/kinesisanalyticsv2/api_op_UpdateApplication.go @@ -60,10 +60,10 @@ func (c *Client) UpdateApplication(ctx context.Context, params *UpdateApplicatio type UpdateApplicationInput struct { - // Describes application Amazon CloudWatch logging option updates. You can only - // update existing CloudWatch logging options with this action. To add a new - // CloudWatch logging option, use AddApplicationCloudWatchLoggingOption (). - CloudWatchLoggingOptionUpdates []*types.CloudWatchLoggingOptionUpdate + // The name of the application to update. + // + // This member is required. + ApplicationName *string // The current application version ID. You can retrieve the application version ID // using DescribeApplication (). @@ -71,17 +71,17 @@ type UpdateApplicationInput struct { // This member is required. CurrentApplicationVersionId *int64 - // Describes updates to the application's starting parameters. - RunConfigurationUpdate *types.RunConfigurationUpdate - - // The name of the application to update. - // - // This member is required. - ApplicationName *string - // Describes application configuration updates. ApplicationConfigurationUpdate *types.ApplicationConfigurationUpdate + // Describes application Amazon CloudWatch logging option updates. You can only + // update existing CloudWatch logging options with this action. To add a new + // CloudWatch logging option, use AddApplicationCloudWatchLoggingOption (). + CloudWatchLoggingOptionUpdates []*types.CloudWatchLoggingOptionUpdate + + // Describes updates to the application's starting parameters. + RunConfigurationUpdate *types.RunConfigurationUpdate + // Describes updates to the service execution role. ServiceExecutionRoleUpdate *string } diff --git a/service/kinesisanalyticsv2/go.mod b/service/kinesisanalyticsv2/go.mod index be867d34150..8fb34338299 100644 --- a/service/kinesisanalyticsv2/go.mod +++ b/service/kinesisanalyticsv2/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/kinesisanalyticsv2 go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/kinesisanalyticsv2/types/types.go b/service/kinesisanalyticsv2/types/types.go index 6b0fcbcc2af..386bb14b15b 100644 --- a/service/kinesisanalyticsv2/types/types.go +++ b/service/kinesisanalyticsv2/types/types.go @@ -52,47 +52,44 @@ type ApplicationConfiguration struct { // This member is required. ApplicationCodeConfiguration *ApplicationCodeConfiguration - // The creation and update parameters for a Java-based Kinesis Data Analytics + // Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics // application. - FlinkApplicationConfiguration *FlinkApplicationConfiguration + ApplicationSnapshotConfiguration *ApplicationSnapshotConfiguration // Describes execution properties for a Java-based Kinesis Data Analytics // application. EnvironmentProperties *EnvironmentProperties - // Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics + // The creation and update parameters for a Java-based Kinesis Data Analytics // application. - ApplicationSnapshotConfiguration *ApplicationSnapshotConfiguration - - // The array of descriptions of VPC configurations available to the application. - VpcConfigurations []*VpcConfiguration + FlinkApplicationConfiguration *FlinkApplicationConfiguration // The creation and update parameters for an SQL-based Kinesis Data Analytics // application. SqlApplicationConfiguration *SqlApplicationConfiguration + + // The array of descriptions of VPC configurations available to the application. + VpcConfigurations []*VpcConfiguration } // Describes details about the application code and starting parameters for an // Amazon Kinesis Data Analytics application. type ApplicationConfigurationDescription struct { - // The details about a Java-based Kinesis Data Analytics application. - FlinkApplicationConfigurationDescription *FlinkApplicationConfigurationDescription - - // Describes execution properties for a Java-based Kinesis Data Analytics + // The details about the application code for a Java-based Kinesis Data Analytics // application. - EnvironmentPropertyDescriptions *EnvironmentPropertyDescriptions - - // The array of descriptions of VPC configurations available to the application. - VpcConfigurationDescriptions []*VpcConfigurationDescription + ApplicationCodeConfigurationDescription *ApplicationCodeConfigurationDescription // Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics // application. ApplicationSnapshotConfigurationDescription *ApplicationSnapshotConfigurationDescription - // The details about the application code for a Java-based Kinesis Data Analytics + // Describes execution properties for a Java-based Kinesis Data Analytics // application. - ApplicationCodeConfigurationDescription *ApplicationCodeConfigurationDescription + EnvironmentPropertyDescriptions *EnvironmentPropertyDescriptions + + // The details about a Java-based Kinesis Data Analytics application. + FlinkApplicationConfigurationDescription *FlinkApplicationConfigurationDescription // The details about the starting properties for a Kinesis Data Analytics // application. @@ -101,6 +98,9 @@ type ApplicationConfigurationDescription struct { // The details about inputs, outputs, and reference data sources for an SQL-based // Kinesis Data Analytics application. SqlApplicationConfigurationDescription *SqlApplicationConfigurationDescription + + // The array of descriptions of VPC configurations available to the application. + VpcConfigurationDescriptions []*VpcConfigurationDescription } // Describes updates to an application's configuration. @@ -110,18 +110,10 @@ type ApplicationConfigurationUpdate struct { // configuration. ApplicationCodeConfigurationUpdate *ApplicationCodeConfigurationUpdate - // Updates to the array of descriptions of VPC configurations available to the - // application. - VpcConfigurationUpdates []*VpcConfigurationUpdate - // Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics // application. ApplicationSnapshotConfigurationUpdate *ApplicationSnapshotConfigurationUpdate - // Describes updates to an SQL-based Kinesis Data Analytics application's - // configuration. - SqlApplicationConfigurationUpdate *SqlApplicationConfigurationUpdate - // Describes updates to the environment properties for a Java-based Kinesis Data // Analytics application. EnvironmentPropertyUpdates *EnvironmentPropertyUpdates @@ -129,34 +121,34 @@ type ApplicationConfigurationUpdate struct { // Describes updates to a Java-based Kinesis Data Analytics application's // configuration. FlinkApplicationConfigurationUpdate *FlinkApplicationConfigurationUpdate + + // Describes updates to an SQL-based Kinesis Data Analytics application's + // configuration. + SqlApplicationConfigurationUpdate *SqlApplicationConfigurationUpdate + + // Updates to the array of descriptions of VPC configurations available to the + // application. + VpcConfigurationUpdates []*VpcConfigurationUpdate } // Describes the application, including the application Amazon Resource Name (ARN), // status, latest version, and input and output configurations. type ApplicationDetail struct { - // The current timestamp when the application was last updated. - LastUpdateTimestamp *time.Time - - // The status of the application. + // The ARN of the application. // // This member is required. - ApplicationStatus ApplicationStatus - - // The description of the application. - ApplicationDescription *string - - // Provides details about the application's SQL or Java code and starting - // parameters. - ApplicationConfigurationDescription *ApplicationConfigurationDescription + ApplicationARN *string - // Describes the application Amazon CloudWatch logging options. - CloudWatchLoggingOptionDescriptions []*CloudWatchLoggingOptionDescription + // The name of the application. + // + // This member is required. + ApplicationName *string - // The ARN of the application. + // The status of the application. // // This member is required. - ApplicationARN *string + ApplicationStatus ApplicationStatus // Provides the current application version. Kinesis Data Analytics updates the // ApplicationVersionId each time you update the application. @@ -164,36 +156,44 @@ type ApplicationDetail struct { // This member is required. ApplicationVersionId *int64 - // Specifies the IAM role that the application uses to access external resources. - ServiceExecutionRole *string - // The runtime environment for the application (SQL-1.0 or FLINK-1_6). // // This member is required. RuntimeEnvironment RuntimeEnvironment + // Provides details about the application's SQL or Java code and starting + // parameters. + ApplicationConfigurationDescription *ApplicationConfigurationDescription + + // The description of the application. + ApplicationDescription *string + + // Describes the application Amazon CloudWatch logging options. + CloudWatchLoggingOptionDescriptions []*CloudWatchLoggingOptionDescription + // The current timestamp when the application was created. CreateTimestamp *time.Time - // The name of the application. - // - // This member is required. - ApplicationName *string + // The current timestamp when the application was last updated. + LastUpdateTimestamp *time.Time + + // Specifies the IAM role that the application uses to access external resources. + ServiceExecutionRole *string } // Specifies the method and snapshot to use when restarting an application using // previously saved application state. type ApplicationRestoreConfiguration struct { - // The identifier of an existing snapshot of application state to use to restart an - // application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is - // specified for the ApplicationRestoreType. - SnapshotName *string - // Specifies how the application should be restored. // // This member is required. ApplicationRestoreType ApplicationRestoreType + + // The identifier of an existing snapshot of application state to use to restart an + // application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is + // specified for the ApplicationRestoreType. + SnapshotName *string } // Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics @@ -233,30 +233,30 @@ type ApplicationSnapshotConfigurationUpdate struct { // Resource Name (ARN), name, and status. type ApplicationSummary struct { - // The status of the application. - // - // This member is required. - ApplicationStatus ApplicationStatus - - // The runtime environment for the application (SQL-1.0 or FLINK-1_6). + // The ARN of the application. // // This member is required. - RuntimeEnvironment RuntimeEnvironment + ApplicationARN *string // The name of the application. // // This member is required. ApplicationName *string - // The ARN of the application. + // The status of the application. // // This member is required. - ApplicationARN *string + ApplicationStatus ApplicationStatus // Provides the current application version. // // This member is required. ApplicationVersionId *int64 + + // The runtime environment for the application (SQL-1.0 or FLINK-1_6). + // + // This member is required. + RuntimeEnvironment RuntimeEnvironment } // Describes an application's checkpointing configuration. Checkpointing is the @@ -267,12 +267,6 @@ type ApplicationSummary struct { // (https://ci.apache.org/projects/flink/flink-docs-release-1.6/). type CheckpointConfiguration struct { - // Describes the interval in milliseconds between checkpoint operations. If - // CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a - // CheckpointInterval vaue of 60000, even if this value is set to another value - // using this API or in application code. - CheckpointInterval *int64 - // Describes whether the application uses Amazon Kinesis Data Analytics' default // checkpointing behavior. You must set this property to CUSTOM in order to set the // CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints @@ -290,6 +284,18 @@ type CheckpointConfiguration struct { // This member is required. ConfigurationType ConfigurationType + // Describes the interval in milliseconds between checkpoint operations. If + // CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a + // CheckpointInterval vaue of 60000, even if this value is set to another value + // using this API or in application code. + CheckpointInterval *int64 + + // Describes whether checkpointing is enabled for a Java-based Kinesis Data + // Analytics application. If CheckpointConfiguration.ConfigurationType is DEFAULT, + // the application will use a CheckpointingEnabled value of true, even if this + // value is set to another value using this API or in application code. + CheckpointingEnabled *bool + // Describes the minimum time in milliseconds after a checkpoint operation // completes that a new checkpoint operation can start. If a checkpoint operation // takes longer than the CheckpointInterval, the application otherwise performs @@ -301,37 +307,24 @@ type CheckpointConfiguration struct { // MinPauseBetweenCheckpoints value of 5000, even if this value is set using this // API or in application code. MinPauseBetweenCheckpoints *int64 - - // Describes whether checkpointing is enabled for a Java-based Kinesis Data - // Analytics application. If CheckpointConfiguration.ConfigurationType is DEFAULT, - // the application will use a CheckpointingEnabled value of true, even if this - // value is set to another value using this API or in application code. - CheckpointingEnabled *bool } // Describes checkpointing parameters for a Java-based Amazon Kinesis Data // Analytics application. type CheckpointConfigurationDescription struct { - // Describes whether checkpointing is enabled for a Java-based Kinesis Data - // Analytics application. If CheckpointConfiguration.ConfigurationType is DEFAULT, - // the application will use a CheckpointingEnabled value of true, even if this - // value is set to another value using this API or in application code. - CheckpointingEnabled *bool - - // Describes the minimum time in milliseconds after a checkpoint operation - // completes that a new checkpoint operation can start. If - // CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a - // MinPauseBetweenCheckpoints value of 5000, even if this value is set using this - // API or in application code. - MinPauseBetweenCheckpoints *int64 - // Describes the interval in milliseconds between checkpoint operations. If // CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a // CheckpointInterval vaue of 60000, even if this value is set to another value // using this API or in application code. CheckpointInterval *int64 + // Describes whether checkpointing is enabled for a Java-based Kinesis Data + // Analytics application. If CheckpointConfiguration.ConfigurationType is DEFAULT, + // the application will use a CheckpointingEnabled value of true, even if this + // value is set to another value using this API or in application code. + CheckpointingEnabled *bool + // Describes whether the application uses the default checkpointing behavior in // Kinesis Data Analytics. If this value is set to DEFAULT, the application will // use the following values, even if they are set to other values using APIs or @@ -344,24 +337,31 @@ type CheckpointConfigurationDescription struct { // // * MinPauseBetweenCheckpoints: 5000 ConfigurationType ConfigurationType + + // Describes the minimum time in milliseconds after a checkpoint operation + // completes that a new checkpoint operation can start. If + // CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a + // MinPauseBetweenCheckpoints value of 5000, even if this value is set using this + // API or in application code. + MinPauseBetweenCheckpoints *int64 } // Describes updates to the checkpointing parameters for a Java-based Amazon // Kinesis Data Analytics application. type CheckpointConfigurationUpdate struct { - // Describes updates to whether checkpointing is enabled for an application. If - // CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a - // CheckpointingEnabled value of true, even if this value is set to another value - // using this API or in application code. - CheckpointingEnabledUpdate *bool - // Describes updates to the interval in milliseconds between checkpoint operations. // If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will // use a CheckpointInterval vaue of 60000, even if this value is set to another // value using this API or in application code. CheckpointIntervalUpdate *int64 + // Describes updates to whether checkpointing is enabled for an application. If + // CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a + // CheckpointingEnabled value of true, even if this value is set to another value + // using this API or in application code. + CheckpointingEnabledUpdate *bool + // Describes updates to whether the application uses the default checkpointing // behavior of Kinesis Data Analytics. You must set this property to CUSTOM in // order to set the CheckpointingEnabled, CheckpointInterval, or @@ -398,15 +398,15 @@ type CloudWatchLoggingOption struct { // Describes the Amazon CloudWatch logging option. type CloudWatchLoggingOptionDescription struct { - // The ID of the CloudWatch logging option description. - CloudWatchLoggingOptionId *string - // The Amazon Resource Name (ARN) of the CloudWatch log to receive application // messages. // // This member is required. LogStreamARN *string + // The ID of the CloudWatch logging option description. + CloudWatchLoggingOptionId *string + // The IAM ARN of the role to use to send application messages. Provided for // backward compatibility. Applications created with the current API version have // an application-level service execution role rather than a resource-level role. @@ -430,20 +430,23 @@ type CloudWatchLoggingOptionUpdate struct { // for a Java-based Amazon Kinesis Data Analytics application. type CodeContent struct { - // The zip-format code for a Java-based Kinesis Data Analytics application. - ZipFileContent []byte + // Information about the Amazon S3 bucket containing the application code. + S3ContentLocation *S3ContentLocation // The text-format code for a Java-based Kinesis Data Analytics application. TextContent *string - // Information about the Amazon S3 bucket containing the application code. - S3ContentLocation *S3ContentLocation + // The zip-format code for a Java-based Kinesis Data Analytics application. + ZipFileContent []byte } // Describes details about the application code for a Java-based Kinesis Data // Analytics application. type CodeContentDescription struct { + // The checksum that can be used to validate zip-format code. + CodeMD5 *string + // The size in bytes of the application code. Can be used to validate zip-format // code. CodeSize *int64 @@ -454,23 +457,20 @@ type CodeContentDescription struct { // The text-format code TextContent *string - - // The checksum that can be used to validate zip-format code. - CodeMD5 *string } // Describes an update to the code of a Java-based Kinesis Data Analytics // application. type CodeContentUpdate struct { - // Describes an update to the zipped code for an application. - ZipFileContentUpdate []byte + // Describes an update to the location of code for an application. + S3ContentLocationUpdate *S3ContentLocationUpdate // Describes an update to the text code for an application. TextContentUpdate *string - // Describes an update to the location of code for an application. - S3ContentLocationUpdate *S3ContentLocationUpdate + // Describes an update to the zipped code for an application. + ZipFileContentUpdate []byte } // For an SQL-based application, provides additional mapping information when the @@ -480,17 +480,17 @@ type CodeContentUpdate struct { //

    "name2", "address2"

    type CSVMappingParameters struct { - // The row delimiter. For example, in a CSV format, '\n' is the typical row - // delimiter. - // - // This member is required. - RecordRowDelimiter *string - // The column delimiter. For example, in a CSV format, a comma (",") is the typical // column delimiter. // // This member is required. RecordColumnDelimiter *string + + // The row delimiter. For example, in a CSV format, '\n' is the typical row + // delimiter. + // + // This member is required. + RecordRowDelimiter *string } // Describes the data format when records are written to the destination in an @@ -556,6 +556,10 @@ type FlinkApplicationConfiguration struct { // Analytics application. type FlinkApplicationConfigurationDescription struct { + // Describes an application's checkpointing configuration. Checkpointing is the + // process of persisting application state for fault tolerance. + CheckpointConfigurationDescription *CheckpointConfigurationDescription + // The job plan for an application. For more information about the job plan, see // Jobs and Scheduling // (https://ci.apache.org/projects/flink/flink-docs-stable/internals/job_scheduling.html) @@ -566,34 +570,30 @@ type FlinkApplicationConfigurationDescription struct { // DescribeApplication () operation. JobPlanDescription *string - // Describes parameters for how an application executes multiple tasks - // simultaneously. - ParallelismConfigurationDescription *ParallelismConfigurationDescription - // Describes configuration parameters for Amazon CloudWatch logging for an // application. MonitoringConfigurationDescription *MonitoringConfigurationDescription - // Describes an application's checkpointing configuration. Checkpointing is the - // process of persisting application state for fault tolerance. - CheckpointConfigurationDescription *CheckpointConfigurationDescription + // Describes parameters for how an application executes multiple tasks + // simultaneously. + ParallelismConfigurationDescription *ParallelismConfigurationDescription } // Describes updates to the configuration parameters for a Java-based Amazon // Kinesis Data Analytics application. type FlinkApplicationConfigurationUpdate struct { - // Describes updates to the parameters for how an application executes multiple - // tasks simultaneously. - ParallelismConfigurationUpdate *ParallelismConfigurationUpdate + // Describes updates to an application's checkpointing configuration. Checkpointing + // is the process of persisting application state for fault tolerance. + CheckpointConfigurationUpdate *CheckpointConfigurationUpdate // Describes updates to the configuration parameters for Amazon CloudWatch logging // for an application. MonitoringConfigurationUpdate *MonitoringConfigurationUpdate - // Describes updates to an application's checkpointing configuration. Checkpointing - // is the process of persisting application state for fault tolerance. - CheckpointConfigurationUpdate *CheckpointConfigurationUpdate + // Describes updates to the parameters for how an application executes multiple + // tasks simultaneously. + ParallelismConfigurationUpdate *ParallelismConfigurationUpdate } // Describes the starting parameters for an Apache Flink-based Kinesis Data @@ -623,10 +623,6 @@ type Input struct { // This member is required. InputSchema *SourceSchema - // If the streaming source is an Amazon Kinesis data stream, identifies the - // stream's Amazon Resource Name (ARN). - KinesisStreamsInput *KinesisStreamsInput - // The name prefix to use when creating an in-application stream. Suppose that you // specify a prefix "MyInApplicationStream." Kinesis Data Analytics then creates // one or more (as per the InputParallelism count you specified) in-application @@ -636,6 +632,9 @@ type Input struct { // This member is required. NamePrefix *string + // Describes the number of in-application streams to create. + InputParallelism *InputParallelism + // The InputProcessingConfiguration () for the input. An input processor transforms // records as they are received from the stream, before the application's SQL code // executes. Currently, the only input processing configuration available is @@ -646,48 +645,49 @@ type Input struct { // identifies the delivery stream's ARN. KinesisFirehoseInput *KinesisFirehoseInput - // Describes the number of in-application streams to create. - InputParallelism *InputParallelism + // If the streaming source is an Amazon Kinesis data stream, identifies the + // stream's Amazon Resource Name (ARN). + KinesisStreamsInput *KinesisStreamsInput } // Describes the application input configuration for an SQL-based Amazon Kinesis // Data Analytics application. type InputDescription struct { - // If a Kinesis data stream is configured as a streaming source, provides the - // Kinesis data stream's Amazon Resource Name (ARN). - KinesisStreamsInputDescription *KinesisStreamsInputDescription + // Returns the in-application stream names that are mapped to the stream source. + InAppStreamNames []*string - // Describes the format of the data in the streaming source, and how each data - // element maps to corresponding columns in the in-application stream that is being - // created. - InputSchema *SourceSchema + // The input ID that is associated with the application input. This is the ID that + // Kinesis Data Analytics assigns to each input configuration that you add to your + // application. + InputId *string // Describes the configured parallelism (number of in-application streams mapped to // the streaming source). InputParallelism *InputParallelism - // The input ID that is associated with the application input. This is the ID that - // Kinesis Data Analytics assigns to each input configuration that you add to your - // application. - InputId *string + // The description of the preprocessor that executes on records in this input + // before the application's code is run. + InputProcessingConfigurationDescription *InputProcessingConfigurationDescription - // Returns the in-application stream names that are mapped to the stream source. - InAppStreamNames []*string + // Describes the format of the data in the streaming source, and how each data + // element maps to corresponding columns in the in-application stream that is being + // created. + InputSchema *SourceSchema // The point at which the application is configured to read from the input stream. InputStartingPositionConfiguration *InputStartingPositionConfiguration - // The in-application name prefix. - NamePrefix *string - // If a Kinesis Data Firehose delivery stream is configured as a streaming source, // provides the delivery stream's ARN. KinesisFirehoseInputDescription *KinesisFirehoseInputDescription - // The description of the preprocessor that executes on records in this input - // before the application's code is run. - InputProcessingConfigurationDescription *InputProcessingConfigurationDescription + // If a Kinesis data stream is configured as a streaming source, provides the + // Kinesis data stream's Amazon Resource Name (ARN). + KinesisStreamsInputDescription *KinesisStreamsInputDescription + + // The in-application name prefix. + NamePrefix *string } // An object that contains the Amazon Resource Name (ARN) of the AWS Lambda @@ -801,12 +801,12 @@ type InputSchemaUpdate struct { // stream. RecordColumnUpdates []*RecordColumn - // Specifies the format of the records on the streaming source. - RecordFormatUpdate *RecordFormat - // Specifies the encoding of the records in the streaming source; for example, // UTF-8. RecordEncodingUpdate *string + + // Specifies the format of the records on the streaming source. + RecordFormatUpdate *RecordFormat } // Describes the point at which the application reads from the streaming source. @@ -828,6 +828,18 @@ type InputStartingPositionConfiguration struct { // a specific input configuration (identified by the InputId of an application). type InputUpdate struct { + // The input ID of the application input to be updated. + // + // This member is required. + InputId *string + + // Describes the parallelism updates (the number of in-application streams Kinesis + // Data Analytics creates for the specific streaming source). + InputParallelismUpdate *InputParallelismUpdate + + // Describes updates to an InputProcessingConfiguration (). + InputProcessingConfigurationUpdate *InputProcessingConfigurationUpdate + // Describes the data format on the streaming source, and how record elements on // the streaming source map to columns of the in-application stream that is // created. @@ -837,25 +849,13 @@ type InputUpdate struct { // updated, provides an updated stream ARN. KinesisFirehoseInputUpdate *KinesisFirehoseInputUpdate - // The name prefix for in-application streams that Kinesis Data Analytics creates - // for the specific streaming source. - NamePrefixUpdate *string - // If a Kinesis data stream is the streaming source to be updated, provides an // updated stream Amazon Resource Name (ARN). KinesisStreamsInputUpdate *KinesisStreamsInputUpdate - // Describes updates to an InputProcessingConfiguration (). - InputProcessingConfigurationUpdate *InputProcessingConfigurationUpdate - - // Describes the parallelism updates (the number of in-application streams Kinesis - // Data Analytics creates for the specific streaming source). - InputParallelismUpdate *InputParallelismUpdate - - // The input ID of the application input to be updated. - // - // This member is required. - InputId *string + // The name prefix for in-application streams that Kinesis Data Analytics creates + // for the specific streaming source. + NamePrefixUpdate *string } // For an SQL-based Amazon Kinesis Data Analytics application, provides additional @@ -883,16 +883,16 @@ type KinesisFirehoseInput struct { // the streaming source in the application input configuration. type KinesisFirehoseInputDescription struct { + // The Amazon Resource Name (ARN) of the delivery stream. + // + // This member is required. + ResourceARN *string + // The ARN of the IAM role that Kinesis Data Analytics assumes to access the // stream. Provided for backward compatibility. Applications that are created with // the current API version have an application-level service execution role rather // than a resource-level role. RoleARN *string - - // The Amazon Resource Name (ARN) of the delivery stream. - // - // This member is required. - ResourceARN *string } // For an SQL-based Amazon Kinesis Data Analytics application, when updating @@ -999,16 +999,16 @@ type KinesisStreamsOutput struct { // the Kinesis data stream that is configured as its destination. type KinesisStreamsOutputDescription struct { + // The Amazon Resource Name (ARN) of the Kinesis data stream. + // + // This member is required. + ResourceARN *string + // The ARN of the IAM role that Kinesis Data Analytics can assume to access the // stream. Provided for backward compatibility. Applications that are created with // the current API version have an application-level service execution role rather // than a resource-level role. RoleARN *string - - // The Amazon Resource Name (ARN) of the Kinesis data stream. - // - // This member is required. - ResourceARN *string } // When you update an SQL-based Amazon Kinesis Data Analytics application's output @@ -1088,31 +1088,31 @@ type MappingParameters struct { // (https://docs.aws.amazon.com/kinesisanalytics/latest/java/monitoring-overview.html). type MonitoringConfiguration struct { - // Describes the verbosity of the CloudWatch Logs for an application. - LogLevel LogLevel - - // Describes the granularity of the CloudWatch Logs for an application. - MetricsLevel MetricsLevel - // Describes whether to use the default CloudWatch logging configuration for an // application. You must set this property to CUSTOM in order to set the LogLevel // or MetricsLevel parameters. // // This member is required. ConfigurationType ConfigurationType + + // Describes the verbosity of the CloudWatch Logs for an application. + LogLevel LogLevel + + // Describes the granularity of the CloudWatch Logs for an application. + MetricsLevel MetricsLevel } // Describes configuration parameters for CloudWatch logging for a Java-based // Kinesis Data Analytics application. type MonitoringConfigurationDescription struct { - // Describes the verbosity of the CloudWatch Logs for an application. - LogLevel LogLevel - // Describes whether to use the default CloudWatch logging configuration for an // application. ConfigurationType ConfigurationType + // Describes the verbosity of the CloudWatch Logs for an application. + LogLevel LogLevel + // Describes the granularity of the CloudWatch Logs for an application. MetricsLevel MetricsLevel } @@ -1121,16 +1121,16 @@ type MonitoringConfigurationDescription struct { // a Java-based Kinesis Data Analytics application. type MonitoringConfigurationUpdate struct { - // Describes updates to the granularity of the CloudWatch Logs for an application. - MetricsLevelUpdate MetricsLevel - - // Describes updates to the verbosity of the CloudWatch Logs for an application. - LogLevelUpdate LogLevel - // Describes updates to whether to use the default CloudWatch logging configuration // for an application. You must set this property to CUSTOM in order to set the // LogLevel or MetricsLevel parameters. ConfigurationTypeUpdate ConfigurationType + + // Describes updates to the verbosity of the CloudWatch Logs for an application. + LogLevelUpdate LogLevel + + // Describes updates to the granularity of the CloudWatch Logs for an application. + MetricsLevelUpdate MetricsLevel } // Describes an SQL-based Amazon Kinesis Data Analytics application's output @@ -1139,15 +1139,6 @@ type MonitoringConfigurationUpdate struct { // be a Kinesis data stream or a Kinesis Data Firehose delivery stream.

    type Output struct { - // Identifies an Amazon Kinesis Data Firehose delivery stream as the destination. - KinesisFirehoseOutput *KinesisFirehoseOutput - - // Identifies an AWS Lambda function as the destination. - LambdaOutput *LambdaOutput - - // Identifies an Amazon Kinesis data stream as the destination. - KinesisStreamsOutput *KinesisStreamsOutput - // Describes the data format when records are written to the destination. // // This member is required. @@ -1157,6 +1148,15 @@ type Output struct { // // This member is required. Name *string + + // Identifies an Amazon Kinesis Data Firehose delivery stream as the destination. + KinesisFirehoseOutput *KinesisFirehoseOutput + + // Identifies an Amazon Kinesis data stream as the destination. + KinesisStreamsOutput *KinesisStreamsOutput + + // Identifies an AWS Lambda function as the destination. + LambdaOutput *LambdaOutput } // For an SQL-based Amazon Kinesis Data Analytics application, describes the @@ -1165,26 +1165,26 @@ type Output struct { // Kinesis data stream or a Kinesis Data Firehose delivery stream. type OutputDescription struct { - // Describes the Kinesis data stream that is configured as the destination where - // output is written. - KinesisStreamsOutputDescription *KinesisStreamsOutputDescription + // The data format used for writing data to the destination. + DestinationSchema *DestinationSchema // Describes the Kinesis Data Firehose delivery stream that is configured as the // destination where output is written. KinesisFirehoseOutputDescription *KinesisFirehoseOutputDescription - // The data format used for writing data to the destination. - DestinationSchema *DestinationSchema + // Describes the Kinesis data stream that is configured as the destination where + // output is written. + KinesisStreamsOutputDescription *KinesisStreamsOutputDescription - // A unique identifier for the output configuration. - OutputId *string + // Describes the Lambda function that is configured as the destination where output + // is written. + LambdaOutputDescription *LambdaOutputDescription // The name of the in-application stream that is configured as output. Name *string - // Describes the Lambda function that is configured as the destination where output - // is written. - LambdaOutputDescription *LambdaOutputDescription + // A unique identifier for the output configuration. + OutputId *string } // For an SQL-based Amazon Kinesis Data Analytics application, describes updates to @@ -1193,14 +1193,8 @@ type OutputUpdate struct { // Identifies the specific output configuration that you want to update. // - // This member is required. - OutputId *string - - // Describes an AWS Lambda function as the destination for the output. - LambdaOutputUpdate *LambdaOutputUpdate - - // Describes a Kinesis data stream as the destination for the output. - KinesisStreamsOutputUpdate *KinesisStreamsOutputUpdate + // This member is required. + OutputId *string // Describes the data format when records are written to the destination. DestinationSchemaUpdate *DestinationSchema @@ -1209,6 +1203,12 @@ type OutputUpdate struct { // output. KinesisFirehoseOutputUpdate *KinesisFirehoseOutputUpdate + // Describes a Kinesis data stream as the destination for the output. + KinesisStreamsOutputUpdate *KinesisStreamsOutputUpdate + + // Describes an AWS Lambda function as the destination for the output. + LambdaOutputUpdate *LambdaOutputUpdate + // If you want to specify a different in-application stream for this output // configuration, use this field to specify the new in-application stream name. NameUpdate *string @@ -1222,16 +1222,6 @@ type OutputUpdate struct { // (https://ci.apache.org/projects/flink/flink-docs-release-1.6/). type ParallelismConfiguration struct { - // Describes whether the Kinesis Data Analytics service can increase the - // parallelism of the application in response to increased throughput. - AutoScalingEnabled *bool - - // Describes the number of parallel tasks that a Java-based Kinesis Data Analytics - // application can perform per Kinesis Processing Unit (KPU) used by the - // application. For more information about KPUs, see Amazon Kinesis Data Analytics - // Pricing (http://aws.amazon.com/kinesis/data-analytics/pricing/). - ParallelismPerKPU *int32 - // Describes whether the application uses the default parallelism for the Kinesis // Data Analytics service. You must set this property to CUSTOM in order to change // your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU @@ -1240,6 +1230,10 @@ type ParallelismConfiguration struct { // This member is required. ConfigurationType ConfigurationType + // Describes whether the Kinesis Data Analytics service can increase the + // parallelism of the application in response to increased throughput. + AutoScalingEnabled *bool + // Describes the initial number of parallel tasks that a Java-based Kinesis Data // Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis // Data Analytics increases the CurrentParallelism value in response to application @@ -1249,30 +1243,26 @@ type ParallelismConfiguration struct { // increased by requesting a limit increase. If application load is reduced, the // service can reduce the CurrentParallelism value down to the Parallelism setting. Parallelism *int32 + + // Describes the number of parallel tasks that a Java-based Kinesis Data Analytics + // application can perform per Kinesis Processing Unit (KPU) used by the + // application. For more information about KPUs, see Amazon Kinesis Data Analytics + // Pricing (http://aws.amazon.com/kinesis/data-analytics/pricing/). + ParallelismPerKPU *int32 } // Describes parameters for how a Java-based Kinesis Data Analytics application // executes multiple tasks simultaneously. type ParallelismConfigurationDescription struct { - // Describes whether the application uses the default parallelism for the Kinesis - // Data Analytics service. - ConfigurationType ConfigurationType - - // Describes the initial number of parallel tasks that a Java-based Kinesis Data - // Analytics application can perform. If AutoScalingEnabled is set to True, then - // Kinesis Data Analytics can increase the CurrentParallelism value in response to - // application load. The service can increase CurrentParallelism up to the maximum - // parallelism, which is ParalellismPerKPU times the maximum KPUs for the - // application. The maximum KPUs for an application is 32 by default, and can be - // increased by requesting a limit increase. If application load is reduced, the - // service can reduce the CurrentParallelism value down to the Parallelism setting. - Parallelism *int32 - // Describes whether the Kinesis Data Analytics service can increase the // parallelism of the application in response to increased throughput. AutoScalingEnabled *bool + // Describes whether the application uses the default parallelism for the Kinesis + // Data Analytics service. + ConfigurationType ConfigurationType + // Describes the current number of parallel tasks that a Java-based Kinesis Data // Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis // Data Analytics can increase this value in response to application load. The @@ -1283,6 +1273,16 @@ type ParallelismConfigurationDescription struct { // CurrentParallelism value down to the Parallelism setting. CurrentParallelism *int32 + // Describes the initial number of parallel tasks that a Java-based Kinesis Data + // Analytics application can perform. If AutoScalingEnabled is set to True, then + // Kinesis Data Analytics can increase the CurrentParallelism value in response to + // application load. The service can increase CurrentParallelism up to the maximum + // parallelism, which is ParalellismPerKPU times the maximum KPUs for the + // application. The maximum KPUs for an application is 32 by default, and can be + // increased by requesting a limit increase. If application load is reduced, the + // service can reduce the CurrentParallelism value down to the Parallelism setting. + Parallelism *int32 + // Describes the number of parallel tasks that a Java-based Kinesis Data Analytics // application can perform per Kinesis Processing Unit (KPU) used by the // application. @@ -1297,16 +1297,6 @@ type ParallelismConfigurationUpdate struct { // parallelism of the application in response to increased throughput. AutoScalingEnabledUpdate *bool - // Describes updates to the initial number of parallel tasks an application can - // perform. If AutoScalingEnabled is set to True, then Kinesis Data Analytics can - // increase the CurrentParallelism value in response to application load. The - // service can increase CurrentParallelism up to the maximum parallelism, which is - // ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs - // for an application is 32 by default, and can be increased by requesting a limit - // increase. If application load is reduced, the service will reduce - // CurrentParallelism down to the Parallelism setting. - ParallelismUpdate *int32 - // Describes updates to whether the application uses the default parallelism for // the Kinesis Data Analytics service, or if a custom parallelism is used. You must // set this property to CUSTOM in order to change your application's @@ -1316,6 +1306,16 @@ type ParallelismConfigurationUpdate struct { // Describes updates to the number of parallel tasks an application can perform per // Kinesis Processing Unit (KPU) used by the application. ParallelismPerKPUUpdate *int32 + + // Describes updates to the initial number of parallel tasks an application can + // perform. If AutoScalingEnabled is set to True, then Kinesis Data Analytics can + // increase the CurrentParallelism value in response to application load. The + // service can increase CurrentParallelism up to the maximum parallelism, which is + // ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs + // for an application is 32 by default, and can be increased by requesting a limit + // increase. If application load is reduced, the service will reduce + // CurrentParallelism down to the Parallelism setting. + ParallelismUpdate *int32 } // Property key-value pairs passed into a Java-based Kinesis Data Analytics @@ -1380,17 +1380,17 @@ type RecordFormat struct { // in-application table. type ReferenceDataSource struct { - // The name of the in-application table to create. - // - // This member is required. - TableName *string - // Describes the format of the data in the streaming source, and how each data // element maps to corresponding columns created in the in-application stream. // // This member is required. ReferenceSchema *SourceSchema + // The name of the in-application table to create. + // + // This member is required. + TableName *string + // Identifies the S3 bucket and object that contains the reference data. A Kinesis // Data Analytics application loads reference data only once. If the data changes, // you call the UpdateApplication operation to trigger reloading of data @@ -1402,16 +1402,6 @@ type ReferenceDataSource struct { // reference data source configured for an application. type ReferenceDataSourceDescription struct { - // Provides the Amazon S3 bucket name, the object key name that contains the - // reference data. - // - // This member is required. - S3ReferenceDataSourceDescription *S3ReferenceDataSourceDescription - - // Describes the format of the data in the streaming source, and how each data - // element maps to corresponding columns created in the in-application stream. - ReferenceSchema *SourceSchema - // The ID of the reference data source. This is the ID that Kinesis Data Analytics // assigns when you add the reference data source to your application using the // CreateApplication () or UpdateApplication () operation. @@ -1419,11 +1409,21 @@ type ReferenceDataSourceDescription struct { // This member is required. ReferenceId *string + // Provides the Amazon S3 bucket name, the object key name that contains the + // reference data. + // + // This member is required. + S3ReferenceDataSourceDescription *S3ReferenceDataSourceDescription + // The in-application table name created by the specific reference data source // configuration. // // This member is required. TableName *string + + // Describes the format of the data in the streaming source, and how each data + // element maps to corresponding columns created in the in-application stream. + ReferenceSchema *SourceSchema } // When you update a reference data source configuration for a SQL-based Amazon @@ -1433,16 +1433,16 @@ type ReferenceDataSourceDescription struct { // Amazon S3 object to the in-application reference table that is created. type ReferenceDataSourceUpdate struct { - // Describes the format of the data in the streaming source, and how each data - // element maps to corresponding columns created in the in-application stream. - ReferenceSchemaUpdate *SourceSchema - // The ID of the reference data source that is being updated. You can use the // DescribeApplication () operation to get this value. // // This member is required. ReferenceId *string + // Describes the format of the data in the streaming source, and how each data + // element maps to corresponding columns created in the in-application stream. + ReferenceSchemaUpdate *SourceSchema + // Describes the S3 bucket name, object key name, and IAM role that Kinesis Data // Analytics can assume to read the Amazon S3 object on your behalf and populate // the in-application reference table. @@ -1479,31 +1479,31 @@ type RunConfigurationDescription struct { // application. type RunConfigurationUpdate struct { + // Describes updates to the restore behavior of a restarting application. + ApplicationRestoreConfiguration *ApplicationRestoreConfiguration + // Describes the starting parameters for an Apache Flink-based Kinesis Data // Analytics application. FlinkRunConfiguration *FlinkRunConfiguration - - // Describes updates to the restore behavior of a restarting application. - ApplicationRestoreConfiguration *ApplicationRestoreConfiguration } // Describes the location of a Java-based Amazon Kinesis Data Analytics // application's code stored in an S3 bucket. type S3ApplicationCodeLocationDescription struct { - // The version of the object containing the application code. - ObjectVersion *string + // The Amazon Resource Name (ARN) for the S3 bucket containing the application + // code. + // + // This member is required. + BucketARN *string // The file key for the object containing the application code. // // This member is required. FileKey *string - // The Amazon Resource Name (ARN) for the S3 bucket containing the application - // code. - // - // This member is required. - BucketARN *string + // The version of the object containing the application code. + ObjectVersion *string } // For an SQL-based Amazon Kinesis Data Analytics application, provides a @@ -1529,34 +1529,34 @@ type S3Configuration struct { // version number of the Amazon S3 object that contains the data. type S3ContentLocation struct { - // The version of the object containing the application code. - ObjectVersion *string + // The Amazon Resource Name (ARN) for the S3 bucket containing the application + // code. + // + // This member is required. + BucketARN *string // The file key for the object containing the application code. // // This member is required. FileKey *string - // The Amazon Resource Name (ARN) for the S3 bucket containing the application - // code. - // - // This member is required. - BucketARN *string + // The version of the object containing the application code. + ObjectVersion *string } // Describes an update for the Amazon S3 code content location for a Java-based // Amazon Kinesis Data Analytics application. type S3ContentLocationUpdate struct { + // The new Amazon Resource Name (ARN) for the S3 bucket containing the application + // code. + BucketARNUpdate *string + // The new file key for the object containing the application code. FileKeyUpdate *string // The new version of the object containing the application code. ObjectVersionUpdate *string - - // The new Amazon Resource Name (ARN) for the S3 bucket containing the application - // code. - BucketARNUpdate *string } // For an SQL-based Amazon Kinesis Data Analytics application, identifies the @@ -1577,15 +1577,15 @@ type S3ReferenceDataSource struct { // name and object key name that stores the reference data. type S3ReferenceDataSourceDescription struct { - // Amazon S3 object key name. + // The Amazon Resource Name (ARN) of the S3 bucket. // // This member is required. - FileKey *string + BucketARN *string - // The Amazon Resource Name (ARN) of the S3 bucket. + // Amazon S3 object key name. // // This member is required. - BucketARN *string + FileKey *string // The ARN of the IAM role that Kinesis Data Analytics can assume to read the // Amazon S3 object on your behalf to populate the in-application reference table. @@ -1599,33 +1599,33 @@ type S3ReferenceDataSourceDescription struct { // S3 bucket name and object key name for an in-application reference table. type S3ReferenceDataSourceUpdate struct { - // The object key name. - FileKeyUpdate *string - // The Amazon Resource Name (ARN) of the S3 bucket. BucketARNUpdate *string + + // The object key name. + FileKeyUpdate *string } // Provides details about a snapshot of application state. type SnapshotDetails struct { - // The timestamp of the application snapshot. - SnapshotCreationTimestamp *time.Time - - // The status of the application snapshot. + // The current application version ID when the snapshot was created. // // This member is required. - SnapshotStatus SnapshotStatus + ApplicationVersionId *int64 // The identifier for the application snapshot. // // This member is required. SnapshotName *string - // The current application version ID when the snapshot was created. + // The status of the application snapshot. // // This member is required. - ApplicationVersionId *int64 + SnapshotStatus SnapshotStatus + + // The timestamp of the application snapshot. + SnapshotCreationTimestamp *time.Time } // For an SQL-based Amazon Kinesis Data Analytics application, describes the format @@ -1633,6 +1633,11 @@ type SnapshotDetails struct { // corresponding columns created in the in-application stream. type SourceSchema struct { + // A list of RecordColumn objects. + // + // This member is required. + RecordColumns []*RecordColumn + // Specifies the format of the records on the streaming source. // // This member is required. @@ -1641,11 +1646,6 @@ type SourceSchema struct { // Specifies the encoding of the records in the streaming source. For example, // UTF-8. RecordEncoding *string - - // A list of RecordColumn objects. - // - // This member is required. - RecordColumns []*RecordColumn } // Describes the inputs, outputs, and reference data sources for an SQL-based @@ -1669,6 +1669,10 @@ type SqlApplicationConfiguration struct { // Kinesis Data Analytics application. type SqlApplicationConfigurationDescription struct { + // The array of InputDescription () objects describing the input streams used by + // the application. + InputDescriptions []*InputDescription + // The array of OutputDescription () objects describing the destination streams // used by the application. OutputDescriptions []*OutputDescription @@ -1676,10 +1680,6 @@ type SqlApplicationConfigurationDescription struct { // The array of ReferenceDataSourceDescription () objects describing the reference // data sources used by the application. ReferenceDataSourceDescriptions []*ReferenceDataSourceDescription - - // The array of InputDescription () objects describing the input streams used by - // the application. - InputDescriptions []*InputDescription } // Describes updates to the input streams, destination streams, and reference data @@ -1703,17 +1703,17 @@ type SqlApplicationConfigurationUpdate struct { // application. type SqlRunConfiguration struct { - // The point at which you want the application to start processing records from the - // streaming source. - // - // This member is required. - InputStartingPositionConfiguration *InputStartingPositionConfiguration - // The input source ID. You can get this ID by calling the DescribeApplication () // operation. // // This member is required. InputId *string + + // The point at which you want the application to start processing records from the + // streaming source. + // + // This member is required. + InputStartingPositionConfiguration *InputStartingPositionConfiguration } // A key-value pair (the value is optional) that you can define and assign to AWS @@ -1724,24 +1724,35 @@ type SqlRunConfiguration struct { // (https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-tagging.html). type Tag struct { - // The value of the key-value tag. The value is optional. - Value *string - // The key of the key-value tag. // // This member is required. Key *string + + // The value of the key-value tag. The value is optional. + Value *string } // Describes the parameters of a VPC used by the application. type VpcConfiguration struct { + // The array of SecurityGroup + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html) + // IDs used by the VPC configuration. + // + // This member is required. + SecurityGroupIds []*string + // The array of Subnet // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Subnet.html) IDs // used by the VPC configuration. // // This member is required. SubnetIds []*string +} + +// Describes the parameters of a VPC used by the application. +type VpcConfigurationDescription struct { // The array of SecurityGroup // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html) @@ -1749,10 +1760,6 @@ type VpcConfiguration struct { // // This member is required. SecurityGroupIds []*string -} - -// Describes the parameters of a VPC used by the application. -type VpcConfigurationDescription struct { // The array of Subnet // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Subnet.html) IDs @@ -1761,22 +1768,15 @@ type VpcConfigurationDescription struct { // This member is required. SubnetIds []*string - // The ID of the associated VPC. - // - // This member is required. - VpcId *string - // The ID of the VPC configuration. // // This member is required. VpcConfigurationId *string - // The array of SecurityGroup - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html) - // IDs used by the VPC configuration. + // The ID of the associated VPC. // // This member is required. - SecurityGroupIds []*string + VpcId *string } // Describes updates to the VPC configuration used by the application. @@ -1787,13 +1787,13 @@ type VpcConfigurationUpdate struct { // This member is required. VpcConfigurationId *string - // Describes updates to the array of Subnet - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Subnet.html) IDs - // used by the VPC configuration. - SubnetIdUpdates []*string - // Describes updates to the array of SecurityGroup // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html) // IDs used by the VPC configuration. SecurityGroupIdUpdates []*string + + // Describes updates to the array of Subnet + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Subnet.html) IDs + // used by the VPC configuration. + SubnetIdUpdates []*string } diff --git a/service/kinesisvideo/api_op_CreateSignalingChannel.go b/service/kinesisvideo/api_op_CreateSignalingChannel.go index f501f035610..c5f5d80a4c3 100644 --- a/service/kinesisvideo/api_op_CreateSignalingChannel.go +++ b/service/kinesisvideo/api_op_CreateSignalingChannel.go @@ -64,15 +64,15 @@ type CreateSignalingChannelInput struct { // This member is required. ChannelName *string - // A set of tags (key-value pairs) that you want to associate with this channel. - Tags []*types.Tag + // A type of the signaling channel that you are creating. Currently, SINGLE_MASTER + // is the only supported channel type. + ChannelType types.ChannelType // A structure containing the configuration for the SINGLE_MASTER channel type. SingleMasterConfiguration *types.SingleMasterConfiguration - // A type of the signaling channel that you are creating. Currently, SINGLE_MASTER - // is the only supported channel type. - ChannelType types.ChannelType + // A set of tags (key-value pairs) that you want to associate with this channel. + Tags []*types.Tag } type CreateSignalingChannelOutput struct { diff --git a/service/kinesisvideo/api_op_CreateStream.go b/service/kinesisvideo/api_op_CreateStream.go index 92ef07163e8..eecf7e0a982 100644 --- a/service/kinesisvideo/api_op_CreateStream.go +++ b/service/kinesisvideo/api_op_CreateStream.go @@ -63,29 +63,12 @@ func (c *Client) CreateStream(ctx context.Context, params *CreateStreamInput, op type CreateStreamInput struct { - // The media type of the stream. Consumers of the stream can use this information - // when processing the stream. For more information about media types, see Media - // Types (http://www.iana.org/assignments/media-types/media-types.xhtml). If you - // choose to specify the MediaType, see Naming Requirements - // (https://tools.ietf.org/html/rfc6838#section-4.2) for guidelines.

    Example - // valid values include "video/h264" and "video/h264,audio/aac".

    This - // parameter is optional; the default value is null (or empty in - // JSON).

    - MediaType *string - // A name for the stream that you are creating. The stream name is an identifier // for the stream, and must be unique for each account and region. // // This member is required. StreamName *string - // The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis - // Video Streams to use to encrypt stream data. If no key ID is specified, the - // default, Kinesis Video-managed key (aws/kinesisvideo) is used. For more - // information, see DescribeKey - // (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters). - KmsKeyId *string - // The number of hours that you want to retain the data in the stream. Kinesis // Video Streams retains the data in a data store that is associated with the // stream. The default value is 0, indicating that the stream does not persist @@ -99,6 +82,23 @@ type CreateStreamInput struct { // implementation, Kinesis Video Streams does not use this name. DeviceName *string + // The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis + // Video Streams to use to encrypt stream data. If no key ID is specified, the + // default, Kinesis Video-managed key (aws/kinesisvideo) is used. For more + // information, see DescribeKey + // (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters). + KmsKeyId *string + + // The media type of the stream. Consumers of the stream can use this information + // when processing the stream. For more information about media types, see Media + // Types (http://www.iana.org/assignments/media-types/media-types.xhtml). If you + // choose to specify the MediaType, see Naming Requirements + // (https://tools.ietf.org/html/rfc6838#section-4.2) for guidelines.

    Example + // valid values include "video/h264" and "video/h264,audio/aac".

    This + // parameter is optional; the default value is null (or empty in + // JSON).

    + MediaType *string + // A list of tags to associate with the specified stream. Each tag is a key-value // pair (the value is optional). Tags map[string]*string diff --git a/service/kinesisvideo/api_op_DeleteStream.go b/service/kinesisvideo/api_op_DeleteStream.go index 83e3d27bc9d..d0ab07741c0 100644 --- a/service/kinesisvideo/api_op_DeleteStream.go +++ b/service/kinesisvideo/api_op_DeleteStream.go @@ -63,16 +63,16 @@ func (c *Client) DeleteStream(ctx context.Context, params *DeleteStreamInput, op type DeleteStreamInput struct { + // The Amazon Resource Name (ARN) of the stream that you want to delete. + // + // This member is required. + StreamARN *string + // Optional: The version of the stream that you want to delete. Specify the version // as a safeguard to ensure that your are deleting the correct stream. To get the // stream version, use the DescribeStream API. If not specified, only the // CreationTime is checked before deleting the stream. CurrentVersion *string - - // The Amazon Resource Name (ARN) of the stream that you want to delete. - // - // This member is required. - StreamARN *string } type DeleteStreamOutput struct { diff --git a/service/kinesisvideo/api_op_GetDataEndpoint.go b/service/kinesisvideo/api_op_GetDataEndpoint.go index af8566fb23e..ef8f7f7653f 100644 --- a/service/kinesisvideo/api_op_GetDataEndpoint.go +++ b/service/kinesisvideo/api_op_GetDataEndpoint.go @@ -63,6 +63,11 @@ func (c *Client) GetDataEndpoint(ctx context.Context, params *GetDataEndpointInp type GetDataEndpointInput struct { + // The name of the API action for which to get an endpoint. + // + // This member is required. + APIName types.APIName + // The Amazon Resource Name (ARN) of the stream that you want to get the endpoint // for. You must specify either this parameter or a StreamName in the request. StreamARN *string @@ -70,11 +75,6 @@ type GetDataEndpointInput struct { // The name of the stream that you want to get the endpoint for. You must specify // either this parameter or a StreamARN in the request. StreamName *string - - // The name of the API action for which to get an endpoint. - // - // This member is required. - APIName types.APIName } type GetDataEndpointOutput struct { diff --git a/service/kinesisvideo/api_op_GetSignalingChannelEndpoint.go b/service/kinesisvideo/api_op_GetSignalingChannelEndpoint.go index 1597aa7091c..3318c06cfd4 100644 --- a/service/kinesisvideo/api_op_GetSignalingChannelEndpoint.go +++ b/service/kinesisvideo/api_op_GetSignalingChannelEndpoint.go @@ -66,15 +66,15 @@ func (c *Client) GetSignalingChannelEndpoint(ctx context.Context, params *GetSig type GetSignalingChannelEndpointInput struct { - // A structure containing the endpoint configuration for the SINGLE_MASTER channel - // type. - SingleMasterChannelEndpointConfiguration *types.SingleMasterChannelEndpointConfiguration - // The Amazon Resource Name (ARN) of the signalling channel for which you want to // get an endpoint. // // This member is required. ChannelARN *string + + // A structure containing the endpoint configuration for the SINGLE_MASTER channel + // type. + SingleMasterChannelEndpointConfiguration *types.SingleMasterChannelEndpointConfiguration } type GetSignalingChannelEndpointOutput struct { diff --git a/service/kinesisvideo/api_op_ListSignalingChannels.go b/service/kinesisvideo/api_op_ListSignalingChannels.go index d850e8839ca..c7b4759ae52 100644 --- a/service/kinesisvideo/api_op_ListSignalingChannels.go +++ b/service/kinesisvideo/api_op_ListSignalingChannels.go @@ -61,24 +61,24 @@ type ListSignalingChannelsInput struct { // Optional: Returns only the channels that satisfy a specific condition. ChannelNameCondition *types.ChannelNameCondition + // The maximum number of channels to return in the response. The default is 500. + MaxResults *int32 + // If you specify this parameter, when the result of a ListSignalingChannels // operation is truncated, the call returns the NextToken in the response. To get // another batch of channels, provide this token in your next request. NextToken *string - - // The maximum number of channels to return in the response. The default is 500. - MaxResults *int32 } type ListSignalingChannelsOutput struct { + // An array of ChannelInfo objects. + ChannelInfoList []*types.ChannelInfo + // If the response is truncated, the call returns this element with a token. To get // the next batch of streams, use this token in your next request. NextToken *string - // An array of ChannelInfo objects. - ChannelInfoList []*types.ChannelInfo - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kinesisvideo/api_op_ListTagsForResource.go b/service/kinesisvideo/api_op_ListTagsForResource.go index 4ec758a3b17..b4880276446 100644 --- a/service/kinesisvideo/api_op_ListTagsForResource.go +++ b/service/kinesisvideo/api_op_ListTagsForResource.go @@ -70,14 +70,14 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { - // A map of tag keys and values associated with the specified signaling channel. - Tags map[string]*string - // If you specify this parameter and the result of a ListTagsForResource call is // truncated, the response includes a token that you can use in the next request to // fetch the next set of tags. NextToken *string + // A map of tag keys and values associated with the specified signaling channel. + Tags map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kinesisvideo/api_op_ListTagsForStream.go b/service/kinesisvideo/api_op_ListTagsForStream.go index 92564205593..646b0e15fb5 100644 --- a/service/kinesisvideo/api_op_ListTagsForStream.go +++ b/service/kinesisvideo/api_op_ListTagsForStream.go @@ -56,16 +56,16 @@ func (c *Client) ListTagsForStream(ctx context.Context, params *ListTagsForStrea type ListTagsForStreamInput struct { + // If you specify this parameter and the result of a ListTagsForStream call is + // truncated, the response includes a token that you can use in the next request to + // fetch the next batch of tags. + NextToken *string + // The Amazon Resource Name (ARN) of the stream that you want to list tags for. StreamARN *string // The name of the stream that you want to list tags for. StreamName *string - - // If you specify this parameter and the result of a ListTagsForStream call is - // truncated, the response includes a token that you can use in the next request to - // fetch the next batch of tags. - NextToken *string } type ListTagsForStreamOutput struct { diff --git a/service/kinesisvideo/api_op_TagResource.go b/service/kinesisvideo/api_op_TagResource.go index 5e303d068d0..c50f119c0d8 100644 --- a/service/kinesisvideo/api_op_TagResource.go +++ b/service/kinesisvideo/api_op_TagResource.go @@ -62,17 +62,17 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // A list of tags to associate with the specified signaling channel. Each tag is a - // key-value pair. - // - // This member is required. - Tags []*types.Tag - // The Amazon Resource Name (ARN) of the signaling channel to which you want to add // tags. // // This member is required. ResourceARN *string + + // A list of tags to associate with the specified signaling channel. Each tag is a + // key-value pair. + // + // This member is required. + Tags []*types.Tag } type TagResourceOutput struct { diff --git a/service/kinesisvideo/api_op_TagStream.go b/service/kinesisvideo/api_op_TagStream.go index c3d941327a8..94fb4114271 100644 --- a/service/kinesisvideo/api_op_TagStream.go +++ b/service/kinesisvideo/api_op_TagStream.go @@ -63,18 +63,18 @@ func (c *Client) TagStream(ctx context.Context, params *TagStreamInput, optFns . type TagStreamInput struct { + // A list of tags to associate with the specified stream. Each tag is a key-value + // pair (the value is optional). + // + // This member is required. + Tags map[string]*string + // The Amazon Resource Name (ARN) of the resource that you want to add the tag or // tags to. StreamARN *string // The name of the stream that you want to add the tag or tags to. StreamName *string - - // A list of tags to associate with the specified stream. Each tag is a key-value - // pair (the value is optional). - // - // This member is required. - Tags map[string]*string } type TagStreamOutput struct { diff --git a/service/kinesisvideo/api_op_UntagResource.go b/service/kinesisvideo/api_op_UntagResource.go index 3df9423090a..d333d39746f 100644 --- a/service/kinesisvideo/api_op_UntagResource.go +++ b/service/kinesisvideo/api_op_UntagResource.go @@ -58,16 +58,16 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // A list of the keys of the tags that you want to remove. - // - // This member is required. - TagKeyList []*string - // The Amazon Resource Name (ARN) of the signaling channel from which you want to // remove tags. // // This member is required. ResourceARN *string + + // A list of the keys of the tags that you want to remove. + // + // This member is required. + TagKeyList []*string } type UntagResourceOutput struct { diff --git a/service/kinesisvideo/api_op_UntagStream.go b/service/kinesisvideo/api_op_UntagStream.go index 3949104a787..5734c6b6ca0 100644 --- a/service/kinesisvideo/api_op_UntagStream.go +++ b/service/kinesisvideo/api_op_UntagStream.go @@ -58,14 +58,14 @@ func (c *Client) UntagStream(ctx context.Context, params *UntagStreamInput, optF type UntagStreamInput struct { - // The Amazon Resource Name (ARN) of the stream that you want to remove tags from. - StreamARN *string - // A list of the keys of the tags that you want to remove. // // This member is required. TagKeyList []*string + // The Amazon Resource Name (ARN) of the stream that you want to remove tags from. + StreamARN *string + // The name of the stream that you want to remove tags from. StreamName *string } diff --git a/service/kinesisvideo/api_op_UpdateDataRetention.go b/service/kinesisvideo/api_op_UpdateDataRetention.go index 2434cd3a58e..3498923fcf6 100644 --- a/service/kinesisvideo/api_op_UpdateDataRetention.go +++ b/service/kinesisvideo/api_op_UpdateDataRetention.go @@ -70,9 +70,6 @@ func (c *Client) UpdateDataRetention(ctx context.Context, params *UpdateDataRete type UpdateDataRetentionInput struct { - // The name of the stream whose retention period you want to change. - StreamName *string - // The version of the stream whose retention period you want to change. To get the // version, call either the DescribeStream or the ListStreams API. // @@ -93,6 +90,9 @@ type UpdateDataRetentionInput struct { // The Amazon Resource Name (ARN) of the stream whose retention period you want to // change. StreamARN *string + + // The name of the stream whose retention period you want to change. + StreamName *string } type UpdateDataRetentionOutput struct { diff --git a/service/kinesisvideo/api_op_UpdateSignalingChannel.go b/service/kinesisvideo/api_op_UpdateSignalingChannel.go index 53d09190b9a..b962607a552 100644 --- a/service/kinesisvideo/api_op_UpdateSignalingChannel.go +++ b/service/kinesisvideo/api_op_UpdateSignalingChannel.go @@ -61,10 +61,6 @@ func (c *Client) UpdateSignalingChannel(ctx context.Context, params *UpdateSigna type UpdateSignalingChannelInput struct { - // The structure containing the configuration for the SINGLE_MASTER type of the - // signaling channel that you want to update. - SingleMasterConfiguration *types.SingleMasterConfiguration - // The Amazon Resource Name (ARN) of the signaling channel that you want to update. // // This member is required. @@ -74,6 +70,10 @@ type UpdateSignalingChannelInput struct { // // This member is required. CurrentVersion *string + + // The structure containing the configuration for the SINGLE_MASTER type of the + // signaling channel that you want to update. + SingleMasterConfiguration *types.SingleMasterConfiguration } type UpdateSignalingChannelOutput struct { diff --git a/service/kinesisvideo/api_op_UpdateStream.go b/service/kinesisvideo/api_op_UpdateStream.go index b4c6c2a5e6d..10b90c76567 100644 --- a/service/kinesisvideo/api_op_UpdateStream.go +++ b/service/kinesisvideo/api_op_UpdateStream.go @@ -62,14 +62,15 @@ func (c *Client) UpdateStream(ctx context.Context, params *UpdateStreamInput, op type UpdateStreamInput struct { - // The ARN of the stream whose metadata you want to update. - StreamARN *string - // The version of the stream whose metadata you want to update. // // This member is required. CurrentVersion *string + // The name of the device that is writing to the stream. In the current + // implementation, Kinesis Video Streams does not use this name. + DeviceName *string + // The stream's media type. Use MediaType to specify the type of content that the // stream contains to the consumers of the stream. For more information about media // types, see Media Types @@ -80,9 +81,8 @@ type UpdateStreamInput struct { // is H.264, specify video/h264 as the MediaType. MediaType *string - // The name of the device that is writing to the stream. In the current - // implementation, Kinesis Video Streams does not use this name. - DeviceName *string + // The ARN of the stream whose metadata you want to update. + StreamARN *string // The name of the stream whose metadata you want to update. The stream name is an // identifier for the stream, and must be unique for each account and region. diff --git a/service/kinesisvideo/go.mod b/service/kinesisvideo/go.mod index 17f39af9dcb..4eb0c71ff7a 100644 --- a/service/kinesisvideo/go.mod +++ b/service/kinesisvideo/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/kinesisvideo go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/kinesisvideo/types/types.go b/service/kinesisvideo/types/types.go index 73782356196..5505ad4c183 100644 --- a/service/kinesisvideo/types/types.go +++ b/service/kinesisvideo/types/types.go @@ -9,26 +9,26 @@ import ( // A structure that encapsulates a signaling channel's metadata and properties. type ChannelInfo struct { - // Current status of the signaling channel. - ChannelStatus Status - // The Amazon Resource Name (ARN) of the signaling channel. ChannelARN *string - // The current version of the signaling channel. - Version *string + // The name of the signaling channel. + ChannelName *string + + // Current status of the signaling channel. + ChannelStatus Status + + // The type of the signaling channel. + ChannelType ChannelType // The time at which the signaling channel was created. CreationTime *time.Time - // The name of the signaling channel. - ChannelName *string - // A structure that contains the configuration for the SINGLE_MASTER channel type. SingleMasterConfiguration *SingleMasterConfiguration - // The type of the signaling channel. - ChannelType ChannelType + // The current version of the signaling channel. + Version *string } // An optional input parameter for the ListSignalingChannels API. When this @@ -36,12 +36,12 @@ type ChannelInfo struct { // only the channels that satisfy a condition specified in ChannelNameCondition. type ChannelNameCondition struct { - // A value to compare. - ComparisonValue *string - // A comparison operator. Currently, you can only specify the BEGINS_WITH operator, // which finds signaling channels whose names begin with a given prefix. ComparisonOperator ComparisonOperator + + // A value to compare. + ComparisonValue *string } // An object that describes the endpoint of the signaling channel returned by the @@ -86,21 +86,21 @@ type SingleMasterConfiguration struct { // An object describing a Kinesis video stream. type StreamInfo struct { - // The MediaType of the stream. - MediaType *string - // A time stamp that indicates when the stream was created. CreationTime *time.Time + // How long the stream retains data, in hours. + DataRetentionInHours *int32 + + // The name of the device that is associated with the stream. + DeviceName *string + // The ID of the AWS Key Management Service (AWS KMS) key that Kinesis Video // Streams uses to encrypt data on the stream. KmsKeyId *string - // The name of the stream. - StreamName *string - - // The version of the stream. - Version *string + // The MediaType of the stream. + MediaType *string // The status of the stream. Status Status @@ -108,11 +108,11 @@ type StreamInfo struct { // The Amazon Resource Name (ARN) of the stream. StreamARN *string - // The name of the device that is associated with the stream. - DeviceName *string + // The name of the stream. + StreamName *string - // How long the stream retains data, in hours. - DataRetentionInHours *int32 + // The version of the stream. + Version *string } // Specifies the condition that streams must satisfy to be returned when you list @@ -132,13 +132,13 @@ type StreamNameCondition struct { // A key and value pair that is associated with the specified signaling channel. type Tag struct { - // The value of the tag that is associated with the specified signaling channel. + // The key of the tag that is associated with the specified signaling channel. // // This member is required. - Value *string + Key *string - // The key of the tag that is associated with the specified signaling channel. + // The value of the tag that is associated with the specified signaling channel. // // This member is required. - Key *string + Value *string } diff --git a/service/kinesisvideoarchivedmedia/api_op_GetClip.go b/service/kinesisvideoarchivedmedia/api_op_GetClip.go index 19d9384d6e9..9c8b94a9eda 100644 --- a/service/kinesisvideoarchivedmedia/api_op_GetClip.go +++ b/service/kinesisvideoarchivedmedia/api_op_GetClip.go @@ -89,15 +89,15 @@ func (c *Client) GetClip(ctx context.Context, params *GetClipInput, optFns ...fu type GetClipInput struct { - // The Amazon Resource Name (ARN) of the stream for which to retrieve the media - // clip. You must specify either the StreamName or the StreamARN. - StreamARN *string - // The time range of the requested clip and the source of the timestamps. // // This member is required. ClipFragmentSelector *types.ClipFragmentSelector + // The Amazon Resource Name (ARN) of the stream for which to retrieve the media + // clip. You must specify either the StreamName or the StreamARN. + StreamARN *string + // The name of the stream for which to retrieve the media clip. You must specify // either the StreamName or the StreamARN. StreamName *string @@ -105,15 +105,15 @@ type GetClipInput struct { type GetClipOutput struct { + // The content type of the media in the requested clip. + ContentType *string + // Traditional MP4 file that contains the media clip from the specified video // stream. The output will contain the first 100 MB or the first 200 fragments from // the specified start timestamp. For more information, see Kinesis Video Streams // Limits (). Payload io.ReadCloser - // The content type of the media in the requested clip. - ContentType *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kinesisvideoarchivedmedia/api_op_GetDASHStreamingSessionURL.go b/service/kinesisvideoarchivedmedia/api_op_GetDASHStreamingSessionURL.go index ac4412a057d..6d900dec6b6 100644 --- a/service/kinesisvideoarchivedmedia/api_op_GetDASHStreamingSessionURL.go +++ b/service/kinesisvideoarchivedmedia/api_op_GetDASHStreamingSessionURL.go @@ -163,25 +163,6 @@ func (c *Client) GetDASHStreamingSessionURL(ctx context.Context, params *GetDASH type GetDASHStreamingSessionURLInput struct { - // The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH - // manifest URL. You must specify either the StreamName or the StreamARN. - StreamARN *string - - // Per the MPEG-DASH specification, the wall-clock time of fragments in the - // manifest file can be derived using attributes in the manifest itself. However, - // typically, MPEG-DASH compatible media players do not properly handle gaps in the - // media timeline. Kinesis Video Streams adjusts the media timeline in the manifest - // file to enable playback of media with discontinuities. Therefore, the wall-clock - // time derived from the manifest file may be inaccurate. If - // DisplayFragmentTimestamp is set to ALWAYS, the accurate fragment timestamp is - // added to each S element in the manifest file with the attribute name “kvs:ts”. A - // custom MPEG-DASH media player is necessary to leverage this custom attribute. - // The default value is NEVER. When DASHFragmentSelector () is SERVER_TIMESTAMP, - // the timestamps will be the server start timestamps. Similarly, when - // DASHFragmentSelector () is PRODUCER_TIMESTAMP, the timestamps will be the - // producer start timestamps. - DisplayFragmentTimestamp types.DASHDisplayFragmentTimestamp - // The time range of the requested fragment and the source of the timestamps. This // parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY. This // parameter is optional if PlaybackMode isLIVE. If PlaybackMode is LIVE, the @@ -190,10 +171,6 @@ type GetDASHStreamingSessionURLInput struct { // TimestampRange must be set. DASHFragmentSelector *types.DASHFragmentSelector - // The name of the stream for which to retrieve the MPEG-DASH manifest URL. You - // must specify either the StreamName or the StreamARN. - StreamName *string - // Fragments are identified in the manifest file based on their sequence number in // the session. If DisplayFragmentNumber is set to ALWAYS, the Kinesis Video // Streams fragment number is added to each S element in the manifest file with the @@ -203,6 +180,21 @@ type GetDASHStreamingSessionURLInput struct { // default value is NEVER. DisplayFragmentNumber types.DASHDisplayFragmentNumber + // Per the MPEG-DASH specification, the wall-clock time of fragments in the + // manifest file can be derived using attributes in the manifest itself. However, + // typically, MPEG-DASH compatible media players do not properly handle gaps in the + // media timeline. Kinesis Video Streams adjusts the media timeline in the manifest + // file to enable playback of media with discontinuities. Therefore, the wall-clock + // time derived from the manifest file may be inaccurate. If + // DisplayFragmentTimestamp is set to ALWAYS, the accurate fragment timestamp is + // added to each S element in the manifest file with the attribute name “kvs:ts”. A + // custom MPEG-DASH media player is necessary to leverage this custom attribute. + // The default value is NEVER. When DASHFragmentSelector () is SERVER_TIMESTAMP, + // the timestamps will be the server start timestamps. Similarly, when + // DASHFragmentSelector () is PRODUCER_TIMESTAMP, the timestamps will be the + // producer start timestamps. + DisplayFragmentTimestamp types.DASHDisplayFragmentTimestamp + // The time in seconds until the requested session expires. This value can be // between 300 (5 minutes) and 43200 (12 hours). When a session expires, no new // calls to GetDashManifest, GetMP4InitFragment, or GetMP4MediaFragment can be made @@ -269,6 +261,14 @@ type GetDASHStreamingSessionURLInput struct { // durations are still included in the MPEG-DASH manifest. This can lead to // unexpected behavior in the media player. The default is LIVE. PlaybackMode types.DASHPlaybackMode + + // The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH + // manifest URL. You must specify either the StreamName or the StreamARN. + StreamARN *string + + // The name of the stream for which to retrieve the MPEG-DASH manifest URL. You + // must specify either the StreamName or the StreamARN. + StreamName *string } type GetDASHStreamingSessionURLOutput struct { diff --git a/service/kinesisvideoarchivedmedia/api_op_GetHLSStreamingSessionURL.go b/service/kinesisvideoarchivedmedia/api_op_GetHLSStreamingSessionURL.go index 9653c3421a3..76126ac1cfa 100644 --- a/service/kinesisvideoarchivedmedia/api_op_GetHLSStreamingSessionURL.go +++ b/service/kinesisvideoarchivedmedia/api_op_GetHLSStreamingSessionURL.go @@ -207,6 +207,16 @@ func (c *Client) GetHLSStreamingSessionURL(ctx context.Context, params *GetHLSSt type GetHLSStreamingSessionURLInput struct { + // Specifies which format should be used for packaging the media. Specifying the + // FRAGMENTED_MP4 container format packages the media into MP4 fragments (fMP4 or + // CMAF). This is the recommended packaging because there is minimal packaging + // overhead. The other container format option is MPEG_TS. HLS has supported MPEG + // TS chunks since it was released and is sometimes the only supported packaging on + // older HLS players. MPEG TS typically has a 5-25 percent packaging overhead. This + // means MPEG TS typically requires 5-25 percent more bandwidth and cost than fMP4. + // The default is FRAGMENTED_MP4. + ContainerFormat types.ContainerFormat + // Specifies when flags marking discontinuities between fragments are added to the // media playlists. Media players typically build a timeline of media content to // play, based on the timestamps of each fragment. This means that if there is any @@ -239,16 +249,6 @@ type GetHLSStreamingSessionURLInput struct { // PRODUCER_TIMESTAMP. DiscontinuityMode types.HLSDiscontinuityMode - // Specifies which format should be used for packaging the media. Specifying the - // FRAGMENTED_MP4 container format packages the media into MP4 fragments (fMP4 or - // CMAF). This is the recommended packaging because there is minimal packaging - // overhead. The other container format option is MPEG_TS. HLS has supported MPEG - // TS chunks since it was released and is sometimes the only supported packaging on - // older HLS players. MPEG TS typically has a 5-25 percent packaging overhead. This - // means MPEG TS typically requires 5-25 percent more bandwidth and cost than fMP4. - // The default is FRAGMENTED_MP4. - ContainerFormat types.ContainerFormat - // Specifies when the fragment start timestamps should be included in the HLS media // playlist. Typically, media players report the playhead position as a time // relative to the start of the first fragment in the playback session. However, @@ -261,6 +261,21 @@ type GetHLSStreamingSessionURLInput struct { // the timestamps will be the producer start timestamps. DisplayFragmentTimestamp types.HLSDisplayFragmentTimestamp + // The time in seconds until the requested session expires. This value can be + // between 300 (5 minutes) and 43200 (12 hours). When a session expires, no new + // calls to GetHLSMasterPlaylist, GetHLSMediaPlaylist, GetMP4InitFragment, + // GetMP4MediaFragment, or GetTSFragment can be made for that session. The default + // is 300 (5 minutes). + Expires *int32 + + // The time range of the requested fragment and the source of the timestamps. This + // parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY. This + // parameter is optional if PlaybackMode isLIVE. If PlaybackMode is LIVE, the + // FragmentSelectorType can be set, but the TimestampRange should not be set. If + // PlaybackMode is ON_DEMAND or LIVE_REPLAY, both FragmentSelectorType and + // TimestampRange must be set. + HLSFragmentSelector *types.HLSFragmentSelector + // The maximum number of fragments that are returned in the HLS media playlists. // When the PlaybackMode is LIVE, the most recent fragments are returned up to this // value. When the PlaybackMode is ON_DEMAND, the oldest fragments are returned, up @@ -276,14 +291,6 @@ type GetHLSStreamingSessionURLInput struct { // fragments. MaxMediaPlaylistFragmentResults *int64 - // The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS - // master playlist URL. You must specify either the StreamName or the StreamARN. - StreamARN *string - - // The name of the stream for which to retrieve the HLS master playlist URL. You - // must specify either the StreamName or the StreamARN. - StreamName *string - // Whether to retrieve live, live replay, or archived, on-demand data. Features of // the three types of sessions include the following: // @@ -330,20 +337,13 @@ type GetHLSStreamingSessionURLInput struct { // The default is LIVE. PlaybackMode types.HLSPlaybackMode - // The time in seconds until the requested session expires. This value can be - // between 300 (5 minutes) and 43200 (12 hours). When a session expires, no new - // calls to GetHLSMasterPlaylist, GetHLSMediaPlaylist, GetMP4InitFragment, - // GetMP4MediaFragment, or GetTSFragment can be made for that session. The default - // is 300 (5 minutes). - Expires *int32 + // The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS + // master playlist URL. You must specify either the StreamName or the StreamARN. + StreamARN *string - // The time range of the requested fragment and the source of the timestamps. This - // parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY. This - // parameter is optional if PlaybackMode isLIVE. If PlaybackMode is LIVE, the - // FragmentSelectorType can be set, but the TimestampRange should not be set. If - // PlaybackMode is ON_DEMAND or LIVE_REPLAY, both FragmentSelectorType and - // TimestampRange must be set. - HLSFragmentSelector *types.HLSFragmentSelector + // The name of the stream for which to retrieve the HLS master playlist URL. You + // must specify either the StreamName or the StreamARN. + StreamName *string } type GetHLSStreamingSessionURLOutput struct { diff --git a/service/kinesisvideoarchivedmedia/api_op_GetMediaForFragmentList.go b/service/kinesisvideoarchivedmedia/api_op_GetMediaForFragmentList.go index b43b20e3d2c..c3f5099581b 100644 --- a/service/kinesisvideoarchivedmedia/api_op_GetMediaForFragmentList.go +++ b/service/kinesisvideoarchivedmedia/api_op_GetMediaForFragmentList.go @@ -80,16 +80,16 @@ func (c *Client) GetMediaForFragmentList(ctx context.Context, params *GetMediaFo type GetMediaForFragmentListInput struct { - // The name of the stream from which to retrieve fragment media. - // - // This member is required. - StreamName *string - // A list of the numbers of fragments for which to retrieve media. You retrieve // these values with ListFragments (). // // This member is required. Fragments []*string + + // The name of the stream from which to retrieve fragment media. + // + // This member is required. + StreamName *string } type GetMediaForFragmentListOutput struct { diff --git a/service/kinesisvideoarchivedmedia/api_op_ListFragments.go b/service/kinesisvideoarchivedmedia/api_op_ListFragments.go index 21b884fd1e9..33ad411f492 100644 --- a/service/kinesisvideoarchivedmedia/api_op_ListFragments.go +++ b/service/kinesisvideoarchivedmedia/api_op_ListFragments.go @@ -83,6 +83,10 @@ type ListFragmentsInput struct { // This member is required. StreamName *string + // Describes the timestamp range and timestamp origin for the range of fragments to + // return. + FragmentSelector *types.FragmentSelector + // The total number of fragments to return. If the total number of fragments // available is more than the value specified in max-results, then a // ListFragmentsOutput$NextToken () is provided in the output that you can use to @@ -92,10 +96,6 @@ type ListFragmentsInput struct { // A token to specify where to start paginating. This is the // ListFragmentsOutput$NextToken () from a previously truncated response. NextToken *string - - // Describes the timestamp range and timestamp origin for the range of fragments to - // return. - FragmentSelector *types.FragmentSelector } type ListFragmentsOutput struct { diff --git a/service/kinesisvideoarchivedmedia/go.mod b/service/kinesisvideoarchivedmedia/go.mod index 5537f34ae28..6f862a6c226 100644 --- a/service/kinesisvideoarchivedmedia/go.mod +++ b/service/kinesisvideoarchivedmedia/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/kinesisvideoarchivedmedia go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/kinesisvideoarchivedmedia/types/types.go b/service/kinesisvideoarchivedmedia/types/types.go index 3a17cbe7571..ceaded25c49 100644 --- a/service/kinesisvideoarchivedmedia/types/types.go +++ b/service/kinesisvideoarchivedmedia/types/types.go @@ -15,15 +15,15 @@ import ( // oldest ingested collection of fragments are returned. type ClipFragmentSelector struct { - // The range of timestamps to return. + // The origin of the timestamps to use (Server or Producer). // // This member is required. - TimestampRange *ClipTimestampRange + FragmentSelectorType ClipFragmentSelectorType - // The origin of the timestamps to use (Server or Producer). + // The range of timestamps to return. // // This member is required. - FragmentSelectorType ClipFragmentSelectorType + TimestampRange *ClipTimestampRange } // The range of timestamps for which to return fragments. The values in the @@ -32,14 +32,6 @@ type ClipFragmentSelector struct { // it, are included in the session. type ClipTimestampRange struct { - // The starting timestamp in the range of timestamps for which to return fragments. - // This value is inclusive. Fragments that start before the StartTimestamp and - // continue past it are included in the session. If FragmentSelectorType is - // SERVER_TIMESTAMP, the StartTimestamp must be later than the stream head. - // - // This member is required. - StartTimestamp *time.Time - // The end of the timestamp range for the requested media. This value must be // within 3 hours of the specified StartTimestamp, and it must be later than the // StartTimestamp value. If FragmentSelectorType for the request is @@ -50,16 +42,20 @@ type ClipTimestampRange struct { // // This member is required. EndTimestamp *time.Time + + // The starting timestamp in the range of timestamps for which to return fragments. + // This value is inclusive. Fragments that start before the StartTimestamp and + // continue past it are included in the session. If FragmentSelectorType is + // SERVER_TIMESTAMP, the StartTimestamp must be later than the stream head. + // + // This member is required. + StartTimestamp *time.Time } // Contains the range of timestamps for the requested media, and the source of the // timestamps. type DASHFragmentSelector struct { - // The start and end of the timestamp range for the requested media. This value - // should not be present if PlaybackType is LIVE. - TimestampRange *DASHTimestampRange - // The source of the timestamps for the requested media. When FragmentSelectorType // is set to PRODUCER_TIMESTAMP and GetDASHStreamingSessionURLInput$PlaybackMode () // is ON_DEMAND or LIVE_REPLAY, the first fragment ingested with a producer @@ -81,6 +77,10 @@ type DASHFragmentSelector struct { // timestamps with values now, they are not included in the HLS media playlist. The // default is SERVER_TIMESTAMP. FragmentSelectorType DASHFragmentSelectorType + + // The start and end of the timestamp range for the requested media. This value + // should not be present if PlaybackType is LIVE. + TimestampRange *DASHTimestampRange } // The start and end of the timestamp range for the requested media. This value @@ -90,13 +90,6 @@ type DASHFragmentSelector struct { // it, are included in the session. type DASHTimestampRange struct { - // The start of the timestamp range for the requested media. If the - // DASHTimestampRange value is specified, the StartTimestamp value is required. - // This value is inclusive. Fragments that start before the StartTimestamp and - // continue past it are included in the session. If FragmentSelectorType is - // SERVER_TIMESTAMP, the StartTimestamp must be later than the stream head. - StartTimestamp *time.Time - // The end of the timestamp range for the requested media. This value must be // within 3 hours of the specified StartTimestamp, and it must be later than the // StartTimestamp value. If FragmentSelectorType for the request is @@ -110,27 +103,34 @@ type DASHTimestampRange struct { // EndTimestamp value and continue past it are included in the // session.

    EndTimestamp *time.Time + + // The start of the timestamp range for the requested media. If the + // DASHTimestampRange value is specified, the StartTimestamp value is required. + // This value is inclusive. Fragments that start before the StartTimestamp and + // continue past it are included in the session. If FragmentSelectorType is + // SERVER_TIMESTAMP, the StartTimestamp must be later than the stream head. + StartTimestamp *time.Time } // Represents a segment of video or other time-delimited data. type Fragment struct { - // The timestamp from the AWS server corresponding to the fragment. - ServerTimestamp *time.Time - // The playback duration or other time value associated with the fragment. FragmentLengthInMilliseconds *int64 - // The total fragment size, including information about the fragment and contained - // media data. - FragmentSizeInBytes *int64 - // The unique identifier of the fragment. This value monotonically increases based // on the ingestion order. FragmentNumber *string + // The total fragment size, including information about the fragment and contained + // media data. + FragmentSizeInBytes *int64 + // The timestamp from the producer corresponding to the fragment. ProducerTimestamp *time.Time + + // The timestamp from the AWS server corresponding to the fragment. + ServerTimestamp *time.Time } // Describes the timestamp range and timestamp origin of a range of fragments. Only @@ -167,10 +167,6 @@ type FragmentSelector struct { // timestamps. type HLSFragmentSelector struct { - // The start and end of the timestamp range for the requested media. This value - // should not be present if PlaybackType is LIVE. - TimestampRange *HLSTimestampRange - // The source of the timestamps for the requested media. When FragmentSelectorType // is set to PRODUCER_TIMESTAMP and GetHLSStreamingSessionURLInput$PlaybackMode () // is ON_DEMAND or LIVE_REPLAY, the first fragment ingested with a producer @@ -192,6 +188,10 @@ type HLSFragmentSelector struct { // timestamps with values now, they are not included in the HLS media playlist. The // default is SERVER_TIMESTAMP. FragmentSelectorType HLSFragmentSelectorType + + // The start and end of the timestamp range for the requested media. This value + // should not be present if PlaybackType is LIVE. + TimestampRange *HLSTimestampRange } // The start and end of the timestamp range for the requested media. This value @@ -201,13 +201,6 @@ type HLSFragmentSelector struct { // it, are included in the session. type HLSTimestampRange struct { - // The start of the timestamp range for the requested media. If the - // HLSTimestampRange value is specified, the StartTimestamp value is required. This - // value is inclusive. Fragments that start before the StartTimestamp and continue - // past it are included in the session. If FragmentSelectorType is - // SERVER_TIMESTAMP, the StartTimestamp must be later than the stream head. - StartTimestamp *time.Time - // The end of the timestamp range for the requested media. This value must be // within 3 hours of the specified StartTimestamp, and it must be later than the // StartTimestamp value. If FragmentSelectorType for the request is @@ -219,18 +212,25 @@ type HLSTimestampRange struct { // fragment. Fragments that start before the EndTimestamp value and continue past // it are included in the session. EndTimestamp *time.Time + + // The start of the timestamp range for the requested media. If the + // HLSTimestampRange value is specified, the StartTimestamp value is required. This + // value is inclusive. Fragments that start before the StartTimestamp and continue + // past it are included in the session. If FragmentSelectorType is + // SERVER_TIMESTAMP, the StartTimestamp must be later than the stream head. + StartTimestamp *time.Time } // The range of timestamps for which to return fragments. type TimestampRange struct { - // The starting timestamp in the range of timestamps for which to return fragments. + // The ending timestamp in the range of timestamps for which to return fragments. // // This member is required. - StartTimestamp *time.Time + EndTimestamp *time.Time - // The ending timestamp in the range of timestamps for which to return fragments. + // The starting timestamp in the range of timestamps for which to return fragments. // // This member is required. - EndTimestamp *time.Time + StartTimestamp *time.Time } diff --git a/service/kinesisvideomedia/api_op_GetMedia.go b/service/kinesisvideomedia/api_op_GetMedia.go index 15bf5d6a4c0..3db28965ce4 100644 --- a/service/kinesisvideomedia/api_op_GetMedia.go +++ b/service/kinesisvideomedia/api_op_GetMedia.go @@ -91,6 +91,11 @@ func (c *Client) GetMedia(ctx context.Context, params *GetMediaInput, optFns ... type GetMediaInput struct { + // Identifies the starting chunk to get from the specified stream. + // + // This member is required. + StartSelector *types.StartSelector + // The ARN of the stream from where you want to get the media content. If you don't // specify the streamARN, you must specify the streamName. StreamARN *string @@ -98,11 +103,6 @@ type GetMediaInput struct { // The Kinesis video stream name from where you want to get the media content. If // you don't specify the streamName, you must specify the streamARN. StreamName *string - - // Identifies the starting chunk to get from the specified stream. - // - // This member is required. - StartSelector *types.StartSelector } type GetMediaOutput struct { diff --git a/service/kinesisvideomedia/go.mod b/service/kinesisvideomedia/go.mod index 85f1cbbed53..db3eebc270a 100644 --- a/service/kinesisvideomedia/go.mod +++ b/service/kinesisvideomedia/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/kinesisvideomedia go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/kinesisvideomedia/types/types.go b/service/kinesisvideomedia/types/types.go index 75ecfb5d2a0..f57ad446716 100644 --- a/service/kinesisvideomedia/types/types.go +++ b/service/kinesisvideomedia/types/types.go @@ -23,20 +23,6 @@ import ( // then starts returning chunks starting where the last API ended. type StartSelector struct { - // Continuation token that Kinesis Video Streams returned in the previous GetMedia - // response. The GetMedia API then starts with the chunk identified by the - // continuation token. - ContinuationToken *string - - // A timestamp value. This value is required if you choose the PRODUCER_TIMESTAMP - // or the SERVER_TIMESTAMP as the startSelectorType. The GetMedia API then starts - // with the chunk containing the fragment that has the specified timestamp. - StartTimestamp *time.Time - - // Specifies the fragment number from where you want the GetMedia API to start - // returning the fragments. - AfterFragmentNumber *string - // Identifies the fragment on the Kinesis video stream where you want to start // getting the data from. // @@ -63,4 +49,18 @@ type StartSelector struct { // // This member is required. StartSelectorType StartSelectorType + + // Specifies the fragment number from where you want the GetMedia API to start + // returning the fragments. + AfterFragmentNumber *string + + // Continuation token that Kinesis Video Streams returned in the previous GetMedia + // response. The GetMedia API then starts with the chunk identified by the + // continuation token. + ContinuationToken *string + + // A timestamp value. This value is required if you choose the PRODUCER_TIMESTAMP + // or the SERVER_TIMESTAMP as the startSelectorType. The GetMedia API then starts + // with the chunk containing the fragment that has the specified timestamp. + StartTimestamp *time.Time } diff --git a/service/kinesisvideosignaling/api_op_GetIceServerConfig.go b/service/kinesisvideosignaling/api_op_GetIceServerConfig.go index 246c2d66593..9ca6abbb9bd 100644 --- a/service/kinesisvideosignaling/api_op_GetIceServerConfig.go +++ b/service/kinesisvideosignaling/api_op_GetIceServerConfig.go @@ -70,20 +70,20 @@ func (c *Client) GetIceServerConfig(ctx context.Context, params *GetIceServerCon type GetIceServerConfigInput struct { - // Specifies the desired service. Currently, TURN is the only valid value. - Service types.Service + // The ARN of the signaling channel to be used for the peer-to-peer connection + // between configured peers. + // + // This member is required. + ChannelARN *string // Unique identifier for the viewer. Must be unique within the signaling channel. ClientId *string + // Specifies the desired service. Currently, TURN is the only valid value. + Service types.Service + // An optional user ID to be associated with the credentials. Username *string - - // The ARN of the signaling channel to be used for the peer-to-peer connection - // between configured peers. - // - // This member is required. - ChannelARN *string } type GetIceServerConfigOutput struct { diff --git a/service/kinesisvideosignaling/api_op_SendAlexaOfferToMaster.go b/service/kinesisvideosignaling/api_op_SendAlexaOfferToMaster.go index ce0782d9915..8098ad13695 100644 --- a/service/kinesisvideosignaling/api_op_SendAlexaOfferToMaster.go +++ b/service/kinesisvideosignaling/api_op_SendAlexaOfferToMaster.go @@ -61,20 +61,20 @@ func (c *Client) SendAlexaOfferToMaster(ctx context.Context, params *SendAlexaOf type SendAlexaOfferToMasterInput struct { - // The unique identifier for the sender client. + // The ARN of the signaling channel by which Alexa and the master peer communicate. // // This member is required. - SenderClientId *string + ChannelARN *string // The base64-encoded SDP offer content. // // This member is required. MessagePayload *string - // The ARN of the signaling channel by which Alexa and the master peer communicate. + // The unique identifier for the sender client. // // This member is required. - ChannelARN *string + SenderClientId *string } type SendAlexaOfferToMasterOutput struct { diff --git a/service/kinesisvideosignaling/go.mod b/service/kinesisvideosignaling/go.mod index 1f1d6cb35a2..6f4ee2fa70f 100644 --- a/service/kinesisvideosignaling/go.mod +++ b/service/kinesisvideosignaling/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/kinesisvideosignaling go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/kinesisvideosignaling/types/types.go b/service/kinesisvideosignaling/types/types.go index 3ef3b85b7dd..ecb2bda7495 100644 --- a/service/kinesisvideosignaling/types/types.go +++ b/service/kinesisvideosignaling/types/types.go @@ -5,6 +5,9 @@ package types // A structure for the ICE server connection data. type IceServer struct { + // A password to login to the ICE server. + Password *string + // The period of time, in seconds, during which the username and password are // valid. Ttl *int32 @@ -16,9 +19,6 @@ type IceServer struct { // reach the TURN server. Uris []*string - // A password to login to the ICE server. - Password *string - // A username to login to the ICE server. Username *string } diff --git a/service/kms/api_op_CreateCustomKeyStore.go b/service/kms/api_op_CreateCustomKeyStore.go index 636daff724d..a6f0e9c7750 100644 --- a/service/kms/api_op_CreateCustomKeyStore.go +++ b/service/kms/api_op_CreateCustomKeyStore.go @@ -92,14 +92,6 @@ type CreateCustomKeyStoreInput struct { // This member is required. CustomKeyStoreName *string - // Enter the content of the trust anchor certificate for the cluster. This is the - // content of the customerCA.crt file that you created when you initialized the - // cluster - // (https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html). - // - // This member is required. - TrustAnchorCertificate *string - // Enter the password of the kmsuser crypto user (CU) account // (https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser) // in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this @@ -110,6 +102,14 @@ type CreateCustomKeyStoreInput struct { // // This member is required. KeyStorePassword *string + + // Enter the content of the trust anchor certificate for the cluster. This is the + // content of the customerCA.crt file that you created when you initialized the + // cluster + // (https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html). + // + // This member is required. + TrustAnchorCertificate *string } type CreateCustomKeyStoreOutput struct { diff --git a/service/kms/api_op_CreateGrant.go b/service/kms/api_op_CreateGrant.go index eb0bf75ae0c..016911b6363 100644 --- a/service/kms/api_op_CreateGrant.go +++ b/service/kms/api_op_CreateGrant.go @@ -101,16 +101,6 @@ func (c *Client) CreateGrant(ctx context.Context, params *CreateGrantInput, optF type CreateGrantInput struct { - // A list of grant tokens. For more information, see Grant Tokens - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) - // in the AWS Key Management Service Developer Guide. - GrantTokens []*string - - // A list of operations that the grant permits. - // - // This member is required. - Operations []types.GrantOperation - // The principal that is given permission to perform the operations that the grant // permits. To specify the principal, use the Amazon Resource Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of @@ -124,28 +114,6 @@ type CreateGrantInput struct { // This member is required. GranteePrincipal *string - // The principal that is given permission to retire the grant by using RetireGrant - // () operation. To specify the principal, use the Amazon Resource Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, - // federated users, and assumed role users. For examples of the ARN syntax to use - // for specifying a principal, see AWS Identity and Access Management (IAM) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam) - // in the Example ARNs section of the AWS General Reference. - RetiringPrincipal *string - - // A friendly name for identifying the grant. Use this value to prevent the - // unintended creation of duplicate grants when retrying this request. When this - // value is absent, all CreateGrant requests result in a new grant with a unique - // GrantId even if all the supplied parameters are identical. This can result in - // unintended duplicates when you retry the CreateGrant request. When this value is - // present, you can retry a CreateGrant request with identical parameters; if the - // grant already exists, the original GrantId is returned without creating a new - // grant. Note that the returned grant token is unique with every CreateGrant - // request, even when a duplicate GrantId is returned. All grant tokens obtained in - // this way can be used interchangeably. - Name *string - // The unique identifier for the customer master key (CMK) that the grant applies // to.

    Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To // specify a CMK in a different AWS account, you must use the key ARN. For @@ -162,6 +130,11 @@ type CreateGrantInput struct { // This member is required. KeyId *string + // A list of operations that the grant permits. + // + // This member is required. + Operations []types.GrantOperation + // Allows a cryptographic operation // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) // only when the encryption context matches or includes the encryption context @@ -170,6 +143,33 @@ type CreateGrantInput struct { // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) // in the AWS Key Management Service Developer Guide . Constraints *types.GrantConstraints + + // A list of grant tokens. For more information, see Grant Tokens + // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) + // in the AWS Key Management Service Developer Guide. + GrantTokens []*string + + // A friendly name for identifying the grant. Use this value to prevent the + // unintended creation of duplicate grants when retrying this request. When this + // value is absent, all CreateGrant requests result in a new grant with a unique + // GrantId even if all the supplied parameters are identical. This can result in + // unintended duplicates when you retry the CreateGrant request. When this value is + // present, you can retry a CreateGrant request with identical parameters; if the + // grant already exists, the original GrantId is returned without creating a new + // grant. Note that the returned grant token is unique with every CreateGrant + // request, even when a duplicate GrantId is returned. All grant tokens obtained in + // this way can be used interchangeably. + Name *string + + // The principal that is given permission to retire the grant by using RetireGrant + // () operation. To specify the principal, use the Amazon Resource Name (ARN) + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of + // an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, + // federated users, and assumed role users. For examples of the ARN syntax to use + // for specifying a principal, see AWS Identity and Access Management (IAM) + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam) + // in the Example ARNs section of the AWS General Reference. + RetiringPrincipal *string } type CreateGrantOutput struct { diff --git a/service/kms/api_op_CreateKey.go b/service/kms/api_op_CreateKey.go index a9963ad43ae..f401f76742d 100644 --- a/service/kms/api_op_CreateKey.go +++ b/service/kms/api_op_CreateKey.go @@ -111,50 +111,32 @@ func (c *Client) CreateKey(ctx context.Context, params *CreateKeyInput, optFns . type CreateKeyInput struct { - // The source of the key material for the CMK. You cannot change the origin after - // you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key - // material. When the parameter value is EXTERNAL, AWS KMS creates a CMK without - // key material so that you can import key material from your existing key - // management infrastructure. For more information about importing key material - // into AWS KMS, see Importing Key Material - // (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in - // the AWS Key Management Service Developer Guide. This value is valid only for - // symmetric CMKs. When the parameter value is AWS_CLOUDHSM, AWS KMS creates the - // CMK in an AWS KMS custom key store - // (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) - // and creates its key material in the associated AWS CloudHSM cluster. You must - // also use the CustomKeyStoreId parameter to identify the custom key store. This - // value is valid only for symmetric CMKs. - Origin types.OriginType - - // The key policy to attach to the CMK. If you provide a key policy, it must meet - // the following criteria: - // - // * If you don't set BypassPolicyLockoutSafetyCheck - // to true, the key policy must allow the principal that is making the CreateKey - // request to make a subsequent PutKeyPolicy () request on the CMK. This reduces - // the risk that the CMK becomes unmanageable. For more information, refer to the - // scenario in the Default Key Policy + // A flag to indicate whether to bypass the key policy lockout safety check. + // Setting this value to true increases the risk that the CMK becomes unmanageable. + // Do not set this value to true indiscriminately. For more information, refer to + // the scenario in the Default Key Policy // (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) - // section of the AWS Key Management Service Developer Guide . - // - // * Each - // statement in the key policy must contain one or more principals. The principals - // in the key policy must exist and be visible to AWS KMS. When you create a new - // AWS principal (for example, an IAM user or role), you might need to enforce a - // delay before including the new principal in a key policy because the new - // principal might not be immediately visible to AWS KMS. For more information, see - // Changes that I make are not always immediately visible - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) - // in the AWS Identity and Access Management User Guide. - // - // If you do not provide a - // key policy, AWS KMS attaches a default key policy to the CMK. For more - // information, see Default Key Policy - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) - // in the AWS Key Management Service Developer Guide. The key policy size quota is - // 32 kilobytes (32768 bytes). - Policy *string + // section in the AWS Key Management Service Developer Guide . Use this parameter + // only when you include a policy in the request and you intend to prevent the + // principal that is making the request from making a subsequent PutKeyPolicy () + // request on the CMK. The default value is false. + BypassPolicyLockoutSafetyCheck *bool + + // Creates the CMK in the specified custom key store + // (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) + // and the key material in its associated AWS CloudHSM cluster. To create a CMK in + // a custom key store, you must also specify the Origin parameter with a value of + // AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key + // store must have at least two active HSMs, each in a different Availability Zone + // in the Region. This parameter is valid only for symmetric CMKs. You cannot + // create an asymmetric CMK in a custom key store. To find the ID of a custom key + // store, use the DescribeCustomKeyStores () operation. The response includes the + // custom key store ID and the ID of the AWS CloudHSM cluster. This operation is + // part of the Custom Key Store feature + // (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) + // feature in AWS KMS, which combines the convenience and extensive integration of + // AWS KMS with the isolation and control of a single-tenant key store. + CustomKeyStoreId *string // Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, // creates a CMK with a 256-bit symmetric key for encryption and decryption. For @@ -215,17 +197,6 @@ type CreateKeyInput struct { // CMK is appropriate for a task. Description *string - // A flag to indicate whether to bypass the key policy lockout safety check. - // Setting this value to true increases the risk that the CMK becomes unmanageable. - // Do not set this value to true indiscriminately. For more information, refer to - // the scenario in the Default Key Policy - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) - // section in the AWS Key Management Service Developer Guide . Use this parameter - // only when you include a policy in the request and you intend to prevent the - // principal that is making the request from making a subsequent PutKeyPolicy () - // request on the CMK. The default value is false. - BypassPolicyLockoutSafetyCheck *bool - // Determines the cryptographic operations // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) // for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This @@ -242,21 +213,50 @@ type CreateKeyInput struct { // * For asymmetric CMKs with ECC key material, specify SIGN_VERIFY. KeyUsage types.KeyUsageType - // Creates the CMK in the specified custom key store - // (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) - // and the key material in its associated AWS CloudHSM cluster. To create a CMK in - // a custom key store, you must also specify the Origin parameter with a value of - // AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key - // store must have at least two active HSMs, each in a different Availability Zone - // in the Region. This parameter is valid only for symmetric CMKs. You cannot - // create an asymmetric CMK in a custom key store. To find the ID of a custom key - // store, use the DescribeCustomKeyStores () operation. The response includes the - // custom key store ID and the ID of the AWS CloudHSM cluster. This operation is - // part of the Custom Key Store feature + // The source of the key material for the CMK. You cannot change the origin after + // you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key + // material. When the parameter value is EXTERNAL, AWS KMS creates a CMK without + // key material so that you can import key material from your existing key + // management infrastructure. For more information about importing key material + // into AWS KMS, see Importing Key Material + // (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in + // the AWS Key Management Service Developer Guide. This value is valid only for + // symmetric CMKs. When the parameter value is AWS_CLOUDHSM, AWS KMS creates the + // CMK in an AWS KMS custom key store // (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) - // feature in AWS KMS, which combines the convenience and extensive integration of - // AWS KMS with the isolation and control of a single-tenant key store. - CustomKeyStoreId *string + // and creates its key material in the associated AWS CloudHSM cluster. You must + // also use the CustomKeyStoreId parameter to identify the custom key store. This + // value is valid only for symmetric CMKs. + Origin types.OriginType + + // The key policy to attach to the CMK. If you provide a key policy, it must meet + // the following criteria: + // + // * If you don't set BypassPolicyLockoutSafetyCheck + // to true, the key policy must allow the principal that is making the CreateKey + // request to make a subsequent PutKeyPolicy () request on the CMK. This reduces + // the risk that the CMK becomes unmanageable. For more information, refer to the + // scenario in the Default Key Policy + // (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) + // section of the AWS Key Management Service Developer Guide . + // + // * Each + // statement in the key policy must contain one or more principals. The principals + // in the key policy must exist and be visible to AWS KMS. When you create a new + // AWS principal (for example, an IAM user or role), you might need to enforce a + // delay before including the new principal in a key policy because the new + // principal might not be immediately visible to AWS KMS. For more information, see + // Changes that I make are not always immediately visible + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) + // in the AWS Identity and Access Management User Guide. + // + // If you do not provide a + // key policy, AWS KMS attaches a default key policy to the CMK. For more + // information, see Default Key Policy + // (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) + // in the AWS Key Management Service Developer Guide. The key policy size quota is + // 32 kilobytes (32768 bytes). + Policy *string // One or more tags. Each tag consists of a tag key and a tag value. Both the tag // key and the tag value are required, but the tag value can be an empty (null) diff --git a/service/kms/api_op_Decrypt.go b/service/kms/api_op_Decrypt.go index cccab437dd4..e365eb2b9f2 100644 --- a/service/kms/api_op_Decrypt.go +++ b/service/kms/api_op_Decrypt.go @@ -101,6 +101,38 @@ func (c *Client) Decrypt(ctx context.Context, params *DecryptInput, optFns ...fu type DecryptInput struct { + // Ciphertext to be decrypted. The blob includes metadata. + // + // This member is required. + CiphertextBlob []byte + + // Specifies the encryption algorithm that will be used to decrypt the ciphertext. + // Specify the same algorithm that was used to encrypt the data. If you specify a + // different algorithm, the Decrypt operation fails. This parameter is required + // only when the ciphertext was encrypted under an asymmetric CMK. The default + // value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid + // for symmetric CMKs. + EncryptionAlgorithm types.EncryptionAlgorithmSpec + + // Specifies the encryption context to use when decrypting the data. An encryption + // context is valid only for cryptographic operations + // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) + // with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS + // uses do not support an encryption context. An encryption context is a collection + // of non-secret key-value pairs that represents additional authenticated data. + // When you use an encryption context to encrypt data, you must specify the same + // (an exact case-sensitive match) encryption context to decrypt the data. An + // encryption context is optional when encrypting with a symmetric CMK, but it is + // highly recommended. For more information, see Encryption Context + // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) + // in the AWS Key Management Service Developer Guide. + EncryptionContext map[string]*string + + // A list of grant tokens. For more information, see Grant Tokens + // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) + // in the AWS Key Management Service Developer Guide. + GrantTokens []*string + // Specifies the customer master key (CMK) that AWS KMS will use to decrypt the // ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext. // If you specify a KeyId value, the Decrypt operation succeeds only if the @@ -128,38 +160,6 @@ type DecryptInput struct { // ARN for a CMK, use ListKeys () or DescribeKey (). To get the alias name and // alias ARN, use ListAliases (). KeyId *string - - // Specifies the encryption algorithm that will be used to decrypt the ciphertext. - // Specify the same algorithm that was used to encrypt the data. If you specify a - // different algorithm, the Decrypt operation fails. This parameter is required - // only when the ciphertext was encrypted under an asymmetric CMK. The default - // value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid - // for symmetric CMKs. - EncryptionAlgorithm types.EncryptionAlgorithmSpec - - // A list of grant tokens. For more information, see Grant Tokens - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) - // in the AWS Key Management Service Developer Guide. - GrantTokens []*string - - // Ciphertext to be decrypted. The blob includes metadata. - // - // This member is required. - CiphertextBlob []byte - - // Specifies the encryption context to use when decrypting the data. An encryption - // context is valid only for cryptographic operations - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) - // with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS - // uses do not support an encryption context. An encryption context is a collection - // of non-secret key-value pairs that represents additional authenticated data. - // When you use an encryption context to encrypt data, you must specify the same - // (an exact case-sensitive match) encryption context to decrypt the data. An - // encryption context is optional when encrypting with a symmetric CMK, but it is - // highly recommended. For more information, see Encryption Context - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) - // in the AWS Key Management Service Developer Guide. - EncryptionContext map[string]*string } type DecryptOutput struct { @@ -167,15 +167,15 @@ type DecryptOutput struct { // The encryption algorithm that was used to decrypt the ciphertext. EncryptionAlgorithm types.EncryptionAlgorithmSpec - // Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is - // Base64-encoded. Otherwise, it is not Base64-encoded. - Plaintext []byte - // The Amazon Resource Name (key ARN // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) // of the CMK that was used to decrypt the ciphertext. KeyId *string + // Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is + // Base64-encoded. Otherwise, it is not Base64-encoded. + Plaintext []byte + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kms/api_op_DescribeCustomKeyStores.go b/service/kms/api_op_DescribeCustomKeyStores.go index 1dbbc7e4c84..bbfa87bdf76 100644 --- a/service/kms/api_op_DescribeCustomKeyStores.go +++ b/service/kms/api_op_DescribeCustomKeyStores.go @@ -78,6 +78,13 @@ func (c *Client) DescribeCustomKeyStores(ctx context.Context, params *DescribeCu type DescribeCustomKeyStoresInput struct { + // Gets only information about the specified custom key store. Enter the key store + // ID. By default, this operation gets information about all custom key stores in + // the account and region. To limit the output to a particular custom key store, + // you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not + // both. + CustomKeyStoreId *string + // Gets only information about the specified custom key store. Enter the friendly // name of the custom key store. By default, this operation gets information about // all custom key stores in the account and region. To limit the output to a @@ -85,38 +92,31 @@ type DescribeCustomKeyStoresInput struct { // CustomKeyStoreName parameter, but not both. CustomKeyStoreName *string - // Use this parameter in a subsequent request after you receive a response with - // truncated results. Set it to the value of NextMarker from the truncated response - // you just received. - Marker *string - // Use this parameter to specify the maximum number of items to return. When this // value is present, AWS KMS does not return more than the specified number of // items, but it might return fewer. Limit *int32 - // Gets only information about the specified custom key store. Enter the key store - // ID. By default, this operation gets information about all custom key stores in - // the account and region. To limit the output to a particular custom key store, - // you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not - // both. - CustomKeyStoreId *string + // Use this parameter in a subsequent request after you receive a response with + // truncated results. Set it to the value of NextMarker from the truncated response + // you just received. + Marker *string } type DescribeCustomKeyStoresOutput struct { - // A flag that indicates whether there are more items in the list. When this value - // is true, the list in this response is truncated. To get more items, pass the - // value of the NextMarker element in thisresponse to the Marker parameter in a - // subsequent request. - Truncated *bool + // Contains metadata about each custom key store. + CustomKeyStores []*types.CustomKeyStoresListEntry // When Truncated is true, this element is present and contains the value to use // for the Marker parameter in a subsequent request. NextMarker *string - // Contains metadata about each custom key store. - CustomKeyStores []*types.CustomKeyStoresListEntry + // A flag that indicates whether there are more items in the list. When this value + // is true, the list in this response is truncated. To get more items, pass the + // value of the NextMarker element in thisresponse to the Marker parameter in a + // subsequent request. + Truncated *bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/kms/api_op_DescribeKey.go b/service/kms/api_op_DescribeKey.go index 216b4447e2d..799f47300d5 100644 --- a/service/kms/api_op_DescribeKey.go +++ b/service/kms/api_op_DescribeKey.go @@ -95,11 +95,6 @@ func (c *Client) DescribeKey(ctx context.Context, params *DescribeKeyInput, optF type DescribeKeyInput struct { - // A list of grant tokens. For more information, see Grant Tokens - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) - // in the AWS Key Management Service Developer Guide. - GrantTokens []*string - // Describes the specified customer master key (CMK). If you specify a predefined // AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS // managed CMK @@ -127,6 +122,11 @@ type DescribeKeyInput struct { // // This member is required. KeyId *string + + // A list of grant tokens. For more information, see Grant Tokens + // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) + // in the AWS Key Management Service Developer Guide. + GrantTokens []*string } type DescribeKeyOutput struct { diff --git a/service/kms/api_op_Encrypt.go b/service/kms/api_op_Encrypt.go index 4d35b9ba3e6..6dd8efd6773 100644 --- a/service/kms/api_op_Encrypt.go +++ b/service/kms/api_op_Encrypt.go @@ -114,11 +114,6 @@ func (c *Client) Encrypt(ctx context.Context, params *EncryptInput, optFns ...fu type EncryptInput struct { - // A list of grant tokens. For more information, see Grant Tokens - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) - // in the AWS Key Management Service Developer Guide. - GrantTokens []*string - // A unique identifier for the customer master key (CMK). To specify a CMK, use its // key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an // alias name, prefix it with "alias/". To specify a CMK in a different AWS @@ -143,6 +138,11 @@ type EncryptInput struct { // This member is required. KeyId *string + // Data to be encrypted. + // + // This member is required. + Plaintext []byte + // Specifies the encryption algorithm that AWS KMS will use to encrypt the // plaintext message. The algorithm must be compatible with the CMK that you // specify. This parameter is required only for asymmetric CMKs. The default value, @@ -164,19 +164,14 @@ type EncryptInput struct { // in the AWS Key Management Service Developer Guide. EncryptionContext map[string]*string - // Data to be encrypted. - // - // This member is required. - Plaintext []byte + // A list of grant tokens. For more information, see Grant Tokens + // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) + // in the AWS Key Management Service Developer Guide. + GrantTokens []*string } type EncryptOutput struct { - // The Amazon Resource Name (key ARN - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) - // of the CMK that was used to encrypt the plaintext. - KeyId *string - // The encrypted plaintext. When you use the HTTP API or the AWS CLI, the value is // Base64-encoded. Otherwise, it is not Base64-encoded. CiphertextBlob []byte @@ -184,6 +179,11 @@ type EncryptOutput struct { // The encryption algorithm that was used to encrypt the plaintext. EncryptionAlgorithm types.EncryptionAlgorithmSpec + // The Amazon Resource Name (key ARN + // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) + // of the CMK that was used to encrypt the plaintext. + KeyId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kms/api_op_GenerateDataKey.go b/service/kms/api_op_GenerateDataKey.go index 2a112fc09cd..65368968c77 100644 --- a/service/kms/api_op_GenerateDataKey.go +++ b/service/kms/api_op_GenerateDataKey.go @@ -113,24 +113,6 @@ func (c *Client) GenerateDataKey(ctx context.Context, params *GenerateDataKeyInp type GenerateDataKeyInput struct { - // Specifies the length of the data key in bytes. For example, use the value 64 to - // generate a 512-bit data key (64 bytes is 512 bits). For 128-bit (16-byte) and - // 256-bit (32-byte) data keys, use the KeySpec parameter. You must specify either - // the KeySpec or the NumberOfBytes parameter (but not both) in every - // GenerateDataKey request. - NumberOfBytes *int32 - - // Specifies the encryption context that will be used when encrypting the data key. - // An encryption context is a collection of non-secret key-value pairs that - // represents additional authenticated data. When you use an encryption context to - // encrypt data, you must specify the same (an exact case-sensitive match) - // encryption context to decrypt the data. An encryption context is optional when - // encrypting with a symmetric CMK, but it is highly recommended. For more - // information, see Encryption Context - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) - // in the AWS Key Management Service Developer Guide. - EncryptionContext map[string]*string - // Identifies the symmetric CMK that encrypts the data key.

    To specify a CMK, // use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using // an alias name, prefix it with "alias/". To specify a CMK in a @@ -147,6 +129,17 @@ type GenerateDataKeyInput struct { // This member is required. KeyId *string + // Specifies the encryption context that will be used when encrypting the data key. + // An encryption context is a collection of non-secret key-value pairs that + // represents additional authenticated data. When you use an encryption context to + // encrypt data, you must specify the same (an exact case-sensitive match) + // encryption context to decrypt the data. An encryption context is optional when + // encrypting with a symmetric CMK, but it is highly recommended. For more + // information, see Encryption Context + // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) + // in the AWS Key Management Service Developer Guide. + EncryptionContext map[string]*string + // A list of grant tokens. For more information, see Grant Tokens // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) // in the AWS Key Management Service Developer Guide. @@ -157,16 +150,17 @@ type GenerateDataKeyInput struct { // either the KeySpec or the NumberOfBytes parameter (but not both) in every // GenerateDataKey request. KeySpec types.DataKeySpec + + // Specifies the length of the data key in bytes. For example, use the value 64 to + // generate a 512-bit data key (64 bytes is 512 bits). For 128-bit (16-byte) and + // 256-bit (32-byte) data keys, use the KeySpec parameter. You must specify either + // the KeySpec or the NumberOfBytes parameter (but not both) in every + // GenerateDataKey request. + NumberOfBytes *int32 } type GenerateDataKeyOutput struct { - // The plaintext data key. When you use the HTTP API or the AWS CLI, the value is - // Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to - // encrypt your data outside of KMS. Then, remove it from memory as soon as - // possible. - Plaintext []byte - // The encrypted copy of the data key. When you use the HTTP API or the AWS CLI, // the value is Base64-encoded. Otherwise, it is not Base64-encoded. CiphertextBlob []byte @@ -176,6 +170,12 @@ type GenerateDataKeyOutput struct { // of the CMK that encrypted the data key. KeyId *string + // The plaintext data key. When you use the HTTP API or the AWS CLI, the value is + // Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to + // encrypt your data outside of KMS. Then, remove it from memory as soon as + // possible. + Plaintext []byte + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kms/api_op_GenerateDataKeyPair.go b/service/kms/api_op_GenerateDataKeyPair.go index 1903d7c763b..cd8ba35d726 100644 --- a/service/kms/api_op_GenerateDataKeyPair.go +++ b/service/kms/api_op_GenerateDataKeyPair.go @@ -89,22 +89,6 @@ func (c *Client) GenerateDataKeyPair(ctx context.Context, params *GenerateDataKe type GenerateDataKeyPairInput struct { - // Specifies the encryption context that will be used when encrypting the private - // key in the data key pair. An encryption context is a collection of non-secret - // key-value pairs that represents additional authenticated data. When you use an - // encryption context to encrypt data, you must specify the same (an exact - // case-sensitive match) encryption context to decrypt the data. An encryption - // context is optional when encrypting with a symmetric CMK, but it is highly - // recommended. For more information, see Encryption Context - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) - // in the AWS Key Management Service Developer Guide. - EncryptionContext map[string]*string - - // A list of grant tokens. For more information, see Grant Tokens - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) - // in the AWS Key Management Service Developer Guide. - GrantTokens []*string - // Specifies the symmetric CMK that encrypts the private key in the data key pair. // You cannot specify an asymmetric CMK or a CMK in a custom key store. To get the // type and origin of your CMK, use the DescribeKey () operation. To specify a CMK, @@ -138,14 +122,26 @@ type GenerateDataKeyPairInput struct { // // This member is required. KeyPairSpec types.DataKeyPairSpec + + // Specifies the encryption context that will be used when encrypting the private + // key in the data key pair. An encryption context is a collection of non-secret + // key-value pairs that represents additional authenticated data. When you use an + // encryption context to encrypt data, you must specify the same (an exact + // case-sensitive match) encryption context to decrypt the data. An encryption + // context is optional when encrypting with a symmetric CMK, but it is highly + // recommended. For more information, see Encryption Context + // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) + // in the AWS Key Management Service Developer Guide. + EncryptionContext map[string]*string + + // A list of grant tokens. For more information, see Grant Tokens + // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) + // in the AWS Key Management Service Developer Guide. + GrantTokens []*string } type GenerateDataKeyPairOutput struct { - // The encrypted copy of the private key. When you use the HTTP API or the AWS CLI, - // the value is Base64-encoded. Otherwise, it is not Base64-encoded. - PrivateKeyCiphertextBlob []byte - // The Amazon Resource Name (key ARN // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) // of the CMK that encrypted the private key. @@ -154,6 +150,10 @@ type GenerateDataKeyPairOutput struct { // The type of data key pair that was generated. KeyPairSpec types.DataKeyPairSpec + // The encrypted copy of the private key. When you use the HTTP API or the AWS CLI, + // the value is Base64-encoded. Otherwise, it is not Base64-encoded. + PrivateKeyCiphertextBlob []byte + // The plaintext copy of the private key. When you use the HTTP API or the AWS CLI, // the value is Base64-encoded. Otherwise, it is not Base64-encoded. PrivateKeyPlaintext []byte diff --git a/service/kms/api_op_GenerateDataKeyPairWithoutPlaintext.go b/service/kms/api_op_GenerateDataKeyPairWithoutPlaintext.go index e61dcd41260..88b14e7de11 100644 --- a/service/kms/api_op_GenerateDataKeyPairWithoutPlaintext.go +++ b/service/kms/api_op_GenerateDataKeyPairWithoutPlaintext.go @@ -134,14 +134,14 @@ type GenerateDataKeyPairWithoutPlaintextInput struct { type GenerateDataKeyPairWithoutPlaintextOutput struct { - // The type of data key pair that was generated. - KeyPairSpec types.DataKeyPairSpec - // The Amazon Resource Name (key ARN // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) // of the CMK that encrypted the private key. KeyId *string + // The type of data key pair that was generated. + KeyPairSpec types.DataKeyPairSpec + // The encrypted copy of the private key. When you use the HTTP API or the AWS CLI, // the value is Base64-encoded. Otherwise, it is not Base64-encoded. PrivateKeyCiphertextBlob []byte diff --git a/service/kms/api_op_GenerateDataKeyWithoutPlaintext.go b/service/kms/api_op_GenerateDataKeyWithoutPlaintext.go index d2e78065ffa..95da45114fd 100644 --- a/service/kms/api_op_GenerateDataKeyWithoutPlaintext.go +++ b/service/kms/api_op_GenerateDataKeyWithoutPlaintext.go @@ -90,17 +90,6 @@ func (c *Client) GenerateDataKeyWithoutPlaintext(ctx context.Context, params *Ge type GenerateDataKeyWithoutPlaintextInput struct { - // Specifies the encryption context that will be used when encrypting the data key. - // An encryption context is a collection of non-secret key-value pairs that - // represents additional authenticated data. When you use an encryption context to - // encrypt data, you must specify the same (an exact case-sensitive match) - // encryption context to decrypt the data. An encryption context is optional when - // encrypting with a symmetric CMK, but it is highly recommended. For more - // information, see Encryption Context - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) - // in the AWS Key Management Service Developer Guide. - EncryptionContext map[string]*string - // The identifier of the symmetric customer master key (CMK) that encrypts the data // key. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, // or alias ARN. When using an alias name, prefix it with "alias/". To specify a @@ -125,6 +114,17 @@ type GenerateDataKeyWithoutPlaintextInput struct { // This member is required. KeyId *string + // Specifies the encryption context that will be used when encrypting the data key. + // An encryption context is a collection of non-secret key-value pairs that + // represents additional authenticated data. When you use an encryption context to + // encrypt data, you must specify the same (an exact case-sensitive match) + // encryption context to decrypt the data. An encryption context is optional when + // encrypting with a symmetric CMK, but it is highly recommended. For more + // information, see Encryption Context + // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) + // in the AWS Key Management Service Developer Guide. + EncryptionContext map[string]*string + // A list of grant tokens. For more information, see Grant Tokens // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) // in the AWS Key Management Service Developer Guide. @@ -143,15 +143,15 @@ type GenerateDataKeyWithoutPlaintextInput struct { type GenerateDataKeyWithoutPlaintextOutput struct { + // The encrypted data key. When you use the HTTP API or the AWS CLI, the value is + // Base64-encoded. Otherwise, it is not Base64-encoded. + CiphertextBlob []byte + // The Amazon Resource Name (key ARN // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) // of the CMK that encrypted the data key. KeyId *string - // The encrypted data key. When you use the HTTP API or the AWS CLI, the value is - // Base64-encoded. Otherwise, it is not Base64-encoded. - CiphertextBlob []byte - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kms/api_op_GenerateRandom.go b/service/kms/api_op_GenerateRandom.go index d7a28195849..bd6a9e4f50e 100644 --- a/service/kms/api_op_GenerateRandom.go +++ b/service/kms/api_op_GenerateRandom.go @@ -61,15 +61,15 @@ func (c *Client) GenerateRandom(ctx context.Context, params *GenerateRandomInput type GenerateRandomInput struct { - // The length of the byte string. - NumberOfBytes *int32 - // Generates the random byte string in the AWS CloudHSM cluster that is associated // with the specified custom key store // (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html). // To find the ID of a custom key store, use the DescribeCustomKeyStores () // operation. CustomKeyStoreId *string + + // The length of the byte string. + NumberOfBytes *int32 } type GenerateRandomOutput struct { diff --git a/service/kms/api_op_GetKeyPolicy.go b/service/kms/api_op_GetKeyPolicy.go index 3045cddcbde..56eda6fc5a9 100644 --- a/service/kms/api_op_GetKeyPolicy.go +++ b/service/kms/api_op_GetKeyPolicy.go @@ -57,12 +57,6 @@ func (c *Client) GetKeyPolicy(ctx context.Context, params *GetKeyPolicyInput, op type GetKeyPolicyInput struct { - // Specifies the name of the key policy. The only valid name is default. To get the - // names of key policies, use ListKeyPolicies (). - // - // This member is required. - PolicyName *string - // A unique identifier for the customer master key (CMK). Specify the key ID or the // Amazon Resource Name (ARN) of the CMK. For example: // @@ -77,6 +71,12 @@ type GetKeyPolicyInput struct { // // This member is required. KeyId *string + + // Specifies the name of the key policy. The only valid name is default. To get the + // names of key policies, use ListKeyPolicies (). + // + // This member is required. + PolicyName *string } type GetKeyPolicyOutput struct { diff --git a/service/kms/api_op_GetParametersForImport.go b/service/kms/api_op_GetParametersForImport.go index d5ae08ec4eb..be468433a02 100644 --- a/service/kms/api_op_GetParametersForImport.go +++ b/service/kms/api_op_GetParametersForImport.go @@ -78,12 +78,6 @@ func (c *Client) GetParametersForImport(ctx context.Context, params *GetParamete type GetParametersForImportInput struct { - // The type of wrapping key (public key) to return in the response. Only 2048-bit - // RSA public keys are supported. - // - // This member is required. - WrappingKeySpec types.WrappingKeySpec - // The identifier of the symmetric CMK into which you will import key material. The // Origin of the CMK must be EXTERNAL. Specify the key ID or the Amazon Resource // Name (ARN) of the CMK. For example: @@ -107,28 +101,34 @@ type GetParametersForImportInput struct { // // This member is required. WrappingAlgorithm types.AlgorithmSpec + + // The type of wrapping key (public key) to return in the response. Only 2048-bit + // RSA public keys are supported. + // + // This member is required. + WrappingKeySpec types.WrappingKeySpec } type GetParametersForImportOutput struct { + // The import token to send in a subsequent ImportKeyMaterial () request. + ImportToken []byte + // The Amazon Resource Name (key ARN // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) // of the CMK to use in a subsequent ImportKeyMaterial () request. This is the same // CMK specified in the GetParametersForImport request. KeyId *string - // The import token to send in a subsequent ImportKeyMaterial () request. - ImportToken []byte - - // The public key to use to encrypt the key material before importing it with - // ImportKeyMaterial (). - PublicKey []byte - // The time at which the import token and public key are no longer valid. After // this time, you cannot use them to make an ImportKeyMaterial () request and you // must send another GetParametersForImport request to get new ones. ParametersValidTo *time.Time + // The public key to use to encrypt the key material before importing it with + // ImportKeyMaterial (). + PublicKey []byte + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kms/api_op_GetPublicKey.go b/service/kms/api_op_GetPublicKey.go index 2b972c05af2..a35681896ce 100644 --- a/service/kms/api_op_GetPublicKey.go +++ b/service/kms/api_op_GetPublicKey.go @@ -119,6 +119,21 @@ type GetPublicKeyInput struct { type GetPublicKeyOutput struct { + // The type of the of the public key that was downloaded. + CustomerMasterKeySpec types.CustomerMasterKeySpec + + // The encryption algorithms that AWS KMS supports for this key. This information + // is critical. If a public key encrypts data outside of AWS KMS by using an + // unsupported encryption algorithm, the ciphertext cannot be decrypted. This field + // appears in the response only when the KeyUsage of the public key is + // ENCRYPT_DECRYPT. + EncryptionAlgorithms []types.EncryptionAlgorithmSpec + + // The Amazon Resource Name (key ARN + // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) + // of the asymmetric CMK from which the public key was downloaded. + KeyId *string + // The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or // SIGN_VERIFY. This information is critical. If a public key with SIGN_VERIFY key // usage encrypts data outside of AWS KMS, the ciphertext cannot be decrypted. @@ -130,25 +145,10 @@ type GetPublicKeyOutput struct { // the value is Base64-encoded. Otherwise, it is not Base64-encoded. PublicKey []byte - // The type of the of the public key that was downloaded. - CustomerMasterKeySpec types.CustomerMasterKeySpec - // The signing algorithms that AWS KMS supports for this key. This field appears in // the response only when the KeyUsage of the public key is SIGN_VERIFY. SigningAlgorithms []types.SigningAlgorithmSpec - // The Amazon Resource Name (key ARN - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) - // of the asymmetric CMK from which the public key was downloaded. - KeyId *string - - // The encryption algorithms that AWS KMS supports for this key. This information - // is critical. If a public key encrypts data outside of AWS KMS by using an - // unsupported encryption algorithm, the ciphertext cannot be decrypted. This field - // appears in the response only when the KeyUsage of the public key is - // ENCRYPT_DECRYPT. - EncryptionAlgorithms []types.EncryptionAlgorithmSpec - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kms/api_op_ImportKeyMaterial.go b/service/kms/api_op_ImportKeyMaterial.go index c5a6fa5f81f..9c0bf1fe892 100644 --- a/service/kms/api_op_ImportKeyMaterial.go +++ b/service/kms/api_op_ImportKeyMaterial.go @@ -104,6 +104,14 @@ func (c *Client) ImportKeyMaterial(ctx context.Context, params *ImportKeyMateria type ImportKeyMaterialInput struct { + // The encrypted key material to import. The key material must be encrypted with + // the public wrapping key that GetParametersForImport () returned, using the + // wrapping algorithm that you specified in the same GetParametersForImport + // request. + // + // This member is required. + EncryptedKeyMaterial []byte + // The import token that you received in the response to a previous // GetParametersForImport () request. It must be from the same response that // contained the public key that you used to encrypt the key material. @@ -128,14 +136,6 @@ type ImportKeyMaterialInput struct { // This member is required. KeyId *string - // The encrypted key material to import. The key material must be encrypted with - // the public wrapping key that GetParametersForImport () returned, using the - // wrapping algorithm that you specified in the same GetParametersForImport - // request. - // - // This member is required. - EncryptedKeyMaterial []byte - // Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES, // in which case you must include the ValidTo parameter. When this parameter is set // to KEY_MATERIAL_DOES_NOT_EXPIRE, you must omit the ValidTo parameter. diff --git a/service/kms/api_op_ListAliases.go b/service/kms/api_op_ListAliases.go index 999b811057b..0e5ecf03f6a 100644 --- a/service/kms/api_op_ListAliases.go +++ b/service/kms/api_op_ListAliases.go @@ -75,28 +75,28 @@ type ListAliasesInput struct { // region. KeyId *string - // Use this parameter in a subsequent request after you receive a response with - // truncated results. Set it to the value of NextMarker from the truncated response - // you just received. - Marker *string - // Use this parameter to specify the maximum number of items to return. When this // value is present, AWS KMS does not return more than the specified number of // items, but it might return fewer. This value is optional. If you include a // value, it must be between 1 and 100, inclusive. If you do not include a value, // it defaults to 50. Limit *int32 + + // Use this parameter in a subsequent request after you receive a response with + // truncated results. Set it to the value of NextMarker from the truncated response + // you just received. + Marker *string } type ListAliasesOutput struct { + // A list of aliases. + Aliases []*types.AliasListEntry + // When Truncated is true, this element is present and contains the value to use // for the Marker parameter in a subsequent request. NextMarker *string - // A list of aliases. - Aliases []*types.AliasListEntry - // A flag that indicates whether there are more items in the list. When this value // is true, the list in this response is truncated. To get more items, pass the // value of the NextMarker element in thisresponse to the Marker parameter in a diff --git a/service/kms/api_op_ListGrants.go b/service/kms/api_op_ListGrants.go index 679631cf7d6..2b16459eca9 100644 --- a/service/kms/api_op_ListGrants.go +++ b/service/kms/api_op_ListGrants.go @@ -64,11 +64,6 @@ func (c *Client) ListGrants(ctx context.Context, params *ListGrantsInput, optFns type ListGrantsInput struct { - // Use this parameter in a subsequent request after you receive a response with - // truncated results. Set it to the value of NextMarker from the truncated response - // you just received. - Marker *string - // A unique identifier for the customer master key (CMK). Specify the key ID or the // Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS // account, you must use the key ARN. For example: @@ -91,6 +86,11 @@ type ListGrantsInput struct { // value, it must be between 1 and 100, inclusive. If you do not include a value, // it defaults to 50. Limit *int32 + + // Use this parameter in a subsequent request after you receive a response with + // truncated results. Set it to the value of NextMarker from the truncated response + // you just received. + Marker *string } type ListGrantsOutput struct { diff --git a/service/kms/api_op_ListKeyPolicies.go b/service/kms/api_op_ListKeyPolicies.go index a804cea3046..48b0ab0c8d4 100644 --- a/service/kms/api_op_ListKeyPolicies.go +++ b/service/kms/api_op_ListKeyPolicies.go @@ -59,13 +59,6 @@ func (c *Client) ListKeyPolicies(ctx context.Context, params *ListKeyPoliciesInp type ListKeyPoliciesInput struct { - // Use this parameter to specify the maximum number of items to return. When this - // value is present, AWS KMS does not return more than the specified number of - // items, but it might return fewer. This value is optional. If you include a - // value, it must be between 1 and 1000, inclusive. If you do not include a value, - // it defaults to 100. Only one policy can be attached to a key. - Limit *int32 - // A unique identifier for the customer master key (CMK). Specify the key ID or the // Amazon Resource Name (ARN) of the CMK. For example: // @@ -81,6 +74,13 @@ type ListKeyPoliciesInput struct { // This member is required. KeyId *string + // Use this parameter to specify the maximum number of items to return. When this + // value is present, AWS KMS does not return more than the specified number of + // items, but it might return fewer. This value is optional. If you include a + // value, it must be between 1 and 1000, inclusive. If you do not include a value, + // it defaults to 100. Only one policy can be attached to a key. + Limit *int32 + // Use this parameter in a subsequent request after you receive a response with // truncated results. Set it to the value of NextMarker from the truncated response // you just received. @@ -89,6 +89,10 @@ type ListKeyPoliciesInput struct { type ListKeyPoliciesOutput struct { + // When Truncated is true, this element is present and contains the value to use + // for the Marker parameter in a subsequent request. + NextMarker *string + // A list of key policy names. The only valid value is default. PolicyNames []*string @@ -98,10 +102,6 @@ type ListKeyPoliciesOutput struct { // subsequent request. Truncated *bool - // When Truncated is true, this element is present and contains the value to use - // for the Marker parameter in a subsequent request. - NextMarker *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kms/api_op_ListKeys.go b/service/kms/api_op_ListKeys.go index 6571ed9fbab..ce3c1cc66ee 100644 --- a/service/kms/api_op_ListKeys.go +++ b/service/kms/api_op_ListKeys.go @@ -57,21 +57,24 @@ func (c *Client) ListKeys(ctx context.Context, params *ListKeysInput, optFns ... type ListKeysInput struct { - // Use this parameter in a subsequent request after you receive a response with - // truncated results. Set it to the value of NextMarker from the truncated response - // you just received. - Marker *string - // Use this parameter to specify the maximum number of items to return. When this // value is present, AWS KMS does not return more than the specified number of // items, but it might return fewer. This value is optional. If you include a // value, it must be between 1 and 1000, inclusive. If you do not include a value, // it defaults to 100. Limit *int32 + + // Use this parameter in a subsequent request after you receive a response with + // truncated results. Set it to the value of NextMarker from the truncated response + // you just received. + Marker *string } type ListKeysOutput struct { + // A list of customer master keys (CMKs). + Keys []*types.KeyListEntry + // When Truncated is true, this element is present and contains the value to use // for the Marker parameter in a subsequent request. NextMarker *string @@ -82,9 +85,6 @@ type ListKeysOutput struct { // subsequent request. Truncated *bool - // A list of customer master keys (CMKs). - Keys []*types.KeyListEntry - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kms/api_op_ListResourceTags.go b/service/kms/api_op_ListResourceTags.go index 4236d258dbe..9a5f03fc248 100644 --- a/service/kms/api_op_ListResourceTags.go +++ b/service/kms/api_op_ListResourceTags.go @@ -58,13 +58,6 @@ func (c *Client) ListResourceTags(ctx context.Context, params *ListResourceTagsI type ListResourceTagsInput struct { - // Use this parameter to specify the maximum number of items to return. When this - // value is present, AWS KMS does not return more than the specified number of - // items, but it might return fewer. This value is optional. If you include a - // value, it must be between 1 and 50, inclusive. If you do not include a value, it - // defaults to 50. - Limit *int32 - // A unique identifier for the customer master key (CMK). Specify the key ID or the // Amazon Resource Name (ARN) of the CMK. For example: // @@ -80,6 +73,13 @@ type ListResourceTagsInput struct { // This member is required. KeyId *string + // Use this parameter to specify the maximum number of items to return. When this + // value is present, AWS KMS does not return more than the specified number of + // items, but it might return fewer. This value is optional. If you include a + // value, it must be between 1 and 50, inclusive. If you do not include a value, it + // defaults to 50. + Limit *int32 + // Use this parameter in a subsequent request after you receive a response with // truncated results. Set it to the value of NextMarker from the truncated response // you just received. Do not attempt to construct this value. Use only the value of @@ -94,15 +94,15 @@ type ListResourceTagsOutput struct { // information from this value. NextMarker *string + // A list of tags. Each tag consists of a tag key and a tag value. + Tags []*types.Tag + // A flag that indicates whether there are more items in the list. When this value // is true, the list in this response is truncated. To get more items, pass the // value of the NextMarker element in thisresponse to the Marker parameter in a // subsequent request. Truncated *bool - // A list of tags. Each tag consists of a tag key and a tag value. - Tags []*types.Tag - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kms/api_op_ListRetirableGrants.go b/service/kms/api_op_ListRetirableGrants.go index 8d729b8a90c..2662c4ae315 100644 --- a/service/kms/api_op_ListRetirableGrants.go +++ b/service/kms/api_op_ListRetirableGrants.go @@ -59,18 +59,6 @@ func (c *Client) ListRetirableGrants(ctx context.Context, params *ListRetirableG type ListRetirableGrantsInput struct { - // Use this parameter to specify the maximum number of items to return. When this - // value is present, AWS KMS does not return more than the specified number of - // items, but it might return fewer. This value is optional. If you include a - // value, it must be between 1 and 100, inclusive. If you do not include a value, - // it defaults to 50. - Limit *int32 - - // Use this parameter in a subsequent request after you receive a response with - // truncated results. Set it to the value of NextMarker from the truncated response - // you just received. - Marker *string - // The retiring principal for which to list grants. To specify the retiring // principal, use the Amazon Resource Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of @@ -82,6 +70,18 @@ type ListRetirableGrantsInput struct { // // This member is required. RetiringPrincipal *string + + // Use this parameter to specify the maximum number of items to return. When this + // value is present, AWS KMS does not return more than the specified number of + // items, but it might return fewer. This value is optional. If you include a + // value, it must be between 1 and 100, inclusive. If you do not include a value, + // it defaults to 50. + Limit *int32 + + // Use this parameter in a subsequent request after you receive a response with + // truncated results. Set it to the value of NextMarker from the truncated response + // you just received. + Marker *string } type ListRetirableGrantsOutput struct { diff --git a/service/kms/api_op_PutKeyPolicy.go b/service/kms/api_op_PutKeyPolicy.go index cc1937e9349..a976f258cfe 100644 --- a/service/kms/api_op_PutKeyPolicy.go +++ b/service/kms/api_op_PutKeyPolicy.go @@ -75,16 +75,6 @@ type PutKeyPolicyInput struct { // This member is required. KeyId *string - // A flag to indicate whether to bypass the key policy lockout safety check. - // Setting this value to true increases the risk that the CMK becomes unmanageable. - // Do not set this value to true indiscriminately. For more information, refer to - // the scenario in the Default Key Policy - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) - // section in the AWS Key Management Service Developer Guide. Use this parameter - // only when you intend to prevent the principal that is making the request from - // making a subsequent PutKeyPolicy request on the CMK. The default value is false. - BypassPolicyLockoutSafetyCheck *bool - // The key policy to attach to the CMK. The key policy must meet the following // criteria: // @@ -118,6 +108,16 @@ type PutKeyPolicyInput struct { // // This member is required. PolicyName *string + + // A flag to indicate whether to bypass the key policy lockout safety check. + // Setting this value to true increases the risk that the CMK becomes unmanageable. + // Do not set this value to true indiscriminately. For more information, refer to + // the scenario in the Default Key Policy + // (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) + // section in the AWS Key Management Service Developer Guide. Use this parameter + // only when you intend to prevent the principal that is making the request from + // making a subsequent PutKeyPolicy request on the CMK. The default value is false. + BypassPolicyLockoutSafetyCheck *bool } type PutKeyPolicyOutput struct { diff --git a/service/kms/api_op_ReEncrypt.go b/service/kms/api_op_ReEncrypt.go index 05ad0fe86cb..4ab9d8fa63f 100644 --- a/service/kms/api_op_ReEncrypt.go +++ b/service/kms/api_op_ReEncrypt.go @@ -122,6 +122,38 @@ type ReEncryptInput struct { // This member is required. CiphertextBlob []byte + // A unique identifier for the CMK that is used to reencrypt the data. Specify a + // symmetric or asymmetric CMK with a KeyUsage value of ENCRYPT_DECRYPT. To find + // the KeyUsage value of a CMK, use the DescribeKey () operation. To specify a CMK, + // use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using + // an alias name, prefix it with "alias/". To specify a CMK in a different AWS + // account, you must use the key ARN or alias ARN. For example: + // + // * Key ID: + // 1234abcd-12ab-34cd-56ef-1234567890ab + // + // * Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // + // + // * Alias name: alias/ExampleAlias + // + // * Alias ARN: + // arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias + // + // To get the key ID and key + // ARN for a CMK, use ListKeys () or DescribeKey (). To get the alias name and + // alias ARN, use ListAliases (). + // + // This member is required. + DestinationKeyId *string + + // Specifies the encryption algorithm that AWS KMS will use to reecrypt the data + // after it has decrypted it. The default value, SYMMETRIC_DEFAULT, represents the + // encryption algorithm used for symmetric CMKs. This parameter is required only + // when the destination CMK is an asymmetric CMK. + DestinationEncryptionAlgorithm types.EncryptionAlgorithmSpec + // Specifies that encryption context to use when the reencrypting the data. A // destination encryption context is valid only when the destination CMK is a // symmetric CMK. The standard ciphertext format for asymmetric CMKs does not @@ -135,6 +167,30 @@ type ReEncryptInput struct { // in the AWS Key Management Service Developer Guide. DestinationEncryptionContext map[string]*string + // A list of grant tokens. For more information, see Grant Tokens + // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) + // in the AWS Key Management Service Developer Guide. + GrantTokens []*string + + // Specifies the encryption algorithm that AWS KMS will use to decrypt the + // ciphertext before it is reencrypted. The default value, SYMMETRIC_DEFAULT, + // represents the algorithm used for symmetric CMKs. Specify the same algorithm + // that was used to encrypt the ciphertext. If you specify a different algorithm, + // the decrypt attempt fails. This parameter is required only when the ciphertext + // was encrypted under an asymmetric CMK. + SourceEncryptionAlgorithm types.EncryptionAlgorithmSpec + + // Specifies the encryption context to use to decrypt the ciphertext. Enter the + // same encryption context that was used to encrypt the ciphertext. An encryption + // context is a collection of non-secret key-value pairs that represents additional + // authenticated data. When you use an encryption context to encrypt data, you must + // specify the same (an exact case-sensitive match) encryption context to decrypt + // the data. An encryption context is optional when encrypting with a symmetric + // CMK, but it is highly recommended. For more information, see Encryption Context + // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) + // in the AWS Key Management Service Developer Guide. + SourceEncryptionContext map[string]*string + // A unique identifier for the CMK that is used to decrypt the ciphertext before it // reencrypts it using the destination CMK. This parameter is required only when // the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses @@ -154,74 +210,10 @@ type ReEncryptInput struct { // or DescribeKey. To get the alias name and alias ARN, use // ListAliases.

    SourceKeyId *string - - // A list of grant tokens. For more information, see Grant Tokens - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) - // in the AWS Key Management Service Developer Guide. - GrantTokens []*string - - // Specifies the encryption algorithm that AWS KMS will use to reecrypt the data - // after it has decrypted it. The default value, SYMMETRIC_DEFAULT, represents the - // encryption algorithm used for symmetric CMKs. This parameter is required only - // when the destination CMK is an asymmetric CMK. - DestinationEncryptionAlgorithm types.EncryptionAlgorithmSpec - - // Specifies the encryption context to use to decrypt the ciphertext. Enter the - // same encryption context that was used to encrypt the ciphertext. An encryption - // context is a collection of non-secret key-value pairs that represents additional - // authenticated data. When you use an encryption context to encrypt data, you must - // specify the same (an exact case-sensitive match) encryption context to decrypt - // the data. An encryption context is optional when encrypting with a symmetric - // CMK, but it is highly recommended. For more information, see Encryption Context - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) - // in the AWS Key Management Service Developer Guide. - SourceEncryptionContext map[string]*string - - // Specifies the encryption algorithm that AWS KMS will use to decrypt the - // ciphertext before it is reencrypted. The default value, SYMMETRIC_DEFAULT, - // represents the algorithm used for symmetric CMKs. Specify the same algorithm - // that was used to encrypt the ciphertext. If you specify a different algorithm, - // the decrypt attempt fails. This parameter is required only when the ciphertext - // was encrypted under an asymmetric CMK. - SourceEncryptionAlgorithm types.EncryptionAlgorithmSpec - - // A unique identifier for the CMK that is used to reencrypt the data. Specify a - // symmetric or asymmetric CMK with a KeyUsage value of ENCRYPT_DECRYPT. To find - // the KeyUsage value of a CMK, use the DescribeKey () operation. To specify a CMK, - // use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using - // an alias name, prefix it with "alias/". To specify a CMK in a different AWS - // account, you must use the key ARN or alias ARN. For example: - // - // * Key ID: - // 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // - // * Alias name: alias/ExampleAlias - // - // * Alias ARN: - // arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias - // - // To get the key ID and key - // ARN for a CMK, use ListKeys () or DescribeKey (). To get the alias name and - // alias ARN, use ListAliases (). - // - // This member is required. - DestinationKeyId *string } type ReEncryptOutput struct { - // The Amazon Resource Name (key ARN - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) - // of the CMK that was used to reencrypt the data. - KeyId *string - - // Unique identifier of the CMK used to originally encrypt the data. - SourceKeyId *string - // The reencrypted data. When you use the HTTP API or the AWS CLI, the value is // Base64-encoded. Otherwise, it is not Base64-encoded. CiphertextBlob []byte @@ -229,10 +221,18 @@ type ReEncryptOutput struct { // The encryption algorithm that was used to reencrypt the data. DestinationEncryptionAlgorithm types.EncryptionAlgorithmSpec + // The Amazon Resource Name (key ARN + // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) + // of the CMK that was used to reencrypt the data. + KeyId *string + // The encryption algorithm that was used to decrypt the ciphertext before it was // reencrypted. SourceEncryptionAlgorithm types.EncryptionAlgorithmSpec + // Unique identifier of the CMK used to originally encrypt the data. + SourceKeyId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kms/api_op_RetireGrant.go b/service/kms/api_op_RetireGrant.go index 4f0a53c4c2d..f23530f3edb 100644 --- a/service/kms/api_op_RetireGrant.go +++ b/service/kms/api_op_RetireGrant.go @@ -72,6 +72,13 @@ func (c *Client) RetireGrant(ctx context.Context, params *RetireGrantInput, optF type RetireGrantInput struct { + // Unique identifier of the grant to retire. The grant ID is returned in the + // response to a CreateGrant operation. + // + // * Grant ID Example - + // 0123456789012345678901234567890123456789012345678901234567890123 + GrantId *string + // Token that identifies the grant to be retired. GrantToken *string @@ -79,13 +86,6 @@ type RetireGrantInput struct { // example: // arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab KeyId *string - - // Unique identifier of the grant to retire. The grant ID is returned in the - // response to a CreateGrant operation. - // - // * Grant ID Example - - // 0123456789012345678901234567890123456789012345678901234567890123 - GrantId *string } type RetireGrantOutput struct { diff --git a/service/kms/api_op_ScheduleKeyDeletion.go b/service/kms/api_op_ScheduleKeyDeletion.go index 9c89bed968b..ce434517000 100644 --- a/service/kms/api_op_ScheduleKeyDeletion.go +++ b/service/kms/api_op_ScheduleKeyDeletion.go @@ -102,14 +102,14 @@ type ScheduleKeyDeletionInput struct { type ScheduleKeyDeletionOutput struct { + // The date and time after which AWS KMS deletes the customer master key (CMK). + DeletionDate *time.Time + // The Amazon Resource Name (key ARN // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) // of the CMK whose deletion is scheduled. KeyId *string - // The date and time after which AWS KMS deletes the customer master key (CMK). - DeletionDate *time.Time - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kms/api_op_Sign.go b/service/kms/api_op_Sign.go index c20717a8a7d..84c8414f833 100644 --- a/service/kms/api_op_Sign.go +++ b/service/kms/api_op_Sign.go @@ -112,6 +112,13 @@ type SignInput struct { // This member is required. KeyId *string + // Specifies the message or message digest to sign. Messages can be 0-4096 bytes. + // To sign a larger message, provide the message digest. If you provide a message, + // AWS KMS generates a hash digest of the message and then signs it. + // + // This member is required. + Message []byte + // Specifies the signing algorithm to use when signing the message. Choose an // algorithm that is compatible with the type and size of the specified asymmetric // CMK. @@ -128,19 +135,14 @@ type SignInput struct { // digest. The default value, RAW, indicates a message. To indicate a message // digest, enter DIGEST. MessageType types.MessageType - - // Specifies the message or message digest to sign. Messages can be 0-4096 bytes. - // To sign a larger message, provide the message digest. If you provide a message, - // AWS KMS generates a hash digest of the message and then signs it. - // - // This member is required. - Message []byte } type SignOutput struct { - // The signing algorithm that was used to sign the message. - SigningAlgorithm types.SigningAlgorithmSpec + // The Amazon Resource Name (key ARN + // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) + // of the asymmetric CMK that was used to sign the message. + KeyId *string // The cryptographic signature that was generated for the message. // @@ -159,10 +161,8 @@ type SignOutput struct { // Base64-encoded. Signature []byte - // The Amazon Resource Name (key ARN - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) - // of the asymmetric CMK that was used to sign the message. - KeyId *string + // The signing algorithm that was used to sign the message. + SigningAlgorithm types.SigningAlgorithmSpec // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/kms/api_op_UpdateAlias.go b/service/kms/api_op_UpdateAlias.go index 27a60bd4442..b2229559ea5 100644 --- a/service/kms/api_op_UpdateAlias.go +++ b/service/kms/api_op_UpdateAlias.go @@ -74,6 +74,13 @@ func (c *Client) UpdateAlias(ctx context.Context, params *UpdateAliasInput, optF type UpdateAliasInput struct { + // Identifies the alias that is changing its CMK. This value must begin with alias/ + // followed by the alias name, such as alias/ExampleAlias. You cannot use + // UpdateAlias to change the alias name. + // + // This member is required. + AliasName *string + // Identifies the CMK to associate with the alias. When the update operation // completes, the alias will point to this CMK. The CMK must be in the same AWS // account and Region as the alias. Also, the new target CMK must be the same type @@ -93,13 +100,6 @@ type UpdateAliasInput struct { // // This member is required. TargetKeyId *string - - // Identifies the alias that is changing its CMK. This value must begin with alias/ - // followed by the alias name, such as alias/ExampleAlias. You cannot use - // UpdateAlias to change the alias name. - // - // This member is required. - AliasName *string } type UpdateAliasOutput struct { diff --git a/service/kms/api_op_UpdateCustomKeyStore.go b/service/kms/api_op_UpdateCustomKeyStore.go index b5311aa4178..4db728a01e4 100644 --- a/service/kms/api_op_UpdateCustomKeyStore.go +++ b/service/kms/api_op_UpdateCustomKeyStore.go @@ -89,6 +89,13 @@ func (c *Client) UpdateCustomKeyStore(ctx context.Context, params *UpdateCustomK type UpdateCustomKeyStoreInput struct { + // Identifies the custom key store that you want to update. Enter the ID of the + // custom key store. To find the ID of a custom key store, use the + // DescribeCustomKeyStores () operation. + // + // This member is required. + CustomKeyStoreId *string + // Associates the custom key store with a related AWS CloudHSM cluster. Enter the // cluster ID of the cluster that you used to create the custom key store or a // cluster that shares a backup history and has the same cluster certificate as the @@ -102,22 +109,15 @@ type UpdateCustomKeyStoreInput struct { // operation. CloudHsmClusterId *string - // Identifies the custom key store that you want to update. Enter the ID of the - // custom key store. To find the ID of a custom key store, use the - // DescribeCustomKeyStores () operation. - // - // This member is required. - CustomKeyStoreId *string - - // Changes the friendly name of the custom key store to the value that you specify. - // The custom key store name must be unique in the AWS account. - NewCustomKeyStoreName *string - // Enter the current password of the kmsuser crypto user (CU) in the AWS CloudHSM // cluster that is associated with the custom key store. This parameter tells AWS // KMS the current password of the kmsuser crypto user (CU). It does not set or // change the password of any users in the AWS CloudHSM cluster. KeyStorePassword *string + + // Changes the friendly name of the custom key store to the value that you specify. + // The custom key store name must be unique in the AWS account. + NewCustomKeyStoreName *string } type UpdateCustomKeyStoreOutput struct { diff --git a/service/kms/api_op_Verify.go b/service/kms/api_op_Verify.go index 77a558eb781..163c6ffd416 100644 --- a/service/kms/api_op_Verify.go +++ b/service/kms/api_op_Verify.go @@ -80,33 +80,6 @@ func (c *Client) Verify(ctx context.Context, params *VerifyInput, optFns ...func type VerifyInput struct { - // Tells AWS KMS whether the value of the Message parameter is a message or message - // digest. The default value, RAW, indicates a message. To indicate a message - // digest, enter DIGEST. Use the DIGEST value only when the value of the Message - // parameter is a message digest. If you use the DIGEST value with a raw message, - // the security of the verification operation can be compromised. - MessageType types.MessageType - - // Specifies the message that was signed. You can submit a raw message of up to - // 4096 bytes, or a hash digest of the message. If you submit a digest, use the - // MessageType parameter with a value of DIGEST. If the message specified here is - // different from the message that was signed, the signature verification fails. A - // message and its hash digest are considered to be the same message. - // - // This member is required. - Message []byte - - // The signing algorithm that was used to sign the message. If you submit a - // different algorithm, the signature verification fails. - // - // This member is required. - SigningAlgorithm types.SigningAlgorithmSpec - - // A list of grant tokens. For more information, see Grant Tokens - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) - // in the AWS Key Management Service Developer Guide. - GrantTokens []*string - // Identifies the asymmetric CMK that will be used to verify the signature. This // must be the same CMK that was used to generate the signature. If you specify a // different CMK, the signature verification fails.

    To specify a CMK, use its @@ -125,10 +98,37 @@ type VerifyInput struct { // This member is required. KeyId *string + // Specifies the message that was signed. You can submit a raw message of up to + // 4096 bytes, or a hash digest of the message. If you submit a digest, use the + // MessageType parameter with a value of DIGEST. If the message specified here is + // different from the message that was signed, the signature verification fails. A + // message and its hash digest are considered to be the same message. + // + // This member is required. + Message []byte + // The signature that the Sign operation generated. // // This member is required. Signature []byte + + // The signing algorithm that was used to sign the message. If you submit a + // different algorithm, the signature verification fails. + // + // This member is required. + SigningAlgorithm types.SigningAlgorithmSpec + + // A list of grant tokens. For more information, see Grant Tokens + // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) + // in the AWS Key Management Service Developer Guide. + GrantTokens []*string + + // Tells AWS KMS whether the value of the Message parameter is a message or message + // digest. The default value, RAW, indicates a message. To indicate a message + // digest, enter DIGEST. Use the DIGEST value only when the value of the Message + // parameter is a message digest. If you use the DIGEST value with a raw message, + // the security of the verification operation can be compromised. + MessageType types.MessageType } type VerifyOutput struct { @@ -138,15 +138,15 @@ type VerifyOutput struct { // of the asymmetric CMK that was used to verify the signature. KeyId *string - // The signing algorithm that was used to verify the signature. - SigningAlgorithm types.SigningAlgorithmSpec - // A Boolean value that indicates whether the signature was verified. A value of // True indicates that the Signature was produced by signing the Message with the // specified KeyID and SigningAlgorithm. If the signature is not verified, the // Verify operation fails with a KMSInvalidSignatureException exception. SignatureValid *bool + // The signing algorithm that was used to verify the signature. + SigningAlgorithm types.SigningAlgorithmSpec + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/kms/go.mod b/service/kms/go.mod index 76f9761e157..2419d93db67 100644 --- a/service/kms/go.mod +++ b/service/kms/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/kms go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/kms/types/types.go b/service/kms/types/types.go index 60ab3c7b106..9fef0700623 100644 --- a/service/kms/types/types.go +++ b/service/kms/types/types.go @@ -9,24 +9,22 @@ import ( // Contains information about an alias. type AliasListEntry struct { + // String that contains the key ARN. + AliasArn *string + // String that contains the alias. This value begins with alias/. AliasName *string // String that contains the key identifier referred to by the alias. TargetKeyId *string - - // String that contains the key ARN. - AliasArn *string } // Contains information about each custom key store in the custom key store list. type CustomKeyStoresListEntry struct { - // The date and time when the custom key store was created. - CreationDate *time.Time - - // The user-specified friendly name for the custom key store. - CustomKeyStoreName *string + // A unique identifier for the AWS CloudHSM cluster that is associated with the + // custom key store. + CloudHsmClusterId *string // Describes the connection error. This field appears in the response only when the // ConnectionState is FAILED. For help resolving these errors, see How to Fix a @@ -90,15 +88,6 @@ type CustomKeyStoresListEntry struct { // password value for the custom key store. ConnectionErrorCode ConnectionErrorCodeType - // A unique identifier for the custom key store. - CustomKeyStoreId *string - - // The trust anchor certificate of the associated AWS CloudHSM cluster. When you - // initialize the cluster - // (https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr), - // you create this certificate and save it in the customerCA.crt file. - TrustAnchorCertificate *string - // Indicates whether the custom key store is connected to its AWS CloudHSM cluster. // You can create and use CMKs in your custom key stores only when its connection // state is CONNECTED. The value is DISCONNECTED if the key store has never been @@ -113,9 +102,20 @@ type CustomKeyStoresListEntry struct { // AWS Key Management Service Developer Guide. ConnectionState ConnectionStateType - // A unique identifier for the AWS CloudHSM cluster that is associated with the - // custom key store. - CloudHsmClusterId *string + // The date and time when the custom key store was created. + CreationDate *time.Time + + // A unique identifier for the custom key store. + CustomKeyStoreId *string + + // The user-specified friendly name for the custom key store. + CustomKeyStoreName *string + + // The trust anchor certificate of the associated AWS CloudHSM cluster. When you + // initialize the cluster + // (https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr), + // you create this certificate and save it in the customerCA.crt file. + TrustAnchorCertificate *string } // Use this structure to allow cryptographic operations @@ -162,8 +162,15 @@ type GrantConstraints struct { // Contains information about a grant. type GrantListEntry struct { - // The AWS account under which the grant was issued. - IssuingAccount *string + // A list of key-value pairs that must be present in the encryption context of + // certain subsequent operations that the grant allows. + Constraints *GrantConstraints + + // The date and time when the grant was created. + CreationDate *time.Time + + // The unique identifier for the grant. + GrantId *string // The identity that gets the permissions in the grant. The GranteePrincipal field // in the ListGrants response usually contains the user or role designated as the @@ -173,29 +180,22 @@ type GrantListEntry struct { // which might represent several different grantee principals. GranteePrincipal *string - // The list of operations permitted by the grant. - Operations []GrantOperation - - // The friendly name that identifies the grant. If a name was provided in the - // CreateGrant () request, that name is returned. Otherwise this value is null. - Name *string - - // The principal that can retire the grant. - RetiringPrincipal *string + // The AWS account under which the grant was issued. + IssuingAccount *string // The unique identifier for the customer master key (CMK) to which the grant // applies. KeyId *string - // The unique identifier for the grant. - GrantId *string + // The friendly name that identifies the grant. If a name was provided in the + // CreateGrant () request, that name is returned. Otherwise this value is null. + Name *string - // A list of key-value pairs that must be present in the encryption context of - // certain subsequent operations that the grant allows. - Constraints *GrantConstraints + // The list of operations permitted by the grant. + Operations []GrantOperation - // The date and time when the grant was created. - CreationDate *time.Time + // The principal that can retire the grant. + RetiringPrincipal *string } // Contains information about each entry in the key list. @@ -212,17 +212,19 @@ type KeyListEntry struct { // response element for the CreateKey () and DescribeKey () operations. type KeyMetadata struct { - // Specifies whether the CMK's key material expires. This value is present only - // when Origin is EXTERNAL, otherwise this value is omitted. - ExpirationModel ExpirationModelType - // The globally unique identifier for the CMK. // // This member is required. KeyId *string - // The date and time when the CMK was created. - CreationDate *time.Time + // The twelve-digit account ID of the AWS account that owns the CMK. + AWSAccountId *string + + // The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management + // Service (AWS KMS) + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms) + // in the Example ARNs section of the AWS General Reference. + Arn *string // The cluster ID of the AWS CloudHSM cluster that contains the key material for // the CMK. When you create a CMK in a custom key store @@ -232,28 +234,8 @@ type KeyMetadata struct { // store. CloudHsmClusterId *string - // The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management - // Service (AWS KMS) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms) - // in the Example ARNs section of the AWS General Reference. - Arn *string - - // The manager of the CMK. CMKs in your AWS account are either customer managed or - // AWS managed. For more information about the difference, see Customer Master Keys - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys) - // in the AWS Key Management Service Developer Guide. - KeyManager KeyManagerType - - // The current status of the CMK. For more information about how key state affects - // the use of a CMK, see Key state: Effect on your CMK - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the - // AWS Key Management Service Developer Guide. - KeyState KeyState - - // The cryptographic operations - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) - // for which you can use the CMK. - KeyUsage KeyUsageType + // The date and time when the CMK was created. + CreationDate *time.Time // A unique identifier for the custom key store // (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) @@ -261,34 +243,45 @@ type KeyMetadata struct { // custom key store. CustomKeyStoreId *string - // The twelve-digit account ID of the AWS account that owns the CMK. - AWSAccountId *string + // Describes the type of key material in the CMK. + CustomerMasterKeySpec CustomerMasterKeySpec + + // The date and time after which AWS KMS deletes the CMK. This value is present + // only when KeyState is PendingDeletion. + DeletionDate *time.Time // The description of the CMK. Description *string + // Specifies whether the CMK is enabled. When KeyState is Enabled this value is + // true, otherwise it is false. + Enabled *bool + // The encryption algorithms that the CMK supports. You cannot use the CMK with // other encryption algorithms within AWS KMS. This field appears only when the // KeyUsage of the CMK is ENCRYPT_DECRYPT. EncryptionAlgorithms []EncryptionAlgorithmSpec - // The time at which the imported key material expires. When the key material - // expires, AWS KMS deletes the key material and the CMK becomes unusable. This - // value is present only for CMKs whose Origin is EXTERNAL and whose - // ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted. - ValidTo *time.Time + // Specifies whether the CMK's key material expires. This value is present only + // when Origin is EXTERNAL, otherwise this value is omitted. + ExpirationModel ExpirationModelType - // Specifies whether the CMK is enabled. When KeyState is Enabled this value is - // true, otherwise it is false. - Enabled *bool + // The manager of the CMK. CMKs in your AWS account are either customer managed or + // AWS managed. For more information about the difference, see Customer Master Keys + // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys) + // in the AWS Key Management Service Developer Guide. + KeyManager KeyManagerType - // The signing algorithms that the CMK supports. You cannot use the CMK with other - // signing algorithms within AWS KMS. This field appears only when the KeyUsage of - // the CMK is SIGN_VERIFY. - SigningAlgorithms []SigningAlgorithmSpec + // The current status of the CMK. For more information about how key state affects + // the use of a CMK, see Key state: Effect on your CMK + // (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the + // AWS Key Management Service Developer Guide. + KeyState KeyState - // Describes the type of key material in the CMK. - CustomerMasterKeySpec CustomerMasterKeySpec + // The cryptographic operations + // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) + // for which you can use the CMK. + KeyUsage KeyUsageType // The source of the CMK's key material. When this value is AWS_KMS, AWS KMS // created the key material. When this value is EXTERNAL, the key material was @@ -297,9 +290,16 @@ type KeyMetadata struct { // AWS CloudHSM cluster associated with a custom key store. Origin OriginType - // The date and time after which AWS KMS deletes the CMK. This value is present - // only when KeyState is PendingDeletion. - DeletionDate *time.Time + // The signing algorithms that the CMK supports. You cannot use the CMK with other + // signing algorithms within AWS KMS. This field appears only when the KeyUsage of + // the CMK is SIGN_VERIFY. + SigningAlgorithms []SigningAlgorithmSpec + + // The time at which the imported key material expires. When the key material + // expires, AWS KMS deletes the key material and the CMK becomes unusable. This + // value is present only for CMKs whose Origin is EXTERNAL and whose + // ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted. + ValidTo *time.Time } // A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag diff --git a/service/lakeformation/api_op_BatchRevokePermissions.go b/service/lakeformation/api_op_BatchRevokePermissions.go index b28488fe77a..59392395e8d 100644 --- a/service/lakeformation/api_op_BatchRevokePermissions.go +++ b/service/lakeformation/api_op_BatchRevokePermissions.go @@ -57,17 +57,17 @@ func (c *Client) BatchRevokePermissions(ctx context.Context, params *BatchRevoke type BatchRevokePermissionsInput struct { - // The identifier for the Data Catalog. By default, the account ID. The Data - // Catalog is the persistent metadata store. It contains database definitions, - // table definitions, and other control information to manage your AWS Lake - // Formation environment. - CatalogId *string - // A list of up to 20 entries for resource permissions to be revoked by batch // operation to the principal. // // This member is required. Entries []*types.BatchPermissionsRequestEntry + + // The identifier for the Data Catalog. By default, the account ID. The Data + // Catalog is the persistent metadata store. It contains database definitions, + // table definitions, and other control information to manage your AWS Lake + // Formation environment. + CatalogId *string } type BatchRevokePermissionsOutput struct { diff --git a/service/lakeformation/api_op_GetEffectivePermissionsForPath.go b/service/lakeformation/api_op_GetEffectivePermissionsForPath.go index 08acb246bc5..0ead500d2c7 100644 --- a/service/lakeformation/api_op_GetEffectivePermissionsForPath.go +++ b/service/lakeformation/api_op_GetEffectivePermissionsForPath.go @@ -59,18 +59,18 @@ func (c *Client) GetEffectivePermissionsForPath(ctx context.Context, params *Get type GetEffectivePermissionsForPathInput struct { - // The identifier for the Data Catalog. By default, the account ID. The Data - // Catalog is the persistent metadata store. It contains database definitions, - // table definitions, and other control information to manage your AWS Lake - // Formation environment. - CatalogId *string - // The Amazon Resource Name (ARN) of the resource for which you want to get // permissions. // // This member is required. ResourceArn *string + // The identifier for the Data Catalog. By default, the account ID. The Data + // Catalog is the persistent metadata store. It contains database definitions, + // table definitions, and other control information to manage your AWS Lake + // Formation environment. + CatalogId *string + // The maximum number of results to return. MaxResults *int32 @@ -80,13 +80,13 @@ type GetEffectivePermissionsForPathInput struct { type GetEffectivePermissionsForPathOutput struct { + // A continuation token, if this is not the first call to retrieve this list. + NextToken *string + // A list of the permissions for the specified table or database resource located // at the path in Amazon S3. Permissions []*types.PrincipalResourcePermissions - // A continuation token, if this is not the first call to retrieve this list. - NextToken *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lakeformation/api_op_GrantPermissions.go b/service/lakeformation/api_op_GrantPermissions.go index 77fb0739df9..f2f15621104 100644 --- a/service/lakeformation/api_op_GrantPermissions.go +++ b/service/lakeformation/api_op_GrantPermissions.go @@ -69,12 +69,6 @@ type GrantPermissionsInput struct { // This member is required. Permissions []types.Permission - // The identifier for the Data Catalog. By default, the account ID. The Data - // Catalog is the persistent metadata store. It contains database definitions, - // table definitions, and other control information to manage your AWS Lake - // Formation environment. - CatalogId *string - // The principal to be granted the permissions on the resource. Supported // principals are IAM users or IAM roles, and they are defined by their principal // type and their ARN. Note that if you define a resource with a particular ARN, @@ -84,16 +78,22 @@ type GrantPermissionsInput struct { // This member is required. Principal *types.DataLakePrincipal - // Indicates a list of the granted permissions that the principal may pass to other - // users. These permissions may only be a subset of the permissions granted in the - // Privileges. - PermissionsWithGrantOption []types.Permission - // The resource to which permissions are to be granted. Resources in AWS Lake // Formation are the Data Catalog, databases, and tables. // // This member is required. Resource *types.Resource + + // The identifier for the Data Catalog. By default, the account ID. The Data + // Catalog is the persistent metadata store. It contains database definitions, + // table definitions, and other control information to manage your AWS Lake + // Formation environment. + CatalogId *string + + // Indicates a list of the granted permissions that the principal may pass to other + // users. These permissions may only be a subset of the permissions granted in the + // Privileges. + PermissionsWithGrantOption []types.Permission } type GrantPermissionsOutput struct { diff --git a/service/lakeformation/api_op_ListPermissions.go b/service/lakeformation/api_op_ListPermissions.go index 1ff99277023..283b8a7c1b0 100644 --- a/service/lakeformation/api_op_ListPermissions.go +++ b/service/lakeformation/api_op_ListPermissions.go @@ -63,29 +63,29 @@ func (c *Client) ListPermissions(ctx context.Context, params *ListPermissionsInp type ListPermissionsInput struct { - // A continuation token, if this is not the first call to retrieve this list. - NextToken *string - - // Specifies a resource type to filter the permissions returned. - ResourceType types.DataLakeResourceType - // The identifier for the Data Catalog. By default, the account ID. The Data // Catalog is the persistent metadata store. It contains database definitions, // table definitions, and other control information to manage your AWS Lake // Formation environment. CatalogId *string - // Specifies a principal to filter the permissions returned. - Principal *types.DataLakePrincipal - // The maximum number of results to return. MaxResults *int32 + // A continuation token, if this is not the first call to retrieve this list. + NextToken *string + + // Specifies a principal to filter the permissions returned. + Principal *types.DataLakePrincipal + // A resource where you will get a list of the principal permissions. This // operation does not support getting privileges on a table with columns. Instead, // call this operation on the table, and the operation returns the table and the // table w columns. Resource *types.Resource + + // Specifies a resource type to filter the permissions returned. + ResourceType types.DataLakeResourceType } type ListPermissionsOutput struct { diff --git a/service/lakeformation/api_op_ListResources.go b/service/lakeformation/api_op_ListResources.go index bce686dc1e1..1e559f8c75f 100644 --- a/service/lakeformation/api_op_ListResources.go +++ b/service/lakeformation/api_op_ListResources.go @@ -56,25 +56,25 @@ func (c *Client) ListResources(ctx context.Context, params *ListResourcesInput, type ListResourcesInput struct { + // Any applicable row-level and/or column-level filtering conditions for the + // resources. + FilterConditionList []*types.FilterCondition + // The maximum number of resource results. MaxResults *int32 // A continuation token, if this is not the first call to retrieve these resources. NextToken *string - - // Any applicable row-level and/or column-level filtering conditions for the - // resources. - FilterConditionList []*types.FilterCondition } type ListResourcesOutput struct { - // A summary of the data lake resources. - ResourceInfoList []*types.ResourceInfo - // A continuation token, if this is not the first call to retrieve these resources. NextToken *string + // A summary of the data lake resources. + ResourceInfoList []*types.ResourceInfo + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lakeformation/api_op_RevokePermissions.go b/service/lakeformation/api_op_RevokePermissions.go index 2bcd4364e7f..60fcf3f4011 100644 --- a/service/lakeformation/api_op_RevokePermissions.go +++ b/service/lakeformation/api_op_RevokePermissions.go @@ -58,21 +58,6 @@ func (c *Client) RevokePermissions(ctx context.Context, params *RevokePermission type RevokePermissionsInput struct { - // The identifier for the Data Catalog. By default, the account ID. The Data - // Catalog is the persistent metadata store. It contains database definitions, - // table definitions, and other control information to manage your AWS Lake - // Formation environment. - CatalogId *string - - // The principal to be revoked permissions on the resource. - // - // This member is required. - Principal *types.DataLakePrincipal - - // Indicates a list of permissions for which to revoke the grant option allowing - // the principal to pass permissions to other principals. - PermissionsWithGrantOption []types.Permission - // The permissions revoked to the principal on the resource. For information about // permissions, see Security and Access Control to Metadata and Data // (https://docs-aws.amazon.com/lake-formation/latest/dg/security-data-access.html). @@ -80,10 +65,25 @@ type RevokePermissionsInput struct { // This member is required. Permissions []types.Permission + // The principal to be revoked permissions on the resource. + // + // This member is required. + Principal *types.DataLakePrincipal + // The resource to which permissions are to be revoked. // // This member is required. Resource *types.Resource + + // The identifier for the Data Catalog. By default, the account ID. The Data + // Catalog is the persistent metadata store. It contains database definitions, + // table definitions, and other control information to manage your AWS Lake + // Formation environment. + CatalogId *string + + // Indicates a list of permissions for which to revoke the grant option allowing + // the principal to pass permissions to other principals. + PermissionsWithGrantOption []types.Permission } type RevokePermissionsOutput struct { diff --git a/service/lakeformation/go.mod b/service/lakeformation/go.mod index cf62e5a6957..bad1eb0b0db 100644 --- a/service/lakeformation/go.mod +++ b/service/lakeformation/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/lakeformation go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/lakeformation/types/types.go b/service/lakeformation/types/types.go index 1b0fd5883ad..8e0b60543c0 100644 --- a/service/lakeformation/types/types.go +++ b/service/lakeformation/types/types.go @@ -9,32 +9,32 @@ import ( // A list of failures when performing a batch grant or batch revoke operation. type BatchPermissionsFailureEntry struct { - // An identifier for an entry of the batch request. - RequestEntry *BatchPermissionsRequestEntry - // An error message that applies to the failure of the entry. Error *ErrorDetail + + // An identifier for an entry of the batch request. + RequestEntry *BatchPermissionsRequestEntry } // A permission to a resource granted by batch operation to the principal. type BatchPermissionsRequestEntry struct { + // A unique identifier for the batch permissions request entry. + // + // This member is required. + Id *string + + // The permissions to be granted. + Permissions []Permission + // Indicates if the option to pass permissions is granted. PermissionsWithGrantOption []Permission // The principal to be granted a permission. Principal *DataLakePrincipal - // A unique identifier for the batch permissions request entry. - // - // This member is required. - Id *string - // The resource to which the principal is to be granted a permission. Resource *Resource - - // The permissions to be granted. - Permissions []Permission } // A structure for the catalog object. @@ -75,14 +75,14 @@ type DataLakePrincipal struct { // create database and default create table permissions. type DataLakeSettings struct { - // A structure representing a list of up to three principal permissions entries for - // default create table permissions. - CreateTableDefaultPermissions []*PrincipalPermissions - // A structure representing a list of up to three principal permissions entries for // default create database permissions. CreateDatabaseDefaultPermissions []*PrincipalPermissions + // A structure representing a list of up to three principal permissions entries for + // default create table permissions. + CreateTableDefaultPermissions []*PrincipalPermissions + // A list of AWS Lake Formation principals. Supported principals are IAM users or // IAM roles. DataLakeAdmins []*DataLakePrincipal @@ -97,15 +97,15 @@ type DataLakeSettings struct { // A structure for a data location object where permissions are granted or revoked. type DataLocationResource struct { - // The identifier for the Data Catalog where the location is registered with AWS - // Lake Formation. By default, it is the account ID of the caller. - CatalogId *string - // The Amazon Resource Name (ARN) that uniquely identifies the data location // resource. // // This member is required. ResourceArn *string + + // The identifier for the Data Catalog where the location is registered with AWS + // Lake Formation. By default, it is the account ID of the caller. + CatalogId *string } // Contains details about an error. @@ -122,12 +122,12 @@ type ErrorDetail struct { // condition. type FilterCondition struct { - // The field to filter in the filter condition. - Field FieldNameString - // The comparison operator used in the filter condition. ComparisonOperator ComparisonOperator + // The field to filter in the filter condition. + Field FieldNameString + // A string with values used in evaluating the filter condition. StringValueList []*string } @@ -145,9 +145,6 @@ type PrincipalPermissions struct { // The permissions granted or revoked on a resource. type PrincipalResourcePermissions struct { - // The resource where permissions are to be granted or revoked. - Resource *Resource - // The permissions to be granted or revoked on the resource. Permissions []Permission @@ -157,57 +154,55 @@ type PrincipalResourcePermissions struct { // The Data Lake principal to be granted or revoked permissions. Principal *DataLakePrincipal + + // The resource where permissions are to be granted or revoked. + Resource *Resource } // A structure for the resource. type Resource struct { - // The table with columns for the resource. A principal with permissions to this - // resource can select metadata from the columns of a table in the Data Catalog and - // the underlying data in Amazon S3. - TableWithColumns *TableWithColumnsResource + // The identifier for the Data Catalog. By default, the account ID. The Data + // Catalog is the persistent metadata store. It contains database definitions, + // table definitions, and other control information to manage your AWS Lake + // Formation environment. + Catalog *CatalogResource // The location of an Amazon S3 path where permissions are granted or revoked. DataLocation *DataLocationResource - // The table for the resource. A table is a metadata definition that represents - // your data. You can Grant and Revoke table privileges to a principal. - Table *TableResource - // The database for the resource. Unique to the Data Catalog. A database is a set // of associated table definitions organized into a logical group. You can Grant // and Revoke database permissions to a principal. Database *DatabaseResource - // The identifier for the Data Catalog. By default, the account ID. The Data - // Catalog is the persistent metadata store. It contains database definitions, - // table definitions, and other control information to manage your AWS Lake - // Formation environment. - Catalog *CatalogResource + // The table for the resource. A table is a metadata definition that represents + // your data. You can Grant and Revoke table privileges to a principal. + Table *TableResource + + // The table with columns for the resource. A principal with permissions to this + // resource can select metadata from the columns of a table in the Data Catalog and + // the underlying data in Amazon S3. + TableWithColumns *TableWithColumnsResource } // A structure containing information about an AWS Lake Formation resource. type ResourceInfo struct { - // The IAM role that registered a resource. - RoleArn *string - // The date and time the resource was last modified. LastModified *time.Time // The Amazon Resource Name (ARN) of the resource. ResourceArn *string + + // The IAM role that registered a resource. + RoleArn *string } // A structure for the table object. A table is a metadata definition that // represents your data. You can Grant and Revoke table privileges to a principal. type TableResource struct { - // A wildcard object representing every table under a database.

    At least one of - // TableResource$Name or TableResource$TableWildcard is - // required.

    - TableWildcard *TableWildcard - // The name of the database for the table. Unique to a Data Catalog. A database is // a set of associated table definitions organized into a logical group. You can // Grant and Revoke database privileges to a principal. @@ -215,12 +210,17 @@ type TableResource struct { // This member is required. DatabaseName *string - // The name of the table. - Name *string - // The identifier for the Data Catalog. By default, it is the account ID of the // caller. CatalogId *string + + // The name of the table. + Name *string + + // A wildcard object representing every table under a database.

    At least one of + // TableResource$Name or TableResource$TableWildcard is + // required.

    + TableWildcard *TableWildcard } // A wildcard object representing every table under a database. @@ -239,14 +239,6 @@ type TableWithColumnsResource struct { // This member is required. DatabaseName *string - // The list of column names for the table. At least one of ColumnNames or - // ColumnWildcard is required. - ColumnNames []*string - - // A wildcard specified by a ColumnWildcard object. At least one of ColumnNames or - // ColumnWildcard is required. - ColumnWildcard *ColumnWildcard - // The name of the table resource. A table is a metadata definition that represents // your data. You can Grant and Revoke table privileges to a principal. // @@ -256,4 +248,12 @@ type TableWithColumnsResource struct { // The identifier for the Data Catalog. By default, it is the account ID of the // caller. CatalogId *string + + // The list of column names for the table. At least one of ColumnNames or + // ColumnWildcard is required. + ColumnNames []*string + + // A wildcard specified by a ColumnWildcard object. At least one of ColumnNames or + // ColumnWildcard is required. + ColumnWildcard *ColumnWildcard } diff --git a/service/lambda/api_op_AddLayerVersionPermission.go b/service/lambda/api_op_AddLayerVersionPermission.go index 4f6db9ed381..98af6cd0637 100644 --- a/service/lambda/api_op_AddLayerVersionPermission.go +++ b/service/lambda/api_op_AddLayerVersionPermission.go @@ -67,34 +67,34 @@ type AddLayerVersionPermissionInput struct { // This member is required. Action *string - // An identifier that distinguishes the policy from others on the same layer - // version. + // The name or Amazon Resource Name (ARN) of the layer. // // This member is required. - StatementId *string + LayerName *string // An account ID, or * to grant permission to all AWS accounts. // // This member is required. Principal *string - // Only update the policy if the revision ID matches the ID specified. Use this - // option to avoid modifying a policy that has changed since you last read it. - RevisionId *string - - // The version number. + // An identifier that distinguishes the policy from others on the same layer + // version. // // This member is required. - VersionNumber *int64 + StatementId *string - // The name or Amazon Resource Name (ARN) of the layer. + // The version number. // // This member is required. - LayerName *string + VersionNumber *int64 // With the principal set to *, grant permission to all accounts in the specified // organization. OrganizationId *string + + // Only update the policy if the revision ID matches the ID specified. Use this + // option to avoid modifying a policy that has changed since you last read it. + RevisionId *string } type AddLayerVersionPermissionOutput struct { diff --git a/service/lambda/api_op_AddPermission.go b/service/lambda/api_op_AddPermission.go index dbb47c54e25..81797fb2f1c 100644 --- a/service/lambda/api_op_AddPermission.go +++ b/service/lambda/api_op_AddPermission.go @@ -76,22 +76,6 @@ type AddPermissionInput struct { // This member is required. Action *string - // For AWS services, the ARN of the AWS resource that invokes the function. For - // example, an Amazon S3 bucket or Amazon SNS topic. - SourceArn *string - - // For Amazon S3, the ID of the account that owns the resource. Use this together - // with SourceArn to ensure that the resource is owned by the specified account. It - // is possible for an Amazon S3 bucket to be deleted by its owner and recreated by - // another account. - SourceAccount *string - - // A statement identifier that differentiates the statement from others in the same - // policy. - // - // This member is required. - StatementId *string - // The name of the Lambda function, version, or alias. Name formats // // * Function @@ -110,13 +94,6 @@ type AddPermissionInput struct { // This member is required. FunctionName *string - // For Alexa Smart Home functions, a token that must be supplied by the invoker. - EventSourceToken *string - - // Specify a version or alias to add permissions to a published version of the - // function. - Qualifier *string - // The AWS service or account that invokes the function. If you specify a service, // use SourceArn or SourceAccount to limit who can invoke the function through that // service. @@ -124,9 +101,32 @@ type AddPermissionInput struct { // This member is required. Principal *string + // A statement identifier that differentiates the statement from others in the same + // policy. + // + // This member is required. + StatementId *string + + // For Alexa Smart Home functions, a token that must be supplied by the invoker. + EventSourceToken *string + + // Specify a version or alias to add permissions to a published version of the + // function. + Qualifier *string + // Only update the policy if the revision ID matches the ID that's specified. Use // this option to avoid modifying a policy that has changed since you last read it. RevisionId *string + + // For Amazon S3, the ID of the account that owns the resource. Use this together + // with SourceArn to ensure that the resource is owned by the specified account. It + // is possible for an Amazon S3 bucket to be deleted by its owner and recreated by + // another account. + SourceAccount *string + + // For AWS services, the ARN of the AWS resource that invokes the function. For + // example, an Amazon S3 bucket or Amazon SNS topic. + SourceArn *string } type AddPermissionOutput struct { diff --git a/service/lambda/api_op_CreateAlias.go b/service/lambda/api_op_CreateAlias.go index 8f1949c091f..70e69809f20 100644 --- a/service/lambda/api_op_CreateAlias.go +++ b/service/lambda/api_op_CreateAlias.go @@ -63,11 +63,6 @@ func (c *Client) CreateAlias(ctx context.Context, params *CreateAliasInput, optF type CreateAliasInput struct { - // The routing configuration - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html#configuring-alias-routing) - // of the alias. - RoutingConfig *types.AliasRoutingConfiguration - // The name of the Lambda function. Name formats // // * Function name - @@ -86,9 +81,6 @@ type CreateAliasInput struct { // This member is required. FunctionName *string - // A description of the alias. - Description *string - // The function version that the alias invokes. // // This member is required. @@ -98,31 +90,39 @@ type CreateAliasInput struct { // // This member is required. Name *string -} -// Provides configuration information about a Lambda function alias -// (https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html). -type CreateAliasOutput struct { + // A description of the alias. + Description *string // The routing configuration - // (https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) + // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html#configuring-alias-routing) // of the alias. RoutingConfig *types.AliasRoutingConfiguration +} - // The name of the alias. - Name *string +// Provides configuration information about a Lambda function alias +// (https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html). +type CreateAliasOutput struct { // The Amazon Resource Name (ARN) of the alias. AliasArn *string - // A unique identifier that changes when you update the alias. - RevisionId *string + // A description of the alias. + Description *string // The function version that the alias invokes. FunctionVersion *string - // A description of the alias. - Description *string + // The name of the alias. + Name *string + + // A unique identifier that changes when you update the alias. + RevisionId *string + + // The routing configuration + // (https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) + // of the alias. + RoutingConfig *types.AliasRoutingConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/lambda/api_op_CreateEventSourceMapping.go b/service/lambda/api_op_CreateEventSourceMapping.go index bd06935cd63..5e7cbaf4bd8 100644 --- a/service/lambda/api_op_CreateEventSourceMapping.go +++ b/service/lambda/api_op_CreateEventSourceMapping.go @@ -90,36 +90,19 @@ func (c *Client) CreateEventSourceMapping(ctx context.Context, params *CreateEve type CreateEventSourceMappingInput struct { - // Disables the event source mapping to pause polling and invocation. - Enabled *bool - - // (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded - // records. - DestinationConfig *types.DestinationConfig - - // (Streams) If the function returns an error, split the batch in two and retry. - BisectBatchOnFunctionError *bool - - // With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. - StartingPositionTimestamp *time.Time - - // (Streams) The number of batches to process from each shard concurrently. - ParallelizationFactor *int32 - - // The maximum number of items to retrieve in a single batch. + // The Amazon Resource Name (ARN) of the event source. // - // * Amazon Kinesis - // - Default 100. Max 10,000. + // * Amazon Kinesis - The + // ARN of the data stream or a stream consumer. // - // * Amazon DynamoDB Streams - Default 100. Max - // 1,000. + // * Amazon DynamoDB Streams - + // The ARN of the stream. // - // * Amazon Simple Queue Service - Default 10. Max 10. - BatchSize *int32 - - // (Streams) The maximum number of times to retry when the function returns an - // error. - MaximumRetryAttempts *int32 + // * Amazon Simple Queue Service - The ARN of the + // queue. + // + // This member is required. + EventSourceArn *string // The name of the Lambda function. Name formats // @@ -142,83 +125,100 @@ type CreateEventSourceMappingInput struct { // This member is required. FunctionName *string + // The maximum number of items to retrieve in a single batch. + // + // * Amazon Kinesis + // - Default 100. Max 10,000. + // + // * Amazon DynamoDB Streams - Default 100. Max + // 1,000. + // + // * Amazon Simple Queue Service - Default 10. Max 10. + BatchSize *int32 + + // (Streams) If the function returns an error, split the batch in two and retry. + BisectBatchOnFunctionError *bool + + // (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded + // records. + DestinationConfig *types.DestinationConfig + + // Disables the event source mapping to pause polling and invocation. + Enabled *bool + + // (Streams) The maximum amount of time to gather records before invoking the + // function, in seconds. + MaximumBatchingWindowInSeconds *int32 + // (Streams) The maximum age of a record that Lambda sends to a function for // processing. MaximumRecordAgeInSeconds *int32 + // (Streams) The maximum number of times to retry when the function returns an + // error. + MaximumRetryAttempts *int32 + + // (Streams) The number of batches to process from each shard concurrently. + ParallelizationFactor *int32 + // The position in a stream from which to start reading. Required for Amazon // Kinesis and Amazon DynamoDB Streams sources. AT_TIMESTAMP is only supported for // Amazon Kinesis streams. StartingPosition types.EventSourcePosition - // (Streams) The maximum amount of time to gather records before invoking the - // function, in seconds. - MaximumBatchingWindowInSeconds *int32 - - // The Amazon Resource Name (ARN) of the event source. - // - // * Amazon Kinesis - The - // ARN of the data stream or a stream consumer. - // - // * Amazon DynamoDB Streams - - // The ARN of the stream. - // - // * Amazon Simple Queue Service - The ARN of the - // queue. - // - // This member is required. - EventSourceArn *string + // With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. + StartingPositionTimestamp *time.Time } // A mapping between an AWS resource and an AWS Lambda function. See // CreateEventSourceMapping () for details. type CreateEventSourceMappingOutput struct { - // The state of the event source mapping. It can be one of the following: Creating, - // Enabling, Enabled, Disabling, Disabled, Updating, or Deleting. - State *string + // The maximum number of items to retrieve in a single batch. + BatchSize *int32 + + // (Streams) If the function returns an error, split the batch in two and retry. + BisectBatchOnFunctionError *bool // (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded // records. DestinationConfig *types.DestinationConfig + // The Amazon Resource Name (ARN) of the event source. + EventSourceArn *string + + // The ARN of the Lambda function. + FunctionArn *string + + // The date that the event source mapping was last updated, or its state changed. + LastModified *time.Time + + // The result of the last AWS Lambda invocation of your Lambda function. + LastProcessingResult *string + // (Streams) The maximum amount of time to gather records before invoking the // function, in seconds. MaximumBatchingWindowInSeconds *int32 + // (Streams) The maximum age of a record that Lambda sends to a function for + // processing. + MaximumRecordAgeInSeconds *int32 + // (Streams) The maximum number of times to retry when the function returns an // error. MaximumRetryAttempts *int32 - // The maximum number of items to retrieve in a single batch. - BatchSize *int32 - - // The result of the last AWS Lambda invocation of your Lambda function. - LastProcessingResult *string - // (Streams) The number of batches to process from each shard concurrently. ParallelizationFactor *int32 - // (Streams) If the function returns an error, split the batch in two and retry. - BisectBatchOnFunctionError *bool + // The state of the event source mapping. It can be one of the following: Creating, + // Enabling, Enabled, Disabling, Disabled, Updating, or Deleting. + State *string // Indicates whether the last change to the event source mapping was made by a // user, or by the Lambda service. StateTransitionReason *string - // (Streams) The maximum age of a record that Lambda sends to a function for - // processing. - MaximumRecordAgeInSeconds *int32 - - // The date that the event source mapping was last updated, or its state changed. - LastModified *time.Time - - // The ARN of the Lambda function. - FunctionArn *string - - // The Amazon Resource Name (ARN) of the event source. - EventSourceArn *string - // The identifier of the event source mapping. UUID *string diff --git a/service/lambda/api_op_CreateFunction.go b/service/lambda/api_op_CreateFunction.go index 9fc60906398..cc5c76a4d20 100644 --- a/service/lambda/api_op_CreateFunction.go +++ b/service/lambda/api_op_CreateFunction.go @@ -90,78 +90,11 @@ func (c *Client) CreateFunction(ctx context.Context, params *CreateFunctionInput type CreateFunctionInput struct { - // For network connectivity to AWS resources in a VPC, specify a list of security - // groups and subnets in the VPC. When you connect a function to a VPC, it can only - // access resources and the internet through that VPC. For more information, see - // VPC Settings - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html). - VpcConfig *types.VpcConfig - - // A description of the function. - Description *string - - // The amount of memory that your function has access to. Increasing the function's - // memory also increases its CPU allocation. The default value is 128 MB. The value - // must be a multiple of 64 MB. - MemorySize *int32 - - // The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt - // your function's environment variables. If it's not provided, AWS Lambda uses a - // default service key. - KMSKeyArn *string - - // A list of function layers - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add - // to the function's execution environment. Specify each layer by its ARN, - // including the version. - Layers []*string - - // Set to true to publish the first version of the function during creation. - Publish *bool - - // Set Mode to Active to sample and trace a subset of incoming requests with AWS - // X-Ray. - TracingConfig *types.TracingConfig - - // The name of the method within your code that Lambda calls to execute your - // function. The format includes the file name. It can also include namespaces and - // other qualifiers, depending on the runtime. For more information, see - // Programming Model - // (https://docs.aws.amazon.com/lambda/latest/dg/programming-model-v2.html). - // - // This member is required. - Handler *string - - // The amount of time that Lambda allows a function to run before stopping it. The - // default is 3 seconds. The maximum allowed value is 900 seconds. - Timeout *int32 - // The code for the function. // // This member is required. Code *types.FunctionCode - // The identifier of the function's runtime - // (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). - // - // This member is required. - Runtime types.Runtime - - // Connection settings for an Amazon EFS file system. - FileSystemConfigs []*types.FileSystemConfig - - // The Amazon Resource Name (ARN) of the function's execution role. - // - // This member is required. - Role *string - - // Environment variables that are accessible from function code during execution. - Environment *types.Environment - - // A list of tags (https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to - // apply to the function. - Tags map[string]*string - // The name of the Lambda function. Name formats // // * Function name - @@ -180,103 +113,170 @@ type CreateFunctionInput struct { // This member is required. FunctionName *string + // The name of the method within your code that Lambda calls to execute your + // function. The format includes the file name. It can also include namespaces and + // other qualifiers, depending on the runtime. For more information, see + // Programming Model + // (https://docs.aws.amazon.com/lambda/latest/dg/programming-model-v2.html). + // + // This member is required. + Handler *string + + // The Amazon Resource Name (ARN) of the function's execution role. + // + // This member is required. + Role *string + + // The identifier of the function's runtime + // (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). + // + // This member is required. + Runtime types.Runtime + // A dead letter queue configuration that specifies the queue or topic where Lambda // sends asynchronous events when they fail processing. For more information, see // Dead Letter Queues // (https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq). DeadLetterConfig *types.DeadLetterConfig -} - -// Details about a function's configuration. -type CreateFunctionOutput struct { - // The name of the function. - FunctionName *string + // A description of the function. + Description *string - // The latest updated revision of the function or alias. - RevisionId *string + // Environment variables that are accessible from function code during execution. + Environment *types.Environment - // For Lambda@Edge functions, the ARN of the master function. - MasterArn *string + // Connection settings for an Amazon EFS file system. + FileSystemConfigs []*types.FileSystemConfig - // The status of the last update that was performed on the function. This is first - // set to Successful after function creation completes. - LastUpdateStatus types.LastUpdateStatus + // The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt + // your function's environment variables. If it's not provided, AWS Lambda uses a + // default service key. + KMSKeyArn *string - // The function's layers - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). - Layers []*types.Layer + // A list of function layers + // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add + // to the function's execution environment. Specify each layer by its ARN, + // including the version. + Layers []*string - // Connection settings for an Amazon EFS file system. - FileSystemConfigs []*types.FileSystemConfig + // The amount of memory that your function has access to. Increasing the function's + // memory also increases its CPU allocation. The default value is 128 MB. The value + // must be a multiple of 64 MB. + MemorySize *int32 - // The function's networking configuration. - VpcConfig *types.VpcConfigResponse + // Set to true to publish the first version of the function during creation. + Publish *bool - // The runtime environment for the Lambda function. - Runtime types.Runtime + // A list of tags (https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to + // apply to the function. + Tags map[string]*string - // The SHA256 hash of the function's deployment package. - CodeSha256 *string + // The amount of time that Lambda allows a function to run before stopping it. The + // default is 3 seconds. The maximum allowed value is 900 seconds. + Timeout *int32 - // The date and time that the function was last updated, in ISO-8601 format - // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). - LastModified *string + // Set Mode to Active to sample and trace a subset of incoming requests with AWS + // X-Ray. + TracingConfig *types.TracingConfig - // The memory that's allocated to the function. - MemorySize *int32 + // For network connectivity to AWS resources in a VPC, specify a list of security + // groups and subnets in the VPC. When you connect a function to a VPC, it can only + // access resources and the internet through that VPC. For more information, see + // VPC Settings + // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html). + VpcConfig *types.VpcConfig +} - // The version of the Lambda function. - Version *string +// Details about a function's configuration. +type CreateFunctionOutput struct { - // The amount of time in seconds that Lambda allows a function to run before - // stopping it. - Timeout *int32 + // The SHA256 hash of the function's deployment package. + CodeSha256 *string // The size of the function's deployment package, in bytes. CodeSize *int64 - // The function's Amazon Resource Name (ARN). - FunctionArn *string + // The function's dead letter queue. + DeadLetterConfig *types.DeadLetterConfig + + // The function's description. + Description *string // The function's environment variables. Environment *types.EnvironmentResponse - // The reason for the last update that was performed on the function. - LastUpdateStatusReason *string + // Connection settings for an Amazon EFS file system. + FileSystemConfigs []*types.FileSystemConfig + + // The function's Amazon Resource Name (ARN). + FunctionArn *string + + // The name of the function. + FunctionName *string // The function that Lambda calls to begin executing your function. Handler *string - // The function's AWS X-Ray tracing configuration. - TracingConfig *types.TracingConfigResponse + // The KMS key that's used to encrypt the function's environment variables. This + // key is only returned if you've configured a customer managed CMK. + KMSKeyArn *string - // The reason code for the function's current state. When the code is Creating, you - // can't invoke or modify the function. - StateReasonCode types.StateReasonCode + // The date and time that the function was last updated, in ISO-8601 format + // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). + LastModified *string + + // The status of the last update that was performed on the function. This is first + // set to Successful after function creation completes. + LastUpdateStatus types.LastUpdateStatus + + // The reason for the last update that was performed on the function. + LastUpdateStatusReason *string // The reason code for the last update that was performed on the function. LastUpdateStatusReasonCode types.LastUpdateStatusReasonCode - // The function's description. - Description *string + // The function's layers + // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). + Layers []*types.Layer + + // For Lambda@Edge functions, the ARN of the master function. + MasterArn *string + + // The memory that's allocated to the function. + MemorySize *int32 + + // The latest updated revision of the function or alias. + RevisionId *string // The function's execution role. Role *string - // The KMS key that's used to encrypt the function's environment variables. This - // key is only returned if you've configured a customer managed CMK. - KMSKeyArn *string + // The runtime environment for the Lambda function. + Runtime types.Runtime - // The function's dead letter queue. - DeadLetterConfig *types.DeadLetterConfig + // The current state of the function. When the state is Inactive, you can + // reactivate the function by invoking it. + State types.State // The reason for the function's current state. StateReason *string - // The current state of the function. When the state is Inactive, you can - // reactivate the function by invoking it. - State types.State + // The reason code for the function's current state. When the code is Creating, you + // can't invoke or modify the function. + StateReasonCode types.StateReasonCode + + // The amount of time in seconds that Lambda allows a function to run before + // stopping it. + Timeout *int32 + + // The function's AWS X-Ray tracing configuration. + TracingConfig *types.TracingConfigResponse + + // The version of the Lambda function. + Version *string + + // The function's networking configuration. + VpcConfig *types.VpcConfigResponse // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/lambda/api_op_DeleteAlias.go b/service/lambda/api_op_DeleteAlias.go index 5d429103e9f..1c7a3c94afa 100644 --- a/service/lambda/api_op_DeleteAlias.go +++ b/service/lambda/api_op_DeleteAlias.go @@ -57,11 +57,6 @@ func (c *Client) DeleteAlias(ctx context.Context, params *DeleteAliasInput, optF type DeleteAliasInput struct { - // The name of the alias. - // - // This member is required. - Name *string - // The name of the Lambda function. Name formats // // * Function name - @@ -79,6 +74,11 @@ type DeleteAliasInput struct { // // This member is required. FunctionName *string + + // The name of the alias. + // + // This member is required. + Name *string } type DeleteAliasOutput struct { diff --git a/service/lambda/api_op_DeleteEventSourceMapping.go b/service/lambda/api_op_DeleteEventSourceMapping.go index 37f991d9cdf..a7cb1b80f0b 100644 --- a/service/lambda/api_op_DeleteEventSourceMapping.go +++ b/service/lambda/api_op_DeleteEventSourceMapping.go @@ -72,51 +72,51 @@ type DeleteEventSourceMappingInput struct { // CreateEventSourceMapping () for details. type DeleteEventSourceMappingOutput struct { - // The state of the event source mapping. It can be one of the following: Creating, - // Enabling, Enabled, Disabling, Disabled, Updating, or Deleting. - State *string + // The maximum number of items to retrieve in a single batch. + BatchSize *int32 + + // (Streams) If the function returns an error, split the batch in two and retry. + BisectBatchOnFunctionError *bool // (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded // records. DestinationConfig *types.DestinationConfig + // The Amazon Resource Name (ARN) of the event source. + EventSourceArn *string + + // The ARN of the Lambda function. + FunctionArn *string + + // The date that the event source mapping was last updated, or its state changed. + LastModified *time.Time + + // The result of the last AWS Lambda invocation of your Lambda function. + LastProcessingResult *string + // (Streams) The maximum amount of time to gather records before invoking the // function, in seconds. MaximumBatchingWindowInSeconds *int32 + // (Streams) The maximum age of a record that Lambda sends to a function for + // processing. + MaximumRecordAgeInSeconds *int32 + // (Streams) The maximum number of times to retry when the function returns an // error. MaximumRetryAttempts *int32 - // The maximum number of items to retrieve in a single batch. - BatchSize *int32 - - // The result of the last AWS Lambda invocation of your Lambda function. - LastProcessingResult *string - // (Streams) The number of batches to process from each shard concurrently. ParallelizationFactor *int32 - // (Streams) If the function returns an error, split the batch in two and retry. - BisectBatchOnFunctionError *bool + // The state of the event source mapping. It can be one of the following: Creating, + // Enabling, Enabled, Disabling, Disabled, Updating, or Deleting. + State *string // Indicates whether the last change to the event source mapping was made by a // user, or by the Lambda service. StateTransitionReason *string - // (Streams) The maximum age of a record that Lambda sends to a function for - // processing. - MaximumRecordAgeInSeconds *int32 - - // The date that the event source mapping was last updated, or its state changed. - LastModified *time.Time - - // The ARN of the Lambda function. - FunctionArn *string - - // The Amazon Resource Name (ARN) of the event source. - EventSourceArn *string - // The identifier of the event source mapping. UUID *string diff --git a/service/lambda/api_op_DeleteFunctionEventInvokeConfig.go b/service/lambda/api_op_DeleteFunctionEventInvokeConfig.go index 96acc330fbe..33c820c4549 100644 --- a/service/lambda/api_op_DeleteFunctionEventInvokeConfig.go +++ b/service/lambda/api_op_DeleteFunctionEventInvokeConfig.go @@ -58,9 +58,6 @@ func (c *Client) DeleteFunctionEventInvokeConfig(ctx context.Context, params *De type DeleteFunctionEventInvokeConfigInput struct { - // A version number or alias name. - Qualifier *string - // The name of the Lambda function, version, or alias. Name formats // // * Function @@ -78,6 +75,9 @@ type DeleteFunctionEventInvokeConfigInput struct { // // This member is required. FunctionName *string + + // A version number or alias name. + Qualifier *string } type DeleteFunctionEventInvokeConfigOutput struct { diff --git a/service/lambda/api_op_GetAlias.go b/service/lambda/api_op_GetAlias.go index 50ecd713f5b..6c3139b12d6 100644 --- a/service/lambda/api_op_GetAlias.go +++ b/service/lambda/api_op_GetAlias.go @@ -86,25 +86,25 @@ type GetAliasInput struct { // (https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html). type GetAliasOutput struct { - // The routing configuration - // (https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) - // of the alias. - RoutingConfig *types.AliasRoutingConfiguration - - // The name of the alias. - Name *string - // The Amazon Resource Name (ARN) of the alias. AliasArn *string - // A unique identifier that changes when you update the alias. - RevisionId *string + // A description of the alias. + Description *string // The function version that the alias invokes. FunctionVersion *string - // A description of the alias. - Description *string + // The name of the alias. + Name *string + + // A unique identifier that changes when you update the alias. + RevisionId *string + + // The routing configuration + // (https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) + // of the alias. + RoutingConfig *types.AliasRoutingConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/lambda/api_op_GetEventSourceMapping.go b/service/lambda/api_op_GetEventSourceMapping.go index c432847b2c3..e097c9b8bf8 100644 --- a/service/lambda/api_op_GetEventSourceMapping.go +++ b/service/lambda/api_op_GetEventSourceMapping.go @@ -69,51 +69,51 @@ type GetEventSourceMappingInput struct { // CreateEventSourceMapping () for details. type GetEventSourceMappingOutput struct { - // The state of the event source mapping. It can be one of the following: Creating, - // Enabling, Enabled, Disabling, Disabled, Updating, or Deleting. - State *string + // The maximum number of items to retrieve in a single batch. + BatchSize *int32 + + // (Streams) If the function returns an error, split the batch in two and retry. + BisectBatchOnFunctionError *bool // (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded // records. DestinationConfig *types.DestinationConfig + // The Amazon Resource Name (ARN) of the event source. + EventSourceArn *string + + // The ARN of the Lambda function. + FunctionArn *string + + // The date that the event source mapping was last updated, or its state changed. + LastModified *time.Time + + // The result of the last AWS Lambda invocation of your Lambda function. + LastProcessingResult *string + // (Streams) The maximum amount of time to gather records before invoking the // function, in seconds. MaximumBatchingWindowInSeconds *int32 + // (Streams) The maximum age of a record that Lambda sends to a function for + // processing. + MaximumRecordAgeInSeconds *int32 + // (Streams) The maximum number of times to retry when the function returns an // error. MaximumRetryAttempts *int32 - // The maximum number of items to retrieve in a single batch. - BatchSize *int32 - - // The result of the last AWS Lambda invocation of your Lambda function. - LastProcessingResult *string - // (Streams) The number of batches to process from each shard concurrently. ParallelizationFactor *int32 - // (Streams) If the function returns an error, split the batch in two and retry. - BisectBatchOnFunctionError *bool + // The state of the event source mapping. It can be one of the following: Creating, + // Enabling, Enabled, Disabling, Disabled, Updating, or Deleting. + State *string // Indicates whether the last change to the event source mapping was made by a // user, or by the Lambda service. StateTransitionReason *string - // (Streams) The maximum age of a record that Lambda sends to a function for - // processing. - MaximumRecordAgeInSeconds *int32 - - // The date that the event source mapping was last updated, or its state changed. - LastModified *time.Time - - // The ARN of the Lambda function. - FunctionArn *string - - // The Amazon Resource Name (ARN) of the event source. - EventSourceArn *string - // The identifier of the event source mapping. UUID *string diff --git a/service/lambda/api_op_GetFunction.go b/service/lambda/api_op_GetFunction.go index 8af78fd2d26..49e189e5baa 100644 --- a/service/lambda/api_op_GetFunction.go +++ b/service/lambda/api_op_GetFunction.go @@ -59,10 +59,6 @@ func (c *Client) GetFunction(ctx context.Context, params *GetFunctionInput, optF type GetFunctionInput struct { - // Specify a version or alias to get details about a published version of the - // function. - Qualifier *string - // The name of the Lambda function, version, or alias. Name formats // // * Function @@ -80,13 +76,14 @@ type GetFunctionInput struct { // // This member is required. FunctionName *string + + // Specify a version or alias to get details about a published version of the + // function. + Qualifier *string } type GetFunctionOutput struct { - // The function's tags (https://docs.aws.amazon.com/lambda/latest/dg/tagging.html). - Tags map[string]*string - // The deployment package of the function or version. Code *types.FunctionCodeLocation @@ -97,6 +94,9 @@ type GetFunctionOutput struct { // The configuration of the function or version. Configuration *types.FunctionConfiguration + // The function's tags (https://docs.aws.amazon.com/lambda/latest/dg/tagging.html). + Tags map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lambda/api_op_GetFunctionConfiguration.go b/service/lambda/api_op_GetFunctionConfiguration.go index 590abe2e6d1..e675d347eaf 100644 --- a/service/lambda/api_op_GetFunctionConfiguration.go +++ b/service/lambda/api_op_GetFunctionConfiguration.go @@ -86,93 +86,93 @@ type GetFunctionConfigurationInput struct { // Details about a function's configuration. type GetFunctionConfigurationOutput struct { - // The name of the function. - FunctionName *string + // The SHA256 hash of the function's deployment package. + CodeSha256 *string - // The latest updated revision of the function or alias. - RevisionId *string + // The size of the function's deployment package, in bytes. + CodeSize *int64 - // For Lambda@Edge functions, the ARN of the master function. - MasterArn *string + // The function's dead letter queue. + DeadLetterConfig *types.DeadLetterConfig - // The status of the last update that was performed on the function. This is first - // set to Successful after function creation completes. - LastUpdateStatus types.LastUpdateStatus + // The function's description. + Description *string - // The function's layers - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). - Layers []*types.Layer + // The function's environment variables. + Environment *types.EnvironmentResponse // Connection settings for an Amazon EFS file system. FileSystemConfigs []*types.FileSystemConfig - // The function's networking configuration. - VpcConfig *types.VpcConfigResponse + // The function's Amazon Resource Name (ARN). + FunctionArn *string - // The runtime environment for the Lambda function. - Runtime types.Runtime + // The name of the function. + FunctionName *string - // The SHA256 hash of the function's deployment package. - CodeSha256 *string + // The function that Lambda calls to begin executing your function. + Handler *string + + // The KMS key that's used to encrypt the function's environment variables. This + // key is only returned if you've configured a customer managed CMK. + KMSKeyArn *string // The date and time that the function was last updated, in ISO-8601 format // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). LastModified *string - // The memory that's allocated to the function. - MemorySize *int32 - - // The version of the Lambda function. - Version *string - - // The amount of time in seconds that Lambda allows a function to run before - // stopping it. - Timeout *int32 - - // The size of the function's deployment package, in bytes. - CodeSize *int64 - - // The function's Amazon Resource Name (ARN). - FunctionArn *string - - // The function's environment variables. - Environment *types.EnvironmentResponse + // The status of the last update that was performed on the function. This is first + // set to Successful after function creation completes. + LastUpdateStatus types.LastUpdateStatus // The reason for the last update that was performed on the function. LastUpdateStatusReason *string - // The function that Lambda calls to begin executing your function. - Handler *string + // The reason code for the last update that was performed on the function. + LastUpdateStatusReasonCode types.LastUpdateStatusReasonCode - // The function's AWS X-Ray tracing configuration. - TracingConfig *types.TracingConfigResponse + // The function's layers + // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). + Layers []*types.Layer - // The reason code for the function's current state. When the code is Creating, you - // can't invoke or modify the function. - StateReasonCode types.StateReasonCode + // For Lambda@Edge functions, the ARN of the master function. + MasterArn *string - // The reason code for the last update that was performed on the function. - LastUpdateStatusReasonCode types.LastUpdateStatusReasonCode + // The memory that's allocated to the function. + MemorySize *int32 - // The function's description. - Description *string + // The latest updated revision of the function or alias. + RevisionId *string // The function's execution role. Role *string - // The KMS key that's used to encrypt the function's environment variables. This - // key is only returned if you've configured a customer managed CMK. - KMSKeyArn *string + // The runtime environment for the Lambda function. + Runtime types.Runtime - // The function's dead letter queue. - DeadLetterConfig *types.DeadLetterConfig + // The current state of the function. When the state is Inactive, you can + // reactivate the function by invoking it. + State types.State // The reason for the function's current state. StateReason *string - // The current state of the function. When the state is Inactive, you can - // reactivate the function by invoking it. - State types.State + // The reason code for the function's current state. When the code is Creating, you + // can't invoke or modify the function. + StateReasonCode types.StateReasonCode + + // The amount of time in seconds that Lambda allows a function to run before + // stopping it. + Timeout *int32 + + // The function's AWS X-Ray tracing configuration. + TracingConfig *types.TracingConfigResponse + + // The version of the Lambda function. + Version *string + + // The function's networking configuration. + VpcConfig *types.VpcConfigResponse // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/lambda/api_op_GetFunctionEventInvokeConfig.go b/service/lambda/api_op_GetFunctionEventInvokeConfig.go index ae5a950b48d..65531adacf9 100644 --- a/service/lambda/api_op_GetFunctionEventInvokeConfig.go +++ b/service/lambda/api_op_GetFunctionEventInvokeConfig.go @@ -60,9 +60,6 @@ func (c *Client) GetFunctionEventInvokeConfig(ctx context.Context, params *GetFu type GetFunctionEventInvokeConfigInput struct { - // A version number or alias name. - Qualifier *string - // The name of the Lambda function, version, or alias. Name formats // // * Function @@ -80,13 +77,13 @@ type GetFunctionEventInvokeConfigInput struct { // // This member is required. FunctionName *string + + // A version number or alias name. + Qualifier *string } type GetFunctionEventInvokeConfigOutput struct { - // The maximum age of a request that Lambda sends to a function for processing. - MaximumEventAgeInSeconds *int32 - // A destination for events after they have been sent to a function for processing. // Destinations // @@ -101,15 +98,18 @@ type GetFunctionEventInvokeConfigOutput struct { // * Event Bus - The ARN of an Amazon EventBridge event bus. DestinationConfig *types.DestinationConfig + // The Amazon Resource Name (ARN) of the function. + FunctionArn *string + // The date and time that the configuration was last updated. LastModified *time.Time + // The maximum age of a request that Lambda sends to a function for processing. + MaximumEventAgeInSeconds *int32 + // The maximum number of times to retry when the function returns an error. MaximumRetryAttempts *int32 - // The Amazon Resource Name (ARN) of the function. - FunctionArn *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lambda/api_op_GetLayerVersion.go b/service/lambda/api_op_GetLayerVersion.go index 72cc2a5ff06..208df37e97f 100644 --- a/service/lambda/api_op_GetLayerVersion.go +++ b/service/lambda/api_op_GetLayerVersion.go @@ -72,21 +72,9 @@ type GetLayerVersionInput struct { type GetLayerVersionOutput struct { - // The layer's software license. - LicenseInfo *string - // The layer's compatible runtimes. CompatibleRuntimes []types.Runtime - // The description of the version. - Description *string - - // The ARN of the layer version. - LayerVersionArn *string - - // The version number. - Version *int64 - // Details about the layer version. Content *types.LayerVersionContentOutput @@ -94,9 +82,21 @@ type GetLayerVersionOutput struct { // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). CreatedDate *string + // The description of the version. + Description *string + // The ARN of the layer. LayerArn *string + // The ARN of the layer version. + LayerVersionArn *string + + // The layer's software license. + LicenseInfo *string + + // The version number. + Version *int64 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lambda/api_op_GetLayerVersionByArn.go b/service/lambda/api_op_GetLayerVersionByArn.go index a0641dd3f13..68dfee14623 100644 --- a/service/lambda/api_op_GetLayerVersionByArn.go +++ b/service/lambda/api_op_GetLayerVersionByArn.go @@ -67,21 +67,9 @@ type GetLayerVersionByArnInput struct { type GetLayerVersionByArnOutput struct { - // The layer's software license. - LicenseInfo *string - // The layer's compatible runtimes. CompatibleRuntimes []types.Runtime - // The description of the version. - Description *string - - // The ARN of the layer version. - LayerVersionArn *string - - // The version number. - Version *int64 - // Details about the layer version. Content *types.LayerVersionContentOutput @@ -89,9 +77,21 @@ type GetLayerVersionByArnOutput struct { // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). CreatedDate *string + // The description of the version. + Description *string + // The ARN of the layer. LayerArn *string + // The ARN of the layer version. + LayerVersionArn *string + + // The layer's software license. + LicenseInfo *string + + // The version number. + Version *int64 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lambda/api_op_GetLayerVersionPolicy.go b/service/lambda/api_op_GetLayerVersionPolicy.go index d02c9fee706..3ec1b01340b 100644 --- a/service/lambda/api_op_GetLayerVersionPolicy.go +++ b/service/lambda/api_op_GetLayerVersionPolicy.go @@ -58,15 +58,15 @@ func (c *Client) GetLayerVersionPolicy(ctx context.Context, params *GetLayerVers type GetLayerVersionPolicyInput struct { - // The version number. + // The name or Amazon Resource Name (ARN) of the layer. // // This member is required. - VersionNumber *int64 + LayerName *string - // The name or Amazon Resource Name (ARN) of the layer. + // The version number. // // This member is required. - LayerName *string + VersionNumber *int64 } type GetLayerVersionPolicyOutput struct { diff --git a/service/lambda/api_op_GetProvisionedConcurrencyConfig.go b/service/lambda/api_op_GetProvisionedConcurrencyConfig.go index d3e55ee009a..b65e4a8fed9 100644 --- a/service/lambda/api_op_GetProvisionedConcurrencyConfig.go +++ b/service/lambda/api_op_GetProvisionedConcurrencyConfig.go @@ -58,11 +58,6 @@ func (c *Client) GetProvisionedConcurrencyConfig(ctx context.Context, params *Ge type GetProvisionedConcurrencyConfigInput struct { - // The version number or alias name. - // - // This member is required. - Qualifier *string - // The name of the Lambda function. Name formats // // * Function name - @@ -80,29 +75,34 @@ type GetProvisionedConcurrencyConfigInput struct { // // This member is required. FunctionName *string + + // The version number or alias name. + // + // This member is required. + Qualifier *string } type GetProvisionedConcurrencyConfigOutput struct { - // The amount of provisioned concurrency requested. - RequestedProvisionedConcurrentExecutions *int32 + // The amount of provisioned concurrency allocated. + AllocatedProvisionedConcurrentExecutions *int32 // The amount of provisioned concurrency available. AvailableProvisionedConcurrentExecutions *int32 - // For failed allocations, the reason that provisioned concurrency could not be - // allocated. - StatusReason *string - // The date and time that a user last updated the configuration, in ISO 8601 format // (https://www.iso.org/iso-8601-date-and-time-format.html). LastModified *string + // The amount of provisioned concurrency requested. + RequestedProvisionedConcurrentExecutions *int32 + // The status of the allocation process. Status types.ProvisionedConcurrencyStatusEnum - // The amount of provisioned concurrency allocated. - AllocatedProvisionedConcurrentExecutions *int32 + // For failed allocations, the reason that provisioned concurrency could not be + // allocated. + StatusReason *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/lambda/api_op_Invoke.go b/service/lambda/api_op_Invoke.go index f658e3ee22e..27d7b0d48c9 100644 --- a/service/lambda/api_op_Invoke.go +++ b/service/lambda/api_op_Invoke.go @@ -95,6 +95,28 @@ func (c *Client) Invoke(ctx context.Context, params *InvokeInput, optFns ...func type InvokeInput struct { + // The name of the Lambda function, version, or alias. Name formats + // + // * Function + // name - my-function (name-only), my-function:v1 (with alias). + // + // * Function ARN + // - arn:aws:lambda:us-west-2:123456789012:function:my-function. + // + // * Partial ARN + // - 123456789012:function:my-function. + // + // You can append a version number or alias + // to any of the formats. The length constraint applies only to the full ARN. If + // you specify only the function name, it is limited to 64 characters in length. + // + // This member is required. + FunctionName *string + + // Up to 3583 bytes of base64-encoded data about the invoking client to pass to the + // function in the context object. + ClientContext *string + // Choose from the following options. // // * RequestResponse (default) - Invoke the @@ -119,38 +141,10 @@ type InvokeInput struct { // Specify a version or alias to invoke a published version of the function. Qualifier *string - - // Up to 3583 bytes of base64-encoded data about the invoking client to pass to the - // function in the context object. - ClientContext *string - - // The name of the Lambda function, version, or alias. Name formats - // - // * Function - // name - my-function (name-only), my-function:v1 (with alias). - // - // * Function ARN - // - arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * Partial ARN - // - 123456789012:function:my-function. - // - // You can append a version number or alias - // to any of the formats. The length constraint applies only to the full ARN. If - // you specify only the function name, it is limited to 64 characters in length. - // - // This member is required. - FunctionName *string } type InvokeOutput struct { - // The last 4 KB of the execution log, which is base64 encoded. - LogResult *string - - // The response from the function, or an error object. - Payload []byte - // The version of the function that executed. When you invoke a function with an // alias, this indicates which version the alias resolved to. ExecutedVersion *string @@ -159,6 +153,12 @@ type InvokeOutput struct { // about the error are included in the response payload. FunctionError *string + // The last 4 KB of the execution log, which is base64 encoded. + LogResult *string + + // The response from the function, or an error object. + Payload []byte + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lambda/api_op_InvokeAsync.go b/service/lambda/api_op_InvokeAsync.go index c415739b197..95b2fcb6fdc 100644 --- a/service/lambda/api_op_InvokeAsync.go +++ b/service/lambda/api_op_InvokeAsync.go @@ -58,11 +58,6 @@ func (c *Client) InvokeAsync(ctx context.Context, params *InvokeAsyncInput, optF type InvokeAsyncInput struct { - // The JSON that you want to provide to your Lambda function as input. - // - // This member is required. - InvokeArgs io.Reader - // The name of the Lambda function. Name formats // // * Function name - @@ -80,6 +75,11 @@ type InvokeAsyncInput struct { // // This member is required. FunctionName *string + + // The JSON that you want to provide to your Lambda function as input. + // + // This member is required. + InvokeArgs io.Reader } // A success response (202 Accepted) indicates that the request is queued for diff --git a/service/lambda/api_op_ListAliases.go b/service/lambda/api_op_ListAliases.go index caa0fceb368..a431dccb349 100644 --- a/service/lambda/api_op_ListAliases.go +++ b/service/lambda/api_op_ListAliases.go @@ -59,13 +59,6 @@ func (c *Client) ListAliases(ctx context.Context, params *ListAliasesInput, optF type ListAliasesInput struct { - // Specify the pagination token that's returned by a previous request to retrieve - // the next page of results. - Marker *string - - // Limit the number of aliases returned. - MaxItems *int32 - // The name of the Lambda function. Name formats // // * Function name - @@ -86,6 +79,13 @@ type ListAliasesInput struct { // Specify a function version to only list aliases that invoke that version. FunctionVersion *string + + // Specify the pagination token that's returned by a previous request to retrieve + // the next page of results. + Marker *string + + // Limit the number of aliases returned. + MaxItems *int32 } type ListAliasesOutput struct { diff --git a/service/lambda/api_op_ListEventSourceMappings.go b/service/lambda/api_op_ListEventSourceMappings.go index 17672da6d09..d0cb67307e9 100644 --- a/service/lambda/api_op_ListEventSourceMappings.go +++ b/service/lambda/api_op_ListEventSourceMappings.go @@ -57,11 +57,17 @@ func (c *Client) ListEventSourceMappings(ctx context.Context, params *ListEventS type ListEventSourceMappingsInput struct { - // A pagination token returned by a previous call. - Marker *string - - // The maximum number of event source mappings to return. - MaxItems *int32 + // The Amazon Resource Name (ARN) of the event source. + // + // * Amazon Kinesis - The + // ARN of the data stream or a stream consumer. + // + // * Amazon DynamoDB Streams - + // The ARN of the stream. + // + // * Amazon Simple Queue Service - The ARN of the + // queue. + EventSourceArn *string // The name of the Lambda function. Name formats // @@ -82,28 +88,22 @@ type ListEventSourceMappingsInput struct { // characters in length. FunctionName *string - // The Amazon Resource Name (ARN) of the event source. - // - // * Amazon Kinesis - The - // ARN of the data stream or a stream consumer. - // - // * Amazon DynamoDB Streams - - // The ARN of the stream. - // - // * Amazon Simple Queue Service - The ARN of the - // queue. - EventSourceArn *string + // A pagination token returned by a previous call. + Marker *string + + // The maximum number of event source mappings to return. + MaxItems *int32 } type ListEventSourceMappingsOutput struct { + // A list of event source mappings. + EventSourceMappings []*types.EventSourceMappingConfiguration + // A pagination token that's returned when the response doesn't contain all event // source mappings. NextMarker *string - // A list of event source mappings. - EventSourceMappings []*types.EventSourceMappingConfiguration - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lambda/api_op_ListFunctionEventInvokeConfigs.go b/service/lambda/api_op_ListFunctionEventInvokeConfigs.go index fe28eee234d..96bf75d7a09 100644 --- a/service/lambda/api_op_ListFunctionEventInvokeConfigs.go +++ b/service/lambda/api_op_ListFunctionEventInvokeConfigs.go @@ -77,22 +77,22 @@ type ListFunctionEventInvokeConfigsInput struct { // This member is required. FunctionName *string - // The maximum number of configurations to return. - MaxItems *int32 - // Specify the pagination token that's returned by a previous request to retrieve // the next page of results. Marker *string + + // The maximum number of configurations to return. + MaxItems *int32 } type ListFunctionEventInvokeConfigsOutput struct { - // The pagination token that's included if more results are available. - NextMarker *string - // A list of configurations. FunctionEventInvokeConfigs []*types.FunctionEventInvokeConfig + // The pagination token that's included if more results are available. + NextMarker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lambda/api_op_ListFunctions.go b/service/lambda/api_op_ListFunctions.go index c0708ce091d..1aab9c42cca 100644 --- a/service/lambda/api_op_ListFunctions.go +++ b/service/lambda/api_op_ListFunctions.go @@ -63,8 +63,9 @@ type ListFunctionsInput struct { // Set to ALL to include entries for all published versions of each function. FunctionVersion types.FunctionVersion - // The maximum number of functions to return. - MaxItems *int32 + // Specify the pagination token that's returned by a previous request to retrieve + // the next page of results. + Marker *string // For Lambda@Edge functions, the AWS Region of the master function. For example, // us-east-1 filters the list of functions to only include Lambda@Edge functions @@ -72,9 +73,8 @@ type ListFunctionsInput struct { // must set FunctionVersion to ALL. MasterRegion *string - // Specify the pagination token that's returned by a previous request to retrieve - // the next page of results. - Marker *string + // The maximum number of functions to return. + MaxItems *int32 } // A list of Lambda functions. diff --git a/service/lambda/api_op_ListLayerVersions.go b/service/lambda/api_op_ListLayerVersions.go index bc4a96da21c..9e743998cd4 100644 --- a/service/lambda/api_op_ListLayerVersions.go +++ b/service/lambda/api_op_ListLayerVersions.go @@ -61,29 +61,29 @@ func (c *Client) ListLayerVersions(ctx context.Context, params *ListLayerVersion type ListLayerVersionsInput struct { + // The name or Amazon Resource Name (ARN) of the layer. + // + // This member is required. + LayerName *string + // A runtime identifier. For example, go1.x. CompatibleRuntime types.Runtime // A pagination token returned by a previous call. Marker *string - // The name or Amazon Resource Name (ARN) of the layer. - // - // This member is required. - LayerName *string - // The maximum number of versions to return. MaxItems *int32 } type ListLayerVersionsOutput struct { - // A pagination token returned when the response doesn't contain all versions. - NextMarker *string - // A list of versions. LayerVersions []*types.LayerVersionsListItem + // A pagination token returned when the response doesn't contain all versions. + NextMarker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lambda/api_op_ListLayers.go b/service/lambda/api_op_ListLayers.go index fd728ad6405..bfef32c0f4f 100644 --- a/service/lambda/api_op_ListLayers.go +++ b/service/lambda/api_op_ListLayers.go @@ -60,24 +60,24 @@ func (c *Client) ListLayers(ctx context.Context, params *ListLayersInput, optFns type ListLayersInput struct { - // The maximum number of layers to return. - MaxItems *int32 - // A runtime identifier. For example, go1.x. CompatibleRuntime types.Runtime // A pagination token returned by a previous call. Marker *string + + // The maximum number of layers to return. + MaxItems *int32 } type ListLayersOutput struct { - // A pagination token returned when the response doesn't contain all layers. - NextMarker *string - // A list of function layers. Layers []*types.LayersListItem + // A pagination token returned when the response doesn't contain all layers. + NextMarker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lambda/api_op_ListProvisionedConcurrencyConfigs.go b/service/lambda/api_op_ListProvisionedConcurrencyConfigs.go index 6fa00d781f4..e69bd018ade 100644 --- a/service/lambda/api_op_ListProvisionedConcurrencyConfigs.go +++ b/service/lambda/api_op_ListProvisionedConcurrencyConfigs.go @@ -57,13 +57,6 @@ func (c *Client) ListProvisionedConcurrencyConfigs(ctx context.Context, params * type ListProvisionedConcurrencyConfigsInput struct { - // Specify the pagination token that's returned by a previous request to retrieve - // the next page of results. - Marker *string - - // Specify a number to limit the number of configurations returned. - MaxItems *int32 - // The name of the Lambda function. Name formats // // * Function name - @@ -81,16 +74,23 @@ type ListProvisionedConcurrencyConfigsInput struct { // // This member is required. FunctionName *string + + // Specify the pagination token that's returned by a previous request to retrieve + // the next page of results. + Marker *string + + // Specify a number to limit the number of configurations returned. + MaxItems *int32 } type ListProvisionedConcurrencyConfigsOutput struct { - // A list of provisioned concurrency configurations. - ProvisionedConcurrencyConfigs []*types.ProvisionedConcurrencyConfigListItem - // The pagination token that's included if more results are available. NextMarker *string + // A list of provisioned concurrency configurations. + ProvisionedConcurrencyConfigs []*types.ProvisionedConcurrencyConfigListItem + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lambda/api_op_ListVersionsByFunction.go b/service/lambda/api_op_ListVersionsByFunction.go index 40e4192d048..58df76e58c6 100644 --- a/service/lambda/api_op_ListVersionsByFunction.go +++ b/service/lambda/api_op_ListVersionsByFunction.go @@ -60,10 +60,6 @@ func (c *Client) ListVersionsByFunction(ctx context.Context, params *ListVersion type ListVersionsByFunctionInput struct { - // Specify the pagination token that's returned by a previous request to retrieve - // the next page of results. - Marker *string - // The name of the Lambda function. Name formats // // * Function name - @@ -82,18 +78,22 @@ type ListVersionsByFunctionInput struct { // This member is required. FunctionName *string + // Specify the pagination token that's returned by a previous request to retrieve + // the next page of results. + Marker *string + // The maximum number of versions to return. MaxItems *int32 } type ListVersionsByFunctionOutput struct { - // A list of Lambda function versions. - Versions []*types.FunctionConfiguration - // The pagination token that's included if more results are available. NextMarker *string + // A list of Lambda function versions. + Versions []*types.FunctionConfiguration + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lambda/api_op_PublishLayerVersion.go b/service/lambda/api_op_PublishLayerVersion.go index c4920244586..cd142736107 100644 --- a/service/lambda/api_op_PublishLayerVersion.go +++ b/service/lambda/api_op_PublishLayerVersion.go @@ -66,9 +66,6 @@ type PublishLayerVersionInput struct { // This member is required. Content *types.LayerVersionContentInput - // The description of the version. - Description *string - // The name or Amazon Resource Name (ARN) of the layer. // // This member is required. @@ -79,6 +76,9 @@ type PublishLayerVersionInput struct { // filtering with ListLayers () and ListLayerVersions (). CompatibleRuntimes []types.Runtime + // The description of the version. + Description *string + // The layer's software license. It can be any of the following: // // * An SPDX @@ -94,31 +94,31 @@ type PublishLayerVersionInput struct { type PublishLayerVersionOutput struct { - // The description of the version. - Description *string - - // The ARN of the layer version. - LayerVersionArn *string + // The layer's compatible runtimes. + CompatibleRuntimes []types.Runtime - // The version number. - Version *int64 + // Details about the layer version. + Content *types.LayerVersionContentOutput // The date that the layer version was created, in ISO-8601 format // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). CreatedDate *string + // The description of the version. + Description *string + // The ARN of the layer. LayerArn *string - // Details about the layer version. - Content *types.LayerVersionContentOutput - - // The layer's compatible runtimes. - CompatibleRuntimes []types.Runtime + // The ARN of the layer version. + LayerVersionArn *string // The layer's software license. LicenseInfo *string + // The version number. + Version *int64 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lambda/api_op_PublishVersion.go b/service/lambda/api_op_PublishVersion.go index c5ea45469a8..74b3f12beda 100644 --- a/service/lambda/api_op_PublishVersion.go +++ b/service/lambda/api_op_PublishVersion.go @@ -65,21 +65,6 @@ func (c *Client) PublishVersion(ctx context.Context, params *PublishVersionInput type PublishVersionInput struct { - // Only update the function if the revision ID matches the ID that's specified. Use - // this option to avoid publishing a version if the function configuration has - // changed since you last updated it. - RevisionId *string - - // A description for the version to override the description in the function - // configuration. - Description *string - - // Only publish a version if the hash value matches the value that's specified. Use - // this option to avoid publishing a version if the function code has changed since - // you last updated it. You can get the hash for the version that you uploaded from - // the output of UpdateFunctionCode (). - CodeSha256 *string - // The name of the Lambda function. Name formats // // * Function name - @@ -97,98 +82,113 @@ type PublishVersionInput struct { // // This member is required. FunctionName *string + + // Only publish a version if the hash value matches the value that's specified. Use + // this option to avoid publishing a version if the function code has changed since + // you last updated it. You can get the hash for the version that you uploaded from + // the output of UpdateFunctionCode (). + CodeSha256 *string + + // A description for the version to override the description in the function + // configuration. + Description *string + + // Only update the function if the revision ID matches the ID that's specified. Use + // this option to avoid publishing a version if the function configuration has + // changed since you last updated it. + RevisionId *string } // Details about a function's configuration. type PublishVersionOutput struct { - // The name of the function. - FunctionName *string + // The SHA256 hash of the function's deployment package. + CodeSha256 *string - // The latest updated revision of the function or alias. - RevisionId *string + // The size of the function's deployment package, in bytes. + CodeSize *int64 - // For Lambda@Edge functions, the ARN of the master function. - MasterArn *string + // The function's dead letter queue. + DeadLetterConfig *types.DeadLetterConfig - // The status of the last update that was performed on the function. This is first - // set to Successful after function creation completes. - LastUpdateStatus types.LastUpdateStatus + // The function's description. + Description *string - // The function's layers - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). - Layers []*types.Layer + // The function's environment variables. + Environment *types.EnvironmentResponse // Connection settings for an Amazon EFS file system. FileSystemConfigs []*types.FileSystemConfig - // The function's networking configuration. - VpcConfig *types.VpcConfigResponse + // The function's Amazon Resource Name (ARN). + FunctionArn *string - // The runtime environment for the Lambda function. - Runtime types.Runtime + // The name of the function. + FunctionName *string - // The SHA256 hash of the function's deployment package. - CodeSha256 *string + // The function that Lambda calls to begin executing your function. + Handler *string + + // The KMS key that's used to encrypt the function's environment variables. This + // key is only returned if you've configured a customer managed CMK. + KMSKeyArn *string // The date and time that the function was last updated, in ISO-8601 format // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). LastModified *string - // The memory that's allocated to the function. - MemorySize *int32 - - // The version of the Lambda function. - Version *string - - // The amount of time in seconds that Lambda allows a function to run before - // stopping it. - Timeout *int32 - - // The size of the function's deployment package, in bytes. - CodeSize *int64 - - // The function's Amazon Resource Name (ARN). - FunctionArn *string - - // The function's environment variables. - Environment *types.EnvironmentResponse + // The status of the last update that was performed on the function. This is first + // set to Successful after function creation completes. + LastUpdateStatus types.LastUpdateStatus // The reason for the last update that was performed on the function. LastUpdateStatusReason *string - // The function that Lambda calls to begin executing your function. - Handler *string + // The reason code for the last update that was performed on the function. + LastUpdateStatusReasonCode types.LastUpdateStatusReasonCode - // The function's AWS X-Ray tracing configuration. - TracingConfig *types.TracingConfigResponse + // The function's layers + // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). + Layers []*types.Layer - // The reason code for the function's current state. When the code is Creating, you - // can't invoke or modify the function. - StateReasonCode types.StateReasonCode + // For Lambda@Edge functions, the ARN of the master function. + MasterArn *string - // The reason code for the last update that was performed on the function. - LastUpdateStatusReasonCode types.LastUpdateStatusReasonCode + // The memory that's allocated to the function. + MemorySize *int32 - // The function's description. - Description *string + // The latest updated revision of the function or alias. + RevisionId *string // The function's execution role. Role *string - // The KMS key that's used to encrypt the function's environment variables. This - // key is only returned if you've configured a customer managed CMK. - KMSKeyArn *string + // The runtime environment for the Lambda function. + Runtime types.Runtime - // The function's dead letter queue. - DeadLetterConfig *types.DeadLetterConfig + // The current state of the function. When the state is Inactive, you can + // reactivate the function by invoking it. + State types.State // The reason for the function's current state. StateReason *string - // The current state of the function. When the state is Inactive, you can - // reactivate the function by invoking it. - State types.State + // The reason code for the function's current state. When the code is Creating, you + // can't invoke or modify the function. + StateReasonCode types.StateReasonCode + + // The amount of time in seconds that Lambda allows a function to run before + // stopping it. + Timeout *int32 + + // The function's AWS X-Ray tracing configuration. + TracingConfig *types.TracingConfigResponse + + // The version of the Lambda function. + Version *string + + // The function's networking configuration. + VpcConfig *types.VpcConfigResponse // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/lambda/api_op_PutFunctionConcurrency.go b/service/lambda/api_op_PutFunctionConcurrency.go index 377e1e84dab..79e2de3f913 100644 --- a/service/lambda/api_op_PutFunctionConcurrency.go +++ b/service/lambda/api_op_PutFunctionConcurrency.go @@ -67,11 +67,6 @@ func (c *Client) PutFunctionConcurrency(ctx context.Context, params *PutFunction type PutFunctionConcurrencyInput struct { - // The number of simultaneous executions to reserve for the function. - // - // This member is required. - ReservedConcurrentExecutions *int32 - // The name of the Lambda function. Name formats // // * Function name - @@ -89,6 +84,11 @@ type PutFunctionConcurrencyInput struct { // // This member is required. FunctionName *string + + // The number of simultaneous executions to reserve for the function. + // + // This member is required. + ReservedConcurrentExecutions *int32 } type PutFunctionConcurrencyOutput struct { diff --git a/service/lambda/api_op_PutFunctionEventInvokeConfig.go b/service/lambda/api_op_PutFunctionEventInvokeConfig.go index 88e4f08b528..17d4993abcf 100644 --- a/service/lambda/api_op_PutFunctionEventInvokeConfig.go +++ b/service/lambda/api_op_PutFunctionEventInvokeConfig.go @@ -73,29 +73,6 @@ func (c *Client) PutFunctionEventInvokeConfig(ctx context.Context, params *PutFu type PutFunctionEventInvokeConfigInput struct { - // A version number or alias name. - Qualifier *string - - // The maximum number of times to retry when the function returns an error. - MaximumRetryAttempts *int32 - - // A destination for events after they have been sent to a function for processing. - // Destinations - // - // * Function - The Amazon Resource Name (ARN) of a Lambda - // function. - // - // * Queue - The ARN of an SQS queue. - // - // * Topic - The ARN of an - // SNS topic. - // - // * Event Bus - The ARN of an Amazon EventBridge event bus. - DestinationConfig *types.DestinationConfig - - // The maximum age of a request that Lambda sends to a function for processing. - MaximumEventAgeInSeconds *int32 - // The name of the Lambda function, version, or alias. Name formats // // * Function @@ -113,13 +90,33 @@ type PutFunctionEventInvokeConfigInput struct { // // This member is required. FunctionName *string -} -type PutFunctionEventInvokeConfigOutput struct { + // A destination for events after they have been sent to a function for processing. + // Destinations + // + // * Function - The Amazon Resource Name (ARN) of a Lambda + // function. + // + // * Queue - The ARN of an SQS queue. + // + // * Topic - The ARN of an + // SNS topic. + // + // * Event Bus - The ARN of an Amazon EventBridge event bus. + DestinationConfig *types.DestinationConfig // The maximum age of a request that Lambda sends to a function for processing. MaximumEventAgeInSeconds *int32 + // The maximum number of times to retry when the function returns an error. + MaximumRetryAttempts *int32 + + // A version number or alias name. + Qualifier *string +} + +type PutFunctionEventInvokeConfigOutput struct { + // A destination for events after they have been sent to a function for processing. // Destinations // @@ -134,15 +131,18 @@ type PutFunctionEventInvokeConfigOutput struct { // * Event Bus - The ARN of an Amazon EventBridge event bus. DestinationConfig *types.DestinationConfig + // The Amazon Resource Name (ARN) of the function. + FunctionArn *string + // The date and time that the configuration was last updated. LastModified *time.Time + // The maximum age of a request that Lambda sends to a function for processing. + MaximumEventAgeInSeconds *int32 + // The maximum number of times to retry when the function returns an error. MaximumRetryAttempts *int32 - // The Amazon Resource Name (ARN) of the function. - FunctionArn *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lambda/api_op_PutProvisionedConcurrencyConfig.go b/service/lambda/api_op_PutProvisionedConcurrencyConfig.go index 54037daaf8d..06f15f369fc 100644 --- a/service/lambda/api_op_PutProvisionedConcurrencyConfig.go +++ b/service/lambda/api_op_PutProvisionedConcurrencyConfig.go @@ -88,9 +88,19 @@ type PutProvisionedConcurrencyConfigInput struct { type PutProvisionedConcurrencyConfigOutput struct { + // The amount of provisioned concurrency allocated. + AllocatedProvisionedConcurrentExecutions *int32 + // The amount of provisioned concurrency available. AvailableProvisionedConcurrentExecutions *int32 + // The date and time that a user last updated the configuration, in ISO 8601 format + // (https://www.iso.org/iso-8601-date-and-time-format.html). + LastModified *string + + // The amount of provisioned concurrency requested. + RequestedProvisionedConcurrentExecutions *int32 + // The status of the allocation process. Status types.ProvisionedConcurrencyStatusEnum @@ -98,16 +108,6 @@ type PutProvisionedConcurrencyConfigOutput struct { // allocated. StatusReason *string - // The amount of provisioned concurrency requested. - RequestedProvisionedConcurrentExecutions *int32 - - // The amount of provisioned concurrency allocated. - AllocatedProvisionedConcurrentExecutions *int32 - - // The date and time that a user last updated the configuration, in ISO 8601 format - // (https://www.iso.org/iso-8601-date-and-time-format.html). - LastModified *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lambda/api_op_RemoveLayerVersionPermission.go b/service/lambda/api_op_RemoveLayerVersionPermission.go index 444fcd7c2fb..d5079d85fc5 100644 --- a/service/lambda/api_op_RemoveLayerVersionPermission.go +++ b/service/lambda/api_op_RemoveLayerVersionPermission.go @@ -58,11 +58,6 @@ func (c *Client) RemoveLayerVersionPermission(ctx context.Context, params *Remov type RemoveLayerVersionPermissionInput struct { - // The version number. - // - // This member is required. - VersionNumber *int64 - // The name or Amazon Resource Name (ARN) of the layer. // // This member is required. @@ -73,6 +68,11 @@ type RemoveLayerVersionPermissionInput struct { // This member is required. StatementId *string + // The version number. + // + // This member is required. + VersionNumber *int64 + // Only update the policy if the revision ID matches the ID specified. Use this // option to avoid modifying a policy that has changed since you last read it. RevisionId *string diff --git a/service/lambda/api_op_TagResource.go b/service/lambda/api_op_TagResource.go index 142011e9b82..33835bc4a42 100644 --- a/service/lambda/api_op_TagResource.go +++ b/service/lambda/api_op_TagResource.go @@ -57,15 +57,15 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // A list of tags to apply to the function. + // The function's Amazon Resource Name (ARN). // // This member is required. - Tags map[string]*string + Resource *string - // The function's Amazon Resource Name (ARN). + // A list of tags to apply to the function. // // This member is required. - Resource *string + Tags map[string]*string } type TagResourceOutput struct { diff --git a/service/lambda/api_op_UntagResource.go b/service/lambda/api_op_UntagResource.go index 2b76e46ccf9..b1beea3b462 100644 --- a/service/lambda/api_op_UntagResource.go +++ b/service/lambda/api_op_UntagResource.go @@ -57,15 +57,15 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // A list of tag keys to remove from the function. + // The function's Amazon Resource Name (ARN). // // This member is required. - TagKeys []*string + Resource *string - // The function's Amazon Resource Name (ARN). + // A list of tag keys to remove from the function. // // This member is required. - Resource *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/lambda/api_op_UpdateAlias.go b/service/lambda/api_op_UpdateAlias.go index ad77c92d114..1732d3f7b42 100644 --- a/service/lambda/api_op_UpdateAlias.go +++ b/service/lambda/api_op_UpdateAlias.go @@ -58,26 +58,6 @@ func (c *Client) UpdateAlias(ctx context.Context, params *UpdateAliasInput, optF type UpdateAliasInput struct { - // The name of the alias. - // - // This member is required. - Name *string - - // The function version that the alias invokes. - FunctionVersion *string - - // The routing configuration - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html#configuring-alias-routing) - // of the alias. - RoutingConfig *types.AliasRoutingConfiguration - - // Only update the alias if the revision ID matches the ID that's specified. Use - // this option to avoid modifying an alias that has changed since you last read it. - RevisionId *string - - // A description of the alias. - Description *string - // The name of the Lambda function. Name formats // // * Function name - @@ -95,31 +75,51 @@ type UpdateAliasInput struct { // // This member is required. FunctionName *string -} -// Provides configuration information about a Lambda function alias -// (https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html). -type UpdateAliasOutput struct { + // The name of the alias. + // + // This member is required. + Name *string + + // A description of the alias. + Description *string + + // The function version that the alias invokes. + FunctionVersion *string + + // Only update the alias if the revision ID matches the ID that's specified. Use + // this option to avoid modifying an alias that has changed since you last read it. + RevisionId *string // The routing configuration - // (https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) + // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html#configuring-alias-routing) // of the alias. RoutingConfig *types.AliasRoutingConfiguration +} - // The name of the alias. - Name *string +// Provides configuration information about a Lambda function alias +// (https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html). +type UpdateAliasOutput struct { // The Amazon Resource Name (ARN) of the alias. AliasArn *string - // A unique identifier that changes when you update the alias. - RevisionId *string + // A description of the alias. + Description *string // The function version that the alias invokes. FunctionVersion *string - // A description of the alias. - Description *string + // The name of the alias. + Name *string + + // A unique identifier that changes when you update the alias. + RevisionId *string + + // The routing configuration + // (https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) + // of the alias. + RoutingConfig *types.AliasRoutingConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/lambda/api_op_UpdateEventSourceMapping.go b/service/lambda/api_op_UpdateEventSourceMapping.go index 7bda4fa5822..ddffc8daebb 100644 --- a/service/lambda/api_op_UpdateEventSourceMapping.go +++ b/service/lambda/api_op_UpdateEventSourceMapping.go @@ -76,17 +76,6 @@ func (c *Client) UpdateEventSourceMapping(ctx context.Context, params *UpdateEve type UpdateEventSourceMappingInput struct { - // Disables the event source mapping to pause polling and invocation. - Enabled *bool - - // (Streams) The maximum amount of time to gather records before invoking the - // function, in seconds. - MaximumBatchingWindowInSeconds *int32 - - // (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded - // records. - DestinationConfig *types.DestinationConfig - // The identifier of the event source mapping. // // This member is required. @@ -103,6 +92,16 @@ type UpdateEventSourceMappingInput struct { // * Amazon Simple Queue Service - Default 10. Max 10. BatchSize *int32 + // (Streams) If the function returns an error, split the batch in two and retry. + BisectBatchOnFunctionError *bool + + // (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded + // records. + DestinationConfig *types.DestinationConfig + + // Disables the event source mapping to pause polling and invocation. + Enabled *bool + // The name of the Lambda function. Name formats // // * Function name - @@ -122,70 +121,71 @@ type UpdateEventSourceMappingInput struct { // characters in length. FunctionName *string + // (Streams) The maximum amount of time to gather records before invoking the + // function, in seconds. + MaximumBatchingWindowInSeconds *int32 + // (Streams) The maximum age of a record that Lambda sends to a function for // processing. MaximumRecordAgeInSeconds *int32 - // (Streams) The number of batches to process from each shard concurrently. - ParallelizationFactor *int32 - // (Streams) The maximum number of times to retry when the function returns an // error. MaximumRetryAttempts *int32 - // (Streams) If the function returns an error, split the batch in two and retry. - BisectBatchOnFunctionError *bool + // (Streams) The number of batches to process from each shard concurrently. + ParallelizationFactor *int32 } // A mapping between an AWS resource and an AWS Lambda function. See // CreateEventSourceMapping () for details. type UpdateEventSourceMappingOutput struct { - // The state of the event source mapping. It can be one of the following: Creating, - // Enabling, Enabled, Disabling, Disabled, Updating, or Deleting. - State *string + // The maximum number of items to retrieve in a single batch. + BatchSize *int32 + + // (Streams) If the function returns an error, split the batch in two and retry. + BisectBatchOnFunctionError *bool // (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded // records. DestinationConfig *types.DestinationConfig + // The Amazon Resource Name (ARN) of the event source. + EventSourceArn *string + + // The ARN of the Lambda function. + FunctionArn *string + + // The date that the event source mapping was last updated, or its state changed. + LastModified *time.Time + + // The result of the last AWS Lambda invocation of your Lambda function. + LastProcessingResult *string + // (Streams) The maximum amount of time to gather records before invoking the // function, in seconds. MaximumBatchingWindowInSeconds *int32 + // (Streams) The maximum age of a record that Lambda sends to a function for + // processing. + MaximumRecordAgeInSeconds *int32 + // (Streams) The maximum number of times to retry when the function returns an // error. MaximumRetryAttempts *int32 - // The maximum number of items to retrieve in a single batch. - BatchSize *int32 - - // The result of the last AWS Lambda invocation of your Lambda function. - LastProcessingResult *string - // (Streams) The number of batches to process from each shard concurrently. ParallelizationFactor *int32 - // (Streams) If the function returns an error, split the batch in two and retry. - BisectBatchOnFunctionError *bool + // The state of the event source mapping. It can be one of the following: Creating, + // Enabling, Enabled, Disabling, Disabled, Updating, or Deleting. + State *string // Indicates whether the last change to the event source mapping was made by a // user, or by the Lambda service. StateTransitionReason *string - // (Streams) The maximum age of a record that Lambda sends to a function for - // processing. - MaximumRecordAgeInSeconds *int32 - - // The date that the event source mapping was last updated, or its state changed. - LastModified *time.Time - - // The ARN of the Lambda function. - FunctionArn *string - - // The Amazon Resource Name (ARN) of the event source. - EventSourceArn *string - // The identifier of the event source mapping. UUID *string diff --git a/service/lambda/api_op_UpdateFunctionCode.go b/service/lambda/api_op_UpdateFunctionCode.go index 50f93c558b7..5348e45911d 100644 --- a/service/lambda/api_op_UpdateFunctionCode.go +++ b/service/lambda/api_op_UpdateFunctionCode.go @@ -59,24 +59,6 @@ func (c *Client) UpdateFunctionCode(ctx context.Context, params *UpdateFunctionC type UpdateFunctionCodeInput struct { - // An Amazon S3 bucket in the same AWS Region as your function. The bucket can be - // in a different AWS account. - S3Bucket *string - - // The Amazon S3 key of the deployment package. - S3Key *string - - // For versioned objects, the version of the deployment package object to use. - S3ObjectVersion *string - - // The base64-encoded contents of the deployment package. AWS SDK and AWS CLI - // clients handle the encoding for you. - ZipFile []byte - - // Set to true to validate the request parameters and access permissions without - // modifying the function code. - DryRun *bool - // The name of the Lambda function. Name formats // // * Function name - @@ -95,106 +77,124 @@ type UpdateFunctionCodeInput struct { // This member is required. FunctionName *string + // Set to true to validate the request parameters and access permissions without + // modifying the function code. + DryRun *bool + + // Set to true to publish a new version of the function after updating the code. + // This has the same effect as calling PublishVersion () separately. + Publish *bool + // Only update the function if the revision ID matches the ID that's specified. Use // this option to avoid modifying a function that has changed since you last read // it. RevisionId *string - // Set to true to publish a new version of the function after updating the code. - // This has the same effect as calling PublishVersion () separately. - Publish *bool + // An Amazon S3 bucket in the same AWS Region as your function. The bucket can be + // in a different AWS account. + S3Bucket *string + + // The Amazon S3 key of the deployment package. + S3Key *string + + // For versioned objects, the version of the deployment package object to use. + S3ObjectVersion *string + + // The base64-encoded contents of the deployment package. AWS SDK and AWS CLI + // clients handle the encoding for you. + ZipFile []byte } // Details about a function's configuration. type UpdateFunctionCodeOutput struct { - // The name of the function. - FunctionName *string + // The SHA256 hash of the function's deployment package. + CodeSha256 *string - // The latest updated revision of the function or alias. - RevisionId *string + // The size of the function's deployment package, in bytes. + CodeSize *int64 - // For Lambda@Edge functions, the ARN of the master function. - MasterArn *string + // The function's dead letter queue. + DeadLetterConfig *types.DeadLetterConfig - // The status of the last update that was performed on the function. This is first - // set to Successful after function creation completes. - LastUpdateStatus types.LastUpdateStatus + // The function's description. + Description *string - // The function's layers - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). - Layers []*types.Layer + // The function's environment variables. + Environment *types.EnvironmentResponse // Connection settings for an Amazon EFS file system. FileSystemConfigs []*types.FileSystemConfig - // The function's networking configuration. - VpcConfig *types.VpcConfigResponse + // The function's Amazon Resource Name (ARN). + FunctionArn *string - // The runtime environment for the Lambda function. - Runtime types.Runtime + // The name of the function. + FunctionName *string - // The SHA256 hash of the function's deployment package. - CodeSha256 *string + // The function that Lambda calls to begin executing your function. + Handler *string + + // The KMS key that's used to encrypt the function's environment variables. This + // key is only returned if you've configured a customer managed CMK. + KMSKeyArn *string // The date and time that the function was last updated, in ISO-8601 format // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). LastModified *string - // The memory that's allocated to the function. - MemorySize *int32 - - // The version of the Lambda function. - Version *string - - // The amount of time in seconds that Lambda allows a function to run before - // stopping it. - Timeout *int32 - - // The size of the function's deployment package, in bytes. - CodeSize *int64 - - // The function's Amazon Resource Name (ARN). - FunctionArn *string - - // The function's environment variables. - Environment *types.EnvironmentResponse + // The status of the last update that was performed on the function. This is first + // set to Successful after function creation completes. + LastUpdateStatus types.LastUpdateStatus // The reason for the last update that was performed on the function. LastUpdateStatusReason *string - // The function that Lambda calls to begin executing your function. - Handler *string + // The reason code for the last update that was performed on the function. + LastUpdateStatusReasonCode types.LastUpdateStatusReasonCode - // The function's AWS X-Ray tracing configuration. - TracingConfig *types.TracingConfigResponse + // The function's layers + // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). + Layers []*types.Layer - // The reason code for the function's current state. When the code is Creating, you - // can't invoke or modify the function. - StateReasonCode types.StateReasonCode + // For Lambda@Edge functions, the ARN of the master function. + MasterArn *string - // The reason code for the last update that was performed on the function. - LastUpdateStatusReasonCode types.LastUpdateStatusReasonCode + // The memory that's allocated to the function. + MemorySize *int32 - // The function's description. - Description *string + // The latest updated revision of the function or alias. + RevisionId *string // The function's execution role. Role *string - // The KMS key that's used to encrypt the function's environment variables. This - // key is only returned if you've configured a customer managed CMK. - KMSKeyArn *string + // The runtime environment for the Lambda function. + Runtime types.Runtime - // The function's dead letter queue. - DeadLetterConfig *types.DeadLetterConfig + // The current state of the function. When the state is Inactive, you can + // reactivate the function by invoking it. + State types.State // The reason for the function's current state. StateReason *string - // The current state of the function. When the state is Inactive, you can - // reactivate the function by invoking it. - State types.State + // The reason code for the function's current state. When the code is Creating, you + // can't invoke or modify the function. + StateReasonCode types.StateReasonCode + + // The amount of time in seconds that Lambda allows a function to run before + // stopping it. + Timeout *int32 + + // The function's AWS X-Ray tracing configuration. + TracingConfig *types.TracingConfigResponse + + // The version of the Lambda function. + Version *string + + // The function's networking configuration. + VpcConfig *types.VpcConfigResponse // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/lambda/api_op_UpdateFunctionConfiguration.go b/service/lambda/api_op_UpdateFunctionConfiguration.go index cf9ba19fb30..e65d376f4e3 100644 --- a/service/lambda/api_op_UpdateFunctionConfiguration.go +++ b/service/lambda/api_op_UpdateFunctionConfiguration.go @@ -71,29 +71,38 @@ func (c *Client) UpdateFunctionConfiguration(ctx context.Context, params *Update type UpdateFunctionConfigurationInput struct { - // Only update the function if the revision ID matches the ID that's specified. Use - // this option to avoid modifying a function that has changed since you last read - // it. - RevisionId *string - - // The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt - // your function's environment variables. If it's not provided, AWS Lambda uses a - // default service key. - KMSKeyArn *string + // The name of the Lambda function. Name formats + // + // * Function name - + // my-function. + // + // * Function ARN - + // arn:aws:lambda:us-west-2:123456789012:function:my-function. + // + // * Partial ARN - + // 123456789012:function:my-function. + // + // The length constraint applies only to the + // full ARN. If you specify only the function name, it is limited to 64 characters + // in length. + // + // This member is required. + FunctionName *string - // The amount of memory that your function has access to. Increasing the function's - // memory also increases its CPU allocation. The default value is 128 MB. The value - // must be a multiple of 64 MB. - MemorySize *int32 + // A dead letter queue configuration that specifies the queue or topic where Lambda + // sends asynchronous events when they fail processing. For more information, see + // Dead Letter Queues + // (https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq). + DeadLetterConfig *types.DeadLetterConfig // A description of the function. Description *string - // A list of function layers - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add - // to the function's execution environment. Specify each layer by its ARN, - // including the version. - Layers []*string + // Environment variables that are accessible from function code during execution. + Environment *types.Environment + + // Connection settings for an Amazon EFS file system. + FileSystemConfigs []*types.FileSystemConfig // The name of the method within your code that Lambda calls to execute your // function. The format includes the file name. It can also include namespaces and @@ -102,50 +111,41 @@ type UpdateFunctionConfigurationInput struct { // (https://docs.aws.amazon.com/lambda/latest/dg/programming-model-v2.html). Handler *string - // Set Mode to Active to sample and trace a subset of incoming requests with AWS - // X-Ray. - TracingConfig *types.TracingConfig + // The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt + // your function's environment variables. If it's not provided, AWS Lambda uses a + // default service key. + KMSKeyArn *string - // The amount of time that Lambda allows a function to run before stopping it. The - // default is 3 seconds. The maximum allowed value is 900 seconds. - Timeout *int32 + // A list of function layers + // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add + // to the function's execution environment. Specify each layer by its ARN, + // including the version. + Layers []*string - // Connection settings for an Amazon EFS file system. - FileSystemConfigs []*types.FileSystemConfig + // The amount of memory that your function has access to. Increasing the function's + // memory also increases its CPU allocation. The default value is 128 MB. The value + // must be a multiple of 64 MB. + MemorySize *int32 + + // Only update the function if the revision ID matches the ID that's specified. Use + // this option to avoid modifying a function that has changed since you last read + // it. + RevisionId *string // The Amazon Resource Name (ARN) of the function's execution role. Role *string - // The name of the Lambda function. Name formats - // - // * Function name - - // my-function. - // - // * Function ARN - - // arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * Partial ARN - - // 123456789012:function:my-function. - // - // The length constraint applies only to the - // full ARN. If you specify only the function name, it is limited to 64 characters - // in length. - // - // This member is required. - FunctionName *string - // The identifier of the function's runtime // (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). Runtime types.Runtime - // Environment variables that are accessible from function code during execution. - Environment *types.Environment + // The amount of time that Lambda allows a function to run before stopping it. The + // default is 3 seconds. The maximum allowed value is 900 seconds. + Timeout *int32 - // A dead letter queue configuration that specifies the queue or topic where Lambda - // sends asynchronous events when they fail processing. For more information, see - // Dead Letter Queues - // (https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq). - DeadLetterConfig *types.DeadLetterConfig + // Set Mode to Active to sample and trace a subset of incoming requests with AWS + // X-Ray. + TracingConfig *types.TracingConfig // For network connectivity to AWS resources in a VPC, specify a list of security // groups and subnets in the VPC. When you connect a function to a VPC, it can only @@ -158,93 +158,93 @@ type UpdateFunctionConfigurationInput struct { // Details about a function's configuration. type UpdateFunctionConfigurationOutput struct { - // The name of the function. - FunctionName *string + // The SHA256 hash of the function's deployment package. + CodeSha256 *string - // The latest updated revision of the function or alias. - RevisionId *string + // The size of the function's deployment package, in bytes. + CodeSize *int64 - // For Lambda@Edge functions, the ARN of the master function. - MasterArn *string + // The function's dead letter queue. + DeadLetterConfig *types.DeadLetterConfig - // The status of the last update that was performed on the function. This is first - // set to Successful after function creation completes. - LastUpdateStatus types.LastUpdateStatus + // The function's description. + Description *string - // The function's layers - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). - Layers []*types.Layer + // The function's environment variables. + Environment *types.EnvironmentResponse // Connection settings for an Amazon EFS file system. FileSystemConfigs []*types.FileSystemConfig - // The function's networking configuration. - VpcConfig *types.VpcConfigResponse + // The function's Amazon Resource Name (ARN). + FunctionArn *string - // The runtime environment for the Lambda function. - Runtime types.Runtime + // The name of the function. + FunctionName *string - // The SHA256 hash of the function's deployment package. - CodeSha256 *string + // The function that Lambda calls to begin executing your function. + Handler *string + + // The KMS key that's used to encrypt the function's environment variables. This + // key is only returned if you've configured a customer managed CMK. + KMSKeyArn *string // The date and time that the function was last updated, in ISO-8601 format // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). LastModified *string - // The memory that's allocated to the function. - MemorySize *int32 - - // The version of the Lambda function. - Version *string - - // The amount of time in seconds that Lambda allows a function to run before - // stopping it. - Timeout *int32 - - // The size of the function's deployment package, in bytes. - CodeSize *int64 - - // The function's Amazon Resource Name (ARN). - FunctionArn *string - - // The function's environment variables. - Environment *types.EnvironmentResponse + // The status of the last update that was performed on the function. This is first + // set to Successful after function creation completes. + LastUpdateStatus types.LastUpdateStatus // The reason for the last update that was performed on the function. LastUpdateStatusReason *string - // The function that Lambda calls to begin executing your function. - Handler *string + // The reason code for the last update that was performed on the function. + LastUpdateStatusReasonCode types.LastUpdateStatusReasonCode - // The function's AWS X-Ray tracing configuration. - TracingConfig *types.TracingConfigResponse + // The function's layers + // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). + Layers []*types.Layer - // The reason code for the function's current state. When the code is Creating, you - // can't invoke or modify the function. - StateReasonCode types.StateReasonCode + // For Lambda@Edge functions, the ARN of the master function. + MasterArn *string - // The reason code for the last update that was performed on the function. - LastUpdateStatusReasonCode types.LastUpdateStatusReasonCode + // The memory that's allocated to the function. + MemorySize *int32 - // The function's description. - Description *string + // The latest updated revision of the function or alias. + RevisionId *string // The function's execution role. Role *string - // The KMS key that's used to encrypt the function's environment variables. This - // key is only returned if you've configured a customer managed CMK. - KMSKeyArn *string + // The runtime environment for the Lambda function. + Runtime types.Runtime - // The function's dead letter queue. - DeadLetterConfig *types.DeadLetterConfig + // The current state of the function. When the state is Inactive, you can + // reactivate the function by invoking it. + State types.State // The reason for the function's current state. StateReason *string - // The current state of the function. When the state is Inactive, you can - // reactivate the function by invoking it. - State types.State + // The reason code for the function's current state. When the code is Creating, you + // can't invoke or modify the function. + StateReasonCode types.StateReasonCode + + // The amount of time in seconds that Lambda allows a function to run before + // stopping it. + Timeout *int32 + + // The function's AWS X-Ray tracing configuration. + TracingConfig *types.TracingConfigResponse + + // The version of the Lambda function. + Version *string + + // The function's networking configuration. + VpcConfig *types.VpcConfigResponse // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/lambda/api_op_UpdateFunctionEventInvokeConfig.go b/service/lambda/api_op_UpdateFunctionEventInvokeConfig.go index db48477b5e9..e35ebc7c81f 100644 --- a/service/lambda/api_op_UpdateFunctionEventInvokeConfig.go +++ b/service/lambda/api_op_UpdateFunctionEventInvokeConfig.go @@ -78,15 +78,6 @@ type UpdateFunctionEventInvokeConfigInput struct { // This member is required. FunctionName *string - // The maximum age of a request that Lambda sends to a function for processing. - MaximumEventAgeInSeconds *int32 - - // A version number or alias name. - Qualifier *string - - // The maximum number of times to retry when the function returns an error. - MaximumRetryAttempts *int32 - // A destination for events after they have been sent to a function for processing. // Destinations // @@ -100,13 +91,19 @@ type UpdateFunctionEventInvokeConfigInput struct { // // * Event Bus - The ARN of an Amazon EventBridge event bus. DestinationConfig *types.DestinationConfig -} - -type UpdateFunctionEventInvokeConfigOutput struct { // The maximum age of a request that Lambda sends to a function for processing. MaximumEventAgeInSeconds *int32 + // The maximum number of times to retry when the function returns an error. + MaximumRetryAttempts *int32 + + // A version number or alias name. + Qualifier *string +} + +type UpdateFunctionEventInvokeConfigOutput struct { + // A destination for events after they have been sent to a function for processing. // Destinations // @@ -121,15 +118,18 @@ type UpdateFunctionEventInvokeConfigOutput struct { // * Event Bus - The ARN of an Amazon EventBridge event bus. DestinationConfig *types.DestinationConfig + // The Amazon Resource Name (ARN) of the function. + FunctionArn *string + // The date and time that the configuration was last updated. LastModified *time.Time + // The maximum age of a request that Lambda sends to a function for processing. + MaximumEventAgeInSeconds *int32 + // The maximum number of times to retry when the function returns an error. MaximumRetryAttempts *int32 - // The Amazon Resource Name (ARN) of the function. - FunctionArn *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lambda/go.mod b/service/lambda/go.mod index 52d65803dee..97677ef6389 100644 --- a/service/lambda/go.mod +++ b/service/lambda/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/lambda go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/lambda/types/types.go b/service/lambda/types/types.go index 0b1b0846439..36819cad6ea 100644 --- a/service/lambda/types/types.go +++ b/service/lambda/types/types.go @@ -10,6 +10,14 @@ import ( // are in bytes. type AccountLimit struct { + // The maximum size of a function's deployment package and layers when they're + // extracted. + CodeSizeUnzipped *int64 + + // The maximum size of a deployment package when it's uploaded directly to AWS + // Lambda. Use Amazon S3 for larger files. + CodeSizeZipped *int64 + // The maximum number of simultaneous function executions. ConcurrentExecutions *int32 @@ -17,17 +25,9 @@ type AccountLimit struct { // layer archives. TotalCodeSize *int64 - // The maximum size of a deployment package when it's uploaded directly to AWS - // Lambda. Use Amazon S3 for larger files. - CodeSizeZipped *int64 - // The maximum number of simultaneous function executions, minus the capacity // that's reserved for individual functions with PutFunctionConcurrency (). UnreservedConcurrentExecutions *int32 - - // The maximum size of a function's deployment package and layers when they're - // extracted. - CodeSizeUnzipped *int64 } // The number of functions and amount of storage in use. @@ -45,25 +45,25 @@ type AccountUsage struct { // (https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html). type AliasConfiguration struct { - // The routing configuration - // (https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) - // of the alias. - RoutingConfig *AliasRoutingConfiguration - - // The name of the alias. - Name *string - // The Amazon Resource Name (ARN) of the alias. AliasArn *string - // A unique identifier that changes when you update the alias. - RevisionId *string + // A description of the alias. + Description *string // The function version that the alias invokes. FunctionVersion *string - // A description of the alias. - Description *string + // The name of the alias. + Name *string + + // A unique identifier that changes when you update the alias. + RevisionId *string + + // The routing configuration + // (https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) + // of the alias. + RoutingConfig *AliasRoutingConfiguration } // The traffic-shifting @@ -96,11 +96,11 @@ type DeadLetterConfig struct { // processes it. type DestinationConfig struct { - // The destination configuration for successful invocations. - OnSuccess *OnSuccess - // The destination configuration for failed invocations. OnFailure *OnFailure + + // The destination configuration for successful invocations. + OnSuccess *OnSuccess } // A function's environment variable settings. @@ -113,11 +113,11 @@ type Environment struct { // Error messages for environment variables that couldn't be applied. type EnvironmentError struct { - // The error message. - Message *string - // The error code. ErrorCode *string + + // The error message. + Message *string } // The results of an operation to update or read environment variables. If the @@ -125,62 +125,62 @@ type EnvironmentError struct { // failed, the response contains details about the error. type EnvironmentResponse struct { - // Environment variable key-value pairs. - Variables map[string]*string - // Error messages for environment variables that couldn't be applied. Error *EnvironmentError + + // Environment variable key-value pairs. + Variables map[string]*string } // A mapping between an AWS resource and an AWS Lambda function. See // CreateEventSourceMapping () for details. type EventSourceMappingConfiguration struct { - // The state of the event source mapping. It can be one of the following: Creating, - // Enabling, Enabled, Disabling, Disabled, Updating, or Deleting. - State *string + // The maximum number of items to retrieve in a single batch. + BatchSize *int32 + + // (Streams) If the function returns an error, split the batch in two and retry. + BisectBatchOnFunctionError *bool // (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded // records. DestinationConfig *DestinationConfig + // The Amazon Resource Name (ARN) of the event source. + EventSourceArn *string + + // The ARN of the Lambda function. + FunctionArn *string + + // The date that the event source mapping was last updated, or its state changed. + LastModified *time.Time + + // The result of the last AWS Lambda invocation of your Lambda function. + LastProcessingResult *string + // (Streams) The maximum amount of time to gather records before invoking the // function, in seconds. MaximumBatchingWindowInSeconds *int32 + // (Streams) The maximum age of a record that Lambda sends to a function for + // processing. + MaximumRecordAgeInSeconds *int32 + // (Streams) The maximum number of times to retry when the function returns an // error. MaximumRetryAttempts *int32 - // The maximum number of items to retrieve in a single batch. - BatchSize *int32 - - // The result of the last AWS Lambda invocation of your Lambda function. - LastProcessingResult *string - // (Streams) The number of batches to process from each shard concurrently. ParallelizationFactor *int32 - // (Streams) If the function returns an error, split the batch in two and retry. - BisectBatchOnFunctionError *bool + // The state of the event source mapping. It can be one of the following: Creating, + // Enabling, Enabled, Disabling, Disabled, Updating, or Deleting. + State *string // Indicates whether the last change to the event source mapping was made by a // user, or by the Lambda service. StateTransitionReason *string - // (Streams) The maximum age of a record that Lambda sends to a function for - // processing. - MaximumRecordAgeInSeconds *int32 - - // The date that the event source mapping was last updated, or its state changed. - LastModified *time.Time - - // The ARN of the Lambda function. - FunctionArn *string - - // The Amazon Resource Name (ARN) of the event source. - EventSourceArn *string - // The identifier of the event source mapping. UUID *string } @@ -205,9 +205,6 @@ type FileSystemConfig struct { // or upload a deployment package directly. type FunctionCode struct { - // For versioned objects, the version of the deployment package object to use. - S3ObjectVersion *string - // An Amazon S3 bucket in the same AWS Region as your function. The bucket can be // in a different AWS account. S3Bucket *string @@ -215,6 +212,9 @@ type FunctionCode struct { // The Amazon S3 key of the deployment package. S3Key *string + // For versioned objects, the version of the deployment package object to use. + S3ObjectVersion *string + // The base64-encoded contents of the deployment package. AWS SDK and AWS CLI // clients handle the encoding for you. ZipFile []byte @@ -233,100 +233,97 @@ type FunctionCodeLocation struct { // Details about a function's configuration. type FunctionConfiguration struct { - // The name of the function. - FunctionName *string + // The SHA256 hash of the function's deployment package. + CodeSha256 *string - // The latest updated revision of the function or alias. - RevisionId *string + // The size of the function's deployment package, in bytes. + CodeSize *int64 - // For Lambda@Edge functions, the ARN of the master function. - MasterArn *string + // The function's dead letter queue. + DeadLetterConfig *DeadLetterConfig - // The status of the last update that was performed on the function. This is first - // set to Successful after function creation completes. - LastUpdateStatus LastUpdateStatus + // The function's description. + Description *string - // The function's layers - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). - Layers []*Layer + // The function's environment variables. + Environment *EnvironmentResponse // Connection settings for an Amazon EFS file system. FileSystemConfigs []*FileSystemConfig - // The function's networking configuration. - VpcConfig *VpcConfigResponse + // The function's Amazon Resource Name (ARN). + FunctionArn *string - // The runtime environment for the Lambda function. - Runtime Runtime + // The name of the function. + FunctionName *string - // The SHA256 hash of the function's deployment package. - CodeSha256 *string + // The function that Lambda calls to begin executing your function. + Handler *string + + // The KMS key that's used to encrypt the function's environment variables. This + // key is only returned if you've configured a customer managed CMK. + KMSKeyArn *string // The date and time that the function was last updated, in ISO-8601 format // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). LastModified *string - // The memory that's allocated to the function. - MemorySize *int32 - - // The version of the Lambda function. - Version *string - - // The amount of time in seconds that Lambda allows a function to run before - // stopping it. - Timeout *int32 - - // The size of the function's deployment package, in bytes. - CodeSize *int64 - - // The function's Amazon Resource Name (ARN). - FunctionArn *string - - // The function's environment variables. - Environment *EnvironmentResponse + // The status of the last update that was performed on the function. This is first + // set to Successful after function creation completes. + LastUpdateStatus LastUpdateStatus // The reason for the last update that was performed on the function. LastUpdateStatusReason *string - // The function that Lambda calls to begin executing your function. - Handler *string + // The reason code for the last update that was performed on the function. + LastUpdateStatusReasonCode LastUpdateStatusReasonCode - // The function's AWS X-Ray tracing configuration. - TracingConfig *TracingConfigResponse + // The function's layers + // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). + Layers []*Layer - // The reason code for the function's current state. When the code is Creating, you - // can't invoke or modify the function. - StateReasonCode StateReasonCode + // For Lambda@Edge functions, the ARN of the master function. + MasterArn *string - // The reason code for the last update that was performed on the function. - LastUpdateStatusReasonCode LastUpdateStatusReasonCode + // The memory that's allocated to the function. + MemorySize *int32 - // The function's description. - Description *string + // The latest updated revision of the function or alias. + RevisionId *string // The function's execution role. Role *string - // The KMS key that's used to encrypt the function's environment variables. This - // key is only returned if you've configured a customer managed CMK. - KMSKeyArn *string + // The runtime environment for the Lambda function. + Runtime Runtime - // The function's dead letter queue. - DeadLetterConfig *DeadLetterConfig + // The current state of the function. When the state is Inactive, you can + // reactivate the function by invoking it. + State State // The reason for the function's current state. StateReason *string - // The current state of the function. When the state is Inactive, you can - // reactivate the function by invoking it. - State State + // The reason code for the function's current state. When the code is Creating, you + // can't invoke or modify the function. + StateReasonCode StateReasonCode + + // The amount of time in seconds that Lambda allows a function to run before + // stopping it. + Timeout *int32 + + // The function's AWS X-Ray tracing configuration. + TracingConfig *TracingConfigResponse + + // The version of the Lambda function. + Version *string + + // The function's networking configuration. + VpcConfig *VpcConfigResponse } type FunctionEventInvokeConfig struct { - // The maximum age of a request that Lambda sends to a function for processing. - MaximumEventAgeInSeconds *int32 - // A destination for events after they have been sent to a function for processing. // Destinations // @@ -341,14 +338,17 @@ type FunctionEventInvokeConfig struct { // * Event Bus - The ARN of an Amazon EventBridge event bus. DestinationConfig *DestinationConfig + // The Amazon Resource Name (ARN) of the function. + FunctionArn *string + // The date and time that the configuration was last updated. LastModified *time.Time + // The maximum age of a request that Lambda sends to a function for processing. + MaximumEventAgeInSeconds *int32 + // The maximum number of times to retry when the function returns an error. MaximumRetryAttempts *int32 - - // The Amazon Resource Name (ARN) of the function. - FunctionArn *string } // An AWS Lambda layer @@ -366,14 +366,14 @@ type Layer struct { // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). type LayersListItem struct { + // The newest version of the layer. + LatestMatchingVersion *LayerVersionsListItem + // The Amazon Resource Name (ARN) of the function layer. LayerArn *string // The name of the layer. LayerName *string - - // The newest version of the layer. - LatestMatchingVersion *LayerVersionsListItem } // A ZIP archive that contains the contents of an AWS Lambda layer @@ -384,12 +384,12 @@ type LayerVersionContentInput struct { // The Amazon S3 bucket of the layer archive. S3Bucket *string - // For versioned objects, the version of the layer archive object to use. - S3ObjectVersion *string - // The Amazon S3 key of the layer archive. S3Key *string + // For versioned objects, the version of the layer archive object to use. + S3ObjectVersion *string + // The base64-encoded contents of the layer archive. AWS SDK and AWS CLI clients // handle the encoding for you. ZipFile []byte @@ -413,24 +413,24 @@ type LayerVersionContentOutput struct { // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). type LayerVersionsListItem struct { + // The layer's compatible runtimes. + CompatibleRuntimes []Runtime + // The date that the version was created, in ISO 8601 format. For example, // 2018-11-27T15:10:45.123+0000. CreatedDate *string - // The version number. - Version *int64 - - // The layer's open-source license. - LicenseInfo *string - - // The layer's compatible runtimes. - CompatibleRuntimes []Runtime - // The description of the version. Description *string // The ARN of the layer version. LayerVersionArn *string + + // The layer's open-source license. + LicenseInfo *string + + // The version number. + Version *int64 } // A destination for events that failed processing. @@ -451,28 +451,28 @@ type OnSuccess struct { // version. type ProvisionedConcurrencyConfigListItem struct { + // The amount of provisioned concurrency allocated. + AllocatedProvisionedConcurrentExecutions *int32 + + // The amount of provisioned concurrency available. + AvailableProvisionedConcurrentExecutions *int32 + + // The Amazon Resource Name (ARN) of the alias or version. + FunctionArn *string + // The date and time that a user last updated the configuration, in ISO 8601 format // (https://www.iso.org/iso-8601-date-and-time-format.html). LastModified *string - // The amount of provisioned concurrency allocated. - AllocatedProvisionedConcurrentExecutions *int32 + // The amount of provisioned concurrency requested. + RequestedProvisionedConcurrentExecutions *int32 // The status of the allocation process. Status ProvisionedConcurrencyStatusEnum - // The amount of provisioned concurrency available. - AvailableProvisionedConcurrentExecutions *int32 - // For failed allocations, the reason that provisioned concurrency could not be // allocated. StatusReason *string - - // The amount of provisioned concurrency requested. - RequestedProvisionedConcurrentExecutions *int32 - - // The Amazon Resource Name (ARN) of the alias or version. - FunctionArn *string } // The function's AWS X-Ray tracing configuration. To sample and record incoming @@ -495,22 +495,22 @@ type TracingConfigResponse struct { // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html). type VpcConfig struct { - // A list of VPC subnet IDs. - SubnetIds []*string - // A list of VPC security groups IDs. SecurityGroupIds []*string + + // A list of VPC subnet IDs. + SubnetIds []*string } // The VPC security groups and subnets that are attached to a Lambda function. type VpcConfigResponse struct { - // A list of VPC subnet IDs. - SubnetIds []*string - // A list of VPC security groups IDs. SecurityGroupIds []*string + // A list of VPC subnet IDs. + SubnetIds []*string + // The ID of the VPC. VpcId *string } diff --git a/service/lexmodelbuildingservice/api_op_CreateBotVersion.go b/service/lexmodelbuildingservice/api_op_CreateBotVersion.go index 01f91301b29..e5adae93182 100644 --- a/service/lexmodelbuildingservice/api_op_CreateBotVersion.go +++ b/service/lexmodelbuildingservice/api_op_CreateBotVersion.go @@ -81,11 +81,12 @@ type CreateBotVersionInput struct { type CreateBotVersionOutput struct { - // The version of the bot. - Version *string + // The message that Amazon Lex uses to abort a conversation. For more information, + // see PutBot (). + AbortStatement *types.Statement - // An array of Intent objects. For more information, see PutBot (). - Intents []*types.Intent + // Checksum identifying the version of the bot that was created. + Checksum *string // For each Amazon Lex bot created with the Amazon Lex Model Building Service, you // must specify whether your use of Amazon Lex is related to a website, program, or @@ -110,54 +111,53 @@ type CreateBotVersionOutput struct { // (https://aws.amazon.com/lex/faqs#data-security) ChildDirected *bool - // Checksum identifying the version of the bot that was created. - Checksum *string + // The message that Amazon Lex uses when it doesn't understand the user's request. + // For more information, see PutBot (). + ClarificationPrompt *types.Prompt + + // The date when the bot version was created. + CreatedDate *time.Time + + // A description of the bot. + Description *string // Indicates whether utterances entered by the user should be sent to Amazon // Comprehend for sentiment analysis. DetectSentiment *bool - // A description of the bot. - Description *string + // If status is FAILED, Amazon Lex provides the reason that it failed to build the + // bot. + FailureReason *string - // The message that Amazon Lex uses to abort a conversation. For more information, - // see PutBot (). - AbortStatement *types.Statement + // The maximum time in seconds that Amazon Lex retains the data gathered in a + // conversation. For more information, see PutBot (). + IdleSessionTTLInSeconds *int32 + + // An array of Intent objects. For more information, see PutBot (). + Intents []*types.Intent + + // The date when the $LATEST version of this bot was updated. + LastUpdatedDate *time.Time // Specifies the target locale for the bot. Locale types.Locale + // The name of the bot. + Name *string + // When you send a request to create or update a bot, Amazon Lex sets the status // response element to BUILDING. After Amazon Lex builds the bot, it sets status to // READY. If Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex // returns the reason for the failure in the failureReason response element. Status types.Status - // The message that Amazon Lex uses when it doesn't understand the user's request. - // For more information, see PutBot (). - ClarificationPrompt *types.Prompt + // The version of the bot. + Version *string // The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the // user. VoiceId *string - // If status is FAILED, Amazon Lex provides the reason that it failed to build the - // bot. - FailureReason *string - - // The date when the $LATEST version of this bot was updated. - LastUpdatedDate *time.Time - - // The maximum time in seconds that Amazon Lex retains the data gathered in a - // conversation. For more information, see PutBot (). - IdleSessionTTLInSeconds *int32 - - // The date when the bot version was created. - CreatedDate *time.Time - - // The name of the bot. - Name *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lexmodelbuildingservice/api_op_CreateIntentVersion.go b/service/lexmodelbuildingservice/api_op_CreateIntentVersion.go index 9a44af26429..7f5d2c81c93 100644 --- a/service/lexmodelbuildingservice/api_op_CreateIntentVersion.go +++ b/service/lexmodelbuildingservice/api_op_CreateIntentVersion.go @@ -66,34 +66,28 @@ func (c *Client) CreateIntentVersion(ctx context.Context, params *CreateIntentVe type CreateIntentVersionInput struct { + // The name of the intent that you want to create a new version of. The name is + // case sensitive. + // + // This member is required. + Name *string + // Checksum of the $LATEST version of the intent that should be used to create the // new version. If you specify a checksum and the $LATEST version of the intent has // a different checksum, Amazon Lex returns a PreconditionFailedException exception // and doesn't publish a new version. If you don't specify a checksum, Amazon Lex // publishes the $LATEST version. Checksum *string - - // The name of the intent that you want to create a new version of. The name is - // case sensitive. - // - // This member is required. - Name *string } type CreateIntentVersionOutput struct { - // Configuration information, if any, for connectin an Amazon Kendra index with the - // AMAZON.KendraSearchIntent intent. - KendraConfiguration *types.KendraConfiguration - // Checksum of the intent version created. Checksum *string - // A description of the intent. - Description *string - - // Describes how the intent is fulfilled. - FulfillmentActivity *types.FulfillmentActivity + // After the Lambda function specified in the fulfillmentActivity field fulfills + // the intent, Amazon Lex conveys this statement to the user. + ConclusionStatement *types.Statement // If defined, the prompt that Amazon Lex uses to confirm the user's intent before // fulfilling it. @@ -102,36 +96,42 @@ type CreateIntentVersionOutput struct { // The date that the intent was created. CreatedDate *time.Time - // If the user answers "no" to the question defined in confirmationPrompt, Amazon - // Lex responds with this statement to acknowledge that the intent was canceled. - RejectionStatement *types.Statement - - // A unique identifier for a built-in intent. - ParentIntentSignature *string - - // An array of sample utterances configured for the intent. - SampleUtterances []*string + // A description of the intent. + Description *string // If defined, Amazon Lex invokes this Lambda function for each user input. DialogCodeHook *types.CodeHook - // An array of slot types that defines the information required to fulfill the - // intent. - Slots []*types.Slot + // If defined, Amazon Lex uses this prompt to solicit additional user activity + // after the intent is fulfilled. + FollowUpPrompt *types.FollowUpPrompt - // The name of the intent. - Name *string + // Describes how the intent is fulfilled. + FulfillmentActivity *types.FulfillmentActivity - // After the Lambda function specified in the fulfillmentActivity field fulfills - // the intent, Amazon Lex conveys this statement to the user. - ConclusionStatement *types.Statement + // Configuration information, if any, for connectin an Amazon Kendra index with the + // AMAZON.KendraSearchIntent intent. + KendraConfiguration *types.KendraConfiguration // The date that the intent was updated. LastUpdatedDate *time.Time - // If defined, Amazon Lex uses this prompt to solicit additional user activity - // after the intent is fulfilled. - FollowUpPrompt *types.FollowUpPrompt + // The name of the intent. + Name *string + + // A unique identifier for a built-in intent. + ParentIntentSignature *string + + // If the user answers "no" to the question defined in confirmationPrompt, Amazon + // Lex responds with this statement to acknowledge that the intent was canceled. + RejectionStatement *types.Statement + + // An array of sample utterances configured for the intent. + SampleUtterances []*string + + // An array of slot types that defines the information required to fulfill the + // intent. + Slots []*types.Slot // The version number assigned to the new version of the intent. Version *string diff --git a/service/lexmodelbuildingservice/api_op_CreateSlotTypeVersion.go b/service/lexmodelbuildingservice/api_op_CreateSlotTypeVersion.go index e6a68b17237..09a37c4bb1e 100644 --- a/service/lexmodelbuildingservice/api_op_CreateSlotTypeVersion.go +++ b/service/lexmodelbuildingservice/api_op_CreateSlotTypeVersion.go @@ -66,34 +66,34 @@ func (c *Client) CreateSlotTypeVersion(ctx context.Context, params *CreateSlotTy type CreateSlotTypeVersionInput struct { + // The name of the slot type that you want to create a new version for. The name is + // case sensitive. + // + // This member is required. + Name *string + // Checksum for the $LATEST version of the slot type that you want to publish. If // you specify a checksum and the $LATEST version of the slot type has a different // checksum, Amazon Lex returns a PreconditionFailedException exception and doesn't // publish the new version. If you don't specify a checksum, Amazon Lex publishes // the $LATEST version. Checksum *string - - // The name of the slot type that you want to create a new version for. The name is - // case sensitive. - // - // This member is required. - Name *string } type CreateSlotTypeVersionOutput struct { - // The strategy that Amazon Lex uses to determine the value of the slot. For more - // information, see PutSlotType (). - ValueSelectionStrategy types.SlotValueSelectionStrategy - - // Configuration information that extends the parent built-in slot type. - SlotTypeConfigurations []*types.SlotTypeConfiguration + // Checksum of the $LATEST version of the slot type. + Checksum *string // The date that the slot type was created. CreatedDate *time.Time - // The built-in slot type used a the parent of the slot type. - ParentSlotTypeSignature *string + // A description of the slot type. + Description *string + + // A list of EnumerationValue objects that defines the values that the slot type + // can take. + EnumerationValues []*types.EnumerationValue // The date that the slot type was updated. When you create a resource, the // creation date and last update date are the same. @@ -102,15 +102,15 @@ type CreateSlotTypeVersionOutput struct { // The name of the slot type. Name *string - // Checksum of the $LATEST version of the slot type. - Checksum *string + // The built-in slot type used a the parent of the slot type. + ParentSlotTypeSignature *string - // A description of the slot type. - Description *string + // Configuration information that extends the parent built-in slot type. + SlotTypeConfigurations []*types.SlotTypeConfiguration - // A list of EnumerationValue objects that defines the values that the slot type - // can take. - EnumerationValues []*types.EnumerationValue + // The strategy that Amazon Lex uses to determine the value of the slot. For more + // information, see PutSlotType (). + ValueSelectionStrategy types.SlotValueSelectionStrategy // The version assigned to the new slot type version. Version *string diff --git a/service/lexmodelbuildingservice/api_op_DeleteBotChannelAssociation.go b/service/lexmodelbuildingservice/api_op_DeleteBotChannelAssociation.go index 85c9fd92944..601759d01e4 100644 --- a/service/lexmodelbuildingservice/api_op_DeleteBotChannelAssociation.go +++ b/service/lexmodelbuildingservice/api_op_DeleteBotChannelAssociation.go @@ -57,17 +57,17 @@ func (c *Client) DeleteBotChannelAssociation(ctx context.Context, params *Delete type DeleteBotChannelAssociationInput struct { - // The name of the Amazon Lex bot. - // - // This member is required. - BotName *string - // An alias that points to the specific version of the Amazon Lex bot to which this // association is being made. // // This member is required. BotAlias *string + // The name of the Amazon Lex bot. + // + // This member is required. + BotName *string + // The name of the association. The name is case sensitive. // // This member is required. diff --git a/service/lexmodelbuildingservice/api_op_DeleteBotVersion.go b/service/lexmodelbuildingservice/api_op_DeleteBotVersion.go index 70fe35000a7..63b68a1b35c 100644 --- a/service/lexmodelbuildingservice/api_op_DeleteBotVersion.go +++ b/service/lexmodelbuildingservice/api_op_DeleteBotVersion.go @@ -58,16 +58,16 @@ func (c *Client) DeleteBotVersion(ctx context.Context, params *DeleteBotVersionI type DeleteBotVersionInput struct { - // The version of the bot to delete. You cannot delete the $LATEST version of the - // bot. To delete the $LATEST version, use the DeleteBot () operation. + // The name of the bot. // // This member is required. - Version *string + Name *string - // The name of the bot. + // The version of the bot to delete. You cannot delete the $LATEST version of the + // bot. To delete the $LATEST version, use the DeleteBot () operation. // // This member is required. - Name *string + Version *string } type DeleteBotVersionOutput struct { diff --git a/service/lexmodelbuildingservice/api_op_DeleteSlotTypeVersion.go b/service/lexmodelbuildingservice/api_op_DeleteSlotTypeVersion.go index e5506b9ef08..932abb5f91c 100644 --- a/service/lexmodelbuildingservice/api_op_DeleteSlotTypeVersion.go +++ b/service/lexmodelbuildingservice/api_op_DeleteSlotTypeVersion.go @@ -58,17 +58,17 @@ func (c *Client) DeleteSlotTypeVersion(ctx context.Context, params *DeleteSlotTy type DeleteSlotTypeVersionInput struct { + // The name of the slot type. + // + // This member is required. + Name *string + // The version of the slot type to delete. You cannot delete the $LATEST version of // the slot type. To delete the $LATEST version, use the DeleteSlotType () // operation. // // This member is required. Version *string - - // The name of the slot type. - // - // This member is required. - Name *string } type DeleteSlotTypeVersionOutput struct { diff --git a/service/lexmodelbuildingservice/api_op_GetBot.go b/service/lexmodelbuildingservice/api_op_GetBot.go index 38b46b06050..176a0c51f90 100644 --- a/service/lexmodelbuildingservice/api_op_GetBot.go +++ b/service/lexmodelbuildingservice/api_op_GetBot.go @@ -60,15 +60,15 @@ func (c *Client) GetBot(ctx context.Context, params *GetBotInput, optFns ...func type GetBotInput struct { - // The version or alias of the bot. + // The name of the bot. The name is case sensitive. // // This member is required. - VersionOrAlias *string + Name *string - // The name of the bot. The name is case sensitive. + // The version or alias of the bot. // // This member is required. - Name *string + VersionOrAlias *string } type GetBotOutput struct { @@ -77,39 +77,10 @@ type GetBotOutput struct { // without completing it. For more information, see PutBot (). AbortStatement *types.Statement - // The version of the bot. For a new bot, the version is always $LATEST. - Version *string - - // An array of intent objects. For more information, see PutBot (). - Intents []*types.Intent - // Checksum of the bot used to identify a specific revision of the bot's $LATEST // version. Checksum *string - // The maximum time in seconds that Amazon Lex retains the data gathered in a - // conversation. For more information, see PutBot (). - IdleSessionTTLInSeconds *int32 - - // The name of the bot. - Name *string - - // The status of the bot. When the status is BUILDING Amazon Lex is building the - // bot for testing and use. If the status of the bot is READY_BASIC_TESTING, you - // can test the bot using the exact utterances specified in the bot's intents. When - // the bot is ready for full testing or to run, the status is READY. If there was a - // problem with building the bot, the status is FAILED and the failureReason field - // explains why the bot did not build. If the bot was saved but not built, the - // status is NOT_BUILT. - Status types.Status - - // If status is FAILED, Amazon Lex explains why it failed to build the bot. - FailureReason *string - - // The message Amazon Lex uses when it doesn't understand the user's request. For - // more information, see PutBot (). - ClarificationPrompt *types.Prompt - // For each Amazon Lex bot created with the Amazon Lex Model Building Service, you // must specify whether your use of Amazon Lex is related to a website, program, or // other application that is directed or targeted, in whole or in part, to children @@ -133,27 +104,56 @@ type GetBotOutput struct { // (https://aws.amazon.com/lex/faqs#data-security) ChildDirected *bool + // The message Amazon Lex uses when it doesn't understand the user's request. For + // more information, see PutBot (). + ClarificationPrompt *types.Prompt + // The date that the bot was created. CreatedDate *time.Time - // The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the - // user. For more information, see PutBot (). - VoiceId *string - // A description of the bot. Description *string - // The target locale for the bot. - Locale types.Locale - // Indicates whether user utterances should be sent to Amazon Comprehend for // sentiment analysis. DetectSentiment *bool + // If status is FAILED, Amazon Lex explains why it failed to build the bot. + FailureReason *string + + // The maximum time in seconds that Amazon Lex retains the data gathered in a + // conversation. For more information, see PutBot (). + IdleSessionTTLInSeconds *int32 + + // An array of intent objects. For more information, see PutBot (). + Intents []*types.Intent + // The date that the bot was updated. When you create a resource, the creation date // and last updated date are the same. LastUpdatedDate *time.Time + // The target locale for the bot. + Locale types.Locale + + // The name of the bot. + Name *string + + // The status of the bot. When the status is BUILDING Amazon Lex is building the + // bot for testing and use. If the status of the bot is READY_BASIC_TESTING, you + // can test the bot using the exact utterances specified in the bot's intents. When + // the bot is ready for full testing or to run, the status is READY. If there was a + // problem with building the bot, the status is FAILED and the failureReason field + // explains why the bot did not build. If the bot was saved but not built, the + // status is NOT_BUILT. + Status types.Status + + // The version of the bot. For a new bot, the version is always $LATEST. + Version *string + + // The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the + // user. For more information, see PutBot (). + VoiceId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lexmodelbuildingservice/api_op_GetBotAlias.go b/service/lexmodelbuildingservice/api_op_GetBotAlias.go index b75e33b2d8f..9801bcb71be 100644 --- a/service/lexmodelbuildingservice/api_op_GetBotAlias.go +++ b/service/lexmodelbuildingservice/api_op_GetBotAlias.go @@ -73,28 +73,28 @@ type GetBotAliasInput struct { type GetBotAliasOutput struct { - // A description of the bot alias. - Description *string - // The name of the bot that the alias points to. BotName *string - // The date that the bot alias was updated. When you create a resource, the - // creation date and the last updated date are the same. - LastUpdatedDate *time.Time - // The version of the bot that the alias points to. BotVersion *string - // The date that the bot alias was created. - CreatedDate *time.Time - // Checksum of the bot alias. Checksum *string // The settings that determine how Amazon Lex uses conversation logs for the alias. ConversationLogs *types.ConversationLogsResponse + // The date that the bot alias was created. + CreatedDate *time.Time + + // A description of the bot alias. + Description *string + + // The date that the bot alias was updated. When you create a resource, the + // creation date and the last updated date are the same. + LastUpdatedDate *time.Time + // The name of the bot alias. Name *string diff --git a/service/lexmodelbuildingservice/api_op_GetBotAliases.go b/service/lexmodelbuildingservice/api_op_GetBotAliases.go index 8763c0dc4ee..f91d90126ce 100644 --- a/service/lexmodelbuildingservice/api_op_GetBotAliases.go +++ b/service/lexmodelbuildingservice/api_op_GetBotAliases.go @@ -58,24 +58,24 @@ func (c *Client) GetBotAliases(ctx context.Context, params *GetBotAliasesInput, type GetBotAliasesInput struct { - // A pagination token for fetching the next page of aliases. If the response to - // this call is truncated, Amazon Lex returns a pagination token in the response. - // To fetch the next page of aliases, specify the pagination token in the next - // request. - NextToken *string + // The name of the bot. + // + // This member is required. + BotName *string + + // The maximum number of aliases to return in the response. The default is 50. . + MaxResults *int32 // Substring to match in bot alias names. An alias will be returned if any part of // its name matches the substring. For example, "xyz" matches both "xyzabc" and // "abcxyz." NameContains *string - // The maximum number of aliases to return in the response. The default is 50. . - MaxResults *int32 - - // The name of the bot. - // - // This member is required. - BotName *string + // A pagination token for fetching the next page of aliases. If the response to + // this call is truncated, Amazon Lex returns a pagination token in the response. + // To fetch the next page of aliases, specify the pagination token in the next + // request. + NextToken *string } type GetBotAliasesOutput struct { diff --git a/service/lexmodelbuildingservice/api_op_GetBotChannelAssociation.go b/service/lexmodelbuildingservice/api_op_GetBotChannelAssociation.go index 3796c5b2be5..dee532ad8f4 100644 --- a/service/lexmodelbuildingservice/api_op_GetBotChannelAssociation.go +++ b/service/lexmodelbuildingservice/api_op_GetBotChannelAssociation.go @@ -60,12 +60,6 @@ func (c *Client) GetBotChannelAssociation(ctx context.Context, params *GetBotCha type GetBotChannelAssociationInput struct { - // The name of the association between the bot and the channel. The name is case - // sensitive. - // - // This member is required. - Name *string - // An alias pointing to the specific version of the Amazon Lex bot to which this // association is being made. // @@ -76,6 +70,12 @@ type GetBotChannelAssociationInput struct { // // This member is required. BotName *string + + // The name of the association between the bot and the channel. The name is case + // sensitive. + // + // This member is required. + Name *string } type GetBotChannelAssociationOutput struct { @@ -84,25 +84,25 @@ type GetBotChannelAssociationOutput struct { // association is being made. BotAlias *string - // A description of the association between the bot and the channel. - Description *string + // Provides information that the messaging platform needs to communicate with the + // Amazon Lex bot. + BotConfiguration map[string]*string // The name of the Amazon Lex bot. BotName *string - // If status is FAILED, Amazon Lex provides the reason that it failed to create the - // association. - FailureReason *string - // The date that the association between the bot and the channel was created. CreatedDate *time.Time - // The type of the messaging platform. - Type types.ChannelType + // A description of the association between the bot and the channel. + Description *string - // Provides information that the messaging platform needs to communicate with the - // Amazon Lex bot. - BotConfiguration map[string]*string + // If status is FAILED, Amazon Lex provides the reason that it failed to create the + // association. + FailureReason *string + + // The name of the association between the bot and the channel. + Name *string // The status of the bot channel. // @@ -116,8 +116,8 @@ type GetBotChannelAssociationOutput struct { // reason for the failure, see the failureReason field. Status types.ChannelStatus - // The name of the association between the bot and the channel. - Name *string + // The type of the messaging platform. + Type types.ChannelType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/lexmodelbuildingservice/api_op_GetBotChannelAssociations.go b/service/lexmodelbuildingservice/api_op_GetBotChannelAssociations.go index 4ad9aea6046..62a2e9655bc 100644 --- a/service/lexmodelbuildingservice/api_op_GetBotChannelAssociations.go +++ b/service/lexmodelbuildingservice/api_op_GetBotChannelAssociations.go @@ -59,25 +59,25 @@ func (c *Client) GetBotChannelAssociations(ctx context.Context, params *GetBotCh type GetBotChannelAssociationsInput struct { - // Substring to match in channel association names. An association will be returned - // if any part of its name matches the substring. For example, "xyz" matches both - // "xyzabc" and "abcxyz." To return all bot channel associations, use a hyphen - // ("-") as the nameContains parameter. - NameContains *string - - // The maximum number of associations to return in the response. The default is 50. - MaxResults *int32 + // An alias pointing to the specific version of the Amazon Lex bot to which this + // association is being made. + // + // This member is required. + BotAlias *string // The name of the Amazon Lex bot in the association. // // This member is required. BotName *string - // An alias pointing to the specific version of the Amazon Lex bot to which this - // association is being made. - // - // This member is required. - BotAlias *string + // The maximum number of associations to return in the response. The default is 50. + MaxResults *int32 + + // Substring to match in channel association names. An association will be returned + // if any part of its name matches the substring. For example, "xyz" matches both + // "xyzabc" and "abcxyz." To return all bot channel associations, use a hyphen + // ("-") as the nameContains parameter. + NameContains *string // A pagination token for fetching the next page of associations. If the response // to this call is truncated, Amazon Lex returns a pagination token in the diff --git a/service/lexmodelbuildingservice/api_op_GetBotVersions.go b/service/lexmodelbuildingservice/api_op_GetBotVersions.go index d61c2c5894a..1da39571f49 100644 --- a/service/lexmodelbuildingservice/api_op_GetBotVersions.go +++ b/service/lexmodelbuildingservice/api_op_GetBotVersions.go @@ -63,19 +63,19 @@ func (c *Client) GetBotVersions(ctx context.Context, params *GetBotVersionsInput type GetBotVersionsInput struct { + // The name of the bot for which versions should be returned. + // + // This member is required. + Name *string + + // The maximum number of bot versions to return in the response. The default is 10. + MaxResults *int32 + // A pagination token for fetching the next page of bot versions. If the response // to this call is truncated, Amazon Lex returns a pagination token in the // response. To fetch the next page of versions, specify the pagination token in // the next request. NextToken *string - - // The maximum number of bot versions to return in the response. The default is 10. - MaxResults *int32 - - // The name of the bot for which versions should be returned. - // - // This member is required. - Name *string } type GetBotVersionsOutput struct { diff --git a/service/lexmodelbuildingservice/api_op_GetBots.go b/service/lexmodelbuildingservice/api_op_GetBots.go index f54c518e7a3..79d487e031a 100644 --- a/service/lexmodelbuildingservice/api_op_GetBots.go +++ b/service/lexmodelbuildingservice/api_op_GetBots.go @@ -67,29 +67,29 @@ func (c *Client) GetBots(ctx context.Context, params *GetBotsInput, optFns ...fu type GetBotsInput struct { - // A pagination token that fetches the next page of bots. If the response to this - // call is truncated, Amazon Lex returns a pagination token in the response. To - // fetch the next page of bots, specify the pagination token in the next request. - NextToken *string + // The maximum number of bots to return in the response that the request will + // return. The default is 10. + MaxResults *int32 // Substring to match in bot names. A bot will be returned if any part of its name // matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." NameContains *string - // The maximum number of bots to return in the response that the request will - // return. The default is 10. - MaxResults *int32 + // A pagination token that fetches the next page of bots. If the response to this + // call is truncated, Amazon Lex returns a pagination token in the response. To + // fetch the next page of bots, specify the pagination token in the next request. + NextToken *string } type GetBotsOutput struct { + // An array of botMetadata objects, with one entry for each bot. + Bots []*types.BotMetadata + // If the response is truncated, it includes a pagination token that you can // specify in your next request to fetch the next page of bots. NextToken *string - // An array of botMetadata objects, with one entry for each bot. - Bots []*types.BotMetadata - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lexmodelbuildingservice/api_op_GetBuiltinIntent.go b/service/lexmodelbuildingservice/api_op_GetBuiltinIntent.go index 98778a61e4d..9a10801bf85 100644 --- a/service/lexmodelbuildingservice/api_op_GetBuiltinIntent.go +++ b/service/lexmodelbuildingservice/api_op_GetBuiltinIntent.go @@ -69,13 +69,13 @@ type GetBuiltinIntentInput struct { type GetBuiltinIntentOutput struct { + // The unique identifier for a built-in intent. + Signature *string + // An array of BuiltinIntentSlot objects, one entry for each slot type in the // intent. Slots []*types.BuiltinIntentSlot - // The unique identifier for a built-in intent. - Signature *string - // A list of locales that the intent supports. SupportedLocales []types.Locale diff --git a/service/lexmodelbuildingservice/api_op_GetBuiltinIntents.go b/service/lexmodelbuildingservice/api_op_GetBuiltinIntents.go index d744dfc379a..afe78c973fe 100644 --- a/service/lexmodelbuildingservice/api_op_GetBuiltinIntents.go +++ b/service/lexmodelbuildingservice/api_op_GetBuiltinIntents.go @@ -57,17 +57,17 @@ func (c *Client) GetBuiltinIntents(ctx context.Context, params *GetBuiltinIntent type GetBuiltinIntentsInput struct { - // A pagination token that fetches the next page of intents. If this API call is - // truncated, Amazon Lex returns a pagination token in the response. To fetch the - // next page of intents, use the pagination token in the next request. - NextToken *string - // A list of locales that the intent supports. Locale types.Locale // The maximum number of intents to return in the response. The default is 10. MaxResults *int32 + // A pagination token that fetches the next page of intents. If this API call is + // truncated, Amazon Lex returns a pagination token in the response. To fetch the + // next page of intents, use the pagination token in the next request. + NextToken *string + // Substring to match in built-in intent signatures. An intent will be returned if // any part of its signature matches the substring. For example, "xyz" matches both // "xyzabc" and "abcxyz." To find the signature for an intent, see Standard diff --git a/service/lexmodelbuildingservice/api_op_GetBuiltinSlotTypes.go b/service/lexmodelbuildingservice/api_op_GetBuiltinSlotTypes.go index 45fc81d30a4..bb4312fe630 100644 --- a/service/lexmodelbuildingservice/api_op_GetBuiltinSlotTypes.go +++ b/service/lexmodelbuildingservice/api_op_GetBuiltinSlotTypes.go @@ -63,11 +63,6 @@ type GetBuiltinSlotTypesInput struct { // A list of locales that the slot type supports. Locale types.Locale - // Substring to match in built-in slot type signatures. A slot type will be - // returned if any part of its signature matches the substring. For example, "xyz" - // matches both "xyzabc" and "abcxyz." - SignatureContains *string - // The maximum number of slot types to return in the response. The default is 10. MaxResults *int32 @@ -76,18 +71,23 @@ type GetBuiltinSlotTypesInput struct { // response. To fetch the next page of slot types, specify the pagination token in // the next request. NextToken *string + + // Substring to match in built-in slot type signatures. A slot type will be + // returned if any part of its signature matches the substring. For example, "xyz" + // matches both "xyzabc" and "abcxyz." + SignatureContains *string } type GetBuiltinSlotTypesOutput struct { - // An array of BuiltInSlotTypeMetadata objects, one entry for each slot type - // returned. - SlotTypes []*types.BuiltinSlotTypeMetadata - // If the response is truncated, the response includes a pagination token that you // can use in your next request to fetch the next page of slot types. NextToken *string + // An array of BuiltInSlotTypeMetadata objects, one entry for each slot type + // returned. + SlotTypes []*types.BuiltinSlotTypeMetadata + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lexmodelbuildingservice/api_op_GetExport.go b/service/lexmodelbuildingservice/api_op_GetExport.go index 65504347321..2519fab6060 100644 --- a/service/lexmodelbuildingservice/api_op_GetExport.go +++ b/service/lexmodelbuildingservice/api_op_GetExport.go @@ -62,11 +62,6 @@ type GetExportInput struct { // This member is required. ExportType types.ExportType - // The version of the bot to export. - // - // This member is required. - Version *string - // The name of the bot to export. // // This member is required. @@ -76,25 +71,15 @@ type GetExportInput struct { // // This member is required. ResourceType types.ResourceType + + // The version of the bot to export. + // + // This member is required. + Version *string } type GetExportOutput struct { - // The name of the bot being exported. - Name *string - - // The format of the exported data. - ExportType types.ExportType - - // An S3 pre-signed URL that provides the location of the exported resource. The - // exported resource is a ZIP archive that contains the exported resource in JSON - // format. The structure of the archive may change. Your code should not rely on - // the archive structure. - Url *string - - // The type of the exported resource. - ResourceType types.ResourceType - // The status of the export. // // * IN_PROGRESS - The export is in progress. @@ -106,13 +91,28 @@ type GetExportOutput struct { // completed. ExportStatus types.ExportStatus - // The version of the bot being exported. - Version *string + // The format of the exported data. + ExportType types.ExportType // If status is FAILED, Amazon Lex provides the reason that it failed to export the // resource. FailureReason *string + // The name of the bot being exported. + Name *string + + // The type of the exported resource. + ResourceType types.ResourceType + + // An S3 pre-signed URL that provides the location of the exported resource. The + // exported resource is a ZIP archive that contains the exported resource in JSON + // format. The structure of the archive may change. Your code should not rely on + // the archive structure. + Url *string + + // The version of the bot being exported. + Version *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lexmodelbuildingservice/api_op_GetImport.go b/service/lexmodelbuildingservice/api_op_GetImport.go index e20542f344d..3abaa3fd1af 100644 --- a/service/lexmodelbuildingservice/api_op_GetImport.go +++ b/service/lexmodelbuildingservice/api_op_GetImport.go @@ -66,28 +66,28 @@ type GetImportInput struct { type GetImportOutput struct { - // The name given to the import job. - Name *string + // A timestamp for the date and time that the import job was created. + CreatedDate *time.Time + + // A string that describes why an import job failed to complete. + FailureReason []*string + + // The identifier for the specific import job. + ImportId *string // The status of the import job. If the status is FAILED, you can get the reason // for the failure from the failureReason field. ImportStatus types.ImportStatus - // The type of resource imported. - ResourceType types.ResourceType - - // A timestamp for the date and time that the import job was created. - CreatedDate *time.Time - // The action taken when there was a conflict between an existing resource and a // resource in the import file. MergeStrategy types.MergeStrategy - // A string that describes why an import job failed to complete. - FailureReason []*string + // The name given to the import job. + Name *string - // The identifier for the specific import job. - ImportId *string + // The type of resource imported. + ResourceType types.ResourceType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/lexmodelbuildingservice/api_op_GetIntent.go b/service/lexmodelbuildingservice/api_op_GetIntent.go index 37ca24f11d7..e6ddae14712 100644 --- a/service/lexmodelbuildingservice/api_op_GetIntent.go +++ b/service/lexmodelbuildingservice/api_op_GetIntent.go @@ -73,57 +73,57 @@ type GetIntentInput struct { type GetIntentOutput struct { - // A description of the intent. - Description *string - - // Configuration information, if any, to connect to an Amazon Kendra index with the - // AMAZON.KendraSearchIntent intent. - KendraConfiguration *types.KendraConfiguration - - // A unique identifier for a built-in intent. - ParentIntentSignature *string + // Checksum of the intent. + Checksum *string // After the Lambda function specified in the fulfillmentActivity element fulfills // the intent, Amazon Lex conveys this statement to the user. ConclusionStatement *types.Statement - // An array of sample utterances configured for the intent. - SampleUtterances []*string + // If defined in the bot, Amazon Lex uses prompt to confirm the intent before + // fulfilling the user's request. For more information, see PutIntent (). + ConfirmationPrompt *types.Prompt // The date that the intent was created. CreatedDate *time.Time - // If the user answers "no" to the question defined in confirmationPrompt, Amazon - // Lex responds with this statement to acknowledge that the intent was canceled. - RejectionStatement *types.Statement - - // Checksum of the intent. - Checksum *string + // A description of the intent. + Description *string // If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each // user input. For more information, see PutIntent (). DialogCodeHook *types.CodeHook - // An array of intent slots configured for the intent. - Slots []*types.Slot + // If defined in the bot, Amazon Lex uses this prompt to solicit additional user + // activity after the intent is fulfilled. For more information, see PutIntent (). + FollowUpPrompt *types.FollowUpPrompt - // The name of the intent. - Name *string + // Describes how the intent is fulfilled. For more information, see PutIntent (). + FulfillmentActivity *types.FulfillmentActivity + + // Configuration information, if any, to connect to an Amazon Kendra index with the + // AMAZON.KendraSearchIntent intent. + KendraConfiguration *types.KendraConfiguration // The date that the intent was updated. When you create a resource, the creation // date and the last updated date are the same. LastUpdatedDate *time.Time - // If defined in the bot, Amazon Lex uses prompt to confirm the intent before - // fulfilling the user's request. For more information, see PutIntent (). - ConfirmationPrompt *types.Prompt + // The name of the intent. + Name *string - // Describes how the intent is fulfilled. For more information, see PutIntent (). - FulfillmentActivity *types.FulfillmentActivity + // A unique identifier for a built-in intent. + ParentIntentSignature *string - // If defined in the bot, Amazon Lex uses this prompt to solicit additional user - // activity after the intent is fulfilled. For more information, see PutIntent (). - FollowUpPrompt *types.FollowUpPrompt + // If the user answers "no" to the question defined in confirmationPrompt, Amazon + // Lex responds with this statement to acknowledge that the intent was canceled. + RejectionStatement *types.Statement + + // An array of sample utterances configured for the intent. + SampleUtterances []*string + + // An array of intent slots configured for the intent. + Slots []*types.Slot // The version of the intent. Version *string diff --git a/service/lexmodelbuildingservice/api_op_GetIntentVersions.go b/service/lexmodelbuildingservice/api_op_GetIntentVersions.go index 373a6a255d7..3d4a7c9f421 100644 --- a/service/lexmodelbuildingservice/api_op_GetIntentVersions.go +++ b/service/lexmodelbuildingservice/api_op_GetIntentVersions.go @@ -81,16 +81,16 @@ type GetIntentVersionsInput struct { type GetIntentVersionsOutput struct { + // An array of IntentMetadata objects, one for each numbered version of the intent + // plus one for the $LATEST version. + Intents []*types.IntentMetadata + // A pagination token for fetching the next page of intent versions. If the // response to this call is truncated, Amazon Lex returns a pagination token in the // response. To fetch the next page of versions, specify the pagination token in // the next request. NextToken *string - // An array of IntentMetadata objects, one for each numbered version of the intent - // plus one for the $LATEST version. - Intents []*types.IntentMetadata - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lexmodelbuildingservice/api_op_GetIntents.go b/service/lexmodelbuildingservice/api_op_GetIntents.go index 41f79daa502..4590da1f3c7 100644 --- a/service/lexmodelbuildingservice/api_op_GetIntents.go +++ b/service/lexmodelbuildingservice/api_op_GetIntents.go @@ -66,12 +66,6 @@ func (c *Client) GetIntents(ctx context.Context, params *GetIntentsInput, optFns type GetIntentsInput struct { - // A pagination token that fetches the next page of intents. If the response to - // this API call is truncated, Amazon Lex returns a pagination token in the - // response. To fetch the next page of intents, specify the pagination token in the - // next request. - NextToken *string - // The maximum number of intents to return in the response. The default is 10. MaxResults *int32 @@ -79,6 +73,12 @@ type GetIntentsInput struct { // its name matches the substring. For example, "xyz" matches both "xyzabc" and // "abcxyz." NameContains *string + + // A pagination token that fetches the next page of intents. If the response to + // this API call is truncated, Amazon Lex returns a pagination token in the + // response. To fetch the next page of intents, specify the pagination token in the + // next request. + NextToken *string } type GetIntentsOutput struct { diff --git a/service/lexmodelbuildingservice/api_op_GetSlotType.go b/service/lexmodelbuildingservice/api_op_GetSlotType.go index 9c2f83cada6..68aa5aab3dc 100644 --- a/service/lexmodelbuildingservice/api_op_GetSlotType.go +++ b/service/lexmodelbuildingservice/api_op_GetSlotType.go @@ -73,39 +73,39 @@ type GetSlotTypeInput struct { type GetSlotTypeOutput struct { - // The date that the slot type was updated. When you create a resource, the - // creation date and last update date are the same. - LastUpdatedDate *time.Time - - // The version of the slot type. - Version *string + // Checksum of the $LATEST version of the slot type. + Checksum *string // The date that the slot type was created. CreatedDate *time.Time - // Configuration information that extends the parent built-in slot type. - SlotTypeConfigurations []*types.SlotTypeConfiguration - // A description of the slot type. Description *string - // The strategy that Amazon Lex uses to determine the value of the slot. For more - // information, see PutSlotType (). - ValueSelectionStrategy types.SlotValueSelectionStrategy + // A list of EnumerationValue objects that defines the values that the slot type + // can take. + EnumerationValues []*types.EnumerationValue - // Checksum of the $LATEST version of the slot type. - Checksum *string + // The date that the slot type was updated. When you create a resource, the + // creation date and last update date are the same. + LastUpdatedDate *time.Time // The name of the slot type. Name *string - // A list of EnumerationValue objects that defines the values that the slot type - // can take. - EnumerationValues []*types.EnumerationValue - // The built-in slot type used as a parent for the slot type. ParentSlotTypeSignature *string + // Configuration information that extends the parent built-in slot type. + SlotTypeConfigurations []*types.SlotTypeConfiguration + + // The strategy that Amazon Lex uses to determine the value of the slot. For more + // information, see PutSlotType (). + ValueSelectionStrategy types.SlotValueSelectionStrategy + + // The version of the slot type. + Version *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lexmodelbuildingservice/api_op_GetSlotTypeVersions.go b/service/lexmodelbuildingservice/api_op_GetSlotTypeVersions.go index fdd414001c1..4ce65d8e56b 100644 --- a/service/lexmodelbuildingservice/api_op_GetSlotTypeVersions.go +++ b/service/lexmodelbuildingservice/api_op_GetSlotTypeVersions.go @@ -63,15 +63,15 @@ func (c *Client) GetSlotTypeVersions(ctx context.Context, params *GetSlotTypeVer type GetSlotTypeVersionsInput struct { - // The maximum number of slot type versions to return in the response. The default - // is 10. - MaxResults *int32 - // The name of the slot type for which versions should be returned. // // This member is required. Name *string + // The maximum number of slot type versions to return in the response. The default + // is 10. + MaxResults *int32 + // A pagination token for fetching the next page of slot type versions. If the // response to this call is truncated, Amazon Lex returns a pagination token in the // response. To fetch the next page of versions, specify the pagination token in @@ -81,16 +81,16 @@ type GetSlotTypeVersionsInput struct { type GetSlotTypeVersionsOutput struct { - // An array of SlotTypeMetadata objects, one for each numbered version of the slot - // type plus one for the $LATEST version. - SlotTypes []*types.SlotTypeMetadata - // A pagination token for fetching the next page of slot type versions. If the // response to this call is truncated, Amazon Lex returns a pagination token in the // response. To fetch the next page of versions, specify the pagination token in // the next request. NextToken *string + // An array of SlotTypeMetadata objects, one for each numbered version of the slot + // type plus one for the $LATEST version. + SlotTypes []*types.SlotTypeMetadata + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lexmodelbuildingservice/api_op_GetSlotTypes.go b/service/lexmodelbuildingservice/api_op_GetSlotTypes.go index a0ac8389e47..6fb5958be7e 100644 --- a/service/lexmodelbuildingservice/api_op_GetSlotTypes.go +++ b/service/lexmodelbuildingservice/api_op_GetSlotTypes.go @@ -66,31 +66,31 @@ func (c *Client) GetSlotTypes(ctx context.Context, params *GetSlotTypesInput, op type GetSlotTypesInput struct { - // A pagination token that fetches the next page of slot types. If the response to - // this API call is truncated, Amazon Lex returns a pagination token in the - // response. To fetch next page of slot types, specify the pagination token in the - // next request. - NextToken *string + // The maximum number of slot types to return in the response. The default is 10. + MaxResults *int32 // Substring to match in slot type names. A slot type will be returned if any part // of its name matches the substring. For example, "xyz" matches both "xyzabc" and // "abcxyz." NameContains *string - // The maximum number of slot types to return in the response. The default is 10. - MaxResults *int32 + // A pagination token that fetches the next page of slot types. If the response to + // this API call is truncated, Amazon Lex returns a pagination token in the + // response. To fetch next page of slot types, specify the pagination token in the + // next request. + NextToken *string } type GetSlotTypesOutput struct { - // An array of objects, one for each slot type, that provides information such as - // the name of the slot type, the version, and a description. - SlotTypes []*types.SlotTypeMetadata - // If the response is truncated, it includes a pagination token that you can // specify in your next request to fetch the next page of slot types. NextToken *string + // An array of objects, one for each slot type, that provides information such as + // the name of the slot type, the version, and a description. + SlotTypes []*types.SlotTypeMetadata + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lexmodelbuildingservice/api_op_GetUtterancesView.go b/service/lexmodelbuildingservice/api_op_GetUtterancesView.go index 1f06ba55578..413359868dc 100644 --- a/service/lexmodelbuildingservice/api_op_GetUtterancesView.go +++ b/service/lexmodelbuildingservice/api_op_GetUtterancesView.go @@ -74,11 +74,10 @@ func (c *Client) GetUtterancesView(ctx context.Context, params *GetUtterancesVie type GetUtterancesViewInput struct { - // To return utterances that were recognized and handled, use Detected. To return - // utterances that were not recognized, use Missed. + // The name of the bot for which utterance information should be returned. // // This member is required. - StatusType types.StatusType + BotName *string // An array of bot versions for which utterance information should be returned. The // limit is 5 versions per request. @@ -86,23 +85,24 @@ type GetUtterancesViewInput struct { // This member is required. BotVersions []*string - // The name of the bot for which utterance information should be returned. + // To return utterances that were recognized and handled, use Detected. To return + // utterances that were not recognized, use Missed. // // This member is required. - BotName *string + StatusType types.StatusType } type GetUtterancesViewOutput struct { + // The name of the bot for which utterance information was returned. + BotName *string + // An array of UtteranceList () objects, each containing a list of UtteranceData () // objects describing the utterances that were processed by your bot. The response // contains a maximum of 100 UtteranceData objects for each version. Amazon Lex // returns the most frequent utterances received by the bot in the last 15 days. Utterances []*types.UtteranceList - // The name of the bot for which utterance information was returned. - BotName *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lexmodelbuildingservice/api_op_PutBot.go b/service/lexmodelbuildingservice/api_op_PutBot.go index 5000152b289..2b1286a58e0 100644 --- a/service/lexmodelbuildingservice/api_op_PutBot.go +++ b/service/lexmodelbuildingservice/api_op_PutBot.go @@ -72,28 +72,6 @@ func (c *Client) PutBot(ctx context.Context, params *PutBotInput, optFns ...func type PutBotInput struct { - // The maximum time in seconds that Amazon Lex retains the data gathered in a - // conversation. A user interaction session remains active for the amount of time - // specified. If no conversation occurs during this time, the session expires and - // Amazon Lex deletes any data provided before the timeout. For example, suppose - // that a user chooses the OrderPizza intent, but gets sidetracked halfway through - // placing an order. If the user doesn't complete the order within the specified - // time, Amazon Lex discards the slot information that it gathered, and the user - // must start over. If you don't include the idleSessionTTLInSeconds element in a - // PutBot operation request, Amazon Lex uses the default value. This is also true - // if the request replaces an existing bot. The default is 300 seconds (5 minutes). - IdleSessionTTLInSeconds *int32 - - // If you set the processBehavior element to BUILD, Amazon Lex builds the bot so - // that it can be run. If you set the element to SAVE Amazon Lex saves the bot, but - // doesn't build it. If you don't specify this value, the default value is BUILD. - ProcessBehavior types.ProcessBehavior - - // When set to true a new numbered version of the bot is created. This is the same - // as calling the CreateBotVersion operation. If you don't specify createVersion, - // the default is false. - CreateVersion *bool - // For each Amazon Lex bot created with the Amazon Lex Model Building Service, you // must specify whether your use of Amazon Lex is related to a website, program, or // other application that is directed or targeted, in whole or in part, to children @@ -119,6 +97,18 @@ type PutBotInput struct { // This member is required. ChildDirected *bool + // Specifies the target locale for the bot. Any intent used in the bot must be + // compatible with the locale of the bot.

    The default is + // en-US.

    + // + // This member is required. + Locale types.Locale + + // The name of the bot. The name is not case sensitive. + // + // This member is required. + Name *string + // When Amazon Lex can't understand the user's input in context, it tries to elicit // the information a few times. After that, Amazon Lex sends the message defined in // abortStatement to the user, and then aborts the conversation. To set the number @@ -143,11 +133,6 @@ type PutBotInput struct { // version, you get a PreconditionFailedException exception. Checksum *string - // The name of the bot. The name is not case sensitive. - // - // This member is required. - Name *string - // When Amazon Lex doesn't understand the user's intent, it uses this message to // get clarification. To specify how many times Amazon Lex should repeat the // clarification prompt, use the maxAttempts field. If Amazon Lex still doesn't @@ -179,17 +164,10 @@ type PutBotInput struct { // from the user, it returns a 400 Bad Request exception. ClarificationPrompt *types.Prompt - // An array of Intent objects. Each intent represents a command that a user can - // express. For example, a pizza ordering bot might support an OrderPizza intent. - // For more information, see how-it-works (). - Intents []*types.Intent - - // The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions - // with the user. The locale configured for the voice must match the locale of the - // bot. For more information, see Voices in Amazon Polly - // (https://docs.aws.amazon.com/polly/latest/dg/voicelist.html) in the Amazon Polly - // Developer Guide. - VoiceId *string + // When set to true a new numbered version of the bot is created. This is the same + // as calling the CreateBotVersion operation. If you don't specify createVersion, + // the default is false. + CreateVersion *bool // A description of the bot. Description *string @@ -198,43 +176,50 @@ type PutBotInput struct { // analysis. If you don't specify detectSentiment, the default is false. DetectSentiment *bool - // Specifies the target locale for the bot. Any intent used in the bot must be - // compatible with the locale of the bot.

    The default is - // en-US.

    - // - // This member is required. - Locale types.Locale + // The maximum time in seconds that Amazon Lex retains the data gathered in a + // conversation. A user interaction session remains active for the amount of time + // specified. If no conversation occurs during this time, the session expires and + // Amazon Lex deletes any data provided before the timeout. For example, suppose + // that a user chooses the OrderPizza intent, but gets sidetracked halfway through + // placing an order. If the user doesn't complete the order within the specified + // time, Amazon Lex discards the slot information that it gathered, and the user + // must start over. If you don't include the idleSessionTTLInSeconds element in a + // PutBot operation request, Amazon Lex uses the default value. This is also true + // if the request replaces an existing bot. The default is 300 seconds (5 minutes). + IdleSessionTTLInSeconds *int32 + + // An array of Intent objects. Each intent represents a command that a user can + // express. For example, a pizza ordering bot might support an OrderPizza intent. + // For more information, see how-it-works (). + Intents []*types.Intent + + // If you set the processBehavior element to BUILD, Amazon Lex builds the bot so + // that it can be run. If you set the element to SAVE Amazon Lex saves the bot, but + // doesn't build it. If you don't specify this value, the default value is BUILD. + ProcessBehavior types.ProcessBehavior // A list of tags to add to the bot. You can only add tags when you create a bot, // you can't use the PutBot operation to update the tags on a bot. To update tags, // use the TagResource operation. Tags []*types.Tag -} -type PutBotOutput struct { - - // The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the - // user. For more information, see PutBot (). + // The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions + // with the user. The locale configured for the voice must match the locale of the + // bot. For more information, see Voices in Amazon Polly + // (https://docs.aws.amazon.com/polly/latest/dg/voicelist.html) in the Amazon Polly + // Developer Guide. VoiceId *string +} - // The prompts that Amazon Lex uses when it doesn't understand the user's intent. - // For more information, see PutBot (). - ClarificationPrompt *types.Prompt +type PutBotOutput struct { - // true if the bot is configured to send user utterances to Amazon Comprehend for - // sentiment analysis. If the detectSentiment field was not specified in the - // request, the detectSentiment field is false in the response. - DetectSentiment *bool + // The message that Amazon Lex uses to abort a conversation. For more information, + // see PutBot (). + AbortStatement *types.Statement // Checksum of the bot that you created. Checksum *string - // A description of the bot. - Description *string - - // The target locale for the bot. - Locale types.Locale - // For each Amazon Lex bot created with the Amazon Lex Model Building Service, you // must specify whether your use of Amazon Lex is related to a website, program, or // other application that is directed or targeted, in whole or in part, to children @@ -258,30 +243,47 @@ type PutBotOutput struct { // (https://aws.amazon.com/lex/faqs#data-security) ChildDirected *bool - // A list of tags associated with the bot. - Tags []*types.Tag + // The prompts that Amazon Lex uses when it doesn't understand the user's intent. + // For more information, see PutBot (). + ClarificationPrompt *types.Prompt + + // True if a new version of the bot was created. If the createVersion field was not + // specified in the request, the createVersion field is set to false in the + // response. + CreateVersion *bool + + // The date that the bot was created. + CreatedDate *time.Time + + // A description of the bot. + Description *string + + // true if the bot is configured to send user utterances to Amazon Comprehend for + // sentiment analysis. If the detectSentiment field was not specified in the + // request, the detectSentiment field is false in the response. + DetectSentiment *bool // If status is FAILED, Amazon Lex provides the reason that it failed to build the // bot. FailureReason *string + // The maximum length of time that Amazon Lex retains the data gathered in a + // conversation. For more information, see PutBot (). + IdleSessionTTLInSeconds *int32 + // An array of Intent objects. For more information, see PutBot (). Intents []*types.Intent - // The version of the bot. For a new bot, the version is always $LATEST. - Version *string + // The date that the bot was updated. When you create a resource, the creation date + // and last updated date are the same. + LastUpdatedDate *time.Time - // The maximum length of time that Amazon Lex retains the data gathered in a - // conversation. For more information, see PutBot (). - IdleSessionTTLInSeconds *int32 + // The target locale for the bot. + Locale types.Locale // The name of the bot. Name *string - // The message that Amazon Lex uses to abort a conversation. For more information, - // see PutBot (). - AbortStatement *types.Statement - // When you send a request to create a bot with processBehavior set to BUILD, // Amazon Lex sets the status response element to BUILDING. In the // READY_BASIC_TESTING state you can test the bot with user inputs that exactly @@ -293,17 +295,15 @@ type PutBotOutput struct { // bot. Status types.Status - // The date that the bot was updated. When you create a resource, the creation date - // and last updated date are the same. - LastUpdatedDate *time.Time + // A list of tags associated with the bot. + Tags []*types.Tag - // True if a new version of the bot was created. If the createVersion field was not - // specified in the request, the createVersion field is set to false in the - // response. - CreateVersion *bool + // The version of the bot. For a new bot, the version is always $LATEST. + Version *string - // The date that the bot was created. - CreatedDate *time.Time + // The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the + // user. For more information, see PutBot (). + VoiceId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/lexmodelbuildingservice/api_op_PutBotAlias.go b/service/lexmodelbuildingservice/api_op_PutBotAlias.go index 7566c7c8b8a..d7bf183b222 100644 --- a/service/lexmodelbuildingservice/api_op_PutBotAlias.go +++ b/service/lexmodelbuildingservice/api_op_PutBotAlias.go @@ -71,9 +71,6 @@ type PutBotAliasInput struct { // This member is required. BotVersion *string - // A description of the alias. - Description *string - // The name of the alias. The name is not case sensitive. // // This member is required. @@ -87,39 +84,42 @@ type PutBotAliasInput struct { // match the $LATEST version, you get a PreconditionFailedException exception. Checksum *string - // A list of tags to add to the bot alias. You can only add tags when you create an - // alias, you can't use the PutBotAlias operation to update the tags on a bot - // alias. To update tags, use the TagResource operation. - Tags []*types.Tag - // Settings for conversation logs for the alias. ConversationLogs *types.ConversationLogsRequest -} - -type PutBotAliasOutput struct { // A description of the alias. Description *string - // The settings that determine how Amazon Lex uses conversation logs for the alias. - ConversationLogs *types.ConversationLogsResponse + // A list of tags to add to the bot alias. You can only add tags when you create an + // alias, you can't use the PutBotAlias operation to update the tags on a bot + // alias. To update tags, use the TagResource operation. + Tags []*types.Tag +} - // The date that the bot alias was updated. When you create a resource, the - // creation date and the last updated date are the same. - LastUpdatedDate *time.Time +type PutBotAliasOutput struct { // The name of the bot that the alias points to. BotName *string - // The date that the bot alias was created. - CreatedDate *time.Time - // The version of the bot that the alias points to. BotVersion *string // The checksum for the current version of the alias. Checksum *string + // The settings that determine how Amazon Lex uses conversation logs for the alias. + ConversationLogs *types.ConversationLogsResponse + + // The date that the bot alias was created. + CreatedDate *time.Time + + // A description of the alias. + Description *string + + // The date that the bot alias was updated. When you create a resource, the + // creation date and the last updated date are the same. + LastUpdatedDate *time.Time + // The name of the alias. Name *string diff --git a/service/lexmodelbuildingservice/api_op_PutIntent.go b/service/lexmodelbuildingservice/api_op_PutIntent.go index 7038139c55b..7d4a85d1f7b 100644 --- a/service/lexmodelbuildingservice/api_op_PutIntent.go +++ b/service/lexmodelbuildingservice/api_op_PutIntent.go @@ -96,6 +96,17 @@ func (c *Client) PutIntent(ctx context.Context, params *PutIntentInput, optFns . type PutIntentInput struct { + // The name of the intent. The name is not case sensitive. The name can't match a + // built-in intent name, or a built-in intent name with "AMAZON." removed. For + // example, because there is a built-in intent called AMAZON.HelpIntent, you can't + // create a custom intent called HelpIntent. For a list of built-in intents, see + // Standard Built-in Intents + // (https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents) + // in the Alexa Skills Kit. + // + // This member is required. + Name *string + // Identifies a specific revision of the $LATEST version. When you create a new // intent, leave the checksum field blank. If you specify a checksum you get a // BadRequestException exception. When you want to update a intent, set the @@ -104,54 +115,30 @@ type PutIntentInput struct { // match the $LATEST version, you get a PreconditionFailedException exception. Checksum *string - // Configuration information required to use the AMAZON.KendraSearchIntent intent - // to connect to an Amazon Kendra index. For more information, see - // AMAZON.KendraSearchIntent - // (http://docs.aws.amazon.com/lex/latest/dg/built-in-intent-kendra-search.html). - KendraConfiguration *types.KendraConfiguration - - // A description of the intent. - Description *string + // The statement that you want Amazon Lex to convey to the user after the intent is + // successfully fulfilled by the Lambda function. This element is relevant only if + // you provide a Lambda function in the fulfillmentActivity. If you return the + // intent to the client application, you can't specify this element. The + // followUpPrompt and conclusionStatement are mutually exclusive. You can specify + // only one. + ConclusionStatement *types.Statement - // Required. Describes how the intent is fulfilled. For example, after a user - // provides all of the information for a pizza order, fulfillmentActivity defines - // how the bot places an order with a local pizza store. You might configure Amazon - // Lex to return all of the intent information to the client application, or direct - // it to invoke a Lambda function that can process the intent (for example, place - // an order with a pizzeria). - FulfillmentActivity *types.FulfillmentActivity + // Prompts the user to confirm the intent. This question should have a yes or no + // answer. Amazon Lex uses this prompt to ensure that the user acknowledges that + // the intent is ready for fulfillment. For example, with the OrderPizza intent, + // you might want to confirm that the order is correct before placing it. For other + // intents, such as intents that simply respond to user questions, you might not + // need to ask the user for confirmation before providing the information. You you + // must provide both the rejectionStatement and the confirmationPrompt, or neither. + ConfirmationPrompt *types.Prompt // When set to true a new numbered version of the intent is created. This is the // same as calling the CreateIntentVersion operation. If you do not specify // createVersion, the default is false. CreateVersion *bool - // An array of utterances (strings) that a user might say to signal the intent. For - // example, "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas". - //

    In each utterance, a slot name is enclosed in curly braces.

    - SampleUtterances []*string - - // An array of intent slots. At runtime, Amazon Lex elicits required slot values - // from the user using prompts defined in the slots. For more information, see - // how-it-works (). - Slots []*types.Slot - - // When the user answers "no" to the question defined in confirmationPrompt, Amazon - // Lex responds with this statement to acknowledge that the intent was canceled. - // You must provide both the rejectionStatement and the confirmationPrompt, or - // neither. - RejectionStatement *types.Statement - - // The name of the intent. The name is not case sensitive. The name can't match a - // built-in intent name, or a built-in intent name with "AMAZON." removed. For - // example, because there is a built-in intent called AMAZON.HelpIntent, you can't - // create a custom intent called HelpIntent. For a list of built-in intents, see - // Standard Built-in Intents - // (https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents) - // in the Alexa Skills Kit. - // - // This member is required. - Name *string + // A description of the intent. + Description *string // Specifies a Lambda function to invoke for each user input. You can invoke this // Lambda function to personalize user interaction. For example, suppose your bot @@ -186,50 +173,70 @@ type PutIntentInput struct { // only one.

    FollowUpPrompt *types.FollowUpPrompt + // Required. Describes how the intent is fulfilled. For example, after a user + // provides all of the information for a pizza order, fulfillmentActivity defines + // how the bot places an order with a local pizza store. You might configure Amazon + // Lex to return all of the intent information to the client application, or direct + // it to invoke a Lambda function that can process the intent (for example, place + // an order with a pizzeria). + FulfillmentActivity *types.FulfillmentActivity + + // Configuration information required to use the AMAZON.KendraSearchIntent intent + // to connect to an Amazon Kendra index. For more information, see + // AMAZON.KendraSearchIntent + // (http://docs.aws.amazon.com/lex/latest/dg/built-in-intent-kendra-search.html). + KendraConfiguration *types.KendraConfiguration + // A unique identifier for the built-in intent to base this intent on. To find the // signature for an intent, see Standard Built-in Intents // (https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents) // in the Alexa Skills Kit. ParentIntentSignature *string - // The statement that you want Amazon Lex to convey to the user after the intent is - // successfully fulfilled by the Lambda function. This element is relevant only if - // you provide a Lambda function in the fulfillmentActivity. If you return the - // intent to the client application, you can't specify this element. The - // followUpPrompt and conclusionStatement are mutually exclusive. You can specify - // only one. - ConclusionStatement *types.Statement + // When the user answers "no" to the question defined in confirmationPrompt, Amazon + // Lex responds with this statement to acknowledge that the intent was canceled. + // You must provide both the rejectionStatement and the confirmationPrompt, or + // neither. + RejectionStatement *types.Statement - // Prompts the user to confirm the intent. This question should have a yes or no - // answer. Amazon Lex uses this prompt to ensure that the user acknowledges that - // the intent is ready for fulfillment. For example, with the OrderPizza intent, - // you might want to confirm that the order is correct before placing it. For other - // intents, such as intents that simply respond to user questions, you might not - // need to ask the user for confirmation before providing the information. You you - // must provide both the rejectionStatement and the confirmationPrompt, or neither. - ConfirmationPrompt *types.Prompt + // An array of utterances (strings) that a user might say to signal the intent. For + // example, "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas". + //

    In each utterance, a slot name is enclosed in curly braces.

    + SampleUtterances []*string + + // An array of intent slots. At runtime, Amazon Lex elicits required slot values + // from the user using prompts defined in the slots. For more information, see + // how-it-works (). + Slots []*types.Slot } type PutIntentOutput struct { + // Checksum of the $LATESTversion of the intent created or updated. + Checksum *string + // After the Lambda function specified in thefulfillmentActivityintent fulfills the // intent, Amazon Lex conveys this statement to the user. ConclusionStatement *types.Statement + // If defined in the intent, Amazon Lex prompts the user to confirm the intent + // before fulfilling it. + ConfirmationPrompt *types.Prompt + // True if a new version of the intent was created. If the createVersion field was // not specified in the request, the createVersion field is set to false in the // response. CreateVersion *bool - // An array of sample utterances that are configured for the intent. - SampleUtterances []*string + // The date that the intent was created. + CreatedDate *time.Time - // The version of the intent. For a new intent, the version is always $LATEST. - Version *string + // A description of the intent. + Description *string - // The date that the intent was updated. When you create a resource, the creation - // date and last update dates are the same. - LastUpdatedDate *time.Time + // If defined in the intent, Amazon Lex invokes this Lambda function for each user + // input. + DialogCodeHook *types.CodeHook // If defined in the intent, Amazon Lex uses this prompt to solicit additional user // activity after the intent is fulfilled. @@ -239,39 +246,32 @@ type PutIntentOutput struct { // intent after the user provides all of the information required by the intent. FulfillmentActivity *types.FulfillmentActivity - // A description of the intent. - Description *string + // Configuration information, if any, required to connect to an Amazon Kendra index + // and use the AMAZON.KendraSearchIntent intent. + KendraConfiguration *types.KendraConfiguration - // An array of intent slots that are configured for the intent. - Slots []*types.Slot + // The date that the intent was updated. When you create a resource, the creation + // date and last update dates are the same. + LastUpdatedDate *time.Time + + // The name of the intent. + Name *string + + // A unique identifier for the built-in intent that this intent is based on. + ParentIntentSignature *string // If the user answers "no" to the question defined in confirmationPrompt Amazon // Lex responds with this statement to acknowledge that the intent was canceled. RejectionStatement *types.Statement - // The date that the intent was created. - CreatedDate *time.Time - - // If defined in the intent, Amazon Lex prompts the user to confirm the intent - // before fulfilling it. - ConfirmationPrompt *types.Prompt - - // If defined in the intent, Amazon Lex invokes this Lambda function for each user - // input. - DialogCodeHook *types.CodeHook - - // The name of the intent. - Name *string - - // Checksum of the $LATESTversion of the intent created or updated. - Checksum *string + // An array of sample utterances that are configured for the intent. + SampleUtterances []*string - // Configuration information, if any, required to connect to an Amazon Kendra index - // and use the AMAZON.KendraSearchIntent intent. - KendraConfiguration *types.KendraConfiguration + // An array of intent slots that are configured for the intent. + Slots []*types.Slot - // A unique identifier for the built-in intent that this intent is based on. - ParentIntentSignature *string + // The version of the intent. For a new intent, the version is always $LATEST. + Version *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/lexmodelbuildingservice/api_op_PutSlotType.go b/service/lexmodelbuildingservice/api_op_PutSlotType.go index 0aaad3acae2..a80690cff76 100644 --- a/service/lexmodelbuildingservice/api_op_PutSlotType.go +++ b/service/lexmodelbuildingservice/api_op_PutSlotType.go @@ -68,38 +68,6 @@ func (c *Client) PutSlotType(ctx context.Context, params *PutSlotTypeInput, optF type PutSlotTypeInput struct { - // When set to true a new numbered version of the slot type is created. This is the - // same as calling the CreateSlotTypeVersion operation. If you do not specify - // createVersion, the default is false. - CreateVersion *bool - - // Determines the slot resolution strategy that Amazon Lex uses to return slot type - // values. The field can be set to one of the following values: - // - // * - // ORIGINAL_VALUE - Returns the value entered by the user, if the user value is - // similar to the slot value. - // - // * TOP_RESOLUTION - If there is a resolution list - // for the slot, return the first value in the resolution list as the slot type - // value. If there is no resolution list, null is returned. - // - // If you don't specify - // the valueSelectionStrategy, the default is ORIGINAL_VALUE. - ValueSelectionStrategy types.SlotValueSelectionStrategy - - // Configuration information that extends the parent built-in slot type. The - // configuration is added to the settings for the parent slot type. - SlotTypeConfigurations []*types.SlotTypeConfiguration - - // Identifies a specific revision of the $LATEST version. When you create a new - // slot type, leave the checksum field blank. If you specify a checksum you get a - // BadRequestException exception. When you want to update a slot type, set the - // checksum field to the checksum of the most recent revision of the $LATEST - // version. If you don't specify the checksum field, or if the checksum does not - // match the $LATEST version, you get a PreconditionFailedException exception. - Checksum *string - // The name of the slot type. The name is not case sensitive. The name can't match // a built-in slot type name, or a built-in slot type name with "AMAZON." removed. // For example, because there is a built-in slot type called AMAZON.DATE, you can't @@ -111,6 +79,22 @@ type PutSlotTypeInput struct { // This member is required. Name *string + // Identifies a specific revision of the $LATEST version. When you create a new + // slot type, leave the checksum field blank. If you specify a checksum you get a + // BadRequestException exception. When you want to update a slot type, set the + // checksum field to the checksum of the most recent revision of the $LATEST + // version. If you don't specify the checksum field, or if the checksum does not + // match the $LATEST version, you get a PreconditionFailedException exception. + Checksum *string + + // When set to true a new numbered version of the slot type is created. This is the + // same as calling the CreateSlotTypeVersion operation. If you do not specify + // createVersion, the default is false. + CreateVersion *bool + + // A description of the slot type. + Description *string + // A list of EnumerationValue objects that defines the values that the slot type // can take. Each value can have a list of synonyms, which are additional values // that help train the machine learning model about the values that it resolves for @@ -122,56 +106,72 @@ type PutSlotTypeInput struct { // field indicates the option to use. EnumerationValues []*types.EnumerationValue - // A description of the slot type. - Description *string - // The built-in slot type used as the parent of the slot type. When you define a // parent slot type, the new slot type has all of the same configuration as the // parent. Only AMAZON.AlphaNumeric is supported. ParentSlotTypeSignature *string -} -type PutSlotTypeOutput struct { - - // Configuration information that extends the parent built-in slot type. + // Configuration information that extends the parent built-in slot type. The + // configuration is added to the settings for the parent slot type. SlotTypeConfigurations []*types.SlotTypeConfiguration - // The slot resolution strategy that Amazon Lex uses to determine the value of the - // slot. For more information, see PutSlotType (). + // Determines the slot resolution strategy that Amazon Lex uses to return slot type + // values. The field can be set to one of the following values: + // + // * + // ORIGINAL_VALUE - Returns the value entered by the user, if the user value is + // similar to the slot value. + // + // * TOP_RESOLUTION - If there is a resolution list + // for the slot, return the first value in the resolution list as the slot type + // value. If there is no resolution list, null is returned. + // + // If you don't specify + // the valueSelectionStrategy, the default is ORIGINAL_VALUE. ValueSelectionStrategy types.SlotValueSelectionStrategy +} - // The date that the slot type was updated. When you create a slot type, the - // creation date and last update date are the same. - LastUpdatedDate *time.Time - - // A description of the slot type. - Description *string +type PutSlotTypeOutput struct { // Checksum of the $LATEST version of the slot type. Checksum *string - // The name of the slot type. - Name *string - - // The version of the slot type. For a new slot type, the version is always - // $LATEST. - Version *string - - // The date that the slot type was created. - CreatedDate *time.Time - // True if a new version of the slot type was created. If the createVersion field // was not specified in the request, the createVersion field is set to false in the // response. CreateVersion *bool - // The built-in slot type used as the parent of the slot type. - ParentSlotTypeSignature *string + // The date that the slot type was created. + CreatedDate *time.Time + + // A description of the slot type. + Description *string // A list of EnumerationValue objects that defines the values that the slot type // can take. EnumerationValues []*types.EnumerationValue + // The date that the slot type was updated. When you create a slot type, the + // creation date and last update date are the same. + LastUpdatedDate *time.Time + + // The name of the slot type. + Name *string + + // The built-in slot type used as the parent of the slot type. + ParentSlotTypeSignature *string + + // Configuration information that extends the parent built-in slot type. + SlotTypeConfigurations []*types.SlotTypeConfiguration + + // The slot resolution strategy that Amazon Lex uses to determine the value of the + // slot. For more information, see PutSlotType (). + ValueSelectionStrategy types.SlotValueSelectionStrategy + + // The version of the slot type. For a new slot type, the version is always + // $LATEST. + Version *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lexmodelbuildingservice/api_op_StartImport.go b/service/lexmodelbuildingservice/api_op_StartImport.go index 9a1bdc09688..4ae618a7ab7 100644 --- a/service/lexmodelbuildingservice/api_op_StartImport.go +++ b/service/lexmodelbuildingservice/api_op_StartImport.go @@ -58,20 +58,19 @@ func (c *Client) StartImport(ctx context.Context, params *StartImportInput, optF type StartImportInput struct { - // A list of tags to add to the imported bot. You can only add tags when you import - // a bot, you can't add tags to an intent or slot type. - Tags []*types.Tag - - // Specifies the type of resource to export. Each resource also exports any - // resources that it depends on. - // - // * A bot exports dependent intents. + // Specifies the action that the StartImport operation should take when there is an + // existing resource with the same name. // - // * An - // intent exports dependent slot types. + // * FAIL_ON_CONFLICT - The import + // operation is stopped on the first conflict between a resource in the import file + // and an existing resource. The name of the resource causing the conflict is in + // the failureReason field of the response to the GetImport operation. + // OVERWRITE_LATEST - The import operation proceeds even if there is a conflict + // with an existing resource. The $LASTEST version of the existing resource is + // overwritten with the data from the import file. // // This member is required. - ResourceType types.ResourceType + MergeStrategy types.MergeStrategy // A zip archive in binary format. The archive should contain one file, a JSON file // containing the resource to import. The resource should match the type specified @@ -80,23 +79,27 @@ type StartImportInput struct { // This member is required. Payload []byte - // Specifies the action that the StartImport operation should take when there is an - // existing resource with the same name. + // Specifies the type of resource to export. Each resource also exports any + // resources that it depends on. // - // * FAIL_ON_CONFLICT - The import - // operation is stopped on the first conflict between a resource in the import file - // and an existing resource. The name of the resource causing the conflict is in - // the failureReason field of the response to the GetImport operation. - // OVERWRITE_LATEST - The import operation proceeds even if there is a conflict - // with an existing resource. The $LASTEST version of the existing resource is - // overwritten with the data from the import file. + // * A bot exports dependent intents. + // + // * An + // intent exports dependent slot types. // // This member is required. - MergeStrategy types.MergeStrategy + ResourceType types.ResourceType + + // A list of tags to add to the imported bot. You can only add tags when you import + // a bot, you can't add tags to an intent or slot type. + Tags []*types.Tag } type StartImportOutput struct { + // A timestamp for the date and time that the import job was requested. + CreatedDate *time.Time + // The identifier for the specific import job. ImportId *string @@ -104,20 +107,17 @@ type StartImportOutput struct { // for the failure using the GetImport operation. ImportStatus types.ImportStatus - // A list of tags added to the imported bot. - Tags []*types.Tag - - // The type of resource to import. - ResourceType types.ResourceType + // The action to take when there is a merge conflict. + MergeStrategy types.MergeStrategy // The name given to the import job. Name *string - // A timestamp for the date and time that the import job was requested. - CreatedDate *time.Time + // The type of resource to import. + ResourceType types.ResourceType - // The action to take when there is a merge conflict. - MergeStrategy types.MergeStrategy + // A list of tags added to the imported bot. + Tags []*types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/lexmodelbuildingservice/api_op_TagResource.go b/service/lexmodelbuildingservice/api_op_TagResource.go index 0ee003b2a61..d4799a52799 100644 --- a/service/lexmodelbuildingservice/api_op_TagResource.go +++ b/service/lexmodelbuildingservice/api_op_TagResource.go @@ -58,16 +58,16 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // A list of tag keys to add to the resource. If a tag key already exists, the - // existing value is replaced with the new value. + // The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel to tag. // // This member is required. - Tags []*types.Tag + ResourceArn *string - // The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel to tag. + // A list of tag keys to add to the resource. If a tag key already exists, the + // existing value is replaced with the new value. // // This member is required. - ResourceArn *string + Tags []*types.Tag } type TagResourceOutput struct { diff --git a/service/lexmodelbuildingservice/go.mod b/service/lexmodelbuildingservice/go.mod index ddc7edb39bb..3ec69c73f5b 100644 --- a/service/lexmodelbuildingservice/go.mod +++ b/service/lexmodelbuildingservice/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/lexmodelbuildingservice go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/lexmodelbuildingservice/types/types.go b/service/lexmodelbuildingservice/types/types.go index 50925ff8cff..69f1e5115cb 100644 --- a/service/lexmodelbuildingservice/types/types.go +++ b/service/lexmodelbuildingservice/types/types.go @@ -9,113 +9,113 @@ import ( // Provides information about a bot alias. type BotAliasMetadata struct { - // Settings that determine how Amazon Lex uses conversation logs for the alias. - ConversationLogs *ConversationLogsResponse - - // A description of the bot alias. - Description *string - // The name of the bot to which the alias points. BotName *string // The version of the Amazon Lex bot to which the alias points. BotVersion *string - // The date that the bot alias was updated. When you create a resource, the - // creation date and last updated date are the same. - LastUpdatedDate *time.Time + // Checksum of the bot alias. + Checksum *string + + // Settings that determine how Amazon Lex uses conversation logs for the alias. + ConversationLogs *ConversationLogsResponse // The date that the bot alias was created. CreatedDate *time.Time + // A description of the bot alias. + Description *string + + // The date that the bot alias was updated. When you create a resource, the + // creation date and last updated date are the same. + LastUpdatedDate *time.Time + // The name of the bot alias. Name *string - - // Checksum of the bot alias. - Checksum *string } // Represents an association between an Amazon Lex bot and an external messaging // platform. type BotChannelAssociation struct { - // The status of the bot channel. - // - // * CREATED - The channel has been created and - // is ready for use. - // - // * IN_PROGRESS - Channel creation is in progress. - // - // * - // FAILED - There was an error creating the channel. For information about the - // reason for the failure, see the failureReason field. - Status ChannelStatus - - // If status is FAILED, Amazon Lex provides the reason that it failed to create the - // association. - FailureReason *string + // An alias pointing to the specific version of the Amazon Lex bot to which this + // association is being made. + BotAlias *string - // Specifies the type of association by indicating the type of channel being - // established between the Amazon Lex bot and the external messaging platform. - Type ChannelType + // Provides information necessary to communicate with the messaging platform. + BotConfiguration map[string]*string // The name of the Amazon Lex bot to which this association is being made. // Currently, Amazon Lex supports associations with Facebook and Slack, and Twilio. // BotName *string + // The date that the association between the Amazon Lex bot and the channel was + // created. + CreatedDate *time.Time + // A text description of the association you are creating. Description *string - // An alias pointing to the specific version of the Amazon Lex bot to which this - // association is being made. - BotAlias *string + // If status is FAILED, Amazon Lex provides the reason that it failed to create the + // association. + FailureReason *string // The name of the association between the bot and the channel. Name *string - // The date that the association between the Amazon Lex bot and the channel was - // created. - CreatedDate *time.Time + // The status of the bot channel. + // + // * CREATED - The channel has been created and + // is ready for use. + // + // * IN_PROGRESS - Channel creation is in progress. + // + // * + // FAILED - There was an error creating the channel. For information about the + // reason for the failure, see the failureReason field. + Status ChannelStatus - // Provides information necessary to communicate with the messaging platform. - BotConfiguration map[string]*string + // Specifies the type of association by indicating the type of channel being + // established between the Amazon Lex bot and the external messaging platform. + Type ChannelType } // Provides information about a bot. . type BotMetadata struct { + // The date that the bot was created. + CreatedDate *time.Time + + // A description of the bot. + Description *string + // The date that the bot was updated. When you create a bot, the creation date and // last updated date are the same. LastUpdatedDate *time.Time + // The name of the bot. + Name *string + // The status of the bot. Status Status - // A description of the bot. - Description *string - - // The date that the bot was created. - CreatedDate *time.Time - // The version of the bot. For a new bot, the version is always $LATEST. Version *string - - // The name of the bot. - Name *string } // Provides metadata for a built-in intent. type BuiltinIntentMetadata struct { - // A list of identifiers for the locales that the intent supports. - SupportedLocales []Locale - // A unique identifier for the built-in intent. To find the signature for an // intent, see Standard Built-in Intents // (https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents) // in the Alexa Skills Kit. Signature *string + + // A list of identifiers for the locales that the intent supports. + SupportedLocales []Locale } // Provides information about a slot used in a built-in intent. @@ -128,30 +128,30 @@ type BuiltinIntentSlot struct { // Provides information about a built in slot type. type BuiltinSlotTypeMetadata struct { - // A list of target locales for the slot. - SupportedLocales []Locale - // A unique identifier for the built-in slot type. To find the signature for a slot // type, see Slot Type Reference // (https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/slot-type-reference) // in the Alexa Skills Kit. Signature *string + + // A list of target locales for the slot. + SupportedLocales []Locale } // Specifies a Lambda function that verifies requests to a bot or fulfills the // user's request to a bot.. type CodeHook struct { - // The Amazon Resource Name (ARN) of the Lambda function. - // - // This member is required. - Uri *string - // The version of the request-response that you want Amazon Lex to use to invoke // your Lambda function. For more information, see using-lambda (). // // This member is required. MessageVersion *string + + // The Amazon Resource Name (ARN) of the Lambda function. + // + // This member is required. + Uri *string } // Provides the settings needed for conversation logs. @@ -211,16 +211,16 @@ type EnumerationValue struct { // whether the user wants to order drinks. type FollowUpPrompt struct { - // If the user answers "no" to the question defined in the prompt field, Amazon Lex - // responds with this statement to acknowledge that the intent was canceled. + // Prompts for information from the user. // // This member is required. - RejectionStatement *Statement + Prompt *Prompt - // Prompts for information from the user. + // If the user answers "no" to the question defined in the prompt field, Amazon Lex + // responds with this statement to acknowledge that the intent was canceled. // // This member is required. - Prompt *Prompt + RejectionStatement *Statement } // Describes how the intent is fulfilled after the user provides all of the @@ -252,15 +252,15 @@ type FulfillmentActivity struct { // Identifies the specific version of an intent. type Intent struct { - // The version of the intent. + // The name of the intent. // // This member is required. - IntentVersion *string + IntentName *string - // The name of the intent. + // The version of the intent. // // This member is required. - IntentName *string + IntentVersion *string } // Provides information about an intent. @@ -269,8 +269,8 @@ type IntentMetadata struct { // The date that the intent was created. CreatedDate *time.Time - // The version of the intent. - Version *string + // A description of the intent. + Description *string // The date that the intent was updated. When you create an intent, the creation // date and last updated date are the same. @@ -279,8 +279,8 @@ type IntentMetadata struct { // The name of the intent. Name *string - // A description of the intent. - Description *string + // The version of the intent. + Version *string } // Provides configuration information for the AMAZON.KendraSearchIntent intent. @@ -290,12 +290,13 @@ type IntentMetadata struct { // (http://docs.aws.amazon.com/lex/latest/dg/built-in-intent-kendra-search.html). type KendraConfiguration struct { - // A query filter that Amazon Lex sends to Amazon Kendra to filter the response - // from the query. The filter is in the format defined by Amazon Kendra. For more - // information, see Filtering queries - // (http://docs.aws.amazon.com/kendra/latest/dg/filtering.html). You can override - // this filter string with a new filter string at runtime. - QueryFilterString *string + // The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the + // AMAZON.KendraSearchIntent intent to search. The index must be in the same + // account and Region as the Amazon Lex bot. If the Amazon Kendra index does not + // exist, you get an exception when you call the PutIntent operation. + // + // This member is required. + KendraIndex *string // The Amazon Resource Name (ARN) of an IAM role that has permission to search the // Amazon Kendra index. The role must be in the same account and Region as the @@ -305,45 +306,47 @@ type KendraConfiguration struct { // This member is required. Role *string - // The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the - // AMAZON.KendraSearchIntent intent to search. The index must be in the same - // account and Region as the Amazon Lex bot. If the Amazon Kendra index does not - // exist, you get an exception when you call the PutIntent operation. - // - // This member is required. - KendraIndex *string + // A query filter that Amazon Lex sends to Amazon Kendra to filter the response + // from the query. The filter is in the format defined by Amazon Kendra. For more + // information, see Filtering queries + // (http://docs.aws.amazon.com/kendra/latest/dg/filtering.html). You can override + // this filter string with a new filter string at runtime. + QueryFilterString *string } // Settings used to configure delivery mode and destination for conversation logs. type LogSettingsRequest struct { - // The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket - // where the logs should be delivered. - // - // This member is required. - ResourceArn *string - // Where the logs will be delivered. Text logs are delivered to a CloudWatch Logs // log group. Audio logs are delivered to an S3 bucket. // // This member is required. Destination Destination - // The Amazon Resource Name (ARN) of the AWS KMS customer managed key for - // encrypting audio logs delivered to an S3 bucket. The key does not apply to - // CloudWatch Logs and is optional for S3 buckets. - KmsKeyArn *string - // The type of logging to enable. Text logs are delivered to a CloudWatch Logs log // group. Audio logs are delivered to an S3 bucket. // // This member is required. LogType LogType + + // The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket + // where the logs should be delivered. + // + // This member is required. + ResourceArn *string + + // The Amazon Resource Name (ARN) of the AWS KMS customer managed key for + // encrypting audio logs delivered to an S3 bucket. The key does not apply to + // CloudWatch Logs and is optional for S3 buckets. + KmsKeyArn *string } // The settings for conversation logs. type LogSettingsResponse struct { + // The destination where logs are delivered. + Destination Destination + // The Amazon Resource Name (ARN) of the key used to encrypt audio logs in an S3 // bucket. KmsKeyArn *string @@ -351,17 +354,14 @@ type LogSettingsResponse struct { // The type of logging that is enabled. LogType LogType + // The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket + // where the logs are delivered. + ResourceArn *string + // The resource prefix is the first part of the S3 object key within the S3 bucket // that you specified to contain audio logs. For CloudWatch Logs it is the prefix // of the log stream name within the log group that you specified. ResourcePrefix *string - - // The destination where logs are delivered. - Destination Destination - - // The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket - // where the logs are delivered. - ResourceArn *string } // The message object that provides the message text and its type. @@ -389,10 +389,10 @@ type Message struct { // to prompt the user. For more information, see how-it-works (). type Prompt struct { - // A response card. Amazon Lex uses this prompt at runtime, in the PostText API - // response. It substitutes session attributes and slot values for placeholders in - // the response card. For more information, see ex-resp-card (). - ResponseCard *string + // The number of times to prompt the user for information. + // + // This member is required. + MaxAttempts *int32 // An array of objects, each of which provides a message string and its type. You // can specify the message string in plain text or in Speech Synthesis Markup @@ -401,10 +401,10 @@ type Prompt struct { // This member is required. Messages []*Message - // The number of times to prompt the user for information. - // - // This member is required. - MaxAttempts *int32 + // A response card. Amazon Lex uses this prompt at runtime, in the PostText API + // response. It substitutes session attributes and slot values for placeholders in + // the response card. For more information, see ex-resp-card (). + ResponseCard *string } // Describes the resource that refers to the resource that you are attempting to @@ -423,14 +423,19 @@ type ResourceReference struct { // Identifies the version of a specific slot. type Slot struct { - // A description of the slot. - Description *string - // The name of the slot. // // This member is required. Name *string + // Specifies whether the slot is required or optional. + // + // This member is required. + SlotConstraint SlotConstraint + + // A description of the slot. + Description *string + // Determines whether a slot is obfuscated in conversation logs and stored // utterances. When you obfuscate a slot, the value is replaced by the slot name in // curly braces ({}). For example, if the slot name is "full_name", obfuscated @@ -444,30 +449,25 @@ type Slot struct { // same priority, the order in which Amazon Lex elicits values is arbitrary. Priority *int32 + // A set of possible responses for the slot type used by text-based clients. A user + // chooses an option from the response card, instead of using text to reply. + ResponseCard *string + // If you know a specific pattern with which users might respond to an Amazon Lex // request for a slot value, you can provide those utterances to improve accuracy. // This is optional. In most cases, Amazon Lex is capable of understanding user // utterances. SampleUtterances []*string - // A set of possible responses for the slot type used by text-based clients. A user - // chooses an option from the response card, instead of using text to reply. - ResponseCard *string - - // The prompt that Amazon Lex uses to elicit the slot value from the user. - ValueElicitationPrompt *Prompt + // The type of the slot, either a custom slot type that you defined or one of the + // built-in slot types. + SlotType *string // The version of the slot type. SlotTypeVersion *string - // Specifies whether the slot is required or optional. - // - // This member is required. - SlotConstraint SlotConstraint - - // The type of the slot, either a custom slot type that you defined or one of the - // built-in slot types. - SlotType *string + // The prompt that Amazon Lex uses to elicit the slot value from the user. + ValueElicitationPrompt *Prompt } // Provides configuration information for a slot type. @@ -483,18 +483,18 @@ type SlotTypeMetadata struct { // The date that the slot type was created. CreatedDate *time.Time + // A description of the slot type. + Description *string + // The date that the slot type was updated. When you create a resource, the // creation date and last updated date are the same. LastUpdatedDate *time.Time - // The version of the slot type. - Version *string - - // A description of the slot type. - Description *string - // The name of the slot type. Name *string + + // The version of the slot type. + Version *string } // Provides a regular expression used to validate the value of a slot. @@ -544,46 +544,46 @@ type Statement struct { // the following symbols: _ . : / = + - @. type Tag struct { - // The value associated with a key. The value may be an empty string but it can't - // be null. + // The key for the tag. Keys are not case-sensitive and must be unique. // // This member is required. - Value *string + Key *string - // The key for the tag. Keys are not case-sensitive and must be unique. + // The value associated with a key. The value may be an empty string but it can't + // be null. // // This member is required. - Key *string + Value *string } // Provides information about a single utterance that was made to your bot. type UtteranceData struct { - // The text that was entered by the user or the text representation of an audio - // clip. - UtteranceString *string - - // The date that the utterance was first recorded. - FirstUtteredDate *time.Time + // The number of times that the utterance was processed. + Count *int32 // The total number of individuals that used the utterance. DistinctUsers *int32 - // The number of times that the utterance was processed. - Count *int32 + // The date that the utterance was first recorded. + FirstUtteredDate *time.Time // The date that the utterance was last recorded. LastUtteredDate *time.Time + + // The text that was entered by the user or the text representation of an audio + // clip. + UtteranceString *string } // Provides a list of utterances that have been made to a specific version of your // bot. The list contains a maximum of 100 utterances. type UtteranceList struct { + // The version of the bot that processed the list. + BotVersion *string + // One or more UtteranceData () objects that contain information about the // utterances that have been made to a bot. The maximum number of object is 100. Utterances []*UtteranceData - - // The version of the bot that processed the list. - BotVersion *string } diff --git a/service/lexruntimeservice/api_op_DeleteSession.go b/service/lexruntimeservice/api_op_DeleteSession.go index d03365903ed..007381ab2f4 100644 --- a/service/lexruntimeservice/api_op_DeleteSession.go +++ b/service/lexruntimeservice/api_op_DeleteSession.go @@ -56,20 +56,20 @@ func (c *Client) DeleteSession(ctx context.Context, params *DeleteSessionInput, type DeleteSessionInput struct { - // The identifier of the user associated with the session data. + // The alias in use for the bot that contains the session data. // // This member is required. - UserId *string + BotAlias *string // The name of the bot that contains the session data. // // This member is required. BotName *string - // The alias in use for the bot that contains the session data. + // The identifier of the user associated with the session data. // // This member is required. - BotAlias *string + UserId *string } type DeleteSessionOutput struct { @@ -77,15 +77,15 @@ type DeleteSessionOutput struct { // The alias in use for the bot associated with the session data. BotAlias *string + // The name of the bot associated with the session data. + BotName *string + // The unique identifier for the session. SessionId *string // The ID of the client application user. UserId *string - // The name of the bot associated with the session data. - BotName *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lexruntimeservice/api_op_GetSession.go b/service/lexruntimeservice/api_op_GetSession.go index 858659a3496..4d354670135 100644 --- a/service/lexruntimeservice/api_op_GetSession.go +++ b/service/lexruntimeservice/api_op_GetSession.go @@ -57,26 +57,26 @@ func (c *Client) GetSession(ctx context.Context, params *GetSessionInput, optFns type GetSessionInput struct { - // The name of the bot that contains the session data. + // The alias in use for the bot that contains the session data. // // This member is required. - BotName *string - - // A string used to filter the intents returned in the recentIntentSummaryView - // structure. When you specify a filter, only intents with their checkpointLabel - // field set to that string are returned. - CheckpointLabelFilter *string + BotAlias *string - // The alias in use for the bot that contains the session data. + // The name of the bot that contains the session data. // // This member is required. - BotAlias *string + BotName *string // The ID of the client application user. Amazon Lex uses this to identify a user's // conversation with your bot. // // This member is required. UserId *string + + // A string used to filter the intents returned in the recentIntentSummaryView + // structure. When you specify a filter, only intents with their checkpointLabel + // field set to that string are returned. + CheckpointLabelFilter *string } type GetSessionOutput struct { @@ -84,9 +84,6 @@ type GetSessionOutput struct { // Describes the current state of the bot. DialogAction *types.DialogAction - // A unique identifier for the session. - SessionId *string - // An array of information about the intents used in the session. The array can // contain a maximum of three summaries. If more than three intents are used in the // session, the recentIntentSummaryView operation contains information about the @@ -99,6 +96,9 @@ type GetSessionOutput struct { // application. SessionAttributes map[string]*string + // A unique identifier for the session. + SessionId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lexruntimeservice/api_op_PostContent.go b/service/lexruntimeservice/api_op_PostContent.go index d173cb933dd..4401d2bcb31 100644 --- a/service/lexruntimeservice/api_op_PostContent.go +++ b/service/lexruntimeservice/api_op_PostContent.go @@ -114,66 +114,15 @@ func (c *Client) PostContent(ctx context.Context, params *PostContentInput, optF type PostContentInput struct { - // User input in PCM or Opus audio format or text format as described in the - // Content-Type HTTP header. You can stream audio data to Amazon Lex or you can - // create a local buffer that captures all of the audio data before sending. In - // general, you get better performance if you stream audio data rather than - // buffering the data locally. + // Alias of the Amazon Lex bot. // // This member is required. - InputStream io.Reader - - // You pass this value as the x-amz-lex-session-attributes HTTP header. - // Application-specific information passed between Amazon Lex and a client - // application. The value must be a JSON serialized and base64 encoded map with - // string keys and values. The total size of the sessionAttributes and - // requestAttributes headers is limited to 12 KB. For more information, see Setting - // Session Attributes - // (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs). - // This value conforms to the media type: application/json - SessionAttributes *string - - // You pass this value as the x-amz-lex-request-attributes HTTP header. - // Request-specific information passed between Amazon Lex and a client application. - // The value must be a JSON serialized and base64 encoded map with string keys and - // values. The total size of the requestAttributes and sessionAttributes headers is - // limited to 12 KB. The namespace x-amz-lex: is reserved for special attributes. - // Don't create any request attributes with the prefix x-amz-lex:. For more - // information, see Setting Request Attributes - // (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs). - // This value conforms to the media type: application/json - RequestAttributes *string + BotAlias *string - // You pass this value as the Accept HTTP header. The message Amazon Lex returns in - // the response can be either text or speech based on the Accept HTTP header value - // in the request. - // - // * If the value is text/plain; charset=utf-8, Amazon Lex - // returns text in the response. - // - // * If the value begins with audio/, Amazon Lex - // returns speech in the response. Amazon Lex uses Amazon Polly to generate the - // speech (using the configuration you specified in the Accept header). For - // example, if you specify audio/mpeg as the value, Amazon Lex returns speech in - // the MPEG format. - // - // * If the value is audio/pcm, the speech returned is - // audio/pcm in 16-bit, little endian format. - // - // * The following are the accepted - // values: - // - // * audio/mpeg - // - // * audio/ogg - // - // * audio/pcm - // - // - // * text/plain; charset=utf-8 + // Name of the Amazon Lex bot. // - // * audio/* (defaults to mpeg) - Accept *string + // This member is required. + BotName *string // You pass this value as the Content-Type HTTP header. Indicates the audio format // or text. The header value must start with one of the following prefixes: @@ -204,6 +153,15 @@ type PostContentInput struct { // This member is required. ContentType *string + // User input in PCM or Opus audio format or text format as described in the + // Content-Type HTTP header. You can stream audio data to Amazon Lex or you can + // create a local buffer that captures all of the audio data before sending. In + // general, you get better performance if you stream audio data rather than + // buffering the data locally. + // + // This member is required. + InputStream io.Reader + // The ID of the client application user. Amazon Lex uses this to identify a user's // conversation with your bot. At runtime, each request must contain the userID // field. To decide the user ID to use for your application, consider the following @@ -230,45 +188,60 @@ type PostContentInput struct { // This member is required. UserId *string - // Name of the Amazon Lex bot. + // You pass this value as the Accept HTTP header. The message Amazon Lex returns in + // the response can be either text or speech based on the Accept HTTP header value + // in the request. // - // This member is required. - BotName *string - - // Alias of the Amazon Lex bot. + // * If the value is text/plain; charset=utf-8, Amazon Lex + // returns text in the response. // - // This member is required. - BotAlias *string -} - -type PostContentOutput struct { + // * If the value begins with audio/, Amazon Lex + // returns speech in the response. Amazon Lex uses Amazon Polly to generate the + // speech (using the configuration you specified in the Accept header). For + // example, if you specify audio/mpeg as the value, Amazon Lex returns speech in + // the MPEG format. + // + // * If the value is audio/pcm, the speech returned is + // audio/pcm in 16-bit, little endian format. + // + // * The following are the accepted + // values: + // + // * audio/mpeg + // + // * audio/ogg + // + // * audio/pcm + // + // + // * text/plain; charset=utf-8 + // + // * audio/* (defaults to mpeg) + Accept *string - // The message to convey to the user. The message can come from the bot's - // configuration or from a Lambda function. If the intent is not configured with a - // Lambda function, or if the Lambda function returned Delegate as the - // dialogAction.type in its response, Amazon Lex decides on the next course of - // action and selects an appropriate message from the bot's configuration based on - // the current interaction context. For example, if Amazon Lex isn't able to - // understand user input, it uses a clarification prompt message. When you create - // an intent you can assign messages to groups. When messages are assigned to - // groups Amazon Lex returns one message from each group in the response. The - // message field is an escaped JSON string containing the messages. For more - // information about the structure of the JSON string returned, see - // msg-prompts-formats (). If the Lambda function returns a message, Amazon Lex - // passes it to the client in its response. - Message *string + // You pass this value as the x-amz-lex-request-attributes HTTP header. + // Request-specific information passed between Amazon Lex and a client application. + // The value must be a JSON serialized and base64 encoded map with string keys and + // values. The total size of the requestAttributes and sessionAttributes headers is + // limited to 12 KB. The namespace x-amz-lex: is reserved for special attributes. + // Don't create any request attributes with the prefix x-amz-lex:. For more + // information, see Setting Request Attributes + // (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs). + // This value conforms to the media type: application/json + RequestAttributes *string - // Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the - // user input during the conversation. The field is base-64 encoded. Amazon Lex - // creates a resolution list containing likely values for a slot. The value that it - // returns is determined by the valueSelectionStrategy selected when the slot type - // was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the - // value provided by the user is returned, if the user value is similar to the slot - // values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns - // the first value in the resolution list or, if there is no resolution list, null. - // If you don't specify a valueSelectionStrategy, the default is ORIGINAL_VALUE. + // You pass this value as the x-amz-lex-session-attributes HTTP header. + // Application-specific information passed between Amazon Lex and a client + // application. The value must be a JSON serialized and base64 encoded map with + // string keys and values. The total size of the sessionAttributes and + // requestAttributes headers is limited to 12 KB. For more information, see Setting + // Session Attributes + // (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs). // This value conforms to the media type: application/json - Slots *string + SessionAttributes *string +} + +type PostContentOutput struct { // The prompt (or statement) to convey to the user. This is based on the bot // configuration and context. For example, if Amazon Lex did not understand the @@ -279,6 +252,9 @@ type PostContentOutput struct { // Then Amazon Lex sends that message in the response. AudioStream io.ReadCloser + // Content type as specified in the Accept HTTP header in the request. + ContentType *string + // Identifies the current state of the user interaction. Amazon Lex returns one of // the following values as dialogState. The client can optionally use this // information to customize the user interface. @@ -317,9 +293,6 @@ type PostContentOutput struct { // specific information), or if the Lambda function fails to fulfill the intent. DialogState types.DialogState - // Current user intent that Amazon Lex is aware of. - IntentName *string - // The text used to process the request. If the input was an audio stream, the // inputTranscript field contains the text extracted from the audio stream. This is // the text that is actually processed to recognize intents and slot values. You @@ -327,6 +300,24 @@ type PostContentOutput struct { // audio that you send. InputTranscript *string + // Current user intent that Amazon Lex is aware of. + IntentName *string + + // The message to convey to the user. The message can come from the bot's + // configuration or from a Lambda function. If the intent is not configured with a + // Lambda function, or if the Lambda function returned Delegate as the + // dialogAction.type in its response, Amazon Lex decides on the next course of + // action and selects an appropriate message from the bot's configuration based on + // the current interaction context. For example, if Amazon Lex isn't able to + // understand user input, it uses a clarification prompt message. When you create + // an intent you can assign messages to groups. When messages are assigned to + // groups Amazon Lex returns one message from each group in the response. The + // message field is an escaped JSON string containing the messages. For more + // information about the structure of the JSON string returned, see + // msg-prompts-formats (). If the Lambda function returns a message, Amazon Lex + // passes it to the client in its response. + Message *string + // The format of the response message. One of the following values: // // * @@ -343,25 +334,34 @@ type PostContentOutput struct { // messages were assigned to when the intent was created. MessageFormat types.MessageFormatType - // Content type as specified in the Accept HTTP header in the request. - ContentType *string - - // The unique identifier for the session. - SessionId *string + // The sentiment expressed in and utterance. When the bot is configured to send + // utterances to Amazon Comprehend for sentiment analysis, this field contains the + // result of the analysis. + SentimentResponse *string // Map of key/value pairs representing the session-specific context information. // This value conforms to the media type: application/json SessionAttributes *string - // The sentiment expressed in and utterance. When the bot is configured to send - // utterances to Amazon Comprehend for sentiment analysis, this field contains the - // result of the analysis. - SentimentResponse *string + // The unique identifier for the session. + SessionId *string // If the dialogState value is ElicitSlot, returns the name of the slot for which // Amazon Lex is eliciting a value. SlotToElicit *string + // Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the + // user input during the conversation. The field is base-64 encoded. Amazon Lex + // creates a resolution list containing likely values for a slot. The value that it + // returns is determined by the valueSelectionStrategy selected when the slot type + // was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the + // value provided by the user is returned, if the user value is similar to the slot + // values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns + // the first value in the resolution list or, if there is no resolution list, null. + // If you don't specify a valueSelectionStrategy, the default is ORIGINAL_VALUE. + // This value conforms to the media type: application/json + Slots *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lexruntimeservice/api_op_PostText.go b/service/lexruntimeservice/api_op_PostText.go index dc4e0b433a4..3b64cc5a369 100644 --- a/service/lexruntimeservice/api_op_PostText.go +++ b/service/lexruntimeservice/api_op_PostText.go @@ -99,6 +99,21 @@ func (c *Client) PostText(ctx context.Context, params *PostTextInput, optFns ... type PostTextInput struct { + // The alias of the Amazon Lex bot. + // + // This member is required. + BotAlias *string + + // The name of the Amazon Lex bot. + // + // This member is required. + BotName *string + + // The text that the user entered (Amazon Lex interprets this text). + // + // This member is required. + InputText *string + // The ID of the client application user. Amazon Lex uses this to identify a user's // conversation with your bot. At runtime, each request must contain the userID // field. To decide the user ID to use for your application, consider the following @@ -125,98 +140,21 @@ type PostTextInput struct { // This member is required. UserId *string - // The text that the user entered (Amazon Lex interprets this text). - // - // This member is required. - InputText *string - - // The name of the Amazon Lex bot. - // - // This member is required. - BotName *string - - // The alias of the Amazon Lex bot. - // - // This member is required. - BotAlias *string - - // Application-specific information passed between Amazon Lex and a client - // application. For more information, see Setting Session Attributes - // (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs). - SessionAttributes map[string]*string - // Request-specific information passed between Amazon Lex and a client application. // The namespace x-amz-lex: is reserved for special attributes. Don't create any // request attributes with the prefix x-amz-lex:. For more information, see Setting // Request Attributes // (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs). RequestAttributes map[string]*string + + // Application-specific information passed between Amazon Lex and a client + // application. For more information, see Setting Session Attributes + // (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs). + SessionAttributes map[string]*string } type PostTextOutput struct { - // The message to convey to the user. The message can come from the bot's - // configuration or from a Lambda function. If the intent is not configured with a - // Lambda function, or if the Lambda function returned Delegate as the - // dialogAction.type its response, Amazon Lex decides on the next course of action - // and selects an appropriate message from the bot's configuration based on the - // current interaction context. For example, if Amazon Lex isn't able to understand - // user input, it uses a clarification prompt message. When you create an intent - // you can assign messages to groups. When messages are assigned to groups Amazon - // Lex returns one message from each group in the response. The message field is an - // escaped JSON string containing the messages. For more information about the - // structure of the JSON string returned, see msg-prompts-formats (). If the Lambda - // function returns a message, Amazon Lex passes it to the client in its response. - Message *string - - // The intent slots that Amazon Lex detected from the user input in the - // conversation. Amazon Lex creates a resolution list containing likely values for - // a slot. The value that it returns is determined by the valueSelectionStrategy - // selected when the slot type was created or updated. If valueSelectionStrategy is - // set to ORIGINAL_VALUE, the value provided by the user is returned, if the user - // value is similar to the slot values. If valueSelectionStrategy is set to - // TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if - // there is no resolution list, null. If you don't specify a - // valueSelectionStrategy, the default is ORIGINAL_VALUE. - Slots map[string]*string - - // Represents the options that the user has to respond to the current prompt. - // Response Card can come from the bot configuration (in the Amazon Lex console, - // choose the settings button next to a slot) or from a code hook (Lambda - // function). - ResponseCard *types.ResponseCard - - // The sentiment expressed in and utterance. When the bot is configured to send - // utterances to Amazon Comprehend for sentiment analysis, this field contains the - // result of the analysis. - SentimentResponse *types.SentimentResponse - - // If the dialogState value is ElicitSlot, returns the name of the slot for which - // Amazon Lex is eliciting a value. - SlotToElicit *string - - // The format of the response message. One of the following values: - // - // * - // PlainText - The message contains plain UTF-8 text. - // - // * CustomPayload - The - // message is a custom format defined by the Lambda function. - // - // * SSML - The - // message contains text formatted for voice output. - // - // * Composite - The message - // contains an escaped JSON object containing one or more messages from the groups - // that messages were assigned to when the intent was created. - MessageFormat types.MessageFormatType - - // A unique identifier for the session. - SessionId *string - - // A map of key-value pairs representing the session-specific context information. - SessionAttributes map[string]*string - // Identifies the current state of the user interaction. Amazon Lex returns one of // the following values as dialogState. The client can optionally use this // information to customize the user interface. @@ -256,6 +194,68 @@ type PostTextOutput struct { // The current user intent that Amazon Lex is aware of. IntentName *string + // The message to convey to the user. The message can come from the bot's + // configuration or from a Lambda function. If the intent is not configured with a + // Lambda function, or if the Lambda function returned Delegate as the + // dialogAction.type its response, Amazon Lex decides on the next course of action + // and selects an appropriate message from the bot's configuration based on the + // current interaction context. For example, if Amazon Lex isn't able to understand + // user input, it uses a clarification prompt message. When you create an intent + // you can assign messages to groups. When messages are assigned to groups Amazon + // Lex returns one message from each group in the response. The message field is an + // escaped JSON string containing the messages. For more information about the + // structure of the JSON string returned, see msg-prompts-formats (). If the Lambda + // function returns a message, Amazon Lex passes it to the client in its response. + Message *string + + // The format of the response message. One of the following values: + // + // * + // PlainText - The message contains plain UTF-8 text. + // + // * CustomPayload - The + // message is a custom format defined by the Lambda function. + // + // * SSML - The + // message contains text formatted for voice output. + // + // * Composite - The message + // contains an escaped JSON object containing one or more messages from the groups + // that messages were assigned to when the intent was created. + MessageFormat types.MessageFormatType + + // Represents the options that the user has to respond to the current prompt. + // Response Card can come from the bot configuration (in the Amazon Lex console, + // choose the settings button next to a slot) or from a code hook (Lambda + // function). + ResponseCard *types.ResponseCard + + // The sentiment expressed in and utterance. When the bot is configured to send + // utterances to Amazon Comprehend for sentiment analysis, this field contains the + // result of the analysis. + SentimentResponse *types.SentimentResponse + + // A map of key-value pairs representing the session-specific context information. + SessionAttributes map[string]*string + + // A unique identifier for the session. + SessionId *string + + // If the dialogState value is ElicitSlot, returns the name of the slot for which + // Amazon Lex is eliciting a value. + SlotToElicit *string + + // The intent slots that Amazon Lex detected from the user input in the + // conversation. Amazon Lex creates a resolution list containing likely values for + // a slot. The value that it returns is determined by the valueSelectionStrategy + // selected when the slot type was created or updated. If valueSelectionStrategy is + // set to ORIGINAL_VALUE, the value provided by the user is returned, if the user + // value is similar to the slot values. If valueSelectionStrategy is set to + // TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if + // there is no resolution list, null. If you don't specify a + // valueSelectionStrategy, the default is ORIGINAL_VALUE. + Slots map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lexruntimeservice/api_op_PutSession.go b/service/lexruntimeservice/api_op_PutSession.go index 16cd2e2665a..d8e6079a269 100644 --- a/service/lexruntimeservice/api_op_PutSession.go +++ b/service/lexruntimeservice/api_op_PutSession.go @@ -60,45 +60,21 @@ func (c *Client) PutSession(ctx context.Context, params *PutSessionInput, optFns type PutSessionInput struct { - // The ID of the client application user. Amazon Lex uses this to identify a user's - // conversation with your bot. + // The alias in use for the bot that contains the session data. // // This member is required. - UserId *string + BotAlias *string // The name of the bot that contains the session data. // // This member is required. BotName *string - // The alias in use for the bot that contains the session data. + // The ID of the client application user. Amazon Lex uses this to identify a user's + // conversation with your bot. // // This member is required. - BotAlias *string - - // Sets the next action that the bot should take to fulfill the conversation. - DialogAction *types.DialogAction - - // A summary of the recent intents for the bot. You can use the intent summary view - // to set a checkpoint label on an intent and modify attributes of intents. You can - // also use it to remove or add intent summary objects to the list. An intent that - // you modify or add to the list must make sense for the bot. For example, the - // intent name must be valid for the bot. You must provide valid values for: - // - // * - // intentName - // - // * slot names - // - // * slotToElict - // - // If you send the - // recentIntentSummaryView parameter in a PutSession request, the contents of the - // new summary view replaces the old summary view. For example, if a GetSession - // request returns three intents in the summary view and you call PutSession with - // one intent in the summary view, the next call to GetSession will only return one - // intent. - RecentIntentSummaryView []*types.IntentSummary + UserId *string // The message that Amazon Lex returns in the response can be either text or speech // based depending on the value of this field. @@ -130,51 +106,43 @@ type PutSessionInput struct { // * text/plain; charset=utf-8 Accept *string - // Map of key/value pairs representing the session-specific context information. It - // contains application information passed between Amazon Lex and a client - // application. - SessionAttributes map[string]*string -} - -type PutSessionOutput struct { - - // Map of zero or more intent slots Amazon Lex detected from the user input during - // the conversation. Amazon Lex creates a resolution list containing likely values - // for a slot. The value that it returns is determined by the - // valueSelectionStrategy selected when the slot type was created or updated. If - // valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user - // is returned, if the user value is similar to the slot values. If - // valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first - // value in the resolution list or, if there is no resolution list, null. If you - // don't specify a valueSelectionStrategy the default is ORIGINAL_VALUE. - // This value conforms to the media type: application/json - Slots *string + // Sets the next action that the bot should take to fulfill the conversation. + DialogAction *types.DialogAction - // The format of the response message. One of the following values: + // A summary of the recent intents for the bot. You can use the intent summary view + // to set a checkpoint label on an intent and modify attributes of intents. You can + // also use it to remove or add intent summary objects to the list. An intent that + // you modify or add to the list must make sense for the bot. For example, the + // intent name must be valid for the bot. You must provide valid values for: // // * - // PlainText - The message contains plain UTF-8 text. + // intentName // - // * CustomPayload - The - // message is a custom format for the client. + // * slot names // - // * SSML - The message contains - // text formatted for voice output. + // * slotToElict // - // * Composite - The message contains an - // escaped JSON object containing one or more messages from the groups that - // messages were assigned to when the intent was created. - MessageFormat types.MessageFormatType + // If you send the + // recentIntentSummaryView parameter in a PutSession request, the contents of the + // new summary view replaces the old summary view. For example, if a GetSession + // request returns three intents in the summary view and you call PutSession with + // one intent in the summary view, the next call to GetSession will only return one + // intent. + RecentIntentSummaryView []*types.IntentSummary - // The name of the current intent. - IntentName *string + // Map of key/value pairs representing the session-specific context information. It + // contains application information passed between Amazon Lex and a client + // application. + SessionAttributes map[string]*string +} - // A unique identifier for the session. - SessionId *string +type PutSessionOutput struct { - // Map of key/value pairs representing session-specific context information. - // This value conforms to the media type: application/json - SessionAttributes *string + // The audio version of the message to convey to the user. + AudioStream io.ReadCloser + + // Content type as specified in the Accept HTTP header in the request. + ContentType *string // * ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm // the intent before fulfilling an intent. @@ -197,19 +165,51 @@ type PutSessionOutput struct { // ReadyForFulfillment - Conveys that the client has to fulfill the intent. DialogState types.DialogState - // The audio version of the message to convey to the user. - AudioStream io.ReadCloser + // The name of the current intent. + IntentName *string // The next message that should be presented to the user. Message *string - // Content type as specified in the Accept HTTP header in the request. - ContentType *string + // The format of the response message. One of the following values: + // + // * + // PlainText - The message contains plain UTF-8 text. + // + // * CustomPayload - The + // message is a custom format for the client. + // + // * SSML - The message contains + // text formatted for voice output. + // + // * Composite - The message contains an + // escaped JSON object containing one or more messages from the groups that + // messages were assigned to when the intent was created. + MessageFormat types.MessageFormatType + + // Map of key/value pairs representing session-specific context information. + // This value conforms to the media type: application/json + SessionAttributes *string + + // A unique identifier for the session. + SessionId *string // If the dialogState is ElicitSlot, returns the name of the slot for which Amazon // Lex is eliciting a value. SlotToElicit *string + // Map of zero or more intent slots Amazon Lex detected from the user input during + // the conversation. Amazon Lex creates a resolution list containing likely values + // for a slot. The value that it returns is determined by the + // valueSelectionStrategy selected when the slot type was created or updated. If + // valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user + // is returned, if the user value is similar to the slot values. If + // valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first + // value in the resolution list or, if there is no resolution list, null. If you + // don't specify a valueSelectionStrategy the default is ORIGINAL_VALUE. + // This value conforms to the media type: application/json + Slots *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lexruntimeservice/go.mod b/service/lexruntimeservice/go.mod index 6613a364cc7..5ae13a1b034 100644 --- a/service/lexruntimeservice/go.mod +++ b/service/lexruntimeservice/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/lexruntimeservice go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/lexruntimeservice/types/types.go b/service/lexruntimeservice/types/types.go index 5fefff57a7a..26453253565 100644 --- a/service/lexruntimeservice/types/types.go +++ b/service/lexruntimeservice/types/types.go @@ -5,17 +5,17 @@ package types // Represents an option to be shown on the client platform (Facebook, Slack, etc.) type Button struct { + // Text that is visible to the user on the button. + // + // This member is required. + Text *string + // The value sent to Amazon Lex when a user chooses the button. For example, // consider button text "NYC." When the user chooses the button, the value sent can // be "New York City." // // This member is required. Value *string - - // Text that is visible to the user on the button. - // - // This member is required. - Text *string } // Describes the next action that the bot should take in its interaction with the @@ -24,13 +24,6 @@ type Button struct { // return the interaction to a previous state. type DialogAction struct { - // The name of the slot that should be elicited from the user. - SlotToElicit *string - - // The message that should be shown to the user. If you don't specify a message, - // Amazon Lex will use the message configured for the intent. - Message *string - // The next action that the bot should take in its interaction with the user. The // possible values are: // @@ -68,12 +61,13 @@ type DialogAction struct { // application. FulfillmentState FulfillmentState - // Map of the slots that have been gathered and their values. - Slots map[string]*string - // The name of the intent. IntentName *string + // The message that should be shown to the user. If you don't specify a message, + // Amazon Lex will use the message configured for the intent. + Message *string + // * PlainText - The message contains plain UTF-8 text. // // * CustomPayload - The @@ -87,26 +81,32 @@ type DialogAction struct { // Message Groups // (https://docs.aws.amazon.com/lex/latest/dg/howitworks-manage-prompts.html). MessageFormat MessageFormatType + + // The name of the slot that should be elicited from the user. + SlotToElicit *string + + // Map of the slots that have been gathered and their values. + Slots map[string]*string } // Represents an option rendered to the user when a prompt is shown. It could be an // image, a button, a link, or text. type GenericAttachment struct { - // The title of the option. - Title *string - // The URL of an attachment to the response card. AttachmentLinkUrl *string - // The URL of an image that is displayed to the user. - ImageUrl *string - // The list of options to show to the user. Buttons []*Button + // The URL of an image that is displayed to the user. + ImageUrl *string + // The subtitle shown below the title. SubTitle *string + + // The title of the option. + Title *string } // Provides information about the state of an intent. You can use this information @@ -114,20 +114,6 @@ type GenericAttachment struct { // that you can return the intent to its previous state. type IntentSummary struct { - // The fulfillment state of the intent. The possible values are: - // - // * Failed - - // The Lambda function associated with the intent failed to fulfill the intent. - // - // - // * Fulfilled - The intent has fulfilled by the Lambda function associated with - // the intent. - // - // * ReadyForFulfillment - All of the information necessary for - // the intent is present and the intent ready to be fulfilled by the client - // application. - FulfillmentState FulfillmentState - // The next action that the bot should take in its interaction with the user. The // possible values are: // @@ -154,13 +140,6 @@ type IntentSummary struct { // those with only the specified label. CheckpointLabel *string - // The next slot to elicit from the user. If there is not slot to elicit, the field - // is blank. - SlotToElicit *string - - // Map of the slots that have been gathered and their values. - Slots map[string]*string - // The status of the intent after the user responds to the confirmation prompt. If // the user confirms the intent, Amazon Lex sets this field to Confirmed. If the // user denies the intent, Amazon Lex sets this value to Denied. The possible @@ -177,8 +156,29 @@ type IntentSummary struct { // user was prompted but did not confirm or deny the prompt. ConfirmationStatus ConfirmationStatus + // The fulfillment state of the intent. The possible values are: + // + // * Failed - + // The Lambda function associated with the intent failed to fulfill the intent. + // + // + // * Fulfilled - The intent has fulfilled by the Lambda function associated with + // the intent. + // + // * ReadyForFulfillment - All of the information necessary for + // the intent is present and the intent ready to be fulfilled by the client + // application. + FulfillmentState FulfillmentState + // The name of the intent. IntentName *string + + // The next slot to elicit from the user. If there is not slot to elicit, the field + // is blank. + SlotToElicit *string + + // Map of the slots that have been gathered and their values. + Slots map[string]*string } // If you configure a response card when creating your bots, Amazon Lex substitutes @@ -187,14 +187,14 @@ type IntentSummary struct { // fulfillmentActivity on an intent). type ResponseCard struct { - // The version of the response card format. - Version *string + // The content type of the response. + ContentType ContentType // An array of attachment objects representing options. GenericAttachments []*GenericAttachment - // The content type of the response. - ContentType ContentType + // The version of the response card format. + Version *string } // The sentiment expressed in an utterance. When the bot is configured to send @@ -202,9 +202,9 @@ type ResponseCard struct { // contains the result of the analysis. type SentimentResponse struct { - // The likelihood that the sentiment was correctly inferred. - SentimentScore *string - // The inferred sentiment that Amazon Comprehend has the highest confidence in. SentimentLabel *string + + // The likelihood that the sentiment was correctly inferred. + SentimentScore *string } diff --git a/service/licensemanager/api_op_CreateLicenseConfiguration.go b/service/licensemanager/api_op_CreateLicenseConfiguration.go index 0c8064e698b..0c213f32dc7 100644 --- a/service/licensemanager/api_op_CreateLicenseConfiguration.go +++ b/service/licensemanager/api_op_CreateLicenseConfiguration.go @@ -62,6 +62,22 @@ func (c *Client) CreateLicenseConfiguration(ctx context.Context, params *CreateL type CreateLicenseConfigurationInput struct { + // Dimension used to track the license inventory. + // + // This member is required. + LicenseCountingType types.LicenseCountingType + + // Name of the license configuration. + // + // This member is required. + Name *string + + // Description of the license configuration. + Description *string + + // Number of licenses managed by the license configuration. + LicenseCount *int64 + // Indicates whether hard or soft license enforcement is used. Exceeding a hard // limit blocks the launch of new instances. LicenseCountHardLimit *bool @@ -86,22 +102,6 @@ type CreateLicenseConfigurationInput struct { // Product information. ProductInformationList []*types.ProductInformation - // Description of the license configuration. - Description *string - - // Number of licenses managed by the license configuration. - LicenseCount *int64 - - // Name of the license configuration. - // - // This member is required. - Name *string - - // Dimension used to track the license inventory. - // - // This member is required. - LicenseCountingType types.LicenseCountingType - // Tags to add to the license configuration. Tags []*types.Tag } diff --git a/service/licensemanager/api_op_GetLicenseConfiguration.go b/service/licensemanager/api_op_GetLicenseConfiguration.go index 98b42c45981..8a7ca3368f2 100644 --- a/service/licensemanager/api_op_GetLicenseConfiguration.go +++ b/service/licensemanager/api_op_GetLicenseConfiguration.go @@ -65,53 +65,53 @@ type GetLicenseConfigurationInput struct { type GetLicenseConfigurationOutput struct { - // Summaries of the managed resources. - ManagedResourceSummaryList []*types.ManagedResourceSummary + // Automated discovery information. + AutomatedDiscoveryInformation *types.AutomatedDiscoveryInformation - // Product information. - ProductInformationList []*types.ProductInformation + // Summaries of the licenses consumed by resources. + ConsumedLicenseSummaryList []*types.ConsumedLicenseSummary + + // Number of licenses assigned to resources. + ConsumedLicenses *int64 + + // Description of the license configuration. + Description *string + + // Amazon Resource Name (ARN) of the license configuration. + LicenseConfigurationArn *string + + // Unique ID for the license configuration. + LicenseConfigurationId *string // Number of available licenses. LicenseCount *int64 - // Tags for the license configuration. - Tags []*types.Tag + // Sets the number of available licenses as a hard limit. + LicenseCountHardLimit *bool // Dimension on which the licenses are counted. LicenseCountingType types.LicenseCountingType - // Account ID of the owner of the license configuration. - OwnerAccountId *string + // License rules. + LicenseRules []*string + + // Summaries of the managed resources. + ManagedResourceSummaryList []*types.ManagedResourceSummary // Name of the license configuration. Name *string - // Amazon Resource Name (ARN) of the license configuration. - LicenseConfigurationArn *string - - // Unique ID for the license configuration. - LicenseConfigurationId *string + // Account ID of the owner of the license configuration. + OwnerAccountId *string - // Summaries of the licenses consumed by resources. - ConsumedLicenseSummaryList []*types.ConsumedLicenseSummary + // Product information. + ProductInformationList []*types.ProductInformation // License configuration status. Status *string - // Description of the license configuration. - Description *string - - // Number of licenses assigned to resources. - ConsumedLicenses *int64 - - // Automated discovery information. - AutomatedDiscoveryInformation *types.AutomatedDiscoveryInformation - - // License rules. - LicenseRules []*string - - // Sets the number of available licenses as a hard limit. - LicenseCountHardLimit *bool + // Tags for the license configuration. + Tags []*types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/licensemanager/api_op_GetServiceSettings.go b/service/licensemanager/api_op_GetServiceSettings.go index 6cab417d999..89126b4cd97 100644 --- a/service/licensemanager/api_op_GetServiceSettings.go +++ b/service/licensemanager/api_op_GetServiceSettings.go @@ -59,6 +59,13 @@ type GetServiceSettingsInput struct { type GetServiceSettingsOutput struct { + // Indicates whether cross-account discovery has been enabled. + EnableCrossAccountsDiscovery *bool + + // Amazon Resource Name (ARN) of the AWS resource share. The License Manager master + // account will provide member accounts with access to this share. + LicenseManagerResourceShareArn *string + // Indicates whether AWS Organizations has been integrated with License Manager for // cross-account discovery. OrganizationConfiguration *types.OrganizationConfiguration @@ -67,16 +74,9 @@ type GetServiceSettingsOutput struct { // data, and so on. S3BucketArn *string - // Amazon Resource Name (ARN) of the AWS resource share. The License Manager master - // account will provide member accounts with access to this share. - LicenseManagerResourceShareArn *string - // SNS topic configured to receive notifications from License Manager. SnsTopicArn *string - // Indicates whether cross-account discovery has been enabled. - EnableCrossAccountsDiscovery *bool - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/licensemanager/api_op_ListAssociationsForLicenseConfiguration.go b/service/licensemanager/api_op_ListAssociationsForLicenseConfiguration.go index 8d6fc8bef0f..f1ff6107efc 100644 --- a/service/licensemanager/api_op_ListAssociationsForLicenseConfiguration.go +++ b/service/licensemanager/api_op_ListAssociationsForLicenseConfiguration.go @@ -65,21 +65,21 @@ type ListAssociationsForLicenseConfigurationInput struct { // This member is required. LicenseConfigurationArn *string - // Token for the next set of results. - NextToken *string - // Maximum number of results to return in a single call. MaxResults *int32 -} - -type ListAssociationsForLicenseConfigurationOutput struct { // Token for the next set of results. NextToken *string +} + +type ListAssociationsForLicenseConfigurationOutput struct { // Information about the associations for the license configuration. LicenseConfigurationAssociations []*types.LicenseConfigurationAssociation + // Token for the next set of results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/licensemanager/api_op_ListFailuresForLicenseConfigurationOperations.go b/service/licensemanager/api_op_ListFailuresForLicenseConfigurationOperations.go index daea4ccdb7e..0e455702605 100644 --- a/service/licensemanager/api_op_ListFailuresForLicenseConfigurationOperations.go +++ b/service/licensemanager/api_op_ListFailuresForLicenseConfigurationOperations.go @@ -57,16 +57,16 @@ func (c *Client) ListFailuresForLicenseConfigurationOperations(ctx context.Conte type ListFailuresForLicenseConfigurationOperationsInput struct { - // Token for the next set of results. - NextToken *string - - // Maximum number of results to return in a single call. - MaxResults *int32 - // Amazon Resource Name of the license configuration. // // This member is required. LicenseConfigurationArn *string + + // Maximum number of results to return in a single call. + MaxResults *int32 + + // Token for the next set of results. + NextToken *string } type ListFailuresForLicenseConfigurationOperationsOutput struct { diff --git a/service/licensemanager/api_op_ListLicenseConfigurations.go b/service/licensemanager/api_op_ListLicenseConfigurations.go index 74e2a6cf38e..a581be68ccb 100644 --- a/service/licensemanager/api_op_ListLicenseConfigurations.go +++ b/service/licensemanager/api_op_ListLicenseConfigurations.go @@ -56,9 +56,6 @@ func (c *Client) ListLicenseConfigurations(ctx context.Context, params *ListLice type ListLicenseConfigurationsInput struct { - // Maximum number of results to return in a single call. - MaxResults *int32 - // Filters to scope the results. The following filters and logical operators are // supported: // @@ -77,18 +74,21 @@ type ListLicenseConfigurationsInput struct { // Amazon Resource Names (ARN) of the license configurations. LicenseConfigurationArns []*string + // Maximum number of results to return in a single call. + MaxResults *int32 + // Token for the next set of results. NextToken *string } type ListLicenseConfigurationsOutput struct { - // Token for the next set of results. - NextToken *string - // Information about the license configurations. LicenseConfigurations []*types.LicenseConfiguration + // Token for the next set of results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/licensemanager/api_op_ListLicenseSpecificationsForResource.go b/service/licensemanager/api_op_ListLicenseSpecificationsForResource.go index 675d5445218..7703708d53f 100644 --- a/service/licensemanager/api_op_ListLicenseSpecificationsForResource.go +++ b/service/licensemanager/api_op_ListLicenseSpecificationsForResource.go @@ -72,12 +72,12 @@ type ListLicenseSpecificationsForResourceInput struct { type ListLicenseSpecificationsForResourceOutput struct { - // Token for the next set of results. - NextToken *string - // License configurations associated with a resource. LicenseSpecifications []*types.LicenseSpecification + // Token for the next set of results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/licensemanager/api_op_ListResourceInventory.go b/service/licensemanager/api_op_ListResourceInventory.go index a792e2a3164..485a29d0e9e 100644 --- a/service/licensemanager/api_op_ListResourceInventory.go +++ b/service/licensemanager/api_op_ListResourceInventory.go @@ -57,12 +57,6 @@ func (c *Client) ListResourceInventory(ctx context.Context, params *ListResource type ListResourceInventoryInput struct { - // Maximum number of results to return in a single call. - MaxResults *int32 - - // Token for the next set of results. - NextToken *string - // Filters to scope the results. The following filters and logical operators are // supported: // @@ -83,16 +77,22 @@ type ListResourceInventoryInput struct { // * resource_id - // The ID of the resource. Logical operators are EQUALS | NOT_EQUALS. Filters []*types.InventoryFilter + + // Maximum number of results to return in a single call. + MaxResults *int32 + + // Token for the next set of results. + NextToken *string } type ListResourceInventoryOutput struct { - // Information about the resources. - ResourceInventoryList []*types.ResourceInventory - // Token for the next set of results. NextToken *string + // Information about the resources. + ResourceInventoryList []*types.ResourceInventory + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/licensemanager/api_op_ListUsageForLicenseConfiguration.go b/service/licensemanager/api_op_ListUsageForLicenseConfiguration.go index 511127b2132..70a2da2261e 100644 --- a/service/licensemanager/api_op_ListUsageForLicenseConfiguration.go +++ b/service/licensemanager/api_op_ListUsageForLicenseConfiguration.go @@ -60,8 +60,10 @@ func (c *Client) ListUsageForLicenseConfiguration(ctx context.Context, params *L type ListUsageForLicenseConfigurationInput struct { - // Maximum number of results to return in a single call. - MaxResults *int32 + // Amazon Resource Name (ARN) of the license configuration. + // + // This member is required. + LicenseConfigurationArn *string // Filters to scope the results. The following filters and logical operators are // supported: @@ -77,23 +79,21 @@ type ListUsageForLicenseConfigurationInput struct { // the account that owns the resource. Logical operators are EQUALS | NOT_EQUALS. Filters []*types.Filter + // Maximum number of results to return in a single call. + MaxResults *int32 + // Token for the next set of results. NextToken *string - - // Amazon Resource Name (ARN) of the license configuration. - // - // This member is required. - LicenseConfigurationArn *string } type ListUsageForLicenseConfigurationOutput struct { - // Token for the next set of results. - NextToken *string - // Information about the license configurations. LicenseConfigurationUsageList []*types.LicenseConfigurationUsage + // Token for the next set of results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/licensemanager/api_op_TagResource.go b/service/licensemanager/api_op_TagResource.go index 9b09c2b50c0..ca2da3f21a0 100644 --- a/service/licensemanager/api_op_TagResource.go +++ b/service/licensemanager/api_op_TagResource.go @@ -57,15 +57,15 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // One or more tags. + // Amazon Resource Name (ARN) of the license configuration. // // This member is required. - Tags []*types.Tag + ResourceArn *string - // Amazon Resource Name (ARN) of the license configuration. + // One or more tags. // // This member is required. - ResourceArn *string + Tags []*types.Tag } type TagResourceOutput struct { diff --git a/service/licensemanager/api_op_UntagResource.go b/service/licensemanager/api_op_UntagResource.go index 6ab154b16a7..ada59049fd1 100644 --- a/service/licensemanager/api_op_UntagResource.go +++ b/service/licensemanager/api_op_UntagResource.go @@ -56,15 +56,15 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // Keys identifying the tags to remove. + // Amazon Resource Name (ARN) of the license configuration. // // This member is required. - TagKeys []*string + ResourceArn *string - // Amazon Resource Name (ARN) of the license configuration. + // Keys identifying the tags to remove. // // This member is required. - ResourceArn *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/licensemanager/api_op_UpdateLicenseConfiguration.go b/service/licensemanager/api_op_UpdateLicenseConfiguration.go index 6af897bc8af..90b7d3c09ee 100644 --- a/service/licensemanager/api_op_UpdateLicenseConfiguration.go +++ b/service/licensemanager/api_op_UpdateLicenseConfiguration.go @@ -63,31 +63,31 @@ func (c *Client) UpdateLicenseConfiguration(ctx context.Context, params *UpdateL type UpdateLicenseConfigurationInput struct { - // New hard limit of the number of available licenses. - LicenseCountHardLimit *bool - - // New product information. - ProductInformationList []*types.ProductInformation - - // New description of the license configuration. - Description *string - // Amazon Resource Name (ARN) of the license configuration. // // This member is required. LicenseConfigurationArn *string - // New license rules. - LicenseRules []*string + // New description of the license configuration. + Description *string + + // New status of the license configuration. + LicenseConfigurationStatus types.LicenseConfigurationStatus // New number of licenses managed by the license configuration. LicenseCount *int64 - // New status of the license configuration. - LicenseConfigurationStatus types.LicenseConfigurationStatus + // New hard limit of the number of available licenses. + LicenseCountHardLimit *bool + + // New license rules. + LicenseRules []*string // New name of the license configuration. Name *string + + // New product information. + ProductInformationList []*types.ProductInformation } type UpdateLicenseConfigurationOutput struct { diff --git a/service/licensemanager/api_op_UpdateLicenseSpecificationsForResource.go b/service/licensemanager/api_op_UpdateLicenseSpecificationsForResource.go index bade72aed60..01dff5c5986 100644 --- a/service/licensemanager/api_op_UpdateLicenseSpecificationsForResource.go +++ b/service/licensemanager/api_op_UpdateLicenseSpecificationsForResource.go @@ -61,14 +61,14 @@ func (c *Client) UpdateLicenseSpecificationsForResource(ctx context.Context, par type UpdateLicenseSpecificationsForResourceInput struct { - // ARNs of the license configurations to add. - AddLicenseSpecifications []*types.LicenseSpecification - // Amazon Resource Name (ARN) of the AWS resource. // // This member is required. ResourceArn *string + // ARNs of the license configurations to add. + AddLicenseSpecifications []*types.LicenseSpecification + // ARNs of the license configurations to remove. RemoveLicenseSpecifications []*types.LicenseSpecification } diff --git a/service/licensemanager/api_op_UpdateServiceSettings.go b/service/licensemanager/api_op_UpdateServiceSettings.go index c99a035c0f8..5c43f8b9489 100644 --- a/service/licensemanager/api_op_UpdateServiceSettings.go +++ b/service/licensemanager/api_op_UpdateServiceSettings.go @@ -57,19 +57,19 @@ func (c *Client) UpdateServiceSettings(ctx context.Context, params *UpdateServic type UpdateServiceSettingsInput struct { - // Amazon Resource Name (ARN) of the Amazon SNS topic used for License Manager - // alerts. - SnsTopicArn *string - - // Amazon Resource Name (ARN) of the Amazon S3 bucket where the License Manager - // information is stored. - S3BucketArn *string - // Activates cross-account discovery. EnableCrossAccountsDiscovery *bool // Enables integration with AWS Organizations for cross-account discovery. OrganizationConfiguration *types.OrganizationConfiguration + + // Amazon Resource Name (ARN) of the Amazon S3 bucket where the License Manager + // information is stored. + S3BucketArn *string + + // Amazon Resource Name (ARN) of the Amazon SNS topic used for License Manager + // alerts. + SnsTopicArn *string } type UpdateServiceSettingsOutput struct { diff --git a/service/licensemanager/go.mod b/service/licensemanager/go.mod index 8204123b248..ea28bbfaf53 100644 --- a/service/licensemanager/go.mod +++ b/service/licensemanager/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/licensemanager go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/licensemanager/types/types.go b/service/licensemanager/types/types.go index 85e142c1465..c64e494e320 100644 --- a/service/licensemanager/types/types.go +++ b/service/licensemanager/types/types.go @@ -16,11 +16,11 @@ type AutomatedDiscoveryInformation struct { // Details about license consumption. type ConsumedLicenseSummary struct { - // Resource type of the resource consuming a license. - ResourceType ResourceType - // Number of licenses consumed by the resource. ConsumedLicenses *int64 + + // Resource type of the resource consuming a license. + ResourceType ResourceType } // A filter name and value pair that is used to return more specific results from a @@ -38,18 +38,18 @@ type Filter struct { // An inventory filter. type InventoryFilter struct { - // Value of the filter. - Value *string + // Condition of the filter. + // + // This member is required. + Condition InventoryFilterCondition // Name of the filter. // // This member is required. Name *string - // Condition of the filter. - // - // This member is required. - Condition InventoryFilterCondition + // Value of the filter. + Value *string } // A license configuration is an abstraction of a customer license agreement that @@ -60,8 +60,14 @@ type InventoryFilter struct { // the number of licenses purchased and used. type LicenseConfiguration struct { - // Number of available licenses as a hard limit. - LicenseCountHardLimit *bool + // Automated discovery information. + AutomatedDiscoveryInformation *AutomatedDiscoveryInformation + + // Summaries for licenses consumed by various resources. + ConsumedLicenseSummaryList []*ConsumedLicenseSummary + + // Number of licenses consumed. + ConsumedLicenses *int64 // Description of the license configuration. Description *string @@ -69,38 +75,32 @@ type LicenseConfiguration struct { // Amazon Resource Name (ARN) of the license configuration. LicenseConfigurationArn *string - // Number of licenses consumed. - ConsumedLicenses *int64 - // Unique ID of the license configuration. LicenseConfigurationId *string - // Summaries for licenses consumed by various resources. - ConsumedLicenseSummaryList []*ConsumedLicenseSummary + // Number of licenses managed by the license configuration. + LicenseCount *int64 + + // Number of available licenses as a hard limit. + LicenseCountHardLimit *bool // Dimension to use to track the license inventory. LicenseCountingType LicenseCountingType - // Account ID of the license configuration's owner. - OwnerAccountId *string - - // Product information. - ProductInformationList []*ProductInformation - - // Name of the license configuration. - Name *string + // License rules. + LicenseRules []*string // Summaries for managed resources. ManagedResourceSummaryList []*ManagedResourceSummary - // License rules. - LicenseRules []*string + // Name of the license configuration. + Name *string - // Number of licenses managed by the license configuration. - LicenseCount *int64 + // Account ID of the license configuration's owner. + OwnerAccountId *string - // Automated discovery information. - AutomatedDiscoveryInformation *AutomatedDiscoveryInformation + // Product information. + ProductInformationList []*ProductInformation // Status of the license configuration. Status *string @@ -109,17 +109,17 @@ type LicenseConfiguration struct { // Describes an association with a license configuration. type LicenseConfigurationAssociation struct { - // ID of the AWS account that owns the resource consuming licenses. - ResourceOwnerId *string + // Time when the license configuration was associated with the resource. + AssociationTime *time.Time // Amazon Resource Name (ARN) of the resource. ResourceArn *string + // ID of the AWS account that owns the resource consuming licenses. + ResourceOwnerId *string + // Type of server resource. ResourceType ResourceType - - // Time when the license configuration was associated with the resource. - AssociationTime *time.Time } // Details about the usage of a resource associated with a license configuration. @@ -131,45 +131,45 @@ type LicenseConfigurationUsage struct { // Number of licenses consumed by the resource. ConsumedLicenses *int64 - // ID of the account that owns the resource. - ResourceOwnerId *string - // Amazon Resource Name (ARN) of the resource. ResourceArn *string - // Type of resource. - ResourceType ResourceType + // ID of the account that owns the resource. + ResourceOwnerId *string // Status of the resource. ResourceStatus *string + + // Type of resource. + ResourceType ResourceType } // Describes the failure of a license operation. type LicenseOperationFailure struct { - // Name of the operation. - OperationName *string - // Error message. ErrorMessage *string // Failure time. FailureTime *time.Time - // ID of the AWS account that owns the resource. - ResourceOwnerId *string + // Reserved. + MetadataList []*Metadata - // Amazon Resource Name (ARN) of the resource. - ResourceArn *string + // Name of the operation. + OperationName *string // The requester is "License Manager Automated Discovery". OperationRequestedBy *string + // Amazon Resource Name (ARN) of the resource. + ResourceArn *string + + // ID of the AWS account that owns the resource. + ResourceOwnerId *string + // Resource type. ResourceType ResourceType - - // Reserved. - MetadataList []*Metadata } // Details for associating a license configuration with a resource. @@ -195,10 +195,10 @@ type ManagedResourceSummary struct { type Metadata struct { // Reserved. - Value *string + Name *string // Reserved. - Name *string + Value *string } // Configuration information for AWS Organizations. @@ -253,22 +253,25 @@ type ProductInformationFilter struct { // This member is required. ProductInformationFilterComparator *string - // Filter value. + // Filter name. // // This member is required. - ProductInformationFilterValue []*string + ProductInformationFilterName *string - // Filter name. + // Filter value. // // This member is required. - ProductInformationFilterName *string + ProductInformationFilterValue []*string } // Details about a resource. type ResourceInventory struct { - // ID of the account that owns the resource. - ResourceOwningAccountId *string + // Platform of the resource. + Platform *string + + // Platform version of the resource in the inventory. + PlatformVersion *string // Amazon Resource Name (ARN) of the resource. ResourceArn *string @@ -276,14 +279,11 @@ type ResourceInventory struct { // ID of the resource. ResourceId *string + // ID of the account that owns the resource. + ResourceOwningAccountId *string + // Type of resource. ResourceType ResourceType - - // Platform version of the resource in the inventory. - PlatformVersion *string - - // Platform of the resource. - Platform *string } // Details about a tag for a license configuration. diff --git a/service/lightsail/api_op_AttachDisk.go b/service/lightsail/api_op_AttachDisk.go index 9a3c061c480..67962ca5d3c 100644 --- a/service/lightsail/api_op_AttachDisk.go +++ b/service/lightsail/api_op_AttachDisk.go @@ -62,6 +62,11 @@ func (c *Client) AttachDisk(ctx context.Context, params *AttachDiskInput, optFns type AttachDiskInput struct { + // The unique Lightsail disk name (e.g., my-disk). + // + // This member is required. + DiskName *string + // The disk path to expose to the instance (e.g., /dev/xvdf). // // This member is required. @@ -71,11 +76,6 @@ type AttachDiskInput struct { // // This member is required. InstanceName *string - - // The unique Lightsail disk name (e.g., my-disk). - // - // This member is required. - DiskName *string } type AttachDiskOutput struct { diff --git a/service/lightsail/api_op_AttachLoadBalancerTlsCertificate.go b/service/lightsail/api_op_AttachLoadBalancerTlsCertificate.go index 357953530ab..d2aed2735e5 100644 --- a/service/lightsail/api_op_AttachLoadBalancerTlsCertificate.go +++ b/service/lightsail/api_op_AttachLoadBalancerTlsCertificate.go @@ -66,16 +66,16 @@ func (c *Client) AttachLoadBalancerTlsCertificate(ctx context.Context, params *A type AttachLoadBalancerTlsCertificateInput struct { - // The name of the load balancer to which you want to associate the SSL/TLS - // certificate. + // The name of your SSL/TLS certificate. // // This member is required. - LoadBalancerName *string + CertificateName *string - // The name of your SSL/TLS certificate. + // The name of the load balancer to which you want to associate the SSL/TLS + // certificate. // // This member is required. - CertificateName *string + LoadBalancerName *string } type AttachLoadBalancerTlsCertificateOutput struct { diff --git a/service/lightsail/api_op_AttachStaticIp.go b/service/lightsail/api_op_AttachStaticIp.go index b8f8a1e36ab..84c9e00e1fe 100644 --- a/service/lightsail/api_op_AttachStaticIp.go +++ b/service/lightsail/api_op_AttachStaticIp.go @@ -57,15 +57,15 @@ func (c *Client) AttachStaticIp(ctx context.Context, params *AttachStaticIpInput type AttachStaticIpInput struct { - // The name of the static IP. + // The instance name to which you want to attach the static IP address. // // This member is required. - StaticIpName *string + InstanceName *string - // The instance name to which you want to attach the static IP address. + // The name of the static IP. // // This member is required. - InstanceName *string + StaticIpName *string } type AttachStaticIpOutput struct { diff --git a/service/lightsail/api_op_CloseInstancePublicPorts.go b/service/lightsail/api_op_CloseInstancePublicPorts.go index 17e6a93104c..7c841d9efea 100644 --- a/service/lightsail/api_op_CloseInstancePublicPorts.go +++ b/service/lightsail/api_op_CloseInstancePublicPorts.go @@ -61,15 +61,15 @@ func (c *Client) CloseInstancePublicPorts(ctx context.Context, params *CloseInst type CloseInstancePublicPortsInput struct { - // An object to describe the ports to close for the specified instance. + // The name of the instance for which to close ports. // // This member is required. - PortInfo *types.PortInfo + InstanceName *string - // The name of the instance for which to close ports. + // An object to describe the ports to close for the specified instance. // // This member is required. - InstanceName *string + PortInfo *types.PortInfo } type CloseInstancePublicPortsOutput struct { diff --git a/service/lightsail/api_op_CopySnapshot.go b/service/lightsail/api_op_CopySnapshot.go index 19ae9861d49..98b12b09e7c 100644 --- a/service/lightsail/api_op_CopySnapshot.go +++ b/service/lightsail/api_op_CopySnapshot.go @@ -69,6 +69,11 @@ type CopySnapshotInput struct { // This member is required. SourceRegion types.RegionName + // The name of the new manual snapshot to be created as a copy. + // + // This member is required. + TargetSnapshotName *string + // The date of the source automatic snapshot to copy. Use the get auto snapshots // operation to identify the dates of the available automatic snapshots. // Constraints: @@ -86,6 +91,21 @@ type CopySnapshotInput struct { // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots). RestoreDate *string + // The name of the source instance or disk from which the source automatic snapshot + // was created. Constraint: + // + // * Define this parameter only when copying an + // automatic snapshot as a manual snapshot. For more information, see the Lightsail + // Dev Guide + // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots). + SourceResourceName *string + + // The name of the source manual snapshot to copy. Constraint: + // + // * Define this + // parameter only when copying a manual snapshot as another manual snapshot. + SourceSnapshotName *string + // A Boolean value to indicate whether to use the latest available automatic // snapshot of the specified source instance or disk. Constraints: // @@ -98,26 +118,6 @@ type CopySnapshotInput struct { // as a manual snapshot. For more information, see the Lightsail Dev Guide // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots). UseLatestRestorableAutoSnapshot *bool - - // The name of the new manual snapshot to be created as a copy. - // - // This member is required. - TargetSnapshotName *string - - // The name of the source manual snapshot to copy. Constraint: - // - // * Define this - // parameter only when copying a manual snapshot as another manual snapshot. - SourceSnapshotName *string - - // The name of the source instance or disk from which the source automatic snapshot - // was created. Constraint: - // - // * Define this parameter only when copying an - // automatic snapshot as a manual snapshot. For more information, see the Lightsail - // Dev Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots). - SourceResourceName *string } type CopySnapshotOutput struct { diff --git a/service/lightsail/api_op_CreateCertificate.go b/service/lightsail/api_op_CreateCertificate.go index 6654e737694..80adfc53830 100644 --- a/service/lightsail/api_op_CreateCertificate.go +++ b/service/lightsail/api_op_CreateCertificate.go @@ -64,16 +64,16 @@ func (c *Client) CreateCertificate(ctx context.Context, params *CreateCertificat type CreateCertificateInput struct { - // The tag keys and optional values to add to the certificate during create. - //

    Use the TagResource action to tag a resource after it's - // created.

    - Tags []*types.Tag - // The name for the certificate. // // This member is required. CertificateName *string + // The domain name (e.g., example.com) for the certificate. + // + // This member is required. + DomainName *string + // An array of strings that specify the alternate domains (e.g., example2.com) and // subdomains (e.g., blog.example.com) for the certificate.

    You can specify a // maximum of nine alternate domains (in addition to the primary domain name).

    @@ -81,10 +81,10 @@ type CreateCertificateInput struct { // supported.

    SubjectAlternativeNames []*string - // The domain name (e.g., example.com) for the certificate. - // - // This member is required. - DomainName *string + // The tag keys and optional values to add to the certificate during create. + //

    Use the TagResource action to tag a resource after it's + // created.

    + Tags []*types.Tag } type CreateCertificateOutput struct { diff --git a/service/lightsail/api_op_CreateContactMethod.go b/service/lightsail/api_op_CreateContactMethod.go index 22ccae49601..0596244e0c7 100644 --- a/service/lightsail/api_op_CreateContactMethod.go +++ b/service/lightsail/api_op_CreateContactMethod.go @@ -63,6 +63,18 @@ func (c *Client) CreateContactMethod(ctx context.Context, params *CreateContactM type CreateContactMethodInput struct { + // The destination of the contact method, such as an email address or a mobile + // phone number. Use the E.164 format when specifying a mobile phone number. E.164 + // is a standard for the phone number structure used for international + // telecommunication. Phone numbers that follow this format can have a maximum of + // 15 digits, and they are prefixed with the plus character (+) and the country + // code. For example, a U.S. phone number in E.164 format would be specified as + // +1XXX5550100. For more information, see E.164 + // (https://en.wikipedia.org/wiki/E.164) on Wikipedia. + // + // This member is required. + ContactEndpoint *string + // The protocol of the contact method, such as Email or SMS (text messaging). The // SMS protocol is supported only in the following AWS Regions. // @@ -92,18 +104,6 @@ type CreateContactMethodInput struct { // // This member is required. Protocol types.ContactProtocol - - // The destination of the contact method, such as an email address or a mobile - // phone number. Use the E.164 format when specifying a mobile phone number. E.164 - // is a standard for the phone number structure used for international - // telecommunication. Phone numbers that follow this format can have a maximum of - // 15 digits, and they are prefixed with the plus character (+) and the country - // code. For example, a U.S. phone number in E.164 format would be specified as - // +1XXX5550100. For more information, see E.164 - // (https://en.wikipedia.org/wiki/E.164) on Wikipedia. - // - // This member is required. - ContactEndpoint *string } type CreateContactMethodOutput struct { diff --git a/service/lightsail/api_op_CreateDisk.go b/service/lightsail/api_op_CreateDisk.go index 2d20ec00f9f..b06d19ceac8 100644 --- a/service/lightsail/api_op_CreateDisk.go +++ b/service/lightsail/api_op_CreateDisk.go @@ -61,26 +61,26 @@ func (c *Client) CreateDisk(ctx context.Context, params *CreateDiskInput, optFns type CreateDiskInput struct { - // The size of the disk in GB (e.g., 32). + // The Availability Zone where you want to create the disk (e.g., us-east-2a). Use + // the same Availability Zone as the Lightsail instance to which you want to attach + // the disk. Use the get regions operation to list the Availability Zones where + // Lightsail is currently available. // // This member is required. - SizeInGb *int32 - - // An array of objects that represent the add-ons to enable for the new disk. - AddOns []*types.AddOnRequest + AvailabilityZone *string // The unique Lightsail disk name (e.g., my-disk). // // This member is required. DiskName *string - // The Availability Zone where you want to create the disk (e.g., us-east-2a). Use - // the same Availability Zone as the Lightsail instance to which you want to attach - // the disk. Use the get regions operation to list the Availability Zones where - // Lightsail is currently available. + // The size of the disk in GB (e.g., 32). // // This member is required. - AvailabilityZone *string + SizeInGb *int32 + + // An array of objects that represent the add-ons to enable for the new disk. + AddOns []*types.AddOnRequest // The tag keys and optional values to add to the resource during create. Use the // TagResource action to tag a resource after it's created. diff --git a/service/lightsail/api_op_CreateDiskFromSnapshot.go b/service/lightsail/api_op_CreateDiskFromSnapshot.go index efb5fa76740..2a38139c188 100644 --- a/service/lightsail/api_op_CreateDiskFromSnapshot.go +++ b/service/lightsail/api_op_CreateDiskFromSnapshot.go @@ -63,18 +63,13 @@ func (c *Client) CreateDiskFromSnapshot(ctx context.Context, params *CreateDiskF type CreateDiskFromSnapshotInput struct { - // The name of the source disk from which the source automatic snapshot was - // created. Constraints: - // - // * This parameter cannot be defined together with the - // disk snapshot name parameter. The source disk name and disk snapshot name - // parameters are mutually exclusive. + // The Availability Zone where you want to create the disk (e.g., us-east-2a). + // Choose the same Availability Zone as the Lightsail instance where you want to + // create the disk. Use the GetRegions operation to list the Availability Zones + // where Lightsail is currently available. // - // * Define this parameter only when - // creating a new disk from an automatic snapshot. For more information, see the - // Lightsail Dev Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots). - SourceDiskName *string + // This member is required. + AvailabilityZone *string // The unique Lightsail disk name (e.g., my-disk). // @@ -97,47 +92,52 @@ type CreateDiskFromSnapshotInput struct { // parameters are mutually exclusive. DiskSnapshotName *string - // A Boolean value to indicate whether to use the latest available automatic - // snapshot. Constraints: + // The date of the automatic snapshot to use for the new disk. Use the get auto + // snapshots operation to identify the dates of the available automatic snapshots. + // Constraints: + // + // * Must be specified in YYYY-MM-DD format. + // + // * This + // parameter cannot be defined together with the use latest restorable auto + // snapshot parameter. The restore date and use latest restorable auto snapshot + // parameters are mutually exclusive. + // + // * Define this parameter only when + // creating a new disk from an automatic snapshot. For more information, see the + // Lightsail Dev Guide + // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots). + RestoreDate *string + + // The name of the source disk from which the source automatic snapshot was + // created. Constraints: // // * This parameter cannot be defined together with the - // restore date parameter. The use latest restorable auto snapshot and restore date + // disk snapshot name parameter. The source disk name and disk snapshot name // parameters are mutually exclusive. // // * Define this parameter only when // creating a new disk from an automatic snapshot. For more information, see the // Lightsail Dev Guide // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots). - UseLatestRestorableAutoSnapshot *bool + SourceDiskName *string // The tag keys and optional values to add to the resource during create. Use the // TagResource action to tag a resource after it's created. Tags []*types.Tag - // The Availability Zone where you want to create the disk (e.g., us-east-2a). - // Choose the same Availability Zone as the Lightsail instance where you want to - // create the disk. Use the GetRegions operation to list the Availability Zones - // where Lightsail is currently available. - // - // This member is required. - AvailabilityZone *string - - // The date of the automatic snapshot to use for the new disk. Use the get auto - // snapshots operation to identify the dates of the available automatic snapshots. - // Constraints: - // - // * Must be specified in YYYY-MM-DD format. + // A Boolean value to indicate whether to use the latest available automatic + // snapshot. Constraints: // - // * This - // parameter cannot be defined together with the use latest restorable auto - // snapshot parameter. The restore date and use latest restorable auto snapshot + // * This parameter cannot be defined together with the + // restore date parameter. The use latest restorable auto snapshot and restore date // parameters are mutually exclusive. // // * Define this parameter only when // creating a new disk from an automatic snapshot. For more information, see the // Lightsail Dev Guide // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots). - RestoreDate *string + UseLatestRestorableAutoSnapshot *bool } type CreateDiskFromSnapshotOutput struct { diff --git a/service/lightsail/api_op_CreateDiskSnapshot.go b/service/lightsail/api_op_CreateDiskSnapshot.go index ccf74befdc4..82f811e73e9 100644 --- a/service/lightsail/api_op_CreateDiskSnapshot.go +++ b/service/lightsail/api_op_CreateDiskSnapshot.go @@ -79,6 +79,12 @@ func (c *Client) CreateDiskSnapshot(ctx context.Context, params *CreateDiskSnaps type CreateDiskSnapshotInput struct { + // The name of the destination disk snapshot (e.g., my-disk-snapshot) based on the + // source disk. + // + // This member is required. + DiskSnapshotName *string + // The unique name of the source disk (e.g., Disk-Virginia-1). This parameter // cannot be defined together with the instance name parameter. The disk name and // instance name parameters are mutually exclusive. @@ -93,12 +99,6 @@ type CreateDiskSnapshotInput struct { // The tag keys and optional values to add to the resource during create. Use the // TagResource action to tag a resource after it's created. Tags []*types.Tag - - // The name of the destination disk snapshot (e.g., my-disk-snapshot) based on the - // source disk. - // - // This member is required. - DiskSnapshotName *string } type CreateDiskSnapshotOutput struct { diff --git a/service/lightsail/api_op_CreateDistribution.go b/service/lightsail/api_op_CreateDistribution.go index 8fe4289af3b..3bc8b81b274 100644 --- a/service/lightsail/api_op_CreateDistribution.go +++ b/service/lightsail/api_op_CreateDistribution.go @@ -62,28 +62,24 @@ func (c *Client) CreateDistribution(ctx context.Context, params *CreateDistribut type CreateDistributionInput struct { - // The tag keys and optional values to add to the distribution during create. - //

    Use the TagResource action to tag a resource after it's - // created.

    - Tags []*types.Tag - - // The name for the distribution. + // The bundle ID to use for the distribution.

    A distribution bundle describes + // the specifications of your distribution, such as the monthly cost and monthly + // network transfer quota.

    Use the GetDistributionBundles + // action to get a list of distribution bundle IDs that you can specify.

    // // This member is required. - DistributionName *string - - // An array of objects that describe the per-path cache behavior for the - // distribution. - CacheBehaviors []*types.CacheBehaviorPerPath - - // An object that describes the cache behavior settings for the distribution. - CacheBehaviorSettings *types.CacheSettings + BundleId *string // An object that describes the default cache behavior for the distribution. // // This member is required. DefaultCacheBehavior *types.CacheBehavior + // The name for the distribution. + // + // This member is required. + DistributionName *string + // An object that describes the origin resource for the distribution, such as a // Lightsail instance or load balancer.

    The distribution pulls, caches, and // serves content from the origin.

    @@ -91,25 +87,29 @@ type CreateDistributionInput struct { // This member is required. Origin *types.InputOrigin - // The bundle ID to use for the distribution.

    A distribution bundle describes - // the specifications of your distribution, such as the monthly cost and monthly - // network transfer quota.

    Use the GetDistributionBundles - // action to get a list of distribution bundle IDs that you can specify.

    - // - // This member is required. - BundleId *string + // An object that describes the cache behavior settings for the distribution. + CacheBehaviorSettings *types.CacheSettings + + // An array of objects that describe the per-path cache behavior for the + // distribution. + CacheBehaviors []*types.CacheBehaviorPerPath + + // The tag keys and optional values to add to the distribution during create. + //

    Use the TagResource action to tag a resource after it's + // created.

    + Tags []*types.Tag } type CreateDistributionOutput struct { + // An object that describes the distribution created. + Distribution *types.LightsailDistribution + // An array of objects that describe the result of the action, such as the status // of the request, the timestamp of the request, and the resources affected by the // request. Operation *types.Operation - // An object that describes the distribution created. - Distribution *types.LightsailDistribution - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lightsail/api_op_CreateInstanceSnapshot.go b/service/lightsail/api_op_CreateInstanceSnapshot.go index 2661fab9e93..46cda6dae3e 100644 --- a/service/lightsail/api_op_CreateInstanceSnapshot.go +++ b/service/lightsail/api_op_CreateInstanceSnapshot.go @@ -61,6 +61,11 @@ func (c *Client) CreateInstanceSnapshot(ctx context.Context, params *CreateInsta type CreateInstanceSnapshotInput struct { + // The Lightsail instance on which to base your snapshot. + // + // This member is required. + InstanceName *string + // The name for your new snapshot. // // This member is required. @@ -69,11 +74,6 @@ type CreateInstanceSnapshotInput struct { // The tag keys and optional values to add to the resource during create. Use the // TagResource action to tag a resource after it's created. Tags []*types.Tag - - // The Lightsail instance on which to base your snapshot. - // - // This member is required. - InstanceName *string } type CreateInstanceSnapshotOutput struct { diff --git a/service/lightsail/api_op_CreateInstances.go b/service/lightsail/api_op_CreateInstances.go index 981a2b84f39..6cf2dbaa129 100644 --- a/service/lightsail/api_op_CreateInstances.go +++ b/service/lightsail/api_op_CreateInstances.go @@ -60,6 +60,16 @@ func (c *Client) CreateInstances(ctx context.Context, params *CreateInstancesInp type CreateInstancesInput struct { + // The Availability Zone in which to create your instance. Use the following + // format: us-east-2a (case sensitive). You can get a list of Availability Zones by + // using the get regions + // (http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html) + // operation. Be sure to add the include Availability Zones parameter to your + // request. + // + // This member is required. + AvailabilityZone *string + // The ID for a virtual private server image (e.g., app_wordpress_4_4 or // app_lamp_7_0). Use the get blueprints operation to return a list of available // images (or blueprints). Use active blueprints when creating new instances. @@ -71,25 +81,12 @@ type CreateInstancesInput struct { // This member is required. BlueprintId *string - // The name of your key pair. - KeyPairName *string - // The bundle of specification information for your virtual private server (or // instance), including the pricing plan (e.g., micro_1_0). // // This member is required. BundleId *string - // The Availability Zone in which to create your instance. Use the following - // format: us-east-2a (case sensitive). You can get a list of Availability Zones by - // using the get regions - // (http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html) - // operation. Be sure to add the include Availability Zones parameter to your - // request. - // - // This member is required. - AvailabilityZone *string - // The names to use for your new Lightsail instances. Separate multiple values // using quotation marks and commas, for example: // ["MyFirstInstance","MySecondInstance"] @@ -97,6 +94,16 @@ type CreateInstancesInput struct { // This member is required. InstanceNames []*string + // An array of objects representing the add-ons to enable for the new instance. + AddOns []*types.AddOnRequest + + // (Deprecated) The name for your custom image. In releases prior to June 12, 2017, + // this parameter was ignored by the API. It is now deprecated. + CustomImageName *string + + // The name of your key pair. + KeyPairName *string + // The tag keys and optional values to add to the resource during create. Use the // TagResource action to tag a resource after it's created. Tags []*types.Tag @@ -108,13 +115,6 @@ type CreateInstancesInput struct { // pkg. For a complete list, see the Dev Guide // (https://lightsail.aws.amazon.com/ls/docs/getting-started/article/compare-options-choose-lightsail-instance-image). UserData *string - - // An array of objects representing the add-ons to enable for the new instance. - AddOns []*types.AddOnRequest - - // (Deprecated) The name for your custom image. In releases prior to June 12, 2017, - // this parameter was ignored by the API. It is now deprecated. - CustomImageName *string } type CreateInstancesOutput struct { diff --git a/service/lightsail/api_op_CreateInstancesFromSnapshot.go b/service/lightsail/api_op_CreateInstancesFromSnapshot.go index 5256010e371..276de930779 100644 --- a/service/lightsail/api_op_CreateInstancesFromSnapshot.go +++ b/service/lightsail/api_op_CreateInstancesFromSnapshot.go @@ -61,6 +61,42 @@ func (c *Client) CreateInstancesFromSnapshot(ctx context.Context, params *Create type CreateInstancesFromSnapshotInput struct { + // The Availability Zone where you want to create your instances. Use the following + // formatting: us-east-2a (case sensitive). You can get a list of Availability + // Zones by using the get regions + // (http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html) + // operation. Be sure to add the include Availability Zones parameter to your + // request. + // + // This member is required. + AvailabilityZone *string + + // The bundle of specification information for your virtual private server (or + // instance), including the pricing plan (e.g., micro_1_0). + // + // This member is required. + BundleId *string + + // The names for your new instances. + // + // This member is required. + InstanceNames []*string + + // An array of objects representing the add-ons to enable for the new instance. + AddOns []*types.AddOnRequest + + // An object containing information about one or more disk mappings. + AttachedDiskMapping map[string][]*types.DiskMap + + // The name of the instance snapshot on which you are basing your new instances. + // Use the get instance snapshots operation to return information about your + // existing snapshots. Constraint: + // + // * This parameter cannot be defined together + // with the source instance name parameter. The instance snapshot name and source + // instance name parameters are mutually exclusive. + InstanceSnapshotName *string + // The name for your key pair. KeyPairName *string @@ -81,12 +117,6 @@ type CreateInstancesFromSnapshotInput struct { // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots). RestoreDate *string - // The bundle of specification information for your virtual private server (or - // instance), including the pricing plan (e.g., micro_1_0). - // - // This member is required. - BundleId *string - // The name of the source instance from which the source automatic snapshot was // created. Constraints: // @@ -100,28 +130,6 @@ type CreateInstancesFromSnapshotInput struct { // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots). SourceInstanceName *string - // The Availability Zone where you want to create your instances. Use the following - // formatting: us-east-2a (case sensitive). You can get a list of Availability - // Zones by using the get regions - // (http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html) - // operation. Be sure to add the include Availability Zones parameter to your - // request. - // - // This member is required. - AvailabilityZone *string - - // An object containing information about one or more disk mappings. - AttachedDiskMapping map[string][]*types.DiskMap - - // The name of the instance snapshot on which you are basing your new instances. - // Use the get instance snapshots operation to return information about your - // existing snapshots. Constraint: - // - // * This parameter cannot be defined together - // with the source instance name parameter. The instance snapshot name and source - // instance name parameters are mutually exclusive. - InstanceSnapshotName *string - // The tag keys and optional values to add to the resource during create. Use the // TagResource action to tag a resource after it's created. Tags []*types.Tag @@ -146,14 +154,6 @@ type CreateInstancesFromSnapshotInput struct { // see the Dev Guide // (https://lightsail.aws.amazon.com/ls/docs/getting-started/article/compare-options-choose-lightsail-instance-image). UserData *string - - // The names for your new instances. - // - // This member is required. - InstanceNames []*string - - // An array of objects representing the add-ons to enable for the new instance. - AddOns []*types.AddOnRequest } type CreateInstancesFromSnapshotOutput struct { diff --git a/service/lightsail/api_op_CreateKeyPair.go b/service/lightsail/api_op_CreateKeyPair.go index 803037e895e..8bc7b314ce3 100644 --- a/service/lightsail/api_op_CreateKeyPair.go +++ b/service/lightsail/api_op_CreateKeyPair.go @@ -59,18 +59,22 @@ func (c *Client) CreateKeyPair(ctx context.Context, params *CreateKeyPairInput, type CreateKeyPairInput struct { - // The tag keys and optional values to add to the resource during create. Use the - // TagResource action to tag a resource after it's created. - Tags []*types.Tag - // The name for your new key pair. // // This member is required. KeyPairName *string + + // The tag keys and optional values to add to the resource during create. Use the + // TagResource action to tag a resource after it's created. + Tags []*types.Tag } type CreateKeyPairOutput struct { + // An array of key-value pairs containing information about the new key pair you + // just created. + KeyPair *types.KeyPair + // An array of objects that describe the result of the action, such as the status // of the request, the timestamp of the request, and the resources affected by the // request. @@ -79,10 +83,6 @@ type CreateKeyPairOutput struct { // A base64-encoded RSA private key. PrivateKeyBase64 *string - // An array of key-value pairs containing information about the new key pair you - // just created. - KeyPair *types.KeyPair - // A base64-encoded public key of the ssh-rsa type. PublicKeyBase64 *string diff --git a/service/lightsail/api_op_CreateLoadBalancer.go b/service/lightsail/api_op_CreateLoadBalancer.go index 426915fb78a..c56b12a0976 100644 --- a/service/lightsail/api_op_CreateLoadBalancer.go +++ b/service/lightsail/api_op_CreateLoadBalancer.go @@ -71,31 +71,31 @@ type CreateLoadBalancerInput struct { // This member is required. InstancePort *int32 - // The path you provided to perform the load balancer health check. If you didn't - // specify a health check path, Lightsail uses the root path of your website (e.g., - // "/"). You may want to specify a custom health check path other than the root of - // your application if your home page loads slowly or has a lot of media or - // scripting on it. - HealthCheckPath *string + // The name of your load balancer. + // + // This member is required. + LoadBalancerName *string + + // The optional alternative domains and subdomains to use with your SSL/TLS + // certificate (e.g., www.example.com, example.com, m.example.com, + // blog.example.com). + CertificateAlternativeNames []*string // The domain name with which your certificate is associated (e.g., example.com). // If you specify certificateDomainName, then certificateName is required (and // vice-versa). CertificateDomainName *string - // The name of your load balancer. - // - // This member is required. - LoadBalancerName *string - // The name of the SSL/TLS certificate. If you specify certificateName, then // certificateDomainName is required (and vice-versa). CertificateName *string - // The optional alternative domains and subdomains to use with your SSL/TLS - // certificate (e.g., www.example.com, example.com, m.example.com, - // blog.example.com). - CertificateAlternativeNames []*string + // The path you provided to perform the load balancer health check. If you didn't + // specify a health check path, Lightsail uses the root path of your website (e.g., + // "/"). You may want to specify a custom health check path other than the root of + // your application if your home page loads slowly or has a lot of media or + // scripting on it. + HealthCheckPath *string // The tag keys and optional values to add to the resource during create. Use the // TagResource action to tag a resource after it's created. diff --git a/service/lightsail/api_op_CreateLoadBalancerTlsCertificate.go b/service/lightsail/api_op_CreateLoadBalancerTlsCertificate.go index bdeb699d6c5..0ca0720059c 100644 --- a/service/lightsail/api_op_CreateLoadBalancerTlsCertificate.go +++ b/service/lightsail/api_op_CreateLoadBalancerTlsCertificate.go @@ -62,26 +62,11 @@ func (c *Client) CreateLoadBalancerTlsCertificate(ctx context.Context, params *C type CreateLoadBalancerTlsCertificateInput struct { - // An array of strings listing alternative domains and subdomains for your SSL/TLS - // certificate. Lightsail will de-dupe the names for you. You can have a maximum of - // 9 alternative names (in addition to the 1 primary domain). We do not support - // wildcards (e.g., *.example.com). - CertificateAlternativeNames []*string - // The domain name (e.g., example.com) for your SSL/TLS certificate. // // This member is required. CertificateDomainName *string - // The tag keys and optional values to add to the resource during create. Use the - // TagResource action to tag a resource after it's created. - Tags []*types.Tag - - // The load balancer name where you want to create the SSL/TLS certificate. - // - // This member is required. - LoadBalancerName *string - // The SSL/TLS certificate name. You can have up to 10 certificates in your account // at one time. Each Lightsail load balancer can have up to 2 certificates // associated with it at one time. There is also an overall limit to the number of @@ -90,6 +75,21 @@ type CreateLoadBalancerTlsCertificateInput struct { // // This member is required. CertificateName *string + + // The load balancer name where you want to create the SSL/TLS certificate. + // + // This member is required. + LoadBalancerName *string + + // An array of strings listing alternative domains and subdomains for your SSL/TLS + // certificate. Lightsail will de-dupe the names for you. You can have a maximum of + // 9 alternative names (in addition to the 1 primary domain). We do not support + // wildcards (e.g., *.example.com). + CertificateAlternativeNames []*string + + // The tag keys and optional values to add to the resource during create. Use the + // TagResource action to tag a resource after it's created. + Tags []*types.Tag } type CreateLoadBalancerTlsCertificateOutput struct { diff --git a/service/lightsail/api_op_CreateRelationalDatabase.go b/service/lightsail/api_op_CreateRelationalDatabase.go index f96b070b4f0..871167d59e2 100644 --- a/service/lightsail/api_op_CreateRelationalDatabase.go +++ b/service/lightsail/api_op_CreateRelationalDatabase.go @@ -60,43 +60,6 @@ func (c *Client) CreateRelationalDatabase(ctx context.Context, params *CreateRel type CreateRelationalDatabaseInput struct { - // The daily time range during which automated backups are created for your new - // database if automated backups are enabled. The default is a 30-minute window - // selected at random from an 8-hour block of time for each AWS Region. For more - // information about the preferred backup window time blocks for each region, see - // the Working With Backups - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) - // guide in the Amazon Relational Database Service (Amazon RDS) documentation. - // Constraints: - // - // * Must be in the hh24:mi-hh24:mi format. Example: - // 16:00-16:30 - // - // * Specified in Coordinated Universal Time (UTC). - // - // * Must - // not conflict with the preferred maintenance window. - // - // * Must be at least 30 - // minutes. - PreferredBackupWindow *string - - // The name to use for your new database. Constraints: - // - // * Must contain from 2 - // to 255 alphanumeric characters, or hyphens. - // - // * The first and last character - // must be a letter or number. - // - // This member is required. - RelationalDatabaseName *string - - // The password for the master user of your new database. The password can include - // any printable ASCII character except "/", """, or "@". Constraints: Must contain - // 8 to 41 characters. - MasterUserPassword *string - // The name of the master database created when the Lightsail database resource is // created. Constraints: // @@ -108,23 +71,6 @@ type CreateRelationalDatabaseInput struct { // This member is required. MasterDatabaseName *string - // The bundle ID for your new database. A bundle describes the performance - // specifications for your database. You can get a list of database bundle IDs by - // using the get relational database bundles operation. - // - // This member is required. - RelationalDatabaseBundleId *string - - // Specifies the accessibility options for your new database. A value of true - // specifies a database that is available to resources outside of your Lightsail - // account. A value of false specifies a database that is available only to your - // Lightsail resources in the same region as your database. - PubliclyAccessible *bool - - // The tag keys and optional values to add to the resource during create. Use the - // TagResource action to tag a resource after it's created. - Tags []*types.Tag - // The master user name for your new database. Constraints: // // * Master user name @@ -151,12 +97,56 @@ type CreateRelationalDatabaseInput struct { // This member is required. RelationalDatabaseBlueprintId *string + // The bundle ID for your new database. A bundle describes the performance + // specifications for your database. You can get a list of database bundle IDs by + // using the get relational database bundles operation. + // + // This member is required. + RelationalDatabaseBundleId *string + + // The name to use for your new database. Constraints: + // + // * Must contain from 2 + // to 255 alphanumeric characters, or hyphens. + // + // * The first and last character + // must be a letter or number. + // + // This member is required. + RelationalDatabaseName *string + // The Availability Zone in which to create your new database. Use the us-east-2a // case-sensitive format. You can get a list of Availability Zones by using the get // regions operation. Be sure to add the include relational database Availability // Zones parameter to your request. AvailabilityZone *string + // The password for the master user of your new database. The password can include + // any printable ASCII character except "/", """, or "@". Constraints: Must contain + // 8 to 41 characters. + MasterUserPassword *string + + // The daily time range during which automated backups are created for your new + // database if automated backups are enabled. The default is a 30-minute window + // selected at random from an 8-hour block of time for each AWS Region. For more + // information about the preferred backup window time blocks for each region, see + // the Working With Backups + // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) + // guide in the Amazon Relational Database Service (Amazon RDS) documentation. + // Constraints: + // + // * Must be in the hh24:mi-hh24:mi format. Example: + // 16:00-16:30 + // + // * Specified in Coordinated Universal Time (UTC). + // + // * Must + // not conflict with the preferred maintenance window. + // + // * Must be at least 30 + // minutes. + PreferredBackupWindow *string + // The weekly time range during which system maintenance can occur on your new // database. The default is a 30-minute window selected at random from an 8-hour // block of time for each AWS Region, occurring on a random day of the week. @@ -175,6 +165,16 @@ type CreateRelationalDatabaseInput struct { // * Example: // Tue:17:00-Tue:17:30 PreferredMaintenanceWindow *string + + // Specifies the accessibility options for your new database. A value of true + // specifies a database that is available to resources outside of your Lightsail + // account. A value of false specifies a database that is available only to your + // Lightsail resources in the same region as your database. + PubliclyAccessible *bool + + // The tag keys and optional values to add to the resource during create. Use the + // TagResource action to tag a resource after it's created. + Tags []*types.Tag } type CreateRelationalDatabaseOutput struct { diff --git a/service/lightsail/api_op_CreateRelationalDatabaseFromSnapshot.go b/service/lightsail/api_op_CreateRelationalDatabaseFromSnapshot.go index fcb8ab6d632..0da287c06f3 100644 --- a/service/lightsail/api_op_CreateRelationalDatabaseFromSnapshot.go +++ b/service/lightsail/api_op_CreateRelationalDatabaseFromSnapshot.go @@ -65,12 +65,6 @@ func (c *Client) CreateRelationalDatabaseFromSnapshot(ctx context.Context, param type CreateRelationalDatabaseFromSnapshotInput struct { - // Specifies the accessibility options for your new database. A value of true - // specifies a database that is available to resources outside of your Lightsail - // account. A value of false specifies a database that is available only to your - // Lightsail resources in the same region as your database. - PubliclyAccessible *bool - // The name to use for your new database. Constraints: // // * Must contain from 2 @@ -82,8 +76,17 @@ type CreateRelationalDatabaseFromSnapshotInput struct { // This member is required. RelationalDatabaseName *string - // The name of the database snapshot from which to create your new database. - RelationalDatabaseSnapshotName *string + // The Availability Zone in which to create your new database. Use the us-east-2a + // case-sensitive format. You can get a list of Availability Zones by using the get + // regions operation. Be sure to add the include relational database Availability + // Zones parameter to your request. + AvailabilityZone *string + + // Specifies the accessibility options for your new database. A value of true + // specifies a database that is available to resources outside of your Lightsail + // account. A value of false specifies a database that is available only to your + // Lightsail resources in the same region as your database. + PubliclyAccessible *bool // The bundle ID for your new database. A bundle describes the performance // specifications for your database. You can get a list of database bundle IDs by @@ -92,6 +95,9 @@ type CreateRelationalDatabaseFromSnapshotInput struct { // bundle of the source database. RelationalDatabaseBundleId *string + // The name of the database snapshot from which to create your new database. + RelationalDatabaseSnapshotName *string + // The date and time to restore your database from. Constraints: // // * Must be @@ -108,18 +114,12 @@ type CreateRelationalDatabaseFromSnapshotInput struct { // you input 1538424000 as the restore time. RestoreTime *time.Time - // The tag keys and optional values to add to the resource during create. Use the - // TagResource action to tag a resource after it's created. - Tags []*types.Tag - // The name of the source database. SourceRelationalDatabaseName *string - // The Availability Zone in which to create your new database. Use the us-east-2a - // case-sensitive format. You can get a list of Availability Zones by using the get - // regions operation. Be sure to add the include relational database Availability - // Zones parameter to your request. - AvailabilityZone *string + // The tag keys and optional values to add to the resource during create. Use the + // TagResource action to tag a resource after it's created. + Tags []*types.Tag // Specifies whether your database is restored from the latest backup time. A value // of true restores from the latest backup time. Default: false Constraints: Cannot diff --git a/service/lightsail/api_op_CreateRelationalDatabaseSnapshot.go b/service/lightsail/api_op_CreateRelationalDatabaseSnapshot.go index b13f7b9ba6e..f2b74a8929c 100644 --- a/service/lightsail/api_op_CreateRelationalDatabaseSnapshot.go +++ b/service/lightsail/api_op_CreateRelationalDatabaseSnapshot.go @@ -62,9 +62,10 @@ func (c *Client) CreateRelationalDatabaseSnapshot(ctx context.Context, params *C type CreateRelationalDatabaseSnapshotInput struct { - // The tag keys and optional values to add to the resource during create. Use the - // TagResource action to tag a resource after it's created. - Tags []*types.Tag + // The name of the database on which to base your new snapshot. + // + // This member is required. + RelationalDatabaseName *string // The name for your new database snapshot. Constraints: // @@ -77,10 +78,9 @@ type CreateRelationalDatabaseSnapshotInput struct { // This member is required. RelationalDatabaseSnapshotName *string - // The name of the database on which to base your new snapshot. - // - // This member is required. - RelationalDatabaseName *string + // The tag keys and optional values to add to the resource during create. Use the + // TagResource action to tag a resource after it's created. + Tags []*types.Tag } type CreateRelationalDatabaseSnapshotOutput struct { diff --git a/service/lightsail/api_op_DeleteAutoSnapshot.go b/service/lightsail/api_op_DeleteAutoSnapshot.go index 5f82ea2138c..10a7483273c 100644 --- a/service/lightsail/api_op_DeleteAutoSnapshot.go +++ b/service/lightsail/api_op_DeleteAutoSnapshot.go @@ -59,18 +59,18 @@ func (c *Client) DeleteAutoSnapshot(ctx context.Context, params *DeleteAutoSnaps type DeleteAutoSnapshotInput struct { - // The name of the source instance or disk from which to delete the automatic - // snapshot. - // - // This member is required. - ResourceName *string - // The date of the automatic snapshot to delete in YYYY-MM-DD format. Use the get // auto snapshots operation to get the available automatic snapshots for a // resource. // // This member is required. Date *string + + // The name of the source instance or disk from which to delete the automatic + // snapshot. + // + // This member is required. + ResourceName *string } type DeleteAutoSnapshotOutput struct { diff --git a/service/lightsail/api_op_DeleteDisk.go b/service/lightsail/api_op_DeleteDisk.go index 33b072cbb22..0054e02039c 100644 --- a/service/lightsail/api_op_DeleteDisk.go +++ b/service/lightsail/api_op_DeleteDisk.go @@ -63,13 +63,13 @@ func (c *Client) DeleteDisk(ctx context.Context, params *DeleteDiskInput, optFns type DeleteDiskInput struct { - // A Boolean value to indicate whether to delete the enabled add-ons for the disk. - ForceDeleteAddOns *bool - // The unique name of the disk you want to delete (e.g., my-disk). // // This member is required. DiskName *string + + // A Boolean value to indicate whether to delete the enabled add-ons for the disk. + ForceDeleteAddOns *bool } type DeleteDiskOutput struct { diff --git a/service/lightsail/api_op_DeleteDomainEntry.go b/service/lightsail/api_op_DeleteDomainEntry.go index d343b4e8ef6..bb332df7808 100644 --- a/service/lightsail/api_op_DeleteDomainEntry.go +++ b/service/lightsail/api_op_DeleteDomainEntry.go @@ -60,15 +60,15 @@ func (c *Client) DeleteDomainEntry(ctx context.Context, params *DeleteDomainEntr type DeleteDomainEntryInput struct { - // The name of the domain entry to delete. + // An array of key-value pairs containing information about your domain entries. // // This member is required. - DomainName *string + DomainEntry *types.DomainEntry - // An array of key-value pairs containing information about your domain entries. + // The name of the domain entry to delete. // // This member is required. - DomainEntry *types.DomainEntry + DomainName *string } type DeleteDomainEntryOutput struct { diff --git a/service/lightsail/api_op_DeleteLoadBalancerTlsCertificate.go b/service/lightsail/api_op_DeleteLoadBalancerTlsCertificate.go index db1839e54ea..dd0fef1bdbb 100644 --- a/service/lightsail/api_op_DeleteLoadBalancerTlsCertificate.go +++ b/service/lightsail/api_op_DeleteLoadBalancerTlsCertificate.go @@ -61,21 +61,21 @@ func (c *Client) DeleteLoadBalancerTlsCertificate(ctx context.Context, params *D type DeleteLoadBalancerTlsCertificateInput struct { - // When true, forces the deletion of an SSL/TLS certificate. There can be two - // certificates associated with a Lightsail load balancer: the primary and the - // backup. The force parameter is required when the primary SSL/TLS certificate is - // in use by an instance attached to the load balancer. - Force *bool + // The SSL/TLS certificate name. + // + // This member is required. + CertificateName *string // The load balancer name. // // This member is required. LoadBalancerName *string - // The SSL/TLS certificate name. - // - // This member is required. - CertificateName *string + // When true, forces the deletion of an SSL/TLS certificate. There can be two + // certificates associated with a Lightsail load balancer: the primary and the + // backup. The force parameter is required when the primary SSL/TLS certificate is + // in use by an instance attached to the load balancer. + Force *bool } type DeleteLoadBalancerTlsCertificateOutput struct { diff --git a/service/lightsail/api_op_DownloadDefaultKeyPair.go b/service/lightsail/api_op_DownloadDefaultKeyPair.go index c89b9a55103..8a116169790 100644 --- a/service/lightsail/api_op_DownloadDefaultKeyPair.go +++ b/service/lightsail/api_op_DownloadDefaultKeyPair.go @@ -58,12 +58,12 @@ type DownloadDefaultKeyPairInput struct { type DownloadDefaultKeyPairOutput struct { - // A base64-encoded public key of the ssh-rsa type. - PublicKeyBase64 *string - // A base64-encoded RSA private key. PrivateKeyBase64 *string + // A base64-encoded public key of the ssh-rsa type. + PublicKeyBase64 *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lightsail/api_op_GetActiveNames.go b/service/lightsail/api_op_GetActiveNames.go index b68711e6cdb..ea35f69793c 100644 --- a/service/lightsail/api_op_GetActiveNames.go +++ b/service/lightsail/api_op_GetActiveNames.go @@ -64,15 +64,15 @@ type GetActiveNamesInput struct { type GetActiveNamesOutput struct { + // The list of active names returned by the get active names request. + ActiveNames []*string + // The token to advance to the next page of resutls from your request. A next page // token is not returned if there are no more results to display. To get the next // page of results, perform another GetActiveNames request and specify the next // page token using the pageToken parameter. NextPageToken *string - // The list of active names returned by the get active names request. - ActiveNames []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lightsail/api_op_GetAlarms.go b/service/lightsail/api_op_GetAlarms.go index 4473469d5b7..31ff7ae8521 100644 --- a/service/lightsail/api_op_GetAlarms.go +++ b/service/lightsail/api_op_GetAlarms.go @@ -63,6 +63,10 @@ func (c *Client) GetAlarms(ctx context.Context, params *GetAlarmsInput, optFns . type GetAlarmsInput struct { + // The name of the alarm. Specify an alarm name to return information about a + // specific alarm. + AlarmName *string + // The name of the Lightsail resource being monitored by the alarm. Specify a // monitored resource name to return information about all alarms for a specific // resource. @@ -73,23 +77,19 @@ type GetAlarmsInput struct { // the response will return a next page token that you can specify as the page // token in a subsequent request. PageToken *string - - // The name of the alarm. Specify an alarm name to return information about a - // specific alarm. - AlarmName *string } type GetAlarmsOutput struct { + // An array of objects that describe the alarms. + Alarms []*types.Alarm + // The token to advance to the next page of resutls from your request. A next page // token is not returned if there are no more results to display. To get the next // page of results, perform another GetAlarms request and specify the next page // token using the pageToken parameter. NextPageToken *string - // An array of objects that describe the alarms. - Alarms []*types.Alarm - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lightsail/api_op_GetAutoSnapshots.go b/service/lightsail/api_op_GetAutoSnapshots.go index 0d4edba2c0a..675581553dd 100644 --- a/service/lightsail/api_op_GetAutoSnapshots.go +++ b/service/lightsail/api_op_GetAutoSnapshots.go @@ -72,12 +72,12 @@ type GetAutoSnapshotsOutput struct { // the specified source instance or disk. AutoSnapshots []*types.AutoSnapshotDetails - // The resource type (e.g., Instance or Disk). - ResourceType types.ResourceType - // The name of the source instance or disk for the automatic snapshots. ResourceName *string + // The resource type (e.g., Instance or Disk). + ResourceType types.ResourceType + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lightsail/api_op_GetBlueprints.go b/service/lightsail/api_op_GetBlueprints.go index 8598756fa5c..36fc4b1c08d 100644 --- a/service/lightsail/api_op_GetBlueprints.go +++ b/service/lightsail/api_op_GetBlueprints.go @@ -63,14 +63,14 @@ func (c *Client) GetBlueprints(ctx context.Context, params *GetBlueprintsInput, type GetBlueprintsInput struct { + // A Boolean value indicating whether to include inactive results in your request. + IncludeInactive *bool + // The token to advance to the next page of results from your request. To get a // page token, perform an initial GetBlueprints request. If your results are // paginated, the response will return a next page token that you can specify as // the page token in a subsequent request. PageToken *string - - // A Boolean value indicating whether to include inactive results in your request. - IncludeInactive *bool } type GetBlueprintsOutput struct { diff --git a/service/lightsail/api_op_GetBundles.go b/service/lightsail/api_op_GetBundles.go index 01517e36337..08b183d0376 100644 --- a/service/lightsail/api_op_GetBundles.go +++ b/service/lightsail/api_op_GetBundles.go @@ -57,15 +57,15 @@ func (c *Client) GetBundles(ctx context.Context, params *GetBundlesInput, optFns type GetBundlesInput struct { + // A Boolean value that indicates whether to include inactive bundle results in + // your request. + IncludeInactive *bool + // The token to advance to the next page of results from your request. To get a // page token, perform an initial GetBundles request. If your results are // paginated, the response will return a next page token that you can specify as // the page token in a subsequent request. PageToken *string - - // A Boolean value that indicates whether to include inactive bundle results in - // your request. - IncludeInactive *bool } type GetBundlesOutput struct { diff --git a/service/lightsail/api_op_GetCertificates.go b/service/lightsail/api_op_GetCertificates.go index 160d504269b..712b25d484b 100644 --- a/service/lightsail/api_op_GetCertificates.go +++ b/service/lightsail/api_op_GetCertificates.go @@ -60,11 +60,6 @@ func (c *Client) GetCertificates(ctx context.Context, params *GetCertificatesInp type GetCertificatesInput struct { - // Indicates whether to include detailed information about the certificates in the - // response.

    When omitted, the response includes only the certificate names, - // Amazon Resource Names (ARNs), domain names, and tags.

    - IncludeCertificateDetails *bool - // The name for the certificate for which to return information.

    When omitted, // the response includes all of your certificates in the AWS region where the // request is made.

    @@ -76,6 +71,11 @@ type GetCertificatesInput struct { // your certificates in the AWS region where the request is made, regardless of // their current status.

    CertificateStatuses []types.CertificateStatus + + // Indicates whether to include detailed information about the certificates in the + // response.

    When omitted, the response includes only the certificate names, + // Amazon Resource Names (ARNs), domain names, and tags.

    + IncludeCertificateDetails *bool } type GetCertificatesOutput struct { diff --git a/service/lightsail/api_op_GetDistributionLatestCacheReset.go b/service/lightsail/api_op_GetDistributionLatestCacheReset.go index 3641d65840e..fea24a818f1 100644 --- a/service/lightsail/api_op_GetDistributionLatestCacheReset.go +++ b/service/lightsail/api_op_GetDistributionLatestCacheReset.go @@ -66,12 +66,12 @@ type GetDistributionLatestCacheResetInput struct { type GetDistributionLatestCacheResetOutput struct { - // The status of the last cache reset. - Status *string - // The timestamp of the last cache reset (e.g., 1479734909.17) in Unix time format. CreateTime *time.Time + // The status of the last cache reset. + Status *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lightsail/api_op_GetDistributionMetricData.go b/service/lightsail/api_op_GetDistributionMetricData.go index fdd3ace9979..a0e88991f32 100644 --- a/service/lightsail/api_op_GetDistributionMetricData.go +++ b/service/lightsail/api_op_GetDistributionMetricData.go @@ -62,6 +62,29 @@ func (c *Client) GetDistributionMetricData(ctx context.Context, params *GetDistr type GetDistributionMetricDataInput struct { + // The name of the distribution for which to get metric data.

    Use the + // GetDistributions action to get a list of distribution names that + // you can specify.

    + // + // This member is required. + DistributionName *string + + // The end of the time interval for which to get metric data. Constraints: + // + // * + // Specified in Coordinated Universal Time (UTC). + // + // * Specified in the Unix time + // format. For example, if you wish to use an end time of October 1, 2018, at 9 PM + // UTC, specify 1538427600 as the end time. + // + // You can convert a human-friendly time + // to Unix time format using a converter like Epoch converter + // (https://www.epochconverter.com/). + // + // This member is required. + EndTime *time.Time + // The metric for which you want to return information.

    Valid distribution // metric names are listed below, along with the most useful // statistics to include in your request, and the published @@ -99,21 +122,26 @@ type GetDistributionMetricDataInput struct { // This member is required. MetricName types.DistributionMetricName - // The end of the time interval for which to get metric data. Constraints: + // The granularity, in seconds, for the metric data points that will be returned. + // + // This member is required. + Period *int32 + + // The start of the time interval for which to get metric data. Constraints: // // * // Specified in Coordinated Universal Time (UTC). // // * Specified in the Unix time - // format. For example, if you wish to use an end time of October 1, 2018, at 9 PM - // UTC, specify 1538427600 as the end time. + // format. For example, if you wish to use a start time of October 1, 2018, at 8 PM + // UTC, specify 1538424000 as the start time. // - // You can convert a human-friendly time - // to Unix time format using a converter like Epoch converter + // You can convert a human-friendly + // time to Unix time format using a converter like Epoch converter // (https://www.epochconverter.com/). // // This member is required. - EndTime *time.Time + StartTime *time.Time // The statistic for the metric. The following statistics are available: // @@ -141,40 +169,12 @@ type GetDistributionMetricDataInput struct { // This member is required. Statistics []types.MetricStatistic - // The start of the time interval for which to get metric data. Constraints: - // - // * - // Specified in Coordinated Universal Time (UTC). - // - // * Specified in the Unix time - // format. For example, if you wish to use a start time of October 1, 2018, at 8 PM - // UTC, specify 1538424000 as the start time. - // - // You can convert a human-friendly - // time to Unix time format using a converter like Epoch converter - // (https://www.epochconverter.com/). - // - // This member is required. - StartTime *time.Time - // The unit for the metric data request.

    Valid units depend on the metric data // being requested. For the valid units with each available metric, see the // metricName parameter.

    // // This member is required. Unit types.MetricUnit - - // The granularity, in seconds, for the metric data points that will be returned. - // - // This member is required. - Period *int32 - - // The name of the distribution for which to get metric data.

    Use the - // GetDistributions action to get a list of distribution names that - // you can specify.

    - // - // This member is required. - DistributionName *string } type GetDistributionMetricDataOutput struct { diff --git a/service/lightsail/api_op_GetDistributions.go b/service/lightsail/api_op_GetDistributions.go index 61c0b0d579b..5a08eb2f3a7 100644 --- a/service/lightsail/api_op_GetDistributions.go +++ b/service/lightsail/api_op_GetDistributions.go @@ -57,17 +57,17 @@ func (c *Client) GetDistributions(ctx context.Context, params *GetDistributionsI type GetDistributionsInput struct { - // The token to advance to the next page of results from your request.

    To get a - // page token, perform an initial GetDistributions request. If your - // results are paginated, the response will return a next page token that you can - // specify as the page token in a subsequent request.

    - PageToken *string - // The name of the distribution for which to return information.

    Use the // GetDistributions action to get a list of distribution names that // you can specify.

    When omitted, the response includes all of your // distributions in the AWS Region where the request is made.

    DistributionName *string + + // The token to advance to the next page of results from your request.

    To get a + // page token, perform an initial GetDistributions request. If your + // results are paginated, the response will return a next page token that you can + // specify as the page token in a subsequent request.

    + PageToken *string } type GetDistributionsOutput struct { diff --git a/service/lightsail/api_op_GetInstanceAccessDetails.go b/service/lightsail/api_op_GetInstanceAccessDetails.go index f54b8cd9bb7..d472efcac7c 100644 --- a/service/lightsail/api_op_GetInstanceAccessDetails.go +++ b/service/lightsail/api_op_GetInstanceAccessDetails.go @@ -61,13 +61,13 @@ func (c *Client) GetInstanceAccessDetails(ctx context.Context, params *GetInstan type GetInstanceAccessDetailsInput struct { - // The protocol to use to connect to your instance. Defaults to ssh. - Protocol types.InstanceAccessProtocol - // The name of the instance to access. // // This member is required. InstanceName *string + + // The protocol to use to connect to your instance. Defaults to ssh. + Protocol types.InstanceAccessProtocol } type GetInstanceAccessDetailsOutput struct { diff --git a/service/lightsail/api_op_GetInstanceMetricData.go b/service/lightsail/api_op_GetInstanceMetricData.go index a815cce9cda..e2d4344b457 100644 --- a/service/lightsail/api_op_GetInstanceMetricData.go +++ b/service/lightsail/api_op_GetInstanceMetricData.go @@ -61,62 +61,16 @@ func (c *Client) GetInstanceMetricData(ctx context.Context, params *GetInstanceM type GetInstanceMetricDataInput struct { - // The start time of the time period. - // - // This member is required. - StartTime *time.Time - - // The statistic for the metric. The following statistics are available: - // - // * - // Minimum - The lowest value observed during the specified period. Use this value - // to determine low volumes of activity for your application. - // - // * Maximum - The - // highest value observed during the specified period. Use this value to determine - // high volumes of activity for your application. - // - // * Sum - All values submitted - // for the matching metric added together. You can use this statistic to determine - // the total volume of a metric. - // - // * Average - The value of Sum / SampleCount - // during the specified period. By comparing this statistic with the Minimum and - // Maximum values, you can determine the full scope of a metric and how close the - // average use is to the Minimum and Maximum values. This comparison helps you to - // know when to increase or decrease your resources. - // - // * SampleCount - The - // count, or number, of data points used for the statistical calculation. - // - // This member is required. - Statistics []types.MetricStatistic - // The end time of the time period. // // This member is required. EndTime *time.Time - // The unit for the metric data request. Valid units depend on the metric data - // being requested. For the valid units to specify with each available metric, see - // the metricName parameter. - // - // This member is required. - Unit types.MetricUnit - // The name of the instance for which you want to get metrics data. // // This member is required. InstanceName *string - // The granularity, in seconds, of the returned data points. The StatusCheckFailed, - // StatusCheckFailed_Instance, and StatusCheckFailed_System instance metric data is - // available in 1-minute (60 seconds) granularity. All other instance metric data - // is available in 5-minute (300 seconds) granularity. - // - // This member is required. - Period *int32 - // The metric for which you want to return information. Valid instance metric names // are listed below, along with the most useful statistics to include in your // request, and the published unit value. @@ -188,6 +142,52 @@ type GetInstanceMetricDataInput struct { // // This member is required. MetricName types.InstanceMetricName + + // The granularity, in seconds, of the returned data points. The StatusCheckFailed, + // StatusCheckFailed_Instance, and StatusCheckFailed_System instance metric data is + // available in 1-minute (60 seconds) granularity. All other instance metric data + // is available in 5-minute (300 seconds) granularity. + // + // This member is required. + Period *int32 + + // The start time of the time period. + // + // This member is required. + StartTime *time.Time + + // The statistic for the metric. The following statistics are available: + // + // * + // Minimum - The lowest value observed during the specified period. Use this value + // to determine low volumes of activity for your application. + // + // * Maximum - The + // highest value observed during the specified period. Use this value to determine + // high volumes of activity for your application. + // + // * Sum - All values submitted + // for the matching metric added together. You can use this statistic to determine + // the total volume of a metric. + // + // * Average - The value of Sum / SampleCount + // during the specified period. By comparing this statistic with the Minimum and + // Maximum values, you can determine the full scope of a metric and how close the + // average use is to the Minimum and Maximum values. This comparison helps you to + // know when to increase or decrease your resources. + // + // * SampleCount - The + // count, or number, of data points used for the statistical calculation. + // + // This member is required. + Statistics []types.MetricStatistic + + // The unit for the metric data request. Valid units depend on the metric data + // being requested. For the valid units to specify with each available metric, see + // the metricName parameter. + // + // This member is required. + Unit types.MetricUnit } type GetInstanceMetricDataOutput struct { diff --git a/service/lightsail/api_op_GetInstanceSnapshots.go b/service/lightsail/api_op_GetInstanceSnapshots.go index ebd1258eb84..443c023b5f0 100644 --- a/service/lightsail/api_op_GetInstanceSnapshots.go +++ b/service/lightsail/api_op_GetInstanceSnapshots.go @@ -65,16 +65,16 @@ type GetInstanceSnapshotsInput struct { type GetInstanceSnapshotsOutput struct { + // An array of key-value pairs containing information about the results of your get + // instance snapshots request. + InstanceSnapshots []*types.InstanceSnapshot + // The token to advance to the next page of resutls from your request. A next page // token is not returned if there are no more results to display. To get the next // page of results, perform another GetInstanceSnapshots request and specify the // next page token using the pageToken parameter. NextPageToken *string - // An array of key-value pairs containing information about the results of your get - // instance snapshots request. - InstanceSnapshots []*types.InstanceSnapshot - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lightsail/api_op_GetLoadBalancerMetricData.go b/service/lightsail/api_op_GetLoadBalancerMetricData.go index c19fb644bb7..6eb5ceae5f5 100644 --- a/service/lightsail/api_op_GetLoadBalancerMetricData.go +++ b/service/lightsail/api_op_GetLoadBalancerMetricData.go @@ -61,10 +61,15 @@ func (c *Client) GetLoadBalancerMetricData(ctx context.Context, params *GetLoadB type GetLoadBalancerMetricDataInput struct { - // The granularity, in seconds, of the returned data points. + // The end time of the period. // // This member is required. - Period *int32 + EndTime *time.Time + + // The name of the load balancer. + // + // This member is required. + LoadBalancerName *string // The metric for which you want to return information. Valid load balancer metric // names are listed below, along with the most useful statistics to include in your @@ -145,6 +150,11 @@ type GetLoadBalancerMetricDataInput struct { // This member is required. MetricName types.LoadBalancerMetricName + // The granularity, in seconds, of the returned data points. + // + // This member is required. + Period *int32 + // The start time of the period. // // This member is required. @@ -176,16 +186,6 @@ type GetLoadBalancerMetricDataInput struct { // This member is required. Statistics []types.MetricStatistic - // The name of the load balancer. - // - // This member is required. - LoadBalancerName *string - - // The end time of the period. - // - // This member is required. - EndTime *time.Time - // The unit for the metric data request. Valid units depend on the metric data // being requested. For the valid units with each available metric, see the // metricName parameter. diff --git a/service/lightsail/api_op_GetOperations.go b/service/lightsail/api_op_GetOperations.go index 8e131314364..170d68062ed 100644 --- a/service/lightsail/api_op_GetOperations.go +++ b/service/lightsail/api_op_GetOperations.go @@ -68,17 +68,17 @@ type GetOperationsInput struct { type GetOperationsOutput struct { - // An array of objects that describe the result of the action, such as the status - // of the request, the timestamp of the request, and the resources affected by the - // request. - Operations []*types.Operation - // The token to advance to the next page of resutls from your request. A next page // token is not returned if there are no more results to display. To get the next // page of results, perform another GetOperations request and specify the next page // token using the pageToken parameter. NextPageToken *string + // An array of objects that describe the result of the action, such as the status + // of the request, the timestamp of the request, and the resources affected by the + // request. + Operations []*types.Operation + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lightsail/api_op_GetOperationsForResource.go b/service/lightsail/api_op_GetOperationsForResource.go index b2f471695a5..54cc007b74d 100644 --- a/service/lightsail/api_op_GetOperationsForResource.go +++ b/service/lightsail/api_op_GetOperationsForResource.go @@ -57,31 +57,31 @@ func (c *Client) GetOperationsForResource(ctx context.Context, params *GetOperat type GetOperationsForResourceInput struct { + // The name of the resource for which you are requesting information. + // + // This member is required. + ResourceName *string + // The token to advance to the next page of results from your request. To get a // page token, perform an initial GetOperationsForResource request. If your results // are paginated, the response will return a next page token that you can specify // as the page token in a subsequent request. PageToken *string - - // The name of the resource for which you are requesting information. - // - // This member is required. - ResourceName *string } type GetOperationsForResourceOutput struct { + // (Deprecated) Returns the number of pages of results that remain. In releases + // prior to June 12, 2017, this parameter returned null by the API. It is now + // deprecated, and the API returns the next page token parameter instead. + NextPageCount *string + // The token to advance to the next page of resutls from your request. A next page // token is not returned if there are no more results to display. To get the next // page of results, perform another GetOperationsForResource request and specify // the next page token using the pageToken parameter. NextPageToken *string - // (Deprecated) Returns the number of pages of results that remain. In releases - // prior to June 12, 2017, this parameter returned null by the API. It is now - // deprecated, and the API returns the next page token parameter instead. - NextPageCount *string - // An array of objects that describe the result of the action, such as the status // of the request, the timestamp of the request, and the resources affected by the // request. diff --git a/service/lightsail/api_op_GetRelationalDatabaseBundles.go b/service/lightsail/api_op_GetRelationalDatabaseBundles.go index 87be47199e6..2d3311c9fb3 100644 --- a/service/lightsail/api_op_GetRelationalDatabaseBundles.go +++ b/service/lightsail/api_op_GetRelationalDatabaseBundles.go @@ -67,15 +67,15 @@ type GetRelationalDatabaseBundlesInput struct { type GetRelationalDatabaseBundlesOutput struct { + // An object describing the result of your get relational database bundles request. + Bundles []*types.RelationalDatabaseBundle + // The token to advance to the next page of resutls from your request. A next page // token is not returned if there are no more results to display. To get the next // page of results, perform another GetRelationalDatabaseBundles request and // specify the next page token using the pageToken parameter. NextPageToken *string - // An object describing the result of your get relational database bundles request. - Bundles []*types.RelationalDatabaseBundle - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lightsail/api_op_GetRelationalDatabaseEvents.go b/service/lightsail/api_op_GetRelationalDatabaseEvents.go index f64e3aae726..6e015fa429d 100644 --- a/service/lightsail/api_op_GetRelationalDatabaseEvents.go +++ b/service/lightsail/api_op_GetRelationalDatabaseEvents.go @@ -57,34 +57,34 @@ func (c *Client) GetRelationalDatabaseEvents(ctx context.Context, params *GetRel type GetRelationalDatabaseEventsInput struct { - // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetRelationalDatabaseEvents request. If your - // results are paginated, the response will return a next page token that you can - // specify as the page token in a subsequent request. - PageToken *string + // The name of the database from which to get events. + // + // This member is required. + RelationalDatabaseName *string // The number of minutes in the past from which to retrieve events. For example, to // get all events from the past 2 hours, enter 120. Default: 60 The minimum is 1 // and the maximum is 14 days (20160 minutes). DurationInMinutes *int32 - // The name of the database from which to get events. - // - // This member is required. - RelationalDatabaseName *string + // The token to advance to the next page of results from your request. To get a + // page token, perform an initial GetRelationalDatabaseEvents request. If your + // results are paginated, the response will return a next page token that you can + // specify as the page token in a subsequent request. + PageToken *string } type GetRelationalDatabaseEventsOutput struct { - // An object describing the result of your get relational database events request. - RelationalDatabaseEvents []*types.RelationalDatabaseEvent - // The token to advance to the next page of resutls from your request. A next page // token is not returned if there are no more results to display. To get the next // page of results, perform another GetRelationalDatabaseEvents request and specify // the next page token using the pageToken parameter. NextPageToken *string + // An object describing the result of your get relational database events request. + RelationalDatabaseEvents []*types.RelationalDatabaseEvent + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lightsail/api_op_GetRelationalDatabaseLogEvents.go b/service/lightsail/api_op_GetRelationalDatabaseLogEvents.go index bed4e9b5d77..fccd2da1f27 100644 --- a/service/lightsail/api_op_GetRelationalDatabaseLogEvents.go +++ b/service/lightsail/api_op_GetRelationalDatabaseLogEvents.go @@ -58,30 +58,26 @@ func (c *Client) GetRelationalDatabaseLogEvents(ctx context.Context, params *Get type GetRelationalDatabaseLogEventsInput struct { - // The end of the time interval from which to get log events. Constraints: - // - // * - // Specified in Coordinated Universal Time (UTC). + // The name of the log stream. Use the get relational database log streams + // operation to get a list of available log streams. // - // * Specified in the Unix time - // format. For example, if you wish to use an end time of October 1, 2018, at 8 PM - // UTC, then you input 1538424000 as the end time. - EndTime *time.Time + // This member is required. + LogStreamName *string // The name of your database for which to get log events. // // This member is required. RelationalDatabaseName *string - // The start of the time interval from which to get log events. Constraints: + // The end of the time interval from which to get log events. Constraints: // // * // Specified in Coordinated Universal Time (UTC). // // * Specified in the Unix time - // format. For example, if you wish to use a start time of October 1, 2018, at 8 PM - // UTC, then you input 1538424000 as the start time. - StartTime *time.Time + // format. For example, if you wish to use an end time of October 1, 2018, at 8 PM + // UTC, then you input 1538424000 as the end time. + EndTime *time.Time // The token to advance to the next or previous page of results from your request. // To get a page token, perform an initial GetRelationalDatabaseLogEvents request. @@ -96,19 +92,19 @@ type GetRelationalDatabaseLogEventsInput struct { // of false is the only option available. StartFromHead *bool - // The name of the log stream. Use the get relational database log streams - // operation to get a list of available log streams. + // The start of the time interval from which to get log events. Constraints: // - // This member is required. - LogStreamName *string + // * + // Specified in Coordinated Universal Time (UTC). + // + // * Specified in the Unix time + // format. For example, if you wish to use a start time of October 1, 2018, at 8 PM + // UTC, then you input 1538424000 as the start time. + StartTime *time.Time } type GetRelationalDatabaseLogEventsOutput struct { - // An object describing the result of your get relational database log events - // request. - ResourceLogEvents []*types.LogEvent - // A token used for advancing to the previous page of results from your get // relational database log events request. NextBackwardToken *string @@ -117,6 +113,10 @@ type GetRelationalDatabaseLogEventsOutput struct { // database log events request. NextForwardToken *string + // An object describing the result of your get relational database log events + // request. + ResourceLogEvents []*types.LogEvent + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lightsail/api_op_GetRelationalDatabaseMasterUserPassword.go b/service/lightsail/api_op_GetRelationalDatabaseMasterUserPassword.go index 3c5dd3e6c0d..ff5c3dd2d88 100644 --- a/service/lightsail/api_op_GetRelationalDatabaseMasterUserPassword.go +++ b/service/lightsail/api_op_GetRelationalDatabaseMasterUserPassword.go @@ -61,17 +61,17 @@ func (c *Client) GetRelationalDatabaseMasterUserPassword(ctx context.Context, pa type GetRelationalDatabaseMasterUserPasswordInput struct { + // The name of your database for which to get the master user password. + // + // This member is required. + RelationalDatabaseName *string + // The password version to return. Specifying CURRENT or PREVIOUS returns the // current or previous passwords respectively. Specifying PENDING returns the // newest version of the password that will rotate to CURRENT. After the PENDING // password rotates to CURRENT, the PENDING password is no longer available. // Default: CURRENT PasswordVersion types.RelationalDatabasePasswordVersion - - // The name of your database for which to get the master user password. - // - // This member is required. - RelationalDatabaseName *string } type GetRelationalDatabaseMasterUserPasswordOutput struct { diff --git a/service/lightsail/api_op_GetRelationalDatabaseMetricData.go b/service/lightsail/api_op_GetRelationalDatabaseMetricData.go index deb79232238..8c3f6aa4963 100644 --- a/service/lightsail/api_op_GetRelationalDatabaseMetricData.go +++ b/service/lightsail/api_op_GetRelationalDatabaseMetricData.go @@ -61,6 +61,18 @@ func (c *Client) GetRelationalDatabaseMetricData(ctx context.Context, params *Ge type GetRelationalDatabaseMetricDataInput struct { + // The end of the time interval from which to get metric data. Constraints: + // + // * + // Specified in Coordinated Universal Time (UTC). + // + // * Specified in the Unix time + // format. For example, if you wish to use an end time of October 1, 2018, at 8 PM + // UTC, then you input 1538424000 as the end time. + // + // This member is required. + EndTime *time.Time + // The metric for which you want to return information. Valid relational database // metric names are listed below, along with the most useful statistics to include // in your request, and the published unit value. All relational database metric @@ -97,24 +109,16 @@ type GetRelationalDatabaseMetricDataInput struct { // This member is required. MetricName types.RelationalDatabaseMetricName - // The end of the time interval from which to get metric data. Constraints: - // - // * - // Specified in Coordinated Universal Time (UTC). - // - // * Specified in the Unix time - // format. For example, if you wish to use an end time of October 1, 2018, at 8 PM - // UTC, then you input 1538424000 as the end time. + // The granularity, in seconds, of the returned data points. All relational + // database metric data is available in 1-minute (60 seconds) granularity. // // This member is required. - EndTime *time.Time + Period *int32 - // The unit for the metric data request. Valid units depend on the metric data - // being requested. For the valid units with each available metric, see the - // metricName parameter. + // The name of your database from which to get metric data. // // This member is required. - Unit types.MetricUnit + RelationalDatabaseName *string // The start of the time interval from which to get metric data. Constraints: // @@ -154,16 +158,12 @@ type GetRelationalDatabaseMetricDataInput struct { // This member is required. Statistics []types.MetricStatistic - // The name of your database from which to get metric data. - // - // This member is required. - RelationalDatabaseName *string - - // The granularity, in seconds, of the returned data points. All relational - // database metric data is available in 1-minute (60 seconds) granularity. + // The unit for the metric data request. Valid units depend on the metric data + // being requested. For the valid units with each available metric, see the + // metricName parameter. // // This member is required. - Period *int32 + Unit types.MetricUnit } type GetRelationalDatabaseMetricDataOutput struct { diff --git a/service/lightsail/api_op_GetRelationalDatabaseParameters.go b/service/lightsail/api_op_GetRelationalDatabaseParameters.go index c8f13d6ed0d..7b288f9ddef 100644 --- a/service/lightsail/api_op_GetRelationalDatabaseParameters.go +++ b/service/lightsail/api_op_GetRelationalDatabaseParameters.go @@ -61,16 +61,16 @@ func (c *Client) GetRelationalDatabaseParameters(ctx context.Context, params *Ge type GetRelationalDatabaseParametersInput struct { + // The name of your database for which to get parameters. + // + // This member is required. + RelationalDatabaseName *string + // The token to advance to the next page of results from your request. To get a // page token, perform an initial GetRelationalDatabaseParameters request. If your // results are paginated, the response will return a next page token that you can // specify as the page token in a subsequent request. PageToken *string - - // The name of your database for which to get parameters. - // - // This member is required. - RelationalDatabaseName *string } type GetRelationalDatabaseParametersOutput struct { diff --git a/service/lightsail/api_op_GetRelationalDatabases.go b/service/lightsail/api_op_GetRelationalDatabases.go index 48116ea8191..3ba1b0a52ab 100644 --- a/service/lightsail/api_op_GetRelationalDatabases.go +++ b/service/lightsail/api_op_GetRelationalDatabases.go @@ -65,15 +65,15 @@ type GetRelationalDatabasesInput struct { type GetRelationalDatabasesOutput struct { - // An object describing the result of your get relational databases request. - RelationalDatabases []*types.RelationalDatabase - // The token to advance to the next page of resutls from your request. A next page // token is not returned if there are no more results to display. To get the next // page of results, perform another GetRelationalDatabases request and specify the // next page token using the pageToken parameter. NextPageToken *string + // An object describing the result of your get relational databases request. + RelationalDatabases []*types.RelationalDatabase + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lightsail/api_op_GetStaticIps.go b/service/lightsail/api_op_GetStaticIps.go index 937032a3aa5..1358cabbd56 100644 --- a/service/lightsail/api_op_GetStaticIps.go +++ b/service/lightsail/api_op_GetStaticIps.go @@ -65,16 +65,16 @@ type GetStaticIpsInput struct { type GetStaticIpsOutput struct { - // An array of key-value pairs containing information about your get static IPs - // request. - StaticIps []*types.StaticIp - // The token to advance to the next page of resutls from your request. A next page // token is not returned if there are no more results to display. To get the next // page of results, perform another GetStaticIps request and specify the next page // token using the pageToken parameter. NextPageToken *string + // An array of key-value pairs containing information about your get static IPs + // request. + StaticIps []*types.StaticIp + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/lightsail/api_op_ImportKeyPair.go b/service/lightsail/api_op_ImportKeyPair.go index 0b73f0c1fd0..e07a2ebb8e2 100644 --- a/service/lightsail/api_op_ImportKeyPair.go +++ b/service/lightsail/api_op_ImportKeyPair.go @@ -57,15 +57,15 @@ func (c *Client) ImportKeyPair(ctx context.Context, params *ImportKeyPairInput, type ImportKeyPairInput struct { - // A base64-encoded public key of the ssh-rsa type. + // The name of the key pair for which you want to import the public key. // // This member is required. - PublicKeyBase64 *string + KeyPairName *string - // The name of the key pair for which you want to import the public key. + // A base64-encoded public key of the ssh-rsa type. // // This member is required. - KeyPairName *string + PublicKeyBase64 *string } type ImportKeyPairOutput struct { diff --git a/service/lightsail/api_op_PutAlarm.go b/service/lightsail/api_op_PutAlarm.go index 457ad451ed3..23633b56468 100644 --- a/service/lightsail/api_op_PutAlarm.go +++ b/service/lightsail/api_op_PutAlarm.go @@ -68,51 +68,17 @@ func (c *Client) PutAlarm(ctx context.Context, params *PutAlarmInput, optFns ... type PutAlarmInput struct { - // The name of the Lightsail resource that will be monitored. Instances, load - // balancers, and relational databases are the only Lightsail resources that can - // currently be monitored by alarms. + // The name for the alarm. Specify the name of an existing alarm to update, and + // overwrite the previous configuration of the alarm. // // This member is required. - MonitoredResourceName *string - - // The alarm states that trigger a notification. An alarm has the following - // possible states: - // - // * ALARM - The metric is outside of the defined - // threshold. - // - // * INSUFFICIENT_DATA - The alarm has just started, the metric is - // not available, or not enough data is available for the metric to determine the - // alarm state. - // - // * OK - The metric is within the defined threshold. - // - // When you - // specify a notification trigger, the ALARM state must be specified. The - // INSUFFICIENT_DATA and OK states can be specified in addition to the ALARM - // state. - // - // * If you specify OK as an alarm trigger, a notification is sent when - // the alarm switches from an ALARM or INSUFFICIENT_DATA alarm state to an OK - // state. This can be thought of as an all clear alarm notification. - // - // * If you - // specify INSUFFICIENT_DATA as the alarm trigger, a notification is sent when the - // alarm switches from an OK or ALARM alarm state to an INSUFFICIENT_DATA - // state. - // - // The notification trigger defaults to ALARM if you don't specify this - // parameter. - NotificationTriggers []types.AlarmState + AlarmName *string - // The value against which the specified statistic is compared. + // The arithmetic operation to use when comparing the specified statistic to the + // threshold. The specified statistic value is used as the first operand. // // This member is required. - Threshold *float64 - - // Indicates whether the alarm is enabled. Notifications are enabled by default if - // you don't specify this parameter. - NotificationEnabled *bool + ComparisonOperator types.ComparisonOperator // The number of most recent periods over which data is compared to the specified // threshold. If you are setting an "M out of N" alarm, this value @@ -127,22 +93,6 @@ type PutAlarmInput struct { // This member is required. EvaluationPeriods *int32 - // The name for the alarm. Specify the name of an existing alarm to update, and - // overwrite the previous configuration of the alarm. - // - // This member is required. - AlarmName *string - - // The contact protocols to use for the alarm, such as Email, SMS (text messaging), - // or both. A notification is sent via the specified contact protocol if - // notifications are enabled for the alarm, and when the alarm is triggered. A - // notification is not sent if a contact protocol is not specified, if the - // specified contact protocol is not configured in the AWS Region, or if - // notifications are not enabled for the alarm using the notificationEnabled - // paramater. Use the CreateContactMethod action to configure a contact protocol in - // an AWS Region. - ContactProtocols []types.ContactProtocol - // The name of the metric to associate with the alarm. You can configure up to two // alarms per metric. The following metrics are available for each resource type: // @@ -168,17 +118,67 @@ type PutAlarmInput struct { // This member is required. MetricName types.MetricName - // The arithmetic operation to use when comparing the specified statistic to the - // threshold. The specified statistic value is used as the first operand. + // The name of the Lightsail resource that will be monitored. Instances, load + // balancers, and relational databases are the only Lightsail resources that can + // currently be monitored by alarms. // // This member is required. - ComparisonOperator types.ComparisonOperator + MonitoredResourceName *string + + // The value against which the specified statistic is compared. + // + // This member is required. + Threshold *float64 + + // The contact protocols to use for the alarm, such as Email, SMS (text messaging), + // or both. A notification is sent via the specified contact protocol if + // notifications are enabled for the alarm, and when the alarm is triggered. A + // notification is not sent if a contact protocol is not specified, if the + // specified contact protocol is not configured in the AWS Region, or if + // notifications are not enabled for the alarm using the notificationEnabled + // paramater. Use the CreateContactMethod action to configure a contact protocol in + // an AWS Region. + ContactProtocols []types.ContactProtocol // The number of data points that must be not within the specified threshold to // trigger the alarm. If you are setting an "M out of N" alarm, this value // (datapointsToAlarm) is the M. DatapointsToAlarm *int32 + // Indicates whether the alarm is enabled. Notifications are enabled by default if + // you don't specify this parameter. + NotificationEnabled *bool + + // The alarm states that trigger a notification. An alarm has the following + // possible states: + // + // * ALARM - The metric is outside of the defined + // threshold. + // + // * INSUFFICIENT_DATA - The alarm has just started, the metric is + // not available, or not enough data is available for the metric to determine the + // alarm state. + // + // * OK - The metric is within the defined threshold. + // + // When you + // specify a notification trigger, the ALARM state must be specified. The + // INSUFFICIENT_DATA and OK states can be specified in addition to the ALARM + // state. + // + // * If you specify OK as an alarm trigger, a notification is sent when + // the alarm switches from an ALARM or INSUFFICIENT_DATA alarm state to an OK + // state. This can be thought of as an all clear alarm notification. + // + // * If you + // specify INSUFFICIENT_DATA as the alarm trigger, a notification is sent when the + // alarm switches from an OK or ALARM alarm state to an INSUFFICIENT_DATA + // state. + // + // The notification trigger defaults to ALARM if you don't specify this + // parameter. + NotificationTriggers []types.AlarmState + // Sets how this alarm will handle missing data points. An alarm can treat missing // data in the following ways: // diff --git a/service/lightsail/api_op_StopRelationalDatabase.go b/service/lightsail/api_op_StopRelationalDatabase.go index 5e753d88220..630452a800b 100644 --- a/service/lightsail/api_op_StopRelationalDatabase.go +++ b/service/lightsail/api_op_StopRelationalDatabase.go @@ -61,14 +61,14 @@ func (c *Client) StopRelationalDatabase(ctx context.Context, params *StopRelatio type StopRelationalDatabaseInput struct { - // The name of your new database snapshot to be created before stopping your - // database. - RelationalDatabaseSnapshotName *string - // The name of your database to stop. // // This member is required. RelationalDatabaseName *string + + // The name of your new database snapshot to be created before stopping your + // database. + RelationalDatabaseSnapshotName *string } type StopRelationalDatabaseOutput struct { diff --git a/service/lightsail/api_op_TagResource.go b/service/lightsail/api_op_TagResource.go index a0a9f9b371f..3b5f625bedf 100644 --- a/service/lightsail/api_op_TagResource.go +++ b/service/lightsail/api_op_TagResource.go @@ -65,9 +65,6 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The Amazon Resource Name (ARN) of the resource to which you want to add a tag. - ResourceArn *string - // The name of the resource to which you are adding tags. // // This member is required. @@ -77,6 +74,9 @@ type TagResourceInput struct { // // This member is required. Tags []*types.Tag + + // The Amazon Resource Name (ARN) of the resource to which you want to add a tag. + ResourceArn *string } type TagResourceOutput struct { diff --git a/service/lightsail/api_op_TestAlarm.go b/service/lightsail/api_op_TestAlarm.go index 1a9a02e50b5..5991f3fd188 100644 --- a/service/lightsail/api_op_TestAlarm.go +++ b/service/lightsail/api_op_TestAlarm.go @@ -64,6 +64,11 @@ func (c *Client) TestAlarm(ctx context.Context, params *TestAlarmInput, optFns . type TestAlarmInput struct { + // The name of the alarm to test. + // + // This member is required. + AlarmName *string + // The alarm state to test. An alarm has the following possible states that can be // tested: // @@ -78,11 +83,6 @@ type TestAlarmInput struct { // // This member is required. State types.AlarmState - - // The name of the alarm to test. - // - // This member is required. - AlarmName *string } type TestAlarmOutput struct { diff --git a/service/lightsail/api_op_UpdateDistribution.go b/service/lightsail/api_op_UpdateDistribution.go index 4c8af0d38cd..6953f4f08f5 100644 --- a/service/lightsail/api_op_UpdateDistribution.go +++ b/service/lightsail/api_op_UpdateDistribution.go @@ -59,8 +59,12 @@ func (c *Client) UpdateDistribution(ctx context.Context, params *UpdateDistribut type UpdateDistributionInput struct { - // An object that describes the default cache behavior for the distribution. - DefaultCacheBehavior *types.CacheBehavior + // The name of the distribution to update.

    Use the + // GetDistributions action to get a list of distribution names that + // you can specify.

    + // + // This member is required. + DistributionName *string // An object that describes the cache behavior settings for the distribution. The // cacheBehaviorSettings specified in your UpdateDistributionRequest will replace @@ -71,6 +75,9 @@ type UpdateDistributionInput struct { // distribution. CacheBehaviors []*types.CacheBehaviorPerPath + // An object that describes the default cache behavior for the distribution. + DefaultCacheBehavior *types.CacheBehavior + // Indicates whether to enable the distribution. IsEnabled *bool @@ -78,13 +85,6 @@ type UpdateDistributionInput struct { // Lightsail instance or load balancer.

    The distribution pulls, caches, and // serves content from the origin.

    Origin *types.InputOrigin - - // The name of the distribution to update.

    Use the - // GetDistributions action to get a list of distribution names that - // you can specify.

    - // - // This member is required. - DistributionName *string } type UpdateDistributionOutput struct { diff --git a/service/lightsail/api_op_UpdateLoadBalancerAttribute.go b/service/lightsail/api_op_UpdateLoadBalancerAttribute.go index 45905ab9afd..f93a146381c 100644 --- a/service/lightsail/api_op_UpdateLoadBalancerAttribute.go +++ b/service/lightsail/api_op_UpdateLoadBalancerAttribute.go @@ -61,20 +61,20 @@ func (c *Client) UpdateLoadBalancerAttribute(ctx context.Context, params *Update type UpdateLoadBalancerAttributeInput struct { - // The name of the load balancer that you want to modify (e.g., my-load-balancer. + // The name of the attribute you want to update. Valid values are below. // // This member is required. - LoadBalancerName *string + AttributeName types.LoadBalancerAttributeName // The value that you want to specify for the attribute name. // // This member is required. AttributeValue *string - // The name of the attribute you want to update. Valid values are below. + // The name of the load balancer that you want to modify (e.g., my-load-balancer. // // This member is required. - AttributeName types.LoadBalancerAttributeName + LoadBalancerName *string } type UpdateLoadBalancerAttributeOutput struct { diff --git a/service/lightsail/api_op_UpdateRelationalDatabase.go b/service/lightsail/api_op_UpdateRelationalDatabase.go index b2e21a159c9..39300f91c02 100644 --- a/service/lightsail/api_op_UpdateRelationalDatabase.go +++ b/service/lightsail/api_op_UpdateRelationalDatabase.go @@ -63,6 +63,34 @@ func (c *Client) UpdateRelationalDatabase(ctx context.Context, params *UpdateRel type UpdateRelationalDatabaseInput struct { + // The name of your database to update. + // + // This member is required. + RelationalDatabaseName *string + + // When true, applies changes immediately. When false, applies changes during the + // preferred maintenance window. Some changes may cause an outage. Default: false + ApplyImmediately *bool + + // Indicates the certificate that needs to be associated with the database. + CaCertificateIdentifier *string + + // When true, disables automated backup retention for your database. Disabling + // backup retention deletes all automated database backups. Before disabling this, + // you may want to create a snapshot of your database using the create relational + // database snapshot operation. Updates are applied during the next maintenance + // window because this can result in an outage. + DisableBackupRetention *bool + + // When true, enables automated backup retention for your database. Updates are + // applied during the next maintenance window because this can result in an outage. + EnableBackupRetention *bool + + // The password for the master user of your database. The password can include any + // printable ASCII character except "/", """, or "@". Constraints: Must contain 8 + // to 41 characters. + MasterUserPassword *string + // The daily time range during which automated backups are created for your // database if automated backups are enabled. Constraints: // @@ -78,27 +106,6 @@ type UpdateRelationalDatabaseInput struct { // * Must be at least 30 minutes. PreferredBackupWindow *string - // The name of your database to update. - // - // This member is required. - RelationalDatabaseName *string - - // Indicates the certificate that needs to be associated with the database. - CaCertificateIdentifier *string - - // When true, the master user password is changed to a new strong password - // generated by Lightsail. Use the get relational database master user password - // operation to get the new password. - RotateMasterUserPassword *bool - - // When true, enables automated backup retention for your database. Updates are - // applied during the next maintenance window because this can result in an outage. - EnableBackupRetention *bool - - // When true, applies changes immediately. When false, applies changes during the - // preferred maintenance window. Some changes may cause an outage. Default: false - ApplyImmediately *bool - // The weekly time range during which system maintenance can occur on your // database. The default is a 30-minute window selected at random from an 8-hour // block of time for each AWS Region, occurring on a random day of the week. @@ -118,23 +125,16 @@ type UpdateRelationalDatabaseInput struct { // Tue:17:00-Tue:17:30 PreferredMaintenanceWindow *string - // The password for the master user of your database. The password can include any - // printable ASCII character except "/", """, or "@". Constraints: Must contain 8 - // to 41 characters. - MasterUserPassword *string - - // When true, disables automated backup retention for your database. Disabling - // backup retention deletes all automated database backups. Before disabling this, - // you may want to create a snapshot of your database using the create relational - // database snapshot operation. Updates are applied during the next maintenance - // window because this can result in an outage. - DisableBackupRetention *bool - // Specifies the accessibility options for your database. A value of true specifies // a database that is available to resources outside of your Lightsail account. A // value of false specifies a database that is available only to your Lightsail // resources in the same region as your database. PubliclyAccessible *bool + + // When true, the master user password is changed to a new strong password + // generated by Lightsail. Use the get relational database master user password + // operation to get the new password. + RotateMasterUserPassword *bool } type UpdateRelationalDatabaseOutput struct { diff --git a/service/lightsail/api_op_UpdateRelationalDatabaseParameters.go b/service/lightsail/api_op_UpdateRelationalDatabaseParameters.go index 0f9922d5831..465a8afcfd3 100644 --- a/service/lightsail/api_op_UpdateRelationalDatabaseParameters.go +++ b/service/lightsail/api_op_UpdateRelationalDatabaseParameters.go @@ -67,15 +67,15 @@ func (c *Client) UpdateRelationalDatabaseParameters(ctx context.Context, params type UpdateRelationalDatabaseParametersInput struct { - // The name of your database for which to update parameters. + // The database parameters to update. // // This member is required. - RelationalDatabaseName *string + Parameters []*types.RelationalDatabaseParameter - // The database parameters to update. + // The name of your database for which to update parameters. // // This member is required. - Parameters []*types.RelationalDatabaseParameter + RelationalDatabaseName *string } type UpdateRelationalDatabaseParametersOutput struct { diff --git a/service/lightsail/go.mod b/service/lightsail/go.mod index d2266cb494c..8a280d7a506 100644 --- a/service/lightsail/go.mod +++ b/service/lightsail/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/lightsail go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/lightsail/types/types.go b/service/lightsail/types/types.go index 3dd1d55d522..f5db5c104ee 100644 --- a/service/lightsail/types/types.go +++ b/service/lightsail/types/types.go @@ -9,14 +9,14 @@ import ( // Describes an add-on that is enabled for an Amazon Lightsail resource. type AddOn struct { + // The name of the add-on. + Name *string + // The next daily time an automatic snapshot will be created. The time shown is in // HH:00 format, and in Coordinated Universal Time (UTC). The snapshot is // automatically created between the time shown and up to 45 minutes after. NextSnapshotTimeOfDay *string - // The name of the add-on. - Name *string - // The daily time when an automatic snapshot is created. The time shown is in HH:00 // format, and in Coordinated Universal Time (UTC). The snapshot is automatically // created between the time shown and up to 45 minutes after. @@ -47,69 +47,64 @@ type AddOnRequest struct { // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms). type Alarm struct { - // The current state of the alarm. An alarm has the following possible states: - // - // - // * ALARM - The metric is outside of the defined threshold. - // - // * - // INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or - // not enough data is available for the metric to determine the alarm state. - // - // * - // OK - The metric is within the defined threshold. - State AlarmState - - // An object that lists information about the location of the alarm. - Location *ResourceLocation - - // The value against which the specified statistic is compared. - Threshold *float64 - - // The alarm states that trigger a notification. - NotificationTriggers []AlarmState - - // The unit of the metric associated with the alarm. - Unit MetricUnit + // The Amazon Resource Name (ARN) of the alarm. + Arn *string - // The name of the metric associated with the alarm. - MetricName MetricName + // The arithmetic operation used when comparing the specified statistic and + // threshold. + ComparisonOperator ComparisonOperator // The contact protocols for the alarm, such as Email, SMS (text messaging), or // both. ContactProtocols []ContactProtocol - // The arithmetic operation used when comparing the specified statistic and - // threshold. - ComparisonOperator ComparisonOperator + // The timestamp when the alarm was created. + CreatedAt *time.Time // The number of data points that must not within the specified threshold to // trigger the alarm. DatapointsToAlarm *int32 - // The support code. Include this code in your email to support when you have - // questions about your Lightsail alarm. This code enables our support team to look - // up your Lightsail information more easily. - SupportCode *string + // The number of periods over which data is compared to the specified threshold. + EvaluationPeriods *int32 - // The Lightsail resource type (e.g., Alarm). - ResourceType ResourceType + // An object that lists information about the location of the alarm. + Location *ResourceLocation - // The name of the alarm. - Name *string + // The name of the metric associated with the alarm. + MetricName MetricName - // The number of periods over which data is compared to the specified threshold. - EvaluationPeriods *int32 + // An object that lists information about the resource monitored by the alarm. + MonitoredResourceInfo *MonitoredResourceInfo - // The Amazon Resource Name (ARN) of the alarm. - Arn *string + // The name of the alarm. + Name *string // Indicates whether the alarm is enabled. NotificationEnabled *bool + // The alarm states that trigger a notification. + NotificationTriggers []AlarmState + // The period, in seconds, over which the statistic is applied. Period *int32 + // The Lightsail resource type (e.g., Alarm). + ResourceType ResourceType + + // The current state of the alarm. An alarm has the following possible states: + // + // + // * ALARM - The metric is outside of the defined threshold. + // + // * + // INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or + // not enough data is available for the metric to determine the alarm state. + // + // * + // OK - The metric is within the defined threshold. + State AlarmState + // The statistic for the metric associated with the alarm. The following statistics // are available: // @@ -135,8 +130,13 @@ type Alarm struct { // points used for the statistical calculation. Statistic MetricStatistic - // The timestamp when the alarm was created. - CreatedAt *time.Time + // The support code. Include this code in your email to support when you have + // questions about your Lightsail alarm. This code enables our support team to look + // up your Lightsail information more easily. + SupportCode *string + + // The value against which the specified statistic is compared. + Threshold *float64 // Specifies how the alarm handles missing data points. An alarm can treat missing // data in the following ways: @@ -156,8 +156,8 @@ type Alarm struct { // missing. TreatMissingData TreatMissingData - // An object that lists information about the resource monitored by the alarm. - MonitoredResourceInfo *MonitoredResourceInfo + // The unit of the metric associated with the alarm. + Unit MetricUnit } // Describes a block storage disk that is attached to an instance, and is included @@ -221,18 +221,18 @@ type AutoSnapshotAddOnRequest struct { // Describes an automatic snapshot. type AutoSnapshotDetails struct { - // The status of the automatic snapshot. - Status AutoSnapshotStatus - - // An array of objects that describe the block storage disks attached to the - // instance when the automatic snapshot was created. - FromAttachedDisks []*AttachedDisk - // The timestamp when the automatic snapshot was created. CreatedAt *time.Time // The date of the automatic snapshot in YYYY-MM-DD format. Date *string + + // An array of objects that describe the block storage disks attached to the + // instance when the automatic snapshot was created. + FromAttachedDisks []*AttachedDisk + + // The status of the automatic snapshot. + Status AutoSnapshotStatus } // Describes an Availability Zone. @@ -248,8 +248,15 @@ type AvailabilityZone struct { // Describes a blueprint (a virtual private server image). type Blueprint struct { - // The friendly name of the blueprint (e.g., Amazon Linux). - Name *string + // The ID for the virtual private server image (e.g., app_wordpress_4_4 or + // app_lamp_7_0). + BlueprintId *string + + // The description of the blueprint. + Description *string + + // The group name of the blueprint (e.g., amazon-linux). + Group *string // A Boolean value indicating whether the blueprint is active. Inactive blueprints // are listed to support customers with existing instances but are not necessarily @@ -260,49 +267,45 @@ type Blueprint struct { // The end-user license agreement URL for the image or blueprint. LicenseUrl *string - // The version number of the operating system, application, or stack (e.g., - // 2016.03.0). - Version *string - - // The product URL to learn more about the image or blueprint. - ProductUrl *string - - // The type of the blueprint (e.g., os or app). - Type BlueprintType - // The minimum bundle power required to run this blueprint. For example, you need a // bundle with a power value of 500 or more to create an instance that uses a // blueprint with a minimum power value of 500. 0 indicates that the blueprint runs // on all instance sizes. MinPower *int32 - // The group name of the blueprint (e.g., amazon-linux). - Group *string - - // The version code. - VersionCode *string + // The friendly name of the blueprint (e.g., Amazon Linux). + Name *string // The operating system platform (either Linux/Unix-based or Windows Server-based) // of the blueprint. Platform InstancePlatform - // The description of the blueprint. - Description *string + // The product URL to learn more about the image or blueprint. + ProductUrl *string - // The ID for the virtual private server image (e.g., app_wordpress_4_4 or - // app_lamp_7_0). - BlueprintId *string + // The type of the blueprint (e.g., os or app). + Type BlueprintType + + // The version number of the operating system, application, or stack (e.g., + // 2016.03.0). + Version *string + + // The version code. + VersionCode *string } // Describes a bundle, which is a set of specs describing your virtual private // server (or instance). type Bundle struct { + // The bundle ID (e.g., micro_1_0). + BundleId *string + // The number of vCPUs included in the bundle (e.g., 2). CpuCount *int32 - // The price in US dollars (e.g., 5.0) of the bundle. - Price *float32 + // The size of the SSD (e.g., 30). + DiskSizeInGb *int32 // The Amazon EC2 instance type (e.g., t2.micro). InstanceType *string @@ -310,8 +313,8 @@ type Bundle struct { // A Boolean value indicating whether the bundle is active. IsActive *bool - // The data transfer rate per month in GB (e.g., 2000). - TransferPerMonthInGb *int32 + // A friendly name for the bundle (e.g., Micro). + Name *string // A numeric value that represents the power of the bundle (e.g., 500). You can use // the bundle's power value in conjunction with a blueprint's minimum power value @@ -320,11 +323,11 @@ type Bundle struct { // blueprint with a minimum power value of 500. Power *int32 - // The size of the SSD (e.g., 30). - DiskSizeInGb *int32 + // The price in US dollars (e.g., 5.0) of the bundle. + Price *float32 - // The bundle ID (e.g., micro_1_0). - BundleId *string + // The amount of RAM in GB (e.g., 2.0). + RamSizeInGb *float32 // The operating system platform (Linux/Unix-based or Windows Server-based) that // the bundle supports. You can only launch a WINDOWS bundle on a blueprint that @@ -332,11 +335,8 @@ type Bundle struct { // bundle. SupportedPlatforms []InstancePlatform - // A friendly name for the bundle (e.g., Micro). - Name *string - - // The amount of RAM in GB (e.g., 2.0). - RamSizeInGb *float32 + // The data transfer rate per month in GB (e.g., 2000). + TransferPerMonthInGb *int32 } // Describes the default cache behavior of an Amazon Lightsail content delivery @@ -403,29 +403,6 @@ type CacheBehaviorPerPath struct { // that have a behavior of cache.

    type CacheSettings struct { - // An object that describes the headers that are forwarded to the origin. Your - // content is cached based on the headers that are forwarded. - ForwardedHeaders *HeaderObject - - // The default amount of time that objects stay in the distribution's cache before - // the distribution forwards another request to the origin to determine whether the - // content has been updated.

    The value specified applies only when the - // origin does not add HTTP headers such as Cache-Control max-age, - // Cache-Control s-maxage, and Expires to objects.

    - //     - DefaultTTL *int64 - - // An object that describes the cookies that are forwarded to the origin. Your - // content is cached based on the cookies that are forwarded. - ForwardedCookies *CookieObject - - // The minimum amount of time that objects stay in the distribution's cache before - // the distribution forwards another request to the origin to determine whether the - // object has been updated.

    A value of 0 must be specified for - // minimumTTL if the distribution is configured to forward all headers - // to the origin.

    - MinimumTTL *int64 - // The HTTP methods that are processed and forwarded to the distribution's origin. //

    You can specify the following options:

    CachedHTTPMethods *string + // The default amount of time that objects stay in the distribution's cache before + // the distribution forwards another request to the origin to determine whether the + // content has been updated.

    The value specified applies only when the + // origin does not add HTTP headers such as Cache-Control max-age, + // Cache-Control s-maxage, and Expires to objects.

    + //     + DefaultTTL *int64 + + // An object that describes the cookies that are forwarded to the origin. Your + // content is cached based on the cookies that are forwarded. + ForwardedCookies *CookieObject + + // An object that describes the headers that are forwarded to the origin. Your + // content is cached based on the headers that are forwarded. + ForwardedHeaders *HeaderObject + + // An object that describes the query strings that are forwarded to the origin. + // Your content is cached based on the query strings that are forwarded. + ForwardedQueryStrings *QueryStringObject + // The maximum amount of time that objects stay in the distribution's cache before // the distribution forwards another request to the origin to determine whether the // object has been updated.

    The value specified applies only when the origin @@ -456,9 +453,12 @@ type CacheSettings struct { // Cache-Control s-maxage, and Expires to objects.

    MaximumTTL *int64 - // An object that describes the query strings that are forwarded to the origin. - // Your content is cached based on the query strings that are forwarded. - ForwardedQueryStrings *QueryStringObject + // The minimum amount of time that objects stay in the distribution's cache before + // the distribution forwards another request to the origin to determine whether the + // object has been updated.

    A value of 0 must be specified for + // minimumTTL if the distribution is configured to forward all headers + // to the origin.

    + MinimumTTL *int64 } // Describes the full details of an Amazon Lightsail SSL/TLS certificate. @@ -468,41 +468,44 @@ type CacheSettings struct { // certificate name, domain name, and tags.

     type Certificate struct { - // The timestamp when the certificate was revoked. This value is present only when - // the certificate status is REVOKED. - RevokedAt *time.Time - - // The tag keys and optional values for the resource. For more information about - // tags in Lightsail, see the Lightsail Dev Guide - // (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). - Tags []*Tag - - // The validation status of the certificate. - Status CertificateStatus - - // The reason the certificate was revoked. This value is present only when the - // certificate status is REVOKED. - RevocationReason *string + // The Amazon Resource Name (ARN) of the certificate. + Arn *string // The timestamp when the certificate was created. CreatedAt *time.Time - // An array of strings that specify the alternate domains (e.g., example2.com) and - // subdomains (e.g., blog.example.com) of the certificate. - SubjectAlternativeNames []*string - // The domain name of the certificate. DomainName *string - // The number of Lightsail resources that the certificate is attached to. - InUseResourceCount *int32 - - // The timestamp when the certificate was issued. - IssuedAt *time.Time + // An array of objects that describe the domain validation records of the + // certificate. + DomainValidationRecords []*DomainValidationRecord // The renewal eligibility of the certificate. EligibleToRenew *string + // The number of Lightsail resources that the certificate is attached to. + InUseResourceCount *int32 + + // The timestamp when the certificate was issued. + IssuedAt *time.Time + + // The certificate authority that issued the certificate. + IssuerCA *string + + // The algorithm used to generate the key pair (the public and private key) of the + // certificate. + KeyAlgorithm *string + + // The name of the certificate (e.g., my-certificate). + Name *string + + // The timestamp when the certificate expires. + NotAfter *time.Time + + // The timestamp when the certificate is first valid. + NotBefore *time.Time + // An object that describes the status of the certificate renewal managed by // Lightsail. RenewalSummary *RenewalSummary @@ -547,48 +550,37 @@ type Certificate struct { // typos that were in the failed request.

    RequestFailureReason *string - // The name of the certificate (e.g., my-certificate). - Name *string - - // The algorithm used to generate the key pair (the public and private key) of the - // certificate. - KeyAlgorithm *string - - // The support code. Include this code in your email to support when you have - // questions about your Lightsail certificate. This code enables our support team - // to look up your Lightsail information more easily. - SupportCode *string - - // The Amazon Resource Name (ARN) of the certificate. - Arn *string - - // The timestamp when the certificate is first valid. - NotBefore *time.Time - - // An array of objects that describe the domain validation records of the - // certificate. - DomainValidationRecords []*DomainValidationRecord + // The reason the certificate was revoked. This value is present only when the + // certificate status is REVOKED. + RevocationReason *string - // The certificate authority that issued the certificate. - IssuerCA *string + // The timestamp when the certificate was revoked. This value is present only when + // the certificate status is REVOKED. + RevokedAt *time.Time // The serial number of the certificate. SerialNumber *string - // The timestamp when the certificate expires. - NotAfter *time.Time -} + // The validation status of the certificate. + Status CertificateStatus -// Describes an Amazon Lightsail SSL/TLS certificate. -type CertificateSummary struct { + // An array of strings that specify the alternate domains (e.g., example2.com) and + // subdomains (e.g., blog.example.com) of the certificate. + SubjectAlternativeNames []*string - // The domain name of the certificate. - DomainName *string + // The support code. Include this code in your email to support when you have + // questions about your Lightsail certificate. This code enables our support team + // to look up your Lightsail information more easily. + SupportCode *string // The tag keys and optional values for the resource. For more information about // tags in Lightsail, see the Lightsail Dev Guide // (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). Tags []*Tag +} + +// Describes an Amazon Lightsail SSL/TLS certificate. +type CertificateSummary struct { // The Amazon Resource Name (ARN) of the certificate. CertificateArn *string @@ -598,6 +590,14 @@ type CertificateSummary struct { // The name of the certificate. CertificateName *string + + // The domain name of the certificate. + DomainName *string + + // The tag keys and optional values for the resource. For more information about + // tags in Lightsail, see the Lightsail Dev Guide + // (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). + Tags []*Tag } // Describes a CloudFormation stack record created as a result of the create cloud @@ -606,12 +606,8 @@ type CertificateSummary struct { // Cloud instance from an exported Lightsail instance snapshot. type CloudFormationStackRecord struct { - // The Lightsail resource type (e.g., CloudFormationStackRecord). - ResourceType ResourceType - - // A list of objects describing the Availability Zone and AWS Region of the - // CloudFormation stack record. - Location *ResourceLocation + // The Amazon Resource Name (ARN) of the CloudFormation stack record. + Arn *string // The date when the CloudFormation stack record was created. CreatedAt *time.Time @@ -621,32 +617,36 @@ type CloudFormationStackRecord struct { // stack. DestinationInfo *DestinationInfo - // The current state of the CloudFormation stack record. - State RecordState + // A list of objects describing the Availability Zone and AWS Region of the + // CloudFormation stack record. + Location *ResourceLocation - // The Amazon Resource Name (ARN) of the CloudFormation stack record. - Arn *string + // The name of the CloudFormation stack record. It starts with + // CloudFormationStackRecord followed by a GUID. + Name *string + + // The Lightsail resource type (e.g., CloudFormationStackRecord). + ResourceType ResourceType // A list of objects describing the source of the CloudFormation stack record. SourceInfo []*CloudFormationStackRecordSourceInfo - // The name of the CloudFormation stack record. It starts with - // CloudFormationStackRecord followed by a GUID. - Name *string + // The current state of the CloudFormation stack record. + State RecordState } // Describes the source of a CloudFormation stack record (i.e., the export snapshot // record). type CloudFormationStackRecordSourceInfo struct { - // The Lightsail resource type (e.g., ExportSnapshotRecord). - ResourceType CloudFormationStackRecordSourceType + // The Amazon Resource Name (ARN) of the export snapshot record. + Arn *string // The name of the record. Name *string - // The Amazon Resource Name (ARN) of the export snapshot record. - Arn *string + // The Lightsail resource type (e.g., ExportSnapshotRecord). + ResourceType CloudFormationStackRecordSourceType } // Describes a contact method. A contact method is a way to send you notifications. @@ -657,20 +657,24 @@ type ContactMethod struct { // The Amazon Resource Name (ARN) of the contact method. Arn *string - // The protocol of the contact method, such as email or SMS (text messaging). - Protocol ContactProtocol - - // The support code. Include this code in your email to support when you have - // questions about your Lightsail contact method. This code enables our support - // team to look up your Lightsail information more easily. - SupportCode *string + // The destination of the contact method, such as an email address or a mobile + // phone number. + ContactEndpoint *string // The timestamp when the contact method was created. CreatedAt *time.Time - // The destination of the contact method, such as an email address or a mobile - // phone number. - ContactEndpoint *string + // Describes the resource location. + Location *ResourceLocation + + // The name of the contact method. + Name *string + + // The protocol of the contact method, such as email or SMS (text messaging). + Protocol ContactProtocol + + // The Lightsail resource type (e.g., ContactMethod). + ResourceType ResourceType // The current status of the contact method. A contact method has the following // possible status: @@ -685,14 +689,10 @@ type ContactMethod struct { // the contact method, but the verification has expired. Status ContactMethodStatus - // Describes the resource location. - Location *ResourceLocation - - // The Lightsail resource type (e.g., ContactMethod). - ResourceType ResourceType - - // The name of the contact method. - Name *string + // The support code. Include this code in your email to support when you have + // questions about your Lightsail contact method. This code enables our support + // team to look up your Lightsail information more easily. + SupportCode *string } // Describes whether an Amazon Lightsail content delivery network (CDN) @@ -701,87 +701,87 @@ type ContactMethod struct { // specified content based on the cookie values in viewer requests.

    type CookieObject struct { + // The specific cookies to forward to your distribution's origin. + CookiesAllowList []*string + // Specifies which cookies to forward to the distribution's origin for a cache // behavior: all, none, or allow-list to forward only the cookies specified in the // cookiesAllowList parameter. Option ForwardValues - - // The specific cookies to forward to your distribution's origin. - CookiesAllowList []*string } // Describes the destination of a record. type DestinationInfo struct { - // The destination service of the record. - Service *string - // The ID of the resource created at the destination. Id *string + + // The destination service of the record. + Service *string } // Describes a system disk or a block storage disk. type Disk struct { + // An array of objects representing the add-ons enabled on the disk. + AddOns []*AddOn + + // The Amazon Resource Name (ARN) of the disk. + Arn *string + + // The resources to which the disk is attached. + AttachedTo *string + // (Deprecated) The attachment state of the disk. In releases prior to November 14, // 2017, this parameter returned attached for system disks in the API response. It // is now deprecated, but still included in the response. Use isAttached instead. AttachmentState *string + // The date when the disk was created. + CreatedAt *time.Time + // (Deprecated) The number of GB in use by the disk. In releases prior to November // 14, 2017, this parameter was not included in the API response. It is now // deprecated. GbInUse *int32 - // The date when the disk was created. - CreatedAt *time.Time - // The input/output operations per second (IOPS) of the disk. Iops *int32 - // The disk path. - Path *string - - // The resources to which the disk is attached. - AttachedTo *string - - // The tag keys and optional values for the resource. For more information about - // tags in Lightsail, see the Lightsail Dev Guide - // (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). - Tags []*Tag + // A Boolean value indicating whether the disk is attached. + IsAttached *bool - // Describes the status of the disk. - State DiskState + // A Boolean value indicating whether this disk is a system disk (has an operating + // system loaded on it). + IsSystemDisk *bool // The AWS Region and Availability Zone where the disk is located. Location *ResourceLocation - // A Boolean value indicating whether this disk is a system disk (has an operating - // system loaded on it). - IsSystemDisk *bool + // The unique name of the disk. + Name *string + + // The disk path. + Path *string + + // The Lightsail resource type (e.g., Disk). + ResourceType ResourceType // The size of the disk in GB. SizeInGb *int32 - // An array of objects representing the add-ons enabled on the disk. - AddOns []*AddOn + // Describes the status of the disk. + State DiskState // The support code. Include this code in your email to support when you have // questions about an instance or another resource in Lightsail. This code enables // our support team to look up your Lightsail information more easily. SupportCode *string - // The Amazon Resource Name (ARN) of the disk. - Arn *string - - // The Lightsail resource type (e.g., Disk). - ResourceType ResourceType - - // The unique name of the disk. - Name *string - - // A Boolean value indicating whether the disk is attached. - IsAttached *bool + // The tag keys and optional values for the resource. For more information about + // tags in Lightsail, see the Lightsail Dev Guide + // (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). + Tags []*Tag } // Describes a disk. @@ -791,12 +791,12 @@ type DiskInfo struct { // system loaded on it). IsSystemDisk *bool - // The disk path. - Path *string - // The disk name. Name *string + // The disk path. + Path *string + // The size of the disk in GB (e.g., 32). SizeInGb *int32 } @@ -804,68 +804,68 @@ type DiskInfo struct { // Describes a block storage disk mapping. type DiskMap struct { - // The original disk path exposed to the instance (for example, /dev/sdh). - OriginalDiskPath *string - // The new disk name (e.g., my-new-disk). NewDiskName *string + + // The original disk path exposed to the instance (for example, /dev/sdh). + OriginalDiskPath *string } // Describes a block storage disk snapshot. type DiskSnapshot struct { - // The support code. Include this code in your email to support when you have - // questions about an instance or another resource in Lightsail. This code enables - // our support team to look up your Lightsail information more easily. - SupportCode *string + // The Amazon Resource Name (ARN) of the disk snapshot. + Arn *string - // The AWS Region and Availability Zone where the disk snapshot was created. - Location *ResourceLocation + // The date when the disk snapshot was created. + CreatedAt *time.Time - // The status of the disk snapshot operation. - State DiskSnapshotState + // The Amazon Resource Name (ARN) of the source disk from which the disk snapshot + // was created. + FromDiskArn *string - // The Lightsail resource type (e.g., DiskSnapshot). - ResourceType ResourceType + // The unique name of the source disk from which the disk snapshot was created. + FromDiskName *string + + // The Amazon Resource Name (ARN) of the source instance from which the disk + // (system volume) snapshot was created. + FromInstanceArn *string // The unique name of the source instance from which the disk (system volume) // snapshot was created. FromInstanceName *string - // The progress of the disk snapshot operation. - Progress *string + // A Boolean value indicating whether the snapshot was created from an automatic + // snapshot. + IsFromAutoSnapshot *bool - // The Amazon Resource Name (ARN) of the source instance from which the disk - // (system volume) snapshot was created. - FromInstanceArn *string + // The AWS Region and Availability Zone where the disk snapshot was created. + Location *ResourceLocation // The name of the disk snapshot (e.g., my-disk-snapshot). Name *string - // The Amazon Resource Name (ARN) of the disk snapshot. - Arn *string - - // A Boolean value indicating whether the snapshot was created from an automatic - // snapshot. - IsFromAutoSnapshot *bool + // The progress of the disk snapshot operation. + Progress *string - // The date when the disk snapshot was created. - CreatedAt *time.Time + // The Lightsail resource type (e.g., DiskSnapshot). + ResourceType ResourceType // The size of the disk in GB. SizeInGb *int32 - // The Amazon Resource Name (ARN) of the source disk from which the disk snapshot - // was created. - FromDiskArn *string + // The status of the disk snapshot operation. + State DiskSnapshotState + + // The support code. Include this code in your email to support when you have + // questions about an instance or another resource in Lightsail. This code enables + // our support team to look up your Lightsail information more easily. + SupportCode *string // The tag keys and optional values for the resource. For more information about // tags in Lightsail, see the Lightsail Dev Guide // (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). Tags []*Tag - - // The unique name of the source disk from which the disk snapshot was created. - FromDiskName *string } // Describes a disk snapshot. @@ -878,34 +878,41 @@ type DiskSnapshotInfo struct { // Describes the specifications of a distribution bundle. type DistributionBundle struct { - // The name of the distribution bundle. - Name *string - // The ID of the bundle. BundleId *string - // The monthly network transfer quota of the bundle. - TransferPerMonthInGb *int32 - // Indicates whether the bundle is active, and can be specified for a new // distribution. IsActive *bool + // The name of the distribution bundle. + Name *string + // The monthly price, in US dollars, of the bundle. Price *float32 + + // The monthly network transfer quota of the bundle. + TransferPerMonthInGb *int32 } // Describes a domain where you are storing recordsets in Lightsail. type Domain struct { - // The AWS Region and Availability Zones where the domain recordset was created. - Location *ResourceLocation + // The Amazon Resource Name (ARN) of the domain recordset (e.g., + // arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE). + Arn *string + + // The date when the domain recordset was created. + CreatedAt *time.Time // An array of key-value pairs containing information about the domain entries. DomainEntries []*DomainEntry - // The date when the domain recordset was created. - CreatedAt *time.Time + // The AWS Region and Availability Zones where the domain recordset was created. + Location *ResourceLocation + + // The name of the domain. + Name *string // The resource type. ResourceType ResourceType @@ -915,31 +922,23 @@ type Domain struct { // our support team to look up your Lightsail information more easily. SupportCode *string - // The name of the domain. - Name *string - // The tag keys and optional values for the resource. For more information about // tags in Lightsail, see the Lightsail Dev Guide // (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). Tags []*Tag - - // The Amazon Resource Name (ARN) of the domain recordset (e.g., - // arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE). - Arn *string } // Describes a domain recordset entry. type DomainEntry struct { - // The target AWS name server (e.g., ns-111.awsdns-22.com.). For Lightsail load - // balancers, the value looks like - // ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. Be sure - // to also set isAlias to true when setting up an A record for a load balancer. - Target *string - // The ID of the domain recordset entry. Id *string + // When true, specifies whether the domain entry is an alias used by the Lightsail + // load balancer. You can include an alias (A type) record in your request, which + // points to a load balancer DNS name and routes traffic to your load balancer + IsAlias *bool + // The name of the domain. Name *string @@ -947,10 +946,11 @@ type DomainEntry struct { // 2017, this parameter was not included in the API response. It is now deprecated. Options map[string]*string - // When true, specifies whether the domain entry is an alias used by the Lightsail - // load balancer. You can include an alias (A type) record in your request, which - // points to a load balancer DNS name and routes traffic to your load balancer - IsAlias *bool + // The target AWS name server (e.g., ns-111.awsdns-22.com.). For Lightsail load + // balancers, the value looks like + // ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. Be sure + // to also set isAlias to true when setting up an A record for a load balancer. + Target *string // The type of domain entry, such as address (A), canonical name (CNAME), mail // exchanger (MX), name server (NS), start of authority (SOA), service locator @@ -992,20 +992,11 @@ type ExportSnapshotRecord struct { // The Amazon Resource Name (ARN) of the export snapshot record. Arn *string - // A list of objects describing the source of the export snapshot record. - SourceInfo *ExportSnapshotRecordSourceInfo - - // The state of the export snapshot record. - State RecordState - - // A list of objects describing the destination of the export snapshot record. - DestinationInfo *DestinationInfo - // The date when the export snapshot record was created. CreatedAt *time.Time - // The Lightsail resource type (e.g., ExportSnapshotRecord). - ResourceType ResourceType + // A list of objects describing the destination of the export snapshot record. + DestinationInfo *DestinationInfo // The AWS Region and Availability Zone where the export snapshot record is // located. @@ -1013,32 +1004,41 @@ type ExportSnapshotRecord struct { // The export snapshot record name. Name *string + + // The Lightsail resource type (e.g., ExportSnapshotRecord). + ResourceType ResourceType + + // A list of objects describing the source of the export snapshot record. + SourceInfo *ExportSnapshotRecordSourceInfo + + // The state of the export snapshot record. + State RecordState } // Describes the source of an export snapshot record. type ExportSnapshotRecordSourceInfo struct { - // A list of objects describing an instance snapshot. - InstanceSnapshotInfo *InstanceSnapshotInfo - // The Amazon Resource Name (ARN) of the source instance or disk snapshot. Arn *string - // The name of the snapshot's source instance or disk. - FromResourceName *string + // The date when the source instance or disk snapshot was created. + CreatedAt *time.Time + + // A list of objects describing a disk snapshot. + DiskSnapshotInfo *DiskSnapshotInfo // The Amazon Resource Name (ARN) of the snapshot's source instance or disk. FromResourceArn *string - // The date when the source instance or disk snapshot was created. - CreatedAt *time.Time + // The name of the snapshot's source instance or disk. + FromResourceName *string + + // A list of objects describing an instance snapshot. + InstanceSnapshotInfo *InstanceSnapshotInfo // The name of the source instance or disk snapshot. Name *string - // A list of objects describing a disk snapshot. - DiskSnapshotInfo *DiskSnapshotInfo - // The Lightsail resource type (e.g., InstanceSnapshot or DiskSnapshot). ResourceType ExportSnapshotRecordSourceType } @@ -1075,12 +1075,15 @@ type HostKeyAttributes struct { // certificates, the algorithm is always x509-cert. Algorithm *string - // The returned RDP certificate is not valid after this point in time. This value - // is listed only for RDP certificates. - NotValidAfter *time.Time - - // The public SSH host key or the RDP certificate. - PublicKey *string + // The SHA-1 fingerprint of the returned SSH host key or RDP certificate. + // + // * + // Example of an SHA-1 SSH fingerprint: SHA1:1CHH6FaAaXjtFOsR/t83vf91SR0 + // + // * + // Example of an SHA-1 RDP fingerprint: + // af:34:51:fe:09:f0:e0:da:b8:4e:56:ca:60:c2:10:ff:38:06:db:45 + FingerprintSHA1 *string // The SHA-256 fingerprint of the returned SSH host key or RDP certificate. // @@ -1093,20 +1096,17 @@ type HostKeyAttributes struct { // 03:9b:36:9f:4b:de:4e:61:70:fc:7c:c9:78:e7:d2:1a:1c:25:a8:0c:91:f6:7c:e4:d6:a0:85:c8:b4:53:99:68 FingerprintSHA256 *string - // The SHA-1 fingerprint of the returned SSH host key or RDP certificate. - // - // * - // Example of an SHA-1 SSH fingerprint: SHA1:1CHH6FaAaXjtFOsR/t83vf91SR0 - // - // * - // Example of an SHA-1 RDP fingerprint: - // af:34:51:fe:09:f0:e0:da:b8:4e:56:ca:60:c2:10:ff:38:06:db:45 - FingerprintSHA1 *string + // The returned RDP certificate is not valid after this point in time. This value + // is listed only for RDP certificates. + NotValidAfter *time.Time // The returned RDP certificate is valid after this point in time. This value is // listed only for RDP certificates. NotValidBefore *time.Time + // The public SSH host key or the RDP certificate. + PublicKey *string + // The time that the SSH host key or RDP certificate was recorded by Lightsail. WitnessedAt *time.Time } @@ -1117,112 +1117,100 @@ type HostKeyAttributes struct { // via a worldwide network of edge servers.

    type InputOrigin struct { - // The AWS Region name of the origin resource. - RegionName RegionName + // The name of the origin resource. + Name *string // The protocol that your Amazon Lightsail distribution uses when establishing a // connection with your origin to pull content. ProtocolPolicy OriginProtocolPolicyEnum - // The name of the origin resource. - Name *string + // The AWS Region name of the origin resource. + RegionName RegionName } // Describes an instance (a virtual private server). type Instance struct { - // A Boolean value indicating whether this instance has a static IP assigned to it. - IsStaticIp *bool - - // Information about the public ports and monthly data transfer rates for the - // instance. - Networking *InstanceNetworking - - // The timestamp when the instance was created (e.g., 1479734909.17) in Unix time - // format. - CreatedAt *time.Time + // An array of objects representing the add-ons enabled on the instance. + AddOns []*AddOn // The Amazon Resource Name (ARN) of the instance (e.g., // arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE). Arn *string - // The support code. Include this code in your email to support when you have - // questions about an instance or another resource in Lightsail. This code enables - // our support team to look up your Lightsail information more easily. - SupportCode *string + // The blueprint ID (e.g., os_amlinux_2016_03). + BlueprintId *string - // The user name for connecting to the instance (e.g., ec2-user). - Username *string + // The friendly name of the blueprint (e.g., Amazon Linux). + BlueprintName *string - // The size of the vCPU and the amount of RAM for the instance. - Hardware *InstanceHardware + // The bundle for the instance (e.g., micro_1_0). + BundleId *string - // The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1). - Name *string + // The timestamp when the instance was created (e.g., 1479734909.17) in Unix time + // format. + CreatedAt *time.Time - // The type of resource (usually Instance). - ResourceType ResourceType + // The size of the vCPU and the amount of RAM for the instance. + Hardware *InstanceHardware // The IPv6 address of the instance. Ipv6Address *string - // The tag keys and optional values for the resource. For more information about - // tags in Lightsail, see the Lightsail Dev Guide - // (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). - Tags []*Tag - - // The private IP address of the instance. - PrivateIpAddress *string - - // The status code and the state (e.g., running) for the instance. - State *InstanceState + // A Boolean value indicating whether this instance has a static IP assigned to it. + IsStaticIp *bool // The region name and Availability Zone where the instance is located. Location *ResourceLocation - // The public IP address of the instance. - PublicIpAddress *string + // The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1). + Name *string - // The friendly name of the blueprint (e.g., Amazon Linux). - BlueprintName *string + // Information about the public ports and monthly data transfer rates for the + // instance. + Networking *InstanceNetworking - // An array of objects representing the add-ons enabled on the instance. - AddOns []*AddOn + // The private IP address of the instance. + PrivateIpAddress *string - // The bundle for the instance (e.g., micro_1_0). - BundleId *string + // The public IP address of the instance. + PublicIpAddress *string + + // The type of resource (usually Instance). + ResourceType ResourceType // The name of the SSH key being used to connect to the instance (e.g., // LightsailDefaultKeyPair). SshKeyName *string - // The blueprint ID (e.g., os_amlinux_2016_03). - BlueprintId *string -} + // The status code and the state (e.g., running) for the instance. + State *InstanceState -// The parameters for gaining temporary access to one of your Amazon Lightsail -// instances. -type InstanceAccessDetails struct { + // The support code. Include this code in your email to support when you have + // questions about an instance or another resource in Lightsail. This code enables + // our support team to look up your Lightsail information more easily. + SupportCode *string - // For RDP access, the password for your Amazon Lightsail instance. Password will - // be an empty string if the password for your new instance is not ready yet. When - // you create an instance, it can take up to 15 minutes for the instance to be - // ready. If you create an instance using any key pair other than the default - // (LightsailDefaultKeyPair), password will always be an empty string. If you - // change the Administrator password on the instance, Lightsail will continue to - // return the original password value. When accessing the instance using RDP, you - // need to manually enter the Administrator password after changing it from the - // default. - Password *string + // The tag keys and optional values for the resource. For more information about + // tags in Lightsail, see the Lightsail Dev Guide + // (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). + Tags []*Tag - // For SSH access, the date on which the temporary keys expire. - ExpiresAt *time.Time + // The user name for connecting to the instance (e.g., ec2-user). + Username *string +} - // The public IP address of the Amazon Lightsail instance. - IpAddress *string +// The parameters for gaining temporary access to one of your Amazon Lightsail +// instances. +type InstanceAccessDetails struct { - // The protocol for these Amazon Lightsail instance access details. - Protocol InstanceAccessProtocol + // For SSH access, the public key to use when accessing your instance For OpenSSH + // clients (e.g., command line SSH), you should save this value to + // tempkey-cert.pub. + CertKey *string + + // For SSH access, the date on which the temporary keys expire. + ExpiresAt *time.Time // Describes the public SSH host keys or the RDP certificate. HostKeys []*HostKeyAttributes @@ -1230,12 +1218,19 @@ type InstanceAccessDetails struct { // The name of this Amazon Lightsail instance. InstanceName *string - // The user name to use when logging in to the Amazon Lightsail instance. - Username *string + // The public IP address of the Amazon Lightsail instance. + IpAddress *string - // For SSH access, the temporary private key. For OpenSSH clients (e.g., command - // line SSH), you should save this value to tempkey). - PrivateKey *string + // For RDP access, the password for your Amazon Lightsail instance. Password will + // be an empty string if the password for your new instance is not ready yet. When + // you create an instance, it can take up to 15 minutes for the instance to be + // ready. If you create an instance using any key pair other than the default + // (LightsailDefaultKeyPair), password will always be an empty string. If you + // change the Administrator password on the instance, Lightsail will continue to + // return the original password value. When accessing the instance using RDP, you + // need to manually enter the Administrator password after changing it from the + // default. + Password *string // For a Windows Server-based instance, an object with the data you can use to // retrieve your password. This is only needed if password is empty and the @@ -1243,23 +1238,25 @@ type InstanceAccessDetails struct { // create an instance, it can take up to 15 minutes for the instance to be ready. PasswordData *PasswordData - // For SSH access, the public key to use when accessing your instance For OpenSSH - // clients (e.g., command line SSH), you should save this value to - // tempkey-cert.pub. - CertKey *string + // For SSH access, the temporary private key. For OpenSSH clients (e.g., command + // line SSH), you should save this value to tempkey). + PrivateKey *string + + // The protocol for these Amazon Lightsail instance access details. + Protocol InstanceAccessProtocol + + // The user name to use when logging in to the Amazon Lightsail instance. + Username *string } // Describes the Amazon Elastic Compute Cloud instance and related resources to be // created using the create cloud formation stack operation. type InstanceEntry struct { - // The name of the export snapshot record, which contains the exported Lightsail - // instance snapshot that will be used as the source of the new Amazon EC2 - // instance. Use the get export snapshot records operation to get a list of export - // snapshot records that you can use to create a CloudFormation stack. + // The Availability Zone for the new Amazon EC2 instance. // // This member is required. - SourceName *string + AvailabilityZone *string // The instance type (e.g., t2.micro) to use for the new Amazon EC2 instance. // @@ -1289,28 +1286,31 @@ type InstanceEntry struct { // This member is required. PortInfoSource PortInfoSourceType + // The name of the export snapshot record, which contains the exported Lightsail + // instance snapshot that will be used as the source of the new Amazon EC2 + // instance. Use the get export snapshot records operation to get a list of export + // snapshot records that you can use to create a CloudFormation stack. + // + // This member is required. + SourceName *string + // A launch script you can create that configures a server with additional user // data. For example, you might want to run apt-get -y update. Depending on the // machine image you choose, the command to get software on your instance varies. // Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses // pkg. UserData *string - - // The Availability Zone for the new Amazon EC2 instance. - // - // This member is required. - AvailabilityZone *string } // Describes the hardware for the instance. type InstanceHardware struct { - // The disks attached to the instance. - Disks []*Disk - // The number of vCPUs the instance has. CpuCount *int32 + // The disks attached to the instance. + Disks []*Disk + // The amount of RAM in GB on the instance (e.g., 1.0). RamSizeInGb *float32 } @@ -1318,9 +1318,8 @@ type InstanceHardware struct { // Describes information about the health of the instance. type InstanceHealthSummary struct { - // The name of the Lightsail instance for which you are requesting health check - // data. - InstanceName *string + // Describes the overall instance health. Valid values are below. + InstanceHealth InstanceHealthState // More information about the instance health. If the instanceHealth is healthy, // then an instanceHealthReason value is not provided. If instanceHealth is @@ -1377,8 +1376,9 @@ type InstanceHealthSummary struct { // expired. InstanceHealthReason InstanceHealthReason - // Describes the overall instance health. Valid values are below. - InstanceHealth InstanceHealthState + // The name of the Lightsail instance for which you are requesting health check + // data. + InstanceName *string } // Describes monthly data transfer rates and port information for an instance. @@ -1395,21 +1395,22 @@ type InstanceNetworking struct { // Describes information about ports for an Amazon Lightsail instance. type InstancePortInfo struct { - // An alias that defines access for a preconfigured range of IP addresses. The only - // alias currently supported is lightsail-connect, which allows IP addresses of the - // browser-based RDP/SSH client in the Lightsail console to connect to your - // instance. - CidrListAliases []*string - // The access direction (inbound or outbound). Lightsail currently supports only // inbound access direction. AccessDirection AccessDirection + // The location from which access is allowed. For example, Anywhere (0.0.0.0/0), or + // Custom if a specific IP address or range of IP addresses is allowed. + AccessFrom *string + // The type of access (Public or Private). AccessType PortAccessType - // The common name of the port information. - CommonName *string + // An alias that defines access for a preconfigured range of IP addresses. The only + // alias currently supported is lightsail-connect, which allows IP addresses of the + // browser-based RDP/SSH client in the Lightsail console to connect to your + // instance. + CidrListAliases []*string // The IP address, or range of IP addresses in CIDR notation, that are allowed to // connect to an instance through the ports, and the protocol. Lightsail supports @@ -1419,17 +1420,8 @@ type InstancePortInfo struct { // Wikipedia. Cidrs []*string - // The last port in a range of open ports on an instance. Allowed ports: - // - // * TCP - // and UDP - 0 to 65535 - // - // * ICMP - The ICMP code. For example, specify 8 as the - // fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For - // more information, see Control Messages - // (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages) - // on Wikipedia. - ToPort *int32 + // The common name of the port information. + CommonName *string // The first port in a range of open ports on an instance. Allowed ports: // @@ -1443,10 +1435,6 @@ type InstancePortInfo struct { // on Wikipedia. FromPort *int32 - // The location from which access is allowed. For example, Anywhere (0.0.0.0/0), or - // Custom if a specific IP address or range of IP addresses is allowed. - AccessFrom *string - // The IP protocol name. The name can be one of the following: // // * tcp - @@ -1474,6 +1462,18 @@ type InstancePortInfo struct { // be reached. When you specify icmp as the protocol, you must specify the ICMP // type using the fromPort parameter, and ICMP code using the toPort parameter. Protocol NetworkProtocol + + // The last port in a range of open ports on an instance. Allowed ports: + // + // * TCP + // and UDP - 0 to 65535 + // + // * ICMP - The ICMP code. For example, specify 8 as the + // fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For + // more information, see Control Messages + // (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages) + // on Wikipedia. + ToPort *int32 } // Describes open ports on an instance, the IP addresses allowed to connect to the @@ -1494,6 +1494,18 @@ type InstancePortState struct { // Wikipedia. Cidrs []*string + // The first port in a range of open ports on an instance. Allowed ports: + // + // * + // TCP and UDP - 0 to 65535 + // + // * ICMP - The ICMP type. For example, specify 8 as + // the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. + // For more information, see Control Messages + // (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages) + // on Wikipedia. + FromPort *int32 + // The IP protocol name. The name can be one of the following: // // * tcp - @@ -1537,80 +1549,68 @@ type InstancePortState struct { // (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages) // on Wikipedia. ToPort *int32 - - // The first port in a range of open ports on an instance. Allowed ports: - // - // * - // TCP and UDP - 0 to 65535 - // - // * ICMP - The ICMP type. For example, specify 8 as - // the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. - // For more information, see Control Messages - // (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages) - // on Wikipedia. - FromPort *int32 } // Describes an instance snapshot. type InstanceSnapshot struct { - // The size in GB of the SSD. - SizeInGb *int32 - - // The state the snapshot is in. - State InstanceSnapshotState + // The Amazon Resource Name (ARN) of the snapshot (e.g., + // arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE). + Arn *string // The timestamp when the snapshot was created (e.g., 1479907467.024). CreatedAt *time.Time - // The region name and Availability Zone where you created the snapshot. - Location *ResourceLocation + // An array of disk objects containing information about all block storage disks. + FromAttachedDisks []*Disk - // The type of resource (usually InstanceSnapshot). - ResourceType ResourceType + // The blueprint ID from which you created the snapshot (e.g., os_debian_8_3). A + // blueprint is a virtual private server (or instance) image used to create + // instances quickly. + FromBlueprintId *string + + // The bundle ID from which you created the snapshot (e.g., micro_1_0). + FromBundleId *string + + // The Amazon Resource Name (ARN) of the instance from which the snapshot was + // created (e.g., + // arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE). + FromInstanceArn *string + + // The instance from which the snapshot was created. + FromInstanceName *string // A Boolean value indicating whether the snapshot was created from an automatic // snapshot. IsFromAutoSnapshot *bool + // The region name and Availability Zone where you created the snapshot. + Location *ResourceLocation + + // The name of the snapshot. + Name *string + // The progress of the snapshot. Progress *string - // The instance from which the snapshot was created. - FromInstanceName *string + // The type of resource (usually InstanceSnapshot). + ResourceType ResourceType - // The Amazon Resource Name (ARN) of the instance from which the snapshot was - // created (e.g., - // arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE). - FromInstanceArn *string + // The size in GB of the SSD. + SizeInGb *int32 + + // The state the snapshot is in. + State InstanceSnapshotState // The support code. Include this code in your email to support when you have // questions about an instance or another resource in Lightsail. This code enables // our support team to look up your Lightsail information more easily. SupportCode *string - // The name of the snapshot. - Name *string - - // The Amazon Resource Name (ARN) of the snapshot (e.g., - // arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE). - Arn *string - // The tag keys and optional values for the resource. For more information about // tags in Lightsail, see the Lightsail Dev Guide // (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). Tags []*Tag - - // The blueprint ID from which you created the snapshot (e.g., os_debian_8_3). A - // blueprint is a virtual private server (or instance) image used to create - // instances quickly. - FromBlueprintId *string - - // An array of disk objects containing information about all block storage disks. - FromAttachedDisks []*Disk - - // The bundle ID from which you created the snapshot (e.g., micro_1_0). - FromBundleId *string } // Describes an instance snapshot. @@ -1619,36 +1619,45 @@ type InstanceSnapshotInfo struct { // The blueprint ID from which the source instance (e.g., os_debian_8_3). FromBlueprintId *string + // The bundle ID from which the source instance was created (e.g., micro_1_0). + FromBundleId *string + // A list of objects describing the disks that were attached to the source // instance. FromDiskInfo []*DiskInfo - - // The bundle ID from which the source instance was created (e.g., micro_1_0). - FromBundleId *string } // Describes the virtual private server (or instance) status. type InstanceState struct { - // The state of the instance (e.g., running or pending). - Name *string - // The status code for the instance. Code *int32 + + // The state of the instance (e.g., running or pending). + Name *string } // Describes the SSH key pair. type KeyPair struct { - // The friendly name of the SSH key pair. - Name *string + // The Amazon Resource Name (ARN) of the key pair (e.g., + // arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE). + Arn *string + + // The timestamp when the key pair was created (e.g., 1479816991.349). + CreatedAt *time.Time // The RSA fingerprint of the key pair. Fingerprint *string - // The Amazon Resource Name (ARN) of the key pair (e.g., - // arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE). - Arn *string + // The region name and Availability Zone where the key pair was created. + Location *ResourceLocation + + // The friendly name of the SSH key pair. + Name *string + + // The resource type (usually KeyPair). + ResourceType ResourceType // The support code. Include this code in your email to support when you have // questions about an instance or another resource in Lightsail. This code enables @@ -1659,123 +1668,127 @@ type KeyPair struct { // tags in Lightsail, see the Lightsail Dev Guide // (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). Tags []*Tag - - // The resource type (usually KeyPair). - ResourceType ResourceType - - // The region name and Availability Zone where the key pair was created. - Location *ResourceLocation - - // The timestamp when the key pair was created (e.g., 1479816991.349). - CreatedAt *time.Time } // Describes an Amazon Lightsail content delivery network (CDN) distribution. type LightsailDistribution struct { + // Indicates whether the bundle that is currently applied to your distribution, + // specified using the distributionName parameter, can be changed to another + // bundle.

    Use the UpdateDistributionBundle action to change your + // distribution's bundle.

    + AbleToUpdateBundle *bool + + // The alternate domain names of the distribution. + AlternativeDomainNames []*string + + // The Amazon Resource Name (ARN) of the distribution. + Arn *string + + // The ID of the bundle currently applied to the distribution. + BundleId *string + + // An object that describes the cache behavior settings of the distribution. + CacheBehaviorSettings *CacheSettings + // An array of objects that describe the per-path cache behavior of the // distribution. CacheBehaviors []*CacheBehaviorPerPath + // The name of the SSL/TLS certificate attached to the distribution, if any. + CertificateName *string + + // The timestamp when the distribution was created. + CreatedAt *time.Time + + // An object that describes the default cache behavior of the distribution. + DefaultCacheBehavior *CacheBehavior + + // The domain name of the distribution. + DomainName *string + + // Indicates whether the distribution is enabled. + IsEnabled *bool + // An object that describes the location of the distribution, such as the AWS // Region and Availability Zone. Lightsail distributions are global resources that // can reference an origin in any AWS Region, and distribute its content globally. // However, all distributions are located in the us-east-1 Region. Location *ResourceLocation - // The status of the distribution. - Status *string + // The name of the distribution. + Name *string // An object that describes the origin resource of the distribution, such as a // Lightsail instance or load balancer.

    The distribution pulls, caches, and // serves content from the origin.

    Origin *Origin - // An object that describes the cache behavior settings of the distribution. - CacheBehaviorSettings *CacheSettings - // The public DNS of the origin. OriginPublicDNS *string // The Lightsail resource type (e.g., Distribution). ResourceType ResourceType - // An object that describes the default cache behavior of the distribution. - DefaultCacheBehavior *CacheBehavior - - // The timestamp when the distribution was created. - CreatedAt *time.Time - - // The Amazon Resource Name (ARN) of the distribution. - Arn *string - - // Indicates whether the distribution is enabled. - IsEnabled *bool - - // The name of the SSL/TLS certificate attached to the distribution, if any. - CertificateName *string - - // The domain name of the distribution. - DomainName *string - - // Indicates whether the bundle that is currently applied to your distribution, - // specified using the distributionName parameter, can be changed to another - // bundle.

    Use the UpdateDistributionBundle action to change your - // distribution's bundle.

    - AbleToUpdateBundle *bool - - // The name of the distribution. - Name *string + // The status of the distribution. + Status *string // The support code. Include this code in your email to support when you have // questions about your Lightsail distribution. This code enables our support team // to look up your Lightsail information more easily. SupportCode *string - // The alternate domain names of the distribution. - AlternativeDomainNames []*string - // The tag keys and optional values for the resource. For more information about // tags in Lightsail, see the Lightsail Dev Guide // (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). Tags []*Tag - - // The ID of the bundle currently applied to the distribution. - BundleId *string } // Describes the Lightsail load balancer. type LoadBalancer struct { - // The path you specified to perform your health checks. If no path is specified, - // the load balancer tries to make a request to the default (root) page. - HealthCheckPath *string + // The Amazon Resource Name (ARN) of the load balancer. + Arn *string + + // A string to string map of the configuration options for your load balancer. + // Valid values are listed below. + ConfigurationOptions map[string]*string // The date when your load balancer was created. CreatedAt *time.Time - // An array of LoadBalancerTlsCertificateSummary objects that provide additional - // information about the SSL/TLS certificates. For example, if true, the - // certificate is attached to the load balancer. - TlsCertificateSummaries []*LoadBalancerTlsCertificateSummary + // The DNS name of your Lightsail load balancer. + DnsName *string - // The protocol you have enabled for your load balancer. Valid values are below. - // You can't just have HTTP_HTTPS, but you can have just HTTP. - Protocol LoadBalancerProtocol + // The path you specified to perform your health checks. If no path is specified, + // the load balancer tries to make a request to the default (root) page. + HealthCheckPath *string // An array of InstanceHealthSummary objects describing the health of the load // balancer. InstanceHealthSummary []*InstanceHealthSummary - // The resource type (e.g., LoadBalancer. - ResourceType ResourceType + // The port where the load balancer will direct traffic to your Lightsail + // instances. For HTTP traffic, it's port 80. For HTTPS traffic, it's port 443. + InstancePort *int32 + + // The AWS Region where your load balancer was created (e.g., us-east-2a). + // Lightsail automatically creates your load balancer across Availability Zones. + Location *ResourceLocation // The name of the load balancer (e.g., my-load-balancer). Name *string - // The port where the load balancer will direct traffic to your Lightsail - // instances. For HTTP traffic, it's port 80. For HTTPS traffic, it's port 443. - InstancePort *int32 + // The protocol you have enabled for your load balancer. Valid values are below. + // You can't just have HTTP_HTTPS, but you can have just HTTP. + Protocol LoadBalancerProtocol + + // An array of public port settings for your load balancer. For HTTP, use port 80. + // For HTTPS, use port 443. + PublicPorts []*int32 + + // The resource type (e.g., LoadBalancer. + ResourceType ResourceType // The status of your load balancer. Valid values are below. State LoadBalancerState @@ -1785,92 +1798,104 @@ type LoadBalancer struct { // to look up your Lightsail information more easily. SupportCode *string - // The Amazon Resource Name (ARN) of the load balancer. - Arn *string - - // The DNS name of your Lightsail load balancer. - DnsName *string - - // An array of public port settings for your load balancer. For HTTP, use port 80. - // For HTTPS, use port 443. - PublicPorts []*int32 - - // The AWS Region where your load balancer was created (e.g., us-east-2a). - // Lightsail automatically creates your load balancer across Availability Zones. - Location *ResourceLocation - // The tag keys and optional values for the resource. For more information about // tags in Lightsail, see the Lightsail Dev Guide // (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). Tags []*Tag - // A string to string map of the configuration options for your load balancer. - // Valid values are listed below. - ConfigurationOptions map[string]*string + // An array of LoadBalancerTlsCertificateSummary objects that provide additional + // information about the SSL/TLS certificates. For example, if true, the + // certificate is attached to the load balancer. + TlsCertificateSummaries []*LoadBalancerTlsCertificateSummary } // Describes a load balancer SSL/TLS certificate. TLS is just an updated, more // secure version of Secure Socket Layer (SSL). type LoadBalancerTlsCertificate struct { - // The issuer of the certificate. - Issuer *string - - // The name of the entity that is associated with the public key contained in the - // certificate. - Subject *string - - // The reason the certificate was revoked. This value is present only when the - // certificate status is REVOKED. - RevocationReason LoadBalancerTlsCertificateRevocationReason - - // The timestamp when the SSL/TLS certificate expires. - NotAfter *time.Time - - // An array of strings that specify the alternate domains (e.g., example2.com) and - // subdomains (e.g., blog.example.com) for the certificate. - SubjectAlternativeNames []*string + // The Amazon Resource Name (ARN) of the SSL/TLS certificate. + Arn *string - // The algorithm used to generate the key pair (the public and private key). - KeyAlgorithm *string + // The time when you created your SSL/TLS certificate. + CreatedAt *time.Time - // The timestamp when the SSL/TLS certificate is first valid. - NotBefore *time.Time + // The domain name for your SSL/TLS certificate. + DomainName *string // An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing // the records. DomainValidationRecords []*LoadBalancerTlsCertificateDomainValidationRecord - // The load balancer name where your SSL/TLS certificate is attached. - LoadBalancerName *string - - // The time when you created your SSL/TLS certificate. - CreatedAt *time.Time + // The validation failure reason, if any, of the certificate.

    The following + // failure reasons are possible:

    + FailureReason LoadBalancerTlsCertificateFailureReason - // An object that describes the status of the certificate renewal managed by - // Lightsail. - RenewalSummary *LoadBalancerTlsCertificateRenewalSummary + // When true, the SSL/TLS certificate is attached to the Lightsail load balancer. + IsAttached *bool // The time when the SSL/TLS certificate was issued. IssuedAt *time.Time - // The Amazon Resource Name (ARN) of the SSL/TLS certificate. - Arn *string + // The issuer of the certificate. + Issuer *string - // The timestamp when the certificate was revoked. This value is present only when - // the certificate status is REVOKED. - RevokedAt *time.Time + // The algorithm used to generate the key pair (the public and private key). + KeyAlgorithm *string - // The tag keys and optional values for the resource. For more information about - // tags in Lightsail, see the Lightsail Dev Guide - // (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). - Tags []*Tag + // The load balancer name where your SSL/TLS certificate is attached. + LoadBalancerName *string + + // The AWS Region and Availability Zone where you created your certificate. + Location *ResourceLocation + + // The name of the SSL/TLS certificate (e.g., my-certificate). + Name *string - // The AWS Region and Availability Zone where you created your certificate. - Location *ResourceLocation + // The timestamp when the SSL/TLS certificate expires. + NotAfter *time.Time - // The algorithm that was used to sign the certificate. - SignatureAlgorithm *string + // The timestamp when the SSL/TLS certificate is first valid. + NotBefore *time.Time + + // An object that describes the status of the certificate renewal managed by + // Lightsail. + RenewalSummary *LoadBalancerTlsCertificateRenewalSummary // The resource type (e.g., LoadBalancerTlsCertificate). // @@ -1902,95 +1927,70 @@ type LoadBalancerTlsCertificate struct { // DiskSnapshot - A block storage disk snapshot ResourceType ResourceType - // The validation failure reason, if any, of the certificate.

    The following - // failure reasons are possible:

    - FailureReason LoadBalancerTlsCertificateFailureReason + // The reason the certificate was revoked. This value is present only when the + // certificate status is REVOKED. + RevocationReason LoadBalancerTlsCertificateRevocationReason - // The domain name for your SSL/TLS certificate. - DomainName *string + // The timestamp when the certificate was revoked. This value is present only when + // the certificate status is REVOKED. + RevokedAt *time.Time // The serial number of the certificate. Serial *string - // When true, the SSL/TLS certificate is attached to the Lightsail load balancer. - IsAttached *bool + // The algorithm that was used to sign the certificate. + SignatureAlgorithm *string // The validation status of the SSL/TLS certificate. Valid values are below. Status LoadBalancerTlsCertificateStatus + // The name of the entity that is associated with the public key contained in the + // certificate. + Subject *string + + // An array of strings that specify the alternate domains (e.g., example2.com) and + // subdomains (e.g., blog.example.com) for the certificate. + SubjectAlternativeNames []*string + // The support code. Include this code in your email to support when you have // questions about your Lightsail load balancer or SSL/TLS certificate. This code // enables our support team to look up your Lightsail information more easily. SupportCode *string - // The name of the SSL/TLS certificate (e.g., my-certificate). - Name *string + // The tag keys and optional values for the resource. For more information about + // tags in Lightsail, see the Lightsail Dev Guide + // (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). + Tags []*Tag } // Contains information about the domain names on an SSL/TLS certificate that you // will use to validate domain ownership. type LoadBalancerTlsCertificateDomainValidationOption struct { - // The status of the domain validation. Valid values are listed below. - ValidationStatus LoadBalancerTlsCertificateDomainStatus - // The fully qualified domain name in the certificate request. DomainName *string + + // The status of the domain validation. Valid values are listed below. + ValidationStatus LoadBalancerTlsCertificateDomainStatus } // Describes the validation record of each domain name in the SSL/TLS certificate. type LoadBalancerTlsCertificateDomainValidationRecord struct { - // The value for that type. - Value *string + // The domain name against which your SSL/TLS certificate was validated. + DomainName *string // A fully qualified domain name in the certificate. For example, example.com. Name *string - // The domain name against which your SSL/TLS certificate was validated. - DomainName *string - // The type of validation record. For example, CNAME for domain validation. Type *string // The validation status. Valid values are listed below. ValidationStatus LoadBalancerTlsCertificateDomainStatus + + // The value for that type. + Value *string } // Contains information about the status of Lightsail's managed renewal for the @@ -2043,11 +2043,11 @@ type LoadBalancerTlsCertificateRenewalSummary struct { // Provides a summary of SSL/TLS certificate metadata. type LoadBalancerTlsCertificateSummary struct { - // The name of the SSL/TLS certificate. - Name *string - // When true, the SSL/TLS certificate is attached to the Lightsail load balancer. IsAttached *bool + + // The name of the SSL/TLS certificate. + Name *string } // Describes a database log event. @@ -2063,26 +2063,26 @@ type LogEvent struct { // Describes the metric data point. type MetricDatapoint struct { + // The average. + Average *float64 + // The maximum. Maximum *float64 + // The minimum. + Minimum *float64 + // The sample count. SampleCount *float64 + // The sum. + Sum *float64 + // The timestamp (e.g., 1479816991.349). Timestamp *time.Time // The unit. Unit MetricUnit - - // The average. - Average *float64 - - // The minimum. - Minimum *float64 - - // The sum. - Sum *float64 } // Describes resource being monitored by an alarm. An alarm is a way to monitor @@ -2091,12 +2091,12 @@ type MetricDatapoint struct { // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms). type MonitoredResourceInfo struct { - // The name of the Lightsail resource being monitored. - Name *string - // The Amazon Resource Name (ARN) of the resource being monitored. Arn *string + // The name of the Lightsail resource being monitored. + Name *string + // The Lightsail resource type of the resource being monitored. Instances, load // balancers, and relational databases are the only Lightsail resources that can // currently be monitored by alarms. @@ -2114,21 +2114,24 @@ type MonthlyTransfer struct { // Describes the API operation. type Operation struct { - // The timestamp when the status was changed (e.g., 1479816991.349). - StatusChangedAt *time.Time + // The timestamp when the operation was initialized (e.g., 1479816991.349). + CreatedAt *time.Time - // The resource type. - ResourceType ResourceType + // The error code. + ErrorCode *string + + // The error details. + ErrorDetails *string // The ID of the operation. Id *string - // The AWS Region and Availability Zone. - Location *ResourceLocation - // A Boolean value indicating whether the operation is terminal. IsTerminal *bool + // The AWS Region and Availability Zone. + Location *ResourceLocation + // Details about the operation (e.g., Debian-1GB-Ohio-1). OperationDetails *string @@ -2138,17 +2141,14 @@ type Operation struct { // The resource name. ResourceName *string + // The resource type. + ResourceType ResourceType + // The status of the operation. Status OperationStatus - // The error details. - ErrorDetails *string - - // The timestamp when the operation was initialized (e.g., 1479816991.349). - CreatedAt *time.Time - - // The error code. - ErrorCode *string + // The timestamp when the status was changed (e.g., 1479816991.349). + StatusChangedAt *time.Time } // Describes the origin resource of an Amazon Lightsail content delivery network @@ -2157,15 +2157,15 @@ type Operation struct { // via a worldwide network of edge servers.

    type Origin struct { - // The AWS Region name of the origin resource. - RegionName RegionName + // The name of the origin resource. + Name *string // The protocol that your Amazon Lightsail distribution uses when establishing a // connection with your origin to pull content. ProtocolPolicy OriginProtocolPolicyEnum - // The name of the origin resource. - Name *string + // The AWS Region name of the origin resource. + RegionName RegionName // The resource type of the origin resource (e.g., Instance). ResourceType ResourceType @@ -2198,12 +2198,12 @@ type PasswordData struct { // Describes a pending database maintenance action. type PendingMaintenanceAction struct { - // The effective date of the pending database maintenance action. - CurrentApplyDate *time.Time - // The type of pending database maintenance action. Action *string + // The effective date of the pending database maintenance action. + CurrentApplyDate *time.Time + // Additional detail about the pending database maintenance action. Description *string } @@ -2211,12 +2211,12 @@ type PendingMaintenanceAction struct { // Describes a pending database value modification. type PendingModifiedRelationalDatabaseValues struct { - // The database engine version. - EngineVersion *string - // A Boolean value indicating whether automated backup retention is enabled. BackupRetentionEnabled *bool + // The database engine version. + EngineVersion *string + // The password for the master user of the database. MasterUserPassword *string } @@ -2247,6 +2247,18 @@ type PortInfo struct { // Wikipedia. Cidrs []*string + // The first port in a range of open ports on an instance. Allowed ports: + // + // * + // TCP and UDP - 0 to 65535 + // + // * ICMP - The ICMP type. For example, specify 8 as + // the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. + // For more information, see Control Messages + // (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages) + // on Wikipedia. + FromPort *int32 + // The IP protocol name. The name can be one of the following: // // * tcp - @@ -2275,18 +2287,6 @@ type PortInfo struct { // type using the fromPort parameter, and ICMP code using the toPort parameter. Protocol NetworkProtocol - // The first port in a range of open ports on an instance. Allowed ports: - // - // * - // TCP and UDP - 0 to 65535 - // - // * ICMP - The ICMP type. For example, specify 8 as - // the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. - // For more information, see Control Messages - // (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages) - // on Wikipedia. - FromPort *int32 - // The last port in a range of open ports on an instance. Allowed ports: // // * TCP @@ -2306,157 +2306,157 @@ type PortInfo struct { // based on the query string values in viewer requests.

    type QueryStringObject struct { + // Indicates whether the distribution forwards and caches based on query strings. + Option *bool + // The specific query strings that the distribution forwards to the origin. //

    Your distribution will cache content based on the specified query // strings.

    If the option parameter is true, then your // distribution forwards all query strings, regardless of what you specify using // the queryStringsAllowList parameter.

    QueryStringsAllowList []*string - - // Indicates whether the distribution forwards and caches based on query strings. - Option *bool } // Describes the AWS Region. type Region struct { + // The Availability Zones. Follows the format us-east-2a (case-sensitive). + AvailabilityZones []*AvailabilityZone + // The continent code (e.g., NA, meaning North America). ContinentCode *string + // The description of the AWS Region (e.g., This region is recommended to serve + // users in the eastern United States and eastern Canada). + Description *string + // The display name (e.g., Ohio). DisplayName *string - // The Availability Zones for databases. Follows the format us-east-2a - // (case-sensitive). - RelationalDatabaseAvailabilityZones []*AvailabilityZone - // The region name (e.g., us-east-2). Name RegionName - // The description of the AWS Region (e.g., This region is recommended to serve - // users in the eastern United States and eastern Canada). - Description *string - - // The Availability Zones. Follows the format us-east-2a (case-sensitive). - AvailabilityZones []*AvailabilityZone + // The Availability Zones for databases. Follows the format us-east-2a + // (case-sensitive). + RelationalDatabaseAvailabilityZones []*AvailabilityZone } // Describes a database. type RelationalDatabase struct { - // The database software (for example, MySQL). - Engine *string - - // A Boolean value indicating whether automated backup retention is enabled for the - // database. - BackupRetentionEnabled *bool - - // The tag keys and optional values for the resource. For more information about - // tags in Lightsail, see the Lightsail Dev Guide - // (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). - Tags []*Tag - - // The database engine version (for example, 5.7.23). - EngineVersion *string - - // The daily time range during which automated backups are created for the database - // (for example, 16:00-16:30). - PreferredBackupWindow *string - - // The master user name of the database. - MasterUsername *string - // The Amazon Resource Name (ARN) of the database. Arn *string - // The timestamp when the database was created. Formatted in Unix time. - CreatedAt *time.Time - - // Describes the pending maintenance actions for the database. - PendingMaintenanceActions []*PendingMaintenanceAction - - // The name of the master database created when the Lightsail database resource is - // created. - MasterDatabaseName *string - - // Describes the secondary Availability Zone of a high availability database. The - // secondary database is used for failover support of a high availability database. - SecondaryAvailabilityZone *string + // A Boolean value indicating whether automated backup retention is enabled for the + // database. + BackupRetentionEnabled *bool // The certificate associated with the database. CaCertificateIdentifier *string + // The timestamp when the database was created. Formatted in Unix time. + CreatedAt *time.Time + + // The database software (for example, MySQL). + Engine *string + + // The database engine version (for example, 5.7.23). + EngineVersion *string + // Describes the hardware of the database. Hardware *RelationalDatabaseHardware - // A Boolean value indicating whether the database is publicly accessible. - PubliclyAccessible *bool - // The latest point in time to which the database can be restored. Formatted in // Unix time. LatestRestorableTime *time.Time + // The Region name and Availability Zone where the database is located. + Location *ResourceLocation + + // The name of the master database created when the Lightsail database resource is + // created. + MasterDatabaseName *string + + // The master endpoint for the database. + MasterEndpoint *RelationalDatabaseEndpoint + + // The master user name of the database. + MasterUsername *string + + // The unique name of the database resource in Lightsail. + Name *string + // The status of parameter updates for the database. ParameterApplyStatus *string - // Describes the current state of the database. - State *string - - // The blueprint ID for the database. A blueprint describes the major engine - // version of a database. - RelationalDatabaseBlueprintId *string + // Describes the pending maintenance actions for the database. + PendingMaintenanceActions []*PendingMaintenanceAction // Describes pending database value modifications. PendingModifiedValues *PendingModifiedRelationalDatabaseValues + // The daily time range during which automated backups are created for the database + // (for example, 16:00-16:30). + PreferredBackupWindow *string + // The weekly time range during which system maintenance can occur on the database. // In the format ddd:hh24:mi-ddd:hh24:mi. For example, Tue:17:00-Tue:17:30. PreferredMaintenanceWindow *string - // The master endpoint for the database. - MasterEndpoint *RelationalDatabaseEndpoint + // A Boolean value indicating whether the database is publicly accessible. + PubliclyAccessible *bool + + // The blueprint ID for the database. A blueprint describes the major engine + // version of a database. + RelationalDatabaseBlueprintId *string // The bundle ID for the database. A bundle describes the performance // specifications for your database. RelationalDatabaseBundleId *string + // The Lightsail resource type for the database (for example, RelationalDatabase). + ResourceType ResourceType + + // Describes the secondary Availability Zone of a high availability database. The + // secondary database is used for failover support of a high availability database. + SecondaryAvailabilityZone *string + + // Describes the current state of the database. + State *string + // The support code for the database. Include this code in your email to support // when you have questions about a database in Lightsail. This code enables our // support team to look up your Lightsail information more easily. SupportCode *string - // The Lightsail resource type for the database (for example, RelationalDatabase). - ResourceType ResourceType - - // The Region name and Availability Zone where the database is located. - Location *ResourceLocation - - // The unique name of the database resource in Lightsail. - Name *string + // The tag keys and optional values for the resource. For more information about + // tags in Lightsail, see the Lightsail Dev Guide + // (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). + Tags []*Tag } // Describes a database image, or blueprint. A blueprint describes the major engine // version of a database. type RelationalDatabaseBlueprint struct { - // The database engine version for the database blueprint (for example, 5.7.23). - EngineVersion *string - - // A Boolean value indicating whether the engine version is the default for the - // database blueprint. - IsEngineDefault *bool - - // The description of the database engine version for the database blueprint. - EngineVersionDescription *string + // The ID for the database blueprint. + BlueprintId *string // The database software of the database blueprint (for example, MySQL). Engine RelationalDatabaseEngine - // The ID for the database blueprint. - BlueprintId *string - // The description of the database engine for the database blueprint. EngineDescription *string + + // The database engine version for the database blueprint (for example, 5.7.23). + EngineVersion *string + + // The description of the database engine version for the database blueprint. + EngineVersionDescription *string + + // A Boolean value indicating whether the engine version is the default for the + // database blueprint. + IsEngineDefault *bool } // Describes a database bundle. A bundle describes the performance specifications @@ -2466,39 +2466,39 @@ type RelationalDatabaseBundle struct { // The ID for the database bundle. BundleId *string - // The name for the database bundle. - Name *string - - // A Boolean value indicating whether the database bundle is active. - IsActive *bool + // The number of virtual CPUs (vCPUs) for the database bundle. + CpuCount *int32 // The size of the disk for the database bundle. DiskSizeInGb *int32 - // The data transfer rate per month in GB for the database bundle. - TransferPerMonthInGb *int32 + // A Boolean value indicating whether the database bundle is active. + IsActive *bool // A Boolean value indicating whether the database bundle is encrypted. IsEncrypted *bool + // The name for the database bundle. + Name *string + // The cost of the database bundle in US currency. Price *float32 // The amount of RAM in GB (for example, 2.0) for the database bundle. RamSizeInGb *float32 - // The number of virtual CPUs (vCPUs) for the database bundle. - CpuCount *int32 + // The data transfer rate per month in GB for the database bundle. + TransferPerMonthInGb *int32 } // Describes an endpoint for a database. type RelationalDatabaseEndpoint struct { - // Specifies the port that the database is listening on. - Port *int32 - // Specifies the DNS address of the database. Address *string + + // Specifies the port that the database is listening on. + Port *int32 } // Describes an event for a database. @@ -2507,53 +2507,53 @@ type RelationalDatabaseEvent struct { // The timestamp when the database event was created. CreatedAt *time.Time - // The database that the database event relates to. - Resource *string - // The category that the database event belongs to. EventCategories []*string // The message of the database event. Message *string + + // The database that the database event relates to. + Resource *string } // Describes the hardware of a database. type RelationalDatabaseHardware struct { - // The amount of RAM in GB for the database. - RamSizeInGb *float32 - // The number of vCPUs for the database. CpuCount *int32 // The size of the disk for the database. DiskSizeInGb *int32 + + // The amount of RAM in GB for the database. + RamSizeInGb *float32 } // Describes the parameters of a database. type RelationalDatabaseParameter struct { - // Specifies the name of the parameter. - ParameterName *string - - // Provides a description of the parameter. - Description *string - - // Specifies the valid data type for the parameter. - DataType *string + // Specifies the valid range of values for the parameter. + AllowedValues *string // Indicates when parameter updates are applied. Can be immediate or // pending-reboot. ApplyMethod *string - // Specifies the valid range of values for the parameter. - AllowedValues *string + // Specifies the engine-specific parameter type. + ApplyType *string + + // Specifies the valid data type for the parameter. + DataType *string + + // Provides a description of the parameter. + Description *string // A Boolean value indicating whether the parameter can be modified. IsModifiable *bool - // Specifies the engine-specific parameter type. - ApplyType *string + // Specifies the name of the parameter. + ParameterName *string // Specifies the value of the parameter. ParameterValue *string @@ -2562,65 +2562,62 @@ type RelationalDatabaseParameter struct { // Describes a database snapshot. type RelationalDatabaseSnapshot struct { - // The size of the disk in GB (for example, 32) for the database snapshot. - SizeInGb *int32 + // The Amazon Resource Name (ARN) of the database snapshot. + Arn *string - // The Region name and Availability Zone where the database snapshot is located. - Location *ResourceLocation + // The timestamp when the database snapshot was created. + CreatedAt *time.Time - // The bundle ID of the database from which the database snapshot was created. - FromRelationalDatabaseBundleId *string + // The software of the database snapshot (for example, MySQL) + Engine *string // The database engine version for the database snapshot (for example, 5.7.23). EngineVersion *string - // The timestamp when the database snapshot was created. - CreatedAt *time.Time - - // The tag keys and optional values for the resource. For more information about - // tags in Lightsail, see the Lightsail Dev Guide - // (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). - Tags []*Tag + // The Amazon Resource Name (ARN) of the database from which the database snapshot + // was created. + FromRelationalDatabaseArn *string // The blueprint ID of the database from which the database snapshot was created. A // blueprint describes the major engine version of a database. FromRelationalDatabaseBlueprintId *string + // The bundle ID of the database from which the database snapshot was created. + FromRelationalDatabaseBundleId *string + // The name of the source database from which the database snapshot was created. FromRelationalDatabaseName *string + // The Region name and Availability Zone where the database snapshot is located. + Location *ResourceLocation + // The name of the database snapshot. Name *string // The Lightsail resource type. ResourceType ResourceType - // The support code for the database snapshot. Include this code in your email to - // support when you have questions about a database snapshot in Lightsail. This - // code enables our support team to look up your Lightsail information more easily. - SupportCode *string - - // The Amazon Resource Name (ARN) of the database snapshot. - Arn *string + // The size of the disk in GB (for example, 32) for the database snapshot. + SizeInGb *int32 // The state of the database snapshot. State *string - // The software of the database snapshot (for example, MySQL) - Engine *string + // The support code for the database snapshot. Include this code in your email to + // support when you have questions about a database snapshot in Lightsail. This + // code enables our support team to look up your Lightsail information more easily. + SupportCode *string - // The Amazon Resource Name (ARN) of the database from which the database snapshot - // was created. - FromRelationalDatabaseArn *string + // The tag keys and optional values for the resource. For more information about + // tags in Lightsail, see the Lightsail Dev Guide + // (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). + Tags []*Tag } // Describes the status of a SSL/TLS certificate renewal managed by Amazon // Lightsail. type RenewalSummary struct { - // The timestamp when the certificate was last updated. - UpdatedAt *time.Time - // An array of objects that describe the domain validation records of the // certificate. DomainValidationRecords []*DomainValidationRecord @@ -2644,6 +2641,9 @@ type RenewalSummary struct { // The reason for the renewal status of the certificate. RenewalStatusReason *string + + // The timestamp when the certificate was last updated. + UpdatedAt *time.Time } // Describes the resource location. @@ -2663,18 +2663,25 @@ type ResourceRecord struct { // The name of the record. Name *string - // The value for the DNS record. - Value *string - // The DNS record type. Type *string + + // The value for the DNS record. + Value *string } // Describes the static IP. type StaticIp struct { - // The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE). - Name *string + // The Amazon Resource Name (ARN) of the static IP (e.g., + // arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE). + Arn *string + + // The instance where the static IP is attached (e.g., Amazon_Linux-1GB-Ohio-1). + AttachedTo *string + + // The timestamp when the static IP was created (e.g., 1479735304.222). + CreatedAt *time.Time // The static IP address. IpAddress *string @@ -2682,26 +2689,19 @@ type StaticIp struct { // A Boolean value indicating whether the static IP is attached. IsAttached *bool - // The instance where the static IP is attached (e.g., Amazon_Linux-1GB-Ohio-1). - AttachedTo *string - // The region and Availability Zone where the static IP was created. Location *ResourceLocation - // The timestamp when the static IP was created (e.g., 1479735304.222). - CreatedAt *time.Time + // The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE). + Name *string - // The Amazon Resource Name (ARN) of the static IP (e.g., - // arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE). - Arn *string + // The resource type (usually StaticIp). + ResourceType ResourceType // The support code. Include this code in your email to support when you have // questions about an instance or another resource in Lightsail. This code enables // our support team to look up your Lightsail information more easily. SupportCode *string - - // The resource type (usually StaticIp). - ResourceType ResourceType } // Describes a tag key and optional value assigned to an Amazon Lightsail resource. @@ -2709,11 +2709,11 @@ type StaticIp struct { // (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). type Tag struct { - // The value of the tag. Constraints: Tag values accept a maximum of 256 letters, - // numbers, spaces in UTF-8, or the following characters: + - = . _ : / @ - Value *string - // The key of the tag. Constraints: Tag keys accept a maximum of 128 letters, // numbers, spaces in UTF-8, or the following characters: + - = . _ : / @ Key *string + + // The value of the tag. Constraints: Tag values accept a maximum of 256 letters, + // numbers, spaces in UTF-8, or the following characters: + - = . _ : / @ + Value *string } diff --git a/service/machinelearning/api_op_AddTags.go b/service/machinelearning/api_op_AddTags.go index 50410f3b0c9..6875597e97a 100644 --- a/service/machinelearning/api_op_AddTags.go +++ b/service/machinelearning/api_op_AddTags.go @@ -59,6 +59,11 @@ func (c *Client) AddTags(ctx context.Context, params *AddTagsInput, optFns ...fu type AddTagsInput struct { + // The ID of the ML object to tag. For example, exampleModelId. + // + // This member is required. + ResourceId *string + // The type of the ML object to tag. // // This member is required. @@ -70,11 +75,6 @@ type AddTagsInput struct { // // This member is required. Tags []*types.Tag - - // The ID of the ML object to tag. For example, exampleModelId. - // - // This member is required. - ResourceId *string } // Amazon ML returns the following elements. diff --git a/service/machinelearning/api_op_CreateBatchPrediction.go b/service/machinelearning/api_op_CreateBatchPrediction.go index d9d61c368ed..86c9e2eed9a 100644 --- a/service/machinelearning/api_op_CreateBatchPrediction.go +++ b/service/machinelearning/api_op_CreateBatchPrediction.go @@ -68,11 +68,22 @@ func (c *Client) CreateBatchPrediction(ctx context.Context, params *CreateBatchP type CreateBatchPredictionInput struct { + // The ID of the DataSource that points to the group of observations to predict. + // + // This member is required. + BatchPredictionDataSourceId *string + // A user-supplied ID that uniquely identifies the BatchPrediction. // // This member is required. BatchPredictionId *string + // The ID of the MLModel that will generate predictions for the group of + // observations. + // + // This member is required. + MLModelId *string + // The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory // to store the batch prediction results. The following substrings are not allowed // in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'. Amazon @@ -86,17 +97,6 @@ type CreateBatchPredictionInput struct { // A user-supplied name or description of the BatchPrediction. BatchPredictionName // can only use the UTF-8 character set. BatchPredictionName *string - - // The ID of the DataSource that points to the group of observations to predict. - // - // This member is required. - BatchPredictionDataSourceId *string - - // The ID of the MLModel that will generate predictions for the group of - // observations. - // - // This member is required. - MLModelId *string } // Represents the output of a CreateBatchPrediction operation, and is an diff --git a/service/machinelearning/api_op_CreateDataSourceFromRDS.go b/service/machinelearning/api_op_CreateDataSourceFromRDS.go index 042a5fcb8fa..3797463e06c 100644 --- a/service/machinelearning/api_op_CreateDataSourceFromRDS.go +++ b/service/machinelearning/api_op_CreateDataSourceFromRDS.go @@ -77,19 +77,6 @@ type CreateDataSourceFromRDSInput struct { // This member is required. DataSourceId *string - // The compute statistics for a DataSource. The statistics are generated from the - // observation data referenced by a DataSource. Amazon ML uses the statistics - // internally during MLModel training. This parameter must be set to true if the - // DataSource needs to be used for MLModel training. - ComputeStatistics *bool - - // The role that Amazon ML assumes on behalf of the user to create and activate a - // data pipeline in the user's account and copy data using the SelectSqlQuery query - // from Amazon RDS to Amazon S3. - // - // This member is required. - RoleARN *string - // The data specification of an Amazon RDS DataSource: // // * DatabaseInformation @@ -143,6 +130,19 @@ type CreateDataSourceFromRDSInput struct { // This member is required. RDSData *types.RDSDataSpec + // The role that Amazon ML assumes on behalf of the user to create and activate a + // data pipeline in the user's account and copy data using the SelectSqlQuery query + // from Amazon RDS to Amazon S3. + // + // This member is required. + RoleARN *string + + // The compute statistics for a DataSource. The statistics are generated from the + // observation data referenced by a DataSource. Amazon ML uses the statistics + // internally during MLModel training. This parameter must be set to true if the + // DataSource needs to be used for MLModel training. + ComputeStatistics *bool + // A user-supplied name or description of the DataSource. DataSourceName *string } diff --git a/service/machinelearning/api_op_CreateDataSourceFromRedshift.go b/service/machinelearning/api_op_CreateDataSourceFromRedshift.go index 616f3c33601..2e2c8a61161 100644 --- a/service/machinelearning/api_op_CreateDataSourceFromRedshift.go +++ b/service/machinelearning/api_op_CreateDataSourceFromRedshift.go @@ -94,15 +94,6 @@ type CreateDataSourceFromRedshiftInput struct { // This member is required. DataSourceId *string - // The compute statistics for a DataSource. The statistics are generated from the - // observation data referenced by a DataSource. Amazon ML uses the statistics - // internally during MLModel training. This parameter must be set to true if the - // DataSource needs to be used for MLModel training. - ComputeStatistics *bool - - // A user-supplied name or description of the DataSource. - DataSourceName *string - // The data specification of an Amazon Redshift DataSource: // // * @@ -147,6 +138,15 @@ type CreateDataSourceFromRedshiftInput struct { // // This member is required. RoleARN *string + + // The compute statistics for a DataSource. The statistics are generated from the + // observation data referenced by a DataSource. Amazon ML uses the statistics + // internally during MLModel training. This parameter must be set to true if the + // DataSource needs to be used for MLModel training. + ComputeStatistics *bool + + // A user-supplied name or description of the DataSource. + DataSourceName *string } // Represents the output of a CreateDataSourceFromRedshift operation, and is an diff --git a/service/machinelearning/api_op_CreateDataSourceFromS3.go b/service/machinelearning/api_op_CreateDataSourceFromS3.go index 538ed1e24ca..ffb0116f9bb 100644 --- a/service/machinelearning/api_op_CreateDataSourceFromS3.go +++ b/service/machinelearning/api_op_CreateDataSourceFromS3.go @@ -89,15 +89,6 @@ type CreateDataSourceFromS3Input struct { // This member is required. DataSourceId *string - // A user-supplied name or description of the DataSource. - DataSourceName *string - - // The compute statistics for a DataSource. The statistics are generated from the - // observation data referenced by a DataSource. Amazon ML uses the statistics - // internally during MLModel training. This parameter must be set to true if the - // DataSource needs to be used for MLModel training. - ComputeStatistics *bool - // The data specification of a DataSource: // // * DataLocationS3 - The Amazon S3 @@ -116,6 +107,15 @@ type CreateDataSourceFromS3Input struct { // // This member is required. DataSpec *types.S3DataSpec + + // The compute statistics for a DataSource. The statistics are generated from the + // observation data referenced by a DataSource. Amazon ML uses the statistics + // internally during MLModel training. This parameter must be set to true if the + // DataSource needs to be used for MLModel training. + ComputeStatistics *bool + + // A user-supplied name or description of the DataSource. + DataSourceName *string } // Represents the output of a CreateDataSourceFromS3 operation, and is an diff --git a/service/machinelearning/api_op_CreateEvaluation.go b/service/machinelearning/api_op_CreateEvaluation.go index 2fb8c80c040..2066f0d96a8 100644 --- a/service/machinelearning/api_op_CreateEvaluation.go +++ b/service/machinelearning/api_op_CreateEvaluation.go @@ -69,17 +69,17 @@ func (c *Client) CreateEvaluation(ctx context.Context, params *CreateEvaluationI type CreateEvaluationInput struct { - // A user-supplied ID that uniquely identifies the Evaluation. - // - // This member is required. - EvaluationId *string - // The ID of the DataSource for the evaluation. The schema of the DataSource must // match the schema used to create the MLModel. // // This member is required. EvaluationDataSourceId *string + // A user-supplied ID that uniquely identifies the Evaluation. + // + // This member is required. + EvaluationId *string + // The ID of the MLModel to evaluate. The schema used in creating the MLModel must // match the schema of the DataSource used in the Evaluation. // diff --git a/service/machinelearning/api_op_CreateMLModel.go b/service/machinelearning/api_op_CreateMLModel.go index 8b135a8032d..9d8099e289f 100644 --- a/service/machinelearning/api_op_CreateMLModel.go +++ b/service/machinelearning/api_op_CreateMLModel.go @@ -69,16 +69,37 @@ func (c *Client) CreateMLModel(ctx context.Context, params *CreateMLModelInput, type CreateMLModelInput struct { - // The Amazon Simple Storage Service (Amazon S3) location and file name that - // contains the MLModel recipe. You must specify either the recipe or its URI. If - // you don't specify a recipe or its URI, Amazon ML creates a default. - RecipeUri *string + // A user-supplied ID that uniquely identifies the MLModel. + // + // This member is required. + MLModelId *string + + // The category of supervised learning that this MLModel will address. Choose from + // the following types: + // + // * Choose REGRESSION if the MLModel will be used to + // predict a numeric value. + // + // * Choose BINARY if the MLModel result has two + // possible values. + // + // * Choose MULTICLASS if the MLModel result has a limited + // number of values. + // + // For more information, see the Amazon Machine Learning + // Developer Guide (https://docs.aws.amazon.com/machine-learning/latest/dg). + // + // This member is required. + MLModelType types.MLModelType // The DataSource that points to the training data. // // This member is required. TrainingDataSourceId *string + // A user-supplied name or description of the MLModel. + MLModelName *string + // A list of the training parameters in the MLModel. The list is implemented as a // map of key-value pairs. The following is the current set of training // parameters: @@ -115,35 +136,14 @@ type CreateMLModelInput struct { // can't be used when L1 is specified. Use this parameter sparingly. Parameters map[string]*string - // A user-supplied name or description of the MLModel. - MLModelName *string - - // The category of supervised learning that this MLModel will address. Choose from - // the following types: - // - // * Choose REGRESSION if the MLModel will be used to - // predict a numeric value. - // - // * Choose BINARY if the MLModel result has two - // possible values. - // - // * Choose MULTICLASS if the MLModel result has a limited - // number of values. - // - // For more information, see the Amazon Machine Learning - // Developer Guide (https://docs.aws.amazon.com/machine-learning/latest/dg). - // - // This member is required. - MLModelType types.MLModelType - // The data recipe for creating the MLModel. You must specify either the recipe or // its URI. If you don't specify a recipe or its URI, Amazon ML creates a default. Recipe *string - // A user-supplied ID that uniquely identifies the MLModel. - // - // This member is required. - MLModelId *string + // The Amazon Simple Storage Service (Amazon S3) location and file name that + // contains the MLModel recipe. You must specify either the recipe or its URI. If + // you don't specify a recipe or its URI, Amazon ML creates a default. + RecipeUri *string } // Represents the output of a CreateMLModel operation, and is an acknowledgement diff --git a/service/machinelearning/api_op_DeleteTags.go b/service/machinelearning/api_op_DeleteTags.go index e3ff3bbd616..0227f463913 100644 --- a/service/machinelearning/api_op_DeleteTags.go +++ b/service/machinelearning/api_op_DeleteTags.go @@ -59,6 +59,11 @@ func (c *Client) DeleteTags(ctx context.Context, params *DeleteTagsInput, optFns type DeleteTagsInput struct { + // The ID of the tagged ML object. For example, exampleModelId. + // + // This member is required. + ResourceId *string + // The type of the tagged ML object. // // This member is required. @@ -68,11 +73,6 @@ type DeleteTagsInput struct { // // This member is required. TagKeys []*string - - // The ID of the tagged ML object. For example, exampleModelId. - // - // This member is required. - ResourceId *string } // Amazon ML returns the following elements. diff --git a/service/machinelearning/api_op_DescribeBatchPredictions.go b/service/machinelearning/api_op_DescribeBatchPredictions.go index eea6bec156d..f0e94b1a6fa 100644 --- a/service/machinelearning/api_op_DescribeBatchPredictions.go +++ b/service/machinelearning/api_op_DescribeBatchPredictions.go @@ -57,50 +57,9 @@ func (c *Client) DescribeBatchPredictions(ctx context.Context, params *DescribeB type DescribeBatchPredictionsInput struct { - // A two-value parameter that determines the sequence of the resulting list of - // MLModels. - // - // * asc - Arranges the list in ascending order (A-Z, 0-9). - // - // * - // dsc - Arranges the list in descending order (Z-A, 9-0). - // - // Results are sorted by - // FilterVariable. - SortOrder types.SortOrder - - // The not equal to operator. The BatchPrediction results will have FilterVariable - // values not equal to the value specified with NE. - NE *string - - // A string that is found at the beginning of a variable, such as Name or Id. For - // example, a Batch Prediction operation could have the - // Name2014-09-09-HolidayGiftMailer. To search for this BatchPrediction, select - // Name for the FilterVariable and any of the following strings for the Prefix: - // - Prefix *string - - // The number of pages of information to include in the result. The range of - // acceptable values is 1 through 100. The default value is 100. - Limit *int32 - - // The less than or equal to operator. The BatchPrediction results will have - // FilterVariable values that are less than or equal to the value specified with - // LE. - LE *string - - // The less than operator. The BatchPrediction results will have FilterVariable - // values that are less than the value specified with LT. - LT *string - - // An ID of the page in the paginated results. - NextToken *string - - // The greater than or equal to operator. The BatchPrediction results will have - // FilterVariable values that are greater than or equal to the value specified with - // GE. - GE *string + // The equal to operator. The BatchPrediction results will have FilterVariable + // values that exactly match the value specified with EQ. + EQ *string // Use one of the following variables to filter a list of BatchPrediction: // @@ -129,26 +88,67 @@ type DescribeBatchPredictionsInput struct { // or directory. FilterVariable types.BatchPredictionFilterVariable - // The equal to operator. The BatchPrediction results will have FilterVariable - // values that exactly match the value specified with EQ. - EQ *string + // The greater than or equal to operator. The BatchPrediction results will have + // FilterVariable values that are greater than or equal to the value specified with + // GE. + GE *string // The greater than operator. The BatchPrediction results will have FilterVariable // values that are greater than the value specified with GT. GT *string + + // The less than or equal to operator. The BatchPrediction results will have + // FilterVariable values that are less than or equal to the value specified with + // LE. + LE *string + + // The less than operator. The BatchPrediction results will have FilterVariable + // values that are less than the value specified with LT. + LT *string + + // The number of pages of information to include in the result. The range of + // acceptable values is 1 through 100. The default value is 100. + Limit *int32 + + // The not equal to operator. The BatchPrediction results will have FilterVariable + // values not equal to the value specified with NE. + NE *string + + // An ID of the page in the paginated results. + NextToken *string + + // A string that is found at the beginning of a variable, such as Name or Id. For + // example, a Batch Prediction operation could have the + // Name2014-09-09-HolidayGiftMailer. To search for this BatchPrediction, select + // Name for the FilterVariable and any of the following strings for the Prefix: + // + Prefix *string + + // A two-value parameter that determines the sequence of the resulting list of + // MLModels. + // + // * asc - Arranges the list in ascending order (A-Z, 0-9). + // + // * + // dsc - Arranges the list in descending order (Z-A, 9-0). + // + // Results are sorted by + // FilterVariable. + SortOrder types.SortOrder } // Represents the output of a DescribeBatchPredictions operation. The content is // essentially a list of BatchPredictions. type DescribeBatchPredictionsOutput struct { - // A list of BatchPrediction objects that meet the search criteria. - Results []*types.BatchPrediction - // The ID of the next page in the paginated results that indicates at least one // more page follows. NextToken *string + // A list of BatchPrediction objects that meet the search criteria. + Results []*types.BatchPrediction + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/machinelearning/api_op_DescribeDataSources.go b/service/machinelearning/api_op_DescribeDataSources.go index e57081ee1c7..91adf559e11 100644 --- a/service/machinelearning/api_op_DescribeDataSources.go +++ b/service/machinelearning/api_op_DescribeDataSources.go @@ -56,21 +56,38 @@ func (c *Client) DescribeDataSources(ctx context.Context, params *DescribeDataSo type DescribeDataSourcesInput struct { - // The not equal to operator. The DataSource results will have FilterVariable - // values not equal to the value specified with NE. - NE *string + // The equal to operator. The DataSource results will have FilterVariable values + // that exactly match the value specified with EQ. + EQ *string - // A two-value parameter that determines the sequence of the resulting list of - // DataSource. - // - // * asc - Arranges the list in ascending order (A-Z, 0-9). + // Use one of the following variables to filter a list of DataSource: // // * - // dsc - Arranges the list in descending order (Z-A, 9-0). + // CreatedAt - Sets the search criteria to DataSource creation dates. // - // Results are sorted by - // FilterVariable. - SortOrder types.SortOrder + // * Status + // - Sets the search criteria to DataSource statuses. + // + // * Name - Sets the search + // criteria to the contents of DataSourceName. + // + // * DataUri - Sets the search + // criteria to the URI of data files used to create the DataSource. The URI can + // identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or + // directory. + // + // * IAMUser - Sets the search criteria to the user account that + // invoked the DataSource creation. + FilterVariable types.DataSourceFilterVariable + + // The greater than or equal to operator. The DataSource results will have + // FilterVariable values that are greater than or equal to the value specified with + // GE. + GE *string + + // The greater than operator. The DataSource results will have FilterVariable + // values that are greater than the value specified with GT. + GT *string // The less than or equal to operator. The DataSource results will have // FilterVariable values that are less than or equal to the value specified with @@ -81,12 +98,16 @@ type DescribeDataSourcesInput struct { // that are less than the value specified with LT. LT *string - // The ID of the page in the paginated results. - NextToken *string - // The maximum number of DataSource to include in the result. Limit *int32 + // The not equal to operator. The DataSource results will have FilterVariable + // values not equal to the value specified with NE. + NE *string + + // The ID of the page in the paginated results. + NextToken *string + // A string that is found at the beginning of a variable, such as Name or Id. For // example, a DataSource could have the Name2014-09-09-HolidayGiftMailer. To search // for this DataSource, select Name for the FilterVariable and any of the following @@ -94,38 +115,17 @@ type DescribeDataSourcesInput struct { //

  • 2014-09-09-Holiday

    • Prefix *string - // The greater than operator. The DataSource results will have FilterVariable - // values that are greater than the value specified with GT. - GT *string - - // Use one of the following variables to filter a list of DataSource: - // - // * - // CreatedAt - Sets the search criteria to DataSource creation dates. - // - // * Status - // - Sets the search criteria to DataSource statuses. + // A two-value parameter that determines the sequence of the resulting list of + // DataSource. // - // * Name - Sets the search - // criteria to the contents of DataSourceName. + // * asc - Arranges the list in ascending order (A-Z, 0-9). // - // * DataUri - Sets the search - // criteria to the URI of data files used to create the DataSource. The URI can - // identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or - // directory. + // * + // dsc - Arranges the list in descending order (Z-A, 9-0). // - // * IAMUser - Sets the search criteria to the user account that - // invoked the DataSource creation. - FilterVariable types.DataSourceFilterVariable - - // The equal to operator. The DataSource results will have FilterVariable values - // that exactly match the value specified with EQ. - EQ *string - - // The greater than or equal to operator. The DataSource results will have - // FilterVariable values that are greater than or equal to the value specified with - // GE. - GE *string + // Results are sorted by + // FilterVariable. + SortOrder types.SortOrder } // Represents the query results from a DescribeDataSources () operation. The diff --git a/service/machinelearning/api_op_DescribeEvaluations.go b/service/machinelearning/api_op_DescribeEvaluations.go index bfd2d2b9b54..d03ff0f0923 100644 --- a/service/machinelearning/api_op_DescribeEvaluations.go +++ b/service/machinelearning/api_op_DescribeEvaluations.go @@ -57,29 +57,9 @@ func (c *Client) DescribeEvaluations(ctx context.Context, params *DescribeEvalua type DescribeEvaluationsInput struct { - // The ID of the page in the paginated results. - NextToken *string - - // The greater than or equal to operator. The Evaluation results will have - // FilterVariable values that are greater than or equal to the value specified with - // GE. - GE *string - - // A two-value parameter that determines the sequence of the resulting list of - // Evaluation. - // - // * asc - Arranges the list in ascending order (A-Z, 0-9). - // - // * - // dsc - Arranges the list in descending order (Z-A, 9-0). - // - // Results are sorted by - // FilterVariable. - SortOrder types.SortOrder - - // The greater than operator. The Evaluation results will have FilterVariable - // values that are greater than the value specified with GT. - GT *string + // The equal to operator. The Evaluation results will have FilterVariable values + // that exactly match the value specified with EQ. + EQ *string // Use one of the following variable to filter a list of Evaluation objects: // @@ -107,19 +87,14 @@ type DescribeEvaluationsInput struct { // bucket or directory. FilterVariable types.EvaluationFilterVariable - // A string that is found at the beginning of a variable, such as Name or Id. For - // example, an Evaluation could have the Name2014-09-09-HolidayGiftMailer. To - // search for this Evaluation, select Name for the FilterVariable and any of the - // following strings for the Prefix: - Prefix *string - - // The equal to operator. The Evaluation results will have FilterVariable values - // that exactly match the value specified with EQ. - EQ *string + // The greater than or equal to operator. The Evaluation results will have + // FilterVariable values that are greater than or equal to the value specified with + // GE. + GE *string - // The maximum number of Evaluation to include in the result. - Limit *int32 + // The greater than operator. The Evaluation results will have FilterVariable + // values that are greater than the value specified with GT. + GT *string // The less than or equal to operator. The Evaluation results will have // FilterVariable values that are less than or equal to the value specified with @@ -130,22 +105,47 @@ type DescribeEvaluationsInput struct { // that are less than the value specified with LT. LT *string + // The maximum number of Evaluation to include in the result. + Limit *int32 + // The not equal to operator. The Evaluation results will have FilterVariable // values not equal to the value specified with NE. NE *string + + // The ID of the page in the paginated results. + NextToken *string + + // A string that is found at the beginning of a variable, such as Name or Id. For + // example, an Evaluation could have the Name2014-09-09-HolidayGiftMailer. To + // search for this Evaluation, select Name for the FilterVariable and any of the + // following strings for the Prefix: + Prefix *string + + // A two-value parameter that determines the sequence of the resulting list of + // Evaluation. + // + // * asc - Arranges the list in ascending order (A-Z, 0-9). + // + // * + // dsc - Arranges the list in descending order (Z-A, 9-0). + // + // Results are sorted by + // FilterVariable. + SortOrder types.SortOrder } // Represents the query results from a DescribeEvaluations operation. The content // is essentially a list of Evaluation. type DescribeEvaluationsOutput struct { - // A list of Evaluation that meet the search criteria. - Results []*types.Evaluation - // The ID of the next page in the paginated results that indicates at least one // more page follows. NextToken *string + // A list of Evaluation that meet the search criteria. + Results []*types.Evaluation + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/machinelearning/api_op_DescribeMLModels.go b/service/machinelearning/api_op_DescribeMLModels.go index 8b6f5008448..5e5e36e3b42 100644 --- a/service/machinelearning/api_op_DescribeMLModels.go +++ b/service/machinelearning/api_op_DescribeMLModels.go @@ -56,44 +56,6 @@ func (c *Client) DescribeMLModels(ctx context.Context, params *DescribeMLModelsI type DescribeMLModelsInput struct { - // The not equal to operator. The MLModel results will have FilterVariable values - // not equal to the value specified with NE. - NE *string - - // The less than operator. The MLModel results will have FilterVariable values that - // are less than the value specified with LT. - LT *string - - // A string that is found at the beginning of a variable, such as Name or Id. For - // example, an MLModel could have the Name2014-09-09-HolidayGiftMailer. To search - // for this MLModel, select Name for the FilterVariable and any of the following - // strings for the Prefix: - Prefix *string - - // The less than or equal to operator. The MLModel results will have FilterVariable - // values that are less than or equal to the value specified with LE. - LE *string - - // A two-value parameter that determines the sequence of the resulting list of - // MLModel. - // - // * asc - Arranges the list in ascending order (A-Z, 0-9). - // - // * - // dsc - Arranges the list in descending order (Z-A, 9-0). - // - // Results are sorted by - // FilterVariable. - SortOrder types.SortOrder - - // The ID of the page in the paginated results. - NextToken *string - - // The number of pages of information to include in the result. The range of - // acceptable values is 1 through 100. The default value is 100. - Limit *int32 - // The equal to operator. The MLModel results will have FilterVariable values that // exactly match the value specified with EQ. EQ *string @@ -131,27 +93,65 @@ type DescribeMLModelsInput struct { // directory. FilterVariable types.MLModelFilterVariable - // The greater than operator. The MLModel results will have FilterVariable values - // that are greater than the value specified with GT. - GT *string - // The greater than or equal to operator. The MLModel results will have // FilterVariable values that are greater than or equal to the value specified with // GE. GE *string + + // The greater than operator. The MLModel results will have FilterVariable values + // that are greater than the value specified with GT. + GT *string + + // The less than or equal to operator. The MLModel results will have FilterVariable + // values that are less than or equal to the value specified with LE. + LE *string + + // The less than operator. The MLModel results will have FilterVariable values that + // are less than the value specified with LT. + LT *string + + // The number of pages of information to include in the result. The range of + // acceptable values is 1 through 100. The default value is 100. + Limit *int32 + + // The not equal to operator. The MLModel results will have FilterVariable values + // not equal to the value specified with NE. + NE *string + + // The ID of the page in the paginated results. + NextToken *string + + // A string that is found at the beginning of a variable, such as Name or Id. For + // example, an MLModel could have the Name2014-09-09-HolidayGiftMailer. To search + // for this MLModel, select Name for the FilterVariable and any of the following + // strings for the Prefix: + Prefix *string + + // A two-value parameter that determines the sequence of the resulting list of + // MLModel. + // + // * asc - Arranges the list in ascending order (A-Z, 0-9). + // + // * + // dsc - Arranges the list in descending order (Z-A, 9-0). + // + // Results are sorted by + // FilterVariable. + SortOrder types.SortOrder } // Represents the output of a DescribeMLModels operation. The content is // essentially a list of MLModel. type DescribeMLModelsOutput struct { - // A list of MLModel that meet the search criteria. - Results []*types.MLModel - // The ID of the next page in the paginated results that indicates at least one // more page follows. NextToken *string + // A list of MLModel that meet the search criteria. + Results []*types.MLModel + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/machinelearning/api_op_DescribeTags.go b/service/machinelearning/api_op_DescribeTags.go index 8dffa4818a8..eae5f0f34ee 100644 --- a/service/machinelearning/api_op_DescribeTags.go +++ b/service/machinelearning/api_op_DescribeTags.go @@ -71,14 +71,14 @@ type DescribeTagsInput struct { // Amazon ML returns the following elements. type DescribeTagsOutput struct { - // A list of tags associated with the ML object. - Tags []*types.Tag + // The ID of the tagged ML object. + ResourceId *string // The type of the tagged ML object. ResourceType types.TaggableResourceType - // The ID of the tagged ML object. - ResourceId *string + // A list of tags associated with the ML object. + Tags []*types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/machinelearning/api_op_GetBatchPrediction.go b/service/machinelearning/api_op_GetBatchPrediction.go index a1942aa9518..cb105bcea20 100644 --- a/service/machinelearning/api_op_GetBatchPrediction.go +++ b/service/machinelearning/api_op_GetBatchPrediction.go @@ -69,49 +69,8 @@ type GetBatchPredictionInput struct { // BatchPrediction. type GetBatchPredictionOutput struct { - // The ID of the MLModel that generated predictions for the BatchPrediction - // request. - MLModelId *string - - // The time when the BatchPrediction was created. The time is expressed in epoch - // time. - CreatedAt *time.Time - - // The status of the BatchPrediction, which can be one of the following values: - // - // - // * PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate - // batch predictions. - // - // * INPROGRESS - The batch predictions are in progress. - // - // - // * FAILED - The request to perform a batch prediction did not run to completion. - // It is not usable. - // - // * COMPLETED - The batch prediction process completed - // successfully. - // - // * DELETED - The BatchPrediction is marked as deleted. It is - // not usable. - Status types.EntityStatus - - // The time of the most recent edit to BatchPrediction. The time is expressed in - // epoch time. - LastUpdatedAt *time.Time - - // The number of total records that Amazon Machine Learning saw while processing - // the BatchPrediction. - TotalRecordCount *int64 - - // The number of invalid records that Amazon Machine Learning saw while processing - // the BatchPrediction. - InvalidRecordCount *int64 - - // The epoch time when Amazon Machine Learning marked the BatchPrediction as - // INPROGRESS. StartedAt isn't available if the BatchPrediction is in the PENDING - // state. - StartedAt *time.Time + // The ID of the DataSource that was used to create the BatchPrediction. + BatchPredictionDataSourceId *string // An ID assigned to the BatchPrediction at creation. This value should be // identical to the value of the BatchPredictionID in the request. @@ -122,6 +81,10 @@ type GetBatchPredictionOutput struct { // ComputeTime is only available if the BatchPrediction is in the COMPLETED state. ComputeTime *int64 + // The time when the BatchPrediction was created. The time is expressed in epoch + // time. + CreatedAt *time.Time + // The AWS user account that invoked the BatchPrediction. The account type can be // either an AWS root account or an AWS Identity and Access Management (IAM) user // account. @@ -136,16 +99,25 @@ type GetBatchPredictionOutput struct { // (Amazon S3). InputDataLocationS3 *string + // The number of invalid records that Amazon Machine Learning saw while processing + // the BatchPrediction. + InvalidRecordCount *int64 + + // The time of the most recent edit to BatchPrediction. The time is expressed in + // epoch time. + LastUpdatedAt *time.Time + // A link to the file that contains logs of the CreateBatchPrediction operation. LogUri *string + // The ID of the MLModel that generated predictions for the BatchPrediction + // request. + MLModelId *string + // A description of the most recent details about processing the batch prediction // request. Message *string - // The ID of the DataSource that was used to create the BatchPrediction. - BatchPredictionDataSourceId *string - // A user-supplied name or description of the BatchPrediction. Name *string @@ -153,6 +125,34 @@ type GetBatchPredictionOutput struct { // results. OutputUri *string + // The epoch time when Amazon Machine Learning marked the BatchPrediction as + // INPROGRESS. StartedAt isn't available if the BatchPrediction is in the PENDING + // state. + StartedAt *time.Time + + // The status of the BatchPrediction, which can be one of the following values: + // + // + // * PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate + // batch predictions. + // + // * INPROGRESS - The batch predictions are in progress. + // + // + // * FAILED - The request to perform a batch prediction did not run to completion. + // It is not usable. + // + // * COMPLETED - The batch prediction process completed + // successfully. + // + // * DELETED - The BatchPrediction is marked as deleted. It is + // not usable. + Status types.EntityStatus + + // The number of total records that Amazon Machine Learning saw while processing + // the BatchPrediction. + TotalRecordCount *int64 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/machinelearning/api_op_GetDataSource.go b/service/machinelearning/api_op_GetDataSource.go index 01f18998824..dcb2dd17fe9 100644 --- a/service/machinelearning/api_op_GetDataSource.go +++ b/service/machinelearning/api_op_GetDataSource.go @@ -74,13 +74,9 @@ type GetDataSourceInput struct { // Represents the output of a GetDataSource operation and describes a DataSource. type GetDataSourceOutput struct { - // The epoch time when Amazon Machine Learning marked the DataSource as INPROGRESS. - // StartedAt isn't available if the DataSource is in the PENDING state. - StartedAt *time.Time - - // The schema used by all of the data files of this DataSource. Note: This - // parameter is provided as part of the verbose format. - DataSourceSchema *string + // The parameter is true if statistics need to be generated from the observation + // data. + ComputeStatistics *bool // The approximate CPU time in milliseconds that Amazon Machine Learning spent // processing the DataSource, normalized and scaled on computation resources. @@ -88,37 +84,70 @@ type GetDataSourceOutput struct { // the ComputeStatistics is set to true. ComputeTime *int64 - // A user-supplied name or description of the DataSource. - Name *string - - // The ID assigned to the DataSource at creation. This value should be identical to - // the value of the DataSourceId in the request. - DataSourceId *string + // The time that the DataSource was created. The time is expressed in epoch time. + CreatedAt *time.Time // The AWS user account from which the DataSource was created. The account type can // be either an AWS root account or an AWS Identity and Access Management (IAM) // user account. CreatedByIamUser *string - // The user-supplied description of the most recent details about creating the - // DataSource. - Message *string + // The location of the data file or directory in Amazon Simple Storage Service + // (Amazon S3). + DataLocationS3 *string + + // A JSON string that represents the splitting and rearrangement requirement used + // when this DataSource was created. + DataRearrangement *string // The total size of observations in the data files. DataSizeInBytes *int64 - // The parameter is true if statistics need to be generated from the observation - // data. - ComputeStatistics *bool + // The ID assigned to the DataSource at creation. This value should be identical to + // the value of the DataSourceId in the request. + DataSourceId *string + + // The schema used by all of the data files of this DataSource. Note: This + // parameter is provided as part of the verbose format. + DataSourceSchema *string // The epoch time when Amazon Machine Learning marked the DataSource as COMPLETED // or FAILED. FinishedAt is only available when the DataSource is in the COMPLETED // or FAILED state. FinishedAt *time.Time + // The time of the most recent edit to the DataSource. The time is expressed in + // epoch time. + LastUpdatedAt *time.Time + // A link to the file containing logs of CreateDataSourceFrom* operations. LogUri *string + // The user-supplied description of the most recent details about creating the + // DataSource. + Message *string + + // A user-supplied name or description of the DataSource. + Name *string + + // The number of data files referenced by the DataSource. + NumberOfFiles *int64 + + // The datasource details that are specific to Amazon RDS. + RDSMetadata *types.RDSMetadata + + // Describes the DataSource details specific to Amazon Redshift. + RedshiftMetadata *types.RedshiftMetadata + + // The Amazon Resource Name (ARN) of an AWS IAM Role + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html#roles-about-termsandconcepts), + // such as the following: arn:aws:iam::account:role/rolename. + RoleARN *string + + // The epoch time when Amazon Machine Learning marked the DataSource as INPROGRESS. + // StartedAt isn't available if the DataSource is in the PENDING state. + StartedAt *time.Time + // The current status of the DataSource. This element can have one of the following // values: // @@ -137,35 +166,6 @@ type GetDataSourceOutput struct { // DataSource is marked as deleted. It is not usable. Status types.EntityStatus - // The datasource details that are specific to Amazon RDS. - RDSMetadata *types.RDSMetadata - - // The location of the data file or directory in Amazon Simple Storage Service - // (Amazon S3). - DataLocationS3 *string - - // Describes the DataSource details specific to Amazon Redshift. - RedshiftMetadata *types.RedshiftMetadata - - // The number of data files referenced by the DataSource. - NumberOfFiles *int64 - - // The Amazon Resource Name (ARN) of an AWS IAM Role - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html#roles-about-termsandconcepts), - // such as the following: arn:aws:iam::account:role/rolename. - RoleARN *string - - // The time that the DataSource was created. The time is expressed in epoch time. - CreatedAt *time.Time - - // A JSON string that represents the splitting and rearrangement requirement used - // when this DataSource was created. - DataRearrangement *string - - // The time of the most recent edit to the DataSource. The time is expressed in - // epoch time. - LastUpdatedAt *time.Time - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/machinelearning/api_op_GetEvaluation.go b/service/machinelearning/api_op_GetEvaluation.go index 276f82d0125..b9a1b12cdb5 100644 --- a/service/machinelearning/api_op_GetEvaluation.go +++ b/service/machinelearning/api_op_GetEvaluation.go @@ -69,49 +69,48 @@ type GetEvaluationInput struct { // Represents the output of a GetEvaluation operation and describes an Evaluation. type GetEvaluationOutput struct { - // The evaluation ID which is same as the EvaluationId in the request. - EvaluationId *string - - // The epoch time when Amazon Machine Learning marked the Evaluation as INPROGRESS. - // StartedAt isn't available if the Evaluation is in the PENDING state. - StartedAt *time.Time + // The approximate CPU time in milliseconds that Amazon Machine Learning spent + // processing the Evaluation, normalized and scaled on computation resources. + // ComputeTime is only available if the Evaluation is in the COMPLETED state. + ComputeTime *int64 - // A user-supplied name or description of the Evaluation. - Name *string + // The time that the Evaluation was created. The time is expressed in epoch time. + CreatedAt *time.Time // The AWS user account that invoked the evaluation. The account type can be either // an AWS root account or an AWS Identity and Access Management (IAM) user account. CreatedByIamUser *string - // A description of the most recent details about evaluating the MLModel. - Message *string - // The DataSource used for this evaluation. EvaluationDataSourceId *string + // The evaluation ID which is same as the EvaluationId in the request. + EvaluationId *string + // The epoch time when Amazon Machine Learning marked the Evaluation as COMPLETED // or FAILED. FinishedAt is only available when the Evaluation is in the COMPLETED // or FAILED state. FinishedAt *time.Time - // The approximate CPU time in milliseconds that Amazon Machine Learning spent - // processing the Evaluation, normalized and scaled on computation resources. - // ComputeTime is only available if the Evaluation is in the COMPLETED state. - ComputeTime *int64 - - // The time that the Evaluation was created. The time is expressed in epoch time. - CreatedAt *time.Time + // The location of the data file or directory in Amazon Simple Storage Service + // (Amazon S3). + InputDataLocationS3 *string // The time of the most recent edit to the Evaluation. The time is expressed in // epoch time. LastUpdatedAt *time.Time + // A link to the file that contains logs of the CreateEvaluation operation. + LogUri *string + // The ID of the MLModel that was the focus of the evaluation. MLModelId *string - // The location of the data file or directory in Amazon Simple Storage Service - // (Amazon S3). - InputDataLocationS3 *string + // A description of the most recent details about evaluating the MLModel. + Message *string + + // A user-supplied name or description of the Evaluation. + Name *string // Measurements of how well the MLModel performed using observations referenced by // the DataSource. One of the following metric is returned based on the type of the @@ -133,6 +132,10 @@ type GetEvaluationOutput struct { // (https://docs.aws.amazon.com/machine-learning/latest/dg). PerformanceMetrics *types.PerformanceMetrics + // The epoch time when Amazon Machine Learning marked the Evaluation as INPROGRESS. + // StartedAt isn't available if the Evaluation is in the PENDING state. + StartedAt *time.Time + // The status of the evaluation. This element can have one of the following // values: // @@ -151,9 +154,6 @@ type GetEvaluationOutput struct { // DELETED - The Evaluation is marked as deleted. It is not usable. Status types.EntityStatus - // A link to the file that contains logs of the CreateEvaluation operation. - LogUri *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/machinelearning/api_op_GetMLModel.go b/service/machinelearning/api_op_GetMLModel.go index e0de4fe4eca..b9b4089d35b 100644 --- a/service/machinelearning/api_op_GetMLModel.go +++ b/service/machinelearning/api_op_GetMLModel.go @@ -60,59 +60,54 @@ func (c *Client) GetMLModel(ctx context.Context, params *GetMLModelInput, optFns type GetMLModelInput struct { - // Specifies whether the GetMLModel operation should return Recipe. If true, Recipe - // is returned. If false, Recipe is not returned. - Verbose *bool - // The ID assigned to the MLModel at creation. // // This member is required. MLModelId *string + + // Specifies whether the GetMLModel operation should return Recipe. If true, Recipe + // is returned. If false, Recipe is not returned. + Verbose *bool } // Represents the output of a GetMLModel operation, and provides detailed // information about a MLModel. type GetMLModelOutput struct { - // The recipe to use when training the MLModel. The Recipe provides detailed - // information about the observation data to use during training, and manipulations - // to perform on the observation data during training. Note: This parameter is - // provided as part of the verbose format. - Recipe *string - - // A user-supplied name or description of the MLModel. - Name *string + // The approximate CPU time in milliseconds that Amazon Machine Learning spent + // processing the MLModel, normalized and scaled on computation resources. + // ComputeTime is only available if the MLModel is in the COMPLETED state. + ComputeTime *int64 - // A description of the most recent details about accessing the MLModel. - Message *string + // The time that the MLModel was created. The time is expressed in epoch time. + CreatedAt *time.Time // The AWS user account from which the MLModel was created. The account type can be // either an AWS root account or an AWS Identity and Access Management (IAM) user // account. CreatedByIamUser *string - // The MLModel ID, which is same as the MLModelId in the request. - MLModelId *string + // The current endpoint of the MLModel + EndpointInfo *types.RealtimeEndpointInfo + + // The epoch time when Amazon Machine Learning marked the MLModel as COMPLETED or + // FAILED. FinishedAt is only available when the MLModel is in the COMPLETED or + // FAILED state. + FinishedAt *time.Time + + // The location of the data file or directory in Amazon Simple Storage Service + // (Amazon S3). + InputDataLocationS3 *string // The time of the most recent edit to the MLModel. The time is expressed in epoch // time. LastUpdatedAt *time.Time - // The time of the most recent edit to the ScoreThreshold. The time is expressed in - // epoch time. - ScoreThresholdLastUpdatedAt *time.Time - - // The time that the MLModel was created. The time is expressed in epoch time. - CreatedAt *time.Time - - // The current endpoint of the MLModel - EndpointInfo *types.RealtimeEndpointInfo - - // The ID of the training DataSource. - TrainingDataSourceId *string + // A link to the file that contains logs of the CreateMLModel operation. + LogUri *string - // Long integer type that is a 64-bit signed number. - SizeInBytes *int64 + // The MLModel ID, which is same as the MLModelId in the request. + MLModelId *string // Identifies the MLModel category. The following are the available types: // @@ -128,6 +123,61 @@ type GetMLModelOutput struct { // trade?" MLModelType types.MLModelType + // A description of the most recent details about accessing the MLModel. + Message *string + + // A user-supplied name or description of the MLModel. + Name *string + + // The recipe to use when training the MLModel. The Recipe provides detailed + // information about the observation data to use during training, and manipulations + // to perform on the observation data during training. Note: This parameter is + // provided as part of the verbose format. + Recipe *string + + // The schema used by all of the data files referenced by the DataSource. Note: + // This parameter is provided as part of the verbose format. + Schema *string + + // The scoring threshold is used in binary classification MLModel models. It marks + // the boundary between a positive prediction and a negative prediction. Output + // values greater than or equal to the threshold receive a positive result from the + // MLModel, such as true. Output values less than the threshold receive a negative + // response from the MLModel, such as false. + ScoreThreshold *float32 + + // The time of the most recent edit to the ScoreThreshold. The time is expressed in + // epoch time. + ScoreThresholdLastUpdatedAt *time.Time + + // Long integer type that is a 64-bit signed number. + SizeInBytes *int64 + + // The epoch time when Amazon Machine Learning marked the MLModel as INPROGRESS. + // StartedAt isn't available if the MLModel is in the PENDING state. + StartedAt *time.Time + + // The current status of the MLModel. This element can have one of the following + // values: + // + // * PENDING - Amazon Machine Learning (Amazon ML) submitted a request + // to describe a MLModel. + // + // * INPROGRESS - The request is processing. + // + // * + // FAILED - The request did not run to completion. The ML model isn't usable. + // + // + // * COMPLETED - The request completed successfully. + // + // * DELETED - The MLModel + // is marked as deleted. It isn't usable. + Status types.EntityStatus + + // The ID of the training DataSource. + TrainingDataSourceId *string + // A list of the training parameters in the MLModel. The list is implemented as a // map of key-value pairs. The following is the current set of training // parameters: @@ -164,56 +214,6 @@ type GetMLModelOutput struct { // can't be used when L1 is specified. Use this parameter sparingly. TrainingParameters map[string]*string - // The scoring threshold is used in binary classification MLModel models. It marks - // the boundary between a positive prediction and a negative prediction. Output - // values greater than or equal to the threshold receive a positive result from the - // MLModel, such as true. Output values less than the threshold receive a negative - // response from the MLModel, such as false. - ScoreThreshold *float32 - - // A link to the file that contains logs of the CreateMLModel operation. - LogUri *string - - // The schema used by all of the data files referenced by the DataSource. Note: - // This parameter is provided as part of the verbose format. - Schema *string - - // The approximate CPU time in milliseconds that Amazon Machine Learning spent - // processing the MLModel, normalized and scaled on computation resources. - // ComputeTime is only available if the MLModel is in the COMPLETED state. - ComputeTime *int64 - - // The epoch time when Amazon Machine Learning marked the MLModel as COMPLETED or - // FAILED. FinishedAt is only available when the MLModel is in the COMPLETED or - // FAILED state. - FinishedAt *time.Time - - // The current status of the MLModel. This element can have one of the following - // values: - // - // * PENDING - Amazon Machine Learning (Amazon ML) submitted a request - // to describe a MLModel. - // - // * INPROGRESS - The request is processing. - // - // * - // FAILED - The request did not run to completion. The ML model isn't usable. - // - // - // * COMPLETED - The request completed successfully. - // - // * DELETED - The MLModel - // is marked as deleted. It isn't usable. - Status types.EntityStatus - - // The location of the data file or directory in Amazon Simple Storage Service - // (Amazon S3). - InputDataLocationS3 *string - - // The epoch time when Amazon Machine Learning marked the MLModel as INPROGRESS. - // StartedAt isn't available if the MLModel is in the PENDING state. - StartedAt *time.Time - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/machinelearning/api_op_Predict.go b/service/machinelearning/api_op_Predict.go index d1ce8e53cbe..dee2f8b43f6 100644 --- a/service/machinelearning/api_op_Predict.go +++ b/service/machinelearning/api_op_Predict.go @@ -59,11 +59,6 @@ func (c *Client) Predict(ctx context.Context, params *PredictInput, optFns ...fu type PredictInput struct { - // A map of variable name-value pairs that represent an observation. - // - // This member is required. - Record map[string]*string - // A unique identifier of the MLModel. // // This member is required. @@ -73,6 +68,11 @@ type PredictInput struct { // // This member is required. PredictEndpoint *string + + // A map of variable name-value pairs that represent an observation. + // + // This member is required. + Record map[string]*string } type PredictOutput struct { diff --git a/service/machinelearning/api_op_UpdateBatchPrediction.go b/service/machinelearning/api_op_UpdateBatchPrediction.go index ff173a25a85..6ba394289d8 100644 --- a/service/machinelearning/api_op_UpdateBatchPrediction.go +++ b/service/machinelearning/api_op_UpdateBatchPrediction.go @@ -57,15 +57,15 @@ func (c *Client) UpdateBatchPrediction(ctx context.Context, params *UpdateBatchP type UpdateBatchPredictionInput struct { - // A new user-supplied name or description of the BatchPrediction. + // The ID assigned to the BatchPrediction during creation. // // This member is required. - BatchPredictionName *string + BatchPredictionId *string - // The ID assigned to the BatchPrediction during creation. + // A new user-supplied name or description of the BatchPrediction. // // This member is required. - BatchPredictionId *string + BatchPredictionName *string } // Represents the output of an UpdateBatchPrediction operation. You can see the diff --git a/service/machinelearning/api_op_UpdateEvaluation.go b/service/machinelearning/api_op_UpdateEvaluation.go index 7e72e573b6d..8d013b65e65 100644 --- a/service/machinelearning/api_op_UpdateEvaluation.go +++ b/service/machinelearning/api_op_UpdateEvaluation.go @@ -57,16 +57,16 @@ func (c *Client) UpdateEvaluation(ctx context.Context, params *UpdateEvaluationI type UpdateEvaluationInput struct { - // A new user-supplied name or description of the Evaluation that will replace the - // current content. + // The ID assigned to the Evaluation during creation. // // This member is required. - EvaluationName *string + EvaluationId *string - // The ID assigned to the Evaluation during creation. + // A new user-supplied name or description of the Evaluation that will replace the + // current content. // // This member is required. - EvaluationId *string + EvaluationName *string } // Represents the output of an UpdateEvaluation operation. You can see the updated diff --git a/service/machinelearning/api_op_UpdateMLModel.go b/service/machinelearning/api_op_UpdateMLModel.go index e6189a2f5b4..03c9164b261 100644 --- a/service/machinelearning/api_op_UpdateMLModel.go +++ b/service/machinelearning/api_op_UpdateMLModel.go @@ -57,20 +57,20 @@ func (c *Client) UpdateMLModel(ctx context.Context, params *UpdateMLModelInput, type UpdateMLModelInput struct { + // The ID assigned to the MLModel during creation. + // + // This member is required. + MLModelId *string + + // A user-supplied name or description of the MLModel. + MLModelName *string + // The ScoreThreshold used in binary classification MLModel that marks the boundary // between a positive prediction and a negative prediction. Output values greater // than or equal to the ScoreThreshold receive a positive result from the MLModel, // such as true. Output values less than the ScoreThreshold receive a negative // response from the MLModel, such as false. ScoreThreshold *float32 - - // A user-supplied name or description of the MLModel. - MLModelName *string - - // The ID assigned to the MLModel during creation. - // - // This member is required. - MLModelId *string } // Represents the output of an UpdateMLModel operation. You can see the updated diff --git a/service/machinelearning/go.mod b/service/machinelearning/go.mod index a894c243d6a..6aed46f9d43 100644 --- a/service/machinelearning/go.mod +++ b/service/machinelearning/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/machinelearning go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/machinelearning/types/types.go b/service/machinelearning/types/types.go index 53cf5067916..0796a05a7a7 100644 --- a/service/machinelearning/types/types.go +++ b/service/machinelearning/types/types.go @@ -11,79 +11,79 @@ import ( // Prediction. type BatchPrediction struct { - // The status of the BatchPrediction. This element can have one of the following - // values: - // - // * PENDING - Amazon Machine Learning (Amazon ML) submitted a request - // to generate predictions for a batch of observations. - // - // * INPROGRESS - The - // process is underway. - // - // * FAILED - The request to perform a batch prediction - // did not run to completion. It is not usable. - // - // * COMPLETED - The batch - // prediction process completed successfully. - // - // * DELETED - The BatchPrediction - // is marked as deleted. It is not usable. - Status EntityStatus - - // Long integer type that is a 64-bit signed number. - TotalRecordCount *int64 + // The ID of the DataSource that points to the group of observations to predict. + BatchPredictionDataSourceId *string - // The time of the most recent edit to the BatchPrediction. The time is expressed - // in epoch time. - LastUpdatedAt *time.Time + // The ID assigned to the BatchPrediction at creation. This value should be + // identical to the value of the BatchPredictionID in the request. + BatchPredictionId *string - // A description of the most recent details about processing the batch prediction - // request. - Message *string + // Long integer type that is a 64-bit signed number. + ComputeTime *int64 // The time that the BatchPrediction was created. The time is expressed in epoch // time. CreatedAt *time.Time + // The AWS user account that invoked the BatchPrediction. The account type can be + // either an AWS root account or an AWS Identity and Access Management (IAM) user + // account. + CreatedByIamUser *string + + // A timestamp represented in epoch time. + FinishedAt *time.Time + + // The location of the data file or directory in Amazon Simple Storage Service + // (Amazon S3). + InputDataLocationS3 *string + // Long integer type that is a 64-bit signed number. InvalidRecordCount *int64 - // The location of an Amazon S3 bucket or directory to receive the operation - // results. The following substrings are not allowed in the s3 key portion of the - // outputURI field: ':', '//', '/./', '/../'. - OutputUri *string + // The time of the most recent edit to the BatchPrediction. The time is expressed + // in epoch time. + LastUpdatedAt *time.Time // The ID of the MLModel that generated predictions for the BatchPrediction // request. MLModelId *string - // The ID of the DataSource that points to the group of observations to predict. - BatchPredictionDataSourceId *string + // A description of the most recent details about processing the batch prediction + // request. + Message *string // A user-supplied name or description of the BatchPrediction. Name *string - // The location of the data file or directory in Amazon Simple Storage Service - // (Amazon S3). - InputDataLocationS3 *string - - // Long integer type that is a 64-bit signed number. - ComputeTime *int64 - - // A timestamp represented in epoch time. - FinishedAt *time.Time - - // The ID assigned to the BatchPrediction at creation. This value should be - // identical to the value of the BatchPredictionID in the request. - BatchPredictionId *string + // The location of an Amazon S3 bucket or directory to receive the operation + // results. The following substrings are not allowed in the s3 key portion of the + // outputURI field: ':', '//', '/./', '/../'. + OutputUri *string // A timestamp represented in epoch time. StartedAt *time.Time - // The AWS user account that invoked the BatchPrediction. The account type can be - // either an AWS root account or an AWS Identity and Access Management (IAM) user - // account. - CreatedByIamUser *string + // The status of the BatchPrediction. This element can have one of the following + // values: + // + // * PENDING - Amazon Machine Learning (Amazon ML) submitted a request + // to generate predictions for a batch of observations. + // + // * INPROGRESS - The + // process is underway. + // + // * FAILED - The request to perform a batch prediction + // did not run to completion. It is not usable. + // + // * COMPLETED - The batch + // prediction process completed successfully. + // + // * DELETED - The BatchPrediction + // is marked as deleted. It is not usable. + Status EntityStatus + + // Long integer type that is a 64-bit signed number. + TotalRecordCount *int64 } // Represents the output of the GetDataSource operation. The content consists of @@ -91,43 +91,66 @@ type BatchPrediction struct { // DataSource. type DataSource struct { + // The parameter is true if statistics need to be generated from the observation + // data. + ComputeStatistics *bool + + // Long integer type that is a 64-bit signed number. + ComputeTime *int64 + + // The time that the DataSource was created. The time is expressed in epoch time. + CreatedAt *time.Time + + // The AWS user account from which the DataSource was created. The account type can + // be either an AWS root account or an AWS Identity and Access Management (IAM) + // user account. + CreatedByIamUser *string + // The location and name of the data in Amazon Simple Storage Service (Amazon S3) // that is used by a DataSource. DataLocationS3 *string - // The number of data files referenced by the DataSource. - NumberOfFiles *int64 - - // Describes the DataSource details specific to Amazon Redshift. - RedshiftMetadata *RedshiftMetadata - // A JSON string that represents the splitting and rearrangement requirement used // when this DataSource was created. DataRearrangement *string - // Long integer type that is a 64-bit signed number. - ComputeTime *int64 + // The total number of observations contained in the data files that the DataSource + // references. + DataSizeInBytes *int64 + + // The ID that is assigned to the DataSource during creation. + DataSourceId *string // A timestamp represented in epoch time. FinishedAt *time.Time - // The parameter is true if statistics need to be generated from the observation - // data. - ComputeStatistics *bool + // The time of the most recent edit to the BatchPrediction. The time is expressed + // in epoch time. + LastUpdatedAt *time.Time - // The total number of observations contained in the data files that the DataSource - // references. - DataSizeInBytes *int64 + // A description of the most recent details about creating the DataSource. + Message *string + + // A user-supplied name or description of the DataSource. + Name *string + + // The number of data files referenced by the DataSource. + NumberOfFiles *int64 // The datasource details that are specific to Amazon RDS. RDSMetadata *RDSMetadata + // Describes the DataSource details specific to Amazon Redshift. + RedshiftMetadata *RedshiftMetadata + + // The Amazon Resource Name (ARN) of an AWS IAM Role + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html#roles-about-termsandconcepts), + // such as the following: arn:aws:iam::account:role/rolename. + RoleARN *string + // A timestamp represented in epoch time. StartedAt *time.Time - // A description of the most recent details about creating the DataSource. - Message *string - // The current status of the DataSource. This element can have one of the following // values: // @@ -145,35 +168,48 @@ type DataSource struct { // // * DELETED - The DataSource is marked as deleted. It is not usable. Status EntityStatus +} - // The Amazon Resource Name (ARN) of an AWS IAM Role - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html#roles-about-termsandconcepts), - // such as the following: arn:aws:iam::account:role/rolename. - RoleARN *string +// Represents the output of GetEvaluation operation. The content consists of the +// detailed metadata and data file information and the current status of the +// Evaluation. +type Evaluation struct { - // The ID that is assigned to the DataSource during creation. - DataSourceId *string + // Long integer type that is a 64-bit signed number. + ComputeTime *int64 - // A user-supplied name or description of the DataSource. - Name *string + // The time that the Evaluation was created. The time is expressed in epoch time. + CreatedAt *time.Time - // The AWS user account from which the DataSource was created. The account type can - // be either an AWS root account or an AWS Identity and Access Management (IAM) - // user account. + // The AWS user account that invoked the evaluation. The account type can be either + // an AWS root account or an AWS Identity and Access Management (IAM) user account. CreatedByIamUser *string - // The time of the most recent edit to the BatchPrediction. The time is expressed - // in epoch time. + // The ID of the DataSource that is used to evaluate the MLModel. + EvaluationDataSourceId *string + + // The ID that is assigned to the Evaluation at creation. + EvaluationId *string + + // A timestamp represented in epoch time. + FinishedAt *time.Time + + // The location and name of the data in Amazon Simple Storage Server (Amazon S3) + // that is used in the evaluation. + InputDataLocationS3 *string + + // The time of the most recent edit to the Evaluation. The time is expressed in + // epoch time. LastUpdatedAt *time.Time - // The time that the DataSource was created. The time is expressed in epoch time. - CreatedAt *time.Time -} + // The ID of the MLModel that is the focus of the evaluation. + MLModelId *string -// Represents the output of GetEvaluation operation. The content consists of the -// detailed metadata and data file information and the current status of the -// Evaluation. -type Evaluation struct { + // A description of the most recent details about evaluating the MLModel. + Message *string + + // A user-supplied name or description of the Evaluation. + Name *string // Measurements of how well the MLModel performed, using observations referenced by // the DataSource. One of the following metrics is returned, based on the type of @@ -195,34 +231,8 @@ type Evaluation struct { // (https://docs.aws.amazon.com/machine-learning/latest/dg). PerformanceMetrics *PerformanceMetrics - // The time that the Evaluation was created. The time is expressed in epoch time. - CreatedAt *time.Time - - // The ID of the MLModel that is the focus of the evaluation. - MLModelId *string - - // The time of the most recent edit to the Evaluation. The time is expressed in - // epoch time. - LastUpdatedAt *time.Time - - // The ID of the DataSource that is used to evaluate the MLModel. - EvaluationDataSourceId *string - - // The AWS user account that invoked the evaluation. The account type can be either - // an AWS root account or an AWS Identity and Access Management (IAM) user account. - CreatedByIamUser *string - - // A user-supplied name or description of the Evaluation. - Name *string - - // Long integer type that is a 64-bit signed number. - ComputeTime *int64 - - // A description of the most recent details about evaluating the MLModel. - Message *string - - // The ID that is assigned to the Evaluation at creation. - EvaluationId *string + // A timestamp represented in epoch time. + StartedAt *time.Time // The status of the evaluation. This element can have one of the following // values: @@ -241,36 +251,80 @@ type Evaluation struct { // * // DELETED - The Evaluation is marked as deleted. It is not usable. Status EntityStatus - - // The location and name of the data in Amazon Simple Storage Server (Amazon S3) - // that is used in the evaluation. - InputDataLocationS3 *string - - // A timestamp represented in epoch time. - StartedAt *time.Time - - // A timestamp represented in epoch time. - FinishedAt *time.Time } // Represents the output of a GetMLModel operation. The content consists of the // detailed metadata and the current status of the MLModel. type MLModel struct { + // The algorithm used to train the MLModel. The following algorithm is supported: + // + // + // * SGD -- Stochastic gradient descent. The goal of SGD is to minimize the + // gradient of the loss function. + Algorithm Algorithm + + // Long integer type that is a 64-bit signed number. + ComputeTime *int64 + // The time that the MLModel was created. The time is expressed in epoch time. CreatedAt *time.Time + // The AWS user account from which the MLModel was created. The account type can be + // either an AWS root account or an AWS Identity and Access Management (IAM) user + // account. + CreatedByIamUser *string + + // The current endpoint of the MLModel. + EndpointInfo *RealtimeEndpointInfo + // A timestamp represented in epoch time. - StartedAt *time.Time + FinishedAt *time.Time - // The ID of the training DataSource. The CreateMLModel operation uses the - // TrainingDataSourceId. - TrainingDataSourceId *string + // The location of the data file or directory in Amazon Simple Storage Service + // (Amazon S3). + InputDataLocationS3 *string // The time of the most recent edit to the MLModel. The time is expressed in epoch // time. LastUpdatedAt *time.Time + // The ID assigned to the MLModel at creation. + MLModelId *string + + // Identifies the MLModel category. The following are the available types: + // + // * + // REGRESSION - Produces a numeric result. For example, "What price should a house + // be listed at?" + // + // * BINARY - Produces one of two possible results. For + // example, "Is this a child-friendly web site?". + // + // * MULTICLASS - Produces one + // of several possible results. For example, "Is this a HIGH-, LOW-, or MEDIUM-risk + // trade?". + MLModelType MLModelType + + // A description of the most recent details about accessing the MLModel. + Message *string + + // A user-supplied name or description of the MLModel. + Name *string + + // The score threshold for the MLModel. + ScoreThreshold *float32 + + // The time of the most recent edit to the ScoreThreshold. The time is expressed in + // epoch time. + ScoreThresholdLastUpdatedAt *time.Time + + // Long integer type that is a 64-bit signed number. + SizeInBytes *int64 + + // A timestamp represented in epoch time. + StartedAt *time.Time + // The current status of an MLModel. This element can have one of the following // values: // @@ -289,31 +343,9 @@ type MLModel struct { // * DELETED - The MLModel is marked as deleted. It isn't usable. Status EntityStatus - // A user-supplied name or description of the MLModel. - Name *string - - // The ID assigned to the MLModel at creation. - MLModelId *string - - // A description of the most recent details about accessing the MLModel. - Message *string - - // Identifies the MLModel category. The following are the available types: - // - // * - // REGRESSION - Produces a numeric result. For example, "What price should a house - // be listed at?" - // - // * BINARY - Produces one of two possible results. For - // example, "Is this a child-friendly web site?". - // - // * MULTICLASS - Produces one - // of several possible results. For example, "Is this a HIGH-, LOW-, or MEDIUM-risk - // trade?". - MLModelType MLModelType - - // The current endpoint of the MLModel. - EndpointInfo *RealtimeEndpointInfo + // The ID of the training DataSource. The CreateMLModel operation uses the + // TrainingDataSourceId. + TrainingDataSourceId *string // A list of the training parameters in the MLModel. The list is implemented as a // map of key-value pairs. The following is the current set of training @@ -348,40 +380,8 @@ type MLModel struct { // use this parameter, start by specifying a small value, such as 1.0E-08. The // value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2 // normalization. This parameter can't be used when L1 is specified. Use this - // parameter sparingly. - TrainingParameters map[string]*string - - // Long integer type that is a 64-bit signed number. - SizeInBytes *int64 - - // The time of the most recent edit to the ScoreThreshold. The time is expressed in - // epoch time. - ScoreThresholdLastUpdatedAt *time.Time - - // The algorithm used to train the MLModel. The following algorithm is supported: - // - // - // * SGD -- Stochastic gradient descent. The goal of SGD is to minimize the - // gradient of the loss function. - Algorithm Algorithm - - // The location of the data file or directory in Amazon Simple Storage Service - // (Amazon S3). - InputDataLocationS3 *string - - // The score threshold for the MLModel. - ScoreThreshold *float32 - - // A timestamp represented in epoch time. - FinishedAt *time.Time - - // Long integer type that is a 64-bit signed number. - ComputeTime *int64 - - // The AWS user account from which the MLModel was created. The account type can be - // either an AWS root account or an AWS Identity and Access Management (IAM) user - // account. - CreatedByIamUser *string + // parameter sparingly. + TrainingParameters map[string]*string } // Measurements of how well the MLModel performed on known observations. One of the @@ -425,11 +425,11 @@ type Prediction struct { // The prediction label for either a BINARY or MULTICLASSMLModel. PredictedLabel *string - // The prediction value for REGRESSIONMLModel. - PredictedValue *float32 - // Provides the raw classification score corresponding to each label. PredictedScores map[string]*float32 + + // The prediction value for REGRESSIONMLModel. + PredictedValue *float32 } // The database details of an Amazon RDS database. @@ -468,21 +468,16 @@ type RDSDatabaseCredentials struct { // DataSource. type RDSDataSpec struct { - // The subnet ID to be used to access a VPC-based RDS DB instance. This attribute - // is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon - // S3. + // The AWS Identity and Access Management (IAM) credentials that are used connect + // to the Amazon RDS database. // // This member is required. - SubnetId *string + DatabaseCredentials *RDSDatabaseCredentials - // The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to - // monitor the progress of the copy task from Amazon RDS to Amazon S3. For more - // information, see Role templates - // (https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html) - // for data pipelines. + // Describes the DatabaseName and InstanceIdentifier of an Amazon RDS database. // // This member is required. - ServiceRole *string + DatabaseInformation *RDSDatabase // The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute // Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to @@ -493,6 +488,12 @@ type RDSDataSpec struct { // This member is required. ResourceRole *string + // The Amazon S3 location for staging Amazon RDS data. The data retrieved from + // Amazon RDS using SelectSqlQuery is stored in this location. + // + // This member is required. + S3StagingLocation *string + // The security group IDs to be used to access a VPC-based RDS DB instance. Ensure // that there are appropriate ingress rules set up to allow access to the RDS DB // instance. This attribute is used by Data Pipeline to carry out the copy @@ -501,26 +502,26 @@ type RDSDataSpec struct { // This member is required. SecurityGroupIds []*string - // A JSON string that represents the schema for an Amazon RDS DataSource. The - // DataSchema defines the structure of the observation data in the data file(s) - // referenced in the DataSource. A DataSchema is not required if you specify a - // DataSchemaUri Define your DataSchema as a series of key-value pairs. attributes - // and excludedAttributeNames have an array of key-value pairs for their value. Use - // the following format to define your DataSchema. { "version": "1.0", - // "recordAnnotationFieldName": "F1", "recordWeightFieldName": "F2", - // "targetAttributeName": "F3", "dataFormat": "CSV", "dataFileContainsHeader": - // true, "attributes": [ { "attributeName": "F1", "attributeType": "TEXT" }, { - // "attributeName": "F2", "attributeType": "NUMERIC" }, { "attributeName": "F3", - // "attributeType": "CATEGORICAL" }, { "attributeName": "F4", "attributeType": - // "NUMERIC" }, { "attributeName": "F5", "attributeType": "CATEGORICAL" }, { - // "attributeName": "F6", "attributeType": "TEXT" }, { "attributeName": "F7", - // "attributeType": "WEIGHTED_INT_SEQUENCE" }, { "attributeName": "F8", - // "attributeType": "WEIGHTED_STRING_SEQUENCE" } ], "excludedAttributeNames": [ - // "F6" ] } - DataSchema *string + // The query that is used to retrieve the observation data for the DataSource. + // + // This member is required. + SelectSqlQuery *string - // The Amazon S3 location of the DataSchema. - DataSchemaUri *string + // The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to + // monitor the progress of the copy task from Amazon RDS to Amazon S3. For more + // information, see Role templates + // (https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html) + // for data pipelines. + // + // This member is required. + ServiceRole *string + + // The subnet ID to be used to access a VPC-based RDS DB instance. This attribute + // is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon + // S3. + // + // This member is required. + SubnetId *string // A JSON string that represents the splitting and rearrangement processing to be // applied to a DataSource. If the DataRearrangement parameter is not provided, all @@ -582,32 +583,44 @@ type RDSDataSpec struct { // "complement":"true"}}

    DataRearrangement *string - // The query that is used to retrieve the observation data for the DataSource. - // - // This member is required. - SelectSqlQuery *string - - // The AWS Identity and Access Management (IAM) credentials that are used connect - // to the Amazon RDS database. - // - // This member is required. - DatabaseCredentials *RDSDatabaseCredentials - - // The Amazon S3 location for staging Amazon RDS data. The data retrieved from - // Amazon RDS using SelectSqlQuery is stored in this location. - // - // This member is required. - S3StagingLocation *string + // A JSON string that represents the schema for an Amazon RDS DataSource. The + // DataSchema defines the structure of the observation data in the data file(s) + // referenced in the DataSource. A DataSchema is not required if you specify a + // DataSchemaUri Define your DataSchema as a series of key-value pairs. attributes + // and excludedAttributeNames have an array of key-value pairs for their value. Use + // the following format to define your DataSchema. { "version": "1.0", + // "recordAnnotationFieldName": "F1", "recordWeightFieldName": "F2", + // "targetAttributeName": "F3", "dataFormat": "CSV", "dataFileContainsHeader": + // true, "attributes": [ { "attributeName": "F1", "attributeType": "TEXT" }, { + // "attributeName": "F2", "attributeType": "NUMERIC" }, { "attributeName": "F3", + // "attributeType": "CATEGORICAL" }, { "attributeName": "F4", "attributeType": + // "NUMERIC" }, { "attributeName": "F5", "attributeType": "CATEGORICAL" }, { + // "attributeName": "F6", "attributeType": "TEXT" }, { "attributeName": "F7", + // "attributeType": "WEIGHTED_INT_SEQUENCE" }, { "attributeName": "F8", + // "attributeType": "WEIGHTED_STRING_SEQUENCE" } ], "excludedAttributeNames": [ + // "F6" ] } + DataSchema *string - // Describes the DatabaseName and InstanceIdentifier of an Amazon RDS database. - // - // This member is required. - DatabaseInformation *RDSDatabase + // The Amazon S3 location of the DataSchema. + DataSchemaUri *string } // The datasource details that are specific to Amazon RDS. type RDSMetadata struct { + // The ID of the Data Pipeline instance that is used to carry to copy data from + // Amazon RDS to Amazon S3. You can use the ID to find details about the instance + // in the Data Pipeline console. + DataPipelineId *string + + // The database details required to connect to an Amazon RDS. + Database *RDSDatabase + + // The username to be used by Amazon ML to connect to database on an Amazon RDS + // instance. The username should have sufficient permissions to execute an + // RDSSelectSqlQuery query. + DatabaseUserName *string + // The role (DataPipelineDefaultResourceRole) assumed by an Amazon EC2 instance to // carry out the copy task from Amazon RDS to Amazon S3. For more information, see // Role templates @@ -615,34 +628,25 @@ type RDSMetadata struct { // for data pipelines. ResourceRole *string + // The SQL query that is supplied during CreateDataSourceFromRDS (). Returns only + // if Verbose is true in GetDataSourceInput. + SelectSqlQuery *string + // The role (DataPipelineDefaultRole) assumed by the Data Pipeline service to // monitor the progress of the copy task from Amazon RDS to Amazon S3. For more // information, see Role templates // (https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html) // for data pipelines. ServiceRole *string - - // The username to be used by Amazon ML to connect to database on an Amazon RDS - // instance. The username should have sufficient permissions to execute an - // RDSSelectSqlQuery query. - DatabaseUserName *string - - // The ID of the Data Pipeline instance that is used to carry to copy data from - // Amazon RDS to Amazon S3. You can use the ID to find details about the instance - // in the Data Pipeline console. - DataPipelineId *string - - // The SQL query that is supplied during CreateDataSourceFromRDS (). Returns only - // if Verbose is true in GetDataSourceInput. - SelectSqlQuery *string - - // The database details required to connect to an Amazon RDS. - Database *RDSDatabase } // Describes the real-time endpoint information for an MLModel. type RealtimeEndpointInfo struct { + // The time that the request to create the real-time endpoint for the MLModel was + // received. The time is expressed in epoch time. + CreatedAt *time.Time + // The current status of the real-time endpoint for the MLModel. This element can // have one of the following values: // @@ -663,10 +667,6 @@ type RealtimeEndpointInfo struct { // The maximum processing rate for the real-time endpoint for MLModel, measured in // incoming requests per second. PeakRequestsPerSecond *int32 - - // The time that the request to create the real-time endpoint for the MLModel was - // received. The time is expressed in epoch time. - CreatedAt *time.Time } // Describes the database details required to connect to an Amazon Redshift @@ -688,15 +688,6 @@ type RedshiftDatabase struct { // Redshift cluster. type RedshiftDatabaseCredentials struct { - // A username to be used by Amazon Machine Learning (Amazon ML)to connect to a - // database on an Amazon Redshift cluster. The username should have sufficient - // permissions to execute the RedshiftSelectSqlQuery query. The username should be - // valid for an Amazon Redshift USER - // (https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html). - // - // This member is required. - Username *string - // A password to be used by Amazon ML to connect to a database on an Amazon // Redshift cluster. The password should have sufficient permissions to execute a // RedshiftSelectSqlQuery query. The password should be valid for an Amazon @@ -705,11 +696,44 @@ type RedshiftDatabaseCredentials struct { // // This member is required. Password *string + + // A username to be used by Amazon Machine Learning (Amazon ML)to connect to a + // database on an Amazon Redshift cluster. The username should have sufficient + // permissions to execute the RedshiftSelectSqlQuery query. The username should be + // valid for an Amazon Redshift USER + // (https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html). + // + // This member is required. + Username *string } // Describes the data specification of an Amazon Redshift DataSource. type RedshiftDataSpec struct { + // Describes AWS Identity and Access Management (IAM) credentials that are used + // connect to the Amazon Redshift database. + // + // This member is required. + DatabaseCredentials *RedshiftDatabaseCredentials + + // Describes the DatabaseName and ClusterIdentifier for an Amazon Redshift + // DataSource. + // + // This member is required. + DatabaseInformation *RedshiftDatabase + + // Describes an Amazon S3 location to store the result set of the SelectSqlQuery + // query. + // + // This member is required. + S3StagingLocation *string + + // Describes the SQL Query to execute on an Amazon Redshift database for an Amazon + // Redshift DataSource. + // + // This member is required. + SelectSqlQuery *string + // A JSON string that represents the splitting and rearrangement processing to be // applied to a DataSource. If the DataRearrangement parameter is not provided, all // of the input data is used to create the Datasource.

    There are multiple @@ -770,33 +794,6 @@ type RedshiftDataSpec struct { // "complement":"true"}}

    DataRearrangement *string - // Describes the SQL Query to execute on an Amazon Redshift database for an Amazon - // Redshift DataSource. - // - // This member is required. - SelectSqlQuery *string - - // Describes the schema location for an Amazon Redshift DataSource. - DataSchemaUri *string - - // Describes AWS Identity and Access Management (IAM) credentials that are used - // connect to the Amazon Redshift database. - // - // This member is required. - DatabaseCredentials *RedshiftDatabaseCredentials - - // Describes the DatabaseName and ClusterIdentifier for an Amazon Redshift - // DataSource. - // - // This member is required. - DatabaseInformation *RedshiftDatabase - - // Describes an Amazon S3 location to store the result set of the SelectSqlQuery - // query. - // - // This member is required. - S3StagingLocation *string - // A JSON string that represents the schema for an Amazon Redshift DataSource. The // DataSchema defines the structure of the observation data in the data file(s) // referenced in the DataSource. A DataSchema is not required if you specify a @@ -814,30 +811,40 @@ type RedshiftDataSpec struct { // "attributeType": "WEIGHTED_STRING_SEQUENCE" } ], "excludedAttributeNames": [ // "F6" ] } DataSchema *string + + // Describes the schema location for an Amazon Redshift DataSource. + DataSchemaUri *string } // Describes the DataSource details specific to Amazon Redshift. type RedshiftMetadata struct { - // The SQL query that is specified during CreateDataSourceFromRedshift (). Returns - // only if Verbose is true in GetDataSourceInput. - SelectSqlQuery *string - - // Describes the database details required to connect to an Amazon Redshift - // database. - RedshiftDatabase *RedshiftDatabase - // A username to be used by Amazon Machine Learning (Amazon ML)to connect to a // database on an Amazon Redshift cluster. The username should have sufficient // permissions to execute the RedshiftSelectSqlQuery query. The username should be // valid for an Amazon Redshift USER // (https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html). DatabaseUserName *string + + // Describes the database details required to connect to an Amazon Redshift + // database. + RedshiftDatabase *RedshiftDatabase + + // The SQL query that is specified during CreateDataSourceFromRedshift (). Returns + // only if Verbose is true in GetDataSourceInput. + SelectSqlQuery *string } // Describes the data specification of a DataSource. type S3DataSpec struct { + // The location of the data file(s) used by a DataSource. The URI specifies a data + // file or an Amazon Simple Storage Service (Amazon S3) directory or bucket + // containing data files. + // + // This member is required. + DataLocationS3 *string + // A JSON string that represents the splitting and rearrangement processing to be // applied to a DataSource. If the DataRearrangement parameter is not provided, all // of the input data is used to create the Datasource.

    There are multiple @@ -898,10 +905,6 @@ type S3DataSpec struct { // "complement":"true"}}

    DataRearrangement *string - // Describes the schema location in Amazon S3. You must provide either the - // DataSchema or the DataSchemaLocationS3. - DataSchemaLocationS3 *string - // A JSON string that represents the schema for an Amazon S3 DataSource. The // DataSchema defines the structure of the observation data in the data file(s) // referenced in the DataSource. You must provide either the DataSchema or the @@ -920,12 +923,9 @@ type S3DataSpec struct { // "F6" ] } DataSchema *string - // The location of the data file(s) used by a DataSource. The URI specifies a data - // file or an Amazon Simple Storage Service (Amazon S3) directory or bucket - // containing data files. - // - // This member is required. - DataLocationS3 *string + // Describes the schema location in Amazon S3. You must provide either the + // DataSchema or the DataSchemaLocationS3. + DataSchemaLocationS3 *string } // A custom key-value pair associated with an ML object, such as an ML model. diff --git a/service/macie/api_op_DisassociateS3Resources.go b/service/macie/api_op_DisassociateS3Resources.go index a3b3196c459..3f8b1aef4fc 100644 --- a/service/macie/api_op_DisassociateS3Resources.go +++ b/service/macie/api_op_DisassociateS3Resources.go @@ -61,15 +61,15 @@ func (c *Client) DisassociateS3Resources(ctx context.Context, params *Disassocia type DisassociateS3ResourcesInput struct { - // The ID of the Amazon Macie Classic member account whose resources you want to - // remove from being monitored by Amazon Macie Classic. - MemberAccountId *string - // The S3 resources (buckets or prefixes) that you want to remove from being // monitored and classified by Amazon Macie Classic. // // This member is required. AssociatedS3Resources []*types.S3Resource + + // The ID of the Amazon Macie Classic member account whose resources you want to + // remove from being monitored by Amazon Macie Classic. + MemberAccountId *string } type DisassociateS3ResourcesOutput struct { diff --git a/service/macie/api_op_ListS3Resources.go b/service/macie/api_op_ListS3Resources.go index 8dce01214c9..d741ec3cd66 100644 --- a/service/macie/api_op_ListS3Resources.go +++ b/service/macie/api_op_ListS3Resources.go @@ -60,6 +60,10 @@ func (c *Client) ListS3Resources(ctx context.Context, params *ListS3ResourcesInp type ListS3ResourcesInput struct { + // Use this parameter to indicate the maximum number of items that you want in the + // response. The default value is 250. + MaxResults *int32 + // The Amazon Macie Classic member account ID whose associated S3 resources you // want to list. MemberAccountId *string @@ -69,10 +73,6 @@ type ListS3ResourcesInput struct { // nextToken in the request with the value of nextToken from the previous response // to continue listing data. NextToken *string - - // Use this parameter to indicate the maximum number of items that you want in the - // response. The default value is 250. - MaxResults *int32 } type ListS3ResourcesOutput struct { diff --git a/service/macie/go.mod b/service/macie/go.mod index 24c194339b8..9659ca6883d 100644 --- a/service/macie/go.mod +++ b/service/macie/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/macie go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/macie/types/types.go b/service/macie/types/types.go index a1af9f863bd..fa47fd38785 100644 --- a/service/macie/types/types.go +++ b/service/macie/types/types.go @@ -6,18 +6,18 @@ package types // resources. type ClassificationType struct { - // A one-time classification of all of the existing objects in a specified S3 - // bucket. - // - // This member is required. - OneTime S3OneTimeClassificationType - // A continuous classification of the objects that are added to a specified S3 // bucket. Amazon Macie Classic begins performing continuous classification after a // bucket is successfully associated with Amazon Macie Classic. // // This member is required. Continuous S3ContinuousClassificationType + + // A one-time classification of all of the existing objects in a specified S3 + // bucket. + // + // This member is required. + OneTime S3OneTimeClassificationType } // The classification type that Amazon Macie Classic applies to the associated S3 @@ -41,11 +41,11 @@ type FailedS3Resource struct { // The status code of a failed item. ErrorCode *string - // The failed S3 resources. - FailedItem *S3Resource - // The error message of a failed item. ErrorMessage *string + + // The failed S3 resources. + FailedItem *S3Resource } // Contains information about the Amazon Macie Classic member account. @@ -60,13 +60,13 @@ type MemberAccount struct { // parameter in the AssociateS3Resources and UpdateS3Resources actions. type S3Resource struct { - // The prefix of the S3 bucket. - Prefix *string - // The name of the S3 bucket. // // This member is required. BucketName *string + + // The prefix of the S3 bucket. + Prefix *string } // The S3 resources that you want to associate with Amazon Macie Classic for @@ -75,9 +75,10 @@ type S3Resource struct { // ListS3Resources action. type S3ResourceClassification struct { - // The prefix of the S3 bucket that you want to associate with Amazon Macie - // Classic. - Prefix *string + // The name of the S3 bucket that you want to associate with Amazon Macie Classic. + // + // This member is required. + BucketName *string // The classification type that you want to specify for the resource associated // with Amazon Macie Classic. @@ -85,26 +86,25 @@ type S3ResourceClassification struct { // This member is required. ClassificationType *ClassificationType - // The name of the S3 bucket that you want to associate with Amazon Macie Classic. - // - // This member is required. - BucketName *string + // The prefix of the S3 bucket that you want to associate with Amazon Macie + // Classic. + Prefix *string } // The S3 resources whose classification types you want to update. This data type // is used as a request parameter in the UpdateS3Resources action. type S3ResourceClassificationUpdate struct { - // The classification type that you want to update for the resource associated with - // Amazon Macie Classic. + // The name of the S3 bucket whose classification types you want to update. // // This member is required. - ClassificationTypeUpdate *ClassificationTypeUpdate + BucketName *string - // The name of the S3 bucket whose classification types you want to update. + // The classification type that you want to update for the resource associated with + // Amazon Macie Classic. // // This member is required. - BucketName *string + ClassificationTypeUpdate *ClassificationTypeUpdate // The prefix of the S3 bucket whose classification types you want to update. Prefix *string diff --git a/service/macie2/api_op_CreateClassificationJob.go b/service/macie2/api_op_CreateClassificationJob.go index 179011cde15..0ac0cb9e31f 100644 --- a/service/macie2/api_op_CreateClassificationJob.go +++ b/service/macie2/api_op_CreateClassificationJob.go @@ -59,29 +59,11 @@ func (c *Client) CreateClassificationJob(ctx context.Context, params *CreateClas type CreateClassificationJobInput struct { - // A map of key-value pairs that specifies the tags to associate with the job. A - // job can have a maximum of 50 tags. Each tag consists of a required tag key and - // an associated tag value. The maximum length of a tag key is 128 characters. The - // maximum length of a tag value is 256 characters. - Tags map[string]*string - - // The S3 buckets that contain the objects to analyze, and the scope of that - // analysis. - // - // This member is required. - S3JobDefinition *types.S3JobDefinition - - // A custom description of the job. The description can contain as many as 200 - // characters. - Description *string - - // A custom name for the job. The name can contain as many as 500 characters. + // A unique, case-sensitive token that you provide to ensure the idempotency of the + // request. // // This member is required. - Name *string - - // Specifies whether to run the job immediately, after it's created. - InitialRun *bool + ClientToken *string // The schedule for running the job. Valid values are: // @@ -96,25 +78,43 @@ type CreateClassificationJobInput struct { // This member is required. JobType types.JobType - // A unique, case-sensitive token that you provide to ensure the idempotency of the - // request. + // A custom name for the job. The name can contain as many as 500 characters. // // This member is required. - ClientToken *string + Name *string - // The recurrence pattern for running the job. To run the job only once, don't - // specify a value for this property and set the value of the jobType property to - // ONE_TIME. - ScheduleFrequency *types.JobScheduleFrequency + // The S3 buckets that contain the objects to analyze, and the scope of that + // analysis. + // + // This member is required. + S3JobDefinition *types.S3JobDefinition // The custom data identifiers to use for data analysis and classification. CustomDataIdentifierIds []*string + // A custom description of the job. The description can contain as many as 200 + // characters. + Description *string + + // Specifies whether to run the job immediately, after it's created. + InitialRun *bool + // The sampling depth, as a percentage, to apply when processing objects. This // value determines the percentage of eligible objects that the job analyzes. If // the value is less than 100, Amazon Macie randomly selects the objects to // analyze, up to the specified percentage. SamplingPercentage *int32 + + // The recurrence pattern for running the job. To run the job only once, don't + // specify a value for this property and set the value of the jobType property to + // ONE_TIME. + ScheduleFrequency *types.JobScheduleFrequency + + // A map of key-value pairs that specifies the tags to associate with the job. A + // job can have a maximum of 50 tags. Each tag consists of a required tag key and + // an associated tag value. The maximum length of a tag key is 128 characters. The + // maximum length of a tag value is 256 characters. + Tags map[string]*string } type CreateClassificationJobOutput struct { diff --git a/service/macie2/api_op_CreateCustomDataIdentifier.go b/service/macie2/api_op_CreateCustomDataIdentifier.go index d73d8abcbde..2fb3d8fe0b2 100644 --- a/service/macie2/api_op_CreateCustomDataIdentifier.go +++ b/service/macie2/api_op_CreateCustomDataIdentifier.go @@ -58,12 +58,9 @@ func (c *Client) CreateCustomDataIdentifier(ctx context.Context, params *CreateC type CreateCustomDataIdentifierInput struct { - // A custom name for the custom data identifier. The name can contain as many as - // 128 characters. We strongly recommend that you avoid including any sensitive - // data in the name of a custom data identifier. Other users of your account might - // be able to see the identifier's name, depending on the actions that they're - // allowed to perform in Amazon Macie. - Name *string + // A unique, case-sensitive token that you provide to ensure the idempotency of the + // request. + ClientToken *string // A custom description of the custom data identifier. The description can contain // as many as 512 characters. We strongly recommend that you avoid including any @@ -72,20 +69,17 @@ type CreateCustomDataIdentifierInput struct { // actions that they're allowed to perform in Amazon Macie. Description *string - // A map of key-value pairs that specifies the tags to associate with the custom - // data identifier. A custom data identifier can have a maximum of 50 tags. Each - // tag consists of a required tag key and an associated tag value. The maximum - // length of a tag key is 128 characters. The maximum length of a tag value is 256 - // characters. - Tags map[string]*string - - // A unique, case-sensitive token that you provide to ensure the idempotency of the - // request. - ClientToken *string + // An array that lists specific character sequences (ignore words) to exclude from + // the results. If the text matched by the regular expression is the same as any + // string in this array, Amazon Macie ignores it. The array can contain as many as + // 10 ignore words. Each ignore word can contain 4 - 90 characters. + IgnoreWords []*string - // The regular expression (regex) that defines the pattern to match. The expression - // can contain as many as 512 characters. - Regex *string + // An array that lists specific character sequences (keywords), one of which must + // be within proximity (maximumMatchDistance) of the regular expression to match. + // The array can contain as many as 50 keywords. Each keyword can contain 4 - 90 + // characters. + Keywords []*string // The maximum number of characters that can exist between text that matches the // regex pattern and the character sequences specified by the keywords array. Macie @@ -94,17 +88,23 @@ type CreateCustomDataIdentifierInput struct { // value is 50. MaximumMatchDistance *int32 - // An array that lists specific character sequences (keywords), one of which must - // be within proximity (maximumMatchDistance) of the regular expression to match. - // The array can contain as many as 50 keywords. Each keyword can contain 4 - 90 - // characters. - Keywords []*string + // A custom name for the custom data identifier. The name can contain as many as + // 128 characters. We strongly recommend that you avoid including any sensitive + // data in the name of a custom data identifier. Other users of your account might + // be able to see the identifier's name, depending on the actions that they're + // allowed to perform in Amazon Macie. + Name *string - // An array that lists specific character sequences (ignore words) to exclude from - // the results. If the text matched by the regular expression is the same as any - // string in this array, Amazon Macie ignores it. The array can contain as many as - // 10 ignore words. Each ignore word can contain 4 - 90 characters. - IgnoreWords []*string + // The regular expression (regex) that defines the pattern to match. The expression + // can contain as many as 512 characters. + Regex *string + + // A map of key-value pairs that specifies the tags to associate with the custom + // data identifier. A custom data identifier can have a maximum of 50 tags. Each + // tag consists of a required tag key and an associated tag value. The maximum + // length of a tag key is 128 characters. The maximum length of a tag value is 256 + // characters. + Tags map[string]*string } type CreateCustomDataIdentifierOutput struct { diff --git a/service/macie2/api_op_CreateFindingsFilter.go b/service/macie2/api_op_CreateFindingsFilter.go index 9d8b0bd9a28..c9633504f8a 100644 --- a/service/macie2/api_op_CreateFindingsFilter.go +++ b/service/macie2/api_op_CreateFindingsFilter.go @@ -59,28 +59,6 @@ func (c *Client) CreateFindingsFilter(ctx context.Context, params *CreateFinding type CreateFindingsFilterInput struct { - // A map of key-value pairs that specifies the tags to associate with the filter. A - // findings filter can have a maximum of 50 tags. Each tag consists of a required - // tag key and an associated tag value. The maximum length of a tag key is 128 - // characters. The maximum length of a tag value is 256 characters. - Tags map[string]*string - - // A custom description of the filter. The description can contain as many as 512 - // characters. We strongly recommend that you avoid including any sensitive data in - // the description of a filter. Other users of your account might be able to see - // the filter's description, depending on the actions that they're allowed to - // perform in Amazon Macie. - Description *string - - // The criteria to use to filter findings. - // - // This member is required. - FindingCriteria *types.FindingCriteria - - // A unique, case-sensitive token that you provide to ensure the idempotency of the - // request. - ClientToken *string - // The action to perform on findings that meet the filter criteria // (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) // the findings; and, NOOP, don't perform any action on the findings. @@ -88,6 +66,11 @@ type CreateFindingsFilterInput struct { // This member is required. Action types.FindingsFilterAction + // The criteria to use to filter findings. + // + // This member is required. + FindingCriteria *types.FindingCriteria + // A custom name for the filter. The name must contain at least 3 characters and // can contain as many as 64 characters. We strongly recommend that you avoid // including any sensitive data in the name of a filter. Other users of your @@ -97,20 +80,37 @@ type CreateFindingsFilterInput struct { // This member is required. Name *string + // A unique, case-sensitive token that you provide to ensure the idempotency of the + // request. + ClientToken *string + + // A custom description of the filter. The description can contain as many as 512 + // characters. We strongly recommend that you avoid including any sensitive data in + // the description of a filter. Other users of your account might be able to see + // the filter's description, depending on the actions that they're allowed to + // perform in Amazon Macie. + Description *string + // The position of the filter in the list of saved filters on the Amazon Macie // console. This value also determines the order in which the filter is applied to // findings, relative to other filters that are also applied to the findings. Position *int32 + + // A map of key-value pairs that specifies the tags to associate with the filter. A + // findings filter can have a maximum of 50 tags. Each tag consists of a required + // tag key and an associated tag value. The maximum length of a tag key is 128 + // characters. The maximum length of a tag value is 256 characters. + Tags map[string]*string } type CreateFindingsFilterOutput struct { - // The unique identifier for the filter that was created. - Id *string - // The Amazon Resource Name (ARN) of the filter that was created. Arn *string + // The unique identifier for the filter that was created. + Id *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/macie2/api_op_CreateInvitations.go b/service/macie2/api_op_CreateInvitations.go index ddfc811bbc9..f7629a60c97 100644 --- a/service/macie2/api_op_CreateInvitations.go +++ b/service/macie2/api_op_CreateInvitations.go @@ -57,9 +57,11 @@ func (c *Client) CreateInvitations(ctx context.Context, params *CreateInvitation type CreateInvitationsInput struct { - // A custom message to include in the invitation. Amazon Macie adds this message to - // the standard content that it sends for an invitation. - Message *string + // An array that lists AWS account IDs, one for each account to send the invitation + // to. + // + // This member is required. + AccountIds []*string // Specifies whether to send an email notification to the root user of each account // that the invitation will be sent to. This notification is in addition to an @@ -67,11 +69,9 @@ type CreateInvitationsInput struct { // email notification to the root user of each account, set this value to true. DisableEmailNotification *bool - // An array that lists AWS account IDs, one for each account to send the invitation - // to. - // - // This member is required. - AccountIds []*string + // A custom message to include in the invitation. Amazon Macie adds this message to + // the standard content that it sends for an invitation. + Message *string } type CreateInvitationsOutput struct { diff --git a/service/macie2/api_op_CreateMember.go b/service/macie2/api_op_CreateMember.go index ebaffc576e1..263689ee385 100644 --- a/service/macie2/api_op_CreateMember.go +++ b/service/macie2/api_op_CreateMember.go @@ -57,16 +57,16 @@ func (c *Client) CreateMember(ctx context.Context, params *CreateMemberInput, op type CreateMemberInput struct { + // The details for the account to associate with the master account. + // + // This member is required. + Account *types.AccountDetail + // A map of key-value pairs that specifies the tags to associate with the account // in Amazon Macie. An account can have a maximum of 50 tags. Each tag consists of // a required tag key and an associated tag value. The maximum length of a tag key // is 128 characters. The maximum length of a tag value is 256 characters. Tags map[string]*string - - // The details for the account to associate with the master account. - // - // This member is required. - Account *types.AccountDetail } type CreateMemberOutput struct { diff --git a/service/macie2/api_op_DescribeBuckets.go b/service/macie2/api_op_DescribeBuckets.go index e6ba9100ac1..6513824db05 100644 --- a/service/macie2/api_op_DescribeBuckets.go +++ b/service/macie2/api_op_DescribeBuckets.go @@ -57,8 +57,8 @@ func (c *Client) DescribeBuckets(ctx context.Context, params *DescribeBucketsInp type DescribeBucketsInput struct { - // The criteria to use to sort the query results. - SortCriteria *types.BucketSortCriteria + // The criteria to use to filter the query results. + Criteria map[string]*types.BucketCriteriaAdditionalProperties // The maximum number of items to include in each page of the response. The default // value is 50. @@ -68,8 +68,8 @@ type DescribeBucketsInput struct { // paginated response. NextToken *string - // The criteria to use to filter the query results. - Criteria map[string]*types.BucketCriteriaAdditionalProperties + // The criteria to use to sort the query results. + SortCriteria *types.BucketSortCriteria } type DescribeBucketsOutput struct { diff --git a/service/macie2/api_op_DescribeClassificationJob.go b/service/macie2/api_op_DescribeClassificationJob.go index b5b330e798e..6f578e7277d 100644 --- a/service/macie2/api_op_DescribeClassificationJob.go +++ b/service/macie2/api_op_DescribeClassificationJob.go @@ -66,43 +66,29 @@ type DescribeClassificationJobInput struct { type DescribeClassificationJobOutput struct { - // The schedule for running the job. Possible values are: - // - // * ONE_TIME - The job - // ran or will run only once. - // - // * SCHEDULED - The job runs on a daily, weekly, - // or monthly basis. The scheduleFrequency property indicates the recurrence - // pattern for the job. - JobType types.JobType - // The token that was provided to ensure the idempotency of the request to create // the job. ClientToken *string + // The date and time, in UTC and extended ISO 8601 format, when the job was + // created. + CreatedAt *time.Time + // The custom data identifiers that the job uses to analyze data. CustomDataIdentifierIds []*string - // The date and time, in UTC and extended ISO 8601 format, when the job last ran. - LastRunTime *time.Time - - // The Amazon Resource Name (ARN) of the job. - JobArn *string - // The custom description of the job. Description *string - // A map of key-value pairs that identifies the tags (keys and values) that are - // associated with the classification job. - Tags map[string]*string - - // The sampling depth, as a percentage, that the job applies when it processes - // objects. - SamplingPercentage *int32 - // Specifies whether the job has run for the first time. InitialRun *bool + // The Amazon Resource Name (ARN) of the job. + JobArn *string + + // The unique identifier for the job. + JobId *string + // The current status of the job. Possible values are: // // * CANCELLED - The job @@ -125,28 +111,42 @@ type DescribeClassificationJobOutput struct { // job is in progress. JobStatus types.JobStatus + // The schedule for running the job. Possible values are: + // + // * ONE_TIME - The job + // ran or will run only once. + // + // * SCHEDULED - The job runs on a daily, weekly, + // or monthly basis. The scheduleFrequency property indicates the recurrence + // pattern for the job. + JobType types.JobType + + // The date and time, in UTC and extended ISO 8601 format, when the job last ran. + LastRunTime *time.Time + + // The custom name of the job. + Name *string + // The S3 buckets that the job is configured to analyze, and the scope of that // analysis. S3JobDefinition *types.S3JobDefinition - // The date and time, in UTC and extended ISO 8601 format, when the job was - // created. - CreatedAt *time.Time + // The sampling depth, as a percentage, that the job applies when it processes + // objects. + SamplingPercentage *int32 // The recurrence pattern for running the job. If the job is configured to run only // once, this value is null. ScheduleFrequency *types.JobScheduleFrequency - // The unique identifier for the job. - JobId *string - - // The custom name of the job. - Name *string - // The number of times that the job has run and processing statistics for the job's // most recent run. Statistics *types.Statistics + // A map of key-value pairs that identifies the tags (keys and values) that are + // associated with the classification job. + Tags map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/macie2/api_op_EnableOrganizationAdminAccount.go b/service/macie2/api_op_EnableOrganizationAdminAccount.go index 0b87dc3c2d2..233ccccac9c 100644 --- a/service/macie2/api_op_EnableOrganizationAdminAccount.go +++ b/service/macie2/api_op_EnableOrganizationAdminAccount.go @@ -59,14 +59,14 @@ func (c *Client) EnableOrganizationAdminAccount(ctx context.Context, params *Ena type EnableOrganizationAdminAccountInput struct { - // A unique, case-sensitive token that you provide to ensure the idempotency of the - // request. - ClientToken *string - // The AWS account ID for the account. // // This member is required. AdminAccountId *string + + // A unique, case-sensitive token that you provide to ensure the idempotency of the + // request. + ClientToken *string } type EnableOrganizationAdminAccountOutput struct { diff --git a/service/macie2/api_op_GetBucketStatistics.go b/service/macie2/api_op_GetBucketStatistics.go index 946af212b89..f3e611201ab 100644 --- a/service/macie2/api_op_GetBucketStatistics.go +++ b/service/macie2/api_op_GetBucketStatistics.go @@ -64,38 +64,38 @@ type GetBucketStatisticsInput struct { type GetBucketStatisticsOutput struct { + // The total number of buckets. + BucketCount *int64 + + // The total number of buckets that are publicly accessible based on a combination + // of permissions settings for each bucket. + BucketCountByEffectivePermission *types.BucketCountByEffectivePermission + // The total number of buckets, grouped by server-side encryption type. This object // also reports the total number of buckets that aren't encrypted. BucketCountByEncryptionType *types.BucketCountByEncryptionType - // The total storage size, in bytes, of all the buckets. - SizeInBytes *int64 - - // The date and time, in UTC and extended ISO 8601 format, when Amazon Macie last - // analyzed the buckets. - LastUpdated *time.Time + // The total number of buckets that are shared with another AWS account. + BucketCountBySharedAccessType *types.BucketCountBySharedAccessType // The total number of objects that Amazon Macie can analyze in all the buckets. // These objects use a file format, file extension, or content type that Amazon // Macie supports. ClassifiableObjectCount *int64 - // The total number of buckets that are publicly accessible based on a combination - // of permissions settings for each bucket. - BucketCountByEffectivePermission *types.BucketCountByEffectivePermission + // The date and time, in UTC and extended ISO 8601 format, when Amazon Macie last + // analyzed the buckets. + LastUpdated *time.Time // The total number of objects in all the buckets. ObjectCount *int64 + // The total storage size, in bytes, of all the buckets. + SizeInBytes *int64 + // The total compressed storage size, in bytes, of all the buckets. SizeInBytesCompressed *int64 - // The total number of buckets that are shared with another AWS account. - BucketCountBySharedAccessType *types.BucketCountBySharedAccessType - - // The total number of buckets. - BucketCount *int64 - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/macie2/api_op_GetCustomDataIdentifier.go b/service/macie2/api_op_GetCustomDataIdentifier.go index 1482a3243d0..9ef3d043a71 100644 --- a/service/macie2/api_op_GetCustomDataIdentifier.go +++ b/service/macie2/api_op_GetCustomDataIdentifier.go @@ -67,25 +67,33 @@ type GetCustomDataIdentifierInput struct { type GetCustomDataIdentifierOutput struct { + // The Amazon Resource Name (ARN) of the custom data identifier. + Arn *string + // The date and time, in UTC and extended ISO 8601 format, when the custom data // identifier was created. CreatedAt *time.Time - // The regular expression (regex) that defines the pattern to match. - Regex *string - - // A map of key-value pairs that identifies the tags (keys and values) that are - // associated with the custom data identifier. - Tags map[string]*string - - // The custom description of the custom data identifier. - Description *string - // Specifies whether the custom data identifier was deleted. If you delete a custom // data identifier, Amazon Macie doesn't delete it permanently. Instead, it soft // deletes the identifier. Deleted *bool + // The custom description of the custom data identifier. + Description *string + + // The unique identifier for the custom data identifier. + Id *string + + // An array that lists specific character sequences (ignore words) to exclude from + // the results. If the text matched by the regular expression is the same as any + // string in this array, Amazon Macie ignores it. + IgnoreWords []*string + + // An array that lists specific character sequences (keywords), one of which must + // be within proximity (maximumMatchDistance) of the regular expression to match. + Keywords []*string + // The maximum number of characters that can exist between text that matches the // regex pattern and the character sequences specified by the keywords array. Macie // includes or excludes a result based on the proximity of a keyword to text that @@ -95,20 +103,12 @@ type GetCustomDataIdentifierOutput struct { // The custom name of the custom data identifier. Name *string - // An array that lists specific character sequences (keywords), one of which must - // be within proximity (maximumMatchDistance) of the regular expression to match. - Keywords []*string - - // The Amazon Resource Name (ARN) of the custom data identifier. - Arn *string - - // An array that lists specific character sequences (ignore words) to exclude from - // the results. If the text matched by the regular expression is the same as any - // string in this array, Amazon Macie ignores it. - IgnoreWords []*string + // The regular expression (regex) that defines the pattern to match. + Regex *string - // The unique identifier for the custom data identifier. - Id *string + // A map of key-value pairs that identifies the tags (keys and values) that are + // associated with the custom data identifier. + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/macie2/api_op_GetFindingStatistics.go b/service/macie2/api_op_GetFindingStatistics.go index d8f8124c723..a6e81f9ac25 100644 --- a/service/macie2/api_op_GetFindingStatistics.go +++ b/service/macie2/api_op_GetFindingStatistics.go @@ -57,12 +57,6 @@ func (c *Client) GetFindingStatistics(ctx context.Context, params *GetFindingSta type GetFindingStatisticsInput struct { - // The maximum number of items to include in each page of the response. - Size *int32 - - // The criteria to use to sort the query results. - SortCriteria *types.FindingStatisticsSortCriteria - // The finding property to use to group the query results. Valid values are: // // * @@ -84,6 +78,12 @@ type GetFindingStatisticsInput struct { // The criteria to use to filter the query results. FindingCriteria *types.FindingCriteria + + // The maximum number of items to include in each page of the response. + Size *int32 + + // The criteria to use to sort the query results. + SortCriteria *types.FindingStatisticsSortCriteria } type GetFindingStatisticsOutput struct { diff --git a/service/macie2/api_op_GetFindings.go b/service/macie2/api_op_GetFindings.go index c9c48e5de7c..a7a5f1cc7fc 100644 --- a/service/macie2/api_op_GetFindings.go +++ b/service/macie2/api_op_GetFindings.go @@ -57,14 +57,14 @@ func (c *Client) GetFindings(ctx context.Context, params *GetFindingsInput, optF type GetFindingsInput struct { - // The criteria for sorting the results of the request. - SortCriteria *types.SortCriteria - // An array of strings that lists the unique identifiers for the findings to // retrieve information about. // // This member is required. FindingIds []*string + + // The criteria for sorting the results of the request. + SortCriteria *types.SortCriteria } type GetFindingsOutput struct { diff --git a/service/macie2/api_op_GetFindingsFilter.go b/service/macie2/api_op_GetFindingsFilter.go index b1d22f63225..cc395751d1b 100644 --- a/service/macie2/api_op_GetFindingsFilter.go +++ b/service/macie2/api_op_GetFindingsFilter.go @@ -67,31 +67,31 @@ type GetFindingsFilterInput struct { type GetFindingsFilterOutput struct { - // The Amazon Resource Name (ARN) of the filter. - Arn *string - - // The unique identifier for the filter. - Id *string - // The action that's performed on findings that meet the filter criteria // (findingCriteria). Possible values are: ARCHIVE, suppress (automatically // archive) the findings; and, NOOP, don't perform any action on the findings. Action types.FindingsFilterAction + // The Amazon Resource Name (ARN) of the filter. + Arn *string + // The custom description of the filter. Description *string - // The position of the filter in the list of saved filters on the Amazon Macie - // console. This value also determines the order in which the filter is applied to - // findings, relative to other filters that are also applied to the findings. - Position *int32 - // The criteria that's used to filter findings. FindingCriteria *types.FindingCriteria + // The unique identifier for the filter. + Id *string + // The custom name of the filter. Name *string + // The position of the filter in the list of saved filters on the Amazon Macie + // console. This value also determines the order in which the filter is applied to + // findings, relative to other filters that are also applied to the findings. + Position *int32 + // A map of key-value pairs that identifies the tags (keys and values) that are // associated with the filter. Tags map[string]*string diff --git a/service/macie2/api_op_GetMacieSession.go b/service/macie2/api_op_GetMacieSession.go index 8892261c2a3..7c8aca82153 100644 --- a/service/macie2/api_op_GetMacieSession.go +++ b/service/macie2/api_op_GetMacieSession.go @@ -61,29 +61,29 @@ type GetMacieSessionInput struct { type GetMacieSessionOutput struct { - // The current status of the Amazon Macie account. Possible values are: PAUSED, the - // account is enabled but all Amazon Macie activities are suspended (paused) for - // the account; and, ENABLED, the account is enabled and all Amazon Macie - // activities are enabled for the account. - Status types.MacieStatus + // The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie + // account was created. + CreatedAt *time.Time // The frequency with which Amazon Macie publishes updates to policy findings for // the account. This includes publishing updates to AWS Security Hub and Amazon // EventBridge (formerly called Amazon CloudWatch Events). FindingPublishingFrequency types.FindingPublishingFrequency - // The date and time, in UTC and extended ISO 8601 format, of the most recent - // change to the status of the Amazon Macie account. - UpdatedAt *time.Time - - // The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie - // account was created. - CreatedAt *time.Time - // The Amazon Resource Name (ARN) of the service-linked role that allows Amazon // Macie to monitor and analyze data in AWS resources for the account. ServiceRole *string + // The current status of the Amazon Macie account. Possible values are: PAUSED, the + // account is enabled but all Amazon Macie activities are suspended (paused) for + // the account; and, ENABLED, the account is enabled and all Amazon Macie + // activities are enabled for the account. + Status types.MacieStatus + + // The date and time, in UTC and extended ISO 8601 format, of the most recent + // change to the status of the Amazon Macie account. + UpdatedAt *time.Time + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/macie2/api_op_GetMember.go b/service/macie2/api_op_GetMember.go index da06a9980fc..ec4b22eba96 100644 --- a/service/macie2/api_op_GetMember.go +++ b/service/macie2/api_op_GetMember.go @@ -74,18 +74,16 @@ type GetMemberOutput struct { // The Amazon Resource Name (ARN) of the account. Arn *string + // The email address for the account. + Email *string + // The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie // membership invitation was last sent to the account. This value is null if a // Macie invitation hasn't been sent to the account. InvitedAt *time.Time - // The date and time, in UTC and extended ISO 8601 format, of the most recent - // change to the status of the relationship between the account and the master - // account. - UpdatedAt *time.Time - - // The email address for the account. - Email *string + // The AWS account ID for the master account. + MasterAccountId *string // The current status of the relationship between the account and the master // account. @@ -95,8 +93,10 @@ type GetMemberOutput struct { // associated with the member account in Amazon Macie. Tags map[string]*string - // The AWS account ID for the master account. - MasterAccountId *string + // The date and time, in UTC and extended ISO 8601 format, of the most recent + // change to the status of the relationship between the account and the master + // account. + UpdatedAt *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/macie2/api_op_GetUsageStatistics.go b/service/macie2/api_op_GetUsageStatistics.go index 38cb29b9df5..9260aa24f8c 100644 --- a/service/macie2/api_op_GetUsageStatistics.go +++ b/service/macie2/api_op_GetUsageStatistics.go @@ -61,27 +61,27 @@ type GetUsageStatisticsInput struct { // join the conditions specified by the objects. FilterBy []*types.UsageStatisticsFilter + // The maximum number of items to include in each page of the response. + MaxResults *int32 + // The nextToken string that specifies which page of results to return in a // paginated response. NextToken *string - // The maximum number of items to include in each page of the response. - MaxResults *int32 - // The criteria to use to sort the query results. SortBy *types.UsageStatisticsSortBy } type GetUsageStatisticsOutput struct { - // An array of objects that contains the results of the query. Each object contains - // the data for an account that meets the filter criteria specified in the request. - Records []*types.UsageRecord - // The string to use in a subsequent request to get the next page of results in a // paginated response. This value is null if there are no additional pages. NextToken *string + // An array of objects that contains the results of the query. Each object contains + // the data for an account that meets the filter criteria specified in the request. + Records []*types.UsageRecord + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/macie2/api_op_ListClassificationJobs.go b/service/macie2/api_op_ListClassificationJobs.go index 390ff7ebd38..1d16fef4c53 100644 --- a/service/macie2/api_op_ListClassificationJobs.go +++ b/service/macie2/api_op_ListClassificationJobs.go @@ -62,24 +62,24 @@ type ListClassificationJobsInput struct { // The maximum number of items to include in each page of the response. MaxResults *int32 - // The criteria to use to sort the results. - SortCriteria *types.ListJobsSortCriteria - // The nextToken string that specifies which page of results to return in a // paginated response. NextToken *string + + // The criteria to use to sort the results. + SortCriteria *types.ListJobsSortCriteria } type ListClassificationJobsOutput struct { - // The string to use in a subsequent request to get the next page of results in a - // paginated response. This value is null if there are no additional pages. - NextToken *string - // An array of objects, one for each job that meets the filter criteria specified // in the request. Items []*types.JobSummary + // The string to use in a subsequent request to get the next page of results in a + // paginated response. This value is null if there are no additional pages. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/macie2/api_op_ListFindings.go b/service/macie2/api_op_ListFindings.go index 4b319c098a3..d5a96b442da 100644 --- a/service/macie2/api_op_ListFindings.go +++ b/service/macie2/api_op_ListFindings.go @@ -56,18 +56,18 @@ func (c *Client) ListFindings(ctx context.Context, params *ListFindingsInput, op type ListFindingsInput struct { + // The criteria to use to filter the results. + FindingCriteria *types.FindingCriteria + // The maximum number of items to include in each page of the response. MaxResults *int32 - // The criteria to use to sort the results. - SortCriteria *types.SortCriteria - // The nextToken string that specifies which page of results to return in a // paginated response. NextToken *string - // The criteria to use to filter the results. - FindingCriteria *types.FindingCriteria + // The criteria to use to sort the results. + SortCriteria *types.SortCriteria } type ListFindingsOutput struct { diff --git a/service/macie2/api_op_ListFindingsFilters.go b/service/macie2/api_op_ListFindingsFilters.go index fabc1c7e46b..b49d5337d65 100644 --- a/service/macie2/api_op_ListFindingsFilters.go +++ b/service/macie2/api_op_ListFindingsFilters.go @@ -66,13 +66,13 @@ type ListFindingsFiltersInput struct { type ListFindingsFiltersOutput struct { + // An array of objects, one for each filter that's associated with the account. + FindingsFilterListItems []*types.FindingsFilterListItem + // The string to use in a subsequent request to get the next page of results in a // paginated response. This value is null if there are no additional pages. NextToken *string - // An array of objects, one for each filter that's associated with the account. - FindingsFilterListItems []*types.FindingsFilterListItem - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/macie2/api_op_ListInvitations.go b/service/macie2/api_op_ListInvitations.go index 939232259c3..2eeca7ae4ab 100644 --- a/service/macie2/api_op_ListInvitations.go +++ b/service/macie2/api_op_ListInvitations.go @@ -57,12 +57,12 @@ func (c *Client) ListInvitations(ctx context.Context, params *ListInvitationsInp type ListInvitationsInput struct { + // The maximum number of items to include in each page of a paginated response. + MaxResults *int32 + // The nextToken string that specifies which page of results to return in a // paginated response. NextToken *string - - // The maximum number of items to include in each page of a paginated response. - MaxResults *int32 } type ListInvitationsOutput struct { diff --git a/service/macie2/api_op_ListMembers.go b/service/macie2/api_op_ListMembers.go index 8d8bb41e0fb..f42fe720f78 100644 --- a/service/macie2/api_op_ListMembers.go +++ b/service/macie2/api_op_ListMembers.go @@ -60,15 +60,15 @@ type ListMembersInput struct { // The maximum number of items to include in each page of a paginated response. MaxResults *int32 + // The nextToken string that specifies which page of results to return in a + // paginated response. + NextToken *string + // Specifies which accounts to include in the response, based on the status of an // account's relationship with the master account. By default, the response // includes only current member accounts. To include all accounts, set the value // for this parameter to false. OnlyAssociated *string - - // The nextToken string that specifies which page of results to return in a - // paginated response. - NextToken *string } type ListMembersOutput struct { diff --git a/service/macie2/api_op_TagResource.go b/service/macie2/api_op_TagResource.go index 841cf099c5e..430952a06e5 100644 --- a/service/macie2/api_op_TagResource.go +++ b/service/macie2/api_op_TagResource.go @@ -57,6 +57,12 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { + // The Amazon Resource Name (ARN) of the classification job, custom data + // identifier, findings filter, or member account. + // + // This member is required. + ResourceArn *string + // A map of key-value pairs that specifies the tags to associate with the resource. // A resource can have a maximum of 50 tags. Each tag consists of a required tag // key and an associated tag value. The maximum length of a tag key is 128 @@ -64,12 +70,6 @@ type TagResourceInput struct { // // This member is required. Tags map[string]*string - - // The Amazon Resource Name (ARN) of the classification job, custom data - // identifier, findings filter, or member account. - // - // This member is required. - ResourceArn *string } type TagResourceOutput struct { diff --git a/service/macie2/api_op_TestCustomDataIdentifier.go b/service/macie2/api_op_TestCustomDataIdentifier.go index 202d2854f49..71ddac91782 100644 --- a/service/macie2/api_op_TestCustomDataIdentifier.go +++ b/service/macie2/api_op_TestCustomDataIdentifier.go @@ -62,6 +62,12 @@ type TestCustomDataIdentifierInput struct { // This member is required. Regex *string + // The sample text to inspect by using the custom data identifier. The text can + // contain as many as 1,000 characters. + // + // This member is required. + SampleText *string + // An array that lists specific character sequences (ignore words) to exclude from // the results. If the text matched by the regular expression is the same as any // string in this array, Amazon Macie ignores it. The array can contain as many as @@ -80,12 +86,6 @@ type TestCustomDataIdentifierInput struct { // matches the regex pattern. The distance can be 1 - 300 characters. The default // value is 50. MaximumMatchDistance *int32 - - // The sample text to inspect by using the custom data identifier. The text can - // contain as many as 1,000 characters. - // - // This member is required. - SampleText *string } type TestCustomDataIdentifierOutput struct { diff --git a/service/macie2/api_op_UpdateFindingsFilter.go b/service/macie2/api_op_UpdateFindingsFilter.go index 3041e1c6c60..244f14625c9 100644 --- a/service/macie2/api_op_UpdateFindingsFilter.go +++ b/service/macie2/api_op_UpdateFindingsFilter.go @@ -57,6 +57,17 @@ func (c *Client) UpdateFindingsFilter(ctx context.Context, params *UpdateFinding type UpdateFindingsFilterInput struct { + // The unique identifier for the Amazon Macie resource or account that the request + // applies to. + // + // This member is required. + Id *string + + // The action to perform on findings that meet the filter criteria + // (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) + // the findings; and, NOOP, don't perform any action on the findings. + Action types.FindingsFilterAction + // A custom description of the filter. The description can contain as many as 512 // characters. We strongly recommend that you avoid including any sensitive data in // the description of a filter. Other users might be able to see the filter's @@ -64,10 +75,8 @@ type UpdateFindingsFilterInput struct { // Macie. Description *string - // The position of the filter in the list of saved filters on the Amazon Macie - // console. This value also determines the order in which the filter is applied to - // findings, relative to other filters that are also applied to the findings. - Position *int32 + // The criteria to use to filter findings. + FindingCriteria *types.FindingCriteria // A custom name for the filter. The name must contain at least 3 characters and // can contain as many as 64 characters. We strongly recommend that you avoid @@ -76,29 +85,20 @@ type UpdateFindingsFilterInput struct { // perform in Amazon Macie. Name *string - // The unique identifier for the Amazon Macie resource or account that the request - // applies to. - // - // This member is required. - Id *string - - // The action to perform on findings that meet the filter criteria - // (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) - // the findings; and, NOOP, don't perform any action on the findings. - Action types.FindingsFilterAction - - // The criteria to use to filter findings. - FindingCriteria *types.FindingCriteria + // The position of the filter in the list of saved filters on the Amazon Macie + // console. This value also determines the order in which the filter is applied to + // findings, relative to other filters that are also applied to the findings. + Position *int32 } type UpdateFindingsFilterOutput struct { - // The unique identifier for the filter that was updated. - Id *string - // The Amazon Resource Name (ARN) of the filter that was updated. Arn *string + // The unique identifier for the filter that was updated. + Id *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/macie2/api_op_UpdateMemberSession.go b/service/macie2/api_op_UpdateMemberSession.go index 29e1c0d9212..b44b6957c66 100644 --- a/service/macie2/api_op_UpdateMemberSession.go +++ b/service/macie2/api_op_UpdateMemberSession.go @@ -57,18 +57,18 @@ func (c *Client) UpdateMemberSession(ctx context.Context, params *UpdateMemberSe type UpdateMemberSessionInput struct { + // The unique identifier for the Amazon Macie resource or account that the request + // applies to. + // + // This member is required. + Id *string + // Specifies the new status for the account. Valid values are: ENABLED, resume all // Amazon Macie activities for the account; and, PAUSED, suspend all Macie // activities for the account. // // This member is required. Status types.MacieStatus - - // The unique identifier for the Amazon Macie resource or account that the request - // applies to. - // - // This member is required. - Id *string } type UpdateMemberSessionOutput struct { diff --git a/service/macie2/go.mod b/service/macie2/go.mod index 519ec8e403c..780ec41c974 100644 --- a/service/macie2/go.mod +++ b/service/macie2/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/macie2 go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/macie2/types/types.go b/service/macie2/types/types.go index 0a1bf73251b..6398959f71c 100644 --- a/service/macie2/types/types.go +++ b/service/macie2/types/types.go @@ -58,21 +58,21 @@ type AdminAccount struct { // affected resource. type ApiCallDetails struct { - // The most recent date and time, in UTC and extended ISO 8601 format, when the - // specified operation (api) was invoked and produced the finding. - LastSeen *time.Time - - // The first date and time, in UTC and extended ISO 8601 format, when any operation - // was invoked and produced the finding. - FirstSeen *time.Time + // The name of the operation that was invoked most recently and produced the + // finding. + Api *string // The URL of the AWS service that provides the operation, for example: // s3.amazonaws.com. ApiServiceName *string - // The name of the operation that was invoked most recently and produced the - // finding. - Api *string + // The first date and time, in UTC and extended ISO 8601 format, when any operation + // was invoked and produced the finding. + FirstSeen *time.Time + + // The most recent date and time, in UTC and extended ISO 8601 format, when the + // specified operation (api) was invoked and produced the finding. + LastSeen *time.Time } // Provides information about an identity that performed an action on an affected @@ -80,9 +80,6 @@ type ApiCallDetails struct { // using the AssumeRole operation of the AWS Security Token Service (AWS STS) API. type AssumedRole struct { - // The unique identifier for the entity that was used to get the credentials. - PrincipalId *string - // The AWS access key ID that identifies the credentials. AccessKeyId *string @@ -90,13 +87,16 @@ type AssumedRole struct { // get the credentials. AccountId *string - // The details of the session that was created for the credentials, including the - // entity that issued the session. - SessionContext *SessionContext - // The Amazon Resource Name (ARN) of the entity that was used to get the // credentials. Arn *string + + // The unique identifier for the entity that was used to get the credentials. + PrincipalId *string + + // The details of the session that was created for the credentials, including the + // entity that issued the session. + SessionContext *SessionContext } // Provides information about an AWS account and entity that performed an action on @@ -104,11 +104,11 @@ type AssumedRole struct { // account other than your own account. type AwsAccount struct { - // The unique identifier for the entity that performed the action. - PrincipalId *string - // The unique identifier for the AWS account. AccountId *string + + // The unique identifier for the entity that performed the action. + PrincipalId *string } // Provides information about an AWS service that performed an action on an @@ -125,21 +125,21 @@ type BatchGetCustomDataIdentifierSummary struct { // The Amazon Resource Name (ARN) of the custom data identifier. Arn *string - // The unique identifier for the custom data identifier. - Id *string + // The date and time, in UTC and extended ISO 8601 format, when the custom data + // identifier was created. + CreatedAt *time.Time // Specifies whether the custom data identifier was deleted. If you delete a custom // data identifier, Amazon Macie doesn't delete it permanently. Instead, it soft // deletes the identifier. Deleted *bool - // The date and time, in UTC and extended ISO 8601 format, when the custom data - // identifier was created. - CreatedAt *time.Time - // The custom description of the custom data identifier. Description *string + // The unique identifier for the custom data identifier. + Id *string + // The custom name of the custom data identifier. Name *string } @@ -151,19 +151,19 @@ type BatchGetCustomDataIdentifierSummary struct { // in the Amazon Simple Storage Service Developer Guide. type BlockPublicAccess struct { - // Specifies whether Amazon S3 restricts public bucket policies for the bucket. - RestrictPublicBuckets *bool - // Specifies whether Amazon S3 blocks public access control lists (ACLs) for the // bucket and objects in the bucket. BlockPublicAcls *bool + // Specifies whether Amazon S3 blocks public bucket policies for the bucket. + BlockPublicPolicy *bool + // Specifies whether Amazon S3 ignores public ACLs for the bucket and objects in // the bucket. IgnorePublicAcls *bool - // Specifies whether Amazon S3 blocks public bucket policies for the bucket. - BlockPublicPolicy *bool + // Specifies whether Amazon S3 restricts public bucket policies for the bucket. + RestrictPublicBuckets *bool } // Provides information about the number of S3 buckets that are publicly accessible @@ -193,13 +193,13 @@ type BucketCountByEncryptionType struct { // encryption. KmsManaged *int64 - // The total number of buckets that don't encrypt objects by default. Default - // encryption is disabled for these buckets. - Unencrypted *int64 - // The total number of buckets that use an Amazon S3-managed key to encrypt // objects. These buckets use Amazon S3-managed (SSE-S3) encryption. S3Managed *int64 + + // The total number of buckets that don't encrypt objects by default. Default + // encryption is disabled for these buckets. + Unencrypted *int64 } // Provides information about the number of S3 buckets that are shared with other @@ -210,12 +210,12 @@ type BucketCountBySharedAccessType struct { // of the same Amazon Macie organization. External *int64 - // The total number of buckets that aren't shared with any other AWS accounts. - NotShared *int64 - // The total number of buckets that are shared with an AWS account that's part of // the same Amazon Macie organization. Internal *int64 + + // The total number of buckets that aren't shared with any other AWS accounts. + NotShared *int64 } // Specifies the operator to use in an attribute-based condition that filters the @@ -225,25 +225,25 @@ type BucketCriteriaAdditionalProperties struct { // An equal to condition to apply to a specified attribute value for buckets. Eq []*string - // The prefix of the buckets to include in the results. - Prefix *string - - // A less than or equal to condition to apply to a specified attribute value for - // buckets. - Lte *int64 - // A greater than condition to apply to a specified attribute value for buckets. Gt *int64 + // A greater than or equal to condition to apply to a specified attribute value for + // buckets. + Gte *int64 + // A less than condition to apply to a specified attribute value for buckets. Lt *int64 + // A less than or equal to condition to apply to a specified attribute value for + // buckets. + Lte *int64 + // A not equal to condition to apply to a specified attribute value for buckets. Neq []*string - // A greater than or equal to condition to apply to a specified attribute value for - // buckets. - Gte *int64 + // The prefix of the buckets to include in the results. + Prefix *string } // Provides information about bucket-level permissions settings for an S3 bucket. @@ -264,16 +264,47 @@ type BucketLevelPermissions struct { // Provides information about an S3 bucket that Amazon Macie monitors and analyzes. type BucketMetadata struct { - // The total number of objects in the bucket. - ObjectCount *int64 + // The unique identifier for the AWS account that's associated with the bucket. + AccountId *string + + // The Amazon Resource Name (ARN) of the bucket. + BucketArn *string + + // The date and time, in UTC and extended ISO 8601 format, when the bucket was + // created. + BucketCreatedAt *time.Time + + // The name of the bucket. + BucketName *string // The total number of objects that Amazon Macie can analyze in the bucket. These // objects use a file format, file extension, or content type that Amazon Macie // supports. ClassifiableObjectCount *int64 - // The total storage size, in bytes, of the bucket. - SizeInBytes *int64 + // The date and time, in UTC and extended ISO 8601 format, when Amazon Macie last + // analyzed the bucket. + LastUpdated *time.Time + + // The total number of objects in the bucket. + ObjectCount *int64 + + // The total number of objects that are in the bucket, grouped by server-side + // encryption type. This includes a grouping that reports the total number of + // objects that aren't encrypted or use client-side encryption. + ObjectCountByEncryptionType *ObjectCountByEncryptionType + + // Specifies whether the bucket is publicly accessible. If this value is true, an + // access control list (ACL), bucket policy, or block public access settings allow + // the bucket to be accessed by the general public. + PublicAccess *BucketPublicAccess + + // The AWS Region that hosts the bucket. + Region *string + + // Specifies whether the bucket is configured to replicate one or more objects to + // buckets for other AWS accounts and, if so, which accounts. + ReplicationDetails *ReplicationDetails // Specifies whether the bucket is shared with another AWS account. Valid values // are: @@ -288,47 +319,16 @@ type BucketMetadata struct { // NOT_SHARED - The bucket isn't shared with other AWS accounts. SharedAccess SharedAccess - // The name of the bucket. - BucketName *string - - // The total number of objects that are in the bucket, grouped by server-side - // encryption type. This includes a grouping that reports the total number of - // objects that aren't encrypted or use client-side encryption. - ObjectCountByEncryptionType *ObjectCountByEncryptionType - - // Specifies whether the bucket is configured to replicate one or more objects to - // buckets for other AWS accounts and, if so, which accounts. - ReplicationDetails *ReplicationDetails - - // The AWS Region that hosts the bucket. - Region *string - - // The date and time, in UTC and extended ISO 8601 format, when the bucket was - // created. - BucketCreatedAt *time.Time + // The total storage size, in bytes, of the bucket. + SizeInBytes *int64 // The total compressed storage size, in bytes, of the bucket. SizeInBytesCompressed *int64 - // The unique identifier for the AWS account that's associated with the bucket. - AccountId *string - - // The Amazon Resource Name (ARN) of the bucket. - BucketArn *string - // An array that specifies the tags (keys and values) that are associated with the // bucket. Tags []*KeyValuePair - // Specifies whether the bucket is publicly accessible. If this value is true, an - // access control list (ACL), bucket policy, or block public access settings allow - // the bucket to be accessed by the general public. - PublicAccess *BucketPublicAccess - - // The date and time, in UTC and extended ISO 8601 format, when Amazon Macie last - // analyzed the bucket. - LastUpdated *time.Time - // Specifies whether versioning is enabled for the bucket. Versioning *bool } @@ -336,11 +336,11 @@ type BucketMetadata struct { // The account-level and bucket-level permissions settings for an S3 bucket. type BucketPermissionConfiguration struct { - // The bucket-level permissions settings for the bucket. - BucketLevelPermissions *BucketLevelPermissions - // The account-level permissions settings that apply to the bucket. AccountLevelPermissions *AccountLevelPermissions + + // The bucket-level permissions settings for the bucket. + BucketLevelPermissions *BucketLevelPermissions } // Provides information about the permissions settings of a bucket policy for an S3 @@ -389,19 +389,19 @@ type BucketSortCriteria struct { // classification job that produced the finding. type ClassificationDetails struct { - // The Amazon Resource Name (ARN) of the classification job that produced the - // finding. - JobArn *string - // The Amazon Resource Name (ARN) of the file that contains the detailed record, // including offsets, for the finding. DetailedResultsLocation *string - // The status and detailed results of the finding. - Result *ClassificationResult + // The Amazon Resource Name (ARN) of the classification job that produced the + // finding. + JobArn *string // The unique identifier for the classification job that produced the finding. JobId *string + + // The status and detailed results of the finding. + Result *ClassificationResult } // Specifies where to store data classification results, and the encryption @@ -418,24 +418,24 @@ type ClassificationExportConfiguration struct { // types and number of occurrences of the sensitive data that was found. type ClassificationResult struct { - // The category and number of occurrences of the sensitive data that produced the - // finding. - SensitiveData []*SensitiveDataItem + // The number of occurrences of the data that produced the finding, and the custom + // data identifiers that detected the data. + CustomDataIdentifiers *CustomDataIdentifiers // The type of content, expressed as a MIME type, that the finding applies to. For // example, application/gzip, for a GNU Gzip compressed archive file, or // application/pdf, for an Adobe PDF file. MimeType *string + // The category and number of occurrences of the sensitive data that produced the + // finding. + SensitiveData []*SensitiveDataItem + // The total size, in bytes, of the data that the finding applies to. SizeClassified *int64 // The status of the finding. Status *ClassificationResultStatus - - // The number of occurrences of the data that produced the finding, and the custom - // data identifiers that detected the data. - CustomDataIdentifiers *CustomDataIdentifiers } // Provides information about the status of a sensitive data finding. @@ -457,22 +457,22 @@ type CriterionAdditionalProperties struct { // An equal to condition to apply to a specified property value for findings. Eq []*string - // A less than or equal to condition to apply to a specified property value for - // findings. - Lte *int64 - // A greater than condition to apply to a specified property value for findings. Gt *int64 + // A greater than or equal to condition to apply to a specified property value for + // findings. + Gte *int64 + // A less than condition to apply to a specified property value for findings. Lt *int64 + // A less than or equal to condition to apply to a specified property value for + // findings. + Lte *int64 + // A not equal to condition to apply to a specified property value for findings. Neq []*string - - // A greater than or equal to condition to apply to a specified property value for - // findings. - Gte *int64 } // Provides information about the number of occurrences of the data that produced a @@ -492,8 +492,12 @@ type CustomDataIdentifiers struct { // Provides information about a custom data identifier. type CustomDataIdentifierSummary struct { - // The custom name of the custom data identifier. - Name *string + // The Amazon Resource Name (ARN) of the custom data identifier. + Arn *string + + // The date and time, in UTC and extended ISO 8601 format, when the custom data + // identifier was created. + CreatedAt *time.Time // The custom description of the custom data identifier. Description *string @@ -501,12 +505,8 @@ type CustomDataIdentifierSummary struct { // The unique identifier for the custom data identifier. Id *string - // The Amazon Resource Name (ARN) of the custom data identifier. - Arn *string - - // The date and time, in UTC and extended ISO 8601 format, when the custom data - // identifier was created. - CreatedAt *time.Time + // The custom name of the custom data identifier. + Name *string } // Provides information about a custom data identifier that produced a sensitive @@ -514,15 +514,15 @@ type CustomDataIdentifierSummary struct { // finding. type CustomDetection struct { + // The Amazon Resource Name (ARN) of the custom data identifier. + Arn *string + // The total number of occurrences of the data that the custom data identifier // detected for the finding. Count *int64 // The name of the custom data identifier. Name *string - - // The Amazon Resource Name (ARN) of the custom data identifier. - Arn *string } // Specifies that a classification job runs once a day, every day. This is an empty @@ -556,9 +556,8 @@ type DomainDetails struct { // STS) API. type FederatedUser struct { - // The details of the session that was created for the credentials, including the - // entity that issued the session. - SessionContext *SessionContext + // The AWS access key ID that identifies the credentials. + AccessKeyId *string // The unique identifier for the AWS account that owns the entity that was used to // get the credentials. @@ -571,76 +570,77 @@ type FederatedUser struct { // The unique identifier for the entity that was used to get the credentials. PrincipalId *string - // The AWS access key ID that identifies the credentials. - AccessKeyId *string + // The details of the session that was created for the credentials, including the + // entity that issued the session. + SessionContext *SessionContext } // Provides information about a finding. type Finding struct { - // The unique identifier for the finding. This is a random string that Amazon Macie - // generates and assigns to a finding when it creates the finding. - Id *string - - // The date and time, in UTC and extended ISO 8601 format, when the finding was - // last updated. For sensitive data findings, this value is the same as the value - // for the createdAt property. Sensitive data findings aren't updated. - UpdatedAt *time.Time + // The unique identifier for the AWS account that the finding applies to. This is + // typically the account that owns the affected resource. + AccountId *string - // The details of a sensitive data finding. This value is null for a policy - // finding. - ClassificationDetails *ClassificationDetails + // Specifies whether the finding is archived. + Archived *bool // The category of the finding. Possible values are: CLASSIFICATION, for a // sensitive data finding; and, POLICY, for a policy finding. Category FindingCategory - // The resources that the finding applies to. - ResourcesAffected *ResourcesAffected + // The details of a sensitive data finding. This value is null for a policy + // finding. + ClassificationDetails *ClassificationDetails + + // The total number of occurrences of this finding. + Count *int64 // The date and time, in UTC and extended ISO 8601 format, when the finding was // created. CreatedAt *time.Time + // The description of the finding. + Description *string + + // The unique identifier for the finding. This is a random string that Amazon Macie + // generates and assigns to a finding when it creates the finding. + Id *string + // The AWS partition that Amazon Macie created the finding in. Partition *string - // The version of the schema that was used to define the data structures in the + // The details of a policy finding. This value is null for a sensitive data // finding. - SchemaVersion *string - - // The brief description of the finding. - Title *string - - // The total number of occurrences of this finding. - Count *int64 + PolicyDetails *PolicyDetails // The AWS Region that Amazon Macie created the finding in. Region *string - // The unique identifier for the AWS account that the finding applies to. This is - // typically the account that owns the affected resource. - AccountId *string + // The resources that the finding applies to. + ResourcesAffected *ResourcesAffected // Specifies whether the finding is a sample finding. A sample finding is a finding // that uses example data to demonstrate what a finding might contain. Sample *bool - // The description of the finding. - Description *string - - // The type of the finding. - Type FindingType + // The version of the schema that was used to define the data structures in the + // finding. + SchemaVersion *string // The severity of the finding. Severity *Severity - // Specifies whether the finding is archived. - Archived *bool + // The brief description of the finding. + Title *string - // The details of a policy finding. This value is null for a sensitive data - // finding. - PolicyDetails *PolicyDetails + // The type of the finding. + Type FindingType + + // The date and time, in UTC and extended ISO 8601 format, when the finding was + // last updated. For sensitive data findings, this value is the same as the value + // for the createdAt property. Sensitive data findings aren't updated. + UpdatedAt *time.Time } // Provides information about an action that occurred for a resource and produced a @@ -692,15 +692,15 @@ type FindingsFilterListItem struct { // don't perform any action on the findings. Action FindingsFilterAction - // The custom name of the filter. - Name *string - // The Amazon Resource Name (ARN) of the filter. Arn *string // The unique identifier for the filter. Id *string + // The custom name of the filter. + Name *string + // A map of key-value pairs that identifies the tags (keys and values) that are // associated with the filter. Tags map[string]*string @@ -725,31 +725,31 @@ type FindingStatisticsSortCriteria struct { // data about findings. type GroupCount struct { + // The total number of findings in the group of query results. + Count *int64 + // The name of the property that defines the group in the query results, as // specified by the groupBy property in the query request. GroupKey *string - - // The total number of findings in the group of query results. - Count *int64 } // Provides information about an AWS Identity and Access Management (IAM) user who // performed an action on an affected resource. type IamUser struct { - // The user name of the IAM user who performed the action. - UserName *string + // The unique identifier for the AWS account that's associated with the IAM user + // who performed the action. + AccountId *string // The Amazon Resource Name (ARN) of the principal that performed the action. The // last section of the ARN contains the name of the user who performed the action. Arn *string - // The unique identifier for the AWS account that's associated with the IAM user - // who performed the action. - AccountId *string - // The unique identifier for the IAM user who performed the action. PrincipalId *string + + // The user name of the IAM user who performed the action. + UserName *string } // Provides information about an Amazon Macie membership invitation that was @@ -759,6 +759,10 @@ type Invitation struct { // The AWS account ID for the account that sent the invitation. AccountId *string + // The unique identifier for the invitation. Amazon Macie uses this identifier to + // validate the inviter account with the invitee account. + InvitationId *string + // The date and time, in UTC and extended ISO 8601 format, when the invitation was // sent. InvitedAt *time.Time @@ -767,30 +771,26 @@ type Invitation struct { // (inviter account) and the account that received the invitation (invitee // account). RelationshipStatus RelationshipStatus - - // The unique identifier for the invitation. Amazon Macie uses this identifier to - // validate the inviter account with the invitee account. - InvitationId *string } // Provides information about the IP address of the device that an entity used to // perform an action on an affected resource. type IpAddressDetails struct { + // The Internet Protocol version 4 (IPv4) address of the device. + IpAddressV4 *string + // The city that the IP address originated from. IpCity *IpCity - // The geographic coordinates of the location that the IP address originated from. - IpGeoLocation *IpGeoLocation - // The country that the IP address originated from. IpCountry *IpCountry + // The geographic coordinates of the location that the IP address originated from. + IpGeoLocation *IpGeoLocation + // The registered owner of the IP address. IpOwner *IpOwner - - // The Internet Protocol version 4 (IPv4) address of the device. - IpAddressV4 *string } // Provides information about the city that an IP address originated from. @@ -815,55 +815,55 @@ type IpCountry struct { // originated from. type IpGeoLocation struct { - // The longitude coordinate of the location, rounded to four decimal places. - Lon *float64 - // The latitude coordinate of the location, rounded to four decimal places. Lat *float64 + + // The longitude coordinate of the location, rounded to four decimal places. + Lon *float64 } // Provides information about the registered owner of an IP address. type IpOwner struct { - // The name of the internet service provider (ISP) that owned the IP address. - Isp *string - // The autonomous system number (ASN) for the autonomous system that included the // IP address. Asn *string - // The name of the organization that owned the IP address. - Org *string - // The organization identifier that's associated with the autonomous system number // (ASN) for the autonomous system that included the IP address. AsnOrg *string + + // The name of the internet service provider (ISP) that owned the IP address. + Isp *string + + // The name of the organization that owned the IP address. + Org *string } // Specifies the recurrence pattern for running a classification job. type JobScheduleFrequency struct { - // Specifies a weekly recurrence pattern for running the job. - WeeklySchedule *WeeklySchedule + // Specifies a daily recurrence pattern for running the job. + DailySchedule *DailySchedule // Specifies a monthly recurrence pattern for running the job. MonthlySchedule *MonthlySchedule - // Specifies a daily recurrence pattern for running the job. - DailySchedule *DailySchedule + // Specifies a weekly recurrence pattern for running the job. + WeeklySchedule *WeeklySchedule } // Specifies a property- or tag-based condition that defines criteria for including // or excluding objects from a classification job. type JobScopeTerm struct { - // A tag-based condition that defines the operator and a tag key or tag keys and - // values for including or excluding an object from the job. - TagScopeTerm *TagScopeTerm - // A property-based condition that defines a property, operator, and one or more // values for including or excluding an object from the job. SimpleScopeTerm *SimpleScopeTerm + + // A tag-based condition that defines the operator and a tag key or tag keys and + // values for including or excluding an object from the job. + TagScopeTerm *TagScopeTerm } // Specifies one or more property- and tag-based conditions that define criteria @@ -879,19 +879,13 @@ type JobScopingBlock struct { // the job. type JobSummary struct { + // The S3 buckets that the job is configured to analyze. + BucketDefinitions []*S3BucketDefinitionForJob + // The date and time, in UTC and extended ISO 8601 format, when the job was // created. CreatedAt *time.Time - // The schedule for running the job. Possible values are: - // - // * ONE_TIME - The job - // ran or will run only once. - // - // * SCHEDULED - The job runs on a daily, weekly, - // or monthly basis. - JobType JobType - // The unique identifier for the job. JobId *string @@ -913,28 +907,34 @@ type JobSummary struct { // * PAUSED - Amazon Macie started the job, but completion of // the job would exceed one or more quotas for your account. // - // * RUNNING - The - // job is in progress. - JobStatus JobStatus + // * RUNNING - The + // job is in progress. + JobStatus JobStatus + + // The schedule for running the job. Possible values are: + // + // * ONE_TIME - The job + // ran or will run only once. + // + // * SCHEDULED - The job runs on a daily, weekly, + // or monthly basis. + JobType JobType // The custom name of the job. Name *string - - // The S3 buckets that the job is configured to analyze. - BucketDefinitions []*S3BucketDefinitionForJob } // Provides information about the tags that are associated with an S3 bucket or // object. Each tag consists of a required tag key and an associated tag value. type KeyValuePair struct { - // One part of a key-value pair that comprises a tag. A tag value acts as a - // descriptor for a tag key. A tag value can be empty or null. - Value *string - // One part of a key-value pair that comprises a tag. A tag key is a general label // that acts as a category for more specific tag values. Key *string + + // One part of a key-value pair that comprises a tag. A tag value acts as a + // descriptor for a tag key. A tag value can be empty or null. + Value *string } // Specifies criteria for filtering the results of a request for information about @@ -955,12 +955,12 @@ type ListJobsFilterCriteria struct { // and one or more values. type ListJobsFilterTerm struct { - // The property to use to filter the results. - Key ListJobsFilterKey - // The operator to use to filter the results. Comparator JobComparator + // The property to use to filter the results. + Key ListJobsFilterKey + // An array that lists one or more values to use to filter the results. Values []*string } @@ -969,48 +969,48 @@ type ListJobsFilterTerm struct { // classification jobs. type ListJobsSortCriteria struct { + // The property to sort the results by. + AttributeName ListJobsSortAttributeName + // The sort order to apply to the results, based on the value for the property // specified by the attributeName property. Valid values are: ASC, sort the results // in ascending order; and, DESC, sort the results in descending order. OrderBy OrderBy - - // The property to sort the results by. - AttributeName ListJobsSortAttributeName } // Provides information about an account that's associated with an Amazon Macie // master account. type Member struct { - // A map of key-value pairs that identifies the tags (keys and values) that are - // associated with the account in Amazon Macie. - Tags map[string]*string + // The AWS account ID for the account. + AccountId *string - // The current status of the relationship between the account and the master - // account. - RelationshipStatus RelationshipStatus + // The Amazon Resource Name (ARN) of the account. + Arn *string // The email address for the account. Email *string - // The AWS account ID for the master account. - MasterAccountId *string - - // The AWS account ID for the account. - AccountId *string - // The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie // membership invitation was last sent to the account. This value is null if a // Macie invitation hasn't been sent to the account. InvitedAt *time.Time + // The AWS account ID for the master account. + MasterAccountId *string + + // The current status of the relationship between the account and the master + // account. + RelationshipStatus RelationshipStatus + + // A map of key-value pairs that identifies the tags (keys and values) that are + // associated with the account in Amazon Macie. + Tags map[string]*string + // The date and time, in UTC and extended ISO 8601 format, of the most recent // change to the status of the relationship between the account and the master // account. UpdatedAt *time.Time - - // The Amazon Resource Name (ARN) of the account. - Arn *string } // Specifies a monthly recurrence pattern for running a classification job. @@ -1026,31 +1026,31 @@ type MonthlySchedule struct { // aren't encrypted. type ObjectCountByEncryptionType struct { - // The total number of objects that aren't encrypted or use client-side encryption. - Unencrypted *int64 - // The total number of objects that are encrypted using a customer-managed key. The // objects use customer-provided server-side (SSE-C) encryption. CustomerManaged *int64 - // The total number of objects that are encrypted using an Amazon S3-managed key. - // The objects use Amazon S3-managed (SSE-S3) encryption. - S3Managed *int64 - // The total number of objects that are encrypted using an AWS Key Management // Service (AWS KMS) customer master key (CMK). The objects use AWS KMS AWS-managed // (AWS-KMS) encryption or AWS KMS customer-managed (SSE-KMS) encryption. KmsManaged *int64 + + // The total number of objects that are encrypted using an Amazon S3-managed key. + // The objects use Amazon S3-managed (SSE-S3) encryption. + S3Managed *int64 + + // The total number of objects that aren't encrypted or use client-side encryption. + Unencrypted *int64 } // Provides the details of a policy finding. type PolicyDetails struct { - // The entity that performed the action that produced the finding. - Actor *FindingActor - // The action that produced the finding. Action *FindingAction + + // The entity that performed the action that produced the finding. + Actor *FindingActor } // Provides information about settings that define whether one or more objects in @@ -1086,9 +1086,6 @@ type ResourcesAffected struct { // Provides information about an S3 bucket that a finding applies to. type S3Bucket struct { - // The display name and account identifier for the user who owns the bucket. - Owner *S3BucketOwner - // The Amazon Resource Name (ARN) of the bucket. Arn *string @@ -1096,15 +1093,18 @@ type S3Bucket struct { // created. CreatedAt *time.Time - // The permissions settings that determine whether the bucket is publicly - // accessible. - PublicAccess *BucketPublicAccess + // The server-side encryption settings for the bucket. + DefaultServerSideEncryption *ServerSideEncryption // The name of the bucket. Name *string - // The server-side encryption settings for the bucket. - DefaultServerSideEncryption *ServerSideEncryption + // The display name and account identifier for the user who owns the bucket. + Owner *S3BucketOwner + + // The permissions settings that determine whether the bucket is publicly + // accessible. + PublicAccess *BucketPublicAccess // The tags that are associated with the bucket. Tags []*KeyValuePair @@ -1114,23 +1114,23 @@ type S3Bucket struct { // analyzes. type S3BucketDefinitionForJob struct { - // An array that lists the names of the buckets. - Buckets []*string - // The unique identifier for the AWS account that owns one or more of the buckets. // If specified, the job analyzes objects in all the buckets that are owned by the // account and meet other conditions specified for the job. AccountId *string + + // An array that lists the names of the buckets. + Buckets []*string } // Provides information about the user who owns an S3 bucket. type S3BucketOwner struct { - // The AWS account ID for the user who owns the bucket. - Id *string - // The display name of the user who owns the bucket. DisplayName *string + + // The AWS account ID for the user who owns the bucket. + Id *string } // Specifies an S3 bucket to store data classification results in, and the @@ -1142,16 +1142,16 @@ type S3Destination struct { // This member is required. BucketName *string - // The path prefix to use in the path to the location in the bucket. This prefix - // specifies where to store classification results in the bucket. - KeyPrefix *string - // The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) // customer master key (CMK) to use for encryption of the results. This must be the // ARN of an existing CMK that's in the same AWS Region as the bucket. // // This member is required. KmsKeyArn *string + + // The path prefix to use in the path to the location in the bucket. This prefix + // specifies where to store classification results in the bucket. + KeyPrefix *string } // Specifies which S3 buckets contain the objects that a classification job @@ -1172,43 +1172,43 @@ type S3Object struct { // The Amazon Resource Name (ARN) of the bucket that contains the object. BucketArn *string + // The entity tag (ETag) that identifies the affected version of the object. If the + // object was overwritten or changed after Amazon Macie produced the finding, this + // value might be different from the current ETag for the object. + ETag *string + // The file extension of the object. If the object doesn't have a file extension, // this value is "". Extension *string - // The identifier for the affected version of the object. - VersionId *string + // The full key (name) that's assigned to the object. + Key *string - // The entity tag (ETag) that identifies the affected version of the object. If the - // object was overwritten or changed after Amazon Macie produced the finding, this - // value might be different from the current ETag for the object. - ETag *string + // The date and time, in UTC and extended ISO 8601 format, when the object was last + // modified. + LastModified *time.Time // The path to the object, including the full key (name). Path *string - // The total storage size, in bytes, of the object. - Size *int64 - // Specifies whether the object is publicly accessible due to the combination of // permissions settings that apply to the object. PublicAccess *bool - // The storage class of the object. - StorageClass StorageClass - - // The date and time, in UTC and extended ISO 8601 format, when the object was last - // modified. - LastModified *time.Time - // The server-side encryption settings for the object. ServerSideEncryption *ServerSideEncryption + // The total storage size, in bytes, of the object. + Size *int64 + + // The storage class of the object. + StorageClass StorageClass + // The tags that are associated with the object. Tags []*KeyValuePair - // The full key (name) that's assigned to the object. - Key *string + // The identifier for the affected version of the object. + VersionId *string } // Specifies one or more property- and tag-based conditions that refine the scope @@ -1229,9 +1229,6 @@ type Scoping struct { // sensitive data that produced a finding. type SensitiveDataItem struct { - // The total number of occurrences of the sensitive data that was detected. - TotalCount *int64 - // The category of sensitive data that was detected. For example: // FINANCIAL_INFORMATION, for financial information such as credit card numbers; // PERSONAL_INFORMATION, for personally identifiable information such as full names @@ -1243,6 +1240,9 @@ type SensitiveDataItem struct { // object reports the number of occurrences of a specific type of sensitive data // that was detected. Detections []*DefaultDetection + + // The total number of occurrences of the sensitive data that was detected. + TotalCount *int64 } // Provides information about the server-side encryption settings for an S3 bucket @@ -1291,12 +1291,12 @@ type SessionContext struct { // were issued to an entity. type SessionContextAttributes struct { + // The date and time, in UTC and ISO 8601 format, when the credentials were issued. + CreationDate *time.Time + // Specifies whether the credentials were authenticated with a multi-factor // authentication (MFA) device. MfaAuthenticated *bool - - // The date and time, in UTC and ISO 8601 format, when the credentials were issued. - CreationDate *time.Time } // Provides information about the source and type of temporary security credentials @@ -1307,6 +1307,13 @@ type SessionIssuer struct { // get the credentials. AccountId *string + // The Amazon Resource Name (ARN) of the source account, IAM user, or role that was + // used to get the credentials. + Arn *string + + // The unique identifier for the entity that was used to get the credentials. + PrincipalId *string + // The source of the temporary security credentials, such as Root, IAMUser, or // Role. Type *string @@ -1315,13 +1322,6 @@ type SessionIssuer struct { // null if the credentials were obtained from a root account that doesn't have an // alias. UserName *string - - // The Amazon Resource Name (ARN) of the source account, IAM user, or role that was - // used to get the credentials. - Arn *string - - // The unique identifier for the entity that was used to get the credentials. - PrincipalId *string } // Provides the numeric score and textual representation of a severity value. @@ -1342,11 +1342,11 @@ type SimpleScopeTerm struct { // The operator to use in the condition. Comparator JobComparator - // An array that lists one or more values to use in the condition. - Values []*string - // The property to use in the condition. Key ScopeFilterKey + + // An array that lists one or more values to use in the condition. + Values []*string } // Specifies criteria for sorting the results of a request for information about @@ -1378,28 +1378,28 @@ type Statistics struct { // excluded from a classification job. type TagScopeTerm struct { - // The tag key and value pairs to use in the condition. - TagValues []*TagValuePair + // The operator to use in the condition. + Comparator JobComparator // The tag key to use in the condition. Key *string + // The tag key and value pairs to use in the condition. + TagValues []*TagValuePair + // The type of object to apply the condition to. Target TagTarget - - // The operator to use in the condition. - Comparator JobComparator } // Specifies a tag key and value, as a pair, to use in a tag-based condition for a // classification job. type TagValuePair struct { - // The tag value, associated with the specified tag key, to use in the condition. - Value *string - // The value for the tag key to use in the condition. Key *string + + // The tag value, associated with the specified tag key, to use in the condition. + Value *string } // Provides information about an account-related request that hasn't been @@ -1409,11 +1409,11 @@ type UnprocessedAccount struct { // The AWS account ID for the account that the request applies to. AccountId *string - // The reason why the request hasn't been processed. - ErrorMessage *string - // The source of the issue or delay in processing the request. ErrorCode ErrorCode + + // The reason why the request hasn't been processed. + ErrorMessage *string } // Provides data for a specific usage metric and the corresponding quota for an @@ -1421,13 +1421,13 @@ type UnprocessedAccount struct { // during the past 30 days. type UsageByAccount struct { - // The estimated value for the metric. - EstimatedCost *string - // The type of currency that the value for the metric (estimatedCost) is reported // in. Currency Currency + // The estimated value for the metric. + EstimatedCost *string + // The current value for the quota that corresponds to the metric specified by the // type field. ServiceLimit *ServiceLimit @@ -1441,13 +1441,13 @@ type UsageByAccount struct { // Provides quota and aggregated usage data for an account. type UsageRecord struct { + // The unique identifier for the AWS account that the data applies to. + AccountId *string + // The date and time, in UTC and extended ISO 8601 format, when the free trial // started for the account. FreeTrialStartDate *time.Time - // The unique identifier for the AWS account that the data applies to. - AccountId *string - // An array of objects that contains usage data and quotas for the account. Each // object contains the data for a specific usage metric and the corresponding // quota. @@ -1458,6 +1458,14 @@ type UsageRecord struct { // and usage data. type UsageStatisticsFilter struct { + // The operator to use in the condition. If the value for the key property is + // accountId, this value must be CONTAINS. If the value for the key property is any + // other supported field, this value can be EQ, GT, GTE, LT, LTE, or NE. + Comparator UsageStatisticsFilterComparator + + // The field to use in the condition. + Key UsageStatisticsFilterKey + // An array that lists values to use in the condition, based on the value for the // field specified by the key property. If the value for the key property is // accountId, this array can specify multiple values. Otherwise, this array can @@ -1477,14 +1485,6 @@ type UsageStatisticsFilter struct { // A string that represents the current, estimated month-to-date cost for an // account. Values []*string - - // The field to use in the condition. - Key UsageStatisticsFilterKey - - // The operator to use in the condition. If the value for the key property is - // accountId, this value must be CONTAINS. If the value for the key property is any - // other supported field, this value can be EQ, GT, GTE, LT, LTE, or NE. - Comparator UsageStatisticsFilterComparator } // Specifies criteria for sorting the results of a query for account quotas and @@ -1531,26 +1531,26 @@ type UserIdentity struct { // details of that account. AwsAccount *AwsAccount - // The type of entity that performed the action. - Type UserIdentityType - // If the action was performed by an AWS account that belongs to an AWS service, // the name of the service. AwsService *AwsService - // If the action was performed using the credentials for an AWS Identity and Access - // Management (IAM) user, the name and other details about the user. - IamUser *IamUser - // If the action was performed with temporary security credentials that were // obtained using the GetFederationToken operation of the AWS Security Token // Service (AWS STS) API, the identifiers, session context, and other details about // the identity. FederatedUser *FederatedUser + // If the action was performed using the credentials for an AWS Identity and Access + // Management (IAM) user, the name and other details about the user. + IamUser *IamUser + // If the action was performed using the credentials for your AWS account, the // details of your account. Root *UserIdentityRoot + + // The type of entity that performed the action. + Type UserIdentityType } // Provides information about an AWS account and entity that performed an action on @@ -1558,16 +1558,16 @@ type UserIdentity struct { // AWS account. type UserIdentityRoot struct { - // The unique identifier for the entity that performed the action. - PrincipalId *string + // The unique identifier for the AWS account. + AccountId *string // The Amazon Resource Name (ARN) of the principal that performed the action. The // last section of the ARN contains the name of the user or role that performed the // action. Arn *string - // The unique identifier for the AWS account. - AccountId *string + // The unique identifier for the entity that performed the action. + PrincipalId *string } // Specifies a weekly recurrence pattern for running a classification job. diff --git a/service/managedblockchain/api_op_CreateMember.go b/service/managedblockchain/api_op_CreateMember.go index 8b549866eff..83989ca3b53 100644 --- a/service/managedblockchain/api_op_CreateMember.go +++ b/service/managedblockchain/api_op_CreateMember.go @@ -59,15 +59,13 @@ func (c *Client) CreateMember(ctx context.Context, params *CreateMemberInput, op type CreateMemberInput struct { - // The unique identifier of the network in which the member is created. - // - // This member is required. - NetworkId *string - - // Member configuration parameters. + // A unique, case-sensitive identifier that you provide to ensure the idempotency + // of the operation. An idempotent operation completes no more than one time. This + // identifier is required only if you make a service request directly using an HTTP + // client. It is generated automatically if you use an AWS SDK or the AWS CLI. // // This member is required. - MemberConfiguration *types.MemberConfiguration + ClientRequestToken *string // The unique identifier of the invitation that is sent to the member to join the // network. @@ -75,13 +73,15 @@ type CreateMemberInput struct { // This member is required. InvitationId *string - // A unique, case-sensitive identifier that you provide to ensure the idempotency - // of the operation. An idempotent operation completes no more than one time. This - // identifier is required only if you make a service request directly using an HTTP - // client. It is generated automatically if you use an AWS SDK or the AWS CLI. + // Member configuration parameters. // // This member is required. - ClientRequestToken *string + MemberConfiguration *types.MemberConfiguration + + // The unique identifier of the network in which the member is created. + // + // This member is required. + NetworkId *string } type CreateMemberOutput struct { diff --git a/service/managedblockchain/api_op_CreateNetwork.go b/service/managedblockchain/api_op_CreateNetwork.go index 7fd92581ea8..50c5ed6f7b1 100644 --- a/service/managedblockchain/api_op_CreateNetwork.go +++ b/service/managedblockchain/api_op_CreateNetwork.go @@ -67,47 +67,47 @@ type CreateNetworkInput struct { // This member is required. ClientRequestToken *string - // An optional description for the network. - Description *string + // The blockchain framework that the network uses. + // + // This member is required. + Framework types.Framework - // The name of the network. + // The version of the blockchain framework that the network uses. // // This member is required. - Name *string + FrameworkVersion *string // Configuration properties for the first member within the network. // // This member is required. MemberConfiguration *types.MemberConfiguration - // The voting rules used by the network to determine if a proposal is approved. + // The name of the network. // // This member is required. - VotingPolicy *types.VotingPolicy + Name *string - // The blockchain framework that the network uses. + // The voting rules used by the network to determine if a proposal is approved. // // This member is required. - Framework types.Framework + VotingPolicy *types.VotingPolicy + + // An optional description for the network. + Description *string // Configuration properties of the blockchain framework relevant to the network // configuration. FrameworkConfiguration *types.NetworkFrameworkConfiguration - - // The version of the blockchain framework that the network uses. - // - // This member is required. - FrameworkVersion *string } type CreateNetworkOutput struct { - // The unique identifier for the network. - NetworkId *string - // The unique identifier for the first member within the network. MemberId *string + // The unique identifier for the network. + NetworkId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/managedblockchain/api_op_CreateNode.go b/service/managedblockchain/api_op_CreateNode.go index 7e34c7dea8b..12bfbdbde71 100644 --- a/service/managedblockchain/api_op_CreateNode.go +++ b/service/managedblockchain/api_op_CreateNode.go @@ -72,15 +72,15 @@ type CreateNodeInput struct { // This member is required. MemberId *string - // The properties of a node configuration. + // The unique identifier of the network in which this node runs. // // This member is required. - NodeConfiguration *types.NodeConfiguration + NetworkId *string - // The unique identifier of the network in which this node runs. + // The properties of a node configuration. // // This member is required. - NetworkId *string + NodeConfiguration *types.NodeConfiguration } type CreateNodeOutput struct { diff --git a/service/managedblockchain/api_op_CreateProposal.go b/service/managedblockchain/api_op_CreateProposal.go index 0c2042d03c3..0a663501182 100644 --- a/service/managedblockchain/api_op_CreateProposal.go +++ b/service/managedblockchain/api_op_CreateProposal.go @@ -61,14 +61,12 @@ func (c *Client) CreateProposal(ctx context.Context, params *CreateProposalInput type CreateProposalInput struct { - // A description for the proposal that is visible to voting members, for example, - // "Proposal to add Example Corp. as member." - Description *string - - // The unique identifier of the network for which the proposal is made. + // The type of actions proposed, such as inviting a member or removing a member. + // The types of Actions in a proposal are mutually exclusive. For example, a + // proposal with Invitations actions cannot also contain Removals actions. // // This member is required. - NetworkId *string + Actions *types.ProposalActions // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the operation. An idempotent operation completes no more than one time. This @@ -85,12 +83,14 @@ type CreateProposalInput struct { // This member is required. MemberId *string - // The type of actions proposed, such as inviting a member or removing a member. - // The types of Actions in a proposal are mutually exclusive. For example, a - // proposal with Invitations actions cannot also contain Removals actions. + // The unique identifier of the network for which the proposal is made. // // This member is required. - Actions *types.ProposalActions + NetworkId *string + + // A description for the proposal that is visible to voting members, for example, + // "Proposal to add Example Corp. as member." + Description *string } type CreateProposalOutput struct { diff --git a/service/managedblockchain/api_op_DeleteMember.go b/service/managedblockchain/api_op_DeleteMember.go index 0deecba59fa..4370bcfe59a 100644 --- a/service/managedblockchain/api_op_DeleteMember.go +++ b/service/managedblockchain/api_op_DeleteMember.go @@ -62,15 +62,15 @@ func (c *Client) DeleteMember(ctx context.Context, params *DeleteMemberInput, op type DeleteMemberInput struct { - // The unique identifier of the network from which the member is removed. + // The unique identifier of the member to remove. // // This member is required. - NetworkId *string + MemberId *string - // The unique identifier of the member to remove. + // The unique identifier of the network from which the member is removed. // // This member is required. - MemberId *string + NetworkId *string } type DeleteMemberOutput struct { diff --git a/service/managedblockchain/api_op_DeleteNode.go b/service/managedblockchain/api_op_DeleteNode.go index 02d2fe653c1..67ee27842f2 100644 --- a/service/managedblockchain/api_op_DeleteNode.go +++ b/service/managedblockchain/api_op_DeleteNode.go @@ -57,6 +57,11 @@ func (c *Client) DeleteNode(ctx context.Context, params *DeleteNodeInput, optFns type DeleteNodeInput struct { + // The unique identifier of the member that owns this node. + // + // This member is required. + MemberId *string + // The unique identifier of the network that the node belongs to. // // This member is required. @@ -66,11 +71,6 @@ type DeleteNodeInput struct { // // This member is required. NodeId *string - - // The unique identifier of the member that owns this node. - // - // This member is required. - MemberId *string } type DeleteNodeOutput struct { diff --git a/service/managedblockchain/api_op_GetNode.go b/service/managedblockchain/api_op_GetNode.go index 0e37dfa2871..ad5be325a12 100644 --- a/service/managedblockchain/api_op_GetNode.go +++ b/service/managedblockchain/api_op_GetNode.go @@ -57,11 +57,6 @@ func (c *Client) GetNode(ctx context.Context, params *GetNodeInput, optFns ...fu type GetNodeInput struct { - // The unique identifier of the node. - // - // This member is required. - NodeId *string - // The unique identifier of the member that owns the node. // // This member is required. @@ -71,6 +66,11 @@ type GetNodeInput struct { // // This member is required. NetworkId *string + + // The unique identifier of the node. + // + // This member is required. + NodeId *string } type GetNodeOutput struct { diff --git a/service/managedblockchain/api_op_GetProposal.go b/service/managedblockchain/api_op_GetProposal.go index e0847cf7638..ae0174356de 100644 --- a/service/managedblockchain/api_op_GetProposal.go +++ b/service/managedblockchain/api_op_GetProposal.go @@ -57,15 +57,15 @@ func (c *Client) GetProposal(ctx context.Context, params *GetProposalInput, optF type GetProposalInput struct { - // The unique identifier of the proposal. + // The unique identifier of the network for which the proposal is made. // // This member is required. - ProposalId *string + NetworkId *string - // The unique identifier of the network for which the proposal is made. + // The unique identifier of the proposal. // // This member is required. - NetworkId *string + ProposalId *string } type GetProposalOutput struct { diff --git a/service/managedblockchain/api_op_ListMembers.go b/service/managedblockchain/api_op_ListMembers.go index 6f86c9b4258..e08c7193e2b 100644 --- a/service/managedblockchain/api_op_ListMembers.go +++ b/service/managedblockchain/api_op_ListMembers.go @@ -58,9 +58,6 @@ func (c *Client) ListMembers(ctx context.Context, params *ListMembersInput, optF type ListMembersInput struct { - // The pagination token that indicates the next set of results to retrieve. - NextToken *string - // The unique identifier of the network for which to list members. // // This member is required. @@ -71,11 +68,14 @@ type ListMembersInput struct { // If omitted, all members are listed. IsOwned *bool + // The maximum number of members to return in the request. + MaxResults *int32 + // The optional name of the member to list. Name *string - // The maximum number of members to return in the request. - MaxResults *int32 + // The pagination token that indicates the next set of results to retrieve. + NextToken *string // An optional status specifier. If provided, only members currently in this status // are listed. @@ -84,13 +84,13 @@ type ListMembersInput struct { type ListMembersOutput struct { - // The pagination token that indicates the next set of results to retrieve. - NextToken *string - // An array of MemberSummary objects. Each object contains details about a network // member. Members []*types.MemberSummary + // The pagination token that indicates the next set of results to retrieve. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/managedblockchain/api_op_ListNetworks.go b/service/managedblockchain/api_op_ListNetworks.go index c56a743410d..d0a8ca1919e 100644 --- a/service/managedblockchain/api_op_ListNetworks.go +++ b/service/managedblockchain/api_op_ListNetworks.go @@ -57,33 +57,33 @@ func (c *Client) ListNetworks(ctx context.Context, params *ListNetworksInput, op type ListNetworksInput struct { - // An optional status specifier. If provided, only networks currently in this - // status are listed. - Status types.NetworkStatus - // An optional framework specifier. If provided, only networks of this framework // type are listed. Framework types.Framework - // The name of the network. - Name *string - // The maximum number of networks to list. MaxResults *int32 + // The name of the network. + Name *string + // The pagination token that indicates the next set of results to retrieve. NextToken *string + + // An optional status specifier. If provided, only networks currently in this + // status are listed. + Status types.NetworkStatus } type ListNetworksOutput struct { - // The pagination token that indicates the next set of results to retrieve. - NextToken *string - // An array of NetworkSummary objects that contain configuration properties for // each network. Networks []*types.NetworkSummary + // The pagination token that indicates the next set of results to retrieve. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/managedblockchain/api_op_ListNodes.go b/service/managedblockchain/api_op_ListNodes.go index 2d67699cb87..723a57d9b18 100644 --- a/service/managedblockchain/api_op_ListNodes.go +++ b/service/managedblockchain/api_op_ListNodes.go @@ -62,31 +62,31 @@ type ListNodesInput struct { // This member is required. MemberId *string - // An optional status specifier. If provided, only nodes currently in this status - // are listed. - Status types.NodeStatus - // The unique identifier of the network for which to list nodes. // // This member is required. NetworkId *string + // The maximum number of nodes to list. + MaxResults *int32 + // The pagination token that indicates the next set of results to retrieve. NextToken *string - // The maximum number of nodes to list. - MaxResults *int32 + // An optional status specifier. If provided, only nodes currently in this status + // are listed. + Status types.NodeStatus } type ListNodesOutput struct { + // The pagination token that indicates the next set of results to retrieve. + NextToken *string + // An array of NodeSummary objects that contain configuration properties for each // node. Nodes []*types.NodeSummary - // The pagination token that indicates the next set of results to retrieve. - NextToken *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/managedblockchain/api_op_ListProposalVotes.go b/service/managedblockchain/api_op_ListProposalVotes.go index b02b87cd91e..fae732da4e4 100644 --- a/service/managedblockchain/api_op_ListProposalVotes.go +++ b/service/managedblockchain/api_op_ListProposalVotes.go @@ -63,16 +63,16 @@ type ListProposalVotesInput struct { // This member is required. NetworkId *string - // The pagination token that indicates the next set of results to retrieve. - NextToken *string - - // The maximum number of votes to return. - MaxResults *int32 - // The unique identifier of the proposal. // // This member is required. ProposalId *string + + // The maximum number of votes to return. + MaxResults *int32 + + // The pagination token that indicates the next set of results to retrieve. + NextToken *string } type ListProposalVotesOutput struct { diff --git a/service/managedblockchain/api_op_ListProposals.go b/service/managedblockchain/api_op_ListProposals.go index 6ac71640df4..17061ae678e 100644 --- a/service/managedblockchain/api_op_ListProposals.go +++ b/service/managedblockchain/api_op_ListProposals.go @@ -62,21 +62,21 @@ type ListProposalsInput struct { // This member is required. NetworkId *string - // The pagination token that indicates the next set of results to retrieve. - NextToken *string - // The maximum number of proposals to return. MaxResults *int32 + + // The pagination token that indicates the next set of results to retrieve. + NextToken *string } type ListProposalsOutput struct { - // The summary of each proposal made on the network. - Proposals []*types.ProposalSummary - // The pagination token that indicates the next set of results to retrieve. NextToken *string + // The summary of each proposal made on the network. + Proposals []*types.ProposalSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/managedblockchain/api_op_UpdateMember.go b/service/managedblockchain/api_op_UpdateMember.go index 16d21a20dda..b597957b712 100644 --- a/service/managedblockchain/api_op_UpdateMember.go +++ b/service/managedblockchain/api_op_UpdateMember.go @@ -57,15 +57,15 @@ func (c *Client) UpdateMember(ctx context.Context, params *UpdateMemberInput, op type UpdateMemberInput struct { - // The unique ID of the Managed Blockchain network to which the member belongs. + // The unique ID of the member. // // This member is required. - NetworkId *string + MemberId *string - // The unique ID of the member. + // The unique ID of the Managed Blockchain network to which the member belongs. // // This member is required. - MemberId *string + NetworkId *string // Configuration properties for publishing to Amazon CloudWatch Logs. LogPublishingConfiguration *types.MemberLogPublishingConfiguration diff --git a/service/managedblockchain/api_op_UpdateNode.go b/service/managedblockchain/api_op_UpdateNode.go index bdea7b223ed..a50fb282370 100644 --- a/service/managedblockchain/api_op_UpdateNode.go +++ b/service/managedblockchain/api_op_UpdateNode.go @@ -57,23 +57,23 @@ func (c *Client) UpdateNode(ctx context.Context, params *UpdateNodeInput, optFns type UpdateNodeInput struct { - // The unique ID of the node. - // - // This member is required. - NodeId *string - // The unique ID of the member that owns the node. // // This member is required. MemberId *string - // Configuration properties for publishing to Amazon CloudWatch Logs. - LogPublishingConfiguration *types.NodeLogPublishingConfiguration - // The unique ID of the Managed Blockchain network to which the node belongs. // // This member is required. NetworkId *string + + // The unique ID of the node. + // + // This member is required. + NodeId *string + + // Configuration properties for publishing to Amazon CloudWatch Logs. + LogPublishingConfiguration *types.NodeLogPublishingConfiguration } type UpdateNodeOutput struct { diff --git a/service/managedblockchain/api_op_VoteOnProposal.go b/service/managedblockchain/api_op_VoteOnProposal.go index ced3a336297..472bd5371ff 100644 --- a/service/managedblockchain/api_op_VoteOnProposal.go +++ b/service/managedblockchain/api_op_VoteOnProposal.go @@ -64,6 +64,11 @@ type VoteOnProposalInput struct { // This member is required. NetworkId *string + // The unique identifier of the proposal. + // + // This member is required. + ProposalId *string + // The value of the vote. // // This member is required. @@ -73,11 +78,6 @@ type VoteOnProposalInput struct { // // This member is required. VoterMemberId *string - - // The unique identifier of the proposal. - // - // This member is required. - ProposalId *string } type VoteOnProposalOutput struct { diff --git a/service/managedblockchain/go.mod b/service/managedblockchain/go.mod index 49a83de9750..da77bf50979 100644 --- a/service/managedblockchain/go.mod +++ b/service/managedblockchain/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/managedblockchain go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/managedblockchain/types/types.go b/service/managedblockchain/types/types.go index 8d873a0b586..cf1993dde7b 100644 --- a/service/managedblockchain/types/types.go +++ b/service/managedblockchain/types/types.go @@ -18,6 +18,11 @@ type ApprovalThresholdPolicy struct { // the proposal is EXPIRED and ProposalActions are not carried out. ProposalDurationInHours *int32 + // Determines whether the vote percentage must be greater than the + // ThresholdPercentage or must be greater than or equal to the ThreholdPercentage + // to be approved. + ThresholdComparator ThresholdComparator + // The percentage of votes among all members that must be YES for a proposal to be // approved. For example, a ThresholdPercentage value of 50 indicates 50%. The // ThresholdComparator determines the precise comparison. If a ThresholdPercentage @@ -25,24 +30,22 @@ type ApprovalThresholdPolicy struct { // ThresholdComparator value of GREATER_THAN, this indicates that 6 YES votes are // required for the proposal to be approved. ThresholdPercentage *int32 - - // Determines whether the vote percentage must be greater than the - // ThresholdPercentage or must be greater than or equal to the ThreholdPercentage - // to be approved. - ThresholdComparator ThresholdComparator } // An invitation to an AWS account to create a member and join the network. type Invitation struct { + // The date and time that the invitation was created. + CreationDate *time.Time + // The date and time that the invitation expires. This is the CreationDate plus the // ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After // this date and time, the invitee can no longer create a member and join the // network using this InvitationId. ExpirationDate *time.Time - // The date and time that the invitation was created. - CreationDate *time.Time + // The unique identifier for the invitation. + InvitationId *string // A summary of network configuration properties. NetworkSummary *NetworkSummary @@ -65,9 +68,6 @@ type Invitation struct { // * EXPIRED - The invitee neither created a member nor rejected the invitation // before the ExpirationDate. Status InvitationStatus - - // The unique identifier for the invitation. - InvitationId *string } // An action to invite a specific AWS account to create a member and join the @@ -97,25 +97,28 @@ type LogConfigurations struct { // Member configuration properties. type Member struct { - // The unique identifier of the member. - Id *string + // The date and time that the member was created. + CreationDate *time.Time // An optional description for the member. Description *string - // The name of the member. - Name *string + // Attributes relevant to a member for the blockchain framework that the Managed + // Blockchain network uses. + FrameworkAttributes *MemberFrameworkAttributes + + // The unique identifier of the member. + Id *string // Configuration properties for logging events associated with a member. LogPublishingConfiguration *MemberLogPublishingConfiguration + // The name of the member. + Name *string + // The unique identifier of the network to which the member belongs. NetworkId *string - // Attributes relevant to a member for the blockchain framework that the Managed - // Blockchain network uses. - FrameworkAttributes *MemberFrameworkAttributes - // The status of a member. // // * CREATING - The AWS account is in the process of @@ -137,9 +140,6 @@ type Member struct { // Either the AWS account that owns the member deleted it, or the member is being // deleted as the result of an APPROVEDPROPOSAL to remove the member. Status MemberStatus - - // The date and time that the member was created. - CreationDate *time.Time } // Configuration properties of the member. @@ -150,14 +150,14 @@ type MemberConfiguration struct { // This member is required. FrameworkConfiguration *MemberFrameworkConfiguration - // An optional description of the member. - Description *string - // The name of the member. // // This member is required. Name *string + // An optional description of the member. + Description *string + // LogPublishingConfiguration *MemberLogPublishingConfiguration } @@ -232,6 +232,15 @@ type MemberLogPublishingConfiguration struct { // A summary of configuration properties for a member. type MemberSummary struct { + // The date and time that the member was created. + CreationDate *time.Time + + // An optional description of the member. + Description *string + + // The unique identifier of the member. + Id *string + // An indicator of whether the member is owned by your AWS account or a different // AWS account. IsOwned *bool @@ -239,9 +248,6 @@ type MemberSummary struct { // The name of the member. Name *string - // An optional description of the member. - Description *string - // The status of the member. // // * CREATING - The AWS account is in the process of @@ -263,60 +269,54 @@ type MemberSummary struct { // Either the AWS account that owns the member deleted it, or the member is being // deleted as the result of an APPROVEDPROPOSAL to remove the member. Status MemberStatus - - // The unique identifier of the member. - Id *string - - // The date and time that the member was created. - CreationDate *time.Time } // Network configuration properties. type Network struct { - // The voting rules for the network to decide if a proposal is accepted. - VotingPolicy *VotingPolicy + // The date and time that the network was created. + CreationDate *time.Time - // The VPC endpoint service name of the VPC endpoint service of the network. - // Members use the VPC endpoint service name to create a VPC endpoint to access - // network resources. - VpcEndpointServiceName *string + // Attributes of the blockchain framework for the network. + Description *string + + // The blockchain framework that the network uses. + Framework Framework // Attributes of the blockchain framework that the network uses. FrameworkAttributes *NetworkFrameworkAttributes - // The current status of the network. - Status NetworkStatus - - // The name of the network. - Name *string - - // The blockchain framework that the network uses. - Framework Framework + // The version of the blockchain framework that the network uses. + FrameworkVersion *string // The unique identifier of the network. Id *string - // Attributes of the blockchain framework for the network. - Description *string + // The name of the network. + Name *string - // The version of the blockchain framework that the network uses. - FrameworkVersion *string + // The current status of the network. + Status NetworkStatus - // The date and time that the network was created. - CreationDate *time.Time + // The voting rules for the network to decide if a proposal is accepted. + VotingPolicy *VotingPolicy + + // The VPC endpoint service name of the VPC endpoint service of the network. + // Members use the VPC endpoint service name to create a VPC endpoint to access + // network resources. + VpcEndpointServiceName *string } // Attributes of Hyperledger Fabric for a network. type NetworkFabricAttributes struct { - // The endpoint of the ordering service for the network. - OrderingServiceEndpoint *string - // The edition of Amazon Managed Blockchain that Hyperledger Fabric uses. For more // information, see Amazon Managed Blockchain Pricing // (http://aws.amazon.com/managed-blockchain/pricing/). Edition Edition + + // The endpoint of the ordering service for the network. + OrderingServiceEndpoint *string } // Hyperledger Fabric configuration properties for the network. @@ -351,54 +351,54 @@ type NetworkFrameworkConfiguration struct { // A summary of network configuration properties. type NetworkSummary struct { - // The unique identifier of the network. - Id *string - - // The version of the blockchain framework that the network uses. - FrameworkVersion *string - // The date and time that the network was created. CreationDate *time.Time - // The current status of the network. - Status NetworkStatus - // An optional description of the network. Description *string + // The blockchain framework that the network uses. + Framework Framework + + // The version of the blockchain framework that the network uses. + FrameworkVersion *string + + // The unique identifier of the network. + Id *string + // The name of the network. Name *string - // The blockchain framework that the network uses. - Framework Framework + // The current status of the network. + Status NetworkStatus } // Configuration properties of a peer node. type Node struct { - // The instance type of the node. - InstanceType *string + // The Availability Zone in which the node exists. + AvailabilityZone *string + + // The date and time that the node was created. + CreationDate *time.Time + + // Attributes of the blockchain framework being used. + FrameworkAttributes *NodeFrameworkAttributes // The unique identifier of the node. Id *string + // The instance type of the node. + InstanceType *string + // LogPublishingConfiguration *NodeLogPublishingConfiguration - // The unique identifier of the network that the node is in. - NetworkId *string - - // Attributes of the blockchain framework being used. - FrameworkAttributes *NodeFrameworkAttributes - // The unique identifier of the member to which the node belongs. MemberId *string - // The Availability Zone in which the node exists. - AvailabilityZone *string - - // The date and time that the node was created. - CreationDate *time.Time + // The unique identifier of the network that the node is in. + NetworkId *string // The status of the node. Status NodeStatus @@ -425,31 +425,31 @@ type NodeConfiguration struct { // that uses Hyperledger Fabric. type NodeFabricAttributes struct { - // The endpoint that identifies the peer node for peer channel-based event - // services. - PeerEventEndpoint *string - // The endpoint that identifies the peer node for all services except peer // channel-based event services. PeerEndpoint *string + + // The endpoint that identifies the peer node for peer channel-based event + // services. + PeerEventEndpoint *string } // Configuration properties for logging events associated with a peer node owned by // a member in a Managed Blockchain network. type NodeFabricLogPublishingConfiguration struct { - // Configuration properties for a peer node log. Peer node logs contain messages - // generated when your client submits transaction proposals to peer nodes, requests - // to join channels, enrolls an admin peer, and lists the chaincode instances on a - // peer node. - PeerLogs *LogConfigurations - // Configuration properties for logging events associated with chaincode execution // on a peer node. Chaincode logs contain the results of instantiating, invoking, // and querying the chaincode. A peer can run multiple instances of chaincode. When // enabled, a log stream is created for all chaincodes, with an individual log // stream for each chaincode. ChaincodeLogs *LogConfigurations + + // Configuration properties for a peer node log. Peer node logs contain messages + // generated when your client submits transaction proposals to peer nodes, requests + // to join channels, enrolls an admin peer, and lists the chaincode instances on a + // peer node. + PeerLogs *LogConfigurations } // Attributes relevant to a peer node on a Managed Blockchain network for the @@ -477,6 +477,9 @@ type NodeSummary struct { // The Availability Zone in which the node exists. AvailabilityZone *string + // The date and time that the node was created. + CreationDate *time.Time + // The unique identifier of the node. Id *string @@ -485,42 +488,20 @@ type NodeSummary struct { // The status of the node. Status NodeStatus - - // The date and time that the node was created. - CreationDate *time.Time } // Properties of a proposal on a Managed Blockchain network. type Proposal struct { - // The current total of NO votes cast on the proposal by members. - NoVoteCount *int32 + // The actions to perform on the network if the proposal is APPROVED. + Actions *ProposalActions // The date and time that the proposal was created. CreationDate *time.Time - // The number of votes remaining to be cast on the proposal by members. In other - // words, the number of members minus the sum of YES votes and NO votes. - OutstandingVoteCount *int32 - - // The unique identifier of the member that created the proposal. - ProposedByMemberId *string - - // The name of the member that created the proposal. - ProposedByMemberName *string - - // The current total of YES votes cast on the proposal by members. - YesVoteCount *int32 - - // The unique identifier of the network for which the proposal is made. - NetworkId *string - // The description of the proposal. Description *string - // The unique identifier of the proposal. - ProposalId *string - // The date and time that the proposal expires. This is the CreationDate plus the // ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After // this date and time, if members have not cast enough votes to determine the @@ -528,8 +509,24 @@ type Proposal struct { // not carried out. ExpirationDate *time.Time - // The actions to perform on the network if the proposal is APPROVED. - Actions *ProposalActions + // The unique identifier of the network for which the proposal is made. + NetworkId *string + + // The current total of NO votes cast on the proposal by members. + NoVoteCount *int32 + + // The number of votes remaining to be cast on the proposal by members. In other + // words, the number of members minus the sum of YES votes and NO votes. + OutstandingVoteCount *int32 + + // The unique identifier of the proposal. + ProposalId *string + + // The unique identifier of the member that created the proposal. + ProposedByMemberId *string + + // The name of the member that created the proposal. + ProposedByMemberName *string // The status of the proposal. Values are as follows: // @@ -555,24 +552,49 @@ type Proposal struct { // status occurs even if only one ProposalAction fails and other actions are // successful. Status ProposalStatus + + // The current total of YES votes cast on the proposal by members. + YesVoteCount *int32 } // The actions to carry out if a proposal is APPROVED. type ProposalActions struct { + // The actions to perform for an APPROVED proposal to invite an AWS account to + // create a member and join the network. + Invitations []*InviteAction + // The actions to perform for an APPROVED proposal to remove a member from the // network, which deletes the member and all associated member resources from the // network. Removals []*RemoveAction - - // The actions to perform for an APPROVED proposal to invite an AWS account to - // create a member and join the network. - Invitations []*InviteAction } // Properties of a proposal. type ProposalSummary struct { + // The date and time that the proposal was created. + CreationDate *time.Time + + // The description of the proposal. + Description *string + + // The date and time that the proposal expires. This is the CreationDate plus the + // ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After + // this date and time, if members have not cast enough votes to determine the + // outcome according to the voting policy, the proposal is EXPIRED and Actions are + // not carried out. + ExpirationDate *time.Time + + // The unique identifier of the proposal. + ProposalId *string + + // The unique identifier of the member that created the proposal. + ProposedByMemberId *string + + // The name of the member that created the proposal. + ProposedByMemberName *string + // The status of the proposal. Values are as follows: // // * IN_PROGRESS - The @@ -595,28 +617,6 @@ type ProposalSummary struct { // ACTION_FAILED - One or more of the specified ProposalActions in a proposal that // was approved could not be completed because of an error. Status ProposalStatus - - // The date and time that the proposal was created. - CreationDate *time.Time - - // The description of the proposal. - Description *string - - // The date and time that the proposal expires. This is the CreationDate plus the - // ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After - // this date and time, if members have not cast enough votes to determine the - // outcome according to the voting policy, the proposal is EXPIRED and Actions are - // not carried out. - ExpirationDate *time.Time - - // The name of the member that created the proposal. - ProposedByMemberName *string - - // The unique identifier of the member that created the proposal. - ProposedByMemberId *string - - // The unique identifier of the proposal. - ProposalId *string } // An action to remove a member from a Managed Blockchain network as the result of @@ -633,14 +633,14 @@ type RemoveAction struct { // Properties of an individual vote that a member cast for a proposal. type VoteSummary struct { + // The unique identifier of the member that cast the vote. + MemberId *string + // The name of the member that cast the vote. MemberName *string // The vote value, either YES or NO. Vote VoteValue - - // The unique identifier of the member that cast the vote. - MemberId *string } // The voting rules for the network to decide if a proposal is accepted diff --git a/service/marketplacecatalog/api_op_CancelChangeSet.go b/service/marketplacecatalog/api_op_CancelChangeSet.go index b58a07954f5..d1172c6b58d 100644 --- a/service/marketplacecatalog/api_op_CancelChangeSet.go +++ b/service/marketplacecatalog/api_op_CancelChangeSet.go @@ -59,26 +59,26 @@ func (c *Client) CancelChangeSet(ctx context.Context, params *CancelChangeSetInp type CancelChangeSetInput struct { - // Required. The unique identifier of the StartChangeSet request that you want to - // cancel. + // Required. The catalog related to the request. Fixed value: AWSMarketplace. // // This member is required. - ChangeSetId *string + Catalog *string - // Required. The catalog related to the request. Fixed value: AWSMarketplace. + // Required. The unique identifier of the StartChangeSet request that you want to + // cancel. // // This member is required. - Catalog *string + ChangeSetId *string } type CancelChangeSetOutput struct { - // The unique identifier for the change set referenced in this request. - ChangeSetId *string - // The ARN associated with the change set referenced in this request. ChangeSetArn *string + // The unique identifier for the change set referenced in this request. + ChangeSetId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/marketplacecatalog/api_op_DescribeChangeSet.go b/service/marketplacecatalog/api_op_DescribeChangeSet.go index 1ae5fc13f9d..1b5d736eda7 100644 --- a/service/marketplacecatalog/api_op_DescribeChangeSet.go +++ b/service/marketplacecatalog/api_op_DescribeChangeSet.go @@ -71,35 +71,35 @@ type DescribeChangeSetInput struct { type DescribeChangeSetOutput struct { - // The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request - // transitioned to a terminal state. The change cannot transition to a different - // state. Null if the request is not in a terminal state. - EndTime *string - - // The optional name provided in the StartChangeSet request. If you do not provide - // a name, one is set by default. - ChangeSetName *string + // An array of ChangeSummary objects. + ChangeSet []*types.ChangeSummary - // The status of the change request. - Status types.ChangeStatus + // The ARN associated with the unique identifier for the change set referenced in + // this request. + ChangeSetArn *string // Required. The unique identifier for the change set referenced in this request. ChangeSetId *string - // The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request - // started. - StartTime *string + // The optional name provided in the StartChangeSet request. If you do not provide + // a name, one is set by default. + ChangeSetName *string - // The ARN associated with the unique identifier for the change set referenced in - // this request. - ChangeSetArn *string + // The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request + // transitioned to a terminal state. The change cannot transition to a different + // state. Null if the request is not in a terminal state. + EndTime *string // Returned if there is a failure on the change set, but that failure is not // related to any of the changes in the request. FailureDescription *string - // An array of ChangeSummary objects. - ChangeSet []*types.ChangeSummary + // The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request + // started. + StartTime *string + + // The status of the change request. + Status types.ChangeStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/marketplacecatalog/api_op_DescribeEntity.go b/service/marketplacecatalog/api_op_DescribeEntity.go index 3a213d1722b..ef41d50cede 100644 --- a/service/marketplacecatalog/api_op_DescribeEntity.go +++ b/service/marketplacecatalog/api_op_DescribeEntity.go @@ -69,15 +69,6 @@ type DescribeEntityInput struct { type DescribeEntityOutput struct { - // The last modified date of the entity, in ISO 8601 format (2018-02-27T13:45:22Z). - LastModifiedDate *string - - // The named type of the entity, in the format of EntityType@Version. - EntityType *string - - // The identifier of the entity, in the format of EntityId@RevisionId. - EntityIdentifier *string - // This stringified JSON object includes the details of the entity. Details *string @@ -85,6 +76,15 @@ type DescribeEntityOutput struct { // this request. EntityArn *string + // The identifier of the entity, in the format of EntityId@RevisionId. + EntityIdentifier *string + + // The named type of the entity, in the format of EntityType@Version. + EntityType *string + + // The last modified date of the entity, in ISO 8601 format (2018-02-27T13:45:22Z). + LastModifiedDate *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/marketplacecatalog/api_op_ListChangeSets.go b/service/marketplacecatalog/api_op_ListChangeSets.go index 0a034c85812..ce52e57ca83 100644 --- a/service/marketplacecatalog/api_op_ListChangeSets.go +++ b/service/marketplacecatalog/api_op_ListChangeSets.go @@ -61,35 +61,35 @@ func (c *Client) ListChangeSets(ctx context.Context, params *ListChangeSetsInput type ListChangeSetsInput struct { - // The token value retrieved from a previous call to access the next page of - // results. - NextToken *string - - // An object that contains two attributes, SortBy and SortOrder. - Sort *types.Sort - - // An array of filter objects. - FilterList []*types.Filter - // The catalog related to the request. Fixed value: AWSMarketplace // // This member is required. Catalog *string + // An array of filter objects. + FilterList []*types.Filter + // The maximum number of results returned by a single call. This value must be // provided in the next call to retrieve the next set of results. By default, this // value is 20. MaxResults *int32 + + // The token value retrieved from a previous call to access the next page of + // results. + NextToken *string + + // An object that contains two attributes, SortBy and SortOrder. + Sort *types.Sort } type ListChangeSetsOutput struct { - // The value of the next token, if it exists. Null if there are no more results. - NextToken *string - // Array of ChangeSetSummaryListItem objects. ChangeSetSummaryList []*types.ChangeSetSummaryListItem + // The value of the next token, if it exists. Null if there are no more results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/marketplacecatalog/api_op_ListEntities.go b/service/marketplacecatalog/api_op_ListEntities.go index 04d0ffdc529..2c233d07d44 100644 --- a/service/marketplacecatalog/api_op_ListEntities.go +++ b/service/marketplacecatalog/api_op_ListEntities.go @@ -57,29 +57,29 @@ func (c *Client) ListEntities(ctx context.Context, params *ListEntitiesInput, op type ListEntitiesInput struct { - // The type of entities to retrieve. + // The catalog related to the request. Fixed value: AWSMarketplace // // This member is required. - EntityType *string + Catalog *string - // The catalog related to the request. Fixed value: AWSMarketplace + // The type of entities to retrieve. // // This member is required. - Catalog *string + EntityType *string - // The value of the next token, if it exists. Null if there are no more results. - NextToken *string + // An array of filter objects. Each filter object contains two attributes, + // filterName and filterValues. + FilterList []*types.Filter // Specifies the upper limit of the elements on a single page. If a value isn't // provided, the default value is 20. MaxResults *int32 + // The value of the next token, if it exists. Null if there are no more results. + NextToken *string + // An object that contains two attributes, SortBy and SortOrder. Sort *types.Sort - - // An array of filter objects. Each filter object contains two attributes, - // filterName and filterValues. - FilterList []*types.Filter } type ListEntitiesOutput struct { diff --git a/service/marketplacecatalog/api_op_StartChangeSet.go b/service/marketplacecatalog/api_op_StartChangeSet.go index 7721d78f133..bbeea68ff83 100644 --- a/service/marketplacecatalog/api_op_StartChangeSet.go +++ b/service/marketplacecatalog/api_op_StartChangeSet.go @@ -68,6 +68,11 @@ func (c *Client) StartChangeSet(ctx context.Context, params *StartChangeSetInput type StartChangeSetInput struct { + // The catalog related to the request. Fixed value: AWSMarketplace + // + // This member is required. + Catalog *string + // Array of change object. // // This member is required. @@ -79,21 +84,16 @@ type StartChangeSetInput struct { // A unique token to identify the request to ensure idempotency. ClientRequestToken *string - - // The catalog related to the request. Fixed value: AWSMarketplace - // - // This member is required. - Catalog *string } type StartChangeSetOutput struct { - // Unique identifier generated for the request. - ChangeSetId *string - // The ARN associated to the unique identifier generated for the request. ChangeSetArn *string + // Unique identifier generated for the request. + ChangeSetId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/marketplacecatalog/go.mod b/service/marketplacecatalog/go.mod index 29f687d6ec4..52bf3361728 100644 --- a/service/marketplacecatalog/go.mod +++ b/service/marketplacecatalog/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/marketplacecatalog go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/marketplacecatalog/types/types.go b/service/marketplacecatalog/types/types.go index d9913bbce78..53a4010b158 100644 --- a/service/marketplacecatalog/types/types.go +++ b/service/marketplacecatalog/types/types.go @@ -5,10 +5,12 @@ package types // An object that contains the ChangeType, Details, and Entity. type Change struct { - // The entity to be changed. + // Change types are single string values that describe your intention for the + // change. Each change type is unique for each EntityType provided in the change's + // scope. // // This member is required. - Entity *Entity + ChangeType *string // This object contains details specific to the change type of the requested // change. @@ -16,24 +18,30 @@ type Change struct { // This member is required. Details *string - // Change types are single string values that describe your intention for the - // change. Each change type is unique for each EntityType provided in the change's - // scope. + // The entity to be changed. // // This member is required. - ChangeType *string + Entity *Entity } // A summary of a change set returned in a list of change sets when the // ListChangeSets action is called. type ChangeSetSummaryListItem struct { + // The ARN associated with the unique identifier for the change set referenced in + // this request. + ChangeSetArn *string + // The unique identifier for a change set. ChangeSetId *string // The non-unique name for the change set. ChangeSetName *string + // The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was + // finished. + EndTime *string + // This object is a list of entity IDs (string) that are a part of a change set. // The entity ID list is a maximum of 20 entities. It must contain at least one // entity. @@ -43,14 +51,6 @@ type ChangeSetSummaryListItem struct { // started. StartTime *string - // The ARN associated with the unique identifier for the change set referenced in - // this request. - ChangeSetArn *string - - // The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was - // finished. - EndTime *string - // The current status of the change set. Status ChangeStatus } @@ -59,6 +59,9 @@ type ChangeSetSummaryListItem struct { // summary doesn't contain the whole change structure. type ChangeSummary struct { + // The type of the change. + ChangeType *string + // This object contains details specific to the change type of the requested // change. Details *string @@ -68,22 +71,19 @@ type ChangeSummary struct { // An array of ErrorDetail objects associated with the change. ErrorDetailList []*ErrorDetail - - // The type of the change. - ChangeType *string } // A product entity contains data that describes your product, its supported // features, and how it can be used or launched by your customer. type Entity struct { - // The identifier for the entity. - Identifier *string - // The type of entity. // // This member is required. Type *string + + // The identifier for the entity. + Identifier *string } // This object is a container for common summary information about the entity. The @@ -91,6 +91,19 @@ type Entity struct { // information common across all entities. type EntitySummary struct { + // The ARN associated with the unique identifier for the entity. + EntityArn *string + + // The unique identifier for the entity. + EntityId *string + + // The type of the entity. + EntityType *string + + // The last time the entity was published, using ISO 8601 format + // (2018-02-27T13:45:22Z). + LastModifiedDate *string + // The name for the entity. This value is not unique. It is defined by the seller. Name *string @@ -99,19 +112,6 @@ type EntitySummary struct { // accounts only), or Restricted (the entity was published and then unpublished and // only existing buyers can view it). Visibility *string - - // The last time the entity was published, using ISO 8601 format - // (2018-02-27T13:45:22Z). - LastModifiedDate *string - - // The ARN associated with the unique identifier for the entity. - EntityArn *string - - // The type of the entity. - EntityType *string - - // The unique identifier for the entity. - EntityId *string } // Details about the error. @@ -128,6 +128,10 @@ type ErrorDetail struct { // ListEntities and ListChangeSets actions. type Filter struct { + // For ListEntities, the supported value for this is an EntityId. For + // ListChangeSets, the supported values are as follows: + Name *string + // ListEntities - This is a list of unique EntityIds.

    // ListChangeSets - The supported filter names and associated // ValueLists is as follows:

    ValueList []*string - - // For ListEntities, the supported value for this is an EntityId. For - // ListChangeSets, the supported values are as follows: - Name *string } // An object that contains two attributes, SortBy and SortOrder. diff --git a/service/marketplacecommerceanalytics/api_op_GenerateDataSet.go b/service/marketplacecommerceanalytics/api_op_GenerateDataSet.go index 95b1bd28735..aedb0118779 100644 --- a/service/marketplacecommerceanalytics/api_op_GenerateDataSet.go +++ b/service/marketplacecommerceanalytics/api_op_GenerateDataSet.go @@ -68,17 +68,6 @@ func (c *Client) GenerateDataSet(ctx context.Context, params *GenerateDataSetInp // Container for the parameters to the GenerateDataSet operation. type GenerateDataSetInput struct { - // Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data - // set has been published or if an error has occurred. - // - // This member is required. - SnsTopicArn *string - - // (Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS - // notification message and the data set metadata file. These key-value pairs can - // be used to correlated responses with tracking information from other systems. - CustomerDefinedValues map[string]*string - // The date a data set was published. For daily data sets, provide a date with // day-level granularity for the desired day. For monthly data sets except those // with prefix disbursed_amount, provide a date with month-level granularity for @@ -90,19 +79,6 @@ type GenerateDataSetInput struct { // This member is required. DataSetPublicationDate *time.Time - // (Optional) The desired S3 prefix for the published data set, similar to a - // directory path in standard file systems. For example, if given the bucket name - // "mybucket" and the prefix "myprefix/mydatasets", the output file "outputfile" - // would be published to "s3://mybucket/myprefix/mydatasets/outputfile". If the - // prefix directory structure does not exist, it will be created. If no prefix is - // provided, the data set will be published to the S3 bucket root. - DestinationS3Prefix *string - - // The name (friendly name, not ARN) of the destination S3 bucket. - // - // This member is required. - DestinationS3BucketName *string - // The desired data set type. // // * @@ -187,11 +163,35 @@ type GenerateDataSetInput struct { // This member is required. DataSetType types.DataSetType + // The name (friendly name, not ARN) of the destination S3 bucket. + // + // This member is required. + DestinationS3BucketName *string + // The Amazon Resource Name (ARN) of the Role with an attached permissions policy // to interact with the provided AWS services. // // This member is required. RoleNameArn *string + + // Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data + // set has been published or if an error has occurred. + // + // This member is required. + SnsTopicArn *string + + // (Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS + // notification message and the data set metadata file. These key-value pairs can + // be used to correlated responses with tracking information from other systems. + CustomerDefinedValues map[string]*string + + // (Optional) The desired S3 prefix for the published data set, similar to a + // directory path in standard file systems. For example, if given the bucket name + // "mybucket" and the prefix "myprefix/mydatasets", the output file "outputfile" + // would be published to "s3://mybucket/myprefix/mydatasets/outputfile". If the + // prefix directory structure does not exist, it will be created. If no prefix is + // provided, the data set will be published to the S3 bucket root. + DestinationS3Prefix *string } // Container for the result of the GenerateDataSet operation. diff --git a/service/marketplacecommerceanalytics/api_op_StartSupportDataExport.go b/service/marketplacecommerceanalytics/api_op_StartSupportDataExport.go index 2828683ce7d..226d0ff25f3 100644 --- a/service/marketplacecommerceanalytics/api_op_StartSupportDataExport.go +++ b/service/marketplacecommerceanalytics/api_op_StartSupportDataExport.go @@ -69,18 +69,6 @@ func (c *Client) StartSupportDataExport(ctx context.Context, params *StartSuppor // Container for the parameters to the StartSupportDataExport operation. type StartSupportDataExportInput struct { - // The start date from which to retrieve the data set in UTC. This parameter only - // affects the customer_support_contacts_data data set type. - // - // This member is required. - FromDate *time.Time - - // Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data - // set has been published or if an error has occurred. - // - // This member is required. - SnsTopicArn *string - // Specifies the data set type to be written to the output csv file. The data set // types customer_support_contacts_data and test_customer_support_contacts_data // both result in a csv file containing the following fields: Product Id, Product @@ -100,6 +88,29 @@ type StartSupportDataExportInput struct { // This member is required. DataSetType types.SupportDataSetType + // The name (friendly name, not ARN) of the destination S3 bucket. + // + // This member is required. + DestinationS3BucketName *string + + // The start date from which to retrieve the data set in UTC. This parameter only + // affects the customer_support_contacts_data data set type. + // + // This member is required. + FromDate *time.Time + + // The Amazon Resource Name (ARN) of the Role with an attached permissions policy + // to interact with the provided AWS services. + // + // This member is required. + RoleNameArn *string + + // Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data + // set has been published or if an error has occurred. + // + // This member is required. + SnsTopicArn *string + // (Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS // notification message and the data set metadata file. CustomerDefinedValues map[string]*string @@ -111,17 +122,6 @@ type StartSupportDataExportInput struct { // prefix directory structure does not exist, it will be created. If no prefix is // provided, the data set will be published to the S3 bucket root. DestinationS3Prefix *string - - // The name (friendly name, not ARN) of the destination S3 bucket. - // - // This member is required. - DestinationS3BucketName *string - - // The Amazon Resource Name (ARN) of the Role with an attached permissions policy - // to interact with the provided AWS services. - // - // This member is required. - RoleNameArn *string } // Container for the result of the StartSupportDataExport operation. diff --git a/service/marketplacecommerceanalytics/go.mod b/service/marketplacecommerceanalytics/go.mod index dbc3a15477c..4c2b6fdf7f7 100644 --- a/service/marketplacecommerceanalytics/go.mod +++ b/service/marketplacecommerceanalytics/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/marketplacecommerceanalytics go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/marketplaceentitlementservice/api_op_GetEntitlements.go b/service/marketplaceentitlementservice/api_op_GetEntitlements.go index 688166f4911..f94f5769b10 100644 --- a/service/marketplaceentitlementservice/api_op_GetEntitlements.go +++ b/service/marketplaceentitlementservice/api_op_GetEntitlements.go @@ -60,13 +60,12 @@ func (c *Client) GetEntitlements(ctx context.Context, params *GetEntitlementsInp // operation. type GetEntitlementsInput struct { - // The maximum number of items to retrieve from the GetEntitlements operation. For - // pagination, use the NextToken field in subsequent calls to GetEntitlements. - MaxResults *int32 - - // For paginated calls to GetEntitlements, pass the NextToken from the previous - // GetEntitlementsResult. - NextToken *string + // Product code is used to uniquely identify a product in AWS Marketplace. The + // product code will be provided by AWS Marketplace when the product listing is + // created. + // + // This member is required. + ProductCode *string // Filter is used to return entitlements for a specific customer or for a specific // dimension. Filters are described as keys mapped to a lists of values. Filtered @@ -74,12 +73,13 @@ type GetEntitlementsInput struct { // each filter key. Filter map[string][]*string - // Product code is used to uniquely identify a product in AWS Marketplace. The - // product code will be provided by AWS Marketplace when the product listing is - // created. - // - // This member is required. - ProductCode *string + // The maximum number of items to retrieve from the GetEntitlements operation. For + // pagination, use the NextToken field in subsequent calls to GetEntitlements. + MaxResults *int32 + + // For paginated calls to GetEntitlements, pass the NextToken from the previous + // GetEntitlementsResult. + NextToken *string } // The GetEntitlementsRequest contains results from the GetEntitlements operation. diff --git a/service/marketplaceentitlementservice/go.mod b/service/marketplaceentitlementservice/go.mod index e4c28b8ee42..7bcfe95473d 100644 --- a/service/marketplaceentitlementservice/go.mod +++ b/service/marketplaceentitlementservice/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/marketplaceentitlementservice go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/marketplaceentitlementservice/types/types.go b/service/marketplaceentitlementservice/types/types.go index 4c08f6c7f89..6ac1a3ecfd0 100644 --- a/service/marketplaceentitlementservice/types/types.go +++ b/service/marketplaceentitlementservice/types/types.go @@ -11,19 +11,15 @@ import ( // application or some amount of data capacity in a multi-tenant database. type Entitlement struct { - // The dimension for which the given entitlement applies. Dimensions represent - // categories of capacity in a product and are specified when the product is listed - // in AWS Marketplace. - Dimension *string - // The customer identifier is a handle to each unique customer in an application. // Customer identifiers are obtained through the ResolveCustomer operation in AWS // Marketplace Metering Service. CustomerIdentifier *string - // The product code for which the given entitlement applies. Product codes are - // provided by AWS Marketplace when the product listing is created. - ProductCode *string + // The dimension for which the given entitlement applies. Dimensions represent + // categories of capacity in a product and are specified when the product is listed + // in AWS Marketplace. + Dimension *string // The expiration date represents the minimum date through which this entitlement // is expected to remain valid. For contractual products listed on AWS Marketplace, @@ -32,6 +28,10 @@ type Entitlement struct { // entitlements with an expiration date. ExpirationDate *time.Time + // The product code for which the given entitlement applies. Product codes are + // provided by AWS Marketplace when the product listing is created. + ProductCode *string + // The EntitlementValue represents the amount of capacity that the customer is // entitled to for the product. Value *EntitlementValue @@ -41,14 +41,14 @@ type Entitlement struct { // entitled to for the product. type EntitlementValue struct { - // The DoubleValue field will be populated with a double value when the entitlement - // is a double type. Otherwise, the field will not be set. - DoubleValue *float64 - // The BooleanValue field will be populated with a boolean value when the // entitlement is a boolean type. Otherwise, the field will not be set. BooleanValue *bool + // The DoubleValue field will be populated with a double value when the entitlement + // is a double type. Otherwise, the field will not be set. + DoubleValue *float64 + // The IntegerValue field will be populated with an integer value when the // entitlement is an integer type. Otherwise, the field will not be set. IntegerValue *int32 diff --git a/service/marketplacemetering/api_op_MeterUsage.go b/service/marketplacemetering/api_op_MeterUsage.go index f58182530b4..139d04203dc 100644 --- a/service/marketplacemetering/api_op_MeterUsage.go +++ b/service/marketplacemetering/api_op_MeterUsage.go @@ -60,6 +60,13 @@ func (c *Client) MeterUsage(ctx context.Context, params *MeterUsageInput, optFns type MeterUsageInput struct { + // Product code is used to uniquely identify a product in AWS Marketplace. The + // product code should be the same as the one used during the publishing of a new + // product. + // + // This member is required. + ProductCode *string + // Timestamp, in UTC, for which the usage is being reported. Your application can // meter usage for up to one hour in the past. Make sure the timestamp value is not // before the start of the software usage. @@ -67,27 +74,20 @@ type MeterUsageInput struct { // This member is required. Timestamp *time.Time + // It will be one of the fcp dimension name provided during the publishing of the + // product. + // + // This member is required. + UsageDimension *string + // Checks whether you have the permissions required for the action, but does not // make the request. If you have the permissions, the request returns // DryRunOperation; otherwise, it returns UnauthorizedException. Defaults to false // if not specified. DryRun *bool - // Product code is used to uniquely identify a product in AWS Marketplace. The - // product code should be the same as the one used during the publishing of a new - // product. - // - // This member is required. - ProductCode *string - // Consumption value for the hour. Defaults to 0 if not specified. UsageQuantity *int32 - - // It will be one of the fcp dimension name provided during the publishing of the - // product. - // - // This member is required. - UsageDimension *string } type MeterUsageOutput struct { diff --git a/service/marketplacemetering/api_op_RegisterUsage.go b/service/marketplacemetering/api_op_RegisterUsage.go index 551cb382bb7..b0ed8ec0826 100644 --- a/service/marketplacemetering/api_op_RegisterUsage.go +++ b/service/marketplacemetering/api_op_RegisterUsage.go @@ -92,14 +92,14 @@ type RegisterUsageInput struct { // This member is required. ProductCode *string - // (Optional) To scope down the registration to a specific running software - // instance and guard against replay attacks. - Nonce *string - // Public Key Version provided by AWS Marketplace // // This member is required. PublicKeyVersion *int32 + + // (Optional) To scope down the registration to a specific running software + // instance and guard against replay attacks. + Nonce *string } type RegisterUsageOutput struct { diff --git a/service/marketplacemetering/api_op_ResolveCustomer.go b/service/marketplacemetering/api_op_ResolveCustomer.go index b52db915f88..3d82cd89115 100644 --- a/service/marketplacemetering/api_op_ResolveCustomer.go +++ b/service/marketplacemetering/api_op_ResolveCustomer.go @@ -72,16 +72,16 @@ type ResolveCustomerInput struct { // product code. type ResolveCustomerOutput struct { - // The product code is returned to confirm that the buyer is registering for your - // product. Subsequent BatchMeterUsage calls should be made using this product - // code. - ProductCode *string - // The CustomerIdentifier is used to identify an individual customer in your // application. Calls to BatchMeterUsage require CustomerIdentifiers for each // UsageRecord. CustomerIdentifier *string + // The product code is returned to confirm that the buyer is registering for your + // product. Subsequent BatchMeterUsage calls should be made using this product + // code. + ProductCode *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/marketplacemetering/go.mod b/service/marketplacemetering/go.mod index e9ee87a30a7..81d12ecbaae 100644 --- a/service/marketplacemetering/go.mod +++ b/service/marketplacemetering/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/marketplacemetering go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/marketplacemetering/types/types.go b/service/marketplacemetering/types/types.go index 811b196e40c..d5b701ffb71 100644 --- a/service/marketplacemetering/types/types.go +++ b/service/marketplacemetering/types/types.go @@ -11,16 +11,11 @@ import ( // be deduplicated to prevent double charges. type UsageRecord struct { - // Timestamp, in UTC, for which the usage is being reported. Your application can - // meter usage for up to one hour in the past. Make sure the timestamp value is not - // before the start of the software usage. + // The CustomerIdentifier is obtained through the ResolveCustomer operation and + // represents an individual buyer in your application. // // This member is required. - Timestamp *time.Time - - // The quantity of usage consumed by the customer for the given dimension and time. - // Defaults to 0 if not specified. - Quantity *int32 + CustomerIdentifier *string // During the process of registering a product on AWS Marketplace, up to eight // dimensions are specified. These represent different units of value in your @@ -29,11 +24,16 @@ type UsageRecord struct { // This member is required. Dimension *string - // The CustomerIdentifier is obtained through the ResolveCustomer operation and - // represents an individual buyer in your application. + // Timestamp, in UTC, for which the usage is being reported. Your application can + // meter usage for up to one hour in the past. Make sure the timestamp value is not + // before the start of the software usage. // // This member is required. - CustomerIdentifier *string + Timestamp *time.Time + + // The quantity of usage consumed by the customer for the given dimension and time. + // Defaults to 0 if not specified. + Quantity *int32 } // A UsageRecordResult indicates the status of a given UsageRecord processed by diff --git a/service/mediaconnect/api_op_AddFlowSources.go b/service/mediaconnect/api_op_AddFlowSources.go index 768b644380a..4c586f814b1 100644 --- a/service/mediaconnect/api_op_AddFlowSources.go +++ b/service/mediaconnect/api_op_AddFlowSources.go @@ -58,15 +58,15 @@ func (c *Client) AddFlowSources(ctx context.Context, params *AddFlowSourcesInput // A request to add sources to the flow. type AddFlowSourcesInput struct { - // A list of sources that you want to add. + // The flow that you want to mutate. // // This member is required. - Sources []*types.SetSourceRequest + FlowArn *string - // The flow that you want to mutate. + // A list of sources that you want to add. // // This member is required. - FlowArn *string + Sources []*types.SetSourceRequest } type AddFlowSourcesOutput struct { diff --git a/service/mediaconnect/api_op_AddFlowVpcInterfaces.go b/service/mediaconnect/api_op_AddFlowVpcInterfaces.go index 196556b1b52..d12334e5f90 100644 --- a/service/mediaconnect/api_op_AddFlowVpcInterfaces.go +++ b/service/mediaconnect/api_op_AddFlowVpcInterfaces.go @@ -71,12 +71,12 @@ type AddFlowVpcInterfacesInput struct { type AddFlowVpcInterfacesOutput struct { - // The details of the newly added VPC interfaces. - VpcInterfaces []*types.VpcInterface - // The ARN of the flow that these VPC interfaces were added to. FlowArn *string + // The details of the newly added VPC interfaces. + VpcInterfaces []*types.VpcInterface + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mediaconnect/api_op_CreateFlow.go b/service/mediaconnect/api_op_CreateFlow.go index d65cbf1059f..bd28c6e680e 100644 --- a/service/mediaconnect/api_op_CreateFlow.go +++ b/service/mediaconnect/api_op_CreateFlow.go @@ -60,31 +60,31 @@ func (c *Client) CreateFlow(ctx context.Context, params *CreateFlowInput, optFns // can include outputs (up to 50) and entitlements (up to 50). type CreateFlowInput struct { - // The VPC interfaces you want on the flow. - VpcInterfaces []*types.VpcInterfaceRequest + // The name of the flow. + // + // This member is required. + Name *string // The Availability Zone that you want to create the flow in. These options are // limited to the Availability Zones within the current AWS Region. AvailabilityZone *string - // The settings for source failover - SourceFailoverConfig *types.FailoverConfig - // The entitlements that you want to grant on a flow. Entitlements []*types.GrantEntitlementRequest - Sources []*types.SetSourceRequest - // The outputs that you want to add to this flow. Outputs []*types.AddOutputRequest - // The name of the flow. - // - // This member is required. - Name *string - // The settings for the source of the flow. Source *types.SetSourceRequest + + // The settings for source failover + SourceFailoverConfig *types.FailoverConfig + + Sources []*types.SetSourceRequest + + // The VPC interfaces you want on the flow. + VpcInterfaces []*types.VpcInterfaceRequest } type CreateFlowOutput struct { diff --git a/service/mediaconnect/api_op_DescribeFlow.go b/service/mediaconnect/api_op_DescribeFlow.go index b622f6994c8..d896e13569e 100644 --- a/service/mediaconnect/api_op_DescribeFlow.go +++ b/service/mediaconnect/api_op_DescribeFlow.go @@ -67,12 +67,12 @@ type DescribeFlowInput struct { type DescribeFlowOutput struct { - // Messages that provide the state of the flow. - Messages *types.Messages - // The settings for a flow, including its source, outputs, and entitlements. Flow *types.Flow + // Messages that provide the state of the flow. + Messages *types.Messages + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mediaconnect/api_op_ListFlows.go b/service/mediaconnect/api_op_ListFlows.go index 5d2d696c38d..16898a90813 100644 --- a/service/mediaconnect/api_op_ListFlows.go +++ b/service/mediaconnect/api_op_ListFlows.go @@ -57,13 +57,6 @@ func (c *Client) ListFlows(ctx context.Context, params *ListFlowsInput, optFns . type ListFlowsInput struct { - // The token that identifies which batch of results that you want to see. For - // example, you submit a ListFlows request with MaxResults set at 5. The service - // returns the first batch of results (up to 5) and a NextToken value. To see the - // next batch of results, you can submit the ListFlows request a second time and - // specify the NextToken value. - NextToken *string - // The maximum number of results to return per API request. For example, you submit // a ListFlows request with MaxResults set at 5. Although 20 items match your // request, the service returns no more than the first 5 items. (The service also @@ -72,6 +65,13 @@ type ListFlowsInput struct { // is not included in the request, the service defaults to pagination with a // maximum of 10 results per page. MaxResults *int32 + + // The token that identifies which batch of results that you want to see. For + // example, you submit a ListFlows request with MaxResults set at 5. The service + // returns the first batch of results (up to 5) and a NextToken value. To see the + // next batch of results, you can submit the ListFlows request a second time and + // specify the NextToken value. + NextToken *string } type ListFlowsOutput struct { diff --git a/service/mediaconnect/api_op_RemoveFlowVpcInterface.go b/service/mediaconnect/api_op_RemoveFlowVpcInterface.go index 7910500cb13..1e6e04ced4c 100644 --- a/service/mediaconnect/api_op_RemoveFlowVpcInterface.go +++ b/service/mediaconnect/api_op_RemoveFlowVpcInterface.go @@ -75,13 +75,13 @@ type RemoveFlowVpcInterfaceOutput struct { // The ARN of the flow that is associated with the VPC interface you removed. FlowArn *string - // The name of the VPC interface that was removed. - VpcInterfaceName *string - // IDs of network interfaces associated with the removed VPC interface that Media // Connect was unable to remove. NonDeletedNetworkInterfaceIds []*string + // The name of the VPC interface that was removed. + VpcInterfaceName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mediaconnect/api_op_RevokeFlowEntitlement.go b/service/mediaconnect/api_op_RevokeFlowEntitlement.go index 20796db744d..16a876ef832 100644 --- a/service/mediaconnect/api_op_RevokeFlowEntitlement.go +++ b/service/mediaconnect/api_op_RevokeFlowEntitlement.go @@ -70,12 +70,12 @@ type RevokeFlowEntitlementInput struct { type RevokeFlowEntitlementOutput struct { - // The ARN of the flow that the entitlement was revoked from. - FlowArn *string - // The ARN of the entitlement that was revoked. EntitlementArn *string + // The ARN of the flow that the entitlement was revoked from. + FlowArn *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mediaconnect/api_op_TagResource.go b/service/mediaconnect/api_op_TagResource.go index ac77322a78f..a4f6f64036d 100644 --- a/service/mediaconnect/api_op_TagResource.go +++ b/service/mediaconnect/api_op_TagResource.go @@ -62,17 +62,17 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF // maximum length of 256 characters. type TagResourceInput struct { - // A map from tag keys to values. Tag keys can have a maximum character length of - // 128 characters, and tag values can have a maximum length of 256 characters. - // - // This member is required. - Tags map[string]*string - // The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect // resource to which to add tags. // // This member is required. ResourceArn *string + + // A map from tag keys to values. Tag keys can have a maximum character length of + // 128 characters, and tag values can have a maximum length of 256 characters. + // + // This member is required. + Tags map[string]*string } type TagResourceOutput struct { diff --git a/service/mediaconnect/api_op_UpdateFlow.go b/service/mediaconnect/api_op_UpdateFlow.go index b42458b444e..841016800a1 100644 --- a/service/mediaconnect/api_op_UpdateFlow.go +++ b/service/mediaconnect/api_op_UpdateFlow.go @@ -58,13 +58,13 @@ func (c *Client) UpdateFlow(ctx context.Context, params *UpdateFlowInput, optFns // A request to update flow. type UpdateFlowInput struct { - // The settings for source failover - SourceFailoverConfig *types.UpdateFailoverConfig - // The flow that you want to update. // // This member is required. FlowArn *string + + // The settings for source failover + SourceFailoverConfig *types.UpdateFailoverConfig } type UpdateFlowOutput struct { diff --git a/service/mediaconnect/api_op_UpdateFlowEntitlement.go b/service/mediaconnect/api_op_UpdateFlowEntitlement.go index eb1e9e1984b..1aa9e829edb 100644 --- a/service/mediaconnect/api_op_UpdateFlowEntitlement.go +++ b/service/mediaconnect/api_op_UpdateFlowEntitlement.go @@ -60,30 +60,30 @@ func (c *Client) UpdateFlowEntitlement(ctx context.Context, params *UpdateFlowEn // The entitlement fields that you want to update. type UpdateFlowEntitlementInput struct { - // An indication of whether you want to enable the entitlement to allow access, or - // disable it to stop streaming content to the subscriber’s flow temporarily. If - // you don’t specify the entitlementStatus field in your request, MediaConnect - // leaves the value unchanged. - EntitlementStatus types.EntitlementStatus + // The ARN of the entitlement that you want to update. + // + // This member is required. + EntitlementArn *string - // The type of encryption that will be used on the output associated with this - // entitlement. - Encryption *types.UpdateEncryption + // The flow that is associated with the entitlement that you want to update. + // + // This member is required. + FlowArn *string // A description of the entitlement. This description appears only on the AWS // Elemental MediaConnect console and will not be seen by the subscriber or end // user. Description *string - // The flow that is associated with the entitlement that you want to update. - // - // This member is required. - FlowArn *string + // The type of encryption that will be used on the output associated with this + // entitlement. + Encryption *types.UpdateEncryption - // The ARN of the entitlement that you want to update. - // - // This member is required. - EntitlementArn *string + // An indication of whether you want to enable the entitlement to allow access, or + // disable it to stop streaming content to the subscriber’s flow temporarily. If + // you don’t specify the entitlementStatus field in your request, MediaConnect + // leaves the value unchanged. + EntitlementStatus types.EntitlementStatus // The AWS account IDs that you want to share your content with. The receiving // accounts (subscribers) will be allowed to create their own flow using your diff --git a/service/mediaconnect/api_op_UpdateFlowOutput.go b/service/mediaconnect/api_op_UpdateFlowOutput.go index 2755e4fd6e3..837886c1735 100644 --- a/service/mediaconnect/api_op_UpdateFlowOutput.go +++ b/service/mediaconnect/api_op_UpdateFlowOutput.go @@ -58,46 +58,43 @@ func (c *Client) UpdateFlowOutput(ctx context.Context, params *UpdateFlowOutputI // The fields that you want to update in the output. type UpdateFlowOutputInput struct { + // The flow that is associated with the output that you want to update. + // + // This member is required. + FlowArn *string + + // The ARN of the output that you want to update. + // + // This member is required. + OutputArn *string + // The range of IP addresses that should be allowed to initiate output requests to // this flow. These IP addresses should be in the form of a Classless Inter-Domain // Routing (CIDR) block; for example, 10.0.0.0/16. CidrAllowList []*string - // The IP address where you want to send the output. - Destination *string - // A description of the output. This description appears only on the AWS Elemental // MediaConnect console and will not be seen by the end user. Description *string - // The ARN of the output that you want to update. - // - // This member is required. - OutputArn *string + // The IP address where you want to send the output. + Destination *string // The type of key used for the encryption. If no keyType is provided, the service // will use the default setting (static-key). Encryption *types.UpdateEncryption - // The port to use when content is distributed to this output. - Port *int32 - - // The flow that is associated with the output that you want to update. - // - // This member is required. - FlowArn *string - - // The remote ID for the Zixi-pull stream. - RemoteId *string - // The maximum latency in milliseconds for Zixi-based streams. MaxLatency *int32 + // The port to use when content is distributed to this output. + Port *int32 + // The protocol to use for the output. Protocol types.Protocol - // The name of the VPC interface attachment to use for this output. - VpcInterfaceAttachment *types.VpcInterfaceAttachment + // The remote ID for the Zixi-pull stream. + RemoteId *string // The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams. SmoothingLatency *int32 @@ -105,16 +102,19 @@ type UpdateFlowOutputInput struct { // The stream ID that you want to use for this transport. This parameter applies // only to Zixi-based streams. StreamId *string + + // The name of the VPC interface attachment to use for this output. + VpcInterfaceAttachment *types.VpcInterfaceAttachment } type UpdateFlowOutputOutput struct { - // The settings for an output. - Output *types.Output - // The ARN of the flow that is associated with the updated output. FlowArn *string + // The settings for an output. + Output *types.Output + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mediaconnect/api_op_UpdateFlowSource.go b/service/mediaconnect/api_op_UpdateFlowSource.go index d0f5b23e3d5..9db8eceabef 100644 --- a/service/mediaconnect/api_op_UpdateFlowSource.go +++ b/service/mediaconnect/api_op_UpdateFlowSource.go @@ -58,15 +58,10 @@ func (c *Client) UpdateFlowSource(ctx context.Context, params *UpdateFlowSourceI // A request to update the source of a flow. type UpdateFlowSourceInput struct { - // The name of the VPC Interface to configure this Source with. - VpcInterfaceName *string - - // A description for the source. This value is not used or seen outside of the - // current AWS Elemental MediaConnect account. - Description *string - - // The smoothing max bitrate for RIST, RTP, and RTP-FEC streams. - MaxBitrate *int32 + // The flow that is associated with the source that you want to update. + // + // This member is required. + FlowArn *string // The ARN of the source that you want to update. // @@ -76,34 +71,39 @@ type UpdateFlowSourceInput struct { // The type of encryption used on the content ingested from this source. Decryption *types.UpdateEncryption - // The stream ID that you want to use for this transport. This parameter applies - // only to Zixi-based streams. - StreamId *string - - // The protocol that is used by the source. - Protocol types.Protocol + // A description for the source. This value is not used or seen outside of the + // current AWS Elemental MediaConnect account. + Description *string // The ARN of the entitlement that allows you to subscribe to this flow. The // entitlement is set by the flow originator, and the ARN is generated as part of // the originator's flow. EntitlementArn *string + // The port that the flow will be listening on for incoming content. + IngestPort *int32 + + // The smoothing max bitrate for RIST, RTP, and RTP-FEC streams. + MaxBitrate *int32 + // The maximum latency in milliseconds. This parameter applies only to RIST-based // and Zixi-based streams. MaxLatency *int32 + // The protocol that is used by the source. + Protocol types.Protocol + + // The stream ID that you want to use for this transport. This parameter applies + // only to Zixi-based streams. + StreamId *string + + // The name of the VPC Interface to configure this Source with. + VpcInterfaceName *string + // The range of IP addresses that should be allowed to contribute content to your // source. These IP addresses should be in the form of a Classless Inter-Domain // Routing (CIDR) block; for example, 10.0.0.0/16. WhitelistCidr *string - - // The port that the flow will be listening on for incoming content. - IngestPort *int32 - - // The flow that is associated with the source that you want to update. - // - // This member is required. - FlowArn *string } type UpdateFlowSourceOutput struct { diff --git a/service/mediaconnect/go.mod b/service/mediaconnect/go.mod index bc76476bd5c..4e43a4732db 100644 --- a/service/mediaconnect/go.mod +++ b/service/mediaconnect/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/mediaconnect go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/mediaconnect/types/types.go b/service/mediaconnect/types/types.go index 601725e606c..b62af67c993 100644 --- a/service/mediaconnect/types/types.go +++ b/service/mediaconnect/types/types.go @@ -5,16 +5,35 @@ package types // The output that you want to add to this flow. type AddOutputRequest struct { + // The protocol to use for the output. + // + // This member is required. + Protocol Protocol + + // The range of IP addresses that should be allowed to initiate output requests to + // this flow. These IP addresses should be in the form of a Classless Inter-Domain + // Routing (CIDR) block; for example, 10.0.0.0/16. + CidrAllowList []*string + // A description of the output. This description appears only on the AWS Elemental // MediaConnect console and will not be seen by the end user. Description *string + // The IP address from which video will be sent to output destinations. + Destination *string + // The type of key used for the encryption. If no keyType is provided, the service // will use the default setting (static-key). Encryption *Encryption - // The name of the VPC interface attachment to use for this output. - VpcInterfaceAttachment *VpcInterfaceAttachment + // The maximum latency in milliseconds for Zixi-based streams. + MaxLatency *int32 + + // The name of the output. This value must be unique within the current flow. + Name *string + + // The port to use when content is distributed to this output. + Port *int32 // The remote ID for the Zixi-pull output stream. RemoteId *string @@ -26,73 +45,54 @@ type AddOutputRequest struct { // only to Zixi-based streams. StreamId *string - // The port to use when content is distributed to this output. - Port *int32 - - // The protocol to use for the output. - // - // This member is required. - Protocol Protocol - - // The IP address from which video will be sent to output destinations. - Destination *string - - // The name of the output. This value must be unique within the current flow. - Name *string - - // The maximum latency in milliseconds for Zixi-based streams. - MaxLatency *int32 - - // The range of IP addresses that should be allowed to initiate output requests to - // this flow. These IP addresses should be in the form of a Classless Inter-Domain - // Routing (CIDR) block; for example, 10.0.0.0/16. - CidrAllowList []*string + // The name of the VPC interface attachment to use for this output. + VpcInterfaceAttachment *VpcInterfaceAttachment } // Information about the encryption of the flow. type Encryption struct { - // The ARN of the secret that you created in AWS Secrets Manager to store the - // encryption key. This parameter is required for static key encryption and is not - // valid for SPEKE encryption. - SecretArn *string + // The type of algorithm that is used for the encryption (such as aes128, aes192, + // or aes256). + // + // This member is required. + Algorithm Algorithm - // The type of key that is used for the encryption. If no keyType is provided, the - // service will use the default setting (static-key). - KeyType KeyType + // The ARN of the role that you created during setup (when you set up AWS Elemental + // MediaConnect as a trusted entity). + // + // This member is required. + RoleArn *string - // An identifier for the content. The service sends this value to the key server to - // identify the current endpoint. The resource ID is also known as the content ID. - // This parameter is required for SPEKE encryption and is not valid for static key + // A 128-bit, 16-byte hex value represented by a 32-character string, to be used + // with the key for encrypting content. This parameter is not valid for static key // encryption. - ResourceId *string + ConstantInitializationVector *string // The value of one of the devices that you configured with your digital rights // management (DRM) platform key provider. This parameter is required for SPEKE // encryption and is not valid for static key encryption. DeviceId *string + // The type of key that is used for the encryption. If no keyType is provided, the + // service will use the default setting (static-key). + KeyType KeyType + // The AWS Region that the API Gateway proxy endpoint was created in. This // parameter is required for SPEKE encryption and is not valid for static key // encryption. Region *string - // A 128-bit, 16-byte hex value represented by a 32-character string, to be used - // with the key for encrypting content. This parameter is not valid for static key + // An identifier for the content. The service sends this value to the key server to + // identify the current endpoint. The resource ID is also known as the content ID. + // This parameter is required for SPEKE encryption and is not valid for static key // encryption. - ConstantInitializationVector *string - - // The type of algorithm that is used for the encryption (such as aes128, aes192, - // or aes256). - // - // This member is required. - Algorithm Algorithm + ResourceId *string - // The ARN of the role that you created during setup (when you set up AWS Elemental - // MediaConnect as a trusted entity). - // - // This member is required. - RoleArn *string + // The ARN of the secret that you created in AWS Secrets Manager to store the + // encryption key. This parameter is required for static key encryption and is not + // valid for SPEKE encryption. + SecretArn *string // The URL from the API Gateway proxy that you set up to talk to your key server. // This parameter is required for SPEKE encryption and is not valid for static key @@ -103,14 +103,16 @@ type Encryption struct { // The settings for a flow entitlement. type Entitlement struct { - // An indication of whether the entitlement is enabled. - EntitlementStatus EntitlementStatus - // The ARN of the entitlement. // // This member is required. EntitlementArn *string + // The name of the entitlement. + // + // This member is required. + Name *string + // The AWS account IDs that you want to share your content with. The receiving // accounts (subscribers) will be allowed to create their own flow using your // content as the source. @@ -118,95 +120,94 @@ type Entitlement struct { // This member is required. Subscribers []*string - // The name of the entitlement. - // - // This member is required. - Name *string + // Percentage from 0-100 of the data transfer cost to be billed to the subscriber. + DataTransferSubscriberFeePercent *int32 + + // A description of the entitlement. + Description *string // The type of encryption that will be used on the output that is associated with // this entitlement. Encryption *Encryption - // A description of the entitlement. - Description *string - - // Percentage from 0-100 of the data transfer cost to be billed to the subscriber. - DataTransferSubscriberFeePercent *int32 + // An indication of whether the entitlement is enabled. + EntitlementStatus EntitlementStatus } // The settings for source failover type FailoverConfig struct { - State State // Search window time to look for dash-7 packets RecoveryWindow *int32 + + State State } // The settings for a flow, including its source, outputs, and entitlements. type Flow struct { - // The settings for the source of the flow. - // - // This member is required. - Source *Source - - // The name of the flow. + // The Availability Zone that you want to create the flow in. These options are + // limited to the Availability Zones within the current AWS. // // This member is required. - Name *string + AvailabilityZone *string // The entitlements in this flow. // // This member is required. Entitlements []*Entitlement - Sources []*Source - - // The VPC Interfaces for this flow. - VpcInterfaces []*VpcInterface - - // The IP address from which video will be sent to output destinations. - EgressIp *string - - // The settings for source failover - SourceFailoverConfig *FailoverConfig - - // The outputs in this flow. + // The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the + // flow. // // This member is required. - Outputs []*Output + FlowArn *string - // A description of the flow. This value is not used or seen outside of the current - // AWS Elemental MediaConnect account. - Description *string + // The name of the flow. + // + // This member is required. + Name *string - // The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the - // flow. + // The outputs in this flow. // // This member is required. - FlowArn *string + Outputs []*Output - // The Availability Zone that you want to create the flow in. These options are - // limited to the Availability Zones within the current AWS. + // The settings for the source of the flow. // // This member is required. - AvailabilityZone *string + Source *Source // The current status of the flow. // // This member is required. Status Status + + // A description of the flow. This value is not used or seen outside of the current + // AWS Elemental MediaConnect account. + Description *string + + // The IP address from which video will be sent to output destinations. + EgressIp *string + + // The settings for source failover + SourceFailoverConfig *FailoverConfig + + Sources []*Source + + // The VPC Interfaces for this flow. + VpcInterfaces []*VpcInterface } // The entitlements that you want to grant on a flow. type GrantEntitlementRequest struct { - // The name of the entitlement. This value must be unique within the current flow. - Name *string - - // The type of encryption that will be used on the output that is associated with - // this entitlement. - Encryption *Encryption + // The AWS account IDs that you want to share your content with. The receiving + // accounts (subscribers) will be allowed to create their own flows using your + // content as the source. + // + // This member is required. + Subscribers []*string // Percentage from 0-100 of the data transfer cost to be billed to the subscriber. DataTransferSubscriberFeePercent *int32 @@ -216,31 +217,31 @@ type GrantEntitlementRequest struct { // user. Description *string + // The type of encryption that will be used on the output that is associated with + // this entitlement. + Encryption *Encryption + // An indication of whether the new entitlement should be enabled or disabled as // soon as it is created. If you don’t specify the entitlementStatus field in your // request, MediaConnect sets it to ENABLED. EntitlementStatus EntitlementStatus - // The AWS account IDs that you want to share your content with. The receiving - // accounts (subscribers) will be allowed to create their own flows using your - // content as the source. - // - // This member is required. - Subscribers []*string + // The name of the entitlement. This value must be unique within the current flow. + Name *string } // An entitlement that has been granted to you from other AWS accounts. type ListedEntitlement struct { - // The name of the entitlement. + // The ARN of the entitlement. // // This member is required. - EntitlementName *string + EntitlementArn *string - // The ARN of the entitlement. + // The name of the entitlement. // // This member is required. - EntitlementArn *string + EntitlementName *string // Percentage from 0-100 of the data transfer cost to be billed to the subscriber. DataTransferSubscriberFeePercent *int32 @@ -270,17 +271,17 @@ type ListedFlow struct { // This member is required. Name *string - // The current status of the flow. - // - // This member is required. - Status Status - // The type of source. This value is either owned (originated somewhere other than // an AWS Elemental MediaConnect flow owned by another AWS account) or entitled // (originated at an AWS Elemental MediaConnect flow owned by another AWS account). // // This member is required. SourceType SourceType + + // The current status of the flow. + // + // This member is required. + Status Status } // Messages that provide the state of the flow. @@ -295,202 +296,193 @@ type Messages struct { // The settings for an output. type Output struct { - // The address where you want to send the output. - Destination *string - - // The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant - // only for outputs that were added by creating a MediaLive input. - MediaLiveInputArn *string - - // Attributes related to the transport stream that are used in the output. - Transport *Transport + // The name of the output. This value must be unique within the current flow. + // + // This member is required. + Name *string // The ARN of the output. // // This member is required. OutputArn *string - // The type of key used for the encryption. If no keyType is provided, the service - // will use the default setting (static-key). - Encryption *Encryption - - // The name of the VPC interface attachment to use for this output. - VpcInterfaceAttachment *VpcInterfaceAttachment + // Percentage from 0-100 of the data transfer cost to be billed to the subscriber. + DataTransferSubscriberFeePercent *int32 // A description of the output. Description *string - // Percentage from 0-100 of the data transfer cost to be billed to the subscriber. - DataTransferSubscriberFeePercent *int32 - - // The name of the output. This value must be unique within the current flow. - // - // This member is required. - Name *string + // The address where you want to send the output. + Destination *string - // The port to use when content is distributed to this output. - Port *int32 + // The type of key used for the encryption. If no keyType is provided, the service + // will use the default setting (static-key). + Encryption *Encryption // The ARN of the entitlement on the originator''s flow. This value is relevant // only on entitled flows. EntitlementArn *string + + // The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant + // only for outputs that were added by creating a MediaLive input. + MediaLiveInputArn *string + + // The port to use when content is distributed to this output. + Port *int32 + + // Attributes related to the transport stream that are used in the output. + Transport *Transport + + // The name of the VPC interface attachment to use for this output. + VpcInterfaceAttachment *VpcInterfaceAttachment } // The settings for the source of the flow. type SetSourceRequest struct { - // The name of the VPC interface to use for this source. - VpcInterfaceName *string - - // The port that the flow will be listening on for incoming content. - IngestPort *int32 + // The type of encryption that is used on the content ingested from this source. + Decryption *Encryption - // The smoothing max bitrate for RIST, RTP, and RTP-FEC streams. - MaxBitrate *int32 + // A description for the source. This value is not used or seen outside of the + // current AWS Elemental MediaConnect account. + Description *string // The ARN of the entitlement that allows you to subscribe to this flow. The // entitlement is set by the flow originator, and the ARN is generated as part of // the originator's flow. EntitlementArn *string + // The port that the flow will be listening on for incoming content. + IngestPort *int32 + + // The smoothing max bitrate for RIST, RTP, and RTP-FEC streams. + MaxBitrate *int32 + // The maximum latency in milliseconds. This parameter applies only to RIST-based // and Zixi-based streams. MaxLatency *int32 - // The range of IP addresses that should be allowed to contribute content to your - // source. These IP addresses should be in the form of a Classless Inter-Domain - // Routing (CIDR) block; for example, 10.0.0.0/16. - WhitelistCidr *string - // The name of the source. Name *string + // The protocol that is used by the source. + Protocol Protocol + // The stream ID that you want to use for this transport. This parameter applies // only to Zixi-based streams. StreamId *string - // The type of encryption that is used on the content ingested from this source. - Decryption *Encryption - - // The protocol that is used by the source. - Protocol Protocol + // The name of the VPC interface to use for this source. + VpcInterfaceName *string - // A description for the source. This value is not used or seen outside of the - // current AWS Elemental MediaConnect account. - Description *string + // The range of IP addresses that should be allowed to contribute content to your + // source. These IP addresses should be in the form of a Classless Inter-Domain + // Routing (CIDR) block; for example, 10.0.0.0/16. + WhitelistCidr *string } // The settings for the source of the flow. type Source struct { - // The ARN of the source. + // The name of the source. // // This member is required. - SourceArn *string + Name *string - // The name of the source. + // The ARN of the source. // // This member is required. - Name *string + SourceArn *string // Percentage from 0-100 of the data transfer cost to be billed to the subscriber. DataTransferSubscriberFeePercent *int32 - // The range of IP addresses that should be allowed to contribute content to your - // source. These IP addresses should be in the form of a Classless Inter-Domain - // Routing (CIDR) block; for example, 10.0.0.0/16. - WhitelistCidr *string + // The type of encryption that is used on the content ingested from this source. + Decryption *Encryption // A description for the source. This value is not used or seen outside of the // current AWS Elemental MediaConnect account. Description *string - // The name of the VPC Interface this Source is configured with. - VpcInterfaceName *string - - // Attributes related to the transport stream that are used in the source. - Transport *Transport - - // The type of encryption that is used on the content ingested from this source. - Decryption *Encryption - // The ARN of the entitlement that allows you to subscribe to content that comes // from another AWS account. The entitlement is set by the content originator and // the ARN is generated as part of the originator's flow. EntitlementArn *string + // The IP address that the flow will be listening on for incoming content. + IngestIp *string + // The port that the flow will be listening on for incoming content. IngestPort *int32 - // The IP address that the flow will be listening on for incoming content. - IngestIp *string + // Attributes related to the transport stream that are used in the source. + Transport *Transport + + // The name of the VPC Interface this Source is configured with. + VpcInterfaceName *string + + // The range of IP addresses that should be allowed to contribute content to your + // source. These IP addresses should be in the form of a Classless Inter-Domain + // Routing (CIDR) block; for example, 10.0.0.0/16. + WhitelistCidr *string } // Attributes related to the transport stream that are used in a source or output. type Transport struct { - // The remote ID for the Zixi-pull stream. - RemoteId *string + // The protocol that is used by the source or output. + // + // This member is required. + Protocol Protocol // The range of IP addresses that should be allowed to initiate output requests to // this flow. These IP addresses should be in the form of a Classless Inter-Domain // Routing (CIDR) block; for example, 10.0.0.0/16. CidrAllowList []*string + // The smoothing max bitrate for RIST, RTP, and RTP-FEC streams. + MaxBitrate *int32 + // The maximum latency in milliseconds. This parameter applies only to RIST-based // and Zixi-based streams. MaxLatency *int32 + // The remote ID for the Zixi-pull stream. + RemoteId *string + // The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams. SmoothingLatency *int32 // The stream ID that you want to use for this transport. This parameter applies // only to Zixi-based streams. StreamId *string - - // The protocol that is used by the source or output. - // - // This member is required. - Protocol Protocol - - // The smoothing max bitrate for RIST, RTP, and RTP-FEC streams. - MaxBitrate *int32 } // Information about the encryption of the flow. type UpdateEncryption struct { - // The AWS Region that the API Gateway proxy endpoint was created in. This - // parameter is required for SPEKE encryption and is not valid for static key - // encryption. - Region *string - - // The ARN of the role that you created during setup (when you set up AWS Elemental - // MediaConnect as a trusted entity). - RoleArn *string - - // The URL from the API Gateway proxy that you set up to talk to your key server. - // This parameter is required for SPEKE encryption and is not valid for static key - // encryption. - Url *string - // The type of algorithm that is used for the encryption (such as aes128, aes192, // or aes256). Algorithm Algorithm - // The type of key that is used for the encryption. If no keyType is provided, the - // service will use the default setting (static-key). - KeyType KeyType + // A 128-bit, 16-byte hex value represented by a 32-character string, to be used + // with the key for encrypting content. This parameter is not valid for static key + // encryption. + ConstantInitializationVector *string // The value of one of the devices that you configured with your digital rights // management (DRM) platform key provider. This parameter is required for SPEKE // encryption and is not valid for static key encryption. DeviceId *string - // A 128-bit, 16-byte hex value represented by a 32-character string, to be used - // with the key for encrypting content. This parameter is not valid for static key + // The type of key that is used for the encryption. If no keyType is provided, the + // service will use the default setting (static-key). + KeyType KeyType + + // The AWS Region that the API Gateway proxy endpoint was created in. This + // parameter is required for SPEKE encryption and is not valid for static key // encryption. - ConstantInitializationVector *string + Region *string // An identifier for the content. The service sends this value to the key server to // identify the current endpoint. The resource ID is also known as the content ID. @@ -498,18 +490,28 @@ type UpdateEncryption struct { // encryption. ResourceId *string + // The ARN of the role that you created during setup (when you set up AWS Elemental + // MediaConnect as a trusted entity). + RoleArn *string + // The ARN of the secret that you created in AWS Secrets Manager to store the // encryption key. This parameter is required for static key encryption and is not // valid for SPEKE encryption. SecretArn *string + + // The URL from the API Gateway proxy that you set up to talk to your key server. + // This parameter is required for SPEKE encryption and is not valid for static key + // encryption. + Url *string } // The settings for source failover type UpdateFailoverConfig struct { - State State // Recovery window time to look for dash-7 packets RecoveryWindow *int32 + + State State } // The settings for a VPC Source. @@ -525,6 +527,11 @@ type VpcInterface struct { // This member is required. NetworkInterfaceIds []*string + // Role Arn MediaConnect can assumes to create ENIs in customer's account + // + // This member is required. + RoleArn *string + // Security Group IDs to be used on ENI. // // This member is required. @@ -534,11 +541,6 @@ type VpcInterface struct { // // This member is required. SubnetId *string - - // Role Arn MediaConnect can assumes to create ENIs in customer's account - // - // This member is required. - RoleArn *string } // The settings for attaching a VPC interface to an output. @@ -551,24 +553,24 @@ type VpcInterfaceAttachment struct { // Desired VPC Interface for a Flow type VpcInterfaceRequest struct { - // Subnet must be in the AZ of the Flow + // The name of the VPC Interface. This value must be unique within the current + // flow. // // This member is required. - SubnetId *string + Name *string - // Security Group IDs to be used on ENI. + // Role Arn MediaConnect can assumes to create ENIs in customer's account // // This member is required. - SecurityGroupIds []*string + RoleArn *string - // Role Arn MediaConnect can assumes to create ENIs in customer's account + // Security Group IDs to be used on ENI. // // This member is required. - RoleArn *string + SecurityGroupIds []*string - // The name of the VPC Interface. This value must be unique within the current - // flow. + // Subnet must be in the AZ of the Flow // // This member is required. - Name *string + SubnetId *string } diff --git a/service/mediaconvert/api_op_CreateJob.go b/service/mediaconvert/api_op_CreateJob.go index e35a3c75f1d..20609357233 100644 --- a/service/mediaconvert/api_op_CreateJob.go +++ b/service/mediaconvert/api_op_CreateJob.go @@ -60,33 +60,6 @@ func (c *Client) CreateJob(ctx context.Context, params *CreateJobInput, optFns . type CreateJobInput struct { - // Optional. Accelerated transcoding can significantly speed up jobs with long, - // visually complex content. Outputs that use this feature incur pro-tier pricing. - // For information about feature limitations, see the AWS Elemental MediaConvert - // User Guide. - AccelerationSettings *types.AccelerationSettings - - // Optional. Use queue hopping to avoid overly long waits in the backlog of the - // queue that you submit your job to. Specify an alternate queue and the maximum - // time that your job will wait in the initial queue before hopping. For more - // information about this feature, see the AWS Elemental MediaConvert User Guide. - HopDestinations []*types.HopDestination - - // Optional. Enable this setting when you run a test job to estimate how many - // reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert - // runs your job from an on-demand queue with similar performance to what you will - // see with one RTS in a reserved queue. This setting is disabled by default. - SimulateReservedQueue types.SimulateReservedQueue - - // Optional. The tags that you want to add to the resource. You can tag resources - // with a key-value pair or with only a key. - Tags map[string]*string - - // JobSettings contains all the transcode settings for a job. - // - // This member is required. - Settings *types.JobSettings - // Required. The IAM role you use for creating this job. For details about // permissions, see the User Guide topic at the User Guide at // http://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html. @@ -94,18 +67,16 @@ type CreateJobInput struct { // This member is required. Role *string - // Optional. Idempotency token for CreateJob operation. - ClientRequestToken *string - - // Optional. When you create a job, you can specify a queue to send it to. If you - // don't specify, the job will go to the default queue. For more about queues, see - // the User Guide topic at - // http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html. - Queue *string + // JobSettings contains all the transcode settings for a job. + // + // This member is required. + Settings *types.JobSettings - // Optional. When you create a job, you can either specify a job template or - // specify the transcoding settings individually. - JobTemplate *string + // Optional. Accelerated transcoding can significantly speed up jobs with long, + // visually complex content. Outputs that use this feature incur pro-tier pricing. + // For information about feature limitations, see the AWS Elemental MediaConvert + // User Guide. + AccelerationSettings *types.AccelerationSettings // Optional. Choose a tag type that AWS Billing and Cost Management will use to // sort your AWS Elemental MediaConvert costs on any billing report that you set @@ -114,6 +85,19 @@ type CreateJobInput struct { // your job outputs will appear on the billing report unsorted. BillingTagsSource types.BillingTagsSource + // Optional. Idempotency token for CreateJob operation. + ClientRequestToken *string + + // Optional. Use queue hopping to avoid overly long waits in the backlog of the + // queue that you submit your job to. Specify an alternate queue and the maximum + // time that your job will wait in the initial queue before hopping. For more + // information about this feature, see the AWS Elemental MediaConvert User Guide. + HopDestinations []*types.HopDestination + + // Optional. When you create a job, you can either specify a job template or + // specify the transcoding settings individually. + JobTemplate *string + // Optional. Specify the relative priority for this job. In any given queue, the // service begins processing the job with the highest value first. When more than // one job has the same priority, the service begins processing the job that you @@ -121,9 +105,17 @@ type CreateJobInput struct { // value 0. Priority *int32 - // Optional. User-defined metadata that you want to associate with an MediaConvert - // job. You specify metadata in key/value pairs. - UserMetadata map[string]*string + // Optional. When you create a job, you can specify a queue to send it to. If you + // don't specify, the job will go to the default queue. For more about queues, see + // the User Guide topic at + // http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html. + Queue *string + + // Optional. Enable this setting when you run a test job to estimate how many + // reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert + // runs your job from an on-demand queue with similar performance to what you will + // see with one RTS in a reserved queue. This setting is disabled by default. + SimulateReservedQueue types.SimulateReservedQueue // Optional. Specify how often MediaConvert sends STATUS_UPDATE events to Amazon // CloudWatch Events. Set the interval, in seconds, between status updates. @@ -131,6 +123,14 @@ type CreateJobInput struct { // processing your job to the time it completes the transcode or encounters an // error. StatusUpdateInterval types.StatusUpdateInterval + + // Optional. The tags that you want to add to the resource. You can tag resources + // with a key-value pair or with only a key. + Tags map[string]*string + + // Optional. User-defined metadata that you want to associate with an MediaConvert + // job. You specify metadata in key/value pairs. + UserMetadata map[string]*string } type CreateJobOutput struct { diff --git a/service/mediaconvert/api_op_CreateJobTemplate.go b/service/mediaconvert/api_op_CreateJobTemplate.go index 0b91babf703..e5cd6112a40 100644 --- a/service/mediaconvert/api_op_CreateJobTemplate.go +++ b/service/mediaconvert/api_op_CreateJobTemplate.go @@ -63,18 +63,11 @@ type CreateJobTemplateInput struct { // This member is required. Name *string - // Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch - // Events. Set the interval, in seconds, between status updates. MediaConvert sends - // an update at this interval from the time the service begins processing your job - // to the time it completes the transcode or encounters an error. - StatusUpdateInterval types.StatusUpdateInterval - - // Optional. The queue that jobs created from this template are assigned to. If you - // don't specify this, jobs will go to the default queue. - Queue *string - - // Optional. A description of the job template you are creating. - Description *string + // JobTemplateSettings contains all the transcode settings saved in the template + // that will be applied to jobs created from it. + // + // This member is required. + Settings *types.JobTemplateSettings // Accelerated transcoding can significantly speed up jobs with long, visually // complex content. Outputs that use this feature incur pro-tier pricing. For @@ -85,9 +78,14 @@ type CreateJobTemplateInput struct { // Optional. A category for the job template you are creating Category *string - // The tags that you want to add to the resource. You can tag resources with a - // key-value pair or with only a key. - Tags map[string]*string + // Optional. A description of the job template you are creating. + Description *string + + // Optional. Use queue hopping to avoid overly long waits in the backlog of the + // queue that you submit your job to. Specify an alternate queue and the maximum + // time that your job will wait in the initial queue before hopping. For more + // information about this feature, see the AWS Elemental MediaConvert User Guide. + HopDestinations []*types.HopDestination // Specify the relative priority for this job. In any given queue, the service // begins processing the job with the highest value first. When more than one job @@ -95,17 +93,19 @@ type CreateJobTemplateInput struct { // first. If you don't specify a priority, the service uses the default value 0. Priority *int32 - // Optional. Use queue hopping to avoid overly long waits in the backlog of the - // queue that you submit your job to. Specify an alternate queue and the maximum - // time that your job will wait in the initial queue before hopping. For more - // information about this feature, see the AWS Elemental MediaConvert User Guide. - HopDestinations []*types.HopDestination + // Optional. The queue that jobs created from this template are assigned to. If you + // don't specify this, jobs will go to the default queue. + Queue *string - // JobTemplateSettings contains all the transcode settings saved in the template - // that will be applied to jobs created from it. - // - // This member is required. - Settings *types.JobTemplateSettings + // Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch + // Events. Set the interval, in seconds, between status updates. MediaConvert sends + // an update at this interval from the time the service begins processing your job + // to the time it completes the transcode or encounters an error. + StatusUpdateInterval types.StatusUpdateInterval + + // The tags that you want to add to the resource. You can tag resources with a + // key-value pair or with only a key. + Tags map[string]*string } type CreateJobTemplateOutput struct { diff --git a/service/mediaconvert/api_op_CreatePreset.go b/service/mediaconvert/api_op_CreatePreset.go index 689f2ef14d4..64d6e688a7a 100644 --- a/service/mediaconvert/api_op_CreatePreset.go +++ b/service/mediaconvert/api_op_CreatePreset.go @@ -58,16 +58,6 @@ func (c *Client) CreatePreset(ctx context.Context, params *CreatePresetInput, op type CreatePresetInput struct { - // Optional. A description of the preset you are creating. - Description *string - - // Optional. A category for the preset you are creating. - Category *string - - // The tags that you want to add to the resource. You can tag resources with a - // key-value pair or with only a key. - Tags map[string]*string - // The name of the preset you are creating. // // This member is required. @@ -77,6 +67,16 @@ type CreatePresetInput struct { // // This member is required. Settings *types.PresetSettings + + // Optional. A category for the preset you are creating. + Category *string + + // Optional. A description of the preset you are creating. + Description *string + + // The tags that you want to add to the resource. You can tag resources with a + // key-value pair or with only a key. + Tags map[string]*string } type CreatePresetOutput struct { diff --git a/service/mediaconvert/api_op_CreateQueue.go b/service/mediaconvert/api_op_CreateQueue.go index 745aaa743de..d6dd7f47fd3 100644 --- a/service/mediaconvert/api_op_CreateQueue.go +++ b/service/mediaconvert/api_op_CreateQueue.go @@ -59,32 +59,32 @@ func (c *Client) CreateQueue(ctx context.Context, params *CreateQueueInput, optF type CreateQueueInput struct { - // Optional. A description of the queue that you are creating. - Description *string - // The name of the queue that you are creating. // // This member is required. Name *string + // Optional. A description of the queue that you are creating. + Description *string + + // Specifies whether the pricing plan for the queue is on-demand or reserved. For + // on-demand, you pay per minute, billed in increments of .01 minute. For reserved, + // you pay for the transcoding capacity of the entire queue, regardless of how much + // or how little you use it. Reserved pricing requires a 12-month commitment. When + // you use the API to create a queue, the default is on-demand. + PricingPlan types.PricingPlan + // Details about the pricing plan for your reserved queue. Required for reserved // queues and not applicable to on-demand queues. ReservationPlanSettings *types.ReservationPlanSettings - // The tags that you want to add to the resource. You can tag resources with a - // key-value pair or with only a key. - Tags map[string]*string - // Initial state of the queue. If you create a paused queue, then jobs in that // queue won't begin. Status types.QueueStatus - // Specifies whether the pricing plan for the queue is on-demand or reserved. For - // on-demand, you pay per minute, billed in increments of .01 minute. For reserved, - // you pay for the transcoding capacity of the entire queue, regardless of how much - // or how little you use it. Reserved pricing requires a 12-month commitment. When - // you use the API to create a queue, the default is on-demand. - PricingPlan types.PricingPlan + // The tags that you want to add to the resource. You can tag resources with a + // key-value pair or with only a key. + Tags map[string]*string } type CreateQueueOutput struct { diff --git a/service/mediaconvert/api_op_DescribeEndpoints.go b/service/mediaconvert/api_op_DescribeEndpoints.go index c30dc5d45c4..48ba7786ba7 100644 --- a/service/mediaconvert/api_op_DescribeEndpoints.go +++ b/service/mediaconvert/api_op_DescribeEndpoints.go @@ -58,10 +58,6 @@ func (c *Client) DescribeEndpoints(ctx context.Context, params *DescribeEndpoint // DescribeEndpointsRequest type DescribeEndpointsInput struct { - // Use this string, provided with the response to a previous request, to request - // the next batch of endpoints. - NextToken *string - // Optional. Max number of endpoints, up to twenty, that will be returned at one // time. MaxResults *int32 @@ -71,16 +67,20 @@ type DescribeEndpointsInput struct { // it if one doesn't already exist. Specify GET_ONLY to return your endpoints if // any exist, or an empty list if none exist. Mode types.DescribeEndpointsMode + + // Use this string, provided with the response to a previous request, to request + // the next batch of endpoints. + NextToken *string } type DescribeEndpointsOutput struct { - // Use this string to request the next batch of endpoints. - NextToken *string - // List of endpoints Endpoints []*types.Endpoint + // Use this string to request the next batch of endpoints. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mediaconvert/api_op_ListJobTemplates.go b/service/mediaconvert/api_op_ListJobTemplates.go index b56db221677..7b26849db81 100644 --- a/service/mediaconvert/api_op_ListJobTemplates.go +++ b/service/mediaconvert/api_op_ListJobTemplates.go @@ -58,26 +58,26 @@ func (c *Client) ListJobTemplates(ctx context.Context, params *ListJobTemplatesI type ListJobTemplatesInput struct { - // Use this string, provided with the response to a previous request, to request - // the next batch of job templates. - NextToken *string - // Optionally, specify a job template category to limit responses to only job // templates from that category. Category *string - // Optional. When you request lists of resources, you can specify whether they are - // sorted in ASCENDING or DESCENDING order. Default varies by resource. - Order types.Order + // Optional. When you request a list of job templates, you can choose to list them + // alphabetically by NAME or chronologically by CREATION_DATE. If you don't + // specify, the service will list them by name. + ListBy types.JobTemplateListBy // Optional. Number of job templates, up to twenty, that will be returned at one // time. MaxResults *int32 - // Optional. When you request a list of job templates, you can choose to list them - // alphabetically by NAME or chronologically by CREATION_DATE. If you don't - // specify, the service will list them by name. - ListBy types.JobTemplateListBy + // Use this string, provided with the response to a previous request, to request + // the next batch of job templates. + NextToken *string + + // Optional. When you request lists of resources, you can specify whether they are + // sorted in ASCENDING or DESCENDING order. Default varies by resource. + Order types.Order } type ListJobTemplatesOutput struct { diff --git a/service/mediaconvert/api_op_ListJobs.go b/service/mediaconvert/api_op_ListJobs.go index bbe3cf207e2..5e03b230255 100644 --- a/service/mediaconvert/api_op_ListJobs.go +++ b/service/mediaconvert/api_op_ListJobs.go @@ -59,33 +59,33 @@ func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ... type ListJobsInput struct { - // Optional. When you request lists of resources, you can specify whether they are - // sorted in ASCENDING or DESCENDING order. Default varies by resource. - Order types.Order - - // Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or - // ERROR. - Status types.JobStatus + // Optional. Number of jobs, up to twenty, that will be returned at one time. + MaxResults *int32 // Optional. Use this string, provided with the response to a previous request, to // request the next batch of jobs. NextToken *string - // Optional. Number of jobs, up to twenty, that will be returned at one time. - MaxResults *int32 + // Optional. When you request lists of resources, you can specify whether they are + // sorted in ASCENDING or DESCENDING order. Default varies by resource. + Order types.Order // Optional. Provide a queue name to get back only jobs from that queue. Queue *string + + // Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or + // ERROR. + Status types.JobStatus } type ListJobsOutput struct { - // Use this string to request the next batch of jobs. - NextToken *string - // List of jobs Jobs []*types.Job + // Use this string to request the next batch of jobs. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mediaconvert/api_op_ListPresets.go b/service/mediaconvert/api_op_ListPresets.go index 571df3ee69d..54d0fbf938a 100644 --- a/service/mediaconvert/api_op_ListPresets.go +++ b/service/mediaconvert/api_op_ListPresets.go @@ -58,17 +58,6 @@ func (c *Client) ListPresets(ctx context.Context, params *ListPresetsInput, optF type ListPresetsInput struct { - // Optional. Number of presets, up to twenty, that will be returned at one time - MaxResults *int32 - - // Optional. When you request lists of resources, you can specify whether they are - // sorted in ASCENDING or DESCENDING order. Default varies by resource. - Order types.Order - - // Use this string, provided with the response to a previous request, to request - // the next batch of presets. - NextToken *string - // Optionally, specify a preset category to limit responses to only presets from // that category. Category *string @@ -77,6 +66,17 @@ type ListPresetsInput struct { // alphabetically by NAME or chronologically by CREATION_DATE. If you don't // specify, the service will list them by name. ListBy types.PresetListBy + + // Optional. Number of presets, up to twenty, that will be returned at one time + MaxResults *int32 + + // Use this string, provided with the response to a previous request, to request + // the next batch of presets. + NextToken *string + + // Optional. When you request lists of resources, you can specify whether they are + // sorted in ASCENDING or DESCENDING order. Default varies by resource. + Order types.Order } type ListPresetsOutput struct { diff --git a/service/mediaconvert/api_op_ListQueues.go b/service/mediaconvert/api_op_ListQueues.go index fd51d3c83c8..3eec5ccc4ce 100644 --- a/service/mediaconvert/api_op_ListQueues.go +++ b/service/mediaconvert/api_op_ListQueues.go @@ -63,13 +63,13 @@ type ListQueuesInput struct { // specify, the service will list them by creation date. ListBy types.QueueListBy + // Optional. Number of queues, up to twenty, that will be returned at one time. + MaxResults *int32 + // Use this string, provided with the response to a previous request, to request // the next batch of queues. NextToken *string - // Optional. Number of queues, up to twenty, that will be returned at one time. - MaxResults *int32 - // Optional. When you request lists of resources, you can specify whether they are // sorted in ASCENDING or DESCENDING order. Default varies by resource. Order types.Order @@ -77,12 +77,12 @@ type ListQueuesInput struct { type ListQueuesOutput struct { - // List of queues. - Queues []*types.Queue - // Use this string to request the next batch of queues. NextToken *string + // List of queues. + Queues []*types.Queue + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mediaconvert/api_op_TagResource.go b/service/mediaconvert/api_op_TagResource.go index a6b4e061e51..84cfd8d973c 100644 --- a/service/mediaconvert/api_op_TagResource.go +++ b/service/mediaconvert/api_op_TagResource.go @@ -58,17 +58,17 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The tags that you want to add to the resource. You can tag resources with a - // key-value pair or with only a key. - // - // This member is required. - Tags map[string]*string - // The Amazon Resource Name (ARN) of the resource that you want to tag. To get the // ARN, send a GET request with the resource name. // // This member is required. Arn *string + + // The tags that you want to add to the resource. You can tag resources with a + // key-value pair or with only a key. + // + // This member is required. + Tags map[string]*string } type TagResourceOutput struct { diff --git a/service/mediaconvert/api_op_UpdateJobTemplate.go b/service/mediaconvert/api_op_UpdateJobTemplate.go index 89a46f45b26..6d3b75a27ff 100644 --- a/service/mediaconvert/api_op_UpdateJobTemplate.go +++ b/service/mediaconvert/api_op_UpdateJobTemplate.go @@ -57,23 +57,10 @@ func (c *Client) UpdateJobTemplate(ctx context.Context, params *UpdateJobTemplat type UpdateJobTemplateInput struct { - // The new category for the job template, if you are changing it. - Category *string - - // Specify the relative priority for this job. In any given queue, the service - // begins processing the job with the highest value first. When more than one job - // has the same priority, the service begins processing the job that you submitted - // first. If you don't specify a priority, the service uses the default value 0. - Priority *int32 - - // Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch - // Events. Set the interval, in seconds, between status updates. MediaConvert sends - // an update at this interval from the time the service begins processing your job - // to the time it completes the transcode or encounters an error. - StatusUpdateInterval types.StatusUpdateInterval - - // The new description for the job template, if you are changing it. - Description *string + // The name of the job template you are modifying + // + // This member is required. + Name *string // Accelerated transcoding can significantly speed up jobs with long, visually // complex content. Outputs that use this feature incur pro-tier pricing. For @@ -81,20 +68,33 @@ type UpdateJobTemplateInput struct { // Guide. AccelerationSettings *types.AccelerationSettings - // The new queue for the job template, if you are changing it. - Queue *string + // The new category for the job template, if you are changing it. + Category *string + + // The new description for the job template, if you are changing it. + Description *string // Optional list of hop destinations. HopDestinations []*types.HopDestination - // The name of the job template you are modifying - // - // This member is required. - Name *string + // Specify the relative priority for this job. In any given queue, the service + // begins processing the job with the highest value first. When more than one job + // has the same priority, the service begins processing the job that you submitted + // first. If you don't specify a priority, the service uses the default value 0. + Priority *int32 + + // The new queue for the job template, if you are changing it. + Queue *string // JobTemplateSettings contains all the transcode settings saved in the template // that will be applied to jobs created from it. Settings *types.JobTemplateSettings + + // Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch + // Events. Set the interval, in seconds, between status updates. MediaConvert sends + // an update at this interval from the time the service begins processing your job + // to the time it completes the transcode or encounters an error. + StatusUpdateInterval types.StatusUpdateInterval } type UpdateJobTemplateOutput struct { diff --git a/service/mediaconvert/api_op_UpdatePreset.go b/service/mediaconvert/api_op_UpdatePreset.go index ec49370be1b..09a8fdf6c18 100644 --- a/service/mediaconvert/api_op_UpdatePreset.go +++ b/service/mediaconvert/api_op_UpdatePreset.go @@ -57,9 +57,6 @@ func (c *Client) UpdatePreset(ctx context.Context, params *UpdatePresetInput, op type UpdatePresetInput struct { - // Settings for preset - Settings *types.PresetSettings - // The name of the preset you are modifying. // // This member is required. @@ -70,6 +67,9 @@ type UpdatePresetInput struct { // The new description for the preset, if you are changing it. Description *string + + // Settings for preset + Settings *types.PresetSettings } type UpdatePresetOutput struct { diff --git a/service/mediaconvert/api_op_UpdateQueue.go b/service/mediaconvert/api_op_UpdateQueue.go index c013828511f..ebe440fd51a 100644 --- a/service/mediaconvert/api_op_UpdateQueue.go +++ b/service/mediaconvert/api_op_UpdateQueue.go @@ -57,14 +57,14 @@ func (c *Client) UpdateQueue(ctx context.Context, params *UpdateQueueInput, optF type UpdateQueueInput struct { + // The name of the queue that you are modifying. + // + // This member is required. + Name *string + // The new description for the queue, if you are changing it. Description *string - // Pause or activate a queue by changing its status between ACTIVE and PAUSED. If - // you pause a queue, jobs in that queue won't begin. Jobs that are running when - // you pause the queue continue to run until they finish or result in an error. - Status types.QueueStatus - // The new details of your pricing plan for your reserved queue. When you set up a // new pricing plan to replace an expired one, you enter into another 12-month // commitment. When you add capacity to your queue by increasing the number of RTS, @@ -72,10 +72,10 @@ type UpdateQueueInput struct { // After you make these commitments, you can't cancel them. ReservationPlanSettings *types.ReservationPlanSettings - // The name of the queue that you are modifying. - // - // This member is required. - Name *string + // Pause or activate a queue by changing its status between ACTIVE and PAUSED. If + // you pause a queue, jobs in that queue won't begin. Jobs that are running when + // you pause the queue continue to run until they finish or result in an error. + Status types.QueueStatus } type UpdateQueueOutput struct { diff --git a/service/mediaconvert/go.mod b/service/mediaconvert/go.mod index 1b9f56e7310..33c685b3376 100644 --- a/service/mediaconvert/go.mod +++ b/service/mediaconvert/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/mediaconvert go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/mediaconvert/types/types.go b/service/mediaconvert/types/types.go index 535dda58790..d2f01ede828 100644 --- a/service/mediaconvert/types/types.go +++ b/service/mediaconvert/types/types.go @@ -15,30 +15,6 @@ import ( // control mode. type AacSettings struct { - // Enables LATM/LOAS AAC output. Note that if you use LATM/LOAS AAC in an output, - // you must choose "No container" for the output container. - RawFormat AacRawFormat - - // Use MPEG-2 AAC instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream - // containers. - Specification AacSpecification - - // VBR Quality Level - Only used if rate_control_mode is VBR. - VbrQuality AacVbrQuality - - // Rate Control Mode. - RateControlMode AacRateControlMode - - // Mono (Audio Description), Mono, Stereo, or 5.1 channel layout. Valid values - // depend on rate control mode and profile. "1.0 - Audio Description (Receiver - // Mix)" setting receives a stereo description plus control track and emits a mono - // AAC encode of the description track, with control data emitted in the PES header - // as per ETSI TS 101 154 Annex E. - CodingMode AacCodingMode - - // AAC Profile. - CodecProfile AacCodecProfile - // Choose BROADCASTER_MIXED_AD when the input contains pre-mixed main audio + audio // description (AD) as a stereo pair. The value for AudioType will be set to 3, // which signals to downstream systems that this stream contains "broadcaster mixed @@ -50,9 +26,6 @@ type AacSettings struct { // you provide for AudioType and FollowInputAudioType. AudioDescriptionBroadcasterMix AacAudioDescriptionBroadcasterMix - // Sample rate in Hz. Valid values depend on rate control mode and profile. - SampleRate *int32 - // Specify the average bitrate in bits per second. The set of valid values for this // setting is: 6000, 8000, 10000, 12000, 14000, 16000, 20000, 24000, 28000, 32000, // 40000, 48000, 56000, 64000, 80000, 96000, 112000, 128000, 160000, 192000, @@ -61,30 +34,61 @@ type AacSettings struct { // choose for Profile (codecProfile), Bitrate control mode (codingMode), and Sample // rate (sampleRate). Default values depend on Bitrate control mode and Profile. Bitrate *int32 + + // AAC Profile. + CodecProfile AacCodecProfile + + // Mono (Audio Description), Mono, Stereo, or 5.1 channel layout. Valid values + // depend on rate control mode and profile. "1.0 - Audio Description (Receiver + // Mix)" setting receives a stereo description plus control track and emits a mono + // AAC encode of the description track, with control data emitted in the PES header + // as per ETSI TS 101 154 Annex E. + CodingMode AacCodingMode + + // Rate Control Mode. + RateControlMode AacRateControlMode + + // Enables LATM/LOAS AAC output. Note that if you use LATM/LOAS AAC in an output, + // you must choose "No container" for the output container. + RawFormat AacRawFormat + + // Sample rate in Hz. Valid values depend on rate control mode and profile. + SampleRate *int32 + + // Use MPEG-2 AAC instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream + // containers. + Specification AacSpecification + + // VBR Quality Level - Only used if rate_control_mode is VBR. + VbrQuality AacVbrQuality } // Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the // value AC3. type Ac3Settings struct { - // Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid - // with 3_2_LFE coding mode. - LfeFilter Ac3LfeFilter + // Specify the average bitrate in bits per second. Valid bitrates depend on the + // coding mode. + Bitrate *int32 // Specify the bitstream mode for the AC-3 stream that the encoder emits. For more // information about the AC3 bitstream mode, see ATSC A/52-2012 (Annex E). BitstreamMode Ac3BitstreamMode - // Specify the average bitrate in bits per second. Valid bitrates depend on the - // coding mode. - Bitrate *int32 + // Dolby Digital coding mode. Determines number of channels. + CodingMode Ac3CodingMode + + // Sets the dialnorm for the output. If blank and input audio is Dolby Digital, + // dialnorm will be passed through. + Dialnorm *int32 // If set to FILM_STANDARD, adds dynamic range compression signaling to the output // bitstream as defined in the Dolby Digital specification. DynamicRangeCompressionProfile Ac3DynamicRangeCompressionProfile - // Dolby Digital coding mode. Determines number of channels. - CodingMode Ac3CodingMode + // Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid + // with 3_2_LFE coding mode. + LfeFilter Ac3LfeFilter // When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or // DolbyE decoder that supplied this audio data. If audio was not supplied from one @@ -93,10 +97,6 @@ type Ac3Settings struct { // This value is always 48000. It represents the sample rate in Hz. SampleRate *int32 - - // Sets the dialnorm for the output. If blank and input audio is Dolby Digital, - // dialnorm will be passed through. - Dialnorm *int32 } // Accelerated transcoding can significantly speed up jobs with long, visually @@ -114,9 +114,6 @@ type AccelerationSettings struct { // value AIFF. type AiffSettings struct { - // Sample rate in hz. - SampleRate *int32 - // Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality // for this audio track. BitDepth *int32 @@ -124,15 +121,14 @@ type AiffSettings struct { // Specify the number of channels in this output audio track. Valid values are 1 // and even numbers up to 64. For example, 1, 2, 4, 6, and so on, up to 64. Channels *int32 + + // Sample rate in hz. + SampleRate *int32 } // Settings for ancillary captions source. type AncillarySourceSettings struct { - // Specifies the 608 channel number in the ancillary data track from which to - // extract captions. Unused for passthrough. - SourceAncillaryChannelNumber *int32 - // Specify whether this set of input captions appears in your outputs in both 608 // and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the // captions data in two ways: it passes the 608 data through using the 608 @@ -140,6 +136,10 @@ type AncillarySourceSettings struct { // data into 708. Convert608To708 AncillaryConvert608To708 + // Specifies the 608 channel number in the ancillary data track from which to + // extract captions. Unused for passthrough. + SourceAncillaryChannelNumber *int32 + // By default, the service terminates any unterminated captions at the end of each // input. If you want the caption to continue onto your next input, disable this // setting. @@ -156,14 +156,6 @@ type AncillarySourceSettings struct { // VorbisSettings * OPUS, OpusSettings type AudioCodecSettings struct { - // Required when you set Codec, under AudioDescriptions>CodecSettings, to the value - // MP3. - Mp3Settings *Mp3Settings - - // Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the - // value MP2. - Mp2Settings *Mp2Settings - // Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the // value AAC. The service accepts one of two mutually exclusive groups of AAC // settings--VBR and CBR. To select one of these modes, set the value of Bitrate @@ -173,33 +165,41 @@ type AudioCodecSettings struct { // control mode. AacSettings *AacSettings - // Required when you set Codec, under AudioDescriptions>CodecSettings, to the value - // OPUS. - OpusSettings *OpusSettings - // Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the // value AC3. Ac3Settings *Ac3Settings // Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the - // value EAC3. - Eac3Settings *Eac3Settings - - // Required when you set Codec, under AudioDescriptions>CodecSettings, to the value - // Vorbis. - VorbisSettings *VorbisSettings + // value AIFF. + AiffSettings *AiffSettings // Type of Audio codec. Codec AudioCodec - // Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the - // value AIFF. - AiffSettings *AiffSettings - // Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the // value EAC3_ATMOS. Eac3AtmosSettings *Eac3AtmosSettings + // Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the + // value EAC3. + Eac3Settings *Eac3Settings + + // Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the + // value MP2. + Mp2Settings *Mp2Settings + + // Required when you set Codec, under AudioDescriptions>CodecSettings, to the value + // MP3. + Mp3Settings *Mp3Settings + + // Required when you set Codec, under AudioDescriptions>CodecSettings, to the value + // OPUS. + OpusSettings *OpusSettings + + // Required when you set Codec, under AudioDescriptions>CodecSettings, to the value + // Vorbis. + VorbisSettings *VorbisSettings + // Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the // value WAV. WavSettings *WavSettings @@ -208,21 +208,21 @@ type AudioCodecSettings struct { // Description of audio output type AudioDescription struct { - // Audio codec settings (CodecSettings) under (AudioDescriptions) contains the - // group of settings related to audio encoding. The settings in this group vary - // depending on the value that you choose for Audio codec (Codec). For each codec - // enum that you choose, define the corresponding settings object. The following - // lists the codec enum, settings object pairs. * AAC, AacSettings * MP2, - // Mp2Settings * MP3, Mp3Settings * WAV, WavSettings * AIFF, AiffSettings * AC3, - // Ac3Settings * EAC3, Eac3Settings * EAC3_ATMOS, Eac3AtmosSettings * VORBIS, - // VorbisSettings * OPUS, OpusSettings - CodecSettings *AudioCodecSettings + // Advanced audio normalization settings. Ignore these settings unless you need to + // comply with a loudness standard. + AudioNormalizationSettings *AudioNormalizationSettings - // Indicates the language of the audio output track. The ISO 639 language specified - // in the 'Language Code' drop down will be used when 'Follow Input Language Code' - // is not selected or when 'Follow Input Language Code' is selected but there is no - // ISO 639 language code specified by the input. - LanguageCode LanguageCode + // Specifies which audio data to use from each input. In the simplest case, specify + // an "Audio Selector":#inputs-audio_selector by name based on its order within + // each input. For example if you specify "Audio Selector 3", then the third audio + // selector will be used from each input. If an input does not have an "Audio + // Selector 3", then the audio selector marked as "default" in that input will be + // used. If there is no audio selector marked as "default", silence will be + // inserted for the duration of that input. Alternatively, an "Audio Selector + // Group":#inputs-audio_selector_group name may be specified, with similar + // default/silence behavior. If no audio_source_name is specified, then "Audio + // Selector 1" will be chosen automatically. + AudioSourceName *string // Applies only if Follow Input Audio Type is unchecked (false). A number between 0 // and 255. The following are defined in ISO-IEC 13818-1: 0 = Undefined, 1 = Clean @@ -230,9 +230,6 @@ type AudioDescription struct { // Reserved. AudioType *int32 - // Advanced audio remixing settings. - RemixSettings *RemixSettings - // When set to FOLLOW_INPUT, if the input contains an ISO 639 audio_type, then that // value is passed through to the output. If the input contains no ISO 639 // audio_type, the value in Audio Type is included in the output. Otherwise the @@ -241,17 +238,15 @@ type AudioDescription struct { // BROADCASTER_MIXED_AD. AudioTypeControl AudioTypeControl - // Specify which source for language code takes precedence for this audio track. - // When you choose Follow input (FOLLOW_INPUT), the service uses the language code - // from the input track if it's present. If there's no languge code on the input - // track, the service uses the code that you specify in the setting Language code - // (languageCode or customLanguageCode). When you choose Use configured - // (USE_CONFIGURED), the service uses the language code that you specify. - LanguageCodeControl AudioLanguageCodeControl - - // Advanced audio normalization settings. Ignore these settings unless you need to - // comply with a loudness standard. - AudioNormalizationSettings *AudioNormalizationSettings + // Audio codec settings (CodecSettings) under (AudioDescriptions) contains the + // group of settings related to audio encoding. The settings in this group vary + // depending on the value that you choose for Audio codec (Codec). For each codec + // enum that you choose, define the corresponding settings object. The following + // lists the codec enum, settings object pairs. * AAC, AacSettings * MP2, + // Mp2Settings * MP3, Mp3Settings * WAV, WavSettings * AIFF, AiffSettings * AC3, + // Ac3Settings * EAC3, Eac3Settings * EAC3_ATMOS, Eac3AtmosSettings * VORBIS, + // VorbisSettings * OPUS, OpusSettings + CodecSettings *AudioCodecSettings // Specify the language for this audio output track. The service puts this language // code into your output audio track when you set Language code control @@ -265,17 +260,22 @@ type AudioDescription struct { // Streaming. CustomLanguageCode *string - // Specifies which audio data to use from each input. In the simplest case, specify - // an "Audio Selector":#inputs-audio_selector by name based on its order within - // each input. For example if you specify "Audio Selector 3", then the third audio - // selector will be used from each input. If an input does not have an "Audio - // Selector 3", then the audio selector marked as "default" in that input will be - // used. If there is no audio selector marked as "default", silence will be - // inserted for the duration of that input. Alternatively, an "Audio Selector - // Group":#inputs-audio_selector_group name may be specified, with similar - // default/silence behavior. If no audio_source_name is specified, then "Audio - // Selector 1" will be chosen automatically. - AudioSourceName *string + // Indicates the language of the audio output track. The ISO 639 language specified + // in the 'Language Code' drop down will be used when 'Follow Input Language Code' + // is not selected or when 'Follow Input Language Code' is selected but there is no + // ISO 639 language code specified by the input. + LanguageCode LanguageCode + + // Specify which source for language code takes precedence for this audio track. + // When you choose Follow input (FOLLOW_INPUT), the service uses the language code + // from the input track if it's present. If there's no languge code on the input + // track, the service uses the code that you specify in the setting Language code + // (languageCode or customLanguageCode). When you choose Use configured + // (USE_CONFIGURED), the service uses the language code that you specify. + LanguageCodeControl AudioLanguageCodeControl + + // Advanced audio remixing settings. + RemixSettings *RemixSettings // Specify a label for this output audio stream. For example, "English", "Director // commentary", or "track_2". For streaming outputs, MediaConvert passes this @@ -288,14 +288,6 @@ type AudioDescription struct { // comply with a loudness standard. type AudioNormalizationSettings struct { - // Content measuring above this level will be corrected to the target level. - // Content measuring below this level will not be corrected. - CorrectionGateLevel *int32 - - // When enabled the output audio is corrected using the chosen algorithm. If - // disabled, the audio will be measured but not adjusted. - AlgorithmControl AudioNormalizationAlgorithmControl - // Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: // Ungated loudness. A measurement of ungated average loudness for an entire piece // of content, suitable for measurement of short-form content under ATSC @@ -308,42 +300,53 @@ type AudioNormalizationSettings struct { // 7.1. Algorithm AudioNormalizationAlgorithm + // When enabled the output audio is corrected using the chosen algorithm. If + // disabled, the audio will be measured but not adjusted. + AlgorithmControl AudioNormalizationAlgorithmControl + + // Content measuring above this level will be corrected to the target level. + // Content measuring below this level will not be corrected. + CorrectionGateLevel *int32 + // If set to LOG, log each output's audio track loudness to a CSV file. LoudnessLogging AudioNormalizationLoudnessLogging + // If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio + // track loudness. + PeakCalculation AudioNormalizationPeakCalculation + // When you use Audio normalization (AudioNormalizationSettings), optionally use // this setting to specify a target loudness. If you don't specify a value here, // the encoder chooses a value for you, based on the algorithm that you choose for // Algorithm (algorithm). If you choose algorithm 1770-1, the encoder will choose // -24 LKFS; otherwise, the encoder will choose -23 LKFS. TargetLkfs *float64 - - // If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio - // track loudness. - PeakCalculation AudioNormalizationPeakCalculation } // Selector for Audio type AudioSelector struct { + // Selects a specific language code from within an audio source, using the ISO + // 639-2 or ISO 639-3 three-letter language code + CustomLanguageCode *string + + // Enable this setting on one audio selector to set it as the default for the job. + // The service uses this default for outputs where it can't find the specified + // input audio. If you don't set a default, those outputs have no audio. + DefaultSelection AudioDefaultSelection + + // Specifies audio data from an external file source. + ExternalAudioFileInput *string + // Selects a specific language code from within an audio source. LanguageCode LanguageCode + // Specifies a time delta in milliseconds to offset the audio from the input video. + Offset *int32 + // Selects a specific PID from within an audio source (e.g. 257 selects PID 0x101). Pids []*int32 - // Identify a track from the input audio to include in this selector by entering - // the track index number. To include several tracks in a single audio selector, - // specify multiple tracks as follows. Using the console, enter a comma-separated - // list. For examle, type "1,2,3" to include tracks 1 through 3. Specifying - // directly in your JSON job file, provide the track numbers in an array. For - // example, "tracks": [1,2,3]. - Tracks []*int32 - - // Selects a specific language code from within an audio source, using the ISO - // 639-2 or ISO 639-3 three-letter language code - CustomLanguageCode *string - // Use this setting for input streams that contain Dolby E, to have the service // extract specific program data from the track. To select multiple programs, // create multiple selectors with the same Track and different Program numbers. In @@ -355,17 +358,6 @@ type AudioSelector struct { // track. ProgramSelection *int32 - // Specifies a time delta in milliseconds to offset the audio from the input video. - Offset *int32 - - // Enable this setting on one audio selector to set it as the default for the job. - // The service uses this default for outputs where it can't find the specified - // input audio. If you don't set a default, those outputs have no audio. - DefaultSelection AudioDefaultSelection - - // Specifies audio data from an external file source. - ExternalAudioFileInput *string - // Use these settings to reorder the audio channels of one input to match those of // another input. This allows you to combine the two files into a single output, // one after the other. @@ -373,6 +365,14 @@ type AudioSelector struct { // Specifies the type of the audio selector. SelectorType AudioSelectorType + + // Identify a track from the input audio to include in this selector by entering + // the track index number. To include several tracks in a single audio selector, + // specify multiple tracks as follows. Using the console, enter a comma-separated + // list. For examle, type "1,2,3" to include tracks 1 through 3. Specifying + // directly in your JSON job file, provide the track numbers in an array. For + // example, "tracks": [1,2,3]. + Tracks []*int32 } // Group of Audio Selectors @@ -414,33 +414,27 @@ type Av1QvbrSettings struct { // AV1. type Av1Settings struct { - // Specify the GOP length (keyframe interval) in frames. With AV1, MediaConvert - // doesn't support GOP length in seconds. This value must be greater than zero and - // preferably equal to 1 + ((numberBFrames + 1) * x), where x is an integer value. - GopSize *float64 + // Adaptive quantization. Allows intra-frame quantizers to vary to improve visual + // quality. + AdaptiveQuantization Av1AdaptiveQuantization + + // If you are using the console, use the Framerate setting to specify the frame + // rate for this output. If you want to keep the same frame rate as the input + // video, choose Follow source. If you want to do frame rate conversion, choose a + // frame rate from the dropdown list or choose Custom. The framerates shown in the + // dropdown list are decimal approximations of fractions. If you choose Custom, + // specify your frame rate as a fraction. If you are creating your transcoding job + // specification as a JSON file without the console, use FramerateControl to + // specify which value the service uses for the frame rate for this output. Choose + // INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the + // input. Choose SPECIFIED if you want the service to use the frame rate you + // specify in the settings FramerateNumerator and FramerateDenominator. + FramerateControl Av1FramerateControl // Optional. Specify how the transcoder performs framerate conversion. The default // behavior is to use duplicate drop conversion. FramerateConversionAlgorithm Av1FramerateConversionAlgorithm - // 'With AV1 outputs, for rate control mode, MediaConvert supports only - // quality-defined variable bitrate (QVBR). You can''t use CBR or VBR.' - RateControlMode Av1RateControlMode - - // Settings for quality-defined variable bitrate encoding with the AV1 codec. - // Required when you set Rate control mode to QVBR. Not valid when you set Rate - // control mode to a value other than QVBR, or when you don't define Rate control - // mode. - QvbrSettings *Av1QvbrSettings - - // Maximum bitrate in bits/second. For example, enter five megabits per second as - // 5000000. Required when Rate control mode is QVBR. - MaxBitrate *int32 - - // Adjust quantization within each frame based on spatial variation of content - // complexity. - SpatialAdaptiveQuantization Av1SpatialAdaptiveQuantization - // When you use the API for transcode jobs that use frame rate conversion, specify // the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use // FramerateDenominator to specify the denominator of this fraction. In this @@ -449,13 +443,6 @@ type Av1Settings struct { // a decimal number for Framerate. In this example, specify 23.976. FramerateDenominator *int32 - // Specify the number of B-frames. With AV1, MediaConvert supports only 7 or 15. - NumberBFramesBetweenReferenceFrames *int32 - - // Adaptive quantization. Allows intra-frame quantizers to vary to improve visual - // quality. - AdaptiveQuantization Av1AdaptiveQuantization - // When you use the API for transcode jobs that use frame rate conversion, specify // the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use // FramerateNumerator to specify the numerator of this fraction. In this example, @@ -464,24 +451,37 @@ type Av1Settings struct { // number for Framerate. In this example, specify 23.976. FramerateNumerator *int32 + // Specify the GOP length (keyframe interval) in frames. With AV1, MediaConvert + // doesn't support GOP length in seconds. This value must be greater than zero and + // preferably equal to 1 + ((numberBFrames + 1) * x), where x is an integer value. + GopSize *float64 + + // Maximum bitrate in bits/second. For example, enter five megabits per second as + // 5000000. Required when Rate control mode is QVBR. + MaxBitrate *int32 + + // Specify the number of B-frames. With AV1, MediaConvert supports only 7 or 15. + NumberBFramesBetweenReferenceFrames *int32 + + // Settings for quality-defined variable bitrate encoding with the AV1 codec. + // Required when you set Rate control mode to QVBR. Not valid when you set Rate + // control mode to a value other than QVBR, or when you don't define Rate control + // mode. + QvbrSettings *Av1QvbrSettings + + // 'With AV1 outputs, for rate control mode, MediaConvert supports only + // quality-defined variable bitrate (QVBR). You can''t use CBR or VBR.' + RateControlMode Av1RateControlMode + // Specify the number of slices per picture. This value must be 1, 2, 4, 8, 16, or // 32. For progressive pictures, this value must be less than or equal to the // number of macroblock rows. For interlaced pictures, this value must be less than // or equal to half the number of macroblock rows. Slices *int32 - // If you are using the console, use the Framerate setting to specify the frame - // rate for this output. If you want to keep the same frame rate as the input - // video, choose Follow source. If you want to do frame rate conversion, choose a - // frame rate from the dropdown list or choose Custom. The framerates shown in the - // dropdown list are decimal approximations of fractions. If you choose Custom, - // specify your frame rate as a fraction. If you are creating your transcoding job - // specification as a JSON file without the console, use FramerateControl to - // specify which value the service uses for the frame rate for this output. Choose - // INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the - // input. Choose SPECIFIED if you want the service to use the frame rate you - // specify in the settings FramerateNumerator and FramerateDenominator. - FramerateControl Av1FramerateControl + // Adjust quantization within each frame based on spatial variation of content + // complexity. + SpatialAdaptiveQuantization Av1SpatialAdaptiveQuantization } // Settings for Avail Blanking @@ -495,44 +495,6 @@ type AvailBlanking struct { // Burn-In Destination Settings. type BurninDestinationSettings struct { - // A positive integer indicates the exact font size in points. Set to 0 for - // automatic font size selection. All burn-in and DVB-Sub font settings must match. - FontSize *int32 - - // Specifies the color of the rectangle behind the captions. All burn-in and - // DVB-Sub font settings must match. - BackgroundColor BurninSubtitleBackgroundColor - - // Specifies the vertical position of the caption relative to the top of the output - // in pixels. A value of 10 would result in the captions starting 10 pixels from - // the top of the output. If no explicit y_position is provided, the caption will - // be positioned towards the bottom of the output. This option is not valid for - // source captions that are STL, 608/embedded or teletext. These source settings - // are already pre-defined by the caption stream. All burn-in and DVB-Sub font - // settings must match. - YPosition *int32 - - // Only applies to jobs with input captions in Teletext or STL formats. Specify - // whether the spacing between letters in your captions is set by the captions grid - // or varies depending on letter width. Choose fixed grid to conform to the spacing - // specified in the captions file more accurately. Choose proportional to make the - // text easier to read if the captions are closed caption. - TeletextSpacing BurninSubtitleTeletextSpacing - - // Specifies the vertical offset of the shadow relative to the captions in pixels. - // A value of -2 would result in a shadow offset 2 pixels above the text. All - // burn-in and DVB-Sub font settings must match. - ShadowYOffset *int32 - - // Specifies the horizontal position of the caption relative to the left side of - // the output in pixels. A value of 10 would result in the captions starting 10 - // pixels from the left of the output. If no explicit x_position is provided, the - // horizontal caption position will be determined by the alignment parameter. This - // option is not valid for source captions that are STL, 608/embedded or teletext. - // These source settings are already pre-defined by the caption stream. All burn-in - // and DVB-Sub font settings must match. - XPosition *int32 - // If no explicit x_position or y_position is provided, setting alignment to // centered will place the captions at the bottom center of the output. Similarly, // setting a left alignment will align captions to the bottom left of the output. @@ -543,30 +505,25 @@ type BurninDestinationSettings struct { // All burn-in and DVB-Sub font settings must match. Alignment BurninSubtitleAlignment + // Specifies the color of the rectangle behind the captions. All burn-in and + // DVB-Sub font settings must match. + BackgroundColor BurninSubtitleBackgroundColor + // Specifies the opacity of the background rectangle. 255 is opaque; 0 is // transparent. Leaving this parameter blank is equivalent to setting it to 0 // (transparent). All burn-in and DVB-Sub font settings must match. BackgroundOpacity *int32 - // Specifies the horizontal offset of the shadow relative to the captions in - // pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All - // burn-in and DVB-Sub font settings must match. - ShadowXOffset *int32 - - // Specifies font outline size in pixels. This option is not valid for source - // captions that are either 608/embedded or teletext. These source settings are - // already pre-defined by the caption stream. All burn-in and DVB-Sub font settings - // must match. - OutlineSize *int32 + // Specifies the color of the burned-in captions. This option is not valid for + // source captions that are STL, 608/embedded or teletext. These source settings + // are already pre-defined by the caption stream. All burn-in and DVB-Sub font + // settings must match. + FontColor BurninSubtitleFontColor // Specifies the opacity of the burned-in captions. 255 is opaque; 0 is // transparent. All burn-in and DVB-Sub font settings must match. FontOpacity *int32 - // Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub - // font settings must match. - ShadowColor BurninSubtitleShadowColor - // Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and // DVB-Sub font settings must match. FontResolution *int32 @@ -577,27 +534,87 @@ type BurninDestinationSettings struct { // to help determine the appropriate font for rendering burn-in captions. FontScript FontScript + // A positive integer indicates the exact font size in points. Set to 0 for + // automatic font size selection. All burn-in and DVB-Sub font settings must match. + FontSize *int32 + // Specifies font outline color. This option is not valid for source captions that // are either 608/embedded or teletext. These source settings are already // pre-defined by the caption stream. All burn-in and DVB-Sub font settings must // match. OutlineColor BurninSubtitleOutlineColor + // Specifies font outline size in pixels. This option is not valid for source + // captions that are either 608/embedded or teletext. These source settings are + // already pre-defined by the caption stream. All burn-in and DVB-Sub font settings + // must match. + OutlineSize *int32 + + // Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub + // font settings must match. + ShadowColor BurninSubtitleShadowColor + // Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving // this parameter blank is equivalent to setting it to 0 (transparent). All burn-in // and DVB-Sub font settings must match. ShadowOpacity *int32 - // Specifies the color of the burned-in captions. This option is not valid for + // Specifies the horizontal offset of the shadow relative to the captions in + // pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All + // burn-in and DVB-Sub font settings must match. + ShadowXOffset *int32 + + // Specifies the vertical offset of the shadow relative to the captions in pixels. + // A value of -2 would result in a shadow offset 2 pixels above the text. All + // burn-in and DVB-Sub font settings must match. + ShadowYOffset *int32 + + // Only applies to jobs with input captions in Teletext or STL formats. Specify + // whether the spacing between letters in your captions is set by the captions grid + // or varies depending on letter width. Choose fixed grid to conform to the spacing + // specified in the captions file more accurately. Choose proportional to make the + // text easier to read if the captions are closed caption. + TeletextSpacing BurninSubtitleTeletextSpacing + + // Specifies the horizontal position of the caption relative to the left side of + // the output in pixels. A value of 10 would result in the captions starting 10 + // pixels from the left of the output. If no explicit x_position is provided, the + // horizontal caption position will be determined by the alignment parameter. This + // option is not valid for source captions that are STL, 608/embedded or teletext. + // These source settings are already pre-defined by the caption stream. All burn-in + // and DVB-Sub font settings must match. + XPosition *int32 + + // Specifies the vertical position of the caption relative to the top of the output + // in pixels. A value of 10 would result in the captions starting 10 pixels from + // the top of the output. If no explicit y_position is provided, the caption will + // be positioned towards the bottom of the output. This option is not valid for // source captions that are STL, 608/embedded or teletext. These source settings // are already pre-defined by the caption stream. All burn-in and DVB-Sub font // settings must match. - FontColor BurninSubtitleFontColor + YPosition *int32 } // Description of Caption output type CaptionDescription struct { + // Specifies which "Caption Selector":#inputs-caption_selector to use from each + // input when generating captions. The name should be of the format "Caption + // Selector ", which denotes that the Nth Caption Selector will be used from each + // input. + CaptionSelectorName *string + + // Specify the language for this captions output track. For most captions output + // formats, the encoder puts this language information in the output captions + // metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses + // this language information when automatically selecting the font script for + // rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO + // 639-3 code. For streaming outputs, you can also use any other code in the full + // RFC-5646 specification. Streaming outputs are those that are in one of the + // following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth + // Streaming. + CustomLanguageCode *string + // Specific settings required by destination type. Note that // burnin_destination_settings are not available if the source of the caption data // is Embedded or Teletext. @@ -616,23 +633,6 @@ type CaptionDescription struct { // player device. For outputs in other output groups, the service ignores this // setting. LanguageDescription *string - - // Specify the language for this captions output track. For most captions output - // formats, the encoder puts this language information in the output captions - // metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses - // this language information when automatically selecting the font script for - // rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO - // 639-3 code. For streaming outputs, you can also use any other code in the full - // RFC-5646 specification. Streaming outputs are those that are in one of the - // following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth - // Streaming. - CustomLanguageCode *string - - // Specifies which "Caption Selector":#inputs-caption_selector to use from each - // input when generating captions. The name should be of the format "Caption - // Selector ", which denotes that the Nth Caption Selector will be used from each - // input. - CaptionSelectorName *string } // Caption Description for preset @@ -674,6 +674,9 @@ type CaptionDescriptionPreset struct { // is Embedded or Teletext. type CaptionDestinationSettings struct { + // Burn-In Destination Settings. + BurninDestinationSettings *BurninDestinationSettings + // Specify the format for this set of captions on this output. The default format // is embedded without SCTE-20. Other options are embedded with SCTE-20, burn-in, // DVB-sub, IMSC, SCC, SRT, teletext, TTML, and web-VTT. If you are using SCTE-20, @@ -683,41 +686,30 @@ type CaptionDestinationSettings struct { // (EMBEDDED_PLUS_SCTE20). DestinationType CaptionDestinationType - // Settings specific to IMSC caption outputs. - ImscDestinationSettings *ImscDestinationSettings - - // Settings for Teletext caption output - TeletextDestinationSettings *TeletextDestinationSettings + // DVB-Sub Destination Settings + DvbSubDestinationSettings *DvbSubDestinationSettings // Settings specific to embedded/ancillary caption outputs, including 608/708 // Channel destination number. EmbeddedDestinationSettings *EmbeddedDestinationSettings - // DVB-Sub Destination Settings - DvbSubDestinationSettings *DvbSubDestinationSettings + // Settings specific to IMSC caption outputs. + ImscDestinationSettings *ImscDestinationSettings - // Burn-In Destination Settings. - BurninDestinationSettings *BurninDestinationSettings + // Settings for SCC caption output. + SccDestinationSettings *SccDestinationSettings + + // Settings for Teletext caption output + TeletextDestinationSettings *TeletextDestinationSettings // Settings specific to TTML caption outputs, including Pass style information // (TtmlStylePassthrough). TtmlDestinationSettings *TtmlDestinationSettings - - // Settings for SCC caption output. - SccDestinationSettings *SccDestinationSettings } // Set up captions in your outputs by first selecting them from your input here. type CaptionSelector struct { - // The specific language to extract from source. If input is SCTE-27, complete this - // field and/or PID to select the caption language to extract. If input is DVB-Sub - // and output is Burn-in or SMPTE-TT, complete this field and/or PID to select the - // caption language to extract. If input is DVB-Sub that is being passed through, - // omit this field (and PID field); there is no way to extract a specific language - // with pass-through captions. - LanguageCode LanguageCode - // The specific language to extract from source, using the ISO 639-2 or ISO 639-3 // three-letter language code. If input is SCTE-27, complete this field and/or PID // to select the caption language to extract. If input is DVB-Sub and output is @@ -727,6 +719,14 @@ type CaptionSelector struct { // pass-through captions. CustomLanguageCode *string + // The specific language to extract from source. If input is SCTE-27, complete this + // field and/or PID to select the caption language to extract. If input is DVB-Sub + // and output is Burn-in or SMPTE-TT, complete this field and/or PID to select the + // caption language to extract. If input is DVB-Sub that is being passed through, + // omit this field (and PID field); there is no way to extract a specific language + // with pass-through captions. + LanguageCode LanguageCode + // If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml file, // specify the URI of the input captions source file. If your input captions are // IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings. @@ -758,32 +758,32 @@ type CaptionSourceFramerate struct { // IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings. type CaptionSourceSettings struct { - // Settings specific to Teletext caption sources, including Page number. - TeletextSourceSettings *TeletextSourceSettings + // Settings for ancillary captions source. + AncillarySourceSettings *AncillarySourceSettings + + // DVB Sub Source Settings + DvbSubSourceSettings *DvbSubSourceSettings + + // Settings for embedded captions Source + EmbeddedSourceSettings *EmbeddedSourceSettings // If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file, // specify the URI of the input caption source file. If your caption source is IMSC // in an IMF package, use TrackSourceSettings instead of FileSoureSettings. FileSourceSettings *FileSourceSettings - // Settings specific to caption sources that are specified by track number. - // Currently, this is only IMSC captions in an IMF package. If your caption source - // is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of - // TrackSourceSettings. - TrackSourceSettings *TrackSourceSettings - // Use Source (SourceType) to identify the format of your input captions. The // service cannot auto-detect caption format. SourceType CaptionSourceType - // Settings for ancillary captions source. - AncillarySourceSettings *AncillarySourceSettings - - // DVB Sub Source Settings - DvbSubSourceSettings *DvbSubSourceSettings + // Settings specific to Teletext caption sources, including Page number. + TeletextSourceSettings *TeletextSourceSettings - // Settings for embedded captions Source - EmbeddedSourceSettings *EmbeddedSourceSettings + // Settings specific to caption sources that are specified by track number. + // Currently, this is only IMSC captions in an IMF package. If your caption source + // is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of + // TrackSourceSettings. + TrackSourceSettings *TrackSourceSettings } // Channel mapping (ChannelMapping) contains the group of fields that hold the @@ -819,31 +819,31 @@ type CmafAdditionalManifest struct { // Settings for CMAF encryption type CmafEncryptionSettings struct { - // Specify whether your DRM encryption key is static or from a key provider that - // follows the SPEKE standard. For more information about SPEKE, see - // https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html. - Type CmafKeyProviderType - - // Use these settings to set up encryption with a static key provider. - StaticKeyProvider *StaticKeyProvider + // This is a 128-bit, 16-byte hex value represented by a 32-character text string. + // If this parameter is not set then the Initialization Vector will follow the + // segment number by default. + ConstantInitializationVector *string // Specify the encryption scheme that you want the service to use when encrypting // your CMAF segments. Choose AES-CBC subsample (SAMPLE-AES) or AES_CTR (AES-CTR). EncryptionMethod CmafEncryptionType - // This is a 128-bit, 16-byte hex value represented by a 32-character text string. - // If this parameter is not set then the Initialization Vector will follow the - // segment number by default. - ConstantInitializationVector *string + // When you use DRM with CMAF outputs, choose whether the service writes the + // 128-bit encryption initialization vector in the HLS and DASH manifests. + InitializationVectorInManifest CmafInitializationVectorInManifest // If your output group type is CMAF, use these settings when doing DRM encryption // with a SPEKE-compliant key provider. If your output group type is HLS, DASH, or // Microsoft Smooth, use the SpekeKeyProvider settings instead. SpekeKeyProvider *SpekeKeyProviderCmaf - // When you use DRM with CMAF outputs, choose whether the service writes the - // 128-bit encryption initialization vector in the HLS and DASH manifests. - InitializationVectorInManifest CmafInitializationVectorInManifest + // Use these settings to set up encryption with a static key provider. + StaticKeyProvider *StaticKeyProvider + + // Specify whether your DRM encryption key is static or from a key provider that + // follows the SPEKE standard. For more information about SPEKE, see + // https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html. + Type CmafKeyProviderType } // Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to @@ -851,15 +851,6 @@ type CmafEncryptionSettings struct { // single video, audio, or caption output. type CmafGroupSettings struct { - // When you enable Precise segment duration in DASH manifests - // (writeSegmentTimelineInRepresentation), your DASH manifest shows precise segment - // durations. The segment duration information appears inside the SegmentTimeline - // element, inside SegmentTemplate at the Representation level. When this feature - // isn't enabled, the segment durations in your DASH manifest are approximate. The - // segment duration information appears in the duration attribute of the - // SegmentTemplate element. - WriteSegmentTimelineInRepresentation CmafWriteSegmentTimelineInRepresentation - // By default, the service creates one top-level .m3u8 HLS manifest and one top // -level .mpd DASH manifest for each CMAF output group in your job. These default // manifests reference every output in the output group. To create additional @@ -868,6 +859,33 @@ type CmafGroupSettings struct { // service creates one HLS manifest and one DASH manifest. AdditionalManifests []*CmafAdditionalManifest + // A partial URI prefix that will be put in the manifest file at the top level + // BaseURL element. Can be used if streams are delivered from a different URL than + // the manifest file. + BaseUrl *string + + // When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from + // saving media segments for later replay. + ClientCache CmafClientCache + + // Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist + // generation. + CodecSpecification CmafCodecSpecification + + // Use Destination (Destination) to specify the S3 output location and the output + // filename base. Destination accepts format identifiers. If you do not specify the + // base filename in the URI, the service will use the filename of the input file. + // If your job has multiple inputs, the service uses the filename of the first + // input file. + Destination *string + + // Settings associated with the destination. Will vary based on the type of + // destination + DestinationSettings *DestinationSettings + + // DRM settings. + Encryption *CmafEncryptionSettings + // Length of fragments to generate (in seconds). Fragment length must be compatible // with GOP size and Framerate. Note that fragments will end on the next keyframe // after this number of seconds, so actual fragment length may be longer. When Emit @@ -876,16 +894,29 @@ type CmafGroupSettings struct { // types. FragmentLength *int32 + // When set to GZIP, compresses HLS playlist. + ManifestCompression CmafManifestCompression + // Indicates whether the output manifest should use floating point values for // segment duration. ManifestDurationFormat CmafManifestDurationFormat - // Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of - // variant manifest. - StreamInfResolution CmafStreamInfResolution + // Minimum time of initially buffered media that is needed to ensure smooth + // playout. + MinBufferTime *int32 - // DRM settings. - Encryption *CmafEncryptionSettings + // Keep this setting at the default value of 0, unless you are troubleshooting a + // problem with how devices play back the end of your video asset. If you know that + // player devices are hanging on the final segment of your video because the length + // of your final segment is too short, use this setting to specify a minimum final + // segment length, in seconds. Choose a value that is greater than or equal to 1 + // and less than your segment length. When you specify a value for this setting, + // the encoder will combine any final segment that is shorter than the length that + // you specify with the previous segment. For example, your segment length is 3 + // seconds and your final segment is .5 seconds without a minimum final segment + // length; when you set the minimum final segment length to 1, your final segment + // is 3.5 seconds. + MinFinalSegmentLength *float64 // Specify whether your DASH profile is on-demand or main. When you choose Main // profile (MAIN_PROFILE), the service signals @@ -896,43 +927,11 @@ type CmafGroupSettings struct { // (SegmentControl) to Single file (SINGLE_FILE). MpdProfile CmafMpdProfile - // Settings associated with the destination. Will vary based on the type of - // destination - DestinationSettings *DestinationSettings - // When set to SINGLE_FILE, a single output file is generated, which is internally // segmented using the Fragment Length and Segment Length. When set to // SEGMENTED_FILES, separate segment files will be created. SegmentControl CmafSegmentControl - // When set to ENABLED, a DASH MPD manifest will be generated for this output. - WriteDashManifest CmafWriteDASHManifest - - // When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from - // saving media segments for later replay. - ClientCache CmafClientCache - - // When set to ENABLED, an Apple HLS manifest will be generated for this output. - WriteHlsManifest CmafWriteHLSManifest - - // A partial URI prefix that will be put in the manifest file at the top level - // BaseURL element. Can be used if streams are delivered from a different URL than - // the manifest file. - BaseUrl *string - - // Keep this setting at the default value of 0, unless you are troubleshooting a - // problem with how devices play back the end of your video asset. If you know that - // player devices are hanging on the final segment of your video because the length - // of your final segment is too short, use this setting to specify a minimum final - // segment length, in seconds. Choose a value that is greater than or equal to 1 - // and less than your segment length. When you specify a value for this setting, - // the encoder will combine any final segment that is shorter than the length that - // you specify with the previous segment. For example, your segment length is 3 - // seconds and your final segment is .5 seconds without a minimum final segment - // length; when you set the minimum final segment length to 1, your final segment - // is 3.5 seconds. - MinFinalSegmentLength *float64 - // Use this setting to specify the length, in seconds, of each individual CMAF // segment. This value applies to the whole package; that is, to every output in // the output group. Note that segments end on the first keyframe after this number @@ -943,43 +942,55 @@ type CmafGroupSettings struct { // for each output, each with the content of one segment. SegmentLength *int32 - // Use Destination (Destination) to specify the S3 output location and the output - // filename base. Destination accepts format identifiers. If you do not specify the - // base filename in the URI, the service will use the filename of the input file. - // If your job has multiple inputs, the service uses the filename of the first - // input file. - Destination *string + // Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of + // variant manifest. + StreamInfResolution CmafStreamInfResolution - // When set to GZIP, compresses HLS playlist. - ManifestCompression CmafManifestCompression + // When set to ENABLED, a DASH MPD manifest will be generated for this output. + WriteDashManifest CmafWriteDASHManifest - // Minimum time of initially buffered media that is needed to ensure smooth - // playout. - MinBufferTime *int32 + // When set to ENABLED, an Apple HLS manifest will be generated for this output. + WriteHlsManifest CmafWriteHLSManifest - // Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist - // generation. - CodecSpecification CmafCodecSpecification + // When you enable Precise segment duration in DASH manifests + // (writeSegmentTimelineInRepresentation), your DASH manifest shows precise segment + // durations. The segment duration information appears inside the SegmentTimeline + // element, inside SegmentTemplate at the Representation level. When this feature + // isn't enabled, the segment durations in your DASH manifest are approximate. The + // segment duration information appears in the duration attribute of the + // SegmentTemplate element. + WriteSegmentTimelineInRepresentation CmafWriteSegmentTimelineInRepresentation } // Settings for MP4 segments in CMAF type CmfcSettings struct { + // Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT + // to put SCTE-35 markers in this output at the insertion points that you specify + // in an ESAM XML document. Provide the document in the setting SCC XML (sccXml). + Scte35Esam CmfcScte35Esam + // Ignore this setting unless you have SCTE-35 markers in your input video file. // Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your // input to also appear in this output. Choose None (NONE) if you don't want those // SCTE-35 markers in this output. Scte35Source CmfcScte35Source - - // Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT - // to put SCTE-35 markers in this output at the insertion points that you specify - // in an ESAM XML document. Provide the document in the setting SCC XML (sccXml). - Scte35Esam CmfcScte35Esam } // Settings for color correction. type ColorCorrector struct { + // Brightness level. + Brightness *int32 + + // Specify the color space you want for this output. The service supports + // conversion between HDR formats, between SDR formats, from SDR to HDR, and from + // HDR to SDR. SDR to HDR conversion doesn't upgrade the dynamic range. The + // converted video has an HDR format, but visually appears the same as an + // unconverted output. HDR to SDR conversion uses Elemental tone mapping technology + // to approximate the outcome of manually regrading from HDR to SDR. + ColorSpaceConversion ColorSpaceConversion + // Contrast level. Contrast *int32 @@ -997,49 +1008,26 @@ type ColorCorrector struct { // https://docs.aws.amazon.com/console/mediaconvert/hdr. Hdr10Metadata *Hdr10Metadata - // Brightness level. - Brightness *int32 - - // Specify the color space you want for this output. The service supports - // conversion between HDR formats, between SDR formats, from SDR to HDR, and from - // HDR to SDR. SDR to HDR conversion doesn't upgrade the dynamic range. The - // converted video has an HDR format, but visually appears the same as an - // unconverted output. HDR to SDR conversion uses Elemental tone mapping technology - // to approximate the outcome of manually regrading from HDR to SDR. - ColorSpaceConversion ColorSpaceConversion + // Hue in degrees. + Hue *int32 // Saturation level. Saturation *int32 - - // Hue in degrees. - Hue *int32 } // Container specific settings. type ContainerSettings struct { - // Settings for TS segments in HLS - M3u8Settings *M3u8Settings - - // MXF settings - MxfSettings *MxfSettings - // Settings for MP4 segments in CMAF CmfcSettings *CmfcSettings - // Settings for F4v container - F4vSettings *F4vSettings - - // Settings for MP4 segments in DASH - MpdSettings *MpdSettings - - // Settings for MOV Container. - MovSettings *MovSettings - // Container for this output. Some containers require a container settings object. // If not specified, the default object will be created. Container ContainerType + // Settings for F4v container + F4vSettings *F4vSettings + // MPEG-2 TS container settings. These apply to outputs in a File output group when // the output's container (ContainerType) is MPEG-2 Transport Stream (M2TS). In // these assets, data is organized by the program map table (PMT). Each transport @@ -1052,9 +1040,21 @@ type ContainerSettings struct { // asset. M2tsSettings *M2tsSettings + // Settings for TS segments in HLS + M3u8Settings *M3u8Settings + + // Settings for MOV Container. + MovSettings *MovSettings + // Settings for MP4 container. You can create audio-only AAC outputs with this // container. Mp4Settings *Mp4Settings + + // Settings for MP4 segments in DASH + MpdSettings *MpdSettings + + // MXF settings + MxfSettings *MxfSettings } // Specify the details for each additional DASH manifest that you want the service @@ -1077,11 +1077,6 @@ type DashAdditionalManifest struct { // Specifies DRM settings for DASH outputs. type DashIsoEncryptionSettings struct { - // If your output group type is HLS, DASH, or Microsoft Smooth, use these settings - // when doing DRM encryption with a SPEKE-compliant key provider. If your output - // group type is CMAF, use the SpekeKeyProviderCmaf settings instead. - SpekeKeyProvider *SpekeKeyProvider - // This setting can improve the compatibility of your output with video players on // obsolete devices. It applies only to DASH H.264 outputs with DRM encryption. // Choose Unencrypted SEI (UNENCRYPTED_SEI) only to correct problems with playback @@ -1089,16 +1084,27 @@ type DashIsoEncryptionSettings struct { // choose Unencrypted SEI, for that output, the service will exclude the access // unit delimiter and will leave the SEI NAL units unencrypted. PlaybackDeviceCompatibility DashIsoPlaybackDeviceCompatibility + + // If your output group type is HLS, DASH, or Microsoft Smooth, use these settings + // when doing DRM encryption with a SPEKE-compliant key provider. If your output + // group type is CMAF, use the SpekeKeyProviderCmaf settings instead. + SpekeKeyProvider *SpekeKeyProvider } // Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to // DASH_ISO_GROUP_SETTINGS. type DashIsoGroupSettings struct { - // When set to SINGLE_FILE, a single output file is generated, which is internally - // segmented using the Fragment Length and Segment Length. When set to - // SEGMENTED_FILES, separate segment files will be created. - SegmentControl DashIsoSegmentControl + // By default, the service creates one .mpd DASH manifest for each DASH ISO output + // group in your job. This default manifest references every output in the output + // group. To create additional DASH manifests that reference a subset of the + // outputs in the output group, specify a list of them here. + AdditionalManifests []*DashAdditionalManifest + + // A partial URI prefix that will be put in the manifest (.mpd) file at the top + // level BaseURL element. Can be used if streams are delivered from a different URL + // than the manifest file. + BaseUrl *string // Use Destination (Destination) to specify the S3 output location and the output // filename base. Destination accepts format identifiers. If you do not specify the @@ -1107,45 +1113,12 @@ type DashIsoGroupSettings struct { // input file. Destination *string - // DRM settings. - Encryption *DashIsoEncryptionSettings - - // A partial URI prefix that will be put in the manifest (.mpd) file at the top - // level BaseURL element. Can be used if streams are delivered from a different URL - // than the manifest file. - BaseUrl *string - // Settings associated with the destination. Will vary based on the type of // destination DestinationSettings *DestinationSettings - // If you get an HTTP error in the 400 range when you play back your DASH output, - // enable this setting and run your transcoding job again. When you enable this - // setting, the service writes precise segment durations in the DASH manifest. The - // segment duration information appears inside the SegmentTimeline element, inside - // SegmentTemplate at the Representation level. When you don't enable this setting, - // the service writes approximate segment durations in your DASH manifest. - WriteSegmentTimelineInRepresentation DashIsoWriteSegmentTimelineInRepresentation - - // By default, the service creates one .mpd DASH manifest for each DASH ISO output - // group in your job. This default manifest references every output in the output - // group. To create additional DASH manifests that reference a subset of the - // outputs in the output group, specify a list of them here. - AdditionalManifests []*DashAdditionalManifest - - // Length of mpd segments to create (in seconds). Note that segments will end on - // the next keyframe after this number of seconds, so actual segment length may be - // longer. When Emit Single File is checked, the segmentation is internal to a - // single output file and it does not cause the creation of many output files as in - // other output types. - SegmentLength *int32 - - // Supports HbbTV specification as indicated - HbbtvCompliance DashIsoHbbtvCompliance - - // Minimum time of initially buffered media that is needed to ensure smooth - // playout. - MinBufferTime *int32 + // DRM settings. + Encryption *DashIsoEncryptionSettings // Length of fragments to generate (in seconds). Fragment length must be compatible // with GOP size and Framerate. Note that fragments will end on the next keyframe @@ -1155,6 +1128,13 @@ type DashIsoGroupSettings struct { // types. FragmentLength *int32 + // Supports HbbTV specification as indicated + HbbtvCompliance DashIsoHbbtvCompliance + + // Minimum time of initially buffered media that is needed to ensure smooth + // playout. + MinBufferTime *int32 + // Specify whether your DASH profile is on-demand or main. When you choose Main // profile (MAIN_PROFILE), the service signals // urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you @@ -1163,11 +1143,38 @@ type DashIsoGroupSettings struct { // On-demand, you must also set the output group setting Segment control // (SegmentControl) to Single file (SINGLE_FILE). MpdProfile DashIsoMpdProfile + + // When set to SINGLE_FILE, a single output file is generated, which is internally + // segmented using the Fragment Length and Segment Length. When set to + // SEGMENTED_FILES, separate segment files will be created. + SegmentControl DashIsoSegmentControl + + // Length of mpd segments to create (in seconds). Note that segments will end on + // the next keyframe after this number of seconds, so actual segment length may be + // longer. When Emit Single File is checked, the segmentation is internal to a + // single output file and it does not cause the creation of many output files as in + // other output types. + SegmentLength *int32 + + // If you get an HTTP error in the 400 range when you play back your DASH output, + // enable this setting and run your transcoding job again. When you enable this + // setting, the service writes precise segment durations in the DASH manifest. The + // segment duration information appears inside the SegmentTimeline element, inside + // SegmentTemplate at the Representation level. When you don't enable this setting, + // the service writes approximate segment durations in your DASH manifest. + WriteSegmentTimelineInRepresentation DashIsoWriteSegmentTimelineInRepresentation } // Settings for deinterlacer type Deinterlacer struct { + // Only applies when you set Deinterlacer (DeinterlaceMode) to Deinterlace + // (DEINTERLACE) or Adaptive (ADAPTIVE). Motion adaptive interpolate (INTERPOLATE) + // produces sharper pictures, while blend (BLEND) produces smoother motion. Use + // (INTERPOLATE_TICKER) OR (BLEND_TICKER) if your source file includes a ticker, + // such as a scrolling headline at the bottom of the frame. + Algorithm DeinterlaceAlgorithm + // * When set to NORMAL (default), the deinterlacer does not convert frames that // are tagged in metadata as progressive. It will only convert those that are // tagged as some other type. - When set to FORCE_ALL_FRAMES, the deinterlacer @@ -1178,13 +1185,6 @@ type Deinterlacer struct { // probably result in lower quality video. Control DeinterlacerControl - // Only applies when you set Deinterlacer (DeinterlaceMode) to Deinterlace - // (DEINTERLACE) or Adaptive (ADAPTIVE). Motion adaptive interpolate (INTERPOLATE) - // produces sharper pictures, while blend (BLEND) produces smoother motion. Use - // (INTERPOLATE_TICKER) OR (BLEND_TICKER) if your source file includes a ticker, - // such as a scrolling headline at the bottom of the frame. - Algorithm DeinterlaceAlgorithm - // Use Deinterlacer (DeinterlaceMode) to choose how the service will do // deinterlacing. Default is Deinterlace. - Deinterlace converts interlaced to // progressive. - Inverse telecine converts Hard Telecine 29.97i to progressive @@ -1203,6 +1203,10 @@ type DestinationSettings struct { // Settings for Dolby Vision type DolbyVision struct { + // Use these settings when you set DolbyVisionLevel6Mode to SPECIFY to override the + // MaxCLL and MaxFALL values in your input with new values. + L6Metadata *DolbyVisionLevel6Metadata + // Use Dolby Vision Mode to choose how the service will handle Dolby Vision MaxCLL // and MaxFALL properies. L6Mode DolbyVisionLevel6Mode @@ -1211,10 +1215,6 @@ type DolbyVision struct { // (PROFILE_5). Therefore, all of your inputs must contain Dolby Vision frame // interleaved data. Profile DolbyVisionProfile - - // Use these settings when you set DolbyVisionLevel6Mode to SPECIFY to override the - // MaxCLL and MaxFALL values in your input with new values. - L6Metadata *DolbyVisionLevel6Metadata } // Use these settings when you set DolbyVisionLevel6Mode to SPECIFY to override the @@ -1250,14 +1250,6 @@ type DvbNitSettings struct { // interval. type DvbSdtSettings struct { - // The number of milliseconds between instances of this table in the output - // transport stream. - SdtInterval *int32 - - // The service name placed in the service_descriptor in the Service Description - // Table. Maximum length is 256 characters. - ServiceName *string - // Selects method of inserting SDT information into output stream. "Follow input // SDT" copies SDT information from input stream to output stream. "Follow input // SDT if present" copies SDT information from input stream to output stream if SDT @@ -1266,6 +1258,14 @@ type DvbSdtSettings struct { // information. "No SDT" means output stream will not contain SDT information. OutputSdt OutputSdt + // The number of milliseconds between instances of this table in the output + // transport stream. + SdtInterval *int32 + + // The service name placed in the service_descriptor in the Service Description + // Table. Maximum length is 256 characters. + ServiceName *string + // The service provider name placed in the service_descriptor in the Service // Description Table. Maximum length is 256 characters. ServiceProviderName *string @@ -1274,34 +1274,54 @@ type DvbSdtSettings struct { // DVB-Sub Destination Settings type DvbSubDestinationSettings struct { + // If no explicit x_position or y_position is provided, setting alignment to + // centered will place the captions at the bottom center of the output. Similarly, + // setting a left alignment will align captions to the bottom left of the output. + // If x and y positions are given in conjunction with the alignment parameter, the + // font will be justified (either left or centered) relative to those coordinates. + // This option is not valid for source captions that are STL, 608/embedded or + // teletext. These source settings are already pre-defined by the caption stream. + // All burn-in and DVB-Sub font settings must match. + Alignment DvbSubtitleAlignment + + // Specifies the color of the rectangle behind the captions. All burn-in and + // DVB-Sub font settings must match. + BackgroundColor DvbSubtitleBackgroundColor + // Specifies the opacity of the background rectangle. 255 is opaque; 0 is // transparent. Leaving this parameter blank is equivalent to setting it to 0 // (transparent). All burn-in and DVB-Sub font settings must match. BackgroundOpacity *int32 - // Specifies font outline color. This option is not valid for source captions that - // are either 608/embedded or teletext. These source settings are already - // pre-defined by the caption stream. All burn-in and DVB-Sub font settings must - // match. - OutlineColor DvbSubtitleOutlineColor + // Specifies the color of the burned-in captions. This option is not valid for + // source captions that are STL, 608/embedded or teletext. These source settings + // are already pre-defined by the caption stream. All burn-in and DVB-Sub font + // settings must match. + FontColor DvbSubtitleFontColor + + // Specifies the opacity of the burned-in captions. 255 is opaque; 0 is + // transparent. All burn-in and DVB-Sub font settings must match. + FontOpacity *int32 // Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and // DVB-Sub font settings must match. FontResolution *int32 - // Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub - // font settings must match. - ShadowColor DvbSubtitleShadowColor - // Provide the font script, using an ISO 15924 script code, if the LanguageCode is // not sufficient for determining the script type. Where LanguageCode or // CustomLanguageCode is sufficient, use "AUTOMATIC" or leave unset. This is used // to help determine the appropriate font for rendering DVB-Sub captions. FontScript FontScript - // Specifies the opacity of the burned-in captions. 255 is opaque; 0 is - // transparent. All burn-in and DVB-Sub font settings must match. - FontOpacity *int32 + // A positive integer indicates the exact font size in points. Set to 0 for + // automatic font size selection. All burn-in and DVB-Sub font settings must match. + FontSize *int32 + + // Specifies font outline color. This option is not valid for source captions that + // are either 608/embedded or teletext. These source settings are already + // pre-defined by the caption stream. All burn-in and DVB-Sub font settings must + // match. + OutlineColor DvbSubtitleOutlineColor // Specifies font outline size in pixels. This option is not valid for source // captions that are either 608/embedded or teletext. These source settings are @@ -1309,14 +1329,36 @@ type DvbSubDestinationSettings struct { // must match. OutlineSize *int32 + // Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub + // font settings must match. + ShadowColor DvbSubtitleShadowColor + + // Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving + // this parameter blank is equivalent to setting it to 0 (transparent). All burn-in + // and DVB-Sub font settings must match. + ShadowOpacity *int32 + // Specifies the horizontal offset of the shadow relative to the captions in // pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All // burn-in and DVB-Sub font settings must match. ShadowXOffset *int32 - // Specifies the color of the rectangle behind the captions. All burn-in and - // DVB-Sub font settings must match. - BackgroundColor DvbSubtitleBackgroundColor + // Specifies the vertical offset of the shadow relative to the captions in pixels. + // A value of -2 would result in a shadow offset 2 pixels above the text. All + // burn-in and DVB-Sub font settings must match. + ShadowYOffset *int32 + + // Specify whether your DVB subtitles are standard or for hearing impaired. Choose + // hearing impaired if your subtitles include audio descriptions and dialogue. + // Choose standard if your subtitles include only dialogue. + SubtitlingType DvbSubtitlingType + + // Only applies to jobs with input captions in Teletext or STL formats. Specify + // whether the spacing between letters in your captions is set by the captions grid + // or varies depending on letter width. Choose fixed grid to conform to the spacing + // specified in the captions file more accurately. Choose proportional to make the + // text easier to read if the captions are closed caption. + TeletextSpacing DvbSubtitleTeletextSpacing // Specifies the horizontal position of the caption relative to the left side of // the output in pixels. A value of 10 would result in the captions starting 10 @@ -1327,16 +1369,6 @@ type DvbSubDestinationSettings struct { // and DVB-Sub font settings must match. XPosition *int32 - // If no explicit x_position or y_position is provided, setting alignment to - // centered will place the captions at the bottom center of the output. Similarly, - // setting a left alignment will align captions to the bottom left of the output. - // If x and y positions are given in conjunction with the alignment parameter, the - // font will be justified (either left or centered) relative to those coordinates. - // This option is not valid for source captions that are STL, 608/embedded or - // teletext. These source settings are already pre-defined by the caption stream. - // All burn-in and DVB-Sub font settings must match. - Alignment DvbSubtitleAlignment - // Specifies the vertical position of the caption relative to the top of the output // in pixels. A value of 10 would result in the captions starting 10 pixels from // the top of the output. If no explicit y_position is provided, the caption will @@ -1345,52 +1377,20 @@ type DvbSubDestinationSettings struct { // are already pre-defined by the caption stream. All burn-in and DVB-Sub font // settings must match. YPosition *int32 +} - // Only applies to jobs with input captions in Teletext or STL formats. Specify - // whether the spacing between letters in your captions is set by the captions grid - // or varies depending on letter width. Choose fixed grid to conform to the spacing - // specified in the captions file more accurately. Choose proportional to make the - // text easier to read if the captions are closed caption. - TeletextSpacing DvbSubtitleTeletextSpacing +// DVB Sub Source Settings +type DvbSubSourceSettings struct { - // Specifies the vertical offset of the shadow relative to the captions in pixels. - // A value of -2 would result in a shadow offset 2 pixels above the text. All - // burn-in and DVB-Sub font settings must match. - ShadowYOffset *int32 + // When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source + // content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, + // regardless of selectors. + Pid *int32 +} - // A positive integer indicates the exact font size in points. Set to 0 for - // automatic font size selection. All burn-in and DVB-Sub font settings must match. - FontSize *int32 - - // Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving - // this parameter blank is equivalent to setting it to 0 (transparent). All burn-in - // and DVB-Sub font settings must match. - ShadowOpacity *int32 - - // Specify whether your DVB subtitles are standard or for hearing impaired. Choose - // hearing impaired if your subtitles include audio descriptions and dialogue. - // Choose standard if your subtitles include only dialogue. - SubtitlingType DvbSubtitlingType - - // Specifies the color of the burned-in captions. This option is not valid for - // source captions that are STL, 608/embedded or teletext. These source settings - // are already pre-defined by the caption stream. All burn-in and DVB-Sub font - // settings must match. - FontColor DvbSubtitleFontColor -} - -// DVB Sub Source Settings -type DvbSubSourceSettings struct { - - // When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source - // content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, - // regardless of selectors. - Pid *int32 -} - -// Inserts DVB Time and Date Table (TDT) at the specified table repetition -// interval. -type DvbTdtSettings struct { +// Inserts DVB Time and Date Table (TDT) at the specified table repetition +// interval. +type DvbTdtSettings struct { // The number of milliseconds between instances of this table in the output // transport stream. @@ -1401,26 +1401,9 @@ type DvbTdtSettings struct { // value EAC3_ATMOS. type Eac3AtmosSettings struct { - // Specify a value for the following Dolby Atmos setting: Left total/Right total - // center mix (Lt/Rt center). MediaConvert uses this value for downmixing. How the - // service uses this value depends on the value that you choose for Stereo downmix - // (Eac3AtmosStereoDownmix). Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, and - // -6.0. - LtRtCenterMixLevel *float64 - - // Choose how the service does stereo downmixing. - StereoDownmix Eac3AtmosStereoDownmix - - // Specify a value for the following Dolby Atmos setting: Left only/Right only - // (Lo/Ro surround). MediaConvert uses this value for downmixing. How the service - // uses this value depends on the value that you choose for Stereo downmix - // (Eac3AtmosStereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The - // value -60 mutes the channel. - LoRoSurroundMixLevel *float64 - - // Specify whether your input audio has an additional center rear surround channel - // matrix encoded into your left and right surround channels. - SurroundExMode Eac3AtmosSurroundExMode + // Specify the average bitrate in bits per second. Valid values: 384k, 448k, 640k, + // 768k + Bitrate *int32 // Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For // more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E). @@ -1430,16 +1413,16 @@ type Eac3AtmosSettings struct { // (CODING_MODE_9_1_6). CodingMode Eac3AtmosCodingMode - // Specify the average bitrate in bits per second. Valid values: 384k, 448k, 640k, - // 768k - Bitrate *int32 + // Enable Dolby Dialogue Intelligence to adjust loudness based on dialogue + // analysis. + DialogueIntelligence Eac3AtmosDialogueIntelligence - // Specify a value for the following Dolby Atmos setting: Left total/Right total - // surround mix (Lt/Rt surround). MediaConvert uses this value for downmixing. How - // the service uses this value depends on the value that you choose for Stereo - // downmix (Eac3AtmosStereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. - // The value -60 mutes the channel. - LtRtSurroundMixLevel *float64 + // Specify the absolute peak level for a signal with dynamic range compression. + DynamicRangeCompressionLine Eac3AtmosDynamicRangeCompressionLine + + // Specify how the service limits the audio dynamic range when compressing the + // audio. + DynamicRangeCompressionRf Eac3AtmosDynamicRangeCompressionRf // Specify a value for the following Dolby Atmos setting: Left only/Right only // center mix (Lo/Ro center). MediaConvert uses this value for downmixing. How the @@ -1448,86 +1431,84 @@ type Eac3AtmosSettings struct { // -6.0. LoRoCenterMixLevel *float64 - // Enable Dolby Dialogue Intelligence to adjust loudness based on dialogue - // analysis. - DialogueIntelligence Eac3AtmosDialogueIntelligence + // Specify a value for the following Dolby Atmos setting: Left only/Right only + // (Lo/Ro surround). MediaConvert uses this value for downmixing. How the service + // uses this value depends on the value that you choose for Stereo downmix + // (Eac3AtmosStereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The + // value -60 mutes the channel. + LoRoSurroundMixLevel *float64 - // Specify the percentage of audio content that must be speech before the encoder - // uses the measured speech loudness as the overall program loudness. - SpeechThreshold *int32 + // Specify a value for the following Dolby Atmos setting: Left total/Right total + // center mix (Lt/Rt center). MediaConvert uses this value for downmixing. How the + // service uses this value depends on the value that you choose for Stereo downmix + // (Eac3AtmosStereoDownmix). Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, and + // -6.0. + LtRtCenterMixLevel *float64 - // Specify the absolute peak level for a signal with dynamic range compression. - DynamicRangeCompressionLine Eac3AtmosDynamicRangeCompressionLine + // Specify a value for the following Dolby Atmos setting: Left total/Right total + // surround mix (Lt/Rt surround). MediaConvert uses this value for downmixing. How + // the service uses this value depends on the value that you choose for Stereo + // downmix (Eac3AtmosStereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. + // The value -60 mutes the channel. + LtRtSurroundMixLevel *float64 // Choose how the service meters the loudness of your audio. MeteringMode Eac3AtmosMeteringMode - // Specify how the service limits the audio dynamic range when compressing the - // audio. - DynamicRangeCompressionRf Eac3AtmosDynamicRangeCompressionRf - // This value is always 48000. It represents the sample rate in Hz. SampleRate *int32 + + // Specify the percentage of audio content that must be speech before the encoder + // uses the measured speech loudness as the overall program loudness. + SpeechThreshold *int32 + + // Choose how the service does stereo downmixing. + StereoDownmix Eac3AtmosStereoDownmix + + // Specify whether your input audio has an additional center rear surround channel + // matrix encoded into your left and right surround channels. + SurroundExMode Eac3AtmosSurroundExMode } // Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the // value EAC3. type Eac3Settings struct { - // Choose how the service does stereo downmixing. This setting only applies if you - // keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the - // setting Coding mode (Eac3CodingMode). If you choose a different value for Coding - // mode, the service ignores Stereo downmix (Eac3StereoDownmix). - StereoDownmix Eac3StereoDownmix + // If set to ATTENUATE_3_DB, applies a 3 dB attenuation to the surround channels. + // Only used for 3/2 coding mode. + AttenuationControl Eac3AttenuationControl + + // Specify the average bitrate in bits per second. Valid bitrates depend on the + // coding mode. + Bitrate *int32 // Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For // more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E). BitstreamMode Eac3BitstreamMode - // Specify a value for the following Dolby Digital Plus setting: Left only/Right - // only (Lo/Ro surround). MediaConvert uses this value for downmixing. How the - // service uses this value depends on the value that you choose for Stereo downmix - // (Eac3StereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value - // -60 mutes the channel. This setting applies only if you keep the default value - // of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode - // (Eac3CodingMode). If you choose a different value for Coding mode, the service - // ignores Left only/Right only surround (loRoSurroundMixLevel). - LoRoSurroundMixLevel *float64 - - // Sets the dialnorm for the output. If blank and input audio is Dolby Digital - // Plus, dialnorm will be passed through. - Dialnorm *int32 - // Dolby Digital Plus coding mode. Determines number of channels. CodingMode Eac3CodingMode - // Specify a value for the following Dolby Digital Plus setting: Left total/Right - // total center mix (Lt/Rt center). MediaConvert uses this value for downmixing. - // How the service uses this value depends on the value that you choose for Stereo - // downmix (Eac3StereoDownmix). Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, - // -6.0, and -60. The value -60 mutes the channel. This setting applies only if you - // keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the - // setting Coding mode (Eac3CodingMode). If you choose a different value for Coding - // mode, the service ignores Left total/Right total center (ltRtCenterMixLevel). - LtRtCenterMixLevel *float64 + // Activates a DC highpass filter for all input channels. + DcFilter Eac3DcFilter - // Controls the amount of phase-shift applied to the surround channels. Only used - // for 3/2 coding mode. - PhaseControl Eac3PhaseControl + // Sets the dialnorm for the output. If blank and input audio is Dolby Digital + // Plus, dialnorm will be passed through. + Dialnorm *int32 - // If set to ATTENUATE_3_DB, applies a 3 dB attenuation to the surround channels. - // Only used for 3/2 coding mode. - AttenuationControl Eac3AttenuationControl + // Specify the absolute peak level for a signal with dynamic range compression. + DynamicRangeCompressionLine Eac3DynamicRangeCompressionLine - // When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the - // two channels. - SurroundMode Eac3SurroundMode + // Specify how the service limits the audio dynamic range when compressing the + // audio. + DynamicRangeCompressionRf Eac3DynamicRangeCompressionRf - // Activates a DC highpass filter for all input channels. - DcFilter Eac3DcFilter + // When encoding 3/2 audio, controls whether the LFE channel is enabled + LfeControl Eac3LfeControl - // This value is always 48000. It represents the sample rate in Hz. - SampleRate *int32 + // Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid + // with 3_2_LFE coding mode. + LfeFilter Eac3LfeFilter // Specify a value for the following Dolby Digital Plus setting: Left only/Right // only center mix (Lo/Ro center). MediaConvert uses this value for downmixing. How @@ -1539,19 +1520,35 @@ type Eac3Settings struct { // mode, the service ignores Left only/Right only center (loRoCenterMixLevel). LoRoCenterMixLevel *float64 - // When encoding 3/2 audio, sets whether an extra center back surround channel is - // matrix encoded into the left and right surround channels. - SurroundExMode Eac3SurroundExMode - - // Specify how the service limits the audio dynamic range when compressing the - // audio. - DynamicRangeCompressionRf Eac3DynamicRangeCompressionRf + // Specify a value for the following Dolby Digital Plus setting: Left only/Right + // only (Lo/Ro surround). MediaConvert uses this value for downmixing. How the + // service uses this value depends on the value that you choose for Stereo downmix + // (Eac3StereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value + // -60 mutes the channel. This setting applies only if you keep the default value + // of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode + // (Eac3CodingMode). If you choose a different value for Coding mode, the service + // ignores Left only/Right only surround (loRoSurroundMixLevel). + LoRoSurroundMixLevel *float64 - // Specify the absolute peak level for a signal with dynamic range compression. - DynamicRangeCompressionLine Eac3DynamicRangeCompressionLine + // Specify a value for the following Dolby Digital Plus setting: Left total/Right + // total center mix (Lt/Rt center). MediaConvert uses this value for downmixing. + // How the service uses this value depends on the value that you choose for Stereo + // downmix (Eac3StereoDownmix). Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, + // -6.0, and -60. The value -60 mutes the channel. This setting applies only if you + // keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the + // setting Coding mode (Eac3CodingMode). If you choose a different value for Coding + // mode, the service ignores Left total/Right total center (ltRtCenterMixLevel). + LtRtCenterMixLevel *float64 - // When encoding 3/2 audio, controls whether the LFE channel is enabled - LfeControl Eac3LfeControl + // Specify a value for the following Dolby Digital Plus setting: Left total/Right + // total surround mix (Lt/Rt surround). MediaConvert uses this value for + // downmixing. How the service uses this value depends on the value that you choose + // for Stereo downmix (Eac3StereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, + // and -60. The value -60 mutes the channel. This setting applies only if you keep + // the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting + // Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, + // the service ignores Left total/Right total surround (ltRtSurroundMixLevel). + LtRtSurroundMixLevel *float64 // When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or // DolbyE decoder that supplied this audio data. If audio was not supplied from one @@ -1564,29 +1561,39 @@ type Eac3Settings struct { // output as the system alternates between passthrough and encoding. PassthroughControl Eac3PassthroughControl - // Specify a value for the following Dolby Digital Plus setting: Left total/Right - // total surround mix (Lt/Rt surround). MediaConvert uses this value for - // downmixing. How the service uses this value depends on the value that you choose - // for Stereo downmix (Eac3StereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, - // and -60. The value -60 mutes the channel. This setting applies only if you keep - // the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting - // Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, - // the service ignores Left total/Right total surround (ltRtSurroundMixLevel). - LtRtSurroundMixLevel *float64 + // Controls the amount of phase-shift applied to the surround channels. Only used + // for 3/2 coding mode. + PhaseControl Eac3PhaseControl - // Specify the average bitrate in bits per second. Valid bitrates depend on the - // coding mode. - Bitrate *int32 + // This value is always 48000. It represents the sample rate in Hz. + SampleRate *int32 - // Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid - // with 3_2_LFE coding mode. - LfeFilter Eac3LfeFilter + // Choose how the service does stereo downmixing. This setting only applies if you + // keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the + // setting Coding mode (Eac3CodingMode). If you choose a different value for Coding + // mode, the service ignores Stereo downmix (Eac3StereoDownmix). + StereoDownmix Eac3StereoDownmix + + // When encoding 3/2 audio, sets whether an extra center back surround channel is + // matrix encoded into the left and right surround channels. + SurroundExMode Eac3SurroundExMode + + // When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the + // two channels. + SurroundMode Eac3SurroundMode } // Settings specific to embedded/ancillary caption outputs, including 608/708 // Channel destination number. type EmbeddedDestinationSettings struct { + // Ignore this setting unless your input captions are SCC format and your output + // captions are embedded in the video stream. Specify a CC number for each captions + // channel in this output. If you have two channels, choose CC numbers that aren't + // in the same field. For example, choose 1 and 3. For more information, see + // https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded. + Destination608ChannelNumber *int32 + // Ignore this setting unless your input captions are SCC format and you want both // 608 and 708 captions embedded in your output stream. Optionally, specify the 708 // service number for each output captions channel. Choose a different number for @@ -1597,37 +1604,30 @@ type EmbeddedDestinationSettings struct { // (destination608ChannelNumber) for the 708 service number. For more information, // see https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded. Destination708ServiceNumber *int32 - - // Ignore this setting unless your input captions are SCC format and your output - // captions are embedded in the video stream. Specify a CC number for each captions - // channel in this output. If you have two channels, choose CC numbers that aren't - // in the same field. For example, choose 1 and 3. For more information, see - // https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded. - Destination608ChannelNumber *int32 -} +} // Settings for embedded captions Source type EmbeddedSourceSettings struct { - // Specifies the video track index used for extracting captions. The system only - // supports one input video track, so this should always be set to '1'. - Source608TrackNumber *int32 + // Specify whether this set of input captions appears in your outputs in both 608 + // and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the + // captions data in two ways: it passes the 608 data through using the 608 + // compatibility bytes fields of the 708 wrapper, and it also translates the 608 + // data into 708. + Convert608To708 EmbeddedConvert608To708 // Specifies the 608/708 channel number within the video track from which to // extract captions. Unused for passthrough. Source608ChannelNumber *int32 + // Specifies the video track index used for extracting captions. The system only + // supports one input video track, so this should always be set to '1'. + Source608TrackNumber *int32 + // By default, the service terminates any unterminated captions at the end of each // input. If you want the caption to continue onto your next input, disable this // setting. TerminateCaptions EmbeddedTerminateCaptions - - // Specify whether this set of input captions appears in your outputs in both 608 - // and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the - // captions data in two ways: it passes the 608 data through using the 608 - // compatibility bytes fields of the 708 wrapper, and it also translates the 608 - // data into 708. - Convert608To708 EmbeddedConvert608To708 } // Describes an account-specific API endpoint. @@ -1651,10 +1651,10 @@ type EsamManifestConfirmConditionNotification struct { // you can ignore these settings. type EsamSettings struct { - // Specifies an ESAM SignalProcessingNotification XML as per - // OC-SP-ESAM-API-I03-131025. The transcoder uses the signal processing - // instructions that you provide in the setting SCC XML (sccXml). - SignalProcessingNotification *EsamSignalProcessingNotification + // Specifies an ESAM ManifestConfirmConditionNotification XML as per + // OC-SP-ESAM-API-I03-131025. The transcoder uses the manifest conditioning + // instructions that you provide in the setting MCC XML (mccXml). + ManifestConfirmConditionNotification *EsamManifestConfirmConditionNotification // Specifies the stream distance, in milliseconds, between the SCTE 35 messages // that the transcoder places and the splice points that they refer to. If the time @@ -1662,10 +1662,10 @@ type EsamSettings struct { // then the transcoder places the SCTE-35 marker at the beginning of the stream. ResponseSignalPreroll *int32 - // Specifies an ESAM ManifestConfirmConditionNotification XML as per - // OC-SP-ESAM-API-I03-131025. The transcoder uses the manifest conditioning - // instructions that you provide in the setting MCC XML (mccXml). - ManifestConfirmConditionNotification *EsamManifestConfirmConditionNotification + // Specifies an ESAM SignalProcessingNotification XML as per + // OC-SP-ESAM-API-I03-131025. The transcoder uses the signal processing + // instructions that you provide in the setting SCC XML (sccXml). + SignalProcessingNotification *EsamSignalProcessingNotification } // ESAM SignalProcessingNotification data defined by OC-SP-ESAM-API-I03-131025. @@ -1712,12 +1712,12 @@ type FileGroupSettings struct { // in an IMF package, use TrackSourceSettings instead of FileSoureSettings. type FileSourceSettings struct { - // External caption file used for loading captions. Accepted file extensions are - // 'scc', 'ttml', 'dfxp', 'stl', 'srt', 'xml', and 'smi'. - SourceFile *string - - // Specifies a time delta in seconds to offset the captions from the source file. - TimeDelta *int32 + // Specify whether this set of input captions appears in your outputs in both 608 + // and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the + // captions data in two ways: it passes the 608 data through using the 608 + // compatibility bytes fields of the 708 wrapper, and it also translates the 608 + // data into 708. + Convert608To708 FileSourceConvert608To708 // Ignore this setting unless your input captions format is SCC. To have the // service compensate for differing frame rates between your input captions and @@ -1728,12 +1728,12 @@ type FileSourceSettings struct { // for 29.97 fps. Framerate *CaptionSourceFramerate - // Specify whether this set of input captions appears in your outputs in both 608 - // and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the - // captions data in two ways: it passes the 608 data through using the 608 - // compatibility bytes fields of the 708 wrapper, and it also translates the 608 - // data into 708. - Convert608To708 FileSourceConvert608To708 + // External caption file used for loading captions. Accepted file extensions are + // 'scc', 'ttml', 'dfxp', 'stl', 'srt', 'xml', and 'smi'. + SourceFile *string + + // Specifies a time delta in seconds to offset the captions from the source file. + TimeDelta *int32 } // Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the @@ -1744,22 +1744,22 @@ type FrameCaptureSettings struct { // every framerateDenominator/framerateNumerator seconds. For example, settings of // framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per // second) will capture the first frame, then 1 frame every 3s. Files will be named - // as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded - // to 7 decimal places. - FramerateNumerator *int32 - - // JPEG Quality - a higher value equals higher quality. - Quality *int32 + // as filename.n.jpg where n is the 0-based sequence number of each Capture. + FramerateDenominator *int32 // Frame capture will encode the first frame of the output stream, then one frame // every framerateDenominator/framerateNumerator seconds. For example, settings of // framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per // second) will capture the first frame, then 1 frame every 3s. Files will be named - // as filename.n.jpg where n is the 0-based sequence number of each Capture. - FramerateDenominator *int32 + // as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded + // to 7 decimal places. + FramerateNumerator *int32 // Maximum number of captures (encoded jpg output files). MaxCaptures *int32 + + // JPEG Quality - a higher value equals higher quality. + Quality *int32 } // Settings for quality-defined variable bitrate encoding with the H.264 codec. @@ -1768,13 +1768,13 @@ type FrameCaptureSettings struct { // mode. type H264QvbrSettings struct { - // Optional. Specify a value here to set the QVBR quality to a level that is - // between whole numbers. For example, if you want your QVBR quality level to be - // 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33. - // MediaConvert rounds your QVBR quality level to the nearest third of a whole - // number. For example, if you set qvbrQualityLevel to 7 and you set - // qvbrQualityLevelFineTune to .25, your actual QVBR quality level is 7.33. - QvbrQualityLevelFineTune *float64 + // Use this setting only when Rate control mode is QVBR and Quality tuning level is + // Multi-pass HQ. For Max average bitrate values suited to the complexity of your + // input video, the service limits the average bitrate of the video part of this + // output to the value that you choose. That is, the total size of the video + // element is less than or equal to the value you set multiplied by the number of + // seconds of encoded output. + MaxAverageBitrate *int32 // Required when you use QVBR rate control mode. That is, when you specify // qvbrSettings within h264Settings. Specify the general target quality level for @@ -1786,25 +1786,98 @@ type H264QvbrSettings struct { // 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33. QvbrQualityLevel *int32 - // Use this setting only when Rate control mode is QVBR and Quality tuning level is - // Multi-pass HQ. For Max average bitrate values suited to the complexity of your - // input video, the service limits the average bitrate of the video part of this - // output to the value that you choose. That is, the total size of the video - // element is less than or equal to the value you set multiplied by the number of - // seconds of encoded output. - MaxAverageBitrate *int32 + // Optional. Specify a value here to set the QVBR quality to a level that is + // between whole numbers. For example, if you want your QVBR quality level to be + // 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33. + // MediaConvert rounds your QVBR quality level to the nearest third of a whole + // number. For example, if you set qvbrQualityLevel to 7 and you set + // qvbrQualityLevelFineTune to .25, your actual QVBR quality level is 7.33. + QvbrQualityLevelFineTune *float64 } // Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the // value H_264. type H264Settings struct { + // Adaptive quantization. Allows intra-frame quantizers to vary to improve visual + // quality. + AdaptiveQuantization H264AdaptiveQuantization + + // Specify the average bitrate in bits per second. Required for VBR and CBR. For MS + // Smooth outputs, bitrates must be unique when rounded down to the nearest + // multiple of 1000. + Bitrate *int32 + + // Specify an H.264 level that is consistent with your output video settings. If + // you aren't sure what level to specify, choose Auto (AUTO). + CodecLevel H264CodecLevel + + // H.264 Profile. High 4:2:2 and 10-bit profiles are only available with the AVC-I + // License. + CodecProfile H264CodecProfile + + // Choose Adaptive to improve subjective video quality for high-motion content. + // This will cause the service to use fewer B-frames (which infer information based + // on other frames) for high-motion portions of the video and more B-frames for + // low-motion portions. The maximum number of B-frames is limited by the value you + // provide for the setting B frames between reference frames + // (numberBFramesBetweenReferenceFrames). + DynamicSubGop H264DynamicSubGop + + // Entropy encoding mode. Use CABAC (must be in Main or High profile) or CAVLC. + EntropyEncoding H264EntropyEncoding + + // Choosing FORCE_FIELD disables PAFF encoding for interlaced outputs. + FieldEncoding H264FieldEncoding + + // Adjust quantization within each frame to reduce flicker or 'pop' on I-frames. + FlickerAdaptiveQuantization H264FlickerAdaptiveQuantization + + // If you are using the console, use the Framerate setting to specify the frame + // rate for this output. If you want to keep the same frame rate as the input + // video, choose Follow source. If you want to do frame rate conversion, choose a + // frame rate from the dropdown list or choose Custom. The framerates shown in the + // dropdown list are decimal approximations of fractions. If you choose Custom, + // specify your frame rate as a fraction. If you are creating your transcoding job + // specification as a JSON file without the console, use FramerateControl to + // specify which value the service uses for the frame rate for this output. Choose + // INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the + // input. Choose SPECIFIED if you want the service to use the frame rate you + // specify in the settings FramerateNumerator and FramerateDenominator. + FramerateControl H264FramerateControl + + // Optional. Specify how the transcoder performs framerate conversion. The default + // behavior is to use duplicate drop conversion. + FramerateConversionAlgorithm H264FramerateConversionAlgorithm + + // When you use the API for transcode jobs that use frame rate conversion, specify + // the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use + // FramerateDenominator to specify the denominator of this fraction. In this + // example, use 1001 for the value of FramerateDenominator. When you use the + // console for transcode jobs that use frame rate conversion, provide the value as + // a decimal number for Framerate. In this example, specify 23.976. + FramerateDenominator *int32 + + // Frame rate numerator - frame rate is a fraction, e.g. 24000 / 1001 = 23.976 fps. + FramerateNumerator *int32 + + // If enable, use reference B frames for GOP structures that have B frames > 1. + GopBReference H264GopBReference + + // Frequency of closed GOPs. In streaming applications, it is recommended that this + // be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly + // as possible. Setting this value to 0 will break output segmenting. + GopClosedCadence *int32 + // GOP Length (keyframe interval) in frames or seconds. Must be greater than zero. GopSize *float64 - // Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as - // 25fps, and audio is sped up correspondingly. - SlowPal H264SlowPal + // Indicates if the GOP Size in H264 is specified in frames or seconds. If seconds + // the system will convert the GOP Size into a frame count at run time. + GopSizeUnits H264GopSizeUnits + + // Percentage of the buffer that should initially be filled (HRD buffer model). + HrdBufferInitialFillPercentage *int32 // Size of buffer (HRD buffer model) in bits. For example, enter five megabits as // 5000000. @@ -1827,22 +1900,42 @@ type H264Settings struct { // polarity, depending on which of the Follow options you chose. InterlaceMode H264InterlaceMode + // Maximum bitrate in bits/second. For example, enter five megabits per second as + // 5000000. Required when Rate control mode is QVBR. + MaxBitrate *int32 + + // Enforces separation between repeated (cadence) I-frames and I-frames inserted by + // Scene Change Detection. If a scene change I-frame is within I-interval frames of + // a cadence I-frame, the GOP is shrunk and/or stretched to the scene change + // I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. + // The normal cadence resumes for the next GOP. This setting is only used when + // Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + + // Min-I-interval - 1 + MinIInterval *int32 + // Number of B-frames between reference frames. NumberBFramesBetweenReferenceFrames *int32 - // If enable, use reference B frames for GOP structures that have B frames > 1. - GopBReference H264GopBReference + // Number of reference frames to use. The encoder may use more than requested if + // using B-frames and/or interlaced encoding. + NumberReferenceFrames *int32 - // Produces a bitstream compliant with SMPTE RP-2027. - Syntax H264Syntax + // Optional. Specify how the service determines the pixel aspect ratio (PAR) for + // this output. The default behavior, Follow source (INITIALIZE_FROM_SOURCE), uses + // the PAR from your input video for your output. To specify a different PAR in the + // console, choose any value other than Follow source. To specify a different PAR + // by editing the JSON job specification, choose SPECIFIED. When you choose + // SPECIFIED for this setting, you must also specify values for the parNumerator + // and parDenominator settings. + ParControl H264ParControl - // Choose Adaptive to improve subjective video quality for high-motion content. - // This will cause the service to use fewer B-frames (which infer information based - // on other frames) for high-motion portions of the video and more B-frames for - // low-motion portions. The maximum number of B-frames is limited by the value you - // provide for the setting B frames between reference frames - // (numberBFramesBetweenReferenceFrames). - DynamicSubGop H264DynamicSubGop + // Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the + // console, this corresponds to any value other than Follow source. When you + // specify an output pixel aspect ratio (PAR) that is different from your input + // video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC + // widescreen, you would specify the ratio 40:33. In this example, the value for + // parDenominator is 33. + ParDenominator *int32 // Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the // console, this corresponds to any value other than Follow source. When you @@ -1852,25 +1945,23 @@ type H264Settings struct { // parNumerator is 40. ParNumerator *int32 - // Choosing FORCE_FIELD disables PAFF encoding for interlaced outputs. - FieldEncoding H264FieldEncoding - - // H.264 Profile. High 4:2:2 and 10-bit profiles are only available with the AVC-I - // License. - CodecProfile H264CodecProfile + // Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want + // to trade off encoding speed for output video quality. The default behavior is + // faster, lower quality, single-pass encoding. + QualityTuningLevel H264QualityTuningLevel - // Number of slices per picture. Must be less than or equal to the number of - // macroblock rows for progressive pictures, and less than or equal to half the - // number of macroblock rows for interlaced pictures. - Slices *int32 + // Settings for quality-defined variable bitrate encoding with the H.264 codec. + // Required when you set Rate control mode to QVBR. Not valid when you set Rate + // control mode to a value other than QVBR, or when you don't define Rate control + // mode. + QvbrSettings *H264QvbrSettings - // Maximum bitrate in bits/second. For example, enter five megabits per second as - // 5000000. Required when Rate control mode is QVBR. - MaxBitrate *int32 + // Use this setting to specify whether this output has a variable bitrate (VBR), + // constant bitrate (CBR) or quality-defined variable bitrate (QVBR). + RateControlMode H264RateControlMode - // Indicates if the GOP Size in H264 is specified in frames or seconds. If seconds - // the system will convert the GOP Size into a frame count at run time. - GopSizeUnits H264GopSizeUnits + // Places a PPS header on each encoded picture, even if repeated. + RepeatPps H264RepeatPps // Enable this setting to insert I-frames at scene changes that the service // automatically detects. This improves video quality and is enabled by default. If @@ -1879,45 +1970,25 @@ type H264Settings struct { // https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr. SceneChangeDetect H264SceneChangeDetect - // Places a PPS header on each encoded picture, even if repeated. - RepeatPps H264RepeatPps - - // Inserts timecode for each frame as 4 bytes of an unregistered SEI message. - UnregisteredSeiTimecode H264UnregisteredSeiTimecode - - // Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want - // to trade off encoding speed for output video quality. The default behavior is - // faster, lower quality, single-pass encoding. - QualityTuningLevel H264QualityTuningLevel - - // Entropy encoding mode. Use CABAC (must be in Main or High profile) or CAVLC. - EntropyEncoding H264EntropyEncoding - - // Percentage of the buffer that should initially be filled (HRD buffer model). - HrdBufferInitialFillPercentage *int32 - - // Optional. Specify how the transcoder performs framerate conversion. The default - // behavior is to use duplicate drop conversion. - FramerateConversionAlgorithm H264FramerateConversionAlgorithm - - // Use this setting to specify whether this output has a variable bitrate (VBR), - // constant bitrate (CBR) or quality-defined variable bitrate (QVBR). - RateControlMode H264RateControlMode + // Number of slices per picture. Must be less than or equal to the number of + // macroblock rows for progressive pictures, and less than or equal to half the + // number of macroblock rows for interlaced pictures. + Slices *int32 - // Number of reference frames to use. The encoder may use more than requested if - // using B-frames and/or interlaced encoding. - NumberReferenceFrames *int32 + // Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as + // 25fps, and audio is sped up correspondingly. + SlowPal H264SlowPal - // Adjust quantization within each frame based on temporal variation of content - // complexity. - TemporalAdaptiveQuantization H264TemporalAdaptiveQuantization + // Softness. Selects quantizer matrix, larger values reduce high-frequency content + // in the encoded image. + Softness *int32 // Adjust quantization within each frame based on spatial variation of content // complexity. SpatialAdaptiveQuantization H264SpatialAdaptiveQuantization - // Adjust quantization within each frame to reduce flicker or 'pop' on I-frames. - FlickerAdaptiveQuantization H264FlickerAdaptiveQuantization + // Produces a bitstream compliant with SMPTE RP-2027. + Syntax H264Syntax // This field applies only if the Streams > Advanced > Framerate (framerate) field // is set to 29.970. This field works with the Streams > Advanced > Preprocessors > @@ -1928,83 +1999,12 @@ type H264Settings struct { // output to 29.97i. Telecine H264Telecine - // Optional. Specify how the service determines the pixel aspect ratio (PAR) for - // this output. The default behavior, Follow source (INITIALIZE_FROM_SOURCE), uses - // the PAR from your input video for your output. To specify a different PAR in the - // console, choose any value other than Follow source. To specify a different PAR - // by editing the JSON job specification, choose SPECIFIED. When you choose - // SPECIFIED for this setting, you must also specify values for the parNumerator - // and parDenominator settings. - ParControl H264ParControl - - // Settings for quality-defined variable bitrate encoding with the H.264 codec. - // Required when you set Rate control mode to QVBR. Not valid when you set Rate - // control mode to a value other than QVBR, or when you don't define Rate control - // mode. - QvbrSettings *H264QvbrSettings - - // Softness. Selects quantizer matrix, larger values reduce high-frequency content - // in the encoded image. - Softness *int32 - - // Frame rate numerator - frame rate is a fraction, e.g. 24000 / 1001 = 23.976 fps. - FramerateNumerator *int32 - - // Specify the average bitrate in bits per second. Required for VBR and CBR. For MS - // Smooth outputs, bitrates must be unique when rounded down to the nearest - // multiple of 1000. - Bitrate *int32 - - // Frequency of closed GOPs. In streaming applications, it is recommended that this - // be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly - // as possible. Setting this value to 0 will break output segmenting. - GopClosedCadence *int32 - - // Specify an H.264 level that is consistent with your output video settings. If - // you aren't sure what level to specify, choose Auto (AUTO). - CodecLevel H264CodecLevel - - // Adaptive quantization. Allows intra-frame quantizers to vary to improve visual - // quality. - AdaptiveQuantization H264AdaptiveQuantization - - // When you use the API for transcode jobs that use frame rate conversion, specify - // the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use - // FramerateDenominator to specify the denominator of this fraction. In this - // example, use 1001 for the value of FramerateDenominator. When you use the - // console for transcode jobs that use frame rate conversion, provide the value as - // a decimal number for Framerate. In this example, specify 23.976. - FramerateDenominator *int32 - - // If you are using the console, use the Framerate setting to specify the frame - // rate for this output. If you want to keep the same frame rate as the input - // video, choose Follow source. If you want to do frame rate conversion, choose a - // frame rate from the dropdown list or choose Custom. The framerates shown in the - // dropdown list are decimal approximations of fractions. If you choose Custom, - // specify your frame rate as a fraction. If you are creating your transcoding job - // specification as a JSON file without the console, use FramerateControl to - // specify which value the service uses for the frame rate for this output. Choose - // INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the - // input. Choose SPECIFIED if you want the service to use the frame rate you - // specify in the settings FramerateNumerator and FramerateDenominator. - FramerateControl H264FramerateControl - - // Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the - // console, this corresponds to any value other than Follow source. When you - // specify an output pixel aspect ratio (PAR) that is different from your input - // video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC - // widescreen, you would specify the ratio 40:33. In this example, the value for - // parDenominator is 33. - ParDenominator *int32 + // Adjust quantization within each frame based on temporal variation of content + // complexity. + TemporalAdaptiveQuantization H264TemporalAdaptiveQuantization - // Enforces separation between repeated (cadence) I-frames and I-frames inserted by - // Scene Change Detection. If a scene change I-frame is within I-interval frames of - // a cadence I-frame, the GOP is shrunk and/or stretched to the scene change - // I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. - // The normal cadence resumes for the next GOP. This setting is only used when - // Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + - // Min-I-interval - 1 - MinIInterval *int32 + // Inserts timecode for each frame as 4 bytes of an unregistered SEI message. + UnregisteredSeiTimecode H264UnregisteredSeiTimecode } // Settings for quality-defined variable bitrate encoding with the H.265 codec. @@ -2021,14 +2021,6 @@ type H265QvbrSettings struct { // seconds of encoded output. MaxAverageBitrate *int32 - // Optional. Specify a value here to set the QVBR quality to a level that is - // between whole numbers. For example, if you want your QVBR quality level to be - // 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33. - // MediaConvert rounds your QVBR quality level to the nearest third of a whole - // number. For example, if you set qvbrQualityLevel to 7 and you set - // qvbrQualityLevelFineTune to .25, your actual QVBR quality level is 7.33. - QvbrQualityLevelFineTune *float64 - // Required when you use QVBR rate control mode. That is, when you specify // qvbrSettings within h265Settings. Specify the general target quality level for // this output, from 1 to 10. Use higher numbers for greater quality. Level 10 @@ -2038,90 +2030,50 @@ type H265QvbrSettings struct { // qvbrQualityLevelFineTune. For example, if you want your QVBR quality level to be // 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33. QvbrQualityLevel *int32 + + // Optional. Specify a value here to set the QVBR quality to a level that is + // between whole numbers. For example, if you want your QVBR quality level to be + // 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33. + // MediaConvert rounds your QVBR quality level to the nearest third of a whole + // number. For example, if you set qvbrQualityLevel to 7 and you set + // qvbrQualityLevelFineTune to .25, your actual QVBR quality level is 7.33. + QvbrQualityLevelFineTune *float64 } // Settings for H265 codec type H265Settings struct { - // Choose the scan line type for the output. Choose Progressive (PROGRESSIVE) to - // create a progressive output, regardless of the scan type of your input. Choose - // Top Field First (TOP_FIELD) or Bottom Field First (BOTTOM_FIELD) to create an - // output that's interlaced with the same field polarity throughout. Choose Follow, - // Default Top (FOLLOW_TOP_FIELD) or Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) - // to create an interlaced output with the same field polarity as the source. If - // the source is interlaced, the output will be interlaced with the same polarity - // as the source (it will follow the source). The output could therefore be a mix - // of "top field first" and "bottom field first". If the source is progressive, - // your output will be interlaced with "top field first" or "bottom field first" - // polarity, depending on which of the Follow options you chose. If you don't - // choose a value, the service will default to Progressive (PROGRESSIVE). - InterlaceMode H265InterlaceMode - - // H.265 Level. - CodecLevel H265CodecLevel - - // If the location of parameter set NAL units doesn't matter in your workflow, - // ignore this setting. Use this setting only with CMAF or DASH outputs, or with - // standalone file outputs in an MPEG-4 container (MP4 outputs). Choose HVC1 to - // mark your output as HVC1. This makes your output compliant with the following - // specification: ISO IECJTC1 SC29 N13798 Text ISO/IEC FDIS 14496-15 3rd Edition. - // For these outputs, the service stores parameter set NAL units in the sample - // headers but not in the samples directly. For MP4 outputs, when you choose HVC1, - // your output video might not work properly with some downstream systems and video - // players. The service defaults to marking your output as HEV1. For these outputs, - // the service writes parameter set NAL units directly into the samples. - WriteMp4PackagingType H265WriteMp4PackagingType - - // GOP Length (keyframe interval) in frames or seconds. Must be greater than zero. - GopSize *float64 - - // If enable, use reference B frames for GOP structures that have B frames > 1. - GopBReference H265GopBReference - - // Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as - // 25fps, and audio is sped up correspondingly. - SlowPal H265SlowPal - - // Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the - // console, this corresponds to any value other than Follow source. When you - // specify an output pixel aspect ratio (PAR) that is different from your input - // video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC - // widescreen, you would specify the ratio 40:33. In this example, the value for - // parDenominator is 33. - ParDenominator *int32 + // Adaptive quantization. Allows intra-frame quantizers to vary to improve visual + // quality. + AdaptiveQuantization H265AdaptiveQuantization - // Size of buffer (HRD buffer model) in bits. For example, enter five megabits as - // 5000000. - HrdBufferSize *int32 + // Enables Alternate Transfer Function SEI message for outputs using Hybrid Log + // Gamma (HLG) Electro-Optical Transfer Function (EOTF). + AlternateTransferFunctionSei H265AlternateTransferFunctionSei - // Optional. Specify how the service determines the pixel aspect ratio (PAR) for - // this output. The default behavior, Follow source (INITIALIZE_FROM_SOURCE), uses - // the PAR from your input video for your output. To specify a different PAR in the - // console, choose any value other than Follow source. To specify a different PAR - // by editing the JSON job specification, choose SPECIFIED. When you choose - // SPECIFIED for this setting, you must also specify values for the parNumerator - // and parDenominator settings. - ParControl H265ParControl + // Specify the average bitrate in bits per second. Required for VBR and CBR. For MS + // Smooth outputs, bitrates must be unique when rounded down to the nearest + // multiple of 1000. + Bitrate *int32 - // Adjust quantization within each frame based on spatial variation of content - // complexity. - SpatialAdaptiveQuantization H265SpatialAdaptiveQuantization + // H.265 Level. + CodecLevel H265CodecLevel - // Frame rate numerator - frame rate is a fraction, e.g. 24000 / 1001 = 23.976 fps. - FramerateNumerator *int32 + // Represents the Profile and Tier, per the HEVC (H.265) specification. Selections + // are grouped as [Profile] / [Tier], so "Main/High" represents Main Profile with + // High Tier. 4:2:2 profiles are only available with the HEVC 4:2:2 License. + CodecProfile H265CodecProfile - // Frame rate denominator. - FramerateDenominator *int32 + // Choose Adaptive to improve subjective video quality for high-motion content. + // This will cause the service to use fewer B-frames (which infer information based + // on other frames) for high-motion portions of the video and more B-frames for + // low-motion portions. The maximum number of B-frames is limited by the value you + // provide for the setting B frames between reference frames + // (numberBFramesBetweenReferenceFrames). + DynamicSubGop H265DynamicSubGop - // Enables temporal layer identifiers in the encoded bitstream. Up to 3 layers are - // supported depending on GOP structure: I- and P-frames form one layer, reference - // B-frames can form a second layer and non-reference b-frames can form a third - // layer. Decoders can optionally decode only the lower temporal layers to generate - // a lower frame rate output. For example, given a bitstream with temporal IDs and - // with b-frames = 1 (i.e. IbPbPb display order), a decoder could decode all the - // frames for full frame rate output or only the I and P frames (lowest temporal - // layer) for a half frame rate output. - TemporalIds H265TemporalIds + // Adjust quantization within each frame to reduce flicker or 'pop' on I-frames. + FlickerAdaptiveQuantization H265FlickerAdaptiveQuantization // If you are using the console, use the Framerate setting to specify the frame // rate for this output. If you want to keep the same frame rate as the input @@ -2136,53 +2088,55 @@ type H265Settings struct { // specify in the settings FramerateNumerator and FramerateDenominator. FramerateControl H265FramerateControl + // Optional. Specify how the transcoder performs framerate conversion. The default + // behavior is to use duplicate drop conversion. + FramerateConversionAlgorithm H265FramerateConversionAlgorithm + + // Frame rate denominator. + FramerateDenominator *int32 + + // Frame rate numerator - frame rate is a fraction, e.g. 24000 / 1001 = 23.976 fps. + FramerateNumerator *int32 + + // If enable, use reference B frames for GOP structures that have B frames > 1. + GopBReference H265GopBReference + // Frequency of closed GOPs. In streaming applications, it is recommended that this // be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly // as possible. Setting this value to 0 will break output segmenting. GopClosedCadence *int32 - // Specify the average bitrate in bits per second. Required for VBR and CBR. For MS - // Smooth outputs, bitrates must be unique when rounded down to the nearest - // multiple of 1000. - Bitrate *int32 - - // This field applies only if the Streams > Advanced > Framerate (framerate) field - // is set to 29.970. This field works with the Streams > Advanced > Preprocessors > - // Deinterlacer field (deinterlace_mode) and the Streams > Advanced > Interlaced - // Mode field (interlace_mode) to identify the scan type for the output: - // Progressive, Interlaced, Hard Telecine or Soft Telecine. - Hard: produces 29.97i - // output from 23.976 input. - Soft: produces 23.976; the player converts this - // output to 29.97i. - Telecine H265Telecine + // GOP Length (keyframe interval) in frames or seconds. Must be greater than zero. + GopSize *float64 - // Enables Alternate Transfer Function SEI message for outputs using Hybrid Log - // Gamma (HLG) Electro-Optical Transfer Function (EOTF). - AlternateTransferFunctionSei H265AlternateTransferFunctionSei + // Indicates if the GOP Size in H265 is specified in frames or seconds. If seconds + // the system will convert the GOP Size into a frame count at run time. + GopSizeUnits H265GopSizeUnits - // Settings for quality-defined variable bitrate encoding with the H.265 codec. - // Required when you set Rate control mode to QVBR. Not valid when you set Rate - // control mode to a value other than QVBR, or when you don't define Rate control - // mode. - QvbrSettings *H265QvbrSettings + // Percentage of the buffer that should initially be filled (HRD buffer model). + HrdBufferInitialFillPercentage *int32 - // Enable this setting to insert I-frames at scene changes that the service - // automatically detects. This improves video quality and is enabled by default. If - // this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for - // further video quality improvement. For more information about QVBR, see - // https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr. - SceneChangeDetect H265SceneChangeDetect + // Size of buffer (HRD buffer model) in bits. For example, enter five megabits as + // 5000000. + HrdBufferSize *int32 - // Use this setting to specify whether this output has a variable bitrate (VBR), - // constant bitrate (CBR) or quality-defined variable bitrate (QVBR). - RateControlMode H265RateControlMode + // Choose the scan line type for the output. Choose Progressive (PROGRESSIVE) to + // create a progressive output, regardless of the scan type of your input. Choose + // Top Field First (TOP_FIELD) or Bottom Field First (BOTTOM_FIELD) to create an + // output that's interlaced with the same field polarity throughout. Choose Follow, + // Default Top (FOLLOW_TOP_FIELD) or Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) + // to create an interlaced output with the same field polarity as the source. If + // the source is interlaced, the output will be interlaced with the same polarity + // as the source (it will follow the source). The output could therefore be a mix + // of "top field first" and "bottom field first". If the source is progressive, + // your output will be interlaced with "top field first" or "bottom field first" + // polarity, depending on which of the Follow options you chose. If you don't + // choose a value, the service will default to Progressive (PROGRESSIVE). + InterlaceMode H265InterlaceMode - // Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the - // console, this corresponds to any value other than Follow source. When you - // specify an output pixel aspect ratio (PAR) that is different from your input - // video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC - // widescreen, you would specify the ratio 40:33. In this example, the value for - // parNumerator is 40. - ParNumerator *int32 + // Maximum bitrate in bits/second. For example, enter five megabits per second as + // 5000000. Required when Rate control mode is QVBR. + MaxBitrate *int32 // Enforces separation between repeated (cadence) I-frames and I-frames inserted by // Scene Change Detection. If a scene change I-frame is within I-interval frames of @@ -2193,72 +2147,118 @@ type H265Settings struct { // Min-I-interval - 1 MinIInterval *int32 - // Percentage of the buffer that should initially be filled (HRD buffer model). - HrdBufferInitialFillPercentage *int32 - - // Enable use of tiles, allowing horizontal as well as vertical subdivision of the - // encoded pictures. - Tiles H265Tiles - - // Adaptive quantization. Allows intra-frame quantizers to vary to improve visual - // quality. - AdaptiveQuantization H265AdaptiveQuantization - - // Indicates if the GOP Size in H265 is specified in frames or seconds. If seconds - // the system will convert the GOP Size into a frame count at run time. - GopSizeUnits H265GopSizeUnits + // Number of B-frames between reference frames. + NumberBFramesBetweenReferenceFrames *int32 // Number of reference frames to use. The encoder may use more than requested if // using B-frames and/or interlaced encoding. NumberReferenceFrames *int32 - // Adjust quantization within each frame based on temporal variation of content - // complexity. - TemporalAdaptiveQuantization H265TemporalAdaptiveQuantization + // Optional. Specify how the service determines the pixel aspect ratio (PAR) for + // this output. The default behavior, Follow source (INITIALIZE_FROM_SOURCE), uses + // the PAR from your input video for your output. To specify a different PAR in the + // console, choose any value other than Follow source. To specify a different PAR + // by editing the JSON job specification, choose SPECIFIED. When you choose + // SPECIFIED for this setting, you must also specify values for the parNumerator + // and parDenominator settings. + ParControl H265ParControl + + // Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the + // console, this corresponds to any value other than Follow source. When you + // specify an output pixel aspect ratio (PAR) that is different from your input + // video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC + // widescreen, you would specify the ratio 40:33. In this example, the value for + // parDenominator is 33. + ParDenominator *int32 + + // Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the + // console, this corresponds to any value other than Follow source. When you + // specify an output pixel aspect ratio (PAR) that is different from your input + // video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC + // widescreen, you would specify the ratio 40:33. In this example, the value for + // parNumerator is 40. + ParNumerator *int32 + + // Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want + // to trade off encoding speed for output video quality. The default behavior is + // faster, lower quality, single-pass encoding. + QualityTuningLevel H265QualityTuningLevel + + // Settings for quality-defined variable bitrate encoding with the H.265 codec. + // Required when you set Rate control mode to QVBR. Not valid when you set Rate + // control mode to a value other than QVBR, or when you don't define Rate control + // mode. + QvbrSettings *H265QvbrSettings - // Adjust quantization within each frame to reduce flicker or 'pop' on I-frames. - FlickerAdaptiveQuantization H265FlickerAdaptiveQuantization + // Use this setting to specify whether this output has a variable bitrate (VBR), + // constant bitrate (CBR) or quality-defined variable bitrate (QVBR). + RateControlMode H265RateControlMode // Specify Sample Adaptive Offset (SAO) filter strength. Adaptive mode dynamically // selects best strength based on content SampleAdaptiveOffsetFilterMode H265SampleAdaptiveOffsetFilterMode - // Maximum bitrate in bits/second. For example, enter five megabits per second as - // 5000000. Required when Rate control mode is QVBR. - MaxBitrate *int32 + // Enable this setting to insert I-frames at scene changes that the service + // automatically detects. This improves video quality and is enabled by default. If + // this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for + // further video quality improvement. For more information about QVBR, see + // https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr. + SceneChangeDetect H265SceneChangeDetect - // Optional. Specify how the transcoder performs framerate conversion. The default - // behavior is to use duplicate drop conversion. - FramerateConversionAlgorithm H265FramerateConversionAlgorithm + // Number of slices per picture. Must be less than or equal to the number of + // macroblock rows for progressive pictures, and less than or equal to half the + // number of macroblock rows for interlaced pictures. + Slices *int32 - // Choose Adaptive to improve subjective video quality for high-motion content. - // This will cause the service to use fewer B-frames (which infer information based - // on other frames) for high-motion portions of the video and more B-frames for - // low-motion portions. The maximum number of B-frames is limited by the value you - // provide for the setting B frames between reference frames - // (numberBFramesBetweenReferenceFrames). - DynamicSubGop H265DynamicSubGop + // Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as + // 25fps, and audio is sped up correspondingly. + SlowPal H265SlowPal - // Represents the Profile and Tier, per the HEVC (H.265) specification. Selections - // are grouped as [Profile] / [Tier], so "Main/High" represents Main Profile with - // High Tier. 4:2:2 profiles are only available with the HEVC 4:2:2 License. - CodecProfile H265CodecProfile + // Adjust quantization within each frame based on spatial variation of content + // complexity. + SpatialAdaptiveQuantization H265SpatialAdaptiveQuantization - // Inserts timecode for each frame as 4 bytes of an unregistered SEI message. - UnregisteredSeiTimecode H265UnregisteredSeiTimecode + // This field applies only if the Streams > Advanced > Framerate (framerate) field + // is set to 29.970. This field works with the Streams > Advanced > Preprocessors > + // Deinterlacer field (deinterlace_mode) and the Streams > Advanced > Interlaced + // Mode field (interlace_mode) to identify the scan type for the output: + // Progressive, Interlaced, Hard Telecine or Soft Telecine. - Hard: produces 29.97i + // output from 23.976 input. - Soft: produces 23.976; the player converts this + // output to 29.97i. + Telecine H265Telecine - // Number of B-frames between reference frames. - NumberBFramesBetweenReferenceFrames *int32 + // Adjust quantization within each frame based on temporal variation of content + // complexity. + TemporalAdaptiveQuantization H265TemporalAdaptiveQuantization - // Number of slices per picture. Must be less than or equal to the number of - // macroblock rows for progressive pictures, and less than or equal to half the - // number of macroblock rows for interlaced pictures. - Slices *int32 + // Enables temporal layer identifiers in the encoded bitstream. Up to 3 layers are + // supported depending on GOP structure: I- and P-frames form one layer, reference + // B-frames can form a second layer and non-reference b-frames can form a third + // layer. Decoders can optionally decode only the lower temporal layers to generate + // a lower frame rate output. For example, given a bitstream with temporal IDs and + // with b-frames = 1 (i.e. IbPbPb display order), a decoder could decode all the + // frames for full frame rate output or only the I and P frames (lowest temporal + // layer) for a half frame rate output. + TemporalIds H265TemporalIds - // Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want - // to trade off encoding speed for output video quality. The default behavior is - // faster, lower quality, single-pass encoding. - QualityTuningLevel H265QualityTuningLevel + // Enable use of tiles, allowing horizontal as well as vertical subdivision of the + // encoded pictures. + Tiles H265Tiles + + // Inserts timecode for each frame as 4 bytes of an unregistered SEI message. + UnregisteredSeiTimecode H265UnregisteredSeiTimecode + + // If the location of parameter set NAL units doesn't matter in your workflow, + // ignore this setting. Use this setting only with CMAF or DASH outputs, or with + // standalone file outputs in an MPEG-4 container (MP4 outputs). Choose HVC1 to + // mark your output as HVC1. This makes your output compliant with the following + // specification: ISO IECJTC1 SC29 N13798 Text ISO/IEC FDIS 14496-15 3rd Edition. + // For these outputs, the service stores parameter set NAL units in the sample + // headers but not in the samples directly. For MP4 outputs, when you choose HVC1, + // your output video might not work properly with some downstream systems and video + // players. The service defaults to marking your output as HEV1. For these outputs, + // the service writes parameter set NAL units directly into the samples. + WriteMp4PackagingType H265WriteMp4PackagingType } // Use these settings to specify static color calibration metadata, as defined by @@ -2270,60 +2270,60 @@ type Hdr10Metadata struct { // HDR Master Display Information must be provided by a color grader, using color // grading tools. Range is 0 to 50,000, each increment represents 0.00002 in // CIE1931 color coordinate. Note that this setting is not for color correction. - WhitePointY *int32 + BluePrimaryX *int32 // HDR Master Display Information must be provided by a color grader, using color // grading tools. Range is 0 to 50,000, each increment represents 0.00002 in // CIE1931 color coordinate. Note that this setting is not for color correction. - RedPrimaryY *int32 + BluePrimaryY *int32 + + // HDR Master Display Information must be provided by a color grader, using color + // grading tools. Range is 0 to 50,000, each increment represents 0.00002 in + // CIE1931 color coordinate. Note that this setting is not for color correction. + GreenPrimaryX *int32 + + // HDR Master Display Information must be provided by a color grader, using color + // grading tools. Range is 0 to 50,000, each increment represents 0.00002 in + // CIE1931 color coordinate. Note that this setting is not for color correction. + GreenPrimaryY *int32 // Maximum light level among all samples in the coded video sequence, in units of // candelas per square meter. This setting doesn't have a default value; you must // specify a value that is suitable for the content. MaxContentLightLevel *int32 - // Nominal minimum mastering display luminance in units of of 0.0001 candelas per - // square meter - MinLuminance *int32 - - // HDR Master Display Information must be provided by a color grader, using color - // grading tools. Range is 0 to 50,000, each increment represents 0.00002 in - // CIE1931 color coordinate. Note that this setting is not for color correction. - RedPrimaryX *int32 + // Maximum average light level of any frame in the coded video sequence, in units + // of candelas per square meter. This setting doesn't have a default value; you + // must specify a value that is suitable for the content. + MaxFrameAverageLightLevel *int32 // Nominal maximum mastering display luminance in units of of 0.0001 candelas per // square meter. MaxLuminance *int32 - // HDR Master Display Information must be provided by a color grader, using color - // grading tools. Range is 0 to 50,000, each increment represents 0.00002 in - // CIE1931 color coordinate. Note that this setting is not for color correction. - WhitePointX *int32 + // Nominal minimum mastering display luminance in units of of 0.0001 candelas per + // square meter + MinLuminance *int32 // HDR Master Display Information must be provided by a color grader, using color // grading tools. Range is 0 to 50,000, each increment represents 0.00002 in // CIE1931 color coordinate. Note that this setting is not for color correction. - GreenPrimaryX *int32 + RedPrimaryX *int32 // HDR Master Display Information must be provided by a color grader, using color // grading tools. Range is 0 to 50,000, each increment represents 0.00002 in // CIE1931 color coordinate. Note that this setting is not for color correction. - BluePrimaryX *int32 - - // Maximum average light level of any frame in the coded video sequence, in units - // of candelas per square meter. This setting doesn't have a default value; you - // must specify a value that is suitable for the content. - MaxFrameAverageLightLevel *int32 + RedPrimaryY *int32 // HDR Master Display Information must be provided by a color grader, using color // grading tools. Range is 0 to 50,000, each increment represents 0.00002 in // CIE1931 color coordinate. Note that this setting is not for color correction. - GreenPrimaryY *int32 + WhitePointX *int32 // HDR Master Display Information must be provided by a color grader, using color // grading tools. Range is 0 to 50,000, each increment represents 0.00002 in // CIE1931 color coordinate. Note that this setting is not for color correction. - BluePrimaryY *int32 + WhitePointY *int32 } // Specify the details for each additional HLS manifest that you want the service @@ -2331,10 +2331,6 @@ type Hdr10Metadata struct { // subset of outputs in the group. type HlsAdditionalManifest struct { - // Specify the outputs that you want this additional top-level manifest to - // reference. - SelectedOutputs []*string - // Specify a name modifier that the service adds to the name of this manifest to // make it different from the file names of the other main manifests in the output // group. For example, say that the default main manifest for your HLS group is @@ -2344,18 +2340,22 @@ type HlsAdditionalManifest struct { // nameModifier of the output. The service uses the output name modifier to create // unique names for the individual variant manifests. ManifestNameModifier *string + + // Specify the outputs that you want this additional top-level manifest to + // reference. + SelectedOutputs []*string } // Caption Language Mapping type HlsCaptionLanguageMapping struct { + // Caption channel. + CaptionChannel *int32 + // Specify the language for this captions channel, using the ISO 639-2 or ISO 639-3 // three-letter language code CustomLanguageCode *string - // Caption channel. - CaptionChannel *int32 - // Specify the language, using the ISO 639-2 three-letter code listed at // https://www.loc.gov/standards/iso639-2/php/code_list.php. LanguageCode LanguageCode @@ -2367,14 +2367,24 @@ type HlsCaptionLanguageMapping struct { // Settings for HLS encryption type HlsEncryptionSettings struct { - // Enable this setting to insert the EXT-X-SESSION-KEY element into the master - // playlist. This allows for offline Apple HLS FairPlay content protection. - OfflineEncrypted HlsOfflineEncrypted + // This is a 128-bit, 16-byte hex value represented by a 32-character text string. + // If this parameter is not set then the Initialization Vector will follow the + // segment number by default. + ConstantInitializationVector *string // Encrypts the segments with the given encryption scheme. Leave blank to disable. // Selecting 'Disabled' in the web interface also disables encryption. EncryptionMethod HlsEncryptionType + // The Initialization Vector is a 128-bit number used in conjunction with the key + // for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the + // manifest. Otherwise Initialization Vector is not in the manifest. + InitializationVectorInManifest HlsInitializationVectorInManifest + + // Enable this setting to insert the EXT-X-SESSION-KEY element into the master + // playlist. This allows for offline Apple HLS FairPlay content protection. + OfflineEncrypted HlsOfflineEncrypted + // If your output group type is HLS, DASH, or Microsoft Smooth, use these settings // when doing DRM encryption with a SPEKE-compliant key provider. If your output // group type is CMAF, use the SpekeKeyProviderCmaf settings instead. @@ -2387,50 +2397,30 @@ type HlsEncryptionSettings struct { // follows the SPEKE standard. For more information about SPEKE, see // https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html. Type HlsKeyProviderType - - // This is a 128-bit, 16-byte hex value represented by a 32-character text string. - // If this parameter is not set then the Initialization Vector will follow the - // segment number by default. - ConstantInitializationVector *string - - // The Initialization Vector is a 128-bit number used in conjunction with the key - // for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the - // manifest. Otherwise Initialization Vector is not in the manifest. - InitializationVectorInManifest HlsInitializationVectorInManifest } // Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to // HLS_GROUP_SETTINGS. type HlsGroupSettings struct { - // Indicates ID3 frame that has the timecode. - TimedMetadataId3Frame HlsTimedMetadataId3Frame - - // Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The - // value is calculated as follows: either the program date and time are initialized - // using the input timecode source, or the time is initialized using the input - // timecode source and the date is initialized using the timestamp_offset. - ProgramDateTime HlsProgramDateTime + // Choose one or more ad marker types to decorate your Apple HLS manifest. This + // setting does not determine whether SCTE-35 markers appear in the outputs + // themselves. + AdMarkers []HlsAdMarkers - // Keep this setting at the default value of 0, unless you are troubleshooting a - // problem with how devices play back the end of your video asset. If you know that - // player devices are hanging on the final segment of your video because the length - // of your final segment is too short, use this setting to specify a minimum final - // segment length, in seconds. Choose a value that is greater than or equal to 1 - // and less than your segment length. When you specify a value for this setting, - // the encoder will combine any final segment that is shorter than the length that - // you specify with the previous segment. For example, your segment length is 3 - // seconds and your final segment is .5 seconds without a minimum final segment - // length; when you set the minimum final segment length to 1, your final segment - // is 3.5 seconds. - MinFinalSegmentLength *float64 + // By default, the service creates one top-level .m3u8 HLS manifest for each HLS + // output group in your job. This default manifest references every output in the + // output group. To create additional top-level manifests that reference a subset + // of the outputs in the output group, specify a list of them here. + AdditionalManifests []*HlsAdditionalManifest - // Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds. - ProgramDateTimePeriod *int32 + // A partial URI prefix that will be prepended to each output in the media .m3u8 + // file. Can be used if base manifest is delivered from a different URL than the + // main .m3u8 file. + BaseUrl *string - // When set to SINGLE_FILE, emits program as a single media resource (.ts) file, - // uses #EXT-X-BYTERANGE tags to index segment for playback. - SegmentControl HlsSegmentControl + // Language to be used on Caption outputs + CaptionLanguageMappings []*HlsCaptionLanguageMapping // Applies only to 608 Embedded output captions. Insert: Include CLOSED-CAPTIONS // lines in the manifest. Specify at least one language in the CC1 Language Code @@ -2443,6 +2433,10 @@ type HlsGroupSettings struct { // from the manifest. CaptionLanguageSetting HlsCaptionLanguageSetting + // When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from + // saving media segments for later replay. + ClientCache HlsClientCache + // Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist // generation. CodecSpecification HlsCodecSpecification @@ -2454,89 +2448,96 @@ type HlsGroupSettings struct { // input file. Destination *string - // When set to GZIP, compresses HLS playlist. - ManifestCompression HlsManifestCompression + // Settings associated with the destination. Will vary based on the type of + // destination + DestinationSettings *DestinationSettings - // Length of MPEG-2 Transport Stream segments to create (in seconds). Note that - // segments will end on the next keyframe after this number of seconds, so actual - // segment length may be longer. - SegmentLength *int32 + // Indicates whether segments should be placed in subdirectories. + DirectoryStructure HlsDirectoryStructure - // A partial URI prefix that will be prepended to each output in the media .m3u8 - // file. Can be used if base manifest is delivered from a different URL than the - // main .m3u8 file. - BaseUrl *string + // DRM settings. + Encryption *HlsEncryptionSettings - // Choose one or more ad marker types to decorate your Apple HLS manifest. This - // setting does not determine whether SCTE-35 markers appear in the outputs - // themselves. - AdMarkers []HlsAdMarkers + // When set to GZIP, compresses HLS playlist. + ManifestCompression HlsManifestCompression - // Provides an extra millisecond delta offset to fine tune the timestamps. - TimestampDeltaMilliseconds *int32 + // Indicates whether the output manifest should use floating point values for + // segment duration. + ManifestDurationFormat HlsManifestDurationFormat - // Settings associated with the destination. Will vary based on the type of - // destination - DestinationSettings *DestinationSettings + // Keep this setting at the default value of 0, unless you are troubleshooting a + // problem with how devices play back the end of your video asset. If you know that + // player devices are hanging on the final segment of your video because the length + // of your final segment is too short, use this setting to specify a minimum final + // segment length, in seconds. Choose a value that is greater than or equal to 1 + // and less than your segment length. When you specify a value for this setting, + // the encoder will combine any final segment that is shorter than the length that + // you specify with the previous segment. For example, your segment length is 3 + // seconds and your final segment is .5 seconds without a minimum final segment + // length; when you set the minimum final segment length to 1, your final segment + // is 3.5 seconds. + MinFinalSegmentLength *float64 // When set, Minimum Segment Size is enforced by looking ahead and back within the // specified range for a nearby avail and extending the segment size if needed. MinSegmentLength *int32 - // When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from - // saving media segments for later replay. - ClientCache HlsClientCache + // Indicates whether the .m3u8 manifest file should be generated for this HLS + // output group. + OutputSelection HlsOutputSelection - // Indicates whether segments should be placed in subdirectories. - DirectoryStructure HlsDirectoryStructure + // Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The + // value is calculated as follows: either the program date and time are initialized + // using the input timecode source, or the time is initialized using the input + // timecode source and the date is initialized using the timestamp_offset. + ProgramDateTime HlsProgramDateTime - // Timed Metadata interval in seconds. - TimedMetadataId3Period *int32 + // Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds. + ProgramDateTimePeriod *int32 + + // When set to SINGLE_FILE, emits program as a single media resource (.ts) file, + // uses #EXT-X-BYTERANGE tags to index segment for playback. + SegmentControl HlsSegmentControl + + // Length of MPEG-2 Transport Stream segments to create (in seconds). Note that + // segments will end on the next keyframe after this number of seconds, so actual + // segment length may be longer. + SegmentLength *int32 // Number of segments to write to a subdirectory before starting a new one. // directoryStructure must be SINGLE_DIRECTORY for this setting to have an effect. SegmentsPerSubdirectory *int32 - // Language to be used on Caption outputs - CaptionLanguageMappings []*HlsCaptionLanguageMapping - - // By default, the service creates one top-level .m3u8 HLS manifest for each HLS - // output group in your job. This default manifest references every output in the - // output group. To create additional top-level manifests that reference a subset - // of the outputs in the output group, specify a list of them here. - AdditionalManifests []*HlsAdditionalManifest - - // DRM settings. - Encryption *HlsEncryptionSettings - - // Indicates whether the .m3u8 manifest file should be generated for this HLS - // output group. - OutputSelection HlsOutputSelection - - // Indicates whether the output manifest should use floating point values for - // segment duration. - ManifestDurationFormat HlsManifestDurationFormat - // Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of // variant manifest. StreamInfResolution HlsStreamInfResolution + + // Indicates ID3 frame that has the timecode. + TimedMetadataId3Frame HlsTimedMetadataId3Frame + + // Timed Metadata interval in seconds. + TimedMetadataId3Period *int32 + + // Provides an extra millisecond delta offset to fine tune the timestamps. + TimestampDeltaMilliseconds *int32 } // Settings for HLS output groups type HlsSettings struct { - // Use this setting to add an identifying string to the filename of each segment. - // The service adds this string between the name modifier and segment index number. - // You can use format identifiers in the string. For more information, see - // https://docs.aws.amazon.com/mediaconvert/latest/ug/using-variables-in-your-job-settings.html - SegmentModifier *string - // Specifies the group to which the audio Rendition belongs. AudioGroupId *string - // When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS - // manifest - IFrameOnlyManifest HlsIFrameOnlyManifest + // Use this setting only in audio-only outputs. Choose MPEG-2 Transport Stream + // (M2TS) to create a file in an MPEG2-TS container. Keep the default value + // Automatic (AUTOMATIC) to create an audio-only file in a raw container. + // Regardless of the value that you specify here, if this output has video, the + // service will place the output into an MPEG2-TS container. + AudioOnlyContainer HlsAudioOnlyContainer + + // List all the audio groups that are used with the video output stream. Input all + // the audio GROUP-IDs that are associated to the video, separate by ','. + AudioRenditionSets *string // Four types of audio-only tracks are supported: Audio-Only Variant Stream The // client can play back this audio-only stream instead of video in low-bandwidth @@ -2551,16 +2552,15 @@ type HlsSettings struct { // AUTOSELECT=NO AudioTrackType HlsAudioTrackType - // List all the audio groups that are used with the video output stream. Input all - // the audio GROUP-IDs that are associated to the video, separate by ','. - AudioRenditionSets *string + // When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS + // manifest + IFrameOnlyManifest HlsIFrameOnlyManifest - // Use this setting only in audio-only outputs. Choose MPEG-2 Transport Stream - // (M2TS) to create a file in an MPEG2-TS container. Keep the default value - // Automatic (AUTOMATIC) to create an audio-only file in a raw container. - // Regardless of the value that you specify here, if this output has video, the - // service will place the output into an MPEG2-TS container. - AudioOnlyContainer HlsAudioOnlyContainer + // Use this setting to add an identifying string to the filename of each segment. + // The service adds this string between the name modifier and segment index number. + // You can use format identifiers in the string. For more information, see + // https://docs.aws.amazon.com/mediaconvert/latest/ug/using-variables-in-your-job-settings.html + SegmentModifier *string } // Optional. Configuration for a destination queue to which the job can hop once a @@ -2572,17 +2572,17 @@ type HopDestination struct { // specify, the relative priority will remain the same as in the previous queue. Priority *int32 - // Required for setting up a job to use queue hopping. Minimum wait time in minutes - // until the job can hop to the destination queue. Valid range is 1 to 1440 - // minutes, inclusive. - WaitMinutes *int32 - // Optional unless the job is submitted on the default queue. When you set up a job // to use queue hopping, you can specify a destination queue. This queue cannot be // the original queue to which the job is submitted. If the original queue isn't // the default queue and you don't specify the destination queue, the job will move // to the default queue. Queue *string + + // Required for setting up a job to use queue hopping. Minimum wait time in minutes + // until the job can hop to the destination queue. Valid range is 1 to 1440 + // minutes, inclusive. + WaitMinutes *int32 } // To insert ID3 tags in your output, specify two values. Use ID3 tag (Id3) to @@ -2591,11 +2591,11 @@ type HopDestination struct { // output, create multiple instances of ID3 insertion (Id3Insertion). type Id3Insertion struct { - // Provide a Timecode (TimeCode) in HH:MM:SS:FF or HH:MM:SS;FF format. - Timecode *string - // Use ID3 tag (Id3) to provide a tag value in base64-encode format. Id3 *string + + // Provide a Timecode (TimeCode) in HH:MM:SS:FF or HH:MM:SS;FF format. + Timecode *string } // Enable the image inserter feature to include a graphic overlay on your video. @@ -2621,65 +2621,62 @@ type ImscDestinationSettings struct { // Specifies media input type Input struct { - // Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is - // disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs. - DenoiseFilter InputDenoiseFilter - - // Use Filter strength (FilterStrength) to adjust the magnitude the input filter - // settings (Deblock and Denoise). The range is -5 to 5. Default is 0. - FilterStrength *int32 - - // Use Cropping selection (crop) to specify the video area that the service will - // include in the output video frame. If you specify a value here, it will override - // any value that you specify in the output setting Cropping selection (crop). - Crop *Rectangle + // Specifies set of audio selectors within an input to combine. An input may have + // multiple audio selector groups. See "Audio Selector + // Group":#inputs-audio_selector_group for more information. + AudioSelectorGroups map[string]*AudioSelectorGroup // Use Audio selectors (AudioSelectors) to specify a track or set of tracks from // the input that you will use in your outputs. You can use multiple Audio // selectors per input. AudioSelectors map[string]*AudioSelector - // Use Program (programNumber) to select a specific program from within a - // multi-program transport stream. Note that Quad 4K is not currently supported. - // Default is the first program within the transport stream. If the program you - // specify doesn't exist, the transcoding service will use this default. - ProgramNumber *int32 - // Use captions selectors to specify the captions data from your input that you use // in your outputs. You can use up to 20 captions selectors per input. CaptionSelectors map[string]*CaptionSelector - // Set PSI control (InputPsiControl) for transport stream inputs to specify which - // data the demux process to scans. * Ignore PSI - Scan all PIDs for audio and - // video. * Use PSI - Scan only PSI data. - PsiControl InputPsiControl - - // Use Selection placement (position) to define the video area in your output - // frame. The area outside of the rectangle that you specify here is black. If you - // specify a value here, it will override any value that you specify in the output - // setting Selection placement (position). If you specify a value here, this will - // override any AFD values in your input, even if you set Respond to AFD - // (RespondToAfd) to Respond (RESPOND). If you specify a value here, this will - // ignore anything that you specify for the setting Scaling Behavior - // (scalingBehavior). - Position *Rectangle - - // Provide a list of any necessary supplemental IMPs. You need supplemental IMPs if - // the CPL that you're using for your input is in an incomplete IMP. Specify either - // the supplemental IMP directories with a trailing slash or the ASSETMAP.xml - // files. For example ["s3://bucket/ov/", "s3://bucket/vf2/ASSETMAP.xml"]. You - // don't need to specify the IMP that contains your input CPL, because the service - // automatically detects it. - SupplementalImps []*string - - // Selector for video. - VideoSelector *VideoSelector + // Use Cropping selection (crop) to specify the video area that the service will + // include in the output video frame. If you specify a value here, it will override + // any value that you specify in the output setting Cropping selection (crop). + Crop *Rectangle // Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. // Default is disabled. Only manually controllable for MPEG2 and uncompressed video // inputs. DeblockFilter InputDeblockFilter + // Settings for decrypting any input files that you encrypt before you upload them + // to Amazon S3. MediaConvert can decrypt files only when you use AWS Key + // Management Service (KMS) to encrypt the data key that you use to encrypt your + // content. + DecryptionSettings *InputDecryptionSettings + + // Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is + // disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs. + DenoiseFilter InputDenoiseFilter + + // Specify the source file for your transcoding job. You can use multiple inputs in + // a single job. The service concatenates these inputs, in the order that you + // specify them in the job, to create the outputs. If your input format is IMF, + // specify your input by providing the path to your CPL. For example, + // "s3://bucket/vf/cpl.xml". If the CPL is in an incomplete IMP, make sure to use + // Supplemental IMPs (SupplementalImps) to specify any supplemental IMPs that + // contain assets referenced by the CPL. + FileInput *string + + // Use Filter enable (InputFilterEnable) to specify how the transcoding service + // applies the denoise and deblock filters. You must also enable the filters + // separately, with Denoise (InputDenoiseFilter) and Deblock (InputDeblockFilter). + // * Auto - The transcoding service determines whether to apply filtering, + // depending on input type and quality. * Disable - The input is not filtered. This + // is true even if you use the API to enable them in (InputDeblockFilter) and + // (InputDeblockFilter). * Force - The in put is filtered regardless of input type. + FilterEnable InputFilterEnable + + // Use Filter strength (FilterStrength) to adjust the magnitude the input filter + // settings (Deblock and Denoise). The range is -5 to 5. Default is 0. + FilterStrength *int32 + // Enable the image inserter feature to include a graphic overlay on your video. // Enable or disable this feature for each input individually. This setting is // disabled by default. @@ -2693,41 +2690,34 @@ type Input struct { // outputs by stringing the clips together in the order you specify them. InputClippings []*InputClipping - // Use Filter enable (InputFilterEnable) to specify how the transcoding service - // applies the denoise and deblock filters. You must also enable the filters - // separately, with Denoise (InputDenoiseFilter) and Deblock (InputDeblockFilter). - // * Auto - The transcoding service determines whether to apply filtering, - // depending on input type and quality. * Disable - The input is not filtered. This - // is true even if you use the API to enable them in (InputDeblockFilter) and - // (InputDeblockFilter). * Force - The in put is filtered regardless of input type. - FilterEnable InputFilterEnable - - // Specify the source file for your transcoding job. You can use multiple inputs in - // a single job. The service concatenates these inputs, in the order that you - // specify them in the job, to create the outputs. If your input format is IMF, - // specify your input by providing the path to your CPL. For example, - // "s3://bucket/vf/cpl.xml". If the CPL is in an incomplete IMP, make sure to use - // Supplemental IMPs (SupplementalImps) to specify any supplemental IMPs that - // contain assets referenced by the CPL. - FileInput *string + // Use Selection placement (position) to define the video area in your output + // frame. The area outside of the rectangle that you specify here is black. If you + // specify a value here, it will override any value that you specify in the output + // setting Selection placement (position). If you specify a value here, this will + // override any AFD values in your input, even if you set Respond to AFD + // (RespondToAfd) to Respond (RESPOND). If you specify a value here, this will + // ignore anything that you specify for the setting Scaling Behavior + // (scalingBehavior). + Position *Rectangle - // Settings for decrypting any input files that you encrypt before you upload them - // to Amazon S3. MediaConvert can decrypt files only when you use AWS Key - // Management Service (KMS) to encrypt the data key that you use to encrypt your - // content. - DecryptionSettings *InputDecryptionSettings + // Use Program (programNumber) to select a specific program from within a + // multi-program transport stream. Note that Quad 4K is not currently supported. + // Default is the first program within the transport stream. If the program you + // specify doesn't exist, the transcoding service will use this default. + ProgramNumber *int32 - // Specifies set of audio selectors within an input to combine. An input may have - // multiple audio selector groups. See "Audio Selector - // Group":#inputs-audio_selector_group for more information. - AudioSelectorGroups map[string]*AudioSelectorGroup + // Set PSI control (InputPsiControl) for transport stream inputs to specify which + // data the demux process to scans. * Ignore PSI - Scan all PIDs for audio and + // video. * Use PSI - Scan only PSI data. + PsiControl InputPsiControl - // Specify the timecode that you want the service to use for this input's initial - // frame. To use this setting, you must set the Timecode source setting, located - // under the input settings (InputTimecodeSource), to Specified start - // (SPECIFIEDSTART). For more information about timecodes, see - // https://docs.aws.amazon.com/console/mediaconvert/timecode. - TimecodeStart *string + // Provide a list of any necessary supplemental IMPs. You need supplemental IMPs if + // the CPL that you're using for your input is in an incomplete IMP. Specify either + // the supplemental IMP directories with a trailing slash or the ASSETMAP.xml + // files. For example ["s3://bucket/ov/", "s3://bucket/vf2/ASSETMAP.xml"]. You + // don't need to specify the IMP that contains your input CPL, because the service + // automatically detects it. + SupplementalImps []*string // Use this Timecode source setting, located under the input settings // (InputTimecodeSource), to specify how the service counts input video frames. @@ -2740,7 +2730,17 @@ type Input struct { // a value for Timecode source, the service will use Embedded by default. For more // information about timecodes, see // https://docs.aws.amazon.com/console/mediaconvert/timecode. - TimecodeSource InputTimecodeSource + TimecodeSource InputTimecodeSource + + // Specify the timecode that you want the service to use for this input's initial + // frame. To use this setting, you must set the Timecode source setting, located + // under the input settings (InputTimecodeSource), to Specified start + // (SPECIFIEDSTART). For more information about timecodes, see + // https://docs.aws.amazon.com/console/mediaconvert/timecode. + TimecodeStart *string + + // Selector for video. + VideoSelector *VideoSelector } // To transcode only portions of your input (clips), include one Input clipping @@ -2748,16 +2748,6 @@ type Input struct { // input clips you specify will be included in every output of the job. type InputClipping struct { - // Set Start timecode (StartTimecode) to the beginning of the portion of the input - // you are clipping. The frame corresponding to the Start timecode value is - // included in the clip. Start timecode or End timecode may be left blank, but not - // both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the - // minute, SS is the second, and FF is the frame number. When choosing this value, - // take into account your setting for Input timecode source. For example, if you - // have embedded timecodes that start at 01:00:00:00 and you want your clip to - // begin five minutes into the video, use 01:05:00:00. - StartTimecode *string - // Set End timecode (EndTimecode) to the end of the portion of the input you are // clipping. The frame corresponding to the End timecode value is included in the // clip. Start timecode or End timecode may be left blank, but not both. Use the @@ -2768,6 +2758,16 @@ type InputClipping struct { // 01:00:00:00 and you want your clip to end six minutes into the video, use // 01:06:00:00. EndTimecode *string + + // Set Start timecode (StartTimecode) to the beginning of the portion of the input + // you are clipping. The frame corresponding to the Start timecode value is + // included in the clip. Start timecode or End timecode may be left blank, but not + // both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the + // minute, SS is the second, and FF is the frame number. When choosing this value, + // take into account your setting for Input timecode source. For example, if you + // have embedded timecodes that start at 01:00:00:00 and you want your clip to + // begin five minutes into the video, use 01:05:00:00. + StartTimecode *string } // Settings for decrypting any input files that you encrypt before you upload them @@ -2802,38 +2802,33 @@ type InputDecryptionSettings struct { // Specified video input in a template. type InputTemplate struct { - // Specify the timecode that you want the service to use for this input's initial - // frame. To use this setting, you must set the Timecode source setting, located - // under the input settings (InputTimecodeSource), to Specified start - // (SPECIFIEDSTART). For more information about timecodes, see - // https://docs.aws.amazon.com/console/mediaconvert/timecode. - TimecodeStart *string - - // (InputClippings) contains sets of start and end times that together specify a - // portion of the input to be used in the outputs. If you provide only a start - // time, the clip will be the entire input from that point to the end. If you - // provide only an end time, it will be the entire input up to that point. When you - // specify more than one input clip, the transcoding service creates the job - // outputs by stringing the clips together in the order you specify them. - InputClippings []*InputClipping + // Specifies set of audio selectors within an input to combine. An input may have + // multiple audio selector groups. See "Audio Selector + // Group":#inputs-audio_selector_group for more information. + AudioSelectorGroups map[string]*AudioSelectorGroup - // Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. - // Default is disabled. Only manually controllable for MPEG2 and uncompressed video - // inputs. - DeblockFilter InputDeblockFilter + // Use Audio selectors (AudioSelectors) to specify a track or set of tracks from + // the input that you will use in your outputs. You can use multiple Audio + // selectors per input. + AudioSelectors map[string]*AudioSelector - // Enable the image inserter feature to include a graphic overlay on your video. - // Enable or disable this feature for each input individually. This setting is - // disabled by default. - ImageInserter *ImageInserter + // Use captions selectors to specify the captions data from your input that you use + // in your outputs. You can use up to 20 captions selectors per input. + CaptionSelectors map[string]*CaptionSelector // Use Cropping selection (crop) to specify the video area that the service will // include in the output video frame. If you specify a value here, it will override // any value that you specify in the output setting Cropping selection (crop). Crop *Rectangle - // Selector for video. - VideoSelector *VideoSelector + // Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. + // Default is disabled. Only manually controllable for MPEG2 and uncompressed video + // inputs. + DeblockFilter InputDeblockFilter + + // Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is + // disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs. + DenoiseFilter InputDenoiseFilter // Use Filter enable (InputFilterEnable) to specify how the transcoding service // applies the denoise and deblock filters. You must also enable the filters @@ -2844,25 +2839,22 @@ type InputTemplate struct { // (InputDeblockFilter). * Force - The in put is filtered regardless of input type. FilterEnable InputFilterEnable - // Set PSI control (InputPsiControl) for transport stream inputs to specify which - // data the demux process to scans. * Ignore PSI - Scan all PIDs for audio and - // video. * Use PSI - Scan only PSI data. - PsiControl InputPsiControl - - // Use Program (programNumber) to select a specific program from within a - // multi-program transport stream. Note that Quad 4K is not currently supported. - // Default is the first program within the transport stream. If the program you - // specify doesn't exist, the transcoding service will use this default. - ProgramNumber *int32 + // Use Filter strength (FilterStrength) to adjust the magnitude the input filter + // settings (Deblock and Denoise). The range is -5 to 5. Default is 0. + FilterStrength *int32 - // Use Audio selectors (AudioSelectors) to specify a track or set of tracks from - // the input that you will use in your outputs. You can use multiple Audio - // selectors per input. - AudioSelectors map[string]*AudioSelector + // Enable the image inserter feature to include a graphic overlay on your video. + // Enable or disable this feature for each input individually. This setting is + // disabled by default. + ImageInserter *ImageInserter - // Use captions selectors to specify the captions data from your input that you use - // in your outputs. You can use up to 20 captions selectors per input. - CaptionSelectors map[string]*CaptionSelector + // (InputClippings) contains sets of start and end times that together specify a + // portion of the input to be used in the outputs. If you provide only a start + // time, the clip will be the entire input from that point to the end. If you + // provide only an end time, it will be the entire input up to that point. When you + // specify more than one input clip, the transcoding service creates the job + // outputs by stringing the clips together in the order you specify them. + InputClippings []*InputClipping // Use Selection placement (position) to define the video area in your output // frame. The area outside of the rectangle that you specify here is black. If you @@ -2874,13 +2866,16 @@ type InputTemplate struct { // (scalingBehavior). Position *Rectangle - // Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is - // disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs. - DenoiseFilter InputDenoiseFilter + // Use Program (programNumber) to select a specific program from within a + // multi-program transport stream. Note that Quad 4K is not currently supported. + // Default is the first program within the transport stream. If the program you + // specify doesn't exist, the transcoding service will use this default. + ProgramNumber *int32 - // Use Filter strength (FilterStrength) to adjust the magnitude the input filter - // settings (Deblock and Denoise). The range is -5 to 5. Default is 0. - FilterStrength *int32 + // Set PSI control (InputPsiControl) for transport stream inputs to specify which + // data the demux process to scans. * Ignore PSI - Scan all PIDs for audio and + // video. * Use PSI - Scan only PSI data. + PsiControl InputPsiControl // Use this Timecode source setting, located under the input settings // (InputTimecodeSource), to specify how the service counts input video frames. @@ -2895,15 +2890,51 @@ type InputTemplate struct { // https://docs.aws.amazon.com/console/mediaconvert/timecode. TimecodeSource InputTimecodeSource - // Specifies set of audio selectors within an input to combine. An input may have - // multiple audio selector groups. See "Audio Selector - // Group":#inputs-audio_selector_group for more information. - AudioSelectorGroups map[string]*AudioSelectorGroup + // Specify the timecode that you want the service to use for this input's initial + // frame. To use this setting, you must set the Timecode source setting, located + // under the input settings (InputTimecodeSource), to Specified start + // (SPECIFIEDSTART). For more information about timecodes, see + // https://docs.aws.amazon.com/console/mediaconvert/timecode. + TimecodeStart *string + + // Selector for video. + VideoSelector *VideoSelector } // Settings that specify how your still graphic overlay appears. type InsertableImage struct { + // Specify the time, in milliseconds, for the image to remain on the output video. + // This duration includes fade-in time but not fade-out time. + Duration *int32 + + // Specify the length of time, in milliseconds, between the Start time that you + // specify for the image insertion and the time that the image appears at full + // opacity. Full opacity is the level that you specify for the opacity setting. If + // you don't specify a value for Fade-in, the image will appear abruptly at the + // overlay start time. + FadeIn *int32 + + // Specify the length of time, in milliseconds, between the end of the time that + // you have specified for the image overlay Duration and when the overlaid image + // has faded to total transparency. If you don't specify a value for Fade-out, the + // image will disappear abruptly at the end of the inserted image duration. + FadeOut *int32 + + // Specify the height of the inserted image in pixels. If you specify a value + // that's larger than the video resolution height, the service will crop your + // overlaid image to fit. To use the native height of the image, keep this setting + // blank. + Height *int32 + + // Specify the HTTP, HTTPS, or Amazon S3 location of the image that you want to + // overlay on the video. Use a PNG or TGA file. + ImageInserterInput *string + + // Specify the distance, in pixels, between the inserted image and the left edge of + // the video frame. Required for any image overlay that you specify. + ImageX *int32 + // Specify the distance, in pixels, between the overlaid image and the top edge of // the video frame. Required for any image overlay that you specify. ImageY *int32 @@ -2912,10 +2943,6 @@ type InsertableImage struct { // Layer appear on top of images with lower values for Layer. Layer *int32 - // Specify the distance, in pixels, between the inserted image and the left edge of - // the video frame. Required for any image overlay that you specify. - ImageX *int32 - // Use Opacity (Opacity) to specify how much of the underlying video shows through // the inserted image. 0 is transparent and 100 is fully opaque. Default is 50. Opacity *int32 @@ -2925,37 +2952,10 @@ type InsertableImage struct { // into account your timecode source settings. StartTime *string - // Specify the length of time, in milliseconds, between the end of the time that - // you have specified for the image overlay Duration and when the overlaid image - // has faded to total transparency. If you don't specify a value for Fade-out, the - // image will disappear abruptly at the end of the inserted image duration. - FadeOut *int32 - - // Specify the length of time, in milliseconds, between the Start time that you - // specify for the image insertion and the time that the image appears at full - // opacity. Full opacity is the level that you specify for the opacity setting. If - // you don't specify a value for Fade-in, the image will appear abruptly at the - // overlay start time. - FadeIn *int32 - // Specify the width of the inserted image in pixels. If you specify a value that's // larger than the video resolution width, the service will crop your overlaid // image to fit. To use the native width of the image, keep this setting blank. Width *int32 - - // Specify the height of the inserted image in pixels. If you specify a value - // that's larger than the video resolution height, the service will crop your - // overlaid image to fit. To use the native height of the image, keep this setting - // blank. - Height *int32 - - // Specify the time, in milliseconds, for the image to remain on the output video. - // This duration includes fade-in time but not fade-out time. - Duration *int32 - - // Specify the HTTP, HTTPS, or Amazon S3 location of the image that you want to - // overlay on the video. Use a PNG or TGA file. - ImageInserterInput *string } // Each job converts an input file into an output file or files. For more @@ -2963,14 +2963,6 @@ type InsertableImage struct { // http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html type Job struct { - // Error code for the job - ErrorCode *int32 - - // JobSettings contains all the transcode settings for a job. - // - // This member is required. - Settings *JobSettings - // The IAM role you use for creating this job. For details about permissions, see // the User Guide topic at the User Guide at // http://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html @@ -2978,6 +2970,15 @@ type Job struct { // This member is required. Role *string + // JobSettings contains all the transcode settings for a job. + // + // This member is required. + Settings *JobSettings + + // Accelerated transcoding can significantly speed up jobs with long, visually + // complex content. + AccelerationSettings *AccelerationSettings + // Describes whether the current job is running with accelerated transcoding. For // jobs that have Acceleration (AccelerationMode) set to DISABLED, // AccelerationStatus is always NOT_APPLICABLE. For jobs that have Acceleration @@ -2991,52 +2992,31 @@ type Job struct { // your job without accelerated transcoding, AccelerationStatus is NOT_ACCELERATED. AccelerationStatus AccelerationStatus - // Enable this setting when you run a test job to estimate how many reserved - // transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your - // job from an on-demand queue with similar performance to what you will see with - // one RTS in a reserved queue. This setting is disabled by default. - SimulateReservedQueue SimulateReservedQueue - - // Relative priority on the job. - Priority *int32 - - // A job's phase can be PROBING, TRANSCODING OR UPLOADING - CurrentPhase JobPhase - - // A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR. - Status JobStatus + // An identifier for this resource that is unique within all of AWS. + Arn *string // The tag type that AWS Billing and Cost Management will use to sort your AWS // Elemental MediaConvert costs on any billing report that you set up. BillingTagsSource BillingTagsSource - // Information about when jobs are submitted, started, and finished is specified in - // Unix epoch format in seconds. - Timing *Timing + // The time, in Unix epoch format in seconds, when the job got created. + CreatedAt *time.Time - // A portion of the job's ARN, unique within your AWS Elemental MediaConvert - // resources - Id *string + // A job's phase can be PROBING, TRANSCODING OR UPLOADING + CurrentPhase JobPhase - // Provides messages from the service about jobs that you have already successfully - // submitted. - Messages *JobMessages + // Error code for the job + ErrorCode *int32 - // Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch - // Events. Set the interval, in seconds, between status updates. MediaConvert sends - // an update at this interval from the time the service begins processing your job - // to the time it completes the transcode or encounters an error. - StatusUpdateInterval StatusUpdateInterval + // Error message of Job + ErrorMessage *string // Optional list of hop destinations. HopDestinations []*HopDestination - // The time, in Unix epoch format in seconds, when the job got created. - CreatedAt *time.Time - - // The job template that the job is created from, if it is created from a job - // template. - JobTemplate *string + // A portion of the job's ARN, unique within your AWS Elemental MediaConvert + // resources + Id *string // An estimate of how far your job has progressed. This estimate is shown as a // percentage of the total time from when your job leaves its queue to when your @@ -3048,9 +3028,19 @@ type Job struct { // progress. In those cases, jobPercentComplete returns a null value. JobPercentComplete *int32 - // User-defined metadata that you want to associate with an MediaConvert job. You - // specify metadata in key/value pairs. - UserMetadata map[string]*string + // The job template that the job is created from, if it is created from a job + // template. + JobTemplate *string + + // Provides messages from the service about jobs that you have already successfully + // submitted. + Messages *JobMessages + + // List of output group details + OutputGroupDetails []*OutputGroupDetail + + // Relative priority on the job. + Priority *int32 // When you create a job, you can specify a queue to send it to. If you don't // specify, the job will go to the default queue. For more about queues, see the @@ -3058,25 +3048,35 @@ type Job struct { // http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html Queue *string - // Accelerated transcoding can significantly speed up jobs with long, visually - // complex content. - AccelerationSettings *AccelerationSettings - - // An identifier for this resource that is unique within all of AWS. - Arn *string - - // Error message of Job - ErrorMessage *string - - // List of output group details - OutputGroupDetails []*OutputGroupDetail + // The job's queue hopping history. + QueueTransitions []*QueueTransition // The number of times that the service automatically attempted to process your job // after encountering an error. RetryCount *int32 - // The job's queue hopping history. - QueueTransitions []*QueueTransition + // Enable this setting when you run a test job to estimate how many reserved + // transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your + // job from an on-demand queue with similar performance to what you will see with + // one RTS in a reserved queue. This setting is disabled by default. + SimulateReservedQueue SimulateReservedQueue + + // A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR. + Status JobStatus + + // Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch + // Events. Set the interval, in seconds, between status updates. MediaConvert sends + // an update at this interval from the time the service begins processing your job + // to the time it completes the transcode or encounters an error. + StatusUpdateInterval StatusUpdateInterval + + // Information about when jobs are submitted, started, and finished is specified in + // Unix epoch format in seconds. + Timing *Timing + + // User-defined metadata that you want to associate with an MediaConvert job. You + // specify metadata in key/value pairs. + UserMetadata map[string]*string } // Provides messages from the service about jobs that you have already successfully @@ -3095,23 +3095,35 @@ type JobMessages struct { // JobSettings contains all the transcode settings for a job. type JobSettings struct { - // Contains settings used to acquire and adjust timecode information from inputs. - TimecodeConfig *TimecodeConfig - - // Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in - // your job. To include timed metadata, you must enable it here, enable it in each - // output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) - // objects. - TimedMetadataInsertion *TimedMetadataInsertion + // When specified, this offset (in milliseconds) is added to the input Ad Avail PTS + // time. + AdAvailOffset *int32 // Settings for ad avail blanking. Video can be blanked or overlaid with an image, // and audio muted during SCTE-35 triggered ad avails. AvailBlanking *AvailBlanking + // Settings for Event Signaling And Messaging (ESAM). + Esam *EsamSettings + + // Use Inputs (inputs) to define source file used in the transcode job. There can + // be multiple inputs add in a job. These inputs will be concantenated together to + // create the output. + Inputs []*Input + // Overlay motion graphics on top of your video. The motion graphics that you // specify here appear on all outputs in all output groups. MotionImageInserter *MotionImageInserter + // Settings for your Nielsen configuration. If you don't do Nielsen measurement and + // analytics, ignore these settings. When you enable Nielsen configuration + // (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs + // in the job. To enable Nielsen configuration programmatically, include an + // instance of nielsenConfiguration in your JSON job specification. Even if you + // don't include any children of nielsenConfiguration, you still enable the + // setting. + NielsenConfiguration *NielsenConfiguration + // (OutputGroups) contains one group of settings for each set of outputs that share // a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, // and no container) are grouped in a single output group as well. Required in @@ -3124,82 +3136,70 @@ type JobSettings struct { // CmafGroupSettings OutputGroups []*OutputGroup - // Use Inputs (inputs) to define source file used in the transcode job. There can - // be multiple inputs add in a job. These inputs will be concantenated together to - // create the output. - Inputs []*Input - - // Settings for your Nielsen configuration. If you don't do Nielsen measurement and - // analytics, ignore these settings. When you enable Nielsen configuration - // (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs - // in the job. To enable Nielsen configuration programmatically, include an - // instance of nielsenConfiguration in your JSON job specification. Even if you - // don't include any children of nielsenConfiguration, you still enable the - // setting. - NielsenConfiguration *NielsenConfiguration - - // When specified, this offset (in milliseconds) is added to the input Ad Avail PTS - // time. - AdAvailOffset *int32 + // Contains settings used to acquire and adjust timecode information from inputs. + TimecodeConfig *TimecodeConfig - // Settings for Event Signaling And Messaging (ESAM). - Esam *EsamSettings + // Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in + // your job. To include timed metadata, you must enable it here, enable it in each + // output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) + // objects. + TimedMetadataInsertion *TimedMetadataInsertion } // A job template is a pre-made set of encoding instructions that you can use to // quickly create a job. type JobTemplate struct { - // Optional list of hop destinations. - HopDestinations []*HopDestination - // A name you create for each job template. Each name must be unique within your // account. // // This member is required. Name *string - // The timestamp in epoch seconds when the Job template was last updated. - LastUpdated *time.Time - // JobTemplateSettings contains all the transcode settings saved in the template // that will be applied to jobs created from it. // // This member is required. Settings *JobTemplateSettings - // Relative priority on the job. - Priority *int32 - - // Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch - // Events. Set the interval, in seconds, between status updates. MediaConvert sends - // an update at this interval from the time the service begins processing your job - // to the time it completes the transcode or encounters an error. - StatusUpdateInterval StatusUpdateInterval + // Accelerated transcoding can significantly speed up jobs with long, visually + // complex content. + AccelerationSettings *AccelerationSettings // An identifier for this resource that is unique within all of AWS. Arn *string - // A job template can be of two types: system or custom. System or built-in job - // templates can't be modified or deleted by the user. - Type Type + // An optional category you create to organize your job templates. + Category *string // The timestamp in epoch seconds for Job template creation. CreatedAt *time.Time + // An optional description you create for each job template. + Description *string + + // Optional list of hop destinations. + HopDestinations []*HopDestination + + // The timestamp in epoch seconds when the Job template was last updated. + LastUpdated *time.Time + + // Relative priority on the job. + Priority *int32 + // Optional. The queue that jobs created from this template are assigned to. If you // don't specify this, jobs will go to the default queue. Queue *string - // Accelerated transcoding can significantly speed up jobs with long, visually - // complex content. - AccelerationSettings *AccelerationSettings - - // An optional category you create to organize your job templates. - Category *string + // Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch + // Events. Set the interval, in seconds, between status updates. MediaConvert sends + // an update at this interval from the time the service begins processing your job + // to the time it completes the transcode or encounters an error. + StatusUpdateInterval StatusUpdateInterval - // An optional description you create for each job template. - Description *string + // A job template can be of two types: system or custom. System or built-in job + // templates can't be modified or deleted by the user. + Type Type } // JobTemplateSettings contains all the transcode settings saved in the template @@ -3210,39 +3210,22 @@ type JobTemplateSettings struct { // time. AdAvailOffset *int32 - // Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in - // your job. To include timed metadata, you must enable it here, enable it in each - // output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) - // objects. - TimedMetadataInsertion *TimedMetadataInsertion + // Settings for ad avail blanking. Video can be blanked or overlaid with an image, + // and audio muted during SCTE-35 triggered ad avails. + AvailBlanking *AvailBlanking // Settings for Event Signaling And Messaging (ESAM). Esam *EsamSettings - // Contains settings used to acquire and adjust timecode information from inputs. - TimecodeConfig *TimecodeConfig - - // (OutputGroups) contains one group of settings for each set of outputs that share - // a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, - // and no container) are grouped in a single output group as well. Required in - // (OutputGroups) is a group of settings that apply to the whole group. This - // required object depends on the value you set for (Type) under - // (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as - // follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, - // HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * - // MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, - // CmafGroupSettings - OutputGroups []*OutputGroup - - // Overlay motion graphics on top of your video. The motion graphics that you - // specify here appear on all outputs in all output groups. - MotionImageInserter *MotionImageInserter - // Use Inputs (inputs) to define the source file used in the transcode job. There // can only be one input in a job template. Using the API, you can include multiple // inputs when referencing a job template. Inputs []*InputTemplate + // Overlay motion graphics on top of your video. The motion graphics that you + // specify here appear on all outputs in all output groups. + MotionImageInserter *MotionImageInserter + // Settings for your Nielsen configuration. If you don't do Nielsen measurement and // analytics, ignore these settings. When you enable Nielsen configuration // (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs @@ -3252,9 +3235,26 @@ type JobTemplateSettings struct { // setting. NielsenConfiguration *NielsenConfiguration - // Settings for ad avail blanking. Video can be blanked or overlaid with an image, - // and audio muted during SCTE-35 triggered ad avails. - AvailBlanking *AvailBlanking + // (OutputGroups) contains one group of settings for each set of outputs that share + // a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, + // and no container) are grouped in a single output group as well. Required in + // (OutputGroups) is a group of settings that apply to the whole group. This + // required object depends on the value you set for (Type) under + // (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as + // follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, + // HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * + // MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, + // CmafGroupSettings + OutputGroups []*OutputGroup + + // Contains settings used to acquire and adjust timecode information from inputs. + TimecodeConfig *TimecodeConfig + + // Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in + // your job. To include timed metadata, you must enable it here, enable it in each + // output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) + // objects. + TimedMetadataInsertion *TimedMetadataInsertion } // Settings for SCTE-35 signals from ESAM. Include this in your job settings to put @@ -3278,60 +3278,30 @@ type M2tsScte35Esam struct { // systems and players use the program map table to look up the PID for each type // of data it accesses and then uses the PIDs to locate specific data within the // asset. -type M2tsSettings struct { - - // Value in bits per second of extra null packets to insert into the transport - // stream. This can be used if a downstream encryption system requires periodic - // null packets. - NullPacketBitrate *float64 - - // Specify the number of milliseconds between instances of the program map table - // (PMT) in the output transport stream. - PmtInterval *int32 - - // Specify the packet identifiers (PIDs) for DVB subtitle data included in this - // output. Specify multiple PIDs as a JSON array. Default is the range 460-479. - DvbSubPids []*int32 - - // When set to CBR, inserts null packets into transport stream to fill specified - // bitrate. When set to VBR, the bitrate setting acts as the maximum bitrate, but - // the output will not be padded up to that bitrate. - RateMode M2tsRateMode - - // Controls whether to include the ES Rate field in the PES header. - EsRateInPes M2tsEsRateInPes - - // The segmentation style parameter controls how segmentation markers are inserted - // into the transport stream. With avails, it is possible that segments may be - // truncated, which can influence where future segmentation markers are inserted. - // When a segmentation style of "reset_cadence" is selected and a segment is - // truncated due to an avail, we will reset the segmentation cadence. This means - // the subsequent segment will have a duration of of $segmentation_time seconds. - // When a segmentation style of "maintain_cadence" is selected and a segment is - // truncated due to an avail, we will not reset the segmentation cadence. This - // means the subsequent segment will likely be truncated as well. However, all - // segments after that will have a duration of $segmentation_time seconds. Note - // that EBP lookahead is a slight exception to this rule. - SegmentationStyle M2tsSegmentationStyle - - // Include this in your job settings to put SCTE-35 markers in your HLS and - // transport stream outputs at the insertion points that you specify in an ESAM XML - // document. Provide the document in the setting SCC XML (sccXml). - Scte35Esam *M2tsScte35Esam - - // The number of milliseconds between instances of this table in the output - // transport stream. - PatInterval *int32 +type M2tsSettings struct { - // Specify the maximum time, in milliseconds, between Program Clock References - // (PCRs) inserted into the transport stream. - MaxPcrInterval *int32 + // Selects between the DVB and ATSC buffer models for Dolby Digital audio. + AudioBufferModel M2tsAudioBufferModel + + // The number of audio frames to insert for each PES packet. + AudioFramesPerPes *int32 // Specify the packet identifiers (PIDs) for any elementary audio streams you // include in this output. Specify multiple PIDs as a JSON array. Default is the // range 482-492. AudioPids []*int32 + // Specify the output bitrate of the transport stream in bits per second. Setting + // to 0 lets the muxer automatically determine the appropriate bitrate. Other + // common values are 3750000, 7500000, and 15000000. + Bitrate *int32 + + // Controls what buffer model to use for accurate interleaving. If set to + // MULTIPLEX, use multiplex buffer model. If set to NONE, this can lead to lower + // latency, but low-memory devices may not be able to play back the stream without + // interruptions. + BufferModel M2tsBufferModel + // Inserts DVB Network Information Table (NIT) at the specified table repetition // interval. DvbNitSettings *DvbNitSettings @@ -3340,65 +3310,117 @@ type M2tsSettings struct { // interval. DvbSdtSettings *DvbSdtSettings - // Controls what buffer model to use for accurate interleaving. If set to - // MULTIPLEX, use multiplex buffer model. If set to NONE, this can lead to lower - // latency, but low-memory devices may not be able to play back the stream without - // interruptions. - BufferModel M2tsBufferModel + // Specify the packet identifiers (PIDs) for DVB subtitle data included in this + // output. Specify multiple PIDs as a JSON array. Default is the range 460-479. + DvbSubPids []*int32 - // For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you - // want SCTE-35 markers that appear in your input to also appear in this output. - // Choose None (NONE) if you don't want SCTE-35 markers in this output. For SCTE-35 - // markers from an ESAM XML document-- Choose None (NONE). Also provide the ESAM - // XML as a string in the setting Signal processing notification XML (sccXml). Also - // enable ESAM SCTE-35 (include the property scte35Esam). - Scte35Source M2tsScte35Source + // Inserts DVB Time and Date Table (TDT) at the specified table repetition + // interval. + DvbTdtSettings *DvbTdtSettings - // Specify the packet identifier (PID) of the private metadata stream. Default is - // 503. - PrivateMetadataPid *int32 + // Specify the packet identifier (PID) for DVB teletext data you include in this + // output. Default is 499. + DvbTeletextPid *int32 - // Selects between the DVB and ATSC buffer models for Dolby Digital audio. - AudioBufferModel M2tsAudioBufferModel + // When set to VIDEO_AND_FIXED_INTERVALS, audio EBP markers will be added to + // partitions 3 and 4. The interval between these additional markers will be fixed, + // and will be slightly shorter than the video EBP marker interval. When set to + // VIDEO_INTERVAL, these additional markers will not be inserted. Only applicable + // when EBP segmentation markers are is selected (segmentationMarkers is EBP or + // EBP_LEGACY). + EbpAudioInterval M2tsEbpAudioInterval + + // Selects which PIDs to place EBP markers on. They can either be placed only on + // the video PID, or on both the video PID and all audio PIDs. Only applicable when + // EBP segmentation markers are is selected (segmentationMarkers is EBP or + // EBP_LEGACY). + EbpPlacement M2tsEbpPlacement + + // Controls whether to include the ES Rate field in the PES header. + EsRateInPes M2tsEsRateInPes // Keep the default value (DEFAULT) unless you know that your audio EBP markers are // incorrectly appearing before your video EBP markers. To correct this problem, // set this value to Force (FORCE). ForceTsVideoEbpOrder M2tsForceTsVideoEbpOrder + // The length, in seconds, of each fragment. Only used with EBP markers. + FragmentTime *float64 + + // Specify the maximum time, in milliseconds, between Program Clock References + // (PCRs) inserted into the transport stream. + MaxPcrInterval *int32 + + // When set, enforces that Encoder Boundary Points do not come within the specified + // time interval of each other by looking ahead at input video. If another EBP is + // going to come in within the specified time interval, the current EBP is not + // emitted, and the segment is "stretched" to the next marker. The lookahead value + // does not add latency to the system. The Live Event must be configured elsewhere + // to create sufficient latency to make the lookahead accurate. + MinEbpInterval *int32 + + // If INSERT, Nielsen inaudible tones for media tracking will be detected in the + // input audio and an equivalent ID3 tag will be inserted in the output. + NielsenId3 M2tsNielsenId3 + + // Value in bits per second of extra null packets to insert into the transport + // stream. This can be used if a downstream encryption system requires periodic + // null packets. + NullPacketBitrate *float64 + + // The number of milliseconds between instances of this table in the output + // transport stream. + PatInterval *int32 + // When set to PCR_EVERY_PES_PACKET, a Program Clock Reference value is inserted // for every Packetized Elementary Stream (PES) header. This is effective only when // the PCR PID is the same as the video or audio elementary stream. PcrControl M2tsPcrControl - // Specify the packet identifier (PID) for timed metadata in this output. Default - // is 502. - TimedMetadataPid *int32 - // Specify the packet identifier (PID) for the program clock reference (PCR) in // this output. If you do not specify a value, the service will use the value for // Video PID (VideoPid). PcrPid *int32 - // Specify the length, in seconds, of each segment. Required unless markers is set - // to none. - SegmentationTime *float64 - - // Specify the packet identifier (PID) for DVB teletext data you include in this - // output. Default is 499. - DvbTeletextPid *int32 - - // The length, in seconds, of each fragment. Only used with EBP markers. - FragmentTime *float64 + // Specify the number of milliseconds between instances of the program map table + // (PMT) in the output transport stream. + PmtInterval *int32 // Specify the packet identifier (PID) for the program map table (PMT) itself. // Default is 480. PmtPid *int32 - // Specify the output bitrate of the transport stream in bits per second. Setting - // to 0 lets the muxer automatically determine the appropriate bitrate. Other - // common values are 3750000, 7500000, and 15000000. - Bitrate *int32 + // Specify the packet identifier (PID) of the private metadata stream. Default is + // 503. + PrivateMetadataPid *int32 + + // Use Program number (programNumber) to specify the program number used in the + // program map table (PMT) for this output. Default is 1. Program numbers and + // program map tables are parts of MPEG-2 transport stream containers, used for + // organizing data. + ProgramNumber *int32 + + // When set to CBR, inserts null packets into transport stream to fill specified + // bitrate. When set to VBR, the bitrate setting acts as the maximum bitrate, but + // the output will not be padded up to that bitrate. + RateMode M2tsRateMode + + // Include this in your job settings to put SCTE-35 markers in your HLS and + // transport stream outputs at the insertion points that you specify in an ESAM XML + // document. Provide the document in the setting SCC XML (sccXml). + Scte35Esam *M2tsScte35Esam + + // Specify the packet identifier (PID) of the SCTE-35 stream in the transport + // stream. + Scte35Pid *int32 + + // For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you + // want SCTE-35 markers that appear in your input to also appear in this output. + // Choose None (NONE) if you don't want SCTE-35 markers in this output. For SCTE-35 + // markers from an ESAM XML document-- Choose None (NONE). Also provide the ESAM + // XML as a string in the setting Signal processing notification XML (sccXml). Also + // enable ESAM SCTE-35 (include the property scte35Esam). + Scte35Source M2tsScte35Source // Inserts segmentation markers at each segmentation_time period. rai_segstart sets // the Random Access Indicator bit in the adaptation field. rai_adapt sets the RAI @@ -3409,61 +3431,55 @@ type M2tsSettings struct { // adaptation field using a legacy proprietary format. SegmentationMarkers M2tsSegmentationMarkers - // The number of audio frames to insert for each PES packet. - AudioFramesPerPes *int32 + // The segmentation style parameter controls how segmentation markers are inserted + // into the transport stream. With avails, it is possible that segments may be + // truncated, which can influence where future segmentation markers are inserted. + // When a segmentation style of "reset_cadence" is selected and a segment is + // truncated due to an avail, we will reset the segmentation cadence. This means + // the subsequent segment will have a duration of of $segmentation_time seconds. + // When a segmentation style of "maintain_cadence" is selected and a segment is + // truncated due to an avail, we will not reset the segmentation cadence. This + // means the subsequent segment will likely be truncated as well. However, all + // segments after that will have a duration of $segmentation_time seconds. Note + // that EBP lookahead is a slight exception to this rule. + SegmentationStyle M2tsSegmentationStyle - // When set to VIDEO_AND_FIXED_INTERVALS, audio EBP markers will be added to - // partitions 3 and 4. The interval between these additional markers will be fixed, - // and will be slightly shorter than the video EBP marker interval. When set to - // VIDEO_INTERVAL, these additional markers will not be inserted. Only applicable - // when EBP segmentation markers are is selected (segmentationMarkers is EBP or - // EBP_LEGACY). - EbpAudioInterval M2tsEbpAudioInterval + // Specify the length, in seconds, of each segment. Required unless markers is set + // to none. + SegmentationTime *float64 - // Selects which PIDs to place EBP markers on. They can either be placed only on - // the video PID, or on both the video PID and all audio PIDs. Only applicable when - // EBP segmentation markers are is selected (segmentationMarkers is EBP or - // EBP_LEGACY). - EbpPlacement M2tsEbpPlacement + // Specify the packet identifier (PID) for timed metadata in this output. Default + // is 502. + TimedMetadataPid *int32 // Specify the ID for the transport stream itself in the program map table for this // output. Transport stream IDs and program map tables are parts of MPEG-2 // transport stream containers, used for organizing data. TransportStreamId *int32 - // If INSERT, Nielsen inaudible tones for media tracking will be detected in the - // input audio and an equivalent ID3 tag will be inserted in the output. - NielsenId3 M2tsNielsenId3 - // Specify the packet identifier (PID) of the elementary video stream in the // transport stream. VideoPid *int32 +} - // When set, enforces that Encoder Boundary Points do not come within the specified - // time interval of each other by looking ahead at input video. If another EBP is - // going to come in within the specified time interval, the current EBP is not - // emitted, and the segment is "stretched" to the next marker. The lookahead value - // does not add latency to the system. The Live Event must be configured elsewhere - // to create sufficient latency to make the lookahead accurate. - MinEbpInterval *int32 +// Settings for TS segments in HLS +type M3u8Settings struct { - // Specify the packet identifier (PID) of the SCTE-35 stream in the transport - // stream. - Scte35Pid *int32 + // The number of audio frames to insert for each PES packet. + AudioFramesPerPes *int32 - // Use Program number (programNumber) to specify the program number used in the - // program map table (PMT) for this output. Default is 1. Program numbers and - // program map tables are parts of MPEG-2 transport stream containers, used for - // organizing data. - ProgramNumber *int32 + // Packet Identifier (PID) of the elementary audio stream(s) in the transport + // stream. Multiple values are accepted, and can be entered in ranges and/or by + // comma separation. + AudioPids []*int32 - // Inserts DVB Time and Date Table (TDT) at the specified table repetition - // interval. - DvbTdtSettings *DvbTdtSettings -} + // If INSERT, Nielsen inaudible tones for media tracking will be detected in the + // input audio and an equivalent ID3 tag will be inserted in the output. + NielsenId3 M3u8NielsenId3 -// Settings for TS segments in HLS -type M3u8Settings struct { + // The number of milliseconds between instances of this table in the output + // transport stream. + PatInterval *int32 // When set to PCR_EVERY_PES_PACKET a Program Clock Reference value is inserted for // every Packetized Elementary Stream (PES) header. This parameter is effective @@ -3475,25 +3491,21 @@ type M3u8Settings struct { // Video PID. PcrPid *int32 - // The number of milliseconds between instances of this table in the output - // transport stream. - PatInterval *int32 - // The number of milliseconds between instances of this table in the output // transport stream. PmtInterval *int32 - // The number of audio frames to insert for each PES packet. - AudioFramesPerPes *int32 + // Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. + PmtPid *int32 - // Packet Identifier (PID) of the elementary audio stream(s) in the transport - // stream. Multiple values are accepted, and can be entered in ranges and/or by - // comma separation. - AudioPids []*int32 + // Packet Identifier (PID) of the private metadata stream in the transport stream. + PrivateMetadataPid *int32 - // If INSERT, Nielsen inaudible tones for media tracking will be detected in the - // input audio and an equivalent ID3 tag will be inserted in the output. - NielsenId3 M3u8NielsenId3 + // The value of the program number field in the Program Map Table. + ProgramNumber *int32 + + // Packet Identifier (PID) of the SCTE-35 stream in the transport stream. + Scte35Pid *int32 // For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you // want SCTE-35 markers that appear in your input to also appear in this output. @@ -3505,45 +3517,31 @@ type M3u8Settings struct { // (sccXml). Scte35Source M3u8Scte35Source - // Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. - PmtPid *int32 - - // Packet Identifier (PID) of the elementary video stream in the transport stream. - VideoPid *int32 - - // Packet Identifier (PID) of the SCTE-35 stream in the transport stream. - Scte35Pid *int32 - // Applies only to HLS outputs. Use this setting to specify whether the service // inserts the ID3 timed metadata from the input in this output. TimedMetadata TimedMetadata - // Packet Identifier (PID) of the private metadata stream in the transport stream. - PrivateMetadataPid *int32 + // Packet Identifier (PID) of the timed metadata stream in the transport stream. + TimedMetadataPid *int32 // The value of the transport stream ID field in the Program Map Table. TransportStreamId *int32 - // Packet Identifier (PID) of the timed metadata stream in the transport stream. - TimedMetadataPid *int32 - - // The value of the program number field in the Program Map Table. - ProgramNumber *int32 + // Packet Identifier (PID) of the elementary video stream in the transport stream. + VideoPid *int32 } // Overlay motion graphics on top of your video at the time that you specify. type MotionImageInserter struct { - // Specify whether your motion graphic overlay repeats on a loop or plays only - // once. - Playback MotionImagePlayback - - // Use Offset to specify the placement of your motion graphic overlay on the video - // frame. Specify in pixels, from the upper-left corner of the frame. If you don't - // specify an offset, the service scales your overlay to the full size of the - // frame. Otherwise, the service inserts the overlay at its native resolution and - // scales the size up or down with any video scaling. - Offset *MotionImageInsertionOffset + // If your motion graphic asset is a .mov file, keep this setting unspecified. If + // your motion graphic asset is a series of .png files, specify the frame rate of + // the overlay in frames per second, as a fraction. For example, specify 24 fps as + // 24/1. Make sure that the number of images in your series matches the frame rate + // and your intended overlay duration. For example, if you want a 30-second overlay + // at 30 fps, you should have 900 .png images. This overlay frame rate doesn't need + // to match the frame rate of the underlying video. + Framerate *MotionImageInsertionFramerate // Specify the .mov file or series of .png files that you want to overlay on your // video. For .png files, provide the file name of the first file in the series. @@ -3557,6 +3555,21 @@ type MotionImageInserter struct { // can be 100 images in the sequence. Input *string + // Choose the type of motion graphic asset that you are providing for your overlay. + // You can choose either a .mov file or a series of .png files. + InsertionMode MotionImageInsertionMode + + // Use Offset to specify the placement of your motion graphic overlay on the video + // frame. Specify in pixels, from the upper-left corner of the frame. If you don't + // specify an offset, the service scales your overlay to the full size of the + // frame. Otherwise, the service inserts the overlay at its native resolution and + // scales the size up or down with any video scaling. + Offset *MotionImageInsertionOffset + + // Specify whether your motion graphic overlay repeats on a loop or plays only + // once. + Playback MotionImagePlayback + // Specify when the motion overlay begins. Use timecode format (HH:MM:SS:FF or // HH:MM:SS;FF). Make sure that the timecode you provide here takes into account // how you have set up your timecode configuration under both job settings and @@ -3569,19 +3582,6 @@ type MotionImageInserter struct { // specification at settings>timecodeConfig>source and // settings>inputs>timecodeSource. StartTime *string - - // Choose the type of motion graphic asset that you are providing for your overlay. - // You can choose either a .mov file or a series of .png files. - InsertionMode MotionImageInsertionMode - - // If your motion graphic asset is a .mov file, keep this setting unspecified. If - // your motion graphic asset is a series of .png files, specify the frame rate of - // the overlay in frames per second, as a fraction. For example, specify 24 fps as - // 24/1. Make sure that the number of images in your series matches the frame rate - // and your intended overlay duration. For example, if you want a 30-second overlay - // at 30 fps, you should have 900 .png images. This overlay frame rate doesn't need - // to match the frame rate of the underlying video. - Framerate *MotionImageInsertionFramerate } // For motion overlays that don't have a built-in frame rate, specify the frame @@ -3590,57 +3590,60 @@ type MotionImageInserter struct { // underlying video. type MotionImageInsertionFramerate struct { - // The top of the fraction that expresses your overlay frame rate. For example, if - // your frame rate is 24 fps, set this value to 24. - FramerateNumerator *int32 - // The bottom of the fraction that expresses your overlay frame rate. For example, // if your frame rate is 24 fps, set this value to 1. FramerateDenominator *int32 + + // The top of the fraction that expresses your overlay frame rate. For example, if + // your frame rate is 24 fps, set this value to 24. + FramerateNumerator *int32 } // Specify the offset between the upper-left corner of the video frame and the top // left corner of the overlay. type MotionImageInsertionOffset struct { - // Set the distance, in pixels, between the overlay and the top edge of the video - // frame. - ImageY *int32 - // Set the distance, in pixels, between the overlay and the left edge of the video // frame. ImageX *int32 + + // Set the distance, in pixels, between the overlay and the top edge of the video + // frame. + ImageY *int32 } // Settings for MOV Container. type MovSettings struct { + // When enabled, include 'clap' atom if appropriate for the video output settings. + ClapAtom MovClapAtom + + // When enabled, file composition times will start at zero, composition times in + // the 'ctts' (composition time to sample) box for B-frames will be negative, and a + // 'cslg' (composition shift least greatest) box will be included per 14496-1 + // amendment 1. This improves compatibility with Apple players and tools. + CslgAtom MovCslgAtom + // When set to XDCAM, writes MPEG2 video streams into the QuickTime file using // XDCAM fourcc codes. This increases compatibility with Apple editors and players, // but may decrease compatibility with other players. Only applicable when the // video codec is MPEG2. Mpeg2FourCCControl MovMpeg2FourCCControl - // Always keep the default value (SELF_CONTAINED) for this setting. - Reference MovReference - - // When enabled, include 'clap' atom if appropriate for the video output settings. - ClapAtom MovClapAtom - // If set to OMNEON, inserts Omneon-compatible padding PaddingControl MovPaddingControl - // When enabled, file composition times will start at zero, composition times in - // the 'ctts' (composition time to sample) box for B-frames will be negative, and a - // 'cslg' (composition shift least greatest) box will be included per 14496-1 - // amendment 1. This improves compatibility with Apple players and tools. - CslgAtom MovCslgAtom + // Always keep the default value (SELF_CONTAINED) for this setting. + Reference MovReference } // Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the // value MP2. type Mp2Settings struct { + // Specify the average bitrate in bits per second. + Bitrate *int32 + // Set Channels to specify the number of channels in this output audio track. // Choosing Mono in the console will give you 1 output channel; choosing Stereo // will give you 2. In the API, valid values are 1 and 2. @@ -3648,15 +3651,20 @@ type Mp2Settings struct { // Sample rate in hz. SampleRate *int32 - - // Specify the average bitrate in bits per second. - Bitrate *int32 } // Required when you set Codec, under AudioDescriptions>CodecSettings, to the value // MP3. type Mp3Settings struct { + // Specify the average bitrate in bits per second. + Bitrate *int32 + + // Specify the number of channels in this output audio track. Choosing Mono on the + // console gives you 1 output channel; choosing Stereo gives you 2. In the API, + // valid values are 1 and 2. + Channels *int32 + // Specify whether the service encodes this MP3 audio output with a constant // bitrate (CBR) or a variable bitrate (VBR). RateControlMode Mp3RateControlMode @@ -3667,38 +3675,18 @@ type Mp3Settings struct { // Required when you set Bitrate control mode (rateControlMode) to VBR. Specify the // audio quality of this MP3 output from 0 (highest quality) to 9 (lowest quality). VbrQuality *int32 - - // Specify the average bitrate in bits per second. - Bitrate *int32 - - // Specify the number of channels in this output audio track. Choosing Mono on the - // console gives you 1 output channel; choosing Stereo gives you 2. In the API, - // valid values are 1 and 2. - Channels *int32 } // Settings for MP4 container. You can create audio-only AAC outputs with this // container. type Mp4Settings struct { - // Inserts a free-space box immediately after the moov box. - FreeSpaceBox Mp4FreeSpaceBox - - // If set to PROGRESSIVE_DOWNLOAD, the MOOV atom is relocated to the beginning of - // the archive as required for progressive downloading. Otherwise it is placed - // normally at the end. - MoovPlacement Mp4MoovPlacement - // When enabled, file composition times will start at zero, composition times in // the 'ctts' (composition time to sample) box for B-frames will be negative, and a // 'cslg' (composition shift least greatest) box will be included per 14496-1 // amendment 1. This improves compatibility with Apple players and tools. CslgAtom Mp4CslgAtom - // Overrides the "Major Brand" field in the output file. Usually not necessary to - // specify. - Mp4MajorBrand *string - // Ignore this setting unless compliance to the CTTS box version specification // matters in your workflow. Specify a value of 1 to set your CTTS box version to 1 // and make your output compliant with the specification. When you specify a value @@ -3706,6 +3694,18 @@ type Mp4Settings struct { // default value 0 to set your CTTS box version to 0. This can provide backward // compatibility for some players and packagers. CttsVersion *int32 + + // Inserts a free-space box immediately after the moov box. + FreeSpaceBox Mp4FreeSpaceBox + + // If set to PROGRESSIVE_DOWNLOAD, the MOOV atom is relocated to the beginning of + // the archive as required for progressive downloading. Otherwise it is placed + // normally at the end. + MoovPlacement Mp4MoovPlacement + + // Overrides the "Major Brand" field in the output file. Usually not necessary to + // specify. + Mp4MajorBrand *string } // Settings for MP4 segments in DASH @@ -3719,47 +3719,87 @@ type MpdSettings struct { // your video and audio fragmented MP4 files. CaptionContainerType MpdCaptionContainerType + // Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT + // to put SCTE-35 markers in this output at the insertion points that you specify + // in an ESAM XML document. Provide the document in the setting SCC XML (sccXml). + Scte35Esam MpdScte35Esam + // Ignore this setting unless you have SCTE-35 markers in your input video file. // Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your // input to also appear in this output. Choose None (NONE) if you don't want those // SCTE-35 markers in this output. Scte35Source MpdScte35Source - - // Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT - // to put SCTE-35 markers in this output at the insertion points that you specify - // in an ESAM XML document. Provide the document in the setting SCC XML (sccXml). - Scte35Esam MpdScte35Esam } // Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the // value MPEG2. type Mpeg2Settings struct { - // Only use Telecine (Mpeg2Telecine) when you set Framerate (Framerate) to 29.970. - // Set Telecine (Mpeg2Telecine) to Hard (hard) to produce a 29.97i output from a - // 23.976 input. Set it to Soft (soft) to produce 23.976 output and leave - // converstion to the player. - Telecine Mpeg2Telecine + // Adaptive quantization. Allows intra-frame quantizers to vary to improve visual + // quality. + AdaptiveQuantization Mpeg2AdaptiveQuantization - // Softness. Selects quantizer matrix, larger values reduce high-frequency content - // in the encoded image. - Softness *int32 + // Specify the average bitrate in bits per second. Required for VBR and CBR. For MS + // Smooth outputs, bitrates must be unique when rounded down to the nearest + // multiple of 1000. + Bitrate *int32 - // Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the - // console, this corresponds to any value other than Follow source. When you - // specify an output pixel aspect ratio (PAR) that is different from your input - // video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC - // widescreen, you would specify the ratio 40:33. In this example, the value for - // parDenominator is 33. - ParDenominator *int32 + // Use Level (Mpeg2CodecLevel) to set the MPEG-2 level for the video output. + CodecLevel Mpeg2CodecLevel // Use Profile (Mpeg2CodecProfile) to set the MPEG-2 profile for the video output. CodecProfile Mpeg2CodecProfile + // Choose Adaptive to improve subjective video quality for high-motion content. + // This will cause the service to use fewer B-frames (which infer information based + // on other frames) for high-motion portions of the video and more B-frames for + // low-motion portions. The maximum number of B-frames is limited by the value you + // provide for the setting B frames between reference frames + // (numberBFramesBetweenReferenceFrames). + DynamicSubGop Mpeg2DynamicSubGop + + // If you are using the console, use the Framerate setting to specify the frame + // rate for this output. If you want to keep the same frame rate as the input + // video, choose Follow source. If you want to do frame rate conversion, choose a + // frame rate from the dropdown list or choose Custom. The framerates shown in the + // dropdown list are decimal approximations of fractions. If you choose Custom, + // specify your frame rate as a fraction. If you are creating your transcoding job + // specification as a JSON file without the console, use FramerateControl to + // specify which value the service uses for the frame rate for this output. Choose + // INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the + // input. Choose SPECIFIED if you want the service to use the frame rate you + // specify in the settings FramerateNumerator and FramerateDenominator. + FramerateControl Mpeg2FramerateControl + // Optional. Specify how the transcoder performs framerate conversion. The default // behavior is to use duplicate drop conversion. FramerateConversionAlgorithm Mpeg2FramerateConversionAlgorithm + // Frame rate denominator. + FramerateDenominator *int32 + + // Frame rate numerator - frame rate is a fraction, e.g. 24000 / 1001 = 23.976 fps. + FramerateNumerator *int32 + + // Frequency of closed GOPs. In streaming applications, it is recommended that this + // be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly + // as possible. Setting this value to 0 will break output segmenting. + GopClosedCadence *int32 + + // GOP Length (keyframe interval) in frames or seconds. Must be greater than zero. + GopSize *float64 + + // Indicates if the GOP Size in MPEG2 is specified in frames or seconds. If seconds + // the system will convert the GOP Size into a frame count at run time. + GopSizeUnits Mpeg2GopSizeUnits + + // Percentage of the buffer that should initially be filled (HRD buffer model). + HrdBufferInitialFillPercentage *int32 + + // Size of buffer (HRD buffer model) in bits. For example, enter five megabits as + // 5000000. + HrdBufferSize *int32 + // Use Interlace mode (InterlaceMode) to choose the scan line type for the output. // * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce // interlaced output with the entire output having the same field polarity (top or @@ -3772,68 +3812,31 @@ type Mpeg2Settings struct { // (it will follow the source). The output could therefore be a mix of "top field // first" and "bottom field first". // - // * If the source is progressive, the output - // will be interlaced with "top field first" or "bottom field first" polarity, - // depending on which of the Follow options you chose. - InterlaceMode Mpeg2InterlaceMode - - // GOP Length (keyframe interval) in frames or seconds. Must be greater than zero. - GopSize *float64 - - // Enforces separation between repeated (cadence) I-frames and I-frames inserted by - // Scene Change Detection. If a scene change I-frame is within I-interval frames of - // a cadence I-frame, the GOP is shrunk and/or stretched to the scene change - // I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. - // The normal cadence resumes for the next GOP. This setting is only used when - // Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + - // Min-I-interval - 1 - MinIInterval *int32 - - // Maximum bitrate in bits/second. For example, enter five megabits per second as - // 5000000. - MaxBitrate *int32 - - // Enable this setting to insert I-frames at scene changes that the service - // automatically detects. This improves video quality and is enabled by default. - SceneChangeDetect Mpeg2SceneChangeDetect - - // Indicates if the GOP Size in MPEG2 is specified in frames or seconds. If seconds - // the system will convert the GOP Size into a frame count at run time. - GopSizeUnits Mpeg2GopSizeUnits - - // If you are using the console, use the Framerate setting to specify the frame - // rate for this output. If you want to keep the same frame rate as the input - // video, choose Follow source. If you want to do frame rate conversion, choose a - // frame rate from the dropdown list or choose Custom. The framerates shown in the - // dropdown list are decimal approximations of fractions. If you choose Custom, - // specify your frame rate as a fraction. If you are creating your transcoding job - // specification as a JSON file without the console, use FramerateControl to - // specify which value the service uses for the frame rate for this output. Choose - // INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the - // input. Choose SPECIFIED if you want the service to use the frame rate you - // specify in the settings FramerateNumerator and FramerateDenominator. - FramerateControl Mpeg2FramerateControl - - // Specify the average bitrate in bits per second. Required for VBR and CBR. For MS - // Smooth outputs, bitrates must be unique when rounded down to the nearest - // multiple of 1000. - Bitrate *int32 + // * If the source is progressive, the output + // will be interlaced with "top field first" or "bottom field first" polarity, + // depending on which of the Follow options you chose. + InterlaceMode Mpeg2InterlaceMode - // Use Level (Mpeg2CodecLevel) to set the MPEG-2 level for the video output. - CodecLevel Mpeg2CodecLevel + // Use Intra DC precision (Mpeg2IntraDcPrecision) to set quantization precision for + // intra-block DC coefficients. If you choose the value auto, the service will + // automatically select the precision based on the per-frame compression ratio. + IntraDcPrecision Mpeg2IntraDcPrecision - // Use Rate control mode (Mpeg2RateControlMode) to specifiy whether the bitrate is - // variable (vbr) or constant (cbr). - RateControlMode Mpeg2RateControlMode + // Maximum bitrate in bits/second. For example, enter five megabits per second as + // 5000000. + MaxBitrate *int32 - // Adjust quantization within each frame based on spatial variation of content - // complexity. - SpatialAdaptiveQuantization Mpeg2SpatialAdaptiveQuantization + // Enforces separation between repeated (cadence) I-frames and I-frames inserted by + // Scene Change Detection. If a scene change I-frame is within I-interval frames of + // a cadence I-frame, the GOP is shrunk and/or stretched to the scene change + // I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. + // The normal cadence resumes for the next GOP. This setting is only used when + // Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + + // Min-I-interval - 1 + MinIInterval *int32 - // Frequency of closed GOPs. In streaming applications, it is recommended that this - // be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly - // as possible. Setting this value to 0 will break output segmenting. - GopClosedCadence *int32 + // Number of B-frames between reference frames. + NumberBFramesBetweenReferenceFrames *int32 // Optional. Specify how the service determines the pixel aspect ratio (PAR) for // this output. The default behavior, Follow source (INITIALIZE_FROM_SOURCE), uses @@ -3844,30 +3847,13 @@ type Mpeg2Settings struct { // and parDenominator settings. ParControl Mpeg2ParControl - // Use Intra DC precision (Mpeg2IntraDcPrecision) to set quantization precision for - // intra-block DC coefficients. If you choose the value auto, the service will - // automatically select the precision based on the per-frame compression ratio. - IntraDcPrecision Mpeg2IntraDcPrecision - - // Produces a Type D-10 compatible bitstream (SMPTE 356M-2001). - Syntax Mpeg2Syntax - - // Frame rate numerator - frame rate is a fraction, e.g. 24000 / 1001 = 23.976 fps. - FramerateNumerator *int32 - - // Number of B-frames between reference frames. - NumberBFramesBetweenReferenceFrames *int32 - - // Size of buffer (HRD buffer model) in bits. For example, enter five megabits as - // 5000000. - HrdBufferSize *int32 - - // Frame rate denominator. - FramerateDenominator *int32 - - // Adaptive quantization. Allows intra-frame quantizers to vary to improve visual - // quality. - AdaptiveQuantization Mpeg2AdaptiveQuantization + // Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the + // console, this corresponds to any value other than Follow source. When you + // specify an output pixel aspect ratio (PAR) that is different from your input + // video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC + // widescreen, you would specify the ratio 40:33. In this example, the value for + // parDenominator is 33. + ParDenominator *int32 // Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the // console, this corresponds to any value other than Follow source. When you @@ -3877,29 +3863,43 @@ type Mpeg2Settings struct { // parNumerator is 40. ParNumerator *int32 - // Percentage of the buffer that should initially be filled (HRD buffer model). - HrdBufferInitialFillPercentage *int32 + // Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want + // to trade off encoding speed for output video quality. The default behavior is + // faster, lower quality, single-pass encoding. + QualityTuningLevel Mpeg2QualityTuningLevel + + // Use Rate control mode (Mpeg2RateControlMode) to specifiy whether the bitrate is + // variable (vbr) or constant (cbr). + RateControlMode Mpeg2RateControlMode + + // Enable this setting to insert I-frames at scene changes that the service + // automatically detects. This improves video quality and is enabled by default. + SceneChangeDetect Mpeg2SceneChangeDetect // Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as // 25fps, and audio is sped up correspondingly. SlowPal Mpeg2SlowPal - // Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want - // to trade off encoding speed for output video quality. The default behavior is - // faster, lower quality, single-pass encoding. - QualityTuningLevel Mpeg2QualityTuningLevel + // Softness. Selects quantizer matrix, larger values reduce high-frequency content + // in the encoded image. + Softness *int32 + + // Adjust quantization within each frame based on spatial variation of content + // complexity. + SpatialAdaptiveQuantization Mpeg2SpatialAdaptiveQuantization + + // Produces a Type D-10 compatible bitstream (SMPTE 356M-2001). + Syntax Mpeg2Syntax + + // Only use Telecine (Mpeg2Telecine) when you set Framerate (Framerate) to 29.970. + // Set Telecine (Mpeg2Telecine) to Hard (hard) to produce a 29.97i output from a + // 23.976 input. Set it to Soft (soft) to produce 23.976 output and leave + // converstion to the player. + Telecine Mpeg2Telecine // Adjust quantization within each frame based on temporal variation of content // complexity. TemporalAdaptiveQuantization Mpeg2TemporalAdaptiveQuantization - - // Choose Adaptive to improve subjective video quality for high-motion content. - // This will cause the service to use fewer B-frames (which infer information based - // on other frames) for high-motion portions of the video and more B-frames for - // low-motion portions. The maximum number of B-frames is limited by the value you - // provide for the setting B frames between reference frames - // (numberBFramesBetweenReferenceFrames). - DynamicSubGop Mpeg2DynamicSubGop } // Specify the details for each additional Microsoft Smooth Streaming manifest that @@ -3907,10 +3907,6 @@ type Mpeg2Settings struct { // reference a different subset of outputs in the group. type MsSmoothAdditionalManifest struct { - // Specify the outputs that you want this additional top-level manifest to - // reference. - SelectedOutputs []*string - // Specify a name modifier that the service adds to the name of this manifest to // make it different from the file names of the other main manifests in the output // group. For example, say that the default main manifest for your Microsoft Smooth @@ -3918,6 +3914,10 @@ type MsSmoothAdditionalManifest struct { // file name the service generates for this top-level manifest is // film-name-no-premium.ismv. ManifestNameModifier *string + + // Specify the outputs that you want this additional top-level manifest to + // reference. + SelectedOutputs []*string } // If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify the @@ -3934,18 +3934,6 @@ type MsSmoothEncryptionSettings struct { // MS_SMOOTH_GROUP_SETTINGS. type MsSmoothGroupSettings struct { - // Use Fragment length (FragmentLength) to specify the mp4 fragment sizes in - // seconds. Fragment length must be compatible with GOP size and frame rate. - FragmentLength *int32 - - // If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify the - // value SpekeKeyProvider. - Encryption *MsSmoothEncryptionSettings - - // Use Manifest encoding (MsSmoothManifestEncoding) to specify the encoding format - // for the server and client manifest. Valid options are utf8 and utf16. - ManifestEncoding MsSmoothManifestEncoding - // By default, the service creates one .ism Microsoft Smooth Streaming manifest for // each Microsoft Smooth Streaming output group in your job. This default manifest // references every output in the output group. To create additional manifests that @@ -3953,10 +3941,6 @@ type MsSmoothGroupSettings struct { // here. AdditionalManifests []*MsSmoothAdditionalManifest - // Settings associated with the destination. Will vary based on the type of - // destination - DestinationSettings *DestinationSettings - // COMBINE_DUPLICATE_STREAMS combines identical audio encoding settings across a // Microsoft Smooth output group into a single audio stream. AudioDeduplication MsSmoothAudioDeduplication @@ -3967,6 +3951,22 @@ type MsSmoothGroupSettings struct { // If your job has multiple inputs, the service uses the filename of the first // input file. Destination *string + + // Settings associated with the destination. Will vary based on the type of + // destination + DestinationSettings *DestinationSettings + + // If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify the + // value SpekeKeyProvider. + Encryption *MsSmoothEncryptionSettings + + // Use Fragment length (FragmentLength) to specify the mp4 fragment sizes in + // seconds. Fragment length must be compatible with GOP size and frame rate. + FragmentLength *int32 + + // Use Manifest encoding (MsSmoothManifestEncoding) to specify the encoding format + // for the server and client manifest. Valid options are utf8 and utf16. + ManifestEncoding MsSmoothManifestEncoding } // MXF settings @@ -3988,15 +3988,10 @@ type MxfSettings struct { // OTT Streaming workflows. type NexGuardFileMarkerSettings struct { - // Optional. Ignore this setting unless Nagra support directs you to specify a - // value. When you don't specify a value here, the Nagra NexGuard library uses its - // default value. - Strength WatermarkingStrength - - // Enter one of the watermarking preset strings that Nagra provides you. Required - // when you include Nagra NexGuard File Marker watermarking - // (NexGuardWatermarkingSettings) in your job. - Preset *string + // Use the base64 license string that Nagra provides you. Enter it directly in your + // JSON job specification or in the console. Required when you include Nagra + // NexGuard File Marker watermarking (NexGuardWatermarkingSettings) in your job. + License *string // Specify the payload ID that you want associated with this output. Valid values // vary depending on your Nagra NexGuard forensic watermarking workflow. Required @@ -4012,10 +4007,15 @@ type NexGuardFileMarkerSettings struct { // output. Payload *int32 - // Use the base64 license string that Nagra provides you. Enter it directly in your - // JSON job specification or in the console. Required when you include Nagra - // NexGuard File Marker watermarking (NexGuardWatermarkingSettings) in your job. - License *string + // Enter one of the watermarking preset strings that Nagra provides you. Required + // when you include Nagra NexGuard File Marker watermarking + // (NexGuardWatermarkingSettings) in your job. + Preset *string + + // Optional. Ignore this setting unless Nagra support directs you to specify a + // value. When you don't specify a value here, the Nagra NexGuard library uses its + // default value. + Strength WatermarkingStrength } // Settings for your Nielsen configuration. If you don't do Nielsen measurement and @@ -4043,9 +4043,6 @@ type NielsenConfiguration struct { // (NoiseReducerFilter). type NoiseReducer struct { - // Noise reducer filter settings for temporal filter. - TemporalFilterSettings *NoiseReducerTemporalFilterSettings - // Use Noise reducer filter (NoiseReducerFilter) to select one of the following // spatial image filtering functions. To use this setting, you must also enable // Noise reducer (NoiseReducer). * Bilateral preserves edges while reducing noise. @@ -4055,11 +4052,14 @@ type NoiseReducer struct { // quality for complex motion. Filter NoiseReducerFilter + // Settings for a noise reducer filter + FilterSettings *NoiseReducerFilterSettings + // Noise reducer filter settings for spatial filter. SpatialFilterSettings *NoiseReducerSpatialFilterSettings - // Settings for a noise reducer filter - FilterSettings *NoiseReducerFilterSettings + // Noise reducer filter settings for temporal filter. + TemporalFilterSettings *NoiseReducerTemporalFilterSettings } // Settings for a noise reducer filter @@ -4094,23 +4094,23 @@ type NoiseReducerTemporalFilterSettings struct { // aggressively and creates better VQ for low bitrate outputs. AggressiveMode *int32 - // Specify the strength of the noise reducing filter on this output. Higher values - // produce stronger filtering. We recommend the following value ranges, depending - // on the result that you want: * 0-2 for complexity reduction with minimal - // sharpness loss * 2-8 for complexity reduction with image preservation * 8-16 for - // a high level of complexity reduction - Strength *int32 + // Optional. When you set Noise reducer (noiseReducer) to Temporal (TEMPORAL), you + // can optionally use this setting to apply additional sharpening. The default + // behavior, Auto (AUTO) allows the transcoder to determine whether to apply + // filtering, depending on input type and quality. + PostTemporalSharpening NoiseFilterPostTemporalSharpening // The speed of the filter (higher number is faster). Low setting reduces bit rate // at the cost of transcode time, high setting improves transcode time at the cost // of bit rate. Speed *int32 - // Optional. When you set Noise reducer (noiseReducer) to Temporal (TEMPORAL), you - // can optionally use this setting to apply additional sharpening. The default - // behavior, Auto (AUTO) allows the transcoder to determine whether to apply - // filtering, depending on input type and quality. - PostTemporalSharpening NoiseFilterPostTemporalSharpening + // Specify the strength of the noise reducing filter on this output. Higher values + // produce stronger filtering. We recommend the following value ranges, depending + // on the result that you want: * 0-2 for complexity reduction with minimal + // sharpness loss * 2-8 for complexity reduction with image preservation * 8-16 for + // a high level of complexity reduction + Strength *int32 } // Required when you set Codec, under AudioDescriptions>CodecSettings, to the value @@ -4136,10 +4136,10 @@ type OpusSettings struct { // output group. type Output struct { - // Use Preset (Preset) to specifiy a preset for your transcoding settings. Provide - // the system or custom preset name. You can specify either Preset (Preset) or - // Container settings (ContainerSettings), but not both. - Preset *string + // (AudioDescriptions) contains groups of audio encoding settings organized by + // audio codec. Include one instance of (AudioDescriptions) per output. + // (AudioDescriptions) can contain multiple groups of encoding settings. + AudioDescriptions []*AudioDescription // (CaptionDescriptions) contains groups of captions settings. For each output that // has captions, include one instance of (CaptionDescriptions). @@ -4149,8 +4149,13 @@ type Output struct { // Container specific settings. ContainerSettings *ContainerSettings - // Specific settings for this type of output. - OutputSettings *OutputSettings + // Use Extension (Extension) to specify the file extension for outputs in File + // output groups. If you do not specify a value, the service will use default + // extensions by container type as follows * MPEG-2 transport stream, m2ts * + // Quicktime, mov * MXF container, mxf * MPEG-4 container, mp4 * WebM container, + // webm * No Container, the service will use codec extensions (e.g. AAC, H265, + // H265, AC3) + Extension *string // Use Name modifier (NameModifier) to have the service add a string to the end of // each output filename. You specify the base filename as part of your destination @@ -4160,24 +4165,19 @@ type Output struct { // output, you must use them in the same way in all outputs of the output group. NameModifier *string - // Use Extension (Extension) to specify the file extension for outputs in File - // output groups. If you do not specify a value, the service will use default - // extensions by container type as follows * MPEG-2 transport stream, m2ts * - // Quicktime, mov * MXF container, mxf * MPEG-4 container, mp4 * WebM container, - // webm * No Container, the service will use codec extensions (e.g. AAC, H265, - // H265, AC3) - Extension *string + // Specific settings for this type of output. + OutputSettings *OutputSettings + + // Use Preset (Preset) to specifiy a preset for your transcoding settings. Provide + // the system or custom preset name. You can specify either Preset (Preset) or + // Container settings (ContainerSettings), but not both. + Preset *string // (VideoDescription) contains a group of video encoding settings. The specific // video settings depend on the video codec that you choose when you specify a // value for Video codec (codec). Include one instance of (VideoDescription) per // output. VideoDescription *VideoDescription - - // (AudioDescriptions) contains groups of audio encoding settings organized by - // audio codec. Include one instance of (AudioDescriptions) per output. - // (AudioDescriptions) can contain multiple groups of encoding settings. - AudioDescriptions []*AudioDescription } // OutputChannel mapping settings. @@ -4190,19 +4190,16 @@ type OutputChannelMapping struct { // Details regarding output type OutputDetail struct { - // Contains details about the output's video stream - VideoDetails *VideoDetail - // Duration in milliseconds DurationInMs *int32 + + // Contains details about the output's video stream + VideoDetails *VideoDetail } // Group of outputs type OutputGroup struct { - // Output Group settings, including type - OutputGroupSettings *OutputGroupSettings - // Use Custom Group Name (CustomName) to specify a name for the output group. This // value is displayed on the console and can make your job settings JSON more // human-readable. It does not affect your outputs. Use up to twelve characters @@ -4212,6 +4209,9 @@ type OutputGroup struct { // Name of the output group Name *string + // Output Group settings, including type + OutputGroupSettings *OutputGroupSettings + // This object holds groups of encoding settings, one group of settings per output. Outputs []*Output } @@ -4226,30 +4226,30 @@ type OutputGroupDetail struct { // Output Group settings, including type type OutputGroupSettings struct { - // Type of output group (File group, Apple HLS, DASH ISO, Microsoft Smooth - // Streaming, CMAF) - Type OutputGroupType - // Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to - // HLS_GROUP_SETTINGS. - HlsGroupSettings *HlsGroupSettings + // CMAF_GROUP_SETTINGS. Each output in a CMAF Output Group may only contain a + // single video, audio, or caption output. + CmafGroupSettings *CmafGroupSettings + + // Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to + // DASH_ISO_GROUP_SETTINGS. + DashIsoGroupSettings *DashIsoGroupSettings // Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to // FILE_GROUP_SETTINGS. FileGroupSettings *FileGroupSettings // Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to - // DASH_ISO_GROUP_SETTINGS. - DashIsoGroupSettings *DashIsoGroupSettings + // HLS_GROUP_SETTINGS. + HlsGroupSettings *HlsGroupSettings // Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to // MS_SMOOTH_GROUP_SETTINGS. MsSmoothGroupSettings *MsSmoothGroupSettings - // Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to - // CMAF_GROUP_SETTINGS. Each output in a CMAF Output Group may only contain a - // single video, audio, or caption output. - CmafGroupSettings *CmafGroupSettings + // Type of output group (File group, Apple HLS, DASH ISO, Microsoft Smooth + // Streaming, CMAF) + Type OutputGroupType } // Specific settings for this type of output. @@ -4274,9 +4274,6 @@ type PartnerWatermarking struct { // want MediaConvert to apply to the output during the conversion process. type Preset struct { - // The timestamp in epoch seconds when the preset was last updated. - LastUpdated *time.Time - // A name you create for each preset. Each name must be unique within your account. // // This member is required. @@ -4287,56 +4284,81 @@ type Preset struct { // This member is required. Settings *PresetSettings + // An identifier for this resource that is unique within all of AWS. + Arn *string + + // An optional category you create to organize your presets. + Category *string + // The timestamp in epoch seconds for preset creation. CreatedAt *time.Time // An optional description you create for each preset. Description *string - // An optional category you create to organize your presets. - Category *string + // The timestamp in epoch seconds when the preset was last updated. + LastUpdated *time.Time // A preset can be of two types: system or custom. System or built-in preset can't // be modified or deleted by the user. Type Type - - // An identifier for this resource that is unique within all of AWS. - Arn *string } // Settings for preset type PresetSettings struct { + // (AudioDescriptions) contains groups of audio encoding settings organized by + // audio codec. Include one instance of (AudioDescriptions) per output. + // (AudioDescriptions) can contain multiple groups of encoding settings. + AudioDescriptions []*AudioDescription + // Caption settings for this preset. There can be multiple caption settings in a // single output. CaptionDescriptions []*CaptionDescriptionPreset + // Container specific settings. + ContainerSettings *ContainerSettings + // (VideoDescription) contains a group of video encoding settings. The specific // video settings depend on the video codec that you choose when you specify a // value for Video codec (codec). Include one instance of (VideoDescription) per // output. VideoDescription *VideoDescription - - // (AudioDescriptions) contains groups of audio encoding settings organized by - // audio codec. Include one instance of (AudioDescriptions) per output. - // (AudioDescriptions) can contain multiple groups of encoding settings. - AudioDescriptions []*AudioDescription - - // Container specific settings. - ContainerSettings *ContainerSettings } // Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the // value PRORES. type ProresSettings struct { - // Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the - // console, this corresponds to any value other than Follow source. When you - // specify an output pixel aspect ratio (PAR) that is different from your input - // video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC - // widescreen, you would specify the ratio 40:33. In this example, the value for - // parDenominator is 33. - ParDenominator *int32 + // Use Profile (ProResCodecProfile) to specifiy the type of Apple ProRes codec to + // use for this output. + CodecProfile ProresCodecProfile + + // If you are using the console, use the Framerate setting to specify the frame + // rate for this output. If you want to keep the same frame rate as the input + // video, choose Follow source. If you want to do frame rate conversion, choose a + // frame rate from the dropdown list or choose Custom. The framerates shown in the + // dropdown list are decimal approximations of fractions. If you choose Custom, + // specify your frame rate as a fraction. If you are creating your transcoding job + // specification as a JSON file without the console, use FramerateControl to + // specify which value the service uses for the frame rate for this output. Choose + // INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the + // input. Choose SPECIFIED if you want the service to use the frame rate you + // specify in the settings FramerateNumerator and FramerateDenominator. + FramerateControl ProresFramerateControl + + // Optional. Specify how the transcoder performs framerate conversion. The default + // behavior is to use duplicate drop conversion. + FramerateConversionAlgorithm ProresFramerateConversionAlgorithm + + // Frame rate denominator. + FramerateDenominator *int32 + + // When you use the API for transcode jobs that use frame rate conversion, specify + // the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use + // FramerateNumerator to specify the numerator of this fraction. In this example, + // use 24000 for the value of FramerateNumerator. + FramerateNumerator *int32 // Use Interlace mode (InterlaceMode) to choose the scan line type for the output. // * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce @@ -4355,6 +4377,23 @@ type ProresSettings struct { // depending on which of the Follow options you chose. InterlaceMode ProresInterlaceMode + // Optional. Specify how the service determines the pixel aspect ratio (PAR) for + // this output. The default behavior, Follow source (INITIALIZE_FROM_SOURCE), uses + // the PAR from your input video for your output. To specify a different PAR in the + // console, choose any value other than Follow source. To specify a different PAR + // by editing the JSON job specification, choose SPECIFIED. When you choose + // SPECIFIED for this setting, you must also specify values for the parNumerator + // and parDenominator settings. + ParControl ProresParControl + + // Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the + // console, this corresponds to any value other than Follow source. When you + // specify an output pixel aspect ratio (PAR) that is different from your input + // video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC + // widescreen, you would specify the ratio 40:33. In this example, the value for + // parDenominator is 33. + ParDenominator *int32 + // Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the // console, this corresponds to any value other than Follow source. When you // specify an output pixel aspect ratio (PAR) that is different from your input @@ -4363,54 +4402,15 @@ type ProresSettings struct { // parNumerator is 40. ParNumerator *int32 - // Optional. Specify how the transcoder performs framerate conversion. The default - // behavior is to use duplicate drop conversion. - FramerateConversionAlgorithm ProresFramerateConversionAlgorithm - // Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as // 25fps, and audio is sped up correspondingly. SlowPal ProresSlowPal - // When you use the API for transcode jobs that use frame rate conversion, specify - // the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use - // FramerateNumerator to specify the numerator of this fraction. In this example, - // use 24000 for the value of FramerateNumerator. - FramerateNumerator *int32 - // Only use Telecine (ProresTelecine) when you set Framerate (Framerate) to 29.970. // Set Telecine (ProresTelecine) to Hard (hard) to produce a 29.97i output from a // 23.976 input. Set it to Soft (soft) to produce 23.976 output and leave // converstion to the player. Telecine ProresTelecine - - // Optional. Specify how the service determines the pixel aspect ratio (PAR) for - // this output. The default behavior, Follow source (INITIALIZE_FROM_SOURCE), uses - // the PAR from your input video for your output. To specify a different PAR in the - // console, choose any value other than Follow source. To specify a different PAR - // by editing the JSON job specification, choose SPECIFIED. When you choose - // SPECIFIED for this setting, you must also specify values for the parNumerator - // and parDenominator settings. - ParControl ProresParControl - - // Use Profile (ProResCodecProfile) to specifiy the type of Apple ProRes codec to - // use for this output. - CodecProfile ProresCodecProfile - - // Frame rate denominator. - FramerateDenominator *int32 - - // If you are using the console, use the Framerate setting to specify the frame - // rate for this output. If you want to keep the same frame rate as the input - // video, choose Follow source. If you want to do frame rate conversion, choose a - // frame rate from the dropdown list or choose Custom. The framerates shown in the - // dropdown list are decimal approximations of fractions. If you choose Custom, - // specify your frame rate as a fraction. If you are creating your transcoding job - // specification as a JSON file without the console, use FramerateControl to - // specify which value the service uses for the frame rate for this output. Choose - // INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the - // input. Choose SPECIFIED if you want the service to use the frame rate you - // specify in the settings FramerateNumerator and FramerateDenominator. - FramerateControl ProresFramerateControl } // You can use queues to manage the resources that are available to your AWS @@ -4420,11 +4420,11 @@ type ProresSettings struct { // https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html. type Queue struct { - // The estimated number of jobs with a SUBMITTED status. - SubmittedJobsCount *int32 - - // An optional description that you create for each queue. - Description *string + // A name that you create for each queue. Each name must be unique within your + // account. + // + // This member is required. + Name *string // An identifier for this resource that is unique within all of AWS. Arn *string @@ -4432,19 +4432,11 @@ type Queue struct { // The timestamp in epoch seconds for when you created the queue. CreatedAt *time.Time - // A name that you create for each queue. Each name must be unique within your - // account. - // - // This member is required. - Name *string - - // The estimated number of jobs with a PROGRESSING status. - ProgressingJobsCount *int32 + // An optional description that you create for each queue. + Description *string - // Specifies whether this on-demand queue is system or custom. System queues are - // built in. You can't modify or delete system queues. You can create and modify - // custom queues. - Type Type + // The timestamp in epoch seconds for when you most recently updated the queue. + LastUpdated *time.Time // Specifies whether the pricing plan for the queue is on-demand or reserved. For // on-demand, you pay per minute, billed in increments of .01 minute. For reserved, @@ -4452,17 +4444,25 @@ type Queue struct { // or how little you use it. Reserved pricing requires a 12-month commitment. PricingPlan PricingPlan + // The estimated number of jobs with a PROGRESSING status. + ProgressingJobsCount *int32 + + // Details about the pricing plan for your reserved queue. Required for reserved + // queues and not applicable to on-demand queues. + ReservationPlan *ReservationPlan + // Queues can be ACTIVE or PAUSED. If you pause a queue, the service won't begin // processing jobs in that queue. Jobs that are running when you pause the queue // continue to run until they finish or result in an error. Status QueueStatus - // The timestamp in epoch seconds for when you most recently updated the queue. - LastUpdated *time.Time + // The estimated number of jobs with a SUBMITTED status. + SubmittedJobsCount *int32 - // Details about the pricing plan for your reserved queue. Required for reserved - // queues and not applicable to on-demand queues. - ReservationPlan *ReservationPlan + // Specifies whether this on-demand queue is system or custom. System queues are + // built in. You can't modify or delete system queues. You can create and modify + // custom queues. + Type Type } // Description of the source and destination queues between which the job has @@ -4472,30 +4472,30 @@ type QueueTransition struct { // The queue that the job was on after the transition. DestinationQueue *string + // The queue that the job was on before the transition. + SourceQueue *string + // The time, in Unix epoch format, that the job moved from the source queue to the // destination queue. Timestamp *time.Time - - // The queue that the job was on before the transition. - SourceQueue *string } // Use Rectangle to identify a specific area of the video frame. type Rectangle struct { - // The distance, in pixels, between the rectangle and the top edge of the video - // frame. Specify only even numbers. - Y *int32 - - // The distance, in pixels, between the rectangle and the left edge of the video - // frame. Specify only even numbers. - X *int32 - // Height of rectangle in pixels. Specify only even numbers. Height *int32 // Width of rectangle in pixels. Specify only even numbers. Width *int32 + + // The distance, in pixels, between the rectangle and the left edge of the video + // frame. Specify only even numbers. + X *int32 + + // The distance, in pixels, between the rectangle and the top edge of the video + // frame. Specify only even numbers. + Y *int32 } // Use Manual audio remixing (RemixSettings) to adjust audio levels for each audio @@ -4503,40 +4503,41 @@ type Rectangle struct { // fewer audio channels than your input audio source provides. type RemixSettings struct { - // Specify the number of channels in this output after remixing. Valid values: 1, - // 2, 4, 6, 8... 64. (1 and even numbers to 64.) - ChannelsOut *int32 + // Channel mapping (ChannelMapping) contains the group of fields that hold the + // remixing value for each channel. Units are in dB. Acceptable values are within + // the range from -60 (mute) through 6. A setting of 0 passes the input channel + // unchanged to the output channel (no attenuation or amplification). + ChannelMapping *ChannelMapping // Specify the number of audio channels from your input that you want to use in // your output. With remixing, you might combine or split the data in these // channels, so the number of channels in your final output might be different. ChannelsIn *int32 - // Channel mapping (ChannelMapping) contains the group of fields that hold the - // remixing value for each channel. Units are in dB. Acceptable values are within - // the range from -60 (mute) through 6. A setting of 0 passes the input channel - // unchanged to the output channel (no attenuation or amplification). - ChannelMapping *ChannelMapping + // Specify the number of channels in this output after remixing. Valid values: 1, + // 2, 4, 6, 8... 64. (1 and even numbers to 64.) + ChannelsOut *int32 } // Details about the pricing plan for your reserved queue. Required for reserved // queues and not applicable to on-demand queues. type ReservationPlan struct { - // The timestamp in epoch seconds for when you set up the current pricing plan for - // this reserved queue. - PurchasedAt *time.Time - // The length of the term of your reserved queue pricing plan commitment. Commitment Commitment - // Specifies whether the pricing plan for your reserved queue is ACTIVE or EXPIRED. - Status ReservationPlanStatus - // The timestamp in epoch seconds for when the current pricing plan term for this // reserved queue expires. ExpiresAt *time.Time + // The timestamp in epoch seconds for when you set up the current pricing plan for + // this reserved queue. + PurchasedAt *time.Time + + // Specifies whether the term of your reserved queue pricing plan is automatically + // extended (AUTO_RENEW) or expires (EXPIRE) at the end of the term. + RenewalType RenewalType + // Specifies the number of reserved transcode slots (RTS) for this queue. The // number of RTS determines how many jobs the queue can process in parallel; each // RTS can process one job at a time. When you increase this number, you extend @@ -4545,27 +4546,26 @@ type ReservationPlan struct { // can't decrease the number of RTS in your reserved queue. ReservedSlots *int32 - // Specifies whether the term of your reserved queue pricing plan is automatically - // extended (AUTO_RENEW) or expires (EXPIRE) at the end of the term. - RenewalType RenewalType + // Specifies whether the pricing plan for your reserved queue is ACTIVE or EXPIRED. + Status ReservationPlanStatus } // Details about the pricing plan for your reserved queue. Required for reserved // queues and not applicable to on-demand queues. type ReservationPlanSettings struct { + // The length of the term of your reserved queue pricing plan commitment. + // + // This member is required. + Commitment Commitment + // Specifies whether the term of your reserved queue pricing plan is automatically // extended (AUTO_RENEW) or expires (EXPIRE) at the end of the term. When your term // is auto renewed, you extend your commitment by 12 months from the auto renew // date. You can cancel this commitment. // // This member is required. - RenewalType RenewalType - - // The length of the term of your reserved queue pricing plan commitment. - // - // This member is required. - Commitment Commitment + RenewalType RenewalType // Specifies the number of reserved transcode slots (RTS) for this queue. The // number of RTS determines how many jobs the queue can process in parallel; each @@ -4603,14 +4603,14 @@ type S3DestinationAccessControl struct { // Settings associated with S3 destination type S3DestinationSettings struct { - // Settings for how your job outputs are encrypted as they are uploaded to Amazon - // S3. - Encryption *S3EncryptionSettings - // Optional. Have MediaConvert automatically apply Amazon S3 access control for the // outputs in this output group. When you don't use this setting, S3 automatically // applies the default access control list PRIVATE. AccessControl *S3DestinationAccessControl + + // Settings for how your job outputs are encrypted as they are uploaded to Amazon + // S3. + Encryption *S3EncryptionSettings } // Settings for how your job outputs are encrypted as they are uploaded to Amazon @@ -4657,6 +4657,11 @@ type SccDestinationSettings struct { // group type is CMAF, use the SpekeKeyProviderCmaf settings instead. type SpekeKeyProvider struct { + // If you want your key provider to encrypt the content keys that it provides to + // MediaConvert, set up a certificate with a master key using AWS Certificate + // Manager. Specify the certificate's Amazon Resource Name (ARN) here. + CertificateArn *string + // Specify the resource ID that your SPEKE-compliant key provider uses to identify // this content. ResourceId *string @@ -4669,11 +4674,6 @@ type SpekeKeyProvider struct { // Specify the URL to the key server that your SPEKE-compliant DRM key provider // uses to provide keys for encrypting your content. Url *string - - // If you want your key provider to encrypt the content keys that it provides to - // MediaConvert, set up a certificate with a master key using AWS Certificate - // Manager. Specify the certificate's Amazon Resource Name (ARN) here. - CertificateArn *string } // If your output group type is CMAF, use these settings when doing DRM encryption @@ -4681,6 +4681,17 @@ type SpekeKeyProvider struct { // Microsoft Smooth, use the SpekeKeyProvider settings instead. type SpekeKeyProviderCmaf struct { + // If you want your key provider to encrypt the content keys that it provides to + // MediaConvert, set up a certificate with a master key using AWS Certificate + // Manager. Specify the certificate's Amazon Resource Name (ARN) here. + CertificateArn *string + + // Specify the DRM system IDs that you want signaled in the DASH manifest that + // MediaConvert creates as part of this CMAF package. The DASH manifest can + // currently signal up to three system IDs. For more information, see + // https://dashif.org/identifiers/content_protection/. + DashSignaledSystemIds []*string + // Specify the DRM system ID that you want signaled in the HLS manifest that // MediaConvert creates as part of this CMAF package. The HLS manifest can // currently signal only one system ID. For more information, see @@ -4691,33 +4702,14 @@ type SpekeKeyProviderCmaf struct { // this content. ResourceId *string - // Specify the DRM system IDs that you want signaled in the DASH manifest that - // MediaConvert creates as part of this CMAF package. The DASH manifest can - // currently signal up to three system IDs. For more information, see - // https://dashif.org/identifiers/content_protection/. - DashSignaledSystemIds []*string - // Specify the URL to the key server that your SPEKE-compliant DRM key provider // uses to provide keys for encrypting your content. Url *string - - // If you want your key provider to encrypt the content keys that it provides to - // MediaConvert, set up a certificate with a master key using AWS Certificate - // Manager. Specify the certificate's Amazon Resource Name (ARN) here. - CertificateArn *string } // Use these settings to set up encryption with a static key provider. type StaticKeyProvider struct { - // Relates to DRM implementation. Use a 32-character hexidecimal string to specify - // Key Value (StaticKeyValue). - StaticKeyValue *string - - // Relates to DRM implementation. The location of the license server used for - // protecting content. - Url *string - // Relates to DRM implementation. Sets the value of the KEYFORMAT attribute. Must // be 'identity' or a reverse DNS string. May be omitted to indicate an implicit // value of 'identity'. @@ -4726,6 +4718,14 @@ type StaticKeyProvider struct { // Relates to DRM implementation. Either a single positive integer version value or // a slash delimited list of version values (1/2/3). KeyFormatVersions *string + + // Relates to DRM implementation. Use a 32-character hexidecimal string to specify + // Key Value (StaticKeyValue). + StaticKeyValue *string + + // Relates to DRM implementation. The location of the license server used for + // protecting content. + Url *string } // Settings for Teletext caption output @@ -4758,13 +4758,6 @@ type TeletextSourceSettings struct { // prefix into the output. type TimecodeBurnin struct { - // Use Prefix (Prefix) to place ASCII characters before any burned-in timecode. For - // example, a prefix of "EZ-" will result in the timecode "EZ-00:00:00:00". Provide - // either the characters themselves or the ASCII code equivalents. The supported - // range of characters is 0x20 through 0x7e. This includes letters, numbers, and - // all special characters represented on a standard English keyboard. - Prefix *string - // Use Font Size (FontSize) to set the font size of any burned-in timecode. Valid // values are 10, 16, 32, 48. FontSize *int32 @@ -4772,12 +4765,32 @@ type TimecodeBurnin struct { // Use Position (Position) under under Timecode burn-in (TimecodeBurnIn) to specify // the location the burned-in timecode on output video. Position TimecodeBurninPosition + + // Use Prefix (Prefix) to place ASCII characters before any burned-in timecode. For + // example, a prefix of "EZ-" will result in the timecode "EZ-00:00:00:00". Provide + // either the characters themselves or the ASCII code equivalents. The supported + // range of characters is 0x20 through 0x7e. This includes letters, numbers, and + // all special characters represented on a standard English keyboard. + Prefix *string } // These settings control how the service handles timecodes throughout the job. // These settings don't affect input clipping. type TimecodeConfig struct { + // If you use an editing platform that relies on an anchor timecode, use Anchor + // Timecode (Anchor) to specify a timecode that will match the input video frame to + // the output video frame. Use 24-hour format with frame number, (HH:MM:SS:FF) or + // (HH:MM:SS;FF). This setting ignores frame rate conversion. System behavior for + // Anchor Timecode varies depending on your setting for Source (TimecodeSource). * + // If Source (TimecodeSource) is set to Specified Start (SPECIFIEDSTART), the first + // input frame is the specified value in Start Timecode (Start). Anchor Timecode + // (Anchor) and Start Timecode (Start) are used calculate output timecode. * If + // Source (TimecodeSource) is set to Start at 0 (ZEROBASED) the first frame is + // 00:00:00:00. * If Source (TimecodeSource) is set to Embedded (EMBEDDED), the + // first frame is the timecode value on the first input frame of the input. + Anchor *string + // Use Source (TimecodeSource) to set how timecodes are handled within this job. To // make sure that your video, audio, captions, and markers are synchronized and // that time-based features, such as image inserter, work correctly, choose the @@ -4796,19 +4809,6 @@ type TimecodeConfig struct { // (HH:MM:SS;FF). Start *string - // If you use an editing platform that relies on an anchor timecode, use Anchor - // Timecode (Anchor) to specify a timecode that will match the input video frame to - // the output video frame. Use 24-hour format with frame number, (HH:MM:SS:FF) or - // (HH:MM:SS;FF). This setting ignores frame rate conversion. System behavior for - // Anchor Timecode varies depending on your setting for Source (TimecodeSource). * - // If Source (TimecodeSource) is set to Specified Start (SPECIFIEDSTART), the first - // input frame is the specified value in Start Timecode (Start). Anchor Timecode - // (Anchor) and Start Timecode (Start) are used calculate output timecode. * If - // Source (TimecodeSource) is set to Start at 0 (ZEROBASED) the first frame is - // 00:00:00:00. * If Source (TimecodeSource) is set to Embedded (EMBEDDED), the - // first frame is the timecode value on the first input frame of the input. - Anchor *string - // Only applies to outputs that support program-date-time stamp. Use Timestamp // offset (TimestampOffset) to overwrite the timecode date without affecting the // time and frame number. Provide the new date as a string in the format @@ -4833,14 +4833,14 @@ type TimedMetadataInsertion struct { // Unix epoch format in seconds. type Timing struct { + // The time, in Unix epoch format, that the transcoding job finished + FinishTime *time.Time + // The time, in Unix epoch format, that transcoding for the job began. StartTime *time.Time // The time, in Unix epoch format, that you submitted the job. SubmitTime *time.Time - - // The time, in Unix epoch format, that the transcoding job finished - FinishTime *time.Time } // Settings specific to caption sources that are specified by track number. @@ -4877,14 +4877,22 @@ type TtmlDestinationSettings struct { // * VP9, Vp9Settings type VideoCodecSettings struct { - // Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the - // value PRORES. - ProresSettings *ProresSettings + // Required when you set Codec, under VideoDescription>CodecSettings to the value + // AV1. + Av1Settings *Av1Settings + + // Specifies the video codec. This must be equal to one of the enum values defined + // by the object VideoCodec. + Codec VideoCodec // Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the // value FRAME_CAPTURE. FrameCaptureSettings *FrameCaptureSettings + // Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the + // value H_264. + H264Settings *H264Settings + // Settings for H265 codec H265Settings *H265Settings @@ -4892,39 +4900,74 @@ type VideoCodecSettings struct { // value MPEG2. Mpeg2Settings *Mpeg2Settings - // Specifies the video codec. This must be equal to one of the enum values defined - // by the object VideoCodec. - Codec VideoCodec - // Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the - // value VP9. - Vp9Settings *Vp9Settings - - // Required when you set Codec, under VideoDescription>CodecSettings to the value - // AV1. - Av1Settings *Av1Settings + // value PRORES. + ProresSettings *ProresSettings // Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the // value VP8. Vp8Settings *Vp8Settings // Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the - // value H_264. - H264Settings *H264Settings + // value VP9. + Vp9Settings *Vp9Settings } // Settings for video outputs type VideoDescription struct { + // This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD + // signaling (AfdSignaling) to specify whether the service includes AFD values in + // the output video data and what those values are. * Choose None to remove all AFD + // values from this output. * Choose Fixed to ignore input AFD values and instead + // encode the value specified in the job. * Choose Auto to calculate output AFD + // values based on the input AFD scaler data. + AfdSignaling AfdSignaling + + // The anti-alias filter is automatically applied to all outputs. The service no + // longer accepts the value DISABLED for AntiAlias. If you specify that in your + // job, the service will ignore the setting. + AntiAlias AntiAlias + + // Video codec settings, (CodecSettings) under (VideoDescription), contains the + // group of settings related to video encoding. The settings in this group vary + // depending on the value that you choose for Video codec (Codec). For each codec + // enum that you choose, define the corresponding settings object. The following + // lists the codec enum, settings object pairs. * FRAME_CAPTURE, + // FrameCaptureSettings * AV1, Av1Settings * H_264, H264Settings * H_265, + // H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * VP8, Vp8Settings + // * VP9, Vp9Settings + CodecSettings *VideoCodecSettings + + // Choose Insert (INSERT) for this setting to include color metadata in this + // output. Choose Ignore (IGNORE) to exclude color metadata from this output. If + // you don't specify a value, the service sets this to Insert by default. + ColorMetadata ColorMetadata + + // Use Cropping selection (crop) to specify the video area that the service will + // include in the output video frame. + Crop *Rectangle + + // Applies only to 29.97 fps outputs. When this feature is enabled, the service + // will use drop-frame timecode on outputs. If it is not possible to use drop-frame + // timecode, the system will fall back to non-drop-frame. This setting is enabled + // by default when Timecode insertion (TimecodeInsertion) is enabled. + DropFrameTimecode DropFrameTimecode + + // Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). Use Fixed + // (FixedAfd) to specify a four-bit AFD value which the service will write on all + // frames of this video output. + FixedAfd *int32 + + // Use the Height (Height) setting to define the video resolution height for this + // output. Specify in pixels. If you don't provide a value here, the service will + // use the input height. + Height *int32 + // Use Selection placement (position) to define the video area in your output // frame. The area outside of the rectangle that you specify here is black. Position *Rectangle - // Find additional transcoding features under Preprocessors (VideoPreprocessors). - // Enable the features at each output individually. These features are disabled by - // default. - VideoPreprocessors *VideoPreprocessor - // Use Respond to AFD (RespondToAfd) to specify how the service changes the video // itself in response to AFD values in the input. * Choose Respond to clip the // input video frame according to the AFD value, input display aspect ratio, and @@ -4935,11 +4978,6 @@ type VideoDescription struct { // output. RespondToAfd RespondToAfd - // Use the Height (Height) setting to define the video resolution height for this - // output. Specify in pixels. If you don't provide a value here, the service will - // use the input height. - Height *int32 - // Specify how the service handles outputs that have a different aspect ratio from // the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the // service stretch your video image to fit. Keep the setting Default (DEFAULT) to @@ -4947,24 +4985,12 @@ type VideoDescription struct { // that you specify for the setting Selection placement (position) in this output. ScalingBehavior ScalingBehavior - // Applies only to 29.97 fps outputs. When this feature is enabled, the service - // will use drop-frame timecode on outputs. If it is not possible to use drop-frame - // timecode, the system will fall back to non-drop-frame. This setting is enabled - // by default when Timecode insertion (TimecodeInsertion) is enabled. - DropFrameTimecode DropFrameTimecode - - // Use Width (Width) to define the video resolution width, in pixels, for this - // output. If you don't provide a value here, the service will use the input width. - Width *int32 - - // Use Cropping selection (crop) to specify the video area that the service will - // include in the output video frame. - Crop *Rectangle - - // Choose Insert (INSERT) for this setting to include color metadata in this - // output. Choose Ignore (IGNORE) to exclude color metadata from this output. If - // you don't specify a value, the service sets this to Insert by default. - ColorMetadata ColorMetadata + // Use Sharpness (Sharpness) setting to specify the strength of anti-aliasing. This + // setting changes the width of the anti-alias filter kernel used for scaling. + // Sharpness only applies if your output resolution is different from your input + // resolution. 0 is the softest setting, 100 the sharpest, and 50 recommended for + // most content. + Sharpness *int32 // Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode // insertion when the input frame rate is identical to the output frame rate. To @@ -4981,40 +5007,14 @@ type VideoDescription struct { // does. TimecodeInsertion VideoTimecodeInsertion - // This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD - // signaling (AfdSignaling) to specify whether the service includes AFD values in - // the output video data and what those values are. * Choose None to remove all AFD - // values from this output. * Choose Fixed to ignore input AFD values and instead - // encode the value specified in the job. * Choose Auto to calculate output AFD - // values based on the input AFD scaler data. - AfdSignaling AfdSignaling - - // Use Sharpness (Sharpness) setting to specify the strength of anti-aliasing. This - // setting changes the width of the anti-alias filter kernel used for scaling. - // Sharpness only applies if your output resolution is different from your input - // resolution. 0 is the softest setting, 100 the sharpest, and 50 recommended for - // most content. - Sharpness *int32 - - // Video codec settings, (CodecSettings) under (VideoDescription), contains the - // group of settings related to video encoding. The settings in this group vary - // depending on the value that you choose for Video codec (Codec). For each codec - // enum that you choose, define the corresponding settings object. The following - // lists the codec enum, settings object pairs. * FRAME_CAPTURE, - // FrameCaptureSettings * AV1, Av1Settings * H_264, H264Settings * H_265, - // H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * VP8, Vp8Settings - // * VP9, Vp9Settings - CodecSettings *VideoCodecSettings - - // Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). Use Fixed - // (FixedAfd) to specify a four-bit AFD value which the service will write on all - // frames of this video output. - FixedAfd *int32 + // Find additional transcoding features under Preprocessors (VideoPreprocessors). + // Enable the features at each output individually. These features are disabled by + // default. + VideoPreprocessors *VideoPreprocessor - // The anti-alias filter is automatically applied to all outputs. The service no - // longer accepts the value DISABLED for AntiAlias. If you specify that in your - // job, the service will ignore the setting. - AntiAlias AntiAlias + // Use Width (Width) to define the video resolution width, in pixels, for this + // output. If you don't provide a value here, the service will use the input width. + Width *int32 } // Contains details about the output's video stream @@ -5032,6 +5032,11 @@ type VideoDetail struct { // default. type VideoPreprocessor struct { + // Enable the Color corrector (ColorCorrector) feature if necessary. Enable or + // disable this feature for each output individually. This setting is disabled by + // default. + ColorCorrector *ColorCorrector + // Use Deinterlacer (Deinterlacer) to produce smoother motion and a clearer // picture. Deinterlacer *Deinterlacer @@ -5039,16 +5044,16 @@ type VideoPreprocessor struct { // Enable Dolby Vision feature to produce Dolby Vision compatible video output. DolbyVision *DolbyVision - // Enable the Color corrector (ColorCorrector) feature if necessary. Enable or - // disable this feature for each output individually. This setting is disabled by - // default. - ColorCorrector *ColorCorrector - // Enable the Image inserter (ImageInserter) feature to include a graphic overlay // on your video. Enable or disable this feature for each output individually. This // setting is disabled by default. ImageInserter *ImageInserter + // Enable the Noise reducer (NoiseReducer) feature to remove noise from your video + // output if necessary. Enable or disable this feature for each output + // individually. This setting is disabled by default. + NoiseReducer *NoiseReducer + // If you work with a third party video watermarking partner, use the group of // settings that correspond with your watermarking partner to include watermarks in // your output. @@ -5057,11 +5062,6 @@ type VideoPreprocessor struct { // Timecode burn-in (TimecodeBurnIn)--Burns the output timecode and specified // prefix into the output. TimecodeBurnin *TimecodeBurnin - - // Enable the Noise reducer (NoiseReducer) feature to remove noise from your video - // output if necessary. Enable or disable this feature for each output - // individually. This setting is disabled by default. - NoiseReducer *NoiseReducer } // Selector for video. @@ -5087,6 +5087,17 @@ type VideoSelector struct { // https://docs.aws.amazon.com/console/mediaconvert/hdr. ColorSpace ColorSpace + // There are two sources for color metadata, the input file and the job input + // settings Color space (ColorSpace) and HDR master display information + // settings(Hdr10Metadata). The Color space usage setting determines which takes + // precedence. Choose Force (FORCE) to use color metadata from the input job + // settings. If you don't specify values for those settings, the service defaults + // to using metadata from your input. FALLBACK - Choose Fallback (FALLBACK) to use + // color metadata from the source when it is present. If there's no color metadata + // in your input file, the service defaults to using values you specify in the + // input settings. + ColorSpaceUsage ColorSpaceUsage + // Use these settings to provide HDR 10 metadata that is missing or inaccurate in // your input video. Appropriate values vary depending on the input video and must // be provided by a color grader. The color grader generates these values during @@ -5101,17 +5112,6 @@ type VideoSelector struct { // https://docs.aws.amazon.com/console/mediaconvert/hdr. Hdr10Metadata *Hdr10Metadata - // There are two sources for color metadata, the input file and the job input - // settings Color space (ColorSpace) and HDR master display information - // settings(Hdr10Metadata). The Color space usage setting determines which takes - // precedence. Choose Force (FORCE) to use color metadata from the input job - // settings. If you don't specify values for those settings, the service defaults - // to using metadata from your input. FALLBACK - Choose Fallback (FALLBACK) to use - // color metadata from the source when it is present. If there's no color metadata - // in your input file, the service defaults to using values you specify in the - // input settings. - ColorSpaceUsage ColorSpaceUsage - // Use PID (Pid) to select specific video data from an input file. Specify this // value as an integer; the system automatically converts it to the hexidecimal // value. For example, 257 selects PID 0x101. A PID, or packet identifier, is an @@ -5138,12 +5138,6 @@ type VideoSelector struct { // Vorbis. type VorbisSettings struct { - // Optional. Specify the variable audio quality of this Vorbis output from -1 - // (lowest quality, ~45 kbit/s) to 10 (highest quality, ~500 kbit/s). The default - // value is 4 (~128 kbit/s). Values 5 and 6 are approximately 160 and 192 kbit/s, - // respectively. - VbrQuality *int32 - // Optional. Specify the number of channels in this output audio track. Choosing // Mono on the console gives you 1 output channel; choosing Stereo gives you 2. In // the API, valid values are 1 and 2. The default value is 2. @@ -5152,25 +5146,48 @@ type VorbisSettings struct { // Optional. Specify the audio sample rate in Hz. Valid values are 22050, 32000, // 44100, and 48000. The default value is 48000. SampleRate *int32 + + // Optional. Specify the variable audio quality of this Vorbis output from -1 + // (lowest quality, ~45 kbit/s) to 10 (highest quality, ~500 kbit/s). The default + // value is 4 (~128 kbit/s). Values 5 and 6 are approximately 160 and 192 kbit/s, + // respectively. + VbrQuality *int32 } // Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the // value VP8. type Vp8Settings struct { - // Optional. Specify how the service determines the pixel aspect ratio (PAR) for - // this output. The default behavior, Follow source (INITIALIZE_FROM_SOURCE), uses - // the PAR from your input video for your output. To specify a different PAR in the - // console, choose any value other than Follow source. To specify a different PAR - // by editing the JSON job specification, choose SPECIFIED. When you choose - // SPECIFIED for this setting, you must also specify values for the parNumerator - // and parDenominator settings. - ParControl Vp8ParControl - // Target bitrate in bits/second. For example, enter five megabits per second as // 5000000. Bitrate *int32 + // If you are using the console, use the Framerate setting to specify the frame + // rate for this output. If you want to keep the same frame rate as the input + // video, choose Follow source. If you want to do frame rate conversion, choose a + // frame rate from the dropdown list or choose Custom. The framerates shown in the + // dropdown list are decimal approximations of fractions. If you choose Custom, + // specify your frame rate as a fraction. If you are creating your transcoding job + // specification as a JSON file without the console, use FramerateControl to + // specify which value the service uses for the frame rate for this output. Choose + // INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the + // input. Choose SPECIFIED if you want the service to use the frame rate you + // specify in the settings FramerateNumerator and FramerateDenominator. + FramerateControl Vp8FramerateControl + + // Optional. Specify how the transcoder performs framerate conversion. The default + // behavior is to use Drop duplicate (DUPLICATE_DROP) conversion. When you choose + // Interpolate (INTERPOLATE) instead, the conversion produces smoother motion. + FramerateConversionAlgorithm Vp8FramerateConversionAlgorithm + + // When you use the API for transcode jobs that use frame rate conversion, specify + // the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use + // FramerateDenominator to specify the denominator of this fraction. In this + // example, use 1001 for the value of FramerateDenominator. When you use the + // console for transcode jobs that use frame rate conversion, provide the value as + // a decimal number for Framerate. In this example, specify 23.976. + FramerateDenominator *int32 + // When you use the API for transcode jobs that use frame rate conversion, specify // the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use // FramerateNumerator to specify the numerator of this fraction. In this example, @@ -5179,9 +5196,35 @@ type Vp8Settings struct { // number for Framerate. In this example, specify 23.976. FramerateNumerator *int32 - // With the VP8 codec, you can use only the variable bitrate (VBR) rate control - // mode. - RateControlMode Vp8RateControlMode + // GOP Length (keyframe interval) in frames. Must be greater than zero. + GopSize *float64 + + // Optional. Size of buffer (HRD buffer model) in bits. For example, enter five + // megabits as 5000000. + HrdBufferSize *int32 + + // Ignore this setting unless you set qualityTuningLevel to MULTI_PASS. Optional. + // Specify the maximum bitrate in bits/second. For example, enter five megabits per + // second as 5000000. The default behavior uses twice the target bitrate as the + // maximum bitrate. + MaxBitrate *int32 + + // Optional. Specify how the service determines the pixel aspect ratio (PAR) for + // this output. The default behavior, Follow source (INITIALIZE_FROM_SOURCE), uses + // the PAR from your input video for your output. To specify a different PAR in the + // console, choose any value other than Follow source. To specify a different PAR + // by editing the JSON job specification, choose SPECIFIED. When you choose + // SPECIFIED for this setting, you must also specify values for the parNumerator + // and parDenominator settings. + ParControl Vp8ParControl + + // Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the + // console, this corresponds to any value other than Follow source. When you + // specify an output pixel aspect ratio (PAR) that is different from your input + // video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC + // widescreen, you would specify the ratio 40:33. In this example, the value for + // parDenominator is 33. + ParDenominator *int32 // Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the // console, this corresponds to any value other than Follow source. When you @@ -5191,14 +5234,23 @@ type Vp8Settings struct { // parNumerator is 40. ParNumerator *int32 - // Optional. Size of buffer (HRD buffer model) in bits. For example, enter five - // megabits as 5000000. - HrdBufferSize *int32 + // Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want + // to trade off encoding speed for output video quality. The default behavior is + // faster, lower quality, multi-pass encoding. + QualityTuningLevel Vp8QualityTuningLevel - // Optional. Specify how the transcoder performs framerate conversion. The default - // behavior is to use Drop duplicate (DUPLICATE_DROP) conversion. When you choose - // Interpolate (INTERPOLATE) instead, the conversion produces smoother motion. - FramerateConversionAlgorithm Vp8FramerateConversionAlgorithm + // With the VP8 codec, you can use only the variable bitrate (VBR) rate control + // mode. + RateControlMode Vp8RateControlMode +} + +// Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the +// value VP9. +type Vp9Settings struct { + + // Target bitrate in bits/second. For example, enter five megabits per second as + // 5000000. + Bitrate *int32 // If you are using the console, use the Framerate setting to specify the frame // rate for this output. If you want to keep the same frame rate as the input @@ -5211,21 +5263,12 @@ type Vp8Settings struct { // INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the // input. Choose SPECIFIED if you want the service to use the frame rate you // specify in the settings FramerateNumerator and FramerateDenominator. - FramerateControl Vp8FramerateControl - - // Ignore this setting unless you set qualityTuningLevel to MULTI_PASS. Optional. - // Specify the maximum bitrate in bits/second. For example, enter five megabits per - // second as 5000000. The default behavior uses twice the target bitrate as the - // maximum bitrate. - MaxBitrate *int32 - - // GOP Length (keyframe interval) in frames. Must be greater than zero. - GopSize *float64 + FramerateControl Vp9FramerateControl - // Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want - // to trade off encoding speed for output video quality. The default behavior is - // faster, lower quality, multi-pass encoding. - QualityTuningLevel Vp8QualityTuningLevel + // Optional. Specify how the transcoder performs framerate conversion. The default + // behavior is to use Drop duplicate (DUPLICATE_DROP) conversion. When you choose + // Interpolate (INTERPOLATE) instead, the conversion produces smoother motion. + FramerateConversionAlgorithm Vp9FramerateConversionAlgorithm // When you use the API for transcode jobs that use frame rate conversion, specify // the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use @@ -5235,31 +5278,6 @@ type Vp8Settings struct { // a decimal number for Framerate. In this example, specify 23.976. FramerateDenominator *int32 - // Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the - // console, this corresponds to any value other than Follow source. When you - // specify an output pixel aspect ratio (PAR) that is different from your input - // video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC - // widescreen, you would specify the ratio 40:33. In this example, the value for - // parDenominator is 33. - ParDenominator *int32 -} - -// Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the -// value VP9. -type Vp9Settings struct { - - // Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the - // console, this corresponds to any value other than Follow source. When you - // specify an output pixel aspect ratio (PAR) that is different from your input - // video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC - // widescreen, you would specify the ratio 40:33. In this example, the value for - // parDenominator is 33. - ParDenominator *int32 - - // Size of buffer (HRD buffer model) in bits. For example, enter five megabits as - // 5000000. - HrdBufferSize *int32 - // When you use the API for transcode jobs that use frame rate conversion, specify // the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use // FramerateNumerator to specify the numerator of this fraction. In this example, @@ -5268,10 +5286,12 @@ type Vp9Settings struct { // number for Framerate. In this example, specify 23.976. FramerateNumerator *int32 - // Optional. Specify how the service determines the pixel aspect ratio for this - // output. The default behavior is to use the same pixel aspect ratio as your input - // video. - ParControl Vp9ParControl + // GOP Length (keyframe interval) in frames. Must be greater than zero. + GopSize *float64 + + // Size of buffer (HRD buffer model) in bits. For example, enter five megabits as + // 5000000. + HrdBufferSize *int32 // Ignore this setting unless you set qualityTuningLevel to MULTI_PASS. Optional. // Specify the maximum bitrate in bits/second. For example, enter five megabits per @@ -5279,17 +5299,18 @@ type Vp9Settings struct { // maximum bitrate. MaxBitrate *int32 - // Optional. Specify how the transcoder performs framerate conversion. The default - // behavior is to use Drop duplicate (DUPLICATE_DROP) conversion. When you choose - // Interpolate (INTERPOLATE) instead, the conversion produces smoother motion. - FramerateConversionAlgorithm Vp9FramerateConversionAlgorithm - - // GOP Length (keyframe interval) in frames. Must be greater than zero. - GopSize *float64 + // Optional. Specify how the service determines the pixel aspect ratio for this + // output. The default behavior is to use the same pixel aspect ratio as your input + // video. + ParControl Vp9ParControl - // With the VP9 codec, you can use only the variable bitrate (VBR) rate control - // mode. - RateControlMode Vp9RateControlMode + // Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the + // console, this corresponds to any value other than Follow source. When you + // specify an output pixel aspect ratio (PAR) that is different from your input + // video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC + // widescreen, you would specify the ratio 40:33. In this example, the value for + // parDenominator is 33. + ParDenominator *int32 // Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the // console, this corresponds to any value other than Follow source. When you @@ -5299,41 +5320,24 @@ type Vp9Settings struct { // parNumerator is 40. ParNumerator *int32 - // When you use the API for transcode jobs that use frame rate conversion, specify - // the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use - // FramerateDenominator to specify the denominator of this fraction. In this - // example, use 1001 for the value of FramerateDenominator. When you use the - // console for transcode jobs that use frame rate conversion, provide the value as - // a decimal number for Framerate. In this example, specify 23.976. - FramerateDenominator *int32 - - // If you are using the console, use the Framerate setting to specify the frame - // rate for this output. If you want to keep the same frame rate as the input - // video, choose Follow source. If you want to do frame rate conversion, choose a - // frame rate from the dropdown list or choose Custom. The framerates shown in the - // dropdown list are decimal approximations of fractions. If you choose Custom, - // specify your frame rate as a fraction. If you are creating your transcoding job - // specification as a JSON file without the console, use FramerateControl to - // specify which value the service uses for the frame rate for this output. Choose - // INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the - // input. Choose SPECIFIED if you want the service to use the frame rate you - // specify in the settings FramerateNumerator and FramerateDenominator. - FramerateControl Vp9FramerateControl - - // Target bitrate in bits/second. For example, enter five megabits per second as - // 5000000. - Bitrate *int32 - // Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want // to trade off encoding speed for output video quality. The default behavior is // faster, lower quality, multi-pass encoding. QualityTuningLevel Vp9QualityTuningLevel + + // With the VP9 codec, you can use only the variable bitrate (VBR) rate control + // mode. + RateControlMode Vp9RateControlMode } // Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the // value WAV. type WavSettings struct { + // Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality + // for this audio track. + BitDepth *int32 + // Specify the number of channels in this output audio track. Valid values are 1 // and even numbers up to 64. For example, 1, 2, 4, 6, and so on, up to 64. Channels *int32 @@ -5345,8 +5349,4 @@ type WavSettings struct { // Sample rate in Hz. SampleRate *int32 - - // Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality - // for this audio track. - BitDepth *int32 } diff --git a/service/medialive/api_op_BatchUpdateSchedule.go b/service/medialive/api_op_BatchUpdateSchedule.go index f19f6ed52b0..bcaae9b855f 100644 --- a/service/medialive/api_op_BatchUpdateSchedule.go +++ b/service/medialive/api_op_BatchUpdateSchedule.go @@ -63,22 +63,22 @@ type BatchUpdateScheduleInput struct { // This member is required. ChannelId *string - // Schedule actions to delete from the schedule. - Deletes *types.BatchScheduleActionDeleteRequest - // Schedule actions to create in the schedule. Creates *types.BatchScheduleActionCreateRequest + + // Schedule actions to delete from the schedule. + Deletes *types.BatchScheduleActionDeleteRequest } // Placeholder documentation for BatchUpdateScheduleResponse type BatchUpdateScheduleOutput struct { - // Schedule actions deleted from the schedule. - Deletes *types.BatchScheduleActionDeleteResult - // Schedule actions created in the schedule. Creates *types.BatchScheduleActionCreateResult + // Schedule actions deleted from the schedule. + Deletes *types.BatchScheduleActionDeleteResult + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/medialive/api_op_CreateChannel.go b/service/medialive/api_op_CreateChannel.go index c7eac06896f..e78d77eea81 100644 --- a/service/medialive/api_op_CreateChannel.go +++ b/service/medialive/api_op_CreateChannel.go @@ -60,25 +60,27 @@ func (c *Client) CreateChannel(ctx context.Context, params *CreateChannelInput, // A request to create a channel type CreateChannelInput struct { - // Name of channel. - Name *string + // The class for this channel. STANDARD for a channel with two pipelines or + // SINGLE_PIPELINE for a channel with one pipeline. + ChannelClass types.ChannelClass + + // Placeholder documentation for __listOfOutputDestination + Destinations []*types.OutputDestination // Encoder Settings EncoderSettings *types.EncoderSettings - // The log level to write to CloudWatch Logs. - LogLevel types.LogLevel - // List of input attachments for channel. InputAttachments []*types.InputAttachment - // An optional Amazon Resource Name (ARN) of the role to assume when running the - // Channel. - RoleArn *string + // Specification of input for this channel (max. bitrate, resolution, codec, etc.) + InputSpecification *types.InputSpecification - // The class for this channel. STANDARD for a channel with two pipelines or - // SINGLE_PIPELINE for a channel with one pipeline. - ChannelClass types.ChannelClass + // The log level to write to CloudWatch Logs. + LogLevel types.LogLevel + + // Name of channel. + Name *string // Unique request ID to be specified. This is needed to prevent retries from // creating multiple resources. @@ -87,14 +89,12 @@ type CreateChannelInput struct { // Deprecated field that's only usable by whitelisted customers. Reserved *string + // An optional Amazon Resource Name (ARN) of the role to assume when running the + // Channel. + RoleArn *string + // A collection of key-value pairs. Tags map[string]*string - - // Specification of input for this channel (max. bitrate, resolution, codec, etc.) - InputSpecification *types.InputSpecification - - // Placeholder documentation for __listOfOutputDestination - Destinations []*types.OutputDestination } // Placeholder documentation for CreateChannelResponse diff --git a/service/medialive/api_op_CreateInput.go b/service/medialive/api_op_CreateInput.go index ae27be2ed8d..a33868fbffe 100644 --- a/service/medialive/api_op_CreateInput.go +++ b/service/medialive/api_op_CreateInput.go @@ -60,11 +60,8 @@ func (c *Client) CreateInput(ctx context.Context, params *CreateInputInput, optF // The name of the input type CreateInputInput struct { - // A collection of key-value pairs. - Tags map[string]*string - - // Placeholder documentation for InputType - Type types.InputType + // Destination settings for PUSH type inputs. + Destinations []*types.InputDestinationRequest // Settings for the devices. InputDevices []*types.InputDeviceSettings @@ -72,36 +69,39 @@ type CreateInputInput struct { // A list of security groups referenced by IDs to attach to the input. InputSecurityGroups []*string - // The Amazon Resource Name (ARN) of the role this input assumes during and after - // creation. - RoleArn *string + // A list of the MediaConnect Flows that you want to use in this input. You can + // specify as few as one Flow and presently, as many as two. The only requirement + // is when you have more than one is that each Flow is in a separate Availability + // Zone as this ensures your EML input is redundant to AZ issues. + MediaConnectFlows []*types.MediaConnectFlowRequest // Name of the input. Name *string + // Unique identifier of the request to ensure the request is handled exactly once + // in case of retries. + RequestId *string + + // The Amazon Resource Name (ARN) of the role this input assumes during and after + // creation. + RoleArn *string + // The source URLs for a PULL-type input. Every PULL type input needs exactly two // source URLs for redundancy. Only specify sources for PULL type Inputs. Leave // Destinations empty. Sources []*types.InputSourceRequest - // A list of the MediaConnect Flows that you want to use in this input. You can - // specify as few as one Flow and presently, as many as two. The only requirement - // is when you have more than one is that each Flow is in a separate Availability - // Zone as this ensures your EML input is redundant to AZ issues. - MediaConnectFlows []*types.MediaConnectFlowRequest + // A collection of key-value pairs. + Tags map[string]*string + + // Placeholder documentation for InputType + Type types.InputType // Settings for a private VPC Input. When this property is specified, the input // destination addresses will be created in a VPC rather than with public Internet // addresses. This property requires setting the roleArn property on Input // creation. Not compatible with the inputSecurityGroups property. Vpc *types.InputVpcRequest - - // Destination settings for PUSH type inputs. - Destinations []*types.InputDestinationRequest - - // Unique identifier of the request to ensure the request is handled exactly once - // in case of retries. - RequestId *string } // Placeholder documentation for CreateInputResponse diff --git a/service/medialive/api_op_CreateInputSecurityGroup.go b/service/medialive/api_op_CreateInputSecurityGroup.go index 1522c5fdfbd..aa0943dfd66 100644 --- a/service/medialive/api_op_CreateInputSecurityGroup.go +++ b/service/medialive/api_op_CreateInputSecurityGroup.go @@ -57,11 +57,11 @@ func (c *Client) CreateInputSecurityGroup(ctx context.Context, params *CreateInp // The IPv4 CIDRs to whitelist for this Input Security Group type CreateInputSecurityGroupInput struct { - // List of IPv4 CIDR addresses to whitelist - WhitelistRules []*types.InputWhitelistRuleCidr - // A collection of key-value pairs. Tags map[string]*string + + // List of IPv4 CIDR addresses to whitelist + WhitelistRules []*types.InputWhitelistRuleCidr } // Placeholder documentation for CreateInputSecurityGroupResponse diff --git a/service/medialive/api_op_CreateMultiplex.go b/service/medialive/api_op_CreateMultiplex.go index 8c6a9aef14b..bcf10991896 100644 --- a/service/medialive/api_op_CreateMultiplex.go +++ b/service/medialive/api_op_CreateMultiplex.go @@ -70,6 +70,11 @@ type CreateMultiplexInput struct { // This member is required. MultiplexSettings *types.MultiplexSettings + // Name of multiplex. + // + // This member is required. + Name *string + // Unique request ID. This prevents retries from creating multiple resources. // // This member is required. @@ -77,11 +82,6 @@ type CreateMultiplexInput struct { // A collection of key-value pairs. Tags map[string]*string - - // Name of multiplex. - // - // This member is required. - Name *string } // Placeholder documentation for CreateMultiplexResponse diff --git a/service/medialive/api_op_CreateTags.go b/service/medialive/api_op_CreateTags.go index 60bf934c2dd..c5a943420ce 100644 --- a/service/medialive/api_op_CreateTags.go +++ b/service/medialive/api_op_CreateTags.go @@ -57,13 +57,13 @@ func (c *Client) CreateTags(ctx context.Context, params *CreateTagsInput, optFns // Placeholder documentation for CreateTagsRequest type CreateTagsInput struct { - // Placeholder documentation for Tags - Tags map[string]*string - // Placeholder documentation for __string // // This member is required. ResourceArn *string + + // Placeholder documentation for Tags + Tags map[string]*string } type CreateTagsOutput struct { diff --git a/service/medialive/api_op_DeleteChannel.go b/service/medialive/api_op_DeleteChannel.go index f5483bd5a3b..a3704b20e42 100644 --- a/service/medialive/api_op_DeleteChannel.go +++ b/service/medialive/api_op_DeleteChannel.go @@ -67,38 +67,26 @@ type DeleteChannelInput struct { // Placeholder documentation for DeleteChannelResponse type DeleteChannelOutput struct { - // A list of destinations of the channel. For UDP outputs, there is one destination - // per output. For other types (HLS, for example), there is one destination per - // packager. - Destinations []*types.OutputDestination - - // The unique id of the channel. - Id *string - - // Encoder Settings - EncoderSettings *types.EncoderSettings + // The unique arn of the channel. + Arn *string // The class for this channel. STANDARD for a channel with two pipelines or // SINGLE_PIPELINE for a channel with one pipeline. ChannelClass types.ChannelClass - // Runtime details for the pipelines of a running channel. - PipelineDetails []*types.PipelineDetail - - // The unique arn of the channel. - Arn *string - - // A collection of key-value pairs. - Tags map[string]*string + // A list of destinations of the channel. For UDP outputs, there is one destination + // per output. For other types (HLS, for example), there is one destination per + // packager. + Destinations []*types.OutputDestination // The endpoints where outgoing connections initiate from EgressEndpoints []*types.ChannelEgressEndpoint - // The number of currently healthy pipelines. - PipelinesRunningCount *int32 + // Encoder Settings + EncoderSettings *types.EncoderSettings - // Placeholder documentation for ChannelState - State types.ChannelState + // The unique id of the channel. + Id *string // List of input attachments for channel. InputAttachments []*types.InputAttachment @@ -109,11 +97,23 @@ type DeleteChannelOutput struct { // The log level being written to CloudWatch Logs. LogLevel types.LogLevel + // The name of the channel. (user-mutable) + Name *string + + // Runtime details for the pipelines of a running channel. + PipelineDetails []*types.PipelineDetail + + // The number of currently healthy pipelines. + PipelinesRunningCount *int32 + // The Amazon Resource Name (ARN) of the role assumed when running the Channel. RoleArn *string - // The name of the channel. (user-mutable) - Name *string + // Placeholder documentation for ChannelState + State types.ChannelState + + // A collection of key-value pairs. + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/medialive/api_op_DeleteMultiplex.go b/service/medialive/api_op_DeleteMultiplex.go index cb09aa195cd..a5c65775c5b 100644 --- a/service/medialive/api_op_DeleteMultiplex.go +++ b/service/medialive/api_op_DeleteMultiplex.go @@ -67,35 +67,35 @@ type DeleteMultiplexInput struct { // Placeholder documentation for DeleteMultiplexResponse type DeleteMultiplexOutput struct { - // A collection of key-value pairs. - Tags map[string]*string + // The unique arn of the multiplex. + Arn *string // A list of availability zones for the multiplex. AvailabilityZones []*string - // The name of the multiplex. - Name *string - // A list of the multiplex output destinations. Destinations []*types.MultiplexOutputDestination - // The current state of the multiplex. - State types.MultiplexState + // The unique id of the multiplex. + Id *string - // The unique arn of the multiplex. - Arn *string + // Configuration for a multiplex event. + MultiplexSettings *types.MultiplexSettings - // The number of programs in the multiplex. - ProgramCount *int32 + // The name of the multiplex. + Name *string // The number of currently healthy pipelines. PipelinesRunningCount *int32 - // Configuration for a multiplex event. - MultiplexSettings *types.MultiplexSettings + // The number of programs in the multiplex. + ProgramCount *int32 - // The unique id of the multiplex. - Id *string + // The current state of the multiplex. + State types.MultiplexState + + // A collection of key-value pairs. + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/medialive/api_op_DeleteMultiplexProgram.go b/service/medialive/api_op_DeleteMultiplexProgram.go index 599f312ea3b..743d4e43aec 100644 --- a/service/medialive/api_op_DeleteMultiplexProgram.go +++ b/service/medialive/api_op_DeleteMultiplexProgram.go @@ -58,32 +58,32 @@ func (c *Client) DeleteMultiplexProgram(ctx context.Context, params *DeleteMulti // Placeholder documentation for DeleteMultiplexProgramRequest type DeleteMultiplexProgramInput struct { - // The multiplex program name. + // The ID of the multiplex that the program belongs to. // // This member is required. - ProgramName *string + MultiplexId *string - // The ID of the multiplex that the program belongs to. + // The multiplex program name. // // This member is required. - MultiplexId *string + ProgramName *string } // Placeholder documentation for DeleteMultiplexProgramResponse type DeleteMultiplexProgramOutput struct { - // The settings for this multiplex program. - MultiplexProgramSettings *types.MultiplexProgramSettings - // The MediaLive channel associated with the program. ChannelId *string - // The name of the multiplex program. - ProgramName *string + // The settings for this multiplex program. + MultiplexProgramSettings *types.MultiplexProgramSettings // The packet identifier map for this multiplex program. PacketIdentifiersMap *types.MultiplexProgramPacketIdentifiersMap + // The name of the multiplex program. + ProgramName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/medialive/api_op_DeleteReservation.go b/service/medialive/api_op_DeleteReservation.go index 8efd054804c..036903ec177 100644 --- a/service/medialive/api_op_DeleteReservation.go +++ b/service/medialive/api_op_DeleteReservation.go @@ -67,63 +67,63 @@ type DeleteReservationInput struct { // Placeholder documentation for DeleteReservationResponse type DeleteReservationOutput struct { - // Unique offering ID, e.g. '87654321' - OfferingId *string + // Unique reservation ARN, e.g. + // 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567' + Arn *string - // Reservation UTC start date and time in ISO-8601 format, e.g. - // '2018-03-01T00:00:00' - Start *string + // Number of reserved resources + Count *int32 + + // Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD' + CurrencyCode *string + + // Lease duration, e.g. '12' + Duration *int32 + + // Units for duration, e.g. 'MONTHS' + DurationUnits types.OfferingDurationUnits // Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00' End *string - // Unique reservation ARN, e.g. - // 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567' - Arn *string - // One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering FixedPrice *float64 - // AWS region, e.g. 'us-west-2' - Region *string - - // A collection of key-value pairs - Tags map[string]*string + // User specified reservation name + Name *string // Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ // in US West (Oregon)' OfferingDescription *string + // Unique offering ID, e.g. '87654321' + OfferingId *string + + // Offering type, e.g. 'NO_UPFRONT' + OfferingType types.OfferingType + + // AWS region, e.g. 'us-west-2' + Region *string + // Unique reservation ID, e.g. '1234567' ReservationId *string - // Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD' - CurrencyCode *string + // Resource configuration details + ResourceSpecification *types.ReservationResourceSpecification - // Units for duration, e.g. 'MONTHS' - DurationUnits types.OfferingDurationUnits + // Reservation UTC start date and time in ISO-8601 format, e.g. + // '2018-03-01T00:00:00' + Start *string // Current state of reservation, e.g. 'ACTIVE' State types.ReservationState - // User specified reservation name - Name *string - - // Lease duration, e.g. '12' - Duration *int32 + // A collection of key-value pairs + Tags map[string]*string // Recurring usage charge for each reserved resource, e.g. '157.0' UsagePrice *float64 - // Offering type, e.g. 'NO_UPFRONT' - OfferingType types.OfferingType - - // Number of reserved resources - Count *int32 - - // Resource configuration details - ResourceSpecification *types.ReservationResourceSpecification - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/medialive/api_op_DescribeChannel.go b/service/medialive/api_op_DescribeChannel.go index 31ca3f58c3c..ff28d28f5f2 100644 --- a/service/medialive/api_op_DescribeChannel.go +++ b/service/medialive/api_op_DescribeChannel.go @@ -70,50 +70,50 @@ type DescribeChannelOutput struct { // The unique arn of the channel. Arn *string - // The Amazon Resource Name (ARN) of the role assumed when running the Channel. - RoleArn *string + // The class for this channel. STANDARD for a channel with two pipelines or + // SINGLE_PIPELINE for a channel with one pipeline. + ChannelClass types.ChannelClass // A list of destinations of the channel. For UDP outputs, there is one destination // per output. For other types (HLS, for example), there is one destination per // packager. Destinations []*types.OutputDestination - // Placeholder documentation for InputSpecification - InputSpecification *types.InputSpecification - - // Runtime details for the pipelines of a running channel. - PipelineDetails []*types.PipelineDetail - // The endpoints where outgoing connections initiate from EgressEndpoints []*types.ChannelEgressEndpoint - // A collection of key-value pairs. - Tags map[string]*string - - // The class for this channel. STANDARD for a channel with two pipelines or - // SINGLE_PIPELINE for a channel with one pipeline. - ChannelClass types.ChannelClass - - // The number of currently healthy pipelines. - PipelinesRunningCount *int32 + // Encoder Settings + EncoderSettings *types.EncoderSettings // The unique id of the channel. Id *string - // Placeholder documentation for ChannelState - State types.ChannelState + // List of input attachments for channel. + InputAttachments []*types.InputAttachment - // The name of the channel. (user-mutable) - Name *string + // Placeholder documentation for InputSpecification + InputSpecification *types.InputSpecification // The log level being written to CloudWatch Logs. LogLevel types.LogLevel - // Encoder Settings - EncoderSettings *types.EncoderSettings + // The name of the channel. (user-mutable) + Name *string - // List of input attachments for channel. - InputAttachments []*types.InputAttachment + // Runtime details for the pipelines of a running channel. + PipelineDetails []*types.PipelineDetail + + // The number of currently healthy pipelines. + PipelinesRunningCount *int32 + + // The Amazon Resource Name (ARN) of the role assumed when running the Channel. + RoleArn *string + + // Placeholder documentation for ChannelState + State types.ChannelState + + // A collection of key-value pairs. + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/medialive/api_op_DescribeInput.go b/service/medialive/api_op_DescribeInput.go index 685720fea33..fa2dab0cb2e 100644 --- a/service/medialive/api_op_DescribeInput.go +++ b/service/medialive/api_op_DescribeInput.go @@ -67,60 +67,60 @@ type DescribeInputInput struct { // Placeholder documentation for DescribeInputResponse type DescribeInputOutput struct { - // Placeholder documentation for InputType - Type types.InputType + // The Unique ARN of the input (generated, immutable). + Arn *string - // A collection of key-value pairs. - Tags map[string]*string + // A list of channel IDs that that input is attached to (currently an input can + // only be attached to one channel). + AttachedChannels []*string - // A list of MediaConnect Flows for this input. - MediaConnectFlows []*types.MediaConnectFlow + // A list of the destinations of the input (PUSH-type). + Destinations []*types.InputDestination // The generated ID of the input (unique for user account, immutable). Id *string - // The Amazon Resource Name (ARN) of the role this input assumes during and after - // creation. - RoleArn *string - - // Placeholder documentation for InputState - State types.InputState + // STANDARD - MediaLive expects two sources to be connected to this input. If the + // channel is also STANDARD, both sources will be ingested. If the channel is + // SINGLE_PIPELINE, only the first source will be ingested; the second source will + // always be ignored, even if the first source fails. SINGLE_PIPELINE - You can + // connect only one source to this input. If the ChannelClass is also + // SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this + // value is not valid because the channel requires two sources in the input. + InputClass types.InputClass - // A list of the destinations of the input (PUSH-type). - Destinations []*types.InputDestination + // Settings for the input devices. + InputDevices []*types.InputDeviceSettings // Certain pull input sources can be dynamic, meaning that they can have their // URL's dynamically changes during input switch actions. Presently, this // functionality only works with MP4_FILE inputs. InputSourceType types.InputSourceType - // Settings for the input devices. - InputDevices []*types.InputDeviceSettings + // A list of MediaConnect Flows for this input. + MediaConnectFlows []*types.MediaConnectFlow // The user-assigned name (This is a mutable value). Name *string - // STANDARD - MediaLive expects two sources to be connected to this input. If the - // channel is also STANDARD, both sources will be ingested. If the channel is - // SINGLE_PIPELINE, only the first source will be ingested; the second source will - // always be ignored, even if the first source fails. SINGLE_PIPELINE - You can - // connect only one source to this input. If the ChannelClass is also - // SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this - // value is not valid because the channel requires two sources in the input. - InputClass types.InputClass + // The Amazon Resource Name (ARN) of the role this input assumes during and after + // creation. + RoleArn *string - // A list of channel IDs that that input is attached to (currently an input can - // only be attached to one channel). - AttachedChannels []*string + // A list of IDs for all the Input Security Groups attached to the input. + SecurityGroups []*string // A list of the sources of the input (PULL-type). Sources []*types.InputSource - // The Unique ARN of the input (generated, immutable). - Arn *string + // Placeholder documentation for InputState + State types.InputState - // A list of IDs for all the Input Security Groups attached to the input. - SecurityGroups []*string + // A collection of key-value pairs. + Tags map[string]*string + + // Placeholder documentation for InputType + Type types.InputType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/medialive/api_op_DescribeInputDevice.go b/service/medialive/api_op_DescribeInputDevice.go index 5e7cda1e5f4..9392148b49e 100644 --- a/service/medialive/api_op_DescribeInputDevice.go +++ b/service/medialive/api_op_DescribeInputDevice.go @@ -67,24 +67,12 @@ type DescribeInputDeviceInput struct { // Placeholder documentation for DescribeInputDeviceResponse type DescribeInputDeviceOutput struct { - // The network MAC address of the input device. - MacAddress *string - // The unique ARN of the input device. Arn *string // The state of the connection between the input device and AWS. ConnectionState types.InputDeviceConnectionState - // The unique ID of the input device. - Id *string - - // The network settings for the input device. - NetworkSettings *types.InputDeviceNetworkSettings - - // The unique serial number of the input device. - SerialNumber *string - // The status of the action to synchronize the device configuration. If you change // the configuration of the input device (for example, the maximum bitrate), // MediaLive sends the new data to the device. The device might not update itself @@ -92,15 +80,27 @@ type DescribeInputDeviceOutput struct { // means that it has not updated its configuration. DeviceSettingsSyncState types.DeviceSettingsSyncState - // The type of the input device. - Type types.InputDeviceType - // Settings that describe an input device that is type HD. HdDeviceSettings *types.InputDeviceHdSettings + // The unique ID of the input device. + Id *string + + // The network MAC address of the input device. + MacAddress *string + // A name that you specify for the input device. Name *string + // The network settings for the input device. + NetworkSettings *types.InputDeviceNetworkSettings + + // The unique serial number of the input device. + SerialNumber *string + + // The type of the input device. + Type types.InputDeviceType + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/medialive/api_op_DescribeInputDeviceThumbnail.go b/service/medialive/api_op_DescribeInputDeviceThumbnail.go index 92f7a265a03..321bb63ac8c 100644 --- a/service/medialive/api_op_DescribeInputDeviceThumbnail.go +++ b/service/medialive/api_op_DescribeInputDeviceThumbnail.go @@ -59,36 +59,36 @@ func (c *Client) DescribeInputDeviceThumbnail(ctx context.Context, params *Descr // Placeholder documentation for DescribeInputDeviceThumbnailRequest type DescribeInputDeviceThumbnailInput struct { - // The unique ID of this input device. For example, hd-123456789abcdef. + // The HTTP Accept header. Indicates the requested type for the thumbnail. // // This member is required. - InputDeviceId *string + Accept types.AcceptHeader - // The HTTP Accept header. Indicates the requested type for the thumbnail. + // The unique ID of this input device. For example, hd-123456789abcdef. // // This member is required. - Accept types.AcceptHeader + InputDeviceId *string } // Placeholder documentation for DescribeInputDeviceThumbnailResponse type DescribeInputDeviceThumbnailOutput struct { - // Specifies the media type of the thumbnail. - ContentType types.ContentType + // The binary data for the thumbnail that the Link device has most recently sent to + // MediaLive. + Body io.ReadCloser // The length of the content. ContentLength *int64 + // Specifies the media type of the thumbnail. + ContentType types.ContentType + // The unique, cacheable version of this thumbnail. ETag *string // The date and time the thumbnail was last updated at the device. LastModified *time.Time - // The binary data for the thumbnail that the Link device has most recently sent to - // MediaLive. - Body io.ReadCloser - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/medialive/api_op_DescribeInputSecurityGroup.go b/service/medialive/api_op_DescribeInputSecurityGroup.go index d596c51f11a..730752d39a9 100644 --- a/service/medialive/api_op_DescribeInputSecurityGroup.go +++ b/service/medialive/api_op_DescribeInputSecurityGroup.go @@ -70,11 +70,8 @@ type DescribeInputSecurityGroupOutput struct { // Unique ARN of Input Security Group Arn *string - // Whitelist rules and their sync status - WhitelistRules []*types.InputWhitelistRule - - // A collection of key-value pairs. - Tags map[string]*string + // The Id of the Input Security Group + Id *string // The list of inputs currently using this Input Security Group. Inputs []*string @@ -82,8 +79,11 @@ type DescribeInputSecurityGroupOutput struct { // The current state of the Input Security Group. State types.InputSecurityGroupState - // The Id of the Input Security Group - Id *string + // A collection of key-value pairs. + Tags map[string]*string + + // Whitelist rules and their sync status + WhitelistRules []*types.InputWhitelistRule // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/medialive/api_op_DescribeMultiplex.go b/service/medialive/api_op_DescribeMultiplex.go index e6c5c98ed2b..6006a71d7e4 100644 --- a/service/medialive/api_op_DescribeMultiplex.go +++ b/service/medialive/api_op_DescribeMultiplex.go @@ -67,8 +67,8 @@ type DescribeMultiplexInput struct { // Placeholder documentation for DescribeMultiplexResponse type DescribeMultiplexOutput struct { - // A collection of key-value pairs. - Tags map[string]*string + // The unique arn of the multiplex. + Arn *string // A list of availability zones for the multiplex. AvailabilityZones []*string @@ -76,14 +76,11 @@ type DescribeMultiplexOutput struct { // A list of the multiplex output destinations. Destinations []*types.MultiplexOutputDestination - // The current state of the multiplex. - State types.MultiplexState - - // The number of programs in the multiplex. - ProgramCount *int32 + // The unique id of the multiplex. + Id *string - // The unique arn of the multiplex. - Arn *string + // Configuration for a multiplex event. + MultiplexSettings *types.MultiplexSettings // The name of the multiplex. Name *string @@ -91,11 +88,14 @@ type DescribeMultiplexOutput struct { // The number of currently healthy pipelines. PipelinesRunningCount *int32 - // Configuration for a multiplex event. - MultiplexSettings *types.MultiplexSettings + // The number of programs in the multiplex. + ProgramCount *int32 - // The unique id of the multiplex. - Id *string + // The current state of the multiplex. + State types.MultiplexState + + // A collection of key-value pairs. + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/medialive/api_op_DescribeMultiplexProgram.go b/service/medialive/api_op_DescribeMultiplexProgram.go index fb21e4d8b18..7a110cdd94a 100644 --- a/service/medialive/api_op_DescribeMultiplexProgram.go +++ b/service/medialive/api_op_DescribeMultiplexProgram.go @@ -75,15 +75,15 @@ type DescribeMultiplexProgramOutput struct { // The MediaLive channel associated with the program. ChannelId *string - // The name of the multiplex program. - ProgramName *string - // The settings for this multiplex program. MultiplexProgramSettings *types.MultiplexProgramSettings // The packet identifier map for this multiplex program. PacketIdentifiersMap *types.MultiplexProgramPacketIdentifiersMap + // The name of the multiplex program. + ProgramName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/medialive/api_op_DescribeOffering.go b/service/medialive/api_op_DescribeOffering.go index f4f0e1aa3d7..bcdfe087d7f 100644 --- a/service/medialive/api_op_DescribeOffering.go +++ b/service/medialive/api_op_DescribeOffering.go @@ -67,40 +67,40 @@ type DescribeOfferingInput struct { // Placeholder documentation for DescribeOfferingResponse type DescribeOfferingOutput struct { + // Unique offering ARN, e.g. + // 'arn:aws:medialive:us-west-2:123456789012:offering:87654321' + Arn *string + + // Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD' + CurrencyCode *string + // Lease duration, e.g. '12' Duration *int32 - // AWS region, e.g. 'us-west-2' - Region *string + // Units for duration, e.g. 'MONTHS' + DurationUnits types.OfferingDurationUnits - // Resource configuration details - ResourceSpecification *types.ReservationResourceSpecification + // One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering + FixedPrice *float64 // Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ // in US West (Oregon)' OfferingDescription *string - // Recurring usage charge for each reserved resource, e.g. '157.0' - UsagePrice *float64 - - // Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD' - CurrencyCode *string + // Unique offering ID, e.g. '87654321' + OfferingId *string // Offering type, e.g. 'NO_UPFRONT' OfferingType types.OfferingType - // Unique offering ID, e.g. '87654321' - OfferingId *string - - // Units for duration, e.g. 'MONTHS' - DurationUnits types.OfferingDurationUnits + // AWS region, e.g. 'us-west-2' + Region *string - // Unique offering ARN, e.g. - // 'arn:aws:medialive:us-west-2:123456789012:offering:87654321' - Arn *string + // Resource configuration details + ResourceSpecification *types.ReservationResourceSpecification - // One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering - FixedPrice *float64 + // Recurring usage charge for each reserved resource, e.g. '157.0' + UsagePrice *float64 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/medialive/api_op_DescribeReservation.go b/service/medialive/api_op_DescribeReservation.go index a725e068d94..6df800080bf 100644 --- a/service/medialive/api_op_DescribeReservation.go +++ b/service/medialive/api_op_DescribeReservation.go @@ -67,63 +67,63 @@ type DescribeReservationInput struct { // Placeholder documentation for DescribeReservationResponse type DescribeReservationOutput struct { + // Unique reservation ARN, e.g. + // 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567' + Arn *string + // Number of reserved resources Count *int32 - // One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering - FixedPrice *float64 + // Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD' + CurrencyCode *string - // Current state of reservation, e.g. 'ACTIVE' - State types.ReservationState + // Lease duration, e.g. '12' + Duration *int32 // Units for duration, e.g. 'MONTHS' DurationUnits types.OfferingDurationUnits + // Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00' + End *string + + // One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering + FixedPrice *float64 + // User specified reservation name Name *string - // AWS region, e.g. 'us-west-2' - Region *string - - // Offering type, e.g. 'NO_UPFRONT' - OfferingType types.OfferingType + // Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ + // in US West (Oregon)' + OfferingDescription *string // Unique offering ID, e.g. '87654321' OfferingId *string - // A collection of key-value pairs - Tags map[string]*string + // Offering type, e.g. 'NO_UPFRONT' + OfferingType types.OfferingType - // Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ - // in US West (Oregon)' - OfferingDescription *string + // AWS region, e.g. 'us-west-2' + Region *string // Unique reservation ID, e.g. '1234567' ReservationId *string + // Resource configuration details + ResourceSpecification *types.ReservationResourceSpecification + // Reservation UTC start date and time in ISO-8601 format, e.g. // '2018-03-01T00:00:00' Start *string - // Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00' - End *string - - // Unique reservation ARN, e.g. - // 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567' - Arn *string - - // Resource configuration details - ResourceSpecification *types.ReservationResourceSpecification + // Current state of reservation, e.g. 'ACTIVE' + State types.ReservationState - // Lease duration, e.g. '12' - Duration *int32 + // A collection of key-value pairs + Tags map[string]*string // Recurring usage charge for each reserved resource, e.g. '157.0' UsagePrice *float64 - // Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD' - CurrencyCode *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/medialive/api_op_DescribeSchedule.go b/service/medialive/api_op_DescribeSchedule.go index f5ece15950c..40f4161b4c4 100644 --- a/service/medialive/api_op_DescribeSchedule.go +++ b/service/medialive/api_op_DescribeSchedule.go @@ -58,9 +58,6 @@ func (c *Client) DescribeSchedule(ctx context.Context, params *DescribeScheduleI // Placeholder documentation for DescribeScheduleRequest type DescribeScheduleInput struct { - // Placeholder documentation for __string - NextToken *string - // Id of the channel whose schedule is being updated. // // This member is required. @@ -68,6 +65,9 @@ type DescribeScheduleInput struct { // Placeholder documentation for MaxResults MaxResults *int32 + + // Placeholder documentation for __string + NextToken *string } // Placeholder documentation for DescribeScheduleResponse diff --git a/service/medialive/api_op_ListChannels.go b/service/medialive/api_op_ListChannels.go index 820ae96113e..fb133bf6670 100644 --- a/service/medialive/api_op_ListChannels.go +++ b/service/medialive/api_op_ListChannels.go @@ -67,12 +67,12 @@ type ListChannelsInput struct { // Placeholder documentation for ListChannelsResponse type ListChannelsOutput struct { - // Placeholder documentation for __string - NextToken *string - // Placeholder documentation for __listOfChannelSummary Channels []*types.ChannelSummary + // Placeholder documentation for __string + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/medialive/api_op_ListInputs.go b/service/medialive/api_op_ListInputs.go index 6ec81ce4a1c..7276f78ceed 100644 --- a/service/medialive/api_op_ListInputs.go +++ b/service/medialive/api_op_ListInputs.go @@ -57,11 +57,11 @@ func (c *Client) ListInputs(ctx context.Context, params *ListInputsInput, optFns // Placeholder documentation for ListInputsRequest type ListInputsInput struct { - // Placeholder documentation for __string - NextToken *string - // Placeholder documentation for MaxResults MaxResults *int32 + + // Placeholder documentation for __string + NextToken *string } // Placeholder documentation for ListInputsResponse diff --git a/service/medialive/api_op_ListMultiplexPrograms.go b/service/medialive/api_op_ListMultiplexPrograms.go index 51c44eb4415..e3babf01ca2 100644 --- a/service/medialive/api_op_ListMultiplexPrograms.go +++ b/service/medialive/api_op_ListMultiplexPrograms.go @@ -63,11 +63,11 @@ type ListMultiplexProgramsInput struct { // This member is required. MultiplexId *string - // The token to retrieve the next page of results. - NextToken *string - // The maximum number of items to return. MaxResults *int32 + + // The token to retrieve the next page of results. + NextToken *string } // Placeholder documentation for ListMultiplexProgramsResponse diff --git a/service/medialive/api_op_ListOfferings.go b/service/medialive/api_op_ListOfferings.go index 83a109582d6..b65ee6024d6 100644 --- a/service/medialive/api_op_ListOfferings.go +++ b/service/medialive/api_op_ListOfferings.go @@ -57,33 +57,18 @@ func (c *Client) ListOfferings(ctx context.Context, params *ListOfferingsInput, // Placeholder documentation for ListOfferingsRequest type ListOfferingsInput struct { - // Filter by codec, 'AVC', 'HEVC', 'MPEG2', or 'AUDIO' - Codec *string - // Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE' ChannelClass *string - // Filter by offering duration, e.g. '12' - Duration *string - - // Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD' - Resolution *string - - // Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS' - MaximumFramerate *string - // Filter to offerings that match the configuration of an existing channel, e.g. // '2345678' (a channel ID) ChannelConfiguration *string - // Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL' - ResourceType *string - - // Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM' - VideoQuality *string + // Filter by codec, 'AVC', 'HEVC', 'MPEG2', or 'AUDIO' + Codec *string - // Placeholder documentation for __string - NextToken *string + // Filter by offering duration, e.g. '12' + Duration *string // Placeholder documentation for MaxResults MaxResults *int32 @@ -91,19 +76,34 @@ type ListOfferingsInput struct { // Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS' MaximumBitrate *string + // Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS' + MaximumFramerate *string + + // Placeholder documentation for __string + NextToken *string + + // Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD' + Resolution *string + + // Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL' + ResourceType *string + // Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION' SpecialFeature *string + + // Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM' + VideoQuality *string } // Placeholder documentation for ListOfferingsResponse type ListOfferingsOutput struct { - // List of offerings - Offerings []*types.Offering - // Token to retrieve the next page of results NextToken *string + // List of offerings + Offerings []*types.Offering + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/medialive/api_op_ListReservations.go b/service/medialive/api_op_ListReservations.go index 5d7ea6dc4b0..c9fb3a962cd 100644 --- a/service/medialive/api_op_ListReservations.go +++ b/service/medialive/api_op_ListReservations.go @@ -57,46 +57,46 @@ func (c *Client) ListReservations(ctx context.Context, params *ListReservationsI // Placeholder documentation for ListReservationsRequest type ListReservationsInput struct { - // Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD' - Resolution *string - - // Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL' - ResourceType *string + // Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE' + ChannelClass *string - // Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS' - MaximumFramerate *string + // Filter by codec, 'AVC', 'HEVC', 'MPEG2', or 'AUDIO' + Codec *string // Placeholder documentation for MaxResults MaxResults *int32 + // Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS' + MaximumBitrate *string + + // Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS' + MaximumFramerate *string + // Placeholder documentation for __string NextToken *string - // Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS' - MaximumBitrate *string + // Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD' + Resolution *string + + // Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL' + ResourceType *string // Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION' SpecialFeature *string - // Filter by codec, 'AVC', 'HEVC', 'MPEG2', or 'AUDIO' - Codec *string - // Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM' VideoQuality *string - - // Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE' - ChannelClass *string } // Placeholder documentation for ListReservationsResponse type ListReservationsOutput struct { - // List of reservations - Reservations []*types.Reservation - // Token to retrieve the next page of results NextToken *string + // List of reservations + Reservations []*types.Reservation + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/medialive/api_op_PurchaseOffering.go b/service/medialive/api_op_PurchaseOffering.go index 7d53eb360e2..ccbd7a5c547 100644 --- a/service/medialive/api_op_PurchaseOffering.go +++ b/service/medialive/api_op_PurchaseOffering.go @@ -60,30 +60,30 @@ func (c *Client) PurchaseOffering(ctx context.Context, params *PurchaseOfferingI // Placeholder documentation for PurchaseOfferingRequest type PurchaseOfferingInput struct { + // Number of resources + // + // This member is required. + Count *int32 + // Offering to purchase, e.g. '87654321' // // This member is required. OfferingId *string - // A collection of key-value pairs - Tags map[string]*string - // Name for the new reservation Name *string + // Unique request ID to be specified. This is needed to prevent retries from + // creating multiple resources. + RequestId *string + // Requested reservation start time (UTC) in ISO-8601 format. The specified time // must be between the first day of the current month and one year from now. If no // value is given, the default is now. Start *string - // Unique request ID to be specified. This is needed to prevent retries from - // creating multiple resources. - RequestId *string - - // Number of resources - // - // This member is required. - Count *int32 + // A collection of key-value pairs + Tags map[string]*string } // Placeholder documentation for PurchaseOfferingResponse diff --git a/service/medialive/api_op_StartChannel.go b/service/medialive/api_op_StartChannel.go index 63410783eaf..a1d918b5252 100644 --- a/service/medialive/api_op_StartChannel.go +++ b/service/medialive/api_op_StartChannel.go @@ -67,54 +67,54 @@ type StartChannelInput struct { // Placeholder documentation for StartChannelResponse type StartChannelOutput struct { + // The unique arn of the channel. + Arn *string + + // The class for this channel. STANDARD for a channel with two pipelines or + // SINGLE_PIPELINE for a channel with one pipeline. + ChannelClass types.ChannelClass + // A list of destinations of the channel. For UDP outputs, there is one destination // per output. For other types (HLS, for example), there is one destination per // packager. Destinations []*types.OutputDestination + // The endpoints where outgoing connections initiate from + EgressEndpoints []*types.ChannelEgressEndpoint + // Encoder Settings EncoderSettings *types.EncoderSettings - // The log level being written to CloudWatch Logs. - LogLevel types.LogLevel + // The unique id of the channel. + Id *string + + // List of input attachments for channel. + InputAttachments []*types.InputAttachment // Placeholder documentation for InputSpecification InputSpecification *types.InputSpecification - // The Amazon Resource Name (ARN) of the role assumed when running the Channel. - RoleArn *string - - // List of input attachments for channel. - InputAttachments []*types.InputAttachment + // The log level being written to CloudWatch Logs. + LogLevel types.LogLevel // The name of the channel. (user-mutable) Name *string - // Placeholder documentation for ChannelState - State types.ChannelState - - // The endpoints where outgoing connections initiate from - EgressEndpoints []*types.ChannelEgressEndpoint - - // A collection of key-value pairs. - Tags map[string]*string - - // The unique arn of the channel. - Arn *string - - // The unique id of the channel. - Id *string - - // The class for this channel. STANDARD for a channel with two pipelines or - // SINGLE_PIPELINE for a channel with one pipeline. - ChannelClass types.ChannelClass - // Runtime details for the pipelines of a running channel. PipelineDetails []*types.PipelineDetail // The number of currently healthy pipelines. PipelinesRunningCount *int32 + // The Amazon Resource Name (ARN) of the role assumed when running the Channel. + RoleArn *string + + // Placeholder documentation for ChannelState + State types.ChannelState + + // A collection of key-value pairs. + Tags map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/medialive/api_op_StartMultiplex.go b/service/medialive/api_op_StartMultiplex.go index d07832ab4ef..ff9d433194d 100644 --- a/service/medialive/api_op_StartMultiplex.go +++ b/service/medialive/api_op_StartMultiplex.go @@ -68,36 +68,36 @@ type StartMultiplexInput struct { // Placeholder documentation for StartMultiplexResponse type StartMultiplexOutput struct { - // Configuration for a multiplex event. - MultiplexSettings *types.MultiplexSettings + // The unique arn of the multiplex. + Arn *string + + // A list of availability zones for the multiplex. + AvailabilityZones []*string + + // A list of the multiplex output destinations. + Destinations []*types.MultiplexOutputDestination // The unique id of the multiplex. Id *string - // The current state of the multiplex. - State types.MultiplexState + // Configuration for a multiplex event. + MultiplexSettings *types.MultiplexSettings - // A list of availability zones for the multiplex. - AvailabilityZones []*string + // The name of the multiplex. + Name *string // The number of currently healthy pipelines. PipelinesRunningCount *int32 - // The name of the multiplex. - Name *string + // The number of programs in the multiplex. + ProgramCount *int32 - // A list of the multiplex output destinations. - Destinations []*types.MultiplexOutputDestination + // The current state of the multiplex. + State types.MultiplexState // A collection of key-value pairs. Tags map[string]*string - // The unique arn of the multiplex. - Arn *string - - // The number of programs in the multiplex. - ProgramCount *int32 - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/medialive/api_op_StopChannel.go b/service/medialive/api_op_StopChannel.go index 8fc706d7cdd..2a21ef8a902 100644 --- a/service/medialive/api_op_StopChannel.go +++ b/service/medialive/api_op_StopChannel.go @@ -67,53 +67,53 @@ type StopChannelInput struct { // Placeholder documentation for StopChannelResponse type StopChannelOutput struct { - // A collection of key-value pairs. - Tags map[string]*string - - // The log level being written to CloudWatch Logs. - LogLevel types.LogLevel - - // The endpoints where outgoing connections initiate from - EgressEndpoints []*types.ChannelEgressEndpoint + // The unique arn of the channel. + Arn *string // The class for this channel. STANDARD for a channel with two pipelines or // SINGLE_PIPELINE for a channel with one pipeline. ChannelClass types.ChannelClass - // Placeholder documentation for ChannelState - State types.ChannelState - - // The name of the channel. (user-mutable) - Name *string - - // The Amazon Resource Name (ARN) of the role assumed when running the Channel. - RoleArn *string - // A list of destinations of the channel. For UDP outputs, there is one destination // per output. For other types (HLS, for example), there is one destination per // packager. Destinations []*types.OutputDestination + // The endpoints where outgoing connections initiate from + EgressEndpoints []*types.ChannelEgressEndpoint + + // Encoder Settings + EncoderSettings *types.EncoderSettings + + // The unique id of the channel. + Id *string + + // List of input attachments for channel. + InputAttachments []*types.InputAttachment + // Placeholder documentation for InputSpecification InputSpecification *types.InputSpecification - // The number of currently healthy pipelines. - PipelinesRunningCount *int32 + // The log level being written to CloudWatch Logs. + LogLevel types.LogLevel - // The unique arn of the channel. - Arn *string + // The name of the channel. (user-mutable) + Name *string // Runtime details for the pipelines of a running channel. PipelineDetails []*types.PipelineDetail - // List of input attachments for channel. - InputAttachments []*types.InputAttachment + // The number of currently healthy pipelines. + PipelinesRunningCount *int32 - // The unique id of the channel. - Id *string + // The Amazon Resource Name (ARN) of the role assumed when running the Channel. + RoleArn *string - // Encoder Settings - EncoderSettings *types.EncoderSettings + // Placeholder documentation for ChannelState + State types.ChannelState + + // A collection of key-value pairs. + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/medialive/api_op_StopMultiplex.go b/service/medialive/api_op_StopMultiplex.go index fdbcb7c8e83..f3b23ba8563 100644 --- a/service/medialive/api_op_StopMultiplex.go +++ b/service/medialive/api_op_StopMultiplex.go @@ -68,17 +68,14 @@ type StopMultiplexInput struct { // Placeholder documentation for StopMultiplexResponse type StopMultiplexOutput struct { - // A list of the multiplex output destinations. - Destinations []*types.MultiplexOutputDestination - - // The number of programs in the multiplex. - ProgramCount *int32 + // The unique arn of the multiplex. + Arn *string - // The current state of the multiplex. - State types.MultiplexState + // A list of availability zones for the multiplex. + AvailabilityZones []*string - // The name of the multiplex. - Name *string + // A list of the multiplex output destinations. + Destinations []*types.MultiplexOutputDestination // The unique id of the multiplex. Id *string @@ -86,14 +83,17 @@ type StopMultiplexOutput struct { // Configuration for a multiplex event. MultiplexSettings *types.MultiplexSettings - // The unique arn of the multiplex. - Arn *string + // The name of the multiplex. + Name *string // The number of currently healthy pipelines. PipelinesRunningCount *int32 - // A list of availability zones for the multiplex. - AvailabilityZones []*string + // The number of programs in the multiplex. + ProgramCount *int32 + + // The current state of the multiplex. + State types.MultiplexState // A collection of key-value pairs. Tags map[string]*string diff --git a/service/medialive/api_op_UpdateChannel.go b/service/medialive/api_op_UpdateChannel.go index e85b4ad16f8..147494b0802 100644 --- a/service/medialive/api_op_UpdateChannel.go +++ b/service/medialive/api_op_UpdateChannel.go @@ -66,25 +66,25 @@ type UpdateChannelInput struct { // A list of output destinations for this channel. Destinations []*types.OutputDestination - // The name of the channel. - Name *string - - // An optional Amazon Resource Name (ARN) of the role to assume when running the - // Channel. If you do not specify this on an update call but the role was - // previously set that role will be removed. - RoleArn *string + // The encoder settings for this channel. + EncoderSettings *types.EncoderSettings // Placeholder documentation for __listOfInputAttachment InputAttachments []*types.InputAttachment + // Specification of input for this channel (max. bitrate, resolution, codec, etc.) + InputSpecification *types.InputSpecification + // The log level to write to CloudWatch Logs. LogLevel types.LogLevel - // Specification of input for this channel (max. bitrate, resolution, codec, etc.) - InputSpecification *types.InputSpecification + // The name of the channel. + Name *string - // The encoder settings for this channel. - EncoderSettings *types.EncoderSettings + // An optional Amazon Resource Name (ARN) of the role to assume when running the + // Channel. If you do not specify this on an update call but the role was + // previously set that role will be removed. + RoleArn *string } // Placeholder documentation for UpdateChannelResponse diff --git a/service/medialive/api_op_UpdateInput.go b/service/medialive/api_op_UpdateInput.go index 694c45b9509..2238b606b07 100644 --- a/service/medialive/api_op_UpdateInput.go +++ b/service/medialive/api_op_UpdateInput.go @@ -58,25 +58,27 @@ func (c *Client) UpdateInput(ctx context.Context, params *UpdateInputInput, optF // A request to update an input. type UpdateInputInput struct { - // Settings for the devices. - InputDevices []*types.InputDeviceRequest - - // The source URLs for a PULL-type input. Every PULL type input needs exactly two - // source URLs for redundancy. Only specify sources for PULL type Inputs. Leave - // Destinations empty. - Sources []*types.InputSourceRequest - - // Destination settings for PUSH type inputs. - Destinations []*types.InputDestinationRequest - // Unique ID of the input. // // This member is required. InputId *string + // Destination settings for PUSH type inputs. + Destinations []*types.InputDestinationRequest + + // Settings for the devices. + InputDevices []*types.InputDeviceRequest + // A list of security groups referenced by IDs to attach to the input. InputSecurityGroups []*string + // A list of the MediaConnect Flow ARNs that you want to use as the source of the + // input. You can specify as few as one Flow and presently, as many as two. The + // only requirement is when you have more than one is that each Flow is in a + // separate Availability Zone as this ensures your EML input is redundant to AZ + // issues. + MediaConnectFlows []*types.MediaConnectFlowRequest + // Name of the input. Name *string @@ -84,12 +86,10 @@ type UpdateInputInput struct { // creation. RoleArn *string - // A list of the MediaConnect Flow ARNs that you want to use as the source of the - // input. You can specify as few as one Flow and presently, as many as two. The - // only requirement is when you have more than one is that each Flow is in a - // separate Availability Zone as this ensures your EML input is redundant to AZ - // issues. - MediaConnectFlows []*types.MediaConnectFlowRequest + // The source URLs for a PULL-type input. Every PULL type input needs exactly two + // source URLs for redundancy. Only specify sources for PULL type Inputs. Leave + // Destinations empty. + Sources []*types.InputSourceRequest } // Placeholder documentation for UpdateInputResponse diff --git a/service/medialive/api_op_UpdateInputDevice.go b/service/medialive/api_op_UpdateInputDevice.go index f5b9f08879d..4f82cd9a239 100644 --- a/service/medialive/api_op_UpdateInputDevice.go +++ b/service/medialive/api_op_UpdateInputDevice.go @@ -58,14 +58,14 @@ func (c *Client) UpdateInputDevice(ctx context.Context, params *UpdateInputDevic // A request to update an input device. type UpdateInputDeviceInput struct { - // The settings that you want to apply to the input device. - HdDeviceSettings *types.InputDeviceConfigurableSettings - // The unique ID of the input device. For example, hd-123456789abcdef. // // This member is required. InputDeviceId *string + // The settings that you want to apply to the input device. + HdDeviceSettings *types.InputDeviceConfigurableSettings + // The name that you assigned to this input device (not the unique ID). Name *string } @@ -76,14 +76,8 @@ type UpdateInputDeviceOutput struct { // The unique ARN of the input device. Arn *string - // The network MAC address of the input device. - MacAddress *string - - // Settings that describe an input device that is type HD. - HdDeviceSettings *types.InputDeviceHdSettings - - // The type of the input device. - Type types.InputDeviceType + // The state of the connection between the input device and AWS. + ConnectionState types.InputDeviceConnectionState // The status of the action to synchronize the device configuration. If you change // the configuration of the input device (for example, the maximum bitrate), @@ -92,20 +86,26 @@ type UpdateInputDeviceOutput struct { // means that it has not updated its configuration. DeviceSettingsSyncState types.DeviceSettingsSyncState - // The network settings for the input device. - NetworkSettings *types.InputDeviceNetworkSettings + // Settings that describe an input device that is type HD. + HdDeviceSettings *types.InputDeviceHdSettings - // The unique serial number of the input device. - SerialNumber *string + // The unique ID of the input device. + Id *string + + // The network MAC address of the input device. + MacAddress *string // A name that you specify for the input device. Name *string - // The unique ID of the input device. - Id *string + // The network settings for the input device. + NetworkSettings *types.InputDeviceNetworkSettings - // The state of the connection between the input device and AWS. - ConnectionState types.InputDeviceConnectionState + // The unique serial number of the input device. + SerialNumber *string + + // The type of the input device. + Type types.InputDeviceType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/medialive/api_op_UpdateInputSecurityGroup.go b/service/medialive/api_op_UpdateInputSecurityGroup.go index e5dce8eda15..2c595235fb0 100644 --- a/service/medialive/api_op_UpdateInputSecurityGroup.go +++ b/service/medialive/api_op_UpdateInputSecurityGroup.go @@ -59,16 +59,16 @@ func (c *Client) UpdateInputSecurityGroup(ctx context.Context, params *UpdateInp // IPv4 CIDRs the Input Security Group should allow. type UpdateInputSecurityGroupInput struct { - // List of IPv4 CIDR addresses to whitelist - WhitelistRules []*types.InputWhitelistRuleCidr - - // A collection of key-value pairs. - Tags map[string]*string - // The id of the Input Security Group to update. // // This member is required. InputSecurityGroupId *string + + // A collection of key-value pairs. + Tags map[string]*string + + // List of IPv4 CIDR addresses to whitelist + WhitelistRules []*types.InputWhitelistRuleCidr } // Placeholder documentation for UpdateInputSecurityGroupResponse diff --git a/service/medialive/api_op_UpdateMultiplex.go b/service/medialive/api_op_UpdateMultiplex.go index 6074e1b4e4d..fea2fd64367 100644 --- a/service/medialive/api_op_UpdateMultiplex.go +++ b/service/medialive/api_op_UpdateMultiplex.go @@ -63,11 +63,11 @@ type UpdateMultiplexInput struct { // This member is required. MultiplexId *string - // Name of the multiplex. - Name *string - // The new settings for a multiplex. MultiplexSettings *types.MultiplexSettings + + // Name of the multiplex. + Name *string } // Placeholder documentation for UpdateMultiplexResponse diff --git a/service/medialive/api_op_UpdateMultiplexProgram.go b/service/medialive/api_op_UpdateMultiplexProgram.go index 270567cdf24..c2b6b20cfc4 100644 --- a/service/medialive/api_op_UpdateMultiplexProgram.go +++ b/service/medialive/api_op_UpdateMultiplexProgram.go @@ -58,6 +58,11 @@ func (c *Client) UpdateMultiplexProgram(ctx context.Context, params *UpdateMulti // A request to update a program in a multiplex. type UpdateMultiplexProgramInput struct { + // The ID of the multiplex of the program to update. + // + // This member is required. + MultiplexId *string + // The name of the program to update. // // This member is required. @@ -65,11 +70,6 @@ type UpdateMultiplexProgramInput struct { // The new settings for a multiplex program. MultiplexProgramSettings *types.MultiplexProgramSettings - - // The ID of the multiplex of the program to update. - // - // This member is required. - MultiplexId *string } // Placeholder documentation for UpdateMultiplexProgramResponse diff --git a/service/medialive/go.mod b/service/medialive/go.mod index 0a0d12cca59..690c3ae67a6 100644 --- a/service/medialive/go.mod +++ b/service/medialive/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/medialive go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/medialive/types/types.go b/service/medialive/types/types.go index 2f3d9132618..5f29bf04173 100644 --- a/service/medialive/types/types.go +++ b/service/medialive/types/types.go @@ -5,9 +5,15 @@ package types // Aac Settings type AacSettings struct { - // Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport - // Stream containers. - Spec AacSpec + // Average bitrate in bits/second. Valid values depend on rate control mode and + // profile. + Bitrate *float64 + + // Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode + // and profile. The adReceiverMix setting receives a stereo description plus + // control track and emits a mono AAC encode of the description track, with control + // data emitted in the PES header as per ETSI TS 101 154 Annex E. + CodingMode AacCodingMode // Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD // (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, @@ -18,38 +24,38 @@ type AacSettings struct { // Leave set to "normal" when input does not contain pre-mixed audio + AD. InputType AacInputType + // AAC Profile. + Profile AacProfile + // Rate Control Mode. RateControlMode AacRateControlMode + // Sets LATM / LOAS AAC output for raw containers. + RawFormat AacRawFormat + // Sample rate in Hz. Valid values depend on rate control mode and profile. SampleRate *float64 - // AAC Profile. - Profile AacProfile + // Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport + // Stream containers. + Spec AacSpec // VBR Quality Level - Only used if rateControlMode is VBR. VbrQuality AacVbrQuality - - // Average bitrate in bits/second. Valid values depend on rate control mode and - // profile. - Bitrate *float64 - - // Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode - // and profile. The adReceiverMix setting receives a stereo description plus - // control track and emits a mono AAC encode of the description track, with control - // data emitted in the PES header as per ETSI TS 101 154 Annex E. - CodingMode AacCodingMode - - // Sets LATM / LOAS AAC output for raw containers. - RawFormat AacRawFormat } // Ac3 Settings type Ac3Settings struct { - // When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to - // encoding. Only valid in codingMode32Lfe mode. - LfeFilter Ac3LfeFilter + // Average bitrate in bits/second. Valid bitrates depend on the coding mode. + Bitrate *float64 + + // Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC + // A/52-2012 for background on these values. + BitstreamMode Ac3BitstreamMode + + // Dolby Digital coding mode. Determines number of channels. + CodingMode Ac3CodingMode // Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, // dialnorm will be passed through. @@ -59,20 +65,14 @@ type Ac3Settings struct { // bitstream as defined in the Dolby Digital specification. DrcProfile Ac3DrcProfile - // Average bitrate in bits/second. Valid bitrates depend on the coding mode. - Bitrate *float64 + // When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to + // encoding. Only valid in codingMode32Lfe mode. + LfeFilter Ac3LfeFilter // When set to "followInput", encoder metadata will be sourced from the DD, DD+, or // DolbyE decoder that supplied this audio data. If audio was not supplied from one // of these streams, then the static metadata settings will be used. MetadataControl Ac3MetadataControl - - // Dolby Digital coding mode. Determines number of channels. - CodingMode Ac3CodingMode - - // Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC - // A/52-2012 for background on these values. - BitstreamMode Ac3BitstreamMode } // Archive Container Settings @@ -85,14 +85,14 @@ type ArchiveContainerSettings struct { // Archive Group Settings type ArchiveGroupSettings struct { - // Number of seconds to write to archive file before closing and starting a new - // one. - RolloverInterval *int32 - // A directory and base filename where archive files should be written. // // This member is required. Destination *OutputLocationRef + + // Number of seconds to write to archive file before closing and starting a new + // one. + RolloverInterval *int32 } // Archive Output Settings @@ -138,52 +138,30 @@ type AudioChannelMapping struct { // Audio Codec Settings type AudioCodecSettings struct { - // Pass Through Settings - PassThroughSettings *PassThroughSettings + // Aac Settings + AacSettings *AacSettings // Ac3 Settings Ac3Settings *Ac3Settings + // Eac3 Settings + Eac3Settings *Eac3Settings + // Mp2 Settings Mp2Settings *Mp2Settings - // Aac Settings - AacSettings *AacSettings - - // Eac3 Settings - Eac3Settings *Eac3Settings + // Pass Through Settings + PassThroughSettings *PassThroughSettings } // Audio Description type AudioDescription struct { - // Advanced audio normalization settings. - AudioNormalizationSettings *AudioNormalizationSettings - - // RFC 5646 language code representing the language of the audio output track. Only - // used if languageControlMode is useConfigured, or there is no ISO 639 language - // code specified in the input. - LanguageCode *string - // The name of the AudioSelector used as the source for this AudioDescription. // // This member is required. AudioSelectorName *string - // Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the - // player (eg. English, or Director Commentary). - StreamName *string - - // Choosing followInput will cause the ISO 639 language code of the output to - // follow the ISO 639 language code of the input. The languageCode will be used - // when useConfigured is set, or when followInput is selected but there is no ISO - // 639 language code specified by the input. - LanguageCodeControl AudioDescriptionLanguageCodeControl - - // Applies only if audioTypeControl is useConfigured. The values for audioType are - // defined in ISO-IEC 13818-1. - AudioType AudioType - // The name of this AudioDescription. Outputs will use this name to uniquely // identify this AudioDescription. Description names should be unique within this // Live Event. @@ -191,12 +169,12 @@ type AudioDescription struct { // This member is required. Name *string - // Audio codec settings. - CodecSettings *AudioCodecSettings + // Advanced audio normalization settings. + AudioNormalizationSettings *AudioNormalizationSettings - // Settings that control how input audio channels are remixed into the output audio - // channels. - RemixSettings *RemixSettings + // Applies only if audioTypeControl is useConfigured. The values for audioType are + // defined in ISO-IEC 13818-1. + AudioType AudioType // Determines how audio type is determined. followInput: If the input contains an // ISO 639 audioType, then that value is passed through to the output. If the input @@ -205,11 +183,38 @@ type AudioDescription struct { // that this field and audioType are both ignored if inputType is // broadcasterMixedAd. AudioTypeControl AudioDescriptionAudioTypeControl + + // Audio codec settings. + CodecSettings *AudioCodecSettings + + // RFC 5646 language code representing the language of the audio output track. Only + // used if languageControlMode is useConfigured, or there is no ISO 639 language + // code specified in the input. + LanguageCode *string + + // Choosing followInput will cause the ISO 639 language code of the output to + // follow the ISO 639 language code of the input. The languageCode will be used + // when useConfigured is set, or when followInput is selected but there is no ISO + // 639 language code specified by the input. + LanguageCodeControl AudioDescriptionLanguageCodeControl + + // Settings that control how input audio channels are remixed into the output audio + // channels. + RemixSettings *RemixSettings + + // Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the + // player (eg. English, or Director Commentary). + StreamName *string } // Audio Language Selection type AudioLanguageSelection struct { + // Selects a specific three-letter language code from within an audio source. + // + // This member is required. + LanguageCode *string + // When set to "strict", the transport stream demux strictly identifies audio // streams by their language descriptor. If a PMT update occurs such that an audio // stream matching the initially selected language is no longer present then mute @@ -217,36 +222,38 @@ type AudioLanguageSelection struct { // demux will choose another audio stream in the program with the same stream type // if it can't find one with the same language. LanguageSelectionPolicy AudioLanguageSelectionPolicy - - // Selects a specific three-letter language code from within an audio source. - // - // This member is required. - LanguageCode *string } // Audio Normalization Settings type AudioNormalizationSettings struct { - // Target LKFS(loudness) to adjust volume to. If no value is entered, a default - // value will be used according to the chosen algorithm. The CALM Act (1770-1) - // recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends - // a target of -23 LKFS. - TargetLkfs *float64 + // Audio normalization algorithm to use. itu17701 conforms to the CALM Act + // specification, itu17702 conforms to the EBU R-128 specification. + Algorithm AudioNormalizationAlgorithm // When set to correctAudio the output audio is corrected using the chosen // algorithm. If set to measureOnly, the audio will be measured but not adjusted. AlgorithmControl AudioNormalizationAlgorithmControl - // Audio normalization algorithm to use. itu17701 conforms to the CALM Act - // specification, itu17702 conforms to the EBU R-128 specification. - Algorithm AudioNormalizationAlgorithm + // Target LKFS(loudness) to adjust volume to. If no value is entered, a default + // value will be used according to the chosen algorithm. The CALM Act (1770-1) + // recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends + // a target of -23 LKFS. + TargetLkfs *float64 } // Audio Only Hls Settings type AudioOnlyHlsSettings struct { - // Specifies the segment type. - SegmentType AudioOnlyHlsSegmentType + // Specifies the group to which the audio Rendition belongs. + AudioGroupId *string + + // Optional. Specifies the .jpg or .png image to use as the cover art for an + // audio-only output. We recommend a low bit-size file because the image increases + // the output audio bandwidth. The image is attached to the audio as an ID3 tag, + // frame type APIC, picture type 0x10, as per the "ID3 tag version 2.4.0 - Native + // Frames" standard. + AudioOnlyImage *InputLocation // Four types of audio-only tracks are supported: Audio-Only Variant Stream The // client can play back this audio-only stream instead of video in low-bandwidth @@ -261,15 +268,8 @@ type AudioOnlyHlsSettings struct { // AUTOSELECT=NO AudioTrackType AudioOnlyHlsTrackType - // Specifies the group to which the audio Rendition belongs. - AudioGroupId *string - - // Optional. Specifies the .jpg or .png image to use as the cover art for an - // audio-only output. We recommend a low bit-size file because the image increases - // the output audio bandwidth. The image is attached to the audio as an ID3 tag, - // frame type APIC, picture type 0x10, as per the "ID3 tag version 2.4.0 - Native - // Frames" standard. - AudioOnlyImage *InputLocation + // Specifies the segment type. + SegmentType AudioOnlyHlsSegmentType } // Audio Pid Selection @@ -341,13 +341,13 @@ type AutomaticInputFailoverSettings struct { // Avail Blanking type AvailBlanking struct { - // When set to enabled, causes video, audio and captions to be blanked when - // insertion metadata is added. - State AvailBlankingState - // Blanking image to be used. Leave empty for solid black. Only bmp and png images // are supported. AvailBlankingImage *InputLocation + + // When set to enabled, causes video, audio and captions to be blanked when + // insertion metadata is added. + State AvailBlankingState } // Avail Configuration @@ -360,11 +360,11 @@ type AvailConfiguration struct { // Avail Settings type AvailSettings struct { - // Scte35 Time Signal Apos - Scte35TimeSignalApos *Scte35TimeSignalApos - // Scte35 Splice Insert Scte35SpliceInsert *Scte35SpliceInsert + + // Scte35 Time Signal Apos + Scte35TimeSignalApos *Scte35TimeSignalApos } // A list of schedule actions to create (in a request) or that have been created @@ -407,13 +407,9 @@ type BatchScheduleActionDeleteResult struct { // Blackout Slate type BlackoutSlate struct { - // When set to enabled, causes video, audio and captions to be blanked when - // indicated by program metadata. - State BlackoutSlateState - - // Path to local file to use as Network End Blackout image. Image will be scaled to - // fill the entire output raster. - NetworkEndBlackoutImage *InputLocation + // Blackout slate image to be used. Leave empty for solid black. Only bmp and png + // images are supported. + BlackoutSlateImage *InputLocation // Setting to enabled causes the encoder to blackout the video, audio, and // captions, and raise the "Network Blackout Image" slate when an SCTE104/35 @@ -423,18 +419,40 @@ type BlackoutSlate struct { // entered in "Network ID". NetworkEndBlackout BlackoutSlateNetworkEndBlackout + // Path to local file to use as Network End Blackout image. Image will be scaled to + // fill the entire output raster. + NetworkEndBlackoutImage *InputLocation + // Provides Network ID that matches EIDR ID format (e.g., // "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C"). NetworkId *string - // Blackout slate image to be used. Leave empty for solid black. Only bmp and png - // images are supported. - BlackoutSlateImage *InputLocation + // When set to enabled, causes video, audio and captions to be blanked when + // indicated by program metadata. + State BlackoutSlateState } // Burn In Destination Settings type BurnInDestinationSettings struct { + // If no explicit xPosition or yPosition is provided, setting alignment to centered + // will place the captions at the bottom center of the output. Similarly, setting a + // left alignment will align captions to the bottom left of the output. If x and y + // positions are given in conjunction with the alignment parameter, the font will + // be justified (either left or centered) relative to those coordinates. Selecting + // "smart" justification will left-justify live subtitles and center-justify + // pre-recorded subtitles. All burn-in and DVB-Sub font settings must match. + Alignment BurnInAlignment + + // Specifies the color of the rectangle behind the captions. All burn-in and + // DVB-Sub font settings must match. + BackgroundColor BurnInBackgroundColor + + // Specifies the opacity of the background rectangle. 255 is opaque; 0 is + // transparent. Leaving this parameter out is equivalent to setting it to 0 + // (transparent). All burn-in and DVB-Sub font settings must match. + BackgroundOpacity *int32 + // External font file used for caption burn-in. File extension must be 'ttf' or // 'tte'. Although the user can select output fonts for many different types of // input captions, embedded, STL and teletext sources use a strict grid system. @@ -442,37 +460,30 @@ type BurnInDestinationSettings struct { // of proportional fonts. All burn-in and DVB-Sub font settings must match. Font *InputLocation - // Specifies the horizontal position of the caption relative to the left side of - // the output in pixels. A value of 10 would result in the captions starting 10 - // pixels from the left of the output. If no explicit xPosition is provided, the - // horizontal caption position will be determined by the alignment parameter. All - // burn-in and DVB-Sub font settings must match. - XPosition *int32 + // Specifies the color of the burned-in captions. This option is not valid for + // source captions that are STL, 608/embedded or teletext. These source settings + // are already pre-defined by the caption stream. All burn-in and DVB-Sub font + // settings must match. + FontColor BurnInFontColor + + // Specifies the opacity of the burned-in captions. 255 is opaque; 0 is + // transparent. All burn-in and DVB-Sub font settings must match. + FontOpacity *int32 + + // Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and + // DVB-Sub font settings must match. + FontResolution *int32 // When set to 'auto' fontSize will scale depending on the size of the output. // Giving a positive integer will specify the exact font size in points. All // burn-in and DVB-Sub font settings must match. FontSize *string - // Specifies the vertical offset of the shadow relative to the captions in pixels. - // A value of -2 would result in a shadow offset 2 pixels above the text. All - // burn-in and DVB-Sub font settings must match. - ShadowYOffset *int32 - - // Specifies the vertical position of the caption relative to the top of the output - // in pixels. A value of 10 would result in the captions starting 10 pixels from - // the top of the output. If no explicit yPosition is provided, the caption will be - // positioned towards the bottom of the output. All burn-in and DVB-Sub font - // settings must match. - YPosition *int32 - - // Controls whether a fixed grid size will be used to generate the output subtitles - // bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. - TeletextGridControl BurnInTeletextGridControl - - // Specifies the color of the rectangle behind the captions. All burn-in and - // DVB-Sub font settings must match. - BackgroundColor BurnInBackgroundColor + // Specifies font outline color. This option is not valid for source captions that + // are either 608/embedded or teletext. These source settings are already + // pre-defined by the caption stream. All burn-in and DVB-Sub font settings must + // match. + OutlineColor BurnInOutlineColor // Specifies font outline size in pixels. This option is not valid for source // captions that are either 608/embedded or teletext. These source settings are @@ -480,58 +491,59 @@ type BurnInDestinationSettings struct { // must match. OutlineSize *int32 + // Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub + // font settings must match. + ShadowColor BurnInShadowColor + + // Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving + // this parameter out is equivalent to setting it to 0 (transparent). All burn-in + // and DVB-Sub font settings must match. + ShadowOpacity *int32 + // Specifies the horizontal offset of the shadow relative to the captions in // pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All // burn-in and DVB-Sub font settings must match. ShadowXOffset *int32 - // Specifies the opacity of the burned-in captions. 255 is opaque; 0 is - // transparent. All burn-in and DVB-Sub font settings must match. - FontOpacity *int32 - - // Specifies font outline color. This option is not valid for source captions that - // are either 608/embedded or teletext. These source settings are already - // pre-defined by the caption stream. All burn-in and DVB-Sub font settings must - // match. - OutlineColor BurnInOutlineColor - - // Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub - // font settings must match. - ShadowColor BurnInShadowColor - - // Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and - // DVB-Sub font settings must match. - FontResolution *int32 + // Specifies the vertical offset of the shadow relative to the captions in pixels. + // A value of -2 would result in a shadow offset 2 pixels above the text. All + // burn-in and DVB-Sub font settings must match. + ShadowYOffset *int32 - // Specifies the opacity of the background rectangle. 255 is opaque; 0 is - // transparent. Leaving this parameter out is equivalent to setting it to 0 - // (transparent). All burn-in and DVB-Sub font settings must match. - BackgroundOpacity *int32 + // Controls whether a fixed grid size will be used to generate the output subtitles + // bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. + TeletextGridControl BurnInTeletextGridControl - // If no explicit xPosition or yPosition is provided, setting alignment to centered - // will place the captions at the bottom center of the output. Similarly, setting a - // left alignment will align captions to the bottom left of the output. If x and y - // positions are given in conjunction with the alignment parameter, the font will - // be justified (either left or centered) relative to those coordinates. Selecting - // "smart" justification will left-justify live subtitles and center-justify - // pre-recorded subtitles. All burn-in and DVB-Sub font settings must match. - Alignment BurnInAlignment + // Specifies the horizontal position of the caption relative to the left side of + // the output in pixels. A value of 10 would result in the captions starting 10 + // pixels from the left of the output. If no explicit xPosition is provided, the + // horizontal caption position will be determined by the alignment parameter. All + // burn-in and DVB-Sub font settings must match. + XPosition *int32 - // Specifies the color of the burned-in captions. This option is not valid for - // source captions that are STL, 608/embedded or teletext. These source settings - // are already pre-defined by the caption stream. All burn-in and DVB-Sub font + // Specifies the vertical position of the caption relative to the top of the output + // in pixels. A value of 10 would result in the captions starting 10 pixels from + // the top of the output. If no explicit yPosition is provided, the caption will be + // positioned towards the bottom of the output. All burn-in and DVB-Sub font // settings must match. - FontColor BurnInFontColor - - // Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving - // this parameter out is equivalent to setting it to 0 (transparent). All burn-in - // and DVB-Sub font settings must match. - ShadowOpacity *int32 + YPosition *int32 } // Caption Description type CaptionDescription struct { + // Specifies which input caption selector to use as a caption source when + // generating output captions. This field should match a captionSelector name. + // + // This member is required. + CaptionSelectorName *string + + // Name of the caption description. Used to associate a caption description with an + // output. Names must be unique within an event. + // + // This member is required. + Name *string + // Additional settings for captions destination that depend on the destination // type. DestinationSettings *CaptionDestinationSettings @@ -542,67 +554,61 @@ type CaptionDescription struct { // Human readable information to indicate captions available for players (eg. // English, or Spanish). LanguageDescription *string - - // Name of the caption description. Used to associate a caption description with an - // output. Names must be unique within an event. - // - // This member is required. - Name *string - - // Specifies which input caption selector to use as a caption source when - // generating output captions. This field should match a captionSelector name. - // - // This member is required. - CaptionSelectorName *string } // Caption Destination Settings type CaptionDestinationSettings struct { - // Smpte Tt Destination Settings - SmpteTtDestinationSettings *SmpteTtDestinationSettings - - // Embedded Plus Scte20 Destination Settings - EmbeddedPlusScte20DestinationSettings *EmbeddedPlusScte20DestinationSettings - // Arib Destination Settings AribDestinationSettings *AribDestinationSettings + // Burn In Destination Settings + BurnInDestinationSettings *BurnInDestinationSettings + + // Dvb Sub Destination Settings + DvbSubDestinationSettings *DvbSubDestinationSettings + // Ebu Tt DDestination Settings EbuTtDDestinationSettings *EbuTtDDestinationSettings - // Ttml Destination Settings - TtmlDestinationSettings *TtmlDestinationSettings + // Embedded Destination Settings + EmbeddedDestinationSettings *EmbeddedDestinationSettings + + // Embedded Plus Scte20 Destination Settings + EmbeddedPlusScte20DestinationSettings *EmbeddedPlusScte20DestinationSettings + + // Rtmp Caption Info Destination Settings + RtmpCaptionInfoDestinationSettings *RtmpCaptionInfoDestinationSettings // Scte20 Plus Embedded Destination Settings Scte20PlusEmbeddedDestinationSettings *Scte20PlusEmbeddedDestinationSettings - // Dvb Sub Destination Settings - DvbSubDestinationSettings *DvbSubDestinationSettings + // Scte27 Destination Settings + Scte27DestinationSettings *Scte27DestinationSettings - // Webvtt Destination Settings - WebvttDestinationSettings *WebvttDestinationSettings + // Smpte Tt Destination Settings + SmpteTtDestinationSettings *SmpteTtDestinationSettings // Teletext Destination Settings TeletextDestinationSettings *TeletextDestinationSettings - // Burn In Destination Settings - BurnInDestinationSettings *BurnInDestinationSettings - - // Scte27 Destination Settings - Scte27DestinationSettings *Scte27DestinationSettings - - // Embedded Destination Settings - EmbeddedDestinationSettings *EmbeddedDestinationSettings + // Ttml Destination Settings + TtmlDestinationSettings *TtmlDestinationSettings - // Rtmp Caption Info Destination Settings - RtmpCaptionInfoDestinationSettings *RtmpCaptionInfoDestinationSettings + // Webvtt Destination Settings + WebvttDestinationSettings *WebvttDestinationSettings } // Maps a caption channel to an ISO 693-2 language code // (http://www.loc.gov/standards/iso639-2), with an optional description. type CaptionLanguageMapping struct { + // The closed caption channel being described by this CaptionLanguageMapping. Each + // channel mapping must have a unique channel number (maximum of 4) + // + // This member is required. + CaptionChannel *int32 + // Three character ISO 639-2 language code (see // http://www.loc.gov/standards/iso639-2) // @@ -613,50 +619,44 @@ type CaptionLanguageMapping struct { // // This member is required. LanguageDescription *string - - // The closed caption channel being described by this CaptionLanguageMapping. Each - // channel mapping must have a unique channel number (maximum of 4) - // - // This member is required. - CaptionChannel *int32 } // Output groups for this Live Event. Output groups contain information about where // streams should be distributed. type CaptionSelector struct { - // Caption selector settings. - SelectorSettings *CaptionSelectorSettings - - // When specified this field indicates the three letter language code of the - // caption track to extract from the source. - LanguageCode *string - // Name identifier for a caption selector. This name is used to associate this // caption selector with one or more caption descriptions. Names must be unique // within an event. // // This member is required. Name *string + + // When specified this field indicates the three letter language code of the + // caption track to extract from the source. + LanguageCode *string + + // Caption selector settings. + SelectorSettings *CaptionSelectorSettings } // Caption Selector Settings type CaptionSelectorSettings struct { - // Scte27 Source Settings - Scte27SourceSettings *Scte27SourceSettings + // Arib Source Settings + AribSourceSettings *AribSourceSettings // Dvb Sub Source Settings DvbSubSourceSettings *DvbSubSourceSettings - // Arib Source Settings - AribSourceSettings *AribSourceSettings + // Embedded Source Settings + EmbeddedSourceSettings *EmbeddedSourceSettings // Scte20 Source Settings Scte20SourceSettings *Scte20SourceSettings - // Embedded Source Settings - EmbeddedSourceSettings *EmbeddedSourceSettings + // Scte27 Source Settings + Scte27SourceSettings *Scte27SourceSettings // Teletext Source Settings TeletextSourceSettings *TeletextSourceSettings @@ -665,39 +665,32 @@ type CaptionSelectorSettings struct { // Placeholder documentation for Channel type Channel struct { - // Placeholder documentation for InputSpecification - InputSpecification *InputSpecification - - // The Amazon Resource Name (ARN) of the role assumed when running the Channel. - RoleArn *string - - // The unique id of the channel. - Id *string - - // List of input attachments for channel. - InputAttachments []*InputAttachment - // The unique arn of the channel. Arn *string - // The number of currently healthy pipelines. - PipelinesRunningCount *int32 - - // Runtime details for the pipelines of a running channel. - PipelineDetails []*PipelineDetail - - // Encoder Settings - EncoderSettings *EncoderSettings - // The class for this channel. STANDARD for a channel with two pipelines or // SINGLE_PIPELINE for a channel with one pipeline. ChannelClass ChannelClass + // A list of destinations of the channel. For UDP outputs, there is one destination + // per output. For other types (HLS, for example), there is one destination per + // packager. + Destinations []*OutputDestination + // The endpoints where outgoing connections initiate from EgressEndpoints []*ChannelEgressEndpoint - // A collection of key-value pairs. - Tags map[string]*string + // Encoder Settings + EncoderSettings *EncoderSettings + + // The unique id of the channel. + Id *string + + // List of input attachments for channel. + InputAttachments []*InputAttachment + + // Placeholder documentation for InputSpecification + InputSpecification *InputSpecification // The log level being written to CloudWatch Logs. LogLevel LogLevel @@ -705,13 +698,20 @@ type Channel struct { // The name of the channel. (user-mutable) Name *string - // A list of destinations of the channel. For UDP outputs, there is one destination - // per output. For other types (HLS, for example), there is one destination per - // packager. - Destinations []*OutputDestination + // Runtime details for the pipelines of a running channel. + PipelineDetails []*PipelineDetail + + // The number of currently healthy pipelines. + PipelinesRunningCount *int32 + + // The Amazon Resource Name (ARN) of the role assumed when running the Channel. + RoleArn *string // Placeholder documentation for ChannelState State ChannelState + + // A collection of key-value pairs. + Tags map[string]*string } // Placeholder documentation for ChannelEgressEndpoint @@ -724,47 +724,47 @@ type ChannelEgressEndpoint struct { // Placeholder documentation for ChannelSummary type ChannelSummary struct { + // The unique arn of the channel. + Arn *string + + // The class for this channel. STANDARD for a channel with two pipelines or + // SINGLE_PIPELINE for a channel with one pipeline. + ChannelClass ChannelClass + // A list of destinations of the channel. For UDP outputs, there is one destination // per output. For other types (HLS, for example), there is one destination per // packager. Destinations []*OutputDestination - // List of input attachments for channel. + // The endpoints where outgoing connections initiate from + EgressEndpoints []*ChannelEgressEndpoint + + // The unique id of the channel. + Id *string + + // List of input attachments for channel. InputAttachments []*InputAttachment // Placeholder documentation for InputSpecification InputSpecification *InputSpecification - // The Amazon Resource Name (ARN) of the role assumed when running the Channel. - RoleArn *string - // The log level being written to CloudWatch Logs. LogLevel LogLevel - // Placeholder documentation for ChannelState - State ChannelState - // The name of the channel. (user-mutable) Name *string - // A collection of key-value pairs. - Tags map[string]*string - - // The endpoints where outgoing connections initiate from - EgressEndpoints []*ChannelEgressEndpoint - - // The unique id of the channel. - Id *string + // The number of currently healthy pipelines. + PipelinesRunningCount *int32 - // The unique arn of the channel. - Arn *string + // The Amazon Resource Name (ARN) of the role assumed when running the Channel. + RoleArn *string - // The class for this channel. STANDARD for a channel with two pipelines or - // SINGLE_PIPELINE for a channel with one pipeline. - ChannelClass ChannelClass + // Placeholder documentation for ChannelState + State ChannelState - // The number of currently healthy pipelines. - PipelinesRunningCount *int32 + // A collection of key-value pairs. + Tags map[string]*string } // Passthrough applies no color space conversion to the output @@ -774,6 +774,11 @@ type ColorSpacePassthroughSettings struct { // DVB Network Information Table (NIT) type DvbNitSettings struct { + // The numeric value placed in the Network Information Table (NIT). + // + // This member is required. + NetworkId *int32 + // The network name text placed in the networkNameDescriptor inside the Network // Information Table. Maximum length is 256 characters. // @@ -783,11 +788,6 @@ type DvbNitSettings struct { // The number of milliseconds between instances of this table in the output // transport stream. RepInterval *int32 - - // The numeric value placed in the Network Information Table (NIT). - // - // This member is required. - NetworkId *int32 } // DVB Service Description Table (SDT) @@ -802,47 +802,22 @@ type DvbSdtSettings struct { // information. OutputSdt DvbSdtOutputSdt - // The service provider name placed in the serviceDescriptor in the Service - // Description Table. Maximum length is 256 characters. - ServiceProviderName *string + // The number of milliseconds between instances of this table in the output + // transport stream. + RepInterval *int32 // The service name placed in the serviceDescriptor in the Service Description // Table. Maximum length is 256 characters. ServiceName *string - // The number of milliseconds between instances of this table in the output - // transport stream. - RepInterval *int32 + // The service provider name placed in the serviceDescriptor in the Service + // Description Table. Maximum length is 256 characters. + ServiceProviderName *string } // Dvb Sub Destination Settings type DvbSubDestinationSettings struct { - // Specifies the horizontal position of the caption relative to the left side of - // the output in pixels. A value of 10 would result in the captions starting 10 - // pixels from the left of the output. If no explicit xPosition is provided, the - // horizontal caption position will be determined by the alignment parameter. This - // option is not valid for source captions that are STL, 608/embedded or teletext. - // These source settings are already pre-defined by the caption stream. All burn-in - // and DVB-Sub font settings must match. - XPosition *int32 - - // When set to auto fontSize will scale depending on the size of the output. Giving - // a positive integer will specify the exact font size in points. All burn-in and - // DVB-Sub font settings must match. - FontSize *string - - // External font file used for caption burn-in. File extension must be 'ttf' or - // 'tte'. Although the user can select output fonts for many different types of - // input captions, embedded, STL and teletext sources use a strict grid system. - // Using external fonts with these caption sources could cause unexpected display - // of proportional fonts. All burn-in and DVB-Sub font settings must match. - Font *InputLocation - - // Specifies the color of the rectangle behind the captions. All burn-in and - // DVB-Sub font settings must match. - BackgroundColor DvbSubDestinationBackgroundColor - // If no explicit xPosition or yPosition is provided, setting alignment to centered // will place the captions at the bottom center of the output. Similarly, setting a // left alignment will align captions to the bottom left of the output. If x and y @@ -854,68 +829,93 @@ type DvbSubDestinationSettings struct { // caption stream. All burn-in and DVB-Sub font settings must match. Alignment DvbSubDestinationAlignment - // Specifies the horizontal offset of the shadow relative to the captions in - // pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All - // burn-in and DVB-Sub font settings must match. - ShadowXOffset *int32 - - // Specifies font outline size in pixels. This option is not valid for source - // captions that are either 608/embedded or teletext. These source settings are - // already pre-defined by the caption stream. All burn-in and DVB-Sub font settings - // must match. - OutlineSize *int32 + // Specifies the color of the rectangle behind the captions. All burn-in and + // DVB-Sub font settings must match. + BackgroundColor DvbSubDestinationBackgroundColor // Specifies the opacity of the background rectangle. 255 is opaque; 0 is // transparent. Leaving this parameter blank is equivalent to setting it to 0 // (transparent). All burn-in and DVB-Sub font settings must match. BackgroundOpacity *int32 - // Controls whether a fixed grid size will be used to generate the output subtitles - // bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. - TeletextGridControl DvbSubDestinationTeletextGridControl + // External font file used for caption burn-in. File extension must be 'ttf' or + // 'tte'. Although the user can select output fonts for many different types of + // input captions, embedded, STL and teletext sources use a strict grid system. + // Using external fonts with these caption sources could cause unexpected display + // of proportional fonts. All burn-in and DVB-Sub font settings must match. + Font *InputLocation - // Specifies the vertical position of the caption relative to the top of the output - // in pixels. A value of 10 would result in the captions starting 10 pixels from - // the top of the output. If no explicit yPosition is provided, the caption will be - // positioned towards the bottom of the output. This option is not valid for source - // captions that are STL, 608/embedded or teletext. These source settings are - // already pre-defined by the caption stream. All burn-in and DVB-Sub font settings - // must match. - YPosition *int32 + // Specifies the color of the burned-in captions. This option is not valid for + // source captions that are STL, 608/embedded or teletext. These source settings + // are already pre-defined by the caption stream. All burn-in and DVB-Sub font + // settings must match. + FontColor DvbSubDestinationFontColor + + // Specifies the opacity of the burned-in captions. 255 is opaque; 0 is + // transparent. All burn-in and DVB-Sub font settings must match. + FontOpacity *int32 // Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and // DVB-Sub font settings must match. FontResolution *int32 + // When set to auto fontSize will scale depending on the size of the output. Giving + // a positive integer will specify the exact font size in points. All burn-in and + // DVB-Sub font settings must match. + FontSize *string + // Specifies font outline color. This option is not valid for source captions that // are either 608/embedded or teletext. These source settings are already // pre-defined by the caption stream. All burn-in and DVB-Sub font settings must // match. OutlineColor DvbSubDestinationOutlineColor - // Specifies the opacity of the burned-in captions. 255 is opaque; 0 is - // transparent. All burn-in and DVB-Sub font settings must match. - FontOpacity *int32 + // Specifies font outline size in pixels. This option is not valid for source + // captions that are either 608/embedded or teletext. These source settings are + // already pre-defined by the caption stream. All burn-in and DVB-Sub font settings + // must match. + OutlineSize *int32 - // Specifies the color of the burned-in captions. This option is not valid for - // source captions that are STL, 608/embedded or teletext. These source settings - // are already pre-defined by the caption stream. All burn-in and DVB-Sub font - // settings must match. - FontColor DvbSubDestinationFontColor + // Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub + // font settings must match. + ShadowColor DvbSubDestinationShadowColor // Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving // this parameter blank is equivalent to setting it to 0 (transparent). All burn-in // and DVB-Sub font settings must match. ShadowOpacity *int32 + // Specifies the horizontal offset of the shadow relative to the captions in + // pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All + // burn-in and DVB-Sub font settings must match. + ShadowXOffset *int32 + // Specifies the vertical offset of the shadow relative to the captions in pixels. // A value of -2 would result in a shadow offset 2 pixels above the text. All // burn-in and DVB-Sub font settings must match. ShadowYOffset *int32 - // Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub - // font settings must match. - ShadowColor DvbSubDestinationShadowColor + // Controls whether a fixed grid size will be used to generate the output subtitles + // bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. + TeletextGridControl DvbSubDestinationTeletextGridControl + + // Specifies the horizontal position of the caption relative to the left side of + // the output in pixels. A value of 10 would result in the captions starting 10 + // pixels from the left of the output. If no explicit xPosition is provided, the + // horizontal caption position will be determined by the alignment parameter. This + // option is not valid for source captions that are STL, 608/embedded or teletext. + // These source settings are already pre-defined by the caption stream. All burn-in + // and DVB-Sub font settings must match. + XPosition *int32 + + // Specifies the vertical position of the caption relative to the top of the output + // in pixels. A value of 10 would result in the captions starting 10 pixels from + // the top of the output. If no explicit yPosition is provided, the caption will be + // positioned towards the bottom of the output. This option is not valid for source + // captions that are STL, 608/embedded or teletext. These source settings are + // already pre-defined by the caption stream. All burn-in and DVB-Sub font settings + // must match. + YPosition *int32 } // Dvb Sub Source Settings @@ -938,83 +938,92 @@ type DvbTdtSettings struct { // Eac3 Settings type Eac3Settings struct { - // When set to enabled, activates a DC highpass filter for all input channels. - DcFilter Eac3DcFilter - - // Left only/Right only center mix level. Only used for 3/2 coding mode. - LoRoCenterMixLevel *float64 - - // Left total/Right total surround mix level. Only used for 3/2 coding mode. - LtRtSurroundMixLevel *float64 - - // When encoding 3/2 audio, sets whether an extra center back surround channel is - // matrix encoded into the left and right surround channels. - SurroundExMode Eac3SurroundExMode + // When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. + // Only used for 3/2 coding mode. + AttenuationControl Eac3AttenuationControl - // When set to whenPossible, input DD+ audio will be passed through if it is - // present on the input. This detection is dynamic over the life of the transcode. - // Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ - // output as the system alternates between passthrough and encoding. - PassthroughControl Eac3PassthroughControl + // Average bitrate in bits/second. Valid bitrates depend on the coding mode. + Bitrate *float64 // Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC // A/52-2012 (Annex E) for background on these values. BitstreamMode Eac3BitstreamMode - // Sets the profile for heavy Dolby dynamic range compression, ensures that the - // instantaneous signal peaks do not exceed specified levels. - DrcRf Eac3DrcRf - - // When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. - // Only used for 3/2 coding mode. - AttenuationControl Eac3AttenuationControl - // Dolby Digital Plus coding mode. Determines number of channels. CodingMode Eac3CodingMode - // Sets the Dolby dynamic range compression profile. - DrcLine Eac3DrcLine + // When set to enabled, activates a DC highpass filter for all input channels. + DcFilter Eac3DcFilter // Sets the dialnorm for the output. If blank and input audio is Dolby Digital // Plus, dialnorm will be passed through. Dialnorm *int32 - // When set to shift90Degrees, applies a 90-degree phase shift to the surround - // channels. Only used for 3/2 coding mode. - PhaseControl Eac3PhaseControl - - // Stereo downmix preference. Only used for 3/2 coding mode. - StereoDownmix Eac3StereoDownmix + // Sets the Dolby dynamic range compression profile. + DrcLine Eac3DrcLine - // When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the - // two channels. - SurroundMode Eac3SurroundMode + // Sets the profile for heavy Dolby dynamic range compression, ensures that the + // instantaneous signal peaks do not exceed specified levels. + DrcRf Eac3DrcRf - // Left total/Right total center mix level. Only used for 3/2 coding mode. - LtRtCenterMixLevel *float64 + // When encoding 3/2 audio, setting to lfe enables the LFE channel + LfeControl Eac3LfeControl // When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to // encoding. Only valid with codingMode32 coding mode. LfeFilter Eac3LfeFilter + // Left only/Right only center mix level. Only used for 3/2 coding mode. + LoRoCenterMixLevel *float64 + // Left only/Right only surround mix level. Only used for 3/2 coding mode. LoRoSurroundMixLevel *float64 - // Average bitrate in bits/second. Valid bitrates depend on the coding mode. - Bitrate *float64 + // Left total/Right total center mix level. Only used for 3/2 coding mode. + LtRtCenterMixLevel *float64 + + // Left total/Right total surround mix level. Only used for 3/2 coding mode. + LtRtSurroundMixLevel *float64 // When set to followInput, encoder metadata will be sourced from the DD, DD+, or // DolbyE decoder that supplied this audio data. If audio was not supplied from one // of these streams, then the static metadata settings will be used. MetadataControl Eac3MetadataControl - // When encoding 3/2 audio, setting to lfe enables the LFE channel - LfeControl Eac3LfeControl + // When set to whenPossible, input DD+ audio will be passed through if it is + // present on the input. This detection is dynamic over the life of the transcode. + // Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ + // output as the system alternates between passthrough and encoding. + PassthroughControl Eac3PassthroughControl + + // When set to shift90Degrees, applies a 90-degree phase shift to the surround + // channels. Only used for 3/2 coding mode. + PhaseControl Eac3PhaseControl + + // Stereo downmix preference. Only used for 3/2 coding mode. + StereoDownmix Eac3StereoDownmix + + // When encoding 3/2 audio, sets whether an extra center back surround channel is + // matrix encoded into the left and right surround channels. + SurroundExMode Eac3SurroundExMode + + // When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the + // two channels. + SurroundMode Eac3SurroundMode } // Ebu Tt DDestination Settings type EbuTtDDestinationSettings struct { + // Specifies how to handle the gap between the lines (in multi-line captions). + // + // + // * enabled: Fill with the captions background color (as specified in the input + // captions). + // + // * disabled: Leave the gap unfilled. + FillLineGap EbuTtDFillLineGapControl + // Specifies the font family to include in the font data attached to the EBU-TT // captions. Valid only if styleControl is set to include. If you leave this field // empty, the font family is set to "monospaced". (If styleControl is set to @@ -1032,15 +1041,6 @@ type EbuTtDDestinationSettings struct { // set the family to “monospace”. FontFamily *string - // Specifies how to handle the gap between the lines (in multi-line captions). - // - // - // * enabled: Fill with the captions background color (as specified in the input - // captions). - // - // * disabled: Leave the gap unfilled. - FillLineGap EbuTtDFillLineGapControl - // Specifies the style information (font color, font position, and so on) to // include in the font data that is attached to the EBU-TT captions. // @@ -1067,18 +1067,18 @@ type EmbeddedPlusScte20DestinationSettings struct { // Embedded Source Settings type EmbeddedSourceSettings struct { - // Specifies the 608/708 channel number within the video track from which to - // extract captions. Unused for passthrough. - Source608ChannelNumber *int32 + // If upconvert, 608 data is both passed through via the "608 compatibility bytes" + // fields of the 708 wrapper as well as translated into 708. 708 data present in + // the source content will be discarded. + Convert608To708 EmbeddedConvert608To708 // Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and // Embedded captions. Scte20Detection EmbeddedScte20Detection - // If upconvert, 608 data is both passed through via the "608 compatibility bytes" - // fields of the 708 wrapper as well as translated into 708. 708 data present in - // the source content will be discarded. - Convert608To708 EmbeddedConvert608To708 + // Specifies the 608/708 channel number within the video track from which to + // extract captions. Unused for passthrough. + Source608ChannelNumber *int32 // This field is unused and deprecated. Source608TrackNumber *int32 @@ -1092,24 +1092,29 @@ type EncoderSettings struct { // This member is required. AudioDescriptions []*AudioDescription - // Nielsen configuration settings. - NielsenConfiguration *NielsenConfiguration + // Placeholder documentation for __listOfOutputGroup + // + // This member is required. + OutputGroups []*OutputGroup - // Configuration settings that apply to the event as a whole. - GlobalConfiguration *GlobalConfiguration + // Contains settings used to acquire and adjust timecode information from inputs. + // + // This member is required. + TimecodeConfig *TimecodeConfig // Placeholder documentation for __listOfVideoDescription // // This member is required. VideoDescriptions []*VideoDescription + // Settings for ad avail blanking. + AvailBlanking *AvailBlanking + // Event-wide configuration settings for ad avail insertion. AvailConfiguration *AvailConfiguration - // Placeholder documentation for __listOfOutputGroup - // - // This member is required. - OutputGroups []*OutputGroup + // Settings for blackout slate. + BlackoutSlate *BlackoutSlate // Settings for caption decriptions CaptionDescriptions []*CaptionDescription @@ -1117,16 +1122,11 @@ type EncoderSettings struct { // Feature Activations FeatureActivations *FeatureActivations - // Contains settings used to acquire and adjust timecode information from inputs. - // - // This member is required. - TimecodeConfig *TimecodeConfig - - // Settings for ad avail blanking. - AvailBlanking *AvailBlanking + // Configuration settings that apply to the event as a whole. + GlobalConfiguration *GlobalConfiguration - // Settings for blackout slate. - BlackoutSlate *BlackoutSlate + // Nielsen configuration settings. + NielsenConfiguration *NielsenConfiguration } // Feature Activations @@ -1147,6 +1147,9 @@ type FecOutputSettings struct { // between 4 and 20, inclusive. ColumnDepth *int32 + // Enables column only or column and row based FEC + IncludeFec FecOutputIncludeFec + // Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be // between 1 and 20, inclusive. If only Column FEC is used, then larger values // increase robustness. If Row FEC is used, then this is the number of transport @@ -1154,9 +1157,6 @@ type FecOutputSettings struct { // and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this // value must be 1 to 20, inclusive. RowLength *int32 - - // Enables column only or column and row based FEC - IncludeFec FecOutputIncludeFec } // Start time for the action. @@ -1175,15 +1175,15 @@ type FixedModeScheduleActionStartSettings struct { // Fmp4 Hls Settings type Fmp4HlsSettings struct { + // List all the audio groups that are used with the video output stream. Input all + // the audio GROUP-IDs that are associated to the video, separate by ','. + AudioRenditionSets *string + // If set to passthrough, Nielsen inaudible tones for media tracking will be // detected in the input audio and an equivalent ID3 tag will be inserted in the // output. NielsenId3Behavior Fmp4NielsenId3Behavior - // List all the audio groups that are used with the video output stream. Input all - // the audio GROUP-IDs that are associated to the video, separate by ','. - AudioRenditionSets *string - // When set to passthrough, timed metadata is passed through from input to output. TimedMetadataBehavior Fmp4TimedMetadataBehavior } @@ -1191,16 +1191,16 @@ type Fmp4HlsSettings struct { // Settings to specify if an action follows another. type FollowModeScheduleActionStartSettings struct { - // The action name of another action that this one refers to. - // - // This member is required. - ReferenceActionName *string - // Identifies whether this action starts relative to the start or relative to the // end of the reference action. // // This member is required. FollowPoint FollowPoint + + // The action name of another action that this one refers to. + // + // This member is required. + ReferenceActionName *string } // Frame Capture Group Settings @@ -1230,43 +1230,23 @@ type FrameCaptureOutputSettings struct { // Frame Capture Settings type FrameCaptureSettings struct { - // Unit for the frame capture interval. - CaptureIntervalUnits FrameCaptureIntervalUnit - // The frequency at which to capture frames for inclusion in the output. May be // specified in either seconds or milliseconds, as specified by // captureIntervalUnits. // // This member is required. CaptureInterval *int32 + + // Unit for the frame capture interval. + CaptureIntervalUnits FrameCaptureIntervalUnit } // Global Configuration type GlobalConfiguration struct { - // Indicates whether the rate of frames emitted by the Live encoder should be paced - // by its system clock (which optionally may be locked to another source via NTP) - // or should be locked to the clock of the source that is providing the input - // stream. - OutputTimingSource GlobalConfigurationOutputTimingSource - - // Adjusts video input buffer for streams with very low video framerates. This is - // commonly set to enabled for music channels with less than one video frame per - // second. - SupportLowFramerateInputs GlobalConfigurationLowFramerateInputs - // Value to set the initial audio gain for the Live Event. InitialAudioGain *int32 - // Indicates how MediaLive pipelines are synchronized. PIPELINE_LOCKING - MediaLive - // will attempt to synchronize the output of each pipeline to the other. - // EPOCH_LOCKING - MediaLive will attempt to synchronize the output of each - // pipeline to the Unix epoch. - OutputLockingMode GlobalConfigurationOutputLockingMode - - // Settings for system actions when input is lost. - InputLossBehavior *InputLossBehavior - // Indicates the action to take when the current input completes (e.g. // end-of-file). When switchAndLoopInputs is configured the encoder will restart at // the beginning of the first input. When "none" is configured the encoder will @@ -1274,19 +1254,39 @@ type GlobalConfiguration struct { // "Input Loss Behavior" configuration until the next input switch occurs (which is // controlled through the Channel Schedule API). InputEndAction GlobalConfigurationInputEndAction + + // Settings for system actions when input is lost. + InputLossBehavior *InputLossBehavior + + // Indicates how MediaLive pipelines are synchronized. PIPELINE_LOCKING - MediaLive + // will attempt to synchronize the output of each pipeline to the other. + // EPOCH_LOCKING - MediaLive will attempt to synchronize the output of each + // pipeline to the Unix epoch. + OutputLockingMode GlobalConfigurationOutputLockingMode + + // Indicates whether the rate of frames emitted by the Live encoder should be paced + // by its system clock (which optionally may be locked to another source via NTP) + // or should be locked to the clock of the source that is providing the input + // stream. + OutputTimingSource GlobalConfigurationOutputTimingSource + + // Adjusts video input buffer for streams with very low video framerates. This is + // commonly set to enabled for music channels with less than one video frame per + // second. + SupportLowFramerateInputs GlobalConfigurationLowFramerateInputs } // H264 Color Space Settings type H264ColorSpaceSettings struct { + // Passthrough applies no color space conversion to the output + ColorSpacePassthroughSettings *ColorSpacePassthroughSettings + // Rec601 Settings Rec601Settings *Rec601Settings // Rec709 Settings Rec709Settings *Rec709Settings - - // Passthrough applies no color space conversion to the output - ColorSpacePassthroughSettings *ColorSpacePassthroughSettings } // H264 Filter Settings @@ -1299,58 +1299,46 @@ type H264FilterSettings struct { // H264 Settings type H264Settings struct { - // Color Space settings - ColorSpaceSettings *H264ColorSpaceSettings - - // Softness. Selects quantizer matrix, larger values reduce high-frequency content - // in the encoded image. - Softness *int32 - - // Documentation update needed - GopBReference H264GopBReference + // Adaptive quantization. Allows intra-frame quantizers to vary to improve visual + // quality. + AdaptiveQuantization H264AdaptiveQuantization - // Pixel Aspect Ratio denominator. - ParDenominator *int32 + // Indicates that AFD values will be written into the output stream. If + // afdSignaling is "auto", the system will try to preserve the input AFD value (in + // cases where multiple AFD values are valid). If set to "fixed", the AFD value + // will be the value configured in the fixedAfd parameter. + AfdSignaling AfdSignaling // Average bitrate in bits/second. Required when the rate control mode is VBR or // CBR. Not used for QVBR. In an MS Smooth output group, each output must have a // unique value when its bitrate is rounded down to the nearest multiple of 1000. Bitrate *int32 - // If set to enabled, adjust quantization within each frame based on spatial - // variation of content complexity. - SpatialAq H264SpatialAq + // Percentage of the buffer that should initially be filled (HRD buffer model). + BufFillPct *int32 + + // Size of buffer (HRD buffer model) in bits. + BufSize *int32 + + // Includes colorspace metadata in the output. + ColorMetadata H264ColorMetadata + + // Color Space settings + ColorSpaceSettings *H264ColorSpaceSettings // Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc. EntropyEncoding H264EntropyEncoding - // Indicates if the gopSize is specified in frames or seconds. If seconds the - // system will convert the gopSize into a frame count at run time. - GopSizeUnits H264GopSizeUnits + // Optional filters that you can apply to an encode. + FilterSettings *H264FilterSettings // Four bit AFD value to write on all frames of video in the output stream. Only // valid when afdSignaling is set to 'Fixed'. FixedAfd FixedAfd - // Indicates that AFD values will be written into the output stream. If - // afdSignaling is "auto", the system will try to preserve the input AFD value (in - // cases where multiple AFD values are valid). If set to "fixed", the AFD value - // will be the value configured in the fixedAfd parameter. - AfdSignaling AfdSignaling - - // GOP size (keyframe interval) in units of either frames or seconds per - // gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be - // greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater - // than 0, but need not be an integer. - GopSize *float64 - - // Scene change detection. - // - // * On: inserts I-frames when scene change is - // detected. - // - // * Off: does not force an I-frame when scene change is detected. - SceneChangeDetect H264SceneChangeDetect + // If set to enabled, adjust quantization within each frame to reduce flicker or + // 'pop' on I-frames. + FlickerAq H264FlickerAq // This setting applies only when scan type is "interlaced." It controls whether // coding is performed on a field basis or on a frame basis. (When the video is @@ -1361,30 +1349,6 @@ type H264Settings struct { // appropriate for the content. ForceFieldPictures H264ForceFieldPictures - // Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if - // multiplex rate control is used. Enforces separation between repeated (cadence) - // I-frames and I-frames inserted by Scene Change Detection. If a scene change - // I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk - // and/or stretched to the scene change I-frame. GOP stretch requires enabling - // lookahead as well as setting I-interval. The normal cadence resumes for the next - // GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1 - MinIInterval *int32 - - // Leave as STANDARD_QUALITY or choose a different value (which might result in - // additional costs to run the channel). - // - // * ENHANCED_QUALITY: Produces a - // slightly better video quality without an increase in the bitrate. Has an effect - // only when the Rate control mode is QVBR or CBR. If this channel is in a - // MediaLive multiplex, the value must be ENHANCED_QUALITY. - // - // * - // STANDARD_QUALITY: Valid for any Rate control mode. - QualityLevel H264QualityLevel - - // Framerate denominator. - FramerateDenominator *int32 - // This field indicates how the output video frame rate is specified. If // "specified" is selected then the output video frame rate is determined by // framerateNumerator and framerateDenominator, else if "initializeFromSource" is @@ -1392,67 +1356,84 @@ type H264Settings struct { // frame rate of the first input. FramerateControl H264FramerateControl - // Adaptive quantization. Allows intra-frame quantizers to vary to improve visual - // quality. - AdaptiveQuantization H264AdaptiveQuantization + // Framerate denominator. + FramerateDenominator *int32 - // Optional filters that you can apply to an encode. - FilterSettings *H264FilterSettings + // Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps. + FramerateNumerator *int32 - // Number of reference frames to use. The encoder may use more than requested if - // using B-frames and/or interlaced encoding. - NumRefFrames *int32 + // Documentation update needed + GopBReference H264GopBReference - // Produces a bitstream compliant with SMPTE RP-2027. - Syntax H264Syntax + // Frequency of closed GOPs. In streaming applications, it is recommended that this + // be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly + // as possible. Setting this value to 0 will break output segmenting. + GopClosedCadence *int32 - // H.264 Level. - Level H264Level + // Number of B-frames between reference frames. + GopNumBFrames *int32 - // This field indicates how the output pixel aspect ratio is specified. If - // "specified" is selected then the output video pixel aspect ratio is determined - // by parNumerator and parDenominator, else if "initializeFromSource" is selected - // then the output pixsel aspect ratio will be set equal to the input video pixel - // aspect ratio of the first input. - ParControl H264ParControl - - // If set to enabled, adjust quantization within each frame based on temporal - // variation of content complexity. - TemporalAq H264TemporalAq - - // Frequency of closed GOPs. In streaming applications, it is recommended that this - // be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly - // as possible. Setting this value to 0 will break output segmenting. - GopClosedCadence *int32 - - // Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps. - FramerateNumerator *int32 + // GOP size (keyframe interval) in units of either frames or seconds per + // gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be + // greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater + // than 0, but need not be an integer. + GopSize *float64 - // If set to enabled, adjust quantization within each frame to reduce flicker or - // 'pop' on I-frames. - FlickerAq H264FlickerAq + // Indicates if the gopSize is specified in frames or seconds. If seconds the + // system will convert the gopSize into a frame count at run time. + GopSizeUnits H264GopSizeUnits - // H.264 Profile. - Profile H264Profile + // H.264 Level. + Level H264Level - // Rate control mode. QVBR: Quality will match the specified quality level except - // when it is constrained by the maximum bitrate. Recommended if you or your - // viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video - // complexity. Recommended instead of QVBR if you want to maintain a specific - // average bitrate over the duration of the channel. CBR: Quality varies, depending - // on the video complexity. Recommended only if you distribute your assets to - // devices that cannot handle variable bitrates. Multiplex: This rate control mode - // is only supported (and is required) when the video is being delivered to a - // MediaLive Multiplex in which case the rate control configuration is controlled - // by the properties within the Multiplex Program. - RateControlMode H264RateControlMode + // Amount of lookahead. A value of low can decrease latency and memory usage, while + // high can produce better quality for certain content. + LookAheadRateControl H264LookAheadRateControl // For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in // order to accommodate expected spikes in the complexity of the video. MaxBitrate *int32 - // Includes colorspace metadata in the output. - ColorMetadata H264ColorMetadata + // Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if + // multiplex rate control is used. Enforces separation between repeated (cadence) + // I-frames and I-frames inserted by Scene Change Detection. If a scene change + // I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk + // and/or stretched to the scene change I-frame. GOP stretch requires enabling + // lookahead as well as setting I-interval. The normal cadence resumes for the next + // GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1 + MinIInterval *int32 + + // Number of reference frames to use. The encoder may use more than requested if + // using B-frames and/or interlaced encoding. + NumRefFrames *int32 + + // This field indicates how the output pixel aspect ratio is specified. If + // "specified" is selected then the output video pixel aspect ratio is determined + // by parNumerator and parDenominator, else if "initializeFromSource" is selected + // then the output pixsel aspect ratio will be set equal to the input video pixel + // aspect ratio of the first input. + ParControl H264ParControl + + // Pixel Aspect Ratio denominator. + ParDenominator *int32 + + // Pixel Aspect Ratio numerator. + ParNumerator *int32 + + // H.264 Profile. + Profile H264Profile + + // Leave as STANDARD_QUALITY or choose a different value (which might result in + // additional costs to run the channel). + // + // * ENHANCED_QUALITY: Produces a + // slightly better video quality without an increase in the bitrate. Has an effect + // only when the Rate control mode is QVBR or CBR. If this channel is in a + // MediaLive multiplex, the value must be ENHANCED_QUALITY. + // + // * + // STANDARD_QUALITY: Valid for any Rate control mode. + QualityLevel H264QualityLevel // Controls the target quality for the video encode. Applies only when the rate // control mode is QVBR. Set values for the QVBR quality level field and Max @@ -1468,9 +1449,28 @@ type H264Settings struct { // level: 6. Max bitrate: 1M to 1.5M QvbrQualityLevel *int32 - // If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, - // optimize the number of B-frames used for each sub-GOP to improve visual quality. - SubgopLength H264SubGopLength + // Rate control mode. QVBR: Quality will match the specified quality level except + // when it is constrained by the maximum bitrate. Recommended if you or your + // viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video + // complexity. Recommended instead of QVBR if you want to maintain a specific + // average bitrate over the duration of the channel. CBR: Quality varies, depending + // on the video complexity. Recommended only if you distribute your assets to + // devices that cannot handle variable bitrates. Multiplex: This rate control mode + // is only supported (and is required) when the video is being delivered to a + // MediaLive Multiplex in which case the rate control configuration is controlled + // by the properties within the Multiplex Program. + RateControlMode H264RateControlMode + + // Sets the scan type of the output to progressive or top-field-first interlaced. + ScanType H264ScanType + + // Scene change detection. + // + // * On: inserts I-frames when scene change is + // detected. + // + // * Off: does not force an I-frame when scene change is detected. + SceneChangeDetect H264SceneChangeDetect // Number of slices per picture. Must be less than or equal to the number of // macroblock rows for progressive pictures, and less than or equal to half the @@ -1479,12 +1479,24 @@ type H264Settings struct { // encode resolution. Slices *int32 - // Amount of lookahead. A value of low can decrease latency and memory usage, while - // high can produce better quality for certain content. - LookAheadRateControl H264LookAheadRateControl + // Softness. Selects quantizer matrix, larger values reduce high-frequency content + // in the encoded image. + Softness *int32 - // Size of buffer (HRD buffer model) in bits. - BufSize *int32 + // If set to enabled, adjust quantization within each frame based on spatial + // variation of content complexity. + SpatialAq H264SpatialAq + + // If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, + // optimize the number of B-frames used for each sub-GOP to improve visual quality. + SubgopLength H264SubGopLength + + // Produces a bitstream compliant with SMPTE RP-2027. + Syntax H264Syntax + + // If set to enabled, adjust quantization within each frame based on temporal + // variation of content complexity. + TemporalAq H264TemporalAq // Determines how timecodes should be inserted into the video elementary stream. // @@ -1494,23 +1506,14 @@ type H264Settings struct { // * 'picTimingSei': Pass through // picture timing SEI messages from the source specified in Timecode Config TimecodeInsertion H264TimecodeInsertionBehavior - - // Sets the scan type of the output to progressive or top-field-first interlaced. - ScanType H264ScanType - - // Percentage of the buffer that should initially be filled (HRD buffer model). - BufFillPct *int32 - - // Pixel Aspect Ratio numerator. - ParNumerator *int32 - - // Number of B-frames between reference frames. - GopNumBFrames *int32 } // H265 Color Space Settings type H265ColorSpaceSettings struct { + // Passthrough applies no color space conversion to the output + ColorSpacePassthroughSettings *ColorSpacePassthroughSettings + // Hdr10 Settings Hdr10Settings *Hdr10Settings @@ -1519,9 +1522,6 @@ type H265ColorSpaceSettings struct { // Rec709 Settings Rec709Settings *Rec709Settings - - // Passthrough applies no color space conversion to the output - ColorSpacePassthroughSettings *ColorSpacePassthroughSettings } // H265 Filter Settings @@ -1534,21 +1534,19 @@ type H265FilterSettings struct { // H265 Settings type H265Settings struct { - // Whether or not EML should insert an Alternative Transfer Function SEI message to - // support backwards compatibility with non-HDR decoders and displays. - AlternativeTransferFunction H265AlternativeTransferFunction - - // Pixel Aspect Ratio denominator. - ParDenominator *int32 - - // Color Space settings - ColorSpaceSettings *H265ColorSpaceSettings + // Framerate denominator. + // + // This member is required. + FramerateDenominator *int32 - // H.265 Tier. - Tier H265Tier + // Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps. + // + // This member is required. + FramerateNumerator *int32 - // For QVBR: See the tooltip for Quality level - MaxBitrate *int32 + // Adaptive quantization. Allows intra-frame quantizers to vary to improve visual + // quality. + AdaptiveQuantization H265AdaptiveQuantization // Indicates that AFD values will be written into the output stream. If // afdSignaling is "auto", the system will try to preserve the input AFD value (in @@ -1556,13 +1554,14 @@ type H265Settings struct { // will be the value configured in the fixedAfd parameter. AfdSignaling AfdSignaling - // Four bit AFD value to write on all frames of video in the output stream. Only - // valid when afdSignaling is set to 'Fixed'. - FixedAfd FixedAfd + // Whether or not EML should insert an Alternative Transfer Function SEI message to + // support backwards compatibility with non-HDR decoders and displays. + AlternativeTransferFunction H265AlternativeTransferFunction - // Indicates if the gopSize is specified in frames or seconds. If seconds the - // system will convert the gopSize into a frame count at run time. - GopSizeUnits H265GopSizeUnits + // Average bitrate in bits/second. Required when the rate control mode is VBR or + // CBR. Not used for QVBR. In an MS Smooth output group, each output must have a + // unique value when its bitrate is rounded down to the nearest multiple of 1000. + Bitrate *int32 // Size of buffer (HRD buffer model) in bits. BufSize *int32 @@ -1570,30 +1569,62 @@ type H265Settings struct { // Includes colorspace metadata in the output. ColorMetadata H265ColorMetadata - // Pixel Aspect Ratio numerator. - ParNumerator *int32 + // Color Space settings + ColorSpaceSettings *H265ColorSpaceSettings - // Sets the scan type of the output to progressive or top-field-first interlaced. - ScanType H265ScanType + // Optional filters that you can apply to an encode. + FilterSettings *H265FilterSettings - // Determines how timecodes should be inserted into the video elementary stream. - // - // - // * 'disabled': Do not include timecodes - // - // * 'picTimingSei': Pass through - // picture timing SEI messages from the source specified in Timecode Config - TimecodeInsertion H265TimecodeInsertionBehavior + // Four bit AFD value to write on all frames of video in the output stream. Only + // valid when afdSignaling is set to 'Fixed'. + FixedAfd FixedAfd + + // If set to enabled, adjust quantization within each frame to reduce flicker or + // 'pop' on I-frames. + FlickerAq H265FlickerAq + + // Frequency of closed GOPs. In streaming applications, it is recommended that this + // be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly + // as possible. Setting this value to 0 will break output segmenting. + GopClosedCadence *int32 + + // GOP size (keyframe interval) in units of either frames or seconds per + // gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be + // greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater + // than 0, but need not be an integer. + GopSize *float64 + + // Indicates if the gopSize is specified in frames or seconds. If seconds the + // system will convert the gopSize into a frame count at run time. + GopSizeUnits H265GopSizeUnits // H.265 Level. Level H265Level - // Number of slices per picture. Must be less than or equal to the number of - // macroblock rows for progressive pictures, and less than or equal to half the - // number of macroblock rows for interlaced pictures. This field is optional; when - // no value is specified the encoder will choose the number of slices based on - // encode resolution. - Slices *int32 + // Amount of lookahead. A value of low can decrease latency and memory usage, while + // high can produce better quality for certain content. + LookAheadRateControl H265LookAheadRateControl + + // For QVBR: See the tooltip for Quality level + MaxBitrate *int32 + + // Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if + // multiplex rate control is used. Enforces separation between repeated (cadence) + // I-frames and I-frames inserted by Scene Change Detection. If a scene change + // I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk + // and/or stretched to the scene change I-frame. GOP stretch requires enabling + // lookahead as well as setting I-interval. The normal cadence resumes for the next + // GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1 + MinIInterval *int32 + + // Pixel Aspect Ratio denominator. + ParDenominator *int32 + + // Pixel Aspect Ratio numerator. + ParNumerator *int32 + + // H.265 Profile. + Profile H265Profile // Controls the target quality for the video encode. Applies only when the rate // control mode is QVBR. Set values for the QVBR quality level field and Max @@ -1609,36 +1640,6 @@ type H265Settings struct { // level: 6. Max bitrate: 1M to 1.5M QvbrQualityLevel *int32 - // Amount of lookahead. A value of low can decrease latency and memory usage, while - // high can produce better quality for certain content. - LookAheadRateControl H265LookAheadRateControl - - // If set to enabled, adjust quantization within each frame to reduce flicker or - // 'pop' on I-frames. - FlickerAq H265FlickerAq - - // Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps. - // - // This member is required. - FramerateNumerator *int32 - - // H.265 Profile. - Profile H265Profile - - // Average bitrate in bits/second. Required when the rate control mode is VBR or - // CBR. Not used for QVBR. In an MS Smooth output group, each output must have a - // unique value when its bitrate is rounded down to the nearest multiple of 1000. - Bitrate *int32 - - // Adaptive quantization. Allows intra-frame quantizers to vary to improve visual - // quality. - AdaptiveQuantization H265AdaptiveQuantization - - // Frequency of closed GOPs. In streaming applications, it is recommended that this - // be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly - // as possible. Setting this value to 0 will break output segmenting. - GopClosedCadence *int32 - // Rate control mode. QVBR: Quality will match the specified quality level except // when it is constrained by the maximum bitrate. Recommended if you or your // viewers pay for bandwidth. CBR: Quality varies, depending on the video @@ -1649,31 +1650,30 @@ type H265Settings struct { // properties within the Multiplex Program. RateControlMode H265RateControlMode - // Framerate denominator. - // - // This member is required. - FramerateDenominator *int32 - - // Optional filters that you can apply to an encode. - FilterSettings *H265FilterSettings + // Sets the scan type of the output to progressive or top-field-first interlaced. + ScanType H265ScanType // Scene change detection. SceneChangeDetect H265SceneChangeDetect - // GOP size (keyframe interval) in units of either frames or seconds per - // gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be - // greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater - // than 0, but need not be an integer. - GopSize *float64 + // Number of slices per picture. Must be less than or equal to the number of + // macroblock rows for progressive pictures, and less than or equal to half the + // number of macroblock rows for interlaced pictures. This field is optional; when + // no value is specified the encoder will choose the number of slices based on + // encode resolution. + Slices *int32 - // Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if - // multiplex rate control is used. Enforces separation between repeated (cadence) - // I-frames and I-frames inserted by Scene Change Detection. If a scene change - // I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk - // and/or stretched to the scene change I-frame. GOP stretch requires enabling - // lookahead as well as setting I-interval. The normal cadence resumes for the next - // GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1 - MinIInterval *int32 + // H.265 Tier. + Tier H265Tier + + // Determines how timecodes should be inserted into the video elementary stream. + // + // + // * 'disabled': Do not include timecodes + // + // * 'picTimingSei': Pass through + // picture timing SEI messages from the source specified in Timecode Config + TimecodeInsertion H265TimecodeInsertionBehavior } // Hdr10 Settings @@ -1692,39 +1692,35 @@ type Hdr10Settings struct { // Hls Akamai Settings type HlsAkamaiSettings struct { + // Number of seconds to wait before retrying connection to the CDN if the + // connection is lost. + ConnectionRetryInterval *int32 + // Size in seconds of file cache for streaming outputs. FilecacheDuration *int32 - // Token parameter for authenticated akamai. If not specified, gda is used. - Token *string - - // Salt for authenticated Akamai. - Salt *string - // Specify whether or not to use chunked transfer encoding to Akamai. User should // contact Akamai to enable this feature. HttpTransferMode HlsAkamaiHttpTransferMode - // Number of seconds to wait before retrying connection to the CDN if the - // connection is lost. - ConnectionRetryInterval *int32 + // Number of retry attempts that will be made before the Live Event is put into an + // error state. + NumRetries *int32 // If a streaming output fails, number of seconds to wait until a restart is // initiated. A value of 0 means never restart. RestartDelay *int32 - // Number of retry attempts that will be made before the Live Event is put into an - // error state. - NumRetries *int32 + // Salt for authenticated Akamai. + Salt *string + + // Token parameter for authenticated akamai. If not specified, gda is used. + Token *string } // Hls Basic Put Settings type HlsBasicPutSettings struct { - // If a streaming output fails, number of seconds to wait until a restart is - // initiated. A value of 0 means never restart. - RestartDelay *int32 - // Number of seconds to wait before retrying connection to the CDN if the // connection is lost. ConnectionRetryInterval *int32 @@ -1735,6 +1731,10 @@ type HlsBasicPutSettings struct { // Number of retry attempts that will be made before the Live Event is put into an // error state. NumRetries *int32 + + // If a streaming output fails, number of seconds to wait until a restart is + // initiated. A value of 0 means never restart. + RestartDelay *int32 } // Hls Cdn Settings @@ -1743,68 +1743,33 @@ type HlsCdnSettings struct { // Hls Akamai Settings HlsAkamaiSettings *HlsAkamaiSettings - // Hls Webdav Settings - HlsWebdavSettings *HlsWebdavSettings - // Hls Basic Put Settings HlsBasicPutSettings *HlsBasicPutSettings // Hls Media Store Settings HlsMediaStoreSettings *HlsMediaStoreSettings + + // Hls Webdav Settings + HlsWebdavSettings *HlsWebdavSettings } // Hls Group Settings type HlsGroupSettings struct { - // Indicates whether the output manifest should use floating point or integer - // values for segment duration. - ManifestDurationFormat HlsManifestDurationFormat - - // Place segments in subdirectories. - DirectoryStructure HlsDirectoryStructure - - // Timed Metadata interval in seconds. - TimedMetadataId3Period *int32 - - // Applies only if Mode field is LIVE. Specifies the number of media segments (.ts - // files) to retain in the destination directory. - KeepSegments *int32 - - // When set to gzip, compresses HLS playlist. - ManifestCompression HlsManifestCompression - - // Length of MPEG-2 Transport Stream segments to create (in seconds). Note that - // segments will end on the next keyframe after this number of seconds, so actual - // segment length may be longer. - SegmentLength *int32 - - // The key provider settings. - KeyProviderSettings *KeyProviderSettings - - // Applies only if Mode field is LIVE. Specifies the maximum number of segments in - // the media manifest file. After this maximum, older segments are removed from the - // media manifest. This number must be less than or equal to the Keep Segments - // field. - IndexNSegments *int32 - - // Mapping of up to 4 caption channels to caption languages. Is only meaningful if - // captionLanguageSetting is set to "insert". - CaptionLanguageMappings []*CaptionLanguageMapping + // A directory or HTTP destination for the HLS segments, manifest files, and + // encryption keys (if enabled). + // + // This member is required. + Destination *OutputLocationRef - // SEGMENTED_FILES: Emit the program as segments - multiple .ts media files. - // SINGLE_FILE: Applies only if Mode field is VOD. Emit the program as a single .ts - // media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments - // for playback. A typical use for this value is when sending the output to AWS - // Elemental MediaConvert, which can accept only a single media file. Playback - // while the channel is running is not guaranteed due to HTTP server caching. - TsFileMode HlsTsFileMode + // Choose one or more ad marker types to pass SCTE35 signals through to this group + // of Apple HLS outputs. + AdMarkers []HlsAdMarkers - // For use with encryptionType. The IV (Initialization Vector) is a 128-bit number - // used in conjunction with the key for encrypting blocks. If this setting is - // "followsSegmentNumber", it will cause the IV to change every segment (to match - // the segment number). If this is set to "explicit", you must enter a constantIv - // value. - IvSource HlsIvSource + // A partial URI prefix that will be prepended to each output in the media .m3u8 + // file. Can be used if base manifest is delivered from a different URL than the + // main .m3u8 file. + BaseUrlContent *string // Optional. One value per output group. This field is required only if you are // completing Base URL content A, and the downstream system has notified you that @@ -1812,42 +1777,20 @@ type HlsGroupSettings struct { // the media files for pipeline 0. BaseUrlContent1 *string - // useInputSegmentation has been deprecated. The configured segment size is always - // used. - SegmentationMode HlsSegmentationMode - - // The value specifies how the key is represented in the resource identified by the - // URI. If parameter is absent, an implicit value of "identity" is used. A reverse - // DNS string can also be given. - KeyFormat *string - - // Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The - // value is calculated as follows: either the program date and time are initialized - // using the input timecode source, or the time is initialized using the input - // timecode source and the date is initialized using the timestampOffset. - ProgramDateTime HlsProgramDateTime - // A partial URI prefix that will be prepended to each output in the media .m3u8 // file. Can be used if base manifest is delivered from a different URL than the // main .m3u8 file. BaseUrlManifest *string - // Choose one or more ad marker types to pass SCTE35 signals through to this group - // of Apple HLS outputs. - AdMarkers []HlsAdMarkers - - // A partial URI prefix that will be prepended to each output in the media .m3u8 - // file. Can be used if base manifest is delivered from a different URL than the - // main .m3u8 file. - BaseUrlContent *string - - // Provides an extra millisecond delta offset to fine tune the timestamps. - TimestampDeltaMilliseconds *int32 + // Optional. One value per output group. Complete this field only if you are + // completing Base URL manifest A, and the downstream system has notified you that + // the child manifest files for pipeline 1 of all outputs are in a location + // different from the child manifest files for pipeline 0. + BaseUrlManifest1 *string - // Number of segments to write to a subdirectory before starting a new one. - // directoryStructure must be subdirectoryPerStream for this setting to have an - // effect. - SegmentsPerSubdirectory *int32 + // Mapping of up to 4 caption channels to caption languages. Is only meaningful if + // captionLanguageSetting is set to "insert". + CaptionLanguageMappings []*CaptionLanguageMapping // Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS // lines in the manifest. Specify at least one language in the CC1 Language Code @@ -1860,6 +1803,32 @@ type HlsGroupSettings struct { // from the manifest. CaptionLanguageSetting HlsCaptionLanguageSetting + // When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, + // which prevents clients from saving media segments for later replay. + ClientCache HlsClientCache + + // Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist + // generation. + CodecSpecification HlsCodecSpecification + + // For use with encryptionType. This is a 128-bit, 16-byte hex value represented by + // a 32-character text string. If ivSource is set to "explicit" then this parameter + // is required and is used as the IV for encryption. + ConstantIv *string + + // Place segments in subdirectories. + DirectoryStructure HlsDirectoryStructure + + // Encrypts the segments with the given encryption scheme. Exclude this parameter + // if no encryption is desired. + EncryptionType HlsEncryptionType + + // Parameters that control interactions with the CDN. + HlsCdnSettings *HlsCdnSettings + + // State of HLS ID3 Segment Tagging + HlsId3SegmentTagging HlsId3SegmentTaggingState + // DISABLED: Do not create an I-frame-only manifest, but do create the master and // media manifests (according to the Output Selection field). STANDARD: Create an // I-frame-only manifest for each output that contains video, as well as the other @@ -1869,20 +1838,76 @@ type HlsGroupSettings struct { // #EXT-X-BYTERANGE:160364@1461888" IFrameOnlyPlaylists IFrameOnlyPlaylistType + // Applies only if Mode field is LIVE. Specifies the maximum number of segments in + // the media manifest file. After this maximum, older segments are removed from the + // media manifest. This number must be less than or equal to the Keep Segments + // field. + IndexNSegments *int32 + + // Parameter that control output group behavior on input loss. + InputLossAction InputLossActionForHlsOut + // For use with encryptionType. The IV (Initialization Vector) is a 128-bit number // used in conjunction with the key for encrypting blocks. If set to "include", IV // is listed in the manifest, otherwise the IV is not in the manifest. IvInManifest HlsIvInManifest + // For use with encryptionType. The IV (Initialization Vector) is a 128-bit number + // used in conjunction with the key for encrypting blocks. If this setting is + // "followsSegmentNumber", it will cause the IV to change every segment (to match + // the segment number). If this is set to "explicit", you must enter a constantIv + // value. + IvSource HlsIvSource + + // Applies only if Mode field is LIVE. Specifies the number of media segments (.ts + // files) to retain in the destination directory. + KeepSegments *int32 + + // The value specifies how the key is represented in the resource identified by the + // URI. If parameter is absent, an implicit value of "identity" is used. A reverse + // DNS string can also be given. + KeyFormat *string + + // Either a single positive integer version value or a slash delimited list of + // version values (1/2/3). + KeyFormatVersions *string + + // The key provider settings. + KeyProviderSettings *KeyProviderSettings + + // When set to gzip, compresses HLS playlist. + ManifestCompression HlsManifestCompression + + // Indicates whether the output manifest should use floating point or integer + // values for segment duration. + ManifestDurationFormat HlsManifestDurationFormat + + // When set, minimumSegmentLength is enforced by looking ahead and back within the + // specified range for a nearby avail and extending the segment size if needed. + MinSegmentLength *int32 + + // If "vod", all segments are indexed and kept permanently in the destination and + // manifest. If "live", only the number segments specified in keepSegments and + // indexNSegments are kept; newer segments replace older segments, which may + // prevent players from rewinding all the way to the beginning of the event. VOD + // mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, + // converting it to a "VOD" type manifest on completion of the stream. + Mode HlsMode + // MANIFESTS_AND_SEGMENTS: Generates manifests (master manifest, if applicable, and // media manifests) for this output group. VARIANT_MANIFESTS_AND_SEGMENTS: // Generates media manifests for this output group, but not a master manifest. // SEGMENTS_ONLY: Does not generate any manifests for this output group. OutputSelection HlsOutputSelection - // Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of - // variant manifest. - StreamInfResolution HlsStreamInfResolution + // Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The + // value is calculated as follows: either the program date and time are initialized + // using the input timecode source, or the time is initialized using the input + // timecode source and the date is initialized using the timestampOffset. + ProgramDateTime HlsProgramDateTime + + // Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds. + ProgramDateTimePeriod *int32 // ENABLED: The master manifest (.m3u8 file) for each pipeline includes information // about both pipelines: first its own media files, then the media files of the @@ -1897,65 +1922,40 @@ type HlsGroupSettings struct { // manifest from MediaLive is irrelevant. RedundantManifest HlsRedundantManifest - // Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds. - ProgramDateTimePeriod *int32 - - // Indicates ID3 frame that has the timecode. - TimedMetadataId3Frame HlsTimedMetadataId3Frame - - // When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, - // which prevents clients from saving media segments for later replay. - ClientCache HlsClientCache - - // When set, minimumSegmentLength is enforced by looking ahead and back within the - // specified range for a nearby avail and extending the segment size if needed. - MinSegmentLength *int32 - - // Optional. One value per output group. Complete this field only if you are - // completing Base URL manifest A, and the downstream system has notified you that - // the child manifest files for pipeline 1 of all outputs are in a location - // different from the child manifest files for pipeline 0. - BaseUrlManifest1 *string - - // If "vod", all segments are indexed and kept permanently in the destination and - // manifest. If "live", only the number segments specified in keepSegments and - // indexNSegments are kept; newer segments replace older segments, which may - // prevent players from rewinding all the way to the beginning of the event. VOD - // mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, - // converting it to a "VOD" type manifest on completion of the stream. - Mode HlsMode - - // Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist - // generation. - CodecSpecification HlsCodecSpecification + // Length of MPEG-2 Transport Stream segments to create (in seconds). Note that + // segments will end on the next keyframe after this number of seconds, so actual + // segment length may be longer. + SegmentLength *int32 - // A directory or HTTP destination for the HLS segments, manifest files, and - // encryption keys (if enabled). - // - // This member is required. - Destination *OutputLocationRef + // useInputSegmentation has been deprecated. The configured segment size is always + // used. + SegmentationMode HlsSegmentationMode - // Parameter that control output group behavior on input loss. - InputLossAction InputLossActionForHlsOut + // Number of segments to write to a subdirectory before starting a new one. + // directoryStructure must be subdirectoryPerStream for this setting to have an + // effect. + SegmentsPerSubdirectory *int32 - // Encrypts the segments with the given encryption scheme. Exclude this parameter - // if no encryption is desired. - EncryptionType HlsEncryptionType + // Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of + // variant manifest. + StreamInfResolution HlsStreamInfResolution - // For use with encryptionType. This is a 128-bit, 16-byte hex value represented by - // a 32-character text string. If ivSource is set to "explicit" then this parameter - // is required and is used as the IV for encryption. - ConstantIv *string + // Indicates ID3 frame that has the timecode. + TimedMetadataId3Frame HlsTimedMetadataId3Frame - // Either a single positive integer version value or a slash delimited list of - // version values (1/2/3). - KeyFormatVersions *string + // Timed Metadata interval in seconds. + TimedMetadataId3Period *int32 - // State of HLS ID3 Segment Tagging - HlsId3SegmentTagging HlsId3SegmentTaggingState + // Provides an extra millisecond delta offset to fine tune the timestamps. + TimestampDeltaMilliseconds *int32 - // Parameters that control interactions with the CDN. - HlsCdnSettings *HlsCdnSettings + // SEGMENTED_FILES: Emit the program as segments - multiple .ts media files. + // SINGLE_FILE: Applies only if Mode field is VOD. Emit the program as a single .ts + // media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments + // for playback. A typical use for this value is when sending the output to AWS + // Elemental MediaConvert, which can accept only a single media file. Playback + // while the channel is running is not guaranteed due to HTTP server caching. + TsFileMode HlsTsFileMode } // Settings for the action to insert a user-defined ID3 tag in each HLS segment @@ -1972,56 +1972,52 @@ type HlsId3SegmentTaggingScheduleActionSettings struct { // Hls Input Settings type HlsInputSettings struct { - // The number of seconds between retries when an attempt to read a manifest or - // segment fails. - RetryInterval *int32 - - // When specified, reading of the HLS input will begin this many buffer segments - // from the end (most recently written segment). When not specified, the HLS input - // will begin with the first segment specified in the m3u8. - BufferSegments *int32 - // When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches // this value will be chosen, otherwise the highest bandwidth stream in the m3u8 // will be chosen. The bitrate is specified in bits per second, as in an HLS // manifest. Bandwidth *int32 + // When specified, reading of the HLS input will begin this many buffer segments + // from the end (most recently written segment). When not specified, the HLS input + // will begin with the first segment specified in the m3u8. + BufferSegments *int32 + // The number of consecutive times that attempts to read a manifest or segment must // fail before the input is considered unavailable. Retries *int32 + + // The number of seconds between retries when an attempt to read a manifest or + // segment fails. + RetryInterval *int32 } // Hls Media Store Settings type HlsMediaStoreSettings struct { - // Number of retry attempts that will be made before the Live Event is put into an - // error state. - NumRetries *int32 + // Number of seconds to wait before retrying connection to the CDN if the + // connection is lost. + ConnectionRetryInterval *int32 - // If a streaming output fails, number of seconds to wait until a restart is - // initiated. A value of 0 means never restart. - RestartDelay *int32 + // Size in seconds of file cache for streaming outputs. + FilecacheDuration *int32 // When set to temporal, output files are stored in non-persistent memory for // faster reading and writing. MediaStoreStorageClass HlsMediaStoreStorageClass - // Number of seconds to wait before retrying connection to the CDN if the - // connection is lost. - ConnectionRetryInterval *int32 + // Number of retry attempts that will be made before the Live Event is put into an + // error state. + NumRetries *int32 - // Size in seconds of file cache for streaming outputs. - FilecacheDuration *int32 + // If a streaming output fails, number of seconds to wait until a restart is + // initiated. A value of 0 means never restart. + RestartDelay *int32 } // Hls Output Settings type HlsOutputSettings struct { - // String concatenated to the end of the destination filename. Accepts "Format - // Identifiers":#formatIdentifierParameters. - NameModifier *string - // Settings regarding the underlying stream. These settings are different for // audio-only outputs. // @@ -2032,6 +2028,10 @@ type HlsOutputSettings struct { // Specifies whether MP4 segments should be packaged as HEV1 or HVC1. H265PackagingType HlsH265PackagingType + // String concatenated to the end of the destination filename. Accepts "Format + // Identifiers":#formatIdentifierParameters. + NameModifier *string + // String concatenated to end of segment filenames. SegmentModifier *string } @@ -2039,14 +2039,14 @@ type HlsOutputSettings struct { // Hls Settings type HlsSettings struct { - // Standard Hls Settings - StandardHlsSettings *StandardHlsSettings + // Audio Only Hls Settings + AudioOnlyHlsSettings *AudioOnlyHlsSettings // Fmp4 Hls Settings Fmp4HlsSettings *Fmp4HlsSettings - // Audio Only Hls Settings - AudioOnlyHlsSettings *AudioOnlyHlsSettings + // Standard Hls Settings + StandardHlsSettings *StandardHlsSettings } // Settings for the action to emit HLS metadata @@ -2062,6 +2062,13 @@ type HlsTimedMetadataScheduleActionSettings struct { // Hls Webdav Settings type HlsWebdavSettings struct { + // Number of seconds to wait before retrying connection to the CDN if the + // connection is lost. + ConnectionRetryInterval *int32 + + // Size in seconds of file cache for streaming outputs. + FilecacheDuration *int32 + // Specify whether or not to use chunked transfer encoding to WebDAV. HttpTransferMode HlsWebdavHttpTransferMode @@ -2069,16 +2076,9 @@ type HlsWebdavSettings struct { // error state. NumRetries *int32 - // Size in seconds of file cache for streaming outputs. - FilecacheDuration *int32 - // If a streaming output fails, number of seconds to wait until a restart is // initiated. A value of 0 means never restart. RestartDelay *int32 - - // Number of seconds to wait before retrying connection to the CDN if the - // connection is lost. - ConnectionRetryInterval *int32 } // Settings to configure an action so that it occurs as soon as possible. @@ -2088,12 +2088,18 @@ type ImmediateModeScheduleActionStartSettings struct { // Placeholder documentation for Input type Input struct { - // A list of IDs for all the Input Security Groups attached to the input. - SecurityGroups []*string + // The Unique ARN of the input (generated, immutable). + Arn *string - // The Amazon Resource Name (ARN) of the role this input assumes during and after - // creation. - RoleArn *string + // A list of channel IDs that that input is attached to (currently an input can + // only be attached to one channel). + AttachedChannels []*string + + // A list of the destinations of the input (PUSH-type). + Destinations []*InputDestination + + // The generated ID of the input (unique for user account, immutable). + Id *string // STANDARD - MediaLive expects two sources to be connected to this input. If the // channel is also STANDARD, both sources will be ingested. If the channel is @@ -2104,49 +2110,47 @@ type Input struct { // value is not valid because the channel requires two sources in the input. InputClass InputClass - // The Unique ARN of the input (generated, immutable). - Arn *string - - // The generated ID of the input (unique for user account, immutable). - Id *string + // Settings for the input devices. + InputDevices []*InputDeviceSettings - // A list of the sources of the input (PULL-type). - Sources []*InputSource + // Certain pull input sources can be dynamic, meaning that they can have their + // URL's dynamically changes during input switch actions. Presently, this + // functionality only works with MP4_FILE inputs. + InputSourceType InputSourceType - // A list of the destinations of the input (PUSH-type). - Destinations []*InputDestination + // A list of MediaConnect Flows for this input. + MediaConnectFlows []*MediaConnectFlow // The user-assigned name (This is a mutable value). Name *string - // Placeholder documentation for InputState - State InputState + // The Amazon Resource Name (ARN) of the role this input assumes during and after + // creation. + RoleArn *string - // A list of MediaConnect Flows for this input. - MediaConnectFlows []*MediaConnectFlow + // A list of IDs for all the Input Security Groups attached to the input. + SecurityGroups []*string - // Certain pull input sources can be dynamic, meaning that they can have their - // URL's dynamically changes during input switch actions. Presently, this - // functionality only works with MP4_FILE inputs. - InputSourceType InputSourceType + // A list of the sources of the input (PULL-type). + Sources []*InputSource - // Placeholder documentation for InputType - Type InputType + // Placeholder documentation for InputState + State InputState // A collection of key-value pairs. Tags map[string]*string - // A list of channel IDs that that input is attached to (currently an input can - // only be attached to one channel). - AttachedChannels []*string - - // Settings for the input devices. - InputDevices []*InputDeviceSettings + // Placeholder documentation for InputType + Type InputType } // Placeholder documentation for InputAttachment type InputAttachment struct { + // User-specified settings for defining what the conditions are for declaring the + // input unhealthy and failing over to a different input. + AutomaticInputFailoverSettings *AutomaticInputFailoverSettings + // User-specified name for the attachment. This is required if the user wants to // use this input in an input switch action. InputAttachmentName *string @@ -2154,10 +2158,6 @@ type InputAttachment struct { // The ID of the input InputId *string - // User-specified settings for defining what the conditions are for declaring the - // input unhealthy and failing over to a different input. - AutomaticInputFailoverSettings *AutomaticInputFailoverSettings - // Settings of an input (caption selector, etc.) InputSettings *InputSettings } @@ -2165,16 +2165,16 @@ type InputAttachment struct { // Input Channel Level type InputChannelLevel struct { - // The index of the input channel used as a source. - // - // This member is required. - InputChannel *int32 - // Remixing value. Units are in dB and acceptable values are within the range from // -60 (mute) and 6 dB. // // This member is required. Gain *int32 + + // The index of the input channel used as a source. + // + // This member is required. + InputChannel *int32 } // Settings to let you create a clip of the file input, in order to set up the @@ -2186,28 +2186,28 @@ type InputClippingSettings struct { // This member is required. InputTimecodeSource InputTimecodeSource - // Settings to identify the end of the clip. - StopTimecode *StopTimecode - // Settings to identify the start of the clip. StartTimecode *StartTimecode + + // Settings to identify the end of the clip. + StopTimecode *StopTimecode } // The settings for a PUSH type input. type InputDestination struct { - // The port number for the input. - Port *string - - // The properties for a VPC type input destination. - Vpc *InputDestinationVpc - // The system-generated static IP address of endpoint. It remains fixed for the // lifetime of the input. Ip *string + // The port number for the input. + Port *string + // This represents the endpoint that the customer stream will be pushed to. Url *string + + // The properties for a VPC type input destination. + Vpc *InputDestinationVpc } // Endpoint settings for a PUSH type input. @@ -2220,77 +2220,77 @@ type InputDestinationRequest struct { // The properties for a VPC type input destination. type InputDestinationVpc struct { - // The network interface ID of the Input destination in the VPC. - NetworkInterfaceId *string - // The availability zone of the Input destination. AvailabilityZone *string + + // The network interface ID of the Input destination in the VPC. + NetworkInterfaceId *string } // Configurable settings for the input device. type InputDeviceConfigurableSettings struct { - // The maximum bitrate in bits per second. Set a value here to throttle the bitrate - // of the source video. - MaxBitrate *int32 - // The input source that you want to use. If the device has a source connected to // only one of its input ports, or if you don't care which source the device sends, // specify Auto. If the device has sources connected to both its input ports, and // you want to use a specific source, specify the source. ConfiguredInput InputDeviceConfiguredInput + + // The maximum bitrate in bits per second. Set a value here to throttle the bitrate + // of the source video. + MaxBitrate *int32 } // Settings that describe the active source from the input device, and the video // characteristics of that source. type InputDeviceHdSettings struct { - // The width of the video source, in pixels. - Width *int32 - - // The height of the video source, in pixels. - Height *int32 - // If you specified Auto as the configured input, specifies which of the sources is // currently active (SDI or HDMI). ActiveInput InputDeviceActiveInput - // The frame rate of the video source. - Framerate *float64 + // The source at the input device that is currently active. You can specify this + // source. + ConfiguredInput InputDeviceConfiguredInput // The state of the input device. DeviceState InputDeviceState + // The frame rate of the video source. + Framerate *float64 + + // The height of the video source, in pixels. + Height *int32 + // The current maximum bitrate for ingesting this source, in bits per second. You // can specify this maximum. MaxBitrate *int32 - // The source at the input device that is currently active. You can specify this - // source. - ConfiguredInput InputDeviceConfiguredInput - // The scan type of the video source. ScanType InputDeviceScanType + + // The width of the video source, in pixels. + Width *int32 } // The network settings for the input device. type InputDeviceNetworkSettings struct { - // The subnet mask of the input device. - SubnetMask *string + // The DNS addresses of the input device. + DnsAddresses []*string // The network gateway IP address. Gateway *string - // The DNS addresses of the input device. - DnsAddresses []*string + // The IP address of the input device. + IpAddress *string // Specifies whether the input device has been configured (outside of MediaLive) to // use a dynamic IP address assignment (DHCP) or a static IP address. IpScheme InputDeviceIpScheme - // The IP address of the input device. - IpAddress *string + // The subnet mask of the input device. + SubnetMask *string } // Settings for an input device. @@ -2310,6 +2310,12 @@ type InputDeviceSettings struct { // Details of the input device. type InputDeviceSummary struct { + // The unique ARN of the input device. + Arn *string + + // The state of the connection between the input device and AWS. + ConnectionState InputDeviceConnectionState + // The status of the action to synchronize the device configuration. If you change // the configuration of the input device (for example, the maximum bitrate), // MediaLive sends the new data to the device. The device might not update itself @@ -2317,8 +2323,8 @@ type InputDeviceSummary struct { // means that it has not updated its configuration. DeviceSettingsSyncState DeviceSettingsSyncState - // A name that you specify for the input device. - Name *string + // Settings that describe an input device that is type HD. + HdDeviceSettings *InputDeviceHdSettings // The unique ID of the input device. Id *string @@ -2326,23 +2332,17 @@ type InputDeviceSummary struct { // The network MAC address of the input device. MacAddress *string - // Settings that describe an input device that is type HD. - HdDeviceSettings *InputDeviceHdSettings - - // The state of the connection between the input device and AWS. - ConnectionState InputDeviceConnectionState - - // The unique ARN of the input device. - Arn *string + // A name that you specify for the input device. + Name *string // Network settings for the input device. NetworkSettings *InputDeviceNetworkSettings - // The type of the input device. - Type InputDeviceType - // The unique serial number of the input device. SerialNumber *string + + // The type of the input device. + Type InputDeviceType } // Input Location @@ -2365,16 +2365,9 @@ type InputLocation struct { // Input Loss Behavior type InputLossBehavior struct { - // Documentation update needed - RepeatFrameMsec *int32 - // Documentation update needed BlackFrameMsec *int32 - // Indicates whether to substitute a solid color or a slate into the output after - // input loss exceeds blackFrameMsec. - InputLossImageType InputLossImageType - // When input loss image type is "color" this field specifies the color to use. // Value: 6 hex characters representing the values of RGB. InputLossImageColor *string @@ -2382,11 +2375,23 @@ type InputLossBehavior struct { // When input loss image type is "slate" these fields specify the parameters for // accessing the slate. InputLossImageSlate *InputLocation + + // Indicates whether to substitute a solid color or a slate into the output after + // input loss exceeds blackFrameMsec. + InputLossImageType InputLossImageType + + // Documentation update needed + RepeatFrameMsec *int32 } // Action to prepare an input for a future immediate input switch. type InputPrepareScheduleActionSettings struct { + // The name of the input attachment that should be prepared by this action. If no + // name is provided, the action will stop the most recent prepare (if any) when + // activated. + InputAttachmentNameReference *string + // Settings to let you create a clip of the file input, in order to set up the // input to ingest only a portion of the file. InputClippingSettings *InputClippingSettings @@ -2396,39 +2401,50 @@ type InputPrepareScheduleActionSettings struct { // switch action, you can provide a different value, in order to connect the input // to a different content source. UrlPath []*string - - // The name of the input attachment that should be prepared by this action. If no - // name is provided, the action will stop the most recent prepare (if any) when - // activated. - InputAttachmentNameReference *string } // An Input Security Group type InputSecurityGroup struct { - // The Id of the Input Security Group - Id *string - - // Whitelist rules and their sync status - WhitelistRules []*InputWhitelistRule - // Unique ARN of Input Security Group Arn *string - // The current state of the Input Security Group. - State InputSecurityGroupState + // The Id of the Input Security Group + Id *string // The list of inputs currently using this Input Security Group. Inputs []*string + // The current state of the Input Security Group. + State InputSecurityGroupState + // A collection of key-value pairs. Tags map[string]*string + + // Whitelist rules and their sync status + WhitelistRules []*InputWhitelistRule } // Live Event input parameters. There can be multiple inputs in a single Live // Event. type InputSettings struct { + // Used to select the audio stream to decode for inputs that have multiple + // available. + AudioSelectors []*AudioSelector + + // Used to select the caption input to use for inputs that have multiple available. + CaptionSelectors []*CaptionSelector + + // Enable or disable the deblock filter when filtering. + DeblockFilter InputDeblockFilter + + // Enable or disable the denoise filter when filtering. + DenoiseFilter InputDenoiseFilter + + // Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest). + FilterStrength *int32 + // Turns on the filter for this input. MPEG-2 inputs have the deblocking filter // enabled by default. // @@ -2441,8 +2457,8 @@ type InputSettings struct { // forced - filtering will be applied regardless of input type InputFilter InputFilter - // Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest). - FilterStrength *int32 + // Input settings. + NetworkInputSettings *NetworkInputSettings // Specifies whether to extract applicable ancillary data from a SMPTE-2038 source // in this input. Applicable data types are captions, timecode, AFD, and SCTE-104 @@ -2455,55 +2471,39 @@ type InputSettings struct { // ancillary data from SMPTE-2038. Smpte2038DataPreference Smpte2038DataPreference - // Used to select the caption input to use for inputs that have multiple available. - CaptionSelectors []*CaptionSelector - - // Used to select the audio stream to decode for inputs that have multiple - // available. - AudioSelectors []*AudioSelector - - // Informs which video elementary stream to decode for input types that have - // multiple available. - VideoSelector *VideoSelector - // Loop input if it is a file. This allows a file input to be streamed // indefinitely. SourceEndBehavior InputSourceEndBehavior - // Enable or disable the deblock filter when filtering. - DeblockFilter InputDeblockFilter - - // Input settings. - NetworkInputSettings *NetworkInputSettings - - // Enable or disable the denoise filter when filtering. - DenoiseFilter InputDenoiseFilter + // Informs which video elementary stream to decode for input types that have + // multiple available. + VideoSelector *VideoSelector } // The settings for a PULL type input. type InputSource struct { + // The key used to extract the password from EC2 Parameter store. + PasswordParam *string + // This represents the customer's source URL where stream is pulled from. Url *string // The username for the input source. Username *string - - // The key used to extract the password from EC2 Parameter store. - PasswordParam *string } // Settings for for a PULL type input. type InputSourceRequest struct { + // The key used to extract the password from EC2 Parameter store. + PasswordParam *string + // This represents the customer's source URL where stream is pulled from. Url *string // The username for the input source. Username *string - - // The key used to extract the password from EC2 Parameter store. - PasswordParam *string } // Placeholder documentation for InputSpecification @@ -2512,11 +2512,11 @@ type InputSpecification struct { // Input codec Codec InputCodec - // Input resolution, categorized coarsely - Resolution InputResolution - // Maximum input bitrate, categorized coarsely MaximumBitrate InputMaximumBitrate + + // Input resolution, categorized coarsely + Resolution InputResolution } // Settings for the "switch input" action: to switch from ingesting one input to @@ -2529,15 +2529,15 @@ type InputSwitchScheduleActionSettings struct { // This member is required. InputAttachmentNameReference *string + // Settings to let you create a clip of the file input, in order to set up the + // input to ingest only a portion of the file. + InputClippingSettings *InputClippingSettings + // The value for the variable portion of the URL for the dynamic input, for this // instance of the input. Each time you use the same dynamic input in an input // switch action, you can provide a different value, in order to connect the input // to a different content source. UrlPath []*string - - // Settings to let you create a clip of the file input, in order to set up the - // input to ingest only a portion of the file. - InputClippingSettings *InputClippingSettings } // Settings for a private VPC Input. When this property is specified, the input @@ -2582,32 +2582,30 @@ type KeyProviderSettings struct { // M2ts Settings type M2tsSettings struct { - // Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be - // entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 - // (or 0x1ff6). - Scte35Pid *string - - // Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple - // values are accepted, and can be entered in ranges and/or by comma separation. - // Can be entered as decimal or hexadecimal values. Each PID specified must be in - // the range of 32 (or 0x20)..8182 (or 0x1ff6). - Scte27Pids *string - - // Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP - // markers will be placed on the video PID and all audio PIDs. If set to videoPid, - // EBP markers will be placed on only the video PID. - EbpPlacement M2tsEbpPlacement + // When set to drop, output audio streams will be removed from the program if the + // selected input audio stream is removed from the input. This allows the output + // audio configuration to dynamically change based on input configuration. If this + // is set to encodeSilence, all output audio streams will output encoded silence + // when not connected to an active input stream. + AbsentInputAudioBehavior M2tsAbsentInputAudioBehavior - // When set to enabled, generates captionServiceDescriptor in PMT. - CcDescriptor M2tsCcDescriptor + // When set to enabled, uses ARIB-compliant field muxing and removes video + // descriptor. + Arib M2tsArib - // Packet Identifier (PID) for input source ETV Signal data to this output. Can be + // Packet Identifier (PID) for ARIB Captions in the transport stream. Can be // entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 // (or 0x1ff6). - EtvSignalPid *string + AribCaptionsPid *string - // The value of the transport stream ID field in the Program Map Table. - TransportStreamId *int32 + // If set to auto, pid number used for ARIB Captions will be auto-selected from + // unused pids. If set to useConfigured, ARIB Captions will be on the configured + // pid number. + AribCaptionsPidControl M2tsAribCaptionsPidControl + + // When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to + // atsc, the ATSC model is used. + AudioBufferModel M2tsAudioBufferModel // The number of audio frames to insert for each PES packet. AudioFramesPerPes *int32 @@ -2618,91 +2616,55 @@ type M2tsSettings struct { // specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). AudioPids *string - // Packet Identifier (PID) for ARIB Captions in the transport stream. Can be - // entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 - // (or 0x1ff6). - AribCaptionsPid *string + // When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for + // EAC3. When set to dvb, uses stream type = 0x06. + AudioStreamType M2tsAudioStreamType // The output bitrate of the transport stream in bits per second. Setting to 0 lets // the muxer automatically determine the appropriate bitrate. Bitrate *int32 - // Packet Identifier (PID) of the elementary video stream in the transport stream. - // Can be entered as a decimal or hexadecimal value. Valid values are 32 (or - // 0x20)..8182 (or 0x1ff6). - VideoPid *string - - // Inserts segmentation markers at each segmentationTime period. raiSegstart sets - // the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI - // bit and adds the current timecode in the private data bytes. psiSegstart inserts - // PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point - // information to the adaptation field as per OpenCable specification - // OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the - // adaptation field using a legacy proprietary format. - SegmentationMarkers M2tsSegmentationMarkers - - // Packet Identifier (PID) for input source ETV Platform data to this output. Can - // be entered as a decimal or hexadecimal value. Valid values are 32 (or - // 0x20)..8182 (or 0x1ff6). - EtvPlatformPid *string - - // The length in seconds of each fragment. Only used with EBP markers. - FragmentTime *float64 - - // When set to drop, output audio streams will be removed from the program if the - // selected input audio stream is removed from the input. This allows the output - // audio configuration to dynamically change based on input configuration. If this - // is set to encodeSilence, all output audio streams will output encoded silence - // when not connected to an active input stream. - AbsentInputAudioBehavior M2tsAbsentInputAudioBehavior - - // The number of milliseconds between instances of this table in the output - // transport stream. Valid values are 0, 10..1000. - PatInterval *int32 - - // Maximum time in milliseconds between Program Clock Reference (PCRs) inserted - // into the transport stream. - PcrPeriod *int32 - - // Optionally pass SCTE-35 signals from the input source to this output. - Scte35Control M2tsScte35Control + // If set to multiplex, use multiplex buffer model for accurate interleaving. + // Setting to bufferModel to none can lead to lower latency, but low-memory devices + // may not be able to play back the stream without interruptions. + BufferModel M2tsBufferModel - // When set to passthrough, timed metadata will be passed through from input to - // output. - TimedMetadataBehavior M2tsTimedMetadataBehavior + // When set to enabled, generates captionServiceDescriptor in PMT. + CcDescriptor M2tsCcDescriptor // Inserts DVB Network Information Table (NIT) at the specified table repetition // interval. DvbNitSettings *DvbNitSettings - // The segmentation style parameter controls how segmentation markers are inserted - // into the transport stream. With avails, it is possible that segments may be - // truncated, which can influence where future segmentation markers are inserted. - // When a segmentation style of "resetCadence" is selected and a segment is - // truncated due to an avail, we will reset the segmentation cadence. This means - // the subsequent segment will have a duration of $segmentationTime seconds. When a - // segmentation style of "maintainCadence" is selected and a segment is truncated - // due to an avail, we will not reset the segmentation cadence. This means the - // subsequent segment will likely be truncated as well. However, all segments after - // that will have a duration of $segmentationTime seconds. Note that EBP lookahead - // is a slight exception to this rule. - SegmentationStyle M2tsSegmentationStyle + // Inserts DVB Service Description Table (SDT) at the specified table repetition + // interval. + DvbSdtSettings *DvbSdtSettings + + // Packet Identifier (PID) for input source DVB Subtitle data to this output. + // Multiple values are accepted, and can be entered in ranges and/or by comma + // separation. Can be entered as decimal or hexadecimal values. Each PID specified + // must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). + DvbSubPids *string // Inserts DVB Time and Date Table (TDT) at the specified table repetition // interval. DvbTdtSettings *DvbTdtSettings - // If set to auto, pid number used for ARIB Captions will be auto-selected from - // unused pids. If set to useConfigured, ARIB Captions will be on the configured - // pid number. - AribCaptionsPidControl M2tsAribCaptionsPidControl + // Packet Identifier (PID) for input source DVB Teletext data to this output. Can + // be entered as a decimal or hexadecimal value. Valid values are 32 (or + // 0x20)..8182 (or 0x1ff6). + DvbTeletextPid *string - // If set to passthrough, passes any KLV data from the input source to this output. - Klv M2tsKlv + // If set to passthrough, passes any EBIF data from the input source to this + // output. + Ebif M2tsEbifControl - // When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for - // EAC3. When set to dvb, uses stream type = 0x06. - AudioStreamType M2tsAudioStreamType + // When videoAndFixedIntervals is selected, audio EBP markers will be added to + // partitions 3 and 4. The interval between these additional markers will be fixed, + // and will be slightly shorter than the video EBP marker interval. Only available + // when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will + // always follow the video interval. + EbpAudioInterval M2tsAudioInterval // When set, enforces that Encoder Boundary Points do not come within the specified // time interval of each other by looking ahead at input video. If another EBP is @@ -2712,17 +2674,32 @@ type M2tsSettings struct { // to create sufficient latency to make the lookahead accurate. EbpLookaheadMs *int32 + // Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP + // markers will be placed on the video PID and all audio PIDs. If set to videoPid, + // EBP markers will be placed on only the video PID. + EbpPlacement M2tsEbpPlacement + + // This field is unused and deprecated. + EcmPid *string + // Include or exclude the ES Rate field in the PES header. EsRateInPes M2tsEsRateInPes - // If set to passthrough, Nielsen inaudible tones for media tracking will be - // detected in the input audio and an equivalent ID3 tag will be inserted in the - // output. - NielsenId3Behavior M2tsNielsenId3Behavior + // Packet Identifier (PID) for input source ETV Platform data to this output. Can + // be entered as a decimal or hexadecimal value. Valid values are 32 (or + // 0x20)..8182 (or 0x1ff6). + EtvPlatformPid *string - // When set to enabled, uses ARIB-compliant field muxing and removes video - // descriptor. - Arib M2tsArib + // Packet Identifier (PID) for input source ETV Signal data to this output. Can be + // entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 + // (or 0x1ff6). + EtvSignalPid *string + + // The length in seconds of each fragment. Only used with EBP markers. + FragmentTime *float64 + + // If set to passthrough, passes any KLV data from the input source to this output. + Klv M2tsKlv // Packet Identifier (PID) for input source KLV data to this output. Multiple // values are accepted, and can be entered in ranges and/or by comma separation. @@ -2730,40 +2707,28 @@ type M2tsSettings struct { // the range of 32 (or 0x20)..8182 (or 0x1ff6). KlvDataPids *string - // Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. - // Can be entered as a decimal or hexadecimal value. Valid values are 32 (or - // 0x20)..8182 (or 0x1ff6). - PmtPid *string + // If set to passthrough, Nielsen inaudible tones for media tracking will be + // detected in the input audio and an equivalent ID3 tag will be inserted in the + // output. + NielsenId3Behavior M2tsNielsenId3Behavior - // Packet Identifier (PID) for input source DVB Teletext data to this output. Can - // be entered as a decimal or hexadecimal value. Valid values are 32 (or - // 0x20)..8182 (or 0x1ff6). - DvbTeletextPid *string + // Value in bits per second of extra null packets to insert into the transport + // stream. This can be used if a downstream encryption system requires periodic + // null packets. + NullPacketBitrate *float64 - // The value of the program number field in the Program Map Table. - ProgramNum *int32 + // The number of milliseconds between instances of this table in the output + // transport stream. Valid values are 0, 10..1000. + PatInterval *int32 // When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for // every Packetized Elementary Stream (PES) header. This parameter is effective // only when the PCR PID is the same as the video or audio elementary stream. PcrControl M2tsPcrControl - // When vbr, does not insert null packets into transport stream to fill specified - // bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. - RateMode M2tsRateMode - - // Packet Identifier (PID) for input source DVB Subtitle data to this output. - // Multiple values are accepted, and can be entered in ranges and/or by comma - // separation. Can be entered as decimal or hexadecimal values. Each PID specified - // must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). - DvbSubPids *string - - // When videoAndFixedIntervals is selected, audio EBP markers will be added to - // partitions 3 and 4. The interval between these additional markers will be fixed, - // and will be slightly shorter than the video EBP marker interval. Only available - // when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will - // always follow the video interval. - EbpAudioInterval M2tsAudioInterval + // Maximum time in milliseconds between Program Clock Reference (PCRs) inserted + // into the transport stream. + PcrPeriod *int32 // Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport // stream. When no value is given, the encoder will assign the same value as the @@ -2775,110 +2740,145 @@ type M2tsSettings struct { // transport stream. Valid values are 0, 10..1000. PmtInterval *int32 - // The length in seconds of each segment. Required unless markers is set to none. - SegmentationTime *float64 - - // If set to multiplex, use multiplex buffer model for accurate interleaving. - // Setting to bufferModel to none can lead to lower latency, but low-memory devices - // may not be able to play back the stream without interruptions. - BufferModel M2tsBufferModel - - // Packet Identifier (PID) of the timed metadata stream in the transport stream. + // Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. // Can be entered as a decimal or hexadecimal value. Valid values are 32 (or // 0x20)..8182 (or 0x1ff6). - TimedMetadataPid *string - - // This field is unused and deprecated. - EcmPid *string - - // Value in bits per second of extra null packets to insert into the transport - // stream. This can be used if a downstream encryption system requires periodic - // null packets. - NullPacketBitrate *float64 + PmtPid *string - // Inserts DVB Service Description Table (SDT) at the specified table repetition - // interval. - DvbSdtSettings *DvbSdtSettings + // The value of the program number field in the Program Map Table. + ProgramNum *int32 - // If set to passthrough, passes any EBIF data from the input source to this - // output. - Ebif M2tsEbifControl + // When vbr, does not insert null packets into transport stream to fill specified + // bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. + RateMode M2tsRateMode - // When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to - // atsc, the ATSC model is used. - AudioBufferModel M2tsAudioBufferModel -} + // Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple + // values are accepted, and can be entered in ranges and/or by comma separation. + // Can be entered as decimal or hexadecimal values. Each PID specified must be in + // the range of 32 (or 0x20)..8182 (or 0x1ff6). + Scte27Pids *string -// Settings information for the .m3u8 container -type M3u8Settings struct { + // Optionally pass SCTE-35 signals from the input source to this output. + Scte35Control M2tsScte35Control // Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be - // entered as a decimal or hexadecimal value. + // entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 + // (or 0x1ff6). Scte35Pid *string - // When set to passthrough, timed metadata is passed through from input to output. - TimedMetadataBehavior M3u8TimedMetadataBehavior + // Inserts segmentation markers at each segmentationTime period. raiSegstart sets + // the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI + // bit and adds the current timecode in the private data bytes. psiSegstart inserts + // PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point + // information to the adaptation field as per OpenCable specification + // OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the + // adaptation field using a legacy proprietary format. + SegmentationMarkers M2tsSegmentationMarkers - // Packet Identifier (PID) of the elementary video stream in the transport stream. - // Can be entered as a decimal or hexadecimal value. - VideoPid *string + // The segmentation style parameter controls how segmentation markers are inserted + // into the transport stream. With avails, it is possible that segments may be + // truncated, which can influence where future segmentation markers are inserted. + // When a segmentation style of "resetCadence" is selected and a segment is + // truncated due to an avail, we will reset the segmentation cadence. This means + // the subsequent segment will have a duration of $segmentationTime seconds. When a + // segmentation style of "maintainCadence" is selected and a segment is truncated + // due to an avail, we will not reset the segmentation cadence. This means the + // subsequent segment will likely be truncated as well. However, all segments after + // that will have a duration of $segmentationTime seconds. Note that EBP lookahead + // is a slight exception to this rule. + SegmentationStyle M2tsSegmentationStyle + + // The length in seconds of each segment. Required unless markers is set to none. + SegmentationTime *float64 + + // When set to passthrough, timed metadata will be passed through from input to + // output. + TimedMetadataBehavior M2tsTimedMetadataBehavior // Packet Identifier (PID) of the timed metadata stream in the transport stream. // Can be entered as a decimal or hexadecimal value. Valid values are 32 (or // 0x20)..8182 (or 0x1ff6). TimedMetadataPid *string - // If set to passthrough, Nielsen inaudible tones for media tracking will be - // detected in the input audio and an equivalent ID3 tag will be inserted in the - // output. - NielsenId3Behavior M3u8NielsenId3Behavior + // The value of the transport stream ID field in the Program Map Table. + TransportStreamId *int32 - // Maximum time in milliseconds between Program Clock References (PCRs) inserted - // into the transport stream. - PcrPeriod *int32 + // Packet Identifier (PID) of the elementary video stream in the transport stream. + // Can be entered as a decimal or hexadecimal value. Valid values are 32 (or + // 0x20)..8182 (or 0x1ff6). + VideoPid *string +} - // The value of the program number field in the Program Map Table. - ProgramNum *int32 +// Settings information for the .m3u8 container +type M3u8Settings struct { + + // The number of audio frames to insert for each PES packet. + AudioFramesPerPes *int32 // Packet Identifier (PID) of the elementary audio stream(s) in the transport // stream. Multiple values are accepted, and can be entered in ranges and/or by // comma separation. Can be entered as decimal or hexadecimal values. AudioPids *string + // This parameter is unused and deprecated. + EcmPid *string + + // If set to passthrough, Nielsen inaudible tones for media tracking will be + // detected in the input audio and an equivalent ID3 tag will be inserted in the + // output. + NielsenId3Behavior M3u8NielsenId3Behavior + // The number of milliseconds between instances of this table in the output // transport stream. A value of "0" writes out the PMT once per segment file. PatInterval *int32 - // This parameter is unused and deprecated. - EcmPid *string - // When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for // every Packetized Elementary Stream (PES) header. This parameter is effective // only when the PCR PID is the same as the video or audio elementary stream. PcrControl M3u8PcrControl + // Maximum time in milliseconds between Program Clock References (PCRs) inserted + // into the transport stream. + PcrPeriod *int32 + + // Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport + // stream. When no value is given, the encoder will assign the same value as the + // Video PID. Can be entered as a decimal or hexadecimal value. + PcrPid *string + + // The number of milliseconds between instances of this table in the output + // transport stream. A value of "0" writes out the PMT once per segment file. + PmtInterval *int32 + // Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. // Can be entered as a decimal or hexadecimal value. PmtPid *string + // The value of the program number field in the Program Map Table. + ProgramNum *int32 + // If set to passthrough, passes any SCTE-35 signals from the input source to this // output. Scte35Behavior M3u8Scte35Behavior - // The value of the transport stream ID field in the Program Map Table. - TransportStreamId *int32 + // Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be + // entered as a decimal or hexadecimal value. + Scte35Pid *string - // The number of audio frames to insert for each PES packet. - AudioFramesPerPes *int32 + // When set to passthrough, timed metadata is passed through from input to output. + TimedMetadataBehavior M3u8TimedMetadataBehavior - // Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport - // stream. When no value is given, the encoder will assign the same value as the - // Video PID. Can be entered as a decimal or hexadecimal value. - PcrPid *string + // Packet Identifier (PID) of the timed metadata stream in the transport stream. + // Can be entered as a decimal or hexadecimal value. Valid values are 32 (or + // 0x20)..8182 (or 0x1ff6). + TimedMetadataPid *string - // The number of milliseconds between instances of this table in the output - // transport stream. A value of "0" writes out the PMT once per segment file. - PmtInterval *int32 + // The value of the transport stream ID field in the Program Map Table. + TransportStreamId *int32 + + // Packet Identifier (PID) of the elementary video stream in the transport stream. + // Can be entered as a decimal or hexadecimal value. + VideoPid *string } // The settings for a MediaConnect Flow. @@ -2922,66 +2922,48 @@ type MediaPackageOutputSettings struct { // Mp2 Settings type Mp2Settings struct { - // Sample rate in Hz. - SampleRate *float64 + // Average bitrate in bits/second. + Bitrate *float64 // The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or // codingMode20 (for stereo). CodingMode Mp2CodingMode - // Average bitrate in bits/second. - Bitrate *float64 + // Sample rate in Hz. + SampleRate *float64 } // Ms Smooth Group Settings type MsSmoothGroupSettings struct { - // Number of milliseconds to delay the output from the second pipeline. - SendDelayMs *int32 + // Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" + // encoder to IIS. + // + // This member is required. + Destination *OutputLocationRef - // MS Smooth event ID to be sent to the IIS server. Should only be specified if - // eventIdMode is set to useConfigured. - EventId *string + // The ID to include in each message in the sparse track. Ignored if + // sparseTrackType is NONE. + AcquisitionPointId *string - // Size in seconds of file cache for streaming outputs. - FilecacheDuration *int32 + // If set to passthrough for an audio-only MS Smooth output, the fragment absolute + // time will be set to the current timecode. This option does not write timecodes + // to the audio elementary stream. + AudioOnlyTimecodeControl SmoothGroupAudioOnlyTimecodeControl + + // If set to verifyAuthenticity, verify the https certificate chain to a trusted + // Certificate Authority (CA). This will cause https outputs to self-signed + // certificates to fail. + CertificateMode SmoothGroupCertificateMode // Number of seconds to wait before retrying connection to the IIS server if the // connection is lost. Content will be cached during this time and the cache will // be be delivered to the IIS server once the connection is re-established. ConnectionRetryInterval *int32 - // Number of seconds before initiating a restart due to output failure, due to - // exhausting the numRetries on one segment, or exceeding filecacheDuration. - RestartDelay *int32 - - // useInputSegmentation has been deprecated. The configured segment size is always - // used. - SegmentationMode SmoothGroupSegmentationMode - - // Parameter that control output group behavior on input loss. - InputLossAction InputLossActionForMsSmoothOut - - // Timestamp offset for the event. Only used if timestampOffsetMode is set to - // useConfiguredOffset. - TimestampOffset *string - - // When set to send, send stream manifest so publishing point doesn't start until - // all streams start. - StreamManifestBehavior SmoothGroupStreamManifestBehavior - - // Type of timestamp date offset to use. - // - // * useEventStartDate: Use the date the - // event was started as the offset - // - // * useConfiguredOffset: Use an explicitly - // configured date as the offset - TimestampOffsetMode SmoothGroupTimestampOffsetMode - - // Length of mp4 fragments to generate (in seconds). Fragment length must be - // compatible with GOP size and framerate. - FragmentLength *int32 + // MS Smooth event ID to be sent to the IIS server. Should only be specified if + // eventIdMode is set to useConfigured. + EventId *string // Specifies whether or not to send an event ID to the IIS server. If no event ID // is sent and the same Live Event is used without changing the publishing point, @@ -2997,20 +2979,33 @@ type MsSmoothGroupSettings struct { // - do not send an event ID to the IIS server. EventIdMode SmoothGroupEventIdMode - // If set to verifyAuthenticity, verify the https certificate chain to a trusted - // Certificate Authority (CA). This will cause https outputs to self-signed - // certificates to fail. - CertificateMode SmoothGroupCertificateMode + // When set to sendEos, send EOS signal to IIS server when stopping the event + EventStopBehavior SmoothGroupEventStopBehavior - // Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" - // encoder to IIS. - // - // This member is required. - Destination *OutputLocationRef + // Size in seconds of file cache for streaming outputs. + FilecacheDuration *int32 + + // Length of mp4 fragments to generate (in seconds). Fragment length must be + // compatible with GOP size and framerate. + FragmentLength *int32 + + // Parameter that control output group behavior on input loss. + InputLossAction InputLossActionForMsSmoothOut // Number of retry attempts. NumRetries *int32 + // Number of seconds before initiating a restart due to output failure, due to + // exhausting the numRetries on one segment, or exceeding filecacheDuration. + RestartDelay *int32 + + // useInputSegmentation has been deprecated. The configured segment size is always + // used. + SegmentationMode SmoothGroupSegmentationMode + + // Number of milliseconds to delay the output from the second pipeline. + SendDelayMs *int32 + // Identifies the type of data to place in the sparse track: // // * SCTE35: Insert @@ -3025,45 +3020,47 @@ type MsSmoothGroupSettings struct { // outputs in this output group. SparseTrackType SmoothGroupSparseTrackType - // When set to sendEos, send EOS signal to IIS server when stopping the event - EventStopBehavior SmoothGroupEventStopBehavior + // When set to send, send stream manifest so publishing point doesn't start until + // all streams start. + StreamManifestBehavior SmoothGroupStreamManifestBehavior - // If set to passthrough for an audio-only MS Smooth output, the fragment absolute - // time will be set to the current timecode. This option does not write timecodes - // to the audio elementary stream. - AudioOnlyTimecodeControl SmoothGroupAudioOnlyTimecodeControl + // Timestamp offset for the event. Only used if timestampOffsetMode is set to + // useConfiguredOffset. + TimestampOffset *string - // The ID to include in each message in the sparse track. Ignored if - // sparseTrackType is NONE. - AcquisitionPointId *string + // Type of timestamp date offset to use. + // + // * useEventStartDate: Use the date the + // event was started as the offset + // + // * useConfiguredOffset: Use an explicitly + // configured date as the offset + TimestampOffsetMode SmoothGroupTimestampOffsetMode } // Ms Smooth Output Settings type MsSmoothOutputSettings struct { - // String concatenated to the end of the destination filename. Required for - // multiple outputs of the same type. - NameModifier *string - // Only applicable when this output is referencing an H.265 video description. // Specifies whether MP4 segments should be packaged as HEV1 or HVC1. H265PackagingType MsSmoothH265PackagingType + + // String concatenated to the end of the destination filename. Required for + // multiple outputs of the same type. + NameModifier *string } // The multiplex object. type Multiplex struct { - // The number of currently healthy pipelines. - PipelinesRunningCount *int32 - - // The number of programs in the multiplex. - ProgramCount *int32 + // The unique arn of the multiplex. + Arn *string - // The name of the multiplex. - Name *string + // A list of availability zones for the multiplex. + AvailabilityZones []*string - // The current state of the multiplex. - State MultiplexState + // A list of the multiplex output destinations. + Destinations []*MultiplexOutputDestination // The unique id of the multiplex. Id *string @@ -3071,17 +3068,20 @@ type Multiplex struct { // Configuration for a multiplex event. MultiplexSettings *MultiplexSettings - // The unique arn of the multiplex. - Arn *string + // The name of the multiplex. + Name *string - // A list of availability zones for the multiplex. - AvailabilityZones []*string + // The number of currently healthy pipelines. + PipelinesRunningCount *int32 + + // The number of programs in the multiplex. + ProgramCount *int32 + + // The current state of the multiplex. + State MultiplexState // A collection of key-value pairs. Tags map[string]*string - - // A list of the multiplex output destinations. - Destinations []*MultiplexOutputDestination } // Multiplex Group Settings @@ -3114,9 +3114,6 @@ type MultiplexOutputSettings struct { // The multiplex program object. type MultiplexProgram struct { - // The name of the multiplex program. - ProgramName *string - // The MediaLive channel associated with the program. ChannelId *string @@ -3125,83 +3122,91 @@ type MultiplexProgram struct { // The packet identifier map for this multiplex program. PacketIdentifiersMap *MultiplexProgramPacketIdentifiersMap + + // The name of the multiplex program. + ProgramName *string } // Multiplex Program Input Destination Settings for outputting a Channel to a // Multiplex type MultiplexProgramChannelDestinationSettings struct { - // The program name of the Multiplex program that the encoder is providing output - // to. - ProgramName *string - // The ID of the Multiplex that the encoder is providing output to. You do not need // to specify the individual inputs to the Multiplex; MediaLive will handle the // connection of the two MediaLive pipelines to the two Multiplex instances. The // Multiplex must be in the same region as the Channel. MultiplexId *string + + // The program name of the Multiplex program that the encoder is providing output + // to. + ProgramName *string } // Packet identifiers map for a given Multiplex program. type MultiplexProgramPacketIdentifiersMap struct { - // Placeholder documentation for __integer - EtvPlatformPid *int32 - - // Placeholder documentation for __integer - TimedMetadataPid *int32 + // Placeholder documentation for __listOf__integer + AudioPids []*int32 // Placeholder documentation for __listOf__integer DvbSubPids []*int32 - // Placeholder documentation for __listOf__integer - Scte27Pids []*int32 + // Placeholder documentation for __integer + DvbTeletextPid *int32 // Placeholder documentation for __integer - PcrPid *int32 + EtvPlatformPid *int32 // Placeholder documentation for __integer EtvSignalPid *int32 // Placeholder documentation for __listOf__integer - AudioPids []*int32 + KlvDataPids []*int32 // Placeholder documentation for __integer - Scte35Pid *int32 + PcrPid *int32 + + // Placeholder documentation for __integer + PmtPid *int32 // Placeholder documentation for __integer PrivateMetadataPid *int32 + // Placeholder documentation for __listOf__integer + Scte27Pids []*int32 + // Placeholder documentation for __integer - PmtPid *int32 + Scte35Pid *int32 // Placeholder documentation for __integer - DvbTeletextPid *int32 + TimedMetadataPid *int32 // Placeholder documentation for __integer VideoPid *int32 - - // Placeholder documentation for __listOf__integer - KlvDataPids []*int32 } // Transport stream service descriptor configuration for the Multiplex program. type MultiplexProgramServiceDescriptor struct { - // Name of the service. + // Name of the provider. // // This member is required. - ServiceName *string + ProviderName *string - // Name of the provider. + // Name of the service. // // This member is required. - ProviderName *string + ServiceName *string } // Multiplex Program settings configuration. type MultiplexProgramSettings struct { + // Unique program number. + // + // This member is required. + ProgramNumber *int32 + // Indicates which pipeline is preferred by the multiplex for program ingest. PreferredChannelPipeline PreferredChannelPipeline @@ -3210,41 +3215,36 @@ type MultiplexProgramSettings struct { // Program video settings configuration. VideoSettings *MultiplexVideoSettings - - // Unique program number. - // - // This member is required. - ProgramNumber *int32 } // Placeholder documentation for MultiplexProgramSummary type MultiplexProgramSummary struct { - // The name of the multiplex program. - ProgramName *string - // The MediaLive Channel associated with the program. ChannelId *string + + // The name of the multiplex program. + ProgramName *string } // Contains configuration for a Multiplex event type MultiplexSettings struct { - // Transport stream reserved bit rate. - TransportStreamReservedBitrate *int32 - - // Transport stream ID. + // Transport stream bit rate. // // This member is required. - TransportStreamId *int32 + TransportStreamBitrate *int32 - // Transport stream bit rate. + // Transport stream ID. // // This member is required. - TransportStreamBitrate *int32 + TransportStreamId *int32 // Maximum video buffer delay in milliseconds. MaximumVideoBufferDelayMilliseconds *int32 + + // Transport stream reserved bit rate. + TransportStreamReservedBitrate *int32 } // Contains summary configuration for a Multiplex event. @@ -3267,44 +3267,44 @@ type MultiplexStatmuxVideoSettings struct { // Placeholder documentation for MultiplexSummary type MultiplexSummary struct { - // The current state of the multiplex. - State MultiplexState - - // The number of programs in the multiplex. - ProgramCount *int32 - // The unique arn of the multiplex. Arn *string + // A list of availability zones for the multiplex. + AvailabilityZones []*string + + // The unique id of the multiplex. + Id *string + // Configuration for a multiplex event. MultiplexSettings *MultiplexSettingsSummary + // The name of the multiplex. + Name *string + // The number of currently healthy pipelines. PipelinesRunningCount *int32 - // The unique id of the multiplex. - Id *string + // The number of programs in the multiplex. + ProgramCount *int32 + + // The current state of the multiplex. + State MultiplexState // A collection of key-value pairs. Tags map[string]*string - - // A list of availability zones for the multiplex. - AvailabilityZones []*string - - // The name of the multiplex. - Name *string } // The video configuration for each program in a multiplex. type MultiplexVideoSettings struct { - // Statmux rate control settings. When this field is defined, ConstantBitrate must - // be undefined. - StatmuxSettings *MultiplexStatmuxVideoSettings - // The constant bitrate configuration for the video encode. When this field is // defined, StatmuxSettings must be undefined. ConstantBitrate *int32 + + // Statmux rate control settings. When this field is defined, ConstantBitrate must + // be undefined. + StatmuxSettings *MultiplexStatmuxVideoSettings } // Network source to transcode. Must be accessible to the Elemental Live node that @@ -3335,45 +3335,50 @@ type NielsenConfiguration struct { // Reserved resources available for purchase type Offering struct { - // One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering - FixedPrice *float64 - - // AWS region, e.g. 'us-west-2' - Region *string - // Unique offering ARN, e.g. // 'arn:aws:medialive:us-west-2:123456789012:offering:87654321' Arn *string - // Units for duration, e.g. 'MONTHS' - DurationUnits OfferingDurationUnits - // Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD' CurrencyCode *string - // Unique offering ID, e.g. '87654321' - OfferingId *string + // Lease duration, e.g. '12' + Duration *int32 - // Offering type, e.g. 'NO_UPFRONT' - OfferingType OfferingType + // Units for duration, e.g. 'MONTHS' + DurationUnits OfferingDurationUnits + + // One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering + FixedPrice *float64 // Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ // in US West (Oregon)' OfferingDescription *string - // Recurring usage charge for each reserved resource, e.g. '157.0' - UsagePrice *float64 + // Unique offering ID, e.g. '87654321' + OfferingId *string - // Lease duration, e.g. '12' - Duration *int32 + // Offering type, e.g. 'NO_UPFRONT' + OfferingType OfferingType + + // AWS region, e.g. 'us-west-2' + Region *string // Resource configuration details ResourceSpecification *ReservationResourceSpecification + + // Recurring usage charge for each reserved resource, e.g. '157.0' + UsagePrice *float64 } // Output settings. There can be multiple outputs within a group. type Output struct { + // Output type-specific settings. + // + // This member is required. + OutputSettings *OutputSettings + // The names of the AudioDescriptions used as audio sources for this output. AudioDescriptionNames []*string @@ -3385,11 +3390,6 @@ type Output struct { // The name of the VideoDescription used as the source for this output. VideoDescriptionName *string - - // Output type-specific settings. - // - // This member is required. - OutputSettings *OutputSettings } // Placeholder documentation for OutputDestination @@ -3398,13 +3398,13 @@ type OutputDestination struct { // User-specified id. This is used in an output group or an output. Id *string - // Destination settings for a Multiplex output; one destination for both encoders. - MultiplexSettings *MultiplexProgramChannelDestinationSettings - // Destination settings for a MediaPackage output; one destination for both // encoders. MediaPackageSettings []*MediaPackageOutputDestinationSettings + // Destination settings for a Multiplex output; one destination for both encoders. + MultiplexSettings *MultiplexProgramChannelDestinationSettings + // Destination settings for a standard output; one destination for each redundant // encoder. Settings []*OutputDestinationSettings @@ -3413,14 +3413,14 @@ type OutputDestination struct { // Placeholder documentation for OutputDestinationSettings type OutputDestinationSettings struct { - // A URL specifying a destination - Url *string + // key used to extract the password from EC2 Parameter store + PasswordParam *string // Stream name for RTMP destinations (URLs of type rtmp://) StreamName *string - // key used to extract the password from EC2 Parameter store - PasswordParam *string + // A URL specifying a destination + Url *string // username for destination Username *string @@ -3430,10 +3430,6 @@ type OutputDestinationSettings struct { // streams should be distributed. type OutputGroup struct { - // Custom output group name optionally defined by the user. Only letters, numbers, - // and the underscore character allowed; only 32 characters allowed. - Name *string - // Settings associated with the output group. // // This member is required. @@ -3443,31 +3439,35 @@ type OutputGroup struct { // // This member is required. Outputs []*Output + + // Custom output group name optionally defined by the user. Only letters, numbers, + // and the underscore character allowed; only 32 characters allowed. + Name *string } // Output Group Settings type OutputGroupSettings struct { - // Rtmp Group Settings - RtmpGroupSettings *RtmpGroupSettings + // Archive Group Settings + ArchiveGroupSettings *ArchiveGroupSettings // Frame Capture Group Settings FrameCaptureGroupSettings *FrameCaptureGroupSettings - // Multiplex Group Settings - MultiplexGroupSettings *MultiplexGroupSettings - - // Archive Group Settings - ArchiveGroupSettings *ArchiveGroupSettings - // Hls Group Settings HlsGroupSettings *HlsGroupSettings + // Media Package Group Settings + MediaPackageGroupSettings *MediaPackageGroupSettings + // Ms Smooth Group Settings MsSmoothGroupSettings *MsSmoothGroupSettings - // Media Package Group Settings - MediaPackageGroupSettings *MediaPackageGroupSettings + // Multiplex Group Settings + MultiplexGroupSettings *MultiplexGroupSettings + + // Rtmp Group Settings + RtmpGroupSettings *RtmpGroupSettings // Udp Group Settings UdpGroupSettings *UdpGroupSettings @@ -3483,15 +3483,6 @@ type OutputLocationRef struct { // Output Settings type OutputSettings struct { - // Media Package Output Settings - MediaPackageOutputSettings *MediaPackageOutputSettings - - // Multiplex Output Settings - MultiplexOutputSettings *MultiplexOutputSettings - - // Ms Smooth Output Settings - MsSmoothOutputSettings *MsSmoothOutputSettings - // Archive Output Settings ArchiveOutputSettings *ArchiveOutputSettings @@ -3501,6 +3492,15 @@ type OutputSettings struct { // Hls Output Settings HlsOutputSettings *HlsOutputSettings + // Media Package Output Settings + MediaPackageOutputSettings *MediaPackageOutputSettings + + // Ms Smooth Output Settings + MsSmoothOutputSettings *MsSmoothOutputSettings + + // Multiplex Output Settings + MultiplexOutputSettings *MultiplexOutputSettings + // Rtmp Output Settings RtmpOutputSettings *RtmpOutputSettings @@ -3554,9 +3554,6 @@ type Rec709Settings struct { // Remix Settings type RemixSettings struct { - // Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8 - ChannelsOut *int32 - // Mapping of input channels to output channels, with appropriate gain adjustments. // // This member is required. @@ -3564,93 +3561,96 @@ type RemixSettings struct { // Number of input channels to be used. ChannelsIn *int32 + + // Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8 + ChannelsOut *int32 } // Reserved resources available to use type Reservation struct { - // One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering - FixedPrice *float64 - - // Offering type, e.g. 'NO_UPFRONT' - OfferingType OfferingType - - // Current state of reservation, e.g. 'ACTIVE' - State ReservationState + // Unique reservation ARN, e.g. + // 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567' + Arn *string - // Units for duration, e.g. 'MONTHS' - DurationUnits OfferingDurationUnits + // Number of reserved resources + Count *int32 // Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD' CurrencyCode *string - // AWS region, e.g. 'us-west-2' - Region *string - - // Unique offering ID, e.g. '87654321' - OfferingId *string - - // A collection of key-value pairs - Tags map[string]*string - - // Recurring usage charge for each reserved resource, e.g. '157.0' - UsagePrice *float64 - - // Unique reservation ARN, e.g. - // 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567' - Arn *string + // Lease duration, e.g. '12' + Duration *int32 - // Reservation UTC start date and time in ISO-8601 format, e.g. - // '2018-03-01T00:00:00' - Start *string + // Units for duration, e.g. 'MONTHS' + DurationUnits OfferingDurationUnits // Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00' End *string - // Lease duration, e.g. '12' - Duration *int32 + // One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering + FixedPrice *float64 - // Unique reservation ID, e.g. '1234567' - ReservationId *string + // User specified reservation name + Name *string // Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ // in US West (Oregon)' OfferingDescription *string - // User specified reservation name - Name *string + // Unique offering ID, e.g. '87654321' + OfferingId *string + + // Offering type, e.g. 'NO_UPFRONT' + OfferingType OfferingType + + // AWS region, e.g. 'us-west-2' + Region *string + + // Unique reservation ID, e.g. '1234567' + ReservationId *string // Resource configuration details ResourceSpecification *ReservationResourceSpecification - // Number of reserved resources - Count *int32 + // Reservation UTC start date and time in ISO-8601 format, e.g. + // '2018-03-01T00:00:00' + Start *string + + // Current state of reservation, e.g. 'ACTIVE' + State ReservationState + + // A collection of key-value pairs + Tags map[string]*string + + // Recurring usage charge for each reserved resource, e.g. '157.0' + UsagePrice *float64 } // Resource configuration (codec, resolution, bitrate, ...) type ReservationResourceSpecification struct { - // Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only) - MaximumFramerate ReservationMaximumFramerate - - // Resolution, e.g. 'HD' - Resolution ReservationResolution + // Channel class, e.g. 'STANDARD' + ChannelClass ChannelClass // Codec, e.g. 'AVC' Codec ReservationCodec - // Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only) - SpecialFeature ReservationSpecialFeature - // Maximum bitrate, e.g. 'MAX_20_MBPS' MaximumBitrate ReservationMaximumBitrate - // Channel class, e.g. 'STANDARD' - ChannelClass ChannelClass + // Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only) + MaximumFramerate ReservationMaximumFramerate + + // Resolution, e.g. 'HD' + Resolution ReservationResolution // Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL' ResourceType ReservationResourceType + // Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only) + SpecialFeature ReservationSpecialFeature + // Video quality, e.g. 'STANDARD' (Outputs only) VideoQuality ReservationVideoQuality } @@ -3662,6 +3662,9 @@ type RtmpCaptionInfoDestinationSettings struct { // Rtmp Group Settings type RtmpGroupSettings struct { + // Authentication scheme to use when connecting with CDN + AuthenticationScheme AuthenticationScheme + // Controls behavior when content cache fills up. If remote origin server stalls // the RTMP connection and does not accept content fast enough the 'Media Cache' // will fill up. When the cache reaches the duration specified by cacheLength the @@ -3671,6 +3674,9 @@ type RtmpGroupSettings struct { // minutes to allow the origin server to begin accepting data again. CacheFullBehavior RtmpCacheFullBehavior + // Cache length, in seconds, is used to calculate buffer size. + CacheLength *int32 + // Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' // then 608 and 708 carried DTVCC data will be passed. If set to // 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from @@ -3678,13 +3684,6 @@ type RtmpGroupSettings struct { // 608 from field 1 video will be passed. CaptionData RtmpCaptionData - // If a streaming output fails, number of seconds to wait until a restart is - // initiated. A value of 0 means never restart. - RestartDelay *int32 - - // Cache length, in seconds, is used to calculate buffer size. - CacheLength *int32 - // Controls the behavior of this RTMP group if input becomes unavailable. // // * @@ -3695,15 +3694,20 @@ type RtmpGroupSettings struct { // connection. InputLossAction InputLossActionForRtmpOut - // Authentication scheme to use when connecting with CDN - AuthenticationScheme AuthenticationScheme + // If a streaming output fails, number of seconds to wait until a restart is + // initiated. A value of 0 means never restart. + RestartDelay *int32 } // Rtmp Output Settings type RtmpOutputSettings struct { - // Number of retry attempts. - NumRetries *int32 + // The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For + // connection to Akamai, a username and password must be supplied. URI fields + // accept format identifiers. + // + // This member is required. + Destination *OutputLocationRef // If set to verifyAuthenticity, verify the tls certificate chain to a trusted // Certificate Authority (CA). This will cause rtmps outputs with self-signed @@ -3714,83 +3718,79 @@ type RtmpOutputSettings struct { // if the connection is lost. ConnectionRetryInterval *int32 - // The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For - // connection to Akamai, a username and password must be supplied. URI fields - // accept format identifiers. - // - // This member is required. - Destination *OutputLocationRef + // Number of retry attempts. + NumRetries *int32 } // Contains information on a single schedule action. type ScheduleAction struct { - // The time for the action to start in the channel. + // The name of the action, must be unique within the schedule. This name provides + // the main reference to an action once it is added to the schedule. A name is + // unique if it is no longer in the schedule. The schedule is automatically cleaned + // up to remove actions with a start time of more than 1 hour ago (approximately) + // so at that point a name can be reused. // // This member is required. - ScheduleActionStartSettings *ScheduleActionStartSettings + ActionName *string // Settings for this schedule action. // // This member is required. ScheduleActionSettings *ScheduleActionSettings - // The name of the action, must be unique within the schedule. This name provides - // the main reference to an action once it is added to the schedule. A name is - // unique if it is no longer in the schedule. The schedule is automatically cleaned - // up to remove actions with a start time of more than 1 hour ago (approximately) - // so at that point a name can be reused. + // The time for the action to start in the channel. // // This member is required. - ActionName *string + ScheduleActionStartSettings *ScheduleActionStartSettings } -// Holds the settings for a single schedule action. -type ScheduleActionSettings struct { +// Holds the settings for a single schedule action. +type ScheduleActionSettings struct { + + // Action to insert HLS ID3 segment tagging + HlsId3SegmentTaggingSettings *HlsId3SegmentTaggingScheduleActionSettings + + // Action to insert HLS metadata + HlsTimedMetadataSettings *HlsTimedMetadataScheduleActionSettings + + // Action to prepare an input for a future immediate input switch + InputPrepareSettings *InputPrepareScheduleActionSettings + + // Action to switch the input + InputSwitchSettings *InputSwitchScheduleActionSettings // Action to pause or unpause one or both channel pipelines PauseStateSettings *PauseStateScheduleActionSettings + // Action to insert SCTE-35 return_to_network message + Scte35ReturnToNetworkSettings *Scte35ReturnToNetworkScheduleActionSettings + // Action to insert SCTE-35 splice_insert message Scte35SpliceInsertSettings *Scte35SpliceInsertScheduleActionSettings - // Action to switch the input - InputSwitchSettings *InputSwitchScheduleActionSettings - - // Action to deactivate a static image overlay - StaticImageDeactivateSettings *StaticImageDeactivateScheduleActionSettings - // Action to insert SCTE-35 time_signal message Scte35TimeSignalSettings *Scte35TimeSignalScheduleActionSettings - // Action to insert HLS metadata - HlsTimedMetadataSettings *HlsTimedMetadataScheduleActionSettings - - // Action to insert HLS ID3 segment tagging - HlsId3SegmentTaggingSettings *HlsId3SegmentTaggingScheduleActionSettings - - // Action to insert SCTE-35 return_to_network message - Scte35ReturnToNetworkSettings *Scte35ReturnToNetworkScheduleActionSettings - // Action to activate a static image overlay StaticImageActivateSettings *StaticImageActivateScheduleActionSettings - // Action to prepare an input for a future immediate input switch - InputPrepareSettings *InputPrepareScheduleActionSettings + // Action to deactivate a static image overlay + StaticImageDeactivateSettings *StaticImageDeactivateScheduleActionSettings } // Settings to specify when an action should occur. Only one of the options must be // selected. type ScheduleActionStartSettings struct { - // Option for specifying an action that should be applied immediately. - ImmediateModeScheduleActionStartSettings *ImmediateModeScheduleActionStartSettings + // Option for specifying the start time for an action. + FixedModeScheduleActionStartSettings *FixedModeScheduleActionStartSettings // Option for specifying an action as relative to another action. FollowModeScheduleActionStartSettings *FollowModeScheduleActionStartSettings - // Option for specifying the start time for an action. - FixedModeScheduleActionStartSettings *FixedModeScheduleActionStartSettings + // Option for specifying an action that should be applied immediately. + ImmediateModeScheduleActionStartSettings *ImmediateModeScheduleActionStartSettings } // Scte20 Plus Embedded Destination Settings @@ -3840,25 +3840,25 @@ type Scte27SourceSettings struct { // declare that there are no restrictions, omit this element. type Scte35DeliveryRestrictions struct { - // Corresponds to SCTE-35 no_regional_blackout_flag parameter. + // Corresponds to SCTE-35 archive_allowed_flag. // // This member is required. - NoRegionalBlackoutFlag Scte35NoRegionalBlackoutFlag + ArchiveAllowedFlag Scte35ArchiveAllowedFlag - // Corresponds to SCTE-35 web_delivery_allowed_flag parameter. + // Corresponds to SCTE-35 device_restrictions parameter. // // This member is required. - WebDeliveryAllowedFlag Scte35WebDeliveryAllowedFlag + DeviceRestrictions Scte35DeviceRestrictions - // Corresponds to SCTE-35 archive_allowed_flag. + // Corresponds to SCTE-35 no_regional_blackout_flag parameter. // // This member is required. - ArchiveAllowedFlag Scte35ArchiveAllowedFlag + NoRegionalBlackoutFlag Scte35NoRegionalBlackoutFlag - // Corresponds to SCTE-35 device_restrictions parameter. + // Corresponds to SCTE-35 web_delivery_allowed_flag parameter. // // This member is required. - DeviceRestrictions Scte35DeviceRestrictions + WebDeliveryAllowedFlag Scte35WebDeliveryAllowedFlag } // Holds one set of SCTE-35 Descriptor Settings. @@ -3891,12 +3891,28 @@ type Scte35ReturnToNetworkScheduleActionSettings struct { // Corresponds to SCTE-35 segmentation_descriptor. type Scte35SegmentationDescriptor struct { + // Corresponds to SCTE-35 segmentation_event_cancel_indicator. + // + // This member is required. + SegmentationCancelIndicator Scte35SegmentationCancelIndicator + + // Corresponds to SCTE-35 segmentation_event_id. + // + // This member is required. + SegmentationEventId *int64 + + // Holds the four SCTE-35 delivery restriction parameters. + DeliveryRestrictions *Scte35DeliveryRestrictions + // Corresponds to SCTE-35 segment_num. A value that is valid for the specified // segmentation_type_id. SegmentNum *int32 - // Holds the four SCTE-35 delivery restriction parameters. - DeliveryRestrictions *Scte35DeliveryRestrictions + // Corresponds to SCTE-35 segmentation_duration. Optional. The duration for the + // time_signal, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds + // by 90,000. Enter time in 90 KHz clock ticks. If you do not enter a duration, the + // time_signal will continue until you insert a cancellation message. + SegmentationDuration *int64 // Corresponds to SCTE-35 segmentation_type_id. One of the segmentation_type_id // values listed in the SCTE-35 specification. On the console, enter the ID in @@ -3904,9 +3920,12 @@ type Scte35SegmentationDescriptor struct { // (for example, "0x34") or decimal (for example, "52"). SegmentationTypeId *int32 - // Corresponds to SCTE-35 sub_segments_expected. A value that is valid for the - // specified segmentation_type_id. - SubSegmentsExpected *int32 + // Corresponds to SCTE-35 segmentation_upid. Enter a string containing the + // hexadecimal representation of the characters that make up the SCTE-35 + // segmentation_upid value. Must contain an even number of hex characters. Do not + // include spaces between each hex pair. For example, the ASCII "ADS Information" + // becomes hex "41445320496e666f726d6174696f6e. + SegmentationUpid *string // Corresponds to SCTE-35 segmentation_upid_type. On the console, enter one of the // types listed in the SCTE-35 specification, converted to a decimal. For example, @@ -3923,42 +3942,23 @@ type Scte35SegmentationDescriptor struct { // segmentation_type_id. SubSegmentNum *int32 - // Corresponds to SCTE-35 segmentation_event_cancel_indicator. - // - // This member is required. - SegmentationCancelIndicator Scte35SegmentationCancelIndicator - - // Corresponds to SCTE-35 segmentation_upid. Enter a string containing the - // hexadecimal representation of the characters that make up the SCTE-35 - // segmentation_upid value. Must contain an even number of hex characters. Do not - // include spaces between each hex pair. For example, the ASCII "ADS Information" - // becomes hex "41445320496e666f726d6174696f6e. - SegmentationUpid *string - - // Corresponds to SCTE-35 segmentation_event_id. - // - // This member is required. - SegmentationEventId *int64 - - // Corresponds to SCTE-35 segmentation_duration. Optional. The duration for the - // time_signal, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds - // by 90,000. Enter time in 90 KHz clock ticks. If you do not enter a duration, the - // time_signal will continue until you insert a cancellation message. - SegmentationDuration *int64 + // Corresponds to SCTE-35 sub_segments_expected. A value that is valid for the + // specified segmentation_type_id. + SubSegmentsExpected *int32 } // Scte35 Splice Insert type Scte35SpliceInsert struct { - // When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 - // will no longer trigger blackouts or Ad Avail slates - NoRegionalBlackoutFlag Scte35SpliceInsertNoRegionalBlackoutBehavior - // When specified, this offset (in milliseconds) is added to the input Ad Avail PTS // time. This only applies to embedded SCTE 104/35 messages and does not apply to // OOB messages. AdAvailOffset *int32 + // When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 + // will no longer trigger blackouts or Ad Avail slates + NoRegionalBlackoutFlag Scte35SpliceInsertNoRegionalBlackoutBehavior + // When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 // will no longer trigger blackouts or Ad Avail slates WebDeliveryAllowedFlag Scte35SpliceInsertWebDeliveryAllowedBehavior @@ -3967,6 +3967,11 @@ type Scte35SpliceInsert struct { // Settings for a SCTE-35 splice_insert message. type Scte35SpliceInsertScheduleActionSettings struct { + // The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35. + // + // This member is required. + SpliceEventId *int64 + // Optional, the duration for the splice_insert, in 90 KHz ticks. To convert // seconds to ticks, multiple the seconds by 90,000. If you enter a duration, there // is an expectation that the downstream system can read the duration and cue in at @@ -3974,28 +3979,23 @@ type Scte35SpliceInsertScheduleActionSettings struct { // indefinitely and there is an expectation that you will enter a return_to_network // to end the splice_insert at the appropriate time. Duration *int64 - - // The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35. - // - // This member is required. - SpliceEventId *int64 } // Scte35 Time Signal Apos type Scte35TimeSignalApos struct { - // When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 - // will no longer trigger blackouts or Ad Avail slates - WebDeliveryAllowedFlag Scte35AposWebDeliveryAllowedBehavior + // When specified, this offset (in milliseconds) is added to the input Ad Avail PTS + // time. This only applies to embedded SCTE 104/35 messages and does not apply to + // OOB messages. + AdAvailOffset *int32 // When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 // will no longer trigger blackouts or Ad Avail slates NoRegionalBlackoutFlag Scte35AposNoRegionalBlackoutBehavior - // When specified, this offset (in milliseconds) is added to the input Ad Avail PTS - // time. This only applies to embedded SCTE 104/35 messages and does not apply to - // OOB messages. - AdAvailOffset *int32 + // When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 + // will no longer trigger blackouts or Ad Avail slates + WebDeliveryAllowedFlag Scte35AposWebDeliveryAllowedBehavior } // Settings for a SCTE-35 time_signal. @@ -4014,14 +4014,14 @@ type SmpteTtDestinationSettings struct { // Standard Hls Settings type StandardHlsSettings struct { - // List all the audio groups that are used with the video output stream. Input all - // the audio GROUP-IDs that are associated to the video, separate by ','. - AudioRenditionSets *string - // Settings information for the .m3u8 container // // This member is required. M3u8Settings *M3u8Settings + + // List all the audio groups that are used with the video output stream. Input all + // the audio GROUP-IDs that are associated to the video, separate by ','. + AudioRenditionSets *string } // Settings to identify the start of the clip. @@ -4036,13 +4036,22 @@ type StartTimecode struct { // Settings for the action to activate a static image. type StaticImageActivateScheduleActionSettings struct { + // The location and filename of the image file to overlay on the video. The file + // must be a 32-bit BMP, PNG, or TGA file, and must not be larger (in pixels) than + // the input video. + // + // This member is required. + Image *InputLocation + + // The duration in milliseconds for the image to remain on the video. If omitted or + // set to 0 the duration is unlimited and the image will remain until it is + // explicitly deactivated. + Duration *int32 + // The time in milliseconds for the image to fade in. The fade-in starts at the // start time of the overlay. Default is 0 (no fade-in). FadeIn *int32 - // Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100. - Opacity *int32 - // Applies only if a duration is specified. The time in milliseconds for the image // to fade out. The fade-out starts when the duration time is hit, so it // effectively extends the duration. Default is 0 (no fade-out). @@ -4053,35 +4062,26 @@ type StaticImageActivateScheduleActionSettings struct { // height of the overlay. Height *int32 - // Placement of the top edge of the overlay relative to the top edge of the video - // frame, in pixels. 0 (the default) is the top edge of the frame. If the placement - // causes the overlay to extend beyond the bottom edge of the underlying video, - // then the overlay is cropped on the bottom. - ImageY *int32 - // Placement of the left edge of the overlay relative to the left edge of the video // frame, in pixels. 0 (the default) is the left edge of the frame. If the // placement causes the overlay to extend beyond the right edge of the underlying // video, then the overlay is cropped on the right. ImageX *int32 + // Placement of the top edge of the overlay relative to the top edge of the video + // frame, in pixels. 0 (the default) is the top edge of the frame. If the placement + // causes the overlay to extend beyond the bottom edge of the underlying video, + // then the overlay is cropped on the bottom. + ImageY *int32 + // The number of the layer, 0 to 7. There are 8 layers that can be overlaid on the // video, each layer with a different image. The layers are in Z order, which means // that overlays with higher values of layer are inserted on top of overlays with // lower values of layer. Default is 0. Layer *int32 - // The duration in milliseconds for the image to remain on the video. If omitted or - // set to 0 the duration is unlimited and the image will remain until it is - // explicitly deactivated. - Duration *int32 - - // The location and filename of the image file to overlay on the video. The file - // must be a 32-bit BMP, PNG, or TGA file, and must not be larger (in pixels) than - // the input video. - // - // This member is required. - Image *InputLocation + // Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100. + Opacity *int32 // The width of the image when inserted into the video, in pixels. The overlay will // be scaled up or down to the specified width. Leave blank to use the native width @@ -4092,11 +4092,11 @@ type StaticImageActivateScheduleActionSettings struct { // Settings for the action to deactivate the image in a specific layer. type StaticImageDeactivateScheduleActionSettings struct { - // The image overlay layer to deactivate, 0 to 7. Default is 0. - Layer *int32 - // The time in milliseconds for the image to fade out. Default is 0 (no fade-out). FadeOut *int32 + + // The image overlay layer to deactivate, 0 to 7. Default is 0. + Layer *int32 } // Static Key Settings @@ -4159,12 +4159,6 @@ type TemporalFilterSettings struct { // Timecode Config type TimecodeConfig struct { - // Threshold in frames beyond which output timecode is resynchronized to the input - // timecode. Discrepancies below this threshold are permitted to avoid unnecessary - // discontinuities in the output timecode. No timecode sync when this is not - // specified. - SyncThreshold *int32 - // Identifies the source for the timecode that will be associated with the events // outputs. -Embedded (embedded): Initialize the output timecode with timecode from // the the source. If no embedded timecode is detected in the source, the system @@ -4174,6 +4168,12 @@ type TimecodeConfig struct { // // This member is required. Source TimecodeConfigSource + + // Threshold in frames beyond which output timecode is resynchronized to the input + // timecode. Discrepancies below this threshold are permitted to avoid unnecessary + // discontinuities in the output timecode. No timecode sync when this is not + // specified. + SyncThreshold *int32 } // Ttml Destination Settings @@ -4214,16 +4214,16 @@ type UdpGroupSettings struct { // Udp Output Settings type UdpOutputSettings struct { - // Destination address and port number for RTP or UDP packets. Can be unicast or - // multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002). + // Udp Container Settings // // This member is required. - Destination *OutputLocationRef + ContainerSettings *UdpContainerSettings - // Udp Container Settings + // Destination address and port number for RTP or UDP packets. Can be unicast or + // multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002). // // This member is required. - ContainerSettings *UdpContainerSettings + Destination *OutputLocationRef // UDP output buffering in milliseconds. Larger values increase latency through the // transcoder but simultaneously assist the transcoder in maintaining a constant, @@ -4251,28 +4251,32 @@ type VideoCodecSettings struct { // Frame Capture Settings FrameCaptureSettings *FrameCaptureSettings - // H265 Settings - H265Settings *H265Settings - // H264 Settings H264Settings *H264Settings + + // H265 Settings + H265Settings *H265Settings } // Video settings for this stream. type VideoDescription struct { + // The name of this VideoDescription. Outputs will use this name to uniquely + // identify this Description. Description names should be unique within this Live + // Event. + // + // This member is required. + Name *string + + // Video codec settings. + CodecSettings *VideoCodecSettings + // Output video height, in pixels. Must be an even number. For most codecs, you can // leave this field and width blank in order to use the height and width // (resolution) from the source. Note, however, that leaving blank is not // recommended. For the Frame Capture codec, height and width are required. Height *int32 - // Output video width, in pixels. Must be an even number. For most codecs, you can - // leave this field and height blank in order to use the height and width - // (resolution) from the source. Note, however, that leaving blank is not - // recommended. For the Frame Capture codec, height and width are required. - Width *int32 - // Indicates how to respond to the AFD values in the input stream. RESPOND causes // input video to be clipped, depending on the AFD value, input display aspect // ratio, and output display aspect ratio, and (except for FRAME_CAPTURE codec) @@ -4288,19 +4292,15 @@ type VideoDescription struct { // around the video to provide the specified output resolution. ScalingBehavior VideoDescriptionScalingBehavior - // The name of this VideoDescription. Outputs will use this name to uniquely - // identify this Description. Description names should be unique within this Live - // Event. - // - // This member is required. - Name *string - // Changes the strength of the anti-alias filter used for scaling. 0 is the softest // setting, 100 is the sharpest. A setting of 50 is recommended for most content. Sharpness *int32 - // Video codec settings. - CodecSettings *VideoCodecSettings + // Output video width, in pixels. Must be an even number. For most codecs, you can + // leave this field and height blank in order to use the height and width + // (resolution) from the source. Note, however, that leaving blank is not + // recommended. For the Frame Capture codec, height and width are required. + Width *int32 } // Specifies a particular video stream within an input source. An input may have @@ -4312,9 +4312,6 @@ type VideoSelector struct { // if any conversion will be performed. ColorSpace VideoSelectorColorSpace - // The video selector settings. - SelectorSettings *VideoSelectorSettings - // Applies only if colorSpace is a value other than follow. This field controls how // the value in the colorSpace field will be used. fallback means that when the // input does include color space data, that data will be used, but when the input @@ -4324,6 +4321,9 @@ type VideoSelector struct { // colorSpace. Choose force if your input usually has no color space data or might // have unreliable color space data. ColorSpaceUsage VideoSelectorColorSpaceUsage + + // The video selector settings. + SelectorSettings *VideoSelectorSettings } // Video Selector Pid diff --git a/service/mediapackage/api_op_CreateChannel.go b/service/mediapackage/api_op_CreateChannel.go index 7202ca50805..316fcfb1417 100644 --- a/service/mediapackage/api_op_CreateChannel.go +++ b/service/mediapackage/api_op_CreateChannel.go @@ -73,21 +73,21 @@ type CreateChannelInput struct { type CreateChannelOutput struct { - // A collection of tags associated with a resource - Tags map[string]*string - - // An HTTP Live Streaming (HLS) ingest resource configuration. - HlsIngest *types.HlsIngest + // The Amazon Resource Name (ARN) assigned to the Channel. + Arn *string // A short text description of the Channel. Description *string - // The Amazon Resource Name (ARN) assigned to the Channel. - Arn *string + // An HTTP Live Streaming (HLS) ingest resource configuration. + HlsIngest *types.HlsIngest // The ID of the Channel. Id *string + // A collection of tags associated with a resource + Tags map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mediapackage/api_op_CreateHarvestJob.go b/service/mediapackage/api_op_CreateHarvestJob.go index 1418b058faa..8f60b5113d9 100644 --- a/service/mediapackage/api_op_CreateHarvestJob.go +++ b/service/mediapackage/api_op_CreateHarvestJob.go @@ -63,48 +63,48 @@ type CreateHarvestJobInput struct { // This member is required. EndTime *string - // The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot - // be changed after the HarvestJob is submitted. - // - // This member is required. - OriginEndpointId *string - - // The start of the time-window which will be harvested - // - // This member is required. - StartTime *string - // The ID of the HarvestJob. The ID must be unique within the region and it cannot // be changed after the HarvestJob is submitted // // This member is required. Id *string + // The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot + // be changed after the HarvestJob is submitted. + // + // This member is required. + OriginEndpointId *string + // Configuration parameters for where in an S3 bucket to place the harvested // content // // This member is required. S3Destination *types.S3Destination -} - -type CreateHarvestJobOutput struct { - - // The ID of the HarvestJob. The ID must be unique within the region and it cannot - // be changed after the HarvestJob is submitted. - Id *string - // The start of the time-window which will be harvested. + // The start of the time-window which will be harvested + // + // This member is required. StartTime *string +} - // The end of the time-window which will be harvested. - EndTime *string +type CreateHarvestJobOutput struct { // The Amazon Resource Name (ARN) assigned to the HarvestJob. Arn *string + // The ID of the Channel that the HarvestJob will harvest from. + ChannelId *string + // The time the HarvestJob was submitted CreatedAt *string + // The end of the time-window which will be harvested. + EndTime *string + + // The ID of the HarvestJob. The ID must be unique within the region and it cannot + // be changed after the HarvestJob is submitted. + Id *string + // The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot // be changed after the HarvestJob is submitted. OriginEndpointId *string @@ -113,14 +113,14 @@ type CreateHarvestJobOutput struct { // content S3Destination *types.S3Destination + // The start of the time-window which will be harvested. + StartTime *string + // The current status of the HarvestJob. Consider setting up a CloudWatch Event to // listen for HarvestJobs as they succeed or fail. In the event of failure, the // CloudWatch Event will include an explanation of why the HarvestJob failed. Status types.Status - // The ID of the Channel that the HarvestJob will harvest from. - ChannelId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mediapackage/api_op_CreateOriginEndpoint.go b/service/mediapackage/api_op_CreateOriginEndpoint.go index 12b7242908f..d76b82b8792 100644 --- a/service/mediapackage/api_op_CreateOriginEndpoint.go +++ b/service/mediapackage/api_op_CreateOriginEndpoint.go @@ -58,42 +58,39 @@ func (c *Client) CreateOriginEndpoint(ctx context.Context, params *CreateOriginE // Configuration parameters used to create a new OriginEndpoint. type CreateOriginEndpointInput struct { - // Amount of delay (seconds) to enforce on the playback of live content. If not - // specified, there will be no time delay in effect for the OriginEndpoint. - TimeDelaySeconds *int32 - - // A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. - DashPackage *types.DashPackage - // The ID of the Channel that the OriginEndpoint will be associated with. This // cannot be changed after the OriginEndpoint is created. // // This member is required. ChannelId *string - // An HTTP Live Streaming (HLS) packaging configuration. - HlsPackage *types.HlsPackage + // The ID of the OriginEndpoint. The ID must be unique within the region and it + // cannot be changed after the OriginEndpoint is created. + // + // This member is required. + Id *string - // A list of source IP CIDR blocks that will be allowed to access the - // OriginEndpoint. - Whitelist []*string + // CDN Authorization credentials + Authorization *types.Authorization // A Common Media Application Format (CMAF) packaging configuration. CmafPackage *types.CmafPackageCreateOrUpdateParameters - // A collection of tags associated with a resource - Tags map[string]*string + // A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. + DashPackage *types.DashPackage + + // A short text description of the OriginEndpoint. + Description *string + + // An HTTP Live Streaming (HLS) packaging configuration. + HlsPackage *types.HlsPackage // A short string that will be used as the filename of the OriginEndpoint URL // (defaults to "index"). ManifestName *string - // CDN Authorization credentials - Authorization *types.Authorization - - // Maximum duration (seconds) of content to retain for startover playback. If not - // specified, startover playback will be disabled for the OriginEndpoint. - StartoverWindowSeconds *int32 + // A Microsoft Smooth Streaming (MSS) packaging configuration. + MssPackage *types.MssPackage // Control whether origination of video is allowed for this OriginEndpoint. If set // to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of @@ -102,21 +99,6 @@ type CreateOriginEndpointInput struct { // origination Origination types.Origination - // The ID of the OriginEndpoint. The ID must be unique within the region and it - // cannot be changed after the OriginEndpoint is created. - // - // This member is required. - Id *string - - // A Microsoft Smooth Streaming (MSS) packaging configuration. - MssPackage *types.MssPackage - - // A short text description of the OriginEndpoint. - Description *string -} - -type CreateOriginEndpointOutput struct { - // Maximum duration (seconds) of content to retain for startover playback. If not // specified, startover playback will be disabled for the OriginEndpoint. StartoverWindowSeconds *int32 @@ -124,49 +106,67 @@ type CreateOriginEndpointOutput struct { // A collection of tags associated with a resource Tags map[string]*string - // The URL of the packaged OriginEndpoint for consumption. - Url *string + // Amount of delay (seconds) to enforce on the playback of live content. If not + // specified, there will be no time delay in effect for the OriginEndpoint. + TimeDelaySeconds *int32 - // Control whether origination of video is allowed for this OriginEndpoint. If set - // to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of - // access control. If set to DENY, the OriginEndpoint may not be requested. This - // can be helpful for Live to VOD harvesting, or for temporarily disabling - // origination - Origination types.Origination + // A list of source IP CIDR blocks that will be allowed to access the + // OriginEndpoint. + Whitelist []*string +} - // An HTTP Live Streaming (HLS) packaging configuration. - HlsPackage *types.HlsPackage +type CreateOriginEndpointOutput struct { - // A short string appended to the end of the OriginEndpoint URL. - ManifestName *string + // The Amazon Resource Name (ARN) assigned to the OriginEndpoint. + Arn *string // CDN Authorization credentials Authorization *types.Authorization - // The ID of the OriginEndpoint. - Id *string + // The ID of the Channel the OriginEndpoint is associated with. + ChannelId *string + + // A Common Media Application Format (CMAF) packaging configuration. + CmafPackage *types.CmafPackage // A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. DashPackage *types.DashPackage - // The Amazon Resource Name (ARN) assigned to the OriginEndpoint. - Arn *string - // A short text description of the OriginEndpoint. Description *string - // A Common Media Application Format (CMAF) packaging configuration. - CmafPackage *types.CmafPackage + // An HTTP Live Streaming (HLS) packaging configuration. + HlsPackage *types.HlsPackage - // Amount of delay (seconds) to enforce on the playback of live content. If not - // specified, there will be no time delay in effect for the OriginEndpoint. - TimeDelaySeconds *int32 + // The ID of the OriginEndpoint. + Id *string + + // A short string appended to the end of the OriginEndpoint URL. + ManifestName *string // A Microsoft Smooth Streaming (MSS) packaging configuration. MssPackage *types.MssPackage - // The ID of the Channel the OriginEndpoint is associated with. - ChannelId *string + // Control whether origination of video is allowed for this OriginEndpoint. If set + // to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of + // access control. If set to DENY, the OriginEndpoint may not be requested. This + // can be helpful for Live to VOD harvesting, or for temporarily disabling + // origination + Origination types.Origination + + // Maximum duration (seconds) of content to retain for startover playback. If not + // specified, startover playback will be disabled for the OriginEndpoint. + StartoverWindowSeconds *int32 + + // A collection of tags associated with a resource + Tags map[string]*string + + // Amount of delay (seconds) to enforce on the playback of live content. If not + // specified, there will be no time delay in effect for the OriginEndpoint. + TimeDelaySeconds *int32 + + // The URL of the packaged OriginEndpoint for consumption. + Url *string // A list of source IP CIDR blocks that will be allowed to access the // OriginEndpoint. diff --git a/service/mediapackage/api_op_DescribeChannel.go b/service/mediapackage/api_op_DescribeChannel.go index 7460f74e81a..600cb660c30 100644 --- a/service/mediapackage/api_op_DescribeChannel.go +++ b/service/mediapackage/api_op_DescribeChannel.go @@ -65,20 +65,20 @@ type DescribeChannelInput struct { type DescribeChannelOutput struct { + // The Amazon Resource Name (ARN) assigned to the Channel. + Arn *string + // A short text description of the Channel. Description *string - // A collection of tags associated with a resource - Tags map[string]*string + // An HTTP Live Streaming (HLS) ingest resource configuration. + HlsIngest *types.HlsIngest // The ID of the Channel. Id *string - // An HTTP Live Streaming (HLS) ingest resource configuration. - HlsIngest *types.HlsIngest - - // The Amazon Resource Name (ARN) assigned to the Channel. - Arn *string + // A collection of tags associated with a resource + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/mediapackage/api_op_DescribeHarvestJob.go b/service/mediapackage/api_op_DescribeHarvestJob.go index 64afcf52c26..1226a2a6d2a 100644 --- a/service/mediapackage/api_op_DescribeHarvestJob.go +++ b/service/mediapackage/api_op_DescribeHarvestJob.go @@ -68,34 +68,34 @@ type DescribeHarvestJobOutput struct { // The Amazon Resource Name (ARN) assigned to the HarvestJob. Arn *string - // Configuration parameters for where in an S3 bucket to place the harvested - // content - S3Destination *types.S3Destination - - // The ID of the HarvestJob. The ID must be unique within the region and it cannot - // be changed after the HarvestJob is submitted. - Id *string + // The ID of the Channel that the HarvestJob will harvest from. + ChannelId *string - // The current status of the HarvestJob. Consider setting up a CloudWatch Event to - // listen for HarvestJobs as they succeed or fail. In the event of failure, the - // CloudWatch Event will include an explanation of why the HarvestJob failed. - Status types.Status + // The time the HarvestJob was submitted + CreatedAt *string // The end of the time-window which will be harvested. EndTime *string - // The start of the time-window which will be harvested. - StartTime *string - - // The time the HarvestJob was submitted - CreatedAt *string + // The ID of the HarvestJob. The ID must be unique within the region and it cannot + // be changed after the HarvestJob is submitted. + Id *string // The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot // be changed after the HarvestJob is submitted. OriginEndpointId *string - // The ID of the Channel that the HarvestJob will harvest from. - ChannelId *string + // Configuration parameters for where in an S3 bucket to place the harvested + // content + S3Destination *types.S3Destination + + // The start of the time-window which will be harvested. + StartTime *string + + // The current status of the HarvestJob. Consider setting up a CloudWatch Event to + // listen for HarvestJobs as they succeed or fail. In the event of failure, the + // CloudWatch Event will include an explanation of why the HarvestJob failed. + Status types.Status // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/mediapackage/api_op_DescribeOriginEndpoint.go b/service/mediapackage/api_op_DescribeOriginEndpoint.go index 8da4d5f97d5..9ba9388d7c3 100644 --- a/service/mediapackage/api_op_DescribeOriginEndpoint.go +++ b/service/mediapackage/api_op_DescribeOriginEndpoint.go @@ -65,44 +65,36 @@ type DescribeOriginEndpointInput struct { type DescribeOriginEndpointOutput struct { - // Maximum duration (seconds) of content to retain for startover playback. If not - // specified, startover playback will be disabled for the OriginEndpoint. - StartoverWindowSeconds *int32 - - // A Common Media Application Format (CMAF) packaging configuration. - CmafPackage *types.CmafPackage - - // A collection of tags associated with a resource - Tags map[string]*string + // The Amazon Resource Name (ARN) assigned to the OriginEndpoint. + Arn *string // CDN Authorization credentials Authorization *types.Authorization - // A short string appended to the end of the OriginEndpoint URL. - ManifestName *string + // The ID of the Channel the OriginEndpoint is associated with. + ChannelId *string + + // A Common Media Application Format (CMAF) packaging configuration. + CmafPackage *types.CmafPackage // A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. DashPackage *types.DashPackage + // A short text description of the OriginEndpoint. + Description *string + // An HTTP Live Streaming (HLS) packaging configuration. HlsPackage *types.HlsPackage // The ID of the OriginEndpoint. Id *string - // The Amazon Resource Name (ARN) assigned to the OriginEndpoint. - Arn *string - - // A short text description of the OriginEndpoint. - Description *string + // A short string appended to the end of the OriginEndpoint URL. + ManifestName *string // A Microsoft Smooth Streaming (MSS) packaging configuration. MssPackage *types.MssPackage - // A list of source IP CIDR blocks that will be allowed to access the - // OriginEndpoint. - Whitelist []*string - // Control whether origination of video is allowed for this OriginEndpoint. If set // to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of // access control. If set to DENY, the OriginEndpoint may not be requested. This @@ -110,16 +102,24 @@ type DescribeOriginEndpointOutput struct { // origination Origination types.Origination - // The URL of the packaged OriginEndpoint for consumption. - Url *string + // Maximum duration (seconds) of content to retain for startover playback. If not + // specified, startover playback will be disabled for the OriginEndpoint. + StartoverWindowSeconds *int32 - // The ID of the Channel the OriginEndpoint is associated with. - ChannelId *string + // A collection of tags associated with a resource + Tags map[string]*string // Amount of delay (seconds) to enforce on the playback of live content. If not // specified, there will be no time delay in effect for the OriginEndpoint. TimeDelaySeconds *int32 + // The URL of the packaged OriginEndpoint for consumption. + Url *string + + // A list of source IP CIDR blocks that will be allowed to access the + // OriginEndpoint. + Whitelist []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mediapackage/api_op_ListChannels.go b/service/mediapackage/api_op_ListChannels.go index 29674710b20..e5d2df92676 100644 --- a/service/mediapackage/api_op_ListChannels.go +++ b/service/mediapackage/api_op_ListChannels.go @@ -65,12 +65,12 @@ type ListChannelsInput struct { type ListChannelsOutput struct { - // A token that can be used to resume pagination from the end of the collection. - NextToken *string - // A list of Channel records. Channels []*types.Channel + // A token that can be used to resume pagination from the end of the collection. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mediapackage/api_op_ListHarvestJobs.go b/service/mediapackage/api_op_ListHarvestJobs.go index c38f7e6d295..23068618ab2 100644 --- a/service/mediapackage/api_op_ListHarvestJobs.go +++ b/service/mediapackage/api_op_ListHarvestJobs.go @@ -56,18 +56,18 @@ func (c *Client) ListHarvestJobs(ctx context.Context, params *ListHarvestJobsInp type ListHarvestJobsInput struct { - // The upper bound on the number of records to return. - MaxResults *int32 + // When specified, the request will return only HarvestJobs associated with the + // given Channel ID. + IncludeChannelId *string // When specified, the request will return only HarvestJobs in the given status. IncludeStatus *string + // The upper bound on the number of records to return. + MaxResults *int32 + // A token used to resume pagination from the end of a previous request. NextToken *string - - // When specified, the request will return only HarvestJobs associated with the - // given Channel ID. - IncludeChannelId *string } type ListHarvestJobsOutput struct { diff --git a/service/mediapackage/api_op_ListOriginEndpoints.go b/service/mediapackage/api_op_ListOriginEndpoints.go index da652752930..c9552d9b28d 100644 --- a/service/mediapackage/api_op_ListOriginEndpoints.go +++ b/service/mediapackage/api_op_ListOriginEndpoints.go @@ -69,12 +69,12 @@ type ListOriginEndpointsInput struct { type ListOriginEndpointsOutput struct { - // A list of OriginEndpoint records. - OriginEndpoints []*types.OriginEndpoint - // A token that can be used to resume pagination from the end of the collection. NextToken *string + // A list of OriginEndpoint records. + OriginEndpoints []*types.OriginEndpoint + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mediapackage/api_op_RotateChannelCredentials.go b/service/mediapackage/api_op_RotateChannelCredentials.go index f3c5cd2ce1d..918c8c79821 100644 --- a/service/mediapackage/api_op_RotateChannelCredentials.go +++ b/service/mediapackage/api_op_RotateChannelCredentials.go @@ -66,21 +66,21 @@ type RotateChannelCredentialsInput struct { type RotateChannelCredentialsOutput struct { + // The Amazon Resource Name (ARN) assigned to the Channel. + Arn *string + // A short text description of the Channel. Description *string + // An HTTP Live Streaming (HLS) ingest resource configuration. + HlsIngest *types.HlsIngest + // The ID of the Channel. Id *string // A collection of tags associated with a resource Tags map[string]*string - // An HTTP Live Streaming (HLS) ingest resource configuration. - HlsIngest *types.HlsIngest - - // The Amazon Resource Name (ARN) assigned to the Channel. - Arn *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mediapackage/api_op_RotateIngestEndpointCredentials.go b/service/mediapackage/api_op_RotateIngestEndpointCredentials.go index e692e5348de..6077e3f92d6 100644 --- a/service/mediapackage/api_op_RotateIngestEndpointCredentials.go +++ b/service/mediapackage/api_op_RotateIngestEndpointCredentials.go @@ -71,21 +71,21 @@ type RotateIngestEndpointCredentialsInput struct { type RotateIngestEndpointCredentialsOutput struct { - // An HTTP Live Streaming (HLS) ingest resource configuration. - HlsIngest *types.HlsIngest - - // A collection of tags associated with a resource - Tags map[string]*string - // The Amazon Resource Name (ARN) assigned to the Channel. Arn *string // A short text description of the Channel. Description *string + // An HTTP Live Streaming (HLS) ingest resource configuration. + HlsIngest *types.HlsIngest + // The ID of the Channel. Id *string + // A collection of tags associated with a resource + Tags map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mediapackage/api_op_UntagResource.go b/service/mediapackage/api_op_UntagResource.go index 910b12405e2..2e29bcebafa 100644 --- a/service/mediapackage/api_op_UntagResource.go +++ b/service/mediapackage/api_op_UntagResource.go @@ -54,13 +54,12 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, } type UntagResourceInput struct { + ResourceArn *string // The key(s) of tag to be deleted // // This member is required. TagKeys []*string - - ResourceArn *string } type UntagResourceOutput struct { diff --git a/service/mediapackage/api_op_UpdateChannel.go b/service/mediapackage/api_op_UpdateChannel.go index 4e9fd9d7ceb..44896acee20 100644 --- a/service/mediapackage/api_op_UpdateChannel.go +++ b/service/mediapackage/api_op_UpdateChannel.go @@ -69,11 +69,8 @@ type UpdateChannelInput struct { type UpdateChannelOutput struct { - // The ID of the Channel. - Id *string - - // A collection of tags associated with a resource - Tags map[string]*string + // The Amazon Resource Name (ARN) assigned to the Channel. + Arn *string // A short text description of the Channel. Description *string @@ -81,8 +78,11 @@ type UpdateChannelOutput struct { // An HTTP Live Streaming (HLS) ingest resource configuration. HlsIngest *types.HlsIngest - // The Amazon Resource Name (ARN) assigned to the Channel. - Arn *string + // The ID of the Channel. + Id *string + + // A collection of tags associated with a resource + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/mediapackage/api_op_UpdateOriginEndpoint.go b/service/mediapackage/api_op_UpdateOriginEndpoint.go index a91bbc861b1..40b9e5a74da 100644 --- a/service/mediapackage/api_op_UpdateOriginEndpoint.go +++ b/service/mediapackage/api_op_UpdateOriginEndpoint.go @@ -58,40 +58,31 @@ func (c *Client) UpdateOriginEndpoint(ctx context.Context, params *UpdateOriginE // Configuration parameters used to update an existing OriginEndpoint. type UpdateOriginEndpointInput struct { - // A list of source IP CIDR blocks that will be allowed to access the - // OriginEndpoint. - Whitelist []*string - - // Amount of delay (in seconds) to enforce on the playback of live content. If not - // specified, there will be no time delay in effect for the OriginEndpoint. - TimeDelaySeconds *int32 - - // A Common Media Application Format (CMAF) packaging configuration. - CmafPackage *types.CmafPackageCreateOrUpdateParameters - // The ID of the OriginEndpoint to update. // // This member is required. Id *string - // A Microsoft Smooth Streaming (MSS) packaging configuration. - MssPackage *types.MssPackage + // CDN Authorization credentials + Authorization *types.Authorization - // A short text description of the OriginEndpoint. - Description *string + // A Common Media Application Format (CMAF) packaging configuration. + CmafPackage *types.CmafPackageCreateOrUpdateParameters // A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. DashPackage *types.DashPackage - // Maximum duration (in seconds) of content to retain for startover playback. If - // not specified, startover playback will be disabled for the OriginEndpoint. - StartoverWindowSeconds *int32 + // A short text description of the OriginEndpoint. + Description *string + + // An HTTP Live Streaming (HLS) packaging configuration. + HlsPackage *types.HlsPackage // A short string that will be appended to the end of the Endpoint URL. ManifestName *string - // An HTTP Live Streaming (HLS) packaging configuration. - HlsPackage *types.HlsPackage + // A Microsoft Smooth Streaming (MSS) packaging configuration. + MssPackage *types.MssPackage // Control whether origination of video is allowed for this OriginEndpoint. If set // to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of @@ -100,42 +91,50 @@ type UpdateOriginEndpointInput struct { // origination Origination types.Origination - // CDN Authorization credentials - Authorization *types.Authorization -} - -type UpdateOriginEndpointOutput struct { + // Maximum duration (in seconds) of content to retain for startover playback. If + // not specified, startover playback will be disabled for the OriginEndpoint. + StartoverWindowSeconds *int32 - // A short text description of the OriginEndpoint. - Description *string + // Amount of delay (in seconds) to enforce on the playback of live content. If not + // specified, there will be no time delay in effect for the OriginEndpoint. + TimeDelaySeconds *int32 - // A Microsoft Smooth Streaming (MSS) packaging configuration. - MssPackage *types.MssPackage + // A list of source IP CIDR blocks that will be allowed to access the + // OriginEndpoint. + Whitelist []*string +} - // The ID of the OriginEndpoint. - Id *string +type UpdateOriginEndpointOutput struct { // The Amazon Resource Name (ARN) assigned to the OriginEndpoint. Arn *string - // Amount of delay (seconds) to enforce on the playback of live content. If not - // specified, there will be no time delay in effect for the OriginEndpoint. - TimeDelaySeconds *int32 + // CDN Authorization credentials + Authorization *types.Authorization + + // The ID of the Channel the OriginEndpoint is associated with. + ChannelId *string // A Common Media Application Format (CMAF) packaging configuration. CmafPackage *types.CmafPackage - // The URL of the packaged OriginEndpoint for consumption. - Url *string + // A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. + DashPackage *types.DashPackage - // CDN Authorization credentials - Authorization *types.Authorization + // A short text description of the OriginEndpoint. + Description *string // An HTTP Live Streaming (HLS) packaging configuration. HlsPackage *types.HlsPackage - // The ID of the Channel the OriginEndpoint is associated with. - ChannelId *string + // The ID of the OriginEndpoint. + Id *string + + // A short string appended to the end of the OriginEndpoint URL. + ManifestName *string + + // A Microsoft Smooth Streaming (MSS) packaging configuration. + MssPackage *types.MssPackage // Control whether origination of video is allowed for this OriginEndpoint. If set // to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of @@ -144,18 +143,19 @@ type UpdateOriginEndpointOutput struct { // origination Origination types.Origination - // A collection of tags associated with a resource - Tags map[string]*string - // Maximum duration (seconds) of content to retain for startover playback. If not // specified, startover playback will be disabled for the OriginEndpoint. StartoverWindowSeconds *int32 - // A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. - DashPackage *types.DashPackage + // A collection of tags associated with a resource + Tags map[string]*string - // A short string appended to the end of the OriginEndpoint URL. - ManifestName *string + // Amount of delay (seconds) to enforce on the playback of live content. If not + // specified, there will be no time delay in effect for the OriginEndpoint. + TimeDelaySeconds *int32 + + // The URL of the packaged OriginEndpoint for consumption. + Url *string // A list of source IP CIDR blocks that will be allowed to access the // OriginEndpoint. diff --git a/service/mediapackage/go.mod b/service/mediapackage/go.mod index 2ff1f3ab612..072df07c511 100644 --- a/service/mediapackage/go.mod +++ b/service/mediapackage/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/mediapackage go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/mediapackage/types/types.go b/service/mediapackage/types/types.go index 8121d010467..e630ef8a14a 100644 --- a/service/mediapackage/types/types.go +++ b/service/mediapackage/types/types.go @@ -5,26 +5,23 @@ package types // CDN Authorization credentials type Authorization struct { - // The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to - // communicate with AWS Secrets Manager. - // - // This member is required. - SecretsRoleArn *string - // The Amazon Resource Name (ARN) for the secret in Secrets Manager that your // Content Distribution Network (CDN) uses for authorization to access your // endpoint. // // This member is required. CdnIdentifierSecret *string + + // The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to + // communicate with AWS Secrets Manager. + // + // This member is required. + SecretsRoleArn *string } // A Channel resource configuration. type Channel struct { - // A collection of tags associated with a resource - Tags map[string]*string - // The Amazon Resource Name (ARN) assigned to the Channel. Arn *string @@ -36,6 +33,9 @@ type Channel struct { // The ID of the Channel. Id *string + + // A collection of tags associated with a resource + Tags map[string]*string } // A Common Media Application Format (CMAF) encryption configuration. @@ -54,6 +54,9 @@ type CmafEncryption struct { // A Common Media Application Format (CMAF) packaging configuration. type CmafPackage struct { + // A Common Media Application Format (CMAF) encryption configuration. + Encryption *CmafEncryption + // A list of HLS manifest configurations HlsManifests []*HlsManifest @@ -61,36 +64,33 @@ type CmafPackage struct { // nearest multiple of the source segment duration. SegmentDurationSeconds *int32 - // A StreamSelection configuration. - StreamSelection *StreamSelection - // An optional custom string that is prepended to the name of each segment. If not // specified, it defaults to the ChannelId. SegmentPrefix *string - // A Common Media Application Format (CMAF) encryption configuration. - Encryption *CmafEncryption + // A StreamSelection configuration. + StreamSelection *StreamSelection } // A Common Media Application Format (CMAF) packaging configuration. type CmafPackageCreateOrUpdateParameters struct { - // A StreamSelection configuration. - StreamSelection *StreamSelection + // A Common Media Application Format (CMAF) encryption configuration. + Encryption *CmafEncryption + + // A list of HLS manifest configurations + HlsManifests []*HlsManifestCreateOrUpdateParameters // Duration (in seconds) of each segment. Actual segments will be rounded to the // nearest multiple of the source segment duration. SegmentDurationSeconds *int32 - // A list of HLS manifest configurations - HlsManifests []*HlsManifestCreateOrUpdateParameters - // An optional custom string that is prepended to the name of each segment. If not // specified, it defaults to the ChannelId. SegmentPrefix *string - // A Common Media Application Format (CMAF) encryption configuration. - Encryption *CmafEncryption + // A StreamSelection configuration. + StreamSelection *StreamSelection } // A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration. @@ -109,40 +109,10 @@ type DashEncryption struct { // A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. type DashPackage struct { - // Duration (in seconds) of each segment. Actual segments will be rounded to the - // nearest multiple of the source segment duration. - SegmentDurationSeconds *int32 - - // Determines the type of SegmentTemplate included in the Media Presentation - // Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is - // presented in each SegmentTemplate, with $Number$ media URLs. When set to - // TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with - // $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included - // in each SegmentTemplate, with $Number$ media URLs. - SegmentTemplateFormat SegmentTemplateFormat - - // Time window (in seconds) contained in each manifest. - ManifestWindowSeconds *int32 - - // Minimum duration (in seconds) between potential changes to the Dynamic Adaptive - // Streaming over HTTP (DASH) Media Presentation Description (MPD). - MinUpdatePeriodSeconds *int32 - - // A StreamSelection configuration. - StreamSelection *StreamSelection - - // Duration (in seconds) to delay live content before presentation. - SuggestedPresentationDelaySeconds *int32 - - // Minimum duration (in seconds) that a player will buffer media before starting - // the presentation. - MinBufferTimeSeconds *int32 - - // Determines the position of some tags in the Media Presentation Description - // (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are - // included in each Representation. When set to COMPACT, duplicate elements are - // combined and presented at the AdaptationSet level. - ManifestLayout ManifestLayout + // A list of SCTE-35 message types that are treated as ad markers in the output. If + // empty, no ad markers are output. Specify multiple items to create ad markers for + // all of the included message types. + AdTriggers []AdTriggersElement // This setting allows the delivery restriction flags on SCTE-35 segmentation // descriptors to determine whether a message signals an ad. Choosing "NONE" means @@ -156,6 +126,26 @@ type DashPackage struct { // AdTriggers. AdsOnDeliveryRestrictions AdsOnDeliveryRestrictions + // A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration. + Encryption *DashEncryption + + // Determines the position of some tags in the Media Presentation Description + // (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are + // included in each Representation. When set to COMPACT, duplicate elements are + // combined and presented at the AdaptationSet level. + ManifestLayout ManifestLayout + + // Time window (in seconds) contained in each manifest. + ManifestWindowSeconds *int32 + + // Minimum duration (in seconds) that a player will buffer media before starting + // the presentation. + MinBufferTimeSeconds *int32 + + // Minimum duration (in seconds) between potential changes to the Dynamic Adaptive + // Streaming over HTTP (DASH) Media Presentation Description (MPD). + MinUpdatePeriodSeconds *int32 + // A list of triggers that controls when the outgoing Dynamic Adaptive Streaming // over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into // multiple periods. If empty, the content will not be partitioned into more than @@ -163,76 +153,86 @@ type DashPackage struct { // Channel source contains SCTE-35 ad markers. PeriodTriggers []PeriodTriggersElement - // A list of SCTE-35 message types that are treated as ad markers in the output. If - // empty, no ad markers are output. Specify multiple items to create ad markers for - // all of the included message types. - AdTriggers []AdTriggersElement - - // A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration. - Encryption *DashEncryption - // The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to // "HBBTV_1_5", HbbTV 1.5 compliant output is enabled. Profile Profile + + // Duration (in seconds) of each segment. Actual segments will be rounded to the + // nearest multiple of the source segment duration. + SegmentDurationSeconds *int32 + + // Determines the type of SegmentTemplate included in the Media Presentation + // Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is + // presented in each SegmentTemplate, with $Number$ media URLs. When set to + // TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with + // $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included + // in each SegmentTemplate, with $Number$ media URLs. + SegmentTemplateFormat SegmentTemplateFormat + + // A StreamSelection configuration. + StreamSelection *StreamSelection + + // Duration (in seconds) to delay live content before presentation. + SuggestedPresentationDelaySeconds *int32 } // A HarvestJob resource configuration type HarvestJob struct { - // The ID of the Channel that the HarvestJob will harvest from. - ChannelId *string - // The Amazon Resource Name (ARN) assigned to the HarvestJob. Arn *string - // The start of the time-window which will be harvested. - StartTime *string + // The ID of the Channel that the HarvestJob will harvest from. + ChannelId *string - // The current status of the HarvestJob. Consider setting up a CloudWatch Event to - // listen for HarvestJobs as they succeed or fail. In the event of failure, the - // CloudWatch Event will include an explanation of why the HarvestJob failed. - Status Status + // The time the HarvestJob was submitted + CreatedAt *string // The end of the time-window which will be harvested. EndTime *string + // The ID of the HarvestJob. The ID must be unique within the region and it cannot + // be changed after the HarvestJob is submitted. + Id *string + // The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot // be changed after the HarvestJob is submitted. OriginEndpointId *string - // The time the HarvestJob was submitted - CreatedAt *string - // Configuration parameters for where in an S3 bucket to place the harvested // content S3Destination *S3Destination - // The ID of the HarvestJob. The ID must be unique within the region and it cannot - // be changed after the HarvestJob is submitted. - Id *string + // The start of the time-window which will be harvested. + StartTime *string + + // The current status of the HarvestJob. Consider setting up a CloudWatch Event to + // listen for HarvestJobs as they succeed or fail. In the event of failure, the + // CloudWatch Event will include an explanation of why the HarvestJob failed. + Status Status } // An HTTP Live Streaming (HLS) encryption configuration. type HlsEncryption struct { - // A constant initialization vector for encryption (optional). When not specified - // the initialization vector will be periodically rotated. - ConstantInitializationVector *string - // A configuration for accessing an external Secure Packager and Encoder Key // Exchange (SPEKE) service that will provide encryption keys. // // This member is required. SpekeKeyProvider *SpekeKeyProvider - // When enabled, the EXT-X-KEY tag will be repeated in output manifests. - RepeatExtXKey *bool + // A constant initialization vector for encryption (optional). When not specified + // the initialization vector will be periodically rotated. + ConstantInitializationVector *string + + // The encryption method to use. + EncryptionMethod EncryptionMethod // Interval (in seconds) between each encryption key rotation. KeyRotationIntervalSeconds *int32 - // The encryption method to use. - EncryptionMethod EncryptionMethod + // When enabled, the EXT-X-KEY tag will be repeated in output manifests. + RepeatExtXKey *bool } // An HTTP Live Streaming (HLS) ingest resource configuration. @@ -245,6 +245,22 @@ type HlsIngest struct { // A HTTP Live Streaming (HLS) manifest configuration. type HlsManifest struct { + // The ID of the manifest. The ID must be unique within the OriginEndpoint and it + // cannot be changed after it is created. + // + // This member is required. + Id *string + + // This setting controls how ad markers are included in the packaged + // OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. + // "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers + // (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. + // "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 + // messages in the input source. "DATERANGE" inserts EXT-X-DATERANGE tags to signal + // ad and program transition events in HLS and CMAF manifests. For this option, you + // must set a programDateTimeIntervalSeconds value that is greater than 0. + AdMarkers AdMarkers + // When enabled, an I-Frame only stream will be included in the output. IncludeIframeOnlyStream *bool @@ -252,17 +268,14 @@ type HlsManifest struct { // specified, defaults to the manifestName for the OriginEndpoint. ManifestName *string - // The URL of the packaged OriginEndpoint for consumption. - Url *string - - // Time window (in seconds) contained in each parent manifest. - PlaylistWindowSeconds *int32 - // The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is // specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the // media playlist. PlaylistType PlaylistType + // Time window (in seconds) contained in each parent manifest. + PlaylistWindowSeconds *int32 + // The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into // manifests. Additionally, when an interval is specified ID3Timed Metadata // messages will be generated every 5 seconds using the ingest time of the content. @@ -273,6 +286,19 @@ type HlsManifest struct { // output. ProgramDateTimeIntervalSeconds *int32 + // The URL of the packaged OriginEndpoint for consumption. + Url *string +} + +// A HTTP Live Streaming (HLS) manifest configuration. +type HlsManifestCreateOrUpdateParameters struct { + + // The ID of the manifest. The ID must be unique within the OriginEndpoint and it + // cannot be changed after it is created. + // + // This member is required. + Id *string + // This setting controls how ad markers are included in the packaged // OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. // "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers @@ -283,24 +309,38 @@ type HlsManifest struct { // must set a programDateTimeIntervalSeconds value that is greater than 0. AdMarkers AdMarkers - // The ID of the manifest. The ID must be unique within the OriginEndpoint and it - // cannot be changed after it is created. - // - // This member is required. - Id *string -} - -// A HTTP Live Streaming (HLS) manifest configuration. -type HlsManifestCreateOrUpdateParameters struct { - // A list of SCTE-35 message types that are treated as ad markers in the output. If // empty, no ad markers are output. Specify multiple items to create ad markers for // all of the included message types. AdTriggers []AdTriggersElement + // This setting allows the delivery restriction flags on SCTE-35 segmentation + // descriptors to determine whether a message signals an ad. Choosing "NONE" means + // no SCTE-35 messages become ads. Choosing "RESTRICTED" means SCTE-35 messages of + // the types specified in AdTriggers that contain delivery restrictions will be + // treated as ads. Choosing "UNRESTRICTED" means SCTE-35 messages of the types + // specified in AdTriggers that do not contain delivery restrictions will be + // treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types + // specified in AdTriggers will be treated as ads. Note that Splice Insert messages + // do not have these flags and are always treated as ads if specified in + // AdTriggers. + AdsOnDeliveryRestrictions AdsOnDeliveryRestrictions + // When enabled, an I-Frame only stream will be included in the output. IncludeIframeOnlyStream *bool + // An optional short string appended to the end of the OriginEndpoint URL. If not + // specified, defaults to the manifestName for the OriginEndpoint. + ManifestName *string + + // The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is + // specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the + // media playlist. + PlaylistType PlaylistType + + // Time window (in seconds) contained in each parent manifest. + PlaylistWindowSeconds *int32 + // The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into // manifests. Additionally, when an interval is specified ID3Timed Metadata // messages will be generated every 5 seconds using the ingest time of the content. @@ -310,17 +350,10 @@ type HlsManifestCreateOrUpdateParameters struct { // is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS // output. ProgramDateTimeIntervalSeconds *int32 +} - // The ID of the manifest. The ID must be unique within the OriginEndpoint and it - // cannot be changed after it is created. - // - // This member is required. - Id *string - - // The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is - // specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the - // media playlist. - PlaylistType PlaylistType +// An HTTP Live Streaming (HLS) packaging configuration. +type HlsPackage struct { // This setting controls how ad markers are included in the packaged // OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. @@ -332,12 +365,10 @@ type HlsManifestCreateOrUpdateParameters struct { // must set a programDateTimeIntervalSeconds value that is greater than 0. AdMarkers AdMarkers - // An optional short string appended to the end of the OriginEndpoint URL. If not - // specified, defaults to the manifestName for the OriginEndpoint. - ManifestName *string - - // Time window (in seconds) contained in each parent manifest. - PlaylistWindowSeconds *int32 + // A list of SCTE-35 message types that are treated as ad markers in the output. If + // empty, no ad markers are output. Specify multiple items to create ad markers for + // all of the included message types. + AdTriggers []AdTriggersElement // This setting allows the delivery restriction flags on SCTE-35 segmentation // descriptors to determine whether a message signals an ad. Choosing "NONE" means @@ -350,20 +381,20 @@ type HlsManifestCreateOrUpdateParameters struct { // do not have these flags and are always treated as ads if specified in // AdTriggers. AdsOnDeliveryRestrictions AdsOnDeliveryRestrictions -} -// An HTTP Live Streaming (HLS) packaging configuration. -type HlsPackage struct { + // An HTTP Live Streaming (HLS) encryption configuration. + Encryption *HlsEncryption + + // When enabled, an I-Frame only stream will be included in the output. + IncludeIframeOnlyStream *bool // The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is // specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the // media playlist. PlaylistType PlaylistType - // A list of SCTE-35 message types that are treated as ad markers in the output. If - // empty, no ad markers are output. Specify multiple items to create ad markers for - // all of the included message types. - AdTriggers []AdTriggersElement + // Time window (in seconds) contained in each parent manifest. + PlaylistWindowSeconds *int32 // The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into // manifests. Additionally, when an interval is specified ID3Timed Metadata @@ -375,62 +406,31 @@ type HlsPackage struct { // output. ProgramDateTimeIntervalSeconds *int32 - // When enabled, audio streams will be placed in rendition groups in the output. - UseAudioRenditionGroup *bool - - // When enabled, an I-Frame only stream will be included in the output. - IncludeIframeOnlyStream *bool - - // An HTTP Live Streaming (HLS) encryption configuration. - Encryption *HlsEncryption - // Duration (in seconds) of each fragment. Actual fragments will be rounded to the // nearest multiple of the source fragment duration. SegmentDurationSeconds *int32 - // This setting controls how ad markers are included in the packaged - // OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. - // "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers - // (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. - // "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 - // messages in the input source. "DATERANGE" inserts EXT-X-DATERANGE tags to signal - // ad and program transition events in HLS and CMAF manifests. For this option, you - // must set a programDateTimeIntervalSeconds value that is greater than 0. - AdMarkers AdMarkers - - // Time window (in seconds) contained in each parent manifest. - PlaylistWindowSeconds *int32 - // A StreamSelection configuration. StreamSelection *StreamSelection - // This setting allows the delivery restriction flags on SCTE-35 segmentation - // descriptors to determine whether a message signals an ad. Choosing "NONE" means - // no SCTE-35 messages become ads. Choosing "RESTRICTED" means SCTE-35 messages of - // the types specified in AdTriggers that contain delivery restrictions will be - // treated as ads. Choosing "UNRESTRICTED" means SCTE-35 messages of the types - // specified in AdTriggers that do not contain delivery restrictions will be - // treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types - // specified in AdTriggers will be treated as ads. Note that Splice Insert messages - // do not have these flags and are always treated as ads if specified in - // AdTriggers. - AdsOnDeliveryRestrictions AdsOnDeliveryRestrictions + // When enabled, audio streams will be placed in rendition groups in the output. + UseAudioRenditionGroup *bool } // An endpoint for ingesting source content for a Channel. type IngestEndpoint struct { - // The system generated password for ingest authentication. - Password *string - - // The system generated username for ingest authentication. - Username *string - // The system generated unique identifier for the IngestEndpoint Id *string + // The system generated password for ingest authentication. + Password *string + // The ingest URL to which the source stream should be sent. Url *string + + // The system generated username for ingest authentication. + Username *string } // A Microsoft Smooth Streaming (MSS) encryption configuration. @@ -446,40 +446,51 @@ type MssEncryption struct { // A Microsoft Smooth Streaming (MSS) packaging configuration. type MssPackage struct { - // The time window (in seconds) contained in each manifest. - ManifestWindowSeconds *int32 - // A Microsoft Smooth Streaming (MSS) encryption configuration. Encryption *MssEncryption - // A StreamSelection configuration. - StreamSelection *StreamSelection + // The time window (in seconds) contained in each manifest. + ManifestWindowSeconds *int32 // The duration (in seconds) of each segment. SegmentDurationSeconds *int32 + + // A StreamSelection configuration. + StreamSelection *StreamSelection } // An OriginEndpoint resource configuration. type OriginEndpoint struct { - // The URL of the packaged OriginEndpoint for consumption. - Url *string + // The Amazon Resource Name (ARN) assigned to the OriginEndpoint. + Arn *string + + // CDN Authorization credentials + Authorization *Authorization + + // The ID of the Channel the OriginEndpoint is associated with. + ChannelId *string + + // A Common Media Application Format (CMAF) packaging configuration. + CmafPackage *CmafPackage // A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. DashPackage *DashPackage - // A short string appended to the end of the OriginEndpoint URL. - ManifestName *string + // A short text description of the OriginEndpoint. + Description *string // An HTTP Live Streaming (HLS) packaging configuration. HlsPackage *HlsPackage - // Maximum duration (seconds) of content to retain for startover playback. If not - // specified, startover playback will be disabled for the OriginEndpoint. - StartoverWindowSeconds *int32 + // The ID of the OriginEndpoint. + Id *string - // CDN Authorization credentials - Authorization *Authorization + // A short string appended to the end of the OriginEndpoint URL. + ManifestName *string + + // A Microsoft Smooth Streaming (MSS) packaging configuration. + MssPackage *MssPackage // Control whether origination of video is allowed for this OriginEndpoint. If set // to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of @@ -488,34 +499,23 @@ type OriginEndpoint struct { // origination Origination Origination - // The ID of the Channel the OriginEndpoint is associated with. - ChannelId *string + // Maximum duration (seconds) of content to retain for startover playback. If not + // specified, startover playback will be disabled for the OriginEndpoint. + StartoverWindowSeconds *int32 // A collection of tags associated with a resource Tags map[string]*string - // The ID of the OriginEndpoint. - Id *string - - // A Common Media Application Format (CMAF) packaging configuration. - CmafPackage *CmafPackage - - // A Microsoft Smooth Streaming (MSS) packaging configuration. - MssPackage *MssPackage - - // A short text description of the OriginEndpoint. - Description *string + // Amount of delay (seconds) to enforce on the playback of live content. If not + // specified, there will be no time delay in effect for the OriginEndpoint. + TimeDelaySeconds *int32 - // The Amazon Resource Name (ARN) assigned to the OriginEndpoint. - Arn *string + // The URL of the packaged OriginEndpoint for consumption. + Url *string // A list of source IP CIDR blocks that will be allowed to access the // OriginEndpoint. Whitelist []*string - - // Amount of delay (seconds) to enforce on the playback of live content. If not - // specified, there will be no time delay in effect for the OriginEndpoint. - TimeDelaySeconds *int32 } // Configuration parameters for where in an S3 bucket to place the harvested @@ -527,16 +527,16 @@ type S3Destination struct { // This member is required. BucketName *string - // The IAM role used to write to the specified S3 bucket - // - // This member is required. - RoleArn *string - // The key in the specified S3 bucket where the harvested top-level manifest will // be placed. // // This member is required. ManifestKey *string + + // The IAM role used to write to the specified S3 bucket + // + // This member is required. + RoleArn *string } // A configuration for accessing an external Secure Packager and Encoder Key @@ -548,6 +548,12 @@ type SpekeKeyProvider struct { // This member is required. ResourceId *string + // An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage + // will assume when accessing the key provider service. + // + // This member is required. + RoleArn *string + // The system IDs to include in key requests. // // This member is required. @@ -558,12 +564,6 @@ type SpekeKeyProvider struct { // This member is required. Url *string - // An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage - // will assume when accessing the key provider service. - // - // This member is required. - RoleArn *string - // An Amazon Resource Name (ARN) of a Certificate Manager certificate that // MediaPackage will use for enforcing secure end-to-end data transfer with the key // provider service. @@ -573,12 +573,12 @@ type SpekeKeyProvider struct { // A StreamSelection configuration. type StreamSelection struct { + // The maximum video bitrate (bps) to include in output. + MaxVideoBitsPerSecond *int32 + // The minimum video bitrate (bps) to include in output. MinVideoBitsPerSecond *int32 // A directive that determines the order of streams in the output. StreamOrder StreamOrder - - // The maximum video bitrate (bps) to include in output. - MaxVideoBitsPerSecond *int32 } diff --git a/service/mediapackagevod/api_op_CreateAsset.go b/service/mediapackagevod/api_op_CreateAsset.go index 52616c318f4..39f19cbb7b6 100644 --- a/service/mediapackagevod/api_op_CreateAsset.go +++ b/service/mediapackagevod/api_op_CreateAsset.go @@ -58,40 +58,43 @@ func (c *Client) CreateAsset(ctx context.Context, params *CreateAssetInput, optF // A new MediaPackage VOD Asset configuration. type CreateAssetInput struct { - // A collection of tags associated with a resource - Tags map[string]*string - - // The resource ID to include in SPEKE key requests. - ResourceId *string - - // ARN of the source object in S3. + // The unique identifier for the Asset. // // This member is required. - SourceArn *string + Id *string // The ID of the PackagingGroup for the Asset. // // This member is required. PackagingGroupId *string - // The IAM role ARN used to access the source S3 bucket. + // ARN of the source object in S3. // // This member is required. - SourceRoleArn *string + SourceArn *string - // The unique identifier for the Asset. + // The IAM role ARN used to access the source S3 bucket. // // This member is required. - Id *string + SourceRoleArn *string + + // The resource ID to include in SPEKE key requests. + ResourceId *string + + // A collection of tags associated with a resource + Tags map[string]*string } type CreateAssetOutput struct { + // The ARN of the Asset. + Arn *string + // The time the Asset was initially submitted for Ingest. CreatedAt *string - // ARN of the source object in S3. - SourceArn *string + // The list of egress endpoints available for the Asset. + EgressEndpoints []*types.EgressEndpoint // The unique identifier for the Asset. Id *string @@ -102,17 +105,14 @@ type CreateAssetOutput struct { // The resource ID to include in SPEKE key requests. ResourceId *string - // A collection of tags associated with a resource - Tags map[string]*string - - // The list of egress endpoints available for the Asset. - EgressEndpoints []*types.EgressEndpoint + // ARN of the source object in S3. + SourceArn *string // The IAM role_arn used to access the source S3 bucket. SourceRoleArn *string - // The ARN of the Asset. - Arn *string + // A collection of tags associated with a resource + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/mediapackagevod/api_op_CreatePackagingConfiguration.go b/service/mediapackagevod/api_op_CreatePackagingConfiguration.go index 261ffb8ff2b..f2fd2010ed8 100644 --- a/service/mediapackagevod/api_op_CreatePackagingConfiguration.go +++ b/service/mediapackagevod/api_op_CreatePackagingConfiguration.go @@ -58,58 +58,58 @@ func (c *Client) CreatePackagingConfiguration(ctx context.Context, params *Creat // A new MediaPackage VOD PackagingConfiguration resource configuration. type CreatePackagingConfigurationInput struct { - // A collection of tags associated with a resource - Tags map[string]*string - - // A CMAF packaging configuration. - CmafPackage *types.CmafPackage - // The ID of the PackagingConfiguration. // // This member is required. Id *string - // A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. - DashPackage *types.DashPackage - // The ID of a PackagingGroup. // // This member is required. PackagingGroupId *string + // A CMAF packaging configuration. + CmafPackage *types.CmafPackage + + // A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. + DashPackage *types.DashPackage + // An HTTP Live Streaming (HLS) packaging configuration. HlsPackage *types.HlsPackage // A Microsoft Smooth Streaming (MSS) PackagingConfiguration. MssPackage *types.MssPackage + + // A collection of tags associated with a resource + Tags map[string]*string } type CreatePackagingConfigurationOutput struct { + // The ARN of the PackagingConfiguration. + Arn *string + // A CMAF packaging configuration. CmafPackage *types.CmafPackage + // A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. + DashPackage *types.DashPackage + // An HTTP Live Streaming (HLS) packaging configuration. HlsPackage *types.HlsPackage + // The ID of the PackagingConfiguration. + Id *string + // A Microsoft Smooth Streaming (MSS) PackagingConfiguration. MssPackage *types.MssPackage // The ID of a PackagingGroup. PackagingGroupId *string - // The ID of the PackagingConfiguration. - Id *string - // A collection of tags associated with a resource Tags map[string]*string - // A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. - DashPackage *types.DashPackage - - // The ARN of the PackagingConfiguration. - Arn *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mediapackagevod/api_op_CreatePackagingGroup.go b/service/mediapackagevod/api_op_CreatePackagingGroup.go index e8623fac733..c907838ac68 100644 --- a/service/mediapackagevod/api_op_CreatePackagingGroup.go +++ b/service/mediapackagevod/api_op_CreatePackagingGroup.go @@ -72,21 +72,21 @@ type CreatePackagingGroupInput struct { type CreatePackagingGroupOutput struct { + // The ARN of the PackagingGroup. + Arn *string + // CDN Authorization credentials Authorization *types.Authorization - // A collection of tags associated with a resource - Tags map[string]*string - // The fully qualified domain name for Assets in the PackagingGroup. DomainName *string - // The ARN of the PackagingGroup. - Arn *string - // The ID of the PackagingGroup. Id *string + // A collection of tags associated with a resource + Tags map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mediapackagevod/api_op_DescribeAsset.go b/service/mediapackagevod/api_op_DescribeAsset.go index 6353ef0e10c..8a215bbd95a 100644 --- a/service/mediapackagevod/api_op_DescribeAsset.go +++ b/service/mediapackagevod/api_op_DescribeAsset.go @@ -65,33 +65,33 @@ type DescribeAssetInput struct { type DescribeAssetOutput struct { - // The IAM role_arn used to access the source S3 bucket. - SourceRoleArn *string + // The ARN of the Asset. + Arn *string + + // The time the Asset was initially submitted for Ingest. + CreatedAt *string + + // The list of egress endpoints available for the Asset. + EgressEndpoints []*types.EgressEndpoint // The unique identifier for the Asset. Id *string + // The ID of the PackagingGroup for the Asset. + PackagingGroupId *string + // The resource ID to include in SPEKE key requests. ResourceId *string - // The time the Asset was initially submitted for Ingest. - CreatedAt *string - // ARN of the source object in S3. SourceArn *string - // The ID of the PackagingGroup for the Asset. - PackagingGroupId *string - - // The ARN of the Asset. - Arn *string + // The IAM role_arn used to access the source S3 bucket. + SourceRoleArn *string // A collection of tags associated with a resource Tags map[string]*string - // The list of egress endpoints available for the Asset. - EgressEndpoints []*types.EgressEndpoint - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mediapackagevod/api_op_DescribePackagingConfiguration.go b/service/mediapackagevod/api_op_DescribePackagingConfiguration.go index 8aaef8d1d48..7fca7982971 100644 --- a/service/mediapackagevod/api_op_DescribePackagingConfiguration.go +++ b/service/mediapackagevod/api_op_DescribePackagingConfiguration.go @@ -65,29 +65,29 @@ type DescribePackagingConfigurationInput struct { type DescribePackagingConfigurationOutput struct { + // The ARN of the PackagingConfiguration. + Arn *string + + // A CMAF packaging configuration. + CmafPackage *types.CmafPackage + + // A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. + DashPackage *types.DashPackage + // An HTTP Live Streaming (HLS) packaging configuration. HlsPackage *types.HlsPackage // The ID of the PackagingConfiguration. Id *string - // A collection of tags associated with a resource - Tags map[string]*string - - // A CMAF packaging configuration. - CmafPackage *types.CmafPackage - // A Microsoft Smooth Streaming (MSS) PackagingConfiguration. MssPackage *types.MssPackage // The ID of a PackagingGroup. PackagingGroupId *string - // The ARN of the PackagingConfiguration. - Arn *string - - // A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. - DashPackage *types.DashPackage + // A collection of tags associated with a resource + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/mediapackagevod/api_op_DescribePackagingGroup.go b/service/mediapackagevod/api_op_DescribePackagingGroup.go index a183fa03bc8..e1c9124db93 100644 --- a/service/mediapackagevod/api_op_DescribePackagingGroup.go +++ b/service/mediapackagevod/api_op_DescribePackagingGroup.go @@ -65,21 +65,21 @@ type DescribePackagingGroupInput struct { type DescribePackagingGroupOutput struct { + // The ARN of the PackagingGroup. + Arn *string + // CDN Authorization credentials Authorization *types.Authorization - // A collection of tags associated with a resource - Tags map[string]*string - // The fully qualified domain name for Assets in the PackagingGroup. DomainName *string - // The ARN of the PackagingGroup. - Arn *string - // The ID of the PackagingGroup. Id *string + // A collection of tags associated with a resource + Tags map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mediapackagevod/api_op_ListAssets.go b/service/mediapackagevod/api_op_ListAssets.go index 052d2145fb8..a7bd8faec6b 100644 --- a/service/mediapackagevod/api_op_ListAssets.go +++ b/service/mediapackagevod/api_op_ListAssets.go @@ -56,12 +56,12 @@ func (c *Client) ListAssets(ctx context.Context, params *ListAssetsInput, optFns type ListAssetsInput struct { - // A token used to resume pagination from the end of a previous request. - NextToken *string - // Upper bound on number of records to return. MaxResults *int32 + // A token used to resume pagination from the end of a previous request. + NextToken *string + // Returns Assets associated with the specified PackagingGroup. PackagingGroupId *string } diff --git a/service/mediapackagevod/api_op_ListPackagingConfigurations.go b/service/mediapackagevod/api_op_ListPackagingConfigurations.go index 06416a8c031..0ac5645e593 100644 --- a/service/mediapackagevod/api_op_ListPackagingConfigurations.go +++ b/service/mediapackagevod/api_op_ListPackagingConfigurations.go @@ -56,15 +56,15 @@ func (c *Client) ListPackagingConfigurations(ctx context.Context, params *ListPa type ListPackagingConfigurationsInput struct { - // Returns MediaPackage VOD PackagingConfigurations associated with the specified - // PackagingGroup. - PackagingGroupId *string - // Upper bound on number of records to return. MaxResults *int32 // A token used to resume pagination from the end of a previous request. NextToken *string + + // Returns MediaPackage VOD PackagingConfigurations associated with the specified + // PackagingGroup. + PackagingGroupId *string } type ListPackagingConfigurationsOutput struct { diff --git a/service/mediapackagevod/api_op_ListPackagingGroups.go b/service/mediapackagevod/api_op_ListPackagingGroups.go index 7e9ba422011..6fbbf87e8cd 100644 --- a/service/mediapackagevod/api_op_ListPackagingGroups.go +++ b/service/mediapackagevod/api_op_ListPackagingGroups.go @@ -56,21 +56,21 @@ func (c *Client) ListPackagingGroups(ctx context.Context, params *ListPackagingG type ListPackagingGroupsInput struct { - // A token used to resume pagination from the end of a previous request. - NextToken *string - // Upper bound on number of records to return. MaxResults *int32 + + // A token used to resume pagination from the end of a previous request. + NextToken *string } type ListPackagingGroupsOutput struct { - // A list of MediaPackage VOD PackagingGroup resources. - PackagingGroups []*types.PackagingGroup - // A token that can be used to resume pagination from the end of the collection. NextToken *string + // A list of MediaPackage VOD PackagingGroup resources. + PackagingGroups []*types.PackagingGroup + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mediapackagevod/api_op_UntagResource.go b/service/mediapackagevod/api_op_UntagResource.go index 5a88cdd2235..5420b76a508 100644 --- a/service/mediapackagevod/api_op_UntagResource.go +++ b/service/mediapackagevod/api_op_UntagResource.go @@ -57,16 +57,16 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // A comma-separated list of the tag keys to remove from the resource. - // - // This member is required. - TagKeys []*string - // The Amazon Resource Name (ARN) for the resource. You can get this from the // response to any request to the resource. // // This member is required. ResourceArn *string + + // A comma-separated list of the tag keys to remove from the resource. + // + // This member is required. + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/mediapackagevod/api_op_UpdatePackagingGroup.go b/service/mediapackagevod/api_op_UpdatePackagingGroup.go index 3f39a78b4e4..ab24c62e251 100644 --- a/service/mediapackagevod/api_op_UpdatePackagingGroup.go +++ b/service/mediapackagevod/api_op_UpdatePackagingGroup.go @@ -70,8 +70,8 @@ type UpdatePackagingGroupInput struct { type UpdatePackagingGroupOutput struct { - // A collection of tags associated with a resource - Tags map[string]*string + // The ARN of the PackagingGroup. + Arn *string // CDN Authorization credentials Authorization *types.Authorization @@ -79,12 +79,12 @@ type UpdatePackagingGroupOutput struct { // The fully qualified domain name for Assets in the PackagingGroup. DomainName *string - // The ARN of the PackagingGroup. - Arn *string - // The ID of the PackagingGroup. Id *string + // A collection of tags associated with a resource + Tags map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mediapackagevod/go.mod b/service/mediapackagevod/go.mod index df7aab5d4b8..aafc1418591 100644 --- a/service/mediapackagevod/go.mod +++ b/service/mediapackagevod/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/mediapackagevod go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/mediapackagevod/types/types.go b/service/mediapackagevod/types/types.go index 7cc5b81cab0..bcb08b0c341 100644 --- a/service/mediapackagevod/types/types.go +++ b/service/mediapackagevod/types/types.go @@ -5,45 +5,45 @@ package types // A MediaPackage VOD Asset resource. type AssetShallow struct { + // The ARN of the Asset. + Arn *string + // The time the Asset was initially submitted for Ingest. CreatedAt *string - // A collection of tags associated with a resource - Tags map[string]*string + // The unique identifier for the Asset. + Id *string // The ID of the PackagingGroup for the Asset. PackagingGroupId *string - // ARN of the source object in S3. - SourceArn *string - // The resource ID to include in SPEKE key requests. ResourceId *string + // ARN of the source object in S3. + SourceArn *string + // The IAM role ARN used to access the source S3 bucket. SourceRoleArn *string - // The unique identifier for the Asset. - Id *string - - // The ARN of the Asset. - Arn *string + // A collection of tags associated with a resource + Tags map[string]*string } // CDN Authorization credentials type Authorization struct { - // The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to - // communicate with AWS Secrets Manager. - // - // This member is required. - SecretsRoleArn *string - // The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is // used for CDN authorization. // // This member is required. CdnIdentifierSecret *string + + // The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to + // communicate with AWS Secrets Manager. + // + // This member is required. + SecretsRoleArn *string } // A CMAF encryption configuration. @@ -64,12 +64,12 @@ type CmafPackage struct { // This member is required. HlsManifests []*HlsManifest + // A CMAF encryption configuration. + Encryption *CmafEncryption + // Duration (in seconds) of each fragment. Actual fragments will be rounded to the // nearest multiple of the source fragment duration. SegmentDurationSeconds *int32 - - // A CMAF encryption configuration. - Encryption *CmafEncryption } // A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration. @@ -85,34 +85,30 @@ type DashEncryption struct { // A DASH manifest configuration. type DashManifest struct { + // Determines the position of some tags in the Media Presentation Description + // (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are + // included in each Representation. When set to COMPACT, duplicate elements are + // combined and presented at the AdaptationSet level. + ManifestLayout ManifestLayout + // An optional string to include in the name of the manifest. ManifestName *string - // A StreamSelection configuration. - StreamSelection *StreamSelection - // Minimum duration (in seconds) that a player will buffer media before starting // the presentation. MinBufferTimeSeconds *int32 - // Determines the position of some tags in the Media Presentation Description - // (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are - // included in each Representation. When set to COMPACT, duplicate elements are - // combined and presented at the AdaptationSet level. - ManifestLayout ManifestLayout - // The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to // "HBBTV_1_5", HbbTV 1.5 compliant output is enabled. Profile Profile + + // A StreamSelection configuration. + StreamSelection *StreamSelection } // A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. type DashPackage struct { - // Duration (in seconds) of each segment. Actual segments will be rounded to the - // nearest multiple of the source segment duration. - SegmentDurationSeconds *int32 - // A list of DASH manifest configurations. // // This member is required. @@ -128,6 +124,10 @@ type DashPackage struct { // Asset contains SCTE-35 ad markers. PeriodTriggers []PeriodTriggersElement + // Duration (in seconds) of each segment. Actual segments will be rounded to the + // nearest multiple of the source segment duration. + SegmentDurationSeconds *int32 + // Determines the type of SegmentTemplate included in the Media Presentation // Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is // presented in each SegmentTemplate, with $Number$ media URLs. When set to @@ -140,26 +140,26 @@ type DashPackage struct { // The endpoint URL used to access an Asset using one PackagingConfiguration. type EgressEndpoint struct { - // The URL of the parent manifest for the repackaged Asset. - Url *string - // The ID of the PackagingConfiguration being applied to the Asset. PackagingConfigurationId *string + + // The URL of the parent manifest for the repackaged Asset. + Url *string } // An HTTP Live Streaming (HLS) encryption configuration. type HlsEncryption struct { - // A constant initialization vector for encryption (optional). When not specified - // the initialization vector will be periodically rotated. - ConstantInitializationVector *string - // A configuration for accessing an external Secure Packager and Encoder Key // Exchange (SPEKE) service that will provide encryption keys. // // This member is required. SpekeKeyProvider *SpekeKeyProvider + // A constant initialization vector for encryption (optional). When not specified + // the initialization vector will be periodically rotated. + ConstantInitializationVector *string + // The encryption method to use. EncryptionMethod EncryptionMethod } @@ -167,11 +167,19 @@ type HlsEncryption struct { // An HTTP Live Streaming (HLS) manifest configuration. type HlsManifest struct { + // This setting controls how ad markers are included in the packaged + // OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. + // "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers + // (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. + // "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 + // messages in the input source. + AdMarkers AdMarkers + // When enabled, an I-Frame only stream will be included in the output. IncludeIframeOnlyStream *bool - // When enabled, the EXT-X-KEY tag will be repeated in output manifests. - RepeatExtXKey *bool + // An optional string to include in the name of the manifest. + ManifestName *string // The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into // manifests. Additionally, when an interval is specified ID3Timed Metadata @@ -183,19 +191,11 @@ type HlsManifest struct { // output. ProgramDateTimeIntervalSeconds *int32 - // This setting controls how ad markers are included in the packaged - // OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. - // "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers - // (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. - // "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 - // messages in the input source. - AdMarkers AdMarkers + // When enabled, the EXT-X-KEY tag will be repeated in output manifests. + RepeatExtXKey *bool // A StreamSelection configuration. StreamSelection *StreamSelection - - // An optional string to include in the name of the manifest. - ManifestName *string } // An HTTP Live Streaming (HLS) packaging configuration. @@ -206,15 +206,15 @@ type HlsPackage struct { // This member is required. HlsManifests []*HlsManifest - // When enabled, audio streams will be placed in rendition groups in the output. - UseAudioRenditionGroup *bool - // An HTTP Live Streaming (HLS) encryption configuration. Encryption *HlsEncryption // Duration (in seconds) of each fragment. Actual fragments will be rounded to the // nearest multiple of the source fragment duration. SegmentDurationSeconds *int32 + + // When enabled, audio streams will be placed in rendition groups in the output. + UseAudioRenditionGroup *bool } // A Microsoft Smooth Streaming (MSS) encryption configuration. @@ -230,24 +230,24 @@ type MssEncryption struct { // A Microsoft Smooth Streaming (MSS) manifest configuration. type MssManifest struct { - // A StreamSelection configuration. - StreamSelection *StreamSelection - // An optional string to include in the name of the manifest. ManifestName *string + + // A StreamSelection configuration. + StreamSelection *StreamSelection } // A Microsoft Smooth Streaming (MSS) PackagingConfiguration. type MssPackage struct { - // A Microsoft Smooth Streaming (MSS) encryption configuration. - Encryption *MssEncryption - // A list of MSS manifest configurations. // // This member is required. MssManifests []*MssManifest + // A Microsoft Smooth Streaming (MSS) encryption configuration. + Encryption *MssEncryption + // The duration (in seconds) of each segment. SegmentDurationSeconds *int32 } @@ -255,48 +255,48 @@ type MssPackage struct { // A MediaPackage VOD PackagingConfiguration resource. type PackagingConfiguration struct { - // The ID of the PackagingConfiguration. - Id *string - - // An HTTP Live Streaming (HLS) packaging configuration. - HlsPackage *HlsPackage + // The ARN of the PackagingConfiguration. + Arn *string - // The ID of a PackagingGroup. - PackagingGroupId *string + // A CMAF packaging configuration. + CmafPackage *CmafPackage // A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. DashPackage *DashPackage - // The ARN of the PackagingConfiguration. - Arn *string - - // A collection of tags associated with a resource - Tags map[string]*string + // An HTTP Live Streaming (HLS) packaging configuration. + HlsPackage *HlsPackage - // A CMAF packaging configuration. - CmafPackage *CmafPackage + // The ID of the PackagingConfiguration. + Id *string // A Microsoft Smooth Streaming (MSS) PackagingConfiguration. MssPackage *MssPackage -} -// A MediaPackage VOD PackagingGroup resource. -type PackagingGroup struct { + // The ID of a PackagingGroup. + PackagingGroupId *string // A collection of tags associated with a resource Tags map[string]*string +} - // CDN Authorization credentials - Authorization *Authorization +// A MediaPackage VOD PackagingGroup resource. +type PackagingGroup struct { // The ARN of the PackagingGroup. Arn *string + // CDN Authorization credentials + Authorization *Authorization + // The fully qualified domain name for Assets in the PackagingGroup. DomainName *string // The ID of the PackagingGroup. Id *string + + // A collection of tags associated with a resource + Tags map[string]*string } // A configuration for accessing an external Secure Packager and Encoder Key @@ -309,26 +309,26 @@ type SpekeKeyProvider struct { // This member is required. RoleArn *string - // The URL of the external key provider service. + // The system IDs to include in key requests. // // This member is required. - Url *string + SystemIds []*string - // The system IDs to include in key requests. + // The URL of the external key provider service. // // This member is required. - SystemIds []*string + Url *string } // A StreamSelection configuration. type StreamSelection struct { + // The maximum video bitrate (bps) to include in output. + MaxVideoBitsPerSecond *int32 + // The minimum video bitrate (bps) to include in output. MinVideoBitsPerSecond *int32 // A directive that determines the order of streams in the output. StreamOrder StreamOrder - - // The maximum video bitrate (bps) to include in output. - MaxVideoBitsPerSecond *int32 } diff --git a/service/mediastore/api_op_ListContainers.go b/service/mediastore/api_op_ListContainers.go index 1e807e2f820..a059cbc7832 100644 --- a/service/mediastore/api_op_ListContainers.go +++ b/service/mediastore/api_op_ListContainers.go @@ -63,29 +63,29 @@ func (c *Client) ListContainers(ctx context.Context, params *ListContainersInput type ListContainersInput struct { + // Enter the maximum number of containers in the response. Use from 1 to 255 + // characters. + MaxResults *int32 + // Only if you used MaxResults in the first command, enter the token (which was // included in the previous response) to obtain the next set of containers. This // token is included in a response only if there actually are more containers to // list. NextToken *string - - // Enter the maximum number of containers in the response. Use from 1 to 255 - // characters. - MaxResults *int32 } type ListContainersOutput struct { - // NextToken is the token to use in the next call to ListContainers. This token is - // returned only if you included the MaxResults tag in the original command, and - // only if there are still containers to return. - NextToken *string - // The names of the containers. // // This member is required. Containers []*types.Container + // NextToken is the token to use in the next call to ListContainers. This token is + // returned only if you included the MaxResults tag in the original command, and + // only if there are still containers to return. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mediastore/api_op_PutContainerPolicy.go b/service/mediastore/api_op_PutContainerPolicy.go index 8ccf48a21fb..fd6823cb4a6 100644 --- a/service/mediastore/api_op_PutContainerPolicy.go +++ b/service/mediastore/api_op_PutContainerPolicy.go @@ -61,6 +61,11 @@ func (c *Client) PutContainerPolicy(ctx context.Context, params *PutContainerPol type PutContainerPolicyInput struct { + // The name of the container. + // + // This member is required. + ContainerName *string + // The contents of the policy, which includes the following: // // * One Version @@ -70,11 +75,6 @@ type PutContainerPolicyInput struct { // // This member is required. Policy *string - - // The name of the container. - // - // This member is required. - ContainerName *string } type PutContainerPolicyOutput struct { diff --git a/service/mediastore/api_op_PutCorsPolicy.go b/service/mediastore/api_op_PutCorsPolicy.go index f6e93c97263..e3b4c0b17ac 100644 --- a/service/mediastore/api_op_PutCorsPolicy.go +++ b/service/mediastore/api_op_PutCorsPolicy.go @@ -68,15 +68,15 @@ func (c *Client) PutCorsPolicy(ctx context.Context, params *PutCorsPolicyInput, type PutCorsPolicyInput struct { - // The CORS policy to apply to the container. + // The name of the container that you want to assign the CORS policy to. // // This member is required. - CorsPolicy []*types.CorsRule + ContainerName *string - // The name of the container that you want to assign the CORS policy to. + // The CORS policy to apply to the container. // // This member is required. - ContainerName *string + CorsPolicy []*types.CorsRule } type PutCorsPolicyOutput struct { diff --git a/service/mediastore/go.mod b/service/mediastore/go.mod index 4129663707d..777cafbf414 100644 --- a/service/mediastore/go.mod +++ b/service/mediastore/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/mediastore go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/mediastore/types/types.go b/service/mediastore/types/types.go index d7d59ae9e6d..176bff009e7 100644 --- a/service/mediastore/types/types.go +++ b/service/mediastore/types/types.go @@ -10,23 +10,11 @@ import ( // MediaStore container. type Container struct { - // The DNS endpoint of the container. Use the endpoint to identify the specific - // container when sending requests to the data plane. The service assigns this - // value when the container is created. Once the value has been assigned, it does - // not change. - Endpoint *string - // The Amazon Resource Name (ARN) of the container. The ARN has the following // format: arn:aws:::container/ For example: // arn:aws:mediastore:us-west-2:111122223333:container/movies ARN *string - // The status of container creation or deletion. The status is one of the - // following: CREATING, ACTIVE, or DELETING. While the service is creating the - // container, the status is CREATING. When the endpoint is available, the status - // changes to ACTIVE. - Status ContainerStatus - // The state of access logging on the container. This value is false by default, // indicating that AWS Elemental MediaStore does not send access logs to Amazon // CloudWatch Logs. When you enable access logging on the container, MediaStore @@ -37,24 +25,26 @@ type Container struct { // Unix timestamp. CreationTime *time.Time + // The DNS endpoint of the container. Use the endpoint to identify the specific + // container when sending requests to the data plane. The service assigns this + // value when the container is created. Once the value has been assigned, it does + // not change. + Endpoint *string + // The name of the container. Name *string + + // The status of container creation or deletion. The status is one of the + // following: CREATING, ACTIVE, or DELETING. While the service is creating the + // container, the status is CREATING. When the endpoint is available, the status + // changes to ACTIVE. + Status ContainerStatus } // A rule for a CORS policy. You can add up to 100 rules to a CORS policy. If more // than one rule applies, the service uses the first applicable rule listed. type CorsRule struct { - // One or more headers in the response that you want users to be able to access - // from their applications (for example, from a JavaScript XMLHttpRequest object). - // This element is optional for each rule. - ExposeHeaders []*string - - // Identifies an HTTP method that the origin that is specified in the rule is - // allowed to execute. Each CORS rule must contain at least one AllowedMethods and - // one AllowedOrigins element. - AllowedMethods []MethodName - // Specifies which headers are allowed in a preflight OPTIONS request through the // Access-Control-Request-Headers header. Each header name that is specified in // Access-Control-Request-Headers must have a corresponding entry in the rule. Only @@ -64,10 +54,6 @@ type CorsRule struct { // This member is required. AllowedHeaders []*string - // The time in seconds that your browser caches the preflight response for the - // specified resource. A CORS rule can have only one MaxAgeSeconds element. - MaxAgeSeconds *int32 - // One or more response headers that you want users to be able to access from their // applications (for example, from a JavaScript XMLHttpRequest object). Each CORS // rule must have at least one AllowedOrigins element. The string value can include @@ -77,6 +63,20 @@ type CorsRule struct { // // This member is required. AllowedOrigins []*string + + // Identifies an HTTP method that the origin that is specified in the rule is + // allowed to execute. Each CORS rule must contain at least one AllowedMethods and + // one AllowedOrigins element. + AllowedMethods []MethodName + + // One or more headers in the response that you want users to be able to access + // from their applications (for example, from a JavaScript XMLHttpRequest object). + // This element is optional for each rule. + ExposeHeaders []*string + + // The time in seconds that your browser caches the preflight response for the + // specified resource. A CORS rule can have only one MaxAgeSeconds element. + MaxAgeSeconds *int32 } // The metric policy that is associated with the container. A metric policy allows @@ -88,6 +88,11 @@ type CorsRule struct { // (https://docs.aws.amazon.com/mediastore/latest/ug/policies-metric-examples.html). type MetricPolicy struct { + // A setting to enable or disable metrics at the container level. + // + // This member is required. + ContainerLevelMetrics ContainerLevelMetrics + // A parameter that holds an array of rules that enable metrics at the object // level. This parameter is optional, but if you choose to include it, you must // also include at least one rule. By default, you can include up to five rules. @@ -95,11 +100,6 @@ type MetricPolicy struct { // (https://console.aws.amazon.com/servicequotas/home?region=us-east-1#!/services/mediastore/quotas) // to allow up to 300 rules per policy. MetricPolicyRules []*MetricPolicyRule - - // A setting to enable or disable metrics at the container level. - // - // This member is required. - ContainerLevelMetrics ContainerLevelMetrics } // A setting that enables metrics at the object level. Each rule contains an object @@ -131,14 +131,14 @@ type MetricPolicyRule struct { // MediaStore (https://docs.aws.amazon.com/mediastore/latest/ug/tagging.html). type Tag struct { - // Part of the key:value pair that defines a tag. You can use a tag value to - // describe a specific value within a category, such as "companyA" or "companyB." - // Tag values are case-sensitive. - Value *string - // Part of the key:value pair that defines a tag. You can use a tag key to describe // a category of information, such as "customer." Tag keys are case-sensitive. // // This member is required. Key *string + + // Part of the key:value pair that defines a tag. You can use a tag value to + // describe a specific value within a category, such as "companyA" or "companyB." + // Tag values are case-sensitive. + Value *string } diff --git a/service/mediastoredata/api_op_DescribeObject.go b/service/mediastoredata/api_op_DescribeObject.go index 7641b1f1f45..f9f692eca1c 100644 --- a/service/mediastoredata/api_op_DescribeObject.go +++ b/service/mediastoredata/api_op_DescribeObject.go @@ -66,12 +66,6 @@ type DescribeObjectInput struct { type DescribeObjectOutput struct { - // The date and time that the object was last modified. - LastModified *time.Time - - // The content type of the object. - ContentType *string - // An optional CacheControl header that allows the caller to control the object's // cache behavior. Headers can be passed in as specified in the HTTP at // https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9 @@ -79,11 +73,17 @@ type DescribeObjectOutput struct { // a custom user-defined value are also accepted. CacheControl *string + // The length of the object in bytes. + ContentLength *int64 + + // The content type of the object. + ContentType *string + // The ETag that represents a unique instance of the object. ETag *string - // The length of the object in bytes. - ContentLength *int64 + // The date and time that the object was last modified. + LastModified *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/mediastoredata/api_op_GetObject.go b/service/mediastoredata/api_op_GetObject.go index b209461c002..6558e8d771b 100644 --- a/service/mediastoredata/api_op_GetObject.go +++ b/service/mediastoredata/api_op_GetObject.go @@ -84,11 +84,8 @@ type GetObjectInput struct { type GetObjectOutput struct { - // The content type of the object. - ContentType *string - - // The length of the object in bytes. - ContentLength *int64 + // The bytes of the object. + Body io.ReadCloser // An optional CacheControl header that allows the caller to control the object's // cache behavior. Headers can be passed in as specified in the HTTP spec at @@ -97,18 +94,21 @@ type GetObjectOutput struct { // a custom user-defined value are also accepted. CacheControl *string + // The length of the object in bytes. + ContentLength *int64 + // The range of bytes to retrieve. ContentRange *string + // The content type of the object. + ContentType *string + // The ETag that represents a unique instance of the object. ETag *string // The date and time that the object was last modified. LastModified *time.Time - // The bytes of the object. - Body io.ReadCloser - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mediastoredata/api_op_ListItems.go b/service/mediastoredata/api_op_ListItems.go index 66ce3f08585..9cd68555340 100644 --- a/service/mediastoredata/api_op_ListItems.go +++ b/service/mediastoredata/api_op_ListItems.go @@ -57,16 +57,6 @@ func (c *Client) ListItems(ctx context.Context, params *ListItemsInput, optFns . type ListItemsInput struct { - // The path in the container from which to retrieve items. Format: // - Path *string - - // The token that identifies which batch of results that you want to see. For - // example, you submit a ListItems request with MaxResults set at 500. The service - // returns the first batch of results (up to 500) and a NextToken value. To see the - // next batch of results, you can submit the ListItems request a second time and - // specify the NextToken value. Tokens expire after 15 minutes. - NextToken *string - // The maximum number of results to return per API request. For example, you submit // a ListItems request with MaxResults set at 500. Although 2,000 items match your // request, the service returns no more than the first 500 items. (The service also @@ -75,6 +65,16 @@ type ListItemsInput struct { // is not included in the request, the service defaults to pagination with a // maximum of 1,000 results per page. MaxResults *int32 + + // The token that identifies which batch of results that you want to see. For + // example, you submit a ListItems request with MaxResults set at 500. The service + // returns the first batch of results (up to 500) and a NextToken value. To see the + // next batch of results, you can submit the ListItems request a second time and + // specify the NextToken value. Tokens expire after 15 minutes. + NextToken *string + + // The path in the container from which to retrieve items. Format: // + Path *string } type ListItemsOutput struct { diff --git a/service/mediastoredata/api_op_PutObject.go b/service/mediastoredata/api_op_PutObject.go index 7267c6e1a7e..18ac645241a 100644 --- a/service/mediastoredata/api_op_PutObject.go +++ b/service/mediastoredata/api_op_PutObject.go @@ -59,20 +59,10 @@ func (c *Client) PutObject(ctx context.Context, params *PutObjectInput, optFns . type PutObjectInput struct { - // Indicates the storage class of a Put request. Defaults to high-performance - // temporal storage class, and objects are persisted into durable storage shortly - // after being received. - StorageClass types.StorageClass - - // An optional CacheControl header that allows the caller to control the object's - // cache behavior. Headers can be passed in as specified in the HTTP at - // https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9 - // (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9). Headers with - // a custom user-defined value are also accepted. - CacheControl *string - - // The content type of the object. - ContentType *string + // The bytes to be stored. + // + // This member is required. + Body io.Reader // The path (including the file name) where the object is stored in the container. // Format: // For example, to upload the file mlaw.avi to the folder path @@ -93,20 +83,30 @@ type PutObjectInput struct { // This member is required. Path *string - // The bytes to be stored. - // - // This member is required. - Body io.Reader + // An optional CacheControl header that allows the caller to control the object's + // cache behavior. Headers can be passed in as specified in the HTTP at + // https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9 + // (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9). Headers with + // a custom user-defined value are also accepted. + CacheControl *string + + // The content type of the object. + ContentType *string + + // Indicates the storage class of a Put request. Defaults to high-performance + // temporal storage class, and objects are persisted into durable storage shortly + // after being received. + StorageClass types.StorageClass } type PutObjectOutput struct { - // Unique identifier of the object in the container. - ETag *string - // The SHA256 digest of the object that is persisted. ContentSHA256 *string + // Unique identifier of the object in the container. + ETag *string + // The storage class where the object was persisted. The class should be // “Temporal”. StorageClass types.StorageClass diff --git a/service/mediastoredata/go.mod b/service/mediastoredata/go.mod index 59d936c018a..8ddc7c389b9 100644 --- a/service/mediastoredata/go.mod +++ b/service/mediastoredata/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/mediastoredata go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/mediastoredata/types/types.go b/service/mediastoredata/types/types.go index e3c5cf96b91..72df444027d 100644 --- a/service/mediastoredata/types/types.go +++ b/service/mediastoredata/types/types.go @@ -9,21 +9,21 @@ import ( // A metadata entry for a folder or object. type Item struct { - // The name of the item. - Name *string - - // The item type (folder or object). - Type ItemType - // The length of the item in bytes. ContentLength *int64 - // The ETag that represents a unique instance of the item. - ETag *string - // The content type of the item. ContentType *string + // The ETag that represents a unique instance of the item. + ETag *string + // The date and time that the item was last modified. LastModified *time.Time + + // The name of the item. + Name *string + + // The item type (folder or object). + Type ItemType } diff --git a/service/mediatailor/api_op_GetPlaybackConfiguration.go b/service/mediatailor/api_op_GetPlaybackConfiguration.go index 07b16892ffa..7eb287ef515 100644 --- a/service/mediatailor/api_op_GetPlaybackConfiguration.go +++ b/service/mediatailor/api_op_GetPlaybackConfiguration.go @@ -65,41 +65,51 @@ type GetPlaybackConfigurationInput struct { type GetPlaybackConfigurationOutput struct { - // The configuration for HLS content. - HlsConfiguration *types.HlsConfiguration + // The URL for the ad decision server (ADS). This includes the specification of + // static parameters and placeholders for dynamic parameters. AWS Elemental + // MediaTailor substitutes player-specific and session-specific parameters as + // needed when calling the ADS. Alternately, for testing, you can provide a static + // VAST URL. The maximum length is 25,000 characters. + AdDecisionServerUrl *string - // The URL prefix for the master playlist for the stream, minus the asset ID. The - // maximum length is 512 characters. - VideoContentSourceUrl *string + // The configuration for Avail Suppression. Ad suppression can be used to turn off + // ad personalization in a long manifest, or if a viewer joins mid-break. + AvailSuppression *types.AvailSuppression - // The Amazon Resource Name (ARN) for the playback configuration. - PlaybackConfigurationArn *string + // The configuration for bumpers. Bumpers are short audio or video clips that play + // at the start or before the end of an ad break. + Bumper *types.Bumper + + // The configuration for using a content delivery network (CDN), like Amazon + // CloudFront, for content and ad segment management. + CdnConfiguration *types.CdnConfiguration + + // The configuration for DASH content. + DashConfiguration *types.DashConfiguration + + // The configuration for HLS content. + HlsConfiguration *types.HlsConfiguration // The configuration for pre-roll ad insertion. LivePreRollConfiguration *types.LivePreRollConfiguration - // The URL that the player uses to initialize a session that uses client-side - // reporting. - SessionInitializationEndpointPrefix *string - // The identifier for the playback configuration. Name *string - // The configuration for Avail Suppression. Ad suppression can be used to turn off - // ad personalization in a long manifest, or if a viewer joins mid-break. - AvailSuppression *types.AvailSuppression - // The maximum duration of underfilled ad time (in seconds) allowed in an ad break. PersonalizationThresholdSeconds *int32 - // The configuration for using a content delivery network (CDN), like Amazon - // CloudFront, for content and ad segment management. - CdnConfiguration *types.CdnConfiguration + // The Amazon Resource Name (ARN) for the playback configuration. + PlaybackConfigurationArn *string // The URL that the player accesses to get a manifest from AWS Elemental // MediaTailor. This session will use server-side reporting. PlaybackEndpointPrefix *string + // The URL that the player uses to initialize a session that uses client-side + // reporting. + SessionInitializationEndpointPrefix *string + // The URL for a high-quality video asset to transcode and use to fill in time // that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in // gaps in media content. Configuring the slate is optional for non-VPAID playback @@ -108,28 +118,18 @@ type GetPlaybackConfigurationOutput struct { // asset that contains both audio and video. SlateAdUrl *string + // The tags assigned to the playback configuration. + Tags map[string]*string + // The name that is used to associate this playback configuration with a custom // transcode profile. This overrides the dynamic transcoding defaults of // MediaTailor. Use this only if you have already set up custom profiles with the // help of AWS Support. TranscodeProfileName *string - // The configuration for DASH content. - DashConfiguration *types.DashConfiguration - - // The tags assigned to the playback configuration. - Tags map[string]*string - - // The URL for the ad decision server (ADS). This includes the specification of - // static parameters and placeholders for dynamic parameters. AWS Elemental - // MediaTailor substitutes player-specific and session-specific parameters as - // needed when calling the ADS. Alternately, for testing, you can provide a static - // VAST URL. The maximum length is 25,000 characters. - AdDecisionServerUrl *string - - // The configuration for bumpers. Bumpers are short audio or video clips that play - // at the start or before the end of an ad break. - Bumper *types.Bumper + // The URL prefix for the master playlist for the stream, minus the asset ID. The + // maximum length is 512 characters. + VideoContentSourceUrl *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/mediatailor/api_op_ListPlaybackConfigurations.go b/service/mediatailor/api_op_ListPlaybackConfigurations.go index a24d44f3257..15964376dfe 100644 --- a/service/mediatailor/api_op_ListPlaybackConfigurations.go +++ b/service/mediatailor/api_op_ListPlaybackConfigurations.go @@ -70,15 +70,15 @@ type ListPlaybackConfigurationsInput struct { type ListPlaybackConfigurationsOutput struct { - // Pagination token returned by the GET list request when results exceed the - // maximum allowed. Use the token to fetch the next page of results. - NextToken *string - // Array of playback configurations. This might be all the available configurations // or a subset, depending on the settings that you provide and the total number of // configurations stored. Items []*types.PlaybackConfiguration + // Pagination token returned by the GET list request when results exceed the + // maximum allowed. Use the token to fetch the next page of results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mediatailor/api_op_PutPlaybackConfiguration.go b/service/mediatailor/api_op_PutPlaybackConfiguration.go index 711c60557b0..497265cc7c2 100644 --- a/service/mediatailor/api_op_PutPlaybackConfiguration.go +++ b/service/mediatailor/api_op_PutPlaybackConfiguration.go @@ -56,17 +56,37 @@ func (c *Client) PutPlaybackConfiguration(ctx context.Context, params *PutPlayba type PutPlaybackConfigurationInput struct { - // The URL prefix for the master playlist for the stream, minus the asset ID. The - // maximum length is 512 characters. - VideoContentSourceUrl *string + // The URL for the ad decision server (ADS). This includes the specification of + // static parameters and placeholders for dynamic parameters. AWS Elemental + // MediaTailor substitutes player-specific and session-specific parameters as + // needed when calling the ADS. Alternately, for testing you can provide a static + // VAST URL. The maximum length is 25,000 characters. + AdDecisionServerUrl *string // The configuration for Avail Suppression. Ad suppression can be used to turn off // ad personalization in a long manifest, or if a viewer joins mid-break. AvailSuppression *types.AvailSuppression + // The configuration for bumpers. Bumpers are short audio or video clips that play + // at the start or before the end of an ad break. + Bumper *types.Bumper + + // The configuration for using a content delivery network (CDN), like Amazon + // CloudFront, for content and ad segment management. + CdnConfiguration *types.CdnConfiguration + + // The configuration for DASH content. + DashConfiguration *types.DashConfigurationForPut + + // The configuration for pre-roll ad insertion. + LivePreRollConfiguration *types.LivePreRollConfiguration + // The identifier for the playback configuration. Name *string + // The maximum duration of underfilled ad time (in seconds) allowed in an ad break. + PersonalizationThresholdSeconds *int32 + // The URL for a high-quality video asset to transcode and use to fill in time // that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in // gaps in media content. Configuring the slate is optional for non-VPAID @@ -75,8 +95,8 @@ type PutPlaybackConfigurationInput struct { // high-quality asset that contains both audio and video. SlateAdUrl *string - // The configuration for DASH content. - DashConfiguration *types.DashConfigurationForPut + // The tags to assign to the playback configuration. + Tags map[string]*string // The name that is used to associate this playback configuration with a custom // transcode profile. This overrides the dynamic transcoding defaults of @@ -84,39 +104,13 @@ type PutPlaybackConfigurationInput struct { // help of AWS Support. TranscodeProfileName *string - // The URL for the ad decision server (ADS). This includes the specification of - // static parameters and placeholders for dynamic parameters. AWS Elemental - // MediaTailor substitutes player-specific and session-specific parameters as - // needed when calling the ADS. Alternately, for testing you can provide a static - // VAST URL. The maximum length is 25,000 characters. - AdDecisionServerUrl *string - - // The tags to assign to the playback configuration. - Tags map[string]*string - - // The configuration for using a content delivery network (CDN), like Amazon - // CloudFront, for content and ad segment management. - CdnConfiguration *types.CdnConfiguration - - // The configuration for bumpers. Bumpers are short audio or video clips that play - // at the start or before the end of an ad break. - Bumper *types.Bumper - - // The maximum duration of underfilled ad time (in seconds) allowed in an ad break. - PersonalizationThresholdSeconds *int32 - - // The configuration for pre-roll ad insertion. - LivePreRollConfiguration *types.LivePreRollConfiguration + // The URL prefix for the master playlist for the stream, minus the asset ID. The + // maximum length is 512 characters. + VideoContentSourceUrl *string } type PutPlaybackConfigurationOutput struct { - // The name that is used to associate this playback configuration with a custom - // transcode profile. This overrides the dynamic transcoding defaults of - // MediaTailor. Use this only if you have already set up custom profiles with the - // help of AWS Support. - TranscodeProfileName *string - // The URL for the ad decision server (ADS). This includes the specification of // static parameters and placeholders for dynamic parameters. AWS Elemental // MediaTailor substitutes player-specific and session-specific parameters as @@ -124,48 +118,44 @@ type PutPlaybackConfigurationOutput struct { // VAST URL. The maximum length is 25,000 characters. AdDecisionServerUrl *string - // The configuration for using a content delivery network (CDN), like Amazon - // CloudFront, for content and ad segment management. - CdnConfiguration *types.CdnConfiguration - - // The identifier for the playback configuration. - Name *string - - // The Amazon Resource Name (ARN) for the playback configuration. - PlaybackConfigurationArn *string - - // The URL that the player uses to initialize a session that uses client-side - // reporting. - SessionInitializationEndpointPrefix *string - - // The configuration for HLS content. - HlsConfiguration *types.HlsConfiguration - - // The URL prefix for the master playlist for the stream, minus the asset ID. The - // maximum length is 512 characters. - VideoContentSourceUrl *string + // The configuration for Avail Suppression. Ad suppression can be used to turn off + // ad personalization in a long manifest, or if a viewer joins mid-break. + AvailSuppression *types.AvailSuppression // The configuration for bumpers. Bumpers are short audio or video clips that play // at the start or before the end of an ad break. Bumper *types.Bumper + // The configuration for using a content delivery network (CDN), like Amazon + // CloudFront, for content and ad segment management. + CdnConfiguration *types.CdnConfiguration + // The configuration for DASH content. DashConfiguration *types.DashConfiguration + // The configuration for HLS content. + HlsConfiguration *types.HlsConfiguration + // The configuration for pre-roll ad insertion. LivePreRollConfiguration *types.LivePreRollConfiguration + // The identifier for the playback configuration. + Name *string + // The maximum duration of underfilled ad time (in seconds) allowed in an ad break. PersonalizationThresholdSeconds *int32 - // The configuration for Avail Suppression. Ad suppression can be used to turn off - // ad personalization in a long manifest, or if a viewer joins mid-break. - AvailSuppression *types.AvailSuppression + // The Amazon Resource Name (ARN) for the playback configuration. + PlaybackConfigurationArn *string // The URL that the player accesses to get a manifest from AWS Elemental // MediaTailor. This session will use server-side reporting. PlaybackEndpointPrefix *string + // The URL that the player uses to initialize a session that uses client-side + // reporting. + SessionInitializationEndpointPrefix *string + // The URL for a high-quality video asset to transcode and use to fill in time // that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in // gaps in media content. Configuring the slate is optional for non-VPAID playback @@ -177,6 +167,16 @@ type PutPlaybackConfigurationOutput struct { // The tags assigned to the playback configuration. Tags map[string]*string + // The name that is used to associate this playback configuration with a custom + // transcode profile. This overrides the dynamic transcoding defaults of + // MediaTailor. Use this only if you have already set up custom profiles with the + // help of AWS Support. + TranscodeProfileName *string + + // The URL prefix for the master playlist for the stream, minus the asset ID. The + // maximum length is 512 characters. + VideoContentSourceUrl *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mediatailor/api_op_UntagResource.go b/service/mediatailor/api_op_UntagResource.go index 9abec1e1e3b..97f061c2acf 100644 --- a/service/mediatailor/api_op_UntagResource.go +++ b/service/mediatailor/api_op_UntagResource.go @@ -57,17 +57,17 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // A comma-separated list of the tag keys to remove from the playback - // configuration. - // - // This member is required. - TagKeys []*string - // The Amazon Resource Name (ARN) for the playback configuration. You can get this // from the response to any playback configuration request. // // This member is required. ResourceArn *string + + // A comma-separated list of the tag keys to remove from the playback + // configuration. + // + // This member is required. + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/mediatailor/go.mod b/service/mediatailor/go.mod index e0e4455dc2b..00281925a8d 100644 --- a/service/mediatailor/go.mod +++ b/service/mediatailor/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/mediatailor go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/mediatailor/types/types.go b/service/mediatailor/types/types.go index bcda5b0bd71..e9fbf8873eb 100644 --- a/service/mediatailor/types/types.go +++ b/service/mediatailor/types/types.go @@ -6,14 +6,14 @@ package types // ad personalization in a long manifest, or if a viewer joins mid-break. type AvailSuppression struct { - // The avail suppression value is a live edge offset time in HH:MM:SS. MediaTailor - // won't fill ad breaks on or behind this time in the manifest lookback window. - Value *string - // Sets the mode for avail suppression, also known as ad suppression. By default, // ad suppression is off and all ad breaks are filled by MediaTailor with ads or // slate. Mode Mode + + // The avail suppression value is a live edge offset time in HH:MM:SS. MediaTailor + // won't fill ad breaks on or behind this time in the manifest lookback window. + Value *string } // The configuration for bumpers. Bumpers are short audio or video clips that play @@ -31,13 +31,6 @@ type Bumper struct { // CloudFront, for content and ad segment management. type CdnConfiguration struct { - // A content delivery network (CDN) to cache content segments, so that content - // requests don’t always have to go to the origin server. First, create a rule in - // your CDN for the content segment origin server. Then specify the rule's name in - // this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, - // it reports your CDN as the source for content segments. - ContentSegmentUrlPrefix *string - // A non-default content delivery network (CDN) to serve ad segments. By default, // AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as // its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN @@ -45,6 +38,13 @@ type CdnConfiguration struct { // the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor // serves a manifest, it reports your CDN as the source for ad segments. AdSegmentUrlPrefix *string + + // A content delivery network (CDN) to cache content segments, so that content + // requests don’t always have to go to the origin server. First, create a rule in + // your CDN for the content segment origin server. Then specify the rule's name in + // this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, + // it reports your CDN as the source for content segments. + ContentSegmentUrlPrefix *string } // The configuration for DASH content. @@ -74,13 +74,6 @@ type DashConfiguration struct { // The configuration for DASH PUT operations. type DashConfigurationForPut struct { - // The setting that controls whether MediaTailor handles manifests from the origin - // server as multi-period manifests or single-period manifests. If your origin - // server produces single-period manifests, set this to SINGLE_PERIOD. The default - // setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it - // to MULTI_PERIOD. - OriginManifestType OriginManifestType - // The setting that controls whether MediaTailor includes the Location tag in DASH // manifests. MediaTailor populates the Location tag with the URL for manifest // update requests, to be used by players that don't support sticky redirects. @@ -89,6 +82,13 @@ type DashConfigurationForPut struct { // support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The // EMT_DEFAULT setting enables the inclusion of the tag and is the default value. MpdLocation *string + + // The setting that controls whether MediaTailor handles manifests from the origin + // server as multi-period manifests or single-period manifests. If your origin + // server produces single-period manifests, set this to SINGLE_PERIOD. The default + // setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it + // to MULTI_PERIOD. + OriginManifestType OriginManifestType } // The configuration for HLS content. @@ -118,13 +118,6 @@ type LivePreRollConfiguration struct { // The AWSMediaTailor configuration. type PlaybackConfiguration struct { - // The URL prefix for the master playlist for the stream, minus the asset ID. The - // maximum length is 512 characters. - VideoContentSourceUrl *string - - // The configuration for HLS content. - HlsConfiguration *HlsConfiguration - // The URL for the ad decision server (ADS). This includes the specification of // static parameters and placeholders for dynamic parameters. AWS Elemental // MediaTailor substitutes player-specific and session-specific parameters as @@ -132,36 +125,41 @@ type PlaybackConfiguration struct { // VAST URL. The maximum length is 25,000 characters. AdDecisionServerUrl *string - // The configuration for DASH content. - DashConfiguration *DashConfiguration + // The configuration for Avail Suppression. Ad suppression can be used to turn off + // ad personalization in a long manifest, or if a viewer joins mid-break. + AvailSuppression *AvailSuppression // The configuration for bumpers. Bumpers are short audio or video clips that play // at the start or before the end of an ad break. Bumper *Bumper - // The Amazon Resource Name (ARN) for the playback configuration. - PlaybackConfigurationArn *string - - // The maximum duration of underfilled ad time (in seconds) allowed in an ad break. - PersonalizationThresholdSeconds *int32 - // The configuration for using a content delivery network (CDN), like Amazon // CloudFront, for content and ad segment management. CdnConfiguration *CdnConfiguration - // The name that is used to associate this playback configuration with a custom - // transcode profile. This overrides the dynamic transcoding defaults of - // MediaTailor. Use this only if you have already set up custom profiles with the - // help of AWS Support. - TranscodeProfileName *string + // The configuration for DASH content. + DashConfiguration *DashConfiguration - // The configuration for Avail Suppression. Ad suppression can be used to turn off - // ad personalization in a long manifest, or if a viewer joins mid-break. - AvailSuppression *AvailSuppression + // The configuration for HLS content. + HlsConfiguration *HlsConfiguration // The identifier for the playback configuration. Name *string + // The maximum duration of underfilled ad time (in seconds) allowed in an ad break. + PersonalizationThresholdSeconds *int32 + + // The Amazon Resource Name (ARN) for the playback configuration. + PlaybackConfigurationArn *string + + // The URL that the player accesses to get a manifest from AWS Elemental + // MediaTailor. This session will use server-side reporting. + PlaybackEndpointPrefix *string + + // The URL that the player uses to initialize a session that uses client-side + // reporting. + SessionInitializationEndpointPrefix *string + // The URL for a high-quality video asset to transcode and use to fill in time // that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in // gaps in media content. Configuring the slate is optional for non-VPAID playback @@ -173,11 +171,13 @@ type PlaybackConfiguration struct { // The tags assigned to the playback configuration. Tags map[string]*string - // The URL that the player accesses to get a manifest from AWS Elemental - // MediaTailor. This session will use server-side reporting. - PlaybackEndpointPrefix *string + // The name that is used to associate this playback configuration with a custom + // transcode profile. This overrides the dynamic transcoding defaults of + // MediaTailor. Use this only if you have already set up custom profiles with the + // help of AWS Support. + TranscodeProfileName *string - // The URL that the player uses to initialize a session that uses client-side - // reporting. - SessionInitializationEndpointPrefix *string + // The URL prefix for the master playlist for the stream, minus the asset ID. The + // maximum length is 512 characters. + VideoContentSourceUrl *string } diff --git a/service/migrationhub/api_op_AssociateCreatedArtifact.go b/service/migrationhub/api_op_AssociateCreatedArtifact.go index 21411860c29..77957f1a5cb 100644 --- a/service/migrationhub/api_op_AssociateCreatedArtifact.go +++ b/service/migrationhub/api_op_AssociateCreatedArtifact.go @@ -71,6 +71,12 @@ func (c *Client) AssociateCreatedArtifact(ctx context.Context, params *Associate type AssociateCreatedArtifactInput struct { + // An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, + // RDS instance, etc.) + // + // This member is required. + CreatedArtifact *types.CreatedArtifact + // Unique identifier that references the migration task. Do not store personal data // in this field. // @@ -85,12 +91,6 @@ type AssociateCreatedArtifactInput struct { // Optional boolean flag to indicate whether any effect should take place. Used to // test if the caller has permission to make the call. DryRun *bool - - // An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, - // RDS instance, etc.) - // - // This member is required. - CreatedArtifact *types.CreatedArtifact } type AssociateCreatedArtifactOutput struct { diff --git a/service/migrationhub/api_op_AssociateDiscoveredResource.go b/service/migrationhub/api_op_AssociateDiscoveredResource.go index b0f75cedff2..772edffe5ee 100644 --- a/service/migrationhub/api_op_AssociateDiscoveredResource.go +++ b/service/migrationhub/api_op_AssociateDiscoveredResource.go @@ -69,14 +69,14 @@ type AssociateDiscoveredResourceInput struct { // This member is required. MigrationTaskName *string - // Optional boolean flag to indicate whether any effect should take place. Used to - // test if the caller has permission to make the call. - DryRun *bool - // The name of the ProgressUpdateStream. // // This member is required. ProgressUpdateStream *string + + // Optional boolean flag to indicate whether any effect should take place. Used to + // test if the caller has permission to make the call. + DryRun *bool } type AssociateDiscoveredResourceOutput struct { diff --git a/service/migrationhub/api_op_CreateProgressUpdateStream.go b/service/migrationhub/api_op_CreateProgressUpdateStream.go index 57629ef5cc4..0c77065db23 100644 --- a/service/migrationhub/api_op_CreateProgressUpdateStream.go +++ b/service/migrationhub/api_op_CreateProgressUpdateStream.go @@ -60,14 +60,14 @@ func (c *Client) CreateProgressUpdateStream(ctx context.Context, params *CreateP type CreateProgressUpdateStreamInput struct { - // Optional boolean flag to indicate whether any effect should take place. Used to - // test if the caller has permission to make the call. - DryRun *bool - // The name of the ProgressUpdateStream. Do not store personal data in this field. // // This member is required. ProgressUpdateStreamName *string + + // Optional boolean flag to indicate whether any effect should take place. Used to + // test if the caller has permission to make the call. + DryRun *bool } type CreateProgressUpdateStreamOutput struct { diff --git a/service/migrationhub/api_op_DeleteProgressUpdateStream.go b/service/migrationhub/api_op_DeleteProgressUpdateStream.go index 1c6ee3efca4..011c4420e67 100644 --- a/service/migrationhub/api_op_DeleteProgressUpdateStream.go +++ b/service/migrationhub/api_op_DeleteProgressUpdateStream.go @@ -80,14 +80,14 @@ func (c *Client) DeleteProgressUpdateStream(ctx context.Context, params *DeleteP type DeleteProgressUpdateStreamInput struct { - // Optional boolean flag to indicate whether any effect should take place. Used to - // test if the caller has permission to make the call. - DryRun *bool - // The name of the ProgressUpdateStream. Do not store personal data in this field. // // This member is required. ProgressUpdateStreamName *string + + // Optional boolean flag to indicate whether any effect should take place. Used to + // test if the caller has permission to make the call. + DryRun *bool } type DeleteProgressUpdateStreamOutput struct { diff --git a/service/migrationhub/api_op_DisassociateCreatedArtifact.go b/service/migrationhub/api_op_DisassociateCreatedArtifact.go index 84eaddcc37e..627d5dd883c 100644 --- a/service/migrationhub/api_op_DisassociateCreatedArtifact.go +++ b/service/migrationhub/api_op_DisassociateCreatedArtifact.go @@ -70,26 +70,26 @@ func (c *Client) DisassociateCreatedArtifact(ctx context.Context, params *Disass type DisassociateCreatedArtifactInput struct { + // An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, + // RDS instance, etc.) + // + // This member is required. + CreatedArtifactName *string + // Unique identifier that references the migration task to be disassociated with // the artifact. Do not store personal data in this field. // // This member is required. MigrationTaskName *string - // Optional boolean flag to indicate whether any effect should take place. Used to - // test if the caller has permission to make the call. - DryRun *bool - // The name of the ProgressUpdateStream. // // This member is required. ProgressUpdateStream *string - // An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, - // RDS instance, etc.) - // - // This member is required. - CreatedArtifactName *string + // Optional boolean flag to indicate whether any effect should take place. Used to + // test if the caller has permission to make the call. + DryRun *bool } type DisassociateCreatedArtifactOutput struct { diff --git a/service/migrationhub/api_op_DisassociateDiscoveredResource.go b/service/migrationhub/api_op_DisassociateDiscoveredResource.go index c31d49934e7..5e2e30898fb 100644 --- a/service/migrationhub/api_op_DisassociateDiscoveredResource.go +++ b/service/migrationhub/api_op_DisassociateDiscoveredResource.go @@ -57,15 +57,6 @@ func (c *Client) DisassociateDiscoveredResource(ctx context.Context, params *Dis type DisassociateDiscoveredResourceInput struct { - // The name of the ProgressUpdateStream. - // - // This member is required. - ProgressUpdateStream *string - - // Optional boolean flag to indicate whether any effect should take place. Used to - // test if the caller has permission to make the call. - DryRun *bool - // ConfigurationId of the Application Discovery Service resource to be // disassociated. // @@ -77,6 +68,15 @@ type DisassociateDiscoveredResourceInput struct { // // This member is required. MigrationTaskName *string + + // The name of the ProgressUpdateStream. + // + // This member is required. + ProgressUpdateStream *string + + // Optional boolean flag to indicate whether any effect should take place. Used to + // test if the caller has permission to make the call. + DryRun *bool } type DisassociateDiscoveredResourceOutput struct { diff --git a/service/migrationhub/api_op_ListApplicationStates.go b/service/migrationhub/api_op_ListApplicationStates.go index a542ccb69d7..849d87840e9 100644 --- a/service/migrationhub/api_op_ListApplicationStates.go +++ b/service/migrationhub/api_op_ListApplicationStates.go @@ -58,29 +58,29 @@ func (c *Client) ListApplicationStates(ctx context.Context, params *ListApplicat type ListApplicationStatesInput struct { - // If a NextToken was returned by a previous call, there are more results - // available. To retrieve the next page of results, make the call again using the - // returned token in NextToken. - NextToken *string - - // Maximum number of results to be returned per page. - MaxResults *int32 - // The configurationIds from the Application Discovery Service that uniquely // identifies your applications. ApplicationIds []*string -} -type ListApplicationStatesOutput struct { + // Maximum number of results to be returned per page. + MaxResults *int32 // If a NextToken was returned by a previous call, there are more results // available. To retrieve the next page of results, make the call again using the // returned token in NextToken. NextToken *string +} + +type ListApplicationStatesOutput struct { // A list of Applications that exist in Application Discovery Service. ApplicationStateList []*types.ApplicationState + // If a NextToken was returned by a previous call, there are more results + // available. To retrieve the next page of results, make the call again using the + // returned token in NextToken. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/migrationhub/api_op_ListCreatedArtifacts.go b/service/migrationhub/api_op_ListCreatedArtifacts.go index c26095737d3..a06bcdeed58 100644 --- a/service/migrationhub/api_op_ListCreatedArtifacts.go +++ b/service/migrationhub/api_op_ListCreatedArtifacts.go @@ -73,18 +73,18 @@ type ListCreatedArtifactsInput struct { // This member is required. MigrationTaskName *string - // If a NextToken was returned by a previous call, there are more results - // available. To retrieve the next page of results, make the call again using the - // returned token in NextToken. - NextToken *string - - // Maximum number of results to be returned per page. - MaxResults *int32 - // The name of the ProgressUpdateStream. // // This member is required. ProgressUpdateStream *string + + // Maximum number of results to be returned per page. + MaxResults *int32 + + // If a NextToken was returned by a previous call, there are more results + // available. To retrieve the next page of results, make the call again using the + // returned token in NextToken. + NextToken *string } type ListCreatedArtifactsOutput struct { diff --git a/service/migrationhub/api_op_ListDiscoveredResources.go b/service/migrationhub/api_op_ListDiscoveredResources.go index a37d7b0e041..99cd8d9303f 100644 --- a/service/migrationhub/api_op_ListDiscoveredResources.go +++ b/service/migrationhub/api_op_ListDiscoveredResources.go @@ -62,18 +62,18 @@ type ListDiscoveredResourcesInput struct { // This member is required. MigrationTaskName *string - // If a NextToken was returned by a previous call, there are more results - // available. To retrieve the next page of results, make the call again using the - // returned token in NextToken. - NextToken *string - - // The maximum number of results returned per page. - MaxResults *int32 - // The name of the ProgressUpdateStream. // // This member is required. ProgressUpdateStream *string + + // The maximum number of results returned per page. + MaxResults *int32 + + // If a NextToken was returned by a previous call, there are more results + // available. To retrieve the next page of results, make the call again using the + // returned token in NextToken. + NextToken *string } type ListDiscoveredResourcesOutput struct { diff --git a/service/migrationhub/api_op_ListProgressUpdateStreams.go b/service/migrationhub/api_op_ListProgressUpdateStreams.go index fcd262c1d29..8f2deea9d09 100644 --- a/service/migrationhub/api_op_ListProgressUpdateStreams.go +++ b/service/migrationhub/api_op_ListProgressUpdateStreams.go @@ -56,13 +56,13 @@ func (c *Client) ListProgressUpdateStreams(ctx context.Context, params *ListProg type ListProgressUpdateStreamsInput struct { + // Filter to limit the maximum number of results to list per page. + MaxResults *int32 + // If a NextToken was returned by a previous call, there are more results // available. To retrieve the next page of results, make the call again using the // returned token in NextToken. NextToken *string - - // Filter to limit the maximum number of results to list per page. - MaxResults *int32 } type ListProgressUpdateStreamsOutput struct { diff --git a/service/migrationhub/api_op_NotifyApplicationState.go b/service/migrationhub/api_op_NotifyApplicationState.go index f8f6494703b..7049f6b6c40 100644 --- a/service/migrationhub/api_op_NotifyApplicationState.go +++ b/service/migrationhub/api_op_NotifyApplicationState.go @@ -60,6 +60,12 @@ func (c *Client) NotifyApplicationState(ctx context.Context, params *NotifyAppli type NotifyApplicationStateInput struct { + // The configurationId in Application Discovery Service that uniquely identifies + // the grouped application. + // + // This member is required. + ApplicationId *string + // Status of the application - Not Started, In-Progress, Complete. // // This member is required. @@ -69,12 +75,6 @@ type NotifyApplicationStateInput struct { // test if the caller has permission to make the call. DryRun *bool - // The configurationId in Application Discovery Service that uniquely identifies - // the grouped application. - // - // This member is required. - ApplicationId *string - // The timestamp when the application state changed. UpdateDateTime *time.Time } diff --git a/service/migrationhub/api_op_NotifyMigrationTaskState.go b/service/migrationhub/api_op_NotifyMigrationTaskState.go index a59f17c778a..1bc67cbead8 100644 --- a/service/migrationhub/api_op_NotifyMigrationTaskState.go +++ b/service/migrationhub/api_op_NotifyMigrationTaskState.go @@ -69,20 +69,6 @@ func (c *Client) NotifyMigrationTaskState(ctx context.Context, params *NotifyMig type NotifyMigrationTaskStateInput struct { - // The timestamp when the task was gathered. - // - // This member is required. - UpdateDateTime *time.Time - - // The name of the ProgressUpdateStream. - // - // This member is required. - ProgressUpdateStream *string - - // Optional boolean flag to indicate whether any effect should take place. Used to - // test if the caller has permission to make the call. - DryRun *bool - // Unique identifier that references the migration task. Do not store personal data // in this field. // @@ -96,10 +82,24 @@ type NotifyMigrationTaskStateInput struct { // This member is required. NextUpdateSeconds *int32 + // The name of the ProgressUpdateStream. + // + // This member is required. + ProgressUpdateStream *string + // Information about the task's progress and status. // // This member is required. Task *types.Task + + // The timestamp when the task was gathered. + // + // This member is required. + UpdateDateTime *time.Time + + // Optional boolean flag to indicate whether any effect should take place. Used to + // test if the caller has permission to make the call. + DryRun *bool } type NotifyMigrationTaskStateOutput struct { diff --git a/service/migrationhub/api_op_PutResourceAttributes.go b/service/migrationhub/api_op_PutResourceAttributes.go index 4a06b638bb9..387a2fd95f3 100644 --- a/service/migrationhub/api_op_PutResourceAttributes.go +++ b/service/migrationhub/api_op_PutResourceAttributes.go @@ -75,17 +75,17 @@ func (c *Client) PutResourceAttributes(ctx context.Context, params *PutResourceA type PutResourceAttributesInput struct { - // The name of the ProgressUpdateStream. - // - // This member is required. - ProgressUpdateStream *string - // Unique identifier that references the migration task. Do not store personal data // in this field. // // This member is required. MigrationTaskName *string + // The name of the ProgressUpdateStream. + // + // This member is required. + ProgressUpdateStream *string + // Information about the resource that is being migrated. This data will be used to // map the task to a resource in the Application Discovery Service repository. // Takes the object array of ResourceAttribute where the Type field is reserved for diff --git a/service/migrationhub/go.mod b/service/migrationhub/go.mod index a0e10640f2b..ac5f4a3900f 100644 --- a/service/migrationhub/go.mod +++ b/service/migrationhub/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/migrationhub go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/migrationhub/types/types.go b/service/migrationhub/types/types.go index eb4118efc41..f0305906819 100644 --- a/service/migrationhub/types/types.go +++ b/service/migrationhub/types/types.go @@ -10,15 +10,15 @@ import ( // Agentless Discovery Connector, or the AWS Application Discovery Agent. type ApplicationState struct { + // The configurationId from the Application Discovery Service that uniquely + // identifies an application. + ApplicationId *string + // The current status of an application. ApplicationStatus ApplicationStatus // The timestamp when the application status was last updated. LastUpdatedTime *time.Time - - // The configurationId from the Application Discovery Service that uniquely - // identifies an application. - ApplicationId *string } // An ARN of the AWS cloud resource target receiving the migration (e.g., AMI, EC2 @@ -38,15 +38,15 @@ type CreatedArtifact struct { // Object representing the on-premises resource being migrated. type DiscoveredResource struct { - // A description that can be free-form text to record additional detail about the - // discovered resource for clarity or later reference. - Description *string - // The configurationId in Application Discovery Service that uniquely identifies // the on-premise resource. // // This member is required. ConfigurationId *string + + // A description that can be free-form text to record additional detail about the + // discovered resource for clarity or later reference. + Description *string } // Represents a migration task in a migration tool. @@ -56,43 +56,43 @@ type MigrationTask struct { // in this field. MigrationTaskName *string - // Task object encapsulating task information. - Task *Task - - // The timestamp when the task was gathered. - UpdateDateTime *time.Time - // A name that identifies the vendor of the migration tool being used. ProgressUpdateStream *string // Information about the resource that is being migrated. This data will be used to // map the task to a resource in the Application Discovery Service repository. ResourceAttributeList []*ResourceAttribute + + // Task object encapsulating task information. + Task *Task + + // The timestamp when the task was gathered. + UpdateDateTime *time.Time } // MigrationTaskSummary includes MigrationTaskName, ProgressPercent, // ProgressUpdateStream, Status, and UpdateDateTime for each task. type MigrationTaskSummary struct { - // Detail information of what is being done within the overall status state. - StatusDetail *string - - // Status of the task. - Status Status - // Unique identifier that references the migration task. Do not store personal data // in this field. MigrationTaskName *string - // The timestamp when the task was gathered. - UpdateDateTime *time.Time + // Indication of the percentage completion of the task. + ProgressPercent *int32 // An AWS resource used for access control. It should uniquely identify the // migration tool as it is used for all updates made by the tool. ProgressUpdateStream *string - // Indication of the percentage completion of the task. - ProgressPercent *int32 + // Status of the task. + Status Status + + // Detail information of what is being done within the overall status state. + StatusDetail *string + + // The timestamp when the task was gathered. + UpdateDateTime *time.Time } // Summary of the AWS resource used for access control that is implicitly linked to @@ -127,6 +127,11 @@ type ResourceAttribute struct { // Task object encapsulating task information. type Task struct { + // Status of the task - Not Started, In-Progress, Complete. + // + // This member is required. + Status Status + // Indication of the percentage completion of the task. ProgressPercent *int32 @@ -134,9 +139,4 @@ type Task struct { // field to provide clarifying information about the status that is unique to that // tool or that explains an error state. StatusDetail *string - - // Status of the task - Not Started, In-Progress, Complete. - // - // This member is required. - Status Status } diff --git a/service/migrationhubconfig/api_op_CreateHomeRegionControl.go b/service/migrationhubconfig/api_op_CreateHomeRegionControl.go index 8d27db735b3..9591de7ff71 100644 --- a/service/migrationhubconfig/api_op_CreateHomeRegionControl.go +++ b/service/migrationhubconfig/api_op_CreateHomeRegionControl.go @@ -57,10 +57,6 @@ func (c *Client) CreateHomeRegionControl(ctx context.Context, params *CreateHome type CreateHomeRegionControlInput struct { - // Optional Boolean flag to indicate whether any effect should take place. It tests - // whether the caller has permission to make the call. - DryRun *bool - // The name of the home region of the calling account. // // This member is required. @@ -71,6 +67,10 @@ type CreateHomeRegionControlInput struct { // // This member is required. Target *types.Target + + // Optional Boolean flag to indicate whether any effect should take place. It tests + // whether the caller has permission to make the call. + DryRun *bool } type CreateHomeRegionControlOutput struct { diff --git a/service/migrationhubconfig/api_op_DescribeHomeRegionControls.go b/service/migrationhubconfig/api_op_DescribeHomeRegionControls.go index fae6d982367..f2573c2c1e9 100644 --- a/service/migrationhubconfig/api_op_DescribeHomeRegionControls.go +++ b/service/migrationhubconfig/api_op_DescribeHomeRegionControls.go @@ -57,10 +57,11 @@ func (c *Client) DescribeHomeRegionControls(ctx context.Context, params *Describ type DescribeHomeRegionControlsInput struct { - // The target parameter specifies the identifier to which the home region is - // applied, which is always of type ACCOUNT. It applies the home region to the - // current ACCOUNT. - Target *types.Target + // The ControlID is a unique identifier string of your HomeRegionControl object. + ControlId *string + + // The name of the home region you'd like to view. + HomeRegion *string // The maximum number of filtering results to display per page. MaxResults *int32 @@ -70,23 +71,22 @@ type DescribeHomeRegionControlsInput struct { // in NextToken. NextToken *string - // The name of the home region you'd like to view. - HomeRegion *string - - // The ControlID is a unique identifier string of your HomeRegionControl object. - ControlId *string + // The target parameter specifies the identifier to which the home region is + // applied, which is always of type ACCOUNT. It applies the home region to the + // current ACCOUNT. + Target *types.Target } type DescribeHomeRegionControlsOutput struct { + // An array that contains your HomeRegionControl objects. + HomeRegionControls []*types.HomeRegionControl + // If a NextToken was returned by a previous call, more results are available. To // retrieve the next page of results, make the call again using the returned token // in NextToken. NextToken *string - // An array that contains your HomeRegionControl objects. - HomeRegionControls []*types.HomeRegionControl - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/migrationhubconfig/go.mod b/service/migrationhubconfig/go.mod index 7240f386913..d7f28b96071 100644 --- a/service/migrationhubconfig/go.mod +++ b/service/migrationhubconfig/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/migrationhubconfig go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/migrationhubconfig/types/types.go b/service/migrationhubconfig/types/types.go index 1c08b93dfda..b7034e2f7fa 100644 --- a/service/migrationhubconfig/types/types.go +++ b/service/migrationhubconfig/types/types.go @@ -11,22 +11,22 @@ import ( // ACCOUNT), an ID, and a time at which the home region was set. type HomeRegionControl struct { - // The target parameter specifies the identifier to which the home region is - // applied, which is always an ACCOUNT. It applies the home region to the current - // ACCOUNT. - Target *Target - // A unique identifier that's generated for each home region control. It's always a // string that begins with "hrc-" followed by 12 lowercase letters and numbers. ControlId *string + // The AWS Region that's been set as home region. For example, "us-west-2" or + // "eu-central-1" are valid home regions. + HomeRegion *string + // A timestamp representing the time when the customer called // CreateHomeregionControl and set the home region for the account. RequestedTime *time.Time - // The AWS Region that's been set as home region. For example, "us-west-2" or - // "eu-central-1" are valid home regions. - HomeRegion *string + // The target parameter specifies the identifier to which the home region is + // applied, which is always an ACCOUNT. It applies the home region to the current + // ACCOUNT. + Target *Target } // The target parameter specifies the identifier to which the home region is diff --git a/service/mobile/api_op_CreateProject.go b/service/mobile/api_op_CreateProject.go index 6b48eb2d9cd..adfb5a815fc 100644 --- a/service/mobile/api_op_CreateProject.go +++ b/service/mobile/api_op_CreateProject.go @@ -57,20 +57,20 @@ func (c *Client) CreateProject(ctx context.Context, params *CreateProjectInput, // Request structure used to request a project be created. type CreateProjectInput struct { - // Default region where project resources should be created. - Region *string - // ZIP or YAML file which contains configuration settings to be used when creating // the project. This may be the contents of the file downloaded from the URL // provided in an export project operation. Contents []byte + // Name of the project. + Name *string + + // Default region where project resources should be created. + Region *string + // Unique identifier for an exported snapshot of project configuration. This // snapshot identifier is included in the share URL when a project is exported. SnapshotId *string - - // Name of the project. - Name *string } // Result structure used in response to a request to create a project. diff --git a/service/mobile/api_op_ExportBundle.go b/service/mobile/api_op_ExportBundle.go index ecfb320cfc1..c764a4713bb 100644 --- a/service/mobile/api_op_ExportBundle.go +++ b/service/mobile/api_op_ExportBundle.go @@ -60,9 +60,6 @@ func (c *Client) ExportBundle(ctx context.Context, params *ExportBundleInput, op // required to integrate mobile web or app clients with backed AWS resources. type ExportBundleInput struct { - // Unique project identifier. - ProjectId *string - // Unique bundle identifier. // // This member is required. @@ -70,6 +67,9 @@ type ExportBundleInput struct { // Developer desktop or target application platform. Platform types.Platform + + // Unique project identifier. + ProjectId *string } // Result structure which contains link to download custom-generated SDK and tool diff --git a/service/mobile/api_op_ExportProject.go b/service/mobile/api_op_ExportProject.go index add55c9788a..3f65ba131da 100644 --- a/service/mobile/api_op_ExportProject.go +++ b/service/mobile/api_op_ExportProject.go @@ -68,10 +68,6 @@ type ExportProjectInput struct { // Result structure used for requests to export project configuration details. type ExportProjectOutput struct { - // Unique identifier for the exported snapshot of the project configuration. This - // snapshot identifier is included in the share URL. - SnapshotId *string - // URL which can be used to download the exported project configuation file(s). DownloadUrl *string @@ -83,6 +79,10 @@ type ExportProjectOutput struct { // this method again. ShareUrl *string + // Unique identifier for the exported snapshot of the project configuration. This + // snapshot identifier is included in the share URL. + SnapshotId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mobile/api_op_ListBundles.go b/service/mobile/api_op_ListBundles.go index fa564cef73b..0941d0b7266 100644 --- a/service/mobile/api_op_ListBundles.go +++ b/service/mobile/api_op_ListBundles.go @@ -69,13 +69,13 @@ type ListBundlesInput struct { // Result structure contains a list of all available bundles with details. type ListBundlesOutput struct { + // A list of bundles. + BundleList []*types.BundleDetails + // Pagination token. If non-null pagination token is returned in a result, then // pass its value in another request to fetch more entries. NextToken *string - // A list of bundles. - BundleList []*types.BundleDetails - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mobile/api_op_UpdateProject.go b/service/mobile/api_op_UpdateProject.go index 9b71a6e4103..10884e236f9 100644 --- a/service/mobile/api_op_UpdateProject.go +++ b/service/mobile/api_op_UpdateProject.go @@ -58,15 +58,15 @@ func (c *Client) UpdateProject(ctx context.Context, params *UpdateProjectInput, // Request structure used for requests to update project configuration. type UpdateProjectInput struct { - // ZIP or YAML file which contains project configuration to be updated. This should - // be the contents of the file downloaded from the URL provided in an export - // project operation. - Contents []byte - // Unique project identifier. // // This member is required. ProjectId *string + + // ZIP or YAML file which contains project configuration to be updated. This should + // be the contents of the file downloaded from the URL provided in an export + // project operation. + Contents []byte } // Result structure used for requests to updated project configuration. diff --git a/service/mobile/go.mod b/service/mobile/go.mod index af2d1e53f40..b62d130fe39 100644 --- a/service/mobile/go.mod +++ b/service/mobile/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/mobile go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/mobile/types/types.go b/service/mobile/types/types.go index 438591052d6..d01b7d2a3f4 100644 --- a/service/mobile/types/types.go +++ b/service/mobile/types/types.go @@ -12,18 +12,18 @@ type BundleDetails struct { // Developer desktop or mobile app or website platforms. AvailablePlatforms []Platform - // Description of the download bundle. - Description *string - // Unique bundle identifier. BundleId *string - // Title of the download bundle. - Title *string + // Description of the download bundle. + Description *string // Icon for the download bundle. IconUrl *string + // Title of the download bundle. + Title *string + // Version of the download bundle. Version *string } @@ -31,8 +31,14 @@ type BundleDetails struct { // Detailed information about an AWS Mobile Hub project. type ProjectDetails struct { - // List of AWS resources associated with a project. - Resources []*Resource + // Website URL for this project in the AWS Mobile Hub console. + ConsoleUrl *string + + // Date the project was created. + CreatedDate *time.Time + + // Date of the last modification of the project. + LastUpdatedDate *time.Time // Name of the project. Name *string @@ -40,48 +46,42 @@ type ProjectDetails struct { // Unique project identifier. ProjectId *string - // Synchronization state for a project. - State ProjectState - // Default region to use for AWS resource creation in the AWS Mobile Hub project. Region *string - // Date the project was created. - CreatedDate *time.Time - - // Website URL for this project in the AWS Mobile Hub console. - ConsoleUrl *string + // List of AWS resources associated with a project. + Resources []*Resource - // Date of the last modification of the project. - LastUpdatedDate *time.Time + // Synchronization state for a project. + State ProjectState } // Summary information about an AWS Mobile Hub project. type ProjectSummary struct { - // Unique project identifier. - ProjectId *string - // Name of the project. Name *string + + // Unique project identifier. + ProjectId *string } // Information about an instance of an AWS resource associated with a project. type Resource struct { - // Identifies which feature in AWS Mobile Hub is associated with this AWS resource. - Feature *string + // AWS resource name which uniquely identifies the resource in AWS systems. + Arn *string // Key-value attribute pairs. Attributes map[string]*string + // Identifies which feature in AWS Mobile Hub is associated with this AWS resource. + Feature *string + // Name of the AWS resource (e.g., for an Amazon S3 bucket this is the name of the // bucket). Name *string - // AWS resource name which uniquely identifies the resource in AWS systems. - Arn *string - // Simplified name for type of AWS resource (e.g., bucket is an Amazon S3 bucket). Type *string } diff --git a/service/mq/api_op_CreateBroker.go b/service/mq/api_op_CreateBroker.go index 8388163bb4f..8e4e71f916c 100644 --- a/service/mq/api_op_CreateBroker.go +++ b/service/mq/api_op_CreateBroker.go @@ -60,20 +60,6 @@ func (c *Client) CreateBroker(ctx context.Context, params *CreateBrokerInput, op // Creates a broker using the specified properties. type CreateBrokerInput struct { - // A list of information about the configuration. - Configuration *types.ConfigurationId - - // Required. The list of ActiveMQ users (persons or applications) who can access - // queues and topics. This value can contain only alphanumeric characters, dashes, - // periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters - // long. - Users []*types.User - - // Required. The version of the broker engine. For a list of supported engine - // versions, see - // https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html - EngineVersion *string - // The authentication strategy used to secure the broker. AuthenticationStrategy types.AuthenticationStrategy @@ -82,70 +68,84 @@ type CreateBrokerInput struct { // maintenance window of the broker or after a manual broker reboot. AutoMinorVersionUpgrade *bool - // The broker's storage type. - StorageType types.BrokerStorageType + // Required. The name of the broker. This value must be unique in your AWS account, + // 1-50 characters long, must contain only letters, numbers, dashes, and + // underscores, and must not contain whitespaces, brackets, wildcard characters, or + // special characters. + BrokerName *string - // The list of security groups (1 minimum, 5 maximum) that authorizes connections - // to brokers. - SecurityGroups []*string + // A list of information about the configuration. + Configuration *types.ConfigurationId - // Create tags when creating the broker. - Tags map[string]*string + // The unique ID that the requester receives for the created broker. Amazon MQ + // passes your ID with the API action. Note: We recommend using a Universally + // Unique Identifier (UUID) for the creatorRequestId. You may omit the + // creatorRequestId if your application doesn't require idempotency. + CreatorRequestId *string - // The metadata of the LDAP server used to authenticate and authorize connections - // to the broker. - LdapServerMetadata *types.LdapServerMetadataInput + // Required. The deployment mode of the broker. + DeploymentMode types.DeploymentMode // Encryption options for the broker. EncryptionOptions *types.EncryptionOptions - // Required. Enables connections from applications outside of the VPC that hosts - // the broker's subnets. - PubliclyAccessible *bool - // Required. The type of broker engine. Note: Currently, Amazon MQ supports only // ACTIVEMQ. EngineType types.EngineType - // Required. The deployment mode of the broker. - DeploymentMode types.DeploymentMode - - // Enables Amazon CloudWatch logging for brokers. - Logs *types.Logs + // Required. The version of the broker engine. For a list of supported engine + // versions, see + // https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html + EngineVersion *string // Required. The broker's instance type. HostInstanceType *string - // Required. The name of the broker. This value must be unique in your AWS account, - // 1-50 characters long, must contain only letters, numbers, dashes, and - // underscores, and must not contain whitespaces, brackets, wildcard characters, or - // special characters. - BrokerName *string + // The metadata of the LDAP server used to authenticate and authorize connections + // to the broker. + LdapServerMetadata *types.LdapServerMetadataInput + + // Enables Amazon CloudWatch logging for brokers. + Logs *types.Logs // The parameters that determine the WeeklyStartTime. MaintenanceWindowStartTime *types.WeeklyStartTime - // The unique ID that the requester receives for the created broker. Amazon MQ - // passes your ID with the API action. Note: We recommend using a Universally - // Unique Identifier (UUID) for the creatorRequestId. You may omit the - // creatorRequestId if your application doesn't require idempotency. - CreatorRequestId *string + // Required. Enables connections from applications outside of the VPC that hosts + // the broker's subnets. + PubliclyAccessible *bool + + // The list of security groups (1 minimum, 5 maximum) that authorizes connections + // to brokers. + SecurityGroups []*string + + // The broker's storage type. + StorageType types.BrokerStorageType // The list of groups (2 maximum) that define which subnets and IP ranges the // broker can use from different Availability Zones. A SINGLE_INSTANCE deployment // requires one subnet (for example, the default subnet). An // ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets. SubnetIds []*string + + // Create tags when creating the broker. + Tags map[string]*string + + // Required. The list of ActiveMQ users (persons or applications) who can access + // queues and topics. This value can contain only alphanumeric characters, dashes, + // periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters + // long. + Users []*types.User } type CreateBrokerOutput struct { - // The unique ID that Amazon MQ generates for the broker. - BrokerId *string - // The Amazon Resource Name (ARN) of the broker. BrokerArn *string + // The unique ID that Amazon MQ generates for the broker. + BrokerId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mq/api_op_CreateConfiguration.go b/service/mq/api_op_CreateConfiguration.go index e2c17031ace..3afad88c7e6 100644 --- a/service/mq/api_op_CreateConfiguration.go +++ b/service/mq/api_op_CreateConfiguration.go @@ -60,49 +60,49 @@ func (c *Client) CreateConfiguration(ctx context.Context, params *CreateConfigur // the default configuration (the engine type and version). type CreateConfigurationInput struct { - // Required. The version of the broker engine. For a list of supported engine - // versions, see - // https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html - EngineVersion *string - - // Create tags when creating the configuration. - Tags map[string]*string + // The authentication strategy associated with the configuration. + AuthenticationStrategy types.AuthenticationStrategy // Required. The type of broker engine. Note: Currently, Amazon MQ supports only // ACTIVEMQ. EngineType types.EngineType - // The authentication strategy associated with the configuration. - AuthenticationStrategy types.AuthenticationStrategy + // Required. The version of the broker engine. For a list of supported engine + // versions, see + // https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html + EngineVersion *string // Required. The name of the configuration. This value can contain only // alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). // This value must be 1-150 characters long. Name *string + + // Create tags when creating the configuration. + Tags map[string]*string } type CreateConfigurationOutput struct { + // Required. The Amazon Resource Name (ARN) of the configuration. + Arn *string + // The authentication strategy associated with the configuration. AuthenticationStrategy types.AuthenticationStrategy - // The latest revision of the configuration. - LatestRevision *types.ConfigurationRevision - - // Required. The Amazon Resource Name (ARN) of the configuration. - Arn *string + // Required. The date and time of the configuration. + Created *time.Time // Required. The unique ID that Amazon MQ generates for the configuration. Id *string + // The latest revision of the configuration. + LatestRevision *types.ConfigurationRevision + // Required. The name of the configuration. This value can contain only // alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). // This value must be 1-150 characters long. Name *string - // Required. The date and time of the configuration. - Created *time.Time - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mq/api_op_CreateTags.go b/service/mq/api_op_CreateTags.go index ab705ac3090..c57188dc84a 100644 --- a/service/mq/api_op_CreateTags.go +++ b/service/mq/api_op_CreateTags.go @@ -57,13 +57,13 @@ func (c *Client) CreateTags(ctx context.Context, params *CreateTagsInput, optFns // A map of the key-value pairs for the resource tag. type CreateTagsInput struct { - // The key-value pair for the resource tag. - Tags map[string]*string - // The Amazon Resource Name (ARN) of the resource tag. // // This member is required. ResourceArn *string + + // The key-value pair for the resource tag. + Tags map[string]*string } type CreateTagsOutput struct { diff --git a/service/mq/api_op_CreateUser.go b/service/mq/api_op_CreateUser.go index b472a6faf8b..0d00815b011 100644 --- a/service/mq/api_op_CreateUser.go +++ b/service/mq/api_op_CreateUser.go @@ -57,9 +57,10 @@ func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns // Creates a new ActiveMQ user. type CreateUserInput struct { - // Required. The password of the user. This value must be at least 12 characters - // long, must contain at least 4 unique characters, and must not contain commas. - Password *string + // The unique ID that Amazon MQ generates for the broker. + // + // This member is required. + BrokerId *string // The username of the ActiveMQ user. This value can contain only alphanumeric // characters, dashes, periods, underscores, and tildes (- . _ ~). This value must @@ -76,10 +77,9 @@ type CreateUserInput struct { // tildes (- . _ ~). This value must be 2-100 characters long. Groups []*string - // The unique ID that Amazon MQ generates for the broker. - // - // This member is required. - BrokerId *string + // Required. The password of the user. This value must be at least 12 characters + // long, must contain at least 4 unique characters, and must not contain commas. + Password *string } type CreateUserOutput struct { diff --git a/service/mq/api_op_DescribeBroker.go b/service/mq/api_op_DescribeBroker.go index 5e1c984fbd7..cd2fb89e16b 100644 --- a/service/mq/api_op_DescribeBroker.go +++ b/service/mq/api_op_DescribeBroker.go @@ -69,108 +69,108 @@ type DescribeBrokerInput struct { type DescribeBrokerOutput struct { - // The status of the broker. - BrokerState types.BrokerState + // The authentication strategy used to secure the broker. + AuthenticationStrategy types.AuthenticationStrategy - // The list of security groups (1 minimum, 5 maximum) that authorizes connections - // to brokers. - SecurityGroups []*string + // Required. Enables automatic upgrades to new minor versions for brokers, as + // Apache releases the versions. The automatic upgrades occur during the + // maintenance window of the broker or after a manual broker reboot. + AutoMinorVersionUpgrade *bool - // The list of pending security groups to authorize connections to brokers. - PendingSecurityGroups []*string + // The Amazon Resource Name (ARN) of the broker. + BrokerArn *string + + // The unique ID that Amazon MQ generates for the broker. + BrokerId *string // A list of information about allocated brokers. BrokerInstances []*types.BrokerInstance - // The authentication strategy used to secure the broker. - AuthenticationStrategy types.AuthenticationStrategy + // The name of the broker. This value must be unique in your AWS account, 1-50 + // characters long, must contain only letters, numbers, dashes, and underscores, + // and must not contain whitespaces, brackets, wildcard characters, or special + // characters. + BrokerName *string - // The list of all ActiveMQ usernames for the specified broker. - Users []*types.UserSummary + // The status of the broker. + BrokerState types.BrokerState - // The list of groups (2 maximum) that define which subnets and IP ranges the - // broker can use from different Availability Zones. A SINGLE_INSTANCE deployment - // requires one subnet (for example, the default subnet). An - // ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets. - SubnetIds []*string + // The list of all revisions for the specified configuration. + Configurations *types.Configurations // The time when the broker was created. Created *time.Time - // The host instance type of the broker to upgrade to. For a list of supported - // instance types, see - // https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types - PendingHostInstanceType *string - // Required. The deployment mode of the broker. DeploymentMode types.DeploymentMode - // Required. The type of broker engine. Note: Currently, Amazon MQ supports only - // ACTIVEMQ. - EngineType types.EngineType - - // The list of all revisions for the specified configuration. - Configurations *types.Configurations - // Encryption options for the broker. EncryptionOptions *types.EncryptionOptions - // The version of the broker engine to upgrade to. For a list of supported engine - // versions, see - // https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html - PendingEngineVersion *string - - // The list of all tags associated with this broker. - Tags map[string]*string + // Required. The type of broker engine. Note: Currently, Amazon MQ supports only + // ACTIVEMQ. + EngineType types.EngineType // The version of the broker engine. For a list of supported engine versions, see // https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html EngineVersion *string - // The broker's storage type. - StorageType types.BrokerStorageType - - // The unique ID that Amazon MQ generates for the broker. - BrokerId *string - - // The authentication strategy that will be applied when the broker is rebooted. - PendingAuthenticationStrategy types.AuthenticationStrategy - - // The parameters that determine the WeeklyStartTime. - MaintenanceWindowStartTime *types.WeeklyStartTime - // The broker's instance type. HostInstanceType *string - // Required. Enables automatic upgrades to new minor versions for brokers, as - // Apache releases the versions. The automatic upgrades occur during the - // maintenance window of the broker or after a manual broker reboot. - AutoMinorVersionUpgrade *bool + // The metadata of the LDAP server used to authenticate and authorize connections + // to the broker. + LdapServerMetadata *types.LdapServerMetadataOutput // The list of information about logs currently enabled and pending to be deployed // for the specified broker. Logs *types.LogsSummary - // The name of the broker. This value must be unique in your AWS account, 1-50 - // characters long, must contain only letters, numbers, dashes, and underscores, - // and must not contain whitespaces, brackets, wildcard characters, or special - // characters. - BrokerName *string + // The parameters that determine the WeeklyStartTime. + MaintenanceWindowStartTime *types.WeeklyStartTime + + // The authentication strategy that will be applied when the broker is rebooted. + PendingAuthenticationStrategy types.AuthenticationStrategy + + // The version of the broker engine to upgrade to. For a list of supported engine + // versions, see + // https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html + PendingEngineVersion *string + + // The host instance type of the broker to upgrade to. For a list of supported + // instance types, see + // https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types + PendingHostInstanceType *string // The metadata of the LDAP server that will be used to authenticate and authorize // connections to the broker once it is rebooted. PendingLdapServerMetadata *types.LdapServerMetadataOutput - // The metadata of the LDAP server used to authenticate and authorize connections - // to the broker. - LdapServerMetadata *types.LdapServerMetadataOutput + // The list of pending security groups to authorize connections to brokers. + PendingSecurityGroups []*string // Required. Enables connections from applications outside of the VPC that hosts // the broker's subnets. PubliclyAccessible *bool - // The Amazon Resource Name (ARN) of the broker. - BrokerArn *string + // The list of security groups (1 minimum, 5 maximum) that authorizes connections + // to brokers. + SecurityGroups []*string + + // The broker's storage type. + StorageType types.BrokerStorageType + + // The list of groups (2 maximum) that define which subnets and IP ranges the + // broker can use from different Availability Zones. A SINGLE_INSTANCE deployment + // requires one subnet (for example, the default subnet). An + // ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets. + SubnetIds []*string + + // The list of all tags associated with this broker. + Tags map[string]*string + + // The list of all ActiveMQ usernames for the specified broker. + Users []*types.UserSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/mq/api_op_DescribeBrokerEngineTypes.go b/service/mq/api_op_DescribeBrokerEngineTypes.go index 1912a91508e..59443f8ed32 100644 --- a/service/mq/api_op_DescribeBrokerEngineTypes.go +++ b/service/mq/api_op_DescribeBrokerEngineTypes.go @@ -56,6 +56,9 @@ func (c *Client) DescribeBrokerEngineTypes(ctx context.Context, params *Describe type DescribeBrokerEngineTypesInput struct { + // Filter response by engine type. + EngineType *string + // The maximum number of engine types that Amazon MQ can return per page (20 by // default). This value must be an integer from 5 to 100. MaxResults *int32 @@ -63,17 +66,10 @@ type DescribeBrokerEngineTypesInput struct { // The token that specifies the next page of results Amazon MQ should return. To // request the first page, leave nextToken empty. NextToken *string - - // Filter response by engine type. - EngineType *string } type DescribeBrokerEngineTypesOutput struct { - // The token that specifies the next page of results Amazon MQ should return. To - // request the first page, leave nextToken empty. - NextToken *string - // List of available engine types and versions. BrokerEngineTypes []*types.BrokerEngineType @@ -81,6 +77,10 @@ type DescribeBrokerEngineTypesOutput struct { // by default). This value must be an integer from 5 to 100. MaxResults *int32 + // The token that specifies the next page of results Amazon MQ should return. To + // request the first page, leave nextToken empty. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mq/api_op_DescribeBrokerInstanceOptions.go b/service/mq/api_op_DescribeBrokerInstanceOptions.go index b5b581c42fb..2f432dcea85 100644 --- a/service/mq/api_op_DescribeBrokerInstanceOptions.go +++ b/service/mq/api_op_DescribeBrokerInstanceOptions.go @@ -56,22 +56,22 @@ func (c *Client) DescribeBrokerInstanceOptions(ctx context.Context, params *Desc type DescribeBrokerInstanceOptionsInput struct { - // The token that specifies the next page of results Amazon MQ should return. To - // request the first page, leave nextToken empty. - NextToken *string + // Filter response by engine type. + EngineType *string - // Filter response by storage type. - StorageType *string + // Filter response by host instance type. + HostInstanceType *string // The maximum number of instance options that Amazon MQ can return per page (20 by // default). This value must be an integer from 5 to 100. MaxResults *int32 - // Filter response by host instance type. - HostInstanceType *string + // The token that specifies the next page of results Amazon MQ should return. To + // request the first page, leave nextToken empty. + NextToken *string - // Filter response by engine type. - EngineType *string + // Filter response by storage type. + StorageType *string } type DescribeBrokerInstanceOptionsOutput struct { @@ -79,14 +79,14 @@ type DescribeBrokerInstanceOptionsOutput struct { // List of available broker instance options. BrokerInstanceOptions []*types.BrokerInstanceOption - // The token that specifies the next page of results Amazon MQ should return. To - // request the first page, leave nextToken empty. - NextToken *string - // Required. The maximum number of instance options that can be returned per page // (20 by default). This value must be an integer from 5 to 100. MaxResults *int32 + // The token that specifies the next page of results Amazon MQ should return. To + // request the first page, leave nextToken empty. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mq/api_op_DescribeConfiguration.go b/service/mq/api_op_DescribeConfiguration.go index 099c1f29cd2..960eff92a42 100644 --- a/service/mq/api_op_DescribeConfiguration.go +++ b/service/mq/api_op_DescribeConfiguration.go @@ -66,41 +66,41 @@ type DescribeConfigurationInput struct { type DescribeConfigurationOutput struct { - // Required. The name of the configuration. This value can contain only - // alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). - // This value must be 1-150 characters long. - Name *string - - // The list of all tags associated with this configuration. - Tags map[string]*string - - // Required. The type of broker engine. Note: Currently, Amazon MQ supports only - // ACTIVEMQ. - EngineType types.EngineType + // Required. The ARN of the configuration. + Arn *string // The authentication strategy associated with the configuration. AuthenticationStrategy types.AuthenticationStrategy - // Required. The latest revision of the configuration. - LatestRevision *types.ConfigurationRevision - - // Required. The ARN of the configuration. - Arn *string - // Required. The date and time of the configuration revision. Created *time.Time + // Required. The description of the configuration. + Description *string + + // Required. The type of broker engine. Note: Currently, Amazon MQ supports only + // ACTIVEMQ. + EngineType types.EngineType + // Required. The version of the broker engine. For a list of supported engine // versions, see // https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html EngineVersion *string - // Required. The description of the configuration. - Description *string - // Required. The unique ID that Amazon MQ generates for the configuration. Id *string + // Required. The latest revision of the configuration. + LatestRevision *types.ConfigurationRevision + + // Required. The name of the configuration. This value can contain only + // alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). + // This value must be 1-150 characters long. + Name *string + + // The list of all tags associated with this configuration. + Tags map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mq/api_op_DescribeConfigurationRevision.go b/service/mq/api_op_DescribeConfigurationRevision.go index 5b8a51ac2c3..dedd4db9c83 100644 --- a/service/mq/api_op_DescribeConfigurationRevision.go +++ b/service/mq/api_op_DescribeConfigurationRevision.go @@ -57,15 +57,15 @@ func (c *Client) DescribeConfigurationRevision(ctx context.Context, params *Desc type DescribeConfigurationRevisionInput struct { - // The revision of the configuration. + // The unique ID that Amazon MQ generates for the configuration. // // This member is required. - ConfigurationRevision *string + ConfigurationId *string - // The unique ID that Amazon MQ generates for the configuration. + // The revision of the configuration. // // This member is required. - ConfigurationId *string + ConfigurationRevision *string } type DescribeConfigurationRevisionOutput struct { @@ -73,15 +73,15 @@ type DescribeConfigurationRevisionOutput struct { // Required. The unique ID that Amazon MQ generates for the configuration. ConfigurationId *string + // Required. The date and time of the configuration. + Created *time.Time + // Required. The base64-encoded XML configuration. Data *string // The description of the configuration. Description *string - // Required. The date and time of the configuration. - Created *time.Time - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mq/api_op_DescribeUser.go b/service/mq/api_op_DescribeUser.go index 31e39513829..15a4aa44127 100644 --- a/service/mq/api_op_DescribeUser.go +++ b/service/mq/api_op_DescribeUser.go @@ -57,21 +57,24 @@ func (c *Client) DescribeUser(ctx context.Context, params *DescribeUserInput, op type DescribeUserInput struct { + // The unique ID that Amazon MQ generates for the broker. + // + // This member is required. + BrokerId *string + // The username of the ActiveMQ user. This value can contain only alphanumeric // characters, dashes, periods, underscores, and tildes (- . _ ~). This value must // be 2-100 characters long. // // This member is required. Username *string - - // The unique ID that Amazon MQ generates for the broker. - // - // This member is required. - BrokerId *string } type DescribeUserOutput struct { + // Required. The unique ID that Amazon MQ generates for the broker. + BrokerId *string + // Enables access to the the ActiveMQ Web Console for the ActiveMQ user. ConsoleAccess *bool @@ -80,17 +83,14 @@ type DescribeUserOutput struct { // tildes (- . _ ~). This value must be 2-100 characters long. Groups []*string + // The status of the changes pending for the ActiveMQ user. + Pending *types.UserPendingChanges + // Required. The username of the ActiveMQ user. This value can contain only // alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). // This value must be 2-100 characters long. Username *string - // Required. The unique ID that Amazon MQ generates for the broker. - BrokerId *string - - // The status of the changes pending for the ActiveMQ user. - Pending *types.UserPendingChanges - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mq/api_op_ListConfigurationRevisions.go b/service/mq/api_op_ListConfigurationRevisions.go index 20afd349a0b..31a8f11f907 100644 --- a/service/mq/api_op_ListConfigurationRevisions.go +++ b/service/mq/api_op_ListConfigurationRevisions.go @@ -73,19 +73,19 @@ type ListConfigurationRevisionsInput struct { type ListConfigurationRevisionsOutput struct { + // The unique ID that Amazon MQ generates for the configuration. + ConfigurationId *string + // The maximum number of configuration revisions that can be returned per page (20 // by default). This value must be an integer from 5 to 100. MaxResults *int32 - // The list of all revisions for the specified configuration. - Revisions []*types.ConfigurationRevision - // The token that specifies the next page of results Amazon MQ should return. To // request the first page, leave nextToken empty. NextToken *string - // The unique ID that Amazon MQ generates for the configuration. - ConfigurationId *string + // The list of all revisions for the specified configuration. + Revisions []*types.ConfigurationRevision // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/mq/api_op_ListConfigurations.go b/service/mq/api_op_ListConfigurations.go index a2be881b8a4..953a8d2fd01 100644 --- a/service/mq/api_op_ListConfigurations.go +++ b/service/mq/api_op_ListConfigurations.go @@ -56,20 +56,16 @@ func (c *Client) ListConfigurations(ctx context.Context, params *ListConfigurati type ListConfigurationsInput struct { - // The token that specifies the next page of results Amazon MQ should return. To - // request the first page, leave nextToken empty. - NextToken *string - // The maximum number of configurations that Amazon MQ can return per page (20 by // default). This value must be an integer from 5 to 100. MaxResults *int32 -} - -type ListConfigurationsOutput struct { // The token that specifies the next page of results Amazon MQ should return. To // request the first page, leave nextToken empty. NextToken *string +} + +type ListConfigurationsOutput struct { // The list of all revisions for the specified configuration. Configurations []*types.Configuration @@ -78,6 +74,10 @@ type ListConfigurationsOutput struct { // default). This value must be an integer from 5 to 100. MaxResults *int32 + // The token that specifies the next page of results Amazon MQ should return. To + // request the first page, leave nextToken empty. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mq/api_op_ListUsers.go b/service/mq/api_op_ListUsers.go index 6302a68ae29..069ff050353 100644 --- a/service/mq/api_op_ListUsers.go +++ b/service/mq/api_op_ListUsers.go @@ -57,6 +57,11 @@ func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns . type ListUsersInput struct { + // The unique ID that Amazon MQ generates for the broker. + // + // This member is required. + BrokerId *string + // The maximum number of ActiveMQ users that can be returned per page (20 by // default). This value must be an integer from 5 to 100. MaxResults *int32 @@ -64,11 +69,6 @@ type ListUsersInput struct { // The token that specifies the next page of results Amazon MQ should return. To // request the first page, leave nextToken empty. NextToken *string - - // The unique ID that Amazon MQ generates for the broker. - // - // This member is required. - BrokerId *string } type ListUsersOutput struct { @@ -76,9 +76,6 @@ type ListUsersOutput struct { // Required. The unique ID that Amazon MQ generates for the broker. BrokerId *string - // Required. The list of all ActiveMQ usernames for the specified broker. - Users []*types.UserSummary - // Required. The maximum number of ActiveMQ users that can be returned per page (20 // by default). This value must be an integer from 5 to 100. MaxResults *int32 @@ -87,6 +84,9 @@ type ListUsersOutput struct { // request the first page, leave nextToken empty. NextToken *string + // Required. The list of all ActiveMQ usernames for the specified broker. + Users []*types.UserSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mq/api_op_UpdateBroker.go b/service/mq/api_op_UpdateBroker.go index b6f2615b477..4c943f8061f 100644 --- a/service/mq/api_op_UpdateBroker.go +++ b/service/mq/api_op_UpdateBroker.go @@ -58,77 +58,77 @@ func (c *Client) UpdateBroker(ctx context.Context, params *UpdateBrokerInput, op // Updates the broker using the specified properties. type UpdateBrokerInput struct { - // The version of the broker engine. For a list of supported engine versions, see - // https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html - EngineVersion *string - - // A list of information about the configuration. - Configuration *types.ConfigurationId - - // The list of security groups (1 minimum, 5 maximum) that authorizes connections - // to brokers. - SecurityGroups []*string - - // The metadata of the LDAP server used to authenticate and authorize connections - // to the broker. - LdapServerMetadata *types.LdapServerMetadataInput - - // The authentication strategy used to secure the broker. - AuthenticationStrategy types.AuthenticationStrategy - // The unique ID that Amazon MQ generates for the broker. // // This member is required. BrokerId *string - // The host instance type of the broker to upgrade to. For a list of supported - // instance types, see - // https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types - HostInstanceType *string - - // Enables Amazon CloudWatch logging for brokers. - Logs *types.Logs + // The authentication strategy used to secure the broker. + AuthenticationStrategy types.AuthenticationStrategy // Enables automatic upgrades to new minor versions for brokers, as Apache releases // the versions. The automatic upgrades occur during the maintenance window of the // broker or after a manual broker reboot. AutoMinorVersionUpgrade *bool -} - -type UpdateBrokerOutput struct { - // The ID of the updated configuration. + // A list of information about the configuration. Configuration *types.ConfigurationId - // Required. The unique ID that Amazon MQ generates for the broker. - BrokerId *string - - // The list of information about logs to be enabled for the specified broker. - Logs *types.Logs + // The version of the broker engine. For a list of supported engine versions, see + // https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html + EngineVersion *string // The host instance type of the broker to upgrade to. For a list of supported // instance types, see // https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types HostInstanceType *string + // The metadata of the LDAP server used to authenticate and authorize connections + // to the broker. + LdapServerMetadata *types.LdapServerMetadataInput + + // Enables Amazon CloudWatch logging for brokers. + Logs *types.Logs + // The list of security groups (1 minimum, 5 maximum) that authorizes connections // to brokers. SecurityGroups []*string +} + +type UpdateBrokerOutput struct { // The authentication strategy used to secure the broker. AuthenticationStrategy types.AuthenticationStrategy - // The metadata of the LDAP server used to authenticate and authorize connections - // to the broker. - LdapServerMetadata *types.LdapServerMetadataOutput + // The new value of automatic upgrades to new minor version for brokers. + AutoMinorVersionUpgrade *bool + + // Required. The unique ID that Amazon MQ generates for the broker. + BrokerId *string + + // The ID of the updated configuration. + Configuration *types.ConfigurationId // The version of the broker engine to upgrade to. For a list of supported engine // versions, see // https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html EngineVersion *string - // The new value of automatic upgrades to new minor version for brokers. - AutoMinorVersionUpgrade *bool + // The host instance type of the broker to upgrade to. For a list of supported + // instance types, see + // https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types + HostInstanceType *string + + // The metadata of the LDAP server used to authenticate and authorize connections + // to the broker. + LdapServerMetadata *types.LdapServerMetadataOutput + + // The list of information about logs to be enabled for the specified broker. + Logs *types.Logs + + // The list of security groups (1 minimum, 5 maximum) that authorizes connections + // to brokers. + SecurityGroups []*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/mq/api_op_UpdateConfiguration.go b/service/mq/api_op_UpdateConfiguration.go index 42632511fce..315fe99f8fa 100644 --- a/service/mq/api_op_UpdateConfiguration.go +++ b/service/mq/api_op_UpdateConfiguration.go @@ -73,9 +73,18 @@ type UpdateConfigurationInput struct { type UpdateConfigurationOutput struct { + // Required. The Amazon Resource Name (ARN) of the configuration. + Arn *string + // Required. The date and time of the configuration. Created *time.Time + // Required. The unique ID that Amazon MQ generates for the configuration. + Id *string + + // The latest revision of the configuration. + LatestRevision *types.ConfigurationRevision + // Required. The name of the configuration. This value can contain only // alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). // This value must be 1-150 characters long. @@ -85,15 +94,6 @@ type UpdateConfigurationOutput struct { // attributes that were sanitized. Warnings []*types.SanitizationWarning - // Required. The Amazon Resource Name (ARN) of the configuration. - Arn *string - - // Required. The unique ID that Amazon MQ generates for the configuration. - Id *string - - // The latest revision of the configuration. - LatestRevision *types.ConfigurationRevision - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mq/api_op_UpdateUser.go b/service/mq/api_op_UpdateUser.go index 3f0e0bf6796..b1d54acf118 100644 --- a/service/mq/api_op_UpdateUser.go +++ b/service/mq/api_op_UpdateUser.go @@ -57,12 +57,10 @@ func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns // Updates the information for an ActiveMQ user. type UpdateUserInput struct { - // Enables access to the the ActiveMQ Web Console for the ActiveMQ user. - ConsoleAccess *bool - - // The password of the user. This value must be at least 12 characters long, must - // contain at least 4 unique characters, and must not contain commas. - Password *string + // The unique ID that Amazon MQ generates for the broker. + // + // This member is required. + BrokerId *string // Required. The username of the ActiveMQ user. This value can contain only // alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). @@ -71,15 +69,17 @@ type UpdateUserInput struct { // This member is required. Username *string + // Enables access to the the ActiveMQ Web Console for the ActiveMQ user. + ConsoleAccess *bool + // The list of groups (20 maximum) to which the ActiveMQ user belongs. This value // can contain only alphanumeric characters, dashes, periods, underscores, and // tildes (- . _ ~). This value must be 2-100 characters long. Groups []*string - // The unique ID that Amazon MQ generates for the broker. - // - // This member is required. - BrokerId *string + // The password of the user. This value must be at least 12 characters long, must + // contain at least 4 unique characters, and must not contain commas. + Password *string } type UpdateUserOutput struct { diff --git a/service/mq/go.mod b/service/mq/go.mod index 0fada29d21a..c074d4ff4df 100644 --- a/service/mq/go.mod +++ b/service/mq/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/mq go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/mq/types/types.go b/service/mq/types/types.go index 03d12cb04bd..bd60024ca1c 100644 --- a/service/mq/types/types.go +++ b/service/mq/types/types.go @@ -42,34 +42,31 @@ type BrokerInstanceOption struct { // The list of available az. AvailabilityZones []*AvailabilityZone - // The broker's storage type. - StorageType BrokerStorageType - - // The list of supported engine versions. - SupportedEngineVersions []*string + // The type of broker engine. + EngineType EngineType // The type of broker instance. HostInstanceType *string + // The broker's storage type. + StorageType BrokerStorageType + // The list of supported deployment modes. SupportedDeploymentModes []DeploymentMode - // The type of broker engine. - EngineType EngineType + // The list of supported engine versions. + SupportedEngineVersions []*string } // The Amazon Resource Name (ARN) of the broker. type BrokerSummary struct { + // The Amazon Resource Name (ARN) of the broker. + BrokerArn *string + // The unique ID that Amazon MQ generates for the broker. BrokerId *string - // The time when the broker was created. - Created *time.Time - - // The broker's instance type. - HostInstanceType *string - // The name of the broker. This value must be unique in your AWS account, 1-50 // characters long, must contain only letters, numbers, dashes, and underscores, // and must not contain whitespaces, brackets, wildcard characters, or special @@ -79,50 +76,53 @@ type BrokerSummary struct { // The status of the broker. BrokerState BrokerState - // The Amazon Resource Name (ARN) of the broker. - BrokerArn *string + // The time when the broker was created. + Created *time.Time // Required. The deployment mode of the broker. DeploymentMode DeploymentMode + + // The broker's instance type. + HostInstanceType *string } // Returns information about all configurations. type Configuration struct { + // Required. The ARN of the configuration. + Arn *string + + // The authentication strategy associated with the configuration. + AuthenticationStrategy AuthenticationStrategy + // Required. The date and time of the configuration revision. Created *time.Time - // Required. The name of the configuration. This value can contain only - // alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). - // This value must be 1-150 characters long. - Name *string - - // The list of all tags associated with this configuration. - Tags map[string]*string + // Required. The description of the configuration. + Description *string // Required. The type of broker engine. Note: Currently, Amazon MQ supports only // ACTIVEMQ. EngineType EngineType + // Required. The version of the broker engine. For a list of supported engine + // versions, see + // https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html + EngineVersion *string + // Required. The unique ID that Amazon MQ generates for the configuration. Id *string // Required. The latest revision of the configuration. LatestRevision *ConfigurationRevision - // Required. The ARN of the configuration. - Arn *string - - // The authentication strategy associated with the configuration. - AuthenticationStrategy AuthenticationStrategy - - // Required. The version of the broker engine. For a list of supported engine - // versions, see - // https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html - EngineVersion *string + // Required. The name of the configuration. This value can contain only + // alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). + // This value must be 1-150 characters long. + Name *string - // Required. The description of the configuration. - Description *string + // The list of all tags associated with this configuration. + Tags map[string]*string } // A list of information about the configuration. @@ -138,14 +138,14 @@ type ConfigurationId struct { // Returns information about the specified configuration revision. type ConfigurationRevision struct { - // Required. The revision number of the configuration. - Revision *int32 + // Required. The date and time of the configuration revision. + Created *time.Time // The description of the configuration revision. Description *string - // Required. The date and time of the configuration revision. - Created *time.Time + // Required. The revision number of the configuration. + Revision *int32 } // Broker configuration information @@ -186,17 +186,11 @@ type EngineVersion struct { // to the broker. type LdapServerMetadataInput struct { - // Service account username. - ServiceAccountUsername *string - - // Service account password. - ServiceAccountPassword *string - - // Specifies the name of the LDAP attribute for the user group membership. - UserRoleName *string + // Fully qualified domain name of the LDAP server. Optional failover server. + Hosts []*string - // Fully qualified name of the directory where you want to search for users. - UserBase *string + // Fully qualified name of the directory to search for a user’s groups. + RoleBase *string // Specifies the LDAP attribute that identifies the group name attribute in the // object returned from the group membership query. @@ -209,18 +203,24 @@ type LdapServerMetadataInput struct { // entire sub-tree. RoleSearchSubtree *bool - // Fully qualified domain name of the LDAP server. Optional failover server. - Hosts []*string + // Service account password. + ServiceAccountPassword *string - // Fully qualified name of the directory to search for a user’s groups. - RoleBase *string + // Service account username. + ServiceAccountUsername *string - // The directory search scope for the user. If set to true, scope is to search the - // entire sub-tree. - UserSearchSubtree *bool + // Fully qualified name of the directory where you want to search for users. + UserBase *string + + // Specifies the name of the LDAP attribute for the user group membership. + UserRoleName *string // The search criteria for users. UserSearchMatching *string + + // The directory search scope for the user. If set to true, scope is to search the + // entire sub-tree. + UserSearchSubtree *bool } // The metadata of the LDAP server used to authenticate and authorize connections @@ -230,68 +230,68 @@ type LdapServerMetadataOutput struct { // Fully qualified domain name of the LDAP server. Optional failover server. Hosts []*string + // Fully qualified name of the directory to search for a user’s groups. + RoleBase *string + + // Specifies the LDAP attribute that identifies the group name attribute in the + // object returned from the group membership query. + RoleName *string + + // The search criteria for groups. + RoleSearchMatching *string + // The directory search scope for the role. If set to true, scope is to search the // entire sub-tree. RoleSearchSubtree *bool + // Service account username. + ServiceAccountUsername *string + // Fully qualified name of the directory where you want to search for users. UserBase *string - // The search criteria for groups. - RoleSearchMatching *string - // Specifies the name of the LDAP attribute for the user group membership. UserRoleName *string - // Fully qualified name of the directory to search for a user’s groups. - RoleBase *string - - // Service account username. - ServiceAccountUsername *string - // The search criteria for users. UserSearchMatching *string // The directory search scope for the user. If set to true, scope is to search the // entire sub-tree. UserSearchSubtree *bool - - // Specifies the LDAP attribute that identifies the group name attribute in the - // object returned from the group membership query. - RoleName *string } // The list of information about logs to be enabled for the specified broker. type Logs struct { - // Enables general logging. - General *bool - // Enables audit logging. Every user management action made using JMX or the // ActiveMQ Web Console is logged. Audit *bool + + // Enables general logging. + General *bool } // The list of information about logs currently enabled and pending to be deployed // for the specified broker. type LogsSummary struct { + // Enables audit logging. Every user management action made using JMX or the + // ActiveMQ Web Console is logged. + Audit *bool + + // The location of the CloudWatch Logs log group where audit logs are sent. + AuditLogGroup *string + // Enables general logging. General *bool - // The list of information about logs pending to be deployed for the specified - // broker. - Pending *PendingLogs - // The location of the CloudWatch Logs log group where general logs are sent. GeneralLogGroup *string - // The location of the CloudWatch Logs log group where audit logs are sent. - AuditLogGroup *string - - // Enables audit logging. Every user management action made using JMX or the - // ActiveMQ Web Console is logged. - Audit *bool + // The list of information about logs pending to be deployed for the specified + // broker. + Pending *PendingLogs } // The list of information about logs to be enabled for the specified broker. @@ -309,12 +309,12 @@ type PendingLogs struct { // configuration. type SanitizationWarning struct { - // The name of the XML element that has been sanitized. - ElementName *string - // The name of the XML attribute that has been sanitized. AttributeName *string + // The name of the XML element that has been sanitized. + ElementName *string + // Required. The reason for which the XML elements or attributes were sanitized. Reason SanitizationWarningReason } @@ -322,32 +322,29 @@ type SanitizationWarning struct { // An ActiveMQ user associated with the broker. type User struct { + // Enables access to the the ActiveMQ Web Console for the ActiveMQ user. + ConsoleAccess *bool + // The list of groups (20 maximum) to which the ActiveMQ user belongs. This value // can contain only alphanumeric characters, dashes, periods, underscores, and // tildes (- . _ ~). This value must be 2-100 characters long. Groups []*string - // Required. The username of the ActiveMQ user. This value can contain only - // alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). - // This value must be 2-100 characters long. - Username *string - - // Enables access to the the ActiveMQ Web Console for the ActiveMQ user. - ConsoleAccess *bool - // Required. The password of the ActiveMQ user. This value must be at least 12 // characters long, must contain at least 4 unique characters, and must not contain // commas. Password *string + + // Required. The username of the ActiveMQ user. This value can contain only + // alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). + // This value must be 2-100 characters long. + Username *string } // Returns information about the status of the changes pending for the ActiveMQ // user. type UserPendingChanges struct { - // Required. The type of change pending for the ActiveMQ user. - PendingChange ChangeType - // Enables access to the the ActiveMQ Web Console for the ActiveMQ user. ConsoleAccess *bool @@ -355,6 +352,9 @@ type UserPendingChanges struct { // can contain only alphanumeric characters, dashes, periods, underscores, and // tildes (- . _ ~). This value must be 2-100 characters long. Groups []*string + + // Required. The type of change pending for the ActiveMQ user. + PendingChange ChangeType } // Returns a list of all ActiveMQ users. diff --git a/service/mturk/api_op_AcceptQualificationRequest.go b/service/mturk/api_op_AcceptQualificationRequest.go index ace70716018..605ad036501 100644 --- a/service/mturk/api_op_AcceptQualificationRequest.go +++ b/service/mturk/api_op_AcceptQualificationRequest.go @@ -59,15 +59,15 @@ func (c *Client) AcceptQualificationRequest(ctx context.Context, params *AcceptQ type AcceptQualificationRequestInput struct { - // The value of the Qualification. You can omit this value if you are using the - // presence or absence of the Qualification as the basis for a HIT requirement. - IntegerValue *int32 - // The ID of the Qualification request, as returned by the GetQualificationRequests // operation. // // This member is required. QualificationRequestId *string + + // The value of the Qualification. You can omit this value if you are using the + // presence or absence of the Qualification as the basis for a HIT requirement. + IntegerValue *int32 } type AcceptQualificationRequestOutput struct { diff --git a/service/mturk/api_op_ApproveAssignment.go b/service/mturk/api_op_ApproveAssignment.go index 07f16c45524..8daf48c81a0 100644 --- a/service/mturk/api_op_ApproveAssignment.go +++ b/service/mturk/api_op_ApproveAssignment.go @@ -73,16 +73,16 @@ func (c *Client) ApproveAssignment(ctx context.Context, params *ApproveAssignmen type ApproveAssignmentInput struct { - // A flag indicating that an assignment should be approved even if it was - // previously rejected. Defaults to False. - OverrideRejection *bool - // The ID of the assignment. The assignment must correspond to a HIT created by the // Requester. // // This member is required. AssignmentId *string + // A flag indicating that an assignment should be approved even if it was + // previously rejected. Defaults to False. + OverrideRejection *bool + // A message for the Worker, which the Worker can see in the Status section of the // web site. RequesterFeedback *string diff --git a/service/mturk/api_op_AssociateQualificationWithWorker.go b/service/mturk/api_op_AssociateQualificationWithWorker.go index 7f04bde3e2e..a5e723247b6 100644 --- a/service/mturk/api_op_AssociateQualificationWithWorker.go +++ b/service/mturk/api_op_AssociateQualificationWithWorker.go @@ -67,9 +67,6 @@ func (c *Client) AssociateQualificationWithWorker(ctx context.Context, params *A type AssociateQualificationWithWorkerInput struct { - // The value of the Qualification to assign. - IntegerValue *int32 - // The ID of the Qualification type to use for the assigned Qualification. // // This member is required. @@ -81,6 +78,9 @@ type AssociateQualificationWithWorkerInput struct { // This member is required. WorkerId *string + // The value of the Qualification to assign. + IntegerValue *int32 + // Specifies whether to send a notification email message to the Worker saying that // the qualification was assigned to the Worker. Note: this is true by default. SendNotification *bool diff --git a/service/mturk/api_op_CreateAdditionalAssignmentsForHIT.go b/service/mturk/api_op_CreateAdditionalAssignmentsForHIT.go index 2abfd3619bb..0f2a86bbfa7 100644 --- a/service/mturk/api_op_CreateAdditionalAssignmentsForHIT.go +++ b/service/mturk/api_op_CreateAdditionalAssignmentsForHIT.go @@ -69,15 +69,15 @@ func (c *Client) CreateAdditionalAssignmentsForHIT(ctx context.Context, params * type CreateAdditionalAssignmentsForHITInput struct { - // The number of additional assignments to request for this HIT. + // The ID of the HIT to extend. // // This member is required. - NumberOfAdditionalAssignments *int32 + HITId *string - // The ID of the HIT to extend. + // The number of additional assignments to request for this HIT. // // This member is required. - HITId *string + NumberOfAdditionalAssignments *int32 // A unique identifier for this request, which allows you to retry the call on // error without extending the HIT multiple times. This is useful in cases such as diff --git a/service/mturk/api_op_CreateHIT.go b/service/mturk/api_op_CreateHIT.go index 520e7c70d99..7d344619b79 100644 --- a/service/mturk/api_op_CreateHIT.go +++ b/service/mturk/api_op_CreateHIT.go @@ -74,11 +74,14 @@ func (c *Client) CreateHIT(ctx context.Context, params *CreateHITInput, optFns . type CreateHITInput struct { - // The HITLayoutId allows you to use a pre-existing HIT design with placeholder - // values and create an additional HIT by providing those values as - // HITLayoutParameters. Constraints: Either a Question parameter or a HITLayoutId - // parameter must be provided. - HITLayoutId *string + // The amount of time, in seconds, that a Worker has to complete the HIT after + // accepting it. If a Worker does not complete the assignment within the specified + // duration, the assignment is considered abandoned. If the HIT is still active + // (that is, its lifetime has not elapsed), the assignment becomes available for + // other users to find and accept. + // + // This member is required. + AssignmentDurationInSeconds *int64 // A general description of the HIT. A description includes detailed information // about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, @@ -89,19 +92,6 @@ type CreateHITInput struct { // This member is required. Description *string - // The amount of money the Requester will pay a Worker for successfully completing - // the HIT. - // - // This member is required. - Reward *string - - // Conditions that a Worker's Qualifications must meet in order to accept the HIT. - // A HIT can have between zero and ten Qualification requirements. All requirements - // must be met in order for a Worker to accept the HIT. Additionally, other actions - // can be restricted using the ActionsGuarded field on each - // QualificationRequirement structure. - QualificationRequirements []*types.QualificationRequirement - // An amount of time, in seconds, after which the HIT is no longer available for // users to accept. After the lifetime of the HIT elapses, the HIT no longer // appears in HIT searches, even if not all of the assignments for the HIT have @@ -110,14 +100,11 @@ type CreateHITInput struct { // This member is required. LifetimeInSeconds *int64 - // The amount of time, in seconds, that a Worker has to complete the HIT after - // accepting it. If a Worker does not complete the assignment within the specified - // duration, the assignment is considered abandoned. If the HIT is still active - // (that is, its lifetime has not elapsed), the assignment becomes available for - // other users to find and accept. + // The amount of money the Requester will pay a Worker for successfully completing + // the HIT. // // This member is required. - AssignmentDurationInSeconds *int64 + Reward *string // The title of the HIT. A title should be short and descriptive about the kind of // task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title @@ -126,22 +113,45 @@ type CreateHITInput struct { // This member is required. Title *string - // A unique identifier for this request which allows you to retry the call on error - // without creating duplicate HITs. This is useful in cases such as network - // timeouts where it is unclear whether or not the call succeeded on the server. If - // the HIT already exists in the system from a previous call using the same - // UniqueRequestToken, subsequent calls will return a - // AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId. - // Note: It is your responsibility to ensure uniqueness of the token. The unique - // token expires after 24 hours. Subsequent calls using the same UniqueRequestToken - // made after the 24 hour limit could create duplicate HITs. - UniqueRequestToken *string + // The Assignment-level Review Policy applies to the assignments under the HIT. You + // can specify for Mechanical Turk to take various actions based on the policy. + AssignmentReviewPolicy *types.ReviewPolicy // The number of seconds after an assignment for the HIT has been submitted, after // which the assignment is considered Approved automatically unless the Requester // explicitly rejects it. AutoApprovalDelayInSeconds *int64 + // The HITLayoutId allows you to use a pre-existing HIT design with placeholder + // values and create an additional HIT by providing those values as + // HITLayoutParameters. Constraints: Either a Question parameter or a HITLayoutId + // parameter must be provided. + HITLayoutId *string + + // If the HITLayoutId is provided, any placeholder values must be filled in with + // values using the HITLayoutParameter structure. For more information, see + // HITLayout. + HITLayoutParameters []*types.HITLayoutParameter + + // The HIT-level Review Policy applies to the HIT. You can specify for Mechanical + // Turk to take various actions based on the policy. + HITReviewPolicy *types.ReviewPolicy + + // One or more words or phrases that describe the HIT, separated by commas. These + // words are used in searches to find HITs. + Keywords *string + + // The number of times the HIT can be accepted and completed before the HIT becomes + // unavailable. + MaxAssignments *int32 + + // Conditions that a Worker's Qualifications must meet in order to accept the HIT. + // A HIT can have between zero and ten Qualification requirements. All requirements + // must be met in order for a Worker to accept the HIT. Additionally, other actions + // can be restricted using the ActionsGuarded field on each + // QualificationRequirement structure. + QualificationRequirements []*types.QualificationRequirement + // The data the person completing the HIT uses to produce the results. Constraints: // Must be a QuestionForm data structure, an ExternalQuestion data structure, or an // HTMLQuestion data structure. The XML question data must not be larger than 64 @@ -149,14 +159,6 @@ type CreateHITInput struct { // parameter or a HITLayoutId parameter must be provided. Question *string - // The HIT-level Review Policy applies to the HIT. You can specify for Mechanical - // Turk to take various actions based on the policy. - HITReviewPolicy *types.ReviewPolicy - - // The Assignment-level Review Policy applies to the assignments under the HIT. You - // can specify for Mechanical Turk to take various actions based on the policy. - AssignmentReviewPolicy *types.ReviewPolicy - // An arbitrary data field. The RequesterAnnotation parameter lets your application // attach arbitrary data to the HIT for tracking purposes. For example, this // parameter could be an identifier internal to the Requester's application that @@ -166,18 +168,16 @@ type CreateHITInput struct { // HIT you submit. It does not affect how your HITs are grouped. RequesterAnnotation *string - // If the HITLayoutId is provided, any placeholder values must be filled in with - // values using the HITLayoutParameter structure. For more information, see - // HITLayout. - HITLayoutParameters []*types.HITLayoutParameter - - // The number of times the HIT can be accepted and completed before the HIT becomes - // unavailable. - MaxAssignments *int32 - - // One or more words or phrases that describe the HIT, separated by commas. These - // words are used in searches to find HITs. - Keywords *string + // A unique identifier for this request which allows you to retry the call on error + // without creating duplicate HITs. This is useful in cases such as network + // timeouts where it is unclear whether or not the call succeeded on the server. If + // the HIT already exists in the system from a previous call using the same + // UniqueRequestToken, subsequent calls will return a + // AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId. + // Note: It is your responsibility to ensure uniqueness of the token. The unique + // token expires after 24 hours. Subsequent calls using the same UniqueRequestToken + // made after the 24 hour limit could create duplicate HITs. + UniqueRequestToken *string } type CreateHITOutput struct { diff --git a/service/mturk/api_op_CreateHITType.go b/service/mturk/api_op_CreateHITType.go index 68cffddfac2..e4bbdff535a 100644 --- a/service/mturk/api_op_CreateHITType.go +++ b/service/mturk/api_op_CreateHITType.go @@ -60,6 +60,15 @@ func (c *Client) CreateHITType(ctx context.Context, params *CreateHITTypeInput, type CreateHITTypeInput struct { + // The amount of time, in seconds, that a Worker has to complete the HIT after + // accepting it. If a Worker does not complete the assignment within the specified + // duration, the assignment is considered abandoned. If the HIT is still active + // (that is, its lifetime has not elapsed), the assignment becomes available for + // other users to find and accept. + // + // This member is required. + AssignmentDurationInSeconds *int64 + // A general description of the HIT. A description includes detailed information // about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, // the HIT description appears in the expanded view of search results, and in the @@ -69,25 +78,11 @@ type CreateHITTypeInput struct { // This member is required. Description *string - // Conditions that a Worker's Qualifications must meet in order to accept the HIT. - // A HIT can have between zero and ten Qualification requirements. All requirements - // must be met in order for a Worker to accept the HIT. Additionally, other actions - // can be restricted using the ActionsGuarded field on each - // QualificationRequirement structure. - QualificationRequirements []*types.QualificationRequirement - - // The amount of time, in seconds, that a Worker has to complete the HIT after - // accepting it. If a Worker does not complete the assignment within the specified - // duration, the assignment is considered abandoned. If the HIT is still active - // (that is, its lifetime has not elapsed), the assignment becomes available for - // other users to find and accept. + // The amount of money the Requester will pay a Worker for successfully completing + // the HIT. // // This member is required. - AssignmentDurationInSeconds *int64 - - // One or more words or phrases that describe the HIT, separated by commas. These - // words are used in searches to find HITs. - Keywords *string + Reward *string // The title of the HIT. A title should be short and descriptive about the kind of // task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title @@ -96,16 +91,21 @@ type CreateHITTypeInput struct { // This member is required. Title *string - // The amount of money the Requester will pay a Worker for successfully completing - // the HIT. - // - // This member is required. - Reward *string - // The number of seconds after an assignment for the HIT has been submitted, after // which the assignment is considered Approved automatically unless the Requester // explicitly rejects it. AutoApprovalDelayInSeconds *int64 + + // One or more words or phrases that describe the HIT, separated by commas. These + // words are used in searches to find HITs. + Keywords *string + + // Conditions that a Worker's Qualifications must meet in order to accept the HIT. + // A HIT can have between zero and ten Qualification requirements. All requirements + // must be met in order for a Worker to accept the HIT. Additionally, other actions + // can be restricted using the ActionsGuarded field on each + // QualificationRequirement structure. + QualificationRequirements []*types.QualificationRequirement } type CreateHITTypeOutput struct { diff --git a/service/mturk/api_op_CreateHITWithHITType.go b/service/mturk/api_op_CreateHITWithHITType.go index 9a579fccb3b..9de2c381faf 100644 --- a/service/mturk/api_op_CreateHITWithHITType.go +++ b/service/mturk/api_op_CreateHITWithHITType.go @@ -66,34 +66,48 @@ func (c *Client) CreateHITWithHITType(ctx context.Context, params *CreateHITWith type CreateHITWithHITTypeInput struct { + // The HIT type ID you want to create this HIT with. + // + // This member is required. + HITTypeId *string + + // An amount of time, in seconds, after which the HIT is no longer available for + // users to accept. After the lifetime of the HIT elapses, the HIT no longer + // appears in HIT searches, even if not all of the assignments for the HIT have + // been accepted. + // + // This member is required. + LifetimeInSeconds *int64 + // The Assignment-level Review Policy applies to the assignments under the HIT. You // can specify for Mechanical Turk to take various actions based on the policy. AssignmentReviewPolicy *types.ReviewPolicy + // The HITLayoutId allows you to use a pre-existing HIT design with placeholder + // values and create an additional HIT by providing those values as + // HITLayoutParameters. Constraints: Either a Question parameter or a HITLayoutId + // parameter must be provided. + HITLayoutId *string + // If the HITLayoutId is provided, any placeholder values must be filled in with // values using the HITLayoutParameter structure. For more information, see // HITLayout. HITLayoutParameters []*types.HITLayoutParameter + // The HIT-level Review Policy applies to the HIT. You can specify for Mechanical + // Turk to take various actions based on the policy. + HITReviewPolicy *types.ReviewPolicy + // The number of times the HIT can be accepted and completed before the HIT becomes // unavailable. MaxAssignments *int32 - // A unique identifier for this request which allows you to retry the call on error - // without creating duplicate HITs. This is useful in cases such as network - // timeouts where it is unclear whether or not the call succeeded on the server. If - // the HIT already exists in the system from a previous call using the same - // UniqueRequestToken, subsequent calls will return a - // AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId. - // Note: It is your responsibility to ensure uniqueness of the token. The unique - // token expires after 24 hours. Subsequent calls using the same UniqueRequestToken - // made after the 24 hour limit could create duplicate HITs. - UniqueRequestToken *string - - // The HIT type ID you want to create this HIT with. - // - // This member is required. - HITTypeId *string + // The data the person completing the HIT uses to produce the results. Constraints: + // Must be a QuestionForm data structure, an ExternalQuestion data structure, or an + // HTMLQuestion data structure. The XML question data must not be larger than 64 + // kilobytes (65,535 bytes) in size, including whitespace. Either a Question + // parameter or a HITLayoutId parameter must be provided. + Question *string // An arbitrary data field. The RequesterAnnotation parameter lets your application // attach arbitrary data to the HIT for tracking purposes. For example, this @@ -104,30 +118,16 @@ type CreateHITWithHITTypeInput struct { // HIT you submit. It does not affect how your HITs are grouped. RequesterAnnotation *string - // The data the person completing the HIT uses to produce the results. Constraints: - // Must be a QuestionForm data structure, an ExternalQuestion data structure, or an - // HTMLQuestion data structure. The XML question data must not be larger than 64 - // kilobytes (65,535 bytes) in size, including whitespace. Either a Question - // parameter or a HITLayoutId parameter must be provided. - Question *string - - // The HITLayoutId allows you to use a pre-existing HIT design with placeholder - // values and create an additional HIT by providing those values as - // HITLayoutParameters. Constraints: Either a Question parameter or a HITLayoutId - // parameter must be provided. - HITLayoutId *string - - // The HIT-level Review Policy applies to the HIT. You can specify for Mechanical - // Turk to take various actions based on the policy. - HITReviewPolicy *types.ReviewPolicy - - // An amount of time, in seconds, after which the HIT is no longer available for - // users to accept. After the lifetime of the HIT elapses, the HIT no longer - // appears in HIT searches, even if not all of the assignments for the HIT have - // been accepted. - // - // This member is required. - LifetimeInSeconds *int64 + // A unique identifier for this request which allows you to retry the call on error + // without creating duplicate HITs. This is useful in cases such as network + // timeouts where it is unclear whether or not the call succeeded on the server. If + // the HIT already exists in the system from a previous call using the same + // UniqueRequestToken, subsequent calls will return a + // AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId. + // Note: It is your responsibility to ensure uniqueness of the token. The unique + // token expires after 24 hours. Subsequent calls using the same UniqueRequestToken + // made after the 24 hour limit could create duplicate HITs. + UniqueRequestToken *string } type CreateHITWithHITTypeOutput struct { diff --git a/service/mturk/api_op_CreateQualificationType.go b/service/mturk/api_op_CreateQualificationType.go index 972b6889434..b89d26370dc 100644 --- a/service/mturk/api_op_CreateQualificationType.go +++ b/service/mturk/api_op_CreateQualificationType.go @@ -65,11 +65,12 @@ type CreateQualificationTypeInput struct { // This member is required. Description *string - // The answers to the Qualification test specified in the Test parameter, in the - // form of an AnswerKey data structure. Constraints: Must not be longer than 65535 - // bytes. Constraints: None. If not specified, you must process Qualification - // requests manually. - AnswerKey *string + // The name you give to the Qualification type. The type name is used to represent + // the Qualification to Workers, and to find the type using a Qualification type + // search. It must be unique across all of your Qualification types. + // + // This member is required. + Name *string // The initial status of the Qualification type. Constraints: Valid values are: // Active | Inactive @@ -77,22 +78,25 @@ type CreateQualificationTypeInput struct { // This member is required. QualificationTypeStatus types.QualificationTypeStatus - // The questions for the Qualification test a Worker must answer correctly to - // obtain a Qualification of this type. If this parameter is specified, - // TestDurationInSeconds must also be specified. Constraints: Must not be longer - // than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot - // be specified if AutoGranted is true. Constraints: None. If not specified, the - // Worker may request the Qualification without answering any questions. - Test *string + // The answers to the Qualification test specified in the Test parameter, in the + // form of an AnswerKey data structure. Constraints: Must not be longer than 65535 + // bytes. Constraints: None. If not specified, you must process Qualification + // requests manually. + AnswerKey *string - // The number of seconds the Worker has to complete the Qualification test, - // starting from the time the Worker requests the Qualification. - TestDurationInSeconds *int64 + // Specifies whether requests for the Qualification type are granted immediately, + // without prompting the Worker with a Qualification test. Constraints: If the Test + // parameter is specified, this parameter cannot be true. + AutoGranted *bool // The Qualification value to use for automatically granted Qualifications. This // parameter is used only if the AutoGranted parameter is true. AutoGrantedValue *int32 + // One or more words or phrases that describe the Qualification type, separated by + // commas. The keywords of a type make the type easier to find during a search. + Keywords *string + // The number of seconds that a Worker must wait after requesting a Qualification // of the Qualification type before the worker can retry the Qualification request. // Constraints: None. If not specified, retries are disabled and Workers can @@ -103,21 +107,17 @@ type CreateQualificationTypeInput struct { // and then create a new Qualification type with retries disabled. RetryDelayInSeconds *int64 - // One or more words or phrases that describe the Qualification type, separated by - // commas. The keywords of a type make the type easier to find during a search. - Keywords *string - - // The name you give to the Qualification type. The type name is used to represent - // the Qualification to Workers, and to find the type using a Qualification type - // search. It must be unique across all of your Qualification types. - // - // This member is required. - Name *string + // The questions for the Qualification test a Worker must answer correctly to + // obtain a Qualification of this type. If this parameter is specified, + // TestDurationInSeconds must also be specified. Constraints: Must not be longer + // than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot + // be specified if AutoGranted is true. Constraints: None. If not specified, the + // Worker may request the Qualification without answering any questions. + Test *string - // Specifies whether requests for the Qualification type are granted immediately, - // without prompting the Worker with a Qualification test. Constraints: If the Test - // parameter is specified, this parameter cannot be true. - AutoGranted *bool + // The number of seconds the Worker has to complete the Qualification test, + // starting from the time the Worker requests the Qualification. + TestDurationInSeconds *int64 } type CreateQualificationTypeOutput struct { diff --git a/service/mturk/api_op_DeleteWorkerBlock.go b/service/mturk/api_op_DeleteWorkerBlock.go index 8a285bb9206..19db2231478 100644 --- a/service/mturk/api_op_DeleteWorkerBlock.go +++ b/service/mturk/api_op_DeleteWorkerBlock.go @@ -61,14 +61,14 @@ func (c *Client) DeleteWorkerBlock(ctx context.Context, params *DeleteWorkerBloc type DeleteWorkerBlockInput struct { - // A message that explains the reason for unblocking the Worker. The Worker does - // not see this message. - Reason *string - // The ID of the Worker to unblock. // // This member is required. WorkerId *string + + // A message that explains the reason for unblocking the Worker. The Worker does + // not see this message. + Reason *string } type DeleteWorkerBlockOutput struct { diff --git a/service/mturk/api_op_GetAccountBalance.go b/service/mturk/api_op_GetAccountBalance.go index 2240a66c55f..4272afb3d90 100644 --- a/service/mturk/api_op_GetAccountBalance.go +++ b/service/mturk/api_op_GetAccountBalance.go @@ -60,10 +60,10 @@ type GetAccountBalanceInput struct { type GetAccountBalanceOutput struct { // A string representing a currency amount. - OnHoldBalance *string + AvailableBalance *string // A string representing a currency amount. - AvailableBalance *string + OnHoldBalance *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/mturk/api_op_GetAssignment.go b/service/mturk/api_op_GetAssignment.go index 3a22549d08f..1406f965864 100644 --- a/service/mturk/api_op_GetAssignment.go +++ b/service/mturk/api_op_GetAssignment.go @@ -65,12 +65,12 @@ type GetAssignmentInput struct { type GetAssignmentOutput struct { - // The HIT associated with this assignment. The response includes one HIT element. - HIT *types.HIT - // The assignment. The response includes one Assignment element. Assignment *types.Assignment + // The HIT associated with this assignment. The response includes one HIT element. + HIT *types.HIT + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mturk/api_op_GetFileUploadURL.go b/service/mturk/api_op_GetFileUploadURL.go index 67c52677b20..e9d49ded824 100644 --- a/service/mturk/api_op_GetFileUploadURL.go +++ b/service/mturk/api_op_GetFileUploadURL.go @@ -65,16 +65,16 @@ func (c *Client) GetFileUploadURL(ctx context.Context, params *GetFileUploadURLI type GetFileUploadURLInput struct { - // The identifier of the question with a FileUploadAnswer, as specified in the - // QuestionForm of the HIT. + // The ID of the assignment that contains the question with a FileUploadAnswer. // // This member is required. - QuestionIdentifier *string + AssignmentId *string - // The ID of the assignment that contains the question with a FileUploadAnswer. + // The identifier of the question with a FileUploadAnswer, as specified in the + // QuestionForm of the HIT. // // This member is required. - AssignmentId *string + QuestionIdentifier *string } type GetFileUploadURLOutput struct { diff --git a/service/mturk/api_op_GetQualificationScore.go b/service/mturk/api_op_GetQualificationScore.go index e26cb342c32..2f68aed8fec 100644 --- a/service/mturk/api_op_GetQualificationScore.go +++ b/service/mturk/api_op_GetQualificationScore.go @@ -61,15 +61,15 @@ func (c *Client) GetQualificationScore(ctx context.Context, params *GetQualifica type GetQualificationScoreInput struct { - // The ID of the Worker whose Qualification is being updated. + // The ID of the QualificationType. // // This member is required. - WorkerId *string + QualificationTypeId *string - // The ID of the QualificationType. + // The ID of the Worker whose Qualification is being updated. // // This member is required. - QualificationTypeId *string + WorkerId *string } type GetQualificationScoreOutput struct { diff --git a/service/mturk/api_op_ListAssignmentsForHIT.go b/service/mturk/api_op_ListAssignmentsForHIT.go index 3bd07268eb0..9982ac432ae 100644 --- a/service/mturk/api_op_ListAssignmentsForHIT.go +++ b/service/mturk/api_op_ListAssignmentsForHIT.go @@ -69,16 +69,17 @@ func (c *Client) ListAssignmentsForHIT(ctx context.Context, params *ListAssignme } type ListAssignmentsForHITInput struct { - MaxResults *int32 - - // The status of the assignments to return: Submitted | Approved | Rejected - AssignmentStatuses []types.AssignmentStatus // The ID of the HIT. // // This member is required. HITId *string + // The status of the assignments to return: Submitted | Approved | Rejected + AssignmentStatuses []types.AssignmentStatus + + MaxResults *int32 + // Pagination token NextToken *string } diff --git a/service/mturk/api_op_ListBonusPayments.go b/service/mturk/api_op_ListBonusPayments.go index 368e08d0d9f..899a6c165bf 100644 --- a/service/mturk/api_op_ListBonusPayments.go +++ b/service/mturk/api_op_ListBonusPayments.go @@ -57,8 +57,10 @@ func (c *Client) ListBonusPayments(ctx context.Context, params *ListBonusPayment type ListBonusPaymentsInput struct { - // Pagination token - NextToken *string + // The ID of the assignment associated with the bonus payments to retrieve. If + // specified, only bonus payments for the given assignment are returned. Either the + // HITId parameter or the AssignmentId parameter must be specified + AssignmentId *string // The ID of the HIT associated with the bonus payments to retrieve. If not // specified, all bonus payments for all assignments for the given HIT are @@ -68,10 +70,8 @@ type ListBonusPaymentsInput struct { MaxResults *int32 - // The ID of the assignment associated with the bonus payments to retrieve. If - // specified, only bonus payments for the given assignment are returned. Either the - // HITId parameter or the AssignmentId parameter must be specified - AssignmentId *string + // Pagination token + NextToken *string } type ListBonusPaymentsOutput struct { @@ -80,15 +80,15 @@ type ListBonusPaymentsOutput struct { // BonusPayment objects. BonusPayments []*types.BonusPayment - // The number of bonus payments on this page in the filtered results list, - // equivalent to the number of bonus payments being returned by this call. - NumResults *int32 - // If the previous response was incomplete (because there is more data to // retrieve), Amazon Mechanical Turk returns a pagination token in the response. // You can use this pagination token to retrieve the next set of results. NextToken *string + // The number of bonus payments on this page in the filtered results list, + // equivalent to the number of bonus payments being returned by this call. + NumResults *int32 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mturk/api_op_ListHITs.go b/service/mturk/api_op_ListHITs.go index 0104fa23936..7ff2c7014ec 100644 --- a/service/mturk/api_op_ListHITs.go +++ b/service/mturk/api_op_ListHITs.go @@ -65,17 +65,17 @@ type ListHITsInput struct { type ListHITsOutput struct { - // The number of HITs on this page in the filtered results list, equivalent to the - // number of HITs being returned by this call. - NumResults *int32 + // The list of HIT elements returned by the query. + HITs []*types.HIT // If the previous response was incomplete (because there is more data to // retrieve), Amazon Mechanical Turk returns a pagination token in the response. // You can use this pagination token to retrieve the next set of results. NextToken *string - // The list of HIT elements returned by the query. - HITs []*types.HIT + // The number of HITs on this page in the filtered results list, equivalent to the + // number of HITs being returned by this call. + NumResults *int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/mturk/api_op_ListHITsForQualificationType.go b/service/mturk/api_op_ListHITsForQualificationType.go index b3a88ad80b3..0ded9673f2f 100644 --- a/service/mturk/api_op_ListHITsForQualificationType.go +++ b/service/mturk/api_op_ListHITsForQualificationType.go @@ -65,26 +65,26 @@ type ListHITsForQualificationTypeInput struct { // This member is required. QualificationTypeId *string - // Pagination Token - NextToken *string - // Limit the number of results returned. MaxResults *int32 + + // Pagination Token + NextToken *string } type ListHITsForQualificationTypeOutput struct { - // The number of HITs on this page in the filtered results list, equivalent to the - // number of HITs being returned by this call. - NumResults *int32 + // The list of HIT elements returned by the query. + HITs []*types.HIT // If the previous response was incomplete (because there is more data to // retrieve), Amazon Mechanical Turk returns a pagination token in the response. // You can use this pagination token to retrieve the next set of results. NextToken *string - // The list of HIT elements returned by the query. - HITs []*types.HIT + // The number of HITs on this page in the filtered results list, equivalent to the + // number of HITs being returned by this call. + NumResults *int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/mturk/api_op_ListQualificationRequests.go b/service/mturk/api_op_ListQualificationRequests.go index ba5923a981b..265f4e4fc13 100644 --- a/service/mturk/api_op_ListQualificationRequests.go +++ b/service/mturk/api_op_ListQualificationRequests.go @@ -59,20 +59,25 @@ func (c *Client) ListQualificationRequests(ctx context.Context, params *ListQual type ListQualificationRequestsInput struct { - // The ID of the QualificationType. - QualificationTypeId *string + // The maximum number of results to return in a single call. + MaxResults *int32 // If the previous response was incomplete (because there is more data to // retrieve), Amazon Mechanical Turk returns a pagination token in the response. // You can use this pagination token to retrieve the next set of results. NextToken *string - // The maximum number of results to return in a single call. - MaxResults *int32 + // The ID of the QualificationType. + QualificationTypeId *string } type ListQualificationRequestsOutput struct { + // If the previous response was incomplete (because there is more data to + // retrieve), Amazon Mechanical Turk returns a pagination token in the response. + // You can use this pagination token to retrieve the next set of results. + NextToken *string + // The number of Qualification requests on this page in the filtered results list, // equivalent to the number of Qualification requests being returned by this call. NumResults *int32 @@ -81,11 +86,6 @@ type ListQualificationRequestsOutput struct { // element for each Qualification request returned by the query. QualificationRequests []*types.QualificationRequest - // If the previous response was incomplete (because there is more data to - // retrieve), Amazon Mechanical Turk returns a pagination token in the response. - // You can use this pagination token to retrieve the next set of results. - NextToken *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mturk/api_op_ListQualificationTypes.go b/service/mturk/api_op_ListQualificationTypes.go index d3f90dad122..178bb318cfb 100644 --- a/service/mturk/api_op_ListQualificationTypes.go +++ b/service/mturk/api_op_ListQualificationTypes.go @@ -71,15 +71,15 @@ type ListQualificationTypesInput struct { // The maximum number of results to return in a single call. MaxResults *int32 + // Specifies that only Qualification types that the Requester created are returned. + // If false, the operation returns all Qualification types. + MustBeOwnedByCaller *bool + // If the previous response was incomplete (because there is more data to // retrieve), Amazon Mechanical Turk returns a pagination token in the response. // You can use this pagination token to retrieve the next set of results. NextToken *string - // Specifies that only Qualification types that the Requester created are returned. - // If false, the operation returns all Qualification types. - MustBeOwnedByCaller *bool - // A text query against all of the searchable attributes of Qualification types. Query *string } @@ -91,13 +91,13 @@ type ListQualificationTypesOutput struct { // You can use this pagination token to retrieve the next set of results. NextToken *string - // The list of QualificationType elements returned by the query. - QualificationTypes []*types.QualificationType - // The number of Qualification types on this page in the filtered results list, // equivalent to the number of types this operation returns. NumResults *int32 + // The list of QualificationType elements returned by the query. + QualificationTypes []*types.QualificationType + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mturk/api_op_ListReviewPolicyResultsForHIT.go b/service/mturk/api_op_ListReviewPolicyResultsForHIT.go index 71b6b27728e..fc238bc0262 100644 --- a/service/mturk/api_op_ListReviewPolicyResultsForHIT.go +++ b/service/mturk/api_op_ListReviewPolicyResultsForHIT.go @@ -61,55 +61,55 @@ func (c *Client) ListReviewPolicyResultsForHIT(ctx context.Context, params *List type ListReviewPolicyResultsForHITInput struct { + // The unique identifier of the HIT to retrieve review results for. + // + // This member is required. + HITId *string + // Limit the number of results returned. MaxResults *int32 // Pagination token NextToken *string - // Specify if the operation should retrieve a list of the results computed by the - // Review Policies. - RetrieveResults *bool - // The Policy Level(s) to retrieve review results for - HIT or Assignment. If // omitted, the default behavior is to retrieve all data for both policy levels. // For a list of all the described policies, see Review Policies. PolicyLevels []types.ReviewPolicyLevel - // The unique identifier of the HIT to retrieve review results for. - // - // This member is required. - HITId *string - // Specify if the operation should retrieve a list of the actions taken executing // the Review Policies and their outcomes. RetrieveActions *bool + + // Specify if the operation should retrieve a list of the results computed by the + // Review Policies. + RetrieveResults *bool } type ListReviewPolicyResultsForHITOutput struct { - // Contains both ReviewResult and ReviewAction elements for a particular HIT. - HITReviewReport *types.ReviewReport + // The name of the Assignment-level Review Policy. This contains only the + // PolicyName element. + AssignmentReviewPolicy *types.ReviewPolicy + + // Contains both ReviewResult and ReviewAction elements for an Assignment. + AssignmentReviewReport *types.ReviewReport + + // The HITId of the HIT for which results have been returned. + HITId *string // The name of the HIT-level Review Policy. This contains only the PolicyName // element. HITReviewPolicy *types.ReviewPolicy - // The name of the Assignment-level Review Policy. This contains only the - // PolicyName element. - AssignmentReviewPolicy *types.ReviewPolicy + // Contains both ReviewResult and ReviewAction elements for a particular HIT. + HITReviewReport *types.ReviewReport // If the previous response was incomplete (because there is more data to // retrieve), Amazon Mechanical Turk returns a pagination token in the response. // You can use this pagination token to retrieve the next set of results. NextToken *string - // The HITId of the HIT for which results have been returned. - HITId *string - - // Contains both ReviewResult and ReviewAction elements for an Assignment. - AssignmentReviewReport *types.ReviewReport - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mturk/api_op_ListReviewableHITs.go b/service/mturk/api_op_ListReviewableHITs.go index 77b563a2f5f..3ec8682b2a6 100644 --- a/service/mturk/api_op_ListReviewableHITs.go +++ b/service/mturk/api_op_ListReviewableHITs.go @@ -58,9 +58,6 @@ func (c *Client) ListReviewableHITs(ctx context.Context, params *ListReviewableH type ListReviewableHITsInput struct { - // Can be either Reviewable or Reviewing. Reviewable is the default value. - Status types.ReviewableHITStatus - // The ID of the HIT type of the HITs to consider for the query. If not specified, // all HITs for the Reviewer are considered HITTypeId *string @@ -70,6 +67,9 @@ type ListReviewableHITsInput struct { // Pagination Token NextToken *string + + // Can be either Reviewable or Reviewing. Reviewable is the default value. + Status types.ReviewableHITStatus } type ListReviewableHITsOutput struct { diff --git a/service/mturk/api_op_ListWorkerBlocks.go b/service/mturk/api_op_ListWorkerBlocks.go index 847efcb99e1..e6b586947ae 100644 --- a/service/mturk/api_op_ListWorkerBlocks.go +++ b/service/mturk/api_op_ListWorkerBlocks.go @@ -64,10 +64,6 @@ type ListWorkerBlocksInput struct { type ListWorkerBlocksOutput struct { - // The list of WorkerBlocks, containing the collection of Worker IDs and reasons - // for blocking. - WorkerBlocks []*types.WorkerBlock - // If the previous response was incomplete (because there is more data to // retrieve), Amazon Mechanical Turk returns a pagination token in the response. // You can use this pagination token to retrieve the next set of results. @@ -77,6 +73,10 @@ type ListWorkerBlocksOutput struct { // to the number of assignments returned by this call. NumResults *int32 + // The list of WorkerBlocks, containing the collection of Worker IDs and reasons + // for blocking. + WorkerBlocks []*types.WorkerBlock + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/mturk/api_op_ListWorkersWithQualificationType.go b/service/mturk/api_op_ListWorkersWithQualificationType.go index 892632b189b..246335f5bf3 100644 --- a/service/mturk/api_op_ListWorkersWithQualificationType.go +++ b/service/mturk/api_op_ListWorkersWithQualificationType.go @@ -63,12 +63,12 @@ type ListWorkersWithQualificationTypeInput struct { // This member is required. QualificationTypeId *string - // Pagination Token - NextToken *string - // Limit the number of results returned. MaxResults *int32 + // Pagination Token + NextToken *string + // The status of the Qualifications to return. Can be Granted | Revoked. Status types.QualificationStatus } diff --git a/service/mturk/api_op_NotifyWorkers.go b/service/mturk/api_op_NotifyWorkers.go index ab00a44f2e4..3241b49e157 100644 --- a/service/mturk/api_op_NotifyWorkers.go +++ b/service/mturk/api_op_NotifyWorkers.go @@ -61,12 +61,6 @@ func (c *Client) NotifyWorkers(ctx context.Context, params *NotifyWorkersInput, type NotifyWorkersInput struct { - // A list of Worker IDs you wish to notify. You can notify upto 100 Workers at a - // time. - // - // This member is required. - WorkerIds []*string - // The text of the email message to send. Can include up to 4,096 characters // // This member is required. @@ -76,6 +70,12 @@ type NotifyWorkersInput struct { // // This member is required. Subject *string + + // A list of Worker IDs you wish to notify. You can notify upto 100 Workers at a + // time. + // + // This member is required. + WorkerIds []*string } type NotifyWorkersOutput struct { diff --git a/service/mturk/api_op_SendBonus.go b/service/mturk/api_op_SendBonus.go index 96887e8d3ed..c0189fee673 100644 --- a/service/mturk/api_op_SendBonus.go +++ b/service/mturk/api_op_SendBonus.go @@ -68,6 +68,13 @@ type SendBonusInput struct { // This member is required. AssignmentId *string + // The Bonus amount is a US Dollar amount specified using a string (for example, + // "5" represents $5.00 USD and "101.42" represents $101.42 USD). Do not include + // currency symbols or currency codes. + // + // This member is required. + BonusAmount *string + // A message that explains the reason for the bonus payment. The Worker receiving // the bonus can see this message. // @@ -79,13 +86,6 @@ type SendBonusInput struct { // This member is required. WorkerId *string - // The Bonus amount is a US Dollar amount specified using a string (for example, - // "5" represents $5.00 USD and "101.42" represents $101.42 USD). Do not include - // currency symbols or currency codes. - // - // This member is required. - BonusAmount *string - // A unique identifier for this request, which allows you to retry the call on // error without granting multiple bonuses. This is useful in cases such as network // timeouts where it is unclear whether or not the call succeeded on the server. If diff --git a/service/mturk/api_op_UpdateExpirationForHIT.go b/service/mturk/api_op_UpdateExpirationForHIT.go index 7e17ab04b7b..72b480d1718 100644 --- a/service/mturk/api_op_UpdateExpirationForHIT.go +++ b/service/mturk/api_op_UpdateExpirationForHIT.go @@ -59,15 +59,15 @@ func (c *Client) UpdateExpirationForHIT(ctx context.Context, params *UpdateExpir type UpdateExpirationForHITInput struct { - // The HIT to update. + // The date and time at which you want the HIT to expire // // This member is required. - HITId *string + ExpireAt *time.Time - // The date and time at which you want the HIT to expire + // The HIT to update. // // This member is required. - ExpireAt *time.Time + HITId *string } type UpdateExpirationForHITOutput struct { diff --git a/service/mturk/api_op_UpdateHITReviewStatus.go b/service/mturk/api_op_UpdateHITReviewStatus.go index af761eb5f4d..2afcd99429c 100644 --- a/service/mturk/api_op_UpdateHITReviewStatus.go +++ b/service/mturk/api_op_UpdateHITReviewStatus.go @@ -58,6 +58,11 @@ func (c *Client) UpdateHITReviewStatus(ctx context.Context, params *UpdateHITRev type UpdateHITReviewStatusInput struct { + // The ID of the HIT to update. + // + // This member is required. + HITId *string + // Specifies how to update the HIT status. Default is False. // // * Setting this to @@ -66,11 +71,6 @@ type UpdateHITReviewStatusInput struct { // * Setting // this to true will only transition a HIT from Reviewing to Reviewable Revert *bool - - // The ID of the HIT to update. - // - // This member is required. - HITId *string } type UpdateHITReviewStatusOutput struct { diff --git a/service/mturk/api_op_UpdateHITTypeOfHIT.go b/service/mturk/api_op_UpdateHITTypeOfHIT.go index ca0b0eae08c..c92d5fc980b 100644 --- a/service/mturk/api_op_UpdateHITTypeOfHIT.go +++ b/service/mturk/api_op_UpdateHITTypeOfHIT.go @@ -59,15 +59,15 @@ func (c *Client) UpdateHITTypeOfHIT(ctx context.Context, params *UpdateHITTypeOf type UpdateHITTypeOfHITInput struct { - // The ID of the new HIT type. + // The HIT to update. // // This member is required. - HITTypeId *string + HITId *string - // The HIT to update. + // The ID of the new HIT type. // // This member is required. - HITId *string + HITTypeId *string } type UpdateHITTypeOfHITOutput struct { diff --git a/service/mturk/api_op_UpdateNotificationSettings.go b/service/mturk/api_op_UpdateNotificationSettings.go index a24287352c9..8ffd85f737b 100644 --- a/service/mturk/api_op_UpdateNotificationSettings.go +++ b/service/mturk/api_op_UpdateNotificationSettings.go @@ -67,17 +67,17 @@ func (c *Client) UpdateNotificationSettings(ctx context.Context, params *UpdateN type UpdateNotificationSettingsInput struct { + // The ID of the HIT type whose notification specification is being updated. + // + // This member is required. + HITTypeId *string + // Specifies whether notifications are sent for HITs of this HIT type, according to // the notification specification. You must specify either the Notification // parameter or the Active parameter for the call to UpdateNotificationSettings to // succeed. Active *bool - // The ID of the HIT type whose notification specification is being updated. - // - // This member is required. - HITTypeId *string - // The notification specification for the HIT type. Notification *types.NotificationSpecification } diff --git a/service/mturk/api_op_UpdateQualificationType.go b/service/mturk/api_op_UpdateQualificationType.go index 6698eeb13d5..139d507fe96 100644 --- a/service/mturk/api_op_UpdateQualificationType.go +++ b/service/mturk/api_op_UpdateQualificationType.go @@ -84,34 +84,33 @@ type UpdateQualificationTypeInput struct { // This member is required. QualificationTypeId *string - // The amount of time, in seconds, that Workers must wait after requesting a - // Qualification of the specified Qualification type before they can retry the - // Qualification request. It is not possible to disable retries for a Qualification - // type after it has been created with retries enabled. If you want to disable - // retries, you must dispose of the existing retry-enabled Qualification type using - // DisposeQualificationType and then create a new Qualification type with retries - // disabled using CreateQualificationType. - RetryDelayInSeconds *int64 + // The answers to the Qualification test specified in the Test parameter, in the + // form of an AnswerKey data structure. + AnswerKey *string // Specifies whether requests for the Qualification type are granted immediately, // without prompting the Worker with a Qualification test. Constraints: If the Test // parameter is specified, this parameter cannot be true. AutoGranted *bool - // The answers to the Qualification test specified in the Test parameter, in the - // form of an AnswerKey data structure. - AnswerKey *string + // The Qualification value to use for automatically granted Qualifications. This + // parameter is used only if the AutoGranted parameter is true. + AutoGrantedValue *int32 - // The number of seconds the Worker has to complete the Qualification test, - // starting from the time the Worker requests the Qualification. - TestDurationInSeconds *int64 + // The new description of the Qualification type. + Description *string // The new status of the Qualification type - Active | Inactive QualificationTypeStatus types.QualificationTypeStatus - // The Qualification value to use for automatically granted Qualifications. This - // parameter is used only if the AutoGranted parameter is true. - AutoGrantedValue *int32 + // The amount of time, in seconds, that Workers must wait after requesting a + // Qualification of the specified Qualification type before they can retry the + // Qualification request. It is not possible to disable retries for a Qualification + // type after it has been created with retries enabled. If you want to disable + // retries, you must dispose of the existing retry-enabled Qualification type using + // DisposeQualificationType and then create a new Qualification type with retries + // disabled using CreateQualificationType. + RetryDelayInSeconds *int64 // The questions for the Qualification test a Worker must answer correctly to // obtain a Qualification of this type. If this parameter is specified, @@ -121,8 +120,9 @@ type UpdateQualificationTypeInput struct { // Worker may request the Qualification without answering any questions. Test *string - // The new description of the Qualification type. - Description *string + // The number of seconds the Worker has to complete the Qualification test, + // starting from the time the Worker requests the Qualification. + TestDurationInSeconds *int64 } type UpdateQualificationTypeOutput struct { diff --git a/service/mturk/go.mod b/service/mturk/go.mod index 126d0417a2a..06be8b2169b 100644 --- a/service/mturk/go.mod +++ b/service/mturk/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/mturk go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/mturk/types/types.go b/service/mturk/types/types.go index 5c60b8aa2ba..e096dbd2357 100644 --- a/service/mturk/types/types.go +++ b/service/mturk/types/types.go @@ -11,10 +11,26 @@ import ( // contains the results for later retrieval. type Assignment struct { - // The date and time of the deadline for the assignment. This value is derived from - // the deadline specification for the HIT and the date and time the Worker accepted - // the HIT. - Deadline *time.Time + // The date and time the Worker accepted the assignment. + AcceptTime *time.Time + + // The Worker's answers submitted for the HIT contained in a QuestionFormAnswers + // document, if the Worker provides an answer. If the Worker does not provide any + // answers, Answer may contain a QuestionFormAnswers document, or Answer may be + // empty. + Answer *string + + // If the Worker has submitted results and the Requester has approved the results, + // ApprovalTime is the date and time the Requester approved the results. This value + // is omitted from the assignment if the Requester has not yet approved the + // results. + ApprovalTime *time.Time + + // A unique identifier for the assignment. + AssignmentId *string + + // The status of the assignment. + AssignmentStatus AssignmentStatus // If results have been submitted, AutoApprovalTime is the date and time the // results of the assignment results are considered Approved automatically if they @@ -24,23 +40,17 @@ type Assignment struct { // submitted results. AutoApprovalTime *time.Time - // The status of the assignment. - AssignmentStatus AssignmentStatus - - // A unique identifier for the assignment. - AssignmentId *string + // The date and time of the deadline for the assignment. This value is derived from + // the deadline specification for the HIT and the date and time the Worker accepted + // the HIT. + Deadline *time.Time // The ID of the HIT. HITId *string - // The date and time the Worker accepted the assignment. - AcceptTime *time.Time - - // If the Worker has submitted results and the Requester has approved the results, - // ApprovalTime is the date and time the Requester approved the results. This value - // is omitted from the assignment if the Requester has not yet approved the - // results. - ApprovalTime *time.Time + // If the Worker has submitted results and the Requester has rejected the results, + // RejectionTime is the date and time the Requester rejected the results. + RejectionTime *time.Time // The feedback string included with the call to the ApproveAssignment operation or // the RejectAssignment operation, if the Requester approved or rejected the @@ -54,90 +64,89 @@ type Assignment struct { // The ID of the Worker who accepted the HIT. WorkerId *string - - // The Worker's answers submitted for the HIT contained in a QuestionFormAnswers - // document, if the Worker provides an answer. If the Worker does not provide any - // answers, Answer may contain a QuestionFormAnswers document, or Answer may be - // empty. - Answer *string - - // If the Worker has submitted results and the Requester has rejected the results, - // RejectionTime is the date and time the Requester rejected the results. - RejectionTime *time.Time } // An object representing a Bonus payment paid to a Worker. type BonusPayment struct { - // The Reason text given when the bonus was granted, if any. - Reason *string + // The ID of the assignment associated with this bonus payment. + AssignmentId *string + + // A string representing a currency amount. + BonusAmount *string // The date and time of when the bonus was granted. GrantTime *time.Time - // A string representing a currency amount. - BonusAmount *string + // The Reason text given when the bonus was granted, if any. + Reason *string // The ID of the Worker to whom the bonus was paid. WorkerId *string - - // The ID of the assignment associated with this bonus payment. - AssignmentId *string } // The HIT data structure represents a single HIT, including all the information // necessary for a Worker to accept and complete the HIT. type HIT struct { - // The number of times the HIT can be accepted and completed before the HIT becomes - // unavailable. - MaxAssignments *int32 - - // The status of the HIT and its assignments. Valid Values are Assignable | - // Unassignable | Reviewable | Reviewing | Disposed. - HITStatus HITStatus + // The length of time, in seconds, that a Worker has to complete the HIT after + // accepting it. + AssignmentDurationInSeconds *int64 - // The ID of the HIT type of this HIT - HITTypeId *string + // The amount of time, in seconds, after the Worker submits an assignment for the + // HIT that the results are automatically approved by Amazon Mechanical Turk. This + // is the amount of time the Requester has to reject an assignment submitted by a + // Worker before the assignment is auto-approved and the Worker is paid. + AutoApprovalDelayInSeconds *int64 // The date and time the HIT was created. CreationTime *time.Time - // The length of time, in seconds, that a Worker has to complete the HIT after - // accepting it. - AssignmentDurationInSeconds *int64 + // A general description of the HIT. + Description *string // The date and time the HIT expires. Expiration *time.Time - // A general description of the HIT. - Description *string - // The ID of the HIT Group of this HIT. HITGroupId *string + // A unique identifier for the HIT. + HITId *string + + // The ID of the HIT Layout of this HIT. + HITLayoutId *string + + // Indicates the review status of the HIT. Valid Values are NotReviewed | + // MarkedForReview | ReviewedAppropriate | ReviewedInappropriate. + HITReviewStatus HITReviewStatus + + // The status of the HIT and its assignments. Valid Values are Assignable | + // Unassignable | Reviewable | Reviewing | Disposed. + HITStatus HITStatus + + // The ID of the HIT type of this HIT + HITTypeId *string + // One or more words or phrases that describe the HIT, separated by commas. Search // terms similar to the keywords of a HIT are more likely to have the HIT in the // search results. Keywords *string - // An arbitrary data field the Requester who created the HIT can use. This field is - // visible only to the creator of the HIT. - RequesterAnnotation *string - - // The number of assignments for this HIT that have been approved or rejected. - NumberOfAssignmentsCompleted *int32 + // The number of times the HIT can be accepted and completed before the HIT becomes + // unavailable. + MaxAssignments *int32 // The number of assignments for this HIT that are available for Workers to accept. NumberOfAssignmentsAvailable *int32 + // The number of assignments for this HIT that have been approved or rejected. + NumberOfAssignmentsCompleted *int32 + // The number of assignments for this HIT that are being previewed or have been // accepted by Workers, but have not yet been submitted, returned, or abandoned. NumberOfAssignmentsPending *int32 - // The ID of the HIT Layout of this HIT. - HITLayoutId *string - // Conditions that a Worker's Qualifications must meet in order to accept the HIT. // A HIT can have between zero and ten Qualification requirements. All requirements // must be met in order for a Worker to accept the HIT. Additionally, other actions @@ -145,25 +154,16 @@ type HIT struct { // QualificationRequirement structure. QualificationRequirements []*QualificationRequirement - // The amount of time, in seconds, after the Worker submits an assignment for the - // HIT that the results are automatically approved by Amazon Mechanical Turk. This - // is the amount of time the Requester has to reject an assignment submitted by a - // Worker before the assignment is auto-approved and the Worker is paid. - AutoApprovalDelayInSeconds *int64 - - // A string representing a currency amount. - Reward *string - // The data the Worker completing the HIT uses produce the results. This is either // either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure. Question *string - // Indicates the review status of the HIT. Valid Values are NotReviewed | - // MarkedForReview | ReviewedAppropriate | ReviewedInappropriate. - HITReviewStatus HITReviewStatus + // An arbitrary data field the Requester who created the HIT can use. This field is + // visible only to the creator of the HIT. + RequesterAnnotation *string - // A unique identifier for the HIT. - HITId *string + // A string representing a currency amount. + Reward *string // The title of the HIT. Title *string @@ -203,6 +203,20 @@ type Locale struct { // for a HIT type. type NotificationSpecification struct { + // The target for notification messages. The Destination’s format is determined by + // the specified Transport: + // + // * When Transport is Email, the Destination is your + // email address. + // + // * When Transport is SQS, the Destination is your queue + // URL. + // + // * When Transport is SNS, the Destination is the ARN of your topic. + // + // This member is required. + Destination *string + // The list of events that should cause notifications to be sent. Valid Values: // AssignmentAccepted | AssignmentAbandoned | AssignmentReturned | // AssignmentSubmitted | AssignmentRejected | AssignmentApproved | HITCreated | @@ -218,20 +232,6 @@ type NotificationSpecification struct { // This member is required. Transport NotificationTransport - // The target for notification messages. The Destination’s format is determined by - // the specified Transport: - // - // * When Transport is Email, the Destination is your - // email address. - // - // * When Transport is SQS, the Destination is your queue - // URL. - // - // * When Transport is SNS, the Destination is the ARN of your topic. - // - // This member is required. - Destination *string - // The version of the Notification API to use. Valid value is 2006-05-05. // // This member is required. @@ -242,28 +242,28 @@ type NotificationSpecification struct { // returns back this object with failure details. type NotifyWorkersFailureStatus struct { + // Encoded value for the failure type. + NotifyWorkersFailureCode NotifyWorkersFailureCode + // A message detailing the reason the Worker could not be notified. NotifyWorkersFailureMessage *string // The ID of the Worker. WorkerId *string - - // Encoded value for the failure type. - NotifyWorkersFailureCode NotifyWorkersFailureCode } // This data structure is the data type for the AnswerKey parameter of the // ScoreMyKnownAnswers/2011-09-01 Review Policy. type ParameterMapEntry struct { - // The list of answers to the question specified in the MapEntry Key element. The - // Worker must match all values in order for the answer to be scored correctly. - Values []*string - // The QuestionID from the HIT that is used to identify which question requires // Mechanical Turk to score as part of the ScoreMyKnownAnswers/2011-09-01 Review // Policy. Key *string + + // The list of answers to the question specified in the MapEntry Key element. The + // Worker must match all values in order for the answer to be scored correctly. + Values []*string } // Name of the parameter from the Review policy. @@ -272,17 +272,23 @@ type PolicyParameter struct { // Name of the parameter from the list of Review Polices. Key *string - // The list of values of the Parameter - Values []*string - // List of ParameterMapEntry objects. MapEntries []*ParameterMapEntry + + // The list of values of the Parameter + Values []*string } // The Qualification data structure represents a Qualification assigned to a user, // including the Qualification type and the value (score). type Qualification struct { + // The date and time the Qualification was granted to the Worker. If the Worker's + // Qualification was revoked, and then re-granted based on a new Qualification + // request, GrantTime is the date and time of the last call to the + // AcceptQualificationRequest operation. + GrantTime *time.Time + // The value (score) of the Qualification, if the Qualification has an integer // value. IntegerValue *int32 @@ -290,54 +296,48 @@ type Qualification struct { // The Locale data structure represents a geographical region or location. LocaleValue *Locale - // The ID of the Worker who possesses the Qualification. - WorkerId *string - // The ID of the Qualification type for the Qualification. QualificationTypeId *string - // The date and time the Qualification was granted to the Worker. If the Worker's - // Qualification was revoked, and then re-granted based on a new Qualification - // request, GrantTime is the date and time of the last call to the - // AcceptQualificationRequest operation. - GrantTime *time.Time - // The status of the Qualification. Valid values are Granted | Revoked. Status QualificationStatus + + // The ID of the Worker who possesses the Qualification. + WorkerId *string } // The QualificationRequest data structure represents a request a Worker has made // for a Qualification. type QualificationRequest struct { - // The ID of the Qualification type the Worker is requesting, as returned by the - // CreateQualificationType operation. - QualificationTypeId *string - - // The ID of the Worker requesting the Qualification. - WorkerId *string + // The Worker's answers for the Qualification type's test contained in a + // QuestionFormAnswers document, if the type has a test and the Worker has + // submitted answers. If the Worker does not provide any answers, Answer may be + // empty. + Answer *string // The ID of the Qualification request, a unique identifier generated when the // request was submitted.

    QualificationRequestId *string + // The ID of the Qualification type the Worker is requesting, as returned by the + // CreateQualificationType operation. + QualificationTypeId *string + // The date and time the Qualification request had a status of Submitted. This is // either the time the Worker submitted answers for a Qualification test, or the // time the Worker requested the Qualification if the Qualification type does not // have a test. SubmitTime *time.Time - // The Worker's answers for the Qualification type's test contained in a - // QuestionFormAnswers document, if the type has a test and the Worker has - // submitted answers. If the Worker does not provide any answers, Answer may be - // empty. - Answer *string - // The contents of the Qualification test that was presented to the Worker, if the // type has a test and the Worker has submitted answers. This value is identical to // the QuestionForm associated with the Qualification type at the time the Worker // requests the Qualification. Test *string + + // The ID of the Worker requesting the Qualification. + WorkerId *string } // The QualificationRequirement data structure describes a Qualification that a @@ -346,6 +346,23 @@ type QualificationRequest struct { // the HIT, or see the HIT in search results. type QualificationRequirement struct { + // The kind of comparison to make against a Qualification's value. You can compare + // a Qualification's value to an IntegerValue to see if it is LessThan, + // LessThanOrEqualTo, GreaterThan, GreaterThanOrEqualTo, EqualTo, or NotEqualTo the + // IntegerValue. You can compare it to a LocaleValue to see if it is EqualTo, or + // NotEqualTo the LocaleValue. You can check to see if the value is In or NotIn a + // set of IntegerValue or LocaleValue values. Lastly, a Qualification requirement + // can also test if a Qualification Exists or DoesNotExist in the user's profile, + // regardless of its value. + // + // This member is required. + Comparator Comparator + + // The ID of the Qualification type for the requirement. + // + // This member is required. + QualificationTypeId *string + // Setting this attribute prevents Workers whose Qualifications do not meet this // QualificationRequirement from taking the specified action. Valid arguments // include "Accept" (Worker cannot accept the HIT, but can preview the HIT and see @@ -365,17 +382,13 @@ type QualificationRequirement struct { // field. ActionsGuarded HITAccessActions - // DEPRECATED: Use the ActionsGuarded field instead. If RequiredToPreview is true, - // the question data for the HIT will not be shown when a Worker whose - // Qualifications do not meet this requirement tries to preview the HIT. That is, a - // Worker's Qualifications must meet all of the requirements for which - // RequiredToPreview is true in order to preview the HIT. If a Worker meets all of - // the requirements where RequiredToPreview is true (or if there are no such - // requirements), but does not meet all of the requirements for the HIT, the Worker - // will be allowed to preview the HIT's question data, but will not be allowed to - // accept and complete the HIT. The default is false. This should not be used in - // combination with the ActionsGuarded field. - RequiredToPreview *bool + // The integer value to compare against the Qualification's value. IntegerValue + // must not be present if Comparator is Exists or DoesNotExist. IntegerValue can + // only be used if the Qualification type has an integer value; it cannot be used + // with the Worker_Locale QualificationType ID. When performing a set comparison by + // using the In or the NotIn comparator, you can use up to 15 IntegerValue elements + // in a QualificationRequirement data structure. + IntegerValues []*int32 // The locale value to compare against the Qualification's value. The local value // must be a valid ISO 3166 country code or supports ISO 3166-2 subdivisions. @@ -387,30 +400,17 @@ type QualificationRequirement struct { // QualificationRequirement data structure. LocaleValues []*Locale - // The integer value to compare against the Qualification's value. IntegerValue - // must not be present if Comparator is Exists or DoesNotExist. IntegerValue can - // only be used if the Qualification type has an integer value; it cannot be used - // with the Worker_Locale QualificationType ID. When performing a set comparison by - // using the In or the NotIn comparator, you can use up to 15 IntegerValue elements - // in a QualificationRequirement data structure. - IntegerValues []*int32 - - // The ID of the Qualification type for the requirement. - // - // This member is required. - QualificationTypeId *string - - // The kind of comparison to make against a Qualification's value. You can compare - // a Qualification's value to an IntegerValue to see if it is LessThan, - // LessThanOrEqualTo, GreaterThan, GreaterThanOrEqualTo, EqualTo, or NotEqualTo the - // IntegerValue. You can compare it to a LocaleValue to see if it is EqualTo, or - // NotEqualTo the LocaleValue. You can check to see if the value is In or NotIn a - // set of IntegerValue or LocaleValue values. Lastly, a Qualification requirement - // can also test if a Qualification Exists or DoesNotExist in the user's profile, - // regardless of its value. - // - // This member is required. - Comparator Comparator + // DEPRECATED: Use the ActionsGuarded field instead. If RequiredToPreview is true, + // the question data for the HIT will not be shown when a Worker whose + // Qualifications do not meet this requirement tries to preview the HIT. That is, a + // Worker's Qualifications must meet all of the requirements for which + // RequiredToPreview is true in order to preview the HIT. If a Worker meets all of + // the requirements where RequiredToPreview is true (or if there are no such + // requirements), but does not meet all of the requirements for the HIT, the Worker + // will be allowed to preview the HIT's question data, but will not be allowed to + // accept and complete the HIT. The default is false. This should not be used in + // combination with the ActionsGuarded field. + RequiredToPreview *bool } // The QualificationType data structure represents a Qualification type, a @@ -420,50 +420,41 @@ type QualificationRequirement struct { // test. type QualificationType struct { - // The questions for a Qualification test associated with this Qualification type - // that a user can take to obtain a Qualification of this type. This parameter must - // be specified if AnswerKey is present. A Qualification type cannot have both a - // specified Test parameter and an AutoGranted value of true. - Test *string - - // The amount of time, in seconds, Workers must wait after taking the Qualification - // test before they can take it again. Workers can take a Qualification test - // multiple times if they were not granted the Qualification from a previous - // attempt, or if the test offers a gradient score and they want a better score. If - // not specified, retries are disabled and Workers can request a Qualification only - // once. - RetryDelayInSeconds *int64 - - // The name of the Qualification type. The type name is used to identify the type, - // and to find the type using a Qualification type search. - Name *string - - // One or more words or phrases that describe theQualification type, separated by - // commas. The Keywords make the type easier to find using a search. - Keywords *string - - // A unique identifier for the Qualification type. A Qualification type is given a - // Qualification type ID when you call the CreateQualificationType operation. - QualificationTypeId *string + // The answers to the Qualification test specified in the Test parameter. + AnswerKey *string // Specifies that requests for the Qualification type are granted immediately, // without prompting the Worker with a Qualification test. Valid values are True | // False. AutoGranted *bool + // The Qualification integer value to use for automatically granted Qualifications, + // if AutoGranted is true. This is 1 by default. + AutoGrantedValue *int32 + // The date and time the Qualification type was created. CreationTime *time.Time - // The amount of time, in seconds, given to a Worker to complete the Qualification - // test, beginning from the time the Worker requests the Qualification. - TestDurationInSeconds *int64 - // A long description for the Qualification type. Description *string - // The Qualification integer value to use for automatically granted Qualifications, - // if AutoGranted is true. This is 1 by default. - AutoGrantedValue *int32 + // Specifies whether the Qualification type is one that a user can request through + // the Amazon Mechanical Turk web site, such as by taking a Qualification test. + // This value is False for Qualifications assigned automatically by the system. + // Valid values are True | False. + IsRequestable *bool + + // One or more words or phrases that describe theQualification type, separated by + // commas. The Keywords make the type easier to find using a search. + Keywords *string + + // The name of the Qualification type. The type name is used to identify the type, + // and to find the type using a Qualification type search. + Name *string + + // A unique identifier for the Qualification type. A Qualification type is given a + // Qualification type ID when you call the CreateQualificationType operation. + QualificationTypeId *string // The status of the Qualification type. A Qualification type's status determines // if users can apply to receive a Qualification of this type, and if HITs can be @@ -471,14 +462,23 @@ type QualificationType struct { // Inactive. QualificationTypeStatus QualificationTypeStatus - // Specifies whether the Qualification type is one that a user can request through - // the Amazon Mechanical Turk web site, such as by taking a Qualification test. - // This value is False for Qualifications assigned automatically by the system. - // Valid values are True | False. - IsRequestable *bool + // The amount of time, in seconds, Workers must wait after taking the Qualification + // test before they can take it again. Workers can take a Qualification test + // multiple times if they were not granted the Qualification from a previous + // attempt, or if the test offers a gradient score and they want a better score. If + // not specified, retries are disabled and Workers can request a Qualification only + // once. + RetryDelayInSeconds *int64 - // The answers to the Qualification test specified in the Test parameter. - AnswerKey *string + // The questions for a Qualification test associated with this Qualification type + // that a user can take to obtain a Qualification of this type. This parameter must + // be specified if AnswerKey is present. A Qualification type cannot have both a + // specified Test parameter and an AutoGranted value of true. + Test *string + + // The amount of time, in seconds, given to a Worker to complete the Qualification + // test, beginning from the time the Worker requests the Qualification. + TestDurationInSeconds *int64 } // Both the AssignmentReviewReport and the HITReviewReport elements contains the @@ -489,43 +489,43 @@ type ReviewActionDetail struct { // The unique identifier for the action. ActionId *string - // The date when the action was completed. - CompleteTime *time.Time - // The nature of the action itself. The Review Policy is responsible for examining // the HIT and Assignments, emitting results, and deciding which other actions will // be necessary. ActionName *string + // The date when the action was completed. + CompleteTime *time.Time + + // Present only when the Results have a FAILED Status. + ErrorCode *string + // A description of the outcome of the review. Result *string + // The current disposition of the action: INTENDED, SUCCEEDED, FAILED, or + // CANCELLED. + Status ReviewActionStatus + // The specific HITId or AssignmentID targeted by the action. TargetId *string // The type of object in TargetId. TargetType *string - - // Present only when the Results have a FAILED Status. - ErrorCode *string - - // The current disposition of the action: INTENDED, SUCCEEDED, FAILED, or - // CANCELLED. - Status ReviewActionStatus } // HIT Review Policy data structures represent HIT review policies, which you // specify when you create a HIT. type ReviewPolicy struct { - // Name of the parameter from the Review policy. - Parameters []*PolicyParameter - // Name of a Review Policy: SimplePlurality/2011-09-01 or // ScoreMyKnownAnswers/2011-09-01 // // This member is required. PolicyName *string + + // Name of the parameter from the Review policy. + Parameters []*PolicyParameter } // Contains both ReviewResult and ReviewAction elements for a particular HIT. @@ -542,6 +542,12 @@ type ReviewReport struct { // Review Policy. type ReviewResultDetail struct { + // A unique identifier of the Review action result. + ActionId *string + + // Key identifies the particular piece of reviewed information. + Key *string + // Specifies the QuestionId the result is describing. Depending on whether the // TargetType is a HIT or Assignment this results could specify multiple values. If // TargetType is HIT and QuestionId is absent, then the result describes results of @@ -550,12 +556,6 @@ type ReviewResultDetail struct { // HIT. QuestionId *string - // A unique identifier of the Review action result. - ActionId *string - - // Key identifies the particular piece of reviewed information. - Key *string - // The HITID or AssignmentId about which this result was taken. Note that HIT-level // Review Policies will often emit results about both the HIT itself and its // Assignments, while Assignment-level review policies generally only emit results diff --git a/service/neptune/api_op_AddTagsToResource.go b/service/neptune/api_op_AddTagsToResource.go index ab1a99fd702..4fd18ec9a2a 100644 --- a/service/neptune/api_op_AddTagsToResource.go +++ b/service/neptune/api_op_AddTagsToResource.go @@ -59,11 +59,6 @@ func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourc type AddTagsToResourceInput struct { - // The tags to be assigned to the Amazon Neptune resource. - // - // This member is required. - Tags []*types.Tag - // The Amazon Neptune resource that the tags are added to. This value is an Amazon // Resource Name (ARN). For information about creating an ARN, see Constructing an // Amazon Resource Name (ARN) @@ -71,6 +66,11 @@ type AddTagsToResourceInput struct { // // This member is required. ResourceName *string + + // The tags to be assigned to the Amazon Neptune resource. + // + // This member is required. + Tags []*types.Tag } type AddTagsToResourceOutput struct { diff --git a/service/neptune/api_op_CopyDBClusterParameterGroup.go b/service/neptune/api_op_CopyDBClusterParameterGroup.go index b6ee4ccabfb..80aae9c0123 100644 --- a/service/neptune/api_op_CopyDBClusterParameterGroup.go +++ b/service/neptune/api_op_CopyDBClusterParameterGroup.go @@ -57,9 +57,6 @@ func (c *Client) CopyDBClusterParameterGroup(ctx context.Context, params *CopyDB type CopyDBClusterParameterGroupInput struct { - // The tags to be assigned to the copied DB cluster parameter group. - Tags []*types.Tag - // The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter // group. For information about creating an ARN, see Constructing an Amazon // Resource Name (ARN) @@ -81,6 +78,11 @@ type CopyDBClusterParameterGroupInput struct { // This member is required. SourceDBClusterParameterGroupIdentifier *string + // A description for the copied DB cluster parameter group. + // + // This member is required. + TargetDBClusterParameterGroupDescription *string + // The identifier for the copied DB cluster parameter group. Constraints: // // * @@ -100,10 +102,8 @@ type CopyDBClusterParameterGroupInput struct { // This member is required. TargetDBClusterParameterGroupIdentifier *string - // A description for the copied DB cluster parameter group. - // - // This member is required. - TargetDBClusterParameterGroupDescription *string + // The tags to be assigned to the copied DB cluster parameter group. + Tags []*types.Tag } type CopyDBClusterParameterGroupOutput struct { diff --git a/service/neptune/api_op_CopyDBClusterSnapshot.go b/service/neptune/api_op_CopyDBClusterSnapshot.go index 1d912e3153f..7139e252bde 100644 --- a/service/neptune/api_op_CopyDBClusterSnapshot.go +++ b/service/neptune/api_op_CopyDBClusterSnapshot.go @@ -59,29 +59,6 @@ func (c *Client) CopyDBClusterSnapshot(ctx context.Context, params *CopyDBCluste type CopyDBClusterSnapshotInput struct { - // The tags to assign to the new DB cluster snapshot copy. - Tags []*types.Tag - - // True to copy all tags from the source DB cluster snapshot to the target DB - // cluster snapshot, and otherwise false. The default is false. - CopyTags *bool - - // The AWS AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is - // the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the - // KMS encryption key.

    If you copy an encrypted DB cluster snapshot from your - // AWS account, you can specify a value for KmsKeyId to encrypt the - // copy with a new KMS encryption key. If you don't specify a value for - // KmsKeyId, then the copy of the DB cluster snapshot is encrypted - // with the same KMS key as the source DB cluster snapshot.

    If you copy an - // encrypted DB cluster snapshot that is shared from another AWS account, then you - // must specify a value for KmsKeyId.

    KMS encryption keys are - // specific to the AWS Region that they are created in, and you can't use - // encryption keys from one AWS Region in another AWS Region.

    You cannot - // encrypt an unencrypted DB cluster snapshot when you copy it. If you try to copy - // an unencrypted DB cluster snapshot and specify a value for the KmsKeyId - // parameter, an error is returned.

    - KmsKeyId *string - // The identifier of the DB cluster snapshot to copy. This parameter is not // case-sensitive. You can't copy from one AWS Region to another. Constraints: // @@ -96,9 +73,6 @@ type CopyDBClusterSnapshotInput struct { // This member is required. SourceDBClusterSnapshotIdentifier *string - // Not currently supported. - PreSignedUrl *string - // The identifier of the new DB cluster snapshot to create from the source DB // cluster snapshot. This parameter is not case-sensitive. Constraints: // @@ -115,6 +89,32 @@ type CopyDBClusterSnapshotInput struct { // // This member is required. TargetDBClusterSnapshotIdentifier *string + + // True to copy all tags from the source DB cluster snapshot to the target DB + // cluster snapshot, and otherwise false. The default is false. + CopyTags *bool + + // The AWS AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is + // the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the + // KMS encryption key.

    If you copy an encrypted DB cluster snapshot from your + // AWS account, you can specify a value for KmsKeyId to encrypt the + // copy with a new KMS encryption key. If you don't specify a value for + // KmsKeyId, then the copy of the DB cluster snapshot is encrypted + // with the same KMS key as the source DB cluster snapshot.

    If you copy an + // encrypted DB cluster snapshot that is shared from another AWS account, then you + // must specify a value for KmsKeyId.

    KMS encryption keys are + // specific to the AWS Region that they are created in, and you can't use + // encryption keys from one AWS Region in another AWS Region.

    You cannot + // encrypt an unencrypted DB cluster snapshot when you copy it. If you try to copy + // an unencrypted DB cluster snapshot and specify a value for the KmsKeyId + // parameter, an error is returned.

    + KmsKeyId *string + + // Not currently supported. + PreSignedUrl *string + + // The tags to assign to the new DB cluster snapshot copy. + Tags []*types.Tag } type CopyDBClusterSnapshotOutput struct { diff --git a/service/neptune/api_op_CopyDBParameterGroup.go b/service/neptune/api_op_CopyDBParameterGroup.go index 68597aa2cc0..0c5bab0b2dc 100644 --- a/service/neptune/api_op_CopyDBParameterGroup.go +++ b/service/neptune/api_op_CopyDBParameterGroup.go @@ -57,6 +57,16 @@ func (c *Client) CopyDBParameterGroup(ctx context.Context, params *CopyDBParamet type CopyDBParameterGroupInput struct { + // The identifier or ARN for the source DB parameter group. For information about + // creating an ARN, see Constructing an Amazon Resource Name (ARN) + // (https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing). + //

    Constraints:

    + // + // This member is required. + SourceDBParameterGroupIdentifier *string + // A description for the copied DB parameter group. // // This member is required. @@ -83,16 +93,6 @@ type CopyDBParameterGroupInput struct { // The tags to be assigned to the copied DB parameter group. Tags []*types.Tag - - // The identifier or ARN for the source DB parameter group. For information about - // creating an ARN, see Constructing an Amazon Resource Name (ARN) - // (https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing). - //

    Constraints:

    - // - // This member is required. - SourceDBParameterGroupIdentifier *string } type CopyDBParameterGroupOutput struct { diff --git a/service/neptune/api_op_CreateDBCluster.go b/service/neptune/api_op_CreateDBCluster.go index 040b9b12f36..2afa6423f48 100644 --- a/service/neptune/api_op_CreateDBCluster.go +++ b/service/neptune/api_op_CreateDBCluster.go @@ -63,22 +63,6 @@ func (c *Client) CreateDBCluster(ctx context.Context, params *CreateDBClusterInp type CreateDBClusterInput struct { - // True to enable mapping of AWS Identity and Access Management (IAM) accounts to - // database accounts, and otherwise false. Default: false - EnableIAMDatabaseAuthentication *bool - - // The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this - // DB cluster is created as a Read Replica. - ReplicationSourceIdentifier *string - - // The tags to assign to the new DB cluster. - Tags []*types.Tag - - // The password for the master database user. This password can contain any - // printable ASCII character except "/", """, or "@". Constraints: Must contain - // from 8 to 41 characters. - MasterUserPassword *string - // The DB cluster identifier. This parameter is stored as a lowercase string. // Constraints: // @@ -95,6 +79,16 @@ type CreateDBClusterInput struct { // This member is required. DBClusterIdentifier *string + // The name of the database engine to be used for this DB cluster. Valid Values: + // neptune + // + // This member is required. + Engine *string + + // A list of EC2 Availability Zones that instances in the DB cluster can be created + // in. + AvailabilityZones []*string + // The number of days for which automated backups are retained. You must specify a // minimum value of 1. Default: 1 Constraints: // @@ -102,7 +96,7 @@ type CreateDBClusterInput struct { BackupRetentionPeriod *int32 // (Not supported by Neptune) - OptionGroupName *string + CharacterSetName *string // The name of the DB cluster parameter group to associate with this DB cluster. If // this argument is omitted, the default is used. Constraints: @@ -111,40 +105,10 @@ type CreateDBClusterInput struct { // must match the name of an existing DBClusterParameterGroup. DBClusterParameterGroupName *string - // The port number on which the instances in the DB cluster accept connections. - // Default: 8182 - Port *int32 - - // The version number of the database engine to use. Currently, setting this - // parameter has no effect. Example: 1.0.1 - EngineVersion *string - - // Specifies whether the DB cluster is encrypted. - StorageEncrypted *bool - - // (Not supported by Neptune) - CharacterSetName *string - // A DB subnet group to associate with this DB cluster. Constraints: Must match the // name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup DBSubnetGroupName *string - // A list of EC2 VPC security groups to associate with this DB cluster. - VpcSecurityGroupIds []*string - - // A list of EC2 Availability Zones that instances in the DB cluster can be created - // in. - AvailabilityZones []*string - - // The name of the database engine to be used for this DB cluster. Valid Values: - // neptune - // - // This member is required. - Engine *string - - // The list of log types that need to be enabled for exporting to CloudWatch Logs. - EnableCloudwatchLogsExports []*string - // The name for your database of up to 64 alpha-numeric characters. If you do not // provide a name, Amazon Neptune will not create a database in the DB cluster you // are creating. @@ -155,19 +119,16 @@ type CreateDBClusterInput struct { // deletion protection is enabled. DeletionProtection *bool - // The name of the master user for the DB cluster. Constraints: - // - // * Must be 1 to - // 16 letters or numbers. - // - // * First character must be a letter. - // - // * Cannot be - // a reserved word for the chosen database engine. - MasterUsername *string + // The list of log types that need to be enabled for exporting to CloudWatch Logs. + EnableCloudwatchLogsExports []*string - // This parameter is not currently supported. - PreSignedUrl *string + // True to enable mapping of AWS Identity and Access Management (IAM) accounts to + // database accounts, and otherwise false. Default: false + EnableIAMDatabaseAuthentication *bool + + // The version number of the database engine to use. Currently, setting this + // parameter has no effect. Example: 1.0.1 + EngineVersion *string // The AWS KMS key identifier for an encrypted DB cluster. The KMS key identifier // is the Amazon Resource Name (ARN) for the KMS encryption key. If you are @@ -192,6 +153,32 @@ type CreateDBClusterInput struct { // encrypt the Read Replica in that AWS Region. KmsKeyId *string + // The password for the master database user. This password can contain any + // printable ASCII character except "/", """, or "@". Constraints: Must contain + // from 8 to 41 characters. + MasterUserPassword *string + + // The name of the master user for the DB cluster. Constraints: + // + // * Must be 1 to + // 16 letters or numbers. + // + // * First character must be a letter. + // + // * Cannot be + // a reserved word for the chosen database engine. + MasterUsername *string + + // (Not supported by Neptune) + OptionGroupName *string + + // The port number on which the instances in the DB cluster accept connections. + // Default: 8182 + Port *int32 + + // This parameter is not currently supported. + PreSignedUrl *string + // The daily time range during which automated backups are created if automated // backups are enabled using the BackupRetentionPeriod parameter. The default is a // 30-minute window selected at random from an 8-hour block of time for each AWS @@ -221,6 +208,19 @@ type CreateDBClusterInput struct { // in the Amazon Neptune User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. // Constraints: Minimum 30-minute window. PreferredMaintenanceWindow *string + + // The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this + // DB cluster is created as a Read Replica. + ReplicationSourceIdentifier *string + + // Specifies whether the DB cluster is encrypted. + StorageEncrypted *bool + + // The tags to assign to the new DB cluster. + Tags []*types.Tag + + // A list of EC2 VPC security groups to associate with this DB cluster. + VpcSecurityGroupIds []*string } type CreateDBClusterOutput struct { diff --git a/service/neptune/api_op_CreateDBClusterParameterGroup.go b/service/neptune/api_op_CreateDBClusterParameterGroup.go index 858ec01fac0..200ad4aad61 100644 --- a/service/neptune/api_op_CreateDBClusterParameterGroup.go +++ b/service/neptune/api_op_CreateDBClusterParameterGroup.go @@ -77,14 +77,6 @@ func (c *Client) CreateDBClusterParameterGroup(ctx context.Context, params *Crea type CreateDBClusterParameterGroupInput struct { - // The description for the DB cluster parameter group. - // - // This member is required. - Description *string - - // The tags to be assigned to the new DB cluster parameter group. - Tags []*types.Tag - // The name of the DB cluster parameter group. Constraints: // // * Must match the @@ -103,6 +95,14 @@ type CreateDBClusterParameterGroupInput struct { // // This member is required. DBParameterGroupFamily *string + + // The description for the DB cluster parameter group. + // + // This member is required. + Description *string + + // The tags to be assigned to the new DB cluster parameter group. + Tags []*types.Tag } type CreateDBClusterParameterGroupOutput struct { diff --git a/service/neptune/api_op_CreateDBClusterSnapshot.go b/service/neptune/api_op_CreateDBClusterSnapshot.go index 10a6174c1d5..74fdbda78c3 100644 --- a/service/neptune/api_op_CreateDBClusterSnapshot.go +++ b/service/neptune/api_op_CreateDBClusterSnapshot.go @@ -57,9 +57,6 @@ func (c *Client) CreateDBClusterSnapshot(ctx context.Context, params *CreateDBCl type CreateDBClusterSnapshotInput struct { - // The tags to be assigned to the DB cluster snapshot. - Tags []*types.Tag - // The identifier of the DB cluster to create a snapshot for. This parameter is not // case-sensitive. Constraints: // @@ -87,6 +84,9 @@ type CreateDBClusterSnapshotInput struct { // // This member is required. DBClusterSnapshotIdentifier *string + + // The tags to be assigned to the DB cluster snapshot. + Tags []*types.Tag } type CreateDBClusterSnapshotOutput struct { diff --git a/service/neptune/api_op_CreateDBInstance.go b/service/neptune/api_op_CreateDBInstance.go index 1e58b39c7eb..9a9192ee666 100644 --- a/service/neptune/api_op_CreateDBInstance.go +++ b/service/neptune/api_op_CreateDBInstance.go @@ -57,90 +57,11 @@ func (c *Client) CreateDBInstance(ctx context.Context, params *CreateDBInstanceI type CreateDBInstanceInput struct { - // Specify the name of the IAM role to be used when making API calls to the - // Directory Service. - DomainIAMRoleName *string - - // A value that specifies the order in which an Read Replica is promoted to the - // primary instance after a failure of the existing primary instance. Default: 1 - // Valid Values: 0 - 15 - PromotionTier *int32 - - // The password for the master user. The password can include any printable ASCII - // character except "/", """, or "@". Not used. - MasterUserPassword *string - - // Specify the Active Directory Domain to create the instance in. - Domain *string - - // The ARN for the IAM role that permits Neptune to send enhanced monitoring - // metrics to Amazon CloudWatch Logs. For example, - // arn:aws:iam:123456789012:role/emaccess. If MonitoringInterval is set to a value - // other than 0, then you must supply a MonitoringRoleArn value. - MonitoringRoleArn *string - - // The tags to assign to the new instance. - Tags []*types.Tag - - // True to enable AWS Identity and Access Management (IAM) authentication for - // Neptune. Default: false - EnableIAMDatabaseAuthentication *bool - - // Specifies if the DB instance is a Multi-AZ deployment. You can't set the - // AvailabilityZone parameter if the MultiAZ parameter is set to true. - MultiAZ *bool - - // The ARN from the key store with which to associate the instance for TDE - // encryption. - TdeCredentialArn *string - - // (Not supported by Neptune) - PerformanceInsightsKMSKeyId *string - - // This flag should no longer be used. - PubliclyAccessible *bool - - // The identifier of the DB cluster that the instance will belong to. For - // information on creating a DB cluster, see CreateDBCluster (). Type: String - DBClusterIdentifier *string - - // The number of days for which automated backups are retained. Not applicable. The - // retention period for automated backups is managed by the DB cluster. For more - // information, see CreateDBCluster (). Default: 1 Constraints: - // - // * Must be a - // value from 0 to 35 + // The compute and memory capacity of the DB instance, for example, db.m4.large. + // Not all DB instance classes are available in all AWS Regions. // - // * Cannot be set to 0 if the DB instance is a source to - // Read Replicas - BackupRetentionPeriod *int32 - - // The port number on which the database accepts connections. Not applicable. The - // port is managed by the DB cluster. For more information, see CreateDBCluster (). - // Default: 8182 Type: Integer - Port *int32 - - // (Not supported by Neptune) - CharacterSetName *string - - // A list of EC2 VPC security groups to associate with this DB instance. Not - // applicable. The associated list of EC2 VPC security groups is managed by the DB - // cluster. For more information, see CreateDBCluster (). Default: The default EC2 - // VPC security group for the DB subnet group's VPC. - VpcSecurityGroupIds []*string - - // The version number of the database engine to use. Currently, setting this - // parameter has no effect. - EngineVersion *string - - // Specifies whether the DB instance is encrypted. Not applicable. The encryption - // for DB instances is managed by the DB cluster. For more information, see - // CreateDBCluster (). Default: false - StorageEncrypted *bool - - // Specifies the storage type to be associated with the DB instance. Not - // applicable. Storage is managed by the DB Cluster. - StorageType *string + // This member is required. + DBInstanceClass *string // The DB instance identifier. This parameter is stored as a lowercase string. // Constraints: @@ -158,8 +79,11 @@ type CreateDBInstanceInput struct { // This member is required. DBInstanceIdentifier *string - // (Not supported by Neptune) - OptionGroupName *string + // The name of the database engine to be used for this instance. Valid Values: + // neptune + // + // This member is required. + Engine *string // The amount of storage (in gibibytes) to allocate for the DB instance. Type: // Integer Not applicable. Neptune cluster volumes automatically grow as the amount @@ -167,57 +91,95 @@ type CreateDBInstanceInput struct { // that you use in a Neptune cluster volume. AllocatedStorage *int32 - // (Not supported by Neptune) - EnablePerformanceInsights *bool - - // The list of log types that need to be enabled for exporting to CloudWatch Logs. - EnableCloudwatchLogsExports []*string - - // The amount of Provisioned IOPS (input/output operations per second) to be - // initially allocated for the DB instance. - Iops *int32 - - // The compute and memory capacity of the DB instance, for example, db.m4.large. - // Not all DB instance classes are available in all AWS Regions. - // - // This member is required. - DBInstanceClass *string - // Indicates that minor engine upgrades are applied automatically to the DB // instance during the maintenance window. Default: true AutoMinorVersionUpgrade *bool - // A list of DB security groups to associate with this DB instance. Default: The - // default DB security group for the database engine. - DBSecurityGroups []*string + // The EC2 Availability Zone that the DB instance is created in Default: A random, + // system-chosen Availability Zone in the endpoint's AWS Region. Example: + // us-east-1d Constraint: The AvailabilityZone parameter can't be specified if the + // MultiAZ parameter is set to true. The specified Availability Zone must be in the + // same AWS Region as the current endpoint. + AvailabilityZone *string - // The name of the database engine to be used for this instance. Valid Values: - // neptune + // The number of days for which automated backups are retained. Not applicable. The + // retention period for automated backups is managed by the DB cluster. For more + // information, see CreateDBCluster (). Default: 1 Constraints: // - // This member is required. - Engine *string + // * Must be a + // value from 0 to 35 + // + // * Cannot be set to 0 if the DB instance is a source to + // Read Replicas + BackupRetentionPeriod *int32 + + // (Not supported by Neptune) + CharacterSetName *string // True to copy all tags from the DB instance to snapshots of the DB instance, and // otherwise false. The default is false. CopyTagsToSnapshot *bool - // The daily time range during which automated backups are created. Not applicable. - // The daily time range for creating automated backups is managed by the DB - // cluster. For more information, see CreateDBCluster (). - PreferredBackupWindow *string - - // The time range each week during which system maintenance can occur, in Universal - // Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a - // 30-minute window selected at random from an 8-hour block of time for each AWS - // Region, occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, - // Fri, Sat, Sun. Constraints: Minimum 30-minute window. - PreferredMaintenanceWindow *string + // The identifier of the DB cluster that the instance will belong to. For + // information on creating a DB cluster, see CreateDBCluster (). Type: String + DBClusterIdentifier *string // Not supported. DBName *string - // The name for the master user. Not used. - MasterUsername *string + // The name of the DB parameter group to associate with this DB instance. If this + // argument is omitted, the default DBParameterGroup for the specified engine is + // used. Constraints: + // + // * Must be 1 to 255 letters, numbers, or hyphens. + // + // * + // First character must be a letter + // + // * Cannot end with a hyphen or contain two + // consecutive hyphens + DBParameterGroupName *string + + // A list of DB security groups to associate with this DB instance. Default: The + // default DB security group for the database engine. + DBSecurityGroups []*string + + // A DB subnet group to associate with this DB instance. If there is no DB subnet + // group, then it is a non-VPC DB instance. + DBSubnetGroupName *string + + // A value that indicates whether the DB instance has deletion protection enabled. + // The database can't be deleted when deletion protection is enabled. By default, + // deletion protection is disabled. See Deleting a DB Instance + // (https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html). + //

    DB instances in a DB cluster can be deleted even when deletion protection is + // enabled in their parent DB cluster.

    + DeletionProtection *bool + + // Specify the Active Directory Domain to create the instance in. + Domain *string + + // Specify the name of the IAM role to be used when making API calls to the + // Directory Service. + DomainIAMRoleName *string + + // The list of log types that need to be enabled for exporting to CloudWatch Logs. + EnableCloudwatchLogsExports []*string + + // True to enable AWS Identity and Access Management (IAM) authentication for + // Neptune. Default: false + EnableIAMDatabaseAuthentication *bool + + // (Not supported by Neptune) + EnablePerformanceInsights *bool + + // The version number of the database engine to use. Currently, setting this + // parameter has no effect. + EngineVersion *string + + // The amount of Provisioned IOPS (input/output operations per second) to be + // initially allocated for the DB instance. + Iops *int32 // The AWS KMS key identifier for an encrypted DB instance. The KMS key identifier // is the Amazon Resource Name (ARN) for the KMS encryption key. If you are @@ -232,19 +194,16 @@ type CreateDBInstanceInput struct { // Region. KmsKeyId *string - // The EC2 Availability Zone that the DB instance is created in Default: A random, - // system-chosen Availability Zone in the endpoint's AWS Region. Example: - // us-east-1d Constraint: The AvailabilityZone parameter can't be specified if the - // MultiAZ parameter is set to true. The specified Availability Zone must be in the - // same AWS Region as the current endpoint. - AvailabilityZone *string - // License model information for this DB instance. Valid values: license-included | // bring-your-own-license | general-public-license LicenseModel *string - // The time zone of the DB instance. - Timezone *string + // The password for the master user. The password can include any printable ASCII + // character except "/", """, or "@". Not used. + MasterUserPassword *string + + // The name for the master user. Not used. + MasterUsername *string // The interval, in seconds, between points when Enhanced Monitoring metrics are // collected for the DB instance. To disable collecting Enhanced Monitoring @@ -253,33 +212,74 @@ type CreateDBInstanceInput struct { // 1, 5, 10, 15, 30, 60 MonitoringInterval *int32 - // A value that indicates whether the DB instance has deletion protection enabled. - // The database can't be deleted when deletion protection is enabled. By default, - // deletion protection is disabled. See Deleting a DB Instance - // (https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html). - //

    DB instances in a DB cluster can be deleted even when deletion protection is - // enabled in their parent DB cluster.

    - DeletionProtection *bool + // The ARN for the IAM role that permits Neptune to send enhanced monitoring + // metrics to Amazon CloudWatch Logs. For example, + // arn:aws:iam:123456789012:role/emaccess. If MonitoringInterval is set to a value + // other than 0, then you must supply a MonitoringRoleArn value. + MonitoringRoleArn *string - // A DB subnet group to associate with this DB instance. If there is no DB subnet - // group, then it is a non-VPC DB instance. - DBSubnetGroupName *string + // Specifies if the DB instance is a Multi-AZ deployment. You can't set the + // AvailabilityZone parameter if the MultiAZ parameter is set to true. + MultiAZ *bool + + // (Not supported by Neptune) + OptionGroupName *string + + // (Not supported by Neptune) + PerformanceInsightsKMSKeyId *string + + // The port number on which the database accepts connections. Not applicable. The + // port is managed by the DB cluster. For more information, see CreateDBCluster (). + // Default: 8182 Type: Integer + Port *int32 + + // The daily time range during which automated backups are created. Not applicable. + // The daily time range for creating automated backups is managed by the DB + // cluster. For more information, see CreateDBCluster (). + PreferredBackupWindow *string + + // The time range each week during which system maintenance can occur, in Universal + // Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a + // 30-minute window selected at random from an 8-hour block of time for each AWS + // Region, occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, + // Fri, Sat, Sun. Constraints: Minimum 30-minute window. + PreferredMaintenanceWindow *string + + // A value that specifies the order in which an Read Replica is promoted to the + // primary instance after a failure of the existing primary instance. Default: 1 + // Valid Values: 0 - 15 + PromotionTier *int32 + + // This flag should no longer be used. + PubliclyAccessible *bool + + // Specifies whether the DB instance is encrypted. Not applicable. The encryption + // for DB instances is managed by the DB cluster. For more information, see + // CreateDBCluster (). Default: false + StorageEncrypted *bool + + // Specifies the storage type to be associated with the DB instance. Not + // applicable. Storage is managed by the DB Cluster. + StorageType *string + + // The tags to assign to the new instance. + Tags []*types.Tag + + // The ARN from the key store with which to associate the instance for TDE + // encryption. + TdeCredentialArn *string // The password for the given ARN from the key store in order to access the device. TdeCredentialPassword *string - // The name of the DB parameter group to associate with this DB instance. If this - // argument is omitted, the default DBParameterGroup for the specified engine is - // used. Constraints: - // - // * Must be 1 to 255 letters, numbers, or hyphens. - // - // * - // First character must be a letter - // - // * Cannot end with a hyphen or contain two - // consecutive hyphens - DBParameterGroupName *string + // The time zone of the DB instance. + Timezone *string + + // A list of EC2 VPC security groups to associate with this DB instance. Not + // applicable. The associated list of EC2 VPC security groups is managed by the DB + // cluster. For more information, see CreateDBCluster (). Default: The default EC2 + // VPC security group for the DB subnet group's VPC. + VpcSecurityGroupIds []*string } type CreateDBInstanceOutput struct { diff --git a/service/neptune/api_op_CreateDBParameterGroup.go b/service/neptune/api_op_CreateDBParameterGroup.go index 6dabf0fb51b..d56975c46b3 100644 --- a/service/neptune/api_op_CreateDBParameterGroup.go +++ b/service/neptune/api_op_CreateDBParameterGroup.go @@ -74,6 +74,14 @@ func (c *Client) CreateDBParameterGroup(ctx context.Context, params *CreateDBPar type CreateDBParameterGroupInput struct { + // The DB parameter group family name. A DB parameter group can be associated with + // one and only one DB parameter group family, and can be applied only to a DB + // instance running a database engine and engine version compatible with that DB + // parameter group family. + // + // This member is required. + DBParameterGroupFamily *string + // The name of the DB parameter group. Constraints: // // * Must be 1 to 255 @@ -90,21 +98,13 @@ type CreateDBParameterGroupInput struct { // This member is required. DBParameterGroupName *string - // The tags to be assigned to the new DB parameter group. - Tags []*types.Tag - // The description for the DB parameter group. // // This member is required. Description *string - // The DB parameter group family name. A DB parameter group can be associated with - // one and only one DB parameter group family, and can be applied only to a DB - // instance running a database engine and engine version compatible with that DB - // parameter group family. - // - // This member is required. - DBParameterGroupFamily *string + // The tags to be assigned to the new DB parameter group. + Tags []*types.Tag } type CreateDBParameterGroupOutput struct { diff --git a/service/neptune/api_op_CreateDBSubnetGroup.go b/service/neptune/api_op_CreateDBSubnetGroup.go index b671b0cf0b7..5e7ae43b03a 100644 --- a/service/neptune/api_op_CreateDBSubnetGroup.go +++ b/service/neptune/api_op_CreateDBSubnetGroup.go @@ -63,9 +63,6 @@ type CreateDBSubnetGroupInput struct { // This member is required. DBSubnetGroupDescription *string - // The tags to be assigned to the new DB subnet group. - Tags []*types.Tag - // The name for the DB subnet group. This value is stored as a lowercase string. // Constraints: Must contain no more than 255 letters, numbers, periods, // underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup @@ -77,6 +74,9 @@ type CreateDBSubnetGroupInput struct { // // This member is required. SubnetIds []*string + + // The tags to be assigned to the new DB subnet group. + Tags []*types.Tag } type CreateDBSubnetGroupOutput struct { diff --git a/service/neptune/api_op_CreateEventSubscription.go b/service/neptune/api_op_CreateEventSubscription.go index 55005382f32..e960c04c3d8 100644 --- a/service/neptune/api_op_CreateEventSubscription.go +++ b/service/neptune/api_op_CreateEventSubscription.go @@ -72,23 +72,27 @@ func (c *Client) CreateEventSubscription(ctx context.Context, params *CreateEven type CreateEventSubscriptionInput struct { + // The Amazon Resource Name (ARN) of the SNS topic created for event notification. + // The ARN is created by Amazon SNS when you create a topic and subscribe to it. + // + // This member is required. + SnsTopicArn *string + // The name of the subscription. Constraints: The name must be less than 255 // characters. // // This member is required. SubscriptionName *string + // A Boolean value; set to true to activate the subscription, set to false to + // create the subscription but not active it. + Enabled *bool + // A list of event categories for a SourceType that you want to subscribe to. You // can see a list of the categories for a given SourceType by using the // DescribeEventCategories action. EventCategories []*string - // The Amazon Resource Name (ARN) of the SNS topic created for event notification. - // The ARN is created by Amazon SNS when you create a topic and subscribe to it. - // - // This member is required. - SnsTopicArn *string - // The list of identifiers of the event sources for which events are returned. If // not specified, then all sources are included in the response. An identifier must // begin with a letter and must contain only ASCII letters, digits, and hyphens; it @@ -111,9 +115,6 @@ type CreateEventSubscriptionInput struct { // snapshot, a DBSnapshotIdentifier must be supplied. SourceIds []*string - // The tags to be applied to the new event subscription. - Tags []*types.Tag - // The type of source that is generating the events. For example, if you want to be // notified of events generated by a DB instance, you would set this parameter to // db-instance. if this value is not specified, all events are returned. Valid @@ -121,9 +122,8 @@ type CreateEventSubscriptionInput struct { // db-snapshot | db-cluster-snapshot SourceType *string - // A Boolean value; set to true to activate the subscription, set to false to - // create the subscription but not active it. - Enabled *bool + // The tags to be applied to the new event subscription. + Tags []*types.Tag } type CreateEventSubscriptionOutput struct { diff --git a/service/neptune/api_op_DeleteDBCluster.go b/service/neptune/api_op_DeleteDBCluster.go index 0cf9ef9d091..3e88d1caed3 100644 --- a/service/neptune/api_op_DeleteDBCluster.go +++ b/service/neptune/api_op_DeleteDBCluster.go @@ -62,12 +62,13 @@ func (c *Client) DeleteDBCluster(ctx context.Context, params *DeleteDBClusterInp type DeleteDBClusterInput struct { - // Determines whether a final DB cluster snapshot is created before the DB cluster - // is deleted. If true is specified, no DB cluster snapshot is created. If false is - // specified, a DB cluster snapshot is created before the DB cluster is deleted. - // You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is - // false. Default: false - SkipFinalSnapshot *bool + // The DB cluster identifier for the DB cluster to be deleted. This parameter isn't + // case-sensitive. Constraints: + // + // * Must match an existing DBClusterIdentifier. + // + // This member is required. + DBClusterIdentifier *string // The DB cluster snapshot identifier of the new DB cluster snapshot created when // SkipFinalSnapshot is set to false. Specifying this parameter and also setting @@ -82,13 +83,12 @@ type DeleteDBClusterInput struct { // * Cannot end with a hyphen or contain two consecutive hyphens FinalDBSnapshotIdentifier *string - // The DB cluster identifier for the DB cluster to be deleted. This parameter isn't - // case-sensitive. Constraints: - // - // * Must match an existing DBClusterIdentifier. - // - // This member is required. - DBClusterIdentifier *string + // Determines whether a final DB cluster snapshot is created before the DB cluster + // is deleted. If true is specified, no DB cluster snapshot is created. If false is + // specified, a DB cluster snapshot is created before the DB cluster is deleted. + // You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is + // false. Default: false + SkipFinalSnapshot *bool } type DeleteDBClusterOutput struct { diff --git a/service/neptune/api_op_DeleteDBInstance.go b/service/neptune/api_op_DeleteDBInstance.go index 54ddb04e7d3..f006aa215e1 100644 --- a/service/neptune/api_op_DeleteDBInstance.go +++ b/service/neptune/api_op_DeleteDBInstance.go @@ -68,6 +68,15 @@ func (c *Client) DeleteDBInstance(ctx context.Context, params *DeleteDBInstanceI type DeleteDBInstanceInput struct { + // The DB instance identifier for the DB instance to be deleted. This parameter + // isn't case-sensitive. Constraints: + // + // * Must match the name of an existing DB + // instance. + // + // This member is required. + DBInstanceIdentifier *string + // The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is // set to false. Specifying this parameter and also setting the SkipFinalShapshot // parameter to true results in an error. Constraints: @@ -93,15 +102,6 @@ type DeleteDBInstanceInput struct { // Read Replica. The FinalDBSnapshotIdentifier parameter must be specified if // SkipFinalSnapshot is false. Default: false SkipFinalSnapshot *bool - - // The DB instance identifier for the DB instance to be deleted. This parameter - // isn't case-sensitive. Constraints: - // - // * Must match the name of an existing DB - // instance. - // - // This member is required. - DBInstanceIdentifier *string } type DeleteDBInstanceOutput struct { diff --git a/service/neptune/api_op_DescribeDBClusterParameterGroups.go b/service/neptune/api_op_DescribeDBClusterParameterGroups.go index d62c4a8002a..951883816dc 100644 --- a/service/neptune/api_op_DescribeDBClusterParameterGroups.go +++ b/service/neptune/api_op_DescribeDBClusterParameterGroups.go @@ -66,15 +66,15 @@ type DescribeDBClusterParameterGroupsInput struct { // DBClusterParameterGroup. DBClusterParameterGroupName *string + // This parameter is not currently supported. + Filters []*types.Filter + // An optional pagination token provided by a previous // DescribeDBClusterParameterGroups request. If this parameter is specified, the // response includes only records beyond the marker, up to the value specified by // MaxRecords. Marker *string - // This parameter is not currently supported. - Filters []*types.Filter - // The maximum number of records to include in the response. If more records exist // than the specified MaxRecords value, a pagination token called a marker is // included in the response so that the remaining results can be retrieved. @@ -84,15 +84,15 @@ type DescribeDBClusterParameterGroupsInput struct { type DescribeDBClusterParameterGroupsOutput struct { + // A list of DB cluster parameter groups. + DBClusterParameterGroups []*types.DBClusterParameterGroup + // An optional pagination token provided by a previous // DescribeDBClusterParameterGroups request. If this parameter is specified, the // response includes only records beyond the marker, up to the value specified by // MaxRecords. Marker *string - // A list of DB cluster parameter groups. - DBClusterParameterGroups []*types.DBClusterParameterGroup - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/neptune/api_op_DescribeDBClusterParameters.go b/service/neptune/api_op_DescribeDBClusterParameters.go index 097fc1097d0..1dce096bfeb 100644 --- a/service/neptune/api_op_DescribeDBClusterParameters.go +++ b/service/neptune/api_op_DescribeDBClusterParameters.go @@ -57,32 +57,32 @@ func (c *Client) DescribeDBClusterParameters(ctx context.Context, params *Descri type DescribeDBClusterParametersInput struct { + // The name of a specific DB cluster parameter group to return parameter details + // for. Constraints: + // + // * If supplied, must match the name of an existing + // DBClusterParameterGroup. + // + // This member is required. + DBClusterParameterGroupName *string + + // This parameter is not currently supported. + Filters []*types.Filter + // An optional pagination token provided by a previous DescribeDBClusterParameters // request. If this parameter is specified, the response includes only records // beyond the marker, up to the value specified by MaxRecords. Marker *string - // A value that indicates to return only parameters for a specific source. - // Parameter sources can be engine, service, or customer. - Source *string - // The maximum number of records to include in the response. If more records exist // than the specified MaxRecords value, a pagination token called a marker is // included in the response so that the remaining results can be retrieved. // Default: 100 Constraints: Minimum 20, maximum 100. MaxRecords *int32 - // This parameter is not currently supported. - Filters []*types.Filter - - // The name of a specific DB cluster parameter group to return parameter details - // for. Constraints: - // - // * If supplied, must match the name of an existing - // DBClusterParameterGroup. - // - // This member is required. - DBClusterParameterGroupName *string + // A value that indicates to return only parameters for a specific source. + // Parameter sources can be engine, service, or customer. + Source *string } type DescribeDBClusterParametersOutput struct { diff --git a/service/neptune/api_op_DescribeDBClusterSnapshots.go b/service/neptune/api_op_DescribeDBClusterSnapshots.go index 6548c61a3c0..f75e142924f 100644 --- a/service/neptune/api_op_DescribeDBClusterSnapshots.go +++ b/service/neptune/api_op_DescribeDBClusterSnapshots.go @@ -77,6 +77,15 @@ type DescribeDBClusterSnapshotsInput struct { // automated snapshot, the SnapshotType parameter must also be specified. DBClusterSnapshotIdentifier *string + // This parameter is not currently supported. + Filters []*types.Filter + + // True to include manual DB cluster snapshots that are public and can be copied or + // restored by any AWS account, and otherwise false. The default is false. The + // default is false. You can share a manual DB cluster snapshot as public by using + // the ModifyDBClusterSnapshotAttribute () API action. + IncludePublic *bool + // True to include shared manual DB cluster snapshots from other AWS accounts that // this AWS account has been given permission to copy or restore, and otherwise // false. The default is false. You can give an AWS account permission to restore a @@ -84,6 +93,17 @@ type DescribeDBClusterSnapshotsInput struct { // ModifyDBClusterSnapshotAttribute () API action. IncludeShared *bool + // An optional pagination token provided by a previous DescribeDBClusterSnapshots + // request. If this parameter is specified, the response includes only records + // beyond the marker, up to the value specified by MaxRecords. + Marker *string + + // The maximum number of records to include in the response. If more records exist + // than the specified MaxRecords value, a pagination token called a marker is + // included in the response so that the remaining results can be retrieved. + // Default: 100 Constraints: Minimum 20, maximum 100. + MaxRecords *int32 + // The type of DB cluster snapshots to be returned. You can specify one of the // following values: // @@ -109,38 +129,18 @@ type DescribeDBClusterSnapshotsInput struct { // parameter doesn't apply when SnapshotType is set to shared. The IncludeShared // parameter doesn't apply when SnapshotType is set to public. SnapshotType *string - - // True to include manual DB cluster snapshots that are public and can be copied or - // restored by any AWS account, and otherwise false. The default is false. The - // default is false. You can share a manual DB cluster snapshot as public by using - // the ModifyDBClusterSnapshotAttribute () API action. - IncludePublic *bool - - // This parameter is not currently supported. - Filters []*types.Filter - - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a pagination token called a marker is - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. - MaxRecords *int32 - - // An optional pagination token provided by a previous DescribeDBClusterSnapshots - // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. - Marker *string } type DescribeDBClusterSnapshotsOutput struct { + // Provides a list of DB cluster snapshots for the user. + DBClusterSnapshots []*types.DBClusterSnapshot + // An optional pagination token provided by a previous DescribeDBClusterSnapshots // () request. If this parameter is specified, the response includes only records // beyond the marker, up to the value specified by MaxRecords. Marker *string - // Provides a list of DB cluster snapshots for the user. - DBClusterSnapshots []*types.DBClusterSnapshot - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/neptune/api_op_DescribeDBClusters.go b/service/neptune/api_op_DescribeDBClusters.go index fdf26851e6b..797b8755f33 100644 --- a/service/neptune/api_op_DescribeDBClusters.go +++ b/service/neptune/api_op_DescribeDBClusters.go @@ -59,11 +59,13 @@ func (c *Client) DescribeDBClusters(ctx context.Context, params *DescribeDBClust type DescribeDBClustersInput struct { - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a pagination token called a marker is - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. - MaxRecords *int32 + // The user-supplied DB cluster identifier. If this parameter is specified, + // information from only the specific DB cluster is returned. This parameter isn't + // case-sensitive. Constraints: + // + // * If supplied, must match an existing + // DBClusterIdentifier. + DBClusterIdentifier *string // A filter that specifies one or more DB clusters to describe. Supported // filters: @@ -81,18 +83,16 @@ type DescribeDBClustersInput struct { // following command:

    Filters []*types.Filter - // The user-supplied DB cluster identifier. If this parameter is specified, - // information from only the specific DB cluster is returned. This parameter isn't - // case-sensitive. Constraints: - // - // * If supplied, must match an existing - // DBClusterIdentifier. - DBClusterIdentifier *string - // An optional pagination token provided by a previous DescribeDBClusters () // request. If this parameter is specified, the response includes only records // beyond the marker, up to the value specified by MaxRecords. Marker *string + + // The maximum number of records to include in the response. If more records exist + // than the specified MaxRecords value, a pagination token called a marker is + // included in the response so that the remaining results can be retrieved. + // Default: 100 Constraints: Minimum 20, maximum 100. + MaxRecords *int32 } type DescribeDBClustersOutput struct { diff --git a/service/neptune/api_op_DescribeDBEngineVersions.go b/service/neptune/api_op_DescribeDBEngineVersions.go index 7c818012835..c848e14dd8f 100644 --- a/service/neptune/api_op_DescribeDBEngineVersions.go +++ b/service/neptune/api_op_DescribeDBEngineVersions.go @@ -57,57 +57,57 @@ func (c *Client) DescribeDBEngineVersions(ctx context.Context, params *DescribeD type DescribeDBEngineVersionsInput struct { - // If this parameter is specified and the requested engine supports the TimeZone - // parameter for CreateDBInstance, the response includes a list of supported time - // zones for each engine version. - ListSupportedTimezones *bool - - // An optional pagination token provided by a previous request. If this parameter - // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. - Marker *string - - // The database engine to return. - Engine *string - - // The maximum number of records to include in the response. If more than the - // MaxRecords value is available, a pagination token called a marker is included in - // the response so that the following results can be retrieved. Default: 100 - // Constraints: Minimum 20, maximum 100. - MaxRecords *int32 - // The name of a specific DB parameter group family to return details for. // Constraints: // // * If supplied, must match an existing DBParameterGroupFamily. DBParameterGroupFamily *string - // Not currently supported. - Filters []*types.Filter + // Indicates that only the default version of the specified engine or engine and + // major version combination is returned. + DefaultOnly *bool + + // The database engine to return. + Engine *string // The database engine version to return. Example: 5.1.49 EngineVersion *string - // Indicates that only the default version of the specified engine or engine and - // major version combination is returned. - DefaultOnly *bool + // Not currently supported. + Filters []*types.Filter // If this parameter is specified and the requested engine supports the // CharacterSetName parameter for CreateDBInstance, the response includes a list of // supported character sets for each engine version. ListSupportedCharacterSets *bool -} -type DescribeDBEngineVersionsOutput struct { + // If this parameter is specified and the requested engine supports the TimeZone + // parameter for CreateDBInstance, the response includes a list of supported time + // zones for each engine version. + ListSupportedTimezones *bool // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the // value specified by MaxRecords. Marker *string + // The maximum number of records to include in the response. If more than the + // MaxRecords value is available, a pagination token called a marker is included in + // the response so that the following results can be retrieved. Default: 100 + // Constraints: Minimum 20, maximum 100. + MaxRecords *int32 +} + +type DescribeDBEngineVersionsOutput struct { + // A list of DBEngineVersion elements. DBEngineVersions []*types.DBEngineVersion + // An optional pagination token provided by a previous request. If this parameter + // is specified, the response includes only records beyond the marker, up to the + // value specified by MaxRecords. + Marker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/neptune/api_op_DescribeDBInstances.go b/service/neptune/api_op_DescribeDBInstances.go index f1307435eac..54dc9cad801 100644 --- a/service/neptune/api_op_DescribeDBInstances.go +++ b/service/neptune/api_op_DescribeDBInstances.go @@ -59,6 +59,14 @@ func (c *Client) DescribeDBInstances(ctx context.Context, params *DescribeDBInst type DescribeDBInstancesInput struct { + // The user-supplied instance identifier. If this parameter is specified, + // information from only the specific DB instance is returned. This parameter isn't + // case-sensitive. Constraints: + // + // * If supplied, must match the identifier of an + // existing DBInstance. + DBInstanceIdentifier *string + // A filter that specifies one or more DB instances to describe. Supported // filters: // @@ -75,36 +83,28 @@ type DescribeDBInstancesInput struct { // are returned, you could use the following command:

    Filters []*types.Filter + // An optional pagination token provided by a previous DescribeDBInstances request. + // If this parameter is specified, the response includes only records beyond the + // marker, up to the value specified by MaxRecords. + Marker *string + // The maximum number of records to include in the response. If more records exist // than the specified MaxRecords value, a pagination token called a marker is // included in the response so that the remaining results can be retrieved. // Default: 100 Constraints: Minimum 20, maximum 100. MaxRecords *int32 - - // The user-supplied instance identifier. If this parameter is specified, - // information from only the specific DB instance is returned. This parameter isn't - // case-sensitive. Constraints: - // - // * If supplied, must match the identifier of an - // existing DBInstance. - DBInstanceIdentifier *string - - // An optional pagination token provided by a previous DescribeDBInstances request. - // If this parameter is specified, the response includes only records beyond the - // marker, up to the value specified by MaxRecords. - Marker *string } type DescribeDBInstancesOutput struct { + // A list of DBInstance () instances. + DBInstances []*types.DBInstance + // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the // value specified by MaxRecords . Marker *string - // A list of DBInstance () instances. - DBInstances []*types.DBInstance - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/neptune/api_op_DescribeDBParameterGroups.go b/service/neptune/api_op_DescribeDBParameterGroups.go index 0589fd30317..c74b257eda5 100644 --- a/service/neptune/api_op_DescribeDBParameterGroups.go +++ b/service/neptune/api_op_DescribeDBParameterGroups.go @@ -59,37 +59,37 @@ func (c *Client) DescribeDBParameterGroups(ctx context.Context, params *Describe type DescribeDBParameterGroupsInput struct { - // This parameter is not currently supported. - Filters []*types.Filter - - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a pagination token called a marker is - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. - MaxRecords *int32 - // The name of a specific DB parameter group to return details for. Constraints: // // // * If supplied, must match the name of an existing DBClusterParameterGroup. DBParameterGroupName *string + // This parameter is not currently supported. + Filters []*types.Filter + // An optional pagination token provided by a previous DescribeDBParameterGroups // request. If this parameter is specified, the response includes only records // beyond the marker, up to the value specified by MaxRecords. Marker *string + + // The maximum number of records to include in the response. If more records exist + // than the specified MaxRecords value, a pagination token called a marker is + // included in the response so that the remaining results can be retrieved. + // Default: 100 Constraints: Minimum 20, maximum 100. + MaxRecords *int32 } type DescribeDBParameterGroupsOutput struct { + // A list of DBParameterGroup () instances. + DBParameterGroups []*types.DBParameterGroup + // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the // value specified by MaxRecords. Marker *string - // A list of DBParameterGroup () instances. - DBParameterGroups []*types.DBParameterGroup - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/neptune/api_op_DescribeDBParameters.go b/service/neptune/api_op_DescribeDBParameters.go index 8ac216ec2fc..6c4939e7723 100644 --- a/service/neptune/api_op_DescribeDBParameters.go +++ b/service/neptune/api_op_DescribeDBParameters.go @@ -73,27 +73,27 @@ type DescribeDBParametersInput struct { // beyond the marker, up to the value specified by MaxRecords. Marker *string - // The parameter types to return. Default: All parameter types returned Valid - // Values: user | system | engine-default - Source *string - // The maximum number of records to include in the response. If more records exist // than the specified MaxRecords value, a pagination token called a marker is // included in the response so that the remaining results can be retrieved. // Default: 100 Constraints: Minimum 20, maximum 100. MaxRecords *int32 + + // The parameter types to return. Default: All parameter types returned Valid + // Values: user | system | engine-default + Source *string } type DescribeDBParametersOutput struct { - // A list of Parameter () values. - Parameters []*types.Parameter - // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the // value specified by MaxRecords. Marker *string + // A list of Parameter () values. + Parameters []*types.Parameter + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/neptune/api_op_DescribeDBSubnetGroups.go b/service/neptune/api_op_DescribeDBSubnetGroups.go index 37024c90492..462b180ab5e 100644 --- a/service/neptune/api_op_DescribeDBSubnetGroups.go +++ b/service/neptune/api_op_DescribeDBSubnetGroups.go @@ -60,34 +60,34 @@ func (c *Client) DescribeDBSubnetGroups(ctx context.Context, params *DescribeDBS type DescribeDBSubnetGroupsInput struct { + // The name of the DB subnet group to return details for. + DBSubnetGroupName *string + // This parameter is not currently supported. Filters []*types.Filter + // An optional pagination token provided by a previous DescribeDBSubnetGroups + // request. If this parameter is specified, the response includes only records + // beyond the marker, up to the value specified by MaxRecords. + Marker *string + // The maximum number of records to include in the response. If more records exist // than the specified MaxRecords value, a pagination token called a marker is // included in the response so that the remaining results can be retrieved. // Default: 100 Constraints: Minimum 20, maximum 100. MaxRecords *int32 - - // The name of the DB subnet group to return details for. - DBSubnetGroupName *string - - // An optional pagination token provided by a previous DescribeDBSubnetGroups - // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. - Marker *string } type DescribeDBSubnetGroupsOutput struct { + // A list of DBSubnetGroup () instances. + DBSubnetGroups []*types.DBSubnetGroup + // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the // value specified by MaxRecords. Marker *string - // A list of DBSubnetGroup () instances. - DBSubnetGroups []*types.DBSubnetGroup - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/neptune/api_op_DescribeEngineDefaultClusterParameters.go b/service/neptune/api_op_DescribeEngineDefaultClusterParameters.go index ecceec5c350..8f1652d5307 100644 --- a/service/neptune/api_op_DescribeEngineDefaultClusterParameters.go +++ b/service/neptune/api_op_DescribeEngineDefaultClusterParameters.go @@ -64,15 +64,15 @@ type DescribeEngineDefaultClusterParametersInput struct { // This member is required. DBParameterGroupFamily *string + // This parameter is not currently supported. + Filters []*types.Filter + // An optional pagination token provided by a previous // DescribeEngineDefaultClusterParameters request. If this parameter is specified, // the response includes only records beyond the marker, up to the value specified // by MaxRecords. Marker *string - // This parameter is not currently supported. - Filters []*types.Filter - // The maximum number of records to include in the response. If more records exist // than the specified MaxRecords value, a pagination token called a marker is // included in the response so that the remaining results can be retrieved. diff --git a/service/neptune/api_op_DescribeEngineDefaultParameters.go b/service/neptune/api_op_DescribeEngineDefaultParameters.go index 3aebb8c426d..0f3265605c7 100644 --- a/service/neptune/api_op_DescribeEngineDefaultParameters.go +++ b/service/neptune/api_op_DescribeEngineDefaultParameters.go @@ -58,14 +58,14 @@ func (c *Client) DescribeEngineDefaultParameters(ctx context.Context, params *De type DescribeEngineDefaultParametersInput struct { - // Not currently supported. - Filters []*types.Filter - // The name of the DB parameter group family. // // This member is required. DBParameterGroupFamily *string + // Not currently supported. + Filters []*types.Filter + // An optional pagination token provided by a previous // DescribeEngineDefaultParameters request. If this parameter is specified, the // response includes only records beyond the marker, up to the value specified by diff --git a/service/neptune/api_op_DescribeEventSubscriptions.go b/service/neptune/api_op_DescribeEventSubscriptions.go index 13deb28272a..59f8e2ad0f9 100644 --- a/service/neptune/api_op_DescribeEventSubscriptions.go +++ b/service/neptune/api_op_DescribeEventSubscriptions.go @@ -60,15 +60,6 @@ func (c *Client) DescribeEventSubscriptions(ctx context.Context, params *Describ type DescribeEventSubscriptionsInput struct { - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a pagination token called a marker is - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. - MaxRecords *int32 - - // The name of the event notification subscription you want to describe. - SubscriptionName *string - // This parameter is not currently supported. Filters []*types.Filter @@ -77,6 +68,15 @@ type DescribeEventSubscriptionsInput struct { // response includes only records beyond the marker, up to the value specified by // MaxRecords . Marker *string + + // The maximum number of records to include in the response. If more records exist + // than the specified MaxRecords value, a pagination token called a marker is + // included in the response so that the remaining results can be retrieved. + // Default: 100 Constraints: Minimum 20, maximum 100. + MaxRecords *int32 + + // The name of the event notification subscription you want to describe. + SubscriptionName *string } type DescribeEventSubscriptionsOutput struct { diff --git a/service/neptune/api_op_DescribeEvents.go b/service/neptune/api_op_DescribeEvents.go index 117977a67dc..d1b8364ae09 100644 --- a/service/neptune/api_op_DescribeEvents.go +++ b/service/neptune/api_op_DescribeEvents.go @@ -62,30 +62,31 @@ func (c *Client) DescribeEvents(ctx context.Context, params *DescribeEventsInput type DescribeEventsInput struct { + // The number of minutes to retrieve events for. Default: 60 + Duration *int32 + // The end of the time interval for which to retrieve events, specified in ISO 8601 // format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. // (http://en.wikipedia.org/wiki/ISO_8601) Example: 2009-07-08T18:00Z EndTime *time.Time - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a pagination token called a marker is - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. - MaxRecords *int32 + // A list of event categories that trigger notifications for a event notification + // subscription. + EventCategories []*string + + // This parameter is not currently supported. + Filters []*types.Filter // An optional pagination token provided by a previous DescribeEvents request. If // this parameter is specified, the response includes only records beyond the // marker, up to the value specified by MaxRecords. Marker *string - // The event source to retrieve events for. If no value is specified, all events - // are returned. - SourceType types.SourceType - - // The beginning of the time interval to retrieve events for, specified in ISO 8601 - // format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. - // (http://en.wikipedia.org/wiki/ISO_8601) Example: 2009-07-08T18:00Z - StartTime *time.Time + // The maximum number of records to include in the response. If more records exist + // than the specified MaxRecords value, a pagination token called a marker is + // included in the response so that the remaining results can be retrieved. + // Default: 100 Constraints: Minimum 20, maximum 100. + MaxRecords *int32 // The identifier of the event source for which events are returned. If not // specified, then all sources are included in the response. Constraints: @@ -109,27 +110,26 @@ type DescribeEventsInput struct { // * Cannot end with a hyphen or contain two consecutive hyphens. SourceIdentifier *string - // A list of event categories that trigger notifications for a event notification - // subscription. - EventCategories []*string - - // This parameter is not currently supported. - Filters []*types.Filter + // The event source to retrieve events for. If no value is specified, all events + // are returned. + SourceType types.SourceType - // The number of minutes to retrieve events for. Default: 60 - Duration *int32 + // The beginning of the time interval to retrieve events for, specified in ISO 8601 + // format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. + // (http://en.wikipedia.org/wiki/ISO_8601) Example: 2009-07-08T18:00Z + StartTime *time.Time } type DescribeEventsOutput struct { + // A list of Event () instances. + Events []*types.Event + // An optional pagination token provided by a previous Events request. If this // parameter is specified, the response includes only records beyond the marker, up // to the value specified by MaxRecords . Marker *string - // A list of Event () instances. - Events []*types.Event - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/neptune/api_op_DescribeOrderableDBInstanceOptions.go b/service/neptune/api_op_DescribeOrderableDBInstanceOptions.go index a9574427039..9805408b74d 100644 --- a/service/neptune/api_op_DescribeOrderableDBInstanceOptions.go +++ b/service/neptune/api_op_DescribeOrderableDBInstanceOptions.go @@ -57,31 +57,19 @@ func (c *Client) DescribeOrderableDBInstanceOptions(ctx context.Context, params type DescribeOrderableDBInstanceOptionsInput struct { - // An optional pagination token provided by a previous - // DescribeOrderableDBInstanceOptions request. If this parameter is specified, the - // response includes only records beyond the marker, up to the value specified by - // MaxRecords . - Marker *string - - // The VPC filter value. Specify this parameter to show only the available VPC or - // non-VPC offerings. - Vpc *bool - // The name of the engine to retrieve DB instance options for. // // This member is required. Engine *string - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a pagination token called a marker is - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. - MaxRecords *int32 - // The DB instance class filter value. Specify this parameter to show only the // available offerings matching the specified DB instance class. DBInstanceClass *string + // The engine version filter value. Specify this parameter to show only the + // available offerings matching the specified engine version. + EngineVersion *string + // This parameter is not currently supported. Filters []*types.Filter @@ -89,22 +77,34 @@ type DescribeOrderableDBInstanceOptionsInput struct { // available offerings matching the specified license model. LicenseModel *string - // The engine version filter value. Specify this parameter to show only the - // available offerings matching the specified engine version. - EngineVersion *string + // An optional pagination token provided by a previous + // DescribeOrderableDBInstanceOptions request. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by + // MaxRecords . + Marker *string + + // The maximum number of records to include in the response. If more records exist + // than the specified MaxRecords value, a pagination token called a marker is + // included in the response so that the remaining results can be retrieved. + // Default: 100 Constraints: Minimum 20, maximum 100. + MaxRecords *int32 + + // The VPC filter value. Specify this parameter to show only the available VPC or + // non-VPC offerings. + Vpc *bool } type DescribeOrderableDBInstanceOptionsOutput struct { - // An OrderableDBInstanceOption () structure containing information about orderable - // options for the DB instance. - OrderableDBInstanceOptions []*types.OrderableDBInstanceOption - // An optional pagination token provided by a previous OrderableDBInstanceOptions // request. If this parameter is specified, the response includes only records // beyond the marker, up to the value specified by MaxRecords . Marker *string + // An OrderableDBInstanceOption () structure containing information about orderable + // options for the DB instance. + OrderableDBInstanceOptions []*types.OrderableDBInstanceOption + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/neptune/api_op_DescribePendingMaintenanceActions.go b/service/neptune/api_op_DescribePendingMaintenanceActions.go index 3a0ae2df2fb..f0199449592 100644 --- a/service/neptune/api_op_DescribePendingMaintenanceActions.go +++ b/service/neptune/api_op_DescribePendingMaintenanceActions.go @@ -58,21 +58,6 @@ func (c *Client) DescribePendingMaintenanceActions(ctx context.Context, params * type DescribePendingMaintenanceActionsInput struct { - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a pagination token called a marker is - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. - MaxRecords *int32 - - // An optional pagination token provided by a previous - // DescribePendingMaintenanceActions request. If this parameter is specified, the - // response includes only records beyond the marker, up to a number of records - // specified by MaxRecords. - Marker *string - - // The ARN of a resource to return pending maintenance actions for. - ResourceIdentifier *string - // A filter that specifies one or more resources to return pending maintenance // actions for. Supported filters: // @@ -85,6 +70,21 @@ type DescribePendingMaintenanceActionsInput struct { // ARNs. The results list will only include pending maintenance actions for the DB // instances identified by these ARNs. Filters []*types.Filter + + // An optional pagination token provided by a previous + // DescribePendingMaintenanceActions request. If this parameter is specified, the + // response includes only records beyond the marker, up to a number of records + // specified by MaxRecords. + Marker *string + + // The maximum number of records to include in the response. If more records exist + // than the specified MaxRecords value, a pagination token called a marker is + // included in the response so that the remaining results can be retrieved. + // Default: 100 Constraints: Minimum 20, maximum 100. + MaxRecords *int32 + + // The ARN of a resource to return pending maintenance actions for. + ResourceIdentifier *string } type DescribePendingMaintenanceActionsOutput struct { diff --git a/service/neptune/api_op_ListTagsForResource.go b/service/neptune/api_op_ListTagsForResource.go index 4fec2758f0d..4cea08efd80 100644 --- a/service/neptune/api_op_ListTagsForResource.go +++ b/service/neptune/api_op_ListTagsForResource.go @@ -57,9 +57,6 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // This parameter is not currently supported. - Filters []*types.Filter - // The Amazon Neptune resource with tags to be listed. This value is an Amazon // Resource Name (ARN). For information about creating an ARN, see Constructing an // Amazon Resource Name (ARN) @@ -67,6 +64,9 @@ type ListTagsForResourceInput struct { // // This member is required. ResourceName *string + + // This parameter is not currently supported. + Filters []*types.Filter } type ListTagsForResourceOutput struct { diff --git a/service/neptune/api_op_ModifyDBCluster.go b/service/neptune/api_op_ModifyDBCluster.go index 1fdc538badd..d0db3136b8a 100644 --- a/service/neptune/api_op_ModifyDBCluster.go +++ b/service/neptune/api_op_ModifyDBCluster.go @@ -59,26 +59,6 @@ func (c *Client) ModifyDBCluster(ctx context.Context, params *ModifyDBClusterInp type ModifyDBClusterInput struct { - // The new DB cluster identifier for the DB cluster when renaming a DB cluster. - // This value is stored as a lowercase string. Constraints: - // - // * Must contain - // from 1 to 63 letters, numbers, or hyphens - // - // * The first character must be a - // letter - // - // * Cannot end with a hyphen or contain two consecutive - // hyphens - // - // Example: my-cluster2 - NewDBClusterIdentifier *string - - // A value that indicates whether the DB cluster has deletion protection enabled. - // The database can't be deleted when deletion protection is enabled. By default, - // deletion protection is disabled. - DeletionProtection *bool - // The DB cluster identifier for the cluster being modified. This parameter is not // case-sensitive. Constraints: // @@ -88,19 +68,39 @@ type ModifyDBClusterInput struct { // This member is required. DBClusterIdentifier *string - // (Not supported by Neptune) - OptionGroupName *string + // A value that specifies whether the modifications in this request and any pending + // modifications are asynchronously applied as soon as possible, regardless of the + // PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set + // to false, changes to the DB cluster are applied during the next maintenance + // window. The ApplyImmediately parameter only affects the NewDBClusterIdentifier + // and MasterUserPassword values. If you set the ApplyImmediately parameter value + // to false, then changes to the NewDBClusterIdentifier and MasterUserPassword + // values are applied during the next maintenance window. All other changes are + // applied immediately, regardless of the value of the ApplyImmediately parameter. + // Default: false + ApplyImmediately *bool - // The weekly time range during which system maintenance can occur, in Universal - // Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a - // 30-minute window selected at random from an 8-hour block of time for each AWS - // Region, occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, - // Fri, Sat, Sun. Constraints: Minimum 30-minute window. - PreferredMaintenanceWindow *string + // The number of days for which automated backups are retained. You must specify a + // minimum value of 1. Default: 1 Constraints: + // + // * Must be a value from 1 to 35 + BackupRetentionPeriod *int32 - // The port number on which the DB cluster accepts connections. Constraints: Value - // must be 1150-65535 Default: The same port as the original DB cluster. - Port *int32 + // The configuration setting for the log types to be enabled for export to + // CloudWatch Logs for a specific DB cluster. + CloudwatchLogsExportConfiguration *types.CloudwatchLogsExportConfiguration + + // The name of the DB cluster parameter group to use for the DB cluster. + DBClusterParameterGroupName *string + + // A value that indicates whether the DB cluster has deletion protection enabled. + // The database can't be deleted when deletion protection is enabled. By default, + // deletion protection is disabled. + DeletionProtection *bool + + // True to enable mapping of AWS Identity and Access Management (IAM) accounts to + // database accounts, and otherwise false. Default: false + EnableIAMDatabaseAuthentication *bool // The version number of the database engine. Currently, setting this parameter has // no effect. To upgrade your database engine to the most recent release, use the @@ -113,8 +113,27 @@ type ModifyDBClusterInput struct { // from 8 to 41 characters. MasterUserPassword *string - // A list of VPC security groups that the DB cluster will belong to. - VpcSecurityGroupIds []*string + // The new DB cluster identifier for the DB cluster when renaming a DB cluster. + // This value is stored as a lowercase string. Constraints: + // + // * Must contain + // from 1 to 63 letters, numbers, or hyphens + // + // * The first character must be a + // letter + // + // * Cannot end with a hyphen or contain two consecutive + // hyphens + // + // Example: my-cluster2 + NewDBClusterIdentifier *string + + // (Not supported by Neptune) + OptionGroupName *string + + // The port number on which the DB cluster accepts connections. Constraints: Value + // must be 1150-65535 Default: The same port as the original DB cluster. + Port *int32 // The daily time range during which automated backups are created if automated // backups are enabled, using the BackupRetentionPeriod parameter. The default is a @@ -132,34 +151,15 @@ type ModifyDBClusterInput struct { // * Must be at least 30 minutes. PreferredBackupWindow *string - // The name of the DB cluster parameter group to use for the DB cluster. - DBClusterParameterGroupName *string - - // The number of days for which automated backups are retained. You must specify a - // minimum value of 1. Default: 1 Constraints: - // - // * Must be a value from 1 to 35 - BackupRetentionPeriod *int32 - - // True to enable mapping of AWS Identity and Access Management (IAM) accounts to - // database accounts, and otherwise false. Default: false - EnableIAMDatabaseAuthentication *bool - - // A value that specifies whether the modifications in this request and any pending - // modifications are asynchronously applied as soon as possible, regardless of the - // PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set - // to false, changes to the DB cluster are applied during the next maintenance - // window. The ApplyImmediately parameter only affects the NewDBClusterIdentifier - // and MasterUserPassword values. If you set the ApplyImmediately parameter value - // to false, then changes to the NewDBClusterIdentifier and MasterUserPassword - // values are applied during the next maintenance window. All other changes are - // applied immediately, regardless of the value of the ApplyImmediately parameter. - // Default: false - ApplyImmediately *bool + // The weekly time range during which system maintenance can occur, in Universal + // Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a + // 30-minute window selected at random from an 8-hour block of time for each AWS + // Region, occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, + // Fri, Sat, Sun. Constraints: Minimum 30-minute window. + PreferredMaintenanceWindow *string - // The configuration setting for the log types to be enabled for export to - // CloudWatch Logs for a specific DB cluster. - CloudwatchLogsExportConfiguration *types.CloudwatchLogsExportConfiguration + // A list of VPC security groups that the DB cluster will belong to. + VpcSecurityGroupIds []*string } type ModifyDBClusterOutput struct { diff --git a/service/neptune/api_op_ModifyDBClusterParameterGroup.go b/service/neptune/api_op_ModifyDBClusterParameterGroup.go index 9962ff7d3f2..189891bd38a 100644 --- a/service/neptune/api_op_ModifyDBClusterParameterGroup.go +++ b/service/neptune/api_op_ModifyDBClusterParameterGroup.go @@ -73,15 +73,15 @@ func (c *Client) ModifyDBClusterParameterGroup(ctx context.Context, params *Modi type ModifyDBClusterParameterGroupInput struct { - // A list of parameters in the DB cluster parameter group to modify. + // The name of the DB cluster parameter group to modify. // // This member is required. - Parameters []*types.Parameter + DBClusterParameterGroupName *string - // The name of the DB cluster parameter group to modify. + // A list of parameters in the DB cluster parameter group to modify. // // This member is required. - DBClusterParameterGroupName *string + Parameters []*types.Parameter } type ModifyDBClusterParameterGroupOutput struct { diff --git a/service/neptune/api_op_ModifyDBClusterSnapshotAttribute.go b/service/neptune/api_op_ModifyDBClusterSnapshotAttribute.go index d87d131fc1e..38fc1eb5477 100644 --- a/service/neptune/api_op_ModifyDBClusterSnapshotAttribute.go +++ b/service/neptune/api_op_ModifyDBClusterSnapshotAttribute.go @@ -82,6 +82,14 @@ type ModifyDBClusterSnapshotAttributeInput struct { // This member is required. DBClusterSnapshotIdentifier *string + // A list of DB cluster snapshot attributes to add to the attribute specified by + // AttributeName. To authorize other AWS accounts to copy or restore a manual DB + // cluster snapshot, set this list to include one or more AWS account IDs, or all + // to make the manual DB cluster snapshot restorable by any AWS account. Do not add + // the all value for any manual DB cluster snapshots that contain private + // information that you don't want available to all AWS accounts. + ValuesToAdd []*string + // A list of DB cluster snapshot attributes to remove from the attribute specified // by AttributeName. To remove authorization for other AWS accounts to copy or // restore a manual DB cluster snapshot, set this list to include one or more AWS @@ -90,14 +98,6 @@ type ModifyDBClusterSnapshotAttributeInput struct { // account ID is explicitly added to the restore attribute can still copy or // restore a manual DB cluster snapshot. ValuesToRemove []*string - - // A list of DB cluster snapshot attributes to add to the attribute specified by - // AttributeName. To authorize other AWS accounts to copy or restore a manual DB - // cluster snapshot, set this list to include one or more AWS account IDs, or all - // to make the manual DB cluster snapshot restorable by any AWS account. Do not add - // the all value for any manual DB cluster snapshots that contain private - // information that you don't want available to all AWS accounts. - ValuesToAdd []*string } type ModifyDBClusterSnapshotAttributeOutput struct { diff --git a/service/neptune/api_op_ModifyDBInstance.go b/service/neptune/api_op_ModifyDBInstance.go index 524ef1dce98..d4cbe01aefc 100644 --- a/service/neptune/api_op_ModifyDBInstance.go +++ b/service/neptune/api_op_ModifyDBInstance.go @@ -60,54 +60,54 @@ func (c *Client) ModifyDBInstance(ctx context.Context, params *ModifyDBInstanceI type ModifyDBInstanceInput struct { - // A value that indicates whether the DB instance has deletion protection enabled. - // The database can't be deleted when deletion protection is enabled. By default, - // deletion protection is disabled. See Deleting a DB Instance - // (https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html). - DeletionProtection *bool + // The DB instance identifier. This value is stored as a lowercase string. + // Constraints: + // + // * Must match the identifier of an existing DBInstance. + // + // This member is required. + DBInstanceIdentifier *string - // (Not supported by Neptune) - OptionGroupName *string + // The new amount of storage (in gibibytes) to allocate for the DB instance. Not + // applicable. Storage is managed by the DB Cluster. + AllocatedStorage *int32 - // Not supported. - StorageType *string + // Indicates that major version upgrades are allowed. Changing this parameter + // doesn't result in an outage and the change is asynchronously applied as soon as + // possible. + AllowMajorVersionUpgrade *bool - // Not supported. - LicenseModel *string + // Specifies whether the modifications in this request and any pending + // modifications are asynchronously applied as soon as possible, regardless of the + // PreferredMaintenanceWindow setting for the DB instance. If this parameter is set + // to false, changes to the DB instance are applied during the next maintenance + // window. Some parameter changes can cause an outage and are applied on the next + // call to RebootDBInstance (), or the next failure reboot. Default: false + ApplyImmediately *bool - // The weekly time range (in UTC) during which system maintenance can occur, which - // might result in an outage. Changing this parameter doesn't result in an outage, - // except in the following situation, and the change is asynchronously applied as - // soon as possible. If there are pending actions that cause a reboot, and the - // maintenance window is changed to include the current time, then changing this - // parameter will cause a reboot of the DB instance. If moving this window to the - // current time, there must be at least 30 minutes between the current time and end - // of the window to ensure pending changes are applied. Default: Uses existing - // setting Format: ddd:hh24:mi-ddd:hh24:mi Valid Days: Mon | Tue | Wed | Thu | Fri - // | Sat | Sun Constraints: Must be at least 30 minutes - PreferredMaintenanceWindow *string + // Indicates that minor version upgrades are applied automatically to the DB + // instance during the maintenance window. Changing this parameter doesn't result + // in an outage except in the following case and the change is asynchronously + // applied as soon as possible. An outage will result if this parameter is set to + // true during the maintenance window, and a newer minor version is available, and + // Neptune has enabled auto patching for that engine version. + AutoMinorVersionUpgrade *bool + + // Not applicable. The retention period for automated backups is managed by the DB + // cluster. For more information, see ModifyDBCluster (). Default: Uses existing + // setting + BackupRetentionPeriod *int32 + + // Indicates the certificate that needs to be associated with the instance. + CACertificateIdentifier *string // The configuration setting for the log types to be enabled for export to // CloudWatch Logs for a specific DB instance or DB cluster. CloudwatchLogsExportConfiguration *types.CloudwatchLogsExportConfiguration - // The password for the given ARN from the key store in order to access the device. - TdeCredentialPassword *string - - // The new amount of storage (in gibibytes) to allocate for the DB instance. Not - // applicable. Storage is managed by the DB Cluster. - AllocatedStorage *int32 - - // This flag should no longer be used. - PubliclyAccessible *bool - - // The version number of the database engine to upgrade to. Currently, setting this - // parameter has no effect. To upgrade your database engine to the most recent - // release, use the ApplyPendingMaintenanceAction () API. - EngineVersion *string - - // (Not supported by Neptune) - EnablePerformanceInsights *bool + // True to copy all tags from the DB instance to snapshots of the DB instance, and + // otherwise false. The default is false. + CopyTagsToSnapshot *bool // The new compute and memory capacity of the DB instance, for example, // db.m4.large. Not all DB instance classes are available in all AWS Regions. If @@ -116,6 +116,30 @@ type ModifyDBInstanceInput struct { // specified as true for this request. Default: Uses existing setting DBInstanceClass *string + // The name of the DB parameter group to apply to the DB instance. Changing this + // setting doesn't result in an outage. The parameter group name itself is changed + // immediately, but the actual parameter changes are not applied until you reboot + // the instance without failover. The db instance will NOT be rebooted + // automatically and the parameter changes will NOT be applied during the next + // maintenance window. Default: Uses existing setting Constraints: The DB parameter + // group must be in the same DB parameter group family as this DB instance. + DBParameterGroupName *string + + // The port number on which the database accepts connections. The value of the + // DBPortNumber parameter must not match any of the port values specified for + // options in the option group for the DB instance. Your database will restart when + // you change the DBPortNumber value regardless of the value of the + // ApplyImmediately parameter. Default: 8182 + DBPortNumber *int32 + + // A list of DB security groups to authorize on this DB instance. Changing this + // setting doesn't result in an outage and the change is asynchronously applied as + // soon as possible. Constraints: + // + // * If supplied, must match existing + // DBSecurityGroups. + DBSecurityGroups []*string + // The new DB subnet group for the DB instance. You can use this parameter to move // your DB instance to a different VPC. Changing the subnet group causes an outage // during the change. The change is applied during the next maintenance window, @@ -124,6 +148,18 @@ type ModifyDBInstanceInput struct { // mySubnetGroup DBSubnetGroupName *string + // A value that indicates whether the DB instance has deletion protection enabled. + // The database can't be deleted when deletion protection is enabled. By default, + // deletion protection is disabled. See Deleting a DB Instance + // (https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html). + DeletionProtection *bool + + // Not supported. + Domain *string + + // Not supported + DomainIAMRoleName *string + // True to enable mapping of AWS Identity and Access Management (IAM) accounts to // database accounts, and otherwise false. You can enable IAM database // authentication for the following database engines Not applicable. Mapping AWS @@ -131,16 +167,13 @@ type ModifyDBInstanceInput struct { // information, see ModifyDBCluster (). Default: false EnableIAMDatabaseAuthentication *bool - // Not supported. - Domain *string + // (Not supported by Neptune) + EnablePerformanceInsights *bool - // Indicates that minor version upgrades are applied automatically to the DB - // instance during the maintenance window. Changing this parameter doesn't result - // in an outage except in the following case and the change is asynchronously - // applied as soon as possible. An outage will result if this parameter is set to - // true during the maintenance window, and a newer minor version is available, and - // Neptune has enabled auto patching for that engine version. - AutoMinorVersionUpgrade *bool + // The version number of the database engine to upgrade to. Currently, setting this + // parameter has no effect. To upgrade your database engine to the most recent + // release, use the ApplyPendingMaintenanceAction () API. + EngineVersion *string // The new Provisioned IOPS (I/O operations per second) value for the instance. // Changing this setting doesn't result in an outage and the change is applied @@ -148,25 +181,18 @@ type ModifyDBInstanceInput struct { // to true for this request. Default: Uses existing setting Iops *int32 + // Not supported. + LicenseModel *string + // Not applicable. MasterUserPassword *string - // The name of the DB parameter group to apply to the DB instance. Changing this - // setting doesn't result in an outage. The parameter group name itself is changed - // immediately, but the actual parameter changes are not applied until you reboot - // the instance without failover. The db instance will NOT be rebooted - // automatically and the parameter changes will NOT be applied during the next - // maintenance window. Default: Uses existing setting Constraints: The DB parameter - // group must be in the same DB parameter group family as this DB instance. - DBParameterGroupName *string - - // Specifies whether the modifications in this request and any pending - // modifications are asynchronously applied as soon as possible, regardless of the - // PreferredMaintenanceWindow setting for the DB instance. If this parameter is set - // to false, changes to the DB instance are applied during the next maintenance - // window. Some parameter changes can cause an outage and are applied on the next - // call to RebootDBInstance (), or the next failure reboot. Default: false - ApplyImmediately *bool + // The interval, in seconds, between points when Enhanced Monitoring metrics are + // collected for the DB instance. To disable collecting Enhanced Monitoring + // metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then + // you must also set MonitoringInterval to a value other than 0. Valid Values: 0, + // 1, 5, 10, 15, 30, 60 + MonitoringInterval *int32 // The ARN for the IAM role that permits Neptune to send enhanced monitoring // metrics to Amazon CloudWatch Logs. For example, @@ -174,65 +200,12 @@ type ModifyDBInstanceInput struct { // other than 0, then you must supply a MonitoringRoleArn value. MonitoringRoleArn *string - // The daily time range during which automated backups are created if automated - // backups are enabled. Not applicable. The daily time range for creating automated - // backups is managed by the DB cluster. For more information, see ModifyDBCluster - // (). Constraints: - // - // * Must be in the format hh24:mi-hh24:mi - // - // * Must be in - // Universal Time Coordinated (UTC) - // - // * Must not conflict with the preferred - // maintenance window - // - // * Must be at least 30 minutes - PreferredBackupWindow *string - - // Indicates the certificate that needs to be associated with the instance. - CACertificateIdentifier *string - - // A list of DB security groups to authorize on this DB instance. Changing this - // setting doesn't result in an outage and the change is asynchronously applied as - // soon as possible. Constraints: - // - // * If supplied, must match existing - // DBSecurityGroups. - DBSecurityGroups []*string - - // Indicates that major version upgrades are allowed. Changing this parameter - // doesn't result in an outage and the change is asynchronously applied as soon as - // possible. - AllowMajorVersionUpgrade *bool - - // Not applicable. The retention period for automated backups is managed by the DB - // cluster. For more information, see ModifyDBCluster (). Default: Uses existing - // setting - BackupRetentionPeriod *int32 - // Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter // doesn't result in an outage and the change is applied during the next // maintenance window unless the ApplyImmediately parameter is set to true for this // request. MultiAZ *bool - // The interval, in seconds, between points when Enhanced Monitoring metrics are - // collected for the DB instance. To disable collecting Enhanced Monitoring - // metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then - // you must also set MonitoringInterval to a value other than 0. Valid Values: 0, - // 1, 5, 10, 15, 30, 60 - MonitoringInterval *int32 - - // A value that specifies the order in which a Read Replica is promoted to the - // primary instance after a failure of the existing primary instance. Default: 1 - // Valid Values: 0 - 15 - PromotionTier *int32 - - // True to copy all tags from the DB instance to snapshots of the DB instance, and - // otherwise false. The default is false. - CopyTagsToSnapshot *bool - // The new DB instance identifier for the DB instance when renaming a DB instance. // When you change the DB instance identifier, an instance reboot will occur // immediately if you set Apply Immediately to true, or will occur during the next @@ -250,31 +223,58 @@ type ModifyDBInstanceInput struct { // Example: mydbinstance NewDBInstanceIdentifier *string - // The DB instance identifier. This value is stored as a lowercase string. - // Constraints: + // (Not supported by Neptune) + OptionGroupName *string + + // (Not supported by Neptune) + PerformanceInsightsKMSKeyId *string + + // The daily time range during which automated backups are created if automated + // backups are enabled. Not applicable. The daily time range for creating automated + // backups is managed by the DB cluster. For more information, see ModifyDBCluster + // (). Constraints: // - // * Must match the identifier of an existing DBInstance. + // * Must be in the format hh24:mi-hh24:mi // - // This member is required. - DBInstanceIdentifier *string + // * Must be in + // Universal Time Coordinated (UTC) + // + // * Must not conflict with the preferred + // maintenance window + // + // * Must be at least 30 minutes + PreferredBackupWindow *string - // The port number on which the database accepts connections. The value of the - // DBPortNumber parameter must not match any of the port values specified for - // options in the option group for the DB instance. Your database will restart when - // you change the DBPortNumber value regardless of the value of the - // ApplyImmediately parameter. Default: 8182 - DBPortNumber *int32 + // The weekly time range (in UTC) during which system maintenance can occur, which + // might result in an outage. Changing this parameter doesn't result in an outage, + // except in the following situation, and the change is asynchronously applied as + // soon as possible. If there are pending actions that cause a reboot, and the + // maintenance window is changed to include the current time, then changing this + // parameter will cause a reboot of the DB instance. If moving this window to the + // current time, there must be at least 30 minutes between the current time and end + // of the window to ensure pending changes are applied. Default: Uses existing + // setting Format: ddd:hh24:mi-ddd:hh24:mi Valid Days: Mon | Tue | Wed | Thu | Fri + // | Sat | Sun Constraints: Must be at least 30 minutes + PreferredMaintenanceWindow *string - // (Not supported by Neptune) - PerformanceInsightsKMSKeyId *string + // A value that specifies the order in which a Read Replica is promoted to the + // primary instance after a failure of the existing primary instance. Default: 1 + // Valid Values: 0 - 15 + PromotionTier *int32 - // Not supported - DomainIAMRoleName *string + // This flag should no longer be used. + PubliclyAccessible *bool + + // Not supported. + StorageType *string // The ARN from the key store with which to associate the instance for TDE // encryption. TdeCredentialArn *string + // The password for the given ARN from the key store in order to access the device. + TdeCredentialPassword *string + // A list of EC2 VPC security groups to authorize on this DB instance. This change // is asynchronously applied as soon as possible. Not applicable. The associated // list of EC2 VPC security groups is managed by the DB cluster. For more diff --git a/service/neptune/api_op_ModifyDBParameterGroup.go b/service/neptune/api_op_ModifyDBParameterGroup.go index 6ef8b0e8ca3..57e7c6037c2 100644 --- a/service/neptune/api_op_ModifyDBParameterGroup.go +++ b/service/neptune/api_op_ModifyDBParameterGroup.go @@ -71,6 +71,14 @@ func (c *Client) ModifyDBParameterGroup(ctx context.Context, params *ModifyDBPar type ModifyDBParameterGroupInput struct { + // The name of the DB parameter group. Constraints: + // + // * If supplied, must match + // the name of an existing DBParameterGroup. + // + // This member is required. + DBParameterGroupName *string + // An array of parameter names, values, and the apply method for the parameter // update. At least one parameter name, value, and apply method must be supplied; // subsequent arguments are optional. A maximum of 20 parameters can be modified in @@ -81,14 +89,6 @@ type ModifyDBParameterGroupInput struct { // // This member is required. Parameters []*types.Parameter - - // The name of the DB parameter group. Constraints: - // - // * If supplied, must match - // the name of an existing DBParameterGroup. - // - // This member is required. - DBParameterGroupName *string } type ModifyDBParameterGroupOutput struct { diff --git a/service/neptune/api_op_ModifyDBSubnetGroup.go b/service/neptune/api_op_ModifyDBSubnetGroup.go index 60b0644e111..422bca85af8 100644 --- a/service/neptune/api_op_ModifyDBSubnetGroup.go +++ b/service/neptune/api_op_ModifyDBSubnetGroup.go @@ -65,13 +65,13 @@ type ModifyDBSubnetGroupInput struct { // This member is required. DBSubnetGroupName *string - // The description for the DB subnet group. - DBSubnetGroupDescription *string - // The EC2 subnet IDs for the DB subnet group. // // This member is required. SubnetIds []*string + + // The description for the DB subnet group. + DBSubnetGroupDescription *string } type ModifyDBSubnetGroupOutput struct { diff --git a/service/neptune/api_op_ModifyEventSubscription.go b/service/neptune/api_op_ModifyEventSubscription.go index 8f70fa6b1d6..b926945c24f 100644 --- a/service/neptune/api_op_ModifyEventSubscription.go +++ b/service/neptune/api_op_ModifyEventSubscription.go @@ -66,23 +66,23 @@ type ModifyEventSubscriptionInput struct { // This member is required. SubscriptionName *string - // The type of source that is generating the events. For example, if you want to be - // notified of events generated by a DB instance, you would set this parameter to - // db-instance. if this value is not specified, all events are returned. Valid - // values: db-instance | db-parameter-group | db-security-group | db-snapshot - SourceType *string - // A Boolean value; set to true to activate the subscription. Enabled *bool - // The Amazon Resource Name (ARN) of the SNS topic created for event notification. - // The ARN is created by Amazon SNS when you create a topic and subscribe to it. - SnsTopicArn *string - // A list of event categories for a SourceType that you want to subscribe to. You // can see a list of the categories for a given SourceType by using the // DescribeEventCategories action.

    EventCategories []*string + + // The Amazon Resource Name (ARN) of the SNS topic created for event notification. + // The ARN is created by Amazon SNS when you create a topic and subscribe to it. + SnsTopicArn *string + + // The type of source that is generating the events. For example, if you want to be + // notified of events generated by a DB instance, you would set this parameter to + // db-instance. if this value is not specified, all events are returned. Valid + // values: db-instance | db-parameter-group | db-security-group | db-snapshot + SourceType *string } type ModifyEventSubscriptionOutput struct { diff --git a/service/neptune/api_op_RemoveSourceIdentifierFromSubscription.go b/service/neptune/api_op_RemoveSourceIdentifierFromSubscription.go index b819c99505e..8e8362aefd8 100644 --- a/service/neptune/api_op_RemoveSourceIdentifierFromSubscription.go +++ b/service/neptune/api_op_RemoveSourceIdentifierFromSubscription.go @@ -57,17 +57,17 @@ func (c *Client) RemoveSourceIdentifierFromSubscription(ctx context.Context, par type RemoveSourceIdentifierFromSubscriptionInput struct { - // The name of the event notification subscription you want to remove a source - // identifier from. - // - // This member is required. - SubscriptionName *string - // The source identifier to be removed from the subscription, such as the DB // instance identifier for a DB instance or the name of a security group. // // This member is required. SourceIdentifier *string + + // The name of the event notification subscription you want to remove a source + // identifier from. + // + // This member is required. + SubscriptionName *string } type RemoveSourceIdentifierFromSubscriptionOutput struct { diff --git a/service/neptune/api_op_ResetDBClusterParameterGroup.go b/service/neptune/api_op_ResetDBClusterParameterGroup.go index dfceb08ecc9..4b42a25e183 100644 --- a/service/neptune/api_op_ResetDBClusterParameterGroup.go +++ b/service/neptune/api_op_ResetDBClusterParameterGroup.go @@ -65,11 +65,6 @@ func (c *Client) ResetDBClusterParameterGroup(ctx context.Context, params *Reset type ResetDBClusterParameterGroupInput struct { - // A value that is set to true to reset all parameters in the DB cluster parameter - // group to their default values, and false otherwise. You can't use this parameter - // if there is a list of parameter names specified for the Parameters parameter. - ResetAllParameters *bool - // The name of the DB cluster parameter group to reset. // // This member is required. @@ -79,6 +74,11 @@ type ResetDBClusterParameterGroupInput struct { // default values. You can't use this parameter if the ResetAllParameters parameter // is set to true. Parameters []*types.Parameter + + // A value that is set to true to reset all parameters in the DB cluster parameter + // group to their default values, and false otherwise. You can't use this parameter + // if there is a list of parameter names specified for the Parameters parameter. + ResetAllParameters *bool } type ResetDBClusterParameterGroupOutput struct { diff --git a/service/neptune/api_op_RestoreDBClusterFromSnapshot.go b/service/neptune/api_op_RestoreDBClusterFromSnapshot.go index 0b2fe674566..adeec021622 100644 --- a/service/neptune/api_op_RestoreDBClusterFromSnapshot.go +++ b/service/neptune/api_op_RestoreDBClusterFromSnapshot.go @@ -63,35 +63,6 @@ func (c *Client) RestoreDBClusterFromSnapshot(ctx context.Context, params *Resto type RestoreDBClusterFromSnapshotInput struct { - // The tags to be assigned to the restored DB cluster. - Tags []*types.Tag - - // The name of the DB cluster parameter group to associate with the new DB cluster. - // Constraints: - // - // * If supplied, must match the name of an existing - // DBClusterParameterGroup. - DBClusterParameterGroupName *string - - // A list of VPC security groups that the new DB cluster will belong to. - VpcSecurityGroupIds []*string - - // (Not supported by Neptune) - OptionGroupName *string - - // Not supported. - DatabaseName *string - - // The name of the DB subnet group to use for the new DB cluster. Constraints: If - // supplied, must match the name of an existing DBSubnetGroup. Example: - // mySubnetgroup - DBSubnetGroupName *string - - // A value that indicates whether the DB cluster has deletion protection enabled. - // The database can't be deleted when deletion protection is enabled. By default, - // deletion protection is disabled. - DeletionProtection *bool - // The name of the DB cluster to create from the DB snapshot or DB cluster // snapshot. This parameter isn't case-sensitive. Constraints: // @@ -109,8 +80,11 @@ type RestoreDBClusterFromSnapshotInput struct { // This member is required. DBClusterIdentifier *string - // The version of the database engine to use for the new DB cluster. - EngineVersion *string + // The database engine to use for the new DB cluster. Default: The same as source + // Constraint: Must be compatible with the engine of the source + // + // This member is required. + Engine *string // The identifier for the DB snapshot or DB cluster snapshot to restore from. You // can use either the name or the Amazon Resource Name (ARN) to specify a DB @@ -122,9 +96,40 @@ type RestoreDBClusterFromSnapshotInput struct { // This member is required. SnapshotIdentifier *string - // The port number on which the new DB cluster accepts connections. Constraints: - // Value must be 1150-65535 Default: The same port as the original DB cluster. - Port *int32 + // Provides the list of EC2 Availability Zones that instances in the restored DB + // cluster can be created in. + AvailabilityZones []*string + + // The name of the DB cluster parameter group to associate with the new DB cluster. + // Constraints: + // + // * If supplied, must match the name of an existing + // DBClusterParameterGroup. + DBClusterParameterGroupName *string + + // The name of the DB subnet group to use for the new DB cluster. Constraints: If + // supplied, must match the name of an existing DBSubnetGroup. Example: + // mySubnetgroup + DBSubnetGroupName *string + + // Not supported. + DatabaseName *string + + // A value that indicates whether the DB cluster has deletion protection enabled. + // The database can't be deleted when deletion protection is enabled. By default, + // deletion protection is disabled. + DeletionProtection *bool + + // The list of logs that the restored DB cluster is to export to Amazon CloudWatch + // Logs. + EnableCloudwatchLogsExports []*string + + // True to enable mapping of AWS Identity and Access Management (IAM) accounts to + // database accounts, and otherwise false. Default: false + EnableIAMDatabaseAuthentication *bool + + // The version of the database engine to use for the new DB cluster. + EngineVersion *string // The AWS KMS key identifier to use when restoring an encrypted DB cluster from a // DB snapshot or DB cluster snapshot. The KMS key identifier is the Amazon @@ -144,23 +149,18 @@ type RestoreDBClusterFromSnapshotInput struct { // encrypted. KmsKeyId *string - // Provides the list of EC2 Availability Zones that instances in the restored DB - // cluster can be created in. - AvailabilityZones []*string + // (Not supported by Neptune) + OptionGroupName *string - // True to enable mapping of AWS Identity and Access Management (IAM) accounts to - // database accounts, and otherwise false. Default: false - EnableIAMDatabaseAuthentication *bool + // The port number on which the new DB cluster accepts connections. Constraints: + // Value must be 1150-65535 Default: The same port as the original DB cluster. + Port *int32 - // The database engine to use for the new DB cluster. Default: The same as source - // Constraint: Must be compatible with the engine of the source - // - // This member is required. - Engine *string + // The tags to be assigned to the restored DB cluster. + Tags []*types.Tag - // The list of logs that the restored DB cluster is to export to Amazon CloudWatch - // Logs. - EnableCloudwatchLogsExports []*string + // A list of VPC security groups that the new DB cluster will belong to. + VpcSecurityGroupIds []*string } type RestoreDBClusterFromSnapshotOutput struct { diff --git a/service/neptune/api_op_RestoreDBClusterToPointInTime.go b/service/neptune/api_op_RestoreDBClusterToPointInTime.go index 3c5fabaf99e..588bf499cfd 100644 --- a/service/neptune/api_op_RestoreDBClusterToPointInTime.go +++ b/service/neptune/api_op_RestoreDBClusterToPointInTime.go @@ -67,25 +67,18 @@ func (c *Client) RestoreDBClusterToPointInTime(ctx context.Context, params *Rest type RestoreDBClusterToPointInTimeInput struct { - // The tags to be applied to the restored DB cluster. - Tags []*types.Tag - - // The type of restore to be performed. You can specify one of the following - // values: + // The name of the new DB cluster to be created. Constraints: // - // * full-copy - The new DB cluster is restored as a full copy of the - // source DB cluster. + // * Must contain + // from 1 to 63 letters, numbers, or hyphens // - // * copy-on-write - The new DB cluster is restored as a - // clone of the source DB cluster. + // * First character must be a + // letter // - // If you don't specify a RestoreType value, then - // the new DB cluster is restored as a full copy of the source DB cluster. - RestoreType *string - - // True to enable mapping of AWS Identity and Access Management (IAM) accounts to - // database accounts, and otherwise false. Default: false - EnableIAMDatabaseAuthentication *bool + // * Cannot end with a hyphen or contain two consecutive hyphens + // + // This member is required. + DBClusterIdentifier *string // The identifier of the source DB cluster from which to restore. Constraints: // @@ -102,36 +95,6 @@ type RestoreDBClusterToPointInTimeInput struct { // DBClusterParameterGroup. DBClusterParameterGroupName *string - // The port number on which the new DB cluster accepts connections. Constraints: - // Value must be 1150-65535 Default: The same port as the original DB cluster. - Port *int32 - - // The date and time to restore the DB cluster to. Valid Values: Value must be a - // time in Universal Coordinated Time (UTC) format Constraints: - // - // * Must be - // before the latest restorable time for the DB instance - // - // * Must be specified - // if UseLatestRestorableTime parameter is not provided - // - // * Cannot be specified - // if UseLatestRestorableTime parameter is true - // - // * Cannot be specified if - // RestoreType parameter is copy-on-write - // - // Example: 2015-03-07T23:45:00Z - RestoreToTime *time.Time - - // The list of logs that the restored DB cluster is to export to CloudWatch Logs. - EnableCloudwatchLogsExports []*string - - // A value that is set to true to restore the DB cluster to the latest restorable - // backup time, and false otherwise. Default: false Constraints: Cannot be - // specified if RestoreToTime parameter is provided. - UseLatestRestorableTime *bool - // The DB subnet group name to use for the new DB cluster. Constraints: If // supplied, must match the name of an existing DBSubnetGroup. Example: // mySubnetgroup @@ -142,21 +105,12 @@ type RestoreDBClusterToPointInTimeInput struct { // deletion protection is disabled. DeletionProtection *bool - // (Not supported by Neptune) - OptionGroupName *string + // The list of logs that the restored DB cluster is to export to CloudWatch Logs. + EnableCloudwatchLogsExports []*string - // The name of the new DB cluster to be created. Constraints: - // - // * Must contain - // from 1 to 63 letters, numbers, or hyphens - // - // * First character must be a - // letter - // - // * Cannot end with a hyphen or contain two consecutive hyphens - // - // This member is required. - DBClusterIdentifier *string + // True to enable mapping of AWS Identity and Access Management (IAM) accounts to + // database accounts, and otherwise false. Default: false + EnableIAMDatabaseAuthentication *bool // The AWS KMS key identifier to use when restoring an encrypted DB cluster from an // encrypted DB cluster. The KMS key identifier is the Amazon Resource Name (ARN) @@ -180,6 +134,52 @@ type RestoreDBClusterToPointInTimeInput struct { // is not encrypted, then the restore request is rejected. KmsKeyId *string + // (Not supported by Neptune) + OptionGroupName *string + + // The port number on which the new DB cluster accepts connections. Constraints: + // Value must be 1150-65535 Default: The same port as the original DB cluster. + Port *int32 + + // The date and time to restore the DB cluster to. Valid Values: Value must be a + // time in Universal Coordinated Time (UTC) format Constraints: + // + // * Must be + // before the latest restorable time for the DB instance + // + // * Must be specified + // if UseLatestRestorableTime parameter is not provided + // + // * Cannot be specified + // if UseLatestRestorableTime parameter is true + // + // * Cannot be specified if + // RestoreType parameter is copy-on-write + // + // Example: 2015-03-07T23:45:00Z + RestoreToTime *time.Time + + // The type of restore to be performed. You can specify one of the following + // values: + // + // * full-copy - The new DB cluster is restored as a full copy of the + // source DB cluster. + // + // * copy-on-write - The new DB cluster is restored as a + // clone of the source DB cluster. + // + // If you don't specify a RestoreType value, then + // the new DB cluster is restored as a full copy of the source DB cluster. + RestoreType *string + + // The tags to be applied to the restored DB cluster. + Tags []*types.Tag + + // A value that is set to true to restore the DB cluster to the latest restorable + // backup time, and false otherwise. Default: false Constraints: Cannot be + // specified if RestoreToTime parameter is provided. + UseLatestRestorableTime *bool + // A list of VPC security groups that the new DB cluster belongs to. VpcSecurityGroupIds []*string } diff --git a/service/neptune/go.mod b/service/neptune/go.mod index 7a93a37dff6..c3d596ec457 100644 --- a/service/neptune/go.mod +++ b/service/neptune/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/neptune go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/neptune/types/types.go b/service/neptune/types/types.go index 5b4778636a1..44f267de228 100644 --- a/service/neptune/types/types.go +++ b/service/neptune/types/types.go @@ -16,11 +16,11 @@ type AvailabilityZone struct { // Specifies a character set. type CharacterSet struct { - // The name of the character set. - CharacterSetName *string - // The description of the character set. CharacterSetDescription *string + + // The name of the character set. + CharacterSetName *string } // The configuration setting for the log types to be enabled for export to @@ -29,69 +29,56 @@ type CharacterSet struct { // which logs will be exported (or not exported) to CloudWatch Logs.

    type CloudwatchLogsExportConfiguration struct { - // The list of log types to enable. - EnableLogTypes []*string - // The list of log types to disable. DisableLogTypes []*string + + // The list of log types to enable. + EnableLogTypes []*string } // Contains the details of an Amazon Neptune DB cluster. This data type is used as // a response element in the DescribeDBClusters () action. type DBCluster struct { - // Specifies the latest time to which a database can be restored with point-in-time - // restore. - LatestRestorableTime *time.Time - - // The reader endpoint for the DB cluster. The reader endpoint for a DB cluster - // load-balances connections across the Read Replicas that are available in a DB - // cluster. As clients request new connections to the reader endpoint, Neptune - // distributes the connection requests among the Read Replicas in the DB cluster. - // This functionality can help balance your read workload across multiple Read - // Replicas in your DB cluster. If a failover occurs, and the Read Replica that you - // are connected to is promoted to be the primary instance, your connection is - // dropped. To continue sending your read workload to other Read Replicas in the - // cluster, you can then reconnect to the reader endpoint. - ReaderEndpoint *string - - // Provides the name of the database engine to be used for this DB cluster. - Engine *string - - // Indicates whether or not the DB cluster has deletion protection enabled. The - // database can't be deleted when deletion protection is enabled. - DeletionProtection *bool - - // (Not supported by Neptune) - DBClusterOptionGroupMemberships []*DBClusterOptionGroupStatus + // AllocatedStorage always returns 1, because Neptune DB cluster storage size is + // not fixed, but instead automatically adjusts as needed. + AllocatedStorage *int32 - // Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. - HostedZoneId *string + // Provides a list of the AWS Identity and Access Management (IAM) roles that are + // associated with the DB cluster. IAM roles that are associated with a DB cluster + // grant permission for the DB cluster to access other AWS services on your behalf. + AssociatedRoles []*DBClusterRole // Provides the list of EC2 Availability Zones that instances in the DB cluster can // be created in. AvailabilityZones []*string - // If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB - // cluster. - KmsKeyId *string + // Specifies the number of days for which automatic DB snapshots are retained. + BackupRetentionPeriod *int32 - // Specifies the weekly time range during which system maintenance can occur, in - // Universal Coordinated Time (UTC). - PreferredMaintenanceWindow *string + // (Not supported by Neptune) + CharacterSetName *string - // Contains the name of the initial database of this DB cluster that was provided - // at create time, if one was specified when the DB cluster was created. This same - // name is returned for the life of the DB cluster. - DatabaseName *string + // Identifies the clone group to which the DB cluster is associated. + CloneGroupId *string - // Specifies the daily time range during which automated backups are created if - // automated backups are enabled, as determined by the BackupRetentionPeriod. - PreferredBackupWindow *string + // Specifies the time when the DB cluster was created, in Universal Coordinated + // Time (UTC). + ClusterCreateTime *time.Time // The Amazon Resource Name (ARN) for the DB cluster. DBClusterArn *string + // Contains a user-supplied DB cluster identifier. This identifier is the unique + // key that identifies a DB cluster. + DBClusterIdentifier *string + + // Provides the list of instances that make up the DB cluster. + DBClusterMembers []*DBClusterMember + + // (Not supported by Neptune) + DBClusterOptionGroupMemberships []*DBClusterOptionGroupStatus + // Specifies the name of the DB cluster parameter group for the DB cluster. DBClusterParameterGroup *string @@ -99,104 +86,117 @@ type DBCluster struct { // including the name, description, and subnets in the subnet group. DBSubnetGroup *string + // Contains the name of the initial database of this DB cluster that was provided + // at create time, if one was specified when the DB cluster was created. This same + // name is returned for the life of the DB cluster. + DatabaseName *string + + // The AWS Region-unique, immutable identifier for the DB cluster. This identifier + // is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB + // cluster is accessed. + DbClusterResourceId *string + + // Indicates whether or not the DB cluster has deletion protection enabled. The + // database can't be deleted when deletion protection is enabled. + DeletionProtection *bool + + // Specifies the earliest time to which a database can be restored with + // point-in-time restore. + EarliestRestorableTime *time.Time + // A list of log types that this DB cluster is configured to export to CloudWatch // Logs. EnabledCloudwatchLogsExports []*string - // Provides a list of the AWS Identity and Access Management (IAM) roles that are - // associated with the DB cluster. IAM roles that are associated with a DB cluster - // grant permission for the DB cluster to access other AWS services on your behalf. - AssociatedRoles []*DBClusterRole + // Specifies the connection endpoint for the primary instance of the DB cluster. + Endpoint *string - // Specifies whether the DB cluster has instances in multiple Availability Zones. - MultiAZ *bool + // Provides the name of the database engine to be used for this DB cluster. + Engine *string - // Provides a list of VPC security groups that the DB cluster belongs to. - VpcSecurityGroups []*VpcSecurityGroupMembership + // Indicates the database engine version. + EngineVersion *string + + // Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. + HostedZoneId *string // True if mapping of AWS Identity and Access Management (IAM) accounts to database // accounts is enabled, and otherwise false. IAMDatabaseAuthenticationEnabled *bool - // Specifies whether the DB cluster is encrypted. - StorageEncrypted *bool - - // Not supported by Neptune. - ReplicationSourceIdentifier *string + // If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB + // cluster. + KmsKeyId *string - // Specifies the connection endpoint for the primary instance of the DB cluster. - Endpoint *string + // Specifies the latest time to which a database can be restored with point-in-time + // restore. + LatestRestorableTime *time.Time // Contains the master username for the DB cluster. MasterUsername *string - // Specifies the number of days for which automatic DB snapshots are retained. - BackupRetentionPeriod *int32 + // Specifies whether the DB cluster has instances in multiple Availability Zones. + MultiAZ *bool // Specifies the progress of the operation as a percentage. PercentProgress *string - // Contains a user-supplied DB cluster identifier. This identifier is the unique - // key that identifies a DB cluster. - DBClusterIdentifier *string - - // Identifies the clone group to which the DB cluster is associated. - CloneGroupId *string - - // The AWS Region-unique, immutable identifier for the DB cluster. This identifier - // is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB - // cluster is accessed. - DbClusterResourceId *string + // Specifies the port that the database engine is listening on. + Port *int32 - // Provides the list of instances that make up the DB cluster. - DBClusterMembers []*DBClusterMember + // Specifies the daily time range during which automated backups are created if + // automated backups are enabled, as determined by the BackupRetentionPeriod. + PreferredBackupWindow *string - // AllocatedStorage always returns 1, because Neptune DB cluster storage size is - // not fixed, but instead automatically adjusts as needed. - AllocatedStorage *int32 + // Specifies the weekly time range during which system maintenance can occur, in + // Universal Coordinated Time (UTC). + PreferredMaintenanceWindow *string // Contains one or more identifiers of the Read Replicas associated with this DB // cluster. ReadReplicaIdentifiers []*string - // Specifies the current state of this DB cluster. - Status *string - - // Specifies the earliest time to which a database can be restored with - // point-in-time restore. - EarliestRestorableTime *time.Time + // The reader endpoint for the DB cluster. The reader endpoint for a DB cluster + // load-balances connections across the Read Replicas that are available in a DB + // cluster. As clients request new connections to the reader endpoint, Neptune + // distributes the connection requests among the Read Replicas in the DB cluster. + // This functionality can help balance your read workload across multiple Read + // Replicas in your DB cluster. If a failover occurs, and the Read Replica that you + // are connected to is promoted to be the primary instance, your connection is + // dropped. To continue sending your read workload to other Read Replicas in the + // cluster, you can then reconnect to the reader endpoint. + ReaderEndpoint *string - // Indicates the database engine version. - EngineVersion *string + // Not supported by Neptune. + ReplicationSourceIdentifier *string - // (Not supported by Neptune) - CharacterSetName *string + // Specifies the current state of this DB cluster. + Status *string - // Specifies the time when the DB cluster was created, in Universal Coordinated - // Time (UTC). - ClusterCreateTime *time.Time + // Specifies whether the DB cluster is encrypted. + StorageEncrypted *bool - // Specifies the port that the database engine is listening on. - Port *int32 + // Provides a list of VPC security groups that the DB cluster belongs to. + VpcSecurityGroups []*VpcSecurityGroupMembership } // Contains information about an instance that is part of a DB cluster. type DBClusterMember struct { - // Value that is true if the cluster member is the primary instance for the DB - // cluster and false otherwise. - IsClusterWriter *bool + // Specifies the status of the DB cluster parameter group for this member of the DB + // cluster. + DBClusterParameterGroupStatus *string // Specifies the instance identifier for this member of the DB cluster. DBInstanceIdentifier *string + // Value that is true if the cluster member is the primary instance for the DB + // cluster and false otherwise. + IsClusterWriter *bool + // A value that specifies the order in which a Read Replica is promoted to the // primary instance after a failure of the existing primary instance. PromotionTier *int32 - - // Specifies the status of the DB cluster parameter group for this member of the DB - // cluster. - DBClusterParameterGroupStatus *string } // Contains status information for a DB cluster option group. @@ -214,6 +214,9 @@ type DBClusterOptionGroupStatus struct { // action. type DBClusterParameterGroup struct { + // The Amazon Resource Name (ARN) for the DB cluster parameter group. + DBClusterParameterGroupArn *string + // Provides the name of the DB cluster parameter group. DBClusterParameterGroupName *string @@ -221,9 +224,6 @@ type DBClusterParameterGroup struct { // parameter group is compatible with. DBParameterGroupFamily *string - // The Amazon Resource Name (ARN) for the DB cluster parameter group. - DBClusterParameterGroupArn *string - // Provides the customer-specified description for this DB cluster parameter group. Description *string } @@ -256,26 +256,23 @@ type DBClusterRole struct { // used as a response element in the DescribeDBClusterSnapshots () action. type DBClusterSnapshot struct { - // Specifies the time when the DB cluster was created, in Universal Coordinated - // Time (UTC). - ClusterCreateTime *time.Time - - // Specifies the name of the database engine. - Engine *string + // Specifies the allocated storage size in gibibytes (GiB). + AllocatedStorage *int32 // Provides the list of EC2 Availability Zones that instances in the DB cluster // snapshot can be restored in. AvailabilityZones []*string - // Provides the version of the database engine for this DB cluster snapshot. - EngineVersion *string + // Specifies the time when the DB cluster was created, in Universal Coordinated + // Time (UTC). + ClusterCreateTime *time.Time - // Provides the master username for the DB cluster snapshot. - MasterUsername *string + // Specifies the DB cluster identifier of the DB cluster that this DB cluster + // snapshot was created from. + DBClusterIdentifier *string - // If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB - // cluster snapshot. - KmsKeyId *string + // The Amazon Resource Name (ARN) for the DB cluster snapshot. + DBClusterSnapshotArn *string // Specifies the identifier for a DB cluster snapshot. Must match the identifier of // an existing snapshot.

    After you restore a DB cluster using a @@ -291,29 +288,25 @@ type DBClusterSnapshot struct { // original DB cluster is deleted.

    DBClusterSnapshotIdentifier *string - // Specifies the allocated storage size in gibibytes (GiB). - AllocatedStorage *int32 - - // Provides the license model information for this DB cluster snapshot. - LicenseModel *string + // Specifies the name of the database engine. + Engine *string - // Provides the VPC ID associated with the DB cluster snapshot. - VpcId *string + // Provides the version of the database engine for this DB cluster snapshot. + EngineVersion *string // True if mapping of AWS Identity and Access Management (IAM) accounts to database // accounts is enabled, and otherwise false. IAMDatabaseAuthenticationEnabled *bool - // Specifies whether the DB cluster snapshot is encrypted. - StorageEncrypted *bool + // If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB + // cluster snapshot. + KmsKeyId *string - // Specifies the DB cluster identifier of the DB cluster that this DB cluster - // snapshot was created from. - DBClusterIdentifier *string + // Provides the license model information for this DB cluster snapshot. + LicenseModel *string - // Provides the time when the snapshot was taken, in Universal Coordinated Time - // (UTC). - SnapshotCreateTime *time.Time + // Provides the master username for the DB cluster snapshot. + MasterUsername *string // Specifies the percentage of the estimated data that has been transferred. PercentProgress *int32 @@ -322,8 +315,12 @@ type DBClusterSnapshot struct { // snapshot. Port *int32 - // The Amazon Resource Name (ARN) for the DB cluster snapshot. - DBClusterSnapshotArn *string + // Provides the time when the snapshot was taken, in Universal Coordinated Time + // (UTC). + SnapshotCreateTime *time.Time + + // Provides the type of the DB cluster snapshot. + SnapshotType *string // If the DB cluster snapshot was copied from a source DB cluster snapshot, the // Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null @@ -333,8 +330,11 @@ type DBClusterSnapshot struct { // Specifies the status of this DB cluster snapshot. Status *string - // Provides the type of the DB cluster snapshot. - SnapshotType *string + // Specifies whether the DB cluster snapshot is encrypted. + StorageEncrypted *bool + + // Provides the VPC ID associated with the DB cluster snapshot. + VpcId *string } // Contains the name and values of a manual DB cluster snapshot attribute. Manual @@ -375,248 +375,241 @@ type DBClusterSnapshotAttributesResult struct { // DescribeDBEngineVersions (). type DBEngineVersion struct { - // (Not supported by Neptune) - SupportedCharacterSets []*CharacterSet + // The description of the database engine. + DBEngineDescription *string - // A list of engine versions that this database engine version can be upgraded to. - ValidUpgradeTarget []*UpgradeTarget + // The description of the database engine version. + DBEngineVersionDescription *string + + // The name of the DB parameter group family for the database engine. + DBParameterGroupFamily *string // (Not supported by Neptune) DefaultCharacterSet *CharacterSet - // Indicates whether the database engine version supports read replicas. - SupportsReadReplica *bool + // The name of the database engine. + Engine *string + + // The version number of the database engine. + EngineVersion *string // The types of logs that the database engine has available for export to // CloudWatch Logs. ExportableLogTypes []*string + // (Not supported by Neptune) + SupportedCharacterSets []*CharacterSet + // A list of the time zones supported by this engine for the Timezone parameter of // the CreateDBInstance action. SupportedTimezones []*Timezone - // The description of the database engine. - DBEngineDescription *string - // A value that indicates whether the engine version supports exporting the log // types specified by ExportableLogTypes to CloudWatch Logs. SupportsLogExportsToCloudwatchLogs *bool - // The name of the database engine. - Engine *string - - // The version number of the database engine. - EngineVersion *string - - // The name of the DB parameter group family for the database engine. - DBParameterGroupFamily *string + // Indicates whether the database engine version supports read replicas. + SupportsReadReplica *bool - // The description of the database engine version. - DBEngineVersionDescription *string + // A list of engine versions that this database engine version can be upgraded to. + ValidUpgradeTarget []*UpgradeTarget } // Contains the details of an Amazon Neptune DB instance. This data type is used as // a response element in the DescribeDBInstances () action. type DBInstance struct { - // Specifies the name of the Availability Zone the DB instance is located in. - AvailabilityZone *string + // Specifies the allocated storage size specified in gibibytes. + AllocatedStorage *int32 - // The database name. - DBName *string + // Indicates that minor version patches are applied automatically. + AutoMinorVersionUpgrade *bool - // Contains one or more identifiers of the Read Replicas associated with this DB - // instance. - ReadReplicaDBInstanceIdentifiers []*string + // Specifies the name of the Availability Zone the DB instance is located in. + AvailabilityZone *string - // Specifies the allocated storage size specified in gibibytes. - AllocatedStorage *int32 + // Specifies the number of days for which automatic DB snapshots are retained. + BackupRetentionPeriod *int32 // The identifier of the CA certificate for this DB instance. CACertificateIdentifier *string - // Contains the name of the compute and memory capacity class of the DB instance. - DBInstanceClass *string - - // Specifies the latest time to which a database can be restored with point-in-time - // restore. - LatestRestorableTime *time.Time - - // Provides the name of the database engine to be used for this DB instance. - Engine *string + // (Not supported by Neptune) + CharacterSetName *string - // The interval, in seconds, between points when Enhanced Monitoring metrics are - // collected for the DB instance. - MonitoringInterval *int32 + // Specifies whether tags are copied from the DB instance to snapshots of the DB + // instance. + CopyTagsToSnapshot *bool - // A list of log types that this DB instance is configured to export to CloudWatch - // Logs. - EnabledCloudwatchLogsExports []*string + // If the DB instance is a member of a DB cluster, contains the name of the DB + // cluster that the DB instance is a member of. + DBClusterIdentifier *string // The Amazon Resource Name (ARN) for the DB instance. DBInstanceArn *string + // Contains the name of the compute and memory capacity class of the DB instance. + DBInstanceClass *string + + // Contains a user-supplied database identifier. This identifier is the unique key + // that identifies a DB instance. + DBInstanceIdentifier *string + // Specifies the current state of this database. DBInstanceStatus *string - // If the DB instance is a member of a DB cluster, contains the name of the DB - // cluster that the DB instance is a member of. - DBClusterIdentifier *string + // The database name. + DBName *string - // Not supported - DomainMemberships []*DomainMembership + // Provides the list of DB parameter groups applied to this DB instance. + DBParameterGroups []*DBParameterGroupStatus - // Specifies whether tags are copied from the DB instance to snapshots of the DB - // instance. - CopyTagsToSnapshot *bool + // Provides List of DB security group elements containing only DBSecurityGroup.Name + // and DBSecurityGroup.Status subelements. + DBSecurityGroups []*DBSecurityGroupMembership - // Contains one or more identifiers of DB clusters that are Read Replicas of this - // DB instance. - ReadReplicaDBClusterIdentifiers []*string + // Specifies information on the subnet group associated with the DB instance, + // including the name, description, and subnets in the subnet group. + DBSubnetGroup *DBSubnetGroup - // Not supported: The encryption for DB instances is managed by the DB cluster. - StorageEncrypted *bool + // Specifies the port that the DB instance listens on. If the DB instance is part + // of a DB cluster, this can be a different port than the DB cluster port. + DbInstancePort *int32 - // Not supported. - Timezone *string + // The AWS Region-unique, immutable identifier for the DB instance. This identifier + // is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB + // instance is accessed. + DbiResourceId *string - // The ARN for the IAM role that permits Neptune to send Enhanced Monitoring - // metrics to Amazon CloudWatch Logs. - MonitoringRoleArn *string + // Indicates whether or not the DB instance has deletion protection enabled. The + // instance can't be deleted when deletion protection is enabled. See Deleting a DB + // Instance + // (https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html). + DeletionProtection *bool - // If present, specifies the name of the secondary Availability Zone for a DB - // instance with multi-AZ support. - SecondaryAvailabilityZone *string + // Not supported + DomainMemberships []*DomainMembership - // Provides the date and time the DB instance was created. - InstanceCreateTime *time.Time + // A list of log types that this DB instance is configured to export to CloudWatch + // Logs. + EnabledCloudwatchLogsExports []*string - // Contains the master username for the DB instance. - MasterUsername *string + // Specifies the connection endpoint. + Endpoint *Endpoint - // Provides List of DB security group elements containing only DBSecurityGroup.Name - // and DBSecurityGroup.Status subelements. - DBSecurityGroups []*DBSecurityGroupMembership + // Provides the name of the database engine to be used for this DB instance. + Engine *string - // A value that specifies the order in which a Read Replica is promoted to the - // primary instance after a failure of the existing primary instance. - PromotionTier *int32 + // Indicates the database engine version. + EngineVersion *string // The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that // receives the Enhanced Monitoring metrics data for the DB instance. EnhancedMonitoringResourceArn *string - // Contains a user-supplied database identifier. This identifier is the unique key - // that identifies a DB instance. - DBInstanceIdentifier *string - - // Contains the identifier of the source DB instance if this DB instance is a Read - // Replica. - ReadReplicaSourceDBInstanceIdentifier *string - - // Specifies the storage type associated with DB instance. - StorageType *string - - // Indicates the database engine version. - EngineVersion *string - - // (Not supported by Neptune) - CharacterSetName *string + // True if AWS Identity and Access Management (IAM) authentication is enabled, and + // otherwise false. + IAMDatabaseAuthenticationEnabled *bool - // Specifies the weekly time range during which system maintenance can occur, in - // Universal Coordinated Time (UTC). - PreferredMaintenanceWindow *string + // Provides the date and time the DB instance was created. + InstanceCreateTime *time.Time - // Indicates whether or not the DB instance has deletion protection enabled. The - // instance can't be deleted when deletion protection is enabled. See Deleting a DB - // Instance - // (https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html). - DeletionProtection *bool + // Specifies the Provisioned IOPS (I/O operations per second) value. + Iops *int32 - // This flag should no longer be used. - PubliclyAccessible *bool + // Not supported: The encryption for DB instances is managed by the DB cluster. + KmsKeyId *string - // Specifies information on the subnet group associated with the DB instance, - // including the name, description, and subnets in the subnet group. - DBSubnetGroup *DBSubnetGroup + // Specifies the latest time to which a database can be restored with point-in-time + // restore. + LatestRestorableTime *time.Time // License model information for this DB instance. LicenseModel *string - // Specifies the connection endpoint. - Endpoint *Endpoint + // Contains the master username for the DB instance. + MasterUsername *string - // Not supported: The encryption for DB instances is managed by the DB cluster. - KmsKeyId *string + // The interval, in seconds, between points when Enhanced Monitoring metrics are + // collected for the DB instance. + MonitoringInterval *int32 - // Specifies the port that the DB instance listens on. If the DB instance is part - // of a DB cluster, this can be a different port than the DB cluster port. - DbInstancePort *int32 + // The ARN for the IAM role that permits Neptune to send Enhanced Monitoring + // metrics to Amazon CloudWatch Logs. + MonitoringRoleArn *string + + // Specifies if the DB instance is a Multi-AZ deployment. + MultiAZ *bool + + // (Not supported by Neptune) + OptionGroupMemberships []*OptionGroupMembership // Specifies that changes to the DB instance are pending. This element is only // included when changes are pending. Specific changes are identified by // subelements. PendingModifiedValues *PendingModifiedValues - // Provides the list of DB parameter groups applied to this DB instance. - DBParameterGroups []*DBParameterGroupStatus + // (Not supported by Neptune) + PerformanceInsightsEnabled *bool - // Specifies the Provisioned IOPS (I/O operations per second) value. - Iops *int32 + // (Not supported by Neptune) + PerformanceInsightsKMSKeyId *string - // Indicates that minor version patches are applied automatically. - AutoMinorVersionUpgrade *bool + // Specifies the daily time range during which automated backups are created if + // automated backups are enabled, as determined by the BackupRetentionPeriod. + PreferredBackupWindow *string - // The ARN from the key store with which the instance is associated for TDE - // encryption. - TdeCredentialArn *string + // Specifies the weekly time range during which system maintenance can occur, in + // Universal Coordinated Time (UTC). + PreferredMaintenanceWindow *string - // Specifies if the DB instance is a Multi-AZ deployment. - MultiAZ *bool + // A value that specifies the order in which a Read Replica is promoted to the + // primary instance after a failure of the existing primary instance. + PromotionTier *int32 - // Provides a list of VPC security group elements that the DB instance belongs to. - VpcSecurityGroups []*VpcSecurityGroupMembership + // This flag should no longer be used. + PubliclyAccessible *bool - // (Not supported by Neptune) - PerformanceInsightsKMSKeyId *string + // Contains one or more identifiers of DB clusters that are Read Replicas of this + // DB instance. + ReadReplicaDBClusterIdentifiers []*string + + // Contains one or more identifiers of the Read Replicas associated with this DB + // instance. + ReadReplicaDBInstanceIdentifiers []*string + + // Contains the identifier of the source DB instance if this DB instance is a Read + // Replica. + ReadReplicaSourceDBInstanceIdentifier *string + + // If present, specifies the name of the secondary Availability Zone for a DB + // instance with multi-AZ support. + SecondaryAvailabilityZone *string // The status of a Read Replica. If the instance is not a Read Replica, this is // blank. StatusInfos []*DBInstanceStatusInfo - // (Not supported by Neptune) - OptionGroupMemberships []*OptionGroupMembership - - // Specifies the number of days for which automatic DB snapshots are retained. - BackupRetentionPeriod *int32 + // Not supported: The encryption for DB instances is managed by the DB cluster. + StorageEncrypted *bool - // The AWS Region-unique, immutable identifier for the DB instance. This identifier - // is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB - // instance is accessed. - DbiResourceId *string + // Specifies the storage type associated with DB instance. + StorageType *string - // Specifies the daily time range during which automated backups are created if - // automated backups are enabled, as determined by the BackupRetentionPeriod. - PreferredBackupWindow *string + // The ARN from the key store with which the instance is associated for TDE + // encryption. + TdeCredentialArn *string - // True if AWS Identity and Access Management (IAM) authentication is enabled, and - // otherwise false. - IAMDatabaseAuthenticationEnabled *bool + // Not supported. + Timezone *string - // (Not supported by Neptune) - PerformanceInsightsEnabled *bool + // Provides a list of VPC security group elements that the DB instance belongs to. + VpcSecurityGroups []*VpcSecurityGroupMembership } // Provides a list of status information for a DB instance. type DBInstanceStatusInfo struct { - // Status of the DB instance. For a StatusType of read replica, the values can be - // replicating, error, stopped, or terminated. - Status *string - - // This value is currently "read replication." - StatusType *string - // Details of the error if there is an error for the instance. If the instance is // not in an error state, this value is blank. Message *string @@ -624,24 +617,31 @@ type DBInstanceStatusInfo struct { // Boolean value that is true if the instance is operating normally, or false if // the instance is in an error state. Normal *bool + + // Status of the DB instance. For a StatusType of read replica, the values can be + // replicating, error, stopped, or terminated. + Status *string + + // This value is currently "read replication." + StatusType *string } // Contains the details of an Amazon Neptune DB parameter group. This data type is // used as a response element in the DescribeDBParameterGroups () action. type DBParameterGroup struct { - // Provides the customer-specified description for this DB parameter group. - Description *string + // The Amazon Resource Name (ARN) for the DB parameter group. + DBParameterGroupArn *string // Provides the name of the DB parameter group family that this DB parameter group // is compatible with. DBParameterGroupFamily *string - // The Amazon Resource Name (ARN) for the DB parameter group. - DBParameterGroupArn *string - // Provides the name of the DB parameter group. DBParameterGroupName *string + + // Provides the customer-specified description for this DB parameter group. + Description *string } // The status of the DB parameter group. This data type is used as a response @@ -657,11 +657,11 @@ type DBParameterGroup struct { // * RebootDBInstance () type DBParameterGroupStatus struct { - // The status of parameter updates. - ParameterApplyStatus *string - // The name of the DP parameter group. DBParameterGroupName *string + + // The status of parameter updates. + ParameterApplyStatus *string } // Specifies membership in a designated DB security group. @@ -678,23 +678,23 @@ type DBSecurityGroupMembership struct { // used as a response element in the DescribeDBSubnetGroups () action. type DBSubnetGroup struct { - // Provides the VpcId of the DB subnet group. - VpcId *string - // The Amazon Resource Name (ARN) for the DB subnet group. DBSubnetGroupArn *string // Provides the description of the DB subnet group. DBSubnetGroupDescription *string - // Provides the status of the DB subnet group. - SubnetGroupStatus *string - // The name of the DB subnet group. DBSubnetGroupName *string + // Provides the status of the DB subnet group. + SubnetGroupStatus *string + // Contains a list of Subnet () elements. Subnets []*Subnet + + // Provides the VpcId of the DB subnet group. + VpcId *string } // An Active Directory Domain membership record associated with a DB instance. @@ -703,6 +703,9 @@ type DomainMembership struct { // The identifier of the Active Directory Domain. Domain *string + // The fully qualified domain name of the Active Directory Domain. + FQDN *string + // The name of the IAM role to be used when making API calls to the Directory // Service. IAMRoleName *string @@ -710,47 +713,44 @@ type DomainMembership struct { // The status of the DB instance's Active Directory Domain membership, such as // joined, pending-join, failed etc). Status *string - - // The fully qualified domain name of the Active Directory Domain. - FQDN *string } // A range of double values. type DoubleRange struct { - // The maximum value in the range. - To *float64 - // The minimum value in the range. From *float64 + + // The maximum value in the range. + To *float64 } // Specifies a connection endpoint. type Endpoint struct { - // Specifies the port that the database engine is listening on. - Port *int32 + // Specifies the DNS address of the DB instance. + Address *string // Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. HostedZoneId *string - // Specifies the DNS address of the DB instance. - Address *string + // Specifies the port that the database engine is listening on. + Port *int32 } // Contains the result of a successful invocation of the // DescribeEngineDefaultParameters () action. type EngineDefaults struct { - // An optional pagination token provided by a previous EngineDefaults request. If - // this parameter is specified, the response includes only records beyond the - // marker, up to the value specified by MaxRecords . - Marker *string - // Specifies the name of the DB parameter group family that the engine default // parameters apply to. DBParameterGroupFamily *string + // An optional pagination token provided by a previous EngineDefaults request. If + // this parameter is specified, the response includes only records beyond the + // marker, up to the value specified by MaxRecords . + Marker *string + // Contains a list of engine default parameters. Parameters []*Parameter } @@ -761,20 +761,20 @@ type Event struct { // Specifies the date and time of the event. Date *time.Time - // Provides the identifier for the source of the event. - SourceIdentifier *string - - // Specifies the source type for this event. - SourceType SourceType + // Specifies the category for the event. + EventCategories []*string // Provides the text of this event. Message *string - // Specifies the category for the event. - EventCategories []*string - // The Amazon Resource Name (ARN) for the event. SourceArn *string + + // Provides the identifier for the source of the event. + SourceIdentifier *string + + // Specifies the source type for this event. + SourceType SourceType } // Contains the results of a successful invocation of the DescribeEventCategories @@ -792,22 +792,31 @@ type EventCategoriesMap struct { // DescribeEventSubscriptions () action. type EventSubscription struct { + // The event notification subscription Id. + CustSubscriptionId *string + + // The AWS customer account associated with the event notification subscription. + CustomerAwsId *string + // A Boolean value indicating if the subscription is enabled. True indicates the // subscription is enabled. Enabled *bool - // The topic ARN of the event notification subscription. - SnsTopicArn *string + // A list of event categories for the event notification subscription. + EventCategoriesList []*string // The Amazon Resource Name (ARN) for the event subscription. EventSubscriptionArn *string - // The event notification subscription Id. - CustSubscriptionId *string + // The topic ARN of the event notification subscription. + SnsTopicArn *string // A list of source IDs for the event notification subscription. SourceIdsList []*string + // The source type for the event notification subscription. + SourceType *string + // The status of the event notification subscription. Constraints: Can be one of // the following: creating | modifying | deleting | active | no-permission | // topic-not-exist The status "no-permission" indicates that Neptune no longer has @@ -815,15 +824,6 @@ type EventSubscription struct { // the topic was deleted after the subscription was created. Status *string - // A list of event categories for the event notification subscription. - EventCategoriesList []*string - - // The source type for the event notification subscription. - SourceType *string - - // The AWS customer account associated with the event notification subscription. - CustomerAwsId *string - // The time the event notification subscription was created. SubscriptionCreationTime *string } @@ -845,115 +845,115 @@ type Filter struct { // Provides information on the option groups the DB instance is a member of. type OptionGroupMembership struct { + // The name of the option group that the instance belongs to. + OptionGroupName *string + // The status of the DB instance's option group membership. Valid values are: // in-sync, pending-apply, pending-removal, pending-maintenance-apply, // pending-maintenance-removal, applying, removing, and failed. Status *string - - // The name of the option group that the instance belongs to. - OptionGroupName *string } // Contains a list of available options for a DB instance. This data type is used // as a response element in the DescribeOrderableDBInstanceOptions () action. type OrderableDBInstanceOption struct { - // The DB instance class for a DB instance. - DBInstanceClass *string - // A list of Availability Zones for a DB instance. AvailabilityZones []*AvailabilityZone + // The DB instance class for a DB instance. + DBInstanceClass *string + // The engine type of a DB instance. Engine *string - // Indicates whether a DB instance is Multi-AZ capable. - MultiAZCapable *bool + // The engine version of a DB instance. + EngineVersion *string - // Maximum storage size for a DB instance. - MaxStorageSize *int32 + // The license model for a DB instance. + LicenseModel *string - // Indicates whether a DB instance is in a VPC. - Vpc *bool + // Maximum total provisioned IOPS for a DB instance. + MaxIopsPerDbInstance *int32 - // The engine version of a DB instance. - EngineVersion *string + // Maximum provisioned IOPS per GiB for a DB instance. + MaxIopsPerGib *float64 - // Indicates the storage type for a DB instance. - StorageType *string + // Maximum storage size for a DB instance. + MaxStorageSize *int32 // Minimum total provisioned IOPS for a DB instance. MinIopsPerDbInstance *int32 - // Indicates whether a DB instance supports IAM database authentication. - SupportsIAMDatabaseAuthentication *bool + // Minimum provisioned IOPS per GiB for a DB instance. + MinIopsPerGib *float64 - // Indicates whether a DB instance supports provisioned IOPS. - SupportsIops *bool + // Minimum storage size for a DB instance. + MinStorageSize *int32 + + // Indicates whether a DB instance is Multi-AZ capable. + MultiAZCapable *bool + + // Indicates whether a DB instance can have a Read Replica. + ReadReplicaCapable *bool + + // Indicates the storage type for a DB instance. + StorageType *string // Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 // to 60 seconds. SupportsEnhancedMonitoring *bool - // The license model for a DB instance. - LicenseModel *string - - // Maximum provisioned IOPS per GiB for a DB instance. - MaxIopsPerGib *float64 + // Indicates whether a DB instance supports IAM database authentication. + SupportsIAMDatabaseAuthentication *bool - // Maximum total provisioned IOPS for a DB instance. - MaxIopsPerDbInstance *int32 + // Indicates whether a DB instance supports provisioned IOPS. + SupportsIops *bool // (Not supported by Neptune) SupportsPerformanceInsights *bool - // Indicates whether a DB instance can have a Read Replica. - ReadReplicaCapable *bool - - // Minimum storage size for a DB instance. - MinStorageSize *int32 - - // Minimum provisioned IOPS per GiB for a DB instance. - MinIopsPerGib *float64 - // Indicates whether a DB instance supports encrypted storage. SupportsStorageEncryption *bool + + // Indicates whether a DB instance is in a VPC. + Vpc *bool } // Specifies a parameter. type Parameter struct { - // Provides a description of the parameter. - Description *string + // Specifies the valid range of values for the parameter. + AllowedValues *string + + // Indicates when to apply parameter updates. + ApplyMethod ApplyMethod // Specifies the engine specific parameters type. ApplyType *string + // Specifies the valid data type for the parameter. + DataType *string + + // Provides a description of the parameter. + Description *string + // Indicates whether (true) or not (false) the parameter can be modified. Some // parameters have security or operational implications that prevent them from // being changed. IsModifiable *bool - // Indicates when to apply parameter updates. - ApplyMethod ApplyMethod - - // Specifies the name of the parameter. - ParameterName *string - - // Indicates the source of the parameter value. - Source *string - - // Specifies the valid data type for the parameter. - DataType *string - // The earliest engine version to which the parameter can apply. MinimumEngineVersion *string - // Specifies the valid range of values for the parameter. - AllowedValues *string + // Specifies the name of the parameter. + ParameterName *string // Specifies the value of the parameter. ParameterValue *string + + // Indicates the source of the parameter value. + Source *string } // A list of the log types whose configuration is still pending. In other words, @@ -972,8 +972,14 @@ type PendingCloudwatchLogsExports struct { // Provides information about a pending maintenance action for a resource. type PendingMaintenanceAction struct { - // Indicates the type of opt-in request that has been received for the resource. - OptInStatus *string + // The type of pending maintenance action that is available for the resource. + Action *string + + // The date of the maintenance window when the action is applied. The maintenance + // action is applied to the resource during its first maintenance window after this + // date. If this date is specified, any next-maintenance opt-in requests are + // ignored. + AutoAppliedAfterDate *time.Time // The effective date when the pending maintenance action is applied to the // resource. This date takes into account opt-in requests received from the @@ -985,34 +991,39 @@ type PendingMaintenanceAction struct { // A description providing more detail about the maintenance action. Description *string - // The type of pending maintenance action that is available for the resource. - Action *string - - // The date of the maintenance window when the action is applied. The maintenance - // action is applied to the resource during its first maintenance window after this - // date. If this date is specified, any next-maintenance opt-in requests are - // ignored. - AutoAppliedAfterDate *time.Time - // The date when the maintenance action is automatically applied. The maintenance // action is applied to the resource on this date regardless of the maintenance // window for the resource. If this date is specified, any immediate opt-in // requests are ignored. ForcedApplyDate *time.Time + + // Indicates the type of opt-in request that has been received for the resource. + OptInStatus *string } // This data type is used as a response element in the ModifyDBInstance () action. type PendingModifiedValues struct { - // Specifies the storage type to be associated with the DB instance. - StorageType *string + // Contains the new AllocatedStorage size for the DB instance that will be applied + // or is currently being applied. + AllocatedStorage *int32 - // The license model for the DB instance. Valid values: license-included | - // bring-your-own-license | general-public-license - LicenseModel *string + // Specifies the pending number of days for which automated backups are retained. + BackupRetentionPeriod *int32 - // Specifies the pending port for the DB instance. - Port *int32 + // Specifies the identifier of the CA certificate for the DB instance. + CACertificateIdentifier *string + + // Contains the new DBInstanceClass for the DB instance that will be applied or is + // currently being applied. + DBInstanceClass *string + + // Contains the new DBInstanceIdentifier for the DB instance that will be applied + // or is currently being applied. + DBInstanceIdentifier *string + + // The new DB subnet group for the DB instance. + DBSubnetGroupName *string // Indicates the database engine version. EngineVersion *string @@ -1021,51 +1032,40 @@ type PendingModifiedValues struct { // applied or is currently being applied. Iops *int32 - // Contains the new AllocatedStorage size for the DB instance that will be applied - // or is currently being applied. - AllocatedStorage *int32 - - // The new DB subnet group for the DB instance. - DBSubnetGroupName *string + // The license model for the DB instance. Valid values: license-included | + // bring-your-own-license | general-public-license + LicenseModel *string // Contains the pending or currently-in-progress change of the master credentials // for the DB instance. MasterUserPassword *string - // Specifies the identifier of the CA certificate for the DB instance. - CACertificateIdentifier *string - - // Contains the new DBInstanceIdentifier for the DB instance that will be applied - // or is currently being applied. - DBInstanceIdentifier *string + // Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment. + MultiAZ *bool // This PendingCloudwatchLogsExports structure specifies pending changes to which // CloudWatch logs are enabled and which are disabled. PendingCloudwatchLogsExports *PendingCloudwatchLogsExports - // Contains the new DBInstanceClass for the DB instance that will be applied or is - // currently being applied. - DBInstanceClass *string - - // Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment. - MultiAZ *bool + // Specifies the pending port for the DB instance. + Port *int32 - // Specifies the pending number of days for which automated backups are retained. - BackupRetentionPeriod *int32 + // Specifies the storage type to be associated with the DB instance. + StorageType *string } // A range of integer values. type Range struct { + // The minimum value in the range. + From *int32 + // The step value for the range. For example, if you have a range of 5,000 to // 10,000, with a step value of 1,000, the valid values start at 5,000 and step up // by 1,000. Even though 7,500 is within the range, it isn't a valid value for the // range. The valid values are 5,000, 6,000, 7,000, 8,000... Step *int32 - // The minimum value in the range. - From *int32 - // The maximum value in the range. To *int32 } @@ -1085,14 +1085,14 @@ type ResourcePendingMaintenanceActions struct { // DescribeDBSubnetGroups () action. type Subnet struct { - // Specifies the status of the subnet. - SubnetStatus *string + // Specifies the EC2 Availability Zone that the subnet is in. + SubnetAvailabilityZone *AvailabilityZone // Specifies the identifier of the subnet. SubnetIdentifier *string - // Specifies the EC2 Availability Zone that the subnet is in. - SubnetAvailabilityZone *AvailabilityZone + // Specifies the status of the subnet. + SubnetStatus *string } // Metadata assigned to an Amazon Neptune resource consisting of a key-value pair. @@ -1121,21 +1121,21 @@ type Timezone struct { // The version of the database engine that a DB instance can be upgraded to. type UpgradeTarget struct { - // The version of the database engine that a DB instance can be upgraded to. - Description *string - // A value that indicates whether the target version is applied to any source DB // instances that have AutoMinorVersionUpgrade set to true. AutoUpgrade *bool + // The version of the database engine that a DB instance can be upgraded to. + Description *string + + // The name of the upgrade target database engine. + Engine *string + // The version number of the upgrade target database engine. EngineVersion *string // A value that indicates whether a database engine is upgraded to a major version. IsMajorVersionUpgrade *bool - - // The name of the upgrade target database engine. - Engine *string } // Information about valid modifications that you can make to your DB instance. @@ -1158,14 +1158,14 @@ type ValidStorageOptions struct { // storage. IopsToStorageRatio []*DoubleRange - // The valid storage types for your DB instance. For example, gp2, io1. - StorageType *string - // The valid range of provisioned IOPS. For example, 1000-20000. ProvisionedIops []*Range // The valid range of storage in gibibytes. For example, 100 to 16384. StorageSize []*Range + + // The valid storage types for your DB instance. For example, gp2, io1. + StorageType *string } // This data type is used as a response element for queries on VPC security group diff --git a/service/networkmanager/api_op_AssociateCustomerGateway.go b/service/networkmanager/api_op_AssociateCustomerGateway.go index c2daba992b9..1a887cf9c4a 100644 --- a/service/networkmanager/api_op_AssociateCustomerGateway.go +++ b/service/networkmanager/api_op_AssociateCustomerGateway.go @@ -73,15 +73,15 @@ type AssociateCustomerGatewayInput struct { // This member is required. CustomerGatewayArn *string - // The ID of the global network. + // The ID of the device. // // This member is required. - GlobalNetworkId *string + DeviceId *string - // The ID of the device. + // The ID of the global network. // // This member is required. - DeviceId *string + GlobalNetworkId *string // The ID of the link. LinkId *string diff --git a/service/networkmanager/api_op_AssociateLink.go b/service/networkmanager/api_op_AssociateLink.go index 38605fa94b0..2d1503314fa 100644 --- a/service/networkmanager/api_op_AssociateLink.go +++ b/service/networkmanager/api_op_AssociateLink.go @@ -59,15 +59,15 @@ func (c *Client) AssociateLink(ctx context.Context, params *AssociateLinkInput, type AssociateLinkInput struct { - // The ID of the global network. + // The ID of the device. // // This member is required. - GlobalNetworkId *string + DeviceId *string - // The ID of the device. + // The ID of the global network. // // This member is required. - DeviceId *string + GlobalNetworkId *string // The ID of the link. // diff --git a/service/networkmanager/api_op_CreateDevice.go b/service/networkmanager/api_op_CreateDevice.go index a72e16d0982..64e88714521 100644 --- a/service/networkmanager/api_op_CreateDevice.go +++ b/service/networkmanager/api_op_CreateDevice.go @@ -59,18 +59,10 @@ func (c *Client) CreateDevice(ctx context.Context, params *CreateDeviceInput, op type CreateDeviceInput struct { - // The serial number of the device. Length Constraints: Maximum length of 128 - // characters. - SerialNumber *string - - // The tags to apply to the resource during creation. - Tags []*types.Tag - - // The ID of the site. - SiteId *string - - // The type of the device. - Type *string + // The ID of the global network. + // + // This member is required. + GlobalNetworkId *string // A description of the device. Length Constraints: Maximum length of 256 // characters. @@ -82,13 +74,21 @@ type CreateDeviceInput struct { // The model of the device. Length Constraints: Maximum length of 128 characters. Model *string + // The serial number of the device. Length Constraints: Maximum length of 128 + // characters. + SerialNumber *string + + // The ID of the site. + SiteId *string + + // The tags to apply to the resource during creation. + Tags []*types.Tag + + // The type of the device. + Type *string + // The vendor of the device. Length Constraints: Maximum length of 128 characters. Vendor *string - - // The ID of the global network. - // - // This member is required. - GlobalNetworkId *string } type CreateDeviceOutput struct { diff --git a/service/networkmanager/api_op_CreateGlobalNetwork.go b/service/networkmanager/api_op_CreateGlobalNetwork.go index f74c8c86417..b68654fc96c 100644 --- a/service/networkmanager/api_op_CreateGlobalNetwork.go +++ b/service/networkmanager/api_op_CreateGlobalNetwork.go @@ -56,12 +56,12 @@ func (c *Client) CreateGlobalNetwork(ctx context.Context, params *CreateGlobalNe type CreateGlobalNetworkInput struct { - // The tags to apply to the resource during creation. - Tags []*types.Tag - // A description of the global network. Length Constraints: Maximum length of 256 // characters. Description *string + + // The tags to apply to the resource during creation. + Tags []*types.Tag } type CreateGlobalNetworkOutput struct { diff --git a/service/networkmanager/api_op_CreateLink.go b/service/networkmanager/api_op_CreateLink.go index b76813f388e..8680e6190c7 100644 --- a/service/networkmanager/api_op_CreateLink.go +++ b/service/networkmanager/api_op_CreateLink.go @@ -57,34 +57,34 @@ func (c *Client) CreateLink(ctx context.Context, params *CreateLinkInput, optFns type CreateLinkInput struct { - // The tags to apply to the resource during creation. - Tags []*types.Tag - - // The ID of the site. + // The upload speed and download speed in Mbps. // // This member is required. - SiteId *string - - // The type of the link. Constraints: Cannot include the following characters: | \ - // ^ Length Constraints: Maximum length of 128 characters. - Type *string + Bandwidth *types.Bandwidth // The ID of the global network. // // This member is required. GlobalNetworkId *string + // The ID of the site. + // + // This member is required. + SiteId *string + + // A description of the link. Length Constraints: Maximum length of 256 characters. + Description *string + // The provider of the link. Constraints: Cannot include the following characters: // | \ ^ Length Constraints: Maximum length of 128 characters. Provider *string - // A description of the link. Length Constraints: Maximum length of 256 characters. - Description *string + // The tags to apply to the resource during creation. + Tags []*types.Tag - // The upload speed and download speed in Mbps. - // - // This member is required. - Bandwidth *types.Bandwidth + // The type of the link. Constraints: Cannot include the following characters: | \ + // ^ Length Constraints: Maximum length of 128 characters. + Type *string } type CreateLinkOutput struct { diff --git a/service/networkmanager/api_op_CreateSite.go b/service/networkmanager/api_op_CreateSite.go index fc39fa0c284..6f3d1b3bf02 100644 --- a/service/networkmanager/api_op_CreateSite.go +++ b/service/networkmanager/api_op_CreateSite.go @@ -57,6 +57,15 @@ func (c *Client) CreateSite(ctx context.Context, params *CreateSiteInput, optFns type CreateSiteInput struct { + // The ID of the global network. + // + // This member is required. + GlobalNetworkId *string + + // A description of your site. Length Constraints: Maximum length of 256 + // characters. + Description *string + // The site location. This information is used for visualization in the Network // Manager console. If you specify the address, the latitude and longitude are // automatically calculated. @@ -72,15 +81,6 @@ type CreateSiteInput struct { // The tags to apply to the resource during creation. Tags []*types.Tag - - // The ID of the global network. - // - // This member is required. - GlobalNetworkId *string - - // A description of your site. Length Constraints: Maximum length of 256 - // characters. - Description *string } type CreateSiteOutput struct { diff --git a/service/networkmanager/api_op_DescribeGlobalNetworks.go b/service/networkmanager/api_op_DescribeGlobalNetworks.go index 7ab7852a25d..50e148fee7d 100644 --- a/service/networkmanager/api_op_DescribeGlobalNetworks.go +++ b/service/networkmanager/api_op_DescribeGlobalNetworks.go @@ -59,24 +59,24 @@ func (c *Client) DescribeGlobalNetworks(ctx context.Context, params *DescribeGlo type DescribeGlobalNetworksInput struct { - // The maximum number of results to return. - MaxResults *int32 - // The IDs of one or more global networks. The maximum is 10. GlobalNetworkIds []*string + // The maximum number of results to return. + MaxResults *int32 + // The token for the next page of results. NextToken *string } type DescribeGlobalNetworksOutput struct { - // The token for the next page of results. - NextToken *string - // Information about the global networks. GlobalNetworks []*types.GlobalNetwork + // The token for the next page of results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/networkmanager/api_op_DisassociateLink.go b/service/networkmanager/api_op_DisassociateLink.go index 9c27e031448..4102e657302 100644 --- a/service/networkmanager/api_op_DisassociateLink.go +++ b/service/networkmanager/api_op_DisassociateLink.go @@ -63,15 +63,15 @@ type DisassociateLinkInput struct { // This member is required. DeviceId *string - // The ID of the link. + // The ID of the global network. // // This member is required. - LinkId *string + GlobalNetworkId *string - // The ID of the global network. + // The ID of the link. // // This member is required. - GlobalNetworkId *string + LinkId *string } type DisassociateLinkOutput struct { diff --git a/service/networkmanager/api_op_GetCustomerGatewayAssociations.go b/service/networkmanager/api_op_GetCustomerGatewayAssociations.go index 7dc50db9ef0..8f28d9261c6 100644 --- a/service/networkmanager/api_op_GetCustomerGatewayAssociations.go +++ b/service/networkmanager/api_op_GetCustomerGatewayAssociations.go @@ -58,8 +58,10 @@ func (c *Client) GetCustomerGatewayAssociations(ctx context.Context, params *Get type GetCustomerGatewayAssociationsInput struct { - // The token for the next page of results. - NextToken *string + // The ID of the global network. + // + // This member is required. + GlobalNetworkId *string // One or more customer gateway Amazon Resource Names (ARNs). For more information, // see Resources Defined by Amazon EC2 @@ -70,10 +72,8 @@ type GetCustomerGatewayAssociationsInput struct { // The maximum number of results to return. MaxResults *int32 - // The ID of the global network. - // - // This member is required. - GlobalNetworkId *string + // The token for the next page of results. + NextToken *string } type GetCustomerGatewayAssociationsOutput struct { diff --git a/service/networkmanager/api_op_GetDevices.go b/service/networkmanager/api_op_GetDevices.go index 683a7ac5a11..1bca44f8edb 100644 --- a/service/networkmanager/api_op_GetDevices.go +++ b/service/networkmanager/api_op_GetDevices.go @@ -65,14 +65,14 @@ type GetDevicesInput struct { // One or more device IDs. The maximum is 10. DeviceIds []*string - // The ID of the site. - SiteId *string - // The maximum number of results to return. MaxResults *int32 // The token for the next page of results. NextToken *string + + // The ID of the site. + SiteId *string } type GetDevicesOutput struct { diff --git a/service/networkmanager/api_op_GetLinkAssociations.go b/service/networkmanager/api_op_GetLinkAssociations.go index 768acd686b3..e0338aa5afc 100644 --- a/service/networkmanager/api_op_GetLinkAssociations.go +++ b/service/networkmanager/api_op_GetLinkAssociations.go @@ -58,11 +58,10 @@ func (c *Client) GetLinkAssociations(ctx context.Context, params *GetLinkAssocia type GetLinkAssociationsInput struct { - // The token for the next page of results. - NextToken *string - - // The maximum number of results to return. - MaxResults *int32 + // The ID of the global network. + // + // This member is required. + GlobalNetworkId *string // The ID of the device. DeviceId *string @@ -70,10 +69,11 @@ type GetLinkAssociationsInput struct { // The ID of the link. LinkId *string - // The ID of the global network. - // - // This member is required. - GlobalNetworkId *string + // The maximum number of results to return. + MaxResults *int32 + + // The token for the next page of results. + NextToken *string } type GetLinkAssociationsOutput struct { diff --git a/service/networkmanager/api_op_GetLinks.go b/service/networkmanager/api_op_GetLinks.go index fe5fc65ccb7..ea126c55909 100644 --- a/service/networkmanager/api_op_GetLinks.go +++ b/service/networkmanager/api_op_GetLinks.go @@ -59,38 +59,38 @@ func (c *Client) GetLinks(ctx context.Context, params *GetLinksInput, optFns ... type GetLinksInput struct { - // The link provider. - Provider *string - - // The ID of the site. - SiteId *string - - // The link type. - Type *string - // The ID of the global network. // // This member is required. GlobalNetworkId *string - // The token for the next page of results. - NextToken *string + // One or more link IDs. The maximum is 10. + LinkIds []*string // The maximum number of results to return. MaxResults *int32 - // One or more link IDs. The maximum is 10. - LinkIds []*string + // The token for the next page of results. + NextToken *string + + // The link provider. + Provider *string + + // The ID of the site. + SiteId *string + + // The link type. + Type *string } type GetLinksOutput struct { - // The token for the next page of results. - NextToken *string - // The links. Links []*types.Link + // The token for the next page of results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/networkmanager/api_op_GetSites.go b/service/networkmanager/api_op_GetSites.go index 88237f50a9e..5d02be63eaa 100644 --- a/service/networkmanager/api_op_GetSites.go +++ b/service/networkmanager/api_op_GetSites.go @@ -57,17 +57,17 @@ func (c *Client) GetSites(ctx context.Context, params *GetSitesInput, optFns ... type GetSitesInput struct { + // The ID of the global network. + // + // This member is required. + GlobalNetworkId *string + // The maximum number of results to return. MaxResults *int32 // The token for the next page of results. NextToken *string - // The ID of the global network. - // - // This member is required. - GlobalNetworkId *string - // One or more site IDs. The maximum is 10. SiteIds []*string } diff --git a/service/networkmanager/api_op_GetTransitGatewayRegistrations.go b/service/networkmanager/api_op_GetTransitGatewayRegistrations.go index 3d29f1efe0c..ffa5d16b758 100644 --- a/service/networkmanager/api_op_GetTransitGatewayRegistrations.go +++ b/service/networkmanager/api_op_GetTransitGatewayRegistrations.go @@ -58,30 +58,30 @@ func (c *Client) GetTransitGatewayRegistrations(ctx context.Context, params *Get type GetTransitGatewayRegistrationsInput struct { - // The maximum number of results to return. - MaxResults *int32 - - // The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is - // 10. - TransitGatewayArns []*string - // The ID of the global network. // // This member is required. GlobalNetworkId *string + // The maximum number of results to return. + MaxResults *int32 + // The token for the next page of results. NextToken *string + + // The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is + // 10. + TransitGatewayArns []*string } type GetTransitGatewayRegistrationsOutput struct { - // The transit gateway registrations. - TransitGatewayRegistrations []*types.TransitGatewayRegistration - // The token for the next page of results. NextToken *string + // The transit gateway registrations. + TransitGatewayRegistrations []*types.TransitGatewayRegistration + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/networkmanager/api_op_RegisterTransitGateway.go b/service/networkmanager/api_op_RegisterTransitGateway.go index 3e0ab76ef4b..10a9dd7bd63 100644 --- a/service/networkmanager/api_op_RegisterTransitGateway.go +++ b/service/networkmanager/api_op_RegisterTransitGateway.go @@ -60,17 +60,17 @@ func (c *Client) RegisterTransitGateway(ctx context.Context, params *RegisterTra type RegisterTransitGatewayInput struct { + // The ID of the global network. + // + // This member is required. + GlobalNetworkId *string + // The Amazon Resource Name (ARN) of the transit gateway. For more information, see // Resources Defined by Amazon EC2 // (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html#amazonec2-resources-for-iam-policies). // // This member is required. TransitGatewayArn *string - - // The ID of the global network. - // - // This member is required. - GlobalNetworkId *string } type RegisterTransitGatewayOutput struct { diff --git a/service/networkmanager/api_op_TagResource.go b/service/networkmanager/api_op_TagResource.go index c9e0795c2c1..bd379627671 100644 --- a/service/networkmanager/api_op_TagResource.go +++ b/service/networkmanager/api_op_TagResource.go @@ -57,15 +57,15 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The tags to apply to the specified resource. + // The Amazon Resource Name (ARN) of the resource. // // This member is required. - Tags []*types.Tag + ResourceArn *string - // The Amazon Resource Name (ARN) of the resource. + // The tags to apply to the specified resource. // // This member is required. - ResourceArn *string + Tags []*types.Tag } type TagResourceOutput struct { diff --git a/service/networkmanager/api_op_UntagResource.go b/service/networkmanager/api_op_UntagResource.go index c6032eece7b..28fc9208cd9 100644 --- a/service/networkmanager/api_op_UntagResource.go +++ b/service/networkmanager/api_op_UntagResource.go @@ -56,15 +56,15 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The tag keys to remove from the specified resource. + // The Amazon Resource Name (ARN) of the resource. // // This member is required. - TagKeys []*string + ResourceArn *string - // The Amazon Resource Name (ARN) of the resource. + // The tag keys to remove from the specified resource. // // This member is required. - ResourceArn *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/networkmanager/api_op_UpdateDevice.go b/service/networkmanager/api_op_UpdateDevice.go index d8ad8c4dc75..79aeec609ac 100644 --- a/service/networkmanager/api_op_UpdateDevice.go +++ b/service/networkmanager/api_op_UpdateDevice.go @@ -58,38 +58,38 @@ func (c *Client) UpdateDevice(ctx context.Context, params *UpdateDeviceInput, op type UpdateDeviceInput struct { - // The serial number of the device. Length Constraints: Maximum length of 128 - // characters. - SerialNumber *string - - // The ID of the site. - SiteId *string - - // The type of the device. - Type *string + // The ID of the device. + // + // This member is required. + DeviceId *string // The ID of the global network. // // This member is required. GlobalNetworkId *string - // The vendor of the device. Length Constraints: Maximum length of 128 characters. - Vendor *string - - // Describes a location. - Location *types.Location - // A description of the device. Length Constraints: Maximum length of 256 // characters. Description *string + // Describes a location. + Location *types.Location + // The model of the device. Length Constraints: Maximum length of 128 characters. Model *string - // The ID of the device. - // - // This member is required. - DeviceId *string + // The serial number of the device. Length Constraints: Maximum length of 128 + // characters. + SerialNumber *string + + // The ID of the site. + SiteId *string + + // The type of the device. + Type *string + + // The vendor of the device. Length Constraints: Maximum length of 128 characters. + Vendor *string } type UpdateDeviceOutput struct { diff --git a/service/networkmanager/api_op_UpdateLink.go b/service/networkmanager/api_op_UpdateLink.go index 111f7a833e7..f2c4bcc0e81 100644 --- a/service/networkmanager/api_op_UpdateLink.go +++ b/service/networkmanager/api_op_UpdateLink.go @@ -58,6 +58,11 @@ func (c *Client) UpdateLink(ctx context.Context, params *UpdateLinkInput, optFns type UpdateLinkInput struct { + // The ID of the global network. + // + // This member is required. + GlobalNetworkId *string + // The ID of the link. // // This member is required. @@ -66,19 +71,14 @@ type UpdateLinkInput struct { // The upload and download speed in Mbps. Bandwidth *types.Bandwidth - // The type of the link. Length Constraints: Maximum length of 128 characters. - Type *string - - // The ID of the global network. - // - // This member is required. - GlobalNetworkId *string + // A description of the link. Length Constraints: Maximum length of 256 characters. + Description *string // The provider of the link. Length Constraints: Maximum length of 128 characters. Provider *string - // A description of the link. Length Constraints: Maximum length of 256 characters. - Description *string + // The type of the link. Length Constraints: Maximum length of 128 characters. + Type *string } type UpdateLinkOutput struct { diff --git a/service/networkmanager/api_op_UpdateSite.go b/service/networkmanager/api_op_UpdateSite.go index f1fc5f09bc2..9e19ecf16bd 100644 --- a/service/networkmanager/api_op_UpdateSite.go +++ b/service/networkmanager/api_op_UpdateSite.go @@ -68,6 +68,10 @@ type UpdateSiteInput struct { // This member is required. SiteId *string + // A description of your site. Length Constraints: Maximum length of 256 + // characters. + Description *string + // The site location: // // * Address: The physical address of the site. @@ -77,10 +81,6 @@ type UpdateSiteInput struct { // // * Longitude: The longitude of the site. Location *types.Location - - // A description of your site. Length Constraints: Maximum length of 256 - // characters. - Description *string } type UpdateSiteOutput struct { diff --git a/service/networkmanager/go.mod b/service/networkmanager/go.mod index 8e131120f30..43f510e8abf 100644 --- a/service/networkmanager/go.mod +++ b/service/networkmanager/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/networkmanager go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/networkmanager/types/types.go b/service/networkmanager/types/types.go index 8e3ff7f6e58..c085bb1bf07 100644 --- a/service/networkmanager/types/types.go +++ b/service/networkmanager/types/types.go @@ -19,20 +19,20 @@ type Bandwidth struct { // Describes the association between a customer gateway, a device, and a link. type CustomerGatewayAssociation struct { - // The association state. - State CustomerGatewayAssociationState + // The Amazon Resource Name (ARN) of the customer gateway. + CustomerGatewayArn *string // The ID of the device. DeviceId *string - // The Amazon Resource Name (ARN) of the customer gateway. - CustomerGatewayArn *string - // The ID of the global network. GlobalNetworkId *string // The ID of the link. LinkId *string + + // The association state. + State CustomerGatewayAssociationState } // Describes a device. @@ -41,68 +41,71 @@ type Device struct { // The date and time that the site was created. CreatedAt *time.Time + // The description of the device. + Description *string + + // The Amazon Resource Name (ARN) of the device. + DeviceArn *string + // The ID of the device. DeviceId *string // The ID of the global network. GlobalNetworkId *string + // The site location. + Location *Location + // The device model. Model *string - // The description of the device. - Description *string - // The device serial number. SerialNumber *string - // The tags for the device. - Tags []*Tag - - // The device type. - Type *string - // The site ID. SiteId *string - // The site location. - Location *Location - // The device state. State DeviceState + // The tags for the device. + Tags []*Tag + + // The device type. + Type *string + // The device vendor. Vendor *string - - // The Amazon Resource Name (ARN) of the device. - DeviceArn *string } // Describes a global network. type GlobalNetwork struct { - // The tags for the global network. - Tags []*Tag - // The date and time that the global network was created. CreatedAt *time.Time - // The ID of the global network. - GlobalNetworkId *string - // The description of the global network. Description *string + // The Amazon Resource Name (ARN) of the global network. + GlobalNetworkArn *string + + // The ID of the global network. + GlobalNetworkId *string + // The state of the global network. State GlobalNetworkState - // The Amazon Resource Name (ARN) of the global network. - GlobalNetworkArn *string + // The tags for the global network. + Tags []*Tag } // Describes a link. type Link struct { + // The bandwidth for the link. + Bandwidth *Bandwidth + // The date and time that the link was created. CreatedAt *time.Time @@ -112,34 +115,34 @@ type Link struct { // The ID of the global network. GlobalNetworkId *string - // The type of the link. - Type *string + // The Amazon Resource Name (ARN) of the link. + LinkArn *string // The ID of the link. LinkId *string + // The provider of the link. + Provider *string + // The ID of the site. SiteId *string - // The provider of the link. - Provider *string + // The state of the link. + State LinkState // The tags for the link. Tags []*Tag - // The bandwidth for the link. - Bandwidth *Bandwidth - - // The Amazon Resource Name (ARN) of the link. - LinkArn *string - - // The state of the link. - State LinkState + // The type of the link. + Type *string } // Describes the association between a device and a link. type LinkAssociation struct { + // The device ID for the link association. + DeviceId *string + // The ID of the global network. GlobalNetworkId *string @@ -148,9 +151,6 @@ type LinkAssociation struct { // The ID of the link. LinkId *string - - // The device ID for the link association. - DeviceId *string } // Describes a location. @@ -159,39 +159,39 @@ type Location struct { // The physical address. Address *string - // The longitude. - Longitude *string - // The latitude. Latitude *string + + // The longitude. + Longitude *string } // Describes a site. type Site struct { - // The state of the site. - State SiteState - - // The location of the site. - Location *Location - // The date and time that the site was created. CreatedAt *time.Time - // The ID of the global network. - GlobalNetworkId *string - // The description of the site. Description *string - // The tags for the site. - Tags []*Tag + // The ID of the global network. + GlobalNetworkId *string + + // The location of the site. + Location *Location // The Amazon Resource Name (ARN) of the site. SiteArn *string // The ID of the site. SiteId *string + + // The state of the site. + State SiteState + + // The tags for the site. + Tags []*Tag } // Describes a tag. @@ -207,24 +207,24 @@ type Tag struct { // Describes the registration of a transit gateway to a global network. type TransitGatewayRegistration struct { + // The ID of the global network. + GlobalNetworkId *string + // The state of the transit gateway registration. State *TransitGatewayRegistrationStateReason // The Amazon Resource Name (ARN) of the transit gateway. TransitGatewayArn *string - - // The ID of the global network. - GlobalNetworkId *string } // Describes the status of a transit gateway registration. type TransitGatewayRegistrationStateReason struct { - // The message for the state reason. - Message *string - // The code for the state reason. Code TransitGatewayRegistrationState + + // The message for the state reason. + Message *string } // Describes a validation exception for a field. diff --git a/service/opsworks/api_op_AttachElasticLoadBalancer.go b/service/opsworks/api_op_AttachElasticLoadBalancer.go index fcf2735eb22..7c171a5cdca 100644 --- a/service/opsworks/api_op_AttachElasticLoadBalancer.go +++ b/service/opsworks/api_op_AttachElasticLoadBalancer.go @@ -69,16 +69,16 @@ func (c *Client) AttachElasticLoadBalancer(ctx context.Context, params *AttachEl type AttachElasticLoadBalancerInput struct { - // The ID of the layer to which the Elastic Load Balancing instance is to be - // attached. + // The Elastic Load Balancing instance's name. // // This member is required. - LayerId *string + ElasticLoadBalancerName *string - // The Elastic Load Balancing instance's name. + // The ID of the layer to which the Elastic Load Balancing instance is to be + // attached. // // This member is required. - ElasticLoadBalancerName *string + LayerId *string } type AttachElasticLoadBalancerOutput struct { diff --git a/service/opsworks/api_op_CloneStack.go b/service/opsworks/api_op_CloneStack.go index 55949dc6390..3e51f4ab0cf 100644 --- a/service/opsworks/api_op_CloneStack.go +++ b/service/opsworks/api_op_CloneStack.go @@ -63,6 +63,26 @@ func (c *Client) CloneStack(ctx context.Context, params *CloneStackInput, optFns type CloneStackInput struct { + // The stack AWS Identity and Access Management (IAM) role, which allows AWS + // OpsWorks Stacks to work with AWS resources on your behalf. You must set this + // parameter to the Amazon Resource Name (ARN) for an existing IAM role. If you + // create a stack by using the AWS OpsWorks Stacks console, it creates the role for + // you. You can obtain an existing stack's IAM ARN programmatically by calling + // DescribePermissions (). For more information about IAM ARNs, see Using + // Identifiers + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). You + // must set this parameter to a valid service role ARN or the action will fail; + // there is no default value. You can specify the source stack's service role ARN, + // if you prefer, but you must do so explicitly. + // + // This member is required. + ServiceRoleArn *string + + // The source stack ID. + // + // This member is required. + SourceStackId *string + // The default AWS OpsWorks Stacks agent version. You have the following options: // // @@ -83,8 +103,55 @@ type CloneStackInput struct { // the stack's default setting. AgentVersion *string - // Whether to use custom cookbooks. - UseCustomCookbooks *bool + // A list of stack attributes and values as key/value pairs to be added to the + // cloned stack. + Attributes map[string]*string + + // A ChefConfiguration object that specifies whether to enable Berkshelf and the + // Berkshelf version on Chef 11.10 stacks. For more information, see Create a New + // Stack + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html). + ChefConfiguration *types.ChefConfiguration + + // A list of source stack app IDs to be included in the cloned stack. + CloneAppIds []*string + + // Whether to clone the source stack's permissions. + ClonePermissions *bool + + // The configuration manager. When you clone a stack we recommend that you use the + // configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux + // stacks, or 12.2 for Windows stacks. The default value for Linux stacks is + // currently 12. + ConfigurationManager *types.StackConfigurationManager + + // Contains the information required to retrieve an app or cookbook from a + // repository. For more information, see Adding Apps + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html) + // or Cookbooks and Recipes + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html). + CustomCookbooksSource *types.Source + + // A string that contains user-defined, custom JSON. It is used to override the + // corresponding default stack configuration JSON values. The string should be in + // the following format: "{\"key1\": \"value1\", \"key2\": \"value2\",...}" For + // more information about custom JSON, see Use Custom JSON to Modify the Stack + // Configuration Attributes + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html) + CustomJson *string + + // The cloned stack's default Availability Zone, which must be in the specified + // region. For more information, see Regions and Endpoints + // (https://docs.aws.amazon.com/general/latest/gr/rande.html). If you also specify + // a value for DefaultSubnetId, the subnet must be in the same zone. For more + // information, see the VpcId parameter description. + DefaultAvailabilityZone *string + + // The Amazon Resource Name (ARN) of an IAM profile that is the default profile for + // all of the stack's EC2 instances. For more information about IAM ARNs, see Using + // Identifiers + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). + DefaultInstanceProfileArn *string // The stack's operating system, which must be set to one of the following. // @@ -120,66 +187,11 @@ type CloneStackInput struct { // cannot change from Linux to Windows or Windows to Linux. DefaultOs *string - // The stack AWS Identity and Access Management (IAM) role, which allows AWS - // OpsWorks Stacks to work with AWS resources on your behalf. You must set this - // parameter to the Amazon Resource Name (ARN) for an existing IAM role. If you - // create a stack by using the AWS OpsWorks Stacks console, it creates the role for - // you. You can obtain an existing stack's IAM ARN programmatically by calling - // DescribePermissions (). For more information about IAM ARNs, see Using - // Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). You - // must set this parameter to a valid service role ARN or the action will fail; - // there is no default value. You can specify the source stack's service role ARN, - // if you prefer, but you must do so explicitly. - // - // This member is required. - ServiceRoleArn *string - - // The Amazon Resource Name (ARN) of an IAM profile that is the default profile for - // all of the stack's EC2 instances. For more information about IAM ARNs, see Using - // Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). - DefaultInstanceProfileArn *string - - // A list of stack attributes and values as key/value pairs to be added to the - // cloned stack. - Attributes map[string]*string - - // Whether to associate the AWS OpsWorks Stacks built-in security groups with the - // stack's layers. AWS OpsWorks Stacks provides a standard set of built-in security - // groups, one for each layer, which are associated with layers by default. With - // UseOpsworksSecurityGroups you can instead provide your own custom security - // groups. UseOpsworksSecurityGroups has the following settings: - // - // * True - AWS - // OpsWorks Stacks automatically associates the appropriate built-in security group - // with each layer (default setting). You can associate additional security groups - // with a layer after you create it but you cannot delete the built-in security - // group. - // - // * False - AWS OpsWorks Stacks does not associate built-in security - // groups with layers. You must create appropriate Amazon Elastic Compute Cloud - // (Amazon EC2) security groups and associate a security group with each layer that - // you create. However, you can still manually associate a built-in security group - // with a layer on creation; custom security groups are required only for those - // layers that need custom settings. - // - // For more information, see Create a New Stack - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html). - UseOpsworksSecurityGroups *bool - - // A string that contains user-defined, custom JSON. It is used to override the - // corresponding default stack configuration JSON values. The string should be in - // the following format: "{\"key1\": \"value1\", \"key2\": \"value2\",...}" For - // more information about custom JSON, see Use Custom JSON to Modify the Stack - // Configuration Attributes - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html) - CustomJson *string - - // The cloned stack AWS region, such as "ap-northeast-2". For more information - // about AWS regions, see Regions and Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/rande.html). - Region *string + // The default root device type. This value is used by default for all instances in + // the cloned stack, but you can override it when you create an instance. For more + // information, see Storage for the Root Device + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device). + DefaultRootDeviceType types.RootDeviceType // A default Amazon EC2 key pair name. The default value is none. If you specify a // key pair name, AWS OpsWorks installs the public key on the instance and you can @@ -201,60 +213,6 @@ type CloneStackInput struct { // parameter description. DefaultSubnetId *string - // Contains the information required to retrieve an app or cookbook from a - // repository. For more information, see Adding Apps - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html) - // or Cookbooks and Recipes - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html). - CustomCookbooksSource *types.Source - - // The configuration manager. When you clone a stack we recommend that you use the - // configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux - // stacks, or 12.2 for Windows stacks. The default value for Linux stacks is - // currently 12. - ConfigurationManager *types.StackConfigurationManager - - // A list of source stack app IDs to be included in the cloned stack. - CloneAppIds []*string - - // The default root device type. This value is used by default for all instances in - // the cloned stack, but you can override it when you create an instance. For more - // information, see Storage for the Root Device - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device). - DefaultRootDeviceType types.RootDeviceType - - // The ID of the VPC that the cloned stack is to be launched into. It must be in - // the specified region. All instances are launched into this VPC, and you cannot - // change the ID later. - // - // * If your account supports EC2 Classic, the default - // value is no VPC. - // - // * If your account does not support EC2 Classic, the - // default value is the default VPC for the specified region. - // - // If the VPC ID - // corresponds to a default VPC and you have specified either the - // DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks - // Stacks infers the value of the other parameter. If you specify neither - // parameter, AWS OpsWorks Stacks sets these parameters to the first valid - // Availability Zone for the specified region and the corresponding default VPC - // subnet ID, respectively. If you specify a nondefault VPC ID, note the - // following: - // - // * It must belong to a VPC in your account that is in the - // specified region. - // - // * You must specify a value for DefaultSubnetId. - // - // For more - // information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack - // in a VPC - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html). - // For more information about default VPC and EC2 Classic, see Supported Platforms - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html). - VpcId *string - // The stack's host name theme, with spaces are replaced by underscores. The theme // is used to generate host names for the stack's instances. By default, // HostnameTheme is set to Layer_Dependent, which creates host names by appending @@ -290,29 +248,71 @@ type CloneStackInput struct { // theme. HostnameTheme *string - // A ChefConfiguration object that specifies whether to enable Berkshelf and the - // Berkshelf version on Chef 11.10 stacks. For more information, see Create a New - // Stack - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html). - ChefConfiguration *types.ChefConfiguration - // The cloned stack name. Name *string - // Whether to clone the source stack's permissions. - ClonePermissions *bool + // The cloned stack AWS region, such as "ap-northeast-2". For more information + // about AWS regions, see Regions and Endpoints + // (https://docs.aws.amazon.com/general/latest/gr/rande.html). + Region *string - // The source stack ID. + // Whether to use custom cookbooks. + UseCustomCookbooks *bool + + // Whether to associate the AWS OpsWorks Stacks built-in security groups with the + // stack's layers. AWS OpsWorks Stacks provides a standard set of built-in security + // groups, one for each layer, which are associated with layers by default. With + // UseOpsworksSecurityGroups you can instead provide your own custom security + // groups. UseOpsworksSecurityGroups has the following settings: // - // This member is required. - SourceStackId *string + // * True - AWS + // OpsWorks Stacks automatically associates the appropriate built-in security group + // with each layer (default setting). You can associate additional security groups + // with a layer after you create it but you cannot delete the built-in security + // group. + // + // * False - AWS OpsWorks Stacks does not associate built-in security + // groups with layers. You must create appropriate Amazon Elastic Compute Cloud + // (Amazon EC2) security groups and associate a security group with each layer that + // you create. However, you can still manually associate a built-in security group + // with a layer on creation; custom security groups are required only for those + // layers that need custom settings. + // + // For more information, see Create a New Stack + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html). + UseOpsworksSecurityGroups *bool - // The cloned stack's default Availability Zone, which must be in the specified - // region. For more information, see Regions and Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/rande.html). If you also specify - // a value for DefaultSubnetId, the subnet must be in the same zone. For more - // information, see the VpcId parameter description. - DefaultAvailabilityZone *string + // The ID of the VPC that the cloned stack is to be launched into. It must be in + // the specified region. All instances are launched into this VPC, and you cannot + // change the ID later. + // + // * If your account supports EC2 Classic, the default + // value is no VPC. + // + // * If your account does not support EC2 Classic, the + // default value is the default VPC for the specified region. + // + // If the VPC ID + // corresponds to a default VPC and you have specified either the + // DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks + // Stacks infers the value of the other parameter. If you specify neither + // parameter, AWS OpsWorks Stacks sets these parameters to the first valid + // Availability Zone for the specified region and the corresponding default VPC + // subnet ID, respectively. If you specify a nondefault VPC ID, note the + // following: + // + // * It must belong to a VPC in your account that is in the + // specified region. + // + // * You must specify a value for DefaultSubnetId. + // + // For more + // information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack + // in a VPC + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html). + // For more information about default VPC and EC2 Classic, see Supported Platforms + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html). + VpcId *string } // Contains the response to a CloneStack request. diff --git a/service/opsworks/api_op_CreateApp.go b/service/opsworks/api_op_CreateApp.go index 5806b49fb71..85a44e9b236 100644 --- a/service/opsworks/api_op_CreateApp.go +++ b/service/opsworks/api_op_CreateApp.go @@ -63,37 +63,15 @@ func (c *Client) CreateApp(ctx context.Context, params *CreateAppInput, optFns . type CreateAppInput struct { - // An SslConfiguration object with the SSL configuration. - SslConfiguration *types.SslConfiguration - - // The app's short name. - Shortname *string - - // An array of EnvironmentVariable objects that specify environment variables to be - // associated with the app. After you deploy the app, these variables are defined - // on the associated app server instance. For more information, see Environment - // Variables - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment). - // There is no specific limit on the number of environment variables. However, the - // size of the associated data structure - which includes the variables' names, - // values, and protected flag values - cannot exceed 20 KB. This limit should - // accommodate most if not all use cases. Exceeding it will cause an exception with - // the message, "Environment: is too large (maximum is 20KB)." If you have - // specified one or more environment variables, you cannot modify the stack's Chef - // version. - Environment []*types.EnvironmentVariable - - // One or more user-defined key/value pairs to be added to the stack attributes. - Attributes map[string]*string - - // A Source object that specifies the app repository. - AppSource *types.Source - - // A description of the app. - Description *string + // The app name. + // + // This member is required. + Name *string - // The app's data source. - DataSources []*types.DataSource + // The stack ID. + // + // This member is required. + StackId *string // The app type. Each supported type is associated with a particular layer. For // example, PHP applications are associated with a PHP layer. AWS OpsWorks Stacks @@ -104,22 +82,44 @@ type CreateAppInput struct { // This member is required. Type types.AppType + // A Source object that specifies the app repository. + AppSource *types.Source + + // One or more user-defined key/value pairs to be added to the stack attributes. + Attributes map[string]*string + + // The app's data source. + DataSources []*types.DataSource + + // A description of the app. + Description *string + // The app virtual host settings, with multiple domains separated by commas. For // example: 'www.example.com, example.com' Domains []*string - // The stack ID. - // - // This member is required. - StackId *string - - // The app name. - // - // This member is required. - Name *string - // Whether to enable SSL for the app. EnableSsl *bool + + // An array of EnvironmentVariable objects that specify environment variables to be + // associated with the app. After you deploy the app, these variables are defined + // on the associated app server instance. For more information, see Environment + // Variables + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment). + // There is no specific limit on the number of environment variables. However, the + // size of the associated data structure - which includes the variables' names, + // values, and protected flag values - cannot exceed 20 KB. This limit should + // accommodate most if not all use cases. Exceeding it will cause an exception with + // the message, "Environment: is too large (maximum is 20KB)." If you have + // specified one or more environment variables, you cannot modify the stack's Chef + // version. + Environment []*types.EnvironmentVariable + + // The app's short name. + Shortname *string + + // An SslConfiguration object with the SSL configuration. + SslConfiguration *types.SslConfiguration } // Contains the response to a CreateApp request. diff --git a/service/opsworks/api_op_CreateDeployment.go b/service/opsworks/api_op_CreateDeployment.go index 3221d45c423..64a11adb366 100644 --- a/service/opsworks/api_op_CreateDeployment.go +++ b/service/opsworks/api_op_CreateDeployment.go @@ -65,14 +65,17 @@ func (c *Client) CreateDeployment(ctx context.Context, params *CreateDeploymentI type CreateDeploymentInput struct { + // A DeploymentCommand object that specifies the deployment command and any + // associated arguments. + // + // This member is required. + Command *types.DeploymentCommand + // The stack ID. // // This member is required. StackId *string - // The instance IDs for the deployment targets. - InstanceIds []*string - // The app ID. This parameter is required for app deployments, but not for other // deployment commands. AppId *string @@ -90,11 +93,8 @@ type CreateDeploymentInput struct { // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html). CustomJson *string - // A DeploymentCommand object that specifies the deployment command and any - // associated arguments. - // - // This member is required. - Command *types.DeploymentCommand + // The instance IDs for the deployment targets. + InstanceIds []*string // The layer IDs for the deployment targets. LayerIds []*string diff --git a/service/opsworks/api_op_CreateInstance.go b/service/opsworks/api_op_CreateInstance.go index 97de14640a5..c7199a3c083 100644 --- a/service/opsworks/api_op_CreateInstance.go +++ b/service/opsworks/api_op_CreateInstance.go @@ -64,25 +64,85 @@ func (c *Client) CreateInstance(ctx context.Context, params *CreateInstanceInput type CreateInstanceInput struct { + // The instance type, such as t2.micro. For a list of supported instance types, + // open the stack in the console, choose Instances, and choose + Instance. The Size + // list contains the currently supported types. For more information, see Instance + // Families and Types + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html). The + // parameter values that you use to specify the various types are in the API Name + // column of the Available Instance Types table. + // + // This member is required. + InstanceType *string + + // An array that contains the instance's layer IDs. + // + // This member is required. + LayerIds []*string + // The stack ID. // // This member is required. StackId *string + // The default AWS OpsWorks Stacks agent version. You have the following options: + // + // + // * INHERIT - Use the stack's default agent version setting. + // + // * version_number + // - Use the specified agent version. This value overrides the stack's default + // setting. To update the agent version, edit the instance configuration and + // specify a new version. AWS OpsWorks Stacks then automatically installs that + // version on the instance. + // + // The default setting is INHERIT. To specify an agent + // version, you must use the complete version number, not the abbreviated number + // shown on the console. For a list of available agent version numbers, call + // DescribeAgentVersions (). AgentVersion cannot be set to Chef 12.2. + AgentVersion *string + + // A custom AMI ID to be used to create the instance. The AMI should be based on + // one of the supported operating systems. For more information, see Using Custom + // AMIs + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html). + // If you specify a custom AMI, you must set Os to Custom. + AmiId *string + + // The instance architecture. The default option is x86_64. Instance types do not + // necessarily support both architectures. For a list of the architectures that are + // supported by the different instance types, see Instance Families and Types + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html). + Architecture types.Architecture + + // For load-based or time-based instances, the type. Windows stacks can use only + // time-based instances. + AutoScalingType types.AutoScalingType + + // The instance Availability Zone. For more information, see Regions and Endpoints + // (https://docs.aws.amazon.com/general/latest/gr/rande.html). + AvailabilityZone *string + // An array of BlockDeviceMapping objects that specify the instance's block // devices. For more information, see Block Device Mapping // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html). // Note that block device mappings are not supported for custom AMIs. BlockDeviceMappings []*types.BlockDeviceMapping - // The ID of the instance's subnet. If the stack is running in a VPC, you can use - // this parameter to override the stack's default subnet ID value and direct AWS - // OpsWorks Stacks to launch the instance in a different subnet. - SubnetId *string + // Whether to create an Amazon EBS-optimized instance. + EbsOptimized *bool - // For load-based or time-based instances, the type. Windows stacks can use only - // time-based instances. - AutoScalingType types.AutoScalingType + // The instance host name. + Hostname *string + + // Whether to install operating system and package updates when the instance boots. + // The default value is true. To control when updates are installed, set this value + // to false. You must then update your instances manually by using CreateDeployment + // () to run the update_dependencies stack command or by manually running yum + // (Amazon Linux) or apt-get (Ubuntu) on the instances. We strongly recommend using + // the default value of true to ensure that your instances have the latest security + // updates. + InstallUpdatesOnBoot *bool // The instance's operating system, which must be set to one of the following. // @@ -129,6 +189,11 @@ type CreateInstanceInput struct { // The instance's Amazon EC2 key-pair name. SshKeyName *string + // The ID of the instance's subnet. If the stack is running in a VPC, you can use + // this parameter to override the stack's default subnet ID value and direct AWS + // OpsWorks Stacks to launch the instance in a different subnet. + SubnetId *string + // The instance's tenancy option. The default option is no tenancy, or if the // instance is running in a VPC, inherit tenancy settings from the VPC. The // following are valid values for this parameter: dedicated, default, or host. @@ -143,73 +208,8 @@ type CreateInstanceInput struct { // (http://aws.amazon.com/ec2/purchasing-options/dedicated-instances/). Tenancy *string - // The instance type, such as t2.micro. For a list of supported instance types, - // open the stack in the console, choose Instances, and choose + Instance. The Size - // list contains the currently supported types. For more information, see Instance - // Families and Types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html). The - // parameter values that you use to specify the various types are in the API Name - // column of the Available Instance Types table. - // - // This member is required. - InstanceType *string - - // An array that contains the instance's layer IDs. - // - // This member is required. - LayerIds []*string - - // A custom AMI ID to be used to create the instance. The AMI should be based on - // one of the supported operating systems. For more information, see Using Custom - // AMIs - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html). - // If you specify a custom AMI, you must set Os to Custom. - AmiId *string - - // Whether to install operating system and package updates when the instance boots. - // The default value is true. To control when updates are installed, set this value - // to false. You must then update your instances manually by using CreateDeployment - // () to run the update_dependencies stack command or by manually running yum - // (Amazon Linux) or apt-get (Ubuntu) on the instances. We strongly recommend using - // the default value of true to ensure that your instances have the latest security - // updates. - InstallUpdatesOnBoot *bool - - // The instance Availability Zone. For more information, see Regions and Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/rande.html). - AvailabilityZone *string - // The instance's virtualization type, paravirtual or hvm. VirtualizationType *string - - // The default AWS OpsWorks Stacks agent version. You have the following options: - // - // - // * INHERIT - Use the stack's default agent version setting. - // - // * version_number - // - Use the specified agent version. This value overrides the stack's default - // setting. To update the agent version, edit the instance configuration and - // specify a new version. AWS OpsWorks Stacks then automatically installs that - // version on the instance. - // - // The default setting is INHERIT. To specify an agent - // version, you must use the complete version number, not the abbreviated number - // shown on the console. For a list of available agent version numbers, call - // DescribeAgentVersions (). AgentVersion cannot be set to Chef 12.2. - AgentVersion *string - - // The instance architecture. The default option is x86_64. Instance types do not - // necessarily support both architectures. For a list of the architectures that are - // supported by the different instance types, see Instance Families and Types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html). - Architecture types.Architecture - - // Whether to create an Amazon EBS-optimized instance. - EbsOptimized *bool - - // The instance host name. - Hostname *string } // Contains the response to a CreateInstance request. diff --git a/service/opsworks/api_op_CreateLayer.go b/service/opsworks/api_op_CreateLayer.go index 1b92bf1cd07..3ef4201afec 100644 --- a/service/opsworks/api_op_CreateLayer.go +++ b/service/opsworks/api_op_CreateLayer.go @@ -68,27 +68,6 @@ func (c *Client) CreateLayer(ctx context.Context, params *CreateLayerInput, optF type CreateLayerInput struct { - // Whether to use Amazon EBS-optimized instances. - UseEbsOptimizedInstances *bool - - // The ARN of an IAM profile to be used for the layer's EC2 instances. For more - // information about IAM ARNs, see Using Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). - CustomInstanceProfileArn *string - - // Whether to disable auto healing for the layer. - EnableAutoHealing *bool - - // A LifeCycleEventConfiguration object that you can use to configure the Shutdown - // event to specify an execution timeout and enable or disable Elastic Load - // Balancer connection draining. - LifecycleEventConfiguration *types.LifecycleEventConfiguration - - // The layer stack ID. - // - // This member is required. - StackId *string - // The layer name, which is used by the console. // // This member is required. @@ -105,21 +84,21 @@ type CreateLayerInput struct { // This member is required. Shortname *string - // Whether to install operating system and package updates when the instance boots. - // The default value is true. To control when updates are installed, set this value - // to false. You must then update your instances manually by using CreateDeployment - // () to run the update_dependencies stack command or by manually running yum - // (Amazon Linux) or apt-get (Ubuntu) on the instances. To ensure that your - // instances have the latest security updates, we strongly recommend using the - // default value of true. - InstallUpdatesOnBoot *bool + // The layer stack ID. + // + // This member is required. + StackId *string - // Specifies CloudWatch Logs configuration options for the layer. For more - // information, see CloudWatchLogsLogStream (). - CloudWatchLogsConfiguration *types.CloudWatchLogsConfiguration + // The layer type. A stack cannot have more than one built-in layer of the same + // type. It can have any number of custom layers. Built-in layers are not available + // in Chef 12 stacks. + // + // This member is required. + Type types.LayerType - // An array of Package objects that describes the layer packages. - Packages []*string + // One or more user-defined key-value pairs to be added to the stack attributes. To + // create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN. + Attributes map[string]*string // Whether to automatically assign an Elastic IP address // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) @@ -127,15 +106,20 @@ type CreateLayerInput struct { // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html). AutoAssignElasticIps *bool - // An array containing the layer custom security group IDs. - CustomSecurityGroupIds []*string + // For stacks that are running in a VPC, whether to automatically assign a public + // IP address to the layer's instances. For more information, see How to Edit a + // Layer + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html). + AutoAssignPublicIps *bool - // The layer type. A stack cannot have more than one built-in layer of the same - // type. It can have any number of custom layers. Built-in layers are not available - // in Chef 12 stacks. - // - // This member is required. - Type types.LayerType + // Specifies CloudWatch Logs configuration options for the layer. For more + // information, see CloudWatchLogsLogStream (). + CloudWatchLogsConfiguration *types.CloudWatchLogsConfiguration + + // The ARN of an IAM profile to be used for the layer's EC2 instances. For more + // information about IAM ARNs, see Using Identifiers + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). + CustomInstanceProfileArn *string // A JSON-formatted string containing custom stack configuration and deployment // attributes to be installed on the layer's instances. For more information, see @@ -147,18 +131,34 @@ type CreateLayerInput struct { // A LayerCustomRecipes object that specifies the layer custom recipes. CustomRecipes *types.Recipes - // A VolumeConfigurations object that describes the layer's Amazon EBS volumes. - VolumeConfigurations []*types.VolumeConfiguration + // An array containing the layer custom security group IDs. + CustomSecurityGroupIds []*string - // For stacks that are running in a VPC, whether to automatically assign a public - // IP address to the layer's instances. For more information, see How to Edit a - // Layer - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html). - AutoAssignPublicIps *bool + // Whether to disable auto healing for the layer. + EnableAutoHealing *bool - // One or more user-defined key-value pairs to be added to the stack attributes. To - // create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN. - Attributes map[string]*string + // Whether to install operating system and package updates when the instance boots. + // The default value is true. To control when updates are installed, set this value + // to false. You must then update your instances manually by using CreateDeployment + // () to run the update_dependencies stack command or by manually running yum + // (Amazon Linux) or apt-get (Ubuntu) on the instances. To ensure that your + // instances have the latest security updates, we strongly recommend using the + // default value of true. + InstallUpdatesOnBoot *bool + + // A LifeCycleEventConfiguration object that you can use to configure the Shutdown + // event to specify an execution timeout and enable or disable Elastic Load + // Balancer connection draining. + LifecycleEventConfiguration *types.LifecycleEventConfiguration + + // An array of Package objects that describes the layer packages. + Packages []*string + + // Whether to use Amazon EBS-optimized instances. + UseEbsOptimizedInstances *bool + + // A VolumeConfigurations object that describes the layer's Amazon EBS volumes. + VolumeConfigurations []*types.VolumeConfiguration } // Contains the response to a CreateLayer request. diff --git a/service/opsworks/api_op_CreateStack.go b/service/opsworks/api_op_CreateStack.go index 1729554f694..12b05433213 100644 --- a/service/opsworks/api_op_CreateStack.go +++ b/service/opsworks/api_op_CreateStack.go @@ -62,8 +62,39 @@ func (c *Client) CreateStack(ctx context.Context, params *CreateStackInput, optF type CreateStackInput struct { - // Whether the stack uses custom cookbooks. - UseCustomCookbooks *bool + // The Amazon Resource Name (ARN) of an IAM profile that is the default profile for + // all of the stack's EC2 instances. For more information about IAM ARNs, see Using + // Identifiers + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). + // + // This member is required. + DefaultInstanceProfileArn *string + + // The stack name. + // + // This member is required. + Name *string + + // The stack's AWS region, such as ap-south-1. For more information about Amazon + // regions, see Regions and Endpoints + // (https://docs.aws.amazon.com/general/latest/gr/rande.html). In the AWS CLI, this + // API maps to the --stack-region parameter. If the --stack-region parameter and + // the AWS CLI common parameter --region are set to the same value, the stack uses + // a regional endpoint. If the --stack-region parameter is not set, but the AWS CLI + // --region parameter is, this also results in a stack with a regional endpoint. + // However, if the --region parameter is set to us-east-1, and the --stack-region + // parameter is set to one of the following, then the stack uses a legacy or + // classic region: us-west-1, us-west-2, sa-east-1, eu-central-1, eu-west-1, + // ap-northeast-1, ap-southeast-1, ap-southeast-2. In this case, the actual API + // endpoint of the stack is in us-east-1. Only the preceding regions are supported + // as classic regions in the us-east-1 API endpoint. Because it is a best practice + // to choose the regional endpoint that is closest to where you manage AWS, we + // recommend that you use regional endpoints for new stacks. The AWS CLI common + // --region parameter always specifies a regional API endpoint; it cannot be used + // to specify a classic AWS OpsWorks Stacks region. + // + // This member is required. + Region *string // The stack's AWS Identity and Access Management (IAM) role, which allows AWS // OpsWorks Stacks to work with AWS resources on your behalf. You must set this @@ -94,60 +125,27 @@ type CreateStackInput struct { // create or update an instance, which overrides the stack's default setting. AgentVersion *string - // Whether to associate the AWS OpsWorks Stacks built-in security groups with the - // stack's layers. AWS OpsWorks Stacks provides a standard set of built-in security - // groups, one for each layer, which are associated with layers by default. With - // UseOpsworksSecurityGroups you can instead provide your own custom security - // groups. UseOpsworksSecurityGroups has the following settings: - // - // * True - AWS - // OpsWorks Stacks automatically associates the appropriate built-in security group - // with each layer (default setting). You can associate additional security groups - // with a layer after you create it, but you cannot delete the built-in security - // group. - // - // * False - AWS OpsWorks Stacks does not associate built-in security - // groups with layers. You must create appropriate EC2 security groups and - // associate a security group with each layer that you create. However, you can - // still manually associate a built-in security group with a layer on creation; - // custom security groups are required only for those layers that need custom - // settings. - // - // For more information, see Create a New Stack - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html). - UseOpsworksSecurityGroups *bool - - // The Amazon Resource Name (ARN) of an IAM profile that is the default profile for - // all of the stack's EC2 instances. For more information about IAM ARNs, see Using - // Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). - // - // This member is required. - DefaultInstanceProfileArn *string - // One or more user-defined key-value pairs to be added to the stack attributes. Attributes map[string]*string - // The stack's AWS region, such as ap-south-1. For more information about Amazon - // regions, see Regions and Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/rande.html). In the AWS CLI, this - // API maps to the --stack-region parameter. If the --stack-region parameter and - // the AWS CLI common parameter --region are set to the same value, the stack uses - // a regional endpoint. If the --stack-region parameter is not set, but the AWS CLI - // --region parameter is, this also results in a stack with a regional endpoint. - // However, if the --region parameter is set to us-east-1, and the --stack-region - // parameter is set to one of the following, then the stack uses a legacy or - // classic region: us-west-1, us-west-2, sa-east-1, eu-central-1, eu-west-1, - // ap-northeast-1, ap-southeast-1, ap-southeast-2. In this case, the actual API - // endpoint of the stack is in us-east-1. Only the preceding regions are supported - // as classic regions in the us-east-1 API endpoint. Because it is a best practice - // to choose the regional endpoint that is closest to where you manage AWS, we - // recommend that you use regional endpoints for new stacks. The AWS CLI common - // --region parameter always specifies a regional API endpoint; it cannot be used - // to specify a classic AWS OpsWorks Stacks region. - // - // This member is required. - Region *string + // A ChefConfiguration object that specifies whether to enable Berkshelf and the + // Berkshelf version on Chef 11.10 stacks. For more information, see Create a New + // Stack + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html). + ChefConfiguration *types.ChefConfiguration + + // The configuration manager. When you create a stack we recommend that you use the + // configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux + // stacks, or 12.2 for Windows stacks. The default value for Linux stacks is + // currently 12. + ConfigurationManager *types.StackConfigurationManager + + // Contains the information required to retrieve an app or cookbook from a + // repository. For more information, see Adding Apps + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html) + // or Cookbooks and Recipes + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html). + CustomCookbooksSource *types.Source // A string that contains user-defined, custom JSON. It can be used to override the // corresponding default stack configuration attribute values or to pass data to @@ -157,6 +155,52 @@ type CreateStackInput struct { // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html). CustomJson *string + // The stack's default Availability Zone, which must be in the specified region. + // For more information, see Regions and Endpoints + // (https://docs.aws.amazon.com/general/latest/gr/rande.html). If you also specify + // a value for DefaultSubnetId, the subnet must be in the same zone. For more + // information, see the VpcId parameter description. + DefaultAvailabilityZone *string + + // The stack's default operating system, which is installed on every instance + // unless you specify a different operating system when you create the instance. + // You can specify one of the following. + // + // * A supported Linux operating system: + // An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, + // Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux + // 2015.09, or Amazon Linux 2015.03. + // + // * A supported Ubuntu operating system, + // such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS. + // + // * CentOS + // Linux 7 + // + // * Red Hat Enterprise Linux 7 + // + // * A supported Windows operating + // system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server + // 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL + // Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web. + // + // * + // A custom AMI: Custom. You specify the custom AMI you want to use when you create + // instances. For more information, see Using Custom AMIs + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html). + // + // The + // default option is the current Amazon Linux version. For more information about + // supported operating systems, see AWS OpsWorks Stacks Operating Systems + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html). + DefaultOs *string + + // The default root device type. This value is the default for all instances in the + // stack, but you can override it when you create an instance. The default option + // is instance-store. For more information, see Storage for the Root Device + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device). + DefaultRootDeviceType types.RootDeviceType + // A default Amazon EC2 key pair name. The default value is none. If you specify a // key pair name, AWS OpsWorks installs the public key on the instance and you can // use the private key with an SSH client to log in to the instance. For more @@ -177,56 +221,6 @@ type CreateStackInput struct { // parameter description. DefaultSubnetId *string - // Contains the information required to retrieve an app or cookbook from a - // repository. For more information, see Adding Apps - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html) - // or Cookbooks and Recipes - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html). - CustomCookbooksSource *types.Source - - // The configuration manager. When you create a stack we recommend that you use the - // configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux - // stacks, or 12.2 for Windows stacks. The default value for Linux stacks is - // currently 12. - ConfigurationManager *types.StackConfigurationManager - - // The default root device type. This value is the default for all instances in the - // stack, but you can override it when you create an instance. The default option - // is instance-store. For more information, see Storage for the Root Device - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device). - DefaultRootDeviceType types.RootDeviceType - - // The ID of the VPC that the stack is to be launched into. The VPC must be in the - // stack's region. All instances are launched into this VPC. You cannot change the - // ID later. - // - // * If your account supports EC2-Classic, the default value is no - // VPC. - // - // * If your account does not support EC2-Classic, the default value is - // the default VPC for the specified region. - // - // If the VPC ID corresponds to a - // default VPC and you have specified either the DefaultAvailabilityZone or the - // DefaultSubnetId parameter only, AWS OpsWorks Stacks infers the value of the - // other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets - // these parameters to the first valid Availability Zone for the specified region - // and the corresponding default VPC subnet ID, respectively. If you specify a - // nondefault VPC ID, note the following: - // - // * It must belong to a VPC in your - // account that is in the specified region. - // - // * You must specify a value for - // DefaultSubnetId. - // - // For more information about how to use AWS OpsWorks Stacks with - // a VPC, see Running a Stack in a VPC - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html). - // For more information about default VPC and EC2-Classic, see Supported Platforms - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html). - VpcId *string - // The stack's host name theme, with spaces replaced by underscores. The theme is // used to generate host names for the stack's instances. By default, HostnameTheme // is set to Layer_Dependent, which creates host names by appending integers to the @@ -262,56 +256,62 @@ type CreateStackInput struct { // theme. HostnameTheme *string - // The stack name. - // - // This member is required. - Name *string + // Whether the stack uses custom cookbooks. + UseCustomCookbooks *bool - // A ChefConfiguration object that specifies whether to enable Berkshelf and the - // Berkshelf version on Chef 11.10 stacks. For more information, see Create a New - // Stack + // Whether to associate the AWS OpsWorks Stacks built-in security groups with the + // stack's layers. AWS OpsWorks Stacks provides a standard set of built-in security + // groups, one for each layer, which are associated with layers by default. With + // UseOpsworksSecurityGroups you can instead provide your own custom security + // groups. UseOpsworksSecurityGroups has the following settings: + // + // * True - AWS + // OpsWorks Stacks automatically associates the appropriate built-in security group + // with each layer (default setting). You can associate additional security groups + // with a layer after you create it, but you cannot delete the built-in security + // group. + // + // * False - AWS OpsWorks Stacks does not associate built-in security + // groups with layers. You must create appropriate EC2 security groups and + // associate a security group with each layer that you create. However, you can + // still manually associate a built-in security group with a layer on creation; + // custom security groups are required only for those layers that need custom + // settings. + // + // For more information, see Create a New Stack // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html). - ChefConfiguration *types.ChefConfiguration + UseOpsworksSecurityGroups *bool - // The stack's default operating system, which is installed on every instance - // unless you specify a different operating system when you create the instance. - // You can specify one of the following. - // - // * A supported Linux operating system: - // An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, - // Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux - // 2015.09, or Amazon Linux 2015.03. + // The ID of the VPC that the stack is to be launched into. The VPC must be in the + // stack's region. All instances are launched into this VPC. You cannot change the + // ID later. // - // * A supported Ubuntu operating system, - // such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS. + // * If your account supports EC2-Classic, the default value is no + // VPC. // - // * CentOS - // Linux 7 + // * If your account does not support EC2-Classic, the default value is + // the default VPC for the specified region. // - // * Red Hat Enterprise Linux 7 + // If the VPC ID corresponds to a + // default VPC and you have specified either the DefaultAvailabilityZone or the + // DefaultSubnetId parameter only, AWS OpsWorks Stacks infers the value of the + // other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets + // these parameters to the first valid Availability Zone for the specified region + // and the corresponding default VPC subnet ID, respectively. If you specify a + // nondefault VPC ID, note the following: // - // * A supported Windows operating - // system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server - // 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL - // Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web. + // * It must belong to a VPC in your + // account that is in the specified region. // - // * - // A custom AMI: Custom. You specify the custom AMI you want to use when you create - // instances. For more information, see Using Custom AMIs - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html). + // * You must specify a value for + // DefaultSubnetId. // - // The - // default option is the current Amazon Linux version. For more information about - // supported operating systems, see AWS OpsWorks Stacks Operating Systems - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html). - DefaultOs *string - - // The stack's default Availability Zone, which must be in the specified region. - // For more information, see Regions and Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/rande.html). If you also specify - // a value for DefaultSubnetId, the subnet must be in the same zone. For more - // information, see the VpcId parameter description. - DefaultAvailabilityZone *string + // For more information about how to use AWS OpsWorks Stacks with + // a VPC, see Running a Stack in a VPC + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html). + // For more information about default VPC and EC2-Classic, see Supported Platforms + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html). + VpcId *string } // Contains the response to a CreateStack request. diff --git a/service/opsworks/api_op_CreateUserProfile.go b/service/opsworks/api_op_CreateUserProfile.go index 7ca39de95da..105d16e3bb9 100644 --- a/service/opsworks/api_op_CreateUserProfile.go +++ b/service/opsworks/api_op_CreateUserProfile.go @@ -59,13 +59,6 @@ func (c *Client) CreateUserProfile(ctx context.Context, params *CreateUserProfil type CreateUserProfileInput struct { - // The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', - // and '_'. If the specified name includes other punctuation marks, AWS OpsWorks - // Stacks removes them. For example, my.name will be changed to myname. If you do - // not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM - // user name. - SshUsername *string - // The user's IAM ARN; this can also be a federated user's ARN. // // This member is required. @@ -78,6 +71,13 @@ type CreateUserProfileInput struct { // The user's public SSH key. SshPublicKey *string + + // The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', + // and '_'. If the specified name includes other punctuation marks, AWS OpsWorks + // Stacks removes them. For example, my.name will be changed to myname. If you do + // not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM + // user name. + SshUsername *string } // Contains the response to a CreateUserProfile request. diff --git a/service/opsworks/api_op_DescribeApps.go b/service/opsworks/api_op_DescribeApps.go index d022728c86c..5d79b9cd28d 100644 --- a/service/opsworks/api_op_DescribeApps.go +++ b/service/opsworks/api_op_DescribeApps.go @@ -61,14 +61,14 @@ func (c *Client) DescribeApps(ctx context.Context, params *DescribeAppsInput, op type DescribeAppsInput struct { - // The app stack ID. If you use this parameter, DescribeApps returns a description - // of the apps in the specified stack. - StackId *string - // An array of app IDs for the apps to be described. If you use this parameter, // DescribeApps returns a description of the specified apps. Otherwise, it returns // a description of every app. AppIds []*string + + // The app stack ID. If you use this parameter, DescribeApps returns a description + // of the apps in the specified stack. + StackId *string } // Contains the response to a DescribeApps request. diff --git a/service/opsworks/api_op_DescribeCommands.go b/service/opsworks/api_op_DescribeCommands.go index 52a347a644b..44aaddef7db 100644 --- a/service/opsworks/api_op_DescribeCommands.go +++ b/service/opsworks/api_op_DescribeCommands.go @@ -61,6 +61,11 @@ func (c *Client) DescribeCommands(ctx context.Context, params *DescribeCommandsI type DescribeCommandsInput struct { + // An array of command IDs. If you include this parameter, DescribeCommands returns + // a description of the specified commands. Otherwise, it returns a description of + // every command. + CommandIds []*string + // The deployment ID. If you include this parameter, DescribeCommands returns a // description of the commands associated with the specified deployment. DeploymentId *string @@ -68,11 +73,6 @@ type DescribeCommandsInput struct { // The instance ID. If you include this parameter, DescribeCommands returns a // description of the commands associated with the specified instance. InstanceId *string - - // An array of command IDs. If you include this parameter, DescribeCommands returns - // a description of the specified commands. Otherwise, it returns a description of - // every command. - CommandIds []*string } // Contains the response to a DescribeCommands request. diff --git a/service/opsworks/api_op_DescribeDeployments.go b/service/opsworks/api_op_DescribeDeployments.go index cfe34d0920b..37a4561467f 100644 --- a/service/opsworks/api_op_DescribeDeployments.go +++ b/service/opsworks/api_op_DescribeDeployments.go @@ -65,14 +65,14 @@ type DescribeDeploymentsInput struct { // the commands associated with the specified app. AppId *string - // The stack ID. If you include this parameter, the command returns a description - // of the commands associated with the specified stack. - StackId *string - // An array of deployment IDs to be described. If you include this parameter, the // command returns a description of the specified deployments. Otherwise, it // returns a description of every deployment. DeploymentIds []*string + + // The stack ID. If you include this parameter, the command returns a description + // of the commands associated with the specified stack. + StackId *string } // Contains the response to a DescribeDeployments request. diff --git a/service/opsworks/api_op_DescribeEcsClusters.go b/service/opsworks/api_op_DescribeEcsClusters.go index 642b4d51444..1337c8f90a6 100644 --- a/service/opsworks/api_op_DescribeEcsClusters.go +++ b/service/opsworks/api_op_DescribeEcsClusters.go @@ -67,6 +67,12 @@ type DescribeEcsClustersInput struct { // A list of ARNs, one for each cluster to be described. EcsClusterArns []*string + // To receive a paginated response, use this parameter to specify the maximum + // number of results to be returned with a single call. If the number of available + // results exceeds this maximum, the response includes a NextToken value that you + // can assign to the NextToken request parameter to get the next set of results. + MaxResults *int32 + // If the previous paginated request did not return all of the remaining results, // the response object'sNextToken parameter value is set to a token. To retrieve // the next set of results, call DescribeEcsClusters again and assign that token to @@ -77,12 +83,6 @@ type DescribeEcsClustersInput struct { // A stack ID. DescribeEcsClusters returns a description of the cluster that is // registered with the stack. StackId *string - - // To receive a paginated response, use this parameter to specify the maximum - // number of results to be returned with a single call. If the number of available - // results exceeds this maximum, the response includes a NextToken value that you - // can assign to the NextToken request parameter to get the next set of results. - MaxResults *int32 } // Contains the response to a DescribeEcsClusters request. diff --git a/service/opsworks/api_op_DescribeElasticIps.go b/service/opsworks/api_op_DescribeElasticIps.go index a1f71f470b8..294924695c2 100644 --- a/service/opsworks/api_op_DescribeElasticIps.go +++ b/service/opsworks/api_op_DescribeElasticIps.go @@ -62,19 +62,19 @@ func (c *Client) DescribeElasticIps(ctx context.Context, params *DescribeElastic type DescribeElasticIpsInput struct { - // A stack ID. If you include this parameter, DescribeElasticIps returns a - // description of the Elastic IP addresses that are registered with the specified - // stack. - StackId *string + // The instance ID. If you include this parameter, DescribeElasticIps returns a + // description of the Elastic IP addresses associated with the specified instance. + InstanceId *string // An array of Elastic IP addresses to be described. If you include this parameter, // DescribeElasticIps returns a description of the specified Elastic IP addresses. // Otherwise, it returns a description of every Elastic IP address. Ips []*string - // The instance ID. If you include this parameter, DescribeElasticIps returns a - // description of the Elastic IP addresses associated with the specified instance. - InstanceId *string + // A stack ID. If you include this parameter, DescribeElasticIps returns a + // description of the Elastic IP addresses that are registered with the specified + // stack. + StackId *string } // Contains the response to a DescribeElasticIps request. diff --git a/service/opsworks/api_op_DescribeElasticLoadBalancers.go b/service/opsworks/api_op_DescribeElasticLoadBalancers.go index c14ec138342..1774f55fb2c 100644 --- a/service/opsworks/api_op_DescribeElasticLoadBalancers.go +++ b/service/opsworks/api_op_DescribeElasticLoadBalancers.go @@ -61,12 +61,12 @@ func (c *Client) DescribeElasticLoadBalancers(ctx context.Context, params *Descr type DescribeElasticLoadBalancersInput struct { - // A stack ID. The action describes the stack's Elastic Load Balancing instances. - StackId *string - // A list of layer IDs. The action describes the Elastic Load Balancing instances // for the specified layers. LayerIds []*string + + // A stack ID. The action describes the stack's Elastic Load Balancing instances. + StackId *string } // Contains the response to a DescribeElasticLoadBalancers request. diff --git a/service/opsworks/api_op_DescribeInstances.go b/service/opsworks/api_op_DescribeInstances.go index 2da4b8297c4..47440b33bcb 100644 --- a/service/opsworks/api_op_DescribeInstances.go +++ b/service/opsworks/api_op_DescribeInstances.go @@ -61,15 +61,15 @@ func (c *Client) DescribeInstances(ctx context.Context, params *DescribeInstance type DescribeInstancesInput struct { - // A layer ID. If you use this parameter, DescribeInstances returns descriptions of - // the instances associated with the specified layer. - LayerId *string - // An array of instance IDs to be described. If you use this parameter, // DescribeInstances returns a description of the specified instances. Otherwise, // it returns a description of every instance. InstanceIds []*string + // A layer ID. If you use this parameter, DescribeInstances returns descriptions of + // the instances associated with the specified layer. + LayerId *string + // A stack ID. If you use this parameter, DescribeInstances returns descriptions of // the instances associated with the specified stack. StackId *string diff --git a/service/opsworks/api_op_DescribeLayers.go b/service/opsworks/api_op_DescribeLayers.go index aecde34b166..2556aa2d1ee 100644 --- a/service/opsworks/api_op_DescribeLayers.go +++ b/service/opsworks/api_op_DescribeLayers.go @@ -61,13 +61,13 @@ func (c *Client) DescribeLayers(ctx context.Context, params *DescribeLayersInput type DescribeLayersInput struct { - // The stack ID. - StackId *string - // An array of layer IDs that specify the layers to be described. If you omit this // parameter, DescribeLayers returns a description of every layer in the specified // stack. LayerIds []*string + + // The stack ID. + StackId *string } // Contains the response to a DescribeLayers request. diff --git a/service/opsworks/api_op_DescribeRaidArrays.go b/service/opsworks/api_op_DescribeRaidArrays.go index b0eead133a1..2949736b708 100644 --- a/service/opsworks/api_op_DescribeRaidArrays.go +++ b/service/opsworks/api_op_DescribeRaidArrays.go @@ -61,15 +61,15 @@ func (c *Client) DescribeRaidArrays(ctx context.Context, params *DescribeRaidArr type DescribeRaidArraysInput struct { + // The instance ID. If you use this parameter, DescribeRaidArrays returns + // descriptions of the RAID arrays associated with the specified instance. + InstanceId *string + // An array of RAID array IDs. If you use this parameter, DescribeRaidArrays // returns descriptions of the specified arrays. Otherwise, it returns a // description of every array. RaidArrayIds []*string - // The instance ID. If you use this parameter, DescribeRaidArrays returns - // descriptions of the RAID arrays associated with the specified instance. - InstanceId *string - // The stack ID. StackId *string } diff --git a/service/opsworks/api_op_DescribeServiceErrors.go b/service/opsworks/api_op_DescribeServiceErrors.go index 8f180f49e6d..d2a2cef4793 100644 --- a/service/opsworks/api_op_DescribeServiceErrors.go +++ b/service/opsworks/api_op_DescribeServiceErrors.go @@ -61,6 +61,10 @@ func (c *Client) DescribeServiceErrors(ctx context.Context, params *DescribeServ type DescribeServiceErrorsInput struct { + // The instance ID. If you use this parameter, DescribeServiceErrors returns + // descriptions of the errors associated with the specified instance. + InstanceId *string + // An array of service error IDs. If you use this parameter, DescribeServiceErrors // returns descriptions of the specified errors. Otherwise, it returns a // description of every error. @@ -69,10 +73,6 @@ type DescribeServiceErrorsInput struct { // The stack ID. If you use this parameter, DescribeServiceErrors returns // descriptions of the errors associated with the specified stack. StackId *string - - // The instance ID. If you use this parameter, DescribeServiceErrors returns - // descriptions of the errors associated with the specified instance. - InstanceId *string } // Contains the response to a DescribeServiceErrors request. diff --git a/service/opsworks/api_op_DescribeVolumes.go b/service/opsworks/api_op_DescribeVolumes.go index cf3b8e3fb40..b56a8e5316e 100644 --- a/service/opsworks/api_op_DescribeVolumes.go +++ b/service/opsworks/api_op_DescribeVolumes.go @@ -61,6 +61,14 @@ func (c *Client) DescribeVolumes(ctx context.Context, params *DescribeVolumesInp type DescribeVolumesInput struct { + // The instance ID. If you use this parameter, DescribeVolumes returns descriptions + // of the volumes associated with the specified instance. + InstanceId *string + + // The RAID array ID. If you use this parameter, DescribeVolumes returns + // descriptions of the volumes associated with the specified RAID array. + RaidArrayId *string + // A stack ID. The action describes the stack's registered Amazon EBS volumes. StackId *string @@ -68,14 +76,6 @@ type DescribeVolumesInput struct { // descriptions of the specified volumes. Otherwise, it returns a description of // every volume. VolumeIds []*string - - // The RAID array ID. If you use this parameter, DescribeVolumes returns - // descriptions of the volumes associated with the specified RAID array. - RaidArrayId *string - - // The instance ID. If you use this parameter, DescribeVolumes returns descriptions - // of the volumes associated with the specified instance. - InstanceId *string } // Contains the response to a DescribeVolumes request. diff --git a/service/opsworks/api_op_DetachElasticLoadBalancer.go b/service/opsworks/api_op_DetachElasticLoadBalancer.go index 12408354546..0ed25b38ddd 100644 --- a/service/opsworks/api_op_DetachElasticLoadBalancer.go +++ b/service/opsworks/api_op_DetachElasticLoadBalancer.go @@ -60,15 +60,15 @@ func (c *Client) DetachElasticLoadBalancer(ctx context.Context, params *DetachEl type DetachElasticLoadBalancerInput struct { - // The ID of the layer that the Elastic Load Balancing instance is attached to. + // The Elastic Load Balancing instance's name. // // This member is required. - LayerId *string + ElasticLoadBalancerName *string - // The Elastic Load Balancing instance's name. + // The ID of the layer that the Elastic Load Balancing instance is attached to. // // This member is required. - ElasticLoadBalancerName *string + LayerId *string } type DetachElasticLoadBalancerOutput struct { diff --git a/service/opsworks/api_op_GetHostnameSuggestion.go b/service/opsworks/api_op_GetHostnameSuggestion.go index ac8fc6fda46..67039b9a1e8 100644 --- a/service/opsworks/api_op_GetHostnameSuggestion.go +++ b/service/opsworks/api_op_GetHostnameSuggestion.go @@ -70,12 +70,12 @@ type GetHostnameSuggestionInput struct { // Contains the response to a GetHostnameSuggestion request. type GetHostnameSuggestionOutput struct { - // The layer ID. - LayerId *string - // The generated host name. Hostname *string + // The layer ID. + LayerId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/opsworks/api_op_ListTags.go b/service/opsworks/api_op_ListTags.go index bcd6411d1ea..cab329dc574 100644 --- a/service/opsworks/api_op_ListTags.go +++ b/service/opsworks/api_op_ListTags.go @@ -61,28 +61,28 @@ type ListTagsInput struct { // This member is required. ResourceArn *string - // Do not use. A validation exception occurs if you add a NextToken parameter to a - // ListTagsRequest call. - NextToken *string - // Do not use. A validation exception occurs if you add a MaxResults parameter to a // ListTagsRequest call. MaxResults *int32 + + // Do not use. A validation exception occurs if you add a NextToken parameter to a + // ListTagsRequest call. + NextToken *string } // Contains the response to a ListTags request. type ListTagsOutput struct { - // A set of key-value pairs that contain tag keys and tag values that are attached - // to a stack or layer. - Tags map[string]*string - // If a paginated request does not return all of the remaining results, this // parameter is set to a token that you can assign to the request object's // NextToken parameter to get the next set of results. If the previous paginated // request returned all of the remaining results, this parameter is set to null. NextToken *string + // A set of key-value pairs that contain tag keys and tag values that are attached + // to a stack or layer. + Tags map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/opsworks/api_op_RegisterInstance.go b/service/opsworks/api_op_RegisterInstance.go index da92bdce3c1..bde01edc7ac 100644 --- a/service/opsworks/api_op_RegisterInstance.go +++ b/service/opsworks/api_op_RegisterInstance.go @@ -75,16 +75,6 @@ func (c *Client) RegisterInstance(ctx context.Context, params *RegisterInstanceI type RegisterInstanceInput struct { - // The instances public RSA key. This key is used to encrypt communication between - // the instance and the service. - RsaPublicKey *string - - // The instance's private IP address. - PrivateIp *string - - // The instances public RSA key fingerprint. - RsaPublicKeyFingerprint *string - // The ID of the stack that the instance is to be registered with. // // This member is required. @@ -96,8 +86,18 @@ type RegisterInstanceInput struct { // An InstanceIdentity object that contains the instance's identity. InstanceIdentity *types.InstanceIdentity + // The instance's private IP address. + PrivateIp *string + // The instance's public IP address. PublicIp *string + + // The instances public RSA key. This key is used to encrypt communication between + // the instance and the service. + RsaPublicKey *string + + // The instances public RSA key fingerprint. + RsaPublicKeyFingerprint *string } // Contains the response to a RegisterInstanceResult request. diff --git a/service/opsworks/api_op_RegisterRdsDbInstance.go b/service/opsworks/api_op_RegisterRdsDbInstance.go index 9693cd6d98c..5c14b1e030c 100644 --- a/service/opsworks/api_op_RegisterRdsDbInstance.go +++ b/service/opsworks/api_op_RegisterRdsDbInstance.go @@ -60,11 +60,6 @@ func (c *Client) RegisterRdsDbInstance(ctx context.Context, params *RegisterRdsD type RegisterRdsDbInstanceInput struct { - // The Amazon RDS instance's ARN. - // - // This member is required. - RdsDbInstanceArn *string - // The database password. // // This member is required. @@ -75,6 +70,11 @@ type RegisterRdsDbInstanceInput struct { // This member is required. DbUser *string + // The Amazon RDS instance's ARN. + // + // This member is required. + RdsDbInstanceArn *string + // The stack ID. // // This member is required. diff --git a/service/opsworks/api_op_SetLoadBasedAutoScaling.go b/service/opsworks/api_op_SetLoadBasedAutoScaling.go index 90ad340f0d8..bc2aa768161 100644 --- a/service/opsworks/api_op_SetLoadBasedAutoScaling.go +++ b/service/opsworks/api_op_SetLoadBasedAutoScaling.go @@ -67,23 +67,23 @@ func (c *Client) SetLoadBasedAutoScaling(ctx context.Context, params *SetLoadBas type SetLoadBasedAutoScalingInput struct { - // An AutoScalingThresholds object with the upscaling threshold configuration. If - // the load exceeds these thresholds for a specified amount of time, AWS OpsWorks - // Stacks starts a specified number of instances. - UpScaling *types.AutoScalingThresholds - // The layer ID. // // This member is required. LayerId *string - // Enables load-based auto scaling for the layer. - Enable *bool - // An AutoScalingThresholds object with the downscaling threshold configuration. If // the load falls below these thresholds for a specified amount of time, AWS // OpsWorks Stacks stops a specified number of instances. DownScaling *types.AutoScalingThresholds + + // Enables load-based auto scaling for the layer. + Enable *bool + + // An AutoScalingThresholds object with the upscaling threshold configuration. If + // the load exceeds these thresholds for a specified amount of time, AWS OpsWorks + // Stacks starts a specified number of instances. + UpScaling *types.AutoScalingThresholds } type SetLoadBasedAutoScalingOutput struct { diff --git a/service/opsworks/api_op_SetPermission.go b/service/opsworks/api_op_SetPermission.go index a637f21bd55..ef3018db8d4 100644 --- a/service/opsworks/api_op_SetPermission.go +++ b/service/opsworks/api_op_SetPermission.go @@ -68,14 +68,14 @@ type SetPermissionInput struct { // This member is required. IamUserArn *string - // The user is allowed to use SSH to communicate with the instance. - AllowSsh *bool - // The stack ID. // // This member is required. StackId *string + // The user is allowed to use SSH to communicate with the instance. + AllowSsh *bool + // The user is allowed to use sudo to elevate privileges. AllowSudo *bool diff --git a/service/opsworks/api_op_UntagResource.go b/service/opsworks/api_op_UntagResource.go index 1c5bc0490bf..f6fba80f2cc 100644 --- a/service/opsworks/api_op_UntagResource.go +++ b/service/opsworks/api_op_UntagResource.go @@ -56,15 +56,15 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // A list of the keys of tags to be removed from a stack or layer. + // The stack or layer's Amazon Resource Number (ARN). // // This member is required. - TagKeys []*string + ResourceArn *string - // The stack or layer's Amazon Resource Number (ARN). + // A list of the keys of tags to be removed from a stack or layer. // // This member is required. - ResourceArn *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/opsworks/api_op_UpdateApp.go b/service/opsworks/api_op_UpdateApp.go index c03c4a66509..e832e92afa3 100644 --- a/service/opsworks/api_op_UpdateApp.go +++ b/service/opsworks/api_op_UpdateApp.go @@ -61,9 +61,30 @@ func (c *Client) UpdateApp(ctx context.Context, params *UpdateAppInput, optFns . type UpdateAppInput struct { + // The app ID. + // + // This member is required. + AppId *string + // A Source object that specifies the app repository. AppSource *types.Source + // One or more user-defined key/value pairs to be added to the stack attributes. + Attributes map[string]*string + + // The app's data sources. + DataSources []*types.DataSource + + // A description of the app. + Description *string + + // The app's virtual host settings, with multiple domains separated by commas. For + // example: 'www.example.com, example.com' + Domains []*string + + // Whether SSL is enabled for the app. + EnableSsl *bool + // An array of EnvironmentVariable objects that specify environment variables to be // associated with the app. After you deploy the app, these variables are defined // on the associated app server instances.For more information, see Environment @@ -78,35 +99,14 @@ type UpdateAppInput struct { // version. Environment []*types.EnvironmentVariable - // One or more user-defined key/value pairs to be added to the stack attributes. - Attributes map[string]*string - - // Whether SSL is enabled for the app. - EnableSsl *bool - // The app name. Name *string - // The app type. - Type types.AppType - - // The app's data sources. - DataSources []*types.DataSource - - // The app ID. - // - // This member is required. - AppId *string - - // The app's virtual host settings, with multiple domains separated by commas. For - // example: 'www.example.com, example.com' - Domains []*string - - // A description of the app. - Description *string - // An SslConfiguration object with the SSL configuration. SslConfiguration *types.SslConfiguration + + // The app type. + Type types.AppType } type UpdateAppOutput struct { diff --git a/service/opsworks/api_op_UpdateElasticIp.go b/service/opsworks/api_op_UpdateElasticIp.go index 933f639d1d5..f6614986d91 100644 --- a/service/opsworks/api_op_UpdateElasticIp.go +++ b/service/opsworks/api_op_UpdateElasticIp.go @@ -62,13 +62,13 @@ func (c *Client) UpdateElasticIp(ctx context.Context, params *UpdateElasticIpInp type UpdateElasticIpInput struct { - // The new name. - Name *string - // The IP address for which you want to update the name. // // This member is required. ElasticIp *string + + // The new name. + Name *string } type UpdateElasticIpOutput struct { diff --git a/service/opsworks/api_op_UpdateInstance.go b/service/opsworks/api_op_UpdateInstance.go index 532a5009cf8..c1b00460539 100644 --- a/service/opsworks/api_op_UpdateInstance.go +++ b/service/opsworks/api_op_UpdateInstance.go @@ -66,25 +66,6 @@ type UpdateInstanceInput struct { // This member is required. InstanceId *string - // For load-based or time-based instances, the type. Windows stacks can use only - // time-based instances. - AutoScalingType types.AutoScalingType - - // The instance architecture. Instance types do not necessarily support both - // architectures. For a list of the architectures that are supported by the - // different instance types, see Instance Families and Types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html). - Architecture types.Architecture - - // The instance type, such as t2.micro. For a list of supported instance types, - // open the stack in the console, choose Instances, and choose + Instance. The Size - // list contains the currently supported types. For more information, see Instance - // Families and Types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html). The - // parameter values that you use to specify the various types are in the API Name - // column of the Available Instance Types table. - InstanceType *string - // The default AWS OpsWorks Stacks agent version. You have the following options: // // @@ -102,6 +83,28 @@ type UpdateInstanceInput struct { // DescribeAgentVersions (). AgentVersion cannot be set to Chef 12.2. AgentVersion *string + // The ID of the AMI that was used to create the instance. The value of this + // parameter must be the same AMI ID that the instance is already using. You cannot + // apply a new AMI to an instance by running UpdateInstance. UpdateInstance does + // not work on instances that are using custom AMIs. + AmiId *string + + // The instance architecture. Instance types do not necessarily support both + // architectures. For a list of the architectures that are supported by the + // different instance types, see Instance Families and Types + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html). + Architecture types.Architecture + + // For load-based or time-based instances, the type. Windows stacks can use only + // time-based instances. + AutoScalingType types.AutoScalingType + + // This property cannot be updated. + EbsOptimized *bool + + // The instance host name. + Hostname *string + // Whether to install operating system and package updates when the instance boots. // The default value is true. To control when updates are installed, set this value // to false. You must then update your instances manually by using CreateDeployment @@ -111,21 +114,18 @@ type UpdateInstanceInput struct { // security updates. InstallUpdatesOnBoot *bool - // The instance host name. - Hostname *string - - // This property cannot be updated. - EbsOptimized *bool + // The instance type, such as t2.micro. For a list of supported instance types, + // open the stack in the console, choose Instances, and choose + Instance. The Size + // list contains the currently supported types. For more information, see Instance + // Families and Types + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html). The + // parameter values that you use to specify the various types are in the API Name + // column of the Available Instance Types table. + InstanceType *string // The instance's layer IDs. LayerIds []*string - // The ID of the AMI that was used to create the instance. The value of this - // parameter must be the same AMI ID that the instance is already using. You cannot - // apply a new AMI to an instance by running UpdateInstance. UpdateInstance does - // not work on instances that are using custom AMIs. - AmiId *string - // The instance's operating system, which must be set to one of the following. You // cannot update an instance that is using a custom AMI. // diff --git a/service/opsworks/api_op_UpdateLayer.go b/service/opsworks/api_op_UpdateLayer.go index cc5b6048e67..82af19c3c8f 100644 --- a/service/opsworks/api_op_UpdateLayer.go +++ b/service/opsworks/api_op_UpdateLayer.go @@ -61,16 +61,19 @@ func (c *Client) UpdateLayer(ctx context.Context, params *UpdateLayerInput, optF type UpdateLayerInput struct { + // The layer ID. // - LifecycleEventConfiguration *types.LifecycleEventConfiguration + // This member is required. + LayerId *string - // The ARN of an IAM profile to be used for all of the layer's EC2 instances. For - // more information about IAM ARNs, see Using Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). - CustomInstanceProfileArn *string + // One or more user-defined key/value pairs to be added to the stack attributes. + Attributes map[string]*string - // The layer name, which is used by the console. - Name *string + // Whether to automatically assign an Elastic IP address + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) + // to the layer's instances. For more information, see How to Edit a Layer + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html). + AutoAssignElasticIps *bool // For stacks that are running in a VPC, whether to automatically assign a public // IP address to the layer's instances. For more information, see How to Edit a @@ -78,27 +81,29 @@ type UpdateLayerInput struct { // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html). AutoAssignPublicIps *bool - // For custom layers only, use this parameter to specify the layer's short name, - // which is used internally by AWS OpsWorks Stacks and by Chef. The short name is - // also used as the name for the directory where your app files are installed. It - // can have a maximum of 200 characters and must be in the following format: - // /\A[a-z0-9\-\_\.]+\Z/. The built-in layers' short names are defined by AWS - // OpsWorks Stacks. For more information, see the Layer Reference - // (https://docs.aws.amazon.com/opsworks/latest/userguide/layers.html) - Shortname *string - - // Whether to disable auto healing for the layer. - EnableAutoHealing *bool - - // An array of Package objects that describe the layer's packages. - Packages []*string - // Specifies CloudWatch Logs configuration options for the layer. For more // information, see CloudWatchLogsLogStream (). CloudWatchLogsConfiguration *types.CloudWatchLogsConfiguration - // Whether to use Amazon EBS-optimized instances. - UseEbsOptimizedInstances *bool + // The ARN of an IAM profile to be used for all of the layer's EC2 instances. For + // more information about IAM ARNs, see Using Identifiers + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). + CustomInstanceProfileArn *string + + // A JSON-formatted string containing custom stack configuration and deployment + // attributes to be installed on the layer's instances. For more information, see + // Using Custom JSON + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html). + CustomJson *string + + // A LayerCustomRecipes object that specifies the layer's custom recipes. + CustomRecipes *types.Recipes + + // An array containing the layer's custom security group IDs. + CustomSecurityGroupIds []*string + + // Whether to disable auto healing for the layer. + EnableAutoHealing *bool // Whether to install operating system and package updates when the instance boots. // The default value is true. To control when updates are installed, set this value @@ -109,34 +114,29 @@ type UpdateLayerInput struct { // updates. InstallUpdatesOnBoot *bool - // One or more user-defined key/value pairs to be added to the stack attributes. - Attributes map[string]*string - - // A VolumeConfigurations object that describes the layer's Amazon EBS volumes. - VolumeConfigurations []*types.VolumeConfiguration + // + LifecycleEventConfiguration *types.LifecycleEventConfiguration - // Whether to automatically assign an Elastic IP address - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) - // to the layer's instances. For more information, see How to Edit a Layer - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html). - AutoAssignElasticIps *bool + // The layer name, which is used by the console. + Name *string - // The layer ID. - // - // This member is required. - LayerId *string + // An array of Package objects that describe the layer's packages. + Packages []*string - // An array containing the layer's custom security group IDs. - CustomSecurityGroupIds []*string + // For custom layers only, use this parameter to specify the layer's short name, + // which is used internally by AWS OpsWorks Stacks and by Chef. The short name is + // also used as the name for the directory where your app files are installed. It + // can have a maximum of 200 characters and must be in the following format: + // /\A[a-z0-9\-\_\.]+\Z/. The built-in layers' short names are defined by AWS + // OpsWorks Stacks. For more information, see the Layer Reference + // (https://docs.aws.amazon.com/opsworks/latest/userguide/layers.html) + Shortname *string - // A JSON-formatted string containing custom stack configuration and deployment - // attributes to be installed on the layer's instances. For more information, see - // Using Custom JSON - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html). - CustomJson *string + // Whether to use Amazon EBS-optimized instances. + UseEbsOptimizedInstances *bool - // A LayerCustomRecipes object that specifies the layer's custom recipes. - CustomRecipes *types.Recipes + // A VolumeConfigurations object that describes the layer's Amazon EBS volumes. + VolumeConfigurations []*types.VolumeConfiguration } type UpdateLayerOutput struct { diff --git a/service/opsworks/api_op_UpdateRdsDbInstance.go b/service/opsworks/api_op_UpdateRdsDbInstance.go index fc2b7c92ed0..f2da3a1412c 100644 --- a/service/opsworks/api_op_UpdateRdsDbInstance.go +++ b/service/opsworks/api_op_UpdateRdsDbInstance.go @@ -65,11 +65,11 @@ type UpdateRdsDbInstanceInput struct { // This member is required. RdsDbInstanceArn *string - // The master user name. - DbUser *string - // The database password. DbPassword *string + + // The master user name. + DbUser *string } type UpdateRdsDbInstanceOutput struct { diff --git a/service/opsworks/api_op_UpdateStack.go b/service/opsworks/api_op_UpdateStack.go index 3997465ada7..3f902edccd9 100644 --- a/service/opsworks/api_op_UpdateStack.go +++ b/service/opsworks/api_op_UpdateStack.go @@ -61,75 +61,10 @@ func (c *Client) UpdateStack(ctx context.Context, params *UpdateStackInput, optF type UpdateStackInput struct { - // Whether to associate the AWS OpsWorks Stacks built-in security groups with the - // stack's layers. AWS OpsWorks Stacks provides a standard set of built-in security - // groups, one for each layer, which are associated with layers by default. - // UseOpsworksSecurityGroups allows you to provide your own custom security groups - // instead of using the built-in groups. UseOpsworksSecurityGroups has the - // following settings: - // - // * True - AWS OpsWorks Stacks automatically associates - // the appropriate built-in security group with each layer (default setting). You - // can associate additional security groups with a layer after you create it, but - // you cannot delete the built-in security group. - // - // * False - AWS OpsWorks - // Stacks does not associate built-in security groups with layers. You must create - // appropriate EC2 security groups and associate a security group with each layer - // that you create. However, you can still manually associate a built-in security - // group with a layer on. Custom security groups are required only for those layers - // that need custom settings. - // - // For more information, see Create a New Stack - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html). - UseOpsworksSecurityGroups *bool - - // The stack's default Availability Zone, which must be in the stack's region. For - // more information, see Regions and Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/rande.html). If you also specify - // a value for DefaultSubnetId, the subnet must be in the same zone. For more - // information, see CreateStack (). - DefaultAvailabilityZone *string - - // The ARN of an IAM profile that is the default profile for all of the stack's EC2 - // instances. For more information about IAM ARNs, see Using Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). - DefaultInstanceProfileArn *string - - // The stack's new host name theme, with spaces replaced by underscores. The theme - // is used to generate host names for the stack's instances. By default, - // HostnameTheme is set to Layer_Dependent, which creates host names by appending - // integers to the layer's short name. The other themes are: - // - // * Baked_Goods - // - // - // * Clouds - // - // * Europe_Cities - // - // * Fruits - // - // * Greek_Deities_and_Titans - // - // - // * Legendary_creatures_from_Japan - // - // * Planets_and_Moons - // - // * Roman_Deities - // - // - // * Scottish_Islands - // - // * US_Cities - // - // * Wild_Cats + // The stack ID. // - // To obtain a generated host - // name, call GetHostNameSuggestion, which returns a host name based on the current - // theme. - HostnameTheme *string + // This member is required. + StackId *string // The default AWS OpsWorks Stacks agent version. You have the following options: // @@ -151,33 +86,14 @@ type UpdateStackInput struct { // the stack's default setting. AgentVersion *string - // Whether the stack uses custom cookbooks. - UseCustomCookbooks *bool - - // A default Amazon EC2 key-pair name. The default value is none. If you specify a - // key-pair name, AWS OpsWorks Stacks installs the public key on the instance and - // you can use the private key with an SSH client to log in to the instance. For - // more information, see Using SSH to Communicate with an Instance - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html) - // and Managing SSH Access - // (https://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html). - // You can override this setting by specifying a different key pair, or no key - // pair, when you create an instance - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html). - DefaultSshKeyName *string - - // The stack ID. - // - // This member is required. - StackId *string + // One or more user-defined key-value pairs to be added to the stack attributes. + Attributes map[string]*string - // The stack's default VPC subnet ID. This parameter is required if you specify a - // value for the VpcId parameter. All instances are launched into this subnet - // unless you specify otherwise when you create the instance. If you also specify a - // value for DefaultAvailabilityZone, the subnet must be in that zone. For - // information on default values and when this parameter is required, see the VpcId - // parameter description. - DefaultSubnetId *string + // A ChefConfiguration object that specifies whether to enable Berkshelf and the + // Berkshelf version on Chef 11.10 stacks. For more information, see Create a New + // Stack + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html). + ChefConfiguration *types.ChefConfiguration // The configuration manager. When you update a stack, we recommend that you use // the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for @@ -185,20 +101,6 @@ type UpdateStackInput struct { // currently 12. ConfigurationManager *types.StackConfigurationManager - // A string that contains user-defined, custom JSON. It can be used to override the - // corresponding default stack configuration JSON values or to pass data to - // recipes. The string should be in the following format: "{\"key1\": \"value1\", - // \"key2\": \"value2\",...}" For more information about custom JSON, see Use - // Custom JSON to Modify the Stack Configuration Attributes - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html). - CustomJson *string - - // The default root device type. This value is used by default for all instances in - // the stack, but you can override it when you create an instance. For more - // information, see Storage for the Root Device - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device). - DefaultRootDeviceType types.RootDeviceType - // Contains the information required to retrieve an app or cookbook from a // repository. For more information, see Adding Apps // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html) @@ -206,20 +108,25 @@ type UpdateStackInput struct { // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html). CustomCookbooksSource *types.Source - // A ChefConfiguration object that specifies whether to enable Berkshelf and the - // Berkshelf version on Chef 11.10 stacks. For more information, see Create a New - // Stack - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html). - ChefConfiguration *types.ChefConfiguration - - // One or more user-defined key-value pairs to be added to the stack attributes. - Attributes map[string]*string + // A string that contains user-defined, custom JSON. It can be used to override the + // corresponding default stack configuration JSON values or to pass data to + // recipes. The string should be in the following format: "{\"key1\": \"value1\", + // \"key2\": \"value2\",...}" For more information about custom JSON, see Use + // Custom JSON to Modify the Stack Configuration Attributes + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html). + CustomJson *string - // Do not use this parameter. You cannot update a stack's service role. - ServiceRoleArn *string + // The stack's default Availability Zone, which must be in the stack's region. For + // more information, see Regions and Endpoints + // (https://docs.aws.amazon.com/general/latest/gr/rande.html). If you also specify + // a value for DefaultSubnetId, the subnet must be in the same zone. For more + // information, see CreateStack (). + DefaultAvailabilityZone *string - // The stack's new name. - Name *string + // The ARN of an IAM profile that is the default profile for all of the stack's EC2 + // instances. For more information about IAM ARNs, see Using Identifiers + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). + DefaultInstanceProfileArn *string // The stack's operating system, which must be set to one of the following: // @@ -252,6 +159,99 @@ type UpdateStackInput struct { // about supported operating systems, see AWS OpsWorks Stacks Operating Systems // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html). DefaultOs *string + + // The default root device type. This value is used by default for all instances in + // the stack, but you can override it when you create an instance. For more + // information, see Storage for the Root Device + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device). + DefaultRootDeviceType types.RootDeviceType + + // A default Amazon EC2 key-pair name. The default value is none. If you specify a + // key-pair name, AWS OpsWorks Stacks installs the public key on the instance and + // you can use the private key with an SSH client to log in to the instance. For + // more information, see Using SSH to Communicate with an Instance + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html) + // and Managing SSH Access + // (https://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html). + // You can override this setting by specifying a different key pair, or no key + // pair, when you create an instance + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html). + DefaultSshKeyName *string + + // The stack's default VPC subnet ID. This parameter is required if you specify a + // value for the VpcId parameter. All instances are launched into this subnet + // unless you specify otherwise when you create the instance. If you also specify a + // value for DefaultAvailabilityZone, the subnet must be in that zone. For + // information on default values and when this parameter is required, see the VpcId + // parameter description. + DefaultSubnetId *string + + // The stack's new host name theme, with spaces replaced by underscores. The theme + // is used to generate host names for the stack's instances. By default, + // HostnameTheme is set to Layer_Dependent, which creates host names by appending + // integers to the layer's short name. The other themes are: + // + // * Baked_Goods + // + // + // * Clouds + // + // * Europe_Cities + // + // * Fruits + // + // * Greek_Deities_and_Titans + // + // + // * Legendary_creatures_from_Japan + // + // * Planets_and_Moons + // + // * Roman_Deities + // + // + // * Scottish_Islands + // + // * US_Cities + // + // * Wild_Cats + // + // To obtain a generated host + // name, call GetHostNameSuggestion, which returns a host name based on the current + // theme. + HostnameTheme *string + + // The stack's new name. + Name *string + + // Do not use this parameter. You cannot update a stack's service role. + ServiceRoleArn *string + + // Whether the stack uses custom cookbooks. + UseCustomCookbooks *bool + + // Whether to associate the AWS OpsWorks Stacks built-in security groups with the + // stack's layers. AWS OpsWorks Stacks provides a standard set of built-in security + // groups, one for each layer, which are associated with layers by default. + // UseOpsworksSecurityGroups allows you to provide your own custom security groups + // instead of using the built-in groups. UseOpsworksSecurityGroups has the + // following settings: + // + // * True - AWS OpsWorks Stacks automatically associates + // the appropriate built-in security group with each layer (default setting). You + // can associate additional security groups with a layer after you create it, but + // you cannot delete the built-in security group. + // + // * False - AWS OpsWorks + // Stacks does not associate built-in security groups with layers. You must create + // appropriate EC2 security groups and associate a security group with each layer + // that you create. However, you can still manually associate a built-in security + // group with a layer on. Custom security groups are required only for those layers + // that need custom settings. + // + // For more information, see Create a New Stack + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html). + UseOpsworksSecurityGroups *bool } type UpdateStackOutput struct { diff --git a/service/opsworks/api_op_UpdateUserProfile.go b/service/opsworks/api_op_UpdateUserProfile.go index 82542fd572b..f0a893b19b2 100644 --- a/service/opsworks/api_op_UpdateUserProfile.go +++ b/service/opsworks/api_op_UpdateUserProfile.go @@ -59,25 +59,25 @@ func (c *Client) UpdateUserProfile(ctx context.Context, params *UpdateUserProfil type UpdateUserProfileInput struct { - // The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', - // and '_'. If the specified name includes other punctuation marks, AWS OpsWorks - // Stacks removes them. For example, my.name will be changed to myname. If you do - // not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM - // user name. - SshUsername *string + // The user IAM ARN. This can also be a federated user's ARN. + // + // This member is required. + IamUserArn *string // Whether users can specify their own SSH public key through the My Settings page. // For more information, see Managing User Permissions // (https://docs.aws.amazon.com/opsworks/latest/userguide/security-settingsshkey.html). AllowSelfManagement *bool - // The user IAM ARN. This can also be a federated user's ARN. - // - // This member is required. - IamUserArn *string - // The user's new SSH public key. SshPublicKey *string + + // The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', + // and '_'. If the specified name includes other punctuation marks, AWS OpsWorks + // Stacks removes them. For example, my.name will be changed to myname. If you do + // not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM + // user name. + SshUsername *string } type UpdateUserProfileOutput struct { diff --git a/service/opsworks/api_op_UpdateVolume.go b/service/opsworks/api_op_UpdateVolume.go index f66355fd768..5f126a43042 100644 --- a/service/opsworks/api_op_UpdateVolume.go +++ b/service/opsworks/api_op_UpdateVolume.go @@ -62,14 +62,14 @@ func (c *Client) UpdateVolume(ctx context.Context, params *UpdateVolumeInput, op type UpdateVolumeInput struct { - // The new mount point. - MountPoint *string - // The volume ID. // // This member is required. VolumeId *string + // The new mount point. + MountPoint *string + // The new name. Name *string } diff --git a/service/opsworks/go.mod b/service/opsworks/go.mod index b9a263bcb63..b30b2ff2fcb 100644 --- a/service/opsworks/go.mod +++ b/service/opsworks/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/opsworks go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/opsworks/types/types.go b/service/opsworks/types/types.go index 030d62f792a..ad108704f8d 100644 --- a/service/opsworks/types/types.go +++ b/service/opsworks/types/types.go @@ -5,42 +5,40 @@ package types // Describes an agent version. type AgentVersion struct { - // The agent version. - Version *string - // The configuration manager. ConfigurationManager *StackConfigurationManager + + // The agent version. + Version *string } // A description of the app. type App struct { - // Whether to enable SSL for the app. - EnableSsl *bool + // The app ID. + AppId *string + + // A Source object that describes the app repository. + AppSource *Source + + // The stack attributes. + Attributes map[string]*string // When the app was created. CreatedAt *string + // The app's data sources. + DataSources []*DataSource + // A description of the app. Description *string - // The app ID. - AppId *string - - // The app stack ID. - StackId *string - - // The app type. - Type AppType - - // The app's short name. - Shortname *string - - // An SslConfiguration object with the SSL configuration. - SslConfiguration *SslConfiguration + // The app vhost settings with multiple domains separated by commas. For example: + // 'www.example.com, example.com' + Domains []*string - // A Source object that describes the app repository. - AppSource *Source + // Whether to enable SSL for the app. + EnableSsl *bool // An array of EnvironmentVariable objects that specify environment variables to be // associated with the app. After you deploy the app, these variables are defined @@ -55,18 +53,20 @@ type App struct { // message. Environment []*EnvironmentVariable - // The app vhost settings with multiple domains separated by commas. For example: - // 'www.example.com, example.com' - Domains []*string - - // The app's data sources. - DataSources []*DataSource - // The app name. Name *string - // The stack attributes. - Attributes map[string]*string + // The app's short name. + Shortname *string + + // An SslConfiguration object with the SSL configuration. + SslConfiguration *SslConfiguration + + // The app stack ID. + StackId *string + + // The app type. + Type AppType } // Describes a load-based auto scaling upscaling or downscaling threshold @@ -74,17 +74,20 @@ type App struct { // load-based instances. type AutoScalingThresholds struct { - // The number of instances to add or remove when the load exceeds a threshold. - InstanceCount *int32 + // Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter + // takes a list of up to five alarm names, which are case sensitive and must be in + // the same region as the stack. To use custom alarms, you must update your service + // role to allow cloudwatch:DescribeAlarms. You can either have AWS OpsWorks Stacks + // update the role for you when you first use this feature or you can edit the role + // manually. For more information, see Allowing AWS OpsWorks Stacks to Act on Your + // Behalf + // (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-servicerole.html). + Alarms []*string // The CPU utilization threshold, as a percent of the available CPU. A value of -1 // disables the threshold. CpuThreshold *float64 - // The amount of time, in minutes, that the load must exceed a threshold before - // more instances are added or removed. - ThresholdsWaitTime *int32 - // The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks // Stacks should ignore metrics and suppress additional scaling events. For // example, AWS OpsWorks Stacks adds new instances following an upscaling event but @@ -95,24 +98,21 @@ type AutoScalingThresholds struct { // new instances online. IgnoreMetricsTime *int32 - // The memory utilization threshold, as a percent of the available memory. A value - // of -1 disables the threshold. - MemoryThreshold *float64 - - // Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter - // takes a list of up to five alarm names, which are case sensitive and must be in - // the same region as the stack. To use custom alarms, you must update your service - // role to allow cloudwatch:DescribeAlarms. You can either have AWS OpsWorks Stacks - // update the role for you when you first use this feature or you can edit the role - // manually. For more information, see Allowing AWS OpsWorks Stacks to Act on Your - // Behalf - // (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-servicerole.html). - Alarms []*string + // The number of instances to add or remove when the load exceeds a threshold. + InstanceCount *int32 // The load threshold. A value of -1 disables the threshold. For more information // about how load is computed, see Load (computing) // (http://en.wikipedia.org/wiki/Load_%28computing%29). LoadThreshold *float64 + + // The memory utilization threshold, as a percent of the available memory. A value + // of -1 disables the threshold. + MemoryThreshold *float64 + + // The amount of time, in minutes, that the load must exceed a threshold before + // more instances are added or removed. + ThresholdsWaitTime *int32 } // Describes a block device mapping. This data type maps directly to the Amazon EC2 @@ -121,21 +121,21 @@ type AutoScalingThresholds struct { // data type. type BlockDeviceMapping struct { - // The virtual device name. For more information, see BlockDeviceMapping - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html). - VirtualName *string - - // Suppresses the specified device included in the AMI's block device mapping. - NoDevice *string + // The device name that is exposed to the instance, such as /dev/sdh. For the root + // device, you can use the explicit device name or you can set this parameter to + // ROOT_DEVICE and AWS OpsWorks Stacks will provide the correct device name. + DeviceName *string // An EBSBlockDevice that defines how to configure an Amazon EBS volume when the // instance is launched. Ebs *EbsBlockDevice - // The device name that is exposed to the instance, such as /dev/sdh. For the root - // device, you can use the explicit device name or you can set this parameter to - // ROOT_DEVICE and AWS OpsWorks Stacks will provide the correct device name. - DeviceName *string + // Suppresses the specified device included in the AMI's block device mapping. + NoDevice *string + + // The virtual device name. For more information, see BlockDeviceMapping + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html). + VirtualName *string } // Describes the Chef configuration. @@ -151,11 +151,11 @@ type ChefConfiguration struct { // Describes the Amazon CloudWatch logs configuration for a layer. type CloudWatchLogsConfiguration struct { - // A list of configuration options for CloudWatch Logs. - LogStreams []*CloudWatchLogsLogStream - // Whether CloudWatch Logs is enabled for a layer. Enabled *bool + + // A list of configuration options for CloudWatch Logs. + LogStreams []*CloudWatchLogsLogStream } // Describes the Amazon CloudWatch logs configuration for a layer. For detailed @@ -164,14 +164,28 @@ type CloudWatchLogsConfiguration struct { // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AgentReference.html). type CloudWatchLogsLogStream struct { + // Specifies the max number of log events in a batch, up to 10000. The default + // value is 1000. + BatchCount *int32 + + // Specifies the maximum size of log events in a batch, in bytes, up to 1048576 + // bytes. The default value is 32768 bytes. This size is calculated as the sum of + // all event messages in UTF-8, plus 26 bytes for each log event. + BatchSize *int32 + + // Specifies the time duration for the batching of log events. The minimum value is + // 5000ms and default value is 5000ms. + BufferDuration *int32 + // Specifies how the time stamp is extracted from logs. For more information, see // the CloudWatch Logs Agent Reference // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AgentReference.html). DatetimeFormat *string - // Specifies the max number of log events in a batch, up to 10000. The default - // value is 1000. - BatchCount *int32 + // Specifies the encoding of the log file so that the file can be read correctly. + // The default is utf_8. Encodings supported by Python codecs.decode() can be used + // here. + Encoding CloudWatchLogsEncoding // Specifies log files that you want to push to CloudWatch Logs. File can point to // a specific file or multiple files (by using wild card characters such as @@ -185,55 +199,56 @@ type CloudWatchLogsLogStream struct { // a different log group. Zipped files are not supported. File *string - // Specifies the time duration for the batching of log events. The minimum value is - // 5000ms and default value is 5000ms. - BufferDuration *int32 - - // Specifies the encoding of the log file so that the file can be read correctly. - // The default is utf_8. Encodings supported by Python codecs.decode() can be used - // here. - Encoding CloudWatchLogsEncoding - - // Specifies the pattern for identifying the start of a log message. - MultiLineStartPattern *string - // Specifies the range of lines for identifying a file. The valid values are one // number, or two dash-delimited numbers, such as '1', '2-5'. The default value is // '1', meaning the first line is used to calculate the fingerprint. Fingerprint // lines are not sent to CloudWatch Logs unless all specified lines are available. FileFingerprintLines *string + // Specifies where to start to read data (start_of_file or end_of_file). The + // default is start_of_file. This setting is only used if there is no state + // persisted for that log stream. + InitialPosition CloudWatchLogsInitialPosition + // Specifies the destination log group. A log group is created automatically if it // doesn't already exist. Log group names can be between 1 and 512 characters long. // Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' // (forward slash), and '.' (period). LogGroupName *string - // Specifies the maximum size of log events in a batch, in bytes, up to 1048576 - // bytes. The default value is 32768 bytes. This size is calculated as the sum of - // all event messages in UTF-8, plus 26 bytes for each log event. - BatchSize *int32 + // Specifies the pattern for identifying the start of a log message. + MultiLineStartPattern *string // Specifies the time zone of log event time stamps. TimeZone CloudWatchLogsTimeZone - - // Specifies where to start to read data (start_of_file or end_of_file). The - // default is start_of_file. This setting is only used if there is no state - // persisted for that log stream. - InitialPosition CloudWatchLogsInitialPosition } // Describes a command. type Command struct { + // Date and time when the command was acknowledged. + AcknowledgedAt *string + + // The command ID. + CommandId *string + + // Date when the command completed. + CompletedAt *string + // Date and time when the command was run. CreatedAt *string + // The command deployment ID. + DeploymentId *string + // The command exit code. ExitCode *int32 - // Date and time when the command was acknowledged. - AcknowledgedAt *string + // The ID of the instance where the command was executed. + InstanceId *string + + // The URL of the command log. + LogUrl *string // The command status: // @@ -247,12 +262,6 @@ type Command struct { // pending Status *string - // The URL of the command log. - LogUrl *string - - // The command deployment ID. - DeploymentId *string - // The command type: // // * configure @@ -281,15 +290,6 @@ type Command struct { // // * update_dependencies Type *string - - // The ID of the instance where the command was executed. - InstanceId *string - - // The command ID. - CommandId *string - - // Date when the command completed. - CompletedAt *string } // Describes an app's data source. @@ -309,23 +309,20 @@ type DataSource struct { // Describes a deployment of a stack or app. type Deployment struct { + // The app ID. + AppId *string + // Used to specify a stack or deployment command. Command *DeploymentCommand - // Date when the deployment was created. - CreatedAt *string + // A user-defined comment. + Comment *string - // The user's IAM ARN. - IamUserArn *string + // Date when the deployment completed. + CompletedAt *string - // The deployment status: - // - // * running - // - // * successful - // - // * failed - Status *string + // Date when the deployment was created. + CreatedAt *string // A string that contains user-defined custom JSON. It can be used to override the // corresponding default stack configuration attribute values for stack or to pass @@ -335,50 +332,34 @@ type Deployment struct { // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html). CustomJson *string - // Date when the deployment completed. - CompletedAt *string - // The deployment ID. DeploymentId *string - // The IDs of the target instances. - InstanceIds []*string - // The deployment duration. Duration *int32 + // The user's IAM ARN. + IamUserArn *string + + // The IDs of the target instances. + InstanceIds []*string + // The stack ID. StackId *string - // The app ID. - AppId *string - - // A user-defined comment. - Comment *string + // The deployment status: + // + // * running + // + // * successful + // + // * failed + Status *string } // Used to specify a stack or deployment command. type DeploymentCommand struct { - // The arguments of those commands that take arguments. It should be set to a JSON - // object with the following format: {"arg_name1" : ["value1", "value2", ...], - // "arg_name2" : ["value1", "value2", ...], ...} The update_dependencies command - // takes two arguments: - // - // * upgrade_os_to - Specifies the desired Amazon Linux - // version for instances whose OS you want to upgrade, such as Amazon Linux - // 2016.09. You must also set the allow_reboot argument to true. - // - // * - // allow_reboot - Specifies whether to allow AWS OpsWorks Stacks to reboot the - // instances if necessary, after installing the updates. This argument can be set - // to either true or false. The default value is false. - // - // For example, to upgrade an - // instance to Amazon Linux 2016.09, set Args to the following. { - // "upgrade_os_to":["Amazon Linux 2016.09"], "allow_reboot":["true"] } - Args map[string][]*string - // Specifies the operation. You can specify only one command. For stacks, the // following commands are available: // @@ -423,6 +404,25 @@ type DeploymentCommand struct { // // This member is required. Name DeploymentCommandName + + // The arguments of those commands that take arguments. It should be set to a JSON + // object with the following format: {"arg_name1" : ["value1", "value2", ...], + // "arg_name2" : ["value1", "value2", ...], ...} The update_dependencies command + // takes two arguments: + // + // * upgrade_os_to - Specifies the desired Amazon Linux + // version for instances whose OS you want to upgrade, such as Amazon Linux + // 2016.09. You must also set the allow_reboot argument to true. + // + // * + // allow_reboot - Specifies whether to allow AWS OpsWorks Stacks to reboot the + // instances if necessary, after installing the updates. This argument can be set + // to either true or false. The default value is false. + // + // For example, to upgrade an + // instance to Amazon Linux 2016.09, set Args to the following. { + // "upgrade_os_to":["Amazon Linux 2016.09"], "allow_reboot":["true"] } + Args map[string][]*string } // Describes an Amazon EBS volume. This data type maps directly to the Amazon EC2 @@ -431,19 +431,6 @@ type DeploymentCommand struct { // data type. type EbsBlockDevice struct { - // The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS - // (SSD) volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1 for Cold - // HDD,and standard for Magnetic volumes. If you specify the io1 volume type, you - // must also specify a value for the Iops attribute. The maximum ratio of - // provisioned IOPS to requested volume size (in GiB) is 50:1. AWS uses the default - // volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x (volume - // size). - VolumeType VolumeType - - // The volume size, in GiB. For more information, see EbsBlockDevice - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html). - VolumeSize *int32 - // Whether the volume is deleted on instance termination. DeleteOnTermination *bool @@ -454,6 +441,19 @@ type EbsBlockDevice struct { // The snapshot ID. SnapshotId *string + + // The volume size, in GiB. For more information, see EbsBlockDevice + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html). + VolumeSize *int32 + + // The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS + // (SSD) volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1 for Cold + // HDD,and standard for Magnetic volumes. If you specify the io1 volume type, you + // must also specify a value for the Iops attribute. The maximum ratio of + // provisioned IOPS to requested volume size (in GiB) is 50:1. AWS uses the default + // volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x (volume + // size). + VolumeType VolumeType } // Describes a registered Amazon ECS cluster. @@ -462,12 +462,12 @@ type EcsCluster struct { // The cluster's ARN. EcsClusterArn *string - // The time and date that the cluster was registered with the stack. - RegisteredAt *string - // The cluster name. EcsClusterName *string + // The time and date that the cluster was registered with the stack. + RegisteredAt *string + // The stack ID. StackId *string } @@ -475,43 +475,31 @@ type EcsCluster struct { // Describes an Elastic IP address. type ElasticIp struct { - // The name. - Name *string + // The domain. + Domain *string - // The AWS region. For more information, see Regions and Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/rande.html). - Region *string + // The ID of the instance that the address is attached to. + InstanceId *string // The IP address. Ip *string - // The domain. - Domain *string + // The name. + Name *string - // The ID of the instance that the address is attached to. - InstanceId *string + // The AWS region. For more information, see Regions and Endpoints + // (https://docs.aws.amazon.com/general/latest/gr/rande.html). + Region *string } // Describes an Elastic Load Balancing instance. type ElasticLoadBalancer struct { - // The ID of the layer that the instance is attached to. - LayerId *string - - // The VPC ID. - VpcId *string - - // A list of subnet IDs, if the stack is running in a VPC. - SubnetIds []*string - - // The ID of the stack that the instance is associated with. - StackId *string - // A list of Availability Zones. AvailabilityZones []*string - // The instance's AWS region. - Region *string + // The instance's public DNS name. + DnsName *string // A list of the EC2 instances that the Elastic Load Balancing instance is managing // traffic for. @@ -520,8 +508,20 @@ type ElasticLoadBalancer struct { // The Elastic Load Balancing instance's name. ElasticLoadBalancerName *string - // The instance's public DNS name. - DnsName *string + // The ID of the layer that the instance is attached to. + LayerId *string + + // The instance's AWS region. + Region *string + + // The ID of the stack that the instance is associated with. + StackId *string + + // A list of subnet IDs, if the stack is running in a VPC. + SubnetIds []*string + + // The VPC ID. + VpcId *string } // Represents an app's environment variable. @@ -552,108 +552,132 @@ type EnvironmentVariable struct { // Describes an instance. type Instance struct { - // Whether to install operating system and package updates when the instance boots. - // The default value is true. If this value is set to false, you must then update - // your instances manually by using CreateDeployment () to run the - // update_dependencies stack command or by manually running yum (Amazon Linux) or - // apt-get (Ubuntu) on the instances. We strongly recommend using the default value - // of true, to ensure that your instances have the latest security updates. - InstallUpdatesOnBoot *bool - - // For container instances, the Amazon ECS cluster's ARN. - EcsClusterArn *string - - // The instance's platform. - Platform *string - // The agent version. This parameter is set to INHERIT if the instance inherits the // default stack setting or to a a version number for a fixed agent version. AgentVersion *string - // For registered instances, the infrastructure class: ec2 or on-premises. - InfrastructureClass *string + // A custom AMI ID to be used to create the instance. For more information, see + // Instances + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html) + AmiId *string + + // The instance architecture: "i386" or "x86_64". + Architecture Architecture + + // The instance's Amazon Resource Number (ARN). + Arn *string + + // For load-based or time-based instances, the type. + AutoScalingType AutoScalingType + + // The instance Availability Zone. For more information, see Regions and Endpoints + // (https://docs.aws.amazon.com/general/latest/gr/rande.html). + AvailabilityZone *string + + // An array of BlockDeviceMapping objects that specify the instance's block device + // mappings. + BlockDeviceMappings []*BlockDeviceMapping // The time that the instance was created. CreatedAt *string + // Whether this is an Amazon EBS-optimized instance. + EbsOptimized *bool + + // The ID of the associated Amazon EC2 instance. + Ec2InstanceId *string + + // For container instances, the Amazon ECS cluster's ARN. + EcsClusterArn *string + // For container instances, the instance's ARN. EcsContainerInstanceArn *string - // The instance's tenancy option, such as dedicated or host. - Tenancy *string - // The instance Elastic IP address // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html). ElasticIp *string - // An array containing the instance layer IDs. - LayerIds []*string + // The instance host name. + Hostname *string - // The instance type, such as t2.micro. - InstanceType *string + // For registered instances, the infrastructure class: ec2 or on-premises. + InfrastructureClass *string - // The instance's Amazon Resource Number (ARN). - Arn *string + // Whether to install operating system and package updates when the instance boots. + // The default value is true. If this value is set to false, you must then update + // your instances manually by using CreateDeployment () to run the + // update_dependencies stack command or by manually running yum (Amazon Linux) or + // apt-get (Ubuntu) on the instances. We strongly recommend using the default value + // of true, to ensure that your instances have the latest security updates. + InstallUpdatesOnBoot *bool - // The stack ID. - StackId *string + // The instance ID. + InstanceId *string + + // The ARN of the instance's IAM profile. For more information about IAM ARNs, see + // Using Identifiers + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). + InstanceProfileArn *string + + // The instance type, such as t2.micro. + InstanceType *string // The ID of the last service error. For more information, call // DescribeServiceErrors (). LastServiceErrorId *string - // The instance's subnet ID; applicable only if the stack is running in a VPC. - SubnetId *string + // An array containing the instance layer IDs. + LayerIds []*string - // For load-based or time-based instances, the type. - AutoScalingType AutoScalingType + // The instance's operating system. + Os *string - // The SSH key's RSA fingerprint. - SshHostRsaKeyFingerprint *string + // The instance's platform. + Platform *string + + // The instance's private DNS name. + PrivateDns *string // The instance's private IP address. PrivateIp *string + // The instance public DNS name. + PublicDns *string + + // The instance public IP address. + PublicIp *string + + // For registered instances, who performed the registration. + RegisteredBy *string + + // The instance's reported AWS OpsWorks Stacks agent version. + ReportedAgentVersion *string + // For registered instances, the reported operating system. ReportedOs *ReportedOs - // The ID of the associated Amazon EC2 instance. - Ec2InstanceId *string - // The instance's root device type. For more information, see Storage for the Root // Device // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device). RootDeviceType RootDeviceType - // The ARN of the instance's IAM profile. For more information about IAM ARNs, see - // Using Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). - InstanceProfileArn *string - - // Whether this is an Amazon EBS-optimized instance. - EbsOptimized *bool - - // The instance host name. - Hostname *string - - // The instance Availability Zone. For more information, see Regions and Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/rande.html). - AvailabilityZone *string + // The root device volume ID. + RootDeviceVolumeId *string - // The instance's reported AWS OpsWorks Stacks agent version. - ReportedAgentVersion *string + // An array containing the instance security group IDs. + SecurityGroupIds []*string - // The instance architecture: "i386" or "x86_64". - Architecture Architecture + // The SSH key's Deep Security Agent (DSA) fingerprint. + SshHostDsaKeyFingerprint *string - // The instance public IP address. - PublicIp *string + // The SSH key's RSA fingerprint. + SshHostRsaKeyFingerprint *string - // The instance ID. - InstanceId *string + // The instance's Amazon EC2 key-pair name. + SshKeyName *string - // The instance's virtualization type: paravirtual or hvm. - VirtualizationType VirtualizationType + // The stack ID. + StackId *string // The instance status: // @@ -691,38 +715,14 @@ type Instance struct { // * terminating Status *string - // The instance's Amazon EC2 key-pair name. - SshKeyName *string - - // For registered instances, who performed the registration. - RegisteredBy *string - - // A custom AMI ID to be used to create the instance. For more information, see - // Instances - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html) - AmiId *string - - // An array of BlockDeviceMapping objects that specify the instance's block device - // mappings. - BlockDeviceMappings []*BlockDeviceMapping - - // The instance's private DNS name. - PrivateDns *string - - // An array containing the instance security group IDs. - SecurityGroupIds []*string - - // The instance's operating system. - Os *string - - // The root device volume ID. - RootDeviceVolumeId *string + // The instance's subnet ID; applicable only if the stack is running in a VPC. + SubnetId *string - // The SSH key's Deep Security Agent (DSA) fingerprint. - SshHostDsaKeyFingerprint *string + // The instance's tenancy option, such as dedicated or host. + Tenancy *string - // The instance public DNS name. - PublicDns *string + // The instance's virtualization type: paravirtual or hvm. + VirtualizationType VirtualizationType } // Contains a description of an Amazon EC2 instance from the Amazon EC2 metadata @@ -730,115 +730,133 @@ type Instance struct { // (https://docs.aws.amazon.com/sdkfornet/latest/apidocs/Index.html). type InstanceIdentity struct { - // A signature that can be used to verify the document's accuracy and authenticity. - Signature *string - // A JSON document that contains the metadata. Document *string + + // A signature that can be used to verify the document's accuracy and authenticity. + Signature *string } // Describes how many instances a stack has for each status. type InstancesCount struct { - // The number of instances with stopped status. - Stopped *int32 + // The number of instances in the Assigning state. + Assigning *int32 - // The number of instances in the Registered state. - Registered *int32 + // The number of instances with booting status. + Booting *int32 + + // The number of instances with connection_lost status. + ConnectionLost *int32 + + // The number of instances in the Deregistering state. + Deregistering *int32 // The number of instances with online status. Online *int32 - // The number of instances in the Registering state. - Registering *int32 - // The number of instances with pending status. Pending *int32 // The number of instances with rebooting status. Rebooting *int32 + // The number of instances in the Registered state. + Registered *int32 + + // The number of instances in the Registering state. + Registering *int32 + // The number of instances with requested status. Requested *int32 + // The number of instances with running_setup status. + RunningSetup *int32 + // The number of instances with setup_failed status. SetupFailed *int32 - // The number of instances with connection_lost status. - ConnectionLost *int32 - - // The number of instances in the Deregistering state. - Deregistering *int32 + // The number of instances with shutting_down status. + ShuttingDown *int32 - // The number of instances with terminated status. - Terminated *int32 + // The number of instances with start_failed status. + StartFailed *int32 // The number of instances with stop_failed status. StopFailed *int32 - // The number of instances with shutting_down status. - ShuttingDown *int32 + // The number of instances with stopped status. + Stopped *int32 // The number of instances with stopping status. Stopping *int32 - // The number of instances in the Assigning state. - Assigning *int32 - - // The number of instances in the Unassigning state. - Unassigning *int32 - - // The number of instances with running_setup status. - RunningSetup *int32 - - // The number of instances with start_failed status. - StartFailed *int32 - - // The number of instances with booting status. - Booting *int32 + // The number of instances with terminated status. + Terminated *int32 // The number of instances with terminating status. Terminating *int32 + + // The number of instances in the Unassigning state. + Unassigning *int32 } // Describes a layer. type Layer struct { - // The layer name. - Name *string + // The Amazon Resource Number (ARN) of a layer. + Arn *string - // The layer stack ID. - StackId *string + // The layer attributes. For the HaproxyStatsPassword, MysqlRootPassword, and + // GangliaPassword attributes, AWS OpsWorks Stacks returns *****FILTERED***** + // instead of the actual value For an ECS Cluster layer, AWS OpsWorks Stacks the + // EcsClusterArn attribute is set to the cluster's ARN. + Attributes map[string]*string - // AWS OpsWorks Stacks supports five lifecycle events: setup, configuration, - // deploy, undeploy, and shutdown. For each layer, AWS OpsWorks Stacks runs a set - // of standard recipes for each event. You can also provide custom recipes for any - // or all layers and events. AWS OpsWorks Stacks runs custom event recipes after - // the standard recipes. LayerCustomRecipes specifies the custom recipes for a - // particular layer to be run in response to each of the five events. To specify a - // recipe, use the cookbook's directory name in the repository followed by two - // colons and the recipe name, which is the recipe's file name without the .rb - // extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the - // repository's phpapp2 folder. - DefaultRecipes *Recipes + // Whether to automatically assign an Elastic IP address + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) + // to the layer's instances. For more information, see How to Edit a Layer + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html). + AutoAssignElasticIps *bool - // A LifeCycleEventConfiguration object that specifies the Shutdown event - // configuration. - LifecycleEventConfiguration *LifecycleEventConfiguration + // For stacks that are running in a VPC, whether to automatically assign a public + // IP address to the layer's instances. For more information, see How to Edit a + // Layer + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html). + AutoAssignPublicIps *bool + + // The Amazon CloudWatch Logs configuration settings for the layer. + CloudWatchLogsConfiguration *CloudWatchLogsConfiguration + + // Date when the layer was created. + CreatedAt *string // The ARN of the default IAM profile to be used for the layer's EC2 instances. For // more information about IAM ARNs, see Using Identifiers // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). CustomInstanceProfileArn *string - // The layer short name. - Shortname *string + // A JSON formatted string containing the layer's custom stack configuration and + // deployment attributes. + CustomJson *string - // For stacks that are running in a VPC, whether to automatically assign a public - // IP address to the layer's instances. For more information, see How to Edit a - // Layer - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html). - AutoAssignPublicIps *bool + // A LayerCustomRecipes object that specifies the layer's custom recipes. + CustomRecipes *Recipes + + // An array containing the layer's custom security group IDs. + CustomSecurityGroupIds []*string + + // AWS OpsWorks Stacks supports five lifecycle events: setup, configuration, + // deploy, undeploy, and shutdown. For each layer, AWS OpsWorks Stacks runs a set + // of standard recipes for each event. You can also provide custom recipes for any + // or all layers and events. AWS OpsWorks Stacks runs custom event recipes after + // the standard recipes. LayerCustomRecipes specifies the custom recipes for a + // particular layer to be run in response to each of the five events. To specify a + // recipe, use the cookbook's directory name in the repository followed by two + // colons and the recipe name, which is the recipe's file name without the .rb + // extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the + // repository's phpapp2 folder. + DefaultRecipes *Recipes // An array containing the layer's security group names. DefaultSecurityGroupNames []*string @@ -846,15 +864,6 @@ type Layer struct { // Whether auto healing is disabled for the layer. EnableAutoHealing *bool - // Date when the layer was created. - CreatedAt *string - - // A LayerCustomRecipes object that specifies the layer's custom recipes. - CustomRecipes *Recipes - - // The Amazon Resource Number (ARN) of a layer. - Arn *string - // Whether to install operating system and package updates when the instance boots. // The default value is true. If this value is set to false, you must then update // your instances manually by using CreateDeployment () to run the @@ -863,42 +872,33 @@ type Layer struct { // of true, to ensure that your instances have the latest security updates. InstallUpdatesOnBoot *bool - // The layer attributes. For the HaproxyStatsPassword, MysqlRootPassword, and - // GangliaPassword attributes, AWS OpsWorks Stacks returns *****FILTERED***** - // instead of the actual value For an ECS Cluster layer, AWS OpsWorks Stacks the - // EcsClusterArn attribute is set to the cluster's ARN. - Attributes map[string]*string - // The layer ID. LayerId *string - // Whether to automatically assign an Elastic IP address - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) - // to the layer's instances. For more information, see How to Edit a Layer - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html). - AutoAssignElasticIps *bool + // A LifeCycleEventConfiguration object that specifies the Shutdown event + // configuration. + LifecycleEventConfiguration *LifecycleEventConfiguration - // An array containing the layer's custom security group IDs. - CustomSecurityGroupIds []*string + // The layer name. + Name *string - // A JSON formatted string containing the layer's custom stack configuration and - // deployment attributes. - CustomJson *string + // An array of Package objects that describe the layer's packages. + Packages []*string - // The layer type. - Type LayerType + // The layer short name. + Shortname *string - // A VolumeConfigurations object that describes the layer's Amazon EBS volumes. - VolumeConfigurations []*VolumeConfiguration + // The layer stack ID. + StackId *string - // The Amazon CloudWatch Logs configuration settings for the layer. - CloudWatchLogsConfiguration *CloudWatchLogsConfiguration + // The layer type. + Type LayerType // Whether the layer uses Amazon EBS-optimized instances. UseEbsOptimizedInstances *bool - // An array of Package objects that describe the layer's packages. - Packages []*string + // A VolumeConfigurations object that describes the layer's Amazon EBS volumes. + VolumeConfigurations []*VolumeConfiguration } // Specifies the lifecycle event configuration @@ -912,15 +912,15 @@ type LifecycleEventConfiguration struct { // Describes a layer's load-based auto scaling configuration. type LoadBasedAutoScalingConfiguration struct { - // The layer ID. - LayerId *string + // An AutoScalingThresholds object that describes the downscaling configuration, + // which defines how and when AWS OpsWorks Stacks reduces the number of instances. + DownScaling *AutoScalingThresholds // Whether load-based auto scaling is enabled for the layer. Enable *bool - // An AutoScalingThresholds object that describes the downscaling configuration, - // which defines how and when AWS OpsWorks Stacks reduces the number of instances. - DownScaling *AutoScalingThresholds + // The layer ID. + LayerId *string // An AutoScalingThresholds object that describes the upscaling configuration, // which defines how and when AWS OpsWorks Stacks increases the number of @@ -931,28 +931,28 @@ type LoadBasedAutoScalingConfiguration struct { // Describes supported operating systems in AWS OpsWorks Stacks. type OperatingSystem struct { + // Supported configuration manager name and versions for an AWS OpsWorks Stacks + // operating system. + ConfigurationManagers []*OperatingSystemConfigurationManager + // The ID of a supported operating system, such as Amazon Linux 2018.03. Id *string - // The version of the operating system, including the release and edition, if - // applicable. - ReportedVersion *string - // The name of the operating system, such as Amazon Linux 2018.03. Name *string // A short name for the operating system manufacturer. ReportedName *string + // The version of the operating system, including the release and edition, if + // applicable. + ReportedVersion *string + // Indicates that an operating system is not supported for new instances. Supported *bool // The type of a supported operating system, either Linux or Windows. Type *string - - // Supported configuration manager name and versions for an AWS OpsWorks Stacks - // operating system. - ConfigurationManagers []*OperatingSystemConfigurationManager } // A block that contains information about the configuration manager (Chef) and the @@ -960,12 +960,12 @@ type OperatingSystem struct { // system. type OperatingSystemConfigurationManager struct { + // The name of the configuration manager, which is Chef. + Name *string + // The versions of the configuration manager that are supported by an operating // system. Version *string - - // The name of the configuration manager, which is Chef. - Name *string } // Describes stack or user permissions. @@ -974,6 +974,9 @@ type Permission struct { // Whether the user can use SSH. AllowSsh *bool + // Whether the user can use sudo. + AllowSudo *bool + // The Amazon Resource Name (ARN) for an AWS Identity and Access Management (IAM) // role. For more information about IAM ARNs, see Using Identifiers // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). @@ -999,9 +1002,6 @@ type Permission struct { // A stack ID. StackId *string - - // Whether the user can use sudo. - AllowSudo *bool } // Describes an instance's RAID array. @@ -1011,39 +1011,39 @@ type RaidArray struct { // (https://docs.aws.amazon.com/general/latest/gr/rande.html). AvailabilityZone *string - // The array's size. - Size *int32 + // When the RAID array was created. + CreatedAt *string + + // The array's Linux device. For example /dev/mdadm0. + Device *string // The instance ID. InstanceId *string - // The RAID level (http://en.wikipedia.org/wiki/Standard_RAID_levels). - RaidLevel *int32 - // For PIOPS volumes, the IOPS per disk. Iops *int32 - // The array's Linux device. For example /dev/mdadm0. - Device *string + // The array's mount point. + MountPoint *string // The array name. Name *string - // The stack ID. - StackId *string - - // When the RAID array was created. - CreatedAt *string - - // The array's mount point. - MountPoint *string - // The number of disks in the array. NumberOfDisks *int32 // The array ID. RaidArrayId *string + // The RAID level (http://en.wikipedia.org/wiki/Standard_RAID_levels). + RaidLevel *int32 + + // The array's size. + Size *int32 + + // The stack ID. + StackId *string + // The volume type, standard or PIOPS. VolumeType *string } @@ -1051,35 +1051,35 @@ type RaidArray struct { // Describes an Amazon RDS instance. type RdsDbInstance struct { - // The master user name. - DbUser *string - // The instance's address. Address *string + // The DB instance identifier. + DbInstanceIdentifier *string + // AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value. DbPassword *string - // The ID of the stack with which the instance is registered. - StackId *string - - // The instance's AWS region. - Region *string + // The master user name. + DbUser *string // The instance's database engine. Engine *string - // The instance's ARN. - RdsDbInstanceArn *string - // Set to true if AWS OpsWorks Stacks is unable to discover the Amazon RDS // instance. AWS OpsWorks Stacks attempts to discover the instance only once. If // this value is set to true, you must deregister the instance, and then register // it again. MissingOnRds *bool - // The DB instance identifier. - DbInstanceIdentifier *string + // The instance's ARN. + RdsDbInstanceArn *string + + // The instance's AWS region. + Region *string + + // The ID of the stack with which the instance is registered. + StackId *string } // AWS OpsWorks Stacks supports five lifecycle events: setup, configuration, @@ -1094,84 +1094,84 @@ type RdsDbInstance struct { // the repository's phpapp2 folder.

    type Recipes struct { - // An array of custom recipe names to be run following a shutdown event. - Shutdown []*string + // An array of custom recipe names to be run following a configure event. + Configure []*string - // An array of custom recipe names to be run following a undeploy event. - Undeploy []*string + // An array of custom recipe names to be run following a deploy event. + Deploy []*string // An array of custom recipe names to be run following a setup event. Setup []*string - // An array of custom recipe names to be run following a configure event. - Configure []*string + // An array of custom recipe names to be run following a shutdown event. + Shutdown []*string - // An array of custom recipe names to be run following a deploy event. - Deploy []*string + // An array of custom recipe names to be run following a undeploy event. + Undeploy []*string } // A registered instance's reported operating system. type ReportedOs struct { - // The operating system version. - Version *string - // The operating system family. Family *string // The operating system name. Name *string + + // The operating system version. + Version *string } // Describes a user's SSH information. type SelfUserProfile struct { - // The user's SSH public key. - SshPublicKey *string + // The user's IAM ARN. + IamUserArn *string // The user's name. Name *string + // The user's SSH public key. + SshPublicKey *string + // The user's SSH user name. SshUsername *string - - // The user's IAM ARN. - IamUserArn *string } // Describes an AWS OpsWorks Stacks service error. type ServiceError struct { - // The error ID. - ServiceErrorId *string - // When the error occurred. CreatedAt *string - // The stack ID. - StackId *string - - // The error type. - Type *string - // The instance ID. InstanceId *string // A message that describes the error. Message *string + + // The error ID. + ServiceErrorId *string + + // The stack ID. + StackId *string + + // The error type. + Type *string } // The Shutdown event configuration. type ShutdownEventConfiguration struct { - // The time, in seconds, that AWS OpsWorks Stacks will wait after triggering a - // Shutdown event before shutting down an instance. - ExecutionTimeout *int32 - // Whether to enable Elastic Load Balancing connection draining. For more // information, see Connection Draining // (https://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#conn-drain) DelayUntilElbConnectionsDrained *bool + + // The time, in seconds, that AWS OpsWorks Stacks will wait after triggering a + // Shutdown event before shutting down an instance. + ExecutionTimeout *int32 } // Contains the information required to retrieve an app or cookbook from a @@ -1181,32 +1181,6 @@ type ShutdownEventConfiguration struct { // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html). type Source struct { - // The application's version. AWS OpsWorks Stacks enables you to easily deploy new - // versions of an application. One of the simplest approaches is to have branches - // or revisions in your repository that represent different versions that can - // potentially be deployed. - Revision *string - - // This parameter depends on the repository type. - // - // * For Amazon S3 bundles, set - // Username to the appropriate IAM access key ID. - // - // * For HTTP bundles, Git - // repositories, and Subversion repositories, set Username to the user name. - Username *string - - // The repository type. - Type SourceType - - // In requests, the repository's SSH key. In responses, AWS OpsWorks Stacks returns - // *****FILTERED***** instead of the actual value. - SshKey *string - - // The source URL. The following is an example of an Amazon S3 source URL: - // https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz. - Url *string - // When included in a request, the parameter depends on the repository type. // // * @@ -1222,6 +1196,32 @@ type Source struct { // In responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the // actual value. Password *string + + // The application's version. AWS OpsWorks Stacks enables you to easily deploy new + // versions of an application. One of the simplest approaches is to have branches + // or revisions in your repository that represent different versions that can + // potentially be deployed. + Revision *string + + // In requests, the repository's SSH key. In responses, AWS OpsWorks Stacks returns + // *****FILTERED***** instead of the actual value. + SshKey *string + + // The repository type. + Type SourceType + + // The source URL. The following is an example of an Amazon S3 source URL: + // https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz. + Url *string + + // This parameter depends on the repository type. + // + // * For Amazon S3 bundles, set + // Username to the appropriate IAM access key ID. + // + // * For HTTP bundles, Git + // repositories, and Subversion repositories, set Username to the user name. + Username *string } // Describes an app's SSL configuration. @@ -1245,17 +1245,33 @@ type SslConfiguration struct { // Describes a stack. type Stack struct { + // The agent version. This parameter is set to LATEST for auto-update. or a version + // number for a fixed agent version. + AgentVersion *string + + // The stack's ARN. + Arn *string + // The stack's attributes. Attributes map[string]*string - // The default subnet ID; applicable only if the stack is running in a VPC. - DefaultSubnetId *string + // A ChefConfiguration object that specifies whether to enable Berkshelf and the + // Berkshelf version. For more information, see Create a New Stack + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html). + ChefConfiguration *ChefConfiguration - // The stack's default operating system. - DefaultOs *string + // The configuration manager. + ConfigurationManager *StackConfigurationManager - // The stack's ARN. - Arn *string + // The date when the stack was created. + CreatedAt *string + + // Contains the information required to retrieve an app or cookbook from a + // repository. For more information, see Adding Apps + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html) + // or Cookbooks and Recipes + // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html). + CustomCookbooksSource *Source // A JSON object that contains user-defined attributes to be added to the stack // configuration and deployment attributes. You can use custom JSON to override the @@ -1266,17 +1282,17 @@ type Stack struct { // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html). CustomJson *string + // The stack's default Availability Zone. For more information, see Regions and + // Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html). + DefaultAvailabilityZone *string + // The ARN of an IAM profile that is the default profile for all of the stack's EC2 // instances. For more information about IAM ARNs, see Using Identifiers // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). DefaultInstanceProfileArn *string - // Whether the stack automatically associates the AWS OpsWorks Stacks built-in - // security groups with the stack's layers. - UseOpsworksSecurityGroups *bool - - // The VPC ID; applicable only if the stack is running in a VPC. - VpcId *string + // The stack's default operating system. + DefaultOs *string // The default root device type. This value is used by default for all instances in // the stack, but you can override it when you create an instance. For more @@ -1284,55 +1300,39 @@ type Stack struct { // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device). DefaultRootDeviceType RootDeviceType - // The date when the stack was created. - CreatedAt *string + // A default Amazon EC2 key pair for the stack's instances. You can override this + // value when you create or update an instance. + DefaultSshKeyName *string - // Whether the stack uses custom cookbooks. - UseCustomCookbooks *bool + // The default subnet ID; applicable only if the stack is running in a VPC. + DefaultSubnetId *string // The stack host name theme, with spaces replaced by underscores. HostnameTheme *string - // A default Amazon EC2 key pair for the stack's instances. You can override this - // value when you create or update an instance. - DefaultSshKeyName *string - - // The configuration manager. - ConfigurationManager *StackConfigurationManager + // The stack name. + Name *string // The stack AWS region, such as "ap-northeast-2". For more information about AWS // regions, see Regions and Endpoints // (https://docs.aws.amazon.com/general/latest/gr/rande.html). Region *string + // The stack AWS Identity and Access Management (IAM) role. + ServiceRoleArn *string + // The stack ID. StackId *string - // The stack name. - Name *string - - // The stack's default Availability Zone. For more information, see Regions and - // Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html). - DefaultAvailabilityZone *string - - // The agent version. This parameter is set to LATEST for auto-update. or a version - // number for a fixed agent version. - AgentVersion *string - - // Contains the information required to retrieve an app or cookbook from a - // repository. For more information, see Adding Apps - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html) - // or Cookbooks and Recipes - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html). - CustomCookbooksSource *Source + // Whether the stack uses custom cookbooks. + UseCustomCookbooks *bool - // The stack AWS Identity and Access Management (IAM) role. - ServiceRoleArn *string + // Whether the stack automatically associates the AWS OpsWorks Stacks built-in + // security groups with the stack's layers. + UseOpsworksSecurityGroups *bool - // A ChefConfiguration object that specifies whether to enable Berkshelf and the - // Berkshelf version. For more information, see Create a New Stack - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html). - ChefConfiguration *ChefConfiguration + // The VPC ID; applicable only if the stack is running in a VPC. + VpcId *string } // Describes the configuration manager. @@ -1350,43 +1350,43 @@ type StackConfigurationManager struct { // Summarizes the number of layers, instances, and apps in a stack. type StackSummary struct { - // The stack ID. - StackId *string - - // The stack name. - Name *string - // The number of apps. AppsCount *int32 - // The number of layers. - LayersCount *int32 + // The stack's ARN. + Arn *string // An InstancesCount object with the number of instances in each status. InstancesCount *InstancesCount - // The stack's ARN. - Arn *string + // The number of layers. + LayersCount *int32 + + // The stack name. + Name *string + + // The stack ID. + StackId *string } // Contains the data needed by RDP clients such as the Microsoft Remote Desktop // Connection to log in to the instance. type TemporaryCredential struct { + // The instance's AWS OpsWorks Stacks ID. + InstanceId *string + // The password. Password *string - // The instance's AWS OpsWorks Stacks ID. - InstanceId *string + // The user name. + Username *string // The length of time (in minutes) that the grant is valid. When the grant expires, // at the end of this period, the user will no longer be able to use the // credentials to log in. If they are logged in at the time, they will be // automatically logged out. ValidForInMinutes *int32 - - // The user name. - Username *string } // Describes an instance's time-based auto scaling configuration. @@ -1402,8 +1402,10 @@ type TimeBasedAutoScalingConfiguration struct { // Describes a user's SSH information. type UserProfile struct { - // The user's SSH user name. - SshUsername *string + // Whether users can specify their own SSH public key through the My Settings page. + // For more information, see Managing User Permissions + // (https://docs.aws.amazon.com/opsworks/latest/userguide/security-settingsshkey.html). + AllowSelfManagement *bool // The user's IAM ARN. IamUserArn *string @@ -1414,24 +1416,56 @@ type UserProfile struct { // The user's SSH public key. SshPublicKey *string - // Whether users can specify their own SSH public key through the My Settings page. - // For more information, see Managing User Permissions - // (https://docs.aws.amazon.com/opsworks/latest/userguide/security-settingsshkey.html). - AllowSelfManagement *bool + // The user's SSH user name. + SshUsername *string } // Describes an instance's Amazon EBS volume. type Volume struct { + // The volume Availability Zone. For more information, see Regions and Endpoints + // (https://docs.aws.amazon.com/general/latest/gr/rande.html). + AvailabilityZone *string + + // The device name. + Device *string + + // The Amazon EC2 volume ID. + Ec2VolumeId *string + + // Specifies whether an Amazon EBS volume is encrypted. For more information, see + // Amazon EBS Encryption + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html). + Encrypted *bool + + // The instance ID. + InstanceId *string + + // For PIOPS volumes, the IOPS per disk. + Iops *int32 + // The volume mount point. For example, "/mnt/disk1". MountPoint *string + // The volume name. + Name *string + + // The RAID array ID. + RaidArrayId *string + // The AWS region. For more information about AWS regions, see Regions and // Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html). Region *string - // The Amazon EC2 volume ID. - Ec2VolumeId *string + // The volume size. + Size *int32 + + // The value returned by DescribeVolumes + // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeVolumes.html). + Status *string + + // The volume ID. + VolumeId *string // The volume type. For more information, see Amazon EBS Volume Types // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html). @@ -1454,30 +1488,26 @@ type Volume struct { // * sc1 - Cold HDD. Cold HDD volumes // must have a minimum size of 500 GiB and a maximum size of 16384 GiB. VolumeType *string +} - // The volume ID. - VolumeId *string +// Describes an Amazon EBS volume configuration. +type VolumeConfiguration struct { - // The value returned by DescribeVolumes - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeVolumes.html). - Status *string + // The volume mount point. For example "/dev/sdh". + // + // This member is required. + MountPoint *string + + // The number of disks in the volume. + // + // This member is required. + NumberOfDisks *int32 // The volume size. + // + // This member is required. Size *int32 - // The RAID array ID. - RaidArrayId *string - - // The volume Availability Zone. For more information, see Regions and Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/rande.html). - AvailabilityZone *string - - // The instance ID. - InstanceId *string - - // The device name. - Device *string - // Specifies whether an Amazon EBS volume is encrypted. For more information, see // Amazon EBS Encryption // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html). @@ -1486,16 +1516,6 @@ type Volume struct { // For PIOPS volumes, the IOPS per disk. Iops *int32 - // The volume name. - Name *string -} - -// Describes an Amazon EBS volume configuration. -type VolumeConfiguration struct { - - // For PIOPS volumes, the IOPS per disk. - Iops *int32 - // The volume RAID level (http://en.wikipedia.org/wiki/Standard_RAID_levels). RaidLevel *int32 @@ -1520,26 +1540,6 @@ type VolumeConfiguration struct { // * sc1 - Cold HDD. Cold HDD volumes // must have a minimum size of 500 GiB and a maximum size of 16384 GiB. VolumeType *string - - // The volume size. - // - // This member is required. - Size *int32 - - // The volume mount point. For example "/dev/sdh". - // - // This member is required. - MountPoint *string - - // Specifies whether an Amazon EBS volume is encrypted. For more information, see - // Amazon EBS Encryption - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html). - Encrypted *bool - - // The number of disks in the volume. - // - // This member is required. - NumberOfDisks *int32 } // Describes a time-based instance's auto scaling schedule. The schedule consists @@ -1560,24 +1560,24 @@ type VolumeConfiguration struct { // { "12":"on", "13":"on", "14":"on", "15":"on" } type WeeklyAutoScalingSchedule struct { - // The schedule for Saturday. - Saturday map[string]*string - - // The schedule for Tuesday. - Tuesday map[string]*string - // The schedule for Friday. Friday map[string]*string // The schedule for Monday. Monday map[string]*string + // The schedule for Saturday. + Saturday map[string]*string + + // The schedule for Sunday. + Sunday map[string]*string + // The schedule for Thursday. Thursday map[string]*string + // The schedule for Tuesday. + Tuesday map[string]*string + // The schedule for Wednesday. Wednesday map[string]*string - - // The schedule for Sunday. - Sunday map[string]*string } diff --git a/service/opsworkscm/api_op_AssociateNode.go b/service/opsworkscm/api_op_AssociateNode.go index d37d65e3985..af749ef512d 100644 --- a/service/opsworkscm/api_op_AssociateNode.go +++ b/service/opsworkscm/api_op_AssociateNode.go @@ -90,15 +90,15 @@ type AssociateNodeInput struct { // This member is required. EngineAttributes []*types.EngineAttribute - // The name of the server with which to associate the node. + // The name of the node. // // This member is required. - ServerName *string + NodeName *string - // The name of the node. + // The name of the server with which to associate the node. // // This member is required. - NodeName *string + ServerName *string } type AssociateNodeOutput struct { diff --git a/service/opsworkscm/api_op_CreateBackup.go b/service/opsworkscm/api_op_CreateBackup.go index d1cdb22e1a0..7a19bdf89e6 100644 --- a/service/opsworkscm/api_op_CreateBackup.go +++ b/service/opsworkscm/api_op_CreateBackup.go @@ -70,6 +70,9 @@ type CreateBackupInput struct { // This member is required. ServerName *string + // A user-defined description of the backup. + Description *string + // A map that contains tag keys and tag values to attach to an AWS OpsWorks-CM // server backup. // @@ -90,9 +93,6 @@ type CreateBackupInput struct { // maximum of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM // resources. Tags []*types.Tag - - // A user-defined description of the backup. - Description *string } type CreateBackupOutput struct { diff --git a/service/opsworkscm/api_op_CreateServer.go b/service/opsworkscm/api_op_CreateServer.go index 022ab0eeb0d..4511f9b4e78 100644 --- a/service/opsworkscm/api_op_CreateServer.go +++ b/service/opsworkscm/api_op_CreateServer.go @@ -77,32 +77,6 @@ func (c *Client) CreateServer(ctx context.Context, params *CreateServerInput, op type CreateServerInput struct { - // A list of security group IDs to attach to the Amazon EC2 instance. If you add - // this parameter, the specified security groups must be within the VPC that is - // specified by SubnetIds. If you do not specify this parameter, AWS OpsWorks CM - // creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 - // (everyone). - SecurityGroupIds []*string - - // The IDs of subnets in which to launch the server EC2 instance. Amazon - // EC2-Classic customers: This field is required. All servers must run within a - // VPC. The VPC must have "Auto Assign Public IP" enabled. EC2-VPC customers: This - // field is optional. If you do not specify subnet IDs, your EC2 instances are - // created in a default subnet that is selected by Amazon EC2. If you specify - // subnet IDs, the VPC must have "Auto Assign Public IP" enabled. For more - // information about supported Amazon EC2 platforms, see Supported Platforms - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html). - SubnetIds []*string - - // The number of automated backups that you want to keep. Whenever a new backup is - // created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. - // The default value is 1. - BackupRetentionCount *int32 - - // If you specify this field, AWS OpsWorks CM creates the server by using the - // backup represented by BackupId. - BackupId *string - // The configuration management engine to use. Valid values include ChefAutomate // and Puppet. // @@ -125,16 +99,12 @@ type CreateServerInput struct { // This member is required. InstanceType *string - // The major release version of the engine that you want to use. For a Chef server, - // the valid value for EngineVersion is currently 2. For a Puppet server, the valid - // value is 2017. - EngineVersion *string - - // A private key in PEM format for connecting to the server by using HTTPS. The - // private key must not be encrypted; it cannot be protected by a password or - // passphrase. If you specify a custom private key, you must also specify values - // for CustomDomain and CustomCertificate. - CustomPrivateKey *string + // The name of the server. The server name must be unique within your AWS account, + // within each region. Server names must start with a letter; then letters, + // numbers, or hyphens (-) are allowed, up to a maximum of 40 characters. + // + // This member is required. + ServerName *string // The service role that the AWS OpsWorks CM service backend uses to work with your // account. Although the AWS OpsWorks management console typically creates the @@ -147,37 +117,61 @@ type CreateServerInput struct { // This member is required. ServiceRoleArn *string - // The name of the server. The server name must be unique within your AWS account, - // within each region. Server names must start with a letter; then letters, - // numbers, or hyphens (-) are allowed, up to a maximum of 40 characters. - // - // This member is required. - ServerName *string + // Associate a public IP address with a server that you are launching. Valid values + // are true or false. The default value is true. + AssociatePublicIpAddress *bool - // The start time for a one-hour period during which AWS OpsWorks CM backs up - // application-level data on your server if automated backups are enabled. Valid - // values must be specified in one of the following formats: + // If you specify this field, AWS OpsWorks CM creates the server by using the + // backup represented by BackupId. + BackupId *string + + // The number of automated backups that you want to keep. Whenever a new backup is + // created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. + // The default value is 1. + BackupRetentionCount *int32 + + // A PEM-formatted HTTPS certificate. The value can be be a single, self-signed + // certificate, or a certificate chain. If you specify a custom certificate, you + // must also specify values for CustomDomain and CustomPrivateKey. The following + // are requirements for the CustomCertificate value: // - // * HH:MM for daily - // backups + // * You can provide either + // a self-signed, custom certificate, or the full certificate chain. // - // * DDD:HH:MM for weekly backups + // * The + // certificate must be a valid X509 certificate, or a certificate chain in PEM + // format. // - // MM must be specified as 00. The - // specified time is in coordinated universal time (UTC). The default value is a - // random, daily start time. Example: 08:00, which represents a daily start time of - // 08:00 UTC. Example: Mon:08:00, which represents a start time of every Monday at - // 08:00 UTC. (8:00 a.m.) - PreferredBackupWindow *string + // * The certificate must be valid at the time of upload. A + // certificate can't be used before its validity period begins (the certificate's + // NotBefore date), or after it expires (the certificate's NotAfter date). + // + // * + // The certificate’s common name or subject alternative names (SANs), if present, + // must match the value of CustomDomain. + // + // * The certificate must match the + // value of CustomPrivateKey. + CustomCertificate *string - // The start time for a one-hour period each week during which AWS OpsWorks CM - // performs maintenance on the instance. Valid values must be specified in the - // following format: DDD:HH:MM. MM must be specified as 00. The specified time is - // in coordinated universal time (UTC). The default value is a random one-hour - // period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more - // information. Example: Mon:08:00, which represents a start time of every Monday - // at 08:00 UTC. (8:00 a.m.) - PreferredMaintenanceWindow *string + // An optional public endpoint of a server, such as https://aws.my-company.com. To + // access the server, create a CNAME DNS record in your preferred DNS service that + // points the custom domain to the endpoint that is generated when the server is + // created (the value of the CreateServer Endpoint attribute). You cannot access + // the server by using the generated Endpoint value if the server is using a custom + // domain. If you specify a custom domain, you must also specify values for + // CustomCertificate and CustomPrivateKey. + CustomDomain *string + + // A private key in PEM format for connecting to the server by using HTTPS. The + // private key must not be encrypted; it cannot be protected by a password or + // passphrase. If you specify a custom private key, you must also specify values + // for CustomDomain and CustomCertificate. + CustomPrivateKey *string + + // Enable or disable scheduled backups. Valid values are true or false. The default + // value is true. + DisableAutomatedBackup *bool // Optional engine attributes on a specified server. Attributes accepted in a Chef // createServer request: @@ -211,6 +205,62 @@ type CreateServerInput struct { // private SSH key. EngineAttributes []*types.EngineAttribute + // The engine model of the server. Valid values in this release include Monolithic + // for Puppet and Single for Chef. + EngineModel *string + + // The major release version of the engine that you want to use. For a Chef server, + // the valid value for EngineVersion is currently 2. For a Puppet server, the valid + // value is 2017. + EngineVersion *string + + // The Amazon EC2 key pair to set for the instance. This parameter is optional; if + // desired, you may specify this parameter to connect to your instances by using + // SSH. + KeyPair *string + + // The start time for a one-hour period during which AWS OpsWorks CM backs up + // application-level data on your server if automated backups are enabled. Valid + // values must be specified in one of the following formats: + // + // * HH:MM for daily + // backups + // + // * DDD:HH:MM for weekly backups + // + // MM must be specified as 00. The + // specified time is in coordinated universal time (UTC). The default value is a + // random, daily start time. Example: 08:00, which represents a daily start time of + // 08:00 UTC. Example: Mon:08:00, which represents a start time of every Monday at + // 08:00 UTC. (8:00 a.m.) + PreferredBackupWindow *string + + // The start time for a one-hour period each week during which AWS OpsWorks CM + // performs maintenance on the instance. Valid values must be specified in the + // following format: DDD:HH:MM. MM must be specified as 00. The specified time is + // in coordinated universal time (UTC). The default value is a random one-hour + // period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more + // information. Example: Mon:08:00, which represents a start time of every Monday + // at 08:00 UTC. (8:00 a.m.) + PreferredMaintenanceWindow *string + + // A list of security group IDs to attach to the Amazon EC2 instance. If you add + // this parameter, the specified security groups must be within the VPC that is + // specified by SubnetIds. If you do not specify this parameter, AWS OpsWorks CM + // creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 + // (everyone). + SecurityGroupIds []*string + + // The IDs of subnets in which to launch the server EC2 instance. Amazon + // EC2-Classic customers: This field is required. All servers must run within a + // VPC. The VPC must have "Auto Assign Public IP" enabled. EC2-VPC customers: This + // field is optional. If you do not specify subnet IDs, your EC2 instances are + // created in a default subnet that is selected by Amazon EC2. If you specify + // subnet IDs, the VPC must have "Auto Assign Public IP" enabled. For more + // information about supported Amazon EC2 platforms, see Supported Platforms + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html). + SubnetIds []*string + // A map that contains tag keys and tag values to attach to an AWS OpsWorks for // Chef Automate or AWS OpsWorks for Puppet Enterprise server. // @@ -231,56 +281,6 @@ type CreateServerInput struct { // * A maximum of 50 user-applied tags is // allowed for any AWS OpsWorks-CM server. Tags []*types.Tag - - // A PEM-formatted HTTPS certificate. The value can be be a single, self-signed - // certificate, or a certificate chain. If you specify a custom certificate, you - // must also specify values for CustomDomain and CustomPrivateKey. The following - // are requirements for the CustomCertificate value: - // - // * You can provide either - // a self-signed, custom certificate, or the full certificate chain. - // - // * The - // certificate must be a valid X509 certificate, or a certificate chain in PEM - // format. - // - // * The certificate must be valid at the time of upload. A - // certificate can't be used before its validity period begins (the certificate's - // NotBefore date), or after it expires (the certificate's NotAfter date). - // - // * - // The certificate’s common name or subject alternative names (SANs), if present, - // must match the value of CustomDomain. - // - // * The certificate must match the - // value of CustomPrivateKey. - CustomCertificate *string - - // Associate a public IP address with a server that you are launching. Valid values - // are true or false. The default value is true. - AssociatePublicIpAddress *bool - - // The Amazon EC2 key pair to set for the instance. This parameter is optional; if - // desired, you may specify this parameter to connect to your instances by using - // SSH. - KeyPair *string - - // An optional public endpoint of a server, such as https://aws.my-company.com. To - // access the server, create a CNAME DNS record in your preferred DNS service that - // points the custom domain to the endpoint that is generated when the server is - // created (the value of the CreateServer Endpoint attribute). You cannot access - // the server by using the generated Endpoint value if the server is using a custom - // domain. If you specify a custom domain, you must also specify values for - // CustomCertificate and CustomPrivateKey. - CustomDomain *string - - // The engine model of the server. Valid values in this release include Monolithic - // for Puppet and Single for Chef. - EngineModel *string - - // Enable or disable scheduled backups. Valid values are true or false. The default - // value is true. - DisableAutomatedBackup *bool } type CreateServerOutput struct { diff --git a/service/opsworkscm/api_op_DescribeBackups.go b/service/opsworkscm/api_op_DescribeBackups.go index e80af4f3d0e..f52fdb8ffa8 100644 --- a/service/opsworkscm/api_op_DescribeBackups.go +++ b/service/opsworkscm/api_op_DescribeBackups.go @@ -63,14 +63,14 @@ type DescribeBackupsInput struct { // Describes a single backup. BackupId *string - // Returns backups for the server with the specified ServerName. - ServerName *string + // This is not currently implemented for DescribeBackups requests. + MaxResults *int32 // This is not currently implemented for DescribeBackups requests. NextToken *string - // This is not currently implemented for DescribeBackups requests. - MaxResults *int32 + // Returns backups for the server with the specified ServerName. + ServerName *string } type DescribeBackupsOutput struct { diff --git a/service/opsworkscm/api_op_DescribeEvents.go b/service/opsworkscm/api_op_DescribeEvents.go index 6df8e0f1aea..00c5f46ba44 100644 --- a/service/opsworkscm/api_op_DescribeEvents.go +++ b/service/opsworkscm/api_op_DescribeEvents.go @@ -65,6 +65,12 @@ type DescribeEventsInput struct { // This member is required. ServerName *string + // To receive a paginated response, use this parameter to specify the maximum + // number of results to be returned with a single call. If the number of available + // results exceeds this maximum, the response includes a NextToken value that you + // can assign to the NextToken request parameter to get the next set of results. + MaxResults *int32 + // NextToken is a string that is returned in some command responses. It indicates // that not all entries have been returned, and that you must run at least one more // request to get remaining items. To get remaining results, call DescribeEvents @@ -73,19 +79,10 @@ type DescribeEventsInput struct { // nextToken parameter value is null. Setting a nextToken value that was not // returned in your previous results causes an InvalidNextTokenException to occur. NextToken *string - - // To receive a paginated response, use this parameter to specify the maximum - // number of results to be returned with a single call. If the number of available - // results exceeds this maximum, the response includes a NextToken value that you - // can assign to the NextToken request parameter to get the next set of results. - MaxResults *int32 } type DescribeEventsOutput struct { - // Contains the response to a DescribeEvents request. - ServerEvents []*types.ServerEvent - // NextToken is a string that is returned in some command responses. It indicates // that not all entries have been returned, and that you must run at least one more // request to get remaining items. To get remaining results, call DescribeEvents @@ -95,6 +92,9 @@ type DescribeEventsOutput struct { // returned in your previous results causes an InvalidNextTokenException to occur. NextToken *string + // Contains the response to a DescribeEvents request. + ServerEvents []*types.ServerEvent + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/opsworkscm/api_op_DescribeNodeAssociationStatus.go b/service/opsworkscm/api_op_DescribeNodeAssociationStatus.go index bad4c260017..6122e571824 100644 --- a/service/opsworkscm/api_op_DescribeNodeAssociationStatus.go +++ b/service/opsworkscm/api_op_DescribeNodeAssociationStatus.go @@ -61,20 +61,24 @@ func (c *Client) DescribeNodeAssociationStatus(ctx context.Context, params *Desc type DescribeNodeAssociationStatusInput struct { - // The name of the server from which to disassociate the node. - // - // This member is required. - ServerName *string - // The token returned in either the AssociateNodeResponse or the // DisassociateNodeResponse. // // This member is required. NodeAssociationStatusToken *string + + // The name of the server from which to disassociate the node. + // + // This member is required. + ServerName *string } type DescribeNodeAssociationStatusOutput struct { + // Attributes specific to the node association. In Puppet, the attibute + // PUPPET_NODE_CERT contains the signed certificate (the result of the CSR). + EngineAttributes []*types.EngineAttribute + // The status of the association or disassociation request. Possible values: // // * @@ -87,10 +91,6 @@ type DescribeNodeAssociationStatusOutput struct { // disassociation is still in progress. NodeAssociationStatus types.NodeAssociationStatus - // Attributes specific to the node association. In Puppet, the attibute - // PUPPET_NODE_CERT contains the signed certificate (the result of the CSR). - EngineAttributes []*types.EngineAttribute - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/opsworkscm/api_op_DescribeServers.go b/service/opsworkscm/api_op_DescribeServers.go index 72d2f244272..b08ec26922b 100644 --- a/service/opsworkscm/api_op_DescribeServers.go +++ b/service/opsworkscm/api_op_DescribeServers.go @@ -60,18 +60,21 @@ func (c *Client) DescribeServers(ctx context.Context, params *DescribeServersInp type DescribeServersInput struct { + // This is not currently implemented for DescribeServers requests. + MaxResults *int32 + // This is not currently implemented for DescribeServers requests. NextToken *string // Describes the server with the specified ServerName. ServerName *string - - // This is not currently implemented for DescribeServers requests. - MaxResults *int32 } type DescribeServersOutput struct { + // This is not currently implemented for DescribeServers requests. + NextToken *string + // Contains the response to a DescribeServers request. For Chef Automate servers: // If DescribeServersResponse$Servers$EngineAttributes includes // CHEF_MAJOR_UPGRADE_AVAILABLE, you can upgrade the Chef Automate server to Chef @@ -83,9 +86,6 @@ type DescribeServersOutput struct { // node certificates. Servers []*types.Server - // This is not currently implemented for DescribeServers requests. - NextToken *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/opsworkscm/api_op_DisassociateNode.go b/service/opsworkscm/api_op_DisassociateNode.go index dc5eb14b67a..7c2953e9aaf 100644 --- a/service/opsworkscm/api_op_DisassociateNode.go +++ b/service/opsworkscm/api_op_DisassociateNode.go @@ -69,6 +69,11 @@ type DisassociateNodeInput struct { // This member is required. NodeName *string + // The name of the server from which to disassociate the node. + // + // This member is required. + ServerName *string + // Engine attributes that are used for disassociating the node. No attributes are // required for Puppet. Attributes required in a DisassociateNode request for // Chef @@ -76,11 +81,6 @@ type DisassociateNodeInput struct { // * CHEF_ORGANIZATION: The Chef organization with which the node was // associated. By default only one organization named default can exist. EngineAttributes []*types.EngineAttribute - - // The name of the server from which to disassociate the node. - // - // This member is required. - ServerName *string } type DisassociateNodeOutput struct { diff --git a/service/opsworkscm/api_op_ListTagsForResource.go b/service/opsworkscm/api_op_ListTagsForResource.go index 7a1e3e87982..a9679ad9db8 100644 --- a/service/opsworkscm/api_op_ListTagsForResource.go +++ b/service/opsworkscm/api_op_ListTagsForResource.go @@ -58,6 +58,20 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { + // The Amazon Resource Number (ARN) of an AWS OpsWorks for Chef Automate or AWS + // OpsWorks for Puppet Enterprise server for which you want to show applied tags. + // For example, + // arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE. + // + // This member is required. + ResourceArn *string + + // To receive a paginated response, use this parameter to specify the maximum + // number of results to be returned with a single call. If the number of available + // results exceeds this maximum, the response includes a NextToken value that you + // can assign to the NextToken request parameter to get the next set of results. + MaxResults *int32 + // NextToken is a string that is returned in some command responses. It indicates // that not all entries have been returned, and that you must run at least one more // request to get remaining items. To get remaining results, call @@ -67,20 +81,6 @@ type ListTagsForResourceInput struct { // not returned in your previous results causes an InvalidNextTokenException to // occur. NextToken *string - - // To receive a paginated response, use this parameter to specify the maximum - // number of results to be returned with a single call. If the number of available - // results exceeds this maximum, the response includes a NextToken value that you - // can assign to the NextToken request parameter to get the next set of results. - MaxResults *int32 - - // The Amazon Resource Number (ARN) of an AWS OpsWorks for Chef Automate or AWS - // OpsWorks for Puppet Enterprise server for which you want to show applied tags. - // For example, - // arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE. - // - // This member is required. - ResourceArn *string } type ListTagsForResourceOutput struct { diff --git a/service/opsworkscm/api_op_RestoreServer.go b/service/opsworkscm/api_op_RestoreServer.go index ea14c4b29c4..59ef620a577 100644 --- a/service/opsworkscm/api_op_RestoreServer.go +++ b/service/opsworkscm/api_op_RestoreServer.go @@ -68,15 +68,15 @@ func (c *Client) RestoreServer(ctx context.Context, params *RestoreServerInput, type RestoreServerInput struct { - // The name of the server that you want to restore. + // The ID of the backup that you want to use to restore a server. // // This member is required. - ServerName *string + BackupId *string - // The ID of the backup that you want to use to restore a server. + // The name of the server that you want to restore. // // This member is required. - BackupId *string + ServerName *string // The type of instance to restore. Valid values must be specified in the following // format: ^([cm][34]|t2).* For example, m5.large. Valid values are m5.large, diff --git a/service/opsworkscm/api_op_StartMaintenance.go b/service/opsworkscm/api_op_StartMaintenance.go index aed5c2eccc9..0e918e5cebc 100644 --- a/service/opsworkscm/api_op_StartMaintenance.go +++ b/service/opsworkscm/api_op_StartMaintenance.go @@ -63,6 +63,11 @@ func (c *Client) StartMaintenance(ctx context.Context, params *StartMaintenanceI type StartMaintenanceInput struct { + // The name of the server on which to run maintenance. + // + // This member is required. + ServerName *string + // Engine attributes that are specific to the server on which you want to run // maintenance. Attributes accepted in a StartMaintenance request for Chef // @@ -73,11 +78,6 @@ type StartMaintenanceInput struct { // see Upgrade an AWS OpsWorks for Chef Automate Server to Chef Automate 2 // (https://docs.aws.amazon.com/opsworks/latest/userguide/opscm-a2upgrade.html). EngineAttributes []*types.EngineAttribute - - // The name of the server on which to run maintenance. - // - // This member is required. - ServerName *string } type StartMaintenanceOutput struct { diff --git a/service/opsworkscm/api_op_UntagResource.go b/service/opsworkscm/api_op_UntagResource.go index d39d5eb65d8..56826836724 100644 --- a/service/opsworkscm/api_op_UntagResource.go +++ b/service/opsworkscm/api_op_UntagResource.go @@ -56,17 +56,17 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The keys of tags that you want to remove. - // - // This member is required. - TagKeys []*string - // The Amazon Resource Number (ARN) of a resource from which you want to remove // tags. For example, // arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE. // // This member is required. ResourceArn *string + + // The keys of tags that you want to remove. + // + // This member is required. + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/opsworkscm/api_op_UpdateServer.go b/service/opsworkscm/api_op_UpdateServer.go index 85dfbfacad2..75fdd6c48ad 100644 --- a/service/opsworkscm/api_op_UpdateServer.go +++ b/service/opsworkscm/api_op_UpdateServer.go @@ -57,11 +57,6 @@ func (c *Client) UpdateServer(ctx context.Context, params *UpdateServerInput, op type UpdateServerInput struct { - // DDD:HH:MM (weekly start time) or HH:MM (daily start time). Time windows always - // use coordinated universal time (UTC). Valid strings for day of week (DDD) are: - // Mon, Tue, Wed, Thr, Fri, Sat, or Sun. - PreferredBackupWindow *string - // The name of the server to update. // // This member is required. @@ -70,14 +65,19 @@ type UpdateServerInput struct { // Sets the number of automated backups that you want to keep. BackupRetentionCount *int32 + // Setting DisableAutomatedBackup to true disables automated or scheduled backups. + // Automated backups are enabled by default. + DisableAutomatedBackup *bool + // DDD:HH:MM (weekly start time) or HH:MM (daily start time). Time windows always // use coordinated universal time (UTC). Valid strings for day of week (DDD) are: // Mon, Tue, Wed, Thr, Fri, Sat, or Sun. - PreferredMaintenanceWindow *string + PreferredBackupWindow *string - // Setting DisableAutomatedBackup to true disables automated or scheduled backups. - // Automated backups are enabled by default. - DisableAutomatedBackup *bool + // DDD:HH:MM (weekly start time) or HH:MM (daily start time). Time windows always + // use coordinated universal time (UTC). Valid strings for day of week (DDD) are: + // Mon, Tue, Wed, Thr, Fri, Sat, or Sun. + PreferredMaintenanceWindow *string } type UpdateServerOutput struct { diff --git a/service/opsworkscm/go.mod b/service/opsworkscm/go.mod index 06f61bc77b4..a42c7dd22f0 100644 --- a/service/opsworkscm/go.mod +++ b/service/opsworkscm/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/opsworkscm go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/opsworkscm/types/types.go b/service/opsworkscm/types/types.go index 989fbc16b27..ec5ce25cba2 100644 --- a/service/opsworkscm/types/types.go +++ b/service/opsworkscm/types/types.go @@ -9,6 +9,9 @@ import ( // Stores account attributes. type AccountAttribute struct { + // The maximum allowed value. + Maximum *int32 + // The attribute name. The following are supported attribute names. // // * @@ -20,9 +23,6 @@ type AccountAttribute struct { // you can have a maximum of 50 manual backups saved. Name *string - // The maximum allowed value. - Maximum *int32 - // The current usage, such as the current number of servers that are associated // with the account. Used *int32 @@ -31,87 +31,87 @@ type AccountAttribute struct { // Describes a single backup. type Backup struct { + // The ARN of the backup. + BackupArn *string + // The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS BackupId *string - // An informational message about backup status. - StatusDescription *string - - // The Amazon S3 URL of the backup's log file. - S3LogUrl *string + // The backup type. Valid values are automated or manual. + BackupType BackupType - // The status of a backup while in progress. - Status BackupStatus + // The time stamp when the backup was created in the database. Example: + // 2016-07-29T13:38:47.520Z + CreatedAt *time.Time - // The version of AWS OpsWorks CM-specific tools that is obtained from the server - // when the backup is created. - ToolsVersion *string + // A user-provided description for a manual backup. This field is empty for + // automated backups. + Description *string // The engine type that is obtained from the server when the backup is created. Engine *string - // The backup type. Valid values are automated or manual. - BackupType BackupType - // The engine model that is obtained from the server when the backup is created. EngineModel *string + // The engine version that is obtained from the server when the backup is created. + EngineVersion *string + + // The EC2 instance profile ARN that is obtained from the server when the backup is + // created. Because this value is stored, you are not required to provide the + // InstanceProfileArn again if you restore a backup. + InstanceProfileArn *string + // The instance type that is obtained from the server when the backup is created. InstanceType *string - // A user-provided description for a manual backup. This field is empty for - // automated backups. - Description *string - // The key pair that is obtained from the server when the backup is created. KeyPair *string - // The IAM user ARN of the requester for manual backups. This field is empty for - // automated backups. - UserArn *string + // The preferred backup period that is obtained from the server when the backup is + // created. + PreferredBackupWindow *string + + // The preferred maintenance period that is obtained from the server when the + // backup is created. + PreferredMaintenanceWindow *string // This field is deprecated and is no longer used. S3DataSize *int32 - // The service role ARN that is obtained from the server when the backup is + // This field is deprecated and is no longer used. + S3DataUrl *string + + // The Amazon S3 URL of the backup's log file. + S3LogUrl *string + + // The security group IDs that are obtained from the server when the backup is // created. - ServiceRoleArn *string + SecurityGroupIds []*string // The name of the server from which the backup was made. ServerName *string - // The time stamp when the backup was created in the database. Example: - // 2016-07-29T13:38:47.520Z - CreatedAt *time.Time - - // The ARN of the backup. - BackupArn *string + // The service role ARN that is obtained from the server when the backup is + // created. + ServiceRoleArn *string - // The engine version that is obtained from the server when the backup is created. - EngineVersion *string + // The status of a backup while in progress. + Status BackupStatus - // The security group IDs that are obtained from the server when the backup is - // created. - SecurityGroupIds []*string + // An informational message about backup status. + StatusDescription *string // The subnet IDs that are obtained from the server when the backup is created. SubnetIds []*string - // The preferred maintenance period that is obtained from the server when the - // backup is created. - PreferredMaintenanceWindow *string - - // The preferred backup period that is obtained from the server when the backup is - // created. - PreferredBackupWindow *string - - // This field is deprecated and is no longer used. - S3DataUrl *string + // The version of AWS OpsWorks CM-specific tools that is obtained from the server + // when the backup is created. + ToolsVersion *string - // The EC2 instance profile ARN that is obtained from the server when the backup is - // created. Because this value is stored, you are not required to provide the - // InstanceProfileArn again if you restore a backup. - InstanceProfileArn *string + // The IAM user ARN of the requester for manual backups. This field is empty for + // automated backups. + UserArn *string } // A name and value pair that is specific to the engine of the server. @@ -127,17 +127,35 @@ type EngineAttribute struct { // Describes a configuration management server. type Server struct { + // Associate a public IP address with a server that you are launching. + AssociatePublicIpAddress *bool + + // The number of automated backups to keep. + BackupRetentionCount *int32 + + // The ARN of the CloudFormation stack that was used to create the server. + CloudFormationStackArn *string + + // Time stamp of server creation. Example 2016-07-29T13:38:47.520Z + CreatedAt *time.Time + + // An optional public endpoint of a server, such as https://aws.my-company.com. You + // cannot access the server by using the Endpoint value if the server has a + // CustomDomain specified. + CustomDomain *string + + // Disables automated backups. The number of stored backups is dependent on the + // value of PreferredBackupCount. + DisableAutomatedBackup *bool + // A DNS name that can be used to access the engine. Example: // myserver-asdfghjkl.us-east-1.opsworks.io. You cannot access the server by using // the Endpoint value if the server has a CustomDomain specified. Endpoint *string - // The engine model of the server. Valid values in this release include Monolithic - // for Puppet and Single for Chef. - EngineModel *string - - // The preferred maintenance period specified for the server. - PreferredMaintenanceWindow *string + // The engine type of the server. Valid values in this release include ChefAutomate + // and Puppet. + Engine *string // The response of a createServer() request returns the master credential to access // the server in EngineAttributes. These credentials are not stored by AWS OpsWorks @@ -167,76 +185,58 @@ type Server struct { // use to sign in to the Puppet Enterprise console after the server is online. EngineAttributes []*EngineAttribute - // The name of the server. - ServerName *string + // The engine model of the server. Valid values in this release include Monolithic + // for Puppet and Single for Chef. + EngineModel *string - // Disables automated backups. The number of stored backups is dependent on the - // value of PreferredBackupCount. - DisableAutomatedBackup *bool + // The engine version of the server. For a Chef server, the valid value for + // EngineVersion is currently 2. For a Puppet server, the valid value is 2017. + EngineVersion *string - // The service role ARN used to create the server. - ServiceRoleArn *string + // The instance profile ARN of the server. + InstanceProfileArn *string - // Time stamp of server creation. Example 2016-07-29T13:38:47.520Z - CreatedAt *time.Time + // The instance type for the server, as specified in the CloudFormation stack. This + // might not be the same instance type that is shown in the EC2 console. + InstanceType *string // The key pair associated with the server. KeyPair *string - // The instance profile ARN of the server. - InstanceProfileArn *string - - // Associate a public IP address with a server that you are launching. - AssociatePublicIpAddress *bool - - // The subnet IDs specified in a CreateServer request. - SubnetIds []*string + // The status of the most recent server maintenance run. Shows SUCCESS or FAILED. + MaintenanceStatus MaintenanceStatus // The preferred backup period specified for the server. PreferredBackupWindow *string - // Depending on the server status, this field has either a human-readable message - // (such as a create or backup error), or an escaped block of JSON (used for health - // check results). - StatusReason *string - - // The engine type of the server. Valid values in this release include ChefAutomate - // and Puppet. - Engine *string - - // The number of automated backups to keep. - BackupRetentionCount *int32 + // The preferred maintenance period specified for the server. + PreferredMaintenanceWindow *string // The security group IDs for the server, as specified in the CloudFormation stack. // These might not be the same security groups that are shown in the EC2 console. SecurityGroupIds []*string - // The engine version of the server. For a Chef server, the valid value for - // EngineVersion is currently 2. For a Puppet server, the valid value is 2017. - EngineVersion *string - - // An optional public endpoint of a server, such as https://aws.my-company.com. You - // cannot access the server by using the Endpoint value if the server has a - // CustomDomain specified. - CustomDomain *string - // The ARN of the server. ServerArn *string - // The ARN of the CloudFormation stack that was used to create the server. - CloudFormationStackArn *string + // The name of the server. + ServerName *string + + // The service role ARN used to create the server. + ServiceRoleArn *string // The server's status. This field displays the states of actions in progress, such // as creating, running, or backing up the server, as well as the server's health // state. Status ServerStatus - // The status of the most recent server maintenance run. Shows SUCCESS or FAILED. - MaintenanceStatus MaintenanceStatus + // Depending on the server status, this field has either a human-readable message + // (such as a create or backup error), or an escaped block of JSON (used for health + // check results). + StatusReason *string - // The instance type for the server, as specified in the CloudFormation stack. This - // might not be the same instance type that is shown in the EC2 console. - InstanceType *string + // The subnet IDs specified in a CreateServer request. + SubnetIds []*string } // An event that is related to the server, such as the start of maintenance or @@ -246,12 +246,12 @@ type ServerEvent struct { // The time when the event occurred. CreatedAt *time.Time - // A human-readable informational or status message. - Message *string - // The Amazon S3 URL of the event's log file. LogUrl *string + // A human-readable informational or status message. + Message *string + // The name of the server on or for which the event occurred. ServerName *string } diff --git a/service/organizations/api_op_AttachPolicy.go b/service/organizations/api_op_AttachPolicy.go index c9e57b90834..f7644077c11 100644 --- a/service/organizations/api_op_AttachPolicy.go +++ b/service/organizations/api_op_AttachPolicy.go @@ -77,6 +77,15 @@ func (c *Client) AttachPolicy(ctx context.Context, params *AttachPolicyInput, op type AttachPolicyInput struct { + // The unique identifier (ID) of the policy that you want to attach to the target. + // You can get the ID for the policy by calling the ListPolicies () operation. The + // regex pattern (http://wikipedia.org/wiki/regex) for a policy ID string requires + // "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the + // underscore character (_). + // + // This member is required. + PolicyId *string + // The unique identifier (ID) of the root, OU, or account that you want to attach // the policy to. You can get the ID by calling the ListRoots (), // ListOrganizationalUnitsForParent (), or ListAccounts () operations. The regex @@ -96,15 +105,6 @@ type AttachPolicyInput struct { // // This member is required. TargetId *string - - // The unique identifier (ID) of the policy that you want to attach to the target. - // You can get the ID for the policy by calling the ListPolicies () operation. The - // regex pattern (http://wikipedia.org/wiki/regex) for a policy ID string requires - // "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the - // underscore character (_). - // - // This member is required. - PolicyId *string } type AttachPolicyOutput struct { diff --git a/service/organizations/api_op_CreateAccount.go b/service/organizations/api_op_CreateAccount.go index 5dac7994bbb..a67846b974e 100644 --- a/service/organizations/api_op_CreateAccount.go +++ b/service/organizations/api_op_CreateAccount.go @@ -126,6 +126,30 @@ func (c *Client) CreateAccount(ctx context.Context, params *CreateAccountInput, type CreateAccountInput struct { + // The friendly name of the member account. + // + // This member is required. + AccountName *string + + // The email address of the owner to assign to the new member account. This email + // address must not already be associated with another AWS account. You must use a + // valid email address to complete account creation. You can't access the root user + // of the account or remove an account that was created with an invalid email + // address. + // + // This member is required. + Email *string + + // If set to ALLOW, the new account enables IAM users to access account billing + // information if they have the required permissions. If set to DENY, only the root + // user of the new account can access account billing information. For more + // information, see Activating Access to the Billing and Cost Management Console + // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate) + // in the AWS Billing and Cost Management User Guide. If you don't specify this + // parameter, the value defaults to ALLOW, and IAM users and roles with the + // required permissions can access billing information for the new account. + IamUserAccessToBilling types.IAMUserAccessToBilling + // (Optional) The name of an IAM role that AWS Organizations automatically // preconfigures in the new member account. This role trusts the master account, // allowing users in the master account to assume the role, as permitted by the @@ -149,30 +173,6 @@ type CreateAccountInput struct { // lowercase letters, digits with no spaces, and any of the following characters: // =,.@- RoleName *string - - // If set to ALLOW, the new account enables IAM users to access account billing - // information if they have the required permissions. If set to DENY, only the root - // user of the new account can access account billing information. For more - // information, see Activating Access to the Billing and Cost Management Console - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate) - // in the AWS Billing and Cost Management User Guide. If you don't specify this - // parameter, the value defaults to ALLOW, and IAM users and roles with the - // required permissions can access billing information for the new account. - IamUserAccessToBilling types.IAMUserAccessToBilling - - // The email address of the owner to assign to the new member account. This email - // address must not already be associated with another AWS account. You must use a - // valid email address to complete account creation. You can't access the root user - // of the account or remove an account that was created with an invalid email - // address. - // - // This member is required. - Email *string - - // The friendly name of the member account. - // - // This member is required. - AccountName *string } type CreateAccountOutput struct { diff --git a/service/organizations/api_op_CreateGovCloudAccount.go b/service/organizations/api_op_CreateGovCloudAccount.go index 177122e9fae..e5ae4f0b90b 100644 --- a/service/organizations/api_op_CreateGovCloudAccount.go +++ b/service/organizations/api_op_CreateGovCloudAccount.go @@ -161,6 +161,11 @@ func (c *Client) CreateGovCloudAccount(ctx context.Context, params *CreateGovClo type CreateGovCloudAccountInput struct { + // The friendly name of the member account. + // + // This member is required. + AccountName *string + // The email address of the owner to assign to the new member account in the // commercial Region. This email address must not already be associated with // another AWS account. You must use a valid email address to complete account @@ -202,11 +207,6 @@ type CreateGovCloudAccountInput struct { // lowercase letters, digits with no spaces, and any of the following characters: // =,.@- RoleName *string - - // The friendly name of the member account. - // - // This member is required. - AccountName *string } type CreateGovCloudAccountOutput struct { diff --git a/service/organizations/api_op_CreatePolicy.go b/service/organizations/api_op_CreatePolicy.go index d44b5ea08e4..1f511a0f97e 100644 --- a/service/organizations/api_op_CreatePolicy.go +++ b/service/organizations/api_op_CreatePolicy.go @@ -61,6 +61,24 @@ func (c *Client) CreatePolicy(ctx context.Context, params *CreatePolicyInput, op type CreatePolicyInput struct { + // The policy text content to add to the new policy. The text that you supply must + // adhere to the rules of the policy type you specify in the Type parameter. + // + // This member is required. + Content *string + + // An optional description to assign to the policy. + // + // This member is required. + Description *string + + // The friendly name to assign to the policy. The regex pattern + // (http://wikipedia.org/wiki/regex) that is used to validate this parameter is a + // string of any of the characters in the ASCII character range. + // + // This member is required. + Name *string + // The type of policy to create. You can specify one of the following values: // // @@ -81,24 +99,6 @@ type CreatePolicyInput struct { // // This member is required. Type types.PolicyType - - // An optional description to assign to the policy. - // - // This member is required. - Description *string - - // The policy text content to add to the new policy. The text that you supply must - // adhere to the rules of the policy type you specify in the Type parameter. - // - // This member is required. - Content *string - - // The friendly name to assign to the policy. The regex pattern - // (http://wikipedia.org/wiki/regex) that is used to validate this parameter is a - // string of any of the characters in the ASCII character range. - // - // This member is required. - Name *string } type CreatePolicyOutput struct { diff --git a/service/organizations/api_op_DisablePolicyType.go b/service/organizations/api_op_DisablePolicyType.go index 61e30f7b551..267e4794a2c 100644 --- a/service/organizations/api_op_DisablePolicyType.go +++ b/service/organizations/api_op_DisablePolicyType.go @@ -70,14 +70,6 @@ func (c *Client) DisablePolicyType(ctx context.Context, params *DisablePolicyTyp type DisablePolicyTypeInput struct { - // The unique identifier (ID) of the root in which you want to disable a policy - // type. You can get the ID from the ListRoots () operation. The regex pattern - // (http://wikipedia.org/wiki/regex) for a root ID string requires "r-" followed by - // from 4 to 32 lowercase letters or digits. - // - // This member is required. - RootId *string - // The policy type that you want to disable in this root. You can specify one of // the following values: // @@ -98,6 +90,14 @@ type DisablePolicyTypeInput struct { // // This member is required. PolicyType types.PolicyType + + // The unique identifier (ID) of the root in which you want to disable a policy + // type. You can get the ID from the ListRoots () operation. The regex pattern + // (http://wikipedia.org/wiki/regex) for a root ID string requires "r-" followed by + // from 4 to 32 lowercase letters or digits. + // + // This member is required. + RootId *string } type DisablePolicyTypeOutput struct { diff --git a/service/organizations/api_op_ListAWSServiceAccessForOrganization.go b/service/organizations/api_op_ListAWSServiceAccessForOrganization.go index 6f2916c9ea8..3cc96543ed9 100644 --- a/service/organizations/api_op_ListAWSServiceAccessForOrganization.go +++ b/service/organizations/api_op_ListAWSServiceAccessForOrganization.go @@ -65,12 +65,6 @@ func (c *Client) ListAWSServiceAccessForOrganization(ctx context.Context, params type ListAWSServiceAccessForOrganizationInput struct { - // The parameter for receiving additional results if you receive a NextToken - // response in a previous request. A NextToken response indicates that more output - // is available. Set this parameter to the value of the previous call's NextToken - // response to indicate where the output should continue from. - NextToken *string - // The total number of results that you want included on each page of the response. // If you do not include this parameter, it defaults to a value that is specific to // the operation. If additional items exist beyond the maximum you specify, the @@ -81,21 +75,27 @@ type ListAWSServiceAccessForOrganizationInput struct { // check NextToken after every operation to ensure that you receive all of the // results. MaxResults *int32 + + // The parameter for receiving additional results if you receive a NextToken + // response in a previous request. A NextToken response indicates that more output + // is available. Set this parameter to the value of the previous call's NextToken + // response to indicate where the output should continue from. + NextToken *string } type ListAWSServiceAccessForOrganizationOutput struct { + // A list of the service principals for the services that are enabled to integrate + // with your organization. Each principal is a structure that includes the name and + // the date that it was enabled for integration with AWS Organizations. + EnabledServicePrincipals []*types.EnabledServicePrincipal + // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null. NextToken *string - // A list of the service principals for the services that are enabled to integrate - // with your organization. Each principal is a structure that includes the name and - // the date that it was enabled for integration with AWS Organizations. - EnabledServicePrincipals []*types.EnabledServicePrincipal - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/organizations/api_op_ListAccounts.go b/service/organizations/api_op_ListAccounts.go index eca8f57f55b..2be49d5226c 100644 --- a/service/organizations/api_op_ListAccounts.go +++ b/service/organizations/api_op_ListAccounts.go @@ -64,12 +64,6 @@ func (c *Client) ListAccounts(ctx context.Context, params *ListAccountsInput, op type ListAccountsInput struct { - // The parameter for receiving additional results if you receive a NextToken - // response in a previous request. A NextToken response indicates that more output - // is available. Set this parameter to the value of the previous call's NextToken - // response to indicate where the output should continue from. - NextToken *string - // The total number of results that you want included on each page of the response. // If you do not include this parameter, it defaults to a value that is specific to // the operation. If additional items exist beyond the maximum you specify, the @@ -80,6 +74,12 @@ type ListAccountsInput struct { // check NextToken after every operation to ensure that you receive all of the // results. MaxResults *int32 + + // The parameter for receiving additional results if you receive a NextToken + // response in a previous request. A NextToken response indicates that more output + // is available. Set this parameter to the value of the previous call's NextToken + // response to indicate where the output should continue from. + NextToken *string } type ListAccountsOutput struct { diff --git a/service/organizations/api_op_ListCreateAccountStatus.go b/service/organizations/api_op_ListCreateAccountStatus.go index d33e25ba293..7a4692143cd 100644 --- a/service/organizations/api_op_ListCreateAccountStatus.go +++ b/service/organizations/api_op_ListCreateAccountStatus.go @@ -63,16 +63,6 @@ func (c *Client) ListCreateAccountStatus(ctx context.Context, params *ListCreate type ListCreateAccountStatusInput struct { - // A list of one or more states that you want included in the response. If this - // parameter isn't present, all requests are included in the response. - States []types.CreateAccountState - - // The parameter for receiving additional results if you receive a NextToken - // response in a previous request. A NextToken response indicates that more output - // is available. Set this parameter to the value of the previous call's NextToken - // response to indicate where the output should continue from. - NextToken *string - // The total number of results that you want included on each page of the response. // If you do not include this parameter, it defaults to a value that is specific to // the operation. If additional items exist beyond the maximum you specify, the @@ -83,21 +73,31 @@ type ListCreateAccountStatusInput struct { // check NextToken after every operation to ensure that you receive all of the // results. MaxResults *int32 + + // The parameter for receiving additional results if you receive a NextToken + // response in a previous request. A NextToken response indicates that more output + // is available. Set this parameter to the value of the previous call's NextToken + // response to indicate where the output should continue from. + NextToken *string + + // A list of one or more states that you want included in the response. If this + // parameter isn't present, all requests are included in the response. + States []types.CreateAccountState } type ListCreateAccountStatusOutput struct { + // A list of objects with details about the requests. Certain elements, such as the + // accountId number, are present in the output only after the account has been + // successfully created. + CreateAccountStatuses []*types.CreateAccountStatus + // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null. NextToken *string - // A list of objects with details about the requests. Certain elements, such as the - // accountId number, are present in the output only after the account has been - // successfully created. - CreateAccountStatuses []*types.CreateAccountStatus - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/organizations/api_op_ListDelegatedAdministrators.go b/service/organizations/api_op_ListDelegatedAdministrators.go index 716659de8c1..98eb0b18700 100644 --- a/service/organizations/api_op_ListDelegatedAdministrators.go +++ b/service/organizations/api_op_ListDelegatedAdministrators.go @@ -70,17 +70,17 @@ type ListDelegatedAdministratorsInput struct { // results. MaxResults *int32 - // Specifies a service principal name. If specified, then the operation lists the - // delegated administrators only for the specified service. If you don't specify a - // service principal, the operation lists all delegated administrators for all - // services in your organization. - ServicePrincipal *string - // The parameter for receiving additional results if you receive a NextToken // response in a previous request. A NextToken response indicates that more output // is available. Set this parameter to the value of the previous call's NextToken // response to indicate where the output should continue from. NextToken *string + + // Specifies a service principal name. If specified, then the operation lists the + // delegated administrators only for the specified service. If you don't specify a + // service principal, the operation lists all delegated administrators for all + // services in your organization. + ServicePrincipal *string } type ListDelegatedAdministratorsOutput struct { diff --git a/service/organizations/api_op_ListDelegatedServicesForAccount.go b/service/organizations/api_op_ListDelegatedServicesForAccount.go index 980693d4cbd..13e665a6ad3 100644 --- a/service/organizations/api_op_ListDelegatedServicesForAccount.go +++ b/service/organizations/api_op_ListDelegatedServicesForAccount.go @@ -85,15 +85,15 @@ type ListDelegatedServicesForAccountInput struct { type ListDelegatedServicesForAccountOutput struct { + // The services for which the account is a delegated administrator. + DelegatedServices []*types.DelegatedService + // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null. NextToken *string - // The services for which the account is a delegated administrator. - DelegatedServices []*types.DelegatedService - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/organizations/api_op_ListHandshakesForOrganization.go b/service/organizations/api_op_ListHandshakesForOrganization.go index 802edbfaa2e..fd51d8b7c12 100644 --- a/service/organizations/api_op_ListHandshakesForOrganization.go +++ b/service/organizations/api_op_ListHandshakesForOrganization.go @@ -95,16 +95,16 @@ type ListHandshakesForOrganizationInput struct { type ListHandshakesForOrganizationOutput struct { + // A list of Handshake () objects with details about each of the handshakes that + // are associated with an organization. + Handshakes []*types.Handshake + // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null. NextToken *string - // A list of Handshake () objects with details about each of the handshakes that - // are associated with an organization. - Handshakes []*types.Handshake - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/organizations/api_op_ListOrganizationalUnitsForParent.go b/service/organizations/api_op_ListOrganizationalUnitsForParent.go index 416a53b5194..d85b9050cce 100644 --- a/service/organizations/api_op_ListOrganizationalUnitsForParent.go +++ b/service/organizations/api_op_ListOrganizationalUnitsForParent.go @@ -79,12 +79,6 @@ type ListOrganizationalUnitsForParentInput struct { // This member is required. ParentId *string - // The parameter for receiving additional results if you receive a NextToken - // response in a previous request. A NextToken response indicates that more output - // is available. Set this parameter to the value of the previous call's NextToken - // response to indicate where the output should continue from. - NextToken *string - // The total number of results that you want included on each page of the response. // If you do not include this parameter, it defaults to a value that is specific to // the operation. If additional items exist beyond the maximum you specify, the @@ -95,6 +89,12 @@ type ListOrganizationalUnitsForParentInput struct { // check NextToken after every operation to ensure that you receive all of the // results. MaxResults *int32 + + // The parameter for receiving additional results if you receive a NextToken + // response in a previous request. A NextToken response indicates that more output + // is available. Set this parameter to the value of the previous call's NextToken + // response to indicate where the output should continue from. + NextToken *string } type ListOrganizationalUnitsForParentOutput struct { diff --git a/service/organizations/api_op_ListParents.go b/service/organizations/api_op_ListParents.go index 990a049e94d..1133760cea9 100644 --- a/service/organizations/api_op_ListParents.go +++ b/service/organizations/api_op_ListParents.go @@ -66,12 +66,6 @@ func (c *Client) ListParents(ctx context.Context, params *ListParentsInput, optF type ListParentsInput struct { - // The parameter for receiving additional results if you receive a NextToken - // response in a previous request. A NextToken response indicates that more output - // is available. Set this parameter to the value of the previous call's NextToken - // response to indicate where the output should continue from. - NextToken *string - // The unique identifier (ID) of the OU or account whose parent containers you want // to list. Don't specify a root. The regex pattern // (http://wikipedia.org/wiki/regex) for a child ID string requires one of the @@ -98,19 +92,25 @@ type ListParentsInput struct { // check NextToken after every operation to ensure that you receive all of the // results. MaxResults *int32 + + // The parameter for receiving additional results if you receive a NextToken + // response in a previous request. A NextToken response indicates that more output + // is available. Set this parameter to the value of the previous call's NextToken + // response to indicate where the output should continue from. + NextToken *string } type ListParentsOutput struct { - // A list of parents for the specified child account or OU. - Parents []*types.Parent - // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null. NextToken *string + // A list of parents for the specified child account or OU. + Parents []*types.Parent + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/organizations/api_op_ListPolicies.go b/service/organizations/api_op_ListPolicies.go index f306926f064..06e4800fff5 100644 --- a/service/organizations/api_op_ListPolicies.go +++ b/service/organizations/api_op_ListPolicies.go @@ -63,12 +63,6 @@ func (c *Client) ListPolicies(ctx context.Context, params *ListPoliciesInput, op type ListPoliciesInput struct { - // The parameter for receiving additional results if you receive a NextToken - // response in a previous request. A NextToken response indicates that more output - // is available. Set this parameter to the value of the previous call's NextToken - // response to indicate where the output should continue from. - NextToken *string - // Specifies the type of policy that you want to include in the response. You must // specify one of the following values: // @@ -100,6 +94,12 @@ type ListPoliciesInput struct { // check NextToken after every operation to ensure that you receive all of the // results. MaxResults *int32 + + // The parameter for receiving additional results if you receive a NextToken + // response in a previous request. A NextToken response indicates that more output + // is available. Set this parameter to the value of the previous call's NextToken + // response to indicate where the output should continue from. + NextToken *string } type ListPoliciesOutput struct { diff --git a/service/organizations/api_op_ListPoliciesForTarget.go b/service/organizations/api_op_ListPoliciesForTarget.go index 0a41b108f2f..89014dbb02e 100644 --- a/service/organizations/api_op_ListPoliciesForTarget.go +++ b/service/organizations/api_op_ListPoliciesForTarget.go @@ -65,31 +65,6 @@ func (c *Client) ListPoliciesForTarget(ctx context.Context, params *ListPolicies type ListPoliciesForTargetInput struct { - // The parameter for receiving additional results if you receive a NextToken - // response in a previous request. A NextToken response indicates that more output - // is available. Set this parameter to the value of the previous call's NextToken - // response to indicate where the output should continue from. - NextToken *string - - // The unique identifier (ID) of the root, organizational unit, or account whose - // policies you want to list. The regex pattern (http://wikipedia.org/wiki/regex) - // for a target ID string requires one of the following: - // - // * Root - A string - // that begins with "r-" followed by from 4 to 32 lowercase letters or digits. - // - // - // * Account - A string that consists of exactly 12 digits. - // - // * Organizational - // unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase - // letters or digits (the ID of the root that the OU is in). This string is - // followed by a second "-" dash and from 8 to 32 additional lowercase letters or - // digits. - // - // This member is required. - TargetId *string - // The type of policy that you want to include in the returned list. You must // specify one of the following values: // @@ -111,6 +86,25 @@ type ListPoliciesForTargetInput struct { // This member is required. Filter types.PolicyType + // The unique identifier (ID) of the root, organizational unit, or account whose + // policies you want to list. The regex pattern (http://wikipedia.org/wiki/regex) + // for a target ID string requires one of the following: + // + // * Root - A string + // that begins with "r-" followed by from 4 to 32 lowercase letters or digits. + // + // + // * Account - A string that consists of exactly 12 digits. + // + // * Organizational + // unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase + // letters or digits (the ID of the root that the OU is in). This string is + // followed by a second "-" dash and from 8 to 32 additional lowercase letters or + // digits. + // + // This member is required. + TargetId *string + // The total number of results that you want included on each page of the response. // If you do not include this parameter, it defaults to a value that is specific to // the operation. If additional items exist beyond the maximum you specify, the @@ -121,19 +115,25 @@ type ListPoliciesForTargetInput struct { // check NextToken after every operation to ensure that you receive all of the // results. MaxResults *int32 + + // The parameter for receiving additional results if you receive a NextToken + // response in a previous request. A NextToken response indicates that more output + // is available. Set this parameter to the value of the previous call's NextToken + // response to indicate where the output should continue from. + NextToken *string } type ListPoliciesForTargetOutput struct { - // The list of policies that match the criteria in the request. - Policies []*types.PolicySummary - // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null. NextToken *string + // The list of policies that match the criteria in the request. + Policies []*types.PolicySummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/organizations/api_op_ListTagsForResource.go b/service/organizations/api_op_ListTagsForResource.go index a2334581f2b..043367c6a4e 100644 --- a/service/organizations/api_op_ListTagsForResource.go +++ b/service/organizations/api_op_ListTagsForResource.go @@ -60,16 +60,16 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { + // The ID of the resource that you want to retrieve tags for. + // + // This member is required. + ResourceId *string + // The parameter for receiving additional results if you receive a NextToken // response in a previous request. A NextToken response indicates that more output // is available. Set this parameter to the value of the previous call's NextToken // response to indicate where the output should continue from. NextToken *string - - // The ID of the resource that you want to retrieve tags for. - // - // This member is required. - ResourceId *string } type ListTagsForResourceOutput struct { diff --git a/service/organizations/api_op_ListTargetsForPolicy.go b/service/organizations/api_op_ListTargetsForPolicy.go index ac4e813badb..a6480b4b8d0 100644 --- a/service/organizations/api_op_ListTargetsForPolicy.go +++ b/service/organizations/api_op_ListTargetsForPolicy.go @@ -64,11 +64,13 @@ func (c *Client) ListTargetsForPolicy(ctx context.Context, params *ListTargetsFo type ListTargetsForPolicyInput struct { - // The parameter for receiving additional results if you receive a NextToken - // response in a previous request. A NextToken response indicates that more output - // is available. Set this parameter to the value of the previous call's NextToken - // response to indicate where the output should continue from. - NextToken *string + // The unique identifier (ID) of the policy whose attachments you want to know. The + // regex pattern (http://wikipedia.org/wiki/regex) for a policy ID string requires + // "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the + // underscore character (_). + // + // This member is required. + PolicyId *string // The total number of results that you want included on each page of the response. // If you do not include this parameter, it defaults to a value that is specific to @@ -81,13 +83,11 @@ type ListTargetsForPolicyInput struct { // results. MaxResults *int32 - // The unique identifier (ID) of the policy whose attachments you want to know. The - // regex pattern (http://wikipedia.org/wiki/regex) for a policy ID string requires - // "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the - // underscore character (_). - // - // This member is required. - PolicyId *string + // The parameter for receiving additional results if you receive a NextToken + // response in a previous request. A NextToken response indicates that more output + // is available. Set this parameter to the value of the previous call's NextToken + // response to indicate where the output should continue from. + NextToken *string } type ListTargetsForPolicyOutput struct { diff --git a/service/organizations/api_op_RegisterDelegatedAdministrator.go b/service/organizations/api_op_RegisterDelegatedAdministrator.go index d3d18c984b7..79153e0a96e 100644 --- a/service/organizations/api_op_RegisterDelegatedAdministrator.go +++ b/service/organizations/api_op_RegisterDelegatedAdministrator.go @@ -65,17 +65,17 @@ func (c *Client) RegisterDelegatedAdministrator(ctx context.Context, params *Reg type RegisterDelegatedAdministratorInput struct { - // The service principal of the AWS service for which you want to make the member - // account a delegated administrator. - // - // This member is required. - ServicePrincipal *string - // The account ID number of the member account in the organization to register as a // delegated administrator. // // This member is required. AccountId *string + + // The service principal of the AWS service for which you want to make the member + // account a delegated administrator. + // + // This member is required. + ServicePrincipal *string } type RegisterDelegatedAdministratorOutput struct { diff --git a/service/organizations/api_op_TagResource.go b/service/organizations/api_op_TagResource.go index a882b9cfd16..be569c5f3a9 100644 --- a/service/organizations/api_op_TagResource.go +++ b/service/organizations/api_op_TagResource.go @@ -59,17 +59,17 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { + // The ID of the resource to add a tag to. + // + // This member is required. + ResourceId *string + // The tag to add to the specified resource. You must specify both a tag key and // value. You can set the value of a tag to an empty string, but you can't set it // to null. // // This member is required. Tags []*types.Tag - - // The ID of the resource to add a tag to. - // - // This member is required. - ResourceId *string } type TagResourceOutput struct { diff --git a/service/organizations/api_op_UpdatePolicy.go b/service/organizations/api_op_UpdatePolicy.go index efa4b2c3a84..caee9b50ddc 100644 --- a/service/organizations/api_op_UpdatePolicy.go +++ b/service/organizations/api_op_UpdatePolicy.go @@ -60,13 +60,6 @@ func (c *Client) UpdatePolicy(ctx context.Context, params *UpdatePolicyInput, op type UpdatePolicyInput struct { - // If provided, the new content for the policy. The text must be correctly - // formatted JSON that complies with the syntax for the policy's type. For more - // information, see Service Control Policy Syntax - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_scp-syntax.html) - // in the AWS Organizations User Guide. - Content *string - // The unique identifier (ID) of the policy that you want to update. The regex // pattern (http://wikipedia.org/wiki/regex) for a policy ID string requires "p-" // followed by from 8 to 128 lowercase or uppercase letters, digits, or the @@ -75,13 +68,20 @@ type UpdatePolicyInput struct { // This member is required. PolicyId *string + // If provided, the new content for the policy. The text must be correctly + // formatted JSON that complies with the syntax for the policy's type. For more + // information, see Service Control Policy Syntax + // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_scp-syntax.html) + // in the AWS Organizations User Guide. + Content *string + + // If provided, the new description for the policy. + Description *string + // If provided, the new name for the policy. The regex pattern // (http://wikipedia.org/wiki/regex) that is used to validate this parameter is a // string of any of the characters in the ASCII character range. Name *string - - // If provided, the new description for the policy. - Description *string } type UpdatePolicyOutput struct { diff --git a/service/organizations/go.mod b/service/organizations/go.mod index 415e7d177b5..2cdb2b8a7b4 100644 --- a/service/organizations/go.mod +++ b/service/organizations/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/organizations go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/organizations/types/types.go b/service/organizations/types/types.go index f25fe75507f..b6b2b4965c2 100644 --- a/service/organizations/types/types.go +++ b/service/organizations/types/types.go @@ -9,43 +9,40 @@ import ( // Contains information about an AWS account that is a member of an organization. type Account struct { - // The method by which the account joined the organization. - JoinedMethod AccountJoinedMethod - - // The status of the account in the organization. - Status AccountStatus - - // The date the account became a part of the organization. - JoinedTimestamp *time.Time - // The Amazon Resource Name (ARN) of the account. For more information about ARNs // in Organizations, see ARN Formats Supported by Organizations // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_permissions.html#orgs-permissions-arns) // in the AWS Organizations User Guide. Arn *string - // The friendly name of the account. The regex pattern - // (http://wikipedia.org/wiki/regex) that is used to validate this parameter is a - // string of any of the characters in the ASCII character range. - Name *string + // The email address associated with the AWS account. The regex pattern + // (http://wikipedia.org/wiki/regex) for this parameter is a string of characters + // that represents a standard internet email address. + Email *string // The unique identifier (ID) of the account. The regex pattern // (http://wikipedia.org/wiki/regex) for an account ID string requires exactly 12 // digits. Id *string - // The email address associated with the AWS account. The regex pattern - // (http://wikipedia.org/wiki/regex) for this parameter is a string of characters - // that represents a standard internet email address. - Email *string + // The method by which the account joined the organization. + JoinedMethod AccountJoinedMethod + + // The date the account became a part of the organization. + JoinedTimestamp *time.Time + + // The friendly name of the account. The regex pattern + // (http://wikipedia.org/wiki/regex) that is used to validate this parameter is a + // string of any of the characters in the ASCII character range. + Name *string + + // The status of the account in the organization. + Status AccountStatus } // Contains a list of child entities, either OUs or accounts. type Child struct { - // The type of this child entity. - Type ChildType - // The unique identifier (ID) of this child entity. The regex pattern // (http://wikipedia.org/wiki/regex) for a child ID string requires one of the // following: @@ -58,25 +55,25 @@ type Child struct { // string is followed by a second "-" dash and from 8 to 32 additional lower-case // letters or digits. Id *string + + // The type of this child entity. + Type ChildType } // Contains the status about a CreateAccount () or CreateGovCloudAccount () request // to create an AWS account or an AWS GovCloud (US) account in an organization. type CreateAccountStatus struct { - // The account name given to the account when it was created. - AccountName *string - - // The date and time that the account was created and the request completed. - CompletedTimestamp *time.Time - // If the account was created successfully, the unique identifier (ID) of the new // account. The regex pattern (http://wikipedia.org/wiki/regex) for an account ID // string requires exactly 12 digits. AccountId *string - // The date and time that the request was made for the account creation. - RequestedTimestamp *time.Time + // The account name given to the account when it was created. + AccountName *string + + // The date and time that the account was created and the request completed. + CompletedTimestamp *time.Time // If the request failed, a description of the reason for the failure. // @@ -108,45 +105,48 @@ type CreateAccountStatus struct { // account in the AWS GovCloud (US) Region. GovCloudAccountId *string - // The status of the request. - State CreateAccountState - // The unique identifier (ID) that references this request. You get this value from // the response of the initial CreateAccount () request to create the account. The // regex pattern (http://wikipedia.org/wiki/regex) for a create account request ID // string requires "car-" followed by from 8 to 32 lower-case letters or digits. Id *string + + // The date and time that the request was made for the account creation. + RequestedTimestamp *time.Time + + // The status of the request. + State CreateAccountState } // Contains information about the delegated administrator. type DelegatedAdministrator struct { - // The friendly name of the delegated administrator's account. - Name *string + // The Amazon Resource Name (ARN) of the delegated administrator's account. + Arn *string // The date when the account was made a delegated administrator. DelegationEnabledDate *time.Time - // The unique identifier (ID) of the delegated administrator's account. - Id *string - // The email address that is associated with the delegated administrator's AWS // account. Email *string - // The Amazon Resource Name (ARN) of the delegated administrator's account. - Arn *string + // The unique identifier (ID) of the delegated administrator's account. + Id *string + + // The method by which the delegated administrator's account joined the + // organization. + JoinedMethod AccountJoinedMethod // The date when the delegated administrator's account became a part of the // organization. JoinedTimestamp *time.Time + // The friendly name of the delegated administrator's account. + Name *string + // The status of the delegated administrator's account in the organization. Status AccountStatus - - // The method by which the delegated administrator's account joined the - // organization. - JoinedMethod AccountJoinedMethod } // Contains information about the AWS service for which the account is a delegated @@ -166,14 +166,14 @@ type DelegatedService struct { // attached to the account. type EffectivePolicy struct { - // The policy type. - PolicyType EffectivePolicyType + // The time of the last update to this policy. + LastUpdatedTimestamp *time.Time // The text content of the policy. PolicyContent *string - // The time of the last update to this policy. - LastUpdatedTimestamp *time.Time + // The policy type. + PolicyType EffectivePolicyType // The account ID of the policy target. TargetId *string @@ -201,11 +201,25 @@ type EnabledServicePrincipal struct { // they are deleted. type Handshake struct { - // The unique identifier (ID) of a handshake. The originating account creates the - // ID when it initiates the handshake. The regex pattern - // (http://wikipedia.org/wiki/regex) for handshake ID string requires "h-" followed - // by from 8 to 32 lower-case letters or digits. - Id *string + // The type of handshake, indicating what action occurs when the recipient accepts + // the handshake. The following handshake types are supported: + // + // * INVITE: This + // type of handshake represents a request to join an organization. It is always + // sent from the master account to only non-member accounts. + // + // * + // ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all + // features in an organization. It is always sent from the master account to only + // invited member accounts. Created accounts do not receive this because those + // accounts were created by the organization's master account and approval is + // inferred. + // + // * APPROVE_ALL_FEATURES: This type of handshake is sent from the + // Organizations service when all member accounts have approved the + // ENABLE_ALL_FEATURES invitation. It is sent only to the master account and + // signals the master that it can finalize the process to enable all features. + Action ActionType // The Amazon Resource Name (ARN) of a handshake. For more information about ARNs // in Organizations, see ARN Formats Supported by Organizations @@ -213,19 +227,25 @@ type Handshake struct { // in the AWS Organizations User Guide. Arn *string - // Additional information that is needed to process the handshake. - Resources []*HandshakeResource + // The date and time that the handshake expires. If the recipient of the handshake + // request fails to respond before the specified date and time, the handshake + // becomes inactive and is no longer valid. + ExpirationTimestamp *time.Time - // The date and time that the handshake request was made. - RequestedTimestamp *time.Time + // The unique identifier (ID) of a handshake. The originating account creates the + // ID when it initiates the handshake. The regex pattern + // (http://wikipedia.org/wiki/regex) for handshake ID string requires "h-" followed + // by from 8 to 32 lower-case letters or digits. + Id *string // Information about the two accounts that are participating in the handshake. Parties []*HandshakeParty - // The date and time that the handshake expires. If the recipient of the handshake - // request fails to respond before the specified date and time, the handshake - // becomes inactive and is no longer valid. - ExpirationTimestamp *time.Time + // The date and time that the handshake request was made. + RequestedTimestamp *time.Time + + // Additional information that is needed to process the handshake. + Resources []*HandshakeResource // The current state of the handshake. Use the state to trace the flow of the // handshake through the process from its creation to its acceptance. The meaning @@ -254,26 +274,6 @@ type Handshake struct { // is no longer active because the originator did not receive a response of any // kind from the recipient before the expiration time (15 days). State HandshakeState - - // The type of handshake, indicating what action occurs when the recipient accepts - // the handshake. The following handshake types are supported: - // - // * INVITE: This - // type of handshake represents a request to join an organization. It is always - // sent from the master account to only non-member accounts. - // - // * - // ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all - // features in an organization. It is always sent from the master account to only - // invited member accounts. Created accounts do not receive this because those - // accounts were created by the organization's master account and approval is - // inferred. - // - // * APPROVE_ALL_FEATURES: This type of handshake is sent from the - // Organizations service when all member accounts have approved the - // ENABLE_ALL_FEATURES invitation. It is sent only to the master account and - // signals the master that it can finalize the process to enable all features. - Action ActionType } // Specifies the criteria that are used to select the handshakes for the operation. @@ -309,10 +309,6 @@ type HandshakeParty struct { // Contains additional data that is needed to process a handshake. type HandshakeResource struct { - // The information that is passed to the other party in the handshake. The format - // of the value string must match the requirements of the specified type. - Value *string - // When needed, contains an additional array of HandshakeResource objects. Resources []*HandshakeResource @@ -338,6 +334,10 @@ type HandshakeResource struct { // * NOTES - Additional text provided by // the handshake initiator and intended for the recipient to read. Type HandshakeResourceType + + // The information that is passed to the other party in the handshake. The format + // of the value string must match the requirements of the specified type. + Value *string } // Contains details about an organization. An organization is a collection of @@ -346,12 +346,11 @@ type HandshakeResource struct { // policies . type Organization struct { - // The Amazon Resource Name (ARN) of the account that is designated as the master - // account for the organization. For more information about ARNs in Organizations, - // see ARN Formats Supported by Organizations + // The Amazon Resource Name (ARN) of an organization. For more information about + // ARNs in Organizations, see ARN Formats Supported by Organizations // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_permissions.html#orgs-permissions-arns) // in the AWS Organizations User Guide. - MasterAccountArn *string + Arn *string // Do not use. This field is deprecated and doesn't provide complete information // about the policies in your organization. To determine the policies that are @@ -368,6 +367,18 @@ type Organization struct { // in the AWS Organizations User Guide. FeatureSet OrganizationFeatureSet + // The unique identifier (ID) of an organization. The regex pattern + // (http://wikipedia.org/wiki/regex) for an organization ID string requires "o-" + // followed by from 10 to 32 lower-case letters or digits. + Id *string + + // The Amazon Resource Name (ARN) of the account that is designated as the master + // account for the organization. For more information about ARNs in Organizations, + // see ARN Formats Supported by Organizations + // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_permissions.html#orgs-permissions-arns) + // in the AWS Organizations User Guide. + MasterAccountArn *string + // The email address that is associated with the AWS account that is designated as // the master account for the organization. MasterAccountEmail *string @@ -376,17 +387,6 @@ type Organization struct { // pattern (http://wikipedia.org/wiki/regex) for an account ID string requires // exactly 12 digits. MasterAccountId *string - - // The Amazon Resource Name (ARN) of an organization. For more information about - // ARNs in Organizations, see ARN Formats Supported by Organizations - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_permissions.html#orgs-permissions-arns) - // in the AWS Organizations User Guide. - Arn *string - - // The unique identifier (ID) of an organization. The regex pattern - // (http://wikipedia.org/wiki/regex) for an organization ID string requires "o-" - // followed by from 10 to 32 lower-case letters or digits. - Id *string } // Contains details about an organizational unit (OU). An OU is a container of AWS @@ -394,6 +394,12 @@ type Organization struct { // apply to all accounts contained in that OU and in any child OUs. type OrganizationalUnit struct { + // The Amazon Resource Name (ARN) of this OU. For more information about ARNs in + // Organizations, see ARN Formats Supported by Organizations + // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_permissions.html#orgs-permissions-arns) + // in the AWS Organizations User Guide. + Arn *string + // The unique identifier (ID) associated with this OU. The regex pattern // (http://wikipedia.org/wiki/regex) for an organizational unit ID string requires // "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root @@ -401,12 +407,6 @@ type OrganizationalUnit struct { // to 32 additional lower-case letters or digits. Id *string - // The Amazon Resource Name (ARN) of this OU. For more information about ARNs in - // Organizations, see ARN Formats Supported by Organizations - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_permissions.html#orgs-permissions-arns) - // in the AWS Organizations User Guide. - Arn *string - // The friendly name of this OU. The regex pattern // (http://wikipedia.org/wiki/regex) that is used to validate this parameter is a // string of any of the characters in the ASCII character range. @@ -417,9 +417,6 @@ type OrganizationalUnit struct { // contain OUs or accounts in an organization. type Parent struct { - // The type of the parent entity. - Type ParentType - // The unique identifier (ID) of the parent entity. The regex pattern // (http://wikipedia.org/wiki/regex) for a parent ID string requires one of the // following: @@ -432,6 +429,9 @@ type Parent struct { // of the root that the OU is in). This string is followed by a second "-" dash and // from 8 to 32 additional lower-case letters or digits. Id *string + + // The type of the parent entity. + Type ParentType } // Contains rules to be applied to the affected accounts. Policies can be attached @@ -450,39 +450,47 @@ type Policy struct { // the content of a policy, see DescribePolicy (). type PolicySummary struct { - // The type of policy. - Type PolicyType - - // The friendly name of the policy. The regex pattern - // (http://wikipedia.org/wiki/regex) that is used to validate this parameter is a - // string of any of the characters in the ASCII character range. - Name *string + // The Amazon Resource Name (ARN) of the policy. For more information about ARNs in + // Organizations, see ARN Formats Supported by Organizations + // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_permissions.html#orgs-permissions-arns) + // in the AWS Organizations User Guide. + Arn *string // A boolean value that indicates whether the specified policy is an AWS managed // policy. If true, then you can attach the policy to roots, OUs, or accounts, but // you cannot edit it. AwsManaged *bool + // The description of the policy. + Description *string + // The unique identifier (ID) of the policy. The regex pattern // (http://wikipedia.org/wiki/regex) for a policy ID string requires "p-" followed // by from 8 to 128 lower-case letters or digits. Id *string - // The description of the policy. - Description *string + // The friendly name of the policy. The regex pattern + // (http://wikipedia.org/wiki/regex) that is used to validate this parameter is a + // string of any of the characters in the ASCII character range. + Name *string - // The Amazon Resource Name (ARN) of the policy. For more information about ARNs in - // Organizations, see ARN Formats Supported by Organizations - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_permissions.html#orgs-permissions-arns) - // in the AWS Organizations User Guide. - Arn *string + // The type of policy. + Type PolicyType } // Contains information about a root, OU, or account that a policy is attached to. type PolicyTargetSummary struct { - // The type of the policy target. - Type TargetType + // The Amazon Resource Name (ARN) of the policy target. For more information about + // ARNs in Organizations, see ARN Formats Supported by Organizations + // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_permissions.html#orgs-permissions-arns) + // in the AWS Organizations User Guide. + Arn *string + + // The friendly name of the policy target. The regex pattern + // (http://wikipedia.org/wiki/regex) that is used to validate this parameter is a + // string of any of the characters in the ASCII character range. + Name *string // The unique identifier (ID) of the policy target. The regex pattern // (http://wikipedia.org/wiki/regex) for a target ID string requires one of the @@ -500,16 +508,8 @@ type PolicyTargetSummary struct { // additional lower-case letters or digits. TargetId *string - // The friendly name of the policy target. The regex pattern - // (http://wikipedia.org/wiki/regex) that is used to validate this parameter is a - // string of any of the characters in the ASCII character range. - Name *string - - // The Amazon Resource Name (ARN) of the policy target. For more information about - // ARNs in Organizations, see ARN Formats Supported by Organizations - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_permissions.html#orgs-permissions-arns) - // in the AWS Organizations User Guide. - Arn *string + // The type of the policy target. + Type TargetType } // Contains information about a policy type and its status in the associated root. @@ -531,17 +531,22 @@ type PolicyTypeSummary struct { // policy types enabled for use in that root. type Root struct { - // The friendly name of the root. The regex pattern - // (http://wikipedia.org/wiki/regex) that is used to validate this parameter is a - // string of any of the characters in the ASCII character range. - Name *string - // The Amazon Resource Name (ARN) of the root. For more information about ARNs in // Organizations, see ARN Formats Supported by Organizations // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_permissions.html#orgs-permissions-arns) // in the AWS Organizations User Guide. Arn *string + // The unique identifier (ID) for the root. The regex pattern + // (http://wikipedia.org/wiki/regex) for a root ID string requires "r-" followed by + // from 4 to 32 lower-case letters or digits. + Id *string + + // The friendly name of the root. The regex pattern + // (http://wikipedia.org/wiki/regex) that is used to validate this parameter is a + // string of any of the characters in the ASCII character range. + Name *string + // The types of policies that are currently enabled for the root and therefore can // be attached to the root or to its OUs or accounts. Even if a policy type is // shown as available in the organization, you can separately enable and disable @@ -549,11 +554,6 @@ type Root struct { // Use DescribeOrganization () to see the availability of the policy types in that // organization. PolicyTypes []*PolicyTypeSummary - - // The unique identifier (ID) for the root. The regex pattern - // (http://wikipedia.org/wiki/regex) for a root ID string requires "r-" followed by - // from 4 to 32 lower-case letters or digits. - Id *string } // A custom key-value pair associated with a resource such as an account within diff --git a/service/outposts/api_op_CreateOutpost.go b/service/outposts/api_op_CreateOutpost.go index d44b154b9c3..17e4a4ad6d2 100644 --- a/service/outposts/api_op_CreateOutpost.go +++ b/service/outposts/api_op_CreateOutpost.go @@ -57,8 +57,10 @@ func (c *Client) CreateOutpost(ctx context.Context, params *CreateOutpostInput, type CreateOutpostInput struct { - // The name of the Outpost. - Name *string + // The ID of the site. + // + // This member is required. + SiteId *string // The Availability Zone. You must specify AvailabilityZone or AvailabilityZoneId. AvailabilityZone *string @@ -67,13 +69,11 @@ type CreateOutpostInput struct { // AvailabilityZoneId. AvailabilityZoneId *string - // The ID of the site. - // - // This member is required. - SiteId *string - // The Outpost description. Description *string + + // The name of the Outpost. + Name *string } type CreateOutpostOutput struct { diff --git a/service/outposts/api_op_GetOutpostInstanceTypes.go b/service/outposts/api_op_GetOutpostInstanceTypes.go index 83c8c6a6341..0bc810a05ac 100644 --- a/service/outposts/api_op_GetOutpostInstanceTypes.go +++ b/service/outposts/api_op_GetOutpostInstanceTypes.go @@ -57,9 +57,6 @@ func (c *Client) GetOutpostInstanceTypes(ctx context.Context, params *GetOutpost type GetOutpostInstanceTypesInput struct { - // The pagination token. - NextToken *string - // The ID of the Outpost. // // This member is required. @@ -67,22 +64,25 @@ type GetOutpostInstanceTypesInput struct { // The maximum page size. MaxResults *int32 + + // The pagination token. + NextToken *string } type GetOutpostInstanceTypesOutput struct { - // The Amazon Resource Name (ARN) of the Outpost. - OutpostArn *string - - // The ID of the Outpost. - OutpostId *string - // Information about the instance types. InstanceTypes []*types.InstanceTypeItem // The pagination token. NextToken *string + // The Amazon Resource Name (ARN) of the Outpost. + OutpostArn *string + + // The ID of the Outpost. + OutpostId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/outposts/api_op_ListOutposts.go b/service/outposts/api_op_ListOutposts.go index f838e0673db..dbde878eec1 100644 --- a/service/outposts/api_op_ListOutposts.go +++ b/service/outposts/api_op_ListOutposts.go @@ -56,21 +56,21 @@ func (c *Client) ListOutposts(ctx context.Context, params *ListOutpostsInput, op type ListOutpostsInput struct { - // The pagination token. - NextToken *string - // The maximum page size. MaxResults *int32 + + // The pagination token. + NextToken *string } type ListOutpostsOutput struct { - // Information about the Outposts. - Outposts []*types.Outpost - // The pagination token. NextToken *string + // Information about the Outposts. + Outposts []*types.Outpost + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/outposts/api_op_ListSites.go b/service/outposts/api_op_ListSites.go index d36a43f7039..f0848bd618d 100644 --- a/service/outposts/api_op_ListSites.go +++ b/service/outposts/api_op_ListSites.go @@ -56,21 +56,21 @@ func (c *Client) ListSites(ctx context.Context, params *ListSitesInput, optFns . type ListSitesInput struct { - // The pagination token. - NextToken *string - // The maximum page size. MaxResults *int32 + + // The pagination token. + NextToken *string } type ListSitesOutput struct { - // Information about the sites. - Sites []*types.Site - // The pagination token. NextToken *string + // Information about the sites. + Sites []*types.Site + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/outposts/go.mod b/service/outposts/go.mod index ff9e7f4dbb6..59f006702c7 100644 --- a/service/outposts/go.mod +++ b/service/outposts/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/outposts go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/outposts/types/types.go b/service/outposts/types/types.go index dcad1e4e808..d78d20ee193 100644 --- a/service/outposts/types/types.go +++ b/service/outposts/types/types.go @@ -12,24 +12,24 @@ type InstanceTypeItem struct { // Information about an Outpost. type Outpost struct { + // The Availability Zone. You must specify AvailabilityZone or AvailabilityZoneId. + AvailabilityZone *string + // The ID of the Availability Zone. You must specify AvailabilityZone or // AvailabilityZoneId. AvailabilityZoneId *string - // The Availability Zone. You must specify AvailabilityZone or AvailabilityZoneId. - AvailabilityZone *string + // The Outpost description. + Description *string // The life cycle status. LifeCycleStatus *string - // The Amazon Resource Name (ARN) of the Outpost. - OutpostArn *string - // The name of the Outpost. Name *string - // The ID of the site. - SiteId *string + // The Amazon Resource Name (ARN) of the Outpost. + OutpostArn *string // The ID of the Outpost. OutpostId *string @@ -37,8 +37,8 @@ type Outpost struct { // The AWS account ID of the Outpost owner. OwnerId *string - // The Outpost description. - Description *string + // The ID of the site. + SiteId *string } // Information about a site. @@ -47,12 +47,12 @@ type Site struct { // The ID of the AWS account. AccountId *string + // The description of the site. + Description *string + // The name of the site. Name *string // The ID of the site. SiteId *string - - // The description of the site. - Description *string } diff --git a/service/personalize/api_op_CreateBatchInferenceJob.go b/service/personalize/api_op_CreateBatchInferenceJob.go index 34c47f19d68..b9d1a1ded6d 100644 --- a/service/personalize/api_op_CreateBatchInferenceJob.go +++ b/service/personalize/api_op_CreateBatchInferenceJob.go @@ -59,40 +59,40 @@ func (c *Client) CreateBatchInferenceJob(ctx context.Context, params *CreateBatc type CreateBatchInferenceJobInput struct { - // The path to the Amazon S3 bucket where the job's output will be stored. + // The Amazon S3 path that leads to the input file to base your recommendations on. + // The input material must be in JSON format. // // This member is required. - JobOutput *types.BatchInferenceJobOutput - - // The number of recommendations to retreive. - NumResults *int32 - - // The ARN of the filter to apply to the batch inference job. For more information - // on using filters, see Using Filters with Amazon Personalize. - FilterArn *string + JobInput *types.BatchInferenceJobInput - // The ARN of the Amazon Identity and Access Management role that has permissions - // to read and write to your input and out Amazon S3 buckets respectively. + // The name of the batch inference job to create. // // This member is required. - RoleArn *string + JobName *string - // The name of the batch inference job to create. + // The path to the Amazon S3 bucket where the job's output will be stored. // // This member is required. - JobName *string + JobOutput *types.BatchInferenceJobOutput - // The Amazon S3 path that leads to the input file to base your recommendations on. - // The input material must be in JSON format. + // The ARN of the Amazon Identity and Access Management role that has permissions + // to read and write to your input and out Amazon S3 buckets respectively. // // This member is required. - JobInput *types.BatchInferenceJobInput + RoleArn *string // The Amazon Resource Name (ARN) of the solution version that will be used to // generate the batch inference recommendations. // // This member is required. SolutionVersionArn *string + + // The ARN of the filter to apply to the batch inference job. For more information + // on using filters, see Using Filters with Amazon Personalize. + FilterArn *string + + // The number of recommendations to retreive. + NumResults *int32 } type CreateBatchInferenceJobOutput struct { diff --git a/service/personalize/api_op_CreateCampaign.go b/service/personalize/api_op_CreateCampaign.go index 9ed0a11a6c5..805c8990f3e 100644 --- a/service/personalize/api_op_CreateCampaign.go +++ b/service/personalize/api_op_CreateCampaign.go @@ -88,16 +88,16 @@ type CreateCampaignInput struct { // This member is required. MinProvisionedTPS *int32 - // The Amazon Resource Name (ARN) of the solution version to deploy. - // - // This member is required. - SolutionVersionArn *string - // A name for the new campaign. The campaign name must be unique within your // account. // // This member is required. Name *string + + // The Amazon Resource Name (ARN) of the solution version to deploy. + // + // This member is required. + SolutionVersionArn *string } type CreateCampaignOutput struct { diff --git a/service/personalize/api_op_CreateDataset.go b/service/personalize/api_op_CreateDataset.go index 850bffc72f7..aa06b1a487f 100644 --- a/service/personalize/api_op_CreateDataset.go +++ b/service/personalize/api_op_CreateDataset.go @@ -92,17 +92,6 @@ type CreateDatasetInput struct { // This member is required. DatasetGroupArn *string - // The name for the dataset. - // - // This member is required. - Name *string - - // The ARN of the schema to associate with the dataset. The schema defines the - // dataset fields. - // - // This member is required. - SchemaArn *string - // The type of dataset. One of the following (case insensitive) values: // // * @@ -114,6 +103,17 @@ type CreateDatasetInput struct { // // This member is required. DatasetType *string + + // The name for the dataset. + // + // This member is required. + Name *string + + // The ARN of the schema to associate with the dataset. The schema defines the + // dataset fields. + // + // This member is required. + SchemaArn *string } type CreateDatasetOutput struct { diff --git a/service/personalize/api_op_CreateDatasetGroup.go b/service/personalize/api_op_CreateDatasetGroup.go index 051f0c06e0b..b40e11e9c69 100644 --- a/service/personalize/api_op_CreateDatasetGroup.go +++ b/service/personalize/api_op_CreateDatasetGroup.go @@ -100,17 +100,17 @@ func (c *Client) CreateDatasetGroup(ctx context.Context, params *CreateDatasetGr type CreateDatasetGroupInput struct { + // The name for the new dataset group. + // + // This member is required. + Name *string + // The Amazon Resource Name (ARN) of a KMS key used to encrypt the datasets. KmsKeyArn *string // The ARN of the IAM role that has permissions to access the KMS key. Supplying an // IAM role is only valid when also specifying a KMS key. RoleArn *string - - // The name for the new dataset group. - // - // This member is required. - Name *string } type CreateDatasetGroupOutput struct { diff --git a/service/personalize/api_op_CreateDatasetImportJob.go b/service/personalize/api_op_CreateDatasetImportJob.go index 79a46693c9a..fe5eda32e3b 100644 --- a/service/personalize/api_op_CreateDatasetImportJob.go +++ b/service/personalize/api_op_CreateDatasetImportJob.go @@ -80,6 +80,11 @@ type CreateDatasetImportJobInput struct { // This member is required. DataSource *types.DataSource + // The ARN of the dataset that receives the imported data. + // + // This member is required. + DatasetArn *string + // The name for the dataset import job. // // This member is required. @@ -90,11 +95,6 @@ type CreateDatasetImportJobInput struct { // // This member is required. RoleArn *string - - // The ARN of the dataset that receives the imported data. - // - // This member is required. - DatasetArn *string } type CreateDatasetImportJobOutput struct { diff --git a/service/personalize/api_op_CreateEventTracker.go b/service/personalize/api_op_CreateEventTracker.go index 7383c920ba2..f8044214875 100644 --- a/service/personalize/api_op_CreateEventTracker.go +++ b/service/personalize/api_op_CreateEventTracker.go @@ -84,16 +84,16 @@ func (c *Client) CreateEventTracker(ctx context.Context, params *CreateEventTrac type CreateEventTrackerInput struct { - // The name for the event tracker. - // - // This member is required. - Name *string - // The Amazon Resource Name (ARN) of the dataset group that receives the event // data. // // This member is required. DatasetGroupArn *string + + // The name for the event tracker. + // + // This member is required. + Name *string } type CreateEventTrackerOutput struct { diff --git a/service/personalize/api_op_CreateFilter.go b/service/personalize/api_op_CreateFilter.go index d8ca53ef57f..50b253d7b98 100644 --- a/service/personalize/api_op_CreateFilter.go +++ b/service/personalize/api_op_CreateFilter.go @@ -57,6 +57,11 @@ func (c *Client) CreateFilter(ctx context.Context, params *CreateFilterInput, op type CreateFilterInput struct { + // The ARN of the dataset group that the filter will belong to. + // + // This member is required. + DatasetGroupArn *string + // The filter expression that designates the interaction types that the filter will // filter out. A filter expression must follow the following format: EXCLUDE itemId // WHERE INTERACTIONS.event_type in ("EVENT_TYPE") Where "EVENT_TYPE" is the type @@ -67,11 +72,6 @@ type CreateFilterInput struct { // This member is required. FilterExpression *string - // The ARN of the dataset group that the filter will belong to. - // - // This member is required. - DatasetGroupArn *string - // The name of the filter to create. // // This member is required. diff --git a/service/personalize/api_op_CreateSchema.go b/service/personalize/api_op_CreateSchema.go index 18df68cdd86..25da741e100 100644 --- a/service/personalize/api_op_CreateSchema.go +++ b/service/personalize/api_op_CreateSchema.go @@ -62,15 +62,15 @@ func (c *Client) CreateSchema(ctx context.Context, params *CreateSchemaInput, op type CreateSchemaInput struct { - // A schema in Avro JSON format. + // The name for the schema. // // This member is required. - Schema *string + Name *string - // The name for the schema. + // A schema in Avro JSON format. // // This member is required. - Name *string + Schema *string } type CreateSchemaOutput struct { diff --git a/service/personalize/api_op_CreateSolution.go b/service/personalize/api_op_CreateSolution.go index 188258187a8..1a72f3f1de8 100644 --- a/service/personalize/api_op_CreateSolution.go +++ b/service/personalize/api_op_CreateSolution.go @@ -85,9 +85,21 @@ func (c *Client) CreateSolution(ctx context.Context, params *CreateSolutionInput type CreateSolutionInput struct { - // The ARN of the recipe to use for model training. Only specified when - // performAutoML is false. - RecipeArn *string + // The Amazon Resource Name (ARN) of the dataset group that provides the training + // data. + // + // This member is required. + DatasetGroupArn *string + + // The name for the solution. + // + // This member is required. + Name *string + + // When your have multiple event types (using an EVENT_TYPE schema field), this + // parameter specifies which event type (for example, 'click' or 'like') is used + // for training the model. + EventType *string // Whether to perform automated machine learning (AutoML). The default is false. // For this case, you must specify recipeArn. When set to true, Amazon Personalize @@ -103,26 +115,14 @@ type CreateSolutionInput struct { // always true and you should not set it to false. PerformHPO *bool - // The name for the solution. - // - // This member is required. - Name *string + // The ARN of the recipe to use for model training. Only specified when + // performAutoML is false. + RecipeArn *string // The configuration to use with the solution. When performAutoML is set to true, // Amazon Personalize only evaluates the autoMLConfig section of the solution // configuration. SolutionConfig *types.SolutionConfig - - // When your have multiple event types (using an EVENT_TYPE schema field), this - // parameter specifies which event type (for example, 'click' or 'like') is used - // for training the model. - EventType *string - - // The Amazon Resource Name (ARN) of the dataset group that provides the training - // data. - // - // This member is required. - DatasetGroupArn *string } type CreateSolutionOutput struct { diff --git a/service/personalize/api_op_ListBatchInferenceJobs.go b/service/personalize/api_op_ListBatchInferenceJobs.go index 93e72f3814a..30dc742a35d 100644 --- a/service/personalize/api_op_ListBatchInferenceJobs.go +++ b/service/personalize/api_op_ListBatchInferenceJobs.go @@ -71,13 +71,13 @@ type ListBatchInferenceJobsInput struct { type ListBatchInferenceJobsOutput struct { + // A list containing information on each job that is returned. + BatchInferenceJobs []*types.BatchInferenceJobSummary + // The token to use to retreive the next page of results. The value is null when // there are no more results to return. NextToken *string - // A list containing information on each job that is returned. - BatchInferenceJobs []*types.BatchInferenceJobSummary - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/personalize/api_op_ListCampaigns.go b/service/personalize/api_op_ListCampaigns.go index 16e590bfc43..a7de7a36238 100644 --- a/service/personalize/api_op_ListCampaigns.go +++ b/service/personalize/api_op_ListCampaigns.go @@ -62,24 +62,24 @@ type ListCampaignsInput struct { // The maximum number of campaigns to return. MaxResults *int32 + // A token returned from the previous call to ListCampaigns for getting the next + // set of campaigns (if they exist). + NextToken *string + // The Amazon Resource Name (ARN) of the solution to list the campaigns for. When a // solution is not specified, all the campaigns associated with the account are // listed. SolutionArn *string - - // A token returned from the previous call to ListCampaigns for getting the next - // set of campaigns (if they exist). - NextToken *string } type ListCampaignsOutput struct { - // A token for getting the next set of campaigns (if they exist). - NextToken *string - // A list of the campaigns. Campaigns []*types.CampaignSummary + // A token for getting the next set of campaigns (if they exist). + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/personalize/api_op_ListDatasetGroups.go b/service/personalize/api_op_ListDatasetGroups.go index 14c4ce45969..a0c17f6637f 100644 --- a/service/personalize/api_op_ListDatasetGroups.go +++ b/service/personalize/api_op_ListDatasetGroups.go @@ -58,12 +58,12 @@ func (c *Client) ListDatasetGroups(ctx context.Context, params *ListDatasetGroup type ListDatasetGroupsInput struct { + // The maximum number of dataset groups to return. + MaxResults *int32 + // A token returned from the previous call to ListDatasetGroups for getting the // next set of dataset groups (if they exist). NextToken *string - - // The maximum number of dataset groups to return. - MaxResults *int32 } type ListDatasetGroupsOutput struct { diff --git a/service/personalize/api_op_ListDatasetImportJobs.go b/service/personalize/api_op_ListDatasetImportJobs.go index 7b1914ddb04..4c19b8ab451 100644 --- a/service/personalize/api_op_ListDatasetImportJobs.go +++ b/service/personalize/api_op_ListDatasetImportJobs.go @@ -61,26 +61,26 @@ func (c *Client) ListDatasetImportJobs(ctx context.Context, params *ListDatasetI type ListDatasetImportJobsInput struct { - // A token returned from the previous call to ListDatasetImportJobs for getting the - // next set of dataset import jobs (if they exist). - NextToken *string - // The Amazon Resource Name (ARN) of the dataset to list the dataset import jobs // for. DatasetArn *string // The maximum number of dataset import jobs to return. MaxResults *int32 + + // A token returned from the previous call to ListDatasetImportJobs for getting the + // next set of dataset import jobs (if they exist). + NextToken *string } type ListDatasetImportJobsOutput struct { - // A token for getting the next set of dataset import jobs (if they exist). - NextToken *string - // The list of dataset import jobs. DatasetImportJobs []*types.DatasetImportJobSummary + // A token for getting the next set of dataset import jobs (if they exist). + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/personalize/api_op_ListDatasets.go b/service/personalize/api_op_ListDatasets.go index 2795ac742df..1a7b124005f 100644 --- a/service/personalize/api_op_ListDatasets.go +++ b/service/personalize/api_op_ListDatasets.go @@ -58,26 +58,26 @@ func (c *Client) ListDatasets(ctx context.Context, params *ListDatasetsInput, op type ListDatasetsInput struct { + // The Amazon Resource Name (ARN) of the dataset group that contains the datasets + // to list. + DatasetGroupArn *string + // The maximum number of datasets to return. MaxResults *int32 // A token returned from the previous call to ListDatasetImportJobs for getting the // next set of dataset import jobs (if they exist). NextToken *string - - // The Amazon Resource Name (ARN) of the dataset group that contains the datasets - // to list. - DatasetGroupArn *string } type ListDatasetsOutput struct { - // A token for getting the next set of datasets (if they exist). - NextToken *string - // An array of Dataset objects. Each object provides metadata information. Datasets []*types.DatasetSummary + // A token for getting the next set of datasets (if they exist). + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/personalize/api_op_ListEventTrackers.go b/service/personalize/api_op_ListEventTrackers.go index dbc349da29d..1b74078d4f7 100644 --- a/service/personalize/api_op_ListEventTrackers.go +++ b/service/personalize/api_op_ListEventTrackers.go @@ -59,12 +59,12 @@ func (c *Client) ListEventTrackers(ctx context.Context, params *ListEventTracker type ListEventTrackersInput struct { - // The maximum number of event trackers to return. - MaxResults *int32 - // The ARN of a dataset group used to filter the response. DatasetGroupArn *string + // The maximum number of event trackers to return. + MaxResults *int32 + // A token returned from the previous call to ListEventTrackers for getting the // next set of event trackers (if they exist). NextToken *string @@ -72,12 +72,12 @@ type ListEventTrackersInput struct { type ListEventTrackersOutput struct { - // A token for getting the next set of event trackers (if they exist). - NextToken *string - // A list of event trackers. EventTrackers []*types.EventTrackerSummary + // A token for getting the next set of event trackers (if they exist). + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/personalize/api_op_ListFilters.go b/service/personalize/api_op_ListFilters.go index b724238df9a..86f991b9f5b 100644 --- a/service/personalize/api_op_ListFilters.go +++ b/service/personalize/api_op_ListFilters.go @@ -56,15 +56,15 @@ func (c *Client) ListFilters(ctx context.Context, params *ListFiltersInput, optF type ListFiltersInput struct { + // The ARN of the dataset group that contains the filters. + DatasetGroupArn *string + // The maximum number of filters to return. MaxResults *int32 // A token returned from the previous call to ListFilters for getting the next set // of filters (if they exist). NextToken *string - - // The ARN of the dataset group that contains the filters. - DatasetGroupArn *string } type ListFiltersOutput struct { diff --git a/service/personalize/api_op_ListRecipes.go b/service/personalize/api_op_ListRecipes.go index bc39ce8dccb..7b65f78a1b7 100644 --- a/service/personalize/api_op_ListRecipes.go +++ b/service/personalize/api_op_ListRecipes.go @@ -57,15 +57,15 @@ func (c *Client) ListRecipes(ctx context.Context, params *ListRecipesInput, optF type ListRecipesInput struct { - // The default is SERVICE. - RecipeProvider types.RecipeProvider + // The maximum number of recipes to return. + MaxResults *int32 // A token returned from the previous call to ListRecipes for getting the next set // of recipes (if they exist). NextToken *string - // The maximum number of recipes to return. - MaxResults *int32 + // The default is SERVICE. + RecipeProvider types.RecipeProvider } type ListRecipesOutput struct { diff --git a/service/personalize/api_op_ListSchemas.go b/service/personalize/api_op_ListSchemas.go index d2c74ca6b90..7a9f9513777 100644 --- a/service/personalize/api_op_ListSchemas.go +++ b/service/personalize/api_op_ListSchemas.go @@ -68,12 +68,12 @@ type ListSchemasInput struct { type ListSchemasOutput struct { - // A list of schemas. - Schemas []*types.DatasetSchemaSummary - // A token used to get the next set of schemas (if they exist). NextToken *string + // A list of schemas. + Schemas []*types.DatasetSchemaSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/personalize/api_op_ListSolutionVersions.go b/service/personalize/api_op_ListSolutionVersions.go index cd7425d2411..baa1615f96a 100644 --- a/service/personalize/api_op_ListSolutionVersions.go +++ b/service/personalize/api_op_ListSolutionVersions.go @@ -60,13 +60,13 @@ func (c *Client) ListSolutionVersions(ctx context.Context, params *ListSolutionV type ListSolutionVersionsInput struct { + // The maximum number of solution versions to return. + MaxResults *int32 + // A token returned from the previous call to ListSolutionVersions for getting the // next set of solution versions (if they exist). NextToken *string - // The maximum number of solution versions to return. - MaxResults *int32 - // The Amazon Resource Name (ARN) of the solution. SolutionArn *string } diff --git a/service/personalize/api_op_UpdateCampaign.go b/service/personalize/api_op_UpdateCampaign.go index b5f55715a74..3725f6c95c9 100644 --- a/service/personalize/api_op_UpdateCampaign.go +++ b/service/personalize/api_op_UpdateCampaign.go @@ -61,9 +61,6 @@ func (c *Client) UpdateCampaign(ctx context.Context, params *UpdateCampaignInput type UpdateCampaignInput struct { - // The ARN of a new solution version to deploy. - SolutionVersionArn *string - // The Amazon Resource Name (ARN) of the campaign. // // This member is required. @@ -72,6 +69,9 @@ type UpdateCampaignInput struct { // Specifies the requested minimum provisioned transactions (recommendations) per // second that Amazon Personalize will support. MinProvisionedTPS *int32 + + // The ARN of a new solution version to deploy. + SolutionVersionArn *string } type UpdateCampaignOutput struct { diff --git a/service/personalize/go.mod b/service/personalize/go.mod index b7d5db6e4cb..54bc6088124 100644 --- a/service/personalize/go.mod +++ b/service/personalize/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/personalize go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/personalize/types/types.go b/service/personalize/types/types.go index f01d22b307c..81ad4294505 100644 --- a/service/personalize/types/types.go +++ b/service/personalize/types/types.go @@ -9,50 +9,50 @@ import ( // Describes a custom algorithm. type Algorithm struct { - // Specifies the default maximum number of training jobs and parallel training - // jobs. - DefaultResourceConfig map[string]*string - // The Amazon Resource Name (ARN) of the algorithm. AlgorithmArn *string - // The name of the algorithm. - Name *string - // The URI of the Docker container for the algorithm image. AlgorithmImage *AlgorithmImage - // The Amazon Resource Name (ARN) of the role. - RoleArn *string + // The date and time (in Unix time) that the algorithm was created. + CreationDateTime *time.Time - // The date and time (in Unix time) that the algorithm was last updated. - LastUpdatedDateTime *time.Time + // Specifies the default hyperparameters, their ranges, and whether they are + // tunable. A tunable hyperparameter can have its value determined during + // hyperparameter optimization (HPO). + DefaultHyperParameterRanges *DefaultHyperParameterRanges // Specifies the default hyperparameters. DefaultHyperParameters map[string]*string - // The training input mode. - TrainingInputMode *string + // Specifies the default maximum number of training jobs and parallel training + // jobs. + DefaultResourceConfig map[string]*string - // Specifies the default hyperparameters, their ranges, and whether they are - // tunable. A tunable hyperparameter can have its value determined during - // hyperparameter optimization (HPO). - DefaultHyperParameterRanges *DefaultHyperParameterRanges + // The date and time (in Unix time) that the algorithm was last updated. + LastUpdatedDateTime *time.Time - // The date and time (in Unix time) that the algorithm was created. - CreationDateTime *time.Time + // The name of the algorithm. + Name *string + + // The Amazon Resource Name (ARN) of the role. + RoleArn *string + + // The training input mode. + TrainingInputMode *string } // Describes an algorithm image. type AlgorithmImage struct { - // The name of the algorithm image. - Name *string - // The URI of the Docker container for the algorithm image. // // This member is required. DockerURI *string + + // The name of the algorithm image. + Name *string } // When the solution performs AutoML (performAutoML is true in CreateSolution ()), @@ -78,31 +78,44 @@ type AutoMLResult struct { // Contains information on a batch inference job. type BatchInferenceJob struct { - // The name of the batch inference job. - JobName *string + // The Amazon Resource Name (ARN) of the batch inference job. + BatchInferenceJobArn *string + + // The time at which the batch inference job was created. + CreationDateTime *time.Time // If the batch inference job failed, the reason for the failure. FailureReason *string - // The Amazon Resource Name (ARN) of the solution version from which the batch - // inference job was created. - SolutionVersionArn *string - - // The ARN of the Amazon Identity and Access Management (IAM) role that requested - // the batch inference job. - RoleArn *string - - // The number of recommendations generated by the batch inference job. This number - // includes the error messages generated for failed input records. - NumResults *int32 + // The ARN of the filter used on the batch inference job. + FilterArn *string // The Amazon S3 path that leads to the input data used to generate the batch // inference job. JobInput *BatchInferenceJobInput + // The name of the batch inference job. + JobName *string + + // The Amazon S3 bucket that contains the output data generated by the batch + // inference job. + JobOutput *BatchInferenceJobOutput + // The time at which the batch inference job was last updated. LastUpdatedDateTime *time.Time + // The number of recommendations generated by the batch inference job. This number + // includes the error messages generated for failed input records. + NumResults *int32 + + // The ARN of the Amazon Identity and Access Management (IAM) role that requested + // the batch inference job. + RoleArn *string + + // The Amazon Resource Name (ARN) of the solution version from which the batch + // inference job was created. + SolutionVersionArn *string + // The status of the batch inference job. The status is one of the following // values: // @@ -114,19 +127,6 @@ type BatchInferenceJob struct { // // * CREATE FAILED Status *string - - // The time at which the batch inference job was created. - CreationDateTime *time.Time - - // The Amazon S3 bucket that contains the output data generated by the batch - // inference job. - JobOutput *BatchInferenceJobOutput - - // The ARN of the filter used on the batch inference job. - FilterArn *string - - // The Amazon Resource Name (ARN) of the batch inference job. - BatchInferenceJobArn *string } // The input configuration of a batch inference job. @@ -154,20 +154,23 @@ type BatchInferenceJobOutput struct { // summaries. type BatchInferenceJobSummary struct { - // The ARN of the solution version used by the batch inference job. - SolutionVersionArn *string + // The Amazon Resource Name (ARN) of the batch inference job. + BatchInferenceJobArn *string - // The time at which the batch inference job was last updated. - LastUpdatedDateTime *time.Time + // The time at which the batch inference job was created. + CreationDateTime *time.Time // If the batch inference job failed, the reason for the failure. FailureReason *string - // The Amazon Resource Name (ARN) of the batch inference job. - BatchInferenceJobArn *string + // The name of the batch inference job. + JobName *string - // The time at which the batch inference job was created. - CreationDateTime *time.Time + // The time at which the batch inference job was last updated. + LastUpdatedDateTime *time.Time + + // The ARN of the solution version used by the batch inference job. + SolutionVersionArn *string // The status of the batch inference job. The status is one of the following // values: @@ -180,22 +183,28 @@ type BatchInferenceJobSummary struct { // // * CREATE FAILED Status *string - - // The name of the batch inference job. - JobName *string } // Describes a deployed solution version, otherwise known as a campaign. For more // information on campaigns, see CreateCampaign (). type Campaign struct { - // Provides a summary of the properties of a campaign update. For a complete - // listing, call the DescribeCampaign () API. - LatestCampaignUpdate *CampaignUpdateSummary + // The Amazon Resource Name (ARN) of the campaign. + CampaignArn *string + + // The date and time (in Unix format) that the campaign was created. + CreationDateTime *time.Time + + // If a campaign fails, the reason behind the failure. + FailureReason *string // The date and time (in Unix format) that the campaign was last updated. LastUpdatedDateTime *time.Time + // Provides a summary of the properties of a campaign update. For a complete + // listing, call the DescribeCampaign () API. + LatestCampaignUpdate *CampaignUpdateSummary + // Specifies the requested minimum provisioned transactions (recommendations) per // second. MinProvisionedTPS *int32 @@ -203,6 +212,9 @@ type Campaign struct { // The name of the campaign. Name *string + // The Amazon Resource Name (ARN) of a specific version of the solution. + SolutionVersionArn *string + // The status of the campaign. A campaign can be in one of the following states: // // @@ -211,36 +223,27 @@ type Campaign struct { // * DELETE // PENDING > DELETE IN_PROGRESS Status *string +} - // The date and time (in Unix format) that the campaign was created. - CreationDateTime *time.Time - - // The Amazon Resource Name (ARN) of a specific version of the solution. - SolutionVersionArn *string +// Provides a summary of the properties of a campaign. For a complete listing, call +// the DescribeCampaign () API. +type CampaignSummary struct { // The Amazon Resource Name (ARN) of the campaign. CampaignArn *string + // The date and time (in Unix time) that the campaign was created. + CreationDateTime *time.Time + // If a campaign fails, the reason behind the failure. FailureReason *string -} - -// Provides a summary of the properties of a campaign. For a complete listing, call -// the DescribeCampaign () API. -type CampaignSummary struct { // The date and time (in Unix time) that the campaign was last updated. LastUpdatedDateTime *time.Time - // The Amazon Resource Name (ARN) of the campaign. - CampaignArn *string - // The name of the campaign. Name *string - // The date and time (in Unix time) that the campaign was created. - CreationDateTime *time.Time - // The status of the campaign. A campaign can be in one of the following states: // // @@ -249,21 +252,28 @@ type CampaignSummary struct { // * DELETE // PENDING > DELETE IN_PROGRESS Status *string - - // If a campaign fails, the reason behind the failure. - FailureReason *string } // Provides a summary of the properties of a campaign update. For a complete // listing, call the DescribeCampaign () API. type CampaignUpdateSummary struct { - // The date and time (in Unix time) that the campaign update was last updated. - LastUpdatedDateTime *time.Time + // The date and time (in Unix time) that the campaign update was created. + CreationDateTime *time.Time // If a campaign update fails, the reason behind the failure. FailureReason *string + // The date and time (in Unix time) that the campaign update was last updated. + LastUpdatedDateTime *time.Time + + // Specifies the requested minimum provisioned transactions (recommendations) per + // second that Amazon Personalize will support. + MinProvisionedTPS *int32 + + // The Amazon Resource Name (ARN) of the deployed solution version. + SolutionVersionArn *string + // The status of the campaign update. A campaign update can be in one of the // following states: // @@ -272,16 +282,6 @@ type CampaignUpdateSummary struct { // // * DELETE PENDING > DELETE IN_PROGRESS Status *string - - // The date and time (in Unix time) that the campaign update was created. - CreationDateTime *time.Time - - // The Amazon Resource Name (ARN) of the deployed solution version. - SolutionVersionArn *string - - // Specifies the requested minimum provisioned transactions (recommendations) per - // second that Amazon Personalize will support. - MinProvisionedTPS *int32 } // Provides the name and range of a categorical hyperparameter. @@ -300,16 +300,25 @@ type ContinuousHyperParameterRange struct { // The maximum allowable value for the hyperparameter. MaxValue *float64 - // The name of the hyperparameter. - Name *string - // The minimum allowable value for the hyperparameter. MinValue *float64 + + // The name of the hyperparameter. + Name *string } // Provides metadata for a dataset. type Dataset struct { + // The creation date and time (in Unix time) of the dataset. + CreationDateTime *time.Time + + // The Amazon Resource Name (ARN) of the dataset that you want metadata for. + DatasetArn *string + + // The Amazon Resource Name (ARN) of the dataset group. + DatasetGroupArn *string + // One of the following values: // // * Interactions @@ -322,6 +331,12 @@ type Dataset struct { // A time stamp that shows when the dataset was updated. LastUpdatedDateTime *time.Time + // The name of the dataset. + Name *string + + // The ARN of the associated schema. + SchemaArn *string + // The status of the dataset. A dataset can be in one of the following states: // // @@ -330,21 +345,6 @@ type Dataset struct { // * DELETE // PENDING > DELETE IN_PROGRESS Status *string - - // The creation date and time (in Unix time) of the dataset. - CreationDateTime *time.Time - - // The Amazon Resource Name (ARN) of the dataset that you want metadata for. - DatasetArn *string - - // The name of the dataset. - Name *string - - // The ARN of the associated schema. - SchemaArn *string - - // The Amazon Resource Name (ARN) of the dataset group. - DatasetGroupArn *string } // A dataset group is a collection of related datasets (Interactions, User, and @@ -356,17 +356,26 @@ type Dataset struct { // group. type DatasetGroup struct { - // The ARN of the IAM role that has permissions to create the dataset group. - RoleArn *string + // The creation date and time (in Unix time) of the dataset group. + CreationDateTime *time.Time - // The name of the dataset group. - Name *string + // The Amazon Resource Name (ARN) of the dataset group. + DatasetGroupArn *string + + // If creating a dataset group fails, provides the reason why. + FailureReason *string + + // The Amazon Resource Name (ARN) of the KMS key used to encrypt the datasets. + KmsKeyArn *string // The last update date and time (in Unix time) of the dataset group. LastUpdatedDateTime *time.Time - // If creating a dataset group fails, provides the reason why. - FailureReason *string + // The name of the dataset group. + Name *string + + // The ARN of the IAM role that has permissions to create the dataset group. + RoleArn *string // The current status of the dataset group. A dataset group can be in one of the // following states: @@ -376,35 +385,26 @@ type DatasetGroup struct { // // * DELETE PENDING Status *string - - // The creation date and time (in Unix time) of the dataset group. - CreationDateTime *time.Time - - // The Amazon Resource Name (ARN) of the KMS key used to encrypt the datasets. - KmsKeyArn *string - - // The Amazon Resource Name (ARN) of the dataset group. - DatasetGroupArn *string } // Provides a summary of the properties of a dataset group. For a complete listing, // call the DescribeDatasetGroup () API. type DatasetGroupSummary struct { + // The date and time (in Unix time) that the dataset group was created. + CreationDateTime *time.Time + // The Amazon Resource Name (ARN) of the dataset group. DatasetGroupArn *string - // The name of the dataset group. - Name *string - // If creating a dataset group fails, the reason behind the failure. FailureReason *string // The date and time (in Unix time) that the dataset group was last updated. LastUpdatedDateTime *time.Time - // The date and time (in Unix time) that the dataset group was created. - CreationDateTime *time.Time + // The name of the dataset group. + Name *string // The status of the dataset group. A dataset group can be in one of the following // states: @@ -424,48 +424,30 @@ type DatasetGroupSummary struct { // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED type DatasetImportJob struct { - // The status of the dataset import job. A dataset import job can be in one of the - // following states: - // - // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- - // CREATE FAILED - Status *string - - // If a dataset import job fails, provides the reason why. - FailureReason *string - // The creation date and time (in Unix time) of the dataset import job. CreationDateTime *time.Time - // The date and time (in Unix time) the dataset was last updated. - LastUpdatedDateTime *time.Time + // The Amazon S3 bucket that contains the training data to import. + DataSource *DataSource // The Amazon Resource Name (ARN) of the dataset that receives the imported data. DatasetArn *string + // The ARN of the dataset import job. + DatasetImportJobArn *string + + // If a dataset import job fails, provides the reason why. + FailureReason *string + // The name of the import job. JobName *string - // The Amazon S3 bucket that contains the training data to import. - DataSource *DataSource - - // The ARN of the dataset import job. - DatasetImportJobArn *string + // The date and time (in Unix time) the dataset was last updated. + LastUpdatedDateTime *time.Time // The ARN of the AWS Identity and Access Management (IAM) role that has // permissions to read from the Amazon S3 data source. RoleArn *string -} - -// Provides a summary of the properties of a dataset import job. For a complete -// listing, call the DescribeDatasetImportJob () API. -type DatasetImportJobSummary struct { - - // The name of the dataset import job. - JobName *string - - // If a dataset import job fails, the reason behind the failure. - FailureReason *string // The status of the dataset import job. A dataset import job can be in one of the // following states: @@ -473,6 +455,11 @@ type DatasetImportJobSummary struct { // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- // CREATE FAILED Status *string +} + +// Provides a summary of the properties of a dataset import job. For a complete +// listing, call the DescribeDatasetImportJob () API. +type DatasetImportJobSummary struct { // The date and time (in Unix time) that the dataset import job was created. CreationDateTime *time.Time @@ -480,42 +467,55 @@ type DatasetImportJobSummary struct { // The Amazon Resource Name (ARN) of the dataset import job. DatasetImportJobArn *string + // If a dataset import job fails, the reason behind the failure. + FailureReason *string + + // The name of the dataset import job. + JobName *string + // The date and time (in Unix time) that the dataset was last updated. LastUpdatedDateTime *time.Time + + // The status of the dataset import job. A dataset import job can be in one of the + // following states: + // + // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- + // CREATE FAILED + Status *string } // Describes the schema for a dataset. For more information on schemas, see // CreateSchema (). type DatasetSchema struct { - // The Amazon Resource Name (ARN) of the schema. - SchemaArn *string - - // The schema. - Schema *string - // The date and time (in Unix time) that the schema was created. CreationDateTime *time.Time + // The date and time (in Unix time) that the schema was last updated. + LastUpdatedDateTime *time.Time + // The name of the schema. Name *string - // The date and time (in Unix time) that the schema was last updated. - LastUpdatedDateTime *time.Time + // The schema. + Schema *string + + // The Amazon Resource Name (ARN) of the schema. + SchemaArn *string } // Provides a summary of the properties of a dataset schema. For a complete // listing, call the DescribeSchema () API. type DatasetSchemaSummary struct { - // The name of the schema. - Name *string + // The date and time (in Unix time) that the schema was created. + CreationDateTime *time.Time // The date and time (in Unix time) that the schema was last updated. LastUpdatedDateTime *time.Time - // The date and time (in Unix time) that the schema was created. - CreationDateTime *time.Time + // The name of the schema. + Name *string // The Amazon Resource Name (ARN) of the schema. SchemaArn *string @@ -525,6 +525,12 @@ type DatasetSchemaSummary struct { // the DescribeDataset () API. type DatasetSummary struct { + // The date and time (in Unix time) that the dataset was created. + CreationDateTime *time.Time + + // The Amazon Resource Name (ARN) of the dataset. + DatasetArn *string + // The dataset type. One of the following values: // // * Interactions @@ -540,8 +546,8 @@ type DatasetSummary struct { // The date and time (in Unix time) that the dataset was last updated. LastUpdatedDateTime *time.Time - // The date and time (in Unix time) that the dataset was created. - CreationDateTime *time.Time + // The name of the dataset. + Name *string // The status of the dataset. A dataset can be in one of the following states: // @@ -551,12 +557,6 @@ type DatasetSummary struct { // * DELETE // PENDING > DELETE IN_PROGRESS Status *string - - // The name of the dataset. - Name *string - - // The Amazon Resource Name (ARN) of the dataset. - DatasetArn *string } // Describes the data source that contains the data to upload to a dataset. @@ -572,14 +572,14 @@ type DataSource struct { // determined during hyperparameter optimization (HPO). type DefaultCategoricalHyperParameterRange struct { - // A list of the categories for the hyperparameter. - Values []*string - // Whether the hyperparameter is tunable. IsTunable *bool // The name of the hyperparameter. Name *string + + // A list of the categories for the hyperparameter. + Values []*string } // Provides the name and default range of a continuous hyperparameter and whether @@ -587,31 +587,31 @@ type DefaultCategoricalHyperParameterRange struct { // determined during hyperparameter optimization (HPO). type DefaultContinuousHyperParameterRange struct { - // The minimum allowable value for the hyperparameter. - MinValue *float64 - - // The name of the hyperparameter. - Name *string - // Whether the hyperparameter is tunable. IsTunable *bool // The maximum allowable value for the hyperparameter. MaxValue *float64 + + // The minimum allowable value for the hyperparameter. + MinValue *float64 + + // The name of the hyperparameter. + Name *string } // Specifies the hyperparameters and their default ranges. Hyperparameters can be // categorical, continuous, or integer-valued. type DefaultHyperParameterRanges struct { - // The integer-valued hyperparameters and their default ranges. - IntegerHyperParameterRanges []*DefaultIntegerHyperParameterRange + // The categorical hyperparameters and their default ranges. + CategoricalHyperParameterRanges []*DefaultCategoricalHyperParameterRange // The continuous hyperparameters and their default ranges. ContinuousHyperParameterRanges []*DefaultContinuousHyperParameterRange - // The categorical hyperparameters and their default ranges. - CategoricalHyperParameterRanges []*DefaultCategoricalHyperParameterRange + // The integer-valued hyperparameters and their default ranges. + IntegerHyperParameterRanges []*DefaultIntegerHyperParameterRange } // Provides the name and default range of a integer-valued hyperparameter and @@ -619,9 +619,6 @@ type DefaultHyperParameterRanges struct { // value determined during hyperparameter optimization (HPO). type DefaultIntegerHyperParameterRange struct { - // The name of the hyperparameter. - Name *string - // Indicates whether the hyperparameter is tunable. IsTunable *bool @@ -630,22 +627,32 @@ type DefaultIntegerHyperParameterRange struct { // The minimum allowable value for the hyperparameter. MinValue *int32 + + // The name of the hyperparameter. + Name *string } // Provides information about an event tracker. type EventTracker struct { - // The name of the event tracker. - Name *string + // The Amazon AWS account that owns the event tracker. + AccountId *string - // The date and time (in Unix time) that the event tracker was last updated. - LastUpdatedDateTime *time.Time + // The date and time (in Unix format) that the event tracker was created. + CreationDateTime *time.Time + + // The Amazon Resource Name (ARN) of the dataset group that receives the event + // data. + DatasetGroupArn *string // The ARN of the event tracker. EventTrackerArn *string - // The date and time (in Unix format) that the event tracker was created. - CreationDateTime *time.Time + // The date and time (in Unix time) that the event tracker was last updated. + LastUpdatedDateTime *time.Time + + // The name of the event tracker. + Name *string // The status of the event tracker. An event tracker can be in one of the following // states: @@ -659,28 +666,24 @@ type EventTracker struct { // The ID of the event tracker. Include this ID in requests to the PutEvents // (https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) API. TrackingId *string - - // The Amazon AWS account that owns the event tracker. - AccountId *string - - // The Amazon Resource Name (ARN) of the dataset group that receives the event - // data. - DatasetGroupArn *string } // Provides a summary of the properties of an event tracker. For a complete // listing, call the DescribeEventTracker () API. type EventTrackerSummary struct { - // The date and time (in Unix time) that the event tracker was last updated. - LastUpdatedDateTime *time.Time - // The date and time (in Unix time) that the event tracker was created. CreationDateTime *time.Time // The Amazon Resource Name (ARN) of the event tracker. EventTrackerArn *string + // The date and time (in Unix time) that the event tracker was last updated. + LastUpdatedDateTime *time.Time + + // The name of the event tracker. + Name *string + // The status of the event tracker. An event tracker can be in one of the following // states: // @@ -689,9 +692,6 @@ type EventTrackerSummary struct { // // * DELETE PENDING > DELETE IN_PROGRESS Status *string - - // The name of the event tracker. - Name *string } // Provides feature transformation information. Feature transformation is the @@ -699,20 +699,20 @@ type EventTrackerSummary struct { // training. type FeatureTransformation struct { - // The name of the feature transformation. - Name *string + // The creation date and time (in Unix time) of the feature transformation. + CreationDateTime *time.Time + + // Provides the default parameters for feature transformation. + DefaultParameters map[string]*string // The Amazon Resource Name (ARN) of the FeatureTransformation object. FeatureTransformationArn *string - // The creation date and time (in Unix time) of the feature transformation. - CreationDateTime *time.Time - // The last update date and time (in Unix time) of the feature transformation. LastUpdatedDateTime *time.Time - // Provides the default parameters for feature transformation. - DefaultParameters map[string]*string + // The name of the feature transformation. + Name *string // The status of the feature transformation. A feature transformation can be in one // of the following states: @@ -726,9 +726,18 @@ type FeatureTransformation struct { // filter expression. type Filter struct { + // The time at which the filter was created. + CreationDateTime *time.Time + // The ARN of the dataset group to which the filter belongs. DatasetGroupArn *string + // If the filter failed, the reason for its failure. + FailureReason *string + + // The ARN of the filter. + FilterArn *string + // Specifies the type of item interactions to filter out of recommendation results. // The filter expression must follow the following format: EXCLUDE itemId WHERE // INTERACTIONS.event_type in ("EVENT_TYPE") Where "EVENT_TYPE" is the type of @@ -736,62 +745,53 @@ type Filter struct { // Personalize. FilterExpression *string - // If the filter failed, the reason for its failure. - FailureReason *string - // The time at which the filter was last updated. LastUpdatedDateTime *time.Time - // The ARN of the filter. - FilterArn *string - // The name of the filter. Name *string // The status of the filter. Status *string - - // The time at which the filter was created. - CreationDateTime *time.Time } // A short summary of a filter's attributes. type FilterSummary struct { - // The name of the filter. - Name *string + // The time at which the filter was created. + CreationDateTime *time.Time // The ARN of the dataset group to which the filter belongs. DatasetGroupArn *string + // If the filter failed, the reason for the failure. + FailureReason *string + + // The ARN of the filter. + FilterArn *string + // The time at which the filter was last updated. LastUpdatedDateTime *time.Time + // The name of the filter. + Name *string + // The status of the filter. Status *string - - // The time at which the filter was created. - CreationDateTime *time.Time - - // The ARN of the filter. - FilterArn *string - - // If the filter failed, the reason for the failure. - FailureReason *string } // Describes the properties for hyperparameter optimization (HPO). For use with the // bring-your-own-recipe feature. Do not use for Amazon Personalize native recipes. type HPOConfig struct { - // Describes the resource configuration for HPO. - HpoResourceConfig *HPOResourceConfig - // The hyperparameters and their allowable ranges. AlgorithmHyperParameterRanges *HyperParameterRanges // The metric to optimize during HPO. HpoObjective *HPOObjective + + // Describes the resource configuration for HPO. + HpoResourceConfig *HPOResourceConfig } // The metric to optimize during hyperparameter optimization (HPO). @@ -800,35 +800,35 @@ type HPOObjective struct { // The name of the metric. MetricName *string - // The type of the metric. Valid values are Maximize and Minimize. - Type *string - // A regular expression for finding the metric in the training job logs. MetricRegex *string + + // The type of the metric. Valid values are Maximize and Minimize. + Type *string } // Describes the resource configuration for hyperparameter optimization (HPO). type HPOResourceConfig struct { - // The maximum number of parallel training jobs when you create a solution version. - // The maximum value for maxParallelTrainingJobs is 10. - MaxParallelTrainingJobs *string - // The maximum number of training jobs when you create a solution version. The // maximum value for maxNumberOfTrainingJobs is 40. MaxNumberOfTrainingJobs *string + + // The maximum number of parallel training jobs when you create a solution version. + // The maximum value for maxParallelTrainingJobs is 10. + MaxParallelTrainingJobs *string } // Specifies the hyperparameters and their ranges. Hyperparameters can be // categorical, continuous, or integer-valued. type HyperParameterRanges struct { - // The continuous hyperparameters and their ranges. - ContinuousHyperParameterRanges []*ContinuousHyperParameterRange - // The categorical hyperparameters and their ranges. CategoricalHyperParameterRanges []*CategoricalHyperParameterRange + // The continuous hyperparameters and their ranges. + ContinuousHyperParameterRanges []*ContinuousHyperParameterRange + // The integer-valued hyperparameters and their ranges. IntegerHyperParameterRanges []*IntegerHyperParameterRange } @@ -851,6 +851,28 @@ type IntegerHyperParameterRange struct { // operation. type Recipe struct { + // The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to + // train the model. + AlgorithmArn *string + + // The date and time (in Unix format) that the recipe was created. + CreationDateTime *time.Time + + // The description of the recipe. + Description *string + + // The ARN of the FeatureTransformation object. + FeatureTransformationArn *string + + // The date and time (in Unix format) that the recipe was last updated. + LastUpdatedDateTime *time.Time + + // The name of the recipe. + Name *string + + // The Amazon Resource Name (ARN) of the recipe. + RecipeArn *string + // One of the following values: // // * PERSONALIZED_RANKING @@ -861,30 +883,8 @@ type Recipe struct { // * USER_PERSONALIZATION RecipeType *string - // The name of the recipe. - Name *string - - // The date and time (in Unix format) that the recipe was last updated. - LastUpdatedDateTime *time.Time - - // The Amazon Resource Name (ARN) of the recipe. - RecipeArn *string - - // The date and time (in Unix format) that the recipe was created. - CreationDateTime *time.Time - // The status of the recipe. Status *string - - // The ARN of the FeatureTransformation object. - FeatureTransformationArn *string - - // The description of the recipe. - Description *string - - // The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to - // train the model. - AlgorithmArn *string } // Provides a summary of the properties of a recipe. For a complete listing, call @@ -894,48 +894,59 @@ type RecipeSummary struct { // The date and time (in Unix time) that the recipe was created. CreationDateTime *time.Time - // The status of the recipe. - Status *string - // The date and time (in Unix time) that the recipe was last updated. LastUpdatedDateTime *time.Time + // The name of the recipe. + Name *string + // The Amazon Resource Name (ARN) of the recipe. RecipeArn *string - // The name of the recipe. - Name *string + // The status of the recipe. + Status *string } // The configuration details of an Amazon S3 input or output bucket. type S3DataConfig struct { - // The Amazon Resource Name (ARN) of the Amazon Key Management Service (KMS) key - // that Amazon Personalize uses to encrypt or decrypt the input and output files of - // a batch inference job. - KmsKeyArn *string - // The file path of the Amazon S3 bucket. // // This member is required. Path *string + + // The Amazon Resource Name (ARN) of the Amazon Key Management Service (KMS) key + // that Amazon Personalize uses to encrypt or decrypt the input and output files of + // a batch inference job. + KmsKeyArn *string } // An object that provides information about a solution. A solution is a trained // model that can be deployed as a campaign. type Solution struct { - // The status of the solution. A solution can be in one of the following states: - // - // - // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED - // - // * DELETE - // PENDING > DELETE IN_PROGRESS - Status *string + // When performAutoML is true, specifies the best recipe found. + AutoMLResult *AutoMLResult - // Describes the configuration properties for the solution. - SolutionConfig *SolutionConfig + // The creation date and time (in Unix time) of the solution. + CreationDateTime *time.Time + + // The Amazon Resource Name (ARN) of the dataset group that provides the training + // data. + DatasetGroupArn *string + + // The event type (for example, 'click' or 'like') that is used for training the + // model. + EventType *string + + // The date and time (in Unix time) that the solution was last updated. + LastUpdatedDateTime *time.Time + + // Describes the latest version of the solution, including the status and the ARN. + LatestSolutionVersion *SolutionVersionSummary + + // The name of the solution. + Name *string // When true, Amazon Personalize performs a search for the best // USER_PERSONALIZATION recipe from the list specified in the solution @@ -943,71 +954,66 @@ type Solution struct { // Amazon Personalize uses recipeArn for training. PerformAutoML *bool - // The date and time (in Unix time) that the solution was last updated. - LastUpdatedDateTime *time.Time - // Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The // default is false. PerformHPO *bool - // The Amazon Resource Name (ARN) of the dataset group that provides the training - // data. - DatasetGroupArn *string - - // The creation date and time (in Unix time) of the solution. - CreationDateTime *time.Time - - // The name of the solution. - Name *string - // The ARN of the recipe used to create the solution. RecipeArn *string - // Describes the latest version of the solution, including the status and the ARN. - LatestSolutionVersion *SolutionVersionSummary - - // When performAutoML is true, specifies the best recipe found. - AutoMLResult *AutoMLResult - // The ARN of the solution. SolutionArn *string - // The event type (for example, 'click' or 'like') that is used for training the - // model. - EventType *string + // Describes the configuration properties for the solution. + SolutionConfig *SolutionConfig + + // The status of the solution. A solution can be in one of the following states: + // + // + // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED + // + // * DELETE + // PENDING > DELETE IN_PROGRESS + Status *string } // Describes the configuration properties for the solution. type SolutionConfig struct { - // Only events with a value greater than or equal to this threshold are used for - // training a model. - EventValueThreshold *string + // Lists the hyperparameter names and ranges. + AlgorithmHyperParameters map[string]*string // The AutoMLConfig () object containing a list of recipes to search when AutoML is // performed. AutoMLConfig *AutoMLConfig + // Only events with a value greater than or equal to this threshold are used for + // training a model. + EventValueThreshold *string + // Lists the feature transformation parameters. FeatureTransformationParameters map[string]*string // Describes the properties for hyperparameter optimization (HPO). HpoConfig *HPOConfig - - // Lists the hyperparameter names and ranges. - AlgorithmHyperParameters map[string]*string } // Provides a summary of the properties of a solution. For a complete listing, call // the DescribeSolution () API. type SolutionSummary struct { - // The Amazon Resource Name (ARN) of the solution. - SolutionArn *string + // The date and time (in Unix time) that the solution was created. + CreationDateTime *time.Time // The date and time (in Unix time) that the solution was last updated. LastUpdatedDateTime *time.Time + // The name of the solution. + Name *string + + // The Amazon Resource Name (ARN) of the solution. + SolutionArn *string + // The status of the solution. A solution can be in one of the following states: // // @@ -1016,23 +1022,48 @@ type SolutionSummary struct { // * DELETE // PENDING > DELETE IN_PROGRESS Status *string - - // The date and time (in Unix time) that the solution was created. - CreationDateTime *time.Time - - // The name of the solution. - Name *string } // An object that provides information about a specific version of a Solution (). type SolutionVersion struct { - // Describes the configuration properties for the solution. - SolutionConfig *SolutionConfig + // The date and time (in Unix time) that this version of the solution was created. + CreationDateTime *time.Time + + // The Amazon Resource Name (ARN) of the dataset group providing the training data. + DatasetGroupArn *string + + // The event type (for example, 'click' or 'like') that is used for training the + // model. + EventType *string + + // If training a solution version fails, the reason for the failure. + FailureReason *string // The date and time (in Unix time) that the solution was last updated. LastUpdatedDateTime *time.Time + // When true, Amazon Personalize searches for the most optimal recipe according to + // the solution configuration. When false (the default), Amazon Personalize uses + // recipeArn. + PerformAutoML *bool + + // Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The + // default is false. + PerformHPO *bool + + // The ARN of the recipe used in the solution. + RecipeArn *string + + // The ARN of the solution. + SolutionArn *string + + // Describes the configuration properties for the solution. + SolutionConfig *SolutionConfig + + // The ARN of the solution version. + SolutionVersionArn *string + // The status of the solution version. A solution version can be in one of the // following states: // @@ -1046,18 +1077,10 @@ type SolutionVersion struct { // * CREATE FAILED Status *string - // If hyperparameter optimization was performed, contains the hyperparameter values - // of the best performing model. - TunedHPOParams *TunedHPOParams - - // Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The - // default is false. - PerformHPO *bool - - // When true, Amazon Personalize searches for the most optimal recipe according to - // the solution configuration. When false (the default), Amazon Personalize uses - // recipeArn. - PerformAutoML *bool + // The time used to train the model. You are billed for the time it takes to train + // a model. This field is visible only after Amazon Personalize successfully trains + // a model. + TrainingHours *float64 // The scope of training used to create the solution version. The FULL option // trains the solution version based on the entirety of the input solution's @@ -1069,43 +1092,26 @@ type SolutionVersion struct { // native-recipe-hrnn-coldstart (). TrainingMode TrainingMode - // The time used to train the model. You are billed for the time it takes to train - // a model. This field is visible only after Amazon Personalize successfully trains - // a model. - TrainingHours *float64 - - // If training a solution version fails, the reason for the failure. - FailureReason *string - - // The date and time (in Unix time) that this version of the solution was created. - CreationDateTime *time.Time - - // The event type (for example, 'click' or 'like') that is used for training the - // model. - EventType *string - - // The ARN of the solution. - SolutionArn *string - - // The ARN of the recipe used in the solution. - RecipeArn *string - - // The ARN of the solution version. - SolutionVersionArn *string - - // The Amazon Resource Name (ARN) of the dataset group providing the training data. - DatasetGroupArn *string + // If hyperparameter optimization was performed, contains the hyperparameter values + // of the best performing model. + TunedHPOParams *TunedHPOParams } // Provides a summary of the properties of a solution version. For a complete // listing, call the DescribeSolutionVersion () API. type SolutionVersionSummary struct { + // The date and time (in Unix time) that this version of a solution was created. + CreationDateTime *time.Time + + // If a solution version fails, the reason behind the failure. + FailureReason *string + // The date and time (in Unix time) that the solution version was last updated. LastUpdatedDateTime *time.Time - // The date and time (in Unix time) that this version of a solution was created. - CreationDateTime *time.Time + // The Amazon Resource Name (ARN) of the solution version. + SolutionVersionArn *string // The status of the solution version. A solution version can be in one of the // following states: @@ -1113,12 +1119,6 @@ type SolutionVersionSummary struct { // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- // CREATE FAILED Status *string - - // If a solution version fails, the reason behind the failure. - FailureReason *string - - // The Amazon Resource Name (ARN) of the solution version. - SolutionVersionArn *string } // If hyperparameter optimization (HPO) was performed, contains the hyperparameter diff --git a/service/personalizeevents/api_op_PutEvents.go b/service/personalizeevents/api_op_PutEvents.go index 1c3ec62d494..e2c9d733c35 100644 --- a/service/personalizeevents/api_op_PutEvents.go +++ b/service/personalizeevents/api_op_PutEvents.go @@ -62,8 +62,10 @@ type PutEventsInput struct { // This member is required. EventList []*types.Event - // The user associated with the event. - UserId *string + // The session ID associated with the user's visit. + // + // This member is required. + SessionId *string // The tracking ID for the event. The ID is generated by a call to the // CreateEventTracker @@ -73,10 +75,8 @@ type PutEventsInput struct { // This member is required. TrackingId *string - // The session ID associated with the user's visit. - // - // This member is required. - SessionId *string + // The user associated with the event. + UserId *string } type PutEventsOutput struct { diff --git a/service/personalizeevents/go.mod b/service/personalizeevents/go.mod index 383e06f0447..fc3b68520b0 100644 --- a/service/personalizeevents/go.mod +++ b/service/personalizeevents/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/personalizeevents go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/personalizeruntime/api_op_GetPersonalizedRanking.go b/service/personalizeruntime/api_op_GetPersonalizedRanking.go index c416ebfd499..2ea7f3962e6 100644 --- a/service/personalizeruntime/api_op_GetPersonalizedRanking.go +++ b/service/personalizeruntime/api_op_GetPersonalizedRanking.go @@ -66,11 +66,6 @@ type GetPersonalizedRankingInput struct { // This member is required. CampaignArn *string - // The user for which you want the campaign to provide a personalized ranking. - // - // This member is required. - UserId *string - // A list of items (itemId's) to rank. If an item was not included in the training // dataset, the item is appended to the end of the reranked list. The maximum is // 500. @@ -78,6 +73,11 @@ type GetPersonalizedRankingInput struct { // This member is required. InputList []*string + // The user for which you want the campaign to provide a personalized ranking. + // + // This member is required. + UserId *string + // The contextual metadata to use when getting recommendations. Contextual metadata // includes any interaction information that might be relevant when getting a // user's recommendations, such as the user's current location or device type. diff --git a/service/personalizeruntime/api_op_GetRecommendations.go b/service/personalizeruntime/api_op_GetRecommendations.go index 8f98d44b235..04d2e1d913b 100644 --- a/service/personalizeruntime/api_op_GetRecommendations.go +++ b/service/personalizeruntime/api_op_GetRecommendations.go @@ -67,21 +67,17 @@ func (c *Client) GetRecommendations(ctx context.Context, params *GetRecommendati type GetRecommendationsInput struct { - // The contextual metadata to use when getting recommendations. Contextual metadata - // includes any interaction information that might be relevant when getting a - // user's recommendations, such as the user's current location or device type. - Context map[string]*string - - // The user ID to provide recommendations for. Required for USER_PERSONALIZATION - // recipe type. - UserId *string - // The Amazon Resource Name (ARN) of the campaign to use for getting // recommendations. // // This member is required. CampaignArn *string + // The contextual metadata to use when getting recommendations. Contextual metadata + // includes any interaction information that might be relevant when getting a + // user's recommendations, such as the user's current location or device type. + Context map[string]*string + // The ARN of the filter to apply to the returned recommendations. For more // information, see Using Filters with Amazon Personalize. FilterArn *string @@ -92,6 +88,10 @@ type GetRecommendationsInput struct { // The number of results to return. The default is 25. The maximum is 500. NumResults *int32 + + // The user ID to provide recommendations for. Required for USER_PERSONALIZATION + // recipe type. + UserId *string } type GetRecommendationsOutput struct { diff --git a/service/personalizeruntime/go.mod b/service/personalizeruntime/go.mod index 9efbcffc430..6af565da82a 100644 --- a/service/personalizeruntime/go.mod +++ b/service/personalizeruntime/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/personalizeruntime go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/personalizeruntime/types/types.go b/service/personalizeruntime/types/types.go index 7c65ec1ed88..586ad30b760 100644 --- a/service/personalizeruntime/types/types.go +++ b/service/personalizeruntime/types/types.go @@ -5,10 +5,10 @@ package types // An object that identifies an item. The and APIs return a list of PredictedItems. type PredictedItem struct { + // The recommended item ID. + ItemId *string + // A numeric representation of the model's certainty that the item will be the next // user selection. For more information on scoring logic, see how-scores-work (). Score *float64 - - // The recommended item ID. - ItemId *string } diff --git a/service/pi/api_op_DescribeDimensionKeys.go b/service/pi/api_op_DescribeDimensionKeys.go index f057d58e784..abe1e3697ae 100644 --- a/service/pi/api_op_DescribeDimensionKeys.go +++ b/service/pi/api_op_DescribeDimensionKeys.go @@ -58,13 +58,13 @@ func (c *Client) DescribeDimensionKeys(ctx context.Context, params *DescribeDime type DescribeDimensionKeysInput struct { - // An immutable, AWS Region-unique identifier for a data source. Performance - // Insights gathers metrics from this data source. To use an Amazon RDS instance as - // a data source, you specify its DbiResourceId value - for example: - // db-FAIHNTYBKTGAUSUZQYPDS2GW4A + // The date and time specifying the end of the requested time series data. The + // value specified is exclusive - data points less than (but not equal to) EndTime + // will be returned. The value for EndTime must be later than the value for + // StartTime. // // This member is required. - Identifier *string + EndTime *time.Time // A specification for how to aggregate the data points from a query result. You // must specify a valid dimension group. Performance Insights will return all of @@ -75,6 +75,14 @@ type DescribeDimensionKeysInput struct { // This member is required. GroupBy *types.DimensionGroup + // An immutable, AWS Region-unique identifier for a data source. Performance + // Insights gathers metrics from this data source. To use an Amazon RDS instance as + // a data source, you specify its DbiResourceId value - for example: + // db-FAIHNTYBKTGAUSUZQYPDS2GW4A + // + // This member is required. + Identifier *string + // The name of a Performance Insights metric to be measured. Valid values for // Metric are: PreferredBackupWindow *string - // The name for the master user.

    Constraints:

    - MasterUsername *string - - // The number of days for which automated backups are retained. Setting this - // parameter to a positive number enables backups. For more information, see - // CreateDBInstance. - BackupRetentionPeriod *int32 - - // A list of VPC security groups to associate with this DB instance. - VpcSecurityGroupIds []*string - - // A value that indicates whether to copy all tags from the DB instance to - // snapshots of the DB instance. By default, tags are not copied. - CopyTagsToSnapshot *bool - - // The port number on which the database accepts connections. Type: Integer Valid - // Values: 1150-65535 Default: 3306 - Port *int32 - - // The name of the engine of your source database.

    Valid Values: - // mysql

    - // - // This member is required. - SourceEngine *string - - // The interval, in seconds, between points when Enhanced Monitoring metrics are - // collected for the DB instance. To disable collecting Enhanced Monitoring - // metrics, specify 0.

    If MonitoringRoleArn is specified, then you - // must also set MonitoringInterval to a value other than 0.

    - //

    Valid Values: 0, 1, 5, 10, 15, 30, 60

    Default: 0

    - MonitoringInterval *int32 - - // A value that indicates whether minor engine upgrades are applied automatically - // to the DB instance during the maintenance window. By default, minor engine - // upgrades are not applied automatically. - AutoMinorVersionUpgrade *bool - - // The amount of Provisioned IOPS (input/output operations per second) to allocate - // initially for the DB instance. For information about valid Iops values, see - // Amazon RDS Provisioned IOPS Storage to Improve Performance - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) - // in the Amazon RDS User Guide. - Iops *int32 - - // The DB instance identifier. This parameter is stored as a lowercase string. - //

    Constraints:

    - //

    Example: mydbinstance

    - // - // This member is required. - DBInstanceIdentifier *string + // The time range each week during which system maintenance can occur, in Universal + // Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window + // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance) + // in the Amazon RDS User Guide.

    Constraints:

    + PreferredMaintenanceWindow *string - // The name of the database engine to be used for this instance.

    Valid Values: - // mysql

    - // - // This member is required. - Engine *string + // The number of CPU cores and the number of threads per core for the DB instance + // class of the DB instance. + ProcessorFeatures []*types.ProcessorFeature - // A value that indicates whether to enable Performance Insights for the DB - // instance. For more information, see Using Amazon Performance Insights - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) - // in the Amazon Relational Database Service User Guide. - EnablePerformanceInsights *bool + // A value that indicates whether the DB instance is publicly accessible. When the + // DB instance is publicly accessible, its DNS endpoint resolves to the private IP + // address from within the DB instance's VPC, and to the public IP address from + // outside of the DB instance's VPC. Access to the DB instance is ultimately + // controlled by the security group it uses, and that public access is not + // permitted if the security group assigned to the DB instance doesn't permit it. + // When the DB instance isn't publicly accessible, it is an internal DB instance + // with a DNS name that resolves to a private IP address. For more information, see + // CreateDBInstance (). + PubliclyAccessible *bool - // A value that indicates whether the DB instance is a Multi-AZ deployment. If the - // DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone - // parameter. - MultiAZ *bool + // The prefix of your Amazon S3 bucket. + S3Prefix *string // A value that indicates whether the new DB instance is encrypted or not. StorageEncrypted *bool - // The compute and memory capacity of the DB instance, for example, db.m4.large. - // Not all DB instance classes are available in all AWS Regions, or for all - // database engines. For the full list of DB instance classes, and availability for - // your engine, see DB Instance Class - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) - // in the Amazon RDS User Guide. Importing from Amazon S3 isn't supported on the - // db.t2.micro DB instance class. - // - // This member is required. - DBInstanceClass *string + // Specifies the storage type to be associated with the DB instance. Valid values: + // standard | gp2 | io1 If you specify io1, you must also include a value for the + // Iops parameter. Default: io1 if the Iops parameter is specified; otherwise gp2 + StorageType *string - // The number of CPU cores and the number of threads per core for the DB instance - // class of the DB instance. - ProcessorFeatures []*types.ProcessorFeature + // A list of tags to associate with this DB instance. For more information, see + // Tagging Amazon RDS Resources + // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in + // the Amazon RDS User Guide. + Tags []*types.Tag - // An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access - // your Amazon S3 bucket. - // - // This member is required. - S3IngestionRoleArn *string + // A value that indicates whether the DB instance class of the DB instance uses its + // default processor features. + UseDefaultProcessorFeatures *bool - // The AWS KMS key identifier for encryption of Performance Insights data. The KMS - // key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key - // alias for the KMS encryption key. If you do not specify a value for - // PerformanceInsightsKMSKeyId, then Amazon RDS uses your default encryption key. - // AWS KMS creates the default encryption key for your AWS account. Your AWS - // account has a different default encryption key for each AWS Region. - PerformanceInsightsKMSKeyId *string + // A list of VPC security groups to associate with this DB instance. + VpcSecurityGroupIds []*string } type RestoreDBInstanceFromS3Output struct { diff --git a/service/rds/api_op_RestoreDBInstanceToPointInTime.go b/service/rds/api_op_RestoreDBInstanceToPointInTime.go index f6e94e5b879..70dce8439c4 100644 --- a/service/rds/api_op_RestoreDBInstanceToPointInTime.go +++ b/service/rds/api_op_RestoreDBInstanceToPointInTime.go @@ -69,57 +69,66 @@ func (c *Client) RestoreDBInstanceToPointInTime(ctx context.Context, params *Res // type RestoreDBInstanceToPointInTimeInput struct { - // The identifier of the source DB instance from which to restore. Constraints: + // The name of the new DB instance to be created. Constraints: // + // * Must contain + // from 1 to 63 letters, numbers, or hyphens // - // * Must match the identifier of an existing DB instance. - SourceDBInstanceIdentifier *string + // * First character must be a + // letter + // + // * Can't end with a hyphen or contain two consecutive hyphens + // + // This member is required. + TargetDBInstanceIdentifier *string - // License model information for the restored DB instance. Default: Same as source. - // Valid values: license-included | bring-your-own-license | general-public-license - LicenseModel *string + // A value that indicates whether minor version upgrades are applied automatically + // to the DB instance during the maintenance window. + AutoMinorVersionUpgrade *bool - // The database engine to use for the new instance. Default: The same as source - // Constraint: Must be compatible with the engine of the source

    Valid - // Values:

    - Engine *string + // The Availability Zone (AZ) where the DB instance will be created. Default: A + // random, system-chosen Availability Zone. Constraint: You can't specify the + // AvailabilityZone parameter if the DB instance is a Multi-AZ deployment. Example: + // us-east-1a + AvailabilityZone *string - // The amount of Provisioned IOPS (input/output operations per second) to be - // initially allocated for the DB instance. Constraints: Must be an integer greater - // than 1000. SQL Server Setting the IOPS value for the SQL Server database engine - // isn't supported. - Iops *int32 + // A value that indicates whether to copy all tags from the restored DB instance to + // snapshots of the DB instance. By default, tags are not copied. + CopyTagsToSnapshot *bool - // The list of logs that the restored DB instance is to export to CloudWatch Logs. - // The values in the list depend on the DB engine being used. For more information, - // see Publishing Database Logs to Amazon CloudWatch Logs - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) - // in the Amazon RDS User Guide. - EnableCloudwatchLogsExports []*string + // The compute and memory capacity of the Amazon RDS DB instance, for example, + // db.m4.large. Not all DB instance classes are available in all AWS Regions, or + // for all database engines. For the full list of DB instance classes, and + // availability for your engine, see DB Instance Class + // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) + // in the Amazon RDS User Guide. Default: The same DBInstanceClass as the original + // DB instance. + DBInstanceClass *string - // Specifies the storage type to be associated with the DB instance. Valid values: - // standard | gp2 | io1 If you specify io1, you must also include a value for the - // Iops parameter. Default: io1 if the Iops parameter is specified, otherwise gp2 - StorageType *string + // The database name for the restored DB instance. This parameter isn't used for + // the MySQL or MariaDB engines. + DBName *string - // The password for the given ARN from the key store in order to access the device. - TdeCredentialPassword *string + // The name of the DB parameter group to associate with this DB instance. If you do + // not specify a value for DBParameterGroupName, then the default DBParameterGroup + // for the specified DB engine is used. Constraints: + // + // * If supplied, must match + // the name of an existing DBParameterGroup. + // + // * Must be 1 to 255 letters, + // numbers, or hyphens. + // + // * First character must be a letter. + // + // * Can't end + // with a hyphen or contain two consecutive hyphens. + DBParameterGroupName *string // The DB subnet group name to use for the new instance. Constraints: If supplied, // must match the name of an existing DBSubnetGroup. Example: mySubnetgroup DBSubnetGroupName *string - // A value that indicates whether the DB instance is restored from the latest - // backup time. By default, the DB instance isn't restored from the latest backup - // time. Constraints: Can't be specified if the RestoreTime parameter is provided. - UseLatestRestorableTime *bool - // A value that indicates whether the DB instance has deletion protection enabled. // The database can't be deleted when deletion protection is enabled. By default, // deletion protection is disabled. For more information, see Deleting a DB @@ -127,29 +136,6 @@ type RestoreDBInstanceToPointInTimeInput struct { // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). DeletionProtection *bool - // The name of the option group to be used for the restored DB instance. - //

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, - // can't be removed from an option group, and that option group can't be removed - // from a DB instance once it is associated with a DB instance

    - OptionGroupName *string - - // The database name for the restored DB instance. This parameter isn't used for - // the MySQL or MariaDB engines. - DBName *string - - // A list of EC2 VPC security groups to associate with this DB instance. Default: - // The default EC2 VPC security group for the DB subnet group's VPC. - VpcSecurityGroupIds []*string - - // The Availability Zone (AZ) where the DB instance will be created. Default: A - // random, system-chosen Availability Zone. Constraint: You can't specify the - // AvailabilityZone parameter if the DB instance is a Multi-AZ deployment. Example: - // us-east-1a - AvailabilityZone *string - - // The resource ID of the source DB instance from which to restore. - SourceDbiResourceId *string - // Specify the Active Directory directory ID to restore the DB instance in. The // domain must be created prior to this operation. Currently, only Microsoft SQL // Server and Oracle DB instances can be created in an Active Directory Domain. For @@ -166,6 +152,17 @@ type RestoreDBInstanceToPointInTimeInput struct { // the Amazon RDS User Guide. Domain *string + // Specify the name of the IAM role to be used when making API calls to the + // Directory Service. + DomainIAMRoleName *string + + // The list of logs that the restored DB instance is to export to CloudWatch Logs. + // The values in the list depend on the DB engine being used. For more information, + // see Publishing Database Logs to Amazon CloudWatch Logs + // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) + // in the Amazon RDS User Guide. + EnableCloudwatchLogsExports []*string + // A value that indicates whether to enable mapping of AWS Identity and Access // Management (IAM) accounts to database accounts. By default, mapping is disabled. // For information about the supported DB engines, see CreateDBInstance ().

    For @@ -175,9 +172,45 @@ type RestoreDBInstanceToPointInTimeInput struct { // User Guide.

    EnableIAMDatabaseAuthentication *bool - // A value that indicates whether the DB instance class of the DB instance uses its - // default processor features. - UseDefaultProcessorFeatures *bool + // The database engine to use for the new instance. Default: The same as source + // Constraint: Must be compatible with the engine of the source

    Valid + // Values:

    + Engine *string + + // The amount of Provisioned IOPS (input/output operations per second) to be + // initially allocated for the DB instance. Constraints: Must be an integer greater + // than 1000. SQL Server Setting the IOPS value for the SQL Server database engine + // isn't supported. + Iops *int32 + + // License model information for the restored DB instance. Default: Same as source. + // Valid values: license-included | bring-your-own-license | general-public-license + LicenseModel *string + + // A value that indicates whether the DB instance is a Multi-AZ deployment. + // Constraint: You can't specify the AvailabilityZone parameter if the DB instance + // is a Multi-AZ deployment. + MultiAZ *bool + + // The name of the option group to be used for the restored DB instance. + //

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, + // can't be removed from an option group, and that option group can't be removed + // from a DB instance once it is associated with a DB instance

    + OptionGroupName *string + + // The port number on which the database accepts connections. Constraints: Value + // must be 1150-65535 Default: The same port as the original DB instance. + Port *int32 + + // The number of CPU cores and the number of threads per core for the DB instance + // class of the DB instance. + ProcessorFeatures []*types.ProcessorFeature // A value that indicates whether the DB instance is publicly accessible. When the // DB instance is publicly accessible, its DNS endpoint resolves to the private IP @@ -190,19 +223,6 @@ type RestoreDBInstanceToPointInTimeInput struct { // CreateDBInstance (). PubliclyAccessible *bool - // The port number on which the database accepts connections. Constraints: Value - // must be 1150-65535 Default: The same port as the original DB instance. - Port *int32 - - // A value that indicates whether the DB instance is a Multi-AZ deployment. - // Constraint: You can't specify the AvailabilityZone parameter if the DB instance - // is a Multi-AZ deployment. - MultiAZ *bool - - // Specify the name of the IAM role to be used when making API calls to the - // Directory Service. - DomainIAMRoleName *string - // The date and time to restore from. Valid Values: Value must be a time in // Universal Coordinated Time (UTC) format Constraints: // @@ -215,64 +235,44 @@ type RestoreDBInstanceToPointInTimeInput struct { // Example: 2009-09-07T23:45:00Z RestoreTime *time.Time - // The ARN from the key store with which to associate the instance for TDE - // encryption. - TdeCredentialArn *string - - // The name of the new DB instance to be created. Constraints: - // - // * Must contain - // from 1 to 63 letters, numbers, or hyphens - // - // * First character must be a - // letter + // The identifier of the source DB instance from which to restore. Constraints: // - // * Can't end with a hyphen or contain two consecutive hyphens // - // This member is required. - TargetDBInstanceIdentifier *string + // * Must match the identifier of an existing DB instance. + SourceDBInstanceIdentifier *string - // The number of CPU cores and the number of threads per core for the DB instance - // class of the DB instance. - ProcessorFeatures []*types.ProcessorFeature + // The resource ID of the source DB instance from which to restore. + SourceDbiResourceId *string + + // Specifies the storage type to be associated with the DB instance. Valid values: + // standard | gp2 | io1 If you specify io1, you must also include a value for the + // Iops parameter. Default: io1 if the Iops parameter is specified, otherwise gp2 + StorageType *string // A list of tags. For more information, see Tagging Amazon RDS Resources // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in // the Amazon RDS User Guide. Tags []*types.Tag - // The name of the DB parameter group to associate with this DB instance. If you do - // not specify a value for DBParameterGroupName, then the default DBParameterGroup - // for the specified DB engine is used. Constraints: - // - // * If supplied, must match - // the name of an existing DBParameterGroup. - // - // * Must be 1 to 255 letters, - // numbers, or hyphens. - // - // * First character must be a letter. - // - // * Can't end - // with a hyphen or contain two consecutive hyphens. - DBParameterGroupName *string + // The ARN from the key store with which to associate the instance for TDE + // encryption. + TdeCredentialArn *string - // A value that indicates whether minor version upgrades are applied automatically - // to the DB instance during the maintenance window. - AutoMinorVersionUpgrade *bool + // The password for the given ARN from the key store in order to access the device. + TdeCredentialPassword *string - // A value that indicates whether to copy all tags from the restored DB instance to - // snapshots of the DB instance. By default, tags are not copied. - CopyTagsToSnapshot *bool + // A value that indicates whether the DB instance class of the DB instance uses its + // default processor features. + UseDefaultProcessorFeatures *bool - // The compute and memory capacity of the Amazon RDS DB instance, for example, - // db.m4.large. Not all DB instance classes are available in all AWS Regions, or - // for all database engines. For the full list of DB instance classes, and - // availability for your engine, see DB Instance Class - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) - // in the Amazon RDS User Guide. Default: The same DBInstanceClass as the original - // DB instance. - DBInstanceClass *string + // A value that indicates whether the DB instance is restored from the latest + // backup time. By default, the DB instance isn't restored from the latest backup + // time. Constraints: Can't be specified if the RestoreTime parameter is provided. + UseLatestRestorableTime *bool + + // A list of EC2 VPC security groups to associate with this DB instance. Default: + // The default EC2 VPC security group for the DB subnet group's VPC. + VpcSecurityGroupIds []*string } type RestoreDBInstanceToPointInTimeOutput struct { diff --git a/service/rds/api_op_RevokeDBSecurityGroupIngress.go b/service/rds/api_op_RevokeDBSecurityGroupIngress.go index 5f767024c22..86b53bb3836 100644 --- a/service/rds/api_op_RevokeDBSecurityGroupIngress.go +++ b/service/rds/api_op_RevokeDBSecurityGroupIngress.go @@ -71,6 +71,11 @@ type RevokeDBSecurityGroupIngressInput struct { // can't be provided. CIDRIP *string + // The id of the EC2 security group to revoke access from. For VPC DB security + // groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId + // and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. + EC2SecurityGroupId *string + // The name of the EC2 security group to revoke access from. For VPC DB security // groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId // and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. @@ -82,11 +87,6 @@ type RevokeDBSecurityGroupIngressInput struct { // EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId // must be provided. EC2SecurityGroupOwnerId *string - - // The id of the EC2 security group to revoke access from. For VPC DB security - // groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId - // and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. - EC2SecurityGroupId *string } type RevokeDBSecurityGroupIngressOutput struct { diff --git a/service/rds/api_op_StartActivityStream.go b/service/rds/api_op_StartActivityStream.go index 3c8b7e10cec..cba0a551d12 100644 --- a/service/rds/api_op_StartActivityStream.go +++ b/service/rds/api_op_StartActivityStream.go @@ -60,16 +60,6 @@ func (c *Client) StartActivityStream(ctx context.Context, params *StartActivityS type StartActivityStreamInput struct { - // Specifies whether or not the database activity stream is to start as soon as - // possible, regardless of the maintenance window for the database. - ApplyImmediately *bool - - // The Amazon Resource Name (ARN) of the DB cluster, for example - // arn:aws:rds:us-east-1:12345667890:cluster:das-cluster. - // - // This member is required. - ResourceArn *string - // The AWS KMS key identifier for encrypting messages in the database activity // stream. The key identifier can be either a key ID, a key ARN, or a key alias. // @@ -82,10 +72,24 @@ type StartActivityStreamInput struct { // // This member is required. Mode types.ActivityStreamMode + + // The Amazon Resource Name (ARN) of the DB cluster, for example + // arn:aws:rds:us-east-1:12345667890:cluster:das-cluster. + // + // This member is required. + ResourceArn *string + + // Specifies whether or not the database activity stream is to start as soon as + // possible, regardless of the maintenance window for the database. + ApplyImmediately *bool } type StartActivityStreamOutput struct { + // Indicates whether or not the database activity stream will start as soon as + // possible, regardless of the maintenance window for the database. + ApplyImmediately *bool + // The name of the Amazon Kinesis data stream to be used for the database activity // stream. KinesisStreamName *string @@ -100,10 +104,6 @@ type StartActivityStreamOutput struct { // The status of the database activity stream. Status types.ActivityStreamStatus - // Indicates whether or not the database activity stream will start as soon as - // possible, regardless of the maintenance window for the database. - ApplyImmediately *bool - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/rds/api_op_StartExportTask.go b/service/rds/api_op_StartExportTask.go index 98deedefd4f..cfff7543142 100644 --- a/service/rds/api_op_StartExportTask.go +++ b/service/rds/api_op_StartExportTask.go @@ -64,6 +64,30 @@ type StartExportTaskInput struct { // This member is required. ExportTaskIdentifier *string + // The name of the IAM role to use for writing to the Amazon S3 bucket when + // exporting a snapshot. + // + // This member is required. + IamRoleArn *string + + // The ID of the AWS KMS key to use to encrypt the snapshot exported to Amazon S3. + // The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the + // KMS key alias for the KMS encryption key. The IAM role used for the snapshot + // export must have encryption and decryption permissions to use this KMS key. + // + // This member is required. + KmsKeyId *string + + // The name of the Amazon S3 bucket to export the snapshot to. + // + // This member is required. + S3BucketName *string + + // The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3. + // + // This member is required. + SourceArn *string + // The data to be exported from the snapshot. If this parameter is not provided, // all the snapshot data is exported. Valid values are the following: // @@ -83,30 +107,6 @@ type StartExportTaskInput struct { // PostgreSQL and Aurora PostgreSQL. ExportOnly []*string - // The name of the Amazon S3 bucket to export the snapshot to. - // - // This member is required. - S3BucketName *string - - // The ID of the AWS KMS key to use to encrypt the snapshot exported to Amazon S3. - // The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the - // KMS key alias for the KMS encryption key. The IAM role used for the snapshot - // export must have encryption and decryption permissions to use this KMS key. - // - // This member is required. - KmsKeyId *string - - // The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3. - // - // This member is required. - SourceArn *string - - // The name of the IAM role to use for writing to the Amazon S3 bucket when - // exporting a snapshot. - // - // This member is required. - IamRoleArn *string - // The Amazon S3 bucket prefix to use as the file name and path of the exported // snapshot. S3Prefix *string @@ -116,24 +116,23 @@ type StartExportTaskInput struct { // as a response element in the DescribeExportTasks action. type StartExportTaskOutput struct { - // The name of the IAM role that is used to write to Amazon S3 when exporting a - // snapshot. - IamRoleArn *string - - // The total amount of data exported, in gigabytes. - TotalExtractedDataInGB *int32 - - // The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3. - SourceArn *string - - // The Amazon S3 bucket that the snapshot is exported to. - S3Bucket *string - - // The time that the snapshot was created. - SnapshotTime *time.Time - - // The progress status of the export task. - Status *string + // The data exported from the snapshot. Valid values are the following: + // + // * + // database - Export all the data from a specified database. + // + // * database.table + // table-name - Export a table of the snapshot. This format is valid only for RDS + // for MySQL, RDS for MariaDB, and Aurora MySQL. + // + // * database.schema schema-name + // - Export a database schema of the snapshot. This format is valid only for RDS + // for PostgreSQL and Aurora PostgreSQL. + // + // * database.schema.table table-name - + // Export a table of the database schema. This format is valid only for RDS for + // PostgreSQL and Aurora PostgreSQL. + ExportOnly []*string // A unique identifier for the snapshot export task. This ID isn't an identifier // for the Amazon S3 bucket where the snapshot is exported to. @@ -142,12 +141,9 @@ type StartExportTaskOutput struct { // The reason the export failed, if it failed. FailureCause *string - // The progress of the snapshot export task as a percentage. - PercentProgress *int32 - - // The Amazon S3 bucket prefix that is the file name and path of the exported + // The name of the IAM role that is used to write to Amazon S3 when exporting a // snapshot. - S3Prefix *string + IamRoleArn *string // The ID of the AWS KMS key that is used to encrypt the snapshot when it's // exported to Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS @@ -156,33 +152,37 @@ type StartExportTaskOutput struct { // use this KMS key. KmsKeyId *string + // The progress of the snapshot export task as a percentage. + PercentProgress *int32 + + // The Amazon S3 bucket that the snapshot is exported to. + S3Bucket *string + + // The Amazon S3 bucket prefix that is the file name and path of the exported + // snapshot. + S3Prefix *string + + // The time that the snapshot was created. + SnapshotTime *time.Time + + // The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3. + SourceArn *string + + // The progress status of the export task. + Status *string + // The time that the snapshot export task completed. TaskEndTime *time.Time - // The data exported from the snapshot. Valid values are the following: - // - // * - // database - Export all the data from a specified database. - // - // * database.table - // table-name - Export a table of the snapshot. This format is valid only for RDS - // for MySQL, RDS for MariaDB, and Aurora MySQL. - // - // * database.schema schema-name - // - Export a database schema of the snapshot. This format is valid only for RDS - // for PostgreSQL and Aurora PostgreSQL. - // - // * database.schema.table table-name - - // Export a table of the database schema. This format is valid only for RDS for - // PostgreSQL and Aurora PostgreSQL. - ExportOnly []*string + // The time that the snapshot export task started. + TaskStartTime *time.Time + + // The total amount of data exported, in gigabytes. + TotalExtractedDataInGB *int32 // A warning about the snapshot export task. WarningMessage *string - // The time that the snapshot export task started. - TaskStartTime *time.Time - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/rds/api_op_StopActivityStream.go b/service/rds/api_op_StopActivityStream.go index a09f6144a3d..2b66e8e5fd0 100644 --- a/service/rds/api_op_StopActivityStream.go +++ b/service/rds/api_op_StopActivityStream.go @@ -61,19 +61,23 @@ func (c *Client) StopActivityStream(ctx context.Context, params *StopActivityStr type StopActivityStreamInput struct { - // Specifies whether or not the database activity stream is to stop as soon as - // possible, regardless of the maintenance window for the database. - ApplyImmediately *bool - // The Amazon Resource Name (ARN) of the DB cluster for the database activity // stream. For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster. // // This member is required. ResourceArn *string + + // Specifies whether or not the database activity stream is to stop as soon as + // possible, regardless of the maintenance window for the database. + ApplyImmediately *bool } type StopActivityStreamOutput struct { + // The name of the Amazon Kinesis data stream used for the database activity + // stream. + KinesisStreamName *string + // The AWS KMS key identifier used for encrypting messages in the database activity // stream. KmsKeyId *string @@ -81,10 +85,6 @@ type StopActivityStreamOutput struct { // The status of the database activity stream. Status types.ActivityStreamStatus - // The name of the Amazon Kinesis data stream used for the database activity - // stream. - KinesisStreamName *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/rds/go.mod b/service/rds/go.mod index 02e24881e5a..4bfe5d4a2c9 100644 --- a/service/rds/go.mod +++ b/service/rds/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/rds go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/rds/types/types.go b/service/rds/types/types.go index b52f443c452..ded381531f8 100644 --- a/service/rds/types/types.go +++ b/service/rds/types/types.go @@ -123,14 +123,14 @@ type AvailabilityZone struct { // in the Amazon RDS User Guide. type AvailableProcessorFeature struct { - // The name of the processor feature. Valid names are coreCount and threadsPerCore. - Name *string + // The allowed values for the processor feature of the DB instance class. + AllowedValues *string // The default value for the processor feature of the DB instance class. DefaultValue *string - // The allowed values for the processor feature of the DB instance class. - AllowedValues *string + // The name of the processor feature. Valid names are coreCount and threadsPerCore. + Name *string } // A CA certificate for an AWS account. @@ -145,32 +145,32 @@ type Certificate struct { // The type of the certificate. CertificateType *string + // Whether there is an override for the default certificate identifier. + CustomerOverride *bool + // If there is an override for the default certificate identifier, when the // override expires. CustomerOverrideValidTill *time.Time - // The final date that the certificate continues to be valid. - ValidTill *time.Time + // The thumbprint of the certificate. + Thumbprint *string // The starting date from which the certificate is valid. ValidFrom *time.Time - // The thumbprint of the certificate. - Thumbprint *string - - // Whether there is an override for the default certificate identifier. - CustomerOverride *bool + // The final date that the certificate continues to be valid. + ValidTill *time.Time } // This data type is used as a response element in the action // DescribeDBEngineVersions. type CharacterSet struct { - // The name of the character set. - CharacterSetName *string - // The description of the character set. CharacterSetDescription *string + + // The name of the character set. + CharacterSetName *string } // The configuration setting for the log types to be enabled for export to @@ -183,31 +183,22 @@ type CharacterSet struct { // in the Amazon RDS User Guide. type CloudwatchLogsExportConfiguration struct { - // The list of log types to enable. - EnableLogTypes []*string - // The list of log types to disable. DisableLogTypes []*string + + // The list of log types to enable. + EnableLogTypes []*string } // Specifies the settings that control the size and behavior of the connection pool // associated with a DBProxyTargetGroup. type ConnectionPoolConfiguration struct { - // Controls how actively the proxy closes idle database connections in the - // connection pool. A high value enables the proxy to leave a high percentage of - // idle connections open. A low value causes the proxy to close idle client - // connections and return the underlying database connections to the connection - // pool. For Aurora MySQL, it is expressed as a percentage of the max_connections - // setting for the RDS DB instance or Aurora DB cluster used by the target group. - // Default: 50 Constraints: between 0 and MaxConnectionsPercent - MaxIdleConnectionsPercent *int32 - - // Each item in the list represents a class of SQL operations that normally cause - // all later statements in a session using a proxy to be pinned to the same - // underlying database connection. Including an item in the list exempts that class - // of SQL operations from the pinning behavior. Default: no session pinning filters - SessionPinningFilters []*string + // The number of seconds for a proxy to wait for a connection to become available + // in the connection pool. Only applies when the proxy has opened its maximum + // number of connections and all connections are busy with client sessions. + // Default: 120 Constraints: between 1 and 3600, or 0 representing unlimited + ConnectionBorrowTimeout *int32 // One or more SQL statements for the proxy to run when opening each new database // connection. Typically used with SET statements to make sure that each connection @@ -223,23 +214,30 @@ type ConnectionPoolConfiguration struct { // Constraints: between 1 and 100 MaxConnectionsPercent *int32 - // The number of seconds for a proxy to wait for a connection to become available - // in the connection pool. Only applies when the proxy has opened its maximum - // number of connections and all connections are busy with client sessions. - // Default: 120 Constraints: between 1 and 3600, or 0 representing unlimited - ConnectionBorrowTimeout *int32 + // Controls how actively the proxy closes idle database connections in the + // connection pool. A high value enables the proxy to leave a high percentage of + // idle connections open. A low value causes the proxy to close idle client + // connections and return the underlying database connections to the connection + // pool. For Aurora MySQL, it is expressed as a percentage of the max_connections + // setting for the RDS DB instance or Aurora DB cluster used by the target group. + // Default: 50 Constraints: between 0 and MaxConnectionsPercent + MaxIdleConnectionsPercent *int32 + + // Each item in the list represents a class of SQL operations that normally cause + // all later statements in a session using a proxy to be pinned to the same + // underlying database connection. Including an item in the list exempts that class + // of SQL operations from the pinning behavior. Default: no session pinning filters + SessionPinningFilters []*string } // Displays the settings that control the size and behavior of the connection pool // associated with a DBProxyTarget. type ConnectionPoolConfigurationInfo struct { - // Each item in the list represents a class of SQL operations that normally cause - // all later statements in a session using a proxy to be pinned to the same - // underlying database connection. Including an item in the list exempts that class - // of SQL operations from the pinning behavior. Currently, the only allowed value - // is EXCLUDE_VARIABLE_SETS. - SessionPinningFilters []*string + // The number of seconds for a proxy to wait for a connection to become available + // in the connection pool. Only applies when the proxy has opened its maximum + // number of connections and all connections are busy with client sessions. + ConnectionBorrowTimeout *int32 // One or more SQL statements for the proxy to run when opening each new database // connection. Typically used with SET statements to make sure that each connection @@ -249,10 +247,10 @@ type ConnectionPoolConfigurationInfo struct { // y=2. InitQuery *string - // The number of seconds for a proxy to wait for a connection to become available - // in the connection pool. Only applies when the proxy has opened its maximum - // number of connections and all connections are busy with client sessions. - ConnectionBorrowTimeout *int32 + // The maximum size of the connection pool for each target in a target group. For + // Aurora MySQL, it is expressed as a percentage of the max_connections setting for + // the RDS DB instance or Aurora DB cluster used by the target group. + MaxConnectionsPercent *int32 // Controls how actively the proxy closes idle database connections in the // connection pool. A high value enables the proxy to leave a high percentage of @@ -262,10 +260,12 @@ type ConnectionPoolConfigurationInfo struct { // setting for the RDS DB instance or Aurora DB cluster used by the target group. MaxIdleConnectionsPercent *int32 - // The maximum size of the connection pool for each target in a target group. For - // Aurora MySQL, it is expressed as a percentage of the max_connections setting for - // the RDS DB instance or Aurora DB cluster used by the target group. - MaxConnectionsPercent *int32 + // Each item in the list represents a class of SQL operations that normally cause + // all later statements in a session using a proxy to be pinned to the same + // underlying database connection. Including an item in the list exempts that class + // of SQL operations from the pinning behavior. Currently, the only allowed value + // is EXCLUDE_VARIABLE_SETS. + SessionPinningFilters []*string } // A custom Availability Zone (AZ) is an on-premises AZ that is integrated with a @@ -281,12 +281,12 @@ type CustomAvailabilityZone struct { // The name of the custom AZ. CustomAvailabilityZoneName *string + // The status of the custom AZ. + CustomAvailabilityZoneStatus *string + // Information about the virtual private network (VPN) between the VMware vSphere // cluster and the AWS website. VpnDetails *VpnDetails - - // The status of the custom AZ. - CustomAvailabilityZoneStatus *string } // Contains the details of an Amazon Aurora DB cluster. This data type is used as a @@ -294,17 +294,47 @@ type CustomAvailabilityZone struct { // actions. type DBCluster struct { - // Provides a list of VPC security groups that the DB cluster belongs to. - VpcSecurityGroups []*VpcSecurityGroupMembership - - // Contains the identifier of the source DB cluster if this DB cluster is a read - // replica. - ReplicationSourceIdentifier *string + // The name of the Amazon Kinesis data stream used for the database activity + // stream. + ActivityStreamKinesisStreamName *string // The AWS KMS key identifier used for encrypting messages in the database activity // stream. ActivityStreamKmsKeyId *string + // The mode of the database activity stream. Database events such as a change or + // access generate an activity stream event. The database session can handle these + // events either synchronously or asynchronously. + ActivityStreamMode ActivityStreamMode + + // The status of the database activity stream. + ActivityStreamStatus ActivityStreamStatus + + // For all database engines except Amazon Aurora, AllocatedStorage specifies the + // allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always + // returns 1, because Aurora DB cluster storage size isn't fixed, but instead + // automatically adjusts as needed. + AllocatedStorage *int32 + + // Provides a list of the AWS Identity and Access Management (IAM) roles that are + // associated with the DB cluster. IAM roles that are associated with a DB cluster + // grant permission for the DB cluster to access other AWS services on your behalf. + AssociatedRoles []*DBClusterRole + + // Provides the list of Availability Zones (AZs) where instances in the DB cluster + // can be created. + AvailabilityZones []*string + + // The number of change records stored for Backtrack. + BacktrackConsumedChangeRecords *int64 + + // The target backtrack window, in seconds. If this value is set to 0, backtracking + // is disabled for the DB cluster. Otherwise, backtracking is enabled. + BacktrackWindow *int64 + + // Specifies the number of days for which automatic DB snapshots are retained. + BackupRetentionPeriod *int32 + // The current capacity of an Aurora Serverless DB cluster. The capacity is 0 // (zero) when the cluster is paused. For more information about Aurora Serverless, // see Using Amazon Aurora Serverless @@ -312,56 +342,84 @@ type DBCluster struct { // in the Amazon Aurora User Guide. Capacity *int32 - // Specifies the connection endpoint for the primary instance of the DB cluster. - Endpoint *string - - // The earliest time to which a DB cluster can be backtracked. - EarliestBacktrackTime *time.Time + // If present, specifies the name of the character set that this cluster is + // associated with. + CharacterSetName *string - // A value that indicates whether the mapping of AWS Identity and Access Management - // (IAM) accounts to database accounts is enabled. - IAMDatabaseAuthenticationEnabled *bool + // Identifies the clone group to which the DB cluster is associated. + CloneGroupId *string - // Specifies whether the DB cluster is encrypted. - StorageEncrypted *bool + // Specifies the time when the DB cluster was created, in Universal Coordinated + // Time (UTC). + ClusterCreateTime *time.Time - // If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB + // Specifies whether tags are copied from the DB cluster to snapshots of the DB // cluster. - KmsKeyId *string + CopyTagsToSnapshot *bool - // Specifies the port that the database engine is listening on. - Port *int32 + // Specifies whether the DB cluster is a clone of a DB cluster owned by a different + // AWS account. + CrossAccountClone *bool - // A value that indicates whether the HTTP endpoint for an Aurora Serverless DB - // cluster is enabled. When enabled, the HTTP endpoint provides a connectionless - // web service API for running SQL queries on the Aurora Serverless DB cluster. You - // can also query your database from inside the RDS console with the query editor. - // For more information, see Using the Data API for Aurora Serverless - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in - // the Amazon Aurora User Guide. - HttpEndpointEnabled *bool + // Identifies all custom endpoints associated with the cluster. + CustomEndpoints []*string + + // The Amazon Resource Name (ARN) for the DB cluster. + DBClusterArn *string + + // Contains a user-supplied DB cluster identifier. This identifier is the unique + // key that identifies a DB cluster. + DBClusterIdentifier *string // Provides the list of instances that make up the DB cluster. DBClusterMembers []*DBClusterMember + // Provides the list of option group memberships for this DB cluster. + DBClusterOptionGroupMemberships []*DBClusterOptionGroupStatus + + // Specifies the name of the DB cluster parameter group for the DB cluster. + DBClusterParameterGroup *string + + // Specifies information on the subnet group associated with the DB cluster, + // including the name, description, and subnets in the subnet group. + DBSubnetGroup *string + + // Contains the name of the initial database of this DB cluster that was provided + // at create time, if one was specified when the DB cluster was created. This same + // name is returned for the life of the DB cluster. + DatabaseName *string + // The AWS Region-unique, immutable identifier for the DB cluster. This identifier // is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB // cluster is accessed. DbClusterResourceId *string + // Indicates if the DB cluster has deletion protection enabled. The database can't + // be deleted when deletion protection is enabled. + DeletionProtection *bool + // The Active Directory Domain membership records associated with the DB cluster. DomainMemberships []*DomainMembership - // The reader endpoint for the DB cluster. The reader endpoint for a DB cluster - // load-balances connections across the Aurora Replicas that are available in a DB - // cluster. As clients request new connections to the reader endpoint, Aurora - // distributes the connection requests among the Aurora Replicas in the DB cluster. - // This functionality can help balance your read workload across multiple Aurora - // Replicas in your DB cluster. If a failover occurs, and the Aurora Replica that - // you are connected to is promoted to be the primary instance, your connection is - // dropped. To continue sending your read workload to other Aurora Replicas in the - // cluster, you can then reconnect to the reader endpoint. - ReaderEndpoint *string + // The earliest time to which a DB cluster can be backtracked. + EarliestBacktrackTime *time.Time + + // The earliest time to which a database can be restored with point-in-time + // restore. + EarliestRestorableTime *time.Time + + // A list of log types that this DB cluster is configured to export to CloudWatch + // Logs. Log types vary by DB engine. For information about the log types for each + // DB engine, see Amazon RDS Database Log Files + // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html) + // in the Amazon Aurora User Guide. + EnabledCloudwatchLogsExports []*string + + // Specifies the connection endpoint for the primary instance of the DB cluster. + Endpoint *string + + // Provides the name of the database engine to be used for this DB cluster. + Engine *string // The DB engine mode of the DB cluster, either provisioned, serverless, // parallelquery, global, or multimaster. global engine mode only applies for @@ -372,176 +430,118 @@ type DBCluster struct { // DescribeDBClusters. EngineMode *string - // Specifies the number of days for which automatic DB snapshots are retained. - BackupRetentionPeriod *int32 - - // The earliest time to which a database can be restored with point-in-time - // restore. - EarliestRestorableTime *time.Time + // Indicates the database engine version. + EngineVersion *string - // The status of the database activity stream. - ActivityStreamStatus ActivityStreamStatus + // Specifies whether you have requested to enable write forwarding for a secondary + // cluster in an Aurora global database. Because write forwarding takes time to + // enable, check the value of GlobalWriteForwardingStatus to confirm that the + // request has completed before using the write forwarding feature for this + // cluster. + GlobalWriteForwardingRequested *bool - // Specifies whether the DB cluster is a clone of a DB cluster owned by a different - // AWS account. - CrossAccountClone *bool - - // The target backtrack window, in seconds. If this value is set to 0, backtracking - // is disabled for the DB cluster. Otherwise, backtracking is enabled. - BacktrackWindow *int64 - - // Contains the master username for the DB cluster. - MasterUsername *string - - // Shows the scaling configuration for an Aurora DB cluster in serverless DB engine - // mode. For more information, see Using Amazon Aurora Serverless - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) - // in the Amazon Aurora User Guide. - ScalingConfigurationInfo *ScalingConfigurationInfo + // Specifies whether a secondary cluster in an Aurora global database has write + // forwarding enabled, not enabled, or is in the process of enabling it. + GlobalWriteForwardingStatus WriteForwardingStatus - // Indicates if the DB cluster has deletion protection enabled. The database can't - // be deleted when deletion protection is enabled. - DeletionProtection *bool + // Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. + HostedZoneId *string - // Specifies the name of the DB cluster parameter group for the DB cluster. - DBClusterParameterGroup *string + // A value that indicates whether the HTTP endpoint for an Aurora Serverless DB + // cluster is enabled. When enabled, the HTTP endpoint provides a connectionless + // web service API for running SQL queries on the Aurora Serverless DB cluster. You + // can also query your database from inside the RDS console with the query editor. + // For more information, see Using the Data API for Aurora Serverless + // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in + // the Amazon Aurora User Guide. + HttpEndpointEnabled *bool - // Specifies whether the DB cluster has instances in multiple Availability Zones. - MultiAZ *bool + // A value that indicates whether the mapping of AWS Identity and Access Management + // (IAM) accounts to database accounts is enabled. + IAMDatabaseAuthenticationEnabled *bool - // Provides a list of the AWS Identity and Access Management (IAM) roles that are - // associated with the DB cluster. IAM roles that are associated with a DB cluster - // grant permission for the DB cluster to access other AWS services on your behalf. - AssociatedRoles []*DBClusterRole + // If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB + // cluster. + KmsKeyId *string // Specifies the latest time to which a database can be restored with point-in-time // restore. LatestRestorableTime *time.Time - // Identifies all custom endpoints associated with the cluster. - CustomEndpoints []*string - - // Contains one or more identifiers of the read replicas associated with this DB - // cluster. - ReadReplicaIdentifiers []*string - - // The number of change records stored for Backtrack. - BacktrackConsumedChangeRecords *int64 - - // Contains the name of the initial database of this DB cluster that was provided - // at create time, if one was specified when the DB cluster was created. This same - // name is returned for the life of the DB cluster. - DatabaseName *string + // Contains the master username for the DB cluster. + MasterUsername *string - // If present, specifies the name of the character set that this cluster is - // associated with. - CharacterSetName *string + // Specifies whether the DB cluster has instances in multiple Availability Zones. + MultiAZ *bool // Specifies the progress of the operation as a percentage. PercentProgress *string - // The mode of the database activity stream. Database events such as a change or - // access generate an activity stream event. The database session can handle these - // events either synchronously or asynchronously. - ActivityStreamMode ActivityStreamMode - - // For all database engines except Amazon Aurora, AllocatedStorage specifies the - // allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always - // returns 1, because Aurora DB cluster storage size isn't fixed, but instead - // automatically adjusts as needed. - AllocatedStorage *int32 - - // Indicates the database engine version. - EngineVersion *string - - // Specifies the current state of this DB cluster. - Status *string - - // Identifies the clone group to which the DB cluster is associated. - CloneGroupId *string - - // Specifies the time when the DB cluster was created, in Universal Coordinated - // Time (UTC). - ClusterCreateTime *time.Time - - // Provides the name of the database engine to be used for this DB cluster. - Engine *string - - // Specifies whether a secondary cluster in an Aurora global database has write - // forwarding enabled, not enabled, or is in the process of enabling it. - GlobalWriteForwardingStatus WriteForwardingStatus - - // Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. - HostedZoneId *string - - // The name of the Amazon Kinesis data stream used for the database activity - // stream. - ActivityStreamKinesisStreamName *string + // Specifies the port that the database engine is listening on. + Port *int32 // Specifies the daily time range during which automated backups are created if // automated backups are enabled, as determined by the BackupRetentionPeriod. PreferredBackupWindow *string - // Contains a user-supplied DB cluster identifier. This identifier is the unique - // key that identifies a DB cluster. - DBClusterIdentifier *string + // Specifies the weekly time range during which system maintenance can occur, in + // Universal Coordinated Time (UTC). + PreferredMaintenanceWindow *string - // Provides the list of option group memberships for this DB cluster. - DBClusterOptionGroupMemberships []*DBClusterOptionGroupStatus + // Contains one or more identifiers of the read replicas associated with this DB + // cluster. + ReadReplicaIdentifiers []*string - // Provides the list of Availability Zones (AZs) where instances in the DB cluster - // can be created. - AvailabilityZones []*string + // The reader endpoint for the DB cluster. The reader endpoint for a DB cluster + // load-balances connections across the Aurora Replicas that are available in a DB + // cluster. As clients request new connections to the reader endpoint, Aurora + // distributes the connection requests among the Aurora Replicas in the DB cluster. + // This functionality can help balance your read workload across multiple Aurora + // Replicas in your DB cluster. If a failover occurs, and the Aurora Replica that + // you are connected to is promoted to be the primary instance, your connection is + // dropped. To continue sending your read workload to other Aurora Replicas in the + // cluster, you can then reconnect to the reader endpoint. + ReaderEndpoint *string - // The Amazon Resource Name (ARN) for the DB cluster. - DBClusterArn *string + // Contains the identifier of the source DB cluster if this DB cluster is a read + // replica. + ReplicationSourceIdentifier *string - // A list of log types that this DB cluster is configured to export to CloudWatch - // Logs. Log types vary by DB engine. For information about the log types for each - // DB engine, see Amazon RDS Database Log Files - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html) + // Shows the scaling configuration for an Aurora DB cluster in serverless DB engine + // mode. For more information, see Using Amazon Aurora Serverless + // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) // in the Amazon Aurora User Guide. - EnabledCloudwatchLogsExports []*string - - // Specifies the weekly time range during which system maintenance can occur, in - // Universal Coordinated Time (UTC). - PreferredMaintenanceWindow *string + ScalingConfigurationInfo *ScalingConfigurationInfo - // Specifies information on the subnet group associated with the DB cluster, - // including the name, description, and subnets in the subnet group. - DBSubnetGroup *string + // Specifies the current state of this DB cluster. + Status *string - // Specifies whether you have requested to enable write forwarding for a secondary - // cluster in an Aurora global database. Because write forwarding takes time to - // enable, check the value of GlobalWriteForwardingStatus to confirm that the - // request has completed before using the write forwarding feature for this - // cluster. - GlobalWriteForwardingRequested *bool + // Specifies whether the DB cluster is encrypted. + StorageEncrypted *bool - // Specifies whether tags are copied from the DB cluster to snapshots of the DB - // cluster. - CopyTagsToSnapshot *bool + // Provides a list of VPC security groups that the DB cluster belongs to. + VpcSecurityGroups []*VpcSecurityGroupMembership } // This data type is used as a response element in the DescribeDBClusterBacktracks // action. type DBClusterBacktrack struct { - // The timestamp of the time to which the DB cluster was backtracked. - BacktrackTo *time.Time + // Contains the backtrack identifier. + BacktrackIdentifier *string // The timestamp of the time at which the backtrack was requested. BacktrackRequestCreationTime *time.Time - // Contains a user-supplied DB cluster identifier. This identifier is the unique - // key that identifies a DB cluster. - DBClusterIdentifier *string + // The timestamp of the time to which the DB cluster was backtracked. + BacktrackTo *time.Time // The timestamp of the time from which the DB cluster was backtracked. BacktrackedFrom *time.Time - // Contains the backtrack identifier. - BacktrackIdentifier *string + // Contains a user-supplied DB cluster identifier. This identifier is the unique + // key that identifies a DB cluster. + DBClusterIdentifier *string // The status of the backtrack. This property returns one of the following // values: @@ -578,46 +578,53 @@ type DBClusterBacktrack struct { // that represents Amazon RDS DB instance endpoints, see Endpoint. type DBClusterEndpoint struct { + // The type associated with a custom endpoint. One of: READER, WRITER, ANY. + CustomEndpointType *string + + // The Amazon Resource Name (ARN) for the endpoint. + DBClusterEndpointArn *string + // The identifier associated with the endpoint. This parameter is stored as a // lowercase string. DBClusterEndpointIdentifier *string + // A unique system-generated identifier for an endpoint. It remains the same for + // the whole life of the endpoint. + DBClusterEndpointResourceIdentifier *string + // The DB cluster identifier of the DB cluster associated with the endpoint. This // parameter is stored as a lowercase string. DBClusterIdentifier *string - // The type of the endpoint. One of: READER, WRITER, CUSTOM. - EndpointType *string - // The DNS address of the endpoint. Endpoint *string - // A unique system-generated identifier for an endpoint. It remains the same for - // the whole life of the endpoint. - DBClusterEndpointResourceIdentifier *string + // The type of the endpoint. One of: READER, WRITER, CUSTOM. + EndpointType *string // List of DB instance identifiers that aren't part of the custom endpoint group. // All other eligible instances are reachable through the custom endpoint. Only // relevant if the list of static members is empty. ExcludedMembers []*string + // List of DB instance identifiers that are part of the custom endpoint group. + StaticMembers []*string + // The current status of the endpoint. One of: creating, available, deleting, // modifying. Status *string - - // The Amazon Resource Name (ARN) for the endpoint. - DBClusterEndpointArn *string - - // The type associated with a custom endpoint. One of: READER, WRITER, ANY. - CustomEndpointType *string - - // List of DB instance identifiers that are part of the custom endpoint group. - StaticMembers []*string } // Contains information about an instance that is part of a DB cluster. type DBClusterMember struct { + // Specifies the status of the DB cluster parameter group for this member of the DB + // cluster. + DBClusterParameterGroupStatus *string + + // Specifies the instance identifier for this member of the DB cluster. + DBInstanceIdentifier *string + // Value that is true if the cluster member is the primary instance for the DB // cluster and false otherwise. IsClusterWriter *bool @@ -628,29 +635,25 @@ type DBClusterMember struct { // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) // in the Amazon Aurora User Guide. PromotionTier *int32 - - // Specifies the instance identifier for this member of the DB cluster. - DBInstanceIdentifier *string - - // Specifies the status of the DB cluster parameter group for this member of the DB - // cluster. - DBClusterParameterGroupStatus *string } // Contains status information for a DB cluster option group. type DBClusterOptionGroupStatus struct { - // Specifies the status of the DB cluster option group. - Status *string - // Specifies the name of the DB cluster option group. DBClusterOptionGroupName *string + + // Specifies the status of the DB cluster option group. + Status *string } // Contains the details of an Amazon RDS DB cluster parameter group. This data type // is used as a response element in the DescribeDBClusterParameterGroups action. type DBClusterParameterGroup struct { + // The Amazon Resource Name (ARN) for the DB cluster parameter group. + DBClusterParameterGroupArn *string + // Provides the name of the DB cluster parameter group. DBClusterParameterGroupName *string @@ -660,15 +663,20 @@ type DBClusterParameterGroup struct { // Provides the customer-specified description for this DB cluster parameter group. Description *string - - // The Amazon Resource Name (ARN) for the DB cluster parameter group. - DBClusterParameterGroupArn *string } // Describes an AWS Identity and Access Management (IAM) role that is associated // with a DB cluster. type DBClusterRole struct { + // The name of the feature associated with the AWS Identity and Access Management + // (IAM) role. For the list of supported feature names, see DBEngineVersion (). + FeatureName *string + + // The Amazon Resource Name (ARN) of the IAM role that is associated with the DB + // cluster. + RoleArn *string + // Describes the state of association between the IAM role and the DB cluster. The // Status property returns one of the following values: // @@ -683,88 +691,80 @@ type DBClusterRole struct { // cluster, but the DB cluster is unable to assume the IAM role in order to access // other AWS services on your behalf. Status *string - - // The Amazon Resource Name (ARN) of the IAM role that is associated with the DB - // cluster. - RoleArn *string - - // The name of the feature associated with the AWS Identity and Access Management - // (IAM) role. For the list of supported feature names, see DBEngineVersion (). - FeatureName *string } // Contains the details for an Amazon RDS DB cluster snapshot This data type is // used as a response element in the DescribeDBClusterSnapshots action. type DBClusterSnapshot struct { - // Specifies the name of the database engine. - Engine *string - - // Provides the version of the database engine for this DB cluster snapshot. - EngineVersion *string - - // Specifies whether the DB cluster snapshot is encrypted. - StorageEncrypted *bool - - // Provides the license model information for this DB cluster snapshot. - LicenseModel *string - - // Provides the time when the snapshot was taken, in Universal Coordinated Time - // (UTC). - SnapshotCreateTime *time.Time + // Specifies the allocated storage size in gibibytes (GiB). + AllocatedStorage *int32 // Provides the list of Availability Zones (AZs) where instances in the DB cluster // snapshot can be restored. AvailabilityZones []*string - // If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB - // cluster snapshot. - KmsKeyId *string - - // Provides the VPC ID associated with the DB cluster snapshot. - VpcId *string + // Specifies the time when the DB cluster was created, in Universal Coordinated + // Time (UTC). + ClusterCreateTime *time.Time // Specifies the DB cluster identifier of the DB cluster that this DB cluster // snapshot was created from. DBClusterIdentifier *string + // The Amazon Resource Name (ARN) for the DB cluster snapshot. + DBClusterSnapshotArn *string + + // Specifies the identifier for the DB cluster snapshot. + DBClusterSnapshotIdentifier *string + + // Specifies the name of the database engine. + Engine *string + + // Provides the version of the database engine for this DB cluster snapshot. + EngineVersion *string + // True if mapping of AWS Identity and Access Management (IAM) accounts to database // accounts is enabled, and otherwise false. IAMDatabaseAuthenticationEnabled *bool - // The Amazon Resource Name (ARN) for the DB cluster snapshot. - DBClusterSnapshotArn *string + // If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB + // cluster snapshot. + KmsKeyId *string - // Provides the type of the DB cluster snapshot. - SnapshotType *string + // Provides the license model information for this DB cluster snapshot. + LicenseModel *string // Provides the master username for the DB cluster snapshot. MasterUsername *string - // Specifies the allocated storage size in gibibytes (GiB). - AllocatedStorage *int32 + // Specifies the percentage of the estimated data that has been transferred. + PercentProgress *int32 // Specifies the port that the DB cluster was listening on at the time of the // snapshot. Port *int32 - // Specifies the identifier for the DB cluster snapshot. - DBClusterSnapshotIdentifier *string - - // Specifies the percentage of the estimated data that has been transferred. - PercentProgress *int32 - - // Specifies the status of this DB cluster snapshot. - Status *string + // Provides the time when the snapshot was taken, in Universal Coordinated Time + // (UTC). + SnapshotCreateTime *time.Time - // Specifies the time when the DB cluster was created, in Universal Coordinated - // Time (UTC). - ClusterCreateTime *time.Time + // Provides the type of the DB cluster snapshot. + SnapshotType *string // If the DB cluster snapshot was copied from a source DB cluster snapshot, the // Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null // value. SourceDBClusterSnapshotArn *string + + // Specifies the status of this DB cluster snapshot. + Status *string + + // Specifies whether the DB cluster snapshot is encrypted. + StorageEncrypted *bool + + // Provides the VPC ID associated with the DB cluster snapshot. + VpcId *string } // Contains the name and values of a manual DB cluster snapshot attribute. Manual @@ -773,18 +773,18 @@ type DBClusterSnapshot struct { // ModifyDBClusterSnapshotAttribute API action. type DBClusterSnapshotAttribute struct { + // The name of the manual DB cluster snapshot attribute. The attribute named + // restore refers to the list of AWS accounts that have permission to copy or + // restore the manual DB cluster snapshot. For more information, see the + // ModifyDBClusterSnapshotAttribute API action. + AttributeName *string + // The value(s) for the manual DB cluster snapshot attribute. If the AttributeName // field is set to restore, then this element returns a list of IDs of the AWS // accounts that are authorized to copy or restore the manual DB cluster snapshot. // If a value of all is in the list, then the manual DB cluster snapshot is public // and available for any AWS account to copy or restore. AttributeValues []*string - - // The name of the manual DB cluster snapshot attribute. The attribute named - // restore refers to the list of AWS accounts that have permission to copy or - // restore the manual DB cluster snapshot. For more information, see the - // ModifyDBClusterSnapshotAttribute API action. - AttributeName *string } // Contains the results of a successful call to the @@ -805,149 +805,123 @@ type DBClusterSnapshotAttributesResult struct { // DescribeDBEngineVersions. type DBEngineVersion struct { - // The types of logs that the database engine has available for export to - // CloudWatch Logs. - ExportableLogTypes []*string + // The description of the database engine. + DBEngineDescription *string + + // The description of the database engine version. + DBEngineVersionDescription *string + + // The name of the DB parameter group family for the database engine. + DBParameterGroupFamily *string // The default character set for new instances of this engine version, if the // CharacterSetName parameter of the CreateDBInstance API isn't specified. DefaultCharacterSet *CharacterSet - // A list of engine versions that this database engine version can be upgraded to. - ValidUpgradeTarget []*UpgradeTarget - - // A list of features supported by the DB engine. Supported feature names include - // the following. - // - // * s3Import - SupportedFeatureNames []*string - - // A value that indicates whether you can use Aurora parallel query with a specific - // DB engine version. - SupportsParallelQuery *bool + // The name of the database engine. + Engine *string // The version number of the database engine. EngineVersion *string + // The types of logs that the database engine has available for export to + // CloudWatch Logs. + ExportableLogTypes []*string + + // The status of the DB engine version, either available or deprecated. + Status *string + + // A list of the character sets supported by this engine for the CharacterSetName + // parameter of the CreateDBInstance action. + SupportedCharacterSets []*CharacterSet + // A list of the supported DB engine modes. global engine mode only applies for // global database clusters created with Aurora MySQL version 5.6.10a. For higher // Aurora MySQL versions, the clusters in a global database use provisioned engine // mode. SupportedEngineModes []*string + // A list of features supported by the DB engine. Supported feature names include + // the following. + // + // * s3Import + SupportedFeatureNames []*string + // A list of the time zones supported by this engine for the Timezone parameter of // the CreateDBInstance action. SupportedTimezones []*Timezone - // The description of the database engine. - DBEngineDescription *string - - // Indicates whether the database engine version supports read replicas. - SupportsReadReplica *bool - - // The name of the database engine. - Engine *string - - // The name of the DB parameter group family for the database engine. - DBParameterGroupFamily *string - - // The status of the DB engine version, either available or deprecated. - Status *string - - // A list of the character sets supported by this engine for the CharacterSetName - // parameter of the CreateDBInstance action. - SupportedCharacterSets []*CharacterSet + // A value that indicates whether you can use Aurora global databases with a + // specific DB engine version. + SupportsGlobalDatabases *bool // A value that indicates whether the engine version supports exporting the log // types specified by ExportableLogTypes to CloudWatch Logs. SupportsLogExportsToCloudwatchLogs *bool - // A value that indicates whether you can use Aurora global databases with a - // specific DB engine version. - SupportsGlobalDatabases *bool + // A value that indicates whether you can use Aurora parallel query with a specific + // DB engine version. + SupportsParallelQuery *bool - // The description of the database engine version. - DBEngineVersionDescription *string + // Indicates whether the database engine version supports read replicas. + SupportsReadReplica *bool + + // A list of engine versions that this database engine version can be upgraded to. + ValidUpgradeTarget []*UpgradeTarget } // Contains the details of an Amazon RDS DB instance. This data type is used as a // response element in the DescribeDBInstances action. type DBInstance struct { - // If present, specifies the name of the character set that this instance is - // associated with. - CharacterSetName *string - - // Specifies the daily time range during which automated backups are created if - // automated backups are enabled, as determined by the BackupRetentionPeriod. - PreferredBackupWindow *string - - // Provides the date and time the DB instance was created. - InstanceCreateTime *time.Time - - // The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to - // Amazon CloudWatch Logs. - MonitoringRoleArn *string - - // Contains the master username for the DB instance. - MasterUsername *string - - // The number of CPU cores and the number of threads per core for the DB instance - // class of the DB instance. - ProcessorFeatures []*ProcessorFeature - - // Specifies the listener connection endpoint for SQL Server Always On. - ListenerEndpoint *Endpoint - - // Contains a user-supplied database identifier. This identifier is the unique key - // that identifies a DB instance. - DBInstanceIdentifier *string + // Specifies the allocated storage size specified in gibibytes. + AllocatedStorage *int32 - // A value that specifies the order in which an Aurora Replica is promoted to the - // primary instance after a failure of the existing primary instance. For more - // information, see Fault Tolerance for an Aurora DB Cluster - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) - // in the Amazon Aurora User Guide. - PromotionTier *int32 + // The AWS Identity and Access Management (IAM) roles associated with the DB + // instance. + AssociatedRoles []*DBInstanceRole - // The amount of time, in days, to retain Performance Insights data. Valid values - // are 7 or 731 (2 years). - PerformanceInsightsRetentionPeriod *int32 + // Indicates that minor version patches are applied automatically. + AutoMinorVersionUpgrade *bool - // Specifies the storage type associated with DB instance. - StorageType *string + // Specifies the name of the Availability Zone the DB instance is located in. + AvailabilityZone *string - // Specifies the weekly time range during which system maintenance can occur, in - // Universal Coordinated Time (UTC). - PreferredMaintenanceWindow *string + // Specifies the number of days for which automatic DB snapshots are retained. + BackupRetentionPeriod *int32 - // License model information for this DB instance. - LicenseModel *string + // The identifier of the CA certificate for this DB instance. + CACertificateIdentifier *string - // Contains the identifier of the source DB instance if this DB instance is a read - // replica. - ReadReplicaSourceDBInstanceIdentifier *string + // If present, specifies the name of the character set that this instance is + // associated with. + CharacterSetName *string - // Specifies information on the subnet group associated with the DB instance, - // including the name, description, and subnets in the subnet group. - DBSubnetGroup *DBSubnetGroup + // Specifies whether tags are copied from the DB instance to snapshots of the DB + // instance. Amazon Aurora Not applicable. Copying tags to snapshots is managed by + // the DB cluster. Setting this value for an Aurora DB instance has no effect on + // the DB cluster setting. For more information, see DBCluster. + CopyTagsToSnapshot *bool - // Specifies the allocated storage size specified in gibibytes. - AllocatedStorage *int32 + // If the DB instance is a member of a DB cluster, contains the name of the DB + // cluster that the DB instance is a member of. + DBClusterIdentifier *string - // Specifies the connection endpoint. - Endpoint *Endpoint + // The Amazon Resource Name (ARN) for the DB instance. + DBInstanceArn *string - // Contains one or more identifiers of the read replicas associated with this DB - // instance. - ReadReplicaDBInstanceIdentifiers []*string + // Contains the name of the compute and memory capacity class of the DB instance. + DBInstanceClass *string - // Specifies the port that the DB instance listens on. If the DB instance is part - // of a DB cluster, this can be a different port than the DB cluster port. - DbInstancePort *int32 + // Contains a user-supplied database identifier. This identifier is the unique key + // that identifies a DB instance. + DBInstanceIdentifier *string - // The identifier of the CA certificate for this DB instance. - CACertificateIdentifier *string + // Specifies the current state of this database. For information about DB instance + // statuses, see DB Instance Status + // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Status.html) + // in the Amazon RDS User Guide. + DBInstanceStatus *string // The meaning of this parameter differs according to the database engine you use. // MySQL, MariaDB, SQL Server, PostgreSQL Contains the name of the initial database @@ -961,25 +935,31 @@ type DBInstance struct { // Provides the list of DB parameter groups applied to this DB instance. DBParameterGroups []*DBParameterGroupStatus - // The AWS KMS key identifier for encryption of Performance Insights data. The KMS - // key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key - // alias for the KMS encryption key. - PerformanceInsightsKMSKeyId *string + // A list of DB security group elements containing DBSecurityGroup.Name and + // DBSecurityGroup.Status subelements. + DBSecurityGroups []*DBSecurityGroupMembership - // Provides the name of the database engine to be used for this DB instance. - Engine *string + // Specifies information on the subnet group associated with the DB instance, + // including the name, description, and subnets in the subnet group. + DBSubnetGroup *DBSubnetGroup - // Specifies whether tags are copied from the DB instance to snapshots of the DB - // instance. Amazon Aurora Not applicable. Copying tags to snapshots is managed by - // the DB cluster. Setting this value for an Aurora DB instance has no effect on - // the DB cluster setting. For more information, see DBCluster. - CopyTagsToSnapshot *bool + // Specifies the port that the DB instance listens on. If the DB instance is part + // of a DB cluster, this can be a different port than the DB cluster port. + DbInstancePort *int32 - // Specifies the Provisioned IOPS (I/O operations per second) value. - Iops *int32 + // The AWS Region-unique, immutable identifier for the DB instance. This identifier + // is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB + // instance is accessed. + DbiResourceId *string - // The Amazon Resource Name (ARN) for the DB instance. - DBInstanceArn *string + // Indicates if the DB instance has deletion protection enabled. The database can't + // be deleted when deletion protection is enabled. For more information, see + // Deleting a DB Instance + // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). + DeletionProtection *bool + + // The Active Directory Domain membership records associated with the DB instance. + DomainMemberships []*DomainMembership // A list of log types that this DB instance is configured to export to CloudWatch // Logs. Log types vary by DB engine. For information about the log types for each @@ -988,22 +968,18 @@ type DBInstance struct { // the Amazon RDS User Guide. EnabledCloudwatchLogsExports []*string - // The AWS Region-unique, immutable identifier for the DB instance. This identifier - // is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB - // instance is accessed. - DbiResourceId *string + // Specifies the connection endpoint. + Endpoint *Endpoint - // If present, specifies the name of the secondary Availability Zone for a DB - // instance with multi-AZ support. - SecondaryAvailabilityZone *string + // Provides the name of the database engine to be used for this DB instance. + Engine *string - // The time zone of the DB instance. In most cases, the Timezone element is empty. - // Timezone content appears only for Microsoft SQL Server DB instances that were - // created with a time zone specified. - Timezone *string + // Indicates the database engine version. + EngineVersion *string - // Specifies whether the DB instance is encrypted. - StorageEncrypted *bool + // The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that + // receives the Enhanced Monitoring metrics data for the DB instance. + EnhancedMonitoringResourceArn *string // True if mapping of AWS Identity and Access Management (IAM) accounts to database // accounts is enabled, and otherwise false.

    IAM database authentication can be @@ -1013,34 +989,84 @@ type DBInstance struct { // authentication for Aurora, see DBCluster Type.

    IAMDatabaseAuthenticationEnabled *bool - // If the DB instance is a member of a DB cluster, contains the name of the DB - // cluster that the DB instance is a member of. - DBClusterIdentifier *string + // Provides the date and time the DB instance was created. + InstanceCreateTime *time.Time - // The ARN from the key store with which the instance is associated for TDE - // encryption. - TdeCredentialArn *string + // Specifies the Provisioned IOPS (I/O operations per second) value. + Iops *int32 - // The Active Directory Domain membership records associated with the DB instance. - DomainMemberships []*DomainMembership + // If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB + // instance. + KmsKeyId *string + + // Specifies the latest time to which a database can be restored with point-in-time + // restore. + LatestRestorableTime *time.Time + + // License model information for this DB instance. + LicenseModel *string + + // Specifies the listener connection endpoint for SQL Server Always On. + ListenerEndpoint *Endpoint + + // Contains the master username for the DB instance. + MasterUsername *string // The upper limit to which Amazon RDS can automatically scale the storage of the // DB instance. MaxAllocatedStorage *int32 + // The interval, in seconds, between points when Enhanced Monitoring metrics are + // collected for the DB instance. + MonitoringInterval *int32 + + // The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to + // Amazon CloudWatch Logs. + MonitoringRoleArn *string + + // Specifies if the DB instance is a Multi-AZ deployment. + MultiAZ *bool + + // Provides the list of option group memberships for this DB instance. + OptionGroupMemberships []*OptionGroupMembership + // Specifies that changes to the DB instance are pending. This element is only // included when changes are pending. Specific changes are identified by // subelements. PendingModifiedValues *PendingModifiedValues - // A list of DB security group elements containing DBSecurityGroup.Name and - // DBSecurityGroup.Status subelements. - DBSecurityGroups []*DBSecurityGroupMembership - // True if Performance Insights is enabled for the DB instance, and otherwise // false. PerformanceInsightsEnabled *bool + // The AWS KMS key identifier for encryption of Performance Insights data. The KMS + // key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key + // alias for the KMS encryption key. + PerformanceInsightsKMSKeyId *string + + // The amount of time, in days, to retain Performance Insights data. Valid values + // are 7 or 731 (2 years). + PerformanceInsightsRetentionPeriod *int32 + + // Specifies the daily time range during which automated backups are created if + // automated backups are enabled, as determined by the BackupRetentionPeriod. + PreferredBackupWindow *string + + // Specifies the weekly time range during which system maintenance can occur, in + // Universal Coordinated Time (UTC). + PreferredMaintenanceWindow *string + + // The number of CPU cores and the number of threads per core for the DB instance + // class of the DB instance. + ProcessorFeatures []*ProcessorFeature + + // A value that specifies the order in which an Aurora Replica is promoted to the + // primary instance after a failure of the existing primary instance. For more + // information, see Fault Tolerance for an Aurora DB Cluster + // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) + // in the Amazon Aurora User Guide. + PromotionTier *int32 + // Specifies the accessibility options for the DB instance. When the DB instance is // publicly accessible, its DNS endpoint resolves to the private IP address from // within the DB instance's VPC, and to the public IP address from outside of the @@ -1051,36 +1077,6 @@ type DBInstance struct { // to a private IP address. For more information, see CreateDBInstance (). PubliclyAccessible *bool - // Specifies the number of days for which automatic DB snapshots are retained. - BackupRetentionPeriod *int32 - - // Indicates the database engine version. - EngineVersion *string - - // If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB - // instance. - KmsKeyId *string - - // Indicates if the DB instance has deletion protection enabled. The database can't - // be deleted when deletion protection is enabled. For more information, see - // Deleting a DB Instance - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). - DeletionProtection *bool - - // The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that - // receives the Enhanced Monitoring metrics data for the DB instance. - EnhancedMonitoringResourceArn *string - - // Specifies the name of the Availability Zone the DB instance is located in. - AvailabilityZone *string - - // Provides a list of VPC security group elements that the DB instance belongs to. - VpcSecurityGroups []*VpcSecurityGroupMembership - - // The interval, in seconds, between points when Enhanced Monitoring metrics are - // collected for the DB instance. - MonitoringInterval *int32 - // Contains one or more identifiers of Aurora DB clusters to which the RDS DB // instance is replicated as a read replica. For example, when you create an Aurora // read replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the @@ -1089,35 +1085,39 @@ type DBInstance struct { // one Aurora read replica. ReadReplicaDBClusterIdentifiers []*string - // Indicates that minor version patches are applied automatically. - AutoMinorVersionUpgrade *bool - - // The AWS Identity and Access Management (IAM) roles associated with the DB + // Contains one or more identifiers of the read replicas associated with this DB // instance. - AssociatedRoles []*DBInstanceRole - - // Specifies if the DB instance is a Multi-AZ deployment. - MultiAZ *bool - - // Contains the name of the compute and memory capacity class of the DB instance. - DBInstanceClass *string + ReadReplicaDBInstanceIdentifiers []*string - // Provides the list of option group memberships for this DB instance. - OptionGroupMemberships []*OptionGroupMembership + // Contains the identifier of the source DB instance if this DB instance is a read + // replica. + ReadReplicaSourceDBInstanceIdentifier *string - // Specifies the latest time to which a database can be restored with point-in-time - // restore. - LatestRestorableTime *time.Time + // If present, specifies the name of the secondary Availability Zone for a DB + // instance with multi-AZ support. + SecondaryAvailabilityZone *string // The status of a read replica. If the instance isn't a read replica, this is // blank. StatusInfos []*DBInstanceStatusInfo - // Specifies the current state of this database. For information about DB instance - // statuses, see DB Instance Status - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Status.html) - // in the Amazon RDS User Guide. - DBInstanceStatus *string + // Specifies whether the DB instance is encrypted. + StorageEncrypted *bool + + // Specifies the storage type associated with DB instance. + StorageType *string + + // The ARN from the key store with which the instance is associated for TDE + // encryption. + TdeCredentialArn *string + + // The time zone of the DB instance. In most cases, the Timezone element is empty. + // Timezone content appears only for Microsoft SQL Server DB instances that were + // created with a time zone specified. + Timezone *string + + // Provides a list of VPC security group elements that the DB instance belongs to. + VpcSecurityGroups []*VpcSecurityGroupMembership } // An automated backup of a DB instance. It it consists of system backups, @@ -1125,44 +1125,69 @@ type DBInstance struct { // you deleted the source instance. type DBInstanceAutomatedBackup struct { + // Specifies the allocated storage size in gibibytes (GiB). + AllocatedStorage *int32 + + // The Availability Zone that the automated backup was created in. For information + // on AWS Regions and Availability Zones, see Regions and Availability Zones + // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html). + AvailabilityZone *string + // The Amazon Resource Name (ARN) for the automated backup. DBInstanceArn *string - // Earliest and latest time an instance can be restored to. - RestoreWindow *RestoreWindow + // The customer id of the instance that is/was associated with the automated + // backup. + DBInstanceIdentifier *string - // The IOPS (I/O operations per second) value for the automated backup. - Iops *int32 + // The identifier for the source DB instance, which can't be changed and which is + // unique to an AWS Region. + DbiResourceId *string + + // Specifies whether the automated backup is encrypted. + Encrypted *bool + + // The name of the database engine for this automated backup. + Engine *string // The version of the database engine for the automated backup. EngineVersion *string - // The identifier for the source DB instance, which can't be changed and which is - // unique to an AWS Region. - DbiResourceId *string + // True if mapping of AWS Identity and Access Management (IAM) accounts to database + // accounts is enabled, and otherwise false. + IAMDatabaseAuthenticationEnabled *bool - // The customer id of the instance that is/was associated with the automated - // backup. - DBInstanceIdentifier *string + // Provides the date and time that the DB instance was created. + InstanceCreateTime *time.Time - // Specifies the storage type associated with the automated backup. - StorageType *string + // The IOPS (I/O operations per second) value for the automated backup. + Iops *int32 + + // The AWS KMS key ID for an automated backup. The KMS key ID is the Amazon + // Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS + // encryption key. + KmsKeyId *string // License model information for the automated backup. LicenseModel *string - // The time zone of the automated backup. In most cases, the Timezone element is - // empty. Timezone content appears only for Microsoft SQL Server DB instances that - // were created with a time zone specified. - Timezone *string - - // True if mapping of AWS Identity and Access Management (IAM) accounts to database - // accounts is enabled, and otherwise false. - IAMDatabaseAuthenticationEnabled *bool - // The license model of an automated backup. MasterUsername *string + // The option group the automated backup is associated with. If omitted, the + // default option group for the engine specified is used. + OptionGroupName *string + + // The port number that the automated backup used for connections. Default: + // Inherits from the source DB instance Valid Values: 1150-65535 + Port *int32 + + // The AWS Region associated with the automated backup. + Region *string + + // Earliest and latest time an instance can be restored to. + RestoreWindow *RestoreWindow + // Provides a list of status information for an automated backup: // // * active - @@ -1175,45 +1200,20 @@ type DBInstanceAutomatedBackup struct { // first automated snapshot to be available. Status *string - // The port number that the automated backup used for connections. Default: - // Inherits from the source DB instance Valid Values: 1150-65535 - Port *int32 - - // The Availability Zone that the automated backup was created in. For information - // on AWS Regions and Availability Zones, see Regions and Availability Zones - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html). - AvailabilityZone *string - - // The AWS KMS key ID for an automated backup. The KMS key ID is the Amazon - // Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS - // encryption key. - KmsKeyId *string - - // Specifies whether the automated backup is encrypted. - Encrypted *bool + // Specifies the storage type associated with the automated backup. + StorageType *string - // The AWS Region associated with the automated backup. - Region *string + // The ARN from the key store with which the automated backup is associated for TDE + // encryption. + TdeCredentialArn *string - // Provides the date and time that the DB instance was created. - InstanceCreateTime *time.Time + // The time zone of the automated backup. In most cases, the Timezone element is + // empty. Timezone content appears only for Microsoft SQL Server DB instances that + // were created with a time zone specified. + Timezone *string // Provides the VPC ID associated with the DB instance VpcId *string - - // The option group the automated backup is associated with. If omitted, the - // default option group for the engine specified is used. - OptionGroupName *string - - // Specifies the allocated storage size in gibibytes (GiB). - AllocatedStorage *int32 - - // The name of the database engine for this automated backup. - Engine *string - - // The ARN from the key store with which the automated backup is associated for TDE - // encryption. - TdeCredentialArn *string } // Describes an AWS Identity and Access Management (IAM) role that is associated @@ -1247,39 +1247,39 @@ type DBInstanceRole struct { // Provides a list of status information for a DB instance. type DBInstanceStatusInfo struct { - // This value is currently "read replication." - StatusType *string - // Details of the error if there is an error for the instance. If the instance // isn't in an error state, this value is blank. Message *string + // Boolean value that is true if the instance is operating normally, or false if + // the instance is in an error state. + Normal *bool + // Status of the DB instance. For a StatusType of read replica, the values can be // replicating, replication stop point set, replication stop point reached, error, // stopped, or terminated. Status *string - // Boolean value that is true if the instance is operating normally, or false if - // the instance is in an error state. - Normal *bool + // This value is currently "read replication." + StatusType *string } // Contains the details of an Amazon RDS DB parameter group. This data type is used // as a response element in the DescribeDBParameterGroups action. type DBParameterGroup struct { - // Provides the name of the DB parameter group. - DBParameterGroupName *string - - // Provides the customer-specified description for this DB parameter group. - Description *string + // The Amazon Resource Name (ARN) for the DB parameter group. + DBParameterGroupArn *string // Provides the name of the DB parameter group family that this DB parameter group // is compatible with. DBParameterGroupFamily *string - // The Amazon Resource Name (ARN) for the DB parameter group. - DBParameterGroupArn *string + // Provides the name of the DB parameter group. + DBParameterGroupName *string + + // Provides the customer-specified description for this DB parameter group. + Description *string } // The status of the DB parameter group. This data type is used as a response @@ -1300,11 +1300,11 @@ type DBParameterGroup struct { // * RestoreDBInstanceFromDBSnapshot type DBParameterGroupStatus struct { - // The status of parameter updates. - ParameterApplyStatus *string - // The name of the DB parameter group. DBParameterGroupName *string + + // The status of parameter updates. + ParameterApplyStatus *string } // The data structure representing a proxy managed by the RDS Proxy. This data type @@ -1321,14 +1321,9 @@ type DBProxy struct { // The Amazon Resource Name (ARN) for the proxy. DBProxyArn *string - // Provides a list of VPC security groups that the proxy belongs to. - VpcSecurityGroupIds []*string - - // The number of seconds a connection to the proxy can have no activity before the - // proxy drops the client connection. The proxy keeps the underlying database - // connection open and puts it back into the connection pool for reuse by later - // connection requests. Default: 1800 (30 minutes) Constraints: 1 to 28,800 - IdleClientTimeout *int32 + // The identifier for the proxy. This name must be unique for all proxies owned by + // your AWS account in the specified AWS Region. + DBProxyName *string // Whether the proxy includes detailed information about SQL statements in its // logs. This information helps you to debug issues involving SQL behavior or the @@ -1339,35 +1334,40 @@ type DBProxy struct { // in the logs. DebugLogging *bool - // The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access - // Amazon Secrets Manager. - RoleArn *string + // The endpoint that you can use to connect to the proxy. You include the endpoint + // value in the connection string for a database client application. + Endpoint *string - // The EC2 subnet IDs for the proxy. - VpcSubnetIds []*string + // The engine family applies to MySQL and PostgreSQL for both RDS and Aurora. + EngineFamily *string - // The identifier for the proxy. This name must be unique for all proxies owned by - // your AWS account in the specified AWS Region. - DBProxyName *string + // The number of seconds a connection to the proxy can have no activity before the + // proxy drops the client connection. The proxy keeps the underlying database + // connection open and puts it back into the connection pool for reuse by later + // connection requests. Default: 1800 (30 minutes) Constraints: 1 to 28,800 + IdleClientTimeout *int32 - // The date and time when the proxy was last updated. - UpdatedDate *time.Time + // Indicates whether Transport Layer Security (TLS) encryption is required for + // connections to the proxy. + RequireTLS *bool - // The endpoint that you can use to connect to the proxy. You include the endpoint - // value in the connection string for a database client application. - Endpoint *string + // The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access + // Amazon Secrets Manager. + RoleArn *string // The current status of this proxy. A status of available means the proxy is ready // to handle requests. Other values indicate that you must wait for the proxy to be // ready, or take some action to resolve an issue. Status DBProxyStatus - // Indicates whether Transport Layer Security (TLS) encryption is required for - // connections to the proxy. - RequireTLS *bool + // The date and time when the proxy was last updated. + UpdatedDate *time.Time - // The engine family applies to MySQL and PostgreSQL for both RDS and Aurora. - EngineFamily *string + // Provides a list of VPC security groups that the proxy belongs to. + VpcSecurityGroupIds []*string + + // The EC2 subnet IDs for the proxy. + VpcSubnetIds []*string } // Contains the details for an RDS Proxy target. It represents an RDS DB instance @@ -1379,27 +1379,27 @@ type DBProxyTarget struct { // The writer endpoint for the RDS DB instance or Aurora DB cluster. Endpoint *string - // Specifies the kind of database, such as an RDS DB instance or an Aurora DB - // cluster, that the target represents. - Type TargetType + // The port that the RDS Proxy uses to connect to the target RDS DB instance or + // Aurora DB cluster. + Port *int32 // The identifier representing the target. It can be the instance identifier for an // RDS DB instance, or the cluster identifier for an Aurora DB cluster. RdsResourceId *string - // The DB cluster identifier when the target represents an Aurora DB cluster. This - // field is blank when the target represents an RDS DB instance. - TrackedClusterId *string - - // The port that the RDS Proxy uses to connect to the target RDS DB instance or - // Aurora DB cluster. - Port *int32 + // The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster. + TargetArn *string // Information about the connection health of the RDS Proxy target. TargetHealth *TargetHealth - // The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster. - TargetArn *string + // The DB cluster identifier when the target represents an Aurora DB cluster. This + // field is blank when the target represents an RDS DB instance. + TrackedClusterId *string + + // Specifies the kind of database, such as an RDS DB instance or an Aurora DB + // cluster, that the target represents. + Type TargetType } // Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy @@ -1408,36 +1408,36 @@ type DBProxyTarget struct { // in the DescribeDBProxyTargetGroups action. type DBProxyTargetGroup struct { - // The date and time when the target group was last updated. - UpdatedDate *time.Time - - // The identifier for the RDS proxy associated with this target group. - DBProxyName *string - // The settings that determine the size and behavior of the connection pool for the // target group. ConnectionPoolConfig *ConnectionPoolConfigurationInfo - // The identifier for the target group. This name must be unique for all target - // groups owned by your AWS account in the specified AWS Region. - TargetGroupName *string + // The date and time when the target group was first created. + CreatedDate *time.Time - // The Amazon Resource Name (ARN) representing the target group. - TargetGroupArn *string + // The identifier for the RDS proxy associated with this target group. + DBProxyName *string // Whether this target group is the first one used for connection requests by the // associated proxy. Because each proxy is currently associated with a single // target group, currently this setting is always true. IsDefault *bool - // The date and time when the target group was first created. - CreatedDate *time.Time - // The current status of this target group. A status of available means the target // group is correctly associated with a database. Other values indicate that you // must wait for the target group to be ready, or take some action to resolve an // issue. Status *string + + // The Amazon Resource Name (ARN) representing the target group. + TargetGroupArn *string + + // The identifier for the target group. This name must be unique for all target + // groups owned by your AWS account in the specified AWS Region. + TargetGroupName *string + + // The date and time when the target group was last updated. + UpdatedDate *time.Time } // Contains the details for an Amazon RDS DB security group. This data type is used @@ -1447,23 +1447,23 @@ type DBSecurityGroup struct { // The Amazon Resource Name (ARN) for the DB security group. DBSecurityGroupArn *string - // Contains a list of IPRange elements. - IPRanges []*IPRange + // Provides the description of the DB security group. + DBSecurityGroupDescription *string + + // Specifies the name of the DB security group. + DBSecurityGroupName *string // Contains a list of EC2SecurityGroup elements. EC2SecurityGroups []*EC2SecurityGroup - // Provides the description of the DB security group. - DBSecurityGroupDescription *string - - // Provides the VpcId of the DB security group. - VpcId *string + // Contains a list of IPRange elements. + IPRanges []*IPRange // Provides the AWS ID of the owner of a specific DB security group. OwnerId *string - // Specifies the name of the DB security group. - DBSecurityGroupName *string + // Provides the VpcId of the DB security group. + VpcId *string } // This data type is used as a response element in the following actions: @@ -1490,101 +1490,101 @@ type DBSecurityGroupMembership struct { // response element in the DescribeDBSnapshots action. type DBSnapshot struct { - // The number of CPU cores and the number of threads per core for the DB instance - // class of the DB instance when the DB snapshot was created. - ProcessorFeatures []*ProcessorFeature + // Specifies the allocated storage size in gibibytes (GiB). + AllocatedStorage *int32 + + // Specifies the name of the Availability Zone the DB instance was located in at + // the time of the DB snapshot. + AvailabilityZone *string + + // Specifies the DB instance identifier of the DB instance this DB snapshot was + // created from. + DBInstanceIdentifier *string + + // The Amazon Resource Name (ARN) for the DB snapshot. + DBSnapshotArn *string + + // Specifies the identifier for the DB snapshot. + DBSnapshotIdentifier *string + + // The identifier for the source DB instance, which can't be changed and which is + // unique to an AWS Region. + DbiResourceId *string // Specifies whether the DB snapshot is encrypted. Encrypted *bool + // Specifies the name of the database engine. + Engine *string + + // Specifies the version of the database engine. + EngineVersion *string + + // True if mapping of AWS Identity and Access Management (IAM) accounts to database + // accounts is enabled, and otherwise false. + IAMDatabaseAuthenticationEnabled *bool + // Specifies the time in Coordinated Universal Time (UTC) when the DB instance, // from which the snapshot was taken, was created. InstanceCreateTime *time.Time - // The time zone of the DB snapshot. In most cases, the Timezone element is empty. - // Timezone content appears only for snapshots taken from Microsoft SQL Server DB - // instances that were created with a time zone specified. - Timezone *string - - // The identifier for the source DB instance, which can't be changed and which is - // unique to an AWS Region. - DbiResourceId *string + // Specifies the Provisioned IOPS (I/O operations per second) value of the DB + // instance at the time of the snapshot. + Iops *int32 - // True if mapping of AWS Identity and Access Management (IAM) accounts to database - // accounts is enabled, and otherwise false. - IAMDatabaseAuthenticationEnabled *bool + // If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot. + KmsKeyId *string - // Specifies the identifier for the DB snapshot. - DBSnapshotIdentifier *string + // License model information for the restored DB instance. + LicenseModel *string - // Provides the VPC ID associated with the DB snapshot. - VpcId *string + // Provides the master username for the DB snapshot. + MasterUsername *string - // Provides the type of the DB snapshot. - SnapshotType *string + // Provides the option group name for the DB snapshot. + OptionGroupName *string // The percentage of the estimated data that has been transferred. PercentProgress *int32 - // Specifies the name of the Availability Zone the DB instance was located in at - // the time of the DB snapshot. - AvailabilityZone *string - // Specifies the port that the database engine was listening on at the time of the // snapshot. Port *int32 - // If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot. - KmsKeyId *string + // The number of CPU cores and the number of threads per core for the DB instance + // class of the DB instance when the DB snapshot was created. + ProcessorFeatures []*ProcessorFeature - // Provides the master username for the DB snapshot. - MasterUsername *string + // Specifies when the snapshot was taken in Coodinated Universal Time (UTC). + SnapshotCreateTime *time.Time - // Specifies the status of this DB snapshot. - Status *string + // Provides the type of the DB snapshot. + SnapshotType *string // The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. // It only has value in case of cross-customer or cross-region copy. SourceDBSnapshotIdentifier *string - // Specifies the name of the database engine. - Engine *string - - // The Amazon Resource Name (ARN) for the DB snapshot. - DBSnapshotArn *string - - // Specifies the Provisioned IOPS (I/O operations per second) value of the DB - // instance at the time of the snapshot. - Iops *int32 - - // Specifies the version of the database engine. - EngineVersion *string - - // Specifies when the snapshot was taken in Coodinated Universal Time (UTC). - SnapshotCreateTime *time.Time - - // License model information for the restored DB instance. - LicenseModel *string - // The AWS Region that the DB snapshot was created in or copied from. SourceRegion *string + // Specifies the status of this DB snapshot. + Status *string + // Specifies the storage type associated with DB snapshot. StorageType *string - // Specifies the allocated storage size in gibibytes (GiB). - AllocatedStorage *int32 - - // Specifies the DB instance identifier of the DB instance this DB snapshot was - // created from. - DBInstanceIdentifier *string - - // Provides the option group name for the DB snapshot. - OptionGroupName *string - // The ARN from the key store with which to associate the instance for TDE // encryption. TdeCredentialArn *string + + // The time zone of the DB snapshot. In most cases, the Timezone element is empty. + // Timezone content appears only for snapshots taken from Microsoft SQL Server DB + // instances that were created with a time zone specified. + Timezone *string + + // Provides the VPC ID associated with the DB snapshot. + VpcId *string } // Contains the name and values of a manual DB snapshot attribute Manual DB @@ -1623,21 +1623,21 @@ type DBSnapshotAttributesResult struct { // a response element in the DescribeDBSubnetGroups action. type DBSubnetGroup struct { - // The name of the DB subnet group. - DBSubnetGroupName *string - // The Amazon Resource Name (ARN) for the DB subnet group. DBSubnetGroupArn *string + // Provides the description of the DB subnet group. + DBSubnetGroupDescription *string + + // The name of the DB subnet group. + DBSubnetGroupName *string + // Provides the status of the DB subnet group. SubnetGroupStatus *string // Contains a list of Subnet elements. Subnets []*Subnet - // Provides the description of the DB subnet group. - DBSubnetGroupDescription *string - // Provides the VpcId of the DB subnet group. VpcId *string } @@ -1645,12 +1645,12 @@ type DBSubnetGroup struct { // This data type is used as a response element to DescribeDBLogFiles. type DescribeDBLogFilesDetails struct { - // The name of the log file for the specified DB instance. - LogFileName *string - // A POSIX timestamp when the last log entry was written. LastWritten *int64 + // The name of the log file for the specified DB instance. + LogFileName *string + // The size, in bytes, of the log file for the specified DB instance. Size *int64 } @@ -1659,16 +1659,16 @@ type DescribeDBLogFilesDetails struct { // cluster. type DomainMembership struct { - // The name of the IAM role to be used when making API calls to the Directory - // Service. - IAMRoleName *string - // The identifier of the Active Directory Domain. Domain *string // The fully qualified domain name of the Active Directory Domain. FQDN *string + // The name of the IAM role to be used when making API calls to the Directory + // Service. + IAMRoleName *string + // The status of the Active Directory Domain membership for the DB instance or // cluster. Values include joined, pending-join, failed, and so on. Status *string @@ -1677,11 +1677,11 @@ type DomainMembership struct { // A range of double values. type DoubleRange struct { - // The maximum value in the range. - To *float64 - // The minimum value in the range. From *float64 + + // The maximum value in the range. + To *float64 } // This data type is used as a response element in the following actions: @@ -1695,19 +1695,19 @@ type DoubleRange struct { // RevokeDBSecurityGroupIngress type EC2SecurityGroup struct { - // Provides the status of the EC2 security group. Status can be "authorizing", - // "authorized", "revoking", and "revoked". - Status *string - - // Specifies the AWS ID of the owner of the EC2 security group specified in the - // EC2SecurityGroupName field. - EC2SecurityGroupOwnerId *string - // Specifies the id of the EC2 security group. EC2SecurityGroupId *string // Specifies the name of the EC2 security group. EC2SecurityGroupName *string + + // Specifies the AWS ID of the owner of the EC2 security group specified in the + // EC2SecurityGroupName field. + EC2SecurityGroupOwnerId *string + + // Provides the status of the EC2 security group. Status can be "authorizing", + // "authorized", "revoking", and "revoked". + Status *string } // This data type represents the information you need to connect to an Amazon RDS @@ -1725,12 +1725,12 @@ type EC2SecurityGroup struct { // cluster endpoints, see DBClusterEndpoint. type Endpoint struct { - // Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. - HostedZoneId *string - // Specifies the DNS address of the DB instance. Address *string + // Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. + HostedZoneId *string + // Specifies the port that the database engine is listening on. Port *int32 } @@ -1739,9 +1739,6 @@ type Endpoint struct { // DescribeEngineDefaultParameters action. type EngineDefaults struct { - // Contains a list of engine default parameters. - Parameters []*Parameter - // Specifies the name of the DB parameter group family that the engine default // parameters apply to. DBParameterGroupFamily *string @@ -1750,6 +1747,9 @@ type EngineDefaults struct { // this parameter is specified, the response includes only records beyond the // marker, up to the value specified by MaxRecords . Marker *string + + // Contains a list of engine default parameters. + Parameters []*Parameter } // This data type is used as a response element in the DescribeEvents action. @@ -1761,28 +1761,28 @@ type Event struct { // Specifies the category for the event. EventCategories []*string - // Provides the identifier for the source of the event. - SourceIdentifier *string - // Provides the text of this event. Message *string - // Specifies the source type for this event. - SourceType SourceType - // The Amazon Resource Name (ARN) for the event. SourceArn *string + + // Provides the identifier for the source of the event. + SourceIdentifier *string + + // Specifies the source type for this event. + SourceType SourceType } // Contains the results of a successful invocation of the DescribeEventCategories // action. type EventCategoriesMap struct { - // The source type that the returned categories belong to - SourceType *string - // The event categories for the specified source type EventCategories []*string + + // The source type that the returned categories belong to + SourceType *string } // Contains the results of a successful invocation of the @@ -1792,11 +1792,13 @@ type EventSubscription struct { // The RDS event notification subscription Id. CustSubscriptionId *string - // A list of source IDs for the RDS event notification subscription. - SourceIdsList []*string + // The AWS customer account associated with the RDS event notification + // subscription. + CustomerAwsId *string - // The source type for the RDS event notification subscription. - SourceType *string + // A Boolean value indicating if the subscription is enabled. True indicates the + // subscription is enabled. + Enabled *bool // A list of event categories for the RDS event notification subscription. EventCategoriesList []*string @@ -1807,6 +1809,12 @@ type EventSubscription struct { // The topic ARN of the RDS event notification subscription. SnsTopicArn *string + // A list of source IDs for the RDS event notification subscription. + SourceIdsList []*string + + // The source type for the RDS event notification subscription. + SourceType *string + // The status of the RDS event notification subscription. Constraints: Can be one // of the following: creating | modifying | deleting | active | no-permission | // topic-not-exist The status "no-permission" indicates that RDS no longer has @@ -1816,38 +1824,29 @@ type EventSubscription struct { // The time the RDS event notification subscription was created. SubscriptionCreationTime *string - - // The AWS customer account associated with the RDS event notification - // subscription. - CustomerAwsId *string - - // A Boolean value indicating if the subscription is enabled. True indicates the - // subscription is enabled. - Enabled *bool } // Contains the details of a snapshot export to Amazon S3. This data type is used // as a response element in the DescribeExportTasks action. type ExportTask struct { - // The name of the IAM role that is used to write to Amazon S3 when exporting a - // snapshot. - IamRoleArn *string - - // The total amount of data exported, in gigabytes. - TotalExtractedDataInGB *int32 - - // The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3. - SourceArn *string - - // The Amazon S3 bucket that the snapshot is exported to. - S3Bucket *string - - // The time that the snapshot was created. - SnapshotTime *time.Time - - // The progress status of the export task. - Status *string + // The data exported from the snapshot. Valid values are the following: + // + // * + // database - Export all the data from a specified database. + // + // * database.table + // table-name - Export a table of the snapshot. This format is valid only for RDS + // for MySQL, RDS for MariaDB, and Aurora MySQL. + // + // * database.schema schema-name + // - Export a database schema of the snapshot. This format is valid only for RDS + // for PostgreSQL and Aurora PostgreSQL. + // + // * database.schema.table table-name - + // Export a table of the database schema. This format is valid only for RDS for + // PostgreSQL and Aurora PostgreSQL. + ExportOnly []*string // A unique identifier for the snapshot export task. This ID isn't an identifier // for the Amazon S3 bucket where the snapshot is exported to. @@ -1856,12 +1855,9 @@ type ExportTask struct { // The reason the export failed, if it failed. FailureCause *string - // The progress of the snapshot export task as a percentage. - PercentProgress *int32 - - // The Amazon S3 bucket prefix that is the file name and path of the exported + // The name of the IAM role that is used to write to Amazon S3 when exporting a // snapshot. - S3Prefix *string + IamRoleArn *string // The ID of the AWS KMS key that is used to encrypt the snapshot when it's // exported to Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS @@ -1870,32 +1866,36 @@ type ExportTask struct { // use this KMS key. KmsKeyId *string - // The time that the snapshot export task completed. - TaskEndTime *time.Time + // The progress of the snapshot export task as a percentage. + PercentProgress *int32 - // The data exported from the snapshot. Valid values are the following: - // - // * - // database - Export all the data from a specified database. - // - // * database.table - // table-name - Export a table of the snapshot. This format is valid only for RDS - // for MySQL, RDS for MariaDB, and Aurora MySQL. - // - // * database.schema schema-name - // - Export a database schema of the snapshot. This format is valid only for RDS - // for PostgreSQL and Aurora PostgreSQL. - // - // * database.schema.table table-name - - // Export a table of the database schema. This format is valid only for RDS for - // PostgreSQL and Aurora PostgreSQL. - ExportOnly []*string + // The Amazon S3 bucket that the snapshot is exported to. + S3Bucket *string + + // The Amazon S3 bucket prefix that is the file name and path of the exported + // snapshot. + S3Prefix *string - // A warning about the snapshot export task. - WarningMessage *string + // The time that the snapshot was created. + SnapshotTime *time.Time + + // The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3. + SourceArn *string + + // The progress status of the export task. + Status *string + + // The time that the snapshot export task completed. + TaskEndTime *time.Time // The time that the snapshot export task started. TaskStartTime *time.Time + + // The total amount of data exported, in gigabytes. + TotalExtractedDataInGB *int32 + + // A warning about the snapshot export task. + WarningMessage *string } // A filter name and value pair that is used to return a more specific list of @@ -1932,45 +1932,48 @@ type Filter struct { // A data type representing an Aurora global database. type GlobalCluster struct { + // The default database name within the new global database cluster. + DatabaseName *string + + // The deletion protection setting for the new global database cluster. + DeletionProtection *bool + // The Aurora database engine used by the global database cluster. Engine *string - // The AWS Region-unique, immutable identifier for the global database cluster. - // This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key - // for the DB cluster is accessed. - GlobalClusterResourceId *string - // Indicates the database engine version. EngineVersion *string - // Contains a user-supplied global database cluster identifier. This identifier is - // the unique key that identifies a global database cluster. - GlobalClusterIdentifier *string - // The Amazon Resource Name (ARN) for the global database cluster. GlobalClusterArn *string - // The storage encryption setting for the global database cluster. - StorageEncrypted *bool + // Contains a user-supplied global database cluster identifier. This identifier is + // the unique key that identifies a global database cluster. + GlobalClusterIdentifier *string // The list of cluster IDs for secondary clusters within the global database // cluster. Currently limited to 1 item. GlobalClusterMembers []*GlobalClusterMember - // The deletion protection setting for the new global database cluster. - DeletionProtection *bool - - // The default database name within the new global database cluster. - DatabaseName *string + // The AWS Region-unique, immutable identifier for the global database cluster. + // This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key + // for the DB cluster is accessed. + GlobalClusterResourceId *string // Specifies the current state of this global database cluster. Status *string + + // The storage encryption setting for the global database cluster. + StorageEncrypted *bool } // A data structure with information about any primary and secondary clusters // associated with an Aurora global database. type GlobalClusterMember struct { + // The Amazon Resource Name (ARN) for each Aurora cluster. + DBClusterArn *string + // Specifies whether a secondary cluster in an Aurora global database has write // forwarding enabled, not enabled, or is in the process of enabling it. GlobalWriteForwardingStatus WriteForwardingStatus @@ -1983,39 +1986,36 @@ type GlobalClusterMember struct { // The Amazon Resource Name (ARN) for each read-only secondary cluster associated // with the Aurora global database. Readers []*string - - // The Amazon Resource Name (ARN) for each Aurora cluster. - DBClusterArn *string } // Contains the installation media for a DB engine that requires an on-premises // customer provided license, such as Microsoft SQL Server. type InstallationMedia struct { - // The status of the installation medium. - Status *string - - // The engine version of the DB engine. - EngineVersion *string - // The custom Availability Zone (AZ) that contains the installation media. CustomAvailabilityZoneId *string - // The path to the installation medium for the operating system associated with the - // DB engine. - OSInstallationMediaPath *string - // The DB engine. Engine *string + // The path to the installation medium for the DB engine. + EngineInstallationMediaPath *string + + // The engine version of the DB engine. + EngineVersion *string + // If an installation media failure occurred, the cause of the failure. FailureCause *InstallationMediaFailureCause // The installation medium ID. InstallationMediaId *string - // The path to the installation medium for the DB engine. - EngineInstallationMediaPath *string + // The path to the installation medium for the operating system associated with the + // DB engine. + OSInstallationMediaPath *string + + // The status of the installation medium. + Status *string } // Contains the cause of an installation media failure. Installation media is used @@ -2053,21 +2053,21 @@ type MinimumEngineVersionPerAllowedValue struct { // Option details. type Option struct { - // The version of the option. - OptionVersion *string + // If the option requires access to a port, then this DB security group allows + // access to the port. + DBSecurityGroupMemberships []*DBSecurityGroupMembership // The description of the option. OptionDescription *string + // The name of the option. + OptionName *string + // The option settings for this option. OptionSettings []*OptionSetting - // If required, the port configured for this option to use. - Port *int32 - - // If the option requires access to a port, then this VPC security group allows - // access to the port. - VpcSecurityGroupMemberships []*VpcSecurityGroupMembership + // The version of the option. + OptionVersion *string // Indicate if this option is permanent. Permanent *bool @@ -2075,49 +2075,45 @@ type Option struct { // Indicate if this option is persistent. Persistent *bool - // The name of the option. - OptionName *string + // If required, the port configured for this option to use. + Port *int32 - // If the option requires access to a port, then this DB security group allows + // If the option requires access to a port, then this VPC security group allows // access to the port. - DBSecurityGroupMemberships []*DBSecurityGroupMembership + VpcSecurityGroupMemberships []*VpcSecurityGroupMembership } // A list of all available options type OptionConfiguration struct { - // A list of VpcSecurityGroupMembership name strings used for this option. - VpcSecurityGroupMemberships []*string - // The configuration of options to include in a group. // // This member is required. OptionName *string - // The optional port for the option. - Port *int32 + // A list of DBSecurityGroupMembership name strings used for this option. + DBSecurityGroupMemberships []*string // The option settings to include in an option group. OptionSettings []*OptionSetting - // A list of DBSecurityGroupMembership name strings used for this option. - DBSecurityGroupMemberships []*string - // The version for the option. OptionVersion *string + + // The optional port for the option. + Port *int32 + + // A list of VpcSecurityGroupMembership name strings used for this option. + VpcSecurityGroupMemberships []*string } // type OptionGroup struct { - // Provides a description of the option group. - OptionGroupDescription *string - - // Indicates what options are available in the option group. - Options []*Option - - // The Amazon Resource Name (ARN) for the option group. - OptionGroupArn *string + // Indicates whether this option group can be applied to both VPC and non-VPC + // instances. The value true indicates the option group can be applied to both VPC + // and non-VPC instances. + AllowsVpcAndNonVpcInstanceMemberships *bool // Indicates the name of the engine that this option group can be applied to. EngineName *string @@ -2125,90 +2121,94 @@ type OptionGroup struct { // Indicates the major engine version associated with this option group. MajorEngineVersion *string + // The Amazon Resource Name (ARN) for the option group. + OptionGroupArn *string + + // Provides a description of the option group. + OptionGroupDescription *string + // Specifies the name of the option group. OptionGroupName *string + // Indicates what options are available in the option group. + Options []*Option + // If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If // AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this // option group can be applied to both VPC and non-VPC instances. If this field // contains a value, then this option group can only be applied to instances that // are in the VPC indicated by this field. VpcId *string - - // Indicates whether this option group can be applied to both VPC and non-VPC - // instances. The value true indicates the option group can be applied to both VPC - // and non-VPC instances. - AllowsVpcAndNonVpcInstanceMemberships *bool } // Provides information on the option groups the DB instance is a member of. type OptionGroupMembership struct { + // The name of the option group that the instance belongs to. + OptionGroupName *string + // The status of the DB instance's option group membership. Valid values are: // in-sync, pending-apply, pending-removal, pending-maintenance-apply, // pending-maintenance-removal, applying, removing, and failed. Status *string - - // The name of the option group that the instance belongs to. - OptionGroupName *string } // Available option. type OptionGroupOption struct { + // If the option requires a port, specifies the default port for the option. + DefaultPort *int32 + + // The description of the option. + Description *string + // The name of the engine that this option can be applied to. EngineName *string + // Indicates the major engine version that the option is available for. + MajorEngineVersion *string + + // The minimum required engine version for the option to be applied. + MinimumRequiredMinorEngineVersion *string + + // The name of the option. + Name *string + // The option settings that are available (and the default value) for each option // in an option group. OptionGroupOptionSettings []*OptionGroupOptionSetting - // If the option requires a port, specifies the default port for the option. - DefaultPort *int32 + // The versions that are available for the option. + OptionGroupOptionVersions []*OptionVersion + + // The options that conflict with this option. + OptionsConflictsWith []*string + + // The options that are prerequisites for this option. + OptionsDependedOn []*string // Permanent options can never be removed from an option group. An option group // containing a permanent option can't be removed from a DB instance. Permanent *bool + // Persistent options can't be removed from an option group while DB instances are + // associated with the option group. If you disassociate all DB instances from the + // option group, your can remove the persistent option from the option group. + Persistent *bool + + // Specifies whether the option requires a port. + PortRequired *bool + // If true, you must enable the Auto Minor Version Upgrade setting for your DB // instance before you can use this option. You can enable Auto Minor Version // Upgrade when you first create your DB instance, or by modifying your DB instance // later. RequiresAutoMinorEngineVersionUpgrade *bool - // The options that are prerequisites for this option. - OptionsDependedOn []*string - - // Specifies whether the option requires a port. - PortRequired *bool - // If true, you can change the option to an earlier version of the option. This // only applies to options that have different versions available. SupportsOptionVersionDowngrade *bool - // The name of the option. - Name *string - - // Persistent options can't be removed from an option group while DB instances are - // associated with the option group. If you disassociate all DB instances from the - // option group, your can remove the persistent option from the option group. - Persistent *bool - - // Indicates the major engine version that the option is available for. - MajorEngineVersion *string - - // The description of the option. - Description *string - - // The options that conflict with this option. - OptionsConflictsWith []*string - - // The minimum required engine version for the option to be applied. - MinimumRequiredMinorEngineVersion *string - - // The versions that are available for the option. - OptionGroupOptionVersions []*OptionVersion - // If true, you can only use this option with a DB instance that is in a VPC. VpcOnly *bool } @@ -2218,32 +2218,32 @@ type OptionGroupOption struct { // with the DescribeOptionGroupOptions action. type OptionGroupOptionSetting struct { + // Indicates the acceptable values for the option group option. + AllowedValues *string + + // The DB engine specific parameter type for the option group option. + ApplyType *string + + // The default value for the option group option. + DefaultValue *string + // Boolean value where true indicates that this option group option can be changed // from the default value. IsModifiable *bool + // Boolean value where true indicates that a value must be specified for this + // option setting of the option group option. + IsRequired *bool + // The minimum DB engine version required for the corresponding allowed value for // this option setting. MinimumEngineVersionPerAllowedValue []*MinimumEngineVersionPerAllowedValue - // The name of the option group option. - SettingName *string - // The description of the option group option. SettingDescription *string - // The default value for the option group option. - DefaultValue *string - - // The DB engine specific parameter type for the option group option. - ApplyType *string - - // Boolean value where true indicates that a value must be specified for this - // option setting of the option group option. - IsRequired *bool - - // Indicates the acceptable values for the option group option. - AllowedValues *string + // The name of the option group option. + SettingName *string } // Option settings are the actual settings being applied or configured for that @@ -2252,20 +2252,23 @@ type OptionGroupOptionSetting struct { // SQLNET.ENCRYPTION_SERVER that can have several different values. type OptionSetting struct { - // Indicates if the option setting is part of a collection. - IsCollection *bool + // The allowed values of the option setting. + AllowedValues *string + + // The DB engine specific parameter type. + ApplyType *string + + // The data type of the option setting. + DataType *string // The default value of the option setting. DefaultValue *string - // The DB engine specific parameter type. - ApplyType *string - // The description of the option setting. Description *string - // The data type of the option setting. - DataType *string + // Indicates if the option setting is part of a collection. + IsCollection *bool // A Boolean value that, when true, indicates the option setting can be modified // from the default. @@ -2276,59 +2279,65 @@ type OptionSetting struct { // The current value of the option setting. Value *string - - // The allowed values of the option setting. - AllowedValues *string } // The version for an option. Option group option versions are returned by the // DescribeOptionGroupOptions action. type OptionVersion struct { - // The version of the option. - Version *string - // True if the version is the default version of the option, and otherwise false. IsDefault *bool + + // The version of the option. + Version *string } // Contains a list of available options for a DB instance. This data type is used // as a response element in the DescribeOrderableDBInstanceOptions action. type OrderableDBInstanceOption struct { - // Indicates whether a DB instance is in a VPC. - Vpc *bool + // The Availability Zone group for a DB instance. + AvailabilityZoneGroup *string - // Indicates whether a DB instance is Multi-AZ capable. - MultiAZCapable *bool + // A list of Availability Zones for a DB instance. + AvailabilityZones []*AvailabilityZone - // Maximum storage size for a DB instance. - MaxStorageSize *int32 + // A list of the available processor features for the DB instance class of a DB + // instance. + AvailableProcessorFeatures []*AvailableProcessorFeature - // A list of the supported DB engine modes. global engine mode only applies for - // global database clusters created with Aurora MySQL version 5.6.10a. For higher - // Aurora MySQL versions, the clusters in a global database use provisioned engine - // mode. - SupportedEngineModes []*string + // The DB instance class for a DB instance. + DBInstanceClass *string + + // The engine type of a DB instance. + Engine *string + + // The engine version of a DB instance. + EngineVersion *string + + // The license model for a DB instance. + LicenseModel *string + + // Maximum total provisioned IOPS for a DB instance. + MaxIopsPerDbInstance *int32 // Maximum provisioned IOPS per GiB for a DB instance. MaxIopsPerGib *float64 - // Indicates whether a DB instance can have a read replica. - ReadReplicaCapable *bool + // Maximum storage size for a DB instance. + MaxStorageSize *int32 - // Indicates whether a DB instance supports IAM database authentication. - SupportsIAMDatabaseAuthentication *bool + // Minimum total provisioned IOPS for a DB instance. + MinIopsPerDbInstance *int32 - // Whether a DB instance supports Kerberos Authentication. - SupportsKerberosAuthentication *bool + // Minimum provisioned IOPS per GiB for a DB instance. + MinIopsPerGib *float64 - // Whether Amazon RDS can automatically scale storage for DB instances that use the - // specified DB instance class. - SupportsStorageAutoscaling *bool + // Minimum storage size for a DB instance. + MinStorageSize *int32 - // Indicates whether a DB instance supports encrypted storage. - SupportsStorageEncryption *bool + // Indicates whether a DB instance is Multi-AZ capable. + MultiAZCapable *bool // Whether a DB instance supports RDS on Outposts. For more information about RDS // on Outposts, see Amazon RDS on AWS Outposts @@ -2336,56 +2345,47 @@ type OrderableDBInstanceOption struct { // the Amazon RDS User Guide. OutpostCapable *bool - // Minimum provisioned IOPS per GiB for a DB instance. - MinIopsPerGib *float64 - - // The engine type of a DB instance. - Engine *string - - // The DB instance class for a DB instance. - DBInstanceClass *string - - // Minimum storage size for a DB instance. - MinStorageSize *int32 - - // Minimum total provisioned IOPS for a DB instance. - MinIopsPerDbInstance *int32 + // Indicates whether a DB instance can have a read replica. + ReadReplicaCapable *bool // Indicates the storage type for a DB instance. StorageType *string - // Maximum total provisioned IOPS for a DB instance. - MaxIopsPerDbInstance *int32 - - // The engine version of a DB instance. - EngineVersion *string - - // A list of Availability Zones for a DB instance. - AvailabilityZones []*AvailabilityZone + // A list of the supported DB engine modes. global engine mode only applies for + // global database clusters created with Aurora MySQL version 5.6.10a. For higher + // Aurora MySQL versions, the clusters in a global database use provisioned engine + // mode. + SupportedEngineModes []*string // Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 // to 60 seconds. SupportsEnhancedMonitoring *bool - // A list of the available processor features for the DB instance class of a DB - // instance. - AvailableProcessorFeatures []*AvailableProcessorFeature + // A value that indicates whether you can use Aurora global databases with a + // specific combination of other DB engine attributes. + SupportsGlobalDatabases *bool + + // Indicates whether a DB instance supports IAM database authentication. + SupportsIAMDatabaseAuthentication *bool // Indicates whether a DB instance supports provisioned IOPS. SupportsIops *bool - // The license model for a DB instance. - LicenseModel *string + // Whether a DB instance supports Kerberos Authentication. + SupportsKerberosAuthentication *bool // True if a DB instance supports Performance Insights, otherwise false. SupportsPerformanceInsights *bool - // The Availability Zone group for a DB instance. - AvailabilityZoneGroup *string + // Whether Amazon RDS can automatically scale storage for DB instances that use the + // specified DB instance class. + SupportsStorageAutoscaling *bool - // A value that indicates whether you can use Aurora global databases with a - // specific combination of other DB engine attributes. - SupportsGlobalDatabases *bool + // Indicates whether a DB instance supports encrypted storage. + SupportsStorageEncryption *bool + + // Indicates whether a DB instance is in a VPC. + Vpc *bool } // A data type that represents an Outpost. For more information about RDS on @@ -2403,53 +2403,53 @@ type Outpost struct { // the DescribeEngineDefaultParameters and DescribeDBParameters actions. type Parameter struct { - // Indicates the source of the parameter value. - Source *string + // Specifies the valid range of values for the parameter. + AllowedValues *string - // The earliest engine version to which the parameter can apply. - MinimumEngineVersion *string + // Indicates when to apply parameter updates. + ApplyMethod ApplyMethod + + // Specifies the engine specific parameters type. + ApplyType *string + + // Specifies the valid data type for the parameter. + DataType *string // Provides a description of the parameter. Description *string - // Indicates when to apply parameter updates. - ApplyMethod ApplyMethod - // Indicates whether (true) or not (false) the parameter can be modified. Some // parameters have security or operational implications that prevent them from // being changed. IsModifiable *bool - // Specifies the engine specific parameters type. - ApplyType *string - - // Specifies the valid data type for the parameter. - DataType *string + // The earliest engine version to which the parameter can apply. + MinimumEngineVersion *string // Specifies the name of the parameter. ParameterName *string - // The valid DB engine modes. - SupportedEngineModes []*string - - // Specifies the valid range of values for the parameter. - AllowedValues *string - // Specifies the value of the parameter. ParameterValue *string + + // Indicates the source of the parameter value. + Source *string + + // The valid DB engine modes. + SupportedEngineModes []*string } // A list of the log types whose configuration is still pending. In other words, // these log types are in the process of being activated or deactivated. type PendingCloudwatchLogsExports struct { - // Log types that are in the process of being deactivated. After they are - // deactivated, these log types aren't exported to CloudWatch Logs. - LogTypesToEnable []*string - // Log types that are in the process of being enabled. After they are enabled, // these log types are exported to CloudWatch Logs. LogTypesToDisable []*string + + // Log types that are in the process of being deactivated. After they are + // deactivated, these log types aren't exported to CloudWatch Logs. + LogTypesToEnable []*string } // Provides information about a pending maintenance action for a resource. @@ -2460,10 +2460,10 @@ type PendingMaintenanceAction struct { // ca-certificate-rotation. Action *string - // The date when the maintenance action is automatically applied. The maintenance - // action is applied to the resource on this date regardless of the maintenance - // window for the resource. - ForcedApplyDate *time.Time + // The date of the maintenance window when the action is applied. The maintenance + // action is applied to the resource during its first maintenance window after this + // date. + AutoAppliedAfterDate *time.Time // The effective date when the pending maintenance action is applied to the // resource. This date takes into account opt-in requests received from the @@ -2475,10 +2475,10 @@ type PendingMaintenanceAction struct { // A description providing more detail about the maintenance action. Description *string - // The date of the maintenance window when the action is applied. The maintenance - // action is applied to the resource during its first maintenance window after this - // date. - AutoAppliedAfterDate *time.Time + // The date when the maintenance action is automatically applied. The maintenance + // action is applied to the resource on this date regardless of the maintenance + // window for the resource. + ForcedApplyDate *time.Time // Indicates the type of opt-in request that has been received for the resource. OptInStatus *string @@ -2487,45 +2487,45 @@ type PendingMaintenanceAction struct { // This data type is used as a response element in the ModifyDBInstance action. type PendingModifiedValues struct { - // Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment. - MultiAZ *bool + // Contains the new AllocatedStorage size for the DB instance that will be applied + // or is currently being applied. + AllocatedStorage *int32 + + // Specifies the pending number of days for which automated backups are retained. + BackupRetentionPeriod *int32 + + // Specifies the identifier of the CA certificate for the DB instance. + CACertificateIdentifier *string // Contains the new DBInstanceClass for the DB instance that will be applied or is // currently being applied. DBInstanceClass *string - // Specifies the new Provisioned IOPS value for the DB instance that will be - // applied or is currently being applied. - Iops *int32 - - // Specifies the storage type to be associated with the DB instance. - StorageType *string - - // Indicates the database engine version. - EngineVersion *string - - // The new DB subnet group for the DB instance. - DBSubnetGroupName *string - - // The number of CPU cores and the number of threads per core for the DB instance - // class of the DB instance. - ProcessorFeatures []*ProcessorFeature - // Contains the new DBInstanceIdentifier for the DB instance that will be applied // or is currently being applied. DBInstanceIdentifier *string - // Specifies the identifier of the CA certificate for the DB instance. - CACertificateIdentifier *string + // The new DB subnet group for the DB instance. + DBSubnetGroupName *string - // Contains the new AllocatedStorage size for the DB instance that will be applied - // or is currently being applied. - AllocatedStorage *int32 + // Indicates the database engine version. + EngineVersion *string + + // Specifies the new Provisioned IOPS value for the DB instance that will be + // applied or is currently being applied. + Iops *int32 // The license model for the DB instance. Valid values: license-included | // bring-your-own-license | general-public-license LicenseModel *string + // Contains the pending or currently-in-progress change of the master credentials + // for the DB instance. + MasterUserPassword *string + + // Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment. + MultiAZ *bool + // A list of the log types whose configuration is still pending. In other words, // these log types are in the process of being activated or deactivated. PendingCloudwatchLogsExports *PendingCloudwatchLogsExports @@ -2533,12 +2533,12 @@ type PendingModifiedValues struct { // Specifies the pending port for the DB instance. Port *int32 - // Specifies the pending number of days for which automated backups are retained. - BackupRetentionPeriod *int32 + // The number of CPU cores and the number of threads per core for the DB instance + // class of the DB instance. + ProcessorFeatures []*ProcessorFeature - // Contains the pending or currently-in-progress change of the master credentials - // for the DB instance. - MasterUserPassword *string + // Specifies the storage type to be associated with the DB instance. + StorageType *string } // Contains the processor features of a DB instance class. To specify the number of @@ -2578,27 +2578,27 @@ type PendingModifiedValues struct { // in the Amazon RDS User Guide. type ProcessorFeature struct { - // The value of a processor feature name. - Value *string - // The name of the processor feature. Valid names are coreCount and threadsPerCore. Name *string + + // The value of a processor feature name. + Value *string } // A range of integer values. type Range struct { + // The minimum value in the range. + From *int32 + // The step value for the range. For example, if you have a range of 5,000 to // 10,000, with a step value of 1,000, the valid values start at 5,000 and step up // by 1,000. Even though 7,500 is within the range, it isn't a valid value for the // range. The valid values are 5,000, 6,000, 7,000, 8,000... Step *int32 - // The maximum value in the range. - To *int32 - - // The minimum value in the range. - From *int32 + // The maximum value in the range. + To *int32 } // This data type is used as a response element in the DescribeReservedDBInstances @@ -2616,32 +2616,44 @@ type RecurringCharge struct { // and PurchaseReservedDBInstancesOffering actions. type ReservedDBInstance struct { - // The unique identifier for the reservation. - ReservedDBInstanceId *string + // The currency code for the reserved DB instance. + CurrencyCode *string + + // The DB instance class for the reserved DB instance. + DBInstanceClass *string + + // The number of reserved DB instances. + DBInstanceCount *int32 // The duration of the reservation in seconds. Duration *int32 + // The fixed price charged for this reserved DB instance. + FixedPrice *float64 + // The unique identifier for the lease associated with the reserved DB instance. // AWS Support might request the lease ID for an issue related to a reserved DB // instance. LeaseId *string - // The description of the reserved DB instance. - ProductDescription *string + // Indicates if the reservation applies to Multi-AZ deployments. + MultiAZ *bool // The offering type of this reserved DB instance. OfferingType *string - // The currency code for the reserved DB instance. - CurrencyCode *string - - // The hourly price charged for this reserved DB instance. - UsagePrice *float64 + // The description of the reserved DB instance. + ProductDescription *string // The recurring price charged to run this reserved DB instance. RecurringCharges []*RecurringCharge + // The Amazon Resource Name (ARN) for the reserved DB instance. + ReservedDBInstanceArn *string + + // The unique identifier for the reservation. + ReservedDBInstanceId *string + // The offering identifier. ReservedDBInstancesOfferingId *string @@ -2651,66 +2663,54 @@ type ReservedDBInstance struct { // The state of the reserved DB instance. State *string - // Indicates if the reservation applies to Multi-AZ deployments. - MultiAZ *bool - - // The Amazon Resource Name (ARN) for the reserved DB instance. - ReservedDBInstanceArn *string - - // The DB instance class for the reserved DB instance. - DBInstanceClass *string - - // The fixed price charged for this reserved DB instance. - FixedPrice *float64 - - // The number of reserved DB instances. - DBInstanceCount *int32 + // The hourly price charged for this reserved DB instance. + UsagePrice *float64 } // This data type is used as a response element in the // DescribeReservedDBInstancesOfferings action. type ReservedDBInstancesOffering struct { - // Indicates if the offering applies to Multi-AZ deployments. - MultiAZ *bool - - // The offering identifier. - ReservedDBInstancesOfferingId *string + // The currency code for the reserved DB instance offering. + CurrencyCode *string // The DB instance class for the reserved DB instance. DBInstanceClass *string - // The offering type. - OfferingType *string - - // The database engine used by the offering. - ProductDescription *string - // The duration of the offering in seconds. Duration *int32 - // The hourly price charged for this offering. - UsagePrice *float64 - // The fixed price charged for this offering. FixedPrice *float64 - // The currency code for the reserved DB instance offering. - CurrencyCode *string + // Indicates if the offering applies to Multi-AZ deployments. + MultiAZ *bool + + // The offering type. + OfferingType *string + + // The database engine used by the offering. + ProductDescription *string // The recurring price charged to run this reserved DB instance. RecurringCharges []*RecurringCharge + + // The offering identifier. + ReservedDBInstancesOfferingId *string + + // The hourly price charged for this offering. + UsagePrice *float64 } // Describes the pending maintenance actions for a resource. type ResourcePendingMaintenanceActions struct { - // The ARN of the resource that has pending maintenance actions. - ResourceIdentifier *string - // A list that provides details about the pending maintenance actions for the // resource. PendingMaintenanceActionDetails []*PendingMaintenanceAction + + // The ARN of the resource that has pending maintenance actions. + ResourceIdentifier *string } // Earliest and latest time an instance can be restored to: @@ -2729,6 +2729,25 @@ type RestoreWindow struct { // in the Amazon Aurora User Guide. type ScalingConfiguration struct { + // A value that indicates whether to allow or disallow automatic pause for an + // Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only + // when it's idle (it has no connections). If a DB cluster is paused for more than + // seven days, the DB cluster might be backed up with a snapshot. In this case, the + // DB cluster is restored when there is a request to connect to it. + AutoPause *bool + + // The maximum capacity for an Aurora DB cluster in serverless DB engine mode. For + // Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. + // For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and + // 384. The maximum capacity must be greater than or equal to the minimum capacity. + MaxCapacity *int32 + + // The minimum capacity for an Aurora DB cluster in serverless DB engine mode. For + // Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. + // For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and + // 384. The minimum capacity must be less than or equal to the maximum capacity. + MinCapacity *int32 + // The time, in seconds, before an Aurora DB cluster in serverless mode is paused. SecondsUntilAutoPause *int32 @@ -2742,25 +2761,6 @@ type ScalingConfiguration struct { // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling) // in the Amazon Aurora User Guide. TimeoutAction *string - - // The minimum capacity for an Aurora DB cluster in serverless DB engine mode. For - // Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. - // For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and - // 384. The minimum capacity must be less than or equal to the maximum capacity. - MinCapacity *int32 - - // The maximum capacity for an Aurora DB cluster in serverless DB engine mode. For - // Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. - // For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and - // 384. The maximum capacity must be greater than or equal to the minimum capacity. - MaxCapacity *int32 - - // A value that indicates whether to allow or disallow automatic pause for an - // Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only - // when it's idle (it has no connections). If a DB cluster is paused for more than - // seven days, the DB cluster might be backed up with a snapshot. In this case, the - // DB cluster is restored when there is a request to connect to it. - AutoPause *bool } // Shows the scaling configuration for an Aurora DB cluster in serverless DB engine @@ -2769,15 +2769,6 @@ type ScalingConfiguration struct { // in the Amazon Aurora User Guide. type ScalingConfigurationInfo struct { - // The timeout action of a call to ModifyCurrentDBClusterCapacity, either - // ForceApplyCapacityChange or RollbackCapacityChange. - TimeoutAction *string - - // The remaining amount of time, in seconds, before the Aurora DB cluster in - // serverless mode is paused. A DB cluster can be paused only when it's idle (it - // has no connections). - SecondsUntilAutoPause *int32 - // A value that indicates whether automatic pause is allowed for the Aurora DB // cluster in serverless DB engine mode. When the value is set to false for an // Aurora Serverless DB cluster, the DB cluster automatically resumes. @@ -2788,6 +2779,15 @@ type ScalingConfigurationInfo struct { // The maximum capacity for the Aurora DB cluster in serverless DB engine mode. MinCapacity *int32 + + // The remaining amount of time, in seconds, before the Aurora DB cluster in + // serverless mode is paused. A DB cluster can be paused only when it's idle (it + // has no connections). + SecondsUntilAutoPause *int32 + + // The timeout action of a call to ModifyCurrentDBClusterCapacity, either + // ForceApplyCapacityChange or RollbackCapacityChange. + TimeoutAction *string } // Contains an AWS Region name as the result of a successful call to the @@ -2797,53 +2797,57 @@ type SourceRegion struct { // The endpoint for the source AWS Region endpoint. Endpoint *string - // The status of the source AWS Region. - Status *string - // The name of the source AWS Region. RegionName *string + + // The status of the source AWS Region. + Status *string } // This data type is used as a response element for the DescribeDBSubnetGroups // operation. type Subnet struct { - // The identifier of the subnet. - SubnetIdentifier *string - - // The status of the subnet. - SubnetStatus *string - // Contains Availability Zone information. This data type is used as an element in // the OrderableDBInstanceOption data type. SubnetAvailabilityZone *AvailabilityZone + // The identifier of the subnet. + SubnetIdentifier *string + // If the subnet is associated with an Outpost, this value specifies the Outpost. // For more information about RDS on Outposts, see Amazon RDS on AWS Outposts // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in // the Amazon RDS User Guide. SubnetOutpost *Outpost + + // The status of the subnet. + SubnetStatus *string } // Metadata assigned to an Amazon RDS resource consisting of a key-value pair. type Tag struct { - // A value is the optional value of the tag. The string value can be from 1 to 256 + // A key is the required name of the tag. The string value can be from 1 to 128 // Unicode characters in length and can't be prefixed with "aws:" or "rds:". The // string can only contain only the set of Unicode letters, digits, white-space, // '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). - Value *string + Key *string - // A key is the required name of the tag. The string value can be from 1 to 128 + // A value is the optional value of the tag. The string value can be from 1 to 256 // Unicode characters in length and can't be prefixed with "aws:" or "rds:". The // string can only contain only the set of Unicode letters, digits, white-space, // '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). - Key *string + Value *string } // Information about the connection health of an RDS Proxy target. type TargetHealth struct { + // A description of the health of the RDS Proxy target. If the State is AVAILABLE, + // a description is not included. + Description *string + // The reason for the current health State of the RDS Proxy target. Reason TargetHealthReason @@ -2851,10 +2855,6 @@ type TargetHealth struct { // The following is a typical lifecycle example for the states of an RDS Proxy // target: registering > unavailable > available > unavailable > available State TargetState - - // A description of the health of the RDS Proxy target. If the State is AVAILABLE, - // a description is not included. - Description *string } // A time zone associated with a DBInstance or a DBSnapshot. This data type is an @@ -2869,21 +2869,21 @@ type Timezone struct { // The version of the database engine that a DB instance can be upgraded to. type UpgradeTarget struct { - // The version number of the upgrade target database engine. - EngineVersion *string - // A value that indicates whether the target version is applied to any source DB // instances that have AutoMinorVersionUpgrade set to true. AutoUpgrade *bool - // A value that indicates whether a database engine is upgraded to a major version. - IsMajorVersionUpgrade *bool - // The version of the database engine that a DB instance can be upgraded to. Description *string // The name of the upgrade target database engine. Engine *string + + // The version number of the upgrade target database engine. + EngineVersion *string + + // A value that indicates whether a database engine is upgraded to a major version. + IsMajorVersionUpgrade *bool } // Specifies the details of authentication used by a proxy to log in as a specific @@ -2894,6 +2894,10 @@ type UserAuthConfig struct { // the underlying database. AuthScheme AuthScheme + // A user-specified description about the authentication used by a proxy to log in + // as a specific database user. + Description *string + // Whether to require or disallow AWS Identity and Access Management (IAM) // authentication for connections to the proxy. IAMAuth IAMAuthMode @@ -2903,10 +2907,6 @@ type UserAuthConfig struct { // stored within Amazon Secrets Manager. SecretArn *string - // A user-specified description about the authentication used by a proxy to log in - // as a specific database user. - Description *string - // The name of the database user to which the proxy connects. UserName *string } @@ -2915,13 +2915,9 @@ type UserAuthConfig struct { // database user. type UserAuthConfigInfo struct { - // The name of the database user to which the proxy connects. - UserName *string - - // The Amazon Resource Name (ARN) representing the secret that the proxy uses to - // authenticate to the RDS DB instance or Aurora DB cluster. These secrets are - // stored within Amazon Secrets Manager. - SecretArn *string + // The type of authentication that the proxy uses for connections from the proxy to + // the underlying database. + AuthScheme AuthScheme // A user-specified description about the authentication used by a proxy to log in // as a specific database user. @@ -2931,9 +2927,13 @@ type UserAuthConfigInfo struct { // authentication for connections to the proxy. IAMAuth IAMAuthMode - // The type of authentication that the proxy uses for connections from the proxy to - // the underlying database. - AuthScheme AuthScheme + // The Amazon Resource Name (ARN) representing the secret that the proxy uses to + // authenticate to the RDS DB instance or Aurora DB cluster. These secrets are + // stored within Amazon Secrets Manager. + SecretArn *string + + // The name of the database user to which the proxy connects. + UserName *string } // Information about valid modifications that you can make to your DB instance. @@ -2942,11 +2942,11 @@ type UserAuthConfigInfo struct { // you call ModifyDBInstance. type ValidDBInstanceModificationsMessage struct { - // Valid processor features for your DB instance. - ValidProcessorFeatures []*AvailableProcessorFeature - // Valid storage options for your DB instance. Storage []*ValidStorageOptions + + // Valid processor features for your DB instance. + ValidProcessorFeatures []*AvailableProcessorFeature } // Information about valid modifications that you can make to your DB instance. @@ -2954,23 +2954,23 @@ type ValidDBInstanceModificationsMessage struct { // DescribeValidDBInstanceModifications action. type ValidStorageOptions struct { - // The valid range of storage in gibibytes. For example, 100 to 16384. - StorageSize []*Range + // The valid range of Provisioned IOPS to gibibytes of storage multiplier. For + // example, 3-10, which means that provisioned IOPS can be between 3 and 10 times + // storage. + IopsToStorageRatio []*DoubleRange // The valid range of provisioned IOPS. For example, 1000-20000. ProvisionedIops []*Range + // The valid range of storage in gibibytes. For example, 100 to 16384. + StorageSize []*Range + // The valid storage types for your DB instance. For example, gp2, io1. StorageType *string // Whether or not Amazon RDS can automatically scale storage for DB instances that // use the new instance class. SupportsStorageAutoscaling *bool - - // The valid range of Provisioned IOPS to gibibytes of storage multiplier. For - // example, 3-10, which means that provisioned IOPS can be between 3 and 10 times - // storage. - IopsToStorageRatio []*DoubleRange } // This data type is used as a response element for queries on VPC security group @@ -2990,22 +2990,22 @@ type VpcSecurityGroupMembership struct { // (https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html) type VpnDetails struct { - // The IP address of network traffic from your on-premises data center. A custom AZ - // receives the network traffic. - VpnTunnelOriginatorIP *string - - // The preshared key (PSK) for the VPN. - VpnPSK *string + // The IP address of network traffic from AWS to your on-premises data center. + VpnGatewayIp *string // The ID of the VPN. VpnId *string - // The IP address of network traffic from AWS to your on-premises data center. - VpnGatewayIp *string + // The name of the VPN. + VpnName *string + + // The preshared key (PSK) for the VPN. + VpnPSK *string // The state of the VPN. VpnState *string - // The name of the VPN. - VpnName *string + // The IP address of network traffic from your on-premises data center. A custom AZ + // receives the network traffic. + VpnTunnelOriginatorIP *string } diff --git a/service/rdsdata/api_op_BatchExecuteStatement.go b/service/rdsdata/api_op_BatchExecuteStatement.go index 23a00cd8b8f..dfcd9a7d1e1 100644 --- a/service/rdsdata/api_op_BatchExecuteStatement.go +++ b/service/rdsdata/api_op_BatchExecuteStatement.go @@ -64,6 +64,21 @@ func (c *Client) BatchExecuteStatement(ctx context.Context, params *BatchExecute // data. type BatchExecuteStatementInput struct { + // The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster. + // + // This member is required. + ResourceArn *string + + // The name or ARN of the secret that enables access to the DB cluster. + // + // This member is required. + SecretArn *string + + // The SQL statement to run. + // + // This member is required. + Sql *string + // The name of the database. Database *string @@ -80,24 +95,9 @@ type BatchExecuteStatementInput struct { // Array parameters are not supported. ParameterSets [][]*types.SqlParameter - // The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster. - // - // This member is required. - ResourceArn *string - // The name of the database schema. Schema *string - // The name or ARN of the secret that enables access to the DB cluster. - // - // This member is required. - SecretArn *string - - // The SQL statement to run. - // - // This member is required. - Sql *string - // The identifier of a transaction that was started by using the BeginTransaction // operation. Specify the transaction ID of the transaction that you want to // include the SQL statement in. If the SQL statement is not part of a transaction, diff --git a/service/rdsdata/api_op_BeginTransaction.go b/service/rdsdata/api_op_BeginTransaction.go index 7929dbdadb4..c98cd4602bd 100644 --- a/service/rdsdata/api_op_BeginTransaction.go +++ b/service/rdsdata/api_op_BeginTransaction.go @@ -65,21 +65,21 @@ func (c *Client) BeginTransaction(ctx context.Context, params *BeginTransactionI // transaction. type BeginTransactionInput struct { - // The name of the database. - Database *string - // The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster. // // This member is required. ResourceArn *string - // The name of the database schema. - Schema *string - // The name or ARN of the secret that enables access to the DB cluster. // // This member is required. SecretArn *string + + // The name of the database. + Database *string + + // The name of the database schema. + Schema *string } // The response elements represent the output of a request to start a SQL diff --git a/service/rdsdata/api_op_ExecuteSql.go b/service/rdsdata/api_op_ExecuteSql.go index 95431a16652..3194047af0e 100644 --- a/service/rdsdata/api_op_ExecuteSql.go +++ b/service/rdsdata/api_op_ExecuteSql.go @@ -66,23 +66,23 @@ type ExecuteSqlInput struct { // This member is required. AwsSecretStoreArn *string - // The name of the database. - Database *string - // The ARN of the Aurora Serverless DB cluster. // // This member is required. DbClusterOrInstanceArn *string - // The name of the database schema. - Schema *string - // One or more SQL statements to run on the DB cluster. You can separate SQL // statements from each other with a semicolon (;). Any valid SQL statement is // permitted, including data definition, data manipulation, and commit statements. // // This member is required. SqlStatements *string + + // The name of the database. + Database *string + + // The name of the database schema. + Schema *string } // The response elements represent the output of a request to run one or more SQL diff --git a/service/rdsdata/api_op_ExecuteStatement.go b/service/rdsdata/api_op_ExecuteStatement.go index d06b84a41bf..686eeb23c89 100644 --- a/service/rdsdata/api_op_ExecuteStatement.go +++ b/service/rdsdata/api_op_ExecuteStatement.go @@ -62,6 +62,21 @@ func (c *Client) ExecuteStatement(ctx context.Context, params *ExecuteStatementI // against a database. type ExecuteStatementInput struct { + // The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster. + // + // This member is required. + ResourceArn *string + + // The name or ARN of the secret that enables access to the DB cluster. + // + // This member is required. + SecretArn *string + + // The SQL statement to run. + // + // This member is required. + Sql *string + // A value that indicates whether to continue running the statement after the call // times out. By default, the statement stops running when the call times out. For // DDL statements, we recommend continuing to run the statement after the call @@ -78,11 +93,6 @@ type ExecuteStatementInput struct { // The parameters for the SQL statement. Array parameters are not supported. Parameters []*types.SqlParameter - // The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster. - // - // This member is required. - ResourceArn *string - // Options that control how the result set is returned. ResultSetOptions *types.ResultSetOptions @@ -90,16 +100,6 @@ type ExecuteStatementInput struct { // supported. Schema *string - // The name or ARN of the secret that enables access to the DB cluster. - // - // This member is required. - SecretArn *string - - // The SQL statement to run. - // - // This member is required. - Sql *string - // The identifier of a transaction that was started by using the BeginTransaction // operation. Specify the transaction ID of the transaction that you want to // include the SQL statement in. If the SQL statement is not part of a transaction, diff --git a/service/rdsdata/go.mod b/service/rdsdata/go.mod index fb4c2e62cfc..46d24c6ddb2 100644 --- a/service/rdsdata/go.mod +++ b/service/rdsdata/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/rdsdata go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/redshift/api_op_AcceptReservedNodeExchange.go b/service/redshift/api_op_AcceptReservedNodeExchange.go index a3376e164f8..ec69b3ea6fe 100644 --- a/service/redshift/api_op_AcceptReservedNodeExchange.go +++ b/service/redshift/api_op_AcceptReservedNodeExchange.go @@ -58,18 +58,18 @@ func (c *Client) AcceptReservedNodeExchange(ctx context.Context, params *AcceptR type AcceptReservedNodeExchangeInput struct { + // A string representing the node identifier of the DC1 Reserved Node to be + // exchanged. + // + // This member is required. + ReservedNodeId *string + // The unique identifier of the DC2 Reserved Node offering to be used for the // exchange. You can obtain the value for the parameter by calling // GetReservedNodeExchangeOfferings () // // This member is required. TargetReservedNodeOfferingId *string - - // A string representing the node identifier of the DC1 Reserved Node to be - // exchanged. - // - // This member is required. - ReservedNodeId *string } type AcceptReservedNodeExchangeOutput struct { diff --git a/service/redshift/api_op_AuthorizeSnapshotAccess.go b/service/redshift/api_op_AuthorizeSnapshotAccess.go index b3d990e85a6..e56ab269d91 100644 --- a/service/redshift/api_op_AuthorizeSnapshotAccess.go +++ b/service/redshift/api_op_AuthorizeSnapshotAccess.go @@ -62,11 +62,6 @@ func (c *Client) AuthorizeSnapshotAccess(ctx context.Context, params *AuthorizeS // type AuthorizeSnapshotAccessInput struct { - // The identifier of the cluster the snapshot was created from. This parameter is - // required if your IAM user has a policy containing a snapshot resource element - // that specifies anything other than * for the cluster name. - SnapshotClusterIdentifier *string - // The identifier of the AWS customer account authorized to restore the specified // snapshot. To share a snapshot with AWS support, specify amazon-redshift-support. // @@ -77,6 +72,11 @@ type AuthorizeSnapshotAccessInput struct { // // This member is required. SnapshotIdentifier *string + + // The identifier of the cluster the snapshot was created from. This parameter is + // required if your IAM user has a policy containing a snapshot resource element + // that specifies anything other than * for the cluster name. + SnapshotClusterIdentifier *string } type AuthorizeSnapshotAccessOutput struct { diff --git a/service/redshift/api_op_BatchDeleteClusterSnapshots.go b/service/redshift/api_op_BatchDeleteClusterSnapshots.go index e5d35b97d16..63e51f04c2b 100644 --- a/service/redshift/api_op_BatchDeleteClusterSnapshots.go +++ b/service/redshift/api_op_BatchDeleteClusterSnapshots.go @@ -65,12 +65,12 @@ type BatchDeleteClusterSnapshotsInput struct { type BatchDeleteClusterSnapshotsOutput struct { - // A list of the snapshot identifiers that were deleted. - Resources []*string - // A list of any errors returned. Errors []*types.SnapshotErrorMessage + // A list of the snapshot identifiers that were deleted. + Resources []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_BatchModifyClusterSnapshots.go b/service/redshift/api_op_BatchModifyClusterSnapshots.go index 45699d6ec2f..90b1a35ad00 100644 --- a/service/redshift/api_op_BatchModifyClusterSnapshots.go +++ b/service/redshift/api_op_BatchModifyClusterSnapshots.go @@ -57,6 +57,15 @@ func (c *Client) BatchModifyClusterSnapshots(ctx context.Context, params *BatchM type BatchModifyClusterSnapshotsInput struct { + // A list of snapshot identifiers you want to modify. + // + // This member is required. + SnapshotIdentifierList []*string + + // A boolean value indicating whether to override an exception if the retention + // period has passed. + Force *bool + // The number of days that a manual snapshot is retained. If you specify the value // -1, the manual snapshot is retained indefinitely. The number must be either -1 // or an integer between 1 and 3,653. If you decrease the manual snapshot retention @@ -64,15 +73,6 @@ type BatchModifyClusterSnapshotsInput struct { // the new retention period will return an error. If you want to suppress the // errors and delete the snapshots, use the force option. ManualSnapshotRetentionPeriod *int32 - - // A boolean value indicating whether to override an exception if the retention - // period has passed. - Force *bool - - // A list of snapshot identifiers you want to modify. - // - // This member is required. - SnapshotIdentifierList []*string } type BatchModifyClusterSnapshotsOutput struct { diff --git a/service/redshift/api_op_CancelResize.go b/service/redshift/api_op_CancelResize.go index e1731df4af2..109b60f7f53 100644 --- a/service/redshift/api_op_CancelResize.go +++ b/service/redshift/api_op_CancelResize.go @@ -66,59 +66,39 @@ type CancelResizeInput struct { // Describes the result of a cluster resize operation. type CancelResizeOutput struct { - // An enum with possible values of ClassicResize and ElasticResize. These values - // describe the type of resize operation being performed. - ResizeType *string - - // The number of nodes that the cluster will have after the resize operation is - // complete. - TargetNumberOfNodes *int32 - // The average rate of the resize operation over the last few minutes, measured in // megabytes per second. After the resize operation completes, this value shows the // average rate of the entire resize operation. AvgResizeRateInMegaBytesPerSecond *float64 - // The estimated time remaining, in seconds, until the resize operation is - // complete. This value is calculated based on the average resize rate and the - // estimated amount of data remaining to be processed. Once the resize operation is - // complete, this value will be 0. - EstimatedTimeToCompletionInSeconds *int64 - - // The names of tables that have not been yet imported. Valid Values: List of table - // names - ImportTablesNotStarted []*string + // The percent of data transferred from source cluster to target cluster. + DataTransferProgressPercent *float64 // The amount of seconds that have elapsed since the resize operation began. After // the resize operation completes, this value shows the total actual time, in // seconds, for the resize operation. ElapsedTimeInSeconds *int64 - // The cluster type after the resize operation is complete. Valid Values: - // multi-node | single-node - TargetClusterType *string - - // The percent of data transferred from source cluster to target cluster. - DataTransferProgressPercent *float64 - - // The node type that the cluster will have after the resize operation is complete. - TargetNodeType *string + // The estimated time remaining, in seconds, until the resize operation is + // complete. This value is calculated based on the average resize rate and the + // estimated amount of data remaining to be processed. Once the resize operation is + // complete, this value will be 0. + EstimatedTimeToCompletionInSeconds *int64 // The names of tables that have been completely imported . Valid Values: List of // table names. ImportTablesCompleted []*string - // An optional string to provide additional details about the resize action. - Message *string + // The names of tables that are being currently imported. Valid Values: List of + // table names. + ImportTablesInProgress []*string - // The estimated total amount of data, in megabytes, on the cluster before the - // resize operation began. - TotalResizeDataInMegaBytes *int64 + // The names of tables that have not been yet imported. Valid Values: List of table + // names + ImportTablesNotStarted []*string - // The type of encryption for the cluster after the resize is complete. Possible - // values are KMS and None. In the China region possible values are: Legacy and - // None. - TargetEncryptionType *string + // An optional string to provide additional details about the resize action. + Message *string // While the resize operation is in progress, this value shows the current amount // of data, in megabytes, that has been processed so far. When the resize operation @@ -127,14 +107,34 @@ type CancelResizeOutput struct { // estimated total amount of data before resize). ProgressInMegaBytes *int64 - // The names of tables that are being currently imported. Valid Values: List of - // table names. - ImportTablesInProgress []*string + // An enum with possible values of ClassicResize and ElasticResize. These values + // describe the type of resize operation being performed. + ResizeType *string // The status of the resize operation. Valid Values: NONE | IN_PROGRESS | FAILED | // SUCCEEDED | CANCELLING Status *string + // The cluster type after the resize operation is complete. Valid Values: + // multi-node | single-node + TargetClusterType *string + + // The type of encryption for the cluster after the resize is complete. Possible + // values are KMS and None. In the China region possible values are: Legacy and + // None. + TargetEncryptionType *string + + // The node type that the cluster will have after the resize operation is complete. + TargetNodeType *string + + // The number of nodes that the cluster will have after the resize operation is + // complete. + TargetNumberOfNodes *int32 + + // The estimated total amount of data, in megabytes, on the cluster before the + // resize operation began. + TotalResizeDataInMegaBytes *int64 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_CopyClusterSnapshot.go b/service/redshift/api_op_CopyClusterSnapshot.go index cd18865f4f5..761143853fa 100644 --- a/service/redshift/api_op_CopyClusterSnapshot.go +++ b/service/redshift/api_op_CopyClusterSnapshot.go @@ -67,19 +67,6 @@ func (c *Client) CopyClusterSnapshot(ctx context.Context, params *CopyClusterSna // type CopyClusterSnapshotInput struct { - // The number of days that a manual snapshot is retained. If the value is -1, the - // manual snapshot is retained indefinitely. The value must be either -1 or an - // integer between 1 and 3,653. The default value is -1. - ManualSnapshotRetentionPeriod *int32 - - // The identifier of the cluster the source snapshot was created from. This - // parameter is required if your IAM user has a policy containing a snapshot - // resource element that specifies anything other than * for the cluster name. - // Constraints: - // - // * Must be the identifier for a valid cluster. - SourceSnapshotClusterIdentifier *string - // The identifier for the source snapshot. Constraints: // // * Must be the @@ -106,6 +93,19 @@ type CopyClusterSnapshotInput struct { // // This member is required. TargetSnapshotIdentifier *string + + // The number of days that a manual snapshot is retained. If the value is -1, the + // manual snapshot is retained indefinitely. The value must be either -1 or an + // integer between 1 and 3,653. The default value is -1. + ManualSnapshotRetentionPeriod *int32 + + // The identifier of the cluster the source snapshot was created from. This + // parameter is required if your IAM user has a policy containing a snapshot + // resource element that specifies anything other than * for the cluster name. + // Constraints: + // + // * Must be the identifier for a valid cluster. + SourceSnapshotClusterIdentifier *string } type CopyClusterSnapshotOutput struct { diff --git a/service/redshift/api_op_CreateCluster.go b/service/redshift/api_op_CreateCluster.go index c1ab443a285..e355ed1baad 100644 --- a/service/redshift/api_op_CreateCluster.go +++ b/service/redshift/api_op_CreateCluster.go @@ -64,56 +64,29 @@ func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, // type CreateClusterInput struct { - // The AWS Key Management Service (KMS) key ID of the encryption key that you want - // to use to encrypt data in the cluster. - KmsKeyId *string - - // The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision - // the cluster. For example, if you have several EC2 instances running in a - // specific Availability Zone, then you might want the cluster to be provisioned in - // the same zone in order to decrease network latency. Default: A random, - // system-chosen Availability Zone in the region that is specified by the endpoint. - // Example: us-east-2d Constraint: The specified Availability Zone must be in the - // same region as the current endpoint. - AvailabilityZone *string - - // The weekly time range (in UTC) during which automated cluster maintenance can - // occur. Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window selected at - // random from an 8-hour block of time per region, occurring on a random day of the - // week. For more information about the time blocks for each region, see - // Maintenance Windows - // (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows) - // in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | - // Fri | Sat | Sun Constraints: Minimum 30-minute window. - PreferredMaintenanceWindow *string - - // Reserved. - AdditionalInfo *string - - // The name of the first database to be created when the cluster is created. To - // create additional databases after the cluster is created, connect to the cluster - // with a SQL client and use SQL commands to create a database. For more - // information, go to Create a Database - // (https://docs.aws.amazon.com/redshift/latest/dg/t_creating_database.html) in the - // Amazon Redshift Database Developer Guide. Default: dev Constraints: + // A unique identifier for the cluster. You use this identifier to refer to the + // cluster for any subsequent cluster operations such as deleting or modifying. The + // identifier also appears in the Amazon Redshift console. Constraints: // // * Must - // contain 1 to 64 alphanumeric characters. + // contain from 1 to 63 alphanumeric characters or hyphens. // - // * Must contain only lowercase - // letters. + // * Alphabetic + // characters must be lowercase. // - // * Cannot be a word that is reserved by the service. A list of - // reserved words can be found in Reserved Words - // (https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the - // Amazon Redshift Database Developer Guide. - DBName *string - - // If true, the cluster can be accessed from a public network. - PubliclyAccessible *bool - - // A list of tag instances. - Tags []*types.Tag + // * First character must be a letter. + // + // * + // Cannot end with a hyphen or contain two consecutive hyphens. + // + // * Must be + // unique for all clusters within an AWS account. + // + //

    Example: + // myexamplecluster

    + // + // This member is required. + ClusterIdentifier *string // The password associated with the master user account for the cluster that is // being created. Constraints: @@ -135,14 +108,21 @@ type CreateClusterInput struct { // This member is required. MasterUserPassword *string - // A list of Virtual Private Cloud (VPC) security groups to be associated with the - // cluster. Default: The default VPC security group is associated with the cluster. - VpcSecurityGroupIds []*string - - // An optional parameter for the name of the maintenance track for the cluster. If - // you don't provide a maintenance track name, the cluster is assigned to the - // current track. - MaintenanceTrackName *string + // The user name associated with the master user account for the cluster that is + // being created. Constraints: + // + // * Must be 1 - 128 alphanumeric characters. The + // user name can't be PUBLIC. + // + // * First character must be a letter. + // + // * + //

    Cannot be a reserved word. A list of reserved words can be found in Reserved + // Words in the Amazon Redshift Database Developer Guide.

    + // + // This member is required. + MasterUsername *string // The node type to be provisioned for the cluster. For information about node // types, go to Working with Clusters @@ -154,17 +134,54 @@ type CreateClusterInput struct { // This member is required. NodeType *string - // A unique identifier for the snapshot schedule. - SnapshotScheduleIdentifier *string + // Reserved. + AdditionalInfo *string - // Specifies the name of the HSM configuration that contains the information the - // Amazon Redshift cluster can use to retrieve and store keys in an HSM. - HsmConfigurationIdentifier *string + // If true, major version upgrades can be applied during the maintenance window to + // the Amazon Redshift engine that is running on the cluster. When a new major + // version of the Amazon Redshift engine is released, you can request that the + // service automatically apply upgrades during the maintenance window to the Amazon + // Redshift engine that is running on your cluster. Default: true + AllowVersionUpgrade *bool - // The version of the Amazon Redshift engine software that you want to deploy on - // the cluster. The version selected runs on all the nodes in the cluster. - // Constraints: Only version 1.0 is currently available. Example: 1.0 - ClusterVersion *string + // The number of days that automated snapshots are retained. If the value is 0, + // automated snapshots are disabled. Even if automated snapshots are disabled, you + // can still create manual snapshots when you want with CreateClusterSnapshot (). + // Default: 1 Constraints: Must be a value from 0 to 35. + AutomatedSnapshotRetentionPeriod *int32 + + // The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision + // the cluster. For example, if you have several EC2 instances running in a + // specific Availability Zone, then you might want the cluster to be provisioned in + // the same zone in order to decrease network latency. Default: A random, + // system-chosen Availability Zone in the region that is specified by the endpoint. + // Example: us-east-2d Constraint: The specified Availability Zone must be in the + // same region as the current endpoint. + AvailabilityZone *string + + // The name of the parameter group to be associated with this cluster. Default: The + // default Amazon Redshift cluster parameter group. For information about the + // default parameter group, go to Working with Amazon Redshift Parameter Groups + // (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) + // Constraints: + // + // * Must be 1 to 255 alphanumeric characters or hyphens. + // + // * + // First character must be a letter. + // + // * Cannot end with a hyphen or contain two + // consecutive hyphens. + ClusterParameterGroupName *string + + // A list of security groups to be associated with this cluster. Default: The + // default cluster security group for Amazon Redshift. + ClusterSecurityGroups []*string + + // The name of a cluster subnet group to be associated with this cluster. If this + // parameter is not provided the resulting cluster will be deployed outside virtual + // private cloud (VPC). + ClusterSubnetGroupName *string // The type of the cluster. When cluster type is specified as // @@ -178,51 +195,29 @@ type CreateClusterInput struct { // Default: multi-node ClusterType *string - // The port number on which the cluster accepts incoming connections. The cluster - // is accessible only via the JDBC and ODBC connection strings. Part of the - // connection string requires the port on which the cluster will listen for - // incoming connections. Default: 5439 Valid Values: 1150-65535 - Port *int32 - - // The number of days that automated snapshots are retained. If the value is 0, - // automated snapshots are disabled. Even if automated snapshots are disabled, you - // can still create manual snapshots when you want with CreateClusterSnapshot (). - // Default: 1 Constraints: Must be a value from 0 to 35. - AutomatedSnapshotRetentionPeriod *int32 - - // An option that specifies whether to create the cluster with enhanced VPC routing - // enabled. To create a cluster that uses enhanced VPC routing, the cluster must be - // in a VPC. For more information, see Enhanced VPC Routing - // (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) in - // the Amazon Redshift Cluster Management Guide. If this option is true, enhanced - // VPC routing is enabled. Default: false - EnhancedVpcRouting *bool + // The version of the Amazon Redshift engine software that you want to deploy on + // the cluster. The version selected runs on all the nodes in the cluster. + // Constraints: Only version 1.0 is currently available. Example: 1.0 + ClusterVersion *string - // The user name associated with the master user account for the cluster that is - // being created. Constraints: - // - // * Must be 1 - 128 alphanumeric characters. The - // user name can't be PUBLIC. + // The name of the first database to be created when the cluster is created. To + // create additional databases after the cluster is created, connect to the cluster + // with a SQL client and use SQL commands to create a database. For more + // information, go to Create a Database + // (https://docs.aws.amazon.com/redshift/latest/dg/t_creating_database.html) in the + // Amazon Redshift Database Developer Guide. Default: dev Constraints: // - // * First character must be a letter. + // * Must + // contain 1 to 64 alphanumeric characters. // - // * - //

    Cannot be a reserved word. A list of reserved words can be found in Reserved - // Words in the Amazon Redshift Database Developer Guide.

    + // * Must contain only lowercase + // letters. // - // This member is required. - MasterUsername *string - - // The number of compute nodes in the cluster. This parameter is required when the - // ClusterType parameter is specified as multi-node. For information about - // determining how many nodes you need, go to Working with Clusters - // (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes) - // in the Amazon Redshift Cluster Management Guide. If you don't specify this - // parameter, you get a single-node cluster. When requesting a multi-node cluster, - // you must specify the number of nodes that you want in the cluster. Default: 1 - // Constraints: Value must be at least 1 and no more than 100. - NumberOfNodes *int32 + // * Cannot be a word that is reserved by the service. A list of + // reserved words can be found in Reserved Words + // (https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the + // Amazon Redshift Database Developer Guide. + DBName *string // The Elastic IP (EIP) address for the cluster. Constraints: The cluster must be // provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For @@ -235,76 +230,81 @@ type CreateClusterInput struct { // If true, the data in the cluster is encrypted at rest. Default: false Encrypted *bool + // An option that specifies whether to create the cluster with enhanced VPC routing + // enabled. To create a cluster that uses enhanced VPC routing, the cluster must be + // in a VPC. For more information, see Enhanced VPC Routing + // (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) in + // the Amazon Redshift Cluster Management Guide. If this option is true, enhanced + // VPC routing is enabled. Default: false + EnhancedVpcRouting *bool + // Specifies the name of the HSM client certificate the Amazon Redshift cluster // uses to retrieve the data encryption keys stored in an HSM. HsmClientCertificateIdentifier *string + // Specifies the name of the HSM configuration that contains the information the + // Amazon Redshift cluster can use to retrieve and store keys in an HSM. + HsmConfigurationIdentifier *string + + // A list of AWS Identity and Access Management (IAM) roles that can be used by the + // cluster to access other AWS services. You must supply the IAM roles in their + // Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single + // request. A cluster can have up to 10 IAM roles associated with it at any time. + IamRoles []*string + + // The AWS Key Management Service (KMS) key ID of the encryption key that you want + // to use to encrypt data in the cluster. + KmsKeyId *string + + // An optional parameter for the name of the maintenance track for the cluster. If + // you don't provide a maintenance track name, the cluster is assigned to the + // current track. + MaintenanceTrackName *string + // The default number of days to retain a manual snapshot. If the value is -1, the // snapshot is retained indefinitely. This setting doesn't change the retention // period of existing snapshots. The value must be either -1 or an integer between // 1 and 3,653. ManualSnapshotRetentionPeriod *int32 - // If true, major version upgrades can be applied during the maintenance window to - // the Amazon Redshift engine that is running on the cluster. When a new major - // version of the Amazon Redshift engine is released, you can request that the - // service automatically apply upgrades during the maintenance window to the Amazon - // Redshift engine that is running on your cluster. Default: true - AllowVersionUpgrade *bool + // The number of compute nodes in the cluster. This parameter is required when the + // ClusterType parameter is specified as multi-node. For information about + // determining how many nodes you need, go to Working with Clusters + // (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes) + // in the Amazon Redshift Cluster Management Guide. If you don't specify this + // parameter, you get a single-node cluster. When requesting a multi-node cluster, + // you must specify the number of nodes that you want in the cluster. Default: 1 + // Constraints: Value must be at least 1 and no more than 100. + NumberOfNodes *int32 - // The name of a cluster subnet group to be associated with this cluster. If this - // parameter is not provided the resulting cluster will be deployed outside virtual - // private cloud (VPC). - ClusterSubnetGroupName *string + // The port number on which the cluster accepts incoming connections. The cluster + // is accessible only via the JDBC and ODBC connection strings. Part of the + // connection string requires the port on which the cluster will listen for + // incoming connections. Default: 5439 Valid Values: 1150-65535 + Port *int32 - // The name of the parameter group to be associated with this cluster. Default: The - // default Amazon Redshift cluster parameter group. For information about the - // default parameter group, go to Working with Amazon Redshift Parameter Groups - // (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) - // Constraints: - // - // * Must be 1 to 255 alphanumeric characters or hyphens. - // - // * - // First character must be a letter. - // - // * Cannot end with a hyphen or contain two - // consecutive hyphens. - ClusterParameterGroupName *string + // The weekly time range (in UTC) during which automated cluster maintenance can + // occur. Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window selected at + // random from an 8-hour block of time per region, occurring on a random day of the + // week. For more information about the time blocks for each region, see + // Maintenance Windows + // (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows) + // in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | + // Fri | Sat | Sun Constraints: Minimum 30-minute window. + PreferredMaintenanceWindow *string - // A list of security groups to be associated with this cluster. Default: The - // default cluster security group for Amazon Redshift. - ClusterSecurityGroups []*string + // If true, the cluster can be accessed from a public network. + PubliclyAccessible *bool - // A list of AWS Identity and Access Management (IAM) roles that can be used by the - // cluster to access other AWS services. You must supply the IAM roles in their - // Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single - // request. A cluster can have up to 10 IAM roles associated with it at any time. - IamRoles []*string + // A unique identifier for the snapshot schedule. + SnapshotScheduleIdentifier *string - // A unique identifier for the cluster. You use this identifier to refer to the - // cluster for any subsequent cluster operations such as deleting or modifying. The - // identifier also appears in the Amazon Redshift console. Constraints: - // - // * Must - // contain from 1 to 63 alphanumeric characters or hyphens. - // - // * Alphabetic - // characters must be lowercase. - // - // * First character must be a letter. - // - // * - // Cannot end with a hyphen or contain two consecutive hyphens. - // - // * Must be - // unique for all clusters within an AWS account. - // - //

    Example: - // myexamplecluster

    - // - // This member is required. - ClusterIdentifier *string + // A list of tag instances. + Tags []*types.Tag + + // A list of Virtual Private Cloud (VPC) security groups to be associated with the + // cluster. Default: The default VPC security group is associated with the cluster. + VpcSecurityGroupIds []*string } type CreateClusterOutput struct { diff --git a/service/redshift/api_op_CreateClusterParameterGroup.go b/service/redshift/api_op_CreateClusterParameterGroup.go index ca881a3666c..c0fcd0542c9 100644 --- a/service/redshift/api_op_CreateClusterParameterGroup.go +++ b/service/redshift/api_op_CreateClusterParameterGroup.go @@ -66,6 +66,23 @@ func (c *Client) CreateClusterParameterGroup(ctx context.Context, params *Create // type CreateClusterParameterGroupInput struct { + // A description of the parameter group. + // + // This member is required. + Description *string + + // The Amazon Redshift engine version to which the cluster parameter group applies. + // The cluster engine version determines the set of parameters. To get a list of + // valid parameter group family names, you can call DescribeClusterParameterGroups + // (). By default, Amazon Redshift returns a list of all the parameter groups that + // are owned by your AWS account, including the default parameter groups for each + // Amazon Redshift engine version. The parameter group family names associated with + // the default parameter groups provide you the valid values. For example, a valid + // family name is "redshift-1.0". + // + // This member is required. + ParameterGroupFamily *string + // The name of the cluster parameter group. Constraints: // // * Must be 1 to 255 @@ -84,25 +101,8 @@ type CreateClusterParameterGroupInput struct { // This member is required. ParameterGroupName *string - // The Amazon Redshift engine version to which the cluster parameter group applies. - // The cluster engine version determines the set of parameters. To get a list of - // valid parameter group family names, you can call DescribeClusterParameterGroups - // (). By default, Amazon Redshift returns a list of all the parameter groups that - // are owned by your AWS account, including the default parameter groups for each - // Amazon Redshift engine version. The parameter group family names associated with - // the default parameter groups provide you the valid values. For example, a valid - // family name is "redshift-1.0". - // - // This member is required. - ParameterGroupFamily *string - // A list of tag instances. Tags []*types.Tag - - // A description of the parameter group. - // - // This member is required. - Description *string } type CreateClusterParameterGroupOutput struct { diff --git a/service/redshift/api_op_CreateClusterSecurityGroup.go b/service/redshift/api_op_CreateClusterSecurityGroup.go index a75a44f6e1c..e2e96aa70fb 100644 --- a/service/redshift/api_op_CreateClusterSecurityGroup.go +++ b/service/redshift/api_op_CreateClusterSecurityGroup.go @@ -62,14 +62,6 @@ func (c *Client) CreateClusterSecurityGroup(ctx context.Context, params *CreateC // type CreateClusterSecurityGroupInput struct { - // A description for the security group. - // - // This member is required. - Description *string - - // A list of tag instances. - Tags []*types.Tag - // The name for the security group. Amazon Redshift stores the value as a lowercase // string. Constraints: // @@ -86,6 +78,14 @@ type CreateClusterSecurityGroupInput struct { // // This member is required. ClusterSecurityGroupName *string + + // A description for the security group. + // + // This member is required. + Description *string + + // A list of tag instances. + Tags []*types.Tag } type CreateClusterSecurityGroupOutput struct { diff --git a/service/redshift/api_op_CreateClusterSnapshot.go b/service/redshift/api_op_CreateClusterSnapshot.go index 4634beac03b..f38b29b27ec 100644 --- a/service/redshift/api_op_CreateClusterSnapshot.go +++ b/service/redshift/api_op_CreateClusterSnapshot.go @@ -62,14 +62,6 @@ func (c *Client) CreateClusterSnapshot(ctx context.Context, params *CreateCluste // type CreateClusterSnapshotInput struct { - // The number of days that a manual snapshot is retained. If the value is -1, the - // manual snapshot is retained indefinitely.

    The value must be either -1 or an - // integer between 1 and 3,653.

    The default value is -1.

    - ManualSnapshotRetentionPeriod *int32 - - // A list of tag instances. - Tags []*types.Tag - // The cluster identifier for which you want a snapshot. // // This member is required. @@ -93,6 +85,14 @@ type CreateClusterSnapshotInput struct { // // This member is required. SnapshotIdentifier *string + + // The number of days that a manual snapshot is retained. If the value is -1, the + // manual snapshot is retained indefinitely.

    The value must be either -1 or an + // integer between 1 and 3,653.

    The default value is -1.

    + ManualSnapshotRetentionPeriod *int32 + + // A list of tag instances. + Tags []*types.Tag } type CreateClusterSnapshotOutput struct { diff --git a/service/redshift/api_op_CreateClusterSubnetGroup.go b/service/redshift/api_op_CreateClusterSubnetGroup.go index 6e126251477..c9f3b2d324b 100644 --- a/service/redshift/api_op_CreateClusterSubnetGroup.go +++ b/service/redshift/api_op_CreateClusterSubnetGroup.go @@ -63,15 +63,6 @@ func (c *Client) CreateClusterSubnetGroup(ctx context.Context, params *CreateClu // type CreateClusterSubnetGroupInput struct { - // A list of tag instances. - Tags []*types.Tag - - // An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single - // request. - // - // This member is required. - SubnetIds []*string - // The name for the subnet group. Amazon Redshift stores the value as a lowercase // string. Constraints: // @@ -93,6 +84,15 @@ type CreateClusterSubnetGroupInput struct { // // This member is required. Description *string + + // An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single + // request. + // + // This member is required. + SubnetIds []*string + + // A list of tag instances. + Tags []*types.Tag } type CreateClusterSubnetGroupOutput struct { diff --git a/service/redshift/api_op_CreateEventSubscription.go b/service/redshift/api_op_CreateEventSubscription.go index 3e1872f97dd..5ad6baaa98d 100644 --- a/service/redshift/api_op_CreateEventSubscription.go +++ b/service/redshift/api_op_CreateEventSubscription.go @@ -83,10 +83,31 @@ type CreateEventSubscriptionInput struct { // This member is required. SnsTopicArn *string + // The name of the event subscription to be created. Constraints: + // + // * Cannot be + // null, empty, or blank. + // + // * Must contain from 1 to 255 alphanumeric characters + // or hyphens. + // + // * First character must be a letter. + // + // * Cannot end with a + // hyphen or contain two consecutive hyphens. + // + // This member is required. + SubscriptionName *string + // A boolean value; set to true to activate the subscription, and set to false to // create the subscription but not activate it. Enabled *bool + // Specifies the Amazon Redshift event categories to be published by the event + // notification subscription. Values: configuration, management, monitoring, + // security + EventCategories []*string + // Specifies the Amazon Redshift event severity to be published by the event // notification subscription. Values: ERROR, INFO Severity *string @@ -99,11 +120,6 @@ type CreateEventSubscriptionInput struct { // my-snapshot-20131010 SourceIds []*string - // Specifies the Amazon Redshift event categories to be published by the event - // notification subscription. Values: configuration, management, monitoring, - // security - EventCategories []*string - // The type of source that will be generating the events. For example, if you want // to be notified of events generated by a cluster, you would set this parameter to // cluster. If this value is not specified, events are returned for all Amazon @@ -114,22 +130,6 @@ type CreateEventSubscriptionInput struct { // A list of tag instances. Tags []*types.Tag - - // The name of the event subscription to be created. Constraints: - // - // * Cannot be - // null, empty, or blank. - // - // * Must contain from 1 to 255 alphanumeric characters - // or hyphens. - // - // * First character must be a letter. - // - // * Cannot end with a - // hyphen or contain two consecutive hyphens. - // - // This member is required. - SubscriptionName *string } type CreateEventSubscriptionOutput struct { diff --git a/service/redshift/api_op_CreateHsmClientCertificate.go b/service/redshift/api_op_CreateHsmClientCertificate.go index 175288ba69f..110e0de958d 100644 --- a/service/redshift/api_op_CreateHsmClientCertificate.go +++ b/service/redshift/api_op_CreateHsmClientCertificate.go @@ -66,14 +66,14 @@ func (c *Client) CreateHsmClientCertificate(ctx context.Context, params *CreateH // type CreateHsmClientCertificateInput struct { - // A list of tag instances. - Tags []*types.Tag - // The identifier to be assigned to the new HSM client certificate that the cluster // will use to connect to the HSM to use the database encryption keys. // // This member is required. HsmClientCertificateIdentifier *string + + // A list of tag instances. + Tags []*types.Tag } type CreateHsmClientCertificateOutput struct { diff --git a/service/redshift/api_op_CreateHsmConfiguration.go b/service/redshift/api_op_CreateHsmConfiguration.go index 845ff80d3aa..f8c308d8da3 100644 --- a/service/redshift/api_op_CreateHsmConfiguration.go +++ b/service/redshift/api_op_CreateHsmConfiguration.go @@ -66,40 +66,40 @@ func (c *Client) CreateHsmConfiguration(ctx context.Context, params *CreateHsmCo // type CreateHsmConfigurationInput struct { - // The IP address that the Amazon Redshift cluster must use to access the HSM. + // A text description of the HSM configuration to be created. // // This member is required. - HsmIpAddress *string + Description *string - // The HSMs public certificate file. When using Cloud HSM, the file name is - // server.pem. + // The identifier to be assigned to the new Amazon Redshift HSM configuration. // // This member is required. - HsmServerPublicCertificate *string + HsmConfigurationIdentifier *string - // A text description of the HSM configuration to be created. + // The IP address that the Amazon Redshift cluster must use to access the HSM. // // This member is required. - Description *string + HsmIpAddress *string + + // The name of the partition in the HSM where the Amazon Redshift clusters will + // store their database encryption keys. + // + // This member is required. + HsmPartitionName *string // The password required to access the HSM partition. // // This member is required. HsmPartitionPassword *string - // The name of the partition in the HSM where the Amazon Redshift clusters will - // store their database encryption keys. + // The HSMs public certificate file. When using Cloud HSM, the file name is + // server.pem. // // This member is required. - HsmPartitionName *string + HsmServerPublicCertificate *string // A list of tag instances. Tags []*types.Tag - - // The identifier to be assigned to the new Amazon Redshift HSM configuration. - // - // This member is required. - HsmConfigurationIdentifier *string } type CreateHsmConfigurationOutput struct { diff --git a/service/redshift/api_op_CreateScheduledAction.go b/service/redshift/api_op_CreateScheduledAction.go index 667f0e33937..ccb402447bf 100644 --- a/service/redshift/api_op_CreateScheduledAction.go +++ b/service/redshift/api_op_CreateScheduledAction.go @@ -60,25 +60,17 @@ func (c *Client) CreateScheduledAction(ctx context.Context, params *CreateSchedu type CreateScheduledActionInput struct { - // If true, the schedule is enabled. If false, the scheduled action does not - // trigger. For more information about state of the scheduled action, see - // ScheduledAction (). - Enable *bool - - // A JSON format string of the Amazon Redshift API operation with input parameters. - // For more information about this parameter, see ScheduledAction (). - // - // This member is required. - TargetAction *types.ScheduledActionType - // The IAM role to assume to run the target action. For more information about this // parameter, see ScheduledAction (). // // This member is required. IamRole *string - // The description of the scheduled action. - ScheduledActionDescription *string + // The schedule in at( ) or cron( ) format. For more information about this + // parameter, see ScheduledAction (). + // + // This member is required. + Schedule *string // The name of the scheduled action. The name must be unique within an account. For // more information about this parameter, see ScheduledAction (). @@ -86,16 +78,24 @@ type CreateScheduledActionInput struct { // This member is required. ScheduledActionName *string + // A JSON format string of the Amazon Redshift API operation with input parameters. + // For more information about this parameter, see ScheduledAction (). + // + // This member is required. + TargetAction *types.ScheduledActionType + + // If true, the schedule is enabled. If false, the scheduled action does not + // trigger. For more information about state of the scheduled action, see + // ScheduledAction (). + Enable *bool + // The end time in UTC of the scheduled action. After this time, the scheduled // action does not trigger. For more information about this parameter, see // ScheduledAction (). EndTime *time.Time - // The schedule in at( ) or cron( ) format. For more information about this - // parameter, see ScheduledAction (). - // - // This member is required. - Schedule *string + // The description of the scheduled action. + ScheduledActionDescription *string // The start time in UTC of the scheduled action. Before this time, the scheduled // action does not trigger. For more information about this parameter, see @@ -108,14 +108,9 @@ type CreateScheduledActionInput struct { // operations can be scheduled, see ScheduledActionType (). type CreateScheduledActionOutput struct { - // List of times when the scheduled action will run. - NextInvocations []*time.Time - - // The description of the scheduled action. - ScheduledActionDescription *string - - // The name of the scheduled action. - ScheduledActionName *string + // The end time in UTC when the schedule is no longer active. After this time, the + // scheduled action does not trigger. + EndTime *time.Time // The IAM role to assume to run the scheduled action. This IAM role must have // permission to run the Amazon Redshift API operation in the scheduled action. @@ -127,16 +122,8 @@ type CreateScheduledActionOutput struct { // in the Amazon Redshift Cluster Management Guide. IamRole *string - // A JSON format string of the Amazon Redshift API operation with input parameters. - // "{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}". - TargetAction *types.ScheduledActionType - - // The end time in UTC when the schedule is no longer active. After this time, the - // scheduled action does not trigger. - EndTime *time.Time - - // The state of the scheduled action. For example, DISABLED. - State types.ScheduledActionState + // List of times when the scheduled action will run. + NextInvocations []*time.Time // The schedule for a one-time (at format) or recurring (cron format) scheduled // action. Schedule invocations must be separated by at least one hour. Format of @@ -148,10 +135,23 @@ type CreateScheduledActionOutput struct { // in the Amazon CloudWatch Events User Guide. Schedule *string + // The description of the scheduled action. + ScheduledActionDescription *string + + // The name of the scheduled action. + ScheduledActionName *string + // The start time in UTC when the schedule is active. Before this time, the // scheduled action does not trigger. StartTime *time.Time + // The state of the scheduled action. For example, DISABLED. + State types.ScheduledActionState + + // A JSON format string of the Amazon Redshift API operation with input parameters. + // "{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}". + TargetAction *types.ScheduledActionType + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_CreateSnapshotCopyGrant.go b/service/redshift/api_op_CreateSnapshotCopyGrant.go index 7247c87603c..1e7a6463349 100644 --- a/service/redshift/api_op_CreateSnapshotCopyGrant.go +++ b/service/redshift/api_op_CreateSnapshotCopyGrant.go @@ -83,12 +83,12 @@ type CreateSnapshotCopyGrantInput struct { // This member is required. SnapshotCopyGrantName *string - // A list of tag instances. - Tags []*types.Tag - // The unique identifier of the customer master key (CMK) to which to grant Amazon // Redshift permission. If no key is specified, the default key is used. KmsKeyId *string + + // A list of tag instances. + Tags []*types.Tag } type CreateSnapshotCopyGrantOutput struct { diff --git a/service/redshift/api_op_CreateSnapshotSchedule.go b/service/redshift/api_op_CreateSnapshotSchedule.go index 3f4c10104f0..2b1cf8275e8 100644 --- a/service/redshift/api_op_CreateSnapshotSchedule.go +++ b/service/redshift/api_op_CreateSnapshotSchedule.go @@ -58,19 +58,19 @@ func (c *Client) CreateSnapshotSchedule(ctx context.Context, params *CreateSnaps type CreateSnapshotScheduleInput struct { - // The description of the snapshot schedule. - ScheduleDescription *string - - // The definition of the snapshot schedule. The definition is made up of schedule - // expressions, for example "cron(30 12 *)" or "rate(12 hours)". - ScheduleDefinitions []*string - // DryRun *bool // NextInvocations *int32 + // The definition of the snapshot schedule. The definition is made up of schedule + // expressions, for example "cron(30 12 *)" or "rate(12 hours)". + ScheduleDefinitions []*string + + // The description of the snapshot schedule. + ScheduleDescription *string + // A unique identifier for a snapshot schedule. Only alphanumeric characters are // allowed for the identifier. ScheduleIdentifier *string @@ -83,15 +83,21 @@ type CreateSnapshotScheduleInput struct { // snapshots of a cluster. You can also schedule snapshots for specific dates. type CreateSnapshotScheduleOutput struct { - // - NextInvocations []*time.Time + // The number of clusters associated with the schedule. + AssociatedClusterCount *int32 // A list of clusters associated with the schedule. A maximum of 100 clusters is // returned. AssociatedClusters []*types.ClusterAssociatedToSchedule - // The number of clusters associated with the schedule. - AssociatedClusterCount *int32 + // + NextInvocations []*time.Time + + // A list of ScheduleDefinitions. + ScheduleDefinitions []*string + + // The description of the schedule. + ScheduleDescription *string // A unique identifier for the schedule. ScheduleIdentifier *string @@ -99,12 +105,6 @@ type CreateSnapshotScheduleOutput struct { // An optional set of tags describing the schedule. Tags []*types.Tag - // The description of the schedule. - ScheduleDescription *string - - // A list of ScheduleDefinitions. - ScheduleDefinitions []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_CreateUsageLimit.go b/service/redshift/api_op_CreateUsageLimit.go index 55bd5430e73..1f1ae3be2b4 100644 --- a/service/redshift/api_op_CreateUsageLimit.go +++ b/service/redshift/api_op_CreateUsageLimit.go @@ -58,32 +58,21 @@ func (c *Client) CreateUsageLimit(ctx context.Context, params *CreateUsageLimitI type CreateUsageLimitInput struct { - // The Amazon Redshift feature that you want to limit. + // The limit amount. If time-based, this amount is in minutes. If data-based, this + // amount is in terabytes (TB). The value must be a positive number. // // This member is required. - FeatureType types.UsageLimitFeatureType - - // A list of tag instances. - Tags []*types.Tag + Amount *int64 // The identifier of the cluster that you want to limit usage. // // This member is required. ClusterIdentifier *string - // The action that Amazon Redshift takes when the limit is reached. The default is - // log. For more information about this parameter, see UsageLimit (). - BreachAction types.UsageLimitBreachAction - - // The time period that the amount applies to. A weekly period begins on Sunday. - // The default is monthly. - Period types.UsageLimitPeriod - - // The limit amount. If time-based, this amount is in minutes. If data-based, this - // amount is in terabytes (TB). The value must be a positive number. + // The Amazon Redshift feature that you want to limit. // // This member is required. - Amount *int64 + FeatureType types.UsageLimitFeatureType // The type of limit. Depending on the feature type, this can be based on a time // duration or data size. If FeatureType is spectrum, then LimitType must be @@ -92,23 +81,25 @@ type CreateUsageLimitInput struct { // // This member is required. LimitType types.UsageLimitLimitType -} -// Describes a usage limit object for a cluster. -type CreateUsageLimitOutput struct { - - // The identifier of the cluster with a usage limit. - ClusterIdentifier *string + // The action that Amazon Redshift takes when the limit is reached. The default is + // log. For more information about this parameter, see UsageLimit (). + BreachAction types.UsageLimitBreachAction - // The Amazon Redshift feature to which the limit applies. - FeatureType types.UsageLimitFeatureType + // The time period that the amount applies to. A weekly period begins on Sunday. + // The default is monthly. + Period types.UsageLimitPeriod // A list of tag instances. Tags []*types.Tag +} - // The type of limit. Depending on the feature type, this can be based on a time - // duration or data size. - LimitType types.UsageLimitLimitType +// Describes a usage limit object for a cluster. +type CreateUsageLimitOutput struct { + + // The limit amount. If time-based, this amount is in minutes. If data-based, this + // amount is in terabytes (TB). + Amount *int64 // The action that Amazon Redshift takes when the limit is reached. Possible values // are: @@ -122,17 +113,26 @@ type CreateUsageLimitOutput struct { // feature until the next usage period begins. BreachAction types.UsageLimitBreachAction + // The identifier of the cluster with a usage limit. + ClusterIdentifier *string + + // The Amazon Redshift feature to which the limit applies. + FeatureType types.UsageLimitFeatureType + + // The type of limit. Depending on the feature type, this can be based on a time + // duration or data size. + LimitType types.UsageLimitLimitType + // The time period that the amount applies to. A weekly period begins on Sunday. // The default is monthly. Period types.UsageLimitPeriod + // A list of tag instances. + Tags []*types.Tag + // The identifier of the usage limit. UsageLimitId *string - // The limit amount. If time-based, this amount is in minutes. If data-based, this - // amount is in terabytes (TB). - Amount *int64 - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_DeleteCluster.go b/service/redshift/api_op_DeleteCluster.go index 8956cdc8fbc..0378c505d0a 100644 --- a/service/redshift/api_op_DeleteCluster.go +++ b/service/redshift/api_op_DeleteCluster.go @@ -88,13 +88,6 @@ type DeleteClusterInput struct { // This member is required. ClusterIdentifier *string - // Determines whether a final snapshot of the cluster is created before Amazon - // Redshift deletes the cluster. If true, a final cluster snapshot is not created. - // If false, a final cluster snapshot is created before the cluster is deleted. The - // FinalClusterSnapshotIdentifier parameter must be specified if - // SkipFinalClusterSnapshot is false. Default: false - SkipFinalClusterSnapshot *bool - // The identifier of the final snapshot that is to be created immediately before // deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot // must be false. Constraints: @@ -112,6 +105,13 @@ type DeleteClusterInput struct { // manual snapshot is retained indefinitely. The value must be either -1 or an // integer between 1 and 3,653. The default value is -1. FinalClusterSnapshotRetentionPeriod *int32 + + // Determines whether a final snapshot of the cluster is created before Amazon + // Redshift deletes the cluster. If true, a final cluster snapshot is not created. + // If false, a final cluster snapshot is created before the cluster is deleted. The + // FinalClusterSnapshotIdentifier parameter must be specified if + // SkipFinalClusterSnapshot is false. Default: false + SkipFinalClusterSnapshot *bool } type DeleteClusterOutput struct { diff --git a/service/redshift/api_op_DeleteClusterSnapshot.go b/service/redshift/api_op_DeleteClusterSnapshot.go index b547b1fe8bb..ef6ced853e4 100644 --- a/service/redshift/api_op_DeleteClusterSnapshot.go +++ b/service/redshift/api_op_DeleteClusterSnapshot.go @@ -64,18 +64,18 @@ func (c *Client) DeleteClusterSnapshot(ctx context.Context, params *DeleteCluste // type DeleteClusterSnapshotInput struct { - // The unique identifier of the cluster the snapshot was created from. This - // parameter is required if your IAM user has a policy containing a snapshot - // resource element that specifies anything other than * for the cluster name. - // Constraints: Must be the name of valid cluster. - SnapshotClusterIdentifier *string - // The unique identifier of the manual snapshot to be deleted. Constraints: Must be // the name of an existing snapshot that is in the available, failed, or cancelled // state. // // This member is required. SnapshotIdentifier *string + + // The unique identifier of the cluster the snapshot was created from. This + // parameter is required if your IAM user has a policy containing a snapshot + // resource element that specifies anything other than * for the cluster name. + // Constraints: Must be the name of valid cluster. + SnapshotClusterIdentifier *string } type DeleteClusterSnapshotOutput struct { diff --git a/service/redshift/api_op_DeleteTags.go b/service/redshift/api_op_DeleteTags.go index d67ff7f2d69..987b53e87f2 100644 --- a/service/redshift/api_op_DeleteTags.go +++ b/service/redshift/api_op_DeleteTags.go @@ -58,16 +58,16 @@ func (c *Client) DeleteTags(ctx context.Context, params *DeleteTagsInput, optFns // Contains the output from the DeleteTags action. type DeleteTagsInput struct { - // The tag key that you want to delete. - // - // This member is required. - TagKeys []*string - // The Amazon Resource Name (ARN) from which you want to remove the tag or tags. // For example, arn:aws:redshift:us-east-2:123456789:cluster:t1. // // This member is required. ResourceName *string + + // The tag key that you want to delete. + // + // This member is required. + TagKeys []*string } type DeleteTagsOutput struct { diff --git a/service/redshift/api_op_DescribeClusterDbRevisions.go b/service/redshift/api_op_DescribeClusterDbRevisions.go index 4e2797b751c..7f9fbd7016d 100644 --- a/service/redshift/api_op_DescribeClusterDbRevisions.go +++ b/service/redshift/api_op_DescribeClusterDbRevisions.go @@ -56,6 +56,11 @@ func (c *Client) DescribeClusterDbRevisions(ctx context.Context, params *Describ type DescribeClusterDbRevisionsInput struct { + // A unique identifier for a cluster whose ClusterDbRevisions you are requesting. + // This parameter is case sensitive. All clusters defined for an account are + // returned by default. + ClusterIdentifier *string + // An optional parameter that specifies the starting point for returning a set of // response records. When the results of a DescribeClusterDbRevisions request // exceed the value specified in MaxRecords, Amazon Redshift returns a value in the @@ -65,11 +70,6 @@ type DescribeClusterDbRevisionsInput struct { // the marker parameter, but not both. Marker *string - // A unique identifier for a cluster whose ClusterDbRevisions you are requesting. - // This parameter is case sensitive. All clusters defined for an account are - // returned by default. - ClusterIdentifier *string - // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in the marker field of the response. You can retrieve the next set of diff --git a/service/redshift/api_op_DescribeClusterParameterGroups.go b/service/redshift/api_op_DescribeClusterParameterGroups.go index 9c3b77da5ce..3b9a0059e42 100644 --- a/service/redshift/api_op_DescribeClusterParameterGroups.go +++ b/service/redshift/api_op_DescribeClusterParameterGroups.go @@ -70,9 +70,13 @@ func (c *Client) DescribeClusterParameterGroups(ctx context.Context, params *Des // type DescribeClusterParameterGroupsInput struct { - // The name of a specific parameter group for which to return details. By default, - // details about all parameter groups and the default parameter group are returned. - ParameterGroupName *string + // An optional parameter that specifies the starting point to return a set of + // response records. When the results of a DescribeClusterParameterGroups () + // request exceed the value specified in MaxRecords, AWS returns a value in the + // Marker field of the response. You can retrieve the next set of response records + // by providing the returned marker value in the Marker parameter and retrying the + // request. + Marker *string // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is @@ -81,6 +85,10 @@ type DescribeClusterParameterGroupsInput struct { // Constraints: minimum 20, maximum 100. MaxRecords *int32 + // The name of a specific parameter group for which to return details. By default, + // details about all parameter groups and the default parameter group are returned. + ParameterGroupName *string + // A tag key or keys for which you want to return all matching cluster parameter // groups that are associated with the specified key or keys. For example, suppose // that you have parameter groups that are tagged with keys called owner and @@ -89,14 +97,6 @@ type DescribeClusterParameterGroupsInput struct { // of these tag keys associated with them. TagKeys []*string - // An optional parameter that specifies the starting point to return a set of - // response records. When the results of a DescribeClusterParameterGroups () - // request exceed the value specified in MaxRecords, AWS returns a value in the - // Marker field of the response. You can retrieve the next set of response records - // by providing the returned marker value in the Marker parameter and retrying the - // request. - Marker *string - // A tag value or values for which you want to return all matching cluster // parameter groups that are associated with the specified tag value or values. For // example, suppose that you have parameter groups that are tagged with values @@ -109,10 +109,6 @@ type DescribeClusterParameterGroupsInput struct { // Contains the output from the DescribeClusterParameterGroups () action. type DescribeClusterParameterGroupsOutput struct { - // A list of ClusterParameterGroup () instances. Each instance describes one - // cluster parameter group. - ParameterGroups []*types.ClusterParameterGroup - // A value that indicates the starting point for the next set of response records // in a subsequent request. If a value is returned in a response, you can retrieve // the next set of records by providing this returned marker value in the Marker @@ -120,6 +116,10 @@ type DescribeClusterParameterGroupsOutput struct { // records have been retrieved for the request. Marker *string + // A list of ClusterParameterGroup () instances. Each instance describes one + // cluster parameter group. + ParameterGroups []*types.ClusterParameterGroup + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_DescribeClusterParameters.go b/service/redshift/api_op_DescribeClusterParameters.go index 83fb2aeab81..6fdcebe67ba 100644 --- a/service/redshift/api_op_DescribeClusterParameters.go +++ b/service/redshift/api_op_DescribeClusterParameters.go @@ -67,24 +67,11 @@ func (c *Client) DescribeClusterParameters(ctx context.Context, params *Describe // type DescribeClusterParametersInput struct { - // The parameter types to return. Specify user to show parameters that are - // different form the default. Similarly, specify engine-default to show parameters - // that are the same as the default parameter group. Default: All parameter types - // returned. Valid Values: user | engine-default - Source *string - // The name of a cluster parameter group for which to return details. // // This member is required. ParameterGroupName *string - // The maximum number of response records to return in each call. If the number of - // remaining response records exceeds the specified MaxRecords value, a value is - // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 - // Constraints: minimum 20, maximum 100. - MaxRecords *int32 - // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeClusterParameters () request // exceed the value specified in MaxRecords, AWS returns a value in the Marker @@ -92,6 +79,19 @@ type DescribeClusterParametersInput struct { // providing the returned marker value in the Marker parameter and retrying the // request. Marker *string + + // The maximum number of response records to return in each call. If the number of + // remaining response records exceeds the specified MaxRecords value, a value is + // returned in a marker field of the response. You can retrieve the next set of + // records by retrying the command with the returned marker value. Default: 100 + // Constraints: minimum 20, maximum 100. + MaxRecords *int32 + + // The parameter types to return. Specify user to show parameters that are + // different form the default. Similarly, specify engine-default to show parameters + // that are the same as the default parameter group. Default: All parameter types + // returned. Valid Values: user | engine-default + Source *string } // Contains the output from the DescribeClusterParameters () action. diff --git a/service/redshift/api_op_DescribeClusterSecurityGroups.go b/service/redshift/api_op_DescribeClusterSecurityGroups.go index 7e4c390abe0..0568ef7cdfd 100644 --- a/service/redshift/api_op_DescribeClusterSecurityGroups.go +++ b/service/redshift/api_op_DescribeClusterSecurityGroups.go @@ -68,13 +68,10 @@ func (c *Client) DescribeClusterSecurityGroups(ctx context.Context, params *Desc // type DescribeClusterSecurityGroupsInput struct { - // A tag value or values for which you want to return all matching cluster security - // groups that are associated with the specified tag value or values. For example, - // suppose that you have security groups that are tagged with values called admin - // and test. If you specify both of these tag values in the request, Amazon - // Redshift returns a response with the security groups that have either or both of - // these tag values associated with them. - TagValues []*string + // The name of a cluster security group for which you are requesting details. You + // can specify either the Marker parameter or a ClusterSecurityGroupName parameter, + // but not both. Example: securitygroup1 + ClusterSecurityGroupName *string // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeClusterSecurityGroups () request @@ -85,6 +82,13 @@ type DescribeClusterSecurityGroupsInput struct { // parameter or the Marker parameter, but not both. Marker *string + // The maximum number of response records to return in each call. If the number of + // remaining response records exceeds the specified MaxRecords value, a value is + // returned in a marker field of the response. You can retrieve the next set of + // records by retrying the command with the returned marker value. Default: 100 + // Constraints: minimum 20, maximum 100. + MaxRecords *int32 + // A tag key or keys for which you want to return all matching cluster security // groups that are associated with the specified key or keys. For example, suppose // that you have security groups that are tagged with keys called owner and @@ -93,22 +97,21 @@ type DescribeClusterSecurityGroupsInput struct { // these tag keys associated with them. TagKeys []*string - // The maximum number of response records to return in each call. If the number of - // remaining response records exceeds the specified MaxRecords value, a value is - // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 - // Constraints: minimum 20, maximum 100. - MaxRecords *int32 - - // The name of a cluster security group for which you are requesting details. You - // can specify either the Marker parameter or a ClusterSecurityGroupName parameter, - // but not both. Example: securitygroup1 - ClusterSecurityGroupName *string + // A tag value or values for which you want to return all matching cluster security + // groups that are associated with the specified tag value or values. For example, + // suppose that you have security groups that are tagged with values called admin + // and test. If you specify both of these tag values in the request, Amazon + // Redshift returns a response with the security groups that have either or both of + // these tag values associated with them. + TagValues []*string } // type DescribeClusterSecurityGroupsOutput struct { + // A list of ClusterSecurityGroup () instances. + ClusterSecurityGroups []*types.ClusterSecurityGroup + // A value that indicates the starting point for the next set of response records // in a subsequent request. If a value is returned in a response, you can retrieve // the next set of records by providing this returned marker value in the Marker @@ -116,9 +119,6 @@ type DescribeClusterSecurityGroupsOutput struct { // records have been retrieved for the request. Marker *string - // A list of ClusterSecurityGroup () instances. - ClusterSecurityGroups []*types.ClusterSecurityGroup - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_DescribeClusterSnapshots.go b/service/redshift/api_op_DescribeClusterSnapshots.go index e126d69948b..5496c84397f 100644 --- a/service/redshift/api_op_DescribeClusterSnapshots.go +++ b/service/redshift/api_op_DescribeClusterSnapshots.go @@ -70,46 +70,6 @@ func (c *Client) DescribeClusterSnapshots(ctx context.Context, params *DescribeC // type DescribeClusterSnapshotsInput struct { - // The identifier of the cluster which generated the requested snapshots. - ClusterIdentifier *string - - // The snapshot identifier of the snapshot about which to return information. - SnapshotIdentifier *string - - // The type of snapshots for which you are requesting information. By default, - // snapshots of all types are returned. Valid Values: automated | manual - SnapshotType *string - - // A value that requests only snapshots created at or after the specified time. The - // time value is specified in ISO 8601 format. For more information about ISO 8601, - // go to the ISO8601 Wikipedia page. (http://en.wikipedia.org/wiki/ISO_8601) - // Example: 2012-07-16T18:00:00Z - StartTime *time.Time - - // A time value that requests only snapshots created at or before the specified - // time. The time value is specified in ISO 8601 format. For more information about - // ISO 8601, go to the ISO8601 Wikipedia page. - // (http://en.wikipedia.org/wiki/ISO_8601) Example: 2012-07-16T18:00:00Z - EndTime *time.Time - - // A tag key or keys for which you want to return all matching cluster snapshots - // that are associated with the specified key or keys. For example, suppose that - // you have snapshots that are tagged with keys called owner and environment. If - // you specify both of these tag keys in the request, Amazon Redshift returns a - // response with the snapshots that have either or both of these tag keys - // associated with them. - TagKeys []*string - - // - SortingEntities []*types.SnapshotSortingEntity - - // The maximum number of response records to return in each call. If the number of - // remaining response records exceeds the specified MaxRecords value, a value is - // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 - // Constraints: minimum 20, maximum 100. - MaxRecords *int32 - // A value that indicates whether to return snapshots only for an existing cluster. // You can perform table-level restore only by using a snapshot of an existing // cluster, that is, a cluster that has not been deleted. Values for this parameter @@ -130,11 +90,14 @@ type DescribeClusterSnapshotsInput struct { // specified for an existing cluster, no snapshots are returned. ClusterExists *bool - // The AWS customer account used to create or copy the snapshot. Use this field to - // filter the results to snapshots owned by a particular account. To describe - // snapshots you own, either specify your AWS customer account, or do not specify - // the parameter. - OwnerAccount *string + // The identifier of the cluster which generated the requested snapshots. + ClusterIdentifier *string + + // A time value that requests only snapshots created at or before the specified + // time. The time value is specified in ISO 8601 format. For more information about + // ISO 8601, go to the ISO8601 Wikipedia page. + // (http://en.wikipedia.org/wiki/ISO_8601) Example: 2012-07-16T18:00:00Z + EndTime *time.Time // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeClusterSnapshots () request @@ -144,6 +107,43 @@ type DescribeClusterSnapshotsInput struct { // request. Marker *string + // The maximum number of response records to return in each call. If the number of + // remaining response records exceeds the specified MaxRecords value, a value is + // returned in a marker field of the response. You can retrieve the next set of + // records by retrying the command with the returned marker value. Default: 100 + // Constraints: minimum 20, maximum 100. + MaxRecords *int32 + + // The AWS customer account used to create or copy the snapshot. Use this field to + // filter the results to snapshots owned by a particular account. To describe + // snapshots you own, either specify your AWS customer account, or do not specify + // the parameter. + OwnerAccount *string + + // The snapshot identifier of the snapshot about which to return information. + SnapshotIdentifier *string + + // The type of snapshots for which you are requesting information. By default, + // snapshots of all types are returned. Valid Values: automated | manual + SnapshotType *string + + // + SortingEntities []*types.SnapshotSortingEntity + + // A value that requests only snapshots created at or after the specified time. The + // time value is specified in ISO 8601 format. For more information about ISO 8601, + // go to the ISO8601 Wikipedia page. (http://en.wikipedia.org/wiki/ISO_8601) + // Example: 2012-07-16T18:00:00Z + StartTime *time.Time + + // A tag key or keys for which you want to return all matching cluster snapshots + // that are associated with the specified key or keys. For example, suppose that + // you have snapshots that are tagged with keys called owner and environment. If + // you specify both of these tag keys in the request, Amazon Redshift returns a + // response with the snapshots that have either or both of these tag keys + // associated with them. + TagKeys []*string + // A tag value or values for which you want to return all matching cluster // snapshots that are associated with the specified tag value or values. For // example, suppose that you have snapshots that are tagged with values called diff --git a/service/redshift/api_op_DescribeClusterSubnetGroups.go b/service/redshift/api_op_DescribeClusterSubnetGroups.go index 3a720e724dc..27bb8f31d57 100644 --- a/service/redshift/api_op_DescribeClusterSubnetGroups.go +++ b/service/redshift/api_op_DescribeClusterSubnetGroups.go @@ -66,13 +66,16 @@ func (c *Client) DescribeClusterSubnetGroups(ctx context.Context, params *Descri // type DescribeClusterSubnetGroupsInput struct { - // A tag value or values for which you want to return all matching cluster subnet - // groups that are associated with the specified tag value or values. For example, - // suppose that you have subnet groups that are tagged with values called admin and - // test. If you specify both of these tag values in the request, Amazon Redshift - // returns a response with the subnet groups that have either or both of these tag - // values associated with them. - TagValues []*string + // The name of the cluster subnet group for which information is requested. + ClusterSubnetGroupName *string + + // An optional parameter that specifies the starting point to return a set of + // response records. When the results of a DescribeClusterSubnetGroups () request + // exceed the value specified in MaxRecords, AWS returns a value in the Marker + // field of the response. You can retrieve the next set of response records by + // providing the returned marker value in the Marker parameter and retrying the + // request. + Marker *string // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is @@ -89,21 +92,21 @@ type DescribeClusterSubnetGroupsInput struct { // these tag keys associated with them. TagKeys []*string - // An optional parameter that specifies the starting point to return a set of - // response records. When the results of a DescribeClusterSubnetGroups () request - // exceed the value specified in MaxRecords, AWS returns a value in the Marker - // field of the response. You can retrieve the next set of response records by - // providing the returned marker value in the Marker parameter and retrying the - // request. - Marker *string - - // The name of the cluster subnet group for which information is requested. - ClusterSubnetGroupName *string + // A tag value or values for which you want to return all matching cluster subnet + // groups that are associated with the specified tag value or values. For example, + // suppose that you have subnet groups that are tagged with values called admin and + // test. If you specify both of these tag values in the request, Amazon Redshift + // returns a response with the subnet groups that have either or both of these tag + // values associated with them. + TagValues []*string } // Contains the output from the DescribeClusterSubnetGroups () action. type DescribeClusterSubnetGroupsOutput struct { + // A list of ClusterSubnetGroup () instances. + ClusterSubnetGroups []*types.ClusterSubnetGroup + // A value that indicates the starting point for the next set of response records // in a subsequent request. If a value is returned in a response, you can retrieve // the next set of records by providing this returned marker value in the Marker @@ -111,9 +114,6 @@ type DescribeClusterSubnetGroupsOutput struct { // records have been retrieved for the request. Marker *string - // A list of ClusterSubnetGroup () instances. - ClusterSubnetGroups []*types.ClusterSubnetGroup - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_DescribeClusterTracks.go b/service/redshift/api_op_DescribeClusterTracks.go index 87b32bc8e96..7ccf9202f91 100644 --- a/service/redshift/api_op_DescribeClusterTracks.go +++ b/service/redshift/api_op_DescribeClusterTracks.go @@ -56,9 +56,6 @@ func (c *Client) DescribeClusterTracks(ctx context.Context, params *DescribeClus type DescribeClusterTracksInput struct { - // An integer value for the maximum number of maintenance tracks to return. - MaxRecords *int32 - // The name of the maintenance track. MaintenanceTrackName *string @@ -69,18 +66,21 @@ type DescribeClusterTracksInput struct { // providing the returned marker value in the Marker parameter and retrying the // request. Marker *string + + // An integer value for the maximum number of maintenance tracks to return. + MaxRecords *int32 } type DescribeClusterTracksOutput struct { + // A list of maintenance tracks output by the DescribeClusterTracks operation. + MaintenanceTracks []*types.MaintenanceTrack + // The starting point to return a set of response tracklist records. You can // retrieve the next set of response records by providing the returned marker value // in the Marker parameter and retrying the request. Marker *string - // A list of maintenance tracks output by the DescribeClusterTracks operation. - MaintenanceTracks []*types.MaintenanceTrack - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_DescribeClusterVersions.go b/service/redshift/api_op_DescribeClusterVersions.go index 0d447a235af..8f05270f0ad 100644 --- a/service/redshift/api_op_DescribeClusterVersions.go +++ b/service/redshift/api_op_DescribeClusterVersions.go @@ -74,12 +74,8 @@ type DescribeClusterVersionsInput struct { // consecutive hyphens ClusterParameterGroupFamily *string - // The maximum number of response records to return in each call. If the number of - // remaining response records exceeds the specified MaxRecords value, a value is - // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 - // Constraints: minimum 20, maximum 100. - MaxRecords *int32 + // The specific cluster version to return. Example: 1.0 + ClusterVersion *string // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeClusterVersions () request @@ -89,8 +85,12 @@ type DescribeClusterVersionsInput struct { // request. Marker *string - // The specific cluster version to return. Example: 1.0 - ClusterVersion *string + // The maximum number of response records to return in each call. If the number of + // remaining response records exceeds the specified MaxRecords value, a value is + // returned in a marker field of the response. You can retrieve the next set of + // records by retrying the command with the returned marker value. Default: 100 + // Constraints: minimum 20, maximum 100. + MaxRecords *int32 } // Contains the output from the DescribeClusterVersions () action. diff --git a/service/redshift/api_op_DescribeClusters.go b/service/redshift/api_op_DescribeClusters.go index ae97f6a68b4..f90da1aa460 100644 --- a/service/redshift/api_op_DescribeClusters.go +++ b/service/redshift/api_op_DescribeClusters.go @@ -68,20 +68,6 @@ func (c *Client) DescribeClusters(ctx context.Context, params *DescribeClustersI // type DescribeClustersInput struct { - // A tag key or keys for which you want to return all matching clusters that are - // associated with the specified key or keys. For example, suppose that you have - // clusters that are tagged with keys called owner and environment. If you specify - // both of these tag keys in the request, Amazon Redshift returns a response with - // the clusters that have either or both of these tag keys associated with them. - TagKeys []*string - - // The maximum number of response records to return in each call. If the number of - // remaining response records exceeds the specified MaxRecords value, a value is - // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 - // Constraints: minimum 20, maximum 100. - MaxRecords *int32 - // The unique identifier of a cluster whose properties you are requesting. This // parameter is case sensitive. The default is that all clusters defined for an // account are returned. @@ -96,6 +82,20 @@ type DescribeClustersInput struct { // Marker parameter, but not both. Marker *string + // The maximum number of response records to return in each call. If the number of + // remaining response records exceeds the specified MaxRecords value, a value is + // returned in a marker field of the response. You can retrieve the next set of + // records by retrying the command with the returned marker value. Default: 100 + // Constraints: minimum 20, maximum 100. + MaxRecords *int32 + + // A tag key or keys for which you want to return all matching clusters that are + // associated with the specified key or keys. For example, suppose that you have + // clusters that are tagged with keys called owner and environment. If you specify + // both of these tag keys in the request, Amazon Redshift returns a response with + // the clusters that have either or both of these tag keys associated with them. + TagKeys []*string + // A tag value or values for which you want to return all matching clusters that // are associated with the specified tag value or values. For example, suppose that // you have clusters that are tagged with values called admin and test. If you @@ -108,6 +108,9 @@ type DescribeClustersInput struct { // Contains the output from the DescribeClusters () action. type DescribeClustersOutput struct { + // A list of Cluster objects, where each object describes one cluster. + Clusters []*types.Cluster + // A value that indicates the starting point for the next set of response records // in a subsequent request. If a value is returned in a response, you can retrieve // the next set of records by providing this returned marker value in the Marker @@ -115,9 +118,6 @@ type DescribeClustersOutput struct { // records have been retrieved for the request. Marker *string - // A list of Cluster objects, where each object describes one cluster. - Clusters []*types.Cluster - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_DescribeEventSubscriptions.go b/service/redshift/api_op_DescribeEventSubscriptions.go index 6c69e9cba66..b071b58cb2a 100644 --- a/service/redshift/api_op_DescribeEventSubscriptions.go +++ b/service/redshift/api_op_DescribeEventSubscriptions.go @@ -66,14 +66,6 @@ func (c *Client) DescribeEventSubscriptions(ctx context.Context, params *Describ // type DescribeEventSubscriptionsInput struct { - // A tag value or values for which you want to return all matching event - // notification subscriptions that are associated with the specified tag value or - // values. For example, suppose that you have subscriptions that are tagged with - // values called admin and test. If you specify both of these tag values in the - // request, Amazon Redshift returns a response with the subscriptions that have - // either or both of these tag values associated with them. - TagValues []*string - // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeEventSubscriptions request // exceed the value specified in MaxRecords, AWS returns a value in the Marker @@ -89,6 +81,9 @@ type DescribeEventSubscriptionsInput struct { // Constraints: minimum 20, maximum 100. MaxRecords *int32 + // The name of the Amazon Redshift event notification subscription to be described. + SubscriptionName *string + // A tag key or keys for which you want to return all matching event notification // subscriptions that are associated with the specified key or keys. For example, // suppose that you have subscriptions that are tagged with keys called owner and @@ -97,13 +92,21 @@ type DescribeEventSubscriptionsInput struct { // these tag keys associated with them. TagKeys []*string - // The name of the Amazon Redshift event notification subscription to be described. - SubscriptionName *string + // A tag value or values for which you want to return all matching event + // notification subscriptions that are associated with the specified tag value or + // values. For example, suppose that you have subscriptions that are tagged with + // values called admin and test. If you specify both of these tag values in the + // request, Amazon Redshift returns a response with the subscriptions that have + // either or both of these tag values associated with them. + TagValues []*string } // type DescribeEventSubscriptionsOutput struct { + // A list of event subscriptions. + EventSubscriptionsList []*types.EventSubscription + // A value that indicates the starting point for the next set of response records // in a subsequent request. If a value is returned in a response, you can retrieve // the next set of records by providing this returned marker value in the Marker @@ -111,9 +114,6 @@ type DescribeEventSubscriptionsOutput struct { // records have been retrieved for the request. Marker *string - // A list of event subscriptions. - EventSubscriptionsList []*types.EventSubscription - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_DescribeEvents.go b/service/redshift/api_op_DescribeEvents.go index 04888a0289c..57700dfd65d 100644 --- a/service/redshift/api_op_DescribeEvents.go +++ b/service/redshift/api_op_DescribeEvents.go @@ -67,6 +67,18 @@ type DescribeEventsInput struct { // Default: 60 Duration *int32 + // The end of the time interval for which to retrieve events, specified in ISO 8601 + // format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. + // (http://en.wikipedia.org/wiki/ISO_8601) Example: 2009-07-08T18:00Z + EndTime *time.Time + + // An optional parameter that specifies the starting point to return a set of + // response records. When the results of a DescribeEvents () request exceed the + // value specified in MaxRecords, AWS returns a value in the Marker field of the + // response. You can retrieve the next set of response records by providing the + // returned marker value in the Marker parameter and retrying the request. + Marker *string + // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of @@ -92,23 +104,6 @@ type DescribeEventsInput struct { // identifier when SourceType is cluster-snapshot. SourceIdentifier *string - // The end of the time interval for which to retrieve events, specified in ISO 8601 - // format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. - // (http://en.wikipedia.org/wiki/ISO_8601) Example: 2009-07-08T18:00Z - EndTime *time.Time - - // An optional parameter that specifies the starting point to return a set of - // response records. When the results of a DescribeEvents () request exceed the - // value specified in MaxRecords, AWS returns a value in the Marker field of the - // response. You can retrieve the next set of response records by providing the - // returned marker value in the Marker parameter and retrying the request. - Marker *string - - // The beginning of the time interval to retrieve events for, specified in ISO 8601 - // format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. - // (http://en.wikipedia.org/wiki/ISO_8601) Example: 2009-07-08T18:00Z - StartTime *time.Time - // The event source to retrieve events for. If no value is specified, all events // are returned. Constraints: If SourceType is supplied, SourceIdentifier must also // be provided. @@ -125,6 +120,11 @@ type DescribeEventsInput struct { // * Specify // cluster-snapshot when SourceIdentifier is a cluster snapshot identifier. SourceType types.SourceType + + // The beginning of the time interval to retrieve events for, specified in ISO 8601 + // format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. + // (http://en.wikipedia.org/wiki/ISO_8601) Example: 2009-07-08T18:00Z + StartTime *time.Time } // diff --git a/service/redshift/api_op_DescribeHsmClientCertificates.go b/service/redshift/api_op_DescribeHsmClientCertificates.go index 73af3128d53..d2a88ab5d6c 100644 --- a/service/redshift/api_op_DescribeHsmClientCertificates.go +++ b/service/redshift/api_op_DescribeHsmClientCertificates.go @@ -71,6 +71,14 @@ type DescribeHsmClientCertificatesInput struct { // client certificates owned by your AWS customer account. HsmClientCertificateIdentifier *string + // An optional parameter that specifies the starting point to return a set of + // response records. When the results of a DescribeHsmClientCertificates () request + // exceed the value specified in MaxRecords, AWS returns a value in the Marker + // field of the response. You can retrieve the next set of response records by + // providing the returned marker value in the Marker parameter and retrying the + // request. + Marker *string + // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of @@ -78,14 +86,6 @@ type DescribeHsmClientCertificatesInput struct { // Constraints: minimum 20, maximum 100. MaxRecords *int32 - // A tag value or values for which you want to return all matching HSM client - // certificates that are associated with the specified tag value or values. For - // example, suppose that you have HSM client certificates that are tagged with - // values called admin and test. If you specify both of these tag values in the - // request, Amazon Redshift returns a response with the HSM client certificates - // that have either or both of these tag values associated with them. - TagValues []*string - // A tag key or keys for which you want to return all matching HSM client // certificates that are associated with the specified key or keys. For example, // suppose that you have HSM client certificates that are tagged with keys called @@ -94,18 +94,22 @@ type DescribeHsmClientCertificatesInput struct { // either or both of these tag keys associated with them. TagKeys []*string - // An optional parameter that specifies the starting point to return a set of - // response records. When the results of a DescribeHsmClientCertificates () request - // exceed the value specified in MaxRecords, AWS returns a value in the Marker - // field of the response. You can retrieve the next set of response records by - // providing the returned marker value in the Marker parameter and retrying the - // request. - Marker *string + // A tag value or values for which you want to return all matching HSM client + // certificates that are associated with the specified tag value or values. For + // example, suppose that you have HSM client certificates that are tagged with + // values called admin and test. If you specify both of these tag values in the + // request, Amazon Redshift returns a response with the HSM client certificates + // that have either or both of these tag values associated with them. + TagValues []*string } // type DescribeHsmClientCertificatesOutput struct { + // A list of the identifiers for one or more HSM client certificates used by Amazon + // Redshift clusters to store and retrieve database encryption keys in an HSM. + HsmClientCertificates []*types.HsmClientCertificate + // A value that indicates the starting point for the next set of response records // in a subsequent request. If a value is returned in a response, you can retrieve // the next set of records by providing this returned marker value in the Marker @@ -113,10 +117,6 @@ type DescribeHsmClientCertificatesOutput struct { // records have been retrieved for the request. Marker *string - // A list of the identifiers for one or more HSM client certificates used by Amazon - // Redshift clusters to store and retrieve database encryption keys in an HSM. - HsmClientCertificates []*types.HsmClientCertificate - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_DescribeHsmConfigurations.go b/service/redshift/api_op_DescribeHsmConfigurations.go index 40d6f5e1924..a6a9e7aeeb5 100644 --- a/service/redshift/api_op_DescribeHsmConfigurations.go +++ b/service/redshift/api_op_DescribeHsmConfigurations.go @@ -65,6 +65,19 @@ func (c *Client) DescribeHsmConfigurations(ctx context.Context, params *Describe // type DescribeHsmConfigurationsInput struct { + // The identifier of a specific Amazon Redshift HSM configuration to be described. + // If no identifier is specified, information is returned for all HSM + // configurations owned by your AWS customer account. + HsmConfigurationIdentifier *string + + // An optional parameter that specifies the starting point to return a set of + // response records. When the results of a DescribeHsmConfigurations () request + // exceed the value specified in MaxRecords, AWS returns a value in the Marker + // field of the response. You can retrieve the next set of response records by + // providing the returned marker value in the Marker parameter and retrying the + // request. + Marker *string + // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of @@ -80,19 +93,6 @@ type DescribeHsmConfigurationsInput struct { // of these tag keys associated with them. TagKeys []*string - // The identifier of a specific Amazon Redshift HSM configuration to be described. - // If no identifier is specified, information is returned for all HSM - // configurations owned by your AWS customer account. - HsmConfigurationIdentifier *string - - // An optional parameter that specifies the starting point to return a set of - // response records. When the results of a DescribeHsmConfigurations () request - // exceed the value specified in MaxRecords, AWS returns a value in the Marker - // field of the response. You can retrieve the next set of response records by - // providing the returned marker value in the Marker parameter and retrying the - // request. - Marker *string - // A tag value or values for which you want to return all matching HSM // configurations that are associated with the specified tag value or values. For // example, suppose that you have HSM configurations that are tagged with values diff --git a/service/redshift/api_op_DescribeLoggingStatus.go b/service/redshift/api_op_DescribeLoggingStatus.go index e5b49cf6f71..c4f448d1e60 100644 --- a/service/redshift/api_op_DescribeLoggingStatus.go +++ b/service/redshift/api_op_DescribeLoggingStatus.go @@ -69,24 +69,24 @@ type DescribeLoggingStatusInput struct { // Describes the status of logging for a cluster. type DescribeLoggingStatusOutput struct { - // The prefix applied to the log file names. - S3KeyPrefix *string + // The name of the S3 bucket where the log files are stored. + BucketName *string // The message indicating that logs failed to be delivered. LastFailureMessage *string - // true if logging is on, false if logging is off. - LoggingEnabled *bool - // The last time when logs failed to be delivered. LastFailureTime *time.Time - // The name of the S3 bucket where the log files are stored. - BucketName *string - // The last time that logs were delivered. LastSuccessfulDeliveryTime *time.Time + // true if logging is on, false if logging is off. + LoggingEnabled *bool + + // The prefix applied to the log file names. + S3KeyPrefix *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_DescribeNodeConfigurationOptions.go b/service/redshift/api_op_DescribeNodeConfigurationOptions.go index f095deab267..2d51e808272 100644 --- a/service/redshift/api_op_DescribeNodeConfigurationOptions.go +++ b/service/redshift/api_op_DescribeNodeConfigurationOptions.go @@ -67,22 +67,12 @@ type DescribeNodeConfigurationOptionsInput struct { // This member is required. ActionType types.ActionType - // The maximum number of response records to return in each call. If the number of - // remaining response records exceeds the specified MaxRecords value, a value is - // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 500 - // Constraints: minimum 100, maximum 500. - MaxRecords *int32 + // The identifier of the cluster to evaluate for possible node configurations. + ClusterIdentifier *string // A set of name, operator, and value items to filter the results. Filters []*types.NodeConfigurationOptionsFilter - // The identifier of the snapshot to evaluate for possible node configurations. - SnapshotIdentifier *string - - // The identifier of the cluster to evaluate for possible node configurations. - ClusterIdentifier *string - // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeNodeConfigurationOptions () // request exceed the value specified in MaxRecords, AWS returns a value in the @@ -91,9 +81,19 @@ type DescribeNodeConfigurationOptionsInput struct { // request. Marker *string + // The maximum number of response records to return in each call. If the number of + // remaining response records exceeds the specified MaxRecords value, a value is + // returned in a marker field of the response. You can retrieve the next set of + // records by retrying the command with the returned marker value. Default: 500 + // Constraints: minimum 100, maximum 500. + MaxRecords *int32 + // The AWS customer account used to create or copy the snapshot. Required if you // are restoring a snapshot you do not own, optional if you own the snapshot. OwnerAccount *string + + // The identifier of the snapshot to evaluate for possible node configurations. + SnapshotIdentifier *string } type DescribeNodeConfigurationOptionsOutput struct { diff --git a/service/redshift/api_op_DescribeOrderableClusterOptions.go b/service/redshift/api_op_DescribeOrderableClusterOptions.go index c6582ec06c7..eb55ebcf4ea 100644 --- a/service/redshift/api_op_DescribeOrderableClusterOptions.go +++ b/service/redshift/api_op_DescribeOrderableClusterOptions.go @@ -65,10 +65,6 @@ func (c *Client) DescribeOrderableClusterOptions(ctx context.Context, params *De // type DescribeOrderableClusterOptionsInput struct { - // The node type filter value. Specify this parameter to show only the available - // offerings matching the specified node type. - NodeType *string - // The version filter value. Specify this parameter to show only the available // offerings matching the specified version. Default: All versions. Constraints: // Must be one of the version returned from DescribeClusterVersions (). @@ -88,15 +84,15 @@ type DescribeOrderableClusterOptionsInput struct { // records by retrying the command with the returned marker value. Default: 100 // Constraints: minimum 20, maximum 100. MaxRecords *int32 + + // The node type filter value. Specify this parameter to show only the available + // offerings matching the specified node type. + NodeType *string } // Contains the output from the DescribeOrderableClusterOptions () action. type DescribeOrderableClusterOptionsOutput struct { - // An OrderableClusterOption structure containing information about orderable - // options for the cluster. - OrderableClusterOptions []*types.OrderableClusterOption - // A value that indicates the starting point for the next set of response records // in a subsequent request. If a value is returned in a response, you can retrieve // the next set of records by providing this returned marker value in the Marker @@ -104,6 +100,10 @@ type DescribeOrderableClusterOptionsOutput struct { // records have been retrieved for the request. Marker *string + // An OrderableClusterOption structure containing information about orderable + // options for the cluster. + OrderableClusterOptions []*types.OrderableClusterOption + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_DescribeReservedNodeOfferings.go b/service/redshift/api_op_DescribeReservedNodeOfferings.go index 92b8a01a8e5..f49c283785e 100644 --- a/service/redshift/api_op_DescribeReservedNodeOfferings.go +++ b/service/redshift/api_op_DescribeReservedNodeOfferings.go @@ -66,6 +66,14 @@ func (c *Client) DescribeReservedNodeOfferings(ctx context.Context, params *Desc // type DescribeReservedNodeOfferingsInput struct { + // An optional parameter that specifies the starting point to return a set of + // response records. When the results of a DescribeReservedNodeOfferings () request + // exceed the value specified in MaxRecords, AWS returns a value in the Marker + // field of the response. You can retrieve the next set of response records by + // providing the returned marker value in the Marker parameter and retrying the + // request. + Marker *string + // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of @@ -75,22 +83,11 @@ type DescribeReservedNodeOfferingsInput struct { // The unique identifier for the offering. ReservedNodeOfferingId *string - - // An optional parameter that specifies the starting point to return a set of - // response records. When the results of a DescribeReservedNodeOfferings () request - // exceed the value specified in MaxRecords, AWS returns a value in the Marker - // field of the response. You can retrieve the next set of response records by - // providing the returned marker value in the Marker parameter and retrying the - // request. - Marker *string } // type DescribeReservedNodeOfferingsOutput struct { - // A list of ReservedNodeOffering objects. - ReservedNodeOfferings []*types.ReservedNodeOffering - // A value that indicates the starting point for the next set of response records // in a subsequent request. If a value is returned in a response, you can retrieve // the next set of records by providing this returned marker value in the Marker @@ -98,6 +95,9 @@ type DescribeReservedNodeOfferingsOutput struct { // records have been retrieved for the request. Marker *string + // A list of ReservedNodeOffering objects. + ReservedNodeOfferings []*types.ReservedNodeOffering + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_DescribeReservedNodes.go b/service/redshift/api_op_DescribeReservedNodes.go index e8a7895d80e..d1e200a1126 100644 --- a/service/redshift/api_op_DescribeReservedNodes.go +++ b/service/redshift/api_op_DescribeReservedNodes.go @@ -57,9 +57,6 @@ func (c *Client) DescribeReservedNodes(ctx context.Context, params *DescribeRese // type DescribeReservedNodesInput struct { - // Identifier for the node reservation. - ReservedNodeId *string - // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeReservedNodes () request exceed // the value specified in MaxRecords, AWS returns a value in the Marker field of @@ -73,14 +70,14 @@ type DescribeReservedNodesInput struct { // records by retrying the command with the returned marker value. Default: 100 // Constraints: minimum 20, maximum 100. MaxRecords *int32 + + // Identifier for the node reservation. + ReservedNodeId *string } // type DescribeReservedNodesOutput struct { - // The list of ReservedNode objects. - ReservedNodes []*types.ReservedNode - // A value that indicates the starting point for the next set of response records // in a subsequent request. If a value is returned in a response, you can retrieve // the next set of records by providing this returned marker value in the Marker @@ -88,6 +85,9 @@ type DescribeReservedNodesOutput struct { // records have been retrieved for the request. Marker *string + // The list of ReservedNode objects. + ReservedNodes []*types.ReservedNode + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_DescribeResize.go b/service/redshift/api_op_DescribeResize.go index 7a70ada1bb1..891da73a92d 100644 --- a/service/redshift/api_op_DescribeResize.go +++ b/service/redshift/api_op_DescribeResize.go @@ -73,59 +73,39 @@ type DescribeResizeInput struct { // Describes the result of a cluster resize operation. type DescribeResizeOutput struct { - // An enum with possible values of ClassicResize and ElasticResize. These values - // describe the type of resize operation being performed. - ResizeType *string - - // The number of nodes that the cluster will have after the resize operation is - // complete. - TargetNumberOfNodes *int32 - // The average rate of the resize operation over the last few minutes, measured in // megabytes per second. After the resize operation completes, this value shows the // average rate of the entire resize operation. AvgResizeRateInMegaBytesPerSecond *float64 - // The estimated time remaining, in seconds, until the resize operation is - // complete. This value is calculated based on the average resize rate and the - // estimated amount of data remaining to be processed. Once the resize operation is - // complete, this value will be 0. - EstimatedTimeToCompletionInSeconds *int64 - - // The names of tables that have not been yet imported. Valid Values: List of table - // names - ImportTablesNotStarted []*string + // The percent of data transferred from source cluster to target cluster. + DataTransferProgressPercent *float64 // The amount of seconds that have elapsed since the resize operation began. After // the resize operation completes, this value shows the total actual time, in // seconds, for the resize operation. ElapsedTimeInSeconds *int64 - // The cluster type after the resize operation is complete. Valid Values: - // multi-node | single-node - TargetClusterType *string - - // The percent of data transferred from source cluster to target cluster. - DataTransferProgressPercent *float64 - - // The node type that the cluster will have after the resize operation is complete. - TargetNodeType *string + // The estimated time remaining, in seconds, until the resize operation is + // complete. This value is calculated based on the average resize rate and the + // estimated amount of data remaining to be processed. Once the resize operation is + // complete, this value will be 0. + EstimatedTimeToCompletionInSeconds *int64 // The names of tables that have been completely imported . Valid Values: List of // table names. ImportTablesCompleted []*string - // An optional string to provide additional details about the resize action. - Message *string + // The names of tables that are being currently imported. Valid Values: List of + // table names. + ImportTablesInProgress []*string - // The estimated total amount of data, in megabytes, on the cluster before the - // resize operation began. - TotalResizeDataInMegaBytes *int64 + // The names of tables that have not been yet imported. Valid Values: List of table + // names + ImportTablesNotStarted []*string - // The type of encryption for the cluster after the resize is complete. Possible - // values are KMS and None. In the China region possible values are: Legacy and - // None. - TargetEncryptionType *string + // An optional string to provide additional details about the resize action. + Message *string // While the resize operation is in progress, this value shows the current amount // of data, in megabytes, that has been processed so far. When the resize operation @@ -134,14 +114,34 @@ type DescribeResizeOutput struct { // estimated total amount of data before resize). ProgressInMegaBytes *int64 - // The names of tables that are being currently imported. Valid Values: List of - // table names. - ImportTablesInProgress []*string + // An enum with possible values of ClassicResize and ElasticResize. These values + // describe the type of resize operation being performed. + ResizeType *string // The status of the resize operation. Valid Values: NONE | IN_PROGRESS | FAILED | // SUCCEEDED | CANCELLING Status *string + // The cluster type after the resize operation is complete. Valid Values: + // multi-node | single-node + TargetClusterType *string + + // The type of encryption for the cluster after the resize is complete. Possible + // values are KMS and None. In the China region possible values are: Legacy and + // None. + TargetEncryptionType *string + + // The node type that the cluster will have after the resize operation is complete. + TargetNodeType *string + + // The number of nodes that the cluster will have after the resize operation is + // complete. + TargetNumberOfNodes *int32 + + // The estimated total amount of data, in megabytes, on the cluster before the + // resize operation began. + TotalResizeDataInMegaBytes *int64 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_DescribeScheduledActions.go b/service/redshift/api_op_DescribeScheduledActions.go index 5113ad9d9d5..c3df24f85ad 100644 --- a/service/redshift/api_op_DescribeScheduledActions.go +++ b/service/redshift/api_op_DescribeScheduledActions.go @@ -58,16 +58,16 @@ func (c *Client) DescribeScheduledActions(ctx context.Context, params *DescribeS type DescribeScheduledActionsInput struct { - // The start time in UTC of the scheduled actions to retrieve. Only active - // scheduled actions that have invocations after this time are retrieved. - StartTime *time.Time - // If true, retrieve only active scheduled actions. If false, retrieve only // disabled scheduled actions. Active *bool - // The name of the scheduled action to retrieve. - ScheduledActionName *string + // The end time in UTC of the scheduled action to retrieve. Only active scheduled + // actions that have invocations before this time are retrieved. + EndTime *time.Time + + // List of scheduled action filters. + Filters []*types.ScheduledActionFilter // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeScheduledActions () request @@ -84,22 +84,19 @@ type DescribeScheduledActionsInput struct { // Constraints: minimum 20, maximum 100. MaxRecords *int32 - // The end time in UTC of the scheduled action to retrieve. Only active scheduled - // actions that have invocations before this time are retrieved. - EndTime *time.Time + // The name of the scheduled action to retrieve. + ScheduledActionName *string + + // The start time in UTC of the scheduled actions to retrieve. Only active + // scheduled actions that have invocations after this time are retrieved. + StartTime *time.Time // The type of the scheduled actions to retrieve. TargetActionType types.ScheduledActionTypeValues - - // List of scheduled action filters. - Filters []*types.ScheduledActionFilter } type DescribeScheduledActionsOutput struct { - // List of retrieved scheduled actions. - ScheduledActions []*types.ScheduledAction - // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeScheduledActions () request // exceed the value specified in MaxRecords, AWS returns a value in the Marker @@ -108,6 +105,9 @@ type DescribeScheduledActionsOutput struct { // request. Marker *string + // List of retrieved scheduled actions. + ScheduledActions []*types.ScheduledAction + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_DescribeSnapshotCopyGrants.go b/service/redshift/api_op_DescribeSnapshotCopyGrants.go index 2ba3bcafa33..e960be05705 100644 --- a/service/redshift/api_op_DescribeSnapshotCopyGrants.go +++ b/service/redshift/api_op_DescribeSnapshotCopyGrants.go @@ -61,6 +61,15 @@ func (c *Client) DescribeSnapshotCopyGrants(ctx context.Context, params *Describ // The result of the DescribeSnapshotCopyGrants action. type DescribeSnapshotCopyGrantsInput struct { + // An optional parameter that specifies the starting point to return a set of + // response records. When the results of a DescribeSnapshotCopyGrant request exceed + // the value specified in MaxRecords, AWS returns a value in the Marker field of + // the response. You can retrieve the next set of response records by providing the + // returned marker value in the Marker parameter and retrying the request. + // Constraints: You can specify either the SnapshotCopyGrantName parameter or the + // Marker parameter, but not both. + Marker *string + // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of @@ -68,12 +77,8 @@ type DescribeSnapshotCopyGrantsInput struct { // Constraints: minimum 20, maximum 100. MaxRecords *int32 - // A tag value or values for which you want to return all matching resources that - // are associated with the specified value or values. For example, suppose that you - // have resources tagged with values called admin and test. If you specify both of - // these tag values in the request, Amazon Redshift returns a response with all - // resources that have either or both of these tag values associated with them. - TagValues []*string + // The name of the snapshot copy grant. + SnapshotCopyGrantName *string // A tag key or keys for which you want to return all matching resources that are // associated with the specified key or keys. For example, suppose that you have @@ -82,17 +87,12 @@ type DescribeSnapshotCopyGrantsInput struct { // resources that have either or both of these tag keys associated with them. TagKeys []*string - // An optional parameter that specifies the starting point to return a set of - // response records. When the results of a DescribeSnapshotCopyGrant request exceed - // the value specified in MaxRecords, AWS returns a value in the Marker field of - // the response. You can retrieve the next set of response records by providing the - // returned marker value in the Marker parameter and retrying the request. - // Constraints: You can specify either the SnapshotCopyGrantName parameter or the - // Marker parameter, but not both. - Marker *string - - // The name of the snapshot copy grant. - SnapshotCopyGrantName *string + // A tag value or values for which you want to return all matching resources that + // are associated with the specified value or values. For example, suppose that you + // have resources tagged with values called admin and test. If you specify both of + // these tag values in the request, Amazon Redshift returns a response with all + // resources that have either or both of these tag values associated with them. + TagValues []*string } // diff --git a/service/redshift/api_op_DescribeSnapshotSchedules.go b/service/redshift/api_op_DescribeSnapshotSchedules.go index 2b35f47bef3..75d182bf488 100644 --- a/service/redshift/api_op_DescribeSnapshotSchedules.go +++ b/service/redshift/api_op_DescribeSnapshotSchedules.go @@ -56,11 +56,15 @@ func (c *Client) DescribeSnapshotSchedules(ctx context.Context, params *Describe type DescribeSnapshotSchedulesInput struct { - // A unique identifier for a snapshot schedule. - ScheduleIdentifier *string + // The unique identifier for the cluster whose snapshot schedules you want to view. + ClusterIdentifier *string - // The key value for a snapshot schedule tag. - TagKeys []*string + // A value that indicates the starting point for the next set of response records + // in a subsequent request. If a value is returned in a response, you can retrieve + // the next set of records by providing this returned marker value in the marker + // parameter and retrying the command. If the marker field is empty, all response + // records have been retrieved for the request. + Marker *string // The maximum number or response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is @@ -68,25 +72,18 @@ type DescribeSnapshotSchedulesInput struct { // records by retrying the command with the returned marker value. MaxRecords *int32 - // The unique identifier for the cluster whose snapshot schedules you want to view. - ClusterIdentifier *string + // A unique identifier for a snapshot schedule. + ScheduleIdentifier *string + + // The key value for a snapshot schedule tag. + TagKeys []*string // The value corresponding to the key of the snapshot schedule tag. TagValues []*string - - // A value that indicates the starting point for the next set of response records - // in a subsequent request. If a value is returned in a response, you can retrieve - // the next set of records by providing this returned marker value in the marker - // parameter and retrying the command. If the marker field is empty, all response - // records have been retrieved for the request. - Marker *string } type DescribeSnapshotSchedulesOutput struct { - // A list of SnapshotSchedules. - SnapshotSchedules []*types.SnapshotSchedule - // A value that indicates the starting point for the next set of response records // in a subsequent request. If a value is returned in a response, you can retrieve // the next set of records by providing this returned marker value in the marker @@ -94,6 +91,9 @@ type DescribeSnapshotSchedulesOutput struct { // records have been retrieved for the request. Marker *string + // A list of SnapshotSchedules. + SnapshotSchedules []*types.SnapshotSchedule + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_DescribeStorage.go b/service/redshift/api_op_DescribeStorage.go index 9b8ad83a8d8..b3f68ed0221 100644 --- a/service/redshift/api_op_DescribeStorage.go +++ b/service/redshift/api_op_DescribeStorage.go @@ -58,12 +58,12 @@ type DescribeStorageInput struct { type DescribeStorageOutput struct { - // The total amount of storage currently provisioned. - TotalProvisionedStorageInMegaBytes *float64 - // The total amount of storage currently used for snapshots. TotalBackupSizeInMegaBytes *float64 + // The total amount of storage currently provisioned. + TotalProvisionedStorageInMegaBytes *float64 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_DescribeTableRestoreStatus.go b/service/redshift/api_op_DescribeTableRestoreStatus.go index d52502d9c98..8c5c2599cc9 100644 --- a/service/redshift/api_op_DescribeTableRestoreStatus.go +++ b/service/redshift/api_op_DescribeTableRestoreStatus.go @@ -62,35 +62,35 @@ func (c *Client) DescribeTableRestoreStatus(ctx context.Context, params *Describ // type DescribeTableRestoreStatusInput struct { + // The Amazon Redshift cluster that the table is being restored to. + ClusterIdentifier *string + // An optional pagination token provided by a previous DescribeTableRestoreStatus // request. If this parameter is specified, the response includes only records // beyond the marker, up to the value specified by the MaxRecords parameter. Marker *string - // The identifier of the table restore request to return status for. If you don't - // specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns - // the status of all in-progress table restore requests. - TableRestoreRequestId *string - - // The Amazon Redshift cluster that the table is being restored to. - ClusterIdentifier *string - // The maximum number of records to include in the response. If more records exist // than the specified MaxRecords value, a pagination token called a marker is // included in the response so that the remaining results can be retrieved. MaxRecords *int32 + + // The identifier of the table restore request to return status for. If you don't + // specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns + // the status of all in-progress table restore requests. + TableRestoreRequestId *string } // type DescribeTableRestoreStatusOutput struct { - // A list of status details for one or more table restore requests. - TableRestoreStatusDetails []*types.TableRestoreStatus - // A pagination token that can be used in a subsequent DescribeTableRestoreStatus // () request. Marker *string + // A list of status details for one or more table restore requests. + TableRestoreStatusDetails []*types.TableRestoreStatus + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_DescribeTags.go b/service/redshift/api_op_DescribeTags.go index 3522c06ca9a..abc98332c85 100644 --- a/service/redshift/api_op_DescribeTags.go +++ b/service/redshift/api_op_DescribeTags.go @@ -78,17 +78,6 @@ func (c *Client) DescribeTags(ctx context.Context, params *DescribeTagsInput, op // type DescribeTagsInput struct { - // A tag value or values for which you want to return all matching resources that - // are associated with the specified value or values. For example, suppose that you - // have resources tagged with values called admin and test. If you specify both of - // these tag values in the request, Amazon Redshift returns a response with all - // resources that have either or both of these tag values associated with them. - TagValues []*string - - // The Amazon Resource Name (ARN) for which you want to describe the tag or tags. - // For example, arn:aws:redshift:us-east-2:123456789:cluster:t1. - ResourceName *string - // A value that indicates the starting point for the next set of response records // in a subsequent request. If a value is returned in a response, you can retrieve // the next set of records by providing this returned marker value in the marker @@ -96,6 +85,16 @@ type DescribeTagsInput struct { // records have been retrieved for the request. Marker *string + // The maximum number or response records to return in each call. If the number of + // remaining response records exceeds the specified MaxRecords value, a value is + // returned in a marker field of the response. You can retrieve the next set of + // records by retrying the command with the returned marker value. + MaxRecords *int32 + + // The Amazon Resource Name (ARN) for which you want to describe the tag or tags. + // For example, arn:aws:redshift:us-east-2:123456789:cluster:t1. + ResourceName *string + // The type of resource with which you want to view tags. Valid resource types // are: // @@ -128,26 +127,24 @@ type DescribeTagsInput struct { // in the Amazon Redshift Cluster Management Guide. ResourceType *string - // The maximum number or response records to return in each call. If the number of - // remaining response records exceeds the specified MaxRecords value, a value is - // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. - MaxRecords *int32 - // A tag key or keys for which you want to return all matching resources that are // associated with the specified key or keys. For example, suppose that you have // resources tagged with keys called owner and environment. If you specify both of // these tag keys in the request, Amazon Redshift returns a response with all // resources that have either or both of these tag keys associated with them. TagKeys []*string + + // A tag value or values for which you want to return all matching resources that + // are associated with the specified value or values. For example, suppose that you + // have resources tagged with values called admin and test. If you specify both of + // these tag values in the request, Amazon Redshift returns a response with all + // resources that have either or both of these tag values associated with them. + TagValues []*string } // type DescribeTagsOutput struct { - // A list of tags with their associated resources. - TaggedResources []*types.TaggedResource - // A value that indicates the starting point for the next set of response records // in a subsequent request. If a value is returned in a response, you can retrieve // the next set of records by providing this returned marker value in the Marker @@ -155,6 +152,9 @@ type DescribeTagsOutput struct { // records have been retrieved for the request. Marker *string + // A list of tags with their associated resources. + TaggedResources []*types.TaggedResource + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_DescribeUsageLimits.go b/service/redshift/api_op_DescribeUsageLimits.go index d8f1400d15d..dbf91301a96 100644 --- a/service/redshift/api_op_DescribeUsageLimits.go +++ b/service/redshift/api_op_DescribeUsageLimits.go @@ -72,23 +72,12 @@ func (c *Client) DescribeUsageLimits(ctx context.Context, params *DescribeUsageL type DescribeUsageLimitsInput struct { - // A tag key or keys for which you want to return all matching usage limit objects - // that are associated with the specified key or keys. For example, suppose that - // you have parameter groups that are tagged with keys called owner and - // environment. If you specify both of these tag keys in the request, Amazon - // Redshift returns a response with the usage limit objects have either or both of - // these tag keys associated with them. - TagKeys []*string + // The identifier of the cluster for which you want to describe usage limits. + ClusterIdentifier *string // The feature type for which you want to describe usage limits. FeatureType types.UsageLimitFeatureType - // The identifier of the usage limit to describe. - UsageLimitId *string - - // The identifier of the cluster for which you want to describe usage limits. - ClusterIdentifier *string - // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeUsageLimits () request exceed // the value specified in MaxRecords, AWS returns a value in the Marker field of @@ -103,6 +92,14 @@ type DescribeUsageLimitsInput struct { // Constraints: minimum 20, maximum 100. MaxRecords *int32 + // A tag key or keys for which you want to return all matching usage limit objects + // that are associated with the specified key or keys. For example, suppose that + // you have parameter groups that are tagged with keys called owner and + // environment. If you specify both of these tag keys in the request, Amazon + // Redshift returns a response with the usage limit objects have either or both of + // these tag keys associated with them. + TagKeys []*string + // A tag value or values for which you want to return all matching usage limit // objects that are associated with the specified tag value or values. For example, // suppose that you have parameter groups that are tagged with values called admin @@ -110,6 +107,9 @@ type DescribeUsageLimitsInput struct { // Redshift returns a response with the usage limit objects that have either or // both of these tag values associated with them. TagValues []*string + + // The identifier of the usage limit to describe. + UsageLimitId *string } type DescribeUsageLimitsOutput struct { diff --git a/service/redshift/api_op_DisableLogging.go b/service/redshift/api_op_DisableLogging.go index 311740ea9d1..68f18de5294 100644 --- a/service/redshift/api_op_DisableLogging.go +++ b/service/redshift/api_op_DisableLogging.go @@ -69,24 +69,24 @@ type DisableLoggingInput struct { // Describes the status of logging for a cluster. type DisableLoggingOutput struct { - // The prefix applied to the log file names. - S3KeyPrefix *string + // The name of the S3 bucket where the log files are stored. + BucketName *string // The message indicating that logs failed to be delivered. LastFailureMessage *string - // true if logging is on, false if logging is off. - LoggingEnabled *bool - // The last time when logs failed to be delivered. LastFailureTime *time.Time - // The name of the S3 bucket where the log files are stored. - BucketName *string - // The last time that logs were delivered. LastSuccessfulDeliveryTime *time.Time + // true if logging is on, false if logging is off. + LoggingEnabled *bool + + // The prefix applied to the log file names. + S3KeyPrefix *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_EnableLogging.go b/service/redshift/api_op_EnableLogging.go index baf435a06f4..322a29ed1c7 100644 --- a/service/redshift/api_op_EnableLogging.go +++ b/service/redshift/api_op_EnableLogging.go @@ -59,6 +59,23 @@ func (c *Client) EnableLogging(ctx context.Context, params *EnableLoggingInput, // type EnableLoggingInput struct { + // The name of an existing S3 bucket where the log files are to be stored. + // Constraints: + // + // * Must be in the same region as the cluster + // + // * The cluster + // must have read bucket and put object permissions + // + // This member is required. + BucketName *string + + // The identifier of the cluster on which logging is to be started. Example: + // examplecluster + // + // This member is required. + ClusterIdentifier *string + // The prefix applied to the log file names. Constraints: // // * Cannot exceed 512 @@ -79,46 +96,29 @@ type EnableLoggingInput struct { // // * x7f or larger S3KeyPrefix *string - - // The name of an existing S3 bucket where the log files are to be stored. - // Constraints: - // - // * Must be in the same region as the cluster - // - // * The cluster - // must have read bucket and put object permissions - // - // This member is required. - BucketName *string - - // The identifier of the cluster on which logging is to be started. Example: - // examplecluster - // - // This member is required. - ClusterIdentifier *string } // Describes the status of logging for a cluster. type EnableLoggingOutput struct { - // The prefix applied to the log file names. - S3KeyPrefix *string + // The name of the S3 bucket where the log files are stored. + BucketName *string // The message indicating that logs failed to be delivered. LastFailureMessage *string - // true if logging is on, false if logging is off. - LoggingEnabled *bool - // The last time when logs failed to be delivered. LastFailureTime *time.Time - // The name of the S3 bucket where the log files are stored. - BucketName *string - // The last time that logs were delivered. LastSuccessfulDeliveryTime *time.Time + // true if logging is on, false if logging is off. + LoggingEnabled *bool + + // The prefix applied to the log file names. + S3KeyPrefix *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_EnableSnapshotCopy.go b/service/redshift/api_op_EnableSnapshotCopy.go index fe71fe34cb8..6f8136c714a 100644 --- a/service/redshift/api_op_EnableSnapshotCopy.go +++ b/service/redshift/api_op_EnableSnapshotCopy.go @@ -59,11 +59,12 @@ func (c *Client) EnableSnapshotCopy(ctx context.Context, params *EnableSnapshotC // type EnableSnapshotCopyInput struct { - // The number of days to retain newly copied snapshots in the destination AWS - // Region after they are copied from the source AWS Region. If the value is -1, the - // manual snapshot is retained indefinitely. The value must be either -1 or an - // integer between 1 and 3,653. - ManualSnapshotRetentionPeriod *int32 + // The unique identifier of the source cluster to copy snapshots from. Constraints: + // Must be the valid name of an existing cluster that does not already have + // cross-region snapshot copy enabled. + // + // This member is required. + ClusterIdentifier *string // The destination AWS Region that you want to copy snapshots to. Constraints: Must // be the name of a valid AWS Region. For more information, see Regions and @@ -74,12 +75,11 @@ type EnableSnapshotCopyInput struct { // This member is required. DestinationRegion *string - // The unique identifier of the source cluster to copy snapshots from. Constraints: - // Must be the valid name of an existing cluster that does not already have - // cross-region snapshot copy enabled. - // - // This member is required. - ClusterIdentifier *string + // The number of days to retain newly copied snapshots in the destination AWS + // Region after they are copied from the source AWS Region. If the value is -1, the + // manual snapshot is retained indefinitely. The value must be either -1 or an + // integer between 1 and 3,653. + ManualSnapshotRetentionPeriod *int32 // The number of days to retain automated snapshots in the destination region after // they are copied from the source region. Default: 7. Constraints: Must be at diff --git a/service/redshift/api_op_GetClusterCredentials.go b/service/redshift/api_op_GetClusterCredentials.go index b74c449ab62..c2d338b0e70 100644 --- a/service/redshift/api_op_GetClusterCredentials.go +++ b/service/redshift/api_op_GetClusterCredentials.go @@ -78,6 +78,46 @@ func (c *Client) GetClusterCredentials(ctx context.Context, params *GetClusterCr // The request parameters to get cluster credentials. type GetClusterCredentialsInput struct { + // The unique identifier of the cluster that contains the database for which your + // are requesting credentials. This parameter is case sensitive. + // + // This member is required. + ClusterIdentifier *string + + // The name of a database user. If a user name matching DbUser exists in the + // database, the temporary user credentials have the same permissions as the + // existing user. If DbUser doesn't exist in the database and Autocreate is True, a + // new user is created using the value for DbUser with PUBLIC permissions. If a + // database user matching the value for DbUser doesn't exist and Autocreate is + // False, then the command succeeds but the connection attempt will fail because + // the user doesn't exist in the database. For more information, see CREATE USER + // (https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html) in the + // Amazon Redshift Database Developer Guide. Constraints: + // + // * Must be 1 to 64 + // alphanumeric characters or hyphens. The user name can't be PUBLIC. + // + // * Must + // contain only lowercase letters, numbers, underscore, plus sign, period (dot), at + // symbol (@), or hyphen. + // + // * First character must be a letter. + // + // * Must not + // contain a colon ( : ) or slash ( / ). + // + // * Cannot be a reserved word. A list + // of reserved words can be found in Reserved Words + // (http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the Amazon + // Redshift Database Developer Guide. + // + // This member is required. + DbUser *string + + // Create a database user with the name specified for the user named in DbUser if + // one does not exist. + AutoCreate *bool + // A list of the names of existing database groups that the user named in DbUser // will join for the current session, in addition to any group memberships for an // existing user. If not specified, a new user is added only to PUBLIC. Database @@ -100,14 +140,6 @@ type GetClusterCredentialsInput struct { // Redshift Database Developer Guide. DbGroups []*string - // The number of seconds until the returned temporary password expires. Constraint: - // minimum 900, maximum 3600. Default: 900 - DurationSeconds *int32 - - // Create a database user with the name specified for the user named in DbUser if - // one does not exist. - AutoCreate *bool - // The name of a database that DbUser is authorized to log on to. If DbName is not // specified, DbUser can log on to any existing database. Constraints: // @@ -129,41 +161,9 @@ type GetClusterCredentialsInput struct { // Redshift Database Developer Guide. DbName *string - // The unique identifier of the cluster that contains the database for which your - // are requesting credentials. This parameter is case sensitive. - // - // This member is required. - ClusterIdentifier *string - - // The name of a database user. If a user name matching DbUser exists in the - // database, the temporary user credentials have the same permissions as the - // existing user. If DbUser doesn't exist in the database and Autocreate is True, a - // new user is created using the value for DbUser with PUBLIC permissions. If a - // database user matching the value for DbUser doesn't exist and Autocreate is - // False, then the command succeeds but the connection attempt will fail because - // the user doesn't exist in the database. For more information, see CREATE USER - // (https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html) in the - // Amazon Redshift Database Developer Guide. Constraints: - // - // * Must be 1 to 64 - // alphanumeric characters or hyphens. The user name can't be PUBLIC. - // - // * Must - // contain only lowercase letters, numbers, underscore, plus sign, period (dot), at - // symbol (@), or hyphen. - // - // * First character must be a letter. - // - // * Must not - // contain a colon ( : ) or slash ( / ). - // - // * Cannot be a reserved word. A list - // of reserved words can be found in Reserved Words - // (http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the Amazon - // Redshift Database Developer Guide. - // - // This member is required. - DbUser *string + // The number of seconds until the returned temporary password expires. Constraint: + // minimum 900, maximum 3600. Default: 900 + DurationSeconds *int32 } // Temporary credentials with authorization to log on to an Amazon Redshift diff --git a/service/redshift/api_op_GetReservedNodeExchangeOfferings.go b/service/redshift/api_op_GetReservedNodeExchangeOfferings.go index e378ae252f1..c308a4e889b 100644 --- a/service/redshift/api_op_GetReservedNodeExchangeOfferings.go +++ b/service/redshift/api_op_GetReservedNodeExchangeOfferings.go @@ -59,18 +59,18 @@ func (c *Client) GetReservedNodeExchangeOfferings(ctx context.Context, params *G // type GetReservedNodeExchangeOfferingsInput struct { - // An integer setting the maximum number of ReservedNodeOfferings to retrieve. - MaxRecords *int32 - - // A value that indicates the starting point for the next set of - // ReservedNodeOfferings. - Marker *string - // A string representing the node identifier for the DC1 Reserved Node to be // exchanged. // // This member is required. ReservedNodeId *string + + // A value that indicates the starting point for the next set of + // ReservedNodeOfferings. + Marker *string + + // An integer setting the maximum number of ReservedNodeOfferings to retrieve. + MaxRecords *int32 } type GetReservedNodeExchangeOfferingsOutput struct { diff --git a/service/redshift/api_op_ModifyCluster.go b/service/redshift/api_op_ModifyCluster.go index 5ef459d1e78..185d50446e4 100644 --- a/service/redshift/api_op_ModifyCluster.go +++ b/service/redshift/api_op_ModifyCluster.go @@ -67,21 +67,14 @@ func (c *Client) ModifyCluster(ctx context.Context, params *ModifyClusterInput, // type ModifyClusterInput struct { - // The AWS Key Management Service (KMS) key ID of the encryption key that you want - // to use to encrypt data in the cluster. - KmsKeyId *string - - // Indicates whether the cluster is encrypted. If the value is encrypted (true) and - // you provide a value for the KmsKeyId parameter, we encrypt the cluster with the - // provided KmsKeyId. If you don't provide a KmsKeyId, we encrypt with the default - // key. In the China region we use legacy encryption if you specify that the - // cluster is encrypted. If the value is not encrypted (false), then the cluster is - // decrypted. - Encrypted *bool + // The unique identifier of the cluster to be modified. Example: examplecluster + // + // This member is required. + ClusterIdentifier *string - // Specifies the name of the HSM client certificate the Amazon Redshift cluster - // uses to retrieve the data encryption keys stored in an HSM. - HsmClientCertificateIdentifier *string + // If true, major version upgrades will be applied automatically to the cluster + // during the maintenance window. Default: false + AllowVersionUpgrade *bool // The number of days that automated snapshots are retained. If the value is 0, // automated snapshots are disabled. Even if automated snapshots are disabled, you @@ -92,6 +85,35 @@ type ModifyClusterInput struct { // value from 0 to 35. AutomatedSnapshotRetentionPeriod *int32 + // The name of the cluster parameter group to apply to this cluster. This change is + // applied only after the cluster is rebooted. To reboot a cluster use + // RebootCluster (). Default: Uses existing setting. Constraints: The cluster + // parameter group must be in the same parameter group family that matches the + // cluster version. + ClusterParameterGroupName *string + + // A list of cluster security groups to be authorized on this cluster. This change + // is asynchronously applied as soon as possible. Security groups currently + // associated with the cluster, and not in the list of groups to apply, will be + // revoked from the cluster. Constraints: + // + // * Must be 1 to 255 alphanumeric + // characters or hyphens + // + // * First character must be a letter + // + // * Cannot end + // with a hyphen or contain two consecutive hyphens + ClusterSecurityGroups []*string + + // The new cluster type. When you submit your cluster resize request, your existing + // cluster goes into a read-only mode. After Amazon Redshift provisions a new + // cluster based on your resize requirements, there will be outage for a period + // while the old cluster is deleted and your connection is switched to the new + // cluster. You can use DescribeResize () to track the progress of the resize + // request. Valid Values: multi-node | single-node + ClusterType *string + // The new version number of the Amazon Redshift engine to upgrade to. For major // version upgrades, if a non-default cluster parameter group is currently in use, // a new cluster parameter group in the cluster parameter group family for the new @@ -102,34 +124,6 @@ type ModifyClusterInput struct { // in the Amazon Redshift Cluster Management Guide. Example: 1.0 ClusterVersion *string - // The new identifier for the cluster. Constraints: - // - // * Must contain from 1 to - // 63 alphanumeric characters or hyphens. - // - // * Alphabetic characters must be - // lowercase. - // - // * First character must be a letter. - // - // * Cannot end with a - // hyphen or contain two consecutive hyphens. - // - // * Must be unique for all - // clusters within an AWS account. - // - //

    Example: examplecluster - //

    - NewClusterIdentifier *string - - // The new number of nodes of the cluster. If you specify a new number of nodes, - // you must also specify the node type parameter. For more information about - // resizing clusters, go to Resizing Clusters in Amazon Redshift - // (https://docs.aws.amazon.com/redshift/latest/mgmt/rs-resize-tutorial.html) in - // the Amazon Redshift Cluster Management Guide.

    Valid Values: Integer greater - // than 0.

    - NumberOfNodes *int32 - // The Elastic IP (EIP) address for the cluster. Constraints: The cluster must be // provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For // more information about provisioning clusters in EC2-VPC, go to Supported @@ -138,6 +132,34 @@ type ModifyClusterInput struct { // in the Amazon Redshift Cluster Management Guide. ElasticIp *string + // Indicates whether the cluster is encrypted. If the value is encrypted (true) and + // you provide a value for the KmsKeyId parameter, we encrypt the cluster with the + // provided KmsKeyId. If you don't provide a KmsKeyId, we encrypt with the default + // key. In the China region we use legacy encryption if you specify that the + // cluster is encrypted. If the value is not encrypted (false), then the cluster is + // decrypted. + Encrypted *bool + + // An option that specifies whether to create the cluster with enhanced VPC routing + // enabled. To create a cluster that uses enhanced VPC routing, the cluster must be + // in a VPC. For more information, see Enhanced VPC Routing + // (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) in + // the Amazon Redshift Cluster Management Guide. If this option is true, enhanced + // VPC routing is enabled. Default: false + EnhancedVpcRouting *bool + + // Specifies the name of the HSM client certificate the Amazon Redshift cluster + // uses to retrieve the data encryption keys stored in an HSM. + HsmClientCertificateIdentifier *string + + // Specifies the name of the HSM configuration that contains the information the + // Amazon Redshift cluster can use to retrieve and store keys in an HSM. + HsmConfigurationIdentifier *string + + // The AWS Key Management Service (KMS) key ID of the encryption key that you want + // to use to encrypt data in the cluster. + KmsKeyId *string + // The name for the maintenance track that you want to assign for the cluster. This // name change is asynchronous. The new track name stays in the // PendingModifiedValues for the cluster until the next maintenance window. When @@ -146,9 +168,12 @@ type ModifyClusterInput struct { // track name is applied. MaintenanceTrackName *string - // If true, the cluster can be accessed from a public network. Only clusters in - // VPCs can be set to be publicly available. - PubliclyAccessible *bool + // The default for number of days that a newly created manual snapshot is retained. + // If the value is -1, the manual snapshot is retained indefinitely. This value + // doesn't retroactively change the retention periods of existing manual snapshots. + // The value must be either -1 or an integer between 1 and 3,653. The default value + // is -1. + ManualSnapshotRetentionPeriod *int32 // The new password for the cluster master user. This change is asynchronously // applied as soon as possible. Between the time of the request and the completion @@ -173,16 +198,25 @@ type ModifyClusterInput struct { // quote), \, /, @, or space. MasterUserPassword *string - // If true, major version upgrades will be applied automatically to the cluster - // during the maintenance window. Default: false - AllowVersionUpgrade *bool - - // The default for number of days that a newly created manual snapshot is retained. - // If the value is -1, the manual snapshot is retained indefinitely. This value - // doesn't retroactively change the retention periods of existing manual snapshots. - // The value must be either -1 or an integer between 1 and 3,653. The default value - // is -1. - ManualSnapshotRetentionPeriod *int32 + // The new identifier for the cluster. Constraints: + // + // * Must contain from 1 to + // 63 alphanumeric characters or hyphens. + // + // * Alphabetic characters must be + // lowercase. + // + // * First character must be a letter. + // + // * Cannot end with a + // hyphen or contain two consecutive hyphens. + // + // * Must be unique for all + // clusters within an AWS account. + // + //

    Example: examplecluster + //

    + NewClusterIdentifier *string // The new node type of the cluster. If you specify a new node type, you must also // specify the number of nodes parameter. For more information about resizing @@ -194,9 +228,13 @@ type ModifyClusterInput struct { // ra3.4xlarge | ra3.16xlarge

    NodeType *string - // A list of virtual private cloud (VPC) security groups to be associated with the - // cluster. This change is asynchronously applied as soon as possible. - VpcSecurityGroupIds []*string + // The new number of nodes of the cluster. If you specify a new number of nodes, + // you must also specify the node type parameter. For more information about + // resizing clusters, go to Resizing Clusters in Amazon Redshift + // (https://docs.aws.amazon.com/redshift/latest/mgmt/rs-resize-tutorial.html) in + // the Amazon Redshift Cluster Management Guide.

    Valid Values: Integer greater + // than 0.

    + NumberOfNodes *int32 // The weekly time range (in UTC) during which system maintenance can occur, if // necessary. If system maintenance is necessary during the window, it may result @@ -208,51 +246,13 @@ type ModifyClusterInput struct { // | Wed | Thu | Fri | Sat | Sun Constraints: Must be at least 30 minutes. PreferredMaintenanceWindow *string - // A list of cluster security groups to be authorized on this cluster. This change - // is asynchronously applied as soon as possible. Security groups currently - // associated with the cluster, and not in the list of groups to apply, will be - // revoked from the cluster. Constraints: - // - // * Must be 1 to 255 alphanumeric - // characters or hyphens - // - // * First character must be a letter - // - // * Cannot end - // with a hyphen or contain two consecutive hyphens - ClusterSecurityGroups []*string - - // An option that specifies whether to create the cluster with enhanced VPC routing - // enabled. To create a cluster that uses enhanced VPC routing, the cluster must be - // in a VPC. For more information, see Enhanced VPC Routing - // (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) in - // the Amazon Redshift Cluster Management Guide. If this option is true, enhanced - // VPC routing is enabled. Default: false - EnhancedVpcRouting *bool - - // Specifies the name of the HSM configuration that contains the information the - // Amazon Redshift cluster can use to retrieve and store keys in an HSM. - HsmConfigurationIdentifier *string - - // The new cluster type. When you submit your cluster resize request, your existing - // cluster goes into a read-only mode. After Amazon Redshift provisions a new - // cluster based on your resize requirements, there will be outage for a period - // while the old cluster is deleted and your connection is switched to the new - // cluster. You can use DescribeResize () to track the progress of the resize - // request. Valid Values: multi-node | single-node - ClusterType *string - - // The name of the cluster parameter group to apply to this cluster. This change is - // applied only after the cluster is rebooted. To reboot a cluster use - // RebootCluster (). Default: Uses existing setting. Constraints: The cluster - // parameter group must be in the same parameter group family that matches the - // cluster version. - ClusterParameterGroupName *string + // If true, the cluster can be accessed from a public network. Only clusters in + // VPCs can be set to be publicly available. + PubliclyAccessible *bool - // The unique identifier of the cluster to be modified. Example: examplecluster - // - // This member is required. - ClusterIdentifier *string + // A list of virtual private cloud (VPC) security groups to be associated with the + // cluster. This change is asynchronously applied as soon as possible. + VpcSecurityGroupIds []*string } type ModifyClusterOutput struct { diff --git a/service/redshift/api_op_ModifyClusterDbRevision.go b/service/redshift/api_op_ModifyClusterDbRevision.go index f93458c6584..3ad85170c01 100644 --- a/service/redshift/api_op_ModifyClusterDbRevision.go +++ b/service/redshift/api_op_ModifyClusterDbRevision.go @@ -58,17 +58,17 @@ func (c *Client) ModifyClusterDbRevision(ctx context.Context, params *ModifyClus type ModifyClusterDbRevisionInput struct { - // The identifier of the database revision. You can retrieve this value from the - // response to the DescribeClusterDbRevisions () request. - // - // This member is required. - RevisionTarget *string - // The unique identifier of a cluster whose database revision you want to modify. // Example: examplecluster // // This member is required. ClusterIdentifier *string + + // The identifier of the database revision. You can retrieve this value from the + // response to the DescribeClusterDbRevisions () request. + // + // This member is required. + RevisionTarget *string } type ModifyClusterDbRevisionOutput struct { diff --git a/service/redshift/api_op_ModifyClusterMaintenance.go b/service/redshift/api_op_ModifyClusterMaintenance.go index 489e88e9fb7..5bb5c47cf04 100644 --- a/service/redshift/api_op_ModifyClusterMaintenance.go +++ b/service/redshift/api_op_ModifyClusterMaintenance.go @@ -58,28 +58,28 @@ func (c *Client) ModifyClusterMaintenance(ctx context.Context, params *ModifyClu type ModifyClusterMaintenanceInput struct { - // A timestamp indicating end time for the deferred maintenance window. If you - // specify an end time, you can't specify a duration. - DeferMaintenanceEndTime *time.Time - - // A timestamp indicating the start time for the deferred maintenance window. - DeferMaintenanceStartTime *time.Time - - // A boolean indicating whether to enable the deferred maintenance window. - DeferMaintenance *bool - // A unique identifier for the cluster. // // This member is required. ClusterIdentifier *string + // A boolean indicating whether to enable the deferred maintenance window. + DeferMaintenance *bool + // An integer indicating the duration of the maintenance window in days. If you // specify a duration, you can't specify an end time. The duration must be 45 days // or less. DeferMaintenanceDuration *int32 + // A timestamp indicating end time for the deferred maintenance window. If you + // specify an end time, you can't specify a duration. + DeferMaintenanceEndTime *time.Time + // A unique identifier for the deferred maintenance window. DeferMaintenanceIdentifier *string + + // A timestamp indicating the start time for the deferred maintenance window. + DeferMaintenanceStartTime *time.Time } type ModifyClusterMaintenanceOutput struct { diff --git a/service/redshift/api_op_ModifyClusterParameterGroup.go b/service/redshift/api_op_ModifyClusterParameterGroup.go index 83a71dcef51..c8fdd416336 100644 --- a/service/redshift/api_op_ModifyClusterParameterGroup.go +++ b/service/redshift/api_op_ModifyClusterParameterGroup.go @@ -61,6 +61,11 @@ func (c *Client) ModifyClusterParameterGroup(ctx context.Context, params *Modify // type ModifyClusterParameterGroupInput struct { + // The name of the parameter group to be modified. + // + // This member is required. + ParameterGroupName *string + // An array of parameters to be modified. A maximum of 20 parameters can be // modified in a single request. For each parameter to be modified, you must supply // at least the parameter name and parameter value; other name-value pairs of the @@ -69,24 +74,19 @@ type ModifyClusterParameterGroupInput struct { // // This member is required. Parameters []*types.Parameter - - // The name of the parameter group to be modified. - // - // This member is required. - ParameterGroupName *string } // type ModifyClusterParameterGroupOutput struct { + // The name of the cluster parameter group. + ParameterGroupName *string + // The status of the parameter group. For example, if you made a change to a // parameter group name-value pair, then the change could be pending a reboot of an // associated cluster. ParameterGroupStatus *string - // The name of the cluster parameter group. - ParameterGroupName *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_ModifyClusterSnapshot.go b/service/redshift/api_op_ModifyClusterSnapshot.go index 17ccc003e2c..84192be4e30 100644 --- a/service/redshift/api_op_ModifyClusterSnapshot.go +++ b/service/redshift/api_op_ModifyClusterSnapshot.go @@ -58,21 +58,21 @@ func (c *Client) ModifyClusterSnapshot(ctx context.Context, params *ModifyCluste type ModifyClusterSnapshotInput struct { + // The identifier of the snapshot whose setting you want to modify. + // + // This member is required. + SnapshotIdentifier *string + + // A Boolean option to override an exception if the retention period has already + // passed. + Force *bool + // The number of days that a manual snapshot is retained. If the value is -1, the // manual snapshot is retained indefinitely. If the manual snapshot falls outside // of the new retention period, you can specify the force option to immediately // delete the snapshot. The value must be either -1 or an integer between 1 and // 3,653. ManualSnapshotRetentionPeriod *int32 - - // A Boolean option to override an exception if the retention period has already - // passed. - Force *bool - - // The identifier of the snapshot whose setting you want to modify. - // - // This member is required. - SnapshotIdentifier *string } type ModifyClusterSnapshotOutput struct { diff --git a/service/redshift/api_op_ModifyClusterSnapshotSchedule.go b/service/redshift/api_op_ModifyClusterSnapshotSchedule.go index 0bcbf862c0e..8dfc3db9547 100644 --- a/service/redshift/api_op_ModifyClusterSnapshotSchedule.go +++ b/service/redshift/api_op_ModifyClusterSnapshotSchedule.go @@ -56,15 +56,15 @@ func (c *Client) ModifyClusterSnapshotSchedule(ctx context.Context, params *Modi type ModifyClusterSnapshotScheduleInput struct { - // A boolean to indicate whether to remove the assoiciation between the cluster and - // the schedule. - DisassociateSchedule *bool - // A unique identifier for the cluster whose snapshot schedule you want to modify. // // This member is required. ClusterIdentifier *string + // A boolean to indicate whether to remove the assoiciation between the cluster and + // the schedule. + DisassociateSchedule *bool + // A unique alphanumeric identifier for the schedule that you want to associate // with the cluster. ScheduleIdentifier *string diff --git a/service/redshift/api_op_ModifyClusterSubnetGroup.go b/service/redshift/api_op_ModifyClusterSubnetGroup.go index a5acafcd02c..87d5895349c 100644 --- a/service/redshift/api_op_ModifyClusterSubnetGroup.go +++ b/service/redshift/api_op_ModifyClusterSubnetGroup.go @@ -65,14 +65,14 @@ type ModifyClusterSubnetGroupInput struct { // This member is required. ClusterSubnetGroupName *string - // A text description of the subnet group to be modified. - Description *string - // An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single // request. // // This member is required. SubnetIds []*string + + // A text description of the subnet group to be modified. + Description *string } type ModifyClusterSubnetGroupOutput struct { diff --git a/service/redshift/api_op_ModifyEventSubscription.go b/service/redshift/api_op_ModifyEventSubscription.go index 622490dba0e..6c67053364f 100644 --- a/service/redshift/api_op_ModifyEventSubscription.go +++ b/service/redshift/api_op_ModifyEventSubscription.go @@ -58,10 +58,28 @@ func (c *Client) ModifyEventSubscription(ctx context.Context, params *ModifyEven // type ModifyEventSubscriptionInput struct { + // The name of the modified Amazon Redshift event notification subscription. + // + // This member is required. + SubscriptionName *string + + // A Boolean value indicating if the subscription is enabled. true indicates the + // subscription is enabled + Enabled *bool + + // Specifies the Amazon Redshift event categories to be published by the event + // notification subscription. Values: configuration, management, monitoring, + // security + EventCategories []*string + // Specifies the Amazon Redshift event severity to be published by the event // notification subscription. Values: ERROR, INFO Severity *string + // The Amazon Resource Name (ARN) of the SNS topic to be used by the event + // notification subscription. + SnsTopicArn *string + // A list of one or more identifiers of Amazon Redshift source objects. All of the // objects must be of the same type as was specified in the source type parameter. // The event subscription will return only events generated by the specified @@ -70,15 +88,6 @@ type ModifyEventSubscriptionInput struct { // my-snapshot-20131010 SourceIds []*string - // A Boolean value indicating if the subscription is enabled. true indicates the - // subscription is enabled - Enabled *bool - - // The name of the modified Amazon Redshift event notification subscription. - // - // This member is required. - SubscriptionName *string - // The type of source that will be generating the events. For example, if you want // to be notified of events generated by a cluster, you would set this parameter to // cluster. If this value is not specified, events are returned for all Amazon @@ -86,15 +95,6 @@ type ModifyEventSubscriptionInput struct { // specify source IDs. Valid values: cluster, cluster-parameter-group, // cluster-security-group, cluster-snapshot, and scheduled-action. SourceType *string - - // The Amazon Resource Name (ARN) of the SNS topic to be used by the event - // notification subscription. - SnsTopicArn *string - - // Specifies the Amazon Redshift event categories to be published by the event - // notification subscription. Values: configuration, management, monitoring, - // security - EventCategories []*string } type ModifyEventSubscriptionOutput struct { diff --git a/service/redshift/api_op_ModifyScheduledAction.go b/service/redshift/api_op_ModifyScheduledAction.go index 90045846bdb..fa480e0f79b 100644 --- a/service/redshift/api_op_ModifyScheduledAction.go +++ b/service/redshift/api_op_ModifyScheduledAction.go @@ -58,37 +58,37 @@ func (c *Client) ModifyScheduledAction(ctx context.Context, params *ModifySchedu type ModifyScheduledActionInput struct { - // A modified JSON format of the scheduled action. For more information about this - // parameter, see ScheduledAction (). - TargetAction *types.ScheduledActionType - - // A modified end time of the scheduled action. For more information about this - // parameter, see ScheduledAction (). - EndTime *time.Time + // The name of the scheduled action to modify. + // + // This member is required. + ScheduledActionName *string // A modified enable flag of the scheduled action. If true, the scheduled action is // active. If false, the scheduled action is disabled. Enable *bool + // A modified end time of the scheduled action. For more information about this + // parameter, see ScheduledAction (). + EndTime *time.Time + // A different IAM role to assume to run the target action. For more information // about this parameter, see ScheduledAction (). IamRole *string - // A modified description of the scheduled action. - ScheduledActionDescription *string - - // The name of the scheduled action to modify. - // - // This member is required. - ScheduledActionName *string - // A modified schedule in either at( ) or cron( ) format. For more information // about this parameter, see ScheduledAction (). Schedule *string + // A modified description of the scheduled action. + ScheduledActionDescription *string + // A modified start time of the scheduled action. For more information about this // parameter, see ScheduledAction (). StartTime *time.Time + + // A modified JSON format of the scheduled action. For more information about this + // parameter, see ScheduledAction (). + TargetAction *types.ScheduledActionType } // Describes a scheduled action. You can use a scheduled action to trigger some @@ -96,14 +96,9 @@ type ModifyScheduledActionInput struct { // operations can be scheduled, see ScheduledActionType (). type ModifyScheduledActionOutput struct { - // List of times when the scheduled action will run. - NextInvocations []*time.Time - - // The description of the scheduled action. - ScheduledActionDescription *string - - // The name of the scheduled action. - ScheduledActionName *string + // The end time in UTC when the schedule is no longer active. After this time, the + // scheduled action does not trigger. + EndTime *time.Time // The IAM role to assume to run the scheduled action. This IAM role must have // permission to run the Amazon Redshift API operation in the scheduled action. @@ -115,16 +110,8 @@ type ModifyScheduledActionOutput struct { // in the Amazon Redshift Cluster Management Guide. IamRole *string - // A JSON format string of the Amazon Redshift API operation with input parameters. - // "{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}". - TargetAction *types.ScheduledActionType - - // The end time in UTC when the schedule is no longer active. After this time, the - // scheduled action does not trigger. - EndTime *time.Time - - // The state of the scheduled action. For example, DISABLED. - State types.ScheduledActionState + // List of times when the scheduled action will run. + NextInvocations []*time.Time // The schedule for a one-time (at format) or recurring (cron format) scheduled // action. Schedule invocations must be separated by at least one hour. Format of @@ -136,10 +123,23 @@ type ModifyScheduledActionOutput struct { // in the Amazon CloudWatch Events User Guide. Schedule *string + // The description of the scheduled action. + ScheduledActionDescription *string + + // The name of the scheduled action. + ScheduledActionName *string + // The start time in UTC when the schedule is active. Before this time, the // scheduled action does not trigger. StartTime *time.Time + // The state of the scheduled action. For example, DISABLED. + State types.ScheduledActionState + + // A JSON format string of the Amazon Redshift API operation with input parameters. + // "{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}". + TargetAction *types.ScheduledActionType + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_ModifySnapshotSchedule.go b/service/redshift/api_op_ModifySnapshotSchedule.go index 680a07aa80c..7a23b02f3fa 100644 --- a/service/redshift/api_op_ModifySnapshotSchedule.go +++ b/service/redshift/api_op_ModifySnapshotSchedule.go @@ -59,31 +59,37 @@ func (c *Client) ModifySnapshotSchedule(ctx context.Context, params *ModifySnaps type ModifySnapshotScheduleInput struct { - // A unique alphanumeric identifier of the schedule to modify. - // - // This member is required. - ScheduleIdentifier *string - // An updated list of schedule definitions. A schedule definition is made up of // schedule expressions, for example, "cron(30 12 *)" or "rate(12 hours)". // // This member is required. ScheduleDefinitions []*string + + // A unique alphanumeric identifier of the schedule to modify. + // + // This member is required. + ScheduleIdentifier *string } // Describes a snapshot schedule. You can set a regular interval for creating // snapshots of a cluster. You can also schedule snapshots for specific dates. type ModifySnapshotScheduleOutput struct { - // - NextInvocations []*time.Time + // The number of clusters associated with the schedule. + AssociatedClusterCount *int32 // A list of clusters associated with the schedule. A maximum of 100 clusters is // returned. AssociatedClusters []*types.ClusterAssociatedToSchedule - // The number of clusters associated with the schedule. - AssociatedClusterCount *int32 + // + NextInvocations []*time.Time + + // A list of ScheduleDefinitions. + ScheduleDefinitions []*string + + // The description of the schedule. + ScheduleDescription *string // A unique identifier for the schedule. ScheduleIdentifier *string @@ -91,12 +97,6 @@ type ModifySnapshotScheduleOutput struct { // An optional set of tags describing the schedule. Tags []*types.Tag - // The description of the schedule. - ScheduleDescription *string - - // A list of ScheduleDefinitions. - ScheduleDefinitions []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_ModifyUsageLimit.go b/service/redshift/api_op_ModifyUsageLimit.go index 11ab6a42a5f..26d7a67544b 100644 --- a/service/redshift/api_op_ModifyUsageLimit.go +++ b/service/redshift/api_op_ModifyUsageLimit.go @@ -75,18 +75,9 @@ type ModifyUsageLimitInput struct { // Describes a usage limit object for a cluster. type ModifyUsageLimitOutput struct { - // The identifier of the cluster with a usage limit. - ClusterIdentifier *string - - // The Amazon Redshift feature to which the limit applies. - FeatureType types.UsageLimitFeatureType - - // A list of tag instances. - Tags []*types.Tag - - // The type of limit. Depending on the feature type, this can be based on a time - // duration or data size. - LimitType types.UsageLimitLimitType + // The limit amount. If time-based, this amount is in minutes. If data-based, this + // amount is in terabytes (TB). + Amount *int64 // The action that Amazon Redshift takes when the limit is reached. Possible values // are: @@ -100,17 +91,26 @@ type ModifyUsageLimitOutput struct { // feature until the next usage period begins. BreachAction types.UsageLimitBreachAction + // The identifier of the cluster with a usage limit. + ClusterIdentifier *string + + // The Amazon Redshift feature to which the limit applies. + FeatureType types.UsageLimitFeatureType + + // The type of limit. Depending on the feature type, this can be based on a time + // duration or data size. + LimitType types.UsageLimitLimitType + // The time period that the amount applies to. A weekly period begins on Sunday. // The default is monthly. Period types.UsageLimitPeriod + // A list of tag instances. + Tags []*types.Tag + // The identifier of the usage limit. UsageLimitId *string - // The limit amount. If time-based, this amount is in minutes. If data-based, this - // amount is in terabytes (TB). - Amount *int64 - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_ResetClusterParameterGroup.go b/service/redshift/api_op_ResetClusterParameterGroup.go index 5d0d22a51a1..1356f249146 100644 --- a/service/redshift/api_op_ResetClusterParameterGroup.go +++ b/service/redshift/api_op_ResetClusterParameterGroup.go @@ -61,10 +61,6 @@ func (c *Client) ResetClusterParameterGroup(ctx context.Context, params *ResetCl // type ResetClusterParameterGroupInput struct { - // If true, all parameters in the specified parameter group will be reset to their - // default values. Default: true - ResetAllParameters *bool - // The name of the cluster parameter group to be reset. // // This member is required. @@ -74,19 +70,23 @@ type ResetClusterParameterGroupInput struct { // used, then at least one parameter name must be supplied. Constraints: A maximum // of 20 parameters can be reset in a single request. Parameters []*types.Parameter + + // If true, all parameters in the specified parameter group will be reset to their + // default values. Default: true + ResetAllParameters *bool } // type ResetClusterParameterGroupOutput struct { + // The name of the cluster parameter group. + ParameterGroupName *string + // The status of the parameter group. For example, if you made a change to a // parameter group name-value pair, then the change could be pending a reboot of an // associated cluster. ParameterGroupStatus *string - // The name of the cluster parameter group. - ParameterGroupName *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/redshift/api_op_ResizeCluster.go b/service/redshift/api_op_ResizeCluster.go index 9a0e2b5231b..0618f9a712c 100644 --- a/service/redshift/api_op_ResizeCluster.go +++ b/service/redshift/api_op_ResizeCluster.go @@ -81,25 +81,25 @@ func (c *Client) ResizeCluster(ctx context.Context, params *ResizeClusterInput, type ResizeClusterInput struct { - // The new node type for the nodes you are adding. If not specified, the cluster's - // current node type is used. - NodeType *string + // The unique identifier for the cluster to resize. + // + // This member is required. + ClusterIdentifier *string // A boolean value indicating whether the resize operation is using the classic // resize process. If you don't provide this parameter or set the value to false, // the resize type is elastic. Classic *bool - // The new number of nodes for the cluster. - NumberOfNodes *int32 - - // The unique identifier for the cluster to resize. - // - // This member is required. - ClusterIdentifier *string - // The new cluster type for the specified cluster. ClusterType *string + + // The new node type for the nodes you are adding. If not specified, the cluster's + // current node type is used. + NodeType *string + + // The new number of nodes for the cluster. + NumberOfNodes *int32 } type ResizeClusterOutput struct { diff --git a/service/redshift/api_op_RestoreFromClusterSnapshot.go b/service/redshift/api_op_RestoreFromClusterSnapshot.go index 7932149b43a..373efc20da3 100644 --- a/service/redshift/api_op_RestoreFromClusterSnapshot.go +++ b/service/redshift/api_op_RestoreFromClusterSnapshot.go @@ -69,53 +69,49 @@ func (c *Client) RestoreFromClusterSnapshot(ctx context.Context, params *Restore // type RestoreFromClusterSnapshotInput struct { - // The AWS customer account used to create or copy the snapshot. Required if you - // are restoring a snapshot you do not own, optional if you own the snapshot. - OwnerAccount *string + // The identifier of the cluster that will be created from restoring the snapshot. + // Constraints: + // + // * Must contain from 1 to 63 alphanumeric characters or + // hyphens. + // + // * Alphabetic characters must be lowercase. + // + // * First character + // must be a letter. + // + // * Cannot end with a hyphen or contain two consecutive + // hyphens. + // + // * Must be unique for all clusters within an AWS account. + // + // This member is required. + ClusterIdentifier *string - // If true, the cluster can be accessed from a public network. - PubliclyAccessible *bool + // The name of the snapshot from which to create the new cluster. This parameter + // isn't case sensitive. Example: my-snapshot-id + // + // This member is required. + SnapshotIdentifier *string - // The name of the cluster the source snapshot was created from. This parameter is - // required if your IAM user has a policy containing a snapshot resource element - // that specifies anything other than * for the cluster name. - SnapshotClusterIdentifier *string + // Reserved. + AdditionalInfo *string - // A list of AWS Identity and Access Management (IAM) roles that can be used by the - // cluster to access other AWS services. You must supply the IAM roles in their - // Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single - // request. A cluster can have up to 10 IAM roles associated at any time. - IamRoles []*string + // If true, major version upgrades can be applied during the maintenance window to + // the Amazon Redshift engine that is running on the cluster. Default: true + AllowVersionUpgrade *bool - // The elastic IP (EIP) address for the cluster. - ElasticIp *string + // The number of days that automated snapshots are retained. If the value is 0, + // automated snapshots are disabled. Even if automated snapshots are disabled, you + // can still create manual snapshots when you want with CreateClusterSnapshot (). + // Default: The value selected for the cluster from which the snapshot was taken. + // Constraints: Must be a value from 0 to 35. + AutomatedSnapshotRetentionPeriod *int32 // The Amazon EC2 Availability Zone in which to restore the cluster. Default: A // random, system-chosen Availability Zone. Example: us-east-2a AvailabilityZone *string - // Specifies the name of the HSM client certificate the Amazon Redshift cluster - // uses to retrieve the data encryption keys stored in an HSM. - HsmClientCertificateIdentifier *string - - // The AWS Key Management Service (KMS) key ID of the encryption key that you want - // to use to encrypt data in the cluster that you restore from a shared snapshot. - KmsKeyId *string - - // The weekly time range (in UTC) during which automated cluster maintenance can - // occur. Format: ddd:hh24:mi-ddd:hh24:mi Default: The value selected for the - // cluster from which the snapshot was taken. For more information about the time - // blocks for each region, see Maintenance Windows - // (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows) - // in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | - // Fri | Sat | Sun Constraints: Minimum 30-minute window. - PreferredMaintenanceWindow *string - - // A list of security groups to be associated with this cluster. Default: The - // default cluster security group for Amazon Redshift. Cluster security groups only - // apply to clusters outside of VPCs. - ClusterSecurityGroups []*string - // The name of the parameter group to be associated with this cluster. Default: The // default Amazon Redshift cluster parameter group. For information about the // default parameter group, go to Working with Amazon Redshift Parameter Groups @@ -131,27 +127,18 @@ type RestoreFromClusterSnapshotInput struct { // consecutive hyphens. ClusterParameterGroupName *string - // The number of nodes specified when provisioning the restored cluster. - NumberOfNodes *int32 + // A list of security groups to be associated with this cluster. Default: The + // default cluster security group for Amazon Redshift. Cluster security groups only + // apply to clusters outside of VPCs. + ClusterSecurityGroups []*string - // The identifier of the cluster that will be created from restoring the snapshot. - // Constraints: - // - // * Must contain from 1 to 63 alphanumeric characters or - // hyphens. - // - // * Alphabetic characters must be lowercase. - // - // * First character - // must be a letter. - // - // * Cannot end with a hyphen or contain two consecutive - // hyphens. - // - // * Must be unique for all clusters within an AWS account. - // - // This member is required. - ClusterIdentifier *string + // The name of the subnet group where you want to cluster restored. A snapshot of + // cluster in VPC can be restored only in VPC. Therefore, you must provide subnet + // group name where you want the cluster restored. + ClusterSubnetGroupName *string + + // The elastic IP (EIP) address for the cluster. + ElasticIp *string // An option that specifies whether to create the cluster with enhanced VPC routing // enabled. To create a cluster that uses enhanced VPC routing, the cluster must be @@ -161,14 +148,37 @@ type RestoreFromClusterSnapshotInput struct { // VPC routing is enabled. Default: false EnhancedVpcRouting *bool - // If true, major version upgrades can be applied during the maintenance window to - // the Amazon Redshift engine that is running on the cluster. Default: true - AllowVersionUpgrade *bool + // Specifies the name of the HSM client certificate the Amazon Redshift cluster + // uses to retrieve the data encryption keys stored in an HSM. + HsmClientCertificateIdentifier *string - // The name of the subnet group where you want to cluster restored. A snapshot of - // cluster in VPC can be restored only in VPC. Therefore, you must provide subnet - // group name where you want the cluster restored. - ClusterSubnetGroupName *string + // Specifies the name of the HSM configuration that contains the information the + // Amazon Redshift cluster can use to retrieve and store keys in an HSM. + HsmConfigurationIdentifier *string + + // A list of AWS Identity and Access Management (IAM) roles that can be used by the + // cluster to access other AWS services. You must supply the IAM roles in their + // Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single + // request. A cluster can have up to 10 IAM roles associated at any time. + IamRoles []*string + + // The AWS Key Management Service (KMS) key ID of the encryption key that you want + // to use to encrypt data in the cluster that you restore from a shared snapshot. + KmsKeyId *string + + // The name of the maintenance track for the restored cluster. When you take a + // snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. The + // snapshot might be on a different track than the cluster that was the source for + // the snapshot. For example, suppose that you take a snapshot of a cluster that is + // on the current track and then change the cluster to be on the trailing track. In + // this case, the snapshot and the source cluster are on different tracks. + MaintenanceTrackName *string + + // The default number of days to retain a manual snapshot. If the value is -1, the + // snapshot is retained indefinitely. This setting doesn't change the retention + // period of existing snapshots. The value must be either -1 or an integer between + // 1 and 3,653. + ManualSnapshotRetentionPeriod *int32 // The node type that the restored cluster will be provisioned with. Default: The // node type of the cluster from which the snapshot was taken. You can modify this @@ -184,51 +194,41 @@ type RestoreFromClusterSnapshotInput struct { // in the Amazon Redshift Cluster Management Guide. NodeType *string - // A unique identifier for the snapshot schedule. - SnapshotScheduleIdentifier *string - - // A list of Virtual Private Cloud (VPC) security groups to be associated with the - // cluster. Default: The default VPC security group is associated with the cluster. - // VPC security groups only apply to clusters in VPCs. - VpcSecurityGroupIds []*string - - // The default number of days to retain a manual snapshot. If the value is -1, the - // snapshot is retained indefinitely. This setting doesn't change the retention - // period of existing snapshots. The value must be either -1 or an integer between - // 1 and 3,653. - ManualSnapshotRetentionPeriod *int32 - - // The name of the maintenance track for the restored cluster. When you take a - // snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. The - // snapshot might be on a different track than the cluster that was the source for - // the snapshot. For example, suppose that you take a snapshot of a cluster that is - // on the current track and then change the cluster to be on the trailing track. In - // this case, the snapshot and the source cluster are on different tracks. - MaintenanceTrackName *string - - // Reserved. - AdditionalInfo *string + // The number of nodes specified when provisioning the restored cluster. + NumberOfNodes *int32 - // The number of days that automated snapshots are retained. If the value is 0, - // automated snapshots are disabled. Even if automated snapshots are disabled, you - // can still create manual snapshots when you want with CreateClusterSnapshot (). - // Default: The value selected for the cluster from which the snapshot was taken. - // Constraints: Must be a value from 0 to 35. - AutomatedSnapshotRetentionPeriod *int32 + // The AWS customer account used to create or copy the snapshot. Required if you + // are restoring a snapshot you do not own, optional if you own the snapshot. + OwnerAccount *string // The port number on which the cluster accepts connections. Default: The same port // as the original cluster. Constraints: Must be between 1115 and 65535. Port *int32 - // The name of the snapshot from which to create the new cluster. This parameter - // isn't case sensitive. Example: my-snapshot-id - // - // This member is required. - SnapshotIdentifier *string + // The weekly time range (in UTC) during which automated cluster maintenance can + // occur. Format: ddd:hh24:mi-ddd:hh24:mi Default: The value selected for the + // cluster from which the snapshot was taken. For more information about the time + // blocks for each region, see Maintenance Windows + // (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows) + // in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | + // Fri | Sat | Sun Constraints: Minimum 30-minute window. + PreferredMaintenanceWindow *string - // Specifies the name of the HSM configuration that contains the information the - // Amazon Redshift cluster can use to retrieve and store keys in an HSM. - HsmConfigurationIdentifier *string + // If true, the cluster can be accessed from a public network. + PubliclyAccessible *bool + + // The name of the cluster the source snapshot was created from. This parameter is + // required if your IAM user has a policy containing a snapshot resource element + // that specifies anything other than * for the cluster name. + SnapshotClusterIdentifier *string + + // A unique identifier for the snapshot schedule. + SnapshotScheduleIdentifier *string + + // A list of Virtual Private Cloud (VPC) security groups to be associated with the + // cluster. Default: The default VPC security group is associated with the cluster. + // VPC security groups only apply to clusters in VPCs. + VpcSecurityGroupIds []*string } type RestoreFromClusterSnapshotOutput struct { diff --git a/service/redshift/api_op_RestoreTableFromClusterSnapshot.go b/service/redshift/api_op_RestoreTableFromClusterSnapshot.go index dc0258ff3a3..216b899a552 100644 --- a/service/redshift/api_op_RestoreTableFromClusterSnapshot.go +++ b/service/redshift/api_op_RestoreTableFromClusterSnapshot.go @@ -68,12 +68,15 @@ func (c *Client) RestoreTableFromClusterSnapshot(ctx context.Context, params *Re // type RestoreTableFromClusterSnapshotInput struct { - // The name of the schema to restore the table to. - TargetSchemaName *string + // The identifier of the Amazon Redshift cluster to restore the table to. + // + // This member is required. + ClusterIdentifier *string - // The name of the source schema that contains the table to restore from. If you do - // not specify a SourceSchemaName value, the default is public. - SourceSchemaName *string + // The name of the table to create as a result of the current request. + // + // This member is required. + NewTableName *string // The identifier of the snapshot to restore the table from. This snapshot must // have been created from the Amazon Redshift cluster specified by the @@ -87,23 +90,20 @@ type RestoreTableFromClusterSnapshotInput struct { // This member is required. SourceDatabaseName *string - // The name of the database to restore the table to. - TargetDatabaseName *string - // The name of the source table to restore from. // // This member is required. SourceTableName *string - // The identifier of the Amazon Redshift cluster to restore the table to. - // - // This member is required. - ClusterIdentifier *string + // The name of the source schema that contains the table to restore from. If you do + // not specify a SourceSchemaName value, the default is public. + SourceSchemaName *string - // The name of the table to create as a result of the current request. - // - // This member is required. - NewTableName *string + // The name of the database to restore the table to. + TargetDatabaseName *string + + // The name of the schema to restore the table to. + TargetSchemaName *string } type RestoreTableFromClusterSnapshotOutput struct { diff --git a/service/redshift/api_op_RevokeClusterSecurityGroupIngress.go b/service/redshift/api_op_RevokeClusterSecurityGroupIngress.go index 88c229a5b6e..d87c858d01e 100644 --- a/service/redshift/api_op_RevokeClusterSecurityGroupIngress.go +++ b/service/redshift/api_op_RevokeClusterSecurityGroupIngress.go @@ -63,12 +63,6 @@ func (c *Client) RevokeClusterSecurityGroupIngress(ctx context.Context, params * // type RevokeClusterSecurityGroupIngressInput struct { - // The AWS account number of the owner of the security group specified in the - // EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable - // value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also - // be provided. and CIDRIP cannot be provided. Example: 111122223333 - EC2SecurityGroupOwnerId *string - // The name of the security Group from which to revoke the ingress rule. // // This member is required. @@ -83,6 +77,12 @@ type RevokeClusterSecurityGroupIngressInput struct { // EC2SecurityGroupName is specified, EC2SecurityGroupOwnerId must also be provided // and CIDRIP cannot be provided. EC2SecurityGroupName *string + + // The AWS account number of the owner of the security group specified in the + // EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable + // value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also + // be provided. and CIDRIP cannot be provided. Example: 111122223333 + EC2SecurityGroupOwnerId *string } type RevokeClusterSecurityGroupIngressOutput struct { diff --git a/service/redshift/api_op_RevokeSnapshotAccess.go b/service/redshift/api_op_RevokeSnapshotAccess.go index b96982d565f..ecec5a30848 100644 --- a/service/redshift/api_op_RevokeSnapshotAccess.go +++ b/service/redshift/api_op_RevokeSnapshotAccess.go @@ -63,17 +63,17 @@ func (c *Client) RevokeSnapshotAccess(ctx context.Context, params *RevokeSnapsho // type RevokeSnapshotAccessInput struct { - // The identifier of the snapshot that the account can no longer access. - // - // This member is required. - SnapshotIdentifier *string - // The identifier of the AWS customer account that can no longer restore the // specified snapshot. // // This member is required. AccountWithRestoreAccess *string + // The identifier of the snapshot that the account can no longer access. + // + // This member is required. + SnapshotIdentifier *string + // The identifier of the cluster the snapshot was created from. This parameter is // required if your IAM user has a policy containing a snapshot resource element // that specifies anything other than * for the cluster name. diff --git a/service/redshift/go.mod b/service/redshift/go.mod index d223b36a072..2d471959a11 100644 --- a/service/redshift/go.mod +++ b/service/redshift/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/redshift go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/redshift/types/types.go b/service/redshift/types/types.go index 5a5493727b2..f5d6cdf1c90 100644 --- a/service/redshift/types/types.go +++ b/service/redshift/types/types.go @@ -19,12 +19,12 @@ type AccountAttribute struct { // Describes an AWS customer account authorized to restore a snapshot. type AccountWithRestoreAccess struct { - // The identifier of an AWS customer account authorized to restore a snapshot. - AccountId *string - // The identifier of an AWS support account authorized to restore a snapshot. For // AWS support, the identifier is amazon-redshift-support. AccountAlias *string + + // The identifier of an AWS customer account authorized to restore a snapshot. + AccountId *string } // Describes an attribute value. @@ -47,141 +47,65 @@ type AvailabilityZone struct { // Describes a cluster. type Cluster struct { - // The connection endpoint. - Endpoint *Endpoint - - // A value that reports whether the Amazon Redshift cluster has finished applying - // any hardware security module (HSM) settings changes specified in a modify - // cluster command. Values: active, applying - HsmStatus *HsmStatus - - // A boolean value that, if true, indicates that the cluster can be accessed from a - // public network. - PubliclyAccessible *bool + // A boolean value that, if true, indicates that major version upgrades will be + // applied automatically to the cluster during the maintenance window. + AllowVersionUpgrade *bool - // A value that returns the destination region and retention period that are - // configured for cross-region snapshot copy. - ClusterSnapshotCopyStatus *ClusterSnapshotCopyStatus + // The number of days that automatic cluster snapshots are retained. + AutomatedSnapshotRetentionPeriod *int32 - // The identifier of the VPC the cluster is in, if the cluster is in a VPC. - VpcId *string + // The name of the Availability Zone in which the cluster is located. + AvailabilityZone *string - // The status of the elastic IP (EIP) address. - ElasticIpStatus *ElasticIpStatus + // The availability status of the cluster for queries. Possible values are the + // following: + // + // * Available - The cluster is available for queries. + // + // * + // Unavailable - The cluster is not available for queries. + // + // * Maintenance - The + // cluster is intermittently available for queries due to maintenance activities. + // + // + // * Modifying - The cluster is intermittently available for queries due to changes + // that modify the cluster. + // + // * Failed - The cluster failed and is not available + // for queries. + ClusterAvailabilityStatus *string - // The status of a modify operation, if any, initiated for the cluster. - ModifyStatus *string + // The date and time that the cluster was created. + ClusterCreateTime *time.Time // The unique identifier of the cluster. ClusterIdentifier *string - // The list of tags for the cluster. - Tags []*Tag - - // A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are - // associated with the cluster. This parameter is returned only if the cluster is - // in a VPC. - VpcSecurityGroups []*VpcSecurityGroupMembership - // The nodes in the cluster. ClusterNodes []*ClusterNode - // The weekly time range, in Universal Coordinated Time (UTC), during which system - // maintenance can occur. - PreferredMaintenanceWindow *string - - // The current state of the cluster snapshot schedule. - SnapshotScheduleState ScheduleState - - // The date and time in UTC when system maintenance can begin. - NextMaintenanceWindowStartTime *time.Time - - // Cluster operations that are waiting to be started. - PendingActions []*string - - // The date and time when the next snapshot is expected to be taken for clusters - // with a valid snapshot schedule and backups enabled. - ExpectedNextSnapshotScheduleTime *time.Time - - // The status of next expected snapshot for clusters having a valid snapshot - // schedule and backups enabled. Possible values are the following: - // - // * OnTrack - // - The next snapshot is expected to be taken on time. - // - // * Pending - The next - // snapshot is pending to be taken. - ExpectedNextSnapshotScheduleTimeStatus *string - - // Returns the following: - // - // * AllowCancelResize: a boolean value indicating if - // the resize operation can be cancelled. - // - // * ResizeType: Returns ClassicResize - ResizeInfo *ResizeInfo - - // The public key for the cluster. - ClusterPublicKey *string - - // The number of days that automatic cluster snapshots are retained. - AutomatedSnapshotRetentionPeriod *int32 - // The list of cluster parameter groups that are associated with this cluster. Each // parameter group in the list is returned with its status. ClusterParameterGroups []*ClusterParameterGroupStatus - // The name of the maintenance track for the cluster. - MaintenanceTrackName *string - - // - DataTransferProgress *DataTransferProgress - - // A unique identifier for the cluster snapshot schedule. - SnapshotScheduleIdentifier *string - - // The version ID of the Amazon Redshift engine that is running on the cluster. - ClusterVersion *string - - // The node type for the nodes in the cluster. - NodeType *string - - // The number of nodes that you can resize the cluster to with the elastic resize - // method. - ElasticResizeNumberOfNodeOptions *string - - // A value that describes the status of a cluster restore action. This parameter - // returns null if the cluster was not created by restoring a snapshot. - RestoreStatus *RestoreStatus - - // Describes a group of DeferredMaintenanceWindow objects. - DeferredMaintenanceWindows []*DeferredMaintenanceWindow - - // An option that specifies whether to create the cluster with enhanced VPC routing - // enabled. To create a cluster that uses enhanced VPC routing, the cluster must be - // in a VPC. For more information, see Enhanced VPC Routing - // (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) in - // the Amazon Redshift Cluster Management Guide. If this option is true, enhanced - // VPC routing is enabled. Default: false - EnhancedVpcRouting *bool - - // A boolean value that, if true, indicates that major version upgrades will be - // applied automatically to the cluster during the maintenance window. - AllowVersionUpgrade *bool - - // The number of compute nodes in the cluster. - NumberOfNodes *int32 + // The public key for the cluster. + ClusterPublicKey *string - // A boolean value that, if true, indicates that data in the cluster is encrypted - // at rest. - Encrypted *bool + // The specific revision number of the database in the cluster. + ClusterRevisionNumber *string - // The date and time that the cluster was created. - ClusterCreateTime *time.Time + // A list of cluster security group that are associated with the cluster. Each + // security group is represented by an element that contains + // ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements. Cluster + // security groups are used when the cluster is not created in an Amazon Virtual + // Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, + // which are listed by the VpcSecurityGroups parameter. + ClusterSecurityGroups []*ClusterSecurityGroupMembership - // A list of AWS Identity and Access Management (IAM) roles that can be used by the - // cluster to access other AWS services. - IamRoles []*ClusterIamRole + // A value that returns the destination region and retention period that are + // configured for cross-region snapshot copy. + ClusterSnapshotCopyStatus *ClusterSnapshotCopyStatus // The current state of the cluster. Possible values are the following: // @@ -232,80 +156,159 @@ type Cluster struct { // * updating-hsm ClusterStatus *string - // The availability status of the cluster for queries. Possible values are the - // following: - // - // * Available - The cluster is available for queries. - // - // * - // Unavailable - The cluster is not available for queries. - // - // * Maintenance - The - // cluster is intermittently available for queries due to maintenance activities. + // The name of the subnet group that is associated with the cluster. This parameter + // is valid only when the cluster is in a VPC. + ClusterSubnetGroupName *string + + // The version ID of the Amazon Redshift engine that is running on the cluster. + ClusterVersion *string + + // The name of the initial database that was created when the cluster was created. + // This same name is returned for the life of the cluster. If an initial database + // was not specified, a database named devdev was created by default. + DBName *string + // + DataTransferProgress *DataTransferProgress + + // Describes a group of DeferredMaintenanceWindow objects. + DeferredMaintenanceWindows []*DeferredMaintenanceWindow + + // The status of the elastic IP (EIP) address. + ElasticIpStatus *ElasticIpStatus + + // The number of nodes that you can resize the cluster to with the elastic resize + // method. + ElasticResizeNumberOfNodeOptions *string + + // A boolean value that, if true, indicates that data in the cluster is encrypted + // at rest. + Encrypted *bool + + // The connection endpoint. + Endpoint *Endpoint + + // An option that specifies whether to create the cluster with enhanced VPC routing + // enabled. To create a cluster that uses enhanced VPC routing, the cluster must be + // in a VPC. For more information, see Enhanced VPC Routing + // (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) in + // the Amazon Redshift Cluster Management Guide. If this option is true, enhanced + // VPC routing is enabled. Default: false + EnhancedVpcRouting *bool + + // The date and time when the next snapshot is expected to be taken for clusters + // with a valid snapshot schedule and backups enabled. + ExpectedNextSnapshotScheduleTime *time.Time + + // The status of next expected snapshot for clusters having a valid snapshot + // schedule and backups enabled. Possible values are the following: // - // * Modifying - The cluster is intermittently available for queries due to changes - // that modify the cluster. + // * OnTrack + // - The next snapshot is expected to be taken on time. // - // * Failed - The cluster failed and is not available - // for queries. - ClusterAvailabilityStatus *string + // * Pending - The next + // snapshot is pending to be taken. + ExpectedNextSnapshotScheduleTimeStatus *string - // The name of the Availability Zone in which the cluster is located. - AvailabilityZone *string + // A value that reports whether the Amazon Redshift cluster has finished applying + // any hardware security module (HSM) settings changes specified in a modify + // cluster command. Values: active, applying + HsmStatus *HsmStatus - // A list of cluster security group that are associated with the cluster. Each - // security group is represented by an element that contains - // ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements. Cluster - // security groups are used when the cluster is not created in an Amazon Virtual - // Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, - // which are listed by the VpcSecurityGroups parameter. - ClusterSecurityGroups []*ClusterSecurityGroupMembership + // A list of AWS Identity and Access Management (IAM) roles that can be used by the + // cluster to access other AWS services. + IamRoles []*ClusterIamRole // The AWS Key Management Service (AWS KMS) key ID of the encryption key used to // encrypt data in the cluster. KmsKeyId *string + // The name of the maintenance track for the cluster. + MaintenanceTrackName *string + // The default number of days to retain a manual snapshot. If the value is -1, the // snapshot is retained indefinitely. This setting doesn't change the retention // period of existing snapshots. The value must be either -1 or an integer between // 1 and 3,653. ManualSnapshotRetentionPeriod *int32 - // The specific revision number of the database in the cluster. - ClusterRevisionNumber *string + // The master user name for the cluster. This name is used to connect to the + // database that is specified in the DBName parameter. + MasterUsername *string + + // The status of a modify operation, if any, initiated for the cluster. + ModifyStatus *string + + // The date and time in UTC when system maintenance can begin. + NextMaintenanceWindowStartTime *time.Time + + // The node type for the nodes in the cluster. + NodeType *string + + // The number of compute nodes in the cluster. + NumberOfNodes *int32 + + // Cluster operations that are waiting to be started. + PendingActions []*string // A value that, if present, indicates that changes to the cluster are pending. // Specific pending changes are identified by subelements. PendingModifiedValues *PendingModifiedValues - // The name of the subnet group that is associated with the cluster. This parameter - // is valid only when the cluster is in a VPC. - ClusterSubnetGroupName *string + // The weekly time range, in Universal Coordinated Time (UTC), during which system + // maintenance can occur. + PreferredMaintenanceWindow *string - // The master user name for the cluster. This name is used to connect to the - // database that is specified in the DBName parameter. - MasterUsername *string + // A boolean value that, if true, indicates that the cluster can be accessed from a + // public network. + PubliclyAccessible *bool - // The name of the initial database that was created when the cluster was created. - // This same name is returned for the life of the cluster. If an initial database - // was not specified, a database named devdev was created by default. - DBName *string + // Returns the following: + // + // * AllowCancelResize: a boolean value indicating if + // the resize operation can be cancelled. + // + // * ResizeType: Returns ClassicResize + ResizeInfo *ResizeInfo + + // A value that describes the status of a cluster restore action. This parameter + // returns null if the cluster was not created by restoring a snapshot. + RestoreStatus *RestoreStatus + + // A unique identifier for the cluster snapshot schedule. + SnapshotScheduleIdentifier *string + + // The current state of the cluster snapshot schedule. + SnapshotScheduleState ScheduleState + + // The list of tags for the cluster. + Tags []*Tag + + // The identifier of the VPC the cluster is in, if the cluster is in a VPC. + VpcId *string + + // A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are + // associated with the cluster. This parameter is returned only if the cluster is + // in a VPC. + VpcSecurityGroups []*VpcSecurityGroupMembership } // type ClusterAssociatedToSchedule struct { // - ScheduleAssociationState ScheduleState + ClusterIdentifier *string // - ClusterIdentifier *string + ScheduleAssociationState ScheduleState } // Describes a ClusterDbRevision. type ClusterDbRevision struct { + // The unique identifier of the cluster. + ClusterIdentifier *string + // A string representing the current cluster version. CurrentDatabaseRevision *string @@ -315,9 +318,6 @@ type ClusterDbRevision struct { // A list of RevisionTarget objects, where each object describes the database // revision that a cluster can be updated to. RevisionTargets []*RevisionTarget - - // The unique identifier of the cluster. - ClusterIdentifier *string } // An AWS Identity and Access Management (IAM) role that can be used by the @@ -345,12 +345,12 @@ type ClusterIamRole struct { // The identifier of a node in a cluster. type ClusterNode struct { - // The private IP address of a node within a cluster. - PrivateIPAddress *string - // Whether the node is a leader node or a compute node. NodeRole *string + // The private IP address of a node within a cluster. + PrivateIPAddress *string + // The public IP address of a node within a cluster. PublicIPAddress *string } @@ -358,9 +358,6 @@ type ClusterNode struct { // Describes a parameter group. type ClusterParameterGroup struct { - // The list of tags for the cluster parameter group. - Tags []*Tag - // The description of the parameter group. Description *string @@ -370,27 +367,33 @@ type ClusterParameterGroup struct { // The name of the cluster parameter group. ParameterGroupName *string + + // The list of tags for the cluster parameter group. + Tags []*Tag } // Describes the status of a parameter group. type ClusterParameterGroupStatus struct { - // The name of the cluster parameter group. - ParameterGroupName *string - - // The status of parameter updates. - ParameterApplyStatus *string - // The list of parameter statuses. For more information about parameters and // parameter groups, go to Amazon Redshift Parameter Groups // (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) // in the Amazon Redshift Cluster Management Guide. ClusterParameterStatusList []*ClusterParameterStatus + + // The status of parameter updates. + ParameterApplyStatus *string + + // The name of the cluster parameter group. + ParameterGroupName *string } // Describes the status of a parameter group. type ClusterParameterStatus struct { + // The error that prevented the parameter from being applied to the database. + ParameterApplyErrorDescription *string + // The status of the parameter that indicates whether the parameter is in sync with // the database, waiting for a cluster reboot, or encountered an error when being // applied. The following are possible statuses and descriptions. @@ -419,9 +422,6 @@ type ClusterParameterStatus struct { // applied after the cluster reboots. ParameterApplyStatus *string - // The error that prevented the parameter from being applied to the database. - ParameterApplyErrorDescription *string - // The name of the parameter. ParameterName *string } @@ -429,9 +429,6 @@ type ClusterParameterStatus struct { // Describes a security group. type ClusterSecurityGroup struct { - // The list of tags for the cluster security group. - Tags []*Tag - // The name of the cluster security group to which the operation was applied. ClusterSecurityGroupName *string @@ -445,6 +442,9 @@ type ClusterSecurityGroup struct { // A list of IP ranges (CIDR blocks) that are permitted to access clusters // associated with this cluster security group. IPRanges []*IPRange + + // The list of tags for the cluster security group. + Tags []*Tag } // Describes a cluster security group. @@ -461,12 +461,9 @@ type ClusterSecurityGroupMembership struct { // cross-region snapshot copy. type ClusterSnapshotCopyStatus struct { - // The number of days that automated snapshots are retained in the destination - // region after they are copied from a source region. - RetentionPeriod *int64 - - // The name of the snapshot copy grant. - SnapshotCopyGrantName *string + // The destination region that snapshots are automatically copied to when + // cross-region snapshot copy is enabled. + DestinationRegion *string // The number of days that automated snapshots are retained in the destination // region after they are copied from a source region. If the value is -1, the @@ -474,52 +471,64 @@ type ClusterSnapshotCopyStatus struct { // integer between 1 and 3,653. ManualSnapshotRetentionPeriod *int32 - // The destination region that snapshots are automatically copied to when - // cross-region snapshot copy is enabled. - DestinationRegion *string + // The number of days that automated snapshots are retained in the destination + // region after they are copied from a source region. + RetentionPeriod *int64 + + // The name of the snapshot copy grant. + SnapshotCopyGrantName *string } // Describes a subnet group. type ClusterSubnetGroup struct { + // The name of the cluster subnet group. + ClusterSubnetGroupName *string + // The description of the cluster subnet group. Description *string + // The status of the cluster subnet group. Possible values are Complete, Incomplete + // and Invalid. + SubnetGroupStatus *string + // A list of the VPC Subnet () elements. Subnets []*Subnet - // The name of the cluster subnet group. - ClusterSubnetGroupName *string - - // The VPC ID of the cluster subnet group. - VpcId *string - // The list of tags for the cluster subnet group. Tags []*Tag - // The status of the cluster subnet group. Possible values are Complete, Incomplete - // and Invalid. - SubnetGroupStatus *string + // The VPC ID of the cluster subnet group. + VpcId *string } // Describes a cluster version, including the parameter group family and // description of the version. type ClusterVersion struct { - // The description of the cluster version. - Description *string + // The name of the cluster parameter group family for the cluster. + ClusterParameterGroupFamily *string // The version number used by the cluster. ClusterVersion *string - // The name of the cluster parameter group family for the cluster. - ClusterParameterGroupFamily *string + // The description of the cluster version. + Description *string } // Describes the status of a cluster while it is in the process of resizing with an // incremental resize. type DataTransferProgress struct { + // Describes the data transfer rate in MB's per second. + CurrentRateInMegaBytesPerSecond *float64 + + // Describes the total amount of data that has been transfered in MB's. + DataTransferredInMegaBytes *int64 + + // Describes the number of seconds that have elapsed during the data transfer. + ElapsedTimeInSeconds *int64 + // Describes the estimated number of seconds remaining to complete the transfer. EstimatedTimeToCompletionInSeconds *int64 @@ -527,25 +536,13 @@ type DataTransferProgress struct { // status is transferringdata. Status *string - // Describes the number of seconds that have elapsed during the data transfer. - ElapsedTimeInSeconds *int64 - // Describes the total amount of data to be transfered in megabytes. TotalDataInMegaBytes *int64 - - // Describes the total amount of data that has been transfered in MB's. - DataTransferredInMegaBytes *int64 - - // Describes the data transfer rate in MB's per second. - CurrentRateInMegaBytesPerSecond *float64 } // Describes the default cluster parameters for a parameter group family. type DefaultClusterParameters struct { - // The list of cluster default parameters. - Parameters []*Parameter - // A value that indicates the starting point for the next set of response records // in a subsequent request. If a value is returned in a response, you can retrieve // the next set of records by providing this returned marker value in the Marker @@ -556,17 +553,20 @@ type DefaultClusterParameters struct { // The name of the cluster parameter group family to which the engine default // parameters apply. ParameterGroupFamily *string + + // The list of cluster default parameters. + Parameters []*Parameter } // Describes a deferred maintenance window type DeferredMaintenanceWindow struct { - // A unique identifier for the maintenance window. - DeferMaintenanceIdentifier *string - // A timestamp for the end of the time period when we defer maintenance. DeferMaintenanceEndTime *time.Time + // A unique identifier for the maintenance window. + DeferMaintenanceIdentifier *string + // A timestamp for the beginning of the time period when we defer maintenance. DeferMaintenanceStartTime *time.Time } @@ -574,45 +574,45 @@ type DeferredMaintenanceWindow struct { // type DeleteClusterSnapshotMessage struct { - // The unique identifier of the cluster the snapshot was created from. This - // parameter is required if your IAM user has a policy containing a snapshot - // resource element that specifies anything other than * for the cluster name. - // Constraints: Must be the name of valid cluster. - SnapshotClusterIdentifier *string - // The unique identifier of the manual snapshot to be deleted. Constraints: Must be // the name of an existing snapshot that is in the available, failed, or cancelled // state. // // This member is required. SnapshotIdentifier *string + + // The unique identifier of the cluster the snapshot was created from. This + // parameter is required if your IAM user has a policy containing a snapshot + // resource element that specifies anything other than * for the cluster name. + // Constraints: Must be the name of valid cluster. + SnapshotClusterIdentifier *string } // Describes an Amazon EC2 security group. type EC2SecurityGroup struct { + // The name of the EC2 Security Group. + EC2SecurityGroupName *string + // The AWS ID of the owner of the EC2 security group specified in the // EC2SecurityGroupName field. EC2SecurityGroupOwnerId *string - // The name of the EC2 Security Group. - EC2SecurityGroupName *string + // The status of the EC2 security group. + Status *string // The list of tags for the EC2 security group. Tags []*Tag - - // The status of the EC2 security group. - Status *string } // Describes the status of the elastic IP (EIP) address. type ElasticIpStatus struct { - // The status of the elastic IP (EIP) address. - Status *string - // The elastic IP (EIP) address for the cluster. ElasticIp *string + + // The status of the elastic IP (EIP) address. + Status *string } // Describes a connection endpoint. @@ -631,8 +631,15 @@ type Event struct { // The date and time of the event. Date *time.Time - // The source type for this event. - SourceType SourceType + // A list of the event categories. Values: Configuration, Management, Monitoring, + // Security + EventCategories []*string + + // The identifier of the event. + EventId *string + + // The text of this event. + Message *string // The severity of the event. Values: ERROR, INFO Severity *string @@ -640,51 +647,72 @@ type Event struct { // The identifier for the source of the event. SourceIdentifier *string - // The identifier of the event. - EventId *string - - // A list of the event categories. Values: Configuration, Management, Monitoring, - // Security - EventCategories []*string - - // The text of this event. - Message *string + // The source type for this event. + SourceType SourceType } // Describes event categories. type EventCategoriesMap struct { + // The events in the event category. + Events []*EventInfoMap + // The source type, such as cluster or cluster-snapshot, that the returned // categories belong to. SourceType *string - - // The events in the event category. - Events []*EventInfoMap } // Describes event information. type EventInfoMap struct { - // The severity of the event. Values: ERROR, INFO - Severity *string - // The category of an Amazon Redshift event. EventCategories []*string + // The description of an Amazon Redshift event. + EventDescription *string + // The identifier of an Amazon Redshift event. EventId *string - // The description of an Amazon Redshift event. - EventDescription *string + // The severity of the event. Values: ERROR, INFO + Severity *string } // Describes event subscriptions. type EventSubscription struct { + // The name of the Amazon Redshift event notification subscription. + CustSubscriptionId *string + + // The AWS customer account associated with the Amazon Redshift event notification + // subscription. + CustomerAwsId *string + + // A boolean value indicating whether the subscription is enabled; true indicates + // that the subscription is enabled. + Enabled *bool + + // The list of Amazon Redshift event categories specified in the event notification + // subscription. Values: Configuration, Management, Monitoring, Security + EventCategoriesList []*string + + // The event severity specified in the Amazon Redshift event notification + // subscription. Values: ERROR, INFO + Severity *string + + // The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event + // notification subscription. + SnsTopicArn *string + // A list of the sources that publish events to the Amazon Redshift event // notification subscription. SourceIdsList []*string + // The source type of the events returned by the Amazon Redshift event + // notification, such as cluster, cluster-snapshot, cluster-parameter-group, + // cluster-security-group, or scheduled-action. + SourceType *string + // The status of the Amazon Redshift event notification subscription. // Constraints: // @@ -697,40 +725,12 @@ type EventSubscription struct { // was created. Status *string - // The list of Amazon Redshift event categories specified in the event notification - // subscription. Values: Configuration, Management, Monitoring, Security - EventCategoriesList []*string - - // The source type of the events returned by the Amazon Redshift event - // notification, such as cluster, cluster-snapshot, cluster-parameter-group, - // cluster-security-group, or scheduled-action. - SourceType *string - - // A boolean value indicating whether the subscription is enabled; true indicates - // that the subscription is enabled. - Enabled *bool - - // The name of the Amazon Redshift event notification subscription. - CustSubscriptionId *string - // The date and time the Amazon Redshift event notification subscription was // created. SubscriptionCreationTime *time.Time - // The event severity specified in the Amazon Redshift event notification - // subscription. Values: ERROR, INFO - Severity *string - - // The AWS customer account associated with the Amazon Redshift event notification - // subscription. - CustomerAwsId *string - // The list of tags for the event subscription. Tags []*Tag - - // The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event - // notification subscription. - SnsTopicArn *string } // Returns information about an HSM client certificate. The certificate is stored @@ -738,15 +738,15 @@ type EventSubscription struct { // cluster to encrypt data files. type HsmClientCertificate struct { - // The list of tags for the HSM client certificate. - Tags []*Tag - // The identifier of the HSM client certificate. HsmClientCertificateIdentifier *string // The public key that the Amazon Redshift cluster will use to connect to the HSM. // You must register the public key in the HSM. HsmClientCertificatePublicKey *string + + // The list of tags for the HSM client certificate. + Tags []*Tag } // Returns information about an HSM configuration, which is an object that @@ -757,27 +757,23 @@ type HsmConfiguration struct { // A text description of the HSM configuration. Description *string - // The list of tags for the HSM configuration. - Tags []*Tag - - // The name of the partition in the HSM where the Amazon Redshift clusters will - // store their database encryption keys. - HsmPartitionName *string - // The name of the Amazon Redshift HSM configuration. HsmConfigurationIdentifier *string // The IP address that the Amazon Redshift cluster must use to access the HSM. HsmIpAddress *string + + // The name of the partition in the HSM where the Amazon Redshift clusters will + // store their database encryption keys. + HsmPartitionName *string + + // The list of tags for the HSM configuration. + Tags []*Tag } // Describes the status of changes to HSM settings. type HsmStatus struct { - // Reports whether the Amazon Redshift cluster has finished applying any HSM - // settings changes specified in a modify cluster command. Values: active, applying - Status *string - // Specifies the name of the HSM client certificate the Amazon Redshift cluster // uses to retrieve the data encryption keys stored in an HSM. HsmClientCertificateIdentifier *string @@ -785,19 +781,23 @@ type HsmStatus struct { // Specifies the name of the HSM configuration that contains the information the // Amazon Redshift cluster can use to retrieve and store keys in an HSM. HsmConfigurationIdentifier *string + + // Reports whether the Amazon Redshift cluster has finished applying any HSM + // settings changes specified in a modify cluster command. Values: active, applying + Status *string } // Describes an IP range used in a security group. type IPRange struct { - // The list of tags for the IP range. - Tags []*Tag - // The IP range in Classless Inter-Domain Routing (CIDR) notation. CIDRIP *string // The status of the IP range, for example, "authorized". Status *string + + // The list of tags for the IP range. + Tags []*Tag } // Defines a maintenance track that determines which Amazon Redshift version to @@ -807,14 +807,14 @@ type IPRange struct { // maintenance release. type MaintenanceTrack struct { + // The version number for the cluster release. + DatabaseVersion *string + // The name of the maintenance track. Possible values are current and trailing. MaintenanceTrackName *string // An array of UpdateTarget () objects to update with the maintenance track. UpdateTargets []*UpdateTarget - - // The version number for the cluster release. - DatabaseVersion *string } // A list of node configurations. @@ -836,52 +836,43 @@ type NodeConfigurationOption struct { // A set of elements to filter the returned node configurations. type NodeConfigurationOptionsFilter struct { - // List of values. Compare Name using Operator to Values. If filter Name is - // NumberOfNodes, then values can range from 0 to 200. If filter Name is - // EstimatedDiskUtilizationPercent, then values can range from 0 to 100. For - // example, filter NumberOfNodes (name) GT (operator) 3 (values). - Values []*string + // The name of the element to filter. + Name NodeConfigurationOptionsFilterName // The filter operator. If filter Name is NodeType only the 'in' operator is // supported. Provide one value to evaluate for 'eq', 'lt', 'le', 'gt', and 'ge'. // Provide two values to evaluate for 'between'. Provide a list of values for 'in'. Operator OperatorType - // The name of the element to filter. - Name NodeConfigurationOptionsFilterName + // List of values. Compare Name using Operator to Values. If filter Name is + // NumberOfNodes, then values can range from 0 to 200. If filter Name is + // EstimatedDiskUtilizationPercent, then values can range from 0 to 100. For + // example, filter NumberOfNodes (name) GT (operator) 3 (values). + Values []*string } // Describes an orderable cluster option. type OrderableClusterOption struct { - // The cluster type, for example multi-node. - ClusterType *string - - // The node type for the orderable cluster. - NodeType *string - // A list of availability zones for the orderable cluster. AvailabilityZones []*AvailabilityZone + // The cluster type, for example multi-node. + ClusterType *string + // The version of the orderable cluster. ClusterVersion *string + + // The node type for the orderable cluster. + NodeType *string } // Describes a parameter in a cluster parameter group. type Parameter struct { - // The data type of the parameter. - DataType *string - // The valid range of values for the parameter. AllowedValues *string - // The source of the parameter value, such as "engine-default" or "user". - Source *string - - // The name of the parameter. - ParameterName *string - // Specifies how to apply the WLM configuration parameter. Some properties can be // applied dynamically, while other properties require that any associated clusters // be rebooted for the configuration changes to be applied. For more information @@ -890,18 +881,27 @@ type Parameter struct { // in the Amazon Redshift Cluster Management Guide. ApplyType ParameterApplyType - // The value of the parameter. - ParameterValue *string + // The data type of the parameter. + DataType *string + + // A description of the parameter. + Description *string // If true, the parameter can be modified. Some parameters have security or // operational implications that prevent them from being changed. IsModifiable *bool - // A description of the parameter. - Description *string - // The earliest engine version to which the parameter can apply. MinimumEngineVersion *string + + // The name of the parameter. + ParameterName *string + + // The value of the parameter. + ParameterValue *string + + // The source of the parameter value, such as "engine-default" or "user". + Source *string } type PauseClusterMessage struct { @@ -916,25 +916,21 @@ type PauseClusterMessage struct { // more the attributes was requested and is in progress or will be applied. type PendingModifiedValues struct { - // The pending or in-progress change of the service version. - ClusterVersion *string - - // The pending or in-progress change of the ability to connect to the cluster from - // the public network. - PubliclyAccessible *bool + // The pending or in-progress change of the automated snapshot retention period. + AutomatedSnapshotRetentionPeriod *int32 // The pending or in-progress change of the new identifier for the cluster. ClusterIdentifier *string - // The pending or in-progress change of the number of nodes in the cluster. - NumberOfNodes *int32 - // The pending or in-progress change of the cluster type. ClusterType *string - // The name of the maintenance track that the cluster will change to during the - // next maintenance window. - MaintenanceTrackName *string + // The pending or in-progress change of the service version. + ClusterVersion *string + + // The encryption type for a cluster. Possible values are: KMS and None. For the + // China region the possible values are None, and Legacy. + EncryptionType *string // An option that specifies whether to create the cluster with enhanced VPC routing // enabled. To create a cluster that uses enhanced VPC routing, the cluster must be @@ -944,18 +940,22 @@ type PendingModifiedValues struct { // VPC routing is enabled. Default: false EnhancedVpcRouting *bool + // The name of the maintenance track that the cluster will change to during the + // next maintenance window. + MaintenanceTrackName *string + // The pending or in-progress change of the master user password for the cluster. MasterUserPassword *string - // The pending or in-progress change of the automated snapshot retention period. - AutomatedSnapshotRetentionPeriod *int32 - - // The encryption type for a cluster. Possible values are: KMS and None. For the - // China region the possible values are None, and Legacy. - EncryptionType *string - // The pending or in-progress change of the cluster's node type. NodeType *string + + // The pending or in-progress change of the number of nodes in the cluster. + NumberOfNodes *int32 + + // The pending or in-progress change of the ability to connect to the cluster from + // the public network. + PubliclyAccessible *bool } // Describes a recurring charge. @@ -973,18 +973,37 @@ type RecurringCharge struct { // to obtain the available reserved node offerings. type ReservedNode struct { - // The recurring charges for the reserved node. - RecurringCharges []*RecurringCharge + // The currency code for the reserved cluster. + CurrencyCode *string - // - ReservedNodeOfferingType ReservedNodeOfferingType + // The duration of the node reservation in seconds. + Duration *int32 // The fixed cost Amazon Redshift charges you for this reserved node. FixedPrice *float64 + // The number of reserved compute nodes. + NodeCount *int32 + + // The node type of the reserved node. + NodeType *string + + // The anticipated utilization of the reserved node, as defined in the reserved + // node offering. + OfferingType *string + + // The recurring charges for the reserved node. + RecurringCharges []*RecurringCharge + + // The unique identifier for the reservation. + ReservedNodeId *string + // The identifier for the reserved node offering. ReservedNodeOfferingId *string + // + ReservedNodeOfferingType ReservedNodeOfferingType + // The time the reservation started. You purchase a reserved node offering for a // duration. This is the start time of that duration. StartTime *time.Time @@ -1008,25 +1027,6 @@ type ReservedNode struct { // the reserved node for another reserved node. State *string - // The node type of the reserved node. - NodeType *string - - // The number of reserved compute nodes. - NodeCount *int32 - - // The duration of the node reservation in seconds. - Duration *int32 - - // The anticipated utilization of the reserved node, as defined in the reserved - // node offering. - OfferingType *string - - // The unique identifier for the reservation. - ReservedNodeId *string - - // The currency code for the reserved cluster. - CurrencyCode *string - // The hourly rate Amazon Redshift charges you for this reserved node. UsagePrice *float64 } @@ -1034,23 +1034,23 @@ type ReservedNode struct { // Describes a reserved node offering. type ReservedNodeOffering struct { - // - ReservedNodeOfferingType ReservedNodeOfferingType - // The currency code for the compute nodes offering. CurrencyCode *string - // The anticipated utilization of the reserved node, as defined in the reserved - // node offering. - OfferingType *string + // The duration, in seconds, for which the offering will reserve the node. + Duration *int32 - // The rate you are charged for each hour the cluster that is using the offering is - // running. - UsagePrice *float64 + // The upfront fixed charge you will pay to purchase the specific reserved node + // offering. + FixedPrice *float64 // The node type offered by the reserved node offering. NodeType *string + // The anticipated utilization of the reserved node, as defined in the reserved + // node offering. + OfferingType *string + // The charge to your account regardless of whether you are creating any clusters // using the node offering. Recurring charges are only in effect for // heavy-utilization reserved nodes. @@ -1059,35 +1059,35 @@ type ReservedNodeOffering struct { // The offering identifier. ReservedNodeOfferingId *string - // The duration, in seconds, for which the offering will reserve the node. - Duration *int32 + // + ReservedNodeOfferingType ReservedNodeOfferingType - // The upfront fixed charge you will pay to purchase the specific reserved node - // offering. - FixedPrice *float64 + // The rate you are charged for each hour the cluster that is using the offering is + // running. + UsagePrice *float64 } type ResizeClusterMessage struct { - // The new node type for the nodes you are adding. If not specified, the cluster's - // current node type is used. - NodeType *string + // The unique identifier for the cluster to resize. + // + // This member is required. + ClusterIdentifier *string // A boolean value indicating whether the resize operation is using the classic // resize process. If you don't provide this parameter or set the value to false, // the resize type is elastic. Classic *bool - // The new number of nodes for the cluster. - NumberOfNodes *int32 - - // The unique identifier for the cluster to resize. - // - // This member is required. - ClusterIdentifier *string - // The new cluster type for the specified cluster. ClusterType *string + + // The new node type for the nodes you are adding. If not specified, the cluster's + // current node type is used. + NodeType *string + + // The new number of nodes for the cluster. + NumberOfNodes *int32 } // Describes a resize operation. @@ -1104,32 +1104,32 @@ type ResizeInfo struct { // was not created by restoring a snapshot. type RestoreStatus struct { - // The size of the set of snapshot data used to restore the cluster. This field is - // only updated when you restore to DC2 and DS2 node types. - SnapshotSizeInMegaBytes *int64 - - // The number of megabytes that have been transferred from snapshot storage. This - // field is only updated when you restore to DC2 and DS2 node types. - ProgressInMegaBytes *int64 - - // The status of the restore action. Returns starting, restoring, completed, or - // failed. - Status *string - // The number of megabytes per second being transferred from the backup storage. // Returns the average rate for a completed backup. This field is only updated when // you restore to DC2 and DS2 node types. CurrentRestoreRateInMegaBytesPerSecond *float64 + // The amount of time an in-progress restore has been running, or the amount of + // time it took a completed restore to finish. This field is only updated when you + // restore to DC2 and DS2 node types. + ElapsedTimeInSeconds *int64 + // The estimate of the time remaining before the restore will complete. Returns 0 // for a completed restore. This field is only updated when you restore to DC2 and // DS2 node types. EstimatedTimeToCompletionInSeconds *int64 - // The amount of time an in-progress restore has been running, or the amount of - // time it took a completed restore to finish. This field is only updated when you - // restore to DC2 and DS2 node types. - ElapsedTimeInSeconds *int64 + // The number of megabytes that have been transferred from snapshot storage. This + // field is only updated when you restore to DC2 and DS2 node types. + ProgressInMegaBytes *int64 + + // The size of the set of snapshot data used to restore the cluster. This field is + // only updated when you restore to DC2 and DS2 node types. + SnapshotSizeInMegaBytes *int64 + + // The status of the restore action. Returns starting, restoring, completed, or + // failed. + Status *string } type ResumeClusterMessage struct { @@ -1143,16 +1143,16 @@ type ResumeClusterMessage struct { // Describes a RevisionTarget. type RevisionTarget struct { + // A unique string that identifies the version to update the cluster to. You can + // use this value in ModifyClusterDbRevision (). + DatabaseRevision *string + // The date on which the database revision was released. DatabaseRevisionReleaseDate *time.Time // A string that describes the changes and features that will be applied to the // cluster when it is updated to the corresponding ClusterDbRevision (). Description *string - - // A unique string that identifies the version to update the cluster to. You can - // use this value in ModifyClusterDbRevision (). - DatabaseRevision *string } // Describes a scheduled action. You can use a scheduled action to trigger some @@ -1160,14 +1160,9 @@ type RevisionTarget struct { // operations can be scheduled, see ScheduledActionType (). type ScheduledAction struct { - // List of times when the scheduled action will run. - NextInvocations []*time.Time - - // The description of the scheduled action. - ScheduledActionDescription *string - - // The name of the scheduled action. - ScheduledActionName *string + // The end time in UTC when the schedule is no longer active. After this time, the + // scheduled action does not trigger. + EndTime *time.Time // The IAM role to assume to run the scheduled action. This IAM role must have // permission to run the Amazon Redshift API operation in the scheduled action. @@ -1179,16 +1174,8 @@ type ScheduledAction struct { // in the Amazon Redshift Cluster Management Guide. IamRole *string - // A JSON format string of the Amazon Redshift API operation with input parameters. - // "{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}". - TargetAction *ScheduledActionType - - // The end time in UTC when the schedule is no longer active. After this time, the - // scheduled action does not trigger. - EndTime *time.Time - - // The state of the scheduled action. For example, DISABLED. - State ScheduledActionState + // List of times when the scheduled action will run. + NextInvocations []*time.Time // The schedule for a one-time (at format) or recurring (cron format) scheduled // action. Schedule invocations must be separated by at least one hour. Format of @@ -1200,9 +1187,22 @@ type ScheduledAction struct { // in the Amazon CloudWatch Events User Guide. Schedule *string + // The description of the scheduled action. + ScheduledActionDescription *string + + // The name of the scheduled action. + ScheduledActionName *string + // The start time in UTC when the schedule is active. Before this time, the // scheduled action does not trigger. StartTime *time.Time + + // The state of the scheduled action. For example, DISABLED. + State ScheduledActionState + + // A JSON format string of the Amazon Redshift API operation with input parameters. + // "{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}". + TargetAction *ScheduledActionType } // A set of elements to filter the returned scheduled actions. @@ -1224,63 +1224,18 @@ type ScheduledActionFilter struct { // supported by the Amazon Redshift scheduler. type ScheduledActionType struct { + // An action that runs a PauseCluster API operation. + PauseCluster *PauseClusterMessage + // An action that runs a ResizeCluster API operation. ResizeCluster *ResizeClusterMessage // An action that runs a ResumeCluster API operation. ResumeCluster *ResumeClusterMessage - - // An action that runs a PauseCluster API operation. - PauseCluster *PauseClusterMessage } // Describes a snapshot. -type Snapshot struct { - - // A boolean that indicates whether the snapshot data is encrypted using the HSM - // keys of the source cluster. true indicates that the data is encrypted using HSM - // keys. - EncryptedWithHSM *bool - - // The version ID of the Amazon Redshift engine that is running on the cluster. - ClusterVersion *string - - // The name of the maintenance track for the snapshot. - MaintenanceTrackName *string - - // The estimate of the time remaining before the snapshot backup will complete. - // Returns 0 for a completed backup. - EstimatedSecondsToCompletion *int64 - - // The amount of time an in-progress snapshot backup has been running, or the - // amount of time it took a completed backup to finish. - ElapsedTimeInSeconds *int64 - - // The number of megabytes per second being transferred to the snapshot backup. - // Returns 0 for a completed backup. - CurrentBackupRateInMegaBytesPerSecond *float64 - - // The number of days until a manual snapshot will pass its retention period. - ManualSnapshotRemainingDays *int32 - - // The snapshot status. The value of the status depends on the API operation - // used: - // - // * CreateClusterSnapshot () and CopyClusterSnapshot () returns status - // as "creating". - // - // * DescribeClusterSnapshots () returns status as "creating", - // "available", "final snapshot", or "failed". - // - // * DeleteClusterSnapshot () - // returns status as "deleted". - Status *string - - // The identifier of the cluster for which the snapshot was taken. - ClusterIdentifier *string - - // The number of megabytes that have been transferred to the snapshot backup. - BackupProgressInMegaBytes *float64 +type Snapshot struct { // A list of the AWS customer accounts authorized to restore the snapshot. Returns // null if no accounts are authorized. Visible only to the snapshot owner. @@ -1289,17 +1244,39 @@ type Snapshot struct { // The size of the incremental backup. ActualIncrementalBackupSizeInMegaBytes *float64 - // The number of nodes in the cluster. - NumberOfNodes *int32 + // The Availability Zone in which the cluster was created. + AvailabilityZone *string - // The number of days that a manual snapshot is retained. If the value is -1, the - // manual snapshot is retained indefinitely.

    The value must be either -1 or an - // integer between 1 and 3,653.

    - ManualSnapshotRetentionPeriod *int32 + // The number of megabytes that have been transferred to the snapshot backup. + BackupProgressInMegaBytes *float64 - // The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot - // contains a copy of the cluster data as of this exact time. - SnapshotCreateTime *time.Time + // The time (UTC) when the cluster was originally created. + ClusterCreateTime *time.Time + + // The identifier of the cluster for which the snapshot was taken. + ClusterIdentifier *string + + // The version ID of the Amazon Redshift engine that is running on the cluster. + ClusterVersion *string + + // The number of megabytes per second being transferred to the snapshot backup. + // Returns 0 for a completed backup. + CurrentBackupRateInMegaBytesPerSecond *float64 + + // The name of the database that was created when the cluster was created. + DBName *string + + // The amount of time an in-progress snapshot backup has been running, or the + // amount of time it took a completed backup to finish. + ElapsedTimeInSeconds *int64 + + // If true, the data in the snapshot is encrypted at rest. + Encrypted *bool + + // A boolean that indicates whether the snapshot data is encrypted using the HSM + // keys of the source cluster. true indicates that the data is encrypted using HSM + // keys. + EncryptedWithHSM *bool // An option that specifies whether to create the cluster with enhanced VPC routing // enabled. To create a cluster that uses enhanced VPC routing, the cluster must be @@ -1309,62 +1286,85 @@ type Snapshot struct { // VPC routing is enabled. Default: false EnhancedVpcRouting *bool + // The estimate of the time remaining before the snapshot backup will complete. + // Returns 0 for a completed backup. + EstimatedSecondsToCompletion *int64 + // The AWS Key Management Service (KMS) key ID of the encryption key that was used // to encrypt data in the cluster from which the snapshot was taken. KmsKeyId *string - // The source region from which the snapshot was copied. - SourceRegion *string + // The name of the maintenance track for the snapshot. + MaintenanceTrackName *string - // The name of the database that was created when the cluster was created. - DBName *string + // The number of days until a manual snapshot will pass its retention period. + ManualSnapshotRemainingDays *int32 + + // The number of days that a manual snapshot is retained. If the value is -1, the + // manual snapshot is retained indefinitely.

    The value must be either -1 or an + // integer between 1 and 3,653.

    + ManualSnapshotRetentionPeriod *int32 // The master user name for the cluster. MasterUsername *string - // The Availability Zone in which the cluster was created. - AvailabilityZone *string + // The node type of the nodes in the cluster. + NodeType *string - // The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. - // Otherwise, this field is not in the output. - VpcId *string + // The number of nodes in the cluster. + NumberOfNodes *int32 - // If true, the data in the snapshot is encrypted at rest. - Encrypted *bool + // For manual snapshots, the AWS customer account used to create or copy the + // snapshot. For automatic snapshots, the owner of the cluster. The owner can + // perform all snapshot actions, such as sharing a manual snapshot. + OwnerAccount *string - // The snapshot identifier that is provided in the request. - SnapshotIdentifier *string + // The port that the cluster is listening on. + Port *int32 // The list of node types that this cluster snapshot is able to restore into. RestorableNodeTypes []*string - // The port that the cluster is listening on. - Port *int32 + // The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot + // contains a copy of the cluster data as of this exact time. + SnapshotCreateTime *time.Time - // The size of the complete set of backup data that would be used to restore the - // cluster. - TotalBackupSizeInMegaBytes *float64 + // The snapshot identifier that is provided in the request. + SnapshotIdentifier *string - // The time (UTC) when the cluster was originally created. - ClusterCreateTime *time.Time + // A timestamp representing the start of the retention period for the snapshot. + SnapshotRetentionStartTime *time.Time // The snapshot type. Snapshots created using CreateClusterSnapshot () and // CopyClusterSnapshot () are of type "manual". SnapshotType *string - // The node type of the nodes in the cluster. - NodeType *string + // The source region from which the snapshot was copied. + SourceRegion *string + + // The snapshot status. The value of the status depends on the API operation + // used: + // + // * CreateClusterSnapshot () and CopyClusterSnapshot () returns status + // as "creating". + // + // * DescribeClusterSnapshots () returns status as "creating", + // "available", "final snapshot", or "failed". + // + // * DeleteClusterSnapshot () + // returns status as "deleted". + Status *string // The list of tags for the cluster snapshot. Tags []*Tag - // For manual snapshots, the AWS customer account used to create or copy the - // snapshot. For automatic snapshots, the owner of the cluster. The owner can - // perform all snapshot actions, such as sharing a manual snapshot. - OwnerAccount *string + // The size of the complete set of backup data that would be used to restore the + // cluster. + TotalBackupSizeInMegaBytes *float64 - // A timestamp representing the start of the retention period for the snapshot. - SnapshotRetentionStartTime *time.Time + // The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. + // Otherwise, this field is not in the output. + VpcId *string } // The snapshot copy grant that grants Amazon Redshift permission to encrypt copied @@ -1375,58 +1375,58 @@ type Snapshot struct { // in the Amazon Redshift Cluster Management Guide. type SnapshotCopyGrant struct { - // A list of tag instances. - Tags []*Tag + // The unique identifier of the customer master key (CMK) in AWS KMS to which + // Amazon Redshift is granted permission. + KmsKeyId *string // The name of the snapshot copy grant. SnapshotCopyGrantName *string - // The unique identifier of the customer master key (CMK) in AWS KMS to which - // Amazon Redshift is granted permission. - KmsKeyId *string + // A list of tag instances. + Tags []*Tag } // Describes the errors returned by a snapshot. type SnapshotErrorMessage struct { + // The failure code for the error. + FailureCode *string + // The text message describing the error. FailureReason *string - // A unique identifier for the snapshot returning the error. - SnapshotIdentifier *string - // A unique identifier for the cluster. SnapshotClusterIdentifier *string - // The failure code for the error. - FailureCode *string + // A unique identifier for the snapshot returning the error. + SnapshotIdentifier *string } // Describes a snapshot schedule. You can set a regular interval for creating // snapshots of a cluster. You can also schedule snapshots for specific dates. type SnapshotSchedule struct { - // - NextInvocations []*time.Time + // The number of clusters associated with the schedule. + AssociatedClusterCount *int32 // A list of clusters associated with the schedule. A maximum of 100 clusters is // returned. AssociatedClusters []*ClusterAssociatedToSchedule - // The number of clusters associated with the schedule. - AssociatedClusterCount *int32 + // + NextInvocations []*time.Time + + // A list of ScheduleDefinitions. + ScheduleDefinitions []*string + + // The description of the schedule. + ScheduleDescription *string // A unique identifier for the schedule. ScheduleIdentifier *string // An optional set of tags describing the schedule. Tags []*Tag - - // The description of the schedule. - ScheduleDescription *string - - // A list of ScheduleDefinitions. - ScheduleDefinitions []*string } // Describes a sorting entity @@ -1471,36 +1471,30 @@ type SupportedPlatform struct { // Describes the status of a RestoreTableFromClusterSnapshot () operation. type TableRestoreStatus struct { - // The name of the schema to restore the table to. - TargetSchemaName *string - - // The total amount of data to restore to the new table, in megabytes (MB). - TotalDataInMegaBytes *int64 - - // The name of the database to restore the table to. - TargetDatabaseName *string - - // The identifier of the snapshot that the table is being restored from. - SnapshotIdentifier *string - // The identifier of the Amazon Redshift cluster that the table is being restored // to. ClusterIdentifier *string + // A description of the status of the table restore request. Status values include + // SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS. + Message *string + + // The name of the table to create as a result of the table restore request. + NewTableName *string + + // The amount of data restored to the new table so far, in megabytes (MB). + ProgressInMegaBytes *int64 + // The time that the table restore request was made, in Universal Coordinated Time // (UTC). RequestTime *time.Time - // The amount of data restored to the new table so far, in megabytes (MB). - ProgressInMegaBytes *int64 + // The identifier of the snapshot that the table is being restored from. + SnapshotIdentifier *string // The name of the source database that contains the table being restored. SourceDatabaseName *string - // A description of the status of the table restore request. Status values include - // SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS. - Message *string - // The name of the source schema that contains the table being restored. SourceSchemaName *string @@ -1514,26 +1508,29 @@ type TableRestoreStatus struct { // The unique identifier for the table restore request. TableRestoreRequestId *string - // The name of the table to create as a result of the table restore request. - NewTableName *string + // The name of the database to restore the table to. + TargetDatabaseName *string + + // The name of the schema to restore the table to. + TargetSchemaName *string + + // The total amount of data to restore to the new table, in megabytes (MB). + TotalDataInMegaBytes *int64 } // A tag consisting of a name/value pair for a resource. type Tag struct { - // The value for the resource tag. - Value *string - // The key, or name, for the resource tag. Key *string + + // The value for the resource tag. + Value *string } // A tag and its associated resource. type TaggedResource struct { - // The tag for the resource. - Tag *Tag - // The Amazon Resource Name (ARN) with which the tag is associated, for example: // arn:aws:redshift:us-east-2:123456789:cluster:t1. ResourceName *string @@ -1567,17 +1564,20 @@ type TaggedResource struct { // (https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-overview.html#redshift-iam-access-control-specify-actions) // in the Amazon Redshift Cluster Management Guide. ResourceType *string + + // The tag for the resource. + Tag *Tag } // A maintenance track that you can switch the current track to. type UpdateTarget struct { - // The name of the new maintenance track. - MaintenanceTrackName *string - // The cluster version for the new maintenance track. DatabaseVersion *string + // The name of the new maintenance track. + MaintenanceTrackName *string + // A list of operations supported by the maintenance track. SupportedOperations []*SupportedOperation } @@ -1585,18 +1585,9 @@ type UpdateTarget struct { // Describes a usage limit object for a cluster. type UsageLimit struct { - // The identifier of the cluster with a usage limit. - ClusterIdentifier *string - - // The Amazon Redshift feature to which the limit applies. - FeatureType UsageLimitFeatureType - - // A list of tag instances. - Tags []*Tag - - // The type of limit. Depending on the feature type, this can be based on a time - // duration or data size. - LimitType UsageLimitLimitType + // The limit amount. If time-based, this amount is in minutes. If data-based, this + // amount is in terabytes (TB). + Amount *int64 // The action that Amazon Redshift takes when the limit is reached. Possible values // are: @@ -1610,24 +1601,33 @@ type UsageLimit struct { // feature until the next usage period begins. BreachAction UsageLimitBreachAction + // The identifier of the cluster with a usage limit. + ClusterIdentifier *string + + // The Amazon Redshift feature to which the limit applies. + FeatureType UsageLimitFeatureType + + // The type of limit. Depending on the feature type, this can be based on a time + // duration or data size. + LimitType UsageLimitLimitType + // The time period that the amount applies to. A weekly period begins on Sunday. // The default is monthly. Period UsageLimitPeriod + // A list of tag instances. + Tags []*Tag + // The identifier of the usage limit. UsageLimitId *string - - // The limit amount. If time-based, this amount is in minutes. If data-based, this - // amount is in terabytes (TB). - Amount *int64 } // Describes the members of a VPC security group. type VpcSecurityGroupMembership struct { - // The identifier of the VPC security group. - VpcSecurityGroupId *string - // The status of the VPC security group. Status *string + + // The identifier of the VPC security group. + VpcSecurityGroupId *string } diff --git a/service/rekognition/api_op_CompareFaces.go b/service/rekognition/api_op_CompareFaces.go index 9c12da76826..04c7d5eeccd 100644 --- a/service/rekognition/api_op_CompareFaces.go +++ b/service/rekognition/api_op_CompareFaces.go @@ -104,6 +104,15 @@ type CompareFacesInput struct { // This member is required. SourceImage *types.Image + // The target image as base64-encoded bytes or an S3 object. If you use the AWS CLI + // to call Amazon Rekognition operations, passing base64-encoded image bytes is not + // supported. If you are using an AWS SDK to call Amazon Rekognition, you might not + // need to base64-encode image bytes passed using the Bytes field. For more + // information, see Images in the Amazon Rekognition developer guide. + // + // This member is required. + TargetImage *types.Image + // A filter that specifies a quality bar for how much filtering is done to identify // faces. Filtered faces aren't compared. If you specify AUTO, Amazon Rekognition // chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes @@ -116,15 +125,6 @@ type CompareFacesInput struct { // using must be associated with version 3 of the face model or higher.

    QualityFilter types.QualityFilter - // The target image as base64-encoded bytes or an S3 object. If you use the AWS CLI - // to call Amazon Rekognition operations, passing base64-encoded image bytes is not - // supported. If you are using an AWS SDK to call Amazon Rekognition, you might not - // need to base64-encode image bytes passed using the Bytes field. For more - // information, see Images in the Amazon Rekognition developer guide. - // - // This member is required. - TargetImage *types.Image - // The minimum level of confidence in the face matches that a match must meet to be // included in the FaceMatches array. SimilarityThreshold *float32 @@ -132,7 +132,16 @@ type CompareFacesInput struct { type CompareFacesOutput struct { - // The value of TargetImageOrientationCorrection is always null. If the input image + // An array of faces in the target image that match the source image face. Each + // CompareFacesMatch object provides the bounding box, the confidence level that + // the bounding box contains a face, and the similarity score for the face in the + // bounding box and the face in the source image. + FaceMatches []*types.CompareFacesMatch + + // The face in the source image that was used for comparison. + SourceImageFace *types.ComparedSourceImageFace + + // The value of SourceImageOrientationCorrection is always null. If the input image // is in .jpeg format, it might contain exchangeable image file format (Exif) // metadata that includes the image's orientation. Amazon Rekognition uses this // orientation information to perform image correction. The bounding box @@ -143,21 +152,9 @@ type CompareFacesOutput struct { // orientation information in the image Exif metadata. The bounding box coordinates // aren't translated and represent the object locations before the image is // rotated. - TargetImageOrientationCorrection types.OrientationCorrection - - // The face in the source image that was used for comparison. - SourceImageFace *types.ComparedSourceImageFace - - // An array of faces in the target image that match the source image face. Each - // CompareFacesMatch object provides the bounding box, the confidence level that - // the bounding box contains a face, and the similarity score for the face in the - // bounding box and the face in the source image. - FaceMatches []*types.CompareFacesMatch - - // An array of faces in the target image that did not match the source image face. - UnmatchedFaces []*types.ComparedFace + SourceImageOrientationCorrection types.OrientationCorrection - // The value of SourceImageOrientationCorrection is always null. If the input image + // The value of TargetImageOrientationCorrection is always null. If the input image // is in .jpeg format, it might contain exchangeable image file format (Exif) // metadata that includes the image's orientation. Amazon Rekognition uses this // orientation information to perform image correction. The bounding box @@ -168,7 +165,10 @@ type CompareFacesOutput struct { // orientation information in the image Exif metadata. The bounding box coordinates // aren't translated and represent the object locations before the image is // rotated. - SourceImageOrientationCorrection types.OrientationCorrection + TargetImageOrientationCorrection types.OrientationCorrection + + // An array of faces in the target image that did not match the source image face. + UnmatchedFaces []*types.ComparedFace // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/rekognition/api_op_CreateCollection.go b/service/rekognition/api_op_CreateCollection.go index 7141838f71f..f10415fbb5f 100644 --- a/service/rekognition/api_op_CreateCollection.go +++ b/service/rekognition/api_op_CreateCollection.go @@ -71,14 +71,14 @@ type CreateCollectionInput struct { type CreateCollectionOutput struct { - // Version number of the face detection model associated with the collection you - // are creating. - FaceModelVersion *string - // Amazon Resource Name (ARN) of the collection. You can use this to manage // permissions on your resources. CollectionArn *string + // Version number of the face detection model associated with the collection you + // are creating. + FaceModelVersion *string + // HTTP status code indicating the result of the operation. StatusCode *int32 diff --git a/service/rekognition/api_op_CreateProjectVersion.go b/service/rekognition/api_op_CreateProjectVersion.go index d15c223b6dc..115bb2f1fd7 100644 --- a/service/rekognition/api_op_CreateProjectVersion.go +++ b/service/rekognition/api_op_CreateProjectVersion.go @@ -70,26 +70,26 @@ type CreateProjectVersionInput struct { // This member is required. OutputConfig *types.OutputConfig - // A name for the version of the model. This value must be unique. - // - // This member is required. - VersionName *string - // The ARN of the Amazon Rekognition Custom Labels project that manages the model // that you want to train. // // This member is required. ProjectArn *string + // The dataset to use for testing. + // + // This member is required. + TestingData *types.TestingData + // The dataset to use for training. // // This member is required. TrainingData *types.TrainingData - // The dataset to use for testing. + // A name for the version of the model. This value must be unique. // // This member is required. - TestingData *types.TestingData + VersionName *string } type CreateProjectVersionOutput struct { diff --git a/service/rekognition/api_op_CreateStreamProcessor.go b/service/rekognition/api_op_CreateStreamProcessor.go index c640bcf979f..0b3edebca3c 100644 --- a/service/rekognition/api_op_CreateStreamProcessor.go +++ b/service/rekognition/api_op_CreateStreamProcessor.go @@ -68,11 +68,11 @@ func (c *Client) CreateStreamProcessor(ctx context.Context, params *CreateStream type CreateStreamProcessorInput struct { - // Face recognition input parameters to be used by the stream processor. Includes - // the collection to use for face recognition and the face attributes to detect. + // Kinesis video stream stream that provides the source streaming video. If you are + // using the AWS CLI, the parameter name is StreamProcessorInput. // // This member is required. - Settings *types.StreamProcessorSettings + Input *types.StreamProcessorInput // An identifier you assign to the stream processor. You can use Name to manage the // stream processor. For example, you can get the current status of the stream @@ -88,16 +88,16 @@ type CreateStreamProcessorInput struct { // This member is required. Output *types.StreamProcessorOutput - // Kinesis video stream stream that provides the source streaming video. If you are - // using the AWS CLI, the parameter name is StreamProcessorInput. + // ARN of the IAM role that allows access to the stream processor. // // This member is required. - Input *types.StreamProcessorInput + RoleArn *string - // ARN of the IAM role that allows access to the stream processor. + // Face recognition input parameters to be used by the stream processor. Includes + // the collection to use for face recognition and the face attributes to detect. // // This member is required. - RoleArn *string + Settings *types.StreamProcessorSettings } type CreateStreamProcessorOutput struct { diff --git a/service/rekognition/api_op_DescribeCollection.go b/service/rekognition/api_op_DescribeCollection.go index 3fe225ee189..026304bc549 100644 --- a/service/rekognition/api_op_DescribeCollection.go +++ b/service/rekognition/api_op_DescribeCollection.go @@ -69,23 +69,23 @@ type DescribeCollectionInput struct { type DescribeCollectionOutput struct { + // The Amazon Resource Name (ARN) of the collection. + CollectionARN *string + // The number of milliseconds since the Unix epoch time until the creation of the // collection. The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), // Thursday, 1 January 1970. CreationTimestamp *time.Time - // The Amazon Resource Name (ARN) of the collection. - CollectionARN *string + // The number of faces that are indexed into the collection. To index faces into a + // collection, use IndexFaces (). + FaceCount *int64 // The version of the face model that's used by the collection for face detection. //

    For more information, see Model Versioning in the Amazon Rekognition // Developer Guide.

    FaceModelVersion *string - // The number of faces that are indexed into the collection. To index faces into a - // collection, use IndexFaces (). - FaceCount *int64 - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/rekognition/api_op_DescribeProjectVersions.go b/service/rekognition/api_op_DescribeProjectVersions.go index 7e309f14cf8..23bf83aeed0 100644 --- a/service/rekognition/api_op_DescribeProjectVersions.go +++ b/service/rekognition/api_op_DescribeProjectVersions.go @@ -60,21 +60,21 @@ func (c *Client) DescribeProjectVersions(ctx context.Context, params *DescribePr type DescribeProjectVersionsInput struct { - // If the previous response was incomplete (because there is more results to - // retrieve), Amazon Rekognition Custom Labels returns a pagination token in the - // response. You can use this pagination token to retrieve the next set of results. - NextToken *string + // The Amazon Resource Name (ARN) of the project that contains the models you want + // to describe. + // + // This member is required. + ProjectArn *string // The maximum number of results to return per paginated call. The largest value // you can specify is 100. If you specify a value greater than 100, a // ValidationException error occurs. The default value is 100. MaxResults *int32 - // The Amazon Resource Name (ARN) of the project that contains the models you want - // to describe. - // - // This member is required. - ProjectArn *string + // If the previous response was incomplete (because there is more results to + // retrieve), Amazon Rekognition Custom Labels returns a pagination token in the + // response. You can use this pagination token to retrieve the next set of results. + NextToken *string // A list of model version names that you want to describe. You can add up to 10 // model version names to the list. If you don't specify a value, all model diff --git a/service/rekognition/api_op_DescribeProjects.go b/service/rekognition/api_op_DescribeProjects.go index 0e7486bbfdb..39b52064236 100644 --- a/service/rekognition/api_op_DescribeProjects.go +++ b/service/rekognition/api_op_DescribeProjects.go @@ -58,28 +58,28 @@ func (c *Client) DescribeProjects(ctx context.Context, params *DescribeProjectsI type DescribeProjectsInput struct { - // If the previous response was incomplete (because there is more results to - // retrieve), Amazon Rekognition Custom Labels returns a pagination token in the - // response. You can use this pagination token to retrieve the next set of results. - NextToken *string - // The maximum number of results to return per paginated call. The largest value // you can specify is 100. If you specify a value greater than 100, a // ValidationException error occurs. The default value is 100. MaxResults *int32 + + // If the previous response was incomplete (because there is more results to + // retrieve), Amazon Rekognition Custom Labels returns a pagination token in the + // response. You can use this pagination token to retrieve the next set of results. + NextToken *string } type DescribeProjectsOutput struct { - // A list of project descriptions. The list is sorted by the date and time the - // projects are created. - ProjectDescriptions []*types.ProjectDescription - // If the previous response was incomplete (because there is more results to // retrieve), Amazon Rekognition Custom Labels returns a pagination token in the // response. You can use this pagination token to retrieve the next set of results. NextToken *string + // A list of project descriptions. The list is sorted by the date and time the + // projects are created. + ProjectDescriptions []*types.ProjectDescription + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/rekognition/api_op_DescribeStreamProcessor.go b/service/rekognition/api_op_DescribeStreamProcessor.go index acbdbe04b2e..3c69f1c496e 100644 --- a/service/rekognition/api_op_DescribeStreamProcessor.go +++ b/service/rekognition/api_op_DescribeStreamProcessor.go @@ -69,40 +69,40 @@ type DescribeStreamProcessorInput struct { type DescribeStreamProcessorOutput struct { - // ARN of the IAM role that allows access to the stream processor. - RoleArn *string + // Date and time the stream processor was created + CreationTimestamp *time.Time + + // Kinesis video stream that provides the source streaming video. + Input *types.StreamProcessorInput // The time, in Unix format, the stream processor was last updated. For example, // when the stream processor moves from a running state to a failed state, or when // the user starts or stops the stream processor. LastUpdateTimestamp *time.Time - // Current status of the stream processor. - Status types.StreamProcessorStatus + // Name of the stream processor. + Name *string - // Kinesis video stream that provides the source streaming video. - Input *types.StreamProcessorInput + // Kinesis data stream to which Amazon Rekognition Video puts the analysis results. + Output *types.StreamProcessorOutput - // Detailed status message about the stream processor. - StatusMessage *string + // ARN of the IAM role that allows access to the stream processor. + RoleArn *string // Face recognition input parameters that are being used by the stream processor. // Includes the collection to use for face recognition and the face attributes to // detect. Settings *types.StreamProcessorSettings - // Name of the stream processor. - Name *string + // Current status of the stream processor. + Status types.StreamProcessorStatus - // Date and time the stream processor was created - CreationTimestamp *time.Time + // Detailed status message about the stream processor. + StatusMessage *string // ARN of the stream processor. StreamProcessorArn *string - // Kinesis data stream to which Amazon Rekognition Video puts the analysis results. - Output *types.StreamProcessorOutput - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/rekognition/api_op_DetectCustomLabels.go b/service/rekognition/api_op_DetectCustomLabels.go index f51b05b98c3..92c7f1f6fbc 100644 --- a/service/rekognition/api_op_DetectCustomLabels.go +++ b/service/rekognition/api_op_DetectCustomLabels.go @@ -78,17 +78,6 @@ func (c *Client) DetectCustomLabels(ctx context.Context, params *DetectCustomLab type DetectCustomLabelsInput struct { - // Specifies the minimum confidence level for the labels to return. Amazon - // Rekognition doesn't return any labels with a confidence lower than this - // specified value. If you specify a value of 0, all labels are return, regardless - // of the default thresholds that the model version applies. - MinConfidence *float32 - - // Maximum number of results you want the service to return in the response. The - // service returns the specified number of highest confidence labels ranked from - // highest confidence to lowest. - MaxResults *int32 - // Provides the input image either as bytes or an S3 object. You pass image bytes // to an Amazon Rekognition API operation by using the Bytes property. For example, // you would use the Bytes property to pass an image loaded from a local file @@ -114,6 +103,17 @@ type DetectCustomLabelsInput struct { // // This member is required. ProjectVersionArn *string + + // Maximum number of results you want the service to return in the response. The + // service returns the specified number of highest confidence labels ranked from + // highest confidence to lowest. + MaxResults *int32 + + // Specifies the minimum confidence level for the labels to return. Amazon + // Rekognition doesn't return any labels with a confidence lower than this + // specified value. If you specify a value of 0, all labels are return, regardless + // of the default thresholds that the model version applies. + MinConfidence *float32 } type DetectCustomLabelsOutput struct { diff --git a/service/rekognition/api_op_DetectFaces.go b/service/rekognition/api_op_DetectFaces.go index 072b311a2e3..3506bbcb2ee 100644 --- a/service/rekognition/api_op_DetectFaces.go +++ b/service/rekognition/api_op_DetectFaces.go @@ -71,6 +71,15 @@ func (c *Client) DetectFaces(ctx context.Context, params *DetectFacesInput, optF type DetectFacesInput struct { + // The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI + // to call Amazon Rekognition operations, passing base64-encoded image bytes is not + // supported. If you are using an AWS SDK to call Amazon Rekognition, you might not + // need to base64-encode image bytes passed using the Bytes field. For more + // information, see Images in the Amazon Rekognition developer guide. + // + // This member is required. + Image *types.Image + // An array of facial attributes you want to be returned. This can be the default // list of attributes or all attributes. If you don't specify a value for // Attributes or if you specify ["DEFAULT"], the API returns the following subset @@ -80,19 +89,13 @@ type DetectFacesInput struct { // logical AND operator to determine which attributes to return (in this case, all // attributes). Attributes []types.Attribute - - // The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI - // to call Amazon Rekognition operations, passing base64-encoded image bytes is not - // supported. If you are using an AWS SDK to call Amazon Rekognition, you might not - // need to base64-encode image bytes passed using the Bytes field. For more - // information, see Images in the Amazon Rekognition developer guide. - // - // This member is required. - Image *types.Image } type DetectFacesOutput struct { + // Details of each face found in the image. + FaceDetails []*types.FaceDetail + // The value of OrientationCorrection is always null. If the input image is in // .jpeg format, it might contain exchangeable image file format (Exif) metadata // that includes the image's orientation. Amazon Rekognition uses this orientation @@ -105,9 +108,6 @@ type DetectFacesOutput struct { // translated and represent the object locations before the image is rotated. OrientationCorrection types.OrientationCorrection - // Details of each face found in the image. - FaceDetails []*types.FaceDetail - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/rekognition/api_op_DetectLabels.go b/service/rekognition/api_op_DetectLabels.go index 405306d1f2d..f1597eddeba 100644 --- a/service/rekognition/api_op_DetectLabels.go +++ b/service/rekognition/api_op_DetectLabels.go @@ -112,19 +112,25 @@ type DetectLabelsInput struct { // This member is required. Image *types.Image + // Maximum number of labels you want the service to return in the response. The + // service returns the specified number of highest confidence labels. + MaxLabels *int32 + // Specifies the minimum confidence level for the labels to return. Amazon // Rekognition doesn't return any labels with confidence lower than this specified // value. If MinConfidence is not specified, the operation returns labels with a // confidence values greater than or equal to 55 percent. MinConfidence *float32 - - // Maximum number of labels you want the service to return in the response. The - // service returns the specified number of highest confidence labels. - MaxLabels *int32 } type DetectLabelsOutput struct { + // Version number of the label detection model that was used to detect labels. + LabelModelVersion *string + + // An array of labels for the real-world objects detected. + Labels []*types.Label + // The value of OrientationCorrection is always null. If the input image is in // .jpeg format, it might contain exchangeable image file format (Exif) metadata // that includes the image's orientation. Amazon Rekognition uses this orientation @@ -137,12 +143,6 @@ type DetectLabelsOutput struct { // translated and represent the object locations before the image is rotated. OrientationCorrection types.OrientationCorrection - // Version number of the label detection model that was used to detect labels. - LabelModelVersion *string - - // An array of labels for the real-world objects detected. - Labels []*types.Label - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/rekognition/api_op_DetectModerationLabels.go b/service/rekognition/api_op_DetectModerationLabels.go index 7b1a3eaa98f..aa25562c3a5 100644 --- a/service/rekognition/api_op_DetectModerationLabels.go +++ b/service/rekognition/api_op_DetectModerationLabels.go @@ -92,14 +92,14 @@ type DetectModerationLabelsOutput struct { // Shows the results of the human in the loop evaluation. HumanLoopActivationOutput *types.HumanLoopActivationOutput - // Version number of the moderation detection model that was used to detect unsafe - // content. - ModerationModelVersion *string - // Array of detected Moderation labels and the time, in milliseconds from the start // of the video, they were detected. ModerationLabels []*types.ModerationLabel + // Version number of the moderation detection model that was used to detect unsafe + // content. + ModerationModelVersion *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/rekognition/api_op_DetectText.go b/service/rekognition/api_op_DetectText.go index 5a3cd339981..8c12e4f3fa7 100644 --- a/service/rekognition/api_op_DetectText.go +++ b/service/rekognition/api_op_DetectText.go @@ -77,10 +77,6 @@ func (c *Client) DetectText(ctx context.Context, params *DetectTextInput, optFns type DetectTextInput struct { - // Optional parameters that let you set the criteria that the text must meet to be - // included in your response. - Filters *types.DetectTextFilters - // The input image as base64-encoded bytes or an Amazon S3 object. If you use the // AWS CLI to call Amazon Rekognition operations, you can't pass image bytes. If // you are using an AWS SDK to call Amazon Rekognition, you might not need to @@ -89,16 +85,20 @@ type DetectTextInput struct { // // This member is required. Image *types.Image + + // Optional parameters that let you set the criteria that the text must meet to be + // included in your response. + Filters *types.DetectTextFilters } type DetectTextOutput struct { - // The model version used to detect text. - TextModelVersion *string - // An array of text that was detected in the input image. TextDetections []*types.TextDetection + // The model version used to detect text. + TextModelVersion *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/rekognition/api_op_GetCelebrityRecognition.go b/service/rekognition/api_op_GetCelebrityRecognition.go index 25e4cd947f6..f048f114231 100644 --- a/service/rekognition/api_op_GetCelebrityRecognition.go +++ b/service/rekognition/api_op_GetCelebrityRecognition.go @@ -93,10 +93,11 @@ func (c *Client) GetCelebrityRecognition(ctx context.Context, params *GetCelebri type GetCelebrityRecognitionInput struct { - // Sort to use for celebrities returned in Celebrities field. Specify ID to sort by - // the celebrity identifier, specify TIMESTAMP to sort by the time the celebrity - // was recognized. - SortBy types.CelebrityRecognitionSortBy + // Job identifier for the required celebrity recognition analysis. You can get the + // job identifer from a call to StartCelebrityRecognition. + // + // This member is required. + JobId *string // Maximum number of results to return per paginated call. The largest value you // can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 @@ -109,11 +110,10 @@ type GetCelebrityRecognitionInput struct { // celebrities. NextToken *string - // Job identifier for the required celebrity recognition analysis. You can get the - // job identifer from a call to StartCelebrityRecognition. - // - // This member is required. - JobId *string + // Sort to use for celebrities returned in Celebrities field. Specify ID to sort by + // the celebrity identifier, specify TIMESTAMP to sort by the time the celebrity + // was recognized. + SortBy types.CelebrityRecognitionSortBy } type GetCelebrityRecognitionOutput struct { @@ -121,13 +121,13 @@ type GetCelebrityRecognitionOutput struct { // Array of celebrities recognized in the video. Celebrities []*types.CelebrityRecognition + // The current status of the celebrity recognition job. + JobStatus types.VideoJobStatus + // If the response is truncated, Amazon Rekognition Video returns this token that // you can use in the subsequent request to retrieve the next set of celebrities. NextToken *string - // The current status of the celebrity recognition job. - JobStatus types.VideoJobStatus - // If the job fails, StatusMessage provides a descriptive error message. StatusMessage *string diff --git a/service/rekognition/api_op_GetContentModeration.go b/service/rekognition/api_op_GetContentModeration.go index 601f7ef1544..fae7f97ffac 100644 --- a/service/rekognition/api_op_GetContentModeration.go +++ b/service/rekognition/api_op_GetContentModeration.go @@ -85,6 +85,12 @@ func (c *Client) GetContentModeration(ctx context.Context, params *GetContentMod type GetContentModerationInput struct { + // The identifier for the unsafe content job. Use JobId to identify the job in a + // subsequent call to GetContentModeration. + // + // This member is required. + JobId *string + // Maximum number of results to return per paginated call. The largest value you // can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 // results is returned. The default value is 1000. @@ -101,12 +107,6 @@ type GetContentModerationInput struct { // array element are sorted by detection confidence. The default sort is by // TIMESTAMP. SortBy types.ContentModerationSortBy - - // The identifier for the unsafe content job. Use JobId to identify the job in a - // subsequent call to GetContentModeration. - // - // This member is required. - JobId *string } type GetContentModerationOutput struct { @@ -117,22 +117,22 @@ type GetContentModerationOutput struct { // The detected unsafe content labels and the time(s) they were detected. ModerationLabels []*types.ContentModerationDetection + // Version number of the moderation detection model that was used to detect unsafe + // content. + ModerationModelVersion *string + // If the response is truncated, Amazon Rekognition Video returns this token that // you can use in the subsequent request to retrieve the next set of unsafe content // labels. NextToken *string - // Version number of the moderation detection model that was used to detect unsafe - // content. - ModerationModelVersion *string + // If the job fails, StatusMessage provides a descriptive error message. + StatusMessage *string // Information about a video that Amazon Rekognition analyzed. Videometadata is // returned in every page of paginated responses from GetContentModeration. VideoMetadata *types.VideoMetadata - // If the job fails, StatusMessage provides a descriptive error message. - StatusMessage *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/rekognition/api_op_GetFaceDetection.go b/service/rekognition/api_op_GetFaceDetection.go index 3d158af69a7..c22dae9d4ae 100644 --- a/service/rekognition/api_op_GetFaceDetection.go +++ b/service/rekognition/api_op_GetFaceDetection.go @@ -73,11 +73,6 @@ func (c *Client) GetFaceDetection(ctx context.Context, params *GetFaceDetectionI type GetFaceDetectionInput struct { - // If the previous response was incomplete (because there are more faces to - // retrieve), Amazon Rekognition Video returns a pagination token in the response. - // You can use this pagination token to retrieve the next set of faces. - NextToken *string - // Unique identifier for the face detection job. The JobId is returned from // StartFaceDetection. // @@ -88,18 +83,15 @@ type GetFaceDetectionInput struct { // can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 // results is returned. The default value is 1000. MaxResults *int32 + + // If the previous response was incomplete (because there are more faces to + // retrieve), Amazon Rekognition Video returns a pagination token in the response. + // You can use this pagination token to retrieve the next set of faces. + NextToken *string } type GetFaceDetectionOutput struct { - // Information about a video that Amazon Rekognition Video analyzed. Videometadata - // is returned in every page of paginated responses from a Amazon Rekognition video - // operation. - VideoMetadata *types.VideoMetadata - - // If the job fails, StatusMessage provides a descriptive error message. - StatusMessage *string - // An array of faces detected in the video. Each element contains a detected face's // details and the time, in milliseconds from the start of the video, the face was // detected. @@ -112,6 +104,14 @@ type GetFaceDetectionOutput struct { // use in the subsequent request to retrieve the next set of faces. NextToken *string + // If the job fails, StatusMessage provides a descriptive error message. + StatusMessage *string + + // Information about a video that Amazon Rekognition Video analyzed. Videometadata + // is returned in every page of paginated responses from a Amazon Rekognition video + // operation. + VideoMetadata *types.VideoMetadata + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/rekognition/api_op_GetFaceSearch.go b/service/rekognition/api_op_GetFaceSearch.go index b16545bb495..4669ab2407a 100644 --- a/service/rekognition/api_op_GetFaceSearch.go +++ b/service/rekognition/api_op_GetFaceSearch.go @@ -82,9 +82,11 @@ func (c *Client) GetFaceSearch(ctx context.Context, params *GetFaceSearchInput, type GetFaceSearchInput struct { - // Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by - // the time that they are recognized. Use INDEX to sort by recognized faces. - SortBy types.FaceSearchSortBy + // The job identifer for the search request. You get the job identifier from an + // initial call to StartFaceSearch. + // + // This member is required. + JobId *string // Maximum number of results to return per paginated call. The largest value you // can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 @@ -96,23 +98,13 @@ type GetFaceSearchInput struct { // You can use this pagination token to retrieve the next set of search results. NextToken *string - // The job identifer for the search request. You get the job identifier from an - // initial call to StartFaceSearch. - // - // This member is required. - JobId *string + // Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by + // the time that they are recognized. Use INDEX to sort by recognized faces. + SortBy types.FaceSearchSortBy } type GetFaceSearchOutput struct { - // If the job fails, StatusMessage provides a descriptive error message. - StatusMessage *string - - // Information about a video that Amazon Rekognition analyzed. Videometadata is - // returned in every page of paginated responses from a Amazon Rekognition Video - // operation. - VideoMetadata *types.VideoMetadata - // The current status of the face search job. JobStatus types.VideoJobStatus @@ -129,6 +121,14 @@ type GetFaceSearchOutput struct { // collection, and person information (Person) for the matched person. Persons []*types.PersonMatch + // If the job fails, StatusMessage provides a descriptive error message. + StatusMessage *string + + // Information about a video that Amazon Rekognition analyzed. Videometadata is + // returned in every page of paginated responses from a Amazon Rekognition Video + // operation. + VideoMetadata *types.VideoMetadata + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/rekognition/api_op_GetLabelDetection.go b/service/rekognition/api_op_GetLabelDetection.go index a67cf20549b..63a59d3dc11 100644 --- a/service/rekognition/api_op_GetLabelDetection.go +++ b/service/rekognition/api_op_GetLabelDetection.go @@ -87,12 +87,6 @@ type GetLabelDetectionInput struct { // This member is required. JobId *string - // Sort to use for elements in the Labels array. Use TIMESTAMP to sort array - // elements by the time labels are detected. Use NAME to alphabetically group - // elements for a label together. Within each label group, the array element are - // sorted by detection confidence. The default sort is by TIMESTAMP. - SortBy types.LabelDetectionSortBy - // Maximum number of results to return per paginated call. The largest value you // can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 // results is returned. The default value is 1000. @@ -102,24 +96,30 @@ type GetLabelDetectionInput struct { // retrieve), Amazon Rekognition Video returns a pagination token in the response. // You can use this pagination token to retrieve the next set of labels. NextToken *string + + // Sort to use for elements in the Labels array. Use TIMESTAMP to sort array + // elements by the time labels are detected. Use NAME to alphabetically group + // elements for a label together. Within each label group, the array element are + // sorted by detection confidence. The default sort is by TIMESTAMP. + SortBy types.LabelDetectionSortBy } type GetLabelDetectionOutput struct { + // The current status of the label detection job. + JobStatus types.VideoJobStatus + // Version number of the label detection model that was used to detect labels. LabelModelVersion *string - // If the response is truncated, Amazon Rekognition Video returns this token that - // you can use in the subsequent request to retrieve the next set of labels. - NextToken *string - // An array of labels detected in the video. Each element contains the detected // label and the time, in milliseconds from the start of the video, that the label // was detected. Labels []*types.LabelDetection - // The current status of the label detection job. - JobStatus types.VideoJobStatus + // If the response is truncated, Amazon Rekognition Video returns this token that + // you can use in the subsequent request to retrieve the next set of labels. + NextToken *string // If the job fails, StatusMessage provides a descriptive error message. StatusMessage *string diff --git a/service/rekognition/api_op_GetPersonTracking.go b/service/rekognition/api_op_GetPersonTracking.go index 6486de428ab..edc4fcff4e4 100644 --- a/service/rekognition/api_op_GetPersonTracking.go +++ b/service/rekognition/api_op_GetPersonTracking.go @@ -82,12 +82,6 @@ func (c *Client) GetPersonTracking(ctx context.Context, params *GetPersonTrackin type GetPersonTrackingInput struct { - // Sort to use for elements in the Persons array. Use TIMESTAMP to sort array - // elements by the time persons are detected. Use INDEX to sort by the tracked - // persons. If you sort by INDEX, the array elements for each person are sorted by - // detection confidence. The default sort is by TIMESTAMP. - SortBy types.PersonTrackingSortBy - // The identifier for a job that tracks persons in a video. You get the JobId from // a call to StartPersonTracking. // @@ -103,6 +97,12 @@ type GetPersonTrackingInput struct { // retrieve), Amazon Rekognition Video returns a pagination token in the response. // You can use this pagination token to retrieve the next set of persons. NextToken *string + + // Sort to use for elements in the Persons array. Use TIMESTAMP to sort array + // elements by the time persons are detected. Use INDEX to sort by the tracked + // persons. If you sort by INDEX, the array elements for each person are sorted by + // detection confidence. The default sort is by TIMESTAMP. + SortBy types.PersonTrackingSortBy } type GetPersonTrackingOutput struct { @@ -119,14 +119,14 @@ type GetPersonTrackingOutput struct { // person's path is tracked. Persons []*types.PersonDetection + // If the job fails, StatusMessage provides a descriptive error message. + StatusMessage *string + // Information about a video that Amazon Rekognition Video analyzed. Videometadata // is returned in every page of paginated responses from a Amazon Rekognition Video // operation. VideoMetadata *types.VideoMetadata - // If the job fails, StatusMessage provides a descriptive error message. - StatusMessage *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/rekognition/api_op_GetSegmentDetection.go b/service/rekognition/api_op_GetSegmentDetection.go index ee08a4922d7..15f68898def 100644 --- a/service/rekognition/api_op_GetSegmentDetection.go +++ b/service/rekognition/api_op_GetSegmentDetection.go @@ -80,10 +80,6 @@ func (c *Client) GetSegmentDetection(ctx context.Context, params *GetSegmentDete type GetSegmentDetectionInput struct { - // Maximum number of results to return per paginated call. The largest value you - // can specify is 1000. - MaxResults *int32 - // Job identifier for the text detection operation for which you want results // returned. You get the job identifer from an initial call to // StartSegmentDetection. @@ -91,6 +87,10 @@ type GetSegmentDetectionInput struct { // This member is required. JobId *string + // Maximum number of results to return per paginated call. The largest value you + // can specify is 1000. + MaxResults *int32 + // If the response is truncated, Amazon Rekognition Video returns this token that // you can use in the subsequent request to retrieve the next set of text. NextToken *string @@ -98,11 +98,6 @@ type GetSegmentDetectionInput struct { type GetSegmentDetectionOutput struct { - // If the previous response was incomplete (because there are more labels to - // retrieve), Amazon Rekognition Video returns a pagination token in the response. - // You can use this pagination token to retrieve the next set of text. - NextToken *string - // An array of objects. There can be multiple audio streams. Each AudioMetadata // object contains metadata for a single audio stream. Audio information in an // AudioMetadata objects includes the audio codec, the number of audio channels, @@ -110,6 +105,14 @@ type GetSegmentDetectionOutput struct { // returned in each page of information returned by GetSegmentDetection. AudioMetadata []*types.AudioMetadata + // Current status of the segment detection job. + JobStatus types.VideoJobStatus + + // If the previous response was incomplete (because there are more labels to + // retrieve), Amazon Rekognition Video returns a pagination token in the response. + // You can use this pagination token to retrieve the next set of text. + NextToken *string + // An array of segments detected in a video. Segments []*types.SegmentDetection @@ -127,9 +130,6 @@ type GetSegmentDetectionOutput struct { // returned in each page of information returned by GetSegmentDetection. VideoMetadata []*types.VideoMetadata - // Current status of the segment detection job. - JobStatus types.VideoJobStatus - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/rekognition/api_op_GetTextDetection.go b/service/rekognition/api_op_GetTextDetection.go index 082ab04f90c..9639ca0e5e4 100644 --- a/service/rekognition/api_op_GetTextDetection.go +++ b/service/rekognition/api_op_GetTextDetection.go @@ -94,29 +94,29 @@ type GetTextDetectionInput struct { type GetTextDetectionOutput struct { + // Current status of the text detection job. + JobStatus types.VideoJobStatus + // If the response is truncated, Amazon Rekognition Video returns this token that // you can use in the subsequent request to retrieve the next set of text. NextToken *string - // Version number of the text detection model that was used to detect text. - TextModelVersion *string - // If the job fails, StatusMessage provides a descriptive error message. StatusMessage *string - // Information about a video that Amazon Rekognition analyzed. Videometadata is - // returned in every page of paginated responses from a Amazon Rekognition video - // operation. - VideoMetadata *types.VideoMetadata - - // Current status of the text detection job. - JobStatus types.VideoJobStatus - // An array of text detected in the video. Each element contains the detected text, // the time in milliseconds from the start of the video that the text was detected, // and where it was detected on the screen. TextDetections []*types.TextDetectionResult + // Version number of the text detection model that was used to detect text. + TextModelVersion *string + + // Information about a video that Amazon Rekognition analyzed. Videometadata is + // returned in every page of paginated responses from a Amazon Rekognition video + // operation. + VideoMetadata *types.VideoMetadata + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/rekognition/api_op_IndexFaces.go b/service/rekognition/api_op_IndexFaces.go index f0bfad2fc4f..0d4646d05a9 100644 --- a/service/rekognition/api_op_IndexFaces.go +++ b/service/rekognition/api_op_IndexFaces.go @@ -126,8 +126,14 @@ type IndexFacesInput struct { // This member is required. CollectionId *string - // The ID you want to assign to all the faces detected in the image. - ExternalImageId *string + // The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI + // to call Amazon Rekognition operations, passing base64-encoded image bytes isn't + // supported. If you are using an AWS SDK to call Amazon Rekognition, you might not + // need to base64-encode image bytes passed using the Bytes field. For more + // information, see Images in the Amazon Rekognition developer guide. + // + // This member is required. + Image *types.Image // An array of facial attributes that you want to be returned. This can be the // default list of attributes or all attributes. If you don't specify a value for @@ -139,26 +145,8 @@ type IndexFacesInput struct { // attributes). DetectionAttributes []types.Attribute - // The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI - // to call Amazon Rekognition operations, passing base64-encoded image bytes isn't - // supported. If you are using an AWS SDK to call Amazon Rekognition, you might not - // need to base64-encode image bytes passed using the Bytes field. For more - // information, see Images in the Amazon Rekognition developer guide. - // - // This member is required. - Image *types.Image - - // A filter that specifies a quality bar for how much filtering is done to identify - // faces. Filtered faces aren't indexed. If you specify AUTO, Amazon Rekognition - // chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes - // all faces that don’t meet the chosen quality bar. The default value is AUTO. - // The quality bar is based on a variety of common use cases. Low-quality - // detections can occur for a number of reasons. Some examples are an object that's - // misidentified as a face, a face that's too blurry, or a face with a pose that's - // too extreme to use. If you specify NONE, no filtering is performed. - //

    To use quality filtering, the collection you are using must be - // associated with version 3 of the face model or higher.

    - QualityFilter types.QualityFilter + // The ID you want to assign to all the faces detected in the image. + ExternalImageId *string // The maximum number of faces to index. The value of MaxFaces must be greater than // or equal to 1. IndexFaces returns no more than 100 detected faces in an image, @@ -172,20 +160,30 @@ type IndexFacesInput struct { // size, in descending order. MaxFaces can be used with a collection associated // with any version of the face model. MaxFaces *int32 + + // A filter that specifies a quality bar for how much filtering is done to identify + // faces. Filtered faces aren't indexed. If you specify AUTO, Amazon Rekognition + // chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes + // all faces that don’t meet the chosen quality bar. The default value is AUTO. + // The quality bar is based on a variety of common use cases. Low-quality + // detections can occur for a number of reasons. Some examples are an object that's + // misidentified as a face, a face that's too blurry, or a face with a pose that's + // too extreme to use. If you specify NONE, no filtering is performed. + //

    To use quality filtering, the collection you are using must be + // associated with version 3 of the face model or higher.

    + QualityFilter types.QualityFilter } type IndexFacesOutput struct { - // An array of faces that were detected in the image but weren't indexed. They - // weren't indexed because the quality filter identified them as low quality, or - // the MaxFaces request parameter filtered them out. To use the quality filter, you - // specify the QualityFilter request parameter. - UnindexedFaces []*types.UnindexedFace - // The version number of the face detection model that's associated with the input // collection (CollectionId). FaceModelVersion *string + // An array of faces detected and added to the collection. For more information, + // see Searching Faces in a Collection in the Amazon Rekognition Developer Guide. + FaceRecords []*types.FaceRecord + // If your collection is associated with a face detection model that's later than // version 3.0, the value of OrientationCorrection is always null and no // orientation information is returned.

    If your collection is associated with a @@ -207,9 +205,11 @@ type IndexFacesOutput struct { // DescribeCollection.

    OrientationCorrection types.OrientationCorrection - // An array of faces detected and added to the collection. For more information, - // see Searching Faces in a Collection in the Amazon Rekognition Developer Guide. - FaceRecords []*types.FaceRecord + // An array of faces that were detected in the image but weren't indexed. They + // weren't indexed because the quality filter identified them as low quality, or + // the MaxFaces request parameter filtered them out. To use the quality filter, you + // specify the QualityFilter request parameter. + UnindexedFaces []*types.UnindexedFace // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/rekognition/api_op_ListCollections.go b/service/rekognition/api_op_ListCollections.go index 85ecdeab41c..af9e2ef401f 100644 --- a/service/rekognition/api_op_ListCollections.go +++ b/service/rekognition/api_op_ListCollections.go @@ -60,19 +60,15 @@ func (c *Client) ListCollections(ctx context.Context, params *ListCollectionsInp type ListCollectionsInput struct { - // Pagination token from the previous response. - NextToken *string - // Maximum number of collection IDs to return. MaxResults *int32 + + // Pagination token from the previous response. + NextToken *string } type ListCollectionsOutput struct { - // If the result is truncated, the response provides a NextToken that you can use - // in the subsequent request to fetch the next set of collection IDs. - NextToken *string - // An array of collection IDs. CollectionIds []*string @@ -82,6 +78,10 @@ type ListCollectionsOutput struct { // CollectionId[2]. FaceModelVersions []*string + // If the result is truncated, the response provides a NextToken that you can use + // in the subsequent request to fetch the next set of collection IDs. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/rekognition/api_op_ListFaces.go b/service/rekognition/api_op_ListFaces.go index f3c87512773..d40da78a313 100644 --- a/service/rekognition/api_op_ListFaces.go +++ b/service/rekognition/api_op_ListFaces.go @@ -78,10 +78,6 @@ type ListFacesInput struct { type ListFacesOutput struct { - // If the response is truncated, Amazon Rekognition returns this token that you can - // use in the subsequent request to retrieve the next set of faces. - NextToken *string - // Version number of the face detection model associated with the input collection // (CollectionId). FaceModelVersion *string @@ -89,6 +85,10 @@ type ListFacesOutput struct { // An array of Face objects. Faces []*types.Face + // If the response is truncated, Amazon Rekognition returns this token that you can + // use in the subsequent request to retrieve the next set of faces. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/rekognition/api_op_ListStreamProcessors.go b/service/rekognition/api_op_ListStreamProcessors.go index 7dcf95508f7..1eee1db8554 100644 --- a/service/rekognition/api_op_ListStreamProcessors.go +++ b/service/rekognition/api_op_ListStreamProcessors.go @@ -57,15 +57,15 @@ func (c *Client) ListStreamProcessors(ctx context.Context, params *ListStreamPro type ListStreamProcessorsInput struct { + // Maximum number of stream processors you want Amazon Rekognition Video to return + // in the response. The default is 1000. + MaxResults *int32 + // If the previous response was incomplete (because there are more stream // processors to retrieve), Amazon Rekognition Video returns a pagination token in // the response. You can use this pagination token to retrieve the next set of // stream processors. NextToken *string - - // Maximum number of stream processors you want Amazon Rekognition Video to return - // in the response. The default is 1000. - MaxResults *int32 } type ListStreamProcessorsOutput struct { diff --git a/service/rekognition/api_op_RecognizeCelebrities.go b/service/rekognition/api_op_RecognizeCelebrities.go index b2882a6a166..342796faf1b 100644 --- a/service/rekognition/api_op_RecognizeCelebrities.go +++ b/service/rekognition/api_op_RecognizeCelebrities.go @@ -91,8 +91,9 @@ type RecognizeCelebritiesInput struct { type RecognizeCelebritiesOutput struct { - // Details about each unrecognized face in the image. - UnrecognizedFaces []*types.ComparedFace + // Details about each celebrity found in the image. Amazon Rekognition can detect a + // maximum of 15 celebrities in an image. + CelebrityFaces []*types.Celebrity // The orientation of the input image (counterclockwise direction). If your // application displays the image, you can use this value to correct the @@ -106,9 +107,8 @@ type RecognizeCelebritiesOutput struct { // the image orientation. Images in .png format don't contain Exif metadata. OrientationCorrection types.OrientationCorrection - // Details about each celebrity found in the image. Amazon Rekognition can detect a - // maximum of 15 celebrities in an image. - CelebrityFaces []*types.Celebrity + // Details about each unrecognized face in the image. + UnrecognizedFaces []*types.ComparedFace // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/rekognition/api_op_SearchFaces.go b/service/rekognition/api_op_SearchFaces.go index f21e022c94e..259ae68ec29 100644 --- a/service/rekognition/api_op_SearchFaces.go +++ b/service/rekognition/api_op_SearchFaces.go @@ -69,38 +69,38 @@ func (c *Client) SearchFaces(ctx context.Context, params *SearchFacesInput, optF type SearchFacesInput struct { - // ID of a face to find matches for in the collection. + // ID of the collection the face belongs to. // // This member is required. - FaceId *string - - // Maximum number of faces to return. The operation returns the maximum number of - // faces with the highest confidence in the match. - MaxFaces *int32 + CollectionId *string - // ID of the collection the face belongs to. + // ID of a face to find matches for in the collection. // // This member is required. - CollectionId *string + FaceId *string // Optional value specifying the minimum confidence in the face match to return. // For example, don't return any matches where confidence in matches is less than // 70%. The default value is 80%. FaceMatchThreshold *float32 + + // Maximum number of faces to return. The operation returns the maximum number of + // faces with the highest confidence in the match. + MaxFaces *int32 } type SearchFacesOutput struct { - // ID of the face that was searched for matches in a collection. - SearchedFaceId *string + // An array of faces that matched the input face, along with the confidence in the + // match. + FaceMatches []*types.FaceMatch // Version number of the face detection model associated with the input collection // (CollectionId). FaceModelVersion *string - // An array of faces that matched the input face, along with the confidence in the - // match. - FaceMatches []*types.FaceMatch + // ID of the face that was searched for matches in a collection. + SearchedFaceId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/rekognition/api_op_SearchFacesByImage.go b/service/rekognition/api_op_SearchFacesByImage.go index e0eb1050e06..eb88d2ce253 100644 --- a/service/rekognition/api_op_SearchFacesByImage.go +++ b/service/rekognition/api_op_SearchFacesByImage.go @@ -86,14 +86,10 @@ func (c *Client) SearchFacesByImage(ctx context.Context, params *SearchFacesByIm type SearchFacesByImageInput struct { - // Maximum number of faces to return. The operation returns the maximum number of - // faces with the highest confidence in the match. - MaxFaces *int32 - - // (Optional) Specifies the minimum confidence in the face match to return. For - // example, don't return any matches where confidence in matches is less than 70%. - // The default value is 80%. - FaceMatchThreshold *float32 + // ID of the collection to search. + // + // This member is required. + CollectionId *string // The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI // to call Amazon Rekognition operations, passing base64-encoded image bytes is not @@ -104,6 +100,15 @@ type SearchFacesByImageInput struct { // This member is required. Image *types.Image + // (Optional) Specifies the minimum confidence in the face match to return. For + // example, don't return any matches where confidence in matches is less than 70%. + // The default value is 80%. + FaceMatchThreshold *float32 + + // Maximum number of faces to return. The operation returns the maximum number of + // faces with the highest confidence in the match. + MaxFaces *int32 + // A filter that specifies a quality bar for how much filtering is done to identify // faces. Filtered faces aren't searched for in the collection. If you specify // AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or @@ -116,22 +121,10 @@ type SearchFacesByImageInput struct { // collection you are using must be associated with version 3 of the face model or // higher.

    QualityFilter types.QualityFilter - - // ID of the collection to search. - // - // This member is required. - CollectionId *string } type SearchFacesByImageOutput struct { - // The level of confidence that the searchedFaceBoundingBox, contains a face. - SearchedFaceConfidence *float32 - - // The bounding box around the face in the input image that Amazon Rekognition used - // for the search. - SearchedFaceBoundingBox *types.BoundingBox - // An array of faces that match the input face, along with the confidence in the // match. FaceMatches []*types.FaceMatch @@ -140,6 +133,13 @@ type SearchFacesByImageOutput struct { // (CollectionId). FaceModelVersion *string + // The bounding box around the face in the input image that Amazon Rekognition used + // for the search. + SearchedFaceBoundingBox *types.BoundingBox + + // The level of confidence that the searchedFaceBoundingBox, contains a face. + SearchedFaceConfidence *float32 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/rekognition/api_op_StartCelebrityRecognition.go b/service/rekognition/api_op_StartCelebrityRecognition.go index 9c4f210a647..5addddfeb90 100644 --- a/service/rekognition/api_op_StartCelebrityRecognition.go +++ b/service/rekognition/api_op_StartCelebrityRecognition.go @@ -68,27 +68,27 @@ func (c *Client) StartCelebrityRecognition(ctx context.Context, params *StartCel type StartCelebrityRecognitionInput struct { - // Idempotent token used to identify the start request. If you use the same token - // with multiple StartCelebrityRecognition requests, the same JobId is returned. - // Use ClientRequestToken to prevent the same job from being accidently started - // more than once. - ClientRequestToken *string - // The video in which you want to recognize celebrities. The video must be stored // in an Amazon S3 bucket. // // This member is required. Video *types.Video - // The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the - // completion status of the celebrity recognition analysis to. - NotificationChannel *types.NotificationChannel + // Idempotent token used to identify the start request. If you use the same token + // with multiple StartCelebrityRecognition requests, the same JobId is returned. + // Use ClientRequestToken to prevent the same job from being accidently started + // more than once. + ClientRequestToken *string // An identifier you specify that's returned in the completion notification that's // published to your Amazon Simple Notification Service topic. For example, you can // use JobTag to group related jobs and identify them in the completion // notification. JobTag *string + + // The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the + // completion status of the celebrity recognition analysis to. + NotificationChannel *types.NotificationChannel } type StartCelebrityRecognitionOutput struct { diff --git a/service/rekognition/api_op_StartContentModeration.go b/service/rekognition/api_op_StartContentModeration.go index 5b78ab4113c..db33223ea37 100644 --- a/service/rekognition/api_op_StartContentModeration.go +++ b/service/rekognition/api_op_StartContentModeration.go @@ -68,36 +68,36 @@ func (c *Client) StartContentModeration(ctx context.Context, params *StartConten type StartContentModerationInput struct { - // Specifies the minimum confidence that Amazon Rekognition must have in order to - // return a moderated content label. Confidence represents how certain Amazon - // Rekognition is that the moderated content is correctly identified. 0 is the - // lowest confidence. 100 is the highest confidence. Amazon Rekognition doesn't - // return any moderated content labels with a confidence level lower than this - // specified value. If you don't specify MinConfidence, GetContentModeration - // returns labels with confidence values greater than or equal to 50 percent. - MinConfidence *float32 - // The video in which you want to detect unsafe content. The video must be stored // in an Amazon S3 bucket. // // This member is required. Video *types.Video + // Idempotent token used to identify the start request. If you use the same token + // with multiple StartContentModeration requests, the same JobId is returned. Use + // ClientRequestToken to prevent the same job from being accidently started more + // than once. + ClientRequestToken *string + // An identifier you specify that's returned in the completion notification that's // published to your Amazon Simple Notification Service topic. For example, you can // use JobTag to group related jobs and identify them in the completion // notification. JobTag *string + // Specifies the minimum confidence that Amazon Rekognition must have in order to + // return a moderated content label. Confidence represents how certain Amazon + // Rekognition is that the moderated content is correctly identified. 0 is the + // lowest confidence. 100 is the highest confidence. Amazon Rekognition doesn't + // return any moderated content labels with a confidence level lower than this + // specified value. If you don't specify MinConfidence, GetContentModeration + // returns labels with confidence values greater than or equal to 50 percent. + MinConfidence *float32 + // The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the // completion status of the unsafe content analysis to. NotificationChannel *types.NotificationChannel - - // Idempotent token used to identify the start request. If you use the same token - // with multiple StartContentModeration requests, the same JobId is returned. Use - // ClientRequestToken to prevent the same job from being accidently started more - // than once. - ClientRequestToken *string } type StartContentModerationOutput struct { diff --git a/service/rekognition/api_op_StartFaceDetection.go b/service/rekognition/api_op_StartFaceDetection.go index 63c4c70836e..48bdc7b821e 100644 --- a/service/rekognition/api_op_StartFaceDetection.go +++ b/service/rekognition/api_op_StartFaceDetection.go @@ -68,9 +68,11 @@ func (c *Client) StartFaceDetection(ctx context.Context, params *StartFaceDetect type StartFaceDetectionInput struct { - // The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to - // publish the completion status of the face detection operation. - NotificationChannel *types.NotificationChannel + // The video in which you want to detect faces. The video must be stored in an + // Amazon S3 bucket. + // + // This member is required. + Video *types.Video // Idempotent token used to identify the start request. If you use the same token // with multiple StartFaceDetection requests, the same JobId is returned. Use @@ -78,11 +80,10 @@ type StartFaceDetectionInput struct { // than once. ClientRequestToken *string - // The video in which you want to detect faces. The video must be stored in an - // Amazon S3 bucket. - // - // This member is required. - Video *types.Video + // The face attributes you want returned. DEFAULT - The following subset of facial + // attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks. + // ALL - All facial attributes are returned. + FaceAttributes types.FaceAttributes // An identifier you specify that's returned in the completion notification that's // published to your Amazon Simple Notification Service topic. For example, you can @@ -90,10 +91,9 @@ type StartFaceDetectionInput struct { // notification. JobTag *string - // The face attributes you want returned. DEFAULT - The following subset of facial - // attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks. - // ALL - All facial attributes are returned. - FaceAttributes types.FaceAttributes + // The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to + // publish the completion status of the face detection operation. + NotificationChannel *types.NotificationChannel } type StartFaceDetectionOutput struct { diff --git a/service/rekognition/api_op_StartFaceSearch.go b/service/rekognition/api_op_StartFaceSearch.go index c0257c686e9..68da76bf0f9 100644 --- a/service/rekognition/api_op_StartFaceSearch.go +++ b/service/rekognition/api_op_StartFaceSearch.go @@ -67,26 +67,26 @@ func (c *Client) StartFaceSearch(ctx context.Context, params *StartFaceSearchInp type StartFaceSearchInput struct { - // The minimum confidence in the person match to return. For example, don't return - // any matches where confidence in matches is less than 70%. The default value is - // 80%. - FaceMatchThreshold *float32 - // ID of the collection that contains the faces you want to search for. // // This member is required. CollectionId *string + // The video you want to search. The video must be stored in an Amazon S3 bucket. + // + // This member is required. + Video *types.Video + // Idempotent token used to identify the start request. If you use the same token // with multiple StartFaceSearch requests, the same JobId is returned. Use // ClientRequestToken to prevent the same job from being accidently started more // than once. ClientRequestToken *string - // The video you want to search. The video must be stored in an Amazon S3 bucket. - // - // This member is required. - Video *types.Video + // The minimum confidence in the person match to return. For example, don't return + // any matches where confidence in matches is less than 70%. The default value is + // 80%. + FaceMatchThreshold *float32 // An identifier you specify that's returned in the completion notification that's // published to your Amazon Simple Notification Service topic. For example, you can diff --git a/service/rekognition/api_op_StartLabelDetection.go b/service/rekognition/api_op_StartLabelDetection.go index 8639df0e44f..3d418bbc050 100644 --- a/service/rekognition/api_op_StartLabelDetection.go +++ b/service/rekognition/api_op_StartLabelDetection.go @@ -71,12 +71,24 @@ func (c *Client) StartLabelDetection(ctx context.Context, params *StartLabelDete type StartLabelDetectionInput struct { + // The video in which you want to detect labels. The video must be stored in an + // Amazon S3 bucket. + // + // This member is required. + Video *types.Video + // Idempotent token used to identify the start request. If you use the same token // with multiple StartLabelDetection requests, the same JobId is returned. Use // ClientRequestToken to prevent the same job from being accidently started more // than once. ClientRequestToken *string + // An identifier you specify that's returned in the completion notification that's + // published to your Amazon Simple Notification Service topic. For example, you can + // use JobTag to group related jobs and identify them in the completion + // notification. + JobTag *string + // Specifies the minimum confidence that Amazon Rekognition Video must have in // order to return a detected label. Confidence represents how certain Amazon // Rekognition is that a label is correctly identified.0 is the lowest confidence. @@ -89,18 +101,6 @@ type StartLabelDetectionInput struct { // The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the // completion status of the label detection operation to. NotificationChannel *types.NotificationChannel - - // The video in which you want to detect labels. The video must be stored in an - // Amazon S3 bucket. - // - // This member is required. - Video *types.Video - - // An identifier you specify that's returned in the completion notification that's - // published to your Amazon Simple Notification Service topic. For example, you can - // use JobTag to group related jobs and identify them in the completion - // notification. - JobTag *string } type StartLabelDetectionOutput struct { diff --git a/service/rekognition/api_op_StartPersonTracking.go b/service/rekognition/api_op_StartPersonTracking.go index cf5ad4526af..1a80f86adad 100644 --- a/service/rekognition/api_op_StartPersonTracking.go +++ b/service/rekognition/api_op_StartPersonTracking.go @@ -66,18 +66,18 @@ func (c *Client) StartPersonTracking(ctx context.Context, params *StartPersonTra type StartPersonTrackingInput struct { - // Idempotent token used to identify the start request. If you use the same token - // with multiple StartPersonTracking requests, the same JobId is returned. Use - // ClientRequestToken to prevent the same job from being accidently started more - // than once. - ClientRequestToken *string - // The video in which you want to detect people. The video must be stored in an // Amazon S3 bucket. // // This member is required. Video *types.Video + // Idempotent token used to identify the start request. If you use the same token + // with multiple StartPersonTracking requests, the same JobId is returned. Use + // ClientRequestToken to prevent the same job from being accidently started more + // than once. + ClientRequestToken *string + // An identifier you specify that's returned in the completion notification that's // published to your Amazon Simple Notification Service topic. For example, you can // use JobTag to group related jobs and identify them in the completion diff --git a/service/rekognition/api_op_StartProjectVersion.go b/service/rekognition/api_op_StartProjectVersion.go index 61ad1aceddc..098323d0f55 100644 --- a/service/rekognition/api_op_StartProjectVersion.go +++ b/service/rekognition/api_op_StartProjectVersion.go @@ -63,11 +63,6 @@ func (c *Client) StartProjectVersion(ctx context.Context, params *StartProjectVe type StartProjectVersionInput struct { - // The Amazon Resource Name(ARN) of the model version that you want to start. - // - // This member is required. - ProjectVersionArn *string - // The minimum number of inference units to use. A single inference unit represents // 1 hour of processing and can support up to 5 Transaction Pers Second (TPS). Use // a higher number to increase the TPS throughput of your model. You are charged @@ -75,6 +70,11 @@ type StartProjectVersionInput struct { // // This member is required. MinInferenceUnits *int32 + + // The Amazon Resource Name(ARN) of the model version that you want to start. + // + // This member is required. + ProjectVersionArn *string } type StartProjectVersionOutput struct { diff --git a/service/rekognition/api_op_StartSegmentDetection.go b/service/rekognition/api_op_StartSegmentDetection.go index 648afd17a4f..b91724fdb2d 100644 --- a/service/rekognition/api_op_StartSegmentDetection.go +++ b/service/rekognition/api_op_StartSegmentDetection.go @@ -78,31 +78,31 @@ type StartSegmentDetectionInput struct { // This member is required. SegmentTypes []types.SegmentType + // Video file stored in an Amazon S3 bucket. Amazon Rekognition video start + // operations such as StartLabelDetection () use Video to specify a video for + // analysis. The supported file formats are .mp4, .mov and .avi. + // + // This member is required. + Video *types.Video + // Idempotent token used to identify the start request. If you use the same token // with multiple StartSegmentDetection requests, the same JobId is returned. Use // ClientRequestToken to prevent the same job from being accidently started more // than once. ClientRequestToken *string - // The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to - // publish the completion status of the segment detection operation. - NotificationChannel *types.NotificationChannel - // Filters for technical cue or shot detection. Filters *types.StartSegmentDetectionFilters - // Video file stored in an Amazon S3 bucket. Amazon Rekognition video start - // operations such as StartLabelDetection () use Video to specify a video for - // analysis. The supported file formats are .mp4, .mov and .avi. - // - // This member is required. - Video *types.Video - // An identifier you specify that's returned in the completion notification that's // published to your Amazon Simple Notification Service topic. For example, you can // use JobTag to group related jobs and identify them in the completion // notification. JobTag *string + + // The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to + // publish the completion status of the segment detection operation. + NotificationChannel *types.NotificationChannel } type StartSegmentDetectionOutput struct { diff --git a/service/rekognition/api_op_StartTextDetection.go b/service/rekognition/api_op_StartTextDetection.go index cfd853f6f4f..ada236a67cd 100644 --- a/service/rekognition/api_op_StartTextDetection.go +++ b/service/rekognition/api_op_StartTextDetection.go @@ -66,9 +66,12 @@ func (c *Client) StartTextDetection(ctx context.Context, params *StartTextDetect type StartTextDetectionInput struct { - // Optional parameters that let you set criteria the text must meet to be included - // in your response. - Filters *types.StartTextDetectionFilters + // Video file stored in an Amazon S3 bucket. Amazon Rekognition video start + // operations such as StartLabelDetection () use Video to specify a video for + // analysis. The supported file formats are .mp4, .mov and .avi. + // + // This member is required. + Video *types.Video // Idempotent token used to identify the start request. If you use the same token // with multiple StartTextDetection requests, the same JobId is returned. Use @@ -76,12 +79,9 @@ type StartTextDetectionInput struct { // than once. ClientRequestToken *string - // Video file stored in an Amazon S3 bucket. Amazon Rekognition video start - // operations such as StartLabelDetection () use Video to specify a video for - // analysis. The supported file formats are .mp4, .mov and .avi. - // - // This member is required. - Video *types.Video + // Optional parameters that let you set criteria the text must meet to be included + // in your response. + Filters *types.StartTextDetectionFilters // An identifier returned in the completion status published by your Amazon Simple // Notification Service topic. For example, you can use JobTag to group related diff --git a/service/rekognition/go.mod b/service/rekognition/go.mod index 7252cda03ea..c76eb199176 100644 --- a/service/rekognition/go.mod +++ b/service/rekognition/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/rekognition go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/rekognition/types/types.go b/service/rekognition/types/types.go index 0cbed46e6ad..f1e75f1b8bf 100644 --- a/service/rekognition/types/types.go +++ b/service/rekognition/types/types.go @@ -33,14 +33,14 @@ type Asset struct { // (). type AudioMetadata struct { - // The number of audio channels in the segement. - NumberOfChannels *int64 + // The audio codec used to encode or decode the audio stream. + Codec *string // The duration of the audio stream in milliseconds. DurationMillis *int64 - // The audio codec used to encode or decode the audio stream. - Codec *string + // The number of audio channels in the segement. + NumberOfChannels *int64 // The sample rate for the audio stream. SampleRate *int64 @@ -50,11 +50,11 @@ type AudioMetadata struct { // determination. type Beard struct { - // Boolean value that indicates whether the face has beard or not. - Value *bool - // Level of confidence in the determination. Confidence *float32 + + // Boolean value that indicates whether the face has beard or not. + Value *bool } // Identifies the bounding box around the label, face, or text. The left @@ -74,9 +74,6 @@ type Beard struct { // values. type BoundingBox struct { - // Width of the bounding box as a ratio of the overall image width. - Width *float32 - // Height of the bounding box as a ratio of the overall image height. Height *float32 @@ -85,12 +82,19 @@ type BoundingBox struct { // Top coordinate of the bounding box as a ratio of overall image height. Top *float32 + + // Width of the bounding box as a ratio of the overall image width. + Width *float32 } // Provides information about a celebrity recognized by the RecognizeCelebrities () // operation. type Celebrity struct { + // Provides information about the celebrity's face, such as its location on the + // image. + Face *ComparedFace + // A unique identifier for the celebrity. Id *string @@ -104,10 +108,6 @@ type Celebrity struct { // An array of URLs pointing to additional information about the celebrity. If // there is no additional information about the celebrity, this list is empty. Urls []*string - - // Provides information about the celebrity's face, such as its location on the - // image. - Face *ComparedFace } // Information about a recognized celebrity. @@ -116,21 +116,21 @@ type CelebrityDetail struct { // Bounding box around the body of a celebrity. BoundingBox *BoundingBox - // The name of the celebrity. - Name *string - // The confidence, in percentage, that Amazon Rekognition has that the recognized // face is the celebrity. Confidence *float32 - // An array of URLs pointing to additional celebrity information. - Urls []*string - // Face details for the recognized celebrity. Face *FaceDetail // The unique identifier for the celebrity. Id *string + + // The name of the celebrity. + Name *string + + // An array of URLs pointing to additional celebrity information. + Urls []*string } // Information about a detected celebrity and the time the celebrity was detected @@ -138,32 +138,32 @@ type CelebrityDetail struct { // Amazon Rekognition Developer Guide. type CelebrityRecognition struct { + // Information about a recognized celebrity. + Celebrity *CelebrityDetail + // The time, in milliseconds from the start of the video, that the celebrity was // recognized. Timestamp *int64 - - // Information about a recognized celebrity. - Celebrity *CelebrityDetail } // Provides face metadata for target image faces that are analyzed by CompareFaces // and RecognizeCelebrities. type ComparedFace struct { - // An array of facial landmarks. - Landmarks []*Landmark - // Bounding box of the face. BoundingBox *BoundingBox - // Identifies face image brightness and sharpness. - Quality *ImageQuality - // Level of confidence that what the bounding box contains is a face. Confidence *float32 + // An array of facial landmarks. + Landmarks []*Landmark + // Indicates the pose of the face as determined by its pitch, roll, and yaw. Pose *Pose + + // Identifies face image brightness and sharpness. + Quality *ImageQuality } // Type that describes the face Amazon Rekognition chose to compare with the faces @@ -172,11 +172,11 @@ type ComparedFace struct { // selects the largest face in the source image for this comparison. type ComparedSourceImageFace struct { - // Confidence level that the selected bounding box contains a face. - Confidence *float32 - // Bounding box of the face. BoundingBox *BoundingBox + + // Confidence level that the selected bounding box contains a face. + Confidence *float32 } // Provides information about a face in a target image that matches the source @@ -185,12 +185,12 @@ type ComparedSourceImageFace struct { // the source image face matches the face in the bounding box. type CompareFacesMatch struct { - // Level of confidence that the faces match. - Similarity *float32 - // Provides face metadata (bounding box and confidence that the bounding box // actually contains a face). Face *ComparedFace + + // Level of confidence that the faces match. + Similarity *float32 } // Information about an unsafe content label detection in a stored video. @@ -207,17 +207,17 @@ type ContentModerationDetection struct { // A custom label detected in an image by a call to DetectCustomLabels (). type CustomLabel struct { - // The name of the custom label. - Name *string + // The confidence that the model has in the detection of the custom label. The + // range is 0-100. A higher value indicates a higher confidence. + Confidence *float32 // The location of the detected object on the image that corresponds to the custom // label. Includes an axis aligned coarse bounding box surrounding the object and a // finer grain polygon for more accurate spatial information. Geometry *Geometry - // The confidence that the model has in the detection of the custom label. The - // range is 0-100. A higher value indicates a higher confidence. - Confidence *float32 + // The name of the custom label. + Name *string } // A set of parameters that allow you to filter out certain results from your @@ -246,13 +246,13 @@ type DetectionFilter struct { // of the image to look for text in. type DetectTextFilters struct { - // A set of parameters that allow you to filter out certain results from your - // returned results. - WordFilter *DetectionFilter - // A Filter focusing on a certain area of the image. Uses a BoundingBox object to // set the region of the image. RegionsOfInterest []*RegionOfInterest + + // A set of parameters that allow you to filter out certain results from your + // returned results. + WordFilter *DetectionFilter } // The emotions that appear to be expressed on the face, and the confidence level @@ -262,11 +262,11 @@ type DetectTextFilters struct { // person pretending to have a sad face might not be sad emotionally. type Emotion struct { - // Type of emotion detected. - Type EmotionName - // Level of confidence in the determination. Confidence *float32 + + // Type of emotion detected. + Type EmotionName } // The evaluation results for the training of a model. @@ -308,21 +308,21 @@ type EyeOpen struct { // input image, and external image ID that you assigned. type Face struct { - // Unique identifier that Amazon Rekognition assigns to the face. - FaceId *string + // Bounding box of the face. + BoundingBox *BoundingBox // Confidence level that the bounding box contains a face (and not a different // object such as a tree). Confidence *float32 - // Unique identifier that Amazon Rekognition assigns to the input image. - ImageId *string - - // Bounding box of the face. - BoundingBox *BoundingBox - // Identifier that you assign to all the faces in the input image. ExternalImageId *string + + // Unique identifier that Amazon Rekognition assigns to the face. + FaceId *string + + // Unique identifier that Amazon Rekognition assigns to the input image. + ImageId *string } // Structure containing attributes of the face that the algorithm detected. A @@ -348,44 +348,21 @@ type Face struct { // For IndexFaces, use the DetectAttributes input parameter. type FaceDetail struct { - // Indicates whether or not the mouth on the face is open, and the confidence level - // in the determination. - MouthOpen *MouthOpen - - // Indicates whether or not the face is wearing sunglasses, and the confidence - // level in the determination. - Sunglasses *Sunglasses - - // Indicates whether or not the eyes on the face are open, and the confidence level - // in the determination. - EyesOpen *EyeOpen - - // The predicted gender of a detected face. - Gender *Gender - - // Indicates whether or not the face has a mustache, and the confidence level in - // the determination. - Mustache *Mustache + // The estimated age range, in years, for the face. Low represents the lowest + // estimated age and High represents the highest estimated age. + AgeRange *AgeRange - // Identifies image brightness and sharpness. Default attribute. - Quality *ImageQuality + // Indicates whether or not the face has a beard, and the confidence level in the + // determination. + Beard *Beard - // Indicates whether or not the face is wearing eye glasses, and the confidence - // level in the determination. - Eyeglasses *Eyeglasses + // Bounding box of the face. Default attribute. + BoundingBox *BoundingBox // Confidence level that the bounding box contains a face (and not a different // object such as a tree). Default attribute. Confidence *float32 - // Indicates whether or not the face is smiling, and the confidence level in the - // determination. - Smile *Smile - - // Indicates whether or not the face has a beard, and the confidence level in the - // determination. - Beard *Beard - // The emotions that appear to be expressed on the face, and the confidence level // in the determination. The API is only making a determination of the physical // appearance of a person's face. It is not a determination of the person’s @@ -393,42 +370,65 @@ type FaceDetail struct { // person pretending to have a sad face might not be sad emotionally. Emotions []*Emotion - // Bounding box of the face. Default attribute. - BoundingBox *BoundingBox + // Indicates whether or not the face is wearing eye glasses, and the confidence + // level in the determination. + Eyeglasses *Eyeglasses + + // Indicates whether or not the eyes on the face are open, and the confidence level + // in the determination. + EyesOpen *EyeOpen + + // The predicted gender of a detected face. + Gender *Gender // Indicates the location of landmarks on the face. Default attribute. Landmarks []*Landmark - // The estimated age range, in years, for the face. Low represents the lowest - // estimated age and High represents the highest estimated age. - AgeRange *AgeRange + // Indicates whether or not the mouth on the face is open, and the confidence level + // in the determination. + MouthOpen *MouthOpen + + // Indicates whether or not the face has a mustache, and the confidence level in + // the determination. + Mustache *Mustache // Indicates the pose of the face as determined by its pitch, roll, and yaw. // Default attribute. Pose *Pose + + // Identifies image brightness and sharpness. Default attribute. + Quality *ImageQuality + + // Indicates whether or not the face is smiling, and the confidence level in the + // determination. + Smile *Smile + + // Indicates whether or not the face is wearing sunglasses, and the confidence + // level in the determination. + Sunglasses *Sunglasses } // Information about a face detected in a video analysis request and the time the // face was detected in the video. type FaceDetection struct { - // Time, in milliseconds from the start of the video, that the face was detected. - Timestamp *int64 - // The face properties for the detected face. Face *FaceDetail + + // Time, in milliseconds from the start of the video, that the face was detected. + Timestamp *int64 } // Provides face metadata. In addition, it also provides the confidence in the // match of this face with the input face. type FaceMatch struct { - // Confidence in the match of this face with the input face. - Similarity *float32 - // Describes the face properties such as the bounding box, face ID, image ID of the // source image, and external image ID that you assigned. Face *Face + + // Confidence in the match of this face with the input face. + Similarity *float32 } // Object containing both the face metadata (stored in the backend database), and @@ -481,12 +481,12 @@ type Gender struct { // ()) is located on an image. type Geometry struct { - // Within the bounding box, a fine-grained polygon around the detected item. - Polygon []*Point - // An axis-aligned coarse representation of the detected item's location on the // image. BoundingBox *BoundingBox + + // Within the bounding box, a fine-grained polygon around the detected item. + Polygon []*Point } // The S3 bucket that contains the Ground Truth manifest file. @@ -509,26 +509,17 @@ type HumanLoopActivationOutput struct { // This value conforms to the media type: application/json HumanLoopActivationConditionsEvaluationResults *string - // The Amazon Resource Name (ARN) of the HumanLoop created. - HumanLoopArn *string - // Shows if and why human review was needed. HumanLoopActivationReasons []*string + + // The Amazon Resource Name (ARN) of the HumanLoop created. + HumanLoopArn *string } // Sets up the flow definition the image will be sent to if one of the conditions // is met. You can also set certain attributes of the image before review. type HumanLoopConfig struct { - // Sets attributes of the input data. - DataAttributes *HumanLoopDataAttributes - - // The name of the human review used for this image. This should be kept unique - // within a region. - // - // This member is required. - HumanLoopName *string - // The Amazon Resource Name (ARN) of the flow definition. You can create a flow // definition by using the Amazon Sagemaker CreateFlowDefinition // (https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateFlowDefinition.html) @@ -536,6 +527,15 @@ type HumanLoopConfig struct { // // This member is required. FlowDefinitionArn *string + + // The name of the human review used for this image. This should be kept unique + // within a region. + // + // This member is required. + HumanLoopName *string + + // Sets attributes of the input data. + DataAttributes *HumanLoopDataAttributes } // Allows you to set attributes of the image. Currently, you can declare an image @@ -575,13 +575,13 @@ type Image struct { // Identifies face image brightness and sharpness. type ImageQuality struct { - // Value representing sharpness of the face. The service returns a value between 0 - // and 100 (inclusive). A higher value indicates a sharper face image. - Sharpness *float32 - // Value representing brightness of the face. The service returns a value between 0 // and 100 (inclusive). A higher value indicates a brighter face image. Brightness *float32 + + // Value representing sharpness of the face. The service returns a value between 0 + // and 100 (inclusive). A higher value indicates a sharper face image. + Sharpness *float32 } // An instance of a label returned by Amazon Rekognition Image (DetectLabels ()) or @@ -617,19 +617,19 @@ type KinesisVideoStream struct { // detected instances, parent labels, and level of confidence. type Label struct { - // The name (label) of the object or scene. - Name *string + // Level of confidence. + Confidence *float32 // If Label represents an object, Instances contains the bounding boxes for each // instance of the detected object. Bounding boxes are returned for common object // labels such as people, cars, furniture, apparel or pets. Instances []*Instance + // The name (label) of the object or scene. + Name *string + // The parent labels for a label. The response includes all ancestor labels. Parents []*Parent - - // Level of confidence. - Confidence *float32 } // Information about a label detected in a video analysis request and the time the @@ -649,15 +649,15 @@ type Landmark struct { // Type of landmark. Type LandmarkType - // The y-coordinate from the top left of the landmark expressed as the ratio of the - // height of the image. For example, if the image is 700 x 200 and the y-coordinate - // of the landmark is at 100 pixels, this value is 0.5. - Y *float32 - // The x-coordinate from the top left of the landmark expressed as the ratio of the // width of the image. For example, if the image is 700 x 200 and the x-coordinate // of the landmark is at 350 pixels, this value is 0.5. X *float32 + + // The y-coordinate from the top left of the landmark expressed as the ratio of the + // height of the image. For example, if the image is 700 x 200 and the y-coordinate + // of the landmark is at 100 pixels, this value is 0.5. + Y *float32 } // Provides information about a single type of unsafe content found in an image or @@ -666,40 +666,40 @@ type Landmark struct { // Rekognition Developer Guide. type ModerationLabel struct { - // The name for the parent label. Labels at the top level of the hierarchy have the - // parent label "". - ParentName *string - - // The label name for the type of unsafe content detected in the image. - Name *string - // Specifies the confidence that Amazon Rekognition has that the label has been // correctly identified. If you don't specify the MinConfidence parameter in the // call to DetectModerationLabels, the operation returns labels with a confidence // value greater than or equal to 50 percent. Confidence *float32 + + // The label name for the type of unsafe content detected in the image. + Name *string + + // The name for the parent label. Labels at the top level of the hierarchy have the + // parent label "". + ParentName *string } // Indicates whether or not the mouth on the face is open, and the confidence level // in the determination. type MouthOpen struct { - // Boolean value that indicates whether the mouth on the face is open or not. - Value *bool - // Level of confidence in the determination. Confidence *float32 + + // Boolean value that indicates whether the mouth on the face is open or not. + Value *bool } // Indicates whether or not the face has a mustache, and the confidence level in // the determination. type Mustache struct { - // Boolean value that indicates whether the face has mustache or not. - Value *bool - // Level of confidence in the determination. Confidence *float32 + + // Boolean value that indicates whether the face has mustache or not. + Value *bool } // The Amazon Simple Notification Service topic to which Amazon Rekognition @@ -739,16 +739,16 @@ type Parent struct { // Details about a person detected in a video analysis request. type PersonDetail struct { - // Identifier for the person detected person within a video. Use to keep track of - // the person throughout the video. The identifier is not stored by Amazon - // Rekognition. - Index *int64 + // Bounding box around the detected person. + BoundingBox *BoundingBox // Face details for the detected person. Face *FaceDetail - // Bounding box around the detected person. - BoundingBox *BoundingBox + // Identifier for the person detected person within a video. Use to keep track of + // the person throughout the video. The identifier is not stored by Amazon + // Rekognition. + Index *int64 } // Details and path tracking information for a single time a person's path is @@ -758,12 +758,12 @@ type PersonDetail struct { // GetPersonTracking in the Amazon Rekognition Developer Guide.

    type PersonDetection struct { + // Details about a person whose path was tracked in a video. + Person *PersonDetail + // The time, in milliseconds from the start of the video, that the person's path // was tracked. Timestamp *int64 - - // Details about a person whose path was tracked in a video. - Person *PersonDetail } // Information about a person whose face matches a face(s) in an Amazon Rekognition @@ -777,12 +777,12 @@ type PersonMatch struct { // person in the video. FaceMatches []*FaceMatch + // Information about the matched person. + Person *PersonDetail + // The time, in milliseconds from the beginning of the video, that the person was // matched in the video. Timestamp *int64 - - // Information about the matched person. - Person *PersonDetail } // The X and Y coordinates of a point on an image. The X and Y values returned are @@ -805,67 +805,67 @@ type Point struct { // Indicates the pose of the face as determined by its pitch, roll, and yaw. type Pose struct { - // Value representing the face rotation on the yaw axis. - Yaw *float32 + // Value representing the face rotation on the pitch axis. + Pitch *float32 // Value representing the face rotation on the roll axis. Roll *float32 - // Value representing the face rotation on the pitch axis. - Pitch *float32 + // Value representing the face rotation on the yaw axis. + Yaw *float32 } // A description of a Amazon Rekognition Custom Labels project. type ProjectDescription struct { - // The current status of the project. - Status ProjectStatus + // The Unix timestamp for the date and time that the project was created. + CreationTimestamp *time.Time // The Amazon Resource Name (ARN) of the project. ProjectArn *string - // The Unix timestamp for the date and time that the project was created. - CreationTimestamp *time.Time + // The current status of the project. + Status ProjectStatus } // The description of a version of a model. type ProjectVersionDescription struct { - // The location where training results are saved. - OutputConfig *OutputConfig + // The duration, in seconds, that the model version has been billed for training. + // This value is only returned if the model version has been successfully trained. + BillableTrainingTimeInSeconds *int64 - // The current status of the model version. - Status ProjectVersionStatus + // The Unix datetime for the date and time that training started. + CreationTimestamp *time.Time + + // The training results. EvaluationResult is only returned if training is + // successful. + EvaluationResult *EvaluationResult // The minimum number of inference units used by the model. For more information, // see StartProjectVersion (). MinInferenceUnits *int32 - // The Unix date and time that training of the model ended. - TrainingEndTimestamp *time.Time - - // The manifest file that represents the testing results. - TestingDataResult *TestingDataResult - - // The manifest file that represents the training results. - TrainingDataResult *TrainingDataResult + // The location where training results are saved. + OutputConfig *OutputConfig // The Amazon Resource Name (ARN) of the model version. ProjectVersionArn *string - // The training results. EvaluationResult is only returned if training is - // successful. - EvaluationResult *EvaluationResult - - // The duration, in seconds, that the model version has been billed for training. - // This value is only returned if the model version has been successfully trained. - BillableTrainingTimeInSeconds *int64 + // The current status of the model version. + Status ProjectVersionStatus // A descriptive message for an error or warning that occurred. StatusMessage *string - // The Unix datetime for the date and time that training started. - CreationTimestamp *time.Time + // The manifest file that represents the testing results. + TestingDataResult *TestingDataResult + + // The manifest file that represents the training results. + TrainingDataResult *TrainingDataResult + + // The Unix date and time that training of the model ended. + TrainingEndTimestamp *time.Time } // Specifies a location within the frame that Rekognition checks for text. Uses a @@ -889,11 +889,11 @@ type S3Object struct { // Name of the S3 bucket. Bucket *string - // If the bucket is versioning enabled, you can specify the object version. - Version *string - // S3 object key name. Name *string + + // If the bucket is versioning enabled, you can specify the object version. + Version *string } // A technical cue or shot detection segment detected in a video. An array of @@ -901,18 +901,12 @@ type S3Object struct { // returned by GetSegmentDetection (). type SegmentDetection struct { - // The frame-accurate SMPTE timecode, from the start of a video, for the start of a - // detected segment. StartTimecode is in HH:MM:SS:fr format (and ;fr for drop - // frame-rates). - StartTimecodeSMPTE *string + // The duration of the detected segment in milliseconds. + DurationMillis *int64 // The duration of the timecode for the detected segment in SMPTE format. DurationSMPTE *string - // If the segment is a shot detection, contains information about the shot - // detection. - ShotSegment *ShotSegment - // The frame-accurate SMPTE timecode, from the start of a video, for the end of a // detected segment. EndTimecode is in HH:MM:SS:fr format (and ;fr for drop // frame-rates). @@ -922,18 +916,24 @@ type SegmentDetection struct { // video. EndTimestampMillis *int64 + // If the segment is a shot detection, contains information about the shot + // detection. + ShotSegment *ShotSegment + + // The frame-accurate SMPTE timecode, from the start of a video, for the start of a + // detected segment. StartTimecode is in HH:MM:SS:fr format (and ;fr for drop + // frame-rates). + StartTimecodeSMPTE *string + // The start time of the detected segment in milliseconds from the start of the // video. StartTimestampMillis *int64 - // The type of the segment. Valid values are TECHNICAL_CUE and SHOT. - Type SegmentType - // If the segment is a technical cue, contains information about the technical cue. TechnicalCueSegment *TechnicalCueSegment - // The duration of the detected segment in milliseconds. - DurationMillis *int64 + // The type of the segment. Valid values are TECHNICAL_CUE and SHOT. + Type SegmentType } // Information about the type of a segment requested in a call to @@ -941,11 +941,11 @@ type SegmentDetection struct { // response from GetSegmentDetection (). type SegmentTypeInfo struct { - // The type of a segment (technical cue or shot detection). - Type SegmentType - // The version of the model used to detect segments. ModelVersion *string + + // The type of a segment (technical cue or shot detection). + Type SegmentType } // Information about a shot detection segment detected in a video. For more @@ -964,11 +964,11 @@ type ShotSegment struct { // determination. type Smile struct { - // Boolean value that indicates whether the face is smiling or not. - Value *bool - // Level of confidence in the determination. Confidence *float32 + + // Boolean value that indicates whether the face is smiling or not. + Value *bool } // Filters applied to the technical cue or shot detection segments. For more @@ -1093,12 +1093,12 @@ type Sunglasses struct { // SegmentDetection (). type TechnicalCueSegment struct { - // The type of the technical cue. - Type TechnicalCueType - // The confidence that Amazon Rekognition Video has in the accuracy of the detected // segment. Confidence *float32 + + // The type of the technical cue. + Type TechnicalCueType } // The dataset used for testing. Optionally, if AutoCreate is set, Amazon @@ -1135,28 +1135,28 @@ type TestingDataResult struct { // Developer Guide.

    type TextDetection struct { - // The identifier for the detected text. The identifier is only unique for a single - // call to DetectText. - Id *int32 + // The confidence that Amazon Rekognition has in the accuracy of the detected text + // and the accuracy of the geometry points around the detected text. + Confidence *float32 + + // The word or line of text recognized by Amazon Rekognition. + DetectedText *string // The location of the detected text on the image. Includes an axis aligned coarse // bounding box surrounding the text and a finer grain polygon for more accurate // spatial information. Geometry *Geometry - // The type of text that was detected. - Type TextTypes - - // The word or line of text recognized by Amazon Rekognition. - DetectedText *string + // The identifier for the detected text. The identifier is only unique for a single + // call to DetectText. + Id *int32 // The Parent identifier for the detected text identified by the value of ID. If // the type of detected text is LINE, the value of ParentId is Null. ParentId *int32 - // The confidence that Amazon Rekognition has in the accuracy of the detected text - // and the accuracy of the geometry points around the detected text. - Confidence *float32 + // The type of text that was detected. + Type TextTypes } // Information about text detected in a video. Incudes the detected text, the time @@ -1184,18 +1184,22 @@ type TrainingData struct { // for training. type TrainingDataResult struct { + // The training assets that you supplied for training. + Input *TrainingData + // The images (assets) that were actually trained by Amazon Rekognition Custom // Labels. Output *TrainingData - - // The training assets that you supplied for training. - Input *TrainingData } // A face that IndexFaces () detected, but didn't index. Use the Reasons response // attribute to determine why a face wasn't indexed. type UnindexedFace struct { + // The structure that contains attributes of a face that IndexFacesdetected, but + // didn't index. + FaceDetail *FaceDetail + // An array of reasons that specify why a face wasn't indexed. // // * EXTREME_POSE @@ -1217,10 +1221,6 @@ type UnindexedFace struct { // * SMALL_BOUNDING_BOX - The bounding box // around the face is too small. Reasons []Reason - - // The structure that contains attributes of a face that IndexFacesdetected, but - // didn't index. - FaceDetail *FaceDetail } // Video file stored in an Amazon S3 bucket. Amazon Rekognition video start @@ -1237,9 +1237,15 @@ type Video struct { // operation. type VideoMetadata struct { + // Type of compression used in the analyzed video. + Codec *string + // Length of the video in milliseconds. DurationMillis *int64 + // Format of the analyzed video. Possible values are MP4, MOV and AVI. + Format *string + // Vertical pixel dimension of the video. FrameHeight *int64 @@ -1248,10 +1254,4 @@ type VideoMetadata struct { // Horizontal pixel dimension of the video. FrameWidth *int64 - - // Format of the analyzed video. Possible values are MP4, MOV and AVI. - Format *string - - // Type of compression used in the analyzed video. - Codec *string } diff --git a/service/resourcegroups/api_op_CreateGroup.go b/service/resourcegroups/api_op_CreateGroup.go index 6475ec77040..e56f29063b8 100644 --- a/service/resourcegroups/api_op_CreateGroup.go +++ b/service/resourcegroups/api_op_CreateGroup.go @@ -58,13 +58,6 @@ func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optF type CreateGroupInput struct { - // The tags to add to the group. A tag is key-value pair string. - Tags map[string]*string - - // The description of the resource group. Descriptions can consist of letters, - // numbers, hyphens, underscores, periods, and spaces. - Description *string - // The name of the group, which is the identifier of the group in other operations. // You can't change the name of a resource group after you create it. A resource // group name can consist of letters, numbers, hyphens, periods, and underscores. @@ -74,15 +67,22 @@ type CreateGroupInput struct { // This member is required. Name *string - // The resource query that determines which AWS resources are members of this - // group. You can specify either a ResourceQuery or a Configuration, but not both. - ResourceQuery *types.ResourceQuery - // A configuration associates the resource group with an AWS service and specifies // how the service can interact with the resources in the group. A configuration is // an array of GroupConfigurationItem () elements. You can specify either a // Configuration or a ResourceQuery in a group, but not both. Configuration []*types.GroupConfigurationItem + + // The description of the resource group. Descriptions can consist of letters, + // numbers, hyphens, underscores, periods, and spaces. + Description *string + + // The resource query that determines which AWS resources are members of this + // group. You can specify either a ResourceQuery or a Configuration, but not both. + ResourceQuery *types.ResourceQuery + + // The tags to add to the group. A tag is key-value pair string. + Tags map[string]*string } type CreateGroupOutput struct { @@ -90,9 +90,6 @@ type CreateGroupOutput struct { // The description of the resource group. Group *types.Group - // The tags associated with the group. - Tags map[string]*string - // The service configuration associated with the resource group. AWS Resource // Groups supports adding service configurations for the following resource group // types: @@ -107,6 +104,9 @@ type CreateGroupOutput struct { // The resource query associated with the group. ResourceQuery *types.ResourceQuery + // The tags associated with the group. + Tags map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/resourcegroups/api_op_DeleteGroup.go b/service/resourcegroups/api_op_DeleteGroup.go index d90bfdbabca..16faa9ee08c 100644 --- a/service/resourcegroups/api_op_DeleteGroup.go +++ b/service/resourcegroups/api_op_DeleteGroup.go @@ -58,11 +58,11 @@ func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optF type DeleteGroupInput struct { - // Don't use this parameter. Use Group instead. - GroupName *string - // The name or the ARN of the resource group to delete. Group *string + + // Don't use this parameter. Use Group instead. + GroupName *string } type DeleteGroupOutput struct { diff --git a/service/resourcegroups/api_op_GetGroup.go b/service/resourcegroups/api_op_GetGroup.go index f337c377ba7..97ae0f218bc 100644 --- a/service/resourcegroups/api_op_GetGroup.go +++ b/service/resourcegroups/api_op_GetGroup.go @@ -56,11 +56,11 @@ func (c *Client) GetGroup(ctx context.Context, params *GetGroupInput, optFns ... type GetGroupInput struct { - // Don't use this parameter. Use Group instead. - GroupName *string - // The name or the ARN of the resource group to retrieve. Group *string + + // Don't use this parameter. Use Group instead. + GroupName *string } type GetGroupOutput struct { diff --git a/service/resourcegroups/api_op_GetGroupQuery.go b/service/resourcegroups/api_op_GetGroupQuery.go index cc6d5117fa5..f1805d1aea1 100644 --- a/service/resourcegroups/api_op_GetGroupQuery.go +++ b/service/resourcegroups/api_op_GetGroupQuery.go @@ -56,11 +56,11 @@ func (c *Client) GetGroupQuery(ctx context.Context, params *GetGroupQueryInput, type GetGroupQueryInput struct { - // Don't use this parameter. Use Group instead. - GroupName *string - // The name or the ARN of the resource group to query. Group *string + + // Don't use this parameter. Use Group instead. + GroupName *string } type GetGroupQueryOutput struct { diff --git a/service/resourcegroups/api_op_GroupResources.go b/service/resourcegroups/api_op_GroupResources.go index 310080ead12..c4fb64d09b4 100644 --- a/service/resourcegroups/api_op_GroupResources.go +++ b/service/resourcegroups/api_op_GroupResources.go @@ -70,14 +70,14 @@ type GroupResourcesInput struct { type GroupResourcesOutput struct { - // The ARNs of the resources that were successfully added to the group by this - // operation. - Succeeded []*string - // The ARNs of the resources that failed to be added to the group by this // operation. Failed []*types.FailedResource + // The ARNs of the resources that were successfully added to the group by this + // operation. + Succeeded []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/resourcegroups/api_op_ListGroupResources.go b/service/resourcegroups/api_op_ListGroupResources.go index 13aeb463584..df93ceff8c9 100644 --- a/service/resourcegroups/api_op_ListGroupResources.go +++ b/service/resourcegroups/api_op_ListGroupResources.go @@ -58,12 +58,6 @@ func (c *Client) ListGroupResources(ctx context.Context, params *ListGroupResour type ListGroupResourcesInput struct { - // The name or the ARN of the resource group - Group *string - - // Don't use this parameter. Use Group instead. - GroupName *string - // Filters, formatted as ResourceFilter () objects, that you want to apply to a // ListGroupResources operation. Filters the results to include only those of the // specified resource types. @@ -87,11 +81,11 @@ type ListGroupResourcesInput struct { // types for the query type (tag-based or AWS CloudFormation stack-based queries). Filters []*types.ResourceFilter - // The parameter for receiving additional results if you receive a NextToken - // response in a previous request. A NextToken response indicates that more output - // is available. Set this parameter to the value provided by a previous call's - // NextToken response to indicate where the output should continue from. - NextToken *string + // The name or the ARN of the resource group + Group *string + + // Don't use this parameter. Use Group instead. + GroupName *string // The total number of results that you want included on each page of the response. // If you do not include this parameter, it defaults to a value that is specific to @@ -103,6 +97,12 @@ type ListGroupResourcesInput struct { // check NextToken after every operation to ensure that you receive all of the // results. MaxResults *int32 + + // The parameter for receiving additional results if you receive a NextToken + // response in a previous request. A NextToken response indicates that more output + // is available. Set this parameter to the value provided by a previous call's + // NextToken response to indicate where the output should continue from. + NextToken *string } type ListGroupResourcesOutput struct { diff --git a/service/resourcegroups/api_op_ListGroups.go b/service/resourcegroups/api_op_ListGroups.go index e549e5b95b6..a1e45308de4 100644 --- a/service/resourcegroups/api_op_ListGroups.go +++ b/service/resourcegroups/api_op_ListGroups.go @@ -57,23 +57,6 @@ func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns type ListGroupsInput struct { - // The parameter for receiving additional results if you receive a NextToken - // response in a previous request. A NextToken response indicates that more output - // is available. Set this parameter to the value provided by a previous call's - // NextToken response to indicate where the output should continue from. - NextToken *string - - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that the service might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. - MaxResults *int32 - // Filters, formatted as GroupFilter () objects, that you want to apply to a // ListGroups operation. // @@ -88,6 +71,23 @@ type ListGroupsInput struct { // // * AWS:EC2::CapacityReservationPool Filters []*types.GroupFilter + + // The total number of results that you want included on each page of the response. + // If you do not include this parameter, it defaults to a value that is specific to + // the operation. If additional items exist beyond the maximum you specify, the + // NextToken response element is present and has a value (is not null). Include + // that value as the NextToken request parameter in the next call to the operation + // to get the next part of the results. Note that the service might return fewer + // results than the maximum even when there are more results available. You should + // check NextToken after every operation to ensure that you receive all of the + // results. + MaxResults *int32 + + // The parameter for receiving additional results if you receive a NextToken + // response in a previous request. A NextToken response indicates that more output + // is available. Set this parameter to the value provided by a previous call's + // NextToken response to indicate where the output should continue from. + NextToken *string } type ListGroupsOutput struct { @@ -96,16 +96,16 @@ type ListGroupsOutput struct { // both the Name and the GroupArn. GroupIdentifiers []*types.GroupIdentifier + // This output element is deprecated and shouldn't be used. Refer to + // GroupIdentifiers instead. + Groups []*types.Group + // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null. NextToken *string - // This output element is deprecated and shouldn't be used. Refer to - // GroupIdentifiers instead. - Groups []*types.Group - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/resourcegroups/api_op_SearchResources.go b/service/resourcegroups/api_op_SearchResources.go index f92b767e446..4904061763b 100644 --- a/service/resourcegroups/api_op_SearchResources.go +++ b/service/resourcegroups/api_op_SearchResources.go @@ -85,17 +85,17 @@ type SearchResourcesInput struct { type SearchResourcesOutput struct { - // A list of QueryError objects. Each error is an object that contains ErrorCode - // and Message structures. Possible values for ErrorCode are - // CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING. - QueryErrors []*types.QueryError - // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null. NextToken *string + // A list of QueryError objects. Each error is an object that contains ErrorCode + // and Message structures. Possible values for ErrorCode are + // CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING. + QueryErrors []*types.QueryError + // The ARNs and resource types of resources that are members of the group that you // specified. ResourceIdentifiers []*types.ResourceIdentifier diff --git a/service/resourcegroups/api_op_UngroupResources.go b/service/resourcegroups/api_op_UngroupResources.go index 7b7737d034d..2d8cbc67749 100644 --- a/service/resourcegroups/api_op_UngroupResources.go +++ b/service/resourcegroups/api_op_UngroupResources.go @@ -57,15 +57,15 @@ func (c *Client) UngroupResources(ctx context.Context, params *UngroupResourcesI type UngroupResourcesInput struct { - // The ARNs of the resources to be removed from the group. + // The name or the ARN of the resource group from which to remove the resources. // // This member is required. - ResourceArns []*string + Group *string - // The name or the ARN of the resource group from which to remove the resources. + // The ARNs of the resources to be removed from the group. // // This member is required. - Group *string + ResourceArns []*string } type UngroupResourcesOutput struct { diff --git a/service/resourcegroups/api_op_Untag.go b/service/resourcegroups/api_op_Untag.go index 6ce78014817..225000d3b43 100644 --- a/service/resourcegroups/api_op_Untag.go +++ b/service/resourcegroups/api_op_Untag.go @@ -56,26 +56,26 @@ func (c *Client) Untag(ctx context.Context, params *UntagInput, optFns ...func(* type UntagInput struct { - // The keys of the tags to be removed. - // - // This member is required. - Keys []*string - // The ARN of the resource group from which to remove tags. The command removed // both the specified keys and any values associated with those keys. // // This member is required. Arn *string + + // The keys of the tags to be removed. + // + // This member is required. + Keys []*string } type UntagOutput struct { - // The keys of the tags that were removed. - Keys []*string - // The ARN of the resource group from which tags have been removed. Arn *string + // The keys of the tags that were removed. + Keys []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/resourcegroups/api_op_UpdateGroup.go b/service/resourcegroups/api_op_UpdateGroup.go index 9af57cd768d..5405081783e 100644 --- a/service/resourcegroups/api_op_UpdateGroup.go +++ b/service/resourcegroups/api_op_UpdateGroup.go @@ -57,9 +57,6 @@ func (c *Client) UpdateGroup(ctx context.Context, params *UpdateGroupInput, optF type UpdateGroupInput struct { - // Don't use this parameter. Use Group instead. - GroupName *string - // The new description that you want to update the resource group with. // Descriptions can contain letters, numbers, hyphens, underscores, periods, and // spaces. @@ -67,6 +64,9 @@ type UpdateGroupInput struct { // The name or the ARN of the resource group to modify. Group *string + + // Don't use this parameter. Use Group instead. + GroupName *string } type UpdateGroupOutput struct { diff --git a/service/resourcegroups/api_op_UpdateGroupQuery.go b/service/resourcegroups/api_op_UpdateGroupQuery.go index 1dd70e2984c..65d9046d0b8 100644 --- a/service/resourcegroups/api_op_UpdateGroupQuery.go +++ b/service/resourcegroups/api_op_UpdateGroupQuery.go @@ -63,11 +63,11 @@ type UpdateGroupQueryInput struct { // This member is required. ResourceQuery *types.ResourceQuery - // Don't use this parameter. Use Group instead. - GroupName *string - // The name or the ARN of the resource group to query. Group *string + + // Don't use this parameter. Use Group instead. + GroupName *string } type UpdateGroupQueryOutput struct { diff --git a/service/resourcegroups/go.mod b/service/resourcegroups/go.mod index 05ca5372366..0042f6e2f6b 100644 --- a/service/resourcegroups/go.mod +++ b/service/resourcegroups/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/resourcegroups go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/resourcegroups/types/types.go b/service/resourcegroups/types/types.go index 1b595fd5379..12abc4cae0f 100644 --- a/service/resourcegroups/types/types.go +++ b/service/resourcegroups/types/types.go @@ -29,15 +29,15 @@ type FailedResource struct { // resource types can be included in the group. type Group struct { - // The name of the resource group. + // The ARN of the resource group. // // This member is required. - Name *string + GroupArn *string - // The ARN of the resource group. + // The name of the resource group. // // This member is required. - GroupArn *string + Name *string // The description of the resource group. Description *string @@ -49,18 +49,18 @@ type Group struct { // configuration when you create the group. type GroupConfiguration struct { - // The current status of an attempt to update the group configuration. - Status GroupConfigurationStatus + // The configuration currently associated with the group and in effect. + Configuration []*GroupConfigurationItem + + // If present, the reason why a request to update the group configuration failed. + FailureReason *string // If present, the new configuration that is in the process of being applied to the // group. ProposedConfiguration []*GroupConfigurationItem - // If present, the reason why a request to update the group configuration failed. - FailureReason *string - - // The configuration currently associated with the group and in effect. - Configuration []*GroupConfigurationItem + // The current status of an attempt to update the group configuration. + Status GroupConfigurationStatus } // An item in a group configuration. A group configuration can have one or more @@ -140,11 +140,11 @@ type GroupFilter struct { // The unique identifiers for a resource group. type GroupIdentifier struct { - // The name of the resource group. - GroupName *string - // The ARN of the resource group. GroupArn *string + + // The name of the resource group. + GroupName *string } // A mapping of a query attached to a resource group that determines the AWS @@ -172,16 +172,16 @@ type GroupQuery struct { // operation, but the resulting group might have no member resources. type QueryError struct { + // Possible values are CLOUDFORMATION_STACK_INACTIVE and + // CLOUDFORMATION_STACK_NOT_EXISTING. + ErrorCode QueryErrorCode + // A message that explains the ErrorCode value. Messages might state that the // specified CloudFormation stack does not exist (or no longer exists). For // CLOUDFORMATION_STACK_INACTIVE, the message typically states that the // CloudFormation stack has a status that is not (or no longer) active, such as // CREATE_FAILED. Message *string - - // Possible values are CLOUDFORMATION_STACK_INACTIVE and - // CLOUDFORMATION_STACK_NOT_EXISTING. - ErrorCode QueryErrorCode } // A filter name and value pair that is used to obtain more specific results from a @@ -203,11 +203,11 @@ type ResourceFilter struct { // The ARN of a resource, and its resource type. type ResourceIdentifier struct { - // The resource type of a resource, such as AWS::EC2::Instance. - ResourceType *string - // The ARN of a resource. ResourceArn *string + + // The resource type of a resource, such as AWS::EC2::Instance. + ResourceType *string } // The query that is used to define a resource group or a search for resources. diff --git a/service/resourcegroupstaggingapi/api_op_DescribeReportCreation.go b/service/resourcegroupstaggingapi/api_op_DescribeReportCreation.go index decbc76e996..b0a35c2cf23 100644 --- a/service/resourcegroupstaggingapi/api_op_DescribeReportCreation.go +++ b/service/resourcegroupstaggingapi/api_op_DescribeReportCreation.go @@ -63,12 +63,12 @@ type DescribeReportCreationOutput struct { // Details of the common errors that all operations return. ErrorMessage *string - // The date and time that the report was started. - StartDate *string - // The path to the Amazon S3 bucket where the report was stored on creation. S3Location *string + // The date and time that the report was started. + StartDate *string + // Reports the status of the operation. The operation status can be one of the // following: // diff --git a/service/resourcegroupstaggingapi/api_op_GetComplianceSummary.go b/service/resourcegroupstaggingapi/api_op_GetComplianceSummary.go index 736c2978131..393416901b4 100644 --- a/service/resourcegroupstaggingapi/api_op_GetComplianceSummary.go +++ b/service/resourcegroupstaggingapi/api_op_GetComplianceSummary.go @@ -60,15 +60,17 @@ func (c *Client) GetComplianceSummary(ctx context.Context, params *GetCompliance type GetComplianceSummaryInput struct { - // The target identifiers (usually, specific account IDs) to limit the output by. - // If you use this parameter, the count of returned noncompliant resources includes - // only resources with the specified target IDs. - TargetIdFilters []*string + // A list of attributes to group the counts of noncompliant resources by. If + // supplied, the counts are sorted by those attributes. + GroupBy []types.GroupByAttribute - // A list of tag keys to limit the output by. If you use this parameter, the count - // of returned noncompliant resources includes only resources that have the - // specified tag keys. - TagKeyFilters []*string + // A limit that restricts the number of results that are returned per page. + MaxResults *int32 + + // A string that indicates that additional data is available. Leave this value + // empty for your initial request. If the response includes a PaginationToken, use + // that string for this value to request an additional page of data. + PaginationToken *string // A list of Regions to limit the output by. If you use this parameter, the count // of returned noncompliant resources includes only resources in the specified @@ -101,29 +103,27 @@ type GetComplianceSummaryInput struct { // resource type filter. ResourceTypeFilters []*string - // A string that indicates that additional data is available. Leave this value - // empty for your initial request. If the response includes a PaginationToken, use - // that string for this value to request an additional page of data. - PaginationToken *string - - // A limit that restricts the number of results that are returned per page. - MaxResults *int32 + // A list of tag keys to limit the output by. If you use this parameter, the count + // of returned noncompliant resources includes only resources that have the + // specified tag keys. + TagKeyFilters []*string - // A list of attributes to group the counts of noncompliant resources by. If - // supplied, the counts are sorted by those attributes. - GroupBy []types.GroupByAttribute + // The target identifiers (usually, specific account IDs) to limit the output by. + // If you use this parameter, the count of returned noncompliant resources includes + // only resources with the specified target IDs. + TargetIdFilters []*string } type GetComplianceSummaryOutput struct { - // A table that shows counts of noncompliant resources. - SummaryList []*types.Summary - // A string that indicates that the response contains more data than can be // returned in a single response. To receive additional data, specify this string // for the PaginationToken value in a subsequent request. PaginationToken *string + // A table that shows counts of noncompliant resources. + SummaryList []*types.Summary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/resourcegroupstaggingapi/api_op_GetResources.go b/service/resourcegroupstaggingapi/api_op_GetResources.go index 0c322813ca3..e1b47b6686c 100644 --- a/service/resourcegroupstaggingapi/api_op_GetResources.go +++ b/service/resourcegroupstaggingapi/api_op_GetResources.go @@ -73,31 +73,53 @@ func (c *Client) GetResources(ctx context.Context, params *GetResourcesInput, op type GetResourcesInput struct { - // AWS recommends using ResourcesPerPage instead of this parameter. A limit that - // restricts the number of tags (key and value pairs) returned by GetResources in - // paginated output. A resource with no tags is counted as having one tag (one key - // and value pair). GetResources does not split a resource and its associated tags - // across pages. If the specified TagsPerPage would cause such a break, a - // PaginationToken is returned in place of the affected resource and its tags. Use - // that token in another request to get the remaining data. For example, if you - // specify a TagsPerPage of 100 and the account has 22 resources with 10 tags each - // (meaning that each resource has 10 key and value pairs), the output will consist - // of three pages. The first page displays the first 10 resources, each with its 10 - // tags. The second page displays the next 10 resources, each with its 10 tags. The - // third page displays the remaining 2 resources, each with its 10 tags. You can - // set TagsPerPage to a minimum of 100 items and the maximum of 500 items. - TagsPerPage *int32 + // Specifies whether to exclude resources that are compliant with the tag policy. + // Set this to true if you are interested in retrieving information on noncompliant + // resources only. You can use this parameter only if the IncludeComplianceDetails + // parameter is also set to true. + ExcludeCompliantResources *bool - // A limit that restricts the number of resources returned by GetResources in - // paginated output. You can set ResourcesPerPage to a minimum of 1 item and the - // maximum of 100 items. - ResourcesPerPage *int32 + // Specifies whether to include details regarding the compliance with the effective + // tag policy. Set this to true to determine whether resources are compliant with + // the tag policy and to get details. + IncludeComplianceDetails *bool // A string that indicates that additional data is available. Leave this value // empty for your initial request. If the response includes a PaginationToken, use // that string for this value to request an additional page of data. PaginationToken *string + // The constraints on the resources that you want returned. The format of each + // resource type is service[:resourceType]. For example, specifying a resource type + // of ec2 returns all Amazon EC2 resources (which includes EC2 instances). + // Specifying a resource type of ec2:instance returns only EC2 instances. The + // string for each service name and resource type is the same as that embedded in a + // resource's Amazon Resource Name (ARN). Consult the AWS General Reference for the + // following: + // + // * For a list of service name strings, see AWS Service Namespaces + // (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces). + // + // + // * For resource type strings, see Example ARNs + // (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax). + // + // + // * For more information about ARNs, see Amazon Resource Names (ARNs) and AWS + // Service Namespaces + // (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // + // You + // can specify multiple resource types by using an array. The array can include up + // to 100 items. Note that the length constraint requirement applies to each + // resource type filter. + ResourceTypeFilters []*string + + // A limit that restricts the number of resources returned by GetResources in + // paginated output. You can set ResourcesPerPage to a minimum of 1 item and the + // maximum of 100 items. + ResourcesPerPage *int32 + // A list of TagFilters (keys and values). Each TagFilter specified must contain a // key with values as optional. A request can include up to 50 keys, and each key // can include up to 20 values. Note the following when deciding how to use @@ -140,54 +162,32 @@ type GetResourcesInput struct { // (key3, irrespective of the value) TagFilters []*types.TagFilter - // Specifies whether to exclude resources that are compliant with the tag policy. - // Set this to true if you are interested in retrieving information on noncompliant - // resources only. You can use this parameter only if the IncludeComplianceDetails - // parameter is also set to true. - ExcludeCompliantResources *bool - - // The constraints on the resources that you want returned. The format of each - // resource type is service[:resourceType]. For example, specifying a resource type - // of ec2 returns all Amazon EC2 resources (which includes EC2 instances). - // Specifying a resource type of ec2:instance returns only EC2 instances. The - // string for each service name and resource type is the same as that embedded in a - // resource's Amazon Resource Name (ARN). Consult the AWS General Reference for the - // following: - // - // * For a list of service name strings, see AWS Service Namespaces - // (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces). - // - // - // * For resource type strings, see Example ARNs - // (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax). - // - // - // * For more information about ARNs, see Amazon Resource Names (ARNs) and AWS - // Service Namespaces - // (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). - // - // You - // can specify multiple resource types by using an array. The array can include up - // to 100 items. Note that the length constraint requirement applies to each - // resource type filter. - ResourceTypeFilters []*string - - // Specifies whether to include details regarding the compliance with the effective - // tag policy. Set this to true to determine whether resources are compliant with - // the tag policy and to get details. - IncludeComplianceDetails *bool + // AWS recommends using ResourcesPerPage instead of this parameter. A limit that + // restricts the number of tags (key and value pairs) returned by GetResources in + // paginated output. A resource with no tags is counted as having one tag (one key + // and value pair). GetResources does not split a resource and its associated tags + // across pages. If the specified TagsPerPage would cause such a break, a + // PaginationToken is returned in place of the affected resource and its tags. Use + // that token in another request to get the remaining data. For example, if you + // specify a TagsPerPage of 100 and the account has 22 resources with 10 tags each + // (meaning that each resource has 10 key and value pairs), the output will consist + // of three pages. The first page displays the first 10 resources, each with its 10 + // tags. The second page displays the next 10 resources, each with its 10 tags. The + // third page displays the remaining 2 resources, each with its 10 tags. You can + // set TagsPerPage to a minimum of 100 items and the maximum of 500 items. + TagsPerPage *int32 } type GetResourcesOutput struct { - // A list of resource ARNs and the tags (keys and values) associated with each. - ResourceTagMappingList []*types.ResourceTagMapping - // A string that indicates that the response contains more data than can be // returned in a single response. To receive additional data, specify this string // for the PaginationToken value in a subsequent request. PaginationToken *string + // A list of resource ARNs and the tags (keys and values) associated with each. + ResourceTagMappingList []*types.ResourceTagMapping + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/resourcegroupstaggingapi/api_op_GetTagValues.go b/service/resourcegroupstaggingapi/api_op_GetTagValues.go index 6fcfdcb0cf6..0f78e6d45aa 100644 --- a/service/resourcegroupstaggingapi/api_op_GetTagValues.go +++ b/service/resourcegroupstaggingapi/api_op_GetTagValues.go @@ -57,11 +57,6 @@ func (c *Client) GetTagValues(ctx context.Context, params *GetTagValuesInput, op type GetTagValuesInput struct { - // A string that indicates that additional data is available. Leave this value - // empty for your initial request. If the response includes a PaginationToken, use - // that string for this value to request an additional page of data. - PaginationToken *string - // The key for which you want to list all existing values in the specified Region // for the AWS account. // @@ -69,6 +64,11 @@ type GetTagValuesInput struct { Key *string MaxResults *int32 + + // A string that indicates that additional data is available. Leave this value + // empty for your initial request. If the response includes a PaginationToken, use + // that string for this value to request an additional page of data. + PaginationToken *string } type GetTagValuesOutput struct { diff --git a/service/resourcegroupstaggingapi/api_op_TagResources.go b/service/resourcegroupstaggingapi/api_op_TagResources.go index 885f01a6ce5..d2af084f982 100644 --- a/service/resourcegroupstaggingapi/api_op_TagResources.go +++ b/service/resourcegroupstaggingapi/api_op_TagResources.go @@ -76,12 +76,6 @@ func (c *Client) TagResources(ctx context.Context, params *TagResourcesInput, op type TagResourcesInput struct { - // The tags that you want to add to the specified resources. A tag consists of a - // key and a value that you define. - // - // This member is required. - Tags map[string]*string - // A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. // For more information, see Amazon Resource Names (ARNs) and AWS Service // Namespaces @@ -90,6 +84,12 @@ type TagResourcesInput struct { // // This member is required. ResourceARNList []*string + + // The tags that you want to add to the specified resources. A tag consists of a + // key and a value that you define. + // + // This member is required. + Tags map[string]*string } type TagResourcesOutput struct { diff --git a/service/resourcegroupstaggingapi/api_op_UntagResources.go b/service/resourcegroupstaggingapi/api_op_UntagResources.go index b8cc5f86fce..d288668036c 100644 --- a/service/resourcegroupstaggingapi/api_op_UntagResources.go +++ b/service/resourcegroupstaggingapi/api_op_UntagResources.go @@ -69,11 +69,6 @@ func (c *Client) UntagResources(ctx context.Context, params *UntagResourcesInput type UntagResourcesInput struct { - // A list of the tag keys that you want to remove from the specified resources. - // - // This member is required. - TagKeys []*string - // A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. // For more information, see Amazon Resource Names (ARNs) and AWS Service // Namespaces @@ -82,6 +77,11 @@ type UntagResourcesInput struct { // // This member is required. ResourceARNList []*string + + // A list of the tag keys that you want to remove from the specified resources. + // + // This member is required. + TagKeys []*string } type UntagResourcesOutput struct { diff --git a/service/resourcegroupstaggingapi/go.mod b/service/resourcegroupstaggingapi/go.mod index 309da8eeb1e..7fc23c5575c 100644 --- a/service/resourcegroupstaggingapi/go.mod +++ b/service/resourcegroupstaggingapi/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/resourcegroupstaggingapi go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/resourcegroupstaggingapi/types/types.go b/service/resourcegroupstaggingapi/types/types.go index 33f84ce4f76..c95ccddecc2 100644 --- a/service/resourcegroupstaggingapi/types/types.go +++ b/service/resourcegroupstaggingapi/types/types.go @@ -6,13 +6,13 @@ package types // policy, including details on any noncompliant tag keys. type ComplianceDetails struct { + // Whether a resource is compliant with the effective tag policy. + ComplianceStatus *bool + // These are keys defined in the effective policy that are on the resource with // either incorrect case treatment or noncompliant values. KeysWithNoncompliantValues []*string - // Whether a resource is compliant with the effective tag policy. - ComplianceStatus *bool - // These tag keys on the resource are noncompliant with the effective tag policy. NoncompliantKeys []*string } @@ -44,31 +44,31 @@ type ComplianceDetails struct { // other AWS services, see the documentation for that service. type FailureInfo struct { + // The code of the common error. Valid values include InternalServiceException, + // InvalidParameterException, and any valid error code returned by the AWS service + // that hosts the resource that you want to tag. + ErrorCode ErrorCode + // The message of the common error. ErrorMessage *string // The HTTP status code of the common error. StatusCode *int32 - - // The code of the common error. Valid values include InternalServiceException, - // InvalidParameterException, and any valid error code returned by the AWS service - // that hosts the resource that you want to tag. - ErrorCode ErrorCode } // A list of resource ARNs and the tags (keys and values) that are associated with // each. type ResourceTagMapping struct { + // Information that shows whether a resource is compliant with the effective tag + // policy, including details on any noncompliant tag keys. + ComplianceDetails *ComplianceDetails + // The ARN of the resource. ResourceARN *string // The tags that have been applied to one or more AWS resources. Tags []*Tag - - // Information that shows whether a resource is compliant with the effective tag - // policy, including details on any noncompliant tag keys. - ComplianceDetails *ComplianceDetails } // A count of noncompliant resources. @@ -77,14 +77,14 @@ type Summary struct { // The timestamp that shows when this summary was generated in this Region. LastUpdated *string - // The AWS resource type. - ResourceType *string + // The count of noncompliant resources. + NonCompliantResources *int64 // The AWS Region that the summary applies to. Region *string - // Whether the target is an account, an OU, or the organization root. - TargetIdType TargetIdType + // The AWS resource type. + ResourceType *string // The account identifier or the root identifier of the organization. If you don't // know the root ID, you can call the AWS Organizations ListRoots @@ -92,8 +92,8 @@ type Summary struct { // API. TargetId *string - // The count of noncompliant resources. - NonCompliantResources *int64 + // Whether the target is an account, an OU, or the organization root. + TargetIdType TargetIdType } // The metadata that you apply to AWS resources to help you categorize and organize @@ -103,17 +103,17 @@ type Summary struct { // General Reference. type Tag struct { - // One part of a key-value pair that make up a tag. A value acts as a descriptor - // within a tag category (key). The value can be empty or null. - // - // This member is required. - Value *string - // One part of a key-value pair that makes up a tag. A key is a general label that // acts like a category for more specific tag values. // // This member is required. Key *string + + // One part of a key-value pair that make up a tag. A value acts as a descriptor + // within a tag category (key). The value can be empty or null. + // + // This member is required. + Value *string } // A list of tags (keys and values) that are used to specify the associated diff --git a/service/robomaker/api_op_CreateDeploymentJob.go b/service/robomaker/api_op_CreateDeploymentJob.go index e1eec82dce3..3cea0b4696f 100644 --- a/service/robomaker/api_op_CreateDeploymentJob.go +++ b/service/robomaker/api_op_CreateDeploymentJob.go @@ -66,24 +66,24 @@ func (c *Client) CreateDeploymentJob(ctx context.Context, params *CreateDeployme type CreateDeploymentJobInput struct { - // The requested deployment configuration. - DeploymentConfig *types.DeploymentConfig - - // The Amazon Resource Name (ARN) of the fleet to deploy. + // Unique, case-sensitive identifier that you provide to ensure the idempotency of + // the request. // // This member is required. - Fleet *string + ClientRequestToken *string // The deployment application configuration. // // This member is required. DeploymentApplicationConfigs []*types.DeploymentApplicationConfig - // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. + // The Amazon Resource Name (ARN) of the fleet to deploy. // // This member is required. - ClientRequestToken *string + Fleet *string + + // The requested deployment configuration. + DeploymentConfig *types.DeploymentConfig // A map that contains tag keys and tag values that are attached to the deployment // job. @@ -92,9 +92,18 @@ type CreateDeploymentJobInput struct { type CreateDeploymentJobOutput struct { + // The Amazon Resource Name (ARN) of the deployment job. + Arn *string + + // The time, in milliseconds since the epoch, when the fleet was created. + CreatedAt *time.Time + // The deployment application configuration. DeploymentApplicationConfigs []*types.DeploymentApplicationConfig + // The deployment configuration. + DeploymentConfig *types.DeploymentConfig + // The failure code of the simulation job if it failed: BadPermissionError

    AWS // Greengrass requires a service-level role permission to access other services. // The role must include the FailureCode types.DeploymentJobErrorCode - // The list of all tags added to the deployment job. - Tags map[string]*string - - // The deployment configuration. - DeploymentConfig *types.DeploymentConfig - - // The time, in milliseconds since the epoch, when the fleet was created. - CreatedAt *time.Time + // The failure reason of the deployment job if it failed. + FailureReason *string // The target fleet for the deployment job. Fleet *string @@ -137,11 +140,8 @@ type CreateDeploymentJobOutput struct { // The status of the deployment job. Status types.DeploymentStatus - // The Amazon Resource Name (ARN) of the deployment job. - Arn *string - - // The failure reason of the deployment job if it failed. - FailureReason *string + // The list of all tags added to the deployment job. + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/robomaker/api_op_CreateFleet.go b/service/robomaker/api_op_CreateFleet.go index 2ada52f0db3..a7b0aaff914 100644 --- a/service/robomaker/api_op_CreateFleet.go +++ b/service/robomaker/api_op_CreateFleet.go @@ -68,18 +68,18 @@ type CreateFleetInput struct { type CreateFleetOutput struct { - // The time, in milliseconds since the epoch, when the fleet was created. - CreatedAt *time.Time - - // The list of all tags added to the fleet. - Tags map[string]*string - // The Amazon Resource Name (ARN) of the fleet. Arn *string + // The time, in milliseconds since the epoch, when the fleet was created. + CreatedAt *time.Time + // The name of the fleet. Name *string + // The list of all tags added to the fleet. + Tags map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/robomaker/api_op_CreateRobot.go b/service/robomaker/api_op_CreateRobot.go index 8605e195196..d9183bd74ac 100644 --- a/service/robomaker/api_op_CreateRobot.go +++ b/service/robomaker/api_op_CreateRobot.go @@ -58,6 +58,11 @@ func (c *Client) CreateRobot(ctx context.Context, params *CreateRobotInput, optF type CreateRobotInput struct { + // The target architecture of the robot. + // + // This member is required. + Architecture types.Architecture + // The Greengrass group id. // // This member is required. @@ -70,11 +75,6 @@ type CreateRobotInput struct { // A map that contains tag keys and tag values that are attached to the robot. Tags map[string]*string - - // The target architecture of the robot. - // - // This member is required. - Architecture types.Architecture } type CreateRobotOutput struct { @@ -82,21 +82,21 @@ type CreateRobotOutput struct { // The target architecture of the robot. Architecture types.Architecture - // The name of the robot. - Name *string + // The Amazon Resource Name (ARN) of the robot. + Arn *string // The time, in milliseconds since the epoch, when the robot was created. CreatedAt *time.Time - // The list of all tags added to the robot. - Tags map[string]*string - // The Amazon Resource Name (ARN) of the Greengrass group associated with the // robot. GreengrassGroupId *string - // The Amazon Resource Name (ARN) of the robot. - Arn *string + // The name of the robot. + Name *string + + // The list of all tags added to the robot. + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/robomaker/api_op_CreateRobotApplication.go b/service/robomaker/api_op_CreateRobotApplication.go index 0188c2acd7d..bd2377d0a17 100644 --- a/service/robomaker/api_op_CreateRobotApplication.go +++ b/service/robomaker/api_op_CreateRobotApplication.go @@ -58,6 +58,11 @@ func (c *Client) CreateRobotApplication(ctx context.Context, params *CreateRobot type CreateRobotApplicationInput struct { + // The name of the robot application. + // + // This member is required. + Name *string + // The robot software suite (ROS distribuition) used by the robot application. // // This member is required. @@ -71,39 +76,34 @@ type CreateRobotApplicationInput struct { // A map that contains tag keys and tag values that are attached to the robot // application. Tags map[string]*string - - // The name of the robot application. - // - // This member is required. - Name *string } type CreateRobotApplicationOutput struct { - // The robot software suite (ROS distribution) used by the robot application. - RobotSoftwareSuite *types.RobotSoftwareSuite - - // The sources of the robot application. - Sources []*types.Source + // The Amazon Resource Name (ARN) of the robot application. + Arn *string // The time, in milliseconds since the epoch, when the robot application was last // updated. LastUpdatedAt *time.Time - // The Amazon Resource Name (ARN) of the robot application. - Arn *string + // The name of the robot application. + Name *string // The revision id of the robot application. RevisionId *string - // The version of the robot application. - Version *string + // The robot software suite (ROS distribution) used by the robot application. + RobotSoftwareSuite *types.RobotSoftwareSuite + + // The sources of the robot application. + Sources []*types.Source // The list of all tags added to the robot application. Tags map[string]*string - // The name of the robot application. - Name *string + // The version of the robot application. + Version *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/robomaker/api_op_CreateRobotApplicationVersion.go b/service/robomaker/api_op_CreateRobotApplicationVersion.go index 090c5b434b2..c093347161f 100644 --- a/service/robomaker/api_op_CreateRobotApplicationVersion.go +++ b/service/robomaker/api_op_CreateRobotApplicationVersion.go @@ -77,6 +77,12 @@ type CreateRobotApplicationVersionOutput struct { // updated. LastUpdatedAt *time.Time + // The name of the robot application. + Name *string + + // The revision id of the robot application. + RevisionId *string + // The robot software suite (ROS distribution) used by the robot application. RobotSoftwareSuite *types.RobotSoftwareSuite @@ -86,12 +92,6 @@ type CreateRobotApplicationVersionOutput struct { // The version of the robot application. Version *string - // The name of the robot application. - Name *string - - // The revision id of the robot application. - RevisionId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/robomaker/api_op_CreateSimulationApplication.go b/service/robomaker/api_op_CreateSimulationApplication.go index 20db73d1ee6..625c2b01555 100644 --- a/service/robomaker/api_op_CreateSimulationApplication.go +++ b/service/robomaker/api_op_CreateSimulationApplication.go @@ -58,12 +58,15 @@ func (c *Client) CreateSimulationApplication(ctx context.Context, params *Create type CreateSimulationApplicationInput struct { - // A map that contains tag keys and tag values that are attached to the simulation - // application. - Tags map[string]*string + // The name of the simulation application. + // + // This member is required. + Name *string - // The rendering engine for the simulation application. - RenderingEngine *types.RenderingEngine + // The robot software suite (ROS distribution) used by the simulation application. + // + // This member is required. + RobotSoftwareSuite *types.RobotSoftwareSuite // The simulation software suite used by the simulation application. // @@ -75,50 +78,47 @@ type CreateSimulationApplicationInput struct { // This member is required. Sources []*types.SourceConfig - // The robot software suite (ROS distribution) used by the simulation application. - // - // This member is required. - RobotSoftwareSuite *types.RobotSoftwareSuite + // The rendering engine for the simulation application. + RenderingEngine *types.RenderingEngine - // The name of the simulation application. - // - // This member is required. - Name *string + // A map that contains tag keys and tag values that are attached to the simulation + // application. + Tags map[string]*string } type CreateSimulationApplicationOutput struct { - // The list of all tags added to the simulation application. - Tags map[string]*string + // The Amazon Resource Name (ARN) of the simulation application. + Arn *string + + // The time, in milliseconds since the epoch, when the simulation application was + // last updated. + LastUpdatedAt *time.Time // The name of the simulation application. Name *string - // The version of the simulation application. - Version *string + // The rendering engine for the simulation application. + RenderingEngine *types.RenderingEngine // The revision id of the simulation application. RevisionId *string - // The Amazon Resource Name (ARN) of the simulation application. - Arn *string - - // The simulation software suite used by the simulation application. - SimulationSoftwareSuite *types.SimulationSoftwareSuite - // Information about the robot software suite (ROS distribution). RobotSoftwareSuite *types.RobotSoftwareSuite - // The time, in milliseconds since the epoch, when the simulation application was - // last updated. - LastUpdatedAt *time.Time - - // The rendering engine for the simulation application. - RenderingEngine *types.RenderingEngine + // The simulation software suite used by the simulation application. + SimulationSoftwareSuite *types.SimulationSoftwareSuite // The sources of the simulation application. Sources []*types.Source + // The list of all tags added to the simulation application. + Tags map[string]*string + + // The version of the simulation application. + Version *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/robomaker/api_op_CreateSimulationApplicationVersion.go b/service/robomaker/api_op_CreateSimulationApplicationVersion.go index 9533d0e7493..c7b897280f6 100644 --- a/service/robomaker/api_op_CreateSimulationApplicationVersion.go +++ b/service/robomaker/api_op_CreateSimulationApplicationVersion.go @@ -58,30 +58,18 @@ func (c *Client) CreateSimulationApplicationVersion(ctx context.Context, params type CreateSimulationApplicationVersionInput struct { - // The current revision id for the simulation application. If you provide a value - // and it matches the latest revision ID, a new version will be created. - CurrentRevisionId *string - // The application information for the simulation application. // // This member is required. Application *string + + // The current revision id for the simulation application. If you provide a value + // and it matches the latest revision ID, a new version will be created. + CurrentRevisionId *string } type CreateSimulationApplicationVersionOutput struct { - // The rendering engine for the simulation application. - RenderingEngine *types.RenderingEngine - - // The version of the simulation application. - Version *string - - // The name of the simulation application. - Name *string - - // Information about the robot software suite (ROS distribution). - RobotSoftwareSuite *types.RobotSoftwareSuite - // The Amazon Resource Name (ARN) of the simulation application. Arn *string @@ -89,15 +77,27 @@ type CreateSimulationApplicationVersionOutput struct { // last updated. LastUpdatedAt *time.Time - // The sources of the simulation application. - Sources []*types.Source + // The name of the simulation application. + Name *string + + // The rendering engine for the simulation application. + RenderingEngine *types.RenderingEngine // The revision ID of the simulation application. RevisionId *string + // Information about the robot software suite (ROS distribution). + RobotSoftwareSuite *types.RobotSoftwareSuite + // The simulation software suite used by the simulation application. SimulationSoftwareSuite *types.SimulationSoftwareSuite + // The sources of the simulation application. + Sources []*types.Source + + // The version of the simulation application. + Version *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/robomaker/api_op_CreateSimulationJob.go b/service/robomaker/api_op_CreateSimulationJob.go index a4de54780d8..98a3f6e835a 100644 --- a/service/robomaker/api_op_CreateSimulationJob.go +++ b/service/robomaker/api_op_CreateSimulationJob.go @@ -61,15 +61,12 @@ func (c *Client) CreateSimulationJob(ctx context.Context, params *CreateSimulati type CreateSimulationJobInput struct { - // Specify data sources to mount read-only files from S3 into your simulation. - // These files are available under /opt/robomaker/datasources/data_source_name. - // There is a limit of 100 files and a combined size of 25GB for all - // DataSourceConfig objects. - DataSources []*types.DataSourceConfig - - // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. - ClientRequestToken *string + // The IAM role name that allows the simulation instance to call the AWS APIs that + // are specified in its associated policies on your behalf. This is how credentials + // are passed in to your simulation job. + // + // This member is required. + IamRole *string // The maximum simulation job duration in seconds (up to 14 days or 1,209,600 // seconds. When maxJobDurationInSeconds is reached, the simulation job will status @@ -78,50 +75,62 @@ type CreateSimulationJobInput struct { // This member is required. MaxJobDurationInSeconds *int64 - // Location for output files generated by the simulation job. - OutputLocation *types.OutputLocation - - // A map that contains tag keys and tag values that are attached to the simulation - // job. - Tags map[string]*string - - // The IAM role name that allows the simulation instance to call the AWS APIs that - // are specified in its associated policies on your behalf. This is how credentials - // are passed in to your simulation job. - // - // This member is required. - IamRole *string + // Unique, case-sensitive identifier that you provide to ensure the idempotency of + // the request. + ClientRequestToken *string - // The logging configuration. - LoggingConfig *types.LoggingConfig + // Compute information for the simulation job. + Compute *types.Compute - // If your simulation job accesses resources in a VPC, you provide this parameter - // identifying the list of security group IDs and subnet IDs. These must belong to - // the same VPC. You must provide at least one security group and one subnet ID. - VpcConfig *types.VPCConfig + // Specify data sources to mount read-only files from S3 into your simulation. + // These files are available under /opt/robomaker/datasources/data_source_name. + // There is a limit of 100 files and a combined size of 25GB for all + // DataSourceConfig objects. + DataSources []*types.DataSourceConfig // The failure behavior the simulation job. Continue Restart the simulation job in // the same host instance. Fail Stop the simulation job and terminate the instance. FailureBehavior types.FailureBehavior + // The logging configuration. + LoggingConfig *types.LoggingConfig + + // Location for output files generated by the simulation job. + OutputLocation *types.OutputLocation + // The robot application to use in the simulation job. RobotApplications []*types.RobotApplicationConfig // The simulation application to use in the simulation job. SimulationApplications []*types.SimulationApplicationConfig - // Compute information for the simulation job. - Compute *types.Compute + // A map that contains tag keys and tag values that are attached to the simulation + // job. + Tags map[string]*string + + // If your simulation job accesses resources in a VPC, you provide this parameter + // identifying the list of security group IDs and subnet IDs. These must belong to + // the same VPC. You must provide at least one security group and one subnet ID. + VpcConfig *types.VPCConfig } type CreateSimulationJobOutput struct { - // Simulation job output files location. - OutputLocation *types.OutputLocation + // The Amazon Resource Name (ARN) of the simulation job. + Arn *string - // The time, in milliseconds since the epoch, when the simulation job was last - // updated. - LastUpdatedAt *time.Time + // Unique, case-sensitive identifier that you provide to ensure the idempotency of + // the request. + ClientRequestToken *string + + // Compute information for the simulation job. + Compute *types.ComputeResponse + + // The data sources for the simulation job. + DataSources []*types.DataSource + + // the failure behavior for the simulation job. + FailureBehavior types.FailureBehavior // The failure code of the simulation job if it failed: InternalServiceError // Internal service error. RobotApplicationCrash Robot application exited @@ -141,53 +150,44 @@ type CreateSimulationJobOutput struct { // for SimulationApplication does not match value during version creation. FailureCode types.SimulationJobErrorCode - // The simulation application used by the simulation job. - SimulationApplications []*types.SimulationApplicationConfig + // The IAM role that allows the simulation job to call the AWS APIs that are + // specified in its associated policies on your behalf. + IamRole *string // The time, in milliseconds since the epoch, when the simulation job was last // started. LastStartedAt *time.Time - // the failure behavior for the simulation job. - FailureBehavior types.FailureBehavior + // The time, in milliseconds since the epoch, when the simulation job was last + // updated. + LastUpdatedAt *time.Time - // The Amazon Resource Name (ARN) of the simulation job. - Arn *string + // The logging configuration. + LoggingConfig *types.LoggingConfig - // The status of the simulation job. - Status types.SimulationJobStatus + // The maximum simulation job duration in seconds. + MaxJobDurationInSeconds *int64 + + // Simulation job output files location. + OutputLocation *types.OutputLocation // The robot application used by the simulation job. RobotApplications []*types.RobotApplicationConfig - // The data sources for the simulation job. - DataSources []*types.DataSource - - // Compute information for the simulation job. - Compute *types.ComputeResponse - - // Information about the vpc configuration. - VpcConfig *types.VPCConfigResponse - - // The IAM role that allows the simulation job to call the AWS APIs that are - // specified in its associated policies on your behalf. - IamRole *string + // The simulation application used by the simulation job. + SimulationApplications []*types.SimulationApplicationConfig // The simulation job execution duration in milliseconds. SimulationTimeMillis *int64 - // The logging configuration. - LoggingConfig *types.LoggingConfig - - // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. - ClientRequestToken *string + // The status of the simulation job. + Status types.SimulationJobStatus // The list of all tags added to the simulation job. Tags map[string]*string - // The maximum simulation job duration in seconds. - MaxJobDurationInSeconds *int64 + // Information about the vpc configuration. + VpcConfig *types.VPCConfigResponse // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/robomaker/api_op_DeleteRobotApplication.go b/service/robomaker/api_op_DeleteRobotApplication.go index a48637cd137..e3337cfeecf 100644 --- a/service/robomaker/api_op_DeleteRobotApplication.go +++ b/service/robomaker/api_op_DeleteRobotApplication.go @@ -56,13 +56,13 @@ func (c *Client) DeleteRobotApplication(ctx context.Context, params *DeleteRobot type DeleteRobotApplicationInput struct { - // The version of the robot application to delete. - ApplicationVersion *string - // The Amazon Resource Name (ARN) of the the robot application. // // This member is required. Application *string + + // The version of the robot application to delete. + ApplicationVersion *string } type DeleteRobotApplicationOutput struct { diff --git a/service/robomaker/api_op_DeregisterRobot.go b/service/robomaker/api_op_DeregisterRobot.go index 6542fcea630..e443b43efc9 100644 --- a/service/robomaker/api_op_DeregisterRobot.go +++ b/service/robomaker/api_op_DeregisterRobot.go @@ -69,12 +69,12 @@ type DeregisterRobotInput struct { type DeregisterRobotOutput struct { - // The Amazon Resource Name (ARN) of the robot. - Robot *string - // The Amazon Resource Name (ARN) of the fleet. Fleet *string + // The Amazon Resource Name (ARN) of the robot. + Robot *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/robomaker/api_op_DescribeDeploymentJob.go b/service/robomaker/api_op_DescribeDeploymentJob.go index 8b993ca5fd6..f0cbe390951 100644 --- a/service/robomaker/api_op_DescribeDeploymentJob.go +++ b/service/robomaker/api_op_DescribeDeploymentJob.go @@ -66,17 +66,11 @@ type DescribeDeploymentJobInput struct { type DescribeDeploymentJobOutput struct { - // The deployment job failure code. - FailureCode types.DeploymentJobErrorCode - - // The status of the deployment job. - Status types.DeploymentStatus - - // A short description of the reason why the deployment job failed. - FailureReason *string + // The Amazon Resource Name (ARN) of the deployment job. + Arn *string - // The list of all tags added to the specified deployment job. - Tags map[string]*string + // The time, in milliseconds since the epoch, when the deployment job was created. + CreatedAt *time.Time // The deployment application configuration. DeploymentApplicationConfigs []*types.DeploymentApplicationConfig @@ -84,17 +78,23 @@ type DescribeDeploymentJobOutput struct { // The deployment configuration. DeploymentConfig *types.DeploymentConfig + // The deployment job failure code. + FailureCode types.DeploymentJobErrorCode + + // A short description of the reason why the deployment job failed. + FailureReason *string + // The Amazon Resource Name (ARN) of the fleet. Fleet *string - // The Amazon Resource Name (ARN) of the deployment job. - Arn *string - // A list of robot deployment summaries. RobotDeploymentSummary []*types.RobotDeployment - // The time, in milliseconds since the epoch, when the deployment job was created. - CreatedAt *time.Time + // The status of the deployment job. + Status types.DeploymentStatus + + // The list of all tags added to the specified deployment job. + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/robomaker/api_op_DescribeFleet.go b/service/robomaker/api_op_DescribeFleet.go index 7f9a5b51f83..5b484d577e3 100644 --- a/service/robomaker/api_op_DescribeFleet.go +++ b/service/robomaker/api_op_DescribeFleet.go @@ -69,26 +69,26 @@ type DescribeFleetOutput struct { // The Amazon Resource Name (ARN) of the fleet. Arn *string + // The time, in milliseconds since the epoch, when the fleet was created. + CreatedAt *time.Time + + // The Amazon Resource Name (ARN) of the last deployment job. + LastDeploymentJob *string + // The status of the last deployment. LastDeploymentStatus types.DeploymentStatus // The time of the last deployment. LastDeploymentTime *time.Time - // The list of all tags added to the specified fleet. - Tags map[string]*string + // The name of the fleet. + Name *string // A list of robots. Robots []*types.Robot - // The Amazon Resource Name (ARN) of the last deployment job. - LastDeploymentJob *string - - // The time, in milliseconds since the epoch, when the fleet was created. - CreatedAt *time.Time - - // The name of the fleet. - Name *string + // The list of all tags added to the specified fleet. + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/robomaker/api_op_DescribeRobot.go b/service/robomaker/api_op_DescribeRobot.go index f48cf76c87d..724824bf088 100644 --- a/service/robomaker/api_op_DescribeRobot.go +++ b/service/robomaker/api_op_DescribeRobot.go @@ -66,14 +66,20 @@ type DescribeRobotInput struct { type DescribeRobotOutput struct { + // The target architecture of the robot application. + Architecture types.Architecture + + // The Amazon Resource Name (ARN) of the robot. + Arn *string + // The time, in milliseconds since the epoch, when the robot was created. CreatedAt *time.Time - // The status of the fleet. - Status types.RobotStatus + // The Amazon Resource Name (ARN) of the fleet. + FleetArn *string - // The list of all tags added to the specified robot. - Tags map[string]*string + // The Greengrass group id. + GreengrassGroupId *string // The Amazon Resource Name (ARN) of the last deployment job. LastDeploymentJob *string @@ -81,20 +87,14 @@ type DescribeRobotOutput struct { // The time of the last deployment job. LastDeploymentTime *time.Time - // The Amazon Resource Name (ARN) of the fleet. - FleetArn *string - // The name of the robot. Name *string - // The Amazon Resource Name (ARN) of the robot. - Arn *string - - // The target architecture of the robot application. - Architecture types.Architecture + // The status of the fleet. + Status types.RobotStatus - // The Greengrass group id. - GreengrassGroupId *string + // The list of all tags added to the specified robot. + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/robomaker/api_op_DescribeRobotApplication.go b/service/robomaker/api_op_DescribeRobotApplication.go index 79a82c3ab59..3bdb0716729 100644 --- a/service/robomaker/api_op_DescribeRobotApplication.go +++ b/service/robomaker/api_op_DescribeRobotApplication.go @@ -58,29 +58,26 @@ func (c *Client) DescribeRobotApplication(ctx context.Context, params *DescribeR type DescribeRobotApplicationInput struct { - // The version of the robot application to describe. - ApplicationVersion *string - // The Amazon Resource Name (ARN) of the robot application. // // This member is required. Application *string + + // The version of the robot application to describe. + ApplicationVersion *string } type DescribeRobotApplicationOutput struct { - // The list of all tags added to the specified robot application. - Tags map[string]*string - - // The version of the robot application. - Version *string + // The Amazon Resource Name (ARN) of the robot application. + Arn *string // The time, in milliseconds since the epoch, when the robot application was last // updated. LastUpdatedAt *time.Time - // The sources of the robot application. - Sources []*types.Source + // The name of the robot application. + Name *string // The revision id of the robot application. RevisionId *string @@ -88,11 +85,14 @@ type DescribeRobotApplicationOutput struct { // The robot software suite (ROS distribution) used by the robot application. RobotSoftwareSuite *types.RobotSoftwareSuite - // The name of the robot application. - Name *string + // The sources of the robot application. + Sources []*types.Source - // The Amazon Resource Name (ARN) of the robot application. - Arn *string + // The list of all tags added to the specified robot application. + Tags map[string]*string + + // The version of the robot application. + Version *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/robomaker/api_op_DescribeSimulationApplication.go b/service/robomaker/api_op_DescribeSimulationApplication.go index aa0725d3636..dfa0a1af2be 100644 --- a/service/robomaker/api_op_DescribeSimulationApplication.go +++ b/service/robomaker/api_op_DescribeSimulationApplication.go @@ -69,36 +69,36 @@ type DescribeSimulationApplicationInput struct { type DescribeSimulationApplicationOutput struct { - // The sources of the simulation application. - Sources []*types.Source - - // The revision id of the simulation application. - RevisionId *string - - // The version of the simulation application. - Version *string - - // The list of all tags added to the specified simulation application. - Tags map[string]*string - // The Amazon Resource Name (ARN) of the robot simulation application. Arn *string - // Information about the robot software suite (ROS distribution). - RobotSoftwareSuite *types.RobotSoftwareSuite + // The time, in milliseconds since the epoch, when the simulation application was + // last updated. + LastUpdatedAt *time.Time + + // The name of the simulation application. + Name *string // The rendering engine for the simulation application. RenderingEngine *types.RenderingEngine - // The name of the simulation application. - Name *string + // The revision id of the simulation application. + RevisionId *string + + // Information about the robot software suite (ROS distribution). + RobotSoftwareSuite *types.RobotSoftwareSuite // The simulation software suite used by the simulation application. SimulationSoftwareSuite *types.SimulationSoftwareSuite - // The time, in milliseconds since the epoch, when the simulation application was - // last updated. - LastUpdatedAt *time.Time + // The sources of the simulation application. + Sources []*types.Source + + // The list of all tags added to the specified simulation application. + Tags map[string]*string + + // The version of the simulation application. + Version *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/robomaker/api_op_DescribeSimulationJob.go b/service/robomaker/api_op_DescribeSimulationJob.go index f111d105617..4230abf6463 100644 --- a/service/robomaker/api_op_DescribeSimulationJob.go +++ b/service/robomaker/api_op_DescribeSimulationJob.go @@ -66,70 +66,22 @@ type DescribeSimulationJobInput struct { type DescribeSimulationJobOutput struct { - // The time, in milliseconds since the epoch, when the simulation job was last - // updated. - LastUpdatedAt *time.Time - - // The name of the simulation job. - Name *string - - // The logging configuration. - LoggingConfig *types.LoggingConfig - - // A list of robot applications. - RobotApplications []*types.RobotApplicationConfig - - // The data sources for the simulation job. - DataSources []*types.DataSource - - // The status of the simulation job. - Status types.SimulationJobStatus - // The Amazon Resource Name (ARN) of the simulation job. Arn *string - // A list of simulation applications. - SimulationApplications []*types.SimulationApplicationConfig - - // The simulation job execution duration in milliseconds. - SimulationTimeMillis *int64 - - // The IAM role that allows the simulation instance to call the AWS APIs that are - // specified in its associated policies on your behalf. - IamRole *string + // Unique, case-sensitive identifier that you provide to ensure the idempotency of + // the request. + ClientRequestToken *string // Compute information for the simulation job. Compute *types.ComputeResponse - // The VPC configuration. - VpcConfig *types.VPCConfigResponse - - // The network interface information for the simulation job. - NetworkInterface *types.NetworkInterface + // The data sources for the simulation job. + DataSources []*types.DataSource // The failure behavior for the simulation job. FailureBehavior types.FailureBehavior - // Details about why the simulation job failed. For more information about - // troubleshooting, see Troubleshooting - // (https://docs.aws.amazon.com/robomaker/latest/dg/troubleshooting.html). - FailureReason *string - - // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. - ClientRequestToken *string - - // The time, in milliseconds since the epoch, when the simulation job was last - // started. - LastStartedAt *time.Time - - // The maximum job duration in seconds. The value must be 8 days (691,200 seconds) - // or less. - MaxJobDurationInSeconds *int64 - - // The list of all tags added to the specified simulation job. - Tags map[string]*string - // The failure code of the simulation job if it failed: InternalServiceError // Internal service error. RobotApplicationCrash Robot application exited // abnormally. SimulationApplicationCrash Simulation application exited abnormally. @@ -148,9 +100,57 @@ type DescribeSimulationJobOutput struct { // for SimulationApplication does not match value during version creation. FailureCode types.SimulationJobErrorCode + // Details about why the simulation job failed. For more information about + // troubleshooting, see Troubleshooting + // (https://docs.aws.amazon.com/robomaker/latest/dg/troubleshooting.html). + FailureReason *string + + // The IAM role that allows the simulation instance to call the AWS APIs that are + // specified in its associated policies on your behalf. + IamRole *string + + // The time, in milliseconds since the epoch, when the simulation job was last + // started. + LastStartedAt *time.Time + + // The time, in milliseconds since the epoch, when the simulation job was last + // updated. + LastUpdatedAt *time.Time + + // The logging configuration. + LoggingConfig *types.LoggingConfig + + // The maximum job duration in seconds. The value must be 8 days (691,200 seconds) + // or less. + MaxJobDurationInSeconds *int64 + + // The name of the simulation job. + Name *string + + // The network interface information for the simulation job. + NetworkInterface *types.NetworkInterface + // Location for output files generated by the simulation job. OutputLocation *types.OutputLocation + // A list of robot applications. + RobotApplications []*types.RobotApplicationConfig + + // A list of simulation applications. + SimulationApplications []*types.SimulationApplicationConfig + + // The simulation job execution duration in milliseconds. + SimulationTimeMillis *int64 + + // The status of the simulation job. + Status types.SimulationJobStatus + + // The list of all tags added to the specified simulation job. + Tags map[string]*string + + // The VPC configuration. + VpcConfig *types.VPCConfigResponse + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/robomaker/api_op_DescribeSimulationJobBatch.go b/service/robomaker/api_op_DescribeSimulationJobBatch.go index fb21c5f795f..fa3500f0e49 100644 --- a/service/robomaker/api_op_DescribeSimulationJobBatch.go +++ b/service/robomaker/api_op_DescribeSimulationJobBatch.go @@ -66,10 +66,30 @@ type DescribeSimulationJobBatchInput struct { type DescribeSimulationJobBatchOutput struct { + // The Amazon Resource Name (ARN) of the batch. + Arn *string + + // The batch policy. + BatchPolicy *types.BatchPolicy + // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. ClientRequestToken *string + // The time, in milliseconds since the epoch, when the simulation job batch was + // created. + CreatedAt *time.Time + + // A list of created simulation job summaries. + CreatedRequests []*types.SimulationJobSummary + + // A list of failed create simulation job requests. The request failed to be + // created into a simulation job. Failed requests do not have a simulation job ID. + FailedRequests []*types.FailedCreateSimulationJobRequest + + // The failure code of the simulation job batch. + FailureCode types.SimulationJobBatchErrorCode + // The reason the simulation job batch failed. FailureReason *string @@ -77,9 +97,9 @@ type DescribeSimulationJobBatchOutput struct { // last updated. LastUpdatedAt *time.Time - // The time, in milliseconds since the epoch, when the simulation job batch was - // created. - CreatedAt *time.Time + // A list of pending simulation job requests. These requests have not yet been + // created into simulation jobs. + PendingRequests []*types.SimulationJobRequest // The status of the batch. Pending The simulation job batch request is pending. // InProgress The simulation job batch is in progress. Failed The simulation job @@ -98,30 +118,10 @@ type DescribeSimulationJobBatchOutput struct { // will be TimedOut. TimedOut The simulation batch job timed out. Status types.SimulationJobBatchStatus - // A list of pending simulation job requests. These requests have not yet been - // created into simulation jobs. - PendingRequests []*types.SimulationJobRequest - - // A list of created simulation job summaries. - CreatedRequests []*types.SimulationJobSummary - - // The Amazon Resource Name (ARN) of the batch. - Arn *string - // A map that contains tag keys and tag values that are attached to the simulation // job batch. Tags map[string]*string - // The failure code of the simulation job batch. - FailureCode types.SimulationJobBatchErrorCode - - // The batch policy. - BatchPolicy *types.BatchPolicy - - // A list of failed create simulation job requests. The request failed to be - // created into a simulation job. Failed requests do not have a simulation job ID. - FailedRequests []*types.FailedCreateSimulationJobRequest - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/robomaker/api_op_ListFleets.go b/service/robomaker/api_op_ListFleets.go index cbe9405159c..d45b9ba40ae 100644 --- a/service/robomaker/api_op_ListFleets.go +++ b/service/robomaker/api_op_ListFleets.go @@ -81,15 +81,15 @@ type ListFleetsInput struct { type ListFleetsOutput struct { + // A list of fleet details meeting the request criteria. + FleetDetails []*types.Fleet + // The nextToken value to include in a future ListDeploymentJobs request. When the // results of a ListFleets request exceed maxResults, this value can be used to // retrieve the next page of results. This value is null when there are no more // results to return. NextToken *string - // A list of fleet details meeting the request criteria. - FleetDetails []*types.Fleet - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/robomaker/api_op_ListRobotApplications.go b/service/robomaker/api_op_ListRobotApplications.go index aef241a30bc..d54625dd0f9 100644 --- a/service/robomaker/api_op_ListRobotApplications.go +++ b/service/robomaker/api_op_ListRobotApplications.go @@ -70,27 +70,27 @@ type ListRobotApplicationsInput struct { // returns up to 100 results and a nextToken value if applicable. MaxResults *int32 - // The version qualifier of the robot application. - VersionQualifier *string - // The nextToken value returned from a previous paginated ListRobotApplications // request where maxResults was used and the results exceeded the value of that // parameter. Pagination continues from the end of the previous results that // returned the nextToken value. NextToken *string + + // The version qualifier of the robot application. + VersionQualifier *string } type ListRobotApplicationsOutput struct { - // A list of robot application summaries that meet the criteria of the request. - RobotApplicationSummaries []*types.RobotApplicationSummary - // The nextToken value to include in a future ListRobotApplications request. When // the results of a ListRobotApplications request exceed maxResults, this value can // be used to retrieve the next page of results. This value is null when there are // no more results to return. NextToken *string + // A list of robot application summaries that meet the criteria of the request. + RobotApplicationSummaries []*types.RobotApplicationSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/robomaker/api_op_ListRobots.go b/service/robomaker/api_op_ListRobots.go index 61cef9c4c20..fd6371bfd88 100644 --- a/service/robomaker/api_op_ListRobots.go +++ b/service/robomaker/api_op_ListRobots.go @@ -64,12 +64,6 @@ type ListRobotsInput struct { // Available. Filters []*types.Filter - // The nextToken value returned from a previous paginated ListRobots request where - // maxResults was used and the results exceeded the value of that parameter. - // Pagination continues from the end of the previous results that returned the - // nextToken value. - NextToken *string - // When this parameter is used, ListRobots only returns maxResults results in a // single page along with a nextToken response element. The remaining results of // the initial request can be seen by sending another ListRobots request with the @@ -77,19 +71,25 @@ type ListRobotsInput struct { // is not used, then ListRobots returns up to 200 results and a nextToken value if // applicable. MaxResults *int32 + + // The nextToken value returned from a previous paginated ListRobots request where + // maxResults was used and the results exceeded the value of that parameter. + // Pagination continues from the end of the previous results that returned the + // nextToken value. + NextToken *string } type ListRobotsOutput struct { - // A list of robots that meet the criteria of the request. - Robots []*types.Robot - // The nextToken value to include in a future ListRobots request. When the results // of a ListRobot request exceed maxResults, this value can be used to retrieve the // next page of results. This value is null when there are no more results to // return. NextToken *string + // A list of robots that meet the criteria of the request. + Robots []*types.Robot + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/robomaker/api_op_ListSimulationJobBatches.go b/service/robomaker/api_op_ListSimulationJobBatches.go index abadadf9530..d3d739b8c21 100644 --- a/service/robomaker/api_op_ListSimulationJobBatches.go +++ b/service/robomaker/api_op_ListSimulationJobBatches.go @@ -57,6 +57,9 @@ func (c *Client) ListSimulationJobBatches(ctx context.Context, params *ListSimul type ListSimulationJobBatchesInput struct { + // Optional filters to limit results. + Filters []*types.Filter + // When this parameter is used, ListSimulationJobBatches only returns maxResults // results in a single page along with a nextToken response element. The remaining // results of the initial request can be seen by sending another @@ -68,22 +71,19 @@ type ListSimulationJobBatchesInput struct { // parameter. Pagination continues from the end of the previous results that // returned the nextToken value. NextToken *string - - // Optional filters to limit results. - Filters []*types.Filter } type ListSimulationJobBatchesOutput struct { - // A list of simulation job batch summaries. - SimulationJobBatchSummaries []*types.SimulationJobBatchSummary - // The nextToken value to include in a future ListSimulationJobBatches request. // When the results of a ListSimulationJobBatches request exceed maxResults, this // value can be used to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string + // A list of simulation job batch summaries. + SimulationJobBatchSummaries []*types.SimulationJobBatchSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/robomaker/api_op_ListSimulationJobs.go b/service/robomaker/api_op_ListSimulationJobs.go index 370e232b154..8813bf6aebb 100644 --- a/service/robomaker/api_op_ListSimulationJobs.go +++ b/service/robomaker/api_op_ListSimulationJobs.go @@ -57,13 +57,12 @@ func (c *Client) ListSimulationJobs(ctx context.Context, params *ListSimulationJ type ListSimulationJobsInput struct { - // The nextToken value returned from a previous paginated ListSimulationJobs - // request where maxResults was used and the results exceeded the value of that - // parameter. Pagination continues from the end of the previous results that - // returned the nextToken value. This token should be treated as an opaque - // identifier that is only used to retrieve the next items in a list and not for - // other programmatic purposes. - NextToken *string + // Optional filters to limit results. The filter names status and + // simulationApplicationName and robotApplicationName are supported. When + // filtering, you must use the complete value of the filtered item. You can use up + // to three filters, but they must be for the same named item. For example, if you + // are looking for items with the status Preparing or the status Running. + Filters []*types.Filter // When this parameter is used, ListSimulationJobs only returns maxResults results // in a single page along with a nextToken response element. The remaining results @@ -73,12 +72,13 @@ type ListSimulationJobsInput struct { // nextToken value if applicable. MaxResults *int32 - // Optional filters to limit results. The filter names status and - // simulationApplicationName and robotApplicationName are supported. When - // filtering, you must use the complete value of the filtered item. You can use up - // to three filters, but they must be for the same named item. For example, if you - // are looking for items with the status Preparing or the status Running. - Filters []*types.Filter + // The nextToken value returned from a previous paginated ListSimulationJobs + // request where maxResults was used and the results exceeded the value of that + // parameter. Pagination continues from the end of the previous results that + // returned the nextToken value. This token should be treated as an opaque + // identifier that is only used to retrieve the next items in a list and not for + // other programmatic purposes. + NextToken *string } type ListSimulationJobsOutput struct { diff --git a/service/robomaker/api_op_RegisterRobot.go b/service/robomaker/api_op_RegisterRobot.go index d18126139c0..1756c711993 100644 --- a/service/robomaker/api_op_RegisterRobot.go +++ b/service/robomaker/api_op_RegisterRobot.go @@ -56,15 +56,15 @@ func (c *Client) RegisterRobot(ctx context.Context, params *RegisterRobotInput, type RegisterRobotInput struct { - // The Amazon Resource Name (ARN) of the robot. + // The Amazon Resource Name (ARN) of the fleet. // // This member is required. - Robot *string + Fleet *string - // The Amazon Resource Name (ARN) of the fleet. + // The Amazon Resource Name (ARN) of the robot. // // This member is required. - Fleet *string + Robot *string } type RegisterRobotOutput struct { diff --git a/service/robomaker/api_op_StartSimulationJobBatch.go b/service/robomaker/api_op_StartSimulationJobBatch.go index 5dd0b68f069..bb1305e901e 100644 --- a/service/robomaker/api_op_StartSimulationJobBatch.go +++ b/service/robomaker/api_op_StartSimulationJobBatch.go @@ -61,40 +61,35 @@ func (c *Client) StartSimulationJobBatch(ctx context.Context, params *StartSimul type StartSimulationJobBatchInput struct { - // The batch policy. - BatchPolicy *types.BatchPolicy - - // A map that contains tag keys and tag values that are attached to the deployment - // job batch. - Tags map[string]*string - // A list of simulation job requests to create in the batch. // // This member is required. CreateSimulationJobRequests []*types.SimulationJobRequest + // The batch policy. + BatchPolicy *types.BatchPolicy + // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. ClientRequestToken *string + + // A map that contains tag keys and tag values that are attached to the deployment + // job batch. + Tags map[string]*string } type StartSimulationJobBatchOutput struct { - // A list of failed simulation job requests. The request failed to be created into - // a simulation job. Failed requests do not have a simulation job ID. - FailedRequests []*types.FailedCreateSimulationJobRequest + // The Amazon Resource Name (arn) of the batch. + Arn *string - // The reason the simulation job batch failed. - FailureReason *string + // The batch policy. + BatchPolicy *types.BatchPolicy // Unique, case-sensitive identifier that you provide to ensure the idempotency of // the request. ClientRequestToken *string - // A list of pending simulation job requests. These requests have not yet been - // created into simulation jobs. - PendingRequests []*types.SimulationJobRequest - // The time, in milliseconds since the epoch, when the simulation job batch was // created. CreatedAt *time.Time @@ -102,9 +97,20 @@ type StartSimulationJobBatchOutput struct { // A list of created simulation job request summaries. CreatedRequests []*types.SimulationJobSummary + // A list of failed simulation job requests. The request failed to be created into + // a simulation job. Failed requests do not have a simulation job ID. + FailedRequests []*types.FailedCreateSimulationJobRequest + // The failure code if the simulation job batch failed. FailureCode types.SimulationJobBatchErrorCode + // The reason the simulation job batch failed. + FailureReason *string + + // A list of pending simulation job requests. These requests have not yet been + // created into simulation jobs. + PendingRequests []*types.SimulationJobRequest + // The status of the simulation job batch. Pending The simulation job batch request // is pending. InProgress The simulation job batch is in progress. Failed The // simulation job batch failed. One or more simulation job requests could not be @@ -123,12 +129,6 @@ type StartSimulationJobBatchOutput struct { // batch job timed out. Status types.SimulationJobBatchStatus - // The Amazon Resource Name (arn) of the batch. - Arn *string - - // The batch policy. - BatchPolicy *types.BatchPolicy - // A map that contains tag keys and tag values that are attached to the deployment // job batch. Tags map[string]*string diff --git a/service/robomaker/api_op_SyncDeploymentJob.go b/service/robomaker/api_op_SyncDeploymentJob.go index e009cb7d40e..01ed0700b24 100644 --- a/service/robomaker/api_op_SyncDeploymentJob.go +++ b/service/robomaker/api_op_SyncDeploymentJob.go @@ -75,15 +75,18 @@ type SyncDeploymentJobInput struct { type SyncDeploymentJobOutput struct { - // The status of the synchronization job. - Status types.DeploymentStatus + // The Amazon Resource Name (ARN) of the synchronization request. + Arn *string - // The failure reason if the job fails. - FailureReason *string + // The time, in milliseconds since the epoch, when the fleet was created. + CreatedAt *time.Time // Information about the deployment application configurations. DeploymentApplicationConfigs []*types.DeploymentApplicationConfig + // Information about the deployment configuration. + DeploymentConfig *types.DeploymentConfig + // The failure code if the job fails: InternalServiceError Internal service error. // RobotApplicationCrash Robot application exited abnormally. // SimulationApplicationCrash Simulation application exited abnormally. @@ -102,17 +105,14 @@ type SyncDeploymentJobOutput struct { // for SimulationApplication does not match value during version creation. FailureCode types.DeploymentJobErrorCode + // The failure reason if the job fails. + FailureReason *string + // The Amazon Resource Name (ARN) of the fleet. Fleet *string - // Information about the deployment configuration. - DeploymentConfig *types.DeploymentConfig - - // The Amazon Resource Name (ARN) of the synchronization request. - Arn *string - - // The time, in milliseconds since the epoch, when the fleet was created. - CreatedAt *time.Time + // The status of the synchronization job. + Status types.DeploymentStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/robomaker/api_op_TagResource.go b/service/robomaker/api_op_TagResource.go index e2ce97dfc2d..d4b37896554 100644 --- a/service/robomaker/api_op_TagResource.go +++ b/service/robomaker/api_op_TagResource.go @@ -61,15 +61,15 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // A map that contains tag keys and tag values that are attached to the resource. + // The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are tagging. // // This member is required. - Tags map[string]*string + ResourceArn *string - // The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are tagging. + // A map that contains tag keys and tag values that are attached to the resource. // // This member is required. - ResourceArn *string + Tags map[string]*string } type TagResourceOutput struct { diff --git a/service/robomaker/api_op_UpdateRobotApplication.go b/service/robomaker/api_op_UpdateRobotApplication.go index b724c103dd9..dda9d515088 100644 --- a/service/robomaker/api_op_UpdateRobotApplication.go +++ b/service/robomaker/api_op_UpdateRobotApplication.go @@ -58,14 +58,6 @@ func (c *Client) UpdateRobotApplication(ctx context.Context, params *UpdateRobot type UpdateRobotApplicationInput struct { - // The revision id for the robot application. - CurrentRevisionId *string - - // The sources of the robot application. - // - // This member is required. - Sources []*types.SourceConfig - // The application information for the robot application. // // This member is required. @@ -75,31 +67,39 @@ type UpdateRobotApplicationInput struct { // // This member is required. RobotSoftwareSuite *types.RobotSoftwareSuite + + // The sources of the robot application. + // + // This member is required. + Sources []*types.SourceConfig + + // The revision id for the robot application. + CurrentRevisionId *string } type UpdateRobotApplicationOutput struct { - // The sources of the robot application. - Sources []*types.Source + // The Amazon Resource Name (ARN) of the updated robot application. + Arn *string // The time, in milliseconds since the epoch, when the robot application was last // updated. LastUpdatedAt *time.Time - // The robot software suite (ROS distribution) used by the robot application. - RobotSoftwareSuite *types.RobotSoftwareSuite + // The name of the robot application. + Name *string // The revision id of the robot application. RevisionId *string - // The version of the robot application. - Version *string + // The robot software suite (ROS distribution) used by the robot application. + RobotSoftwareSuite *types.RobotSoftwareSuite - // The name of the robot application. - Name *string + // The sources of the robot application. + Sources []*types.Source - // The Amazon Resource Name (ARN) of the updated robot application. - Arn *string + // The version of the robot application. + Version *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/robomaker/api_op_UpdateSimulationApplication.go b/service/robomaker/api_op_UpdateSimulationApplication.go index 417935c00e1..896713ba42d 100644 --- a/service/robomaker/api_op_UpdateSimulationApplication.go +++ b/service/robomaker/api_op_UpdateSimulationApplication.go @@ -58,63 +58,63 @@ func (c *Client) UpdateSimulationApplication(ctx context.Context, params *Update type UpdateSimulationApplicationInput struct { - // The simulation software suite used by the simulation application. + // The application information for the simulation application. // // This member is required. - SimulationSoftwareSuite *types.SimulationSoftwareSuite - - // The revision id for the robot application. - CurrentRevisionId *string + Application *string // Information about the robot software suite (ROS distribution). // // This member is required. RobotSoftwareSuite *types.RobotSoftwareSuite - // The rendering engine for the simulation application. - RenderingEngine *types.RenderingEngine + // The simulation software suite used by the simulation application. + // + // This member is required. + SimulationSoftwareSuite *types.SimulationSoftwareSuite // The sources of the simulation application. // // This member is required. Sources []*types.SourceConfig - // The application information for the simulation application. - // - // This member is required. - Application *string + // The revision id for the robot application. + CurrentRevisionId *string + + // The rendering engine for the simulation application. + RenderingEngine *types.RenderingEngine } type UpdateSimulationApplicationOutput struct { - // The sources of the simulation application. - Sources []*types.Source - // The Amazon Resource Name (ARN) of the updated simulation application. Arn *string - // The simulation software suite used by the simulation application. - SimulationSoftwareSuite *types.SimulationSoftwareSuite - // The time, in milliseconds since the epoch, when the simulation application was // last updated. LastUpdatedAt *time.Time - // The revision id of the simulation application. - RevisionId *string - // The name of the simulation application. Name *string + // The rendering engine for the simulation application. + RenderingEngine *types.RenderingEngine + + // The revision id of the simulation application. + RevisionId *string + // Information about the robot software suite (ROS distribution). RobotSoftwareSuite *types.RobotSoftwareSuite + // The simulation software suite used by the simulation application. + SimulationSoftwareSuite *types.SimulationSoftwareSuite + + // The sources of the simulation application. + Sources []*types.Source + // The version of the robot application. Version *string - // The rendering engine for the simulation application. - RenderingEngine *types.RenderingEngine - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/robomaker/go.mod b/service/robomaker/go.mod index 081c24b0e05..ab6753ed30e 100644 --- a/service/robomaker/go.mod +++ b/service/robomaker/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/robomaker go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/robomaker/types/types.go b/service/robomaker/types/types.go index 33e30d781d1..47a440ab796 100644 --- a/service/robomaker/types/types.go +++ b/service/robomaker/types/types.go @@ -9,6 +9,12 @@ import ( // Information about the batch policy. type BatchPolicy struct { + // The number of active simulation jobs create as part of the batch that can be in + // an active state at the same time. Active states include: Pending,Preparing, + // Running, Restarting, RunningFailed and Terminating. All other states are + // terminal states. + MaxConcurrency *int32 + // The amount of time, in seconds, to wait for the batch to complete.

    If a // batch times out, and there are pending requests that were failing due to an // internal failure (like InternalServiceError), they will be moved to @@ -17,12 +23,6 @@ type BatchPolicy struct { // moved to the failed list and the batch status will be TimedOut. //

    TimeoutInSeconds *int64 - - // The number of active simulation jobs create as part of the batch that can be in - // an active state at the same time. Active states include: Pending,Preparing, - // Running, Restarting, RunningFailed and Terminating. All other states are - // terminal states. - MaxConcurrency *int32 } // Compute information for the simulation job. @@ -85,86 +85,86 @@ type DeploymentApplicationConfig struct { // This member is required. Application *string - // The launch configuration. + // The version of the application. // // This member is required. - LaunchConfig *DeploymentLaunchConfig + ApplicationVersion *string - // The version of the application. + // The launch configuration. // // This member is required. - ApplicationVersion *string + LaunchConfig *DeploymentLaunchConfig } // Information about a deployment configuration. type DeploymentConfig struct { - // The percentage of deployments that need to fail before stopping deployment. - FailureThresholdPercentage *int32 + // The percentage of robots receiving the deployment at the same time. + ConcurrentDeploymentPercentage *int32 // The download condition file. DownloadConditionFile *S3Object + // The percentage of deployments that need to fail before stopping deployment. + FailureThresholdPercentage *int32 + // The amount of time, in seconds, to wait for deployment to a single robot to // complete. Choose a time between 1 minute and 7 days. The default is 5 hours. RobotDeploymentTimeoutInSeconds *int64 - - // The percentage of robots receiving the deployment at the same time. - ConcurrentDeploymentPercentage *int32 } // Information about a deployment job. type DeploymentJob struct { - // A short description of the reason why the deployment job failed. - FailureReason *string - - // The status of the deployment job. - Status DeploymentStatus - - // The deployment job failure code. - FailureCode DeploymentJobErrorCode + // The Amazon Resource Name (ARN) of the deployment job. + Arn *string // The time, in milliseconds since the epoch, when the deployment job was created. CreatedAt *time.Time + // The deployment application configuration. + DeploymentApplicationConfigs []*DeploymentApplicationConfig + // The deployment configuration. DeploymentConfig *DeploymentConfig - // The deployment application configuration. - DeploymentApplicationConfigs []*DeploymentApplicationConfig + // The deployment job failure code. + FailureCode DeploymentJobErrorCode - // The Amazon Resource Name (ARN) of the deployment job. - Arn *string + // A short description of the reason why the deployment job failed. + FailureReason *string // The Amazon Resource Name (ARN) of the fleet. Fleet *string + + // The status of the deployment job. + Status DeploymentStatus } // Configuration information for a deployment launch. type DeploymentLaunchConfig struct { - // The deployment pre-launch file. This file will be executed prior to the launch - // file. - PreLaunchFile *string - - // The deployment post-launch file. This file will be executed after the launch - // file. - PostLaunchFile *string - - // The package name. + // The launch file name. // // This member is required. - PackageName *string + LaunchFile *string - // The launch file name. + // The package name. // // This member is required. - LaunchFile *string + PackageName *string // An array of key/value pairs specifying environment variables for the robot // application EnvironmentVariables map[string]*string + + // The deployment post-launch file. This file will be executed after the launch + // file. + PostLaunchFile *string + + // The deployment pre-launch file. This file will be executed prior to the launch + // file. + PreLaunchFile *string } // Information about a failed create simulation job request. @@ -173,14 +173,14 @@ type FailedCreateSimulationJobRequest struct { // The time, in milliseconds since the epoch, when the simulation job batch failed. FailedAt *time.Time - // The simulation job request. - Request *SimulationJobRequest - // The failure code. FailureCode SimulationJobErrorCode // The failure reason of the simulation job request. FailureReason *string + + // The simulation job request. + Request *SimulationJobRequest } // Information about a filter. @@ -196,28 +196,33 @@ type Filter struct { // Information about a fleet. type Fleet struct { + // The Amazon Resource Name (ARN) of the fleet. + Arn *string + // The time, in milliseconds since the epoch, when the fleet was created. CreatedAt *time.Time + // The Amazon Resource Name (ARN) of the last deployment job. + LastDeploymentJob *string + // The status of the last fleet deployment. LastDeploymentStatus DeploymentStatus - // The Amazon Resource Name (ARN) of the fleet. - Arn *string - - // The name of the fleet. - Name *string - // The time of the last deployment. LastDeploymentTime *time.Time - // The Amazon Resource Name (ARN) of the last deployment job. - LastDeploymentJob *string + // The name of the fleet. + Name *string } // Information about a launch configuration. type LaunchConfig struct { + // The launch file name. + // + // This member is required. + LaunchFile *string + // The package name. // // This member is required. @@ -226,19 +231,14 @@ type LaunchConfig struct { // The environment variables for the application launch. EnvironmentVariables map[string]*string - // The launch file name. - // - // This member is required. - LaunchFile *string + // The port forwarding configuration. + PortForwardingConfig *PortForwardingConfig // Boolean indicating whether a streaming session will be configured for the // application. If True, AWS RoboMaker will configure a connection so you can // interact with your application as it is running in the simulation. You must // configure and luanch the component. It must have a graphical user interface. StreamUI *bool - - // The port forwarding configuration. - PortForwardingConfig *PortForwardingConfig } // The logging configuration. @@ -253,12 +253,12 @@ type LoggingConfig struct { // Describes a network interface. type NetworkInterface struct { - // The IPv4 address of the network interface within the subnet. - PrivateIpAddress *string - // The ID of the network interface. NetworkInterfaceId *string + // The IPv4 address of the network interface within the subnet. + PrivateIpAddress *string + // The IPv4 public address of the network interface. PublicIpAddress *string } @@ -283,16 +283,16 @@ type PortForwardingConfig struct { // An object representing a port mapping. type PortMapping struct { - // The port number on the simulation job instance to use as a remote connection - // point. + // The port number on the application. // // This member is required. - JobPort *int32 + ApplicationPort *int32 - // The port number on the application. + // The port number on the simulation job instance to use as a remote connection + // point. // // This member is required. - ApplicationPort *int32 + JobPort *int32 // A Boolean indicating whether to enable this port mapping on public IP. EnableOnPublicIp *bool @@ -301,10 +301,6 @@ type PortMapping struct { // Information about the progress of a deployment job. type ProgressDetail struct { - // Precentage of the step that is done. This currently only applies to the - // Downloading/Extracting step of the deployment. It is empty for other steps. - PercentDone *float32 - // The current progress status. Validating Validating the deployment. // DownloadingExtracting Downloading and extracting the bundle on the robot. // ExecutingPreLaunch Executing pre-launch script(s) if provided. Launching @@ -317,6 +313,10 @@ type ProgressDetail struct { // other steps. EstimatedTimeRemainingSeconds *int32 + // Precentage of the step that is done. This currently only applies to the + // Downloading/Extracting step of the deployment. It is empty for other steps. + PercentDone *float32 + // The Amazon Resource Name (ARN) of the deployment job. TargetResource *string } @@ -324,27 +324,21 @@ type ProgressDetail struct { // Information about a rendering engine. type RenderingEngine struct { - // The version of the rendering engine. - Version *string - // The name of the rendering engine. Name RenderingEngineType + + // The version of the rendering engine. + Version *string } // Information about a robot. type Robot struct { - // The Amazon Resource Name (ARN) of the last deployment job. - LastDeploymentJob *string - // The architecture of the robot. Architecture Architecture - // The time of the last deployment. - LastDeploymentTime *time.Time - - // The status of the robot. - Status RobotStatus + // The Amazon Resource Name (ARN) of the robot. + Arn *string // The time, in milliseconds since the epoch, when the robot was created. CreatedAt *time.Time @@ -352,39 +346,42 @@ type Robot struct { // The Amazon Resource Name (ARN) of the fleet. FleetArn *string - // The Amazon Resource Name (ARN) of the robot. - Arn *string - // The Greengrass group associated with the robot. GreenGrassGroupId *string + // The Amazon Resource Name (ARN) of the last deployment job. + LastDeploymentJob *string + + // The time of the last deployment. + LastDeploymentTime *time.Time + // The name of the robot. Name *string + + // The status of the robot. + Status RobotStatus } // Application configuration information for a robot. type RobotApplicationConfig struct { - // The version of the robot application. - ApplicationVersion *string + // The application information for the robot application. + // + // This member is required. + Application *string // The launch configuration for the robot application. // // This member is required. LaunchConfig *LaunchConfig - // The application information for the robot application. - // - // This member is required. - Application *string + // The version of the robot application. + ApplicationVersion *string } // Summary information for a robot application. type RobotApplicationSummary struct { - // The version of the robot application. - Version *string - // The Amazon Resource Name (ARN) of the robot. Arn *string @@ -397,16 +394,19 @@ type RobotApplicationSummary struct { // Information about a robot software suite (ROS distribution). RobotSoftwareSuite *RobotSoftwareSuite + + // The version of the robot application. + Version *string } // Information about a robot deployment. type RobotDeployment struct { - // The status of the robot deployment. - Status RobotStatus + // The robot deployment Amazon Resource Name (ARN). + Arn *string - // A short description of the reason why the robot deployment failed. - FailureReason *string + // The time, in milliseconds since the epoch, when the deployment finished. + DeploymentFinishTime *time.Time // The time, in milliseconds since the epoch, when the deployment was started. DeploymentStartTime *time.Time @@ -414,56 +414,61 @@ type RobotDeployment struct { // The robot deployment failure code. FailureCode DeploymentJobErrorCode - // The robot deployment Amazon Resource Name (ARN). - Arn *string + // A short description of the reason why the robot deployment failed. + FailureReason *string // Information about how the deployment is progressing. ProgressDetail *ProgressDetail - // The time, in milliseconds since the epoch, when the deployment finished. - DeploymentFinishTime *time.Time + // The status of the robot deployment. + Status RobotStatus } // Information about a robot software suite (ROS distribution). type RobotSoftwareSuite struct { - // The version of the robot software suite (ROS distribution). - Version RobotSoftwareSuiteVersionType - // The name of the robot software suite (ROS distribution). Name RobotSoftwareSuiteType + + // The version of the robot software suite (ROS distribution). + Version RobotSoftwareSuiteVersionType } // Information about S3 keys. type S3KeyOutput struct { - // The S3 key. - S3Key *string - // The etag for the object. Etag *string + + // The S3 key. + S3Key *string } // Information about an S3 object. type S3Object struct { - // The etag of the object. - Etag *string + // The bucket containing the object. + // + // This member is required. + Bucket *string // The key of the object. // // This member is required. Key *string - // The bucket containing the object. - // - // This member is required. - Bucket *string + // The etag of the object. + Etag *string } // Information about a simulation application configuration. type SimulationApplicationConfig struct { + // The application information for the simulation application. + // + // This member is required. + Application *string + // The launch configuration for the simulation application. // // This member is required. @@ -471,123 +476,125 @@ type SimulationApplicationConfig struct { // The version of the simulation application. ApplicationVersion *string - - // The application information for the simulation application. - // - // This member is required. - Application *string } // Summary information for a simulation application. type SimulationApplicationSummary struct { + // The Amazon Resource Name (ARN) of the simulation application. + Arn *string + + // The time, in milliseconds since the epoch, when the simulation application was + // last updated. + LastUpdatedAt *time.Time + // The name of the simulation application. Name *string - // The Amazon Resource Name (ARN) of the simulation application. - Arn *string + // Information about a robot software suite (ROS distribution). + RobotSoftwareSuite *RobotSoftwareSuite // Information about a simulation software suite. SimulationSoftwareSuite *SimulationSoftwareSuite // The version of the simulation application. Version *string - - // Information about a robot software suite (ROS distribution). - RobotSoftwareSuite *RobotSoftwareSuite - - // The time, in milliseconds since the epoch, when the simulation application was - // last updated. - LastUpdatedAt *time.Time } // Information about a simulation job. type SimulationJob struct { - // The logging configuration. - LoggingConfig *LoggingConfig + // The Amazon Resource Name (ARN) of the simulation job. + Arn *string - // Information about a network interface. - NetworkInterface *NetworkInterface + // A unique identifier for this SimulationJob request. + ClientRequestToken *string - // The maximum simulation job duration in seconds. The value must be 8 days - // (691,200 seconds) or less. - MaxJobDurationInSeconds *int64 + // Compute information for the simulation job + Compute *ComputeResponse - // The simulation job execution duration in milliseconds. - SimulationTimeMillis *int64 + // The data sources for the simulation job. + DataSources []*DataSource + + // The failure behavior the simulation job. Continue Restart the simulation job in + // the same host instance. Fail Stop the simulation job and terminate the instance. + FailureBehavior FailureBehavior + + // The failure code of the simulation job if it failed. + FailureCode SimulationJobErrorCode + + // The reason why the simulation job failed. + FailureReason *string // The IAM role that allows the simulation instance to call the AWS APIs that are // specified in its associated policies on your behalf. This is how credentials are // passed in to your simulation job. IamRole *string - // VPC configuration information. - VpcConfig *VPCConfigResponse - - // Status of the simulation job. - Status SimulationJobStatus - - // The failure behavior the simulation job. Continue Restart the simulation job in - // the same host instance. Fail Stop the simulation job and terminate the instance. - FailureBehavior FailureBehavior + // The time, in milliseconds since the epoch, when the simulation job was last + // started. + LastStartedAt *time.Time - // A unique identifier for this SimulationJob request. - ClientRequestToken *string + // The time, in milliseconds since the epoch, when the simulation job was last + // updated. + LastUpdatedAt *time.Time - // A list of simulation applications. - SimulationApplications []*SimulationApplicationConfig + // The logging configuration. + LoggingConfig *LoggingConfig - // Compute information for the simulation job - Compute *ComputeResponse + // The maximum simulation job duration in seconds. The value must be 8 days + // (691,200 seconds) or less. + MaxJobDurationInSeconds *int64 // The name of the simulation job. Name *string - // The Amazon Resource Name (ARN) of the simulation job. - Arn *string + // Information about a network interface. + NetworkInterface *NetworkInterface - // The data sources for the simulation job. - DataSources []*DataSource + // Location for output files generated by the simulation job. + OutputLocation *OutputLocation // A list of robot applications. RobotApplications []*RobotApplicationConfig - // The time, in milliseconds since the epoch, when the simulation job was last - // updated. - LastUpdatedAt *time.Time + // A list of simulation applications. + SimulationApplications []*SimulationApplicationConfig - // The reason why the simulation job failed. - FailureReason *string + // The simulation job execution duration in milliseconds. + SimulationTimeMillis *int64 + + // Status of the simulation job. + Status SimulationJobStatus // A map that contains tag keys and tag values that are attached to the simulation // job. Tags map[string]*string - // The time, in milliseconds since the epoch, when the simulation job was last - // started. - LastStartedAt *time.Time - - // The failure code of the simulation job if it failed. - FailureCode SimulationJobErrorCode - - // Location for output files generated by the simulation job. - OutputLocation *OutputLocation + // VPC configuration information. + VpcConfig *VPCConfigResponse } // Information about a simulation job batch. type SimulationJobBatchSummary struct { + // The Amazon Resource Name (ARN) of the batch. + Arn *string + // The time, in milliseconds since the epoch, when the simulation job batch was // created. CreatedAt *time.Time - // The Amazon Resource Name (ARN) of the batch. - Arn *string + // The number of created simulation job requests. + CreatedRequestCount *int32 // The number of failed simulation job requests. FailedRequestCount *int32 + // The time, in milliseconds since the epoch, when the simulation job batch was + // last updated. + LastUpdatedAt *time.Time + // The number of pending simulation job requests. PendingRequestCount *int32 @@ -608,13 +615,6 @@ type SimulationJobBatchSummary struct { // failing request, the batch status will be TimedOut. TimedOut The simulation // batch job timed out. Status SimulationJobBatchStatus - - // The time, in milliseconds since the epoch, when the simulation job batch was - // last updated. - LastUpdatedAt *time.Time - - // The number of created simulation job requests. - CreatedRequestCount *int32 } // Information about a simulation job request. @@ -629,70 +629,70 @@ type SimulationJobRequest struct { // Compute information for the simulation job Compute *Compute - // Boolean indicating whether to use default simulation tool applications. - UseDefaultApplications *bool - - // The logging configuration. - LoggingConfig *LoggingConfig - // Specify data sources to mount read-only files from S3 into your simulation. // These files are available under /opt/robomaker/datasources/data_source_name. // There is a limit of 100 files and a combined size of 25GB for all // DataSourceConfig objects. DataSources []*DataSourceConfig - // The robot applications to use in the simulation job. - RobotApplications []*RobotApplicationConfig + // The failure behavior the simulation job. Continue Restart the simulation job in + // the same host instance. Fail Stop the simulation job and terminate the instance. + FailureBehavior FailureBehavior + + // The IAM role name that allows the simulation instance to call the AWS APIs that + // are specified in its associated policies on your behalf. This is how credentials + // are passed in to your simulation job. + IamRole *string + + // The logging configuration. + LoggingConfig *LoggingConfig // The output location. OutputLocation *OutputLocation - // A map that contains tag keys and tag values that are attached to the simulation - // job request. - Tags map[string]*string + // The robot applications to use in the simulation job. + RobotApplications []*RobotApplicationConfig // The simulation applications to use in the simulation job. SimulationApplications []*SimulationApplicationConfig - // The failure behavior the simulation job. Continue Restart the simulation job in - // the same host instance. Fail Stop the simulation job and terminate the instance. - FailureBehavior FailureBehavior + // A map that contains tag keys and tag values that are attached to the simulation + // job request. + Tags map[string]*string + + // Boolean indicating whether to use default simulation tool applications. + UseDefaultApplications *bool // If your simulation job accesses resources in a VPC, you provide this parameter // identifying the list of security group IDs and subnet IDs. These must belong to // the same VPC. You must provide at least one security group and two subnet IDs. VpcConfig *VPCConfig - - // The IAM role name that allows the simulation instance to call the AWS APIs that - // are specified in its associated policies on your behalf. This is how credentials - // are passed in to your simulation job. - IamRole *string } // Summary information for a simulation job. type SimulationJobSummary struct { - // The name of the simulation job. - Name *string - - // A list of simulation job simulation application names. - SimulationApplicationNames []*string + // The Amazon Resource Name (ARN) of the simulation job. + Arn *string - // A list of simulation job robot application names. - RobotApplicationNames []*string + // The names of the data sources. + DataSourceNames []*string // The time, in milliseconds since the epoch, when the simulation job was last // updated. LastUpdatedAt *time.Time - // The names of the data sources. - DataSourceNames []*string + // The name of the simulation job. + Name *string + + // A list of simulation job robot application names. + RobotApplicationNames []*string + + // A list of simulation job simulation application names. + SimulationApplicationNames []*string // The status of the simulation job. Status SimulationJobStatus - - // The Amazon Resource Name (ARN) of the simulation job. - Arn *string } // Information about a simulation software suite. @@ -708,8 +708,8 @@ type SimulationSoftwareSuite struct { // Information about a source. type Source struct { - // The s3 object key. - S3Key *string + // The taget processor architecture for the application. + Architecture Architecture // A hash of the object specified by s3Bucket and s3Key. Etag *string @@ -717,21 +717,21 @@ type Source struct { // The s3 bucket name. S3Bucket *string - // The taget processor architecture for the application. - Architecture Architecture + // The s3 object key. + S3Key *string } // Information about a source configuration. type SourceConfig struct { - // The s3 object key. - S3Key *string + // The target processor architecture for the application. + Architecture Architecture // The Amazon S3 bucket name. S3Bucket *string - // The target processor architecture for the application. - Architecture Architecture + // The s3 object key. + S3Key *string } // If your simulation job accesses resources in a VPC, you provide this parameter @@ -754,8 +754,8 @@ type VPCConfig struct { // VPC configuration associated with your simulation job. type VPCConfigResponse struct { - // The VPC ID associated with your simulation job. - VpcId *string + // A boolean indicating if a public IP was assigned. + AssignPublicIp *bool // A list of security group IDs associated with the simulation job. SecurityGroups []*string @@ -763,6 +763,6 @@ type VPCConfigResponse struct { // A list of subnet IDs associated with the simulation job. Subnets []*string - // A boolean indicating if a public IP was assigned. - AssignPublicIp *bool + // The VPC ID associated with your simulation job. + VpcId *string } diff --git a/service/route53/api_op_AssociateVPCWithHostedZone.go b/service/route53/api_op_AssociateVPCWithHostedZone.go index 2d450ebeef4..391176decd4 100644 --- a/service/route53/api_op_AssociateVPCWithHostedZone.go +++ b/service/route53/api_op_AssociateVPCWithHostedZone.go @@ -80,14 +80,14 @@ type AssociateVPCWithHostedZoneInput struct { // This member is required. HostedZoneId *string - // Optional: A comment about the association request. - Comment *string - // A complex type that contains information about the VPC that you want to // associate with a private hosted zone. // // This member is required. VPC *types.VPC + + // Optional: A comment about the association request. + Comment *string } // A complex type that contains the response information for the diff --git a/service/route53/api_op_ChangeTagsForResource.go b/service/route53/api_op_ChangeTagsForResource.go index cab1009c9e1..38b40ea2356 100644 --- a/service/route53/api_op_ChangeTagsForResource.go +++ b/service/route53/api_op_ChangeTagsForResource.go @@ -67,10 +67,6 @@ type ChangeTagsForResourceInput struct { // This member is required. ResourceId *string - // A complex type that contains a list of the tags that you want to delete from the - // specified health check or hosted zone. You can specify up to 10 keys. - RemoveTagKeys []*string - // The type of the resource. // // * The resource type for health checks is @@ -85,6 +81,10 @@ type ChangeTagsForResourceInput struct { // specified health check or hosted zone and/or the tags that you want to edit // Value for. You can add a maximum of 10 tags to a health check or a hosted zone. AddTags []*types.Tag + + // A complex type that contains a list of the tags that you want to delete from the + // specified health check or hosted zone. You can specify up to 10 keys. + RemoveTagKeys []*string } // Empty response for the request. diff --git a/service/route53/api_op_CreateHealthCheck.go b/service/route53/api_op_CreateHealthCheck.go index eb32bcce9f3..a33c6a249e6 100644 --- a/service/route53/api_op_CreateHealthCheck.go +++ b/service/route53/api_op_CreateHealthCheck.go @@ -82,11 +82,6 @@ func (c *Client) CreateHealthCheck(ctx context.Context, params *CreateHealthChec // A complex type that contains the health check request information. type CreateHealthCheckInput struct { - // A complex type that contains settings for a new health check. - // - // This member is required. - HealthCheckConfig *types.HealthCheckConfig - // A unique string that identifies the request and that allows you to retry a // failed CreateHealthCheck request without the risk of creating two identical // health checks: @@ -111,20 +106,25 @@ type CreateHealthCheckInput struct { // // This member is required. CallerReference *string + + // A complex type that contains settings for a new health check. + // + // This member is required. + HealthCheckConfig *types.HealthCheckConfig } // A complex type containing the response information for the new health check. type CreateHealthCheckOutput struct { - // The unique URL representing the new health check. + // A complex type that contains identifying information about the health check. // // This member is required. - Location *string + HealthCheck *types.HealthCheck - // A complex type that contains identifying information about the health check. + // The unique URL representing the new health check. // // This member is required. - HealthCheck *types.HealthCheck + Location *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/route53/api_op_CreateHostedZone.go b/service/route53/api_op_CreateHostedZone.go index 7faff03ecb4..ae1510f6aea 100644 --- a/service/route53/api_op_CreateHostedZone.go +++ b/service/route53/api_op_CreateHostedZone.go @@ -103,18 +103,6 @@ type CreateHostedZoneInput struct { // This member is required. CallerReference *string - // (Optional) A complex type that contains the following optional values: - // - // * - // For public and private hosted zones, an optional comment - // - // * For private - // hosted zones, an optional PrivateZone element - // - // If you don't specify a comment or - // the PrivateZone element, omit HostedZoneConfig and the other elements. - HostedZoneConfig *types.HostedZoneConfig - // The name of the domain. Specify a fully qualified domain name, for example, // www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the // domain name is fully qualified. This means that Route 53 treats www.example.com @@ -127,6 +115,25 @@ type CreateHostedZoneInput struct { // This member is required. Name *string + // If you want to associate a reusable delegation set with this hosted zone, the ID + // that Amazon Route 53 assigned to the reusable delegation set when you created + // it. For more information about reusable delegation sets, see + // CreateReusableDelegationSet + // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateReusableDelegationSet.html). + DelegationSetId *string + + // (Optional) A complex type that contains the following optional values: + // + // * + // For public and private hosted zones, an optional comment + // + // * For private + // hosted zones, an optional PrivateZone element + // + // If you don't specify a comment or + // the PrivateZone element, omit HostedZoneConfig and the other elements. + HostedZoneConfig *types.HostedZoneConfig + // (Private hosted zones only) A complex type that contains information about the // Amazon VPC that you're associating with this hosted zone. You can specify only // one Amazon VPC when you create a private hosted zone. To associate additional @@ -134,41 +141,34 @@ type CreateHostedZoneInput struct { // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_AssociateVPCWithHostedZone.html) // after you create a hosted zone. VPC *types.VPC - - // If you want to associate a reusable delegation set with this hosted zone, the ID - // that Amazon Route 53 assigned to the reusable delegation set when you created - // it. For more information about reusable delegation sets, see - // CreateReusableDelegationSet - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateReusableDelegationSet.html). - DelegationSetId *string } // A complex type containing the response information for the hosted zone. type CreateHostedZoneOutput struct { - // A complex type that contains general information about the hosted zone. + // A complex type that contains information about the CreateHostedZone request. // // This member is required. - HostedZone *types.HostedZone + ChangeInfo *types.ChangeInfo - // A complex type that contains information about the CreateHostedZone request. + // A complex type that describes the name servers for this hosted zone. // // This member is required. - ChangeInfo *types.ChangeInfo + DelegationSet *types.DelegationSet - // A complex type that contains information about an Amazon VPC that you associated - // with this hosted zone. - VPC *types.VPC + // A complex type that contains general information about the hosted zone. + // + // This member is required. + HostedZone *types.HostedZone // The unique URL representing the new hosted zone. // // This member is required. Location *string - // A complex type that describes the name servers for this hosted zone. - // - // This member is required. - DelegationSet *types.DelegationSet + // A complex type that contains information about an Amazon VPC that you associated + // with this hosted zone. + VPC *types.VPC // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/route53/api_op_CreateQueryLoggingConfig.go b/service/route53/api_op_CreateQueryLoggingConfig.go index 1a696039ca0..db1aa7b7970 100644 --- a/service/route53/api_op_CreateQueryLoggingConfig.go +++ b/service/route53/api_op_CreateQueryLoggingConfig.go @@ -157,6 +157,11 @@ type CreateQueryLoggingConfigInput struct { type CreateQueryLoggingConfigOutput struct { + // The unique URL representing the new query logging configuration. + // + // This member is required. + Location *string + // A complex type that contains the ID for a query logging configuration, the ID of // the hosted zone that you want to log queries for, and the ARN for the log group // that you want Amazon Route 53 to send query logs to. @@ -164,11 +169,6 @@ type CreateQueryLoggingConfigOutput struct { // This member is required. QueryLoggingConfig *types.QueryLoggingConfig - // The unique URL representing the new query logging configuration. - // - // This member is required. - Location *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/route53/api_op_CreateReusableDelegationSet.go b/service/route53/api_op_CreateReusableDelegationSet.go index b9f281ca44d..dea1d176575 100644 --- a/service/route53/api_op_CreateReusableDelegationSet.go +++ b/service/route53/api_op_CreateReusableDelegationSet.go @@ -86,10 +86,6 @@ func (c *Client) CreateReusableDelegationSet(ctx context.Context, params *Create type CreateReusableDelegationSetInput struct { - // If you want to mark the delegation set for an existing hosted zone as reusable, - // the ID for that hosted zone. - HostedZoneId *string - // A unique string that identifies the request, and that allows you to retry failed // CreateReusableDelegationSet requests without the risk of executing the operation // twice. You must use a unique CallerReference string every time you submit a @@ -98,19 +94,23 @@ type CreateReusableDelegationSetInput struct { // // This member is required. CallerReference *string + + // If you want to mark the delegation set for an existing hosted zone as reusable, + // the ID for that hosted zone. + HostedZoneId *string } type CreateReusableDelegationSetOutput struct { - // The unique URL representing the new reusable delegation set. + // A complex type that contains name server information. // // This member is required. - Location *string + DelegationSet *types.DelegationSet - // A complex type that contains name server information. + // The unique URL representing the new reusable delegation set. // // This member is required. - DelegationSet *types.DelegationSet + Location *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/route53/api_op_CreateTrafficPolicy.go b/service/route53/api_op_CreateTrafficPolicy.go index f09a30d1c17..936c8605254 100644 --- a/service/route53/api_op_CreateTrafficPolicy.go +++ b/service/route53/api_op_CreateTrafficPolicy.go @@ -61,11 +61,6 @@ func (c *Client) CreateTrafficPolicy(ctx context.Context, params *CreateTrafficP // to create. type CreateTrafficPolicyInput struct { - // The name of the traffic policy. - // - // This member is required. - Name *string - // The definition of this traffic policy in JSON format. For more information, see // Traffic Policy Document Format // (https://docs.aws.amazon.com/Route53/latest/APIReference/api-policies-traffic-policy-document-format.html). @@ -73,6 +68,11 @@ type CreateTrafficPolicyInput struct { // This member is required. Document *string + // The name of the traffic policy. + // + // This member is required. + Name *string + // (Optional) Any comments that you want to include about the traffic policy. Comment *string } diff --git a/service/route53/api_op_CreateTrafficPolicyInstance.go b/service/route53/api_op_CreateTrafficPolicyInstance.go index 65078738419..731da1ae36b 100644 --- a/service/route53/api_op_CreateTrafficPolicyInstance.go +++ b/service/route53/api_op_CreateTrafficPolicyInstance.go @@ -64,6 +64,12 @@ func (c *Client) CreateTrafficPolicyInstance(ctx context.Context, params *Create // want to create based on a specified traffic policy. type CreateTrafficPolicyInstanceInput struct { + // The ID of the hosted zone that you want Amazon Route 53 to create resource + // record sets in by using the configuration in a traffic policy. + // + // This member is required. + HostedZoneId *string + // The domain name (such as example.com) or subdomain name (such as // www.example.com) for which Amazon Route 53 responds to DNS queries by using the // resource record sets that Route 53 creates for this traffic policy instance. @@ -88,27 +94,21 @@ type CreateTrafficPolicyInstanceInput struct { // // This member is required. TrafficPolicyVersion *int32 - - // The ID of the hosted zone that you want Amazon Route 53 to create resource - // record sets in by using the configuration in a traffic policy. - // - // This member is required. - HostedZoneId *string } // A complex type that contains the response information for the // CreateTrafficPolicyInstance request. type CreateTrafficPolicyInstanceOutput struct { - // A complex type that contains settings for the new traffic policy instance. + // A unique URL that represents a new traffic policy instance. // // This member is required. - TrafficPolicyInstance *types.TrafficPolicyInstance + Location *string - // A unique URL that represents a new traffic policy instance. + // A complex type that contains settings for the new traffic policy instance. // // This member is required. - Location *string + TrafficPolicyInstance *types.TrafficPolicyInstance // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/route53/api_op_CreateTrafficPolicyVersion.go b/service/route53/api_op_CreateTrafficPolicyVersion.go index c5a69dc0684..2e4edf2fd38 100644 --- a/service/route53/api_op_CreateTrafficPolicyVersion.go +++ b/service/route53/api_op_CreateTrafficPolicyVersion.go @@ -74,14 +74,14 @@ type CreateTrafficPolicyVersionInput struct { // This member is required. Document *string - // The comment that you specified in the CreateTrafficPolicyVersion request, if - // any. - Comment *string - // The ID of the traffic policy for which you want to create a new version. // // This member is required. Id *string + + // The comment that you specified in the CreateTrafficPolicyVersion request, if + // any. + Comment *string } // A complex type that contains the response information for the diff --git a/service/route53/api_op_CreateVPCAssociationAuthorization.go b/service/route53/api_op_CreateVPCAssociationAuthorization.go index f2e667cf264..355f27f307e 100644 --- a/service/route53/api_op_CreateVPCAssociationAuthorization.go +++ b/service/route53/api_op_CreateVPCAssociationAuthorization.go @@ -68,32 +68,32 @@ func (c *Client) CreateVPCAssociationAuthorization(ctx context.Context, params * // when a private hosted zone and a VPC were created by using different accounts. type CreateVPCAssociationAuthorizationInput struct { - // A complex type that contains the VPC ID and region for the VPC that you want to - // authorize associating with your hosted zone. - // - // This member is required. - VPC *types.VPC - // The ID of the private hosted zone that you want to authorize associating a VPC // with. // // This member is required. HostedZoneId *string + + // A complex type that contains the VPC ID and region for the VPC that you want to + // authorize associating with your hosted zone. + // + // This member is required. + VPC *types.VPC } // A complex type that contains the response information from a // CreateVPCAssociationAuthorization request. type CreateVPCAssociationAuthorizationOutput struct { - // The VPC that you authorized associating with a hosted zone. + // The ID of the hosted zone that you authorized associating a VPC with. // // This member is required. - VPC *types.VPC + HostedZoneId *string - // The ID of the hosted zone that you authorized associating a VPC with. + // The VPC that you authorized associating with a hosted zone. // // This member is required. - HostedZoneId *string + VPC *types.VPC // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/route53/api_op_DeleteVPCAssociationAuthorization.go b/service/route53/api_op_DeleteVPCAssociationAuthorization.go index ff3dddd0b4b..2717834424b 100644 --- a/service/route53/api_op_DeleteVPCAssociationAuthorization.go +++ b/service/route53/api_op_DeleteVPCAssociationAuthorization.go @@ -69,18 +69,18 @@ func (c *Client) DeleteVPCAssociationAuthorization(ctx context.Context, params * type DeleteVPCAssociationAuthorizationInput struct { // When removing authorization to associate a VPC that was created by one AWS - // account with a hosted zone that was created with a different AWS account, a - // complex type that includes the ID and region of the VPC. + // account with a hosted zone that was created with a different AWS account, the ID + // of the hosted zone. // // This member is required. - VPC *types.VPC + HostedZoneId *string // When removing authorization to associate a VPC that was created by one AWS - // account with a hosted zone that was created with a different AWS account, the ID - // of the hosted zone. + // account with a hosted zone that was created with a different AWS account, a + // complex type that includes the ID and region of the VPC. // // This member is required. - HostedZoneId *string + VPC *types.VPC } // Empty response for the request. diff --git a/service/route53/api_op_DisassociateVPCFromHostedZone.go b/service/route53/api_op_DisassociateVPCFromHostedZone.go index b6a752c3501..3db3f85ee03 100644 --- a/service/route53/api_op_DisassociateVPCFromHostedZone.go +++ b/service/route53/api_op_DisassociateVPCFromHostedZone.go @@ -81,8 +81,10 @@ func (c *Client) DisassociateVPCFromHostedZone(ctx context.Context, params *Disa // disassociate from a specified private hosted zone. type DisassociateVPCFromHostedZoneInput struct { - // Optional: A comment about the disassociation request. - Comment *string + // The ID of the private hosted zone that you want to disassociate a VPC from. + // + // This member is required. + HostedZoneId *string // A complex type that contains information about the VPC that you're // disassociating from the specified hosted zone. @@ -90,10 +92,8 @@ type DisassociateVPCFromHostedZoneInput struct { // This member is required. VPC *types.VPC - // The ID of the private hosted zone that you want to disassociate a VPC from. - // - // This member is required. - HostedZoneId *string + // Optional: A comment about the disassociation request. + Comment *string } // A complex type that contains the response information for the disassociate diff --git a/service/route53/api_op_GetGeoLocation.go b/service/route53/api_op_GetGeoLocation.go index c1579bec266..3d94cd9607a 100644 --- a/service/route53/api_op_GetGeoLocation.go +++ b/service/route53/api_op_GetGeoLocation.go @@ -88,16 +88,16 @@ type GetGeoLocationInput struct { // * SA: South America ContinentCode *string + // Amazon Route 53 uses the two-letter country codes that are specified in ISO + // standard 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). + CountryCode *string + // For SubdivisionCode, Amazon Route 53 supports only states of the United States. // For a list of state abbreviations, see Appendix B: Two–Letter State and // Possession Abbreviations (https://pe.usps.com/text/pub28/28apb.htm) on the // United States Postal Service website. If you specify subdivisioncode, you must // also specify US for CountryCode. SubdivisionCode *string - - // Amazon Route 53 uses the two-letter country codes that are specified in ISO - // standard 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). - CountryCode *string } // A complex type that contains the response information for the specified diff --git a/service/route53/api_op_GetHostedZone.go b/service/route53/api_op_GetHostedZone.go index d928cae3232..ef0cbb61a7d 100644 --- a/service/route53/api_op_GetHostedZone.go +++ b/service/route53/api_op_GetHostedZone.go @@ -68,16 +68,16 @@ type GetHostedZoneInput struct { // A complex type that contain the response to a GetHostedZone request. type GetHostedZoneOutput struct { - // A complex type that lists the Amazon Route 53 name servers for the specified - // hosted zone. - DelegationSet *types.DelegationSet - // A complex type that contains general information about the specified hosted // zone. // // This member is required. HostedZone *types.HostedZone + // A complex type that lists the Amazon Route 53 name servers for the specified + // hosted zone. + DelegationSet *types.DelegationSet + // A complex type that contains information about the VPCs that are associated with // the specified hosted zone. VPCs []*types.VPC diff --git a/service/route53/api_op_GetHostedZoneLimit.go b/service/route53/api_op_GetHostedZoneLimit.go index f37e809a966..4cd50f6ef12 100644 --- a/service/route53/api_op_GetHostedZoneLimit.go +++ b/service/route53/api_op_GetHostedZoneLimit.go @@ -85,13 +85,6 @@ type GetHostedZoneLimitInput struct { // A complex type that contains the requested limit. type GetHostedZoneLimitOutput struct { - // The current setting for the specified limit. For example, if you specified - // MAX_RRSETS_BY_ZONE for the value of Type in the request, the value of Limit is - // the maximum number of records that you can create in the specified hosted zone. - // - // This member is required. - Limit *types.HostedZoneLimit - // The current number of entities that you have created of the specified type. For // example, if you specified MAX_RRSETS_BY_ZONE for the value of Type in the // request, the value of Count is the current number of records that you have @@ -100,6 +93,13 @@ type GetHostedZoneLimitOutput struct { // This member is required. Count *int64 + // The current setting for the specified limit. For example, if you specified + // MAX_RRSETS_BY_ZONE for the value of Type in the request, the value of Limit is + // the maximum number of records that you can create in the specified hosted zone. + // + // This member is required. + Limit *types.HostedZoneLimit + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/route53/api_op_GetReusableDelegationSetLimit.go b/service/route53/api_op_GetReusableDelegationSetLimit.go index 7cf52adb63c..e8da17cdadb 100644 --- a/service/route53/api_op_GetReusableDelegationSetLimit.go +++ b/service/route53/api_op_GetReusableDelegationSetLimit.go @@ -78,18 +78,18 @@ type GetReusableDelegationSetLimitInput struct { // A complex type that contains the requested limit. type GetReusableDelegationSetLimitOutput struct { - // The current setting for the limit on hosted zones that you can associate with - // the specified reusable delegation set. - // - // This member is required. - Limit *types.ReusableDelegationSetLimit - // The current number of hosted zones that you can associate with the specified // reusable delegation set. // // This member is required. Count *int64 + // The current setting for the limit on hosted zones that you can associate with + // the specified reusable delegation set. + // + // This member is required. + Limit *types.ReusableDelegationSetLimit + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/route53/api_op_GetTrafficPolicy.go b/service/route53/api_op_GetTrafficPolicy.go index abad0ba612c..f6d2279c5a0 100644 --- a/service/route53/api_op_GetTrafficPolicy.go +++ b/service/route53/api_op_GetTrafficPolicy.go @@ -58,15 +58,15 @@ func (c *Client) GetTrafficPolicy(ctx context.Context, params *GetTrafficPolicyI // Gets information about a specific traffic policy version. type GetTrafficPolicyInput struct { - // The version number of the traffic policy that you want to get information about. + // The ID of the traffic policy that you want to get information about. // // This member is required. - Version *int32 + Id *string - // The ID of the traffic policy that you want to get information about. + // The version number of the traffic policy that you want to get information about. // // This member is required. - Id *string + Version *int32 } // A complex type that contains the response information for the request. diff --git a/service/route53/api_op_ListGeoLocations.go b/service/route53/api_op_ListGeoLocations.go index e369654e370..40123a6bd71 100644 --- a/service/route53/api_op_ListGeoLocations.go +++ b/service/route53/api_op_ListGeoLocations.go @@ -64,6 +64,11 @@ func (c *Client) ListGeoLocations(ctx context.Context, params *ListGeoLocationsI // for geolocation resource record sets. type ListGeoLocationsInput struct { + // (Optional) The maximum number of geolocations to be included in the response + // body for this request. If more than maxitems geolocations remain to be listed, + // then the value of the IsTruncated element in the response is true. + MaxItems *string + // The code for the continent with which you want to start listing locations that // Amazon Route 53 supports for geolocation. If Route 53 has already returned a // page or more of results, if IsTruncated is true, and if NextContinentCode from @@ -73,14 +78,6 @@ type ListGeoLocationsInput struct { // or countries with their subdivisions. StartContinentCode *string - // The code for the state of the United States with which you want to start listing - // locations that Amazon Route 53 supports for geolocation. If Route 53 has already - // returned a page or more of results, if IsTruncated is true, and if - // NextSubdivisionCode from the previous response has a value, enter that value in - // startsubdivisioncode to return the next page of results. To list subdivisions - // (U.S. states), you must include both startcountrycode and startsubdivisioncode. - StartSubdivisionCode *string - // The code for the country with which you want to start listing locations that // Amazon Route 53 supports for geolocation. If Route 53 has already returned a // page or more of results, if IsTruncated is true, and if NextCountryCode from the @@ -88,10 +85,13 @@ type ListGeoLocationsInput struct { // the next page of results. StartCountryCode *string - // (Optional) The maximum number of geolocations to be included in the response - // body for this request. If more than maxitems geolocations remain to be listed, - // then the value of the IsTruncated element in the response is true. - MaxItems *string + // The code for the state of the United States with which you want to start listing + // locations that Amazon Route 53 supports for geolocation. If Route 53 has already + // returned a page or more of results, if IsTruncated is true, and if + // NextSubdivisionCode from the previous response has a value, enter that value in + // startsubdivisioncode to return the next page of results. To list subdivisions + // (U.S. states), you must include both startcountrycode and startsubdivisioncode. + StartSubdivisionCode *string } // A complex type containing the response information for the request. @@ -103,11 +103,6 @@ type ListGeoLocationsOutput struct { // This member is required. GeoLocationDetailsList []*types.GeoLocationDetails - // If IsTruncated is true, you can make a follow-up request to display more - // locations. Enter the value of NextSubdivisionCode in the startsubdivisioncode - // parameter in another ListGeoLocations request. - NextSubdivisionCode *string - // A value that indicates whether more locations remain to be listed after the last // location in this response. If so, the value of IsTruncated is true. To get more // values, submit another request and include the values of NextContinentCode, @@ -117,6 +112,11 @@ type ListGeoLocationsOutput struct { // This member is required. IsTruncated *bool + // The value that you specified for MaxItems in the request. + // + // This member is required. + MaxItems *string + // If IsTruncated is true, you can make a follow-up request to display more // locations. Enter the value of NextContinentCode in the startcontinentcode // parameter in another ListGeoLocations request. @@ -127,10 +127,10 @@ type ListGeoLocationsOutput struct { // in another ListGeoLocations request. NextCountryCode *string - // The value that you specified for MaxItems in the request. - // - // This member is required. - MaxItems *string + // If IsTruncated is true, you can make a follow-up request to display more + // locations. Enter the value of NextSubdivisionCode in the startsubdivisioncode + // parameter in another ListGeoLocations request. + NextSubdivisionCode *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/route53/api_op_ListHealthChecks.go b/service/route53/api_op_ListHealthChecks.go index cb1ef437875..d9d552c8a69 100644 --- a/service/route53/api_op_ListHealthChecks.go +++ b/service/route53/api_op_ListHealthChecks.go @@ -59,12 +59,6 @@ func (c *Client) ListHealthChecks(ctx context.Context, params *ListHealthChecksI // current AWS account. type ListHealthChecksInput struct { - // The maximum number of health checks that you want ListHealthChecks to return in - // response to the current request. Amazon Route 53 returns a maximum of 100 items. - // If you set MaxItems to a value greater than 100, Route 53 returns only the first - // 100 health checks. - MaxItems *string - // If the value of IsTruncated in the previous response was true, you have more // health checks. To get another group, submit another ListHealthChecks request. // For the value of marker, specify the value of NextMarker from the previous @@ -72,6 +66,12 @@ type ListHealthChecksInput struct { // return if you submit another request. If the value of IsTruncated in the // previous response was false, there are no more health checks to get. Marker *string + + // The maximum number of health checks that you want ListHealthChecks to return in + // response to the current request. Amazon Route 53 returns a maximum of 100 items. + // If you set MaxItems to a value greater than 100, Route 53 returns only the first + // 100 health checks. + MaxItems *string } // A complex type that contains the response to a ListHealthChecks request. @@ -91,6 +91,12 @@ type ListHealthChecksOutput struct { // This member is required. IsTruncated *bool + // For the second and subsequent calls to ListHealthChecks, Marker is the value + // that you specified for the marker parameter in the previous request. + // + // This member is required. + Marker *string + // The value that you specified for the maxitems parameter in the call to // ListHealthChecks that produced the current response. // @@ -102,12 +108,6 @@ type ListHealthChecksOutput struct { // request and specify the value of NextMarker in the marker parameter. NextMarker *string - // For the second and subsequent calls to ListHealthChecks, Marker is the value - // that you specified for the marker parameter in the previous request. - // - // This member is required. - Marker *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/route53/api_op_ListHostedZones.go b/service/route53/api_op_ListHostedZones.go index c471f2c3a5f..86193ab5b09 100644 --- a/service/route53/api_op_ListHostedZones.go +++ b/service/route53/api_op_ListHostedZones.go @@ -84,12 +84,6 @@ type ListHostedZonesInput struct { type ListHostedZonesOutput struct { - // If IsTruncated is true, the value of NextMarker identifies the first hosted zone - // in the next group of hosted zones. Submit another ListHostedZones request, and - // specify the value of NextMarker from the response in the marker parameter. This - // element is present only if IsTruncated is true. - NextMarker *string - // A complex type that contains general information about the hosted zone. // // This member is required. @@ -103,12 +97,6 @@ type ListHostedZonesOutput struct { // This member is required. IsTruncated *bool - // The value that you specified for the maxitems parameter in the call to - // ListHostedZones that produced the current response. - // - // This member is required. - MaxItems *string - // For the second and subsequent calls to ListHostedZones, Marker is the value that // you specified for the marker parameter in the request that produced the current // response. @@ -116,6 +104,18 @@ type ListHostedZonesOutput struct { // This member is required. Marker *string + // The value that you specified for the maxitems parameter in the call to + // ListHostedZones that produced the current response. + // + // This member is required. + MaxItems *string + + // If IsTruncated is true, the value of NextMarker identifies the first hosted zone + // in the next group of hosted zones. Submit another ListHostedZones request, and + // specify the value of NextMarker from the response in the marker parameter. This + // element is present only if IsTruncated is true. + NextMarker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/route53/api_op_ListHostedZonesByName.go b/service/route53/api_op_ListHostedZonesByName.go index 13840275518..e651defb120 100644 --- a/service/route53/api_op_ListHostedZonesByName.go +++ b/service/route53/api_op_ListHostedZonesByName.go @@ -104,13 +104,6 @@ type ListHostedZonesByNameInput struct { // response. DNSName *string - // The maximum number of hosted zones to be included in the response body for this - // request. If you have more than maxitems hosted zones, then the value of the - // IsTruncated element in the response is true, and the values of NextDNSName and - // NextHostedZoneId specify the first hosted zone in the next group of maxitems - // hosted zones. - MaxItems *string - // (Optional) For your first request to ListHostedZonesByName, do not include the // hostedzoneid parameter. If you have more hosted zones than the value of // maxitems, ListHostedZonesByName returns only the first maxitems hosted zones. To @@ -119,26 +112,45 @@ type ListHostedZonesByNameInput struct { // the value of hostedzoneid, specify the value of the NextHostedZoneId element // from the previous response. HostedZoneId *string + + // The maximum number of hosted zones to be included in the response body for this + // request. If you have more than maxitems hosted zones, then the value of the + // IsTruncated element in the response is true, and the values of NextDNSName and + // NextHostedZoneId specify the first hosted zone in the next group of maxitems + // hosted zones. + MaxItems *string } // A complex type that contains the response information for the request. type ListHostedZonesByNameOutput struct { - // If IsTruncated is true, the value of NextHostedZoneId identifies the first - // hosted zone in the next group of maxitems hosted zones. Call - // ListHostedZonesByName again and specify the value of NextDNSName and - // NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively. This - // element is present only if IsTruncated is true. - NextHostedZoneId *string + // A complex type that contains general information about the hosted zone. + // + // This member is required. + HostedZones []*types.HostedZone - // The ID that Amazon Route 53 assigned to the hosted zone when you created it. - HostedZoneId *string + // A flag that indicates whether there are more hosted zones to be listed. If the + // response was truncated, you can get the next group of maxitems hosted zones by + // calling ListHostedZonesByName again and specifying the values of NextDNSName and + // NextHostedZoneId elements in the dnsname and hostedzoneid parameters. + // + // This member is required. + IsTruncated *bool + + // The value that you specified for the maxitems parameter in the call to + // ListHostedZonesByName that produced the current response. + // + // This member is required. + MaxItems *string // For the second and subsequent calls to ListHostedZonesByName, DNSName is the // value that you specified for the dnsname parameter in the request that produced // the current response. DNSName *string + // The ID that Amazon Route 53 assigned to the hosted zone when you created it. + HostedZoneId *string + // If IsTruncated is true, the value of NextDNSName is the name of the first hosted // zone in the next group of maxitems hosted zones. Call ListHostedZonesByName // again and specify the value of NextDNSName and NextHostedZoneId in the dnsname @@ -146,24 +158,12 @@ type ListHostedZonesByNameOutput struct { // IsTruncated is true. NextDNSName *string - // The value that you specified for the maxitems parameter in the call to - // ListHostedZonesByName that produced the current response. - // - // This member is required. - MaxItems *string - - // A complex type that contains general information about the hosted zone. - // - // This member is required. - HostedZones []*types.HostedZone - - // A flag that indicates whether there are more hosted zones to be listed. If the - // response was truncated, you can get the next group of maxitems hosted zones by - // calling ListHostedZonesByName again and specifying the values of NextDNSName and - // NextHostedZoneId elements in the dnsname and hostedzoneid parameters. - // - // This member is required. - IsTruncated *bool + // If IsTruncated is true, the value of NextHostedZoneId identifies the first + // hosted zone in the next group of maxitems hosted zones. Call + // ListHostedZonesByName again and specify the value of NextDNSName and + // NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively. This + // element is present only if IsTruncated is true. + NextHostedZoneId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/route53/api_op_ListHostedZonesByVPC.go b/service/route53/api_op_ListHostedZonesByVPC.go index c335899ee73..52217bb185e 100644 --- a/service/route53/api_op_ListHostedZonesByVPC.go +++ b/service/route53/api_op_ListHostedZonesByVPC.go @@ -71,16 +71,23 @@ func (c *Client) ListHostedZonesByVPC(ctx context.Context, params *ListHostedZon // regardless of which AWS account created the hosted zones. type ListHostedZonesByVPCInput struct { + // The ID of the Amazon VPC that you want to list hosted zones for. + // + // This member is required. + VPCId *string + // For the Amazon VPC that you specified for VPCId, the AWS Region that you created // the VPC in. // // This member is required. VPCRegion types.VPCRegion - // The ID of the Amazon VPC that you want to list hosted zones for. - // - // This member is required. - VPCId *string + // (Optional) The maximum number of hosted zones that you want Amazon Route 53 to + // return. If the specified VPC is associated with more than MaxItems hosted zones, + // the response includes a NextToken element. NextToken contains the hosted zone ID + // of the first hosted zone that Route 53 will return if you submit another + // request. + MaxItems *string // If the previous response included a NextToken element, the specified VPC is // associated with more hosted zones. To get more hosted zones, submit another @@ -88,17 +95,17 @@ type ListHostedZonesByVPCInput struct { // NextToken from the previous response. If the previous response didn't include a // NextToken element, there are no more hosted zones to get. NextToken *string - - // (Optional) The maximum number of hosted zones that you want Amazon Route 53 to - // return. If the specified VPC is associated with more than MaxItems hosted zones, - // the response includes a NextToken element. NextToken contains the hosted zone ID - // of the first hosted zone that Route 53 will return if you submit another - // request. - MaxItems *string } type ListHostedZonesByVPCOutput struct { + // A list that contains one HostedZoneSummary element for each hosted zone that the + // specified Amazon VPC is associated with. Each HostedZoneSummary element contains + // the hosted zone name and ID, and information about who owns the hosted zone. + // + // This member is required. + HostedZoneSummaries []*types.HostedZoneSummary + // The value that you specified for MaxItems in the most recent // ListHostedZonesByVPC request. // @@ -109,13 +116,6 @@ type ListHostedZonesByVPCOutput struct { // ListHostedZonesByVPC request. NextToken *string - // A list that contains one HostedZoneSummary element for each hosted zone that the - // specified Amazon VPC is associated with. Each HostedZoneSummary element contains - // the hosted zone name and ID, and information about who owns the hosted zone. - // - // This member is required. - HostedZoneSummaries []*types.HostedZoneSummary - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/route53/api_op_ListQueryLoggingConfigs.go b/service/route53/api_op_ListQueryLoggingConfigs.go index 407ccb05712..13411a4e9dd 100644 --- a/service/route53/api_op_ListQueryLoggingConfigs.go +++ b/service/route53/api_op_ListQueryLoggingConfigs.go @@ -68,13 +68,6 @@ type ListQueryLoggingConfigsInput struct { // configurations that are associated with the current AWS account. HostedZoneId *string - // (Optional) If the current AWS account has more than MaxResults query logging - // configurations, use NextToken to get the second and subsequent pages of results. - // For the first ListQueryLoggingConfigs request, omit this value. For the second - // and subsequent requests, get the value of NextToken from the previous response - // and specify that value for NextToken in the request. - NextToken *string - // (Optional) The maximum number of query logging configurations that you want // Amazon Route 53 to return in response to the current request. If the current AWS // account has more than MaxResults configurations, use the value of NextToken @@ -82,6 +75,13 @@ type ListQueryLoggingConfigsInput struct { // in the response to get the next page of results. If you don't specify a value // for MaxResults, Route 53 returns up to 100 configurations. MaxResults *string + + // (Optional) If the current AWS account has more than MaxResults query logging + // configurations, use NextToken to get the second and subsequent pages of results. + // For the first ListQueryLoggingConfigs request, omit this value. For the second + // and subsequent requests, get the value of NextToken from the previous response + // and specify that value for NextToken in the request. + NextToken *string } type ListQueryLoggingConfigsOutput struct { diff --git a/service/route53/api_op_ListResourceRecordSets.go b/service/route53/api_op_ListResourceRecordSets.go index e5a008ecf46..ac0d8fcf40a 100644 --- a/service/route53/api_op_ListResourceRecordSets.go +++ b/service/route53/api_op_ListResourceRecordSets.go @@ -102,11 +102,6 @@ type ListResourceRecordSetsInput struct { // This member is required. HostedZoneId *string - // The first name in the lexicographic ordering of resource record sets that you - // want to list. If the specified record name doesn't exist, the results begin with - // the first resource record set that has a name greater than the value of name. - StartRecordName *string - // (Optional) The maximum number of resource records sets to include in the // response body for this request. If the response includes more than maxitems // resource record sets, the value of the IsTruncated element in the response is @@ -121,6 +116,11 @@ type ListResourceRecordSetsInput struct { // set that has the current DNS name and type. StartRecordIdentifier *string + // The first name in the lexicographic ordering of resource record sets that you + // want to list. If the specified record name doesn't exist, the results begin with + // the first resource record set that has a name greater than the value of name. + StartRecordName *string + // The type of resource record set to begin the record listing from. Valid values // for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | // SOA | SPF | SRV | TXT Values for weighted, latency, geolocation, and failover @@ -162,15 +162,15 @@ type ListResourceRecordSetsOutput struct { // This member is required. IsTruncated *bool - // Information about multiple resource record sets. + // The maximum number of records you requested. // // This member is required. - ResourceRecordSets []*types.ResourceRecordSet + MaxItems *string - // The maximum number of records you requested. + // Information about multiple resource record sets. // // This member is required. - MaxItems *string + ResourceRecordSets []*types.ResourceRecordSet // Resource record sets that have a routing policy other than simple: If results // were truncated for a given DNS name and type, the value of SetIdentifier for the @@ -180,14 +180,14 @@ type ListResourceRecordSetsOutput struct { // in the Amazon Route 53 Developer Guide. NextRecordIdentifier *string - // If the results were truncated, the type of the next record in the list. This - // element is present only if IsTruncated is true. - NextRecordType types.RRType - // If the results were truncated, the name of the next record in the list. This // element is present only if IsTruncated is true. NextRecordName *string + // If the results were truncated, the type of the next record in the list. This + // element is present only if IsTruncated is true. + NextRecordType types.RRType + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/route53/api_op_ListReusableDelegationSets.go b/service/route53/api_op_ListReusableDelegationSets.go index 893a9ac3ded..091a750a96c 100644 --- a/service/route53/api_op_ListReusableDelegationSets.go +++ b/service/route53/api_op_ListReusableDelegationSets.go @@ -84,6 +84,12 @@ type ListReusableDelegationSetsOutput struct { // This member is required. DelegationSets []*types.DelegationSet + // A flag that indicates whether there are more reusable delegation sets to be + // listed. + // + // This member is required. + IsTruncated *bool + // For the second and subsequent calls to ListReusableDelegationSets, Marker is the // value that you specified for the marker parameter in the request that produced // the current response. @@ -91,24 +97,18 @@ type ListReusableDelegationSetsOutput struct { // This member is required. Marker *string - // If IsTruncated is true, the value of NextMarker identifies the next reusable - // delegation set that Amazon Route 53 will return if you submit another - // ListReusableDelegationSets request and specify the value of NextMarker in the - // marker parameter. - NextMarker *string - - // A flag that indicates whether there are more reusable delegation sets to be - // listed. - // - // This member is required. - IsTruncated *bool - // The value that you specified for the maxitems parameter in the call to // ListReusableDelegationSets that produced the current response. // // This member is required. MaxItems *string + // If IsTruncated is true, the value of NextMarker identifies the next reusable + // delegation set that Amazon Route 53 will return if you submit another + // ListReusableDelegationSets request and specify the value of NextMarker in the + // marker parameter. + NextMarker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/route53/api_op_ListTagsForResources.go b/service/route53/api_op_ListTagsForResources.go index c289ef32ddc..5fa57137c2a 100644 --- a/service/route53/api_op_ListTagsForResources.go +++ b/service/route53/api_op_ListTagsForResources.go @@ -62,6 +62,12 @@ func (c *Client) ListTagsForResources(ctx context.Context, params *ListTagsForRe // for which you want to list tags. type ListTagsForResourcesInput struct { + // A complex type that contains the ResourceId element for each resource for which + // you want to get a list of tags. + // + // This member is required. + ResourceIds []*string + // The type of the resources. // // * The resource type for health checks is @@ -71,12 +77,6 @@ type ListTagsForResourcesInput struct { // // This member is required. ResourceType types.TagResourceType - - // A complex type that contains the ResourceId element for each resource for which - // you want to get a list of tags. - // - // This member is required. - ResourceIds []*string } // A complex type containing tags for the specified resources. diff --git a/service/route53/api_op_ListTrafficPolicies.go b/service/route53/api_op_ListTrafficPolicies.go index 40e2245f46f..4ab389965b8 100644 --- a/service/route53/api_op_ListTrafficPolicies.go +++ b/service/route53/api_op_ListTrafficPolicies.go @@ -60,6 +60,13 @@ func (c *Client) ListTrafficPolicies(ctx context.Context, params *ListTrafficPol // traffic policies that are associated with the current AWS account. type ListTrafficPoliciesInput struct { + // (Optional) The maximum number of traffic policies that you want Amazon Route 53 + // to return in response to this request. If you have more than MaxItems traffic + // policies, the value of IsTruncated in the response is true, and the value of + // TrafficPolicyIdMarker is the ID of the first traffic policy that Route 53 will + // return if you submit another request. + MaxItems *string + // (Conditional) For your first request to ListTrafficPolicies, don't include the // TrafficPolicyIdMarker parameter. If you have more traffic policies than the // value of MaxItems, ListTrafficPolicies returns only the first MaxItems traffic @@ -67,24 +74,11 @@ type ListTrafficPoliciesInput struct { // ListTrafficPolicies. For the value of TrafficPolicyIdMarker, specify the value // of TrafficPolicyIdMarker that was returned in the previous response. TrafficPolicyIdMarker *string - - // (Optional) The maximum number of traffic policies that you want Amazon Route 53 - // to return in response to this request. If you have more than MaxItems traffic - // policies, the value of IsTruncated in the response is true, and the value of - // TrafficPolicyIdMarker is the ID of the first traffic policy that Route 53 will - // return if you submit another request. - MaxItems *string } // A complex type that contains the response information for the request. type ListTrafficPoliciesOutput struct { - // If the value of IsTruncated is true, TrafficPolicyIdMarker is the ID of the - // first traffic policy in the next group of MaxItems traffic policies. - // - // This member is required. - TrafficPolicyIdMarker *string - // A flag that indicates whether there are more traffic policies to be listed. If // the response was truncated, you can get the next group of traffic policies by // submitting another ListTrafficPolicies request and specifying the value of @@ -99,6 +93,12 @@ type ListTrafficPoliciesOutput struct { // This member is required. MaxItems *string + // If the value of IsTruncated is true, TrafficPolicyIdMarker is the ID of the + // first traffic policy in the next group of MaxItems traffic policies. + // + // This member is required. + TrafficPolicyIdMarker *string + // A list that contains one TrafficPolicySummary element for each traffic policy // that was created by the current AWS account. // diff --git a/service/route53/api_op_ListTrafficPolicyInstances.go b/service/route53/api_op_ListTrafficPolicyInstances.go index 91faea96167..131ace6d1fa 100644 --- a/service/route53/api_op_ListTrafficPolicyInstances.go +++ b/service/route53/api_op_ListTrafficPolicyInstances.go @@ -64,6 +64,15 @@ func (c *Client) ListTrafficPolicyInstances(ctx context.Context, params *ListTra // by using the current AWS account. type ListTrafficPolicyInstancesInput struct { + // If the value of IsTruncated in the previous response was true, you have more + // traffic policy instances. To get more traffic policy instances, submit another + // ListTrafficPolicyInstances request. For the value of HostedZoneId, specify the + // value of HostedZoneIdMarker from the previous response, which is the hosted zone + // ID of the first traffic policy instance in the next group of traffic policy + // instances. If the value of IsTruncated in the previous response was false, there + // are no more traffic policy instances to get. + HostedZoneIdMarker *string + // The maximum number of traffic policy instances that you want Amazon Route 53 to // return in response to a ListTrafficPolicyInstances request. If you have more // than MaxItems traffic policy instances, the value of the IsTruncated element in @@ -75,12 +84,12 @@ type ListTrafficPolicyInstancesInput struct { // If the value of IsTruncated in the previous response was true, you have more // traffic policy instances. To get more traffic policy instances, submit another - // ListTrafficPolicyInstances request. For the value of HostedZoneId, specify the - // value of HostedZoneIdMarker from the previous response, which is the hosted zone - // ID of the first traffic policy instance in the next group of traffic policy - // instances. If the value of IsTruncated in the previous response was false, there - // are no more traffic policy instances to get. - HostedZoneIdMarker *string + // ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename, + // specify the value of TrafficPolicyInstanceNameMarker from the previous response, + // which is the name of the first traffic policy instance in the next group of + // traffic policy instances. If the value of IsTruncated in the previous response + // was false, there are no more traffic policy instances to get. + TrafficPolicyInstanceNameMarker *string // If the value of IsTruncated in the previous response was true, you have more // traffic policy instances. To get more traffic policy instances, submit another @@ -90,37 +99,11 @@ type ListTrafficPolicyInstancesInput struct { // traffic policy instances. If the value of IsTruncated in the previous response // was false, there are no more traffic policy instances to get. TrafficPolicyInstanceTypeMarker types.RRType - - // If the value of IsTruncated in the previous response was true, you have more - // traffic policy instances. To get more traffic policy instances, submit another - // ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename, - // specify the value of TrafficPolicyInstanceNameMarker from the previous response, - // which is the name of the first traffic policy instance in the next group of - // traffic policy instances. If the value of IsTruncated in the previous response - // was false, there are no more traffic policy instances to get. - TrafficPolicyInstanceNameMarker *string } // A complex type that contains the response information for the request. type ListTrafficPolicyInstancesOutput struct { - // If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first - // traffic policy instance that Route 53 will return if you submit another - // ListTrafficPolicyInstances request. - TrafficPolicyInstanceNameMarker *string - - // A list that contains one TrafficPolicyInstance element for each traffic policy - // instance that matches the elements in the request. - // - // This member is required. - TrafficPolicyInstances []*types.TrafficPolicyInstance - - // If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the - // resource record sets that are associated with the first traffic policy instance - // that Amazon Route 53 will return if you submit another - // ListTrafficPolicyInstances request. - TrafficPolicyInstanceTypeMarker types.RRType - // A flag that indicates whether there are more traffic policy instances to be // listed. If the response was truncated, you can get more traffic policy instances // by calling ListTrafficPolicyInstances again and specifying the values of the @@ -130,17 +113,34 @@ type ListTrafficPolicyInstancesOutput struct { // This member is required. IsTruncated *bool - // If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the - // first traffic policy instance that Route 53 will return if you submit another - // ListTrafficPolicyInstances request. - HostedZoneIdMarker *string - // The value that you specified for the MaxItems parameter in the call to // ListTrafficPolicyInstances that produced the current response. // // This member is required. MaxItems *string + // A list that contains one TrafficPolicyInstance element for each traffic policy + // instance that matches the elements in the request. + // + // This member is required. + TrafficPolicyInstances []*types.TrafficPolicyInstance + + // If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the + // first traffic policy instance that Route 53 will return if you submit another + // ListTrafficPolicyInstances request. + HostedZoneIdMarker *string + + // If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first + // traffic policy instance that Route 53 will return if you submit another + // ListTrafficPolicyInstances request. + TrafficPolicyInstanceNameMarker *string + + // If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the + // resource record sets that are associated with the first traffic policy instance + // that Amazon Route 53 will return if you submit another + // ListTrafficPolicyInstances request. + TrafficPolicyInstanceTypeMarker types.RRType + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/route53/api_op_ListTrafficPolicyInstancesByHostedZone.go b/service/route53/api_op_ListTrafficPolicyInstancesByHostedZone.go index 03129730474..4e2e2f6e4c4 100644 --- a/service/route53/api_op_ListTrafficPolicyInstancesByHostedZone.go +++ b/service/route53/api_op_ListTrafficPolicyInstancesByHostedZone.go @@ -66,15 +66,6 @@ func (c *Client) ListTrafficPolicyInstancesByHostedZone(ctx context.Context, par // hosted zone. type ListTrafficPolicyInstancesByHostedZoneInput struct { - // If the value of IsTruncated in the previous response is true, you have more - // traffic policy instances. To get more traffic policy instances, submit another - // ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype, - // specify the value of TrafficPolicyInstanceTypeMarker from the previous response, - // which is the type of the first traffic policy instance in the next group of - // traffic policy instances. If the value of IsTruncated in the previous response - // was false, there are no more traffic policy instances to get. - TrafficPolicyInstanceTypeMarker types.RRType - // The ID of the hosted zone that you want to list traffic policy instances for. // // This member is required. @@ -96,6 +87,15 @@ type ListTrafficPolicyInstancesByHostedZoneInput struct { // traffic policy instances. If the value of IsTruncated in the previous response // was false, there are no more traffic policy instances to get. TrafficPolicyInstanceNameMarker *string + + // If the value of IsTruncated in the previous response is true, you have more + // traffic policy instances. To get more traffic policy instances, submit another + // ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype, + // specify the value of TrafficPolicyInstanceTypeMarker from the previous response, + // which is the type of the first traffic policy instance in the next group of + // traffic policy instances. If the value of IsTruncated in the previous response + // was false, there are no more traffic policy instances to get. + TrafficPolicyInstanceTypeMarker types.RRType } // A complex type that contains the response information for the request. diff --git a/service/route53/api_op_ListTrafficPolicyInstancesByPolicy.go b/service/route53/api_op_ListTrafficPolicyInstancesByPolicy.go index 6eeb0883fcf..50a3692e273 100644 --- a/service/route53/api_op_ListTrafficPolicyInstancesByPolicy.go +++ b/service/route53/api_op_ListTrafficPolicyInstancesByPolicy.go @@ -66,15 +66,18 @@ func (c *Client) ListTrafficPolicyInstancesByPolicy(ctx context.Context, params // traffic policy instances. type ListTrafficPolicyInstancesByPolicyInput struct { - // If the value of IsTruncated in the previous response was true, you have more - // traffic policy instances. To get more traffic policy instances, submit another - // ListTrafficPolicyInstancesByPolicy request. For the value of - // trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker - // from the previous response, which is the name of the first traffic policy - // instance that Amazon Route 53 will return if you submit another request. If the - // value of IsTruncated in the previous response was false, there are no more - // traffic policy instances to get. - TrafficPolicyInstanceTypeMarker types.RRType + // The ID of the traffic policy for which you want to list traffic policy + // instances. + // + // This member is required. + TrafficPolicyId *string + + // The version of the traffic policy for which you want to list traffic policy + // instances. The version must be associated with the traffic policy that is + // specified by TrafficPolicyId. + // + // This member is required. + TrafficPolicyVersion *int32 // If the value of IsTruncated in the previous response was true, you have more // traffic policy instances. To get more traffic policy instances, submit another @@ -85,11 +88,13 @@ type ListTrafficPolicyInstancesByPolicyInput struct { // previous response was false, there are no more traffic policy instances to get. HostedZoneIdMarker *string - // The ID of the traffic policy for which you want to list traffic policy - // instances. - // - // This member is required. - TrafficPolicyId *string + // The maximum number of traffic policy instances to be included in the response + // body for this request. If you have more than MaxItems traffic policy instances, + // the value of the IsTruncated element in the response is true, and the values of + // HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and + // TrafficPolicyInstanceTypeMarker represent the first traffic policy instance that + // Amazon Route 53 will return if you submit another request. + MaxItems *string // If the value of IsTruncated in the previous response was true, you have more // traffic policy instances. To get more traffic policy instances, submit another @@ -101,35 +106,20 @@ type ListTrafficPolicyInstancesByPolicyInput struct { // traffic policy instances to get. TrafficPolicyInstanceNameMarker *string - // The maximum number of traffic policy instances to be included in the response - // body for this request. If you have more than MaxItems traffic policy instances, - // the value of the IsTruncated element in the response is true, and the values of - // HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and - // TrafficPolicyInstanceTypeMarker represent the first traffic policy instance that - // Amazon Route 53 will return if you submit another request. - MaxItems *string - - // The version of the traffic policy for which you want to list traffic policy - // instances. The version must be associated with the traffic policy that is - // specified by TrafficPolicyId. - // - // This member is required. - TrafficPolicyVersion *int32 + // If the value of IsTruncated in the previous response was true, you have more + // traffic policy instances. To get more traffic policy instances, submit another + // ListTrafficPolicyInstancesByPolicy request. For the value of + // trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker + // from the previous response, which is the name of the first traffic policy + // instance that Amazon Route 53 will return if you submit another request. If the + // value of IsTruncated in the previous response was false, there are no more + // traffic policy instances to get. + TrafficPolicyInstanceTypeMarker types.RRType } // A complex type that contains the response information for the request. type ListTrafficPolicyInstancesByPolicyOutput struct { - // A list that contains one TrafficPolicyInstance element for each traffic policy - // instance that matches the elements in the request. - // - // This member is required. - TrafficPolicyInstances []*types.TrafficPolicyInstance - - // If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first - // traffic policy instance in the next group of MaxItems traffic policy instances. - TrafficPolicyInstanceNameMarker *string - // A flag that indicates whether there are more traffic policy instances to be // listed. If the response was truncated, you can get the next group of traffic // policy instances by calling ListTrafficPolicyInstancesByPolicy again and @@ -146,15 +136,25 @@ type ListTrafficPolicyInstancesByPolicyOutput struct { // This member is required. MaxItems *string - // If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the - // resource record sets that are associated with the first traffic policy instance - // in the next group of MaxItems traffic policy instances. - TrafficPolicyInstanceTypeMarker types.RRType + // A list that contains one TrafficPolicyInstance element for each traffic policy + // instance that matches the elements in the request. + // + // This member is required. + TrafficPolicyInstances []*types.TrafficPolicyInstance // If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the // first traffic policy instance in the next group of traffic policy instances. HostedZoneIdMarker *string + // If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first + // traffic policy instance in the next group of MaxItems traffic policy instances. + TrafficPolicyInstanceNameMarker *string + + // If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the + // resource record sets that are associated with the first traffic policy instance + // in the next group of MaxItems traffic policy instances. + TrafficPolicyInstanceTypeMarker types.RRType + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/route53/api_op_ListTrafficPolicyVersions.go b/service/route53/api_op_ListTrafficPolicyVersions.go index b941b331303..f888f437e78 100644 --- a/service/route53/api_op_ListTrafficPolicyVersions.go +++ b/service/route53/api_op_ListTrafficPolicyVersions.go @@ -60,6 +60,12 @@ func (c *Client) ListTrafficPolicyVersions(ctx context.Context, params *ListTraf // traffic policies. type ListTrafficPolicyVersionsInput struct { + // Specify the value of Id of the traffic policy for which you want to list all + // versions. + // + // This member is required. + Id *string + // The maximum number of traffic policy versions that you want Amazon Route 53 to // include in the response body for this request. If the specified traffic policy // has more than MaxItems versions, the value of IsTruncated in the response is @@ -74,30 +80,30 @@ type ListTrafficPolicyVersionsInput struct { // ListTrafficPolicyVersions request. For the value of TrafficPolicyVersionMarker, // specify the value of TrafficPolicyVersionMarker in the previous response. TrafficPolicyVersionMarker *string - - // Specify the value of Id of the traffic policy for which you want to list all - // versions. - // - // This member is required. - Id *string } // A complex type that contains the response information for the request. type ListTrafficPolicyVersionsOutput struct { + // A flag that indicates whether there are more traffic policies to be listed. If + // the response was truncated, you can get the next group of traffic policies by + // submitting another ListTrafficPolicyVersions request and specifying the value of + // NextMarker in the marker parameter. + // + // This member is required. + IsTruncated *bool + // The value that you specified for the maxitems parameter in the // ListTrafficPolicyVersions request that produced the current response. // // This member is required. MaxItems *string - // A flag that indicates whether there are more traffic policies to be listed. If - // the response was truncated, you can get the next group of traffic policies by - // submitting another ListTrafficPolicyVersions request and specifying the value of - // NextMarker in the marker parameter. + // A list that contains one TrafficPolicy element for each traffic policy version + // that is associated with the specified traffic policy. // // This member is required. - IsTruncated *bool + TrafficPolicies []*types.TrafficPolicy // If IsTruncated is true, the value of TrafficPolicyVersionMarker identifies the // first traffic policy that Amazon Route 53 will return if you submit another @@ -108,12 +114,6 @@ type ListTrafficPolicyVersionsOutput struct { // This member is required. TrafficPolicyVersionMarker *string - // A list that contains one TrafficPolicy element for each traffic policy version - // that is associated with the specified traffic policy. - // - // This member is required. - TrafficPolicies []*types.TrafficPolicy - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/route53/api_op_ListVPCAssociationAuthorizations.go b/service/route53/api_op_ListVPCAssociationAuthorizations.go index b8d731de80f..df1ea2804e2 100644 --- a/service/route53/api_op_ListVPCAssociationAuthorizations.go +++ b/service/route53/api_op_ListVPCAssociationAuthorizations.go @@ -63,6 +63,12 @@ func (c *Client) ListVPCAssociationAuthorizations(ctx context.Context, params *L // hosted zone. type ListVPCAssociationAuthorizationsInput struct { + // The ID of the hosted zone for which you want a list of VPCs that can be + // associated with the hosted zone. + // + // This member is required. + HostedZoneId *string + // Optional: An integer that specifies the maximum number of VPCs that you want // Amazon Route 53 to return. If you don't specify a value for MaxResults, Route 53 // returns up to 50 VPCs per page. @@ -74,12 +80,6 @@ type ListVPCAssociationAuthorizationsInput struct { // response in the nexttoken parameter in another ListVPCAssociationAuthorizations // request. NextToken *string - - // The ID of the hosted zone for which you want a list of VPCs that can be - // associated with the hosted zone. - // - // This member is required. - HostedZoneId *string } // A complex type that contains the response information for the request. @@ -90,18 +90,18 @@ type ListVPCAssociationAuthorizationsOutput struct { // This member is required. HostedZoneId *string - // When the response includes a NextToken element, there are more VPCs that can be - // associated with the specified hosted zone. To get the next page of VPCs, submit - // another ListVPCAssociationAuthorizations request, and include the value of the - // NextToken element from the response in the nexttoken request parameter. - NextToken *string - // The list of VPCs that are authorized to be associated with the specified hosted // zone. // // This member is required. VPCs []*types.VPC + // When the response includes a NextToken element, there are more VPCs that can be + // associated with the specified hosted zone. To get the next page of VPCs, submit + // another ListVPCAssociationAuthorizations request, and include the value of the + // NextToken element from the response in the nexttoken request parameter. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/route53/api_op_TestDNSAnswer.go b/service/route53/api_op_TestDNSAnswer.go index bbd1e4d789f..02e621c95d8 100644 --- a/service/route53/api_op_TestDNSAnswer.go +++ b/service/route53/api_op_TestDNSAnswer.go @@ -62,11 +62,6 @@ func (c *Client) TestDNSAnswer(ctx context.Context, params *TestDNSAnswerInput, // DNS resolver, an EDNS0 client subnet IP address, and a subnet mask. type TestDNSAnswerInput struct { - // If you want to simulate a request from a specific DNS resolver, specify the IP - // address for that resolver. If you omit this value, TestDnsAnswer uses the IP - // address of a DNS resolver in the AWS US East (N. Virginia) Region (us-east-1). - ResolverIP *string - // The ID of the hosted zone that you want Amazon Route 53 to simulate a query for. // // This member is required. @@ -78,6 +73,16 @@ type TestDNSAnswerInput struct { // This member is required. RecordName *string + // The type of the resource record set. + // + // This member is required. + RecordType types.RRType + + // If the resolver that you specified for resolverip supports EDNS0, specify the + // IPv4 or IPv6 address of a client in the applicable location, for example, + // 192.0.2.44 or 2001:db8:85a3::8a2e:370:7334. + EDNS0ClientSubnetIP *string + // If you specify an IP address for edns0clientsubnetip, you can optionally specify // the number of bits of the IP address that you want the checking tool to include // in the DNS query. For example, if you specify 192.0.2.44 for edns0clientsubnetip @@ -92,15 +97,10 @@ type TestDNSAnswerInput struct { // * IPv6: Specify a value between 0 and 128 EDNS0ClientSubnetMask *string - // The type of the resource record set. - // - // This member is required. - RecordType types.RRType - - // If the resolver that you specified for resolverip supports EDNS0, specify the - // IPv4 or IPv6 address of a client in the applicable location, for example, - // 192.0.2.44 or 2001:db8:85a3::8a2e:370:7334. - EDNS0ClientSubnetIP *string + // If you want to simulate a request from a specific DNS resolver, specify the IP + // address for that resolver. If you omit this value, TestDnsAnswer uses the IP + // address of a DNS resolver in the AWS US East (N. Virginia) Region (us-east-1). + ResolverIP *string } // A complex type that contains the response to a TestDNSAnswer request. @@ -117,11 +117,22 @@ type TestDNSAnswerOutput struct { // This member is required. Protocol *string + // A list that contains values that Amazon Route 53 returned for this resource + // record set. + // + // This member is required. + RecordData []*string + // The name of the resource record set that you submitted a request for. // // This member is required. RecordName *string + // The type of the resource record set that you submitted a request for. + // + // This member is required. + RecordType types.RRType + // A code that indicates whether the request is valid or not. The most common // response code is NOERROR, meaning that the request is valid. If the response is // not valid, Amazon Route 53 returns a response code that describes the error. For @@ -132,17 +143,6 @@ type TestDNSAnswerOutput struct { // This member is required. ResponseCode *string - // A list that contains values that Amazon Route 53 returned for this resource - // record set. - // - // This member is required. - RecordData []*string - - // The type of the resource record set that you submitted a request for. - // - // This member is required. - RecordType types.RRType - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/route53/api_op_UpdateHealthCheck.go b/service/route53/api_op_UpdateHealthCheck.go index fa90a8d6f85..c9e806cbb38 100644 --- a/service/route53/api_op_UpdateHealthCheck.go +++ b/service/route53/api_op_UpdateHealthCheck.go @@ -63,6 +63,22 @@ func (c *Client) UpdateHealthCheck(ctx context.Context, params *UpdateHealthChec // check. type UpdateHealthCheckInput struct { + // The ID for the health check for which you want detailed information. When you + // created the health check, CreateHealthCheck returned the ID in the response, in + // the HealthCheckId element. + // + // This member is required. + HealthCheckId *string + + // A complex type that identifies the CloudWatch alarm that you want Amazon Route + // 53 health checkers to use to determine whether the specified health check is + // healthy. + AlarmIdentifier *types.AlarmIdentifier + + // A complex type that contains one ChildHealthCheck element for each health check + // that you want to associate with a CALCULATED health check. + ChildHealthChecks []*string + // Stops Route 53 from performing health checks. When you disable a health check, // here's what happens: // @@ -87,81 +103,6 @@ type UpdateHealthCheckInput struct { // href="http://aws.amazon.com/route53/pricing/">Amazon Route 53 Pricing    .

    Disabled *bool - // The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to - // perform health checks on. If you don't specify a value for IPAddress, Route 53 - // sends a DNS request to resolve the domain name that you specify in - // FullyQualifiedDomainName at the interval that you specify in RequestInterval. - // Using an IP address that is returned by DNS, Route 53 then checks the health of - // the endpoint. Use one of the following formats for the value of IPAddress: - // - // - // * IPv4 address: four values between 0 and 255, separated by periods (.), for - // example, 192.0.2.44. - // - // * IPv6 address: eight groups of four hexadecimal - // values, separated by colons (:), for example, - // 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as - // described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345. - // - // If the endpoint - // is an EC2 instance, we recommend that you create an Elastic IP address, - // associate it with your EC2 instance, and specify the Elastic IP address for - // IPAddress. This ensures that the IP address of your instance never changes. For - // more information, see the applicable documentation: - // - // * Linux: Elastic IP - // Addresses (EIP) - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) - // in the Amazon EC2 User Guide for Linux Instances - // - // * Windows: Elastic IP - // Addresses (EIP) - // (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-ip-addresses-eip.html) - // in the Amazon EC2 User Guide for Windows Instances - // - // If a health check already - // has a value for IPAddress, you can change the value. However, you can't update - // an existing health check to add or remove the value of IPAddress. For more - // information, see FullyQualifiedDomainName - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-FullyQualifiedDomainName). - // Constraints: Route 53 can't check the health of endpoints for which the IP - // address is in local, private, non-routable, or multicast ranges. For more - // information about IP addresses for which you can't create health checks, see the - // following documents: - // - // * RFC 5735, Special Use IPv4 Addresses - // (https://tools.ietf.org/html/rfc5735) - // - // * RFC 6598, IANA-Reserved IPv4 Prefix - // for Shared Address Space (https://tools.ietf.org/html/rfc6598) - // - // * RFC 5156, - // Special-Use IPv6 Addresses (https://tools.ietf.org/html/rfc5156) - IPAddress *string - - // A complex type that identifies the CloudWatch alarm that you want Amazon Route - // 53 health checkers to use to determine whether the specified health check is - // healthy. - AlarmIdentifier *types.AlarmIdentifier - - // The port on the endpoint that you want Amazon Route 53 to perform health checks - // on. Don't specify a value for Port when you specify a value for Type of - // CLOUDWATCH_METRIC or CALCULATED. - Port *int32 - - // The path that you want Amazon Route 53 to request when performing health checks. - // The path can be any value for which your endpoint will return an HTTP status - // code of 2xx or 3xx when the endpoint is healthy, for example the file - // /docs/route53-health-check.html. You can also include query string parameters, - // for example, /welcome.html?language=jp&login=y. Specify this value only if you - // want to change it. - ResourcePath *string - - // Specify whether you want Amazon Route 53 to invert the status of a health check, - // for example, to consider a health check unhealthy when it otherwise would be - // considered healthy. - Inverted *bool - // Specify whether you want Amazon Route 53 to send the value of // FullyQualifiedDomainName to the endpoint in the client_hello message during TLS // negotiation. This allows the endpoint to respond to HTTPS health check requests @@ -190,10 +131,6 @@ type UpdateHealthCheckInput struct { // FailureThreshold, the default value is three health checks. FailureThreshold *int32 - // A complex type that contains one Region element for each region that you want - // Amazon Route 53 health checkers to check the specified endpoint from. - Regions []types.HealthCheckRegion - // Amazon Route 53 behavior depends on whether you specify a value for IPAddress. //

    If a health check already has a value for IPAddress, you // can change the value. However, you can't update an existing health check to add @@ -248,35 +185,6 @@ type UpdateHealthCheckInput struct { // header.

    FullyQualifiedDomainName *string - // When CloudWatch has insufficient data about the metric to determine the alarm - // state, the status that you want Amazon Route 53 to assign to the health check: - // - // - // * Healthy: Route 53 considers the health check to be healthy. - // - // * Unhealthy: - // Route 53 considers the health check to be unhealthy. - // - // * LastKnownStatus: - // Route 53 uses the status of the health check from the last time CloudWatch had - // sufficient data to determine the alarm state. For new health checks that have no - // last known status, the default status for the health check is healthy. - InsufficientDataHealthStatus types.InsufficientDataHealthStatus - - // If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you - // want Amazon Route 53 to search for in the response body from the specified - // resource. If the string appears in the response body, Route 53 considers the - // resource healthy. (You can't change the value of Type when you update a health - // check.) - SearchString *string - - // The ID for the health check for which you want detailed information. When you - // created the health check, CreateHealthCheck returned the ID in the response, in - // the HealthCheckId element. - // - // This member is required. - HealthCheckId *string - // A sequential counter that Amazon Route 53 sets to 1 when you create a health // check and increments by 1 each time you update settings for the health check. We // recommend that you use GetHealthCheck or ListHealthChecks to get the current @@ -308,6 +216,87 @@ type UpdateHealthCheckInput struct { // this health check to be healthy. HealthThreshold *int32 + // The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to + // perform health checks on. If you don't specify a value for IPAddress, Route 53 + // sends a DNS request to resolve the domain name that you specify in + // FullyQualifiedDomainName at the interval that you specify in RequestInterval. + // Using an IP address that is returned by DNS, Route 53 then checks the health of + // the endpoint. Use one of the following formats for the value of IPAddress: + // + // + // * IPv4 address: four values between 0 and 255, separated by periods (.), for + // example, 192.0.2.44. + // + // * IPv6 address: eight groups of four hexadecimal + // values, separated by colons (:), for example, + // 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as + // described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345. + // + // If the endpoint + // is an EC2 instance, we recommend that you create an Elastic IP address, + // associate it with your EC2 instance, and specify the Elastic IP address for + // IPAddress. This ensures that the IP address of your instance never changes. For + // more information, see the applicable documentation: + // + // * Linux: Elastic IP + // Addresses (EIP) + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) + // in the Amazon EC2 User Guide for Linux Instances + // + // * Windows: Elastic IP + // Addresses (EIP) + // (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-ip-addresses-eip.html) + // in the Amazon EC2 User Guide for Windows Instances + // + // If a health check already + // has a value for IPAddress, you can change the value. However, you can't update + // an existing health check to add or remove the value of IPAddress. For more + // information, see FullyQualifiedDomainName + // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-FullyQualifiedDomainName). + // Constraints: Route 53 can't check the health of endpoints for which the IP + // address is in local, private, non-routable, or multicast ranges. For more + // information about IP addresses for which you can't create health checks, see the + // following documents: + // + // * RFC 5735, Special Use IPv4 Addresses + // (https://tools.ietf.org/html/rfc5735) + // + // * RFC 6598, IANA-Reserved IPv4 Prefix + // for Shared Address Space (https://tools.ietf.org/html/rfc6598) + // + // * RFC 5156, + // Special-Use IPv6 Addresses (https://tools.ietf.org/html/rfc5156) + IPAddress *string + + // When CloudWatch has insufficient data about the metric to determine the alarm + // state, the status that you want Amazon Route 53 to assign to the health check: + // + // + // * Healthy: Route 53 considers the health check to be healthy. + // + // * Unhealthy: + // Route 53 considers the health check to be unhealthy. + // + // * LastKnownStatus: + // Route 53 uses the status of the health check from the last time CloudWatch had + // sufficient data to determine the alarm state. For new health checks that have no + // last known status, the default status for the health check is healthy. + InsufficientDataHealthStatus types.InsufficientDataHealthStatus + + // Specify whether you want Amazon Route 53 to invert the status of a health check, + // for example, to consider a health check unhealthy when it otherwise would be + // considered healthy. + Inverted *bool + + // The port on the endpoint that you want Amazon Route 53 to perform health checks + // on. Don't specify a value for Port when you specify a value for Type of + // CLOUDWATCH_METRIC or CALCULATED. + Port *int32 + + // A complex type that contains one Region element for each region that you want + // Amazon Route 53 health checkers to check the specified endpoint from. + Regions []types.HealthCheckRegion + // A complex type that contains one ResettableElementName element for each element // that you want to reset to the default value. Valid values for // ResettableElementName include the following: @@ -332,9 +321,20 @@ type UpdateHealthCheckInput struct { // to null. ResetElements []types.ResettableElementName - // A complex type that contains one ChildHealthCheck element for each health check - // that you want to associate with a CALCULATED health check. - ChildHealthChecks []*string + // The path that you want Amazon Route 53 to request when performing health checks. + // The path can be any value for which your endpoint will return an HTTP status + // code of 2xx or 3xx when the endpoint is healthy, for example the file + // /docs/route53-health-check.html. You can also include query string parameters, + // for example, /welcome.html?language=jp&login=y. Specify this value only if you + // want to change it. + ResourcePath *string + + // If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you + // want Amazon Route 53 to search for in the response body from the specified + // resource. If the string appears in the response body, Route 53 considers the + // resource healthy. (You can't change the value of Type when you update a health + // check.) + SearchString *string } // A complex type that contains the response to the UpdateHealthCheck request. diff --git a/service/route53/api_op_UpdateTrafficPolicyComment.go b/service/route53/api_op_UpdateTrafficPolicyComment.go index dcb437a108c..5c69303db4b 100644 --- a/service/route53/api_op_UpdateTrafficPolicyComment.go +++ b/service/route53/api_op_UpdateTrafficPolicyComment.go @@ -59,12 +59,6 @@ func (c *Client) UpdateTrafficPolicyComment(ctx context.Context, params *UpdateT // to update the comment for. type UpdateTrafficPolicyCommentInput struct { - // The value of Version for the traffic policy that you want to update the comment - // for. - // - // This member is required. - Version *int32 - // The new comment for the specified traffic policy and version. // // This member is required. @@ -74,6 +68,12 @@ type UpdateTrafficPolicyCommentInput struct { // // This member is required. Id *string + + // The value of Version for the traffic policy that you want to update the comment + // for. + // + // This member is required. + Version *int32 } // A complex type that contains the response information for the traffic policy. diff --git a/service/route53/api_op_UpdateTrafficPolicyInstance.go b/service/route53/api_op_UpdateTrafficPolicyInstance.go index 9d9d60405a8..3a992ec6057 100644 --- a/service/route53/api_op_UpdateTrafficPolicyInstance.go +++ b/service/route53/api_op_UpdateTrafficPolicyInstance.go @@ -77,6 +77,11 @@ func (c *Client) UpdateTrafficPolicyInstance(ctx context.Context, params *Update // want to update based on a specified traffic policy instance. type UpdateTrafficPolicyInstanceInput struct { + // The ID of the traffic policy instance that you want to update. + // + // This member is required. + Id *string + // The TTL that you want Amazon Route 53 to assign to all of the updated resource // record sets. // @@ -94,11 +99,6 @@ type UpdateTrafficPolicyInstanceInput struct { // // This member is required. TrafficPolicyVersion *int32 - - // The ID of the traffic policy instance that you want to update. - // - // This member is required. - Id *string } // A complex type that contains information about the resource record sets that diff --git a/service/route53/go.mod b/service/route53/go.mod index 58d42e388f0..d2b4d85b74e 100644 --- a/service/route53/go.mod +++ b/service/route53/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/route53 go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/route53/types/types.go b/service/route53/types/types.go index fc364304f72..cd2f726d8fa 100644 --- a/service/route53/types/types.go +++ b/service/route53/types/types.go @@ -10,12 +10,6 @@ import ( // and the current value for that limit. type AccountLimit struct { - // The current value for the limit that is specified by Type - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_AccountLimit.html#Route53-Type-AccountLimit-Type). - // - // This member is required. - Value *int64 - // The limit that you requested. Valid values include the following: // // * @@ -41,6 +35,12 @@ type AccountLimit struct { // // This member is required. Type AccountLimitType + + // The current value for the limit that is specified by Type + // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_AccountLimit.html#Route53-Type-AccountLimit-Type). + // + // This member is required. + Value *int64 } // A complex type that identifies the CloudWatch alarm that you want Amazon Route @@ -48,15 +48,6 @@ type AccountLimit struct { // healthy. type AlarmIdentifier struct { - // For the CloudWatch alarm that you want Route 53 health checkers to use to - // determine whether this health check is healthy, the region that the alarm was - // created in. For the current list of CloudWatch regions, see Amazon CloudWatch - // (https://docs.aws.amazon.com/general/latest/gr/rande.html#cw_region) in the AWS - // Service Endpoints chapter of the Amazon Web Services General Reference. - // - // This member is required. - Region CloudWatchRegion - // The name of the CloudWatch alarm that you want Amazon Route 53 health checkers // to use to determine whether this health check is healthy. Route 53 supports // CloudWatch alarms with the following features: @@ -72,6 +63,15 @@ type AlarmIdentifier struct { // // This member is required. Name *string + + // For the CloudWatch alarm that you want Route 53 health checkers to use to + // determine whether this health check is healthy, the region that the alarm was + // created in. For the current list of CloudWatch regions, see Amazon CloudWatch + // (https://docs.aws.amazon.com/general/latest/gr/rande.html#cw_region) in the AWS + // Service Endpoints chapter of the Amazon Web Services General Reference. + // + // This member is required. + Region CloudWatchRegion } // Alias resource record sets only: Information about the AWS resource, such as a @@ -88,61 +88,6 @@ type AlarmIdentifier struct { // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html). type AliasTarget struct { - // Applies only to alias, failover alias, geolocation alias, latency alias, and - // weighted alias resource record sets: When EvaluateTargetHealth is true, an alias - // resource record set inherits the health of the referenced AWS resource, such as - // an ELB load balancer or another resource record set in the hosted zone. Note the - // following:
    CloudFront distributions

    You can't set - // EvaluateTargetHealth to true when the alias target is - // a CloudFront distribution.

    Elastic Beanstalk environments that - // have regionalized subdomains

    If you specify an Elastic Beanstalk - // environment in DNSName and the environment contains an ELB load - // balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 - // instances that are registered with the load balancer. (An environment - // automatically contains an ELB load balancer if it includes more than one Amazon - // EC2 instance.) If you set EvaluateTargetHealth to true - // and either no Amazon EC2 instances are healthy or the load balancer itself is - // unhealthy, Route 53 routes queries to other available resources that are - // healthy, if any.

    If the environment contains a single Amazon EC2 - // instance, there are no special requirements.

    ELB load - // balancers

    Health checking behavior depends on the type of load - // balancer:

    • Classic Load Balancers: If you specify an ELB - // Classic Load Balancer in DNSName, Elastic Load Balancing routes - // queries only to the healthy Amazon EC2 instances that are registered with the - // load balancer. If you set EvaluateTargetHealth to true - // and either no EC2 instances are healthy or the load balancer itself is - // unhealthy, Route 53 routes queries to other resources.

    • - // Application and Network Load Balancers: If you specify an ELB Application - // or Network Load Balancer and you set EvaluateTargetHealth to - // true, Route 53 routes queries to the load balancer based on the - // health of the target groups that are associated with the load balancer:

        - //

      • For an Application or Network Load Balancer to be considered healthy, - // every target group that contains targets must contain at least one healthy - // target. If any target group contains only unhealthy targets, the load balancer - // is considered unhealthy, and Route 53 routes queries to other resources.

        - //

      • A target group that has no registered targets is considered - // unhealthy.

    When you create a load - // balancer, you configure settings for Elastic Load Balancing health checks; - // they're not Route 53 health checks, but they perform a similar function. Do not - // create Route 53 health checks for the EC2 instances that you register with an - // ELB load balancer.

    S3 buckets

    There are no - // special requirements for setting EvaluateTargetHealth to - // true when the alias target is an S3 bucket.

    Other - // records in the same hosted zone

    If the AWS resource that you - // specify in DNSName is a record or a group of records (for example, - // a group of weighted records) but is not another alias record, we recommend that - // you associate a health check with all of the records in the alias target. For - // more information, see What - // Happens When You Omit Health Checks? in the Amazon Route 53 Developer - // Guide.

    For more information and examples, see Amazon - // Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer - // Guide.

    - // - // This member is required. - EvaluateTargetHealth *bool - // Alias resource record sets only: The value that you specify depends on where you // want to route queries: Amazon API Gateway custom regional APIs and // edge-optimized APIs Specify the applicable domain name for your API. You can get @@ -280,6 +225,61 @@ type AliasTarget struct { // This member is required. DNSName *string + // Applies only to alias, failover alias, geolocation alias, latency alias, and + // weighted alias resource record sets: When EvaluateTargetHealth is true, an alias + // resource record set inherits the health of the referenced AWS resource, such as + // an ELB load balancer or another resource record set in the hosted zone. Note the + // following:
    CloudFront distributions

    You can't set + // EvaluateTargetHealth to true when the alias target is + // a CloudFront distribution.

    Elastic Beanstalk environments that + // have regionalized subdomains

    If you specify an Elastic Beanstalk + // environment in DNSName and the environment contains an ELB load + // balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 + // instances that are registered with the load balancer. (An environment + // automatically contains an ELB load balancer if it includes more than one Amazon + // EC2 instance.) If you set EvaluateTargetHealth to true + // and either no Amazon EC2 instances are healthy or the load balancer itself is + // unhealthy, Route 53 routes queries to other available resources that are + // healthy, if any.

    If the environment contains a single Amazon EC2 + // instance, there are no special requirements.

    ELB load + // balancers

    Health checking behavior depends on the type of load + // balancer:

    • Classic Load Balancers: If you specify an ELB + // Classic Load Balancer in DNSName, Elastic Load Balancing routes + // queries only to the healthy Amazon EC2 instances that are registered with the + // load balancer. If you set EvaluateTargetHealth to true + // and either no EC2 instances are healthy or the load balancer itself is + // unhealthy, Route 53 routes queries to other resources.

    • + // Application and Network Load Balancers: If you specify an ELB Application + // or Network Load Balancer and you set EvaluateTargetHealth to + // true, Route 53 routes queries to the load balancer based on the + // health of the target groups that are associated with the load balancer:

        + //

      • For an Application or Network Load Balancer to be considered healthy, + // every target group that contains targets must contain at least one healthy + // target. If any target group contains only unhealthy targets, the load balancer + // is considered unhealthy, and Route 53 routes queries to other resources.

        + //

      • A target group that has no registered targets is considered + // unhealthy.

    When you create a load + // balancer, you configure settings for Elastic Load Balancing health checks; + // they're not Route 53 health checks, but they perform a similar function. Do not + // create Route 53 health checks for the EC2 instances that you register with an + // ELB load balancer.

    S3 buckets

    There are no + // special requirements for setting EvaluateTargetHealth to + // true when the alias target is an S3 bucket.

    Other + // records in the same hosted zone

    If the AWS resource that you + // specify in DNSName is a record or a group of records (for example, + // a group of weighted records) but is not another alias record, we recommend that + // you associate a health check with all of the records in the alias target. For + // more information, see What + // Happens When You Omit Health Checks? in the Amazon Route 53 Developer + // Guide.

    For more information and examples, see Amazon + // Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer + // Guide.

    + // + // This member is required. + EvaluateTargetHealth *bool + // Alias resource records sets only: The value used depends on where you want to // route traffic: Amazon API Gateway custom regional APIs and edge-optimized APIs // Specify the hosted zone ID for your API. You can get the applicable value using @@ -411,12 +411,11 @@ type ChangeInfo struct { // This member is required. Id *string - // A complex type that describes change information about changes made to your - // hosted zone. This element contains an ID that you use when performing a - // GetChange - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html) - // action to get detailed information about the change. - Comment *string + // The current state of the request. PENDING indicates that this request has not + // yet been applied to all Amazon Route 53 DNS servers. + // + // This member is required. + Status ChangeStatus // The date and time that the change request was submitted in ISO 8601 format // (https://en.wikipedia.org/wiki/ISO_8601) and Coordinated Universal Time (UTC). @@ -426,55 +425,48 @@ type ChangeInfo struct { // This member is required. SubmittedAt *time.Time - // The current state of the request. PENDING indicates that this request has not - // yet been applied to all Amazon Route 53 DNS servers. - // - // This member is required. - Status ChangeStatus + // A complex type that describes change information about changes made to your + // hosted zone. This element contains an ID that you use when performing a + // GetChange + // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html) + // action to get detailed information about the change. + Comment *string } // A complex type that contains information about the CloudWatch alarm that Amazon // Route 53 is monitoring for this health check. type CloudWatchAlarmConfiguration struct { - // For the metric that the CloudWatch alarm is associated with, the value the - // metric is compared with. + // For the metric that the CloudWatch alarm is associated with, the arithmetic + // operation that is used for the comparison. // // This member is required. - Threshold *float64 + ComparisonOperator ComparisonOperator - // The namespace of the metric that the alarm is associated with. For more - // information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html) - // in the Amazon CloudWatch User Guide. + // For the metric that the CloudWatch alarm is associated with, the number of + // periods that the metric is compared to the threshold. // // This member is required. - Namespace *string + EvaluationPeriods *int32 - // For the metric that the CloudWatch alarm is associated with, the duration of one - // evaluation period in seconds. + // The name of the CloudWatch metric that the alarm is associated with. // // This member is required. - Period *int32 + MetricName *string - // For the metric that the CloudWatch alarm is associated with, a complex type that - // contains information about the dimensions for the metric. For information, see - // Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference + // The namespace of the metric that the alarm is associated with. For more + // information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html) // in the Amazon CloudWatch User Guide. - Dimensions []*Dimension - - // For the metric that the CloudWatch alarm is associated with, the number of - // periods that the metric is compared to the threshold. // // This member is required. - EvaluationPeriods *int32 + Namespace *string - // For the metric that the CloudWatch alarm is associated with, the arithmetic - // operation that is used for the comparison. + // For the metric that the CloudWatch alarm is associated with, the duration of one + // evaluation period in seconds. // // This member is required. - ComparisonOperator ComparisonOperator + Period *int32 // For the metric that the CloudWatch alarm is associated with, the statistic that // is applied to the metric. @@ -482,10 +474,18 @@ type CloudWatchAlarmConfiguration struct { // This member is required. Statistic Statistic - // The name of the CloudWatch metric that the alarm is associated with. + // For the metric that the CloudWatch alarm is associated with, the value the + // metric is compared with. // // This member is required. - MetricName *string + Threshold *float64 + + // For the metric that the CloudWatch alarm is associated with, a complex type that + // contains information about the dimensions for the metric. For information, see + // Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference + // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html) + // in the Amazon CloudWatch User Guide. + Dimensions []*Dimension } // A complex type that lists the name servers in a delegation set, as well as the @@ -526,11 +526,6 @@ type Dimension struct { // A complex type that contains information about a geographic location. type GeoLocation struct { - // For geolocation resource record sets, the two-letter code for a country. Amazon - // Route 53 uses the two-letter country codes that are specified in ISO standard - // 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). - CountryCode *string - // The two-letter code for the continent. Amazon Route 53 supports the following // continent codes: // @@ -554,6 +549,11 @@ type GeoLocation struct { // SubdivisionCode returns an InvalidInput error. ContinentCode *string + // For geolocation resource record sets, the two-letter code for a country. Amazon + // Route 53 uses the two-letter country codes that are specified in ISO standard + // 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). + CountryCode *string + // For geolocation resource record sets, the two-letter code for a state of the // United States. Route 53 doesn't support any other values for SubdivisionCode. // For a list of state abbreviations, see Appendix B: Two–Letter State and @@ -567,59 +567,59 @@ type GeoLocation struct { // subdivision names for the specified geolocation code. type GeoLocationDetails struct { - // The name of the country. - CountryName *string + // The two-letter code for the continent. + ContinentCode *string // The full name of the continent. ContinentName *string - // The full name of the subdivision. Route 53 currently supports only states in the - // United States. - SubdivisionName *string + // The two-letter code for the country. + CountryCode *string + + // The name of the country. + CountryName *string // The code for the subdivision. Route 53 currently supports only states in the // United States. SubdivisionCode *string - // The two-letter code for the continent. - ContinentCode *string - - // The two-letter code for the country. - CountryCode *string + // The full name of the subdivision. Route 53 currently supports only states in the + // United States. + SubdivisionName *string } // A complex type that contains information about one health check that is // associated with the current AWS account. type HealthCheck struct { - // The identifier that Amazon Route 53assigned to the health check when you created - // it. When you add or update a resource record set, you use this value to specify - // which health check to use. The value can be up to 64 characters long. + // A unique string that you specified when you created the health check. // // This member is required. - Id *string + CallerReference *string // A complex type that contains detailed information about one health check. // // This member is required. HealthCheckConfig *HealthCheckConfig - // A complex type that contains information about the CloudWatch alarm that Amazon - // Route 53 is monitoring for this health check. - CloudWatchAlarmConfiguration *CloudWatchAlarmConfiguration - - // A unique string that you specified when you created the health check. - // - // This member is required. - CallerReference *string - // The version of the health check. You can optionally pass this value in a call to // UpdateHealthCheck to prevent overwriting another change to the health check. // // This member is required. HealthCheckVersion *int64 - // If the health check was created by another service, the service that created the + // The identifier that Amazon Route 53assigned to the health check when you created + // it. When you add or update a resource record set, you use this value to specify + // which health check to use. The value can be up to 64 characters long. + // + // This member is required. + Id *string + + // A complex type that contains information about the CloudWatch alarm that Amazon + // Route 53 is monitoring for this health check. + CloudWatchAlarmConfiguration *CloudWatchAlarmConfiguration + + // If the health check was created by another service, the service that created the // health check. When a health check is created by another service, you can't edit // or delete it using Amazon Route 53. LinkedService *LinkedService @@ -628,26 +628,6 @@ type HealthCheck struct { // A complex type that contains information about the health check. type HealthCheckConfig struct { - // The number of child health checks that are associated with a CALCULATED health - // check that Amazon Route 53 must consider healthy for the CALCULATED health check - // to be considered healthy. To specify the child health checks that you want to - // associate with a CALCULATED health check, use the ChildHealthChecks - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-ChildHealthChecks) - // element. Note the following: - // - // * If you specify a number greater than the - // number of child health checks, Route 53 always considers this health check to be - // unhealthy. - // - // * If you specify 0, Route 53 always considers this health check - // to be healthy. - HealthThreshold *int32 - - // A complex type that identifies the CloudWatch alarm that you want Amazon Route - // 53 health checkers to use to determine whether the specified health check is - // healthy. - AlarmIdentifier *AlarmIdentifier - // The type of health check that you want to create, which indicates how Amazon // Route 53 determines whether an endpoint is healthy. You can't change the value // of Type after you create a health check. You can create the following types of @@ -696,44 +676,15 @@ type HealthCheckConfig struct { // This member is required. Type HealthCheckType - // The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to - // perform health checks on. If you don't specify a value for IPAddress, Route 53 - // sends a DNS request to resolve the domain name that you specify in - // FullyQualifiedDomainName at the interval that you specify in RequestInterval. - // Using an IP address returned by DNS, Route 53 then checks the health of the - // endpoint.

    Use one of the following formats for the value of - // IPAddress:

    If the endpoint is - // an EC2 instance, we recommend that you create an Elastic IP address, associate - // it with your EC2 instance, and specify the Elastic IP address for - // IPAddress. This ensures that the IP address of your instance will - // never change.

    For more information, see FullyQualifiedDomainName. - //

    Constraints: Route 53 can't check the health of endpoints for which the - // IP address is in local, private, non-routable, or multicast ranges. For more - // information about IP addresses for which you can't create health checks, see the - // following documents:

    When the value of Type is - // CALCULATED or CLOUDWATCH_METRIC, omit - // IPAddress.

    - IPAddress *string + // A complex type that identifies the CloudWatch alarm that you want Amazon Route + // 53 health checkers to use to determine whether the specified health check is + // healthy. + AlarmIdentifier *AlarmIdentifier - // The path, if any, that you want Amazon Route 53 to request when performing - // health checks. The path can be any value for which your endpoint will return an - // HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the - // file /docs/route53-health-check.html. You can also include query string - // parameters, for example, /welcome.html?language=jp&login=y. - ResourcePath *string + // (CALCULATED Health Checks Only) A complex type that contains one + // ChildHealthCheck element for each health check that you want to associate with a + // CALCULATED health check. + ChildHealthChecks []*string // Stops Route 53 from performing health checks. When you disable a health check, // here's what happens: @@ -778,6 +729,15 @@ type HealthCheckConfig struct { // client_hello message. EnableSNI *bool + // The number of consecutive health checks that an endpoint must pass or fail for + // Amazon Route 53 to change the current status of the endpoint from unhealthy to + // healthy or vice versa. For more information, see How Amazon Route 53 Determines + // Whether an Endpoint Is Healthy + // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) + // in the Amazon Route 53 Developer Guide. If you don't specify a value for + // FailureThreshold, the default value is three health checks. + FailureThreshold *int32 + // Amazon Route 53 behavior depends on whether you specify a value for IPAddress. //

    If you specify a value for IPAddress:

    Amazon // Route 53 sends health check requests to the specified IPv4 or IPv6 address and @@ -828,17 +788,52 @@ type HealthCheckConfig struct { // header.

    FullyQualifiedDomainName *string - // The number of seconds between the time that Amazon Route 53 gets a response from - // your endpoint and the time that it sends the next health check request. Each - // Route 53 health checker makes requests at this interval. You can't change the - // value of RequestInterval after you create a health check. If you don't specify a - // value for RequestInterval, the default value is 30 seconds. - RequestInterval *int32 + // The number of child health checks that are associated with a CALCULATED health + // check that Amazon Route 53 must consider healthy for the CALCULATED health check + // to be considered healthy. To specify the child health checks that you want to + // associate with a CALCULATED health check, use the ChildHealthChecks + // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-ChildHealthChecks) + // element. Note the following: + // + // * If you specify a number greater than the + // number of child health checks, Route 53 always considers this health check to be + // unhealthy. + // + // * If you specify 0, Route 53 always considers this health check + // to be healthy. + HealthThreshold *int32 - // Specify whether you want Amazon Route 53 to invert the status of a health check, - // for example, to consider a health check unhealthy when it otherwise would be - // considered healthy. - Inverted *bool + // The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to + // perform health checks on. If you don't specify a value for IPAddress, Route 53 + // sends a DNS request to resolve the domain name that you specify in + // FullyQualifiedDomainName at the interval that you specify in RequestInterval. + // Using an IP address returned by DNS, Route 53 then checks the health of the + // endpoint.

    Use one of the following formats for the value of + // IPAddress:

    If the endpoint is + // an EC2 instance, we recommend that you create an Elastic IP address, associate + // it with your EC2 instance, and specify the Elastic IP address for + // IPAddress. This ensures that the IP address of your instance will + // never change.

    For more information, see FullyQualifiedDomainName. + //

    Constraints: Route 53 can't check the health of endpoints for which the + // IP address is in local, private, non-routable, or multicast ranges. For more + // information about IP addresses for which you can't create health checks, see the + // following documents:

    When the value of Type is + // CALCULATED or CLOUDWATCH_METRIC, omit + // IPAddress.

    + IPAddress *string // When CloudWatch has insufficient data about the metric to determine the alarm // state, the status that you want Amazon Route 53 to assign to the health check: @@ -855,21 +850,21 @@ type HealthCheckConfig struct { // have no last known status, the default status for the health check is healthy. InsufficientDataHealthStatus InsufficientDataHealthStatus - // The number of consecutive health checks that an endpoint must pass or fail for - // Amazon Route 53 to change the current status of the endpoint from unhealthy to - // healthy or vice versa. For more information, see How Amazon Route 53 Determines - // Whether an Endpoint Is Healthy - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) - // in the Amazon Route 53 Developer Guide. If you don't specify a value for - // FailureThreshold, the default value is three health checks. - FailureThreshold *int32 + // Specify whether you want Amazon Route 53 to invert the status of a health check, + // for example, to consider a health check unhealthy when it otherwise would be + // considered healthy. + Inverted *bool - // If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you - // want Amazon Route 53 to search for in the response body from the specified - // resource. If the string appears in the response body, Route 53 considers the - // resource healthy. Route 53 considers case when searching for SearchString in the - // response body. - SearchString *string + // Specify whether you want Amazon Route 53 to measure the latency between health + // checkers in multiple AWS regions and your endpoint, and to display CloudWatch + // latency graphs on the Health Checks page in the Route 53 console. You can't + // change the value of MeasureLatency after you create a health check. + MeasureLatency *bool + + // The port on the endpoint that you want Amazon Route 53 to perform health checks + // on. Don't specify a value for Port when you specify a value for Type of + // CLOUDWATCH_METRIC or CALCULATED. + Port *int32 // A complex type that contains one Region element for each region from which you // want Amazon Route 53 health checkers to check the specified endpoint. If you @@ -881,27 +876,36 @@ type HealthCheckConfig struct { // three regions with four different regions). Regions []HealthCheckRegion - // Specify whether you want Amazon Route 53 to measure the latency between health - // checkers in multiple AWS regions and your endpoint, and to display CloudWatch - // latency graphs on the Health Checks page in the Route 53 console. You can't - // change the value of MeasureLatency after you create a health check. - MeasureLatency *bool + // The number of seconds between the time that Amazon Route 53 gets a response from + // your endpoint and the time that it sends the next health check request. Each + // Route 53 health checker makes requests at this interval. You can't change the + // value of RequestInterval after you create a health check. If you don't specify a + // value for RequestInterval, the default value is 30 seconds. + RequestInterval *int32 - // The port on the endpoint that you want Amazon Route 53 to perform health checks - // on. Don't specify a value for Port when you specify a value for Type of - // CLOUDWATCH_METRIC or CALCULATED. - Port *int32 + // The path, if any, that you want Amazon Route 53 to request when performing + // health checks. The path can be any value for which your endpoint will return an + // HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the + // file /docs/route53-health-check.html. You can also include query string + // parameters, for example, /welcome.html?language=jp&login=y. + ResourcePath *string - // (CALCULATED Health Checks Only) A complex type that contains one - // ChildHealthCheck element for each health check that you want to associate with a - // CALCULATED health check. - ChildHealthChecks []*string + // If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you + // want Amazon Route 53 to search for in the response body from the specified + // resource. If the string appears in the response body, Route 53 considers the + // resource healthy. Route 53 considers case when searching for SearchString in the + // response body. + SearchString *string } // A complex type that contains the last failure reason as reported by one Amazon // Route 53 health checker. type HealthCheckObservation struct { + // The IP address of the Amazon Route 53 health checker that provided the failure + // reason in StatusReport. + IPAddress *string + // The region of the Amazon Route 53 health checker that provided the status in // StatusReport. Region HealthCheckRegion @@ -909,17 +913,21 @@ type HealthCheckObservation struct { // A complex type that contains the last failure reason as reported by one Amazon // Route 53 health checker and the time of the failed health check. StatusReport *StatusReport - - // The IP address of the Amazon Route 53 health checker that provided the failure - // reason in StatusReport. - IPAddress *string } // A complex type that contains general information about the hosted zone. type HostedZone struct { - // The number of resource record sets in the hosted zone. - ResourceRecordSetCount *int64 + // The value that you specified for CallerReference when you created the hosted + // zone. + // + // This member is required. + CallerReference *string + + // The ID that Amazon Route 53 assigned to the hosted zone when you created it. + // + // This member is required. + Id *string // The name of the domain. For public hosted zones, this is the name that you have // registered with your DNS registrar. For information about how to specify @@ -940,16 +948,8 @@ type HostedZone struct { // delete it using Route 53. LinkedService *LinkedService - // The value that you specified for CallerReference when you created the hosted - // zone. - // - // This member is required. - CallerReference *string - - // The ID that Amazon Route 53 assigned to the hosted zone when you created it. - // - // This member is required. - Id *string + // The number of resource record sets in the hosted zone. + ResourceRecordSetCount *int64 } // A complex type that contains an optional comment about your hosted zone. If you @@ -968,11 +968,6 @@ type HostedZoneConfig struct { // and the current value for that limit. type HostedZoneLimit struct { - // The current value for the limit that is specified by Type. - // - // This member is required. - Value *int64 - // The limit that you requested. Valid values include the following: // // * @@ -984,6 +979,11 @@ type HostedZoneLimit struct { // // This member is required. Type HostedZoneLimitType + + // The current value for the limit that is specified by Type. + // + // This member is required. + Value *int64 } // A complex type that identifies a hosted zone that a specified Amazon VPC is @@ -1012,12 +1012,6 @@ type HostedZoneOwner struct { // the hosted zone name and ID, and information about who owns the hosted zone. type HostedZoneSummary struct { - // The owner of a private hosted zone that the specified VPC is associated with. - // The owner can be either an AWS account or an AWS service. - // - // This member is required. - Owner *HostedZoneOwner - // The Route 53 hosted zone ID of a private hosted zone that the specified VPC is // associated with. // @@ -1028,6 +1022,12 @@ type HostedZoneSummary struct { // // This member is required. Name *string + + // The owner of a private hosted zone that the specified VPC is associated with. + // The owner can be either an AWS account or an AWS service. + // + // This member is required. + Owner *HostedZoneOwner } // If a health check or hosted zone was created by another service, LinkedService @@ -1051,21 +1051,21 @@ type LinkedService struct { // logging. type QueryLoggingConfig struct { - // The ID for a configuration for DNS query logging. - // + // The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon + // Route 53 is publishing logs to. + // // This member is required. - Id *string + CloudWatchLogsLogGroupArn *string // The ID of the hosted zone that CloudWatch Logs is logging queries for. // // This member is required. HostedZoneId *string - // The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon - // Route 53 is publishing logs to. + // The ID for a configuration for DNS query logging. // // This member is required. - CloudWatchLogsLogGroupArn *string + Id *string } // Information specific to the resource record. If you're creating an alias @@ -1088,16 +1088,87 @@ type ResourceRecord struct { // Information about the resource record set to create or delete. type ResourceRecordSet struct { - // Resource record sets that have a routing policy other than simple: An identifier - // that differentiates among multiple resource record sets that have the same - // combination of name and type, such as multiple weighted resource record sets - // named acme.example.com that have a type of A. In a group of resource record sets - // that have the same name and type, the value of SetIdentifier must be unique for - // each resource record set. For information about routing policies, see Choosing a - // Routing Policy - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html) - // in the Amazon Route 53 Developer Guide. - SetIdentifier *string + // For ChangeResourceRecordSets requests, the name of the record that you want to + // create, update, or delete. For ListResourceRecordSets responses, the name of a + // record in the specified hosted zone.

    ChangeResourceRecordSets Only + //

    Enter a fully qualified domain name, for example, + // www.example.com. You can optionally include a trailing dot. If you + // omit the trailing dot, Amazon Route 53 assumes that the domain name that you + // specify is fully qualified. This means that Route 53 treats + // www.example.com (without a trailing dot) and + // www.example.com. (with a trailing dot) as identical.

    For + // information about how to specify characters other than a-z, + // 0-9, and - (hyphen) and how to specify + // internationalized domain names, see DNS + // Domain Name Format in the Amazon Route 53 Developer Guide.

    You + // can use the asterisk (*) wildcard to replace the leftmost label in a domain + // name, for example, *.example.com. Note the following:

    + //

    You can use the * wildcard as the leftmost label in a domain name, for + // example, *.example.com. You can't use an * for one of the middle + // labels, for example, marketing.*.example.com. In addition, the * + // must replace the entire label; for example, you can't specify + // prod*.example.com.

    + // + // This member is required. + Name *string + + // The DNS record type. For information about different record types and how data + // is encoded for them, see Supported DNS Resource Record Types + // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html) + // in the Amazon Route 53 Developer Guide. Valid values for basic resource record + // sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT + // Values for weighted, latency, geolocation, and failover resource record sets: A + // | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT. When creating a group + // of weighted, latency, geolocation, or failover resource record sets, specify the + // same value for all of the resource record sets in the group. Valid values for + // multivalue answer resource record sets: A | AAAA | MX | NAPTR | PTR | SPF | SRV + // | TXT SPF records were formerly used to verify the identity of the sender of + // email messages. However, we no longer recommend that you create resource record + // sets for which the value of Type is SPF. RFC 7208, Sender Policy Framework (SPF) + // for Authorizing Use of Domains in Email, Version 1, has been updated to say, + // "...[I]ts existence and mechanism defined in [RFC4408] have led to some + // interoperability issues. Accordingly, its use is no longer appropriate for SPF + // version 1; implementations are not to use it." In RFC 7208, see section 14.1, + // The SPF DNS Record Type (http://tools.ietf.org/html/rfc7208#section-14.1). + // Values for alias resource record sets: + // + // * Amazon API Gateway custom regional + // APIs and edge-optimized APIs: A + // + // * CloudFront distributions: A If IPv6 is + // enabled for the distribution, create two resource record sets to route traffic + // to your distribution, one with a value of A and one with a value of AAAA. + // + // * + // Amazon API Gateway environment that has a regionalized subdomain: A + // + // * ELB + // load balancers: A | AAAA + // + // * Amazon S3 buckets: A + // + // * Amazon Virtual + // Private Cloud interface VPC endpoints A + // + // * Another resource record set in + // this hosted zone: Specify the type of the resource record set that you're + // creating the alias for. All values are supported except NS and SOA. If you're + // creating an alias record that has the same name as the hosted zone (known as the + // zone apex), you can't route traffic to a record for which the value of Type is + // CNAME. This is because the alias record must have the same type as the record + // you're routing traffic to, and creating a CNAME record for the zone apex isn't + // supported even for an alias record. + // + // This member is required. + Type RRType // Alias resource record sets only: Information about the AWS resource, such as a // CloudFront distribution or an Amazon S3 bucket, that you want to route traffic @@ -1118,39 +1189,77 @@ type ResourceRecordSet struct { // in the Amazon Route 53 Developer Guide. AliasTarget *AliasTarget - // Weighted resource record sets only: Among resource record sets that have the - // same combination of DNS name and type, a value that determines the proportion of - // DNS queries that Amazon Route 53 responds to using the current resource record - // set. Route 53 calculates the sum of the weights for the resource record sets - // that have the same combination of DNS name and type. Route 53 then responds to - // queries based on the ratio of a resource's weight to the total. Note the - // following: + // Failover resource record sets only: To configure failover, you add the Failover + // element to two resource record sets. For one resource record set, you specify + // PRIMARY as the value for Failover; for the other resource record set, you + // specify SECONDARY. In addition, you include the HealthCheckId element and + // specify the health check that you want Amazon Route 53 to perform for each + // resource record set. Except where noted, the following failover behaviors assume + // that you have included the HealthCheckId element in both resource record sets: // - // * You must specify a value for the Weight element for every - // weighted resource record set. // - // * You can only specify one ResourceRecord per - // weighted resource record set. + // * When the primary resource record set is healthy, Route 53 responds to DNS + // queries with the applicable value from the primary resource record set + // regardless of the health of the secondary resource record set. // - // * You can't create latency, failover, or - // geolocation resource record sets that have the same values for the Name and Type - // elements as weighted resource record sets. + // * When the + // primary resource record set is unhealthy and the secondary resource record set + // is healthy, Route 53 responds to DNS queries with the applicable value from the + // secondary resource record set. // - // * You can create a maximum of - // 100 weighted resource record sets that have the same values for the Name and - // Type elements. + // * When the secondary resource record set is + // unhealthy, Route 53 responds to DNS queries with the applicable value from the + // primary resource record set regardless of the health of the primary resource + // record set. // - // * For weighted (but not weighted alias) resource record - // sets, if you set Weight to 0 for a resource record set, Route 53 never responds - // to queries with the applicable value for that resource record set. However, if - // you set Weight to 0 for all resource record sets that have the same combination - // of DNS name and type, traffic is routed to all resources with equal probability. - // The effect of setting Weight to 0 is different when you associate health checks - // with weighted resource record sets. For more information, see Options for - // Configuring Route 53 Active-Active and Active-Passive Failover - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html) - // in the Amazon Route 53 Developer Guide. - Weight *int64 + // * If you omit the HealthCheckId element for the secondary + // resource record set, and if the primary resource record set is unhealthy, Route + // 53 always responds to DNS queries with the applicable value from the secondary + // resource record set. This is true regardless of the health of the associated + // endpoint. + // + // You can't create non-failover resource record sets that have the same + // values for the Name and Type elements as failover resource record sets. For + // failover alias resource record sets, you must also include the + // EvaluateTargetHealth element and set the value to true. For more information + // about configuring failover for Route 53, see the following topics in the Amazon + // Route 53 Developer Guide: + // + // * Route 53 Health Checks and DNS Failover + // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) + // + // + // * Configuring Failover in a Private Hosted Zone + // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) + Failover ResourceRecordSetFailover + + // Geolocation resource record sets only: A complex type that lets you control how + // Amazon Route 53 responds to DNS queries based on the geographic origin of the + // query. For example, if you want all queries from Africa to be routed to a web + // server with an IP address of 192.0.2.111, create a resource record set with a + // Type of A and a ContinentCode of AF. Although creating geolocation and + // geolocation alias resource record sets in a private hosted zone is allowed, it's + // not supported. If you create separate resource record sets for overlapping + // geographic regions (for example, one resource record set for a continent and one + // for a country on the same continent), priority goes to the smallest geographic + // region. This allows you to route most queries for a continent to one resource + // and to route queries for a country on that continent to a different resource. + // You can't create two geolocation resource record sets that specify the same + // geographic location. The value * in the CountryCode element matches all + // geographic locations that aren't specified in other geolocation resource record + // sets that have the same values for the Name and Type elements. Geolocation works + // by mapping IP addresses to locations. However, some IP addresses aren't mapped + // to geographic locations, so even if you create geolocation resource record sets + // that cover all seven continents, Route 53 will receive some DNS queries from + // locations that it can't identify. We recommend that you create a resource record + // set for which the value of CountryCode is *. Two groups of queries are routed to + // the resource that you specify in this record: queries that come from locations + // for which you haven't created geolocation resource record sets and queries from + // IP addresses that aren't mapped to a location. If you don't create a * resource + // record set, Route 53 returns a "no answer" response for queries from those + // locations. You can't create non-geolocation resource record sets that have the + // same values for the Name and Type elements as geolocation resource record sets. + GeoLocation *GeoLocation // If you want Amazon Route 53 to return this resource record set in response to a // DNS query only when the status of a health check is healthy, include the @@ -1212,207 +1321,30 @@ type ResourceRecordSet struct { // record set.

    The alias resource record set can also route traffic // to a group of non-alias resource record sets that have the same routing // policy, name, and type. In that configuration, associate health checks with all - // of the resource record sets in the group of non-alias resource record sets.

    - //

    Geolocation Routing

    For geolocation - // resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource - // record set for the larger, associated geographic region. For example, suppose - // you have resource record sets for a state in the United States, for the entire - // United States, for North America, and a resource record set that has - // * for CountryCode is *, which applies to - // all locations. If the endpoint for the state resource record set is unhealthy, - // Route 53 checks for healthy resource record sets in the following order until it - // finds a resource record set for which the endpoint is healthy:

    Specifying the Health Check - // Endpoint by Domain Name

    If your health checks specify the endpoint - // only by domain name, we recommend that you create a separate health check for - // each endpoint. For example, create a health check for each HTTP - // server that is serving content for www.example.com. For the value - // of FullyQualifiedDomainName, specify the domain name of the server - // (such as us-east-2-www.example.com), not the name of the resource - // record sets (www.example.com).

    Health check - // results will be unpredictable if you do the following:

    • Create a - // health check that has the same value for FullyQualifiedDomainName - // as the name of a resource record set.

    • Associate that health - // check with the resource record set.

     - HealthCheckId *string - - // Latency-based resource record sets only: The Amazon EC2 Region where you created - // the resource that this resource record set refers to. The resource typically is - // an AWS resource, such as an EC2 instance or an ELB load balancer, and is - // referred to by an IP address or a DNS domain name, depending on the record type. - // Although creating latency and latency alias resource record sets in a private - // hosted zone is allowed, it's not supported. When Amazon Route 53 receives a DNS - // query for a domain name and type for which you have created latency resource - // record sets, Route 53 selects the latency resource record set that has the - // lowest latency between the end user and the associated Amazon EC2 Region. Route - // 53 then returns the value that is associated with the selected resource record - // set. Note the following: - // - // * You can only specify one ResourceRecord per - // latency resource record set. - // - // * You can only create one latency resource - // record set for each Amazon EC2 Region. - // - // * You aren't required to create - // latency resource record sets for all Amazon EC2 Regions. Route 53 will choose - // the region with the best latency from among the regions that you create latency - // resource record sets for. - // - // * You can't create non-latency resource record - // sets that have the same values for the Name and Type elements as latency - // resource record sets. - Region ResourceRecordSetRegion - - // Geolocation resource record sets only: A complex type that lets you control how - // Amazon Route 53 responds to DNS queries based on the geographic origin of the - // query. For example, if you want all queries from Africa to be routed to a web - // server with an IP address of 192.0.2.111, create a resource record set with a - // Type of A and a ContinentCode of AF. Although creating geolocation and - // geolocation alias resource record sets in a private hosted zone is allowed, it's - // not supported. If you create separate resource record sets for overlapping - // geographic regions (for example, one resource record set for a continent and one - // for a country on the same continent), priority goes to the smallest geographic - // region. This allows you to route most queries for a continent to one resource - // and to route queries for a country on that continent to a different resource. - // You can't create two geolocation resource record sets that specify the same - // geographic location. The value * in the CountryCode element matches all - // geographic locations that aren't specified in other geolocation resource record - // sets that have the same values for the Name and Type elements. Geolocation works - // by mapping IP addresses to locations. However, some IP addresses aren't mapped - // to geographic locations, so even if you create geolocation resource record sets - // that cover all seven continents, Route 53 will receive some DNS queries from - // locations that it can't identify. We recommend that you create a resource record - // set for which the value of CountryCode is *. Two groups of queries are routed to - // the resource that you specify in this record: queries that come from locations - // for which you haven't created geolocation resource record sets and queries from - // IP addresses that aren't mapped to a location. If you don't create a * resource - // record set, Route 53 returns a "no answer" response for queries from those - // locations. You can't create non-geolocation resource record sets that have the - // same values for the Name and Type elements as geolocation resource record sets. - GeoLocation *GeoLocation - - // Information about the resource records to act upon. If you're creating an alias - // resource record set, omit ResourceRecords. - ResourceRecords []*ResourceRecord - - // Failover resource record sets only: To configure failover, you add the Failover - // element to two resource record sets. For one resource record set, you specify - // PRIMARY as the value for Failover; for the other resource record set, you - // specify SECONDARY. In addition, you include the HealthCheckId element and - // specify the health check that you want Amazon Route 53 to perform for each - // resource record set. Except where noted, the following failover behaviors assume - // that you have included the HealthCheckId element in both resource record sets: - // - // - // * When the primary resource record set is healthy, Route 53 responds to DNS - // queries with the applicable value from the primary resource record set - // regardless of the health of the secondary resource record set. - // - // * When the - // primary resource record set is unhealthy and the secondary resource record set - // is healthy, Route 53 responds to DNS queries with the applicable value from the - // secondary resource record set. - // - // * When the secondary resource record set is - // unhealthy, Route 53 responds to DNS queries with the applicable value from the - // primary resource record set regardless of the health of the primary resource - // record set. - // - // * If you omit the HealthCheckId element for the secondary - // resource record set, and if the primary resource record set is unhealthy, Route - // 53 always responds to DNS queries with the applicable value from the secondary - // resource record set. This is true regardless of the health of the associated - // endpoint. - // - // You can't create non-failover resource record sets that have the same - // values for the Name and Type elements as failover resource record sets. For - // failover alias resource record sets, you must also include the - // EvaluateTargetHealth element and set the value to true. For more information - // about configuring failover for Route 53, see the following topics in the Amazon - // Route 53 Developer Guide: - // - // * Route 53 Health Checks and DNS Failover - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) - // - // - // * Configuring Failover in a Private Hosted Zone - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) - Failover ResourceRecordSetFailover - - // The DNS record type. For information about different record types and how data - // is encoded for them, see Supported DNS Resource Record Types - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html) - // in the Amazon Route 53 Developer Guide. Valid values for basic resource record - // sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT - // Values for weighted, latency, geolocation, and failover resource record sets: A - // | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT. When creating a group - // of weighted, latency, geolocation, or failover resource record sets, specify the - // same value for all of the resource record sets in the group. Valid values for - // multivalue answer resource record sets: A | AAAA | MX | NAPTR | PTR | SPF | SRV - // | TXT SPF records were formerly used to verify the identity of the sender of - // email messages. However, we no longer recommend that you create resource record - // sets for which the value of Type is SPF. RFC 7208, Sender Policy Framework (SPF) - // for Authorizing Use of Domains in Email, Version 1, has been updated to say, - // "...[I]ts existence and mechanism defined in [RFC4408] have led to some - // interoperability issues. Accordingly, its use is no longer appropriate for SPF - // version 1; implementations are not to use it." In RFC 7208, see section 14.1, - // The SPF DNS Record Type (http://tools.ietf.org/html/rfc7208#section-14.1). - // Values for alias resource record sets: - // - // * Amazon API Gateway custom regional - // APIs and edge-optimized APIs: A - // - // * CloudFront distributions: A If IPv6 is - // enabled for the distribution, create two resource record sets to route traffic - // to your distribution, one with a value of A and one with a value of AAAA. - // - // * - // Amazon API Gateway environment that has a regionalized subdomain: A - // - // * ELB - // load balancers: A | AAAA - // - // * Amazon S3 buckets: A - // - // * Amazon Virtual - // Private Cloud interface VPC endpoints A - // - // * Another resource record set in - // this hosted zone: Specify the type of the resource record set that you're - // creating the alias for. All values are supported except NS and SOA. If you're - // creating an alias record that has the same name as the hosted zone (known as the - // zone apex), you can't route traffic to a record for which the value of Type is - // CNAME. This is because the alias record must have the same type as the record - // you're routing traffic to, and creating a CNAME record for the zone apex isn't - // supported even for an alias record. - // - // This member is required. - Type RRType - - // The resource record cache time to live (TTL), in seconds. Note the following: - // - // - // * If you're creating or updating an alias resource record set, omit TTL. Amazon - // Route 53 uses the value of TTL for the alias target. - // - // * If you're - // associating this resource record set with a health check (if you're adding a - // HealthCheckId element), we recommend that you specify a TTL of 60 seconds or - // less so clients respond quickly to changes in health status. - // - // * All of the - // resource record sets in a group of weighted resource record sets must have the - // same value for TTL. - // - // * If a group of weighted resource record sets includes - // one or more weighted alias resource record sets for which the alias target is an - // ELB load balancer, we recommend that you specify a TTL of 60 seconds for all of - // the non-alias weighted resource record sets that have the same name and type. - // Values other than 60 seconds (the TTL for load balancers) will change the effect - // of the values that you specify for Weight. - TTL *int64 + // of the resource record sets in the group of non-alias resource record sets.

    + //

    Geolocation Routing

    For geolocation + // resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource + // record set for the larger, associated geographic region. For example, suppose + // you have resource record sets for a state in the United States, for the entire + // United States, for North America, and a resource record set that has + // * for CountryCode is *, which applies to + // all locations. If the endpoint for the state resource record set is unhealthy, + // Route 53 checks for healthy resource record sets in the following order until it + // finds a resource record set for which the endpoint is healthy:

    Specifying the Health Check + // Endpoint by Domain Name

    If your health checks specify the endpoint + // only by domain name, we recommend that you create a separate health check for + // each endpoint. For example, create a health check for each HTTP + // server that is serving content for www.example.com. For the value + // of FullyQualifiedDomainName, specify the domain name of the server + // (such as us-east-2-www.example.com), not the name of the resource + // record sets (www.example.com).

    Health check + // results will be unpredictable if you do the following:

     + HealthCheckId *string // Multivalue answer resource record sets only: To route traffic approximately // randomly to multiple resources, such as web servers, create one multivalue @@ -1446,37 +1378,71 @@ type ResourceRecordSet struct { // You can't create multivalue answer alias records. MultiValueAnswer *bool - // For ChangeResourceRecordSets requests, the name of the record that you want to - // create, update, or delete. For ListResourceRecordSets responses, the name of a - // record in the specified hosted zone.

    ChangeResourceRecordSets Only - //

    Enter a fully qualified domain name, for example, - // www.example.com. You can optionally include a trailing dot. If you - // omit the trailing dot, Amazon Route 53 assumes that the domain name that you - // specify is fully qualified. This means that Route 53 treats - // www.example.com (without a trailing dot) and - // www.example.com. (with a trailing dot) as identical.

    For - // information about how to specify characters other than a-z, - // 0-9, and - (hyphen) and how to specify - // internationalized domain names, see DNS - // Domain Name Format in the Amazon Route 53 Developer Guide.

    You - // can use the asterisk (*) wildcard to replace the leftmost label in a domain - // name, for example, *.example.com. Note the following:

    - //

    You can use the * wildcard as the leftmost label in a domain name, for - // example, *.example.com. You can't use an * for one of the middle - // labels, for example, marketing.*.example.com. In addition, the * - // must replace the entire label; for example, you can't specify - // prod*.example.com.

    + // Latency-based resource record sets only: The Amazon EC2 Region where you created + // the resource that this resource record set refers to. The resource typically is + // an AWS resource, such as an EC2 instance or an ELB load balancer, and is + // referred to by an IP address or a DNS domain name, depending on the record type. + // Although creating latency and latency alias resource record sets in a private + // hosted zone is allowed, it's not supported. When Amazon Route 53 receives a DNS + // query for a domain name and type for which you have created latency resource + // record sets, Route 53 selects the latency resource record set that has the + // lowest latency between the end user and the associated Amazon EC2 Region. Route + // 53 then returns the value that is associated with the selected resource record + // set. Note the following: // - // This member is required. - Name *string + // * You can only specify one ResourceRecord per + // latency resource record set. + // + // * You can only create one latency resource + // record set for each Amazon EC2 Region. + // + // * You aren't required to create + // latency resource record sets for all Amazon EC2 Regions. Route 53 will choose + // the region with the best latency from among the regions that you create latency + // resource record sets for. + // + // * You can't create non-latency resource record + // sets that have the same values for the Name and Type elements as latency + // resource record sets. + Region ResourceRecordSetRegion + + // Information about the resource records to act upon. If you're creating an alias + // resource record set, omit ResourceRecords. + ResourceRecords []*ResourceRecord + + // Resource record sets that have a routing policy other than simple: An identifier + // that differentiates among multiple resource record sets that have the same + // combination of name and type, such as multiple weighted resource record sets + // named acme.example.com that have a type of A. In a group of resource record sets + // that have the same name and type, the value of SetIdentifier must be unique for + // each resource record set. For information about routing policies, see Choosing a + // Routing Policy + // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html) + // in the Amazon Route 53 Developer Guide. + SetIdentifier *string + + // The resource record cache time to live (TTL), in seconds. Note the following: + // + // + // * If you're creating or updating an alias resource record set, omit TTL. Amazon + // Route 53 uses the value of TTL for the alias target. + // + // * If you're + // associating this resource record set with a health check (if you're adding a + // HealthCheckId element), we recommend that you specify a TTL of 60 seconds or + // less so clients respond quickly to changes in health status. + // + // * All of the + // resource record sets in a group of weighted resource record sets must have the + // same value for TTL. + // + // * If a group of weighted resource record sets includes + // one or more weighted alias resource record sets for which the alias target is an + // ELB load balancer, we recommend that you specify a TTL of 60 seconds for all of + // the non-alias weighted resource record sets that have the same name and type. + // Values other than 60 seconds (the TTL for load balancers) will change the effect + // of the values that you specify for Weight. + TTL *int64 // When you create a traffic policy instance, Amazon Route 53 automatically creates // a resource record set. TrafficPolicyInstanceId is the ID of the traffic policy @@ -1488,14 +1454,45 @@ type ResourceRecordSet struct { // policy instance, and you'll continue to be charged for it even though it's no // longer in use. TrafficPolicyInstanceId *string + + // Weighted resource record sets only: Among resource record sets that have the + // same combination of DNS name and type, a value that determines the proportion of + // DNS queries that Amazon Route 53 responds to using the current resource record + // set. Route 53 calculates the sum of the weights for the resource record sets + // that have the same combination of DNS name and type. Route 53 then responds to + // queries based on the ratio of a resource's weight to the total. Note the + // following: + // + // * You must specify a value for the Weight element for every + // weighted resource record set. + // + // * You can only specify one ResourceRecord per + // weighted resource record set. + // + // * You can't create latency, failover, or + // geolocation resource record sets that have the same values for the Name and Type + // elements as weighted resource record sets. + // + // * You can create a maximum of + // 100 weighted resource record sets that have the same values for the Name and + // Type elements. + // + // * For weighted (but not weighted alias) resource record + // sets, if you set Weight to 0 for a resource record set, Route 53 never responds + // to queries with the applicable value for that resource record set. However, if + // you set Weight to 0 for all resource record sets that have the same combination + // of DNS name and type, traffic is routed to all resources with equal probability. + // The effect of setting Weight to 0 is different when you associate health checks + // with weighted resource record sets. For more information, see Options for + // Configuring Route 53 Active-Active and Active-Passive Failover + // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html) + // in the Amazon Route 53 Developer Guide. + Weight *int64 } // A complex type containing a resource and its associated tags. type ResourceTagSet struct { - // The tags associated with the specified resource. - Tags []*Tag - // The ID for the specified resource. ResourceId *string @@ -1506,6 +1503,9 @@ type ResourceTagSet struct { // // * The resource type for hosted zones is hostedzone. ResourceType TagResourceType + + // The tags associated with the specified resource. + Tags []*Tag } // A complex type that contains the type of limit that you specified in the request @@ -1575,27 +1575,29 @@ type Tag struct { // A complex type that contains settings for a traffic policy. type TrafficPolicy struct { - // The DNS type of the resource record sets that Amazon Route 53 creates when you - // use a traffic policy to create a traffic policy instance. + // The definition of a traffic policy in JSON format. You specify the JSON document + // to use for a new traffic policy in the CreateTrafficPolicy request. For more + // information about the JSON format, see Traffic Policy Document Format + // (https://docs.aws.amazon.com/Route53/latest/APIReference/api-policies-traffic-policy-document-format.html). // // This member is required. - Type RRType + Document *string - // The comment that you specify in the CreateTrafficPolicy request, if any. - Comment *string + // The ID that Amazon Route 53 assigned to a traffic policy when you created it. + // + // This member is required. + Id *string // The name that you specified when you created the traffic policy. // // This member is required. Name *string - // The definition of a traffic policy in JSON format. You specify the JSON document - // to use for a new traffic policy in the CreateTrafficPolicy request. For more - // information about the JSON format, see Traffic Policy Document Format - // (https://docs.aws.amazon.com/Route53/latest/APIReference/api-policies-traffic-policy-document-format.html). + // The DNS type of the resource record sets that Amazon Route 53 creates when you + // use a traffic policy to create a traffic policy instance. // // This member is required. - Document *string + Type RRType // The version number that Amazon Route 53 assigns to a traffic policy. For a new // traffic policy, the value of Version is always 1. @@ -1603,31 +1605,28 @@ type TrafficPolicy struct { // This member is required. Version *int32 - // The ID that Amazon Route 53 assigned to a traffic policy when you created it. - // - // This member is required. - Id *string + // The comment that you specify in the CreateTrafficPolicy request, if any. + Comment *string } // A complex type that contains settings for the new traffic policy instance. type TrafficPolicyInstance struct { - // The TTL that Amazon Route 53 assigned to all of the resource record sets that it - // created in the specified hosted zone. + // The ID of the hosted zone that Amazon Route 53 created resource record sets in. // // This member is required. - TTL *int64 + HostedZoneId *string // The ID that Amazon Route 53 assigned to the new traffic policy instance. // // This member is required. Id *string - // The version of the traffic policy that Amazon Route 53 used to create resource - // record sets in the specified hosted zone. + // If State is Failed, an explanation of the reason for the failure. If State is + // another value, Message is empty. // // This member is required. - TrafficPolicyVersion *int32 + Message *string // The DNS name, such as www.example.com, for which Amazon Route 53 responds to // queries by using the resource record sets that are associated with this traffic @@ -1636,11 +1635,22 @@ type TrafficPolicyInstance struct { // This member is required. Name *string - // If State is Failed, an explanation of the reason for the failure. If State is - // another value, Message is empty. + // The value of State is one of the following values: Applied Amazon Route 53 has + // finished creating resource record sets, and changes have propagated to all Route + // 53 edge locations. Creating Route 53 is creating the resource record sets. Use + // GetTrafficPolicyInstance to confirm that the CreateTrafficPolicyInstance request + // completed successfully. Failed Route 53 wasn't able to create or update the + // resource record sets. When the value of State is Failed, see Message for an + // explanation of what caused the request to fail. // // This member is required. - Message *string + State *string + + // The TTL that Amazon Route 53 assigned to all of the resource record sets that it + // created in the specified hosted zone. + // + // This member is required. + TTL *int64 // The ID of the traffic policy that Amazon Route 53 used to create resource record // sets in the specified hosted zone. @@ -1654,61 +1664,51 @@ type TrafficPolicyInstance struct { // This member is required. TrafficPolicyType RRType - // The value of State is one of the following values: Applied Amazon Route 53 has - // finished creating resource record sets, and changes have propagated to all Route - // 53 edge locations. Creating Route 53 is creating the resource record sets. Use - // GetTrafficPolicyInstance to confirm that the CreateTrafficPolicyInstance request - // completed successfully. Failed Route 53 wasn't able to create or update the - // resource record sets. When the value of State is Failed, see Message for an - // explanation of what caused the request to fail. - // - // This member is required. - State *string - - // The ID of the hosted zone that Amazon Route 53 created resource record sets in. + // The version of the traffic policy that Amazon Route 53 used to create resource + // record sets in the specified hosted zone. // // This member is required. - HostedZoneId *string + TrafficPolicyVersion *int32 } // A complex type that contains information about the latest version of one traffic // policy that is associated with the current AWS account. type TrafficPolicySummary struct { - // The name that you specified for the traffic policy when you created it. - // - // This member is required. - Name *string - - // The DNS type of the resource record sets that Amazon Route 53 creates when you - // use a traffic policy to create a traffic policy instance. + // The ID that Amazon Route 53 assigned to the traffic policy when you created it. // // This member is required. - Type RRType + Id *string // The version number of the latest version of the traffic policy. // // This member is required. LatestVersion *int32 - // The ID that Amazon Route 53 assigned to the traffic policy when you created it. + // The name that you specified for the traffic policy when you created it. // // This member is required. - Id *string + Name *string // The number of traffic policies that are associated with the current AWS account. // // This member is required. TrafficPolicyCount *int32 + + // The DNS type of the resource record sets that Amazon Route 53 creates when you + // use a traffic policy to create a traffic policy instance. + // + // This member is required. + Type RRType } // (Private hosted zones only) A complex type that contains information about an // Amazon VPC. type VPC struct { - // (Private hosted zones only) The region that an Amazon VPC was created in. - VPCRegion VPCRegion - // (Private hosted zones only) The ID of an Amazon VPC. VPCId *string + + // (Private hosted zones only) The region that an Amazon VPC was created in. + VPCRegion VPCRegion } diff --git a/service/route53domains/api_op_CheckDomainAvailability.go b/service/route53domains/api_op_CheckDomainAvailability.go index 42dd1b9c57d..d925937b243 100644 --- a/service/route53domains/api_op_CheckDomainAvailability.go +++ b/service/route53domains/api_op_CheckDomainAvailability.go @@ -60,9 +60,6 @@ func (c *Client) CheckDomainAvailability(ctx context.Context, params *CheckDomai // The CheckDomainAvailability request contains the following elements. type CheckDomainAvailabilityInput struct { - // Reserved for future use. - IdnLangCode *string - // The name of the domain that you want to get availability for. The top-level // domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of // supported TLDs, see Domains that You Can Register with Amazon Route 53 @@ -91,6 +88,9 @@ type CheckDomainAvailabilityInput struct { // // This member is required. DomainName *string + + // Reserved for future use. + IdnLangCode *string } // The CheckDomainAvailability response includes the following elements. diff --git a/service/route53domains/api_op_CheckDomainTransferability.go b/service/route53domains/api_op_CheckDomainTransferability.go index 2b541573d15..ffba3ba796c 100644 --- a/service/route53domains/api_op_CheckDomainTransferability.go +++ b/service/route53domains/api_op_CheckDomainTransferability.go @@ -58,11 +58,6 @@ func (c *Client) CheckDomainTransferability(ctx context.Context, params *CheckDo // The CheckDomainTransferability request contains the following elements. type CheckDomainTransferabilityInput struct { - // If the registrar for the top-level domain (TLD) requires an authorization code - // to transfer the domain, the code that you got from the current registrar for the - // domain. - AuthCode *string - // The name of the domain that you want to transfer to Route 53. The top-level // domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of // supported TLDs, see Domains that You Can Register with Amazon Route 53 @@ -83,6 +78,11 @@ type CheckDomainTransferabilityInput struct { // // This member is required. DomainName *string + + // If the registrar for the top-level domain (TLD) requires an authorization code + // to transfer the domain, the code that you got from the current registrar for the + // domain. + AuthCode *string } // The CheckDomainTransferability response includes the following elements. diff --git a/service/route53domains/api_op_DeleteTagsForDomain.go b/service/route53domains/api_op_DeleteTagsForDomain.go index cb623c367d6..0ecad960313 100644 --- a/service/route53domains/api_op_DeleteTagsForDomain.go +++ b/service/route53domains/api_op_DeleteTagsForDomain.go @@ -59,15 +59,15 @@ func (c *Client) DeleteTagsForDomain(ctx context.Context, params *DeleteTagsForD // The DeleteTagsForDomainRequest includes the following elements. type DeleteTagsForDomainInput struct { - // A list of tag keys to delete. + // The domain for which you want to delete one or more tags. // // This member is required. - TagsToDelete []*string + DomainName *string - // The domain for which you want to delete one or more tags. + // A list of tag keys to delete. // // This member is required. - DomainName *string + TagsToDelete []*string } type DeleteTagsForDomainOutput struct { diff --git a/service/route53domains/api_op_GetContactReachabilityStatus.go b/service/route53domains/api_op_GetContactReachabilityStatus.go index 26358aec072..0905dfe7f97 100644 --- a/service/route53domains/api_op_GetContactReachabilityStatus.go +++ b/service/route53domains/api_op_GetContactReachabilityStatus.go @@ -66,15 +66,15 @@ type GetContactReachabilityStatusInput struct { type GetContactReachabilityStatusOutput struct { + // The domain name for which you requested the reachability status. + DomainName *string + // Whether the registrant contact has responded. Values include the following: // PENDING We sent the confirmation email and haven't received a response yet. DONE // We sent the email and got confirmation from the registrant contact. EXPIRED The // time limit expired before the registrant contact responded. Status types.ReachabilityStatus - // The domain name for which you requested the reachability status. - DomainName *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/route53domains/api_op_GetDomainDetail.go b/service/route53domains/api_op_GetDomainDetail.go index bb2fdc4680d..7b69404dbb1 100644 --- a/service/route53domains/api_op_GetDomainDetail.go +++ b/service/route53domains/api_op_GetDomainDetail.go @@ -70,35 +70,38 @@ type GetDomainDetailInput struct { // The GetDomainDetail response includes the following elements. type GetDomainDetailOutput struct { - // Reseller of the domain. Domains registered or transferred using Route 53 domains - // will have "Amazon" as the reseller. - Reseller *string + // Provides details about the domain administrative contact. + // + // This member is required. + AdminContact *types.ContactDetail - // The last updated date of the domain as found in the response to a WHOIS query. - // The date and time is in Unix time format and Coordinated Universal time (UTC). - UpdatedDate *time.Time + // The name of a domain. + // + // This member is required. + DomainName *string + + // The name of the domain. + // + // This member is required. + Nameservers []*types.Nameserver // Provides details about the domain registrant. // // This member is required. RegistrantContact *types.ContactDetail - // Specifies whether contact information is concealed from WHOIS queries. If the - // value is true, WHOIS ("who is") queries return contact information either for - // Amazon Registrar (for .com, .net, and .org domains) or for our registrar - // associate, Gandi (for all other TLDs). If the value is false, WHOIS queries - // return the information that you entered for the technical contact. - TechPrivacy *bool - // Provides details about the domain technical contact. // // This member is required. TechContact *types.ContactDetail - // The name of a domain. - // - // This member is required. - DomainName *string + // Email address to contact to report incorrect contact information for a domain, + // to report that the domain is being used to send spam, to report that someone is + // cybersquatting on a domain name, or report some other type of abuse. + AbuseContactEmail *string + + // Phone number for reporting abuse. + AbuseContactPhone *string // Specifies whether contact information is concealed from WHOIS queries. If the // value is true, WHOIS ("who is") queries return contact information either for @@ -107,10 +110,8 @@ type GetDomainDetailOutput struct { // return the information that you entered for the admin contact. AdminPrivacy *bool - // Email address to contact to report incorrect contact information for a domain, - // to report that the domain is being used to send spam, to report that someone is - // cybersquatting on a domain name, or report some other type of abuse. - AbuseContactEmail *string + // Specifies whether the domain registration is set to renew automatically. + AutoRenew *bool // The date when the domain was created as found in the response to a WHOIS query. // The date and time is in Unix time format and Coordinated Universal time (UTC). @@ -119,20 +120,9 @@ type GetDomainDetailOutput struct { // Reserved for future use. DnsSec *string - // Specifies whether the domain registration is set to renew automatically. - AutoRenew *bool - - // Web address of the registrar. - RegistrarUrl *string - - // The fully qualified name of the WHOIS server that can answer the WHOIS query for - // the domain. - WhoIsServer *string - - // The name of the domain. - // - // This member is required. - Nameservers []*types.Nameserver + // The date when the registration for the domain is set to expire. The date and + // time is in Unix time format and Coordinated Universal time (UTC). + ExpirationDate *time.Time // Specifies whether contact information is concealed from WHOIS queries. If the // value is true, WHOIS ("who is") queries return contact information either for @@ -142,6 +132,22 @@ type GetDomainDetailOutput struct { // owner). RegistrantPrivacy *bool + // Name of the registrar of the domain as identified in the registry. Domains with + // a .com, .net, or .org TLD are registered by Amazon Registrar. All other domains + // are registered by our registrar associate, Gandi. The value for domains that are + // registered by Gandi is "GANDI SAS". + RegistrarName *string + + // Web address of the registrar. + RegistrarUrl *string + + // Reserved for future use. + RegistryDomainId *string + + // Reseller of the domain. Domains registered or transferred using Route 53 domains + // will have "Amazon" as the reseller. + Reseller *string + // An array of domain name status codes, also known as Extensible Provisioning // Protocol (EPP) status codes. ICANN, the organization that maintains a central // database of domain names, has developed a set of domain name status codes that @@ -154,26 +160,20 @@ type GetDomainDetailOutput struct { // website; web searches sometimes return an old version of the document.) StatusList []*string - // Reserved for future use. - RegistryDomainId *string - - // Phone number for reporting abuse. - AbuseContactPhone *string - - // Provides details about the domain administrative contact. - // - // This member is required. - AdminContact *types.ContactDetail + // Specifies whether contact information is concealed from WHOIS queries. If the + // value is true, WHOIS ("who is") queries return contact information either for + // Amazon Registrar (for .com, .net, and .org domains) or for our registrar + // associate, Gandi (for all other TLDs). If the value is false, WHOIS queries + // return the information that you entered for the technical contact. + TechPrivacy *bool - // The date when the registration for the domain is set to expire. The date and - // time is in Unix time format and Coordinated Universal time (UTC). - ExpirationDate *time.Time + // The last updated date of the domain as found in the response to a WHOIS query. + // The date and time is in Unix time format and Coordinated Universal time (UTC). + UpdatedDate *time.Time - // Name of the registrar of the domain as identified in the registry. Domains with - // a .com, .net, or .org TLD are registered by Amazon Registrar. All other domains - // are registered by our registrar associate, Gandi. The value for domains that are - // registered by Gandi is "GANDI SAS". - RegistrarName *string + // The fully qualified name of the WHOIS server that can answer the WHOIS query for + // the domain. + WhoIsServer *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/route53domains/api_op_GetDomainSuggestions.go b/service/route53domains/api_op_GetDomainSuggestions.go index aad741e2856..b214b5c5b05 100644 --- a/service/route53domains/api_op_GetDomainSuggestions.go +++ b/service/route53domains/api_op_GetDomainSuggestions.go @@ -57,20 +57,6 @@ func (c *Client) GetDomainSuggestions(ctx context.Context, params *GetDomainSugg type GetDomainSuggestionsInput struct { - // The number of suggested domain names that you want Route 53 to return. Specify a - // value between 1 and 50. - // - // This member is required. - SuggestionCount *int32 - - // If OnlyAvailable is true, Route 53 returns only domain names that are available. - // If OnlyAvailable is false, Route 53 returns domain names without checking - // whether they're available to be registered. To determine whether the domain is - // available, you can call checkDomainAvailability for each suggestion. - // - // This member is required. - OnlyAvailable *bool - // A domain name that you want to use as the basis for a list of possible domain // names. The top-level domain (TLD), such as .com, must be a TLD that Route 53 // supports. For a list of supported TLDs, see Domains that You Can Register with @@ -98,6 +84,20 @@ type GetDomainSuggestionsInput struct { // // This member is required. DomainName *string + + // If OnlyAvailable is true, Route 53 returns only domain names that are available. + // If OnlyAvailable is false, Route 53 returns domain names without checking + // whether they're available to be registered. To determine whether the domain is + // available, you can call checkDomainAvailability for each suggestion. + // + // This member is required. + OnlyAvailable *bool + + // The number of suggested domain names that you want Route 53 to return. Specify a + // value between 1 and 50. + // + // This member is required. + SuggestionCount *int32 } type GetDomainSuggestionsOutput struct { diff --git a/service/route53domains/api_op_GetOperationDetail.go b/service/route53domains/api_op_GetOperationDetail.go index 1ba1c74ef80..9010b128622 100644 --- a/service/route53domains/api_op_GetOperationDetail.go +++ b/service/route53domains/api_op_GetOperationDetail.go @@ -71,17 +71,11 @@ type GetOperationDetailInput struct { // The GetOperationDetail response includes the following elements. type GetOperationDetailOutput struct { - // Detailed information on the status including possible errors. - Message *string - - // The type of operation that was requested. - Type types.OperationType - // The name of a domain. DomainName *string - // The date when the request was submitted. - SubmittedDate *time.Time + // Detailed information on the status including possible errors. + Message *string // The identifier for the operation. OperationId *string @@ -89,6 +83,12 @@ type GetOperationDetailOutput struct { // The current status of the requested operation in the system. Status types.OperationStatus + // The date when the request was submitted. + SubmittedDate *time.Time + + // The type of operation that was requested. + Type types.OperationType + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/route53domains/api_op_ListDomains.go b/service/route53domains/api_op_ListDomains.go index cfa3221d0d3..2c8ecf3b0bc 100644 --- a/service/route53domains/api_op_ListDomains.go +++ b/service/route53domains/api_op_ListDomains.go @@ -73,15 +73,15 @@ type ListDomainsInput struct { // The ListDomains response includes the following elements. type ListDomainsOutput struct { - // If there are more domains than you specified for MaxItems in the request, submit - // another request and include the value of NextPageMarker in the value of Marker. - NextPageMarker *string - // A summary of domains. // // This member is required. Domains []*types.DomainSummary + // If there are more domains than you specified for MaxItems in the request, submit + // another request and include the value of NextPageMarker in the value of Marker. + NextPageMarker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/route53domains/api_op_ListOperations.go b/service/route53domains/api_op_ListOperations.go index a255a66549e..ec8e8ead0c6 100644 --- a/service/route53domains/api_op_ListOperations.go +++ b/service/route53domains/api_op_ListOperations.go @@ -79,16 +79,16 @@ type ListOperationsInput struct { // The ListOperations response includes the following elements. type ListOperationsOutput struct { - // If there are more operations than you specified for MaxItems in the request, - // submit another request and include the value of NextPageMarker in the value of - // Marker. - NextPageMarker *string - // Lists summaries of the operations. // // This member is required. Operations []*types.OperationSummary + // If there are more operations than you specified for MaxItems in the request, + // submit another request and include the value of NextPageMarker in the value of + // Marker. + NextPageMarker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/route53domains/api_op_RegisterDomain.go b/service/route53domains/api_op_RegisterDomain.go index cad91d06fb0..9d2617e5352 100644 --- a/service/route53domains/api_op_RegisterDomain.go +++ b/service/route53domains/api_op_RegisterDomain.go @@ -86,53 +86,6 @@ func (c *Client) RegisterDomain(ctx context.Context, params *RegisterDomainInput // The RegisterDomain request includes the following elements. type RegisterDomainInput struct { - // The number of years that you want to register the domain for. Domains are - // registered for a minimum of one year. The maximum period depends on the - // top-level domain. For the range of valid values for your domain, see Domains - // that You Can Register with Amazon Route 53 - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) - // in the Amazon Route 53 Developer Guide. Default: 1 - // - // This member is required. - DurationInYears *int32 - - // Whether you want to conceal contact information from WHOIS queries. If you - // specify true, WHOIS ("who is") queries return contact information either for - // Amazon Registrar (for .com, .net, and .org domains) or for our registrar - // associate, Gandi (for all other TLDs). If you specify false, WHOIS queries - // return the information that you entered for the technical contact. Default: true - PrivacyProtectTechContact *bool - - // Whether you want to conceal contact information from WHOIS queries. If you - // specify true, WHOIS ("who is") queries return contact information either for - // Amazon Registrar (for .com, .net, and .org domains) or for our registrar - // associate, Gandi (for all other TLDs). If you specify false, WHOIS queries - // return the information that you entered for the registrant contact (the domain - // owner). Default: true - PrivacyProtectRegistrantContact *bool - - // Indicates whether the domain will be automatically renewed (true) or not - // (false). Autorenewal only takes effect after the account is charged. Default: - // true - AutoRenew *bool - - // Whether you want to conceal contact information from WHOIS queries. If you - // specify true, WHOIS ("who is") queries return contact information either for - // Amazon Registrar (for .com, .net, and .org domains) or for our registrar - // associate, Gandi (for all other TLDs). If you specify false, WHOIS queries - // return the information that you entered for the admin contact. Default: true - PrivacyProtectAdminContact *bool - - // Reserved for future use. - IdnLangCode *string - - // Provides detailed contact information. For information about the values that you - // specify for each element, see ContactDetail - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ContactDetail.html). - // - // This member is required. - RegistrantContact *types.ContactDetail - // Provides detailed contact information. For information about the values that you // specify for each element, see ContactDetail // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ContactDetail.html). @@ -169,12 +122,59 @@ type RegisterDomainInput struct { // This member is required. DomainName *string + // The number of years that you want to register the domain for. Domains are + // registered for a minimum of one year. The maximum period depends on the + // top-level domain. For the range of valid values for your domain, see Domains + // that You Can Register with Amazon Route 53 + // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) + // in the Amazon Route 53 Developer Guide. Default: 1 + // + // This member is required. + DurationInYears *int32 + + // Provides detailed contact information. For information about the values that you + // specify for each element, see ContactDetail + // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ContactDetail.html). + // + // This member is required. + RegistrantContact *types.ContactDetail + // Provides detailed contact information. For information about the values that you // specify for each element, see ContactDetail // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ContactDetail.html). // // This member is required. TechContact *types.ContactDetail + + // Indicates whether the domain will be automatically renewed (true) or not + // (false). Autorenewal only takes effect after the account is charged. Default: + // true + AutoRenew *bool + + // Reserved for future use. + IdnLangCode *string + + // Whether you want to conceal contact information from WHOIS queries. If you + // specify true, WHOIS ("who is") queries return contact information either for + // Amazon Registrar (for .com, .net, and .org domains) or for our registrar + // associate, Gandi (for all other TLDs). If you specify false, WHOIS queries + // return the information that you entered for the admin contact. Default: true + PrivacyProtectAdminContact *bool + + // Whether you want to conceal contact information from WHOIS queries. If you + // specify true, WHOIS ("who is") queries return contact information either for + // Amazon Registrar (for .com, .net, and .org domains) or for our registrar + // associate, Gandi (for all other TLDs). If you specify false, WHOIS queries + // return the information that you entered for the registrant contact (the domain + // owner). Default: true + PrivacyProtectRegistrantContact *bool + + // Whether you want to conceal contact information from WHOIS queries. If you + // specify true, WHOIS ("who is") queries return contact information either for + // Amazon Registrar (for .com, .net, and .org domains) or for our registrar + // associate, Gandi (for all other TLDs). If you specify false, WHOIS queries + // return the information that you entered for the technical contact. Default: true + PrivacyProtectTechContact *bool } // The RegisterDomain response includes the following element. diff --git a/service/route53domains/api_op_RenewDomain.go b/service/route53domains/api_op_RenewDomain.go index 596d8719408..ac3837e92f6 100644 --- a/service/route53domains/api_op_RenewDomain.go +++ b/service/route53domains/api_op_RenewDomain.go @@ -65,17 +65,17 @@ func (c *Client) RenewDomain(ctx context.Context, params *RenewDomainInput, optF // and the current expiration year. type RenewDomainInput struct { - // The name of the domain that you want to renew. - // - // This member is required. - DomainName *string - // The year when the registration for the domain is set to expire. This value must // match the current expiration date for the domain. // // This member is required. CurrentExpiryYear *int32 + // The name of the domain that you want to renew. + // + // This member is required. + DomainName *string + // The number of years that you want to renew the domain for. The maximum number of // years depends on the top-level domain. For the range of valid values for your // domain, see Domains that You Can Register with Amazon Route 53 diff --git a/service/route53domains/api_op_ResendContactReachabilityEmail.go b/service/route53domains/api_op_ResendContactReachabilityEmail.go index 69d251fa056..e1995ef706f 100644 --- a/service/route53domains/api_op_ResendContactReachabilityEmail.go +++ b/service/route53domains/api_op_ResendContactReachabilityEmail.go @@ -65,17 +65,17 @@ type ResendContactReachabilityEmailInput struct { type ResendContactReachabilityEmailOutput struct { - // True if the email address for the registrant contact has already been verified, - // and false otherwise. If the email address has already been verified, we don't - // send another confirmation email. - IsAlreadyVerified *bool + // The domain name for which you requested a confirmation email. + DomainName *string // The email address for the registrant contact at the time that we sent the // verification email. EmailAddress *string - // The domain name for which you requested a confirmation email. - DomainName *string + // True if the email address for the registrant contact has already been verified, + // and false otherwise. If the email address has already been verified, we don't + // send another confirmation email. + IsAlreadyVerified *bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/route53domains/api_op_TransferDomain.go b/service/route53domains/api_op_TransferDomain.go index e46c545170a..49441bec463 100644 --- a/service/route53domains/api_op_TransferDomain.go +++ b/service/route53domains/api_op_TransferDomain.go @@ -93,49 +93,10 @@ func (c *Client) TransferDomain(ctx context.Context, params *TransferDomainInput // The TransferDomain request includes the following elements. type TransferDomainInput struct { - // The number of years that you want to register the domain for. Domains are - // registered for a minimum of one year. The maximum period depends on the - // top-level domain. Default: 1 + // Provides detailed contact information. // // This member is required. - DurationInYears *int32 - - // Whether you want to conceal contact information from WHOIS queries. If you - // specify true, WHOIS ("who is") queries return contact information either for - // Amazon Registrar (for .com, .net, and .org domains) or for our registrar - // associate, Gandi (for all other TLDs). If you specify false, WHOIS queries - // return the information that you entered for the technical contact. Default: true - PrivacyProtectTechContact *bool - - // Indicates whether the domain will be automatically renewed (true) or not - // (false). Autorenewal only takes effect after the account is charged. Default: - // true - AutoRenew *bool - - // Contains details for the host and glue IP addresses. - Nameservers []*types.Nameserver - - // Whether you want to conceal contact information from WHOIS queries. If you - // specify true, WHOIS ("who is") queries return contact information either for - // Amazon Registrar (for .com, .net, and .org domains) or for our registrar - // associate, Gandi (for all other TLDs). If you specify false, WHOIS queries - // return the information that you entered for the registrant contact (domain - // owner). Default: true - PrivacyProtectRegistrantContact *bool - - // The authorization code for the domain. You get this value from the current - // registrar. - AuthCode *string - - // Whether you want to conceal contact information from WHOIS queries. If you - // specify true, WHOIS ("who is") queries return contact information either for - // Amazon Registrar (for .com, .net, and .org domains) or for our registrar - // associate, Gandi (for all other TLDs). If you specify false, WHOIS queries - // return the information that you entered for the admin contact. Default: true - PrivacyProtectAdminContact *bool - - // Reserved for future use. - IdnLangCode *string + AdminContact *types.ContactDetail // The name of the domain that you want to transfer to Route 53. The top-level // domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of @@ -158,10 +119,12 @@ type TransferDomainInput struct { // This member is required. DomainName *string - // Provides detailed contact information. + // The number of years that you want to register the domain for. Domains are + // registered for a minimum of one year. The maximum period depends on the + // top-level domain. Default: 1 // // This member is required. - AdminContact *types.ContactDetail + DurationInYears *int32 // Provides detailed contact information. // @@ -172,6 +135,43 @@ type TransferDomainInput struct { // // This member is required. TechContact *types.ContactDetail + + // The authorization code for the domain. You get this value from the current + // registrar. + AuthCode *string + + // Indicates whether the domain will be automatically renewed (true) or not + // (false). Autorenewal only takes effect after the account is charged. Default: + // true + AutoRenew *bool + + // Reserved for future use. + IdnLangCode *string + + // Contains details for the host and glue IP addresses. + Nameservers []*types.Nameserver + + // Whether you want to conceal contact information from WHOIS queries. If you + // specify true, WHOIS ("who is") queries return contact information either for + // Amazon Registrar (for .com, .net, and .org domains) or for our registrar + // associate, Gandi (for all other TLDs). If you specify false, WHOIS queries + // return the information that you entered for the admin contact. Default: true + PrivacyProtectAdminContact *bool + + // Whether you want to conceal contact information from WHOIS queries. If you + // specify true, WHOIS ("who is") queries return contact information either for + // Amazon Registrar (for .com, .net, and .org domains) or for our registrar + // associate, Gandi (for all other TLDs). If you specify false, WHOIS queries + // return the information that you entered for the registrant contact (domain + // owner). Default: true + PrivacyProtectRegistrantContact *bool + + // Whether you want to conceal contact information from WHOIS queries. If you + // specify true, WHOIS ("who is") queries return contact information either for + // Amazon Registrar (for .com, .net, and .org domains) or for our registrar + // associate, Gandi (for all other TLDs). If you specify false, WHOIS queries + // return the information that you entered for the technical contact. Default: true + PrivacyProtectTechContact *bool } // The TransferDomain response includes the following element. diff --git a/service/route53domains/api_op_UpdateDomainContact.go b/service/route53domains/api_op_UpdateDomainContact.go index 53c16655ad9..cb047e10e2e 100644 --- a/service/route53domains/api_op_UpdateDomainContact.go +++ b/service/route53domains/api_op_UpdateDomainContact.go @@ -62,17 +62,17 @@ func (c *Client) UpdateDomainContact(ctx context.Context, params *UpdateDomainCo // The UpdateDomainContact request includes the following elements. type UpdateDomainContactInput struct { + // The name of the domain that you want to update contact information for. + // + // This member is required. + DomainName *string + // Provides detailed contact information. AdminContact *types.ContactDetail // Provides detailed contact information. RegistrantContact *types.ContactDetail - // The name of the domain that you want to update contact information for. - // - // This member is required. - DomainName *string - // Provides detailed contact information. TechContact *types.ContactDetail } diff --git a/service/route53domains/api_op_UpdateDomainContactPrivacy.go b/service/route53domains/api_op_UpdateDomainContactPrivacy.go index 143a1de4906..8169ccad24f 100644 --- a/service/route53domains/api_op_UpdateDomainContactPrivacy.go +++ b/service/route53domains/api_op_UpdateDomainContactPrivacy.go @@ -75,13 +75,6 @@ func (c *Client) UpdateDomainContactPrivacy(ctx context.Context, params *UpdateD // The UpdateDomainContactPrivacy request includes the following elements. type UpdateDomainContactPrivacyInput struct { - // Whether you want to conceal contact information from WHOIS queries. If you - // specify true, WHOIS ("who is") queries return contact information either for - // Amazon Registrar (for .com, .net, and .org domains) or for our registrar - // associate, Gandi (for all other TLDs). If you specify false, WHOIS queries - // return the information that you entered for the admin contact. - AdminPrivacy *bool - // The name of the domain that you want to update the privacy setting for. // // This member is required. @@ -91,8 +84,8 @@ type UpdateDomainContactPrivacyInput struct { // specify true, WHOIS ("who is") queries return contact information either for // Amazon Registrar (for .com, .net, and .org domains) or for our registrar // associate, Gandi (for all other TLDs). If you specify false, WHOIS queries - // return the information that you entered for the technical contact. - TechPrivacy *bool + // return the information that you entered for the admin contact. + AdminPrivacy *bool // Whether you want to conceal contact information from WHOIS queries. If you // specify true, WHOIS ("who is") queries return contact information either for @@ -101,6 +94,13 @@ type UpdateDomainContactPrivacyInput struct { // return the information that you entered for the registrant contact (domain // owner). RegistrantPrivacy *bool + + // Whether you want to conceal contact information from WHOIS queries. If you + // specify true, WHOIS ("who is") queries return contact information either for + // Amazon Registrar (for .com, .net, and .org domains) or for our registrar + // associate, Gandi (for all other TLDs). If you specify false, WHOIS queries + // return the information that you entered for the technical contact. + TechPrivacy *bool } // The UpdateDomainContactPrivacy response includes the following element. diff --git a/service/route53domains/api_op_UpdateDomainNameservers.go b/service/route53domains/api_op_UpdateDomainNameservers.go index 86940497189..8c3eb7fc6a6 100644 --- a/service/route53domains/api_op_UpdateDomainNameservers.go +++ b/service/route53domains/api_op_UpdateDomainNameservers.go @@ -68,9 +68,6 @@ func (c *Client) UpdateDomainNameservers(ctx context.Context, params *UpdateDoma // successfully, the domain registrant will be notified by email. type UpdateDomainNameserversInput struct { - // The authorization key for .fi domains - FIAuthKey *string - // The name of the domain that you want to change name servers for. // // This member is required. @@ -80,6 +77,9 @@ type UpdateDomainNameserversInput struct { // // This member is required. Nameservers []*types.Nameserver + + // The authorization key for .fi domains + FIAuthKey *string } // The UpdateDomainNameservers response includes the following element. diff --git a/service/route53domains/api_op_ViewBilling.go b/service/route53domains/api_op_ViewBilling.go index 8c07196314f..c636cb3e7ae 100644 --- a/service/route53domains/api_op_ViewBilling.go +++ b/service/route53domains/api_op_ViewBilling.go @@ -59,9 +59,6 @@ func (c *Client) ViewBilling(ctx context.Context, params *ViewBillingInput, optF // The ViewBilling request includes the following elements. type ViewBillingInput struct { - // The number of billing records to be returned. Default: 20 - MaxItems *int32 - // The end date and time for the time period for which you want a list of billing // records. Specify the date and time in Unix time format and Coordinated Universal // time (UTC). @@ -77,6 +74,9 @@ type ViewBillingInput struct { // response. Marker *string + // The number of billing records to be returned. Default: 20 + MaxItems *int32 + // The beginning date and time for the time period for which you want a list of // billing records. Specify the date and time in Unix time format and Coordinated // Universal time (UTC). diff --git a/service/route53domains/go.mod b/service/route53domains/go.mod index a448c434d9c..fd21b39a687 100644 --- a/service/route53domains/go.mod +++ b/service/route53domains/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/route53domains go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/route53domains/types/types.go b/service/route53domains/types/types.go index fd202b1fcb7..91dec9382d6 100644 --- a/service/route53domains/types/types.go +++ b/service/route53domains/types/types.go @@ -9,6 +9,9 @@ import ( // Information for one billing record. type BillingRecord struct { + // The date that the operation was billed, in Unix format. + BillDate *time.Time + // The name of the domain that the billing record applies to. If the domain name // contains characters other than a-z, 0-9, and - (hyphen), such as an // internationalized domain name, then this value is in Punycode. For more @@ -17,51 +20,51 @@ type BillingRecord struct { // in the Amazon Route 53 Developer Guide. DomainName *string + // The ID of the invoice that is associated with the billing record. + InvoiceId *string + // The operation that you were charged for. Operation OperationType // The price that you were charged for the operation, in US dollars. Example value: // 12.0 Price *float64 - - // The date that the operation was billed, in Unix format. - BillDate *time.Time - - // The ID of the invoice that is associated with the billing record. - InvoiceId *string } // ContactDetail includes the following elements. type ContactDetail struct { - // The city of the contact's address. - City *string - // First line of the contact's address. AddressLine1 *string - // The phone number of the contact. Constraints: Phone number must be specified in - // the format "+[country dialing code].[number including any area code>]". For - // example, a US phone number might appear as "+1.1234567890". - PhoneNumber *string - // Second line of contact's address, if any. AddressLine2 *string - // The zip or postal code of the contact's address. - ZipCode *string - - // Last name of contact. - LastName *string + // The city of the contact's address. + City *string - // The state or province of the contact's city. - State *string + // Indicates whether the contact is a person, company, association, or public + // organization. Note the following: + // + // * If you specify a value other than + // PERSON, you must also specify a value for OrganizationName. + // + // * For some + // TLDs, the privacy protection available depends on the value that you specify for + // Contact Type. For the privacy protection settings for your TLD, see Domains that + // You Can Register with Amazon Route 53 + // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) + // in the Amazon Route 53 Developer Guide + // + // * For .es domains, if you specify + // PERSON, you must specify INDIVIDUAL for the value of ES_LEGAL_FORM. + ContactType ContactType // Code for the country of the contact's address. CountryCode CountryCode - // Name of the organization for contact types other than PERSON. - OrganizationName *string + // Email address of the contact. + Email *string // A list of name-value pairs for parameters required by certain top-level domains. ExtraParams []*ExtraParam @@ -74,25 +77,22 @@ type ContactDetail struct { // First name of contact. FirstName *string - // Email address of the contact. - Email *string + // Last name of contact. + LastName *string - // Indicates whether the contact is a person, company, association, or public - // organization. Note the following: - // - // * If you specify a value other than - // PERSON, you must also specify a value for OrganizationName. - // - // * For some - // TLDs, the privacy protection available depends on the value that you specify for - // Contact Type. For the privacy protection settings for your TLD, see Domains that - // You Can Register with Amazon Route 53 - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) - // in the Amazon Route 53 Developer Guide - // - // * For .es domains, if you specify - // PERSON, you must specify INDIVIDUAL for the value of ES_LEGAL_FORM. - ContactType ContactType + // Name of the organization for contact types other than PERSON. + OrganizationName *string + + // The phone number of the contact. Constraints: Phone number must be specified in + // the format "+[country dialing code].[number including any area code>]". For + // example, a US phone number might appear as "+1.1234567890". + PhoneNumber *string + + // The state or province of the contact's city. + State *string + + // The zip or postal code of the contact's address. + ZipCode *string } // Information about one suggested domain name. @@ -120,10 +120,6 @@ type DomainSuggestion struct { // Summary information about one domain. type DomainSummary struct { - // Expiration date of the domain in Unix time format and Coordinated Universal Time - // (UTC). - Expiry *time.Time - // The name of the domain that the summary information applies to. // // This member is required. @@ -132,6 +128,10 @@ type DomainSummary struct { // Indicates whether the domain is automatically renewed upon expiration. AutoRenew *bool + // Expiration date of the domain in Unix time format and Coordinated Universal Time + // (UTC). + Expiry *time.Time + // Indicates whether a domain is locked from unauthorized transfer to another // party. TransferLock *bool @@ -153,11 +153,6 @@ type DomainTransferability struct { // ExtraParam includes the following elements. type ExtraParam struct { - // The value that corresponds with the name of an extra parameter. - // - // This member is required. - Value *string - // The name of an additional parameter that is required by a top-level domain. Here // are the top-level domains that require additional parameters and the names of // the parameters that they require:
    .com.au and .net.au
      @@ -307,6 +302,11 @@ type ExtraParam struct { // // This member is required. Name ExtraParamName + + // The value that corresponds with the name of an extra parameter. + // + // This member is required. + Value *string } // Nameserver includes the following elements. @@ -329,35 +329,35 @@ type Nameserver struct { // OperationSummary includes the following elements. type OperationSummary struct { - // The date when the request was submitted. + // Identifier returned to track the requested action. // // This member is required. - SubmittedDate *time.Time + OperationId *string // The current status of the requested operation in the system. // // This member is required. Status OperationStatus - // Type of the action requested. + // The date when the request was submitted. // // This member is required. - Type OperationType + SubmittedDate *time.Time - // Identifier returned to track the requested action. + // Type of the action requested. // // This member is required. - OperationId *string + Type OperationType } // Each tag includes the following elements. type Tag struct { - // The value of a tag. Valid values: A-Z, a-z, 0-9, space, ".:/=+\-@" Constraints: - // Each value can be 0-256 characters long. - Value *string - // The key (name) of a tag. Valid values: A-Z, a-z, 0-9, space, ".:/=+\-@" // Constraints: Each key can be 1-128 characters long. Key *string + + // The value of a tag. Valid values: A-Z, a-z, 0-9, space, ".:/=+\-@" Constraints: + // Each value can be 0-256 characters long. + Value *string } diff --git a/service/route53resolver/api_op_AssociateResolverRule.go b/service/route53resolver/api_op_AssociateResolverRule.go index 8a3fe8c5a1c..62add87cf2c 100644 --- a/service/route53resolver/api_op_AssociateResolverRule.go +++ b/service/route53resolver/api_op_AssociateResolverRule.go @@ -67,14 +67,14 @@ type AssociateResolverRuleInput struct { // This member is required. ResolverRuleId *string - // A name for the association that you're creating between a resolver rule and a - // VPC. - Name *string - // The ID of the VPC that you want to associate the resolver rule with. // // This member is required. VPCId *string + + // A name for the association that you're creating between a resolver rule and a + // VPC. + Name *string } type AssociateResolverRuleOutput struct { diff --git a/service/route53resolver/api_op_CreateResolverEndpoint.go b/service/route53resolver/api_op_CreateResolverEndpoint.go index fcf67f15efa..0efb62055dc 100644 --- a/service/route53resolver/api_op_CreateResolverEndpoint.go +++ b/service/route53resolver/api_op_CreateResolverEndpoint.go @@ -65,28 +65,6 @@ func (c *Client) CreateResolverEndpoint(ctx context.Context, params *CreateResol type CreateResolverEndpointInput struct { - // The ID of one or more security groups that you want to use to control access to - // this VPC. The security group that you specify must include one or more inbound - // rules (for inbound resolver endpoints) or outbound rules (for outbound resolver - // endpoints). - // - // This member is required. - SecurityGroupIds []*string - - // A friendly name that lets you easily find a configuration in the Resolver - // dashboard in the Route 53 console. - Name *string - - // The subnets and IP addresses in your VPC that you want DNS queries to pass - // through on the way from your VPCs to your network (for outbound endpoints) or on - // the way from your network to your VPCs (for inbound resolver endpoints). - // - // This member is required. - IpAddresses []*types.IpAddressRequest - - // A list of the tag keys and values that you want to associate with the endpoint. - Tags []*types.Tag - // A unique string that identifies the request and that allows failed requests to // be retried without the risk of executing the operation twice. CreatorRequestId // can be any unique string, for example, a date/time stamp. @@ -105,6 +83,28 @@ type CreateResolverEndpointInput struct { // // This member is required. Direction types.ResolverEndpointDirection + + // The subnets and IP addresses in your VPC that you want DNS queries to pass + // through on the way from your VPCs to your network (for outbound endpoints) or on + // the way from your network to your VPCs (for inbound resolver endpoints). + // + // This member is required. + IpAddresses []*types.IpAddressRequest + + // The ID of one or more security groups that you want to use to control access to + // this VPC. The security group that you specify must include one or more inbound + // rules (for inbound resolver endpoints) or outbound rules (for outbound resolver + // endpoints). + // + // This member is required. + SecurityGroupIds []*string + + // A friendly name that lets you easily find a configuration in the Resolver + // dashboard in the Route 53 console. + Name *string + + // A list of the tag keys and values that you want to associate with the endpoint. + Tags []*types.Tag } type CreateResolverEndpointOutput struct { diff --git a/service/route53resolver/api_op_CreateResolverRule.go b/service/route53resolver/api_op_CreateResolverRule.go index 5e84772ce78..db7bae9d82f 100644 --- a/service/route53resolver/api_op_CreateResolverRule.go +++ b/service/route53resolver/api_op_CreateResolverRule.go @@ -66,33 +66,33 @@ type CreateResolverRuleInput struct { // This member is required. CreatorRequestId *string + // DNS queries for this domain name are forwarded to the IP addresses that you + // specify in TargetIps. If a query matches multiple resolver rules (example.com + // and www.example.com), outbound DNS queries are routed using the resolver rule + // that contains the most specific domain name (www.example.com). + // + // This member is required. + DomainName *string + // Specify FORWARD. Other resolver rule types aren't supported. // // This member is required. RuleType types.RuleTypeOption - // The IPs that you want Resolver to forward DNS queries to. You can specify only - // IPv4 addresses. Separate IP addresses with a comma. - TargetIps []*types.TargetAddress - // A friendly name that lets you easily find a rule in the Resolver dashboard in // the Route 53 console. Name *string - // DNS queries for this domain name are forwarded to the IP addresses that you - // specify in TargetIps. If a query matches multiple resolver rules (example.com - // and www.example.com), outbound DNS queries are routed using the resolver rule - // that contains the most specific domain name (www.example.com). - // - // This member is required. - DomainName *string + // The ID of the outbound resolver endpoint that you want to use to route DNS + // queries to the IP addresses that you specify in TargetIps. + ResolverEndpointId *string // A list of the tag keys and values that you want to associate with the endpoint. Tags []*types.Tag - // The ID of the outbound resolver endpoint that you want to use to route DNS - // queries to the IP addresses that you specify in TargetIps. - ResolverEndpointId *string + // The IPs that you want Resolver to forward DNS queries to. You can specify only + // IPv4 addresses. Separate IP addresses with a comma. + TargetIps []*types.TargetAddress } type CreateResolverRuleOutput struct { diff --git a/service/route53resolver/api_op_DisassociateResolverEndpointIpAddress.go b/service/route53resolver/api_op_DisassociateResolverEndpointIpAddress.go index cbbf375fefd..6cddd0aab01 100644 --- a/service/route53resolver/api_op_DisassociateResolverEndpointIpAddress.go +++ b/service/route53resolver/api_op_DisassociateResolverEndpointIpAddress.go @@ -60,16 +60,16 @@ func (c *Client) DisassociateResolverEndpointIpAddress(ctx context.Context, para type DisassociateResolverEndpointIpAddressInput struct { - // The ID of the resolver endpoint that you want to disassociate an IP address - // from. + // The IPv4 address that you want to remove from a resolver endpoint. // // This member is required. - ResolverEndpointId *string + IpAddress *types.IpAddressUpdate - // The IPv4 address that you want to remove from a resolver endpoint. + // The ID of the resolver endpoint that you want to disassociate an IP address + // from. // // This member is required. - IpAddress *types.IpAddressUpdate + ResolverEndpointId *string } type DisassociateResolverEndpointIpAddressOutput struct { diff --git a/service/route53resolver/api_op_ListResolverEndpointIpAddresses.go b/service/route53resolver/api_op_ListResolverEndpointIpAddresses.go index b1ca92d25bf..dbf6482272c 100644 --- a/service/route53resolver/api_op_ListResolverEndpointIpAddresses.go +++ b/service/route53resolver/api_op_ListResolverEndpointIpAddresses.go @@ -57,26 +57,30 @@ func (c *Client) ListResolverEndpointIpAddresses(ctx context.Context, params *Li type ListResolverEndpointIpAddressesInput struct { - // For the first ListResolverEndpointIpAddresses request, omit this value. If the - // specified resolver endpoint has more than MaxResults IP addresses, you can - // submit another ListResolverEndpointIpAddresses request to get the next group of - // IP addresses. In the next request, specify the value of NextToken from the - // previous response. - NextToken *string + // The ID of the resolver endpoint that you want to get IP addresses for. + // + // This member is required. + ResolverEndpointId *string // The maximum number of IP addresses that you want to return in the response to a // ListResolverEndpointIpAddresses request. If you don't specify a value for // MaxResults, Resolver returns up to 100 IP addresses. MaxResults *int32 - // The ID of the resolver endpoint that you want to get IP addresses for. - // - // This member is required. - ResolverEndpointId *string + // For the first ListResolverEndpointIpAddresses request, omit this value. If the + // specified resolver endpoint has more than MaxResults IP addresses, you can + // submit another ListResolverEndpointIpAddresses request to get the next group of + // IP addresses. In the next request, specify the value of NextToken from the + // previous response. + NextToken *string } type ListResolverEndpointIpAddressesOutput struct { + // The IP addresses that DNS queries pass through on their way to your network + // (outbound endpoint) or on the way to Resolver (inbound endpoint). + IpAddresses []*types.IpAddressResponse + // The value that you specified for MaxResults in the request. MaxResults *int32 @@ -86,10 +90,6 @@ type ListResolverEndpointIpAddressesOutput struct { // response. NextToken *string - // The IP addresses that DNS queries pass through on their way to your network - // (outbound endpoint) or on the way to Resolver (inbound endpoint). - IpAddresses []*types.IpAddressResponse - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/route53resolver/api_op_ListResolverEndpoints.go b/service/route53resolver/api_op_ListResolverEndpoints.go index 4a5c0d39e84..81ac3ab1d64 100644 --- a/service/route53resolver/api_op_ListResolverEndpoints.go +++ b/service/route53resolver/api_op_ListResolverEndpoints.go @@ -57,6 +57,12 @@ func (c *Client) ListResolverEndpoints(ctx context.Context, params *ListResolver type ListResolverEndpointsInput struct { + // An optional specification to return a subset of resolver endpoints, such as all + // inbound resolver endpoints. If you submit a second or subsequent + // ListResolverEndpoints request and specify the NextToken parameter, you must use + // the same values for Filters, if any, as in the previous request. + Filters []*types.Filter + // The maximum number of resolver endpoints that you want to return in the response // to a ListResolverEndpoints request. If you don't specify a value for MaxResults, // Resolver returns up to 100 resolver endpoints. @@ -67,12 +73,6 @@ type ListResolverEndpointsInput struct { // request to get the next group of resolver endpoints. In the next request, // specify the value of NextToken from the previous response. NextToken *string - - // An optional specification to return a subset of resolver endpoints, such as all - // inbound resolver endpoints. If you submit a second or subsequent - // ListResolverEndpoints request and specify the NextToken parameter, you must use - // the same values for Filters, if any, as in the previous request. - Filters []*types.Filter } type ListResolverEndpointsOutput struct { diff --git a/service/route53resolver/api_op_ListResolverRuleAssociations.go b/service/route53resolver/api_op_ListResolverRuleAssociations.go index cf251cac4f2..020b0828a20 100644 --- a/service/route53resolver/api_op_ListResolverRuleAssociations.go +++ b/service/route53resolver/api_op_ListResolverRuleAssociations.go @@ -57,11 +57,6 @@ func (c *Client) ListResolverRuleAssociations(ctx context.Context, params *ListR type ListResolverRuleAssociationsInput struct { - // The maximum number of rule associations that you want to return in the response - // to a ListResolverRuleAssociations request. If you don't specify a value for - // MaxResults, Resolver returns up to 100 rule associations. - MaxResults *int32 - // An optional specification to return a subset of resolver rules, such as resolver // rules that are associated with the same VPC ID. If you submit a second or // subsequent ListResolverRuleAssociations request and specify the NextToken @@ -69,6 +64,11 @@ type ListResolverRuleAssociationsInput struct { // request. Filters []*types.Filter + // The maximum number of rule associations that you want to return in the response + // to a ListResolverRuleAssociations request. If you don't specify a value for + // MaxResults, Resolver returns up to 100 rule associations. + MaxResults *int32 + // For the first ListResolverRuleAssociation request, omit this value. If you have // more than MaxResults rule associations, you can submit another // ListResolverRuleAssociation request to get the next group of rule associations. @@ -78,10 +78,6 @@ type ListResolverRuleAssociationsInput struct { type ListResolverRuleAssociationsOutput struct { - // The associations that were created between resolver rules and VPCs using the - // current AWS account, and that match the specified filters, if any. - ResolverRuleAssociations []*types.ResolverRuleAssociation - // The value that you specified for MaxResults in the request. MaxResults *int32 @@ -91,6 +87,10 @@ type ListResolverRuleAssociationsOutput struct { // response. NextToken *string + // The associations that were created between resolver rules and VPCs using the + // current AWS account, and that match the specified filters, if any. + ResolverRuleAssociations []*types.ResolverRuleAssociation + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/route53resolver/api_op_ListResolverRules.go b/service/route53resolver/api_op_ListResolverRules.go index 9e5940d3c3a..92aa06dfcdf 100644 --- a/service/route53resolver/api_op_ListResolverRules.go +++ b/service/route53resolver/api_op_ListResolverRules.go @@ -56,35 +56,35 @@ func (c *Client) ListResolverRules(ctx context.Context, params *ListResolverRule type ListResolverRulesInput struct { - // For the first ListResolverRules request, omit this value. If you have more than - // MaxResults resolver rules, you can submit another ListResolverRules request to - // get the next group of resolver rules. In the next request, specify the value of - // NextToken from the previous response. - NextToken *string - - // The maximum number of resolver rules that you want to return in the response to - // a ListResolverRules request. If you don't specify a value for MaxResults, - // Resolver returns up to 100 resolver rules. - MaxResults *int32 - // An optional specification to return a subset of resolver rules, such as all // resolver rules that are associated with the same resolver endpoint. If you // submit a second or subsequent ListResolverRules request and specify the // NextToken parameter, you must use the same values for Filters, if any, as in the // previous request. Filters []*types.Filter + + // The maximum number of resolver rules that you want to return in the response to + // a ListResolverRules request. If you don't specify a value for MaxResults, + // Resolver returns up to 100 resolver rules. + MaxResults *int32 + + // For the first ListResolverRules request, omit this value. If you have more than + // MaxResults resolver rules, you can submit another ListResolverRules request to + // get the next group of resolver rules. In the next request, specify the value of + // NextToken from the previous response. + NextToken *string } type ListResolverRulesOutput struct { + // The value that you specified for MaxResults in the request. + MaxResults *int32 + // If more than MaxResults resolver rules match the specified criteria, you can // submit another ListResolverRules request to get the next group of results. In // the next request, specify the value of NextToken from the previous response. NextToken *string - // The value that you specified for MaxResults in the request. - MaxResults *int32 - // The resolver rules that were created using the current AWS account and that // match the specified filters, if any. ResolverRules []*types.ResolverRule diff --git a/service/route53resolver/api_op_TagResource.go b/service/route53resolver/api_op_TagResource.go index 8130e984070..ed210681fb3 100644 --- a/service/route53resolver/api_op_TagResource.go +++ b/service/route53resolver/api_op_TagResource.go @@ -57,11 +57,6 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The tags that you want to add to the specified resource. - // - // This member is required. - Tags []*types.Tag - // The Amazon Resource Name (ARN) for the resource that you want to add tags to. To // get the ARN for a resource, use the applicable Get or List command: // @@ -82,6 +77,11 @@ type TagResourceInput struct { // // This member is required. ResourceArn *string + + // The tags that you want to add to the specified resource. + // + // This member is required. + Tags []*types.Tag } type TagResourceOutput struct { diff --git a/service/route53resolver/go.mod b/service/route53resolver/go.mod index 51012774b90..2d2cf04ca46 100644 --- a/service/route53resolver/go.mod +++ b/service/route53resolver/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/route53resolver go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/route53resolver/types/types.go b/service/route53resolver/types/types.go index 897318f87b1..7ac932ee69c 100644 --- a/service/route53resolver/types/types.go +++ b/service/route53resolver/types/types.go @@ -23,41 +23,41 @@ type Filter struct { // to use for DNS queries. type IpAddressRequest struct { - // The IP address that you want to use for DNS queries. - Ip *string - // The subnet that contains the IP address. // // This member is required. SubnetId *string + + // The IP address that you want to use for DNS queries. + Ip *string } // In the response to a GetResolverEndpoint () request, information about the IP // addresses that the resolver endpoint uses for DNS queries. type IpAddressResponse struct { - // A status code that gives the current status of the request. - Status IpAddressStatus + // The date and time that the IP address was created, in Unix time format and + // Coordinated Universal Time (UTC). + CreationTime *string + + // One IP address that the resolver endpoint uses for DNS queries. + Ip *string // The ID of one IP address. IpId *string - // The ID of one subnet. - SubnetId *string - // The date and time that the IP address was last modified, in Unix time format and // Coordinated Universal Time (UTC). ModificationTime *string - // The date and time that the IP address was created, in Unix time format and - // Coordinated Universal Time (UTC). - CreationTime *string + // A status code that gives the current status of the request. + Status IpAddressStatus // A message that provides additional information about the status of the request. StatusMessage *string - // One IP address that the resolver endpoint uses for DNS queries. - Ip *string + // The ID of one subnet. + SubnetId *string } // In an UpdateResolverEndpoint () request, information about an IP address to @@ -67,13 +67,13 @@ type IpAddressUpdate struct { // The new IP address. Ip *string - // The ID of the subnet that includes the IP address that you want to update. To - // get this ID, use GetResolverEndpoint (). - SubnetId *string - // Only when removing an IP address from a resolver endpoint: The ID of the IP // address that you want to remove. To get this ID, use GetResolverEndpoint (). IpId *string + + // The ID of the subnet that includes the IP address that you want to update. To + // get this ID, use GetResolverEndpoint (). + SubnetId *string } // In the response to a CreateResolverEndpoint (), DeleteResolverEndpoint (), @@ -82,27 +82,17 @@ type IpAddressUpdate struct { // outbound resolver endpoint. type ResolverEndpoint struct { - // The name that you assigned to the resolver endpoint when you submitted a - // CreateResolverEndpoint () request. - Name *string - - // The date and time that the endpoint was last modified, in Unix time format and - // Coordinated Universal Time (UTC). - ModificationTime *string - - // The ID of one or more security groups that control access to this VPC. The - // security group must include one or more inbound resolver rules. - SecurityGroupIds []*string + // The ARN (Amazon Resource Name) for the resolver endpoint. + Arn *string // The date and time that the endpoint was created, in Unix time format and // Coordinated Universal Time (UTC). CreationTime *string - // The ID of the VPC that you want to create the resolver endpoint in. - HostVPCId *string - - // The ID of the resolver endpoint. - Id *string + // A unique string that identifies the request that created the resolver endpoint. + // The CreatorRequestId allows failed requests to be retried without the risk of + // executing the operation twice. + CreatorRequestId *string // Indicates whether the resolver endpoint allows inbound or outbound DNS // queries: @@ -114,22 +104,32 @@ type ResolverEndpoint struct { // another VPC Direction ResolverEndpointDirection + // The ID of the VPC that you want to create the resolver endpoint in. + HostVPCId *string + + // The ID of the resolver endpoint. + Id *string + + // The number of IP addresses that the resolver endpoint can use for DNS queries. + IpAddressCount *int32 + + // The date and time that the endpoint was last modified, in Unix time format and + // Coordinated Universal Time (UTC). + ModificationTime *string + + // The name that you assigned to the resolver endpoint when you submitted a + // CreateResolverEndpoint () request. + Name *string + + // The ID of one or more security groups that control access to this VPC. The + // security group must include one or more inbound resolver rules. + SecurityGroupIds []*string + // A code that specifies the current status of the resolver endpoint. Status ResolverEndpointStatus - // The ARN (Amazon Resource Name) for the resolver endpoint. - Arn *string - // A detailed description of the status of the resolver endpoint. StatusMessage *string - - // A unique string that identifies the request that created the resolver endpoint. - // The CreatorRequestId allows failed requests to be retried without the risk of - // executing the operation twice. - CreatorRequestId *string - - // The number of IP addresses that the resolver endpoint can use for DNS queries. - IpAddressCount *int32 } // For queries that originate in your VPC, detailed information about a resolver @@ -141,31 +141,24 @@ type ResolverRule struct { // The ARN (Amazon Resource Name) for the resolver rule specified by Id. Arn *string - // This value is always FORWARD. Other resolver rule types aren't supported. - RuleType RuleTypeOption - // A unique string that you specified when you created the resolver rule. // CreatorRequestIdidentifies the request and allows failed requests to be retried // without the risk of executing the operation twice. CreatorRequestId *string - // The ID that Resolver assigned to the resolver rule when you created it. - Id *string - - // Whether the rules is shared and, if so, whether the current account is sharing - // the rule with another account, or another account is sharing the rule with the - // current account. - ShareStatus ShareStatus - - // A code that specifies the current status of the resolver rule. - Status ResolverRuleStatus - // DNS queries for this domain name are forwarded to the IP addresses that are // specified in TargetIps. If a query matches multiple resolver rules (example.com // and www.example.com), the query is routed using the resolver rule that contains // the most specific domain name (www.example.com). DomainName *string + // The ID that Resolver assigned to the resolver rule when you created it. + Id *string + + // The name for the resolver rule, which you specified when you created the + // resolver rule. + Name *string + // When a rule is shared with another AWS account, the account ID of the account // that the rule is shared with. OwnerId *string @@ -173,15 +166,22 @@ type ResolverRule struct { // The ID of the endpoint that the rule is associated with. ResolverEndpointId *string - // An array that contains the IP addresses and ports that you want to forward - TargetIps []*TargetAddress + // This value is always FORWARD. Other resolver rule types aren't supported. + RuleType RuleTypeOption - // The name for the resolver rule, which you specified when you created the - // resolver rule. - Name *string + // Whether the rules is shared and, if so, whether the current account is sharing + // the rule with another account, or another account is sharing the rule with the + // current account. + ShareStatus ShareStatus + + // A code that specifies the current status of the resolver rule. + Status ResolverRuleStatus // A detailed description of the status of a resolver rule. StatusMessage *string + + // An array that contains the IP addresses and ports that you want to forward + TargetIps []*TargetAddress } // In the response to an AssociateResolverRule (), DisassociateResolverRule (), or @@ -189,17 +189,6 @@ type ResolverRule struct { // between a resolver rule and a VPC. type ResolverRuleAssociation struct { - // The ID of the VPC that you associated the resolver rule with. - VPCId *string - - // A code that specifies the current status of the association between a resolver - // rule and a VPC. - Status ResolverRuleAssociationStatus - - // The ID of the resolver rule that you associated with the VPC that is specified - // by VPCId. - ResolverRuleId *string - // The ID of the association between a resolver rule and a VPC. Resolver assigns // this value when you submit an AssociateResolverRule () request. Id *string @@ -207,15 +196,30 @@ type ResolverRuleAssociation struct { // The name of an association between a resolver rule and a VPC. Name *string + // The ID of the resolver rule that you associated with the VPC that is specified + // by VPCId. + ResolverRuleId *string + + // A code that specifies the current status of the association between a resolver + // rule and a VPC. + Status ResolverRuleAssociationStatus + // A detailed description of the status of the association between a resolver rule // and a VPC. StatusMessage *string + + // The ID of the VPC that you associated the resolver rule with. + VPCId *string } // In an UpdateResolverRule () request, information about the changes that you want // to make. type ResolverRuleConfig struct { + // The new name for the resolver rule. The name that you specify appears in the + // Resolver dashboard in the Route 53 console. + Name *string + // The ID of the new outbound resolver endpoint that you want to use to route DNS // queries to the IP addresses that you specify in TargetIps. ResolverEndpointId *string @@ -223,10 +227,6 @@ type ResolverRuleConfig struct { // For DNS queries that originate in your VPC, the new IP addresses that you want // to route outbound DNS queries to. TargetIps []*TargetAddress - - // The new name for the resolver rule. The name that you specify appears in the - // Resolver dashboard in the Route 53 console. - Name *string } // One tag that you want to add to the specified resource. A tag consists of a Key @@ -247,12 +247,12 @@ type Tag struct { // DNS queries to. type TargetAddress struct { - // The port at Ip that you want to forward DNS queries to. - Port *int32 - // One IP address that you want to forward DNS queries to. You can specify only // IPv4 addresses. // // This member is required. Ip *string + + // The port at Ip that you want to forward DNS queries to. + Port *int32 } diff --git a/service/s3/api_op_AbortMultipartUpload.go b/service/s3/api_op_AbortMultipartUpload.go index cbd7cd80508..0d37a6d16f0 100644 --- a/service/s3/api_op_AbortMultipartUpload.go +++ b/service/s3/api_op_AbortMultipartUpload.go @@ -96,6 +96,16 @@ type AbortMultipartUploadInput struct { // This member is required. Bucket *string + // Key of the object for which the multipart upload was initiated. + // + // This member is required. + Key *string + + // Upload ID that identifies the multipart upload. + // + // This member is required. + UploadId *string + // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from requester pays buckets, see Downloading Objects @@ -103,16 +113,6 @@ type AbortMultipartUploadInput struct { // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 Developer Guide. RequestPayer types.RequestPayer - - // Upload ID that identifies the multipart upload. - // - // This member is required. - UploadId *string - - // Key of the object for which the multipart upload was initiated. - // - // This member is required. - Key *string } type AbortMultipartUploadOutput struct { diff --git a/service/s3/api_op_CompleteMultipartUpload.go b/service/s3/api_op_CompleteMultipartUpload.go index 93e8d8aa056..ef4d0cc93e2 100644 --- a/service/s3/api_op_CompleteMultipartUpload.go +++ b/service/s3/api_op_CompleteMultipartUpload.go @@ -103,11 +103,24 @@ func (c *Client) CompleteMultipartUpload(ctx context.Context, params *CompleteMu type CompleteMultipartUploadInput struct { + // Name of the bucket to which the multipart upload was initiated. + // + // This member is required. + Bucket *string + + // Object key for which the multipart upload was initiated. + // + // This member is required. + Key *string + // ID for the initiated multipart upload. // // This member is required. UploadId *string + // The container for the multipart upload request information. + MultipartUpload *types.CompletedMultipartUpload + // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from requester pays buckets, see Downloading Objects @@ -115,30 +128,28 @@ type CompleteMultipartUploadInput struct { // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 Developer Guide. RequestPayer types.RequestPayer +} - // The container for the multipart upload request information. - MultipartUpload *types.CompletedMultipartUpload +type CompleteMultipartUploadOutput struct { - // Name of the bucket to which the multipart upload was initiated. - // - // This member is required. + // The name of the bucket that contains the newly created object. Bucket *string - // Object key for which the multipart upload was initiated. - // - // This member is required. - Key *string -} + // Entity tag that identifies the newly created object's data. Objects with + // different object data will have different entity tags. The entity tag is an + // opaque string. The entity tag may or may not be an MD5 digest of the object + // data. If the entity tag is not an MD5 digest of the object data, it will contain + // one or more nonhexadecimal characters and/or will consist of less than 32 or + // more than 32 hexadecimal digits. + ETag *string -type CompleteMultipartUploadOutput struct { + // If the object expiration is configured, this will contain the expiration date + // (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded. + Expiration *string // The object key of the newly created object. Key *string - // Version ID of the newly created object, in case the bucket has versioning turned - // on. - VersionId *string - // The URI that identifies the newly created object. Location *string @@ -157,20 +168,9 @@ type CompleteMultipartUploadOutput struct { // encryption algorithm that Amazon S3 used to encrypt the object. ServerSideEncryption types.ServerSideEncryption - // If the object expiration is configured, this will contain the expiration date - // (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded. - Expiration *string - - // Entity tag that identifies the newly created object's data. Objects with - // different object data will have different entity tags. The entity tag is an - // opaque string. The entity tag may or may not be an MD5 digest of the object - // data. If the entity tag is not an MD5 digest of the object data, it will contain - // one or more nonhexadecimal characters and/or will consist of less than 32 or - // more than 32 hexadecimal digits. - ETag *string - - // The name of the bucket that contains the newly created object. - Bucket *string + // Version ID of the newly created object, in case the bucket has versioning turned + // on. + VersionId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/s3/api_op_CopyObject.go b/service/s3/api_op_CopyObject.go index f765dad424f..f94b31f270c 100644 --- a/service/s3/api_op_CopyObject.go +++ b/service/s3/api_op_CopyObject.go @@ -175,161 +175,174 @@ func (c *Client) CopyObject(ctx context.Context, params *CopyObjectInput, optFns type CopyObjectInput struct { - // Allows grantee to read the object ACL. - GrantReadACP *string + // The name of the destination bucket. + // + // This member is required. + Bucket *string + + // The name of the source bucket and key name of the source object, separated by a + // slash (/). Must be URL-encoded. + // + // This member is required. + CopySource *string // The key of the destination object. // // This member is required. Key *string - // Specifies whether you want to apply a Legal Hold to the copied object. - ObjectLockLegalHoldStatus types.ObjectLockLegalHoldStatus + // The canned ACL to apply to the object. + ACL types.ObjectCannedACL - // Specifies the AWS KMS key ID to use for object encryption. All GET and PUT - // requests for an object protected by AWS KMS will fail if not made via SSL or - // using SigV4. For information about configuring using any of the officially - // supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request - // Authentication - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version) - // in the Amazon S3 Developer Guide. - SSEKMSKeyId *string + // Specifies caching behavior along the request/reply chain. + CacheControl *string - // Specifies the algorithm to use when decrypting the source object (for example, - // AES256). - CopySourceSSECustomerAlgorithm *string + // Specifies presentational information for the object. + ContentDisposition *string // Specifies what content encodings have been applied to the object and thus what // decoding mechanisms must be applied to obtain the media-type referenced by the // Content-Type header field. ContentEncoding *string - // Allows grantee to read the object data and its metadata. - GrantRead *string - - // Copies the object if it hasn't been modified since the specified time. - CopySourceIfUnmodifiedSince *time.Time - - // Specifies whether the object tag-set are copied from the source object or - // replaced with tag-set provided in the request. - TaggingDirective types.TaggingDirective - // The language the content is in. ContentLanguage *string - // Specifies presentational information for the object. - ContentDisposition *string + // A standard MIME type describing the format of the object data. + ContentType *string // Copies the object if its entity tag (ETag) matches the specified tag. CopySourceIfMatch *string - // A standard MIME type describing the format of the object data. - ContentType *string - - // Specifies the customer-provided encryption key for Amazon S3 to use in - // encrypting data. This value is used to store the object and then it is - // discarded; Amazon S3 does not store the encryption key. The key must be - // appropriate for use with the algorithm specified in the - // x-amz-server-side-encryption-customer-algorithm header. - SSECustomerKey *string + // Copies the object if it has been modified since the specified time. + CopySourceIfModifiedSince *time.Time - // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. - // Amazon S3 uses this header for a message integrity check to ensure that the - // encryption key was transmitted without error. - CopySourceSSECustomerKeyMD5 *string + // Copies the object if its entity tag (ETag) is different than the specified ETag. + CopySourceIfNoneMatch *string - // The name of the destination bucket. - // - // This member is required. - Bucket *string + // Copies the object if it hasn't been modified since the specified time. + CopySourceIfUnmodifiedSince *time.Time - // Specifies the algorithm to use to when encrypting the object (for example, + // Specifies the algorithm to use when decrypting the source object (for example, // AES256). - SSECustomerAlgorithm *string + CopySourceSSECustomerAlgorithm *string - // Confirms that the requester knows that they will be charged for the request. - // Bucket owners need not specify this parameter in their requests. For information - // about downloading objects from requester pays buckets, see Downloading Objects - // in Requestor Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) - // in the Amazon S3 Developer Guide. - RequestPayer types.RequestPayer + // Specifies the customer-provided encryption key for Amazon S3 to use to decrypt + // the source object. The encryption key provided in this header must be one that + // was used when the source object was created. + CopySourceSSECustomerKey *string - // The date and time when you want the copied object's Object Lock to expire. - ObjectLockRetainUntilDate *time.Time + // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. + // Amazon S3 uses this header for a message integrity check to ensure that the + // encryption key was transmitted without error. + CopySourceSSECustomerKeyMD5 *string // The date and time at which the object is no longer cacheable. Expires *time.Time - // The tag-set for the object destination object this value must be used in - // conjunction with the TaggingDirective. The tag-set must be encoded as URL Query - // parameters. - Tagging *string + // Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object. + GrantFullControl *string - // If the bucket is configured as a website, redirects requests for this object to - // another object in the same bucket or to an external URL. Amazon S3 stores the - // value of this header in the object metadata. - WebsiteRedirectLocation *string + // Allows grantee to read the object data and its metadata. + GrantRead *string + + // Allows grantee to read the object ACL. + GrantReadACP *string // Allows grantee to write the ACL for the applicable object. GrantWriteACP *string - // Specifies caching behavior along the request/reply chain. - CacheControl *string - - // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. - // Amazon S3 uses this header for a message integrity check to ensure that the - // encryption key was transmitted without error. - SSECustomerKeyMD5 *string + // A map of metadata to store with the object in S3. + Metadata map[string]*string - // The name of the source bucket and key name of the source object, separated by a - // slash (/). Must be URL-encoded. - // - // This member is required. - CopySource *string + // Specifies whether the metadata is copied from the source object or replaced with + // metadata provided in the request. + MetadataDirective types.MetadataDirective - // Specifies the customer-provided encryption key for Amazon S3 to use to decrypt - // the source object. The encryption key provided in this header must be one that - // was used when the source object was created. - CopySourceSSECustomerKey *string + // Specifies whether you want to apply a Legal Hold to the copied object. + ObjectLockLegalHoldStatus types.ObjectLockLegalHoldStatus - // The type of storage to use for the object. Defaults to 'STANDARD'. - StorageClass types.StorageClass + // The Object Lock mode that you want to apply to the copied object. + ObjectLockMode types.ObjectLockMode - // Copies the object if it has been modified since the specified time. - CopySourceIfModifiedSince *time.Time + // The date and time when you want the copied object's Object Lock to expire. + ObjectLockRetainUntilDate *time.Time - // The canned ACL to apply to the object. - ACL types.ObjectCannedACL + // Confirms that the requester knows that they will be charged for the request. + // Bucket owners need not specify this parameter in their requests. For information + // about downloading objects from requester pays buckets, see Downloading Objects + // in Requestor Pays Buckets + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in the Amazon S3 Developer Guide. + RequestPayer types.RequestPayer - // Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object. - GrantFullControl *string + // Specifies the algorithm to use to when encrypting the object (for example, + // AES256). + SSECustomerAlgorithm *string - // Copies the object if its entity tag (ETag) is different than the specified ETag. - CopySourceIfNoneMatch *string + // Specifies the customer-provided encryption key for Amazon S3 to use in + // encrypting data. This value is used to store the object and then it is + // discarded; Amazon S3 does not store the encryption key. The key must be + // appropriate for use with the algorithm specified in the + // x-amz-server-side-encryption-customer-algorithm header. + SSECustomerKey *string - // A map of metadata to store with the object in S3. - Metadata map[string]*string + // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. + // Amazon S3 uses this header for a message integrity check to ensure that the + // encryption key was transmitted without error. + SSECustomerKeyMD5 *string // Specifies the AWS KMS Encryption Context to use for object encryption. The value // of this header is a base64-encoded UTF-8 string holding JSON with the encryption // context key-value pairs. SSEKMSEncryptionContext *string + // Specifies the AWS KMS key ID to use for object encryption. All GET and PUT + // requests for an object protected by AWS KMS will fail if not made via SSL or + // using SigV4. For information about configuring using any of the officially + // supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request + // Authentication + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version) + // in the Amazon S3 Developer Guide. + SSEKMSKeyId *string + // The server-side encryption algorithm used when storing this object in Amazon S3 // (for example, AES256, aws:kms). ServerSideEncryption types.ServerSideEncryption - // Specifies whether the metadata is copied from the source object or replaced with - // metadata provided in the request. - MetadataDirective types.MetadataDirective + // The type of storage to use for the object. Defaults to 'STANDARD'. + StorageClass types.StorageClass - // The Object Lock mode that you want to apply to the copied object. - ObjectLockMode types.ObjectLockMode + // The tag-set for the object destination object this value must be used in + // conjunction with the TaggingDirective. The tag-set must be encoded as URL Query + // parameters. + Tagging *string + + // Specifies whether the object tag-set are copied from the source object or + // replaced with tag-set provided in the request. + TaggingDirective types.TaggingDirective + + // If the bucket is configured as a website, redirects requests for this object to + // another object in the same bucket or to an external URL. Amazon S3 stores the + // value of this header in the object metadata. + WebsiteRedirectLocation *string } type CopyObjectOutput struct { + // Container for all response elements. + CopyObjectResult *types.CopyObjectResult + + // Version of the copied object in the destination bucket. + CopySourceVersionId *string + + // If the object expiration is configured, the response includes this header. + Expiration *string + + // If present, indicates that the requester was successfully charged for the + // request. + RequestCharged types.RequestCharged + // If server-side encryption with a customer-provided encryption key was requested, // the response will include this header confirming the encryption algorithm used. SSECustomerAlgorithm *string @@ -339,36 +352,23 @@ type CopyObjectOutput struct { // verification of the customer-provided encryption key. SSECustomerKeyMD5 *string + // If present, specifies the AWS KMS Encryption Context to use for object + // encryption. The value of this header is a base64-encoded UTF-8 string holding + // JSON with the encryption context key-value pairs. + SSEKMSEncryptionContext *string + // If present, specifies the ID of the AWS Key Management Service (AWS KMS) // symmetric customer managed customer master key (CMK) that was used for the // object. SSEKMSKeyId *string - // Version of the copied object in the destination bucket. - CopySourceVersionId *string - // The server-side encryption algorithm used when storing this object in Amazon S3 // (for example, AES256, aws:kms). ServerSideEncryption types.ServerSideEncryption - // Container for all response elements. - CopyObjectResult *types.CopyObjectResult - - // If present, specifies the AWS KMS Encryption Context to use for object - // encryption. The value of this header is a base64-encoded UTF-8 string holding - // JSON with the encryption context key-value pairs. - SSEKMSEncryptionContext *string - - // If present, indicates that the requester was successfully charged for the - // request. - RequestCharged types.RequestCharged - // Version ID of the newly created copy. VersionId *string - // If the object expiration is configured, the response includes this header. - Expiration *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/s3/api_op_CreateBucket.go b/service/s3/api_op_CreateBucket.go index 35c6a15533e..5f588183382 100644 --- a/service/s3/api_op_CreateBucket.go +++ b/service/s3/api_op_CreateBucket.go @@ -142,35 +142,35 @@ func (c *Client) CreateBucket(ctx context.Context, params *CreateBucketInput, op type CreateBucketInput struct { - // Allows grantee to create, overwrite, and delete any object in the bucket. - GrantWrite *string - - // Specifies whether you want S3 Object Lock to be enabled for the new bucket. - ObjectLockEnabledForBucket *bool + // The name of the bucket to create. + // + // This member is required. + Bucket *string // The canned ACL to apply to the bucket. ACL types.BucketCannedACL - // Allows grantee to write the ACL for the applicable bucket. - GrantWriteACP *string + // The configuration information for the bucket. + CreateBucketConfiguration *types.CreateBucketConfiguration + + // Allows grantee the read, write, read ACP, and write ACP permissions on the + // bucket. + GrantFullControl *string // Allows grantee to list the objects in the bucket. GrantRead *string - // The configuration information for the bucket. - CreateBucketConfiguration *types.CreateBucketConfiguration - // Allows grantee to read the bucket ACL. GrantReadACP *string - // Allows grantee the read, write, read ACP, and write ACP permissions on the - // bucket. - GrantFullControl *string + // Allows grantee to create, overwrite, and delete any object in the bucket. + GrantWrite *string - // The name of the bucket to create. - // - // This member is required. - Bucket *string + // Allows grantee to write the ACL for the applicable bucket. + GrantWriteACP *string + + // Specifies whether you want S3 Object Lock to be enabled for the new bucket. + ObjectLockEnabledForBucket *bool } type CreateBucketOutput struct { diff --git a/service/s3/api_op_CreateMultipartUpload.go b/service/s3/api_op_CreateMultipartUpload.go index 5ef2b12dd0f..26c07c3326b 100644 --- a/service/s3/api_op_CreateMultipartUpload.go +++ b/service/s3/api_op_CreateMultipartUpload.go @@ -198,70 +198,62 @@ func (c *Client) CreateMultipartUpload(ctx context.Context, params *CreateMultip type CreateMultipartUploadInput struct { - // The server-side encryption algorithm used when storing this object in Amazon S3 - // (for example, AES256, aws:kms). - ServerSideEncryption types.ServerSideEncryption - - // If the bucket is configured as a website, redirects requests for this object to - // another object in the same bucket or to an external URL. Amazon S3 stores the - // value of this header in the object metadata. - WebsiteRedirectLocation *string - - // Allows grantee to write the ACL for the applicable object. - GrantWriteACP *string + // The name of the bucket to which to initiate the upload + // + // This member is required. + Bucket *string - // The tag-set for the object. The tag-set must be encoded as URL Query parameters. - Tagging *string + // Object key for which the multipart upload is to be initiated. + // + // This member is required. + Key *string // The canned ACL to apply to the object. ACL types.ObjectCannedACL + // Specifies caching behavior along the request/reply chain. + CacheControl *string + + // Specifies presentational information for the object. + ContentDisposition *string + + // Specifies what content encodings have been applied to the object and thus what + // decoding mechanisms must be applied to obtain the media-type referenced by the + // Content-Type header field. + ContentEncoding *string + + // The language the content is in. + ContentLanguage *string + + // A standard MIME type describing the format of the object data. + ContentType *string + // The date and time at which the object is no longer cacheable. Expires *time.Time - // Specifies the algorithm to use to when encrypting the object (for example, - // AES256). - SSECustomerAlgorithm *string + // Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object. + GrantFullControl *string - // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. - // Amazon S3 uses this header for a message integrity check to ensure that the - // encryption key was transmitted without error. - SSECustomerKeyMD5 *string + // Allows grantee to read the object data and its metadata. + GrantRead *string // Allows grantee to read the object ACL. GrantReadACP *string - // Object key for which the multipart upload is to be initiated. - // - // This member is required. - Key *string + // Allows grantee to write the ACL for the applicable object. + GrantWriteACP *string + + // A map of metadata to store with the object in S3. + Metadata map[string]*string // Specifies whether you want to apply a Legal Hold to the uploaded object. ObjectLockLegalHoldStatus types.ObjectLockLegalHoldStatus - // Specifies caching behavior along the request/reply chain. - CacheControl *string - - // A standard MIME type describing the format of the object data. - ContentType *string - // Specifies the Object Lock mode that you want to apply to the uploaded object. ObjectLockMode types.ObjectLockMode - // Specifies the ID of the symmetric customer managed AWS KMS CMK to use for object - // encryption. All GET and PUT requests for an object protected by AWS KMS will - // fail if not made via SSL or using SigV4. For information about configuring using - // any of the officially supported AWS SDKs and AWS CLI, see Specifying the - // Signature Version in Request Authentication - // (https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version) - // in the Amazon S3 Developer Guide. - SSEKMSKeyId *string - - // The language the content is in. - ContentLanguage *string - - // Allows grantee to read the object data and its metadata. - GrantRead *string + // Specifies the date and time when you want the Object Lock to expire. + ObjectLockRetainUntilDate *time.Time // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information @@ -271,16 +263,9 @@ type CreateMultipartUploadInput struct { // in the Amazon S3 Developer Guide. RequestPayer types.RequestPayer - // Specifies the date and time when you want the Object Lock to expire. - ObjectLockRetainUntilDate *time.Time - - // The name of the bucket to which to initiate the upload - // - // This member is required. - Bucket *string - - // Specifies presentational information for the object. - ContentDisposition *string + // Specifies the algorithm to use to when encrypting the object (for example, + // AES256). + SSECustomerAlgorithm *string // Specifies the customer-provided encryption key for Amazon S3 to use in // encrypting data. This value is used to store the object and then it is @@ -289,32 +274,59 @@ type CreateMultipartUploadInput struct { // x-amz-server-side-encryption-customer-algorithm header. SSECustomerKey *string - // Specifies what content encodings have been applied to the object and thus what - // decoding mechanisms must be applied to obtain the media-type referenced by the - // Content-Type header field. - ContentEncoding *string - - // The type of storage to use for the object. Defaults to 'STANDARD'. - StorageClass types.StorageClass - - // A map of metadata to store with the object in S3. - Metadata map[string]*string - - // Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object. - GrantFullControl *string + // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. + // Amazon S3 uses this header for a message integrity check to ensure that the + // encryption key was transmitted without error. + SSECustomerKeyMD5 *string // Specifies the AWS KMS Encryption Context to use for object encryption. The value // of this header is a base64-encoded UTF-8 string holding JSON with the encryption // context key-value pairs. SSEKMSEncryptionContext *string + + // Specifies the ID of the symmetric customer managed AWS KMS CMK to use for object + // encryption. All GET and PUT requests for an object protected by AWS KMS will + // fail if not made via SSL or using SigV4. For information about configuring using + // any of the officially supported AWS SDKs and AWS CLI, see Specifying the + // Signature Version in Request Authentication + // (https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version) + // in the Amazon S3 Developer Guide. + SSEKMSKeyId *string + + // The server-side encryption algorithm used when storing this object in Amazon S3 + // (for example, AES256, aws:kms). + ServerSideEncryption types.ServerSideEncryption + + // The type of storage to use for the object. Defaults to 'STANDARD'. + StorageClass types.StorageClass + + // The tag-set for the object. The tag-set must be encoded as URL Query parameters. + Tagging *string + + // If the bucket is configured as a website, redirects requests for this object to + // another object in the same bucket or to an external URL. Amazon S3 stores the + // value of this header in the object metadata. + WebsiteRedirectLocation *string } type CreateMultipartUploadOutput struct { - // If server-side encryption with a customer-provided encryption key was requested, - // the response will include this header to provide round-trip message integrity - // verification of the customer-provided encryption key. - SSECustomerKeyMD5 *string + // If the bucket has a lifecycle rule configured with an action to abort incomplete + // multipart uploads and the prefix in the lifecycle rule matches the object name + // in the request, the response includes this header. The header indicates when the + // initiated multipart upload becomes eligible for an abort operation. For more + // information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle + // Policy + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config). + //

      The response also includes the x-amz-abort-rule-id header that + // provides the ID of the lifecycle configuration rule that defines this + // action.

      + AbortDate *time.Time + + // This header is returned along with the x-amz-abort-date header. It identifies + // the applicable lifecycle configuration rule that defines the action to abort + // incomplete multipart uploads. + AbortRuleId *string // Name of the bucket to which the multipart upload was initiated. When using this // API with an access point, you must direct requests to the access point hostname. @@ -327,19 +339,31 @@ type CreateMultipartUploadOutput struct { // the Amazon Simple Storage Service Developer Guide. Bucket *string - // If present, specifies the AWS KMS Encryption Context to use for object - // encryption. The value of this header is a base64-encoded UTF-8 string holding - // JSON with the encryption context key-value pairs. - SSEKMSEncryptionContext *string + // Object key for which the multipart upload was initiated. + Key *string + + // If present, indicates that the requester was successfully charged for the + // request. + RequestCharged types.RequestCharged // If server-side encryption with a customer-provided encryption key was requested, // the response will include this header confirming the encryption algorithm used. SSECustomerAlgorithm *string - // This header is returned along with the x-amz-abort-date header. It identifies - // the applicable lifecycle configuration rule that defines the action to abort - // incomplete multipart uploads. - AbortRuleId *string + // If server-side encryption with a customer-provided encryption key was requested, + // the response will include this header to provide round-trip message integrity + // verification of the customer-provided encryption key. + SSECustomerKeyMD5 *string + + // If present, specifies the AWS KMS Encryption Context to use for object + // encryption. The value of this header is a base64-encoded UTF-8 string holding + // JSON with the encryption context key-value pairs. + SSEKMSEncryptionContext *string + + // If present, specifies the ID of the AWS Key Management Service (AWS KMS) + // symmetric customer managed customer master key (CMK) that was used for the + // object. + SSEKMSKeyId *string // The server-side encryption algorithm used when storing this object in Amazon S3 // (for example, AES256, aws:kms). @@ -348,30 +372,6 @@ type CreateMultipartUploadOutput struct { // ID for the initiated multipart upload. UploadId *string - // If present, indicates that the requester was successfully charged for the - // request. - RequestCharged types.RequestCharged - - // If the bucket has a lifecycle rule configured with an action to abort incomplete - // multipart uploads and the prefix in the lifecycle rule matches the object name - // in the request, the response includes this header. The header indicates when the - // initiated multipart upload becomes eligible for an abort operation. For more - // information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle - // Policy - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config). - //

      The response also includes the x-amz-abort-rule-id header that - // provides the ID of the lifecycle configuration rule that defines this - // action.

      - AbortDate *time.Time - - // Object key for which the multipart upload was initiated. - Key *string - - // If present, specifies the ID of the AWS Key Management Service (AWS KMS) - // symmetric customer managed customer master key (CMK) that was used for the - // object. - SSEKMSKeyId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/s3/api_op_DeleteBucketInventoryConfiguration.go b/service/s3/api_op_DeleteBucketInventoryConfiguration.go index b286760ddf3..c14f40ab512 100644 --- a/service/s3/api_op_DeleteBucketInventoryConfiguration.go +++ b/service/s3/api_op_DeleteBucketInventoryConfiguration.go @@ -78,15 +78,15 @@ func (c *Client) DeleteBucketInventoryConfiguration(ctx context.Context, params type DeleteBucketInventoryConfigurationInput struct { - // The ID used to identify the inventory configuration. + // The name of the bucket containing the inventory configuration to delete. // // This member is required. - Id *string + Bucket *string - // The name of the bucket containing the inventory configuration to delete. + // The ID used to identify the inventory configuration. // // This member is required. - Bucket *string + Id *string } type DeleteBucketInventoryConfigurationOutput struct { diff --git a/service/s3/api_op_DeleteObject.go b/service/s3/api_op_DeleteObject.go index 402a6064763..7b92453e235 100644 --- a/service/s3/api_op_DeleteObject.go +++ b/service/s3/api_op_DeleteObject.go @@ -82,14 +82,33 @@ func (c *Client) DeleteObject(ctx context.Context, params *DeleteObjectInput, op type DeleteObjectInput struct { - // VersionId used to reference a specific version of the object. - VersionId *string + // The bucket name of the bucket containing the object. When using this API with an + // access point, you must direct requests to the access point hostname. The access + // point hostname takes the form + // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this + // operation using an access point through the AWS SDKs, you provide the access + // point ARN in place of the bucket name. For more information about access point + // ARNs, see Using Access Points + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) in + // the Amazon Simple Storage Service Developer Guide. + // + // This member is required. + Bucket *string // Key name of the object to delete. // // This member is required. Key *string + // Indicates whether S3 Object Lock should bypass Governance-mode restrictions to + // process this operation. + BypassGovernanceRetention *bool + + // The concatenation of the authentication device's serial number, a space, and the + // value that is displayed on your authentication device. Required to permanently + // delete a versioned object if versioning is configured with MFA delete enabled. + MFA *string + // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from requester pays buckets, see Downloading Objects @@ -98,42 +117,23 @@ type DeleteObjectInput struct { // in the Amazon S3 Developer Guide. RequestPayer types.RequestPayer - // The concatenation of the authentication device's serial number, a space, and the - // value that is displayed on your authentication device. Required to permanently - // delete a versioned object if versioning is configured with MFA delete enabled. - MFA *string - - // Indicates whether S3 Object Lock should bypass Governance-mode restrictions to - // process this operation. - BypassGovernanceRetention *bool - - // The bucket name of the bucket containing the object. When using this API with an - // access point, you must direct requests to the access point hostname. The access - // point hostname takes the form - // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this - // operation using an access point through the AWS SDKs, you provide the access - // point ARN in place of the bucket name. For more information about access point - // ARNs, see Using Access Points - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) in - // the Amazon Simple Storage Service Developer Guide. - // - // This member is required. - Bucket *string + // VersionId used to reference a specific version of the object. + VersionId *string } type DeleteObjectOutput struct { - // Returns the version ID of the delete marker created as a result of the DELETE - // operation. - VersionId *string + // Specifies whether the versioned object that was permanently deleted was (true) + // or was not (false) a delete marker. + DeleteMarker *bool // If present, indicates that the requester was successfully charged for the // request. RequestCharged types.RequestCharged - // Specifies whether the versioned object that was permanently deleted was (true) - // or was not (false) a delete marker. - DeleteMarker *bool + // Returns the version ID of the delete marker created as a result of the DELETE + // operation. + VersionId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/s3/api_op_DeleteObjectTagging.go b/service/s3/api_op_DeleteObjectTagging.go index 56f5150a9cc..bccd9a762c0 100644 --- a/service/s3/api_op_DeleteObjectTagging.go +++ b/service/s3/api_op_DeleteObjectTagging.go @@ -69,14 +69,6 @@ func (c *Client) DeleteObjectTagging(ctx context.Context, params *DeleteObjectTa type DeleteObjectTaggingInput struct { - // The versionId of the object that the tag-set will be removed from. - VersionId *string - - // Name of the tag. - // - // This member is required. - Key *string - // The bucket name containing the objects from which to remove the tags. When using // this API with an access point, you must direct requests to the access point // hostname. The access point hostname takes the form @@ -89,6 +81,14 @@ type DeleteObjectTaggingInput struct { // // This member is required. Bucket *string + + // Name of the tag. + // + // This member is required. + Key *string + + // The versionId of the object that the tag-set will be removed from. + VersionId *string } type DeleteObjectTaggingOutput struct { diff --git a/service/s3/api_op_DeleteObjects.go b/service/s3/api_op_DeleteObjects.go index 844746970e7..50a84f2cd71 100644 --- a/service/s3/api_op_DeleteObjects.go +++ b/service/s3/api_op_DeleteObjects.go @@ -88,24 +88,6 @@ func (c *Client) DeleteObjects(ctx context.Context, params *DeleteObjectsInput, type DeleteObjectsInput struct { - // Confirms that the requester knows that they will be charged for the request. - // Bucket owners need not specify this parameter in their requests. For information - // about downloading objects from requester pays buckets, see Downloading Objects - // in Requestor Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) - // in the Amazon S3 Developer Guide. - RequestPayer types.RequestPayer - - // Specifies whether you want to delete this object even if it has a - // Governance-type Object Lock in place. You must have sufficient permissions to - // perform this operation. - BypassGovernanceRetention *bool - - // Container for the request. - // - // This member is required. - Delete *types.Delete - // The bucket name containing the objects to delete. When using this API with an // access point, you must direct requests to the access point hostname. The access // point hostname takes the form @@ -119,10 +101,28 @@ type DeleteObjectsInput struct { // This member is required. Bucket *string + // Container for the request. + // + // This member is required. + Delete *types.Delete + + // Specifies whether you want to delete this object even if it has a + // Governance-type Object Lock in place. You must have sufficient permissions to + // perform this operation. + BypassGovernanceRetention *bool + // The concatenation of the authentication device's serial number, a space, and the // value that is displayed on your authentication device. Required to permanently // delete a versioned object if versioning is configured with MFA delete enabled. MFA *string + + // Confirms that the requester knows that they will be charged for the request. + // Bucket owners need not specify this parameter in their requests. For information + // about downloading objects from requester pays buckets, see Downloading Objects + // in Requestor Pays Buckets + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in the Amazon S3 Developer Guide. + RequestPayer types.RequestPayer } type DeleteObjectsOutput struct { @@ -131,14 +131,14 @@ type DeleteObjectsOutput struct { // successfully deleted. Deleted []*types.DeletedObject - // If present, indicates that the requester was successfully charged for the - // request. - RequestCharged types.RequestCharged - // Container for a failed delete operation that describes the object that Amazon S3 // attempted to delete and the error it encountered. Errors []*types.Error + // If present, indicates that the requester was successfully charged for the + // request. + RequestCharged types.RequestCharged + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/s3/api_op_GetBucketInventoryConfiguration.go b/service/s3/api_op_GetBucketInventoryConfiguration.go index c968184660b..05309b42372 100644 --- a/service/s3/api_op_GetBucketInventoryConfiguration.go +++ b/service/s3/api_op_GetBucketInventoryConfiguration.go @@ -75,15 +75,15 @@ func (c *Client) GetBucketInventoryConfiguration(ctx context.Context, params *Ge type GetBucketInventoryConfigurationInput struct { - // The ID used to identify the inventory configuration. + // The name of the bucket containing the inventory configuration to retrieve. // // This member is required. - Id *string + Bucket *string - // The name of the bucket containing the inventory configuration to retrieve. + // The ID used to identify the inventory configuration. // // This member is required. - Bucket *string + Id *string } type GetBucketInventoryConfigurationOutput struct { diff --git a/service/s3/api_op_GetBucketWebsite.go b/service/s3/api_op_GetBucketWebsite.go index 326aeea2349..dc099bbfa21 100644 --- a/service/s3/api_op_GetBucketWebsite.go +++ b/service/s3/api_op_GetBucketWebsite.go @@ -81,16 +81,16 @@ type GetBucketWebsiteInput struct { type GetBucketWebsiteOutput struct { - // Specifies the redirect behavior of all requests to a website endpoint of an - // Amazon S3 bucket. - RedirectAllRequestsTo *types.RedirectAllRequestsTo - // The object key name of the website error document to use for 4XX class errors. ErrorDocument *types.ErrorDocument // The name of the index document for the website (for example index.html). IndexDocument *types.IndexDocument + // Specifies the redirect behavior of all requests to a website endpoint of an + // Amazon S3 bucket. + RedirectAllRequestsTo *types.RedirectAllRequestsTo + // Rules that define when a redirect is applied and the redirect behavior. RoutingRules []*types.RoutingRule diff --git a/service/s3/api_op_GetObject.go b/service/s3/api_op_GetObject.go index 39490a0ad77..267c296595f 100644 --- a/service/s3/api_op_GetObject.go +++ b/service/s3/api_op_GetObject.go @@ -158,19 +158,6 @@ func (c *Client) GetObject(ctx context.Context, params *GetObjectInput, optFns . type GetObjectInput struct { - // Confirms that the requester knows that they will be charged for the request. - // Bucket owners need not specify this parameter in their requests. For information - // about downloading objects from requester pays buckets, see Downloading Objects - // in Requestor Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) - // in the Amazon S3 Developer Guide. - RequestPayer types.RequestPayer - - // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. - // Amazon S3 uses this header for a message integrity check to ensure that the - // encryption key was transmitted without error. - SSECustomerKeyMD5 *string - // The bucket name containing the object. When using this API with an access point, // you must direct requests to the access point hostname. The access point hostname // takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. @@ -183,20 +170,31 @@ type GetObjectInput struct { // This member is required. Bucket *string - // Return the object only if its entity tag (ETag) is different from the one - // specified, otherwise return a 304 (not modified). - IfNoneMatch *string + // Key of the object to get. + // + // This member is required. + Key *string // Return the object only if its entity tag (ETag) is the same as the one // specified, otherwise return a 412 (precondition failed). IfMatch *string - // Specifies the customer-provided encryption key for Amazon S3 to use in - // encrypting data. This value is used to store the object and then it is - // discarded; Amazon S3 does not store the encryption key. The key must be - // appropriate for use with the algorithm specified in the - // x-amz-server-side-encryption-customer-algorithm header. - SSECustomerKey *string + // Return the object only if it has been modified since the specified time, + // otherwise return a 304 (not modified). + IfModifiedSince *time.Time + + // Return the object only if its entity tag (ETag) is different from the one + // specified, otherwise return a 304 (not modified). + IfNoneMatch *string + + // Return the object only if it has not been modified since the specified time, + // otherwise return a 412 (precondition failed). + IfUnmodifiedSince *time.Time + + // Part number of the object being read. This is a positive integer between 1 and + // 10,000. Effectively performs a 'ranged' GET request for the part specified. + // Useful for downloading just a part of an object. + PartNumber *int32 // Downloads the specified range bytes of an object. For more information about the // HTTP Range header, see @@ -205,167 +203,169 @@ type GetObjectInput struct { // doesn't support retrieving multiple ranges of data per GET request. Range *string + // Confirms that the requester knows that they will be charged for the request. + // Bucket owners need not specify this parameter in their requests. For information + // about downloading objects from requester pays buckets, see Downloading Objects + // in Requestor Pays Buckets + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in the Amazon S3 Developer Guide. + RequestPayer types.RequestPayer + + // Sets the Cache-Control header of the response. + ResponseCacheControl *string + // Sets the Content-Disposition header of the response ResponseContentDisposition *string + // Sets the Content-Encoding header of the response. + ResponseContentEncoding *string + // Sets the Content-Language header of the response. ResponseContentLanguage *string - // VersionId used to reference a specific version of the object. - VersionId *string - - // Sets the Content-Encoding header of the response. - ResponseContentEncoding *string + // Sets the Content-Type header of the response. + ResponseContentType *string - // Key of the object to get. - // - // This member is required. - Key *string + // Sets the Expires header of the response. + ResponseExpires *time.Time // Specifies the algorithm to use to when encrypting the object (for example, // AES256). SSECustomerAlgorithm *string - // Return the object only if it has been modified since the specified time, - // otherwise return a 304 (not modified). - IfModifiedSince *time.Time - - // Sets the Cache-Control header of the response. - ResponseCacheControl *string - - // Sets the Expires header of the response. - ResponseExpires *time.Time - - // Sets the Content-Type header of the response. - ResponseContentType *string + // Specifies the customer-provided encryption key for Amazon S3 to use in + // encrypting data. This value is used to store the object and then it is + // discarded; Amazon S3 does not store the encryption key. The key must be + // appropriate for use with the algorithm specified in the + // x-amz-server-side-encryption-customer-algorithm header. + SSECustomerKey *string - // Return the object only if it has not been modified since the specified time, - // otherwise return a 412 (precondition failed). - IfUnmodifiedSince *time.Time + // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. + // Amazon S3 uses this header for a message integrity check to ensure that the + // encryption key was transmitted without error. + SSECustomerKeyMD5 *string - // Part number of the object being read. This is a positive integer between 1 and - // 10,000. Effectively performs a 'ranged' GET request for the part specified. - // Useful for downloading just a part of an object. - PartNumber *int32 + // VersionId used to reference a specific version of the object. + VersionId *string } type GetObjectOutput struct { - // If server-side encryption with a customer-provided encryption key was requested, - // the response will include this header confirming the encryption algorithm used. - SSECustomerAlgorithm *string - - // If present, indicates that the requester was successfully charged for the - // request. - RequestCharged types.RequestCharged - - // Provides information about object restoration operation and expiration time of - // the restored object copy. - Restore *string - - // Last modified date of the object - LastModified *time.Time - - // The server-side encryption algorithm used when storing this object in Amazon S3 - // (for example, AES256, aws:kms). - ServerSideEncryption types.ServerSideEncryption - - // The count of parts this object has. - PartsCount *int32 - - // The portion of the object returned in the response. - ContentRange *string + // Indicates that a range of bytes was specified. + AcceptRanges *string // Object data. Body io.ReadCloser - // If present, specifies the ID of the AWS Key Management Service (AWS KMS) - // symmetric customer managed customer master key (CMK) that was used for the - // object. - SSEKMSKeyId *string - - // The Object Lock mode currently in place for this object. - ObjectLockMode types.ObjectLockMode + // Specifies caching behavior along the request/reply chain. + CacheControl *string - // Indicates that a range of bytes was specified. - AcceptRanges *string + // Specifies presentational information for the object. + ContentDisposition *string // Specifies what content encodings have been applied to the object and thus what // decoding mechanisms must be applied to obtain the media-type referenced by the // Content-Type header field. ContentEncoding *string - // Provides storage class information of the object. Amazon S3 returns this header - // for all objects except for S3 Standard storage class objects. - StorageClass types.StorageClass + // The language the content is in. + ContentLanguage *string - // A map of metadata to store with the object in S3. - Metadata map[string]*string + // Size of the body in bytes. + ContentLength *int64 - // The number of tags, if any, on the object. - TagCount *int32 + // The portion of the object returned in the response. + ContentRange *string + + // A standard MIME type describing the format of the object data. + ContentType *string // Specifies whether the object retrieved was (true) or was not (false) a Delete // Marker. If false, this response header does not appear in the response. DeleteMarker *bool - // This is set to the number of metadata entries not returned in x-amz-meta - // headers. This can happen if you create metadata using an API like SOAP that - // supports more flexible metadata than the REST API. For example, using SOAP, you - // can create metadata whose values are not legal HTTP headers. - MissingMeta *int32 - - // The date and time when this object's Object Lock will expire. - ObjectLockRetainUntilDate *time.Time + // An ETag is an opaque identifier assigned by a web server to a specific version + // of a resource found at a URL. + ETag *string - // The language the content is in. - ContentLanguage *string + // If the object expiration is configured (see PUT Bucket lifecycle), the response + // includes this header. It includes the expiry-date and rule-id key-value pairs + // providing object expiration information. The value of the rule-id is URL + // encoded. + Expiration *string // The date and time at which the object is no longer cacheable. Expires *time.Time - // Size of the body in bytes. - ContentLength *int64 + // Last modified date of the object + LastModified *time.Time - // Specifies presentational information for the object. - ContentDisposition *string + // A map of metadata to store with the object in S3. + Metadata map[string]*string - // Version of the object. - VersionId *string + // This is set to the number of metadata entries not returned in x-amz-meta + // headers. This can happen if you create metadata using an API like SOAP that + // supports more flexible metadata than the REST API. For example, using SOAP, you + // can create metadata whose values are not legal HTTP headers. + MissingMeta *int32 // Indicates whether this object has an active legal hold. This field is only // returned if you have permission to view an object's legal hold status. ObjectLockLegalHoldStatus types.ObjectLockLegalHoldStatus - // A standard MIME type describing the format of the object data. - ContentType *string + // The Object Lock mode currently in place for this object. + ObjectLockMode types.ObjectLockMode - // Specifies caching behavior along the request/reply chain. - CacheControl *string + // The date and time when this object's Object Lock will expire. + ObjectLockRetainUntilDate *time.Time - // If the bucket is configured as a website, redirects requests for this object to - // another object in the same bucket or to an external URL. Amazon S3 stores the - // value of this header in the object metadata. - WebsiteRedirectLocation *string + // The count of parts this object has. + PartsCount *int32 + + // Amazon S3 can return this if your request involves a bucket that is either a + // source or destination in a replication rule. + ReplicationStatus types.ReplicationStatus + + // If present, indicates that the requester was successfully charged for the + // request. + RequestCharged types.RequestCharged + + // Provides information about object restoration operation and expiration time of + // the restored object copy. + Restore *string + + // If server-side encryption with a customer-provided encryption key was requested, + // the response will include this header confirming the encryption algorithm used. + SSECustomerAlgorithm *string // If server-side encryption with a customer-provided encryption key was requested, // the response will include this header to provide round-trip message integrity // verification of the customer-provided encryption key. SSECustomerKeyMD5 *string - // An ETag is an opaque identifier assigned by a web server to a specific version - // of a resource found at a URL. - ETag *string + // If present, specifies the ID of the AWS Key Management Service (AWS KMS) + // symmetric customer managed customer master key (CMK) that was used for the + // object. + SSEKMSKeyId *string - // Amazon S3 can return this if your request involves a bucket that is either a - // source or destination in a replication rule. - ReplicationStatus types.ReplicationStatus + // The server-side encryption algorithm used when storing this object in Amazon S3 + // (for example, AES256, aws:kms). + ServerSideEncryption types.ServerSideEncryption - // If the object expiration is configured (see PUT Bucket lifecycle), the response - // includes this header. It includes the expiry-date and rule-id key-value pairs - // providing object expiration information. The value of the rule-id is URL - // encoded. - Expiration *string + // Provides storage class information of the object. Amazon S3 returns this header + // for all objects except for S3 Standard storage class objects. + StorageClass types.StorageClass + + // The number of tags, if any, on the object. + TagCount *int32 + + // Version of the object. + VersionId *string + + // If the bucket is configured as a website, redirects requests for this object to + // another object in the same bucket or to an external URL. Amazon S3 stores the + // value of this header in the object metadata. + WebsiteRedirectLocation *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/s3/api_op_GetObjectAcl.go b/service/s3/api_op_GetObjectAcl.go index b8df272886d..3162381119b 100644 --- a/service/s3/api_op_GetObjectAcl.go +++ b/service/s3/api_op_GetObjectAcl.go @@ -66,22 +66,6 @@ func (c *Client) GetObjectAcl(ctx context.Context, params *GetObjectAclInput, op type GetObjectAclInput struct { - // VersionId used to reference a specific version of the object. - VersionId *string - - // Confirms that the requester knows that they will be charged for the request. - // Bucket owners need not specify this parameter in their requests. For information - // about downloading objects from requester pays buckets, see Downloading Objects - // in Requestor Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) - // in the Amazon S3 Developer Guide. - RequestPayer types.RequestPayer - - // The key of the object for which to get the ACL information. - // - // This member is required. - Key *string - // The bucket name that contains the object for which to get the ACL information. // When using this API with an access point, you must direct requests to the access // point hostname. The access point hostname takes the form @@ -94,19 +78,35 @@ type GetObjectAclInput struct { // // This member is required. Bucket *string + + // The key of the object for which to get the ACL information. + // + // This member is required. + Key *string + + // Confirms that the requester knows that they will be charged for the request. + // Bucket owners need not specify this parameter in their requests. For information + // about downloading objects from requester pays buckets, see Downloading Objects + // in Requestor Pays Buckets + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in the Amazon S3 Developer Guide. + RequestPayer types.RequestPayer + + // VersionId used to reference a specific version of the object. + VersionId *string } type GetObjectAclOutput struct { - // If present, indicates that the requester was successfully charged for the - // request. - RequestCharged types.RequestCharged + // A list of grants. + Grants []*types.Grant // Container for the bucket owner's display name and ID. Owner *types.Owner - // A list of grants. - Grants []*types.Grant + // If present, indicates that the requester was successfully charged for the + // request. + RequestCharged types.RequestCharged // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/s3/api_op_GetObjectLegalHold.go b/service/s3/api_op_GetObjectLegalHold.go index df5d147048b..efa4bcc9d83 100644 --- a/service/s3/api_op_GetObjectLegalHold.go +++ b/service/s3/api_op_GetObjectLegalHold.go @@ -61,11 +61,6 @@ func (c *Client) GetObjectLegalHold(ctx context.Context, params *GetObjectLegalH type GetObjectLegalHoldInput struct { - // The key name for the object whose Legal Hold status you want to retrieve. - // - // This member is required. - Key *string - // The bucket name containing the object whose Legal Hold status you want to // retrieve. When using this API with an access point, you must direct requests to // the access point hostname. The access point hostname takes the form @@ -79,6 +74,11 @@ type GetObjectLegalHoldInput struct { // This member is required. Bucket *string + // The key name for the object whose Legal Hold status you want to retrieve. + // + // This member is required. + Key *string + // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from requester pays buckets, see Downloading Objects diff --git a/service/s3/api_op_GetObjectRetention.go b/service/s3/api_op_GetObjectRetention.go index fcc7fc512ad..bdc84656e90 100644 --- a/service/s3/api_op_GetObjectRetention.go +++ b/service/s3/api_op_GetObjectRetention.go @@ -61,17 +61,6 @@ func (c *Client) GetObjectRetention(ctx context.Context, params *GetObjectRetent type GetObjectRetentionInput struct { - // Confirms that the requester knows that they will be charged for the request. - // Bucket owners need not specify this parameter in their requests. For information - // about downloading objects from requester pays buckets, see Downloading Objects - // in Requestor Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) - // in the Amazon S3 Developer Guide. - RequestPayer types.RequestPayer - - // The version ID for the object whose retention settings you want to retrieve. - VersionId *string - // The bucket name containing the object whose retention settings you want to // retrieve. When using this API with an access point, you must direct requests to // the access point hostname. The access point hostname takes the form @@ -89,6 +78,17 @@ type GetObjectRetentionInput struct { // // This member is required. Key *string + + // Confirms that the requester knows that they will be charged for the request. + // Bucket owners need not specify this parameter in their requests. For information + // about downloading objects from requester pays buckets, see Downloading Objects + // in Requestor Pays Buckets + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in the Amazon S3 Developer Guide. + RequestPayer types.RequestPayer + + // The version ID for the object whose retention settings you want to retrieve. + VersionId *string } type GetObjectRetentionOutput struct { diff --git a/service/s3/api_op_GetObjectTagging.go b/service/s3/api_op_GetObjectTagging.go index df449ae51ba..ced18e529c4 100644 --- a/service/s3/api_op_GetObjectTagging.go +++ b/service/s3/api_op_GetObjectTagging.go @@ -73,9 +73,6 @@ func (c *Client) GetObjectTagging(ctx context.Context, params *GetObjectTaggingI type GetObjectTaggingInput struct { - // The versionId of the object for which to get the tagging information. - VersionId *string - // The bucket name containing the object for which to get the tagging information. // When using this API with an access point, you must direct requests to the access // point hostname. The access point hostname takes the form @@ -93,6 +90,9 @@ type GetObjectTaggingInput struct { // // This member is required. Key *string + + // The versionId of the object for which to get the tagging information. + VersionId *string } type GetObjectTaggingOutput struct { diff --git a/service/s3/api_op_GetObjectTorrent.go b/service/s3/api_op_GetObjectTorrent.go index cbbd16b4bc5..296b50de56e 100644 --- a/service/s3/api_op_GetObjectTorrent.go +++ b/service/s3/api_op_GetObjectTorrent.go @@ -68,6 +68,11 @@ func (c *Client) GetObjectTorrent(ctx context.Context, params *GetObjectTorrentI type GetObjectTorrentInput struct { + // The name of the bucket containing the object for which to get the torrent files. + // + // This member is required. + Bucket *string + // The object key for which to get the information. // // This member is required. @@ -80,22 +85,17 @@ type GetObjectTorrentInput struct { // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 Developer Guide. RequestPayer types.RequestPayer - - // The name of the bucket containing the object for which to get the torrent files. - // - // This member is required. - Bucket *string } type GetObjectTorrentOutput struct { + // A Bencoded dictionary as defined by the BitTorrent specification + Body io.ReadCloser + // If present, indicates that the requester was successfully charged for the // request. RequestCharged types.RequestCharged - // A Bencoded dictionary as defined by the BitTorrent specification - Body io.ReadCloser - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/s3/api_op_HeadObject.go b/service/s3/api_op_HeadObject.go index 4313dae31df..0c7024850ad 100644 --- a/service/s3/api_op_HeadObject.go +++ b/service/s3/api_op_HeadObject.go @@ -108,29 +108,27 @@ func (c *Client) HeadObject(ctx context.Context, params *HeadObjectInput, optFns type HeadObjectInput struct { - // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. - // Amazon S3 uses this header for a message integrity check to ensure that the - // encryption key was transmitted without error. - SSECustomerKeyMD5 *string - // The name of the bucket containing the object. // // This member is required. Bucket *string - // Confirms that the requester knows that they will be charged for the request. - // Bucket owners need not specify this parameter in their requests. For information - // about downloading objects from requester pays buckets, see Downloading Objects - // in Requestor Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) - // in the Amazon S3 Developer Guide. - RequestPayer types.RequestPayer + // The object key. + // + // This member is required. + Key *string - // Downloads the specified range bytes of an object. For more information about the - // HTTP Range header, see - // http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35 (). Amazon S3 - // doesn't support retrieving multiple ranges of data per GET request. - Range *string + // Return the object only if its entity tag (ETag) is the same as the one + // specified, otherwise return a 412 (precondition failed). + IfMatch *string + + // Return the object only if it has been modified since the specified time, + // otherwise return a 304 (not modified). + IfModifiedSince *time.Time + + // Return the object only if its entity tag (ETag) is different from the one + // specified, otherwise return a 304 (not modified). + IfNoneMatch *string // Return the object only if it has not been modified since the specified time, // otherwise return a 412 (precondition failed). @@ -142,18 +140,23 @@ type HeadObjectInput struct { // object. PartNumber *int32 - // Return the object only if its entity tag (ETag) is different from the one - // specified, otherwise return a 304 (not modified). - IfNoneMatch *string + // Downloads the specified range bytes of an object. For more information about the + // HTTP Range header, see + // http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35 (). Amazon S3 + // doesn't support retrieving multiple ranges of data per GET request. + Range *string - // The object key. - // - // This member is required. - Key *string + // Confirms that the requester knows that they will be charged for the request. + // Bucket owners need not specify this parameter in their requests. For information + // about downloading objects from requester pays buckets, see Downloading Objects + // in Requestor Pays Buckets + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in the Amazon S3 Developer Guide. + RequestPayer types.RequestPayer - // Return the object only if it has been modified since the specified time, - // otherwise return a 304 (not modified). - IfModifiedSince *time.Time + // Specifies the algorithm to use to when encrypting the object (for example, + // AES256). + SSECustomerAlgorithm *string // Specifies the customer-provided encryption key for Amazon S3 to use in // encrypting data. This value is used to store the object and then it is @@ -162,31 +165,85 @@ type HeadObjectInput struct { // x-amz-server-side-encryption-customer-algorithm header. SSECustomerKey *string + // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. + // Amazon S3 uses this header for a message integrity check to ensure that the + // encryption key was transmitted without error. + SSECustomerKeyMD5 *string + // VersionId used to reference a specific version of the object. VersionId *string - - // Return the object only if its entity tag (ETag) is the same as the one - // specified, otherwise return a 412 (precondition failed). - IfMatch *string - - // Specifies the algorithm to use to when encrypting the object (for example, - // AES256). - SSECustomerAlgorithm *string } type HeadObjectOutput struct { - // If server-side encryption with a customer-provided encryption key was requested, - // the response will include this header confirming the encryption algorithm used. - SSECustomerAlgorithm *string + // Indicates that a range of bytes was specified. + AcceptRanges *string + + // Specifies caching behavior along the request/reply chain. + CacheControl *string + + // Specifies presentational information for the object. + ContentDisposition *string + + // Specifies what content encodings have been applied to the object and thus what + // decoding mechanisms must be applied to obtain the media-type referenced by the + // Content-Type header field. + ContentEncoding *string + + // The language the content is in. + ContentLanguage *string + + // Size of the body in bytes. + ContentLength *int64 + + // A standard MIME type describing the format of the object data. + ContentType *string + + // Specifies whether the object retrieved was (true) or was not (false) a Delete + // Marker. If false, this response header does not appear in the response. + DeleteMarker *bool + + // An ETag is an opaque identifier assigned by a web server to a specific version + // of a resource found at a URL. + ETag *string + + // If the object expiration is configured (see PUT Bucket lifecycle), the response + // includes this header. It includes the expiry-date and rule-id key-value pairs + // providing object expiration information. The value of the rule-id is URL + // encoded. + Expiration *string + + // The date and time at which the object is no longer cacheable. + Expires *time.Time // Last modified date of the object LastModified *time.Time - // If server-side encryption with a customer-provided encryption key was requested, - // the response will include this header to provide round-trip message integrity - // verification of the customer-provided encryption key. - SSECustomerKeyMD5 *string + // A map of metadata to store with the object in S3. + Metadata map[string]*string + + // This is set to the number of metadata entries not returned in x-amz-meta + // headers. This can happen if you create metadata using an API like SOAP that + // supports more flexible metadata than the REST API. For example, using SOAP, you + // can create metadata whose values are not legal HTTP headers. + MissingMeta *int32 + + // Specifies whether a legal hold is in effect for this object. This header is only + // returned if the requester has the s3:GetObjectLegalHold permission. This header + // is not returned if the specified version of this object has never had a legal + // hold applied. For more information about S3 Object Lock, see Object Lock + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). + ObjectLockLegalHoldStatus types.ObjectLockLegalHoldStatus + + // The Object Lock mode, if any, that's in effect for this object. This header is + // only returned if the requester has the s3:GetObjectRetention permission. For + // more information about S3 Object Lock, see Object Lock + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). + ObjectLockMode types.ObjectLockMode + + // The date and time when the Object Lock retention period expires. This header is + // only returned if the requester has the s3:GetObjectRetention permission. + ObjectLockRetainUntilDate *time.Time // The count of parts this object has. PartsCount *int32 @@ -214,8 +271,9 @@ type HeadObjectOutput struct { // href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Replication.

      ReplicationStatus types.ReplicationStatus - // A map of metadata to store with the object in S3. - Metadata map[string]*string + // If present, indicates that the requester was successfully charged for the + // request. + RequestCharged types.RequestCharged // If the object is an archived object (an object whose storage class is GLACIER), // the response includes this header if either the archive restoration is in @@ -230,87 +288,14 @@ type HeadObjectOutput struct { // Objects: General Considerations.

      Restore *string - // Specifies what content encodings have been applied to the object and thus what - // decoding mechanisms must be applied to obtain the media-type referenced by the - // Content-Type header field. - ContentEncoding *string - - // If present, indicates that the requester was successfully charged for the - // request. - RequestCharged types.RequestCharged - - // Version of the object. - VersionId *string - - // Specifies caching behavior along the request/reply chain. - CacheControl *string - - // The date and time when the Object Lock retention period expires. This header is - // only returned if the requester has the s3:GetObjectRetention permission. - ObjectLockRetainUntilDate *time.Time - - // If the bucket is configured as a website, redirects requests for this object to - // another object in the same bucket or to an external URL. Amazon S3 stores the - // value of this header in the object metadata. - WebsiteRedirectLocation *string - - // Size of the body in bytes. - ContentLength *int64 - - // The date and time at which the object is no longer cacheable. - Expires *time.Time - - // Specifies whether a legal hold is in effect for this object. This header is only - // returned if the requester has the s3:GetObjectLegalHold permission. This header - // is not returned if the specified version of this object has never had a legal - // hold applied. For more information about S3 Object Lock, see Object Lock - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). - ObjectLockLegalHoldStatus types.ObjectLockLegalHoldStatus - - // This is set to the number of metadata entries not returned in x-amz-meta - // headers. This can happen if you create metadata using an API like SOAP that - // supports more flexible metadata than the REST API. For example, using SOAP, you - // can create metadata whose values are not legal HTTP headers. - MissingMeta *int32 - - // Specifies presentational information for the object. - ContentDisposition *string - - // Specifies whether the object retrieved was (true) or was not (false) a Delete - // Marker. If false, this response header does not appear in the response. - DeleteMarker *bool - - // The language the content is in. - ContentLanguage *string - - // An ETag is an opaque identifier assigned by a web server to a specific version - // of a resource found at a URL. - ETag *string - - // If the object expiration is configured (see PUT Bucket lifecycle), the response - // includes this header. It includes the expiry-date and rule-id key-value pairs - // providing object expiration information. The value of the rule-id is URL - // encoded. - Expiration *string - - // Indicates that a range of bytes was specified. - AcceptRanges *string - - // The Object Lock mode, if any, that's in effect for this object. This header is - // only returned if the requester has the s3:GetObjectRetention permission. For - // more information about S3 Object Lock, see Object Lock - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). - ObjectLockMode types.ObjectLockMode - - // A standard MIME type describing the format of the object data. - ContentType *string + // If server-side encryption with a customer-provided encryption key was requested, + // the response will include this header confirming the encryption algorithm used. + SSECustomerAlgorithm *string - // Provides storage class information of the object. Amazon S3 returns this header - // for all objects except for S3 Standard storage class objects.

      For more - // information, see Storage - // Classes.

      - StorageClass types.StorageClass + // If server-side encryption with a customer-provided encryption key was requested, + // the response will include this header to provide round-trip message integrity + // verification of the customer-provided encryption key. + SSECustomerKeyMD5 *string // If present, specifies the ID of the AWS Key Management Service (AWS KMS) // symmetric customer managed customer master key (CMK) that was used for the @@ -323,6 +308,21 @@ type HeadObjectOutput struct { // when storing this object in Amazon S3 (for example, AES256, aws:kms). ServerSideEncryption types.ServerSideEncryption + // Provides storage class information of the object. Amazon S3 returns this header + // for all objects except for S3 Standard storage class objects.

      For more + // information, see Storage + // Classes.

      + StorageClass types.StorageClass + + // Version of the object. + VersionId *string + + // If the bucket is configured as a website, redirects requests for this object to + // another object in the same bucket or to an external URL. Amazon S3 stores the + // value of this header in the object metadata. + WebsiteRedirectLocation *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/s3/api_op_ListBucketAnalyticsConfigurations.go b/service/s3/api_op_ListBucketAnalyticsConfigurations.go index 5859649130e..588f4ac3483 100644 --- a/service/s3/api_op_ListBucketAnalyticsConfigurations.go +++ b/service/s3/api_op_ListBucketAnalyticsConfigurations.go @@ -95,23 +95,23 @@ type ListBucketAnalyticsConfigurationsInput struct { type ListBucketAnalyticsConfigurationsOutput struct { + // The list of analytics configurations for a bucket. + AnalyticsConfigurationList []*types.AnalyticsConfiguration + // The marker that is used as a starting point for this analytics configuration // list response. This value is present if it was sent in the request. ContinuationToken *string - // NextContinuationToken is sent when isTruncated is true, which indicates that - // there are more analytics configurations to list. The next request must include - // this NextContinuationToken. The token is obfuscated and is not a usable value. - NextContinuationToken *string - - // The list of analytics configurations for a bucket. - AnalyticsConfigurationList []*types.AnalyticsConfiguration - // Indicates whether the returned list of analytics configurations is complete. A // value of true indicates that the list is not complete and the // NextContinuationToken will be provided for a subsequent request. IsTruncated *bool + // NextContinuationToken is sent when isTruncated is true, which indicates that + // there are more analytics configurations to list. The next request must include + // this NextContinuationToken. The token is obfuscated and is not a usable value. + NextContinuationToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/s3/api_op_ListBucketInventoryConfigurations.go b/service/s3/api_op_ListBucketInventoryConfigurations.go index cad1ef33227..2cd23bca239 100644 --- a/service/s3/api_op_ListBucketInventoryConfigurations.go +++ b/service/s3/api_op_ListBucketInventoryConfigurations.go @@ -83,37 +83,37 @@ func (c *Client) ListBucketInventoryConfigurations(ctx context.Context, params * type ListBucketInventoryConfigurationsInput struct { + // The name of the bucket containing the inventory configurations to retrieve. + // + // This member is required. + Bucket *string + // The marker used to continue an inventory configuration listing that has been // truncated. Use the NextContinuationToken from a previously truncated list // response to continue the listing. The continuation token is an opaque value that // Amazon S3 understands. ContinuationToken *string - - // The name of the bucket containing the inventory configurations to retrieve. - // - // This member is required. - Bucket *string } type ListBucketInventoryConfigurationsOutput struct { - // The list of inventory configurations for a bucket. - InventoryConfigurationList []*types.InventoryConfiguration - - // The marker used to continue this inventory configuration listing. Use the - // NextContinuationToken from this response to continue the listing in a subsequent - // request. The continuation token is an opaque value that Amazon S3 understands. - NextContinuationToken *string - // If sent in the request, the marker that is used as a starting point for this // inventory configuration list response. ContinuationToken *string + // The list of inventory configurations for a bucket. + InventoryConfigurationList []*types.InventoryConfiguration + // Tells whether the returned list of inventory configurations is complete. A value // of true indicates that the list is not complete and the NextContinuationToken is // provided for a subsequent request. IsTruncated *bool + // The marker used to continue this inventory configuration listing. Use the + // NextContinuationToken from this response to continue the listing in a subsequent + // request. The continuation token is an opaque value that Amazon S3 understands. + NextContinuationToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/s3/api_op_ListBucketMetricsConfigurations.go b/service/s3/api_op_ListBucketMetricsConfigurations.go index d94e02f96e0..17128539f6e 100644 --- a/service/s3/api_op_ListBucketMetricsConfigurations.go +++ b/service/s3/api_op_ListBucketMetricsConfigurations.go @@ -85,29 +85,20 @@ func (c *Client) ListBucketMetricsConfigurations(ctx context.Context, params *Li type ListBucketMetricsConfigurationsInput struct { + // The name of the bucket containing the metrics configurations to retrieve. + // + // This member is required. + Bucket *string + // The marker that is used to continue a metrics configuration listing that has // been truncated. Use the NextContinuationToken from a previously truncated list // response to continue the listing. The continuation token is an opaque value that // Amazon S3 understands. ContinuationToken *string - - // The name of the bucket containing the metrics configurations to retrieve. - // - // This member is required. - Bucket *string } type ListBucketMetricsConfigurationsOutput struct { - // The list of metrics configurations for a bucket. - MetricsConfigurationList []*types.MetricsConfiguration - - // The marker used to continue a metrics configuration listing that has been - // truncated. Use the NextContinuationToken from a previously truncated list - // response to continue the listing. The continuation token is an opaque value that - // Amazon S3 understands. - NextContinuationToken *string - // The marker that is used as a starting point for this metrics configuration list // response. This value is present if it was sent in the request. ContinuationToken *string @@ -117,6 +108,15 @@ type ListBucketMetricsConfigurationsOutput struct { // NextContinuationToken will be provided for a subsequent request. IsTruncated *bool + // The list of metrics configurations for a bucket. + MetricsConfigurationList []*types.MetricsConfiguration + + // The marker used to continue a metrics configuration listing that has been + // truncated. Use the NextContinuationToken from a previously truncated list + // response to continue the listing. The continuation token is an opaque value that + // Amazon S3 understands. + NextContinuationToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/s3/api_op_ListMultipartUploads.go b/service/s3/api_op_ListMultipartUploads.go index 0083cc31880..c532008cbb1 100644 --- a/service/s3/api_op_ListMultipartUploads.go +++ b/service/s3/api_op_ListMultipartUploads.go @@ -84,6 +84,19 @@ func (c *Client) ListMultipartUploads(ctx context.Context, params *ListMultipart type ListMultipartUploadsInput struct { + // Name of the bucket to which the multipart upload was initiated. When using this + // API with an access point, you must direct requests to the access point hostname. + // The access point hostname takes the form + // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this + // operation using an access point through the AWS SDKs, you provide the access + // point ARN in place of the bucket name. For more information about access point + // ARNs, see Using Access Points + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) in + // the Amazon Simple Storage Service Developer Guide. + // + // This member is required. + Bucket *string + // Character you use to group keys. All keys that contain the same string between // the prefix, if specified, and the first occurrence of the delimiter after the // prefix are grouped under a single result element, CommonPrefixes. If you don't @@ -100,12 +113,6 @@ type ListMultipartUploadsInput struct { // response. EncodingType types.EncodingType - // Lists in-progress uploads only for those keys that begin with the specified - // prefix. You can use prefixes to separate a bucket into different grouping of - // keys. (You can think of using prefix to make groups in the same way you'd use a - // folder in a file system.) - Prefix *string - // Together with upload-id-marker, this parameter specifies the multipart upload // after which listing should begin. If upload-id-marker is not specified, only the // keys lexicographically greater than the specified key-marker will be included in @@ -115,37 +122,38 @@ type ListMultipartUploadsInput struct { // the specified upload-id-marker.

      KeyMarker *string + // Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the + // response body. 1,000 is the maximum number of uploads that can be returned in a + // response. + MaxUploads *int32 + + // Lists in-progress uploads only for those keys that begin with the specified + // prefix. You can use prefixes to separate a bucket into different grouping of + // keys. (You can think of using prefix to make groups in the same way you'd use a + // folder in a file system.) + Prefix *string + // Together with key-marker, specifies the multipart upload after which listing // should begin. If key-marker is not specified, the upload-id-marker parameter is // ignored. Otherwise, any multipart uploads for a key equal to the key-marker // might be included in the list only if they have an upload ID lexicographically // greater than the specified upload-id-marker. UploadIdMarker *string - - // Name of the bucket to which the multipart upload was initiated. When using this - // API with an access point, you must direct requests to the access point hostname. - // The access point hostname takes the form - // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this - // operation using an access point through the AWS SDKs, you provide the access - // point ARN in place of the bucket name. For more information about access point - // ARNs, see Using Access Points - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) in - // the Amazon Simple Storage Service Developer Guide. - // - // This member is required. - Bucket *string - - // Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the - // response body. 1,000 is the maximum number of uploads that can be returned in a - // response. - MaxUploads *int32 } type ListMultipartUploadsOutput struct { - // When a prefix is provided in the request, this field contains the specified - // prefix. The result contains only keys starting with the specified prefix. - Prefix *string + // Name of the bucket to which the multipart upload was initiated. + Bucket *string + + // If you specify a delimiter in the request, then the result returns each distinct + // key prefix containing the delimiter in a CommonPrefixes element. The distinct + // key prefixes are returned in the Prefix child element. + CommonPrefixes []*types.CommonPrefix + + // Contains the delimiter you specified in the request. If you don't specify a + // delimiter in your request, this element is absent from the response. + Delimiter *string // Encoding type used by Amazon S3 to encode object keys in the response. If you // specify encoding-type request parameter, Amazon S3 includes this element in the @@ -154,46 +162,38 @@ type ListMultipartUploadsOutput struct { // Prefix, NextKeyMarker, Key.

      EncodingType types.EncodingType - // Container for elements related to a particular multipart upload. A response can - // contain zero or more Upload elements. - Uploads []*types.MultipartUpload - - // Name of the bucket to which the multipart upload was initiated. - Bucket *string - - // Maximum number of multipart uploads that could have been included in the - // response. - MaxUploads *int32 - - // When a list is truncated, this element specifies the value that should be used - // for the upload-id-marker request parameter in a subsequent request. - NextUploadIdMarker *string - // Indicates whether the returned list of multipart uploads is truncated. A value // of true indicates that the list was truncated. The list can be truncated if the // number of multipart uploads exceeds the limit allowed or specified by max // uploads. IsTruncated *bool - // If you specify a delimiter in the request, then the result returns each distinct - // key prefix containing the delimiter in a CommonPrefixes element. The distinct - // key prefixes are returned in the Prefix child element. - CommonPrefixes []*types.CommonPrefix + // The key at or after which the listing began. + KeyMarker *string + + // Maximum number of multipart uploads that could have been included in the + // response. + MaxUploads *int32 // When a list is truncated, this element specifies the value that should be used // for the key-marker request parameter in a subsequent request. NextKeyMarker *string - // The key at or after which the listing began. - KeyMarker *string + // When a list is truncated, this element specifies the value that should be used + // for the upload-id-marker request parameter in a subsequent request. + NextUploadIdMarker *string - // Contains the delimiter you specified in the request. If you don't specify a - // delimiter in your request, this element is absent from the response. - Delimiter *string + // When a prefix is provided in the request, this field contains the specified + // prefix. The result contains only keys starting with the specified prefix. + Prefix *string // Upload ID after which listing began. UploadIdMarker *string + // Container for elements related to a particular multipart upload. A response can + // contain zero or more Upload elements. + Uploads []*types.MultipartUpload + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/s3/api_op_ListObjectVersions.go b/service/s3/api_op_ListObjectVersions.go index 2efabb22276..5be8bccf9a5 100644 --- a/service/s3/api_op_ListObjectVersions.go +++ b/service/s3/api_op_ListObjectVersions.go @@ -68,12 +68,25 @@ func (c *Client) ListObjectVersions(ctx context.Context, params *ListObjectVersi type ListObjectVersionsInput struct { - // Use this parameter to select only those keys that begin with the specified - // prefix. You can use prefixes to separate a bucket into different groupings of - // keys. (You can think of using prefix to make groups in the same way you'd use a - // folder in a file system.) You can use prefix with delimiter to roll up numerous - // objects into a single result under CommonPrefixes. - Prefix *string + // The bucket name that contains the objects. When using this API with an access + // point, you must direct requests to the access point hostname. The access point + // hostname takes the form + // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this + // operation using an access point through the AWS SDKs, you provide the access + // point ARN in place of the bucket name. For more information about access point + // ARNs, see Using Access Points + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) in + // the Amazon Simple Storage Service Developer Guide. + // + // This member is required. + Bucket *string + + // A delimiter is a character that you specify to group keys. All keys that contain + // the same string between the prefix and the first occurrence of the delimiter are + // grouped under a single result element in CommonPrefixes. These groups are + // counted as one result against the max-keys limitation. These keys are not + // returned elsewhere in the response. + Delimiter *string // Requests Amazon S3 to encode the object keys in the response and specifies the // encoding method to use. An object key may contain any Unicode character; @@ -93,49 +106,39 @@ type ListObjectVersionsInput struct { // the additional keys, see key-marker and version-id-marker. MaxKeys *int32 + // Use this parameter to select only those keys that begin with the specified + // prefix. You can use prefixes to separate a bucket into different groupings of + // keys. (You can think of using prefix to make groups in the same way you'd use a + // folder in a file system.) You can use prefix with delimiter to roll up numerous + // objects into a single result under CommonPrefixes. + Prefix *string + // Specifies the object version you want to start listing from. VersionIdMarker *string - - // The bucket name that contains the objects. When using this API with an access - // point, you must direct requests to the access point hostname. The access point - // hostname takes the form - // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this - // operation using an access point through the AWS SDKs, you provide the access - // point ARN in place of the bucket name. For more information about access point - // ARNs, see Using Access Points - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) in - // the Amazon Simple Storage Service Developer Guide. - // - // This member is required. - Bucket *string - - // A delimiter is a character that you specify to group keys. All keys that contain - // the same string between the prefix and the first occurrence of the delimiter are - // grouped under a single result element in CommonPrefixes. These groups are - // counted as one result against the max-keys limitation. These keys are not - // returned elsewhere in the response. - Delimiter *string } type ListObjectVersionsOutput struct { - // Container for an object that is a delete marker. - DeleteMarkers []*types.DeleteMarkerEntry - // All of the keys rolled up into a common prefix count as a single return when // calculating the number of returns. CommonPrefixes []*types.CommonPrefix - // Selects objects that start with the value supplied by this parameter. - Prefix *string + // Container for an object that is a delete marker. + DeleteMarkers []*types.DeleteMarkerEntry - // When the number of responses exceeds the value of MaxKeys, NextKeyMarker - // specifies the first key not returned that satisfies the search criteria. Use - // this value for the key-marker request parameter in a subsequent request. - NextKeyMarker *string + // The delimiter grouping the included keys. A delimiter is a character that you + // specify to group keys. All keys that contain the same string between the prefix + // and the first occurrence of the delimiter are grouped under a single result + // element in CommonPrefixes. These groups are counted as one result against the + // max-keys limitation. These keys are not returned elsewhere in the response. + Delimiter *string - // Bucket name. - Name *string + // Encoding type used by Amazon S3 to encode object key names in the XML response. + //

      If you specify encoding-type request parameter, Amazon S3 includes this + // element in the response, and returns encoded key name values in the following + // response elements:

      KeyMarker, NextKeyMarker, Prefix, Key, + // and Delimiter.

      + EncodingType types.EncodingType // A flag that indicates whether Amazon S3 returned all of the results that // satisfied the search criteria. If your results were truncated, you can make a @@ -144,15 +147,19 @@ type ListObjectVersionsOutput struct { // the results. IsTruncated *bool - // Encoding type used by Amazon S3 to encode object key names in the XML response. - //

      If you specify encoding-type request parameter, Amazon S3 includes this - // element in the response, and returns encoded key name values in the following - // response elements:

      KeyMarker, NextKeyMarker, Prefix, Key, - // and Delimiter.

      - EncodingType types.EncodingType + // Marks the last key returned in a truncated response. + KeyMarker *string - // Marks the last version of the key returned in a truncated response. - VersionIdMarker *string + // Specifies the maximum number of objects to return. + MaxKeys *int32 + + // Bucket name. + Name *string + + // When the number of responses exceeds the value of MaxKeys, NextKeyMarker + // specifies the first key not returned that satisfies the search criteria. Use + // this value for the key-marker request parameter in a subsequent request. + NextKeyMarker *string // When the number of responses exceeds the value of MaxKeys, NextVersionIdMarker // specifies the first object version not returned that satisfies the search @@ -160,18 +167,11 @@ type ListObjectVersionsOutput struct { // subsequent request. NextVersionIdMarker *string - // Specifies the maximum number of objects to return. - MaxKeys *int32 - - // The delimiter grouping the included keys. A delimiter is a character that you - // specify to group keys. All keys that contain the same string between the prefix - // and the first occurrence of the delimiter are grouped under a single result - // element in CommonPrefixes. These groups are counted as one result against the - // max-keys limitation. These keys are not returned elsewhere in the response. - Delimiter *string + // Selects objects that start with the value supplied by this parameter. + Prefix *string - // Marks the last key returned in a truncated response. - KeyMarker *string + // Marks the last version of the key returned in a truncated response. + VersionIdMarker *string // Container for version information. Versions []*types.ObjectVersion diff --git a/service/s3/api_op_ListObjects.go b/service/s3/api_op_ListObjects.go index 25f5a6b1205..d4277fa52be 100644 --- a/service/s3/api_op_ListObjects.go +++ b/service/s3/api_op_ListObjects.go @@ -70,22 +70,14 @@ func (c *Client) ListObjects(ctx context.Context, params *ListObjectsInput, optF type ListObjectsInput struct { - // Confirms that the requester knows that she or he will be charged for the list - // objects request. Bucket owners need not specify this parameter in their - // requests. - RequestPayer types.RequestPayer - - // Specifies the key to start with when listing objects in a bucket. - Marker *string - - // Limits the response to keys that begin with the specified prefix. - Prefix *string - // The name of the bucket containing the objects. // // This member is required. Bucket *string + // A delimiter is a character you use to group keys. + Delimiter *string + // Requests Amazon S3 to encode the object keys in the response and specifies the // encoding method to use. An object key may contain any Unicode character; // however, XML 1.0 parser cannot parse some characters, such as characters with an @@ -94,45 +86,24 @@ type ListObjectsInput struct { // response. EncodingType types.EncodingType + // Specifies the key to start with when listing objects in a bucket. + Marker *string + // Sets the maximum number of keys returned in the response. By default the API // returns up to 1,000 key names. The response might contain fewer keys but will // never contain more. MaxKeys *int32 - // A delimiter is a character you use to group keys. - Delimiter *string -} - -type ListObjectsOutput struct { - - // Keys that begin with the indicated prefix. + // Limits the response to keys that begin with the specified prefix. Prefix *string - // Indicates where in the bucket listing begins. Marker is included in the response - // if it was sent with the request. - Marker *string - - // Bucket name. - Name *string - - // When response is truncated (the IsTruncated element value in the response is - // true), you can use the key name in this field as marker in the subsequent - // request to get next set of objects. Amazon S3 lists objects in alphabetical - // order Note: This element is returned only if you have delimiter request - // parameter specified. If response does not include the NextMaker and it is - // truncated, you can use the value of the last Key in the response as the marker - // in the subsequent request to get the next set of object keys. - NextMarker *string - - // A flag that indicates whether Amazon S3 returned all of the results that - // satisfied the search criteria. - IsTruncated *bool - - // Encoding type used by Amazon S3 to encode object keys in the response. - EncodingType types.EncodingType + // Confirms that the requester knows that she or he will be charged for the list + // objects request. Bucket owners need not specify this parameter in their + // requests. + RequestPayer types.RequestPayer +} - // Metadata about each object returned. - Contents []*types.Object +type ListObjectsOutput struct { // All of the keys rolled up in a common prefix count as a single return when // calculating the number of returns.

      A response can contain CommonPrefixes @@ -145,8 +116,8 @@ type ListObjectsOutput struct { // single return when calculating the number of returns.

      CommonPrefixes []*types.CommonPrefix - // The maximum number of keys returned in the response body. - MaxKeys *int32 + // Metadata about each object returned. + Contents []*types.Object // Causes keys that contain the same string between the prefix and the first // occurrence of the delimiter to be rolled up into a single result element in the @@ -155,6 +126,35 @@ type ListObjectsOutput struct { // MaxKeys value. Delimiter *string + // Encoding type used by Amazon S3 to encode object keys in the response. + EncodingType types.EncodingType + + // A flag that indicates whether Amazon S3 returned all of the results that + // satisfied the search criteria. + IsTruncated *bool + + // Indicates where in the bucket listing begins. Marker is included in the response + // if it was sent with the request. + Marker *string + + // The maximum number of keys returned in the response body. + MaxKeys *int32 + + // Bucket name. + Name *string + + // When response is truncated (the IsTruncated element value in the response is + // true), you can use the key name in this field as marker in the subsequent + // request to get next set of objects. Amazon S3 lists objects in alphabetical + // order Note: This element is returned only if you have delimiter request + // parameter specified. If response does not include the NextMaker and it is + // truncated, you can use the value of the last Key in the response as the marker + // in the subsequent request to get the next set of object keys. + NextMarker *string + + // Keys that begin with the indicated prefix. + Prefix *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/s3/api_op_ListObjectsV2.go b/service/s3/api_op_ListObjectsV2.go index 07474b8e883..b2e753abf6b 100644 --- a/service/s3/api_op_ListObjectsV2.go +++ b/service/s3/api_op_ListObjectsV2.go @@ -80,30 +80,6 @@ func (c *Client) ListObjectsV2(ctx context.Context, params *ListObjectsV2Input, type ListObjectsV2Input struct { - // Confirms that the requester knows that she or he will be charged for the list - // objects request in V2 style. Bucket owners need not specify this parameter in - // their requests. - RequestPayer types.RequestPayer - - // Sets the maximum number of keys returned in the response. By default the API - // returns up to 1,000 key names. The response might contain fewer keys but will - // never contain more. - MaxKeys *int32 - - // StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts - // listing after this specified key. StartAfter can be any key in the bucket. - StartAfter *string - - // The owner field is not present in listV2 by default, if you want to return owner - // field with each key in the result then set the fetch owner field to true. - FetchOwner *bool - - // Limits the response to keys that begin with the specified prefix. - Prefix *string - - // A delimiter is a character you use to group keys. - Delimiter *string - // Bucket name to list. When using this API with an access point, you must direct // requests to the access point hostname. The access point hostname takes the form // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this @@ -120,18 +96,36 @@ type ListObjectsV2Input struct { // bucket with a token. ContinuationToken is obfuscated and is not a real key. ContinuationToken *string + // A delimiter is a character you use to group keys. + Delimiter *string + // Encoding type used by Amazon S3 to encode object keys in the response. EncodingType types.EncodingType -} -type ListObjectsV2Output struct { + // The owner field is not present in listV2 by default, if you want to return owner + // field with each key in the result then set the fetch owner field to true. + FetchOwner *bool - // If StartAfter was sent with the request, it is included in the response. - StartAfter *string + // Sets the maximum number of keys returned in the response. By default the API + // returns up to 1,000 key names. The response might contain fewer keys but will + // never contain more. + MaxKeys *int32 - // Keys that begin with the indicated prefix. + // Limits the response to keys that begin with the specified prefix. Prefix *string + // Confirms that the requester knows that she or he will be charged for the list + // objects request in V2 style. Bucket owners need not specify this parameter in + // their requests. + RequestPayer types.RequestPayer + + // StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts + // listing after this specified key. StartAfter can be any key in the bucket. + StartAfter *string +} + +type ListObjectsV2Output struct { + // All of the keys rolled up into a common prefix count as a single return when // calculating the number of returns.

      A response can contain // CommonPrefixes only if you specify a delimiter.

      @@ -145,10 +139,11 @@ type ListObjectsV2Output struct { // count as a single return when calculating the number of returns.

      CommonPrefixes []*types.CommonPrefix - // Sets the maximum number of keys returned in the response. By default the API - // returns up to 1,000 key names. The response might contain fewer keys but will - // never contain more. - MaxKeys *int32 + // Metadata about each object returned. + Contents []*types.Object + + // If ContinuationToken was sent with the request, it is included in the response. + ContinuationToken *string // Causes keys that contain the same string between the prefix and the first // occurrence of the delimiter to be rolled up into a single result element in the @@ -157,22 +152,6 @@ type ListObjectsV2Output struct { // MaxKeys value. Delimiter *string - // KeyCount is the number of keys returned with this request. KeyCount will always - // be less than equals to MaxKeys field. Say you ask for 50 keys, your result will - // include less than equals 50 keys - KeyCount *int32 - - // Set to false if all of the results were returned. Set to true if more keys are - // available to return. If the number of results exceeds that specified by MaxKeys, - // all of the results might not be returned. - IsTruncated *bool - - // Metadata about each object returned. - Contents []*types.Object - - // If ContinuationToken was sent with the request, it is included in the response. - ContinuationToken *string - // Encoding type used by Amazon S3 to encode object key names in the XML response. //

      If you specify the encoding-type request parameter, Amazon S3 includes this // element in the response, and returns encoded key name values in the following @@ -180,11 +159,20 @@ type ListObjectsV2Output struct { // StartAfter.

      EncodingType types.EncodingType - // NextContinuationToken is sent when isTruncated is true, which means there are - // more keys in the bucket that can be listed. The next list requests to Amazon S3 - // can be continued with this NextContinuationToken. NextContinuationToken is - // obfuscated and is not a real key - NextContinuationToken *string + // Set to false if all of the results were returned. Set to true if more keys are + // available to return. If the number of results exceeds that specified by MaxKeys, + // all of the results might not be returned. + IsTruncated *bool + + // KeyCount is the number of keys returned with this request. KeyCount will always + // be less than equals to MaxKeys field. Say you ask for 50 keys, your result will + // include less than equals 50 keys + KeyCount *int32 + + // Sets the maximum number of keys returned in the response. By default the API + // returns up to 1,000 key names. The response might contain fewer keys but will + // never contain more. + MaxKeys *int32 // Bucket name. When using this API with an access point, you must direct requests // to the access point hostname. The access point hostname takes the form @@ -196,6 +184,18 @@ type ListObjectsV2Output struct { // the Amazon Simple Storage Service Developer Guide. Name *string + // NextContinuationToken is sent when isTruncated is true, which means there are + // more keys in the bucket that can be listed. The next list requests to Amazon S3 + // can be continued with this NextContinuationToken. NextContinuationToken is + // obfuscated and is not a real key + NextContinuationToken *string + + // Keys that begin with the indicated prefix. + Prefix *string + + // If StartAfter was sent with the request, it is included in the response. + StartAfter *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/s3/api_op_ListParts.go b/service/s3/api_op_ListParts.go index 3d2bf9600a3..b09b81e520d 100644 --- a/service/s3/api_op_ListParts.go +++ b/service/s3/api_op_ListParts.go @@ -80,23 +80,36 @@ func (c *Client) ListParts(ctx context.Context, params *ListPartsInput, optFns . type ListPartsInput struct { - // Specifies the part after which listing should begin. Only parts with higher part - // numbers will be listed. - PartNumberMarker *int32 - - // Sets the maximum number of parts to return. - MaxParts *int32 - - // Upload ID identifying the multipart upload whose parts are being listed. + // Name of the bucket to which the parts are being uploaded. When using this API + // with an access point, you must direct requests to the access point hostname. The + // access point hostname takes the form + // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this + // operation using an access point through the AWS SDKs, you provide the access + // point ARN in place of the bucket name. For more information about access point + // ARNs, see Using Access Points + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) in + // the Amazon Simple Storage Service Developer Guide. // // This member is required. - UploadId *string + Bucket *string // Object key for which the multipart upload was initiated. // // This member is required. Key *string + // Upload ID identifying the multipart upload whose parts are being listed. + // + // This member is required. + UploadId *string + + // Sets the maximum number of parts to return. + MaxParts *int32 + + // Specifies the part after which listing should begin. Only parts with higher part + // numbers will be listed. + PartNumberMarker *int32 + // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from requester pays buckets, see Downloading Objects @@ -104,29 +117,52 @@ type ListPartsInput struct { // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 Developer Guide. RequestPayer types.RequestPayer - - // Name of the bucket to which the parts are being uploaded. When using this API - // with an access point, you must direct requests to the access point hostname. The - // access point hostname takes the form - // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this - // operation using an access point through the AWS SDKs, you provide the access - // point ARN in place of the bucket name. For more information about access point - // ARNs, see Using Access Points - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) in - // the Amazon Simple Storage Service Developer Guide. - // - // This member is required. - Bucket *string } type ListPartsOutput struct { + // If the bucket has a lifecycle rule configured with an action to abort incomplete + // multipart uploads and the prefix in the lifecycle rule matches the object name + // in the request, then the response includes this header indicating when the + // initiated multipart upload will become eligible for abort operation. For more + // information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle + // Policy + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config). + //

      The response will also include the x-amz-abort-rule-id header + // that will provide the ID of the lifecycle configuration rule that defines this + // action.

      + AbortDate *time.Time + + // This header is returned along with the x-amz-abort-date header. It identifies + // applicable lifecycle configuration rule that defines the action to abort + // incomplete multipart uploads. + AbortRuleId *string + + // Name of the bucket to which the multipart upload was initiated. + Bucket *string + // Container element that identifies who initiated the multipart upload. If the // initiator is an AWS account, this element provides the same information as the // Owner element. If the initiator is an IAM User, this element provides the user // ARN and display name. Initiator *types.Initiator + // Indicates whether the returned list of parts is truncated. A true value + // indicates that the list was truncated. A list can be truncated if the number of + // parts exceeds the limit returned in the MaxParts element. + IsTruncated *bool + + // Object key for which the multipart upload was initiated. + Key *string + + // Maximum number of parts that were allowed in the response. + MaxParts *int32 + + // When a list is truncated, this element specifies the last part in the list, as + // well as the value to use for the part-number-marker request parameter in a + // subsequent request. + NextPartNumberMarker *int32 + // Container element that identifies the object owner, after the object is created. // If multipart upload is initiated by an IAM user, this element provides the // parent account ID and display name. @@ -137,56 +173,20 @@ type ListPartsOutput struct { // subsequent request. PartNumberMarker *int32 - // Object key for which the multipart upload was initiated. - Key *string - - // Maximum number of parts that were allowed in the response. - MaxParts *int32 - // Container for elements related to a particular part. A response can contain zero // or more Part elements. Parts []*types.Part - // Upload ID identifying the multipart upload whose parts are being listed. - UploadId *string - - // Name of the bucket to which the multipart upload was initiated. - Bucket *string - - // This header is returned along with the x-amz-abort-date header. It identifies - // applicable lifecycle configuration rule that defines the action to abort - // incomplete multipart uploads. - AbortRuleId *string + // If present, indicates that the requester was successfully charged for the + // request. + RequestCharged types.RequestCharged // Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded // object. StorageClass types.StorageClass - // If the bucket has a lifecycle rule configured with an action to abort incomplete - // multipart uploads and the prefix in the lifecycle rule matches the object name - // in the request, then the response includes this header indicating when the - // initiated multipart upload will become eligible for abort operation. For more - // information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle - // Policy - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config). - //

      The response will also include the x-amz-abort-rule-id header - // that will provide the ID of the lifecycle configuration rule that defines this - // action.

      - AbortDate *time.Time - - // When a list is truncated, this element specifies the last part in the list, as - // well as the value to use for the part-number-marker request parameter in a - // subsequent request. - NextPartNumberMarker *int32 - - // If present, indicates that the requester was successfully charged for the - // request. - RequestCharged types.RequestCharged - - // Indicates whether the returned list of parts is truncated. A true value - // indicates that the list was truncated. A list can be truncated if the number of - // parts exceeds the limit returned in the MaxParts element. - IsTruncated *bool + // Upload ID identifying the multipart upload whose parts are being listed. + UploadId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/s3/api_op_PutBucketAccelerateConfiguration.go b/service/s3/api_op_PutBucketAccelerateConfiguration.go index 8ca131648d9..0a4807d00b9 100644 --- a/service/s3/api_op_PutBucketAccelerateConfiguration.go +++ b/service/s3/api_op_PutBucketAccelerateConfiguration.go @@ -84,15 +84,15 @@ func (c *Client) PutBucketAccelerateConfiguration(ctx context.Context, params *P type PutBucketAccelerateConfigurationInput struct { - // Name of the bucket for which the accelerate configuration is set. + // Container for setting the transfer acceleration state. // // This member is required. - Bucket *string + AccelerateConfiguration *types.AccelerateConfiguration - // Container for setting the transfer acceleration state. + // Name of the bucket for which the accelerate configuration is set. // // This member is required. - AccelerateConfiguration *types.AccelerateConfiguration + Bucket *string } type PutBucketAccelerateConfigurationOutput struct { diff --git a/service/s3/api_op_PutBucketAcl.go b/service/s3/api_op_PutBucketAcl.go index 29d66f65ca2..2de4c61be88 100644 --- a/service/s3/api_op_PutBucketAcl.go +++ b/service/s3/api_op_PutBucketAcl.go @@ -133,14 +133,16 @@ func (c *Client) PutBucketAcl(ctx context.Context, params *PutBucketAclInput, op type PutBucketAclInput struct { - // Contains the elements that set the ACL permissions for an object per grantee. - AccessControlPolicy *types.AccessControlPolicy + // The bucket to which to apply the ACL. + // + // This member is required. + Bucket *string - // Allows grantee to list the objects in the bucket. - GrantRead *string + // The canned ACL to apply to the bucket. + ACL types.BucketCannedACL - // Allows grantee to read the bucket ACL. - GrantReadACP *string + // Contains the elements that set the ACL permissions for an object per grantee. + AccessControlPolicy *types.AccessControlPolicy // The base64-encoded 128-bit MD5 digest of the data. This header must be used as a // message integrity check to verify that the request body was not corrupted in @@ -148,21 +150,19 @@ type PutBucketAclInput struct { // (http://www.ietf.org/rfc/rfc1864.txt) ContentMD5 *string - // The canned ACL to apply to the bucket. - ACL types.BucketCannedACL - - // Allows grantee to create, overwrite, and delete any object in the bucket. - GrantWrite *string - - // The bucket to which to apply the ACL. - // - // This member is required. - Bucket *string - // Allows grantee the read, write, read ACP, and write ACP permissions on the // bucket. GrantFullControl *string + // Allows grantee to list the objects in the bucket. + GrantRead *string + + // Allows grantee to read the bucket ACL. + GrantReadACP *string + + // Allows grantee to create, overwrite, and delete any object in the bucket. + GrantWrite *string + // Allows grantee to write the ACL for the applicable bucket. GrantWriteACP *string } diff --git a/service/s3/api_op_PutBucketAnalyticsConfiguration.go b/service/s3/api_op_PutBucketAnalyticsConfiguration.go index 7e174682732..0ae250f0e7e 100644 --- a/service/s3/api_op_PutBucketAnalyticsConfiguration.go +++ b/service/s3/api_op_PutBucketAnalyticsConfiguration.go @@ -97,11 +97,6 @@ func (c *Client) PutBucketAnalyticsConfiguration(ctx context.Context, params *Pu type PutBucketAnalyticsConfigurationInput struct { - // The ID that identifies the analytics configuration. - // - // This member is required. - Id *string - // The configuration and any analyses for the analytics filter. // // This member is required. @@ -111,6 +106,11 @@ type PutBucketAnalyticsConfigurationInput struct { // // This member is required. Bucket *string + + // The ID that identifies the analytics configuration. + // + // This member is required. + Id *string } type PutBucketAnalyticsConfigurationOutput struct { diff --git a/service/s3/api_op_PutBucketCors.go b/service/s3/api_op_PutBucketCors.go index 4a34ce20b76..623fdf6a51a 100644 --- a/service/s3/api_op_PutBucketCors.go +++ b/service/s3/api_op_PutBucketCors.go @@ -94,6 +94,11 @@ func (c *Client) PutBucketCors(ctx context.Context, params *PutBucketCorsInput, type PutBucketCorsInput struct { + // Specifies the bucket impacted by the corsconfiguration. + // + // This member is required. + Bucket *string + // Describes the cross-origin access configuration for objects in an Amazon S3 // bucket. For more information, see Enabling Cross-Origin Resource Sharing // (https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the Amazon Simple @@ -107,11 +112,6 @@ type PutBucketCorsInput struct { // transit. For more information, go to RFC 1864. // (http://www.ietf.org/rfc/rfc1864.txt) ContentMD5 *string - - // Specifies the bucket impacted by the corsconfiguration. - // - // This member is required. - Bucket *string } type PutBucketCorsOutput struct { diff --git a/service/s3/api_op_PutBucketEncryption.go b/service/s3/api_op_PutBucketEncryption.go index 6b842de9165..9707ce63061 100644 --- a/service/s3/api_op_PutBucketEncryption.go +++ b/service/s3/api_op_PutBucketEncryption.go @@ -78,16 +78,6 @@ func (c *Client) PutBucketEncryption(ctx context.Context, params *PutBucketEncry type PutBucketEncryptionInput struct { - // Specifies the default server-side-encryption configuration. - // - // This member is required. - ServerSideEncryptionConfiguration *types.ServerSideEncryptionConfiguration - - // The base64-encoded 128-bit MD5 digest of the server-side encryption - // configuration. This parameter is auto-populated when using the command from the - // CLI. - ContentMD5 *string - // Specifies default encryption for a bucket using server-side encryption with // Amazon S3-managed keys (SSE-S3) or customer master keys stored in AWS KMS // (SSE-KMS). For information about the Amazon S3 default encryption feature, see @@ -97,6 +87,16 @@ type PutBucketEncryptionInput struct { // // This member is required. Bucket *string + + // Specifies the default server-side-encryption configuration. + // + // This member is required. + ServerSideEncryptionConfiguration *types.ServerSideEncryptionConfiguration + + // The base64-encoded 128-bit MD5 digest of the server-side encryption + // configuration. This parameter is auto-populated when using the command from the + // CLI. + ContentMD5 *string } type PutBucketEncryptionOutput struct { diff --git a/service/s3/api_op_PutBucketInventoryConfiguration.go b/service/s3/api_op_PutBucketInventoryConfiguration.go index 6e17350dfda..ef3c54e7c25 100644 --- a/service/s3/api_op_PutBucketInventoryConfiguration.go +++ b/service/s3/api_op_PutBucketInventoryConfiguration.go @@ -100,11 +100,6 @@ func (c *Client) PutBucketInventoryConfiguration(ctx context.Context, params *Pu type PutBucketInventoryConfigurationInput struct { - // Specifies the inventory configuration. - // - // This member is required. - InventoryConfiguration *types.InventoryConfiguration - // The name of the bucket where the inventory configuration will be stored. // // This member is required. @@ -114,6 +109,11 @@ type PutBucketInventoryConfigurationInput struct { // // This member is required. Id *string + + // Specifies the inventory configuration. + // + // This member is required. + InventoryConfiguration *types.InventoryConfiguration } type PutBucketInventoryConfigurationOutput struct { diff --git a/service/s3/api_op_PutBucketLogging.go b/service/s3/api_op_PutBucketLogging.go index 0f54c269f6f..644ed59706a 100644 --- a/service/s3/api_op_PutBucketLogging.go +++ b/service/s3/api_op_PutBucketLogging.go @@ -91,6 +91,11 @@ func (c *Client) PutBucketLogging(ctx context.Context, params *PutBucketLoggingI type PutBucketLoggingInput struct { + // The name of the bucket for which to set the logging parameters. + // + // This member is required. + Bucket *string + // Container for logging status information. // // This member is required. @@ -98,11 +103,6 @@ type PutBucketLoggingInput struct { // The MD5 hash of the PutBucketLogging request body. ContentMD5 *string - - // The name of the bucket for which to set the logging parameters. - // - // This member is required. - Bucket *string } type PutBucketLoggingOutput struct { diff --git a/service/s3/api_op_PutBucketMetricsConfiguration.go b/service/s3/api_op_PutBucketMetricsConfiguration.go index 32d20fdff20..bb1e8eb071a 100644 --- a/service/s3/api_op_PutBucketMetricsConfiguration.go +++ b/service/s3/api_op_PutBucketMetricsConfiguration.go @@ -88,15 +88,15 @@ type PutBucketMetricsConfigurationInput struct { // This member is required. Bucket *string - // Specifies the metrics configuration. + // The ID used to identify the metrics configuration. // // This member is required. - MetricsConfiguration *types.MetricsConfiguration + Id *string - // The ID used to identify the metrics configuration. + // Specifies the metrics configuration. // // This member is required. - Id *string + MetricsConfiguration *types.MetricsConfiguration } type PutBucketMetricsConfigurationOutput struct { diff --git a/service/s3/api_op_PutBucketNotificationConfiguration.go b/service/s3/api_op_PutBucketNotificationConfiguration.go index 997818d63ff..2de07843098 100644 --- a/service/s3/api_op_PutBucketNotificationConfiguration.go +++ b/service/s3/api_op_PutBucketNotificationConfiguration.go @@ -96,16 +96,16 @@ func (c *Client) PutBucketNotificationConfiguration(ctx context.Context, params type PutBucketNotificationConfigurationInput struct { - // A container for specifying the notification configuration of the bucket. If this - // element is empty, notifications are turned off for the bucket. + // The name of the bucket. // // This member is required. - NotificationConfiguration *types.NotificationConfiguration + Bucket *string - // The name of the bucket. + // A container for specifying the notification configuration of the bucket. If this + // element is empty, notifications are turned off for the bucket. // // This member is required. - Bucket *string + NotificationConfiguration *types.NotificationConfiguration } type PutBucketNotificationConfigurationOutput struct { diff --git a/service/s3/api_op_PutBucketRequestPayment.go b/service/s3/api_op_PutBucketRequestPayment.go index dc7895ee5f2..76d8a985d6e 100644 --- a/service/s3/api_op_PutBucketRequestPayment.go +++ b/service/s3/api_op_PutBucketRequestPayment.go @@ -67,6 +67,11 @@ func (c *Client) PutBucketRequestPayment(ctx context.Context, params *PutBucketR type PutBucketRequestPaymentInput struct { + // The bucket name. + // + // This member is required. + Bucket *string + // Container for Payer. // // This member is required. @@ -77,11 +82,6 @@ type PutBucketRequestPaymentInput struct { // transit. For more information, see RFC 1864 // (http://www.ietf.org/rfc/rfc1864.txt). ContentMD5 *string - - // The bucket name. - // - // This member is required. - Bucket *string } type PutBucketRequestPaymentOutput struct { diff --git a/service/s3/api_op_PutBucketTagging.go b/service/s3/api_op_PutBucketTagging.go index 03b7305347b..a4d42271c4d 100644 --- a/service/s3/api_op_PutBucketTagging.go +++ b/service/s3/api_op_PutBucketTagging.go @@ -96,12 +96,6 @@ func (c *Client) PutBucketTagging(ctx context.Context, params *PutBucketTaggingI type PutBucketTaggingInput struct { - // The base64-encoded 128-bit MD5 digest of the data. You must use this header as a - // message integrity check to verify that the request body was not corrupted in - // transit. For more information, see RFC 1864 - // (http://www.ietf.org/rfc/rfc1864.txt). - ContentMD5 *string - // The bucket name. // // This member is required. @@ -111,6 +105,12 @@ type PutBucketTaggingInput struct { // // This member is required. Tagging *types.Tagging + + // The base64-encoded 128-bit MD5 digest of the data. You must use this header as a + // message integrity check to verify that the request body was not corrupted in + // transit. For more information, see RFC 1864 + // (http://www.ietf.org/rfc/rfc1864.txt). + ContentMD5 *string } type PutBucketTaggingOutput struct { diff --git a/service/s3/api_op_PutBucketVersioning.go b/service/s3/api_op_PutBucketVersioning.go index 8ed8fa65821..77fc187a781 100644 --- a/service/s3/api_op_PutBucketVersioning.go +++ b/service/s3/api_op_PutBucketVersioning.go @@ -82,25 +82,25 @@ func (c *Client) PutBucketVersioning(ctx context.Context, params *PutBucketVersi type PutBucketVersioningInput struct { - // The concatenation of the authentication device's serial number, a space, and the - // value that is displayed on your authentication device. - MFA *string - // The bucket name. // // This member is required. Bucket *string + // Container for setting the versioning state. + // + // This member is required. + VersioningConfiguration *types.VersioningConfiguration + // >The base64-encoded 128-bit MD5 digest of the data. You must use this header as // a message integrity check to verify that the request body was not corrupted in // transit. For more information, see RFC 1864 // (http://www.ietf.org/rfc/rfc1864.txt). ContentMD5 *string - // Container for setting the versioning state. - // - // This member is required. - VersioningConfiguration *types.VersioningConfiguration + // The concatenation of the authentication device's serial number, a space, and the + // value that is displayed on your authentication device. + MFA *string } type PutBucketVersioningOutput struct { diff --git a/service/s3/api_op_PutBucketWebsite.go b/service/s3/api_op_PutBucketWebsite.go index bf973b7e696..44bd114f17d 100644 --- a/service/s3/api_op_PutBucketWebsite.go +++ b/service/s3/api_op_PutBucketWebsite.go @@ -101,16 +101,16 @@ type PutBucketWebsiteInput struct { // This member is required. Bucket *string + // Container for the request. + // + // This member is required. + WebsiteConfiguration *types.WebsiteConfiguration + // The base64-encoded 128-bit MD5 digest of the data. You must use this header as a // message integrity check to verify that the request body was not corrupted in // transit. For more information, see RFC 1864 // (http://www.ietf.org/rfc/rfc1864.txt). ContentMD5 *string - - // Container for the request. - // - // This member is required. - WebsiteConfiguration *types.WebsiteConfiguration } type PutBucketWebsiteOutput struct { diff --git a/service/s3/api_op_PutObject.go b/service/s3/api_op_PutObject.go index e5bfaf91044..b0a0dd30aca 100644 --- a/service/s3/api_op_PutObject.go +++ b/service/s3/api_op_PutObject.go @@ -111,62 +111,56 @@ func (c *Client) PutObject(ctx context.Context, params *PutObjectInput, optFns . type PutObjectInput struct { - // Object data. - Body io.Reader - - // If you don't specify, S3 Standard is the default storage class. Amazon S3 - // supports other storage classes. - StorageClass types.StorageClass + // Bucket name to which the PUT operation was initiated. When using this API with + // an access point, you must direct requests to the access point hostname. The + // access point hostname takes the form + // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this + // operation using an access point through the AWS SDKs, you provide the access + // point ARN in place of the bucket name. For more information about access point + // ARNs, see Using Access Points + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) in + // the Amazon Simple Storage Service Developer Guide. + // + // This member is required. + Bucket *string - // The tag-set for the object. The tag-set must be encoded as URL Query parameters. - // (For example, "Key1=Value1") - Tagging *string + // Object key for which the PUT operation was initiated. + // + // This member is required. + Key *string - // Specifies the AWS KMS Encryption Context to use for object encryption. The value - // of this header is a base64-encoded UTF-8 string holding JSON with the encryption - // context key-value pairs. - SSEKMSEncryptionContext *string + // The canned ACL to apply to the object. For more information, see Canned ACL + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL). + ACL types.ObjectCannedACL - // If the bucket is configured as a website, redirects requests for this object to - // another object in the same bucket or to an external URL. Amazon S3 stores the - // value of this header in the object metadata. For information about object - // metadata, see Object Key and Metadata - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html).

      In the - // following example, the request header sets the redirect to an object - // (anotherPage.html) in the same bucket:

      - // x-amz-website-redirect-location: /anotherPage.html

      In the - // following example, the request header sets the object redirect to another - // website:

      x-amz-website-redirect-location: - // http://www.example.com/

      For more information about website - // hosting in Amazon S3, see Hosting - // Websites on Amazon S3 and How - // to Configure Website Page Redirects.

      - WebsiteRedirectLocation *string + // Object data. + Body io.Reader - // The server-side encryption algorithm used when storing this object in Amazon S3 - // (for example, AES256, aws:kms). - ServerSideEncryption types.ServerSideEncryption + // Can be used to specify caching behavior along the request/reply chain. For more + // information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9 + // (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9). + CacheControl *string - // The date and time at which the object is no longer cacheable. For more - // information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21 - // (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21). - Expires *time.Time + // Specifies presentational information for the object. For more information, see + // http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1 + // (http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1). + ContentDisposition *string - // Allows grantee to write the ACL for the applicable object. - GrantWriteACP *string + // Specifies what content encodings have been applied to the object and thus what + // decoding mechanisms must be applied to obtain the media-type referenced by the + // Content-Type header field. For more information, see + // http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11 + // (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11). + ContentEncoding *string - // Specifies the algorithm to use to when encrypting the object (for example, - // AES256). - SSECustomerAlgorithm *string + // The language the content is in. + ContentLanguage *string - // Specifies the customer-provided encryption key for Amazon S3 to use in - // encrypting data. This value is used to store the object and then it is - // discarded; Amazon S3 does not store the encryption key. The key must be - // appropriate for use with the algorithm specified in the - // x-amz-server-side-encryption-customer-algorithm header. - SSECustomerKey *string + // Size of the body in bytes. This parameter is useful when the size of the body + // cannot be determined automatically. For more information, see + // http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13 + // (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13). + ContentLength *int64 // The base64-encoded 128-bit MD5 digest of the message (without the headers) // according to RFC 1864. This header can be used as a message integrity check to @@ -177,44 +171,41 @@ type PutObjectInput struct { // (https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html). ContentMD5 *string + // A standard MIME type describing the format of the contents. For more + // information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17 + // (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17). + ContentType *string + + // The date and time at which the object is no longer cacheable. For more + // information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21 + // (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21). + Expires *time.Time + // Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object. GrantFullControl *string - // Specifies presentational information for the object. For more information, see - // http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1 - // (http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1). - ContentDisposition *string - - // Bucket name to which the PUT operation was initiated. When using this API with - // an access point, you must direct requests to the access point hostname. The - // access point hostname takes the form - // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this - // operation using an access point through the AWS SDKs, you provide the access - // point ARN in place of the bucket name. For more information about access point - // ARNs, see Using Access Points - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) in - // the Amazon Simple Storage Service Developer Guide. - // - // This member is required. - Bucket *string + // Allows grantee to read the object data and its metadata. + GrantRead *string // Allows grantee to read the object ACL. GrantReadACP *string + // Allows grantee to write the ACL for the applicable object. + GrantWriteACP *string + + // A map of metadata to store with the object in S3. + Metadata map[string]*string + // Specifies whether a legal hold will be applied to this object. For more // information about S3 Object Lock, see Object Lock // (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). ObjectLockLegalHoldStatus types.ObjectLockLegalHoldStatus - // Specifies what content encodings have been applied to the object and thus what - // decoding mechanisms must be applied to obtain the media-type referenced by the - // Content-Type header field. For more information, see - // http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11 - // (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11). - ContentEncoding *string + // The Object Lock mode that you want to apply to this object. + ObjectLockMode types.ObjectLockMode - // A map of metadata to store with the object in S3. - Metadata map[string]*string + // The date and time when you want this object's Object Lock to expire. + ObjectLockRetainUntilDate *time.Time // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information @@ -224,25 +215,27 @@ type PutObjectInput struct { // in the Amazon S3 Developer Guide. RequestPayer types.RequestPayer - // The date and time when you want this object's Object Lock to expire. - ObjectLockRetainUntilDate *time.Time - - // Can be used to specify caching behavior along the request/reply chain. For more - // information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9 - // (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9). - CacheControl *string + // Specifies the algorithm to use to when encrypting the object (for example, + // AES256). + SSECustomerAlgorithm *string - // Size of the body in bytes. This parameter is useful when the size of the body - // cannot be determined automatically. For more information, see - // http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13 - // (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13). - ContentLength *int64 + // Specifies the customer-provided encryption key for Amazon S3 to use in + // encrypting data. This value is used to store the object and then it is + // discarded; Amazon S3 does not store the encryption key. The key must be + // appropriate for use with the algorithm specified in the + // x-amz-server-side-encryption-customer-algorithm header. + SSECustomerKey *string // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. // Amazon S3 uses this header for a message integrity check to ensure that the // encryption key was transmitted without error. SSECustomerKeyMD5 *string + // Specifies the AWS KMS Encryption Context to use for object encryption. The value + // of this header is a base64-encoded UTF-8 string holding JSON with the encryption + // context key-value pairs. + SSEKMSEncryptionContext *string + // If x-amz-server-side-encryption is present and has the value of aws:kms, this // header specifies the ID of the AWS Key Management Service (AWS KMS) symmetrical // customer managed customer master key (CMK) that was used for the object. If the @@ -253,44 +246,52 @@ type PutObjectInput struct { // in AWS to protect the data. SSEKMSKeyId *string - // The Object Lock mode that you want to apply to this object. - ObjectLockMode types.ObjectLockMode - - // Object key for which the PUT operation was initiated. - // - // This member is required. - Key *string - - // The language the content is in. - ContentLanguage *string + // The server-side encryption algorithm used when storing this object in Amazon S3 + // (for example, AES256, aws:kms). + ServerSideEncryption types.ServerSideEncryption - // The canned ACL to apply to the object. For more information, see Canned ACL - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL). - ACL types.ObjectCannedACL + // If you don't specify, S3 Standard is the default storage class. Amazon S3 + // supports other storage classes. + StorageClass types.StorageClass - // A standard MIME type describing the format of the contents. For more - // information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17 - // (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17). - ContentType *string + // The tag-set for the object. The tag-set must be encoded as URL Query parameters. + // (For example, "Key1=Value1") + Tagging *string - // Allows grantee to read the object data and its metadata. - GrantRead *string + // If the bucket is configured as a website, redirects requests for this object to + // another object in the same bucket or to an external URL. Amazon S3 stores the + // value of this header in the object metadata. For information about object + // metadata, see Object Key and Metadata + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html).

      In the + // following example, the request header sets the redirect to an object + // (anotherPage.html) in the same bucket:

      + // x-amz-website-redirect-location: /anotherPage.html

      In the + // following example, the request header sets the object redirect to another + // website:

      x-amz-website-redirect-location: + // http://www.example.com/

      For more information about website + // hosting in Amazon S3, see Hosting + // Websites on Amazon S3 and How + // to Configure Website Page Redirects.

      + WebsiteRedirectLocation *string } type PutObjectOutput struct { - // Version of the object. - VersionId *string + // Entity tag for the uploaded object. + ETag *string + + // If the expiration is configured for the object (see + // PutBucketLifecycleConfiguration ()), the response includes this header. It + // includes the expiry-date and rule-id key-value pairs that provide information + // about object expiration. The value of the rule-id is URL encoded. + Expiration *string // If present, indicates that the requester was successfully charged for the // request. RequestCharged types.RequestCharged - // If x-amz-server-side-encryption is present and has the value of aws:kms, this - // header specifies the ID of the AWS Key Management Service (AWS KMS) symmetric - // customer managed customer master key (CMK) that was used for the object. - SSEKMSKeyId *string - // If server-side encryption with a customer-provided encryption key was requested, // the response will include this header confirming the encryption algorithm used. SSECustomerAlgorithm *string @@ -305,20 +306,19 @@ type PutObjectOutput struct { // JSON with the encryption context key-value pairs. SSEKMSEncryptionContext *string + // If x-amz-server-side-encryption is present and has the value of aws:kms, this + // header specifies the ID of the AWS Key Management Service (AWS KMS) symmetric + // customer managed customer master key (CMK) that was used for the object. + SSEKMSKeyId *string + // If you specified server-side encryption either with an AWS KMS customer master // key (CMK) or Amazon S3-managed encryption key in your PUT request, the response // includes this header. It confirms the encryption algorithm that Amazon S3 used // to encrypt the object. ServerSideEncryption types.ServerSideEncryption - // Entity tag for the uploaded object. - ETag *string - - // If the expiration is configured for the object (see - // PutBucketLifecycleConfiguration ()), the response includes this header. It - // includes the expiry-date and rule-id key-value pairs that provide information - // about object expiration. The value of the rule-id is URL encoded. - Expiration *string + // Version of the object. + VersionId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/s3/api_op_PutObjectAcl.go b/service/s3/api_op_PutObjectAcl.go index 9160f343867..ef48da922f8 100644 --- a/service/s3/api_op_PutObjectAcl.go +++ b/service/s3/api_op_PutObjectAcl.go @@ -131,26 +131,52 @@ func (c *Client) PutObjectAcl(ctx context.Context, params *PutObjectAclInput, op type PutObjectAclInput struct { + // The bucket name that contains the object to which you want to attach the ACL. + // When using this API with an access point, you must direct requests to the access + // point hostname. The access point hostname takes the form + // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this + // operation using an access point through the AWS SDKs, you provide the access + // point ARN in place of the bucket name. For more information about access point + // ARNs, see Using Access Points + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) in + // the Amazon Simple Storage Service Developer Guide. + // + // This member is required. + Bucket *string + + // Key for which the PUT operation was initiated. + // + // This member is required. + Key *string + + // The canned ACL to apply to the object. For more information, see Canned ACL + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL). + ACL types.ObjectCannedACL + + // Contains the elements that set the ACL permissions for an object per grantee. + AccessControlPolicy *types.AccessControlPolicy + // The base64-encoded 128-bit MD5 digest of the data. This header must be used as a // message integrity check to verify that the request body was not corrupted in // transit. For more information, go to RFC 1864.> // (http://www.ietf.org/rfc/rfc1864.txt) ContentMD5 *string + // Allows grantee the read, write, read ACP, and write ACP permissions on the + // bucket. + GrantFullControl *string + + // Allows grantee to list the objects in the bucket. + GrantRead *string + // Allows grantee to read the bucket ACL. GrantReadACP *string - // VersionId used to reference a specific version of the object. - VersionId *string - - // Key for which the PUT operation was initiated. - // - // This member is required. - Key *string + // Allows grantee to create, overwrite, and delete any object in the bucket. + GrantWrite *string - // Allows grantee the read, write, read ACP, and write ACP permissions on the - // bucket. - GrantFullControl *string + // Allows grantee to write the ACL for the applicable bucket. + GrantWriteACP *string // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information @@ -160,34 +186,8 @@ type PutObjectAclInput struct { // in the Amazon S3 Developer Guide. RequestPayer types.RequestPayer - // Contains the elements that set the ACL permissions for an object per grantee. - AccessControlPolicy *types.AccessControlPolicy - - // Allows grantee to list the objects in the bucket. - GrantRead *string - - // Allows grantee to write the ACL for the applicable bucket. - GrantWriteACP *string - - // The bucket name that contains the object to which you want to attach the ACL. - // When using this API with an access point, you must direct requests to the access - // point hostname. The access point hostname takes the form - // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this - // operation using an access point through the AWS SDKs, you provide the access - // point ARN in place of the bucket name. For more information about access point - // ARNs, see Using Access Points - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) in - // the Amazon Simple Storage Service Developer Guide. - // - // This member is required. - Bucket *string - - // Allows grantee to create, overwrite, and delete any object in the bucket. - GrantWrite *string - - // The canned ACL to apply to the object. For more information, see Canned ACL - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL). - ACL types.ObjectCannedACL + // VersionId used to reference a specific version of the object. + VersionId *string } type PutObjectAclOutput struct { diff --git a/service/s3/api_op_PutObjectLegalHold.go b/service/s3/api_op_PutObjectLegalHold.go index 5637d715357..25a64e8f98a 100644 --- a/service/s3/api_op_PutObjectLegalHold.go +++ b/service/s3/api_op_PutObjectLegalHold.go @@ -64,17 +64,31 @@ func (c *Client) PutObjectLegalHold(ctx context.Context, params *PutObjectLegalH type PutObjectLegalHoldInput struct { - // The version ID of the object that you want to place a Legal Hold on. - VersionId *string - - // The MD5 hash for the request body. - ContentMD5 *string + // The bucket name containing the object that you want to place a Legal Hold on. + // When using this API with an access point, you must direct requests to the access + // point hostname. The access point hostname takes the form + // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this + // operation using an access point through the AWS SDKs, you provide the access + // point ARN in place of the bucket name. For more information about access point + // ARNs, see Using Access Points + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) in + // the Amazon Simple Storage Service Developer Guide. + // + // This member is required. + Bucket *string // The key name for the object that you want to place a Legal Hold on. // // This member is required. Key *string + // The MD5 hash for the request body. + ContentMD5 *string + + // Container element for the Legal Hold configuration you want to apply to the + // specified object. + LegalHold *types.ObjectLockLegalHold + // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from requester pays buckets, see Downloading Objects @@ -83,22 +97,8 @@ type PutObjectLegalHoldInput struct { // in the Amazon S3 Developer Guide. RequestPayer types.RequestPayer - // Container element for the Legal Hold configuration you want to apply to the - // specified object. - LegalHold *types.ObjectLockLegalHold - - // The bucket name containing the object that you want to place a Legal Hold on. - // When using this API with an access point, you must direct requests to the access - // point hostname. The access point hostname takes the form - // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this - // operation using an access point through the AWS SDKs, you provide the access - // point ARN in place of the bucket name. For more information about access point - // ARNs, see Using Access Points - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) in - // the Amazon Simple Storage Service Developer Guide. - // - // This member is required. - Bucket *string + // The version ID of the object that you want to place a Legal Hold on. + VersionId *string } type PutObjectLegalHoldOutput struct { diff --git a/service/s3/api_op_PutObjectLockConfiguration.go b/service/s3/api_op_PutObjectLockConfiguration.go index 7c1188c93cb..1db3b388ebd 100644 --- a/service/s3/api_op_PutObjectLockConfiguration.go +++ b/service/s3/api_op_PutObjectLockConfiguration.go @@ -74,9 +74,6 @@ type PutObjectLockConfigurationInput struct { // The MD5 hash for the request body. ContentMD5 *string - // A token to allow Object Lock to be enabled for an existing bucket. - Token *string - // The Object Lock configuration that you want to apply to the specified bucket. ObjectLockConfiguration *types.ObjectLockConfiguration @@ -87,6 +84,9 @@ type PutObjectLockConfigurationInput struct { // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 Developer Guide. RequestPayer types.RequestPayer + + // A token to allow Object Lock to be enabled for an existing bucket. + Token *string } type PutObjectLockConfigurationOutput struct { diff --git a/service/s3/api_op_PutObjectRetention.go b/service/s3/api_op_PutObjectRetention.go index 5793511622b..1405af26d48 100644 --- a/service/s3/api_op_PutObjectRetention.go +++ b/service/s3/api_op_PutObjectRetention.go @@ -64,13 +64,6 @@ func (c *Client) PutObjectRetention(ctx context.Context, params *PutObjectRetent type PutObjectRetentionInput struct { - // The version ID for the object that you want to apply this Object Retention - // configuration to. - VersionId *string - - // The MD5 hash for the request body. - ContentMD5 *string - // The bucket name that contains the object you want to apply this Object Retention // configuration to. When using this API with an access point, you must direct // requests to the access point hostname. The access point hostname takes the form @@ -84,6 +77,18 @@ type PutObjectRetentionInput struct { // This member is required. Bucket *string + // The key name for the object that you want to apply this Object Retention + // configuration to. + // + // This member is required. + Key *string + + // Indicates whether this operation should bypass Governance-mode restrictions. + BypassGovernanceRetention *bool + + // The MD5 hash for the request body. + ContentMD5 *string + // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from requester pays buckets, see Downloading Objects @@ -92,17 +97,12 @@ type PutObjectRetentionInput struct { // in the Amazon S3 Developer Guide. RequestPayer types.RequestPayer - // Indicates whether this operation should bypass Governance-mode restrictions. - BypassGovernanceRetention *bool - - // The key name for the object that you want to apply this Object Retention - // configuration to. - // - // This member is required. - Key *string - // The container element for the Object Retention configuration. Retention *types.ObjectLockRetention + + // The version ID for the object that you want to apply this Object Retention + // configuration to. + VersionId *string } type PutObjectRetentionOutput struct { diff --git a/service/s3/api_op_PutObjectTagging.go b/service/s3/api_op_PutObjectTagging.go index e731e1da983..a616bb242bf 100644 --- a/service/s3/api_op_PutObjectTagging.go +++ b/service/s3/api_op_PutObjectTagging.go @@ -89,9 +89,6 @@ func (c *Client) PutObjectTagging(ctx context.Context, params *PutObjectTaggingI type PutObjectTaggingInput struct { - // The versionId of the object that the tag-set will be added to. - VersionId *string - // The bucket name containing the object. When using this API with an access point, // you must direct requests to the access point hostname. The access point hostname // takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. @@ -104,6 +101,11 @@ type PutObjectTaggingInput struct { // This member is required. Bucket *string + // Name of the tag. + // + // This member is required. + Key *string + // Container for the TagSet and Tag elements // // This member is required. @@ -112,10 +114,8 @@ type PutObjectTaggingInput struct { // The MD5 hash for the request body. ContentMD5 *string - // Name of the tag. - // - // This member is required. - Key *string + // The versionId of the object that the tag-set will be added to. + VersionId *string } type PutObjectTaggingOutput struct { diff --git a/service/s3/api_op_PutPublicAccessBlock.go b/service/s3/api_op_PutPublicAccessBlock.go index 95c1fc3bde7..b9ab632d0da 100644 --- a/service/s3/api_op_PutPublicAccessBlock.go +++ b/service/s3/api_op_PutPublicAccessBlock.go @@ -85,9 +85,6 @@ type PutPublicAccessBlockInput struct { // This member is required. Bucket *string - // The MD5 hash of the PutPublicAccessBlock request body. - ContentMD5 *string - // The PublicAccessBlock configuration that you want to apply to this Amazon S3 // bucket. You can enable the configuration options in any combination. For more // information about when Amazon S3 considers a bucket or object public, see The @@ -97,6 +94,9 @@ type PutPublicAccessBlockInput struct { // // This member is required. PublicAccessBlockConfiguration *types.PublicAccessBlockConfiguration + + // The MD5 hash of the PutPublicAccessBlock request body. + ContentMD5 *string } type PutPublicAccessBlockOutput struct { diff --git a/service/s3/api_op_RestoreObject.go b/service/s3/api_op_RestoreObject.go index bd1db80cce0..cbbb6ee9c7e 100644 --- a/service/s3/api_op_RestoreObject.go +++ b/service/s3/api_op_RestoreObject.go @@ -268,12 +268,6 @@ func (c *Client) RestoreObject(ctx context.Context, params *RestoreObjectInput, type RestoreObjectInput struct { - // VersionId used to reference a specific version of the object. - VersionId *string - - // Container for restore job parameters. - RestoreRequest *types.RestoreRequest - // The bucket name or containing the object to restore. When using this API with an // access point, you must direct requests to the access point hostname. The access // point hostname takes the form @@ -287,6 +281,11 @@ type RestoreObjectInput struct { // This member is required. Bucket *string + // Object key for which the operation was initiated. + // + // This member is required. + Key *string + // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from requester pays buckets, see Downloading Objects @@ -295,22 +294,23 @@ type RestoreObjectInput struct { // in the Amazon S3 Developer Guide. RequestPayer types.RequestPayer - // Object key for which the operation was initiated. - // - // This member is required. - Key *string + // Container for restore job parameters. + RestoreRequest *types.RestoreRequest + + // VersionId used to reference a specific version of the object. + VersionId *string } type RestoreObjectOutput struct { - // Indicates the path in the provided S3 output location where Select results will - // be restored to. - RestoreOutputPath *string - // If present, indicates that the requester was successfully charged for the // request. RequestCharged types.RequestCharged + // Indicates the path in the provided S3 output location where Select results will + // be restored to. + RestoreOutputPath *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/s3/api_op_UploadPart.go b/service/s3/api_op_UploadPart.go index a99b5ce8a23..6a9782b67d4 100644 --- a/service/s3/api_op_UploadPart.go +++ b/service/s3/api_op_UploadPart.go @@ -118,27 +118,38 @@ func (c *Client) UploadPart(ctx context.Context, params *UploadPartInput, optFns type UploadPartInput struct { - // Size of the body in bytes. This parameter is useful when the size of the body - // cannot be determined automatically. - ContentLength *int64 - // Name of the bucket to which the multipart upload was initiated. // // This member is required. Bucket *string - // Specifies the customer-provided encryption key for Amazon S3 to use in - // encrypting data. This value is used to store the object and then it is - // discarded; Amazon S3 does not store the encryption key. The key must be - // appropriate for use with the algorithm specified in the - // x-amz-server-side-encryption-customer-algorithm header. This must be the same - // encryption key specified in the initiate multipart upload request. - SSECustomerKey *string + // Object key for which the multipart upload was initiated. + // + // This member is required. + Key *string - // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. - // Amazon S3 uses this header for a message integrity check to ensure that the - // encryption key was transmitted without error. - SSECustomerKeyMD5 *string + // Part number of part being uploaded. This is a positive integer between 1 and + // 10,000. + // + // This member is required. + PartNumber *int32 + + // Upload ID identifying the multipart upload whose part is being uploaded. + // + // This member is required. + UploadId *string + + // Object data. + Body io.Reader + + // Size of the body in bytes. This parameter is useful when the size of the body + // cannot be determined automatically. + ContentLength *int64 + + // The base64-encoded 128-bit MD5 digest of the part data. This parameter is + // auto-populated when using the command from the CLI. This parameter is required + // if object lock parameters are specified. + ContentMD5 *string // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information @@ -148,60 +159,49 @@ type UploadPartInput struct { // in the Amazon S3 Developer Guide. RequestPayer types.RequestPayer - // The base64-encoded 128-bit MD5 digest of the part data. This parameter is - // auto-populated when using the command from the CLI. This parameter is required - // if object lock parameters are specified. - ContentMD5 *string - // Specifies the algorithm to use to when encrypting the object (for example, // AES256). SSECustomerAlgorithm *string - // Object data. - Body io.Reader - - // Part number of part being uploaded. This is a positive integer between 1 and - // 10,000. - // - // This member is required. - PartNumber *int32 - - // Upload ID identifying the multipart upload whose part is being uploaded. - // - // This member is required. - UploadId *string + // Specifies the customer-provided encryption key for Amazon S3 to use in + // encrypting data. This value is used to store the object and then it is + // discarded; Amazon S3 does not store the encryption key. The key must be + // appropriate for use with the algorithm specified in the + // x-amz-server-side-encryption-customer-algorithm header. This must be the same + // encryption key specified in the initiate multipart upload request. + SSECustomerKey *string - // Object key for which the multipart upload was initiated. - // - // This member is required. - Key *string + // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. + // Amazon S3 uses this header for a message integrity check to ensure that the + // encryption key was transmitted without error. + SSECustomerKeyMD5 *string } type UploadPartOutput struct { - // If present, specifies the ID of the AWS Key Management Service (AWS KMS) - // symmetric customer managed customer master key (CMK) was used for the object. - SSEKMSKeyId *string - - // The server-side encryption algorithm used when storing this object in Amazon S3 - // (for example, AES256, aws:kms). - ServerSideEncryption types.ServerSideEncryption + // Entity tag for the uploaded object. + ETag *string // If present, indicates that the requester was successfully charged for the // request. RequestCharged types.RequestCharged - // Entity tag for the uploaded object. - ETag *string + // If server-side encryption with a customer-provided encryption key was requested, + // the response will include this header confirming the encryption algorithm used. + SSECustomerAlgorithm *string // If server-side encryption with a customer-provided encryption key was requested, // the response will include this header to provide round-trip message integrity // verification of the customer-provided encryption key. SSECustomerKeyMD5 *string - // If server-side encryption with a customer-provided encryption key was requested, - // the response will include this header confirming the encryption algorithm used. - SSECustomerAlgorithm *string + // If present, specifies the ID of the AWS Key Management Service (AWS KMS) + // symmetric customer managed customer master key (CMK) was used for the object. + SSEKMSKeyId *string + + // The server-side encryption algorithm used when storing this object in Amazon S3 + // (for example, AES256, aws:kms). + ServerSideEncryption types.ServerSideEncryption // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/s3/api_op_UploadPartCopy.go b/service/s3/api_op_UploadPartCopy.go index c93ce492213..00c2ae41b49 100644 --- a/service/s3/api_op_UploadPartCopy.go +++ b/service/s3/api_op_UploadPartCopy.go @@ -130,60 +130,73 @@ func (c *Client) UploadPartCopy(ctx context.Context, params *UploadPartCopyInput type UploadPartCopyInput struct { - // Confirms that the requester knows that they will be charged for the request. - // Bucket owners need not specify this parameter in their requests. For information - // about downloading objects from requester pays buckets, see Downloading Objects - // in Requestor Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) - // in the Amazon S3 Developer Guide. - RequestPayer types.RequestPayer - - // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. - // Amazon S3 uses this header for a message integrity check to ensure that the - // encryption key was transmitted without error. - SSECustomerKeyMD5 *string + // The bucket name. + // + // This member is required. + Bucket *string - // Upload ID identifying the multipart upload whose part is being copied. + // The name of the source bucket and key name of the source object, separated by a + // slash (/). Must be URL-encoded. // // This member is required. - UploadId *string + CopySource *string - // Copies the object if it hasn't been modified since the specified time. - CopySourceIfUnmodifiedSince *time.Time + // Object key for which the multipart upload was initiated. + // + // This member is required. + Key *string - // Copies the object if its entity tag (ETag) is different than the specified ETag. - CopySourceIfNoneMatch *string + // Part number of part being copied. This is a positive integer between 1 and + // 10,000. + // + // This member is required. + PartNumber *int32 - // The bucket name. + // Upload ID identifying the multipart upload whose part is being copied. // // This member is required. - Bucket *string + UploadId *string // Copies the object if its entity tag (ETag) matches the specified tag. CopySourceIfMatch *string - // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. - // Amazon S3 uses this header for a message integrity check to ensure that the - // encryption key was transmitted without error. - CopySourceSSECustomerKeyMD5 *string + // Copies the object if it has been modified since the specified time. + CopySourceIfModifiedSince *time.Time - // Part number of part being copied. This is a positive integer between 1 and - // 10,000. - // - // This member is required. - PartNumber *int32 + // Copies the object if its entity tag (ETag) is different than the specified ETag. + CopySourceIfNoneMatch *string + + // Copies the object if it hasn't been modified since the specified time. + CopySourceIfUnmodifiedSince *time.Time + + // The range of bytes to copy from the source object. The range value must use the + // form bytes=first-last, where the first and last are the zero-based byte offsets + // to copy. For example, bytes=0-9 indicates that you want to copy the first 10 + // bytes of the source. You can copy a range only if the source object is greater + // than 5 MB. + CopySourceRange *string + + // Specifies the algorithm to use when decrypting the source object (for example, + // AES256). + CopySourceSSECustomerAlgorithm *string // Specifies the customer-provided encryption key for Amazon S3 to use to decrypt // the source object. The encryption key provided in this header must be one that // was used when the source object was created. CopySourceSSECustomerKey *string - // Specifies the algorithm to use when decrypting the source object (for example, - // AES256). - CopySourceSSECustomerAlgorithm *string + // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. + // Amazon S3 uses this header for a message integrity check to ensure that the + // encryption key was transmitted without error. + CopySourceSSECustomerKeyMD5 *string - // Copies the object if it has been modified since the specified time. - CopySourceIfModifiedSince *time.Time + // Confirms that the requester knows that they will be charged for the request. + // Bucket owners need not specify this parameter in their requests. For information + // about downloading objects from requester pays buckets, see Downloading Objects + // in Requestor Pays Buckets + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in the Amazon S3 Developer Guide. + RequestPayer types.RequestPayer // Specifies the algorithm to use to when encrypting the object (for example, // AES256). @@ -197,56 +210,43 @@ type UploadPartCopyInput struct { // encryption key specified in the initiate multipart upload request. SSECustomerKey *string - // The range of bytes to copy from the source object. The range value must use the - // form bytes=first-last, where the first and last are the zero-based byte offsets - // to copy. For example, bytes=0-9 indicates that you want to copy the first 10 - // bytes of the source. You can copy a range only if the source object is greater - // than 5 MB. - CopySourceRange *string - - // The name of the source bucket and key name of the source object, separated by a - // slash (/). Must be URL-encoded. - // - // This member is required. - CopySource *string - - // Object key for which the multipart upload was initiated. - // - // This member is required. - Key *string + // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. + // Amazon S3 uses this header for a message integrity check to ensure that the + // encryption key was transmitted without error. + SSECustomerKeyMD5 *string } type UploadPartCopyOutput struct { - // If server-side encryption with a customer-provided encryption key was requested, - // the response will include this header to provide round-trip message integrity - // verification of the customer-provided encryption key. - SSECustomerKeyMD5 *string - - // The server-side encryption algorithm used when storing this object in Amazon S3 - // (for example, AES256, aws:kms). - ServerSideEncryption types.ServerSideEncryption - - // If present, specifies the ID of the AWS Key Management Service (AWS KMS) - // symmetric customer managed customer master key (CMK) that was used for the - // object. - SSEKMSKeyId *string - // Container for all response elements. CopyPartResult *types.CopyPartResult - // If present, indicates that the requester was successfully charged for the - // request. - RequestCharged types.RequestCharged - // The version of the source object that was copied, if you have enabled versioning // on the source bucket. CopySourceVersionId *string + // If present, indicates that the requester was successfully charged for the + // request. + RequestCharged types.RequestCharged + // If server-side encryption with a customer-provided encryption key was requested, // the response will include this header confirming the encryption algorithm used. SSECustomerAlgorithm *string + // If server-side encryption with a customer-provided encryption key was requested, + // the response will include this header to provide round-trip message integrity + // verification of the customer-provided encryption key. + SSECustomerKeyMD5 *string + + // If present, specifies the ID of the AWS Key Management Service (AWS KMS) + // symmetric customer managed customer master key (CMK) that was used for the + // object. + SSEKMSKeyId *string + + // The server-side encryption algorithm used when storing this object in Amazon S3 + // (for example, AES256, aws:kms). + ServerSideEncryption types.ServerSideEncryption + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/s3/go.mod b/service/s3/go.mod index 3aec705e331..84025ecf213 100644 --- a/service/s3/go.mod +++ b/service/s3/go.mod @@ -4,8 +4,8 @@ go 1.15 require ( github.com/aws/aws-sdk-go-v2 v0.26.0 - github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v0.1.0 - github.com/aws/aws-sdk-go-v2/service/internal/s3shared v0.1.1 + github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v0.0.0-20200930084954-897dfb99530c + github.com/aws/aws-sdk-go-v2/service/internal/s3shared v0.1.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/s3/internal/configtesting/go.mod b/service/s3/internal/configtesting/go.mod index 19a96638c56..c94657d938d 100644 --- a/service/s3/internal/configtesting/go.mod +++ b/service/s3/internal/configtesting/go.mod @@ -5,12 +5,6 @@ go 1.15 require ( github.com/aws/aws-sdk-go-v2/config v0.1.1 github.com/aws/aws-sdk-go-v2/service/s3 v0.26.0 - github.com/aws/aws-sdk-go-v2 v0.26.0 - github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v0.1.0 - github.com/aws/aws-sdk-go-v2/service/sts v0.26.0 - github.com/aws/aws-sdk-go-v2/credentials v0.1.1 - github.com/aws/aws-sdk-go-v2/ec2imds v0.1.1 - github.com/aws/aws-sdk-go-v2/service/internal/s3shared v0.1.1 ) replace ( @@ -26,3 +20,5 @@ replace github.com/aws/aws-sdk-go-v2/ec2imds => ../../../../ec2imds/ replace github.com/aws/aws-sdk-go-v2/service/internal/s3shared => ../../../../service/internal/s3shared/ replace github.com/aws/aws-sdk-go-v2/service/sts => ../../../../service/sts/ + +replace github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding => ../../../../service/internal/accept-encoding/ diff --git a/service/s3/internal/configtesting/go.sum b/service/s3/internal/configtesting/go.sum index dd42dd76e4a..06d8116d298 100644 --- a/service/s3/internal/configtesting/go.sum +++ b/service/s3/internal/configtesting/go.sum @@ -1,4 +1,3 @@ -github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v0.0.0-20200930084954-897dfb99530c/go.mod h1:GRJ/IvA6A00/2tAw9KgMTM8as5gAlNI0FVCKBc+aRnA= github.com/awslabs/smithy-go v0.0.0-20200930175536-2cd7f70a8c2f/go.mod h1:hPOQwnmBLHsUphH13tVSjQhTAFma0/0XoZGbBcOuABI= github.com/awslabs/smithy-go v0.1.0 h1:yltioxA96yA1Fv+fE+5FFXnbFgw3ngpeEV++TUUktiM= github.com/awslabs/smithy-go v0.1.0/go.mod h1:hPOQwnmBLHsUphH13tVSjQhTAFma0/0XoZGbBcOuABI= diff --git a/service/s3/types/types.go b/service/s3/types/types.go index 3186462275b..2dd11bfaeaa 100644 --- a/service/s3/types/types.go +++ b/service/s3/types/types.go @@ -56,18 +56,23 @@ type AccessControlTranslation struct { // an object must match all of the predicates for the filter to apply. type AnalyticsAndOperator struct { - // The list of tags to use when evaluating an AND predicate. - Tags []*Tag - // The prefix to use when evaluating an AND predicate: The prefix that an object // must have to be included in the metrics results. Prefix *string + + // The list of tags to use when evaluating an AND predicate. + Tags []*Tag } // Specifies the configuration and any analyses for the analytics filter of an // Amazon S3 bucket. type AnalyticsConfiguration struct { + // The ID that identifies the analytics configuration. + // + // This member is required. + Id *string + // Contains data related to access patterns to be collected and made available to // analyze the tradeoffs between different storage classes. // @@ -78,11 +83,6 @@ type AnalyticsConfiguration struct { // exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no // filter is provided, all objects will be considered in any analysis. Filter *AnalyticsFilter - - // The ID that identifies the analytics configuration. - // - // This member is required. - Id *string } // Where to publish the analytics results. @@ -113,24 +113,24 @@ type AnalyticsFilter struct { // Contains information about where to publish the analytics results. type AnalyticsS3BucketDestination struct { - // Specifies the file format used when exporting data to Amazon S3. + // The Amazon Resource Name (ARN) of the bucket to which data is exported. // // This member is required. - Format AnalyticsS3ExportFileFormat - - // The prefix to use when exporting data. The prefix is prepended to all results. - Prefix *string + Bucket *string - // The Amazon Resource Name (ARN) of the bucket to which data is exported. + // Specifies the file format used when exporting data to Amazon S3. // // This member is required. - Bucket *string + Format AnalyticsS3ExportFileFormat // The account ID that owns the destination S3 bucket. If no account ID is // provided, the owner is not validated before exporting data. Although this value // is optional, we strongly recommend that you set it to help prevent problems if // the destination bucket ownership changes. BucketAccountId *string + + // The prefix to use when exporting data. The prefix is prepended to all results. + Prefix *string } // In terms of implementation, a Bucket is a resource. An Amazon S3 bucket name is @@ -201,6 +201,13 @@ type CompletedPart struct { // redirect request to another host where you might process the error. type Condition struct { + // The HTTP error code when the redirect is applied. In the event of an error, if + // the error code equals this value, then the specified redirect is applied. + // Required when parent element Condition is specified and sibling KeyPrefixEquals + // is not specified. If both are specified, then both must be true for the redirect + // to be applied. + HttpErrorCodeReturnedEquals *string + // The object key name prefix when the redirect is applied. For example, to // redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. // To redirect request for all pages with the prefix docs/, the key prefix will be @@ -209,25 +216,18 @@ type Condition struct { // not specified. If both conditions are specified, both must be true for the // redirect to be applied. KeyPrefixEquals *string - - // The HTTP error code when the redirect is applied. In the event of an error, if - // the error code equals this value, then the specified redirect is applied. - // Required when parent element Condition is specified and sibling KeyPrefixEquals - // is not specified. If both are specified, then both must be true for the redirect - // to be applied. - HttpErrorCodeReturnedEquals *string } // Container for all response elements. type CopyObjectResult struct { - // Returns the date that the object was last modified. - LastModified *time.Time - // Returns the ETag of the new object. The ETag reflects only changes to the // contents of an object, not its metadata. The source and destination ETag is // identical for a successfully copied object. ETag *string + + // Returns the date that the object was last modified. + LastModified *time.Time } // Container for all response elements. @@ -256,9 +256,11 @@ type CORSConfiguration struct { // Specifies a cross-origin access rule for an Amazon S3 bucket. type CORSRule struct { - // The time in seconds that your browser is to cache the preflight response for the - // specified resource. - MaxAgeSeconds *int32 + // An HTTP method that you allow the origin to execute. Valid values are GET, PUT, + // HEAD, POST, and DELETE. + // + // This member is required. + AllowedMethods []*string // One or more origins you want customers to be able to access the bucket from. // @@ -270,15 +272,13 @@ type CORSRule struct { // OPTIONS request, Amazon S3 returns any requested headers that are allowed. AllowedHeaders []*string - // An HTTP method that you allow the origin to execute. Valid values are GET, PUT, - // HEAD, POST, and DELETE. - // - // This member is required. - AllowedMethods []*string - // One or more headers in the response that you want customers to be able to access // from their applications (for example, from a JavaScript XMLHttpRequest object). ExposeHeaders []*string + + // The time in seconds that your browser is to cache the preflight response for the + // specified resource. + MaxAgeSeconds *int32 } // The configuration information for the bucket. @@ -293,6 +293,20 @@ type CreateBucketConfiguration struct { // object is formatted. type CSVInput struct { + // Specifies that CSV field values may contain quoted record delimiters and such + // records should be allowed. Default value is FALSE. Setting this value to TRUE + // may lower performance. + AllowQuotedRecordDelimiter *bool + + // A single character used to indicate that a row should be ignored when the + // character is present at the start of that row. You can specify any character to + // indicate a comment line. + Comments *string + + // A single character used to separate individual fields in a record. You can + // specify an arbitrary delimiter. + FieldDelimiter *string + // Describes the first line of input. Valid values are: // // * NONE: First line is @@ -307,20 +321,6 @@ type CSVInput struct { // identify a column in an expression (SELECT "name" FROM OBJECT). FileHeaderInfo FileHeaderInfo - // A single character used to indicate that a row should be ignored when the - // character is present at the start of that row. You can specify any character to - // indicate a comment line. - Comments *string - - // Specifies that CSV field values may contain quoted record delimiters and such - // records should be allowed. Default value is FALSE. Setting this value to TRUE - // may lower performance. - AllowQuotedRecordDelimiter *bool - - // A single character used to separate individual fields in a record. You can - // specify an arbitrary delimiter. - FieldDelimiter *string - // A single character used for escaping when the field delimiter is part of the // value. For example, if the value is a, b, Amazon S3 wraps this field value in // quotation marks, as follows: " a , b ". Type: String Default: " Ancestors: CSV @@ -340,18 +340,18 @@ type CSVInput struct { // formatted. type CSVOutput struct { - // The single character used for escaping the quote character inside an already - // escaped value. - QuoteEscapeCharacter *string + // The value used to separate individual fields in a record. You can specify an + // arbitrary delimiter. + FieldDelimiter *string // A single character used for escaping when the field delimiter is part of the // value. For example, if the value is a, b, Amazon S3 wraps this field value in // quotation marks, as follows: " a , b ". QuoteCharacter *string - // A single character used to separate individual records in the output. Instead of - // the default value, you can specify an arbitrary delimiter. - RecordDelimiter *string + // The single character used for escaping the quote character inside an already + // escaped value. + QuoteEscapeCharacter *string // Indicates whether to use quotation marks around output fields. // @@ -362,22 +362,22 @@ type CSVOutput struct { // marks for output fields when needed. QuoteFields QuoteFields - // The value used to separate individual fields in a record. You can specify an - // arbitrary delimiter. - FieldDelimiter *string + // A single character used to separate individual records in the output. Instead of + // the default value, you can specify an arbitrary delimiter. + RecordDelimiter *string } // The container element for specifying the default Object Lock retention settings // for new objects placed in the specified bucket. type DefaultRetention struct { + // The number of days that you want to specify for the default retention period. + Days *int32 + // The default Object Lock retention mode you want to apply to new objects placed // in the specified bucket. Mode ObjectLockRetentionMode - // The number of days that you want to specify for the default retention period. - Days *int32 - // The number of years that you want to specify for the default retention period. Years *int32 } @@ -398,18 +398,18 @@ type Delete struct { // Information about the deleted object. type DeletedObject struct { - // The name of the deleted object. - Key *string + // Specifies whether the versioned object that was permanently deleted was (true) + // or was not (false) a delete marker. In a simple DELETE, this header indicates + // whether (true) or not (false) a delete marker was created. + DeleteMarker *bool // The version ID of the delete marker created as a result of the DELETE operation. // If you delete a specific object version, the value returned by this header is // the version ID of the object version deleted. DeleteMarkerVersionId *string - // Specifies whether the versioned object that was permanently deleted was (true) - // or was not (false) a delete marker. In a simple DELETE, this header indicates - // whether (true) or not (false) a delete marker was created. - DeleteMarker *bool + // The name of the deleted object. + Key *string // The version ID of the deleted object. VersionId *string @@ -418,8 +418,12 @@ type DeletedObject struct { // Information about the delete marker. type DeleteMarkerEntry struct { - // Version ID of an object. - VersionId *string + // Specifies whether the object is (true) or is not (false) the latest version of + // an object. + IsLatest *bool + + // The object key. + Key *string // Date and time the object was last modified. LastModified *time.Time @@ -427,12 +431,8 @@ type DeleteMarkerEntry struct { // The account that created the delete marker.> Owner *Owner - // Specifies whether the object is (true) or is not (false) the latest version of - // an object. - IsLatest *bool - - // The object key. - Key *string + // Version ID of an object. + VersionId *string } // Specifies whether Amazon S3 replicates the delete markers. If you specify a @@ -459,23 +459,18 @@ type DeleteMarkerReplication struct { // for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC). type Destination struct { - // The storage class to use when replicating objects, such as S3 Standard or - // reduced redundancy. By default, Amazon S3 uses the storage class of the source - // object to create the object replica. For valid values, see the StorageClass - // element of the PUT Bucket replication - // (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) - // action in the Amazon Simple Storage Service API Reference. - StorageClass StorageClass - - // A container specifying replication metrics-related settings enabling metrics and - // Amazon S3 events for S3 Replication Time Control (S3 RTC). Must be specified - // together with a ReplicationTime block. - Metrics *Metrics + // The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store + // the results. + // + // This member is required. + Bucket *string - // A container specifying S3 Replication Time Control (S3 RTC), including whether - // S3 RTC is enabled and the time when all objects and operations on objects must - // be replicated. Must be specified together with a Metrics block. - ReplicationTime *ReplicationTime + // Specify this only in a cross-account scenario (where source and destination + // bucket owners are not the same), and you want to change replica ownership to the + // AWS account that owns the destination bucket. If this is not specified in the + // replication configuration, the replicas are owned by same AWS account that owns + // the source object. + AccessControlTranslation *AccessControlTranslation // Destination bucket owner account ID. In a cross-account scenario, if you direct // Amazon S3 to change replica ownership to the AWS account that owns the @@ -490,23 +485,34 @@ type Destination struct { // SourceSelectionCriteria is specified, you must specify this element. EncryptionConfiguration *EncryptionConfiguration - // The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store - // the results. - // - // This member is required. - Bucket *string + // A container specifying replication metrics-related settings enabling metrics and + // Amazon S3 events for S3 Replication Time Control (S3 RTC). Must be specified + // together with a ReplicationTime block. + Metrics *Metrics - // Specify this only in a cross-account scenario (where source and destination - // bucket owners are not the same), and you want to change replica ownership to the - // AWS account that owns the destination bucket. If this is not specified in the - // replication configuration, the replicas are owned by same AWS account that owns - // the source object. - AccessControlTranslation *AccessControlTranslation + // A container specifying S3 Replication Time Control (S3 RTC), including whether + // S3 RTC is enabled and the time when all objects and operations on objects must + // be replicated. Must be specified together with a Metrics block. + ReplicationTime *ReplicationTime + + // The storage class to use when replicating objects, such as S3 Standard or + // reduced redundancy. By default, Amazon S3 uses the storage class of the source + // object to create the object replica. For valid values, see the StorageClass + // element of the PUT Bucket replication + // (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) + // action in the Amazon Simple Storage Service API Reference. + StorageClass StorageClass } // Contains the type of server-side encryption used. type Encryption struct { + // The server-side encryption algorithm used when storing job results in Amazon S3 + // (for example, AES256, aws:kms). + // + // This member is required. + EncryptionType ServerSideEncryption + // If the encryption type is aws:kms, this optional value can be used to specify // the encryption context for the restore results. KMSContext *string @@ -518,12 +524,6 @@ type Encryption struct { // (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) // in the AWS Key Management Service Developer Guide. KMSKeyId *string - - // The server-side encryption algorithm used when storing job results in Amazon S3 - // (for example, AES256, aws:kms). - // - // This member is required. - EncryptionType ServerSideEncryption } // Specifies encryption-related information for an Amazon S3 bucket that is a @@ -543,9 +543,6 @@ type EncryptionConfiguration struct { // Container for all error elements. type Error struct { - // The error key. - Key *string - // The error code is a string that uniquely identifies an error condition. It is // meant to be read and understood by programs that detect and handle errors by // type. Amazon S3 error codes @@ -1507,6 +1504,9 @@ type Error struct { // * SOAP Fault Code Prefix: Client Code *string + // The error key. + Key *string + // The error message contains a generic description of the error condition in // English. It is intended for a human audience. Simple programs display the // message directly to the end user if they encounter an error condition they don't @@ -1568,18 +1568,20 @@ type GlacierJobParameters struct { // Container for grant information. type Grant struct { - // Specifies the permission given to the grantee. - Permission Permission - // The person being granted permissions. Grantee *Grantee + + // Specifies the permission given to the grantee. + Permission Permission } // Container for the person being granted permissions. type Grantee struct { - // The canonical user ID of the grantee. - ID *string + // Type of grantee + // + // This member is required. + Type Type // Screen name of the grantee. DisplayName *string @@ -1612,13 +1614,11 @@ type Grantee struct { // General Reference. EmailAddress *string + // The canonical user ID of the grantee. + ID *string + // URI of the grantee group. URI *string - - // Type of grantee - // - // This member is required. - Type Type } // Container for the Suffix element. @@ -1637,30 +1637,30 @@ type IndexDocument struct { // Container element that identifies who initiated the multipart upload. type Initiator struct { + // Name of the Principal. + DisplayName *string + // If the principal is an AWS account, it provides the Canonical User ID. If the // principal is an IAM User, it provides a user ARN value. ID *string - - // Name of the Principal. - DisplayName *string } // Describes the serialization format of the object. type InputSerialization struct { + // Describes the serialization of a CSV-encoded object. + CSV *CSVInput + // Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default // Value: NONE. CompressionType CompressionType - // Specifies Parquet as object's input serialization format. - Parquet *ParquetInput - - // Describes the serialization of a CSV-encoded object. - CSV *CSVInput - // Specifies JSON as object's input serialization format. JSON *JSONInput -} + + // Specifies Parquet as object's input serialization format. + Parquet *ParquetInput +} // Specifies the inventory configuration for an Amazon S3 bucket. For more // information, see GET Bucket inventory @@ -1668,9 +1668,6 @@ type InputSerialization struct { // in the Amazon Simple Storage Service API Reference. type InventoryConfiguration struct { - // Contains the optional fields that are included in the inventory results. - OptionalFields []InventoryOptionalField - // Contains information about where to publish the inventory results. // // This member is required. @@ -1681,14 +1678,13 @@ type InventoryConfiguration struct { // This member is required. Id *string - // Specifies an inventory filter. The inventory only includes objects that meet the - // filter's criteria. - Filter *InventoryFilter - - // Specifies the schedule for generating inventory results. + // Object versions to include in the inventory list. If set to All, the list + // includes all the object versions, which adds the version-related fields + // VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list + // does not contain these version-related fields. // // This member is required. - Schedule *InventorySchedule + IncludedObjectVersions InventoryIncludedObjectVersions // Specifies whether the inventory is enabled or disabled. If set to True, an // inventory list is generated. If set to False, no inventory list is generated. @@ -1696,13 +1692,17 @@ type InventoryConfiguration struct { // This member is required. IsEnabled *bool - // Object versions to include in the inventory list. If set to All, the list - // includes all the object versions, which adds the version-related fields - // VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list - // does not contain these version-related fields. + // Specifies the schedule for generating inventory results. // // This member is required. - IncludedObjectVersions InventoryIncludedObjectVersions + Schedule *InventorySchedule + + // Specifies an inventory filter. The inventory only includes objects that meet the + // filter's criteria. + Filter *InventoryFilter + + // Contains the optional fields that are included in the inventory results. + OptionalFields []InventoryOptionalField } // Specifies the inventory configuration for an Amazon S3 bucket. @@ -1719,11 +1719,11 @@ type InventoryDestination struct { // results. type InventoryEncryption struct { - // Specifies the use of SSE-S3 to encrypt delivered inventory reports. - SSES3 *SSES3 - // Specifies the use of SSE-KMS to encrypt delivered inventory reports. SSEKMS *SSEKMS + + // Specifies the use of SSE-S3 to encrypt delivered inventory reports. + SSES3 *SSES3 } // Specifies an inventory filter. The inventory only includes objects that meet the @@ -1746,6 +1746,11 @@ type InventoryS3BucketDestination struct { // This member is required. Bucket *string + // Specifies the output format of the inventory results. + // + // This member is required. + Format InventoryFormat + // The account ID that owns the destination S3 bucket. If no account ID is // provided, the owner is not validated before exporting data. Although this value // is optional, we strongly recommend that you set it to help prevent problems if @@ -1758,11 +1763,6 @@ type InventoryS3BucketDestination struct { // The prefix that is prepended to all inventory results. Prefix *string - - // Specifies the output format of the inventory results. - // - // This member is required. - Format InventoryFormat } // Specifies the schedule for generating inventory results. @@ -1792,16 +1792,6 @@ type JSONOutput struct { // A container for specifying the configuration for AWS Lambda notifications. type LambdaFunctionConfiguration struct { - // The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon S3 invokes - // when the specified event type occurs. - // - // This member is required. - LambdaFunctionArn *string - - // An optional unique identifier for configurations in a notification - // configuration. If you don't provide one, Amazon S3 will assign an ID. - Id *string - // The Amazon S3 bucket event for which to invoke the AWS Lambda function. For more // information, see Supported Event Types // (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the @@ -1810,11 +1800,21 @@ type LambdaFunctionConfiguration struct { // This member is required. Events []Event + // The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon S3 invokes + // when the specified event type occurs. + // + // This member is required. + LambdaFunctionArn *string + // Specifies object key name filtering rules. For information about key name // filtering, see Configuring Event Notifications // (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the // Amazon Simple Storage Service Developer Guide. Filter *NotificationConfigurationFilter + + // An optional unique identifier for configurations in a notification + // configuration. If you don't provide one, Amazon S3 will assign an ID. + Id *string } // Container for the expiration for the lifecycle of the object. @@ -1824,23 +1824,20 @@ type LifecycleExpiration struct { // ISO 8601 Format. Date *time.Time + // Indicates the lifetime, in days, of the objects that are subject to the rule. + // The value must be a non-zero positive integer. + Days *int32 + // Indicates whether Amazon S3 will remove a delete marker with no noncurrent // versions. If set to true, the delete marker will be expired; if set to false the // policy takes no action. This cannot be specified with Days or Date in a // Lifecycle Expiration Policy. ExpiredObjectDeleteMarker *bool - - // Indicates the lifetime, in days, of the objects that are subject to the rule. - // The value must be a non-zero positive integer. - Days *int32 } // A lifecycle rule for individual objects in an Amazon S3 bucket. type LifecycleRule struct { - // Unique identifier for the rule. The value cannot be longer than 255 characters. - ID *string - // If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is // not currently being applied. // @@ -1855,6 +1852,24 @@ type LifecycleRule struct { // in the Amazon Simple Storage Service Developer Guide. AbortIncompleteMultipartUpload *AbortIncompleteMultipartUpload + // Specifies the expiration for the lifecycle of the object in the form of date, + // days and, whether the object has a delete marker. + Expiration *LifecycleExpiration + + // The Filter is used to identify objects that a Lifecycle Rule applies to. A + // Filter must have exactly one of Prefix, Tag, or And specified. + Filter *LifecycleRuleFilter + + // Unique identifier for the rule. The value cannot be longer than 255 characters. + ID *string + + // Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 + // permanently deletes the noncurrent object versions. You set this lifecycle + // configuration action on a bucket that has versioning enabled (or suspended) to + // request that Amazon S3 delete noncurrent object versions at a specific period in + // the object's lifetime. + NoncurrentVersionExpiration *NoncurrentVersionExpiration + // Specifies the transition rule for the lifecycle rule that describes when // noncurrent objects transition to a specific storage class. If your bucket is // versioning-enabled (or versioning is suspended), you can set this action to @@ -1868,21 +1883,6 @@ type LifecycleRule struct { // Specifies when an Amazon S3 object transitions to a specified storage class. Transitions []*Transition - - // The Filter is used to identify objects that a Lifecycle Rule applies to. A - // Filter must have exactly one of Prefix, Tag, or And specified. - Filter *LifecycleRuleFilter - - // Specifies the expiration for the lifecycle of the object in the form of date, - // days and, whether the object has a delete marker. - Expiration *LifecycleExpiration - - // Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 - // permanently deletes the noncurrent object versions. You set this lifecycle - // configuration action on a bucket that has versioning enabled (or suspended) to - // request that Amazon S3 delete noncurrent object versions at a specific period in - // the object's lifetime. - NoncurrentVersionExpiration *NoncurrentVersionExpiration } // This is used in a Lifecycle Rule Filter to apply a logical AND to two or more @@ -1890,12 +1890,12 @@ type LifecycleRule struct { // predicates configured inside the And operator. type LifecycleRuleAndOperator struct { + // Prefix identifying one or more objects to which the rule applies. + Prefix *string + // All of these tags must exist in the object's tag set in order for the rule to // apply. Tags []*Tag - - // Prefix identifying one or more objects to which the rule applies. - Prefix *string } // The Filter is used to identify objects that a Lifecycle Rule applies to. A @@ -1989,15 +1989,15 @@ type MetricsAndOperator struct { // in the Amazon Simple Storage Service API Reference. type MetricsConfiguration struct { - // Specifies a metrics configuration filter. The metrics configuration will only - // include objects that meet the filter's criteria. A filter must be a prefix, a - // tag, or a conjunction (MetricsAndOperator). - Filter *MetricsFilter - // The ID used to identify the metrics configuration. // // This member is required. Id *string + + // Specifies a metrics configuration filter. The metrics configuration will only + // include objects that meet the filter's criteria. A filter must be a prefix, a + // tag, or a conjunction (MetricsAndOperator). + Filter *MetricsFilter } // Specifies a metrics configuration filter. The metrics configuration only @@ -2005,14 +2005,14 @@ type MetricsConfiguration struct { // tag, or a conjunction (MetricsAndOperator). type MetricsFilter struct { - // The prefix used when evaluating a metrics filter. - Prefix *string - // A conjunction (logical AND) of predicates, which is used in evaluating a metrics // filter. The operator must have at least two predicates, and an object must match // all of the predicates in order for the filter to apply. And *MetricsAndOperator + // The prefix used when evaluating a metrics filter. + Prefix *string + // The tag used when evaluating a metrics filter. Tag *Tag } @@ -2020,23 +2020,23 @@ type MetricsFilter struct { // Container for the MultipartUpload for the Amazon S3 object. type MultipartUpload struct { - // Key of the object for which the multipart upload was initiated. - Key *string - - // Upload ID that identifies the multipart upload. - UploadId *string - // Date and time at which the multipart upload was initiated. Initiated *time.Time - // Specifies the owner of the object that is part of the multipart upload. - Owner *Owner - // Identifies who initiated the multipart upload. Initiator *Initiator + // Key of the object for which the multipart upload was initiated. + Key *string + + // Specifies the owner of the object that is part of the multipart upload. + Owner *Owner + // The class of storage used to store the object. StorageClass StorageClass + + // Upload ID that identifies the multipart upload. + UploadId *string } // Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 @@ -2105,25 +2105,25 @@ type NotificationConfigurationFilter struct { // An object consists of data and its descriptive metadata. type Object struct { - // The owner of the object - Owner *Owner + // The entity tag is an MD5 hash of the object. ETag reflects only changes to the + // contents of an object, not its metadata. + ETag *string - // The class of storage used to store the object. - StorageClass ObjectStorageClass + // The name that you assign to an object. You use the object key to retrieve the + // object. + Key *string // The date the Object was Last Modified LastModified *time.Time - // The entity tag is an MD5 hash of the object. ETag reflects only changes to the - // contents of an object, not its metadata. - ETag *string + // The owner of the object + Owner *Owner // Size in bytes of the object Size *int64 - // The name that you assign to an object. You use the object key to retrieve the - // object. - Key *string + // The class of storage used to store the object. + StorageClass ObjectStorageClass } // Object Identifier is unique value to identify objects. @@ -2176,30 +2176,30 @@ type ObjectLockRule struct { // The version of an object. type ObjectVersion struct { - // The class of storage used to store the object. - StorageClass ObjectVersionStorageClass + // The entity tag is an MD5 hash of that version of the object. + ETag *string // Specifies whether the object is (true) or is not (false) the latest version of // an object. IsLatest *bool - // Specifies the owner of the object. - Owner *Owner + // The object key. + Key *string - // The entity tag is an MD5 hash of that version of the object. - ETag *string + // Date and time the object was last modified. + LastModified *time.Time - // Version ID of an object. - VersionId *string + // Specifies the owner of the object. + Owner *Owner // Size in bytes of the object. Size *int64 - // The object key. - Key *string + // The class of storage used to store the object. + StorageClass ObjectVersionStorageClass - // Date and time the object was last modified. - LastModified *time.Time + // Version ID of an object. + VersionId *string } // Describes the location where the restore job's output is stored. @@ -2239,13 +2239,13 @@ type Part struct { // Entity tag returned when the part was uploaded. ETag *string + // Date and time at which the part was uploaded. + LastModified *time.Time + // Part number identifying the part. This is a positive integer between 1 and // 10,000. PartNumber *int32 - // Date and time at which the part was uploaded. - LastModified *time.Time - // Size in bytes of the uploaded part data. Size *int64 } @@ -2266,14 +2266,6 @@ type PolicyStatus struct { // in the Amazon Simple Storage Service Developer Guide. type PublicAccessBlockConfiguration struct { - // Specifies whether Amazon S3 should restrict public bucket policies for this - // bucket. Setting this element to TRUE restricts access to this bucket to only AWS - // services and authorized users within this account if the bucket has a public - // policy. Enabling this setting doesn't affect previously stored bucket policies, - // except that public and cross-account access within any public bucket policy, - // including non-public delegation to specific accounts, is blocked. - RestrictPublicBuckets *bool - // Specifies whether Amazon S3 should block public access control lists (ACLs) for // this bucket and objects in this bucket. Setting this element to TRUE causes the // following behavior: @@ -2290,6 +2282,12 @@ type PublicAccessBlockConfiguration struct { // Enabling this setting doesn't affect existing policies or ACLs. BlockPublicAcls *bool + // Specifies whether Amazon S3 should block public bucket policies for this bucket. + // Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket + // policy if the specified bucket policy allows public access. Enabling this + // setting doesn't affect existing bucket policies. + BlockPublicPolicy *bool + // Specifies whether Amazon S3 should ignore public ACLs for this bucket and // objects in this bucket. Setting this element to TRUE causes Amazon S3 to ignore // all public ACLs on this bucket and objects in this bucket. Enabling this setting @@ -2297,21 +2295,19 @@ type PublicAccessBlockConfiguration struct { // public ACLs from being set. IgnorePublicAcls *bool - // Specifies whether Amazon S3 should block public bucket policies for this bucket. - // Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket - // policy if the specified bucket policy allows public access. Enabling this - // setting doesn't affect existing bucket policies. - BlockPublicPolicy *bool + // Specifies whether Amazon S3 should restrict public bucket policies for this + // bucket. Setting this element to TRUE restricts access to this bucket to only AWS + // services and authorized users within this account if the bucket has a public + // policy. Enabling this setting doesn't affect previously stored bucket policies, + // except that public and cross-account access within any public bucket policy, + // including non-public delegation to specific accounts, is blocked. + RestrictPublicBuckets *bool } // Specifies the configuration for publishing messages to an Amazon Simple Queue // Service (Amazon SQS) queue when Amazon S3 detects specified events. type QueueConfiguration struct { - // An optional unique identifier for configurations in a notification - // configuration. If you don't provide one, Amazon S3 will assign an ID. - Id *string - // A collection of bucket events for which to send notifications // // This member is required. @@ -2328,21 +2324,27 @@ type QueueConfiguration struct { // (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the // Amazon Simple Storage Service Developer Guide. Filter *NotificationConfigurationFilter + + // An optional unique identifier for configurations in a notification + // configuration. If you don't provide one, Amazon S3 will assign an ID. + Id *string } // Specifies how requests are redirected. In the event of an error, you can specify // a different error code to return. type Redirect struct { + // The host name to use in the redirect request. + HostName *string + + // The HTTP redirect code to use on the response. Not required if one of the + // siblings is present. + HttpRedirectCode *string + // Protocol to use when redirecting requests. The default is the protocol that is // used in the original request. Protocol Protocol - // The specific object key to use in the redirect request. For example, redirect - // request to error.html. Not required if one of the siblings is present. Can be - // present only if ReplaceKeyPrefixWith is not provided. - ReplaceKeyWith *string - // The object key prefix to use in the redirect request. For example, to redirect // requests for all pages with prefix docs/ (objects in the docs/ folder) to // documents/, you can set a condition block with KeyPrefixEquals set to docs/ and @@ -2350,26 +2352,24 @@ type Redirect struct { // the siblings is present. Can be present only if ReplaceKeyWith is not provided. ReplaceKeyPrefixWith *string - // The host name to use in the redirect request. - HostName *string - - // The HTTP redirect code to use on the response. Not required if one of the - // siblings is present. - HttpRedirectCode *string + // The specific object key to use in the redirect request. For example, redirect + // request to error.html. Not required if one of the siblings is present. Can be + // present only if ReplaceKeyPrefixWith is not provided. + ReplaceKeyWith *string } // Specifies the redirect behavior of all requests to a website endpoint of an // Amazon S3 bucket. type RedirectAllRequestsTo struct { - // Protocol to use when redirecting requests. The default is the protocol that is - // used in the original request. - Protocol Protocol - // Name of the host where requests are redirected. // // This member is required. HostName *string + + // Protocol to use when redirecting requests. The default is the protocol that is + // used in the original request. + Protocol Protocol } // A container for replication rules. You can add up to 1,000 rules. The maximum @@ -2395,11 +2395,47 @@ type ReplicationConfiguration struct { // Specifies which Amazon S3 objects to replicate and where to store the replicas. type ReplicationRule struct { + // A container for information about the replication destination and its + // configurations including enabling the S3 Replication Time Control (S3 RTC). + // + // This member is required. + Destination *Destination + // Specifies whether the rule is enabled. // // This member is required. Status ReplicationRuleStatus + // Specifies whether Amazon S3 replicates the delete markers. If you specify a + // Filter, you must specify this element. However, in the latest version of + // replication configuration (when Filter is specified), Amazon S3 doesn't + // replicate delete markers. Therefore, the DeleteMarkerReplication element can + // contain only Disabled. For an example configuration, see Basic Rule + // Configuration + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). + //

      If you don't specify the Filter element, Amazon S3 + // assumes that the replication configuration is the earlier version, V1. In the + // earlier version, Amazon S3 handled replication of delete markers differently. + // For more information, see Backward + // Compatibility.

       + DeleteMarkerReplication *DeleteMarkerReplication + + // + ExistingObjectReplication *ExistingObjectReplication + + // A filter that identifies the subset of objects to which the replication rule + // applies. A Filter must specify exactly one Prefix, Tag, or an And child element. + Filter *ReplicationRuleFilter + + // A unique identifier for the rule. The maximum value is 255 characters. + ID *string + + // An object key name prefix that identifies the object or objects to which the + // rule applies. The maximum prefix length is 1,024 characters. To include all + // objects in a bucket, specify an empty string. + Prefix *string + // The priority associated with the rule. If you specify multiple rules in a // replication configuration, Amazon S3 prioritizes the rules to prevent conflicts // when filtering. If two or more rules identify the same object based on a @@ -2417,48 +2453,12 @@ type ReplicationRule struct { // Simple Storage Service Developer Guide. Priority *int32 - // A container for information about the replication destination and its - // configurations including enabling the S3 Replication Time Control (S3 RTC). - // - // This member is required. - Destination *Destination - - // A unique identifier for the rule. The maximum value is 255 characters. - ID *string - // A container that describes additional filters for identifying the source objects // that you want to replicate. You can choose to enable or disable the replication // of these objects. Currently, Amazon S3 supports only the filter that you can // specify for objects created with server-side encryption using a customer master // key (CMK) stored in AWS Key Management Service (SSE-KMS). SourceSelectionCriteria *SourceSelectionCriteria - - // An object key name prefix that identifies the object or objects to which the - // rule applies. The maximum prefix length is 1,024 characters. To include all - // objects in a bucket, specify an empty string. - Prefix *string - - // A filter that identifies the subset of objects to which the replication rule - // applies. A Filter must specify exactly one Prefix, Tag, or an And child element. - Filter *ReplicationRuleFilter - - // - ExistingObjectReplication *ExistingObjectReplication - - // Specifies whether Amazon S3 replicates the delete markers. If you specify a - // Filter, you must specify this element. However, in the latest version of - // replication configuration (when Filter is specified), Amazon S3 doesn't - // replicate delete markers. Therefore, the DeleteMarkerReplication element can - // contain only Disabled. For an example configuration, see Basic Rule - // Configuration - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). - //

      If you don't specify the Filter element, Amazon S3 - // assumes that the replication configuration is the earlier version, V1. In the - // earlier version, Amazon S3 handled replication of delete markers differently. - // For more information, see Backward - // Compatibility.

       - DeleteMarkerReplication *DeleteMarkerReplication } // A container for specifying rule filters. The filters determine the subset of @@ -2472,12 +2472,12 @@ type ReplicationRule struct { // on multiple tags, wrap the Tag elements in an And tag type ReplicationRuleAndOperator struct { - // An array of tags containing key and value pairs. - Tags []*Tag - // An object key name prefix that identifies the subset of objects to which the // rule applies. Prefix *string + + // An array of tags containing key and value pairs. + Tags []*Tag } // A filter that identifies the subset of objects to which the replication rule @@ -2541,6 +2541,10 @@ type RequestPaymentConfiguration struct { // Container for restore job parameters. type RestoreRequest struct { + // Lifetime of the active copy in days. Do not use with restores that specify + // OutputLocation. + Days *int32 + // The optional description for the job. Description *string @@ -2548,19 +2552,15 @@ type RestoreRequest struct { // that specify OutputLocation. GlacierJobParameters *GlacierJobParameters - // S3 Glacier retrieval tier at which the restore will be processed. - Tier Tier - - // Lifetime of the active copy in days. Do not use with restores that specify - // OutputLocation. - Days *int32 - // Describes the location where the restore job's output is stored. OutputLocation *OutputLocation // Describes the parameters for Select job types. SelectParameters *SelectParameters + // S3 Glacier retrieval tier at which the restore will be processed. + Tier Tier + // Type of restore request. Type RestoreRequestType } @@ -2568,18 +2568,18 @@ type RestoreRequest struct { // Specifies the redirect behavior and when a redirect is applied. type RoutingRule struct { - // A container for describing a condition that must be met for the specified - // redirect to apply. For example, 1. If request is for pages in the /docs folder, - // redirect to the /documents folder. 2. If request results in HTTP error 4xx, - // redirect request to another host where you might process the error. - Condition *Condition - // Container for redirect information. You can redirect requests to another host, // to another page, or with another protocol. In the event of an error, you can // specify a different error code to return. // // This member is required. Redirect *Redirect + + // A container for describing a condition that must be met for the specified + // redirect to apply. For example, 1. If request is for pages in the /docs folder, + // redirect to the /documents folder. 2. If request results in HTTP error 4xx, + // redirect request to another host where you might process the error. + Condition *Condition } // A container for object key name prefix and suffix filtering rules. @@ -2594,33 +2594,33 @@ type S3KeyFilter struct { // request. type S3Location struct { - // A list of metadata to store with the restore results in S3. - UserMetadata []*MetadataEntry - - // The class of storage used to store the restore results. - StorageClass StorageClass - - // The canned ACL to apply to the restore results. - CannedACL ObjectCannedACL - - // Contains the type of server-side encryption used. - Encryption *Encryption - - // The prefix that is prepended to the restore results for this request. + // The name of the bucket where the restore results will be placed. // // This member is required. - Prefix *string + BucketName *string - // The name of the bucket where the restore results will be placed. + // The prefix that is prepended to the restore results for this request. // // This member is required. - BucketName *string + Prefix *string // A list of grants that control access to the staged results. AccessControlList []*Grant + // The canned ACL to apply to the restore results. + CannedACL ObjectCannedACL + + // Contains the type of server-side encryption used. + Encryption *Encryption + + // The class of storage used to store the restore results. + StorageClass StorageClass + // The tag-set that is applied to the restore results. Tagging *Tagging + + // A list of metadata to store with the restore results in S3. + UserMetadata []*MetadataEntry } // Describes the parameters for Select job types. @@ -2631,15 +2631,15 @@ type SelectParameters struct { // This member is required. Expression *string - // Describes the serialization format of the object. + // The type of the provided expression (for example, SQL). // // This member is required. - InputSerialization *InputSerialization + ExpressionType ExpressionType - // The type of the provided expression (for example, SQL). + // Describes the serialization format of the object. // // This member is required. - ExpressionType ExpressionType + InputSerialization *InputSerialization // Describes how the results of the Select job are serialized. // @@ -2655,6 +2655,11 @@ type SelectParameters struct { // in the Amazon Simple Storage Service API Reference. type ServerSideEncryptionByDefault struct { + // Server-side encryption algorithm to use for the default encryption. + // + // This member is required. + SSEAlgorithm ServerSideEncryption + // AWS Key Management Service (KMS) customer master key ID to use for the default // encryption. This parameter is allowed if and only if SSEAlgorithm is set to // aws:kms. You can specify the key ID or the Amazon Resource Name (ARN) of the @@ -2675,11 +2680,6 @@ type ServerSideEncryptionByDefault struct { // (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) // in the AWS Key Management Service Developer Guide. KMSMasterKeyID *string - - // Server-side encryption algorithm to use for the default encryption. - // - // This member is required. - SSEAlgorithm ServerSideEncryption } // Specifies the default server-side-encryption configuration. @@ -2802,29 +2802,29 @@ type TargetGrant struct { // specified events. type TopicConfiguration struct { + // The Amazon S3 bucket event about which to send notifications. For more + // information, see Supported Event Types + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the + // Amazon Simple Storage Service Developer Guide. + // + // This member is required. + Events []Event + // The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 // publishes a message when it detects events of the specified type. // // This member is required. TopicArn *string - // An optional unique identifier for configurations in a notification - // configuration. If you don't provide one, Amazon S3 will assign an ID. - Id *string - // Specifies object key name filtering rules. For information about key name // filtering, see Configuring Event Notifications // (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the // Amazon Simple Storage Service Developer Guide. Filter *NotificationConfigurationFilter - // The Amazon S3 bucket event about which to send notifications. For more - // information, see Supported Event Types - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the - // Amazon Simple Storage Service Developer Guide. - // - // This member is required. - Events []Event + // An optional unique identifier for configurations in a notification + // configuration. If you don't provide one, Amazon S3 will assign an ID. + Id *string } // Specifies when an object transitions to a specified storage class. For more @@ -2864,8 +2864,8 @@ type VersioningConfiguration struct { // Specifies website configuration parameters for an Amazon S3 bucket. type WebsiteConfiguration struct { - // Rules that define when a redirect is applied and the redirect behavior. - RoutingRules []*RoutingRule + // The name of the error document for the website. + ErrorDocument *ErrorDocument // The name of the index document for the website. IndexDocument *IndexDocument @@ -2874,6 +2874,6 @@ type WebsiteConfiguration struct { // you specify this property, you can't specify any other property. RedirectAllRequestsTo *RedirectAllRequestsTo - // The name of the error document for the website. - ErrorDocument *ErrorDocument + // Rules that define when a redirect is applied and the redirect behavior. + RoutingRules []*RoutingRule } diff --git a/service/s3control/api_op_CreateAccessPoint.go b/service/s3control/api_op_CreateAccessPoint.go index d3bac25723f..d6183d0f8eb 100644 --- a/service/s3control/api_op_CreateAccessPoint.go +++ b/service/s3control/api_op_CreateAccessPoint.go @@ -96,24 +96,11 @@ func (c *Client) CreateAccessPoint(ctx context.Context, params *CreateAccessPoin type CreateAccessPointInput struct { - // The name you want to assign to this access point. + // The AWS account ID for the owner of the bucket for which you want to create an + // access point. // // This member is required. - Name *string - - // If you include this field, Amazon S3 restricts access to this access point to - // requests from the specified virtual private cloud (VPC). This is required for - // creating an access point for Amazon S3 on Outposts buckets. - VpcConfiguration *types.VpcConfiguration - - // The PublicAccessBlock configuration that you want to apply to this Amazon S3 - // bucket. You can enable the configuration options in any combination. For more - // information about when Amazon S3 considers a bucket or object public, see The - // Meaning of "Public" - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) - // in the Amazon Simple Storage Service Developer Guide. This is not supported for - // Amazon S3 on Outposts. - PublicAccessBlockConfiguration *types.PublicAccessBlockConfiguration + AccountId *string // The name of the bucket that you want to associate this access point with. For // Amazon S3 on Outposts specify the ARN of the bucket accessed in the format @@ -126,11 +113,24 @@ type CreateAccessPointInput struct { // This member is required. Bucket *string - // The AWS account ID for the owner of the bucket for which you want to create an - // access point. + // The name you want to assign to this access point. // // This member is required. - AccountId *string + Name *string + + // The PublicAccessBlock configuration that you want to apply to this Amazon S3 + // bucket. You can enable the configuration options in any combination. For more + // information about when Amazon S3 considers a bucket or object public, see The + // Meaning of "Public" + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) + // in the Amazon Simple Storage Service Developer Guide. This is not supported for + // Amazon S3 on Outposts. + PublicAccessBlockConfiguration *types.PublicAccessBlockConfiguration + + // If you include this field, Amazon S3 restricts access to this access point to + // requests from the specified virtual private cloud (VPC). This is required for + // creating an access point for Amazon S3 on Outposts buckets. + VpcConfiguration *types.VpcConfiguration } type CreateAccessPointOutput struct { diff --git a/service/s3control/api_op_CreateBucket.go b/service/s3control/api_op_CreateBucket.go index 0798ea1dfad..51fbd413594 100644 --- a/service/s3control/api_op_CreateBucket.go +++ b/service/s3control/api_op_CreateBucket.go @@ -87,53 +87,50 @@ func (c *Client) CreateBucket(ctx context.Context, params *CreateBucketInput, op type CreateBucketInput struct { - // Specifies whether you want S3 Object Lock to be enabled for the new bucket. This - // is not supported by Amazon S3 on Outposts buckets. - ObjectLockEnabledForBucket *bool - - // Allows grantee to list the objects in the bucket. This is not supported by - // Amazon S3 on Outposts buckets. - GrantRead *string + // The name of the bucket. + // + // This member is required. + Bucket *string // The canned ACL to apply to the bucket. This is not supported by Amazon S3 on // Outposts buckets. ACL types.BucketCannedACL - // Allows grantee to create, overwrite, and delete any object in the bucket. This - // is not supported by Amazon S3 on Outposts buckets. - GrantWrite *string - - // The name of the bucket. - // - // This member is required. - Bucket *string + // The configuration information for the bucket. This is not supported by Amazon S3 + // on Outposts buckets. + CreateBucketConfiguration *types.CreateBucketConfiguration // Allows grantee the read, write, read ACP, and write ACP permissions on the // bucket. This is not supported by Amazon S3 on Outposts buckets. GrantFullControl *string - // The configuration information for the bucket. This is not supported by Amazon S3 - // on Outposts buckets. - CreateBucketConfiguration *types.CreateBucketConfiguration + // Allows grantee to list the objects in the bucket. This is not supported by + // Amazon S3 on Outposts buckets. + GrantRead *string // Allows grantee to read the bucket ACL. This is not supported by Amazon S3 on // Outposts buckets. GrantReadACP *string - // The ID of the Outposts where the bucket is being created. This is required by - // Amazon S3 on Outposts buckets. - OutpostId *string + // Allows grantee to create, overwrite, and delete any object in the bucket. This + // is not supported by Amazon S3 on Outposts buckets. + GrantWrite *string // Allows grantee to write the ACL for the applicable bucket. This is not supported // by Amazon S3 on Outposts buckets. GrantWriteACP *string + + // Specifies whether you want S3 Object Lock to be enabled for the new bucket. This + // is not supported by Amazon S3 on Outposts buckets. + ObjectLockEnabledForBucket *bool + + // The ID of the Outposts where the bucket is being created. This is required by + // Amazon S3 on Outposts buckets. + OutpostId *string } type CreateBucketOutput struct { - // The location of the bucket. - Location *string - // The Amazon Resource Name (ARN) of the bucket. For Amazon S3 on Outposts specify // the ARN of the bucket accessed in the format // arn:aws:s3-outposts:::outpost//bucket/. For example, to access the bucket @@ -143,6 +140,9 @@ type CreateBucketOutput struct { // The value must be URL encoded. BucketArn *string + // The location of the bucket. + Location *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/s3control/api_op_CreateJob.go b/service/s3control/api_op_CreateJob.go index 5c5b35f2a1a..f6756a6887b 100644 --- a/service/s3control/api_op_CreateJob.go +++ b/service/s3control/api_op_CreateJob.go @@ -85,15 +85,17 @@ type CreateJobInput struct { // This member is required. AccountId *string + // An idempotency token to ensure that you don't accidentally submit the same + // request twice. You can use any string up to the maximum length. + // + // This member is required. + ClientRequestToken *string + // Configuration parameters for the manifest. // // This member is required. Manifest *types.JobManifest - // A description for this job. You can use any string within the permitted length. - // Descriptions don't need to be unique and can be used for multiple jobs. - Description *string - // The operation that you want this job to perform on each object listed in the // manifest. For more information about the available operations, see Operations // (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-operations.html) in @@ -102,36 +104,34 @@ type CreateJobInput struct { // This member is required. Operation *types.JobOperation - // An idempotency token to ensure that you don't accidentally submit the same - // request twice. You can use any string up to the maximum length. - // - // This member is required. - ClientRequestToken *string - // The numerical priority for this job. Higher numbers indicate higher priority. // // This member is required. Priority *int32 - // Indicates whether confirmation is required before Amazon S3 runs the job. - // Confirmation is only required for jobs created through the Amazon S3 console. - ConfirmationRequired *bool - // Configuration parameters for the optional job-completion report. // // This member is required. Report *types.JobReport - // A set of tags to associate with the S3 Batch Operations job. This is an optional - // parameter. - Tags []*types.S3Tag - // The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) // role that Batch Operations will use to run this job's operation on each object // in the manifest. // // This member is required. RoleArn *string + + // Indicates whether confirmation is required before Amazon S3 runs the job. + // Confirmation is only required for jobs created through the Amazon S3 console. + ConfirmationRequired *bool + + // A description for this job. You can use any string within the permitted length. + // Descriptions don't need to be unique and can be used for multiple jobs. + Description *string + + // A set of tags to associate with the S3 Batch Operations job. This is an optional + // parameter. + Tags []*types.S3Tag } type CreateJobOutput struct { diff --git a/service/s3control/api_op_DeleteBucket.go b/service/s3control/api_op_DeleteBucket.go index a9114c0f520..b7b4823fa44 100644 --- a/service/s3control/api_op_DeleteBucket.go +++ b/service/s3control/api_op_DeleteBucket.go @@ -83,6 +83,11 @@ func (c *Client) DeleteBucket(ctx context.Context, params *DeleteBucketInput, op type DeleteBucketInput struct { + // The account ID that owns the Outposts bucket. + // + // This member is required. + AccountId *string + // Specifies the bucket being deleted. For Amazon S3 on Outposts specify the ARN of // the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/. For // example, to access the bucket reports through outpost my-outpost owned by @@ -92,11 +97,6 @@ type DeleteBucketInput struct { // // This member is required. Bucket *string - - // The account ID that owns the Outposts bucket. - // - // This member is required. - AccountId *string } type DeleteBucketOutput struct { diff --git a/service/s3control/api_op_DeleteJobTagging.go b/service/s3control/api_op_DeleteJobTagging.go index 2ebb8eb68e1..8ee65720fb9 100644 --- a/service/s3control/api_op_DeleteJobTagging.go +++ b/service/s3control/api_op_DeleteJobTagging.go @@ -74,15 +74,15 @@ func (c *Client) DeleteJobTagging(ctx context.Context, params *DeleteJobTaggingI type DeleteJobTaggingInput struct { - // The ID for the S3 Batch Operations job whose tags you want to delete. + // The AWS account ID associated with the S3 Batch Operations job. // // This member is required. - JobId *string + AccountId *string - // The AWS account ID associated with the S3 Batch Operations job. + // The ID for the S3 Batch Operations job whose tags you want to delete. // // This member is required. - AccountId *string + JobId *string } type DeleteJobTaggingOutput struct { diff --git a/service/s3control/api_op_DescribeJob.go b/service/s3control/api_op_DescribeJob.go index d1ce62317c0..fffc6ef1b45 100644 --- a/service/s3control/api_op_DescribeJob.go +++ b/service/s3control/api_op_DescribeJob.go @@ -77,15 +77,15 @@ func (c *Client) DescribeJob(ctx context.Context, params *DescribeJobInput, optF type DescribeJobInput struct { - // The ID for the job whose information you want to retrieve. + // // // This member is required. - JobId *string + AccountId *string - // + // The ID for the job whose information you want to retrieve. // // This member is required. - AccountId *string + JobId *string } type DescribeJobOutput struct { diff --git a/service/s3control/api_op_GetAccessPoint.go b/service/s3control/api_op_GetAccessPoint.go index 5b0f9bac50d..e6556e6d50d 100644 --- a/service/s3control/api_op_GetAccessPoint.go +++ b/service/s3control/api_op_GetAccessPoint.go @@ -73,6 +73,11 @@ func (c *Client) GetAccessPoint(ctx context.Context, params *GetAccessPointInput type GetAccessPointInput struct { + // The account ID for the account that owns the specified access point. + // + // This member is required. + AccountId *string + // The name of the access point whose configuration information you want to // retrieve. For Amazon S3 on Outposts specify the ARN of the access point accessed // in the format arn:aws:s3-outposts:::outpost//accesspoint/. For example, to @@ -83,28 +88,19 @@ type GetAccessPointInput struct { // // This member is required. Name *string - - // The account ID for the account that owns the specified access point. - // - // This member is required. - AccountId *string } type GetAccessPointOutput struct { - // The name of the specified access point. - Name *string - - // Contains the virtual private cloud (VPC) configuration for the specified access - // point. - VpcConfiguration *types.VpcConfiguration - // The name of the bucket associated with the specified access point. Bucket *string // The date and time when the specified access point was created. CreationDate *time.Time + // The name of the specified access point. + Name *string + // Indicates whether this access point allows access from the public internet. If // VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, // and the access point doesn't allow access from the public internet. Otherwise, @@ -122,6 +118,10 @@ type GetAccessPointOutput struct { // Amazon S3 on Outposts. PublicAccessBlockConfiguration *types.PublicAccessBlockConfiguration + // Contains the virtual private cloud (VPC) configuration for the specified access + // point. + VpcConfiguration *types.VpcConfiguration + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/s3control/api_op_GetAccessPointPolicy.go b/service/s3control/api_op_GetAccessPointPolicy.go index b08fa2b945a..804ba6e92d9 100644 --- a/service/s3control/api_op_GetAccessPointPolicy.go +++ b/service/s3control/api_op_GetAccessPointPolicy.go @@ -66,6 +66,11 @@ func (c *Client) GetAccessPointPolicy(ctx context.Context, params *GetAccessPoin type GetAccessPointPolicyInput struct { + // The account ID for the account that owns the specified access point. + // + // This member is required. + AccountId *string + // The name of the access point whose policy you want to retrieve. For Amazon S3 on // Outposts specify the ARN of the access point accessed in the format // arn:aws:s3-outposts:::outpost//accesspoint/. For example, to access the access @@ -76,11 +81,6 @@ type GetAccessPointPolicyInput struct { // // This member is required. Name *string - - // The account ID for the account that owns the specified access point. - // - // This member is required. - AccountId *string } type GetAccessPointPolicyOutput struct { diff --git a/service/s3control/api_op_GetAccessPointPolicyStatus.go b/service/s3control/api_op_GetAccessPointPolicyStatus.go index 94680ca364c..552bbbcf84a 100644 --- a/service/s3control/api_op_GetAccessPointPolicyStatus.go +++ b/service/s3control/api_op_GetAccessPointPolicyStatus.go @@ -62,15 +62,15 @@ func (c *Client) GetAccessPointPolicyStatus(ctx context.Context, params *GetAcce type GetAccessPointPolicyStatusInput struct { - // The name of the access point whose policy status you want to retrieve. + // The account ID for the account that owns the specified access point. // // This member is required. - Name *string + AccountId *string - // The account ID for the account that owns the specified access point. + // The name of the access point whose policy status you want to retrieve. // // This member is required. - AccountId *string + Name *string } type GetAccessPointPolicyStatusOutput struct { diff --git a/service/s3control/api_op_GetBucket.go b/service/s3control/api_op_GetBucket.go index dfbf687ca77..88ad3c4fdbb 100644 --- a/service/s3control/api_op_GetBucket.go +++ b/service/s3control/api_op_GetBucket.go @@ -90,15 +90,15 @@ type GetBucketInput struct { type GetBucketOutput struct { + // The Outposts bucket requested. + Bucket *string + // The creation date of the Outposts bucket. CreationDate *time.Time // PublicAccessBlockEnabled *bool - // The Outposts bucket requested. - Bucket *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/s3control/api_op_GetBucketLifecycleConfiguration.go b/service/s3control/api_op_GetBucketLifecycleConfiguration.go index 9ce5dd7a957..7e522a79736 100644 --- a/service/s3control/api_op_GetBucketLifecycleConfiguration.go +++ b/service/s3control/api_op_GetBucketLifecycleConfiguration.go @@ -93,6 +93,11 @@ func (c *Client) GetBucketLifecycleConfiguration(ctx context.Context, params *Ge type GetBucketLifecycleConfigurationInput struct { + // The AWS account ID of the Outposts bucket. + // + // This member is required. + AccountId *string + // The Amazon Resource Name (ARN) of the bucket. For Amazon S3 on Outposts specify // the ARN of the bucket accessed in the format // arn:aws:s3-outposts:::outpost//bucket/. For example, to access the bucket @@ -103,11 +108,6 @@ type GetBucketLifecycleConfigurationInput struct { // // This member is required. Bucket *string - - // The AWS account ID of the Outposts bucket. - // - // This member is required. - AccountId *string } type GetBucketLifecycleConfigurationOutput struct { diff --git a/service/s3control/api_op_GetBucketTagging.go b/service/s3control/api_op_GetBucketTagging.go index ca726f405ce..bea9a1d2f6d 100644 --- a/service/s3control/api_op_GetBucketTagging.go +++ b/service/s3control/api_op_GetBucketTagging.go @@ -82,6 +82,11 @@ func (c *Client) GetBucketTagging(ctx context.Context, params *GetBucketTaggingI type GetBucketTaggingInput struct { + // The AWS account ID of the Outposts bucket. + // + // This member is required. + AccountId *string + // The ARN of the bucket. For Amazon S3 on Outposts specify the ARN of the bucket // accessed in the format arn:aws:s3-outposts:::outpost//bucket/. For example, to // access the bucket reports through outpost my-outpost owned by account @@ -91,11 +96,6 @@ type GetBucketTaggingInput struct { // // This member is required. Bucket *string - - // The AWS account ID of the Outposts bucket. - // - // This member is required. - AccountId *string } type GetBucketTaggingOutput struct { diff --git a/service/s3control/api_op_GetJobTagging.go b/service/s3control/api_op_GetJobTagging.go index 132174a9810..1b06ee3eed4 100644 --- a/service/s3control/api_op_GetJobTagging.go +++ b/service/s3control/api_op_GetJobTagging.go @@ -74,15 +74,15 @@ func (c *Client) GetJobTagging(ctx context.Context, params *GetJobTaggingInput, type GetJobTaggingInput struct { - // The ID for the S3 Batch Operations job whose tags you want to retrieve. + // The AWS account ID associated with the S3 Batch Operations job. // // This member is required. - JobId *string + AccountId *string - // The AWS account ID associated with the S3 Batch Operations job. + // The ID for the S3 Batch Operations job whose tags you want to retrieve. // // This member is required. - AccountId *string + JobId *string } type GetJobTaggingOutput struct { diff --git a/service/s3control/api_op_ListAccessPoints.go b/service/s3control/api_op_ListAccessPoints.go index e2e484447de..b5f81f8968c 100644 --- a/service/s3control/api_op_ListAccessPoints.go +++ b/service/s3control/api_op_ListAccessPoints.go @@ -81,6 +81,11 @@ func (c *Client) ListAccessPoints(ctx context.Context, params *ListAccessPointsI type ListAccessPointsInput struct { + // The AWS account ID for owner of the bucket whose access points you want to list. + // + // This member is required. + AccountId *string + // The name of the bucket whose associated access points you want to list. For // Amazon S3 on Outposts specify the ARN of the bucket accessed in the format // arn:aws:s3-outposts:::outpost//bucket/. For example, to access the bucket @@ -96,11 +101,6 @@ type ListAccessPointsInput struct { // retrieve the next page of access points. MaxResults *int32 - // The AWS account ID for owner of the bucket whose access points you want to list. - // - // This member is required. - AccountId *string - // A continuation token. If a previous call to ListAccessPoints returned a // continuation token in the NextToken field, then providing that value here causes // Amazon S3 to retrieve the next page of results. @@ -109,15 +109,15 @@ type ListAccessPointsInput struct { type ListAccessPointsOutput struct { + // Contains identification and configuration information for one or more access + // points associated with the specified bucket. + AccessPointList []*types.AccessPoint + // If the specified bucket has more access points than can be returned in one call // to this API, this field contains a continuation token that you can provide in // subsequent calls to this API to retrieve additional access points. NextToken *string - // Contains identification and configuration information for one or more access - // points associated with the specified bucket. - AccessPointList []*types.AccessPoint - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/s3control/api_op_ListJobs.go b/service/s3control/api_op_ListJobs.go index f4cbf55d1ed..8733df6ae8c 100644 --- a/service/s3control/api_op_ListJobs.go +++ b/service/s3control/api_op_ListJobs.go @@ -78,6 +78,11 @@ func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ... type ListJobsInput struct { + // + // + // This member is required. + AccountId *string + // The List Jobs request returns jobs that match the statuses listed in this // element. JobStatuses []types.JobStatus @@ -92,11 +97,6 @@ type ListJobsInput struct { // Amazon S3 returned in the NextToken element of the ListJobsResult from the // previous List Jobs request. NextToken *string - - // - // - // This member is required. - AccountId *string } type ListJobsOutput struct { diff --git a/service/s3control/api_op_ListRegionalBuckets.go b/service/s3control/api_op_ListRegionalBuckets.go index f6ce73a4089..906ce189920 100644 --- a/service/s3control/api_op_ListRegionalBuckets.go +++ b/service/s3control/api_op_ListRegionalBuckets.go @@ -73,11 +73,11 @@ type ListRegionalBucketsInput struct { // MaxResults *int32 - // The ID of the AWS Outposts. This is required by Amazon S3 on Outposts buckets. - OutpostId *string - // NextToken *string + + // The ID of the AWS Outposts. This is required by Amazon S3 on Outposts buckets. + OutpostId *string } type ListRegionalBucketsOutput struct { diff --git a/service/s3control/api_op_PutAccessPointPolicy.go b/service/s3control/api_op_PutAccessPointPolicy.go index ad77c801d59..6a40747d67b 100644 --- a/service/s3control/api_op_PutAccessPointPolicy.go +++ b/service/s3control/api_op_PutAccessPointPolicy.go @@ -74,6 +74,12 @@ func (c *Client) PutAccessPointPolicy(ctx context.Context, params *PutAccessPoin type PutAccessPointPolicyInput struct { + // The AWS account ID for owner of the bucket associated with the specified access + // point. + // + // This member is required. + AccountId *string + // The name of the access point that you want to associate with the specified // policy. For Amazon S3 on Outposts specify the ARN of the access point accessed // in the format arn:aws:s3-outposts:::outpost//accesspoint/. For example, to @@ -93,12 +99,6 @@ type PutAccessPointPolicyInput struct { // // This member is required. Policy *string - - // The AWS account ID for owner of the bucket associated with the specified access - // point. - // - // This member is required. - AccountId *string } type PutAccessPointPolicyOutput struct { diff --git a/service/s3control/api_op_PutBucketLifecycleConfiguration.go b/service/s3control/api_op_PutBucketLifecycleConfiguration.go index 8bb0db5bb0e..98e4094e4d0 100644 --- a/service/s3control/api_op_PutBucketLifecycleConfiguration.go +++ b/service/s3control/api_op_PutBucketLifecycleConfiguration.go @@ -82,15 +82,15 @@ func (c *Client) PutBucketLifecycleConfiguration(ctx context.Context, params *Pu type PutBucketLifecycleConfigurationInput struct { - // The name of the bucket for which to set the configuration. + // The AWS account ID of the Outposts bucket. // // This member is required. - Bucket *string + AccountId *string - // The AWS account ID of the Outposts bucket. + // The name of the bucket for which to set the configuration. // // This member is required. - AccountId *string + Bucket *string // Container for lifecycle rules. You can add as many as 1,000 rules. LifecycleConfiguration *types.LifecycleConfiguration diff --git a/service/s3control/api_op_PutBucketPolicy.go b/service/s3control/api_op_PutBucketPolicy.go index e7720aaeca4..27d0b4b06c6 100644 --- a/service/s3control/api_op_PutBucketPolicy.go +++ b/service/s3control/api_op_PutBucketPolicy.go @@ -103,15 +103,15 @@ type PutBucketPolicyInput struct { // This member is required. Bucket *string - // Set this parameter to true to confirm that you want to remove your permissions - // to change this bucket policy in the future. This is not supported by Amazon S3 - // on Outposts buckets. - ConfirmRemoveSelfBucketAccess *bool - // The bucket policy as a JSON document. // // This member is required. Policy *string + + // Set this parameter to true to confirm that you want to remove your permissions + // to change this bucket policy in the future. This is not supported by Amazon S3 + // on Outposts buckets. + ConfirmRemoveSelfBucketAccess *bool } type PutBucketPolicyOutput struct { diff --git a/service/s3control/api_op_PutBucketTagging.go b/service/s3control/api_op_PutBucketTagging.go index ec468b08080..1a338ba2e65 100644 --- a/service/s3control/api_op_PutBucketTagging.go +++ b/service/s3control/api_op_PutBucketTagging.go @@ -111,11 +111,6 @@ func (c *Client) PutBucketTagging(ctx context.Context, params *PutBucketTaggingI type PutBucketTaggingInput struct { - // - // - // This member is required. - Tagging *types.Tagging - // The AWS account ID of the Outposts bucket. // // This member is required. @@ -131,6 +126,11 @@ type PutBucketTaggingInput struct { // // This member is required. Bucket *string + + // + // + // This member is required. + Tagging *types.Tagging } type PutBucketTaggingOutput struct { diff --git a/service/s3control/api_op_PutJobTagging.go b/service/s3control/api_op_PutJobTagging.go index b26a3bde25c..5312da44762 100644 --- a/service/s3control/api_op_PutJobTagging.go +++ b/service/s3control/api_op_PutJobTagging.go @@ -121,15 +121,15 @@ type PutJobTaggingInput struct { // This member is required. AccountId *string - // The set of tags to associate with the S3 Batch Operations job. + // The ID for the S3 Batch Operations job whose tags you want to replace. // // This member is required. - Tags []*types.S3Tag + JobId *string - // The ID for the S3 Batch Operations job whose tags you want to replace. + // The set of tags to associate with the S3 Batch Operations job. // // This member is required. - JobId *string + Tags []*types.S3Tag } type PutJobTaggingOutput struct { diff --git a/service/s3control/api_op_PutPublicAccessBlock.go b/service/s3control/api_op_PutPublicAccessBlock.go index 4a8be251a53..1b9c6403df1 100644 --- a/service/s3control/api_op_PutPublicAccessBlock.go +++ b/service/s3control/api_op_PutPublicAccessBlock.go @@ -68,17 +68,17 @@ func (c *Client) PutPublicAccessBlock(ctx context.Context, params *PutPublicAcce type PutPublicAccessBlockInput struct { - // The PublicAccessBlock configuration that you want to apply to the specified AWS - // account. - // - // This member is required. - PublicAccessBlockConfiguration *types.PublicAccessBlockConfiguration - // The account ID for the AWS account whose PublicAccessBlock configuration you // want to set. // // This member is required. AccountId *string + + // The PublicAccessBlock configuration that you want to apply to the specified AWS + // account. + // + // This member is required. + PublicAccessBlockConfiguration *types.PublicAccessBlockConfiguration } type PutPublicAccessBlockOutput struct { diff --git a/service/s3control/api_op_UpdateJobPriority.go b/service/s3control/api_op_UpdateJobPriority.go index 0a654fea22d..78ab8022834 100644 --- a/service/s3control/api_op_UpdateJobPriority.go +++ b/service/s3control/api_op_UpdateJobPriority.go @@ -76,15 +76,15 @@ func (c *Client) UpdateJobPriority(ctx context.Context, params *UpdateJobPriorit type UpdateJobPriorityInput struct { - // The ID for the job whose priority you want to update. + // // // This member is required. - JobId *string + AccountId *string - // + // The ID for the job whose priority you want to update. // // This member is required. - AccountId *string + JobId *string // The priority you want to assign to this job. // diff --git a/service/s3control/api_op_UpdateJobStatus.go b/service/s3control/api_op_UpdateJobStatus.go index 7d9754d0929..6866caf8f7a 100644 --- a/service/s3control/api_op_UpdateJobStatus.go +++ b/service/s3control/api_op_UpdateJobStatus.go @@ -78,6 +78,11 @@ func (c *Client) UpdateJobStatus(ctx context.Context, params *UpdateJobStatusInp type UpdateJobStatusInput struct { + // + // + // This member is required. + AccountId *string + // The ID of the job whose status you want to update. // // This member is required. @@ -91,24 +96,19 @@ type UpdateJobStatusInput struct { // A description of the reason why you want to change the specified job's status. // This field can be any string up to the maximum length. StatusUpdateReason *string - - // - // - // This member is required. - AccountId *string } type UpdateJobStatusOutput struct { + // The ID for the job whose status was updated. + JobId *string + // The current status for the specified job. Status types.JobStatus // The reason that the specified job's status was updated. StatusUpdateReason *string - // The ID for the job whose status was updated. - JobId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/s3control/go.mod b/service/s3control/go.mod index ea4a6db8624..df806ceefe3 100644 --- a/service/s3control/go.mod +++ b/service/s3control/go.mod @@ -4,7 +4,7 @@ go 1.15 require ( github.com/aws/aws-sdk-go-v2 v0.26.0 - github.com/aws/aws-sdk-go-v2/service/internal/s3shared v0.1.1 + github.com/aws/aws-sdk-go-v2/service/internal/s3shared v0.1.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/s3control/types/types.go b/service/s3control/types/types.go index f446c2de047..ebff9afb859 100644 --- a/service/s3control/types/types.go +++ b/service/s3control/types/types.go @@ -22,8 +22,10 @@ type AccessPoint struct { // This member is required. Bucket *string - // The ARN for the access point. - AccessPointArn *string + // The name of this access point. + // + // This member is required. + Name *string // Indicates whether this access point allows access from the public internet. If // VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, @@ -34,14 +36,12 @@ type AccessPoint struct { // This member is required. NetworkOrigin NetworkOrigin + // The ARN for the access point. + AccessPointArn *string + // The virtual private cloud (VPC) configuration for this access point, if one // exists. VpcConfiguration *VpcConfiguration - - // The name of this access point. - // - // This member is required. - Name *string } // The container for the bucket configuration. This is not supported by Amazon S3 @@ -58,34 +58,55 @@ type CreateBucketConfiguration struct { // a Describe Job request. type JobDescriptor struct { - // The configuration information for the specified job's manifest object. - Manifest *JobManifest - - // Describes the total number of tasks that the specified job has run, the number - // of tasks that succeeded, and the number of tasks that failed. - ProgressSummary *JobProgressSummary - // Indicates whether confirmation is required before Amazon S3 begins running the // specified job. Confirmation is required only for jobs created through the Amazon // S3 console. ConfirmationRequired *bool + // A timestamp indicating when this job was created. + CreationTime *time.Time + + // The description for this job, if one was provided in this job's Create Job + // request. + Description *string + + // If the specified job failed, this field contains information describing the + // failure. + FailureReasons []*JobFailure + // The Amazon Resource Name (ARN) for this job. JobArn *string + // The ID for the specified job. + JobId *string + + // The configuration information for the specified job's manifest object. + Manifest *JobManifest + + // The operation that the specified job is configured to run on the objects listed + // in the manifest. + Operation *JobOperation + // The priority of the specified job. Priority *int32 + // Describes the total number of tasks that the specified job has run, the number + // of tasks that succeeded, and the number of tasks that failed. + ProgressSummary *JobProgressSummary + // Contains the configuration information for the job-completion report if you // requested one in the Create Job request. Report *JobReport + // The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) + // role assigned to run the tasks for this job. + RoleArn *string + // The current status of the specified job. Status JobStatus - // A timestamp indicating when this job terminated. A job's termination date is the - // date and time when it succeeded, failed, or was canceled. - TerminationDate *time.Time + // The reason for updating the job. + StatusUpdateReason *string // The reason why the specified job was suspended. A job is only suspended if you // create it through the Amazon S3 console. When you create the job, it enters the @@ -93,52 +114,42 @@ type JobDescriptor struct { // it automatically exits the Suspended state. SuspendedCause *string - // The description for this job, if one was provided in this job's Create Job - // request. - Description *string - - // The operation that the specified job is configured to run on the objects listed - // in the manifest. - Operation *JobOperation - - // The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) - // role assigned to run the tasks for this job. - RoleArn *string - // The timestamp when this job was suspended, if it has been suspended. SuspendedDate *time.Time - // If the specified job failed, this field contains information describing the - // failure. - FailureReasons []*JobFailure - - // The reason for updating the job. - StatusUpdateReason *string - - // A timestamp indicating when this job was created. - CreationTime *time.Time - - // The ID for the specified job. - JobId *string + // A timestamp indicating when this job terminated. A job's termination date is the + // date and time when it succeeded, failed, or was canceled. + TerminationDate *time.Time } // If this job failed, this element indicates why the job failed. type JobFailure struct { - // The failure reason, if any, for the specified job. - FailureReason *string - // The failure code, if any, for the specified job. FailureCode *string + + // The failure reason, if any, for the specified job. + FailureReason *string } // Contains the configuration and status information for a single job retrieved as // part of a job list. type JobListDescriptor struct { + // A timestamp indicating when the specified job was created. + CreationTime *time.Time + + // The user-specified description that was included in the specified job's Create + // Job request. + Description *string + // The ID for the specified job. JobId *string + // The operation that the specified job is configured to run on each object listed + // in the manifest. + Operation OperationName + // The current priority for the specified job. Priority *int32 @@ -146,23 +157,12 @@ type JobListDescriptor struct { // of tasks that succeeded, and the number of tasks that failed. ProgressSummary *JobProgressSummary - // The user-specified description that was included in the specified job's Create - // Job request. - Description *string - - // The operation that the specified job is configured to run on each object listed - // in the manifest. - Operation OperationName - - // A timestamp indicating when the specified job was created. - CreationTime *time.Time + // The specified job's current status. + Status JobStatus // A timestamp indicating when the specified job terminated. A job's termination // date is the date and time when it succeeded, failed, or was canceled. TerminationDate *time.Time - - // The specified job's current status. - Status JobStatus } // Contains the configuration information for a job's manifest. @@ -217,25 +217,29 @@ type JobManifestSpec struct { // the Amazon Simple Storage Service Developer Guide. type JobOperation struct { - // Contains the configuration for an S3 Object Lock legal hold operation that an S3 - // Batch Operations job passes each object through to the underlying - // PutObjectLegalHold API. For more information, see Using S3 Object Lock legal - // hold with S3 Batch Operations - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-legal-hold.html) in - // the Amazon Simple Storage Service Developer Guide. - S3PutObjectLegalHold *S3SetObjectLegalHoldOperation - - // Directs the specified job to run a PUT Copy object call on each object in the + // Directs the specified job to invoke an AWS Lambda function on each object in the // manifest. - S3PutObjectCopy *S3CopyObjectOperation + LambdaInvoke *LambdaInvokeOperation // Directs the specified job to run an Initiate Glacier Restore call on each object // in the manifest. S3InitiateRestoreObject *S3InitiateRestoreObjectOperation - // Directs the specified job to run a PUT Object tagging call on each object in the + // Directs the specified job to run a PUT Object acl call on each object in the // manifest. - S3PutObjectTagging *S3SetObjectTaggingOperation + S3PutObjectAcl *S3SetObjectAclOperation + + // Directs the specified job to run a PUT Copy object call on each object in the + // manifest. + S3PutObjectCopy *S3CopyObjectOperation + + // Contains the configuration for an S3 Object Lock legal hold operation that an S3 + // Batch Operations job passes each object through to the underlying + // PutObjectLegalHold API. For more information, see Using S3 Object Lock legal + // hold with S3 Batch Operations + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-legal-hold.html) in + // the Amazon Simple Storage Service Developer Guide. + S3PutObjectLegalHold *S3SetObjectLegalHoldOperation // Contains the configuration parameters for the Object Lock retention action for // an S3 Batch Operations job. Batch Operations passes each value through to the @@ -245,13 +249,9 @@ type JobOperation struct { // in the Amazon Simple Storage Service Developer Guide. S3PutObjectRetention *S3SetObjectRetentionOperation - // Directs the specified job to invoke an AWS Lambda function on each object in the - // manifest. - LambdaInvoke *LambdaInvokeOperation - - // Directs the specified job to run a PUT Object acl call on each object in the + // Directs the specified job to run a PUT Object tagging call on each object in the // manifest. - S3PutObjectAcl *S3SetObjectAclOperation + S3PutObjectTagging *S3SetObjectTaggingOperation } // Describes the total number of tasks that the specified job has started, the @@ -259,30 +259,18 @@ type JobOperation struct { type JobProgressSummary struct { // - NumberOfTasksSucceeded *int64 + NumberOfTasksFailed *int64 // - TotalNumberOfTasks *int64 + NumberOfTasksSucceeded *int64 // - NumberOfTasksFailed *int64 + TotalNumberOfTasks *int64 } // Contains the configuration parameters for a job-completion report. type JobReport struct { - // The format of the specified job-completion report. - Format JobReportFormat - - // Indicates whether the job-completion report will include details of all tasks or - // only failed tasks. - ReportScope JobReportScope - - // An optional prefix to describe where in the specified bucket the job-completion - // report will be stored. Amazon S3 stores the job-completion report at - // /job-/report.json. - Prefix *string - // Indicates whether the specified job will generate a job-completion report. // // This member is required. @@ -291,6 +279,18 @@ type JobReport struct { // The Amazon Resource Name (ARN) for the bucket where specified job-completion // report will be stored. Bucket *string + + // The format of the specified job-completion report. + Format JobReportFormat + + // An optional prefix to describe where in the specified bucket the job-completion + // report will be stored. Amazon S3 stores the job-completion report at + // /job-/report.json. + Prefix *string + + // Indicates whether the job-completion report will include details of all tasks or + // only failed tasks. + ReportScope JobReportScope } // Contains the configuration parameters for a Lambda Invoke operation. @@ -311,12 +311,6 @@ type LifecycleConfiguration struct { // The container of the Outposts bucket lifecycle expiration. type LifecycleExpiration struct { - // Indicates whether Amazon S3 will remove a delete marker with no noncurrent - // versions. If set to true, the delete marker will be expired. If set to false, - // the policy takes no action. This cannot be specified with Days or Date in a - // Lifecycle Expiration Policy. - ExpiredObjectDeleteMarker *bool - // Indicates at what date the object is to be deleted. Should be in GMT ISO 8601 // format. Date *time.Time @@ -324,24 +318,40 @@ type LifecycleExpiration struct { // Indicates the lifetime, in days, of the objects that are subject to the rule. // The value must be a non-zero positive integer. Days *int32 + + // Indicates whether Amazon S3 will remove a delete marker with no noncurrent + // versions. If set to true, the delete marker will be expired. If set to false, + // the policy takes no action. This cannot be specified with Days or Date in a + // Lifecycle Expiration Policy. + ExpiredObjectDeleteMarker *bool } // The container for the Outposts bucket lifecycle rule. type LifecycleRule struct { - // Unique identifier for the rule. The value cannot be longer than 255 characters. - ID *string + // If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is + // not currently being applied. + // + // This member is required. + Status ExpirationStatus - // The container for the filter of lifecycle rule. - Filter *LifecycleRuleFilter + // Specifies the days since the initiation of an incomplete multipart upload that + // Amazon S3 waits before permanently removing all parts of the upload. For more + // information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle + // Policy + // (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) + // in the Amazon Simple Storage Service Developer Guide. + AbortIncompleteMultipartUpload *AbortIncompleteMultipartUpload // Specifies the expiration for the lifecycle of the object in the form of date, // days and, whether the object has a delete marker. Expiration *LifecycleExpiration - // Specifies when an Amazon S3 object transitions to a specified storage class. - // This is not supported by Amazon S3 on Outposts buckets. - Transitions []*Transition + // The container for the filter of lifecycle rule. + Filter *LifecycleRuleFilter + + // Unique identifier for the rule. The value cannot be longer than 255 characters. + ID *string // The noncurrent version expiration of the lifecycle rule. This is not supported // by Amazon S3 on Outposts buckets. @@ -355,43 +365,33 @@ type LifecycleRule struct { // Amazon S3 on Outposts buckets. NoncurrentVersionTransitions []*NoncurrentVersionTransition - // If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is - // not currently being applied. - // - // This member is required. - Status ExpirationStatus - - // Specifies the days since the initiation of an incomplete multipart upload that - // Amazon S3 waits before permanently removing all parts of the upload. For more - // information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle - // Policy - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) - // in the Amazon Simple Storage Service Developer Guide. - AbortIncompleteMultipartUpload *AbortIncompleteMultipartUpload + // Specifies when an Amazon S3 object transitions to a specified storage class. + // This is not supported by Amazon S3 on Outposts buckets. + Transitions []*Transition } // The container for the Outposts bucket lifecycle rule and operator. type LifecycleRuleAndOperator struct { + // Prefix identifying one or more objects to which the rule applies. + Prefix *string + // All of these tags must exist in the object's tag set in order for the rule to // apply. Tags []*S3Tag - - // Prefix identifying one or more objects to which the rule applies. - Prefix *string } // The container for the filter of the lifecycle rule. type LifecycleRuleFilter struct { - // - Tag *S3Tag + // The container for the AND condition for the lifecycle rule. + And *LifecycleRuleAndOperator // Prefix identifying one or more objects to which the rule applies. Prefix *string - // The container for the AND condition for the lifecycle rule. - And *LifecycleRuleAndOperator + // + Tag *S3Tag } // The container of the noncurrent version expiration. @@ -440,22 +440,6 @@ type PolicyStatus struct { // Amazon S3 on Outposts. type PublicAccessBlockConfiguration struct { - // Specifies whether Amazon S3 should restrict public bucket policies for buckets - // in this account. Setting this element to TRUE restricts access to buckets with - // public policies to only AWS services and authorized users within this account. - // Enabling this setting doesn't affect previously stored bucket policies, except - // that public and cross-account access within any public bucket policy, including - // non-public delegation to specific accounts, is blocked. This is not supported - // for Amazon S3 on Outposts. - RestrictPublicBuckets *bool - - // Specifies whether Amazon S3 should block public bucket policies for buckets in - // this account. Setting this element to TRUE causes Amazon S3 to reject calls to - // PUT Bucket policy if the specified bucket policy allows public access. Enabling - // this setting doesn't affect existing bucket policies. This is not supported for - // Amazon S3 on Outposts. - BlockPublicPolicy *bool - // Specifies whether Amazon S3 should block public access control lists (ACLs) for // buckets in this account. Setting this element to TRUE causes the following // behavior: @@ -473,12 +457,28 @@ type PublicAccessBlockConfiguration struct { // not supported for Amazon S3 on Outposts. BlockPublicAcls *bool + // Specifies whether Amazon S3 should block public bucket policies for buckets in + // this account. Setting this element to TRUE causes Amazon S3 to reject calls to + // PUT Bucket policy if the specified bucket policy allows public access. Enabling + // this setting doesn't affect existing bucket policies. This is not supported for + // Amazon S3 on Outposts. + BlockPublicPolicy *bool + // Specifies whether Amazon S3 should ignore public ACLs for buckets in this // account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs // on buckets in this account and any objects that they contain. Enabling this // setting doesn't affect the persistence of any existing ACLs and doesn't prevent // new public ACLs from being set. This is not supported for Amazon S3 on Outposts. IgnorePublicAcls *bool + + // Specifies whether Amazon S3 should restrict public bucket policies for buckets + // in this account. Setting this element to TRUE restricts access to buckets with + // public policies to only AWS services and authorized users within this account. + // Enabling this setting doesn't affect previously stored bucket policies, except + // that public and cross-account access within any public bucket policy, including + // non-public delegation to specific accounts, is blocked. This is not supported + // for Amazon S3 on Outposts. + RestrictPublicBuckets *bool } // The container for the regional bucket. @@ -487,45 +487,45 @@ type RegionalBucket struct { // // // This member is required. - PublicAccessBlockEnabled *bool + Bucket *string + + // The creation date of the regional bucket + // + // This member is required. + CreationDate *time.Time // // // This member is required. - Bucket *string + PublicAccessBlockEnabled *bool // The Amazon Resource Name (ARN) for the regional bucket. BucketArn *string // The AWS Outposts ID of the regional bucket. OutpostId *string - - // The creation date of the regional bucket - // - // This member is required. - CreationDate *time.Time } // type S3AccessControlList struct { - // - Grants []*S3Grant - // // // This member is required. Owner *S3ObjectOwner + + // + Grants []*S3Grant } // type S3AccessControlPolicy struct { // - CannedAccessControlList S3CannedAccessControlList + AccessControlList *S3AccessControlList // - AccessControlList *S3AccessControlList + CannedAccessControlList S3CannedAccessControlList } // Contains the configuration parameters for a PUT Copy object operation. S3 Batch @@ -535,53 +535,53 @@ type S3AccessControlPolicy struct { type S3CopyObjectOperation struct { // - SSEAwsKmsKeyId *string + AccessControlGrants []*S3Grant - // The retention mode to be applied to all objects in the Batch Operations job. - ObjectLockMode S3ObjectLockMode + // + CannedAccessControlList S3CannedAccessControlList // - AccessControlGrants []*S3Grant + MetadataDirective S3MetadataDirective // - RedirectLocation *string + ModifiedSinceConstraint *time.Time - // The date when the applied object retention configuration expires on all objects - // in the Batch Operations job. - ObjectLockRetainUntilDate *time.Time + // + NewObjectMetadata *S3ObjectMetadata + + // + NewObjectTagging []*S3Tag // The legal hold status to be applied to all objects in the Batch Operations job. ObjectLockLegalHoldStatus S3ObjectLockLegalHoldStatus - // - MetadataDirective S3MetadataDirective - - // - TargetKeyPrefix *string + // The retention mode to be applied to all objects in the Batch Operations job. + ObjectLockMode S3ObjectLockMode - // - TargetResource *string + // The date when the applied object retention configuration expires on all objects + // in the Batch Operations job. + ObjectLockRetainUntilDate *time.Time // - NewObjectMetadata *S3ObjectMetadata + RedirectLocation *string // - CannedAccessControlList S3CannedAccessControlList + RequesterPays *bool // - NewObjectTagging []*S3Tag + SSEAwsKmsKeyId *string // - ModifiedSinceConstraint *time.Time + StorageClass S3StorageClass // - UnModifiedSinceConstraint *time.Time + TargetKeyPrefix *string // - RequesterPays *bool + TargetResource *string // - StorageClass S3StorageClass + UnModifiedSinceConstraint *time.Time } // @@ -597,14 +597,14 @@ type S3Grant struct { // type S3Grantee struct { - // - TypeIdentifier S3GranteeTypeIdentifier - // DisplayName *string // Identifier *string + + // + TypeIdentifier S3GranteeTypeIdentifier } // Contains the configuration parameters for an Initiate Glacier Restore job. S3 @@ -636,37 +636,37 @@ type S3ObjectLockLegalHold struct { type S3ObjectMetadata struct { // - ContentEncoding *string + CacheControl *string // ContentDisposition *string // - ContentType *string + ContentEncoding *string // - ContentLength *int64 + ContentLanguage *string // - CacheControl *string + ContentLength *int64 // - HttpExpiresDate *time.Time + ContentMD5 *string // - SSEAlgorithm S3SSEAlgorithm + ContentType *string // - UserMetadata map[string]*string + HttpExpiresDate *time.Time // - ContentMD5 *string + RequesterCharged *bool // - ContentLanguage *string + SSEAlgorithm S3SSEAlgorithm // - RequesterCharged *bool + UserMetadata map[string]*string } // @@ -687,13 +687,13 @@ type S3ObjectOwner struct { // in the Amazon Simple Storage Service Developer Guide. type S3Retention struct { - // The date when the applied Object Lock retention will expire on all objects set - // by the Batch Operations job. - RetainUntilDate *time.Time - // The Object Lock retention mode to be applied to all objects in the Batch // Operations job. Mode S3ObjectLockRetentionMode + + // The date when the applied Object Lock retention will expire on all objects set + // by the Batch Operations job. + RetainUntilDate *time.Time } // Contains the configuration parameters for a Set Object ACL operation. S3 Batch @@ -729,10 +729,6 @@ type S3SetObjectLegalHoldOperation struct { // in the Amazon Simple Storage Service Developer Guide. type S3SetObjectRetentionOperation struct { - // Indicates if the action should be applied to objects in the Batch Operations job - // even if they have Object Lock GOVERNANCE type in place. - BypassGovernanceRetention *bool - // Contains the Object Lock retention mode to be applied to all objects in the // Batch Operations job. For more information, see Using S3 Object Lock retention // with S3 Batch Operations @@ -741,6 +737,10 @@ type S3SetObjectRetentionOperation struct { // // This member is required. Retention *S3Retention + + // Indicates if the action should be applied to objects in the Batch Operations job + // even if they have Object Lock GOVERNANCE type in place. + BypassGovernanceRetention *bool } // Contains the configuration parameters for a Set Object Tagging operation. S3 @@ -760,12 +760,12 @@ type S3Tag struct { // // // This member is required. - Value *string + Key *string // // // This member is required. - Key *string + Value *string } // @@ -788,12 +788,12 @@ type Transition struct { // value must be in ISO 8601 format. The time is always midnight UTC. Date *time.Time - // The storage class to which you want the object to transition. - StorageClass TransitionStorageClass - // Indicates the number of days after creation when objects are transitioned to the // specified storage class. The value must be a positive integer. Days *int32 + + // The storage class to which you want the object to transition. + StorageClass TransitionStorageClass } // The virtual private cloud (VPC) configuration for an access point. diff --git a/service/sagemaker/api_op_AddTags.go b/service/sagemaker/api_op_AddTags.go index c1ab925638f..c1eea848b24 100644 --- a/service/sagemaker/api_op_AddTags.go +++ b/service/sagemaker/api_op_AddTags.go @@ -71,17 +71,17 @@ func (c *Client) AddTags(ctx context.Context, params *AddTagsInput, optFns ...fu type AddTagsInput struct { + // The Amazon Resource Name (ARN) of the resource that you want to tag. + // + // This member is required. + ResourceArn *string + // An array of Tag objects. Each tag is a key-value pair. Only the key parameter is // required. If you don't specify a value, Amazon SageMaker sets the value to an // empty string. // // This member is required. Tags []*types.Tag - - // The Amazon Resource Name (ARN) of the resource that you want to tag. - // - // This member is required. - ResourceArn *string } type AddTagsOutput struct { diff --git a/service/sagemaker/api_op_AssociateTrialComponent.go b/service/sagemaker/api_op_AssociateTrialComponent.go index e5542aa1341..93dd690e2f4 100644 --- a/service/sagemaker/api_op_AssociateTrialComponent.go +++ b/service/sagemaker/api_op_AssociateTrialComponent.go @@ -71,12 +71,12 @@ type AssociateTrialComponentInput struct { type AssociateTrialComponentOutput struct { - // The ARN of the trial component. - TrialComponentArn *string - // The Amazon Resource Name (ARN) of the trial. TrialArn *string + // The ARN of the trial component. + TrialComponentArn *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_CreateAlgorithm.go b/service/sagemaker/api_op_CreateAlgorithm.go index fe24d4f3534..1b5eae3b6d4 100644 --- a/service/sagemaker/api_op_CreateAlgorithm.go +++ b/service/sagemaker/api_op_CreateAlgorithm.go @@ -58,6 +58,11 @@ func (c *Client) CreateAlgorithm(ctx context.Context, params *CreateAlgorithmInp type CreateAlgorithmInput struct { + // The name of the algorithm. + // + // This member is required. + AlgorithmName *string + // Specifies details about training jobs run by this algorithm, including the // following: // @@ -85,6 +90,12 @@ type CreateAlgorithmInput struct { // This member is required. TrainingSpecification *types.TrainingSpecification + // A description of the algorithm. + AlgorithmDescription *string + + // Whether to certify the algorithm so that it can be listed in AWS Marketplace. + CertifyForMarketplace *bool + // Specifies details about inference jobs that the algorithm runs, including the // following: // @@ -98,17 +109,6 @@ type CreateAlgorithmInput struct { // and output content formats that the algorithm supports for inference. InferenceSpecification *types.InferenceSpecification - // A description of the algorithm. - AlgorithmDescription *string - - // Whether to certify the algorithm so that it can be listed in AWS Marketplace. - CertifyForMarketplace *bool - - // The name of the algorithm. - // - // This member is required. - AlgorithmName *string - // Specifies configurations for one or more training jobs and that Amazon SageMaker // runs to test the algorithm's training code and, optionally, one or more batch // transform jobs that Amazon SageMaker runs to test the algorithm's inference diff --git a/service/sagemaker/api_op_CreateApp.go b/service/sagemaker/api_op_CreateApp.go index 6f7cdbc50be..8a18ab5fed7 100644 --- a/service/sagemaker/api_op_CreateApp.go +++ b/service/sagemaker/api_op_CreateApp.go @@ -61,10 +61,6 @@ func (c *Client) CreateApp(ctx context.Context, params *CreateAppInput, optFns . type CreateAppInput struct { - // The instance type and the Amazon Resource Name (ARN) of the SageMaker image - // created on the instance. - ResourceSpec *types.ResourceSpec - // The name of the app. // // This member is required. @@ -85,6 +81,10 @@ type CreateAppInput struct { // This member is required. UserProfileName *string + // The instance type and the Amazon Resource Name (ARN) of the SageMaker image + // created on the instance. + ResourceSpec *types.ResourceSpec + // Each tag consists of a key and an optional value. Tag keys must be unique per // resource. Tags []*types.Tag diff --git a/service/sagemaker/api_op_CreateAutoMLJob.go b/service/sagemaker/api_op_CreateAutoMLJob.go index ebaae569a0f..fa319b909dc 100644 --- a/service/sagemaker/api_op_CreateAutoMLJob.go +++ b/service/sagemaker/api_op_CreateAutoMLJob.go @@ -69,21 +69,17 @@ type CreateAutoMLJobInput struct { // This member is required. AutoMLJobName *string - // Defines the job's objective. You provide a MetricName and AutoML will infer - // minimize or maximize. If this is not provided, the most commonly used - // ObjectiveMetric for problem type will be selected. - AutoMLJobObjective *types.AutoMLJobObjective - - // Defines the kind of preprocessing and algorithms intended for the candidates. - // Options include: BinaryClassification, MulticlassClassification, and Regression. - ProblemType types.ProblemType - // Similar to InputDataConfig supported by Tuning. Format(s) supported: CSV. // Minimum of 1000 rows. // // This member is required. InputDataConfig []*types.AutoMLChannel + // Similar to OutputDataConfig supported by Tuning. Format(s) supported: CSV. + // + // This member is required. + OutputDataConfig *types.AutoMLOutputDataConfig + // The ARN of the role that will be used to access the data. // // This member is required. @@ -92,15 +88,19 @@ type CreateAutoMLJobInput struct { // Contains CompletionCriteria and SecurityConfig. AutoMLJobConfig *types.AutoMLJobConfig + // Defines the job's objective. You provide a MetricName and AutoML will infer + // minimize or maximize. If this is not provided, the most commonly used + // ObjectiveMetric for problem type will be selected. + AutoMLJobObjective *types.AutoMLJobObjective + // This will generate possible candidates without training a model. A candidate is // a combination of data preprocessors, algorithms, and algorithm parameter // settings. GenerateCandidateDefinitionsOnly *bool - // Similar to OutputDataConfig supported by Tuning. Format(s) supported: CSV. - // - // This member is required. - OutputDataConfig *types.AutoMLOutputDataConfig + // Defines the kind of preprocessing and algorithms intended for the candidates. + // Options include: BinaryClassification, MulticlassClassification, and Regression. + ProblemType types.ProblemType // Each tag consists of a key and an optional value. Tag keys must be unique per // resource. diff --git a/service/sagemaker/api_op_CreateCodeRepository.go b/service/sagemaker/api_op_CreateCodeRepository.go index ae5639ad662..b51907fd0ea 100644 --- a/service/sagemaker/api_op_CreateCodeRepository.go +++ b/service/sagemaker/api_op_CreateCodeRepository.go @@ -65,17 +65,17 @@ func (c *Client) CreateCodeRepository(ctx context.Context, params *CreateCodeRep type CreateCodeRepositoryInput struct { - // Specifies details about the repository, including the URL where the repository - // is located, the default branch, and credentials to use to access the repository. - // - // This member is required. - GitConfig *types.GitConfig - // The name of the Git repository. The name must have 1 to 63 characters. Valid // characters are a-z, A-Z, 0-9, and - (hyphen). // // This member is required. CodeRepositoryName *string + + // Specifies details about the repository, including the URL where the repository + // is located, the default branch, and credentials to use to access the repository. + // + // This member is required. + GitConfig *types.GitConfig } type CreateCodeRepositoryOutput struct { diff --git a/service/sagemaker/api_op_CreateCompilationJob.go b/service/sagemaker/api_op_CreateCompilationJob.go index 1ad449ddb87..3d54339b9bd 100644 --- a/service/sagemaker/api_op_CreateCompilationJob.go +++ b/service/sagemaker/api_op_CreateCompilationJob.go @@ -82,18 +82,11 @@ func (c *Client) CreateCompilationJob(ctx context.Context, params *CreateCompila type CreateCompilationJobInput struct { - // Provides information about the output location for the compiled model and the - // target device the model runs on. - // - // This member is required. - OutputConfig *types.OutputConfig - - // Specifies a limit to how long a model compilation job can run. When the job - // reaches the time limit, Amazon SageMaker ends the compilation job. Use this API - // to cap model training costs. + // A name for the model compilation job. The name must be unique within the AWS + // Region and within your AWS account. // // This member is required. - StoppingCondition *types.StoppingCondition + CompilationJobName *string // Provides information about the location of input model artifacts, the name and // shape of the expected data inputs, and the framework in which the model was @@ -102,6 +95,12 @@ type CreateCompilationJobInput struct { // This member is required. InputConfig *types.InputConfig + // Provides information about the output location for the compiled model and the + // target device the model runs on. + // + // This member is required. + OutputConfig *types.OutputConfig + // The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to // perform tasks on your behalf. During model compilation, Amazon SageMaker needs // your permission to: @@ -125,11 +124,12 @@ type CreateCompilationJobInput struct { // This member is required. RoleArn *string - // A name for the model compilation job. The name must be unique within the AWS - // Region and within your AWS account. + // Specifies a limit to how long a model compilation job can run. When the job + // reaches the time limit, Amazon SageMaker ends the compilation job. Use this API + // to cap model training costs. // // This member is required. - CompilationJobName *string + StoppingCondition *types.StoppingCondition } type CreateCompilationJobOutput struct { diff --git a/service/sagemaker/api_op_CreateDomain.go b/service/sagemaker/api_op_CreateDomain.go index 03e7ce923f1..33faef543ac 100644 --- a/service/sagemaker/api_op_CreateDomain.go +++ b/service/sagemaker/api_op_CreateDomain.go @@ -69,27 +69,32 @@ func (c *Client) CreateDomain(ctx context.Context, params *CreateDomainInput, op type CreateDomainInput struct { - // The ID of the Amazon Virtual Private Cloud (VPC) to use for communication with - // the EFS volume. + // The mode of authentication that members use to access the domain. // // This member is required. - VpcId *string + AuthMode types.AuthMode // The default user settings. // // This member is required. DefaultUserSettings *types.UserSettings - // The mode of authentication that members use to access the domain. + // A name for the domain. // // This member is required. - AuthMode types.AuthMode + DomainName *string // The VPC subnets to use for communication with the EFS volume. // // This member is required. SubnetIds []*string + // The ID of the Amazon Virtual Private Cloud (VPC) to use for communication with + // the EFS volume. + // + // This member is required. + VpcId *string + // The AWS Key Management Service (KMS) encryption key ID. Encryption with a // customer master key (CMK) is not supported. HomeEfsFileSystemKmsKeyId *string @@ -98,21 +103,16 @@ type CreateDomainInput struct { // value. Tag keys must be unique per resource. Tags are searchable using the // Search () API. Tags []*types.Tag - - // A name for the domain. - // - // This member is required. - DomainName *string } type CreateDomainOutput struct { - // The URL to the created domain. - Url *string - // The Amazon Resource Name (ARN) of the created domain. DomainArn *string + // The URL to the created domain. + Url *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_CreateEndpoint.go b/service/sagemaker/api_op_CreateEndpoint.go index 2a03ab9acc1..15f7c9d0edc 100644 --- a/service/sagemaker/api_op_CreateEndpoint.go +++ b/service/sagemaker/api_op_CreateEndpoint.go @@ -94,11 +94,11 @@ func (c *Client) CreateEndpoint(ctx context.Context, params *CreateEndpointInput type CreateEndpointInput struct { - // An array of key-value pairs. For more information, see Using Cost Allocation - // Tags - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what)in - // the AWS Billing and Cost Management User Guide.

      - Tags []*types.Tag + // The name of an endpoint configuration. For more information, see + // CreateEndpointConfig (). + // + // This member is required. + EndpointConfigName *string // The name of the endpoint. The name must be unique within an AWS Region in your // AWS account. @@ -106,11 +106,11 @@ type CreateEndpointInput struct { // This member is required. EndpointName *string - // The name of an endpoint configuration. For more information, see - // CreateEndpointConfig (). - // - // This member is required. - EndpointConfigName *string + // An array of key-value pairs. For more information, see Using Cost Allocation + // Tags + // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what)in + // the AWS Billing and Cost Management User Guide.

      + Tags []*types.Tag } type CreateEndpointOutput struct { diff --git a/service/sagemaker/api_op_CreateEndpointConfig.go b/service/sagemaker/api_op_CreateEndpointConfig.go index 55833556ed4..764fc81f8a9 100644 --- a/service/sagemaker/api_op_CreateEndpointConfig.go +++ b/service/sagemaker/api_op_CreateEndpointConfig.go @@ -84,6 +84,21 @@ func (c *Client) CreateEndpointConfig(ctx context.Context, params *CreateEndpoin type CreateEndpointConfigInput struct { + // The name of the endpoint configuration. You specify this name in a + // CreateEndpoint () request. + // + // This member is required. + EndpointConfigName *string + + // An list of ProductionVariant objects, one for each model that you want to host + // at this endpoint. + // + // This member is required. + ProductionVariants []*types.ProductionVariant + + // + DataCaptureConfig *types.DataCaptureConfig + // The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon // SageMaker uses to encrypt data on the storage volume attached to the ML compute // instance that hosts the endpoint. The KmsKeyId can be any of the following @@ -120,25 +135,10 @@ type CreateEndpointConfigInput struct { // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html). KmsKeyId *string - // The name of the endpoint configuration. You specify this name in a - // CreateEndpoint () request. - // - // This member is required. - EndpointConfigName *string - // A list of key-value pairs. For more information, see Using Cost Allocation Tags // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) // in the AWS Billing and Cost Management User Guide. Tags []*types.Tag - - // An list of ProductionVariant objects, one for each model that you want to host - // at this endpoint. - // - // This member is required. - ProductionVariants []*types.ProductionVariant - - // - DataCaptureConfig *types.DataCaptureConfig } type CreateEndpointConfigOutput struct { diff --git a/service/sagemaker/api_op_CreateExperiment.go b/service/sagemaker/api_op_CreateExperiment.go index f1530ee658f..3ec5528eec8 100644 --- a/service/sagemaker/api_op_CreateExperiment.go +++ b/service/sagemaker/api_op_CreateExperiment.go @@ -73,15 +73,15 @@ func (c *Client) CreateExperiment(ctx context.Context, params *CreateExperimentI type CreateExperimentInput struct { - // The description of the experiment. - Description *string - // The name of the experiment. The name must be unique in your AWS account and is // not case-sensitive. // // This member is required. ExperimentName *string + // The description of the experiment. + Description *string + // The name of the experiment as displayed. The name doesn't need to be unique. If // you don't specify DisplayName, the value in ExperimentName is displayed. DisplayName *string diff --git a/service/sagemaker/api_op_CreateFlowDefinition.go b/service/sagemaker/api_op_CreateFlowDefinition.go index 2f375983d21..1a97337c933 100644 --- a/service/sagemaker/api_op_CreateFlowDefinition.go +++ b/service/sagemaker/api_op_CreateFlowDefinition.go @@ -57,41 +57,41 @@ func (c *Client) CreateFlowDefinition(ctx context.Context, params *CreateFlowDef type CreateFlowDefinitionInput struct { + // The name of your flow definition. + // + // This member is required. + FlowDefinitionName *string + // An object containing information about the tasks the human reviewers will // perform. // // This member is required. HumanLoopConfig *types.HumanLoopConfig - // Container for configuring the source of human task requests. Use to specify if - // Amazon Rekognition or Amazon Textract is used as an integration source. - HumanLoopRequestSource *types.HumanLoopRequestSource + // An object containing information about where the human review results will be + // uploaded. + // + // This member is required. + OutputConfig *types.FlowDefinitionOutputConfig - // The name of your flow definition. + // The Amazon Resource Name (ARN) of the role needed to call other services on your + // behalf. For example, + // arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298. // // This member is required. - FlowDefinitionName *string + RoleArn *string // An object containing information about the events that trigger a human workflow. HumanLoopActivationConfig *types.HumanLoopActivationConfig + // Container for configuring the source of human task requests. Use to specify if + // Amazon Rekognition or Amazon Textract is used as an integration source. + HumanLoopRequestSource *types.HumanLoopRequestSource + // An array of key-value pairs that contain metadata to help you categorize and // organize a flow definition. Each tag consists of a key and a value, both of // which you define. Tags []*types.Tag - - // The Amazon Resource Name (ARN) of the role needed to call other services on your - // behalf. For example, - // arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298. - // - // This member is required. - RoleArn *string - - // An object containing information about where the human review results will be - // uploaded. - // - // This member is required. - OutputConfig *types.FlowDefinitionOutputConfig } type CreateFlowDefinitionOutput struct { diff --git a/service/sagemaker/api_op_CreateHumanTaskUi.go b/service/sagemaker/api_op_CreateHumanTaskUi.go index e9d174f81a2..757aaed7599 100644 --- a/service/sagemaker/api_op_CreateHumanTaskUi.go +++ b/service/sagemaker/api_op_CreateHumanTaskUi.go @@ -64,15 +64,15 @@ type CreateHumanTaskUiInput struct { // This member is required. HumanTaskUiName *string - // An array of key-value pairs that contain metadata to help you categorize and - // organize a human review workflow user interface. Each tag consists of a key and - // a value, both of which you define. - Tags []*types.Tag - // The Liquid template for the worker user interface. // // This member is required. UiTemplate *types.UiTemplate + + // An array of key-value pairs that contain metadata to help you categorize and + // organize a human review workflow user interface. Each tag consists of a key and + // a value, both of which you define. + Tags []*types.Tag } type CreateHumanTaskUiOutput struct { diff --git a/service/sagemaker/api_op_CreateHyperParameterTuningJob.go b/service/sagemaker/api_op_CreateHyperParameterTuningJob.go index b8dbf172d96..fe091145aba 100644 --- a/service/sagemaker/api_op_CreateHyperParameterTuningJob.go +++ b/service/sagemaker/api_op_CreateHyperParameterTuningJob.go @@ -61,13 +61,14 @@ func (c *Client) CreateHyperParameterTuningJob(ctx context.Context, params *Crea type CreateHyperParameterTuningJobInput struct { - // An array of key-value pairs. You can use tags to categorize your AWS resources - // in different ways, for example, by purpose, owner, or environment. For more - // information, see AWS Tagging Strategies - // (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/). - // Tags that you specify for the tuning job are also added to all training jobs - // that the tuning job launches. - Tags []*types.Tag + // The HyperParameterTuningJobConfig () object that describes the tuning job, + // including the search strategy, the objective metric used to evaluate training + // jobs, ranges of parameters to search, and resource limits for the tuning job. + // For more information, see How Hyperparameter Tuning Works + // (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html). + // + // This member is required. + HyperParameterTuningJobConfig *types.HyperParameterTuningJobConfig // The name of the tuning job. This name is the prefix for the names of all // training jobs that this tuning job launches. The name must be unique within the @@ -78,9 +79,13 @@ type CreateHyperParameterTuningJobInput struct { // This member is required. HyperParameterTuningJobName *string - // A list of the HyperParameterTrainingJobDefinition () objects launched for this - // tuning job. - TrainingJobDefinitions []*types.HyperParameterTrainingJobDefinition + // An array of key-value pairs. You can use tags to categorize your AWS resources + // in different ways, for example, by purpose, owner, or environment. For more + // information, see AWS Tagging Strategies + // (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/). + // Tags that you specify for the tuning job are also added to all training jobs + // that the tuning job launches. + Tags []*types.Tag // The HyperParameterTrainingJobDefinition () object that describes the training // jobs that this tuning job launches, including static hyperparameters, input data @@ -88,14 +93,9 @@ type CreateHyperParameterTuningJobInput struct { // condition. TrainingJobDefinition *types.HyperParameterTrainingJobDefinition - // The HyperParameterTuningJobConfig () object that describes the tuning job, - // including the search strategy, the objective metric used to evaluate training - // jobs, ranges of parameters to search, and resource limits for the tuning job. - // For more information, see How Hyperparameter Tuning Works - // (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html). - // - // This member is required. - HyperParameterTuningJobConfig *types.HyperParameterTuningJobConfig + // A list of the HyperParameterTrainingJobDefinition () objects launched for this + // tuning job. + TrainingJobDefinitions []*types.HyperParameterTrainingJobDefinition // Specifies the configuration for starting the hyperparameter tuning job using one // or more previous tuning jobs as a starting point. The results of previous tuning diff --git a/service/sagemaker/api_op_CreateLabelingJob.go b/service/sagemaker/api_op_CreateLabelingJob.go index 492c14ee8b2..82fbc2f80ba 100644 --- a/service/sagemaker/api_op_CreateLabelingJob.go +++ b/service/sagemaker/api_op_CreateLabelingJob.go @@ -85,10 +85,11 @@ func (c *Client) CreateLabelingJob(ctx context.Context, params *CreateLabelingJo type CreateLabelingJobInput struct { - // A set of conditions for stopping the labeling job. If any of the conditions are - // met, the job is automatically stopped. You can use these conditions to control - // the cost of data labeling. - StoppingConditions *types.LabelingJobStoppingConditions + // Configures the labeling task and how it is presented to workers; including, but + // not limited to price, keywords, and batch size (task count). + // + // This member is required. + HumanTaskConfig *types.HumanTaskConfig // Input data for the labeling job, such as the Amazon S3 location of the data // objects and the location of the manifest file that describes the data objects. @@ -96,11 +97,15 @@ type CreateLabelingJobInput struct { // This member is required. InputConfig *types.LabelingJobInputConfig - // Configures the labeling task and how it is presented to workers; including, but - // not limited to price, keywords, and batch size (task count). + // The attribute name to use for the label in the output manifest file. This is the + // key for the key/value pair formed with the label that a worker assigns to the + // object. The name can't end with "-metadata". If you are running a semantic + // segmentation labeling job, the attribute name must end with "-ref". If you are + // running any other kind of labeling job, the attribute name must not end with + // "-ref". // // This member is required. - HumanTaskConfig *types.HumanTaskConfig + LabelAttributeName *string // The name of the labeling job. This name is used to identify the job in a list of // labeling jobs. @@ -108,11 +113,18 @@ type CreateLabelingJobInput struct { // This member is required. LabelingJobName *string - // An array of key/value pairs. For more information, see Using Cost Allocation - // Tags - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) - // in the AWS Billing and Cost Management User Guide. - Tags []*types.Tag + // The location of the output data and the AWS Key Management Service key ID for + // the key used to encrypt the output data, if any. + // + // This member is required. + OutputConfig *types.LabelingJobOutputConfig + + // The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks + // on your behalf during data labeling. You must grant this role the necessary + // permissions so that Amazon SageMaker can successfully complete data labeling. + // + // This member is required. + RoleArn *string // The S3 URL of the file that defines the categories used to label the data // objects. For 3D point cloud task types, see Create a Labeling Category @@ -157,31 +169,19 @@ type CreateLabelingJobInput struct { // } LabelCategoryConfigS3Uri *string - // The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks - // on your behalf during data labeling. You must grant this role the necessary - // permissions so that Amazon SageMaker can successfully complete data labeling. - // - // This member is required. - RoleArn *string - - // The attribute name to use for the label in the output manifest file. This is the - // key for the key/value pair formed with the label that a worker assigns to the - // object. The name can't end with "-metadata". If you are running a semantic - // segmentation labeling job, the attribute name must end with "-ref". If you are - // running any other kind of labeling job, the attribute name must not end with - // "-ref". - // - // This member is required. - LabelAttributeName *string - // Configures the information required to perform automated data labeling. LabelingJobAlgorithmsConfig *types.LabelingJobAlgorithmsConfig - // The location of the output data and the AWS Key Management Service key ID for - // the key used to encrypt the output data, if any. - // - // This member is required. - OutputConfig *types.LabelingJobOutputConfig + // A set of conditions for stopping the labeling job. If any of the conditions are + // met, the job is automatically stopped. You can use these conditions to control + // the cost of data labeling. + StoppingConditions *types.LabelingJobStoppingConditions + + // An array of key/value pairs. For more information, see Using Cost Allocation + // Tags + // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) + // in the AWS Billing and Cost Management User Guide. + Tags []*types.Tag } type CreateLabelingJobOutput struct { diff --git a/service/sagemaker/api_op_CreateModel.go b/service/sagemaker/api_op_CreateModel.go index 7148d01e972..321e5dda5b3 100644 --- a/service/sagemaker/api_op_CreateModel.go +++ b/service/sagemaker/api_op_CreateModel.go @@ -78,25 +78,6 @@ func (c *Client) CreateModel(ctx context.Context, params *CreateModelInput, optF type CreateModelInput struct { - // A VpcConfig () object that specifies the VPC that you want your model to connect - // to. Control access to and from your model container by configuring the VPC. - // VpcConfig is used in hosting services and in batch transform. For more - // information, see Protect Endpoints by Using an Amazon Virtual Private Cloud - // (https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) and Protect Data - // in Batch Transform Jobs by Using an Amazon Virtual Private Cloud - // (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-vpc.html). - VpcConfig *types.VpcConfig - - // Isolates the model container. No inbound or outbound network calls can be made - // to or from the model container. - EnableNetworkIsolation *bool - - // An array of key-value pairs. For more information, see Using Cost Allocation - // Tags - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) - // in the AWS Billing and Cost Management User Guide. - Tags []*types.Tag - // The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume // to access model artifacts and docker image for deployment on ML compute // instances or for batch transform jobs. Deploying on ML compute instances is part @@ -108,11 +89,6 @@ type CreateModelInput struct { // This member is required. ExecutionRoleArn *string - // The location of the primary docker image containing inference code, associated - // artifacts, and custom environment map that the inference code uses when the - // model is deployed for predictions. - PrimaryContainer *types.ContainerDefinition - // The name of the new model. // // This member is required. @@ -120,6 +96,30 @@ type CreateModelInput struct { // Specifies the containers in the inference pipeline. Containers []*types.ContainerDefinition + + // Isolates the model container. No inbound or outbound network calls can be made + // to or from the model container. + EnableNetworkIsolation *bool + + // The location of the primary docker image containing inference code, associated + // artifacts, and custom environment map that the inference code uses when the + // model is deployed for predictions. + PrimaryContainer *types.ContainerDefinition + + // An array of key-value pairs. For more information, see Using Cost Allocation + // Tags + // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) + // in the AWS Billing and Cost Management User Guide. + Tags []*types.Tag + + // A VpcConfig () object that specifies the VPC that you want your model to connect + // to. Control access to and from your model container by configuring the VPC. + // VpcConfig is used in hosting services and in batch transform. For more + // information, see Protect Endpoints by Using an Amazon Virtual Private Cloud + // (https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) and Protect Data + // in Batch Transform Jobs by Using an Amazon Virtual Private Cloud + // (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-vpc.html). + VpcConfig *types.VpcConfig } type CreateModelOutput struct { diff --git a/service/sagemaker/api_op_CreateModelPackage.go b/service/sagemaker/api_op_CreateModelPackage.go index 8d8b6d94336..92a8ca85131 100644 --- a/service/sagemaker/api_op_CreateModelPackage.go +++ b/service/sagemaker/api_op_CreateModelPackage.go @@ -63,15 +63,14 @@ func (c *Client) CreateModelPackage(ctx context.Context, params *CreateModelPack type CreateModelPackageInput struct { - // Details about the algorithm that was used to create the model package. - SourceAlgorithmSpecification *types.SourceAlgorithmSpecification - - // Specifies configurations for one or more transform jobs that Amazon SageMaker - // runs to test the model package. - ValidationSpecification *types.ModelPackageValidationSpecification + // The name of the model package. The name must have 1 to 63 characters. Valid + // characters are a-z, A-Z, 0-9, and - (hyphen). + // + // This member is required. + ModelPackageName *string - // A description of the model package. - ModelPackageDescription *string + // Whether to certify the model package for listing on AWS Marketplace. + CertifyForMarketplace *bool // Specifies details about inference jobs that can be run with models based on this // model package, including the following: @@ -87,14 +86,15 @@ type CreateModelPackageInput struct { // the model package supports for inference. InferenceSpecification *types.InferenceSpecification - // The name of the model package. The name must have 1 to 63 characters. Valid - // characters are a-z, A-Z, 0-9, and - (hyphen). - // - // This member is required. - ModelPackageName *string + // A description of the model package. + ModelPackageDescription *string - // Whether to certify the model package for listing on AWS Marketplace. - CertifyForMarketplace *bool + // Details about the algorithm that was used to create the model package. + SourceAlgorithmSpecification *types.SourceAlgorithmSpecification + + // Specifies configurations for one or more transform jobs that Amazon SageMaker + // runs to test the model package. + ValidationSpecification *types.ModelPackageValidationSpecification } type CreateModelPackageOutput struct { diff --git a/service/sagemaker/api_op_CreateMonitoringSchedule.go b/service/sagemaker/api_op_CreateMonitoringSchedule.go index b922fdd54cd..38e70a97e0f 100644 --- a/service/sagemaker/api_op_CreateMonitoringSchedule.go +++ b/service/sagemaker/api_op_CreateMonitoringSchedule.go @@ -58,18 +58,18 @@ func (c *Client) CreateMonitoringSchedule(ctx context.Context, params *CreateMon type CreateMonitoringScheduleInput struct { - // The name of the monitoring schedule. The name must be unique within an AWS - // Region within an AWS account. - // - // This member is required. - MonitoringScheduleName *string - // The configuration object that specifies the monitoring schedule and defines the // monitoring job. // // This member is required. MonitoringScheduleConfig *types.MonitoringScheduleConfig + // The name of the monitoring schedule. The name must be unique within an AWS + // Region within an AWS account. + // + // This member is required. + MonitoringScheduleName *string + // (Optional) An array of key-value pairs. For more information, see Using Cost // Allocation Tags // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) diff --git a/service/sagemaker/api_op_CreateNotebookInstance.go b/service/sagemaker/api_op_CreateNotebookInstance.go index 3d52d9d65c0..797bcd1c2ef 100644 --- a/service/sagemaker/api_op_CreateNotebookInstance.go +++ b/service/sagemaker/api_op_CreateNotebookInstance.go @@ -88,15 +88,34 @@ func (c *Client) CreateNotebookInstance(ctx context.Context, params *CreateNoteb type CreateNotebookInstanceInput struct { - // A Git repository to associate with the notebook instance as its default code - // repository. This can be either the name of a Git repository stored as a resource - // in your account, or the URL of a Git repository in AWS CodeCommit - // (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any - // other Git repository. When you open a notebook instance, it opens in the - // directory that contains this repository. For more information, see Associating - // Git Repositories with Amazon SageMaker Notebook Instances - // (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). - DefaultCodeRepository *string + // The type of ML compute instance to launch for the notebook instance. + // + // This member is required. + InstanceType types.InstanceType + + // The name of the new notebook instance. + // + // This member is required. + NotebookInstanceName *string + + // When you send any requests to AWS resources from the notebook instance, Amazon + // SageMaker assumes this role to perform tasks on your behalf. You must grant this + // role necessary permissions so Amazon SageMaker can perform these tasks. The + // policy must allow the Amazon SageMaker service principal + // (sagemaker.amazonaws.com) permissions to assume this role. For more information, + // see Amazon SageMaker Roles + // (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html). To be + // able to pass this role to Amazon SageMaker, the caller of this API must have the + // iam:PassRole permission. + // + // This member is required. + RoleArn *string + + // A list of Elastic Inference (EI) instance types to associate with this notebook + // instance. Currently, only one instance type can be associated with a notebook + // instance. For more information, see Using Elastic Inference in Amazon SageMaker + // (https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html). + AcceleratorTypes []types.NotebookInstanceAcceleratorType // An array of up to three Git repositories to associate with the notebook // instance. These can be either the names of Git repositories stored as resources @@ -108,6 +127,16 @@ type CreateNotebookInstanceInput struct { // (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). AdditionalCodeRepositories []*string + // A Git repository to associate with the notebook instance as its default code + // repository. This can be either the name of a Git repository stored as a resource + // in your account, or the URL of a Git repository in AWS CodeCommit + // (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any + // other Git repository. When you open a notebook instance, it opens in the + // directory that contains this repository. For more information, see Associating + // Git Repositories with Amazon SageMaker Notebook Instances + // (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). + DefaultCodeRepository *string + // Sets whether Amazon SageMaker provides internet access to the notebook instance. // If you set this to Disabled this notebook instance will be able to access // resources only in your VPC, and will not be able to connect to Amazon SageMaker @@ -118,15 +147,13 @@ type CreateNotebookInstanceInput struct { // the SubnetId parameter. DirectInternetAccess types.DirectInternetAccess - // The ID of the subnet in a VPC to which you would like to have a connectivity - // from your ML compute instance. - SubnetId *string - - // A list of Elastic Inference (EI) instance types to associate with this notebook - // instance. Currently, only one instance type can be associated with a notebook - // instance. For more information, see Using Elastic Inference in Amazon SageMaker - // (https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html). - AcceleratorTypes []types.NotebookInstanceAcceleratorType + // The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon + // SageMaker uses to encrypt data on the storage volume attached to your notebook + // instance. The KMS key you provide must be enabled. For information, see Enabling + // and Disabling Keys + // (https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html) in + // the AWS Key Management Service Developer Guide. + KmsKeyId *string // The name of a lifecycle configuration to associate with the notebook instance. // For information about lifestyle configurations, see Step 2.1: (Optional) @@ -141,48 +168,21 @@ type CreateNotebookInstanceInput struct { // disable root access for users. RootAccess types.RootAccess - // The type of ML compute instance to launch for the notebook instance. - // - // This member is required. - InstanceType types.InstanceType + // The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be + // for the same VPC as specified in the subnet. + SecurityGroupIds []*string - // The size, in GB, of the ML storage volume to attach to the notebook instance. - // The default value is 5 GB. - VolumeSizeInGB *int32 + // The ID of the subnet in a VPC to which you would like to have a connectivity + // from your ML compute instance. + SubnetId *string // A list of tags to associate with the notebook instance. You can add tags later // by using the CreateTags API. Tags []*types.Tag - // The name of the new notebook instance. - // - // This member is required. - NotebookInstanceName *string - - // The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon - // SageMaker uses to encrypt data on the storage volume attached to your notebook - // instance. The KMS key you provide must be enabled. For information, see Enabling - // and Disabling Keys - // (https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html) in - // the AWS Key Management Service Developer Guide. - KmsKeyId *string - - // When you send any requests to AWS resources from the notebook instance, Amazon - // SageMaker assumes this role to perform tasks on your behalf. You must grant this - // role necessary permissions so Amazon SageMaker can perform these tasks. The - // policy must allow the Amazon SageMaker service principal - // (sagemaker.amazonaws.com) permissions to assume this role. For more information, - // see Amazon SageMaker Roles - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html). To be - // able to pass this role to Amazon SageMaker, the caller of this API must have the - // iam:PassRole permission. - // - // This member is required. - RoleArn *string - - // The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be - // for the same VPC as specified in the subnet. - SecurityGroupIds []*string + // The size, in GB, of the ML storage volume to attach to the notebook instance. + // The default value is 5 GB. + VolumeSizeInGB *int32 } type CreateNotebookInstanceOutput struct { diff --git a/service/sagemaker/api_op_CreateNotebookInstanceLifecycleConfig.go b/service/sagemaker/api_op_CreateNotebookInstanceLifecycleConfig.go index fab568fc76d..4af9a8a33d5 100644 --- a/service/sagemaker/api_op_CreateNotebookInstanceLifecycleConfig.go +++ b/service/sagemaker/api_op_CreateNotebookInstanceLifecycleConfig.go @@ -69,6 +69,11 @@ func (c *Client) CreateNotebookInstanceLifecycleConfig(ctx context.Context, para type CreateNotebookInstanceLifecycleConfigInput struct { + // The name of the lifecycle configuration. + // + // This member is required. + NotebookInstanceLifecycleConfigName *string + // A shell script that runs only once, when you create a notebook instance. The // shell script must be a base64-encoded string. OnCreate []*types.NotebookInstanceLifecycleHook @@ -77,11 +82,6 @@ type CreateNotebookInstanceLifecycleConfigInput struct { // when you create the notebook instance. The shell script must be a base64-encoded // string. OnStart []*types.NotebookInstanceLifecycleHook - - // The name of the lifecycle configuration. - // - // This member is required. - NotebookInstanceLifecycleConfigName *string } type CreateNotebookInstanceLifecycleConfigOutput struct { diff --git a/service/sagemaker/api_op_CreatePresignedDomainUrl.go b/service/sagemaker/api_op_CreatePresignedDomainUrl.go index aa777c14ca8..1ddf6406c8e 100644 --- a/service/sagemaker/api_op_CreatePresignedDomainUrl.go +++ b/service/sagemaker/api_op_CreatePresignedDomainUrl.go @@ -60,15 +60,15 @@ func (c *Client) CreatePresignedDomainUrl(ctx context.Context, params *CreatePre type CreatePresignedDomainUrlInput struct { - // The name of the UserProfile to sign-in as. + // The domain ID. // // This member is required. - UserProfileName *string + DomainId *string - // The domain ID. + // The name of the UserProfile to sign-in as. // // This member is required. - DomainId *string + UserProfileName *string // The session expiration duration in seconds. SessionExpirationDurationInSeconds *int32 diff --git a/service/sagemaker/api_op_CreateProcessingJob.go b/service/sagemaker/api_op_CreateProcessingJob.go index c8933bb7c3d..4120d5f9d4f 100644 --- a/service/sagemaker/api_op_CreateProcessingJob.go +++ b/service/sagemaker/api_op_CreateProcessingJob.go @@ -57,22 +57,16 @@ func (c *Client) CreateProcessingJob(ctx context.Context, params *CreateProcessi type CreateProcessingJobInput struct { - // The name of the processing job. The name must be unique within an AWS Region in - // the AWS account. - // - // This member is required. - ProcessingJobName *string - // Configures the processing job to run a specified Docker container image. // // This member is required. AppSpecification *types.AppSpecification - // Sets the environment variables in the Docker container. - Environment map[string]*string - - // Output configuration for the processing job. - ProcessingOutputConfig *types.ProcessingOutputConfig + // The name of the processing job. The name must be unique within an AWS Region in + // the AWS account. + // + // This member is required. + ProcessingJobName *string // Identifies the resources, ML compute instances, and ML storage volumes to deploy // for a processing job. In distributed training, you specify more than one @@ -87,21 +81,8 @@ type CreateProcessingJobInput struct { // This member is required. RoleArn *string - // (Optional) An array of key-value pairs. For more information, see Using Cost - // Allocation Tags - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) - // in the AWS Billing and Cost Management User Guide. - Tags []*types.Tag - - // For each input, data is downloaded from S3 into the processing container before - // the processing job begins running if "S3InputMode" is set to File. - ProcessingInputs []*types.ProcessingInput - - // The time limit for how long the processing job is allowed to run. - StoppingCondition *types.ProcessingStoppingCondition - - // Networking options for a processing job. - NetworkConfig *types.NetworkConfig + // Sets the environment variables in the Docker container. + Environment map[string]*string // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: @@ -113,6 +94,25 @@ type CreateProcessingJobInput struct { // // * CreateTransformJob () ExperimentConfig *types.ExperimentConfig + + // Networking options for a processing job. + NetworkConfig *types.NetworkConfig + + // For each input, data is downloaded from S3 into the processing container before + // the processing job begins running if "S3InputMode" is set to File. + ProcessingInputs []*types.ProcessingInput + + // Output configuration for the processing job. + ProcessingOutputConfig *types.ProcessingOutputConfig + + // The time limit for how long the processing job is allowed to run. + StoppingCondition *types.ProcessingStoppingCondition + + // (Optional) An array of key-value pairs. For more information, see Using Cost + // Allocation Tags + // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) + // in the AWS Billing and Cost Management User Guide. + Tags []*types.Tag } type CreateProcessingJobOutput struct { diff --git a/service/sagemaker/api_op_CreateTrainingJob.go b/service/sagemaker/api_op_CreateTrainingJob.go index de3247f6990..7f3c9d23746 100644 --- a/service/sagemaker/api_op_CreateTrainingJob.go +++ b/service/sagemaker/api_op_CreateTrainingJob.go @@ -91,36 +91,6 @@ func (c *Client) CreateTrainingJob(ctx context.Context, params *CreateTrainingJo type CreateTrainingJobInput struct { - // To encrypt all communications between ML compute instances in distributed - // training, choose True. Encryption provides greater security for distributed - // training, but training might take longer. How long it takes depends on the - // amount of communication between compute instances, especially if you use a deep - // learning algorithm in distributed training. For more information, see Protect - // Communications Between ML Compute Instances in a Distributed Training Job - // (https://docs.aws.amazon.com/sagemaker/latest/dg/train-encrypt.html). - EnableInterContainerTrafficEncryption *bool - - // Algorithm-specific parameters that influence the quality of the model. You set - // hyperparameters before you start the learning process. For a list of - // hyperparameters for each training algorithm provided by Amazon SageMaker, see - // Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html). You can - // specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value - // pair. Each key and value is limited to 256 characters, as specified by the - // Length Constraint. - HyperParameters map[string]*string - - // An array of key-value pairs. For more information, see Using Cost Allocation - // Tags - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) - // in the AWS Billing and Cost Management User Guide.

      - Tags []*types.Tag - - // Configuration information for debugging rules. - DebugRuleConfigurations []*types.DebugRuleConfiguration - - // Configuration of storage locations for TensorBoard output. - TensorBoardOutputConfig *types.TensorBoardOutputConfig - // The registry path of the Docker image that contains the training algorithm and // algorithm-specific metadata, including the input mode. For more information // about algorithms provided by Amazon SageMaker, see Algorithms @@ -132,36 +102,21 @@ type CreateTrainingJobInput struct { // This member is required. AlgorithmSpecification *types.AlgorithmSpecification - // Associates a SageMaker job as a trial component with an experiment and trial. - // Specified when you call the following APIs: - // - // * CreateProcessingJob () - // - // * - // CreateTrainingJob () + // Specifies the path to the S3 location where you want to store model artifacts. + // Amazon SageMaker creates subfolders for the artifacts. // - // * CreateTransformJob () - ExperimentConfig *types.ExperimentConfig - - // An array of Channel objects. Each channel is a named input source. - // InputDataConfig - // describes the input data and its location.

      - //

      Algorithms can accept input data from one or more channels. For example, an - // algorithm might have two channels of input data, training_data and - // validation_data. The configuration for each channel provides the - // S3, EFS, or FSx location where the input data is stored. It also provides - // information about the stored data: the MIME type, compression method, and - // whether the data is wrapped in RecordIO format.

      Depending on the input - // mode that the algorithm supports, Amazon SageMaker either copies input data - // files from an S3 bucket to a local directory in the Docker container, or makes - // it available as input streams. For example, if you specify an EFS location, - // input data files will be made available as input streams. They do not need to be - // downloaded.

      - InputDataConfig []*types.Channel + // This member is required. + OutputDataConfig *types.OutputDataConfig - // Configuration information for the debug hook parameters, collection - // configuration, and storage paths. - DebugHookConfig *types.DebugHookConfig + // The resources, including the ML compute instances and ML storage volumes, to use + // for model training. ML storage volumes store model artifacts and incremental + // states. Training algorithms might also use ML storage volumes for scratch space. + // If you want Amazon SageMaker to use the ML storage volume to store the training + // data, choose File as the TrainingInputMode in the algorithm specification. For + // distributed training algorithms, specify an instance count greater than 1. + // + // This member is required. + ResourceConfig *types.ResourceConfig // The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume // to perform tasks on your behalf. During model training, Amazon SageMaker needs @@ -177,6 +132,42 @@ type CreateTrainingJobInput struct { // This member is required. RoleArn *string + // Specifies a limit to how long a model training job can run. When the job reaches + // the time limit, Amazon SageMaker ends the training job. Use this API to cap + // model training costs. To stop a job, Amazon SageMaker sends the algorithm the + // SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use + // this 120-second window to save the model artifacts, so the results of training + // are not lost. + // + // This member is required. + StoppingCondition *types.StoppingCondition + + // The name of the training job. The name must be unique within an AWS Region in an + // AWS account. + // + // This member is required. + TrainingJobName *string + + // Contains information about the output location for managed spot training + // checkpoint data. + CheckpointConfig *types.CheckpointConfig + + // Configuration information for the debug hook parameters, collection + // configuration, and storage paths. + DebugHookConfig *types.DebugHookConfig + + // Configuration information for debugging rules. + DebugRuleConfigurations []*types.DebugRuleConfiguration + + // To encrypt all communications between ML compute instances in distributed + // training, choose True. Encryption provides greater security for distributed + // training, but training might take longer. How long it takes depends on the + // amount of communication between compute instances, especially if you use a deep + // learning algorithm in distributed training. For more information, see Protect + // Communications Between ML Compute Instances in a Distributed Training Job + // (https://docs.aws.amazon.com/sagemaker/latest/dg/train-encrypt.html). + EnableInterContainerTrafficEncryption *bool + // To train models using managed spot training, choose True. Managed spot training // provides a fully managed and scalable infrastructure for training machine // learning models. this option is useful when training jobs can be interrupted and @@ -195,35 +186,50 @@ type CreateTrainingJobInput struct { // network access. EnableNetworkIsolation *bool - // Specifies a limit to how long a model training job can run. When the job reaches - // the time limit, Amazon SageMaker ends the training job. Use this API to cap - // model training costs. To stop a job, Amazon SageMaker sends the algorithm the - // SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use - // this 120-second window to save the model artifacts, so the results of training - // are not lost. + // Associates a SageMaker job as a trial component with an experiment and trial. + // Specified when you call the following APIs: // - // This member is required. - StoppingCondition *types.StoppingCondition - - // The resources, including the ML compute instances and ML storage volumes, to use - // for model training. ML storage volumes store model artifacts and incremental - // states. Training algorithms might also use ML storage volumes for scratch space. - // If you want Amazon SageMaker to use the ML storage volume to store the training - // data, choose File as the TrainingInputMode in the algorithm specification. For - // distributed training algorithms, specify an instance count greater than 1. + // * CreateProcessingJob () // - // This member is required. - ResourceConfig *types.ResourceConfig + // * + // CreateTrainingJob () + // + // * CreateTransformJob () + ExperimentConfig *types.ExperimentConfig - // Contains information about the output location for managed spot training - // checkpoint data. - CheckpointConfig *types.CheckpointConfig + // Algorithm-specific parameters that influence the quality of the model. You set + // hyperparameters before you start the learning process. For a list of + // hyperparameters for each training algorithm provided by Amazon SageMaker, see + // Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html). You can + // specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value + // pair. Each key and value is limited to 256 characters, as specified by the + // Length Constraint. + HyperParameters map[string]*string - // Specifies the path to the S3 location where you want to store model artifacts. - // Amazon SageMaker creates subfolders for the artifacts. - // - // This member is required. - OutputDataConfig *types.OutputDataConfig + // An array of Channel objects. Each channel is a named input source. + // InputDataConfig + // describes the input data and its location.

      + //

      Algorithms can accept input data from one or more channels. For example, an + // algorithm might have two channels of input data, training_data and + // validation_data. The configuration for each channel provides the + // S3, EFS, or FSx location where the input data is stored. It also provides + // information about the stored data: the MIME type, compression method, and + // whether the data is wrapped in RecordIO format.

      Depending on the input + // mode that the algorithm supports, Amazon SageMaker either copies input data + // files from an S3 bucket to a local directory in the Docker container, or makes + // it available as input streams. For example, if you specify an EFS location, + // input data files will be made available as input streams. They do not need to be + // downloaded.

      + InputDataConfig []*types.Channel + + // An array of key-value pairs. For more information, see Using Cost Allocation + // Tags + // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) + // in the AWS Billing and Cost Management User Guide.

      + Tags []*types.Tag + + // Configuration of storage locations for TensorBoard output. + TensorBoardOutputConfig *types.TensorBoardOutputConfig // A VpcConfig () object that specifies the VPC that you want your training job to // connect to. Control access to and from your training container by configuring @@ -231,12 +237,6 @@ type CreateTrainingJobInput struct { // Virtual Private Cloud // (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). VpcConfig *types.VpcConfig - - // The name of the training job. The name must be unique within an AWS Region in an - // AWS account. - // - // This member is required. - TrainingJobName *string } type CreateTrainingJobOutput struct { diff --git a/service/sagemaker/api_op_CreateTransformJob.go b/service/sagemaker/api_op_CreateTransformJob.go index d8746a264fc..c64238d42e2 100644 --- a/service/sagemaker/api_op_CreateTransformJob.go +++ b/service/sagemaker/api_op_CreateTransformJob.go @@ -90,21 +90,10 @@ type CreateTransformJobInput struct { // This member is required. ModelName *string - // Describes the results of the transform job. + // Describes the input source and the way the transform job consumes it. // // This member is required. - TransformOutput *types.TransformOutput - - // Associates a SageMaker job as a trial component with an experiment and trial. - // Specified when you call the following APIs: - // - // * CreateProcessingJob () - // - // * - // CreateTrainingJob () - // - // * CreateTransformJob () - ExperimentConfig *types.ExperimentConfig + TransformInput *types.TransformInput // The name of the transform job. The name must be unique within an AWS Region in // an AWS account. @@ -112,16 +101,16 @@ type CreateTransformJobInput struct { // This member is required. TransformJobName *string - // The maximum allowed size of the payload, in MB. A payload is the data portion of - // a record (without metadata). The value in MaxPayloadInMB must be greater than, - // or equal to, the size of a single record. To estimate the size of a record in - // MB, divide the size of your dataset by the number of records. To ensure that the - // records fit within the maximum payload size, we recommend using a slightly - // larger value. The default value is 6 MB. For cases where the payload might be - // arbitrarily large and is transmitted using HTTP chunked encoding, set the value - // to 0. This feature works only in supported algorithms. Currently, Amazon - // SageMaker built-in algorithms do not support HTTP chunked encoding. - MaxPayloadInMB *int32 + // Describes the results of the transform job. + // + // This member is required. + TransformOutput *types.TransformOutput + + // Describes the resources, including ML instance types and ML instance count, to + // use for the transform job. + // + // This member is required. + TransformResources *types.TransformResources // Specifies the number of records to include in a mini-batch for an HTTP inference // request. A record is a single unit of input data that inference can be made on. @@ -133,18 +122,6 @@ type CreateTransformJobInput struct { // MultiRecord and SplitType to Line. BatchStrategy types.BatchStrategy - // (Optional) An array of key-value pairs. For more information, see Using Cost - // Allocation Tags - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) - // in the AWS Billing and Cost Management User Guide. - Tags []*types.Tag - - // Describes the resources, including ML instance types and ML instance count, to - // use for the transform job. - // - // This member is required. - TransformResources *types.TransformResources - // The data structure used to specify the data to be used for inference in a batch // transform job and to associate the data that is relevant to the prediction // results in the output. The input filter provided allows you to exclude input @@ -159,14 +136,16 @@ type CreateTransformJobInput struct { // key and values entries in the map. Environment map[string]*string - // Configures the timeout and maximum number of retries for processing a transform - // job invocation. - ModelClientConfig *types.ModelClientConfig - - // Describes the input source and the way the transform job consumes it. + // Associates a SageMaker job as a trial component with an experiment and trial. + // Specified when you call the following APIs: // - // This member is required. - TransformInput *types.TransformInput + // * CreateProcessingJob () + // + // * + // CreateTrainingJob () + // + // * CreateTransformJob () + ExperimentConfig *types.ExperimentConfig // The maximum number of parallel requests that can be sent to each instance in a // transform job. If MaxConcurrentTransforms is set to 0 or left unset, Amazon @@ -178,6 +157,27 @@ type CreateTransformJobInput struct { // For built-in algorithms, you don't need to set a value for // MaxConcurrentTransforms. MaxConcurrentTransforms *int32 + + // The maximum allowed size of the payload, in MB. A payload is the data portion of + // a record (without metadata). The value in MaxPayloadInMB must be greater than, + // or equal to, the size of a single record. To estimate the size of a record in + // MB, divide the size of your dataset by the number of records. To ensure that the + // records fit within the maximum payload size, we recommend using a slightly + // larger value. The default value is 6 MB. For cases where the payload might be + // arbitrarily large and is transmitted using HTTP chunked encoding, set the value + // to 0. This feature works only in supported algorithms. Currently, Amazon + // SageMaker built-in algorithms do not support HTTP chunked encoding. + MaxPayloadInMB *int32 + + // Configures the timeout and maximum number of retries for processing a transform + // job invocation. + ModelClientConfig *types.ModelClientConfig + + // (Optional) An array of key-value pairs. For more information, see Using Cost + // Allocation Tags + // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) + // in the AWS Billing and Cost Management User Guide. + Tags []*types.Tag } type CreateTransformJobOutput struct { diff --git a/service/sagemaker/api_op_CreateTrial.go b/service/sagemaker/api_op_CreateTrial.go index c800df00de1..84390eae7f8 100644 --- a/service/sagemaker/api_op_CreateTrial.go +++ b/service/sagemaker/api_op_CreateTrial.go @@ -66,10 +66,6 @@ func (c *Client) CreateTrial(ctx context.Context, params *CreateTrialInput, optF type CreateTrialInput struct { - // The name of the trial as displayed. The name doesn't need to be unique. If - // DisplayName isn't specified, TrialName is displayed. - DisplayName *string - // The name of the experiment to associate the trial with. // // This member is required. @@ -81,6 +77,10 @@ type CreateTrialInput struct { // This member is required. TrialName *string + // The name of the trial as displayed. The name doesn't need to be unique. If + // DisplayName isn't specified, TrialName is displayed. + DisplayName *string + // A list of tags to associate with the trial. You can use Search () API to search // on the tags. Tags []*types.Tag diff --git a/service/sagemaker/api_op_CreateTrialComponent.go b/service/sagemaker/api_op_CreateTrialComponent.go index 4c6b86d8dae..e763356ed0f 100644 --- a/service/sagemaker/api_op_CreateTrialComponent.go +++ b/service/sagemaker/api_op_CreateTrialComponent.go @@ -69,9 +69,33 @@ func (c *Client) CreateTrialComponent(ctx context.Context, params *CreateTrialCo type CreateTrialComponentInput struct { + // The name of the component. The name must be unique in your AWS account and is + // not case-sensitive. + // + // This member is required. + TrialComponentName *string + + // The name of the component as displayed. The name doesn't need to be unique. If + // DisplayName isn't specified, TrialComponentName is displayed. + DisplayName *string + + // When the component ended. + EndTime *time.Time + + // The input artifacts for the component. Examples of input artifacts are datasets, + // algorithms, hyperparameters, source code, and instance types. + InputArtifacts map[string]*types.TrialComponentArtifact + + // The output artifacts for the component. Examples of output artifacts are + // metrics, snapshots, logs, and images. + OutputArtifacts map[string]*types.TrialComponentArtifact + // The hyperparameters for the component. Parameters map[string]*types.TrialComponentParameterValue + // When the component started. + StartTime *time.Time + // The status of the component. States include: // // * InProgress @@ -82,33 +106,9 @@ type CreateTrialComponentInput struct { // * Failed Status *types.TrialComponentStatus - // When the component ended. - EndTime *time.Time - - // The name of the component. The name must be unique in your AWS account and is - // not case-sensitive. - // - // This member is required. - TrialComponentName *string - // A list of tags to associate with the component. You can use Search () API to // search on the tags. Tags []*types.Tag - - // The output artifacts for the component. Examples of output artifacts are - // metrics, snapshots, logs, and images. - OutputArtifacts map[string]*types.TrialComponentArtifact - - // The name of the component as displayed. The name doesn't need to be unique. If - // DisplayName isn't specified, TrialComponentName is displayed. - DisplayName *string - - // When the component started. - StartTime *time.Time - - // The input artifacts for the component. Examples of input artifacts are datasets, - // algorithms, hyperparameters, source code, and instance types. - InputArtifacts map[string]*types.TrialComponentArtifact } type CreateTrialComponentOutput struct { diff --git a/service/sagemaker/api_op_CreateUserProfile.go b/service/sagemaker/api_op_CreateUserProfile.go index a19e5465f7f..e4db3fc05dd 100644 --- a/service/sagemaker/api_op_CreateUserProfile.go +++ b/service/sagemaker/api_op_CreateUserProfile.go @@ -63,34 +63,34 @@ func (c *Client) CreateUserProfile(ctx context.Context, params *CreateUserProfil type CreateUserProfileInput struct { - // The username of the associated AWS Single Sign-On User for this UserProfile. If - // the Domain's AuthMode is SSO, this field is required, and must match a valid - // username of a user in your directory. If the Domain's AuthMode is not SSO, this - // field cannot be specified. - SingleSignOnUserValue *string - - // A collection of settings. - UserSettings *types.UserSettings - // The ID of the associated Domain. // // This member is required. DomainId *string + // A name for the UserProfile. + // + // This member is required. + UserProfileName *string + // A specifier for the type of value specified in SingleSignOnUserValue. Currently, // the only supported value is "UserName". If the Domain's AuthMode is SSO, this // field is required. If the Domain's AuthMode is not SSO, this field cannot be // specified. SingleSignOnUserIdentifier *string - // A name for the UserProfile. - // - // This member is required. - UserProfileName *string + // The username of the associated AWS Single Sign-On User for this UserProfile. If + // the Domain's AuthMode is SSO, this field is required, and must match a valid + // username of a user in your directory. If the Domain's AuthMode is not SSO, this + // field cannot be specified. + SingleSignOnUserValue *string // Each tag consists of a key and an optional value. Tag keys must be unique per // resource. Tags []*types.Tag + + // A collection of settings. + UserSettings *types.UserSettings } type CreateUserProfileOutput struct { diff --git a/service/sagemaker/api_op_CreateWorkforce.go b/service/sagemaker/api_op_CreateWorkforce.go index 22a3893ba57..a788dd9189c 100644 --- a/service/sagemaker/api_op_CreateWorkforce.go +++ b/service/sagemaker/api_op_CreateWorkforce.go @@ -72,14 +72,10 @@ func (c *Client) CreateWorkforce(ctx context.Context, params *CreateWorkforceInp type CreateWorkforceInput struct { - // An array of key-value pairs that contain metadata to help you categorize and - // organize our workforce. Each tag consists of a key and a value, both of which - // you define. - Tags []*types.Tag - - // Use this parameter to configure a private workforce using your own OIDC Identity - // Provider. Do not use CognitoConfig if you specify values for OidcConfig. - OidcConfig *types.OidcConfig + // The name of the private workforce. + // + // This member is required. + WorkforceName *string // Use this parameter to configure an Amazon Cognito private workforce. A single // Cognito workforce is created using and corresponds to a single Amazon Cognito @@ -89,16 +85,20 @@ type CreateWorkforceInput struct { // CognitoConfig.

      CognitoConfig *types.CognitoConfig + // Use this parameter to configure a private workforce using your own OIDC Identity + // Provider. Do not use CognitoConfig if you specify values for OidcConfig. + OidcConfig *types.OidcConfig + // A list of IP address ranges (CIDRs // (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html)). Used to // create an allow list of IP addresses for a private workforce. For more // information, see . SourceIpConfig *types.SourceIpConfig - // The name of the private workforce. - // - // This member is required. - WorkforceName *string + // An array of key-value pairs that contain metadata to help you categorize and + // organize our workforce. Each tag consists of a key and a value, both of which + // you define. + Tags []*types.Tag } type CreateWorkforceOutput struct { diff --git a/service/sagemaker/api_op_CreateWorkteam.go b/service/sagemaker/api_op_CreateWorkteam.go index 9772bb9faa8..26edd305543 100644 --- a/service/sagemaker/api_op_CreateWorkteam.go +++ b/service/sagemaker/api_op_CreateWorkteam.go @@ -60,14 +60,6 @@ func (c *Client) CreateWorkteam(ctx context.Context, params *CreateWorkteamInput type CreateWorkteamInput struct { - // Configures notification of workers regarding available or expiring work items. - NotificationConfiguration *types.NotificationConfiguration - - // The name of the work team. Use this name to identify the work team. - // - // This member is required. - WorkteamName *string - // A description of the work team. // // This member is required. @@ -83,8 +75,13 @@ type CreateWorkteamInput struct { // This member is required. MemberDefinitions []*types.MemberDefinition - // The name of the workforce. - WorkforceName *string + // The name of the work team. Use this name to identify the work team. + // + // This member is required. + WorkteamName *string + + // Configures notification of workers regarding available or expiring work items. + NotificationConfiguration *types.NotificationConfiguration // An array of key-value pairs. For more information, see Resource Tag // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) @@ -92,6 +89,9 @@ type CreateWorkteamInput struct { // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) // in the AWS Billing and Cost Management User Guide. Tags []*types.Tag + + // The name of the workforce. + WorkforceName *string } type CreateWorkteamOutput struct { diff --git a/service/sagemaker/api_op_DeleteApp.go b/service/sagemaker/api_op_DeleteApp.go index 095b3d3775c..e84db01e8c7 100644 --- a/service/sagemaker/api_op_DeleteApp.go +++ b/service/sagemaker/api_op_DeleteApp.go @@ -57,25 +57,25 @@ func (c *Client) DeleteApp(ctx context.Context, params *DeleteAppInput, optFns . type DeleteAppInput struct { - // The type of app. + // The name of the app. // // This member is required. - AppType types.AppType + AppName *string - // The user profile name. + // The type of app. // // This member is required. - UserProfileName *string + AppType types.AppType - // The name of the app. + // The domain ID. // // This member is required. - AppName *string + DomainId *string - // The domain ID. + // The user profile name. // // This member is required. - DomainId *string + UserProfileName *string } type DeleteAppOutput struct { diff --git a/service/sagemaker/api_op_DeleteDomain.go b/service/sagemaker/api_op_DeleteDomain.go index ac68e69a757..508d46b2f9f 100644 --- a/service/sagemaker/api_op_DeleteDomain.go +++ b/service/sagemaker/api_op_DeleteDomain.go @@ -60,15 +60,15 @@ func (c *Client) DeleteDomain(ctx context.Context, params *DeleteDomainInput, op type DeleteDomainInput struct { - // The retention policy for this domain, which specifies whether resources will be - // retained after the Domain is deleted. By default, all resources are retained - // (not automatically deleted). - RetentionPolicy *types.RetentionPolicy - // The domain ID. // // This member is required. DomainId *string + + // The retention policy for this domain, which specifies whether resources will be + // retained after the Domain is deleted. By default, all resources are retained + // (not automatically deleted). + RetentionPolicy *types.RetentionPolicy } type DeleteDomainOutput struct { diff --git a/service/sagemaker/api_op_DeleteTags.go b/service/sagemaker/api_op_DeleteTags.go index 93b28440500..ae8ed802594 100644 --- a/service/sagemaker/api_op_DeleteTags.go +++ b/service/sagemaker/api_op_DeleteTags.go @@ -59,15 +59,15 @@ func (c *Client) DeleteTags(ctx context.Context, params *DeleteTagsInput, optFns type DeleteTagsInput struct { - // An array or one or more tag keys to delete. + // The Amazon Resource Name (ARN) of the resource whose tags you want to delete. // // This member is required. - TagKeys []*string + ResourceArn *string - // The Amazon Resource Name (ARN) of the resource whose tags you want to delete. + // An array or one or more tag keys to delete. // // This member is required. - ResourceArn *string + TagKeys []*string } type DeleteTagsOutput struct { diff --git a/service/sagemaker/api_op_DeleteUserProfile.go b/service/sagemaker/api_op_DeleteUserProfile.go index 55a885265e7..29f1afc0d6d 100644 --- a/service/sagemaker/api_op_DeleteUserProfile.go +++ b/service/sagemaker/api_op_DeleteUserProfile.go @@ -57,15 +57,15 @@ func (c *Client) DeleteUserProfile(ctx context.Context, params *DeleteUserProfil type DeleteUserProfileInput struct { - // The user profile name. + // The domain ID. // // This member is required. - UserProfileName *string + DomainId *string - // The domain ID. + // The user profile name. // // This member is required. - DomainId *string + UserProfileName *string } type DeleteUserProfileOutput struct { diff --git a/service/sagemaker/api_op_DescribeAlgorithm.go b/service/sagemaker/api_op_DescribeAlgorithm.go index f3027989511..6d933db344e 100644 --- a/service/sagemaker/api_op_DescribeAlgorithm.go +++ b/service/sagemaker/api_op_DescribeAlgorithm.go @@ -66,51 +66,51 @@ type DescribeAlgorithmInput struct { type DescribeAlgorithmOutput struct { - // Whether the algorithm is certified to be listed in AWS Marketplace. - CertifyForMarketplace *bool - - // Details about training jobs run by this algorithm. + // The Amazon Resource Name (ARN) of the algorithm. // // This member is required. - TrainingSpecification *types.TrainingSpecification - - // The product identifier of the algorithm. - ProductId *string + AlgorithmArn *string - // Details about inference jobs that the algorithm runs. - InferenceSpecification *types.InferenceSpecification + // The name of the algorithm being described. + // + // This member is required. + AlgorithmName *string // The current status of the algorithm. // // This member is required. AlgorithmStatus types.AlgorithmStatus - // Details about configurations for one or more training jobs that Amazon SageMaker - // runs to test the algorithm. - ValidationSpecification *types.AlgorithmValidationSpecification - // Details about the current status of the algorithm. // // This member is required. AlgorithmStatusDetails *types.AlgorithmStatusDetails - // A brief summary about the algorithm. - AlgorithmDescription *string - // A timestamp specifying when the algorithm was created. // // This member is required. CreationTime *time.Time - // The Amazon Resource Name (ARN) of the algorithm. + // Details about training jobs run by this algorithm. // // This member is required. - AlgorithmArn *string + TrainingSpecification *types.TrainingSpecification - // The name of the algorithm being described. - // - // This member is required. - AlgorithmName *string + // A brief summary about the algorithm. + AlgorithmDescription *string + + // Whether the algorithm is certified to be listed in AWS Marketplace. + CertifyForMarketplace *bool + + // Details about inference jobs that the algorithm runs. + InferenceSpecification *types.InferenceSpecification + + // The product identifier of the algorithm. + ProductId *string + + // Details about configurations for one or more training jobs that Amazon SageMaker + // runs to test the algorithm. + ValidationSpecification *types.AlgorithmValidationSpecification // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sagemaker/api_op_DescribeApp.go b/service/sagemaker/api_op_DescribeApp.go index c64203d91c5..1e56e5c0010 100644 --- a/service/sagemaker/api_op_DescribeApp.go +++ b/service/sagemaker/api_op_DescribeApp.go @@ -58,50 +58,46 @@ func (c *Client) DescribeApp(ctx context.Context, params *DescribeAppInput, optF type DescribeAppInput struct { - // The type of app. - // - // This member is required. - AppType types.AppType - // The name of the app. // // This member is required. AppName *string - // The user profile name. + // The type of app. // // This member is required. - UserProfileName *string + AppType types.AppType // The domain ID. // // This member is required. DomainId *string -} - -type DescribeAppOutput struct { - - // The status. - Status types.AppStatus // The user profile name. + // + // This member is required. UserProfileName *string +} + +type DescribeAppOutput struct { // The app's Amazon Resource Name (ARN). AppArn *string - // The failure reason. - FailureReason *string + // The name of the app. + AppName *string + + // The type of app. + AppType types.AppType + + // The creation time. + CreationTime *time.Time // The domain ID. DomainId *string - // The instance type and the Amazon Resource Name (ARN) of the SageMaker image - // created on the instance. - ResourceSpec *types.ResourceSpec - - // The name of the app. - AppName *string + // The failure reason. + FailureReason *string // The timestamp of the last health check. LastHealthCheckTimestamp *time.Time @@ -109,11 +105,15 @@ type DescribeAppOutput struct { // The timestamp of the last user's activity. LastUserActivityTimestamp *time.Time - // The creation time. - CreationTime *time.Time + // The instance type and the Amazon Resource Name (ARN) of the SageMaker image + // created on the instance. + ResourceSpec *types.ResourceSpec - // The type of app. - AppType types.AppType + // The status. + Status types.AppStatus + + // The user profile name. + UserProfileName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sagemaker/api_op_DescribeAutoMLJob.go b/service/sagemaker/api_op_DescribeAutoMLJob.go index 28894b63ceb..b03c102b9f0 100644 --- a/service/sagemaker/api_op_DescribeAutoMLJob.go +++ b/service/sagemaker/api_op_DescribeAutoMLJob.go @@ -66,69 +66,45 @@ type DescribeAutoMLJobInput struct { type DescribeAutoMLJobOutput struct { - // Returns the job's creation time. - // - // This member is required. - CreationTime *time.Time - - // Returns the job's last modified time. + // Returns the job's ARN. // // This member is required. - LastModifiedTime *time.Time - - // Returns the job's BestCandidate. - BestCandidate *types.AutoMLCandidate - - // Returns the job's end time. - EndTime *time.Time + AutoMLJobArn *string // Returns the name of a job. // // This member is required. AutoMLJobName *string - // Returns the job's ARN. - // - // This member is required. - AutoMLJobArn *string - - // Returns the job's output from GenerateCandidateDefinitionsOnly. - GenerateCandidateDefinitionsOnly *bool - - // Returns the job's FailureReason. - FailureReason *string - - // Returns the job's objective. - AutoMLJobObjective *types.AutoMLJobObjective - - // Returns information on the job's artifacts found in AutoMLJobArtifacts. - AutoMLJobArtifacts *types.AutoMLJobArtifacts - // Returns the job's AutoMLJobSecondaryStatus. // // This member is required. AutoMLJobSecondaryStatus types.AutoMLJobSecondaryStatus - // This contains ProblemType, AutoMLJobObjective and CompletionCriteria. They're - // auto-inferred values, if not provided by you. If you do provide them, then - // they'll be the same as provided. - ResolvedAttributes *types.ResolvedAttributes + // Returns the job's AutoMLJobStatus. + // + // This member is required. + AutoMLJobStatus types.AutoMLJobStatus - // Returns the job's output data config. + // Returns the job's creation time. // // This member is required. - OutputDataConfig *types.AutoMLOutputDataConfig + CreationTime *time.Time - // Returns the job's problem type. - ProblemType types.ProblemType + // Returns the job's input data config. + // + // This member is required. + InputDataConfig []*types.AutoMLChannel - // Returns the job's AutoMLJobStatus. + // Returns the job's last modified time. // // This member is required. - AutoMLJobStatus types.AutoMLJobStatus + LastModifiedTime *time.Time - // Returns the job's config. - AutoMLJobConfig *types.AutoMLJobConfig + // Returns the job's output data config. + // + // This member is required. + OutputDataConfig *types.AutoMLOutputDataConfig // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) // role that has read permission to the input data location and write permission to @@ -137,10 +113,34 @@ type DescribeAutoMLJobOutput struct { // This member is required. RoleArn *string - // Returns the job's input data config. - // - // This member is required. - InputDataConfig []*types.AutoMLChannel + // Returns information on the job's artifacts found in AutoMLJobArtifacts. + AutoMLJobArtifacts *types.AutoMLJobArtifacts + + // Returns the job's config. + AutoMLJobConfig *types.AutoMLJobConfig + + // Returns the job's objective. + AutoMLJobObjective *types.AutoMLJobObjective + + // Returns the job's BestCandidate. + BestCandidate *types.AutoMLCandidate + + // Returns the job's end time. + EndTime *time.Time + + // Returns the job's FailureReason. + FailureReason *string + + // Returns the job's output from GenerateCandidateDefinitionsOnly. + GenerateCandidateDefinitionsOnly *bool + + // Returns the job's problem type. + ProblemType types.ProblemType + + // This contains ProblemType, AutoMLJobObjective and CompletionCriteria. They're + // auto-inferred values, if not provided by you. If you do provide them, then + // they'll be the same as provided. + ResolvedAttributes *types.ResolvedAttributes // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sagemaker/api_op_DescribeCodeRepository.go b/service/sagemaker/api_op_DescribeCodeRepository.go index d90c16df2bc..ab21c380b38 100644 --- a/service/sagemaker/api_op_DescribeCodeRepository.go +++ b/service/sagemaker/api_op_DescribeCodeRepository.go @@ -76,12 +76,6 @@ type DescribeCodeRepositoryOutput struct { // This member is required. CodeRepositoryName *string - // Configuration details about the repository, including the URL where the - // repository is located, the default branch, and the Amazon Resource Name (ARN) of - // the AWS Secrets Manager secret that contains the credentials used to access the - // repository. - GitConfig *types.GitConfig - // The date and time that the repository was created. // // This member is required. @@ -92,6 +86,12 @@ type DescribeCodeRepositoryOutput struct { // This member is required. LastModifiedTime *time.Time + // Configuration details about the repository, including the URL where the + // repository is located, the default branch, and the Amazon Resource Name (ARN) of + // the AWS Secrets Manager secret that contains the credentials used to access the + // repository. + GitConfig *types.GitConfig + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_DescribeCompilationJob.go b/service/sagemaker/api_op_DescribeCompilationJob.go index 5d07b937303..20c65c1117a 100644 --- a/service/sagemaker/api_op_DescribeCompilationJob.go +++ b/service/sagemaker/api_op_DescribeCompilationJob.go @@ -68,39 +68,26 @@ type DescribeCompilationJobInput struct { type DescribeCompilationJobOutput struct { - // Information about the location in Amazon S3 that has been configured for storing - // the model artifacts used in the compilation job. - // - // This member is required. - ModelArtifacts *types.ModelArtifacts - - // The Amazon Resource Name (ARN) of the model compilation job. + // The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to + // perform the model compilation job. // // This member is required. - RoleArn *string - - // The time when the model compilation job started the CompilationJob instances. - // You are billed for the time between this timestamp and the timestamp in the - // DescribeCompilationJobResponse$CompilationEndTime () field. In Amazon CloudWatch - // Logs, the start time might be later than this time. That's because it takes time - // to download the compilation job, which depends on the size of the compilation - // job container. - CompilationStartTime *time.Time + CompilationJobArn *string // The name of the model compilation job. // // This member is required. CompilationJobName *string - // The time that the model compilation job was created. + // The status of the model compilation job. // // This member is required. - CreationTime *time.Time + CompilationJobStatus types.CompilationJobStatus - // The time that the status of the model compilation job was last modified. + // The time that the model compilation job was created. // // This member is required. - LastModifiedTime *time.Time + CreationTime *time.Time // If a model compilation job failed, the reason it failed. // @@ -114,16 +101,27 @@ type DescribeCompilationJobOutput struct { // This member is required. InputConfig *types.InputConfig + // The time that the status of the model compilation job was last modified. + // + // This member is required. + LastModifiedTime *time.Time + + // Information about the location in Amazon S3 that has been configured for storing + // the model artifacts used in the compilation job. + // + // This member is required. + ModelArtifacts *types.ModelArtifacts + // Information about the output location for the compiled model and the target // device that the model runs on. // // This member is required. OutputConfig *types.OutputConfig - // The status of the model compilation job. + // The Amazon Resource Name (ARN) of the model compilation job. // // This member is required. - CompilationJobStatus types.CompilationJobStatus + RoleArn *string // Specifies a limit to how long a model compilation job can run. When the job // reaches the time limit, Amazon SageMaker ends the compilation job. Use this API @@ -132,18 +130,20 @@ type DescribeCompilationJobOutput struct { // This member is required. StoppingCondition *types.StoppingCondition - // The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to - // perform the model compilation job. - // - // This member is required. - CompilationJobArn *string - // The time when the model compilation job on a compilation job instance ended. For // a successful or stopped job, this is when the job's model artifacts have // finished uploading. For a failed job, this is when Amazon SageMaker detected // that the job failed. CompilationEndTime *time.Time + // The time when the model compilation job started the CompilationJob instances. + // You are billed for the time between this timestamp and the timestamp in the + // DescribeCompilationJobResponse$CompilationEndTime () field. In Amazon CloudWatch + // Logs, the start time might be later than this time. That's because it takes time + // to download the compilation job, which depends on the size of the compilation + // job container. + CompilationStartTime *time.Time + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_DescribeDomain.go b/service/sagemaker/api_op_DescribeDomain.go index 0f642f6631c..731450a04fc 100644 --- a/service/sagemaker/api_op_DescribeDomain.go +++ b/service/sagemaker/api_op_DescribeDomain.go @@ -66,33 +66,33 @@ type DescribeDomainInput struct { type DescribeDomainOutput struct { + // The domain's authentication mode. + AuthMode types.AuthMode + + // The creation time. + CreationTime *time.Time + // Settings which are applied to all UserProfile in this domain, if settings are // not explicitly specified in a given UserProfile. DefaultUserSettings *types.UserSettings - // The AWS Key Management Service encryption key ID. - HomeEfsFileSystemKmsKeyId *string - - // The domain's URL. - Url *string - - // Security setting to limit to a set of subnets. - SubnetIds []*string - // The domain's Amazon Resource Name (ARN). DomainArn *string - // The ID of the Amazon Virtual Private Cloud. - VpcId *string + // The domain ID. + DomainId *string // The domain name. DomainName *string - // The domain's authentication mode. - AuthMode types.AuthMode + // The failure reason. + FailureReason *string - // The creation time. - CreationTime *time.Time + // The ID of the Amazon Elastic File System (EFS) managed by this Domain. + HomeEfsFileSystemId *string + + // The AWS Key Management Service encryption key ID. + HomeEfsFileSystemKmsKeyId *string // The last modified time. LastModifiedTime *time.Time @@ -100,17 +100,17 @@ type DescribeDomainOutput struct { // The SSO managed application instance ID. SingleSignOnManagedApplicationInstanceId *string - // The domain ID. - DomainId *string - - // The ID of the Amazon Elastic File System (EFS) managed by this Domain. - HomeEfsFileSystemId *string - // The status. Status types.DomainStatus - // The failure reason. - FailureReason *string + // Security setting to limit to a set of subnets. + SubnetIds []*string + + // The domain's URL. + Url *string + + // The ID of the Amazon Virtual Private Cloud. + VpcId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sagemaker/api_op_DescribeEndpoint.go b/service/sagemaker/api_op_DescribeEndpoint.go index d0ffbc7d70d..40d7e9374ba 100644 --- a/service/sagemaker/api_op_DescribeEndpoint.go +++ b/service/sagemaker/api_op_DescribeEndpoint.go @@ -66,6 +66,26 @@ type DescribeEndpointInput struct { type DescribeEndpointOutput struct { + // A timestamp that shows when the endpoint was created. + // + // This member is required. + CreationTime *time.Time + + // The Amazon Resource Name (ARN) of the endpoint. + // + // This member is required. + EndpointArn *string + + // The name of the endpoint configuration associated with this endpoint. + // + // This member is required. + EndpointConfigName *string + + // Name of the endpoint. + // + // This member is required. + EndpointName *string + // The status of the endpoint. // // * OutOfService: Endpoint is not available to @@ -105,40 +125,20 @@ type DescribeEndpointOutput struct { // This member is required. EndpointStatus types.EndpointStatus - // An array of ProductionVariantSummary () objects, one for each model hosted - // behind this endpoint. - ProductionVariants []*types.ProductionVariantSummary - - // The name of the endpoint configuration associated with this endpoint. + // A timestamp that shows when the endpoint was last modified. // // This member is required. - EndpointConfigName *string + LastModifiedTime *time.Time - // Name of the endpoint. // - // This member is required. - EndpointName *string + DataCaptureConfig *types.DataCaptureConfigSummary // If the status of the endpoint is Failed, the reason why it failed. FailureReason *string - // A timestamp that shows when the endpoint was created. - // - // This member is required. - CreationTime *time.Time - - // A timestamp that shows when the endpoint was last modified. - // - // This member is required. - LastModifiedTime *time.Time - - // The Amazon Resource Name (ARN) of the endpoint. - // - // This member is required. - EndpointArn *string - - // - DataCaptureConfig *types.DataCaptureConfigSummary + // An array of ProductionVariantSummary () objects, one for each model hosted + // behind this endpoint. + ProductionVariants []*types.ProductionVariantSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sagemaker/api_op_DescribeEndpointConfig.go b/service/sagemaker/api_op_DescribeEndpointConfig.go index d8349d2dacb..f4136757d22 100644 --- a/service/sagemaker/api_op_DescribeEndpointConfig.go +++ b/service/sagemaker/api_op_DescribeEndpointConfig.go @@ -67,15 +67,6 @@ type DescribeEndpointConfigInput struct { type DescribeEndpointConfigOutput struct { - // An array of ProductionVariant objects, one for each model that you want to host - // at this endpoint. - // - // This member is required. - ProductionVariants []*types.ProductionVariant - - // - DataCaptureConfig *types.DataCaptureConfig - // A timestamp that shows when the endpoint configuration was created. // // This member is required. @@ -86,15 +77,24 @@ type DescribeEndpointConfigOutput struct { // This member is required. EndpointConfigArn *string - // AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML - // storage volume attached to the instance. - KmsKeyId *string - // Name of the Amazon SageMaker endpoint configuration. // // This member is required. EndpointConfigName *string + // An array of ProductionVariant objects, one for each model that you want to host + // at this endpoint. + // + // This member is required. + ProductionVariants []*types.ProductionVariant + + // + DataCaptureConfig *types.DataCaptureConfig + + // AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML + // storage volume attached to the instance. + KmsKeyId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_DescribeExperiment.go b/service/sagemaker/api_op_DescribeExperiment.go index af20ebc7673..621969c49c2 100644 --- a/service/sagemaker/api_op_DescribeExperiment.go +++ b/service/sagemaker/api_op_DescribeExperiment.go @@ -66,34 +66,34 @@ type DescribeExperimentInput struct { type DescribeExperimentOutput struct { + // Who created the experiment. + CreatedBy *types.UserContext + // When the experiment was created. CreationTime *time.Time - // When the experiment was last modified. - LastModifiedTime *time.Time + // The description of the experiment. + Description *string // The name of the experiment as displayed. If DisplayName isn't specified, // ExperimentName is displayed. DisplayName *string + // The Amazon Resource Name (ARN) of the experiment. + ExperimentArn *string + + // The name of the experiment. + ExperimentName *string + // Who last modified the experiment. LastModifiedBy *types.UserContext + // When the experiment was last modified. + LastModifiedTime *time.Time + // The ARN of the source and, optionally, the type. Source *types.ExperimentSource - // Who created the experiment. - CreatedBy *types.UserContext - - // The description of the experiment. - Description *string - - // The name of the experiment. - ExperimentName *string - - // The Amazon Resource Name (ARN) of the experiment. - ExperimentArn *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_DescribeFlowDefinition.go b/service/sagemaker/api_op_DescribeFlowDefinition.go index 067cc28721f..cb9ac51b5b4 100644 --- a/service/sagemaker/api_op_DescribeFlowDefinition.go +++ b/service/sagemaker/api_op_DescribeFlowDefinition.go @@ -66,33 +66,25 @@ type DescribeFlowDefinitionInput struct { type DescribeFlowDefinitionOutput struct { - // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) - // execution role for the flow definition. + // The timestamp when the flow definition was created. // // This member is required. - RoleArn *string + CreationTime *time.Time - // The status of the flow definition. Valid values are listed below. + // The Amazon Resource Name (ARN) of the flow defintion. // // This member is required. - FlowDefinitionStatus types.FlowDefinitionStatus + FlowDefinitionArn *string - // The timestamp when the flow definition was created. + // The Amazon Resource Name (ARN) of the flow definition. // // This member is required. - CreationTime *time.Time + FlowDefinitionName *string - // An object containing information about the output file. + // The status of the flow definition. Valid values are listed below. // // This member is required. - OutputConfig *types.FlowDefinitionOutputConfig - - // An object containing information about what triggers a human review workflow. - HumanLoopActivationConfig *types.HumanLoopActivationConfig - - // Container for configuring the source of human task requests. Used to specify if - // Amazon Rekognition or Amazon Textract is used as an integration source. - HumanLoopRequestSource *types.HumanLoopRequestSource + FlowDefinitionStatus types.FlowDefinitionStatus // An object containing information about who works on the task, the workforce task // price, and other task details. @@ -100,18 +92,26 @@ type DescribeFlowDefinitionOutput struct { // This member is required. HumanLoopConfig *types.HumanLoopConfig - // The reason your flow definition failed. - FailureReason *string - - // The Amazon Resource Name (ARN) of the flow defintion. + // An object containing information about the output file. // // This member is required. - FlowDefinitionArn *string + OutputConfig *types.FlowDefinitionOutputConfig - // The Amazon Resource Name (ARN) of the flow definition. + // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) + // execution role for the flow definition. // // This member is required. - FlowDefinitionName *string + RoleArn *string + + // The reason your flow definition failed. + FailureReason *string + + // An object containing information about what triggers a human review workflow. + HumanLoopActivationConfig *types.HumanLoopActivationConfig + + // Container for configuring the source of human task requests. Used to specify if + // Amazon Rekognition or Amazon Textract is used as an integration source. + HumanLoopRequestSource *types.HumanLoopRequestSource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sagemaker/api_op_DescribeHumanTaskUi.go b/service/sagemaker/api_op_DescribeHumanTaskUi.go index d6e296719a0..3277954518e 100644 --- a/service/sagemaker/api_op_DescribeHumanTaskUi.go +++ b/service/sagemaker/api_op_DescribeHumanTaskUi.go @@ -68,10 +68,10 @@ type DescribeHumanTaskUiInput struct { type DescribeHumanTaskUiOutput struct { - // The name of the human task user interface (worker task template). + // The timestamp when the human task user interface was created. // // This member is required. - HumanTaskUiName *string + CreationTime *time.Time // The Amazon Resource Name (ARN) of the human task user interface (worker task // template). @@ -79,10 +79,10 @@ type DescribeHumanTaskUiOutput struct { // This member is required. HumanTaskUiArn *string - // The timestamp when the human task user interface was created. + // The name of the human task user interface (worker task template). // // This member is required. - CreationTime *time.Time + HumanTaskUiName *string // Container for user interface template information. // diff --git a/service/sagemaker/api_op_DescribeHyperParameterTuningJob.go b/service/sagemaker/api_op_DescribeHyperParameterTuningJob.go index 098a3e7a6b7..30d3635cb99 100644 --- a/service/sagemaker/api_op_DescribeHyperParameterTuningJob.go +++ b/service/sagemaker/api_op_DescribeHyperParameterTuningJob.go @@ -66,44 +66,26 @@ type DescribeHyperParameterTuningJobInput struct { type DescribeHyperParameterTuningJobOutput struct { - // The HyperParameterTuningJobConfig () object that specifies the configuration of - // the tuning job. + // The date and time that the tuning job started. // // This member is required. - HyperParameterTuningJobConfig *types.HyperParameterTuningJobConfig - - // If the hyperparameter tuning job is an warm start tuning job with a - // WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary () - // for the training job with the best objective metric value of all training jobs - // launched by this tuning job and all parent jobs specified for the warm start - // tuning job. - OverallBestTrainingJob *types.HyperParameterTrainingJobSummary + CreationTime *time.Time - // The TrainingJobStatusCounters () object that specifies the number of training - // jobs, categorized by status, that this tuning job launched. + // The Amazon Resource Name (ARN) of the tuning job. // // This member is required. - TrainingJobStatusCounters *types.TrainingJobStatusCounters - - // The date and time that the tuning job ended. - HyperParameterTuningEndTime *time.Time - - // The HyperParameterTrainingJobDefinition () object that specifies the definition - // of the training jobs that this tuning job launches. - TrainingJobDefinition *types.HyperParameterTrainingJobDefinition + HyperParameterTuningJobArn *string - // The configuration for starting the hyperparameter parameter tuning job using one - // or more previous tuning jobs as a starting point. The results of previous tuning - // jobs are used to inform which combinations of hyperparameters to search over in - // the new tuning job. - WarmStartConfig *types.HyperParameterTuningJobWarmStartConfig + // The HyperParameterTuningJobConfig () object that specifies the configuration of + // the tuning job. + // + // This member is required. + HyperParameterTuningJobConfig *types.HyperParameterTuningJobConfig - // The ObjectiveStatusCounters () object that specifies the number of training - // jobs, categorized by the status of their final objective metric, that this - // tuning job launched. + // The name of the tuning job. // // This member is required. - ObjectiveStatusCounters *types.ObjectiveStatusCounters + HyperParameterTuningJobName *string // The status of the tuning job: InProgress, Completed, Failed, Stopping, or // Stopped. @@ -111,35 +93,53 @@ type DescribeHyperParameterTuningJobOutput struct { // This member is required. HyperParameterTuningJobStatus types.HyperParameterTuningJobStatus - // A list of the HyperParameterTrainingJobDefinition () objects launched for this - // tuning job. - TrainingJobDefinitions []*types.HyperParameterTrainingJobDefinition - - // The date and time that the tuning job started. + // The ObjectiveStatusCounters () object that specifies the number of training + // jobs, categorized by the status of their final objective metric, that this + // tuning job launched. // // This member is required. - CreationTime *time.Time - - // The date and time that the status of the tuning job was modified. - LastModifiedTime *time.Time + ObjectiveStatusCounters *types.ObjectiveStatusCounters - // The name of the tuning job. + // The TrainingJobStatusCounters () object that specifies the number of training + // jobs, categorized by status, that this tuning job launched. // // This member is required. - HyperParameterTuningJobName *string + TrainingJobStatusCounters *types.TrainingJobStatusCounters // A TrainingJobSummary () object that describes the training job that completed // with the best current HyperParameterTuningJobObjective (). BestTrainingJob *types.HyperParameterTrainingJobSummary - // The Amazon Resource Name (ARN) of the tuning job. - // - // This member is required. - HyperParameterTuningJobArn *string - // If the tuning job failed, the reason it failed. FailureReason *string + // The date and time that the tuning job ended. + HyperParameterTuningEndTime *time.Time + + // The date and time that the status of the tuning job was modified. + LastModifiedTime *time.Time + + // If the hyperparameter tuning job is an warm start tuning job with a + // WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary () + // for the training job with the best objective metric value of all training jobs + // launched by this tuning job and all parent jobs specified for the warm start + // tuning job. + OverallBestTrainingJob *types.HyperParameterTrainingJobSummary + + // The HyperParameterTrainingJobDefinition () object that specifies the definition + // of the training jobs that this tuning job launches. + TrainingJobDefinition *types.HyperParameterTrainingJobDefinition + + // A list of the HyperParameterTrainingJobDefinition () objects launched for this + // tuning job. + TrainingJobDefinitions []*types.HyperParameterTrainingJobDefinition + + // The configuration for starting the hyperparameter parameter tuning job using one + // or more previous tuning jobs as a starting point. The results of previous tuning + // jobs are used to inform which combinations of hyperparameters to search over in + // the new tuning job. + WarmStartConfig *types.HyperParameterTuningJobWarmStartConfig + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_DescribeLabelingJob.go b/service/sagemaker/api_op_DescribeLabelingJob.go index 45026c366af..74a15c85afa 100644 --- a/service/sagemaker/api_op_DescribeLabelingJob.go +++ b/service/sagemaker/api_op_DescribeLabelingJob.go @@ -66,15 +66,16 @@ type DescribeLabelingJobInput struct { type DescribeLabelingJobOutput struct { - // The date and time that the labeling job was last updated. + // The date and time that the labeling job was created. // // This member is required. - LastModifiedTime *time.Time + CreationTime *time.Time - // The date and time that the labeling job was created. + // Configuration information required for human workers to complete a labeling + // task. // // This member is required. - CreationTime *time.Time + HumanTaskConfig *types.HumanTaskConfig // Input configuration information for the labeling job, such as the Amazon S3 // location of the data objects and the location of the manifest file that @@ -83,36 +84,55 @@ type DescribeLabelingJobOutput struct { // This member is required. InputConfig *types.LabelingJobInputConfig - // Configuration information required for human workers to complete a labeling - // task. + // A unique identifier for work done as part of a labeling job. // // This member is required. - HumanTaskConfig *types.HumanTaskConfig + JobReferenceCode *string - // A set of conditions for stopping a labeling job. If any of the conditions are - // met, the job is automatically stopped. - StoppingConditions *types.LabelingJobStoppingConditions + // Provides a breakdown of the number of data objects labeled by humans, the number + // of objects labeled by machine, the number of objects than couldn't be labeled, + // and the total number of objects labeled. + // + // This member is required. + LabelCounters *types.LabelCounters - // Configuration information for automated data labeling. - LabelingJobAlgorithmsConfig *types.LabelingJobAlgorithmsConfig + // The Amazon Resource Name (ARN) of the labeling job. + // + // This member is required. + LabelingJobArn *string + + // The name assigned to the labeling job when it was created. + // + // This member is required. + LabelingJobName *string // The processing status of the labeling job. // // This member is required. LabelingJobStatus types.LabelingJobStatus - // The Amazon Resource Name (ARN) of the labeling job. + // The date and time that the labeling job was last updated. // // This member is required. - LabelingJobArn *string + LastModifiedTime *time.Time - // If the job failed, the reason that it failed. - FailureReason *string + // The location of the job's output data and the AWS Key Management Service key ID + // for the key used to encrypt the output data, if any. + // + // This member is required. + OutputConfig *types.LabelingJobOutputConfig - // The name assigned to the labeling job when it was created. + // The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on + // your behalf during data labeling. // // This member is required. - LabelingJobName *string + RoleArn *string + + // If the job failed, the reason that it failed. + FailureReason *string + + // The attribute used as the label in the output manifest file. + LabelAttributeName *string // The S3 location of the JSON file that defines the categories used to label data // objects. Please note the following label-category limits: @@ -156,41 +176,21 @@ type DescribeLabelingJobOutput struct { // } LabelCategoryConfigS3Uri *string - // An array of key/value pairs. For more information, see Using Cost Allocation - // Tags - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) - // in the AWS Billing and Cost Management User Guide. - Tags []*types.Tag + // Configuration information for automated data labeling. + LabelingJobAlgorithmsConfig *types.LabelingJobAlgorithmsConfig // The location of the output produced by the labeling job. LabelingJobOutput *types.LabelingJobOutput - // The attribute used as the label in the output manifest file. - LabelAttributeName *string - - // A unique identifier for work done as part of a labeling job. - // - // This member is required. - JobReferenceCode *string - - // Provides a breakdown of the number of data objects labeled by humans, the number - // of objects labeled by machine, the number of objects than couldn't be labeled, - // and the total number of objects labeled. - // - // This member is required. - LabelCounters *types.LabelCounters - - // The location of the job's output data and the AWS Key Management Service key ID - // for the key used to encrypt the output data, if any. - // - // This member is required. - OutputConfig *types.LabelingJobOutputConfig + // A set of conditions for stopping a labeling job. If any of the conditions are + // met, the job is automatically stopped. + StoppingConditions *types.LabelingJobStoppingConditions - // The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on - // your behalf during data labeling. - // - // This member is required. - RoleArn *string + // An array of key/value pairs. For more information, see Using Cost Allocation + // Tags + // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) + // in the AWS Billing and Cost Management User Guide. + Tags []*types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sagemaker/api_op_DescribeModel.go b/service/sagemaker/api_op_DescribeModel.go index 087b5a758ec..996aaabe220 100644 --- a/service/sagemaker/api_op_DescribeModel.go +++ b/service/sagemaker/api_op_DescribeModel.go @@ -66,42 +66,42 @@ type DescribeModelInput struct { type DescribeModelOutput struct { - // A VpcConfig () object that specifies the VPC that this model has access to. For - // more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud - // (https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) - VpcConfig *types.VpcConfig - - // The Amazon Resource Name (ARN) of the model. + // A timestamp that shows when the model was created. // // This member is required. - ModelArn *string + CreationTime *time.Time // The Amazon Resource Name (ARN) of the IAM role that you specified for the model. // // This member is required. ExecutionRoleArn *string - // The containers in the inference pipeline. - Containers []*types.ContainerDefinition + // The Amazon Resource Name (ARN) of the model. + // + // This member is required. + ModelArn *string // Name of the Amazon SageMaker model. // // This member is required. ModelName *string - // The location of the primary inference code, associated artifacts, and custom - // environment map that the inference code uses when it is deployed in production. - PrimaryContainer *types.ContainerDefinition - - // A timestamp that shows when the model was created. - // - // This member is required. - CreationTime *time.Time + // The containers in the inference pipeline. + Containers []*types.ContainerDefinition // If True, no inbound or outbound network calls can be made to or from the model // container. EnableNetworkIsolation *bool + // The location of the primary inference code, associated artifacts, and custom + // environment map that the inference code uses when it is deployed in production. + PrimaryContainer *types.ContainerDefinition + + // A VpcConfig () object that specifies the VPC that this model has access to. For + // more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud + // (https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) + VpcConfig *types.VpcConfig + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_DescribeModelPackage.go b/service/sagemaker/api_op_DescribeModelPackage.go index 0de9b6a8db3..a3ca0250127 100644 --- a/service/sagemaker/api_op_DescribeModelPackage.go +++ b/service/sagemaker/api_op_DescribeModelPackage.go @@ -69,11 +69,6 @@ type DescribeModelPackageInput struct { type DescribeModelPackageOutput struct { - // The name of the model package being described. - // - // This member is required. - ModelPackageName *string - // A timestamp specifying when the model package was created. // // This member is required. @@ -84,33 +79,38 @@ type DescribeModelPackageOutput struct { // This member is required. ModelPackageArn *string - // Details about the algorithm that was used to create the model package. - SourceAlgorithmSpecification *types.SourceAlgorithmSpecification + // The name of the model package being described. + // + // This member is required. + ModelPackageName *string + + // The current status of the model package. + // + // This member is required. + ModelPackageStatus types.ModelPackageStatus // Details about the current status of the model package. // // This member is required. ModelPackageStatusDetails *types.ModelPackageStatusDetails - // Configurations for one or more transform jobs that Amazon SageMaker runs to test - // the model package. - ValidationSpecification *types.ModelPackageValidationSpecification - - // A brief summary of the model package. - ModelPackageDescription *string - // Whether the model package is certified for listing on AWS Marketplace. CertifyForMarketplace *bool - // The current status of the model package. - // - // This member is required. - ModelPackageStatus types.ModelPackageStatus - // Details about inference jobs that can be run with models based on this model // package. InferenceSpecification *types.InferenceSpecification + // A brief summary of the model package. + ModelPackageDescription *string + + // Details about the algorithm that was used to create the model package. + SourceAlgorithmSpecification *types.SourceAlgorithmSpecification + + // Configurations for one or more transform jobs that Amazon SageMaker runs to test + // the model package. + ValidationSpecification *types.ModelPackageValidationSpecification + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_DescribeMonitoringSchedule.go b/service/sagemaker/api_op_DescribeMonitoringSchedule.go index 7e010f87742..c010ce655c1 100644 --- a/service/sagemaker/api_op_DescribeMonitoringSchedule.go +++ b/service/sagemaker/api_op_DescribeMonitoringSchedule.go @@ -66,46 +66,46 @@ type DescribeMonitoringScheduleInput struct { type DescribeMonitoringScheduleOutput struct { - // The status of an monitoring job. + // The time at which the monitoring job was created. // // This member is required. - MonitoringScheduleStatus types.ScheduleStatus - - // The name of the endpoint for the monitoring job. - EndpointName *string - - // Describes metadata on the last execution to run, if there was one. - LastMonitoringExecutionSummary *types.MonitoringExecutionSummary + CreationTime *time.Time - // The configuration object that specifies the monitoring schedule and defines the - // monitoring job. + // The time at which the monitoring job was last modified. // // This member is required. - MonitoringScheduleConfig *types.MonitoringScheduleConfig - - // A string, up to one KB in size, that contains the reason a monitoring job - // failed, if it failed. - FailureReason *string + LastModifiedTime *time.Time - // The time at which the monitoring job was created. + // The Amazon Resource Name (ARN) of the monitoring schedule. // // This member is required. - CreationTime *time.Time + MonitoringScheduleArn *string - // The time at which the monitoring job was last modified. + // The configuration object that specifies the monitoring schedule and defines the + // monitoring job. // // This member is required. - LastModifiedTime *time.Time + MonitoringScheduleConfig *types.MonitoringScheduleConfig // Name of the monitoring schedule. // // This member is required. MonitoringScheduleName *string - // The Amazon Resource Name (ARN) of the monitoring schedule. + // The status of an monitoring job. // // This member is required. - MonitoringScheduleArn *string + MonitoringScheduleStatus types.ScheduleStatus + + // The name of the endpoint for the monitoring job. + EndpointName *string + + // A string, up to one KB in size, that contains the reason a monitoring job + // failed, if it failed. + FailureReason *string + + // Describes metadata on the last execution to run, if there was one. + LastMonitoringExecutionSummary *types.MonitoringExecutionSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sagemaker/api_op_DescribeNotebookInstance.go b/service/sagemaker/api_op_DescribeNotebookInstance.go index 940dc2ef7bf..3d1abd5ced4 100644 --- a/service/sagemaker/api_op_DescribeNotebookInstance.go +++ b/service/sagemaker/api_op_DescribeNotebookInstance.go @@ -66,67 +66,12 @@ type DescribeNotebookInstanceInput struct { type DescribeNotebookInstanceOutput struct { - // Whether root access is enabled or disabled for users of the notebook instance. - // Lifecycle configurations need root access to be able to set up a notebook - // instance. Because of this, lifecycle configurations associated with a notebook - // instance always run with root access even if you disable root access for users. - RootAccess types.RootAccess - - // The name of the Amazon SageMaker notebook instance. - NotebookInstanceName *string - - // A timestamp. Use this parameter to return the time when the notebook instance - // was created - CreationTime *time.Time - - // A timestamp. Use this parameter to retrieve the time when the notebook instance - // was last modified. - LastModifiedTime *time.Time - - // The URL that you use to connect to the Jupyter notebook that is running in your - // notebook instance. - Url *string - - // The network interface IDs that Amazon SageMaker created at the time of creating - // the instance. - NetworkInterfaceId *string - // A list of the Elastic Inference (EI) instance types associated with this // notebook instance. Currently only one EI instance type can be associated with a // notebook instance. For more information, see Using Elastic Inference in Amazon // SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html). AcceleratorTypes []types.NotebookInstanceAcceleratorType - // The Amazon Resource Name (ARN) of the IAM role associated with the instance. - RoleArn *string - - // The size, in GB, of the ML storage volume attached to the notebook instance. - VolumeSizeInGB *int32 - - // Returns the name of a notebook instance lifecycle configuration. For information - // about notebook instance lifestyle configurations, see Step 2.1: (Optional) - // Customize a Notebook Instance - // (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html) - NotebookInstanceLifecycleConfigName *string - - // Describes whether Amazon SageMaker provides internet access to the notebook - // instance. If this value is set to Disabled, the notebook instance does not have - // internet access, and cannot connect to Amazon SageMaker training and endpoint - // services. For more information, see Notebook Instances Are Internet-Enabled by - // Default - // (https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access). - DirectInternetAccess types.DirectInternetAccess - - // The Amazon Resource Name (ARN) of the notebook instance. - NotebookInstanceArn *string - - // The AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the - // ML storage volume attached to the instance. - KmsKeyId *string - - // The ID of the VPC subnet. - SubnetId *string - // An array of up to three Git repositories associated with the notebook instance. // These can be either the names of Git repositories stored as resources in your // account, or the URL of Git repositories in AWS CodeCommit @@ -137,11 +82,9 @@ type DescribeNotebookInstanceOutput struct { // (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). AdditionalCodeRepositories []*string - // The type of ML compute instance running on the notebook instance. - InstanceType types.InstanceType - - // The IDs of the VPC security groups. - SecurityGroups []*string + // A timestamp. Use this parameter to return the time when the notebook instance + // was created + CreationTime *time.Time // The Git repository associated with the notebook instance as its default code // repository. This can be either the name of a Git repository stored as a resource @@ -153,12 +96,69 @@ type DescribeNotebookInstanceOutput struct { // (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). DefaultCodeRepository *string - // The status of the notebook instance. - NotebookInstanceStatus types.NotebookInstanceStatus + // Describes whether Amazon SageMaker provides internet access to the notebook + // instance. If this value is set to Disabled, the notebook instance does not have + // internet access, and cannot connect to Amazon SageMaker training and endpoint + // services. For more information, see Notebook Instances Are Internet-Enabled by + // Default + // (https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access). + DirectInternetAccess types.DirectInternetAccess // If status is Failed, the reason it failed. FailureReason *string + // The type of ML compute instance running on the notebook instance. + InstanceType types.InstanceType + + // The AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the + // ML storage volume attached to the instance. + KmsKeyId *string + + // A timestamp. Use this parameter to retrieve the time when the notebook instance + // was last modified. + LastModifiedTime *time.Time + + // The network interface IDs that Amazon SageMaker created at the time of creating + // the instance. + NetworkInterfaceId *string + + // The Amazon Resource Name (ARN) of the notebook instance. + NotebookInstanceArn *string + + // Returns the name of a notebook instance lifecycle configuration. For information + // about notebook instance lifestyle configurations, see Step 2.1: (Optional) + // Customize a Notebook Instance + // (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html) + NotebookInstanceLifecycleConfigName *string + + // The name of the Amazon SageMaker notebook instance. + NotebookInstanceName *string + + // The status of the notebook instance. + NotebookInstanceStatus types.NotebookInstanceStatus + + // The Amazon Resource Name (ARN) of the IAM role associated with the instance. + RoleArn *string + + // Whether root access is enabled or disabled for users of the notebook instance. + // Lifecycle configurations need root access to be able to set up a notebook + // instance. Because of this, lifecycle configurations associated with a notebook + // instance always run with root access even if you disable root access for users. + RootAccess types.RootAccess + + // The IDs of the VPC security groups. + SecurityGroups []*string + + // The ID of the VPC subnet. + SubnetId *string + + // The URL that you use to connect to the Jupyter notebook that is running in your + // notebook instance. + Url *string + + // The size, in GB, of the ML storage volume attached to the notebook instance. + VolumeSizeInGB *int32 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_DescribeNotebookInstanceLifecycleConfig.go b/service/sagemaker/api_op_DescribeNotebookInstanceLifecycleConfig.go index 50feec2a4d7..7f160448d63 100644 --- a/service/sagemaker/api_op_DescribeNotebookInstanceLifecycleConfig.go +++ b/service/sagemaker/api_op_DescribeNotebookInstanceLifecycleConfig.go @@ -69,24 +69,24 @@ type DescribeNotebookInstanceLifecycleConfigInput struct { type DescribeNotebookInstanceLifecycleConfigOutput struct { - // The shell script that runs every time you start a notebook instance, including - // when you create the notebook instance. - OnStart []*types.NotebookInstanceLifecycleHook + // A timestamp that tells when the lifecycle configuration was created. + CreationTime *time.Time // A timestamp that tells when the lifecycle configuration was last modified. LastModifiedTime *time.Time - // A timestamp that tells when the lifecycle configuration was created. - CreationTime *time.Time - // The Amazon Resource Name (ARN) of the lifecycle configuration. NotebookInstanceLifecycleConfigArn *string + // The name of the lifecycle configuration. + NotebookInstanceLifecycleConfigName *string + // The shell script that runs only once, when you create a notebook instance. OnCreate []*types.NotebookInstanceLifecycleHook - // The name of the lifecycle configuration. - NotebookInstanceLifecycleConfigName *string + // The shell script that runs every time you start a notebook instance, including + // when you create the notebook instance. + OnStart []*types.NotebookInstanceLifecycleHook // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sagemaker/api_op_DescribeProcessingJob.go b/service/sagemaker/api_op_DescribeProcessingJob.go index 72b095cb3a2..36fa24a3132 100644 --- a/service/sagemaker/api_op_DescribeProcessingJob.go +++ b/service/sagemaker/api_op_DescribeProcessingJob.go @@ -67,18 +67,31 @@ type DescribeProcessingJobInput struct { type DescribeProcessingJobOutput struct { - // The ARN of a monitoring schedule for an endpoint associated with this processing - // job. - MonitoringScheduleArn *string + // Configures the processing job to run a specified container image. + // + // This member is required. + AppSpecification *types.AppSpecification - // The time at which the processing job started. - ProcessingStartTime *time.Time + // The time at which the processing job was created. + // + // This member is required. + CreationTime *time.Time - // The configuration information used to create an experiment. - ExperimentConfig *types.ExperimentConfig + // The Amazon Resource Name (ARN) of the processing job. + // + // This member is required. + ProcessingJobArn *string - // The time limit for how long the processing job is allowed to run. - StoppingCondition *types.ProcessingStoppingCondition + // The name of the processing job. The name must be unique within an AWS Region in + // the AWS account. + // + // This member is required. + ProcessingJobName *string + + // Provides the status of a processing job. + // + // This member is required. + ProcessingJobStatus types.ProcessingJobStatus // Identifies the resources, ML compute instances, and ML storage volumes to deploy // for a processing job. In distributed training, you specify more than one @@ -87,22 +100,32 @@ type DescribeProcessingJobOutput struct { // This member is required. ProcessingResources *types.ProcessingResources - // Networking options for a processing job. - NetworkConfig *types.NetworkConfig - // The ARN of an AutoML job associated with this processing job. AutoMLJobArn *string + // The environment variables set in the Docker container. + Environment map[string]*string + + // An optional string, up to one KB in size, that contains metadata from the + // processing container when the processing job exits. + ExitMessage *string + + // The configuration information used to create an experiment. + ExperimentConfig *types.ExperimentConfig + // A string, up to one KB in size, that contains the reason a processing job // failed, if it failed. FailureReason *string - // The ARN of a training job associated with this processing job. - TrainingJobArn *string + // The time at which the processing job was last modified. + LastModifiedTime *time.Time - // The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume - // to perform tasks on your behalf. - RoleArn *string + // The ARN of a monitoring schedule for an endpoint associated with this processing + // job. + MonitoringScheduleArn *string + + // Networking options for a processing job. + NetworkConfig *types.NetworkConfig // The time at which the processing job completed. ProcessingEndTime *time.Time @@ -110,44 +133,21 @@ type DescribeProcessingJobOutput struct { // The inputs for a processing job. ProcessingInputs []*types.ProcessingInput - // The name of the processing job. The name must be unique within an AWS Region in - // the AWS account. - // - // This member is required. - ProcessingJobName *string - - // The Amazon Resource Name (ARN) of the processing job. - // - // This member is required. - ProcessingJobArn *string - - // An optional string, up to one KB in size, that contains metadata from the - // processing container when the processing job exits. - ExitMessage *string - - // Provides the status of a processing job. - // - // This member is required. - ProcessingJobStatus types.ProcessingJobStatus - - // Configures the processing job to run a specified container image. - // - // This member is required. - AppSpecification *types.AppSpecification - // Output configuration for the processing job. ProcessingOutputConfig *types.ProcessingOutputConfig - // The time at which the processing job was created. - // - // This member is required. - CreationTime *time.Time + // The time at which the processing job started. + ProcessingStartTime *time.Time - // The environment variables set in the Docker container. - Environment map[string]*string + // The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume + // to perform tasks on your behalf. + RoleArn *string - // The time at which the processing job was last modified. - LastModifiedTime *time.Time + // The time limit for how long the processing job is allowed to run. + StoppingCondition *types.ProcessingStoppingCondition + + // The ARN of a training job associated with this processing job. + TrainingJobArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sagemaker/api_op_DescribeTrainingJob.go b/service/sagemaker/api_op_DescribeTrainingJob.go index 161e4918122..098a2f6c937 100644 --- a/service/sagemaker/api_op_DescribeTrainingJob.go +++ b/service/sagemaker/api_op_DescribeTrainingJob.go @@ -66,42 +66,21 @@ type DescribeTrainingJobInput struct { type DescribeTrainingJobOutput struct { - // Configuration of storage locations for TensorBoard output. - TensorBoardOutputConfig *types.TensorBoardOutputConfig - - // If the training job failed, the reason it failed. - FailureReason *string - - // The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job - // that created the transform or training job. - LabelingJobArn *string - - // If you want to allow inbound or outbound network calls, except for calls between - // peers within a training cluster for distributed training, choose True. If you - // enable network isolation for training jobs that are configured to use a VPC, - // Amazon SageMaker downloads and uploads customer data and model artifacts through - // the specified VPC, but the training container does not have network access. - EnableNetworkIsolation *bool - - // Indicates the time when the training job ends on training instances. You are - // billed for the time interval between the value of TrainingStartTime and this - // time. For successful jobs and stopped jobs, this is the time after model - // artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker - // detects a job failure. - TrainingEndTime *time.Time - - // Contains information about the output location for managed spot training - // checkpoint data. - CheckpointConfig *types.CheckpointConfig + // Information about the algorithm used for training, and algorithm metadata. + // + // This member is required. + AlgorithmSpecification *types.AlgorithmSpecification // A timestamp that indicates when the training job was created. // // This member is required. CreationTime *time.Time - // A timestamp that indicates when the status of the training job was last - // modified. - LastModifiedTime *time.Time + // Information about the Amazon S3 location that is configured for storing model + // artifacts. + // + // This member is required. + ModelArtifacts *types.ModelArtifacts // Resources, including ML compute instances and ML storage volumes, that are // configured for model training. @@ -109,15 +88,6 @@ type DescribeTrainingJobOutput struct { // This member is required. ResourceConfig *types.ResourceConfig - // A collection of MetricData objects that specify the names, values, and dates and - // times that the training algorithm emitted to Amazon CloudWatch. - FinalMetricDataList []*types.MetricData - - // Name of the model training job. - // - // This member is required. - TrainingJobName *string - // Provides detailed information about the state of the training job. For detailed // information on the secondary status of the training job, see StatusMessage under // SecondaryStatusTransition (). Amazon SageMaker provides primary statuses and @@ -176,25 +146,6 @@ type DescribeTrainingJobOutput struct { // This member is required. SecondaryStatus types.SecondaryStatus - // An array of Channel objects that describes each data input channel. - InputDataConfig []*types.Channel - - // The billable time in seconds. You can calculate the savings from using managed - // spot training using the formula (1 - BillableTimeInSeconds / - // TrainingTimeInSeconds) * 100. For example, if BillableTimeInSeconds is 100 and - // TrainingTimeInSeconds is 500, the savings is 80%. - BillableTimeInSeconds *int32 - - // The AWS Identity and Access Management (IAM) role configured for the training - // job. - RoleArn *string - - // Information about the Amazon S3 location that is configured for storing model - // artifacts. - // - // This member is required. - ModelArtifacts *types.ModelArtifacts - // Specifies a limit to how long a model training job can run. It also specifies // the maximum time to wait for a spot instance. When the job reaches the time // limit, Amazon SageMaker ends the training job. Use this API to cap model @@ -206,38 +157,15 @@ type DescribeTrainingJobOutput struct { // This member is required. StoppingCondition *types.StoppingCondition - // Associates a SageMaker job as a trial component with an experiment and trial. - // Specified when you call the following APIs: - // - // * CreateProcessingJob () - // - // * - // CreateTrainingJob () + // The Amazon Resource Name (ARN) of the training job. // - // * CreateTransformJob () - ExperimentConfig *types.ExperimentConfig - - // The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if - // the training job was launched by a hyperparameter tuning job. - TuningJobArn *string - - // Configuration information for debugging rules. - DebugRuleConfigurations []*types.DebugRuleConfiguration - - // The Amazon Resource Name (ARN) of an AutoML job. - AutoMLJobArn *string - - // To encrypt all communications between ML compute instances in distributed - // training, choose True. Encryption provides greater security for distributed - // training, but training might take longer. How long it takes depends on the - // amount of communication between compute instances, especially if you use a deep - // learning algorithms in distributed training. - EnableInterContainerTrafficEncryption *bool + // This member is required. + TrainingJobArn *string - // A VpcConfig () object that specifies the VPC that this training job has access - // to. For more information, see Protect Training Jobs by Using an Amazon Virtual - // Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). - VpcConfig *types.VpcConfig + // Name of the model training job. + // + // This member is required. + TrainingJobName *string // The status of the training job. Amazon SageMaker provides the following training // job statuses: @@ -262,26 +190,100 @@ type DescribeTrainingJobOutput struct { // This member is required. TrainingJobStatus types.TrainingJobStatus - // A history of all of the secondary statuses that the training job has - // transitioned through. - SecondaryStatusTransitions []*types.SecondaryStatusTransition + // The Amazon Resource Name (ARN) of an AutoML job. + AutoMLJobArn *string - // A Boolean indicating whether managed spot training is enabled (True) or not - // (False). - EnableManagedSpotTraining *bool + // The billable time in seconds. You can calculate the savings from using managed + // spot training using the formula (1 - BillableTimeInSeconds / + // TrainingTimeInSeconds) * 100. For example, if BillableTimeInSeconds is 100 and + // TrainingTimeInSeconds is 500, the savings is 80%. + BillableTimeInSeconds *int32 + + // Contains information about the output location for managed spot training + // checkpoint data. + CheckpointConfig *types.CheckpointConfig // Configuration information for the debug hook parameters, collection // configuration, and storage paths. DebugHookConfig *types.DebugHookConfig + // Configuration information for debugging rules. + DebugRuleConfigurations []*types.DebugRuleConfiguration + + // Status about the debug rule evaluation. + DebugRuleEvaluationStatuses []*types.DebugRuleEvaluationStatus + + // To encrypt all communications between ML compute instances in distributed + // training, choose True. Encryption provides greater security for distributed + // training, but training might take longer. How long it takes depends on the + // amount of communication between compute instances, especially if you use a deep + // learning algorithms in distributed training. + EnableInterContainerTrafficEncryption *bool + + // A Boolean indicating whether managed spot training is enabled (True) or not + // (False). + EnableManagedSpotTraining *bool + + // If you want to allow inbound or outbound network calls, except for calls between + // peers within a training cluster for distributed training, choose True. If you + // enable network isolation for training jobs that are configured to use a VPC, + // Amazon SageMaker downloads and uploads customer data and model artifacts through + // the specified VPC, but the training container does not have network access. + EnableNetworkIsolation *bool + + // Associates a SageMaker job as a trial component with an experiment and trial. + // Specified when you call the following APIs: + // + // * CreateProcessingJob () + // + // * + // CreateTrainingJob () + // + // * CreateTransformJob () + ExperimentConfig *types.ExperimentConfig + + // If the training job failed, the reason it failed. + FailureReason *string + + // A collection of MetricData objects that specify the names, values, and dates and + // times that the training algorithm emitted to Amazon CloudWatch. + FinalMetricDataList []*types.MetricData + + // Algorithm-specific parameters. + HyperParameters map[string]*string + + // An array of Channel objects that describes each data input channel. + InputDataConfig []*types.Channel + + // The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job + // that created the transform or training job. + LabelingJobArn *string + + // A timestamp that indicates when the status of the training job was last + // modified. + LastModifiedTime *time.Time + // The S3 path where model artifacts that you configured when creating the job are // stored. Amazon SageMaker creates subfolders for model artifacts. OutputDataConfig *types.OutputDataConfig - // Information about the algorithm used for training, and algorithm metadata. - // - // This member is required. - AlgorithmSpecification *types.AlgorithmSpecification + // The AWS Identity and Access Management (IAM) role configured for the training + // job. + RoleArn *string + + // A history of all of the secondary statuses that the training job has + // transitioned through. + SecondaryStatusTransitions []*types.SecondaryStatusTransition + + // Configuration of storage locations for TensorBoard output. + TensorBoardOutputConfig *types.TensorBoardOutputConfig + + // Indicates the time when the training job ends on training instances. You are + // billed for the time interval between the value of TrainingStartTime and this + // time. For successful jobs and stopped jobs, this is the time after model + // artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker + // detects a job failure. + TrainingEndTime *time.Time // Indicates the time when the training job starts on training instances. You are // billed for the time interval between this time and the value of TrainingEndTime. @@ -290,19 +292,17 @@ type DescribeTrainingJobOutput struct { // training container. TrainingStartTime *time.Time - // The Amazon Resource Name (ARN) of the training job. - // - // This member is required. - TrainingJobArn *string - // The training time in seconds. TrainingTimeInSeconds *int32 - // Status about the debug rule evaluation. - DebugRuleEvaluationStatuses []*types.DebugRuleEvaluationStatus + // The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if + // the training job was launched by a hyperparameter tuning job. + TuningJobArn *string - // Algorithm-specific parameters. - HyperParameters map[string]*string + // A VpcConfig () object that specifies the VPC that this training job has access + // to. For more information, see Protect Training Jobs by Using an Amazon Virtual + // Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). + VpcConfig *types.VpcConfig // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sagemaker/api_op_DescribeTransformJob.go b/service/sagemaker/api_op_DescribeTransformJob.go index aca117af34d..641c5d1993a 100644 --- a/service/sagemaker/api_op_DescribeTransformJob.go +++ b/service/sagemaker/api_op_DescribeTransformJob.go @@ -66,15 +66,46 @@ type DescribeTransformJobInput struct { type DescribeTransformJobOutput struct { + // A timestamp that shows when the transform Job was created. + // + // This member is required. + CreationTime *time.Time + // The name of the model used in the transform job. // // This member is required. ModelName *string - // A timestamp that shows when the transform Job was created. + // Describes the dataset to be transformed and the Amazon S3 location where it is + // stored. // // This member is required. - CreationTime *time.Time + TransformInput *types.TransformInput + + // The Amazon Resource Name (ARN) of the transform job. + // + // This member is required. + TransformJobArn *string + + // The name of the transform job. + // + // This member is required. + TransformJobName *string + + // The status of the transform job. If the transform job failed, the reason is + // returned in the FailureReason field. + // + // This member is required. + TransformJobStatus types.TransformJobStatus + + // Describes the resources, including ML instance types and ML instance count, to + // use for the transform job. + // + // This member is required. + TransformResources *types.TransformResources + + // The Amazon Resource Name (ARN) of the AutoML transform job. + AutoMLJobArn *string // Specifies the number of records to include in a mini-batch for an HTTP inference // request. A record is a single unit of input data that inference can be made on. @@ -82,14 +113,19 @@ type DescribeTransformJobOutput struct { // strategy, you must set SplitType to Line, RecordIO, or TFRecord. BatchStrategy types.BatchStrategy - // The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job - // that created the transform or training job. - LabelingJobArn *string + // The data structure used to specify the data to be used for inference in a batch + // transform job and to associate the data that is relevant to the prediction + // results in the output. The input filter provided allows you to exclude input + // data that is not needed for inference in a batch transform job. The output + // filter provided allows you to include input data relevant to interpreting the + // predictions in the output from the job. For more information, see Associate + // Prediction Results with their Corresponding Input Records + // (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html). + DataProcessing *types.DataProcessing - // The name of the transform job. - // - // This member is required. - TransformJobName *string + // The environment variables to set in the Docker container. We support up to 16 + // key and values entries in the map. + Environment map[string]*string // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: @@ -102,9 +138,6 @@ type DescribeTransformJobOutput struct { // * CreateTransformJob () ExperimentConfig *types.ExperimentConfig - // The maximum payload size, in MB, used in the transform job. - MaxPayloadInMB *int32 - // If the transform job failed, FailureReason describes why it failed. A transform // job creates a log file, which includes error messages, and stores it as an // Amazon S3 object. For more information, see Log Amazon SageMaker Events with @@ -112,67 +145,34 @@ type DescribeTransformJobOutput struct { // (https://docs.aws.amazon.com/sagemaker/latest/dg/logging-cloudwatch.html). FailureReason *string - // The Amazon Resource Name (ARN) of the AutoML transform job. - AutoMLJobArn *string - - // The status of the transform job. If the transform job failed, the reason is - // returned in the FailureReason field. - // - // This member is required. - TransformJobStatus types.TransformJobStatus - - // Indicates when the transform job has been completed, or has stopped or failed. - // You are billed for the time interval between this time and the value of - // TransformStartTime.

      - TransformEndTime *time.Time - - // The data structure used to specify the data to be used for inference in a batch - // transform job and to associate the data that is relevant to the prediction - // results in the output. The input filter provided allows you to exclude input - // data that is not needed for inference in a batch transform job. The output - // filter provided allows you to include input data relevant to interpreting the - // predictions in the output from the job. For more information, see Associate - // Prediction Results with their Corresponding Input Records - // (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html). - DataProcessing *types.DataProcessing + // The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job + // that created the transform or training job. + LabelingJobArn *string // The maximum number of parallel requests on each instance node that can be // launched in a transform job. The default value is 1. MaxConcurrentTransforms *int32 - // Describes the resources, including ML instance types and ML instance count, to - // use for the transform job. - // - // This member is required. - TransformResources *types.TransformResources - - // Describes the dataset to be transformed and the Amazon S3 location where it is - // stored. - // - // This member is required. - TransformInput *types.TransformInput - - // Indicates when the transform job starts on ML instances. You are billed for the - // time interval between this time and the value of TransformEndTime. - TransformStartTime *time.Time - - // The Amazon Resource Name (ARN) of the transform job. - // - // This member is required. - TransformJobArn *string + // The maximum payload size, in MB, used in the transform job. + MaxPayloadInMB *int32 // The timeout and maximum number of retries for processing a transform job // invocation. ModelClientConfig *types.ModelClientConfig - // The environment variables to set in the Docker container. We support up to 16 - // key and values entries in the map. - Environment map[string]*string + // Indicates when the transform job has been completed, or has stopped or failed. + // You are billed for the time interval between this time and the value of + // TransformStartTime.

      + TransformEndTime *time.Time // Identifies the Amazon S3 location where you want Amazon SageMaker to save the // results from the transform job. TransformOutput *types.TransformOutput + // Indicates when the transform job starts on ML instances. You are billed for the + // time interval between this time and the value of TransformEndTime. + TransformStartTime *time.Time + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_DescribeTrial.go b/service/sagemaker/api_op_DescribeTrial.go index 07fa85e6014..b84fa5c7054 100644 --- a/service/sagemaker/api_op_DescribeTrial.go +++ b/service/sagemaker/api_op_DescribeTrial.go @@ -66,34 +66,34 @@ type DescribeTrialInput struct { type DescribeTrialOutput struct { - // When the trial was last modified. - LastModifiedTime *time.Time + // Who created the trial. + CreatedBy *types.UserContext + + // When the trial was created. + CreationTime *time.Time // The name of the trial as displayed. If DisplayName isn't specified, TrialName is // displayed. DisplayName *string - // The Amazon Resource Name (ARN) of the trial. - TrialArn *string - - // When the trial was created. - CreationTime *time.Time - // The name of the experiment the trial is part of. ExperimentName *string - // The name of the trial. - TrialName *string - - // Who created the trial. - CreatedBy *types.UserContext - // Who last modified the trial. LastModifiedBy *types.UserContext + // When the trial was last modified. + LastModifiedTime *time.Time + // The Amazon Resource Name (ARN) of the source and, optionally, the job type. Source *types.TrialSource + // The Amazon Resource Name (ARN) of the trial. + TrialArn *string + + // The name of the trial. + TrialName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_DescribeTrialComponent.go b/service/sagemaker/api_op_DescribeTrialComponent.go index bfed445ce5d..853a3741d82 100644 --- a/service/sagemaker/api_op_DescribeTrialComponent.go +++ b/service/sagemaker/api_op_DescribeTrialComponent.go @@ -66,23 +66,15 @@ type DescribeTrialComponentInput struct { type DescribeTrialComponentOutput struct { - // When the component started. - StartTime *time.Time - - // The metrics for the component. - Metrics []*types.TrialComponentMetricSummary - - // The hyperparameters of the component. - Parameters map[string]*types.TrialComponentParameterValue - - // Who last modified the component. - LastModifiedBy *types.UserContext + // Who created the component. + CreatedBy *types.UserContext - // The Amazon Resource Name (ARN) of the source and, optionally, the job type. - Source *types.TrialComponentSource + // When the component was created. + CreationTime *time.Time - // The name of the trial component. - TrialComponentName *string + // The name of the component as displayed. If DisplayName isn't specified, + // TrialComponentName is displayed. + DisplayName *string // When the component ended. EndTime *time.Time @@ -90,11 +82,26 @@ type DescribeTrialComponentOutput struct { // The input artifacts of the component. InputArtifacts map[string]*types.TrialComponentArtifact + // Who last modified the component. + LastModifiedBy *types.UserContext + + // When the component was last modified. + LastModifiedTime *time.Time + + // The metrics for the component. + Metrics []*types.TrialComponentMetricSummary + // The output artifacts of the component. OutputArtifacts map[string]*types.TrialComponentArtifact - // Who created the component. - CreatedBy *types.UserContext + // The hyperparameters of the component. + Parameters map[string]*types.TrialComponentParameterValue + + // The Amazon Resource Name (ARN) of the source and, optionally, the job type. + Source *types.TrialComponentSource + + // When the component started. + StartTime *time.Time // The status of the component. States include: // @@ -106,19 +113,12 @@ type DescribeTrialComponentOutput struct { // * Failed Status *types.TrialComponentStatus - // The name of the component as displayed. If DisplayName isn't specified, - // TrialComponentName is displayed. - DisplayName *string - - // When the component was last modified. - LastModifiedTime *time.Time - - // When the component was created. - CreationTime *time.Time - // The Amazon Resource Name (ARN) of the trial component. TrialComponentArn *string + // The name of the trial component. + TrialComponentName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_DescribeUserProfile.go b/service/sagemaker/api_op_DescribeUserProfile.go index 063b02f4f1f..ed994710beb 100644 --- a/service/sagemaker/api_op_DescribeUserProfile.go +++ b/service/sagemaker/api_op_DescribeUserProfile.go @@ -58,51 +58,51 @@ func (c *Client) DescribeUserProfile(ctx context.Context, params *DescribeUserPr type DescribeUserProfileInput struct { - // The user profile name. + // The domain ID. // // This member is required. - UserProfileName *string + DomainId *string - // The domain ID. + // The user profile name. // // This member is required. - DomainId *string + UserProfileName *string } type DescribeUserProfileOutput struct { - // The user profile Amazon Resource Name (ARN). - UserProfileArn *string - - // The SSO user value. - SingleSignOnUserValue *string + // The creation time. + CreationTime *time.Time - // The ID of the user's profile in the Amazon Elastic File System (EFS) volume. - HomeEfsFileSystemUid *string + // The ID of the domain that contains the profile. + DomainId *string // The failure reason. FailureReason *string - // A collection of settings. - UserSettings *types.UserSettings + // The ID of the user's profile in the Amazon Elastic File System (EFS) volume. + HomeEfsFileSystemUid *string + + // The last modified time. + LastModifiedTime *time.Time // The SSO user identifier. SingleSignOnUserIdentifier *string - // The ID of the domain that contains the profile. - DomainId *string + // The SSO user value. + SingleSignOnUserValue *string // The status. Status types.UserProfileStatus + // The user profile Amazon Resource Name (ARN). + UserProfileArn *string + // The user profile name. UserProfileName *string - // The last modified time. - LastModifiedTime *time.Time - - // The creation time. - CreationTime *time.Time + // A collection of settings. + UserSettings *types.UserSettings // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sagemaker/api_op_DisassociateTrialComponent.go b/service/sagemaker/api_op_DisassociateTrialComponent.go index fa3e7d8070d..bd81f393550 100644 --- a/service/sagemaker/api_op_DisassociateTrialComponent.go +++ b/service/sagemaker/api_op_DisassociateTrialComponent.go @@ -62,25 +62,25 @@ func (c *Client) DisassociateTrialComponent(ctx context.Context, params *Disasso type DisassociateTrialComponentInput struct { - // The name of the trial to disassociate from. + // The name of the component to disassociate from the trial. // // This member is required. - TrialName *string + TrialComponentName *string - // The name of the component to disassociate from the trial. + // The name of the trial to disassociate from. // // This member is required. - TrialComponentName *string + TrialName *string } type DisassociateTrialComponentOutput struct { - // The ARN of the trial component. - TrialComponentArn *string - // The Amazon Resource Name (ARN) of the trial. TrialArn *string + // The ARN of the trial component. + TrialComponentArn *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_GetSearchSuggestions.go b/service/sagemaker/api_op_GetSearchSuggestions.go index 5984f7f66bb..269bfe060e9 100644 --- a/service/sagemaker/api_op_GetSearchSuggestions.go +++ b/service/sagemaker/api_op_GetSearchSuggestions.go @@ -59,13 +59,13 @@ func (c *Client) GetSearchSuggestions(ctx context.Context, params *GetSearchSugg type GetSearchSuggestionsInput struct { - // Limits the property names that are included in the response. - SuggestionQuery *types.SuggestionQuery - // The name of the Amazon SageMaker resource to search for. // // This member is required. Resource types.ResourceType + + // Limits the property names that are included in the response. + SuggestionQuery *types.SuggestionQuery } type GetSearchSuggestionsOutput struct { diff --git a/service/sagemaker/api_op_ListAlgorithms.go b/service/sagemaker/api_op_ListAlgorithms.go index 1b06934637a..8be4eec727c 100644 --- a/service/sagemaker/api_op_ListAlgorithms.go +++ b/service/sagemaker/api_op_ListAlgorithms.go @@ -57,24 +57,21 @@ func (c *Client) ListAlgorithms(ctx context.Context, params *ListAlgorithmsInput type ListAlgorithmsInput struct { - // The sort order for the results. The default is Ascending. - SortOrder types.SortOrder - - // A string in the algorithm name. This filter returns only algorithms whose name - // contains the specified string. - NameContains *string + // A filter that returns only algorithms created after the specified time + // (timestamp). + CreationTimeAfter *time.Time // A filter that returns only algorithms created before the specified time // (timestamp). CreationTimeBefore *time.Time - // A filter that returns only algorithms created after the specified time - // (timestamp). - CreationTimeAfter *time.Time - // The maximum number of algorithms to return in the response. MaxResults *int32 + // A string in the algorithm name. This filter returns only algorithms whose name + // contains the specified string. + NameContains *string + // If the response to a previous ListAlgorithms request was truncated, the response // includes a NextToken. To retrieve the next set of algorithms, use the token in // the next request. @@ -82,19 +79,22 @@ type ListAlgorithmsInput struct { // The parameter by which to sort the results. The default is CreationTime. SortBy types.AlgorithmSortBy + + // The sort order for the results. The default is Ascending. + SortOrder types.SortOrder } type ListAlgorithmsOutput struct { - // If the response is truncated, Amazon SageMaker returns this token. To retrieve - // the next set of algorithms, use it in the subsequent request. - NextToken *string - // >An array of AlgorithmSummary objects, each of which lists an algorithm. // // This member is required. AlgorithmSummaryList []*types.AlgorithmSummary + // If the response is truncated, Amazon SageMaker returns this token. To retrieve + // the next set of algorithms, use it in the subsequent request. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_ListApps.go b/service/sagemaker/api_op_ListApps.go index 39aea9f1a65..2e7b0c16748 100644 --- a/service/sagemaker/api_op_ListApps.go +++ b/service/sagemaker/api_op_ListApps.go @@ -56,35 +56,35 @@ func (c *Client) ListApps(ctx context.Context, params *ListAppsInput, optFns ... type ListAppsInput struct { - // The sort order for the results. The default is Ascending. - SortOrder types.SortOrder + // A parameter to search for the domain ID. + DomainIdEquals *string - // A parameter to search by user profile name. - UserProfileNameEquals *string + // Returns a list up to a specified limit. + MaxResults *int32 // If the previous response was truncated, you will receive this token. Use it in // your next request to receive the next set of results. NextToken *string - // Returns a list up to a specified limit. - MaxResults *int32 - // The parameter by which to sort the results. The default is CreationTime. SortBy types.AppSortKey - // A parameter to search for the domain ID. - DomainIdEquals *string + // The sort order for the results. The default is Ascending. + SortOrder types.SortOrder + + // A parameter to search by user profile name. + UserProfileNameEquals *string } type ListAppsOutput struct { + // The list of apps. + Apps []*types.AppDetails + // If the previous response was truncated, you will receive this token. Use it in // your next request to receive the next set of results. NextToken *string - // The list of apps. - Apps []*types.AppDetails - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_ListAutoMLJobs.go b/service/sagemaker/api_op_ListAutoMLJobs.go index 538128063fb..3a18b49b99a 100644 --- a/service/sagemaker/api_op_ListAutoMLJobs.go +++ b/service/sagemaker/api_op_ListAutoMLJobs.go @@ -57,36 +57,36 @@ func (c *Client) ListAutoMLJobs(ctx context.Context, params *ListAutoMLJobsInput type ListAutoMLJobsInput struct { - // The parameter by which to sort the results. The default is AutoMLJobName. - SortBy types.AutoMLSortBy + // Request a list of jobs, using a filter for time. + CreationTimeAfter *time.Time // Request a list of jobs, using a filter for time. CreationTimeBefore *time.Time - // Request a list of jobs, using a filter for status. - StatusEquals types.AutoMLJobStatus + // Request a list of jobs, using a filter for time. + LastModifiedTimeAfter *time.Time // Request a list of jobs, using a filter for time. LastModifiedTimeBefore *time.Time - // Request a list of jobs, using a filter for time. - CreationTimeAfter *time.Time + // Request a list of jobs up to a specified limit. + MaxResults *int32 // Request a list of jobs, using a search filter for name. NameContains *string - // The sort order for the results. The default is Descending. - SortOrder types.AutoMLSortOrder - // If the previous response was truncated, you will receive this token. Use it in // your next request to receive the next set of results. NextToken *string - // Request a list of jobs, using a filter for time. - LastModifiedTimeAfter *time.Time + // The parameter by which to sort the results. The default is AutoMLJobName. + SortBy types.AutoMLSortBy - // Request a list of jobs up to a specified limit. - MaxResults *int32 + // The sort order for the results. The default is Descending. + SortOrder types.AutoMLSortOrder + + // Request a list of jobs, using a filter for status. + StatusEquals types.AutoMLJobStatus } type ListAutoMLJobsOutput struct { diff --git a/service/sagemaker/api_op_ListCandidatesForAutoMLJob.go b/service/sagemaker/api_op_ListCandidatesForAutoMLJob.go index 9069f47bf0f..1529cbf4572 100644 --- a/service/sagemaker/api_op_ListCandidatesForAutoMLJob.go +++ b/service/sagemaker/api_op_ListCandidatesForAutoMLJob.go @@ -57,29 +57,29 @@ func (c *Client) ListCandidatesForAutoMLJob(ctx context.Context, params *ListCan type ListCandidatesForAutoMLJobInput struct { - // List the Candidates for the job and filter by status. - StatusEquals types.CandidateStatus - - // The parameter by which to sort the results. The default is Descending. - SortBy types.CandidateSortBy - - // The sort order for the results. The default is Ascending. - SortOrder types.AutoMLSortOrder - - // List the job's Candidates up to a specified limit. - MaxResults *int32 - // List the Candidates created for the job by providing the job's name. // // This member is required. AutoMLJobName *string + // List the Candidates for the job and filter by candidate name. + CandidateNameEquals *string + + // List the job's Candidates up to a specified limit. + MaxResults *int32 + // If the previous response was truncated, you will receive this token. Use it in // your next request to receive the next set of results. NextToken *string - // List the Candidates for the job and filter by candidate name. - CandidateNameEquals *string + // The parameter by which to sort the results. The default is Descending. + SortBy types.CandidateSortBy + + // The sort order for the results. The default is Ascending. + SortOrder types.AutoMLSortOrder + + // List the Candidates for the job and filter by status. + StatusEquals types.CandidateStatus } type ListCandidatesForAutoMLJobOutput struct { diff --git a/service/sagemaker/api_op_ListCodeRepositories.go b/service/sagemaker/api_op_ListCodeRepositories.go index 320d8faa7ec..d9c696415c5 100644 --- a/service/sagemaker/api_op_ListCodeRepositories.go +++ b/service/sagemaker/api_op_ListCodeRepositories.go @@ -57,48 +57,43 @@ func (c *Client) ListCodeRepositories(ctx context.Context, params *ListCodeRepos type ListCodeRepositoriesInput struct { + // A filter that returns only Git repositories that were created after the + // specified time. + CreationTimeAfter *time.Time + + // A filter that returns only Git repositories that were created before the + // specified time. + CreationTimeBefore *time.Time + // A filter that returns only Git repositories that were last modified after the // specified time. LastModifiedTimeAfter *time.Time - // A string in the Git repositories name. This filter returns only repositories - // whose name contains the specified string. - NameContains *string - // A filter that returns only Git repositories that were last modified before the // specified time. LastModifiedTimeBefore *time.Time - // A filter that returns only Git repositories that were created before the - // specified time. - CreationTimeBefore *time.Time - - // A filter that returns only Git repositories that were created after the - // specified time. - CreationTimeAfter *time.Time + // The maximum number of Git repositories to return in the response. + MaxResults *int32 - // The sort order for results. The default is Ascending. - SortOrder types.CodeRepositorySortOrder + // A string in the Git repositories name. This filter returns only repositories + // whose name contains the specified string. + NameContains *string // If the result of a ListCodeRepositoriesOutput request was truncated, the // response includes a NextToken. To get the next set of Git repositories, use the // token in the next request. NextToken *string - // The maximum number of Git repositories to return in the response. - MaxResults *int32 - // The field to sort results by. The default is Name. SortBy types.CodeRepositorySortBy + + // The sort order for results. The default is Ascending. + SortOrder types.CodeRepositorySortOrder } type ListCodeRepositoriesOutput struct { - // If the result of a ListCodeRepositoriesOutput request was truncated, the - // response includes a NextToken. To get the next set of Git repositories, use the - // token in the next request. - NextToken *string - // Gets a list of summaries of the Git repositories. Each summary specifies the // following values for the repository: // @@ -119,6 +114,11 @@ type ListCodeRepositoriesOutput struct { // This member is required. CodeRepositorySummaryList []*types.CodeRepositorySummary + // If the result of a ListCodeRepositoriesOutput request was truncated, the + // response includes a NextToken. To get the next set of Git repositories, use the + // token in the next request. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_ListCompilationJobs.go b/service/sagemaker/api_op_ListCompilationJobs.go index 31d8fcd107f..b44f73f0f4f 100644 --- a/service/sagemaker/api_op_ListCompilationJobs.go +++ b/service/sagemaker/api_op_ListCompilationJobs.go @@ -60,32 +60,36 @@ func (c *Client) ListCompilationJobs(ctx context.Context, params *ListCompilatio type ListCompilationJobsInput struct { - // If the result of the previous ListCompilationJobs request was truncated, the - // response includes a NextToken. To retrieve the next set of model compilation - // jobs, use the token in the next request. - NextToken *string - // A filter that returns the model compilation jobs that were created after a // specified time. CreationTimeAfter *time.Time + // A filter that returns the model compilation jobs that were created before a + // specified time. + CreationTimeBefore *time.Time + + // A filter that returns the model compilation jobs that were modified after a + // specified time. + LastModifiedTimeAfter *time.Time + // A filter that returns the model compilation jobs that were modified before a // specified time. LastModifiedTimeBefore *time.Time - // The field by which to sort results. The default is CreationTime. - SortBy types.ListCompilationJobsSortBy + // The maximum number of model compilation jobs to return in the response. + MaxResults *int32 // A filter that returns the model compilation jobs whose name contains a specified // string. NameContains *string - // The maximum number of model compilation jobs to return in the response. - MaxResults *int32 + // If the result of the previous ListCompilationJobs request was truncated, the + // response includes a NextToken. To retrieve the next set of model compilation + // jobs, use the token in the next request. + NextToken *string - // A filter that returns the model compilation jobs that were modified after a - // specified time. - LastModifiedTimeAfter *time.Time + // The field by which to sort results. The default is CreationTime. + SortBy types.ListCompilationJobsSortBy // The sort order for results. The default is Ascending. SortOrder types.SortOrder @@ -93,10 +97,6 @@ type ListCompilationJobsInput struct { // A filter that retrieves model compilation jobs with a specific // DescribeCompilationJobResponse$CompilationJobStatus () status. StatusEquals types.CompilationJobStatus - - // A filter that returns the model compilation jobs that were created before a - // specified time. - CreationTimeBefore *time.Time } type ListCompilationJobsOutput struct { diff --git a/service/sagemaker/api_op_ListEndpointConfigs.go b/service/sagemaker/api_op_ListEndpointConfigs.go index 9319aacbd04..7bc38bf4cff 100644 --- a/service/sagemaker/api_op_ListEndpointConfigs.go +++ b/service/sagemaker/api_op_ListEndpointConfigs.go @@ -57,26 +57,26 @@ func (c *Client) ListEndpointConfigs(ctx context.Context, params *ListEndpointCo type ListEndpointConfigsInput struct { + // A filter that returns only endpoint configurations with a creation time greater + // than or equal to the specified time (timestamp). + CreationTimeAfter *time.Time + // A filter that returns only endpoint configurations created before the specified // time (timestamp). CreationTimeBefore *time.Time + // The maximum number of training jobs to return in the response. + MaxResults *int32 + // A string in the endpoint configuration name. This filter returns only endpoint // configurations whose name contains the specified string. NameContains *string - // A filter that returns only endpoint configurations with a creation time greater - // than or equal to the specified time (timestamp). - CreationTimeAfter *time.Time - // If the result of the previous ListEndpointConfig request was truncated, the // response includes a NextToken. To retrieve the next set of endpoint // configurations, use the token in the next request. NextToken *string - // The maximum number of training jobs to return in the response. - MaxResults *int32 - // The field to sort results by. The default is CreationTime. SortBy types.EndpointConfigSortKey @@ -86,15 +86,15 @@ type ListEndpointConfigsInput struct { type ListEndpointConfigsOutput struct { - // If the response is truncated, Amazon SageMaker returns this token. To retrieve - // the next set of endpoint configurations, use it in the subsequent request - NextToken *string - // An array of endpoint configurations. // // This member is required. EndpointConfigs []*types.EndpointConfigSummary + // If the response is truncated, Amazon SageMaker returns this token. To retrieve + // the next set of endpoint configurations, use it in the subsequent request + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_ListEndpoints.go b/service/sagemaker/api_op_ListEndpoints.go index 657e92f3c25..6b6c43defd8 100644 --- a/service/sagemaker/api_op_ListEndpoints.go +++ b/service/sagemaker/api_op_ListEndpoints.go @@ -57,24 +57,21 @@ func (c *Client) ListEndpoints(ctx context.Context, params *ListEndpointsInput, type ListEndpointsInput struct { - // A filter that returns only endpoints with the specified status. - StatusEquals types.EndpointStatus - - // A filter that returns only endpoints that were modified after the specified - // timestamp. - LastModifiedTimeAfter *time.Time - - // Sorts the list of results. The default is CreationTime. - SortBy types.EndpointSortKey + // A filter that returns only endpoints with a creation time greater than or equal + // to the specified time (timestamp). + CreationTimeAfter *time.Time // A filter that returns only endpoints that were created before the specified time // (timestamp). CreationTimeBefore *time.Time - // If the result of a ListEndpoints request was truncated, the response includes a - // NextToken. To retrieve the next set of endpoints, use the token in the next - // request. - NextToken *string + // A filter that returns only endpoints that were modified after the specified + // timestamp. + LastModifiedTimeAfter *time.Time + + // A filter that returns only endpoints that were modified before the specified + // timestamp. + LastModifiedTimeBefore *time.Time // The maximum number of endpoints to return in the response. MaxResults *int32 @@ -83,16 +80,19 @@ type ListEndpointsInput struct { // contains the specified string. NameContains *string + // If the result of a ListEndpoints request was truncated, the response includes a + // NextToken. To retrieve the next set of endpoints, use the token in the next + // request. + NextToken *string + + // Sorts the list of results. The default is CreationTime. + SortBy types.EndpointSortKey + // The sort order for results. The default is Descending. SortOrder types.OrderKey - // A filter that returns only endpoints with a creation time greater than or equal - // to the specified time (timestamp). - CreationTimeAfter *time.Time - - // A filter that returns only endpoints that were modified before the specified - // timestamp. - LastModifiedTimeBefore *time.Time + // A filter that returns only endpoints with the specified status. + StatusEquals types.EndpointStatus } type ListEndpointsOutput struct { diff --git a/service/sagemaker/api_op_ListExperiments.go b/service/sagemaker/api_op_ListExperiments.go index 133463c1f5a..c7660230f07 100644 --- a/service/sagemaker/api_op_ListExperiments.go +++ b/service/sagemaker/api_op_ListExperiments.go @@ -59,35 +59,35 @@ func (c *Client) ListExperiments(ctx context.Context, params *ListExperimentsInp type ListExperimentsInput struct { - // The sort order. The default value is Descending. - SortOrder types.SortOrder + // A filter that returns only experiments created after the specified time. + CreatedAfter *time.Time // A filter that returns only experiments created before the specified time. CreatedBefore *time.Time - // A filter that returns only experiments created after the specified time. - CreatedAfter *time.Time - - // The property used to sort results. The default value is CreationTime. - SortBy types.SortExperimentsBy + // The maximum number of experiments to return in the response. The default value + // is 10. + MaxResults *int32 // If the previous call to ListExperiments didn't return the full set of // experiments, the call returns a token for getting the next set of experiments. NextToken *string - // The maximum number of experiments to return in the response. The default value - // is 10. - MaxResults *int32 + // The property used to sort results. The default value is CreationTime. + SortBy types.SortExperimentsBy + + // The sort order. The default value is Descending. + SortOrder types.SortOrder } type ListExperimentsOutput struct { - // A token for getting the next set of experiments, if there are any. - NextToken *string - // A list of the summaries of your experiments. ExperimentSummaries []*types.ExperimentSummary + // A token for getting the next set of experiments, if there are any. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_ListFlowDefinitions.go b/service/sagemaker/api_op_ListFlowDefinitions.go index 1ec77be13ff..99666ba1cc6 100644 --- a/service/sagemaker/api_op_ListFlowDefinitions.go +++ b/service/sagemaker/api_op_ListFlowDefinitions.go @@ -57,37 +57,37 @@ func (c *Client) ListFlowDefinitions(ctx context.Context, params *ListFlowDefini type ListFlowDefinitionsInput struct { - // A token to resume pagination. - NextToken *string - - // An optional value that specifies whether you want the results sorted in - // Ascending or Descending order. - SortOrder types.SortOrder - // A filter that returns only flow definitions with a creation time greater than or // equal to the specified timestamp. CreationTimeAfter *time.Time + // A filter that returns only flow definitions that were created before the + // specified timestamp. + CreationTimeBefore *time.Time + // The total number of items to return. If the total number of available items is // more than the value specified in MaxResults, then a NextToken will be provided // in the output that you can use to resume pagination. MaxResults *int32 - // A filter that returns only flow definitions that were created before the - // specified timestamp. - CreationTimeBefore *time.Time + // A token to resume pagination. + NextToken *string + + // An optional value that specifies whether you want the results sorted in + // Ascending or Descending order. + SortOrder types.SortOrder } type ListFlowDefinitionsOutput struct { - // A token to resume pagination. - NextToken *string - // An array of objects describing the flow definitions. // // This member is required. FlowDefinitionSummaries []*types.FlowDefinitionSummary + // A token to resume pagination. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_ListHumanTaskUis.go b/service/sagemaker/api_op_ListHumanTaskUis.go index d79b40cba7f..b94e4c22db4 100644 --- a/service/sagemaker/api_op_ListHumanTaskUis.go +++ b/service/sagemaker/api_op_ListHumanTaskUis.go @@ -57,25 +57,25 @@ func (c *Client) ListHumanTaskUis(ctx context.Context, params *ListHumanTaskUisI type ListHumanTaskUisInput struct { - // The total number of items to return. If the total number of available items is - // more than the value specified in MaxResults, then a NextToken will be provided - // in the output that you can use to resume pagination. - MaxResults *int32 + // A filter that returns only human task user interfaces with a creation time + // greater than or equal to the specified timestamp. + CreationTimeAfter *time.Time // A filter that returns only human task user interfaces that were created before // the specified timestamp. CreationTimeBefore *time.Time - // An optional value that specifies whether you want the results sorted in - // Ascending or Descending order. - SortOrder types.SortOrder + // The total number of items to return. If the total number of available items is + // more than the value specified in MaxResults, then a NextToken will be provided + // in the output that you can use to resume pagination. + MaxResults *int32 // A token to resume pagination. NextToken *string - // A filter that returns only human task user interfaces with a creation time - // greater than or equal to the specified timestamp. - CreationTimeAfter *time.Time + // An optional value that specifies whether you want the results sorted in + // Ascending or Descending order. + SortOrder types.SortOrder } type ListHumanTaskUisOutput struct { diff --git a/service/sagemaker/api_op_ListHyperParameterTuningJobs.go b/service/sagemaker/api_op_ListHyperParameterTuningJobs.go index 1f5b0674437..76674b18ace 100644 --- a/service/sagemaker/api_op_ListHyperParameterTuningJobs.go +++ b/service/sagemaker/api_op_ListHyperParameterTuningJobs.go @@ -62,19 +62,14 @@ type ListHyperParameterTuningJobsInput struct { // time. CreationTimeAfter *time.Time - // If the result of the previous ListHyperParameterTuningJobs request was - // truncated, the response includes a NextToken. To retrieve the next set of tuning - // jobs, use the token in the next request. - NextToken *string - - // A string in the tuning job name. This filter returns only tuning jobs whose name - // contains the specified string. - NameContains *string - // A filter that returns only tuning jobs that were created before the specified // time. CreationTimeBefore *time.Time + // A filter that returns only tuning jobs that were modified after the specified + // time. + LastModifiedTimeAfter *time.Time + // A filter that returns only tuning jobs that were modified before the specified // time. LastModifiedTimeBefore *time.Time @@ -82,33 +77,38 @@ type ListHyperParameterTuningJobsInput struct { // The maximum number of tuning jobs to return. The default value is 10. MaxResults *int32 - // A filter that returns only tuning jobs with the specified status. - StatusEquals types.HyperParameterTuningJobStatus + // A string in the tuning job name. This filter returns only tuning jobs whose name + // contains the specified string. + NameContains *string - // A filter that returns only tuning jobs that were modified after the specified - // time. - LastModifiedTimeAfter *time.Time + // If the result of the previous ListHyperParameterTuningJobs request was + // truncated, the response includes a NextToken. To retrieve the next set of tuning + // jobs, use the token in the next request. + NextToken *string // The field to sort results by. The default is Name. SortBy types.HyperParameterTuningJobSortByOptions // The sort order for results. The default is Ascending. SortOrder types.SortOrder + + // A filter that returns only tuning jobs with the specified status. + StatusEquals types.HyperParameterTuningJobStatus } type ListHyperParameterTuningJobsOutput struct { - // If the result of this ListHyperParameterTuningJobs request was truncated, the - // response includes a NextToken. To retrieve the next set of tuning jobs, use the - // token in the next request. - NextToken *string - // A list of HyperParameterTuningJobSummary () objects that describe the tuning // jobs that the ListHyperParameterTuningJobs request returned. // // This member is required. HyperParameterTuningJobSummaries []*types.HyperParameterTuningJobSummary + // If the result of this ListHyperParameterTuningJobs request was truncated, the + // response includes a NextToken. To retrieve the next set of tuning jobs, use the + // token in the next request. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_ListLabelingJobs.go b/service/sagemaker/api_op_ListLabelingJobs.go index cc070f39cc2..e88076f6591 100644 --- a/service/sagemaker/api_op_ListLabelingJobs.go +++ b/service/sagemaker/api_op_ListLabelingJobs.go @@ -57,6 +57,25 @@ func (c *Client) ListLabelingJobs(ctx context.Context, params *ListLabelingJobsI type ListLabelingJobsInput struct { + // A filter that returns only labeling jobs created after the specified time + // (timestamp). + CreationTimeAfter *time.Time + + // A filter that returns only labeling jobs created before the specified time + // (timestamp). + CreationTimeBefore *time.Time + + // A filter that returns only labeling jobs modified after the specified time + // (timestamp). + LastModifiedTimeAfter *time.Time + + // A filter that returns only labeling jobs modified before the specified time + // (timestamp). + LastModifiedTimeBefore *time.Time + + // The maximum number of labeling jobs to return in each page of the response. + MaxResults *int32 + // A string in the labeling job name. This filter returns only labeling jobs whose // name contains the specified string. NameContains *string @@ -66,10 +85,6 @@ type ListLabelingJobsInput struct { // the token in the next request. NextToken *string - // A filter that returns only labeling jobs created after the specified time - // (timestamp). - CreationTimeAfter *time.Time - // The field to sort results by. The default is CreationTime. SortBy types.SortBy @@ -78,32 +93,17 @@ type ListLabelingJobsInput struct { // A filter that retrieves only labeling jobs with a specific status. StatusEquals types.LabelingJobStatus - - // A filter that returns only labeling jobs modified after the specified time - // (timestamp). - LastModifiedTimeAfter *time.Time - - // The maximum number of labeling jobs to return in each page of the response. - MaxResults *int32 - - // A filter that returns only labeling jobs created before the specified time - // (timestamp). - CreationTimeBefore *time.Time - - // A filter that returns only labeling jobs modified before the specified time - // (timestamp). - LastModifiedTimeBefore *time.Time } type ListLabelingJobsOutput struct { + // An array of LabelingJobSummary objects, each describing a labeling job. + LabelingJobSummaryList []*types.LabelingJobSummary + // If the response is truncated, Amazon SageMaker returns this token. To retrieve // the next set of labeling jobs, use it in the subsequent request. NextToken *string - // An array of LabelingJobSummary objects, each describing a labeling job. - LabelingJobSummaryList []*types.LabelingJobSummary - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_ListLabelingJobsForWorkteam.go b/service/sagemaker/api_op_ListLabelingJobsForWorkteam.go index d31e78a110c..e920f506c84 100644 --- a/service/sagemaker/api_op_ListLabelingJobsForWorkteam.go +++ b/service/sagemaker/api_op_ListLabelingJobsForWorkteam.go @@ -58,37 +58,37 @@ func (c *Client) ListLabelingJobsForWorkteam(ctx context.Context, params *ListLa type ListLabelingJobsForWorkteamInput struct { - // The field to sort results by. The default is CreationTime. - SortBy types.ListLabelingJobsForWorkteamSortByOptions + // The Amazon Resource Name (ARN) of the work team for which you want to see + // labeling jobs for. + // + // This member is required. + WorkteamArn *string + + // A filter that returns only labeling jobs created after the specified time + // (timestamp). + CreationTimeAfter *time.Time + + // A filter that returns only labeling jobs created before the specified time + // (timestamp). + CreationTimeBefore *time.Time // A filter the limits jobs to only the ones whose job reference code contains the // specified string. JobReferenceCodeContains *string + // The maximum number of labeling jobs to return in each page of the response. + MaxResults *int32 + // If the result of the previous ListLabelingJobsForWorkteam request was truncated, // the response includes a NextToken. To retrieve the next set of labeling jobs, // use the token in the next request. NextToken *string - // The maximum number of labeling jobs to return in each page of the response. - MaxResults *int32 - - // A filter that returns only labeling jobs created before the specified time - // (timestamp). - CreationTimeBefore *time.Time + // The field to sort results by. The default is CreationTime. + SortBy types.ListLabelingJobsForWorkteamSortByOptions // The sort order for results. The default is Ascending. SortOrder types.SortOrder - - // A filter that returns only labeling jobs created after the specified time - // (timestamp). - CreationTimeAfter *time.Time - - // The Amazon Resource Name (ARN) of the work team for which you want to see - // labeling jobs for. - // - // This member is required. - WorkteamArn *string } type ListLabelingJobsForWorkteamOutput struct { diff --git a/service/sagemaker/api_op_ListModelPackages.go b/service/sagemaker/api_op_ListModelPackages.go index 1617f7785a2..433a1f21fdb 100644 --- a/service/sagemaker/api_op_ListModelPackages.go +++ b/service/sagemaker/api_op_ListModelPackages.go @@ -57,15 +57,6 @@ func (c *Client) ListModelPackages(ctx context.Context, params *ListModelPackage type ListModelPackagesInput struct { - // The maximum number of model packages to return in the response. - MaxResults *int32 - - // The sort order for the results. The default is Ascending. - SortOrder types.SortOrder - - // The parameter by which to sort the results. The default is CreationTime. - SortBy types.ModelPackageSortBy - // A filter that returns only model packages created after the specified time // (timestamp). CreationTimeAfter *time.Time @@ -74,14 +65,23 @@ type ListModelPackagesInput struct { // (timestamp). CreationTimeBefore *time.Time + // The maximum number of model packages to return in the response. + MaxResults *int32 + + // A string in the model package name. This filter returns only model packages + // whose name contains the specified string. + NameContains *string + // If the response to a previous ListModelPackages request was truncated, the // response includes a NextToken. To retrieve the next set of model packages, use // the token in the next request. NextToken *string - // A string in the model package name. This filter returns only model packages - // whose name contains the specified string. - NameContains *string + // The parameter by which to sort the results. The default is CreationTime. + SortBy types.ModelPackageSortBy + + // The sort order for the results. The default is Ascending. + SortOrder types.SortOrder } type ListModelPackagesOutput struct { diff --git a/service/sagemaker/api_op_ListModels.go b/service/sagemaker/api_op_ListModels.go index 8010447c609..be020538f98 100644 --- a/service/sagemaker/api_op_ListModels.go +++ b/service/sagemaker/api_op_ListModels.go @@ -61,21 +61,21 @@ type ListModelsInput struct { // the specified time (timestamp). CreationTimeAfter *time.Time - // If the response to a previous ListModels request was truncated, the response - // includes a NextToken. To retrieve the next set of models, use the token in the - // next request. - NextToken *string - - // A string in the training job name. This filter returns only models in the - // training job whose name contains the specified string. - NameContains *string - // A filter that returns only models created before the specified time (timestamp). CreationTimeBefore *time.Time // The maximum number of models to return in the response. MaxResults *int32 + // A string in the training job name. This filter returns only models in the + // training job whose name contains the specified string. + NameContains *string + + // If the response to a previous ListModels request was truncated, the response + // includes a NextToken. To retrieve the next set of models, use the token in the + // next request. + NextToken *string + // Sorts the list of results. The default is CreationTime. SortBy types.ModelSortKey @@ -85,15 +85,15 @@ type ListModelsInput struct { type ListModelsOutput struct { - // If the response is truncated, Amazon SageMaker returns this token. To retrieve - // the next set of models, use it in the subsequent request. - NextToken *string - // An array of ModelSummary objects, each of which lists a model. // // This member is required. Models []*types.ModelSummary + // If the response is truncated, Amazon SageMaker returns this token. To retrieve + // the next set of models, use it in the subsequent request. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_ListMonitoringExecutions.go b/service/sagemaker/api_op_ListMonitoringExecutions.go index 09db8b22ed4..cf2b635adc4 100644 --- a/service/sagemaker/api_op_ListMonitoringExecutions.go +++ b/service/sagemaker/api_op_ListMonitoringExecutions.go @@ -57,47 +57,47 @@ func (c *Client) ListMonitoringExecutions(ctx context.Context, params *ListMonit type ListMonitoringExecutionsInput struct { - // Whether to sort the results in Ascending or Descending order. The default is - // Descending. - SortOrder types.SortOrder + // A filter that returns only jobs created after a specified time. + CreationTimeAfter *time.Time - // A filter that returns only jobs modified after a specified time. - LastModifiedTimeBefore *time.Time + // A filter that returns only jobs created before a specified time. + CreationTimeBefore *time.Time + + // Name of a specific endpoint to fetch jobs for. + EndpointName *string // A filter that returns only jobs modified before a specified time. LastModifiedTimeAfter *time.Time - // Filter for jobs scheduled after a specified time. - ScheduledTimeAfter *time.Time + // A filter that returns only jobs modified after a specified time. + LastModifiedTimeBefore *time.Time // The maximum number of jobs to return in the response. The default value is 10. MaxResults *int32 - // Filter for jobs scheduled before a specified time. - ScheduledTimeBefore *time.Time - - // Whether to sort results by Status, CreationTime, ScheduledTime field. The - // default is CreationTime. - SortBy types.MonitoringExecutionSortKey + // Name of a specific schedule to fetch jobs for. + MonitoringScheduleName *string // The token returned if the response is truncated. To retrieve the next set of job // executions, use it in the next request. NextToken *string - // Name of a specific endpoint to fetch jobs for. - EndpointName *string + // Filter for jobs scheduled after a specified time. + ScheduledTimeAfter *time.Time - // Name of a specific schedule to fetch jobs for. - MonitoringScheduleName *string + // Filter for jobs scheduled before a specified time. + ScheduledTimeBefore *time.Time - // A filter that returns only jobs created before a specified time. - CreationTimeBefore *time.Time + // Whether to sort results by Status, CreationTime, ScheduledTime field. The + // default is CreationTime. + SortBy types.MonitoringExecutionSortKey + + // Whether to sort the results in Ascending or Descending order. The default is + // Descending. + SortOrder types.SortOrder // A filter that retrieves only jobs with a specific status. StatusEquals types.ExecutionStatus - - // A filter that returns only jobs created after a specified time. - CreationTimeAfter *time.Time } type ListMonitoringExecutionsOutput struct { diff --git a/service/sagemaker/api_op_ListMonitoringSchedules.go b/service/sagemaker/api_op_ListMonitoringSchedules.go index 2abd59c16d0..99e761d8da0 100644 --- a/service/sagemaker/api_op_ListMonitoringSchedules.go +++ b/service/sagemaker/api_op_ListMonitoringSchedules.go @@ -57,43 +57,43 @@ func (c *Client) ListMonitoringSchedules(ctx context.Context, params *ListMonito type ListMonitoringSchedulesInput struct { - // The maximum number of jobs to return in the response. The default value is 10. - MaxResults *int32 + // A filter that returns only monitoring schedules created after a specified time. + CreationTimeAfter *time.Time - // A filter that returns only monitoring schedules modified after a specified time. - LastModifiedTimeAfter *time.Time + // A filter that returns only monitoring schedules created before a specified time. + CreationTimeBefore *time.Time // Name of a specific endpoint to fetch schedules for. EndpointName *string - // Whether to sort results by Status, CreationTime, ScheduledTime field. The - // default is CreationTime. - SortBy types.MonitoringScheduleSortKey + // A filter that returns only monitoring schedules modified after a specified time. + LastModifiedTimeAfter *time.Time - // Whether to sort the results in Ascending or Descending order. The default is - // Descending. - SortOrder types.SortOrder + // A filter that returns only monitoring schedules modified before a specified + // time. + LastModifiedTimeBefore *time.Time + + // The maximum number of jobs to return in the response. The default value is 10. + MaxResults *int32 + + // Filter for monitoring schedules whose name contains a specified string. + NameContains *string // The token returned if the response is truncated. To retrieve the next set of job // executions, use it in the next request. NextToken *string - // A filter that returns only monitoring schedules created after a specified time. - CreationTimeAfter *time.Time - - // Filter for monitoring schedules whose name contains a specified string. - NameContains *string + // Whether to sort results by Status, CreationTime, ScheduledTime field. The + // default is CreationTime. + SortBy types.MonitoringScheduleSortKey - // A filter that returns only monitoring schedules created before a specified time. - CreationTimeBefore *time.Time + // Whether to sort the results in Ascending or Descending order. The default is + // Descending. + SortOrder types.SortOrder // A filter that returns only monitoring schedules modified before a specified // time. StatusEquals types.ScheduleStatus - - // A filter that returns only monitoring schedules modified before a specified - // time. - LastModifiedTimeBefore *time.Time } type ListMonitoringSchedulesOutput struct { diff --git a/service/sagemaker/api_op_ListNotebookInstanceLifecycleConfigs.go b/service/sagemaker/api_op_ListNotebookInstanceLifecycleConfigs.go index 113ae973eac..4d0a544df9c 100644 --- a/service/sagemaker/api_op_ListNotebookInstanceLifecycleConfigs.go +++ b/service/sagemaker/api_op_ListNotebookInstanceLifecycleConfigs.go @@ -58,34 +58,34 @@ func (c *Client) ListNotebookInstanceLifecycleConfigs(ctx context.Context, param type ListNotebookInstanceLifecycleConfigsInput struct { - // The maximum number of lifecycle configurations to return in the response. - MaxResults *int32 - - // A filter that returns only lifecycle configurations that were modified after the + // A filter that returns only lifecycle configurations that were created after the // specified time (timestamp). - LastModifiedTimeAfter *time.Time + CreationTimeAfter *time.Time // A filter that returns only lifecycle configurations that were created before the // specified time (timestamp). CreationTimeBefore *time.Time + // A filter that returns only lifecycle configurations that were modified after the + // specified time (timestamp). + LastModifiedTimeAfter *time.Time + // A filter that returns only lifecycle configurations that were modified before // the specified time (timestamp). LastModifiedTimeBefore *time.Time - // If the result of a ListNotebookInstanceLifecycleConfigs request was truncated, - // the response includes a NextToken. To get the next set of lifecycle - // configurations, use the token in the next request. - NextToken *string - - // A filter that returns only lifecycle configurations that were created after the - // specified time (timestamp). - CreationTimeAfter *time.Time + // The maximum number of lifecycle configurations to return in the response. + MaxResults *int32 // A string in the lifecycle configuration name. This filter returns only lifecycle // configurations whose name contains the specified string. NameContains *string + // If the result of a ListNotebookInstanceLifecycleConfigs request was truncated, + // the response includes a NextToken. To get the next set of lifecycle + // configurations, use the token in the next request. + NextToken *string + // Sorts the list of results. The default is CreationTime. SortBy types.NotebookInstanceLifecycleConfigSortKey @@ -95,14 +95,14 @@ type ListNotebookInstanceLifecycleConfigsInput struct { type ListNotebookInstanceLifecycleConfigsOutput struct { - // An array of NotebookInstanceLifecycleConfiguration objects, each listing a - // lifecycle configuration. - NotebookInstanceLifecycleConfigs []*types.NotebookInstanceLifecycleConfigSummary - // If the response is truncated, Amazon SageMaker returns this token. To get the // next set of lifecycle configurations, use it in the next request. NextToken *string + // An array of NotebookInstanceLifecycleConfiguration objects, each listing a + // lifecycle configuration. + NotebookInstanceLifecycleConfigs []*types.NotebookInstanceLifecycleConfigSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_ListNotebookInstances.go b/service/sagemaker/api_op_ListNotebookInstances.go index e4730f5408d..7b9e2c28a18 100644 --- a/service/sagemaker/api_op_ListNotebookInstances.go +++ b/service/sagemaker/api_op_ListNotebookInstances.go @@ -58,15 +58,37 @@ func (c *Client) ListNotebookInstances(ctx context.Context, params *ListNotebook type ListNotebookInstancesInput struct { + // A filter that returns only notebook instances with associated with the specified + // git repository. + AdditionalCodeRepositoryEquals *string + + // A filter that returns only notebook instances that were created after the + // specified time (timestamp). + CreationTimeAfter *time.Time + + // A filter that returns only notebook instances that were created before the + // specified time (timestamp). + CreationTimeBefore *time.Time + + // A string in the name or URL of a Git repository associated with this notebook + // instance. This filter returns only notebook instances associated with a git + // repository with a name that contains the specified string. + DefaultCodeRepositoryContains *string + + // A filter that returns only notebook instances that were modified after the + // specified time (timestamp). + LastModifiedTimeAfter *time.Time + // A filter that returns only notebook instances that were modified before the // specified time (timestamp). LastModifiedTimeBefore *time.Time - // A string in the name of a notebook instances lifecycle configuration associated - // with this notebook instance. This filter returns only notebook instances - // associated with a lifecycle configuration with a name that contains the - // specified string. - NotebookInstanceLifecycleConfigNameContains *string + // The maximum number of notebook instances to return. + MaxResults *int32 + + // A string in the notebook instances' name. This filter returns only notebook + // instances whose name contains the specified string. + NameContains *string // If the previous call to the ListNotebookInstances is truncated, the response // includes a NextToken. You can use this token in your subsequent @@ -76,42 +98,20 @@ type ListNotebookInstancesInput struct { // request. NextToken *string + // A string in the name of a notebook instances lifecycle configuration associated + // with this notebook instance. This filter returns only notebook instances + // associated with a lifecycle configuration with a name that contains the + // specified string. + NotebookInstanceLifecycleConfigNameContains *string + // The field to sort results by. The default is Name. SortBy types.NotebookInstanceSortKey // The sort order for results. SortOrder types.NotebookInstanceSortOrder - // A filter that returns only notebook instances that were modified after the - // specified time (timestamp). - LastModifiedTimeAfter *time.Time - - // The maximum number of notebook instances to return. - MaxResults *int32 - - // A filter that returns only notebook instances that were created before the - // specified time (timestamp). - CreationTimeBefore *time.Time - - // A string in the name or URL of a Git repository associated with this notebook - // instance. This filter returns only notebook instances associated with a git - // repository with a name that contains the specified string. - DefaultCodeRepositoryContains *string - // A filter that returns only notebook instances with the specified status. StatusEquals types.NotebookInstanceStatus - - // A filter that returns only notebook instances that were created after the - // specified time (timestamp). - CreationTimeAfter *time.Time - - // A string in the notebook instances' name. This filter returns only notebook - // instances whose name contains the specified string. - NameContains *string - - // A filter that returns only notebook instances with associated with the specified - // git repository. - AdditionalCodeRepositoryEquals *string } type ListNotebookInstancesOutput struct { diff --git a/service/sagemaker/api_op_ListProcessingJobs.go b/service/sagemaker/api_op_ListProcessingJobs.go index f9518d3f4d7..f4a54cec11f 100644 --- a/service/sagemaker/api_op_ListProcessingJobs.go +++ b/service/sagemaker/api_op_ListProcessingJobs.go @@ -57,51 +57,51 @@ func (c *Client) ListProcessingJobs(ctx context.Context, params *ListProcessingJ type ListProcessingJobsInput struct { - // The field to sort results by. The default is CreationTime. - SortBy types.SortBy + // A filter that returns only processing jobs created after the specified time. + CreationTimeAfter *time.Time // A filter that returns only processing jobs created after the specified time. CreationTimeBefore *time.Time - // A filter that returns only processing jobs created after the specified time. - CreationTimeAfter *time.Time + // A filter that returns only processing jobs modified after the specified time. + LastModifiedTimeAfter *time.Time // A filter that returns only processing jobs modified before the specified time. LastModifiedTimeBefore *time.Time - // A filter that retrieves only processing jobs with a specific status. - StatusEquals types.ProcessingJobStatus + // The maximum number of processing jobs to return in the response. + MaxResults *int32 - // The sort order for results. The default is Ascending. - SortOrder types.SortOrder + // A string in the processing job name. This filter returns only processing jobs + // whose name contains the specified string. + NameContains *string // If the result of the previous ListProcessingJobs request was truncated, the // response includes a NextToken. To retrieve the next set of processing jobs, use // the token in the next request. NextToken *string - // The maximum number of processing jobs to return in the response. - MaxResults *int32 + // The field to sort results by. The default is CreationTime. + SortBy types.SortBy - // A filter that returns only processing jobs modified after the specified time. - LastModifiedTimeAfter *time.Time + // The sort order for results. The default is Ascending. + SortOrder types.SortOrder - // A string in the processing job name. This filter returns only processing jobs - // whose name contains the specified string. - NameContains *string + // A filter that retrieves only processing jobs with a specific status. + StatusEquals types.ProcessingJobStatus } type ListProcessingJobsOutput struct { - // If the response is truncated, Amazon SageMaker returns this token. To retrieve - // the next set of processing jobs, use it in the subsequent request. - NextToken *string - // An array of ProcessingJobSummary objects, each listing a processing job. // // This member is required. ProcessingJobSummaries []*types.ProcessingJobSummary + // If the response is truncated, Amazon SageMaker returns this token. To retrieve + // the next set of processing jobs, use it in the subsequent request. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_ListSubscribedWorkteams.go b/service/sagemaker/api_op_ListSubscribedWorkteams.go index 2e186c41bac..89d7e40e4a0 100644 --- a/service/sagemaker/api_op_ListSubscribedWorkteams.go +++ b/service/sagemaker/api_op_ListSubscribedWorkteams.go @@ -58,17 +58,17 @@ func (c *Client) ListSubscribedWorkteams(ctx context.Context, params *ListSubscr type ListSubscribedWorkteamsInput struct { - // If the result of the previous ListSubscribedWorkteams request was truncated, the - // response includes a NextToken. To retrieve the next set of labeling jobs, use - // the token in the next request. - NextToken *string + // The maximum number of work teams to return in each page of the response. + MaxResults *int32 // A string in the work team name. This filter returns only work teams whose name // contains the specified string. NameContains *string - // The maximum number of work teams to return in each page of the response. - MaxResults *int32 + // If the result of the previous ListSubscribedWorkteams request was truncated, the + // response includes a NextToken. To retrieve the next set of labeling jobs, use + // the token in the next request. + NextToken *string } type ListSubscribedWorkteamsOutput struct { diff --git a/service/sagemaker/api_op_ListTrainingJobs.go b/service/sagemaker/api_op_ListTrainingJobs.go index a2730b2f44c..83da553b4ef 100644 --- a/service/sagemaker/api_op_ListTrainingJobs.go +++ b/service/sagemaker/api_op_ListTrainingJobs.go @@ -57,12 +57,17 @@ func (c *Client) ListTrainingJobs(ctx context.Context, params *ListTrainingJobsI type ListTrainingJobsInput struct { + // A filter that returns only training jobs created after the specified time + // (timestamp). + CreationTimeAfter *time.Time + // A filter that returns only training jobs created before the specified time // (timestamp). CreationTimeBefore *time.Time - // The field to sort results by. The default is CreationTime. - SortBy types.SortBy + // A filter that returns only training jobs modified after the specified time + // (timestamp). + LastModifiedTimeAfter *time.Time // A filter that returns only training jobs modified before the specified time // (timestamp). @@ -71,41 +76,36 @@ type ListTrainingJobsInput struct { // The maximum number of training jobs to return in the response. MaxResults *int32 - // A filter that returns only training jobs modified after the specified time - // (timestamp). - LastModifiedTimeAfter *time.Time - - // A filter that retrieves only training jobs with a specific status. - StatusEquals types.TrainingJobStatus + // A string in the training job name. This filter returns only training jobs whose + // name contains the specified string. + NameContains *string // If the result of the previous ListTrainingJobs request was truncated, the // response includes a NextToken. To retrieve the next set of training jobs, use // the token in the next request. NextToken *string + // The field to sort results by. The default is CreationTime. + SortBy types.SortBy + // The sort order for results. The default is Ascending. SortOrder types.SortOrder - // A filter that returns only training jobs created after the specified time - // (timestamp). - CreationTimeAfter *time.Time - - // A string in the training job name. This filter returns only training jobs whose - // name contains the specified string. - NameContains *string + // A filter that retrieves only training jobs with a specific status. + StatusEquals types.TrainingJobStatus } type ListTrainingJobsOutput struct { - // If the response is truncated, Amazon SageMaker returns this token. To retrieve - // the next set of training jobs, use it in the subsequent request. - NextToken *string - // An array of TrainingJobSummary objects, each listing a training job. // // This member is required. TrainingJobSummaries []*types.TrainingJobSummary + // If the response is truncated, Amazon SageMaker returns this token. To retrieve + // the next set of training jobs, use it in the subsequent request. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_ListTrainingJobsForHyperParameterTuningJob.go b/service/sagemaker/api_op_ListTrainingJobsForHyperParameterTuningJob.go index 907c10cced2..e0f73f89aad 100644 --- a/service/sagemaker/api_op_ListTrainingJobsForHyperParameterTuningJob.go +++ b/service/sagemaker/api_op_ListTrainingJobsForHyperParameterTuningJob.go @@ -58,10 +58,10 @@ func (c *Client) ListTrainingJobsForHyperParameterTuningJob(ctx context.Context, type ListTrainingJobsForHyperParameterTuningJobInput struct { - // The field to sort results by. The default is Name. If the value of this field is - // FinalObjectiveMetricValue, any training jobs that did not return an objective - // metric are not listed. - SortBy types.TrainingJobSortByOptions + // The name of the tuning job whose training jobs you want to list. + // + // This member is required. + HyperParameterTuningJobName *string // The maximum number of training jobs to return. The default value is 10. MaxResults *int32 @@ -71,14 +71,14 @@ type ListTrainingJobsForHyperParameterTuningJobInput struct { // training jobs, use the token in the next request. NextToken *string + // The field to sort results by. The default is Name. If the value of this field is + // FinalObjectiveMetricValue, any training jobs that did not return an objective + // metric are not listed. + SortBy types.TrainingJobSortByOptions + // The sort order for results. The default is Ascending. SortOrder types.SortOrder - // The name of the tuning job whose training jobs you want to list. - // - // This member is required. - HyperParameterTuningJobName *string - // A filter that returns only training jobs with the specified status. StatusEquals types.TrainingJobStatus } diff --git a/service/sagemaker/api_op_ListTransformJobs.go b/service/sagemaker/api_op_ListTransformJobs.go index b5a3d3a6ef7..4b995a4380d 100644 --- a/service/sagemaker/api_op_ListTransformJobs.go +++ b/service/sagemaker/api_op_ListTransformJobs.go @@ -57,52 +57,52 @@ func (c *Client) ListTransformJobs(ctx context.Context, params *ListTransformJob type ListTransformJobsInput struct { - // A filter that retrieves only transform jobs with a specific status. - StatusEquals types.TransformJobStatus + // A filter that returns only transform jobs created after the specified time. + CreationTimeAfter *time.Time + + // A filter that returns only transform jobs created before the specified time. + CreationTimeBefore *time.Time // A filter that returns only transform jobs modified after the specified time. LastModifiedTimeAfter *time.Time - // The sort order for results. The default is Descending. - SortOrder types.SortOrder + // A filter that returns only transform jobs modified before the specified time. + LastModifiedTimeBefore *time.Time + + // The maximum number of transform jobs to return in the response. The default + // value is 10. + MaxResults *int32 + + // A string in the transform job name. This filter returns only transform jobs + // whose name contains the specified string. + NameContains *string // If the result of the previous ListTransformJobs request was truncated, the // response includes a NextToken. To retrieve the next set of transform jobs, use // the token in the next request. NextToken *string - // The maximum number of transform jobs to return in the response. The default - // value is 10. - MaxResults *int32 - // The field to sort results by. The default is CreationTime. SortBy types.SortBy - // A filter that returns only transform jobs modified before the specified time. - LastModifiedTimeBefore *time.Time - - // A filter that returns only transform jobs created before the specified time. - CreationTimeBefore *time.Time - - // A filter that returns only transform jobs created after the specified time. - CreationTimeAfter *time.Time + // The sort order for results. The default is Descending. + SortOrder types.SortOrder - // A string in the transform job name. This filter returns only transform jobs - // whose name contains the specified string. - NameContains *string + // A filter that retrieves only transform jobs with a specific status. + StatusEquals types.TransformJobStatus } type ListTransformJobsOutput struct { - // If the response is truncated, Amazon SageMaker returns this token. To retrieve - // the next set of transform jobs, use it in the next request. - NextToken *string - // An array of TransformJobSummary objects. // // This member is required. TransformJobSummaries []*types.TransformJobSummary + // If the response is truncated, Amazon SageMaker returns this token. To retrieve + // the next set of transform jobs, use it in the next request. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_ListTrialComponents.go b/service/sagemaker/api_op_ListTrialComponents.go index e1c03d3e606..82ca21a3b2d 100644 --- a/service/sagemaker/api_op_ListTrialComponents.go +++ b/service/sagemaker/api_op_ListTrialComponents.go @@ -66,38 +66,38 @@ func (c *Client) ListTrialComponents(ctx context.Context, params *ListTrialCompo type ListTrialComponentsInput struct { - // If the previous call to ListTrialComponents didn't return the full set of - // components, the call returns a token for getting the next set of components. - NextToken *string + // A filter that returns only components created after the specified time. + CreatedAfter *time.Time // A filter that returns only components created before the specified time. CreatedBefore *time.Time - // A filter that returns only components that have the specified source Amazon - // Resource Name (ARN). If you specify SourceArn, you can't filter by - // ExperimentName or TrialName. - SourceArn *string - - // The maximum number of components to return in the response. The default value is - // 10. - MaxResults *int32 - // A filter that returns only components that are part of the specified experiment. // If you specify ExperimentName, you can't filter by SourceArn or TrialName. ExperimentName *string - // A filter that returns only components that are part of the specified trial. If - // you specify TrialName, you can't filter by ExperimentName or SourceArn. - TrialName *string + // The maximum number of components to return in the response. The default value is + // 10. + MaxResults *int32 - // A filter that returns only components created after the specified time. - CreatedAfter *time.Time + // If the previous call to ListTrialComponents didn't return the full set of + // components, the call returns a token for getting the next set of components. + NextToken *string // The property used to sort results. The default value is CreationTime. SortBy types.SortTrialComponentsBy // The sort order. The default value is Descending. SortOrder types.SortOrder + + // A filter that returns only components that have the specified source Amazon + // Resource Name (ARN). If you specify SourceArn, you can't filter by + // ExperimentName or TrialName. + SourceArn *string + + // A filter that returns only components that are part of the specified trial. If + // you specify TrialName, you can't filter by ExperimentName or SourceArn. + TrialName *string } type ListTrialComponentsOutput struct { diff --git a/service/sagemaker/api_op_ListTrials.go b/service/sagemaker/api_op_ListTrials.go index 0009d0e95ed..10f1df46996 100644 --- a/service/sagemaker/api_op_ListTrials.go +++ b/service/sagemaker/api_op_ListTrials.go @@ -61,31 +61,31 @@ func (c *Client) ListTrials(ctx context.Context, params *ListTrialsInput, optFns type ListTrialsInput struct { + // A filter that returns only trials created after the specified time. + CreatedAfter *time.Time + + // A filter that returns only trials created before the specified time. + CreatedBefore *time.Time + // A filter that returns only trials that are part of the specified experiment. ExperimentName *string + // The maximum number of trials to return in the response. The default value is 10. + MaxResults *int32 + // If the previous call to ListTrials didn't return the full set of trials, the // call returns a token for getting the next set of trials. NextToken *string - // The maximum number of trials to return in the response. The default value is 10. - MaxResults *int32 - // The property used to sort results. The default value is CreationTime. SortBy types.SortTrialsBy // The sort order. The default value is Descending. SortOrder types.SortOrder - // A filter that returns only trials created after the specified time. - CreatedAfter *time.Time - // A filter that returns only trials that are associated with the specified trial // component. TrialComponentName *string - - // A filter that returns only trials created before the specified time. - CreatedBefore *time.Time } type ListTrialsOutput struct { diff --git a/service/sagemaker/api_op_ListUserProfiles.go b/service/sagemaker/api_op_ListUserProfiles.go index 37bd84c1e84..f5d624e85f0 100644 --- a/service/sagemaker/api_op_ListUserProfiles.go +++ b/service/sagemaker/api_op_ListUserProfiles.go @@ -56,11 +56,11 @@ func (c *Client) ListUserProfiles(ctx context.Context, params *ListUserProfilesI type ListUserProfilesInput struct { - // The sort order for the results. The default is Ascending. - SortOrder types.SortOrder - // A parameter by which to filter the results. - UserProfileNameContains *string + DomainIdEquals *string + + // Returns a list up to a specified limit. + MaxResults *int32 // If the previous response was truncated, you will receive this token. Use it in // your next request to receive the next set of results. @@ -69,22 +69,22 @@ type ListUserProfilesInput struct { // The parameter by which to sort the results. The default is CreationTime. SortBy types.UserProfileSortKey - // A parameter by which to filter the results. - DomainIdEquals *string + // The sort order for the results. The default is Ascending. + SortOrder types.SortOrder - // Returns a list up to a specified limit. - MaxResults *int32 + // A parameter by which to filter the results. + UserProfileNameContains *string } type ListUserProfilesOutput struct { - // The list of user profiles. - UserProfiles []*types.UserProfileDetails - // If the previous response was truncated, you will receive this token. Use it in // your next request to receive the next set of results. NextToken *string + // The list of user profiles. + UserProfiles []*types.UserProfileDetails + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_ListWorkforces.go b/service/sagemaker/api_op_ListWorkforces.go index cc8248483f2..65fb60456b1 100644 --- a/service/sagemaker/api_op_ListWorkforces.go +++ b/service/sagemaker/api_op_ListWorkforces.go @@ -57,6 +57,12 @@ func (c *Client) ListWorkforces(ctx context.Context, params *ListWorkforcesInput type ListWorkforcesInput struct { + // The maximum number of workforces returned in the response. + MaxResults *int32 + + // A filter you can use to search for workforces using part of the workforce name. + NameContains *string + // A token to resume pagination. NextToken *string @@ -65,24 +71,18 @@ type ListWorkforcesInput struct { // Sort workforces in ascending or descending order. SortOrder types.SortOrder - - // The maximum number of workforces returned in the response. - MaxResults *int32 - - // A filter you can use to search for workforces using part of the workforce name. - NameContains *string } type ListWorkforcesOutput struct { - // A token to resume pagination. - NextToken *string - // A list containing information about your workforce. // // This member is required. Workforces []*types.Workforce + // A token to resume pagination. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_ListWorkteams.go b/service/sagemaker/api_op_ListWorkteams.go index d60d95a96d0..7570d21b966 100644 --- a/service/sagemaker/api_op_ListWorkteams.go +++ b/service/sagemaker/api_op_ListWorkteams.go @@ -58,23 +58,23 @@ func (c *Client) ListWorkteams(ctx context.Context, params *ListWorkteamsInput, type ListWorkteamsInput struct { + // The maximum number of work teams to return in each page of the response. + MaxResults *int32 + + // A string in the work team's name. This filter returns only work teams whose name + // contains the specified string. + NameContains *string + // If the result of the previous ListWorkteams request was truncated, the response // includes a NextToken. To retrieve the next set of labeling jobs, use the token // in the next request. NextToken *string - // The maximum number of work teams to return in each page of the response. - MaxResults *int32 - // The field to sort results by. The default is CreationTime. SortBy types.ListWorkteamsSortByOptions // The sort order for results. The default is Ascending. SortOrder types.SortOrder - - // A string in the work team's name. This filter returns only work teams whose name - // contains the specified string. - NameContains *string } type ListWorkteamsOutput struct { diff --git a/service/sagemaker/api_op_RenderUiTemplate.go b/service/sagemaker/api_op_RenderUiTemplate.go index 69125a0e367..64bf08720d4 100644 --- a/service/sagemaker/api_op_RenderUiTemplate.go +++ b/service/sagemaker/api_op_RenderUiTemplate.go @@ -57,39 +57,39 @@ func (c *Client) RenderUiTemplate(ctx context.Context, params *RenderUiTemplateI type RenderUiTemplateInput struct { - // A Template object containing the worker UI template to render. - UiTemplate *types.UiTemplate - - // The HumanTaskUiArn of the worker UI that you want to render. Do not provide a - // HumanTaskUiArn if you use the UiTemplate parameter. See a list of available - // Human Ui Amazon Resource Names (ARNs) in UiConfig (). - HumanTaskUiArn *string + // The Amazon Resource Name (ARN) that has access to the S3 objects that are used + // by the template. + // + // This member is required. + RoleArn *string // A RenderableTask object containing a representative task to render. // // This member is required. Task *types.RenderableTask - // The Amazon Resource Name (ARN) that has access to the S3 objects that are used - // by the template. - // - // This member is required. - RoleArn *string + // The HumanTaskUiArn of the worker UI that you want to render. Do not provide a + // HumanTaskUiArn if you use the UiTemplate parameter. See a list of available + // Human Ui Amazon Resource Names (ARNs) in UiConfig (). + HumanTaskUiArn *string + + // A Template object containing the worker UI template to render. + UiTemplate *types.UiTemplate } type RenderUiTemplateOutput struct { - // A Liquid template that renders the HTML for the worker UI. - // - // This member is required. - RenderedContent *string - // A list of one or more RenderingError objects if any were encountered while // rendering the template. If there were no errors, the list is empty. // // This member is required. Errors []*types.RenderingError + // A Liquid template that renders the HTML for the worker UI. + // + // This member is required. + RenderedContent *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_Search.go b/service/sagemaker/api_op_Search.go index ba3bd731181..041b0c6c62b 100644 --- a/service/sagemaker/api_op_Search.go +++ b/service/sagemaker/api_op_Search.go @@ -66,9 +66,13 @@ type SearchInput struct { // This member is required. Resource types.ResourceType - // How SearchResults are ordered. Valid values are Ascending or Descending. The - // default is Descending. - SortOrder types.SearchSortOrder + // The maximum number of results to return. + MaxResults *int32 + + // If more than MaxResults resources match the specified SearchExpression, the + // response includes a NextToken. The NextToken can be passed to the next + // SearchRequest to continue retrieving results. + NextToken *string // A Boolean conditional statement. Resources must satisfy this condition to be // included in search results. You must provide at least one subexpression, filter, @@ -80,25 +84,21 @@ type SearchInput struct { // LastModifiedTime. SortBy *string - // If more than MaxResults resources match the specified SearchExpression, the - // response includes a NextToken. The NextToken can be passed to the next - // SearchRequest to continue retrieving results. - NextToken *string - - // The maximum number of results to return. - MaxResults *int32 + // How SearchResults are ordered. Valid values are Ascending or Descending. The + // default is Descending. + SortOrder types.SearchSortOrder } type SearchOutput struct { - // A list of SearchRecord objects. - Results []*types.SearchRecord - // If the result of the previous Search request was truncated, the response // includes a NextToken. To retrieve the next set of results, use the token in the // next request. NextToken *string + // A list of SearchRecord objects. + Results []*types.SearchRecord + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemaker/api_op_UpdateEndpoint.go b/service/sagemaker/api_op_UpdateEndpoint.go index 3ccf8bd7edd..642d3d315ff 100644 --- a/service/sagemaker/api_op_UpdateEndpoint.go +++ b/service/sagemaker/api_op_UpdateEndpoint.go @@ -74,13 +74,10 @@ type UpdateEndpointInput struct { // This member is required. EndpointConfigName *string - // When updating endpoint resources, enables or disables the retention of variant - // properties, such as the instance count or the variant weight. To retain the - // variant properties of an endpoint when updating it, set - // RetainAllVariantProperties to true. To use the variant properties specified in a - // new EndpointConfig call when updating an endpoint, set - // RetainAllVariantProperties to false. - RetainAllVariantProperties *bool + // The name of the endpoint whose configuration you want to update. + // + // This member is required. + EndpointName *string // When you are updating endpoint resources with // UpdateEndpointInput$RetainAllVariantProperties (), whose value is set to true, @@ -89,10 +86,13 @@ type UpdateEndpointInput struct { // value for ExcludeAllVariantProperties, no variant properties are overridden. ExcludeRetainedVariantProperties []*types.VariantProperty - // The name of the endpoint whose configuration you want to update. - // - // This member is required. - EndpointName *string + // When updating endpoint resources, enables or disables the retention of variant + // properties, such as the instance count or the variant weight. To retain the + // variant properties of an endpoint when updating it, set + // RetainAllVariantProperties to true. To use the variant properties specified in a + // new EndpointConfig call when updating an endpoint, set + // RetainAllVariantProperties to false. + RetainAllVariantProperties *bool } type UpdateEndpointOutput struct { diff --git a/service/sagemaker/api_op_UpdateEndpointWeightsAndCapacities.go b/service/sagemaker/api_op_UpdateEndpointWeightsAndCapacities.go index 10ee66cfbea..3404f54ae9a 100644 --- a/service/sagemaker/api_op_UpdateEndpointWeightsAndCapacities.go +++ b/service/sagemaker/api_op_UpdateEndpointWeightsAndCapacities.go @@ -61,15 +61,15 @@ func (c *Client) UpdateEndpointWeightsAndCapacities(ctx context.Context, params type UpdateEndpointWeightsAndCapacitiesInput struct { - // The name of an existing Amazon SageMaker endpoint. + // An object that provides new capacity and weight values for a variant. // // This member is required. - EndpointName *string + DesiredWeightsAndCapacities []*types.DesiredWeightAndCapacity - // An object that provides new capacity and weight values for a variant. + // The name of an existing Amazon SageMaker endpoint. // // This member is required. - DesiredWeightsAndCapacities []*types.DesiredWeightAndCapacity + EndpointName *string } type UpdateEndpointWeightsAndCapacitiesOutput struct { diff --git a/service/sagemaker/api_op_UpdateExperiment.go b/service/sagemaker/api_op_UpdateExperiment.go index 8ba141c449f..1b522dc453c 100644 --- a/service/sagemaker/api_op_UpdateExperiment.go +++ b/service/sagemaker/api_op_UpdateExperiment.go @@ -57,14 +57,14 @@ func (c *Client) UpdateExperiment(ctx context.Context, params *UpdateExperimentI type UpdateExperimentInput struct { - // The description of the experiment. - Description *string - // The name of the experiment to update. // // This member is required. ExperimentName *string + // The description of the experiment. + Description *string + // The name of the experiment as displayed. The name doesn't need to be unique. If // DisplayName isn't specified, ExperimentName is displayed. DisplayName *string diff --git a/service/sagemaker/api_op_UpdateMonitoringSchedule.go b/service/sagemaker/api_op_UpdateMonitoringSchedule.go index 60dab4c26b8..c0764558395 100644 --- a/service/sagemaker/api_op_UpdateMonitoringSchedule.go +++ b/service/sagemaker/api_op_UpdateMonitoringSchedule.go @@ -57,17 +57,17 @@ func (c *Client) UpdateMonitoringSchedule(ctx context.Context, params *UpdateMon type UpdateMonitoringScheduleInput struct { - // The name of the monitoring schedule. The name must be unique within an AWS - // Region within an AWS account. - // - // This member is required. - MonitoringScheduleName *string - // The configuration object that specifies the monitoring schedule and defines the // monitoring job. // // This member is required. MonitoringScheduleConfig *types.MonitoringScheduleConfig + + // The name of the monitoring schedule. The name must be unique within an AWS + // Region within an AWS account. + // + // This member is required. + MonitoringScheduleName *string } type UpdateMonitoringScheduleOutput struct { diff --git a/service/sagemaker/api_op_UpdateNotebookInstance.go b/service/sagemaker/api_op_UpdateNotebookInstance.go index 9913dad1317..87222615300 100644 --- a/service/sagemaker/api_op_UpdateNotebookInstance.go +++ b/service/sagemaker/api_op_UpdateNotebookInstance.go @@ -59,32 +59,26 @@ func (c *Client) UpdateNotebookInstance(ctx context.Context, params *UpdateNoteb type UpdateNotebookInstanceInput struct { - // A list of the Elastic Inference (EI) instance types to remove from this notebook - // instance. This operation is idempotent. If you specify an accelerator type that - // is not associated with the notebook instance when you call this method, it does - // not throw an error. - DisassociateAcceleratorTypes *bool - - // The Amazon ML compute instance type. - InstanceType types.InstanceType - // The name of the notebook instance to update. // // This member is required. NotebookInstanceName *string - // The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume - // to access the notebook instance. For more information, see Amazon SageMaker - // Roles (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html). To - // be able to pass this role to Amazon SageMaker, the caller of this API must have - // the iam:PassRole permission. - RoleArn *string + // A list of the Elastic Inference (EI) instance types to associate with this + // notebook instance. Currently only one EI instance type can be associated with a + // notebook instance. For more information, see Using Elastic Inference in Amazon + // SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html). + AcceleratorTypes []types.NotebookInstanceAcceleratorType - // Set to true to remove the notebook instance lifecycle configuration currently - // associated with the notebook instance. This operation is idempotent. If you - // specify a lifecycle configuration that is not associated with the notebook - // instance when you call this method, it does not throw an error. - DisassociateLifecycleConfig *bool + // An array of up to three Git repositories to associate with the notebook + // instance. These can be either the names of Git repositories stored as resources + // in your account, or the URL of Git repositories in AWS CodeCommit + // (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any + // other Git repository. These repositories are cloned at the same level as the + // default repository of your notebook instance. For more information, see + // Associating Git Repositories with Amazon SageMaker Notebook Instances + // (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). + AdditionalCodeRepositories []*string // The Git repository to associate with the notebook instance as its default code // repository. This can be either the name of a Git repository stored as a resource @@ -96,27 +90,17 @@ type UpdateNotebookInstanceInput struct { // (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). DefaultCodeRepository *string - // An array of up to three Git repositories to associate with the notebook - // instance. These can be either the names of Git repositories stored as resources - // in your account, or the URL of Git repositories in AWS CodeCommit - // (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any - // other Git repository. These repositories are cloned at the same level as the - // default repository of your notebook instance. For more information, see - // Associating Git Repositories with Amazon SageMaker Notebook Instances - // (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). - AdditionalCodeRepositories []*string - - // A list of the Elastic Inference (EI) instance types to associate with this - // notebook instance. Currently only one EI instance type can be associated with a - // notebook instance. For more information, see Using Elastic Inference in Amazon - // SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html). - AcceleratorTypes []types.NotebookInstanceAcceleratorType + // A list of the Elastic Inference (EI) instance types to remove from this notebook + // instance. This operation is idempotent. If you specify an accelerator type that + // is not associated with the notebook instance when you call this method, it does + // not throw an error. + DisassociateAcceleratorTypes *bool - // The name of a lifecycle configuration to associate with the notebook instance. - // For information about lifestyle configurations, see Step 2.1: (Optional) - // Customize a Notebook Instance - // (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html). - LifecycleConfigName *string + // A list of names or URLs of the default Git repositories to remove from this + // notebook instance. This operation is idempotent. If you specify a Git repository + // that is not associated with the notebook instance when you call this method, it + // does not throw an error. + DisassociateAdditionalCodeRepositories *bool // The name or URL of the default Git repository to remove from this notebook // instance. This operation is idempotent. If you specify a Git repository that is @@ -124,11 +108,27 @@ type UpdateNotebookInstanceInput struct { // throw an error. DisassociateDefaultCodeRepository *bool - // A list of names or URLs of the default Git repositories to remove from this - // notebook instance. This operation is idempotent. If you specify a Git repository - // that is not associated with the notebook instance when you call this method, it - // does not throw an error. - DisassociateAdditionalCodeRepositories *bool + // Set to true to remove the notebook instance lifecycle configuration currently + // associated with the notebook instance. This operation is idempotent. If you + // specify a lifecycle configuration that is not associated with the notebook + // instance when you call this method, it does not throw an error. + DisassociateLifecycleConfig *bool + + // The Amazon ML compute instance type. + InstanceType types.InstanceType + + // The name of a lifecycle configuration to associate with the notebook instance. + // For information about lifestyle configurations, see Step 2.1: (Optional) + // Customize a Notebook Instance + // (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html). + LifecycleConfigName *string + + // The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume + // to access the notebook instance. For more information, see Amazon SageMaker + // Roles (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html). To + // be able to pass this role to Amazon SageMaker, the caller of this API must have + // the iam:PassRole permission. + RoleArn *string // Whether root access is enabled or disabled for users of the notebook instance. // The default value is Enabled. If you set this to Disabled, users don't have root diff --git a/service/sagemaker/api_op_UpdateNotebookInstanceLifecycleConfig.go b/service/sagemaker/api_op_UpdateNotebookInstanceLifecycleConfig.go index cfe16d333c9..9863ca8b9b0 100644 --- a/service/sagemaker/api_op_UpdateNotebookInstanceLifecycleConfig.go +++ b/service/sagemaker/api_op_UpdateNotebookInstanceLifecycleConfig.go @@ -58,19 +58,19 @@ func (c *Client) UpdateNotebookInstanceLifecycleConfig(ctx context.Context, para type UpdateNotebookInstanceLifecycleConfigInput struct { - // The shell script that runs every time you start a notebook instance, including - // when you create the notebook instance. The shell script must be a base64-encoded - // string. - OnStart []*types.NotebookInstanceLifecycleHook + // The name of the lifecycle configuration. + // + // This member is required. + NotebookInstanceLifecycleConfigName *string // The shell script that runs only once, when you create a notebook instance. The // shell script must be a base64-encoded string. OnCreate []*types.NotebookInstanceLifecycleHook - // The name of the lifecycle configuration. - // - // This member is required. - NotebookInstanceLifecycleConfigName *string + // The shell script that runs every time you start a notebook instance, including + // when you create the notebook instance. The shell script must be a base64-encoded + // string. + OnStart []*types.NotebookInstanceLifecycleHook } type UpdateNotebookInstanceLifecycleConfigOutput struct { diff --git a/service/sagemaker/api_op_UpdateTrialComponent.go b/service/sagemaker/api_op_UpdateTrialComponent.go index d1f0677dffc..ab3eef089a1 100644 --- a/service/sagemaker/api_op_UpdateTrialComponent.go +++ b/service/sagemaker/api_op_UpdateTrialComponent.go @@ -58,15 +58,17 @@ func (c *Client) UpdateTrialComponent(ctx context.Context, params *UpdateTrialCo type UpdateTrialComponentInput struct { - // Replaces all of the component's hyperparameters with the specified - // hyperparameters. - Parameters map[string]*types.TrialComponentParameterValue + // The name of the component to update. + // + // This member is required. + TrialComponentName *string - // The output artifacts to remove from the component. - OutputArtifactsToRemove []*string + // The name of the component as displayed. The name doesn't need to be unique. If + // DisplayName isn't specified, TrialComponentName is displayed. + DisplayName *string - // The new status of the component. - Status *types.TrialComponentStatus + // When the component ended. + EndTime *time.Time // Replaces all of the component's input artifacts with the specified artifacts. InputArtifacts map[string]*types.TrialComponentArtifact @@ -77,23 +79,21 @@ type UpdateTrialComponentInput struct { // Replaces all of the component's output artifacts with the specified artifacts. OutputArtifacts map[string]*types.TrialComponentArtifact + // The output artifacts to remove from the component. + OutputArtifactsToRemove []*string + + // Replaces all of the component's hyperparameters with the specified + // hyperparameters. + Parameters map[string]*types.TrialComponentParameterValue + // The hyperparameters to remove from the component. ParametersToRemove []*string // When the component started. StartTime *time.Time - // The name of the component to update. - // - // This member is required. - TrialComponentName *string - - // When the component ended. - EndTime *time.Time - - // The name of the component as displayed. The name doesn't need to be unique. If - // DisplayName isn't specified, TrialComponentName is displayed. - DisplayName *string + // The new status of the component. + Status *types.TrialComponentStatus } type UpdateTrialComponentOutput struct { diff --git a/service/sagemaker/api_op_UpdateWorkforce.go b/service/sagemaker/api_op_UpdateWorkforce.go index 962c1299875..c01afa685b3 100644 --- a/service/sagemaker/api_op_UpdateWorkforce.go +++ b/service/sagemaker/api_op_UpdateWorkforce.go @@ -66,10 +66,6 @@ func (c *Client) UpdateWorkforce(ctx context.Context, params *UpdateWorkforceInp type UpdateWorkforceInput struct { - // Use this parameter to update your OIDC Identity Provider (IdP) configuration for - // a workforce made using your own IdP. - OidcConfig *types.OidcConfig - // The name of the private workforce whose access you want to restrict. // WorkforceName is automatically set to default when a workforce is created and // cannot be modified. @@ -77,6 +73,10 @@ type UpdateWorkforceInput struct { // This member is required. WorkforceName *string + // Use this parameter to update your OIDC Identity Provider (IdP) configuration for + // a workforce made using your own IdP. + OidcConfig *types.OidcConfig + // A list of one to ten worker IP address ranges (CIDRs // (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html)) that can be // used to access tasks assigned to this workforce. Maximum: Ten CIDR values diff --git a/service/sagemaker/api_op_UpdateWorkteam.go b/service/sagemaker/api_op_UpdateWorkteam.go index 92a05b519d5..7ecb497b845 100644 --- a/service/sagemaker/api_op_UpdateWorkteam.go +++ b/service/sagemaker/api_op_UpdateWorkteam.go @@ -57,9 +57,6 @@ func (c *Client) UpdateWorkteam(ctx context.Context, params *UpdateWorkteamInput type UpdateWorkteamInput struct { - // A list of MemberDefinition objects that contain the updated work team members. - MemberDefinitions []*types.MemberDefinition - // The name of the work team to update. // // This member is required. @@ -68,6 +65,9 @@ type UpdateWorkteamInput struct { // An updated description for the work team. Description *string + // A list of MemberDefinition objects that contain the updated work team members. + MemberDefinitions []*types.MemberDefinition + // Configures SNS topic notifications for available or expiring work items NotificationConfiguration *types.NotificationConfiguration } diff --git a/service/sagemaker/go.mod b/service/sagemaker/go.mod index 4a00d91bb72..6ebc9c3d4c9 100644 --- a/service/sagemaker/go.mod +++ b/service/sagemaker/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/sagemaker go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/sagemaker/types/types.go b/service/sagemaker/types/types.go index f3a0e85eb4f..437a4bc3e02 100644 --- a/service/sagemaker/types/types.go +++ b/service/sagemaker/types/types.go @@ -35,6 +35,11 @@ type AlgorithmSpecification struct { // This member is required. TrainingInputMode TrainingInputMode + // The name of the algorithm resource to use for the training job. This must be an + // algorithm resource that you created or subscribe to on AWS Marketplace. If you + // specify a value for this parameter, you can't specify a value for TrainingImage. + AlgorithmName *string + // To generate and save time-series metrics during training, set to true. The // default is false and time-series metrics aren't generated except in the // following cases: @@ -57,11 +62,6 @@ type AlgorithmSpecification struct { // * You specify at least one MetricDefinition () EnableSageMakerMetricsTimeSeries *bool - // The name of the algorithm resource to use for the training job. This must be an - // algorithm resource that you created or subscribe to on AWS Marketplace. If you - // specify a value for this parameter, you can't specify a value for TrainingImage. - AlgorithmName *string - // A list of metric definition objects. Each object specifies the metric name and // regular expressions used to parse algorithm logs. Amazon SageMaker publishes // each metric to Amazon CloudWatch. @@ -81,16 +81,21 @@ type AlgorithmSpecification struct { // Specifies the validation and image scan statuses of the algorithm. type AlgorithmStatusDetails struct { - // The status of algorithm validation. - ValidationStatuses []*AlgorithmStatusItem - // The status of the scan of the algorithm's Docker image container. ImageScanStatuses []*AlgorithmStatusItem + + // The status of algorithm validation. + ValidationStatuses []*AlgorithmStatusItem } // Represents the overall status of an algorithm. type AlgorithmStatusItem struct { + // The name of the algorithm for which the overall status is being reported. + // + // This member is required. + Name *string + // The current status. // // This member is required. @@ -98,38 +103,33 @@ type AlgorithmStatusItem struct { // if the overall status is Failed, the reason for the failure. FailureReason *string - - // The name of the algorithm for which the overall status is being reported. - // - // This member is required. - Name *string } // Provides summary information about an algorithm. type AlgorithmSummary struct { - // A timestamp that shows when the algorithm was created. + // The Amazon Resource Name (ARN) of the algorithm. // // This member is required. - CreationTime *time.Time + AlgorithmArn *string - // A brief description of the algorithm. - AlgorithmDescription *string + // The name of the algorithm that is described by the summary. + // + // This member is required. + AlgorithmName *string // The overall status of the algorithm. // // This member is required. AlgorithmStatus AlgorithmStatus - // The Amazon Resource Name (ARN) of the algorithm. + // A timestamp that shows when the algorithm was created. // // This member is required. - AlgorithmArn *string + CreationTime *time.Time - // The name of the algorithm that is described by the summary. - // - // This member is required. - AlgorithmName *string + // A brief description of the algorithm. + AlgorithmDescription *string } // Defines a training job and a batch transform job that Amazon SageMaker runs to @@ -137,18 +137,18 @@ type AlgorithmSummary struct { // available to your buyers on AWS Marketplace. type AlgorithmValidationProfile struct { - // The TrainingJobDefinition object that describes the training job that Amazon - // SageMaker runs to validate your algorithm. - // - // This member is required. - TrainingJobDefinition *TrainingJobDefinition - // The name of the profile for the algorithm. The name must have 1 to 63 // characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen). // // This member is required. ProfileName *string + // The TrainingJobDefinition object that describes the training job that Amazon + // SageMaker runs to validate your algorithm. + // + // This member is required. + TrainingJobDefinition *TrainingJobDefinition + // The TransformJobDefinition object that describes the transform job that Amazon // SageMaker runs to validate your algorithm. TransformJobDefinition *TransformJobDefinition @@ -810,33 +810,33 @@ type AppDetails struct { // The name of the app. AppName *string + // The type of app. + AppType AppType + // The creation time. CreationTime *time.Time // The domain ID. DomainId *string - // The type of app. - AppType AppType + // The status. + Status AppStatus // The user profile name. UserProfileName *string - - // The status. - Status AppStatus } // Configuration to run a processing job in a specified container image. type AppSpecification struct { - // The arguments for a container used to run a processing job. - ContainerArguments []*string - // The container image to be run by the processing job. // // This member is required. ImageUri *string + // The arguments for a container used to run a processing job. + ContainerArguments []*string + // The entrypoint for a container used to run a processing job. ContainerEntrypoint []*string } @@ -850,27 +850,15 @@ type AutoMLCandidate struct { // This member is required. CandidateName *string - // The failure reason. - FailureReason *string - // The candidate's status. // // This member is required. CandidateStatus CandidateStatus - // The objective status. + // The candidate's steps. // // This member is required. - ObjectiveStatus ObjectiveStatus - - // The candidate result from a job. - FinalAutoMLJobObjectiveMetric *FinalAutoMLJobObjectiveMetric - - // The end time. - EndTime *time.Time - - // The inference containers. - InferenceContainers []*AutoMLContainerDefinition + CandidateSteps []*AutoMLCandidateStep // The creation time. // @@ -882,15 +870,32 @@ type AutoMLCandidate struct { // This member is required. LastModifiedTime *time.Time - // The candidate's steps. + // The objective status. // // This member is required. - CandidateSteps []*AutoMLCandidateStep + ObjectiveStatus ObjectiveStatus + + // The end time. + EndTime *time.Time + + // The failure reason. + FailureReason *string + + // The candidate result from a job. + FinalAutoMLJobObjectiveMetric *FinalAutoMLJobObjectiveMetric + + // The inference containers. + InferenceContainers []*AutoMLContainerDefinition } // Information about the steps for a Candidate, and what step it is working on. type AutoMLCandidateStep struct { + // The ARN for the Candidate's step. + // + // This member is required. + CandidateStepArn *string + // The name for the Candidate's step. // // This member is required. @@ -900,26 +905,21 @@ type AutoMLCandidateStep struct { // // This member is required. CandidateStepType CandidateStepType - - // The ARN for the Candidate's step. - // - // This member is required. - CandidateStepArn *string } // Similar to Channel. A channel is a named input source that training algorithms // can consume. Refer to Channel for detailed descriptions. type AutoMLChannel struct { - // The name of the target variable in supervised learning, a.k.a. 'y'. + // The data source. // // This member is required. - TargetAttributeName *string + DataSource *AutoMLDataSource - // The data source. + // The name of the target variable in supervised learning, a.k.a. 'y'. // // This member is required. - DataSource *AutoMLDataSource + TargetAttributeName *string // You can use Gzip or None. The default value is None. CompressionType CompressionType @@ -929,9 +929,10 @@ type AutoMLChannel struct { // up one AutoML candidate. Refer to ContainerDefinition for more details. type AutoMLContainerDefinition struct { - // Environment variables to set in the container. Refer to ContainerDefinition for - // more details. - Environment map[string]*string + // The ECR path of the container. Refer to ContainerDefinition for more details. + // + // This member is required. + Image *string // The location of the model artifacts. Refer to ContainerDefinition for more // details. @@ -939,10 +940,9 @@ type AutoMLContainerDefinition struct { // This member is required. ModelDataUrl *string - // The ECR path of the container. Refer to ContainerDefinition for more details. - // - // This member is required. - Image *string + // Environment variables to set in the container. Refer to ContainerDefinition for + // more details. + Environment map[string]*string } // The data source for the AutoPilot job. @@ -959,25 +959,25 @@ type AutoMLDataSource struct { type AutoMLJobArtifacts struct { // The URL to the notebook location. - DataExplorationNotebookLocation *string + CandidateDefinitionNotebookLocation *string // The URL to the notebook location. - CandidateDefinitionNotebookLocation *string + DataExplorationNotebookLocation *string } // How long a job is allowed to run, or how many candidates a job is allowed to // generate. type AutoMLJobCompletionCriteria struct { - // The maximum time, in seconds, a job is allowed to run. - MaxRuntimePerTrainingJobInSeconds *int32 + // The maximum time, in seconds, an AutoML job is allowed to wait for a trial to + // complete. It must be equal to or greater than MaxRuntimePerTrainingJobInSeconds. + MaxAutoMLJobRuntimeInSeconds *int32 // The maximum number of times a training job is allowed to run. MaxCandidates *int32 - // The maximum time, in seconds, an AutoML job is allowed to wait for a trial to - // complete. It must be equal to or greater than MaxRuntimePerTrainingJobInSeconds. - MaxAutoMLJobRuntimeInSeconds *int32 + // The maximum time, in seconds, a job is allowed to run. + MaxRuntimePerTrainingJobInSeconds *int32 } // A collection of settings used for a job. @@ -1008,16 +1008,20 @@ type AutoMLJobSummary struct { // This member is required. AutoMLJobArn *string - // The failure reason. - FailureReason *string - // The name of the object you are requesting. // // This member is required. AutoMLJobName *string - // The end time. - EndTime *time.Time + // The job's secondary status. + // + // This member is required. + AutoMLJobSecondaryStatus AutoMLJobSecondaryStatus + + // The job's status. + // + // This member is required. + AutoMLJobStatus AutoMLJobStatus // When the job was created. // @@ -1029,27 +1033,23 @@ type AutoMLJobSummary struct { // This member is required. LastModifiedTime *time.Time - // The job's secondary status. - // - // This member is required. - AutoMLJobSecondaryStatus AutoMLJobSecondaryStatus + // The end time. + EndTime *time.Time - // The job's status. - // - // This member is required. - AutoMLJobStatus AutoMLJobStatus + // The failure reason. + FailureReason *string } // The output data configuration. type AutoMLOutputDataConfig struct { - // The AWS KMS encryption key ID. - KmsKeyId *string - // The Amazon S3 output path. Must be 128 characters or less. // // This member is required. S3OutputPath *string + + // The AWS KMS encryption key ID. + KmsKeyId *string } // The Amazon S3 data source. @@ -1069,14 +1069,14 @@ type AutoMLS3DataSource struct { // Security options. type AutoMLSecurityConfig struct { - // VPC configuration. - VpcConfig *VpcConfig - // Whether to use traffic encryption between the container layers. EnableInterContainerTrafficEncryption *bool // The key used to encrypt stored data. VolumeKmsKeyId *string + + // VPC configuration. + VpcConfig *VpcConfig } // @@ -1101,15 +1101,15 @@ type CaptureOption struct { // A list of categorical hyperparameters to tune. type CategoricalParameterRange struct { - // A list of the categories for the hyperparameter. + // The name of the categorical hyperparameter to tune. // // This member is required. - Values []*string + Name *string - // The name of the categorical hyperparameter to tune. + // A list of the categories for the hyperparameter. // // This member is required. - Name *string + Values []*string } // Defines the possible values for a categorical hyperparameter. @@ -1124,6 +1124,21 @@ type CategoricalParameterRangeSpecification struct { // A channel is a named input source that training algorithms can consume. type Channel struct { + // The name of the channel. + // + // This member is required. + ChannelName *string + + // The location of the channel data. + // + // This member is required. + DataSource *DataSource + + // If training data is compressed, the compression type. The default value is None. + // CompressionType is used only in Pipe input mode. In File mode, leave this field + // unset or set it to None. + CompressionType CompressionType + // The MIME type of the data. ContentType *string @@ -1138,6 +1153,15 @@ type Channel struct { // To use a model for incremental training, choose File input model. InputMode TrainingInputMode + // Specify RecordIO as the value when input data is in raw format but the training + // algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps + // each individual S3 object in a RecordIO record. If the input data is already in + // RecordIO format, you don't need to set this attribute. For more information, see + // Create a Dataset Using RecordIO + // (https://mxnet.apache.org/api/architecture/note_data_loading#data-format). In + // File mode, leave this field unset or set it to None. + RecordWrapperType RecordWrapper + // A configuration for a shuffle option for input data in a channel. If you use // S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. // If you use ManifestFile, the order of the S3 object references in the @@ -1151,77 +1175,53 @@ type Channel struct { // that the content sent to a particular node on the first epoch might be sent to a // different node on the second epoch. ShuffleConfig *ShuffleConfig +} - // Specify RecordIO as the value when input data is in raw format but the training - // algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps - // each individual S3 object in a RecordIO record. If the input data is already in - // RecordIO format, you don't need to set this attribute. For more information, see - // Create a Dataset Using RecordIO - // (https://mxnet.apache.org/api/architecture/note_data_loading#data-format). In - // File mode, leave this field unset or set it to None. - RecordWrapperType RecordWrapper +// Defines a named input source, called a channel, to be used by an algorithm. +type ChannelSpecification struct { // The name of the channel. // // This member is required. - ChannelName *string - - // If training data is compressed, the compression type. The default value is None. - // CompressionType is used only in Pipe input mode. In File mode, leave this field - // unset or set it to None. - CompressionType CompressionType + Name *string - // The location of the channel data. + // The supported MIME types for the data. // // This member is required. - DataSource *DataSource -} - -// Defines a named input source, called a channel, to be used by an algorithm. -type ChannelSpecification struct { + SupportedContentTypes []*string - // The supported MIME types for the data. + // The allowed input mode, either FILE or PIPE. In FILE mode, Amazon SageMaker + // copies the data from the input source onto the local Amazon Elastic Block Store + // (Amazon EBS) volumes before starting your training algorithm. This is the most + // commonly used input mode. In PIPE mode, Amazon SageMaker streams input data from + // the source directly to your algorithm without using the EBS volume. // // This member is required. - SupportedContentTypes []*string + SupportedInputModes []TrainingInputMode + + // A brief description of the channel. + Description *string // Indicates whether the channel is required by the algorithm. IsRequired *bool // The allowed compression types, if data compression is used. SupportedCompressionTypes []CompressionType - - // A brief description of the channel. - Description *string - - // The allowed input mode, either FILE or PIPE. In FILE mode, Amazon SageMaker - // copies the data from the input source onto the local Amazon Elastic Block Store - // (Amazon EBS) volumes before starting your training algorithm. This is the most - // commonly used input mode. In PIPE mode, Amazon SageMaker streams input data from - // the source directly to your algorithm without using the EBS volume. - // - // This member is required. - SupportedInputModes []TrainingInputMode - - // The name of the channel. - // - // This member is required. - Name *string } // Contains information about the output location for managed spot training // checkpoint data. type CheckpointConfig struct { - // (Optional) The local directory where checkpoints are written. The default - // directory is /opt/ml/checkpoints/. - LocalPath *string - // Identifies the S3 path where you want Amazon SageMaker to store checkpoints. For // example, s3://bucket-name/key-name-prefix. // // This member is required. S3Uri *string + + // (Optional) The local directory where checkpoints are written. The default + // directory is /opt/ml/checkpoints/. + LocalPath *string } // Specifies summary information about a Git repository. @@ -1232,6 +1232,11 @@ type CodeRepositorySummary struct { // This member is required. CodeRepositoryArn *string + // The name of the Git repository. + // + // This member is required. + CodeRepositoryName *string + // The date and time that the Git repository was created. // // This member is required. @@ -1246,11 +1251,6 @@ type CodeRepositorySummary struct { // located and the ARN of the AWS Secrets Manager secret that contains the // credentials used to access the repository. GitConfig *GitConfig - - // The name of the Git repository. - // - // This member is required. - CodeRepositoryName *string } // Use this parameter to configure your Amazon Cognito workforce. A single Cognito @@ -1284,64 +1284,34 @@ type CognitoMemberDefinition struct { // This member is required. ClientId *string - // An identifier for a user pool. The user pool must be in the same region as the - // service that you are calling. + // An identifier for a user group. // // This member is required. - UserPool *string + UserGroup *string - // An identifier for a user group. + // An identifier for a user pool. The user pool must be in the same region as the + // service that you are calling. // // This member is required. - UserGroup *string + UserPool *string } // Configuration information for tensor collections. type CollectionConfiguration struct { + // The name of the tensor collection. The name must be unique relative to other + // rule configuration names. + CollectionName *string + // Parameter values for the tensor collection. The allowed parameters are "name", // "include_regex", "reduction_config", "save_config", "tensor_names", and // "save_histogram". CollectionParameters map[string]*string - - // The name of the tensor collection. The name must be unique relative to other - // rule configuration names. - CollectionName *string } // A summary of a model compilation job. type CompilationJobSummary struct { - // The type of OS that the model will run on after the compilation job has - // completed. - CompilationTargetPlatformOs TargetPlatformOs - - // The type of device that the model will run on after the compilation job has - // completed. - CompilationTargetDevice TargetDevice - - // The type of architecture that the model will run on after the compilation job - // has completed. - CompilationTargetPlatformArch TargetPlatformArch - - // The time when the model compilation job completed. - CompilationEndTime *time.Time - - // The type of accelerator that the model will run on after the compilation job has - // completed. - CompilationTargetPlatformAccelerator TargetPlatformAccelerator - - // The time when the model compilation job was created. - // - // This member is required. - CreationTime *time.Time - - // The time when the model compilation job was last modified. - LastModifiedTime *time.Time - - // The time when the model compilation job started. - CompilationStartTime *time.Time - // The Amazon Resource Name (ARN) of the model compilation job. // // This member is required. @@ -1356,22 +1326,40 @@ type CompilationJobSummary struct { // // This member is required. CompilationJobStatus CompilationJobStatus -} -// Describes the container, as part of model definition. -type ContainerDefinition struct { + // The time when the model compilation job was created. + // + // This member is required. + CreationTime *time.Time - // The environment variables to set in the Docker container. Each key and value in - // the Environment string to string map can have length of up to 1024. We support - // up to 16 entries in the map. - Environment map[string]*string + // The time when the model compilation job completed. + CompilationEndTime *time.Time - // The name or Amazon Resource Name (ARN) of the model package to use to create the - // model. - ModelPackageName *string + // The time when the model compilation job started. + CompilationStartTime *time.Time - // Whether the container hosts a single model or multiple models. - Mode ContainerMode + // The type of device that the model will run on after the compilation job has + // completed. + CompilationTargetDevice TargetDevice + + // The type of accelerator that the model will run on after the compilation job has + // completed. + CompilationTargetPlatformAccelerator TargetPlatformAccelerator + + // The type of architecture that the model will run on after the compilation job + // has completed. + CompilationTargetPlatformArch TargetPlatformArch + + // The type of OS that the model will run on after the compilation job has + // completed. + CompilationTargetPlatformOs TargetPlatformOs + + // The time when the model compilation job was last modified. + LastModifiedTime *time.Time +} + +// Describes the container, as part of model definition. +type ContainerDefinition struct { // This parameter is ignored for models that contain only a PrimaryContainer. When // a ContainerDefinition is part of an inference pipeline, the value of the @@ -1387,6 +1375,11 @@ type ContainerDefinition struct { // of every ContainerDefinition in that pipeline. ContainerHostname *string + // The environment variables to set in the Docker container. Each key and value in + // the Environment string to string map can have length of up to 1024. We support + // up to 16 entries in the map. + Environment map[string]*string + // The Amazon EC2 Container Registry (Amazon ECR) path where inference code is // stored. If you are using your own custom algorithm instead of an algorithm // provided by Amazon SageMaker, the inference code must meet Amazon SageMaker @@ -1396,6 +1389,9 @@ type ContainerDefinition struct { // (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html) Image *string + // Whether the container hosts a single model or multiple models. + Mode ContainerMode + // The S3 path where the model artifacts, which result from model training, are // stored. This path must point to a single gzip compressed tar archive (.tar.gz // suffix). The S3 path is required for Amazon SageMaker built-in algorithms, but @@ -1412,6 +1408,10 @@ type ContainerDefinition struct { // algorithm to create a model, Amazon SageMaker requires that you provide a S3 // path to the model artifacts in ModelDataUrl. ModelDataUrl *string + + // The name or Amazon Resource Name (ARN) of the model package to use to create the + // model. + ModelPackageName *string } // A list of continuous hyperparameters to tune. @@ -1423,6 +1423,17 @@ type ContinuousParameterRange struct { // This member is required. MaxValue *string + // The minimum value for the hyperparameter. The tuning job uses floating-point + // values between this value and MaxValuefor tuning. + // + // This member is required. + MinValue *string + + // The name of the continuous hyperparameter to tune. + // + // This member is required. + Name *string + // The scale that hyperparameter tuning uses to search the hyperparameter range. // For information about choosing a hyperparameter scale, see Hyperparameter // Scaling @@ -1437,41 +1448,29 @@ type ContinuousParameterRange struct { // logarithmic scaling works only for ranges that are entirely within the range // 0<=x<1.0. ScalingType HyperParameterScalingType - - // The name of the continuous hyperparameter to tune. - // - // This member is required. - Name *string - - // The minimum value for the hyperparameter. The tuning job uses floating-point - // values between this value and MaxValuefor tuning. - // - // This member is required. - MinValue *string } // Defines the possible values for a continuous hyperparameter. type ContinuousParameterRangeSpecification struct { - // The minimum floating-point value allowed. + // The maximum floating-point value allowed. // // This member is required. - MinValue *string + MaxValue *string - // The maximum floating-point value allowed. + // The minimum floating-point value allowed. // // This member is required. - MaxValue *string + MinValue *string } // type DataCaptureConfig struct { // - EnableCapture *bool - // - KmsKeyId *string + // This member is required. + CaptureOptions []*CaptureOption // // @@ -1484,12 +1483,13 @@ type DataCaptureConfig struct { InitialSamplingPercentage *int32 // + CaptureContentTypeHeader *CaptureContentTypeHeader + // - // This member is required. - CaptureOptions []*CaptureOption + EnableCapture *bool // - CaptureContentTypeHeader *CaptureContentTypeHeader + KmsKeyId *string } // @@ -1498,17 +1498,17 @@ type DataCaptureConfigSummary struct { // // // This member is required. - DestinationS3Uri *string + CaptureStatus CaptureStatus // // // This member is required. - CaptureStatus CaptureStatus + CurrentSamplingPercentage *int32 // // // This member is required. - KmsKeyId *string + DestinationS3Uri *string // // @@ -1518,7 +1518,7 @@ type DataCaptureConfigSummary struct { // // // This member is required. - CurrentSamplingPercentage *int32 + KmsKeyId *string } // The data structure used to specify the data to be used for inference in a batch @@ -1568,61 +1568,61 @@ type DataProcessing struct { // Describes the location of the channel data. type DataSource struct { - // The S3 location of the data source that is associated with a channel. - S3DataSource *S3DataSource - // The file system that is associated with a channel. FileSystemDataSource *FileSystemDataSource + + // The S3 location of the data source that is associated with a channel. + S3DataSource *S3DataSource } // Configuration information for the debug hook parameters, collection // configuration, and storage paths. type DebugHookConfig struct { + // Path to Amazon S3 storage location for tensors. + // + // This member is required. + S3OutputPath *string + // Configuration information for tensor collections. CollectionConfigurations []*CollectionConfiguration - // Path to local storage location for tensors. Defaults to /opt/ml/output/tensors/. - LocalPath *string - // Configuration information for the debug hook parameters. HookParameters map[string]*string - // Path to Amazon S3 storage location for tensors. - // - // This member is required. - S3OutputPath *string + // Path to local storage location for tensors. Defaults to /opt/ml/output/tensors/. + LocalPath *string } // Configuration information for debugging rules. type DebugRuleConfiguration struct { - // Path to Amazon S3 storage location for rules. - S3OutputPath *string - - // The instance type to deploy for a training job. - InstanceType ProcessingInstanceType + // The name of the rule configuration. It must be unique relative to other rule + // configuration names. + // + // This member is required. + RuleConfigurationName *string // The Amazon Elastic Container (ECR) Image for the managed rule evaluation. // // This member is required. RuleEvaluatorImage *string - // The name of the rule configuration. It must be unique relative to other rule - // configuration names. - // - // This member is required. - RuleConfigurationName *string + // The instance type to deploy for a training job. + InstanceType ProcessingInstanceType + + // Path to local storage location for output of rules. Defaults to + // /opt/ml/processing/output/rule/. + LocalPath *string // Runtime configuration for rule container. RuleParameters map[string]*string + // Path to Amazon S3 storage location for rules. + S3OutputPath *string + // The size, in GB, of the ML storage volume attached to the processing instance. VolumeSizeInGB *int32 - - // Path to local storage location for output of rules. Defaults to - // /opt/ml/processing/output/rule/. - LocalPath *string } // Information about the status of the rule evaluation. @@ -1631,8 +1631,8 @@ type DebugRuleEvaluationStatus struct { // Timestamp when the rule evaluation status was last modified. LastModifiedTime *time.Time - // Details from the rule evaluation. - StatusDetails *string + // The name of the rule configuration + RuleConfigurationName *string // The Amazon Resource Name (ARN) of the rule evaluation job. RuleEvaluationJobArn *string @@ -1640,8 +1640,8 @@ type DebugRuleEvaluationStatus struct { // Status of the rule evaluation. RuleEvaluationStatus RuleEvaluationStatus - // The name of the rule configuration - RuleConfigurationName *string + // Details from the rule evaluation. + StatusDetails *string } // Gets the Amazon EC2 Container Registry path of the docker image of the model @@ -1684,36 +1684,31 @@ type DesiredWeightAndCapacity struct { // The domain's details. type DomainDetails struct { - // The domain name. - DomainName *string + // The creation time. + CreationTime *time.Time + + // The domain's Amazon Resource Name (ARN). + DomainArn *string // The domain ID. DomainId *string - // The status. - Status DomainStatus - - // The creation time. - CreationTime *time.Time + // The domain name. + DomainName *string // The last modified time. LastModifiedTime *time.Time + // The status. + Status DomainStatus + // The domain's URL. Url *string - - // The domain's Amazon Resource Name (ARN). - DomainArn *string } // Provides summary information for an endpoint configuration. type EndpointConfigSummary struct { - // The name of the endpoint configuration. - // - // This member is required. - EndpointConfigName *string - // A timestamp that shows when the endpoint configuration was created. // // This member is required. @@ -1723,6 +1718,11 @@ type EndpointConfigSummary struct { // // This member is required. EndpointConfigArn *string + + // The name of the endpoint configuration. + // + // This member is required. + EndpointConfigName *string } // Input object for the endpoint @@ -1733,24 +1733,34 @@ type EndpointInput struct { // This member is required. EndpointName *string - // Whether the Pipe or File is used as the input mode for transfering data for the - // monitoring job. Pipe mode is recommended for large datasets. File mode is useful - // for small files that fit in memory. Defaults to File. - S3InputMode ProcessingS3InputMode + // Path to the filesystem where the endpoint data is available to the container. + // + // This member is required. + LocalPath *string // Whether input data distributed in Amazon S3 is fully replicated or sharded by an // S3 key. Defauts to FullyReplicated S3DataDistributionType ProcessingS3DataDistributionType - // Path to the filesystem where the endpoint data is available to the container. - // - // This member is required. - LocalPath *string + // Whether the Pipe or File is used as the input mode for transfering data for the + // monitoring job. Pipe mode is recommended for large datasets. File mode is useful + // for small files that fit in memory. Defaults to File. + S3InputMode ProcessingS3InputMode } // Provides summary information for an endpoint. type EndpointSummary struct { + // A timestamp that shows when the endpoint was created. + // + // This member is required. + CreationTime *time.Time + + // The Amazon Resource Name (ARN) of the endpoint. + // + // This member is required. + EndpointArn *string + // The name of the endpoint. // // This member is required. @@ -1798,16 +1808,6 @@ type EndpointSummary struct { // This member is required. EndpointStatus EndpointStatus - // The Amazon Resource Name (ARN) of the endpoint. - // - // This member is required. - EndpointArn *string - - // A timestamp that shows when the endpoint was created. - // - // This member is required. - CreationTime *time.Time - // A timestamp that shows when the endpoint was last modified. // // This member is required. @@ -1817,39 +1817,39 @@ type EndpointSummary struct { // The properties of an experiment as returned by the Search () API. type Experiment struct { - // The list of tags that are associated with the experiment. You can use Search () - // API to search on the tags. - Tags []*Tag - - // The source of the experiment. - Source *ExperimentSource - // Information about the user who created or modified an experiment, trial, or // trial component. - LastModifiedBy *UserContext + CreatedBy *UserContext + + // When the experiment was created. + CreationTime *time.Time // The description of the experiment. Description *string - // Information about the user who created or modified an experiment, trial, or - // trial component. - CreatedBy *UserContext - - // The name of the experiment. - ExperimentName *string + // The name of the experiment as displayed. If DisplayName isn't specified, + // ExperimentName is displayed. + DisplayName *string // The Amazon Resource Name (ARN) of the experiment. ExperimentArn *string - // The name of the experiment as displayed. If DisplayName isn't specified, - // ExperimentName is displayed. - DisplayName *string + // The name of the experiment. + ExperimentName *string + + // Information about the user who created or modified an experiment, trial, or + // trial component. + LastModifiedBy *UserContext // When the experiment was last modified. LastModifiedTime *time.Time - // When the experiment was created. - CreationTime *time.Time + // The source of the experiment. + Source *ExperimentSource + + // The list of tags that are associated with the experiment. You can use Search () + // API to search on the tags. + Tags []*Tag } // Associates a SageMaker job as a trial component with an experiment and trial. @@ -1863,16 +1863,16 @@ type Experiment struct { // * CreateTransformJob () type ExperimentConfig struct { - // The name of an existing trial to associate the trial component with. If not - // specified, a new trial is created. - TrialName *string - // The name of an existing experiment to associate the trial component with. ExperimentName *string // The display name for the trial component. If this key isn't specified, the // display name is the trial component name. TrialComponentDisplayName *string + + // The name of an existing trial to associate the trial component with. If not + // specified, a new trial is created. + TrialName *string } // The source of the experiment. @@ -1891,24 +1891,24 @@ type ExperimentSource struct { // properties, call the DescribeExperiment () API and provide the ExperimentName. type ExperimentSummary struct { - // The source of the experiment. - ExperimentSource *ExperimentSource + // When the experiment was created. + CreationTime *time.Time - // The name of the experiment. - ExperimentName *string + // The name of the experiment as displayed. If DisplayName isn't specified, + // ExperimentName is displayed. + DisplayName *string // The Amazon Resource Name (ARN) of the experiment. ExperimentArn *string - // When the experiment was created. - CreationTime *time.Time + // The name of the experiment. + ExperimentName *string + + // The source of the experiment. + ExperimentSource *ExperimentSource // When the experiment was last modified. LastModifiedTime *time.Time - - // The name of the experiment as displayed. If DisplayName isn't specified, - // ExperimentName is displayed. - DisplayName *string } // Specifies a file system data source for a channel. @@ -1925,15 +1925,15 @@ type FileSystemDataSource struct { // This member is required. FileSystemAccessMode FileSystemAccessMode - // The file system type. + // The file system id. // // This member is required. - FileSystemType FileSystemType + FileSystemId *string - // The file system id. + // The file system type. // // This member is required. - FileSystemId *string + FileSystemType FileSystemType } // A conditional statement for a search expression that includes a resource @@ -1961,12 +1961,6 @@ type FileSystemDataSource struct { // with the form Tags..

    type Filter struct { - // A value used with Name and Operator to determine which resources satisfy the - // filter's condition. For numerical properties, Value must be an integer or - // floating-point decimal. For timestamp properties, Value must be an ISO 8601 - // date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS. - Value *string - // A resource property name. For example, TrainingJobName. For valid property // names, see SearchRecord (). You must specify a valid property for the resource. // @@ -2019,11 +2013,22 @@ type Filter struct { // Contains operators in the SearchExpression, the result is the following error // message: "'CONTAINS' operator usage limit of 1 exceeded." Operator Operator + + // A value used with Name and Operator to determine which resources satisfy the + // filter's condition. For numerical properties, Value must be an integer or + // floating-point decimal. For timestamp properties, Value must be an ISO 8601 + // date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS. + Value *string } // The candidate result from a job. type FinalAutoMLJobObjectiveMetric struct { + // The name of the metric. + // + // This member is required. + MetricName AutoMLMetricEnum + // The value of the metric. // // This member is required. @@ -2031,11 +2036,6 @@ type FinalAutoMLJobObjectiveMetric struct { // The metric type used. Type AutoMLJobObjectiveType - - // The name of the metric. - // - // This member is required. - MetricName AutoMLMetricEnum } // Shows the final value for the objective metric for a training job that was @@ -2043,32 +2043,32 @@ type FinalAutoMLJobObjectiveMetric struct { // HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig (). type FinalHyperParameterTuningJobObjectiveMetric struct { - // Whether to minimize or maximize the objective metric. Valid values are Minimize - // and Maximize. - Type HyperParameterTuningJobObjectiveType + // The name of the objective metric. + // + // This member is required. + MetricName *string // The value of the objective metric. // // This member is required. Value *float32 - // The name of the objective metric. - // - // This member is required. - MetricName *string + // Whether to minimize or maximize the objective metric. Valid values are Minimize + // and Maximize. + Type HyperParameterTuningJobObjectiveType } // Contains information about where human output will be stored. type FlowDefinitionOutputConfig struct { - // The Amazon Key Management Service (KMS) key ID for server-side encryption. - KmsKeyId *string - // The Amazon S3 path where the object containing human output will be made // available. // // This member is required. S3OutputPath *string + + // The Amazon Key Management Service (KMS) key ID for server-side encryption. + KmsKeyId *string } // Contains summary information about the flow definition. @@ -2079,15 +2079,6 @@ type FlowDefinitionSummary struct { // This member is required. CreationTime *time.Time - // The reason why the flow definition creation failed. A failure reason is returned - // only when the flow definition status is Failed. - FailureReason *string - - // The status of the flow definition. Valid values: - // - // This member is required. - FlowDefinitionStatus FlowDefinitionStatus - // The Amazon Resource Name (ARN) of the flow definition. // // This member is required. @@ -2097,11 +2088,25 @@ type FlowDefinitionSummary struct { // // This member is required. FlowDefinitionName *string + + // The status of the flow definition. Valid values: + // + // This member is required. + FlowDefinitionStatus FlowDefinitionStatus + + // The reason why the flow definition creation failed. A failure reason is returned + // only when the flow definition status is Failed. + FailureReason *string } // Specifies configuration details for a Git repository in your AWS account. type GitConfig struct { + // The URL where the Git repository is located. + // + // This member is required. + RepositoryUrl *string + // The default branch for the Git repository. Branch *string @@ -2110,11 +2115,6 @@ type GitConfig struct { // staging label of AWSCURRENT and must be in the following format: {"username": // UserName, "password": Password} SecretArn *string - - // The URL where the Git repository is located. - // - // This member is required. - RepositoryUrl *string } // Specifies configuration details for a Git repository when the repository is @@ -2160,6 +2160,34 @@ type HumanLoopActivationConfig struct { // Describes the work to be performed by human workers. type HumanLoopConfig struct { + // The Amazon Resource Name (ARN) of the human task user interface. + // + // This member is required. + HumanTaskUiArn *string + + // The number of distinct workers who will perform the same task on each object. + // For example, if TaskCount is set to 3 for an image classification labeling job, + // three workers will classify each input image. Increasing TaskCount can improve + // label accuracy. + // + // This member is required. + TaskCount *int32 + + // A description for the human worker task. + // + // This member is required. + TaskDescription *string + + // A title for the human worker task. + // + // This member is required. + TaskTitle *string + + // Amazon Resource Name (ARN) of a team of workers. + // + // This member is required. + WorkteamArn *string + // Defines the amount of money paid to an Amazon Mechanical Turk worker for each // task performed. Use one of the following prices for bounding box tasks. Prices // are in US dollars and should be based on the complexity of the task; the longer @@ -2383,50 +2411,22 @@ type HumanLoopConfig struct { // * 0.012 PublicWorkforceTaskPrice *PublicWorkforceTaskPrice - // The amount of time that a worker has to complete a task. - TaskTimeLimitInSeconds *int32 - - // The number of distinct workers who will perform the same task on each object. - // For example, if TaskCount is set to 3 for an image classification labeling job, - // three workers will classify each input image. Increasing TaskCount can improve - // label accuracy. - // - // This member is required. - TaskCount *int32 + // The length of time that a task remains available for labeling by human workers. + TaskAvailabilityLifetimeInSeconds *int32 // Keywords used to describe the task so that workers can discover the task. TaskKeywords []*string - // The length of time that a task remains available for labeling by human workers. - TaskAvailabilityLifetimeInSeconds *int32 + // The amount of time that a worker has to complete a task. + TaskTimeLimitInSeconds *int32 +} - // A title for the human worker task. - // - // This member is required. - TaskTitle *string +// Container for configuring the source of human task requests. +type HumanLoopRequestSource struct { - // The Amazon Resource Name (ARN) of the human task user interface. - // - // This member is required. - HumanTaskUiArn *string - - // A description for the human worker task. - // - // This member is required. - TaskDescription *string - - // Amazon Resource Name (ARN) of a team of workers. - // - // This member is required. - WorkteamArn *string -} - -// Container for configuring the source of human task requests. -type HumanLoopRequestSource struct { - - // Specifies whether Amazon Rekognition or Amazon Textract are used as the - // integration source. The default field settings and JSON parsing rules are - // different based on the integration source. Valid values: + // Specifies whether Amazon Rekognition or Amazon Textract are used as the + // integration source. The default field settings and JSON parsing rules are + // different based on the integration source. Valid values: // // This member is required. AwsManagedHumanLoopRequestSource AwsManagedHumanLoopRequestSource @@ -2435,40 +2435,15 @@ type HumanLoopRequestSource struct { // Information required for human workers to complete a labeling task. type HumanTaskConfig struct { - // The Amazon Resource Name (ARN) of the work team assigned to complete the tasks. - // - // This member is required. - WorkteamArn *string - - // Defines the maximum number of data objects that can be labeled by human workers - // at the same time. Also referred to as batch size. Each object may have more than - // one worker at one time. The default value is 1000 objects. - MaxConcurrentTaskCount *int32 - // Configures how labels are consolidated across human workers. // // This member is required. AnnotationConsolidationConfig *AnnotationConsolidationConfig - // Information about the user interface that workers use to complete the labeling - // task. - // - // This member is required. - UiConfig *UiConfig - - // Keywords used to describe the task so that workers on Amazon Mechanical Turk can - // discover the task. - TaskKeywords []*string - - // The amount of time that a worker has to complete a task. - // - // This member is required. - TaskTimeLimitInSeconds *int32 - - // A title for the task for your human workers. + // The number of human workers that will label an object. // // This member is required. - TaskTitle *string + NumberOfHumanWorkersPerDataObject *int32 // The Amazon Resource Name (ARN) of a Lambda function that is run before a data // object is sent to a human worker. Use this function to provide input to a custom @@ -3071,30 +3046,60 @@ type HumanTaskConfig struct { // This member is required. PreHumanTaskLambdaArn *string - // The length of time that a task remains available for labeling by human workers. - // If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours - // (43200). The default value is 864000 seconds (10 days). For private and vendor - // workforces, the maximum is as listed. - TaskAvailabilityLifetimeInSeconds *int32 + // A description of the task for your human workers. + // + // This member is required. + TaskDescription *string - // The price that you pay for each task performed by an Amazon Mechanical Turk - // worker. - PublicWorkforceTaskPrice *PublicWorkforceTaskPrice + // The amount of time that a worker has to complete a task. + // + // This member is required. + TaskTimeLimitInSeconds *int32 - // The number of human workers that will label an object. + // A title for the task for your human workers. // // This member is required. - NumberOfHumanWorkersPerDataObject *int32 + TaskTitle *string - // A description of the task for your human workers. + // Information about the user interface that workers use to complete the labeling + // task. // // This member is required. - TaskDescription *string + UiConfig *UiConfig + + // The Amazon Resource Name (ARN) of the work team assigned to complete the tasks. + // + // This member is required. + WorkteamArn *string + + // Defines the maximum number of data objects that can be labeled by human workers + // at the same time. Also referred to as batch size. Each object may have more than + // one worker at one time. The default value is 1000 objects. + MaxConcurrentTaskCount *int32 + + // The price that you pay for each task performed by an Amazon Mechanical Turk + // worker. + PublicWorkforceTaskPrice *PublicWorkforceTaskPrice + + // The length of time that a task remains available for labeling by human workers. + // If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours + // (43200). The default value is 864000 seconds (10 days). For private and vendor + // workforces, the maximum is as listed. + TaskAvailabilityLifetimeInSeconds *int32 + + // Keywords used to describe the task so that workers on Amazon Mechanical Turk can + // discover the task. + TaskKeywords []*string } // Container for human task user interface information. type HumanTaskUiSummary struct { + // A timestamp when SageMaker created the human task user interface. + // + // This member is required. + CreationTime *time.Time + // The Amazon Resource Name (ARN) of the human task user interface. // // This member is required. @@ -3104,11 +3109,6 @@ type HumanTaskUiSummary struct { // // This member is required. HumanTaskUiName *string - - // A timestamp when SageMaker created the human task user interface. - // - // This member is required. - CreationTime *time.Time } // Specifies which training algorithm to use for training jobs that a @@ -3129,15 +3129,15 @@ type HyperParameterAlgorithmSpecification struct { // This member is required. TrainingInputMode TrainingInputMode - // An array of MetricDefinition () objects that specify the metrics that the - // algorithm emits. - MetricDefinitions []*MetricDefinition - // The name of the resource algorithm to use for the hyperparameter tuning job. If // you specify a value for this parameter, do not specify a value for // TrainingImage. AlgorithmName *string + // An array of MetricDefinition () objects that specify the metrics that the + // algorithm emits. + MetricDefinitions []*MetricDefinition + // The registry path of the Docker image that contains the training algorithm. For // information about Docker registry paths for built-in algorithms, see Algorithms // Provided by Amazon SageMaker: Common Parameters @@ -3152,36 +3152,80 @@ type HyperParameterAlgorithmSpecification struct { // Defines a hyperparameter to be used by an algorithm. type HyperParameterSpecification struct { + // The name of this hyperparameter. The name must be unique. + // + // This member is required. + Name *string + // The type of this hyperparameter. The valid types are Integer, Continuous, // Categorical, and FreeText. // // This member is required. Type ParameterType + // The default value for this hyperparameter. If a default value is specified, a + // hyperparameter cannot be required. + DefaultValue *string + // A brief description of the hyperparameter. Description *string + // Indicates whether this hyperparameter is required. + IsRequired *bool + + // Indicates whether this hyperparameter is tunable in a hyperparameter tuning job. + IsTunable *bool + // The allowed range for this hyperparameter. Range *ParameterRange +} - // The name of this hyperparameter. The name must be unique. +// Defines the training jobs launched by a hyperparameter tuning job. +type HyperParameterTrainingJobDefinition struct { + + // The HyperParameterAlgorithmSpecification () object that specifies the resource + // algorithm to use for the training jobs that the tuning job launches. // // This member is required. - Name *string + AlgorithmSpecification *HyperParameterAlgorithmSpecification - // The default value for this hyperparameter. If a default value is specified, a - // hyperparameter cannot be required. - DefaultValue *string + // Specifies the path to the Amazon S3 bucket where you store model artifacts from + // the training jobs that the tuning job launches. + // + // This member is required. + OutputDataConfig *OutputDataConfig - // Indicates whether this hyperparameter is tunable in a hyperparameter tuning job. - IsTunable *bool + // The resources, including the compute instances and storage volumes, to use for + // the training jobs that the tuning job launches. Storage volumes store model + // artifacts and incremental states. Training algorithms might also use storage + // volumes for scratch space. If you want Amazon SageMaker to use the storage + // volume to store the training data, choose File as the TrainingInputMode in the + // algorithm specification. For distributed training algorithms, specify an + // instance count greater than 1. + // + // This member is required. + ResourceConfig *ResourceConfig - // Indicates whether this hyperparameter is required. - IsRequired *bool -} + // The Amazon Resource Name (ARN) of the IAM role associated with the training jobs + // that the tuning job launches. + // + // This member is required. + RoleArn *string -// Defines the training jobs launched by a hyperparameter tuning job. -type HyperParameterTrainingJobDefinition struct { + // Specifies a limit to how long a model hyperparameter training job can run. It + // also specifies how long you are willing to wait for a managed spot training job + // to complete. When the job reaches the a limit, Amazon SageMaker ends the + // training job. Use this API to cap model training costs. + // + // This member is required. + StoppingCondition *StoppingCondition + + // Contains information about the output location for managed spot training + // checkpoint data. + CheckpointConfig *CheckpointConfig + + // The job definition name. + DefinitionName *string // To encrypt all communications between ML compute instances in distributed // training, choose True. Encryption provides greater security for distributed @@ -3190,6 +3234,10 @@ type HyperParameterTrainingJobDefinition struct { // learning algorithm in distributed training. EnableInterContainerTrafficEncryption *bool + // A Boolean indicating whether managed spot training is enabled (True) or not + // (False). + EnableManagedSpotTraining *bool + // Isolates the training container. No inbound or outbound network calls can be // made, except for calls between peers within a training cluster for distributed // training. If network isolation is used for training jobs that are configured to @@ -3198,17 +3246,6 @@ type HyperParameterTrainingJobDefinition struct { // network access. EnableNetworkIsolation *bool - // Specifies a limit to how long a model hyperparameter training job can run. It - // also specifies how long you are willing to wait for a managed spot training job - // to complete. When the job reaches the a limit, Amazon SageMaker ends the - // training job. Use this API to cap model training costs. - // - // This member is required. - StoppingCondition *StoppingCondition - - // Specifies the values of hyperparameters that do not change for the tuning job. - StaticHyperParameters map[string]*string - // Specifies ranges of integer, continuous, and categorical hyperparameters that a // hyperparameter tuning job searches. The hyperparameter tuning job launches // training jobs with hyperparameter values within these ranges to find the @@ -3219,16 +3256,12 @@ type HyperParameterTrainingJobDefinition struct { // against this limit. HyperParameterRanges *ParameterRanges - // The resources, including the compute instances and storage volumes, to use for - // the training jobs that the tuning job launches. Storage volumes store model - // artifacts and incremental states. Training algorithms might also use storage - // volumes for scratch space. If you want Amazon SageMaker to use the storage - // volume to store the training data, choose File as the TrainingInputMode in the - // algorithm specification. For distributed training algorithms, specify an - // instance count greater than 1. - // - // This member is required. - ResourceConfig *ResourceConfig + // An array of Channel () objects that specify the input for the training jobs that + // the tuning job launches. + InputDataConfig []*Channel + + // Specifies the values of hyperparameters that do not change for the tuning job. + StaticHyperParameters map[string]*string // Defines the objective metric for a hyperparameter tuning job. Hyperparameter // tuning uses the value of this metric to evaluate the training jobs it launches, @@ -3236,73 +3269,31 @@ type HyperParameterTrainingJobDefinition struct { // for this metric, depending on the value you specify for the Type parameter. TuningObjective *HyperParameterTuningJobObjective - // The HyperParameterAlgorithmSpecification () object that specifies the resource - // algorithm to use for the training jobs that the tuning job launches. - // - // This member is required. - AlgorithmSpecification *HyperParameterAlgorithmSpecification - - // The job definition name. - DefinitionName *string - - // Contains information about the output location for managed spot training - // checkpoint data. - CheckpointConfig *CheckpointConfig - // The VpcConfig () object that specifies the VPC that you want the training jobs // that this hyperparameter tuning job launches to connect to. Control access to // and from your training container by configuring the VPC. For more information, // see Protect Training Jobs by Using an Amazon Virtual Private Cloud // (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). VpcConfig *VpcConfig - - // Specifies the path to the Amazon S3 bucket where you store model artifacts from - // the training jobs that the tuning job launches. - // - // This member is required. - OutputDataConfig *OutputDataConfig - - // An array of Channel () objects that specify the input for the training jobs that - // the tuning job launches. - InputDataConfig []*Channel - - // The Amazon Resource Name (ARN) of the IAM role associated with the training jobs - // that the tuning job launches. - // - // This member is required. - RoleArn *string - - // A Boolean indicating whether managed spot training is enabled (True) or not - // (False). - EnableManagedSpotTraining *bool } // Specifies summary information about a training job. type HyperParameterTrainingJobSummary struct { - // The date and time that the training job started. - TrainingStartTime *time.Time - // The date and time that the training job was created. // // This member is required. CreationTime *time.Time - // Specifies the time when the training job ends on training instances. You are - // billed for the time interval between the value of TrainingStartTime and this - // time. For successful jobs and stopped jobs, this is the time after model - // artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker - // detects a job failure. - TrainingEndTime *time.Time - - // The reason that the training job failed. - FailureReason *string - - // The training job definition name. - TrainingJobDefinitionName *string + // The Amazon Resource Name (ARN) of the training job. + // + // This member is required. + TrainingJobArn *string - // The HyperParameter tuning job that launched the training job. - TuningJobName *string + // The name of the training job. + // + // This member is required. + TrainingJobName *string // The status of the training job. // @@ -3314,10 +3305,12 @@ type HyperParameterTrainingJobSummary struct { // This member is required. TunedHyperParameters map[string]*string - // The name of the training job. - // - // This member is required. - TrainingJobName *string + // The reason that the training job failed. + FailureReason *string + + // The FinalHyperParameterTuningJobObjectiveMetric () object that specifies the + // value of the objective metric of the tuning job that launched this training job. + FinalHyperParameterTuningJobObjectiveMetric *FinalHyperParameterTuningJobObjectiveMetric // The status of the objective metric for the training job: // @@ -3334,26 +3327,26 @@ type HyperParameterTrainingJobSummary struct { // occurs when the training job failed or did not emit an objective metric. ObjectiveStatus ObjectiveStatus - // The FinalHyperParameterTuningJobObjectiveMetric () object that specifies the - // value of the objective metric of the tuning job that launched this training job. - FinalHyperParameterTuningJobObjectiveMetric *FinalHyperParameterTuningJobObjectiveMetric + // Specifies the time when the training job ends on training instances. You are + // billed for the time interval between the value of TrainingStartTime and this + // time. For successful jobs and stopped jobs, this is the time after model + // artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker + // detects a job failure. + TrainingEndTime *time.Time - // The Amazon Resource Name (ARN) of the training job. - // - // This member is required. - TrainingJobArn *string + // The training job definition name. + TrainingJobDefinitionName *string + + // The date and time that the training job started. + TrainingStartTime *time.Time + + // The HyperParameter tuning job that launched the training job. + TuningJobName *string } // Configures a hyperparameter tuning job. type HyperParameterTuningJobConfig struct { - // The HyperParameterTuningJobObjective () object that specifies the objective - // metric for this tuning job. - HyperParameterTuningJobObjective *HyperParameterTuningJobObjective - - // The tuning job's completion criteria. - TuningJobCompletionCriteria *TuningJobCompletionCriteria - // The ResourceLimits () object that specifies the maximum number of training jobs // and parallel training jobs for this tuning job. // @@ -3369,6 +3362,14 @@ type HyperParameterTuningJobConfig struct { // This member is required. Strategy HyperParameterTuningJobStrategyType + // The HyperParameterTuningJobObjective () object that specifies the objective + // metric for this tuning job. + HyperParameterTuningJobObjective *HyperParameterTuningJobObjective + + // The ParameterRanges () object that specifies the ranges of hyperparameters that + // this tuning job searches. + ParameterRanges *ParameterRanges + // Specifies whether to use early stopping for training jobs launched by the // hyperparameter tuning job. This can be one of the following values (the default // value is OFF): OFF Training jobs launched by the hyperparameter tuning job do @@ -3379,9 +3380,8 @@ type HyperParameterTuningJobConfig struct { // (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-early-stopping.html). TrainingJobEarlyStoppingType TrainingJobEarlyStoppingType - // The ParameterRanges () object that specifies the ranges of hyperparameters that - // this tuning job searches. - ParameterRanges *ParameterRanges + // The tuning job's completion criteria. + TuningJobCompletionCriteria *TuningJobCompletionCriteria } // Defines the objective metric for a hyperparameter tuning job. Hyperparameter @@ -3404,29 +3404,20 @@ type HyperParameterTuningJobObjective struct { // Provides summary information about a hyperparameter tuning job. type HyperParameterTuningJobSummary struct { - // The ResourceLimits () object that specifies the maximum number of training jobs - // and parallel training jobs allowed for this tuning job. - ResourceLimits *ResourceLimits - - // The date and time that the tuning job was modified. - LastModifiedTime *time.Time - - // The Amazon Resource Name (ARN) of the tuning job. + // The date and time that the tuning job was created. // // This member is required. - HyperParameterTuningJobArn *string + CreationTime *time.Time - // Specifies the search strategy hyperparameter tuning uses to choose which - // hyperparameters to use for each iteration. Currently, the only valid value is - // Bayesian. + // The Amazon Resource Name (ARN) of the tuning job. // // This member is required. - Strategy HyperParameterTuningJobStrategyType + HyperParameterTuningJobArn *string - // The date and time that the tuning job was created. + // The name of the tuning job. // // This member is required. - CreationTime *time.Time + HyperParameterTuningJobName *string // The status of the tuning job. // @@ -3439,6 +3430,13 @@ type HyperParameterTuningJobSummary struct { // This member is required. ObjectiveStatusCounters *ObjectiveStatusCounters + // Specifies the search strategy hyperparameter tuning uses to choose which + // hyperparameters to use for each iteration. Currently, the only valid value is + // Bayesian. + // + // This member is required. + Strategy HyperParameterTuningJobStrategyType + // The TrainingJobStatusCounters () object that specifies the numbers of training // jobs, categorized by status, that this tuning job launched. // @@ -3448,10 +3446,12 @@ type HyperParameterTuningJobSummary struct { // The date and time that the tuning job ended. HyperParameterTuningEndTime *time.Time - // The name of the tuning job. - // - // This member is required. - HyperParameterTuningJobName *string + // The date and time that the tuning job was modified. + LastModifiedTime *time.Time + + // The ResourceLimits () object that specifies the maximum number of training jobs + // and parallel training jobs allowed for this tuning job. + ResourceLimits *ResourceLimits } // Specifies the configuration for a hyperparameter tuning job that uses one or @@ -3505,32 +3505,32 @@ type HyperParameterTuningJobWarmStartConfig struct { // Defines how to perform inference generation after a training job is run. type InferenceSpecification struct { - // A list of the instance types that are used to generate inferences in real-time. + // The Amazon ECR registry path of the Docker image that contains the inference + // code. // // This member is required. - SupportedRealtimeInferenceInstanceTypes []ProductionVariantInstanceType + Containers []*ModelPackageContainerDefinition // The supported MIME types for the input data. // // This member is required. SupportedContentTypes []*string - // A list of the instance types on which a transformation job can be run or on - // which an endpoint can be deployed. + // A list of the instance types that are used to generate inferences in real-time. // // This member is required. - SupportedTransformInstanceTypes []TransformInstanceType + SupportedRealtimeInferenceInstanceTypes []ProductionVariantInstanceType // The supported MIME types for the output data. // // This member is required. SupportedResponseMIMETypes []*string - // The Amazon ECR registry path of the Docker image that contains the inference - // code. + // A list of the instance types on which a transformation job can be run or on + // which an endpoint can be deployed. // // This member is required. - Containers []*ModelPackageContainerDefinition + SupportedTransformInstanceTypes []TransformInstanceType } // Contains information about the location of input model artifacts, the name and @@ -3538,12 +3538,6 @@ type InferenceSpecification struct { // trained. type InputConfig struct { - // Identifies the framework in which the model was trained. For example: - // TENSORFLOW. - // - // This member is required. - Framework Framework - // Specifies the name and shape of the expected data inputs for your trained model // with a JSON dictionary form. The data inputs are InputConfig$Framework () // specific. @@ -3649,6 +3643,12 @@ type InputConfig struct { // This member is required. DataInputConfig *string + // Identifies the framework in which the model was trained. For example: + // TENSORFLOW. + // + // This member is required. + Framework Framework + // The S3 path where the model artifacts, which result from model training, are // stored. This path must point to a single gzip compressed tar archive (.tar.gz // suffix). @@ -3661,18 +3661,6 @@ type InputConfig struct { // hyperparameter tuning job searches. type IntegerParameterRange struct { - // The scale that hyperparameter tuning uses to search the hyperparameter range. - // For information about choosing a hyperparameter scale, see Hyperparameter - // Scaling - // (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type). - // One of the following values: Auto Amazon SageMaker hyperparameter tuning chooses - // the best scale for the hyperparameter. Linear Hyperparameter tuning searches the - // values in the hyperparameter range by using a linear scale. Logarithmic - // Hyperparameter tuning searches the values in the hyperparameter range by using a - // logarithmic scale. Logarithmic scaling works only for ranges that have only - // values greater than 0. - ScalingType HyperParameterScalingType - // The maximum value of the hyperparameter to search. // // This member is required. @@ -3687,6 +3675,18 @@ type IntegerParameterRange struct { // // This member is required. Name *string + + // The scale that hyperparameter tuning uses to search the hyperparameter range. + // For information about choosing a hyperparameter scale, see Hyperparameter + // Scaling + // (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type). + // One of the following values: Auto Amazon SageMaker hyperparameter tuning chooses + // the best scale for the hyperparameter. Linear Hyperparameter tuning searches the + // values in the hyperparameter range by using a linear scale. Logarithmic + // Hyperparameter tuning searches the values in the hyperparameter range by using a + // logarithmic scale. Logarithmic scaling works only for ranges that have only + // values greater than 0. + ScalingType HyperParameterScalingType } // Defines the possible values for an integer hyperparameter. @@ -3722,18 +3722,18 @@ type KernelGatewayAppSettings struct { // Provides a breakdown of the number of objects labeled. type LabelCounters struct { - // The total number of objects labeled by automated data labeling. - MachineLabeled *int32 - // The total number of objects that could not be labeled due to an error. FailedNonRetryableError *int32 - // The total number of objects labeled. - TotalLabeled *int32 - // The total number of objects labeled by a human worker. HumanLabeled *int32 + // The total number of objects labeled by automated data labeling. + MachineLabeled *int32 + + // The total number of objects labeled. + TotalLabeled *int32 + // The total number of objects not yet labeled. Unlabeled *int32 } @@ -3741,14 +3741,14 @@ type LabelCounters struct { // Provides counts for human-labeled tasks in the labeling job. type LabelCountersForWorkteam struct { + // The total number of data objects labeled by a human worker. + HumanLabeled *int32 + // The total number of data objects that need to be labeled by a human worker. PendingHuman *int32 // The total number of tasks in the labeling job. Total *int32 - - // The total number of data objects labeled by a human worker. - HumanLabeled *int32 } // Provides configuration information for auto-labeling of your data objects. A @@ -3756,15 +3756,6 @@ type LabelCountersForWorkteam struct { // auto-labeling. type LabelingJobAlgorithmsConfig struct { - // At the end of an auto-label job Amazon SageMaker Ground Truth sends the Amazon - // Resource Nam (ARN) of the final model used for auto-labeling. You can use this - // model as the starting point for subsequent similar jobs by providing the ARN of - // the model here. - InitialActiveLearningModelArn *string - - // Provides configuration information for a labeling job. - LabelingJobResourceConfig *LabelingJobResourceConfig - // Specifies the Amazon Resource Name (ARN) of the algorithm used for // auto-labeling. You must select one of the following ARNs: // @@ -3786,6 +3777,15 @@ type LabelingJobAlgorithmsConfig struct { // // This member is required. LabelingJobAlgorithmSpecificationArn *string + + // At the end of an auto-label job Amazon SageMaker Ground Truth sends the Amazon + // Resource Nam (ARN) of the final model used for auto-labeling. You can use this + // model as the starting point for subsequent similar jobs by providing the ARN of + // the model here. + InitialActiveLearningModelArn *string + + // Provides configuration information for a labeling job. + LabelingJobResourceConfig *LabelingJobResourceConfig } // Attributes of the data specified by the customer. Use these to describe the data @@ -3808,8 +3808,10 @@ type LabelingJobDataSource struct { // Provides summary information for a work team. type LabelingJobForWorkteamSummary struct { - // Provides information about the progress of a labeling job. - LabelCounters *LabelCountersForWorkteam + // The date and time that the labeling job was created. + // + // This member is required. + CreationTime *time.Time // A unique identifier for a labeling job. You can use this to refer to a specific // labeling job. @@ -3817,21 +3819,19 @@ type LabelingJobForWorkteamSummary struct { // This member is required. JobReferenceCode *string - // The configured number of workers per data object. - NumberOfHumanWorkersPerDataObject *int32 - // // // This member is required. WorkRequesterAccountId *string - // The date and time that the labeling job was created. - // - // This member is required. - CreationTime *time.Time + // Provides information about the progress of a labeling job. + LabelCounters *LabelCountersForWorkteam // The name of the labeling job that the work team is assigned to. LabelingJobName *string + + // The configured number of workers per data object. + NumberOfHumanWorkersPerDataObject *int32 } // Input configuration information for a labeling job. @@ -3849,19 +3849,24 @@ type LabelingJobInputConfig struct { // Specifies the location of the output produced by the labeling job. type LabelingJobOutput struct { - // The Amazon Resource Name (ARN) for the most recent Amazon SageMaker model - // trained as part of automated data labeling. - FinalActiveLearningModelArn *string - // The Amazon S3 bucket location of the manifest file for labeled data. // // This member is required. OutputDatasetS3Uri *string + + // The Amazon Resource Name (ARN) for the most recent Amazon SageMaker model + // trained as part of automated data labeling. + FinalActiveLearningModelArn *string } // Output configuration information for a labeling job. type LabelingJobOutputConfig struct { + // The Amazon S3 location to write output data. + // + // This member is required. + S3OutputPath *string + // The AWS Key Management Service ID of the key used to encrypt the output data, if // any. If you use a KMS key ID or an alias of your master key, the Amazon // SageMaker execution role must include permissions to call kms:Encrypt. If you @@ -3878,11 +3883,6 @@ type LabelingJobOutputConfig struct { // (http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) in the // AWS Key Management Service Developer Guide. KmsKeyId *string - - // The Amazon S3 location to write output data. - // - // This member is required. - S3OutputPath *string } // Provides configuration information for labeling jobs. @@ -3917,11 +3917,11 @@ type LabelingJobS3DataSource struct { // client error message. type LabelingJobStoppingConditions struct { - // The maximum number of input data objects that should be labeled. - MaxPercentageOfInputDatasetLabeled *int32 - // The maximum number of objects that can be labeled by human workers. MaxHumanLabeledObjectCount *int32 + + // The maximum number of input data objects that should be labeled. + MaxPercentageOfInputDatasetLabeled *int32 } // Provides summary information about a labeling job. @@ -3932,38 +3932,30 @@ type LabelingJobSummary struct { // This member is required. CreationTime *time.Time - // The date and time that the job was last modified (timestamp). + // Counts showing the progress of the labeling job. // // This member is required. - LastModifiedTime *time.Time + LabelCounters *LabelCounters - // The current status of the labeling job. + // The Amazon Resource Name (ARN) assigned to the labeling job when it was created. // // This member is required. - LabelingJobStatus LabelingJobStatus - - // If the LabelingJobStatus field is Failed, this field contains a description of - // the error. - FailureReason *string - - // The Amazon Resource Name (ARN) of the Lambda function used to consolidate the - // annotations from individual workers into a label for a data object. For more - // information, see Annotation Consolidation - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-annotation-consolidation.html). - AnnotationConsolidationLambdaArn *string + LabelingJobArn *string - // Counts showing the progress of the labeling job. + // The name of the labeling job. // // This member is required. - LabelCounters *LabelCounters + LabelingJobName *string - // Input configuration for the labeling job. - InputConfig *LabelingJobInputConfig + // The current status of the labeling job. + // + // This member is required. + LabelingJobStatus LabelingJobStatus - // The name of the labeling job. + // The date and time that the job was last modified (timestamp). // // This member is required. - LabelingJobName *string + LastModifiedTime *time.Time // The Amazon Resource Name (ARN) of a Lambda function. The function is run before // each data object is sent to a worker. @@ -3976,10 +3968,18 @@ type LabelingJobSummary struct { // This member is required. WorkteamArn *string - // The Amazon Resource Name (ARN) assigned to the labeling job when it was created. - // - // This member is required. - LabelingJobArn *string + // The Amazon Resource Name (ARN) of the Lambda function used to consolidate the + // annotations from individual workers into a label for a data object. For more + // information, see Annotation Consolidation + // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-annotation-consolidation.html). + AnnotationConsolidationLambdaArn *string + + // If the LabelingJobStatus field is Failed, this field contains a description of + // the error. + FailureReason *string + + // Input configuration for the labeling job. + InputConfig *LabelingJobInputConfig // The location of the output produced by the labeling job. LabelingJobOutput *LabelingJobOutput @@ -4050,27 +4050,16 @@ type ModelArtifacts struct { // job invocation. type ModelClientConfig struct { - // The timeout value in seconds for an invocation request. - InvocationsTimeoutInSeconds *int32 - // The maximum number of retries when invocation requests are failing. InvocationsMaxRetries *int32 + + // The timeout value in seconds for an invocation request. + InvocationsTimeoutInSeconds *int32 } // Describes the Docker container for the model package. type ModelPackageContainerDefinition struct { - // The AWS Marketplace product ID of the model package. - ProductId *string - - // The Amazon S3 path where the model artifacts, which result from model training, - // are stored. This path must point to a single gzip compressed tar archive - // (.tar.gz suffix). - ModelDataUrl *string - - // The DNS host name for the Docker container. - ContainerHostname *string - // The Amazon EC2 Container Registry (Amazon ECR) path where inference code is // stored. If you are using your own custom algorithm instead of an algorithm // provided by Amazon SageMaker, the inference code must meet Amazon SageMaker @@ -4082,9 +4071,20 @@ type ModelPackageContainerDefinition struct { // This member is required. Image *string + // The DNS host name for the Docker container. + ContainerHostname *string + // An MD5 hash of the training algorithm that identifies the Docker image used for // training. ImageDigest *string + + // The Amazon S3 path where the model artifacts, which result from model training, + // are stored. This path must point to a single gzip compressed tar archive + // (.tar.gz suffix). + ModelDataUrl *string + + // The AWS Marketplace product ID of the model package. + ProductId *string } // Specifies the validation and image scan statuses of the model package. @@ -4102,9 +4102,6 @@ type ModelPackageStatusDetails struct { // Represents the overall status of a model package. type ModelPackageStatusItem struct { - // if the overall status is Failed, the reason for the failure. - FailureReason *string - // The name of the model package for which the overall status is being reported. // // This member is required. @@ -4114,33 +4111,36 @@ type ModelPackageStatusItem struct { // // This member is required. Status DetailedModelPackageStatus + + // if the overall status is Failed, the reason for the failure. + FailureReason *string } // Provides summary information about a model package. type ModelPackageSummary struct { - // The name of the model package. + // A timestamp that shows when the model package was created. // // This member is required. - ModelPackageName *string + CreationTime *time.Time // The Amazon Resource Name (ARN) of the model package. // // This member is required. ModelPackageArn *string - // A brief description of the model package. - ModelPackageDescription *string + // The name of the model package. + // + // This member is required. + ModelPackageName *string // The overall status of the model package. // // This member is required. ModelPackageStatus ModelPackageStatus - // A timestamp that shows when the model package was created. - // - // This member is required. - CreationTime *time.Time + // A brief description of the model package. + ModelPackageDescription *string } // Contains data, such as the inputs and targeted instance types that are used in @@ -4148,16 +4148,16 @@ type ModelPackageSummary struct { // profile is made available to your buyers on AWS Marketplace. type ModelPackageValidationProfile struct { - // The TransformJobDefinition object that describes the transform job used for the - // validation of the model package. + // The name of the profile for the model package. // // This member is required. - TransformJobDefinition *TransformJobDefinition + ProfileName *string - // The name of the profile for the model package. + // The TransformJobDefinition object that describes the transform job used for the + // validation of the model package. // // This member is required. - ProfileName *string + TransformJobDefinition *TransformJobDefinition } // Specifies batch transform jobs that Amazon SageMaker runs to validate your model @@ -4203,6 +4203,9 @@ type MonitoringAppSpecification struct { // This member is required. ImageUri *string + // An array of arguments for the container used to run the monitoring job. + ContainerArguments []*string + // Specifies the entrypoint for a container used to run the monitoring job. ContainerEntrypoint []*string @@ -4210,9 +4213,6 @@ type MonitoringAppSpecification struct { // Applicable only for the built-in (first party) containers. PostAnalyticsProcessorSourceUri *string - // An array of arguments for the container used to run the monitoring job. - ContainerArguments []*string - // An Amazon S3 URI to a script that is called per row prior to running analysis. // It can base64 decode the payload and convert it into a flatted json so that the // built-in container can use the converted data. Applicable only for the built-in @@ -4225,13 +4225,13 @@ type MonitoringAppSpecification struct { // series of jobs scheduled to collect data periodically. type MonitoringBaselineConfig struct { - // The baseline statistics file in Amazon S3 that the current monitoring job should - // be validated against. - StatisticsResource *MonitoringStatisticsResource - // The baseline constraint file in Amazon S3 that the current monitoring job should // validated against. ConstraintsResource *MonitoringConstraintsResource + + // The baseline statistics file in Amazon S3 that the current monitoring job should + // be validated against. + StatisticsResource *MonitoringStatisticsResource } // Configuration for the cluster used to run model monitoring jobs. @@ -4249,16 +4249,16 @@ type MonitoringClusterConfig struct { // This member is required. InstanceType ProcessingInstanceType - // The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to - // encrypt data on the storage volume attached to the ML compute instance(s) that - // run the model monitoring job. - VolumeKmsKeyId *string - // The size of the ML storage volume, in gigabytes, that you want to provision. You // must specify sufficient ML storage for your scenario. // // This member is required. VolumeSizeInGB *int32 + + // The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to + // encrypt data on the storage volume attached to the ML compute instance(s) that + // run the model monitoring job. + VolumeKmsKeyId *string } // The constraints resource for a monitoring job. @@ -4271,39 +4271,39 @@ type MonitoringConstraintsResource struct { // Summary of information about the last monitoring job to run. type MonitoringExecutionSummary struct { - // The time the monitoring job was scheduled. - // - // This member is required. - ScheduledTime *time.Time - - // The Amazon Resource Name (ARN) of the monitoring job. - ProcessingJobArn *string - - // The status of the monitoring job. + // The time at which the monitoring job was created. // // This member is required. - MonitoringExecutionStatus ExecutionStatus + CreationTime *time.Time // A timestamp that indicates the last time the monitoring job was modified. // // This member is required. LastModifiedTime *time.Time - // The time at which the monitoring job was created. + // The status of the monitoring job. // // This member is required. - CreationTime *time.Time + MonitoringExecutionStatus ExecutionStatus // The name of the monitoring schedule. // // This member is required. MonitoringScheduleName *string - // Contains the reason a monitoring job failed, if it failed. - FailureReason *string + // The time the monitoring job was scheduled. + // + // This member is required. + ScheduledTime *time.Time // The name of teh endpoint used to run the monitoring job. EndpointName *string + + // Contains the reason a monitoring job failed, if it failed. + FailureReason *string + + // The Amazon Resource Name (ARN) of the monitoring job. + ProcessingJobArn *string } // The inputs for a monitoring job. @@ -4318,6 +4318,17 @@ type MonitoringInput struct { // Defines the monitoring job. type MonitoringJobDefinition struct { + // Configures the monitoring job to run a specified Docker container image. + // + // This member is required. + MonitoringAppSpecification *MonitoringAppSpecification + + // The array of inputs for the monitoring job. Currently we support monitoring an + // Amazon SageMaker Endpoint. + // + // This member is required. + MonitoringInputs []*MonitoringInput + // The array of outputs from the monitoring job to be uploaded to Amazon Simple // Storage Service (Amazon S3). // @@ -4331,35 +4342,24 @@ type MonitoringJobDefinition struct { // This member is required. MonitoringResources *MonitoringResources - // Configures the monitoring job to run a specified Docker container image. - // - // This member is required. - MonitoringAppSpecification *MonitoringAppSpecification - // The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume // to perform tasks on your behalf. // // This member is required. RoleArn *string - // Sets the environment variables in the Docker container. - Environment map[string]*string - // Baseline configuration used to validate that the data conforms to the specified // constraints and statistics BaselineConfig *MonitoringBaselineConfig - // Specifies a time limit for how long the monitoring job is allowed to run. - StoppingCondition *MonitoringStoppingCondition - - // The array of inputs for the monitoring job. Currently we support monitoring an - // Amazon SageMaker Endpoint. - // - // This member is required. - MonitoringInputs []*MonitoringInput + // Sets the environment variables in the Docker container. + Environment map[string]*string // Specifies networking options for an monitoring job. NetworkConfig *NetworkConfig + + // Specifies a time limit for how long the monitoring job is allowed to run. + StoppingCondition *MonitoringStoppingCondition } // The output object for a monitoring job. @@ -4405,15 +4405,15 @@ type MonitoringS3Output struct { // This member is required. LocalPath *string - // Whether to upload the results of the monitoring job continuously or after the - // job completes. - S3UploadMode ProcessingS3UploadMode - // A URI that identifies the Amazon S3 storage location where Amazon SageMaker // saves the results of a monitoring job. // // This member is required. S3Uri *string + + // Whether to upload the results of the monitoring job continuously or after the + // job completes. + S3UploadMode ProcessingS3UploadMode } // Configures the monitoring schedule and defines the monitoring job. @@ -4431,33 +4431,33 @@ type MonitoringScheduleConfig struct { // Summarizes the monitoring schedule. type MonitoringScheduleSummary struct { - // The last time the monitoring schedule was modified. - // - // This member is required. - LastModifiedTime *time.Time - // The creation time of the monitoring schedule. // // This member is required. CreationTime *time.Time - // The name of the endpoint using the monitoring schedule. - EndpointName *string + // The last time the monitoring schedule was modified. + // + // This member is required. + LastModifiedTime *time.Time - // The status of the monitoring schedule. + // The Amazon Resource Name (ARN) of the monitoring schedule. // // This member is required. - MonitoringScheduleStatus ScheduleStatus + MonitoringScheduleArn *string // The name of the monitoring schedule. // // This member is required. MonitoringScheduleName *string - // The Amazon Resource Name (ARN) of the monitoring schedule. + // The status of the monitoring schedule. // // This member is required. - MonitoringScheduleArn *string + MonitoringScheduleStatus ScheduleStatus + + // The name of the endpoint using the monitoring schedule. + EndpointName *string } // The statistics resource for a monitoring job. @@ -4509,15 +4509,15 @@ type NestedFilters struct { // containers, and the VPC subnets and security groups to use for VPC-enabled jobs. type NetworkConfig struct { - // Whether to allow inbound and outbound network calls to and from the containers - // used for the processing job. - EnableNetworkIsolation *bool - // Whether to encrypt all communications between distributed processing jobs. // Choose True to encrypt communications. Encryption provides greater security for // distributed processing jobs, but the processing might take longer. EnableInterContainerTrafficEncryption *bool + // Whether to allow inbound and outbound network calls to and from the containers + // used for the processing job. + EnableNetworkIsolation *bool + // Specifies a VPC that your training jobs and hosted models have access to. // Control access to and from your training and model containers by configuring the // VPC. For more information, see Protect Endpoints by Using an Amazon Virtual @@ -4530,21 +4530,21 @@ type NetworkConfig struct { // Provides a summary of a notebook instance lifecycle configuration. type NotebookInstanceLifecycleConfigSummary struct { - // The name of the lifecycle configuration. - // - // This member is required. - NotebookInstanceLifecycleConfigName *string - // The Amazon Resource Name (ARN) of the lifecycle configuration. // // This member is required. NotebookInstanceLifecycleConfigArn *string - // A timestamp that tells when the lifecycle configuration was last modified. - LastModifiedTime *time.Time + // The name of the lifecycle configuration. + // + // This member is required. + NotebookInstanceLifecycleConfigName *string // A timestamp that tells when the lifecycle configuration was created. CreationTime *time.Time + + // A timestamp that tells when the lifecycle configuration was last modified. + LastModifiedTime *time.Time } // Contains the notebook instance lifecycle configuration script. Each lifecycle @@ -4568,6 +4568,26 @@ type NotebookInstanceLifecycleHook struct { // Provides summary information for an Amazon SageMaker notebook instance. type NotebookInstanceSummary struct { + // The Amazon Resource Name (ARN) of the notebook instance. + // + // This member is required. + NotebookInstanceArn *string + + // The name of the notebook instance that you want a summary for. + // + // This member is required. + NotebookInstanceName *string + + // An array of up to three Git repositories associated with the notebook instance. + // These can be either the names of Git repositories stored as resources in your + // account, or the URL of Git repositories in AWS CodeCommit + // (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any + // other Git repository. These repositories are cloned at the same level as the + // default repository of your notebook instance. For more information, see + // Associating Git Repositories with Amazon SageMaker Notebook Instances + // (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). + AdditionalCodeRepositories []*string + // A timestamp that shows when the notebook instance was created. CreationTime *time.Time @@ -4581,40 +4601,20 @@ type NotebookInstanceSummary struct { // (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). DefaultCodeRepository *string - // An array of up to three Git repositories associated with the notebook instance. - // These can be either the names of Git repositories stored as resources in your - // account, or the URL of Git repositories in AWS CodeCommit - // (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any - // other Git repository. These repositories are cloned at the same level as the - // default repository of your notebook instance. For more information, see - // Associating Git Repositories with Amazon SageMaker Notebook Instances - // (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). - AdditionalCodeRepositories []*string + // The type of ML compute instance that the notebook instance is running on. + InstanceType InstanceType // A timestamp that shows when the notebook instance was last modified. LastModifiedTime *time.Time - // The Amazon Resource Name (ARN) of the notebook instance. - // - // This member is required. - NotebookInstanceArn *string - - // The status of the notebook instance. - NotebookInstanceStatus NotebookInstanceStatus - // The name of a notebook instance lifecycle configuration associated with this // notebook instance. For information about notebook instance lifestyle // configurations, see Step 2.1: (Optional) Customize a Notebook Instance // (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html). NotebookInstanceLifecycleConfigName *string - // The name of the notebook instance that you want a summary for. - // - // This member is required. - NotebookInstanceName *string - - // The type of ML compute instance that the notebook instance is running on. - InstanceType InstanceType + // The status of the notebook instance. + NotebookInstanceStatus NotebookInstanceStatus // The URL that you use to connect to the Jupyter instance running in your notebook // instance. @@ -4634,15 +4634,15 @@ type NotificationConfiguration struct { // been evaluated by the tuning job and used in the hyperparameter tuning process. type ObjectiveStatusCounters struct { - // The number of training jobs that are in progress and pending evaluation of their - // final objective metric. - Pending *int32 - // The number of training jobs whose final objective metric was not evaluated and // used in the hyperparameter tuning process. This typically occurs when the // training job failed or did not emit an objective metric. Failed *int32 + // The number of training jobs that are in progress and pending evaluation of their + // final objective metric. + Pending *int32 + // The number of training jobs whose final objective metric was evaluated by the // hyperparameter tuning job and used in the hyperparameter tuning process. Succeeded *int32 @@ -4651,72 +4651,72 @@ type ObjectiveStatusCounters struct { // Use this parameter to configure your OIDC Identity Provider (IdP). type OidcConfig struct { - // The OIDC IdP logout endpoint used to configure your private workforce. + // The OIDC IdP authorization endpoint used to configure your private workforce. // // This member is required. - LogoutEndpoint *string + AuthorizationEndpoint *string - // The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private - // workforce. + // The OIDC IdP client ID used to configure your private workforce. // // This member is required. - JwksUri *string + ClientId *string - // The OIDC IdP token endpoint used to configure your private workforce. + // The OIDC IdP client secret used to configure your private workforce. // // This member is required. - TokenEndpoint *string + ClientSecret *string - // The OIDC IdP authorization endpoint used to configure your private workforce. + // The OIDC IdP issuer used to configure your private workforce. // // This member is required. - AuthorizationEndpoint *string + Issuer *string - // The OIDC IdP user information endpoint used to configure your private workforce. + // The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private + // workforce. // // This member is required. - UserInfoEndpoint *string + JwksUri *string - // The OIDC IdP client ID used to configure your private workforce. + // The OIDC IdP logout endpoint used to configure your private workforce. // // This member is required. - ClientId *string + LogoutEndpoint *string - // The OIDC IdP issuer used to configure your private workforce. + // The OIDC IdP token endpoint used to configure your private workforce. // // This member is required. - Issuer *string + TokenEndpoint *string - // The OIDC IdP client secret used to configure your private workforce. + // The OIDC IdP user information endpoint used to configure your private workforce. // // This member is required. - ClientSecret *string + UserInfoEndpoint *string } // Your Amazon Cognito workforce configuration. type OidcConfigForResponse struct { - // The OIDC IdP token endpoint used to configure your private workforce. - TokenEndpoint *string + // The OIDC IdP authorization endpoint used to configure your private workforce. + AuthorizationEndpoint *string - // The OIDC IdP logout endpoint used to configure your private workforce. - LogoutEndpoint *string + // The OIDC IdP client ID used to configure your private workforce. + ClientId *string + + // The OIDC IdP issuer used to configure your private workforce. + Issuer *string // The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private // workforce. JwksUri *string - // The OIDC IdP user information endpoint used to configure your private workforce. - UserInfoEndpoint *string - - // The OIDC IdP client ID used to configure your private workforce. - ClientId *string + // The OIDC IdP logout endpoint used to configure your private workforce. + LogoutEndpoint *string - // The OIDC IdP issuer used to configure your private workforce. - Issuer *string + // The OIDC IdP token endpoint used to configure your private workforce. + TokenEndpoint *string - // The OIDC IdP authorization endpoint used to configure your private workforce. - AuthorizationEndpoint *string + // The OIDC IdP user information endpoint used to configure your private workforce. + UserInfoEndpoint *string } // A list user groups that exist in your OIDC Identity Provider (IdP). One to ten @@ -4742,6 +4742,12 @@ type OidcMemberDefinition struct { // recommended to use for particular TargetPlatform. type OutputConfig struct { + // Identifies the S3 bucket where you want Amazon SageMaker to store the model + // artifacts. For example, s3://bucket-name/key-name-prefix. + // + // This member is required. + S3OutputLocation *string + // Specifies additional parameters for compiler options in JSON format. The // compiler options are TargetPlatform specific. It is required for NVIDIA // accelerators and highly recommended for CPU compliations. For any other cases, @@ -4790,11 +4796,11 @@ type OutputConfig struct { // with NEON support. CompilerOptions *string - // Identifies the S3 bucket where you want Amazon SageMaker to store the model - // artifacts. For example, s3://bucket-name/key-name-prefix. - // - // This member is required. - S3OutputLocation *string + // Identifies the target device or the machine learning instance that you want to + // run your model on after the compilation has completed. Alternatively, you can + // specify OS, architecture, and accelerator using TargetPlatform () fields. It can + // be used instead of TargetPlatform. + TargetDevice TargetDevice // Contains information about a target platform that you want your model to run on, // such as OS, architecture, and accelerators. It is an alternative of @@ -4824,18 +4830,18 @@ type OutputConfig struct { // * ARMv8 phone (CPU) "TargetPlatform": {"Os": "ANDROID", "Arch": "ARM64"}, // "CompilerOptions": {'ANDROID_PLATFORM': 29} TargetPlatform *TargetPlatform - - // Identifies the target device or the machine learning instance that you want to - // run your model on after the compilation has completed. Alternatively, you can - // specify OS, architecture, and accelerator using TargetPlatform () fields. It can - // be used instead of TargetPlatform. - TargetDevice TargetDevice } // Provides information about how to store model training results (model // artifacts). type OutputDataConfig struct { + // Identifies the S3 path where you want Amazon SageMaker to store the model + // artifacts. For example, s3://bucket-name/key-name-prefix. + // + // This member is required. + S3OutputPath *string + // The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to // encrypt the model artifacts at rest using Amazon S3 server-side encryption. The // KmsKeyId can be any of the following formats: @@ -4873,22 +4879,12 @@ type OutputDataConfig struct { // Key Policies in AWS KMS in the AWS Key Management Service Developer // Guide.

    KmsKeyId *string - - // Identifies the S3 path where you want Amazon SageMaker to store the model - // artifacts. For example, s3://bucket-name/key-name-prefix. - // - // This member is required. - S3OutputPath *string } // Defines the possible values for categorical, continuous, and integer // hyperparameters to be used by an algorithm. type ParameterRange struct { - // A IntegerParameterRangeSpecification object that defines the possible values for - // an integer hyperparameter. - IntegerParameterRangeSpecification *IntegerParameterRangeSpecification - // A CategoricalParameterRangeSpecification object that defines the possible values // for a categorical hyperparameter. CategoricalParameterRangeSpecification *CategoricalParameterRangeSpecification @@ -4896,6 +4892,10 @@ type ParameterRange struct { // A ContinuousParameterRangeSpecification object that defines the possible values // for a continuous hyperparameter. ContinuousParameterRangeSpecification *ContinuousParameterRangeSpecification + + // A IntegerParameterRangeSpecification object that defines the possible values for + // an integer hyperparameter. + IntegerParameterRangeSpecification *IntegerParameterRangeSpecification } // Specifies ranges of integer, continuous, and categorical hyperparameters that a @@ -4951,6 +4951,11 @@ type ProcessingClusterConfig struct { // This member is required. InstanceCount *int32 + // The ML compute instance type for the processing job. + // + // This member is required. + InstanceType ProcessingInstanceType + // The size of the ML storage volume in gigabytes that you want to provision. You // must specify sufficient ML storage for your scenario. // @@ -4961,11 +4966,6 @@ type ProcessingClusterConfig struct { // encrypt data on the storage volume attached to the ML compute instance(s) that // run the processing job. VolumeKmsKeyId *string - - // The ML compute instance type for the processing job. - // - // This member is required. - InstanceType ProcessingInstanceType } // The inputs for a processing job. @@ -4987,32 +4987,22 @@ type ProcessingInput struct { // (https://docs.aws.amazon.com/sagemaker/latest/dg/processing-job.html). type ProcessingJob struct { - // For each input, data is downloaded from S3 into the processing container before - // the processing job begins running if "S3InputMode" is set to File. - ProcessingInputs []*ProcessingInput - - // The name of the processing job. - ProcessingJobName *string - - // The ARN of the role used to create the processing job. - RoleArn *string - - // The output configuration for the processing job. - ProcessingOutputConfig *ProcessingOutputConfig + // Configuration to run a processing job in a specified container image. + AppSpecification *AppSpecification - // The ARN of the training job associated with this processing job. - TrainingJobArn *string + // The Amazon Resource Name (ARN) of the AutoML job associated with this processing + // job. + AutoMLJobArn *string - // Networking options for a job, such as network traffic encryption between - // containers, whether to allow inbound and outbound network calls to and from - // containers, and the VPC subnets and security groups to use for VPC-enabled jobs. - NetworkConfig *NetworkConfig + // The time the processing job was created. + CreationTime *time.Time - // The time that the processing job ended. - ProcessingEndTime *time.Time + // Sets the environment variables in the Docker container. + Environment map[string]*string - // The ARN of the processing job. - ProcessingJobArn *string + // A string, up to one KB in size, that contains metadata from the processing + // container when the processing job exits. + ExitMessage *string // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: @@ -5025,78 +5015,73 @@ type ProcessingJob struct { // * CreateTransformJob () ExperimentConfig *ExperimentConfig - // The time that the processing job started. - ProcessingStartTime *time.Time + // A string, up to one KB in size, that contains the reason a processing job + // failed, if it failed. + FailureReason *string + + // The time the processing job was last modified. + LastModifiedTime *time.Time // The ARN of a monitoring schedule for an endpoint associated with this processing // job. MonitoringScheduleArn *string - // An array of key-value pairs. For more information, see Using Cost Allocation - // Tags - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) - // in the AWS Billing and Cost Management User Guide. - Tags []*Tag + // Networking options for a job, such as network traffic encryption between + // containers, whether to allow inbound and outbound network calls to and from + // containers, and the VPC subnets and security groups to use for VPC-enabled jobs. + NetworkConfig *NetworkConfig - // A string, up to one KB in size, that contains the reason a processing job - // failed, if it failed. - FailureReason *string + // The time that the processing job ended. + ProcessingEndTime *time.Time - // The Amazon Resource Name (ARN) of the AutoML job associated with this processing - // job. - AutoMLJobArn *string + // For each input, data is downloaded from S3 into the processing container before + // the processing job begins running if "S3InputMode" is set to File. + ProcessingInputs []*ProcessingInput - // Identifies the resources, ML compute instances, and ML storage volumes to deploy - // for a processing job. In distributed training, you specify more than one - // instance. - ProcessingResources *ProcessingResources + // The ARN of the processing job. + ProcessingJobArn *string - // A string, up to one KB in size, that contains metadata from the processing - // container when the processing job exits. - ExitMessage *string + // The name of the processing job. + ProcessingJobName *string // The status of the processing job. ProcessingJobStatus ProcessingJobStatus - // The time the processing job was last modified. - LastModifiedTime *time.Time + // The output configuration for the processing job. + ProcessingOutputConfig *ProcessingOutputConfig - // The time the processing job was created. - CreationTime *time.Time + // Identifies the resources, ML compute instances, and ML storage volumes to deploy + // for a processing job. In distributed training, you specify more than one + // instance. + ProcessingResources *ProcessingResources - // Sets the environment variables in the Docker container. - Environment map[string]*string + // The time that the processing job started. + ProcessingStartTime *time.Time - // Configuration to run a processing job in a specified container image. - AppSpecification *AppSpecification + // The ARN of the role used to create the processing job. + RoleArn *string // Specifies a time limit for how long the processing job is allowed to run. StoppingCondition *ProcessingStoppingCondition + + // An array of key-value pairs. For more information, see Using Cost Allocation + // Tags + // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) + // in the AWS Billing and Cost Management User Guide. + Tags []*Tag + + // The ARN of the training job associated with this processing job. + TrainingJobArn *string } // Summary of information about a processing job. type ProcessingJobSummary struct { - // A timestamp that indicates the last time the processing job was modified. - LastModifiedTime *time.Time - // The time at which the processing job was created. // // This member is required. CreationTime *time.Time - // The status of the processing job. - // - // This member is required. - ProcessingJobStatus ProcessingJobStatus - - // The time at which the processing job completed. - ProcessingEndTime *time.Time - - // An optional string, up to one KB in size, that contains metadata from the - // processing container when the processing job exits. - ExitMessage *string - // The Amazon Resource Name (ARN) of the processing job.. // // This member is required. @@ -5107,11 +5092,26 @@ type ProcessingJobSummary struct { // This member is required. ProcessingJobName *string - // A string, up to one KB in size, that contains the reason a processing job - // failed, if it failed. - FailureReason *string -} - + // The status of the processing job. + // + // This member is required. + ProcessingJobStatus ProcessingJobStatus + + // An optional string, up to one KB in size, that contains metadata from the + // processing container when the processing job exits. + ExitMessage *string + + // A string, up to one KB in size, that contains the reason a processing job + // failed, if it failed. + FailureReason *string + + // A timestamp that indicates the last time the processing job was modified. + LastModifiedTime *time.Time + + // The time at which the processing job completed. + ProcessingEndTime *time.Time +} + // Describes the results of a processing job. type ProcessingOutput struct { @@ -5156,6 +5156,13 @@ type ProcessingResources struct { // job. type ProcessingS3Input struct { + // The local path to the Amazon S3 bucket where you want Amazon SageMaker to + // download the inputs to run a processing job. LocalPath is an absolute path to + // the input data. + // + // This member is required. + LocalPath *string + // Whether you use an S3Prefix or a ManifestFile for the data type. If you choose // S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects // with the specified key name prefix for the processing job. If you choose @@ -5166,9 +5173,6 @@ type ProcessingS3Input struct { // This member is required. S3DataType ProcessingS3DataType - // Whether the data stored in Amazon S3 is FullyReplicated or ShardedByS3Key. - S3DataDistributionType ProcessingS3DataDistributionType - // Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies // the data from the input source onto the local Amazon Elastic Block Store (Amazon // EBS) volumes before starting your training algorithm. This is the most commonly @@ -5178,21 +5182,17 @@ type ProcessingS3Input struct { // This member is required. S3InputMode ProcessingS3InputMode - // Whether to use Gzip compression for Amazon S3 storage. - S3CompressionType ProcessingS3CompressionType - // The URI for the Amazon S3 storage where you want Amazon SageMaker to download // the artifacts needed to run a processing job. // // This member is required. S3Uri *string - // The local path to the Amazon S3 bucket where you want Amazon SageMaker to - // download the inputs to run a processing job. LocalPath is an absolute path to - // the input data. - // - // This member is required. - LocalPath *string + // Whether to use Gzip compression for Amazon S3 storage. + S3CompressionType ProcessingS3CompressionType + + // Whether the data stored in Amazon S3 is FullyReplicated or ShardedByS3Key. + S3DataDistributionType ProcessingS3DataDistributionType } // Information about where and how you want to store the results of an processing @@ -5233,38 +5233,38 @@ type ProcessingStoppingCondition struct { // distribute traffic among the models by specifying variant weights. type ProductionVariant struct { - // The name of the model that you want to host. This is the name that you specified - // when creating the model. + // Number of instances to launch initially. // // This member is required. - ModelName *string + InitialInstanceCount *int32 // The ML compute instance type. // // This member is required. InstanceType ProductionVariantInstanceType - // Number of instances to launch initially. + // The name of the model that you want to host. This is the name that you specified + // when creating the model. // // This member is required. - InitialInstanceCount *int32 + ModelName *string // The name of the production variant. // // This member is required. VariantName *string - // Determines initial traffic distribution among all of the models that you specify - // in the endpoint configuration. The traffic to a production variant is determined - // by the ratio of the VariantWeight to the sum of all VariantWeight values across - // all ProductionVariants. If unspecified, it defaults to 1.0. - InitialVariantWeight *float32 - // The size of the Elastic Inference (EI) instance to use for the production // variant. EI instances provide on-demand GPU computing for inference. For more // information, see Using Elastic Inference in Amazon SageMaker // (https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html). AcceleratorType ProductionVariantAcceleratorType + + // Determines initial traffic distribution among all of the models that you specify + // in the endpoint configuration. The traffic to a production variant is determined + // by the ratio of the VariantWeight to the sum of all VariantWeight values across + // all ProductionVariants. If unspecified, it defaults to 1.0. + InitialVariantWeight *float32 } // Describes weight and capacities for a production variant associated with an @@ -5273,10 +5273,6 @@ type ProductionVariant struct { // values. type ProductionVariantSummary struct { - // The requested weight, as specified in the UpdateEndpointWeightsAndCapacities - // request. - DesiredWeight *float32 - // The name of the variant. // // This member is required. @@ -5285,16 +5281,20 @@ type ProductionVariantSummary struct { // The number of instances associated with the variant. CurrentInstanceCount *int32 - // The number of instances requested in the UpdateEndpointWeightsAndCapacities - // request. - DesiredInstanceCount *int32 - // The weight associated with the variant. CurrentWeight *float32 // An array of DeployedImage objects that specify the Amazon EC2 Container Registry // paths of the inference images deployed on instances of this ProductionVariant. DeployedImages []*DeployedImage + + // The number of instances requested in the UpdateEndpointWeightsAndCapacities + // request. + DesiredInstanceCount *int32 + + // The requested weight, as specified in the UpdateEndpointWeightsAndCapacities + // request. + DesiredWeight *float32 } // Part of the SuggestionQuery type. Specifies a hint for retrieving property names @@ -5559,67 +5559,46 @@ type RenderableTask struct { // A description of an error that occurred while rendering the template. type RenderingError struct { - // A human-readable message describing the error. + // A unique identifier for a specific class of errors. // // This member is required. - Message *string + Code *string - // A unique identifier for a specific class of errors. + // A human-readable message describing the error. // // This member is required. - Code *string + Message *string } // The resolved attributes. type ResolvedAttributes struct { - // The problem type. - ProblemType ProblemType + // Applies a metric to minimize or maximize for the job's objective. + AutoMLJobObjective *AutoMLJobObjective // How long a job is allowed to run, or how many candidates a job is allowed to // generate. CompletionCriteria *AutoMLJobCompletionCriteria - // Applies a metric to minimize or maximize for the job's objective. - AutoMLJobObjective *AutoMLJobObjective + // The problem type. + ProblemType ProblemType } // Describes the resources, including ML compute instances and ML storage volumes, // to use for model training. type ResourceConfig struct { - // The AWS KMS key that Amazon SageMaker uses to encrypt data on the storage volume - // attached to the ML compute instance(s) that run the training job. Certain - // Nitro-based instances include local storage, dependent on the instance type. - // Local storage volumes are encrypted using a hardware module on the instance. You - // can't request a VolumeKmsKeyId when using an instance type with local storage. - // For a list of instance types that support local instance storage, see Instance - // Store Volumes - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes). - // For more information about local instance storage encryption, see SSD Instance - // Store Volumes - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html). - // The VolumeKmsKeyId can be in any of the following formats: - // - // * // KMS Key ID - // "1234abcd-12ab-34cd-56ef-1234567890ab" + // The number of ML compute instances to use. For distributed training, provide a + // value greater than 1. // - // * // Amazon Resource Name (ARN) of a - // KMS Key - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" - VolumeKmsKeyId *string + // This member is required. + InstanceCount *int32 // The ML compute instance type. // // This member is required. InstanceType TrainingInstanceType - // The number of ML compute instances to use. For distributed training, provide a - // value greater than 1. - // - // This member is required. - InstanceCount *int32 - // The size of the ML storage volume that you want to provision. ML storage volumes // store model artifacts and incremental states. Training algorithms might also use // the ML storage volume for scratch space. If you want to store the training data @@ -5636,22 +5615,43 @@ type ResourceConfig struct { // // This member is required. VolumeSizeInGB *int32 + + // The AWS KMS key that Amazon SageMaker uses to encrypt data on the storage volume + // attached to the ML compute instance(s) that run the training job. Certain + // Nitro-based instances include local storage, dependent on the instance type. + // Local storage volumes are encrypted using a hardware module on the instance. You + // can't request a VolumeKmsKeyId when using an instance type with local storage. + // For a list of instance types that support local instance storage, see Instance + // Store Volumes + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes). + // For more information about local instance storage encryption, see SSD Instance + // Store Volumes + // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html). + // The VolumeKmsKeyId can be in any of the following formats: + // + // * // KMS Key ID + // "1234abcd-12ab-34cd-56ef-1234567890ab" + // + // * // Amazon Resource Name (ARN) of a + // KMS Key + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + VolumeKmsKeyId *string } // Specifies the maximum number of training jobs and parallel training jobs that a // hyperparameter tuning job can launch. type ResourceLimits struct { - // The maximum number of concurrent training jobs that a hyperparameter tuning job - // can launch. + // The maximum number of training jobs that a hyperparameter tuning job can launch. // // This member is required. - MaxParallelTrainingJobs *int32 + MaxNumberOfTrainingJobs *int32 - // The maximum number of training jobs that a hyperparameter tuning job can launch. + // The maximum number of concurrent training jobs that a hyperparameter tuning job + // can launch. // // This member is required. - MaxNumberOfTrainingJobs *int32 + MaxParallelTrainingJobs *int32 } // The instance type and the Amazon Resource Name (ARN) of the SageMaker image @@ -5659,11 +5659,11 @@ type ResourceLimits struct { // notebooks. type ResourceSpec struct { - // The Amazon Resource Name (ARN) of the SageMaker image created on the instance. - SageMakerImageArn *string - // The instance type. InstanceType AppInstanceType + + // The Amazon Resource Name (ARN) of the SageMaker image created on the instance. + SageMakerImageArn *string } // The retention policy for data stored on an Amazon Elastic File System (EFS) @@ -5678,26 +5678,6 @@ type RetentionPolicy struct { // Describes the S3 data source. type S3DataSource struct { - // If you want Amazon SageMaker to replicate the entire dataset on each ML compute - // instance that is launched for model training, specify FullyReplicated. If you - // want Amazon SageMaker to replicate a subset of data on each ML compute instance - // that is launched for model training, specify ShardedByS3Key. If there are n ML - // compute instances launched for a training job, each instance gets approximately - // 1/n of the number of S3 objects. In this case, model training on each machine - // uses only the subset of training data. Don't choose more ML compute instances - // for training than available S3 objects. If you do, some nodes won't get any data - // and you will pay for nodes that aren't getting any training data. This applies - // in both File and Pipe modes. Keep this in mind when developing algorithms. In - // distributed training, where you use multiple ML compute EC2 instances, you might - // choose ShardedByS3Key. If the algorithm requires copying training data to the ML - // storage volume (when TrainingInputMode is set to File), this copies 1/n of the - // number of objects. - S3DataDistributionType S3DataDistribution - - // A list of one or more attribute names to use that are found in a specified - // augmented manifest file. - AttributeNames []*string - // If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker // uses all objects that match the specified key name prefix for model training. If // you choose ManifestFile, S3Uri identifies an object that is a manifest file @@ -5733,6 +5713,26 @@ type S3DataSource struct { // // This member is required. S3Uri *string + + // A list of one or more attribute names to use that are found in a specified + // augmented manifest file. + AttributeNames []*string + + // If you want Amazon SageMaker to replicate the entire dataset on each ML compute + // instance that is launched for model training, specify FullyReplicated. If you + // want Amazon SageMaker to replicate a subset of data on each ML compute instance + // that is launched for model training, specify ShardedByS3Key. If there are n ML + // compute instances launched for a training job, each instance gets approximately + // 1/n of the number of S3 objects. In this case, model training on each machine + // uses only the subset of training data. Don't choose more ML compute instances + // for training than available S3 objects. If you do, some nodes won't get any data + // and you will pay for nodes that aren't getting any training data. This applies + // in both File and Pipe modes. Keep this in mind when developing algorithms. In + // distributed training, where you use multiple ML compute EC2 instances, you might + // choose ShardedByS3Key. If the algorithm requires copying training data to the ML + // storage volume (when TrainingInputMode is set to File), this copies 1/n of the + // number of objects. + S3DataDistributionType S3DataDistribution } // Configuration details about the monitoring schedule. @@ -5786,8 +5786,8 @@ type SearchExpression struct { // A list of filter objects. Filters []*Filter - // A list of search expression objects. - SubExpressions []*SearchExpression + // A list of nested filter objects. + NestedFilters []*NestedFilters // A Boolean operator used to evaluate the search expression. If you want every // conditional statement in all lists to be satisfied for the entire search @@ -5796,24 +5796,24 @@ type SearchExpression struct { // value is And. Operator BooleanOperator - // A list of nested filter objects. - NestedFilters []*NestedFilters + // A list of search expression objects. + SubExpressions []*SearchExpression } // A single resource returned as part of the Search () API response. type SearchRecord struct { - // The properties of a trial. - Trial *Trial - // The properties of an experiment. Experiment *Experiment - // The properties of a trial component. - TrialComponent *TrialComponent - // The properties of a training job. TrainingJob *TrainingJob + + // The properties of a trial. + Trial *Trial + + // The properties of a trial component. + TrialComponent *TrialComponent } // An array element of DescribeTrainingJobResponse$SecondaryStatusTransitions (). @@ -5826,73 +5826,32 @@ type SearchRecord struct { // status. type SecondaryStatusTransition struct { - // A detailed description of the progress within a secondary status. Amazon - // SageMaker provides secondary statuses and status messages that apply to each of - // them: Starting + // A timestamp that shows when the training job transitioned to the current + // secondary status state. // - // * Starting the training job. + // This member is required. + StartTime *time.Time + + // Contains a secondary status information from a training job. Status might be one + // of the following secondary statuses: InProgress // - // * Launching requested ML - // instances. + // * Starting - Starting the + // training job. // - // * Insufficient capacity error from EC2 while launching - // instances, retrying! + // * Downloading - An optional stage for algorithms that support + // File training input mode. It indicates that data is being downloaded to the ML + // storage volumes. // - // * Launched instance was unhealthy, replacing it! + // * Training - Training is in progress. // + // * Uploading - + // Training is complete and the model artifacts are being uploaded to the S3 + // location. // - // * Preparing the instances for training. + // Completed // - // Training - // - // * Downloading the - // training image. - // - // * Training image download completed. Training in - // progress. - // - // Status messages are subject to change. Therefore, we recommend not - // including them in code that programmatically initiates actions. For examples, - // don't use status messages in if statements. To have an overview of your training - // job's progress, view TrainingJobStatus and SecondaryStatus in - // DescribeTrainingJob (), and StatusMessage together. For example, at the start of - // a training job, you might see the following: - // - // * TrainingJobStatus - - // InProgress - // - // * SecondaryStatus - Training - // - // * StatusMessage - Downloading - // the training image - StatusMessage *string - - // A timestamp that shows when the training job transitioned to the current - // secondary status state. - // - // This member is required. - StartTime *time.Time - - // Contains a secondary status information from a training job. Status might be one - // of the following secondary statuses: InProgress - // - // * Starting - Starting the - // training job. - // - // * Downloading - An optional stage for algorithms that support - // File training input mode. It indicates that data is being downloaded to the ML - // storage volumes. - // - // * Training - Training is in progress. - // - // * Uploading - - // Training is complete and the model artifacts are being uploaded to the S3 - // location. - // - // Completed - // - // * Completed - The training job has - // completed. + // * Completed - The training job has + // completed. // // Failed // @@ -5930,6 +5889,47 @@ type SecondaryStatusTransition struct { // status state into another secondary status state or when the training job has // ended. EndTime *time.Time + + // A detailed description of the progress within a secondary status. Amazon + // SageMaker provides secondary statuses and status messages that apply to each of + // them: Starting + // + // * Starting the training job. + // + // * Launching requested ML + // instances. + // + // * Insufficient capacity error from EC2 while launching + // instances, retrying! + // + // * Launched instance was unhealthy, replacing it! + // + // + // * Preparing the instances for training. + // + // Training + // + // * Downloading the + // training image. + // + // * Training image download completed. Training in + // progress. + // + // Status messages are subject to change. Therefore, we recommend not + // including them in code that programmatically initiates actions. For examples, + // don't use status messages in if statements. To have an overview of your training + // job's progress, view TrainingJobStatus and SecondaryStatus in + // DescribeTrainingJob (), and StatusMessage together. For example, at the start of + // a training job, you might see the following: + // + // * TrainingJobStatus - + // InProgress + // + // * SecondaryStatus - Training + // + // * StatusMessage - Downloading + // the training image + StatusMessage *string } // Specifies options when sharing an Amazon SageMaker Studio notebook. These @@ -5942,14 +5942,14 @@ type SharingSettings struct { // default is Disabled. NotebookOutputOption NotebookOutputOption - // When NotebookOutputOption is Allowed, the Amazon S3 bucket used to save the - // notebook cell output. If S3OutputPath isn't specified, a default bucket is used. - S3OutputPath *string - // When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS) // encryption key ID used to encrypt the notebook cell output in the Amazon S3 // bucket. S3KmsKeyId *string + + // When NotebookOutputOption is Allowed, the Amazon S3 bucket used to save the + // notebook cell output. If S3OutputPath isn't specified, a default bucket is used. + S3OutputPath *string } // A configuration for a shuffle option for input data in a channel. If you use @@ -6032,16 +6032,16 @@ type SourceIpConfig struct { // complete. type StoppingCondition struct { + // The maximum length of time, in seconds, that the training or compilation job can + // run. If job does not complete during this time, Amazon SageMaker ends the job. + // If value is not specified, default value is 1 day. The maximum value is 28 days. + MaxRuntimeInSeconds *int32 + // The maximum length of time, in seconds, how long you are willing to wait for a // managed spot training job to complete. It is the amount of time spent waiting // for Spot capacity plus the amount of time the training job runs. It must be // equal to or greater than MaxRuntimeInSeconds. MaxWaitTimeInSeconds *int32 - - // The maximum length of time, in seconds, that the training or compilation job can - // run. If job does not complete during this time, Amazon SageMaker ends the job. - // If value is not specified, default value is 1 day. The maximum value is 28 days. - MaxRuntimeInSeconds *int32 } // Describes a work team of a vendor that does the a labelling job. @@ -6052,15 +6052,15 @@ type SubscribedWorkteam struct { // This member is required. WorkteamArn *string - // The title of the service provided by the vendor in the Amazon Marketplace. - MarketplaceTitle *string - // Marketplace product listing ID. ListingId *string // The description of the vendor from the Amazon Marketplace. MarketplaceDescription *string + // The title of the service provided by the vendor in the Amazon Marketplace. + MarketplaceTitle *string + // The name of the vendor in the Amazon Marketplace. SellerName *string } @@ -6077,15 +6077,15 @@ type SuggestionQuery struct { // Describes a tag. type Tag struct { - // The tag value. + // The tag key. // // This member is required. - Value *string + Key *string - // The tag key. + // The tag value. // // This member is required. - Key *string + Value *string } // Contains information about a target platform that you want your model to run on, @@ -6093,6 +6093,24 @@ type Tag struct { // TargetDevice. type TargetPlatform struct { + // Specifies a target platform architecture. + // + // * X86_64: 64-bit version of the + // x86 instruction set. + // + // * X86: 32-bit version of the x86 instruction set. + // + // + // * ARM64: ARMv8 64-bit CPU. + // + // * ARM_EABIHF: ARMv7 32-bit, Hard Float. + // + // * + // ARM_EABI: ARMv7 32-bit, Soft Float. Used by Android 32-bit ARM platform. + // + // This member is required. + Arch TargetPlatformArch + // Specifies a target platform OS. // // * LINUX: Linux-based operating systems. @@ -6116,24 +6134,6 @@ type TargetPlatform struct { // * INTEL_GRAPHICS: // Integrated Intel graphics Accelerator TargetPlatformAccelerator - - // Specifies a target platform architecture. - // - // * X86_64: 64-bit version of the - // x86 instruction set. - // - // * X86: 32-bit version of the x86 instruction set. - // - // - // * ARM64: ARMv8 64-bit CPU. - // - // * ARM_EABIHF: ARMv7 32-bit, Hard Float. - // - // * - // ARM_EABI: ARMv7 32-bit, Soft Float. Used by Android 32-bit ARM platform. - // - // This member is required. - Arch TargetPlatformArch } // The TensorBoard app settings. @@ -6160,71 +6160,101 @@ type TensorBoardOutputConfig struct { // Contains information about a training job. type TrainingJob struct { - // Resources, including ML compute instances and ML storage volumes, that are - // configured for model training. - ResourceConfig *ResourceConfig + // Information about the algorithm used for training, and algorithm metadata. + AlgorithmSpecification *AlgorithmSpecification - // The S3 path where model artifacts that you configured when creating the job are - // stored. Amazon SageMaker creates subfolders for model artifacts. - OutputDataConfig *OutputDataConfig + // The Amazon Resource Name (ARN) of the job. + AutoMLJobArn *string - // Information about the Amazon S3 location that is configured for storing model - // artifacts. - ModelArtifacts *ModelArtifacts + // The billable time in seconds. + BillableTimeInSeconds *int32 + + // Contains information about the output location for managed spot training + // checkpoint data. + CheckpointConfig *CheckpointConfig + + // A timestamp that indicates when the training job was created. + CreationTime *time.Time + + // Configuration information for the debug hook parameters, collection + // configuration, and storage paths. + DebugHookConfig *DebugHookConfig + + // Information about the debug rule configuration. + DebugRuleConfigurations []*DebugRuleConfiguration // Information about the evaluation status of the rules for the training job. DebugRuleEvaluationStatuses []*DebugRuleEvaluationStatus - // A VpcConfig () object that specifies the VPC that this training job has access - // to. For more information, see Protect Training Jobs by Using an Amazon Virtual - // Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). - VpcConfig *VpcConfig + // To encrypt all communications between ML compute instances in distributed + // training, choose True. Encryption provides greater security for distributed + // training, but training might take longer. How long it takes depends on the + // amount of communication between compute instances, especially if you use a deep + // learning algorithm in distributed training. + EnableInterContainerTrafficEncryption *bool - // An array of Channel objects that describes each data input channel. - InputDataConfig []*Channel + // When true, enables managed spot training using Amazon EC2 Spot instances to run + // training jobs instead of on-demand instances. For more information, see Managed + // Spot Training + // (https://docs.aws.amazon.com/sagemaker/latest/dg/model-managed-spot-training.html). + EnableManagedSpotTraining *bool // If the TrainingJob was created with network isolation, the value is set to true. // If network isolation is enabled, nodes can't communicate beyond the VPC they run // in. EnableNetworkIsolation *bool - // Specifies a limit to how long a model training job can run. When the job reaches - // the time limit, Amazon SageMaker ends the training job. Use this API to cap - // model training costs. To stop a job, Amazon SageMaker sends the algorithm the - // SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use - // this 120-second window to save the model artifacts, so the results of training - // are not lost. - StoppingCondition *StoppingCondition + // Associates a SageMaker job as a trial component with an experiment and trial. + // Specified when you call the following APIs: + // + // * CreateProcessingJob () + // + // * + // CreateTrainingJob () + // + // * CreateTransformJob () + ExperimentConfig *ExperimentConfig - // An array of key-value pairs. For more information, see Using Cost Allocation - // Tags - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) - // in the AWS Billing and Cost Management User Guide. - Tags []*Tag + // If the training job failed, the reason it failed. + FailureReason *string - // Information about the debug rule configuration. - DebugRuleConfigurations []*DebugRuleConfiguration + // A list of final metric values that are set when the training job completes. Used + // only if the training job was configured to use metrics. + FinalMetricDataList []*MetricData - // The Amazon Resource Name (ARN) of the job. - AutoMLJobArn *string + // Algorithm-specific parameters. + HyperParameters map[string]*string - // Indicates the time when the training job starts on training instances. You are - // billed for the time interval between this time and the value of TrainingEndTime. - // The start time in CloudWatch Logs might be later than this time. The difference - // is due to the time it takes to download the training data and to the size of the - // training container. - TrainingStartTime *time.Time + // An array of Channel objects that describes each data input channel. + InputDataConfig []*Channel - // Information about the algorithm used for training, and algorithm metadata. - AlgorithmSpecification *AlgorithmSpecification + // The Amazon Resource Name (ARN) of the labeling job. + LabelingJobArn *string - // The name of the training job. - TrainingJobName *string + // A timestamp that indicates when the status of the training job was last + // modified. + LastModifiedTime *time.Time - // Provides detailed information about the state of the training job. For detailed - // information about the secondary status of the training job, see StatusMessage - // under SecondaryStatusTransition (). Amazon SageMaker provides primary statuses - // and secondary statuses that apply to each of them: InProgress + // Information about the Amazon S3 location that is configured for storing model + // artifacts. + ModelArtifacts *ModelArtifacts + + // The S3 path where model artifacts that you configured when creating the job are + // stored. Amazon SageMaker creates subfolders for model artifacts. + OutputDataConfig *OutputDataConfig + + // Resources, including ML compute instances and ML storage volumes, that are + // configured for model training. + ResourceConfig *ResourceConfig + + // The AWS Identity and Access Management (IAM) role configured for the training + // job. + RoleArn *string + + // Provides detailed information about the state of the training job. For detailed + // information about the secondary status of the training job, see StatusMessage + // under SecondaryStatusTransition (). Amazon SageMaker provides primary statuses + // and secondary statuses that apply to each of them: InProgress // // * Starting - // Starting the training job. @@ -6274,31 +6304,39 @@ type TrainingJob struct { // * DownloadingTrainingImage SecondaryStatus SecondaryStatus - // Algorithm-specific parameters. - HyperParameters map[string]*string - - // A list of final metric values that are set when the training job completes. Used - // only if the training job was configured to use metrics. - FinalMetricDataList []*MetricData - // A history of all of the secondary statuses that the training job has // transitioned through. SecondaryStatusTransitions []*SecondaryStatusTransition - // The billable time in seconds. - BillableTimeInSeconds *int32 + // Specifies a limit to how long a model training job can run. When the job reaches + // the time limit, Amazon SageMaker ends the training job. Use this API to cap + // model training costs. To stop a job, Amazon SageMaker sends the algorithm the + // SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use + // this 120-second window to save the model artifacts, so the results of training + // are not lost. + StoppingCondition *StoppingCondition - // Contains information about the output location for managed spot training - // checkpoint data. - CheckpointConfig *CheckpointConfig + // An array of key-value pairs. For more information, see Using Cost Allocation + // Tags + // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) + // in the AWS Billing and Cost Management User Guide. + Tags []*Tag - // Configuration information for the debug hook parameters, collection - // configuration, and storage paths. - DebugHookConfig *DebugHookConfig + // Configuration of storage locations for TensorBoard output. + TensorBoardOutputConfig *TensorBoardOutputConfig - // The AWS Identity and Access Management (IAM) role configured for the training - // job. - RoleArn *string + // Indicates the time when the training job ends on training instances. You are + // billed for the time interval between the value of TrainingStartTime and this + // time. For successful jobs and stopped jobs, this is the time after model + // artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker + // detects a job failure. + TrainingEndTime *time.Time + + // The Amazon Resource Name (ARN) of the training job. + TrainingJobArn *string + + // The name of the training job. + TrainingJobName *string // The status of the training job. Training job statuses are: // @@ -6321,81 +6359,29 @@ type TrainingJob struct { // information, see SecondaryStatus. TrainingJobStatus TrainingJobStatus - // When true, enables managed spot training using Amazon EC2 Spot instances to run - // training jobs instead of on-demand instances. For more information, see Managed - // Spot Training - // (https://docs.aws.amazon.com/sagemaker/latest/dg/model-managed-spot-training.html). - EnableManagedSpotTraining *bool - - // The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if - // the training job was launched by a hyperparameter tuning job. - TuningJobArn *string - - // If the training job failed, the reason it failed. - FailureReason *string - - // The Amazon Resource Name (ARN) of the labeling job. - LabelingJobArn *string - - // Associates a SageMaker job as a trial component with an experiment and trial. - // Specified when you call the following APIs: - // - // * CreateProcessingJob () - // - // * - // CreateTrainingJob () - // - // * CreateTransformJob () - ExperimentConfig *ExperimentConfig - - // A timestamp that indicates when the status of the training job was last - // modified. - LastModifiedTime *time.Time - - // A timestamp that indicates when the training job was created. - CreationTime *time.Time - - // Configuration of storage locations for TensorBoard output. - TensorBoardOutputConfig *TensorBoardOutputConfig + // Indicates the time when the training job starts on training instances. You are + // billed for the time interval between this time and the value of TrainingEndTime. + // The start time in CloudWatch Logs might be later than this time. The difference + // is due to the time it takes to download the training data and to the size of the + // training container. + TrainingStartTime *time.Time // The training time in seconds. TrainingTimeInSeconds *int32 - // To encrypt all communications between ML compute instances in distributed - // training, choose True. Encryption provides greater security for distributed - // training, but training might take longer. How long it takes depends on the - // amount of communication between compute instances, especially if you use a deep - // learning algorithm in distributed training. - EnableInterContainerTrafficEncryption *bool - - // The Amazon Resource Name (ARN) of the training job. - TrainingJobArn *string + // The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if + // the training job was launched by a hyperparameter tuning job. + TuningJobArn *string - // Indicates the time when the training job ends on training instances. You are - // billed for the time interval between the value of TrainingStartTime and this - // time. For successful jobs and stopped jobs, this is the time after model - // artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker - // detects a job failure. - TrainingEndTime *time.Time + // A VpcConfig () object that specifies the VPC that this training job has access + // to. For more information, see Protect Training Jobs by Using an Amazon Virtual + // Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). + VpcConfig *VpcConfig } // Defines the input needed to run a training job using the algorithm. type TrainingJobDefinition struct { - // The input mode used by the algorithm for the training job. For the input modes - // that Amazon SageMaker algorithms support, see Algorithms - // (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html). If an algorithm - // supports the File input mode, Amazon SageMaker downloads the training data from - // S3 to the provisioned ML storage Volume, and mounts the directory to docker - // volume for training container. If an algorithm supports the Pipe input mode, - // Amazon SageMaker streams data directly from S3 to the container. - // - // This member is required. - TrainingInputMode TrainingInputMode - - // The hyperparameters used for the training job. - HyperParameters map[string]*string - // An array of Channel objects, each of which specifies an input source. // // This member is required. @@ -6421,69 +6407,84 @@ type TrainingJobDefinition struct { // // This member is required. StoppingCondition *StoppingCondition + + // The input mode used by the algorithm for the training job. For the input modes + // that Amazon SageMaker algorithms support, see Algorithms + // (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html). If an algorithm + // supports the File input mode, Amazon SageMaker downloads the training data from + // S3 to the provisioned ML storage Volume, and mounts the directory to docker + // volume for training container. If an algorithm supports the Pipe input mode, + // Amazon SageMaker streams data directly from S3 to the container. + // + // This member is required. + TrainingInputMode TrainingInputMode + + // The hyperparameters used for the training job. + HyperParameters map[string]*string } // The numbers of training jobs launched by a hyperparameter tuning job, // categorized by status. type TrainingJobStatusCounters struct { - // The number of training jobs that failed, but can be retried. A failed training - // job can be retried only if it failed because an internal service error occurred. - RetryableError *int32 + // The number of completed training jobs launched by the hyperparameter tuning job. + Completed *int32 + + // The number of in-progress training jobs launched by a hyperparameter tuning job. + InProgress *int32 // The number of training jobs that failed and can't be retried. A failed training // job can't be retried if it failed because a client error occurred. NonRetryableError *int32 - // The number of completed training jobs launched by the hyperparameter tuning job. - Completed *int32 + // The number of training jobs that failed, but can be retried. A failed training + // job can be retried only if it failed because an internal service error occurred. + RetryableError *int32 // The number of training jobs launched by a hyperparameter tuning job that were // manually stopped. Stopped *int32 - - // The number of in-progress training jobs launched by a hyperparameter tuning job. - InProgress *int32 } // Provides summary information about a training job. type TrainingJobSummary struct { - // The status of the training job. + // A timestamp that shows when the training job was created. // // This member is required. - TrainingJobStatus TrainingJobStatus + CreationTime *time.Time // The Amazon Resource Name (ARN) of the training job. // // This member is required. TrainingJobArn *string - // A timestamp that shows when the training job ended. This field is set only if - // the training job has one of the terminal statuses (Completed, Failed, or - // Stopped). - TrainingEndTime *time.Time - - // Timestamp when the training job was last modified. - LastModifiedTime *time.Time - // The name of the training job that you want a summary for. // // This member is required. TrainingJobName *string - // A timestamp that shows when the training job was created. + // The status of the training job. // // This member is required. - CreationTime *time.Time + TrainingJobStatus TrainingJobStatus + + // Timestamp when the training job was last modified. + LastModifiedTime *time.Time + + // A timestamp that shows when the training job ended. This field is set only if + // the training job has one of the terminal statuses (Completed, Failed, or + // Stopped). + TrainingEndTime *time.Time } // Defines how the algorithm is used for a training job. type TrainingSpecification struct { - // A list of the metrics that the algorithm emits that can be used as the objective - // metric in a hyperparameter tuning job. - SupportedTuningJobObjectiveMetrics []*HyperParameterTuningJobObjective + // A list of the instance types that this algorithm can use for training. + // + // This member is required. + SupportedTrainingInstanceTypes []TrainingInstanceType // A list of ChannelSpecification objects, which specify the input sources to be // used by the algorithm. @@ -6491,33 +6492,32 @@ type TrainingSpecification struct { // This member is required. TrainingChannels []*ChannelSpecification - // Indicates whether the algorithm supports distributed training. If set to false, - // buyers can't request more than one instance during training. - SupportsDistributedTraining *bool + // The Amazon ECR registry path of the Docker image that contains the training + // algorithm. + // + // This member is required. + TrainingImage *string + + // A list of MetricDefinition objects, which are used for parsing metrics generated + // by the algorithm. + MetricDefinitions []*MetricDefinition // A list of the HyperParameterSpecification objects, that define the supported // hyperparameters. This is required if the algorithm supports automatic model // tuning.> SupportedHyperParameters []*HyperParameterSpecification - // A list of MetricDefinition objects, which are used for parsing metrics generated - // by the algorithm. - MetricDefinitions []*MetricDefinition + // A list of the metrics that the algorithm emits that can be used as the objective + // metric in a hyperparameter tuning job. + SupportedTuningJobObjectiveMetrics []*HyperParameterTuningJobObjective - // The Amazon ECR registry path of the Docker image that contains the training - // algorithm. - // - // This member is required. - TrainingImage *string + // Indicates whether the algorithm supports distributed training. If set to false, + // buyers can't request more than one instance during training. + SupportsDistributedTraining *bool // An MD5 hash of the training algorithm that identifies the Docker image used for // training. TrainingImageDigest *string - - // A list of the instance types that this algorithm can use for training. - // - // This member is required. - SupportedTrainingInstanceTypes []TrainingInstanceType } // Describes the location of the channel data. @@ -6533,17 +6533,17 @@ type TransformDataSource struct { // consumes it. type TransformInput struct { - // If your transform data is compressed, specify the compression type. Amazon - // SageMaker automatically decompresses the data for the transform job accordingly. - // The default value is None. - CompressionType CompressionType - // Describes the location of the channel data, which is, the S3 location of the // input data that the model can consume. // // This member is required. DataSource *TransformDataSource + // If your transform data is compressed, specify the compression type. Amazon + // SageMaker automatically decompresses the data for the transform job accordingly. + // The default value is None. + CompressionType CompressionType + // The multipurpose internet mail extension (MIME) type of the data. Amazon // SageMaker uses the MIME type with each http call to transfer data to the // transform job. @@ -6579,52 +6579,48 @@ type TransformInput struct { // (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html). type TransformJob struct { - // Describes the results of a transform job. - TransformOutput *TransformOutput + // The Amazon Resource Name (ARN) of the AutoML job that created the transform job. + AutoMLJobArn *string - // The name of the model associated with the transform job. - ModelName *string - - // The maximum allowed size of the payload, in MB. A payload is the data portion of - // a record (without metadata). The value in MaxPayloadInMB must be greater than, - // or equal to, the size of a single record. To estimate the size of a record in - // MB, divide the size of your dataset by the number of records. To ensure that the - // records fit within the maximum payload size, we recommend using a slightly - // larger value. The default value is 6 MB. For cases where the payload might be - // arbitrarily large and is transmitted using HTTP chunked encoding, set the value - // to 0. This feature works only in supported algorithms. Currently, SageMaker - // built-in algorithms do not support HTTP chunked encoding. - MaxPayloadInMB *int32 - - // The environment variables to set in the Docker container. We support up to 16 - // key and values entries in the map. - Environment map[string]*string + // Specifies the number of records to include in a mini-batch for an HTTP inference + // request. A record is a single unit of input data that inference can be made on. + // For example, a single line in a CSV file is a record. + BatchStrategy BatchStrategy // A timestamp that shows when the transform Job was created. CreationTime *time.Time - // Specifies the number of records to include in a mini-batch for an HTTP inference - // request. A record is a single unit of input data that inference can be made on. - // For example, a single line in a CSV file is a record. - BatchStrategy BatchStrategy - - // The name of the transform job. - TransformJobName *string + // The data structure used to specify the data to be used for inference in a batch + // transform job and to associate the data that is relevant to the prediction + // results in the output. The input filter provided allows you to exclude input + // data that is not needed for inference in a batch transform job. The output + // filter provided allows you to include input data relevant to interpreting the + // predictions in the output from the job. For more information, see Associate + // Prediction Results with their Corresponding Input Records + // (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html). + DataProcessing *DataProcessing - // A list of tags associated with the transform job. - Tags []*Tag + // The environment variables to set in the Docker container. We support up to 16 + // key and values entries in the map. + Environment map[string]*string - // Describes the resources, including ML instance types and ML instance count, to - // use for transform job. - TransformResources *TransformResources + // Associates a SageMaker job as a trial component with an experiment and trial. + // Specified when you call the following APIs: + // + // * CreateProcessingJob () + // + // * + // CreateTrainingJob () + // + // * CreateTransformJob () + ExperimentConfig *ExperimentConfig - // Indicates when the transform job starts on ML instances. You are billed for the - // time interval between this time and the value of TransformEndTime. - TransformStartTime *time.Time + // If the transform job failed, the reason it failed. + FailureReason *string - // Configures the timeout and maximum number of retries for processing a transform - // job invocation. - ModelClientConfig *ModelClientConfig + // The Amazon Resource Name (ARN) of the labeling job that created the transform + // job. + LabelingJobArn *string // The maximum number of parallel requests that can be sent to each instance in a // transform job. If MaxConcurrentTransforms is set to 0 or left unset, SageMaker @@ -6634,31 +6630,42 @@ type TransformJob struct { // MaxConcurrentTransforms. MaxConcurrentTransforms *int32 - // The Amazon Resource Name (ARN) of the labeling job that created the transform - // job. - LabelingJobArn *string + // The maximum allowed size of the payload, in MB. A payload is the data portion of + // a record (without metadata). The value in MaxPayloadInMB must be greater than, + // or equal to, the size of a single record. To estimate the size of a record in + // MB, divide the size of your dataset by the number of records. To ensure that the + // records fit within the maximum payload size, we recommend using a slightly + // larger value. The default value is 6 MB. For cases where the payload might be + // arbitrarily large and is transmitted using HTTP chunked encoding, set the value + // to 0. This feature works only in supported algorithms. Currently, SageMaker + // built-in algorithms do not support HTTP chunked encoding. + MaxPayloadInMB *int32 - // Associates a SageMaker job as a trial component with an experiment and trial. - // Specified when you call the following APIs: - // - // * CreateProcessingJob () - // - // * - // CreateTrainingJob () - // - // * CreateTransformJob () - ExperimentConfig *ExperimentConfig + // Configures the timeout and maximum number of retries for processing a transform + // job invocation. + ModelClientConfig *ModelClientConfig - // The Amazon Resource Name (ARN) of the AutoML job that created the transform job. - AutoMLJobArn *string + // The name of the model associated with the transform job. + ModelName *string - // If the transform job failed, the reason it failed. - FailureReason *string + // A list of tags associated with the transform job. + Tags []*Tag + + // Indicates when the transform job has been completed, or has stopped or failed. + // You are billed for the time interval between this time and the value of + // TransformStartTime. + TransformEndTime *time.Time // Describes the input source of a transform job and the way the transform job // consumes it. TransformInput *TransformInput + // The Amazon Resource Name (ARN) of the transform job. + TransformJobArn *string + + // The name of the transform job. + TransformJobName *string + // The status of the transform job. Transform job statuses are: // // * InProgress - @@ -6677,48 +6684,27 @@ type TransformJob struct { // stopped. TransformJobStatus TransformJobStatus - // The Amazon Resource Name (ARN) of the transform job. - TransformJobArn *string + // Describes the results of a transform job. + TransformOutput *TransformOutput - // Indicates when the transform job has been completed, or has stopped or failed. - // You are billed for the time interval between this time and the value of - // TransformStartTime. - TransformEndTime *time.Time + // Describes the resources, including ML instance types and ML instance count, to + // use for transform job. + TransformResources *TransformResources - // The data structure used to specify the data to be used for inference in a batch - // transform job and to associate the data that is relevant to the prediction - // results in the output. The input filter provided allows you to exclude input - // data that is not needed for inference in a batch transform job. The output - // filter provided allows you to include input data relevant to interpreting the - // predictions in the output from the job. For more information, see Associate - // Prediction Results with their Corresponding Input Records - // (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html). - DataProcessing *DataProcessing + // Indicates when the transform job starts on ML instances. You are billed for the + // time interval between this time and the value of TransformEndTime. + TransformStartTime *time.Time } // Defines the input needed to run a transform job using the inference // specification specified in the algorithm. type TransformJobDefinition struct { - // The environment variables to set in the Docker container. We support up to 16 - // key and values entries in the map. - Environment map[string]*string - - // A string that determines the number of records included in a single mini-batch. - // SingleRecord means only one record is used per mini-batch. MultiRecord means a - // mini-batch is set to contain as many records that can fit within the - // MaxPayloadInMB limit. - BatchStrategy BatchStrategy - // A description of the input source and the way the transform job consumes it. // // This member is required. TransformInput *TransformInput - // The maximum number of parallel requests that can be sent to each instance in a - // transform job. The default value is 1. - MaxConcurrentTransforms *int32 - // Identifies the Amazon S3 location where you want Amazon SageMaker to save the // results from the transform job. // @@ -6730,6 +6716,20 @@ type TransformJobDefinition struct { // This member is required. TransformResources *TransformResources + // A string that determines the number of records included in a single mini-batch. + // SingleRecord means only one record is used per mini-batch. MultiRecord means a + // mini-batch is set to contain as many records that can fit within the + // MaxPayloadInMB limit. + BatchStrategy BatchStrategy + + // The environment variables to set in the Docker container. We support up to 16 + // key and values entries in the map. + Environment map[string]*string + + // The maximum number of parallel requests that can be sent to each instance in a + // transform job. The default value is 1. + MaxConcurrentTransforms *int32 + // The maximum payload size allowed, in MB. A payload is the data portion of a // record (without metadata). MaxPayloadInMB *int32 @@ -6739,23 +6739,6 @@ type TransformJobDefinition struct { // returned as a list after in response to a ListTransformJobs () call. type TransformJobSummary struct { - // If the transform job failed, the reason it failed. - FailureReason *string - - // The status of the transform job. - // - // This member is required. - TransformJobStatus TransformJobStatus - - // Indicates when the transform job ends on compute instances. For successful jobs - // and stopped jobs, this is the exact time recorded after the results are - // uploaded. For failed jobs, this is when Amazon SageMaker detected that the job - // failed. - TransformEndTime *time.Time - - // Indicates when the transform job was last modified. - LastModifiedTime *time.Time - // A timestamp that shows when the transform Job was created. // // This member is required. @@ -6770,11 +6753,56 @@ type TransformJobSummary struct { // // This member is required. TransformJobName *string + + // The status of the transform job. + // + // This member is required. + TransformJobStatus TransformJobStatus + + // If the transform job failed, the reason it failed. + FailureReason *string + + // Indicates when the transform job was last modified. + LastModifiedTime *time.Time + + // Indicates when the transform job ends on compute instances. For successful jobs + // and stopped jobs, this is the exact time recorded after the results are + // uploaded. For failed jobs, this is when Amazon SageMaker detected that the job + // failed. + TransformEndTime *time.Time } // Describes the results of a transform job. type TransformOutput struct { + // The Amazon S3 path where you want Amazon SageMaker to store the results of the + // transform job. For example, s3://bucket-name/key-name-prefix. For every S3 + // object used as input for the transform job, batch transform stores the + // transformed data with an .out suffix in a corresponding subfolder in the + // location in the output prefix. For example, for the input data stored at + // s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform stores + // the transformed data at + // s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out. Batch + // transform doesn't upload partially processed objects. For an input S3 object + // that contains multiple records, it creates an .out file only if the transform + // job succeeds on the entire file. When the input contains multiple S3 objects, + // the batch transform job processes the listed S3 objects and uploads only the + // output for successfully processed objects. If any object fails in the transform + // job batch transform marks the job as failed to prompt investigation. + // + // This member is required. + S3OutputPath *string + + // The MIME type used to specify the output data. Amazon SageMaker uses the MIME + // type with each http call to transfer data from the transform job. + Accept *string + + // Defines how to assemble the results of the transform job as a single S3 object. + // Choose a format that is most convenient to you. To concatenate the results in + // binary format, specify None. To add a newline character at the end of every + // transformed record, specify Line. + AssembleWith AssemblyType + // The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to // encrypt the model artifacts at rest using Amazon S3 server-side encryption. The // KmsKeyId can be any of the following formats: @@ -6802,34 +6830,6 @@ type TransformOutput struct { // Key Policies in AWS KMS in the AWS Key Management Service Developer // Guide.

    KmsKeyId *string - - // Defines how to assemble the results of the transform job as a single S3 object. - // Choose a format that is most convenient to you. To concatenate the results in - // binary format, specify None. To add a newline character at the end of every - // transformed record, specify Line. - AssembleWith AssemblyType - - // The MIME type used to specify the output data. Amazon SageMaker uses the MIME - // type with each http call to transfer data from the transform job. - Accept *string - - // The Amazon S3 path where you want Amazon SageMaker to store the results of the - // transform job. For example, s3://bucket-name/key-name-prefix. For every S3 - // object used as input for the transform job, batch transform stores the - // transformed data with an .out suffix in a corresponding subfolder in the - // location in the output prefix. For example, for the input data stored at - // s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform stores - // the transformed data at - // s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out. Batch - // transform doesn't upload partially processed objects. For an input S3 object - // that contains multiple records, it creates an .out file only if the transform - // job succeeds on the entire file. When the input contains multiple S3 objects, - // the batch transform job processes the listed S3 objects and uploads only the - // output for successfully processed objects. If any object fails in the transform - // job batch transform marks the job as failed to prompt investigation. - // - // This member is required. - S3OutputPath *string } // Describes the resources, including ML instance types and ML instance count, to @@ -6842,6 +6842,13 @@ type TransformResources struct { // This member is required. InstanceCount *int32 + // The ML compute instance type for the transform job. If you are using built-in + // algorithms to transform moderately sized datasets, we recommend using + // ml.m4.xlarge or ml.m5.large instance types. + // + // This member is required. + InstanceType TransformInstanceType + // The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to // encrypt model data on the storage volume attached to the ML compute instance(s) // that run the batch transform job. The VolumeKmsKeyId can be any of the following @@ -6858,18 +6865,21 @@ type TransformResources struct { // * Alias name ARN: // arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias VolumeKmsKeyId *string - - // The ML compute instance type for the transform job. If you are using built-in - // algorithms to transform moderately sized datasets, we recommend using - // ml.m4.xlarge or ml.m5.large instance types. - // - // This member is required. - InstanceType TransformInstanceType } // Describes the S3 data source. type TransformS3DataSource struct { + // If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker + // uses all objects with the specified key name prefix for batch transform. If you + // choose ManifestFile, S3Uri identifies an object that is a manifest file + // containing a list of object keys that you want Amazon SageMaker to use for batch + // transform. The following values are compatible: ManifestFile, S3Prefix The + // following value is not compatible: AugmentedManifestFile + // + // This member is required. + S3DataType S3DataType + // Depending on the value specified for the S3DataType, identifies either a key // name prefix or a manifest. For example: // @@ -6889,85 +6899,82 @@ type TransformS3DataSource struct { // // This member is required. S3Uri *string - - // If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker - // uses all objects with the specified key name prefix for batch transform. If you - // choose ManifestFile, S3Uri identifies an object that is a manifest file - // containing a list of object keys that you want Amazon SageMaker to use for batch - // transform. The following values are compatible: ManifestFile, S3Prefix The - // following value is not compatible: AugmentedManifestFile - // - // This member is required. - S3DataType S3DataType } // The properties of a trial as returned by the Search () API. type Trial struct { - // The name of the experiment the trial is part of. - ExperimentName *string + // Information about the user who created or modified an experiment, trial, or + // trial component. + CreatedBy *UserContext // When the trial was created. CreationTime *time.Time - // The Amazon Resource Name (ARN) of the trial. - TrialArn *string - - // The name of the trial. - TrialName *string - - // The source of the trial. - Source *TrialSource - - // Who last modified the trial. - LastModifiedTime *time.Time - // The name of the trial as displayed. If DisplayName isn't specified, TrialName is // displayed. DisplayName *string + // The name of the experiment the trial is part of. + ExperimentName *string + // Information about the user who created or modified an experiment, trial, or // trial component. - CreatedBy *UserContext + LastModifiedBy *UserContext + + // Who last modified the trial. + LastModifiedTime *time.Time + + // The source of the trial. + Source *TrialSource // The list of tags that are associated with the trial. You can use Search () API // to search on the tags. Tags []*Tag + // The Amazon Resource Name (ARN) of the trial. + TrialArn *string + // A list of the components associated with the trial. For each component, a // summary of the component's properties is included. TrialComponentSummaries []*TrialComponentSimpleSummary - // Information about the user who created or modified an experiment, trial, or - // trial component. - LastModifiedBy *UserContext + // The name of the trial. + TrialName *string } // The properties of a trial component as returned by the Search () API. type TrialComponent struct { - // When the component ended. - EndTime *time.Time + // Information about the user who created or modified an experiment, trial, or + // trial component. + CreatedBy *UserContext // When the component was created. CreationTime *time.Time - // When the component was last modified. - LastModifiedTime *time.Time + // The name of the component as displayed. If DisplayName isn't specified, + // TrialComponentName is displayed. + DisplayName *string + + // When the component ended. + EndTime *time.Time + + // The input artifacts of the component. + InputArtifacts map[string]*TrialComponentArtifact // Information about the user who created or modified an experiment, trial, or // trial component. LastModifiedBy *UserContext - // The name of the trial component. - TrialComponentName *string + // When the component was last modified. + LastModifiedTime *time.Time // The metrics for the component. Metrics []*TrialComponentMetricSummary - // Information about the user who created or modified an experiment, trial, or - // trial component. - CreatedBy *UserContext + // The output artifacts of the component. + OutputArtifacts map[string]*TrialComponentArtifact // The hyperparameters of the component. Parameters map[string]*TrialComponentParameterValue @@ -6977,34 +6984,27 @@ type TrialComponent struct { // have any parents. Parents []*Parent - // The input artifacts of the component. - InputArtifacts map[string]*TrialComponentArtifact + // The Amazon Resource Name (ARN) and job type of the source of the component. + Source *TrialComponentSource + + // Details of the source of the component. + SourceDetail *TrialComponentSourceDetail // When the component started. StartTime *time.Time - // The Amazon Resource Name (ARN) of the trial component. - TrialComponentArn *string - - // Details of the source of the component. - SourceDetail *TrialComponentSourceDetail + // The status of the trial component. + Status *TrialComponentStatus // The list of tags that are associated with the component. You can use Search () // API to search on the tags. Tags []*Tag - // The Amazon Resource Name (ARN) and job type of the source of the component. - Source *TrialComponentSource - - // The name of the component as displayed. If DisplayName isn't specified, - // TrialComponentName is displayed. - DisplayName *string - - // The output artifacts of the component. - OutputArtifacts map[string]*TrialComponentArtifact + // The Amazon Resource Name (ARN) of the trial component. + TrialComponentArn *string - // The status of the trial component. - Status *TrialComponentStatus + // The name of the trial component. + TrialComponentName *string } // Represents an input or output artifact of a trial component. You specify @@ -7029,65 +7029,65 @@ type TrialComponentArtifact struct { // A summary of the metrics of a trial component. type TrialComponentMetricSummary struct { - // When the metric was last updated. - TimeStamp *time.Time + // The average value of the metric. + Avg *float64 - // The Amazon Resource Name (ARN) of the source. - SourceArn *string + // The number of samples used to generate the metric. + Count *int32 // The most recent value of the metric. Last *float64 - // The number of samples used to generate the metric. - Count *int32 + // The maximum value of the metric. + Max *float64 + + // The name of the metric. + MetricName *string // The minimum value of the metric. Min *float64 - // The average value of the metric. - Avg *float64 + // The Amazon Resource Name (ARN) of the source. + SourceArn *string // The standard deviation of the metric. StdDev *float64 - // The maximum value of the metric. - Max *float64 - - // The name of the metric. - MetricName *string + // When the metric was last updated. + TimeStamp *time.Time } // The value of a hyperparameter. Only one of NumberValue or StringValue can be // specified. This object is specified in the CreateTrialComponent () request. type TrialComponentParameterValue struct { - // The string value of a categorical hyperparameter. If you specify a value for - // this parameter, you can't specify the NumberValue parameter. - StringValue *string - // The numeric value of a numeric hyperparameter. If you specify a value for this // parameter, you can't specify the StringValue parameter. NumberValue *float64 + + // The string value of a categorical hyperparameter. If you specify a value for + // this parameter, you can't specify the NumberValue parameter. + StringValue *string } // A short summary of a trial component. type TrialComponentSimpleSummary struct { - // The Amazon Resource Name (ARN) and job type of the source of a trial component. - TrialComponentSource *TrialComponentSource + // Information about the user who created or modified an experiment, trial, or + // trial component. + CreatedBy *UserContext // When the component was created. CreationTime *time.Time - // The name of the trial component. - TrialComponentName *string - // The Amazon Resource Name (ARN) of the trial component. TrialComponentArn *string - // Information about the user who created or modified an experiment, trial, or - // trial component. - CreatedBy *UserContext + // The name of the trial component. + TrialComponentName *string + + // The Amazon Resource Name (ARN) and job type of the source of a trial component. + TrialComponentSource *TrialComponentSource } // The Amazon Resource Name (ARN) and job type of the source of a trial component. @@ -7122,93 +7122,93 @@ type TrialComponentSourceDetail struct { // The status of the trial component. type TrialComponentStatus struct { - // The status of the trial component. - PrimaryStatus TrialComponentPrimaryStatus - // If the component failed, a message describing why. Message *string + + // The status of the trial component. + PrimaryStatus TrialComponentPrimaryStatus } // A summary of the properties of a trial component. To get all the properties, // call the DescribeTrialComponent () API and provide the TrialComponentName. type TrialComponentSummary struct { - // The status of the component. States include: - // - // * InProgress - // - // * - // Completed - // - // * Failed - Status *TrialComponentStatus - - // Who last modified the component. - LastModifiedBy *UserContext - // Who created the component. CreatedBy *UserContext // When the component was created. CreationTime *time.Time + // The name of the component as displayed. If DisplayName isn't specified, + // TrialComponentName is displayed. + DisplayName *string + + // When the component ended. + EndTime *time.Time + + // Who last modified the component. + LastModifiedBy *UserContext + // When the component was last modified. LastModifiedTime *time.Time // When the component started. StartTime *time.Time - // The name of the trial component. - TrialComponentName *string - - // When the component ended. - EndTime *time.Time + // The status of the component. States include: + // + // * InProgress + // + // * + // Completed + // + // * Failed + Status *TrialComponentStatus // The ARN of the trial component. TrialComponentArn *string + // The name of the trial component. + TrialComponentName *string + // The Amazon Resource Name (ARN) and job type of the source of a trial component. TrialComponentSource *TrialComponentSource - - // The name of the component as displayed. If DisplayName isn't specified, - // TrialComponentName is displayed. - DisplayName *string } // The source of the trial. type TrialSource struct { - // The source job type. - SourceType *string - // The Amazon Resource Name (ARN) of the source. // // This member is required. SourceArn *string + + // The source job type. + SourceType *string } // A summary of the properties of a trial. To get the complete set of properties, // call the DescribeTrial () API and provide the TrialName. type TrialSummary struct { - // The name of the trial. - TrialName *string - - // The source of the trial. - TrialSource *TrialSource - // When the trial was created. CreationTime *time.Time + // The name of the trial as displayed. If DisplayName isn't specified, TrialName is + // displayed. + DisplayName *string + // When the trial was last modified. LastModifiedTime *time.Time // The Amazon Resource Name (ARN) of the trial. TrialArn *string - // The name of the trial as displayed. If DisplayName isn't specified, TrialName is - // displayed. - DisplayName *string + // The name of the trial. + TrialName *string + + // The source of the trial. + TrialSource *TrialSource } // The job completion criteria. @@ -7281,14 +7281,14 @@ type UiTemplateInfo struct { // Represents an amount of money in United States dollars/ type USD struct { + // The fractional portion, in cents, of the amount. + Cents *int32 + // The whole number of dollars in the amount. Dollars *int32 // Fractions of a cent, in tenths. TenthFractionsOfACent *int32 - - // The fractional portion, in cents, of the amount. - Cents *int32 } // Information about the user who created or modified an experiment, trial, or @@ -7298,21 +7298,18 @@ type UserContext struct { // The domain associated with the user. DomainId *string - // The name of the user's profile. - UserProfileName *string - // The Amazon Resource Name (ARN) of the user's profile. UserProfileArn *string + + // The name of the user's profile. + UserProfileName *string } // The user profile details. type UserProfileDetails struct { - // The user profile name. - UserProfileName *string - - // The status. - Status UserProfileStatus + // The creation time. + CreationTime *time.Time // The domain ID. DomainId *string @@ -7320,8 +7317,11 @@ type UserProfileDetails struct { // The last modified time. LastModifiedTime *time.Time - // The creation time. - CreationTime *time.Time + // The status. + Status UserProfileStatus + + // The user profile name. + UserProfileName *string } // A collection of settings. @@ -7333,17 +7333,17 @@ type UserSettings struct { // The Jupyter server's app settings. JupyterServerAppSettings *JupyterServerAppSettings - // The TensorBoard app settings. - TensorBoardAppSettings *TensorBoardAppSettings - // The kernel gateway app settings. KernelGatewayAppSettings *KernelGatewayAppSettings + // The security groups. + SecurityGroups []*string + // The sharing settings. SharingSettings *SharingSettings - // The security groups. - SecurityGroups []*string + // The TensorBoard app settings. + TensorBoardAppSettings *TensorBoardAppSettings } // Specifies a production variant property type for an Endpoint. If you are @@ -7379,6 +7379,12 @@ type VariantProperty struct { // (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). type VpcConfig struct { + // The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups + // for the VPC that is specified in the Subnets field. + // + // This member is required. + SecurityGroupIds []*string + // The ID of the subnets in the VPC to which you want to connect your training job // or model. For information about the availability of specific instance types, see // Supported Instance Types and Availability Zones @@ -7386,12 +7392,6 @@ type VpcConfig struct { // // This member is required. Subnets []*string - - // The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups - // for the VPC that is specified in the Subnets field. - // - // This member is required. - SecurityGroupIds []*string } // A single private workforce, which is automatically created when you create your @@ -7402,81 +7402,81 @@ type VpcConfig struct { // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html). type Workforce struct { - // The configuration of an OIDC Identity Provider (IdP) private workforce. - OidcConfig *OidcConfigForResponse + // The Amazon Resource Name (ARN) of the private workforce. + // + // This member is required. + WorkforceArn *string // The name of the private workforce. // // This member is required. WorkforceName *string + // The configuration of an Amazon Cognito workforce. A single Cognito workforce is + // created using and corresponds to a single Amazon Cognito user pool + // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html). + CognitoConfig *CognitoConfig + + // The date that the workforce is created. + CreateDate *time.Time + // The most recent date that was used to successfully add one or more IP address // ranges (CIDRs // (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html)) to a // private workforce's allow list. LastUpdatedDate *time.Time - // The subdomain for your OIDC Identity Provider. - SubDomain *string - - // The configuration of an Amazon Cognito workforce. A single Cognito workforce is - // created using and corresponds to a single Amazon Cognito user pool - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html). - CognitoConfig *CognitoConfig + // The configuration of an OIDC Identity Provider (IdP) private workforce. + OidcConfig *OidcConfigForResponse // A list of one to ten IP address ranges (CIDRs // (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html)) to be added // to the workforce allow list. SourceIpConfig *SourceIpConfig - // The date that the workforce is created. - CreateDate *time.Time - - // The Amazon Resource Name (ARN) of the private workforce. - // - // This member is required. - WorkforceArn *string + // The subdomain for your OIDC Identity Provider. + SubDomain *string } // Provides details about a labeling work team. type Workteam struct { - // The date and time that the work team was last updated (timestamp). - LastUpdatedDate *time.Time - - // The date and time that the work team was created (timestamp). - CreateDate *time.Time - - // The URI of the labeling job's user interface. Workers open this URI to start - // labeling your data objects. - SubDomain *string - // A description of the work team. // // This member is required. Description *string + // The Amazon Cognito user groups that make up the work team. + // + // This member is required. + MemberDefinitions []*MemberDefinition + // The Amazon Resource Name (ARN) that identifies the work team. // // This member is required. WorkteamArn *string - // The Amazon Marketplace identifier for a vendor's work team. - ProductListingIds []*string + // The name of the work team. + // + // This member is required. + WorkteamName *string + + // The date and time that the work team was created (timestamp). + CreateDate *time.Time + + // The date and time that the work team was last updated (timestamp). + LastUpdatedDate *time.Time // Configures SNS notifications of available or expiring work items for work teams. NotificationConfiguration *NotificationConfiguration - // The Amazon Resource Name (ARN) of the workforce. - WorkforceArn *string + // The Amazon Marketplace identifier for a vendor's work team. + ProductListingIds []*string - // The Amazon Cognito user groups that make up the work team. - // - // This member is required. - MemberDefinitions []*MemberDefinition + // The URI of the labeling job's user interface. Workers open this URI to start + // labeling your data objects. + SubDomain *string - // The name of the work team. - // - // This member is required. - WorkteamName *string + // The Amazon Resource Name (ARN) of the workforce. + WorkforceArn *string } diff --git a/service/sagemakera2iruntime/api_op_DescribeHumanLoop.go b/service/sagemakera2iruntime/api_op_DescribeHumanLoop.go index 71a62b741b1..ba1048f5618 100644 --- a/service/sagemakera2iruntime/api_op_DescribeHumanLoop.go +++ b/service/sagemakera2iruntime/api_op_DescribeHumanLoop.go @@ -66,30 +66,20 @@ type DescribeHumanLoopInput struct { type DescribeHumanLoopOutput struct { - // The status of the human loop. + // The creation time when Amazon Augmented AI created the human loop. // // This member is required. - HumanLoopStatus types.HumanLoopStatus - - // A failure code that identifies the type of failure. - FailureCode *string - - // An object that contains information about the output of the human loop. - HumanLoopOutput *types.HumanLoopOutput + CreationTime *time.Time - // The Amazon Resource Name (ARN) of the human loop. + // The Amazon Resource Name (ARN) of the flow definition. // // This member is required. - HumanLoopArn *string + FlowDefinitionArn *string - // The creation time when Amazon Augmented AI created the human loop. + // The Amazon Resource Name (ARN) of the human loop. // // This member is required. - CreationTime *time.Time - - // The reason why a human loop failed. The failure reason is returned when the - // status of the human loop is Failed. - FailureReason *string + HumanLoopArn *string // The name of the human loop. The name must be lowercase, unique within the Region // in your account, and can have up to 63 characters. Valid characters: a-z, 0-9, @@ -98,10 +88,20 @@ type DescribeHumanLoopOutput struct { // This member is required. HumanLoopName *string - // The Amazon Resource Name (ARN) of the flow definition. + // The status of the human loop. // // This member is required. - FlowDefinitionArn *string + HumanLoopStatus types.HumanLoopStatus + + // A failure code that identifies the type of failure. + FailureCode *string + + // The reason why a human loop failed. The failure reason is returned when the + // status of the human loop is Failed. + FailureReason *string + + // An object that contains information about the output of the human loop. + HumanLoopOutput *types.HumanLoopOutput // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sagemakera2iruntime/api_op_ListHumanLoops.go b/service/sagemakera2iruntime/api_op_ListHumanLoops.go index 7ed68ff3310..862528fbfe2 100644 --- a/service/sagemakera2iruntime/api_op_ListHumanLoops.go +++ b/service/sagemakera2iruntime/api_op_ListHumanLoops.go @@ -59,6 +59,11 @@ func (c *Client) ListHumanLoops(ctx context.Context, params *ListHumanLoopsInput type ListHumanLoopsInput struct { + // The Amazon Resource Name (ARN) of a flow definition. + // + // This member is required. + FlowDefinitionArn *string + // (Optional) The timestamp of the date when you want the human loops to begin in // ISO 8601 format. For example, 2020-02-24. CreationTimeAfter *time.Time @@ -75,11 +80,6 @@ type ListHumanLoopsInput struct { // A token to display the next page of results. NextToken *string - // The Amazon Resource Name (ARN) of a flow definition. - // - // This member is required. - FlowDefinitionArn *string - // Optional. The order for displaying results. Valid values: Ascending and // Descending. SortOrder types.SortOrder @@ -87,14 +87,14 @@ type ListHumanLoopsInput struct { type ListHumanLoopsOutput struct { - // A token to display the next page of results. - NextToken *string - // An array of objects that contain information about the human loops. // // This member is required. HumanLoopSummaries []*types.HumanLoopSummary + // A token to display the next page of results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemakera2iruntime/go.mod b/service/sagemakera2iruntime/go.mod index 8a86393ee85..4f4215f0c98 100644 --- a/service/sagemakera2iruntime/go.mod +++ b/service/sagemakera2iruntime/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/sagemakera2iruntime go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/sagemakera2iruntime/types/types.go b/service/sagemakera2iruntime/types/types.go index 9a622690da8..58fe1a7ad28 100644 --- a/service/sagemakera2iruntime/types/types.go +++ b/service/sagemakera2iruntime/types/types.go @@ -41,20 +41,20 @@ type HumanLoopOutput struct { // Summary information about the human loop. type HumanLoopSummary struct { - // The name of the human loop. - HumanLoopName *string + // When Amazon Augmented AI created the human loop. + CreationTime *time.Time + + // The reason why the human loop failed. A failure reason is returned when the + // status of the human loop is Failed. + FailureReason *string // The Amazon Resource Name (ARN) of the flow definition used to configure the // human loop. FlowDefinitionArn *string + // The name of the human loop. + HumanLoopName *string + // The status of the human loop. HumanLoopStatus HumanLoopStatus - - // When Amazon Augmented AI created the human loop. - CreationTime *time.Time - - // The reason why the human loop failed. A failure reason is returned when the - // status of the human loop is Failed. - FailureReason *string } diff --git a/service/sagemakerruntime/api_op_InvokeEndpoint.go b/service/sagemakerruntime/api_op_InvokeEndpoint.go index 8525f6e80fb..c48643c02e0 100644 --- a/service/sagemakerruntime/api_op_InvokeEndpoint.go +++ b/service/sagemakerruntime/api_op_InvokeEndpoint.go @@ -62,9 +62,6 @@ func (c *Client) InvokeEndpoint(ctx context.Context, params *InvokeEndpointInput type InvokeEndpointInput struct { - // The MIME type of the input data in the request body. - ContentType *string - // Provides input data, in the format specified in the ContentType request header. // Amazon SageMaker passes all of the data in the body to the model. // @@ -80,6 +77,9 @@ type InvokeEndpointInput struct { // The desired MIME type of the inference in the response. Accept *string + + // The MIME type of the input data in the request body. + ContentType *string } type InvokeEndpointOutput struct { @@ -89,12 +89,12 @@ type InvokeEndpointOutput struct { // This member is required. Body []byte - // Identifies the production variant that was invoked. - InvokedProductionVariant *string - // The MIME type of the inference returned in the response body. ContentType *string + // Identifies the production variant that was invoked. + InvokedProductionVariant *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sagemakerruntime/go.mod b/service/sagemakerruntime/go.mod index c455604880c..8889f958e0f 100644 --- a/service/sagemakerruntime/go.mod +++ b/service/sagemakerruntime/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/sagemakerruntime go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/savingsplans/api_op_CreateSavingsPlan.go b/service/savingsplans/api_op_CreateSavingsPlan.go index f89ee94ed60..2036127c06b 100644 --- a/service/savingsplans/api_op_CreateSavingsPlan.go +++ b/service/savingsplans/api_op_CreateSavingsPlan.go @@ -58,28 +58,28 @@ func (c *Client) CreateSavingsPlan(ctx context.Context, params *CreateSavingsPla type CreateSavingsPlanInput struct { - // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. - ClientToken *string + // The hourly commitment, in USD. This is a value between 0.001 and 1 million. You + // cannot specify more than three digits after the decimal point. + // + // This member is required. + Commitment *string // The ID of the offering. // // This member is required. SavingsPlanOfferingId *string - // The hourly commitment, in USD. This is a value between 0.001 and 1 million. You - // cannot specify more than three digits after the decimal point. - // - // This member is required. - Commitment *string + // Unique, case-sensitive identifier that you provide to ensure the idempotency of + // the request. + ClientToken *string + + // One or more tags. + Tags map[string]*string // The up-front payment amount. This is a whole number between 50 and 99 percent of // the total value of the Savings Plan. This parameter is supported only if the // payment option is Partial Upfront. UpfrontPaymentAmount *string - - // One or more tags. - Tags map[string]*string } type CreateSavingsPlanOutput struct { diff --git a/service/savingsplans/api_op_DescribeSavingsPlanRates.go b/service/savingsplans/api_op_DescribeSavingsPlanRates.go index e725ff9451d..d71388a270a 100644 --- a/service/savingsplans/api_op_DescribeSavingsPlanRates.go +++ b/service/savingsplans/api_op_DescribeSavingsPlanRates.go @@ -57,27 +57,24 @@ func (c *Client) DescribeSavingsPlanRates(ctx context.Context, params *DescribeS type DescribeSavingsPlanRatesInput struct { - // The maximum number of results to return with a single call. To retrieve - // additional results, make another call with the returned token value. - MaxResults *int32 - // The ID of the Savings Plan. // // This member is required. SavingsPlanId *string - // The token for the next page of results. - NextToken *string - // The filters. Filters []*types.SavingsPlanRateFilter + + // The maximum number of results to return with a single call. To retrieve + // additional results, make another call with the returned token value. + MaxResults *int32 + + // The token for the next page of results. + NextToken *string } type DescribeSavingsPlanRatesOutput struct { - // Information about the Savings Plans rates. - SearchResults []*types.SavingsPlanRate - // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string @@ -85,6 +82,9 @@ type DescribeSavingsPlanRatesOutput struct { // The ID of the Savings Plan. SavingsPlanId *string + // Information about the Savings Plans rates. + SearchResults []*types.SavingsPlanRate + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/savingsplans/api_op_DescribeSavingsPlans.go b/service/savingsplans/api_op_DescribeSavingsPlans.go index c767b6b25c9..cefec4601cf 100644 --- a/service/savingsplans/api_op_DescribeSavingsPlans.go +++ b/service/savingsplans/api_op_DescribeSavingsPlans.go @@ -56,24 +56,24 @@ func (c *Client) DescribeSavingsPlans(ctx context.Context, params *DescribeSavin type DescribeSavingsPlansInput struct { + // The filters. + Filters []*types.SavingsPlanFilter + // The maximum number of results to return with a single call. To retrieve // additional results, make another call with the returned token value. MaxResults *int32 + // The token for the next page of results. + NextToken *string + // The Amazon Resource Names (ARN) of the Savings Plans. SavingsPlanArns []*string // The IDs of the Savings Plans. SavingsPlanIds []*string - // The token for the next page of results. - NextToken *string - // The states. States []types.SavingsPlanState - - // The filters. - Filters []*types.SavingsPlanFilter } type DescribeSavingsPlansOutput struct { diff --git a/service/savingsplans/api_op_DescribeSavingsPlansOfferingRates.go b/service/savingsplans/api_op_DescribeSavingsPlansOfferingRates.go index d1551a2c479..85fbb47359b 100644 --- a/service/savingsplans/api_op_DescribeSavingsPlansOfferingRates.go +++ b/service/savingsplans/api_op_DescribeSavingsPlansOfferingRates.go @@ -56,47 +56,47 @@ func (c *Client) DescribeSavingsPlansOfferingRates(ctx context.Context, params * type DescribeSavingsPlansOfferingRatesInput struct { - // The services. - ServiceCodes []types.SavingsPlanRateServiceCode - - // The payment options. - SavingsPlanPaymentOptions []types.SavingsPlanPaymentOption - - // The AWS products. - Products []types.SavingsPlanProductType - - // The token for the next page of results. - NextToken *string - - // The IDs of the offerings. - SavingsPlanOfferingIds []*string + // The filters. + Filters []*types.SavingsPlanOfferingRateFilterElement // The maximum number of results to return with a single call. To retrieve // additional results, make another call with the returned token value. MaxResults *int32 - // The usage details of the line item in the billing report. - UsageTypes []*string + // The token for the next page of results. + NextToken *string // The specific AWS operation for the line item in the billing report. Operations []*string + // The AWS products. + Products []types.SavingsPlanProductType + + // The IDs of the offerings. + SavingsPlanOfferingIds []*string + + // The payment options. + SavingsPlanPaymentOptions []types.SavingsPlanPaymentOption + // The plan types. SavingsPlanTypes []types.SavingsPlanType - // The filters. - Filters []*types.SavingsPlanOfferingRateFilterElement + // The services. + ServiceCodes []types.SavingsPlanRateServiceCode + + // The usage details of the line item in the billing report. + UsageTypes []*string } type DescribeSavingsPlansOfferingRatesOutput struct { - // Information about the Savings Plans offering rates. - SearchResults []*types.SavingsPlanOfferingRate - // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string + // Information about the Savings Plans offering rates. + SearchResults []*types.SavingsPlanOfferingRate + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/savingsplans/api_op_DescribeSavingsPlansOfferings.go b/service/savingsplans/api_op_DescribeSavingsPlansOfferings.go index 1122791ed02..8b4a3b00ab6 100644 --- a/service/savingsplans/api_op_DescribeSavingsPlansOfferings.go +++ b/service/savingsplans/api_op_DescribeSavingsPlansOfferings.go @@ -56,32 +56,36 @@ func (c *Client) DescribeSavingsPlansOfferings(ctx context.Context, params *Desc type DescribeSavingsPlansOfferingsInput struct { - // The descriptions. - Descriptions []*string - - // The IDs of the offerings. - OfferingIds []*string - // The currencies. Currencies []types.CurrencyCode - // The usage details of the line item in the billing report. - UsageTypes []*string - - // The plan type. - PlanTypes []types.SavingsPlanType + // The descriptions. + Descriptions []*string // The durations, in seconds. Durations []*int64 - // The payment options. - PaymentOptions []types.SavingsPlanPaymentOption + // The filters. + Filters []*types.SavingsPlanOfferingFilterElement + + // The maximum number of results to return with a single call. To retrieve + // additional results, make another call with the returned token value. + MaxResults *int32 + + // The token for the next page of results. + NextToken *string + + // The IDs of the offerings. + OfferingIds []*string // The specific AWS operation for the line item in the billing report. Operations []*string - // The filters. - Filters []*types.SavingsPlanOfferingFilterElement + // The payment options. + PaymentOptions []types.SavingsPlanPaymentOption + + // The plan type. + PlanTypes []types.SavingsPlanType // The product type. ProductType types.SavingsPlanProductType @@ -89,12 +93,8 @@ type DescribeSavingsPlansOfferingsInput struct { // The services. ServiceCodes []*string - // The maximum number of results to return with a single call. To retrieve - // additional results, make another call with the returned token value. - MaxResults *int32 - - // The token for the next page of results. - NextToken *string + // The usage details of the line item in the billing report. + UsageTypes []*string } type DescribeSavingsPlansOfferingsOutput struct { diff --git a/service/savingsplans/api_op_TagResource.go b/service/savingsplans/api_op_TagResource.go index 8652c04a388..67d57cf4411 100644 --- a/service/savingsplans/api_op_TagResource.go +++ b/service/savingsplans/api_op_TagResource.go @@ -56,15 +56,15 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // One or more tags. For example, { "tags": {"key1":"value1", "key2":"value2"} }. + // The Amazon Resource Name (ARN) of the resource. // // This member is required. - Tags map[string]*string + ResourceArn *string - // The Amazon Resource Name (ARN) of the resource. + // One or more tags. For example, { "tags": {"key1":"value1", "key2":"value2"} }. // // This member is required. - ResourceArn *string + Tags map[string]*string } type TagResourceOutput struct { diff --git a/service/savingsplans/api_op_UntagResource.go b/service/savingsplans/api_op_UntagResource.go index f22e485ed7b..ceea2ee2faf 100644 --- a/service/savingsplans/api_op_UntagResource.go +++ b/service/savingsplans/api_op_UntagResource.go @@ -56,15 +56,15 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The tag keys. + // The Amazon Resource Name (ARN) of the resource. // // This member is required. - TagKeys []*string + ResourceArn *string - // The Amazon Resource Name (ARN) of the resource. + // The tag keys. // // This member is required. - ResourceArn *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/savingsplans/go.mod b/service/savingsplans/go.mod index d8765e5a8a7..365e95e0c72 100644 --- a/service/savingsplans/go.mod +++ b/service/savingsplans/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/savingsplans go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/savingsplans/types/types.go b/service/savingsplans/types/types.go index 40bc4dfd20e..fa7aadd8dbc 100644 --- a/service/savingsplans/types/types.go +++ b/service/savingsplans/types/types.go @@ -5,21 +5,21 @@ package types // Information about a Savings Plan offering. type ParentSavingsPlanOffering struct { + // The currency. + Currency CurrencyCode + // The duration, in seconds. DurationSeconds *int64 - // The description. - PlanDescription *string - // The ID of the offering. OfferingId *string - // The currency. - Currency CurrencyCode - // The payment option. PaymentOption SavingsPlanPaymentOption + // The description. + PlanDescription *string + // The plan type. PlanType SavingsPlanType } @@ -30,103 +30,103 @@ type SavingsPlan struct { // The hourly commitment, in USD. Commitment *string + // The currency. + Currency CurrencyCode + + // The description. + Description *string + + // The EC2 instance family. + Ec2InstanceFamily *string + // The end time. End *string - // The start time. - Start *string + // The ID of the offering. + OfferingId *string // The payment option. PaymentOption SavingsPlanPaymentOption - // The up-front payment amount. - UpfrontPaymentAmount *string + // The product types. + ProductTypes []SavingsPlanProductType - // One or more tags. - Tags map[string]*string + // The recurring payment amount. + RecurringPaymentAmount *string + + // The AWS Region. + Region *string // The Amazon Resource Name (ARN) of the Savings Plan. SavingsPlanArn *string - // The ID of the offering. - OfferingId *string - - // The description. - Description *string - - // The EC2 instance family. - Ec2InstanceFamily *string + // The ID of the Savings Plan. + SavingsPlanId *string - // The currency. - Currency CurrencyCode + // The plan type. + SavingsPlanType SavingsPlanType - // The AWS Region. - Region *string + // The start time. + Start *string // The state. State SavingsPlanState - // The product types. - ProductTypes []SavingsPlanProductType - - // The recurring payment amount. - RecurringPaymentAmount *string + // One or more tags. + Tags map[string]*string // The duration of the term, in seconds. TermDurationInSeconds *int64 - // The plan type. - SavingsPlanType SavingsPlanType - - // The ID of the Savings Plan. - SavingsPlanId *string + // The up-front payment amount. + UpfrontPaymentAmount *string } // Information about a filter. type SavingsPlanFilter struct { - // The filter value. - Values []*string - // The filter name. Name SavingsPlansFilterName + + // The filter value. + Values []*string } // Information about a Savings Plan offering. type SavingsPlanOffering struct { - // The plan type. - PlanType SavingsPlanType - - // The properties. - Properties []*SavingsPlanOfferingProperty + // The currency. + Currency CurrencyCode // The description. Description *string - // The product type. - ProductTypes []SavingsPlanProductType - - // The service. - ServiceCode *string - // The duration, in seconds. DurationSeconds *int64 + // The ID of the offering. + OfferingId *string + // The specific AWS operation for the line item in the billing report. Operation *string - // The usage details of the line item in the billing report. - UsageType *string - // The payment option. PaymentOption SavingsPlanPaymentOption - // The ID of the offering. - OfferingId *string + // The plan type. + PlanType SavingsPlanType - // The currency. - Currency CurrencyCode + // The product type. + ProductTypes []SavingsPlanProductType + + // The properties. + Properties []*SavingsPlanOfferingProperty + + // The service. + ServiceCode *string + + // The usage details of the line item in the billing report. + UsageType *string } // Information about a filter. @@ -142,49 +142,49 @@ type SavingsPlanOfferingFilterElement struct { // Information about a property. type SavingsPlanOfferingProperty struct { - // The property value. - Value *string - // The property name. Name SavingsPlanOfferingPropertyKey + + // The property value. + Value *string } // Information about a Savings Plan offering rate. type SavingsPlanOfferingRate struct { - // The service. - ServiceCode SavingsPlanRateServiceCode - // The specific AWS operation for the line item in the billing report. Operation *string - // The unit. - Unit SavingsPlanRateUnit + // The product type. + ProductType SavingsPlanProductType // The properties. Properties []*SavingsPlanOfferingRateProperty - // The usage details of the line item in the billing report. - UsageType *string + // The Savings Plan rate. + Rate *string // The Savings Plan offering. SavingsPlanOffering *ParentSavingsPlanOffering - // The product type. - ProductType SavingsPlanProductType + // The service. + ServiceCode SavingsPlanRateServiceCode - // The Savings Plan rate. - Rate *string + // The unit. + Unit SavingsPlanRateUnit + + // The usage details of the line item in the billing report. + UsageType *string } // Information about a filter. type SavingsPlanOfferingRateFilterElement struct { - // The filter values. - Values []*string - // The filter name. Name SavingsPlanRateFilterAttribute + + // The filter values. + Values []*string } // Information about a property. @@ -200,47 +200,47 @@ type SavingsPlanOfferingRateProperty struct { // Information about a Savings Plan rate. type SavingsPlanRate struct { - // The rate. - Rate *string - - // The usage details of the line item in the billing report. - UsageType *string - // The currency. Currency CurrencyCode - // The service. - ServiceCode SavingsPlanRateServiceCode - - // The unit. - Unit SavingsPlanRateUnit + // The specific AWS operation for the line item in the billing report. + Operation *string // The product type. ProductType SavingsPlanProductType - // The specific AWS operation for the line item in the billing report. - Operation *string - // The properties. Properties []*SavingsPlanRateProperty + + // The rate. + Rate *string + + // The service. + ServiceCode SavingsPlanRateServiceCode + + // The unit. + Unit SavingsPlanRateUnit + + // The usage details of the line item in the billing report. + UsageType *string } // Information about a filter. type SavingsPlanRateFilter struct { - // The filter values. - Values []*string - // The filter name. Name SavingsPlanRateFilterName + + // The filter values. + Values []*string } // Information about a property. type SavingsPlanRateProperty struct { - // The property value. - Value *string - // The property name. Name SavingsPlanRatePropertyKey + + // The property value. + Value *string } diff --git a/service/schemas/api_op_CreateDiscoverer.go b/service/schemas/api_op_CreateDiscoverer.go index 1ef146f47e5..fa49f38f2bc 100644 --- a/service/schemas/api_op_CreateDiscoverer.go +++ b/service/schemas/api_op_CreateDiscoverer.go @@ -57,22 +57,22 @@ func (c *Client) CreateDiscoverer(ctx context.Context, params *CreateDiscovererI type CreateDiscovererInput struct { - // A description for the discoverer. - Description *string - // The ARN of the event bus. // // This member is required. SourceArn *string + // A description for the discoverer. + Description *string + // Tags associated with the resource. Tags map[string]*string } type CreateDiscovererOutput struct { - // Tags associated with the resource. - Tags map[string]*string + // The description of the discoverer. + Description *string // The ARN of the discoverer. DiscovererArn *string @@ -80,15 +80,15 @@ type CreateDiscovererOutput struct { // The ID of the discoverer. DiscovererId *string - // The description of the discoverer. - Description *string - // The ARN of the event bus. SourceArn *string // The state of the discoverer. State types.DiscovererState + // Tags associated with the resource. + Tags map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/schemas/api_op_CreateRegistry.go b/service/schemas/api_op_CreateRegistry.go index 2d82c277533..fd96632ea66 100644 --- a/service/schemas/api_op_CreateRegistry.go +++ b/service/schemas/api_op_CreateRegistry.go @@ -56,16 +56,16 @@ func (c *Client) CreateRegistry(ctx context.Context, params *CreateRegistryInput type CreateRegistryInput struct { - // Tags to associate with the registry. - Tags map[string]*string - - // A description of the registry to be created. - Description *string - // The name of the registry. // // This member is required. RegistryName *string + + // A description of the registry to be created. + Description *string + + // Tags to associate with the registry. + Tags map[string]*string } type CreateRegistryOutput struct { @@ -76,12 +76,12 @@ type CreateRegistryOutput struct { // The ARN of the registry. RegistryArn *string - // Tags associated with the registry. - Tags map[string]*string - // The name of the registry. RegistryName *string + // Tags associated with the registry. + Tags map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/schemas/api_op_CreateSchema.go b/service/schemas/api_op_CreateSchema.go index b39d0842ca0..90deb9fd9e4 100644 --- a/service/schemas/api_op_CreateSchema.go +++ b/service/schemas/api_op_CreateSchema.go @@ -63,14 +63,16 @@ type CreateSchemaInput struct { // This member is required. Content *string + // The name of the registry. + // + // This member is required. + RegistryName *string + // The name of the schema. // // This member is required. SchemaName *string - // Tags associated with the schema. - Tags map[string]*string - // The type of schema. // // This member is required. @@ -79,37 +81,35 @@ type CreateSchemaInput struct { // A description of the schema. Description *string - // The name of the registry. - // - // This member is required. - RegistryName *string + // Tags associated with the schema. + Tags map[string]*string } type CreateSchemaOutput struct { - // The name of the schema. - SchemaName *string + // The description of the schema. + Description *string + + // The date and time that schema was modified. + LastModified *time.Time // The ARN of the schema. SchemaArn *string - // The date the schema version was created. - VersionCreatedDate *time.Time + // The name of the schema. + SchemaName *string // The version number of the schema SchemaVersion *string - // The description of the schema. - Description *string - - // The date and time that schema was modified. - LastModified *time.Time + // Key-value pairs associated with a resource. + Tags map[string]*string // The type of the schema. Type *string - // Key-value pairs associated with a resource. - Tags map[string]*string + // The date the schema version was created. + VersionCreatedDate *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/schemas/api_op_DeleteSchemaVersion.go b/service/schemas/api_op_DeleteSchemaVersion.go index 21960efe4fb..954ae96cc63 100644 --- a/service/schemas/api_op_DeleteSchemaVersion.go +++ b/service/schemas/api_op_DeleteSchemaVersion.go @@ -56,15 +56,15 @@ func (c *Client) DeleteSchemaVersion(ctx context.Context, params *DeleteSchemaVe type DeleteSchemaVersionInput struct { - // The name of the schema. + // The name of the registry. // // This member is required. - SchemaName *string + RegistryName *string - // The name of the registry. + // The name of the schema. // // This member is required. - RegistryName *string + SchemaName *string // The version number of the schema // diff --git a/service/schemas/api_op_DescribeCodeBinding.go b/service/schemas/api_op_DescribeCodeBinding.go index 37fd6b651d6..b9f9b0a0253 100644 --- a/service/schemas/api_op_DescribeCodeBinding.go +++ b/service/schemas/api_op_DescribeCodeBinding.go @@ -58,36 +58,36 @@ func (c *Client) DescribeCodeBinding(ctx context.Context, params *DescribeCodeBi type DescribeCodeBindingInput struct { - // Specifying this limits the results to only this schema version. - SchemaVersion *string - - // The name of the registry. + // The language of the code binding. // // This member is required. - RegistryName *string + Language *string - // The language of the code binding. + // The name of the registry. // // This member is required. - Language *string + RegistryName *string // The name of the schema. // // This member is required. SchemaName *string + + // Specifying this limits the results to only this schema version. + SchemaVersion *string } type DescribeCodeBindingOutput struct { - // The version number of the schema. - SchemaVersion *string - // The time and date that the code binding was created. CreationDate *time.Time // The date and time that code bindings were modified. LastModified *time.Time + // The version number of the schema. + SchemaVersion *string + // The current status of code binding generation. Status types.CodeGenerationStatus diff --git a/service/schemas/api_op_DescribeDiscoverer.go b/service/schemas/api_op_DescribeDiscoverer.go index 6461b5f1b52..817ae8e409e 100644 --- a/service/schemas/api_op_DescribeDiscoverer.go +++ b/service/schemas/api_op_DescribeDiscoverer.go @@ -65,24 +65,24 @@ type DescribeDiscovererInput struct { type DescribeDiscovererOutput struct { - // The state of the discoverer. - State types.DiscovererState - // The description of the discoverer. Description *string // The ARN of the discoverer. DiscovererArn *string - // Tags associated with the resource. - Tags map[string]*string - // The ID of the discoverer. DiscovererId *string // The ARN of the event bus. SourceArn *string + // The state of the discoverer. + State types.DiscovererState + + // Tags associated with the resource. + Tags map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/schemas/api_op_DescribeRegistry.go b/service/schemas/api_op_DescribeRegistry.go index f981b24a0ee..c64fa468cf3 100644 --- a/service/schemas/api_op_DescribeRegistry.go +++ b/service/schemas/api_op_DescribeRegistry.go @@ -64,9 +64,6 @@ type DescribeRegistryInput struct { type DescribeRegistryOutput struct { - // Tags associated with the registry. - Tags map[string]*string - // The description of the registry. Description *string @@ -76,6 +73,9 @@ type DescribeRegistryOutput struct { // The name of the registry. RegistryName *string + // Tags associated with the registry. + Tags map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/schemas/api_op_DescribeSchema.go b/service/schemas/api_op_DescribeSchema.go index 123b89de8af..4731f0e5f11 100644 --- a/service/schemas/api_op_DescribeSchema.go +++ b/service/schemas/api_op_DescribeSchema.go @@ -57,30 +57,30 @@ func (c *Client) DescribeSchema(ctx context.Context, params *DescribeSchemaInput type DescribeSchemaInput struct { - // Specifying this limits the results to only this schema version. - SchemaVersion *string + // The name of the registry. + // + // This member is required. + RegistryName *string // The name of the schema. // // This member is required. SchemaName *string - // The name of the registry. - // - // This member is required. - RegistryName *string + // Specifying this limits the results to only this schema version. + SchemaVersion *string } type DescribeSchemaOutput struct { - // The version number of the schema - SchemaVersion *string + // The source of the schema definition. + Content *string - // The type of the schema. - Type *string + // The description of the schema. + Description *string - // Tags associated with the resource. - Tags map[string]*string + // The date and time that schema was modified. + LastModified *time.Time // The ARN of the schema. SchemaArn *string @@ -88,14 +88,14 @@ type DescribeSchemaOutput struct { // The name of the schema. SchemaName *string - // The date and time that schema was modified. - LastModified *time.Time + // The version number of the schema + SchemaVersion *string - // The description of the schema. - Description *string + // Tags associated with the resource. + Tags map[string]*string - // The source of the schema definition. - Content *string + // The type of the schema. + Type *string // The date the schema version was created. VersionCreatedDate *time.Time diff --git a/service/schemas/api_op_GetCodeBindingSource.go b/service/schemas/api_op_GetCodeBindingSource.go index 285e3146ecb..6cd24a879b7 100644 --- a/service/schemas/api_op_GetCodeBindingSource.go +++ b/service/schemas/api_op_GetCodeBindingSource.go @@ -56,15 +56,15 @@ func (c *Client) GetCodeBindingSource(ctx context.Context, params *GetCodeBindin type GetCodeBindingSourceInput struct { - // The name of the registry. + // The language of the code binding. // // This member is required. - RegistryName *string + Language *string - // The language of the code binding. + // The name of the registry. // // This member is required. - Language *string + RegistryName *string // The name of the schema. // diff --git a/service/schemas/api_op_GetResourcePolicy.go b/service/schemas/api_op_GetResourcePolicy.go index a146c27a20f..81fe9aac13b 100644 --- a/service/schemas/api_op_GetResourcePolicy.go +++ b/service/schemas/api_op_GetResourcePolicy.go @@ -61,13 +61,13 @@ type GetResourcePolicyInput struct { type GetResourcePolicyOutput struct { - // The revision ID. - RevisionId *string - // The resource-based policy. // This value conforms to the media type: application/json Policy *string + // The revision ID. + RevisionId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/schemas/api_op_ListDiscoverers.go b/service/schemas/api_op_ListDiscoverers.go index 574d6b0b504..27a937fd2fe 100644 --- a/service/schemas/api_op_ListDiscoverers.go +++ b/service/schemas/api_op_ListDiscoverers.go @@ -55,12 +55,13 @@ func (c *Client) ListDiscoverers(ctx context.Context, params *ListDiscoverersInp } type ListDiscoverersInput struct { - Limit *int32 // Specifying this limits the results to only those discoverer IDs that start with // the specified prefix. DiscovererIdPrefix *string + Limit *int32 + // The token that specifies the next page of results to return. To request the // first page, leave NextToken empty. The token will expire in 24 hours, and cannot // be shared with other accounts. diff --git a/service/schemas/api_op_ListRegistries.go b/service/schemas/api_op_ListRegistries.go index 6f6496f40ef..47f578fd8e1 100644 --- a/service/schemas/api_op_ListRegistries.go +++ b/service/schemas/api_op_ListRegistries.go @@ -55,6 +55,7 @@ func (c *Client) ListRegistries(ctx context.Context, params *ListRegistriesInput } type ListRegistriesInput struct { + Limit *int32 // The token that specifies the next page of results to return. To request the // first page, leave NextToken empty. The token will expire in 24 hours, and cannot @@ -65,8 +66,6 @@ type ListRegistriesInput struct { // the specified prefix. RegistryNamePrefix *string - Limit *int32 - // Can be set to Local or AWS to limit responses to your custom registries, or the // ones provided by AWS. Scope *string @@ -74,14 +73,14 @@ type ListRegistriesInput struct { type ListRegistriesOutput struct { - // An array of registry summaries. - Registries []*types.RegistrySummary - // The token that specifies the next page of results to return. To request the // first page, leave NextToken empty. The token will expire in 24 hours, and cannot // be shared with other accounts. NextToken *string + // An array of registry summaries. + Registries []*types.RegistrySummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/schemas/api_op_ListSchemaVersions.go b/service/schemas/api_op_ListSchemaVersions.go index 02588bae5b1..3eadf2a2ac1 100644 --- a/service/schemas/api_op_ListSchemaVersions.go +++ b/service/schemas/api_op_ListSchemaVersions.go @@ -67,12 +67,12 @@ type ListSchemaVersionsInput struct { // This member is required. SchemaName *string + Limit *int32 + // The token that specifies the next page of results to return. To request the // first page, leave NextToken empty. The token will expire in 24 hours, and cannot // be shared with other accounts. NextToken *string - - Limit *int32 } type ListSchemaVersionsOutput struct { diff --git a/service/schemas/api_op_ListSchemas.go b/service/schemas/api_op_ListSchemas.go index 96562d20da4..d2be2755234 100644 --- a/service/schemas/api_op_ListSchemas.go +++ b/service/schemas/api_op_ListSchemas.go @@ -57,6 +57,13 @@ func (c *Client) ListSchemas(ctx context.Context, params *ListSchemasInput, optF type ListSchemasInput struct { + // The name of the registry. + // + // This member is required. + RegistryName *string + + Limit *int32 + // The token that specifies the next page of results to return. To request the // first page, leave NextToken empty. The token will expire in 24 hours, and cannot // be shared with other accounts. @@ -65,25 +72,18 @@ type ListSchemasInput struct { // Specifying this limits the results to only those schema names that start with // the specified prefix. SchemaNamePrefix *string - - // The name of the registry. - // - // This member is required. - RegistryName *string - - Limit *int32 } type ListSchemasOutput struct { - // An array of schema summaries. - Schemas []*types.SchemaSummary - // The token that specifies the next page of results to return. To request the // first page, leave NextToken empty. The token will expire in 24 hours, and cannot // be shared with other accounts. NextToken *string + // An array of schema summaries. + Schemas []*types.SchemaSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/schemas/api_op_PutCodeBinding.go b/service/schemas/api_op_PutCodeBinding.go index 4f532dc8ca3..815325f156b 100644 --- a/service/schemas/api_op_PutCodeBinding.go +++ b/service/schemas/api_op_PutCodeBinding.go @@ -58,14 +58,6 @@ func (c *Client) PutCodeBinding(ctx context.Context, params *PutCodeBindingInput type PutCodeBindingInput struct { - // Specifying this limits the results to only this schema version. - SchemaVersion *string - - // The name of the schema. - // - // This member is required. - SchemaName *string - // The language of the code binding. // // This member is required. @@ -75,6 +67,14 @@ type PutCodeBindingInput struct { // // This member is required. RegistryName *string + + // The name of the schema. + // + // This member is required. + SchemaName *string + + // Specifying this limits the results to only this schema version. + SchemaVersion *string } type PutCodeBindingOutput struct { diff --git a/service/schemas/api_op_PutResourcePolicy.go b/service/schemas/api_op_PutResourcePolicy.go index 45b16106687..7ba1437a67c 100644 --- a/service/schemas/api_op_PutResourcePolicy.go +++ b/service/schemas/api_op_PutResourcePolicy.go @@ -57,9 +57,6 @@ func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolic // The name of the policy. type PutResourcePolicyInput struct { - // The revision ID of the policy. - RevisionId *string - // The resource-based policy. // This value conforms to the media type: application/json // @@ -68,17 +65,20 @@ type PutResourcePolicyInput struct { // The name of the registry. RegistryName *string -} - -type PutResourcePolicyOutput struct { // The revision ID of the policy. RevisionId *string +} + +type PutResourcePolicyOutput struct { // The resource-based policy. // This value conforms to the media type: application/json Policy *string + // The revision ID of the policy. + RevisionId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/schemas/api_op_SearchSchemas.go b/service/schemas/api_op_SearchSchemas.go index 7d4555f7f56..c80f0b5e2df 100644 --- a/service/schemas/api_op_SearchSchemas.go +++ b/service/schemas/api_op_SearchSchemas.go @@ -68,12 +68,12 @@ type SearchSchemasInput struct { // This member is required. RegistryName *string + Limit *int32 + // The token that specifies the next page of results to return. To request the // first page, leave NextToken empty. The token will expire in 24 hours, and cannot // be shared with other accounts. NextToken *string - - Limit *int32 } type SearchSchemasOutput struct { diff --git a/service/schemas/api_op_StartDiscoverer.go b/service/schemas/api_op_StartDiscoverer.go index 942de3f4870..38eae673b02 100644 --- a/service/schemas/api_op_StartDiscoverer.go +++ b/service/schemas/api_op_StartDiscoverer.go @@ -65,12 +65,12 @@ type StartDiscovererInput struct { type StartDiscovererOutput struct { - // The state of the discoverer. - State types.DiscovererState - // The ID of the discoverer. DiscovererId *string + // The state of the discoverer. + State types.DiscovererState + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/schemas/api_op_StopDiscoverer.go b/service/schemas/api_op_StopDiscoverer.go index e51f9fa80b4..dafbdb87a8e 100644 --- a/service/schemas/api_op_StopDiscoverer.go +++ b/service/schemas/api_op_StopDiscoverer.go @@ -65,12 +65,12 @@ type StopDiscovererInput struct { type StopDiscovererOutput struct { - // The state of the discoverer. - State types.DiscovererState - // The ID of the discoverer. DiscovererId *string + // The state of the discoverer. + State types.DiscovererState + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/schemas/api_op_UpdateDiscoverer.go b/service/schemas/api_op_UpdateDiscoverer.go index 0e62c79dbe8..fa60bbb817f 100644 --- a/service/schemas/api_op_UpdateDiscoverer.go +++ b/service/schemas/api_op_UpdateDiscoverer.go @@ -57,34 +57,34 @@ func (c *Client) UpdateDiscoverer(ctx context.Context, params *UpdateDiscovererI type UpdateDiscovererInput struct { - // The description of the discoverer to update. - Description *string - // The ID of the discoverer. // // This member is required. DiscovererId *string + + // The description of the discoverer to update. + Description *string } type UpdateDiscovererOutput struct { - // Tags associated with the resource. - Tags map[string]*string - // The description of the discoverer. Description *string // The ARN of the discoverer. DiscovererArn *string - // The state of the discoverer. - State types.DiscovererState + // The ID of the discoverer. + DiscovererId *string // The ARN of the event bus. SourceArn *string - // The ID of the discoverer. - DiscovererId *string + // The state of the discoverer. + State types.DiscovererState + + // Tags associated with the resource. + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/schemas/api_op_UpdateRegistry.go b/service/schemas/api_op_UpdateRegistry.go index 5afae247dbc..130c2d19222 100644 --- a/service/schemas/api_op_UpdateRegistry.go +++ b/service/schemas/api_op_UpdateRegistry.go @@ -68,18 +68,18 @@ type UpdateRegistryInput struct { type UpdateRegistryOutput struct { - // The name of the registry. - RegistryName *string - - // Tags associated with the registry. - Tags map[string]*string - // The description of the registry. Description *string // The ARN of the registry. RegistryArn *string + // The name of the registry. + RegistryName *string + + // Tags associated with the registry. + Tags map[string]*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/schemas/api_op_UpdateSchema.go b/service/schemas/api_op_UpdateSchema.go index 3243bdc1ba2..71b601c9385 100644 --- a/service/schemas/api_op_UpdateSchema.go +++ b/service/schemas/api_op_UpdateSchema.go @@ -60,9 +60,6 @@ func (c *Client) UpdateSchema(ctx context.Context, params *UpdateSchemaInput, op type UpdateSchemaInput struct { - // The source of the schema definition. - Content *string - // The name of the registry. // // This member is required. @@ -73,14 +70,17 @@ type UpdateSchemaInput struct { // This member is required. SchemaName *string + // The ID of the client token. + ClientTokenId *string + + // The source of the schema definition. + Content *string + // The description of the schema. Description *string // The schema type for the events schema. Type types.Type - - // The ID of the client token. - ClientTokenId *string } type UpdateSchemaOutput struct { @@ -100,15 +100,15 @@ type UpdateSchemaOutput struct { // The version number of the schema SchemaVersion *string - // The date the schema version was created. - VersionCreatedDate *time.Time - // Key-value pairs associated with a resource. Tags map[string]*string // The type of the schema. Type *string + // The date the schema version was created. + VersionCreatedDate *time.Time + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/schemas/go.mod b/service/schemas/go.mod index 5c98de209c3..11121833552 100644 --- a/service/schemas/go.mod +++ b/service/schemas/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/schemas go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/schemas/types/types.go b/service/schemas/types/types.go index 0850c3b0bd2..23d65cc673b 100644 --- a/service/schemas/types/types.go +++ b/service/schemas/types/types.go @@ -8,20 +8,20 @@ import ( type DiscovererSummary struct { - // The state of the discoverer. - State DiscovererState + // The ARN of the discoverer. + DiscovererArn *string + + // The ID of the discoverer. + DiscovererId *string // The ARN of the event bus. SourceArn *string - // The ID of the discoverer. - DiscovererId *string + // The state of the discoverer. + State DiscovererState // Tags associated with the resource. Tags map[string]*string - - // The ARN of the discoverer. - DiscovererArn *string } type RegistrySummary struct { @@ -39,54 +39,54 @@ type RegistrySummary struct { // A summary of schema details. type SchemaSummary struct { - // The name of the schema. - SchemaName *string + // The date and time that schema was modified. + LastModified *time.Time // The ARN of the schema. SchemaArn *string - // The number of versions available for the schema. - VersionCount *int64 - - // The date and time that schema was modified. - LastModified *time.Time + // The name of the schema. + SchemaName *string // Tags associated with the schema. Tags map[string]*string + + // The number of versions available for the schema. + VersionCount *int64 } type SchemaVersionSummary struct { - // The version number of the schema. - SchemaVersion *string + // The ARN of the schema version. + SchemaArn *string // The name of the schema. SchemaName *string - // The ARN of the schema version. - SchemaArn *string + // The version number of the schema. + SchemaVersion *string } type SearchSchemaSummary struct { - // An array of schema version summaries. - SchemaVersions []*SearchSchemaVersionSummary - - // The name of the schema. - SchemaName *string + // The name of the registry. + RegistryName *string // The ARN of the schema. SchemaArn *string - // The name of the registry. - RegistryName *string + // The name of the schema. + SchemaName *string + + // An array of schema version summaries. + SchemaVersions []*SearchSchemaVersionSummary } type SearchSchemaVersionSummary struct { - // The version number of the schema - SchemaVersion *string - // The date the schema version was created. CreatedDate *time.Time + + // The version number of the schema + SchemaVersion *string } diff --git a/service/secretsmanager/api_op_CancelRotateSecret.go b/service/secretsmanager/api_op_CancelRotateSecret.go index d2f559aa815..91678ef6cb7 100644 --- a/service/secretsmanager/api_op_CancelRotateSecret.go +++ b/service/secretsmanager/api_op_CancelRotateSecret.go @@ -108,6 +108,12 @@ type CancelRotateSecretInput struct { type CancelRotateSecretOutput struct { + // The ARN of the secret for which rotation was canceled. + ARN *string + + // The friendly name of the secret for which rotation was canceled. + Name *string + // The unique identifier of the version of the secret created during the rotation. // This version might not be complete, and should be evaluated for possible // deletion. At the very least, you should remove the VersionStage value AWSPENDING @@ -115,12 +121,6 @@ type CancelRotateSecretOutput struct { // can block you from successfully starting future rotations. VersionId *string - // The ARN of the secret for which rotation was canceled. - ARN *string - - // The friendly name of the secret for which rotation was canceled. - Name *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/secretsmanager/api_op_CreateSecret.go b/service/secretsmanager/api_op_CreateSecret.go index 74564427221..76217292033 100644 --- a/service/secretsmanager/api_op_CreateSecret.go +++ b/service/secretsmanager/api_op_CreateSecret.go @@ -142,35 +142,6 @@ type CreateSecretInput struct { // This member is required. Name *string - // (Optional) Specifies text data that you want to encrypt and store in this new - // version of the secret. Either SecretString or SecretBinary must have a value, - // but not both. They cannot both be empty. If you create a secret by using the - // Secrets Manager console then Secrets Manager puts the protected secret text in - // only the SecretString parameter. The Secrets Manager console stores the - // information as a JSON structure of key/value pairs that the Lambda rotation - // function knows how to parse. For storing multiple values, we recommend that you - // use a JSON text string argument and specify key/value pairs. For information on - // how to format a JSON parameter for the various command line tool environments, - // see Using JSON for Parameters - // (https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json) - // in the AWS CLI User Guide. For example: - // {"username":"bob","password":"abc123xyz456"} If your command-line tool or SDK - // requires quotation marks around the parameter, you should use single quotes to - // avoid confusion with the double quotes required in the JSON text. - SecretString *string - - // (Optional) Specifies a user-provided description of the secret. - Description *string - - // (Optional) Specifies binary data that you want to encrypt and store in the new - // version of the secret. To use this parameter in the command-line tools, we - // recommend that you store your binary data in a file and then use the appropriate - // technique for your tool to pass the contents of the file as a parameter. Either - // SecretString or SecretBinary must have a value, but not both. They cannot both - // be empty. This parameter is not available using the Secrets Manager console. It - // can be accessed only by using the AWS CLI or one of the AWS SDKs. - SecretBinary []byte - // (Optional) If you include SecretString or SecretBinary, then an initial version // is created as part of the secret, and this parameter specifies a unique // identifier for the new version. If you use the AWS CLI or one of the AWS SDK to @@ -202,6 +173,9 @@ type CreateSecretInput struct { // This value becomes the VersionId of the new version. ClientRequestToken *string + // (Optional) Specifies a user-provided description of the secret. + Description *string + // (Optional) Specifies the ARN, Key ID, or alias of the AWS KMS customer master // key (CMK) to be used to encrypt the SecretString or SecretBinary values in the // versions stored in this secret. You can specify any of the supported ways to @@ -217,6 +191,32 @@ type CreateSecretInput struct { // the ARN in this field. KmsKeyId *string + // (Optional) Specifies binary data that you want to encrypt and store in the new + // version of the secret. To use this parameter in the command-line tools, we + // recommend that you store your binary data in a file and then use the appropriate + // technique for your tool to pass the contents of the file as a parameter. Either + // SecretString or SecretBinary must have a value, but not both. They cannot both + // be empty. This parameter is not available using the Secrets Manager console. It + // can be accessed only by using the AWS CLI or one of the AWS SDKs. + SecretBinary []byte + + // (Optional) Specifies text data that you want to encrypt and store in this new + // version of the secret. Either SecretString or SecretBinary must have a value, + // but not both. They cannot both be empty. If you create a secret by using the + // Secrets Manager console then Secrets Manager puts the protected secret text in + // only the SecretString parameter. The Secrets Manager console stores the + // information as a JSON structure of key/value pairs that the Lambda rotation + // function knows how to parse. For storing multiple values, we recommend that you + // use a JSON text string argument and specify key/value pairs. For information on + // how to format a JSON parameter for the various command line tool environments, + // see Using JSON for Parameters + // (https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json) + // in the AWS CLI User Guide. For example: + // {"username":"bob","password":"abc123xyz456"} If your command-line tool or SDK + // requires quotation marks around the parameter, you should use single quotes to + // avoid confusion with the double quotes required in the JSON text. + SecretString *string + // (Optional) Specifies a list of user-defined tags that are attached to the // secret. Each tag is a "Key" and "Value" pair of strings. This operation only // appends tags to the existing list of tags. To remove tags, you must use @@ -268,13 +268,6 @@ type CreateSecretInput struct { type CreateSecretOutput struct { - // The friendly name of the secret that you just created. - Name *string - - // The unique identifier associated with the version of the secret you just - // created. - VersionId *string - // The Amazon Resource Name (ARN) of the secret that you just created. Secrets // Manager automatically adds several random characters to the name at the end of // the ARN when you initially create a secret. This affects only the ARN and not @@ -284,6 +277,13 @@ type CreateSecretOutput struct { // ARNs are different. ARN *string + // The friendly name of the secret that you just created. + Name *string + + // The unique identifier associated with the version of the secret you just + // created. + VersionId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/secretsmanager/api_op_DeleteResourcePolicy.go b/service/secretsmanager/api_op_DeleteResourcePolicy.go index 6ab441c3647..9043ccc060b 100644 --- a/service/secretsmanager/api_op_DeleteResourcePolicy.go +++ b/service/secretsmanager/api_op_DeleteResourcePolicy.go @@ -95,12 +95,12 @@ type DeleteResourcePolicyInput struct { type DeleteResourcePolicyOutput struct { - // The friendly name of the secret that the resource-based policy was deleted for. - Name *string - // The ARN of the secret that the resource-based policy was deleted for. ARN *string + // The friendly name of the secret that the resource-based policy was deleted for. + Name *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/secretsmanager/api_op_DeleteSecret.go b/service/secretsmanager/api_op_DeleteSecret.go index a42ba2b78f1..fadb772d4d0 100644 --- a/service/secretsmanager/api_op_DeleteSecret.go +++ b/service/secretsmanager/api_op_DeleteSecret.go @@ -92,19 +92,6 @@ func (c *Client) DeleteSecret(ctx context.Context, params *DeleteSecretInput, op type DeleteSecretInput struct { - // (Optional) Specifies that the secret is to be deleted without any recovery - // window. You can't use both this parameter and the RecoveryWindowInDays parameter - // in the same API call. An asynchronous background process performs the actual - // deletion, so there can be a short delay before the operation completes. If you - // write code to delete and then immediately recreate a secret with the same name, - // ensure that your code includes appropriate back off and retry logic. Use this - // parameter with caution. This parameter causes the operation to skip the normal - // waiting period before the permanent deletion that AWS would normally impose with - // the RecoveryWindowInDays parameter. If you delete a secret with the - // ForceDeleteWithouRecovery parameter, then you have no opportunity to recover the - // secret. It is permanently lost. - ForceDeleteWithoutRecovery *bool - // Specifies the secret that you want to delete. You can specify either the Amazon // Resource Name (ARN) or the friendly name of the secret. If you specify an ARN, // we generally recommend that you specify a complete ARN. You can specify a @@ -126,6 +113,19 @@ type DeleteSecretInput struct { // This member is required. SecretId *string + // (Optional) Specifies that the secret is to be deleted without any recovery + // window. You can't use both this parameter and the RecoveryWindowInDays parameter + // in the same API call. An asynchronous background process performs the actual + // deletion, so there can be a short delay before the operation completes. If you + // write code to delete and then immediately recreate a secret with the same name, + // ensure that your code includes appropriate back off and retry logic. Use this + // parameter with caution. This parameter causes the operation to skip the normal + // waiting period before the permanent deletion that AWS would normally impose with + // the RecoveryWindowInDays parameter. If you delete a secret with the + // ForceDeleteWithouRecovery parameter, then you have no opportunity to recover the + // secret. It is permanently lost. + ForceDeleteWithoutRecovery *bool + // (Optional) Specifies the number of days that Secrets Manager waits before it can // delete the secret. You can't use both this parameter and the // ForceDeleteWithoutRecovery parameter in the same API call. This value can range @@ -138,14 +138,14 @@ type DeleteSecretOutput struct { // The ARN of the secret that is now scheduled for deletion. ARN *string - // The friendly name of the secret that is now scheduled for deletion. - Name *string - // The date and time after which this secret can be deleted by Secrets Manager and // can no longer be restored. This value is the date and time of the delete request // plus the number of days specified in RecoveryWindowInDays. DeletionDate *time.Time + // The friendly name of the secret that is now scheduled for deletion. + Name *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/secretsmanager/api_op_DescribeSecret.go b/service/secretsmanager/api_op_DescribeSecret.go index ad531c449f0..7e2e60cef0e 100644 --- a/service/secretsmanager/api_op_DescribeSecret.go +++ b/service/secretsmanager/api_op_DescribeSecret.go @@ -101,21 +101,11 @@ type DescribeSecretInput struct { type DescribeSecretOutput struct { - // The ARN of a Lambda function that's invoked by Secrets Manager to rotate the - // secret either automatically per the schedule or manually by a call to - // RotateSecret. - RotationLambdaARN *string - - // The last date that this secret was accessed. This value is truncated to midnight - // of the date and therefore shows only the date, not the time. - LastAccessedDate *time.Time - - // The list of user-defined tags that are associated with the secret. To add tags - // to a secret, use TagResource (). To remove tags, use UntagResource (). - Tags []*types.Tag + // The ARN of the secret. + ARN *string - // Returns the name of the service that created this secret. - OwningService *string + // The date that the secret was created. + CreatedDate *time.Time // This value exists if the secret is scheduled for deletion. Some time after the // specified date and time, Secrets Manager deletes the secret and all of its @@ -124,18 +114,22 @@ type DescribeSecretOutput struct { // and restore access, use RestoreSecret (). DeletedDate *time.Time - // A list of all of the currently assigned VersionStage staging labels and the - // VersionId that each is attached to. Staging labels are used to keep track of the - // different versions during the rotation process. A version that does not have any - // staging labels attached is considered deprecated and subject to deletion. Such - // versions are not included in this list. - VersionIdsToStages map[string][]*string + // The user-provided description of the secret. + Description *string - // The ARN of the secret. - ARN *string + // The ARN or alias of the AWS KMS customer master key (CMK) that's used to encrypt + // the SecretString or SecretBinary fields in each version of the secret. If you + // don't provide a key, then Secrets Manager defaults to encrypting the secret + // fields with the default AWS KMS CMK (the one named awssecretsmanager) for this + // account. + KmsKeyId *string - // The date that the secret was created. - CreatedDate *time.Time + // The last date that this secret was accessed. This value is truncated to midnight + // of the date and therefore shows only the date, not the time. + LastAccessedDate *time.Time + + // The last date and time that this secret was modified in any way. + LastChangedDate *time.Time // The most recent date and time that the Secrets Manager rotation process was // successfully completed. This value is null if the secret has never rotated. @@ -144,26 +138,32 @@ type DescribeSecretOutput struct { // The user-provided friendly name of the secret. Name *string - // The user-provided description of the secret. - Description *string - - // A structure that contains the rotation configuration for this secret. - RotationRules *types.RotationRulesType + // Returns the name of the service that created this secret. + OwningService *string // Specifies whether automatic rotation is enabled for this secret. To enable // rotation, use RotateSecret () with AutomaticallyRotateAfterDays set to a value // greater than 0. To disable rotation, use CancelRotateSecret (). RotationEnabled *bool - // The ARN or alias of the AWS KMS customer master key (CMK) that's used to encrypt - // the SecretString or SecretBinary fields in each version of the secret. If you - // don't provide a key, then Secrets Manager defaults to encrypting the secret - // fields with the default AWS KMS CMK (the one named awssecretsmanager) for this - // account. - KmsKeyId *string + // The ARN of a Lambda function that's invoked by Secrets Manager to rotate the + // secret either automatically per the schedule or manually by a call to + // RotateSecret. + RotationLambdaARN *string - // The last date and time that this secret was modified in any way. - LastChangedDate *time.Time + // A structure that contains the rotation configuration for this secret. + RotationRules *types.RotationRulesType + + // The list of user-defined tags that are associated with the secret. To add tags + // to a secret, use TagResource (). To remove tags, use UntagResource (). + Tags []*types.Tag + + // A list of all of the currently assigned VersionStage staging labels and the + // VersionId that each is attached to. Staging labels are used to keep track of the + // different versions during the rotation process. A version that does not have any + // staging labels attached is considered deprecated and subject to deletion. Such + // versions are not included in this list. + VersionIdsToStages map[string][]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/secretsmanager/api_op_GetRandomPassword.go b/service/secretsmanager/api_op_GetRandomPassword.go index 00747b857c2..693aeb6dfdb 100644 --- a/service/secretsmanager/api_op_GetRandomPassword.go +++ b/service/secretsmanager/api_op_GetRandomPassword.go @@ -66,24 +66,14 @@ type GetRandomPasswordInput struct { // password. The default is that all characters from the included sets can be used. ExcludeCharacters *string - // Specifies that the generated password should not include digits. The default if - // you do not include this switch parameter is that digits can be included. - ExcludeNumbers *bool - // Specifies that the generated password should not include lowercase letters. The // default if you do not include this switch parameter is that lowercase letters // can be included. ExcludeLowercase *bool - // A boolean value that specifies whether the generated password must include at - // least one of every allowed character type. The default value is True and the - // operation requires at least one of every character type. - RequireEachIncludedType *bool - - // Specifies that the generated password should not include uppercase letters. The - // default if you do not include this switch parameter is that uppercase letters - // can be included. - ExcludeUppercase *bool + // Specifies that the generated password should not include digits. The default if + // you do not include this switch parameter is that digits can be included. + ExcludeNumbers *bool // Specifies that the generated password should not include punctuation characters. // The default if you do not include this switch parameter is that punctuation @@ -93,6 +83,11 @@ type GetRandomPasswordInput struct { // < = > ? @ [ \ ] ^ _ ` { | } ~ ExcludePunctuation *bool + // Specifies that the generated password should not include uppercase letters. The + // default if you do not include this switch parameter is that uppercase letters + // can be included. + ExcludeUppercase *bool + // Specifies that the generated password can include the space character. The // default if you do not include this switch parameter is that the space character // is not included. @@ -101,6 +96,11 @@ type GetRandomPasswordInput struct { // The desired length of the generated password. The default value if you do not // include this parameter is 32 characters. PasswordLength *int64 + + // A boolean value that specifies whether the generated password must include at + // least one of every allowed character type. The default value is True and the + // operation requires at least one of every character type. + RequireEachIncludedType *bool } type GetRandomPasswordOutput struct { diff --git a/service/secretsmanager/api_op_GetResourcePolicy.go b/service/secretsmanager/api_op_GetResourcePolicy.go index 1e2a71ba440..c7c1d0e1455 100644 --- a/service/secretsmanager/api_op_GetResourcePolicy.go +++ b/service/secretsmanager/api_op_GetResourcePolicy.go @@ -101,6 +101,10 @@ type GetResourcePolicyOutput struct { // The ARN of the secret that the resource-based policy was retrieved for. ARN *string + // The friendly name of the secret that the resource-based policy was retrieved + // for. + Name *string + // A JSON-formatted string that describes the permissions that are associated with // the attached secret. These permissions are combined with any permissions that // are associated with the user or role that attempts to access this secret. The @@ -111,10 +115,6 @@ type GetResourcePolicyOutput struct { // in the AWS Secrets Manager User Guide. ResourcePolicy *string - // The friendly name of the secret that the resource-based policy was retrieved - // for. - Name *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/secretsmanager/api_op_GetSecretValue.go b/service/secretsmanager/api_op_GetSecretValue.go index d8be51bcf8e..2e3566d7307 100644 --- a/service/secretsmanager/api_op_GetSecretValue.go +++ b/service/secretsmanager/api_op_GetSecretValue.go @@ -116,12 +116,15 @@ type GetSecretValueInput struct { type GetSecretValueOutput struct { - // The friendly name of the secret. - Name *string + // The ARN of the secret. + ARN *string // The date and time that this version of the secret was created. CreatedDate *time.Time + // The friendly name of the secret. + Name *string + // The decrypted part of the protected secret information that was originally // provided as binary data in the form of a byte array. The response parameter // represents the binary data as a base64-encoded @@ -146,9 +149,6 @@ type GetSecretValueOutput struct { // The unique identifier of this version of the secret. VersionId *string - // The ARN of the secret. - ARN *string - // A list of all of the staging labels currently attached to this version of the // secret. VersionStages []*string diff --git a/service/secretsmanager/api_op_ListSecretVersionIds.go b/service/secretsmanager/api_op_ListSecretVersionIds.go index 6c66fa5f256..56763d96fda 100644 --- a/service/secretsmanager/api_op_ListSecretVersionIds.go +++ b/service/secretsmanager/api_op_ListSecretVersionIds.go @@ -73,22 +73,6 @@ func (c *Client) ListSecretVersionIds(ctx context.Context, params *ListSecretVer type ListSecretVersionIdsInput struct { - // (Optional) Limits the number of results you want to include in the response. If - // you don't include this parameter, it defaults to a value that's specific to the - // operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (isn't null). Include that - // value as the NextToken request parameter in the next call to the operation to - // get the next part of the results. Note that Secrets Manager might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. - MaxResults *int32 - - // (Optional) Specifies that you want the results to include versions that do not - // have any staging labels attached to them. Such versions are considered - // deprecated and are subject to deletion by Secrets Manager as needed. - IncludeDeprecated *bool - // The identifier for the secret containing the versions you want to list. You can // specify either the Amazon Resource Name (ARN) or the friendly name of the // secret. If you specify an ARN, we generally recommend that you specify a @@ -110,6 +94,22 @@ type ListSecretVersionIdsInput struct { // This member is required. SecretId *string + // (Optional) Specifies that you want the results to include versions that do not + // have any staging labels attached to them. Such versions are considered + // deprecated and are subject to deletion by Secrets Manager as needed. + IncludeDeprecated *bool + + // (Optional) Limits the number of results you want to include in the response. If + // you don't include this parameter, it defaults to a value that's specific to the + // operation. If additional items exist beyond the maximum you specify, the + // NextToken response element is present and has a value (isn't null). Include that + // value as the NextToken request parameter in the next call to the operation to + // get the next part of the results. Note that Secrets Manager might return fewer + // results than the maximum even when there are more results available. You should + // check NextToken after every operation to ensure that you receive all of the + // results. + MaxResults *int32 + // (Optional) Use this parameter in a request if you receive a NextToken response // in a previous request indicating there's more output available. In a subsequent // call, set it to the value of the previous call NextToken response to indicate diff --git a/service/secretsmanager/api_op_PutResourcePolicy.go b/service/secretsmanager/api_op_PutResourcePolicy.go index 38721c97eaa..fbd01e0bc07 100644 --- a/service/secretsmanager/api_op_PutResourcePolicy.go +++ b/service/secretsmanager/api_op_PutResourcePolicy.go @@ -82,10 +82,6 @@ func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolic type PutResourcePolicyInput struct { - // Makes an optional API call to Zelkova to validate the Resource Policy to prevent - // broad access to your secret. - BlockPublicPolicy *bool - // A JSON-formatted string that's constructed according to the grammar and syntax // for an AWS resource-based policy. The policy in the string identifies who can // access or manage this secret and its versions. For information on how to format @@ -117,16 +113,20 @@ type PutResourcePolicyInput struct { // // This member is required. SecretId *string + + // Makes an optional API call to Zelkova to validate the Resource Policy to prevent + // broad access to your secret. + BlockPublicPolicy *bool } type PutResourcePolicyOutput struct { - // The friendly name of the secret that the retrieved by the resource-based policy. - Name *string - // The ARN of the secret retrieved by the resource-based policy. ARN *string + // The friendly name of the secret that the retrieved by the resource-based policy. + Name *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/secretsmanager/api_op_PutSecretValue.go b/service/secretsmanager/api_op_PutSecretValue.go index a0dcd7717aa..5f98c1bd591 100644 --- a/service/secretsmanager/api_op_PutSecretValue.go +++ b/service/secretsmanager/api_op_PutSecretValue.go @@ -152,33 +152,6 @@ type PutSecretValueInput struct { // This member is required. SecretId *string - // (Optional) Specifies binary data that you want to encrypt and store in the new - // version of the secret. To use this parameter in the command-line tools, we - // recommend that you store your binary data in a file and then use the appropriate - // technique for your tool to pass the contents of the file as a parameter. Either - // SecretBinary or SecretString must have a value, but not both. They cannot both - // be empty.

    This parameter is not accessible if the secret using the Secrets - // Manager console.

    - SecretBinary []byte - - // (Optional) Specifies text data that you want to encrypt and store in this new - // version of the secret. Either SecretString or SecretBinary must have a value, - // but not both. They cannot both be empty.

    If you create this secret by using - // the Secrets Manager console then Secrets Manager puts the protected secret text - // in only the SecretString parameter. The Secrets Manager console - // stores the information as a JSON structure of key/value pairs that the default - // Lambda rotation function knows how to parse.

    For storing multiple values, - // we recommend that you use a JSON text string argument and specify key/value - // pairs. For information on how to format a JSON parameter for the various command - // line tool environments, see Using - // JSON for Parameters in the AWS CLI User Guide.

    For - // example:

    [{"username":"bob"},{"password":"abc123xyz456"}] - //

    If your command-line tool or SDK requires quotation marks around the - // parameter, you should use single quotes to avoid confusion with the double - // quotes required in the JSON text.

    - SecretString *string - // (Optional) Specifies a unique identifier for the new version of the secret. If // you use the AWS CLI or one of the AWS SDK to call this operation, then you can // leave this parameter empty. The CLI or SDK generates a random UUID for you and @@ -209,6 +182,33 @@ type PutSecretValueInput struct { // value becomes the VersionId of the new version. ClientRequestToken *string + // (Optional) Specifies binary data that you want to encrypt and store in the new + // version of the secret. To use this parameter in the command-line tools, we + // recommend that you store your binary data in a file and then use the appropriate + // technique for your tool to pass the contents of the file as a parameter. Either + // SecretBinary or SecretString must have a value, but not both. They cannot both + // be empty.

    This parameter is not accessible if the secret using the Secrets + // Manager console.

    + SecretBinary []byte + + // (Optional) Specifies text data that you want to encrypt and store in this new + // version of the secret. Either SecretString or SecretBinary must have a value, + // but not both. They cannot both be empty.

    If you create this secret by using + // the Secrets Manager console then Secrets Manager puts the protected secret text + // in only the SecretString parameter. The Secrets Manager console + // stores the information as a JSON structure of key/value pairs that the default + // Lambda rotation function knows how to parse.

    For storing multiple values, + // we recommend that you use a JSON text string argument and specify key/value + // pairs. For information on how to format a JSON parameter for the various command + // line tool environments, see Using + // JSON for Parameters in the AWS CLI User Guide.

    For + // example:

    [{"username":"bob"},{"password":"abc123xyz456"}] + //

    If your command-line tool or SDK requires quotation marks around the + // parameter, you should use single quotes to avoid confusion with the double + // quotes required in the JSON text.

    + SecretString *string + // (Optional) Specifies a list of staging labels that are attached to this version // of the secret. These staging labels are used to track the versions through the // rotation process by the Lambda rotation function. A staging label must be unique @@ -222,21 +222,21 @@ type PutSecretValueInput struct { type PutSecretValueOutput struct { - // The unique identifier of the version of the secret you just created or updated. - VersionId *string - // The Amazon Resource Name (ARN) for the secret for which you just created a // version. ARN *string + // The friendly name of the secret for which you just created or updated a version. + Name *string + + // The unique identifier of the version of the secret you just created or updated. + VersionId *string + // The list of staging labels that are currently attached to this version of the // secret. Staging labels are used to track a version as it progresses through the // secret rotation process. VersionStages []*string - // The friendly name of the secret for which you just created or updated a version. - Name *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/secretsmanager/api_op_RotateSecret.go b/service/secretsmanager/api_op_RotateSecret.go index 799ba6b1a27..dd52e44dafe 100644 --- a/service/secretsmanager/api_op_RotateSecret.go +++ b/service/secretsmanager/api_op_RotateSecret.go @@ -113,6 +113,27 @@ func (c *Client) RotateSecret(ctx context.Context, params *RotateSecretInput, op type RotateSecretInput struct { + // Specifies the secret that you want to rotate. You can specify either the Amazon + // Resource Name (ARN) or the friendly name of the secret. If you specify an ARN, + // we generally recommend that you specify a complete ARN. You can specify a + // partial ARN too—for example, if you don’t include the final hyphen and six + // random characters that Secrets Manager adds at the end of the ARN when you + // created the secret. A partial ARN match can work as long as it uniquely matches + // only one secret. However, if your secret has a name that ends in a hyphen + // followed by six characters (before Secrets Manager adds the hyphen and six + // characters to the ARN) and you try to use that as a partial ARN, then those + // characters cause Secrets Manager to assume that you’re specifying a complete + // ARN. This confusion can cause unexpected results. To avoid this situation, we + // recommend that you don’t create secret names ending with a hyphen followed by + // six characters. If you specify an incomplete ARN without the random suffix, and + // instead provide the 'friendly name', you must not include the random suffix. If + // you do include the random suffix added by Secrets Manager, you receive either a + // ResourceNotFoundException or an AccessDeniedException error, depending on your + // permissions. + // + // This member is required. + SecretId *string + // (Optional) Specifies a unique identifier for the new version of the secret that // helps ensure idempotency. If you use the AWS CLI or one of the AWS SDK to call // this operation, then you can leave this parameter empty. The CLI or SDK @@ -135,40 +156,19 @@ type RotateSecretInput struct { // A structure that defines the rotation configuration for this secret. RotationRules *types.RotationRulesType - - // Specifies the secret that you want to rotate. You can specify either the Amazon - // Resource Name (ARN) or the friendly name of the secret. If you specify an ARN, - // we generally recommend that you specify a complete ARN. You can specify a - // partial ARN too—for example, if you don’t include the final hyphen and six - // random characters that Secrets Manager adds at the end of the ARN when you - // created the secret. A partial ARN match can work as long as it uniquely matches - // only one secret. However, if your secret has a name that ends in a hyphen - // followed by six characters (before Secrets Manager adds the hyphen and six - // characters to the ARN) and you try to use that as a partial ARN, then those - // characters cause Secrets Manager to assume that you’re specifying a complete - // ARN. This confusion can cause unexpected results. To avoid this situation, we - // recommend that you don’t create secret names ending with a hyphen followed by - // six characters. If you specify an incomplete ARN without the random suffix, and - // instead provide the 'friendly name', you must not include the random suffix. If - // you do include the random suffix added by Secrets Manager, you receive either a - // ResourceNotFoundException or an AccessDeniedException error, depending on your - // permissions. - // - // This member is required. - SecretId *string } type RotateSecretOutput struct { - // The ID of the new version of the secret created by the rotation started by this - // request. - VersionId *string + // The ARN of the secret. + ARN *string // The friendly name of the secret. Name *string - // The ARN of the secret. - ARN *string + // The ID of the new version of the secret created by the rotation started by this + // request. + VersionId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/secretsmanager/api_op_UntagResource.go b/service/secretsmanager/api_op_UntagResource.go index 5b4de775bfa..6ebe49e56da 100644 --- a/service/secretsmanager/api_op_UntagResource.go +++ b/service/secretsmanager/api_op_UntagResource.go @@ -73,17 +73,6 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // A list of tag key names to remove from the secret. You don't specify the value. - // Both the key and its associated value are removed. This parameter to the API - // requires a JSON text string argument. For information on how to format a JSON - // parameter for the various command line tool environments, see Using JSON for - // Parameters - // (https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json) - // in the AWS CLI User Guide. - // - // This member is required. - TagKeys []*string - // The identifier for the secret that you want to remove tags from. You can specify // either the Amazon Resource Name (ARN) or the friendly name of the secret. If you // specify an ARN, we generally recommend that you specify a complete ARN. You can @@ -104,6 +93,17 @@ type UntagResourceInput struct { // // This member is required. SecretId *string + + // A list of tag key names to remove from the secret. You don't specify the value. + // Both the key and its associated value are removed. This parameter to the API + // requires a JSON text string argument. For information on how to format a JSON + // parameter for the various command line tool environments, see Using JSON for + // Parameters + // (https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json) + // in the AWS CLI User Guide. + // + // This member is required. + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/secretsmanager/api_op_UpdateSecret.go b/service/secretsmanager/api_op_UpdateSecret.go index 8df573f4eff..f5217ba2642 100644 --- a/service/secretsmanager/api_op_UpdateSecret.go +++ b/service/secretsmanager/api_op_UpdateSecret.go @@ -123,48 +123,6 @@ func (c *Client) UpdateSecret(ctx context.Context, params *UpdateSecretInput, op type UpdateSecretInput struct { - // (Optional) Specifies updated binary data that you want to encrypt and store in - // the new version of the secret. To use this parameter in the command-line tools, - // we recommend that you store your binary data in a file and then use the - // appropriate technique for your tool to pass the contents of the file as a - // parameter. Either SecretBinary or SecretString must have a value, but not both. - // They cannot both be empty. This parameter is not accessible using the Secrets - // Manager console. - SecretBinary []byte - - // (Optional) Specifies updated text data that you want to encrypt and store in - // this new version of the secret. Either SecretBinary or SecretString must have a - // value, but not both. They cannot both be empty. If you create this secret by - // using the Secrets Manager console then Secrets Manager puts the protected secret - // text in only the SecretString parameter. The Secrets Manager console stores the - // information as a JSON structure of key/value pairs that the default Lambda - // rotation function knows how to parse. For storing multiple values, we recommend - // that you use a JSON text string argument and specify key/value pairs. For - // information on how to format a JSON parameter for the various command line tool - // environments, see Using JSON for Parameters - // (https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json) - // in the AWS CLI User Guide. For example: - // [{"username":"bob"},{"password":"abc123xyz456"}] If your command-line tool or - // SDK requires quotation marks around the parameter, you should use single quotes - // to avoid confusion with the double quotes required in the JSON text. You can - // also 'escape' the double quote character in the embedded JSON text by prefacing - // each with a backslash. For example, the following string is surrounded by - // double-quotes. All of the embedded double quotes are escaped: - // "[{\"username\":\"bob\"},{\"password\":\"abc123xyz456\"}]" - SecretString *string - - // (Optional) Specifies an updated ARN or alias of the AWS KMS customer master key - // (CMK) to be used to encrypt the protected text in new versions of this secret. - // You can only use the account's default CMK to encrypt and decrypt if you call - // this operation using credentials from the same account that owns the secret. If - // the secret is in a different account, then you must create a custom CMK and - // provide the ARN of that CMK in this field. The user making the call must have - // permissions to both the secret and the CMK in their respective accounts. - KmsKeyId *string - - // (Optional) Specifies an updated user-provided description of the secret. - Description *string - // Specifies the secret that you want to modify or to which you want to add a new // version. You can specify either the Amazon Resource Name (ARN) or the friendly // name of the secret. If you specify an ARN, we generally recommend that you @@ -217,6 +175,48 @@ type UpdateSecretInput struct { // This // value becomes the VersionId of the new version. ClientRequestToken *string + + // (Optional) Specifies an updated user-provided description of the secret. + Description *string + + // (Optional) Specifies an updated ARN or alias of the AWS KMS customer master key + // (CMK) to be used to encrypt the protected text in new versions of this secret. + // You can only use the account's default CMK to encrypt and decrypt if you call + // this operation using credentials from the same account that owns the secret. If + // the secret is in a different account, then you must create a custom CMK and + // provide the ARN of that CMK in this field. The user making the call must have + // permissions to both the secret and the CMK in their respective accounts. + KmsKeyId *string + + // (Optional) Specifies updated binary data that you want to encrypt and store in + // the new version of the secret. To use this parameter in the command-line tools, + // we recommend that you store your binary data in a file and then use the + // appropriate technique for your tool to pass the contents of the file as a + // parameter. Either SecretBinary or SecretString must have a value, but not both. + // They cannot both be empty. This parameter is not accessible using the Secrets + // Manager console. + SecretBinary []byte + + // (Optional) Specifies updated text data that you want to encrypt and store in + // this new version of the secret. Either SecretBinary or SecretString must have a + // value, but not both. They cannot both be empty. If you create this secret by + // using the Secrets Manager console then Secrets Manager puts the protected secret + // text in only the SecretString parameter. The Secrets Manager console stores the + // information as a JSON structure of key/value pairs that the default Lambda + // rotation function knows how to parse. For storing multiple values, we recommend + // that you use a JSON text string argument and specify key/value pairs. For + // information on how to format a JSON parameter for the various command line tool + // environments, see Using JSON for Parameters + // (https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json) + // in the AWS CLI User Guide. For example: + // [{"username":"bob"},{"password":"abc123xyz456"}] If your command-line tool or + // SDK requires quotation marks around the parameter, you should use single quotes + // to avoid confusion with the double quotes required in the JSON text. You can + // also 'escape' the double quote character in the embedded JSON text by prefacing + // each with a backslash. For example, the following string is surrounded by + // double-quotes. All of the embedded double quotes are escaped: + // "[{\"username\":\"bob\"},{\"password\":\"abc123xyz456\"}]" + SecretString *string } type UpdateSecretOutput struct { @@ -229,13 +229,13 @@ type UpdateSecretOutput struct { // automatically get access to the new secret because the ARNs are different. ARN *string + // The friendly name of the secret that was updated. + Name *string + // If a new version of the secret was created by this operation, then VersionId // contains the unique identifier of the new version. VersionId *string - // The friendly name of the secret that was updated. - Name *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/secretsmanager/api_op_UpdateSecretVersionStage.go b/service/secretsmanager/api_op_UpdateSecretVersionStage.go index f3f111b9845..99908b075ff 100644 --- a/service/secretsmanager/api_op_UpdateSecretVersionStage.go +++ b/service/secretsmanager/api_op_UpdateSecretVersionStage.go @@ -80,12 +80,6 @@ func (c *Client) UpdateSecretVersionStage(ctx context.Context, params *UpdateSec type UpdateSecretVersionStageInput struct { - // (Optional) The secret version ID that you want to add the staging label. If you - // want to remove a label from a version, then do not specify this parameter. If - // the staging label is already attached to a different version of the secret, then - // you must also specify the RemoveFromVersionId parameter. - MoveToVersionId *string - // Specifies the secret with the version with the list of staging labels you want // to modify. You can specify either the Amazon Resource Name (ARN) or the friendly // name of the secret. If you specify an ARN, we generally recommend that you @@ -107,6 +101,17 @@ type UpdateSecretVersionStageInput struct { // This member is required. SecretId *string + // The staging label to add to this version. + // + // This member is required. + VersionStage *string + + // (Optional) The secret version ID that you want to add the staging label. If you + // want to remove a label from a version, then do not specify this parameter. If + // the staging label is already attached to a different version of the secret, then + // you must also specify the RemoveFromVersionId parameter. + MoveToVersionId *string + // Specifies the secret version ID of the version that the staging label is to be // removed from. If the staging label you are trying to attach to one version is // already attached to a different version, then you must include this parameter @@ -114,11 +119,6 @@ type UpdateSecretVersionStageInput struct { // attached and you either do not specify this parameter, or the version ID does // not match, then the operation fails. RemoveFromVersionId *string - - // The staging label to add to this version. - // - // This member is required. - VersionStage *string } type UpdateSecretVersionStageOutput struct { diff --git a/service/secretsmanager/api_op_ValidateResourcePolicy.go b/service/secretsmanager/api_op_ValidateResourcePolicy.go index f97c81fa7b7..5b1495fd4e3 100644 --- a/service/secretsmanager/api_op_ValidateResourcePolicy.go +++ b/service/secretsmanager/api_op_ValidateResourcePolicy.go @@ -60,6 +60,11 @@ func (c *Client) ValidateResourcePolicy(ctx context.Context, params *ValidateRes type ValidateResourcePolicyInput struct { + // Identifies the Resource Policy attached to the secret. + // + // This member is required. + ResourcePolicy *string + // The identifier for the secret that you want to validate a resource policy. You // can specify either the Amazon Resource Name (ARN) or the friendly name of the // secret. If you specify an ARN, we generally recommend that you specify a @@ -78,11 +83,6 @@ type ValidateResourcePolicyInput struct { // receive either a ResourceNotFoundException or an AccessDeniedException error, // depending on your permissions. SecretId *string - - // Identifies the Resource Policy attached to the secret. - // - // This member is required. - ResourcePolicy *string } type ValidateResourcePolicyOutput struct { diff --git a/service/secretsmanager/go.mod b/service/secretsmanager/go.mod index d40789945d9..db63e5d3edb 100644 --- a/service/secretsmanager/go.mod +++ b/service/secretsmanager/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/secretsmanager go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/secretsmanager/types/types.go b/service/secretsmanager/types/types.go index bf03e24d99e..977c41a100a 100644 --- a/service/secretsmanager/types/types.go +++ b/service/secretsmanager/types/types.go @@ -34,24 +34,23 @@ type RotationRulesType struct { // GetSecretValue () operation. type SecretListEntry struct { - // The ARN of an AWS Lambda function invoked by Secrets Manager to rotate and - // expire the secret either automatically per the schedule or manually by a call to - // RotateSecret (). - RotationLambdaARN *string - - // The last date that this secret was accessed. This value is truncated to midnight - // of the date and therefore shows only the date, not the time. - LastAccessedDate *time.Time + // The Amazon Resource Name (ARN) of the secret. For more information about ARNs in + // Secrets Manager, see Policy Resources + // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#iam-resources) + // in the AWS Secrets Manager User Guide. + ARN *string - // The list of user-defined tags associated with the secret. To add tags to a - // secret, use TagResource (). To remove tags, use UntagResource (). - Tags []*Tag + // The date and time when a secret was created. + CreatedDate *time.Time - // Returns the name of the service that created the secret. - OwningService *string + // The date and time the deletion of the secret occurred. Not present on active + // secrets. The secret can be recovered until the number of days in the recovery + // window has passed, as specified in the RecoveryWindowInDays parameter of the + // DeleteSecret () operation. + DeletedDate *time.Time - // Indicates whether automatic, scheduled rotation is enabled for this secret. - RotationEnabled *bool + // The user-provided description of the secret. + Description *string // The ARN or alias of the AWS KMS customer master key (CMK) used to encrypt the // SecretString and SecretBinary fields in each version of the secret. If you don't @@ -59,18 +58,15 @@ type SecretListEntry struct { // with the default KMS CMK, the key named awssecretsmanager, for this account. KmsKeyId *string - // A list of all of the currently assigned SecretVersionStage staging labels and - // the SecretVersionId attached to each one. Staging labels are used to keep track - // of the different versions during the rotation process. A version that does not - // have any SecretVersionStage is considered deprecated and subject to deletion. - // Such versions are not included in this list. - SecretVersionsToStages map[string][]*string + // The last date that this secret was accessed. This value is truncated to midnight + // of the date and therefore shows only the date, not the time. + LastAccessedDate *time.Time // The last date and time that this secret was modified in any way. LastChangedDate *time.Time - // A structure that defines the rotation configuration for the secret. - RotationRules *RotationRulesType + // The last date and time that the rotation process for this secret was invoked. + LastRotatedDate *time.Time // The friendly name of the secret. You can use forward slashes in the name to // represent a path hierarchy. For example, /prod/databases/dbserver1 could @@ -78,40 +74,44 @@ type SecretListEntry struct { // folder prod. Name *string - // The user-provided description of the secret. - Description *string + // Returns the name of the service that created the secret. + OwningService *string - // The Amazon Resource Name (ARN) of the secret. For more information about ARNs in - // Secrets Manager, see Policy Resources - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#iam-resources) - // in the AWS Secrets Manager User Guide. - ARN *string + // Indicates whether automatic, scheduled rotation is enabled for this secret. + RotationEnabled *bool - // The date and time when a secret was created. - CreatedDate *time.Time + // The ARN of an AWS Lambda function invoked by Secrets Manager to rotate and + // expire the secret either automatically per the schedule or manually by a call to + // RotateSecret (). + RotationLambdaARN *string - // The date and time the deletion of the secret occurred. Not present on active - // secrets. The secret can be recovered until the number of days in the recovery - // window has passed, as specified in the RecoveryWindowInDays parameter of the - // DeleteSecret () operation. - DeletedDate *time.Time + // A structure that defines the rotation configuration for the secret. + RotationRules *RotationRulesType - // The last date and time that the rotation process for this secret was invoked. - LastRotatedDate *time.Time + // A list of all of the currently assigned SecretVersionStage staging labels and + // the SecretVersionId attached to each one. Staging labels are used to keep track + // of the different versions during the rotation process. A version that does not + // have any SecretVersionStage is considered deprecated and subject to deletion. + // Such versions are not included in this list. + SecretVersionsToStages map[string][]*string + + // The list of user-defined tags associated with the secret. To add tags to a + // secret, use TagResource (). To remove tags, use UntagResource (). + Tags []*Tag } // A structure that contains information about one version of a secret. type SecretVersionsListEntry struct { - // The unique version identifier of this version of the secret. - VersionId *string + // The date and time this version of the secret was created. + CreatedDate *time.Time // The date that this version of the secret was last accessed. Note that the // resolution of this field is at the date level and does not include the time. LastAccessedDate *time.Time - // The date and time this version of the secret was created. - CreatedDate *time.Time + // The unique version identifier of this version of the secret. + VersionId *string // An array of staging labels that are currently associated with this version of // the secret. @@ -121,11 +121,11 @@ type SecretVersionsListEntry struct { // A structure that contains information about a tag. type Tag struct { - // The string value associated with the key of the tag. - Value *string - // The key identifier, or name, of the tag. Key *string + + // The string value associated with the key of the tag. + Value *string } // Displays errors that occurred during validation of the resource policy. diff --git a/service/securityhub/api_op_AcceptInvitation.go b/service/securityhub/api_op_AcceptInvitation.go index c583f789f4c..0d1be23919e 100644 --- a/service/securityhub/api_op_AcceptInvitation.go +++ b/service/securityhub/api_op_AcceptInvitation.go @@ -59,15 +59,15 @@ func (c *Client) AcceptInvitation(ctx context.Context, params *AcceptInvitationI type AcceptInvitationInput struct { - // The account ID of the Security Hub master account that sent the invitation. + // The ID of the invitation sent from the Security Hub master account. // // This member is required. - MasterId *string + InvitationId *string - // The ID of the invitation sent from the Security Hub master account. + // The account ID of the Security Hub master account that sent the invitation. // // This member is required. - InvitationId *string + MasterId *string } type AcceptInvitationOutput struct { diff --git a/service/securityhub/api_op_BatchImportFindings.go b/service/securityhub/api_op_BatchImportFindings.go index 0e03e69908f..7186106083c 100644 --- a/service/securityhub/api_op_BatchImportFindings.go +++ b/service/securityhub/api_op_BatchImportFindings.go @@ -99,14 +99,14 @@ type BatchImportFindingsOutput struct { // This member is required. FailedCount *int32 - // The list of findings that failed to import. - FailedFindings []*types.ImportFindingsError - // The number of findings that were successfully imported. // // This member is required. SuccessCount *int32 + // The list of findings that failed to import. + FailedFindings []*types.ImportFindingsError + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/securityhub/api_op_BatchUpdateFindings.go b/service/securityhub/api_op_BatchUpdateFindings.go index 2f6580e86ae..54c4e0d0b6b 100644 --- a/service/securityhub/api_op_BatchUpdateFindings.go +++ b/service/securityhub/api_op_BatchUpdateFindings.go @@ -86,25 +86,6 @@ func (c *Client) BatchUpdateFindings(ctx context.Context, params *BatchUpdateFin type BatchUpdateFindingsInput struct { - // Indicates the veracity of a finding. The available values for VerificationState - // are as follows. - // - // * UNKNOWN – The default disposition of a security finding - // - // - // * TRUE_POSITIVE – The security finding is confirmed - // - // * FALSE_POSITIVE – The - // security finding was determined to be a false alarm - // - // * BENIGN_POSITIVE – A - // special case of TRUE_POSITIVE where the finding doesn't pose any threat, is - // expected, or both - VerificationState types.VerificationState - - // A list of findings that are related to the updated findings. - RelatedFindings []*types.RelatedFinding - // The list of findings to update. BatchUpdateFindings can be used to update up to // 100 findings at a time. For each finding, the list provides the finding // identifier and the ARN of the finding provider. @@ -119,6 +100,21 @@ type BatchUpdateFindingsInput struct { // confidence. Confidence *int32 + // The updated value for the level of importance assigned to the resources + // associated with the findings. A score of 0 means that the underlying resources + // have no criticality, and a score of 100 is reserved for the most critical + // resources. + Criticality *int32 + + // The updated note. + Note *types.NoteUpdate + + // A list of findings that are related to the updated findings. + RelatedFindings []*types.RelatedFinding + + // Used to update the finding severity. + Severity *types.SeverityUpdate + // One or more finding types in the format of namespace/category/classifier that // classify a finding. Valid namespace values are as follows. // @@ -135,25 +131,29 @@ type BatchUpdateFindingsInput struct { // Sensitive Data Identifications Types []*string - // The updated note. - Note *types.NoteUpdate - - // The updated value for the level of importance assigned to the resources - // associated with the findings. A score of 0 means that the underlying resources - // have no criticality, and a score of 100 is reserved for the most critical - // resources. - Criticality *int32 - // A list of name/value string pairs associated with the finding. These are custom, // user-defined fields added to a finding. UserDefinedFields map[string]*string + // Indicates the veracity of a finding. The available values for VerificationState + // are as follows. + // + // * UNKNOWN – The default disposition of a security finding + // + // + // * TRUE_POSITIVE – The security finding is confirmed + // + // * FALSE_POSITIVE – The + // security finding was determined to be a false alarm + // + // * BENIGN_POSITIVE – A + // special case of TRUE_POSITIVE where the finding doesn't pose any threat, is + // expected, or both + VerificationState types.VerificationState + // Used to update the workflow status of a finding. The workflow status indicates // the progress of the investigation into the finding. Workflow *types.WorkflowUpdate - - // Used to update the finding severity. - Severity *types.SeverityUpdate } type BatchUpdateFindingsOutput struct { diff --git a/service/securityhub/api_op_CreateActionTarget.go b/service/securityhub/api_op_CreateActionTarget.go index de6da7ea511..c902e85e373 100644 --- a/service/securityhub/api_op_CreateActionTarget.go +++ b/service/securityhub/api_op_CreateActionTarget.go @@ -58,15 +58,15 @@ func (c *Client) CreateActionTarget(ctx context.Context, params *CreateActionTar type CreateActionTargetInput struct { - // The ID for the custom action target. + // The description for the custom action target. // // This member is required. - Id *string + Description *string - // The description for the custom action target. + // The ID for the custom action target. // // This member is required. - Description *string + Id *string // The name of the custom action target. // diff --git a/service/securityhub/api_op_CreateInsight.go b/service/securityhub/api_op_CreateInsight.go index 3ac63e9aab0..cbb305c6eaa 100644 --- a/service/securityhub/api_op_CreateInsight.go +++ b/service/securityhub/api_op_CreateInsight.go @@ -59,10 +59,11 @@ func (c *Client) CreateInsight(ctx context.Context, params *CreateInsightInput, type CreateInsightInput struct { - // The name of the custom insight to create. + // One or more attributes used to filter the findings included in the insight. The + // insight only includes findings that match the criteria defined in the filters. // // This member is required. - Name *string + Filters *types.AwsSecurityFindingFilters // The attribute used to group the findings for the insight. The grouping attribute // identifies the type of item that the insight applies to. For example, if an @@ -72,11 +73,10 @@ type CreateInsightInput struct { // This member is required. GroupByAttribute *string - // One or more attributes used to filter the findings included in the insight. The - // insight only includes findings that match the criteria defined in the filters. + // The name of the custom insight to create. // // This member is required. - Filters *types.AwsSecurityFindingFilters + Name *string } type CreateInsightOutput struct { diff --git a/service/securityhub/api_op_DescribeActionTargets.go b/service/securityhub/api_op_DescribeActionTargets.go index c6ad3e466d4..2f2ccd842b5 100644 --- a/service/securityhub/api_op_DescribeActionTargets.go +++ b/service/securityhub/api_op_DescribeActionTargets.go @@ -56,6 +56,9 @@ func (c *Client) DescribeActionTargets(ctx context.Context, params *DescribeActi type DescribeActionTargetsInput struct { + // A list of custom action target ARNs for the custom action targets to retrieve. + ActionTargetArns []*string + // The maximum number of results to return. MaxResults *int32 @@ -64,22 +67,19 @@ type DescribeActionTargetsInput struct { // subsequent calls to the operation, to continue listing data, set the value of // this parameter to the value returned from the previous response. NextToken *string - - // A list of custom action target ARNs for the custom action targets to retrieve. - ActionTargetArns []*string } type DescribeActionTargetsOutput struct { - // The pagination token to use to request the next page of results. - NextToken *string - // A list of ActionTarget objects. Each object includes the ActionTargetArn, // Description, and Name of a custom action target available in Security Hub. // // This member is required. ActionTargets []*types.ActionTarget + // The pagination token to use to request the next page of results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/securityhub/api_op_DescribeStandards.go b/service/securityhub/api_op_DescribeStandards.go index 44f519bbaf8..c7294acec84 100644 --- a/service/securityhub/api_op_DescribeStandards.go +++ b/service/securityhub/api_op_DescribeStandards.go @@ -69,12 +69,12 @@ type DescribeStandardsInput struct { type DescribeStandardsOutput struct { - // A list of available standards. - Standards []*types.Standard - // The pagination token to use to request the next page of results. NextToken *string + // A list of available standards. + Standards []*types.Standard + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/securityhub/api_op_DescribeStandardsControls.go b/service/securityhub/api_op_DescribeStandardsControls.go index 45f0faa0275..960182b29b4 100644 --- a/service/securityhub/api_op_DescribeStandardsControls.go +++ b/service/securityhub/api_op_DescribeStandardsControls.go @@ -59,14 +59,14 @@ func (c *Client) DescribeStandardsControls(ctx context.Context, params *Describe type DescribeStandardsControlsInput struct { - // The maximum number of security standard controls to return. - MaxResults *int32 - // The ARN of a resource that represents your subscription to a supported standard. // // This member is required. StandardsSubscriptionArn *string + // The maximum number of security standard controls to return. + MaxResults *int32 + // The token that is required for pagination. On your first call to the // DescribeStandardsControls operation, set the value of this parameter to NULL. // For subsequent calls to the operation, to continue listing data, set the value diff --git a/service/securityhub/api_op_EnableSecurityHub.go b/service/securityhub/api_op_EnableSecurityHub.go index e5da408c78d..6eeb800119c 100644 --- a/service/securityhub/api_op_EnableSecurityHub.go +++ b/service/securityhub/api_op_EnableSecurityHub.go @@ -74,14 +74,14 @@ func (c *Client) EnableSecurityHub(ctx context.Context, params *EnableSecurityHu type EnableSecurityHubInput struct { - // The tags to add to the hub resource when you enable Security Hub. - Tags map[string]*string - // Whether to enable the security standards that Security Hub has designated as // automatically enabled. If you do not provide a value for EnableDefaultStandards, // it is set to true. To not enable the automatically enabled standards, set // EnableDefaultStandards to false. EnableDefaultStandards *bool + + // The tags to add to the hub resource when you enable Security Hub. + Tags map[string]*string } type EnableSecurityHubOutput struct { diff --git a/service/securityhub/api_op_GetEnabledStandards.go b/service/securityhub/api_op_GetEnabledStandards.go index acd8f2364cf..29ba64ca208 100644 --- a/service/securityhub/api_op_GetEnabledStandards.go +++ b/service/securityhub/api_op_GetEnabledStandards.go @@ -56,28 +56,28 @@ func (c *Client) GetEnabledStandards(ctx context.Context, params *GetEnabledStan type GetEnabledStandardsInput struct { + // The maximum number of results to return in the response. + MaxResults *int32 + // The token that is required for pagination. On your first call to the // GetEnabledStandards operation, set the value of this parameter to NULL. For // subsequent calls to the operation, to continue listing data, set the value of // this parameter to the value returned from the previous response. NextToken *string - // The maximum number of results to return in the response. - MaxResults *int32 - // The list of the standards subscription ARNs for the standards to retrieve. StandardsSubscriptionArns []*string } type GetEnabledStandardsOutput struct { + // The pagination token to use to request the next page of results. + NextToken *string + // The list of StandardsSubscriptions objects that include information about the // enabled standards. StandardsSubscriptions []*types.StandardsSubscription - // The pagination token to use to request the next page of results. - NextToken *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/securityhub/api_op_GetFindings.go b/service/securityhub/api_op_GetFindings.go index 60ad06ff192..64e9a6137c1 100644 --- a/service/securityhub/api_op_GetFindings.go +++ b/service/securityhub/api_op_GetFindings.go @@ -61,9 +61,6 @@ type GetFindingsInput struct { // To search for a finding based on its workflow status, use WorkflowStatus. Filters *types.AwsSecurityFindingFilters - // The finding attributes used to sort the list of returned findings. - SortCriteria []*types.SortCriterion - // The maximum number of findings to return. MaxResults *int32 @@ -72,18 +69,21 @@ type GetFindingsInput struct { // operation, to continue listing data, set the value of this parameter to the // value returned from the previous response. NextToken *string + + // The finding attributes used to sort the list of returned findings. + SortCriteria []*types.SortCriterion } type GetFindingsOutput struct { - // The pagination token to use to request the next page of results. - NextToken *string - // The findings that matched the filters specified in the request. // // This member is required. Findings []*types.AwsSecurityFinding + // The pagination token to use to request the next page of results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/securityhub/api_op_GetInsights.go b/service/securityhub/api_op_GetInsights.go index 70acba9d1d3..c2b699d3046 100644 --- a/service/securityhub/api_op_GetInsights.go +++ b/service/securityhub/api_op_GetInsights.go @@ -73,14 +73,14 @@ type GetInsightsInput struct { type GetInsightsOutput struct { - // The pagination token to use to request the next page of results. - NextToken *string - // The insights returned by the operation. // // This member is required. Insights []*types.Insight + // The pagination token to use to request the next page of results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/securityhub/api_op_ListEnabledProductsForImport.go b/service/securityhub/api_op_ListEnabledProductsForImport.go index 3b73cde6cfe..42d84061778 100644 --- a/service/securityhub/api_op_ListEnabledProductsForImport.go +++ b/service/securityhub/api_op_ListEnabledProductsForImport.go @@ -56,25 +56,25 @@ func (c *Client) ListEnabledProductsForImport(ctx context.Context, params *ListE type ListEnabledProductsForImportInput struct { + // The maximum number of items to return in the response. + MaxResults *int32 + // The token that is required for pagination. On your first call to the // ListEnabledProductsForImport operation, set the value of this parameter to NULL. // For subsequent calls to the operation, to continue listing data, set the value // of this parameter to the value returned from the previous response. NextToken *string - - // The maximum number of items to return in the response. - MaxResults *int32 } type ListEnabledProductsForImportOutput struct { + // The pagination token to use to request the next page of results. + NextToken *string + // The list of ARNs for the resources that represent your subscriptions to // products. ProductSubscriptions []*string - // The pagination token to use to request the next page of results. - NextToken *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/securityhub/api_op_ListInvitations.go b/service/securityhub/api_op_ListInvitations.go index 976491a5606..7be88e0ff30 100644 --- a/service/securityhub/api_op_ListInvitations.go +++ b/service/securityhub/api_op_ListInvitations.go @@ -57,24 +57,24 @@ func (c *Client) ListInvitations(ctx context.Context, params *ListInvitationsInp type ListInvitationsInput struct { + // The maximum number of items to return in the response. + MaxResults *int32 + // The token that is required for pagination. On your first call to the // ListInvitations operation, set the value of this parameter to NULL. For // subsequent calls to the operation, to continue listing data, set the value of // this parameter to the value returned from the previous response. NextToken *string - - // The maximum number of items to return in the response. - MaxResults *int32 } type ListInvitationsOutput struct { - // The pagination token to use to request the next page of results. - NextToken *string - // The details of the invitations returned by the operation. Invitations []*types.Invitation + // The pagination token to use to request the next page of results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/securityhub/api_op_ListMembers.go b/service/securityhub/api_op_ListMembers.go index c158a5d833e..b27087adc04 100644 --- a/service/securityhub/api_op_ListMembers.go +++ b/service/securityhub/api_op_ListMembers.go @@ -57,13 +57,8 @@ func (c *Client) ListMembers(ctx context.Context, params *ListMembersInput, optF type ListMembersInput struct { - // Specifies which member accounts to include in the response based on their - // relationship status with the master account. The default value is TRUE. If - // OnlyAssociated is set to TRUE, the response includes member accounts whose - // relationship status with the master is set to ENABLED or DISABLED. If - // OnlyAssociated is set to FALSE, the response includes all existing member - // accounts. - OnlyAssociated *bool + // The maximum number of items to return in the response. + MaxResults *int32 // The token that is required for pagination. On your first call to the ListMembers // operation, set the value of this parameter to NULL. For subsequent calls to the @@ -71,8 +66,13 @@ type ListMembersInput struct { // value returned from the previous response. NextToken *string - // The maximum number of items to return in the response. - MaxResults *int32 + // Specifies which member accounts to include in the response based on their + // relationship status with the master account. The default value is TRUE. If + // OnlyAssociated is set to TRUE, the response includes member accounts whose + // relationship status with the master is set to ENABLED or DISABLED. If + // OnlyAssociated is set to FALSE, the response includes all existing member + // accounts. + OnlyAssociated *bool } type ListMembersOutput struct { diff --git a/service/securityhub/api_op_UntagResource.go b/service/securityhub/api_op_UntagResource.go index eb6a8651cc8..edaae9a07b9 100644 --- a/service/securityhub/api_op_UntagResource.go +++ b/service/securityhub/api_op_UntagResource.go @@ -56,15 +56,15 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The tag keys associated with the tags to remove from the resource. + // The ARN of the resource to remove the tags from. // // This member is required. - TagKeys []*string + ResourceArn *string - // The ARN of the resource to remove the tags from. + // The tag keys associated with the tags to remove from the resource. // // This member is required. - ResourceArn *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/securityhub/api_op_UpdateFindings.go b/service/securityhub/api_op_UpdateFindings.go index ea15c8c9662..0465434d863 100644 --- a/service/securityhub/api_op_UpdateFindings.go +++ b/service/securityhub/api_op_UpdateFindings.go @@ -60,16 +60,16 @@ func (c *Client) UpdateFindings(ctx context.Context, params *UpdateFindingsInput type UpdateFindingsInput struct { - // The updated record state for the finding. - RecordState types.RecordState - - // The updated note for the finding. - Note *types.NoteUpdate - // A collection of attributes that specify which findings you want to update. // // This member is required. Filters *types.AwsSecurityFindingFilters + + // The updated note for the finding. + Note *types.NoteUpdate + + // The updated record state for the finding. + RecordState types.RecordState } type UpdateFindingsOutput struct { diff --git a/service/securityhub/api_op_UpdateInsight.go b/service/securityhub/api_op_UpdateInsight.go index 96f5874e98d..3941d142235 100644 --- a/service/securityhub/api_op_UpdateInsight.go +++ b/service/securityhub/api_op_UpdateInsight.go @@ -57,19 +57,19 @@ func (c *Client) UpdateInsight(ctx context.Context, params *UpdateInsightInput, type UpdateInsightInput struct { - // The updated GroupBy attribute that defines this insight. - GroupByAttribute *string - // The ARN of the insight that you want to update. // // This member is required. InsightArn *string - // The updated name for the insight. - Name *string - // The updated filters that define this insight. Filters *types.AwsSecurityFindingFilters + + // The updated GroupBy attribute that defines this insight. + GroupByAttribute *string + + // The updated name for the insight. + Name *string } type UpdateInsightOutput struct { diff --git a/service/securityhub/api_op_UpdateStandardsControl.go b/service/securityhub/api_op_UpdateStandardsControl.go index 40b3eb02115..c4a1f045393 100644 --- a/service/securityhub/api_op_UpdateStandardsControl.go +++ b/service/securityhub/api_op_UpdateStandardsControl.go @@ -58,17 +58,17 @@ func (c *Client) UpdateStandardsControl(ctx context.Context, params *UpdateStand type UpdateStandardsControlInput struct { + // The ARN of the security standard control to enable or disable. + // + // This member is required. + StandardsControlArn *string + // The updated status of the security standard control. ControlStatus types.ControlStatus // A description of the reason why you are disabling a security standard control. // If you are disabling a control, then this is required. DisabledReason *string - - // The ARN of the security standard control to enable or disable. - // - // This member is required. - StandardsControlArn *string } type UpdateStandardsControlOutput struct { diff --git a/service/securityhub/go.mod b/service/securityhub/go.mod index 529c37bdc05..43035523e78 100644 --- a/service/securityhub/go.mod +++ b/service/securityhub/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/securityhub go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/securityhub/types/types.go b/service/securityhub/types/types.go index 6a56919e6a7..b6ec468d448 100644 --- a/service/securityhub/types/types.go +++ b/service/securityhub/types/types.go @@ -48,6 +48,9 @@ type AvailabilityZone struct { // Provides details about an auto scaling group. type AwsAutoScalingAutoScalingGroupDetails struct { + // The datetime when the auto scaling group was created. + CreatedTime *string + // The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before it // checks the health status of an EC2 instance that has come into service. HealthCheckGracePeriod *int32 @@ -55,34 +58,24 @@ type AwsAutoScalingAutoScalingGroupDetails struct { // The service to use for the health checks. HealthCheckType *string - // The list of load balancers associated with the group. - LoadBalancerNames []*string - - // The datetime when the auto scaling group was created. - CreatedTime *string - // The name of the launch configuration. LaunchConfigurationName *string + + // The list of load balancers associated with the group. + LoadBalancerNames []*string } // A distribution configuration. type AwsCloudFrontDistributionDetails struct { - // The date and time that the distribution was last modified. - LastModifiedTime *string - - // A unique identifier that specifies the AWS WAF web ACL, if any, to associate - // with this distribution. - WebAclId *string - // The domain name corresponding to the distribution. DomainName *string // The entity tag is a hash of the object. ETag *string - // Indicates the current status of the distribution. - Status *string + // The date and time that the distribution was last modified. + LastModifiedTime *string // A complex type that controls whether access logs are written for the // distribution. @@ -90,24 +83,31 @@ type AwsCloudFrontDistributionDetails struct { // A complex type that contains information about origins for this distribution. Origins *AwsCloudFrontDistributionOrigins + + // Indicates the current status of the distribution. + Status *string + + // A unique identifier that specifies the AWS WAF web ACL, if any, to associate + // with this distribution. + WebAclId *string } // A complex type that controls whether access logs are written for the // distribution. type AwsCloudFrontDistributionLogging struct { + // The Amazon S3 bucket to store the access logs in. + Bucket *string + // With this field, you can enable or disable the selected distribution. Enabled *bool - // An optional string that you want CloudFront to use as a prefix to the access log - // filenames for this distribution. - Prefix *string - // Specifies whether you want CloudFront to include cookies in access logs. IncludeCookies *bool - // The Amazon S3 bucket to store the access logs in. - Bucket *string + // An optional string that you want CloudFront to use as a prefix to the access log + // filenames for this distribution. + Prefix *string } // A complex type that describes the Amazon S3 bucket, HTTP server (for example, a @@ -115,13 +115,13 @@ type AwsCloudFrontDistributionLogging struct { // gets your files. type AwsCloudFrontDistributionOriginItem struct { - // A unique identifier for the origin or origin group. - Id *string - // Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want // CloudFront to get objects for this origin. DomainName *string + // A unique identifier for the origin or origin group. + Id *string + // An optional element that causes CloudFront to request your content from a // directory in your Amazon S3 bucket or your custom origin. OriginPath *string @@ -138,24 +138,24 @@ type AwsCloudFrontDistributionOrigins struct { // Information about an AWS CodeBuild project. type AwsCodeBuildProjectDetails struct { + // The AWS Key Management Service (AWS KMS) customer master key (CMK) used to + // encrypt the build output artifacts. You can specify either the Amazon Resource + // Name (ARN) of the CMK or, if available, the CMK alias (using the format + // alias/alias-name). + EncryptionKey *string + // Information about the build environment for this build project. Environment *AwsCodeBuildProjectEnvironment // The name of the build project. Name *string - // Information about the build input source code for this build project. - Source *AwsCodeBuildProjectSource - // The ARN of the IAM role that enables AWS CodeBuild to interact with dependent // AWS services on behalf of the AWS account. ServiceRole *string - // The AWS Key Management Service (AWS KMS) customer master key (CMK) used to - // encrypt the build output artifacts. You can specify either the Amazon Resource - // Name (ARN) of the CMK or, if available, the CMK alias (using the format - // alias/alias-name). - EncryptionKey *string + // Information about the build input source code for this build project. + Source *AwsCodeBuildProjectSource // Information about the VPC configuration that AWS CodeBuild accesses. VpcConfig *AwsCodeBuildProjectVpcConfig @@ -167,9 +167,6 @@ type AwsCodeBuildProjectEnvironment struct { // The certificate to use with this build project. Certificate *string - // The credentials for access to a private registry. - RegistryCredential *AwsCodeBuildProjectEnvironmentRegistryCredential - // The type of credentials AWS CodeBuild uses to pull images in your build. Valid // values: // @@ -185,6 +182,9 @@ type AwsCodeBuildProjectEnvironment struct { // CodeBuild curated image, you must use CODEBUILD credentials. ImagePullCredentialsType *string + // The credentials for access to a private registry. + RegistryCredential *AwsCodeBuildProjectEnvironmentRegistryCredential + // The type of build environment to use for related builds. The environment type // ARM_CONTAINER is available only in Regions US East (N. Virginia), US East // (Ohio), US West (Oregon), Europe (Ireland), Asia Pacific (Mumbai), Asia Pacific @@ -206,19 +206,25 @@ type AwsCodeBuildProjectEnvironment struct { // The credentials for access to a private registry. type AwsCodeBuildProjectEnvironmentRegistryCredential struct { - // The service that created the credentials to access a private Docker registry. - // The valid value, SECRETS_MANAGER, is for AWS Secrets Manager. - CredentialProvider *string - // The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets // Manager. The credential can use the name of the credentials only if they exist // in your current AWS Region. Credential *string + + // The service that created the credentials to access a private Docker registry. + // The valid value, SECRETS_MANAGER, is for AWS Secrets Manager. + CredentialProvider *string } // Information about the build input source code for this build project. type AwsCodeBuildProjectSource struct { + // Information about the Git clone depth for the build project. + GitCloneDepth *int32 + + // Whether to ignore SSL warnings while connecting to the project source code. + InsecureSsl *bool + // Information about the location of the source code to be built. Valid values // include: // @@ -251,9 +257,6 @@ type AwsCodeBuildProjectSource struct { // clone URL to the repository that contains the source and the build spec file. Location *string - // Information about the Git clone depth for the build project. - GitCloneDepth *int32 - // The type of repository that contains the source code to be built. Valid values // are: // @@ -277,20 +280,17 @@ type AwsCodeBuildProjectSource struct { // // * S3 - The source code is in an S3 input bucket. Type *string - - // Whether to ignore SSL warnings while connecting to the project source code. - InsecureSsl *bool } // Information about the VPC configuration that AWS CodeBuild accesses. type AwsCodeBuildProjectVpcConfig struct { - // A list of one or more subnet IDs in your Amazon VPC. - Subnets []*string - // A list of one or more security group IDs in your Amazon VPC. SecurityGroupIds []*string + // A list of one or more subnet IDs in your Amazon VPC. + Subnets []*string + // The ID of the VPC. VpcId *string } @@ -298,43 +298,37 @@ type AwsCodeBuildProjectVpcConfig struct { // The details of an Amazon EC2 instance. type AwsEc2InstanceDetails struct { - // The date/time the instance was launched. - LaunchedAt *string - - // The instance type of the instance. - Type *string - - // The IPv6 addresses associated with the instance. - IpV6Addresses []*string + // The IAM profile ARN of the instance. + IamInstanceProfileArn *string // The Amazon Machine Image (AMI) ID of the instance. ImageId *string - // The identifier of the VPC that the instance was launched in. - VpcId *string - // The IPv4 addresses associated with the instance. IpV4Addresses []*string + // The IPv6 addresses associated with the instance. + IpV6Addresses []*string + // The key name associated with the instance. KeyName *string - // The IAM profile ARN of the instance. - IamInstanceProfileArn *string + // The date/time the instance was launched. + LaunchedAt *string // The identifier of the subnet that the instance was launched in. SubnetId *string + + // The instance type of the instance. + Type *string + + // The identifier of the VPC that the instance was launched in. + VpcId *string } // Information about the network interface attachment. type AwsEc2NetworkInterfaceAttachment struct { - // The attachment state. Valid values: attaching | attached | detaching | detached - Status *string - - // The AWS account ID of the owner of the instance. - InstanceOwnerId *string - // The timestamp indicating when the attachment initiated. AttachTime *string @@ -350,6 +344,12 @@ type AwsEc2NetworkInterfaceAttachment struct { // The ID of the instance. InstanceId *string + + // The AWS account ID of the owner of the instance. + InstanceOwnerId *string + + // The attachment state. Valid values: attaching | attached | detaching | detached + Status *string } // Details about the network interface @@ -361,62 +361,48 @@ type AwsEc2NetworkInterfaceDetails struct { // The ID of the network interface. NetworkInterfaceId *string - // Indicates whether traffic to or from the instance is validated. - SourceDestCheck *bool - // Security groups for the network interface. SecurityGroups []*AwsEc2NetworkInterfaceSecurityGroup + + // Indicates whether traffic to or from the instance is validated. + SourceDestCheck *bool } // A security group associated with the network interface. type AwsEc2NetworkInterfaceSecurityGroup struct { - // The name of the security group. - GroupName *string - // The ID of the security group. GroupId *string + + // The name of the security group. + GroupName *string } // Details about an EC2 security group. type AwsEc2SecurityGroupDetails struct { + // The ID of the security group. + GroupId *string + + // The name of the security group. + GroupName *string + // The inbound rules associated with the security group. IpPermissions []*AwsEc2SecurityGroupIpPermission + // [VPC only] The outbound rules associated with the security group. + IpPermissionsEgress []*AwsEc2SecurityGroupIpPermission + // The AWS account ID of the owner of the security group. OwnerId *string - // The name of the security group. - GroupName *string - // [VPC only] The ID of the VPC for the security group. VpcId *string - - // The ID of the security group. - GroupId *string - - // [VPC only] The outbound rules associated with the security group. - IpPermissionsEgress []*AwsEc2SecurityGroupIpPermission } // An IP permission for an EC2 security group. type AwsEc2SecurityGroupIpPermission struct { - // [VPC only] The prefix list IDs for an AWS service. With outbound rules, this is - // the AWS service to access through a VPC endpoint from instances associated with - // the security group. - PrefixListIds []*AwsEc2SecurityGroupPrefixListId - - // The IPv6 ranges. - Ipv6Ranges []*AwsEc2SecurityGroupIpv6Range - - // The security group and AWS account ID pairs. - UserIdGroupPairs []*AwsEc2SecurityGroupUserIdGroupPair - - // The IPv4 ranges. - IpRanges []*AwsEc2SecurityGroupIpRange - // The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 // type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all // ICMP/ICMPv6 types, you must specify all codes. @@ -430,10 +416,24 @@ type AwsEc2SecurityGroupIpPermission struct { // the port range, traffic for all types and codes is allowed. IpProtocol *string + // The IPv4 ranges. + IpRanges []*AwsEc2SecurityGroupIpRange + + // The IPv6 ranges. + Ipv6Ranges []*AwsEc2SecurityGroupIpv6Range + + // [VPC only] The prefix list IDs for an AWS service. With outbound rules, this is + // the AWS service to access through a VPC endpoint from instances associated with + // the security group. + PrefixListIds []*AwsEc2SecurityGroupPrefixListId + // The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. // A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 // types, you must specify all codes. ToPort *int32 + + // The security group and AWS account ID pairs. + UserIdGroupPairs []*AwsEc2SecurityGroupUserIdGroupPair } // A range of IPv4 addresses. @@ -464,17 +464,14 @@ type AwsEc2SecurityGroupPrefixListId struct { // A relationship between a security group and a user. type AwsEc2SecurityGroupUserIdGroupPair struct { - // The status of a VPC peering connection, if applicable. - PeeringStatus *string - - // The ID of the VPC for the referenced security group, if applicable. - VpcId *string - // The ID of the security group. GroupId *string - // The ID of the VPC peering connection, if applicable. - VpcPeeringConnectionId *string + // The name of the security group. + GroupName *string + + // The status of a VPC peering connection, if applicable. + PeeringStatus *string // The ID of an AWS account. For a referenced security group in another VPC, the // account ID of the referenced security group is returned in the response. If the @@ -483,24 +480,27 @@ type AwsEc2SecurityGroupUserIdGroupPair struct { // another AWS. UserId *string - // The name of the security group. - GroupName *string + // The ID of the VPC for the referenced security group, if applicable. + VpcId *string + + // The ID of the VPC peering connection, if applicable. + VpcPeeringConnectionId *string } // An attachment to an AWS EC2 volume. type AwsEc2VolumeAttachment struct { - // The identifier of the EC2 instance. - InstanceId *string - - // The attachment state of the volume. - Status *string - // The datetime when the attachment initiated. AttachTime *string // Whether the EBS volume is deleted when the EC2 instance is terminated. DeleteOnTermination *bool + + // The identifier of the EC2 instance. + InstanceId *string + + // The attachment state of the volume. + Status *string } // Details about an EC2 volume. @@ -509,50 +509,55 @@ type AwsEc2VolumeDetails struct { // The volume attachments. Attachments []*AwsEc2VolumeAttachment - // The snapshot from which the volume was created. - SnapshotId *string - - // The ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) - // that was used to protect the volume encryption key for the volume. - KmsKeyId *string - - // The volume state. - Status *string + // The datetime when the volume was created. + CreateTime *string // Whether the volume is encrypted. Encrypted *bool - // The datetime when the volume was created. - CreateTime *string + // The ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) + // that was used to protect the volume encryption key for the volume. + KmsKeyId *string // The size of the volume, in GiBs. Size *int32 + + // The snapshot from which the volume was created. + SnapshotId *string + + // The volume state. + Status *string } // Details about an EC2 VPC. type AwsEc2VpcDetails struct { + // Information about the IPv4 CIDR blocks associated with the VPC. + CidrBlockAssociationSet []*CidrBlockAssociation + // The identifier of the set of Dynamic Host Configuration Protocol (DHCP) options // that are associated with the VPC. If the default options are associated with the // VPC, then this is default. DhcpOptionsId *string - // Information about the IPv4 CIDR blocks associated with the VPC. - CidrBlockAssociationSet []*CidrBlockAssociation + // Information about the IPv6 CIDR blocks associated with the VPC. + Ipv6CidrBlockAssociationSet []*Ipv6CidrBlockAssociation // The current state of the VPC. State *string - - // Information about the IPv6 CIDR blocks associated with the VPC. - Ipv6CidrBlockAssociationSet []*Ipv6CidrBlockAssociation } // Information about an Elasticsearch domain. type AwsElasticsearchDomainDetails struct { - // Domain-specific endpoint used to submit index, search, and data upload requests - // to an Amazon ES domain. The endpoint is a service URL. - Endpoint *string + // IAM policy document specifying the access policies for the new Amazon ES domain. + AccessPolicies *string + + // Additional options for the domain endpoint. + DomainEndpointOptions *AwsElasticsearchDomainDomainEndpointOptions + + // Unique identifier for an Amazon ES domain. + DomainId *string // Name of an Amazon ES domain. Domain names are unique across all domains owned by // the same account within an AWS Region. Domain names must start with a lowercase @@ -560,27 +565,22 @@ type AwsElasticsearchDomainDetails struct { // (lowercase only), 0-9, and – (hyphen). DomainName *string - // Details about the configuration for node-to-node encryption. - NodeToNodeEncryptionOptions *AwsElasticsearchDomainNodeToNodeEncryptionOptions - - // Unique identifier for an Amazon ES domain. - DomainId *string + // Elasticsearch version. + ElasticsearchVersion *string // Details about the configuration for encryption at rest. EncryptionAtRestOptions *AwsElasticsearchDomainEncryptionAtRestOptions - // IAM policy document specifying the access policies for the new Amazon ES domain. - AccessPolicies *string - - // Elasticsearch version. - ElasticsearchVersion *string - - // Additional options for the domain endpoint. - DomainEndpointOptions *AwsElasticsearchDomainDomainEndpointOptions + // Domain-specific endpoint used to submit index, search, and data upload requests + // to an Amazon ES domain. The endpoint is a service URL. + Endpoint *string // The key-value pair that exists if the Amazon ES domain uses VPC endpoints. Endpoints map[string]*string + // Details about the configuration for node-to-node encryption. + NodeToNodeEncryptionOptions *AwsElasticsearchDomainNodeToNodeEncryptionOptions + // Information that Amazon ES derives based on VPCOptions for the domain. VPCOptions *AwsElasticsearchDomainVPCOptions } @@ -605,11 +605,11 @@ type AwsElasticsearchDomainDomainEndpointOptions struct { // Details about the configuration for encryption at rest. type AwsElasticsearchDomainEncryptionAtRestOptions struct { - // The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a. - KmsKeyId *string - // Whether encryption at rest is enabled. Enabled *bool + + // The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a. + KmsKeyId *string } // Details about the configuration for node-to-node encryption. @@ -625,30 +625,35 @@ type AwsElasticsearchDomainVPCOptions struct { // The list of Availability Zones associated with the VPC subnets. AvailabilityZones []*string + // The list of security group IDs associated with the VPC endpoints for the domain. + SecurityGroupIds []*string + // A list of subnet IDs associated with the VPC endpoints for the domain. SubnetIds []*string // ID for the VPC. VPCId *string - - // The list of security group IDs associated with the VPC endpoints for the domain. - SecurityGroupIds []*string } // Information about a load balancer. type AwsElbv2LoadBalancerDetails struct { - // The state of the load balancer. - State *LoadBalancerState + // The Availability Zones for the load balancer. + AvailabilityZones []*AvailabilityZone // The ID of the Amazon Route 53 hosted zone associated with the load balancer. CanonicalHostedZoneId *string - // The ID of the VPC for the load balancer. - VpcId *string + // The date and time the load balancer was created. + CreatedTime *string - // The Availability Zones for the load balancer. - AvailabilityZones []*AvailabilityZone + // The public DNS name of the load balancer. + DNSName *string + + // The type of IP addresses used by the subnets for your load balancer. The + // possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 + // addresses). + IpAddressType *string // The nodes of an Internet-facing load balancer have public IP addresses. Scheme *string @@ -656,43 +661,38 @@ type AwsElbv2LoadBalancerDetails struct { // The IDs of the security groups for the load balancer. SecurityGroups []*string - // The date and time the load balancer was created. - CreatedTime *string + // The state of the load balancer. + State *LoadBalancerState // The type of load balancer. Type *string - // The public DNS name of the load balancer. - DNSName *string - - // The type of IP addresses used by the subnets for your load balancer. The - // possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 - // addresses). - IpAddressType *string + // The ID of the VPC for the load balancer. + VpcId *string } // IAM access key details related to a finding. type AwsIamAccessKeyDetails struct { + // The creation date/time of the IAM access key related to a finding. + CreatedAt *string + + // The ID of the principal associated with an access key. + PrincipalId *string + // The name of the principal. PrincipalName *string // The type of principal associated with an access key. PrincipalType *string + // The status of the IAM access key related to a finding. + Status AwsIamAccessKeyStatus + // The user associated with the IAM access key related to a finding. The UserName // parameter has been replaced with the PrincipalName parameter because access keys // can also be assigned to principals that are not IAM users. UserName *string - - // The creation date/time of the IAM access key related to a finding. - CreatedAt *string - - // The status of the IAM access key related to a finding. - Status AwsIamAccessKeyStatus - - // The ID of the principal associated with an access key. - PrincipalId *string } // Contains information about an IAM role, including all of the role's policies. @@ -704,13 +704,13 @@ type AwsIamRoleDetails struct { // The date and time, in ISO 8601 date-time format, when the role was created. CreateDate *string - // The path to the role. - Path *string - // The maximum session duration (in seconds) that you want to set for the specified // role. MaxSessionDuration *int32 + // The path to the role. + Path *string + // The stable and unique string identifying the role. RoleId *string @@ -721,19 +721,12 @@ type AwsIamRoleDetails struct { // Contains metadata about a customer master key (CMK). type AwsKmsKeyDetails struct { - // The date and time when the CMK was created. - CreationDate *float64 - - // The source of the CMK's key material. When this value is AWS_KMS, AWS KMS - // created the key material. When this value is EXTERNAL, the key material was - // imported from your existing key management infrastructure or the CMK lacks key - // material. When this value is AWS_CLOUDHSM, the key material was created in the - // AWS CloudHSM cluster associated with a custom key store. - Origin *string - // The twelve-digit account ID of the AWS account that owns the CMK. AWSAccountId *string + // The date and time when the CMK was created. + CreationDate *float64 + // The globally unique identifier for the CMK. KeyId *string @@ -743,6 +736,13 @@ type AwsKmsKeyDetails struct { // The state of the CMK. KeyState *string + + // The source of the CMK's key material. When this value is AWS_KMS, AWS KMS + // created the key material. When this value is EXTERNAL, the key material was + // imported from your existing key management infrastructure or the CMK lacks key + // material. When this value is AWS_CLOUDHSM, the key material was created in the + // AWS CloudHSM cluster associated with a custom key store. + Origin *string } // The code for the Lambda function. You can specify either an object in Amazon S3, @@ -756,12 +756,12 @@ type AwsLambdaFunctionCode struct { // The Amazon S3 key of the deployment package. S3Key *string + // For versioned objects, the version of the deployment package object to use. + S3ObjectVersion *string + // The base64-encoded contents of the deployment package. AWS SDK and AWS CLI // clients handle the encoding for you. ZipFile *string - - // For versioned objects, the version of the deployment package object to use. - S3ObjectVersion *string } // The dead-letter queue for failed asynchronous invocations. @@ -774,71 +774,71 @@ type AwsLambdaFunctionDeadLetterConfig struct { // Details about a function's configuration. type AwsLambdaFunctionDetails struct { - // The KMS key that's used to encrypt the function's environment variables. This - // key is only returned if you've configured a customer managed CMK. - KmsKeyArn *string + // An AwsLambdaFunctionCode object. + Code *AwsLambdaFunctionCode - // For Lambda@Edge functions, the ARN of the master function. - MasterArn *string + // The SHA256 hash of the function's deployment package. + CodeSha256 *string - // The name of the function. - FunctionName *string + // The function's dead letter queue. + DeadLetterConfig *AwsLambdaFunctionDeadLetterConfig - // The amount of time that Lambda allows a function to run before stopping it. - Timeout *int32 + // The function's environment variables. + Environment *AwsLambdaFunctionEnvironment - // The function's networking configuration. - VpcConfig *AwsLambdaFunctionVpcConfig + // The name of the function. + FunctionName *string - // The runtime environment for the Lambda function. - Runtime *string + // The function that Lambda calls to begin executing your function. + Handler *string - // The function's environment variables. - Environment *AwsLambdaFunctionEnvironment + // The KMS key that's used to encrypt the function's environment variables. This + // key is only returned if you've configured a customer managed CMK. + KmsKeyArn *string - // The function's execution role. - Role *string + // The date and time that the function was last updated, in ISO-8601 format + // (YYYY-MM-DDThh:mm:ss.sTZD). + LastModified *string // The function's layers. Layers []*AwsLambdaFunctionLayer - // The function's AWS X-Ray tracing configuration. - TracingConfig *AwsLambdaFunctionTracingConfig + // For Lambda@Edge functions, the ARN of the master function. + MasterArn *string // The memory that's allocated to the function. MemorySize *int32 - // The version of the Lambda function. - Version *string + // The latest updated revision of the function or alias. + RevisionId *string - // The function's dead letter queue. - DeadLetterConfig *AwsLambdaFunctionDeadLetterConfig + // The function's execution role. + Role *string - // An AwsLambdaFunctionCode object. - Code *AwsLambdaFunctionCode + // The runtime environment for the Lambda function. + Runtime *string - // The SHA256 hash of the function's deployment package. - CodeSha256 *string + // The amount of time that Lambda allows a function to run before stopping it. + Timeout *int32 - // The function that Lambda calls to begin executing your function. - Handler *string + // The function's AWS X-Ray tracing configuration. + TracingConfig *AwsLambdaFunctionTracingConfig - // The latest updated revision of the function or alias. - RevisionId *string + // The version of the Lambda function. + Version *string - // The date and time that the function was last updated, in ISO-8601 format - // (YYYY-MM-DDThh:mm:ss.sTZD). - LastModified *string + // The function's networking configuration. + VpcConfig *AwsLambdaFunctionVpcConfig } // A function's environment variable settings. type AwsLambdaFunctionEnvironment struct { - // Environment variable key-value pairs. - Variables map[string]*string - // An AwsLambdaFunctionEnvironmentError object. Error *AwsLambdaFunctionEnvironmentError + + // Environment variable key-value pairs. + Variables map[string]*string } // Error messages for environment variables that couldn't be applied. @@ -854,11 +854,11 @@ type AwsLambdaFunctionEnvironmentError struct { // An AWS Lambda layer. type AwsLambdaFunctionLayer struct { - // The size of the layer archive in bytes. - CodeSize *int32 - // The Amazon Resource Name (ARN) of the function layer. Arn *string + + // The size of the layer archive in bytes. + CodeSize *int32 } // The function's AWS X-Ray tracing configuration. @@ -885,17 +885,17 @@ type AwsLambdaFunctionVpcConfig struct { // Details about a Lambda layer version. type AwsLambdaLayerVersionDetails struct { - // The version number. - Version *int64 + // The layer's compatible runtimes. Maximum number of five items. Valid values: + // nodejs10.x | nodejs12.x | java8 | java11 | python2.7 | python3.6 | python3.7 | + // python3.8 | dotnetcore1.0 | dotnetcore2.1 | go1.x | ruby2.5 | provided + CompatibleRuntimes []*string // The date that the version was created, in ISO 8601 format. For example, // 2018-11-27T15:10:45.123+0000. CreatedDate *string - // The layer's compatible runtimes. Maximum number of five items. Valid values: - // nodejs10.x | nodejs12.x | java8 | java11 | python2.7 | python3.6 | python3.7 | - // python3.8 | dotnetcore1.0 | dotnetcore2.1 | go1.x | ruby2.5 | provided - CompatibleRuntimes []*string + // The version number. + Version *int64 } // An AWS Identity and Access Management (IAM) role associated with the DB @@ -928,13 +928,23 @@ type AwsRdsDbInstanceAssociatedRole struct { // Contains the details of an Amazon RDS DB instance. type AwsRdsDbInstanceDetails struct { - // Specifies the connection endpoint. - Endpoint *AwsRdsDbInstanceEndpoint + // The AWS Identity and Access Management (IAM) roles associated with the DB + // instance. + AssociatedRoles []*AwsRdsDbInstanceAssociatedRole - // The AWS Region-unique, immutable identifier for the DB instance. This identifier - // is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB - // instance is accessed. - DbiResourceId *string + // The identifier of the CA certificate for this DB instance. + CACertificateIdentifier *string + + // If the DB instance is a member of a DB cluster, contains the name of the DB + // cluster that the DB instance is a member of. + DBClusterIdentifier *string + + // Contains the name of the compute and memory capacity class of the DB instance. + DBInstanceClass *string + + // Contains a user-supplied database identifier. This identifier is the unique key + // that identifies a DB instance. + DBInstanceIdentifier *string // The meaning of this parameter differs according to the database engine you use. // MySQL, MariaDB, SQL Server, PostgreSQL Contains the name of the initial database @@ -944,29 +954,33 @@ type AwsRdsDbInstanceDetails struct { // Not shown when the returned parameters do not apply to an Oracle DB instance. DBName *string - // The identifier of the CA certificate for this DB instance. - CACertificateIdentifier *string - // Specifies the port that the DB instance listens on. If the DB instance is part // of a DB cluster, this can be a different port than the DB cluster port. DbInstancePort *int32 - // If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB - // instance. - KmsKeyId *string - - // A list of VPC security groups that the DB instance belongs to. - VpcSecurityGroups []*AwsRdsDbInstanceVpcSecurityGroup + // The AWS Region-unique, immutable identifier for the DB instance. This identifier + // is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB + // instance is accessed. + DbiResourceId *string // Indicates whether the DB instance has deletion protection enabled. When deletion // protection is enabled, the database cannot be deleted. DeletionProtection *bool - // True if mapping of AWS Identity and Access Management (IAM) accounts to database - // accounts is enabled, and otherwise false. IAM database authentication can be - // enabled for the following database engines. - // - // * For MySQL 5.6, minor version + // Specifies the connection endpoint. + Endpoint *AwsRdsDbInstanceEndpoint + + // Provides the name of the database engine to use for this DB instance. + Engine *string + + // Indicates the database engine version. + EngineVersion *string + + // True if mapping of AWS Identity and Access Management (IAM) accounts to database + // accounts is enabled, and otherwise false. IAM database authentication can be + // enabled for the following database engines. + // + // * For MySQL 5.6, minor version // 5.6.34 or higher // // * For MySQL 5.7, minor version 5.7.16 or higher @@ -975,42 +989,28 @@ type AwsRdsDbInstanceDetails struct { // Aurora 5.6 or higher IAMDatabaseAuthenticationEnabled *bool - // Specifies whether the DB instance is encrypted. - StorageEncrypted *bool - - // If the DB instance is a member of a DB cluster, contains the name of the DB - // cluster that the DB instance is a member of. - DBClusterIdentifier *string - - // Contains the name of the compute and memory capacity class of the DB instance. - DBInstanceClass *string - - // Provides the name of the database engine to use for this DB instance. - Engine *string - - // The ARN from the key store with which the instance is associated for TDE - // encryption. - TdeCredentialArn *string - // Provides the date and time the DB instance was created. InstanceCreateTime *string - // Contains a user-supplied database identifier. This identifier is the unique key - // that identifies a DB instance. - DBInstanceIdentifier *string - - // The AWS Identity and Access Management (IAM) roles associated with the DB + // If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB // instance. - AssociatedRoles []*AwsRdsDbInstanceAssociatedRole - - // Indicates the database engine version. - EngineVersion *string + KmsKeyId *string // Specifies the accessibility options for the DB instance. A value of true // specifies an Internet-facing instance with a publicly resolvable DNS name, which // resolves to a public IP address. A value of false specifies an internal instance // with a DNS name that resolves to a private IP address. PubliclyAccessible *bool + + // Specifies whether the DB instance is encrypted. + StorageEncrypted *bool + + // The ARN from the key store with which the instance is associated for TDE + // encryption. + TdeCredentialArn *string + + // A list of VPC security groups that the DB instance belongs to. + VpcSecurityGroups []*AwsRdsDbInstanceVpcSecurityGroup } // Specifies the connection endpoint. @@ -1019,28 +1019,28 @@ type AwsRdsDbInstanceEndpoint struct { // Specifies the DNS address of the DB instance. Address *string - // Specifies the port that the database engine is listening on. - Port *int32 - // Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. HostedZoneId *string + + // Specifies the port that the database engine is listening on. + Port *int32 } // A VPC security groups that the DB instance belongs to. type AwsRdsDbInstanceVpcSecurityGroup struct { - // The name of the VPC security group. - VpcSecurityGroupId *string - // The status of the VPC security group. Status *string + + // The name of the VPC security group. + VpcSecurityGroupId *string } // The details of an Amazon S3 bucket. type AwsS3BucketDetails struct { - // The encryption rules that are applied to the S3 bucket. - ServerSideEncryptionConfiguration *AwsS3BucketServerSideEncryptionConfiguration + // The date and time when the S3 bucket was created. + CreatedAt *string // The canonical user ID of the owner of the S3 bucket. OwnerId *string @@ -1048,19 +1048,19 @@ type AwsS3BucketDetails struct { // The display name of the owner of the S3 bucket. OwnerName *string - // The date and time when the S3 bucket was created. - CreatedAt *string + // The encryption rules that are applied to the S3 bucket. + ServerSideEncryptionConfiguration *AwsS3BucketServerSideEncryptionConfiguration } // Specifies the default server-side encryption to apply to new objects in the // bucket. type AwsS3BucketServerSideEncryptionByDefault struct { - // Server-side encryption algorithm to use for the default encryption. - SSEAlgorithm *string - // AWS KMS customer master key (CMK) ID to use for the default encryption. KMSMasterKeyID *string + + // Server-side encryption algorithm to use for the default encryption. + SSEAlgorithm *string } // The encryption configuration for the S3 bucket. @@ -1082,26 +1082,26 @@ type AwsS3BucketServerSideEncryptionRule struct { // Details about an Amazon S3 object. type AwsS3ObjectDetails struct { - // If the object is stored using server-side encryption, the value of the - // server-side encryption algorithm used when storing this object in Amazon S3. - ServerSideEncryption *string + // A standard MIME type describing the format of the object data. + ContentType *string + + // The opaque identifier assigned by a web server to a specific version of a + // resource found at a URL. + ETag *string + + // The date and time when the object was last modified. + LastModified *string // The identifier of the AWS Key Management Service (AWS KMS) symmetric customer // managed customer master key (CMK) that was used for the object. SSEKMSKeyId *string + // If the object is stored using server-side encryption, the value of the + // server-side encryption algorithm used when storing this object in Amazon S3. + ServerSideEncryption *string + // The version of the object. VersionId *string - - // The date and time when the object was last modified. - LastModified *string - - // The opaque identifier assigned by a web server to a specific version of a - // resource found at a URL. - ETag *string - - // A standard MIME type describing the format of the object data. - ContentType *string } // Provides consistent format for the contents of the Security Hub-aggregated @@ -1112,42 +1112,40 @@ type AwsS3ObjectDetails struct { // solutions and standards checks. type AwsSecurityFinding struct { - // One or more finding types in the format of namespace/category/classifier that - // classify a finding. Valid namespace values are: Software and Configuration - // Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications + // The AWS account ID that a finding is generated in. // // This member is required. - Types []*string + AwsAccountId *string - // The ARN generated by Security Hub that uniquely identifies a product that - // generates findings. This can be the ARN for a third-party product that is - // integrated with Security Hub, or the ARN for a custom integration. + // An ISO8601-formatted timestamp that indicates when the security-findings + // provider created the potential security issue that a finding captured. // // This member is required. - ProductArn *string - - // A URL that links to a page about the current finding in the security-findings - // provider's solution. - SourceUrl *string - - // Threat intelligence details related to a finding. - ThreatIntelIndicators []*ThreatIntelIndicator + CreatedAt *string // A finding's description. In this release, Description is a required property. // // This member is required. Description *string - // Provides a list of vulnerabilities associated with the findings. - Vulnerabilities []*Vulnerability + // The identifier for the solution-specific component (a discrete unit of logic) + // that generated a finding. In various security-findings providers' solutions, + // this generator can be called a rule, a check, a detector, a plugin, etc. + // + // This member is required. + GeneratorId *string - // The level of importance assigned to the resources associated with the finding. A - // score of 0 means that the underlying resources have no criticality, and a score - // of 100 is reserved for the most critical resources. - Criticality *int32 + // The security findings provider-specific identifier for a finding. + // + // This member is required. + Id *string - // Indicates the veracity of a finding. - VerificationState VerificationState + // The ARN generated by Security Hub that uniquely identifies a product that + // generates findings. This can be the ARN for a third-party product that is + // integrated with Security Hub, or the ARN for a custom integration. + // + // This member is required. + ProductArn *string // A set of resource data types that describe the resources that the finding refers // to. @@ -1155,54 +1153,38 @@ type AwsSecurityFinding struct { // This member is required. Resources []*Resource - // The details of network-related information about a finding. - Network *Network - - // A list of malware related to a finding. - Malware []*Malware - - // Provides information about a network path that is relevant to a finding. Each - // entry under NetworkPath represents a component of that path. - NetworkPath []*NetworkPathComponent - - // Provides information about the status of the investigation into a finding. - Workflow *Workflow - - // The details of process-related information about a finding. - Process *ProcessDetails - - // A list of related findings. - RelatedFindings []*RelatedFinding - - // An ISO8601-formatted timestamp that indicates when the security-findings - // provider first observed the potential security issue that a finding captured. - FirstObservedAt *string + // The schema version that a finding is formatted for. + // + // This member is required. + SchemaVersion *string // A finding's severity. // // This member is required. Severity *Severity - // The schema version that a finding is formatted for. + // A finding's title. In this release, Title is a required property. // // This member is required. - SchemaVersion *string - - // The record state of a finding. - RecordState RecordState - - // A data type where security-findings providers can include additional - // solution-specific details that aren't part of the defined AwsSecurityFinding - // format. - ProductFields map[string]*string + Title *string - // A data type that describes the remediation options for a finding. - Remediation *Remediation + // One or more finding types in the format of namespace/category/classifier that + // classify a finding. Valid namespace values are: Software and Configuration + // Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications + // + // This member is required. + Types []*string - // A finding's title. In this release, Title is a required property. + // An ISO8601-formatted timestamp that indicates when the security-findings + // provider last updated the finding record. // // This member is required. - Title *string + UpdatedAt *string + + // This data type is exclusive to findings that are generated as the result of a + // check run against a specific rule in a supported security standard, such as CIS + // AWS Foundations. Contains security standard-related finding details. + Compliance *Compliance // A finding's confidence. Confidence is defined as the likelihood that a finding // accurately identifies the behavior or issue that it was intended to identify. @@ -1210,353 +1192,371 @@ type AwsSecurityFinding struct { // percent confidence and 100 means 100 percent confidence. Confidence *int32 + // The level of importance assigned to the resources associated with the finding. A + // score of 0 means that the underlying resources have no criticality, and a score + // of 100 is reserved for the most critical resources. + Criticality *int32 + + // An ISO8601-formatted timestamp that indicates when the security-findings + // provider first observed the potential security issue that a finding captured. + FirstObservedAt *string + // An ISO8601-formatted timestamp that indicates when the security-findings // provider most recently observed the potential security issue that a finding // captured. LastObservedAt *string - // The AWS account ID that a finding is generated in. - // - // This member is required. - AwsAccountId *string - - // The security findings provider-specific identifier for a finding. - // - // This member is required. - Id *string - - // A list of name/value string pairs associated with the finding. These are custom, - // user-defined fields added to a finding. - UserDefinedFields map[string]*string - - // The workflow state of a finding. - WorkflowState WorkflowState + // A list of malware related to a finding. + Malware []*Malware - // An ISO8601-formatted timestamp that indicates when the security-findings - // provider last updated the finding record. - // - // This member is required. - UpdatedAt *string + // The details of network-related information about a finding. + Network *Network - // This data type is exclusive to findings that are generated as the result of a - // check run against a specific rule in a supported security standard, such as CIS - // AWS Foundations. Contains security standard-related finding details. - Compliance *Compliance + // Provides information about a network path that is relevant to a finding. Each + // entry under NetworkPath represents a component of that path. + NetworkPath []*NetworkPathComponent // A user-defined note added to a finding. Note *Note - // An ISO8601-formatted timestamp that indicates when the security-findings - // provider created the potential security issue that a finding captured. - // - // This member is required. - CreatedAt *string + // The details of process-related information about a finding. + Process *ProcessDetails - // The identifier for the solution-specific component (a discrete unit of logic) - // that generated a finding. In various security-findings providers' solutions, - // this generator can be called a rule, a check, a detector, a plugin, etc. - // - // This member is required. - GeneratorId *string -} + // A data type where security-findings providers can include additional + // solution-specific details that aren't part of the defined AwsSecurityFinding + // format. + ProductFields map[string]*string -// A collection of attributes that are applied to all active Security -// Hub-aggregated findings and that result in a subset of findings that are -// included in this insight. -type AwsSecurityFindingFilters struct { + // The record state of a finding. + RecordState RecordState - // The path to the process executable. - ProcessPath []*StringFilter + // A list of related findings. + RelatedFindings []*RelatedFinding - // The protocol of network-related information about a finding. - NetworkProtocol []*StringFilter + // A data type that describes the remediation options for a finding. + Remediation *Remediation - // The IPv4 addresses associated with the instance. - ResourceAwsEc2InstanceIpV4Addresses []*IpFilter + // A URL that links to a page about the current finding in the security-findings + // provider's solution. + SourceUrl *string - // The canonical AWS partition name that the Region is assigned to. - ResourcePartition []*StringFilter + // Threat intelligence details related to a finding. + ThreatIntelIndicators []*ThreatIntelIndicator - // The creation date/time of the IAM access key related to a finding. - ResourceAwsIamAccessKeyCreatedAt []*DateFilter + // A list of name/value string pairs associated with the finding. These are custom, + // user-defined fields added to a finding. + UserDefinedFields map[string]*string - // The solution-generated identifier for a related finding. - RelatedFindingsId []*StringFilter + // Indicates the veracity of a finding. + VerificationState VerificationState - // Specifies the type of the resource that details are provided for. - ResourceType []*StringFilter + // Provides a list of vulnerabilities associated with the findings. + Vulnerabilities []*Vulnerability - // The source IPv4 address of network-related information about a finding. - NetworkSourceIpV4 []*IpFilter + // Provides information about the status of the investigation into a finding. + Workflow *Workflow - // The source IPv6 address of network-related information about a finding. - NetworkSourceIpV6 []*IpFilter + // The workflow state of a finding. + WorkflowState WorkflowState +} - // The principal that created a note. - NoteUpdatedBy []*StringFilter +// A collection of attributes that are applied to all active Security +// Hub-aggregated findings and that result in a subset of findings that are +// included in this insight. +type AwsSecurityFindingFilters struct { - // Indicates the direction of network traffic associated with a finding. - NetworkDirection []*StringFilter + // The AWS account ID that a finding is generated in. + AwsAccountId []*StringFilter - // The identifier of the VPC that the instance was launched in. - ResourceAwsEc2InstanceVpcId []*StringFilter + // The name of the findings provider (company) that owns the solution (product) + // that generates findings. + CompanyName []*StringFilter - // The source port of network-related information about a finding. - NetworkSourcePort []*NumberFilter + // Exclusive to findings that are generated as the result of a check run against a + // specific rule in a supported standard, such as CIS AWS Foundations. Contains + // security standard-related finding details. + ComplianceStatus []*StringFilter - // The type of a threat intelligence indicator. - ThreatIntelIndicatorType []*StringFilter + // A finding's confidence. Confidence is defined as the likelihood that a finding + // accurately identifies the behavior or issue that it was intended to identify. + // Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero + // percent confidence and 100 means 100 percent confidence. + Confidence []*NumberFilter + + // An ISO8601-formatted timestamp that indicates when the security-findings + // provider captured the potential security issue that a finding captured. + CreatedAt []*DateFilter + + // The level of importance assigned to the resources associated with the finding. A + // score of 0 means that the underlying resources have no criticality, and a score + // of 100 is reserved for the most critical resources. + Criticality []*NumberFilter + + // A finding's description. + Description []*StringFilter // An ISO8601-formatted timestamp that indicates when the security-findings // provider first observed the potential security issue that a finding captured. FirstObservedAt []*DateFilter - // The value of a threat intelligence indicator. - ThreatIntelIndicatorValue []*StringFilter + // The identifier for the solution-specific component (a discrete unit of logic) + // that generated a finding. In various security-findings providers' solutions, + // this generator can be called a rule, a check, a detector, a plugin, etc. + GeneratorId []*StringFilter - // The normalized severity of a finding. - SeverityNormalized []*NumberFilter + // The security findings provider-specific identifier for a finding. + Id []*StringFilter - // The date/time that the container was started. - ResourceContainerLaunchedAt []*DateFilter + // A keyword for a finding. + Keyword []*KeywordFilter - // The display name of the owner of the S3 bucket. - ResourceAwsS3BucketOwnerName []*StringFilter + // An ISO8601-formatted timestamp that indicates when the security-findings + // provider most recently observed the potential security issue that a finding + // captured. + LastObservedAt []*DateFilter - // The date/time that the process was launched. - ProcessLaunchedAt []*DateFilter + // The name of the malware that was observed. + MalwareName []*StringFilter - // The security findings provider-specific identifier for a finding. - Id []*StringFilter + // The filesystem path of the malware that was observed. + MalwarePath []*StringFilter - // The user associated with the IAM access key related to a finding. - ResourceAwsIamAccessKeyUserName []*StringFilter + // The state of the malware that was observed. + MalwareState []*StringFilter - // The level of importance assigned to the resources associated with the finding. A - // score of 0 means that the underlying resources have no criticality, and a score - // of 100 is reserved for the most critical resources. - Criticality []*NumberFilter + // The type of the malware that was observed. + MalwareType []*StringFilter + + // The destination domain of network-related information about a finding. + NetworkDestinationDomain []*StringFilter + + // The destination IPv4 address of network-related information about a finding. + NetworkDestinationIpV4 []*IpFilter + + // The destination IPv6 address of network-related information about a finding. + NetworkDestinationIpV6 []*IpFilter // The destination port of network-related information about a finding. NetworkDestinationPort []*NumberFilter - // A list of AWS tags associated with a resource at the time the finding was - // processed. - ResourceTags []*MapFilter + // Indicates the direction of network traffic associated with a finding. + NetworkDirection []*StringFilter - // The IAM profile ARN of the instance. - ResourceAwsEc2InstanceIamInstanceProfileArn []*StringFilter + // The protocol of network-related information about a finding. + NetworkProtocol []*StringFilter - // The destination IPv6 address of network-related information about a finding. - NetworkDestinationIpV6 []*IpFilter + // The source domain of network-related information about a finding. + NetworkSourceDomain []*StringFilter + + // The source IPv4 address of network-related information about a finding. + NetworkSourceIpV4 []*IpFilter + + // The source IPv6 address of network-related information about a finding. + NetworkSourceIpV6 []*IpFilter + + // The source media access control (MAC) address of network-related information + // about a finding. + NetworkSourceMac []*StringFilter + + // The source port of network-related information about a finding. + NetworkSourcePort []*NumberFilter + + // The text of a note. + NoteText []*StringFilter // The timestamp of when the note was updated. NoteUpdatedAt []*DateFilter - // The identifier of the image related to a finding. - ResourceContainerImageId []*StringFilter + // The principal that created a note. + NoteUpdatedBy []*StringFilter - // The destination IPv4 address of network-related information about a finding. - NetworkDestinationIpV4 []*IpFilter + // The date/time that the process was launched. + ProcessLaunchedAt []*DateFilter - // The type of the malware that was observed. - MalwareType []*StringFilter + // The name of the process. + ProcessName []*StringFilter // The parent process ID. ProcessParentPid []*NumberFilter - // The source of the threat intelligence. - ThreatIntelIndicatorSource []*StringFilter + // The path to the process executable. + ProcessPath []*StringFilter - // The date and time the instance was launched. - ResourceAwsEc2InstanceLaunchedAt []*DateFilter + // The process ID. + ProcessPid []*NumberFilter + + // The date/time that the process was terminated. + ProcessTerminatedAt []*DateFilter + + // The ARN generated by Security Hub that uniquely identifies a third-party company + // (security findings provider) after this provider's product (solution that + // generates findings) is registered with Security Hub. + ProductArn []*StringFilter + + // A data type where security-findings providers can include additional + // solution-specific details that aren't part of the defined AwsSecurityFinding + // format. + ProductFields []*MapFilter + + // The name of the solution (product) that generates findings. + ProductName []*StringFilter // The recommendation of what to do about the issue described in a finding. RecommendationText []*StringFilter - // The details of a resource that doesn't have a specific subfield for the resource - // type defined. - ResourceDetailsOther []*MapFilter + // The updated record state for the finding. + RecordState []*StringFilter - // Exclusive to findings that are generated as the result of a check run against a - // specific rule in a supported standard, such as CIS AWS Foundations. Contains - // security standard-related finding details. - ComplianceStatus []*StringFilter + // The solution-generated identifier for a related finding. + RelatedFindingsId []*StringFilter - // The date/time that the process was terminated. - ProcessTerminatedAt []*DateFilter + // The ARN of the solution that generated a related finding. + RelatedFindingsProductArn []*StringFilter + + // The IAM profile ARN of the instance. + ResourceAwsEc2InstanceIamInstanceProfileArn []*StringFilter + + // The Amazon Machine Image (AMI) ID of the instance. + ResourceAwsEc2InstanceImageId []*StringFilter + + // The IPv4 addresses associated with the instance. + ResourceAwsEc2InstanceIpV4Addresses []*IpFilter + + // The IPv6 addresses associated with the instance. + ResourceAwsEc2InstanceIpV6Addresses []*IpFilter + + // The key name associated with the instance. + ResourceAwsEc2InstanceKeyName []*StringFilter + + // The date and time the instance was launched. + ResourceAwsEc2InstanceLaunchedAt []*DateFilter + + // The identifier of the subnet that the instance was launched in. + ResourceAwsEc2InstanceSubnetId []*StringFilter // The instance type of the instance. ResourceAwsEc2InstanceType []*StringFilter - // An ISO8601-formatted timestamp that indicates when the security-findings - // provider captured the potential security issue that a finding captured. - CreatedAt []*DateFilter - - // The process ID. - ProcessPid []*NumberFilter + // The identifier of the VPC that the instance was launched in. + ResourceAwsEc2InstanceVpcId []*StringFilter - // The state of the malware that was observed. - MalwareState []*StringFilter + // The creation date/time of the IAM access key related to a finding. + ResourceAwsIamAccessKeyCreatedAt []*DateFilter - // The filesystem path of the malware that was observed. - MalwarePath []*StringFilter + // The status of the IAM access key related to a finding. + ResourceAwsIamAccessKeyStatus []*StringFilter - // The name of the image related to a finding. - ResourceContainerImageName []*StringFilter + // The user associated with the IAM access key related to a finding. + ResourceAwsIamAccessKeyUserName []*StringFilter - // The status of the investigation into a finding. Allowed values are the - // following. - // - // * NEW - The initial state of a finding, before it is reviewed. - // - // - // * NOTIFIED - Indicates that the resource owner has been notified about the - // security issue. Used when the initial reviewer is not the resource owner, and - // needs intervention from the resource owner. - // - // * SUPPRESSED - The finding will - // not be reviewed again and will not be acted upon. - // - // * RESOLVED - The finding - // was reviewed and remediated and is now considered resolved. - WorkflowStatus []*StringFilter + // The canonical user ID of the owner of the S3 bucket. + ResourceAwsS3BucketOwnerId []*StringFilter - // The AWS account ID that a finding is generated in. - AwsAccountId []*StringFilter + // The display name of the owner of the S3 bucket. + ResourceAwsS3BucketOwnerName []*StringFilter - // The label of a finding's severity. - SeverityLabel []*StringFilter + // The identifier of the image related to a finding. + ResourceContainerImageId []*StringFilter - // The ARN of the solution that generated a related finding. - RelatedFindingsProductArn []*StringFilter + // The name of the image related to a finding. + ResourceContainerImageName []*StringFilter - // A finding's title. - Title []*StringFilter + // The date/time that the container was started. + ResourceContainerLaunchedAt []*DateFilter - // The category of a threat intelligence indicator. - ThreatIntelIndicatorCategory []*StringFilter + // The name of the container related to a finding. + ResourceContainerName []*StringFilter + + // The details of a resource that doesn't have a specific subfield for the resource + // type defined. + ResourceDetailsOther []*MapFilter // The canonical identifier for the given resource type. ResourceId []*StringFilter - // The identifier of the subnet that the instance was launched in. - ResourceAwsEc2InstanceSubnetId []*StringFilter + // The canonical AWS partition name that the Region is assigned to. + ResourcePartition []*StringFilter - // A data type where security-findings providers can include additional - // solution-specific details that aren't part of the defined AwsSecurityFinding - // format. - ProductFields []*MapFilter + // The canonical AWS external Region name where this resource is located. + ResourceRegion []*StringFilter - // The updated record state for the finding. - RecordState []*StringFilter + // A list of AWS tags associated with a resource at the time the finding was + // processed. + ResourceTags []*MapFilter - // The Amazon Machine Image (AMI) ID of the instance. - ResourceAwsEc2InstanceImageId []*StringFilter + // Specifies the type of the resource that details are provided for. + ResourceType []*StringFilter - // The name of the findings provider (company) that owns the solution (product) - // that generates findings. - CompanyName []*StringFilter + // The label of a finding's severity. + SeverityLabel []*StringFilter + + // The normalized severity of a finding. + SeverityNormalized []*NumberFilter // The native severity as defined by the security-findings provider's solution that // generated the finding. SeverityProduct []*NumberFilter - // The status of the IAM access key related to a finding. - ResourceAwsIamAccessKeyStatus []*StringFilter - - // The ARN generated by Security Hub that uniquely identifies a third-party company - // (security findings provider) after this provider's product (solution that - // generates findings) is registered with Security Hub. - ProductArn []*StringFilter + // A URL that links to a page about the current finding in the security-findings + // provider's solution. + SourceUrl []*StringFilter - // The canonical AWS external Region name where this resource is located. - ResourceRegion []*StringFilter + // The category of a threat intelligence indicator. + ThreatIntelIndicatorCategory []*StringFilter // The date/time of the last observation of a threat intelligence indicator. ThreatIntelIndicatorLastObservedAt []*DateFilter - // A list of name/value string pairs associated with the finding. These are custom, - // user-defined fields added to a finding. - UserDefinedFields []*MapFilter + // The source of the threat intelligence. + ThreatIntelIndicatorSource []*StringFilter - // A finding's description. - Description []*StringFilter + // The URL for more details from the source of the threat intelligence. + ThreatIntelIndicatorSourceUrl []*StringFilter - // An ISO8601-formatted timestamp that indicates when the security-findings - // provider most recently observed the potential security issue that a finding - // captured. - LastObservedAt []*DateFilter + // The type of a threat intelligence indicator. + ThreatIntelIndicatorType []*StringFilter - // The name of the malware that was observed. - MalwareName []*StringFilter + // The value of a threat intelligence indicator. + ThreatIntelIndicatorValue []*StringFilter - // The URL for more details from the source of the threat intelligence. - ThreatIntelIndicatorSourceUrl []*StringFilter + // A finding's title. + Title []*StringFilter // A finding type in the format of namespace/category/classifier that classifies a // finding. Type []*StringFilter - // The key name associated with the instance. - ResourceAwsEc2InstanceKeyName []*StringFilter - - // The name of the container related to a finding. - ResourceContainerName []*StringFilter - - // The IPv6 addresses associated with the instance. - ResourceAwsEc2InstanceIpV6Addresses []*IpFilter - - // A URL that links to a page about the current finding in the security-findings - // provider's solution. - SourceUrl []*StringFilter - - // The source domain of network-related information about a finding. - NetworkSourceDomain []*StringFilter - - // The veracity of a finding. - VerificationState []*StringFilter - // An ISO8601-formatted timestamp that indicates when the security-findings // provider last updated the finding record. UpdatedAt []*DateFilter - // The destination domain of network-related information about a finding. - NetworkDestinationDomain []*StringFilter + // A list of name/value string pairs associated with the finding. These are custom, + // user-defined fields added to a finding. + UserDefinedFields []*MapFilter + + // The veracity of a finding. + VerificationState []*StringFilter // The workflow state of a finding. Note that this field is deprecated. To search // for a finding based on its workflow status, use WorkflowStatus. WorkflowState []*StringFilter - // A finding's confidence. Confidence is defined as the likelihood that a finding - // accurately identifies the behavior or issue that it was intended to identify. - // Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero - // percent confidence and 100 means 100 percent confidence. - Confidence []*NumberFilter - - // The name of the process. - ProcessName []*StringFilter - - // The source media access control (MAC) address of network-related information - // about a finding. - NetworkSourceMac []*StringFilter - - // The name of the solution (product) that generates findings. - ProductName []*StringFilter - - // The identifier for the solution-specific component (a discrete unit of logic) - // that generated a finding. In various security-findings providers' solutions, - // this generator can be called a rule, a check, a detector, a plugin, etc. - GeneratorId []*StringFilter - - // The canonical user ID of the owner of the S3 bucket. - ResourceAwsS3BucketOwnerId []*StringFilter - - // The text of a note. - NoteText []*StringFilter - - // A keyword for a finding. - Keyword []*KeywordFilter + // The status of the investigation into a finding. Allowed values are the + // following. + // + // * NEW - The initial state of a finding, before it is reviewed. + // + // + // * NOTIFIED - Indicates that the resource owner has been notified about the + // security issue. Used when the initial reviewer is not the resource owner, and + // needs intervention from the resource owner. + // + // * SUPPRESSED - The finding will + // not be reviewed again and will not be acted upon. + // + // * RESOLVED - The finding + // was reviewed and remediated and is now considered resolved. + WorkflowStatus []*StringFilter } // Identifies a finding to update using BatchUpdateFindings. @@ -1582,15 +1582,15 @@ type AwsSnsTopicDetails struct { // CMK. KmsMasterKeyId *string + // The subscription's owner. + Owner *string + // Subscription is an embedded property that describes the subscription endpoints // of an Amazon SNS topic. Subscription []*AwsSnsTopicSubscription // The name of the topic. TopicName *string - - // The subscription's owner. - Owner *string } // A wrapper type for the attributes of an Amazon SNS subscription. @@ -1606,13 +1606,6 @@ type AwsSnsTopicSubscription struct { // Data about a queue. type AwsSqsQueueDetails struct { - // The name of the new queue. - QueueName *string - - // The ID of an AWS managed customer master key (CMK) for Amazon SQS or a custom - // CMK. - KmsMasterKeyId *string - // The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS // moves messages after the value of maxReceiveCount is exceeded. DeadLetterTargetArn *string @@ -1620,13 +1613,20 @@ type AwsSqsQueueDetails struct { // The length of time, in seconds, for which Amazon SQS can reuse a data key to // encrypt or decrypt messages before calling AWS KMS again. KmsDataKeyReusePeriodSeconds *int32 + + // The ID of an AWS managed customer master key (CMK) for Amazon SQS or a custom + // CMK. + KmsMasterKeyId *string + + // The name of the new queue. + QueueName *string } // Details about a WAF WebACL. type AwsWafWebAclDetails struct { - // A unique identifier for a WebACL. - WebAclId *string + // The action to perform if none of the rules contained in the WebACL match. + DefaultAction *string // A friendly name or description of the WebACL. You can't change the name of a // WebACL after you create it. @@ -1636,13 +1636,20 @@ type AwsWafWebAclDetails struct { // rule, and the ID of the rule. Rules []*AwsWafWebAclRule - // The action to perform if none of the rules contained in the WebACL match. - DefaultAction *string + // A unique identifier for a WebACL. + WebAclId *string } // Details for a rule in a WAF WebACL. type AwsWafWebAclRule struct { + // Specifies the action that CloudFront or AWS WAF takes when a web request matches + // the conditions in the rule. + Action *WafAction + + // Rules to exclude from a rule group. + ExcludedRules []*WafExcludedRule + // Use the OverrideAction to test your RuleGroup. Any rule in a RuleGroup can // potentially block a request. If you set the OverrideAction to None, the // RuleGroup blocks a request if any individual rule in the RuleGroup matches the @@ -1655,10 +1662,6 @@ type AwsWafWebAclRule struct { // requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. OverrideAction *WafOverrideAction - // Specifies the action that CloudFront or AWS WAF takes when a web request matches - // the conditions in the rule. - Action *WafAction - // Specifies the order in which the rules in a WebACL are evaluated. Rules with a // lower value for Priority are evaluated before rules with a higher value. The // value must be a unique integer. If you add multiple rules to a WebACL, the @@ -1671,29 +1674,26 @@ type AwsWafWebAclRule struct { // The rule type. Valid values: REGULAR | RATE_BASED | GROUP The default is // REGULAR. Type *string - - // Rules to exclude from a rule group. - ExcludedRules []*WafExcludedRule } // A finding from a BatchUpdateFindings request that Security Hub was unable to // update. type BatchUpdateFindingsUnprocessedFinding struct { - // The identifier of the finding that was not updated. + // The code associated with the error. // // This member is required. - FindingIdentifier *AwsSecurityFindingIdentifier + ErrorCode *string // The message associated with the error. // // This member is required. ErrorMessage *string - // The code associated with the error. + // The identifier of the finding that was not updated. // // This member is required. - ErrorCode *string + FindingIdentifier *AwsSecurityFindingIdentifier } // An IPv4 CIDR block association. @@ -1713,6 +1713,11 @@ type CidrBlockAssociation struct { // returned for findings generated from controls. type Compliance struct { + // For a control, the industry or regulatory framework requirements that are + // related to the control. The check for that control is aligned with these + // requirements. + RelatedRequirements []*string + // The result of a standards check. The valid values for Status are as follows. // // @@ -1732,11 +1737,6 @@ type Compliance struct { // finding. Status ComplianceStatus - // For a control, the industry or regulatory framework requirements that are - // related to the control. The check for that control is aligned with these - // requirements. - RelatedRequirements []*string - // For findings generated from controls, a list of reasons behind the value of // Status. For the list of status reason codes and their meanings, see // Standards-related information in the ASFF @@ -1748,43 +1748,43 @@ type Compliance struct { // Container details related to a finding. type ContainerDetails struct { - // The name of the container related to a finding. - Name *string - // The identifier of the image related to a finding. ImageId *string + // The name of the image related to a finding. + ImageName *string + // The date and time when the container started. LaunchedAt *string - // The name of the image related to a finding. - ImageName *string + // The name of the container related to a finding. + Name *string } // CVSS scores from the advisory related to the vulnerability. type Cvss struct { - // The version of CVSS for the CVSS score. - Version *string - // The base CVSS score. BaseScore *float64 // The base scoring vector for the CVSS score. BaseVector *string + + // The version of CVSS for the CVSS score. + Version *string } // A date filter for querying findings. type DateFilter struct { - // A start date for the date filter. - Start *string + // A date range for the date filter. + DateRange *DateRange // An end date for the date filter. End *string - // A date range for the date filter. - DateRange *DateRange + // A start date for the date filter. + Start *string } // A date range for the date filter. @@ -1801,15 +1801,15 @@ type DateRange struct { // provides the error. type ImportFindingsError struct { - // The message of the error returned by the BatchImportFindings operation. + // The code of the error returned by the BatchImportFindings operation. // // This member is required. - ErrorMessage *string + ErrorCode *string - // The code of the error returned by the BatchImportFindings operation. + // The message of the error returned by the BatchImportFindings operation. // // This member is required. - ErrorCode *string + ErrorMessage *string // The identifier of the finding that could not be updated. // @@ -1820,34 +1820,40 @@ type ImportFindingsError struct { // Contains information about a Security Hub insight. type Insight struct { - // The name of a Security Hub insight. + // One or more attributes used to filter the findings included in the insight. The + // insight only includes findings that match the criteria defined in the filters. // // This member is required. - Name *string + Filters *AwsSecurityFindingFilters - // The ARN of a Security Hub insight. + // The grouping attribute for the insight's findings. Indicates how to group the + // matching findings, and identifies the type of item that the insight applies to. + // For example, if an insight is grouped by resource identifier, then the insight + // produces a list of resource identifiers. // // This member is required. - InsightArn *string + GroupByAttribute *string - // One or more attributes used to filter the findings included in the insight. The - // insight only includes findings that match the criteria defined in the filters. + // The ARN of a Security Hub insight. // // This member is required. - Filters *AwsSecurityFindingFilters + InsightArn *string - // The grouping attribute for the insight's findings. Indicates how to group the - // matching findings, and identifies the type of item that the insight applies to. - // For example, if an insight is grouped by resource identifier, then the insight - // produces a list of resource identifiers. + // The name of a Security Hub insight. // // This member is required. - GroupByAttribute *string + Name *string } // The insight results returned by the GetInsightResults operation. type InsightResults struct { + // The attribute that the findings are grouped by for the insight whose results are + // returned by the GetInsightResults operation. + // + // This member is required. + GroupByAttribute *string + // The ARN of the insight whose results are returned by the GetInsightResults // operation. // @@ -1858,27 +1864,21 @@ type InsightResults struct { // // This member is required. ResultValues []*InsightResultValue - - // The attribute that the findings are grouped by for the insight whose results are - // returned by the GetInsightResults operation. - // - // This member is required. - GroupByAttribute *string } // The insight result values returned by the GetInsightResults operation. type InsightResultValue struct { - // The value of the attribute that the findings are grouped by for the insight - // whose results are returned by the GetInsightResults operation. + // The number of findings returned for each GroupByAttributeValue. // // This member is required. - GroupByAttributeValue *string + Count *int32 - // The number of findings returned for each GroupByAttributeValue. + // The value of the attribute that the findings are grouped by for the insight + // whose results are returned by the GetInsightResults operation. // // This member is required. - Count *int32 + GroupByAttributeValue *string } // Details about an invitation. @@ -1888,14 +1888,14 @@ type Invitation struct { // from. AccountId *string - // The current status of the association between the member and master accounts. - MemberStatus *string - // The ID of the invitation sent to the member account. InvitationId *string // The timestamp of when the invitation was sent. InvitedAt *time.Time + + // The current status of the association between the member and master accounts. + MemberStatus *string } // The IP filter for querying findings. @@ -1940,84 +1940,81 @@ type LoadBalancerState struct { // A list of malware related to a finding. type Malware struct { - // The file system path of the malware that was observed. - Path *string - - // The type of the malware that was observed. - Type MalwareType - // The name of the malware that was observed. // // This member is required. Name *string + // The file system path of the malware that was observed. + Path *string + // The state of the malware that was observed. State MalwareState + + // The type of the malware that was observed. + Type MalwareType } // The map filter for querying findings. type MapFilter struct { - // The value for the key in the map filter. - Value *string - // The condition to apply to a key value when querying for findings with a map // filter. Comparison MapFilterComparison // The key of the map filter. Key *string + + // The value for the key in the map filter. + Value *string } // The details about a member account. type Member struct { - // The AWS account ID of the Security Hub master account associated with this - // member account. - MasterId *string + // The AWS account ID of the member account. + AccountId *string + + // The email address of the member account. + Email *string // A timestamp for the date and time when the invitation was sent to the member // account. InvitedAt *time.Time + // The AWS account ID of the Security Hub master account associated with this + // member account. + MasterId *string + // The status of the relationship between the member account and its master // account. MemberStatus *string // The timestamp for the date and time when the member account was updated. UpdatedAt *time.Time - - // The email address of the member account. - Email *string - - // The AWS account ID of the member account. - AccountId *string } // The details of network-related information about a finding. type Network struct { - // The source port of network-related information about a finding. - SourcePort *int32 - - // The destination IPv6 address of network-related information about a finding. - DestinationIpV6 *string - - // The source IPv6 address of network-related information about a finding. - SourceIpV6 *string + // The destination domain of network-related information about a finding. + DestinationDomain *string // The destination IPv4 address of network-related information about a finding. DestinationIpV4 *string + // The destination IPv6 address of network-related information about a finding. + DestinationIpV6 *string + // The destination port of network-related information about a finding. DestinationPort *int32 - // The range of open ports that is present on the network. - OpenPortRange *PortRange - // The direction of network traffic associated with a finding. Direction NetworkDirection + // The range of open ports that is present on the network. + OpenPortRange *PortRange + // The protocol of network-related information about a finding. Protocol *string @@ -2027,24 +2024,27 @@ type Network struct { // The source IPv4 address of network-related information about a finding. SourceIpV4 *string + // The source IPv6 address of network-related information about a finding. + SourceIpV6 *string + // The source media access control (MAC) address of network-related information // about a finding. SourceMac *string - // The destination domain of network-related information about a finding. - DestinationDomain *string + // The source port of network-related information about a finding. + SourcePort *int32 } // Details about a network path component that occurs before or after the current // component. type NetworkHeader struct { - // The protocol used for the component. - Protocol *string - // Information about the destination of the component. Destination *NetworkPathComponentDetails + // The protocol used for the component. + Protocol *string + // Information about the origin of the component. Source *NetworkPathComponentDetails } @@ -2052,12 +2052,12 @@ type NetworkHeader struct { // Information about a network path component. type NetworkPathComponent struct { - // The type of component. - ComponentType *string - // The identifier of a component in the network path. ComponentId *string + // The type of component. + ComponentType *string + // Information about the component that comes after the current component in the // network path. Egress *NetworkHeader @@ -2070,11 +2070,11 @@ type NetworkPathComponent struct { // Information about the destination of the next component in the network path. type NetworkPathComponentDetails struct { - // A list of port ranges for the destination. - PortRanges []*PortRange - // The IP addresses of the destination. Address []*string + + // A list of port ranges for the destination. + PortRanges []*PortRange } // A user-defined note added to a finding. @@ -2099,28 +2099,28 @@ type Note struct { // The updated note. type NoteUpdate struct { - // The principal that updated the note. + // The updated note text. // // This member is required. - UpdatedBy *string + Text *string - // The updated note text. + // The principal that updated the note. // // This member is required. - Text *string + UpdatedBy *string } // A number filter for querying findings. type NumberFilter struct { - // The greater-than-equal condition to be applied to a single field when querying - // for findings. - Gte *float64 - // The equal-to condition to be applied to a single field when querying for // findings. Eq *float64 + // The greater-than-equal condition to be applied to a single field when querying + // for findings. + Gte *float64 + // The less-than-equal condition to be applied to a single field when querying for // findings. Lte *float64 @@ -2129,53 +2129,55 @@ type NumberFilter struct { // A range of ports. type PortRange struct { - // The last port in the port range. - End *int32 - // The first port in the port range. Begin *int32 + + // The last port in the port range. + End *int32 } // The details of process-related information about a finding. type ProcessDetails struct { - // The process ID. - Pid *int32 - // The date/time that the process was launched. LaunchedAt *string + // The name of the process. + Name *string + // The parent process ID. ParentPid *int32 - // The date and time when the process was terminated. - TerminatedAt *string - // The path to the process executable. Path *string - // The name of the process. - Name *string + // The process ID. + Pid *int32 + + // The date and time when the process was terminated. + TerminatedAt *string } // Contains details about a product. type Product struct { - // The name of the product. - ProductName *string - - // A description of the product. - Description *string + // The ARN assigned to the product. + // + // This member is required. + ProductArn *string - // The resource policy associated with the product. - ProductSubscriptionResourcePolicy *string + // The URL used to activate the product. + ActivationUrl *string - // The URL for the page that contains more information about the product. - MarketplaceUrl *string + // The categories assigned to the product. + Categories []*string // The name of the company that provides the product. CompanyName *string + // A description of the product. + Description *string + // The types of integration that the product supports. Available values are the // following. // @@ -2186,16 +2188,14 @@ type Product struct { // Indicates that the integration receives findings from Security Hub. IntegrationTypes []IntegrationType - // The ARN assigned to the product. - // - // This member is required. - ProductArn *string + // The URL for the page that contains more information about the product. + MarketplaceUrl *string - // The URL used to activate the product. - ActivationUrl *string + // The name of the product. + ProductName *string - // The categories assigned to the product. - Categories []*string + // The resource policy associated with the product. + ProductSubscriptionResourcePolicy *string } // A recommendation on how to remediate the issue identified in a finding. @@ -2213,15 +2213,15 @@ type Recommendation struct { // Details about a related finding. type RelatedFinding struct { - // The ARN of the product that generated a related finding. + // The product-generated identifier for a related finding. // // This member is required. - ProductArn *string + Id *string - // The product-generated identifier for a related finding. + // The ARN of the product that generated a related finding. // // This member is required. - Id *string + ProductArn *string } // Details about the remediation steps for a finding. @@ -2235,8 +2235,10 @@ type Remediation struct { // A resource related to a finding. type Resource struct { - // The canonical AWS external Region name where this resource is located. - Region *string + // The canonical identifier for the given resource type. + // + // This member is required. + Id *string // The type of the resource that details are provided for. If possible, set Type to // one of the supported resource types. For example, if the resource is an EC2 @@ -2246,20 +2248,18 @@ type Resource struct { // This member is required. Type *string - // A list of AWS tags associated with a resource at the time the finding was - // processed. - Tags map[string]*string - // Additional details about the resource related to a finding. Details *ResourceDetails // The canonical AWS partition name that the Region is assigned to. Partition Partition - // The canonical identifier for the given resource type. - // - // This member is required. - Id *string + // The canonical AWS external Region name where this resource is located. + Region *string + + // A list of AWS tags associated with a resource at the time the finding was + // processed. + Tags map[string]*string } // Additional details about a resource related to a finding. To provide the @@ -2271,72 +2271,72 @@ type Resource struct { // the selected type does not have a corresponding object. type ResourceDetails struct { - // Details about an Amazon S3 object related to a finding. - AwsS3Object *AwsS3ObjectDetails + // Details for an autoscaling group. + AwsAutoScalingAutoScalingGroup *AwsAutoScalingAutoScalingGroupDetails - // Details about an SNS topic. - AwsSnsTopic *AwsSnsTopicDetails + // Details about a CloudFront distribution. + AwsCloudFrontDistribution *AwsCloudFrontDistributionDetails // Details for an AWS CodeBuild project. AwsCodeBuildProject *AwsCodeBuildProjectDetails - // Details about a container resource related to a finding. - Container *ContainerDetails - // Details about an Amazon EC2 instance related to a finding. AwsEc2Instance *AwsEc2InstanceDetails - // Details for an EC2 VPC. - AwsEc2Vpc *AwsEc2VpcDetails - - // Details about a KMS key. - AwsKmsKey *AwsKmsKeyDetails - - // Details for an autoscaling group. - AwsAutoScalingAutoScalingGroup *AwsAutoScalingAutoScalingGroupDetails + // Details for an Amazon EC2 network interface. + AwsEc2NetworkInterface *AwsEc2NetworkInterfaceDetails - // Details about a CloudFront distribution. - AwsCloudFrontDistribution *AwsCloudFrontDistributionDetails + // Details for an EC2 security group. + AwsEc2SecurityGroup *AwsEc2SecurityGroupDetails - // Details about a Lambda function. - AwsLambdaFunction *AwsLambdaFunctionDetails + // Details for an EC2 volume. + AwsEc2Volume *AwsEc2VolumeDetails - // Details about an Amazon S3 bucket related to a finding. - AwsS3Bucket *AwsS3BucketDetails + // Details for an EC2 VPC. + AwsEc2Vpc *AwsEc2VpcDetails - // Details for an Amazon EC2 network interface. - AwsEc2NetworkInterface *AwsEc2NetworkInterfaceDetails + // Details for an Elasticsearch domain. + AwsElasticsearchDomain *AwsElasticsearchDomainDetails - // Details about an SQS queue. - AwsSqsQueue *AwsSqsQueueDetails + // Details about a load balancer. + AwsElbv2LoadBalancer *AwsElbv2LoadBalancerDetails - // Details for an EC2 security group. - AwsEc2SecurityGroup *AwsEc2SecurityGroupDetails + // Details about an IAM access key related to a finding. + AwsIamAccessKey *AwsIamAccessKeyDetails // Details about an IAM role. AwsIamRole *AwsIamRoleDetails - // Details for an Elasticsearch domain. - AwsElasticsearchDomain *AwsElasticsearchDomainDetails + // Details about a KMS key. + AwsKmsKey *AwsKmsKeyDetails + + // Details about a Lambda function. + AwsLambdaFunction *AwsLambdaFunctionDetails + + // Details for a Lambda layer version. + AwsLambdaLayerVersion *AwsLambdaLayerVersionDetails // Details for an Amazon RDS database instance. AwsRdsDbInstance *AwsRdsDbInstanceDetails - // Details for an EC2 volume. - AwsEc2Volume *AwsEc2VolumeDetails + // Details about an Amazon S3 bucket related to a finding. + AwsS3Bucket *AwsS3BucketDetails - // Details about a load balancer. - AwsElbv2LoadBalancer *AwsElbv2LoadBalancerDetails + // Details about an Amazon S3 object related to a finding. + AwsS3Object *AwsS3ObjectDetails - // Details for a Lambda layer version. - AwsLambdaLayerVersion *AwsLambdaLayerVersionDetails + // Details about an SNS topic. + AwsSnsTopic *AwsSnsTopicDetails - // Details about an IAM access key related to a finding. - AwsIamAccessKey *AwsIamAccessKeyDetails + // Details about an SQS queue. + AwsSqsQueue *AwsSqsQueueDetails // Details for a WAF WebACL. AwsWafWebAcl *AwsWafWebAclDetails + // Details about a container resource related to a finding. + Container *ContainerDetails + // Details about a resource that are not available in a type-specific details // object. Use the Other object in the following cases. // @@ -2354,11 +2354,11 @@ type ResourceDetails struct { // Details about the account that was not processed. type Result struct { - // The reason that the account was not processed. - ProcessingResult *string - // An AWS account ID of the account that was not processed. AccountId *string + + // The reason that the account was not processed. + ProcessingResult *string } // The severity of the finding. The finding provider can provide the initial @@ -2370,31 +2370,6 @@ type Result struct { // attribute. type Severity struct { - // The native severity from the finding product that generated the finding. - Original *string - - // Deprecated. The normalized severity of a finding. This attribute is being - // deprecated. Instead of providing Normalized, provide Label. If you provide Label - // and do not provide Normalized, then Normalized is set automatically as - // follows. - // - // * INFORMATIONAL - 0 - // - // * LOW - 1 - // - // * MEDIUM - 40 - // - // * HIGH - // - 70 - // - // * CRITICAL - 90 - Normalized *int32 - - // Deprecated. This attribute is being deprecated. Instead of providing Product, - // provide Original. The native severity as defined by the AWS service or - // integrated partner product that generated the finding. - Product *float64 - // The severity value of the finding. The allowed values are the following. // // * @@ -2426,27 +2401,36 @@ type Severity struct { // // * 90–100 - CRITICAL Label SeverityLabel -} - -// Updates to the severity information for a finding. -type SeverityUpdate struct { - // The normalized severity for the finding. This attribute is to be deprecated in - // favor of Label. If you provide Normalized and do not provide Label, Label is set - // automatically as follows. + // Deprecated. The normalized severity of a finding. This attribute is being + // deprecated. Instead of providing Normalized, provide Label. If you provide Label + // and do not provide Normalized, then Normalized is set automatically as + // follows. // - // * 0 - INFORMATIONAL + // * INFORMATIONAL - 0 // - // * 1–39 - LOW + // * LOW - 1 // - // * - // 40–69 - MEDIUM + // * MEDIUM - 40 // - // * 70–89 - HIGH + // * HIGH + // - 70 // - // * 90–100 - CRITICAL + // * CRITICAL - 90 Normalized *int32 + // The native severity from the finding product that generated the finding. + Original *string + + // Deprecated. This attribute is being deprecated. Instead of providing Product, + // provide Original. The native severity as defined by the AWS service or + // integrated partner product that generated the finding. + Product *float64 +} + +// Updates to the severity information for a finding. +type SeverityUpdate struct { + // The severity value of the finding. The allowed values are the following. // // * @@ -2464,6 +2448,22 @@ type SeverityUpdate struct { // CRITICAL - The issue must be remediated immediately to avoid it escalating. Label SeverityLabel + // The normalized severity for the finding. This attribute is to be deprecated in + // favor of Label. If you provide Normalized and do not provide Label, Label is set + // automatically as follows. + // + // * 0 - INFORMATIONAL + // + // * 1–39 - LOW + // + // * + // 40–69 - MEDIUM + // + // * 70–89 - HIGH + // + // * 90–100 - CRITICAL + Normalized *int32 + // The native severity as defined by the AWS service or integrated partner product // that generated the finding. Product *float64 @@ -2472,20 +2472,20 @@ type SeverityUpdate struct { // Information about a software package. type SoftwarePackage struct { + // The architecture used for the software package. + Architecture *string + + // The epoch of the software package. + Epoch *string + // The name of the software package. Name *string - // The version of the software package. - Version *string - // The release of the software package. Release *string - // The epoch of the software package. - Epoch *string - - // The architecture used for the software package. - Architecture *string + // The version of the software package. + Version *string } // A collection of finding attributes used to sort findings. @@ -2501,8 +2501,8 @@ type SortCriterion struct { // Provides information about a specific standard. type Standard struct { - // The ARN of a standard. - StandardsArn *string + // A description of the standard. + Description *string // Whether the standard is enabled by default. When Security Hub is enabled from // the console, if a standard is enabled by default, the check box for that @@ -2511,89 +2511,89 @@ type Standard struct { // EnableDefaultStandards is set to false. EnabledByDefault *bool - // A description of the standard. - Description *string - // The name of the standard. Name *string + + // The ARN of a standard. + StandardsArn *string } // Details for an individual security standard control. type StandardsControl struct { - // A link to remediation information for the control in the Security Hub user - // documentation. - RemediationUrl *string + // The identifier of the security standard control. + ControlId *string // The current status of the security standard control. Indicates whether the // control is enabled or disabled. Security Hub does not check against disabled // controls. ControlStatus ControlStatus - // The list of requirements that are related to this control. - RelatedRequirements []*string - - // The identifier of the security standard control. - ControlId *string + // The date and time that the status of the security standard control was most + // recently updated. + ControlStatusUpdatedAt *time.Time // The longer description of the security standard control. Provides information // about what the control is checking for. Description *string - // The title of the security standard control. - Title *string - // The reason provided for the most recent change in status for the control. DisabledReason *string + // The list of requirements that are related to this control. + RelatedRequirements []*string + + // A link to remediation information for the control in the Security Hub user + // documentation. + RemediationUrl *string + // The severity of findings generated from this security standard control. The // finding severity is based on an assessment of how easy it would be to compromise // AWS resources if the issue is detected. SeverityRating SeverityRating - // The date and time that the status of the security standard control was most - // recently updated. - ControlStatusUpdatedAt *time.Time - // The ARN of the security standard control. StandardsControlArn *string + + // The title of the security standard control. + Title *string } // A resource that represents your subscription to a supported standard. type StandardsSubscription struct { - // The status of the standards subscription. + // The ARN of a standard. // // This member is required. - StandardsStatus StandardsStatus + StandardsArn *string - // The ARN of a standard. + // A key-value pair of input for the standard. // // This member is required. - StandardsArn *string + StandardsInput map[string]*string - // The ARN of a resource that represents your subscription to a supported standard. + // The status of the standards subscription. // // This member is required. - StandardsSubscriptionArn *string + StandardsStatus StandardsStatus - // A key-value pair of input for the standard. + // The ARN of a resource that represents your subscription to a supported standard. // // This member is required. - StandardsInput map[string]*string + StandardsSubscriptionArn *string } // The standard that you want to enable. type StandardsSubscriptionRequest struct { - // A key-value pair of input for the standard. - StandardsInput map[string]*string - // The ARN of the standard that you want to enable. To view the list of available // standards and their ARNs, use the DescribeStandards () operation. // // This member is required. StandardsArn *string + + // A key-value pair of input for the standard. + StandardsInput map[string]*string } // Provides additional context for the value of Compliance.Status. @@ -2624,8 +2624,15 @@ type StringFilter struct { // Details about the threat intelligence related to a finding. type ThreatIntelIndicator struct { - // The value of a threat intelligence indicator. - Value *string + // The category of a threat intelligence indicator. + Category ThreatIntelIndicatorCategory + + // The date and time when the most recent instance of a threat intelligence + // indicator was observed. + LastObservedAt *string + + // The source of the threat intelligence indicator. + Source *string // The URL to the page or site where you can get more information about the threat // intelligence indicator. @@ -2634,60 +2641,53 @@ type ThreatIntelIndicator struct { // The type of threat intelligence indicator. Type ThreatIntelIndicatorType - // The category of a threat intelligence indicator. - Category ThreatIntelIndicatorCategory - - // The source of the threat intelligence indicator. - Source *string - - // The date and time when the most recent instance of a threat intelligence - // indicator was observed. - LastObservedAt *string + // The value of a threat intelligence indicator. + Value *string } // A vulnerability associated with a finding. type Vulnerability struct { - // List of vulnerabilities that are related to this vulnerability. - RelatedVulnerabilities []*string + // The identifier of the vulnerability. + // + // This member is required. + Id *string // CVSS scores from the advisory related to the vulnerability. Cvss []*Cvss + // A list of URLs that provide additional information about the vulnerability. + ReferenceUrls []*string + + // List of vulnerabilities that are related to this vulnerability. + RelatedVulnerabilities []*string + // Information about the vendor that generates the vulnerability report. Vendor *VulnerabilityVendor // List of software packages that have the vulnerability. VulnerablePackages []*SoftwarePackage - - // The identifier of the vulnerability. - // - // This member is required. - Id *string - - // A list of URLs that provide additional information about the vulnerability. - ReferenceUrls []*string } // A vendor that generates a vulnerability report. type VulnerabilityVendor struct { + // The name of the vendor. + // + // This member is required. + Name *string + + // The URL of the vulnerability advisory. + Url *string + // The datetime when the vulnerability advisory was created. VendorCreatedAt *string - // The datetime when the vulnerability advisory was last updated. - VendorUpdatedAt *string - // The severity that the vendor assigned to the vulnerability. VendorSeverity *string - // The URL of the vulnerability advisory. - Url *string - - // The name of the vendor. - // - // This member is required. - Name *string + // The datetime when the vulnerability advisory was last updated. + VendorUpdatedAt *string } // Details about the action that CloudFront or AWS WAF takes when a web request diff --git a/service/serverlessapplicationrepository/api_op_CreateApplication.go b/service/serverlessapplicationrepository/api_op_CreateApplication.go index 582ee173f35..460f50812b2 100644 --- a/service/serverlessapplicationrepository/api_op_CreateApplication.go +++ b/service/serverlessapplicationrepository/api_op_CreateApplication.go @@ -58,108 +58,97 @@ func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicatio type CreateApplicationInput struct { + // The name of the author publishing the app.Minimum length=1. Maximum + // length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$"; + // + // This member is required. + Author *string + // The description of the application.Minimum length=1. Maximum length=256 // // This member is required. Description *string - // A valid identifier from https://spdx.org/licenses/ (https://spdx.org/licenses/). - SpdxLicenseId *string - - // The local raw packaged AWS SAM template file of your application. The file has - // the format file:///.You can specify only one of templateBody and - // templateUrl; otherwise an error results. - TemplateBody *string - - // The name of the author publishing the app.Minimum length=1. Maximum - // length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$"; + // The name of the application that you want to publish.Minimum length=1. Maximum + // length=140Pattern: "[a-zA-Z0-9\\-]+"; // // This member is required. - Author *string - - // A link to the S3 object containing the packaged AWS SAM template of your - // application.You can specify only one of templateBody and templateUrl; otherwise - // an error results. - TemplateUrl *string + Name *string // A URL with more information about the application, for example the location of // your GitHub repository for the application. HomePageUrl *string - // A link to the S3 object in Markdown language that contains a more detailed - // description of the application and how it works.Maximum size 5 MBYou can specify - // only one of readmeBody and readmeUrl; otherwise, an error results. - ReadmeUrl *string - - // A link to the S3 object that contains the license of the app that matches the - // spdxLicenseID value of your application.Maximum size 5 MBYou can specify only - // one of licenseBody and licenseUrl; otherwise, an error results. - LicenseUrl *string - // Labels to improve discovery of apps in search results.Minimum length=1. Maximum // length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; Labels []*string - // The semantic version of the application: https://semver.org/ - // (https://semver.org/) - SemanticVersion *string - - // The name of the application that you want to publish.Minimum length=1. Maximum - // length=140Pattern: "[a-zA-Z0-9\\-]+"; - // - // This member is required. - Name *string - // A local text file that contains the license of the app that matches the // spdxLicenseID value of your application. The file has the format // file:///.Maximum size 5 MBYou can specify only one of // licenseBody and licenseUrl; otherwise, an error results. LicenseBody *string + // A link to the S3 object that contains the license of the app that matches the + // spdxLicenseID value of your application.Maximum size 5 MBYou can specify only + // one of licenseBody and licenseUrl; otherwise, an error results. + LicenseUrl *string + // A local text readme file in Markdown language that contains a more detailed // description of the application and how it works. The file has the format // file:///.Maximum size 5 MBYou can specify only one of readmeBody // and readmeUrl; otherwise, an error results. ReadmeBody *string - // A link to a public repository for the source code of your application, for - // example the URL of a specific GitHub commit. - SourceCodeUrl *string + // A link to the S3 object in Markdown language that contains a more detailed + // description of the application and how it works.Maximum size 5 MBYou can specify + // only one of readmeBody and readmeUrl; otherwise, an error results. + ReadmeUrl *string + + // The semantic version of the application: https://semver.org/ + // (https://semver.org/) + SemanticVersion *string // A link to the S3 object that contains the ZIP archive of the source code for // this version of your application.Maximum size 50 MB SourceCodeArchiveUrl *string + + // A link to a public repository for the source code of your application, for + // example the URL of a specific GitHub commit. + SourceCodeUrl *string + + // A valid identifier from https://spdx.org/licenses/ (https://spdx.org/licenses/). + SpdxLicenseId *string + + // The local raw packaged AWS SAM template file of your application. The file has + // the format file:///.You can specify only one of templateBody and + // templateUrl; otherwise an error results. + TemplateBody *string + + // A link to the S3 object containing the packaged AWS SAM template of your + // application.You can specify only one of templateBody and templateUrl; otherwise + // an error results. + TemplateUrl *string } type CreateApplicationOutput struct { - // The description of the application.Minimum length=1. Maximum length=256 - Description *string + // The application Amazon Resource Name (ARN). + ApplicationId *string // The name of the author publishing the app.Minimum length=1. Maximum // length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$"; Author *string - // The application Amazon Resource Name (ARN). - ApplicationId *string - // The date and time this resource was created. CreationTime *string - // Version information about the application. - Version *types.Version - - // A link to a license file of the app that matches the spdxLicenseID value of your - // application.Maximum size 5 MB - LicenseUrl *string - - // A link to the readme file in Markdown language that contains a more detailed - // description of the application and how it works.Maximum size 5 MB - ReadmeUrl *string + // The description of the application.Minimum length=1. Maximum length=256 + Description *string - // The URL to the public profile of a verified author. This URL is submitted by the - // author. - VerifiedAuthorUrl *string + // A URL with more information about the application, for example the location of + // your GitHub repository for the application. + HomePageUrl *string // Whether the author of this application has been verified. This means means that // AWS has made a good faith review, as a reasonable and prudent service provider, @@ -167,21 +156,32 @@ type CreateApplicationOutput struct { // requester's identity is as claimed. IsVerifiedAuthor *bool + // Labels to improve discovery of apps in search results.Minimum length=1. Maximum + // length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; + Labels []*string + + // A link to a license file of the app that matches the spdxLicenseID value of your + // application.Maximum size 5 MB + LicenseUrl *string + // The name of the application.Minimum length=1. Maximum length=140Pattern: // "[a-zA-Z0-9\\-]+"; Name *string - // A URL with more information about the application, for example the location of - // your GitHub repository for the application. - HomePageUrl *string - - // Labels to improve discovery of apps in search results.Minimum length=1. Maximum - // length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; - Labels []*string + // A link to the readme file in Markdown language that contains a more detailed + // description of the application and how it works.Maximum size 5 MB + ReadmeUrl *string // A valid identifier from https://spdx.org/licenses/. SpdxLicenseId *string + // The URL to the public profile of a verified author. This URL is submitted by the + // author. + VerifiedAuthorUrl *string + + // Version information about the application. + Version *types.Version + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/serverlessapplicationrepository/api_op_CreateApplicationVersion.go b/service/serverlessapplicationrepository/api_op_CreateApplicationVersion.go index 7c80acebb0b..bac70abdf3d 100644 --- a/service/serverlessapplicationrepository/api_op_CreateApplicationVersion.go +++ b/service/serverlessapplicationrepository/api_op_CreateApplicationVersion.go @@ -57,14 +57,16 @@ func (c *Client) CreateApplicationVersion(ctx context.Context, params *CreateApp type CreateApplicationVersionInput struct { + // The Amazon Resource Name (ARN) of the application. + // + // This member is required. + ApplicationId *string + // The semantic version of the new version. // // This member is required. SemanticVersion *string - // A link to the packaged AWS SAM template of your application. - TemplateUrl *string - // A link to the S3 object that contains the ZIP archive of the source code for // this version of your application.Maximum size 50 MB SourceCodeArchiveUrl *string @@ -73,44 +75,23 @@ type CreateApplicationVersionInput struct { // example the URL of a specific GitHub commit. SourceCodeUrl *string - // The Amazon Resource Name (ARN) of the application. - // - // This member is required. - ApplicationId *string - // The raw packaged AWS SAM template of your application. TemplateBody *string -} - -type CreateApplicationVersionOutput struct { - - // A link to the S3 object that contains the ZIP archive of the source code for - // this version of your application.Maximum size 50 MB - SourceCodeArchiveUrl *string // A link to the packaged AWS SAM template of your application. TemplateUrl *string +} - // An array of parameter types supported by the application. - ParameterDefinitions []*types.ParameterDefinition - - // A link to a public repository for the source code of your application, for - // example the URL of a specific GitHub commit. - SourceCodeUrl *string +type CreateApplicationVersionOutput struct { - // The semantic version of the application: https://semver.org/ - // (https://semver.org/) - SemanticVersion *string + // The application Amazon Resource Name (ARN). + ApplicationId *string // The date and time this resource was created. CreationTime *string - // Whether all of the AWS resources contained in this application are supported in - // the region in which it is being retrieved. - ResourcesSupported *bool - - // The application Amazon Resource Name (ARN). - ApplicationId *string + // An array of parameter types supported by the application. + ParameterDefinitions []*types.ParameterDefinition // A list of values that you must specify before you can deploy certain // applications. Some applications might include resources that can affect @@ -149,6 +130,25 @@ type CreateApplicationVersionOutput struct { // application that requires capabilities, the call will fail. RequiredCapabilities []types.Capability + // Whether all of the AWS resources contained in this application are supported in + // the region in which it is being retrieved. + ResourcesSupported *bool + + // The semantic version of the application: https://semver.org/ + // (https://semver.org/) + SemanticVersion *string + + // A link to the S3 object that contains the ZIP archive of the source code for + // this version of your application.Maximum size 50 MB + SourceCodeArchiveUrl *string + + // A link to a public repository for the source code of your application, for + // example the URL of a specific GitHub commit. + SourceCodeUrl *string + + // A link to the packaged AWS SAM template of your application. + TemplateUrl *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/serverlessapplicationrepository/api_op_CreateCloudFormationChangeSet.go b/service/serverlessapplicationrepository/api_op_CreateCloudFormationChangeSet.go index 8b91df503f5..cd34f4da2e9 100644 --- a/service/serverlessapplicationrepository/api_op_CreateCloudFormationChangeSet.go +++ b/service/serverlessapplicationrepository/api_op_CreateCloudFormationChangeSet.go @@ -57,15 +57,10 @@ func (c *Client) CreateCloudFormationChangeSet(ctx context.Context, params *Crea type CreateCloudFormationChangeSetInput struct { - // The UUID returned by CreateCloudFormationTemplate.Pattern: - // [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12} - TemplateId *string - - // This property corresponds to the parameter of the same name for the AWS - // CloudFormation CreateChangeSet - // (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) - // API. - ChangeSetName *string + // The Amazon Resource Name (ARN) of the application. + // + // This member is required. + ApplicationId *string // This property corresponds to the parameter of the same name for the AWS // CloudFormation CreateChangeSet @@ -75,24 +70,6 @@ type CreateCloudFormationChangeSetInput struct { // This member is required. StackName *string - // This property corresponds to the parameter of the same name for the AWS - // CloudFormation CreateChangeSet - // (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) - // API. - Tags []*types.Tag - - // This property corresponds to the parameter of the same name for the AWS - // CloudFormation CreateChangeSet - // (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) - // API. - RollbackConfiguration *types.RollbackConfiguration - - // This property corresponds to the parameter of the same name for the AWS - // CloudFormation CreateChangeSet - // (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) - // API. - ResourceTypes []*string - // A list of values that you must specify before you can deploy certain // applications. Some applications might include resources that can affect // permissions in your AWS account, for example, by creating new AWS Identity and @@ -130,8 +107,17 @@ type CreateCloudFormationChangeSetInput struct { // application that requires capabilities, the call will fail. Capabilities []*string - // A list of parameter values for the parameters of the application. - ParameterOverrides []*types.ParameterValue + // This property corresponds to the parameter of the same name for the AWS + // CloudFormation CreateChangeSet + // (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) + // API. + ChangeSetName *string + + // This property corresponds to the parameter of the same name for the AWS + // CloudFormation CreateChangeSet + // (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) + // API. + ClientToken *string // This property corresponds to the parameter of the same name for the AWS // CloudFormation CreateChangeSet @@ -139,44 +125,58 @@ type CreateCloudFormationChangeSetInput struct { // API. Description *string - // The semantic version of the application: https://semver.org/ - // (https://semver.org/) - SemanticVersion *string + // This property corresponds to the parameter of the same name for the AWS + // CloudFormation CreateChangeSet + // (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) + // API. + NotificationArns []*string + + // A list of parameter values for the parameters of the application. + ParameterOverrides []*types.ParameterValue // This property corresponds to the parameter of the same name for the AWS // CloudFormation CreateChangeSet // (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) // API. - ClientToken *string + ResourceTypes []*string - // The Amazon Resource Name (ARN) of the application. - // - // This member is required. - ApplicationId *string + // This property corresponds to the parameter of the same name for the AWS + // CloudFormation CreateChangeSet + // (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) + // API. + RollbackConfiguration *types.RollbackConfiguration + + // The semantic version of the application: https://semver.org/ + // (https://semver.org/) + SemanticVersion *string // This property corresponds to the parameter of the same name for the AWS // CloudFormation CreateChangeSet // (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) // API. - NotificationArns []*string + Tags []*types.Tag + + // The UUID returned by CreateCloudFormationTemplate.Pattern: + // [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12} + TemplateId *string } type CreateCloudFormationChangeSetOutput struct { - // The Amazon Resource Name (ARN) of the change set.Length constraints: Minimum - // length of 1.Pattern: ARN:[-a-zA-Z0-9:/]* - ChangeSetId *string - // The application Amazon Resource Name (ARN). ApplicationId *string - // The unique ID of the stack. - StackId *string + // The Amazon Resource Name (ARN) of the change set.Length constraints: Minimum + // length of 1.Pattern: ARN:[-a-zA-Z0-9:/]* + ChangeSetId *string // The semantic version of the application: https://semver.org/ // (https://semver.org/) SemanticVersion *string + // The unique ID of the stack. + StackId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/serverlessapplicationrepository/api_op_CreateCloudFormationTemplate.go b/service/serverlessapplicationrepository/api_op_CreateCloudFormationTemplate.go index 07664123e1a..3d2339eb6a1 100644 --- a/service/serverlessapplicationrepository/api_op_CreateCloudFormationTemplate.go +++ b/service/serverlessapplicationrepository/api_op_CreateCloudFormationTemplate.go @@ -69,9 +69,19 @@ type CreateCloudFormationTemplateInput struct { type CreateCloudFormationTemplateOutput struct { + // The application Amazon Resource Name (ARN). + ApplicationId *string + + // The date and time this resource was created. + CreationTime *string + // The date and time this template expires. Templates expire 1 hour after creation. ExpirationTime *string + // The semantic version of the application: https://semver.org/ + // (https://semver.org/) + SemanticVersion *string + // Status of the template creation workflow.Possible values: PREPARING | ACTIVE | // EXPIRED Status types.Status @@ -80,16 +90,6 @@ type CreateCloudFormationTemplateOutput struct { // [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12} TemplateId *string - // The date and time this resource was created. - CreationTime *string - - // The application Amazon Resource Name (ARN). - ApplicationId *string - - // The semantic version of the application: https://semver.org/ - // (https://semver.org/) - SemanticVersion *string - // A link to the template that can be used to deploy the application using AWS // CloudFormation. TemplateUrl *string diff --git a/service/serverlessapplicationrepository/api_op_GetApplication.go b/service/serverlessapplicationrepository/api_op_GetApplication.go index 322909b667b..d3853f41ab6 100644 --- a/service/serverlessapplicationrepository/api_op_GetApplication.go +++ b/service/serverlessapplicationrepository/api_op_GetApplication.go @@ -57,31 +57,33 @@ func (c *Client) GetApplication(ctx context.Context, params *GetApplicationInput type GetApplicationInput struct { - // The semantic version of the application to get. - SemanticVersion *string - // The Amazon Resource Name (ARN) of the application. // // This member is required. ApplicationId *string + + // The semantic version of the application to get. + SemanticVersion *string } type GetApplicationOutput struct { - // The URL to the public profile of a verified author. This URL is submitted by the - // author. - VerifiedAuthorUrl *string - - // A link to the readme file in Markdown language that contains a more detailed - // description of the application and how it works.Maximum size 5 MB - ReadmeUrl *string - // The application Amazon Resource Name (ARN). ApplicationId *string - // A link to a license file of the app that matches the spdxLicenseID value of your - // application.Maximum size 5 MB - LicenseUrl *string + // The name of the author publishing the app.Minimum length=1. Maximum + // length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$"; + Author *string + + // The date and time this resource was created. + CreationTime *string + + // The description of the application.Minimum length=1. Maximum length=256 + Description *string + + // A URL with more information about the application, for example the location of + // your GitHub repository for the application. + HomePageUrl *string // Whether the author of this application has been verified. This means means that // AWS has made a good faith review, as a reasonable and prudent service provider, @@ -89,33 +91,31 @@ type GetApplicationOutput struct { // requester's identity is as claimed. IsVerifiedAuthor *bool - // The date and time this resource was created. - CreationTime *string - - // Version information about the application. - Version *types.Version - - // A valid identifier from https://spdx.org/licenses/. - SpdxLicenseId *string + // Labels to improve discovery of apps in search results.Minimum length=1. Maximum + // length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; + Labels []*string - // The description of the application.Minimum length=1. Maximum length=256 - Description *string + // A link to a license file of the app that matches the spdxLicenseID value of your + // application.Maximum size 5 MB + LicenseUrl *string // The name of the application.Minimum length=1. Maximum length=140Pattern: // "[a-zA-Z0-9\\-]+"; Name *string - // Labels to improve discovery of apps in search results.Minimum length=1. Maximum - // length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; - Labels []*string + // A link to the readme file in Markdown language that contains a more detailed + // description of the application and how it works.Maximum size 5 MB + ReadmeUrl *string - // The name of the author publishing the app.Minimum length=1. Maximum - // length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$"; - Author *string + // A valid identifier from https://spdx.org/licenses/. + SpdxLicenseId *string - // A URL with more information about the application, for example the location of - // your GitHub repository for the application. - HomePageUrl *string + // The URL to the public profile of a verified author. This URL is submitted by the + // author. + VerifiedAuthorUrl *string + + // Version information about the application. + Version *types.Version // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/serverlessapplicationrepository/api_op_GetCloudFormationTemplate.go b/service/serverlessapplicationrepository/api_op_GetCloudFormationTemplate.go index efc92893911..e4297569857 100644 --- a/service/serverlessapplicationrepository/api_op_GetCloudFormationTemplate.go +++ b/service/serverlessapplicationrepository/api_op_GetCloudFormationTemplate.go @@ -71,31 +71,31 @@ type GetCloudFormationTemplateInput struct { type GetCloudFormationTemplateOutput struct { - // The semantic version of the application: https://semver.org/ - // (https://semver.org/) - SemanticVersion *string + // The application Amazon Resource Name (ARN). + ApplicationId *string // The date and time this resource was created. CreationTime *string - // The UUID returned by CreateCloudFormationTemplate.Pattern: - // [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12} - TemplateId *string + // The date and time this template expires. Templates expire 1 hour after creation. + ExpirationTime *string - // The application Amazon Resource Name (ARN). - ApplicationId *string + // The semantic version of the application: https://semver.org/ + // (https://semver.org/) + SemanticVersion *string // Status of the template creation workflow.Possible values: PREPARING | ACTIVE | // EXPIRED Status types.Status + // The UUID returned by CreateCloudFormationTemplate.Pattern: + // [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12} + TemplateId *string + // A link to the template that can be used to deploy the application using AWS // CloudFormation. TemplateUrl *string - // The date and time this template expires. Templates expire 1 hour after creation. - ExpirationTime *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/serverlessapplicationrepository/api_op_ListApplicationDependencies.go b/service/serverlessapplicationrepository/api_op_ListApplicationDependencies.go index 502cc69c1f0..9212e6f82b6 100644 --- a/service/serverlessapplicationrepository/api_op_ListApplicationDependencies.go +++ b/service/serverlessapplicationrepository/api_op_ListApplicationDependencies.go @@ -57,14 +57,14 @@ func (c *Client) ListApplicationDependencies(ctx context.Context, params *ListAp type ListApplicationDependenciesInput struct { - // The total number of items to return. - MaxItems *int32 - // The Amazon Resource Name (ARN) of the application. // // This member is required. ApplicationId *string + // The total number of items to return. + MaxItems *int32 + // A token to specify where to start paginating. NextToken *string diff --git a/service/serverlessapplicationrepository/api_op_ListApplicationVersions.go b/service/serverlessapplicationrepository/api_op_ListApplicationVersions.go index b6ae7a6fdc8..77d18999640 100644 --- a/service/serverlessapplicationrepository/api_op_ListApplicationVersions.go +++ b/service/serverlessapplicationrepository/api_op_ListApplicationVersions.go @@ -57,14 +57,14 @@ func (c *Client) ListApplicationVersions(ctx context.Context, params *ListApplic type ListApplicationVersionsInput struct { - // The total number of items to return. - MaxItems *int32 - // The Amazon Resource Name (ARN) of the application. // // This member is required. ApplicationId *string + // The total number of items to return. + MaxItems *int32 + // A token to specify where to start paginating. NextToken *string } diff --git a/service/serverlessapplicationrepository/api_op_ListApplications.go b/service/serverlessapplicationrepository/api_op_ListApplications.go index 0cee2c63b0c..42064924218 100644 --- a/service/serverlessapplicationrepository/api_op_ListApplications.go +++ b/service/serverlessapplicationrepository/api_op_ListApplications.go @@ -56,11 +56,11 @@ func (c *Client) ListApplications(ctx context.Context, params *ListApplicationsI type ListApplicationsInput struct { - // A token to specify where to start paginating. - NextToken *string - // The total number of items to return. MaxItems *int32 + + // A token to specify where to start paginating. + NextToken *string } type ListApplicationsOutput struct { diff --git a/service/serverlessapplicationrepository/api_op_PutApplicationPolicy.go b/service/serverlessapplicationrepository/api_op_PutApplicationPolicy.go index f63801d7f83..3d66668212c 100644 --- a/service/serverlessapplicationrepository/api_op_PutApplicationPolicy.go +++ b/service/serverlessapplicationrepository/api_op_PutApplicationPolicy.go @@ -60,15 +60,15 @@ func (c *Client) PutApplicationPolicy(ctx context.Context, params *PutApplicatio type PutApplicationPolicyInput struct { - // An array of policy statements applied to the application. + // The Amazon Resource Name (ARN) of the application. // // This member is required. - Statements []*types.ApplicationPolicyStatement + ApplicationId *string - // The Amazon Resource Name (ARN) of the application. + // An array of policy statements applied to the application. // // This member is required. - ApplicationId *string + Statements []*types.ApplicationPolicyStatement } type PutApplicationPolicyOutput struct { diff --git a/service/serverlessapplicationrepository/api_op_UnshareApplication.go b/service/serverlessapplicationrepository/api_op_UnshareApplication.go index 2776dd66696..a5dbeea513a 100644 --- a/service/serverlessapplicationrepository/api_op_UnshareApplication.go +++ b/service/serverlessapplicationrepository/api_op_UnshareApplication.go @@ -57,15 +57,15 @@ func (c *Client) UnshareApplication(ctx context.Context, params *UnshareApplicat type UnshareApplicationInput struct { - // The AWS Organization ID to unshare the application from. + // The Amazon Resource Name (ARN) of the application. // // This member is required. - OrganizationId *string + ApplicationId *string - // The Amazon Resource Name (ARN) of the application. + // The AWS Organization ID to unshare the application from. // // This member is required. - ApplicationId *string + OrganizationId *string } type UnshareApplicationOutput struct { diff --git a/service/serverlessapplicationrepository/api_op_UpdateApplication.go b/service/serverlessapplicationrepository/api_op_UpdateApplication.go index 6de181fff78..ec423a9a531 100644 --- a/service/serverlessapplicationrepository/api_op_UpdateApplication.go +++ b/service/serverlessapplicationrepository/api_op_UpdateApplication.go @@ -69,14 +69,6 @@ type UpdateApplicationInput struct { // The description of the application.Minimum length=1. Maximum length=256 Description *string - // A link to the readme file in Markdown language that contains a more detailed - // description of the application and how it works.Maximum size 5 MB - ReadmeUrl *string - - // A text readme file in Markdown language that contains a more detailed - // description of the application and how it works.Maximum size 5 MB - ReadmeBody *string - // A URL with more information about the application, for example the location of // your GitHub repository for the application. HomePageUrl *string @@ -84,13 +76,18 @@ type UpdateApplicationInput struct { // Labels to improve discovery of apps in search results.Minimum length=1. Maximum // length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; Labels []*string + + // A text readme file in Markdown language that contains a more detailed + // description of the application and how it works.Maximum size 5 MB + ReadmeBody *string + + // A link to the readme file in Markdown language that contains a more detailed + // description of the application and how it works.Maximum size 5 MB + ReadmeUrl *string } type UpdateApplicationOutput struct { - // The date and time this resource was created. - CreationTime *string - // The application Amazon Resource Name (ARN). ApplicationId *string @@ -98,20 +95,15 @@ type UpdateApplicationOutput struct { // length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$"; Author *string - // The URL to the public profile of a verified author. This URL is submitted by the - // author. - VerifiedAuthorUrl *string - - // Version information about the application. - Version *types.Version + // The date and time this resource was created. + CreationTime *string - // The name of the application.Minimum length=1. Maximum length=140Pattern: - // "[a-zA-Z0-9\\-]+"; - Name *string + // The description of the application.Minimum length=1. Maximum length=256 + Description *string - // A link to a license file of the app that matches the spdxLicenseID value of your - // application.Maximum size 5 MB - LicenseUrl *string + // A URL with more information about the application, for example the location of + // your GitHub repository for the application. + HomePageUrl *string // Whether the author of this application has been verified. This means means that // AWS has made a good faith review, as a reasonable and prudent service provider, @@ -119,23 +111,31 @@ type UpdateApplicationOutput struct { // requester's identity is as claimed. IsVerifiedAuthor *bool + // Labels to improve discovery of apps in search results.Minimum length=1. Maximum + // length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; + Labels []*string + + // A link to a license file of the app that matches the spdxLicenseID value of your + // application.Maximum size 5 MB + LicenseUrl *string + + // The name of the application.Minimum length=1. Maximum length=140Pattern: + // "[a-zA-Z0-9\\-]+"; + Name *string + // A link to the readme file in Markdown language that contains a more detailed // description of the application and how it works.Maximum size 5 MB ReadmeUrl *string - // The description of the application.Minimum length=1. Maximum length=256 - Description *string - // A valid identifier from https://spdx.org/licenses/. SpdxLicenseId *string - // A URL with more information about the application, for example the location of - // your GitHub repository for the application. - HomePageUrl *string + // The URL to the public profile of a verified author. This URL is submitted by the + // author. + VerifiedAuthorUrl *string - // Labels to improve discovery of apps in search results.Minimum length=1. Maximum - // length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; - Labels []*string + // Version information about the application. + Version *types.Version // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/serverlessapplicationrepository/go.mod b/service/serverlessapplicationrepository/go.mod index c1c34ce189a..dcdcf4a4851 100644 --- a/service/serverlessapplicationrepository/go.mod +++ b/service/serverlessapplicationrepository/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/serverlessapplicationrepository go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/serverlessapplicationrepository/types/types.go b/service/serverlessapplicationrepository/types/types.go index 7720bb88bb6..79db2b77db0 100644 --- a/service/serverlessapplicationrepository/types/types.go +++ b/service/serverlessapplicationrepository/types/types.go @@ -19,11 +19,6 @@ type ApplicationDependencySummary struct { // Policy statement applied to the application. type ApplicationPolicyStatement struct { - // An array of PrinciplalOrgIDs, which corresponds to AWS IAM aws:PrincipalOrgID - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#principal-org-id) - // global condition key. - PrincipalOrgIDs []*string - // For the list of actions supported for this operation, see Application // Permissions // (https://docs.aws.amazon.com/serverlessrepo/latest/devguide/access-control-resource-based.html#application-permissions). @@ -36,6 +31,11 @@ type ApplicationPolicyStatement struct { // This member is required. Principals []*string + // An array of PrinciplalOrgIDs, which corresponds to AWS IAM aws:PrincipalOrgID + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#principal-org-id) + // global condition key. + PrincipalOrgIDs []*string + // A unique ID for the statement. StatementId *string } @@ -48,17 +48,6 @@ type ApplicationSummary struct { // This member is required. ApplicationId *string - // A valid identifier from https://spdx.org/licenses/ (https://spdx.org/licenses/). - SpdxLicenseId *string - - // A URL with more information about the application, for example the location of - // your GitHub repository for the application. - HomePageUrl *string - - // Labels to improve discovery of apps in search results.Minimum length=1. Maximum - // length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; - Labels []*string - // The name of the author publishing the app.Minimum length=1. Maximum // length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$"; // @@ -70,43 +59,45 @@ type ApplicationSummary struct { // This member is required. Description *string - // The date and time this resource was created. - CreationTime *string - // The name of the application.Minimum length=1. Maximum length=140Pattern: // "[a-zA-Z0-9\\-]+"; // // This member is required. Name *string + + // The date and time this resource was created. + CreationTime *string + + // A URL with more information about the application, for example the location of + // your GitHub repository for the application. + HomePageUrl *string + + // Labels to improve discovery of apps in search results.Minimum length=1. Maximum + // length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; + Labels []*string + + // A valid identifier from https://spdx.org/licenses/ (https://spdx.org/licenses/). + SpdxLicenseId *string } // Parameters supported by the application. type ParameterDefinition struct { - // An integer value that determines the smallest number of characters that you want - // to allow for String types. - MinLength *int32 - // The name of the parameter. // // This member is required. Name *string - // A value of the appropriate type for the template to use if no value is specified - // when a stack is created. If you define constraints for the parameter, you must - // specify a value that adheres to those constraints. - DefaultValue *string - - // A numeric value that determines the largest numeric value that you want to allow - // for Number types. - MaxValue *int32 + // A list of AWS SAM resources that use this parameter. + // + // This member is required. + ReferencedByResources []*string // A regular expression that represents the patterns to allow for String types. AllowedPattern *string - // An integer value that determines the largest number of characters that you want - // to allow for String types. - MaxLength *int32 + // An array containing the list of values allowed for the parameter. + AllowedValues []*string // A string that explains a constraint when the constraint is violated. For // example, without a constraint description, a parameter that has an allowed @@ -118,12 +109,34 @@ type ParameterDefinition struct { // only uppercase and lowercase letters and numbers. ConstraintDescription *string + // A value of the appropriate type for the template to use if no value is specified + // when a stack is created. If you define constraints for the parameter, you must + // specify a value that adheres to those constraints. + DefaultValue *string + + // A string of up to 4,000 characters that describes the parameter. + Description *string + + // An integer value that determines the largest number of characters that you want + // to allow for String types. + MaxLength *int32 + + // A numeric value that determines the largest numeric value that you want to allow + // for Number types. + MaxValue *int32 + + // An integer value that determines the smallest number of characters that you want + // to allow for String types. + MinLength *int32 + // A numeric value that determines the smallest numeric value that you want to // allow for Number types. MinValue *int32 - // An array containing the list of values allowed for the parameter. - AllowedValues []*string + // Whether to mask the parameter value whenever anyone makes a call that describes + // the stack. If you set the value to true, the parameter value is masked with + // asterisks (*****). + NoEcho *bool // The type of the parameter.Valid values: String | Number | List | // CommaDelimitedList String: A literal string.For example, users can specify @@ -141,19 +154,6 @@ type ParameterDefinition struct { // space-trimmed.For example, users might specify "test,dev,prod", and then Ref // results in ["test","dev","prod"]. Type *string - - // A string of up to 4,000 characters that describes the parameter. - Description *string - - // A list of AWS SAM resources that use this parameter. - // - // This member is required. - ReferencedByResources []*string - - // Whether to mask the parameter value whenever anyone makes a call that describes - // the stack. If you set the value to true, the parameter value is masked with - // asterisks (*****). - NoEcho *bool } // Parameter value of the application. @@ -237,6 +237,21 @@ type Tag struct { // Application version details. type Version struct { + // The application Amazon Resource Name (ARN). + // + // This member is required. + ApplicationId *string + + // The date and time this resource was created. + // + // This member is required. + CreationTime *string + + // An array of parameter types supported by the application. + // + // This member is required. + ParameterDefinitions []*ParameterDefinition + // A list of values that you must specify before you can deploy certain // applications. Some applications might include resources that can affect // permissions in your AWS account, for example, by creating new AWS Identity and @@ -276,30 +291,17 @@ type Version struct { // This member is required. RequiredCapabilities []Capability - // The semantic version of the application: https://semver.org/ - // (https://semver.org/) - // - // This member is required. - SemanticVersion *string - - // The application Amazon Resource Name (ARN). - // - // This member is required. - ApplicationId *string - - // An array of parameter types supported by the application. + // Whether all of the AWS resources contained in this application are supported in + // the region in which it is being retrieved. // // This member is required. - ParameterDefinitions []*ParameterDefinition - - // A link to a public repository for the source code of your application, for - // example the URL of a specific GitHub commit. - SourceCodeUrl *string + ResourcesSupported *bool - // The date and time this resource was created. + // The semantic version of the application: https://semver.org/ + // (https://semver.org/) // // This member is required. - CreationTime *string + SemanticVersion *string // A link to the packaged AWS SAM template of your application. // @@ -310,20 +312,14 @@ type Version struct { // this version of your application.Maximum size 50 MB SourceCodeArchiveUrl *string - // Whether all of the AWS resources contained in this application are supported in - // the region in which it is being retrieved. - // - // This member is required. - ResourcesSupported *bool + // A link to a public repository for the source code of your application, for + // example the URL of a specific GitHub commit. + SourceCodeUrl *string } // An application version summary. type VersionSummary struct { - // A link to a public repository for the source code of your application, for - // example the URL of a specific GitHub commit. - SourceCodeUrl *string - // The application Amazon Resource Name (ARN). // // This member is required. @@ -339,4 +335,8 @@ type VersionSummary struct { // // This member is required. SemanticVersion *string + + // A link to a public repository for the source code of your application, for + // example the URL of a specific GitHub commit. + SourceCodeUrl *string } diff --git a/service/servicecatalog/api_op_AcceptPortfolioShare.go b/service/servicecatalog/api_op_AcceptPortfolioShare.go index d6d5c291177..98cccc6db45 100644 --- a/service/servicecatalog/api_op_AcceptPortfolioShare.go +++ b/service/servicecatalog/api_op_AcceptPortfolioShare.go @@ -57,6 +57,11 @@ func (c *Client) AcceptPortfolioShare(ctx context.Context, params *AcceptPortfol type AcceptPortfolioShareInput struct { + // The portfolio identifier. + // + // This member is required. + PortfolioId *string + // The language code. // // * en - English (default) @@ -82,11 +87,6 @@ type AcceptPortfolioShareInput struct { // example, aws servicecatalog accept-portfolio-share --portfolio-id // "port-2qwzkwxt3y5fk" --portfolio-share-type AWS_ORGANIZATIONS PortfolioShareType types.PortfolioShareType - - // The portfolio identifier. - // - // This member is required. - PortfolioId *string } type AcceptPortfolioShareOutput struct { diff --git a/service/servicecatalog/api_op_AssociatePrincipalWithPortfolio.go b/service/servicecatalog/api_op_AssociatePrincipalWithPortfolio.go index 2dd87094a91..8fc3f501ab5 100644 --- a/service/servicecatalog/api_op_AssociatePrincipalWithPortfolio.go +++ b/service/servicecatalog/api_op_AssociatePrincipalWithPortfolio.go @@ -57,16 +57,21 @@ func (c *Client) AssociatePrincipalWithPortfolio(ctx context.Context, params *As type AssociatePrincipalWithPortfolioInput struct { - // The principal type. The supported value is IAM. + // The portfolio identifier. // // This member is required. - PrincipalType types.PrincipalType + PortfolioId *string // The ARN of the principal (IAM user, role, or group). // // This member is required. PrincipalARN *string + // The principal type. The supported value is IAM. + // + // This member is required. + PrincipalType types.PrincipalType + // The language code. // // * en - English (default) @@ -76,11 +81,6 @@ type AssociatePrincipalWithPortfolioInput struct { // * zh // - Chinese AcceptLanguage *string - - // The portfolio identifier. - // - // This member is required. - PortfolioId *string } type AssociatePrincipalWithPortfolioOutput struct { diff --git a/service/servicecatalog/api_op_AssociateProductWithPortfolio.go b/service/servicecatalog/api_op_AssociateProductWithPortfolio.go index 72d36b225e0..395bc00c29a 100644 --- a/service/servicecatalog/api_op_AssociateProductWithPortfolio.go +++ b/service/servicecatalog/api_op_AssociateProductWithPortfolio.go @@ -57,14 +57,16 @@ func (c *Client) AssociateProductWithPortfolio(ctx context.Context, params *Asso type AssociateProductWithPortfolioInput struct { - // The identifier of the source portfolio. - SourcePortfolioId *string - // The portfolio identifier. // // This member is required. PortfolioId *string + // The product identifier. + // + // This member is required. + ProductId *string + // The language code. // // * en - English (default) @@ -75,10 +77,8 @@ type AssociateProductWithPortfolioInput struct { // - Chinese AcceptLanguage *string - // The product identifier. - // - // This member is required. - ProductId *string + // The identifier of the source portfolio. + SourcePortfolioId *string } type AssociateProductWithPortfolioOutput struct { diff --git a/service/servicecatalog/api_op_AssociateServiceActionWithProvisioningArtifact.go b/service/servicecatalog/api_op_AssociateServiceActionWithProvisioningArtifact.go index 6b4487e6795..4abe849e04b 100644 --- a/service/servicecatalog/api_op_AssociateServiceActionWithProvisioningArtifact.go +++ b/service/servicecatalog/api_op_AssociateServiceActionWithProvisioningArtifact.go @@ -56,30 +56,30 @@ func (c *Client) AssociateServiceActionWithProvisioningArtifact(ctx context.Cont type AssociateServiceActionWithProvisioningArtifactInput struct { - // The language code. - // - // * en - English (default) - // - // * jp - Japanese - // - // * zh - // - Chinese - AcceptLanguage *string - // The product identifier. For example, prod-abcdzk7xy33qa. // // This member is required. ProductId *string + // The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne. + // + // This member is required. + ProvisioningArtifactId *string + // The self-service action identifier. For example, act-fs7abcd89wxyz. // // This member is required. ServiceActionId *string - // The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne. + // The language code. // - // This member is required. - ProvisioningArtifactId *string + // * en - English (default) + // + // * jp - Japanese + // + // * zh + // - Chinese + AcceptLanguage *string } type AssociateServiceActionWithProvisioningArtifactOutput struct { diff --git a/service/servicecatalog/api_op_AssociateTagOptionWithResource.go b/service/servicecatalog/api_op_AssociateTagOptionWithResource.go index 2f75dcded97..95fce261fe8 100644 --- a/service/servicecatalog/api_op_AssociateTagOptionWithResource.go +++ b/service/servicecatalog/api_op_AssociateTagOptionWithResource.go @@ -56,15 +56,15 @@ func (c *Client) AssociateTagOptionWithResource(ctx context.Context, params *Ass type AssociateTagOptionWithResourceInput struct { - // The TagOption identifier. + // The resource identifier. // // This member is required. - TagOptionId *string + ResourceId *string - // The resource identifier. + // The TagOption identifier. // // This member is required. - ResourceId *string + TagOptionId *string } type AssociateTagOptionWithResourceOutput struct { diff --git a/service/servicecatalog/api_op_BatchDisassociateServiceActionFromProvisioningArtifact.go b/service/servicecatalog/api_op_BatchDisassociateServiceActionFromProvisioningArtifact.go index 65a8df08fc6..a81cbd5aa9c 100644 --- a/service/servicecatalog/api_op_BatchDisassociateServiceActionFromProvisioningArtifact.go +++ b/service/servicecatalog/api_op_BatchDisassociateServiceActionFromProvisioningArtifact.go @@ -58,6 +58,12 @@ func (c *Client) BatchDisassociateServiceActionFromProvisioningArtifact(ctx cont type BatchDisassociateServiceActionFromProvisioningArtifactInput struct { + // One or more associations, each consisting of the Action ID, the Product ID, and + // the Provisioning Artifact ID. + // + // This member is required. + ServiceActionAssociations []*types.ServiceActionAssociation + // The language code. // // * en - English (default) @@ -67,12 +73,6 @@ type BatchDisassociateServiceActionFromProvisioningArtifactInput struct { // * zh // - Chinese AcceptLanguage *string - - // One or more associations, each consisting of the Action ID, the Product ID, and - // the Provisioning Artifact ID. - // - // This member is required. - ServiceActionAssociations []*types.ServiceActionAssociation } type BatchDisassociateServiceActionFromProvisioningArtifactOutput struct { diff --git a/service/servicecatalog/api_op_CopyProduct.go b/service/servicecatalog/api_op_CopyProduct.go index 5a13b381b6e..ab121f478ac 100644 --- a/service/servicecatalog/api_op_CopyProduct.go +++ b/service/servicecatalog/api_op_CopyProduct.go @@ -63,18 +63,18 @@ func (c *Client) CopyProduct(ctx context.Context, params *CopyProductInput, optF type CopyProductInput struct { + // A unique identifier that you provide to ensure idempotency. If multiple requests + // differ only by the idempotency token, the same response is returned for each + // repeated request. + // + // This member is required. + IdempotencyToken *string + // The Amazon Resource Name (ARN) of the source product. // // This member is required. SourceProductArn *string - // A name for the target product. The default is the name of the source product. - TargetProductName *string - - // The identifiers of the provisioning artifacts (also known as versions) of the - // product to copy. By default, all provisioning artifacts are copied. - SourceProvisioningArtifactIdentifiers []map[string]*string - // The language code. // // * en - English (default) @@ -89,15 +89,15 @@ type CopyProductInput struct { // copied to the target product. CopyOptions []types.CopyOption + // The identifiers of the provisioning artifacts (also known as versions) of the + // product to copy. By default, all provisioning artifacts are copied. + SourceProvisioningArtifactIdentifiers []map[string]*string + // The identifier of the target product. By default, a new product is created. TargetProductId *string - // A unique identifier that you provide to ensure idempotency. If multiple requests - // differ only by the idempotency token, the same response is returned for each - // repeated request. - // - // This member is required. - IdempotencyToken *string + // A name for the target product. The default is the name of the source product. + TargetProductName *string } type CopyProductOutput struct { diff --git a/service/servicecatalog/api_op_CreateConstraint.go b/service/servicecatalog/api_op_CreateConstraint.go index 5244ecf8573..fc40ae7fc1d 100644 --- a/service/servicecatalog/api_op_CreateConstraint.go +++ b/service/servicecatalog/api_op_CreateConstraint.go @@ -59,6 +59,13 @@ func (c *Client) CreateConstraint(ctx context.Context, params *CreateConstraintI type CreateConstraintInput struct { + // A unique identifier that you provide to ensure idempotency. If multiple requests + // differ only by the idempotency token, the same response is returned for each + // repeated request. + // + // This member is required. + IdempotencyToken *string + // The constraint parameters, in JSON format. The syntax depends on the constraint // type as follows: LAUNCH You are required to specify either the RoleArn or the // LocalRoleName but can't use both. Specify the RoleArn property as follows: @@ -88,8 +95,15 @@ type CreateConstraintInput struct { // This member is required. Parameters *string - // The description of the constraint. - Description *string + // The portfolio identifier. + // + // This member is required. + PortfolioId *string + + // The product identifier. + // + // This member is required. + ProductId *string // The type of constraint. // @@ -107,23 +121,6 @@ type CreateConstraintInput struct { // This member is required. Type *string - // A unique identifier that you provide to ensure idempotency. If multiple requests - // differ only by the idempotency token, the same response is returned for each - // repeated request. - // - // This member is required. - IdempotencyToken *string - - // The portfolio identifier. - // - // This member is required. - PortfolioId *string - - // The product identifier. - // - // This member is required. - ProductId *string - // The language code. // // * en - English (default) @@ -133,16 +130,19 @@ type CreateConstraintInput struct { // * zh // - Chinese AcceptLanguage *string + + // The description of the constraint. + Description *string } type CreateConstraintOutput struct { - // The constraint parameters. - ConstraintParameters *string - // Information about the constraint. ConstraintDetail *types.ConstraintDetail + // The constraint parameters. + ConstraintParameters *string + // The status of the current request. Status types.Status diff --git a/service/servicecatalog/api_op_CreatePortfolio.go b/service/servicecatalog/api_op_CreatePortfolio.go index 8154fcf4917..0a1cb14a58b 100644 --- a/service/servicecatalog/api_op_CreatePortfolio.go +++ b/service/servicecatalog/api_op_CreatePortfolio.go @@ -59,14 +59,23 @@ func (c *Client) CreatePortfolio(ctx context.Context, params *CreatePortfolioInp type CreatePortfolioInput struct { + // The name to use for display purposes. + // + // This member is required. + DisplayName *string + + // A unique identifier that you provide to ensure idempotency. If multiple requests + // differ only by the idempotency token, the same response is returned for each + // repeated request. + // + // This member is required. + IdempotencyToken *string + // The name of the portfolio provider. // // This member is required. ProviderName *string - // The description of the portfolio. - Description *string - // The language code. // // * en - English (default) @@ -77,17 +86,8 @@ type CreatePortfolioInput struct { // - Chinese AcceptLanguage *string - // The name to use for display purposes. - // - // This member is required. - DisplayName *string - - // A unique identifier that you provide to ensure idempotency. If multiple requests - // differ only by the idempotency token, the same response is returned for each - // repeated request. - // - // This member is required. - IdempotencyToken *string + // The description of the portfolio. + Description *string // One or more tags. Tags []*types.Tag diff --git a/service/servicecatalog/api_op_CreatePortfolioShare.go b/service/servicecatalog/api_op_CreatePortfolioShare.go index 636bfe3b553..befc3e6b1f1 100644 --- a/service/servicecatalog/api_op_CreatePortfolioShare.go +++ b/service/servicecatalog/api_op_CreatePortfolioShare.go @@ -64,14 +64,10 @@ func (c *Client) CreatePortfolioShare(ctx context.Context, params *CreatePortfol type CreatePortfolioShareInput struct { - // The AWS account ID. For example, 123456789012. - AccountId *string - - // The organization node to whom you are going to share. If OrganizationNode is - // passed in, PortfolioShare will be created for the node and its children (when - // applies), and a PortfolioShareToken will be returned in the output in order for - // the administrator to monitor the status of the PortfolioShare creation process. - OrganizationNode *types.OrganizationNode + // The portfolio identifier. + // + // This member is required. + PortfolioId *string // The language code. // @@ -83,10 +79,14 @@ type CreatePortfolioShareInput struct { // - Chinese AcceptLanguage *string - // The portfolio identifier. - // - // This member is required. - PortfolioId *string + // The AWS account ID. For example, 123456789012. + AccountId *string + + // The organization node to whom you are going to share. If OrganizationNode is + // passed in, PortfolioShare will be created for the node and its children (when + // applies), and a PortfolioShareToken will be returned in the output in order for + // the administrator to monitor the status of the PortfolioShare creation process. + OrganizationNode *types.OrganizationNode } type CreatePortfolioShareOutput struct { diff --git a/service/servicecatalog/api_op_CreateProduct.go b/service/servicecatalog/api_op_CreateProduct.go index 79d1ee6114e..4a6ddab55be 100644 --- a/service/servicecatalog/api_op_CreateProduct.go +++ b/service/servicecatalog/api_op_CreateProduct.go @@ -59,73 +59,73 @@ func (c *Client) CreateProduct(ctx context.Context, params *CreateProductInput, type CreateProductInput struct { - // The language code. - // - // * en - English (default) - // - // * jp - Japanese - // - // * zh - // - Chinese - AcceptLanguage *string - - // The contact URL for product support. - SupportUrl *string - - // The configuration of the provisioning artifact. + // A unique identifier that you provide to ensure idempotency. If multiple requests + // differ only by the idempotency token, the same response is returned for each + // repeated request. // // This member is required. - ProvisioningArtifactParameters *types.ProvisioningArtifactProperties + IdempotencyToken *string // The name of the product. // // This member is required. Name *string - // The contact email for product support. - SupportEmail *string + // The owner of the product. + // + // This member is required. + Owner *string // The type of product. // // This member is required. ProductType types.ProductType + // The configuration of the provisioning artifact. + // + // This member is required. + ProvisioningArtifactParameters *types.ProvisioningArtifactProperties + + // The language code. + // + // * en - English (default) + // + // * jp - Japanese + // + // * zh + // - Chinese + AcceptLanguage *string + + // The description of the product. + Description *string + // The distributor of the product. Distributor *string // The support information about the product. SupportDescription *string - // The description of the product. - Description *string + // The contact email for product support. + SupportEmail *string - // A unique identifier that you provide to ensure idempotency. If multiple requests - // differ only by the idempotency token, the same response is returned for each - // repeated request. - // - // This member is required. - IdempotencyToken *string + // The contact URL for product support. + SupportUrl *string // One or more tags. Tags []*types.Tag - - // The owner of the product. - // - // This member is required. - Owner *string } type CreateProductOutput struct { - // Information about the tags associated with the product. - Tags []*types.Tag - // Information about the product view. ProductViewDetail *types.ProductViewDetail // Information about the provisioning artifact. ProvisioningArtifactDetail *types.ProvisioningArtifactDetail + // Information about the tags associated with the product. + Tags []*types.Tag + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/servicecatalog/api_op_CreateProvisionedProductPlan.go b/service/servicecatalog/api_op_CreateProvisionedProductPlan.go index 11472a94f62..c4a31861548 100644 --- a/service/servicecatalog/api_op_CreateProvisionedProductPlan.go +++ b/service/servicecatalog/api_op_CreateProvisionedProductPlan.go @@ -72,40 +72,31 @@ type CreateProvisionedProductPlanInput struct { // This member is required. IdempotencyToken *string - // A user-friendly name for the provisioned product. This value must be unique for - // the AWS account and cannot be updated after the product is provisioned. + // The name of the plan. // // This member is required. - ProvisionedProductName *string - - // One or more tags. If the plan is for an existing provisioned product, the - // product must have a RESOURCE_UPDATE constraint with - // TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates. - Tags []*types.Tag - - // The path identifier of the product. This value is optional if the product has a - // default path, and required if the product has more than one path. To list the - // paths for a product, use ListLaunchPaths (). - PathId *string + PlanName *string - // Parameters specified by the administrator that are required for provisioning the - // product. - ProvisioningParameters []*types.UpdateProvisioningParameter + // The plan type. + // + // This member is required. + PlanType types.ProvisionedProductPlanType // The product identifier. // // This member is required. ProductId *string - // The name of the plan. + // A user-friendly name for the provisioned product. This value must be unique for + // the AWS account and cannot be updated after the product is provisioned. // // This member is required. - PlanName *string + ProvisionedProductName *string - // The plan type. + // The identifier of the provisioning artifact. // // This member is required. - PlanType types.ProvisionedProductPlanType + ProvisioningArtifactId *string // The language code. // @@ -117,33 +108,42 @@ type CreateProvisionedProductPlanInput struct { // - Chinese AcceptLanguage *string - // The identifier of the provisioning artifact. - // - // This member is required. - ProvisioningArtifactId *string - // Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related // events. NotificationArns []*string + + // The path identifier of the product. This value is optional if the product has a + // default path, and required if the product has more than one path. To list the + // paths for a product, use ListLaunchPaths (). + PathId *string + + // Parameters specified by the administrator that are required for provisioning the + // product. + ProvisioningParameters []*types.UpdateProvisioningParameter + + // One or more tags. If the plan is for an existing provisioned product, the + // product must have a RESOURCE_UPDATE constraint with + // TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates. + Tags []*types.Tag } type CreateProvisionedProductPlanOutput struct { + // The plan identifier. + PlanId *string + // The name of the plan. PlanName *string + // The product identifier. + ProvisionProductId *string + // The user-friendly name of the provisioned product. ProvisionedProductName *string // The identifier of the provisioning artifact. ProvisioningArtifactId *string - // The plan identifier. - PlanId *string - - // The product identifier. - ProvisionProductId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/servicecatalog/api_op_CreateProvisioningArtifact.go b/service/servicecatalog/api_op_CreateProvisioningArtifact.go index 8cd8a3e7b02..6648d0d88e3 100644 --- a/service/servicecatalog/api_op_CreateProvisioningArtifact.go +++ b/service/servicecatalog/api_op_CreateProvisioningArtifact.go @@ -73,6 +73,11 @@ type CreateProvisioningArtifactInput struct { // This member is required. Parameters *types.ProvisioningArtifactProperties + // The product identifier. + // + // This member is required. + ProductId *string + // The language code. // // * en - English (default) @@ -82,11 +87,6 @@ type CreateProvisioningArtifactInput struct { // * zh // - Chinese AcceptLanguage *string - - // The product identifier. - // - // This member is required. - ProductId *string } type CreateProvisioningArtifactOutput struct { diff --git a/service/servicecatalog/api_op_CreateServiceAction.go b/service/servicecatalog/api_op_CreateServiceAction.go index c6107f53d32..66d8e964a04 100644 --- a/service/servicecatalog/api_op_CreateServiceAction.go +++ b/service/servicecatalog/api_op_CreateServiceAction.go @@ -59,21 +59,6 @@ func (c *Client) CreateServiceAction(ctx context.Context, params *CreateServiceA type CreateServiceActionInput struct { - // The self-service action description. - Description *string - - // The self-service action name. - // - // This member is required. - Name *string - - // A unique identifier that you provide to ensure idempotency. If multiple requests - // differ only by the idempotency token, the same response is returned for each - // repeated request. - // - // This member is required. - IdempotencyToken *string - // The self-service action definition. Can be one of the following: Name The name // of the AWS Systems Manager document (SSM document). For example, // AWS-RestartEC2Instance. If you are using a shared SSM document, you must provide @@ -89,6 +74,23 @@ type CreateServiceActionInput struct { // This member is required. Definition map[string]*string + // The service action definition type. For example, SSM_AUTOMATION. + // + // This member is required. + DefinitionType types.ServiceActionDefinitionType + + // A unique identifier that you provide to ensure idempotency. If multiple requests + // differ only by the idempotency token, the same response is returned for each + // repeated request. + // + // This member is required. + IdempotencyToken *string + + // The self-service action name. + // + // This member is required. + Name *string + // The language code. // // * en - English (default) @@ -99,10 +101,8 @@ type CreateServiceActionInput struct { // - Chinese AcceptLanguage *string - // The service action definition type. For example, SSM_AUTOMATION. - // - // This member is required. - DefinitionType types.ServiceActionDefinitionType + // The self-service action description. + Description *string } type CreateServiceActionOutput struct { diff --git a/service/servicecatalog/api_op_CreateTagOption.go b/service/servicecatalog/api_op_CreateTagOption.go index 045e9c2e5d6..3c1fa1dadcb 100644 --- a/service/servicecatalog/api_op_CreateTagOption.go +++ b/service/servicecatalog/api_op_CreateTagOption.go @@ -57,15 +57,15 @@ func (c *Client) CreateTagOption(ctx context.Context, params *CreateTagOptionInp type CreateTagOptionInput struct { - // The TagOption value. + // The TagOption key. // // This member is required. - Value *string + Key *string - // The TagOption key. + // The TagOption value. // // This member is required. - Key *string + Value *string } type CreateTagOptionOutput struct { diff --git a/service/servicecatalog/api_op_DeleteConstraint.go b/service/servicecatalog/api_op_DeleteConstraint.go index c3ccc18e296..c37b255d004 100644 --- a/service/servicecatalog/api_op_DeleteConstraint.go +++ b/service/servicecatalog/api_op_DeleteConstraint.go @@ -57,6 +57,11 @@ func (c *Client) DeleteConstraint(ctx context.Context, params *DeleteConstraintI type DeleteConstraintInput struct { + // The identifier of the constraint. + // + // This member is required. + Id *string + // The language code. // // * en - English (default) @@ -66,11 +71,6 @@ type DeleteConstraintInput struct { // * zh // - Chinese AcceptLanguage *string - - // The identifier of the constraint. - // - // This member is required. - Id *string } type DeleteConstraintOutput struct { diff --git a/service/servicecatalog/api_op_DeletePortfolio.go b/service/servicecatalog/api_op_DeletePortfolio.go index e0b07b60ef6..ba18b9299d8 100644 --- a/service/servicecatalog/api_op_DeletePortfolio.go +++ b/service/servicecatalog/api_op_DeletePortfolio.go @@ -58,6 +58,11 @@ func (c *Client) DeletePortfolio(ctx context.Context, params *DeletePortfolioInp type DeletePortfolioInput struct { + // The portfolio identifier. + // + // This member is required. + Id *string + // The language code. // // * en - English (default) @@ -67,11 +72,6 @@ type DeletePortfolioInput struct { // * zh // - Chinese AcceptLanguage *string - - // The portfolio identifier. - // - // This member is required. - Id *string } type DeletePortfolioOutput struct { diff --git a/service/servicecatalog/api_op_DeletePortfolioShare.go b/service/servicecatalog/api_op_DeletePortfolioShare.go index 3cbe1b795f3..c57068a2ee8 100644 --- a/service/servicecatalog/api_op_DeletePortfolioShare.go +++ b/service/servicecatalog/api_op_DeletePortfolioShare.go @@ -60,12 +60,6 @@ func (c *Client) DeletePortfolioShare(ctx context.Context, params *DeletePortfol type DeletePortfolioShareInput struct { - // The AWS account ID. - AccountId *string - - // The organization node to whom you are going to stop sharing. - OrganizationNode *types.OrganizationNode - // The portfolio identifier. // // This member is required. @@ -80,6 +74,12 @@ type DeletePortfolioShareInput struct { // * zh // - Chinese AcceptLanguage *string + + // The AWS account ID. + AccountId *string + + // The organization node to whom you are going to stop sharing. + OrganizationNode *types.OrganizationNode } type DeletePortfolioShareOutput struct { diff --git a/service/servicecatalog/api_op_DeleteProduct.go b/service/servicecatalog/api_op_DeleteProduct.go index 5cfa2b783ec..8831cf4bfcc 100644 --- a/service/servicecatalog/api_op_DeleteProduct.go +++ b/service/servicecatalog/api_op_DeleteProduct.go @@ -58,6 +58,11 @@ func (c *Client) DeleteProduct(ctx context.Context, params *DeleteProductInput, type DeleteProductInput struct { + // The product identifier. + // + // This member is required. + Id *string + // The language code. // // * en - English (default) @@ -67,11 +72,6 @@ type DeleteProductInput struct { // * zh // - Chinese AcceptLanguage *string - - // The product identifier. - // - // This member is required. - Id *string } type DeleteProductOutput struct { diff --git a/service/servicecatalog/api_op_DeleteProvisionedProductPlan.go b/service/servicecatalog/api_op_DeleteProvisionedProductPlan.go index 4f1d8011721..5e03069f1c3 100644 --- a/service/servicecatalog/api_op_DeleteProvisionedProductPlan.go +++ b/service/servicecatalog/api_op_DeleteProvisionedProductPlan.go @@ -56,9 +56,10 @@ func (c *Client) DeleteProvisionedProductPlan(ctx context.Context, params *Delet type DeleteProvisionedProductPlanInput struct { - // If set to true, AWS Service Catalog stops managing the specified provisioned - // product even if it cannot delete the underlying resources. - IgnoreErrors *bool + // The plan identifier. + // + // This member is required. + PlanId *string // The language code. // @@ -70,10 +71,9 @@ type DeleteProvisionedProductPlanInput struct { // - Chinese AcceptLanguage *string - // The plan identifier. - // - // This member is required. - PlanId *string + // If set to true, AWS Service Catalog stops managing the specified provisioned + // product even if it cannot delete the underlying resources. + IgnoreErrors *bool } type DeleteProvisionedProductPlanOutput struct { diff --git a/service/servicecatalog/api_op_DeleteProvisioningArtifact.go b/service/servicecatalog/api_op_DeleteProvisioningArtifact.go index 9541accb43f..776e8e02d94 100644 --- a/service/servicecatalog/api_op_DeleteProvisioningArtifact.go +++ b/service/servicecatalog/api_op_DeleteProvisioningArtifact.go @@ -65,6 +65,11 @@ type DeleteProvisioningArtifactInput struct { // This member is required. ProductId *string + // The identifier of the provisioning artifact. + // + // This member is required. + ProvisioningArtifactId *string + // The language code. // // * en - English (default) @@ -74,11 +79,6 @@ type DeleteProvisioningArtifactInput struct { // * zh // - Chinese AcceptLanguage *string - - // The identifier of the provisioning artifact. - // - // This member is required. - ProvisioningArtifactId *string } type DeleteProvisioningArtifactOutput struct { diff --git a/service/servicecatalog/api_op_DescribeConstraint.go b/service/servicecatalog/api_op_DescribeConstraint.go index e371ab4d137..916940ce0a7 100644 --- a/service/servicecatalog/api_op_DescribeConstraint.go +++ b/service/servicecatalog/api_op_DescribeConstraint.go @@ -57,6 +57,11 @@ func (c *Client) DescribeConstraint(ctx context.Context, params *DescribeConstra type DescribeConstraintInput struct { + // The identifier of the constraint. + // + // This member is required. + Id *string + // The language code. // // * en - English (default) @@ -66,24 +71,19 @@ type DescribeConstraintInput struct { // * zh // - Chinese AcceptLanguage *string - - // The identifier of the constraint. - // - // This member is required. - Id *string } type DescribeConstraintOutput struct { + // Information about the constraint. + ConstraintDetail *types.ConstraintDetail + // The constraint parameters. ConstraintParameters *string // The status of the current request. Status types.Status - // Information about the constraint. - ConstraintDetail *types.ConstraintDetail - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/servicecatalog/api_op_DescribeCopyProductStatus.go b/service/servicecatalog/api_op_DescribeCopyProductStatus.go index 536495ffcd3..8c2361580fa 100644 --- a/service/servicecatalog/api_op_DescribeCopyProductStatus.go +++ b/service/servicecatalog/api_op_DescribeCopyProductStatus.go @@ -76,15 +76,15 @@ type DescribeCopyProductStatusInput struct { type DescribeCopyProductStatusOutput struct { - // The identifier of the copied product. - TargetProductId *string - // The status of the copy product operation. CopyProductStatus types.CopyProductStatus // The status message. StatusDetail *string + // The identifier of the copied product. + TargetProductId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/servicecatalog/api_op_DescribePortfolio.go b/service/servicecatalog/api_op_DescribePortfolio.go index 951cb8604f0..2334d0a5d79 100644 --- a/service/servicecatalog/api_op_DescribePortfolio.go +++ b/service/servicecatalog/api_op_DescribePortfolio.go @@ -58,6 +58,11 @@ func (c *Client) DescribePortfolio(ctx context.Context, params *DescribePortfoli type DescribePortfolioInput struct { + // The portfolio identifier. + // + // This member is required. + Id *string + // The language code. // // * en - English (default) @@ -67,11 +72,6 @@ type DescribePortfolioInput struct { // * zh // - Chinese AcceptLanguage *string - - // The portfolio identifier. - // - // This member is required. - Id *string } type DescribePortfolioOutput struct { @@ -79,15 +79,15 @@ type DescribePortfolioOutput struct { // Information about the associated budgets. Budgets []*types.BudgetDetail + // Information about the portfolio. + PortfolioDetail *types.PortfolioDetail + // Information about the TagOptions associated with the portfolio. TagOptions []*types.TagOptionDetail // Information about the tags associated with the portfolio. Tags []*types.Tag - // Information about the portfolio. - PortfolioDetail *types.PortfolioDetail - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/servicecatalog/api_op_DescribePortfolioShareStatus.go b/service/servicecatalog/api_op_DescribePortfolioShareStatus.go index f2861e555b4..f535b0a8ef0 100644 --- a/service/servicecatalog/api_op_DescribePortfolioShareStatus.go +++ b/service/servicecatalog/api_op_DescribePortfolioShareStatus.go @@ -74,12 +74,12 @@ type DescribePortfolioShareStatusOutput struct { // The portfolio identifier. PortfolioId *string - // Information about the portfolio share operation. - ShareDetails *types.ShareDetails - // The token for the portfolio share operation. For example, share-6v24abcdefghi. PortfolioShareToken *string + // Information about the portfolio share operation. + ShareDetails *types.ShareDetails + // Status of the portfolio share operation. Status types.ShareStatus diff --git a/service/servicecatalog/api_op_DescribeProduct.go b/service/servicecatalog/api_op_DescribeProduct.go index 3ae02f4655e..43074d15711 100644 --- a/service/servicecatalog/api_op_DescribeProduct.go +++ b/service/servicecatalog/api_op_DescribeProduct.go @@ -56,12 +56,6 @@ func (c *Client) DescribeProduct(ctx context.Context, params *DescribeProductInp type DescribeProductInput struct { - // The product name. - Name *string - - // The product identifier. - Id *string - // The language code. // // * en - English (default) @@ -71,22 +65,28 @@ type DescribeProductInput struct { // * zh // - Chinese AcceptLanguage *string + + // The product identifier. + Id *string + + // The product name. + Name *string } type DescribeProductOutput struct { + // Information about the associated budgets. + Budgets []*types.BudgetDetail + + // Information about the associated launch paths. + LaunchPaths []*types.LaunchPath + // Summary information about the product view. ProductViewSummary *types.ProductViewSummary // Information about the provisioning artifacts for the specified product. ProvisioningArtifacts []*types.ProvisioningArtifact - // Information about the associated launch paths. - LaunchPaths []*types.LaunchPath - - // Information about the associated budgets. - Budgets []*types.BudgetDetail - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/servicecatalog/api_op_DescribeProductAsAdmin.go b/service/servicecatalog/api_op_DescribeProductAsAdmin.go index c246ea6ddf2..48ed528bfe5 100644 --- a/service/servicecatalog/api_op_DescribeProductAsAdmin.go +++ b/service/servicecatalog/api_op_DescribeProductAsAdmin.go @@ -57,12 +57,6 @@ func (c *Client) DescribeProductAsAdmin(ctx context.Context, params *DescribePro type DescribeProductAsAdminInput struct { - // The product identifier. - Id *string - - // The product name. - Name *string - // The language code. // // * en - English (default) @@ -72,6 +66,12 @@ type DescribeProductAsAdminInput struct { // * zh // - Chinese AcceptLanguage *string + + // The product identifier. + Id *string + + // The product name. + Name *string } type DescribeProductAsAdminOutput struct { @@ -79,18 +79,18 @@ type DescribeProductAsAdminOutput struct { // Information about the associated budgets. Budgets []*types.BudgetDetail + // Information about the product view. + ProductViewDetail *types.ProductViewDetail + // Information about the provisioning artifacts (also known as versions) for the // specified product. ProvisioningArtifactSummaries []*types.ProvisioningArtifactSummary - // Information about the tags associated with the product. - Tags []*types.Tag - // Information about the TagOptions associated with the product. TagOptions []*types.TagOptionDetail - // Information about the product view. - ProductViewDetail *types.ProductViewDetail + // Information about the tags associated with the product. + Tags []*types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/servicecatalog/api_op_DescribeProductView.go b/service/servicecatalog/api_op_DescribeProductView.go index 7dc0352db14..8ecbe24e0d0 100644 --- a/service/servicecatalog/api_op_DescribeProductView.go +++ b/service/servicecatalog/api_op_DescribeProductView.go @@ -57,6 +57,11 @@ func (c *Client) DescribeProductView(ctx context.Context, params *DescribeProduc type DescribeProductViewInput struct { + // The product view identifier. + // + // This member is required. + Id *string + // The language code. // // * en - English (default) @@ -66,21 +71,16 @@ type DescribeProductViewInput struct { // * zh // - Chinese AcceptLanguage *string - - // The product view identifier. - // - // This member is required. - Id *string } type DescribeProductViewOutput struct { - // Information about the provisioning artifacts for the product. - ProvisioningArtifacts []*types.ProvisioningArtifact - // Summary information about the product. ProductViewSummary *types.ProductViewSummary + // Information about the provisioning artifacts for the product. + ProvisioningArtifacts []*types.ProvisioningArtifact + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/servicecatalog/api_op_DescribeProvisionedProductPlan.go b/service/servicecatalog/api_op_DescribeProvisionedProductPlan.go index 55907d653ae..45b656103a3 100644 --- a/service/servicecatalog/api_op_DescribeProvisionedProductPlan.go +++ b/service/servicecatalog/api_op_DescribeProvisionedProductPlan.go @@ -57,9 +57,10 @@ func (c *Client) DescribeProvisionedProductPlan(ctx context.Context, params *Des type DescribeProvisionedProductPlanInput struct { - // The page token for the next set of results. To retrieve the first set of - // results, use null. - PageToken *string + // The plan identifier. + // + // This member is required. + PlanId *string // The language code. // @@ -74,24 +75,23 @@ type DescribeProvisionedProductPlanInput struct { // The maximum number of items to return with this call. PageSize *int32 - // The plan identifier. - // - // This member is required. - PlanId *string + // The page token for the next set of results. To retrieve the first set of + // results, use null. + PageToken *string } type DescribeProvisionedProductPlanOutput struct { - // Information about the resource changes that will occur when the plan is - // executed. - ResourceChanges []*types.ResourceChange + // The page token to use to retrieve the next set of results. If there are no + // additional results, this value is null. + NextPageToken *string // Information about the plan. ProvisionedProductPlanDetails *types.ProvisionedProductPlanDetails - // The page token to use to retrieve the next set of results. If there are no - // additional results, this value is null. - NextPageToken *string + // Information about the resource changes that will occur when the plan is + // executed. + ResourceChanges []*types.ResourceChange // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/servicecatalog/api_op_DescribeProvisioningArtifact.go b/service/servicecatalog/api_op_DescribeProvisioningArtifact.go index 27a2009d5a3..023ff01ef14 100644 --- a/service/servicecatalog/api_op_DescribeProvisioningArtifact.go +++ b/service/servicecatalog/api_op_DescribeProvisioningArtifact.go @@ -67,33 +67,33 @@ type DescribeProvisioningArtifactInput struct { // - Chinese AcceptLanguage *string - // The identifier of the provisioning artifact. - ProvisioningArtifactId *string - // The product identifier. ProductId *string // The product name. ProductName *string - // Indicates whether a verbose level of detail is enabled. - Verbose *bool + // The identifier of the provisioning artifact. + ProvisioningArtifactId *string // The provisioning artifact name. ProvisioningArtifactName *string + + // Indicates whether a verbose level of detail is enabled. + Verbose *bool } type DescribeProvisioningArtifactOutput struct { - // The status of the current request. - Status types.Status - // The URL of the CloudFormation template in Amazon S3. Info map[string]*string // Information about the provisioning artifact. ProvisioningArtifactDetail *types.ProvisioningArtifactDetail + // The status of the current request. + Status types.Status + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/servicecatalog/api_op_DescribeProvisioningParameters.go b/service/servicecatalog/api_op_DescribeProvisioningParameters.go index 60461ae5d43..9d249deb58e 100644 --- a/service/servicecatalog/api_op_DescribeProvisioningParameters.go +++ b/service/servicecatalog/api_op_DescribeProvisioningParameters.go @@ -63,10 +63,6 @@ func (c *Client) DescribeProvisioningParameters(ctx context.Context, params *Des type DescribeProvisioningParametersInput struct { - // The identifier of the provisioning artifact. You must provide the name or ID, - // but not both. - ProvisioningArtifactId *string - // The language code. // // * en - English (default) @@ -77,24 +73,28 @@ type DescribeProvisioningParametersInput struct { // - Chinese AcceptLanguage *string + // The path identifier of the product. This value is optional if the product has a + // default path, and required if the product has more than one path. To list the + // paths for a product, use ListLaunchPaths (). You must provide the name or ID, + // but not both. + PathId *string + // The name of the path. You must provide the name or ID, but not both. PathName *string - // The name of the provisioning artifact. You must provide the name or ID, but not - // both. - ProvisioningArtifactName *string - // The product identifier. You must provide the product name or ID, but not both. ProductId *string // The name of the product. You must provide the name or ID, but not both. ProductName *string - // The path identifier of the product. This value is optional if the product has a - // default path, and required if the product has more than one path. To list the - // paths for a product, use ListLaunchPaths (). You must provide the name or ID, + // The identifier of the provisioning artifact. You must provide the name or ID, // but not both. - PathId *string + ProvisioningArtifactId *string + + // The name of the provisioning artifact. You must provide the name or ID, but not + // both. + ProvisioningArtifactName *string } type DescribeProvisioningParametersOutput struct { @@ -102,6 +102,9 @@ type DescribeProvisioningParametersOutput struct { // Information about the constraints used to provision the product. ConstraintSummaries []*types.ConstraintSummary + // The output of the provisioning artifact. + ProvisioningArtifactOutputs []*types.ProvisioningArtifactOutput + // Information about the parameters used to provision the product. ProvisioningArtifactParameters []*types.ProvisioningArtifactParameter @@ -112,9 +115,6 @@ type DescribeProvisioningParametersOutput struct { // Information about the TagOptions associated with the resource. TagOptions []*types.TagOptionSummary - // The output of the provisioning artifact. - ProvisioningArtifactOutputs []*types.ProvisioningArtifactOutput - // Any additional metadata specifically related to the provisioning of the product. // For example, see the Version field of the CloudFormation template. UsageInstructions []*types.UsageInstruction diff --git a/service/servicecatalog/api_op_DescribeRecord.go b/service/servicecatalog/api_op_DescribeRecord.go index 3a9932cb0e1..de38f1f43d1 100644 --- a/service/servicecatalog/api_op_DescribeRecord.go +++ b/service/servicecatalog/api_op_DescribeRecord.go @@ -64,6 +64,12 @@ func (c *Client) DescribeRecord(ctx context.Context, params *DescribeRecordInput type DescribeRecordInput struct { + // The record identifier of the provisioned product. This identifier is returned by + // the request operation. + // + // This member is required. + Id *string + // The language code. // // * en - English (default) @@ -74,29 +80,23 @@ type DescribeRecordInput struct { // - Chinese AcceptLanguage *string - // The page token for the next set of results. To retrieve the first set of - // results, use null. - PageToken *string - // The maximum number of items to return with this call. PageSize *int32 - // The record identifier of the provisioned product. This identifier is returned by - // the request operation. - // - // This member is required. - Id *string + // The page token for the next set of results. To retrieve the first set of + // results, use null. + PageToken *string } type DescribeRecordOutput struct { - // Information about the product. - RecordDetail *types.RecordDetail - // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string + // Information about the product. + RecordDetail *types.RecordDetail + // Information about the product created as the result of a request. For example, // the output for a CloudFormation-backed product that creates an S3 bucket would // include the S3 bucket URL. diff --git a/service/servicecatalog/api_op_DescribeServiceActionExecutionParameters.go b/service/servicecatalog/api_op_DescribeServiceActionExecutionParameters.go index f1905fbb69a..9a1c4a06772 100644 --- a/service/servicecatalog/api_op_DescribeServiceActionExecutionParameters.go +++ b/service/servicecatalog/api_op_DescribeServiceActionExecutionParameters.go @@ -58,6 +58,11 @@ func (c *Client) DescribeServiceActionExecutionParameters(ctx context.Context, p type DescribeServiceActionExecutionParametersInput struct { + // The identifier of the provisioned product. + // + // This member is required. + ProvisionedProductId *string + // The self-service action identifier. // // This member is required. @@ -72,11 +77,6 @@ type DescribeServiceActionExecutionParametersInput struct { // * zh // - Chinese AcceptLanguage *string - - // The identifier of the provisioned product. - // - // This member is required. - ProvisionedProductId *string } type DescribeServiceActionExecutionParametersOutput struct { diff --git a/service/servicecatalog/api_op_DisassociatePrincipalFromPortfolio.go b/service/servicecatalog/api_op_DisassociatePrincipalFromPortfolio.go index 4862a7dfe60..ae8e77f9259 100644 --- a/service/servicecatalog/api_op_DisassociatePrincipalFromPortfolio.go +++ b/service/servicecatalog/api_op_DisassociatePrincipalFromPortfolio.go @@ -56,16 +56,6 @@ func (c *Client) DisassociatePrincipalFromPortfolio(ctx context.Context, params type DisassociatePrincipalFromPortfolioInput struct { - // The language code. - // - // * en - English (default) - // - // * jp - Japanese - // - // * zh - // - Chinese - AcceptLanguage *string - // The portfolio identifier. // // This member is required. @@ -75,6 +65,16 @@ type DisassociatePrincipalFromPortfolioInput struct { // // This member is required. PrincipalARN *string + + // The language code. + // + // * en - English (default) + // + // * jp - Japanese + // + // * zh + // - Chinese + AcceptLanguage *string } type DisassociatePrincipalFromPortfolioOutput struct { diff --git a/service/servicecatalog/api_op_DisassociateServiceActionFromProvisioningArtifact.go b/service/servicecatalog/api_op_DisassociateServiceActionFromProvisioningArtifact.go index 2d20660c594..564f3360def 100644 --- a/service/servicecatalog/api_op_DisassociateServiceActionFromProvisioningArtifact.go +++ b/service/servicecatalog/api_op_DisassociateServiceActionFromProvisioningArtifact.go @@ -67,6 +67,11 @@ type DisassociateServiceActionFromProvisioningArtifactInput struct { // This member is required. ProvisioningArtifactId *string + // The self-service action identifier. For example, act-fs7abcd89wxyz. + // + // This member is required. + ServiceActionId *string + // The language code. // // * en - English (default) @@ -76,11 +81,6 @@ type DisassociateServiceActionFromProvisioningArtifactInput struct { // * zh // - Chinese AcceptLanguage *string - - // The self-service action identifier. For example, act-fs7abcd89wxyz. - // - // This member is required. - ServiceActionId *string } type DisassociateServiceActionFromProvisioningArtifactOutput struct { diff --git a/service/servicecatalog/api_op_DisassociateTagOptionFromResource.go b/service/servicecatalog/api_op_DisassociateTagOptionFromResource.go index 24ce280f307..60a9c760c18 100644 --- a/service/servicecatalog/api_op_DisassociateTagOptionFromResource.go +++ b/service/servicecatalog/api_op_DisassociateTagOptionFromResource.go @@ -56,15 +56,15 @@ func (c *Client) DisassociateTagOptionFromResource(ctx context.Context, params * type DisassociateTagOptionFromResourceInput struct { - // The TagOption identifier. + // The resource identifier. // // This member is required. - TagOptionId *string + ResourceId *string - // The resource identifier. + // The TagOption identifier. // // This member is required. - ResourceId *string + TagOptionId *string } type DisassociateTagOptionFromResourceOutput struct { diff --git a/service/servicecatalog/api_op_ExecuteProvisionedProductPlan.go b/service/servicecatalog/api_op_ExecuteProvisionedProductPlan.go index 37e56889f76..e2ca7a30742 100644 --- a/service/servicecatalog/api_op_ExecuteProvisionedProductPlan.go +++ b/service/servicecatalog/api_op_ExecuteProvisionedProductPlan.go @@ -60,11 +60,6 @@ func (c *Client) ExecuteProvisionedProductPlan(ctx context.Context, params *Exec type ExecuteProvisionedProductPlanInput struct { - // The plan identifier. - // - // This member is required. - PlanId *string - // A unique identifier that you provide to ensure idempotency. If multiple requests // differ only by the idempotency token, the same response is returned for each // repeated request. @@ -72,6 +67,11 @@ type ExecuteProvisionedProductPlanInput struct { // This member is required. IdempotencyToken *string + // The plan identifier. + // + // This member is required. + PlanId *string + // The language code. // // * en - English (default) diff --git a/service/servicecatalog/api_op_ExecuteProvisionedProductServiceAction.go b/service/servicecatalog/api_op_ExecuteProvisionedProductServiceAction.go index a9cc022aa85..c5ecdc3d00a 100644 --- a/service/servicecatalog/api_op_ExecuteProvisionedProductServiceAction.go +++ b/service/servicecatalog/api_op_ExecuteProvisionedProductServiceAction.go @@ -59,18 +59,6 @@ func (c *Client) ExecuteProvisionedProductServiceAction(ctx context.Context, par type ExecuteProvisionedProductServiceActionInput struct { - // A map of all self-service action parameters and their values. If a provided - // parameter is of a special type, such as TARGET, the provided value will override - // the default value generated by AWS Service Catalog. If the parameters field is - // not provided, no additional parameters are passed and default values will be - // used for any special parameters such as TARGET. - Parameters map[string][]*string - - // The self-service action identifier. For example, act-fs7abcd89wxyz. - // - // This member is required. - ServiceActionId *string - // An idempotency token that uniquely identifies the execute request. // // This member is required. @@ -81,6 +69,11 @@ type ExecuteProvisionedProductServiceActionInput struct { // This member is required. ProvisionedProductId *string + // The self-service action identifier. For example, act-fs7abcd89wxyz. + // + // This member is required. + ServiceActionId *string + // The language code. // // * en - English (default) @@ -90,6 +83,13 @@ type ExecuteProvisionedProductServiceActionInput struct { // * zh // - Chinese AcceptLanguage *string + + // A map of all self-service action parameters and their values. If a provided + // parameter is of a special type, such as TARGET, the provided value will override + // the default value generated by AWS Service Catalog. If the parameters field is + // not provided, no additional parameters are passed and default values will be + // used for any special parameters such as TARGET. + Parameters map[string][]*string } type ExecuteProvisionedProductServiceActionOutput struct { diff --git a/service/servicecatalog/api_op_ListAcceptedPortfolioShares.go b/service/servicecatalog/api_op_ListAcceptedPortfolioShares.go index 0c32ad46bf6..5d306afd27f 100644 --- a/service/servicecatalog/api_op_ListAcceptedPortfolioShares.go +++ b/service/servicecatalog/api_op_ListAcceptedPortfolioShares.go @@ -69,6 +69,10 @@ type ListAcceptedPortfolioSharesInput struct { // The maximum number of items to return with this call. PageSize *int32 + // The page token for the next set of results. To retrieve the first set of + // results, use null. + PageToken *string + // The type of shared portfolios to list. The default is to list imported // portfolios. // @@ -80,21 +84,17 @@ type ListAcceptedPortfolioSharesInput struct { // // * IMPORTED - List imported portfolios PortfolioShareType types.PortfolioShareType - - // The page token for the next set of results. To retrieve the first set of - // results, use null. - PageToken *string } type ListAcceptedPortfolioSharesOutput struct { - // Information about the portfolios. - PortfolioDetails []*types.PortfolioDetail - // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string + // Information about the portfolios. + PortfolioDetails []*types.PortfolioDetail + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/servicecatalog/api_op_ListBudgetsForResource.go b/service/servicecatalog/api_op_ListBudgetsForResource.go index 4bed2ac7131..317e2fb72e7 100644 --- a/service/servicecatalog/api_op_ListBudgetsForResource.go +++ b/service/servicecatalog/api_op_ListBudgetsForResource.go @@ -57,6 +57,11 @@ func (c *Client) ListBudgetsForResource(ctx context.Context, params *ListBudgets type ListBudgetsForResourceInput struct { + // The resource identifier. + // + // This member is required. + ResourceId *string + // The language code. // // * en - English (default) @@ -67,17 +72,12 @@ type ListBudgetsForResourceInput struct { // - Chinese AcceptLanguage *string - // The page token for the next set of results. To retrieve the first set of - // results, use null. - PageToken *string - // The maximum number of items to return with this call. PageSize *int32 - // The resource identifier. - // - // This member is required. - ResourceId *string + // The page token for the next set of results. To retrieve the first set of + // results, use null. + PageToken *string } type ListBudgetsForResourceOutput struct { diff --git a/service/servicecatalog/api_op_ListConstraintsForPortfolio.go b/service/servicecatalog/api_op_ListConstraintsForPortfolio.go index 4219607dc09..578999a372d 100644 --- a/service/servicecatalog/api_op_ListConstraintsForPortfolio.go +++ b/service/servicecatalog/api_op_ListConstraintsForPortfolio.go @@ -57,6 +57,11 @@ func (c *Client) ListConstraintsForPortfolio(ctx context.Context, params *ListCo type ListConstraintsForPortfolioInput struct { + // The portfolio identifier. + // + // This member is required. + PortfolioId *string + // The language code. // // * en - English (default) @@ -67,20 +72,15 @@ type ListConstraintsForPortfolioInput struct { // - Chinese AcceptLanguage *string - // The portfolio identifier. - // - // This member is required. - PortfolioId *string - - // The product identifier. - ProductId *string - // The maximum number of items to return with this call. PageSize *int32 // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string + + // The product identifier. + ProductId *string } type ListConstraintsForPortfolioOutput struct { diff --git a/service/servicecatalog/api_op_ListLaunchPaths.go b/service/servicecatalog/api_op_ListLaunchPaths.go index f677ad4dc05..68ad07fc576 100644 --- a/service/servicecatalog/api_op_ListLaunchPaths.go +++ b/service/servicecatalog/api_op_ListLaunchPaths.go @@ -74,23 +74,23 @@ type ListLaunchPathsInput struct { // - Chinese AcceptLanguage *string + // The maximum number of items to return with this call. + PageSize *int32 + // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string - - // The maximum number of items to return with this call. - PageSize *int32 } type ListLaunchPathsOutput struct { + // Information about the launch path. + LaunchPathSummaries []*types.LaunchPathSummary + // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string - // Information about the launch path. - LaunchPathSummaries []*types.LaunchPathSummary - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/servicecatalog/api_op_ListOrganizationPortfolioAccess.go b/service/servicecatalog/api_op_ListOrganizationPortfolioAccess.go index 61252981ca4..bcfb563d822 100644 --- a/service/servicecatalog/api_op_ListOrganizationPortfolioAccess.go +++ b/service/servicecatalog/api_op_ListOrganizationPortfolioAccess.go @@ -75,18 +75,11 @@ type ListOrganizationPortfolioAccessInput struct { // This member is required. OrganizationNodeType types.OrganizationNodeType - // The page token for the next set of results. To retrieve the first set of - // results, use null. - PageToken *string - // The portfolio identifier. For example, port-2abcdext3y5fk. // // This member is required. PortfolioId *string - // The maximum number of items to return with this call. - PageSize *int32 - // The language code. // // * en - English (default) @@ -96,6 +89,13 @@ type ListOrganizationPortfolioAccessInput struct { // * zh // - Chinese AcceptLanguage *string + + // The maximum number of items to return with this call. + PageSize *int32 + + // The page token for the next set of results. To retrieve the first set of + // results, use null. + PageToken *string } type ListOrganizationPortfolioAccessOutput struct { diff --git a/service/servicecatalog/api_op_ListPortfolioAccess.go b/service/servicecatalog/api_op_ListPortfolioAccess.go index dba7033c63d..e4bebe5ed6c 100644 --- a/service/servicecatalog/api_op_ListPortfolioAccess.go +++ b/service/servicecatalog/api_op_ListPortfolioAccess.go @@ -59,9 +59,6 @@ func (c *Client) ListPortfolioAccess(ctx context.Context, params *ListPortfolioA type ListPortfolioAccessInput struct { - // The maximum number of items to return with this call. - PageSize *int32 - // The portfolio identifier. // // This member is required. @@ -81,6 +78,9 @@ type ListPortfolioAccessInput struct { // this node with an inherited portfolio share will be returned. OrganizationParentId *string + // The maximum number of items to return with this call. + PageSize *int32 + // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string @@ -88,13 +88,13 @@ type ListPortfolioAccessInput struct { type ListPortfolioAccessOutput struct { + // Information about the AWS accounts with access to the portfolio. + AccountIds []*string + // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string - // Information about the AWS accounts with access to the portfolio. - AccountIds []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/servicecatalog/api_op_ListPortfolios.go b/service/servicecatalog/api_op_ListPortfolios.go index 2244db951de..269aefa3d39 100644 --- a/service/servicecatalog/api_op_ListPortfolios.go +++ b/service/servicecatalog/api_op_ListPortfolios.go @@ -56,13 +56,6 @@ func (c *Client) ListPortfolios(ctx context.Context, params *ListPortfoliosInput type ListPortfoliosInput struct { - // The maximum number of items to return with this call. - PageSize *int32 - - // The page token for the next set of results. To retrieve the first set of - // results, use null. - PageToken *string - // The language code. // // * en - English (default) @@ -72,6 +65,13 @@ type ListPortfoliosInput struct { // * zh // - Chinese AcceptLanguage *string + + // The maximum number of items to return with this call. + PageSize *int32 + + // The page token for the next set of results. To retrieve the first set of + // results, use null. + PageToken *string } type ListPortfoliosOutput struct { diff --git a/service/servicecatalog/api_op_ListPortfoliosForProduct.go b/service/servicecatalog/api_op_ListPortfoliosForProduct.go index 9a4fe20d32c..089e040e127 100644 --- a/service/servicecatalog/api_op_ListPortfoliosForProduct.go +++ b/service/servicecatalog/api_op_ListPortfoliosForProduct.go @@ -57,6 +57,11 @@ func (c *Client) ListPortfoliosForProduct(ctx context.Context, params *ListPortf type ListPortfoliosForProductInput struct { + // The product identifier. + // + // This member is required. + ProductId *string + // The language code. // // * en - English (default) @@ -67,11 +72,6 @@ type ListPortfoliosForProductInput struct { // - Chinese AcceptLanguage *string - // The product identifier. - // - // This member is required. - ProductId *string - // The maximum number of items to return with this call. PageSize *int32 @@ -82,13 +82,13 @@ type ListPortfoliosForProductInput struct { type ListPortfoliosForProductOutput struct { - // Information about the portfolios. - PortfolioDetails []*types.PortfolioDetail - // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string + // Information about the portfolios. + PortfolioDetails []*types.PortfolioDetail + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/servicecatalog/api_op_ListPrincipalsForPortfolio.go b/service/servicecatalog/api_op_ListPrincipalsForPortfolio.go index 413d5c735ae..05c1d8e3862 100644 --- a/service/servicecatalog/api_op_ListPrincipalsForPortfolio.go +++ b/service/servicecatalog/api_op_ListPrincipalsForPortfolio.go @@ -57,8 +57,10 @@ func (c *Client) ListPrincipalsForPortfolio(ctx context.Context, params *ListPri type ListPrincipalsForPortfolioInput struct { - // The maximum number of items to return with this call. - PageSize *int32 + // The portfolio identifier. + // + // This member is required. + PortfolioId *string // The language code. // @@ -70,14 +72,12 @@ type ListPrincipalsForPortfolioInput struct { // - Chinese AcceptLanguage *string + // The maximum number of items to return with this call. + PageSize *int32 + // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string - - // The portfolio identifier. - // - // This member is required. - PortfolioId *string } type ListPrincipalsForPortfolioOutput struct { diff --git a/service/servicecatalog/api_op_ListProvisionedProductPlans.go b/service/servicecatalog/api_op_ListProvisionedProductPlans.go index c18fc98e1da..06923c03854 100644 --- a/service/servicecatalog/api_op_ListProvisionedProductPlans.go +++ b/service/servicecatalog/api_op_ListProvisionedProductPlans.go @@ -57,12 +57,6 @@ func (c *Client) ListProvisionedProductPlans(ctx context.Context, params *ListPr type ListProvisionedProductPlansInput struct { - // The access level to use to obtain results. The default is User. - AccessLevelFilter *types.AccessLevelFilter - - // The maximum number of items to return with this call. - PageSize *int32 - // The language code. // // * en - English (default) @@ -73,6 +67,12 @@ type ListProvisionedProductPlansInput struct { // - Chinese AcceptLanguage *string + // The access level to use to obtain results. The default is User. + AccessLevelFilter *types.AccessLevelFilter + + // The maximum number of items to return with this call. + PageSize *int32 + // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string diff --git a/service/servicecatalog/api_op_ListProvisioningArtifactsForServiceAction.go b/service/servicecatalog/api_op_ListProvisioningArtifactsForServiceAction.go index 699fa5e176c..15cf836421d 100644 --- a/service/servicecatalog/api_op_ListProvisioningArtifactsForServiceAction.go +++ b/service/servicecatalog/api_op_ListProvisioningArtifactsForServiceAction.go @@ -73,24 +73,24 @@ type ListProvisioningArtifactsForServiceActionInput struct { // - Chinese AcceptLanguage *string + // The maximum number of items to return with this call. + PageSize *int32 + // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string - - // The maximum number of items to return with this call. - PageSize *int32 } type ListProvisioningArtifactsForServiceActionOutput struct { - // An array of objects with information about product views and provisioning - // artifacts. - ProvisioningArtifactViews []*types.ProvisioningArtifactView - // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string + // An array of objects with information about product views and provisioning + // artifacts. + ProvisioningArtifactViews []*types.ProvisioningArtifactView + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/servicecatalog/api_op_ListRecordHistory.go b/service/servicecatalog/api_op_ListRecordHistory.go index 57ee24d9fd8..3c868ddfa30 100644 --- a/service/servicecatalog/api_op_ListRecordHistory.go +++ b/service/servicecatalog/api_op_ListRecordHistory.go @@ -56,15 +56,6 @@ func (c *Client) ListRecordHistory(ctx context.Context, params *ListRecordHistor type ListRecordHistoryInput struct { - // The access level to use to obtain results. The default is User. - AccessLevelFilter *types.AccessLevelFilter - - // The maximum number of items to return with this call. - PageSize *int32 - - // The search filter to scope the results. - SearchFilter *types.ListRecordHistorySearchFilter - // The language code. // // * en - English (default) @@ -75,20 +66,29 @@ type ListRecordHistoryInput struct { // - Chinese AcceptLanguage *string + // The access level to use to obtain results. The default is User. + AccessLevelFilter *types.AccessLevelFilter + + // The maximum number of items to return with this call. + PageSize *int32 + // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string + + // The search filter to scope the results. + SearchFilter *types.ListRecordHistorySearchFilter } type ListRecordHistoryOutput struct { - // The records, in reverse chronological order. - RecordDetails []*types.RecordDetail - // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string + // The records, in reverse chronological order. + RecordDetails []*types.RecordDetail + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/servicecatalog/api_op_ListServiceActions.go b/service/servicecatalog/api_op_ListServiceActions.go index 291a66ad01e..908adffab53 100644 --- a/service/servicecatalog/api_op_ListServiceActions.go +++ b/service/servicecatalog/api_op_ListServiceActions.go @@ -56,13 +56,6 @@ func (c *Client) ListServiceActions(ctx context.Context, params *ListServiceActi type ListServiceActionsInput struct { - // The maximum number of items to return with this call. - PageSize *int32 - - // The page token for the next set of results. To retrieve the first set of - // results, use null. - PageToken *string - // The language code. // // * en - English (default) @@ -72,18 +65,25 @@ type ListServiceActionsInput struct { // * zh // - Chinese AcceptLanguage *string + + // The maximum number of items to return with this call. + PageSize *int32 + + // The page token for the next set of results. To retrieve the first set of + // results, use null. + PageToken *string } type ListServiceActionsOutput struct { - // An object containing information about the service actions associated with the - // provisioning artifact. - ServiceActionSummaries []*types.ServiceActionSummary - // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string + // An object containing information about the service actions associated with the + // provisioning artifact. + ServiceActionSummaries []*types.ServiceActionSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/servicecatalog/api_op_ListServiceActionsForProvisioningArtifact.go b/service/servicecatalog/api_op_ListServiceActionsForProvisioningArtifact.go index c3388a7562d..91741c2d571 100644 --- a/service/servicecatalog/api_op_ListServiceActionsForProvisioningArtifact.go +++ b/service/servicecatalog/api_op_ListServiceActionsForProvisioningArtifact.go @@ -58,19 +58,15 @@ func (c *Client) ListServiceActionsForProvisioningArtifact(ctx context.Context, type ListServiceActionsForProvisioningArtifactInput struct { - // The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne. + // The product identifier. For example, prod-abcdzk7xy33qa. // // This member is required. - ProvisioningArtifactId *string - - // The page token for the next set of results. To retrieve the first set of - // results, use null. - PageToken *string + ProductId *string - // The product identifier. For example, prod-abcdzk7xy33qa. + // The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne. // // This member is required. - ProductId *string + ProvisioningArtifactId *string // The language code. // @@ -84,6 +80,10 @@ type ListServiceActionsForProvisioningArtifactInput struct { // The maximum number of items to return with this call. PageSize *int32 + + // The page token for the next set of results. To retrieve the first set of + // results, use null. + PageToken *string } type ListServiceActionsForProvisioningArtifactOutput struct { diff --git a/service/servicecatalog/api_op_ListStackInstancesForProvisionedProduct.go b/service/servicecatalog/api_op_ListStackInstancesForProvisionedProduct.go index f81ac53dd90..27fe17f2bc7 100644 --- a/service/servicecatalog/api_op_ListStackInstancesForProvisionedProduct.go +++ b/service/servicecatalog/api_op_ListStackInstancesForProvisionedProduct.go @@ -64,13 +64,6 @@ type ListStackInstancesForProvisionedProductInput struct { // This member is required. ProvisionedProductId *string - // The maximum number of items to return with this call. - PageSize *int32 - - // The page token for the next set of results. To retrieve the first set of - // results, use null. - PageToken *string - // The language code. // // * en - English (default) @@ -80,17 +73,24 @@ type ListStackInstancesForProvisionedProductInput struct { // * zh // - Chinese AcceptLanguage *string + + // The maximum number of items to return with this call. + PageSize *int32 + + // The page token for the next set of results. To retrieve the first set of + // results, use null. + PageToken *string } type ListStackInstancesForProvisionedProductOutput struct { - // List of stack instances. - StackInstances []*types.StackInstance - // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string + // List of stack instances. + StackInstances []*types.StackInstance + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/servicecatalog/api_op_ListTagOptions.go b/service/servicecatalog/api_op_ListTagOptions.go index 6576edb35a5..d0eddae68aa 100644 --- a/service/servicecatalog/api_op_ListTagOptions.go +++ b/service/servicecatalog/api_op_ListTagOptions.go @@ -70,13 +70,13 @@ type ListTagOptionsInput struct { type ListTagOptionsOutput struct { - // Information about the TagOptions. - TagOptionDetails []*types.TagOptionDetail - // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string + // Information about the TagOptions. + TagOptionDetails []*types.TagOptionDetail + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/servicecatalog/api_op_ProvisionProduct.go b/service/servicecatalog/api_op_ProvisionProduct.go index 30d1f09b763..ce2c52a7d7a 100644 --- a/service/servicecatalog/api_op_ProvisionProduct.go +++ b/service/servicecatalog/api_op_ProvisionProduct.go @@ -70,34 +70,12 @@ type ProvisionProductInput struct { // This member is required. ProvisionToken *string - // Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related - // events. - NotificationArns []*string - - // The name of the product. You must provide the name or ID, but not both. - ProductName *string - - // Parameters specified by the administrator that are required for provisioning the - // product. - ProvisioningParameters []*types.ProvisioningParameter - - // An object that contains information about the provisioning preferences for a - // stack set. - ProvisioningPreferences *types.ProvisioningPreferences - // A user-friendly name for the provisioned product. This value must be unique for // the AWS account and cannot be updated after the product is provisioned. // // This member is required. ProvisionedProductName *string - // The identifier of the provisioning artifact. You must provide the name or ID, - // but not both. - ProvisioningArtifactId *string - - // One or more tags. - Tags []*types.Tag - // The language code. // // * en - English (default) @@ -108,21 +86,43 @@ type ProvisionProductInput struct { // - Chinese AcceptLanguage *string + // Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related + // events. + NotificationArns []*string + + // The path identifier of the product. This value is optional if the product has a + // default path, and required if the product has more than one path. To list the + // paths for a product, use ListLaunchPaths (). You must provide the name or ID, + // but not both. + PathId *string + // The name of the path. You must provide the name or ID, but not both. PathName *string + // The product identifier. You must provide the name or ID, but not both. + ProductId *string + + // The name of the product. You must provide the name or ID, but not both. + ProductName *string + + // The identifier of the provisioning artifact. You must provide the name or ID, + // but not both. + ProvisioningArtifactId *string + // The name of the provisioning artifact. You must provide the name or ID, but not // both. ProvisioningArtifactName *string - // The product identifier. You must provide the name or ID, but not both. - ProductId *string + // Parameters specified by the administrator that are required for provisioning the + // product. + ProvisioningParameters []*types.ProvisioningParameter - // The path identifier of the product. This value is optional if the product has a - // default path, and required if the product has more than one path. To list the - // paths for a product, use ListLaunchPaths (). You must provide the name or ID, - // but not both. - PathId *string + // An object that contains information about the provisioning preferences for a + // stack set. + ProvisioningPreferences *types.ProvisioningPreferences + + // One or more tags. + Tags []*types.Tag } type ProvisionProductOutput struct { diff --git a/service/servicecatalog/api_op_RejectPortfolioShare.go b/service/servicecatalog/api_op_RejectPortfolioShare.go index 5b6d3128486..1f48784d1a3 100644 --- a/service/servicecatalog/api_op_RejectPortfolioShare.go +++ b/service/servicecatalog/api_op_RejectPortfolioShare.go @@ -62,6 +62,16 @@ type RejectPortfolioShareInput struct { // This member is required. PortfolioId *string + // The language code. + // + // * en - English (default) + // + // * jp - Japanese + // + // * zh + // - Chinese + AcceptLanguage *string + // The type of shared portfolios to reject. The default is to reject imported // portfolios. // @@ -77,16 +87,6 @@ type RejectPortfolioShareInput struct { // example, aws servicecatalog reject-portfolio-share --portfolio-id // "port-2qwzkwxt3y5fk" --portfolio-share-type AWS_ORGANIZATIONS PortfolioShareType types.PortfolioShareType - - // The language code. - // - // * en - English (default) - // - // * jp - Japanese - // - // * zh - // - Chinese - AcceptLanguage *string } type RejectPortfolioShareOutput struct { diff --git a/service/servicecatalog/api_op_ScanProvisionedProducts.go b/service/servicecatalog/api_op_ScanProvisionedProducts.go index 0bf3bcde821..a9379112563 100644 --- a/service/servicecatalog/api_op_ScanProvisionedProducts.go +++ b/service/servicecatalog/api_op_ScanProvisionedProducts.go @@ -57,13 +57,6 @@ func (c *Client) ScanProvisionedProducts(ctx context.Context, params *ScanProvis type ScanProvisionedProductsInput struct { - // The page token for the next set of results. To retrieve the first set of - // results, use null. - PageToken *string - - // The access level to use to obtain results. The default is User. - AccessLevelFilter *types.AccessLevelFilter - // The language code. // // * en - English (default) @@ -74,8 +67,15 @@ type ScanProvisionedProductsInput struct { // - Chinese AcceptLanguage *string + // The access level to use to obtain results. The default is User. + AccessLevelFilter *types.AccessLevelFilter + // The maximum number of items to return with this call. PageSize *int32 + + // The page token for the next set of results. To retrieve the first set of + // results, use null. + PageToken *string } type ScanProvisionedProductsOutput struct { diff --git a/service/servicecatalog/api_op_SearchProducts.go b/service/servicecatalog/api_op_SearchProducts.go index c1ec300a25d..96b722d74c0 100644 --- a/service/servicecatalog/api_op_SearchProducts.go +++ b/service/servicecatalog/api_op_SearchProducts.go @@ -56,17 +56,6 @@ func (c *Client) SearchProducts(ctx context.Context, params *SearchProductsInput type SearchProductsInput struct { - // The search filters. If no search filters are specified, the output includes all - // products to which the caller has access. - Filters map[string][]*string - - // The page token for the next set of results. To retrieve the first set of - // results, use null. - PageToken *string - - // The maximum number of items to return with this call. - PageSize *int32 - // The language code. // // * en - English (default) @@ -77,18 +66,26 @@ type SearchProductsInput struct { // - Chinese AcceptLanguage *string - // The sort order. If no value is specified, the results are not sorted. - SortOrder types.SortOrder + // The search filters. If no search filters are specified, the output includes all + // products to which the caller has access. + Filters map[string][]*string + + // The maximum number of items to return with this call. + PageSize *int32 + + // The page token for the next set of results. To retrieve the first set of + // results, use null. + PageToken *string // The sort field. If no value is specified, the results are not sorted. SortBy types.ProductViewSortBy + + // The sort order. If no value is specified, the results are not sorted. + SortOrder types.SortOrder } type SearchProductsOutput struct { - // Information about the product views. - ProductViewSummaries []*types.ProductViewSummary - // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string @@ -96,6 +93,9 @@ type SearchProductsOutput struct { // The product view aggregations. ProductViewAggregations map[string][]*types.ProductViewAggregationValue + // Information about the product views. + ProductViewSummaries []*types.ProductViewSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/servicecatalog/api_op_SearchProductsAsAdmin.go b/service/servicecatalog/api_op_SearchProductsAsAdmin.go index 9f8935c6be3..838be34b110 100644 --- a/service/servicecatalog/api_op_SearchProductsAsAdmin.go +++ b/service/servicecatalog/api_op_SearchProductsAsAdmin.go @@ -56,49 +56,49 @@ func (c *Client) SearchProductsAsAdmin(ctx context.Context, params *SearchProduc type SearchProductsAsAdminInput struct { - // The maximum number of items to return with this call. - PageSize *int32 - - // The portfolio identifier. - PortfolioId *string - - // Access level of the source of the product. - ProductSource types.ProductSource + // The language code. + // + // * en - English (default) + // + // * jp - Japanese + // + // * zh + // - Chinese + AcceptLanguage *string // The search filters. If no search filters are specified, the output includes all // products to which the administrator has access. Filters map[string][]*string - // The sort order. If no value is specified, the results are not sorted. - SortOrder types.SortOrder + // The maximum number of items to return with this call. + PageSize *int32 // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string + // The portfolio identifier. + PortfolioId *string + + // Access level of the source of the product. + ProductSource types.ProductSource + // The sort field. If no value is specified, the results are not sorted. SortBy types.ProductViewSortBy - // The language code. - // - // * en - English (default) - // - // * jp - Japanese - // - // * zh - // - Chinese - AcceptLanguage *string + // The sort order. If no value is specified, the results are not sorted. + SortOrder types.SortOrder } type SearchProductsAsAdminOutput struct { - // Information about the product views. - ProductViewDetails []*types.ProductViewDetail - // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string + // Information about the product views. + ProductViewDetails []*types.ProductViewDetail + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/servicecatalog/api_op_SearchProvisionedProducts.go b/service/servicecatalog/api_op_SearchProvisionedProducts.go index 55e61986a9a..7e480ac790d 100644 --- a/service/servicecatalog/api_op_SearchProvisionedProducts.go +++ b/service/servicecatalog/api_op_SearchProvisionedProducts.go @@ -57,16 +57,6 @@ func (c *Client) SearchProvisionedProducts(ctx context.Context, params *SearchPr type SearchProvisionedProductsInput struct { - // The maximum number of items to return with this call. - PageSize *int32 - - // The page token for the next set of results. To retrieve the first set of - // results, use null. - PageToken *string - - // The sort order. If no value is specified, the results are not sorted. - SortOrder types.SortOrder - // The language code. // // * en - English (default) @@ -77,9 +67,8 @@ type SearchProvisionedProductsInput struct { // - Chinese AcceptLanguage *string - // The sort field. If no value is specified, the results are not sorted. The valid - // values are arn, id, name, and lastRecordId. - SortBy *string + // The access level to use to obtain results. The default is User. + AccessLevelFilter *types.AccessLevelFilter // The search filters. When the key is SearchQuery, the searchable fields are arn, // createdTime, id, lastRecordId, idempotencyToken, name, physicalId, productId, @@ -87,21 +76,32 @@ type SearchProvisionedProductsInput struct { // "SearchQuery":["status:AVAILABLE"] Filters map[string][]*string - // The access level to use to obtain results. The default is User. - AccessLevelFilter *types.AccessLevelFilter + // The maximum number of items to return with this call. + PageSize *int32 + + // The page token for the next set of results. To retrieve the first set of + // results, use null. + PageToken *string + + // The sort field. If no value is specified, the results are not sorted. The valid + // values are arn, id, name, and lastRecordId. + SortBy *string + + // The sort order. If no value is specified, the results are not sorted. + SortOrder types.SortOrder } type SearchProvisionedProductsOutput struct { - // The number of provisioned products found. - TotalResultsCount *int32 + // The page token to use to retrieve the next set of results. If there are no + // additional results, this value is null. + NextPageToken *string // Information about the provisioned products. ProvisionedProducts []*types.ProvisionedProductAttribute - // The page token to use to retrieve the next set of results. If there are no - // additional results, this value is null. - NextPageToken *string + // The number of provisioned products found. + TotalResultsCount *int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/servicecatalog/api_op_TerminateProvisionedProduct.go b/service/servicecatalog/api_op_TerminateProvisionedProduct.go index 88c9709af91..0f4fb4258df 100644 --- a/service/servicecatalog/api_op_TerminateProvisionedProduct.go +++ b/service/servicecatalog/api_op_TerminateProvisionedProduct.go @@ -69,10 +69,6 @@ type TerminateProvisionedProductInput struct { // This member is required. TerminateToken *string - // The identifier of the provisioned product. You cannot specify both - // ProvisionedProductName and ProvisionedProductId. - ProvisionedProductId *string - // The language code. // // * en - English (default) @@ -87,6 +83,10 @@ type TerminateProvisionedProductInput struct { // product even if it cannot delete the underlying resources. IgnoreErrors *bool + // The identifier of the provisioned product. You cannot specify both + // ProvisionedProductName and ProvisionedProductId. + ProvisionedProductId *string + // The name of the provisioned product. You cannot specify both // ProvisionedProductName and ProvisionedProductId. ProvisionedProductName *string diff --git a/service/servicecatalog/api_op_UpdateConstraint.go b/service/servicecatalog/api_op_UpdateConstraint.go index a232142fa7c..e51bce1c802 100644 --- a/service/servicecatalog/api_op_UpdateConstraint.go +++ b/service/servicecatalog/api_op_UpdateConstraint.go @@ -57,6 +57,24 @@ func (c *Client) UpdateConstraint(ctx context.Context, params *UpdateConstraintI type UpdateConstraintInput struct { + // The identifier of the constraint. + // + // This member is required. + Id *string + + // The language code. + // + // * en - English (default) + // + // * jp - Japanese + // + // * zh + // - Chinese + AcceptLanguage *string + + // The updated description of the constraint. + Description *string + // The constraint parameters, in JSON format. The syntax depends on the constraint // type as follows: LAUNCH You are required to specify either the RoleArn or the // LocalRoleName but can't use both. Specify the RoleArn property as follows: @@ -83,24 +101,6 @@ type UpdateConstraintInput struct { // more information, see Template Constraint Rules // (http://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html). Parameters *string - - // The identifier of the constraint. - // - // This member is required. - Id *string - - // The language code. - // - // * en - English (default) - // - // * jp - Japanese - // - // * zh - // - Chinese - AcceptLanguage *string - - // The updated description of the constraint. - Description *string } type UpdateConstraintOutput struct { diff --git a/service/servicecatalog/api_op_UpdatePortfolio.go b/service/servicecatalog/api_op_UpdatePortfolio.go index 7913ea0ed39..6d12ef723d5 100644 --- a/service/servicecatalog/api_op_UpdatePortfolio.go +++ b/service/servicecatalog/api_op_UpdatePortfolio.go @@ -58,20 +58,11 @@ func (c *Client) UpdatePortfolio(ctx context.Context, params *UpdatePortfolioInp type UpdatePortfolioInput struct { - // The tags to remove. - RemoveTags []*string - // The portfolio identifier. // // This member is required. Id *string - // The updated description of the portfolio. - Description *string - - // The updated name of the portfolio provider. - ProviderName *string - // The language code. // // * en - English (default) @@ -82,11 +73,20 @@ type UpdatePortfolioInput struct { // - Chinese AcceptLanguage *string + // The tags to add. + AddTags []*types.Tag + + // The updated description of the portfolio. + Description *string + // The name to use for display purposes. DisplayName *string - // The tags to add. - AddTags []*types.Tag + // The updated name of the portfolio provider. + ProviderName *string + + // The tags to remove. + RemoveTags []*string } type UpdatePortfolioOutput struct { diff --git a/service/servicecatalog/api_op_UpdateProduct.go b/service/servicecatalog/api_op_UpdateProduct.go index 06f545f81e6..29bfcb52a2c 100644 --- a/service/servicecatalog/api_op_UpdateProduct.go +++ b/service/servicecatalog/api_op_UpdateProduct.go @@ -72,42 +72,42 @@ type UpdateProductInput struct { // - Chinese AcceptLanguage *string + // The tags to add to the product. + AddTags []*types.Tag + // The updated description of the product. Description *string - // The updated support description for the product. - SupportDescription *string - - // The updated support URL for the product. - SupportUrl *string + // The updated distributor of the product. + Distributor *string // The updated product name. Name *string - // The tags to add to the product. - AddTags []*types.Tag - // The updated owner of the product. Owner *string + // The tags to remove from the product. + RemoveTags []*string + + // The updated support description for the product. + SupportDescription *string + // The updated support email for the product. SupportEmail *string - // The updated distributor of the product. - Distributor *string - - // The tags to remove from the product. - RemoveTags []*string + // The updated support URL for the product. + SupportUrl *string } type UpdateProductOutput struct { - // Information about the tags associated with the product. - Tags []*types.Tag - // Information about the product view. ProductViewDetail *types.ProductViewDetail + // Information about the tags associated with the product. + Tags []*types.Tag + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/servicecatalog/api_op_UpdateProvisionedProduct.go b/service/servicecatalog/api_op_UpdateProvisionedProduct.go index 97a98f3a1df..24b636ecec8 100644 --- a/service/servicecatalog/api_op_UpdateProvisionedProduct.go +++ b/service/servicecatalog/api_op_UpdateProvisionedProduct.go @@ -63,26 +63,10 @@ func (c *Client) UpdateProvisionedProduct(ctx context.Context, params *UpdatePro type UpdateProvisionedProductInput struct { - // The name of the provisioned product. You cannot specify both - // ProvisionedProductName and ProvisionedProductId. - ProvisionedProductName *string - - // The name of the provisioning artifact. You must provide the name or ID, but not - // both. - ProvisioningArtifactName *string - - // The path identifier. This value is optional if the product has a default path, - // and required if the product has more than one path. You must provide the name or - // ID, but not both. - PathId *string - - // The identifier of the provisioned product. You must provide the name or ID, but - // not both. - ProvisionedProductId *string - - // An object that contains information about the provisioning preferences for a - // stack set. - ProvisioningPreferences *types.UpdateProvisioningPreferences + // The idempotency token that uniquely identifies the provisioning update request. + // + // This member is required. + UpdateToken *string // The language code. // @@ -94,29 +78,45 @@ type UpdateProvisionedProductInput struct { // - Chinese AcceptLanguage *string + // The path identifier. This value is optional if the product has a default path, + // and required if the product has more than one path. You must provide the name or + // ID, but not both. + PathId *string + // The name of the path. You must provide the name or ID, but not both. PathName *string + // The identifier of the product. You must provide the name or ID, but not both. + ProductId *string + + // The name of the product. You must provide the name or ID, but not both. + ProductName *string + + // The identifier of the provisioned product. You must provide the name or ID, but + // not both. + ProvisionedProductId *string + + // The name of the provisioned product. You cannot specify both + // ProvisionedProductName and ProvisionedProductId. + ProvisionedProductName *string + // The identifier of the provisioning artifact. ProvisioningArtifactId *string + // The name of the provisioning artifact. You must provide the name or ID, but not + // both. + ProvisioningArtifactName *string + // The new parameters. ProvisioningParameters []*types.UpdateProvisioningParameter + // An object that contains information about the provisioning preferences for a + // stack set. + ProvisioningPreferences *types.UpdateProvisioningPreferences + // One or more tags. Requires the product to have RESOURCE_UPDATE constraint with // TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates. Tags []*types.Tag - - // The name of the product. You must provide the name or ID, but not both. - ProductName *string - - // The identifier of the product. You must provide the name or ID, but not both. - ProductId *string - - // The idempotency token that uniquely identifies the provisioning update request. - // - // This member is required. - UpdateToken *string } type UpdateProvisionedProductOutput struct { diff --git a/service/servicecatalog/api_op_UpdateProvisionedProductProperties.go b/service/servicecatalog/api_op_UpdateProvisionedProductProperties.go index d7ed4209392..b64409b86de 100644 --- a/service/servicecatalog/api_op_UpdateProvisionedProductProperties.go +++ b/service/servicecatalog/api_op_UpdateProvisionedProductProperties.go @@ -59,15 +59,16 @@ func (c *Client) UpdateProvisionedProductProperties(ctx context.Context, params type UpdateProvisionedProductPropertiesInput struct { - // The language code. - // - // * en - English (default) + // The idempotency token that uniquely identifies the provisioning product update + // request. // - // * jp - Japanese + // This member is required. + IdempotencyToken *string + + // The identifier of the provisioned product. // - // * zh - // - Chinese - AcceptLanguage *string + // This member is required. + ProvisionedProductId *string // A map that contains the provisioned product properties to be updated. The OWNER // key accepts user ARNs and role ARNs. The owner is the user that is allowed to @@ -88,26 +89,25 @@ type UpdateProvisionedProductPropertiesInput struct { // This member is required. ProvisionedProductProperties map[string]*string - // The identifier of the provisioned product. + // The language code. // - // This member is required. - ProvisionedProductId *string - - // The idempotency token that uniquely identifies the provisioning product update - // request. + // * en - English (default) // - // This member is required. - IdempotencyToken *string + // * jp - Japanese + // + // * zh + // - Chinese + AcceptLanguage *string } type UpdateProvisionedProductPropertiesOutput struct { - // A map that contains the properties updated. - ProvisionedProductProperties map[string]*string - // The provisioned product identifier. ProvisionedProductId *string + // A map that contains the properties updated. + ProvisionedProductProperties map[string]*string + // The identifier of the record. RecordId *string diff --git a/service/servicecatalog/api_op_UpdateProvisioningArtifact.go b/service/servicecatalog/api_op_UpdateProvisioningArtifact.go index 92a2ccd8e9b..e4343f940da 100644 --- a/service/servicecatalog/api_op_UpdateProvisioningArtifact.go +++ b/service/servicecatalog/api_op_UpdateProvisioningArtifact.go @@ -64,30 +64,11 @@ type UpdateProvisioningArtifactInput struct { // This member is required. ProductId *string - // The updated description of the provisioning artifact. - Description *string - - // Information set by the administrator to provide guidance to end users about - // which provisioning artifacts to use. The DEFAULT value indicates that the - // product version is active. The administrator can set the guidance to DEPRECATED - // to inform users that the product version is deprecated. Users are able to make - // updates to a provisioned product of a deprecated version but cannot launch new - // provisioned products using a deprecated version. - Guidance types.ProvisioningArtifactGuidance - // The identifier of the provisioning artifact. // // This member is required. ProvisioningArtifactId *string - // The updated name of the provisioning artifact. - Name *string - - // Indicates whether the product version is active. Inactive provisioning artifacts - // are invisible to end users. End users cannot launch or update a provisioned - // product from an inactive provisioning artifact. - Active *bool - // The language code. // // * en - English (default) @@ -97,18 +78,37 @@ type UpdateProvisioningArtifactInput struct { // * zh // - Chinese AcceptLanguage *string + + // Indicates whether the product version is active. Inactive provisioning artifacts + // are invisible to end users. End users cannot launch or update a provisioned + // product from an inactive provisioning artifact. + Active *bool + + // The updated description of the provisioning artifact. + Description *string + + // Information set by the administrator to provide guidance to end users about + // which provisioning artifacts to use. The DEFAULT value indicates that the + // product version is active. The administrator can set the guidance to DEPRECATED + // to inform users that the product version is deprecated. Users are able to make + // updates to a provisioned product of a deprecated version but cannot launch new + // provisioned products using a deprecated version. + Guidance types.ProvisioningArtifactGuidance + + // The updated name of the provisioning artifact. + Name *string } type UpdateProvisioningArtifactOutput struct { - // The status of the current request. - Status types.Status + // The URL of the CloudFormation template in Amazon S3. + Info map[string]*string // Information about the provisioning artifact. ProvisioningArtifactDetail *types.ProvisioningArtifactDetail - // The URL of the CloudFormation template in Amazon S3. - Info map[string]*string + // The status of the current request. + Status types.Status // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/servicecatalog/api_op_UpdateServiceAction.go b/service/servicecatalog/api_op_UpdateServiceAction.go index b042ecc5d0b..804379d3662 100644 --- a/service/servicecatalog/api_op_UpdateServiceAction.go +++ b/service/servicecatalog/api_op_UpdateServiceAction.go @@ -57,8 +57,10 @@ func (c *Client) UpdateServiceAction(ctx context.Context, params *UpdateServiceA type UpdateServiceActionInput struct { - // The self-service action name. - Name *string + // The self-service action identifier. + // + // This member is required. + Id *string // The language code. // @@ -70,16 +72,14 @@ type UpdateServiceActionInput struct { // - Chinese AcceptLanguage *string - // The self-service action description. - Description *string - // A map that defines the self-service action. Definition map[string]*string - // The self-service action identifier. - // - // This member is required. - Id *string + // The self-service action description. + Description *string + + // The self-service action name. + Name *string } type UpdateServiceActionOutput struct { diff --git a/service/servicecatalog/go.mod b/service/servicecatalog/go.mod index 69bb9c12ac3..51398c5b028 100644 --- a/service/servicecatalog/go.mod +++ b/service/servicecatalog/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/servicecatalog go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/servicecatalog/types/types.go b/service/servicecatalog/types/types.go index e889622e035..99b792e1140 100644 --- a/service/servicecatalog/types/types.go +++ b/service/servicecatalog/types/types.go @@ -41,15 +41,22 @@ type CloudWatchDashboard struct { // Information about a constraint. type ConstraintDetail struct { - // The identifier of the product the constraint applies to. Note that a constraint - // applies to a specific instance of a product within a certain portfolio. - ProductId *string + // The identifier of the constraint. + ConstraintId *string // The description of the constraint. Description *string - // The identifier of the constraint. - ConstraintId *string + // The owner of the constraint. + Owner *string + + // The identifier of the portfolio the product resides in. The constraint applies + // only to the instance of the product that lives within this portfolio. + PortfolioId *string + + // The identifier of the product the constraint applies to. Note that a constraint + // applies to a specific instance of a product within a certain portfolio. + ProductId *string // The type of constraint. // @@ -62,13 +69,6 @@ type ConstraintDetail struct { // * // TEMPLATE Type *string - - // The owner of the constraint. - Owner *string - - // The identifier of the portfolio the product resides in. The constraint applies - // only to the instance of the product that lives within this portfolio. - PortfolioId *string } // Summary information about a constraint. @@ -94,44 +94,44 @@ type ConstraintSummary struct { // when executed on a provisioned product. type ExecutionParameter struct { + // The default values for the execution parameter. + DefaultValues []*string + // The name of the execution parameter. Name *string // The execution parameter type. Type *string - - // The default values for the execution parameter. - DefaultValues []*string } // An object containing information about the error, along with identifying // information about the self-service action and its associations. type FailedServiceActionAssociation struct { - // The self-service action identifier. For example, act-fs7abcd89wxyz. - ServiceActionId *string - - // The product identifier. For example, prod-abcdzk7xy33qa. - ProductId *string + // The error code. Valid values are listed below. + ErrorCode ServiceActionAssociationErrorCode // A text description of the error. ErrorMessage *string - // The error code. Valid values are listed below. - ErrorCode ServiceActionAssociationErrorCode + // The product identifier. For example, prod-abcdzk7xy33qa. + ProductId *string // The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne. ProvisioningArtifactId *string + + // The self-service action identifier. For example, act-fs7abcd89wxyz. + ServiceActionId *string } // A launch path object. type LaunchPath struct { - // The name of the launch path. - Name *string - // The identifier of the launch path. Id *string + + // The name of the launch path. + Name *string } // Summary information about a product path for a user. @@ -140,22 +140,19 @@ type LaunchPathSummary struct { // The constraints on the portfolio-product relationship. ConstraintSummaries []*ConstraintSummary - // The tags associated with this product path. - Tags []*Tag + // The identifier of the product path. + Id *string // The name of the portfolio to which the user was assigned. Name *string - // The identifier of the product path. - Id *string + // The tags associated with this product path. + Tags []*Tag } // The search filter to use when listing history records. type ListRecordHistorySearchFilter struct { - // The filter value. - Value *string - // The filter key. // // * product - Filter results based on the specified product @@ -164,29 +161,32 @@ type ListRecordHistorySearchFilter struct { // * provisionedproduct - Filter results based on the provisioned // product identifier. Key *string + + // The filter value. + Value *string } // Filters to use when listing TagOptions. type ListTagOptionsFilters struct { + // The active state. + Active *bool + // The TagOption key. Key *string // The TagOption value. Value *string - - // The active state. - Active *bool } // Information about the organization node. type OrganizationNode struct { - // The identifier of the organization node. - Value *string - // The organization node type. Type OrganizationNodeType + + // The identifier of the organization node. + Value *string } // The constraints that the administrator has put on the parameter. @@ -199,23 +199,23 @@ type ParameterConstraints struct { // Information about a portfolio. type PortfolioDetail struct { + // The ARN assigned to the portfolio. + ARN *string + // The UTC time stamp of the creation time. CreatedTime *time.Time // The description of the portfolio. Description *string - // The name of the portfolio provider. - ProviderName *string + // The name to use for display purposes. + DisplayName *string // The portfolio identifier. Id *string - // The ARN assigned to the portfolio. - ARN *string - - // The name to use for display purposes. - DisplayName *string + // The name of the portfolio provider. + ProviderName *string } // Information about a principal. @@ -242,15 +242,15 @@ type ProductViewAggregationValue struct { // Information about a product view. type ProductViewDetail struct { - // Summary information about the product view. - ProductViewSummary *ProductViewSummary - // The UTC time stamp of the creation time. CreatedTime *time.Time // The ARN of the product. ProductARN *string + // Summary information about the product view. + ProductViewSummary *ProductViewSummary + // The status of the product. // // * AVAILABLE - The product is ready for use. @@ -266,30 +266,37 @@ type ProductViewDetail struct { // Summary information about a product view. type ProductViewSummary struct { + // The distributor of the product. Contact the product administrator for the + // significance of this value. + Distributor *string + // Indicates whether the product has a default path. If the product does not have a // default path, call ListLaunchPaths () to disambiguate between paths. Otherwise, // ListLaunchPaths () is not required, and the output of ProductViewSummary () can // be used directly with DescribeProvisioningParameters (). HasDefaultPath *bool - // The description of the support for this Product. - SupportDescription *string - // The product view identifier. Id *string + // The name of the product. + Name *string + + // The owner of the product. Contact the product administrator for the significance + // of this value. + Owner *string + // The product identifier. ProductId *string // Short description of the product. ShortDescription *string - // The name of the product. - Name *string + // The description of the support for this Product. + SupportDescription *string - // The distributor of the product. Contact the product administrator for the - // significance of this value. - Distributor *string + // The email contact information to obtain support for this Product. + SupportEmail *string // The URL information to obtain support for this Product. SupportUrl *string @@ -297,27 +304,41 @@ type ProductViewSummary struct { // The product type. Contact the product administrator for the significance of this // value. If this value is MARKETPLACE, the product was created by AWS Marketplace. Type ProductType - - // The owner of the product. Contact the product administrator for the significance - // of this value. - Owner *string - - // The email contact information to obtain support for this Product. - SupportEmail *string } // Information about a provisioned product. type ProvisionedProductAttribute struct { - // The identifier of the provisioning artifact. - ProvisioningArtifactId *string - - // The ARN of the IAM user in the session. This ARN might contain a session ID. - UserArnSession *string - // The ARN of the provisioned product. Arn *string + // The UTC time stamp of the creation time. + CreatedTime *time.Time + + // The identifier of the provisioned product. + Id *string + + // A unique identifier that you provide to ensure idempotency. If multiple requests + // differ only by the idempotency token, the same response is returned for each + // repeated request. + IdempotencyToken *string + + // The record identifier of the last request performed on this provisioned product. + LastRecordId *string + + // The user-friendly name of the provisioned product. + Name *string + + // The assigned identifier for the resource, such as an EC2 instance ID or an S3 + // bucket name. + PhysicalId *string + + // The product identifier. + ProductId *string + + // The identifier of the provisioning artifact. + ProvisioningArtifactId *string + // The current status of the provisioned product. // // * AVAILABLE - Stable state, @@ -344,11 +365,8 @@ type ProvisionedProductAttribute struct { // plan. Wait for an AVAILABLE status before performing operations. Status ProvisionedProductStatus - // The Amazon Resource Name (ARN) of the IAM user. - UserArn *string - - // The identifier of the provisioned product. - Id *string + // The current status message of the provisioned product. + StatusMessage *string // One or more tags. Tags []*Tag @@ -357,67 +375,42 @@ type ProvisionedProductAttribute struct { // CFN_STACKSET. Type *string - // A unique identifier that you provide to ensure idempotency. If multiple requests - // differ only by the idempotency token, the same response is returned for each - // repeated request. - IdempotencyToken *string - - // The record identifier of the last request performed on this provisioned product. - LastRecordId *string - - // The assigned identifier for the resource, such as an EC2 instance ID or an S3 - // bucket name. - PhysicalId *string - - // The product identifier. - ProductId *string - - // The UTC time stamp of the creation time. - CreatedTime *time.Time - - // The user-friendly name of the provisioned product. - Name *string + // The Amazon Resource Name (ARN) of the IAM user. + UserArn *string - // The current status message of the provisioned product. - StatusMessage *string + // The ARN of the IAM user in the session. This ARN might contain a session ID. + UserArnSession *string } // Information about a provisioned product. type ProvisionedProductDetail struct { - // The product identifier. For example, prod-abcdzk7xy33qa. - ProductId *string - - // The current status message of the provisioned product. - StatusMessage *string - - // The identifier of the provisioned product. - Id *string - - // The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne. - ProvisioningArtifactId *string - - // The user-friendly name of the provisioned product. - Name *string - - // The record identifier of the last request performed on this provisioned product. - LastRecordId *string - // The ARN of the provisioned product. Arn *string // The UTC time stamp of the creation time. CreatedTime *time.Time - // The type of provisioned product. The supported values are CFN_STACK and - // CFN_STACKSET. - Type *string + // The identifier of the provisioned product. + Id *string // A unique identifier that you provide to ensure idempotency. If multiple requests // differ only by the idempotency token, the same response is returned for each // repeated request. IdempotencyToken *string + // The record identifier of the last request performed on this provisioned product. + LastRecordId *string + + // The user-friendly name of the provisioned product. + Name *string + + // The product identifier. For example, prod-abcdzk7xy33qa. + ProductId *string + + // The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne. + ProvisioningArtifactId *string + // The current status of the provisioned product. // // * AVAILABLE - Stable state, @@ -443,111 +436,134 @@ type ProvisionedProductDetail struct { // been created. After reviewing the list of resources to be created, execute the // plan. Wait for an AVAILABLE status before performing operations. Status ProvisionedProductStatus + + // The current status message of the provisioned product. + StatusMessage *string + + // The type of provisioned product. The supported values are CFN_STACK and + // CFN_STACKSET. + Type *string } // Information about a plan. type ProvisionedProductPlanDetails struct { + // The UTC time stamp of the creation time. + CreatedTime *time.Time + + // Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related + // events. + NotificationArns []*string + + // The path identifier of the product. This value is optional if the product has a + // default path, and required if the product has more than one path. To list the + // paths for a product, use ListLaunchPaths (). + PathId *string + // The plan identifier. PlanId *string - // The status. - Status ProvisionedProductPlanStatus - - // The user-friendly name of the provisioned product. - ProvisionProductName *string + // The name of the plan. + PlanName *string // The plan type. PlanType ProvisionedProductPlanType - // The time when the plan was last updated. - UpdatedTime *time.Time - + // The product identifier. + ProductId *string + // The product identifier. ProvisionProductId *string - // One or more tags. - Tags []*Tag + // The user-friendly name of the provisioned product. + ProvisionProductName *string + + // The identifier of the provisioning artifact. + ProvisioningArtifactId *string // Parameters specified by the administrator that are required for provisioning the // product. ProvisioningParameters []*UpdateProvisioningParameter - // The identifier of the provisioning artifact. - ProvisioningArtifactId *string - - // The path identifier of the product. This value is optional if the product has a - // default path, and required if the product has more than one path. To list the - // paths for a product, use ListLaunchPaths (). - PathId *string + // The status. + Status ProvisionedProductPlanStatus // The status message. StatusMessage *string - // The name of the plan. - PlanName *string - - // The UTC time stamp of the creation time. - CreatedTime *time.Time - - // The product identifier. - ProductId *string + // One or more tags. + Tags []*Tag - // Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related - // events. - NotificationArns []*string + // The time when the plan was last updated. + UpdatedTime *time.Time } // Summary information about a plan. type ProvisionedProductPlanSummary struct { - // The user-friendly name of the provisioned product. - ProvisionProductName *string - - // The identifier of the provisioning artifact. - ProvisioningArtifactId *string - // The plan identifier. PlanId *string - // The product identifier. - ProvisionProductId *string - // The name of the plan. PlanName *string // The plan type. PlanType ProvisionedProductPlanType + + // The product identifier. + ProvisionProductId *string + + // The user-friendly name of the provisioned product. + ProvisionProductName *string + + // The identifier of the provisioning artifact. + ProvisioningArtifactId *string } // Information about a provisioning artifact. A provisioning artifact is also known // as a product version. type ProvisioningArtifact struct { - // The identifier of the provisioning artifact. - Id *string + // The UTC time stamp of the creation time. + CreatedTime *time.Time // The description of the provisioning artifact. Description *string - // The name of the provisioning artifact. - Name *string - // Information set by the administrator to provide guidance to end users about // which provisioning artifacts to use. Guidance ProvisioningArtifactGuidance - // The UTC time stamp of the creation time. - CreatedTime *time.Time + // The identifier of the provisioning artifact. + Id *string + + // The name of the provisioning artifact. + Name *string } // Information about a provisioning artifact (also known as a version) for a // product. type ProvisioningArtifactDetail struct { + // Indicates whether the product version is active. + Active *bool + + // The UTC time stamp of the creation time. + CreatedTime *time.Time + + // The description of the provisioning artifact. + Description *string + + // Information set by the administrator to provide guidance to end users about + // which provisioning artifacts to use. + Guidance ProvisioningArtifactGuidance + // The identifier of the provisioning artifact. Id *string + // The name of the provisioning artifact. + Name *string + // The type of provisioning artifact. // // * CLOUD_FORMATION_TEMPLATE - AWS @@ -558,22 +574,6 @@ type ProvisioningArtifactDetail struct { // * // MARKETPLACE_CAR - AWS Marketplace Clusters and AWS Resources Type ProvisioningArtifactType - - // Indicates whether the product version is active. - Active *bool - - // Information set by the administrator to provide guidance to end users about - // which provisioning artifacts to use. - Guidance ProvisioningArtifactGuidance - - // The name of the provisioning artifact. - Name *string - - // The description of the provisioning artifact. - Description *string - - // The UTC time stamp of the creation time. - CreatedTime *time.Time } // Provisioning artifact output. @@ -589,6 +589,12 @@ type ProvisioningArtifactOutput struct { // Information about a parameter used to provision a product. type ProvisioningArtifactParameter struct { + // The default value. + DefaultValue *string + + // The description of the parameter. + Description *string + // If this value is true, the value for this parameter is obfuscated from view when // the parameter is retrieved. This parameter is used to hide sensitive // information. @@ -597,17 +603,11 @@ type ProvisioningArtifactParameter struct { // Constraints that the administrator has put on a parameter. ParameterConstraints *ParameterConstraints - // The parameter type. - ParameterType *string - - // The default value. - DefaultValue *string - - // The description of the parameter. - Description *string - // The parameter key. ParameterKey *string + + // The parameter type. + ParameterType *string } // The user-defined preferences that will be applied during product provisioning, @@ -635,6 +635,13 @@ type ProvisioningArtifactPreferences struct { // product. type ProvisioningArtifactProperties struct { + // The URL of the CloudFormation template in Amazon S3. Specify the URL in JSON + // format as follows: "LoadTemplateFromURL": + // "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..." + // + // This member is required. + Info map[string]*string + // The description of the provisioning artifact, including how it differs from the // previous provisioning artifact. Description *string @@ -643,13 +650,6 @@ type ProvisioningArtifactProperties struct { // artifact even if it is invalid. DisableTemplateValidation *bool - // The URL of the CloudFormation template in Amazon S3. Specify the URL in JSON - // format as follows: "LoadTemplateFromURL": - // "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..." - // - // This member is required. - Info map[string]*string - // The name of the provisioning artifact (for example, v1 v2beta). No spaces are // allowed. Name *string @@ -670,21 +670,21 @@ type ProvisioningArtifactProperties struct { // a product. type ProvisioningArtifactSummary struct { - // The metadata for the provisioning artifact. This is used with AWS Marketplace - // products. - ProvisioningArtifactMetadata map[string]*string + // The UTC time stamp of the creation time. + CreatedTime *time.Time - // The name of the provisioning artifact. - Name *string + // The description of the provisioning artifact. + Description *string // The identifier of the provisioning artifact. Id *string - // The description of the provisioning artifact. - Description *string + // The name of the provisioning artifact. + Name *string - // The UTC time stamp of the creation time. - CreatedTime *time.Time + // The metadata for the provisioning artifact. This is used with AWS Marketplace + // products. + ProvisioningArtifactMetadata map[string]*string } // An object that contains summary information about a product view and a @@ -721,13 +721,14 @@ type ProvisioningPreferences struct { // default value is all accounts from the STACKSET constraint. StackSetAccounts []*string - // One or more AWS Regions where the provisioned product will be available. - // Applicable only to a CFN_STACKSET provisioned product type. The specified - // regions should be within the list of regions from the STACKSET constraint. To - // get the list of regions in the STACKSET constraint, use the - // DescribeProvisioningParameters operation. If no values are specified, the - // default value is all regions from the STACKSET constraint. - StackSetRegions []*string + // The number of accounts, per region, for which this operation can fail before AWS + // Service Catalog stops the operation in that region. If the operation is stopped + // in a region, AWS Service Catalog doesn't attempt the operation in any subsequent + // regions. Applicable only to a CFN_STACKSET provisioned product type. + // Conditional: You must specify either StackSetFailureToleranceCount or + // StackSetFailureTolerancePercentage, but not both. The default value is 0 if no + // value is specified. + StackSetFailureToleranceCount *int32 // The percentage of accounts, per region, for which this stack operation can fail // before AWS Service Catalog stops the operation in that region. If the operation @@ -739,14 +740,16 @@ type ProvisioningPreferences struct { // StackSetFailureTolerancePercentage, but not both. StackSetFailureTolerancePercentage *int32 - // The number of accounts, per region, for which this operation can fail before AWS - // Service Catalog stops the operation in that region. If the operation is stopped - // in a region, AWS Service Catalog doesn't attempt the operation in any subsequent - // regions. Applicable only to a CFN_STACKSET provisioned product type. - // Conditional: You must specify either StackSetFailureToleranceCount or - // StackSetFailureTolerancePercentage, but not both. The default value is 0 if no - // value is specified. - StackSetFailureToleranceCount *int32 + // The maximum number of accounts in which to perform this operation at one time. + // This is dependent on the value of StackSetFailureToleranceCount. + // StackSetMaxConcurrentCount is at most one more than the + // StackSetFailureToleranceCount. Note that this setting lets you specify the + // maximum for operations. For large deployments, under certain circumstances the + // actual number of accounts acted upon concurrently may be lower due to service + // throttling. Applicable only to a CFN_STACKSET provisioned product type. + // Conditional: You must specify either StackSetMaxConcurrentCount or + // StackSetMaxConcurrentPercentage, but not both. + StackSetMaxConcurrencyCount *int32 // The maximum percentage of accounts in which to perform this operation at one // time. When calculating the number of accounts based on the specified percentage, @@ -760,21 +763,59 @@ type ProvisioningPreferences struct { // StackSetMaxConcurrentPercentage, but not both. StackSetMaxConcurrencyPercentage *int32 - // The maximum number of accounts in which to perform this operation at one time. - // This is dependent on the value of StackSetFailureToleranceCount. - // StackSetMaxConcurrentCount is at most one more than the - // StackSetFailureToleranceCount. Note that this setting lets you specify the - // maximum for operations. For large deployments, under certain circumstances the - // actual number of accounts acted upon concurrently may be lower due to service - // throttling. Applicable only to a CFN_STACKSET provisioned product type. - // Conditional: You must specify either StackSetMaxConcurrentCount or - // StackSetMaxConcurrentPercentage, but not both. - StackSetMaxConcurrencyCount *int32 + // One or more AWS Regions where the provisioned product will be available. + // Applicable only to a CFN_STACKSET provisioned product type. The specified + // regions should be within the list of regions from the STACKSET constraint. To + // get the list of regions in the STACKSET constraint, use the + // DescribeProvisioningParameters operation. If no values are specified, the + // default value is all regions from the STACKSET constraint. + StackSetRegions []*string } // Information about a request operation. type RecordDetail struct { + // The UTC time stamp of the creation time. + CreatedTime *time.Time + + // The path identifier. + PathId *string + + // The product identifier. + ProductId *string + + // The identifier of the provisioned product. + ProvisionedProductId *string + + // The user-friendly name of the provisioned product. + ProvisionedProductName *string + + // The type of provisioned product. The supported values are CFN_STACK and + // CFN_STACKSET. + ProvisionedProductType *string + + // The identifier of the provisioning artifact. + ProvisioningArtifactId *string + + // The errors that occurred. + RecordErrors []*RecordError + + // The identifier of the record. + RecordId *string + + // One or more tags. + RecordTags []*RecordTag + + // The record type. + // + // * PROVISION_PRODUCT + // + // * UPDATE_PROVISIONED_PRODUCT + // + // + // * TERMINATE_PROVISIONED_PRODUCT + RecordType *string + // The status of the provisioned product. // // * CREATED - The request was created @@ -794,49 +835,8 @@ type RecordDetail struct { // Investigate using the error messages returned. Status RecordStatus - // One or more tags. - RecordTags []*RecordTag - - // The UTC time stamp of the creation time. - CreatedTime *time.Time - - // The product identifier. - ProductId *string - - // The record type. - // - // * PROVISION_PRODUCT - // - // * UPDATE_PROVISIONED_PRODUCT - // - // - // * TERMINATE_PROVISIONED_PRODUCT - RecordType *string - - // The type of provisioned product. The supported values are CFN_STACK and - // CFN_STACKSET. - ProvisionedProductType *string - - // The path identifier. - PathId *string - - // The identifier of the record. - RecordId *string - - // The identifier of the provisioning artifact. - ProvisioningArtifactId *string - // The time when the record was last updated. UpdatedTime *time.Time - - // The user-friendly name of the provisioned product. - ProvisionedProductName *string - - // The identifier of the provisioned product. - ProvisionedProductId *string - - // The errors that occurred. - RecordErrors []*RecordError } // The error code and description resulting from an operation. @@ -877,35 +877,32 @@ type RecordTag struct { // Information about a resource change that will occur when a plan is executed. type ResourceChange struct { + // The change action. + Action ChangeAction + + // Information about the resource changes. + Details []*ResourceChangeDetail + + // The ID of the resource, as defined in the CloudFormation template. + LogicalResourceId *string + // The ID of the resource, if it was already created. PhysicalResourceId *string - // The type of resource. - ResourceType *string - // If the change type is Modify, indicates whether the existing resource is deleted // and replaced with a new one. Replacement Replacement - // The change action. - Action ChangeAction + // The type of resource. + ResourceType *string // The change scope. Scope []ResourceAttribute - - // The ID of the resource, as defined in the CloudFormation template. - LogicalResourceId *string - - // Information about the resource changes. - Details []*ResourceChangeDetail } // Information about a change to a resource attribute. type ResourceChangeDetail struct { - // Information about the resource attribute to be modified. - Target *ResourceTargetDefinition - // The ID of the entity that caused the change. CausingEntity *string @@ -913,23 +910,26 @@ type ResourceChangeDetail struct { // new value is known. For dynamic evaluations, the value might change, and any new // value will be determined when the plan is updated. Evaluation EvaluationType + + // Information about the resource attribute to be modified. + Target *ResourceTargetDefinition } // Information about a resource. type ResourceDetail struct { - // The creation time of the resource. - CreatedTime *time.Time - - // The identifier of the resource. - Id *string - // The ARN of the resource. ARN *string + // The creation time of the resource. + CreatedTime *time.Time + // The description of the resource. Description *string + // The identifier of the resource. + Id *string + // The name of the resource. Name *string } @@ -937,36 +937,36 @@ type ResourceDetail struct { // Information about a change to a resource attribute. type ResourceTargetDefinition struct { - // If the attribute is Properties, indicates whether a change to this property - // causes the resource to be re-created. - RequiresRecreation RequiresRecreation + // The attribute to be changed. + Attribute ResourceAttribute // If the attribute is Properties, the value is the name of the property. // Otherwise, the value is null. Name *string - // The attribute to be changed. - Attribute ResourceAttribute + // If the attribute is Properties, indicates whether a change to this property + // causes the resource to be re-created. + RequiresRecreation RequiresRecreation } // A self-service action association consisting of the Action ID, the Product ID, // and the Provisioning Artifact ID. type ServiceActionAssociation struct { - // The self-service action identifier. For example, act-fs7abcd89wxyz. + // The product identifier. For example, prod-abcdzk7xy33qa. // // This member is required. - ServiceActionId *string + ProductId *string // The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne. // // This member is required. ProvisioningArtifactId *string - // The product identifier. For example, prod-abcdzk7xy33qa. + // The self-service action identifier. For example, act-fs7abcd89wxyz. // // This member is required. - ProductId *string + ServiceActionId *string } // An object containing detailed information about the self-service action. @@ -985,37 +985,37 @@ type ServiceActionSummary struct { // The self-service action definition type. For example, SSM_AUTOMATION. DefinitionType ServiceActionDefinitionType - // The self-service action name. - Name *string - // The self-service action description. Description *string // The self-service action identifier. Id *string + + // The self-service action name. + Name *string } // Information about the portfolio share operation. type ShareDetails struct { - // List of accounts for whom the operation succeeded. - SuccessfulShares []*string - // List of errors. ShareErrors []*ShareError + + // List of accounts for whom the operation succeeded. + SuccessfulShares []*string } // Errors that occurred during the portfolio share operation. type ShareError struct { + // List of accounts impacted by the error. + Accounts []*string + // Error type that happened when processing the operation. Error *string // Information about the error. Message *string - - // List of accounts impacted by the error. - Accounts []*string } // An AWS CloudFormation stack, in a specific account and region, that's part of a @@ -1027,6 +1027,12 @@ type ShareError struct { // stack and the stack status. type StackInstance struct { + // The name of the AWS account that the stack instance is associated with. + Account *string + + // The name of the AWS region that the stack instance is associated with. + Region *string + // The status of the stack instance, in terms of its synchronization with its // associated stack set. // @@ -1045,32 +1051,29 @@ type StackInstance struct { // * CURRENT: The stack is // currently up to date with the stack set. StackInstanceStatus StackInstanceStatus - - // The name of the AWS account that the stack instance is associated with. - Account *string - - // The name of the AWS region that the stack instance is associated with. - Region *string } // Information about a tag. A tag is a key-value pair. Tags are propagated to the // resources created when provisioning a product. type Tag struct { - // The value for this key. + // The tag key. // // This member is required. - Value *string + Key *string - // The tag key. + // The value for this key. // // This member is required. - Key *string + Value *string } // Information about a TagOption. type TagOptionDetail struct { + // The TagOption active state. + Active *bool + // The TagOption identifier. Id *string @@ -1079,19 +1082,16 @@ type TagOptionDetail struct { // The TagOption value. Value *string - - // The TagOption active state. - Active *bool } // Summary information about a TagOption. type TagOptionSummary struct { - // The TagOption value. - Values []*string - // The TagOption key. Key *string + + // The TagOption value. + Values []*string } // The parameter key-value pair used to update a provisioned product. @@ -1111,25 +1111,6 @@ type UpdateProvisioningParameter struct { // product. Not all preferences are applicable to all provisioned product types. type UpdateProvisioningPreferences struct { - // One or more AWS Regions where the provisioned product will be available. - // Applicable only to a CFN_STACKSET provisioned product type. The specified - // regions should be within the list of regions from the STACKSET constraint. To - // get the list of regions in the STACKSET constraint, use the - // DescribeProvisioningParameters operation. If no values are specified, the - // default value is all regions from the STACKSET constraint. - StackSetRegions []*string - - // The maximum number of accounts in which to perform this operation at one time. - // This is dependent on the value of StackSetFailureToleranceCount. - // StackSetMaxConcurrentCount is at most one more than the - // StackSetFailureToleranceCount. Note that this setting lets you specify the - // maximum for operations. For large deployments, under certain circumstances the - // actual number of accounts acted upon concurrently may be lower due to service - // throttling. Applicable only to a CFN_STACKSET provisioned product type. - // Conditional: You must specify either StackSetMaxConcurrentCount or - // StackSetMaxConcurrentPercentage, but not both. - StackSetMaxConcurrencyCount *int32 - // One or more AWS accounts that will have access to the provisioned product. // Applicable only to a CFN_STACKSET provisioned product type. The AWS accounts // specified should be within the list of accounts in the STACKSET constraint. To @@ -1138,17 +1119,6 @@ type UpdateProvisioningPreferences struct { // default value is all accounts from the STACKSET constraint. StackSetAccounts []*string - // Determines what action AWS Service Catalog performs to a stack set or a stack - // instance represented by the provisioned product. The default value is UPDATE if - // nothing is specified. Applicable only to a CFN_STACKSET provisioned product - // type. CREATE Creates a new stack instance in the stack set represented by the - // provisioned product. In this case, only new stack instances are created based on - // accounts and regions; if new ProductId or ProvisioningArtifactID are passed, - // they will be ignored. UPDATE Updates the stack set represented by the - // provisioned product and also its stack instances. DELETE Deletes a stack - // instance in the stack set represented by the provisioned product. - StackSetOperationType StackSetOperationType - // The number of accounts, per region, for which this operation can fail before AWS // Service Catalog stops the operation in that region. If the operation is stopped // in a region, AWS Service Catalog doesn't attempt the operation in any subsequent @@ -1168,6 +1138,17 @@ type UpdateProvisioningPreferences struct { // StackSetFailureTolerancePercentage, but not both. StackSetFailureTolerancePercentage *int32 + // The maximum number of accounts in which to perform this operation at one time. + // This is dependent on the value of StackSetFailureToleranceCount. + // StackSetMaxConcurrentCount is at most one more than the + // StackSetFailureToleranceCount. Note that this setting lets you specify the + // maximum for operations. For large deployments, under certain circumstances the + // actual number of accounts acted upon concurrently may be lower due to service + // throttling. Applicable only to a CFN_STACKSET provisioned product type. + // Conditional: You must specify either StackSetMaxConcurrentCount or + // StackSetMaxConcurrentPercentage, but not both. + StackSetMaxConcurrencyCount *int32 + // The maximum percentage of accounts in which to perform this operation at one // time. When calculating the number of accounts based on the specified percentage, // AWS Service Catalog rounds down to the next whole number. This is true except in @@ -1179,14 +1160,33 @@ type UpdateProvisioningPreferences struct { // Conditional: You must specify either StackSetMaxConcurrentCount or // StackSetMaxConcurrentPercentage, but not both. StackSetMaxConcurrencyPercentage *int32 + + // Determines what action AWS Service Catalog performs to a stack set or a stack + // instance represented by the provisioned product. The default value is UPDATE if + // nothing is specified. Applicable only to a CFN_STACKSET provisioned product + // type. CREATE Creates a new stack instance in the stack set represented by the + // provisioned product. In this case, only new stack instances are created based on + // accounts and regions; if new ProductId or ProvisioningArtifactID are passed, + // they will be ignored. UPDATE Updates the stack set represented by the + // provisioned product and also its stack instances. DELETE Deletes a stack + // instance in the stack set represented by the provisioned product. + StackSetOperationType StackSetOperationType + + // One or more AWS Regions where the provisioned product will be available. + // Applicable only to a CFN_STACKSET provisioned product type. The specified + // regions should be within the list of regions from the STACKSET constraint. To + // get the list of regions in the STACKSET constraint, use the + // DescribeProvisioningParameters operation. If no values are specified, the + // default value is all regions from the STACKSET constraint. + StackSetRegions []*string } // Additional information provided by the administrator. type UsageInstruction struct { - // The usage instruction value for this type. - Value *string - // The usage instruction type for the value. Type *string + + // The usage instruction value for this type. + Value *string } diff --git a/service/servicediscovery/api_op_CreateHttpNamespace.go b/service/servicediscovery/api_op_CreateHttpNamespace.go index caa6682598a..29ccd003ba3 100644 --- a/service/servicediscovery/api_op_CreateHttpNamespace.go +++ b/service/servicediscovery/api_op_CreateHttpNamespace.go @@ -64,10 +64,10 @@ func (c *Client) CreateHttpNamespace(ctx context.Context, params *CreateHttpName type CreateHttpNamespaceInput struct { - // The tags to add to the namespace. Each tag consists of a key and an optional - // value, both of which you define. Tag keys can have a maximum character length of - // 128 characters, and tag values can have a maximum length of 256 characters. - Tags []*types.Tag + // The name that you want to assign to this namespace. + // + // This member is required. + Name *string // A unique string that identifies the request and that allows failed // CreateHttpNamespace requests to be retried without the risk of executing the @@ -78,10 +78,10 @@ type CreateHttpNamespaceInput struct { // A description for the namespace. Description *string - // The name that you want to assign to this namespace. - // - // This member is required. - Name *string + // The tags to add to the namespace. Each tag consists of a key and an optional + // value, both of which you define. Tag keys can have a maximum character length of + // 128 characters, and tag values can have a maximum length of 256 characters. + Tags []*types.Tag } type CreateHttpNamespaceOutput struct { diff --git a/service/servicediscovery/api_op_CreatePrivateDnsNamespace.go b/service/servicediscovery/api_op_CreatePrivateDnsNamespace.go index 7e71a744be1..5305d7dedba 100644 --- a/service/servicediscovery/api_op_CreatePrivateDnsNamespace.go +++ b/service/servicediscovery/api_op_CreatePrivateDnsNamespace.go @@ -78,6 +78,12 @@ type CreatePrivateDnsNamespaceInput struct { // This member is required. Vpc *string + // A unique string that identifies the request and that allows failed + // CreatePrivateDnsNamespace requests to be retried without the risk of executing + // the operation twice. CreatorRequestId can be any unique string, for example, a + // date/time stamp. + CreatorRequestId *string + // A description for the namespace. Description *string @@ -85,12 +91,6 @@ type CreatePrivateDnsNamespaceInput struct { // value, both of which you define. Tag keys can have a maximum character length of // 128 characters, and tag values can have a maximum length of 256 characters. Tags []*types.Tag - - // A unique string that identifies the request and that allows failed - // CreatePrivateDnsNamespace requests to be retried without the risk of executing - // the operation twice. CreatorRequestId can be any unique string, for example, a - // date/time stamp. - CreatorRequestId *string } type CreatePrivateDnsNamespaceOutput struct { diff --git a/service/servicediscovery/api_op_CreatePublicDnsNamespace.go b/service/servicediscovery/api_op_CreatePublicDnsNamespace.go index 179c54b838f..5f6d0cf36e9 100644 --- a/service/servicediscovery/api_op_CreatePublicDnsNamespace.go +++ b/service/servicediscovery/api_op_CreatePublicDnsNamespace.go @@ -65,10 +65,10 @@ func (c *Client) CreatePublicDnsNamespace(ctx context.Context, params *CreatePub type CreatePublicDnsNamespaceInput struct { - // The tags to add to the namespace. Each tag consists of a key and an optional - // value, both of which you define. Tag keys can have a maximum character length of - // 128 characters, and tag values can have a maximum length of 256 characters. - Tags []*types.Tag + // The name that you want to assign to this namespace. + // + // This member is required. + Name *string // A unique string that identifies the request and that allows failed // CreatePublicDnsNamespace requests to be retried without the risk of executing @@ -79,10 +79,10 @@ type CreatePublicDnsNamespaceInput struct { // A description for the namespace. Description *string - // The name that you want to assign to this namespace. - // - // This member is required. - Name *string + // The tags to add to the namespace. Each tag consists of a key and an optional + // value, both of which you define. Tag keys can have a maximum character length of + // 128 characters, and tag values can have a maximum length of 256 characters. + Tags []*types.Tag } type CreatePublicDnsNamespaceOutput struct { diff --git a/service/servicediscovery/api_op_CreateService.go b/service/servicediscovery/api_op_CreateService.go index 9077dc39433..c1f57d07324 100644 --- a/service/servicediscovery/api_op_CreateService.go +++ b/service/servicediscovery/api_op_CreateService.go @@ -86,25 +86,6 @@ func (c *Client) CreateService(ctx context.Context, params *CreateServiceInput, type CreateServiceInput struct { - // The tags to add to the service. Each tag consists of a key and an optional - // value, both of which you define. Tag keys can have a maximum character length of - // 128 characters, and tag values can have a maximum length of 256 characters. - Tags []*types.Tag - - // A description for the service. - Description *string - - // A complex type that contains information about the Amazon Route 53 records that - // you want AWS Cloud Map to create when you register an instance. - DnsConfig *types.DnsConfig - - // A complex type that contains information about an optional custom health check. - // If you specify a health check configuration, you can specify either - // HealthCheckCustomConfig or HealthCheckConfig but not both. You can't add, - // update, or delete a HealthCheckCustomConfig configuration from an existing - // service. - HealthCheckCustomConfig *types.HealthCheckCustomConfig - // The name that you want to assign to the service. If you want AWS Cloud Map to // create an SRV record when you register an instance, and if you're using a system // that requires a specific SRV format, such as HAProxy (http://www.haproxy.org/), @@ -123,8 +104,17 @@ type CreateServiceInput struct { // This member is required. Name *string - // The ID of the namespace that you want to use to create the service. - NamespaceId *string + // A unique string that identifies the request and that allows failed CreateService + // requests to be retried without the risk of executing the operation twice. + // CreatorRequestId can be any unique string, for example, a date/time stamp. + CreatorRequestId *string + + // A description for the service. + Description *string + + // A complex type that contains information about the Amazon Route 53 records that + // you want AWS Cloud Map to create when you register an instance. + DnsConfig *types.DnsConfig // Public DNS and HTTP namespaces only. A complex type that contains settings for // an optional Route 53 health check. If you specify settings for a health check, @@ -135,10 +125,20 @@ type CreateServiceInput struct { // (http://aws.amazon.com/cloud-map/pricing/). HealthCheckConfig *types.HealthCheckConfig - // A unique string that identifies the request and that allows failed CreateService - // requests to be retried without the risk of executing the operation twice. - // CreatorRequestId can be any unique string, for example, a date/time stamp. - CreatorRequestId *string + // A complex type that contains information about an optional custom health check. + // If you specify a health check configuration, you can specify either + // HealthCheckCustomConfig or HealthCheckConfig but not both. You can't add, + // update, or delete a HealthCheckCustomConfig configuration from an existing + // service. + HealthCheckCustomConfig *types.HealthCheckCustomConfig + + // The ID of the namespace that you want to use to create the service. + NamespaceId *string + + // The tags to add to the service. Each tag consists of a key and an optional + // value, both of which you define. Tag keys can have a maximum character length of + // 128 characters, and tag values can have a maximum length of 256 characters. + Tags []*types.Tag } type CreateServiceOutput struct { diff --git a/service/servicediscovery/api_op_DiscoverInstances.go b/service/servicediscovery/api_op_DiscoverInstances.go index 5044faa0e65..f76e532e423 100644 --- a/service/servicediscovery/api_op_DiscoverInstances.go +++ b/service/servicediscovery/api_op_DiscoverInstances.go @@ -60,24 +60,24 @@ func (c *Client) DiscoverInstances(ctx context.Context, params *DiscoverInstance type DiscoverInstancesInput struct { - // The health status of the instances that you want to discover. - HealthStatus types.HealthStatusFilter + // The name of the namespace that you specified when you registered the instance. + // + // This member is required. + NamespaceName *string // The name of the service that you specified when you registered the instance. // // This member is required. ServiceName *string + // The health status of the instances that you want to discover. + HealthStatus types.HealthStatusFilter + // The maximum number of instances that you want AWS Cloud Map to return in the // response to a DiscoverInstances request. If you don't specify a value for // MaxResults, AWS Cloud Map returns up to 100 instances. MaxResults *int32 - // The name of the namespace that you specified when you registered the instance. - // - // This member is required. - NamespaceName *string - // A string map that contains attributes with values that you can use to filter // instances by any custom attribute that you specified when you registered the // instance. Only instances that match all the specified key/value pairs will be diff --git a/service/servicediscovery/api_op_GetInstance.go b/service/servicediscovery/api_op_GetInstance.go index 2fc7184c398..76af4c31105 100644 --- a/service/servicediscovery/api_op_GetInstance.go +++ b/service/servicediscovery/api_op_GetInstance.go @@ -57,15 +57,15 @@ func (c *Client) GetInstance(ctx context.Context, params *GetInstanceInput, optF type GetInstanceInput struct { - // The ID of the service that the instance is associated with. + // The ID of the instance that you want to get information about. // // This member is required. - ServiceId *string + InstanceId *string - // The ID of the instance that you want to get information about. + // The ID of the service that the instance is associated with. // // This member is required. - InstanceId *string + ServiceId *string } type GetInstanceOutput struct { diff --git a/service/servicediscovery/api_op_GetInstancesHealthStatus.go b/service/servicediscovery/api_op_GetInstancesHealthStatus.go index 47bef8e2846..a3d7bee0bc7 100644 --- a/service/servicediscovery/api_op_GetInstancesHealthStatus.go +++ b/service/servicediscovery/api_op_GetInstancesHealthStatus.go @@ -74,29 +74,29 @@ type GetInstancesHealthStatusInput struct { // request. Instances []*string + // The maximum number of instances that you want AWS Cloud Map to return in the + // response to a GetInstancesHealthStatus request. If you don't specify a value for + // MaxResults, AWS Cloud Map returns up to 100 instances. + MaxResults *int32 + // For the first GetInstancesHealthStatus request, omit this value. If more than // MaxResults instances match the specified criteria, you can submit another // GetInstancesHealthStatus request to get the next group of results. Specify the // value of NextToken from the previous response in the next request. NextToken *string - - // The maximum number of instances that you want AWS Cloud Map to return in the - // response to a GetInstancesHealthStatus request. If you don't specify a value for - // MaxResults, AWS Cloud Map returns up to 100 instances. - MaxResults *int32 } type GetInstancesHealthStatusOutput struct { - // A complex type that contains the IDs and the health status of the instances that - // you specified in the GetInstancesHealthStatus request. - Status map[string]types.HealthStatus - // If more than MaxResults instances match the specified criteria, you can submit // another GetInstancesHealthStatus request to get the next group of results. // Specify the value of NextToken from the previous response in the next request. NextToken *string + // A complex type that contains the IDs and the health status of the instances that + // you specified in the GetInstancesHealthStatus request. + Status map[string]types.HealthStatus + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/servicediscovery/api_op_ListInstances.go b/service/servicediscovery/api_op_ListInstances.go index 82128f01a9d..f11971482bc 100644 --- a/service/servicediscovery/api_op_ListInstances.go +++ b/service/servicediscovery/api_op_ListInstances.go @@ -58,16 +58,16 @@ func (c *Client) ListInstances(ctx context.Context, params *ListInstancesInput, type ListInstancesInput struct { - // The maximum number of instances that you want AWS Cloud Map to return in the - // response to a ListInstances request. If you don't specify a value for - // MaxResults, AWS Cloud Map returns up to 100 instances. - MaxResults *int32 - // The ID of the service that you want to list instances for. // // This member is required. ServiceId *string + // The maximum number of instances that you want AWS Cloud Map to return in the + // response to a ListInstances request. If you don't specify a value for + // MaxResults, AWS Cloud Map returns up to 100 instances. + MaxResults *int32 + // For the first ListInstances request, omit this value. If more than MaxResults // instances match the specified criteria, you can submit another ListInstances // request to get the next group of results. Specify the value of NextToken from diff --git a/service/servicediscovery/api_op_ListNamespaces.go b/service/servicediscovery/api_op_ListNamespaces.go index 18548f69d73..e510ff6f50a 100644 --- a/service/servicediscovery/api_op_ListNamespaces.go +++ b/service/servicediscovery/api_op_ListNamespaces.go @@ -58,16 +58,16 @@ func (c *Client) ListNamespaces(ctx context.Context, params *ListNamespacesInput type ListNamespacesInput struct { - // The maximum number of namespaces that you want AWS Cloud Map to return in the - // response to a ListNamespaces request. If you don't specify a value for - // MaxResults, AWS Cloud Map returns up to 100 namespaces. - MaxResults *int32 - // A complex type that contains specifications for the namespaces that you want to // list. If you specify more than one filter, a namespace must match all filters to // be returned by ListNamespaces. Filters []*types.NamespaceFilter + // The maximum number of namespaces that you want AWS Cloud Map to return in the + // response to a ListNamespaces request. If you don't specify a value for + // MaxResults, AWS Cloud Map returns up to 100 namespaces. + MaxResults *int32 + // For the first ListNamespaces request, omit this value. If the response contains // NextToken, submit another ListNamespaces request to get the next group of // results. Specify the value of NextToken from the previous response in the next @@ -80,6 +80,10 @@ type ListNamespacesInput struct { type ListNamespacesOutput struct { + // An array that contains one NamespaceSummary object for each namespace that + // matches the specified filter criteria. + Namespaces []*types.NamespaceSummary + // If the response contains NextToken, submit another ListNamespaces request to get // the next group of results. Specify the value of NextToken from the previous // response in the next request. AWS Cloud Map gets MaxResults namespaces and then @@ -89,10 +93,6 @@ type ListNamespacesOutput struct { // criteria. NextToken *string - // An array that contains one NamespaceSummary object for each namespace that - // matches the specified filter criteria. - Namespaces []*types.NamespaceSummary - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/servicediscovery/api_op_ListOperations.go b/service/servicediscovery/api_op_ListOperations.go index 82aa02ededb..cd5dcd59e23 100644 --- a/service/servicediscovery/api_op_ListOperations.go +++ b/service/servicediscovery/api_op_ListOperations.go @@ -57,6 +57,12 @@ func (c *Client) ListOperations(ctx context.Context, params *ListOperationsInput type ListOperationsInput struct { + // A complex type that contains specifications for the operations that you want to + // list, for example, operations that you started between a specified start date + // and end date. If you specify more than one filter, an operation must match all + // filters to be returned by ListOperations. + Filters []*types.OperationFilter + // The maximum number of items that you want AWS Cloud Map to return in the // response to a ListOperations request. If you don't specify a value for // MaxResults, AWS Cloud Map returns up to 100 operations. @@ -70,12 +76,6 @@ type ListOperationsInput struct { // operations matched the specified criteria but that subsequent groups of // MaxResults operations do contain operations that match the criteria. NextToken *string - - // A complex type that contains specifications for the operations that you want to - // list, for example, operations that you started between a specified start date - // and end date. If you specify more than one filter, an operation must match all - // filters to be returned by ListOperations. - Filters []*types.OperationFilter } type ListOperationsOutput struct { diff --git a/service/servicediscovery/api_op_ListServices.go b/service/servicediscovery/api_op_ListServices.go index f0bef851489..7c896e11410 100644 --- a/service/servicediscovery/api_op_ListServices.go +++ b/service/servicediscovery/api_op_ListServices.go @@ -58,16 +58,16 @@ func (c *Client) ListServices(ctx context.Context, params *ListServicesInput, op type ListServicesInput struct { - // The maximum number of services that you want AWS Cloud Map to return in the - // response to a ListServices request. If you don't specify a value for MaxResults, - // AWS Cloud Map returns up to 100 services. - MaxResults *int32 - // A complex type that contains specifications for the namespaces that you want to // list services for. If you specify more than one filter, an operation must match // all filters to be returned by ListServices. Filters []*types.ServiceFilter + // The maximum number of services that you want AWS Cloud Map to return in the + // response to a ListServices request. If you don't specify a value for MaxResults, + // AWS Cloud Map returns up to 100 services. + MaxResults *int32 + // For the first ListServices request, omit this value. If the response contains // NextToken, submit another ListServices request to get the next group of results. // Specify the value of NextToken from the previous response in the next request. diff --git a/service/servicediscovery/api_op_RegisterInstance.go b/service/servicediscovery/api_op_RegisterInstance.go index 033869bfc8b..6d32cd3e943 100644 --- a/service/servicediscovery/api_op_RegisterInstance.go +++ b/service/servicediscovery/api_op_RegisterInstance.go @@ -93,14 +93,6 @@ func (c *Client) RegisterInstance(ctx context.Context, params *RegisterInstanceI type RegisterInstanceInput struct { - // A unique string that identifies the request and that allows failed - // RegisterInstance requests to be retried without the risk of executing the - // operation twice. You must use a unique CreatorRequestId string every time you - // submit a RegisterInstance request if you're registering additional instances for - // the same namespace and service. CreatorRequestId can be any unique string, for - // example, a date/time stamp. - CreatorRequestId *string - // A string map that contains the following information for the service that you // specify in ServiceId: // @@ -198,6 +190,14 @@ type RegisterInstanceInput struct { // // This member is required. ServiceId *string + + // A unique string that identifies the request and that allows failed + // RegisterInstance requests to be retried without the risk of executing the + // operation twice. You must use a unique CreatorRequestId string every time you + // submit a RegisterInstance request if you're registering additional instances for + // the same namespace and service. CreatorRequestId can be any unique string, for + // example, a date/time stamp. + CreatorRequestId *string } type RegisterInstanceOutput struct { diff --git a/service/servicediscovery/api_op_TagResource.go b/service/servicediscovery/api_op_TagResource.go index e01d71f04f7..51ca8dce64e 100644 --- a/service/servicediscovery/api_op_TagResource.go +++ b/service/servicediscovery/api_op_TagResource.go @@ -57,18 +57,18 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { + // The Amazon Resource Name (ARN) of the resource that you want to retrieve tags + // for. + // + // This member is required. + ResourceARN *string + // The tags to add to the specified resource. Specifying the tag key is required. // You can set the value of a tag to an empty string, but you can't set the value // of a tag to null. // // This member is required. Tags []*types.Tag - - // The Amazon Resource Name (ARN) of the resource that you want to retrieve tags - // for. - // - // This member is required. - ResourceARN *string } type TagResourceOutput struct { diff --git a/service/servicediscovery/api_op_UntagResource.go b/service/servicediscovery/api_op_UntagResource.go index 243be530d0d..ba08ea9bd65 100644 --- a/service/servicediscovery/api_op_UntagResource.go +++ b/service/servicediscovery/api_op_UntagResource.go @@ -56,16 +56,16 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The tag keys to remove from the specified resource. - // - // This member is required. - TagKeys []*string - // The Amazon Resource Name (ARN) of the resource that you want to retrieve tags // for. // // This member is required. ResourceARN *string + + // The tag keys to remove from the specified resource. + // + // This member is required. + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/servicediscovery/api_op_UpdateInstanceCustomHealthStatus.go b/service/servicediscovery/api_op_UpdateInstanceCustomHealthStatus.go index 971811f392a..759f9c94686 100644 --- a/service/servicediscovery/api_op_UpdateInstanceCustomHealthStatus.go +++ b/service/servicediscovery/api_op_UpdateInstanceCustomHealthStatus.go @@ -63,10 +63,10 @@ func (c *Client) UpdateInstanceCustomHealthStatus(ctx context.Context, params *U type UpdateInstanceCustomHealthStatusInput struct { - // The new status of the instance, HEALTHY or UNHEALTHY. + // The ID of the instance that you want to change the health status for. // // This member is required. - Status types.CustomHealthStatus + InstanceId *string // The ID of the service that includes the configuration for the custom health // check that you want to change the status for. @@ -74,10 +74,10 @@ type UpdateInstanceCustomHealthStatusInput struct { // This member is required. ServiceId *string - // The ID of the instance that you want to change the health status for. + // The new status of the instance, HEALTHY or UNHEALTHY. // // This member is required. - InstanceId *string + Status types.CustomHealthStatus } type UpdateInstanceCustomHealthStatusOutput struct { diff --git a/service/servicediscovery/api_op_UpdateService.go b/service/servicediscovery/api_op_UpdateService.go index da5a23801b4..f731d49bc18 100644 --- a/service/servicediscovery/api_op_UpdateService.go +++ b/service/servicediscovery/api_op_UpdateService.go @@ -79,15 +79,15 @@ func (c *Client) UpdateService(ctx context.Context, params *UpdateServiceInput, type UpdateServiceInput struct { - // A complex type that contains the new settings for the service. + // The ID of the service that you want to update. // // This member is required. - Service *types.ServiceChange + Id *string - // The ID of the service that you want to update. + // A complex type that contains the new settings for the service. // // This member is required. - Id *string + Service *types.ServiceChange } type UpdateServiceOutput struct { diff --git a/service/servicediscovery/go.mod b/service/servicediscovery/go.mod index fdc1b1f515b..1602ee30650 100644 --- a/service/servicediscovery/go.mod +++ b/service/servicediscovery/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/servicediscovery go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/servicediscovery/types/types.go b/service/servicediscovery/types/types.go index 918c343c37d..6e2495fe4d2 100644 --- a/service/servicediscovery/types/types.go +++ b/service/servicediscovery/types/types.go @@ -10,6 +10,15 @@ import ( // that you want AWS Cloud Map to create when you register an instance. type DnsConfig struct { + // An array that contains one DnsRecord object for each Route 53 DNS record that + // you want AWS Cloud Map to create when you register an instance. + // + // This member is required. + DnsRecords []*DnsRecord + + // The ID of the namespace to use for DNS configuration. + NamespaceId *string + // The routing policy that you want to apply to all Route 53 DNS records that AWS // Cloud Map creates when you register an instance and specify this service. If you // want to use this service to register instances that create alias records, @@ -40,15 +49,6 @@ type DnsConfig struct { // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-weighted) // in the Route 53 Developer Guide. RoutingPolicy RoutingPolicy - - // The ID of the namespace to use for DNS configuration. - NamespaceId *string - - // An array that contains one DnsRecord object for each Route 53 DNS record that - // you want AWS Cloud Map to create when you register an instance. - // - // This member is required. - DnsRecords []*DnsRecord } // A complex type that contains information about changes to the Route 53 DNS @@ -331,15 +331,6 @@ type HealthCheckCustomConfig struct { // matches the values that you specified in the request. type HttpInstanceSummary struct { - // The name of the namespace that you specified when you registered the instance. - NamespaceName *string - - // The ID of an instance that matches the values that you specified in the request. - InstanceId *string - - // The name of the service that you specified when you registered the instance. - ServiceName *string - // If you included any attributes when you registered the instance, the values of // those attributes. Attributes map[string]*string @@ -347,6 +338,15 @@ type HttpInstanceSummary struct { // If you configured health checking in the service, the current health status of // the service instance. HealthStatus HealthStatus + + // The ID of an instance that matches the values that you specified in the request. + InstanceId *string + + // The name of the namespace that you specified when you registered the instance. + NamespaceName *string + + // The name of the service that you specified when you registered the instance. + ServiceName *string } // A complex type that contains the name of an HTTP namespace. @@ -360,13 +360,29 @@ type HttpProperties struct { // creates when you submit a RegisterInstance request. type Instance struct { - // A unique string that identifies the request and that allows failed - // RegisterInstance requests to be retried without the risk of executing the - // operation twice. You must use a unique CreatorRequestId string every time you - // submit a RegisterInstance request if you're registering additional instances for - // the same namespace and service. CreatorRequestId can be any unique string, for - // example, a date/time stamp. - CreatorRequestId *string + // An identifier that you want to associate with the instance. Note the + // following: + // + // * If the service that is specified by ServiceId includes + // settings for an SRV record, the value of InstanceId is automatically included as + // part of the value for the SRV record. For more information, see DnsRecord > Type + // (https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type). + // + // + // * You can use this value to update an existing instance. + // + // * To register a + // new instance, you must specify a value that is unique among instances that you + // register by using the same service. + // + // * If you specify an existing InstanceId + // and ServiceId, AWS Cloud Map updates the existing DNS records. If there's also + // an existing health check, AWS Cloud Map deletes the old health check and creates + // a new one. The health check isn't deleted immediately, so it will still appear + // for a while if you submit a ListHealthChecks request, for example. + // + // This member is required. + Id *string // A string map that contains the following information for the service that you // specify in ServiceId: @@ -426,38 +442,19 @@ type Instance struct { // service. Attributes map[string]*string - // An identifier that you want to associate with the instance. Note the - // following: - // - // * If the service that is specified by ServiceId includes - // settings for an SRV record, the value of InstanceId is automatically included as - // part of the value for the SRV record. For more information, see DnsRecord > Type - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type). - // - // - // * You can use this value to update an existing instance. - // - // * To register a - // new instance, you must specify a value that is unique among instances that you - // register by using the same service. - // - // * If you specify an existing InstanceId - // and ServiceId, AWS Cloud Map updates the existing DNS records. If there's also - // an existing health check, AWS Cloud Map deletes the old health check and creates - // a new one. The health check isn't deleted immediately, so it will still appear - // for a while if you submit a ListHealthChecks request, for example. - // - // This member is required. - Id *string + // A unique string that identifies the request and that allows failed + // RegisterInstance requests to be retried without the risk of executing the + // operation twice. You must use a unique CreatorRequestId string every time you + // submit a RegisterInstance request if you're registering additional instances for + // the same namespace and service. CreatorRequestId can be any unique string, for + // example, a date/time stamp. + CreatorRequestId *string } // A complex type that contains information about the instances that you registered // by using a specified service. type InstanceSummary struct { - // The ID for an instance that you created by using a specified service. - Id *string - // A string map that contains the following information: // // * The attributes that @@ -489,14 +486,17 @@ type InstanceSummary struct { // port. In addition, if the service includes HealthCheckConfig, the port on the // endpoint that Route 53 sends requests to. Attributes map[string]*string + + // The ID for an instance that you created by using a specified service. + Id *string } // A complex type that contains information about a specified namespace. type Namespace struct { - // A complex type that contains information that's specific to the type of the - // namespace. - Properties *NamespaceProperties + // The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace when + // you create it. + Arn *string // The date that the namespace was created, in Unix date/time format and // Coordinated Universal Time (UTC). The value of CreateDate is accurate to @@ -504,6 +504,26 @@ type Namespace struct { // 26, 2018 12:11:30.087 AM. CreateDate *time.Time + // A unique string that identifies the request and that allows failed requests to + // be retried without the risk of executing an operation twice. + CreatorRequestId *string + + // The description that you specify for the namespace when you create it. + Description *string + + // The ID of a namespace. + Id *string + + // The name of the namespace, such as example.com. + Name *string + + // A complex type that contains information that's specific to the type of the + // namespace. + Properties *NamespaceProperties + + // The number of services that are associated with the namespace. + ServiceCount *int32 + // The type of the namespace. The methods for discovering instances depends on the // value that you specify: // @@ -517,26 +537,6 @@ type Namespace struct { // * DNS_PRIVATE: Instances can be discovered using DNS // queries in VPCs and using the DiscoverInstances API. Type NamespaceType - - // The number of services that are associated with the namespace. - ServiceCount *int32 - - // The name of the namespace, such as example.com. - Name *string - - // The ID of a namespace. - Id *string - - // A unique string that identifies the request and that allows failed requests to - // be retried without the risk of executing an operation twice. - CreatorRequestId *string - - // The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace when - // you create it. - Arn *string - - // The description that you specify for the namespace when you create it. - Description *string } // A complex type that identifies the namespaces that you want to list. You can @@ -583,32 +583,32 @@ type NamespaceProperties struct { // A complex type that contains information about a namespace. type NamespaceSummary struct { + // The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace when + // you create it. + Arn *string + // The date and time that the namespace was created. CreateDate *time.Time - // The type of the namespace, either public or private. - Type NamespaceType + // A description for the namespace. + Description *string - // A complex type that contains information that is specific to the namespace type. - Properties *NamespaceProperties + // The ID of the namespace. + Id *string // The name of the namespace. When you create a namespace, AWS Cloud Map // automatically creates a Route 53 hosted zone that has the same name as the // namespace. Name *string + // A complex type that contains information that is specific to the namespace type. + Properties *NamespaceProperties + // The number of services that were created using the namespace. ServiceCount *int32 - // The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace when - // you create it. - Arn *string - - // A description for the namespace. - Description *string - - // The ID of the namespace. - Id *string + // The type of the namespace, either public or private. + Type NamespaceType } // A complex type that contains information about a specified operation. @@ -620,12 +620,6 @@ type Operation struct { // 26, 2018 12:11:30.087 AM. CreateDate *time.Time - // The name of the operation that is associated with the specified ID. - Type OperationType - - // If the value of Status is FAIL, the reason that the operation failed. - ErrorMessage *string - // The code associated with ErrorMessage. Values for ErrorCode include the // following: // @@ -646,6 +640,12 @@ type Operation struct { // * THROTTLED_REQUEST ErrorCode *string + // If the value of Status is FAIL, the reason that the operation failed. + ErrorMessage *string + + // The ID of the operation that you want to get information about. + Id *string + // The status of the operation. Values include the following: // // * SUBMITTED: @@ -661,15 +661,6 @@ type Operation struct { // see ErrorMessage. Status OperationStatus - // The date and time that the value of Status changed to the current value, in Unix - // date/time format and Coordinated Universal Time (UTC). The value of UpdateDate - // is accurate to milliseconds. For example, the value 1516925490.087 represents - // Friday, January 26, 2018 12:11:30.087 AM. - UpdateDate *time.Time - - // The ID of the operation that you want to get information about. - Id *string - // The name of the target entity that is associated with the operation: // // * @@ -681,28 +672,39 @@ type Operation struct { // * INSTANCE: // The instance ID is returned in the ResourceId property. Targets map[string]*string + + // The name of the operation that is associated with the specified ID. + Type OperationType + + // The date and time that the value of Status changed to the current value, in Unix + // date/time format and Coordinated Universal Time (UTC). The value of UpdateDate + // is accurate to milliseconds. For example, the value 1516925490.087 represents + // Friday, January 26, 2018 12:11:30.087 AM. + UpdateDate *time.Time } // A complex type that lets you select the operations that you want to list. type OperationFilter struct { - // The operator that you want to use to determine whether an operation matches the - // specified value. Valid values for condition include: + // Specify the operations that you want to get: // - // * EQ: When you specify - // EQ for the condition, you can specify only one value. EQ is supported for - // NAMESPACE_ID, SERVICE_ID, STATUS, and TYPE. EQ is the default condition and can - // be omitted. + // * NAMESPACE_ID: Gets + // operations related to specified namespaces. // - // * IN: When you specify IN for the condition, you can specify a - // list of one or more values. IN is supported for STATUS and TYPE. An operation - // must match one of the specified values to be returned in the response. + // * SERVICE_ID: Gets operations + // related to specified services. // - // * - // BETWEEN: Specify a start date and an end date in Unix date/time format and - // Coordinated Universal Time (UTC). The start date must be the first value. - // BETWEEN is supported for UPDATE_DATE. - Condition FilterCondition + // * STATUS: Gets operations based on the + // status of the operations: SUBMITTED, PENDING, SUCCEED, or FAIL. + // + // * TYPE: + // Gets specified types of operation. + // + // * UPDATE_DATE: Gets operations that + // changed status during a specified date/time range. + // + // This member is required. + Name OperationFilterName // Specify values that are applicable to the value that you specify for Name: // @@ -725,25 +727,23 @@ type OperationFilter struct { // This member is required. Values []*string - // Specify the operations that you want to get: - // - // * NAMESPACE_ID: Gets - // operations related to specified namespaces. - // - // * SERVICE_ID: Gets operations - // related to specified services. - // - // * STATUS: Gets operations based on the - // status of the operations: SUBMITTED, PENDING, SUCCEED, or FAIL. + // The operator that you want to use to determine whether an operation matches the + // specified value. Valid values for condition include: // - // * TYPE: - // Gets specified types of operation. + // * EQ: When you specify + // EQ for the condition, you can specify only one value. EQ is supported for + // NAMESPACE_ID, SERVICE_ID, STATUS, and TYPE. EQ is the default condition and can + // be omitted. // - // * UPDATE_DATE: Gets operations that - // changed status during a specified date/time range. + // * IN: When you specify IN for the condition, you can specify a + // list of one or more values. IN is supported for STATUS and TYPE. An operation + // must match one of the specified values to be returned in the response. // - // This member is required. - Name OperationFilterName + // * + // BETWEEN: Specify a start date and an end date in Unix date/time format and + // Coordinated Universal Time (UTC). The start date must be the first value. + // BETWEEN is supported for UPDATE_DATE. + Condition FilterCondition } // A complex type that contains information about an operation that matches the @@ -774,14 +774,9 @@ type OperationSummary struct { // A complex type that contains information about the specified service. type Service struct { - // The number of instances that are currently associated with the service. - // Instances that were previously associated with the service but that have been - // deleted are not included in the count. The count might not reflect pending - // registrations and deregistrations. - InstanceCount *int32 - - // The description of the service. - Description *string + // The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when + // you create it. + Arn *string // The date and time that the service was created, in Unix format and Coordinated // Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For @@ -794,15 +789,12 @@ type Service struct { // can be any unique string, for example, a date/time stamp. CreatorRequestId *string - // The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when - // you create it. - Arn *string - - // The name of the service. - Name *string + // The description of the service. + Description *string - // The ID of the namespace that was used to create the service. - NamespaceId *string + // A complex type that contains information about the Route 53 DNS records that you + // want AWS Cloud Map to create when you register an instance. + DnsConfig *DnsConfig // Public DNS and HTTP namespaces only. A complex type that contains settings for // an optional health check. If you specify settings for a health check, AWS Cloud @@ -811,17 +803,25 @@ type Service struct { // (http://aws.amazon.com/route53/pricing/). HealthCheckConfig *HealthCheckConfig - // The ID that AWS Cloud Map assigned to the service when you created it. - Id *string - - // A complex type that contains information about the Route 53 DNS records that you - // want AWS Cloud Map to create when you register an instance. - DnsConfig *DnsConfig - // A complex type that contains information about an optional custom health check. // If you specify a health check configuration, you can specify either // HealthCheckCustomConfig or HealthCheckConfig but not both. HealthCheckCustomConfig *HealthCheckCustomConfig + + // The ID that AWS Cloud Map assigned to the service when you created it. + Id *string + + // The number of instances that are currently associated with the service. + // Instances that were previously associated with the service but that have been + // deleted are not included in the count. The count might not reflect pending + // registrations and deregistrations. + InstanceCount *int32 + + // The name of the service. + Name *string + + // The ID of the namespace that was used to create the service. + NamespaceId *string } // A complex type that contains changes to an existing service. @@ -830,6 +830,10 @@ type ServiceChange struct { // A description for the service. Description *string + // A complex type that contains information about the Route 53 DNS records that you + // want AWS Cloud Map to create when you register an instance. + DnsConfig *DnsConfigChange + // Public DNS and HTTP namespaces only. A complex type that contains settings for // an optional health check. If you specify settings for a health check, AWS Cloud // Map associates the health check with the records that you specify in DnsConfig. @@ -872,10 +876,6 @@ type ServiceChange struct { // that monitor an AWS endpoint. For information about pricing for health checks, // see Amazon Route 53 Pricing (http://aws.amazon.com/route53/pricing/). HealthCheckConfig *HealthCheckConfig - - // A complex type that contains information about the Route 53 DNS records that you - // want AWS Cloud Map to create when you register an instance. - DnsConfig *DnsConfigChange } // A complex type that lets you specify the namespaces that you want to list @@ -911,6 +911,63 @@ type ServiceFilter struct { // A complex type that contains information about a specified service. type ServiceSummary struct { + // The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when + // you create it. + Arn *string + + // The date and time that the service was created. + CreateDate *time.Time + + // The description that you specify when you create the service. + Description *string + + // A complex type that contains information about the Amazon Route 53 DNS records + // that you want AWS Cloud Map to create when you register an instance. + DnsConfig *DnsConfig + + // Public DNS and HTTP namespaces only. A complex type that contains settings for + // an optional health check. If you specify settings for a health check, AWS Cloud + // Map associates the health check with the records that you specify in DnsConfig. + // If you specify a health check configuration, you can specify either + // HealthCheckCustomConfig or HealthCheckConfig but not both. Health checks are + // basic Route 53 health checks that monitor an AWS endpoint. For information about + // pricing for health checks, see Amazon Route 53 Pricing + // (http://aws.amazon.com/route53/pricing/). Note the following about configuring + // health checks. A and AAAA records If DnsConfig includes configurations for both + // A and AAAA records, AWS Cloud Map creates a health check that uses the IPv4 + // address to check the health of the resource. If the endpoint that is specified + // by the IPv4 address is unhealthy, Route 53 considers both the A and AAAA records + // to be unhealthy. CNAME records You can't specify settings for HealthCheckConfig + // when the DNSConfig includes CNAME for the value of Type. If you do, the + // CreateService request will fail with an InvalidInput error. Request interval A + // Route 53 health checker in each health-checking region sends a health check + // request to an endpoint every 30 seconds. On average, your endpoint receives a + // health check request about every two seconds. However, health checkers don't + // coordinate with one another, so you'll sometimes see several requests per second + // followed by a few seconds with no health checks at all. Health checking regions + // Health checkers perform checks from all Route 53 health-checking regions. For a + // list of the current regions, see Regions + // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions). + // Alias records When you register an instance, if you include the + // AWS_ALIAS_DNS_NAME attribute, AWS Cloud Map creates a Route 53 alias record. + // Note the following: + // + // * Route 53 automatically sets EvaluateTargetHealth to + // true for alias records. When EvaluateTargetHealth is true, the alias record + // inherits the health of the referenced AWS resource. such as an ELB load + // balancer. For more information, see EvaluateTargetHealth + // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth). + // + // + // * If you include HealthCheckConfig and then use the service to register an + // instance that creates an alias record, Route 53 doesn't create the health + // check. + // + // Charges for health checks Health checks are basic Route 53 health checks + // that monitor an AWS endpoint. For information about pricing for health checks, + // see Amazon Route 53 Pricing (http://aws.amazon.com/route53/pricing/). + HealthCheckConfig *HealthCheckConfig + // A complex type that contains information about an optional custom health check. // A custom health check, which requires that you use a third-party health checker // to evaluate the health of your resources, is useful in the following @@ -963,8 +1020,8 @@ type ServiceSummary struct { // resource. HealthCheckCustomConfig *HealthCheckCustomConfig - // The date and time that the service was created. - CreateDate *time.Time + // The ID that AWS Cloud Map assigned to the service when you created it. + Id *string // The number of instances that are currently associated with the service. // Instances that were previously associated with the service but that have been @@ -972,78 +1029,21 @@ type ServiceSummary struct { // registrations and deregistrations. InstanceCount *int32 - // Public DNS and HTTP namespaces only. A complex type that contains settings for - // an optional health check. If you specify settings for a health check, AWS Cloud - // Map associates the health check with the records that you specify in DnsConfig. - // If you specify a health check configuration, you can specify either - // HealthCheckCustomConfig or HealthCheckConfig but not both. Health checks are - // basic Route 53 health checks that monitor an AWS endpoint. For information about - // pricing for health checks, see Amazon Route 53 Pricing - // (http://aws.amazon.com/route53/pricing/). Note the following about configuring - // health checks. A and AAAA records If DnsConfig includes configurations for both - // A and AAAA records, AWS Cloud Map creates a health check that uses the IPv4 - // address to check the health of the resource. If the endpoint that is specified - // by the IPv4 address is unhealthy, Route 53 considers both the A and AAAA records - // to be unhealthy. CNAME records You can't specify settings for HealthCheckConfig - // when the DNSConfig includes CNAME for the value of Type. If you do, the - // CreateService request will fail with an InvalidInput error. Request interval A - // Route 53 health checker in each health-checking region sends a health check - // request to an endpoint every 30 seconds. On average, your endpoint receives a - // health check request about every two seconds. However, health checkers don't - // coordinate with one another, so you'll sometimes see several requests per second - // followed by a few seconds with no health checks at all. Health checking regions - // Health checkers perform checks from all Route 53 health-checking regions. For a - // list of the current regions, see Regions - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions). - // Alias records When you register an instance, if you include the - // AWS_ALIAS_DNS_NAME attribute, AWS Cloud Map creates a Route 53 alias record. - // Note the following: - // - // * Route 53 automatically sets EvaluateTargetHealth to - // true for alias records. When EvaluateTargetHealth is true, the alias record - // inherits the health of the referenced AWS resource. such as an ELB load - // balancer. For more information, see EvaluateTargetHealth - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth). - // - // - // * If you include HealthCheckConfig and then use the service to register an - // instance that creates an alias record, Route 53 doesn't create the health - // check. - // - // Charges for health checks Health checks are basic Route 53 health checks - // that monitor an AWS endpoint. For information about pricing for health checks, - // see Amazon Route 53 Pricing (http://aws.amazon.com/route53/pricing/). - HealthCheckConfig *HealthCheckConfig - - // The ID that AWS Cloud Map assigned to the service when you created it. - Id *string - - // A complex type that contains information about the Amazon Route 53 DNS records - // that you want AWS Cloud Map to create when you register an instance. - DnsConfig *DnsConfig - - // The description that you specify when you create the service. - Description *string - // The name of the service. Name *string - - // The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when - // you create it. - Arn *string } // A custom key-value pair associated with a resource. type Tag struct { - // The string value that's associated with the key of the tag. You can set the - // value of a tag to an empty string, but you can't set the value of a tag to null. + // The key identifier, or name, of the tag. // // This member is required. - Value *string + Key *string - // The key identifier, or name, of the tag. + // The string value that's associated with the key of the tag. You can set the + // value of a tag to an empty string, but you can't set the value of a tag to null. // // This member is required. - Key *string + Value *string } diff --git a/service/servicequotas/api_op_DeleteServiceQuotaIncreaseRequestFromTemplate.go b/service/servicequotas/api_op_DeleteServiceQuotaIncreaseRequestFromTemplate.go index b1e9ab4b38e..c681896f26f 100644 --- a/service/servicequotas/api_op_DeleteServiceQuotaIncreaseRequestFromTemplate.go +++ b/service/servicequotas/api_op_DeleteServiceQuotaIncreaseRequestFromTemplate.go @@ -56,6 +56,11 @@ func (c *Client) DeleteServiceQuotaIncreaseRequestFromTemplate(ctx context.Conte type DeleteServiceQuotaIncreaseRequestFromTemplateInput struct { + // Specifies the AWS Region for the quota that you want to delete. + // + // This member is required. + AwsRegion *string + // Specifies the code for the quota that you want to delete. // // This member is required. @@ -65,11 +70,6 @@ type DeleteServiceQuotaIncreaseRequestFromTemplateInput struct { // // This member is required. ServiceCode *string - - // Specifies the AWS Region for the quota that you want to delete. - // - // This member is required. - AwsRegion *string } type DeleteServiceQuotaIncreaseRequestFromTemplateOutput struct { diff --git a/service/servicequotas/api_op_GetServiceQuota.go b/service/servicequotas/api_op_GetServiceQuota.go index 79c1449af9e..a84e0391c61 100644 --- a/service/servicequotas/api_op_GetServiceQuota.go +++ b/service/servicequotas/api_op_GetServiceQuota.go @@ -60,15 +60,15 @@ func (c *Client) GetServiceQuota(ctx context.Context, params *GetServiceQuotaInp type GetServiceQuotaInput struct { - // Specifies the service that you want to use. + // Identifies the service quota you want to select. // // This member is required. - ServiceCode *string + QuotaCode *string - // Identifies the service quota you want to select. + // Specifies the service that you want to use. // // This member is required. - QuotaCode *string + ServiceCode *string } type GetServiceQuotaOutput struct { diff --git a/service/servicequotas/api_op_GetServiceQuotaIncreaseRequestFromTemplate.go b/service/servicequotas/api_op_GetServiceQuotaIncreaseRequestFromTemplate.go index f4d7ca1fd16..1ccd5ade87a 100644 --- a/service/servicequotas/api_op_GetServiceQuotaIncreaseRequestFromTemplate.go +++ b/service/servicequotas/api_op_GetServiceQuotaIncreaseRequestFromTemplate.go @@ -57,15 +57,15 @@ func (c *Client) GetServiceQuotaIncreaseRequestFromTemplate(ctx context.Context, type GetServiceQuotaIncreaseRequestFromTemplateInput struct { - // Specifies the quota you want. + // Specifies the AWS Region for the quota that you want to use. // // This member is required. - QuotaCode *string + AwsRegion *string - // Specifies the AWS Region for the quota that you want to use. + // Specifies the quota you want. // // This member is required. - AwsRegion *string + QuotaCode *string // Specifies the service that you want to use. // diff --git a/service/servicequotas/api_op_ListAWSDefaultServiceQuotas.go b/service/servicequotas/api_op_ListAWSDefaultServiceQuotas.go index b05fe7a6ab9..dcbe4755a28 100644 --- a/service/servicequotas/api_op_ListAWSDefaultServiceQuotas.go +++ b/service/servicequotas/api_op_ListAWSDefaultServiceQuotas.go @@ -67,6 +67,11 @@ func (c *Client) ListAWSDefaultServiceQuotas(ctx context.Context, params *ListAW type ListAWSDefaultServiceQuotasInput struct { + // Specifies the service that you want to use. + // + // This member is required. + ServiceCode *string + // (Optional) Limits the number of results that you want to include in the // response. If you don't include this parameter, the response defaults to a value // that's specific to the operation. If additional items exist beyond the specified @@ -85,24 +90,19 @@ type ListAWSDefaultServiceQuotasInput struct { // to the operation to get the next part of the results. You should check NextToken // after every operation to ensure that you receive all of the results. NextToken *string - - // Specifies the service that you want to use. - // - // This member is required. - ServiceCode *string } type ListAWSDefaultServiceQuotasOutput struct { - // A list of the quotas in the account with the AWS default values. - Quotas []*types.ServiceQuota - // (Optional) Use this parameter in a request if you receive a NextToken response // in a previous request that indicates that there's more output available. In a // subsequent call, set it to the value of the previous call's NextToken response // to indicate where the output should continue from. NextToken *string + // A list of the quotas in the account with the AWS default values. + Quotas []*types.ServiceQuota + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/servicequotas/api_op_ListRequestedServiceQuotaChangeHistory.go b/service/servicequotas/api_op_ListRequestedServiceQuotaChangeHistory.go index 0b70df5ce6e..18325011456 100644 --- a/service/servicequotas/api_op_ListRequestedServiceQuotaChangeHistory.go +++ b/service/servicequotas/api_op_ListRequestedServiceQuotaChangeHistory.go @@ -56,18 +56,6 @@ func (c *Client) ListRequestedServiceQuotaChangeHistory(ctx context.Context, par type ListRequestedServiceQuotaChangeHistoryInput struct { - // Specifies the status value of the quota increase request. - Status types.RequestStatus - - // Specifies the service that you want to use. - ServiceCode *string - - // (Optional) Use this parameter in a request if you receive a NextToken response - // in a previous request that indicates that there's more output available. In a - // subsequent call, set it to the value of the previous call's NextToken response - // to indicate where the output should continue from. - NextToken *string - // (Optional) Limits the number of results that you want to include in the // response. If you don't include this parameter, the response defaults to a value // that's specific to the operation. If additional items exist beyond the specified @@ -76,6 +64,18 @@ type ListRequestedServiceQuotaChangeHistoryInput struct { // get the next part of the results. You should check NextToken after every // operation to ensure that you receive all of the results. MaxResults *int32 + + // (Optional) Use this parameter in a request if you receive a NextToken response + // in a previous request that indicates that there's more output available. In a + // subsequent call, set it to the value of the previous call's NextToken response + // to indicate where the output should continue from. + NextToken *string + + // Specifies the service that you want to use. + ServiceCode *string + + // Specifies the status value of the quota increase request. + Status types.RequestStatus } type ListRequestedServiceQuotaChangeHistoryOutput struct { diff --git a/service/servicequotas/api_op_ListRequestedServiceQuotaChangeHistoryByQuota.go b/service/servicequotas/api_op_ListRequestedServiceQuotaChangeHistoryByQuota.go index 7143586793a..c91ed95daa2 100644 --- a/service/servicequotas/api_op_ListRequestedServiceQuotaChangeHistoryByQuota.go +++ b/service/servicequotas/api_op_ListRequestedServiceQuotaChangeHistoryByQuota.go @@ -60,18 +60,15 @@ func (c *Client) ListRequestedServiceQuotaChangeHistoryByQuota(ctx context.Conte type ListRequestedServiceQuotaChangeHistoryByQuotaInput struct { - // Specifies the service that you want to use. + // Specifies the service quota that you want to use // // This member is required. - ServiceCode *string - - // Specifies the status value of the quota increase request. - Status types.RequestStatus + QuotaCode *string - // Specifies the service quota that you want to use + // Specifies the service that you want to use. // // This member is required. - QuotaCode *string + ServiceCode *string // (Optional) Limits the number of results that you want to include in the // response. If you don't include this parameter, the response defaults to a value @@ -87,6 +84,9 @@ type ListRequestedServiceQuotaChangeHistoryByQuotaInput struct { // subsequent call, set it to the value of the previous call's NextToken response // to indicate where the output should continue from. NextToken *string + + // Specifies the status value of the quota increase request. + Status types.RequestStatus } type ListRequestedServiceQuotaChangeHistoryByQuotaOutput struct { diff --git a/service/servicequotas/api_op_ListServiceQuotaIncreaseRequestsInTemplate.go b/service/servicequotas/api_op_ListServiceQuotaIncreaseRequestsInTemplate.go index 98c88a5a704..005a0795826 100644 --- a/service/servicequotas/api_op_ListServiceQuotaIncreaseRequestsInTemplate.go +++ b/service/servicequotas/api_op_ListServiceQuotaIncreaseRequestsInTemplate.go @@ -56,6 +56,9 @@ func (c *Client) ListServiceQuotaIncreaseRequestsInTemplate(ctx context.Context, type ListServiceQuotaIncreaseRequestsInTemplateInput struct { + // Specifies the AWS Region for the quota that you want to use. + AwsRegion *string + // (Optional) Limits the number of results that you want to include in the // response. If you don't include this parameter, the response defaults to a value // that's specific to the operation. If additional items exist beyond the specified @@ -71,9 +74,6 @@ type ListServiceQuotaIncreaseRequestsInTemplateInput struct { // to indicate where the output should continue from. NextToken *string - // Specifies the AWS Region for the quota that you want to use. - AwsRegion *string - // The identifier for a service. When performing an operation, use the ServiceCode // to specify a particular service. ServiceCode *string diff --git a/service/servicequotas/api_op_ListServiceQuotas.go b/service/servicequotas/api_op_ListServiceQuotas.go index 842f2e38c17..f43d0f63690 100644 --- a/service/servicequotas/api_op_ListServiceQuotas.go +++ b/service/servicequotas/api_op_ListServiceQuotas.go @@ -64,12 +64,6 @@ func (c *Client) ListServiceQuotas(ctx context.Context, params *ListServiceQuota type ListServiceQuotasInput struct { - // (Optional) Use this parameter in a request if you receive a NextToken response - // in a previous request that indicates that there's more output available. In a - // subsequent call, set it to the value of the previous call's NextToken response - // to indicate where the output should continue from. - NextToken *string - // The identifier for a service. When performing an operation, use the ServiceCode // to specify a particular service. // @@ -84,6 +78,12 @@ type ListServiceQuotasInput struct { // get the next part of the results. You should check NextToken after every // operation to ensure that you receive all of the results. MaxResults *int32 + + // (Optional) Use this parameter in a request if you receive a NextToken response + // in a previous request that indicates that there's more output available. In a + // subsequent call, set it to the value of the previous call's NextToken response + // to indicate where the output should continue from. + NextToken *string } type ListServiceQuotasOutput struct { diff --git a/service/servicequotas/api_op_ListServices.go b/service/servicequotas/api_op_ListServices.go index 08edbe55542..9fbb59fb488 100644 --- a/service/servicequotas/api_op_ListServices.go +++ b/service/servicequotas/api_op_ListServices.go @@ -58,12 +58,6 @@ func (c *Client) ListServices(ctx context.Context, params *ListServicesInput, op type ListServicesInput struct { - // (Optional) Use this parameter in a request if you receive a NextToken response - // in a previous request that indicates that there's more output available. In a - // subsequent call, set it to the value of the previous call's NextToken response - // to indicate where the output should continue from. - NextToken *string - // (Optional) Limits the number of results that you want to include in the // response. If you don't include this parameter, the response defaults to a value // that's specific to the operation. If additional items exist beyond the specified @@ -72,13 +66,16 @@ type ListServicesInput struct { // get the next part of the results. You should check NextToken after every // operation to ensure that you receive all of the results. MaxResults *int32 + + // (Optional) Use this parameter in a request if you receive a NextToken response + // in a previous request that indicates that there's more output available. In a + // subsequent call, set it to the value of the previous call's NextToken response + // to indicate where the output should continue from. + NextToken *string } type ListServicesOutput struct { - // Returns a list of services. - Services []*types.ServiceInfo - // If present in the response, this value indicates there's more output available // that what's included in the current response. This can occur even when the // response includes no values at all, such as when you ask for a filtered view of @@ -88,6 +85,9 @@ type ListServicesOutput struct { // back empty (as null). NextToken *string + // Returns a list of services. + Services []*types.ServiceInfo + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/servicequotas/api_op_PutServiceQuotaIncreaseRequestIntoTemplate.go b/service/servicequotas/api_op_PutServiceQuotaIncreaseRequestIntoTemplate.go index 531fbde8bd9..f0889695b38 100644 --- a/service/servicequotas/api_op_PutServiceQuotaIncreaseRequestIntoTemplate.go +++ b/service/servicequotas/api_op_PutServiceQuotaIncreaseRequestIntoTemplate.go @@ -61,25 +61,25 @@ func (c *Client) PutServiceQuotaIncreaseRequestIntoTemplate(ctx context.Context, type PutServiceQuotaIncreaseRequestIntoTemplateInput struct { - // Specifies the new, increased value for the quota. - // - // This member is required. - DesiredValue *float64 - // Specifies the AWS Region for the quota. // // This member is required. AwsRegion *string - // Specifies the service that you want to use. + // Specifies the new, increased value for the quota. // // This member is required. - ServiceCode *string + DesiredValue *float64 // Specifies the service quota that you want to use. // // This member is required. QuotaCode *string + + // Specifies the service that you want to use. + // + // This member is required. + ServiceCode *string } type PutServiceQuotaIncreaseRequestIntoTemplateOutput struct { diff --git a/service/servicequotas/api_op_RequestServiceQuotaIncrease.go b/service/servicequotas/api_op_RequestServiceQuotaIncrease.go index f2fbff8bae5..430572fb024 100644 --- a/service/servicequotas/api_op_RequestServiceQuotaIncrease.go +++ b/service/servicequotas/api_op_RequestServiceQuotaIncrease.go @@ -63,15 +63,15 @@ type RequestServiceQuotaIncreaseInput struct { // This member is required. DesiredValue *float64 - // Specifies the service that you want to use. + // Specifies the service quota that you want to use. // // This member is required. - ServiceCode *string + QuotaCode *string - // Specifies the service quota that you want to use. + // Specifies the service that you want to use. // // This member is required. - QuotaCode *string + ServiceCode *string } type RequestServiceQuotaIncreaseOutput struct { diff --git a/service/servicequotas/go.mod b/service/servicequotas/go.mod index 22bce14fcc4..34cc3707945 100644 --- a/service/servicequotas/go.mod +++ b/service/servicequotas/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/servicequotas go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/servicequotas/types/types.go b/service/servicequotas/types/types.go index 7e09d497863..f045241be9c 100644 --- a/service/servicequotas/types/types.go +++ b/service/servicequotas/types/types.go @@ -26,10 +26,6 @@ type ErrorReason struct { // A structure that uses CloudWatch metrics to gather data about the service quota. type MetricInfo struct { - // The namespace of the metric. The namespace is a container for CloudWatch - // metrics. You can specify a name for the namespace when you create a metric. - MetricNamespace *string - // A dimension is a name/value pair that is part of the identity of a metric. Every // metric has specific characteristics that describe it, and you can think of // dimensions as categories for those characteristics. These dimensions are part of @@ -37,14 +33,18 @@ type MetricInfo struct { // quota. MetricDimensions map[string]*string + // The name of the CloudWatch metric that measures usage of a service quota. This + // is a required field. + MetricName *string + + // The namespace of the metric. The namespace is a container for CloudWatch + // metrics. You can specify a name for the namespace when you create a metric. + MetricNamespace *string + // Statistics are metric data aggregations over specified periods of time. This is // the recommended statistic to use when comparing usage in the CloudWatch Metric // against your Service Quota. MetricStatisticRecommendation *string - - // The name of the CloudWatch metric that measures usage of a service quota. This - // is a required field. - MetricName *string } // A structure that contains information about the quota period. @@ -60,49 +60,49 @@ type QuotaPeriod struct { // A structure that contains information about a requested change for a quota. type RequestedServiceQuotaChange struct { - // The IAM identity who submitted the service quota increase request. - Requester *string - - // The name of the AWS service specified in the increase request. - ServiceName *string + // The case Id for the service quota increase request. + CaseId *string - // Specifies the service that you want to use. - ServiceCode *string + // The date and time when the service quota increase request was received and the + // case Id was created. + Created *time.Time - // Name of the service quota. - QuotaName *string + // New increased value for the service quota. + DesiredValue *float64 - // The Amazon Resource Name (ARN) of the service quota. - QuotaArn *string + // Identifies if the quota is global. + GlobalQuota *bool // The unique identifier of a requested service quota change. Id *string - // New increased value for the service quota. - DesiredValue *float64 - - // Specifies the unit used for the quota. - Unit *string - - // State of the service quota increase request. - Status RequestStatus + // The date and time of the most recent change in the service quota increase + // request. + LastUpdated *time.Time - // The date and time when the service quota increase request was received and the - // case Id was created. - Created *time.Time + // The Amazon Resource Name (ARN) of the service quota. + QuotaArn *string // Specifies the service quota that you want to use. QuotaCode *string - // Identifies if the quota is global. - GlobalQuota *bool + // Name of the service quota. + QuotaName *string - // The date and time of the most recent change in the service quota increase - // request. - LastUpdated *time.Time + // The IAM identity who submitted the service quota increase request. + Requester *string - // The case Id for the service quota increase request. - CaseId *string + // Specifies the service that you want to use. + ServiceCode *string + + // The name of the AWS service specified in the increase request. + ServiceName *string + + // State of the service quota increase request. + Status RequestStatus + + // Specifies the unit used for the quota. + Unit *string } // A structure that contains the ServiceName and ServiceCode. It does not include @@ -110,27 +110,21 @@ type RequestedServiceQuotaChange struct { // () operation. type ServiceInfo struct { - // The name of the AWS service specified in the increase request. - ServiceName *string - // Specifies the service that you want to use. ServiceCode *string + + // The name of the AWS service specified in the increase request. + ServiceName *string } // A structure that contains the full set of details that define the service quota. type ServiceQuota struct { - // The unit of measurement for the value of the service quota. - Unit *string - // Specifies if the quota value can be increased. Adjustable *bool - // The value of service quota. - Value *float64 - - // The code identifier for the service quota specified. - QuotaCode *string + // Specifies the ErrorCode and ErrorMessage when success isn't achieved. + ErrorReason *ErrorReason // Specifies if the quota is global. GlobalQuota *bool @@ -138,50 +132,56 @@ type ServiceQuota struct { // Identifies the unit and value of how time is measured. Period *QuotaPeriod - // Specifies the ErrorCode and ErrorMessage when success isn't achieved. - ErrorReason *ErrorReason - - // The name of the AWS service specified in the increase request. - ServiceName *string - // The Amazon Resource Name (ARN) of the service quota. QuotaArn *string + // The code identifier for the service quota specified. + QuotaCode *string + + // The name identifier of the service quota. + QuotaName *string + // Specifies the service that you want to use. ServiceCode *string + // The name of the AWS service specified in the increase request. + ServiceName *string + + // The unit of measurement for the value of the service quota. + Unit *string + // Specifies the details about the measurement. UsageMetric *MetricInfo - // The name identifier of the service quota. - QuotaName *string + // The value of service quota. + Value *float64 } // A structure that contains information about one service quota increase request. type ServiceQuotaIncreaseRequestInTemplate struct { - // The code identifier for the service quota specified in the increase request. - QuotaCode *string - - // Specifies if the quota is a global quota. - GlobalQuota *bool - // The AWS Region where the increase request occurs. AwsRegion *string - // The name of the AWS service specified in the increase request. - ServiceName *string - // Identifies the new, increased value of the service quota in the increase // request. DesiredValue *float64 - // The code identifier for the AWS service specified in the increase request. - ServiceCode *string + // Specifies if the quota is a global quota. + GlobalQuota *bool + + // The code identifier for the service quota specified in the increase request. + QuotaCode *string // The name of the service quota in the increase request. QuotaName *string + // The code identifier for the AWS service specified in the increase request. + ServiceCode *string + + // The name of the AWS service specified in the increase request. + ServiceName *string + // The unit of measure for the increase request. Unit *string } diff --git a/service/ses/api_op_CloneReceiptRuleSet.go b/service/ses/api_op_CloneReceiptRuleSet.go index a57ab972db3..b3956959193 100644 --- a/service/ses/api_op_CloneReceiptRuleSet.go +++ b/service/ses/api_op_CloneReceiptRuleSet.go @@ -65,6 +65,11 @@ func (c *Client) CloneReceiptRuleSet(ctx context.Context, params *CloneReceiptRu // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). type CloneReceiptRuleSetInput struct { + // The name of the rule set to clone. + // + // This member is required. + OriginalRuleSetName *string + // The name of the rule set to create. The name must: // // * This value can only @@ -78,11 +83,6 @@ type CloneReceiptRuleSetInput struct { // // This member is required. RuleSetName *string - - // The name of the rule set to clone. - // - // This member is required. - OriginalRuleSetName *string } // An empty element returned on a successful request. diff --git a/service/ses/api_op_CreateConfigurationSetEventDestination.go b/service/ses/api_op_CreateConfigurationSetEventDestination.go index 4107bd9fa07..403846f9755 100644 --- a/service/ses/api_op_CreateConfigurationSetEventDestination.go +++ b/service/ses/api_op_CreateConfigurationSetEventDestination.go @@ -71,17 +71,17 @@ func (c *Client) CreateConfigurationSetEventDestination(ctx context.Context, par // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). type CreateConfigurationSetEventDestinationInput struct { - // An object that describes the AWS service that email sending event information - // will be published to. - // - // This member is required. - EventDestination *types.EventDestination - // The name of the configuration set that the event destination should be // associated with. // // This member is required. ConfigurationSetName *string + + // An object that describes the AWS service that email sending event information + // will be published to. + // + // This member is required. + EventDestination *types.EventDestination } // An empty element returned on a successful request. diff --git a/service/ses/api_op_CreateCustomVerificationEmailTemplate.go b/service/ses/api_op_CreateCustomVerificationEmailTemplate.go index 498ec248c4c..94e5b39804e 100644 --- a/service/ses/api_op_CreateCustomVerificationEmailTemplate.go +++ b/service/ses/api_op_CreateCustomVerificationEmailTemplate.go @@ -62,41 +62,41 @@ func (c *Client) CreateCustomVerificationEmailTemplate(ctx context.Context, para // Represents a request to create a custom verification email template. type CreateCustomVerificationEmailTemplateInput struct { - // The content of the custom verification email. The total size of the email must - // be less than 10 MB. The message body may contain HTML, with some limitations. - // For more information, see Custom Verification Email Frequently Asked Questions - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html#custom-verification-emails-faq) - // in the Amazon SES Developer Guide. + // The URL that the recipient of the verification email is sent to if his or her + // address is not successfully verified. // // This member is required. - TemplateContent *string + FailureRedirectionURL *string - // The subject line of the custom verification email. + // The email address that the custom verification email is sent from. // // This member is required. - TemplateSubject *string + FromEmailAddress *string // The URL that the recipient of the verification email is sent to if his or her - // address is not successfully verified. + // address is successfully verified. // // This member is required. - FailureRedirectionURL *string + SuccessRedirectionURL *string - // The name of the custom verification email template. + // The content of the custom verification email. The total size of the email must + // be less than 10 MB. The message body may contain HTML, with some limitations. + // For more information, see Custom Verification Email Frequently Asked Questions + // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html#custom-verification-emails-faq) + // in the Amazon SES Developer Guide. // // This member is required. - TemplateName *string + TemplateContent *string - // The email address that the custom verification email is sent from. + // The name of the custom verification email template. // // This member is required. - FromEmailAddress *string + TemplateName *string - // The URL that the recipient of the verification email is sent to if his or her - // address is successfully verified. + // The subject line of the custom verification email. // // This member is required. - SuccessRedirectionURL *string + TemplateSubject *string } type CreateCustomVerificationEmailTemplateOutput struct { diff --git a/service/ses/api_op_CreateReceiptRule.go b/service/ses/api_op_CreateReceiptRule.go index 4624a76e06e..bad1be06c0a 100644 --- a/service/ses/api_op_CreateReceiptRule.go +++ b/service/ses/api_op_CreateReceiptRule.go @@ -63,11 +63,6 @@ func (c *Client) CreateReceiptRule(ctx context.Context, params *CreateReceiptRul // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). type CreateReceiptRuleInput struct { - // The name of an existing rule after which the new rule will be placed. If this - // parameter is null, the new rule will be inserted at the beginning of the rule - // list. - After *string - // A data structure that contains the specified rule's name, actions, recipients, // domains, enabled status, scan status, and TLS policy. // @@ -78,6 +73,11 @@ type CreateReceiptRuleInput struct { // // This member is required. RuleSetName *string + + // The name of an existing rule after which the new rule will be placed. If this + // parameter is null, the new rule will be inserted at the beginning of the rule + // list. + After *string } // An empty element returned on a successful request. diff --git a/service/ses/api_op_DescribeConfigurationSet.go b/service/ses/api_op_DescribeConfigurationSet.go index 4b19b9e69c8..4b8f2e70530 100644 --- a/service/ses/api_op_DescribeConfigurationSet.go +++ b/service/ses/api_op_DescribeConfigurationSet.go @@ -79,23 +79,23 @@ type DescribeConfigurationSetInput struct { // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). type DescribeConfigurationSetOutput struct { - // An object that represents the reputation settings for the configuration set. - ReputationOptions *types.ReputationOptions - - // The name of the custom open and click tracking domain associated with the - // configuration set. - TrackingOptions *types.TrackingOptions - // The configuration set object associated with the specified configuration set. ConfigurationSet *types.ConfigurationSet - // A list of event destinations associated with the configuration set. - EventDestinations []*types.EventDestination - // Specifies whether messages that use the configuration set are required to use // Transport Layer Security (TLS). DeliveryOptions *types.DeliveryOptions + // A list of event destinations associated with the configuration set. + EventDestinations []*types.EventDestination + + // An object that represents the reputation settings for the configuration set. + ReputationOptions *types.ReputationOptions + + // The name of the custom open and click tracking domain associated with the + // configuration set. + TrackingOptions *types.TrackingOptions + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ses/api_op_GetCustomVerificationEmailTemplate.go b/service/ses/api_op_GetCustomVerificationEmailTemplate.go index 6bba42ae1be..0ef4df1bbbd 100644 --- a/service/ses/api_op_GetCustomVerificationEmailTemplate.go +++ b/service/ses/api_op_GetCustomVerificationEmailTemplate.go @@ -71,13 +71,13 @@ type GetCustomVerificationEmailTemplateInput struct { // The content of the custom verification email template. type GetCustomVerificationEmailTemplateOutput struct { - // The email address that the custom verification email is sent from. - FromEmailAddress *string - // The URL that the recipient of the verification email is sent to if his or her // address is not successfully verified. FailureRedirectionURL *string + // The email address that the custom verification email is sent from. + FromEmailAddress *string + // The URL that the recipient of the verification email is sent to if his or her // address is successfully verified. SuccessRedirectionURL *string @@ -85,12 +85,12 @@ type GetCustomVerificationEmailTemplateOutput struct { // The content of the custom verification email. TemplateContent *string - // The subject line of the custom verification email. - TemplateSubject *string - // The name of the custom verification email template. TemplateName *string + // The subject line of the custom verification email. + TemplateSubject *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ses/api_op_GetIdentityPolicies.go b/service/ses/api_op_GetIdentityPolicies.go index fbcc52e94b2..9eaf271789e 100644 --- a/service/ses/api_op_GetIdentityPolicies.go +++ b/service/ses/api_op_GetIdentityPolicies.go @@ -69,13 +69,6 @@ func (c *Client) GetIdentityPolicies(ctx context.Context, params *GetIdentityPol // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). type GetIdentityPoliciesInput struct { - // A list of the names of policies to be retrieved. You can retrieve a maximum of - // 20 policies at a time. If you do not know the names of the policies that are - // attached to the identity, you can use ListIdentityPolicies. - // - // This member is required. - PolicyNames []*string - // The identity for which the policies will be retrieved. You can specify an // identity by using its name or by using its Amazon Resource Name (ARN). Examples: // user@example.com, example.com, @@ -84,6 +77,13 @@ type GetIdentityPoliciesInput struct { // // This member is required. Identity *string + + // A list of the names of policies to be retrieved. You can retrieve a maximum of + // 20 policies at a time. If you do not know the names of the policies that are + // attached to the identity, you can use ListIdentityPolicies. + // + // This member is required. + PolicyNames []*string } // Represents the requested sending authorization policies. diff --git a/service/ses/api_op_GetSendQuota.go b/service/ses/api_op_GetSendQuota.go index b6f7471e99d..d764174554e 100644 --- a/service/ses/api_op_GetSendQuota.go +++ b/service/ses/api_op_GetSendQuota.go @@ -61,9 +61,6 @@ type GetSendQuotaInput struct { // number of emails you have sent in the last 24 hours. type GetSendQuotaOutput struct { - // The number of emails sent during the previous 24 hours. - SentLast24Hours *float64 - // The maximum number of emails the user is allowed to send in a 24-hour interval. // A value of -1 signifies an unlimited quota. Max24HourSend *float64 @@ -73,6 +70,9 @@ type GetSendQuotaOutput struct { // less than the maximum send rate. MaxSendRate *float64 + // The number of emails sent during the previous 24 hours. + SentLast24Hours *float64 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ses/api_op_ListConfigurationSets.go b/service/ses/api_op_ListConfigurationSets.go index 872b45581b4..299020a2f5c 100644 --- a/service/ses/api_op_ListConfigurationSets.go +++ b/service/ses/api_op_ListConfigurationSets.go @@ -69,12 +69,12 @@ func (c *Client) ListConfigurationSets(ctx context.Context, params *ListConfigur // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). type ListConfigurationSetsInput struct { + // The number of configuration sets to return. + MaxItems *int32 + // A token returned from a previous call to ListConfigurationSets to indicate the // position of the configuration set in the configuration set list. NextToken *string - - // The number of configuration sets to return. - MaxItems *int32 } // A list of configuration sets associated with your AWS account. Configuration diff --git a/service/ses/api_op_ListCustomVerificationEmailTemplates.go b/service/ses/api_op_ListCustomVerificationEmailTemplates.go index 66db05a907b..089c085fa07 100644 --- a/service/ses/api_op_ListCustomVerificationEmailTemplates.go +++ b/service/ses/api_op_ListCustomVerificationEmailTemplates.go @@ -66,15 +66,15 @@ func (c *Client) ListCustomVerificationEmailTemplates(ctx context.Context, param // in the Amazon SES Developer Guide. type ListCustomVerificationEmailTemplatesInput struct { - // An array the contains the name and creation time stamp for each template in your - // Amazon SES account. - NextToken *string - // The maximum number of custom verification email templates to return. This value // must be at least 1 and less than or equal to 50. If you do not specify a value, // or if you specify a value less than 1 or greater than 50, the operation will // return up to 50 results. MaxResults *int32 + + // An array the contains the name and creation time stamp for each template in your + // Amazon SES account. + NextToken *string } // A paginated list of custom verification email templates. diff --git a/service/ses/api_op_ListIdentities.go b/service/ses/api_op_ListIdentities.go index 855f9ca8088..2235380cb7c 100644 --- a/service/ses/api_op_ListIdentities.go +++ b/service/ses/api_op_ListIdentities.go @@ -61,13 +61,13 @@ func (c *Client) ListIdentities(ctx context.Context, params *ListIdentitiesInput // verification status. type ListIdentitiesInput struct { - // The maximum number of identities per page. Possible values are 1-1000 inclusive. - MaxItems *int32 - // The type of the identities to list. Possible values are "EmailAddress" and // "Domain". If this parameter is omitted, then all identities will be listed. IdentityType types.IdentityType + // The maximum number of identities per page. Possible values are 1-1000 inclusive. + MaxItems *int32 + // The token to use for pagination. NextToken *string } @@ -76,14 +76,14 @@ type ListIdentitiesInput struct { // account, regardless of verification status. type ListIdentitiesOutput struct { - // The token used for pagination. - NextToken *string - // A list of identities. // // This member is required. Identities []*string + // The token used for pagination. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ses/api_op_ListReceiptRuleSets.go b/service/ses/api_op_ListReceiptRuleSets.go index fe28614c3e6..c071c7f2203 100644 --- a/service/ses/api_op_ListReceiptRuleSets.go +++ b/service/ses/api_op_ListReceiptRuleSets.go @@ -74,15 +74,15 @@ type ListReceiptRuleSetsInput struct { // A list of receipt rule sets that exist under your AWS account. type ListReceiptRuleSetsOutput struct { - // The metadata for the currently active receipt rule set. The metadata consists of - // the rule set name and the timestamp of when the rule set was created. - RuleSets []*types.ReceiptRuleSetMetadata - // A token indicating that there are additional receipt rule sets available to be // listed. Pass this token to successive calls of ListReceiptRuleSets to retrieve // up to 100 receipt rule sets at a time. NextToken *string + // The metadata for the currently active receipt rule set. The metadata consists of + // the rule set name and the timestamp of when the rule set was created. + RuleSets []*types.ReceiptRuleSetMetadata + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ses/api_op_ListTemplates.go b/service/ses/api_op_ListTemplates.go index 236ae52d112..508f0223ace 100644 --- a/service/ses/api_op_ListTemplates.go +++ b/service/ses/api_op_ListTemplates.go @@ -57,28 +57,28 @@ func (c *Client) ListTemplates(ctx context.Context, params *ListTemplatesInput, type ListTemplatesInput struct { - // A token returned from a previous call to ListTemplates to indicate the position - // in the list of email templates. - NextToken *string - // The maximum number of templates to return. This value must be at least 1 and // less than or equal to 10. If you do not specify a value, or if you specify a // value less than 1 or greater than 10, the operation will return up to 10 // results. MaxItems *int32 + + // A token returned from a previous call to ListTemplates to indicate the position + // in the list of email templates. + NextToken *string } type ListTemplatesOutput struct { - // An array the contains the name and creation time stamp for each template in your - // Amazon SES account. - TemplatesMetadata []*types.TemplateMetadata - // A token indicating that there are additional email templates available to be // listed. Pass this token to a subsequent call to ListTemplates to retrieve the // next 50 email templates. NextToken *string + // An array the contains the name and creation time stamp for each template in your + // Amazon SES account. + TemplatesMetadata []*types.TemplateMetadata + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ses/api_op_PutConfigurationSetDeliveryOptions.go b/service/ses/api_op_PutConfigurationSetDeliveryOptions.go index 515d04f53e3..d38256876d3 100644 --- a/service/ses/api_op_PutConfigurationSetDeliveryOptions.go +++ b/service/ses/api_op_PutConfigurationSetDeliveryOptions.go @@ -58,15 +58,15 @@ func (c *Client) PutConfigurationSetDeliveryOptions(ctx context.Context, params // A request to modify the delivery options for a configuration set. type PutConfigurationSetDeliveryOptionsInput struct { - // Specifies whether messages that use the configuration set are required to use - // Transport Layer Security (TLS). - DeliveryOptions *types.DeliveryOptions - // The name of the configuration set that you want to specify the delivery options // for. // // This member is required. ConfigurationSetName *string + + // Specifies whether messages that use the configuration set are required to use + // Transport Layer Security (TLS). + DeliveryOptions *types.DeliveryOptions } // An HTTP 200 response if the request succeeds, or an error message if the request diff --git a/service/ses/api_op_PutIdentityPolicy.go b/service/ses/api_op_PutIdentityPolicy.go index 929298d1b67..5190d66fa43 100644 --- a/service/ses/api_op_PutIdentityPolicy.go +++ b/service/ses/api_op_PutIdentityPolicy.go @@ -68,6 +68,14 @@ func (c *Client) PutIdentityPolicy(ctx context.Context, params *PutIdentityPolic // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). type PutIdentityPolicyInput struct { + // The identity that the policy will apply to. You can specify an identity by using + // its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, + // example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. To + // successfully call this API, you must own the identity. + // + // This member is required. + Identity *string + // The text of the policy in JSON format. The policy cannot exceed 4 KB. For // information about the syntax of sending authorization policies, see the Amazon // SES Developer Guide @@ -81,14 +89,6 @@ type PutIdentityPolicyInput struct { // // This member is required. PolicyName *string - - // The identity that the policy will apply to. You can specify an identity by using - // its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, - // example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. To - // successfully call this API, you must own the identity. - // - // This member is required. - Identity *string } // An empty element returned on a successful request. diff --git a/service/ses/api_op_ReorderReceiptRuleSet.go b/service/ses/api_op_ReorderReceiptRuleSet.go index cd2397da2d8..32774664bb1 100644 --- a/service/ses/api_op_ReorderReceiptRuleSet.go +++ b/service/ses/api_op_ReorderReceiptRuleSet.go @@ -65,16 +65,16 @@ func (c *Client) ReorderReceiptRuleSet(ctx context.Context, params *ReorderRecei // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). type ReorderReceiptRuleSetInput struct { - // The name of the receipt rule set to reorder. - // - // This member is required. - RuleSetName *string - // A list of the specified receipt rule set's receipt rules in the order that you // want to put them. // // This member is required. RuleNames []*string + + // The name of the receipt rule set to reorder. + // + // This member is required. + RuleSetName *string } // An empty element returned on a successful request. diff --git a/service/ses/api_op_SendBounce.go b/service/ses/api_op_SendBounce.go index 2146bd67c33..e619c94a160 100644 --- a/service/ses/api_op_SendBounce.go +++ b/service/ses/api_op_SendBounce.go @@ -65,14 +65,6 @@ func (c *Client) SendBounce(ctx context.Context, params *SendBounceInput, optFns // received through Amazon SES. type SendBounceInput struct { - // The message ID of the message to be bounced. - // - // This member is required. - OriginalMessageId *string - - // Message-related DSN fields. If not specified, Amazon SES will choose the values. - MessageDsn *types.MessageDsn - // The address to use in the "From" header of the bounce message. This must be an // identity that you have verified with Amazon SES. // @@ -86,10 +78,10 @@ type SendBounceInput struct { // This member is required. BouncedRecipientInfoList []*types.BouncedRecipientInfo - // Human-readable text for the bounce message to explain the failure. If not - // specified, the text will be auto-generated based on the bounced recipient - // information. - Explanation *string + // The message ID of the message to be bounced. + // + // This member is required. + OriginalMessageId *string // This parameter is used only for sending authorization. It is the ARN of the // identity that is associated with the sending authorization policy that permits @@ -97,6 +89,14 @@ type SendBounceInput struct { // about sending authorization, see the Amazon SES Developer Guide // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). BounceSenderArn *string + + // Human-readable text for the bounce message to explain the failure. If not + // specified, the text will be auto-generated based on the bounced recipient + // information. + Explanation *string + + // Message-related DSN fields. If not specified, Amazon SES will choose the values. + MessageDsn *types.MessageDsn } // Represents a unique message ID. diff --git a/service/ses/api_op_SendBulkTemplatedEmail.go b/service/ses/api_op_SendBulkTemplatedEmail.go index 13ab95c8397..b627f37699c 100644 --- a/service/ses/api_op_SendBulkTemplatedEmail.go +++ b/service/ses/api_op_SendBulkTemplatedEmail.go @@ -95,50 +95,6 @@ func (c *Client) SendBulkTemplatedEmail(ctx context.Context, params *SendBulkTem // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html). type SendBulkTemplatedEmailInput struct { - // The ARN of the template to use when sending this email. - TemplateArn *string - - // This parameter is used only for sending authorization. It is the ARN of the - // identity that is associated with the sending authorization policy that permits - // you to use the email address specified in the ReturnPath parameter. For example, - // if the owner of example.com (which has ARN - // arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it - // that authorizes you to use feedback@example.com, then you would specify the - // ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and - // the ReturnPath to be feedback@example.com. For more information about sending - // authorization, see the Amazon SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). - ReturnPathArn *string - - // The email address that bounces and complaints will be forwarded to when feedback - // forwarding is enabled. If the message cannot be delivered to the recipient, then - // an error message will be returned from the recipient's ISP; this message will - // then be forwarded to the email address specified by the ReturnPath parameter. - // The ReturnPath parameter is never overwritten. This email address must be either - // individually verified with Amazon SES, or from a domain that has been verified - // with Amazon SES. - ReturnPath *string - - // A list of replacement values to apply to the template when replacement data is - // not specified in a Destination object. These values act as a default or fallback - // option when no other data is available. The template data is a JSON object, - // typically consisting of key-value pairs in which the keys correspond to - // replacement tags in the email template. - DefaultTemplateData *string - - // The template to use when sending this email. - // - // This member is required. - Template *string - - // The name of the configuration set to use when you send an email using - // SendBulkTemplatedEmail. - ConfigurationSetName *string - - // The reply-to email address(es) for the message. If the recipient replies to the - // message, each reply-to address will receive the reply. - ReplyToAddresses []*string - // One or more Destination objects. All of the recipients in a Destination will // receive the same version of the email. You can specify up to 50 Destination // objects within a Destinations array. @@ -146,10 +102,6 @@ type SendBulkTemplatedEmailInput struct { // This member is required. Destinations []*types.BulkEmailDestination - // A list of tags, in the form of name/value pairs, to apply to an email that you - // send to a destination using SendBulkTemplatedEmail. - DefaultTags []*types.MessageTag - // The email address that is sending the email. This email address must be either // individually verified with Amazon SES, or from a domain that has been verified // with Amazon SES. For information about verifying identities, see the Amazon SES @@ -176,6 +128,51 @@ type SendBulkTemplatedEmailInput struct { // This member is required. Source *string + // The template to use when sending this email. + // + // This member is required. + Template *string + + // The name of the configuration set to use when you send an email using + // SendBulkTemplatedEmail. + ConfigurationSetName *string + + // A list of tags, in the form of name/value pairs, to apply to an email that you + // send to a destination using SendBulkTemplatedEmail. + DefaultTags []*types.MessageTag + + // A list of replacement values to apply to the template when replacement data is + // not specified in a Destination object. These values act as a default or fallback + // option when no other data is available. The template data is a JSON object, + // typically consisting of key-value pairs in which the keys correspond to + // replacement tags in the email template. + DefaultTemplateData *string + + // The reply-to email address(es) for the message. If the recipient replies to the + // message, each reply-to address will receive the reply. + ReplyToAddresses []*string + + // The email address that bounces and complaints will be forwarded to when feedback + // forwarding is enabled. If the message cannot be delivered to the recipient, then + // an error message will be returned from the recipient's ISP; this message will + // then be forwarded to the email address specified by the ReturnPath parameter. + // The ReturnPath parameter is never overwritten. This email address must be either + // individually verified with Amazon SES, or from a domain that has been verified + // with Amazon SES. + ReturnPath *string + + // This parameter is used only for sending authorization. It is the ARN of the + // identity that is associated with the sending authorization policy that permits + // you to use the email address specified in the ReturnPath parameter. For example, + // if the owner of example.com (which has ARN + // arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it + // that authorizes you to use feedback@example.com, then you would specify the + // ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and + // the ReturnPath to be feedback@example.com. For more information about sending + // authorization, see the Amazon SES Developer Guide + // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + ReturnPathArn *string + // This parameter is used only for sending authorization. It is the ARN of the // identity that is associated with the sending authorization policy that permits // you to send for the email address specified in the Source parameter. For @@ -187,6 +184,9 @@ type SendBulkTemplatedEmailInput struct { // see the Amazon SES Developer Guide // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). SourceArn *string + + // The ARN of the template to use when sending this email. + TemplateArn *string } type SendBulkTemplatedEmailOutput struct { diff --git a/service/ses/api_op_SendCustomVerificationEmail.go b/service/ses/api_op_SendCustomVerificationEmail.go index a4921bfb64a..e59083d355d 100644 --- a/service/ses/api_op_SendCustomVerificationEmail.go +++ b/service/ses/api_op_SendCustomVerificationEmail.go @@ -71,14 +71,14 @@ type SendCustomVerificationEmailInput struct { // This member is required. EmailAddress *string - // Name of a configuration set to use when sending the verification email. - ConfigurationSetName *string - // The name of the custom verification email template to use when sending the // verification email. // // This member is required. TemplateName *string + + // Name of a configuration set to use when sending the verification email. + ConfigurationSetName *string } // The response received when attempting to send the custom verification email. diff --git a/service/ses/api_op_SendEmail.go b/service/ses/api_op_SendEmail.go index d47c7bee7be..9165661a2c4 100644 --- a/service/ses/api_op_SendEmail.go +++ b/service/ses/api_op_SendEmail.go @@ -87,9 +87,15 @@ func (c *Client) SendEmail(ctx context.Context, params *SendEmailInput, optFns . // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-formatted.html). type SendEmailInput struct { - // The reply-to email address(es) for the message. If the recipient replies to the - // message, each reply-to address will receive the reply. - ReplyToAddresses []*string + // The destination for this email, composed of To:, CC:, and BCC: fields. + // + // This member is required. + Destination *types.Destination + + // The message to be sent. + // + // This member is required. + Message *types.Message // The email address that is sending the email. This email address must be either // individually verified with Amazon SES, or from a domain that has been verified @@ -117,25 +123,12 @@ type SendEmailInput struct { // This member is required. Source *string - // This parameter is used only for sending authorization. It is the ARN of the - // identity that is associated with the sending authorization policy that permits - // you to send for the email address specified in the Source parameter. For - // example, if the owner of example.com (which has ARN - // arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it - // that authorizes you to send from user@example.com, then you would specify the - // SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the - // Source to be user@example.com. For more information about sending authorization, - // see the Amazon SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). - SourceArn *string - // The name of the configuration set to use when you send an email using SendEmail. ConfigurationSetName *string - // A list of tags, in the form of name/value pairs, to apply to an email that you - // send using SendEmail. Tags correspond to characteristics of the email that you - // define, so that you can publish email sending events. - Tags []*types.MessageTag + // The reply-to email address(es) for the message. If the recipient replies to the + // message, each reply-to address will receive the reply. + ReplyToAddresses []*string // The email address that bounces and complaints will be forwarded to when feedback // forwarding is enabled. If the message cannot be delivered to the recipient, then @@ -146,11 +139,6 @@ type SendEmailInput struct { // with Amazon SES. ReturnPath *string - // The message to be sent. - // - // This member is required. - Message *types.Message - // This parameter is used only for sending authorization. It is the ARN of the // identity that is associated with the sending authorization policy that permits // you to use the email address specified in the ReturnPath parameter. For example, @@ -163,10 +151,22 @@ type SendEmailInput struct { // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). ReturnPathArn *string - // The destination for this email, composed of To:, CC:, and BCC: fields. - // - // This member is required. - Destination *types.Destination + // This parameter is used only for sending authorization. It is the ARN of the + // identity that is associated with the sending authorization policy that permits + // you to send for the email address specified in the Source parameter. For + // example, if the owner of example.com (which has ARN + // arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it + // that authorizes you to send from user@example.com, then you would specify the + // SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the + // Source to be user@example.com. For more information about sending authorization, + // see the Amazon SES Developer Guide + // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + SourceArn *string + + // A list of tags, in the form of name/value pairs, to apply to an email that you + // send using SendEmail. Tags correspond to characteristics of the email that you + // define, so that you can publish email sending events. + Tags []*types.MessageTag } // Represents a unique message ID. diff --git a/service/ses/api_op_SendRawEmail.go b/service/ses/api_op_SendRawEmail.go index 4e21fd0b8fb..21ecb1aaaf1 100644 --- a/service/ses/api_op_SendRawEmail.go +++ b/service/ses/api_op_SendRawEmail.go @@ -124,22 +124,6 @@ func (c *Client) SendRawEmail(ctx context.Context, params *SendRawEmailInput, op // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html). type SendRawEmailInput struct { - // This parameter is used only for sending authorization. It is the ARN of the - // identity that is associated with the sending authorization policy that permits - // you to send for the email address specified in the Source parameter. For - // example, if the owner of example.com (which has ARN - // arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it - // that authorizes you to send from user@example.com, then you would specify the - // SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the - // Source to be user@example.com. Instead of using this parameter, you can use the - // X-header X-SES-SOURCE-ARN in the raw message of the email. If you use both the - // SourceArn parameter and the corresponding X-header, Amazon SES uses the value of - // the SourceArn parameter. For information about when to use this parameter, see - // the description of SendRawEmail in this guide, or see the Amazon SES Developer - // Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html). - SourceArn *string - // The raw email message itself. The message has to meet the following criteria: // // @@ -173,6 +157,14 @@ type SendRawEmailInput struct { // This member is required. RawMessage *types.RawMessage + // The name of the configuration set to use when you send an email using + // SendRawEmail. + ConfigurationSetName *string + + // A list of destinations for the message, consisting of To:, CC:, and BCC: + // addresses. + Destinations []*string + // This parameter is used only for sending authorization. It is the ARN of the // identity that is associated with the sending authorization policy that permits // you to specify a particular "From" address in the header of the raw email. @@ -184,9 +176,21 @@ type SendRawEmailInput struct { // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html). FromArn *string - // A list of destinations for the message, consisting of To:, CC:, and BCC: - // addresses. - Destinations []*string + // This parameter is used only for sending authorization. It is the ARN of the + // identity that is associated with the sending authorization policy that permits + // you to use the email address specified in the ReturnPath parameter. For example, + // if the owner of example.com (which has ARN + // arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it + // that authorizes you to use feedback@example.com, then you would specify the + // ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and + // the ReturnPath to be feedback@example.com. Instead of using this parameter, you + // can use the X-header X-SES-RETURN-PATH-ARN in the raw message of the email. If + // you use both the ReturnPathArn parameter and the corresponding X-header, Amazon + // SES uses the value of the ReturnPathArn parameter. For information about when to + // use this parameter, see the description of SendRawEmail in this guide, or see + // the Amazon SES Developer Guide + // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html). + ReturnPathArn *string // The identity's email address. If you do not provide a value for this parameter, // you must specify a "From" address in the raw text of the message. (You can also @@ -208,30 +212,26 @@ type SendRawEmailInput struct { // message.

    Source *string - // A list of tags, in the form of name/value pairs, to apply to an email that you - // send using SendRawEmail. Tags correspond to characteristics of the email that - // you define, so that you can publish email sending events. - Tags []*types.MessageTag - // This parameter is used only for sending authorization. It is the ARN of the // identity that is associated with the sending authorization policy that permits - // you to use the email address specified in the ReturnPath parameter. For example, - // if the owner of example.com (which has ARN + // you to send for the email address specified in the Source parameter. For + // example, if the owner of example.com (which has ARN // arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it - // that authorizes you to use feedback@example.com, then you would specify the - // ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and - // the ReturnPath to be feedback@example.com. Instead of using this parameter, you - // can use the X-header X-SES-RETURN-PATH-ARN in the raw message of the email. If - // you use both the ReturnPathArn parameter and the corresponding X-header, Amazon - // SES uses the value of the ReturnPathArn parameter. For information about when to - // use this parameter, see the description of SendRawEmail in this guide, or see - // the Amazon SES Developer Guide + // that authorizes you to send from user@example.com, then you would specify the + // SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the + // Source to be user@example.com. Instead of using this parameter, you can use the + // X-header X-SES-SOURCE-ARN in the raw message of the email. If you use both the + // SourceArn parameter and the corresponding X-header, Amazon SES uses the value of + // the SourceArn parameter. For information about when to use this parameter, see + // the description of SendRawEmail in this guide, or see the Amazon SES Developer + // Guide // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html). - ReturnPathArn *string + SourceArn *string - // The name of the configuration set to use when you send an email using - // SendRawEmail. - ConfigurationSetName *string + // A list of tags, in the form of name/value pairs, to apply to an email that you + // send using SendRawEmail. Tags correspond to characteristics of the email that + // you define, so that you can publish email sending events. + Tags []*types.MessageTag } // Represents a unique message ID. diff --git a/service/ses/api_op_SendTemplatedEmail.go b/service/ses/api_op_SendTemplatedEmail.go index cfae10d9862..f95033f167e 100644 --- a/service/ses/api_op_SendTemplatedEmail.go +++ b/service/ses/api_op_SendTemplatedEmail.go @@ -103,9 +103,11 @@ func (c *Client) SendTemplatedEmail(ctx context.Context, params *SendTemplatedEm // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html). type SendTemplatedEmailInput struct { - // The reply-to email address(es) for the message. If the recipient replies to the - // message, each reply-to address will receive the reply. - ReplyToAddresses []*string + // The destination for this email, composed of To:, CC:, and BCC: fields. A + // Destination can include up to 50 recipients across these three fields. + // + // This member is required. + Destination *types.Destination // The email address that is sending the email. This email address must be either // individually verified with Amazon SES, or from a domain that has been verified @@ -138,17 +140,29 @@ type SendTemplatedEmailInput struct { // This member is required. Template *string + // A list of replacement values to apply to the template. This parameter is a JSON + // object, typically consisting of key-value pairs in which the keys correspond to + // replacement tags in the email template. + // + // This member is required. + TemplateData *string + // The name of the configuration set to use when you send an email using // SendTemplatedEmail. ConfigurationSetName *string - // A list of tags, in the form of name/value pairs, to apply to an email that you - // send using SendTemplatedEmail. Tags correspond to characteristics of the email - // that you define, so that you can publish email sending events. - Tags []*types.MessageTag + // The reply-to email address(es) for the message. If the recipient replies to the + // message, each reply-to address will receive the reply. + ReplyToAddresses []*string - // The ARN of the template to use when sending this email. - TemplateArn *string + // The email address that bounces and complaints will be forwarded to when feedback + // forwarding is enabled. If the message cannot be delivered to the recipient, then + // an error message will be returned from the recipient's ISP; this message will + // then be forwarded to the email address specified by the ReturnPath parameter. + // The ReturnPath parameter is never overwritten. This email address must be either + // individually verified with Amazon SES, or from a domain that has been verified + // with Amazon SES. + ReturnPath *string // This parameter is used only for sending authorization. It is the ARN of the // identity that is associated with the sending authorization policy that permits @@ -162,12 +176,6 @@ type SendTemplatedEmailInput struct { // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). ReturnPathArn *string - // The destination for this email, composed of To:, CC:, and BCC: fields. A - // Destination can include up to 50 recipients across these three fields. - // - // This member is required. - Destination *types.Destination - // This parameter is used only for sending authorization. It is the ARN of the // identity that is associated with the sending authorization policy that permits // you to send for the email address specified in the Source parameter. For @@ -180,21 +188,13 @@ type SendTemplatedEmailInput struct { // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). SourceArn *string - // A list of replacement values to apply to the template. This parameter is a JSON - // object, typically consisting of key-value pairs in which the keys correspond to - // replacement tags in the email template. - // - // This member is required. - TemplateData *string + // A list of tags, in the form of name/value pairs, to apply to an email that you + // send using SendTemplatedEmail. Tags correspond to characteristics of the email + // that you define, so that you can publish email sending events. + Tags []*types.MessageTag - // The email address that bounces and complaints will be forwarded to when feedback - // forwarding is enabled. If the message cannot be delivered to the recipient, then - // an error message will be returned from the recipient's ISP; this message will - // then be forwarded to the email address specified by the ReturnPath parameter. - // The ReturnPath parameter is never overwritten. This email address must be either - // individually verified with Amazon SES, or from a domain that has been verified - // with Amazon SES. - ReturnPath *string + // The ARN of the template to use when sending this email. + TemplateArn *string } type SendTemplatedEmailOutput struct { diff --git a/service/ses/api_op_SetIdentityDkimEnabled.go b/service/ses/api_op_SetIdentityDkimEnabled.go index f0ff568183e..5a2a57636c7 100644 --- a/service/ses/api_op_SetIdentityDkimEnabled.go +++ b/service/ses/api_op_SetIdentityDkimEnabled.go @@ -71,16 +71,16 @@ func (c *Client) SetIdentityDkimEnabled(ctx context.Context, params *SetIdentity // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html). type SetIdentityDkimEnabledInput struct { - // The identity for which DKIM signing should be enabled or disabled. - // - // This member is required. - Identity *string - // Sets whether DKIM signing is enabled for an identity. Set to true to enable DKIM // signing for this identity; false to disable it. // // This member is required. DkimEnabled *bool + + // The identity for which DKIM signing should be enabled or disabled. + // + // This member is required. + Identity *string } // An empty element returned on a successful request. diff --git a/service/ses/api_op_SetIdentityFeedbackForwardingEnabled.go b/service/ses/api_op_SetIdentityFeedbackForwardingEnabled.go index 6ee4d064213..40caab949b7 100644 --- a/service/ses/api_op_SetIdentityFeedbackForwardingEnabled.go +++ b/service/ses/api_op_SetIdentityFeedbackForwardingEnabled.go @@ -68,12 +68,6 @@ func (c *Client) SetIdentityFeedbackForwardingEnabled(ctx context.Context, param // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications-via-email.html). type SetIdentityFeedbackForwardingEnabledInput struct { - // The identity for which to set bounce and complaint notification forwarding. - // Examples: user@example.com, example.com. - // - // This member is required. - Identity *string - // Sets whether Amazon SES will forward bounce and complaint notifications as // email. true specifies that Amazon SES will forward bounce and complaint // notifications as email, in addition to any Amazon SNS topic publishing otherwise @@ -83,6 +77,12 @@ type SetIdentityFeedbackForwardingEnabledInput struct { // // This member is required. ForwardingEnabled *bool + + // The identity for which to set bounce and complaint notification forwarding. + // Examples: user@example.com, example.com. + // + // This member is required. + Identity *string } // An empty element returned on a successful request. diff --git a/service/ses/api_op_SetIdentityHeadersInNotificationsEnabled.go b/service/ses/api_op_SetIdentityHeadersInNotificationsEnabled.go index 64d17cd9ebc..cb2fd6c8f55 100644 --- a/service/ses/api_op_SetIdentityHeadersInNotificationsEnabled.go +++ b/service/ses/api_op_SetIdentityHeadersInNotificationsEnabled.go @@ -76,16 +76,16 @@ type SetIdentityHeadersInNotificationsEnabledInput struct { // This member is required. Enabled *bool - // The notification type for which to enable or disable headers in notifications. - // - // This member is required. - NotificationType types.NotificationType - // The identity for which to enable or disable headers in notifications. Examples: // user@example.com, example.com. // // This member is required. Identity *string + + // The notification type for which to enable or disable headers in notifications. + // + // This member is required. + NotificationType types.NotificationType } // An empty element returned on a successful request. diff --git a/service/ses/api_op_SetIdentityNotificationTopic.go b/service/ses/api_op_SetIdentityNotificationTopic.go index 048c4ed7e8f..ed83c0fef99 100644 --- a/service/ses/api_op_SetIdentityNotificationTopic.go +++ b/service/ses/api_op_SetIdentityNotificationTopic.go @@ -70,6 +70,15 @@ func (c *Client) SetIdentityNotificationTopic(ctx context.Context, params *SetId // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications-via-sns.html). type SetIdentityNotificationTopicInput struct { + // The identity (email address or domain) that you want to set the Amazon SNS topic + // for. You can only specify a verified identity for this parameter. You can + // specify an identity by using its name or by using its Amazon Resource Name + // (ARN). The following examples are all valid identities: sender@example.com, + // example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. + // + // This member is required. + Identity *string + // The type of notifications that will be published to the specified Amazon SNS // topic. // @@ -80,15 +89,6 @@ type SetIdentityNotificationTopicInput struct { // omitted from the request or a null value is passed, SnsTopic is cleared and // publishing is disabled. SnsTopic *string - - // The identity (email address or domain) that you want to set the Amazon SNS topic - // for. You can only specify a verified identity for this parameter. You can - // specify an identity by using its name or by using its Amazon Resource Name - // (ARN). The following examples are all valid identities: sender@example.com, - // example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. - // - // This member is required. - Identity *string } // An empty element returned on a successful request. diff --git a/service/ses/api_op_SetReceiptRulePosition.go b/service/ses/api_op_SetReceiptRulePosition.go index cea89a76413..49c4bc75833 100644 --- a/service/ses/api_op_SetReceiptRulePosition.go +++ b/service/ses/api_op_SetReceiptRulePosition.go @@ -68,13 +68,13 @@ type SetReceiptRulePositionInput struct { // This member is required. RuleName *string - // The name of the receipt rule after which to place the specified receipt rule. - After *string - // The name of the receipt rule set that contains the receipt rule to reposition. // // This member is required. RuleSetName *string + + // The name of the receipt rule after which to place the specified receipt rule. + After *string } // An empty element returned on a successful request. diff --git a/service/ses/api_op_TestRenderTemplate.go b/service/ses/api_op_TestRenderTemplate.go index 283512ae714..652dddee0b8 100644 --- a/service/ses/api_op_TestRenderTemplate.go +++ b/service/ses/api_op_TestRenderTemplate.go @@ -58,17 +58,17 @@ func (c *Client) TestRenderTemplate(ctx context.Context, params *TestRenderTempl type TestRenderTemplateInput struct { - // The name of the template that you want to render. - // - // This member is required. - TemplateName *string - // A list of replacement values to apply to the template. This parameter is a JSON // object, typically consisting of key-value pairs in which the keys correspond to // replacement tags in the email template. // // This member is required. TemplateData *string + + // The name of the template that you want to render. + // + // This member is required. + TemplateName *string } type TestRenderTemplateOutput struct { diff --git a/service/ses/api_op_UpdateConfigurationSetEventDestination.go b/service/ses/api_op_UpdateConfigurationSetEventDestination.go index 2b0d767b948..0673eb2caf6 100644 --- a/service/ses/api_op_UpdateConfigurationSetEventDestination.go +++ b/service/ses/api_op_UpdateConfigurationSetEventDestination.go @@ -71,17 +71,17 @@ func (c *Client) UpdateConfigurationSetEventDestination(ctx context.Context, par // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). type UpdateConfigurationSetEventDestinationInput struct { - // The event destination object that you want to apply to the specified - // configuration set. - // - // This member is required. - EventDestination *types.EventDestination - // The name of the configuration set that contains the event destination that you // want to update. // // This member is required. ConfigurationSetName *string + + // The event destination object that you want to apply to the specified + // configuration set. + // + // This member is required. + EventDestination *types.EventDestination } // An empty element returned on a successful request. diff --git a/service/ses/api_op_UpdateConfigurationSetSendingEnabled.go b/service/ses/api_op_UpdateConfigurationSetSendingEnabled.go index 6986363d43f..30faddd3039 100644 --- a/service/ses/api_op_UpdateConfigurationSetSendingEnabled.go +++ b/service/ses/api_op_UpdateConfigurationSetSendingEnabled.go @@ -63,16 +63,16 @@ func (c *Client) UpdateConfigurationSetSendingEnabled(ctx context.Context, param // specific configuration set. type UpdateConfigurationSetSendingEnabledInput struct { - // Describes whether email sending is enabled or disabled for the configuration - // set. + // The name of the configuration set that you want to update. // // This member is required. - Enabled *bool + ConfigurationSetName *string - // The name of the configuration set that you want to update. + // Describes whether email sending is enabled or disabled for the configuration + // set. // // This member is required. - ConfigurationSetName *string + Enabled *bool } type UpdateConfigurationSetSendingEnabledOutput struct { diff --git a/service/ses/api_op_UpdateConfigurationSetTrackingOptions.go b/service/ses/api_op_UpdateConfigurationSetTrackingOptions.go index f2dc467c11f..4f879b4ea54 100644 --- a/service/ses/api_op_UpdateConfigurationSetTrackingOptions.go +++ b/service/ses/api_op_UpdateConfigurationSetTrackingOptions.go @@ -63,6 +63,12 @@ func (c *Client) UpdateConfigurationSetTrackingOptions(ctx context.Context, para // Represents a request to update the tracking options for a configuration set. type UpdateConfigurationSetTrackingOptionsInput struct { + // The name of the configuration set for which you want to update the custom + // tracking domain. + // + // This member is required. + ConfigurationSetName *string + // A domain that is used to redirect email recipients to an Amazon SES-operated // domain. This domain captures open and click events generated by Amazon SES // emails. For more information, see Configuring Custom Domains to Handle Open and @@ -72,12 +78,6 @@ type UpdateConfigurationSetTrackingOptionsInput struct { // // This member is required. TrackingOptions *types.TrackingOptions - - // The name of the configuration set for which you want to update the custom - // tracking domain. - // - // This member is required. - ConfigurationSetName *string } // An empty element returned on a successful request. diff --git a/service/ses/api_op_UpdateCustomVerificationEmailTemplate.go b/service/ses/api_op_UpdateCustomVerificationEmailTemplate.go index c94162b6761..c9d28c83929 100644 --- a/service/ses/api_op_UpdateCustomVerificationEmailTemplate.go +++ b/service/ses/api_op_UpdateCustomVerificationEmailTemplate.go @@ -62,6 +62,22 @@ func (c *Client) UpdateCustomVerificationEmailTemplate(ctx context.Context, para // Represents a request to update an existing custom verification email template. type UpdateCustomVerificationEmailTemplateInput struct { + // The name of the custom verification email template that you want to update. + // + // This member is required. + TemplateName *string + + // The URL that the recipient of the verification email is sent to if his or her + // address is not successfully verified. + FailureRedirectionURL *string + + // The email address that the custom verification email is sent from. + FromEmailAddress *string + + // The URL that the recipient of the verification email is sent to if his or her + // address is successfully verified. + SuccessRedirectionURL *string + // The content of the custom verification email. The total size of the email must // be less than 10 MB. The message body may contain HTML, with some limitations. // For more information, see Custom Verification Email Frequently Asked Questions @@ -71,22 +87,6 @@ type UpdateCustomVerificationEmailTemplateInput struct { // The subject line of the custom verification email. TemplateSubject *string - - // The URL that the recipient of the verification email is sent to if his or her - // address is successfully verified. - SuccessRedirectionURL *string - - // The email address that the custom verification email is sent from. - FromEmailAddress *string - - // The URL that the recipient of the verification email is sent to if his or her - // address is not successfully verified. - FailureRedirectionURL *string - - // The name of the custom verification email template that you want to update. - // - // This member is required. - TemplateName *string } type UpdateCustomVerificationEmailTemplateOutput struct { diff --git a/service/ses/api_op_UpdateReceiptRule.go b/service/ses/api_op_UpdateReceiptRule.go index eef851be931..fd2b3744cc2 100644 --- a/service/ses/api_op_UpdateReceiptRule.go +++ b/service/ses/api_op_UpdateReceiptRule.go @@ -63,15 +63,15 @@ func (c *Client) UpdateReceiptRule(ctx context.Context, params *UpdateReceiptRul // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). type UpdateReceiptRuleInput struct { - // The name of the receipt rule set that the receipt rule belongs to. + // A data structure that contains the updated receipt rule information. // // This member is required. - RuleSetName *string + Rule *types.ReceiptRule - // A data structure that contains the updated receipt rule information. + // The name of the receipt rule set that the receipt rule belongs to. // // This member is required. - Rule *types.ReceiptRule + RuleSetName *string } // An empty element returned on a successful request. diff --git a/service/ses/go.mod b/service/ses/go.mod index e587a7cbc42..f62f090f540 100644 --- a/service/ses/go.mod +++ b/service/ses/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/ses go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/ses/types/types.go b/service/ses/types/types.go index cbe91eb43ea..9d1de5efbc1 100644 --- a/service/ses/types/types.go +++ b/service/ses/types/types.go @@ -30,14 +30,14 @@ type AddHeaderAction struct { // email clients. type Body struct { - // The content of the message, in text format. Use this for text-based email - // clients, or clients on high-latency networks (such as mobile devices). - Text *Content - // The content of the message, in HTML format. Use this for email clients that can // process HTML. You can include clickable links, formatted text, and much more in // an HTML message. Html *Content + + // The content of the message, in text format. Use this for text-based email + // clients, or clients on high-latency networks (such as mobile devices). + Text *Content } // When included in a receipt rule, this action rejects the received email by @@ -48,12 +48,6 @@ type Body struct { // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-bounce.html). type BounceAction struct { - // The SMTP reply code, as defined by RFC 5321 - // (https://tools.ietf.org/html/rfc5321). - // - // This member is required. - SmtpReplyCode *string - // Human-readable text to include in the bounce message. // // This member is required. @@ -65,16 +59,22 @@ type BounceAction struct { // This member is required. Sender *string + // The SMTP reply code, as defined by RFC 5321 + // (https://tools.ietf.org/html/rfc5321). + // + // This member is required. + SmtpReplyCode *string + + // The SMTP enhanced status code, as defined by RFC 3463 + // (https://tools.ietf.org/html/rfc3463). + StatusCode *string + // The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce // action is taken. An example of an Amazon SNS topic ARN is // arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon // SNS topics, see the Amazon SNS Developer Guide // (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html). TopicArn *string - - // The SMTP enhanced status code, as defined by RFC 3463 - // (https://tools.ietf.org/html/rfc3463). - StatusCode *string } // Recipient-related information to include in the Delivery Status Notification @@ -84,13 +84,6 @@ type BounceAction struct { // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html). type BouncedRecipientInfo struct { - // This parameter is used only for sending authorization. It is the ARN of the - // identity that is associated with the sending authorization policy that permits - // you to receive email for the recipient of the bounced email. For more - // information about sending authorization, see the Amazon SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). - RecipientArn *string - // The email address of the recipient of the bounced email. // // This member is required. @@ -100,6 +93,13 @@ type BouncedRecipientInfo struct { // RecipientDsnFields. BounceType BounceType + // This parameter is used only for sending authorization. It is the ARN of the + // identity that is associated with the sending authorization policy that permits + // you to receive email for the recipient of the bounced email. For more + // information about sending authorization, see the Amazon SES Developer Guide + // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + RecipientArn *string + // Recipient-related DSN fields, most of which would normally be filled in // automatically when provided with a BounceType. You must provide either this // parameter or BounceType. @@ -110,11 +110,6 @@ type BouncedRecipientInfo struct { // replacement data associated with each of those Destinations. type BulkEmailDestination struct { - // A list of replacement values to apply to the template. This parameter is a JSON - // object, typically consisting of key-value pairs in which the keys correspond to - // replacement tags in the email template. - ReplacementTemplateData *string - // Represents the destination of the message, consisting of To:, CC:, and BCC: // fields. Amazon SES does not support the SMTPUTF8 extension, as described in // RFC6531 (https://tools.ietf.org/html/rfc6531). For this reason, the local part @@ -132,6 +127,11 @@ type BulkEmailDestination struct { // send using SendBulkTemplatedEmail. Tags correspond to characteristics of the // email that you define, so that you can publish email sending events. ReplacementTags []*MessageTag + + // A list of replacement values to apply to the template. This parameter is a JSON + // object, typically consisting of key-value pairs in which the keys correspond to + // replacement tags in the email template. + ReplacementTemplateData *string } // An object that contains the response from the SendBulkTemplatedEmail operation. @@ -232,15 +232,6 @@ type CloudWatchDimensionConfiguration struct { // This member is required. DefaultDimensionValue *string - // The place where Amazon SES finds the value of a dimension to publish to Amazon - // CloudWatch. If you want Amazon SES to use the message tags that you specify - // using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail - // API, choose messageTag. If you want Amazon SES to use your own email headers, - // choose emailHeader. - // - // This member is required. - DimensionValueSource DimensionValueSource - // The name of an Amazon CloudWatch dimension associated with an email sending // metric. The name must: // @@ -252,6 +243,15 @@ type CloudWatchDimensionConfiguration struct { // // This member is required. DimensionName *string + + // The place where Amazon SES finds the value of a dimension to publish to Amazon + // CloudWatch. If you want Amazon SES to use the message tags that you specify + // using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail + // API, choose messageTag. If you want Amazon SES to use your own email headers, + // choose emailHeader. + // + // This member is required. + DimensionValueSource DimensionValueSource } // The name of the configuration set. Configuration sets let you create groups of @@ -293,22 +293,22 @@ type Content struct { // Contains information about a custom verification email template. type CustomVerificationEmailTemplate struct { - // The email address that the custom verification email is sent from. - FromEmailAddress *string - // The URL that the recipient of the verification email is sent to if his or her // address is not successfully verified. FailureRedirectionURL *string - // The subject line of the custom verification email. - TemplateSubject *string - - // The name of the custom verification email template. - TemplateName *string + // The email address that the custom verification email is sent from. + FromEmailAddress *string // The URL that the recipient of the verification email is sent to if his or her // address is successfully verified. SuccessRedirectionURL *string + + // The name of the custom verification email template. + TemplateName *string + + // The subject line of the custom verification email. + TemplateSubject *string } // Specifies whether messages that use the configuration set are required to use @@ -334,14 +334,14 @@ type DeliveryOptions struct { // (https://tools.ietf.org/html/rfc3492.html). type Destination struct { + // The recipients to place on the BCC: line of the message. + BccAddresses []*string + // The recipients to place on the CC: line of the message. CcAddresses []*string // The recipients to place on the To: line of the message. ToAddresses []*string - - // The recipients to place on the BCC: line of the message. - BccAddresses []*string } // Contains information about the event destination that the specified email @@ -355,19 +355,10 @@ type Destination struct { // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). type EventDestination struct { - // An object that contains the names, default values, and sources of the dimensions - // associated with an Amazon CloudWatch event destination. - CloudWatchDestination *CloudWatchDestination - - // An object that contains the delivery stream ARN and the IAM role ARN associated - // with an Amazon Kinesis Firehose event destination. - KinesisFirehoseDestination *KinesisFirehoseDestination - - // Sets whether Amazon SES publishes events to this destination when you send an - // email with the associated configuration set. Set to true to enable publishing to - // this destination; set to false to prevent publishing to this destination. The - // default value is false. - Enabled *bool + // The type of email sending events to publish to the event destination. + // + // This member is required. + MatchingEventTypes []EventType // The name of the event destination. The name must: // @@ -380,10 +371,19 @@ type EventDestination struct { // This member is required. Name *string - // The type of email sending events to publish to the event destination. - // - // This member is required. - MatchingEventTypes []EventType + // An object that contains the names, default values, and sources of the dimensions + // associated with an Amazon CloudWatch event destination. + CloudWatchDestination *CloudWatchDestination + + // Sets whether Amazon SES publishes events to this destination when you send an + // email with the associated configuration set. Set to true to enable publishing to + // this destination; set to false to prevent publishing to this destination. The + // default value is false. + Enabled *bool + + // An object that contains the delivery stream ARN and the IAM role ARN associated + // with an Amazon Kinesis Firehose event destination. + KinesisFirehoseDestination *KinesisFirehoseDestination // An object that contains the topic ARN associated with an Amazon Simple // Notification Service (Amazon SNS) event destination. @@ -396,22 +396,35 @@ type EventDestination struct { // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html). type ExtensionField struct { - // The value of the header to add. Must be less than 2048 characters, and must not - // contain newline characters ("\r" or "\n"). - // - // This member is required. - Value *string - // The name of the header to add. Must be between 1 and 50 characters, inclusive, // and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only. // // This member is required. Name *string + + // The value of the header to add. Must be less than 2048 characters, and must not + // contain newline characters ("\r" or "\n"). + // + // This member is required. + Value *string } // Represents the DKIM attributes of a verified email address or a domain. type IdentityDkimAttributes struct { + // Is true if DKIM signing is enabled for email sent from the identity. It's false + // otherwise. The default value is true. + // + // This member is required. + DkimEnabled *bool + + // Describes whether Amazon SES has successfully verified the DKIM DNS records + // (tokens) published in the domain name's DNS. (This only applies to domain + // identities, not email address identities.) + // + // This member is required. + DkimVerificationStatus VerificationStatus + // A set of character strings that represent the domain's identity. Using these // tokens, you need to create DNS CNAME records that point to DKIM public keys that // are hosted by Amazon SES. Amazon Web Services eventually detects that you've @@ -422,39 +435,12 @@ type IdentityDkimAttributes struct { // see the Amazon SES Developer Guide // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html). DkimTokens []*string - - // Describes whether Amazon SES has successfully verified the DKIM DNS records - // (tokens) published in the domain name's DNS. (This only applies to domain - // identities, not email address identities.) - // - // This member is required. - DkimVerificationStatus VerificationStatus - - // Is true if DKIM signing is enabled for email sent from the identity. It's false - // otherwise. The default value is true. - // - // This member is required. - DkimEnabled *bool } // Represents the custom MAIL FROM domain attributes of a verified identity (email // address or domain). type IdentityMailFromDomainAttributes struct { - // The state that indicates whether Amazon SES has successfully read the MX record - // required for custom MAIL FROM domain setup. If the state is Success, Amazon SES - // uses the specified custom MAIL FROM domain when the verified identity sends an - // email. All other states indicate that Amazon SES takes the action described by - // BehaviorOnMXFailure. - // - // This member is required. - MailFromDomainStatus CustomMailFromStatus - - // The custom MAIL FROM domain that the identity is configured to use. - // - // This member is required. - MailFromDomain *string - // The action that Amazon SES takes if it cannot successfully read the required MX // record when you send an email. A value of UseDefaultValue indicates that if // Amazon SES cannot read the required MX record, it uses amazonses.com (or a @@ -466,6 +452,20 @@ type IdentityMailFromDomainAttributes struct { // // This member is required. BehaviorOnMXFailure BehaviorOnMXFailure + + // The custom MAIL FROM domain that the identity is configured to use. + // + // This member is required. + MailFromDomain *string + + // The state that indicates whether Amazon SES has successfully read the MX record + // required for custom MAIL FROM domain setup. If the state is Success, Amazon SES + // uses the specified custom MAIL FROM domain when the verified identity sends an + // email. All other states indicate that Amazon SES takes the action described by + // BehaviorOnMXFailure. + // + // This member is required. + MailFromDomainStatus CustomMailFromStatus } // Represents the notification attributes of an identity, including whether an @@ -474,14 +474,17 @@ type IdentityMailFromDomainAttributes struct { // forwarding is enabled for bounce and complaint notifications. type IdentityNotificationAttributes struct { - // Describes whether Amazon SES will forward bounce and complaint notifications as - // email. true indicates that Amazon SES will forward bounce and complaint - // notifications as email, while false indicates that bounce and complaint - // notifications will be published only to the specified bounce and complaint - // Amazon SNS topics. + // The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will + // publish bounce notifications. // // This member is required. - ForwardingEnabled *bool + BounceTopic *string + + // The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will + // publish complaint notifications. + // + // This member is required. + ComplaintTopic *string // The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will // publish delivery notifications. @@ -489,11 +492,14 @@ type IdentityNotificationAttributes struct { // This member is required. DeliveryTopic *string - // Describes whether Amazon SES includes the original email headers in Amazon SNS - // notifications of type Delivery. A value of true specifies that Amazon SES will - // include headers in delivery notifications, and a value of false specifies that - // Amazon SES will not include headers in delivery notifications. - HeadersInDeliveryNotificationsEnabled *bool + // Describes whether Amazon SES will forward bounce and complaint notifications as + // email. true indicates that Amazon SES will forward bounce and complaint + // notifications as email, while false indicates that bounce and complaint + // notifications will be published only to the specified bounce and complaint + // Amazon SNS topics. + // + // This member is required. + ForwardingEnabled *bool // Describes whether Amazon SES includes the original email headers in Amazon SNS // notifications of type Bounce. A value of true specifies that Amazon SES will @@ -501,23 +507,17 @@ type IdentityNotificationAttributes struct { // Amazon SES will not include headers in bounce notifications. HeadersInBounceNotificationsEnabled *bool - // The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will - // publish bounce notifications. - // - // This member is required. - BounceTopic *string - - // The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will - // publish complaint notifications. - // - // This member is required. - ComplaintTopic *string - // Describes whether Amazon SES includes the original email headers in Amazon SNS // notifications of type Complaint. A value of true specifies that Amazon SES will // include headers in complaint notifications, and a value of false specifies that // Amazon SES will not include headers in complaint notifications. HeadersInComplaintNotificationsEnabled *bool + + // Describes whether Amazon SES includes the original email headers in Amazon SNS + // notifications of type Delivery. A value of true specifies that Amazon SES will + // include headers in delivery notifications, and a value of false specifies that + // Amazon SES will not include headers in delivery notifications. + HeadersInDeliveryNotificationsEnabled *bool } // Represents the verification attributes of a single identity. @@ -566,6 +566,14 @@ type KinesisFirehoseDestination struct { // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-lambda.html). type LambdaAction struct { + // The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS + // Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. + // For more information about AWS Lambda, see the AWS Lambda Developer Guide + // (https://docs.aws.amazon.com/lambda/latest/dg/welcome.html). + // + // This member is required. + FunctionArn *string + // The invocation type of the AWS Lambda function. An invocation type of // RequestResponse means that the execution of the function will immediately result // in a response, and a value of Event means that the function will be invoked @@ -577,14 +585,6 @@ type LambdaAction struct { // flow decision, such as whether to stop the receipt rule or the receipt rule set. InvocationType InvocationType - // The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS - // Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. - // For more information about AWS Lambda, see the AWS Lambda Developer Guide - // (https://docs.aws.amazon.com/lambda/latest/dg/welcome.html). - // - // This member is required. - FunctionArn *string - // The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda // action is taken. An example of an Amazon SNS topic ARN is // arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon @@ -596,16 +596,16 @@ type LambdaAction struct { // Represents the message to be sent, composed of a subject and a body. type Message struct { - // The subject of the message: A short summary of the content, which will appear in - // the recipient's inbox. + // The message body. // // This member is required. - Subject *Content + Body *Body - // The message body. + // The subject of the message: A short summary of the content, which will appear in + // the recipient's inbox. // // This member is required. - Body *Body + Subject *Content } // Message-related information to include in the Delivery Status Notification (DSN) @@ -621,12 +621,12 @@ type MessageDsn struct { // This member is required. ReportingMta *string - // Additional X-headers to include in the DSN. - ExtensionFields []*ExtensionField - // When the message was received by the reporting mail transfer agent (MTA), in RFC // 822 (https://www.ietf.org/rfc/rfc0822.txt) date-time format. ArrivalDate *time.Time + + // Additional X-headers to include in the DSN. + ExtensionFields []*ExtensionField } // Contains the name and value of a tag that you can provide to SendEmail or @@ -636,7 +636,7 @@ type MessageDsn struct { // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). type MessageTag struct { - // The value of the tag. The value must: + // The name of the tag. The name must: // // * This value can only contain ASCII // letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). @@ -645,9 +645,9 @@ type MessageTag struct { // Contain less than 256 characters. // // This member is required. - Value *string + Name *string - // The name of the tag. The name must: + // The value of the tag. The value must: // // * This value can only contain ASCII // letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). @@ -656,7 +656,7 @@ type MessageTag struct { // Contain less than 256 characters. // // This member is required. - Name *string + Value *string } // Represents the raw data of the message. @@ -687,16 +687,14 @@ type RawMessage struct { // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html). type ReceiptAction struct { - // Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon - // SNS. - WorkmailAction *WorkmailAction - - // Publishes the email content within a notification to Amazon SNS. - SNSAction *SNSAction - // Adds a header to the received email. AddHeaderAction *AddHeaderAction + // Rejects the received email by returning a bounce response to the sender and, + // optionally, publishes a notification to Amazon Simple Notification Service + // (Amazon SNS). + BounceAction *BounceAction + // Calls an AWS Lambda function, and optionally, publishes a notification to Amazon // SNS. LambdaAction *LambdaAction @@ -705,14 +703,16 @@ type ReceiptAction struct { // bucket and, optionally, publishes a notification to Amazon SNS. S3Action *S3Action + // Publishes the email content within a notification to Amazon SNS. + SNSAction *SNSAction + // Terminates the evaluation of the receipt rule set and optionally publishes a // notification to Amazon SNS. StopAction *StopAction - // Rejects the received email by returning a bounce response to the sender and, - // optionally, publishes a notification to Amazon Simple Notification Service - // (Amazon SNS). - BounceAction *BounceAction + // Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon + // SNS. + WorkmailAction *WorkmailAction } // A receipt IP address filter enables you to specify whether to accept or reject @@ -774,6 +774,19 @@ type ReceiptIpFilter struct { // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html). type ReceiptRule struct { + // The name of the receipt rule. The name must: + // + // * This value can only contain + // ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). + // + // * + // Start and end with a letter or number. + // + // * Contain less than 64 characters. + // + // This member is required. + Name *string + // An ordered list of actions to perform on messages that match at least one of the // recipient email addresses or domains specified in the receipt rule. Actions []*ReceiptAction @@ -781,33 +794,20 @@ type ReceiptRule struct { // If true, the receipt rule is active. The default value is false. Enabled *bool - // If true, then messages that this receipt rule applies to are scanned for spam - // and viruses. The default value is false. - ScanEnabled *bool - // The recipient domains and email addresses that the receipt rule applies to. If // this field is not specified, this rule will match all recipients under all // verified domains. Recipients []*string + // If true, then messages that this receipt rule applies to are scanned for spam + // and viruses. The default value is false. + ScanEnabled *bool + // Specifies whether Amazon SES should require that incoming email is delivered // over a connection encrypted with Transport Layer Security (TLS). If this // parameter is set to Require, Amazon SES will bounce emails that are not received // over TLS. The default is Optional. TlsPolicy TlsPolicy - - // The name of the receipt rule. The name must: - // - // * This value can only contain - // ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). - // - // * - // Start and end with a letter or number. - // - // * Contain less than 64 characters. - // - // This member is required. - Name *string } // Information about a receipt rule set. A receipt rule set is a collection of @@ -817,6 +817,9 @@ type ReceiptRule struct { // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html). type ReceiptRuleSetMetadata struct { + // The date and time the receipt rule set was created. + CreatedTimestamp *time.Time + // The name of the receipt rule set. The name must: // // * This value can only @@ -828,9 +831,6 @@ type ReceiptRuleSetMetadata struct { // * Contain less than 64 // characters. Name *string - - // The date and time the receipt rule set was created. - CreatedTimestamp *time.Time } // Recipient-related information to include in the Delivery Status Notification @@ -840,9 +840,12 @@ type ReceiptRuleSetMetadata struct { // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html). type RecipientDsnFields struct { - // The time the final delivery attempt was made, in RFC 822 - // (https://www.ietf.org/rfc/rfc0822.txt) date-time format. - LastAttemptDate *time.Time + // The action performed by the reporting mail transfer agent (MTA) as a result of + // its attempt to deliver the message to the recipient address. This is required by + // RFC 3464 (https://tools.ietf.org/html/rfc3464). + // + // This member is required. + Action DsnAction // The status code that indicates what went wrong. This is required by RFC 3464 // (https://tools.ietf.org/html/rfc3464). @@ -850,6 +853,14 @@ type RecipientDsnFields struct { // This member is required. Status *string + // An extended explanation of what went wrong; this is usually an SMTP response. + // See RFC 3463 (https://tools.ietf.org/html/rfc3463) for the correct formatting of + // this parameter. + DiagnosticCode *string + + // Additional X-headers to include in the DSN. + ExtensionFields []*ExtensionField + // The email address that the message was ultimately delivered to. This corresponds // to the Final-Recipient in the DSN. If not specified, FinalRecipient will be set // to the Recipient specified in the BouncedRecipientInfo structure. Either @@ -858,38 +869,20 @@ type RecipientDsnFields struct { // with rfc 822;, as described in RFC 3798 (https://tools.ietf.org/html/rfc3798). FinalRecipient *string - // An extended explanation of what went wrong; this is usually an SMTP response. - // See RFC 3463 (https://tools.ietf.org/html/rfc3463) for the correct formatting of - // this parameter. - DiagnosticCode *string - - // Additional X-headers to include in the DSN. - ExtensionFields []*ExtensionField + // The time the final delivery attempt was made, in RFC 822 + // (https://www.ietf.org/rfc/rfc0822.txt) date-time format. + LastAttemptDate *time.Time // The MTA to which the remote MTA attempted to deliver the message, formatted as // specified in RFC 3464 (https://tools.ietf.org/html/rfc3464) (mta-name-type; // mta-name). This parameter typically applies only to propagating synchronous // bounces. RemoteMta *string - - // The action performed by the reporting mail transfer agent (MTA) as a result of - // its attempt to deliver the message to the recipient address. This is required by - // RFC 3464 (https://tools.ietf.org/html/rfc3464). - // - // This member is required. - Action DsnAction } // Contains information about the reputation settings for a configuration set. type ReputationOptions struct { - // Describes whether email sending is enabled or disabled for the configuration - // set. If the value is true, then Amazon SES will send emails that use the - // configuration set. If the value is false, Amazon SES will not send emails that - // use the configuration set. The default value is true. You can change this - // setting using UpdateConfigurationSetSendingEnabled (). - SendingEnabled *bool - // The date and time at which the reputation metrics for the configuration set were // last reset. Resetting these metrics is known as a fresh start. When you disable // email sending for a configuration set using UpdateConfigurationSetSendingEnabled @@ -904,6 +897,13 @@ type ReputationOptions struct { // the value is true, reputation metrics are published. If the value is false, // reputation metrics are not published. The default value is false. ReputationMetricsEnabled *bool + + // Describes whether email sending is enabled or disabled for the configuration + // set. If the value is true, then Amazon SES will send emails that use the + // configuration set. If the value is false, Amazon SES will not send emails that + // use the configuration set. The default value is true. You can change this + // setting using UpdateConfigurationSetSendingEnabled (). + SendingEnabled *bool } // When included in a receipt rule, this action saves the received message to an @@ -962,37 +962,37 @@ type S3Action struct { // (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html). KmsKeyArn *string + // The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory + // name that enables you to store similar data under the same directory in a + // bucket. + ObjectKeyPrefix *string + // The ARN of the Amazon SNS topic to notify when the message is saved to the // Amazon S3 bucket. An example of an Amazon SNS topic ARN is // arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon // SNS topics, see the Amazon SNS Developer Guide // (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html). TopicArn *string - - // The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory - // name that enables you to store similar data under the same directory in a - // bucket. - ObjectKeyPrefix *string } // Represents sending statistics data. Each SendDataPoint contains statistics for a // 15-minute period of sending activity. type SendDataPoint struct { - // Number of emails rejected by Amazon SES. - Rejects *int64 + // Number of emails that have bounced. + Bounces *int64 + + // Number of unwanted emails that were rejected by recipients. + Complaints *int64 // Number of emails that have been sent. DeliveryAttempts *int64 - // Number of emails that have bounced. - Bounces *int64 + // Number of emails rejected by Amazon SES. + Rejects *int64 // Time of the data point. Timestamp *time.Time - - // Number of unwanted emails that were rejected by recipients. - Complaints *int64 } // When included in a receipt rule, this action publishes a notification to Amazon @@ -1069,6 +1069,12 @@ type StopAction struct { // text-only part. type Template struct { + // The name of the template. You will refer to this name when you send email using + // the SendTemplatedEmail or SendBulkTemplatedEmail operations. + // + // This member is required. + TemplateName *string + // The HTML body of the email. HtmlPart *string @@ -1078,12 +1084,6 @@ type Template struct { // The email body that will be visible to recipients whose email clients do not // display HTML. TextPart *string - - // The name of the template. You will refer to this name when you send email using - // the SendTemplatedEmail or SendBulkTemplatedEmail operations. - // - // This member is required. - TemplateName *string } // Contains information about an email template. diff --git a/service/sesv2/api_op_CreateConfigurationSet.go b/service/sesv2/api_op_CreateConfigurationSet.go index 7a0fec7c5cd..9d9908d1833 100644 --- a/service/sesv2/api_op_CreateConfigurationSet.go +++ b/service/sesv2/api_op_CreateConfigurationSet.go @@ -62,6 +62,19 @@ func (c *Client) CreateConfigurationSet(ctx context.Context, params *CreateConfi // A request to create a configuration set. type CreateConfigurationSetInput struct { + // The name of the configuration set. + // + // This member is required. + ConfigurationSetName *string + + // An object that defines the dedicated IP pool that is used to send emails that + // you send using the configuration set. + DeliveryOptions *types.DeliveryOptions + + // An object that defines whether or not Amazon SES collects reputation metrics for + // the emails that you send that use the configuration set. + ReputationOptions *types.ReputationOptions + // An object that defines whether or not Amazon SES can send email that you send // using the configuration set. SendingOptions *types.SendingOptions @@ -70,23 +83,10 @@ type CreateConfigurationSetInput struct { // your account. SuppressionOptions *types.SuppressionOptions - // An object that defines the dedicated IP pool that is used to send emails that - // you send using the configuration set. - DeliveryOptions *types.DeliveryOptions - // An array of objects that define the tags (keys and values) that you want to // associate with the configuration set. Tags []*types.Tag - // An object that defines whether or not Amazon SES collects reputation metrics for - // the emails that you send that use the configuration set. - ReputationOptions *types.ReputationOptions - - // The name of the configuration set. - // - // This member is required. - ConfigurationSetName *string - // An object that defines the open and click tracking options for emails that you // send using the configuration set. TrackingOptions *types.TrackingOptions diff --git a/service/sesv2/api_op_CreateCustomVerificationEmailTemplate.go b/service/sesv2/api_op_CreateCustomVerificationEmailTemplate.go index f076a7d9dc6..ac062ea8976 100644 --- a/service/sesv2/api_op_CreateCustomVerificationEmailTemplate.go +++ b/service/sesv2/api_op_CreateCustomVerificationEmailTemplate.go @@ -62,41 +62,41 @@ func (c *Client) CreateCustomVerificationEmailTemplate(ctx context.Context, para // Represents a request to create a custom verification email template. type CreateCustomVerificationEmailTemplateInput struct { - // The subject line of the custom verification email. - // - // This member is required. - TemplateSubject *string - - // The content of the custom verification email. The total size of the email must - // be less than 10 MB. The message body may contain HTML, with some limitations. - // For more information, see Custom Verification Email Frequently Asked Questions - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html#custom-verification-emails-faq) - // in the Amazon SES Developer Guide. - // - // This member is required. - TemplateContent *string - // The URL that the recipient of the verification email is sent to if his or her // address is not successfully verified. // // This member is required. FailureRedirectionURL *string + // The email address that the custom verification email is sent from. + // + // This member is required. + FromEmailAddress *string + // The URL that the recipient of the verification email is sent to if his or her // address is successfully verified. // // This member is required. SuccessRedirectionURL *string - // The email address that the custom verification email is sent from. + // The content of the custom verification email. The total size of the email must + // be less than 10 MB. The message body may contain HTML, with some limitations. + // For more information, see Custom Verification Email Frequently Asked Questions + // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html#custom-verification-emails-faq) + // in the Amazon SES Developer Guide. // // This member is required. - FromEmailAddress *string + TemplateContent *string // The name of the custom verification email template. // // This member is required. TemplateName *string + + // The subject line of the custom verification email. + // + // This member is required. + TemplateSubject *string } // If the action is successful, the service sends back an HTTP 200 response with an diff --git a/service/sesv2/api_op_CreateDeliverabilityTestReport.go b/service/sesv2/api_op_CreateDeliverabilityTestReport.go index 9e25505d082..a3b951e7b2e 100644 --- a/service/sesv2/api_op_CreateDeliverabilityTestReport.go +++ b/service/sesv2/api_op_CreateDeliverabilityTestReport.go @@ -78,6 +78,11 @@ type CreateDeliverabilityTestReportInput struct { // This member is required. Content *types.EmailContent + // The email address that the predictive inbox placement test email was sent from. + // + // This member is required. + FromEmailAddress *string + // A unique name that helps you to identify the predictive inbox placement test // when you retrieve the results. ReportName *string @@ -85,11 +90,6 @@ type CreateDeliverabilityTestReportInput struct { // An array of objects that define the tags (keys and values) that you want to // associate with the predictive inbox placement test. Tags []*types.Tag - - // The email address that the predictive inbox placement test email was sent from. - // - // This member is required. - FromEmailAddress *string } // Information about the predictive inbox placement test that you created. diff --git a/service/sesv2/api_op_CreateEmailIdentity.go b/service/sesv2/api_op_CreateEmailIdentity.go index 51640721af2..5ad823a3669 100644 --- a/service/sesv2/api_op_CreateEmailIdentity.go +++ b/service/sesv2/api_op_CreateEmailIdentity.go @@ -78,6 +78,11 @@ func (c *Client) CreateEmailIdentity(ctx context.Context, params *CreateEmailIde // address or domain). type CreateEmailIdentityInput struct { + // The email address or domain that you want to verify. + // + // This member is required. + EmailIdentity *string + // If your request includes this object, Amazon SES configures the identity to use // Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, as opposed to // the default method, Easy DKIM @@ -86,11 +91,6 @@ type CreateEmailIdentityInput struct { // address. DkimSigningAttributes *types.DkimSigningAttributes - // The email address or domain that you want to verify. - // - // This member is required. - EmailIdentity *string - // An array of objects that define the tags (keys and values) that you want to // associate with the email identity. Tags []*types.Tag @@ -101,18 +101,18 @@ type CreateEmailIdentityInput struct { // address, this object is empty. type CreateEmailIdentityOutput struct { - // Specifies whether or not the identity is verified. You can only send email from - // verified email addresses or domains. For more information about verifying - // identities, see the Amazon Pinpoint User Guide - // (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html). - VerifiedForSendingStatus *bool - // An object that contains information about the DKIM attributes for the identity. DkimAttributes *types.DkimAttributes // The email identity type. IdentityType types.IdentityType + // Specifies whether or not the identity is verified. You can only send email from + // verified email addresses or domains. For more information about verifying + // identities, see the Amazon Pinpoint User Guide + // (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html). + VerifiedForSendingStatus *bool + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sesv2/api_op_CreateEmailTemplate.go b/service/sesv2/api_op_CreateEmailTemplate.go index 64d42d824c4..4a9041d7212 100644 --- a/service/sesv2/api_op_CreateEmailTemplate.go +++ b/service/sesv2/api_op_CreateEmailTemplate.go @@ -64,16 +64,16 @@ func (c *Client) CreateEmailTemplate(ctx context.Context, params *CreateEmailTem // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html). type CreateEmailTemplateInput struct { - // The name of the template you want to create. - // - // This member is required. - TemplateName *string - // The content of the email template, composed of a subject line, an HTML part, and // a text-only part. // // This member is required. TemplateContent *types.EmailTemplateContent + + // The name of the template you want to create. + // + // This member is required. + TemplateName *string } // If the action is successful, the service sends back an HTTP 200 response with an diff --git a/service/sesv2/api_op_GetAccount.go b/service/sesv2/api_op_GetAccount.go index 0a29e7ff3d3..e73af70cdf9 100644 --- a/service/sesv2/api_op_GetAccount.go +++ b/service/sesv2/api_op_GetAccount.go @@ -64,32 +64,13 @@ type GetAccountInput struct { // account in the current AWS Region. type GetAccountOutput struct { - // An object that contains information about the per-day and per-second sending - // limits for your Amazon SES account in the current AWS Region. - SendQuota *types.SendQuota - - // Indicates whether or not email sending is enabled for your Amazon SES account in - // the current AWS Region. - SendingEnabled *bool - - // An object that contains information about the email address suppression - // preferences for your account in the current AWS Region. - SuppressionAttributes *types.SuppressionAttributes + // Indicates whether or not the automatic warm-up feature is enabled for dedicated + // IP addresses that are associated with your account. + DedicatedIpAutoWarmupEnabled *bool // An object that defines your account details. Details *types.AccountDetails - // Indicates whether or not your account has production access in the current AWS - // Region. If the value is false, then your account is in the sandbox. When your - // account is in the sandbox, you can only send email to verified identities. - // Additionally, the maximum number of emails you can send in a 24-hour period - // (your sending quota) is 200, and the maximum number of emails you can send per - // second (your maximum sending rate) is 1. If the value is true, then your account - // has production access. When your account has production access, you can send - // email to any address. The sending quota and maximum sending rate for your - // account vary based on your specific use case. - ProductionAccessEnabled *bool - // The reputation status of your Amazon SES account. The status can be one of the // following: // @@ -106,9 +87,28 @@ type GetAccountOutput struct { // request that your account's ability to send email is resumed. EnforcementStatus *string - // Indicates whether or not the automatic warm-up feature is enabled for dedicated - // IP addresses that are associated with your account. - DedicatedIpAutoWarmupEnabled *bool + // Indicates whether or not your account has production access in the current AWS + // Region. If the value is false, then your account is in the sandbox. When your + // account is in the sandbox, you can only send email to verified identities. + // Additionally, the maximum number of emails you can send in a 24-hour period + // (your sending quota) is 200, and the maximum number of emails you can send per + // second (your maximum sending rate) is 1. If the value is true, then your account + // has production access. When your account has production access, you can send + // email to any address. The sending quota and maximum sending rate for your + // account vary based on your specific use case. + ProductionAccessEnabled *bool + + // An object that contains information about the per-day and per-second sending + // limits for your Amazon SES account in the current AWS Region. + SendQuota *types.SendQuota + + // Indicates whether or not email sending is enabled for your Amazon SES account in + // the current AWS Region. + SendingEnabled *bool + + // An object that contains information about the email address suppression + // preferences for your account in the current AWS Region. + SuppressionAttributes *types.SuppressionAttributes // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_GetConfigurationSet.go b/service/sesv2/api_op_GetConfigurationSet.go index 3f1118f3c87..a16686b6e06 100644 --- a/service/sesv2/api_op_GetConfigurationSet.go +++ b/service/sesv2/api_op_GetConfigurationSet.go @@ -74,33 +74,33 @@ type GetConfigurationSetInput struct { // Information about a configuration set. type GetConfigurationSetOutput struct { - // An object that defines whether or not Amazon SES can send email that you send - // using the configuration set. - SendingOptions *types.SendingOptions + // The name of the configuration set. + ConfigurationSetName *string // An object that defines the dedicated IP pool that is used to send emails that // you send using the configuration set. DeliveryOptions *types.DeliveryOptions - // An object that defines the open and click tracking options for emails that you - // send using the configuration set. - TrackingOptions *types.TrackingOptions - - // An array of objects that define the tags (keys and values) that are associated - // with the configuration set. - Tags []*types.Tag - - // The name of the configuration set. - ConfigurationSetName *string - // An object that defines whether or not Amazon SES collects reputation metrics for // the emails that you send that use the configuration set. ReputationOptions *types.ReputationOptions + // An object that defines whether or not Amazon SES can send email that you send + // using the configuration set. + SendingOptions *types.SendingOptions + // An object that contains information about the suppression list preferences for // your account. SuppressionOptions *types.SuppressionOptions + // An array of objects that define the tags (keys and values) that are associated + // with the configuration set. + Tags []*types.Tag + + // An object that defines the open and click tracking options for emails that you + // send using the configuration set. + TrackingOptions *types.TrackingOptions + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sesv2/api_op_GetCustomVerificationEmailTemplate.go b/service/sesv2/api_op_GetCustomVerificationEmailTemplate.go index 880b9e7caa0..c6a8a9b45cb 100644 --- a/service/sesv2/api_op_GetCustomVerificationEmailTemplate.go +++ b/service/sesv2/api_op_GetCustomVerificationEmailTemplate.go @@ -71,23 +71,23 @@ type GetCustomVerificationEmailTemplateInput struct { // The following elements are returned by the service. type GetCustomVerificationEmailTemplateOutput struct { + // The URL that the recipient of the verification email is sent to if his or her + // address is not successfully verified. + FailureRedirectionURL *string + // The email address that the custom verification email is sent from. FromEmailAddress *string - // The content of the custom verification email. - TemplateContent *string - // The URL that the recipient of the verification email is sent to if his or her // address is successfully verified. SuccessRedirectionURL *string + // The content of the custom verification email. + TemplateContent *string + // The name of the custom verification email template. TemplateName *string - // The URL that the recipient of the verification email is sent to if his or her - // address is not successfully verified. - FailureRedirectionURL *string - // The subject line of the custom verification email. TemplateSubject *string diff --git a/service/sesv2/api_op_GetDedicatedIps.go b/service/sesv2/api_op_GetDedicatedIps.go index 04f8ce00056..fd260486937 100644 --- a/service/sesv2/api_op_GetDedicatedIps.go +++ b/service/sesv2/api_op_GetDedicatedIps.go @@ -57,16 +57,16 @@ func (c *Client) GetDedicatedIps(ctx context.Context, params *GetDedicatedIpsInp // A request to obtain more information about dedicated IP pools. type GetDedicatedIpsInput struct { + // A token returned from a previous call to GetDedicatedIps to indicate the + // position of the dedicated IP pool in the list of IP pools. + NextToken *string + // The number of results to show in a single call to GetDedicatedIpsRequest. If the // number of results is larger than the number you specified in this parameter, // then the response includes a NextToken element, which you can use to obtain // additional results. PageSize *int32 - // A token returned from a previous call to GetDedicatedIps to indicate the - // position of the dedicated IP pool in the list of IP pools. - NextToken *string - // The name of the IP pool that the dedicated IP address is associated with. PoolName *string } @@ -75,14 +75,14 @@ type GetDedicatedIpsInput struct { // account. type GetDedicatedIpsOutput struct { + // A list of dedicated IP addresses that are associated with your AWS account. + DedicatedIps []*types.DedicatedIp + // A token that indicates that there are additional dedicated IP addresses to list. // To view additional addresses, issue another request to GetDedicatedIps, passing // this token in the NextToken parameter. NextToken *string - // A list of dedicated IP addresses that are associated with your AWS account. - DedicatedIps []*types.DedicatedIp - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sesv2/api_op_GetDeliverabilityDashboardOptions.go b/service/sesv2/api_op_GetDeliverabilityDashboardOptions.go index 8750d690d09..726caf8fb0a 100644 --- a/service/sesv2/api_op_GetDeliverabilityDashboardOptions.go +++ b/service/sesv2/api_op_GetDeliverabilityDashboardOptions.go @@ -78,33 +78,33 @@ type GetDeliverabilityDashboardOptionsInput struct { // An object that shows the status of the Deliverability dashboard. type GetDeliverabilityDashboardOptionsOutput struct { - // The date, in Unix time format, when your current subscription to the - // Deliverability dashboard is scheduled to expire, if your subscription is - // scheduled to expire at the end of the current calendar month. This value is null - // if you have an active subscription that isn’t due to expire at the end of the - // month. - SubscriptionExpiryDate *time.Time - - // An array of objects, one for each verified domain that you use to send email and - // currently has an active Deliverability dashboard subscription that's scheduled - // to expire at the end of the current calendar month. - PendingExpirationSubscribedDomains []*types.DomainDeliverabilityTrackingOption - // Specifies whether the Deliverability dashboard is enabled. If this value is // true, the dashboard is enabled. // // This member is required. DashboardEnabled *bool + // The current status of your Deliverability dashboard subscription. If this value + // is PENDING_EXPIRATION, your subscription is scheduled to expire at the end of + // the current calendar month. + AccountStatus types.DeliverabilityDashboardAccountStatus + // An array of objects, one for each verified domain that you use to send email and // currently has an active Deliverability dashboard subscription that isn’t // scheduled to expire at the end of the current calendar month. ActiveSubscribedDomains []*types.DomainDeliverabilityTrackingOption - // The current status of your Deliverability dashboard subscription. If this value - // is PENDING_EXPIRATION, your subscription is scheduled to expire at the end of - // the current calendar month. - AccountStatus types.DeliverabilityDashboardAccountStatus + // An array of objects, one for each verified domain that you use to send email and + // currently has an active Deliverability dashboard subscription that's scheduled + // to expire at the end of the current calendar month. + PendingExpirationSubscribedDomains []*types.DomainDeliverabilityTrackingOption + + // The date, in Unix time format, when your current subscription to the + // Deliverability dashboard is scheduled to expire, if your subscription is + // scheduled to expire at the end of the current calendar month. This value is null + // if you have an active subscription that isn’t due to expire at the end of the + // month. + SubscriptionExpiryDate *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_GetDeliverabilityTestReport.go b/service/sesv2/api_op_GetDeliverabilityTestReport.go index 4767117bfdf..76dda29adff 100644 --- a/service/sesv2/api_op_GetDeliverabilityTestReport.go +++ b/service/sesv2/api_op_GetDeliverabilityTestReport.go @@ -67,16 +67,17 @@ type GetDeliverabilityTestReportInput struct { // The results of the predictive inbox placement test. type GetDeliverabilityTestReportOutput struct { + // An object that contains the results of the predictive inbox placement test. + // + // This member is required. + DeliverabilityTestReport *types.DeliverabilityTestReport + // An object that describes how the test email was handled by several email // providers, including Gmail, Hotmail, Yahoo, AOL, and others. // // This member is required. IspPlacements []*types.IspPlacement - // An array of objects that define the tags (keys and values) that are associated - // with the predictive inbox placement test. - Tags []*types.Tag - // An object that specifies how many test messages that were sent during the // predictive inbox placement test were delivered to recipients' inboxes, how many // were sent to recipients' spam folders, and how many weren't delivered. @@ -88,10 +89,9 @@ type GetDeliverabilityTestReportOutput struct { // predictive inbox placement test. Message *string - // An object that contains the results of the predictive inbox placement test. - // - // This member is required. - DeliverabilityTestReport *types.DeliverabilityTestReport + // An array of objects that define the tags (keys and values) that are associated + // with the predictive inbox placement test. + Tags []*types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_GetEmailIdentity.go b/service/sesv2/api_op_GetEmailIdentity.go index 54ef0c3556e..52941d09fd3 100644 --- a/service/sesv2/api_op_GetEmailIdentity.go +++ b/service/sesv2/api_op_GetEmailIdentity.go @@ -69,12 +69,8 @@ type GetEmailIdentityInput struct { // Details about an email identity. type GetEmailIdentityOutput struct { - // The email identity type. - IdentityType types.IdentityType - - // An object that contains information about the Mail-From attributes for the email - // identity. - MailFromAttributes *types.MailFromAttributes + // An object that contains information about the DKIM attributes for the identity. + DkimAttributes *types.DkimAttributes // The feedback forwarding configuration for the identity. If the value is true, // you receive email notifications when bounce or complaint events occur. These @@ -86,15 +82,19 @@ type GetEmailIdentityOutput struct { // this setting is disabled). FeedbackForwardingStatus *bool - // An array of objects that define the tags (keys and values) that are associated - // with the email identity. - Tags []*types.Tag + // The email identity type. + IdentityType types.IdentityType + + // An object that contains information about the Mail-From attributes for the email + // identity. + MailFromAttributes *types.MailFromAttributes // A map of policy names to policies. Policies map[string]*string - // An object that contains information about the DKIM attributes for the identity. - DkimAttributes *types.DkimAttributes + // An array of objects that define the tags (keys and values) that are associated + // with the email identity. + Tags []*types.Tag // Specifies whether or not the identity is verified. You can only send email from // verified email addresses or domains. For more information about verifying diff --git a/service/sesv2/api_op_GetEmailTemplate.go b/service/sesv2/api_op_GetEmailTemplate.go index f2717788c86..ca6dc4cd5c5 100644 --- a/service/sesv2/api_op_GetEmailTemplate.go +++ b/service/sesv2/api_op_GetEmailTemplate.go @@ -70,17 +70,17 @@ type GetEmailTemplateInput struct { // The following element is returned by the service. type GetEmailTemplateOutput struct { - // The name of the template you want to retrieve. - // - // This member is required. - TemplateName *string - // The content of the email template, composed of a subject line, an HTML part, and // a text-only part. // // This member is required. TemplateContent *types.EmailTemplateContent + // The name of the template you want to retrieve. + // + // This member is required. + TemplateName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sesv2/api_op_ListConfigurationSets.go b/service/sesv2/api_op_ListConfigurationSets.go index 731066d5c61..aff1d002210 100644 --- a/service/sesv2/api_op_ListConfigurationSets.go +++ b/service/sesv2/api_op_ListConfigurationSets.go @@ -62,15 +62,15 @@ func (c *Client) ListConfigurationSets(ctx context.Context, params *ListConfigur // the current AWS Region. type ListConfigurationSetsInput struct { + // A token returned from a previous call to ListConfigurationSets to indicate the + // position in the list of configuration sets. + NextToken *string + // The number of results to show in a single call to ListConfigurationSets. If the // number of results is larger than the number you specified in this parameter, // then the response includes a NextToken element, which you can use to obtain // additional results. PageSize *int32 - - // A token returned from a previous call to ListConfigurationSets to indicate the - // position in the list of configuration sets. - NextToken *string } // A list of configuration sets in your Amazon SES account in the current AWS diff --git a/service/sesv2/api_op_ListCustomVerificationEmailTemplates.go b/service/sesv2/api_op_ListCustomVerificationEmailTemplates.go index 920c93220e2..b9b5fe7b3c3 100644 --- a/service/sesv2/api_op_ListCustomVerificationEmailTemplates.go +++ b/service/sesv2/api_op_ListCustomVerificationEmailTemplates.go @@ -63,16 +63,16 @@ func (c *Client) ListCustomVerificationEmailTemplates(ctx context.Context, param // for your account. type ListCustomVerificationEmailTemplatesInput struct { + // A token returned from a previous call to ListCustomVerificationEmailTemplates to + // indicate the position in the list of custom verification email templates. + NextToken *string + // The number of results to show in a single call to // ListCustomVerificationEmailTemplates. If the number of results is larger than // the number you specified in this parameter, then the response includes a // NextToken element, which you can use to obtain additional results. The value you // specify has to be at least 1, and can be no more than 50. PageSize *int32 - - // A token returned from a previous call to ListCustomVerificationEmailTemplates to - // indicate the position in the list of custom verification email templates. - NextToken *string } // The following elements are returned by the service. diff --git a/service/sesv2/api_op_ListDedicatedIpPools.go b/service/sesv2/api_op_ListDedicatedIpPools.go index 40596005b5e..fa202f97b9e 100644 --- a/service/sesv2/api_op_ListDedicatedIpPools.go +++ b/service/sesv2/api_op_ListDedicatedIpPools.go @@ -71,15 +71,15 @@ type ListDedicatedIpPoolsInput struct { // A list of dedicated IP pools. type ListDedicatedIpPoolsOutput struct { + // A list of all of the dedicated IP pools that are associated with your AWS + // account in the current Region. + DedicatedIpPools []*string + // A token that indicates that there are additional IP pools to list. To view // additional IP pools, issue another request to ListDedicatedIpPools, passing this // token in the NextToken parameter. NextToken *string - // A list of all of the dedicated IP pools that are associated with your AWS - // account in the current Region. - DedicatedIpPools []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sesv2/api_op_ListDomainDeliverabilityCampaigns.go b/service/sesv2/api_op_ListDomainDeliverabilityCampaigns.go index 9efd2acedb6..cf161c6daa4 100644 --- a/service/sesv2/api_op_ListDomainDeliverabilityCampaigns.go +++ b/service/sesv2/api_op_ListDomainDeliverabilityCampaigns.go @@ -63,12 +63,6 @@ func (c *Client) ListDomainDeliverabilityCampaigns(ctx context.Context, params * // only if you enabled the Deliverability dashboard. type ListDomainDeliverabilityCampaignsInput struct { - // The maximum number of results to include in response to a single call to the - // ListDomainDeliverabilityCampaigns operation. If the number of results is larger - // than the number that you specify in this parameter, the response includes a - // NextToken element, which you can use to obtain additional results. - PageSize *int32 - // The last day, in Unix time format, that you want to obtain deliverability data // for. This value has to be less than or equal to 30 days after the value of the // StartDate parameter. @@ -76,21 +70,27 @@ type ListDomainDeliverabilityCampaignsInput struct { // This member is required. EndDate *time.Time - // The domain to obtain deliverability data for. - // - // This member is required. - SubscribedDomain *string - // The first day, in Unix time format, that you want to obtain deliverability data // for. // // This member is required. StartDate *time.Time + // The domain to obtain deliverability data for. + // + // This member is required. + SubscribedDomain *string + // A token that’s returned from a previous call to the // ListDomainDeliverabilityCampaigns operation. This token indicates the position // of a campaign in the list of campaigns. NextToken *string + + // The maximum number of results to include in response to a single call to the + // ListDomainDeliverabilityCampaigns operation. If the number of results is larger + // than the number that you specify in this parameter, the response includes a + // NextToken element, which you can use to obtain additional results. + PageSize *int32 } // An array of objects that provide deliverability data for all the campaigns that diff --git a/service/sesv2/api_op_ListSuppressedDestinations.go b/service/sesv2/api_op_ListSuppressedDestinations.go index 5a689408ff1..3c0ce261124 100644 --- a/service/sesv2/api_op_ListSuppressedDestinations.go +++ b/service/sesv2/api_op_ListSuppressedDestinations.go @@ -87,16 +87,16 @@ type ListSuppressedDestinationsInput struct { // A list of suppressed email addresses. type ListSuppressedDestinationsOutput struct { - // A list of summaries, each containing a summary for a suppressed email - // destination. - SuppressedDestinationSummaries []*types.SuppressedDestinationSummary - // A token that indicates that there are additional email addresses on the // suppression list for your account. To view additional suppressed addresses, // issue another request to ListSuppressedDestinations, and pass this token in the // NextToken parameter. NextToken *string + // A list of summaries, each containing a summary for a suppressed email + // destination. + SuppressedDestinationSummaries []*types.SuppressedDestinationSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sesv2/api_op_PutAccountDetails.go b/service/sesv2/api_op_PutAccountDetails.go index fb127e678d7..59ea1d9f258 100644 --- a/service/sesv2/api_op_PutAccountDetails.go +++ b/service/sesv2/api_op_PutAccountDetails.go @@ -58,39 +58,39 @@ func (c *Client) PutAccountDetails(ctx context.Context, params *PutAccountDetail // A request to submit new account details. type PutAccountDetailsInput struct { - // Indicates whether or not your account should have production access in the - // current AWS Region. If the value is false, then your account is in the sandbox. - // When your account is in the sandbox, you can only send email to verified - // identities. Additionally, the maximum number of emails you can send in a 24-hour - // period (your sending quota) is 200, and the maximum number of emails you can - // send per second (your maximum sending rate) is 1. If the value is true, then - // your account has production access. When your account has production access, you - // can send email to any address. The sending quota and maximum sending rate for - // your account vary based on your specific use case. - ProductionAccessEnabled *bool - // The type of email your account will send. // // This member is required. MailType types.MailType - // The language you would prefer to be contacted with. - ContactLanguage types.ContactLanguage - // A description of the types of email that you plan to send. // // This member is required. UseCaseDescription *string - // Additional email addresses that you would like to be notified regarding Amazon - // SES matters. - AdditionalContactEmailAddresses []*string - // The URL of your website. This information helps us better understand the type of // content that you plan to send. // // This member is required. WebsiteURL *string + + // Additional email addresses that you would like to be notified regarding Amazon + // SES matters. + AdditionalContactEmailAddresses []*string + + // The language you would prefer to be contacted with. + ContactLanguage types.ContactLanguage + + // Indicates whether or not your account should have production access in the + // current AWS Region. If the value is false, then your account is in the sandbox. + // When your account is in the sandbox, you can only send email to verified + // identities. Additionally, the maximum number of emails you can send in a 24-hour + // period (your sending quota) is 200, and the maximum number of emails you can + // send per second (your maximum sending rate) is 1. If the value is true, then + // your account has production access. When your account has production access, you + // can send email to any address. The sending quota and maximum sending rate for + // your account vary based on your specific use case. + ProductionAccessEnabled *bool } // An HTTP 200 response if the request succeeds, or an error message if the request diff --git a/service/sesv2/api_op_PutConfigurationSetDeliveryOptions.go b/service/sesv2/api_op_PutConfigurationSetDeliveryOptions.go index d1dc6c6e14e..c5d427d15f8 100644 --- a/service/sesv2/api_op_PutConfigurationSetDeliveryOptions.go +++ b/service/sesv2/api_op_PutConfigurationSetDeliveryOptions.go @@ -60,6 +60,12 @@ func (c *Client) PutConfigurationSetDeliveryOptions(ctx context.Context, params // A request to associate a configuration set with a dedicated IP pool. type PutConfigurationSetDeliveryOptionsInput struct { + // The name of the configuration set that you want to associate with a dedicated IP + // pool. + // + // This member is required. + ConfigurationSetName *string + // The name of the dedicated IP pool that you want to associate with the // configuration set. SendingPoolName *string @@ -70,12 +76,6 @@ type PutConfigurationSetDeliveryOptionsInput struct { // messages can be delivered in plain text if a TLS connection can't be // established. TlsPolicy types.TlsPolicy - - // The name of the configuration set that you want to associate with a dedicated IP - // pool. - // - // This member is required. - ConfigurationSetName *string } // An HTTP 200 response if the request succeeds, or an error message if the request diff --git a/service/sesv2/api_op_PutConfigurationSetSuppressionOptions.go b/service/sesv2/api_op_PutConfigurationSetSuppressionOptions.go index 1a244ce84b1..6bea7e02d38 100644 --- a/service/sesv2/api_op_PutConfigurationSetSuppressionOptions.go +++ b/service/sesv2/api_op_PutConfigurationSetSuppressionOptions.go @@ -59,6 +59,12 @@ func (c *Client) PutConfigurationSetSuppressionOptions(ctx context.Context, para // configuration set. type PutConfigurationSetSuppressionOptionsInput struct { + // The name of the configuration set that you want to change the suppression list + // preferences for. + // + // This member is required. + ConfigurationSetName *string + // A list that contains the reasons that email addresses are automatically added to // the suppression list for your account. This list can contain any or all of the // following: @@ -71,12 +77,6 @@ type PutConfigurationSetSuppressionOptionsInput struct { // list for your account when a message sent to that address results in a hard // bounce. SuppressedReasons []types.SuppressionListReason - - // The name of the configuration set that you want to change the suppression list - // preferences for. - // - // This member is required. - ConfigurationSetName *string } // An HTTP 200 response if the request succeeds, or an error message if the request diff --git a/service/sesv2/api_op_PutConfigurationSetTrackingOptions.go b/service/sesv2/api_op_PutConfigurationSetTrackingOptions.go index 349f577860c..4f17b6e9111 100644 --- a/service/sesv2/api_op_PutConfigurationSetTrackingOptions.go +++ b/service/sesv2/api_op_PutConfigurationSetTrackingOptions.go @@ -59,14 +59,14 @@ func (c *Client) PutConfigurationSetTrackingOptions(ctx context.Context, params // configuration set. type PutConfigurationSetTrackingOptionsInput struct { - // The domain that you want to use to track open and click events. - CustomRedirectDomain *string - // The name of the configuration set that you want to add a custom tracking domain // to. // // This member is required. ConfigurationSetName *string + + // The domain that you want to use to track open and click events. + CustomRedirectDomain *string } // An HTTP 200 response if the request succeeds, or an error message if the request diff --git a/service/sesv2/api_op_PutDedicatedIpInPool.go b/service/sesv2/api_op_PutDedicatedIpInPool.go index c8b4c35e04b..c96c654e77c 100644 --- a/service/sesv2/api_op_PutDedicatedIpInPool.go +++ b/service/sesv2/api_op_PutDedicatedIpInPool.go @@ -61,18 +61,18 @@ func (c *Client) PutDedicatedIpInPool(ctx context.Context, params *PutDedicatedI // A request to move a dedicated IP address to a dedicated IP pool. type PutDedicatedIpInPoolInput struct { + // The name of the IP pool that you want to add the dedicated IP address to. You + // have to specify an IP pool that already exists. + // + // This member is required. + DestinationPoolName *string + // The IP address that you want to move to the dedicated IP pool. The value you // specify has to be a dedicated IP address that's associated with your AWS // account. // // This member is required. Ip *string - - // The name of the IP pool that you want to add the dedicated IP address to. You - // have to specify an IP pool that already exists. - // - // This member is required. - DestinationPoolName *string } // An HTTP 200 response if the request succeeds, or an error message if the request diff --git a/service/sesv2/api_op_PutDeliverabilityDashboardOption.go b/service/sesv2/api_op_PutDeliverabilityDashboardOption.go index e5a3556ea71..3727205b32a 100644 --- a/service/sesv2/api_op_PutDeliverabilityDashboardOption.go +++ b/service/sesv2/api_op_PutDeliverabilityDashboardOption.go @@ -74,15 +74,15 @@ func (c *Client) PutDeliverabilityDashboardOption(ctx context.Context, params *P // (http://aws.amazon.com/pinpoint/pricing/). type PutDeliverabilityDashboardOptionInput struct { - // An array of objects, one for each verified domain that you use to send email and - // enabled the Deliverability dashboard for. - SubscribedDomains []*types.DomainDeliverabilityTrackingOption - // Specifies whether to enable the Deliverability dashboard. To enable the // dashboard, set this value to true. // // This member is required. DashboardEnabled *bool + + // An array of objects, one for each verified domain that you use to send email and + // enabled the Deliverability dashboard for. + SubscribedDomains []*types.DomainDeliverabilityTrackingOption } // A response that indicates whether the Deliverability dashboard is enabled. diff --git a/service/sesv2/api_op_PutEmailIdentityDkimSigningAttributes.go b/service/sesv2/api_op_PutEmailIdentityDkimSigningAttributes.go index c9301694f77..d492d1bb712 100644 --- a/service/sesv2/api_op_PutEmailIdentityDkimSigningAttributes.go +++ b/service/sesv2/api_op_PutEmailIdentityDkimSigningAttributes.go @@ -74,6 +74,11 @@ func (c *Client) PutEmailIdentityDkimSigningAttributes(ctx context.Context, para // A request to change the DKIM attributes for an email identity. type PutEmailIdentityDkimSigningAttributesInput struct { + // The email identity that you want to configure DKIM for. + // + // This member is required. + EmailIdentity *string + // The method that you want to use to configure DKIM for the identity. There are // two possible values: // @@ -92,30 +97,12 @@ type PutEmailIdentityDkimSigningAttributesInput struct { // want to use to configure DKIM for the identity. This object is only required if // you want to configure Bring Your Own DKIM (BYODKIM) for the identity. SigningAttributes *types.DkimSigningAttributes - - // The email identity that you want to configure DKIM for. - // - // This member is required. - EmailIdentity *string } // If the action is successful, the service sends back an HTTP 200 response. The // following data is returned in JSON format by the service. type PutEmailIdentityDkimSigningAttributesOutput struct { - // If you used Easy DKIM - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) to - // configure DKIM authentication for the domain, then this object contains a set of - // unique strings that you use to create a set of CNAME records that you add to the - // DNS configuration for your domain. When Amazon SES detects these records in the - // DNS configuration for your domain, the DKIM authentication process is complete. - // If you configured DKIM authentication for the domain by providing your own - // public-private key pair, then this object contains the selector that's - // associated with your public key. Regardless of the DKIM authentication method - // you use, Amazon SES searches for the appropriate records in the DNS - // configuration of the domain for up to 72 hours. - DkimTokens []*string - // The DKIM authentication status of the identity. Amazon SES determines the // authentication status by searching for specific records in the DNS configuration // for your domain. If you used Easy DKIM @@ -146,6 +133,19 @@ type PutEmailIdentityDkimSigningAttributesOutput struct { // process hasn't been initiated for the domain. DkimStatus types.DkimStatus + // If you used Easy DKIM + // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) to + // configure DKIM authentication for the domain, then this object contains a set of + // unique strings that you use to create a set of CNAME records that you add to the + // DNS configuration for your domain. When Amazon SES detects these records in the + // DNS configuration for your domain, the DKIM authentication process is complete. + // If you configured DKIM authentication for the domain by providing your own + // public-private key pair, then this object contains the selector that's + // associated with your public key. Regardless of the DKIM authentication method + // you use, Amazon SES searches for the appropriate records in the DNS + // configuration of the domain for up to 72 hours. + DkimTokens []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sesv2/api_op_PutEmailIdentityFeedbackAttributes.go b/service/sesv2/api_op_PutEmailIdentityFeedbackAttributes.go index f3dfde8b975..4cac368e656 100644 --- a/service/sesv2/api_op_PutEmailIdentityFeedbackAttributes.go +++ b/service/sesv2/api_op_PutEmailIdentityFeedbackAttributes.go @@ -66,6 +66,12 @@ func (c *Client) PutEmailIdentityFeedbackAttributes(ctx context.Context, params // processed. type PutEmailIdentityFeedbackAttributesInput struct { + // The email identity that you want to configure bounce and complaint feedback + // forwarding for. + // + // This member is required. + EmailIdentity *string + // Sets the feedback forwarding configuration for the identity. If the value is // true, you receive email notifications when bounce or complaint events occur. // These notifications are sent to the address that you specified in the @@ -75,12 +81,6 @@ type PutEmailIdentityFeedbackAttributesInput struct { // destination), you receive an email notification when these events occur (even if // this setting is disabled). EmailForwardingEnabled *bool - - // The email identity that you want to configure bounce and complaint feedback - // forwarding for. - // - // This member is required. - EmailIdentity *string } // An HTTP 200 response if the request succeeds, or an error message if the request diff --git a/service/sesv2/api_op_SendBulkEmail.go b/service/sesv2/api_op_SendBulkEmail.go index 2d53ef984d0..8723f6e627e 100644 --- a/service/sesv2/api_op_SendBulkEmail.go +++ b/service/sesv2/api_op_SendBulkEmail.go @@ -60,31 +60,6 @@ func (c *Client) SendBulkEmail(ctx context.Context, params *SendBulkEmailInput, // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html). type SendBulkEmailInput struct { - // A list of tags, in the form of name/value pairs, to apply to an email that you - // send using the SendEmail operation. Tags correspond to characteristics of the - // email that you define, so that you can publish email sending events. - DefaultEmailTags []*types.MessageTag - - // The name of the configuration set that you want to use when sending the email. - ConfigurationSetName *string - - // The "Reply-to" email addresses for the message. When the recipient replies to - // the message, each Reply-to address receives the reply. - ReplyToAddresses []*string - - // This parameter is used only for sending authorization. It is the ARN of the - // identity that is associated with the sending authorization policy that permits - // you to use the email address specified in the FromEmailAddress parameter. For - // example, if the owner of example.com (which has ARN - // arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it - // that authorizes you to use sender@example.com, then you would specify the - // FromEmailAddressIdentityArn to be - // arn:aws:ses:us-east-1:123456789012:identity/example.com, and the - // FromEmailAddress to be sender@example.com. For more information about sending - // authorization, see the Amazon SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). - FromEmailAddressIdentityArn *string - // The list of bulk email entry objects. // // This member is required. @@ -96,6 +71,17 @@ type SendBulkEmailInput struct { // This member is required. DefaultContent *types.BulkEmailContent + // The name of the configuration set that you want to use when sending the email. + ConfigurationSetName *string + + // A list of tags, in the form of name/value pairs, to apply to an email that you + // send using the SendEmail operation. Tags correspond to characteristics of the + // email that you define, so that you can publish email sending events. + DefaultEmailTags []*types.MessageTag + + // The address that you want bounce and complaint notifications to be sent to. + FeedbackForwardingEmailAddress *string + // This parameter is used only for sending authorization. It is the ARN of the // identity that is associated with the sending authorization policy that permits // you to use the email address specified in the FeedbackForwardingEmailAddress @@ -109,12 +95,26 @@ type SendBulkEmailInput struct { // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). FeedbackForwardingEmailAddressIdentityArn *string - // The address that you want bounce and complaint notifications to be sent to. - FeedbackForwardingEmailAddress *string - // The email address that you want to use as the "From" address for the email. The // address that you specify has to be verified. FromEmailAddress *string + + // This parameter is used only for sending authorization. It is the ARN of the + // identity that is associated with the sending authorization policy that permits + // you to use the email address specified in the FromEmailAddress parameter. For + // example, if the owner of example.com (which has ARN + // arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it + // that authorizes you to use sender@example.com, then you would specify the + // FromEmailAddressIdentityArn to be + // arn:aws:ses:us-east-1:123456789012:identity/example.com, and the + // FromEmailAddress to be sender@example.com. For more information about sending + // authorization, see the Amazon SES Developer Guide + // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + FromEmailAddressIdentityArn *string + + // The "Reply-to" email addresses for the message. When the recipient replies to + // the message, each Reply-to address receives the reply. + ReplyToAddresses []*string } // The following data is returned in JSON format by the service. diff --git a/service/sesv2/api_op_SendCustomVerificationEmail.go b/service/sesv2/api_op_SendCustomVerificationEmail.go index 27d9e386eba..9738a22eb24 100644 --- a/service/sesv2/api_op_SendCustomVerificationEmail.go +++ b/service/sesv2/api_op_SendCustomVerificationEmail.go @@ -71,14 +71,14 @@ type SendCustomVerificationEmailInput struct { // This member is required. EmailAddress *string - // Name of a configuration set to use when sending the verification email. - ConfigurationSetName *string - // The name of the custom verification email template to use when sending the // verification email. // // This member is required. TemplateName *string + + // Name of a configuration set to use when sending the verification email. + ConfigurationSetName *string } // The following element is returned by the service. diff --git a/service/sesv2/api_op_SendEmail.go b/service/sesv2/api_op_SendEmail.go index bc3805e4cb6..96f79edd8bc 100644 --- a/service/sesv2/api_op_SendEmail.go +++ b/service/sesv2/api_op_SendEmail.go @@ -75,36 +75,26 @@ func (c *Client) SendEmail(ctx context.Context, params *SendEmailInput, optFns . // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-formatted.html). type SendEmailInput struct { - // The "Reply-to" email addresses for the message. When the recipient replies to - // the message, each Reply-to address receives the reply. - ReplyToAddresses []*string + // An object that contains the body of the message. You can send either a Simple + // message Raw message or a template Message. + // + // This member is required. + Content *types.EmailContent // The name of the configuration set that you want to use when sending the email. ConfigurationSetName *string - // This parameter is used only for sending authorization. It is the ARN of the - // identity that is associated with the sending authorization policy that permits - // you to use the email address specified in the FromEmailAddress parameter. For - // example, if the owner of example.com (which has ARN - // arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it - // that authorizes you to use sender@example.com, then you would specify the - // FromEmailAddressIdentityArn to be - // arn:aws:ses:us-east-1:123456789012:identity/example.com, and the - // FromEmailAddress to be sender@example.com. For more information about sending - // authorization, see the Amazon SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). - // For Raw emails, the FromEmailAddressIdentityArn value overrides the - // X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message - // content. - FromEmailAddressIdentityArn *string + // An object that contains the recipients of the email message. + Destination *types.Destination + + // A list of tags, in the form of name/value pairs, to apply to an email that you + // send using the SendEmail operation. Tags correspond to characteristics of the + // email that you define, so that you can publish email sending events. + EmailTags []*types.MessageTag // The address that you want bounce and complaint notifications to be sent to. FeedbackForwardingEmailAddress *string - // The email address that you want to use as the "From" address for the email. The - // address that you specify has to be verified. - FromEmailAddress *string - // This parameter is used only for sending authorization. It is the ARN of the // identity that is associated with the sending authorization policy that permits // you to use the email address specified in the FeedbackForwardingEmailAddress @@ -118,19 +108,29 @@ type SendEmailInput struct { // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). FeedbackForwardingEmailAddressIdentityArn *string - // An object that contains the recipients of the email message. - Destination *types.Destination + // The email address that you want to use as the "From" address for the email. The + // address that you specify has to be verified. + FromEmailAddress *string - // An object that contains the body of the message. You can send either a Simple - // message Raw message or a template Message. - // - // This member is required. - Content *types.EmailContent + // This parameter is used only for sending authorization. It is the ARN of the + // identity that is associated with the sending authorization policy that permits + // you to use the email address specified in the FromEmailAddress parameter. For + // example, if the owner of example.com (which has ARN + // arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it + // that authorizes you to use sender@example.com, then you would specify the + // FromEmailAddressIdentityArn to be + // arn:aws:ses:us-east-1:123456789012:identity/example.com, and the + // FromEmailAddress to be sender@example.com. For more information about sending + // authorization, see the Amazon SES Developer Guide + // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + // For Raw emails, the FromEmailAddressIdentityArn value overrides the + // X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message + // content. + FromEmailAddressIdentityArn *string - // A list of tags, in the form of name/value pairs, to apply to an email that you - // send using the SendEmail operation. Tags correspond to characteristics of the - // email that you define, so that you can publish email sending events. - EmailTags []*types.MessageTag + // The "Reply-to" email addresses for the message. When the recipient replies to + // the message, each Reply-to address receives the reply. + ReplyToAddresses []*string } // A unique message ID that you receive when an email is accepted for sending. diff --git a/service/sesv2/api_op_TagResource.go b/service/sesv2/api_op_TagResource.go index 068003ac962..e295092a7e3 100644 --- a/service/sesv2/api_op_TagResource.go +++ b/service/sesv2/api_op_TagResource.go @@ -63,6 +63,12 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { + // The Amazon Resource Name (ARN) of the resource that you want to add one or more + // tags to. + // + // This member is required. + ResourceArn *string + // A list of the tags that you want to add to the resource. A tag consists of a // required tag key (Key) and an associated tag value (Value). The maximum length // of a tag key is 128 characters. The maximum length of a tag value is 256 @@ -70,12 +76,6 @@ type TagResourceInput struct { // // This member is required. Tags []*types.Tag - - // The Amazon Resource Name (ARN) of the resource that you want to add one or more - // tags to. - // - // This member is required. - ResourceArn *string } type TagResourceOutput struct { diff --git a/service/sesv2/api_op_UpdateCustomVerificationEmailTemplate.go b/service/sesv2/api_op_UpdateCustomVerificationEmailTemplate.go index 18bf3a50e1d..ef1e4c76bd7 100644 --- a/service/sesv2/api_op_UpdateCustomVerificationEmailTemplate.go +++ b/service/sesv2/api_op_UpdateCustomVerificationEmailTemplate.go @@ -62,27 +62,17 @@ func (c *Client) UpdateCustomVerificationEmailTemplate(ctx context.Context, para // Represents a request to update an existing custom verification email template. type UpdateCustomVerificationEmailTemplateInput struct { - // The email address that the custom verification email is sent from. - // - // This member is required. - FromEmailAddress *string - - // The name of the custom verification email template that you want to update. - // - // This member is required. - TemplateName *string - - // The subject line of the custom verification email. - // - // This member is required. - TemplateSubject *string - // The URL that the recipient of the verification email is sent to if his or her // address is not successfully verified. // // This member is required. FailureRedirectionURL *string + // The email address that the custom verification email is sent from. + // + // This member is required. + FromEmailAddress *string + // The URL that the recipient of the verification email is sent to if his or her // address is successfully verified. // @@ -97,6 +87,16 @@ type UpdateCustomVerificationEmailTemplateInput struct { // // This member is required. TemplateContent *string + + // The name of the custom verification email template that you want to update. + // + // This member is required. + TemplateName *string + + // The subject line of the custom verification email. + // + // This member is required. + TemplateSubject *string } // If the action is successful, the service sends back an HTTP 200 response with an diff --git a/service/sesv2/api_op_UpdateEmailIdentityPolicy.go b/service/sesv2/api_op_UpdateEmailIdentityPolicy.go index 7566e24383e..6dfbcb909af 100644 --- a/service/sesv2/api_op_UpdateEmailIdentityPolicy.go +++ b/service/sesv2/api_op_UpdateEmailIdentityPolicy.go @@ -69,12 +69,6 @@ func (c *Client) UpdateEmailIdentityPolicy(ctx context.Context, params *UpdateEm // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html). type UpdateEmailIdentityPolicyInput struct { - // The name of the policy.

    The policy name cannot exceed 64 characters and can - // only include alphanumeric characters, dashes, and underscores.

    - // - // This member is required. - PolicyName *string - // The email identity for which you want to update policy. // // This member is required. @@ -87,6 +81,12 @@ type UpdateEmailIdentityPolicyInput struct { // // This member is required. Policy *string + + // The name of the policy.

    The policy name cannot exceed 64 characters and can + // only include alphanumeric characters, dashes, and underscores.

    + // + // This member is required. + PolicyName *string } // An HTTP 200 response if the request succeeds, or an error message if the request diff --git a/service/sesv2/api_op_UpdateEmailTemplate.go b/service/sesv2/api_op_UpdateEmailTemplate.go index 85ed6c93cb3..c39bf381f4b 100644 --- a/service/sesv2/api_op_UpdateEmailTemplate.go +++ b/service/sesv2/api_op_UpdateEmailTemplate.go @@ -64,16 +64,16 @@ func (c *Client) UpdateEmailTemplate(ctx context.Context, params *UpdateEmailTem // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html). type UpdateEmailTemplateInput struct { - // The name of the template you want to update. - // - // This member is required. - TemplateName *string - // The content of the email template, composed of a subject line, an HTML part, and // a text-only part. // // This member is required. TemplateContent *types.EmailTemplateContent + + // The name of the template you want to update. + // + // This member is required. + TemplateName *string } // If the action is successful, the service sends back an HTTP 200 response with an diff --git a/service/sesv2/go.mod b/service/sesv2/go.mod index 36e1048ac4a..0fbb91fb98c 100644 --- a/service/sesv2/go.mod +++ b/service/sesv2/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/sesv2 go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/sesv2/types/types.go b/service/sesv2/types/types.go index 952e6edfee3..cc1b016939c 100644 --- a/service/sesv2/types/types.go +++ b/service/sesv2/types/types.go @@ -9,6 +9,14 @@ import ( // An object that contains information about your account details. type AccountDetails struct { + // Additional email addresses where updates are sent about your account review + // process. + AdditionalContactEmailAddresses []*string + + // The language you would prefer for the case. The contact language can be one of + // ENGLISH or JAPANESE. + ContactLanguage ContactLanguage + // The type of email your account is sending. The mail type can be one of the // following: // @@ -19,23 +27,15 @@ type AccountDetails struct { // sending traffic is to communicate during a transaction with a customer. MailType MailType - // The URL of your website. This information helps us better understand the type of - // content that you plan to send. - WebsiteURL *string + // Information about the review of the latest details you submitted. + ReviewDetails *ReviewDetails // A description of the types of email that you plan to send. UseCaseDescription *string - // Additional email addresses where updates are sent about your account review - // process. - AdditionalContactEmailAddresses []*string - - // The language you would prefer for the case. The contact language can be one of - // ENGLISH or JAPANESE. - ContactLanguage ContactLanguage - - // Information about the review of the latest details you submitted. - ReviewDetails *ReviewDetails + // The URL of your website. This information helps us better understand the type of + // content that you plan to send. + WebsiteURL *string } // An object that contains information about a blacklisting event that impacts one @@ -103,14 +103,14 @@ type BulkEmailEntry struct { // The result of the SendBulkEmail operation of each specified BulkEmailEntry. type BulkEmailEntryResult struct { - // The unique message identifier returned from the SendBulkTemplatedEmail - // operation. - MessageId *string - // A description of an error that prevented a message being sent using the // SendBulkTemplatedEmail operation. Error *string + // The unique message identifier returned from the SendBulkTemplatedEmail + // operation. + MessageId *string + // The status of a message sent using the SendBulkTemplatedEmail operation. // Possible values for this parameter include: // @@ -239,19 +239,19 @@ type Content struct { type CustomVerificationEmailTemplateMetadata struct { // The URL that the recipient of the verification email is sent to if his or her - // address is successfully verified. - SuccessRedirectionURL *string + // address is not successfully verified. + FailureRedirectionURL *string // The email address that the custom verification email is sent from. FromEmailAddress *string + // The URL that the recipient of the verification email is sent to if his or her + // address is successfully verified. + SuccessRedirectionURL *string + // The name of the custom verification email template. TemplateName *string - // The URL that the recipient of the verification email is sent to if his or her - // address is not successfully verified. - FailureRedirectionURL *string - // The subject line of the custom verification email. TemplateSubject *string } @@ -279,6 +279,17 @@ type DailyVolume struct { // in the Amazon SES Developer Guide. type DedicatedIp struct { + // An IPv4 address. + // + // This member is required. + Ip *string + + // Indicates how complete the dedicated IP warm-up process is. When this value + // equals 1, the address has completed the warm-up process and is ready for use. + // + // This member is required. + WarmupPercentage *int32 + // The warm-up status of a dedicated IP address. The status can have one of the // following values: // @@ -291,24 +302,17 @@ type DedicatedIp struct { // This member is required. WarmupStatus WarmupStatus - // An IPv4 address. - // - // This member is required. - Ip *string - // The name of the dedicated IP pool that the IP address is associated with. PoolName *string - - // Indicates how complete the dedicated IP warm-up process is. When this value - // equals 1, the address has completed the warm-up process and is ready for use. - // - // This member is required. - WarmupPercentage *int32 } // An object that contains metadata related to a predictive inbox placement test. type DeliverabilityTestReport struct { + // The date and time when the predictive inbox placement test was created, in Unix + // time format. + CreateDate *time.Time + // The status of the predictive inbox placement test. If the status is IN_PROGRESS, // then the predictive inbox placement test is currently running. Predictive inbox // placement tests are usually complete within 24 hours of creating the test. If @@ -319,19 +323,15 @@ type DeliverabilityTestReport struct { // The sender address that you specified for the predictive inbox placement test. FromEmailAddress *string + // A unique string that identifies the predictive inbox placement test. + ReportId *string + // A name that helps you identify a predictive inbox placement test report. ReportName *string // The subject line for an email that you submitted in a predictive inbox placement // test. Subject *string - - // A unique string that identifies the predictive inbox placement test. - ReportId *string - - // The date and time when the predictive inbox placement test was created, in Unix - // time format. - CreateDate *time.Time } // Used to associate a configuration set with a dedicated IP pool. @@ -352,9 +352,6 @@ type DeliveryOptions struct { // An object that describes the recipients for an email. type Destination struct { - // An array that contains the email addresses of the "To" recipients for the email. - ToAddresses []*string - // An array that contains the email addresses of the "BCC" (blind carbon copy) // recipients for the email. BccAddresses []*string @@ -362,6 +359,9 @@ type Destination struct { // An array that contains the email addresses of the "CC" (carbon copy) recipients // for the email. CcAddresses []*string + + // An array that contains the email addresses of the "To" recipients for the email. + ToAddresses []*string } // An object that contains information about the DKIM authentication status for an @@ -376,19 +376,6 @@ type Destination struct { // identity type DkimAttributes struct { - // If you used Easy DKIM - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) to - // configure DKIM authentication for the domain, then this object contains a set of - // unique strings that you use to create a set of CNAME records that you add to the - // DNS configuration for your domain. When Amazon SES detects these records in the - // DNS configuration for your domain, the DKIM authentication process is complete. - // If you configured DKIM authentication for the domain by providing your own - // public-private key pair, then this object contains the selector for the public - // key. Regardless of the DKIM authentication method you use, Amazon SES searches - // for the appropriate records in the DNS configuration of the domain for up to 72 - // hours. - Tokens []*string - // A string that indicates how DKIM was configured for the identity. There are two // possible values: // @@ -401,6 +388,11 @@ type DkimAttributes struct { // Your Own DKIM (BYODKIM). SigningAttributesOrigin DkimSigningAttributesOrigin + // If the value is true, then the messages that you send from the identity are + // signed using DKIM. If the value is false, then the messages that you send from + // the identity aren't DKIM-signed. + SigningEnabled *bool + // Describes whether or not Amazon SES has successfully located the DKIM records in // the DNS records for the domain. The status can be one of the following: // @@ -423,27 +415,35 @@ type DkimAttributes struct { // verification process hasn't been initiated for the domain. Status DkimStatus - // If the value is true, then the messages that you send from the identity are - // signed using DKIM. If the value is false, then the messages that you send from - // the identity aren't DKIM-signed. - SigningEnabled *bool + // If you used Easy DKIM + // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) to + // configure DKIM authentication for the domain, then this object contains a set of + // unique strings that you use to create a set of CNAME records that you add to the + // DNS configuration for your domain. When Amazon SES detects these records in the + // DNS configuration for your domain, the DKIM authentication process is complete. + // If you configured DKIM authentication for the domain by providing your own + // public-private key pair, then this object contains the selector for the public + // key. Regardless of the DKIM authentication method you use, Amazon SES searches + // for the appropriate records in the DNS configuration of the domain for up to 72 + // hours. + Tokens []*string } // An object that contains information about the tokens used for setting up Bring // Your Own DKIM (BYODKIM). type DkimSigningAttributes struct { - // A string that's used to identify a public key in the DNS configuration for a - // domain. - // - // This member is required. - DomainSigningSelector *string - // A private key that's used to generate a DKIM signature. The private key must use // 1024-bit RSA encryption, and must be encoded using base64 encoding. // // This member is required. DomainSigningPrivateKey *string + + // A string that's used to identify a public key in the DNS configuration for a + // domain. + // + // This member is required. + DomainSigningSelector *string } // An object that contains the deliverability data for a specific campaign. This @@ -452,19 +452,49 @@ type DkimSigningAttributes struct { // (PutDeliverabilityDashboardOption operation). type DomainDeliverabilityCampaign struct { - // The number of email messages that were delivered to recipients’ inboxes. - InboxCount *int64 + // The unique identifier for the campaign. The Deliverability dashboard + // automatically generates and assigns this identifier to a campaign. + CampaignId *string + + // The percentage of email messages that were deleted by recipients, without being + // opened first. Due to technical limitations, this value only includes recipients + // who opened the message by using an email client that supports images. + DeleteRate *float64 + + // The major email providers who handled the email message. + Esps []*string + + // The first time, in Unix time format, when the email message was delivered to any + // recipient's inbox. This value can help you determine how long it took for a + // campaign to deliver an email message. + FirstSeenDateTime *time.Time + + // The verified email address that the email message was sent from. + FromAddress *string // The URL of an image that contains a snapshot of the email message that was sent. ImageUrl *string + // The number of email messages that were delivered to recipients’ inboxes. + InboxCount *int64 + + // The last time, in Unix time format, when the email message was delivered to any + // recipient's inbox. This value can help you determine how long it took for a + // campaign to deliver an email message. + LastSeenDateTime *time.Time + + // The projected number of recipients that the email message was sent to. + ProjectedVolume *int64 + // The percentage of email messages that were opened and then deleted by // recipients. Due to technical limitations, this value only includes recipients // who opened the message by using an email client that supports images. ReadDeleteRate *float64 - // The projected number of recipients that the email message was sent to. - ProjectedVolume *int64 + // The percentage of email messages that were opened by recipients. Due to + // technical limitations, this value only includes recipients who opened the + // message by using an email client that supports images. + ReadRate *float64 // The IP addresses that were used to send the email message. SendingIps []*string @@ -473,38 +503,8 @@ type DomainDeliverabilityCampaign struct { // mail folders. SpamCount *int64 - // The percentage of email messages that were opened by recipients. Due to - // technical limitations, this value only includes recipients who opened the - // message by using an email client that supports images. - ReadRate *float64 - - // The unique identifier for the campaign. The Deliverability dashboard - // automatically generates and assigns this identifier to a campaign. - CampaignId *string - - // The major email providers who handled the email message. - Esps []*string - - // The verified email address that the email message was sent from. - FromAddress *string - // The subject line, or title, of the email message. Subject *string - - // The last time, in Unix time format, when the email message was delivered to any - // recipient's inbox. This value can help you determine how long it took for a - // campaign to deliver an email message. - LastSeenDateTime *time.Time - - // The first time, in Unix time format, when the email message was delivered to any - // recipient's inbox. This value can help you determine how long it took for a - // campaign to deliver an email message. - FirstSeenDateTime *time.Time - - // The percentage of email messages that were deleted by recipients, without being - // opened first. Due to technical limitations, this value only includes recipients - // who opened the message by using an email client that supports images. - DeleteRate *float64 } // An object that contains information about the Deliverability dashboard @@ -514,14 +514,14 @@ type DomainDeliverabilityCampaign struct { // placement, and other metrics for the domain. type DomainDeliverabilityTrackingOption struct { - // An object that contains information about the inbox placement data settings for - // the domain. - InboxPlacementTrackingOption *InboxPlacementTrackingOption - // A verified domain that’s associated with your AWS account and currently has an // active Deliverability dashboard subscription. Domain *string + // An object that contains information about the inbox placement data settings for + // the domain. + InboxPlacementTrackingOption *InboxPlacementTrackingOption + // The date, in Unix time format, when you enabled the Deliverability dashboard for // the domain. SubscriptionStartDate *time.Time @@ -531,24 +531,24 @@ type DomainDeliverabilityTrackingOption struct { // email domains to a specific email provider. type DomainIspPlacement struct { - // The name of the email provider that the inbox placement data applies to. - IspName *string - // The percentage of messages that were sent from the selected domain to the // specified email provider that arrived in recipients' inboxes. InboxPercentage *float64 - // The total number of messages that were sent from the selected domain to the - // specified email provider that arrived in recipients' spam or junk mail folders. - SpamRawCount *int64 - // The total number of messages that were sent from the selected domain to the // specified email provider that arrived in recipients' inboxes. InboxRawCount *int64 + // The name of the email provider that the inbox placement data applies to. + IspName *string + // The percentage of messages that were sent from the selected domain to the // specified email provider that arrived in recipients' spam or junk mail folders. SpamPercentage *float64 + + // The total number of messages that were sent from the selected domain to the + // specified email provider that arrived in recipients' spam or junk mail folders. + SpamRawCount *int64 } // An object that defines the entire content of the email, including the message @@ -596,25 +596,25 @@ type EmailContent struct { // text-only part. type EmailTemplateContent struct { - // The email body that will be visible to recipients whose email clients do not - // display HTML. - Text *string + // The HTML body of the email. + Html *string // The subject line of the email. Subject *string - // The HTML body of the email. - Html *string + // The email body that will be visible to recipients whose email clients do not + // display HTML. + Text *string } // Contains information about an email template. type EmailTemplateMetadata struct { - // The name of the template. - TemplateName *string - // The time and date the template was created. CreatedTimestamp *time.Time + + // The name of the template. + TemplateName *string } // In the Amazon SES API v2, events include message sends, deliveries, opens, @@ -625,9 +625,15 @@ type EmailTemplateMetadata struct { // S3 for long-term storage. type EventDestination struct { - // An object that defines an Amazon SNS destination for email events. You can use - // Amazon SNS to send notification when certain email events occur. - SnsDestination *SnsDestination + // The types of events that Amazon SES sends to the specified event destinations. + // + // This member is required. + MatchingEventTypes []EventType + + // A name that identifies the event destination. + // + // This member is required. + Name *string // An object that defines an Amazon CloudWatch destination for email events. You // can use Amazon CloudWatch to monitor and gain insights on your email sending @@ -641,6 +647,11 @@ type EventDestination struct { // destinations. Enabled *bool + // An object that defines an Amazon Kinesis Data Firehose destination for email + // events. You can use Amazon Kinesis Data Firehose to stream data to other + // services, such as Amazon S3 and Amazon Redshift. + KinesisFirehoseDestination *KinesisFirehoseDestination + // An object that defines an Amazon Pinpoint project destination for email events. // You can send email event data to a Amazon Pinpoint project to view metrics using // the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For @@ -649,20 +660,9 @@ type EventDestination struct { // in the Amazon Pinpoint User Guide. PinpointDestination *PinpointDestination - // The types of events that Amazon SES sends to the specified event destinations. - // - // This member is required. - MatchingEventTypes []EventType - - // A name that identifies the event destination. - // - // This member is required. - Name *string - - // An object that defines an Amazon Kinesis Data Firehose destination for email - // events. You can use Amazon Kinesis Data Firehose to stream data to other - // services, such as Amazon S3 and Amazon Redshift. - KinesisFirehoseDestination *KinesisFirehoseDestination + // An object that defines an Amazon SNS destination for email events. You can use + // Amazon SNS to send notification when certain email events occur. + SnsDestination *SnsDestination } // An object that defines the event destination. Specifically, it defines which @@ -671,13 +671,10 @@ type EventDestination struct { // sent to the event destination. type EventDestinationDefinition struct { - // An object that defines an Amazon Pinpoint project destination for email events. - // You can send email event data to a Amazon Pinpoint project to view metrics using - // the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For - // more information, see Transactional Messaging Charts - // (https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html) - // in the Amazon Pinpoint User Guide. - PinpointDestination *PinpointDestination + // An object that defines an Amazon CloudWatch destination for email events. You + // can use Amazon CloudWatch to monitor and gain insights on your email sending + // metrics. + CloudWatchDestination *CloudWatchDestination // If true, the event destination is enabled. When the event destination is // enabled, the specified event types are sent to the destinations in this @@ -686,34 +683,31 @@ type EventDestinationDefinition struct { // destinations. Enabled *bool - // An object that defines an Amazon CloudWatch destination for email events. You - // can use Amazon CloudWatch to monitor and gain insights on your email sending - // metrics. - CloudWatchDestination *CloudWatchDestination - - // An object that defines an Amazon SNS destination for email events. You can use - // Amazon SNS to send notification when certain email events occur. - SnsDestination *SnsDestination + // An object that defines an Amazon Kinesis Data Firehose destination for email + // events. You can use Amazon Kinesis Data Firehose to stream data to other + // services, such as Amazon S3 and Amazon Redshift. + KinesisFirehoseDestination *KinesisFirehoseDestination // An array that specifies which events the Amazon SES API v2 should send to the // destinations in this EventDestinationDefinition. MatchingEventTypes []EventType - // An object that defines an Amazon Kinesis Data Firehose destination for email - // events. You can use Amazon Kinesis Data Firehose to stream data to other - // services, such as Amazon S3 and Amazon Redshift. - KinesisFirehoseDestination *KinesisFirehoseDestination + // An object that defines an Amazon Pinpoint project destination for email events. + // You can send email event data to a Amazon Pinpoint project to view metrics using + // the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For + // more information, see Transactional Messaging Charts + // (https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html) + // in the Amazon Pinpoint User Guide. + PinpointDestination *PinpointDestination + + // An object that defines an Amazon SNS destination for email events. You can use + // Amazon SNS to send notification when certain email events occur. + SnsDestination *SnsDestination } // Information about an email identity. type IdentityInfo struct { - // Indicates whether or not you can send email from the identity. An identity is an - // email address or domain that you send email from. Before you can send email from - // an identity, you have to demostrate that you own the identity, and that you - // authorize Amazon SES to send email from that identity. - SendingEnabled *bool - // The address or domain of the identity. IdentityName *string @@ -728,6 +722,12 @@ type IdentityInfo struct { // * MANAGED_DOMAIN – The identity is a domain that is managed by // AWS. IdentityType IdentityType + + // Indicates whether or not you can send email from the identity. An identity is an + // email address or domain that you send email from. Before you can send email from + // an identity, you have to demostrate that you own the identity, and that you + // authorize Amazon SES to send email from that identity. + SendingEnabled *bool } // An object that contains information about the inbox placement data settings for @@ -759,22 +759,38 @@ type IspPlacement struct { // services, such as Amazon S3 and Amazon Redshift. type KinesisFirehoseDestination struct { - // The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses - // to send email events to the Amazon Kinesis Data Firehose stream. - // - // This member is required. - IamRoleArn *string - // The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that // the Amazon SES API v2 sends email events to. // // This member is required. DeliveryStreamArn *string + + // The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses + // to send email events to the Amazon Kinesis Data Firehose stream. + // + // This member is required. + IamRoleArn *string } // A list of attributes that are associated with a MAIL FROM domain. type MailFromAttributes struct { + // The action that you want to take if the required MX record can't be found when + // you send an email. When you set this value to UseDefaultValue, the mail is sent + // using amazonses.com as the MAIL FROM domain. When you set this value to + // RejectMessage, the Amazon SES API v2 returns a MailFromDomainNotVerified error, + // and doesn't attempt to deliver the email. These behaviors are taken when the + // custom MAIL FROM domain configuration is in the Pending, Failed, and + // TemporaryFailure states. + // + // This member is required. + BehaviorOnMxFailure BehaviorOnMxFailure + + // The name of a domain that an email identity uses as a custom MAIL FROM domain. + // + // This member is required. + MailFromDomain *string + // The status of the MAIL FROM domain. This status can have the following values: // // @@ -792,22 +808,6 @@ type MailFromAttributes struct { // // This member is required. MailFromDomainStatus MailFromDomainStatus - - // The name of a domain that an email identity uses as a custom MAIL FROM domain. - // - // This member is required. - MailFromDomain *string - - // The action that you want to take if the required MX record can't be found when - // you send an email. When you set this value to UseDefaultValue, the mail is sent - // using amazonses.com as the MAIL FROM domain. When you set this value to - // RejectMessage, the Amazon SES API v2 returns a MailFromDomainNotVerified error, - // and doesn't attempt to deliver the email. These behaviors are taken when the - // custom MAIL FROM domain configuration is in the Pending, Failed, and - // TemporaryFailure states. - // - // This member is required. - BehaviorOnMxFailure BehaviorOnMxFailure } // Represents the email message that you're sending. The Message object consists of @@ -833,7 +833,7 @@ type Message struct { // message tags when you publish email sending events. type MessageTag struct { - // The value of the message tag. The message tag value has to meet the following + // The name of the message tag. The message tag name has to meet the following // criteria: // // * It can only contain ASCII letters (a–z, A–Z), numbers (0–9), @@ -843,9 +843,9 @@ type MessageTag struct { // characters. // // This member is required. - Value *string + Name *string - // The name of the message tag. The message tag name has to meet the following + // The value of the message tag. The message tag value has to meet the following // criteria: // // * It can only contain ASCII letters (a–z, A–Z), numbers (0–9), @@ -855,7 +855,7 @@ type MessageTag struct { // characters. // // This member is required. - Name *string + Value *string } // An object that contains information about email that was sent from the selected @@ -866,13 +866,13 @@ type OverallVolume struct { // email providers. DomainIspPlacements []*DomainIspPlacement - // An object that contains information about the numbers of messages that arrived - // in recipients' inboxes and junk mail folders. - VolumeStatistics *VolumeStatistics - // The percentage of emails that were sent from the domain that were read by their // recipients. ReadRatePercent *float64 + + // An object that contains information about the numbers of messages that arrived + // in recipients' inboxes and junk mail folders. + VolumeStatistics *VolumeStatistics } // An object that defines an Amazon Pinpoint project destination for email events. @@ -891,25 +891,25 @@ type PinpointDestination struct { // An object that contains inbox placement data for an email provider. type PlacementStatistics struct { + // The percentage of emails that were authenticated by using DomainKeys Identified + // Mail (DKIM) during the predictive inbox placement test. + DkimPercentage *float64 + // The percentage of emails that arrived in recipients' inboxes during the // predictive inbox placement test. InboxPercentage *float64 - // The percentage of emails that were authenticated by using Sender Policy - // Framework (SPF) during the predictive inbox placement test. - SpfPercentage *float64 - - // The percentage of emails that were authenticated by using DomainKeys Identified - // Mail (DKIM) during the predictive inbox placement test. - DkimPercentage *float64 + // The percentage of emails that didn't arrive in recipients' inboxes at all during + // the predictive inbox placement test. + MissingPercentage *float64 // The percentage of emails that arrived in recipients' spam or junk mail folders // during the predictive inbox placement test. SpamPercentage *float64 - // The percentage of emails that didn't arrive in recipients' inboxes at all during - // the predictive inbox placement test. - MissingPercentage *float64 + // The percentage of emails that were authenticated by using Sender Policy + // Framework (SPF) during the predictive inbox placement test. + SpfPercentage *float64 } // Represents the raw content of an email message. @@ -967,19 +967,22 @@ type ReplacementTemplate struct { // using this configuration set in the current AWS Region. type ReputationOptions struct { - // If true, tracking of reputation metrics is enabled for the configuration set. If - // false, tracking of reputation metrics is disabled for the configuration set. - ReputationMetricsEnabled *bool - // The date and time (in Unix time) when the reputation metrics were last given a // fresh start. When your account is given a fresh start, your reputation metrics // are calculated starting from the date of the fresh start. LastFreshStart *time.Time + + // If true, tracking of reputation metrics is enabled for the configuration set. If + // false, tracking of reputation metrics is disabled for the configuration set. + ReputationMetricsEnabled *bool } // An object that contains information about your account details review. type ReviewDetails struct { + // The associated support center case ID (if any). + CaseId *string + // The status of the latest review of your account. The status can be one of the // following: // @@ -996,9 +999,6 @@ type ReviewDetails struct { // error occurred and we didn't receive your appeal. You can submit your appeal // again. Status ReviewStatus - - // The associated support center case ID (if any). - CaseId *string } // Used to enable or disable email sending for messages that use this configuration @@ -1070,23 +1070,18 @@ type SuppressedDestination struct { // that is on the suppression list for your account. type SuppressedDestinationAttributes struct { - // The unique identifier of the email message that caused the email address to be - // added to the suppression list for your account. - MessageId *string - // A unique identifier that's generated when an email address is added to the // suppression list for your account. FeedbackId *string + + // The unique identifier of the email message that caused the email address to be + // added to the suppression list for your account. + MessageId *string } // A summary that describes the suppressed email address. type SuppressedDestinationSummary struct { - // The reason that the address was added to the suppression list for your account. - // - // This member is required. - Reason SuppressionListReason - // The email address that's on the suppression list for your account. // // This member is required. @@ -1097,6 +1092,11 @@ type SuppressedDestinationSummary struct { // // This member is required. LastUpdateTime *time.Time + + // The reason that the address was added to the suppression list for your account. + // + // This member is required. + Reason SuppressionListReason } // An object that contains information about the email address suppression @@ -1165,6 +1165,12 @@ type SuppressionOptions struct { // for your AWS account. type Tag struct { + // One part of a key-value pair that defines a tag. The maximum length of a tag key + // is 128 characters. The minimum length is 1 character. + // + // This member is required. + Key *string + // The optional part of a key-value pair that defines a tag. The maximum length of // a tag value is 256 characters. The minimum length is 0 characters. If you don't // want a resource to have a specific tag value, don't specify a value for this @@ -1173,12 +1179,6 @@ type Tag struct { // // This member is required. Value *string - - // One part of a key-value pair that defines a tag. The maximum length of a tag key - // is 128 characters. The minimum length is 1 character. - // - // This member is required. - Key *string } // An object that defines the email template to use for an email message, and the @@ -1223,14 +1223,14 @@ type VolumeStatistics struct { // The total number of emails that arrived in recipients' inboxes. InboxRawCount *int64 - // An estimate of the percentage of emails sent from the current domain that will - // arrive in recipients' spam or junk mail folders. - ProjectedSpam *int64 - // An estimate of the percentage of emails sent from the current domain that will // arrive in recipients' inboxes. ProjectedInbox *int64 + // An estimate of the percentage of emails sent from the current domain that will + // arrive in recipients' spam or junk mail folders. + ProjectedSpam *int64 + // The total number of emails that arrived in recipients' spam or junk mail // folders. SpamRawCount *int64 diff --git a/service/sfn/api_op_CreateActivity.go b/service/sfn/api_op_CreateActivity.go index 034deaeb020..f237412ba2b 100644 --- a/service/sfn/api_op_CreateActivity.go +++ b/service/sfn/api_op_CreateActivity.go @@ -70,16 +70,6 @@ func (c *Client) CreateActivity(ctx context.Context, params *CreateActivityInput type CreateActivityInput struct { - // The list of tags to add to a resource. An array of key-value pairs. For more - // information, see Using Cost Allocation Tags - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) - // in the AWS Billing and Cost Management User Guide, and Controlling Access Using - // IAM Tags - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html). Tags - // may only contain Unicode letters, digits, white space, or these symbols: _ . : / - // = + - @. - Tags []*types.Tag - // The name of the activity to create. This name must be unique for your AWS // account and region for 90 days. For more information, see Limits Related to // State Machine Executions @@ -104,6 +94,16 @@ type CreateActivityInput struct { // // This member is required. Name *string + + // The list of tags to add to a resource. An array of key-value pairs. For more + // information, see Using Cost Allocation Tags + // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) + // in the AWS Billing and Cost Management User Guide, and Controlling Access Using + // IAM Tags + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html). Tags + // may only contain Unicode letters, digits, white space, or these symbols: _ . : / + // = + - @. + Tags []*types.Tag } type CreateActivityOutput struct { diff --git a/service/sfn/api_op_CreateStateMachine.go b/service/sfn/api_op_CreateStateMachine.go index 4b5bf5c34c2..458117f03c1 100644 --- a/service/sfn/api_op_CreateStateMachine.go +++ b/service/sfn/api_op_CreateStateMachine.go @@ -72,26 +72,12 @@ func (c *Client) CreateStateMachine(ctx context.Context, params *CreateStateMach type CreateStateMachineInput struct { - // Tags to be added when creating a state machine. An array of key-value pairs. For - // more information, see Using Cost Allocation Tags - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) - // in the AWS Billing and Cost Management User Guide, and Controlling Access Using - // IAM Tags - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html). Tags - // may only contain Unicode letters, digits, white space, or these symbols: _ . : / - // = + - @. - Tags []*types.Tag - - // Determines whether a Standard or Express state machine is created. The default - // is STANDARD. You cannot update the type of a state machine once it has been - // created. - Type types.StateMachineType - - // Defines what execution history events are logged and where they are logged. By - // default, the level is set to OFF. For more information see Log Levels - // (https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html) - // in the AWS Step Functions User Guide. - LoggingConfiguration *types.LoggingConfiguration + // The Amazon States Language definition of the state machine. See Amazon States + // Language + // (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html). + // + // This member is required. + Definition *string // The name of the state machine. A name must not contain: // @@ -119,12 +105,26 @@ type CreateStateMachineInput struct { // This member is required. RoleArn *string - // The Amazon States Language definition of the state machine. See Amazon States - // Language - // (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html). - // - // This member is required. - Definition *string + // Defines what execution history events are logged and where they are logged. By + // default, the level is set to OFF. For more information see Log Levels + // (https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html) + // in the AWS Step Functions User Guide. + LoggingConfiguration *types.LoggingConfiguration + + // Tags to be added when creating a state machine. An array of key-value pairs. For + // more information, see Using Cost Allocation Tags + // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) + // in the AWS Billing and Cost Management User Guide, and Controlling Access Using + // IAM Tags + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html). Tags + // may only contain Unicode letters, digits, white space, or these symbols: _ . : / + // = + - @. + Tags []*types.Tag + + // Determines whether a Standard or Express state machine is created. The default + // is STANDARD. You cannot update the type of a state machine once it has been + // created. + Type types.StateMachineType } type CreateStateMachineOutput struct { diff --git a/service/sfn/api_op_DescribeActivity.go b/service/sfn/api_op_DescribeActivity.go index 0b9164f78b3..cd93d7dfa02 100644 --- a/service/sfn/api_op_DescribeActivity.go +++ b/service/sfn/api_op_DescribeActivity.go @@ -66,6 +66,11 @@ type DescribeActivityInput struct { type DescribeActivityOutput struct { + // The Amazon Resource Name (ARN) that identifies the activity. + // + // This member is required. + ActivityArn *string + // The date the activity is created. // // This member is required. @@ -92,11 +97,6 @@ type DescribeActivityOutput struct { // This member is required. Name *string - // The Amazon Resource Name (ARN) that identifies the activity. - // - // This member is required. - ActivityArn *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sfn/api_op_DescribeExecution.go b/service/sfn/api_op_DescribeExecution.go index 8f8d4eb2521..9aeacef454d 100644 --- a/service/sfn/api_op_DescribeExecution.go +++ b/service/sfn/api_op_DescribeExecution.go @@ -68,19 +68,31 @@ type DescribeExecutionInput struct { type DescribeExecutionOutput struct { - // The current status of the execution. + // The Amazon Resource Name (ARN) that id entifies the execution. // // This member is required. - Status types.ExecutionStatus + ExecutionArn *string - // If the execution has already ended, the date the execution stopped. - StopDate *time.Time + // The string that contains the JSON input data of the execution. + // + // This member is required. + Input *string // The date the execution is started. // // This member is required. StartDate *time.Time + // The Amazon Resource Name (ARN) of the executed stated machine. + // + // This member is required. + StateMachineArn *string + + // The current status of the execution. + // + // This member is required. + Status types.ExecutionStatus + // The name of the execution. A name must not contain: // // * white space @@ -104,20 +116,8 @@ type DescribeExecutionOutput struct { // succeeds. If the execution fails, this field is null. Output *string - // The Amazon Resource Name (ARN) of the executed stated machine. - // - // This member is required. - StateMachineArn *string - - // The string that contains the JSON input data of the execution. - // - // This member is required. - Input *string - - // The Amazon Resource Name (ARN) that id entifies the execution. - // - // This member is required. - ExecutionArn *string + // If the execution has already ended, the date the execution stopped. + StopDate *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sfn/api_op_DescribeStateMachine.go b/service/sfn/api_op_DescribeStateMachine.go index 273886b4bf2..d25882d7a96 100644 --- a/service/sfn/api_op_DescribeStateMachine.go +++ b/service/sfn/api_op_DescribeStateMachine.go @@ -67,20 +67,10 @@ type DescribeStateMachineInput struct { type DescribeStateMachineOutput struct { - // The Amazon Resource Name (ARN) of the IAM role used when creating this state - // machine. (The IAM role maintains security by granting Step Functions access to - // AWS resources.) - // - // This member is required. - RoleArn *string - - // The Amazon Resource Name (ARN) that identifies the state machine. + // The date the state machine is created. // // This member is required. - StateMachineArn *string - - // The LoggingConfiguration data type is used to set CloudWatch Logs options. - LoggingConfiguration *types.LoggingConfiguration + CreationDate *time.Time // The Amazon States Language definition of the state machine. See Amazon States // Language @@ -89,16 +79,6 @@ type DescribeStateMachineOutput struct { // This member is required. Definition *string - // The date the state machine is created. - // - // This member is required. - CreationDate *time.Time - - // The type of the state machine (STANDARD or EXPRESS). - // - // This member is required. - Type types.StateMachineType - // The name of the state machine. A name must not contain: // // * white space @@ -120,6 +100,26 @@ type DescribeStateMachineOutput struct { // This member is required. Name *string + // The Amazon Resource Name (ARN) of the IAM role used when creating this state + // machine. (The IAM role maintains security by granting Step Functions access to + // AWS resources.) + // + // This member is required. + RoleArn *string + + // The Amazon Resource Name (ARN) that identifies the state machine. + // + // This member is required. + StateMachineArn *string + + // The type of the state machine (STANDARD or EXPRESS). + // + // This member is required. + Type types.StateMachineType + + // The LoggingConfiguration data type is used to set CloudWatch Logs options. + LoggingConfiguration *types.LoggingConfiguration + // The current status of the state machine. Status types.StateMachineStatus diff --git a/service/sfn/api_op_DescribeStateMachineForExecution.go b/service/sfn/api_op_DescribeStateMachineForExecution.go index 554812c4e96..3b7449e5ed1 100644 --- a/service/sfn/api_op_DescribeStateMachineForExecution.go +++ b/service/sfn/api_op_DescribeStateMachineForExecution.go @@ -70,14 +70,17 @@ type DescribeStateMachineForExecutionInput struct { type DescribeStateMachineForExecutionOutput struct { - // The LoggingConfiguration data type is used to set CloudWatch Logs options. - LoggingConfiguration *types.LoggingConfiguration + // The Amazon States Language definition of the state machine. See Amazon States + // Language + // (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html). + // + // This member is required. + Definition *string - // The Amazon Resource Name (ARN) of the state machine associated with the - // execution. + // The name of the state machine associated with the execution. // // This member is required. - StateMachineArn *string + Name *string // The Amazon Resource Name (ARN) of the IAM role of the State Machine for the // execution. @@ -85,17 +88,11 @@ type DescribeStateMachineForExecutionOutput struct { // This member is required. RoleArn *string - // The name of the state machine associated with the execution. - // - // This member is required. - Name *string - - // The Amazon States Language definition of the state machine. See Amazon States - // Language - // (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html). + // The Amazon Resource Name (ARN) of the state machine associated with the + // execution. // // This member is required. - Definition *string + StateMachineArn *string // The date and time the state machine associated with an execution was updated. // For a newly created state machine, this is the creation date. @@ -103,6 +100,9 @@ type DescribeStateMachineForExecutionOutput struct { // This member is required. UpdateDate *time.Time + // The LoggingConfiguration data type is used to set CloudWatch Logs options. + LoggingConfiguration *types.LoggingConfiguration + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sfn/api_op_GetActivityTask.go b/service/sfn/api_op_GetActivityTask.go index 4d0097625d0..bcee6fcdeb6 100644 --- a/service/sfn/api_op_GetActivityTask.go +++ b/service/sfn/api_op_GetActivityTask.go @@ -80,14 +80,14 @@ type GetActivityTaskInput struct { type GetActivityTaskOutput struct { + // The string that contains the JSON input data for the task. + Input *string + // A token that identifies the scheduled task. This token must be copied and // included in subsequent calls to SendTaskHeartbeat (), SendTaskSuccess () or // SendTaskFailure () in order to report the progress or completion of the task. TaskToken *string - // The string that contains the JSON input data for the task. - Input *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sfn/api_op_GetExecutionHistory.go b/service/sfn/api_op_GetExecutionHistory.go index 9cc0a6f28d0..cb4aabf0c2d 100644 --- a/service/sfn/api_op_GetExecutionHistory.go +++ b/service/sfn/api_op_GetExecutionHistory.go @@ -65,6 +65,11 @@ func (c *Client) GetExecutionHistory(ctx context.Context, params *GetExecutionHi type GetExecutionHistoryInput struct { + // The Amazon Resource Name (ARN) of the execution. + // + // This member is required. + ExecutionArn *string + // The maximum number of results that are returned per call. You can use nextToken // to obtain further pages of results. The default is 100 and the maximum allowed // page size is 1000. A value of 0 uses the default. This is only an upper limit. @@ -81,15 +86,15 @@ type GetExecutionHistoryInput struct { // Lists events in descending order of their timeStamp. ReverseOrder *bool - - // The Amazon Resource Name (ARN) of the execution. - // - // This member is required. - ExecutionArn *string } type GetExecutionHistoryOutput struct { + // The list of events that occurred in the execution. + // + // This member is required. + Events []*types.HistoryEvent + // If nextToken is returned, there are more results available. The value of // nextToken is a unique pagination token for each page. Make the call again using // the returned token to retrieve the next page. Keep all other arguments @@ -97,11 +102,6 @@ type GetExecutionHistoryOutput struct { // pagination token will return an HTTP 400 InvalidToken error. NextToken *string - // The list of events that occurred in the execution. - // - // This member is required. - Events []*types.HistoryEvent - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sfn/api_op_ListActivities.go b/service/sfn/api_op_ListActivities.go index 2c8941fc398..73df03de72c 100644 --- a/service/sfn/api_op_ListActivities.go +++ b/service/sfn/api_op_ListActivities.go @@ -62,19 +62,19 @@ func (c *Client) ListActivities(ctx context.Context, params *ListActivitiesInput type ListActivitiesInput struct { - // If nextToken is returned, there are more results available. The value of - // nextToken is a unique pagination token for each page. Make the call again using - // the returned token to retrieve the next page. Keep all other arguments - // unchanged. Each pagination token expires after 24 hours. Using an expired - // pagination token will return an HTTP 400 InvalidToken error. - NextToken *string - // The maximum number of results that are returned per call. You can use nextToken // to obtain further pages of results. The default is 100 and the maximum allowed // page size is 1000. A value of 0 uses the default. This is only an upper limit. // The actual number of results returned per call might be fewer than the specified // maximum. MaxResults *int32 + + // If nextToken is returned, there are more results available. The value of + // nextToken is a unique pagination token for each page. Make the call again using + // the returned token to retrieve the next page. Keep all other arguments + // unchanged. Each pagination token expires after 24 hours. Using an expired + // pagination token will return an HTTP 400 InvalidToken error. + NextToken *string } type ListActivitiesOutput struct { diff --git a/service/sfn/api_op_ListExecutions.go b/service/sfn/api_op_ListExecutions.go index ee19e394e12..c0f5d0a0ba7 100644 --- a/service/sfn/api_op_ListExecutions.go +++ b/service/sfn/api_op_ListExecutions.go @@ -65,13 +65,6 @@ func (c *Client) ListExecutions(ctx context.Context, params *ListExecutionsInput type ListExecutionsInput struct { - // If nextToken is returned, there are more results available. The value of - // nextToken is a unique pagination token for each page. Make the call again using - // the returned token to retrieve the next page. Keep all other arguments - // unchanged. Each pagination token expires after 24 hours. Using an expired - // pagination token will return an HTTP 400 InvalidToken error. - NextToken *string - // The Amazon Resource Name (ARN) of the state machine whose executions is listed. // // This member is required. @@ -84,6 +77,13 @@ type ListExecutionsInput struct { // maximum. MaxResults *int32 + // If nextToken is returned, there are more results available. The value of + // nextToken is a unique pagination token for each page. Make the call again using + // the returned token to retrieve the next page. Keep all other arguments + // unchanged. Each pagination token expires after 24 hours. Using an expired + // pagination token will return an HTTP 400 InvalidToken error. + NextToken *string + // If specified, only list the executions whose current execution status matches // the given filter. StatusFilter types.ExecutionStatus @@ -91,6 +91,11 @@ type ListExecutionsInput struct { type ListExecutionsOutput struct { + // The list of matching executions. + // + // This member is required. + Executions []*types.ExecutionListItem + // If nextToken is returned, there are more results available. The value of // nextToken is a unique pagination token for each page. Make the call again using // the returned token to retrieve the next page. Keep all other arguments @@ -98,11 +103,6 @@ type ListExecutionsOutput struct { // pagination token will return an HTTP 400 InvalidToken error. NextToken *string - // The list of matching executions. - // - // This member is required. - Executions []*types.ExecutionListItem - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sfn/api_op_ListStateMachines.go b/service/sfn/api_op_ListStateMachines.go index 389efec64cd..fab94ca5359 100644 --- a/service/sfn/api_op_ListStateMachines.go +++ b/service/sfn/api_op_ListStateMachines.go @@ -62,22 +62,23 @@ func (c *Client) ListStateMachines(ctx context.Context, params *ListStateMachine type ListStateMachinesInput struct { - // If nextToken is returned, there are more results available. The value of - // nextToken is a unique pagination token for each page. Make the call again using - // the returned token to retrieve the next page. Keep all other arguments - // unchanged. Each pagination token expires after 24 hours. Using an expired - // pagination token will return an HTTP 400 InvalidToken error. - NextToken *string - // The maximum number of results that are returned per call. You can use nextToken // to obtain further pages of results. The default is 100 and the maximum allowed // page size is 1000. A value of 0 uses the default. This is only an upper limit. // The actual number of results returned per call might be fewer than the specified // maximum. MaxResults *int32 + + // If nextToken is returned, there are more results available. The value of + // nextToken is a unique pagination token for each page. Make the call again using + // the returned token to retrieve the next page. Keep all other arguments + // unchanged. Each pagination token expires after 24 hours. Using an expired + // pagination token will return an HTTP 400 InvalidToken error. + NextToken *string } type ListStateMachinesOutput struct { + StateMachines []*types.StateMachineListItem // If nextToken is returned, there are more results available. The value of // nextToken is a unique pagination token for each page. Make the call again using @@ -86,8 +87,6 @@ type ListStateMachinesOutput struct { // pagination token will return an HTTP 400 InvalidToken error. NextToken *string - StateMachines []*types.StateMachineListItem - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sfn/api_op_SendTaskFailure.go b/service/sfn/api_op_SendTaskFailure.go index 83cf1448073..d36c2650671 100644 --- a/service/sfn/api_op_SendTaskFailure.go +++ b/service/sfn/api_op_SendTaskFailure.go @@ -58,9 +58,6 @@ func (c *Client) SendTaskFailure(ctx context.Context, params *SendTaskFailureInp type SendTaskFailureInput struct { - // The error code of the failure. - Error *string - // The token that represents this task. Task tokens are generated by Step Functions // when tasks are assigned to a worker, or in the context object // (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html) @@ -71,6 +68,9 @@ type SendTaskFailureInput struct { // A more detailed explanation of the cause of the failure. Cause *string + + // The error code of the failure. + Error *string } type SendTaskFailureOutput struct { diff --git a/service/sfn/api_op_SendTaskSuccess.go b/service/sfn/api_op_SendTaskSuccess.go index b152780dab9..c3d0bf597bc 100644 --- a/service/sfn/api_op_SendTaskSuccess.go +++ b/service/sfn/api_op_SendTaskSuccess.go @@ -59,6 +59,11 @@ func (c *Client) SendTaskSuccess(ctx context.Context, params *SendTaskSuccessInp type SendTaskSuccessInput struct { + // The JSON output of the task. + // + // This member is required. + Output *string + // The token that represents this task. Task tokens are generated by Step Functions // when tasks are assigned to a worker, or in the context object // (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html) @@ -66,11 +71,6 @@ type SendTaskSuccessInput struct { // // This member is required. TaskToken *string - - // The JSON output of the task. - // - // This member is required. - Output *string } type SendTaskSuccessOutput struct { diff --git a/service/sfn/api_op_StartExecution.go b/service/sfn/api_op_StartExecution.go index 8449b4b5be5..90b76b2789e 100644 --- a/service/sfn/api_op_StartExecution.go +++ b/service/sfn/api_op_StartExecution.go @@ -61,6 +61,16 @@ func (c *Client) StartExecution(ctx context.Context, params *StartExecutionInput type StartExecutionInput struct { + // The Amazon Resource Name (ARN) of the state machine to execute. + // + // This member is required. + StateMachineArn *string + + // The string that contains the JSON input data for the execution, for example: + // "input": "{\"first_name\" : \"test\"}" If you don't include any JSON input data, + // you still must include the two braces, for example: "input": "{}" + Input *string + // The name of the execution. This name must be unique for your AWS account, // region, and state machine for 90 days. For more information, see Limits Related // to State Machine Executions @@ -83,29 +93,19 @@ type StartExecutionInput struct { // To enable logging with CloudWatch Logs, the name should only // contain 0-9, A-Z, a-z, - and _. Name *string - - // The Amazon Resource Name (ARN) of the state machine to execute. - // - // This member is required. - StateMachineArn *string - - // The string that contains the JSON input data for the execution, for example: - // "input": "{\"first_name\" : \"test\"}" If you don't include any JSON input data, - // you still must include the two braces, for example: "input": "{}" - Input *string } type StartExecutionOutput struct { - // The date the execution is started. + // The Amazon Resource Name (ARN) that id entifies the execution. // // This member is required. - StartDate *time.Time + ExecutionArn *string - // The Amazon Resource Name (ARN) that id entifies the execution. + // The date the execution is started. // // This member is required. - ExecutionArn *string + StartDate *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sfn/api_op_StopExecution.go b/service/sfn/api_op_StopExecution.go index f89c51f225c..b0d07cf38ca 100644 --- a/service/sfn/api_op_StopExecution.go +++ b/service/sfn/api_op_StopExecution.go @@ -57,16 +57,16 @@ func (c *Client) StopExecution(ctx context.Context, params *StopExecutionInput, type StopExecutionInput struct { + // The Amazon Resource Name (ARN) of the execution to stop. + // + // This member is required. + ExecutionArn *string + // A more detailed explanation of the cause of the failure. Cause *string // The error code of the failure. Error *string - - // The Amazon Resource Name (ARN) of the execution to stop. - // - // This member is required. - ExecutionArn *string } type StopExecutionOutput struct { diff --git a/service/sfn/api_op_TagResource.go b/service/sfn/api_op_TagResource.go index e8ae59c2e5c..e52768697fa 100644 --- a/service/sfn/api_op_TagResource.go +++ b/service/sfn/api_op_TagResource.go @@ -64,16 +64,16 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The list of tags to add to a resource. Tags may only contain Unicode letters, - // digits, white space, or these symbols: _ . : / = + - @. + // The Amazon Resource Name (ARN) for the Step Functions state machine or activity. // // This member is required. - Tags []*types.Tag + ResourceArn *string - // The Amazon Resource Name (ARN) for the Step Functions state machine or activity. + // The list of tags to add to a resource. Tags may only contain Unicode letters, + // digits, white space, or these symbols: _ . : / = + - @. // // This member is required. - ResourceArn *string + Tags []*types.Tag } type TagResourceOutput struct { diff --git a/service/sfn/api_op_UpdateStateMachine.go b/service/sfn/api_op_UpdateStateMachine.go index 1cae5f534a7..265880b0c16 100644 --- a/service/sfn/api_op_UpdateStateMachine.go +++ b/service/sfn/api_op_UpdateStateMachine.go @@ -64,6 +64,11 @@ func (c *Client) UpdateStateMachine(ctx context.Context, params *UpdateStateMach type UpdateStateMachineInput struct { + // The Amazon Resource Name (ARN) of the state machine. + // + // This member is required. + StateMachineArn *string + // The Amazon States Language definition of the state machine. See Amazon States // Language // (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html). @@ -72,11 +77,6 @@ type UpdateStateMachineInput struct { // The LoggingConfiguration data type is used to set CloudWatch Logs options. LoggingConfiguration *types.LoggingConfiguration - // The Amazon Resource Name (ARN) of the state machine. - // - // This member is required. - StateMachineArn *string - // The Amazon Resource Name (ARN) of the IAM role of the state machine. RoleArn *string } diff --git a/service/sfn/go.mod b/service/sfn/go.mod index a736abf2253..6e441c2dedd 100644 --- a/service/sfn/go.mod +++ b/service/sfn/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/sfn go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/sfn/types/types.go b/service/sfn/types/types.go index 431699b4239..0a20c8480c1 100644 --- a/service/sfn/types/types.go +++ b/service/sfn/types/types.go @@ -19,6 +19,16 @@ type ActivityFailedEventDetails struct { // Contains details about an activity. type ActivityListItem struct { + // The Amazon Resource Name (ARN) that identifies the activity. + // + // This member is required. + ActivityArn *string + + // The date the activity is created. + // + // This member is required. + CreationDate *time.Time + // The name of the activity. A name must not contain: // // * white space @@ -39,34 +49,24 @@ type ActivityListItem struct { // // This member is required. Name *string - - // The date the activity is created. - // - // This member is required. - CreationDate *time.Time - - // The Amazon Resource Name (ARN) that identifies the activity. - // - // This member is required. - ActivityArn *string } // Contains details about an activity scheduled during an execution. type ActivityScheduledEventDetails struct { - // The JSON data input to the activity task. - Input *string - // The Amazon Resource Name (ARN) of the scheduled activity. // // This member is required. Resource *string - // The maximum allowed duration of the activity task. - TimeoutInSeconds *int64 - // The maximum allowed duration between two heartbeats for the activity task. HeartbeatInSeconds *int64 + + // The JSON data input to the activity task. + Input *string + + // The maximum allowed duration of the activity task. + TimeoutInSeconds *int64 } // Contains details about an activity schedule failure that occurred during an @@ -99,11 +99,11 @@ type ActivitySucceededEventDetails struct { // Contains details about an activity timeout that occurred during an execution. type ActivityTimedOutEventDetails struct { - // The error code of the failure. - Error *string - // A more detailed explanation of the cause of the timeout. Cause *string + + // The error code of the failure. + Error *string } // @@ -127,20 +127,20 @@ type ExecutionAbortedEventDetails struct { // Contains details about an execution failure event. type ExecutionFailedEventDetails struct { - // The error code of the failure. - Error *string - // A more detailed explanation of the cause of the failure. Cause *string + + // The error code of the failure. + Error *string } // Contains details about an execution. type ExecutionListItem struct { - // The current status of the execution. + // The Amazon Resource Name (ARN) that id entifies the execution. // // This member is required. - Status ExecutionStatus + ExecutionArn *string // The name of the execution. A name must not contain: // @@ -163,34 +163,34 @@ type ExecutionListItem struct { // This member is required. Name *string - // The Amazon Resource Name (ARN) that id entifies the execution. - // - // This member is required. - ExecutionArn *string - // The date the execution started. // // This member is required. StartDate *time.Time - // If the execution already ended, the date the execution stopped. - StopDate *time.Time - // The Amazon Resource Name (ARN) of the executed state machine. // // This member is required. StateMachineArn *string + + // The current status of the execution. + // + // This member is required. + Status ExecutionStatus + + // If the execution already ended, the date the execution stopped. + StopDate *time.Time } // Contains details about the start of the execution. type ExecutionStartedEventDetails struct { + // The JSON data input to the execution. + Input *string + // The Amazon Resource Name (ARN) of the IAM role used for executing AWS Lambda // tasks. RoleArn *string - - // The JSON data input to the execution. - Input *string } // Contains details about the successful termination of the execution. @@ -203,160 +203,160 @@ type ExecutionSucceededEventDetails struct { // Contains details about the execution timeout that occurred during the execution. type ExecutionTimedOutEventDetails struct { - // The error code of the failure. - Error *string - // A more detailed explanation of the cause of the timeout. Cause *string + + // The error code of the failure. + Error *string } // Contains details about the events of an execution. type HistoryEvent struct { - // Contains details about an activity schedule event that failed during an - // execution. - ActivityScheduleFailedEventDetails *ActivityScheduleFailedEventDetails - - // Contains details about the successful termination of the execution. - ExecutionSucceededEventDetails *ExecutionSucceededEventDetails + // The id of the event. Events are numbered sequentially, starting at one. + // + // This member is required. + Id *int64 - // Contains details about a task that succeeded. - TaskSucceededEventDetails *TaskSucceededEventDetails + // The date and time the event occurred. + // + // This member is required. + Timestamp *time.Time // The type of the event. // // This member is required. Type HistoryEventType - // Contains details about a lambda function that terminated successfully during an - // execution. - LambdaFunctionSucceededEventDetails *LambdaFunctionSucceededEventDetails + // Contains details about an activity that failed during an execution. + ActivityFailedEventDetails *ActivityFailedEventDetails - // Contains details about a lambda function timeout that occurred during an + // Contains details about an activity schedule event that failed during an // execution. - LambdaFunctionTimedOutEventDetails *LambdaFunctionTimedOutEventDetails - - // Contains details about a state entered during an execution. - StateEnteredEventDetails *StateEnteredEventDetails - - // Contains details about an exit from a state during an execution. - StateExitedEventDetails *StateExitedEventDetails + ActivityScheduleFailedEventDetails *ActivityScheduleFailedEventDetails - // Contains details about the execution timeout that occurred during the execution. - ExecutionTimedOutEventDetails *ExecutionTimedOutEventDetails + // Contains details about an activity scheduled during an execution. + ActivityScheduledEventDetails *ActivityScheduledEventDetails - // The date and time the event occurred. - // - // This member is required. - Timestamp *time.Time + // Contains details about the start of an activity during an execution. + ActivityStartedEventDetails *ActivityStartedEventDetails // Contains details about an activity that successfully terminated during an // execution. ActivitySucceededEventDetails *ActivitySucceededEventDetails - // Contains details about the failure of a task. - TaskFailedEventDetails *TaskFailedEventDetails - // Contains details about an activity timeout that occurred during an execution. ActivityTimedOutEventDetails *ActivityTimedOutEventDetails - // Contains details about an iteration of a Map state that failed. - MapIterationFailedEventDetails *MapIterationEventDetails + // Contains details about an abort of an execution. + ExecutionAbortedEventDetails *ExecutionAbortedEventDetails - // Contains details about an iteration of a Map state that succeeded. - MapIterationSucceededEventDetails *MapIterationEventDetails + // Contains details about an execution failure event. + ExecutionFailedEventDetails *ExecutionFailedEventDetails - // Contains details about a submitted task. - TaskSubmittedEventDetails *TaskSubmittedEventDetails + // Contains details about the start of the execution. + ExecutionStartedEventDetails *ExecutionStartedEventDetails - // Contains details about an activity scheduled during an execution. - ActivityScheduledEventDetails *ActivityScheduledEventDetails + // Contains details about the successful termination of the execution. + ExecutionSucceededEventDetails *ExecutionSucceededEventDetails - // Contains details about a task that failed to start. - TaskStartFailedEventDetails *TaskStartFailedEventDetails + // Contains details about the execution timeout that occurred during the execution. + ExecutionTimedOutEventDetails *ExecutionTimedOutEventDetails + + // Contains details about a lambda function that failed during an execution. + LambdaFunctionFailedEventDetails *LambdaFunctionFailedEventDetails // Contains details about a failed lambda function schedule event that occurred // during an execution. LambdaFunctionScheduleFailedEventDetails *LambdaFunctionScheduleFailedEventDetails - // Contains details about an iteration of a Map state that was aborted. - MapIterationAbortedEventDetails *MapIterationEventDetails - - // The id of the event. Events are numbered sequentially, starting at one. - // - // This member is required. - Id *int64 + // Contains details about a lambda function scheduled during an execution. + LambdaFunctionScheduledEventDetails *LambdaFunctionScheduledEventDetails // Contains details about a lambda function that failed to start during an // execution. LambdaFunctionStartFailedEventDetails *LambdaFunctionStartFailedEventDetails - // Contains details about the start of the execution. - ExecutionStartedEventDetails *ExecutionStartedEventDetails - - // Contains details about a lambda function scheduled during an execution. - LambdaFunctionScheduledEventDetails *LambdaFunctionScheduledEventDetails - - // Contains details about an execution failure event. - ExecutionFailedEventDetails *ExecutionFailedEventDetails + // Contains details about a lambda function that terminated successfully during an + // execution. + LambdaFunctionSucceededEventDetails *LambdaFunctionSucceededEventDetails - // Contains details about an activity that failed during an execution. - ActivityFailedEventDetails *ActivityFailedEventDetails + // Contains details about a lambda function timeout that occurred during an + // execution. + LambdaFunctionTimedOutEventDetails *LambdaFunctionTimedOutEventDetails - // Contains details about an abort of an execution. - ExecutionAbortedEventDetails *ExecutionAbortedEventDetails + // Contains details about an iteration of a Map state that was aborted. + MapIterationAbortedEventDetails *MapIterationEventDetails - // Contains details about a task that where the submit failed. - TaskSubmitFailedEventDetails *TaskSubmitFailedEventDetails + // Contains details about an iteration of a Map state that failed. + MapIterationFailedEventDetails *MapIterationEventDetails - // Contains details about a task that timed out. - TaskTimedOutEventDetails *TaskTimedOutEventDetails + // Contains details about an iteration of a Map state that was started. + MapIterationStartedEventDetails *MapIterationEventDetails - // Contains details about a lambda function that failed during an execution. - LambdaFunctionFailedEventDetails *LambdaFunctionFailedEventDetails + // Contains details about an iteration of a Map state that succeeded. + MapIterationSucceededEventDetails *MapIterationEventDetails // Contains details about Map state that was started. MapStateStartedEventDetails *MapStateStartedEventDetails + // The id of the previous event. + PreviousEventId *int64 + + // Contains details about a state entered during an execution. + StateEnteredEventDetails *StateEnteredEventDetails + + // Contains details about an exit from a state during an execution. + StateExitedEventDetails *StateExitedEventDetails + + // Contains details about the failure of a task. + TaskFailedEventDetails *TaskFailedEventDetails + // Contains details about a task that was scheduled. TaskScheduledEventDetails *TaskScheduledEventDetails - // The id of the previous event. - PreviousEventId *int64 + // Contains details about a task that failed to start. + TaskStartFailedEventDetails *TaskStartFailedEventDetails // Contains details about a task that was started. TaskStartedEventDetails *TaskStartedEventDetails - // Contains details about an iteration of a Map state that was started. - MapIterationStartedEventDetails *MapIterationEventDetails + // Contains details about a task that where the submit failed. + TaskSubmitFailedEventDetails *TaskSubmitFailedEventDetails - // Contains details about the start of an activity during an execution. - ActivityStartedEventDetails *ActivityStartedEventDetails + // Contains details about a submitted task. + TaskSubmittedEventDetails *TaskSubmittedEventDetails + + // Contains details about a task that succeeded. + TaskSucceededEventDetails *TaskSucceededEventDetails + + // Contains details about a task that timed out. + TaskTimedOutEventDetails *TaskTimedOutEventDetails } // Contains details about a lambda function that failed during an execution. type LambdaFunctionFailedEventDetails struct { - // The error code of the failure. - Error *string - // A more detailed explanation of the cause of the failure. Cause *string + + // The error code of the failure. + Error *string } // Contains details about a lambda function scheduled during an execution. type LambdaFunctionScheduledEventDetails struct { + // The Amazon Resource Name (ARN) of the scheduled lambda function. + // + // This member is required. + Resource *string + // The JSON data input to the lambda function. Input *string // The maximum allowed duration of the lambda function. TimeoutInSeconds *int64 - - // The Amazon Resource Name (ARN) of the scheduled lambda function. - // - // This member is required. - Resource *string } // Contains details about a failed lambda function schedule event that occurred @@ -374,11 +374,11 @@ type LambdaFunctionScheduleFailedEventDetails struct { // execution. type LambdaFunctionStartFailedEventDetails struct { - // The error code of the failure. - Error *string - // A more detailed explanation of the cause of the failure. Cause *string + + // The error code of the failure. + Error *string } // Contains details about a lambda function that successfully terminated during an @@ -393,11 +393,11 @@ type LambdaFunctionSucceededEventDetails struct { // execution. type LambdaFunctionTimedOutEventDetails struct { - // The error code of the failure. - Error *string - // A more detailed explanation of the cause of the timeout. Cause *string + + // The error code of the failure. + Error *string } // @@ -413,14 +413,14 @@ type LogDestination struct { // The LoggingConfiguration data type is used to set CloudWatch Logs options. type LoggingConfiguration struct { - // Determines whether execution data is included in your log. When set to FALSE, - // data is excluded. - IncludeExecutionData *bool - // An array of objects that describes where your execution history events will be // logged. Limited to size 1. Required, if your log level is not set to OFF. Destinations []*LogDestination + // Determines whether execution data is included in your log. When set to FALSE, + // data is excluded. + IncludeExecutionData *bool + // Defines which category of execution history events are logged. Level LogLevel } @@ -428,11 +428,11 @@ type LoggingConfiguration struct { // Contains details about an iteration of a Map state. type MapIterationEventDetails struct { - // The name of the iteration’s parent Map state. - Name *string - // The index of the array belonging to the Map state iteration. Index *int32 + + // The name of the iteration’s parent Map state. + Name *string } // Details about a Map state that was started. @@ -485,6 +485,11 @@ type StateExitedEventDetails struct { // Contains details about the state machine. type StateMachineListItem struct { + // The date the state machine is created. + // + // This member is required. + CreationDate *time.Time + // The name of the state machine. A name must not contain: // // * white space @@ -506,11 +511,6 @@ type StateMachineListItem struct { // This member is required. Name *string - // The date the state machine is created. - // - // This member is required. - CreationDate *time.Time - // The Amazon Resource Name (ARN) that identifies the state machine. // // This member is required. @@ -543,110 +543,107 @@ type Tag struct { // Contains details about a task failure event. type TaskFailedEventDetails struct { - // A more detailed explanation of the cause of the failure. - Cause *string - // The service name of the resource in a task state. // // This member is required. Resource *string - // The error code of the failure. - Error *string - // The action of the resource called by a task state. // // This member is required. ResourceType *string + + // A more detailed explanation of the cause of the failure. + Cause *string + + // The error code of the failure. + Error *string } // Contains details about a task scheduled during an execution. type TaskScheduledEventDetails struct { - // The action of the resource called by a task state. + // The JSON data passed to the resource referenced in a task state. // // This member is required. - ResourceType *string + Parameters *string + + // The region of the scheduled task + // + // This member is required. + Region *string // The service name of the resource in a task state. // // This member is required. Resource *string - // The region of the scheduled task + // The action of the resource called by a task state. // // This member is required. - Region *string + ResourceType *string // The maximum allowed duration of the task. TimeoutInSeconds *int64 - - // The JSON data passed to the resource referenced in a task state. - // - // This member is required. - Parameters *string } // Contains details about the start of a task during an execution. type TaskStartedEventDetails struct { - // The action of the resource called by a task state. + // The service name of the resource in a task state. // // This member is required. - ResourceType *string + Resource *string - // The service name of the resource in a task state. + // The action of the resource called by a task state. // // This member is required. - Resource *string + ResourceType *string } // Contains details about a task that failed to start during an execution. type TaskStartFailedEventDetails struct { - // A more detailed explanation of the cause of the failure. - Cause *string - - // The error code of the failure. - Error *string + // The service name of the resource in a task state. + // + // This member is required. + Resource *string // The action of the resource called by a task state. // // This member is required. ResourceType *string - // The service name of the resource in a task state. - // - // This member is required. - Resource *string + // A more detailed explanation of the cause of the failure. + Cause *string + + // The error code of the failure. + Error *string } // Contains details about a task that failed to submit during an execution. type TaskSubmitFailedEventDetails struct { - // A more detailed explanation of the cause of the failure. - Cause *string - // The service name of the resource in a task state. // // This member is required. Resource *string - // The error code of the failure. - Error *string - // The action of the resource called by a task state. // // This member is required. ResourceType *string + + // A more detailed explanation of the cause of the failure. + Cause *string + + // The error code of the failure. + Error *string } // Contains details about a task submitted to a resource . type TaskSubmittedEventDetails struct { - // The response from a resource when a task has started. - Output *string - // The service name of the resource in a task state. // // This member is required. @@ -656,20 +653,23 @@ type TaskSubmittedEventDetails struct { // // This member is required. ResourceType *string + + // The response from a resource when a task has started. + Output *string } // Contains details about the successful completion of a task state. type TaskSucceededEventDetails struct { - // The action of the resource called by a task state. + // The service name of the resource in a task state. // // This member is required. - ResourceType *string + Resource *string - // The service name of the resource in a task state. + // The action of the resource called by a task state. // // This member is required. - Resource *string + ResourceType *string // The full JSON response from a resource when a task has succeeded. This response // becomes the output of the related task. @@ -679,19 +679,19 @@ type TaskSucceededEventDetails struct { // Contains details about a resource timeout that occurred during an execution. type TaskTimedOutEventDetails struct { - // The error code of the failure. - Error *string - // The service name of the resource in a task state. // // This member is required. Resource *string - // A more detailed explanation of the cause of the failure. - Cause *string - // The action of the resource called by a task state. // // This member is required. ResourceType *string + + // A more detailed explanation of the cause of the failure. + Cause *string + + // The error code of the failure. + Error *string } diff --git a/service/shield/api_op_CreateProtection.go b/service/shield/api_op_CreateProtection.go index d2216c08c57..992163ded8f 100644 --- a/service/shield/api_op_CreateProtection.go +++ b/service/shield/api_op_CreateProtection.go @@ -65,6 +65,11 @@ func (c *Client) CreateProtection(ctx context.Context, params *CreateProtectionI type CreateProtectionInput struct { + // Friendly name for the Protection you are creating. + // + // This member is required. + Name *string + // The ARN (Amazon Resource Name) of the resource to be protected. The ARN should // be in one of the following formats: // @@ -91,11 +96,6 @@ type CreateProtectionInput struct { // // This member is required. ResourceArn *string - - // Friendly name for the Protection you are creating. - // - // This member is required. - Name *string } type CreateProtectionOutput struct { diff --git a/service/shield/api_op_DescribeDRTAccess.go b/service/shield/api_op_DescribeDRTAccess.go index bd02e2c82fa..4c110ba028e 100644 --- a/service/shield/api_op_DescribeDRTAccess.go +++ b/service/shield/api_op_DescribeDRTAccess.go @@ -60,13 +60,13 @@ type DescribeDRTAccessInput struct { type DescribeDRTAccessOutput struct { + // The list of Amazon S3 buckets accessed by the DRT. + LogBucketList []*string + // The Amazon Resource Name (ARN) of the role the DRT used to access your AWS // account. RoleArn *string - // The list of Amazon S3 buckets accessed by the DRT. - LogBucketList []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/shield/api_op_DescribeProtection.go b/service/shield/api_op_DescribeProtection.go index 6e713ce103f..a7e2b82fbcc 100644 --- a/service/shield/api_op_DescribeProtection.go +++ b/service/shield/api_op_DescribeProtection.go @@ -56,15 +56,15 @@ func (c *Client) DescribeProtection(ctx context.Context, params *DescribeProtect type DescribeProtectionInput struct { - // The ARN (Amazon Resource Name) of the AWS resource for the Protection () object - // that is described. When submitting the DescribeProtection request you must - // provide either the ResourceArn or the ProtectionID, but not both. - ResourceArn *string - // The unique identifier (ID) for the Protection () object that is described. When // submitting the DescribeProtection request you must provide either the // ResourceArn or the ProtectionID, but not both. ProtectionId *string + + // The ARN (Amazon Resource Name) of the AWS resource for the Protection () object + // that is described. When submitting the DescribeProtection request you must + // provide either the ResourceArn or the ProtectionID, but not both. + ResourceArn *string } type DescribeProtectionOutput struct { diff --git a/service/shield/api_op_ListAttacks.go b/service/shield/api_op_ListAttacks.go index 4c3e3c44fb5..a1f1dfef7b0 100644 --- a/service/shield/api_op_ListAttacks.go +++ b/service/shield/api_op_ListAttacks.go @@ -57,14 +57,6 @@ func (c *Client) ListAttacks(ctx context.Context, params *ListAttacksInput, optF type ListAttacksInput struct { - // The ListAttacksRequest.NextMarker value from a previous call to - // ListAttacksRequest. Pass null if this is the first call. - NextToken *string - - // The ARN (Amazon Resource Name) of the resource that was attacked. If this is - // left blank, all applicable resources for this account will be included. - ResourceArns []*string - // The end of the time period for the attacks. This is a timestamp type. The sample // request above indicates a number type because the default used by WAF is Unix // time in seconds. However any valid timestamp format @@ -81,6 +73,14 @@ type ListAttacksInput struct { // NextToken. MaxResults *int32 + // The ListAttacksRequest.NextMarker value from a previous call to + // ListAttacksRequest. Pass null if this is the first call. + NextToken *string + + // The ARN (Amazon Resource Name) of the resource that was attacked. If this is + // left blank, all applicable resources for this account will be included. + ResourceArns []*string + // The start of the time period for the attacks. This is a timestamp type. The // sample request above indicates a number type because the default used by WAF is // Unix time in seconds. However any valid timestamp format @@ -91,6 +91,9 @@ type ListAttacksInput struct { type ListAttacksOutput struct { + // The attack information for the specified time range. + AttackSummaries []*types.AttackSummary + // The token returned by a previous call to indicate that there is more data // available. If not null, more results are available. Pass this value for the // NextMarker parameter in a subsequent call to ListAttacks to retrieve the next @@ -99,9 +102,6 @@ type ListAttacksOutput struct { // AttackSummary () objects to return, AWS WAF will always also return a NextToken. NextToken *string - // The attack information for the specified time range. - AttackSummaries []*types.AttackSummary - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/shield/api_op_ListProtections.go b/service/shield/api_op_ListProtections.go index 62a8a27e900..b68d66d61d7 100644 --- a/service/shield/api_op_ListProtections.go +++ b/service/shield/api_op_ListProtections.go @@ -56,10 +56,6 @@ func (c *Client) ListProtections(ctx context.Context, params *ListProtectionsInp type ListProtectionsInput struct { - // The ListProtectionsRequest.NextToken value from a previous call to - // ListProtections. Pass null if this is the first call. - NextToken *string - // The maximum number of Protection () objects to be returned. If this is left // blank the first 20 results will be returned. This is a maximum value; it is // possible that AWS WAF will return the results in smaller batches. That is, the @@ -67,6 +63,10 @@ type ListProtectionsInput struct { // there are still more Protection () objects yet to return. If there are more // Protection () objects to return, AWS WAF will always also return a NextToken. MaxResults *int32 + + // The ListProtectionsRequest.NextToken value from a previous call to + // ListProtections. Pass null if this is the first call. + NextToken *string } type ListProtectionsOutput struct { diff --git a/service/shield/go.mod b/service/shield/go.mod index 04aac5d44b0..baa003308c5 100644 --- a/service/shield/go.mod +++ b/service/shield/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/shield go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/shield/types/types.go b/service/shield/types/types.go index ab191a751b6..2308fbfd485 100644 --- a/service/shield/types/types.go +++ b/service/shield/types/types.go @@ -9,51 +9,44 @@ import ( // The details of a DDoS attack. type AttackDetail struct { - // The time the attack started, in Unix time in seconds. For more information see - // timestamp - // (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types). - StartTime *time.Time + // List of counters that describe the attack for the specified time period. + AttackCounters []*SummarizedCounter - // If applicable, additional detail about the resource being attacked, for example, - // IP address or URL. - SubResources []*SubResourceSummary + // The unique identifier (ID) of the attack. + AttackId *string // The array of AttackProperty () objects. AttackProperties []*AttackProperty - // The ARN (Amazon Resource Name) of the resource that was attacked. - ResourceArn *string - - // The unique identifier (ID) of the attack. - AttackId *string - // The time the attack ended, in Unix time in seconds. For more information see // timestamp // (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types). EndTime *time.Time - // List of counters that describe the attack for the specified time period. - AttackCounters []*SummarizedCounter - // List of mitigation actions taken for the attack. Mitigations []*Mitigation + + // The ARN (Amazon Resource Name) of the resource that was attacked. + ResourceArn *string + + // The time the attack started, in Unix time in seconds. For more information see + // timestamp + // (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types). + StartTime *time.Time + + // If applicable, additional detail about the resource being attacked, for example, + // IP address or URL. + SubResources []*SubResourceSummary } // Details of the described attack. type AttackProperty struct { - // The total contributions made to this attack by all contributors, not just the - // five listed in the TopContributors list. - Total *int64 - // The type of distributed denial of service (DDoS) event that was observed. // NETWORK indicates layer 3 and layer 4 events and APPLICATION indicates layer 7 // events. AttackLayer AttackLayer - // The unit of the Value of the contributions. - Unit Unit - // Defines the DDoS attack property information that is provided. The // WORDPRESS_PINGBACK_REFLECTOR and WORDPRESS_PINGBACK_SOURCE values are valid only // for WordPress reflective pingback DDoS attacks. @@ -62,6 +55,13 @@ type AttackProperty struct { // The array of Contributor () objects that includes the top five contributors to // an attack. TopContributors []*Contributor + + // The total contributions made to this attack by all contributors, not just the + // five listed in the TopContributors list. + Total *int64 + + // The unit of the Value of the contributions. + Unit Unit } // Summarizes all DDoS attacks for a specified time period. @@ -73,6 +73,11 @@ type AttackSummary struct { // The list of attacks for a specified time period. AttackVectors []*AttackVectorDescription + // The end time of the attack, in Unix time in seconds. For more information see + // timestamp + // (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types). + EndTime *time.Time + // The ARN (Amazon Resource Name) of the resource that was attacked. ResourceArn *string @@ -80,11 +85,6 @@ type AttackSummary struct { // timestamp // (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types). StartTime *time.Time - - // The end time of the attack, in Unix time in seconds. For more information see - // timestamp - // (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types). - EndTime *time.Time } // Describes the attack. @@ -155,9 +155,6 @@ type Contributor struct { // customer support. type EmergencyContact struct { - // The phone number for the contact. - PhoneNumber *string - // The email address for the contact. // // This member is required. @@ -165,16 +162,19 @@ type EmergencyContact struct { // Additional notes regarding the contact. ContactNotes *string + + // The phone number for the contact. + PhoneNumber *string } // Specifies how many protections of a given type you can create. type Limit struct { - // The type of protection. - Type *string - // The maximum number of protections that can be created for the specified Type. Max *int64 + + // The type of protection. + Type *string } // The mitigation applied to a DDoS attack. @@ -191,43 +191,35 @@ type Protection struct { // the protection. HealthCheckIds []*string - // The ARN (Amazon Resource Name) of the AWS resource that is protected. - ResourceArn *string + // The unique identifier (ID) of the protection. + Id *string // The friendly name of the protection. For example, My CloudFront distributions. Name *string - // The unique identifier (ID) of the protection. - Id *string + // The ARN (Amazon Resource Name) of the AWS resource that is protected. + ResourceArn *string } // The attack information for the specified SubResource. type SubResourceSummary struct { - // The counters that describe the details of the attack. - Counters []*SummarizedCounter - - // The SubResource type. - Type SubResourceType - // The list of attack types and associated counters. AttackVectors []*SummarizedAttackVector + // The counters that describe the details of the attack. + Counters []*SummarizedCounter + // The unique identifier (ID) of the SubResource. Id *string + + // The SubResource type. + Type SubResourceType } // Information about the AWS Shield Advanced subscription for an account. type Subscription struct { - // The start time of the subscription, in Unix time in seconds. For more - // information see timestamp - // (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types). - StartTime *time.Time - - // Specifies how many protections of a given type you can create. - Limits []*Limit - // If ENABLED, the subscription will be automatically renewed at the end of the // existing subscription period. When you initally create a subscription, AutoRenew // is set to ENABLED. You can change this by submitting an UpdateSubscription @@ -238,8 +230,8 @@ type Subscription struct { // The date and time your subscription will end. EndTime *time.Time - // The length, in seconds, of the AWS Shield Advanced subscription for the account. - TimeCommitmentInSeconds *int64 + // Specifies how many protections of a given type you can create. + Limits []*Limit // If ENABLED, the DDoS Response Team (DRT) will use email and phone to notify // contacts about escalations to the DRT and to initiate proactive customer @@ -248,40 +240,48 @@ type Subscription struct { // DISABLED, the DRT will not proactively notify contacts about escalations or to // initiate proactive customer support. ProactiveEngagementStatus ProactiveEngagementStatus + + // The start time of the subscription, in Unix time in seconds. For more + // information see timestamp + // (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types). + StartTime *time.Time + + // The length, in seconds, of the AWS Shield Advanced subscription for the account. + TimeCommitmentInSeconds *int64 } // A summary of information about the attack. type SummarizedAttackVector struct { - // The list of counters that describe the details of the attack. - VectorCounters []*SummarizedCounter - // The attack type, for example, SNMP reflection or SYN flood. // // This member is required. VectorType *string + + // The list of counters that describe the details of the attack. + VectorCounters []*SummarizedCounter } // The counter that describes a DDoS attack. type SummarizedCounter struct { - // The number of counters for a specified time period. - N *int32 - - // The unit of the counters. - Unit *string - // The average value of the counter for a specified time period. Average *float64 // The maximum value of the counter for a specified time period. Max *float64 - // The total of counter values for a specified time period. - Sum *float64 + // The number of counters for a specified time period. + N *int32 // The counter name. Name *string + + // The total of counter values for a specified time period. + Sum *float64 + + // The unit of the counters. + Unit *string } // The time range. diff --git a/service/signer/api_op_DescribeSigningJob.go b/service/signer/api_op_DescribeSigningJob.go index a9415949cc0..32ae89459af 100644 --- a/service/signer/api_op_DescribeSigningJob.go +++ b/service/signer/api_op_DescribeSigningJob.go @@ -67,46 +67,46 @@ type DescribeSigningJobInput struct { type DescribeSigningJobOutput struct { - // The object that contains the name of your S3 bucket or your raw code. - Source *types.Source + // Date and time that the signing job was completed. + CompletedAt *time.Time + + // Date and time that the signing job was created. + CreatedAt *time.Time // The ID of the signing job on output. JobId *string - // The Amazon Resource Name (ARN) of your code signing certificate. - SigningMaterial *types.SigningMaterial + // A list of any overrides that were applied to the signing operation. + Overrides *types.SigningPlatformOverrides // The microcontroller platform to which your signed code image will be // distributed. PlatformId *string - // Status of the signing job. - Status types.SigningStatus - - // Name of the S3 bucket where the signed code image is saved by code signing. - SignedObject *types.SignedObject - - // String value that contains the status reason. - StatusReason *string + // The name of the profile that initiated the signing operation. + ProfileName *string // The IAM principal that requested the signing job. RequestedBy *string - // Date and time that the signing job was completed. - CompletedAt *time.Time + // Name of the S3 bucket where the signed code image is saved by code signing. + SignedObject *types.SignedObject - // A list of any overrides that were applied to the signing operation. - Overrides *types.SigningPlatformOverrides + // The Amazon Resource Name (ARN) of your code signing certificate. + SigningMaterial *types.SigningMaterial // Map of user-assigned key-value pairs used during signing. These values contain // any information that you specified for use in your signing job. SigningParameters map[string]*string - // Date and time that the signing job was created. - CreatedAt *time.Time + // The object that contains the name of your S3 bucket or your raw code. + Source *types.Source - // The name of the profile that initiated the signing operation. - ProfileName *string + // Status of the signing job. + Status types.SigningStatus + + // String value that contains the status reason. + StatusReason *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/signer/api_op_GetSigningPlatform.go b/service/signer/api_op_GetSigningPlatform.go index 834a3046436..31c1a18b1f9 100644 --- a/service/signer/api_op_GetSigningPlatform.go +++ b/service/signer/api_op_GetSigningPlatform.go @@ -65,6 +65,16 @@ type GetSigningPlatformInput struct { type GetSigningPlatformOutput struct { + // The category type of the target signing platform. + Category types.Category + + // The display name of the target signing platform. + DisplayName *string + + // The maximum size (in MB) of the payload that can be signed by the target + // platform. + MaxSizeInMB *int32 + // A list of partner entities that use the target signing platform. Partner *string @@ -74,22 +84,12 @@ type GetSigningPlatformOutput struct { // A list of configurations applied to the target platform at signing. SigningConfiguration *types.SigningConfiguration - // The category type of the target signing platform. - Category types.Category - // The format of the target platform's signing image. SigningImageFormat *types.SigningImageFormat - // The maximum size (in MB) of the payload that can be signed by the target - // platform. - MaxSizeInMB *int32 - // The validation template that is used by the target signing platform. Target *string - // The display name of the target signing platform. - DisplayName *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/signer/api_op_GetSigningProfile.go b/service/signer/api_op_GetSigningProfile.go index 72b5aec8c01..f79393171ac 100644 --- a/service/signer/api_op_GetSigningProfile.go +++ b/service/signer/api_op_GetSigningProfile.go @@ -65,31 +65,31 @@ type GetSigningProfileInput struct { type GetSigningProfileOutput struct { + // The Amazon Resource Name (ARN) for the signing profile. + Arn *string + // A list of overrides applied by the target signing profile for signing // operations. Overrides *types.SigningPlatformOverrides - // The Amazon Resource Name (ARN) for the signing profile. - Arn *string + // The ID of the platform that is used by the target signing profile. + PlatformId *string - // A map of key-value pairs for signing operations that is attached to the target - // signing profile. - SigningParameters map[string]*string + // The name of the target signing profile. + ProfileName *string // The ARN of the certificate that the target profile uses for signing operations. SigningMaterial *types.SigningMaterial - // The ID of the platform that is used by the target signing profile. - PlatformId *string - - // A list of tags associated with the signing profile. - Tags map[string]*string + // A map of key-value pairs for signing operations that is attached to the target + // signing profile. + SigningParameters map[string]*string // The status of the target signing profile. Status types.SigningProfileStatus - // The name of the target signing profile. - ProfileName *string + // A list of tags associated with the signing profile. + Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/signer/api_op_ListSigningJobs.go b/service/signer/api_op_ListSigningJobs.go index c63de2c6173..aa3a693746b 100644 --- a/service/signer/api_op_ListSigningJobs.go +++ b/service/signer/api_op_ListSigningJobs.go @@ -62,10 +62,6 @@ func (c *Client) ListSigningJobs(ctx context.Context, params *ListSigningJobsInp type ListSigningJobsInput struct { - // The ID of microcontroller platform that you specified for the distribution of - // your code image. - PlatformId *string - // Specifies the maximum number of items to return in the response. Use this // parameter when paginating results. If additional items exist beyond the number // you specify, the nextToken element is set in the response. Use the nextToken @@ -78,6 +74,10 @@ type ListSigningJobsInput struct { // received. NextToken *string + // The ID of microcontroller platform that you specified for the distribution of + // your code image. + PlatformId *string + // The IAM principal that requested the signing job. RequestedBy *string @@ -87,12 +87,12 @@ type ListSigningJobsInput struct { type ListSigningJobsOutput struct { - // String for specifying the next set of paginated results. - NextToken *string - // A list of your signing jobs. Jobs []*types.SigningJob + // String for specifying the next set of paginated results. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/signer/api_op_ListSigningPlatforms.go b/service/signer/api_op_ListSigningPlatforms.go index c71feb8551d..5c67416f3e2 100644 --- a/service/signer/api_op_ListSigningPlatforms.go +++ b/service/signer/api_op_ListSigningPlatforms.go @@ -61,23 +61,23 @@ func (c *Client) ListSigningPlatforms(ctx context.Context, params *ListSigningPl type ListSigningPlatformsInput struct { + // The category type of a signing platform. + Category *string + + // The maximum number of results to be returned by this operation. + MaxResults *int32 + // Value for specifying the next set of paginated results to return. After you // receive a response with truncated results, use this parameter in a subsequent // request. Set it to the value of nextToken from the response that you just // received. NextToken *string - // The maximum number of results to be returned by this operation. - MaxResults *int32 - // Any partner entities connected to a signing platform. Partner *string // The validation template that is used by the target signing platform. Target *string - - // The category type of a signing platform. - Category *string } type ListSigningPlatformsOutput struct { diff --git a/service/signer/api_op_ListSigningProfiles.go b/service/signer/api_op_ListSigningProfiles.go index 5445b38bb83..17124666ac3 100644 --- a/service/signer/api_op_ListSigningProfiles.go +++ b/service/signer/api_op_ListSigningProfiles.go @@ -65,25 +65,25 @@ type ListSigningProfilesInput struct { // Designates whether to include profiles with the status of CANCELED. IncludeCanceled *bool + // The maximum number of profiles to be returned. + MaxResults *int32 + // Value for specifying the next set of paginated results to return. After you // receive a response with truncated results, use this parameter in a subsequent // request. Set it to the value of nextToken from the response that you just // received. NextToken *string - - // The maximum number of profiles to be returned. - MaxResults *int32 } type ListSigningProfilesOutput struct { + // Value for specifying the next set of paginated results to return. + NextToken *string + // A list of profiles that are available in the AWS account. This includes profiles // with the status of CANCELED if the includeCanceled parameter is set to true. Profiles []*types.SigningProfile - // Value for specifying the next set of paginated results to return. - NextToken *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/signer/api_op_PutSigningProfile.go b/service/signer/api_op_PutSigningProfile.go index ce873431f53..7a701725f0f 100644 --- a/service/signer/api_op_PutSigningProfile.go +++ b/service/signer/api_op_PutSigningProfile.go @@ -60,14 +60,22 @@ func (c *Client) PutSigningProfile(ctx context.Context, params *PutSigningProfil type PutSigningProfileInput struct { - // Tags to be associated with the signing profile that is being created. - Tags map[string]*string + // The ID of the signing platform to be created. + // + // This member is required. + PlatformId *string // The name of the signing profile to be created. // // This member is required. ProfileName *string + // The AWS Certificate Manager certificate that will be used to sign code with the + // new signing profile. + // + // This member is required. + SigningMaterial *types.SigningMaterial + // A subfield of platform. This specifies any different configuration options that // you want to apply to the chosen platform (such as a different hash-algorithm or // signing-algorithm). @@ -77,16 +85,8 @@ type PutSigningProfileInput struct { // want to use during signing. SigningParameters map[string]*string - // The ID of the signing platform to be created. - // - // This member is required. - PlatformId *string - - // The AWS Certificate Manager certificate that will be used to sign code with the - // new signing profile. - // - // This member is required. - SigningMaterial *types.SigningMaterial + // Tags to be associated with the signing profile that is being created. + Tags map[string]*string } type PutSigningProfileOutput struct { diff --git a/service/signer/api_op_StartSigningJob.go b/service/signer/api_op_StartSigningJob.go index e26de680e2c..01e0797f62c 100644 --- a/service/signer/api_op_StartSigningJob.go +++ b/service/signer/api_op_StartSigningJob.go @@ -84,26 +84,26 @@ func (c *Client) StartSigningJob(ctx context.Context, params *StartSigningJobInp type StartSigningJobInput struct { - // The name of the signing profile. - ProfileName *string - // String that identifies the signing request. All calls after the first that use // this token return the same response as the first call. // // This member is required. ClientRequestToken *string + // The S3 bucket in which to save your signed object. The destination contains the + // name of your bucket and an optional prefix. + // + // This member is required. + Destination *types.Destination + // The S3 bucket that contains the object to sign or a BLOB that contains your raw // code. // // This member is required. Source *types.Source - // The S3 bucket in which to save your signed object. The destination contains the - // name of your bucket and an optional prefix. - // - // This member is required. - Destination *types.Destination + // The name of the signing profile. + ProfileName *string } type StartSigningJobOutput struct { diff --git a/service/signer/api_op_TagResource.go b/service/signer/api_op_TagResource.go index 6caaa2063e6..2d7c0b28eca 100644 --- a/service/signer/api_op_TagResource.go +++ b/service/signer/api_op_TagResource.go @@ -59,15 +59,15 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // One or more tags to be associated with the signing profile. + // The Amazon Resource Name (ARN) for the signing profile. // // This member is required. - Tags map[string]*string + ResourceArn *string - // The Amazon Resource Name (ARN) for the signing profile. + // One or more tags to be associated with the signing profile. // // This member is required. - ResourceArn *string + Tags map[string]*string } type TagResourceOutput struct { diff --git a/service/signer/go.mod b/service/signer/go.mod index 826ec75a8f3..fe0a699d6a5 100644 --- a/service/signer/go.mod +++ b/service/signer/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/signer go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/signer/types/types.go b/service/signer/types/types.go index ecd70353ced..66a48545e84 100644 --- a/service/signer/types/types.go +++ b/service/signer/types/types.go @@ -17,16 +17,16 @@ type Destination struct { // The encryption algorithm options that are available to a code signing job. type EncryptionAlgorithmOptions struct { - // The default encryption algorithm that is used by a code signing job. - // - // This member is required. - DefaultValue EncryptionAlgorithm - // The set of accepted encryption algorithms that are allowed in a code signing // job. // // This member is required. AllowedValues []EncryptionAlgorithm + + // The default encryption algorithm that is used by a code signing job. + // + // This member is required. + DefaultValue EncryptionAlgorithm } // The hash algorithms that are available to a code signing job. @@ -73,15 +73,15 @@ type S3Source struct { // This member is required. BucketName *string - // Version of your source image in your version enabled S3 bucket. + // Key name of the bucket object that contains your unsigned code. // // This member is required. - Version *string + Key *string - // Key name of the bucket object that contains your unsigned code. + // Version of your source image in your version enabled S3 bucket. // // This member is required. - Key *string + Version *string } // Points to an S3SignedObject object that contains information about your signed @@ -136,25 +136,25 @@ type SigningImageFormat struct { // Contains information about a signing job. type SigningJob struct { - // The status of the signing job. - Status SigningStatus - - // A Source that contains information about a signing job's code image source. - Source *Source + // The date and time that the signing job was created. + CreatedAt *time.Time // The ID of the signing job. JobId *string + // A SignedObject structure that contains information about a signing job's signed + // code image. + SignedObject *SignedObject + // A SigningMaterial object that contains the Amazon Resource Name (ARN) of the // certificate used for the signing job. SigningMaterial *SigningMaterial - // The date and time that the signing job was created. - CreatedAt *time.Time + // A Source that contains information about a signing job's code image source. + Source *Source - // A SignedObject structure that contains information about a signing job's signed - // code image. - SignedObject *SignedObject + // The status of the signing job. + Status SigningStatus } // The ACM certificate that is used to sign your code. @@ -171,30 +171,30 @@ type SigningMaterial struct { // used to perform a code signing job. type SigningPlatform struct { - // The types of targets that can be signed by a code signing platform. - Target *string + // The category of a code signing platform. + Category Category // The display name of a code signing platform. DisplayName *string - // The configuration of a code signing platform. This includes the designated hash - // algorithm and encryption algorithm of a signing platform. - SigningConfiguration *SigningConfiguration + // The maximum size (in MB) of code that can be signed by a code signing platform. + MaxSizeInMB *int32 - // The image format of a code signing platform or profile. - SigningImageFormat *SigningImageFormat + // Any partner entities linked to a code signing platform. + Partner *string // The ID of a code signing; platform. PlatformId *string - // The category of a code signing platform. - Category Category + // The configuration of a code signing platform. This includes the designated hash + // algorithm and encryption algorithm of a signing platform. + SigningConfiguration *SigningConfiguration - // Any partner entities linked to a code signing platform. - Partner *string + // The image format of a code signing platform or profile. + SigningImageFormat *SigningImageFormat - // The maximum size (in MB) of code that can be signed by a code signing platform. - MaxSizeInMB *int32 + // The types of targets that can be signed by a code signing platform. + Target *string } // Any overrides that are applied to the signing configuration of a code signing @@ -217,26 +217,26 @@ type SigningPlatformOverrides struct { // parameters that can be used by a given code signing user. type SigningProfile struct { - // The ACM certificate that is available for use by a signing profile. - SigningMaterial *SigningMaterial + // The Amazon Resource Name (ARN) for the signing profile. + Arn *string - // The parameters that are available for use by a code signing user. - SigningParameters map[string]*string + // The ID of a platform that is available for use by a signing profile. + PlatformId *string // The name of the signing profile. ProfileName *string - // The ID of a platform that is available for use by a signing profile. - PlatformId *string - - // The Amazon Resource Name (ARN) for the signing profile. - Arn *string + // The ACM certificate that is available for use by a signing profile. + SigningMaterial *SigningMaterial - // A list of tags associated with the signing profile. - Tags map[string]*string + // The parameters that are available for use by a code signing user. + SigningParameters map[string]*string // The status of a code signing profile. Status SigningProfileStatus + + // A list of tags associated with the signing profile. + Tags map[string]*string } // An S3Source object that contains information about the S3 bucket where you saved diff --git a/service/sms/api_op_CreateApp.go b/service/sms/api_op_CreateApp.go index 9ef6a762f0c..ac22fa3436e 100644 --- a/service/sms/api_op_CreateApp.go +++ b/service/sms/api_op_CreateApp.go @@ -57,9 +57,6 @@ func (c *Client) CreateApp(ctx context.Context, params *CreateAppInput, optFns . type CreateAppInput struct { - // Name of the new application. - Name *string - // A unique, case-sensitive identifier you provide to ensure idempotency of // application creation. ClientToken *string @@ -67,14 +64,17 @@ type CreateAppInput struct { // Description of the new application Description *string - // List of tags to be associated with the application. - Tags []*types.Tag + // Name of the new application. + Name *string + + // Name of service role in customer's account to be used by AWS SMS. + RoleName *string // List of server groups to include in the application. ServerGroups []*types.ServerGroup - // Name of service role in customer's account to be used by AWS SMS. - RoleName *string + // List of tags to be associated with the application. + Tags []*types.Tag } type CreateAppOutput struct { diff --git a/service/sms/api_op_CreateReplicationJob.go b/service/sms/api_op_CreateReplicationJob.go index 00f9b5d761d..5ec7ef2b50f 100644 --- a/service/sms/api_op_CreateReplicationJob.go +++ b/service/sms/api_op_CreateReplicationJob.go @@ -60,33 +60,25 @@ func (c *Client) CreateReplicationJob(ctx context.Context, params *CreateReplica type CreateReplicationJobInput struct { - // The name of the IAM role to be used by the AWS SMS. - RoleName *string + // The seed replication time. + // + // This member is required. + SeedReplicationTime *time.Time // The identifier of the server. // // This member is required. ServerId *string - // - RunOnce *bool - // The description of the replication job. Description *string - // The time between consecutive replication runs, in hours. - Frequency *int32 - - // The maximum number of SMS-created AMIs to retain. The oldest will be deleted - // once the maximum number is reached and a new AMI is created. - NumberOfRecentAmisToKeep *int32 - - // The license type to be used for the AMI created by a successful replication run. - LicenseType types.LicenseType - // When true, the replication job produces encrypted AMIs. See also KmsKeyId below. Encrypted *bool + // The time between consecutive replication runs, in hours. + Frequency *int32 + // KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the // following: // @@ -103,10 +95,18 @@ type CreateReplicationJobInput struct { // id is not specified, the customer's default KMS key for EBS is used. KmsKeyId *string - // The seed replication time. + // The license type to be used for the AMI created by a successful replication run. + LicenseType types.LicenseType + + // The maximum number of SMS-created AMIs to retain. The oldest will be deleted + // once the maximum number is reached and a new AMI is created. + NumberOfRecentAmisToKeep *int32 + + // The name of the IAM role to be used by the AWS SMS. + RoleName *string + // - // This member is required. - SeedReplicationTime *time.Time + RunOnce *bool } type CreateReplicationJobOutput struct { diff --git a/service/sms/api_op_DeleteApp.go b/service/sms/api_op_DeleteApp.go index 5577c661ef4..1e469ddee87 100644 --- a/service/sms/api_op_DeleteApp.go +++ b/service/sms/api_op_DeleteApp.go @@ -57,16 +57,16 @@ func (c *Client) DeleteApp(ctx context.Context, params *DeleteAppInput, optFns . type DeleteAppInput struct { - // While deleting the application, terminate the stack corresponding to the - // application. - ForceTerminateApp *bool + // ID of the application to delete. + AppId *string // While deleting the application, stop all replication jobs corresponding to the // servers in the application. ForceStopAppReplication *bool - // ID of the application to delete. - AppId *string + // While deleting the application, terminate the stack corresponding to the + // application. + ForceTerminateApp *bool } type DeleteAppOutput struct { diff --git a/service/sms/api_op_GenerateChangeSet.go b/service/sms/api_op_GenerateChangeSet.go index 5d4785a7457..7a64999b64e 100644 --- a/service/sms/api_op_GenerateChangeSet.go +++ b/service/sms/api_op_GenerateChangeSet.go @@ -57,11 +57,11 @@ func (c *Client) GenerateChangeSet(ctx context.Context, params *GenerateChangeSe type GenerateChangeSetInput struct { - // Format for the change set. - ChangesetFormat types.OutputFormat - // ID of the application associated with the change set. AppId *string + + // Format for the change set. + ChangesetFormat types.OutputFormat } type GenerateChangeSetOutput struct { diff --git a/service/sms/api_op_GenerateTemplate.go b/service/sms/api_op_GenerateTemplate.go index b671c6e741f..e3f59ac6240 100644 --- a/service/sms/api_op_GenerateTemplate.go +++ b/service/sms/api_op_GenerateTemplate.go @@ -58,11 +58,11 @@ func (c *Client) GenerateTemplate(ctx context.Context, params *GenerateTemplateI type GenerateTemplateInput struct { - // Format for generating the Amazon CloudFormation template. - TemplateFormat types.OutputFormat - // ID of the application associated with the Amazon CloudFormation template. AppId *string + + // Format for generating the Amazon CloudFormation template. + TemplateFormat types.OutputFormat } type GenerateTemplateOutput struct { diff --git a/service/sms/api_op_GetApp.go b/service/sms/api_op_GetApp.go index 4af8b27eca4..76eb792f87a 100644 --- a/service/sms/api_op_GetApp.go +++ b/service/sms/api_op_GetApp.go @@ -62,12 +62,12 @@ type GetAppInput struct { type GetAppOutput struct { - // List of server groups belonging to the application. - ServerGroups []*types.ServerGroup - // Information about the application. AppSummary *types.AppSummary + // List of server groups belonging to the application. + ServerGroups []*types.ServerGroup + // List of tags associated with the application. Tags []*types.Tag diff --git a/service/sms/api_op_GetAppLaunchConfiguration.go b/service/sms/api_op_GetAppLaunchConfiguration.go index 84540ce1879..f135185cd57 100644 --- a/service/sms/api_op_GetAppLaunchConfiguration.go +++ b/service/sms/api_op_GetAppLaunchConfiguration.go @@ -62,15 +62,15 @@ type GetAppLaunchConfigurationInput struct { type GetAppLaunchConfigurationOutput struct { - // List of launch configurations for server groups in this application. - ServerGroupLaunchConfigurations []*types.ServerGroupLaunchConfiguration + // ID of the application associated with the launch configuration. + AppId *string // Name of the service role in the customer's account that Amazon CloudFormation // uses to launch the application. RoleName *string - // ID of the application associated with the launch configuration. - AppId *string + // List of launch configurations for server groups in this application. + ServerGroupLaunchConfigurations []*types.ServerGroupLaunchConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sms/api_op_GetConnectors.go b/service/sms/api_op_GetConnectors.go index 35a16112e4c..30011276fb4 100644 --- a/service/sms/api_op_GetConnectors.go +++ b/service/sms/api_op_GetConnectors.go @@ -56,24 +56,24 @@ func (c *Client) GetConnectors(ctx context.Context, params *GetConnectorsInput, type GetConnectorsInput struct { - // The token for the next set of results. - NextToken *string - // The maximum number of results to return in a single call. The default value is // 50. To retrieve the remaining results, make another call with the returned // NextToken value. MaxResults *int32 + + // The token for the next set of results. + NextToken *string } type GetConnectorsOutput struct { + // Information about the registered connectors. + ConnectorList []*types.Connector + // The token required to retrieve the next set of results. This value is null when // there are no more results to return. NextToken *string - // Information about the registered connectors. - ConnectorList []*types.Connector - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sms/api_op_GetReplicationJobs.go b/service/sms/api_op_GetReplicationJobs.go index 2df9858d292..4c9cd6655a6 100644 --- a/service/sms/api_op_GetReplicationJobs.go +++ b/service/sms/api_op_GetReplicationJobs.go @@ -61,22 +61,22 @@ type GetReplicationJobsInput struct { // NextToken value. MaxResults *int32 - // The identifier of the replication job. - ReplicationJobId *string - // The token for the next set of results. NextToken *string + + // The identifier of the replication job. + ReplicationJobId *string } type GetReplicationJobsOutput struct { - // Information about the replication jobs. - ReplicationJobList []*types.ReplicationJob - // The token required to retrieve the next set of results. This value is null when // there are no more results to return. NextToken *string + // Information about the replication jobs. + ReplicationJobList []*types.ReplicationJob + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sms/api_op_GetReplicationRuns.go b/service/sms/api_op_GetReplicationRuns.go index e05ea0e95cf..10148cf60cc 100644 --- a/service/sms/api_op_GetReplicationRuns.go +++ b/service/sms/api_op_GetReplicationRuns.go @@ -62,27 +62,27 @@ type GetReplicationRunsInput struct { // This member is required. ReplicationJobId *string - // The token for the next set of results. - NextToken *string - // The maximum number of results to return in a single call. The default value is // 50. To retrieve the remaining results, make another call with the returned // NextToken value. MaxResults *int32 + + // The token for the next set of results. + NextToken *string } type GetReplicationRunsOutput struct { + // The token required to retrieve the next set of results. This value is null when + // there are no more results to return. + NextToken *string + // Information about the replication job. ReplicationJob *types.ReplicationJob // Information about the replication runs. ReplicationRunList []*types.ReplicationRun - // The token required to retrieve the next set of results. This value is null when - // there are no more results to return. - NextToken *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sms/api_op_GetServers.go b/service/sms/api_op_GetServers.go index 78484da2ef1..68887e5b68d 100644 --- a/service/sms/api_op_GetServers.go +++ b/service/sms/api_op_GetServers.go @@ -63,28 +63,28 @@ type GetServersInput struct { // NextToken value. MaxResults *int32 - // List of VmServerAddress objects - VmServerAddressList []*types.VmServerAddress - // The token for the next set of results. NextToken *string + + // List of VmServerAddress objects + VmServerAddressList []*types.VmServerAddress } type GetServersOutput struct { - // The status of the server catalog. - ServerCatalogStatus types.ServerCatalogStatus + // The time when the server was last modified. + LastModifiedOn *time.Time // The token required to retrieve the next set of results. This value is null when // there are no more results to return. NextToken *string + // The status of the server catalog. + ServerCatalogStatus types.ServerCatalogStatus + // Information about the servers. ServerList []*types.Server - // The time when the server was last modified. - LastModifiedOn *time.Time - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sms/api_op_ListApps.go b/service/sms/api_op_ListApps.go index f4b09dc3076..a9e1cad81d3 100644 --- a/service/sms/api_op_ListApps.go +++ b/service/sms/api_op_ListApps.go @@ -56,9 +56,6 @@ func (c *Client) ListApps(ctx context.Context, params *ListAppsInput, optFns ... type ListAppsInput struct { - // The token for the next set of results. - NextToken *string - // AppIds []*string @@ -66,6 +63,9 @@ type ListAppsInput struct { // 50. To retrieve the remaining results, make another call with the returned // NextToken value. MaxResults *int32 + + // The token for the next set of results. + NextToken *string } type ListAppsOutput struct { diff --git a/service/sms/api_op_PutAppLaunchConfiguration.go b/service/sms/api_op_PutAppLaunchConfiguration.go index fdc89a1e298..9910b8dde30 100644 --- a/service/sms/api_op_PutAppLaunchConfiguration.go +++ b/service/sms/api_op_PutAppLaunchConfiguration.go @@ -56,15 +56,15 @@ func (c *Client) PutAppLaunchConfiguration(ctx context.Context, params *PutAppLa type PutAppLaunchConfigurationInput struct { - // Launch configurations for server groups in the application. - ServerGroupLaunchConfigurations []*types.ServerGroupLaunchConfiguration + // ID of the application associated with the launch configuration. + AppId *string // Name of service role in the customer's account that Amazon CloudFormation uses // to launch the application. RoleName *string - // ID of the application associated with the launch configuration. - AppId *string + // Launch configurations for server groups in the application. + ServerGroupLaunchConfigurations []*types.ServerGroupLaunchConfiguration } type PutAppLaunchConfigurationOutput struct { diff --git a/service/sms/api_op_PutAppReplicationConfiguration.go b/service/sms/api_op_PutAppReplicationConfiguration.go index 272b1af0d6d..692ea7a00df 100644 --- a/service/sms/api_op_PutAppReplicationConfiguration.go +++ b/service/sms/api_op_PutAppReplicationConfiguration.go @@ -56,11 +56,11 @@ func (c *Client) PutAppReplicationConfiguration(ctx context.Context, params *Put type PutAppReplicationConfigurationInput struct { - // Replication configurations for server groups in the application. - ServerGroupReplicationConfigurations []*types.ServerGroupReplicationConfiguration - // ID of the application tassociated with the replication configuration. AppId *string + + // Replication configurations for server groups in the application. + ServerGroupReplicationConfigurations []*types.ServerGroupReplicationConfiguration } type PutAppReplicationConfigurationOutput struct { diff --git a/service/sms/api_op_UpdateApp.go b/service/sms/api_op_UpdateApp.go index 5f2a9855ae0..e9756fe4c3a 100644 --- a/service/sms/api_op_UpdateApp.go +++ b/service/sms/api_op_UpdateApp.go @@ -56,23 +56,23 @@ func (c *Client) UpdateApp(ctx context.Context, params *UpdateAppInput, optFns . type UpdateAppInput struct { - // Name of the service role in the customer's account used by AWS SMS. - RoleName *string + // ID of the application to update. + AppId *string + + // New description of the application. + Description *string // New name of the application. Name *string - // ID of the application to update. - AppId *string + // Name of the service role in the customer's account used by AWS SMS. + RoleName *string // List of server groups in the application to update. ServerGroups []*types.ServerGroup // List of tags to associate with the application. Tags []*types.Tag - - // New description of the application. - Description *string } type UpdateAppOutput struct { @@ -80,12 +80,12 @@ type UpdateAppOutput struct { // Summary description of the application. AppSummary *types.AppSummary - // List of tags associated with the application. - Tags []*types.Tag - // List of updated server groups in the application. ServerGroups []*types.ServerGroup + // List of tags associated with the application. + Tags []*types.Tag + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sms/api_op_UpdateReplicationJob.go b/service/sms/api_op_UpdateReplicationJob.go index ae781e9cdaa..9e7cfad7a9b 100644 --- a/service/sms/api_op_UpdateReplicationJob.go +++ b/service/sms/api_op_UpdateReplicationJob.go @@ -58,19 +58,20 @@ func (c *Client) UpdateReplicationJob(ctx context.Context, params *UpdateReplica type UpdateReplicationJobInput struct { + // The identifier of the replication job. + // + // This member is required. + ReplicationJobId *string + + // The description of the replication job. + Description *string + // When true, the replication job produces encrypted AMIs . See also KmsKeyId // below. Encrypted *bool - // The license type to be used for the AMI created by a successful replication run. - LicenseType types.LicenseType - - // The maximum number of SMS-created AMIs to retain. The oldest will be deleted - // once the maximum number is reached and a new AMI is created. - NumberOfRecentAmisToKeep *int32 - - // The start time of the next replication run. - NextReplicationRunStartTime *time.Time + // The time between consecutive replication runs, in hours. + Frequency *int32 // KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the // following: @@ -88,19 +89,18 @@ type UpdateReplicationJobInput struct { // id is not specified, the customer's default KMS key for EBS is used. KmsKeyId *string - // The name of the IAM role to be used by AWS SMS. - RoleName *string + // The license type to be used for the AMI created by a successful replication run. + LicenseType types.LicenseType - // The time between consecutive replication runs, in hours. - Frequency *int32 + // The start time of the next replication run. + NextReplicationRunStartTime *time.Time - // The identifier of the replication job. - // - // This member is required. - ReplicationJobId *string + // The maximum number of SMS-created AMIs to retain. The oldest will be deleted + // once the maximum number is reached and a new AMI is created. + NumberOfRecentAmisToKeep *int32 - // The description of the replication job. - Description *string + // The name of the IAM role to be used by AWS SMS. + RoleName *string } type UpdateReplicationJobOutput struct { diff --git a/service/sms/go.mod b/service/sms/go.mod index 439b1f323a3..3a63e564fe9 100644 --- a/service/sms/go.mod +++ b/service/sms/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/sms go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/sms/types/types.go b/service/sms/types/types.go index 7d8e81a71e0..0f4b2d8810b 100644 --- a/service/sms/types/types.go +++ b/service/sms/types/types.go @@ -9,14 +9,11 @@ import ( // Information about the application. type AppSummary struct { - // Details about the latest launch of the application. - LaunchDetails *LaunchDetails - - // Status of the application. - Status AppStatus + // Unique ID of the application. + AppId *string - // Launch status of the application. - LaunchStatus AppLaunchStatus + // Time of creation of this application. + CreationTime *time.Time // Description of the application. Description *string @@ -24,85 +21,88 @@ type AppSummary struct { // Timestamp of the application's creation. LastModified *time.Time - // Time of creation of this application. - CreationTime *time.Time + // Timestamp of the application's most recent successful replication. + LatestReplicationTime *time.Time - // A message related to the status of the application - StatusMessage *string + // Details about the latest launch of the application. + LaunchDetails *LaunchDetails - // Replication status of the application. - ReplicationStatus AppReplicationStatus + // Launch status of the application. + LaunchStatus AppLaunchStatus // A message related to the launch status of the application. LaunchStatusMessage *string - // Unique ID of the application. - AppId *string - - // Number of server groups present in the application. - TotalServerGroups *int32 - - // Number of servers present in the application. - TotalServers *int32 - // Name of the application. Name *string + // Replication status of the application. + ReplicationStatus AppReplicationStatus + // A message related to the replication status of the application. ReplicationStatusMessage *string // Name of the service role in the customer's account used by AWS SMS. RoleName *string - // Timestamp of the application's most recent successful replication. - LatestReplicationTime *time.Time + // Status of the application. + Status AppStatus + + // A message related to the status of the application + StatusMessage *string + + // Number of server groups present in the application. + TotalServerGroups *int32 + + // Number of servers present in the application. + TotalServers *int32 } // Represents a connector. type Connector struct { - // The name of the VM manager. - VmManagerName *string + // The time the connector was associated. + AssociatedOn *time.Time - // The MAC address of the connector. - MacAddress *string + // The capabilities of the connector. + CapabilityList []ConnectorCapability // The identifier of the connector. ConnectorId *string - // The identifier of the VM manager. - VmManagerId *string + // The IP address of the connector. + IpAddress *string - // The VM management product. - VmManagerType VmManagerType + // The MAC address of the connector. + MacAddress *string - // The capabilities of the connector. - CapabilityList []ConnectorCapability + // The status of the connector. + Status ConnectorStatus // The connector version. Version *string - // The status of the connector. - Status ConnectorStatus + // The identifier of the VM manager. + VmManagerId *string - // The time the connector was associated. - AssociatedOn *time.Time + // The name of the VM manager. + VmManagerName *string - // The IP address of the connector. - IpAddress *string + // The VM management product. + VmManagerType VmManagerType } // Details about the latest launch of an application. type LaunchDetails struct { - // Name of the latest stack launched for this application. - StackName *string - // Latest time this application was launched successfully. LatestLaunchTime *time.Time // Identifier of the latest stack launched for this application. StackId *string + + // Name of the latest stack launched for this application. + StackName *string } // Represents a replication job. @@ -111,41 +111,13 @@ type ReplicationJob struct { // The description of the replication job. Description *string - // Information about the replication runs. - ReplicationRunList []*ReplicationRun - - // The state of the replication job. - State ReplicationJobState - - // The name of the IAM role to be used by the Server Migration Service. - RoleName *string - - // - RunOnce *bool - - // Information about the VM server. - VmServer *VmServer - - // Number of recent AMIs to keep in the customer's account for a replication job. - // By default the value is set to zero, meaning that all AMIs are kept. - NumberOfRecentAmisToKeep *int32 - - // The identifier of the server. - ServerId *string - - // The time between consecutive replication runs, in hours. - Frequency *int32 - - // The identifier of the replication job. - ReplicationJobId *string - - // The description of the current status of the replication job. - StatusMessage *string - // Whether the replication job should produce encrypted AMIs or not. See also // KmsKeyId below. Encrypted *bool + // The time between consecutive replication runs, in hours. + Frequency *int32 + // KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the // following: // @@ -162,28 +134,66 @@ type ReplicationJob struct { // id is not specified, the customer's default KMS key for EBS is used. KmsKeyId *string + // The ID of the latest Amazon Machine Image (AMI). + LatestAmiId *string + // The license type to be used for the AMI created by a successful replication run. LicenseType LicenseType - // The type of server. - ServerType ServerType + // The start time of the next replication run. + NextReplicationRunStartTime *time.Time + + // Number of recent AMIs to keep in the customer's account for a replication job. + // By default the value is set to zero, meaning that all AMIs are kept. + NumberOfRecentAmisToKeep *int32 + + // The identifier of the replication job. + ReplicationJobId *string + + // Information about the replication runs. + ReplicationRunList []*ReplicationRun + + // The name of the IAM role to be used by the Server Migration Service. + RoleName *string + + // + RunOnce *bool // The seed replication time. SeedReplicationTime *time.Time - // The start time of the next replication run. - NextReplicationRunStartTime *time.Time + // The identifier of the server. + ServerId *string - // The ID of the latest Amazon Machine Image (AMI). - LatestAmiId *string + // The type of server. + ServerType ServerType + + // The state of the replication job. + State ReplicationJobState + + // The description of the current status of the replication job. + StatusMessage *string + + // Information about the VM server. + VmServer *VmServer } // Represents a replication run. type ReplicationRun struct { + // The identifier of the Amazon Machine Image (AMI) from the replication run. + AmiId *string + // The completion time of the last replication run. CompletedTime *time.Time + // The description of the replication run. + Description *string + + // Whether the replication run should produce encrypted AMI or not. See also + // KmsKeyId below. + Encrypted *bool + // KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the // following: // @@ -200,8 +210,8 @@ type ReplicationRun struct { // id is not specified, the customer's default KMS key for EBS is used. KmsKeyId *string - // The state of the replication run. - State ReplicationRunState + // The identifier of the replication run. + ReplicationRunId *string // The start time of the next replication run. ScheduledStartTime *time.Time @@ -209,74 +219,64 @@ type ReplicationRun struct { // Details of the current stage of the replication run. StageDetails *ReplicationRunStageDetails - // Whether the replication run should produce encrypted AMI or not. See also - // KmsKeyId below. - Encrypted *bool - - // The identifier of the Amazon Machine Image (AMI) from the replication run. - AmiId *string + // The state of the replication run. + State ReplicationRunState - // The description of the replication run. - Description *string + // The description of the current status of the replication job. + StatusMessage *string // The type of replication run. Type ReplicationRunType - - // The identifier of the replication run. - ReplicationRunId *string - - // The description of the current status of the replication job. - StatusMessage *string } // Details of the current stage of a replication run. type ReplicationRunStageDetails struct { - // String describing the progress of the current stage of a replication run. - StageProgress *string - // String describing the current stage of a replication run. Stage *string + + // String describing the progress of the current stage of a replication run. + StageProgress *string } // Location of the Amazon S3 object in the customer's account. type S3Location struct { - // Amazon S3 bucket key. - Key *string - // Amazon S3 bucket name. Bucket *string + + // Amazon S3 bucket key. + Key *string } // Represents a server. type Server struct { - // Information about the VM server. - VmServer *VmServer - - // The type of server. - ServerType ServerType + // The identifier of the replication job. + ReplicationJobId *string // Indicates whether the replication job is deleted or failed. ReplicationJobTerminated *bool - // The identifier of the replication job. - ReplicationJobId *string - // The identifier of the server. ServerId *string + + // The type of server. + ServerType ServerType + + // Information about the VM server. + VmServer *VmServer } // A logical grouping of servers. type ServerGroup struct { - // Identifier of a server group. - ServerGroupId *string - // Name of a server group. Name *string + // Identifier of a server group. + ServerGroupId *string + // List of servers belonging to a server group. ServerList []*Server } @@ -287,53 +287,53 @@ type ServerGroupLaunchConfiguration struct { // Launch order of servers in the server group. LaunchOrder *int32 - // Launch configuration for servers in the server group. - ServerLaunchConfigurations []*ServerLaunchConfiguration - // Identifier of the server group the launch configuration is associated with. ServerGroupId *string + + // Launch configuration for servers in the server group. + ServerLaunchConfigurations []*ServerLaunchConfiguration } // Replication configuration for a server group. type ServerGroupReplicationConfiguration struct { - // Replication configuration for servers in the server group. - ServerReplicationConfigurations []*ServerReplicationConfiguration - // Identifier of the server group this replication configuration is associated // with. ServerGroupId *string + + // Replication configuration for servers in the server group. + ServerReplicationConfigurations []*ServerReplicationConfiguration } // Launch configuration for a server. type ServerLaunchConfiguration struct { - // Identifier of the security group that applies to the launched server. - SecurityGroup *string - // If true, a publicly accessible IP address is created when launching the server. AssociatePublicIpAddress *bool - // Identifier of the VPC the server should be launched into. - Vpc *string - - // Logical ID of the server in the Amazon CloudFormation template. - LogicalId *string + // Name of the EC2 SSH Key to be used for connecting to the launched server. + Ec2KeyName *string // Instance type to be used for launching the server. InstanceType *string - // Identifier of the subnet the server should be launched into. - Subnet *string + // Logical ID of the server in the Amazon CloudFormation template. + LogicalId *string + + // Identifier of the security group that applies to the launched server. + SecurityGroup *string // Identifier of the server the launch configuration is associated with. Server *Server - // Name of the EC2 SSH Key to be used for connecting to the launched server. - Ec2KeyName *string + // Identifier of the subnet the server should be launched into. + Subnet *string // Location of the user-data script to be executed when launching the server. UserData *UserData + + // Identifier of the VPC the server should be launched into. + Vpc *string } // Replication configuration of a server. @@ -349,6 +349,9 @@ type ServerReplicationConfiguration struct { // Replication parameters for replicating a server. type ServerReplicationParameters struct { + // When true, the replication job produces encrypted AMIs. See also KmsKeyId below. + Encrypted *bool + // Frequency of creating replication jobs for the server. Frequency *int32 @@ -368,17 +371,14 @@ type ServerReplicationParameters struct { // id is not specified, the customer's default KMS key for EBS is used. KmsKeyId *string - // - RunOnce *bool + // License type for creating a replication job for the server. + LicenseType LicenseType // Number of recent AMIs to keep when creating a replication job for this server. NumberOfRecentAmisToKeep *int32 - // License type for creating a replication job for the server. - LicenseType LicenseType - - // When true, the replication job produces encrypted AMIs. See also KmsKeyId below. - Encrypted *bool + // + RunOnce *bool // Seed time for creating a replication job for the server. SeedTime *time.Time @@ -405,28 +405,28 @@ type UserData struct { // Represents a VM server. type VmServer struct { - // The VM folder path in the vCenter Server virtual machine inventory tree. - VmPath *string - // The name of the VM manager. VmManagerName *string + // The type of VM management product. + VmManagerType VmManagerType + // The name of the VM. VmName *string + // The VM folder path in the vCenter Server virtual machine inventory tree. + VmPath *string + // Information about the VM server location. VmServerAddress *VmServerAddress - - // The type of VM management product. - VmManagerType VmManagerType } // Represents a VM server location. type VmServerAddress struct { - // The identifier of the VM manager. - VmManagerId *string - // The identifier of the VM. VmId *string + + // The identifier of the VM manager. + VmManagerId *string } diff --git a/service/snowball/api_op_CreateCluster.go b/service/snowball/api_op_CreateCluster.go index 292e7ace440..5cd6dbf6613 100644 --- a/service/snowball/api_op_CreateCluster.go +++ b/service/snowball/api_op_CreateCluster.go @@ -64,9 +64,17 @@ type CreateClusterInput struct { // This member is required. AddressId *string - // An optional description of this specific cluster, for example Environmental Data - // Cluster-01. - Description *string + // The type of job for this cluster. Currently, the only job type supported for + // clusters is LOCAL_USE. + // + // This member is required. + JobType types.JobType + + // The resources associated with the cluster job. These resources include Amazon S3 + // buckets and optional AWS Lambda functions written in the Python language. + // + // This member is required. + Resources *types.JobResource // The RoleARN that you want to associate with this cluster. RoleArn values are // created by using the CreateRole @@ -76,13 +84,6 @@ type CreateClusterInput struct { // This member is required. RoleARN *string - // The tax documents required in your AWS Region. - TaxDocuments *types.TaxDocuments - - // The forwarding address ID for a cluster. This field is not supported in most - // regions. - ForwardingAddressId *string - // The shipping speed for each node in this cluster. This speed doesn't dictate how // soon you'll get each Snowball Edge device, rather it represents how quickly each // device moves to its destination while in transit. Regional shipping speeds are @@ -115,14 +116,13 @@ type CreateClusterInput struct { // This member is required. ShippingOption types.ShippingOption - // The type of AWS Snowball device to use for this cluster.

    For - // cluster jobs, AWS Snowball currently supports only the EDGE device - // type.

     - SnowballType types.SnowballType + // An optional description of this specific cluster, for example Environmental Data + // Cluster-01. + Description *string - // The Amazon Simple Notification Service (Amazon SNS) notification settings for - // this cluster. - Notification *types.Notification + // The forwarding address ID for a cluster. This field is not supported in most + // regions. + ForwardingAddressId *string // The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN // values are created by using the CreateKey @@ -130,17 +130,17 @@ type CreateClusterInput struct { // action in AWS Key Management Service (AWS KMS). KmsKeyARN *string - // The type of job for this cluster. Currently, the only job type supported for - // clusters is LOCAL_USE. - // - // This member is required. - JobType types.JobType + // The Amazon Simple Notification Service (Amazon SNS) notification settings for + // this cluster. + Notification *types.Notification - // The resources associated with the cluster job. These resources include Amazon S3 - // buckets and optional AWS Lambda functions written in the Python language. - // - // This member is required. - Resources *types.JobResource + // The type of AWS Snowball device to use for this cluster.

    For + // cluster jobs, AWS Snowball currently supports only the EDGE device + // type.

     + SnowballType types.SnowballType + + // The tax documents required in your AWS Region. + TaxDocuments *types.TaxDocuments } type CreateClusterOutput struct { diff --git a/service/snowball/api_op_CreateJob.go b/service/snowball/api_op_CreateJob.go index 16c67c597f9..1fc97baf300 100644 --- a/service/snowball/api_op_CreateJob.go +++ b/service/snowball/api_op_CreateJob.go @@ -61,27 +61,27 @@ func (c *Client) CreateJob(ctx context.Context, params *CreateJobInput, optFns . type CreateJobInput struct { - // The shipping speed for this job. This speed doesn't dictate how soon you'll get - // the Snowball, rather it represents how quickly the Snowball moves to its - // destination while in transit. Regional shipping speeds are as follows:
      - //

    • In Australia, you have access to express shipping. Typically, Snowballs - // shipped express are delivered in about a day.

    • In the European - // Union (EU), you have access to express shipping. Typically, Snowballs shipped - // express are delivered in about a day. In addition, most countries in the EU have - // access to standard shipping, which typically takes less than a week, one - // way.

    • In India, Snowballs are delivered in one to seven - // days.

    • In the US, you have access to one-day shipping and - // two-day shipping.

    - ShippingOption types.ShippingOption + // The ID for the address that you want the Snowball shipped to. + AddressId *string + + // The ID of a cluster. If you're creating a job for a node in a cluster, you need + // to provide only this clusterId value. The other job attributes are inherited + // from the cluster. + ClusterId *string + + // Defines an optional description of this specific job, for example Important + // Photos 2016-08-11. + Description *string + + // Defines the device configuration for an AWS Snowcone job. + DeviceConfiguration *types.DeviceConfiguration // The forwarding address ID for a job. This field is not supported in most // regions. ForwardingAddressId *string - // If your job is being created in one of the US regions, you have the option of - // specifying what size Snowball you'd like for this job. In all other regions, - // Snowballs come with 80 TB in storage capacity. - SnowballCapacityPreference types.SnowballCapacity + // Defines the type of job that you're creating. + JobType types.JobType // The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created // using the CreateKey @@ -89,8 +89,19 @@ type CreateJobInput struct { // Management Service (KMS) API action. KmsKeyARN *string - // Defines the type of job that you're creating. - JobType types.JobType + // Defines the Amazon Simple Notification Service (Amazon SNS) notification + // settings for this job. + Notification *types.Notification + + // Defines the Amazon S3 buckets associated with this job.

    With + // IMPORT jobs, you specify the bucket or buckets that your + // transferred data will be imported into.

    With EXPORT jobs, + // you specify the bucket or buckets that your transferred data will be exported + // from. Optionally, you can also specify a KeyRange value. If you + // choose to export a range, you define the length of the range by providing either + // an inclusive BeginMarker value, an inclusive EndMarker + // value, or both. Ranges are UTF-8 binary sorted.

    + Resources *types.JobResource // The RoleARN that you want to associate with this job. RoleArns are created using // the CreateRole @@ -98,15 +109,23 @@ type CreateJobInput struct { // Identity and Access Management (IAM) API action. RoleARN *string - // Defines the Amazon Simple Notification Service (Amazon SNS) notification - // settings for this job. - Notification *types.Notification - - // The tax documents required in your AWS Region. - TaxDocuments *types.TaxDocuments + // The shipping speed for this job. This speed doesn't dictate how soon you'll get + // the Snowball, rather it represents how quickly the Snowball moves to its + // destination while in transit. Regional shipping speeds are as follows:
      + //

    • In Australia, you have access to express shipping. Typically, Snowballs + // shipped express are delivered in about a day.

    • In the European + // Union (EU), you have access to express shipping. Typically, Snowballs shipped + // express are delivered in about a day. In addition, most countries in the EU have + // access to standard shipping, which typically takes less than a week, one + // way.

    • In India, Snowballs are delivered in one to seven + // days.

    • In the US, you have access to one-day shipping and + // two-day shipping.

    + ShippingOption types.ShippingOption - // Defines the device configuration for an AWS Snowcone job. - DeviceConfiguration *types.DeviceConfiguration + // If your job is being created in one of the US regions, you have the option of + // specifying what size Snowball you'd like for this job. In all other regions, + // Snowballs come with 80 TB in storage capacity. + SnowballCapacityPreference types.SnowballCapacity // The type of AWS Snowball device to use for this job. For cluster jobs, AWS // Snowball currently supports only the EDGE device type. The type of AWS Snowball @@ -116,27 +135,8 @@ type CreateJobInput struct { // in the Snowball Edge Developer Guide. SnowballType types.SnowballType - // Defines an optional description of this specific job, for example Important - // Photos 2016-08-11. - Description *string - - // Defines the Amazon S3 buckets associated with this job.

    With - // IMPORT jobs, you specify the bucket or buckets that your - // transferred data will be imported into.

    With EXPORT jobs, - // you specify the bucket or buckets that your transferred data will be exported - // from. Optionally, you can also specify a KeyRange value. If you - // choose to export a range, you define the length of the range by providing either - // an inclusive BeginMarker value, an inclusive EndMarker - // value, or both. Ranges are UTF-8 binary sorted.

    - Resources *types.JobResource - - // The ID of a cluster. If you're creating a job for a node in a cluster, you need - // to provide only this clusterId value. The other job attributes are inherited - // from the cluster. - ClusterId *string - - // The ID for the address that you want the Snowball shipped to. - AddressId *string + // The tax documents required in your AWS Region. + TaxDocuments *types.TaxDocuments } type CreateJobOutput struct { diff --git a/service/snowball/api_op_DescribeAddresses.go b/service/snowball/api_op_DescribeAddresses.go index 1349b8d32cf..ec0bbdefd80 100644 --- a/service/snowball/api_op_DescribeAddresses.go +++ b/service/snowball/api_op_DescribeAddresses.go @@ -58,13 +58,13 @@ func (c *Client) DescribeAddresses(ctx context.Context, params *DescribeAddresse type DescribeAddressesInput struct { + // The number of ADDRESS objects to return. + MaxResults *int32 + // HTTP requests are stateless. To identify what object comes "next" in the list of // ADDRESS objects, you have the option of specifying a value for NextToken as the // starting point for your list of returned addresses. NextToken *string - - // The number of ADDRESS objects to return. - MaxResults *int32 } type DescribeAddressesOutput struct { diff --git a/service/snowball/api_op_ListClusterJobs.go b/service/snowball/api_op_ListClusterJobs.go index 0e1393b9407..c35ede233c6 100644 --- a/service/snowball/api_op_ListClusterJobs.go +++ b/service/snowball/api_op_ListClusterJobs.go @@ -59,11 +59,6 @@ func (c *Client) ListClusterJobs(ctx context.Context, params *ListClusterJobsInp type ListClusterJobsInput struct { - // HTTP requests are stateless. To identify what object comes "next" in the list of - // JobListEntry objects, you have the option of specifying NextToken as the - // starting point for your returned list. - NextToken *string - // The 39-character ID for the cluster that you want to list, for example // CID123e4567-e89b-12d3-a456-426655440000. // @@ -72,19 +67,24 @@ type ListClusterJobsInput struct { // The number of JobListEntry objects to return. MaxResults *int32 + + // HTTP requests are stateless. To identify what object comes "next" in the list of + // JobListEntry objects, you have the option of specifying NextToken as the + // starting point for your returned list. + NextToken *string } type ListClusterJobsOutput struct { + // Each JobListEntry object contains a job's state, a job's ID, and a value that + // indicates whether the job is a job part, in the case of export jobs. + JobListEntries []*types.JobListEntry + // HTTP requests are stateless. If you use the automatically generated NextToken // value in your next ListClusterJobsResult call, your list of returned jobs will // start from this point in the array. NextToken *string - // Each JobListEntry object contains a job's state, a job's ID, and a value that - // indicates whether the job is a job part, in the case of export jobs. - JobListEntries []*types.JobListEntry - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/snowball/api_op_ListClusters.go b/service/snowball/api_op_ListClusters.go index ea7d81a4779..da1077004a1 100644 --- a/service/snowball/api_op_ListClusters.go +++ b/service/snowball/api_op_ListClusters.go @@ -69,15 +69,15 @@ type ListClustersInput struct { type ListClustersOutput struct { + // Each ClusterListEntry object contains a cluster's state, a cluster's ID, and + // other important status information. + ClusterListEntries []*types.ClusterListEntry + // HTTP requests are stateless. If you use the automatically generated NextToken // value in your next ClusterListEntry call, your list of returned clusters will // start from this point in the array. NextToken *string - // Each ClusterListEntry object contains a cluster's state, a cluster's ID, and - // other important status information. - ClusterListEntries []*types.ClusterListEntry - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/snowball/api_op_ListJobs.go b/service/snowball/api_op_ListJobs.go index bc6390df48b..5087e8548a6 100644 --- a/service/snowball/api_op_ListJobs.go +++ b/service/snowball/api_op_ListJobs.go @@ -60,13 +60,13 @@ func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ... type ListJobsInput struct { + // The number of JobListEntry objects to return. + MaxResults *int32 + // HTTP requests are stateless. To identify what object comes "next" in the list of // JobListEntry objects, you have the option of specifying NextToken as the // starting point for your returned list. NextToken *string - - // The number of JobListEntry objects to return. - MaxResults *int32 } type ListJobsOutput struct { diff --git a/service/snowball/api_op_UpdateCluster.go b/service/snowball/api_op_UpdateCluster.go index 48a64091620..47e4223e3e1 100644 --- a/service/snowball/api_op_UpdateCluster.go +++ b/service/snowball/api_op_UpdateCluster.go @@ -60,37 +60,37 @@ func (c *Client) UpdateCluster(ctx context.Context, params *UpdateClusterInput, type UpdateClusterInput struct { - // The updated ID for the forwarding address for a cluster. This field is not - // supported in most regions. - ForwardingAddressId *string - - // The updated shipping option value of this cluster's ShippingDetails () object. - ShippingOption types.ShippingOption - // The cluster ID of the cluster that you want to update, for example // CID123e4567-e89b-12d3-a456-426655440000. // // This member is required. ClusterId *string + // The ID of the updated Address () object. + AddressId *string + // The updated description of this cluster. Description *string - // The updated arrays of JobResource () objects that can include updated S3Resource - // () objects or LambdaResource () objects. - Resources *types.JobResource - - // The ID of the updated Address () object. - AddressId *string + // The updated ID for the forwarding address for a cluster. This field is not + // supported in most regions. + ForwardingAddressId *string // The new or updated Notification () object. Notification *types.Notification + // The updated arrays of JobResource () objects that can include updated S3Resource + // () objects or LambdaResource () objects. + Resources *types.JobResource + // The new role Amazon Resource Name (ARN) that you want to associate with this // cluster. To create a role ARN, use the CreateRole // (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) API // action in AWS Identity and Access Management (IAM). RoleARN *string + + // The updated shipping option value of this cluster's ShippingDetails () object. + ShippingOption types.ShippingOption } type UpdateClusterOutput struct { diff --git a/service/snowball/api_op_UpdateJob.go b/service/snowball/api_op_UpdateJob.go index 7f22d081e51..4fb77da5ec7 100644 --- a/service/snowball/api_op_UpdateJob.go +++ b/service/snowball/api_op_UpdateJob.go @@ -59,27 +59,27 @@ func (c *Client) UpdateJob(ctx context.Context, params *UpdateJobInput, optFns . type UpdateJobInput struct { - // The updated shipping option value of this job's ShippingDetails () object. - ShippingOption types.ShippingOption + // The job ID of the job that you want to update, for example + // JID123e4567-e89b-12d3-a456-426655440000. + // + // This member is required. + JobId *string - // The updated ID for the forwarding address for a job. This field is not supported - // in most regions. - ForwardingAddressId *string + // The ID of the updated Address () object. + AddressId *string // The updated description of this job's JobMetadata () object. Description *string - // The ID of the updated Address () object. - AddressId *string + // The updated ID for the forwarding address for a job. This field is not supported + // in most regions. + ForwardingAddressId *string // The new or updated Notification () object. Notification *types.Notification - // The job ID of the job that you want to update, for example - // JID123e4567-e89b-12d3-a456-426655440000. - // - // This member is required. - JobId *string + // The updated JobResource object, or the updated JobResource () object. + Resources *types.JobResource // The new role Amazon Resource Name (ARN) that you want to associate with this // job. To create a role ARN, use the CreateRole @@ -87,12 +87,12 @@ type UpdateJobInput struct { // Identity and Access Management (IAM) API action. RoleARN *string + // The updated shipping option value of this job's ShippingDetails () object. + ShippingOption types.ShippingOption + // The updated SnowballCapacityPreference of this job's JobMetadata () object. The // 50 TB Snowballs are only available in the US regions. SnowballCapacityPreference types.SnowballCapacity - - // The updated JobResource object, or the updated JobResource () object. - Resources *types.JobResource } type UpdateJobOutput struct { diff --git a/service/snowball/go.mod b/service/snowball/go.mod index 90394353010..6a4daf905c4 100644 --- a/service/snowball/go.mod +++ b/service/snowball/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/snowball go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/snowball/types/types.go b/service/snowball/types/types.go index 0121016826b..e9ad7567903 100644 --- a/service/snowball/types/types.go +++ b/service/snowball/types/types.go @@ -13,89 +13,91 @@ import ( // invalid or unsupported, then an exception is thrown. type Address struct { - // The second line in a street address that a Snowball is to be delivered to. - Street2 *string + // The unique ID for an address. + AddressId *string - // The third line in a street address that a Snowball is to be delivered to. - Street3 *string + // The city in an address that a Snowball is to be delivered to. + City *string + + // The name of the company to receive a Snowball at an address. + Company *string // The country in an address that a Snowball is to be delivered to. Country *string - // The first line in a street address that a Snowball is to be delivered to. - Street1 *string - - // The state or province in an address that a Snowball is to be delivered to. - StateOrProvince *string - - // This field is no longer used and the value is ignored. - PrefectureOrDistrict *string - // If the address you are creating is a primary address, then set this option to // true. This field is not supported in most regions. IsRestricted *bool - // The postal code in an address that a Snowball is to be delivered to. - PostalCode *string - - // The city in an address that a Snowball is to be delivered to. - City *string - // This field is no longer used and the value is ignored. Landmark *string // The name of a person to receive a Snowball at an address. Name *string - // The name of the company to receive a Snowball at an address. - Company *string - // The phone number associated with an address that a Snowball is to be delivered // to. PhoneNumber *string - // The unique ID for an address. - AddressId *string + // The postal code in an address that a Snowball is to be delivered to. + PostalCode *string + + // This field is no longer used and the value is ignored. + PrefectureOrDistrict *string + + // The state or province in an address that a Snowball is to be delivered to. + StateOrProvince *string + + // The first line in a street address that a Snowball is to be delivered to. + Street1 *string + + // The second line in a street address that a Snowball is to be delivered to. + Street2 *string + + // The third line in a street address that a Snowball is to be delivered to. + Street3 *string } // Contains a cluster's state, a cluster's ID, and other important information. type ClusterListEntry struct { - // Defines an optional description of the cluster, for example Environmental Data - // Cluster-01. - Description *string - // The 39-character ID for the cluster that you want to list, for example // CID123e4567-e89b-12d3-a456-426655440000. ClusterId *string - // The creation date for this cluster. - CreationDate *time.Time - // The current state of this cluster. For information about the state of a specific // node, see JobListEntry$JobState (). ClusterState ClusterState + + // The creation date for this cluster. + CreationDate *time.Time + + // Defines an optional description of the cluster, for example Environmental Data + // Cluster-01. + Description *string } // Contains metadata about a specific cluster. type ClusterMetadata struct { - // The Amazon Simple Notification Service (Amazon SNS) notification settings for - // this cluster. - Notification *Notification + // The automatically generated ID for a specific address. + AddressId *string - // The arrays of JobResource () objects that can include updated S3Resource () - // objects or LambdaResource () objects. - Resources *JobResource + // The automatically generated ID for a cluster. + ClusterId *string // The current status of the cluster. ClusterState ClusterState - // The automatically generated ID for a specific address. - AddressId *string + // The creation date for this cluster. + CreationDate *time.Time - // The automatically generated ID for a cluster. - ClusterId *string + // The optional description of the cluster. + Description *string + + // The ID of the address that you want a cluster shipped to, after it will be + // shipped to its primary address. This field is not supported in most regions. + ForwardingAddressId *string // The type of job for this cluster. Currently, the only job type supported for // clusters is LOCAL_USE. @@ -107,8 +109,13 @@ type ClusterMetadata struct { // action in AWS Key Management Service (AWS KMS). KmsKeyARN *string - // The optional description of the cluster. - Description *string + // The Amazon Simple Notification Service (Amazon SNS) notification settings for + // this cluster. + Notification *Notification + + // The arrays of JobResource () objects that can include updated S3Resource () + // objects or LambdaResource () objects. + Resources *JobResource // The role ARN associated with this cluster. This ARN was created using the // CreateRole @@ -116,16 +123,6 @@ type ClusterMetadata struct { // action in AWS Identity and Access Management (IAM). RoleARN *string - // The tax documents required in your AWS Region. - TaxDocuments *TaxDocuments - - // The creation date for this cluster. - CreationDate *time.Time - - // The ID of the address that you want a cluster shipped to, after it will be - // shipped to its primary address. This field is not supported in most regions. - ForwardingAddressId *string - // The shipping speed for each node in this cluster. This speed doesn't dictate how // soon you'll get each Snowball Edge device, rather it represents how quickly each // device moves to its destination while in transit. Regional shipping speeds are @@ -142,6 +139,9 @@ type ClusterMetadata struct { // The type of AWS Snowball device to use for this cluster. For cluster jobs, AWS // Snowball currently supports only the EDGE device type. SnowballType SnowballType + + // The tax documents required in your AWS Region. + TaxDocuments *TaxDocuments } // A JSON-formatted object that describes a compatible Amazon Machine Image (AMI), @@ -150,11 +150,11 @@ type ClusterMetadata struct { // an SBE1 instance on the device. type CompatibleImage struct { - // The optional name of a compatible image. - Name *string - // The unique identifier for an individual Snowball Edge AMI. AmiId *string + + // The optional name of a compatible image. + Name *string } // Defines the real-time status of a Snowball's data transfer while the device is @@ -162,12 +162,12 @@ type CompatibleImage struct { // InProgress, for both import and export jobs. type DataTransfer struct { - // The number of objects transferred between a Snowball and Amazon S3. - ObjectsTransferred *int64 - // The number of bytes transferred between a Snowball and Amazon S3. BytesTransferred *int64 + // The number of objects transferred between a Snowball and Amazon S3. + ObjectsTransferred *int64 + // The total bytes of data for a transfer between a Snowball and Amazon S3. This // value is set to 0 (zero) until all the keys that will be transferred have been // listed. @@ -219,12 +219,12 @@ type INDTaxDocuments struct { // indicates whether the job is a job part, in the case of an export job. type JobListEntry struct { - // The current state of this job. - JobState JobState + // The creation date for this job. + CreationDate *time.Time - // The automatically generated ID for a job, for example - // JID123e4567-e89b-12d3-a456-426655440000. - JobId *string + // The optional description of this specific job, for example Important Photos + // 2016-08-11. + Description *string // A value that indicates that this job is a master job. A master job represents a // successful request to create an export job. Master jobs aren't associated with @@ -234,18 +234,18 @@ type JobListEntry struct { // created after the master job is created. IsMaster *bool - // The optional description of this specific job, for example Important Photos - // 2016-08-11. - Description *string + // The automatically generated ID for a job, for example + // JID123e4567-e89b-12d3-a456-426655440000. + JobId *string - // The type of device used with this job. - SnowballType SnowballType + // The current state of this job. + JobState JobState // The type of job. JobType JobType - // The creation date for this job. - CreationDate *time.Time + // The type of device used with this job. + SnowballType SnowballType } // Contains job logs. Whenever Snowball is used to import data into or export data @@ -268,11 +268,11 @@ type JobLogs struct { // A link to an Amazon S3 presigned URL where the job completion report is located. JobCompletionReportURI *string - // A link to an Amazon S3 presigned URL where the job success log is located. - JobSuccessLogURI *string - // A link to an Amazon S3 presigned URL where the job failure log is located. JobFailureLogURI *string + + // A link to an Amazon S3 presigned URL where the job success log is located. + JobSuccessLogURI *string } // Contains information about a specific job including shipping information, job @@ -280,14 +280,34 @@ type JobLogs struct { // the response syntax of the DescribeJob action. type JobMetadata struct { + // The ID for the address that you want the Snowball shipped to. + AddressId *string + + // The 39-character ID for the cluster, for example + // CID123e4567-e89b-12d3-a456-426655440000. + ClusterId *string + + // The creation date for this job. + CreationDate *time.Time + // A value that defines the real-time status of a Snowball's data transfer while // the device is at AWS. This data is only available while a job has a JobState // value of InProgress, for both import and export jobs. DataTransferProgress *DataTransfer - // An array of S3Resource objects. Each S3Resource object represents an Amazon S3 - // bucket that your transferred data will be exported from or imported into. - Resources *JobResource + // The description of the job, provided at job creation. + Description *string + + // The container for SnowconeDeviceConfiguration. + DeviceConfiguration *DeviceConfiguration + + // The ID of the address that you want a job shipped to, after it will be shipped + // to its primary address. This field is not supported in most regions. + ForwardingAddressId *string + + // The automatically generated ID for a job, for example + // JID123e4567-e89b-12d3-a456-426655440000. + JobId *string // Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, // the PDF job report becomes available at the end of the import process. For @@ -295,66 +315,46 @@ type JobMetadata struct { // your job part is being delivered to you. JobLogInfo *JobLogs - // The Amazon Simple Notification Service (Amazon SNS) notification settings - // associated with a specific job. The Notification object is returned as a part of - // the response syntax of the DescribeJob action in the JobMetadata data type. - Notification *Notification - // The current status of the jobs. JobState JobState - // The type of device used with this job. - SnowballType SnowballType - - // The 39-character ID for the cluster, for example - // CID123e4567-e89b-12d3-a456-426655440000. - ClusterId *string - - // The metadata associated with the tax documents required in your AWS Region. - TaxDocuments *TaxDocuments - - // The Snowball capacity preference for this job, specified at job creation. In US - // regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use - // 80 TB capacity Snowballs. - SnowballCapacityPreference SnowballCapacity - - // The ID for the address that you want the Snowball shipped to. - AddressId *string - - // The creation date for this job. - CreationDate *time.Time - // The type of job. JobType JobType - // The description of the job, provided at job creation. - Description *string - - // The automatically generated ID for a job, for example - // JID123e4567-e89b-12d3-a456-426655440000. - JobId *string + // The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key + // associated with this job. This ARN was created using the CreateKey + // (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html) API + // action in AWS KMS. + KmsKeyARN *string - // The container for SnowconeDeviceConfiguration. - DeviceConfiguration *DeviceConfiguration + // The Amazon Simple Notification Service (Amazon SNS) notification settings + // associated with a specific job. The Notification object is returned as a part of + // the response syntax of the DescribeJob action in the JobMetadata data type. + Notification *Notification - // A job's shipping information, including inbound and outbound tracking numbers - // and shipping speed options. - ShippingDetails *ShippingDetails + // An array of S3Resource objects. Each S3Resource object represents an Amazon S3 + // bucket that your transferred data will be exported from or imported into. + Resources *JobResource // The role ARN associated with this job. This ARN was created using the CreateRole // (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) API // action in AWS Identity and Access Management (IAM). RoleARN *string - // The ID of the address that you want a job shipped to, after it will be shipped - // to its primary address. This field is not supported in most regions. - ForwardingAddressId *string + // A job's shipping information, including inbound and outbound tracking numbers + // and shipping speed options. + ShippingDetails *ShippingDetails - // The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key - // associated with this job. This ARN was created using the CreateKey - // (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html) API - // action in AWS KMS. - KmsKeyARN *string + // The Snowball capacity preference for this job, specified at job creation. In US + // regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use + // 80 TB capacity Snowballs. + SnowballCapacityPreference SnowballCapacity + + // The type of device used with this job. + SnowballType SnowballType + + // The metadata associated with the tax documents required in your AWS Region. + TaxDocuments *TaxDocuments } // Contains an array of AWS resource objects. Each object represents an Amazon S3 @@ -362,12 +362,12 @@ type JobMetadata struct { // EC2 that is associated with a particular job. type JobResource struct { - // The Python-language Lambda functions for this job. - LambdaResources []*LambdaResource - // The Amazon Machine Images (AMIs) associated with this job. Ec2AmiResources []*Ec2AmiResource + // The Python-language Lambda functions for this job. + LambdaResources []*LambdaResource + // An array of S3Resource objects. S3Resources []*S3Resource } @@ -378,13 +378,13 @@ type JobResource struct { // UTF-8 binary sorted. type KeyRange struct { - // The key that ends an optional key range for an export job. Ranges are inclusive - // and UTF-8 binary sorted. - EndMarker *string - // The key that starts an optional key range for an export job. Ranges are // inclusive and UTF-8 binary sorted. BeginMarker *string + + // The key that ends an optional key range for an export job. Ranges are inclusive + // and UTF-8 binary sorted. + EndMarker *string } // Identifies @@ -409,6 +409,12 @@ type LambdaResource struct { // NotifyAll set to true.

    type Notification struct { + // The list of job states that will trigger a notification for this job. + JobStatesToNotify []JobState + + // Any change in job state will trigger a notification for this job. + NotifyAll *bool + // The new SNS TopicArn that you want to associate with this job. You can create // Amazon Resource Names (ARNs) for topics by using the CreateTopic // (https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html) Amazon SNS API @@ -417,12 +423,6 @@ type Notification struct { // href="https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html">Subscribe // AWS Simple Notification Service (SNS) API action.

    SnsTopicARN *string - - // The list of job states that will trigger a notification for this job. - JobStatesToNotify []JobState - - // Any change in job state will trigger a notification for this job. - NotifyAll *bool } // Each S3Resource object represents an Amazon S3 bucket that your transferred data @@ -432,27 +432,27 @@ type Notification struct { // UTF-8 binary sorted. type S3Resource struct { + // The Amazon Resource Name (ARN) of an Amazon S3 bucket. + BucketArn *string + // For export jobs, you can provide an optional KeyRange within a specific Amazon // S3 bucket. The length of the range is defined at job creation, and has either an // inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are UTF-8 binary // sorted. KeyRange *KeyRange - - // The Amazon Resource Name (ARN) of an Amazon S3 bucket. - BucketArn *string } // The Status and TrackingNumber information for an inbound or outbound shipment. type Shipment struct { + // Status information for a shipment. + Status *string + // The tracking number for this job. Using this tracking number with your region's // carrier's website, you can track a Snowball as the carrier transports it. For // India, the carrier is Amazon Logistics. For all other regions, UPS is the // carrier. TrackingNumber *string - - // Status information for a shipment. - Status *string } // A job's shipping information, including inbound and outbound tracking numbers diff --git a/service/sns/api_op_AddPermission.go b/service/sns/api_op_AddPermission.go index 5a449448020..836ed6f53de 100644 --- a/service/sns/api_op_AddPermission.go +++ b/service/sns/api_op_AddPermission.go @@ -57,17 +57,6 @@ func (c *Client) AddPermission(ctx context.Context, params *AddPermissionInput, type AddPermissionInput struct { - // The action you want to allow for the specified principal(s). Valid values: Any - // Amazon SNS action name, for example Publish. - // - // This member is required. - ActionName []*string - - // The ARN of the topic whose access control policy you wish to modify. - // - // This member is required. - TopicArn *string - // The AWS account IDs of the users (principals) who will be given access to the // specified actions. The users must have AWS accounts, but do not need to be // signed up for this service. @@ -75,10 +64,21 @@ type AddPermissionInput struct { // This member is required. AWSAccountId []*string + // The action you want to allow for the specified principal(s). Valid values: Any + // Amazon SNS action name, for example Publish. + // + // This member is required. + ActionName []*string + // A unique identifier for the new policy statement. // // This member is required. Label *string + + // The ARN of the topic whose access control policy you wish to modify. + // + // This member is required. + TopicArn *string } type AddPermissionOutput struct { diff --git a/service/sns/api_op_ConfirmSubscription.go b/service/sns/api_op_ConfirmSubscription.go index 337a86b8354..a9113f7aded 100644 --- a/service/sns/api_op_ConfirmSubscription.go +++ b/service/sns/api_op_ConfirmSubscription.go @@ -66,16 +66,16 @@ type ConfirmSubscriptionInput struct { // This member is required. Token *string + // The ARN of the topic for which you wish to confirm a subscription. + // + // This member is required. + TopicArn *string + // Disallows unauthenticated unsubscribes of the subscription. If the value of this // parameter is true and the request has an AWS signature, then only the topic // owner and the subscription owner can unsubscribe the endpoint. The unsubscribe // action requires AWS authentication. AuthenticateOnUnsubscribe *string - - // The ARN of the topic for which you wish to confirm a subscription. - // - // This member is required. - TopicArn *string } // Response for ConfirmSubscriptions action. diff --git a/service/sns/api_op_CreatePlatformApplication.go b/service/sns/api_op_CreatePlatformApplication.go index d57a6d7950d..4dc2471364c 100644 --- a/service/sns/api_op_CreatePlatformApplication.go +++ b/service/sns/api_op_CreatePlatformApplication.go @@ -91,19 +91,19 @@ type CreatePlatformApplicationInput struct { // This member is required. Attributes map[string]*string - // The following platforms are supported: ADM (Amazon Device Messaging), APNS - // (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud - // Messaging). - // - // This member is required. - Platform *string - // Application names must be made up of only uppercase and lowercase ASCII letters, // numbers, underscores, hyphens, and periods, and must be between 1 and 256 // characters long. // // This member is required. Name *string + + // The following platforms are supported: ADM (Amazon Device Messaging), APNS + // (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud + // Messaging). + // + // This member is required. + Platform *string } // Response from CreatePlatformApplication action. diff --git a/service/sns/api_op_CreatePlatformEndpoint.go b/service/sns/api_op_CreatePlatformEndpoint.go index 3e3ad6bff02..22a1b7b4c70 100644 --- a/service/sns/api_op_CreatePlatformEndpoint.go +++ b/service/sns/api_op_CreatePlatformEndpoint.go @@ -70,20 +70,12 @@ func (c *Client) CreatePlatformEndpoint(ctx context.Context, params *CreatePlatf // Input for CreatePlatformEndpoint action. type CreatePlatformEndpointInput struct { - // For a list of attributes, see SetEndpointAttributes - // (https://docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html). - Attributes map[string]*string - // PlatformApplicationArn returned from CreatePlatformApplication is used to create // a an endpoint. // // This member is required. PlatformApplicationArn *string - // Arbitrary user data to associate with the endpoint. Amazon SNS does not use this - // data. The data must be in UTF-8 format and less than 2KB. - CustomUserData *string - // Unique identifier created by the notification service for an app on a device. // The specific name for Token will vary, depending on which notification service // is being used. For example, when using APNS as the notification service, you @@ -92,6 +84,14 @@ type CreatePlatformEndpointInput struct { // // This member is required. Token *string + + // For a list of attributes, see SetEndpointAttributes + // (https://docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html). + Attributes map[string]*string + + // Arbitrary user data to associate with the endpoint. Amazon SNS does not use this + // data. The data must be in UTF-8 format and less than 2KB. + CustomUserData *string } // Response from CreateEndpoint action. diff --git a/service/sns/api_op_CreateTopic.go b/service/sns/api_op_CreateTopic.go index bf7b9573aed..033b91f97e1 100644 --- a/service/sns/api_op_CreateTopic.go +++ b/service/sns/api_op_CreateTopic.go @@ -62,9 +62,13 @@ func (c *Client) CreateTopic(ctx context.Context, params *CreateTopicInput, optF // Input for CreateTopic action. type CreateTopicInput struct { - // The list of tags to add to a new topic. To be able to tag a topic on creation, - // you must have the sns:CreateTopic and sns:TagResource permissions. - Tags []*types.Tag + // The name of the topic you want to create. Constraints: Topic names must be made + // up of only uppercase and lowercase ASCII letters, numbers, underscores, and + // hyphens, and must be between 1 and 256 characters long. For a FIFO + // (first-in-first-out) topic, the name must end with the .fifo suffix. + // + // This member is required. + Name *string // A map of attributes with their corresponding values. The following lists the // names, descriptions, and values of the special request parameters that the @@ -104,13 +108,9 @@ type CreateTopicInput struct { // Attributes map[string]*string - // The name of the topic you want to create. Constraints: Topic names must be made - // up of only uppercase and lowercase ASCII letters, numbers, underscores, and - // hyphens, and must be between 1 and 256 characters long. For a FIFO - // (first-in-first-out) topic, the name must end with the .fifo suffix. - // - // This member is required. - Name *string + // The list of tags to add to a new topic. To be able to tag a topic on creation, + // you must have the sns:CreateTopic and sns:TagResource permissions. + Tags []*types.Tag } // Response from CreateTopic action. diff --git a/service/sns/api_op_ListEndpointsByPlatformApplication.go b/service/sns/api_op_ListEndpointsByPlatformApplication.go index e5ef25c355c..83847c82c79 100644 --- a/service/sns/api_op_ListEndpointsByPlatformApplication.go +++ b/service/sns/api_op_ListEndpointsByPlatformApplication.go @@ -81,13 +81,13 @@ type ListEndpointsByPlatformApplicationInput struct { // Response for ListEndpointsByPlatformApplication action. type ListEndpointsByPlatformApplicationOutput struct { + // Endpoints returned for ListEndpointsByPlatformApplication action. + Endpoints []*types.Endpoint + // NextToken string is returned when calling ListEndpointsByPlatformApplication // action if additional records are available after the first page results. NextToken *string - // Endpoints returned for ListEndpointsByPlatformApplication action. - Endpoints []*types.Endpoint - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sns/api_op_ListSubscriptionsByTopic.go b/service/sns/api_op_ListSubscriptionsByTopic.go index 43fa713c54f..1e2763101a8 100644 --- a/service/sns/api_op_ListSubscriptionsByTopic.go +++ b/service/sns/api_op_ListSubscriptionsByTopic.go @@ -62,13 +62,13 @@ func (c *Client) ListSubscriptionsByTopic(ctx context.Context, params *ListSubsc // Input for ListSubscriptionsByTopic action. type ListSubscriptionsByTopicInput struct { - // Token returned by the previous ListSubscriptionsByTopic request. - NextToken *string - // The ARN of the topic for which you wish to find subscriptions. // // This member is required. TopicArn *string + + // Token returned by the previous ListSubscriptionsByTopic request. + NextToken *string } // Response for ListSubscriptionsByTopic action. diff --git a/service/sns/api_op_ListTopics.go b/service/sns/api_op_ListTopics.go index 91429fee50b..cfbbffcc46a 100644 --- a/service/sns/api_op_ListTopics.go +++ b/service/sns/api_op_ListTopics.go @@ -66,13 +66,13 @@ type ListTopicsInput struct { // Response for ListTopics action. type ListTopicsOutput struct { - // A list of topic ARNs. - Topics []*types.Topic - // Token to pass along to the next ListTopics request. This element is returned if // there are additional topics to retrieve. NextToken *string + // A list of topic ARNs. + Topics []*types.Topic + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sns/api_op_Publish.go b/service/sns/api_op_Publish.go index f1667ee9917..4c359781b6f 100644 --- a/service/sns/api_op_Publish.go +++ b/service/sns/api_op_Publish.go @@ -124,26 +124,9 @@ type PublishInput struct { // This member is required. Message *string - // Optional parameter to be used as the "Subject" line when the message is - // delivered to email endpoints. This field will also be included, if present, in - // the standard JSON messages delivered to other endpoints. Constraints: Subjects - // must be ASCII text that begins with a letter, number, or punctuation mark; must - // not include line breaks or control characters; and must be less than 100 - // characters long. - Subject *string - - // If you don't specify a value for the TargetArn parameter, you must specify a - // value for the PhoneNumber or TopicArn parameters. - TargetArn *string - // Message attributes for Publish action. MessageAttributes map[string]*types.MessageAttributeValue - // The phone number to which you want to deliver an SMS message. Use E.164 format. - // If you don't specify a value for the PhoneNumber parameter, you must specify a - // value for the TargetArn or TopicArn parameters. - PhoneNumber *string - // Set MessageStructure to json if you want to send a different message for each // protocol. For example, using one publish action, you can send a short message to // your SMS subscribers and a longer message to your email subscribers. If you set @@ -160,6 +143,23 @@ type PublishInput struct { // (e.g., "http"). Valid value: json MessageStructure *string + // The phone number to which you want to deliver an SMS message. Use E.164 format. + // If you don't specify a value for the PhoneNumber parameter, you must specify a + // value for the TargetArn or TopicArn parameters. + PhoneNumber *string + + // Optional parameter to be used as the "Subject" line when the message is + // delivered to email endpoints. This field will also be included, if present, in + // the standard JSON messages delivered to other endpoints. Constraints: Subjects + // must be ASCII text that begins with a letter, number, or punctuation mark; must + // not include line breaks or control characters; and must be less than 100 + // characters long. + Subject *string + + // If you don't specify a value for the TargetArn parameter, you must specify a + // value for the PhoneNumber or TopicArn parameters. + TargetArn *string + // The topic you want to publish to. If you don't specify a value for the TopicArn // parameter, you must specify a value for the PhoneNumber or TargetArn parameters. TopicArn *string diff --git a/service/sns/api_op_RemovePermission.go b/service/sns/api_op_RemovePermission.go index ca0509312f3..5ed6c574a44 100644 --- a/service/sns/api_op_RemovePermission.go +++ b/service/sns/api_op_RemovePermission.go @@ -57,15 +57,15 @@ func (c *Client) RemovePermission(ctx context.Context, params *RemovePermissionI // Input for RemovePermission action. type RemovePermissionInput struct { - // The ARN of the topic whose access control policy you wish to modify. + // The unique label of the statement you want to remove. // // This member is required. - TopicArn *string + Label *string - // The unique label of the statement you want to remove. + // The ARN of the topic whose access control policy you wish to modify. // // This member is required. - Label *string + TopicArn *string } type RemovePermissionOutput struct { diff --git a/service/sns/api_op_SetEndpointAttributes.go b/service/sns/api_op_SetEndpointAttributes.go index 6b2e1d8c2c7..f7c28f07c32 100644 --- a/service/sns/api_op_SetEndpointAttributes.go +++ b/service/sns/api_op_SetEndpointAttributes.go @@ -60,11 +60,6 @@ func (c *Client) SetEndpointAttributes(ctx context.Context, params *SetEndpointA // Input for SetEndpointAttributes action. type SetEndpointAttributesInput struct { - // EndpointArn used for SetEndpointAttributes action. - // - // This member is required. - EndpointArn *string - // A map of the endpoint attributes. Attributes in this map include the // following: // @@ -84,6 +79,11 @@ type SetEndpointAttributesInput struct { // // This member is required. Attributes map[string]*string + + // EndpointArn used for SetEndpointAttributes action. + // + // This member is required. + EndpointArn *string } type SetEndpointAttributesOutput struct { diff --git a/service/sns/api_op_SetPlatformApplicationAttributes.go b/service/sns/api_op_SetPlatformApplicationAttributes.go index 7e6b779b72e..014d0b9ab2d 100644 --- a/service/sns/api_op_SetPlatformApplicationAttributes.go +++ b/service/sns/api_op_SetPlatformApplicationAttributes.go @@ -63,11 +63,6 @@ func (c *Client) SetPlatformApplicationAttributes(ctx context.Context, params *S // Input for SetPlatformApplicationAttributes action. type SetPlatformApplicationAttributesInput struct { - // PlatformApplicationArn for SetPlatformApplicationAttributes action. - // - // This member is required. - PlatformApplicationArn *string - // A map of the platform application attributes. Attributes in this map include the // following: // @@ -108,6 +103,11 @@ type SetPlatformApplicationAttributesInput struct { // // This member is required. Attributes map[string]*string + + // PlatformApplicationArn for SetPlatformApplicationAttributes action. + // + // This member is required. + PlatformApplicationArn *string } type SetPlatformApplicationAttributesOutput struct { diff --git a/service/sns/api_op_SetSubscriptionAttributes.go b/service/sns/api_op_SetSubscriptionAttributes.go index 44316f27313..557fb8be927 100644 --- a/service/sns/api_op_SetSubscriptionAttributes.go +++ b/service/sns/api_op_SetSubscriptionAttributes.go @@ -58,11 +58,6 @@ func (c *Client) SetSubscriptionAttributes(ctx context.Context, params *SetSubsc // Input for SetSubscriptionAttributes action. type SetSubscriptionAttributesInput struct { - // The ARN of the subscription to modify. - // - // This member is required. - SubscriptionArn *string - // A map of attributes with their corresponding values. The following lists the // names, descriptions, and values of the special request parameters that the // SetTopicAttributes action uses: @@ -90,6 +85,11 @@ type SetSubscriptionAttributesInput struct { // This member is required. AttributeName *string + // The ARN of the subscription to modify. + // + // This member is required. + SubscriptionArn *string + // The new value for the attribute in JSON format. AttributeValue *string } diff --git a/service/sns/api_op_SetTopicAttributes.go b/service/sns/api_op_SetTopicAttributes.go index 76d7edc40ad..00905d7046b 100644 --- a/service/sns/api_op_SetTopicAttributes.go +++ b/service/sns/api_op_SetTopicAttributes.go @@ -57,14 +57,6 @@ func (c *Client) SetTopicAttributes(ctx context.Context, params *SetTopicAttribu // Input for SetTopicAttributes action. type SetTopicAttributesInput struct { - // The ARN of the topic to modify. - // - // This member is required. - TopicArn *string - - // The new value for the attribute. - AttributeValue *string - // A map of attributes with their corresponding values. The following lists the // names, descriptions, and values of the special request parameters that the // SetTopicAttributes action uses: @@ -102,6 +94,14 @@ type SetTopicAttributesInput struct { // // This member is required. AttributeName *string + + // The ARN of the topic to modify. + // + // This member is required. + TopicArn *string + + // The new value for the attribute. + AttributeValue *string } type SetTopicAttributesOutput struct { diff --git a/service/sns/api_op_Subscribe.go b/service/sns/api_op_Subscribe.go index 2f6a1d2e700..76da63bf7ef 100644 --- a/service/sns/api_op_Subscribe.go +++ b/service/sns/api_op_Subscribe.go @@ -62,11 +62,6 @@ func (c *Client) Subscribe(ctx context.Context, params *SubscribeInput, optFns . // Input for Subscribe action. type SubscribeInput struct { - // The ARN of the topic you want to subscribe to. - // - // This member is required. - TopicArn *string - // The protocol you want to use. Supported protocols include: // // * http – @@ -95,6 +90,36 @@ type SubscribeInput struct { // This member is required. Protocol *string + // The ARN of the topic you want to subscribe to. + // + // This member is required. + TopicArn *string + + // A map of attributes with their corresponding values. The following lists the + // names, descriptions, and values of the special request parameters that the + // SetTopicAttributes action uses: + // + // * DeliveryPolicy – The policy that defines + // how Amazon SNS retries failed deliveries to HTTP/S endpoints. + // + // * + // FilterPolicy – The simple JSON object that lets your subscriber receive only a + // subset of messages, rather than receiving every message published to the + // topic. + // + // * RawMessageDelivery – When set to true, enables raw message + // delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the + // endpoints to process JSON formatting, which is otherwise created for Amazon SNS + // metadata. + // + // * RedrivePolicy – When specified, sends undeliverable messages to + // the specified Amazon SQS dead-letter queue. Messages that can't be delivered due + // to client errors (for example, when the subscribed endpoint is unreachable) or + // server errors (for example, when the service that powers the subscribed endpoint + // becomes unavailable) are held in the dead-letter queue for further analysis or + // reprocessing. + Attributes map[string]*string + // The endpoint that you want to receive notifications. Endpoints vary by // protocol: // @@ -136,31 +161,6 @@ type SubscribeInput struct { // // The default value is false. ReturnSubscriptionArn *bool - - // A map of attributes with their corresponding values. The following lists the - // names, descriptions, and values of the special request parameters that the - // SetTopicAttributes action uses: - // - // * DeliveryPolicy – The policy that defines - // how Amazon SNS retries failed deliveries to HTTP/S endpoints. - // - // * - // FilterPolicy – The simple JSON object that lets your subscriber receive only a - // subset of messages, rather than receiving every message published to the - // topic. - // - // * RawMessageDelivery – When set to true, enables raw message - // delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the - // endpoints to process JSON formatting, which is otherwise created for Amazon SNS - // metadata. - // - // * RedrivePolicy – When specified, sends undeliverable messages to - // the specified Amazon SQS dead-letter queue. Messages that can't be delivered due - // to client errors (for example, when the subscribed endpoint is unreachable) or - // server errors (for example, when the service that powers the subscribed endpoint - // becomes unavailable) are held in the dead-letter queue for further analysis or - // reprocessing. - Attributes map[string]*string } // Response for Subscribe action. diff --git a/service/sns/api_op_TagResource.go b/service/sns/api_op_TagResource.go index 5a420843d70..afd5f5cc4be 100644 --- a/service/sns/api_op_TagResource.go +++ b/service/sns/api_op_TagResource.go @@ -76,16 +76,16 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The tags to be added to the specified topic. A tag consists of a required key - // and an optional value. + // The ARN of the topic to which to add tags. // // This member is required. - Tags []*types.Tag + ResourceArn *string - // The ARN of the topic to which to add tags. + // The tags to be added to the specified topic. A tag consists of a required key + // and an optional value. // // This member is required. - ResourceArn *string + Tags []*types.Tag } type TagResourceOutput struct { diff --git a/service/sns/api_op_UntagResource.go b/service/sns/api_op_UntagResource.go index 58cfdf2a251..641bcc6726d 100644 --- a/service/sns/api_op_UntagResource.go +++ b/service/sns/api_op_UntagResource.go @@ -58,15 +58,15 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The list of tag keys to remove from the specified topic. + // The ARN of the topic from which to remove tags. // // This member is required. - TagKeys []*string + ResourceArn *string - // The ARN of the topic from which to remove tags. + // The list of tag keys to remove from the specified topic. // // This member is required. - ResourceArn *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/sns/go.mod b/service/sns/go.mod index 6e7baec6a30..8f08a9047e7 100644 --- a/service/sns/go.mod +++ b/service/sns/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/sns go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/sns/types/types.go b/service/sns/types/types.go index 72877545418..7c3d582a347 100644 --- a/service/sns/types/types.go +++ b/service/sns/types/types.go @@ -23,11 +23,6 @@ type Endpoint struct { // (https://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html). type MessageAttributeValue struct { - // Strings are Unicode with UTF8 binary encoding. For a list of code values, see - // ASCII Printable Characters - // (https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters). - StringValue *string - // Amazon SNS supports the following logical data types: String, String.Array, // Number, and Binary. For more information, see Message Attribute Data Types // (https://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html#SNSMessageAttributes.DataTypes). @@ -38,6 +33,11 @@ type MessageAttributeValue struct { // Binary type attributes can store any binary data, for example, compressed data, // encrypted data, or images. BinaryValue []byte + + // Strings are Unicode with UTF8 binary encoding. For a list of code values, see + // ASCII Printable Characters + // (https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters). + StringValue *string } // Platform application object. @@ -53,18 +53,18 @@ type PlatformApplication struct { // A wrapper type for the attributes of an Amazon SNS subscription. type Subscription struct { - // The subscription's protocol. - Protocol *string + // The subscription's endpoint (format depends on the protocol). + Endpoint *string // The subscription's owner. Owner *string + // The subscription's protocol. + Protocol *string + // The subscription's ARN. SubscriptionArn *string - // The subscription's endpoint (format depends on the protocol). - Endpoint *string - // The ARN of the subscription's topic. TopicArn *string } diff --git a/service/sqs/api_op_AddPermission.go b/service/sqs/api_op_AddPermission.go index af6545dcbe8..e6a37dca414 100644 --- a/service/sqs/api_op_AddPermission.go +++ b/service/sqs/api_op_AddPermission.go @@ -87,13 +87,6 @@ func (c *Client) AddPermission(ctx context.Context, params *AddPermissionInput, // type AddPermissionInput struct { - // The unique identification of the permission you're setting (for example, - // AliceSendMessage). Maximum 80 characters. Allowed characters include - // alphanumeric characters, hyphens (-), and underscores (_). - // - // This member is required. - Label *string - // The AWS account number of the principal // (https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P) who is given // permission. The principal must have an AWS account, but does not need to be @@ -105,12 +98,6 @@ type AddPermissionInput struct { // This member is required. AWSAccountIds []*string - // The URL of the Amazon SQS queue to which permissions are added. Queue URLs and - // names are case-sensitive. - // - // This member is required. - QueueUrl *string - // The action the client wants to allow for the specified principal. Valid values: // the name of any action or *. For more information about these actions, see // Overview of Managing Access Permissions to Your Amazon Simple Queue Service @@ -123,6 +110,19 @@ type AddPermissionInput struct { // // This member is required. Actions []*string + + // The unique identification of the permission you're setting (for example, + // AliceSendMessage). Maximum 80 characters. Allowed characters include + // alphanumeric characters, hyphens (-), and underscores (_). + // + // This member is required. + Label *string + + // The URL of the Amazon SQS queue to which permissions are added. Queue URLs and + // names are case-sensitive. + // + // This member is required. + QueueUrl *string } type AddPermissionOutput struct { diff --git a/service/sqs/api_op_ChangeMessageVisibility.go b/service/sqs/api_op_ChangeMessageVisibility.go index 150c909b374..062b6fd8472 100644 --- a/service/sqs/api_op_ChangeMessageVisibility.go +++ b/service/sqs/api_op_ChangeMessageVisibility.go @@ -101,6 +101,12 @@ func (c *Client) ChangeMessageVisibility(ctx context.Context, params *ChangeMess type ChangeMessageVisibilityInput struct { + // The URL of the Amazon SQS queue whose message's visibility is changed. Queue + // URLs and names are case-sensitive. + // + // This member is required. + QueueUrl *string + // The receipt handle associated with the message whose visibility timeout is // changed. This parameter is returned by the ReceiveMessage () action. // @@ -112,12 +118,6 @@ type ChangeMessageVisibilityInput struct { // // This member is required. VisibilityTimeout *int32 - - // The URL of the Amazon SQS queue whose message's visibility is changed. Queue - // URLs and names are case-sensitive. - // - // This member is required. - QueueUrl *string } type ChangeMessageVisibilityOutput struct { diff --git a/service/sqs/api_op_ChangeMessageVisibilityBatch.go b/service/sqs/api_op_ChangeMessageVisibilityBatch.go index 07a3445909f..1c917e407d9 100644 --- a/service/sqs/api_op_ChangeMessageVisibilityBatch.go +++ b/service/sqs/api_op_ChangeMessageVisibilityBatch.go @@ -86,15 +86,15 @@ type ChangeMessageVisibilityBatchInput struct { // BatchResultErrorEntry () tag if the message fails. type ChangeMessageVisibilityBatchOutput struct { - // A list of ChangeMessageVisibilityBatchResultEntry () items. + // A list of BatchResultErrorEntry () items. // // This member is required. - Successful []*types.ChangeMessageVisibilityBatchResultEntry + Failed []*types.BatchResultErrorEntry - // A list of BatchResultErrorEntry () items. + // A list of ChangeMessageVisibilityBatchResultEntry () items. // // This member is required. - Failed []*types.BatchResultErrorEntry + Successful []*types.ChangeMessageVisibilityBatchResultEntry // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sqs/api_op_CreateQueue.go b/service/sqs/api_op_CreateQueue.go index b4e441646a0..be9643119fd 100644 --- a/service/sqs/api_op_CreateQueue.go +++ b/service/sqs/api_op_CreateQueue.go @@ -97,27 +97,6 @@ func (c *Client) CreateQueue(ctx context.Context, params *CreateQueueInput, optF // type CreateQueueInput struct { - // Add cost allocation tags to the specified Amazon SQS queue. For an overview, see - // Tagging Your Amazon SQS Queues - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html) - // in the Amazon Simple Queue Service Developer Guide.

    When you use queue tags, - // keep the following guidelines in mind:

    • Adding more than 50 tags - // to a queue isn't recommended.

    • Tags don't have any semantic - // meaning. Amazon SQS interprets tags as character strings.

    • Tags - // are case-sensitive.

    • A new tag with a key identical to that of - // an existing tag overwrites the existing tag.

    For a full list - // of tag restrictions, see Limits - // Related to Queues in the Amazon Simple Queue Service Developer - // Guide.

    To be able to tag a queue on creation, you must have - // the sqs:CreateQueue and sqs:TagQueue permissions.

    - //

    Cross-account permissions don't apply to this action. For more information, - // see Grant - // Cross-Account Permissions to a Role and a User Name in the Amazon Simple - // Queue Service Developer Guide.

     - Tags map[string]*string - // The name of the new queue. The following limits apply to this name: // // * A @@ -248,6 +227,27 @@ type CreateQueueInput struct { // messages are treated as duplicates and only one copy of the message is // delivered.

    Attributes map[string]*string + + // Add cost allocation tags to the specified Amazon SQS queue. For an overview, see + // Tagging Your Amazon SQS Queues + // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html) + // in the Amazon Simple Queue Service Developer Guide.

    When you use queue tags, + // keep the following guidelines in mind:

    • Adding more than 50 tags + // to a queue isn't recommended.

    • Tags don't have any semantic + // meaning. Amazon SQS interprets tags as character strings.

    • Tags + // are case-sensitive.

    • A new tag with a key identical to that of + // an existing tag overwrites the existing tag.

    For a full list + // of tag restrictions, see Limits + // Related to Queues in the Amazon Simple Queue Service Developer + // Guide.

    To be able to tag a queue on creation, you must have + // the sqs:CreateQueue and sqs:TagQueue permissions.

    + //

    Cross-account permissions don't apply to this action. For more information, + // see Grant + // Cross-Account Permissions to a Role and a User Name in the Amazon Simple + // Queue Service Developer Guide.

     + Tags map[string]*string } // Returns the QueueUrl attribute of the created queue. diff --git a/service/sqs/api_op_DeleteMessage.go b/service/sqs/api_op_DeleteMessage.go index 44d4c2de74e..daf2fbb4efe 100644 --- a/service/sqs/api_op_DeleteMessage.go +++ b/service/sqs/api_op_DeleteMessage.go @@ -73,16 +73,16 @@ func (c *Client) DeleteMessage(ctx context.Context, params *DeleteMessageInput, // type DeleteMessageInput struct { - // The receipt handle associated with the message to delete. - // - // This member is required. - ReceiptHandle *string - // The URL of the Amazon SQS queue from which messages are deleted. Queue URLs and // names are case-sensitive. // // This member is required. QueueUrl *string + + // The receipt handle associated with the message to delete. + // + // This member is required. + ReceiptHandle *string } type DeleteMessageOutput struct { diff --git a/service/sqs/api_op_GetQueueUrl.go b/service/sqs/api_op_GetQueueUrl.go index d9e5833142d..0ae0839c4e2 100644 --- a/service/sqs/api_op_GetQueueUrl.go +++ b/service/sqs/api_op_GetQueueUrl.go @@ -63,15 +63,15 @@ func (c *Client) GetQueueUrl(ctx context.Context, params *GetQueueUrlInput, optF // type GetQueueUrlInput struct { - // The AWS account ID of the account that created the queue. - QueueOwnerAWSAccountId *string - // The name of the queue whose URL must be fetched. Maximum 80 characters. Valid // values: alphanumeric characters, hyphens (-), and underscores (_). Queue URLs // and names are case-sensitive. // // This member is required. QueueName *string + + // The AWS account ID of the account that created the queue. + QueueOwnerAWSAccountId *string } // For more information, see Interpreting Responses diff --git a/service/sqs/api_op_ListDeadLetterSourceQueues.go b/service/sqs/api_op_ListDeadLetterSourceQueues.go index fe86967ce12..cb5673b533f 100644 --- a/service/sqs/api_op_ListDeadLetterSourceQueues.go +++ b/service/sqs/api_op_ListDeadLetterSourceQueues.go @@ -77,15 +77,15 @@ type ListDeadLetterSourceQueuesInput struct { // A list of your dead letter source queues. type ListDeadLetterSourceQueuesOutput struct { - // Pagination token to include in the next request. - NextToken *string - // A list of source queue URLs that have the RedrivePolicy queue attribute // configured with a dead-letter queue. // // This member is required. QueueUrls []*string + // Pagination token to include in the next request. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sqs/api_op_ListQueues.go b/service/sqs/api_op_ListQueues.go index a01c2c6091a..29c85362057 100644 --- a/service/sqs/api_op_ListQueues.go +++ b/service/sqs/api_op_ListQueues.go @@ -62,12 +62,12 @@ func (c *Client) ListQueues(ctx context.Context, params *ListQueuesInput, optFns // type ListQueuesInput struct { - // Pagination token to request the next set of results. - NextToken *string - // Maximum number of results to include in the response. MaxResults *int32 + // Pagination token to request the next set of results. + NextToken *string + // A string to use for filtering the list results. Only those queues whose name // begins with the specified string are returned. Queue URLs and names are // case-sensitive. diff --git a/service/sqs/api_op_ReceiveMessage.go b/service/sqs/api_op_ReceiveMessage.go index e5013266916..481365193f2 100644 --- a/service/sqs/api_op_ReceiveMessage.go +++ b/service/sqs/api_op_ReceiveMessage.go @@ -103,44 +103,6 @@ func (c *Client) ReceiveMessage(ctx context.Context, params *ReceiveMessageInput // type ReceiveMessageInput struct { - // The name of the message attribute, where N is the index. - // - // * The name can - // contain alphanumeric characters and the underscore (_), hyphen (-), and period - // (.). - // - // * The name is case-sensitive and must be unique among all attribute - // names for the message. - // - // * The name must not start with AWS-reserved prefixes - // such as AWS. or Amazon. (or any casing variants). - // - // * The name must not start - // or end with a period (.), and it should not have periods in succession (..). - // - // - // * The name can be up to 256 characters long. - // - //

    When using - // ReceiveMessage, you can send a list of attribute names to receive, - // or you can return all of the attributes by specifying All or - // .* in your request. You can also use all message attributes - // starting with a prefix, for example bar.*.

    - MessageAttributeNames []*string - - // The duration (in seconds) for which the call waits for a message to arrive in - // the queue before returning. If a message is available, the call returns sooner - // than WaitTimeSeconds. If no messages are available and the wait time expires, - // the call returns successfully with an empty list of messages. To avoid HTTP - // errors, ensure that the HTTP response timeout for ReceiveMessage requests is - // longer than the WaitTimeSeconds parameter. For example, with the Java SDK, you - // can set HTTP transport settings using the NettyNioAsyncHttpClient - // (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.html) - // for asynchronous clients, or the ApacheHttpClient - // (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.html) - // for synchronous clients. - WaitTimeSeconds *int32 - // The URL of the Amazon SQS queue from which messages are received. Queue URLs and // names are case-sensitive. // @@ -193,9 +155,30 @@ type ReceiveMessageInput struct { // 10. Default: 1. MaxNumberOfMessages *int32 - // The duration (in seconds) that the received messages are hidden from subsequent - // retrieve requests after being retrieved by a ReceiveMessage request. - VisibilityTimeout *int32 + // The name of the message attribute, where N is the index. + // + // * The name can + // contain alphanumeric characters and the underscore (_), hyphen (-), and period + // (.). + // + // * The name is case-sensitive and must be unique among all attribute + // names for the message. + // + // * The name must not start with AWS-reserved prefixes + // such as AWS. or Amazon. (or any casing variants). + // + // * The name must not start + // or end with a period (.), and it should not have periods in succession (..). + // + // + // * The name can be up to 256 characters long. + // + //

    When using + // ReceiveMessage, you can send a list of attribute names to receive, + // or you can return all of the attributes by specifying All or + // .* in your request. You can also use all message attributes + // starting with a prefix, for example bar.*.

    + MessageAttributeNames []*string // This parameter applies only to FIFO (first-in-first-out) queues. The token used // for deduplication of ReceiveMessage calls. If a networking issue occurs after a @@ -252,6 +235,23 @@ type ReceiveMessageInput struct { // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-receiverequestattemptid-request-parameter.html) // in the Amazon Simple Queue Service Developer Guide. ReceiveRequestAttemptId *string + + // The duration (in seconds) that the received messages are hidden from subsequent + // retrieve requests after being retrieved by a ReceiveMessage request. + VisibilityTimeout *int32 + + // The duration (in seconds) for which the call waits for a message to arrive in + // the queue before returning. If a message is available, the call returns sooner + // than WaitTimeSeconds. If no messages are available and the wait time expires, + // the call returns successfully with an empty list of messages. To avoid HTTP + // errors, ensure that the HTTP response timeout for ReceiveMessage requests is + // longer than the WaitTimeSeconds parameter. For example, with the Java SDK, you + // can set HTTP transport settings using the NettyNioAsyncHttpClient + // (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.html) + // for asynchronous clients, or the ApacheHttpClient + // (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.html) + // for synchronous clients. + WaitTimeSeconds *int32 } // A list of received messages. diff --git a/service/sqs/api_op_RemovePermission.go b/service/sqs/api_op_RemovePermission.go index 9bf1ba94766..2f75325e756 100644 --- a/service/sqs/api_op_RemovePermission.go +++ b/service/sqs/api_op_RemovePermission.go @@ -70,17 +70,17 @@ func (c *Client) RemovePermission(ctx context.Context, params *RemovePermissionI // type RemovePermissionInput struct { - // The URL of the Amazon SQS queue from which permissions are removed. Queue URLs - // and names are case-sensitive. - // - // This member is required. - QueueUrl *string - // The identification of the permission to remove. This is the label added using // the AddPermission () action. // // This member is required. Label *string + + // The URL of the Amazon SQS queue from which permissions are removed. Queue URLs + // and names are case-sensitive. + // + // This member is required. + QueueUrl *string } type RemovePermissionOutput struct { diff --git a/service/sqs/api_op_SendMessage.go b/service/sqs/api_op_SendMessage.go index 6b2cde4ae4c..969d7e7c5b8 100644 --- a/service/sqs/api_op_SendMessage.go +++ b/service/sqs/api_op_SendMessage.go @@ -62,38 +62,36 @@ func (c *Client) SendMessage(ctx context.Context, params *SendMessageInput, optF // type SendMessageInput struct { + // The message to send. The maximum string size is 256 KB. A message can include + // only XML, JSON, and unformatted text. The following Unicode characters are + // allowed: #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to + // #x10FFFF Any characters not included in this list will be rejected. For more + // information, see the W3C specification for characters + // (http://www.w3.org/TR/REC-xml/#charsets). + // + // This member is required. + MessageBody *string + + // The URL of the Amazon SQS queue to which a message is sent. Queue URLs and names + // are case-sensitive. + // + // This member is required. + QueueUrl *string + + // The length of time, in seconds, for which to delay a specific message. Valid + // values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds + // value become available for processing after the delay period is finished. If you + // don't specify a value, the default value for the queue applies. When you set + // FifoQueue, you can't set DelaySeconds per message. You can set this parameter + // only on a queue level. + DelaySeconds *int32 + // Each message attribute consists of a Name, Type, and Value. For more // information, see Amazon SQS Message Attributes // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html) // in the Amazon Simple Queue Service Developer Guide. MessageAttributes map[string]*types.MessageAttributeValue - // This parameter applies only to FIFO (first-in-first-out) queues. The tag that - // specifies that a message belongs to a specific message group. Messages that - // belong to the same message group are processed in a FIFO manner (however, - // messages in different message groups might be processed out of order). To - // interleave multiple ordered streams within a single queue, use MessageGroupId - // values (for example, session data for multiple users). In this scenario, - // multiple consumers can process the queue, but the session data of each user is - // processed in a FIFO fashion. - // - // * You must associate a non-empty - // MessageGroupId with a message. If you don't provide a MessageGroupId, the action - // fails. - // - // * ReceiveMessage might return messages with multiple MessageGroupId - // values. For each MessageGroupId, the messages are sorted by time sent. The - // caller can't specify a MessageGroupId. - // - // The length of MessageGroupId is 128 - // characters. Valid values: alphanumeric characters and punctuation - // (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). For best practices of using MessageGroupId, - // see Using the MessageGroupId Property - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html) - // in the Amazon Simple Queue Service Developer Guide. MessageGroupId is required - // for FIFO queues. You can't use it for Standard queues. - MessageGroupId *string - // This parameter applies only to FIFO (first-in-first-out) queues. The token used // for deduplication of sent messages. If a message with a particular // MessageDeduplicationId is sent successfully, any messages sent with the same @@ -146,19 +144,31 @@ type SendMessageInput struct { // in the Amazon Simple Queue Service Developer Guide. MessageDeduplicationId *string - // The length of time, in seconds, for which to delay a specific message. Valid - // values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds - // value become available for processing after the delay period is finished. If you - // don't specify a value, the default value for the queue applies. When you set - // FifoQueue, you can't set DelaySeconds per message. You can set this parameter - // only on a queue level. - DelaySeconds *int32 - - // The URL of the Amazon SQS queue to which a message is sent. Queue URLs and names - // are case-sensitive. + // This parameter applies only to FIFO (first-in-first-out) queues. The tag that + // specifies that a message belongs to a specific message group. Messages that + // belong to the same message group are processed in a FIFO manner (however, + // messages in different message groups might be processed out of order). To + // interleave multiple ordered streams within a single queue, use MessageGroupId + // values (for example, session data for multiple users). In this scenario, + // multiple consumers can process the queue, but the session data of each user is + // processed in a FIFO fashion. // - // This member is required. - QueueUrl *string + // * You must associate a non-empty + // MessageGroupId with a message. If you don't provide a MessageGroupId, the action + // fails. + // + // * ReceiveMessage might return messages with multiple MessageGroupId + // values. For each MessageGroupId, the messages are sorted by time sent. The + // caller can't specify a MessageGroupId. + // + // The length of MessageGroupId is 128 + // characters. Valid values: alphanumeric characters and punctuation + // (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). For best practices of using MessageGroupId, + // see Using the MessageGroupId Property + // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html) + // in the Amazon Simple Queue Service Developer Guide. MessageGroupId is required + // for FIFO queues. You can't use it for Standard queues. + MessageGroupId *string // The message system attribute to send. Each message system attribute consists of // a Name, Type, and Value. @@ -170,32 +180,11 @@ type SendMessageInput struct { // * The size of a message // system attribute doesn't count towards the total size of a message. MessageSystemAttributes map[string]*types.MessageSystemAttributeValue - - // The message to send. The maximum string size is 256 KB. A message can include - // only XML, JSON, and unformatted text. The following Unicode characters are - // allowed: #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to - // #x10FFFF Any characters not included in this list will be rejected. For more - // information, see the W3C specification for characters - // (http://www.w3.org/TR/REC-xml/#charsets). - // - // This member is required. - MessageBody *string } // The MD5OfMessageBody and MessageId elements. type SendMessageOutput struct { - // An MD5 digest of the non-URL-encoded message system attribute string. You can - // use this attribute to verify that Amazon SQS received the message correctly. - // Amazon SQS URL-decodes the message before creating the MD5 digest. - MD5OfMessageSystemAttributes *string - - // This parameter applies only to FIFO (first-in-first-out) queues. The large, - // non-consecutive number that Amazon SQS assigns to each message. The length of - // SequenceNumber is 128 bits. SequenceNumber continues to increase for a - // particular MessageGroupId. - SequenceNumber *string - // An MD5 digest of the non-URL-encoded message attribute string. You can use this // attribute to verify that Amazon SQS received the message correctly. Amazon SQS // URL-decodes the message before creating the MD5 digest. For information about @@ -208,12 +197,23 @@ type SendMessageOutput struct { // MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). MD5OfMessageBody *string + // An MD5 digest of the non-URL-encoded message system attribute string. You can + // use this attribute to verify that Amazon SQS received the message correctly. + // Amazon SQS URL-decodes the message before creating the MD5 digest. + MD5OfMessageSystemAttributes *string + // An attribute containing the MessageId of the message sent to the queue. For more // information, see Queue and Message Identifiers // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html) // in the Amazon Simple Queue Service Developer Guide. MessageId *string + // This parameter applies only to FIFO (first-in-first-out) queues. The large, + // non-consecutive number that Amazon SQS assigns to each message. The length of + // SequenceNumber is 128 bits. SequenceNumber continues to increase for a + // particular MessageGroupId. + SequenceNumber *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sqs/api_op_SendMessageBatch.go b/service/sqs/api_op_SendMessageBatch.go index 2e3c8926a2c..b67b4467471 100644 --- a/service/sqs/api_op_SendMessageBatch.go +++ b/service/sqs/api_op_SendMessageBatch.go @@ -93,17 +93,17 @@ type SendMessageBatchInput struct { // BatchResultErrorEntry () tag if the message fails. type SendMessageBatchOutput struct { - // A list of SendMessageBatchResultEntry () items. - // - // This member is required. - Successful []*types.SendMessageBatchResultEntry - // A list of BatchResultErrorEntry () items with error details about each message // that can't be enqueued. // // This member is required. Failed []*types.BatchResultErrorEntry + // A list of SendMessageBatchResultEntry () items. + // + // This member is required. + Successful []*types.SendMessageBatchResultEntry + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sqs/api_op_SetQueueAttributes.go b/service/sqs/api_op_SetQueueAttributes.go index 1a3d6366f65..22eb791a27e 100644 --- a/service/sqs/api_op_SetQueueAttributes.go +++ b/service/sqs/api_op_SetQueueAttributes.go @@ -74,12 +74,6 @@ func (c *Client) SetQueueAttributes(ctx context.Context, params *SetQueueAttribu // type SetQueueAttributesInput struct { - // The URL of the Amazon SQS queue whose attributes are set. Queue URLs and names - // are case-sensitive. - // - // This member is required. - QueueUrl *string - // A map of attributes to set. The following lists the names, descriptions, and // values of the special request parameters that the SetQueueAttributes action // uses: @@ -186,6 +180,12 @@ type SetQueueAttributesInput struct { // // This member is required. Attributes map[string]*string + + // The URL of the Amazon SQS queue whose attributes are set. Queue URLs and names + // are case-sensitive. + // + // This member is required. + QueueUrl *string } type SetQueueAttributesOutput struct { diff --git a/service/sqs/api_op_TagQueue.go b/service/sqs/api_op_TagQueue.go index 920f738d957..a98490429fc 100644 --- a/service/sqs/api_op_TagQueue.go +++ b/service/sqs/api_op_TagQueue.go @@ -72,15 +72,15 @@ func (c *Client) TagQueue(ctx context.Context, params *TagQueueInput, optFns ... type TagQueueInput struct { - // The list of tags to be added to the specified queue. + // The URL of the queue. // // This member is required. - Tags map[string]*string + QueueUrl *string - // The URL of the queue. + // The list of tags to be added to the specified queue. // // This member is required. - QueueUrl *string + Tags map[string]*string } type TagQueueOutput struct { diff --git a/service/sqs/go.mod b/service/sqs/go.mod index b5c52ff4d22..7702abec773 100644 --- a/service/sqs/go.mod +++ b/service/sqs/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/sqs go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/sqs/types/types.go b/service/sqs/types/types.go index c41cc798517..1de49574618 100644 --- a/service/sqs/types/types.go +++ b/service/sqs/types/types.go @@ -6,23 +6,23 @@ package types // request. type BatchResultErrorEntry struct { - // Specifies whether the error happened due to the caller of the batch API action. - // - // This member is required. - SenderFault *bool - // An error code representing why the action failed on this entry. // // This member is required. Code *string - // A message explaining why the action failed on this entry. - Message *string - // The Id of an entry in a batch request. // // This member is required. Id *string + + // Specifies whether the error happened due to the caller of the batch API action. + // + // This member is required. + SenderFault *bool + + // A message explaining why the action failed on this entry. + Message *string } // Encloses a receipt handle and an entry id for each message in @@ -38,14 +38,6 @@ type BatchResultErrorEntry struct { // &ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45 type ChangeMessageVisibilityBatchRequestEntry struct { - // A receipt handle. - // - // This member is required. - ReceiptHandle *string - - // The new value (in seconds) for the message's visibility timeout. - VisibilityTimeout *int32 - // An identifier for this particular receipt handle used to communicate the result. // The Ids of a batch request need to be unique within a request. This identifier // can have up to 80 characters. The following characters are accepted: @@ -53,6 +45,14 @@ type ChangeMessageVisibilityBatchRequestEntry struct { // // This member is required. Id *string + + // A receipt handle. + // + // This member is required. + ReceiptHandle *string + + // The new value (in seconds) for the message's visibility timeout. + VisibilityTimeout *int32 } // Encloses the Id of an entry in ChangeMessageVisibilityBatch (). @@ -93,23 +93,6 @@ type DeleteMessageBatchResultEntry struct { // An Amazon SQS message. type Message struct { - // Each message attribute consists of a Name, Type, and Value. For more - // information, see Amazon SQS Message Attributes - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html) - // in the Amazon Simple Queue Service Developer Guide. - MessageAttributes map[string]*MessageAttributeValue - - // An MD5 digest of the non-URL-encoded message attribute string. You can use this - // attribute to verify that Amazon SQS received the message correctly. Amazon SQS - // URL-decodes the message before creating the MD5 digest. For information about - // MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). - MD5OfMessageAttributes *string - - // An identifier associated with the act of receiving the message. A new receipt - // handle is returned every time you receive a message. When deleting a message, - // you provide the last received receipt handle to delete the message. - ReceiptHandle *string - // A map of the attributes requested in ReceiveMessage () to their respective // values. Supported attributes: // @@ -135,15 +118,32 @@ type Message struct { // (http://en.wikipedia.org/wiki/Unix_time) in milliseconds. Attributes map[string]*string - // A unique identifier for the message. A MessageIdis considered unique across all - // AWS accounts for an extended period of time. - MessageId *string + // The message's contents (not URL-encoded). + Body *string // An MD5 digest of the non-URL-encoded message body string. MD5OfBody *string - // The message's contents (not URL-encoded). - Body *string + // An MD5 digest of the non-URL-encoded message attribute string. You can use this + // attribute to verify that Amazon SQS received the message correctly. Amazon SQS + // URL-decodes the message before creating the MD5 digest. For information about + // MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). + MD5OfMessageAttributes *string + + // Each message attribute consists of a Name, Type, and Value. For more + // information, see Amazon SQS Message Attributes + // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html) + // in the Amazon Simple Queue Service Developer Guide. + MessageAttributes map[string]*MessageAttributeValue + + // A unique identifier for the message. A MessageIdis considered unique across all + // AWS accounts for an extended period of time. + MessageId *string + + // An identifier associated with the act of receiving the message. A new receipt + // handle is returned every time you receive a message. When deleting a message, + // you provide the last received receipt handle to delete the message. + ReceiptHandle *string } // The user-specified message attribute value. For string data types, the Value @@ -153,21 +153,6 @@ type Message struct { // Value, are part of the message size restriction (256 KB or 262,144 bytes). type MessageAttributeValue struct { - // Strings are Unicode with UTF-8 binary encoding. For a list of code values, see - // ASCII Printable Characters - // (http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters). - StringValue *string - - // Binary type attributes can store any binary data, such as compressed data, - // encrypted data, or images. - BinaryValue []byte - - // Not implemented. Reserved for future use. - BinaryListValues [][]byte - - // Not implemented. Reserved for future use. - StringListValues []*string - // Amazon SQS supports the following logical data types: String, Number, and // Binary. For the Number data type, you must use StringValue. You can also append // custom labels. For more information, see Amazon SQS Message Attributes @@ -176,6 +161,21 @@ type MessageAttributeValue struct { // // This member is required. DataType *string + + // Not implemented. Reserved for future use. + BinaryListValues [][]byte + + // Binary type attributes can store any binary data, such as compressed data, + // encrypted data, or images. + BinaryValue []byte + + // Not implemented. Reserved for future use. + StringListValues []*string + + // Strings are Unicode with UTF-8 binary encoding. For a list of code values, see + // ASCII Printable Characters + // (http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters). + StringValue *string } // The user-specified message system attribute value. For string data types, the @@ -184,12 +184,6 @@ type MessageAttributeValue struct { // must not be empty or null. type MessageSystemAttributeValue struct { - // Not implemented. Reserved for future use. - BinaryListValues [][]byte - - // Not implemented. Reserved for future use. - StringListValues []*string - // Amazon SQS supports the following logical data types: String, Number, and // Binary. For the Number data type, you must use StringValue. You can also append // custom labels. For more information, see Amazon SQS Message Attributes @@ -199,10 +193,16 @@ type MessageSystemAttributeValue struct { // This member is required. DataType *string + // Not implemented. Reserved for future use. + BinaryListValues [][]byte + // Binary type attributes can store any binary data, such as compressed data, // encrypted data, or images. BinaryValue []byte + // Not implemented. Reserved for future use. + StringListValues []*string + // Strings are Unicode with UTF-8 binary encoding. For a list of code values, see // ASCII Printable Characters // (http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters). @@ -212,11 +212,33 @@ type MessageSystemAttributeValue struct { // Contains the details of a single Amazon SQS message along with an Id. type SendMessageBatchRequestEntry struct { + // An identifier for a message in this batch used to communicate the result. The + // Ids of a batch request need to be unique within a request. This identifier can + // have up to 80 characters. The following characters are accepted: alphanumeric + // characters, hyphens(-), and underscores (_). + // + // This member is required. + Id *string + // The body of the message. // // This member is required. MessageBody *string + // The length of time, in seconds, for which a specific message is delayed. Valid + // values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds + // value become available for processing after the delay period is finished. If you + // don't specify a value, the default value for the queue is applied. When you set + // FifoQueue, you can't set DelaySeconds per message. You can set this parameter + // only on a queue level. + DelaySeconds *int32 + + // Each message attribute consists of a Name, Type, and Value. For more + // information, see Amazon SQS Message Attributes + // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html) + // in the Amazon Simple Queue Service Developer Guide. + MessageAttributes map[string]*MessageAttributeValue + // This parameter applies only to FIFO (first-in-first-out) queues. The token used // for deduplication of messages within a 5-minute minimum deduplication interval. // If a message with a particular MessageDeduplicationId is sent successfully, @@ -269,20 +291,6 @@ type SendMessageBatchRequestEntry struct { // in the Amazon Simple Queue Service Developer Guide. MessageDeduplicationId *string - // Each message attribute consists of a Name, Type, and Value. For more - // information, see Amazon SQS Message Attributes - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html) - // in the Amazon Simple Queue Service Developer Guide. - MessageAttributes map[string]*MessageAttributeValue - - // An identifier for a message in this batch used to communicate the result. The - // Ids of a batch request need to be unique within a request. This identifier can - // have up to 80 characters. The following characters are accepted: alphanumeric - // characters, hyphens(-), and underscores (_). - // - // This member is required. - Id *string - // This parameter applies only to FIFO (first-in-first-out) queues. The tag that // specifies that a message belongs to a specific message group. Messages that // belong to the same message group are processed in a FIFO manner (however, @@ -319,14 +327,6 @@ type SendMessageBatchRequestEntry struct { // * The size of a message // system attribute doesn't count towards the total size of a message. MessageSystemAttributes map[string]*MessageSystemAttributeValue - - // The length of time, in seconds, for which a specific message is delayed. Valid - // values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds - // value become available for processing after the delay period is finished. If you - // don't specify a value, the default value for the queue is applied. When you set - // FifoQueue, you can't set DelaySeconds per message. You can set this parameter - // only on a queue level. - DelaySeconds *int32 } // Encloses a MessageId for a successfully-enqueued message in a SendMessageBatch @@ -338,34 +338,34 @@ type SendMessageBatchResultEntry struct { // This member is required. Id *string - // An MD5 digest of the non-URL-encoded message system attribute string. You can - // use this attribute to verify that Amazon SQS received the message correctly. - // Amazon SQS URL-decodes the message before creating the MD5 digest. For - // information about MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). - MD5OfMessageSystemAttributes *string - // An MD5 digest of the non-URL-encoded message attribute string. You can use this // attribute to verify that Amazon SQS received the message correctly. Amazon SQS // URL-decodes the message before creating the MD5 digest. For information about // MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). - MD5OfMessageAttributes *string + // + // This member is required. + MD5OfMessageBody *string + + // An identifier for the message. + // + // This member is required. + MessageId *string // An MD5 digest of the non-URL-encoded message attribute string. You can use this // attribute to verify that Amazon SQS received the message correctly. Amazon SQS // URL-decodes the message before creating the MD5 digest. For information about // MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). - // - // This member is required. - MD5OfMessageBody *string + MD5OfMessageAttributes *string + + // An MD5 digest of the non-URL-encoded message system attribute string. You can + // use this attribute to verify that Amazon SQS received the message correctly. + // Amazon SQS URL-decodes the message before creating the MD5 digest. For + // information about MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). + MD5OfMessageSystemAttributes *string // This parameter applies only to FIFO (first-in-first-out) queues. The large, // non-consecutive number that Amazon SQS assigns to each message. The length of // SequenceNumber is 128 bits. As SequenceNumber continues to increase for a // particular MessageGroupId. SequenceNumber *string - - // An identifier for the message. - // - // This member is required. - MessageId *string } diff --git a/service/ssm/api_op_AddTagsToResource.go b/service/ssm/api_op_AddTagsToResource.go index b75a0e36abf..dc401c0da1b 100644 --- a/service/ssm/api_op_AddTagsToResource.go +++ b/service/ssm/api_op_AddTagsToResource.go @@ -73,6 +73,16 @@ func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourc type AddTagsToResourceInput struct { + // The resource ID you want to tag. Use the ID of the resource. Here are some + // examples: ManagedInstance: mi-012345abcde MaintenanceWindow: mw-012345abcde + // PatchBaseline: pb-012345abcde For the Document and Parameter values, use the + // name of the resource. The ManagedInstance type for this API action is only for + // on-premises managed instances. You must specify the name of the managed instance + // in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f. + // + // This member is required. + ResourceId *string + // Specifies the type of resource you are tagging. The ManagedInstance type for // this API action is for on-premises managed instances. You must specify the name // of the managed instance in the following format: mi-ID_number. For example, @@ -87,16 +97,6 @@ type AddTagsToResourceInput struct { // // This member is required. Tags []*types.Tag - - // The resource ID you want to tag. Use the ID of the resource. Here are some - // examples: ManagedInstance: mi-012345abcde MaintenanceWindow: mw-012345abcde - // PatchBaseline: pb-012345abcde For the Document and Parameter values, use the - // name of the resource. The ManagedInstance type for this API action is only for - // on-premises managed instances. You must specify the name of the managed instance - // in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f. - // - // This member is required. - ResourceId *string } type AddTagsToResourceOutput struct { diff --git a/service/ssm/api_op_CancelCommand.go b/service/ssm/api_op_CancelCommand.go index b152e01ead7..af03a628595 100644 --- a/service/ssm/api_op_CancelCommand.go +++ b/service/ssm/api_op_CancelCommand.go @@ -59,15 +59,15 @@ func (c *Client) CancelCommand(ctx context.Context, params *CancelCommandInput, // type CancelCommandInput struct { - // (Optional) A list of instance IDs on which you want to cancel the command. If - // not provided, the command is canceled on every instance on which it was - // requested. - InstanceIds []*string - // The ID of the command you want to cancel. // // This member is required. CommandId *string + + // (Optional) A list of instance IDs on which you want to cancel the command. If + // not provided, the command is canceled on every instance on which it was + // requested. + InstanceIds []*string } // Whether or not the command was successfully canceled. There is no guarantee that diff --git a/service/ssm/api_op_CreateActivation.go b/service/ssm/api_op_CreateActivation.go index a6d41f9cb05..1047b368019 100644 --- a/service/ssm/api_op_CreateActivation.go +++ b/service/ssm/api_op_CreateActivation.go @@ -68,9 +68,21 @@ func (c *Client) CreateActivation(ctx context.Context, params *CreateActivationI type CreateActivationInput struct { - // Specify the maximum number of managed instances you want to register. The - // default value is 1 instance. - RegistrationLimit *int32 + // The Amazon Identity and Access Management (IAM) role that you want to assign to + // the managed instance. This IAM role must provide AssumeRole permissions for the + // Systems Manager service principal ssm.amazonaws.com. For more information, see + // Create an IAM service role for a hybrid environment + // (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html) + // in the AWS Systems Manager User Guide. + // + // This member is required. + IamRole *string + + // The name of the registered, managed instance as it will appear in the Systems + // Manager console or when you use the AWS command line tools to list Systems + // Manager resources. Do not enter personally identifiable information in this + // field. + DefaultInstanceName *string // A user-defined description of the resource that you want to register with // Systems Manager. Do not enter personally identifiable information in this field. @@ -80,11 +92,9 @@ type CreateActivationInput struct { // hours. ExpirationDate *time.Time - // The name of the registered, managed instance as it will appear in the Systems - // Manager console or when you use the AWS command line tools to list Systems - // Manager resources. Do not enter personally identifiable information in this - // field. - DefaultInstanceName *string + // Specify the maximum number of managed instances you want to register. The + // default value is 1 instance. + RegistrationLimit *int32 // Optional metadata that you assign to a resource. Tags enable you to categorize a // resource in different ways, such as by purpose, owner, or environment. For @@ -109,28 +119,18 @@ type CreateActivationInput struct { // AddTagsToResource (). For information about how to remove tags from your managed // instances, see RemoveTagsFromResource (). Tags []*types.Tag - - // The Amazon Identity and Access Management (IAM) role that you want to assign to - // the managed instance. This IAM role must provide AssumeRole permissions for the - // Systems Manager service principal ssm.amazonaws.com. For more information, see - // Create an IAM service role for a hybrid environment - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html) - // in the AWS Systems Manager User Guide. - // - // This member is required. - IamRole *string } type CreateActivationOutput struct { - // The ID number generated by the system when it processed the activation. The - // activation ID functions like a user name. - ActivationId *string - // The code the system generates when it processes the activation. The activation // code functions like a password to validate the activation ID. ActivationCode *string + // The ID number generated by the system when it processed the activation. The + // activation ID functions like a user name. + ActivationId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_CreateAssociation.go b/service/ssm/api_op_CreateAssociation.go index bed47a3907a..12bd576c33a 100644 --- a/service/ssm/api_op_CreateAssociation.go +++ b/service/ssm/api_op_CreateAssociation.go @@ -67,19 +67,40 @@ func (c *Client) CreateAssociation(ctx context.Context, params *CreateAssociatio type CreateAssociationInput struct { + // The name of the SSM document that contains the configuration information for the + // instance. You can specify Command or Automation documents. You can specify + // AWS-predefined documents, documents you created, or a document that is shared + // with you from another account. For SSM documents that are shared with you from + // other AWS accounts, you must specify the complete SSM document ARN, in the + // following format: arn:partition:ssm:region:account-id:document/document-name + // For example: arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For + // AWS-predefined documents and SSM documents you created in your account, you only + // need to specify the document name. For example, AWS-ApplyPatchBaseline or + // My-Document. + // + // This member is required. + Name *string + // By default, when you create a new associations, the system runs it immediately // after it is created and then according to the schedule you specified. Specify // this option if you don't want an association to run immediately after you create // it. ApplyOnlyAtCronInterval *bool - // The document version you want to associate with the target(s). Can be a specific - // version or the default version. - DocumentVersion *string + // Specify a descriptive name for the association. + AssociationName *string + + // Specify the target for the association. This target is required for associations + // that use an Automation document and target resources by using rate controls. + AutomationTargetParameterName *string // The severity level to assign to the association. ComplianceSeverity types.AssociationComplianceSeverity + // The document version you want to associate with the target(s). Can be a specific + // version or the default version. + DocumentVersion *string + // The instance ID. InstanceId has been deprecated. To specify an instance ID for // an association, use the Targets parameter. Requests that include the parameter // InstanceID with SSM documents that use schema version 2.0 or later will fail. In @@ -88,27 +109,15 @@ type CreateAssociationInput struct { // ScheduleExpression. To use these parameters, you must use the Targets parameter. InstanceId *string - // The targets for the association. You can target instances by using tags, AWS - // Resource Groups, all instances in an AWS account, or individual instance IDs. - // For more information about choosing targets for an association, see Using - // targets and rate controls with State Manager associations - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-state-manager-targets-and-rate-controls.html) - // in the AWS Systems Manager User Guide. - Targets []*types.Target - - // The mode for generating association compliance. You can specify AUTO or MANUAL. - // In AUTO mode, the system uses the status of the association execution to - // determine the compliance status. If the association execution runs successfully, - // then the association is COMPLIANT. If the association execution doesn't run - // successfully, the association is NON-COMPLIANT. In MANUAL mode, you must specify - // the AssociationId as a parameter for the PutComplianceItems () API action. In - // this case, compliance data is not managed by State Manager. It is managed by - // your direct call to the PutComplianceItems () API action. By default, all - // associations use AUTO mode. - SyncCompliance types.AssociationSyncCompliance - - // A cron expression when the association will be applied to the target(s). - ScheduleExpression *string + // The maximum number of targets allowed to run the association at the same time. + // You can specify a number, for example 10, or a percentage of the target set, for + // example 10%. The default value is 100%, which means all targets run the + // association at the same time. If a new instance starts and attempts to run an + // association while Systems Manager is running MaxConcurrency associations, the + // association is allowed to run. During the next association interval, the new + // instance will process its association within the limit specified for + // MaxConcurrency. + MaxConcurrency *string // The number of errors that are allowed before the system stops sending requests // to run the association on additional targets. You can specify either an absolute @@ -124,42 +133,33 @@ type CreateAssociationInput struct { // one at a time. MaxErrors *string - // Specify the target for the association. This target is required for associations - // that use an Automation document and target resources by using rate controls. - AutomationTargetParameterName *string - - // The name of the SSM document that contains the configuration information for the - // instance. You can specify Command or Automation documents. You can specify - // AWS-predefined documents, documents you created, or a document that is shared - // with you from another account. For SSM documents that are shared with you from - // other AWS accounts, you must specify the complete SSM document ARN, in the - // following format: arn:partition:ssm:region:account-id:document/document-name - // For example: arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For - // AWS-predefined documents and SSM documents you created in your account, you only - // need to specify the document name. For example, AWS-ApplyPatchBaseline or - // My-Document. - // - // This member is required. - Name *string + // An S3 bucket where you want to store the output details of the request. + OutputLocation *types.InstanceAssociationOutputLocation // The parameters for the runtime configuration of the document. Parameters map[string][]*string - // An S3 bucket where you want to store the output details of the request. - OutputLocation *types.InstanceAssociationOutputLocation + // A cron expression when the association will be applied to the target(s). + ScheduleExpression *string - // Specify a descriptive name for the association. - AssociationName *string + // The mode for generating association compliance. You can specify AUTO or MANUAL. + // In AUTO mode, the system uses the status of the association execution to + // determine the compliance status. If the association execution runs successfully, + // then the association is COMPLIANT. If the association execution doesn't run + // successfully, the association is NON-COMPLIANT. In MANUAL mode, you must specify + // the AssociationId as a parameter for the PutComplianceItems () API action. In + // this case, compliance data is not managed by State Manager. It is managed by + // your direct call to the PutComplianceItems () API action. By default, all + // associations use AUTO mode. + SyncCompliance types.AssociationSyncCompliance - // The maximum number of targets allowed to run the association at the same time. - // You can specify a number, for example 10, or a percentage of the target set, for - // example 10%. The default value is 100%, which means all targets run the - // association at the same time. If a new instance starts and attempts to run an - // association while Systems Manager is running MaxConcurrency associations, the - // association is allowed to run. During the next association interval, the new - // instance will process its association within the limit specified for - // MaxConcurrency. - MaxConcurrency *string + // The targets for the association. You can target instances by using tags, AWS + // Resource Groups, all instances in an AWS account, or individual instance IDs. + // For more information about choosing targets for an association, see Using + // targets and rate controls with State Manager associations + // (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-state-manager-targets-and-rate-controls.html) + // in the AWS Systems Manager User Guide. + Targets []*types.Target } type CreateAssociationOutput struct { diff --git a/service/ssm/api_op_CreateAssociationBatch.go b/service/ssm/api_op_CreateAssociationBatch.go index 52b77fc4790..822380b2d14 100644 --- a/service/ssm/api_op_CreateAssociationBatch.go +++ b/service/ssm/api_op_CreateAssociationBatch.go @@ -70,12 +70,12 @@ type CreateAssociationBatchInput struct { type CreateAssociationBatchOutput struct { - // Information about the associations that succeeded. - Successful []*types.AssociationDescription - // Information about the associations that failed. Failed []*types.FailedCreateAssociation + // Information about the associations that succeeded. + Successful []*types.AssociationDescription + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_CreateDocument.go b/service/ssm/api_op_CreateDocument.go index 01aeb59e7f6..d92335b440a 100644 --- a/service/ssm/api_op_CreateDocument.go +++ b/service/ssm/api_op_CreateDocument.go @@ -62,21 +62,6 @@ func (c *Client) CreateDocument(ctx context.Context, params *CreateDocumentInput type CreateDocumentInput struct { - // Specify a target type to define the kinds of resources the document can run on. - // For example, to run a document on EC2 instances, specify the following value: - // /AWS::EC2::Instance. If you specify a value of '/' the document can run on all - // types of resources. If you don't specify a value, the document can't run on any - // resources. For a list of valid resource types, see AWS resource and property - // types reference - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) - // in the AWS CloudFormation User Guide. - TargetType *string - - // An optional field specifying the version of the artifact you are creating with - // the document. For example, "Release 12, Update 6". This value is unique across - // all versions of a document, and cannot be changed. - VersionName *string - // The content for the new SSM document in JSON or YAML format. We recommend // storing the contents for your new document in an external JSON or YAML file and // referencing the file in a command. For examples, see the following topics in the @@ -96,23 +81,30 @@ type CreateDocumentInput struct { // This member is required. Content *string - // The type of document to create. - DocumentType types.DocumentType + // A name for the Systems Manager document. You can't use the following strings as + // document name prefixes. These are reserved by AWS for use as document name + // prefixes: + // + // * aws- + // + // * amazon + // + // * amzn + // + // This member is required. + Name *string - // Optional metadata that you assign to a resource. Tags enable you to categorize a - // resource in different ways, such as by purpose, owner, or environment. For - // example, you might want to tag an SSM document to identify the types of targets - // or the environment where it will run. In this case, you could specify the - // following key name/value pairs:

    • Key=OS,Value=Windows - //

    • Key=Environment,Value=Production

      • - //

    To add tags to an existing SSM document, use the - // AddTagsToResource action.

     - Tags []*types.Tag + // A list of key and value pairs that describe attachments to a version of a + // document. + Attachments []*types.AttachmentsSource // Specify the document format for the request. The document format can be JSON, // YAML, or TEXT. JSON is the default format. DocumentFormat types.DocumentFormat + // The type of document to create. + DocumentType types.DocumentType + // A list of SSM documents required by a document. This parameter is used // exclusively by AWS AppConfig. When a user creates an AppConfig configuration in // an SSM document, the user must also specify a required document for validation @@ -123,22 +115,30 @@ type CreateDocumentInput struct { // the AWS Systems Manager User Guide. Requires []*types.DocumentRequires - // A list of key and value pairs that describe attachments to a version of a - // document. - Attachments []*types.AttachmentsSource + // Optional metadata that you assign to a resource. Tags enable you to categorize a + // resource in different ways, such as by purpose, owner, or environment. For + // example, you might want to tag an SSM document to identify the types of targets + // or the environment where it will run. In this case, you could specify the + // following key name/value pairs:

    • Key=OS,Value=Windows + //

    • Key=Environment,Value=Production

      • + //

    To add tags to an existing SSM document, use the + // AddTagsToResource action.

     + Tags []*types.Tag - // A name for the Systems Manager document. You can't use the following strings as - // document name prefixes. These are reserved by AWS for use as document name - // prefixes: - // - // * aws- - // - // * amazon - // - // * amzn - // - // This member is required. - Name *string + // Specify a target type to define the kinds of resources the document can run on. + // For example, to run a document on EC2 instances, specify the following value: + // /AWS::EC2::Instance. If you specify a value of '/' the document can run on all + // types of resources. If you don't specify a value, the document can't run on any + // resources. For a list of valid resource types, see AWS resource and property + // types reference + // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) + // in the AWS CloudFormation User Guide. + TargetType *string + + // An optional field specifying the version of the artifact you are creating with + // the document. For example, "Release 12, Update 6". This value is unique across + // all versions of a document, and cannot be changed. + VersionName *string } type CreateDocumentOutput struct { diff --git a/service/ssm/api_op_CreateMaintenanceWindow.go b/service/ssm/api_op_CreateMaintenanceWindow.go index 9feebbdbc80..de5aea1735e 100644 --- a/service/ssm/api_op_CreateMaintenanceWindow.go +++ b/service/ssm/api_op_CreateMaintenanceWindow.go @@ -65,41 +65,21 @@ func (c *Client) CreateMaintenanceWindow(ctx context.Context, params *CreateMain type CreateMaintenanceWindowInput struct { - // An optional description for the maintenance window. We recommend specifying a - // description to help you organize your maintenance windows. - Description *string - - // Optional metadata that you assign to a resource. Tags enable you to categorize a - // resource in different ways, such as by purpose, owner, or environment. For - // example, you might want to tag a maintenance window to identify the type of - // tasks it will run, the types of targets, and the environment it will run in. In - // this case, you could specify the following key name/value pairs: - // - // * - // Key=TaskType,Value=AgentUpdate - // - // * Key=OS,Value=Windows - // - // * - // Key=Environment,Value=Production + // Enables a maintenance window task to run on managed instances, even if you have + // not registered those instances as targets. If enabled, then you must specify the + // unregistered instances (by instance ID) when you register a task with the + // maintenance window. If you don't enable this option, then you must specify + // previously-registered targets when you register a task with the maintenance + // window. // - // To add tags to an existing maintenance window, - // use the AddTagsToResource () action. - Tags []*types.Tag - - // The time zone that the scheduled maintenance window executions are based on, in - // Internet Assigned Numbers Authority (IANA) format. For example: - // "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the - // Time Zone Database (https://www.iana.org/time-zones) on the IANA website. - ScheduleTimezone *string - - // User-provided idempotency token. - ClientToken *string + // This member is required. + AllowUnassociatedTargets *bool - // The date and time, in ISO-8601 Extended format, for when you want the - // maintenance window to become active. StartDate allows you to delay activation of - // the maintenance window until the specified future date. - StartDate *string + // The number of hours before the end of the maintenance window that Systems + // Manager stops scheduling new tasks for execution. + // + // This member is required. + Cutoff *int32 // The duration of the maintenance window in hours. // @@ -116,17 +96,18 @@ type CreateMaintenanceWindowInput struct { // This member is required. Schedule *string + // User-provided idempotency token. + ClientToken *string + + // An optional description for the maintenance window. We recommend specifying a + // description to help you organize your maintenance windows. + Description *string + // The date and time, in ISO-8601 Extended format, for when you want the // maintenance window to become inactive. EndDate allows you to set a date and time // in the future when the maintenance window will no longer run. EndDate *string - // The number of hours before the end of the maintenance window that Systems - // Manager stops scheduling new tasks for execution. - // - // This member is required. - Cutoff *int32 - // The number of days to wait after the date and time specified by a CRON // expression before running the maintenance window. For example, the following // cron expression schedules a maintenance window to run on the third Tuesday of @@ -134,15 +115,34 @@ type CreateMaintenanceWindowInput struct { // the maintenance window won't run until two days later. ScheduleOffset *int32 - // Enables a maintenance window task to run on managed instances, even if you have - // not registered those instances as targets. If enabled, then you must specify the - // unregistered instances (by instance ID) when you register a task with the - // maintenance window. If you don't enable this option, then you must specify - // previously-registered targets when you register a task with the maintenance - // window. + // The time zone that the scheduled maintenance window executions are based on, in + // Internet Assigned Numbers Authority (IANA) format. For example: + // "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the + // Time Zone Database (https://www.iana.org/time-zones) on the IANA website. + ScheduleTimezone *string + + // The date and time, in ISO-8601 Extended format, for when you want the + // maintenance window to become active. StartDate allows you to delay activation of + // the maintenance window until the specified future date. + StartDate *string + + // Optional metadata that you assign to a resource. Tags enable you to categorize a + // resource in different ways, such as by purpose, owner, or environment. For + // example, you might want to tag a maintenance window to identify the type of + // tasks it will run, the types of targets, and the environment it will run in. In + // this case, you could specify the following key name/value pairs: // - // This member is required. - AllowUnassociatedTargets *bool + // * + // Key=TaskType,Value=AgentUpdate + // + // * Key=OS,Value=Windows + // + // * + // Key=Environment,Value=Production + // + // To add tags to an existing maintenance window, + // use the AddTagsToResource () action. + Tags []*types.Tag } type CreateMaintenanceWindowOutput struct { diff --git a/service/ssm/api_op_CreateOpsItem.go b/service/ssm/api_op_CreateOpsItem.go index da1f5134436..bfda45421cb 100644 --- a/service/ssm/api_op_CreateOpsItem.go +++ b/service/ssm/api_op_CreateOpsItem.go @@ -66,11 +66,10 @@ func (c *Client) CreateOpsItem(ctx context.Context, params *CreateOpsItemInput, type CreateOpsItemInput struct { - // A short heading that describes the nature of the OpsItem and the impacted - // resource. + // Information about the OpsItem. // // This member is required. - Title *string + Description *string // The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The source // name can't contain the following strings: aws, amazon, and amzn. @@ -78,6 +77,19 @@ type CreateOpsItemInput struct { // This member is required. Source *string + // A short heading that describes the nature of the OpsItem and the impacted + // resource. + // + // This member is required. + Title *string + + // Specify a category to assign to an OpsItem. + Category *string + + // The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when + // this OpsItem is edited or changed. + Notifications []*types.OpsItemNotification + // Operational data is custom data that provides useful reference details about the // OpsItem. For example, you can specify log files, error strings, license keys, // troubleshooting tips, or other relevant data. You enter operational data as @@ -97,25 +109,16 @@ type CreateOpsItemInput struct { // in the AWS Systems Manager User Guide. OperationalData map[string]*types.OpsItemDataValue - // The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when - // this OpsItem is edited or changed. - Notifications []*types.OpsItemNotification + // The importance of this OpsItem in relation to other OpsItems in the system. + Priority *int32 // One or more OpsItems that share something in common with the current OpsItems. // For example, related OpsItems can include OpsItems with similar error messages, // impacted resources, or statuses for the impacted resource. RelatedOpsItems []*types.RelatedOpsItem - // Specify a category to assign to an OpsItem. - Category *string - - // Information about the OpsItem. - // - // This member is required. - Description *string - - // The importance of this OpsItem in relation to other OpsItems in the system. - Priority *int32 + // Specify a severity to assign to an OpsItem. + Severity *string // Optional metadata that you assign to a resource. You can restrict access to // OpsItems by using an inline IAM policy that specifies tags. For more @@ -125,9 +128,6 @@ type CreateOpsItemInput struct { //

    Key=Department,Value=Finance

    To add tags to an // existing OpsItem, use the AddTagsToResource action.

     Tags []*types.Tag - - // Specify a severity to assign to an OpsItem. - Severity *string } type CreateOpsItemOutput struct { diff --git a/service/ssm/api_op_CreatePatchBaseline.go b/service/ssm/api_op_CreatePatchBaseline.go index 11341f916a3..c37acf65382 100644 --- a/service/ssm/api_op_CreatePatchBaseline.go +++ b/service/ssm/api_op_CreatePatchBaseline.go @@ -61,37 +61,50 @@ func (c *Client) CreatePatchBaseline(ctx context.Context, params *CreatePatchBas type CreatePatchBaselineInput struct { - // A description of the patch baseline. - Description *string - - // User-provided idempotency token. - ClientToken *string - - // Defines the operating system the patch baseline applies to. The Default value is - // WINDOWS. - OperatingSystem types.OperatingSystem - // The name of the patch baseline. // // This member is required. Name *string - // A list of explicitly rejected patches for the baseline. For information about + // A set of rules used to include patches in the baseline. + ApprovalRules *types.PatchRuleGroup + + // A list of explicitly approved patches for the baseline. For information about // accepted formats for lists of approved patches and rejected patches, see About // package name formats for approved and rejected patch lists // (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) // in the AWS Systems Manager User Guide. - RejectedPatches []*string + ApprovedPatches []*string - // A set of rules used to include patches in the baseline. - ApprovalRules *types.PatchRuleGroup + // Defines the compliance level for approved patches. This means that if an + // approved patch is reported as missing, this is the severity of the compliance + // violation. The default value is UNSPECIFIED. + ApprovedPatchesComplianceLevel types.PatchComplianceLevel - // A list of explicitly approved patches for the baseline. For information about + // Indicates whether the list of approved patches includes non-security updates + // that should be applied to the instances. The default value is 'false'. Applies + // to Linux instances only. + ApprovedPatchesEnableNonSecurity *bool + + // User-provided idempotency token. + ClientToken *string + + // A description of the patch baseline. + Description *string + + // A set of global filters used to include patches in the baseline. + GlobalFilters *types.PatchFilterGroup + + // Defines the operating system the patch baseline applies to. The Default value is + // WINDOWS. + OperatingSystem types.OperatingSystem + + // A list of explicitly rejected patches for the baseline. For information about // accepted formats for lists of approved patches and rejected patches, see About // package name formats for approved and rejected patch lists // (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) // in the AWS Systems Manager User Guide. - ApprovedPatches []*string + RejectedPatches []*string // The action for Patch Manager to take on patches included in the RejectedPackages // list. @@ -112,11 +125,6 @@ type CreatePatchBaselineInput struct { // operating systems and source repositories. Applies to Linux instances only. Sources []*types.PatchSource - // Defines the compliance level for approved patches. This means that if an - // approved patch is reported as missing, this is the severity of the compliance - // violation. The default value is UNSPECIFIED. - ApprovedPatchesComplianceLevel types.PatchComplianceLevel - // Optional metadata that you assign to a resource. Tags enable you to categorize a // resource in different ways, such as by purpose, owner, or environment. For // example, you might want to tag a patch baseline to identify the severity level @@ -131,14 +139,6 @@ type CreatePatchBaselineInput struct { // To add tags to an // existing patch baseline, use the AddTagsToResource () action. Tags []*types.Tag - - // Indicates whether the list of approved patches includes non-security updates - // that should be applied to the instances. The default value is 'false'. Applies - // to Linux instances only. - ApprovedPatchesEnableNonSecurity *bool - - // A set of global filters used to include patches in the baseline. - GlobalFilters *types.PatchFilterGroup } type CreatePatchBaselineOutput struct { diff --git a/service/ssm/api_op_CreateResourceDataSync.go b/service/ssm/api_op_CreateResourceDataSync.go index 12abb22628a..3a8c550cb9d 100644 --- a/service/ssm/api_op_CreateResourceDataSync.go +++ b/service/ssm/api_op_CreateResourceDataSync.go @@ -79,27 +79,27 @@ func (c *Client) CreateResourceDataSync(ctx context.Context, params *CreateResou type CreateResourceDataSyncInput struct { - // Specify SyncToDestination to create a resource data sync that synchronizes data - // to an S3 bucket for Inventory. If you specify SyncToDestination, you must - // provide a value for S3Destination. Specify SyncFromSource to synchronize data - // from a single account and multiple Regions, or multiple AWS accounts and - // Regions, as listed in AWS Organizations for Explorer. If you specify - // SyncFromSource, you must provide a value for SyncSource. The default value is - // SyncToDestination. - SyncType *string - // A name for the configuration. // // This member is required. SyncName *string + // Amazon S3 configuration details for the sync. This parameter is required if the + // SyncType value is SyncToDestination. + S3Destination *types.ResourceDataSyncS3Destination + // Specify information about the data sources to synchronize. This parameter is // required if the SyncType value is SyncFromSource. SyncSource *types.ResourceDataSyncSource - // Amazon S3 configuration details for the sync. This parameter is required if the - // SyncType value is SyncToDestination. - S3Destination *types.ResourceDataSyncS3Destination + // Specify SyncToDestination to create a resource data sync that synchronizes data + // to an S3 bucket for Inventory. If you specify SyncToDestination, you must + // provide a value for S3Destination. Specify SyncFromSource to synchronize data + // from a single account and multiple Regions, or multiple AWS accounts and + // Regions, as listed in AWS Organizations for Explorer. If you specify + // SyncFromSource, you must provide a value for SyncSource. The default value is + // SyncToDestination. + SyncType *string } type CreateResourceDataSyncOutput struct { diff --git a/service/ssm/api_op_DeleteAssociation.go b/service/ssm/api_op_DeleteAssociation.go index ed35f213ff3..7cfdf44c666 100644 --- a/service/ssm/api_op_DeleteAssociation.go +++ b/service/ssm/api_op_DeleteAssociation.go @@ -59,12 +59,12 @@ func (c *Client) DeleteAssociation(ctx context.Context, params *DeleteAssociatio type DeleteAssociationInput struct { - // The ID of the instance. - InstanceId *string - // The association ID that you want to delete. AssociationId *string + // The ID of the instance. + InstanceId *string + // The name of the Systems Manager document. Name *string } diff --git a/service/ssm/api_op_DeleteDocument.go b/service/ssm/api_op_DeleteDocument.go index 2824cb9470d..e90f72c50ac 100644 --- a/service/ssm/api_op_DeleteDocument.go +++ b/service/ssm/api_op_DeleteDocument.go @@ -59,6 +59,15 @@ func (c *Client) DeleteDocument(ctx context.Context, params *DeleteDocumentInput type DeleteDocumentInput struct { + // The name of the document. + // + // This member is required. + Name *string + + // The version of the document that you want to delete. If not provided, all + // versions of the document are deleted. + DocumentVersion *string + // Some SSM document types require that you specify a Force flag before you can // delete the document. For example, you must specify a Force flag to delete a // document of type ApplicationConfigurationSchema. You can restrict access to the @@ -68,15 +77,6 @@ type DeleteDocumentInput struct { // The version name of the document that you want to delete. If not provided, all // versions of the document are deleted. VersionName *string - - // The name of the document. - // - // This member is required. - Name *string - - // The version of the document that you want to delete. If not provided, all - // versions of the document are deleted. - DocumentVersion *string } type DeleteDocumentOutput struct { diff --git a/service/ssm/api_op_DeleteInventory.go b/service/ssm/api_op_DeleteInventory.go index 74916739701..5833e3970ed 100644 --- a/service/ssm/api_op_DeleteInventory.go +++ b/service/ssm/api_op_DeleteInventory.go @@ -67,6 +67,16 @@ type DeleteInventoryInput struct { // This member is required. TypeName *string + // User-provided idempotency token. + ClientToken *string + + // Use this option to view a summary of the deletion request without deleting any + // data or the data type. This option is useful when you only want to understand + // what will be deleted. Once you validate that the data to be deleted is what you + // intend to delete, you can run the same command without specifying the DryRun + // option. + DryRun *bool + // Use the SchemaDeleteOption to delete a custom inventory type (schema). If you // don't choose this option, the system only deletes existing inventory data // associated with the custom inventory type. Choose one of the following options: @@ -76,16 +86,6 @@ type DeleteInventoryInput struct { // disabled version. DeleteSchema: This option deletes the specified custom type // from the Inventory service. You can recreate the schema later, if you want. SchemaDeleteOption types.InventorySchemaDeleteOption - - // Use this option to view a summary of the deletion request without deleting any - // data or the data type. This option is useful when you only want to understand - // what will be deleted. Once you validate that the data to be deleted is what you - // intend to delete, you can run the same command without specifying the DryRun - // option. - DryRun *bool - - // User-provided idempotency token. - ClientToken *string } type DeleteInventoryOutput struct { diff --git a/service/ssm/api_op_DeleteResourceDataSync.go b/service/ssm/api_op_DeleteResourceDataSync.go index b80f197b674..74d5aea2987 100644 --- a/service/ssm/api_op_DeleteResourceDataSync.go +++ b/service/ssm/api_op_DeleteResourceDataSync.go @@ -58,13 +58,13 @@ func (c *Client) DeleteResourceDataSync(ctx context.Context, params *DeleteResou type DeleteResourceDataSyncInput struct { - // Specify the type of resource data sync to delete. - SyncType *string - // The name of the configuration to delete. // // This member is required. SyncName *string + + // Specify the type of resource data sync to delete. + SyncType *string } type DeleteResourceDataSyncOutput struct { diff --git a/service/ssm/api_op_DeregisterPatchBaselineForPatchGroup.go b/service/ssm/api_op_DeregisterPatchBaselineForPatchGroup.go index d645b664212..06234ec4c96 100644 --- a/service/ssm/api_op_DeregisterPatchBaselineForPatchGroup.go +++ b/service/ssm/api_op_DeregisterPatchBaselineForPatchGroup.go @@ -56,15 +56,15 @@ func (c *Client) DeregisterPatchBaselineForPatchGroup(ctx context.Context, param type DeregisterPatchBaselineForPatchGroupInput struct { - // The name of the patch group that should be deregistered from the patch baseline. + // The ID of the patch baseline to deregister the patch group from. // // This member is required. - PatchGroup *string + BaselineId *string - // The ID of the patch baseline to deregister the patch group from. + // The name of the patch group that should be deregistered from the patch baseline. // // This member is required. - BaselineId *string + PatchGroup *string } type DeregisterPatchBaselineForPatchGroupOutput struct { diff --git a/service/ssm/api_op_DeregisterTargetFromMaintenanceWindow.go b/service/ssm/api_op_DeregisterTargetFromMaintenanceWindow.go index e142995eafa..d15c91def87 100644 --- a/service/ssm/api_op_DeregisterTargetFromMaintenanceWindow.go +++ b/service/ssm/api_op_DeregisterTargetFromMaintenanceWindow.go @@ -56,6 +56,11 @@ func (c *Client) DeregisterTargetFromMaintenanceWindow(ctx context.Context, para type DeregisterTargetFromMaintenanceWindowInput struct { + // The ID of the maintenance window the target should be removed from. + // + // This member is required. + WindowId *string + // The ID of the target definition to remove. // // This member is required. @@ -65,11 +70,6 @@ type DeregisterTargetFromMaintenanceWindowInput struct { // being referenced, the system returns an error and does not deregister the target // from the maintenance window. Safe *bool - - // The ID of the maintenance window the target should be removed from. - // - // This member is required. - WindowId *string } type DeregisterTargetFromMaintenanceWindowOutput struct { diff --git a/service/ssm/api_op_DescribeAssociation.go b/service/ssm/api_op_DescribeAssociation.go index 225bd586032..28c2de52e06 100644 --- a/service/ssm/api_op_DescribeAssociation.go +++ b/service/ssm/api_op_DescribeAssociation.go @@ -69,11 +69,11 @@ type DescribeAssociationInput struct { // versions for a specific association, use ListAssociationVersions (). AssociationVersion *string - // The name of the Systems Manager document. - Name *string - // The instance ID. InstanceId *string + + // The name of the Systems Manager document. + Name *string } type DescribeAssociationOutput struct { diff --git a/service/ssm/api_op_DescribeAssociationExecutionTargets.go b/service/ssm/api_op_DescribeAssociationExecutionTargets.go index 8d5dac2be7e..778dd4da04c 100644 --- a/service/ssm/api_op_DescribeAssociationExecutionTargets.go +++ b/service/ssm/api_op_DescribeAssociationExecutionTargets.go @@ -58,24 +58,24 @@ func (c *Client) DescribeAssociationExecutionTargets(ctx context.Context, params type DescribeAssociationExecutionTargetsInput struct { - // The maximum number of items to return for this call. The call also returns a - // token that you can specify in a subsequent call to get the next set of results. - MaxResults *int32 - - // Filters for the request. You can specify the following filters and values. - // Status (EQUAL) ResourceId (EQUAL) ResourceType (EQUAL) - Filters []*types.AssociationExecutionTargetsFilter + // The association ID that includes the execution for which you want to view + // details. + // + // This member is required. + AssociationId *string // The execution ID for which you want to view details. // // This member is required. ExecutionId *string - // The association ID that includes the execution for which you want to view - // details. - // - // This member is required. - AssociationId *string + // Filters for the request. You can specify the following filters and values. + // Status (EQUAL) ResourceId (EQUAL) ResourceType (EQUAL) + Filters []*types.AssociationExecutionTargetsFilter + + // The maximum number of items to return for this call. The call also returns a + // token that you can specify in a subsequent call to get the next set of results. + MaxResults *int32 // A token to start the list. Use this token to get the next set of results. NextToken *string diff --git a/service/ssm/api_op_DescribeAssociationExecutions.go b/service/ssm/api_op_DescribeAssociationExecutions.go index 33e5b687a06..4e0ff4146d5 100644 --- a/service/ssm/api_op_DescribeAssociationExecutions.go +++ b/service/ssm/api_op_DescribeAssociationExecutions.go @@ -57,18 +57,18 @@ func (c *Client) DescribeAssociationExecutions(ctx context.Context, params *Desc type DescribeAssociationExecutionsInput struct { - // The maximum number of items to return for this call. The call also returns a - // token that you can specify in a subsequent call to get the next set of results. - MaxResults *int32 + // The association ID for which you want to view execution history details. + // + // This member is required. + AssociationId *string // Filters for the request. You can specify the following filters and values. // ExecutionId (EQUAL) Status (EQUAL) CreatedTime (EQUAL, GREATER_THAN, LESS_THAN) Filters []*types.AssociationExecutionFilter - // The association ID for which you want to view execution history details. - // - // This member is required. - AssociationId *string + // The maximum number of items to return for this call. The call also returns a + // token that you can specify in a subsequent call to get the next set of results. + MaxResults *int32 // A token to start the list. Use this token to get the next set of results. NextToken *string diff --git a/service/ssm/api_op_DescribeAutomationExecutions.go b/service/ssm/api_op_DescribeAutomationExecutions.go index c253bae2a80..d0a63e0b3ae 100644 --- a/service/ssm/api_op_DescribeAutomationExecutions.go +++ b/service/ssm/api_op_DescribeAutomationExecutions.go @@ -60,25 +60,25 @@ type DescribeAutomationExecutionsInput struct { // Filters used to limit the scope of executions that are requested. Filters []*types.AutomationExecutionFilter - // The token for the next set of items to return. (You received this token from a - // previous call.) - NextToken *string - // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 + + // The token for the next set of items to return. (You received this token from a + // previous call.) + NextToken *string } type DescribeAutomationExecutionsOutput struct { - // The token to use when requesting the next set of items. If there are no - // additional items to return, the string is empty. - NextToken *string - // The list of details about each automation execution which has occurred which // matches the filter specification, if any. AutomationExecutionMetadataList []*types.AutomationExecutionMetadata + // The token to use when requesting the next set of items. If there are no + // additional items to return, the string is empty. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_DescribeAutomationStepExecutions.go b/service/ssm/api_op_DescribeAutomationStepExecutions.go index b3338574f4c..2b0c3b7e422 100644 --- a/service/ssm/api_op_DescribeAutomationStepExecutions.go +++ b/service/ssm/api_op_DescribeAutomationStepExecutions.go @@ -63,6 +63,10 @@ type DescribeAutomationStepExecutionsInput struct { // This member is required. AutomationExecutionId *string + // One or more filters to limit the number of step executions returned by the + // request. + Filters []*types.StepExecutionFilter + // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 @@ -71,10 +75,6 @@ type DescribeAutomationStepExecutionsInput struct { // previous call.) NextToken *string - // One or more filters to limit the number of step executions returned by the - // request. - Filters []*types.StepExecutionFilter - // A boolean that indicates whether to list step executions in reverse order by // start time. The default value is false. ReverseOrder *bool diff --git a/service/ssm/api_op_DescribeAvailablePatches.go b/service/ssm/api_op_DescribeAvailablePatches.go index c025f8e44ad..3322968751d 100644 --- a/service/ssm/api_op_DescribeAvailablePatches.go +++ b/service/ssm/api_op_DescribeAvailablePatches.go @@ -56,15 +56,15 @@ func (c *Client) DescribeAvailablePatches(ctx context.Context, params *DescribeA type DescribeAvailablePatchesInput struct { - // The token for the next set of items to return. (You received this token from a - // previous call.) - NextToken *string + // Filters used to scope down the returned patches. + Filters []*types.PatchOrchestratorFilter // The maximum number of patches to return (per page). MaxResults *int32 - // Filters used to scope down the returned patches. - Filters []*types.PatchOrchestratorFilter + // The token for the next set of items to return. (You received this token from a + // previous call.) + NextToken *string } type DescribeAvailablePatchesOutput struct { diff --git a/service/ssm/api_op_DescribeDocument.go b/service/ssm/api_op_DescribeDocument.go index 687f7cd4808..ffa7e286ccb 100644 --- a/service/ssm/api_op_DescribeDocument.go +++ b/service/ssm/api_op_DescribeDocument.go @@ -57,11 +57,6 @@ func (c *Client) DescribeDocument(ctx context.Context, params *DescribeDocumentI type DescribeDocumentInput struct { - // An optional field specifying the version of the artifact associated with the - // document. For example, "Release 12, Update 6". This value is unique across all - // versions of a document, and cannot be changed. - VersionName *string - // The name of the Systems Manager document. // // This member is required. @@ -70,6 +65,11 @@ type DescribeDocumentInput struct { // The document version for which you want information. Can be a specific version // or the default version. DocumentVersion *string + + // An optional field specifying the version of the artifact associated with the + // document. For example, "Release 12, Update 6". This value is unique across all + // versions of a document, and cannot be changed. + VersionName *string } type DescribeDocumentOutput struct { diff --git a/service/ssm/api_op_DescribeEffectiveInstanceAssociations.go b/service/ssm/api_op_DescribeEffectiveInstanceAssociations.go index 6b908fd11bf..f779818338d 100644 --- a/service/ssm/api_op_DescribeEffectiveInstanceAssociations.go +++ b/service/ssm/api_op_DescribeEffectiveInstanceAssociations.go @@ -57,15 +57,15 @@ func (c *Client) DescribeEffectiveInstanceAssociations(ctx context.Context, para type DescribeEffectiveInstanceAssociationsInput struct { - // The maximum number of items to return for this call. The call also returns a - // token that you can specify in a subsequent call to get the next set of results. - MaxResults *int32 - // The instance ID for which you want to view all associations. // // This member is required. InstanceId *string + // The maximum number of items to return for this call. The call also returns a + // token that you can specify in a subsequent call to get the next set of results. + MaxResults *int32 + // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string diff --git a/service/ssm/api_op_DescribeEffectivePatchesForPatchBaseline.go b/service/ssm/api_op_DescribeEffectivePatchesForPatchBaseline.go index 9bd996e3823..cde5796410c 100644 --- a/service/ssm/api_op_DescribeEffectivePatchesForPatchBaseline.go +++ b/service/ssm/api_op_DescribeEffectivePatchesForPatchBaseline.go @@ -64,23 +64,23 @@ type DescribeEffectivePatchesForPatchBaselineInput struct { // This member is required. BaselineId *string + // The maximum number of patches to return (per page). + MaxResults *int32 + // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string - - // The maximum number of patches to return (per page). - MaxResults *int32 } type DescribeEffectivePatchesForPatchBaselineOutput struct { + // An array of patches and patch status. + EffectivePatches []*types.EffectivePatch + // The token to use when requesting the next set of items. If there are no // additional items to return, the string is empty. NextToken *string - // An array of patches and patch status. - EffectivePatches []*types.EffectivePatch - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_DescribeInstanceAssociationsStatus.go b/service/ssm/api_op_DescribeInstanceAssociationsStatus.go index ca5b7111437..36b45fac077 100644 --- a/service/ssm/api_op_DescribeInstanceAssociationsStatus.go +++ b/service/ssm/api_op_DescribeInstanceAssociationsStatus.go @@ -62,13 +62,13 @@ type DescribeInstanceAssociationsStatusInput struct { // This member is required. InstanceId *string - // The token for the next set of items to return. (You received this token from a - // previous call.) - NextToken *string - // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 + + // The token for the next set of items to return. (You received this token from a + // previous call.) + NextToken *string } type DescribeInstanceAssociationsStatusOutput struct { diff --git a/service/ssm/api_op_DescribeInstanceInformation.go b/service/ssm/api_op_DescribeInstanceInformation.go index 8b072008c5d..f154950306f 100644 --- a/service/ssm/api_op_DescribeInstanceInformation.go +++ b/service/ssm/api_op_DescribeInstanceInformation.go @@ -65,35 +65,35 @@ func (c *Client) DescribeInstanceInformation(ctx context.Context, params *Descri type DescribeInstanceInformationInput struct { + // One or more filters. Use a filter to return a more specific list of instances. + // You can filter based on tags applied to EC2 instances. Use this Filters data + // type instead of InstanceInformationFilterList, which is deprecated. + Filters []*types.InstanceInformationStringFilter + // This is a legacy method. We recommend that you don't use this method. Instead, // use the Filters data type. Filters enables you to return instance information by // filtering based on tags applied to managed instances. Attempting to use // InstanceInformationFilterList and Filters leads to an exception error. InstanceInformationFilterList []*types.InstanceInformationFilter - // One or more filters. Use a filter to return a more specific list of instances. - // You can filter based on tags applied to EC2 instances. Use this Filters data - // type instead of InstanceInformationFilterList, which is deprecated. - Filters []*types.InstanceInformationStringFilter + // The maximum number of items to return for this call. The call also returns a + // token that you can specify in a subsequent call to get the next set of results. + MaxResults *int32 // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string - - // The maximum number of items to return for this call. The call also returns a - // token that you can specify in a subsequent call to get the next set of results. - MaxResults *int32 } type DescribeInstanceInformationOutput struct { + // The instance information list. + InstanceInformationList []*types.InstanceInformation + // The token to use when requesting the next set of items. If there are no // additional items to return, the string is empty. NextToken *string - // The instance information list. - InstanceInformationList []*types.InstanceInformation - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_DescribeInstancePatchStates.go b/service/ssm/api_op_DescribeInstancePatchStates.go index d77f547ed8a..7ab280caee9 100644 --- a/service/ssm/api_op_DescribeInstancePatchStates.go +++ b/service/ssm/api_op_DescribeInstancePatchStates.go @@ -57,10 +57,6 @@ func (c *Client) DescribeInstancePatchStates(ctx context.Context, params *Descri type DescribeInstancePatchStatesInput struct { - // The token for the next set of items to return. (You received this token from a - // previous call.) - NextToken *string - // The ID of the instance whose patch state information should be retrieved. // // This member is required. @@ -68,17 +64,21 @@ type DescribeInstancePatchStatesInput struct { // The maximum number of instances to return (per page). MaxResults *int32 + + // The token for the next set of items to return. (You received this token from a + // previous call.) + NextToken *string } type DescribeInstancePatchStatesOutput struct { + // The high-level patch state for the requested instances. + InstancePatchStates []*types.InstancePatchState + // The token to use when requesting the next set of items. If there are no // additional items to return, the string is empty. NextToken *string - // The high-level patch state for the requested instances. - InstancePatchStates []*types.InstancePatchState - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_DescribeInstancePatchStatesForPatchGroup.go b/service/ssm/api_op_DescribeInstancePatchStatesForPatchGroup.go index 0e99b6ba591..d7ee15162f7 100644 --- a/service/ssm/api_op_DescribeInstancePatchStatesForPatchGroup.go +++ b/service/ssm/api_op_DescribeInstancePatchStatesForPatchGroup.go @@ -79,13 +79,13 @@ type DescribeInstancePatchStatesForPatchGroupInput struct { type DescribeInstancePatchStatesForPatchGroupOutput struct { + // The high-level patch state for the requested instances. + InstancePatchStates []*types.InstancePatchState + // The token to use when requesting the next set of items. If there are no // additional items to return, the string is empty. NextToken *string - // The high-level patch state for the requested instances. - InstancePatchStates []*types.InstancePatchState - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_DescribeInstancePatches.go b/service/ssm/api_op_DescribeInstancePatches.go index 511b4cad133..0b470ce7981 100644 --- a/service/ssm/api_op_DescribeInstancePatches.go +++ b/service/ssm/api_op_DescribeInstancePatches.go @@ -63,14 +63,14 @@ type DescribeInstancePatchesInput struct { // This member is required. InstanceId *string - // The maximum number of patches to return (per page). - MaxResults *int32 - // An array of structures. Each entry in the array is a structure containing a Key, // Value combination. Valid values for Key are Classification | KBId | Severity | // State. Filters []*types.PatchOrchestratorFilter + // The maximum number of patches to return (per page). + MaxResults *int32 + // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string diff --git a/service/ssm/api_op_DescribeInventoryDeletions.go b/service/ssm/api_op_DescribeInventoryDeletions.go index 96f1f556adc..c90a1223c75 100644 --- a/service/ssm/api_op_DescribeInventoryDeletions.go +++ b/service/ssm/api_op_DescribeInventoryDeletions.go @@ -60,12 +60,12 @@ type DescribeInventoryDeletionsInput struct { // returned by the DeleteInventory action. DeletionId *string - // A token to start the list. Use this token to get the next set of results. - NextToken *string - // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 + + // A token to start the list. Use this token to get the next set of results. + NextToken *string } type DescribeInventoryDeletionsOutput struct { diff --git a/service/ssm/api_op_DescribeMaintenanceWindowExecutionTaskInvocations.go b/service/ssm/api_op_DescribeMaintenanceWindowExecutionTaskInvocations.go index c86b8b7d2a5..d8753a66454 100644 --- a/service/ssm/api_op_DescribeMaintenanceWindowExecutionTaskInvocations.go +++ b/service/ssm/api_op_DescribeMaintenanceWindowExecutionTaskInvocations.go @@ -58,40 +58,40 @@ func (c *Client) DescribeMaintenanceWindowExecutionTaskInvocations(ctx context.C type DescribeMaintenanceWindowExecutionTaskInvocationsInput struct { - // The maximum number of items to return for this call. The call also returns a - // token that you can specify in a subsequent call to get the next set of results. - MaxResults *int32 - // The ID of the specific task in the maintenance window task that should be // retrieved. // // This member is required. TaskId *string + // The ID of the maintenance window execution the task is part of. + // + // This member is required. + WindowExecutionId *string + // Optional filters used to scope down the returned task invocations. The supported // filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, // SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED. Filters []*types.MaintenanceWindowFilter + // The maximum number of items to return for this call. The call also returns a + // token that you can specify in a subsequent call to get the next set of results. + MaxResults *int32 + // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string - - // The ID of the maintenance window execution the task is part of. - // - // This member is required. - WindowExecutionId *string } type DescribeMaintenanceWindowExecutionTaskInvocationsOutput struct { - // Information about the task invocation results per invocation. - WindowExecutionTaskInvocationIdentities []*types.MaintenanceWindowExecutionTaskInvocationIdentity - // The token to use when requesting the next set of items. If there are no // additional items to return, the string is empty. NextToken *string + // Information about the task invocation results per invocation. + WindowExecutionTaskInvocationIdentities []*types.MaintenanceWindowExecutionTaskInvocationIdentity + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_DescribeMaintenanceWindowExecutionTasks.go b/service/ssm/api_op_DescribeMaintenanceWindowExecutionTasks.go index 37eb2184be9..b579c280e2e 100644 --- a/service/ssm/api_op_DescribeMaintenanceWindowExecutionTasks.go +++ b/service/ssm/api_op_DescribeMaintenanceWindowExecutionTasks.go @@ -57,24 +57,24 @@ func (c *Client) DescribeMaintenanceWindowExecutionTasks(ctx context.Context, pa type DescribeMaintenanceWindowExecutionTasksInput struct { + // The ID of the maintenance window execution whose task executions should be + // retrieved. + // + // This member is required. + WindowExecutionId *string + // Optional filters used to scope down the returned tasks. The supported filter key // is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, // TIMED_OUT, CANCELLING, and CANCELLED. Filters []*types.MaintenanceWindowFilter - // The token for the next set of items to return. (You received this token from a - // previous call.) - NextToken *string - // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 - // The ID of the maintenance window execution whose task executions should be - // retrieved. - // - // This member is required. - WindowExecutionId *string + // The token for the next set of items to return. (You received this token from a + // previous call.) + NextToken *string } type DescribeMaintenanceWindowExecutionTasksOutput struct { diff --git a/service/ssm/api_op_DescribeMaintenanceWindowSchedule.go b/service/ssm/api_op_DescribeMaintenanceWindowSchedule.go index b5044341fe5..91c7e863d99 100644 --- a/service/ssm/api_op_DescribeMaintenanceWindowSchedule.go +++ b/service/ssm/api_op_DescribeMaintenanceWindowSchedule.go @@ -61,16 +61,6 @@ type DescribeMaintenanceWindowScheduleInput struct { // date and time. Filters []*types.PatchOrchestratorFilter - // The instance ID or key/value pair to retrieve information about. - Targets []*types.Target - - // The type of resource you want to retrieve information about. For example, - // "INSTANCE". - ResourceType types.MaintenanceWindowResourceType - - // The ID of the maintenance window to retrieve information about. - WindowId *string - // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 @@ -78,18 +68,28 @@ type DescribeMaintenanceWindowScheduleInput struct { // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string + + // The type of resource you want to retrieve information about. For example, + // "INSTANCE". + ResourceType types.MaintenanceWindowResourceType + + // The instance ID or key/value pair to retrieve information about. + Targets []*types.Target + + // The ID of the maintenance window to retrieve information about. + WindowId *string } type DescribeMaintenanceWindowScheduleOutput struct { - // Information about maintenance window executions scheduled for the specified time - // range. - ScheduledWindowExecutions []*types.ScheduledWindowExecution - // The token for the next set of items to return. (You use this token in the next // call.) NextToken *string + // Information about maintenance window executions scheduled for the specified time + // range. + ScheduledWindowExecutions []*types.ScheduledWindowExecution + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_DescribeMaintenanceWindowTargets.go b/service/ssm/api_op_DescribeMaintenanceWindowTargets.go index c176f1f410a..c13c4acb612 100644 --- a/service/ssm/api_op_DescribeMaintenanceWindowTargets.go +++ b/service/ssm/api_op_DescribeMaintenanceWindowTargets.go @@ -57,23 +57,23 @@ func (c *Client) DescribeMaintenanceWindowTargets(ctx context.Context, params *D type DescribeMaintenanceWindowTargetsInput struct { + // The ID of the maintenance window whose targets should be retrieved. + // + // This member is required. + WindowId *string + // Optional filters that can be used to narrow down the scope of the returned // window targets. The supported filter keys are Type, WindowTargetId and // OwnerInformation. Filters []*types.MaintenanceWindowFilter - // The token for the next set of items to return. (You received this token from a - // previous call.) - NextToken *string - // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 - // The ID of the maintenance window whose targets should be retrieved. - // - // This member is required. - WindowId *string + // The token for the next set of items to return. (You received this token from a + // previous call.) + NextToken *string } type DescribeMaintenanceWindowTargetsOutput struct { diff --git a/service/ssm/api_op_DescribeMaintenanceWindowTasks.go b/service/ssm/api_op_DescribeMaintenanceWindowTasks.go index 0d10ffdbe55..bc735ad6d99 100644 --- a/service/ssm/api_op_DescribeMaintenanceWindowTasks.go +++ b/service/ssm/api_op_DescribeMaintenanceWindowTasks.go @@ -57,22 +57,22 @@ func (c *Client) DescribeMaintenanceWindowTasks(ctx context.Context, params *Des type DescribeMaintenanceWindowTasksInput struct { + // The ID of the maintenance window whose tasks should be retrieved. + // + // This member is required. + WindowId *string + // Optional filters used to narrow down the scope of the returned tasks. The // supported filter keys are WindowTaskId, TaskArn, Priority, and TaskType. Filters []*types.MaintenanceWindowFilter - // The token for the next set of items to return. (You received this token from a - // previous call.) - NextToken *string - // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 - // The ID of the maintenance window whose tasks should be retrieved. - // - // This member is required. - WindowId *string + // The token for the next set of items to return. (You received this token from a + // previous call.) + NextToken *string } type DescribeMaintenanceWindowTasksOutput struct { diff --git a/service/ssm/api_op_DescribeMaintenanceWindowsForTarget.go b/service/ssm/api_op_DescribeMaintenanceWindowsForTarget.go index dd51aa85270..f327cde3764 100644 --- a/service/ssm/api_op_DescribeMaintenanceWindowsForTarget.go +++ b/service/ssm/api_op_DescribeMaintenanceWindowsForTarget.go @@ -58,6 +58,12 @@ func (c *Client) DescribeMaintenanceWindowsForTarget(ctx context.Context, params type DescribeMaintenanceWindowsForTargetInput struct { + // The type of resource you want to retrieve information about. For example, + // "INSTANCE". + // + // This member is required. + ResourceType types.MaintenanceWindowResourceType + // The instance ID or key/value pair to retrieve information about. // // This member is required. @@ -70,24 +76,18 @@ type DescribeMaintenanceWindowsForTargetInput struct { // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string - - // The type of resource you want to retrieve information about. For example, - // "INSTANCE". - // - // This member is required. - ResourceType types.MaintenanceWindowResourceType } type DescribeMaintenanceWindowsForTargetOutput struct { - // Information about the maintenance window targets and tasks an instance is - // associated with. - WindowIdentities []*types.MaintenanceWindowIdentityForTarget - // The token for the next set of items to return. (You use this token in the next // call.) NextToken *string + // Information about the maintenance window targets and tasks an instance is + // associated with. + WindowIdentities []*types.MaintenanceWindowIdentityForTarget + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_DescribeOpsItems.go b/service/ssm/api_op_DescribeOpsItems.go index 0245a156e4d..1ae16333a73 100644 --- a/service/ssm/api_op_DescribeOpsItems.go +++ b/service/ssm/api_op_DescribeOpsItems.go @@ -117,13 +117,13 @@ type DescribeOpsItemsInput struct { type DescribeOpsItemsOutput struct { - // A list of OpsItems. - OpsItemSummaries []*types.OpsItemSummary - // The token for the next set of items to return. Use this token to get the next // set of results. NextToken *string + // A list of OpsItems. + OpsItemSummaries []*types.OpsItemSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_DescribeParameters.go b/service/ssm/api_op_DescribeParameters.go index 4f700c24f0f..62f7f093df6 100644 --- a/service/ssm/api_op_DescribeParameters.go +++ b/service/ssm/api_op_DescribeParameters.go @@ -66,26 +66,26 @@ type DescribeParametersInput struct { // This data type is deprecated. Instead, use ParameterFilters. Filters []*types.ParametersFilter - // Filters to limit the request results. - ParameterFilters []*types.ParameterStringFilter + // The maximum number of items to return for this call. The call also returns a + // token that you can specify in a subsequent call to get the next set of results. + MaxResults *int32 // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string - // The maximum number of items to return for this call. The call also returns a - // token that you can specify in a subsequent call to get the next set of results. - MaxResults *int32 + // Filters to limit the request results. + ParameterFilters []*types.ParameterStringFilter } type DescribeParametersOutput struct { - // Parameters returned by the request. - Parameters []*types.ParameterMetadata - // The token to use when requesting the next set of items. NextToken *string + // Parameters returned by the request. + Parameters []*types.ParameterMetadata + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_DescribePatchBaselines.go b/service/ssm/api_op_DescribePatchBaselines.go index e58cf80f5ae..0b0d97d4cc8 100644 --- a/service/ssm/api_op_DescribePatchBaselines.go +++ b/service/ssm/api_op_DescribePatchBaselines.go @@ -56,14 +56,14 @@ func (c *Client) DescribePatchBaselines(ctx context.Context, params *DescribePat type DescribePatchBaselinesInput struct { - // The maximum number of patch baselines to return (per page). - MaxResults *int32 - // Each element in the array is a structure containing: Key: (string, "NAME_PREFIX" // or "OWNER") Value: (array of strings, exactly 1 entry, between 1 and 255 // characters) Filters []*types.PatchOrchestratorFilter + // The maximum number of patch baselines to return (per page). + MaxResults *int32 + // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string diff --git a/service/ssm/api_op_DescribePatchGroupState.go b/service/ssm/api_op_DescribePatchGroupState.go index a4ca66424e2..ae7318f393c 100644 --- a/service/ssm/api_op_DescribePatchGroupState.go +++ b/service/ssm/api_op_DescribePatchGroupState.go @@ -64,14 +64,17 @@ type DescribePatchGroupStateInput struct { type DescribePatchGroupStateOutput struct { - // The number of instances with NotApplicable patches beyond the supported limit, - // which are not reported by name to Systems Manager Inventory. - InstancesWithUnreportedNotApplicablePatches *int32 + // The number of instances in the patch group. + Instances *int32 // The number of instances with patches from the patch baseline that failed to // install. InstancesWithFailedPatches *int32 + // The number of instances with patches installed that aren't defined in the patch + // baseline. + InstancesWithInstalledOtherPatches *int32 + // The number of instances with installed patches. InstancesWithInstalledPatches *int32 @@ -87,18 +90,15 @@ type DescribePatchGroupStateOutput struct { // of InstancesWithInstalledRejectedPatches will always be 0 (zero). InstancesWithInstalledRejectedPatches *int32 - // The number of instances with patches that aren't applicable. - InstancesWithNotApplicablePatches *int32 - - // The number of instances with patches installed that aren't defined in the patch - // baseline. - InstancesWithInstalledOtherPatches *int32 - // The number of instances with missing patches from the patch baseline. InstancesWithMissingPatches *int32 - // The number of instances in the patch group. - Instances *int32 + // The number of instances with patches that aren't applicable. + InstancesWithNotApplicablePatches *int32 + + // The number of instances with NotApplicable patches beyond the supported limit, + // which are not reported by name to Systems Manager Inventory. + InstancesWithUnreportedNotApplicablePatches *int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/ssm/api_op_DescribePatchGroups.go b/service/ssm/api_op_DescribePatchGroups.go index 91e8be16c31..b38ff624579 100644 --- a/service/ssm/api_op_DescribePatchGroups.go +++ b/service/ssm/api_op_DescribePatchGroups.go @@ -56,13 +56,6 @@ func (c *Client) DescribePatchGroups(ctx context.Context, params *DescribePatchG type DescribePatchGroupsInput struct { - // The token for the next set of items to return. (You received this token from a - // previous call.) - NextToken *string - - // The maximum number of patch groups to return (per page). - MaxResults *int32 - // One or more filters. Use a filter to return a more specific list of results. For // DescribePatchGroups,valid filter keys include the following: // @@ -80,6 +73,13 @@ type DescribePatchGroupsInput struct { // * // --filters Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2 Filters []*types.PatchOrchestratorFilter + + // The maximum number of patch groups to return (per page). + MaxResults *int32 + + // The token for the next set of items to return. (You received this token from a + // previous call.) + NextToken *string } type DescribePatchGroupsOutput struct { diff --git a/service/ssm/api_op_DescribePatchProperties.go b/service/ssm/api_op_DescribePatchProperties.go index ad57e095ef8..89137075488 100644 --- a/service/ssm/api_op_DescribePatchProperties.go +++ b/service/ssm/api_op_DescribePatchProperties.go @@ -68,27 +68,27 @@ func (c *Client) DescribePatchProperties(ctx context.Context, params *DescribePa type DescribePatchPropertiesInput struct { - // The patch property for which you want to view patch details. + // The operating system type for which to list patches. // // This member is required. - Property types.PatchProperty + OperatingSystem types.OperatingSystem - // The operating system type for which to list patches. + // The patch property for which you want to view patch details. // // This member is required. - OperatingSystem types.OperatingSystem + Property types.PatchProperty - // Indicates whether to list patches for the Windows operating system or for - // Microsoft applications. Not applicable for Linux operating systems. - PatchSet types.PatchSet + // The maximum number of items to return for this call. The call also returns a + // token that you can specify in a subsequent call to get the next set of results. + MaxResults *int32 // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string - // The maximum number of items to return for this call. The call also returns a - // token that you can specify in a subsequent call to get the next set of results. - MaxResults *int32 + // Indicates whether to list patches for the Windows operating system or for + // Microsoft applications. Not applicable for Linux operating systems. + PatchSet types.PatchSet } type DescribePatchPropertiesOutput struct { diff --git a/service/ssm/api_op_DescribeSessions.go b/service/ssm/api_op_DescribeSessions.go index 73aa6482c4e..6f7b936d424 100644 --- a/service/ssm/api_op_DescribeSessions.go +++ b/service/ssm/api_op_DescribeSessions.go @@ -63,6 +63,9 @@ type DescribeSessionsInput struct { // This member is required. State types.SessionState + // One or more filters to limit the type of sessions returned by the request. + Filters []*types.SessionFilter + // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 @@ -70,20 +73,17 @@ type DescribeSessionsInput struct { // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string - - // One or more filters to limit the type of sessions returned by the request. - Filters []*types.SessionFilter } type DescribeSessionsOutput struct { - // A list of sessions meeting the request parameters. - Sessions []*types.Session - // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string + // A list of sessions meeting the request parameters. + Sessions []*types.Session + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_GetCalendarState.go b/service/ssm/api_op_GetCalendarState.go index 5721574d57e..c2583cf3db6 100644 --- a/service/ssm/api_op_GetCalendarState.go +++ b/service/ssm/api_op_GetCalendarState.go @@ -65,25 +65,20 @@ func (c *Client) GetCalendarState(ctx context.Context, params *GetCalendarStateI type GetCalendarStateInput struct { - // (Optional) The specific time for which you want to get calendar state - // information, in ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601) format. If you - // do not add AtTime, the current time is assumed. - AtTime *string - // The names or Amazon Resource Names (ARNs) of the Systems Manager documents that // represent the calendar entries for which you want to get the state. // // This member is required. CalendarNames []*string + + // (Optional) The specific time for which you want to get calendar state + // information, in ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601) format. If you + // do not add AtTime, the current time is assumed. + AtTime *string } type GetCalendarStateOutput struct { - // The state of the calendar. An OPEN calendar indicates that actions are allowed - // to proceed, and a CLOSED calendar indicates that actions are not allowed to - // proceed. - State types.CalendarState - // The time, as an ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601) string, that // you specified in your command. If you did not specify a time, GetCalendarState // uses the current time. @@ -95,6 +90,11 @@ type GetCalendarStateOutput struct { // vice-versa. NextTransitionTime *string + // The state of the calendar. An OPEN calendar indicates that actions are allowed + // to proceed, and a CLOSED calendar indicates that actions are not allowed to + // proceed. + State types.CalendarState + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_GetCommandInvocation.go b/service/ssm/api_op_GetCommandInvocation.go index a61ffb35837..376d339de39 100644 --- a/service/ssm/api_op_GetCommandInvocation.go +++ b/service/ssm/api_op_GetCommandInvocation.go @@ -58,12 +58,6 @@ func (c *Client) GetCommandInvocation(ctx context.Context, params *GetCommandInv type GetCommandInvocationInput struct { - // (Optional) The name of the plugin for which you want detailed results. If the - // document contains only one plugin, the name can be omitted and the details will - // be returned. Plugin names are also referred to as step names in Systems Manager - // documents. - PluginName *string - // (Required) The parent command ID of the invocation plugin. // // This member is required. @@ -75,10 +69,34 @@ type GetCommandInvocationInput struct { // // This member is required. InstanceId *string + + // (Optional) The name of the plugin for which you want detailed results. If the + // document contains only one plugin, the name can be omitted and the details will + // be returned. Plugin names are also referred to as step names in Systems Manager + // documents. + PluginName *string } type GetCommandInvocationOutput struct { + // CloudWatch Logs information where Systems Manager sent the command output. + CloudWatchOutputConfig *types.CloudWatchOutputConfig + + // The parent command ID of the invocation plugin. + CommandId *string + + // The comment text for the command. + Comment *string + + // The name of the document that was run. For example, AWS-RunShellScript. + DocumentName *string + + // The SSM document version used in the request. + DocumentVersion *string + + // Duration since ExecutionStartDateTime. + ExecutionElapsedTime *string + // The date and time the plugin was finished running. Date and time are written in // ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The // following sample AWS CLI command uses the InvokedAfter filter. aws ssm @@ -86,28 +104,47 @@ type GetCommandInvocationOutput struct { // plugin has not started to run, the string is empty. ExecutionEndDateTime *string - // The parent command ID of the invocation plugin. - CommandId *string - - // The URL for the complete text written by the plugin to stdout in Amazon S3. If - // an S3 bucket was not specified, then this string is empty. - StandardOutputUrl *string + // The date and time the plugin started running. Date and time are written in ISO + // 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The + // following sample AWS CLI command uses the InvokedBefore filter. aws ssm + // list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z If the + // plugin has not started to run, the string is empty. + ExecutionStartDateTime *string - // The URL for the complete text written by the plugin to stderr. If the command - // has not finished running, then this string is empty. - StandardErrorUrl *string + // The ID of the managed instance targeted by the command. A managed instance can + // be an EC2 instance or an instance in your hybrid environment that is configured + // for Systems Manager. + InstanceId *string - // The name of the document that was run. For example, AWS-RunShellScript. - DocumentName *string + // The name of the plugin for which you want detailed results. For example, + // aws:RunShellScript is a plugin. + PluginName *string // The error level response code for the plugin script. If the response code is -1, // then the command has not started running on the instance, or it was not received // by the instance. ResponseCode *int32 - // The name of the plugin for which you want detailed results. For example, - // aws:RunShellScript is a plugin. - PluginName *string + // The first 8,000 characters written by the plugin to stderr. If the command has + // not finished running, then this string is empty. + StandardErrorContent *string + + // The URL for the complete text written by the plugin to stderr. If the command + // has not finished running, then this string is empty. + StandardErrorUrl *string + + // The first 24,000 characters written by the plugin to stdout. If the command has + // not finished running, if ExecutionStatus is neither Succeeded nor Failed, then + // this string is empty. + StandardOutputContent *string + + // The URL for the complete text written by the plugin to stdout in Amazon S3. If + // an S3 bucket was not specified, then this string is empty. + StandardOutputUrl *string + + // The status of this invocation plugin. This status can be different than + // StatusDetails. + Status types.CommandInvocationStatus // A detailed status of the command execution for an invocation. StatusDetails // includes more information than Status because it includes states resulting from @@ -146,43 +183,6 @@ type GetCommandInvocationOutput struct { // StatusDetails *string - // The date and time the plugin started running. Date and time are written in ISO - // 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The - // following sample AWS CLI command uses the InvokedBefore filter. aws ssm - // list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z If the - // plugin has not started to run, the string is empty. - ExecutionStartDateTime *string - - // The ID of the managed instance targeted by the command. A managed instance can - // be an EC2 instance or an instance in your hybrid environment that is configured - // for Systems Manager. - InstanceId *string - - // The first 24,000 characters written by the plugin to stdout. If the command has - // not finished running, if ExecutionStatus is neither Succeeded nor Failed, then - // this string is empty. - StandardOutputContent *string - - // The comment text for the command. - Comment *string - - // Duration since ExecutionStartDateTime. - ExecutionElapsedTime *string - - // The first 8,000 characters written by the plugin to stderr. If the command has - // not finished running, then this string is empty. - StandardErrorContent *string - - // The SSM document version used in the request. - DocumentVersion *string - - // The status of this invocation plugin. This status can be different than - // StatusDetails. - Status types.CommandInvocationStatus - - // CloudWatch Logs information where Systems Manager sent the command output. - CloudWatchOutputConfig *types.CloudWatchOutputConfig - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_GetDefaultPatchBaseline.go b/service/ssm/api_op_GetDefaultPatchBaseline.go index dd4123bfaf8..400968249ea 100644 --- a/service/ssm/api_op_GetDefaultPatchBaseline.go +++ b/service/ssm/api_op_GetDefaultPatchBaseline.go @@ -65,12 +65,12 @@ type GetDefaultPatchBaselineInput struct { type GetDefaultPatchBaselineOutput struct { - // The operating system for the returned patch baseline. - OperatingSystem types.OperatingSystem - // The ID of the default patch baseline. BaselineId *string + // The operating system for the returned patch baseline. + OperatingSystem types.OperatingSystem + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_GetDeployablePatchSnapshotForInstance.go b/service/ssm/api_op_GetDeployablePatchSnapshotForInstance.go index 67e9b395122..66e1efce0c7 100644 --- a/service/ssm/api_op_GetDeployablePatchSnapshotForInstance.go +++ b/service/ssm/api_op_GetDeployablePatchSnapshotForInstance.go @@ -71,9 +71,6 @@ type GetDeployablePatchSnapshotForInstanceInput struct { type GetDeployablePatchSnapshotForInstanceOutput struct { - // The user-defined snapshot ID. - SnapshotId *string - // The ID of the instance. InstanceId *string @@ -84,6 +81,9 @@ type GetDeployablePatchSnapshotForInstanceOutput struct { // A pre-signed Amazon S3 URL that can be used to download the patch snapshot. SnapshotDownloadUrl *string + // The user-defined snapshot ID. + SnapshotId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_GetDocument.go b/service/ssm/api_op_GetDocument.go index 953f90777c9..6af7a8fa7fd 100644 --- a/service/ssm/api_op_GetDocument.go +++ b/service/ssm/api_op_GetDocument.go @@ -57,6 +57,11 @@ func (c *Client) GetDocument(ctx context.Context, params *GetDocumentInput, optF type GetDocumentInput struct { + // The name of the Systems Manager document. + // + // This member is required. + Name *string + // Returns the document in the specified format. The document format can be either // JSON or YAML. JSON is the default format. DocumentFormat types.DocumentFormat @@ -64,11 +69,6 @@ type GetDocumentInput struct { // The document version for which you want information. DocumentVersion *string - // The name of the Systems Manager document. - // - // This member is required. - Name *string - // An optional field specifying the version of the artifact associated with the // document. For example, "Release 12, Update 6". This value is unique across all // versions of a document and can't be changed. @@ -77,31 +77,33 @@ type GetDocumentInput struct { type GetDocumentOutput struct { - // The name of the Systems Manager document. - Name *string + // A description of the document attachments, including names, locations, sizes, + // and so on. + AttachmentsContent []*types.AttachmentContent - // The document version. - DocumentVersion *string + // The contents of the Systems Manager document. + Content *string + + // The document format, either JSON or YAML. + DocumentFormat types.DocumentFormat // The document type. DocumentType types.DocumentType - // The contents of the Systems Manager document. - Content *string + // The document version. + DocumentVersion *string + + // The name of the Systems Manager document. + Name *string // A list of SSM documents required by a document. For example, an // ApplicationConfiguration document requires an ApplicationConfigurationSchema // document. Requires []*types.DocumentRequires - // A description of the document attachments, including names, locations, sizes, - // and so on. - AttachmentsContent []*types.AttachmentContent - - // The version of the artifact associated with the document. For example, "Release - // 12, Update 6". This value is unique across all versions of a document, and - // cannot be changed. - VersionName *string + // The status of the Systems Manager document, such as Creating, Active, Updating, + // Failed, and Deleting. + Status types.DocumentStatus // A message returned by AWS Systems Manager that explains the Status value. For // example, a Failed status might be explained by the StatusInformation message, @@ -109,12 +111,10 @@ type GetDocumentOutput struct { // correct." StatusInformation *string - // The document format, either JSON or YAML. - DocumentFormat types.DocumentFormat - - // The status of the Systems Manager document, such as Creating, Active, Updating, - // Failed, and Deleting. - Status types.DocumentStatus + // The version of the artifact associated with the document. For example, "Release + // 12, Update 6". This value is unique across all versions of a document, and + // cannot be changed. + VersionName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/ssm/api_op_GetInventory.go b/service/ssm/api_op_GetInventory.go index 3dcd9f762c9..8aab00ad722 100644 --- a/service/ssm/api_op_GetInventory.go +++ b/service/ssm/api_op_GetInventory.go @@ -57,23 +57,23 @@ func (c *Client) GetInventory(ctx context.Context, params *GetInventoryInput, op type GetInventoryInput struct { - // One or more filters. Use a filter to return a more specific list of results. - Filters []*types.InventoryFilter - - // The token for the next set of items to return. (You received this token from a - // previous call.) - NextToken *string - // Returns counts of inventory types based on one or more expressions. For example, // if you aggregate by using an expression that uses the // AWS:InstanceInformation.PlatformType type, you can see a count of how many // Windows and Linux instances exist in your inventoried fleet. Aggregators []*types.InventoryAggregator + // One or more filters. Use a filter to return a more specific list of results. + Filters []*types.InventoryFilter + // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 + // The token for the next set of items to return. (You received this token from a + // previous call.) + NextToken *string + // The list of inventory item types to return. ResultAttributes []*types.ResultAttribute } diff --git a/service/ssm/api_op_GetInventorySchema.go b/service/ssm/api_op_GetInventorySchema.go index 57a4047cd2a..52350516bc5 100644 --- a/service/ssm/api_op_GetInventorySchema.go +++ b/service/ssm/api_op_GetInventorySchema.go @@ -57,11 +57,10 @@ func (c *Client) GetInventorySchema(ctx context.Context, params *GetInventorySch type GetInventorySchemaInput struct { - // The type of inventory item to return. - TypeName *string - - // Returns the sub-type schema for a specified inventory type. - SubType *bool + // Returns inventory schemas that support aggregation. For example, this call + // returns the AWS:InstanceInformation type, because it supports aggregation based + // on the PlatformName, PlatformType, and PlatformVersion attributes. + Aggregator *bool // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. @@ -71,21 +70,22 @@ type GetInventorySchemaInput struct { // previous call.) NextToken *string - // Returns inventory schemas that support aggregation. For example, this call - // returns the AWS:InstanceInformation type, because it supports aggregation based - // on the PlatformName, PlatformType, and PlatformVersion attributes. - Aggregator *bool + // Returns the sub-type schema for a specified inventory type. + SubType *bool + + // The type of inventory item to return. + TypeName *string } type GetInventorySchemaOutput struct { - // Inventory schemas returned by the request. - Schemas []*types.InventoryItemSchema - // The token to use when requesting the next set of items. If there are no // additional items to return, the string is empty. NextToken *string + // Inventory schemas returned by the request. + Schemas []*types.InventoryItemSchema + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_GetMaintenanceWindow.go b/service/ssm/api_op_GetMaintenanceWindow.go index 74bbad7f6b9..188b6c1164f 100644 --- a/service/ssm/api_op_GetMaintenanceWindow.go +++ b/service/ssm/api_op_GetMaintenanceWindow.go @@ -65,55 +65,47 @@ type GetMaintenanceWindowInput struct { type GetMaintenanceWindowOutput struct { - // The date and time, in ISO-8601 Extended format, for when the maintenance window - // is scheduled to become inactive. The maintenance window will not run after this - // specified time. - EndDate *string + // Whether targets must be registered with the maintenance window before tasks can + // be defined for those targets. + AllowUnassociatedTargets *bool // The date the maintenance window was created. CreatedDate *time.Time - // The ID of the created maintenance window. - WindowId *string - - // The date the maintenance window was last modified. - ModifiedDate *time.Time + // The number of hours before the end of the maintenance window that Systems + // Manager stops scheduling new tasks for execution. + Cutoff *int32 - // The number of days to wait to run a maintenance window after the scheduled CRON - // expression date and time. - ScheduleOffset *int32 + // The description of the maintenance window. + Description *string - // The next time the maintenance window will actually run, taking into account any - // specified times for the maintenance window to become active or inactive. - NextExecutionTime *string + // The duration of the maintenance window in hours. + Duration *int32 - // The name of the maintenance window. - Name *string + // Indicates whether the maintenance window is enabled. + Enabled *bool // The date and time, in ISO-8601 Extended format, for when the maintenance window - // is scheduled to become active. The maintenance window will not run before this + // is scheduled to become inactive. The maintenance window will not run after this // specified time. - StartDate *string + EndDate *string - // The duration of the maintenance window in hours. - Duration *int32 + // The date the maintenance window was last modified. + ModifiedDate *time.Time - // Indicates whether the maintenance window is enabled. - Enabled *bool + // The name of the maintenance window. + Name *string - // The number of hours before the end of the maintenance window that Systems - // Manager stops scheduling new tasks for execution. - Cutoff *int32 + // The next time the maintenance window will actually run, taking into account any + // specified times for the maintenance window to become active or inactive. + NextExecutionTime *string // The schedule of the maintenance window in the form of a cron or rate expression. Schedule *string - // Whether targets must be registered with the maintenance window before tasks can - // be defined for those targets. - AllowUnassociatedTargets *bool - - // The description of the maintenance window. - Description *string + // The number of days to wait to run a maintenance window after the scheduled CRON + // expression date and time. + ScheduleOffset *int32 // The time zone that the scheduled maintenance window executions are based on, in // Internet Assigned Numbers Authority (IANA) format. For example: @@ -121,6 +113,14 @@ type GetMaintenanceWindowOutput struct { // Time Zone Database (https://www.iana.org/time-zones) on the IANA website. ScheduleTimezone *string + // The date and time, in ISO-8601 Extended format, for when the maintenance window + // is scheduled to become active. The maintenance window will not run before this + // specified time. + StartDate *string + + // The ID of the created maintenance window. + WindowId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_GetMaintenanceWindowExecution.go b/service/ssm/api_op_GetMaintenanceWindowExecution.go index 6c24cbf48a0..e40635222a5 100644 --- a/service/ssm/api_op_GetMaintenanceWindowExecution.go +++ b/service/ssm/api_op_GetMaintenanceWindowExecution.go @@ -66,23 +66,23 @@ type GetMaintenanceWindowExecutionInput struct { type GetMaintenanceWindowExecutionOutput struct { + // The time the maintenance window finished running. + EndTime *time.Time + // The time the maintenance window started running. StartTime *time.Time + // The status of the maintenance window execution. + Status types.MaintenanceWindowExecutionStatus + // The details explaining the Status. Only available for certain status values. StatusDetails *string - // The ID of the maintenance window execution. - WindowExecutionId *string - // The ID of the task executions from the maintenance window execution. TaskIds []*string - // The time the maintenance window finished running. - EndTime *time.Time - - // The status of the maintenance window execution. - Status types.MaintenanceWindowExecutionStatus + // The ID of the maintenance window execution. + WindowExecutionId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/ssm/api_op_GetMaintenanceWindowExecutionTask.go b/service/ssm/api_op_GetMaintenanceWindowExecutionTask.go index 96a18af931a..5623e08d9d4 100644 --- a/service/ssm/api_op_GetMaintenanceWindowExecutionTask.go +++ b/service/ssm/api_op_GetMaintenanceWindowExecutionTask.go @@ -73,40 +73,37 @@ type GetMaintenanceWindowExecutionTaskInput struct { type GetMaintenanceWindowExecutionTaskOutput struct { + // The time the task execution completed. + EndTime *time.Time + // The defined maximum number of task executions that could be run in parallel. MaxConcurrency *string - // The time the task execution started. - StartTime *time.Time - - // The details explaining the Status. Only available for certain status values. - StatusDetails *string - - // The role that was assumed when running the task. - ServiceRole *string - // The defined maximum number of task execution errors allowed before scheduling of // the task execution would have been stopped. MaxErrors *string - // The type of task that was run. - Type types.MaintenanceWindowTaskType + // The priority of the task. + Priority *int32 - // The ID of the specific task execution in the maintenance window task that was - // retrieved. - TaskExecutionId *string + // The role that was assumed when running the task. + ServiceRole *string + + // The time the task execution started. + StartTime *time.Time // The status of the task. Status types.MaintenanceWindowExecutionStatus - // The ID of the maintenance window execution that includes the task. - WindowExecutionId *string + // The details explaining the Status. Only available for certain status values. + StatusDetails *string - // The time the task execution completed. - EndTime *time.Time + // The ARN of the task that ran. + TaskArn *string - // The priority of the task. - Priority *int32 + // The ID of the specific task execution in the maintenance window task that was + // retrieved. + TaskExecutionId *string // The parameters passed to the task when it was run. TaskParameters has been // deprecated. To specify parameters to pass to a task when it runs, instead use @@ -117,8 +114,11 @@ type GetMaintenanceWindowExecutionTaskOutput struct { // of strings, each string is between 1 and 255 characters TaskParameters []map[string]*types.MaintenanceWindowTaskParameterValueExpression - // The ARN of the task that ran. - TaskArn *string + // The type of task that was run. + Type types.MaintenanceWindowTaskType + + // The ID of the maintenance window execution that includes the task. + WindowExecutionId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/ssm/api_op_GetMaintenanceWindowExecutionTaskInvocation.go b/service/ssm/api_op_GetMaintenanceWindowExecutionTaskInvocation.go index 7c3fea0fae0..280a5b48b63 100644 --- a/service/ssm/api_op_GetMaintenanceWindowExecutionTaskInvocation.go +++ b/service/ssm/api_op_GetMaintenanceWindowExecutionTaskInvocation.go @@ -77,45 +77,45 @@ type GetMaintenanceWindowExecutionTaskInvocationInput struct { type GetMaintenanceWindowExecutionTaskInvocationOutput struct { - // The task execution ID. - TaskExecutionId *string + // The time that the task finished running on the target. + EndTime *time.Time + + // The execution ID. + ExecutionId *string + + // The invocation ID. + InvocationId *string // User-provided value to be included in any CloudWatch events raised while running // tasks for these targets in this maintenance window. OwnerInformation *string - // The task status for an invocation. - Status types.MaintenanceWindowExecutionStatus - - // The maintenance window execution ID. - WindowExecutionId *string - - // The time that the task finished running on the target. - EndTime *time.Time - // The parameters used at the time that the task ran. Parameters *string // The time that the task started running on the target. StartTime *time.Time + // The task status for an invocation. + Status types.MaintenanceWindowExecutionStatus + // The details explaining the status. Details are only available for certain status // values. StatusDetails *string + // The task execution ID. + TaskExecutionId *string + // Retrieves the task type for a maintenance window. Task types include the // following: LAMBDA, STEP_FUNCTIONS, AUTOMATION, RUN_COMMAND. TaskType types.MaintenanceWindowTaskType - // The invocation ID. - InvocationId *string + // The maintenance window execution ID. + WindowExecutionId *string // The maintenance window target ID. WindowTargetId *string - // The execution ID. - ExecutionId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_GetMaintenanceWindowTask.go b/service/ssm/api_op_GetMaintenanceWindowTask.go index b5e162f6938..e4c487aa86d 100644 --- a/service/ssm/api_op_GetMaintenanceWindowTask.go +++ b/service/ssm/api_op_GetMaintenanceWindowTask.go @@ -57,30 +57,21 @@ func (c *Client) GetMaintenanceWindowTask(ctx context.Context, params *GetMainte type GetMaintenanceWindowTaskInput struct { - // The maintenance window task ID to retrieve. + // The maintenance window ID that includes the task to retrieve. // // This member is required. - WindowTaskId *string + WindowId *string - // The maintenance window ID that includes the task to retrieve. + // The maintenance window task ID to retrieve. // // This member is required. - WindowId *string + WindowTaskId *string } type GetMaintenanceWindowTaskOutput struct { - // The retrieved task name. - Name *string - - // The resource that the task used during execution. For RUN_COMMAND and AUTOMATION - // task types, the TaskArn is the Systems Manager Document name/ARN. For LAMBDA - // tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value - // is the state machine ARN. - TaskArn *string - - // The maximum number of errors allowed before the task stops being scheduled. - MaxErrors *string + // The retrieved task description. + Description *string // The location in Amazon S3 where the task results are logged. LoggingInfo has // been deprecated. To specify an S3 bucket to contain logs, instead use the @@ -90,22 +81,34 @@ type GetMaintenanceWindowTaskOutput struct { // MaintenanceWindowTaskInvocationParameters (). LoggingInfo *types.LoggingInfo - // The retrieved maintenance window ID. - WindowId *string + // The maximum number of targets allowed to run this task in parallel. + MaxConcurrency *string - // The targets where the task should run. - Targets []*types.Target + // The maximum number of errors allowed before the task stops being scheduled. + MaxErrors *string - // The ARN of the IAM service role to use to publish Amazon Simple Notification - // Service (Amazon SNS) notifications for maintenance window Run Command tasks. - ServiceRoleArn *string + // The retrieved task name. + Name *string // The priority of the task when it runs. The lower the number, the higher the // priority. Tasks that have the same priority are scheduled in parallel. Priority *int32 - // The type of task to run. - TaskType types.MaintenanceWindowTaskType + // The ARN of the IAM service role to use to publish Amazon Simple Notification + // Service (Amazon SNS) notifications for maintenance window Run Command tasks. + ServiceRoleArn *string + + // The targets where the task should run. + Targets []*types.Target + + // The resource that the task used during execution. For RUN_COMMAND and AUTOMATION + // task types, the TaskArn is the Systems Manager Document name/ARN. For LAMBDA + // tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value + // is the state machine ARN. + TaskArn *string + + // The parameters to pass to the task when it runs. + TaskInvocationParameters *types.MaintenanceWindowTaskInvocationParameters // The parameters to pass to the task when it runs. TaskParameters has been // deprecated. To specify parameters to pass to a task when it runs, instead use @@ -114,18 +117,15 @@ type GetMaintenanceWindowTaskOutput struct { // window task types, see MaintenanceWindowTaskInvocationParameters (). TaskParameters map[string]*types.MaintenanceWindowTaskParameterValueExpression - // The parameters to pass to the task when it runs. - TaskInvocationParameters *types.MaintenanceWindowTaskInvocationParameters + // The type of task to run. + TaskType types.MaintenanceWindowTaskType - // The retrieved task description. - Description *string + // The retrieved maintenance window ID. + WindowId *string // The retrieved maintenance window task ID. WindowTaskId *string - // The maximum number of targets allowed to run this task in parallel. - MaxConcurrency *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_GetOpsSummary.go b/service/ssm/api_op_GetOpsSummary.go index c6022e729d3..76994450cb2 100644 --- a/service/ssm/api_op_GetOpsSummary.go +++ b/service/ssm/api_op_GetOpsSummary.go @@ -57,10 +57,6 @@ func (c *Client) GetOpsSummary(ctx context.Context, params *GetOpsSummaryInput, type GetOpsSummaryInput struct { - // The maximum number of items to return for this call. The call also returns a - // token that you can specify in a subsequent call to get the next set of results. - MaxResults *int32 - // Optional aggregators that return counts of OpsItems based on one or more // expressions. Aggregators []*types.OpsAggregator @@ -68,14 +64,18 @@ type GetOpsSummaryInput struct { // Optional filters used to scope down the returned OpsItems. Filters []*types.OpsFilter + // The maximum number of items to return for this call. The call also returns a + // token that you can specify in a subsequent call to get the next set of results. + MaxResults *int32 + // A token to start the list. Use this token to get the next set of results. NextToken *string - // Specify the name of a resource data sync to get. - SyncName *string - // The OpsItem data type to return. ResultAttributes []*types.OpsResultAttribute + + // Specify the name of a resource data sync to get. + SyncName *string } type GetOpsSummaryOutput struct { diff --git a/service/ssm/api_op_GetParameter.go b/service/ssm/api_op_GetParameter.go index 8d254c963de..7e3aabbb98e 100644 --- a/service/ssm/api_op_GetParameter.go +++ b/service/ssm/api_op_GetParameter.go @@ -58,14 +58,14 @@ func (c *Client) GetParameter(ctx context.Context, params *GetParameterInput, op type GetParameterInput struct { - // Return decrypted values for secure string parameters. This flag is ignored for - // String and StringList parameter types. - WithDecryption *bool - // The name of the parameter you want to query. // // This member is required. Name *string + + // Return decrypted values for secure string parameters. This flag is ignored for + // String and StringList parameter types. + WithDecryption *bool } type GetParameterOutput struct { diff --git a/service/ssm/api_op_GetParameterHistory.go b/service/ssm/api_op_GetParameterHistory.go index 02ce51a45c8..3e16bdc7a16 100644 --- a/service/ssm/api_op_GetParameterHistory.go +++ b/service/ssm/api_op_GetParameterHistory.go @@ -62,6 +62,10 @@ type GetParameterHistoryInput struct { // This member is required. Name *string + // The maximum number of items to return for this call. The call also returns a + // token that you can specify in a subsequent call to get the next set of results. + MaxResults *int32 + // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string @@ -69,21 +73,17 @@ type GetParameterHistoryInput struct { // Return decrypted values for secure string parameters. This flag is ignored for // String and StringList parameter types. WithDecryption *bool - - // The maximum number of items to return for this call. The call also returns a - // token that you can specify in a subsequent call to get the next set of results. - MaxResults *int32 } type GetParameterHistoryOutput struct { - // A list of parameters returned by the request. - Parameters []*types.ParameterHistory - // The token to use when requesting the next set of items. If there are no // additional items to return, the string is empty. NextToken *string + // A list of parameters returned by the request. + Parameters []*types.ParameterHistory + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_GetParameters.go b/service/ssm/api_op_GetParameters.go index f9622e8258f..c0386dcb4c7 100644 --- a/service/ssm/api_op_GetParameters.go +++ b/service/ssm/api_op_GetParameters.go @@ -58,14 +58,14 @@ func (c *Client) GetParameters(ctx context.Context, params *GetParametersInput, type GetParametersInput struct { - // Return decrypted secure string value. Return decrypted values for secure string - // parameters. This flag is ignored for String and StringList parameter types. - WithDecryption *bool - // Names of the parameters for which you want to query information. // // This member is required. Names []*string + + // Return decrypted secure string value. Return decrypted values for secure string + // parameters. This flag is ignored for String and StringList parameter types. + WithDecryption *bool } type GetParametersOutput struct { diff --git a/service/ssm/api_op_GetParametersByPath.go b/service/ssm/api_op_GetParametersByPath.go index d9e0b6e5b28..a61399c4bb1 100644 --- a/service/ssm/api_op_GetParametersByPath.go +++ b/service/ssm/api_op_GetParametersByPath.go @@ -64,16 +64,6 @@ func (c *Client) GetParametersByPath(ctx context.Context, params *GetParametersB type GetParametersByPathInput struct { - // A token to start the list. Use this token to get the next set of results. - NextToken *string - - // Retrieve all parameters within a hierarchy. If a user has access to a path, then - // the user can access all levels of that path. For example, if a user has - // permission to access path /a, then the user can also access /a/b. Even if a user - // has explicitly been denied access in IAM for parameter /a/b, they can still call - // the GetParametersByPath API action recursively for /a and view /a/b. - Recursive *bool - // The hierarchy for the parameter. Hierarchies start with a forward slash (/) and // end with the parameter name. A parameter name hierarchy can have a maximum of 15 // levels. Here is an example of a hierarchy: @@ -82,13 +72,23 @@ type GetParametersByPathInput struct { // This member is required. Path *string - // Filters to limit the request results. - ParameterFilters []*types.ParameterStringFilter - // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 + // A token to start the list. Use this token to get the next set of results. + NextToken *string + + // Filters to limit the request results. + ParameterFilters []*types.ParameterStringFilter + + // Retrieve all parameters within a hierarchy. If a user has access to a path, then + // the user can access all levels of that path. For example, if a user has + // permission to access path /a, then the user can also access /a/b. Even if a user + // has explicitly been denied access in IAM for parameter /a/b, they can still call + // the GetParametersByPath API action recursively for /a and view /a/b. + Recursive *bool + // Retrieve all parameters in a hierarchy with their value decrypted. WithDecryption *bool } diff --git a/service/ssm/api_op_GetPatchBaseline.go b/service/ssm/api_op_GetPatchBaseline.go index 67e7e46a30b..b2ea8aca59d 100644 --- a/service/ssm/api_op_GetPatchBaseline.go +++ b/service/ssm/api_op_GetPatchBaseline.go @@ -66,36 +66,35 @@ type GetPatchBaselineInput struct { type GetPatchBaselineOutput struct { - // A set of global filters used to exclude patches from the baseline. - GlobalFilters *types.PatchFilterGroup + // A set of rules used to include patches in the baseline. + ApprovalRules *types.PatchRuleGroup + + // A list of explicitly approved patches for the baseline. + ApprovedPatches []*string // Returns the specified compliance severity level for approved patches in the // patch baseline. ApprovedPatchesComplianceLevel types.PatchComplianceLevel - // The date the patch baseline was last modified. - ModifiedDate *time.Time - - // Patch groups included in the patch baseline. - PatchGroups []*string + // Indicates whether the list of approved patches includes non-security updates + // that should be applied to the instances. The default value is 'false'. Applies + // to Linux instances only. + ApprovedPatchesEnableNonSecurity *bool - // A list of explicitly approved patches for the baseline. - ApprovedPatches []*string + // The ID of the retrieved patch baseline. + BaselineId *string - // The action specified to take on patches included in the RejectedPatches list. A - // patch can be allowed only if it is a dependency of another package, or blocked - // entirely along with packages that include it as a dependency. - RejectedPatchesAction types.PatchAction + // The date the patch baseline was created. + CreatedDate *time.Time - // A set of rules used to include patches in the baseline. - ApprovalRules *types.PatchRuleGroup + // A description of the patch baseline. + Description *string - // Information about the patches to use to update the instances, including target - // operating systems and source repositories. Applies to Linux instances only. - Sources []*types.PatchSource + // A set of global filters used to exclude patches from the baseline. + GlobalFilters *types.PatchFilterGroup - // A list of explicitly rejected patches for the baseline. - RejectedPatches []*string + // The date the patch baseline was last modified. + ModifiedDate *time.Time // The name of the patch baseline. Name *string @@ -103,19 +102,20 @@ type GetPatchBaselineOutput struct { // Returns the operating system specified for the patch baseline. OperatingSystem types.OperatingSystem - // The ID of the retrieved patch baseline. - BaselineId *string + // Patch groups included in the patch baseline. + PatchGroups []*string - // The date the patch baseline was created. - CreatedDate *time.Time + // A list of explicitly rejected patches for the baseline. + RejectedPatches []*string - // A description of the patch baseline. - Description *string + // The action specified to take on patches included in the RejectedPatches list. A + // patch can be allowed only if it is a dependency of another package, or blocked + // entirely along with packages that include it as a dependency. + RejectedPatchesAction types.PatchAction - // Indicates whether the list of approved patches includes non-security updates - // that should be applied to the instances. The default value is 'false'. Applies - // to Linux instances only. - ApprovedPatchesEnableNonSecurity *bool + // Information about the patches to use to update the instances, including target + // operating systems and source repositories. Applies to Linux instances only. + Sources []*types.PatchSource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/ssm/api_op_GetPatchBaselineForPatchGroup.go b/service/ssm/api_op_GetPatchBaselineForPatchGroup.go index 0ca8e585a9b..243ad5982e2 100644 --- a/service/ssm/api_op_GetPatchBaselineForPatchGroup.go +++ b/service/ssm/api_op_GetPatchBaselineForPatchGroup.go @@ -69,15 +69,15 @@ type GetPatchBaselineForPatchGroupInput struct { type GetPatchBaselineForPatchGroupOutput struct { - // The name of the patch group. - PatchGroup *string - // The ID of the patch baseline that should be used for the patch group. BaselineId *string // The operating system rule specified for patch groups using the patch baseline. OperatingSystem types.OperatingSystem + // The name of the patch group. + PatchGroup *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_LabelParameterVersion.go b/service/ssm/api_op_LabelParameterVersion.go index ca1ffbb5486..55aa01b0a2e 100644 --- a/service/ssm/api_op_LabelParameterVersion.go +++ b/service/ssm/api_op_LabelParameterVersion.go @@ -89,11 +89,6 @@ func (c *Client) LabelParameterVersion(ctx context.Context, params *LabelParamet type LabelParameterVersionInput struct { - // The specific version of the parameter on which you want to attach one or more - // labels. If no version is specified, the system attaches the label to the latest - // version. - ParameterVersion *int64 - // One or more labels to attach to the specified parameter version. // // This member is required. @@ -103,19 +98,24 @@ type LabelParameterVersionInput struct { // // This member is required. Name *string + + // The specific version of the parameter on which you want to attach one or more + // labels. If no version is specified, the system attaches the label to the latest + // version. + ParameterVersion *int64 } type LabelParameterVersionOutput struct { - // The version of the parameter that has been labeled. - ParameterVersion *int64 - // The label does not meet the requirements. For information about parameter label // requirements, see Labeling parameters // (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html) // in the AWS Systems Manager User Guide. InvalidLabels []*string + // The version of the parameter that has been labeled. + ParameterVersion *int64 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_ListAssociationVersions.go b/service/ssm/api_op_ListAssociationVersions.go index b37f425b3ed..71dddeb35ca 100644 --- a/service/ssm/api_op_ListAssociationVersions.go +++ b/service/ssm/api_op_ListAssociationVersions.go @@ -62,12 +62,12 @@ type ListAssociationVersionsInput struct { // This member is required. AssociationId *string - // A token to start the list. Use this token to get the next set of results. - NextToken *string - // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 + + // A token to start the list. Use this token to get the next set of results. + NextToken *string } type ListAssociationVersionsOutput struct { diff --git a/service/ssm/api_op_ListAssociations.go b/service/ssm/api_op_ListAssociations.go index 3949a12aaa9..3b08d57485b 100644 --- a/service/ssm/api_op_ListAssociations.go +++ b/service/ssm/api_op_ListAssociations.go @@ -62,24 +62,24 @@ type ListAssociationsInput struct { // One or more filters. Use a filter to return a more specific list of results. AssociationFilterList []*types.AssociationFilter - // The token for the next set of items to return. (You received this token from a - // previous call.) - NextToken *string - // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 + + // The token for the next set of items to return. (You received this token from a + // previous call.) + NextToken *string } type ListAssociationsOutput struct { + // The associations. + Associations []*types.Association + // The token to use when requesting the next set of items. If there are no // additional items to return, the string is empty. NextToken *string - // The associations. - Associations []*types.Association - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_ListCommandInvocations.go b/service/ssm/api_op_ListCommandInvocations.go index 62e4a69c330..183e53e151d 100644 --- a/service/ssm/api_op_ListCommandInvocations.go +++ b/service/ssm/api_op_ListCommandInvocations.go @@ -61,12 +61,19 @@ func (c *Client) ListCommandInvocations(ctx context.Context, params *ListCommand type ListCommandInvocationsInput struct { + // (Optional) The invocations for a specific command ID. + CommandId *string + // (Optional) If set this returns the response of the command executions and any // command output. By default this is set to False. Details *bool - // (Optional) The invocations for a specific command ID. - CommandId *string + // (Optional) One or more filters. Use a filter to return a more specific list of + // results. + Filters []*types.CommandFilter + + // (Optional) The command execution details for a specific instance ID. + InstanceId *string // (Optional) The maximum number of items to return for this call. The call also // returns a token that you can specify in a subsequent call to get the next set of @@ -76,24 +83,17 @@ type ListCommandInvocationsInput struct { // (Optional) The token for the next set of items to return. (You received this // token from a previous call.) NextToken *string - - // (Optional) One or more filters. Use a filter to return a more specific list of - // results. - Filters []*types.CommandFilter - - // (Optional) The command execution details for a specific instance ID. - InstanceId *string } type ListCommandInvocationsOutput struct { + // (Optional) A list of all invocations. + CommandInvocations []*types.CommandInvocation + // (Optional) The token for the next set of items to return. (You received this // token from a previous call.) NextToken *string - // (Optional) A list of all invocations. - CommandInvocations []*types.CommandInvocation - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_ListCommands.go b/service/ssm/api_op_ListCommands.go index 487cc151675..3439392d241 100644 --- a/service/ssm/api_op_ListCommands.go +++ b/service/ssm/api_op_ListCommands.go @@ -57,37 +57,37 @@ func (c *Client) ListCommands(ctx context.Context, params *ListCommandsInput, op type ListCommandsInput struct { - // (Optional) The maximum number of items to return for this call. The call also - // returns a token that you can specify in a subsequent call to get the next set of + // (Optional) If provided, lists only the specified command. + CommandId *string + + // (Optional) One or more filters. Use a filter to return a more specific list of // results. - MaxResults *int32 + Filters []*types.CommandFilter // (Optional) Lists commands issued against this instance ID. You can't specify an // instance ID in the same command that you specify Status = Pending. This is // because the command has not reached the instance yet. InstanceId *string - // (Optional) If provided, lists only the specified command. - CommandId *string + // (Optional) The maximum number of items to return for this call. The call also + // returns a token that you can specify in a subsequent call to get the next set of + // results. + MaxResults *int32 // (Optional) The token for the next set of items to return. (You received this // token from a previous call.) NextToken *string - - // (Optional) One or more filters. Use a filter to return a more specific list of - // results. - Filters []*types.CommandFilter } type ListCommandsOutput struct { + // (Optional) The list of commands requested by the user. + Commands []*types.Command + // (Optional) The token for the next set of items to return. (You received this // token from a previous call.) NextToken *string - // (Optional) The list of commands requested by the user. - Commands []*types.Command - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_ListComplianceItems.go b/service/ssm/api_op_ListComplianceItems.go index 0470e892ce9..72cad7d11b8 100644 --- a/service/ssm/api_op_ListComplianceItems.go +++ b/service/ssm/api_op_ListComplianceItems.go @@ -59,24 +59,24 @@ func (c *Client) ListComplianceItems(ctx context.Context, params *ListCompliance type ListComplianceItemsInput struct { + // One or more compliance filters. Use a filter to return a more specific list of + // results. + Filters []*types.ComplianceStringFilter + // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 + // A token to start the list. Use this token to get the next set of results. + NextToken *string + // The ID for the resources from which to get compliance information. Currently, // you can only specify one resource ID. ResourceIds []*string - // A token to start the list. Use this token to get the next set of results. - NextToken *string - // The type of resource from which to get compliance information. Currently, the // only supported resource type is ManagedInstance. ResourceTypes []*string - - // One or more compliance filters. Use a filter to return a more specific list of - // results. - Filters []*types.ComplianceStringFilter } type ListComplianceItemsOutput struct { diff --git a/service/ssm/api_op_ListComplianceSummaries.go b/service/ssm/api_op_ListComplianceSummaries.go index beb0ca089a3..0aa1f940ce7 100644 --- a/service/ssm/api_op_ListComplianceSummaries.go +++ b/service/ssm/api_op_ListComplianceSummaries.go @@ -59,6 +59,10 @@ func (c *Client) ListComplianceSummaries(ctx context.Context, params *ListCompli type ListComplianceSummariesInput struct { + // One or more compliance or inventory filters. Use a filter to return a more + // specific list of results. + Filters []*types.ComplianceStringFilter + // The maximum number of items to return for this call. Currently, you can specify // null or 50. The call also returns a token that you can specify in a subsequent // call to get the next set of results. @@ -66,10 +70,6 @@ type ListComplianceSummariesInput struct { // A token to start the list. Use this token to get the next set of results. NextToken *string - - // One or more compliance or inventory filters. Use a filter to return a more - // specific list of results. - Filters []*types.ComplianceStringFilter } type ListComplianceSummariesOutput struct { diff --git a/service/ssm/api_op_ListDocumentVersions.go b/service/ssm/api_op_ListDocumentVersions.go index 9b997123674..9d692c62eda 100644 --- a/service/ssm/api_op_ListDocumentVersions.go +++ b/service/ssm/api_op_ListDocumentVersions.go @@ -57,15 +57,15 @@ func (c *Client) ListDocumentVersions(ctx context.Context, params *ListDocumentV type ListDocumentVersionsInput struct { - // The maximum number of items to return for this call. The call also returns a - // token that you can specify in a subsequent call to get the next set of results. - MaxResults *int32 - // The name of the document. You can specify an Amazon Resource Name (ARN). // // This member is required. Name *string + // The maximum number of items to return for this call. The call also returns a + // token that you can specify in a subsequent call to get the next set of results. + MaxResults *int32 + // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string @@ -73,13 +73,13 @@ type ListDocumentVersionsInput struct { type ListDocumentVersionsOutput struct { + // The document versions. + DocumentVersions []*types.DocumentVersionInfo + // The token to use when requesting the next set of items. If there are no // additional items to return, the string is empty. NextToken *string - // The document versions. - DocumentVersions []*types.DocumentVersionInfo - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_ListDocuments.go b/service/ssm/api_op_ListDocuments.go index 66ee1918ce9..93208d77241 100644 --- a/service/ssm/api_op_ListDocuments.go +++ b/service/ssm/api_op_ListDocuments.go @@ -61,10 +61,6 @@ type ListDocumentsInput struct { // This data type is deprecated. Instead, use Filters. DocumentFilterList []*types.DocumentFilter - // The token for the next set of items to return. (You received this token from a - // previous call.) - NextToken *string - // One or more DocumentKeyValuesFilter objects. Use a filter to return a more // specific list of results. For keys, you can specify one or more key-value pair // tags that have been applied to a document. Other valid keys include Owner, Name, @@ -76,6 +72,10 @@ type ListDocumentsInput struct { // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 + + // The token for the next set of items to return. (You received this token from a + // previous call.) + NextToken *string } type ListDocumentsOutput struct { diff --git a/service/ssm/api_op_ListInventoryEntries.go b/service/ssm/api_op_ListInventoryEntries.go index 8fc5e66165d..4e87a734503 100644 --- a/service/ssm/api_op_ListInventoryEntries.go +++ b/service/ssm/api_op_ListInventoryEntries.go @@ -57,9 +57,15 @@ func (c *Client) ListInventoryEntries(ctx context.Context, params *ListInventory type ListInventoryEntriesInput struct { - // The token for the next set of items to return. (You received this token from a - // previous call.) - NextToken *string + // The instance ID for which you want inventory information. + // + // This member is required. + InstanceId *string + + // The type of inventory item for which you want information. + // + // This member is required. + TypeName *string // One or more filters. Use a filter to return a more specific list of results. Filters []*types.InventoryFilter @@ -68,38 +74,32 @@ type ListInventoryEntriesInput struct { // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 - // The type of inventory item for which you want information. - // - // This member is required. - TypeName *string - - // The instance ID for which you want inventory information. - // - // This member is required. - InstanceId *string + // The token for the next set of items to return. (You received this token from a + // previous call.) + NextToken *string } type ListInventoryEntriesOutput struct { - // The token to use when requesting the next set of items. If there are no - // additional items to return, the string is empty. - NextToken *string + // The time that inventory information was collected for the instance(s). + CaptureTime *string // A list of inventory items on the instance(s). Entries []map[string]*string + // The instance ID targeted by the request to query inventory information. + InstanceId *string + + // The token to use when requesting the next set of items. If there are no + // additional items to return, the string is empty. + NextToken *string + // The inventory schema version used by the instance(s). SchemaVersion *string // The type of inventory item returned by the request. TypeName *string - // The time that inventory information was collected for the instance(s). - CaptureTime *string - - // The instance ID targeted by the request to query inventory information. - InstanceId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_ListResourceComplianceSummaries.go b/service/ssm/api_op_ListResourceComplianceSummaries.go index d2f6c32cdf8..61c911825ec 100644 --- a/service/ssm/api_op_ListResourceComplianceSummaries.go +++ b/service/ssm/api_op_ListResourceComplianceSummaries.go @@ -58,15 +58,15 @@ func (c *Client) ListResourceComplianceSummaries(ctx context.Context, params *Li type ListResourceComplianceSummariesInput struct { - // A token to start the list. Use this token to get the next set of results. - NextToken *string - // One or more filters. Use a filter to return a more specific list of results. Filters []*types.ComplianceStringFilter // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 + + // A token to start the list. Use this token to get the next set of results. + NextToken *string } type ListResourceComplianceSummariesOutput struct { diff --git a/service/ssm/api_op_ListResourceDataSync.go b/service/ssm/api_op_ListResourceDataSync.go index 47a0a4c150c..c14fac1791e 100644 --- a/service/ssm/api_op_ListResourceDataSync.go +++ b/service/ssm/api_op_ListResourceDataSync.go @@ -68,14 +68,14 @@ type ListResourceDataSyncInput struct { // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 + // A token to start the list. Use this token to get the next set of results. + NextToken *string + // View a list of resource data syncs according to the sync type. Specify // SyncToDestination to view resource data syncs that synchronize data to an Amazon // S3 buckets. Specify SyncFromSource to view resource data syncs from AWS // Organizations or from multiple AWS Regions. SyncType *string - - // A token to start the list. Use this token to get the next set of results. - NextToken *string } type ListResourceDataSyncOutput struct { diff --git a/service/ssm/api_op_ListTagsForResource.go b/service/ssm/api_op_ListTagsForResource.go index 320aef89b59..507eb5d3ef1 100644 --- a/service/ssm/api_op_ListTagsForResource.go +++ b/service/ssm/api_op_ListTagsForResource.go @@ -57,15 +57,15 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // Returns a list of tags for a specific resource type. + // The resource ID for which you want to see a list of tags. // // This member is required. - ResourceType types.ResourceTypeForTagging + ResourceId *string - // The resource ID for which you want to see a list of tags. + // Returns a list of tags for a specific resource type. // // This member is required. - ResourceId *string + ResourceType types.ResourceTypeForTagging } type ListTagsForResourceOutput struct { diff --git a/service/ssm/api_op_ModifyDocumentPermission.go b/service/ssm/api_op_ModifyDocumentPermission.go index a49e20da4b1..6eff3699641 100644 --- a/service/ssm/api_op_ModifyDocumentPermission.go +++ b/service/ssm/api_op_ModifyDocumentPermission.go @@ -60,15 +60,15 @@ func (c *Client) ModifyDocumentPermission(ctx context.Context, params *ModifyDoc type ModifyDocumentPermissionInput struct { - // The permission type for the document. The permission type can be Share. + // The name of the document that you want to share. // // This member is required. - PermissionType types.DocumentPermissionType + Name *string - // The name of the document that you want to share. + // The permission type for the document. The permission type can be Share. // // This member is required. - Name *string + PermissionType types.DocumentPermissionType // The AWS user accounts that should have access to the document. The account IDs // can either be a group of account IDs or All. diff --git a/service/ssm/api_op_PutComplianceItems.go b/service/ssm/api_op_PutComplianceItems.go index 05ef1d4457d..66d1a1b7f00 100644 --- a/service/ssm/api_op_PutComplianceItems.go +++ b/service/ssm/api_op_PutComplianceItems.go @@ -106,16 +106,11 @@ func (c *Client) PutComplianceItems(ctx context.Context, params *PutComplianceIt type PutComplianceItemsInput struct { - // Specify an ID for this resource. For a managed instance, this is the instance - // ID. + // Specify the compliance type. For example, specify Association (for a State + // Manager association), Patch, or Custom:string. // // This member is required. - ResourceId *string - - // MD5 or SHA-256 content hash. The content hash is used to determine if existing - // information should be overwritten or ignored. If the content hashes match, the - // request to put compliance information is ignored. - ItemContentHash *string + ComplianceType *string // A summary of the call execution that includes an execution ID, the type of // execution (for example, Command), and the date/time of the execution using a @@ -124,15 +119,6 @@ type PutComplianceItemsInput struct { // This member is required. ExecutionSummary *types.ComplianceExecutionSummary - // The mode for uploading compliance items. You can specify COMPLETE or PARTIAL. In - // COMPLETE mode, the system overwrites all existing compliance information for the - // resource. You must provide a full list of compliance items each time you send - // the request. In PARTIAL mode, the system overwrites compliance information for a - // specific association. The association must be configured with SyncCompliance set - // to MANUAL. By default, all requests use COMPLETE mode. This attribute is only - // valid for association compliance. - UploadType types.ComplianceUploadType - // Information about the compliance as defined by the resource type. For example, // for a patch compliance type, Items includes information about the PatchSeverity, // Classification, and so on. @@ -140,17 +126,31 @@ type PutComplianceItemsInput struct { // This member is required. Items []*types.ComplianceItemEntry - // Specify the compliance type. For example, specify Association (for a State - // Manager association), Patch, or Custom:string. + // Specify an ID for this resource. For a managed instance, this is the instance + // ID. // // This member is required. - ComplianceType *string + ResourceId *string // Specify the type of resource. ManagedInstance is currently the only supported // resource type. // // This member is required. ResourceType *string + + // MD5 or SHA-256 content hash. The content hash is used to determine if existing + // information should be overwritten or ignored. If the content hashes match, the + // request to put compliance information is ignored. + ItemContentHash *string + + // The mode for uploading compliance items. You can specify COMPLETE or PARTIAL. In + // COMPLETE mode, the system overwrites all existing compliance information for the + // resource. You must provide a full list of compliance items each time you send + // the request. In PARTIAL mode, the system overwrites compliance information for a + // specific association. The association must be configured with SyncCompliance set + // to MANUAL. By default, all requests use COMPLETE mode. This attribute is only + // valid for association compliance. + UploadType types.ComplianceUploadType } type PutComplianceItemsOutput struct { diff --git a/service/ssm/api_op_PutInventory.go b/service/ssm/api_op_PutInventory.go index d23ff2098e0..8800e1446fa 100644 --- a/service/ssm/api_op_PutInventory.go +++ b/service/ssm/api_op_PutInventory.go @@ -59,15 +59,15 @@ func (c *Client) PutInventory(ctx context.Context, params *PutInventoryInput, op type PutInventoryInput struct { - // The inventory items that you want to add or update on instances. + // An instance ID where you want to add or update inventory items. // // This member is required. - Items []*types.InventoryItem + InstanceId *string - // An instance ID where you want to add or update inventory items. + // The inventory items that you want to add or update on instances. // // This member is required. - InstanceId *string + Items []*types.InventoryItem } type PutInventoryOutput struct { diff --git a/service/ssm/api_op_PutParameter.go b/service/ssm/api_op_PutParameter.go index d113be81e6f..8a91b43ba3b 100644 --- a/service/ssm/api_op_PutParameter.go +++ b/service/ssm/api_op_PutParameter.go @@ -57,91 +57,6 @@ func (c *Client) PutParameter(ctx context.Context, params *PutParameterInput, op type PutParameterInput struct { - // The type of parameter that you want to add to the system. SecureString is not - // currently supported for AWS CloudFormation templates or in the China Regions. - // Items in a StringList must be separated by a comma (,). You can't use other - // punctuation or special character to escape items in the list. If you have a - // parameter value that requires a comma, then use the String data type. Specifying - // a parameter type is not required when updating a parameter. You must specify a - // parameter type when creating a parameter. - Type types.ParameterType - - // Optional metadata that you assign to a resource. Tags enable you to categorize a - // resource in different ways, such as by purpose, owner, or environment. For - // example, you might want to tag a Systems Manager parameter to identify the type - // of resource to which it applies, the environment, or the type of configuration - // data referenced by the parameter. In this case, you could specify the following - // key name/value pairs:

    • Key=Resource,Value=S3bucket - //

    • Key=OS,Value=Windows

    • - // Key=ParameterType,Value=LicenseKey

    To - // add tags to an existing Systems Manager parameter, use the - // AddTagsToResource action.

     - Tags []*types.Tag - - // One or more policies to apply to a parameter. This action takes a JSON array. - // Parameter Store supports the following policy types:

    Expiration: This policy - // deletes the parameter after it expires. When you create the policy, you specify - // the expiration date. You can update the expiration date and time by updating the - // policy. Updating the parameter does not affect the expiration date and time. - // When the expiration time is reached, Parameter Store deletes the parameter. - // ExpirationNotification: This policy triggers an event in Amazon CloudWatch - // Events that notifies you about the expiration. By using this policy, you can - // receive notification before or after the expiration time is reached, in units of - // days or hours. NoChangeNotification: This policy triggers a CloudWatch event if - // a parameter has not been modified for a specified period of time. This policy - // type is useful when, for example, a secret needs to be changed within a period - // of time, but it has not been changed.

    All existing policies are preserved - // until you send new policies or an empty policy. For more information about - // parameter policies, see Assigning parameter policies - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html). - Policies *string - - // Overwrite an existing parameter. If not specified, will default to "false". - Overwrite *bool - - // A regular expression used to validate the parameter value. For example, for - // String types with values restricted to numbers, you can specify the following: - // AllowedPattern=^\d+$ - AllowedPattern *string - - // The parameter value that you want to add to the system. Standard parameters have - // a value limit of 4 KB. Advanced parameters have a value limit of 8 KB. - // - // This member is required. - Value *string - - // The KMS Key ID that you want to use to encrypt a parameter. Either the default - // AWS Key Management Service (AWS KMS) key automatically assigned to your AWS - // account or a custom key. Required for parameters that use the SecureString data - // type. If you don't specify a key ID, the system uses the default key associated - // with your AWS account. - // - // * To use your default AWS KMS key, choose the - // SecureString data type, and do not specify the Key ID when you create the - // parameter. The system automatically populates Key ID with your default KMS - // key. - // - // * To use a custom KMS key, choose the SecureString data type with the - // Key ID parameter. - KeyId *string - - // The data type for a String parameter. Supported data types include plain text - // and Amazon Machine Image IDs. The following data type values are supported. - // - // - // * text - // - // * aws:ec2:image - // - // When you create a String parameter and specify - // aws:ec2:image, Systems Manager validates the parameter value is in the required - // format, such as ami-12345abcdeEXAMPLE, and that the specified AMI is available - // in your AWS account. For more information, see Native parameter support for - // Amazon Machine Image IDs - // (http://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html) - // in the AWS Systems Manager User Guide. - DataType *string - // The fully qualified name of the parameter that you want to add to the system. // The fully qualified name includes the complete hierarchy of the parameter path // and name. For parameters in a hierarchy, you must include a leading forward @@ -179,6 +94,86 @@ type PutParameterInput struct { // This member is required. Name *string + // The parameter value that you want to add to the system. Standard parameters have + // a value limit of 4 KB. Advanced parameters have a value limit of 8 KB. + // + // This member is required. + Value *string + + // A regular expression used to validate the parameter value. For example, for + // String types with values restricted to numbers, you can specify the following: + // AllowedPattern=^\d+$ + AllowedPattern *string + + // The data type for a String parameter. Supported data types include plain text + // and Amazon Machine Image IDs. The following data type values are supported. + // + // + // * text + // + // * aws:ec2:image + // + // When you create a String parameter and specify + // aws:ec2:image, Systems Manager validates the parameter value is in the required + // format, such as ami-12345abcdeEXAMPLE, and that the specified AMI is available + // in your AWS account. For more information, see Native parameter support for + // Amazon Machine Image IDs + // (http://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html) + // in the AWS Systems Manager User Guide. + DataType *string + + // Information about the parameter that you want to add to the system. Optional but + // recommended. Do not enter personally identifiable information in this field. + Description *string + + // The KMS Key ID that you want to use to encrypt a parameter. Either the default + // AWS Key Management Service (AWS KMS) key automatically assigned to your AWS + // account or a custom key. Required for parameters that use the SecureString data + // type. If you don't specify a key ID, the system uses the default key associated + // with your AWS account. + // + // * To use your default AWS KMS key, choose the + // SecureString data type, and do not specify the Key ID when you create the + // parameter. The system automatically populates Key ID with your default KMS + // key. + // + // * To use a custom KMS key, choose the SecureString data type with the + // Key ID parameter. + KeyId *string + + // Overwrite an existing parameter. If not specified, will default to "false". + Overwrite *bool + + // One or more policies to apply to a parameter. This action takes a JSON array. + // Parameter Store supports the following policy types:

    Expiration: This policy + // deletes the parameter after it expires. When you create the policy, you specify + // the expiration date. You can update the expiration date and time by updating the + // policy. Updating the parameter does not affect the expiration date and time. + // When the expiration time is reached, Parameter Store deletes the parameter. + // ExpirationNotification: This policy triggers an event in Amazon CloudWatch + // Events that notifies you about the expiration. By using this policy, you can + // receive notification before or after the expiration time is reached, in units of + // days or hours. NoChangeNotification: This policy triggers a CloudWatch event if + // a parameter has not been modified for a specified period of time. This policy + // type is useful when, for example, a secret needs to be changed within a period + // of time, but it has not been changed.

    All existing policies are preserved + // until you send new policies or an empty policy. For more information about + // parameter policies, see Assigning parameter policies + // (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html). + Policies *string + + // Optional metadata that you assign to a resource. Tags enable you to categorize a + // resource in different ways, such as by purpose, owner, or environment. For + // example, you might want to tag a Systems Manager parameter to identify the type + // of resource to which it applies, the environment, or the type of configuration + // data referenced by the parameter. In this case, you could specify the following + // key name/value pairs:

    • Key=Resource,Value=S3bucket + //

    • Key=OS,Value=Windows

    • + // Key=ParameterType,Value=LicenseKey

    To + // add tags to an existing Systems Manager parameter, use the + // AddTagsToResource action.

     + Tags []*types.Tag + // The parameter tier to assign to a parameter. Parameter Store offers a standard // tier and an advanced tier for parameters. Standard parameters have a content // size limit of 4 KB and can't be configured to use parameter policies. You can @@ -237,9 +232,14 @@ type PutParameterInput struct { // in the AWS Systems Manager User Guide. Tier types.ParameterTier - // Information about the parameter that you want to add to the system. Optional but - // recommended. Do not enter personally identifiable information in this field. - Description *string + // The type of parameter that you want to add to the system. SecureString is not + // currently supported for AWS CloudFormation templates or in the China Regions. + // Items in a StringList must be separated by a comma (,). You can't use other + // punctuation or special character to escape items in the list. If you have a + // parameter value that requires a comma, then use the String data type. Specifying + // a parameter type is not required when updating a parameter. You must specify a + // parameter type when creating a parameter. + Type types.ParameterType } type PutParameterOutput struct { diff --git a/service/ssm/api_op_RegisterPatchBaselineForPatchGroup.go b/service/ssm/api_op_RegisterPatchBaselineForPatchGroup.go index c81506aa93c..34ba831dead 100644 --- a/service/ssm/api_op_RegisterPatchBaselineForPatchGroup.go +++ b/service/ssm/api_op_RegisterPatchBaselineForPatchGroup.go @@ -56,15 +56,15 @@ func (c *Client) RegisterPatchBaselineForPatchGroup(ctx context.Context, params type RegisterPatchBaselineForPatchGroupInput struct { - // The name of the patch group that should be registered with the patch baseline. + // The ID of the patch baseline to register the patch group with. // // This member is required. - PatchGroup *string + BaselineId *string - // The ID of the patch baseline to register the patch group with. + // The name of the patch group that should be registered with the patch baseline. // // This member is required. - BaselineId *string + PatchGroup *string } type RegisterPatchBaselineForPatchGroupOutput struct { diff --git a/service/ssm/api_op_RegisterTargetWithMaintenanceWindow.go b/service/ssm/api_op_RegisterTargetWithMaintenanceWindow.go index 272177e23ee..6656bd71eea 100644 --- a/service/ssm/api_op_RegisterTargetWithMaintenanceWindow.go +++ b/service/ssm/api_op_RegisterTargetWithMaintenanceWindow.go @@ -59,6 +59,11 @@ func (c *Client) RegisterTargetWithMaintenanceWindow(ctx context.Context, params type RegisterTargetWithMaintenanceWindowInput struct { + // The type of target being registered with the maintenance window. + // + // This member is required. + ResourceType types.MaintenanceWindowResourceType + // The targets to register with the maintenance window. In other words, the // instances to run commands on when the maintenance window runs.

    You can // specify targets using instance IDs, resource group names, or tags that have been @@ -83,28 +88,23 @@ type RegisterTargetWithMaintenanceWindowInput struct { // This member is required. Targets []*types.Target - // User-provided value that will be included in any CloudWatch events raised while - // running tasks for these targets in this maintenance window. - OwnerInformation *string - - // An optional description for the target. - Description *string - - // The type of target being registered with the maintenance window. - // - // This member is required. - ResourceType types.MaintenanceWindowResourceType - // The ID of the maintenance window the target should be registered with. // // This member is required. WindowId *string + // User-provided idempotency token. + ClientToken *string + + // An optional description for the target. + Description *string + // An optional name for the target. Name *string - // User-provided idempotency token. - ClientToken *string + // User-provided value that will be included in any CloudWatch events raised while + // running tasks for these targets in this maintenance window. + OwnerInformation *string } type RegisterTargetWithMaintenanceWindowOutput struct { diff --git a/service/ssm/api_op_RegisterTaskWithMaintenanceWindow.go b/service/ssm/api_op_RegisterTaskWithMaintenanceWindow.go index ec639648c40..1449cc32d51 100644 --- a/service/ssm/api_op_RegisterTaskWithMaintenanceWindow.go +++ b/service/ssm/api_op_RegisterTaskWithMaintenanceWindow.go @@ -59,6 +59,44 @@ func (c *Client) RegisterTaskWithMaintenanceWindow(ctx context.Context, params * type RegisterTaskWithMaintenanceWindowInput struct { + // The maximum number of targets this task can be run for in parallel. + // + // This member is required. + MaxConcurrency *string + + // The maximum number of errors allowed before this task stops being scheduled. + // + // This member is required. + MaxErrors *string + + // The targets (either instances or maintenance window targets). Specify instances + // using the following format: Key=InstanceIds,Values=, Specify maintenance window + // targets using the following format: Key=WindowTargetIds;,Values=, + // + // This member is required. + Targets []*types.Target + + // The ARN of the task to run. + // + // This member is required. + TaskArn *string + + // The type of task being registered. + // + // This member is required. + TaskType types.MaintenanceWindowTaskType + + // The ID of the maintenance window the task should be added to. + // + // This member is required. + WindowId *string + + // User-provided idempotency token. + ClientToken *string + + // An optional description for the task. + Description *string + // A structure containing information about an S3 bucket to write instance-level // logs to. LoggingInfo has been deprecated. To specify an S3 bucket to contain // logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the @@ -67,8 +105,13 @@ type RegisterTaskWithMaintenanceWindowInput struct { // MaintenanceWindowTaskInvocationParameters (). LoggingInfo *types.LoggingInfo - // User-provided idempotency token. - ClientToken *string + // An optional name for the task. + Name *string + + // The priority of the task in the maintenance window, the lower the number the + // higher the priority. Tasks in a maintenance window are scheduled in priority + // order with tasks that have the same priority scheduled in parallel. + Priority *int32 // The ARN of the IAM service role for Systems Manager to assume when running a // maintenance window task. If you do not specify a service role ARN, Systems @@ -87,59 +130,16 @@ type RegisterTaskWithMaintenanceWindowInput struct { // (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role) ServiceRoleArn *string - // The targets (either instances or maintenance window targets). Specify instances - // using the following format: Key=InstanceIds,Values=, Specify maintenance window - // targets using the following format: Key=WindowTargetIds;,Values=, - // - // This member is required. - Targets []*types.Target - - // An optional description for the task. - Description *string - - // The ARN of the task to run. - // - // This member is required. - TaskArn *string - - // The maximum number of errors allowed before this task stops being scheduled. - // - // This member is required. - MaxErrors *string - - // The maximum number of targets this task can be run for in parallel. - // - // This member is required. - MaxConcurrency *string - - // The ID of the maintenance window the task should be added to. - // - // This member is required. - WindowId *string - // The parameters that the task should use during execution. Populate only the // fields that match the task type. All other fields should be empty. TaskInvocationParameters *types.MaintenanceWindowTaskInvocationParameters - // An optional name for the task. - Name *string - // The parameters that should be passed to the task when it is run. TaskParameters // has been deprecated. To specify parameters to pass to a task when it runs, // instead use the Parameters option in the TaskInvocationParameters structure. For // information about how Systems Manager handles these options for the supported // maintenance window task types, see MaintenanceWindowTaskInvocationParameters (). TaskParameters map[string]*types.MaintenanceWindowTaskParameterValueExpression - - // The priority of the task in the maintenance window, the lower the number the - // higher the priority. Tasks in a maintenance window are scheduled in priority - // order with tasks that have the same priority scheduled in parallel. - Priority *int32 - - // The type of task being registered. - // - // This member is required. - TaskType types.MaintenanceWindowTaskType } type RegisterTaskWithMaintenanceWindowOutput struct { diff --git a/service/ssm/api_op_RemoveTagsFromResource.go b/service/ssm/api_op_RemoveTagsFromResource.go index 93f5e50fb81..844364ef2b1 100644 --- a/service/ssm/api_op_RemoveTagsFromResource.go +++ b/service/ssm/api_op_RemoveTagsFromResource.go @@ -67,11 +67,6 @@ type RemoveTagsFromResourceInput struct { // This member is required. ResourceId *string - // Tag keys that you want to remove from the specified resource. - // - // This member is required. - TagKeys []*string - // The type of resource from which you want to remove a tag. The ManagedInstance // type for this API action is only for on-premises managed instances. Specify the // name of the managed instance in the following format: mi-ID_number. For example, @@ -79,6 +74,11 @@ type RemoveTagsFromResourceInput struct { // // This member is required. ResourceType types.ResourceTypeForTagging + + // Tag keys that you want to remove from the specified resource. + // + // This member is required. + TagKeys []*string } type RemoveTagsFromResourceOutput struct { diff --git a/service/ssm/api_op_SendAutomationSignal.go b/service/ssm/api_op_SendAutomationSignal.go index 66e28dba6f7..597bfa51a2f 100644 --- a/service/ssm/api_op_SendAutomationSignal.go +++ b/service/ssm/api_op_SendAutomationSignal.go @@ -64,6 +64,11 @@ type SendAutomationSignalInput struct { // This member is required. AutomationExecutionId *string + // The type of signal to send to an Automation execution. + // + // This member is required. + SignalType types.SignalType + // The data sent with the signal. The data schema depends on the type of signal // used in the request. For Approve and Reject signal types, the payload is an // optional comment that you can send with the signal type. For example: @@ -73,11 +78,6 @@ type SendAutomationSignalInput struct { // ID as the payload. For example: // StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab" Payload map[string][]*string - - // The type of signal to send to an Automation execution. - // - // This member is required. - SignalType types.SignalType } type SendAutomationSignalOutput struct { diff --git a/service/ssm/api_op_SendCommand.go b/service/ssm/api_op_SendCommand.go index 69244c5ae76..c84ea59b919 100644 --- a/service/ssm/api_op_SendCommand.go +++ b/service/ssm/api_op_SendCommand.go @@ -57,52 +57,33 @@ func (c *Client) SendCommand(ctx context.Context, params *SendCommandInput, optF type SendCommandInput struct { - // The SSM document version to use in the request. You can specify $DEFAULT, - // $LATEST, or a specific version number. If you run commands by using the AWS CLI, - // then you must escape the first two options by using a backslash. If you specify - // a version number, then you don't need to use the backslash. For example: - // --document-version "\$DEFAULT" --document-version "\$LATEST" --document-version - // "3" - DocumentVersion *string - - // Configurations for sending notifications. - NotificationConfig *types.NotificationConfig - - // (Deprecated) You can no longer specify this parameter. The system ignores it. - // Instead, Systems Manager automatically determines the Region of the S3 bucket. - OutputS3Region *string - - // The Sha256 or Sha1 hash created by the system when the document was created. - // Sha1 hashes have been deprecated. - DocumentHash *string + // Required. The name of the Systems Manager document to run. This can be a public + // document or a custom document. + // + // This member is required. + DocumentName *string - // The directory structure within the S3 bucket where the responses should be - // stored. - OutputS3KeyPrefix *string + // Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs. + CloudWatchOutputConfig *types.CloudWatchOutputConfig // User-specified information about the command, such as a brief description of // what the command should do. Comment *string - // The maximum number of errors allowed without the command failing. When the - // command fails one more time beyond the value of MaxErrors, the systems stops - // sending the command to additional targets. You can specify a number like 10 or a - // percentage like 10%. The default value is 0. For more information about how to - // use MaxErrors, see Using error controls - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors) - // in the AWS Systems Manager User Guide. - MaxErrors *string + // The Sha256 or Sha1 hash created by the system when the document was created. + // Sha1 hashes have been deprecated. + DocumentHash *string - // The required and optional parameters specified in the document being run. - Parameters map[string][]*string + // Sha256 or Sha1. Sha1 hashes have been deprecated. + DocumentHashType types.DocumentHashType - // (Optional) The maximum number of instances that are allowed to run the command - // at the same time. You can specify a number such as 10 or a percentage such as - // 10%. The default value is 50. For more information about how to use - // MaxConcurrency, see Using concurrency controls - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-velocity) - // in the AWS Systems Manager User Guide. - MaxConcurrency *string + // The SSM document version to use in the request. You can specify $DEFAULT, + // $LATEST, or a specific version number. If you run commands by using the AWS CLI, + // then you must escape the first two options by using a backslash. If you specify + // a version number, then you don't need to use the backslash. For example: + // --document-version "\$DEFAULT" --document-version "\$LATEST" --document-version + // "3" + DocumentVersion *string // The IDs of the instances where the command should run. Specifying instance IDs // is most useful when you are targeting a limited number of instances, though you @@ -116,24 +97,39 @@ type SendCommandInput struct { // in the AWS Systems Manager User Guide. InstanceIds []*string - // Required. The name of the Systems Manager document to run. This can be a public - // document or a custom document. - // - // This member is required. - DocumentName *string + // (Optional) The maximum number of instances that are allowed to run the command + // at the same time. You can specify a number such as 10 or a percentage such as + // 10%. The default value is 50. For more information about how to use + // MaxConcurrency, see Using concurrency controls + // (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-velocity) + // in the AWS Systems Manager User Guide. + MaxConcurrency *string + + // The maximum number of errors allowed without the command failing. When the + // command fails one more time beyond the value of MaxErrors, the systems stops + // sending the command to additional targets. You can specify a number like 10 or a + // percentage like 10%. The default value is 0. For more information about how to + // use MaxErrors, see Using error controls + // (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors) + // in the AWS Systems Manager User Guide. + MaxErrors *string + + // Configurations for sending notifications. + NotificationConfig *types.NotificationConfig // The name of the S3 bucket where command execution responses should be stored. OutputS3BucketName *string - // If this time is reached and the command has not already started running, it will - // not run. - TimeoutSeconds *int32 + // The directory structure within the S3 bucket where the responses should be + // stored. + OutputS3KeyPrefix *string - // Sha256 or Sha1. Sha1 hashes have been deprecated. - DocumentHashType types.DocumentHashType + // (Deprecated) You can no longer specify this parameter. The system ignores it. + // Instead, Systems Manager automatically determines the Region of the S3 bucket. + OutputS3Region *string - // Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs. - CloudWatchOutputConfig *types.CloudWatchOutputConfig + // The required and optional parameters specified in the document being run. + Parameters map[string][]*string // The ARN of the IAM service role to use to publish Amazon Simple Notification // Service (Amazon SNS) notifications for Run Command commands. @@ -149,6 +145,10 @@ type SendCommandInput struct { // (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html) // in the AWS Systems Manager User Guide. Targets []*types.Target + + // If this time is reached and the command has not already started running, it will + // not run. + TimeoutSeconds *int32 } type SendCommandOutput struct { diff --git a/service/ssm/api_op_StartAutomationExecution.go b/service/ssm/api_op_StartAutomationExecution.go index 79c261d1f54..95266c53626 100644 --- a/service/ssm/api_op_StartAutomationExecution.go +++ b/service/ssm/api_op_StartAutomationExecution.go @@ -57,26 +57,23 @@ func (c *Client) StartAutomationExecution(ctx context.Context, params *StartAuto type StartAutomationExecutionInput struct { - // Optional metadata that you assign to a resource. You can specify a maximum of - // five tags for an automation. Tags enable you to categorize a resource in - // different ways, such as by purpose, owner, or environment. For example, you - // might want to tag an automation to identify an environment or operating system. - // In this case, you could specify the following key name/value pairs: - // - // * - // Key=environment,Value=test - // - // * Key=OS,Value=Windows - // - // To add tags to an - // existing patch baseline, use the AddTagsToResource () action. - Tags []*types.Tag - // The name of the Automation document to use for this execution. // // This member is required. DocumentName *string + // User-provided idempotency token. The token must be unique, is case insensitive, + // enforces the UUID format, and can't be reused. + ClientToken *string + + // The version of the Automation document to use for this execution. + DocumentVersion *string + + // The maximum number of targets allowed to run this task in parallel. You can + // specify a number, such as 10, or a percentage, such as 10%. The default value is + // 10. + MaxConcurrency *string + // The number of errors that are allowed before the system stops running the // automation on additional targets. You can specify either an absolute number of // errors, for example 10, or a percentage of the target set, for example 10%. If @@ -91,6 +88,29 @@ type StartAutomationExecutionInput struct { // executions, set max-concurrency to 1 so the executions proceed one at a time. MaxErrors *string + // The execution mode of the automation. Valid modes include the following: Auto + // and Interactive. The default mode is Auto. + Mode types.ExecutionMode + + // A key-value map of execution parameters, which match the declared parameters in + // the Automation document. + Parameters map[string][]*string + + // Optional metadata that you assign to a resource. You can specify a maximum of + // five tags for an automation. Tags enable you to categorize a resource in + // different ways, such as by purpose, owner, or environment. For example, you + // might want to tag an automation to identify an environment or operating system. + // In this case, you could specify the following key name/value pairs: + // + // * + // Key=environment,Value=test + // + // * Key=OS,Value=Windows + // + // To add tags to an + // existing patch baseline, use the AddTagsToResource () action. + Tags []*types.Tag + // A location is a combination of AWS Regions and/or AWS accounts where you want to // run the Automation. Use this action to start an Automation in multiple Regions // and multiple accounts. For more information, see Running Automation workflows in @@ -99,37 +119,17 @@ type StartAutomationExecutionInput struct { // in the AWS Systems Manager User Guide. TargetLocations []*types.TargetLocation - // A key-value mapping to target resources. Required if you specify - // TargetParameterName. - Targets []*types.Target - - // User-provided idempotency token. The token must be unique, is case insensitive, - // enforces the UUID format, and can't be reused. - ClientToken *string - // A key-value mapping of document parameters to target resources. Both Targets and // TargetMaps cannot be specified together. TargetMaps []map[string][]*string - // The version of the Automation document to use for this execution. - DocumentVersion *string - - // The execution mode of the automation. Valid modes include the following: Auto - // and Interactive. The default mode is Auto. - Mode types.ExecutionMode - - // The maximum number of targets allowed to run this task in parallel. You can - // specify a number, such as 10, or a percentage, such as 10%. The default value is - // 10. - MaxConcurrency *string - - // A key-value map of execution parameters, which match the declared parameters in - // the Automation document. - Parameters map[string][]*string - // The name of the parameter used as the target resource for the rate-controlled // execution. Required if you specify targets. TargetParameterName *string + + // A key-value mapping to target resources. Required if you specify + // TargetParameterName. + Targets []*types.Target } type StartAutomationExecutionOutput struct { diff --git a/service/ssm/api_op_StartSession.go b/service/ssm/api_op_StartSession.go index 2683e25c406..9dfcaa88748 100644 --- a/service/ssm/api_op_StartSession.go +++ b/service/ssm/api_op_StartSession.go @@ -65,9 +65,6 @@ func (c *Client) StartSession(ctx context.Context, params *StartSessionInput, op type StartSessionInput struct { - // Reserved for future use. - Parameters map[string][]*string - // The instance to connect to for the session. // // This member is required. @@ -79,13 +76,15 @@ type StartSessionInput struct { // session. If no document name is provided, a shell to the instance is launched by // default. DocumentName *string + + // Reserved for future use. + Parameters map[string][]*string } type StartSessionOutput struct { - // An encrypted token value containing session and caller information. Used to - // authenticate the connection to the instance. - TokenValue *string + // The ID of the session. + SessionId *string // A URL back to SSM Agent on the instance that the Session Manager client uses to // send commands and receive output from the instance. Format: @@ -98,8 +97,9 @@ type StartSessionOutput struct { // session, such as 1a2b3c4dEXAMPLE. StreamUrl *string - // The ID of the session. - SessionId *string + // An encrypted token value containing session and caller information. Used to + // authenticate the connection to the instance. + TokenValue *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/ssm/api_op_UpdateAssociation.go b/service/ssm/api_op_UpdateAssociation.go index 97dfad0a81f..ad50edd559b 100644 --- a/service/ssm/api_op_UpdateAssociation.go +++ b/service/ssm/api_op_UpdateAssociation.go @@ -70,38 +70,43 @@ type UpdateAssociationInput struct { // This member is required. AssociationId *string - // Specify the target for the association. This target is required for associations - // that use an Automation document and target resources by using rate controls. - AutomationTargetParameterName *string - - // The targets of the association. - Targets []*types.Target + // By default, when you update an association, the system runs it immediately after + // it is updated and then according to the schedule you specified. Specify this + // option if you don't want an association to run immediately after you update it. + // Also, if you specified this option when you created the association, you can + // reset it. To do so, specify the no-apply-only-at-cron-interval parameter when + // you update the association from the command line. This parameter forces the + // association to run immediately after updating it and according to the interval + // specified. + ApplyOnlyAtCronInterval *bool - // The document version you want update for the association. - DocumentVersion *string + // The name of the association that you want to update. + AssociationName *string // This parameter is provided for concurrency control purposes. You must specify // the latest association version in the service. If you want to ensure that this // request succeeds, either specify $LATEST, or omit this parameter. AssociationVersion *string + // Specify the target for the association. This target is required for associations + // that use an Automation document and target resources by using rate controls. + AutomationTargetParameterName *string + // The severity level to assign to the association. ComplianceSeverity types.AssociationComplianceSeverity - // The name of the SSM document that contains the configuration information for the - // instance. You can specify Command or Automation documents. You can specify - // AWS-predefined documents, documents you created, or a document that is shared - // with you from another account. For SSM documents that are shared with you from - // other AWS accounts, you must specify the complete SSM document ARN, in the - // following format: arn:aws:ssm:region:account-id:document/document-name For - // example: arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For - // AWS-predefined documents and SSM documents you created in your account, you only - // need to specify the document name. For example, AWS-ApplyPatchBaseline or - // My-Document. - Name *string + // The document version you want update for the association. + DocumentVersion *string - // The cron expression used to schedule the association that you want to update. - ScheduleExpression *string + // The maximum number of targets allowed to run the association at the same time. + // You can specify a number, for example 10, or a percentage of the target set, for + // example 10%. The default value is 100%, which means all targets run the + // association at the same time. If a new instance starts and attempts to run an + // association while Systems Manager is running MaxConcurrency associations, the + // association is allowed to run. During the next association interval, the new + // instance will process its association within the limit specified for + // MaxConcurrency. + MaxConcurrency *string // The number of errors that are allowed before the system stops sending requests // to run the association on additional targets. You can specify either an absolute @@ -117,36 +122,28 @@ type UpdateAssociationInput struct { // one at a time. MaxErrors *string - // By default, when you update an association, the system runs it immediately after - // it is updated and then according to the schedule you specified. Specify this - // option if you don't want an association to run immediately after you update it. - // Also, if you specified this option when you created the association, you can - // reset it. To do so, specify the no-apply-only-at-cron-interval parameter when - // you update the association from the command line. This parameter forces the - // association to run immediately after updating it and according to the interval - // specified. - ApplyOnlyAtCronInterval *bool + // The name of the SSM document that contains the configuration information for the + // instance. You can specify Command or Automation documents. You can specify + // AWS-predefined documents, documents you created, or a document that is shared + // with you from another account. For SSM documents that are shared with you from + // other AWS accounts, you must specify the complete SSM document ARN, in the + // following format: arn:aws:ssm:region:account-id:document/document-name For + // example: arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For + // AWS-predefined documents and SSM documents you created in your account, you only + // need to specify the document name. For example, AWS-ApplyPatchBaseline or + // My-Document. + Name *string - // The name of the association that you want to update. - AssociationName *string + // An S3 bucket where you want to store the results of this request. + OutputLocation *types.InstanceAssociationOutputLocation // The parameters you want to update for the association. If you create a parameter // using Parameter Store, you can reference the parameter using // {{ssm:parameter-name}} Parameters map[string][]*string - // An S3 bucket where you want to store the results of this request. - OutputLocation *types.InstanceAssociationOutputLocation - - // The maximum number of targets allowed to run the association at the same time. - // You can specify a number, for example 10, or a percentage of the target set, for - // example 10%. The default value is 100%, which means all targets run the - // association at the same time. If a new instance starts and attempts to run an - // association while Systems Manager is running MaxConcurrency associations, the - // association is allowed to run. During the next association interval, the new - // instance will process its association within the limit specified for - // MaxConcurrency. - MaxConcurrency *string + // The cron expression used to schedule the association that you want to update. + ScheduleExpression *string // The mode for generating association compliance. You can specify AUTO or MANUAL. // In AUTO mode, the system uses the status of the association execution to @@ -158,6 +155,9 @@ type UpdateAssociationInput struct { // your direct call to the PutComplianceItems () API action. By default, all // associations use AUTO mode. SyncCompliance types.AssociationSyncCompliance + + // The targets of the association. + Targets []*types.Target } type UpdateAssociationOutput struct { diff --git a/service/ssm/api_op_UpdateAssociationStatus.go b/service/ssm/api_op_UpdateAssociationStatus.go index 5d2f83084ea..1ae5f5a8f34 100644 --- a/service/ssm/api_op_UpdateAssociationStatus.go +++ b/service/ssm/api_op_UpdateAssociationStatus.go @@ -58,11 +58,6 @@ func (c *Client) UpdateAssociationStatus(ctx context.Context, params *UpdateAsso type UpdateAssociationStatusInput struct { - // The name of the Systems Manager document. - // - // This member is required. - Name *string - // The association status. // // This member is required. @@ -72,6 +67,11 @@ type UpdateAssociationStatusInput struct { // // This member is required. InstanceId *string + + // The name of the Systems Manager document. + // + // This member is required. + Name *string } type UpdateAssociationStatusOutput struct { diff --git a/service/ssm/api_op_UpdateDocument.go b/service/ssm/api_op_UpdateDocument.go index c0222a95c89..361958538ae 100644 --- a/service/ssm/api_op_UpdateDocument.go +++ b/service/ssm/api_op_UpdateDocument.go @@ -62,23 +62,15 @@ type UpdateDocumentInput struct { // This member is required. Content *string - // Specify a new target type for the document. - TargetType *string - - // An optional field specifying the version of the artifact you are updating with - // the document. For example, "Release 12, Update 6". This value is unique across - // all versions of a document, and cannot be changed. - VersionName *string - - // A list of key and value pairs that describe attachments to a version of a - // document. - Attachments []*types.AttachmentsSource - // The name of the document that you want to update. // // This member is required. Name *string + // A list of key and value pairs that describe attachments to a version of a + // document. + Attachments []*types.AttachmentsSource + // Specify the document format for the new document version. Systems Manager // supports JSON and YAML documents. JSON is the default format. DocumentFormat types.DocumentFormat @@ -87,6 +79,14 @@ type UpdateDocumentInput struct { // latest document version can be specified using the $LATEST variable or by the // version number. Updating a previous version of a document is not supported. DocumentVersion *string + + // Specify a new target type for the document. + TargetType *string + + // An optional field specifying the version of the artifact you are updating with + // the document. For example, "Release 12, Update 6". This value is unique across + // all versions of a document, and cannot be changed. + VersionName *string } type UpdateDocumentOutput struct { diff --git a/service/ssm/api_op_UpdateMaintenanceWindow.go b/service/ssm/api_op_UpdateMaintenanceWindow.go index 26a3e14d073..dbd1c8ea0e8 100644 --- a/service/ssm/api_op_UpdateMaintenanceWindow.go +++ b/service/ssm/api_op_UpdateMaintenanceWindow.go @@ -62,37 +62,44 @@ func (c *Client) UpdateMaintenanceWindow(ctx context.Context, params *UpdateMain type UpdateMaintenanceWindowInput struct { - // The schedule of the maintenance window in the form of a cron or rate expression. - Schedule *string - - // The duration of the maintenance window in hours. - Duration *int32 - - // Whether the maintenance window is enabled. - Enabled *bool + // The ID of the maintenance window to update. + // + // This member is required. + WindowId *string // Whether targets must be registered with the maintenance window before tasks can // be defined for those targets. AllowUnassociatedTargets *bool + // The number of hours before the end of the maintenance window that Systems + // Manager stops scheduling new tasks for execution. + Cutoff *int32 + // An optional description for the update request. Description *string - // The time zone that the scheduled maintenance window executions are based on, in - // Internet Assigned Numbers Authority (IANA) format. For example: - // "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the - // Time Zone Database (https://www.iana.org/time-zones) on the IANA website. - ScheduleTimezone *string + // The duration of the maintenance window in hours. + Duration *int32 - // The number of hours before the end of the maintenance window that Systems - // Manager stops scheduling new tasks for execution. - Cutoff *int32 + // Whether the maintenance window is enabled. + Enabled *bool + + // The date and time, in ISO-8601 Extended format, for when you want the + // maintenance window to become inactive. EndDate allows you to set a date and time + // in the future when the maintenance window will no longer run. + EndDate *string + + // The name of the maintenance window. + Name *string // If True, then all fields that are required by the CreateMaintenanceWindow action // are also required for this API request. Optional fields that are not specified // are set to null. Replace *bool + // The schedule of the maintenance window in the form of a cron or rate expression. + Schedule *string + // The number of days to wait after the date and time specified by a CRON // expression before running the maintenance window. For example, the following // cron expression schedules a maintenance window to run the third Tuesday of every @@ -100,18 +107,11 @@ type UpdateMaintenanceWindowInput struct { // maintenance window won't run until two days later. ScheduleOffset *int32 - // The name of the maintenance window. - Name *string - - // The ID of the maintenance window to update. - // - // This member is required. - WindowId *string - - // The date and time, in ISO-8601 Extended format, for when you want the - // maintenance window to become inactive. EndDate allows you to set a date and time - // in the future when the maintenance window will no longer run. - EndDate *string + // The time zone that the scheduled maintenance window executions are based on, in + // Internet Assigned Numbers Authority (IANA) format. For example: + // "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the + // Time Zone Database (https://www.iana.org/time-zones) on the IANA website. + ScheduleTimezone *string // The time zone that the scheduled maintenance window executions are based on, in // Internet Assigned Numbers Authority (IANA) format. For example: @@ -122,52 +122,52 @@ type UpdateMaintenanceWindowInput struct { type UpdateMaintenanceWindowOutput struct { - // The time zone that the scheduled maintenance window executions are based on, in - // Internet Assigned Numbers Authority (IANA) format. For example: - // "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the - // Time Zone Database (https://www.iana.org/time-zones) on the IANA website. - ScheduleTimezone *string + // Whether targets must be registered with the maintenance window before tasks can + // be defined for those targets. + AllowUnassociatedTargets *bool - // The date and time, in ISO-8601 Extended format, for when the maintenance window - // is scheduled to become active. The maintenance window will not run before this - // specified time. - StartDate *string + // The number of hours before the end of the maintenance window that Systems + // Manager stops scheduling new tasks for execution. + Cutoff *int32 + + // An optional description of the update. + Description *string // The duration of the maintenance window in hours. Duration *int32 - // The name of the maintenance window. - Name *string - - // The schedule of the maintenance window in the form of a cron or rate expression. - Schedule *string + // Whether the maintenance window is enabled. + Enabled *bool // The date and time, in ISO-8601 Extended format, for when the maintenance window // is scheduled to become inactive. The maintenance window will not run after this // specified time. EndDate *string - // Whether the maintenance window is enabled. - Enabled *bool - - // The number of hours before the end of the maintenance window that Systems - // Manager stops scheduling new tasks for execution. - Cutoff *int32 - - // Whether targets must be registered with the maintenance window before tasks can - // be defined for those targets. - AllowUnassociatedTargets *bool - - // The ID of the created maintenance window. - WindowId *string + // The name of the maintenance window. + Name *string - // An optional description of the update. - Description *string + // The schedule of the maintenance window in the form of a cron or rate expression. + Schedule *string // The number of days to wait to run a maintenance window after the scheduled CRON // expression date and time. ScheduleOffset *int32 + // The time zone that the scheduled maintenance window executions are based on, in + // Internet Assigned Numbers Authority (IANA) format. For example: + // "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the + // Time Zone Database (https://www.iana.org/time-zones) on the IANA website. + ScheduleTimezone *string + + // The date and time, in ISO-8601 Extended format, for when the maintenance window + // is scheduled to become active. The maintenance window will not run before this + // specified time. + StartDate *string + + // The ID of the created maintenance window. + WindowId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_UpdateMaintenanceWindowTarget.go b/service/ssm/api_op_UpdateMaintenanceWindowTarget.go index 92cbc853b2b..685598c89b8 100644 --- a/service/ssm/api_op_UpdateMaintenanceWindowTarget.go +++ b/service/ssm/api_op_UpdateMaintenanceWindowTarget.go @@ -63,55 +63,55 @@ func (c *Client) UpdateMaintenanceWindowTarget(ctx context.Context, params *Upda type UpdateMaintenanceWindowTargetInput struct { - // User-provided value that will be included in any CloudWatch events raised while - // running tasks for these targets in this maintenance window. - OwnerInformation *string + // The maintenance window ID with which to modify the target. + // + // This member is required. + WindowId *string + + // The target ID to modify. + // + // This member is required. + WindowTargetId *string // An optional description for the update. Description *string - // The targets to add or replace. - Targets []*types.Target + // A name for the update. + Name *string + + // User-provided value that will be included in any CloudWatch events raised while + // running tasks for these targets in this maintenance window. + OwnerInformation *string // If True, then all fields that are required by the // RegisterTargetWithMaintenanceWindow action are also required for this API // request. Optional fields that are not specified are set to null. Replace *bool - // The maintenance window ID with which to modify the target. - // - // This member is required. - WindowId *string - - // A name for the update. - Name *string - - // The target ID to modify. - // - // This member is required. - WindowTargetId *string + // The targets to add or replace. + Targets []*types.Target } type UpdateMaintenanceWindowTargetOutput struct { - // The updated owner. - OwnerInformation *string - // The updated description. Description *string - // The target ID specified in the update request. - WindowTargetId *string - // The updated name. Name *string + // The updated owner. + OwnerInformation *string + // The updated targets. Targets []*types.Target // The maintenance window ID specified in the update request. WindowId *string + // The target ID specified in the update request. + WindowTargetId *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssm/api_op_UpdateMaintenanceWindowTask.go b/service/ssm/api_op_UpdateMaintenanceWindowTask.go index bfb38c53132..78b917d8bcc 100644 --- a/service/ssm/api_op_UpdateMaintenanceWindowTask.go +++ b/service/ssm/api_op_UpdateMaintenanceWindowTask.go @@ -79,10 +79,18 @@ func (c *Client) UpdateMaintenanceWindowTask(ctx context.Context, params *Update type UpdateMaintenanceWindowTaskInput struct { - // If True, then all fields that are required by the - // RegisterTaskWithMaintenanceWndow action are also required for this API request. - // Optional fields that are not specified are set to null. - Replace *bool + // The maintenance window ID that contains the task to modify. + // + // This member is required. + WindowId *string + + // The task ID to modify. + // + // This member is required. + WindowTaskId *string + + // The new task description to specify. + Description *string // The new logging location in Amazon S3 to specify. LoggingInfo has been // deprecated. To specify an S3 bucket to contain logs, instead use the @@ -92,41 +100,25 @@ type UpdateMaintenanceWindowTaskInput struct { // MaintenanceWindowTaskInvocationParameters (). LoggingInfo *types.LoggingInfo - // The new task description to specify. - Description *string + // The new MaxConcurrency value you want to specify. MaxConcurrency is the number + // of targets that are allowed to run this task in parallel. + MaxConcurrency *string // The new MaxErrors value to specify. MaxErrors is the maximum number of errors // that are allowed before the task stops being scheduled. MaxErrors *string - // The task ARN to modify. - TaskArn *string - // The new task name to specify. Name *string - // The targets (either instances or tags) to modify. Instances are specified using - // Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using - // Key=tag_name,Values=tag_value. - Targets []*types.Target - - // The maintenance window ID that contains the task to modify. - // - // This member is required. - WindowId *string - // The new task priority to specify. The lower the number, the higher the priority. // Tasks that have the same priority are scheduled in parallel. Priority *int32 - // The parameters to modify. TaskParameters has been deprecated. To specify - // parameters to pass to a task when it runs, instead use the Parameters option in - // the TaskInvocationParameters structure. For information about how Systems - // Manager handles these options for the supported maintenance window task types, - // see MaintenanceWindowTaskInvocationParameters (). The map has the following - // format: Key: string, between 1 and 255 characters Value: an array of strings, - // each string is between 1 and 255 characters - TaskParameters map[string]*types.MaintenanceWindowTaskParameterValueExpression + // If True, then all fields that are required by the + // RegisterTaskWithMaintenanceWndow action are also required for this API request. + // Optional fields that are not specified are set to null. + Replace *bool // The ARN of the IAM service role for Systems Manager to assume when running a // maintenance window task. If you do not specify a service role ARN, Systems @@ -145,47 +137,29 @@ type UpdateMaintenanceWindowTaskInput struct { // (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role) ServiceRoleArn *string - // The task ID to modify. - // - // This member is required. - WindowTaskId *string + // The targets (either instances or tags) to modify. Instances are specified using + // Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using + // Key=tag_name,Values=tag_value. + Targets []*types.Target + + // The task ARN to modify. + TaskArn *string // The parameters that the task should use during execution. Populate only the // fields that match the task type. All other fields should be empty. TaskInvocationParameters *types.MaintenanceWindowTaskInvocationParameters - // The new MaxConcurrency value you want to specify. MaxConcurrency is the number - // of targets that are allowed to run this task in parallel. - MaxConcurrency *string -} - -type UpdateMaintenanceWindowTaskOutput struct { - - // The ID of the maintenance window that was updated. - WindowId *string - - // The updated task name. - Name *string - - // The updated parameter values. - TaskInvocationParameters *types.MaintenanceWindowTaskInvocationParameters - - // The updated priority value. - Priority *int32 - - // The updated parameter values. TaskParameters has been deprecated. To specify + // The parameters to modify. TaskParameters has been deprecated. To specify // parameters to pass to a task when it runs, instead use the Parameters option in // the TaskInvocationParameters structure. For information about how Systems // Manager handles these options for the supported maintenance window task types, - // see MaintenanceWindowTaskInvocationParameters (). + // see MaintenanceWindowTaskInvocationParameters (). The map has the following + // format: Key: string, between 1 and 255 characters Value: an array of strings, + // each string is between 1 and 255 characters TaskParameters map[string]*types.MaintenanceWindowTaskParameterValueExpression +} - // The updated target values. - Targets []*types.Target - - // The ARN of the IAM service role to use to publish Amazon Simple Notification - // Service (Amazon SNS) notifications for maintenance window Run Command tasks. - ServiceRoleArn *string +type UpdateMaintenanceWindowTaskOutput struct { // The updated task description. Description *string @@ -197,14 +171,40 @@ type UpdateMaintenanceWindowTaskOutput struct { // maintenance window task types, see MaintenanceWindowTaskInvocationParameters (). LoggingInfo *types.LoggingInfo + // The updated MaxConcurrency value. + MaxConcurrency *string + // The updated MaxErrors value. MaxErrors *string + // The updated task name. + Name *string + + // The updated priority value. + Priority *int32 + + // The ARN of the IAM service role to use to publish Amazon Simple Notification + // Service (Amazon SNS) notifications for maintenance window Run Command tasks. + ServiceRoleArn *string + + // The updated target values. + Targets []*types.Target + // The updated task ARN value. TaskArn *string - // The updated MaxConcurrency value. - MaxConcurrency *string + // The updated parameter values. + TaskInvocationParameters *types.MaintenanceWindowTaskInvocationParameters + + // The updated parameter values. TaskParameters has been deprecated. To specify + // parameters to pass to a task when it runs, instead use the Parameters option in + // the TaskInvocationParameters structure. For information about how Systems + // Manager handles these options for the supported maintenance window task types, + // see MaintenanceWindowTaskInvocationParameters (). + TaskParameters map[string]*types.MaintenanceWindowTaskParameterValueExpression + + // The ID of the maintenance window that was updated. + WindowId *string // The task ID of the maintenance window that was updated. WindowTaskId *string diff --git a/service/ssm/api_op_UpdateManagedInstanceRole.go b/service/ssm/api_op_UpdateManagedInstanceRole.go index 9cb6ec70c59..765e42b7040 100644 --- a/service/ssm/api_op_UpdateManagedInstanceRole.go +++ b/service/ssm/api_op_UpdateManagedInstanceRole.go @@ -59,15 +59,15 @@ func (c *Client) UpdateManagedInstanceRole(ctx context.Context, params *UpdateMa type UpdateManagedInstanceRoleInput struct { - // The ID of the managed instance where you want to update the role. + // The IAM role you want to assign or change. // // This member is required. - InstanceId *string + IamRole *string - // The IAM role you want to assign or change. + // The ID of the managed instance where you want to update the role. // // This member is required. - IamRole *string + InstanceId *string } type UpdateManagedInstanceRoleOutput struct { diff --git a/service/ssm/api_op_UpdateOpsItem.go b/service/ssm/api_op_UpdateOpsItem.go index 808495ca8d5..8a1d858657f 100644 --- a/service/ssm/api_op_UpdateOpsItem.go +++ b/service/ssm/api_op_UpdateOpsItem.go @@ -66,17 +66,21 @@ func (c *Client) UpdateOpsItem(ctx context.Context, params *UpdateOpsItemInput, type UpdateOpsItemInput struct { - // Keys that you want to remove from the OperationalData map. - OperationalDataToDelete []*string + // The ID of the OpsItem. + // + // This member is required. + OpsItemId *string + + // Specify a new category for an OpsItem. + Category *string // Update the information about the OpsItem. Provide enough information so that // users reading this OpsItem for the first time understand the issue. Description *string - // The ID of the OpsItem. - // - // This member is required. - OpsItemId *string + // The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when + // this OpsItem is edited or changed. + Notifications []*types.OpsItemNotification // Add new keys or edit existing key-value pairs of the OperationalData map in the // OpsItem object. Operational data is custom data that provides useful reference @@ -99,21 +103,19 @@ type UpdateOpsItemInput struct { // in the AWS Systems Manager User Guide. OperationalData map[string]*types.OpsItemDataValue - // Specify a new category for an OpsItem. - Category *string + // Keys that you want to remove from the OperationalData map. + OperationalDataToDelete []*string + + // The importance of this OpsItem in relation to other OpsItems in the system. + Priority *int32 // One or more OpsItems that share something in common with the current OpsItems. // For example, related OpsItems can include OpsItems with similar error messages, // impacted resources, or statuses for the impacted resource. RelatedOpsItems []*types.RelatedOpsItem - // The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when - // this OpsItem is edited or changed. - Notifications []*types.OpsItemNotification - - // A short heading that describes the nature of the OpsItem and the impacted - // resource. - Title *string + // Specify a new severity for an OpsItem. + Severity *string // The OpsItem status. Status can be Open, In Progress, or Resolved. For more // information, see Editing OpsItem details @@ -121,11 +123,9 @@ type UpdateOpsItemInput struct { // in the AWS Systems Manager User Guide. Status types.OpsItemStatus - // The importance of this OpsItem in relation to other OpsItems in the system. - Priority *int32 - - // Specify a new severity for an OpsItem. - Severity *string + // A short heading that describes the nature of the OpsItem and the impacted + // resource. + Title *string } type UpdateOpsItemOutput struct { diff --git a/service/ssm/api_op_UpdatePatchBaseline.go b/service/ssm/api_op_UpdatePatchBaseline.go index e5e0d80adc6..fb78b76702e 100644 --- a/service/ssm/api_op_UpdatePatchBaseline.go +++ b/service/ssm/api_op_UpdatePatchBaseline.go @@ -61,26 +61,44 @@ func (c *Client) UpdatePatchBaseline(ctx context.Context, params *UpdatePatchBas type UpdatePatchBaselineInput struct { - // A list of explicitly rejected patches for the baseline. For information about + // The ID of the patch baseline to update. + // + // This member is required. + BaselineId *string + + // A set of rules used to include patches in the baseline. + ApprovalRules *types.PatchRuleGroup + + // A list of explicitly approved patches for the baseline. For information about // accepted formats for lists of approved patches and rejected patches, see About // package name formats for approved and rejected patch lists // (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) // in the AWS Systems Manager User Guide. - RejectedPatches []*string + ApprovedPatches []*string + + // Assigns a new compliance severity level to an existing patch baseline. + ApprovedPatchesComplianceLevel types.PatchComplianceLevel + + // Indicates whether the list of approved patches includes non-security updates + // that should be applied to the instances. The default value is 'false'. Applies + // to Linux instances only. + ApprovedPatchesEnableNonSecurity *bool + + // A description of the patch baseline. + Description *string // A set of global filters used to include patches in the baseline. GlobalFilters *types.PatchFilterGroup - // A list of explicitly approved patches for the baseline. For information about + // The name of the patch baseline. + Name *string + + // A list of explicitly rejected patches for the baseline. For information about // accepted formats for lists of approved patches and rejected patches, see About // package name formats for approved and rejected patch lists // (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) // in the AWS Systems Manager User Guide. - ApprovedPatches []*string - - // Information about the patches to use to update the instances, including target - // operating systems and source repositories. Applies to Linux instances only. - Sources []*types.PatchSource + RejectedPatches []*string // The action for Patch Manager to take on patches included in the RejectedPackages // list. @@ -97,83 +115,65 @@ type UpdatePatchBaselineInput struct { // patch baseline, and its status is reported as InstalledRejected. RejectedPatchesAction types.PatchAction - // A description of the patch baseline. - Description *string - // If True, then all fields that are required by the CreatePatchBaseline action are // also required for this API request. Optional fields that are not specified are // set to null. Replace *bool - // Assigns a new compliance severity level to an existing patch baseline. - ApprovedPatchesComplianceLevel types.PatchComplianceLevel - - // Indicates whether the list of approved patches includes non-security updates - // that should be applied to the instances. The default value is 'false'. Applies - // to Linux instances only. - ApprovedPatchesEnableNonSecurity *bool - - // A set of rules used to include patches in the baseline. - ApprovalRules *types.PatchRuleGroup - - // The ID of the patch baseline to update. - // - // This member is required. - BaselineId *string - - // The name of the patch baseline. - Name *string + // Information about the patches to use to update the instances, including target + // operating systems and source repositories. Applies to Linux instances only. + Sources []*types.PatchSource } type UpdatePatchBaselineOutput struct { - // Indicates whether the list of approved patches includes non-security updates - // that should be applied to the instances. The default value is 'false'. Applies - // to Linux instances only. - ApprovedPatchesEnableNonSecurity *bool - - // The date when the patch baseline was last modified. - ModifiedDate *time.Time - - // A list of explicitly rejected patches for the baseline. - RejectedPatches []*string - - // A list of explicitly approved patches for the baseline. - ApprovedPatches []*string - // A set of rules used to include patches in the baseline. ApprovalRules *types.PatchRuleGroup - // Information about the patches to use to update the instances, including target - // operating systems and source repositories. Applies to Linux instances only. - Sources []*types.PatchSource - - // The action specified to take on patches included in the RejectedPatches list. A - // patch can be allowed only if it is a dependency of another package, or blocked - // entirely along with packages that include it as a dependency. - RejectedPatchesAction types.PatchAction + // A list of explicitly approved patches for the baseline. + ApprovedPatches []*string // The compliance severity level assigned to the patch baseline after the update // completed. ApprovedPatchesComplianceLevel types.PatchComplianceLevel - // The name of the patch baseline. - Name *string + // Indicates whether the list of approved patches includes non-security updates + // that should be applied to the instances. The default value is 'false'. Applies + // to Linux instances only. + ApprovedPatchesEnableNonSecurity *bool + + // The ID of the deleted patch baseline. + BaselineId *string // The date when the patch baseline was created. CreatedDate *time.Time + // A description of the Patch Baseline. + Description *string + // A set of global filters used to exclude patches from the baseline. GlobalFilters *types.PatchFilterGroup - // The ID of the deleted patch baseline. - BaselineId *string + // The date when the patch baseline was last modified. + ModifiedDate *time.Time + + // The name of the patch baseline. + Name *string // The operating system rule used by the updated patch baseline. OperatingSystem types.OperatingSystem - // A description of the Patch Baseline. - Description *string + // A list of explicitly rejected patches for the baseline. + RejectedPatches []*string + + // The action specified to take on patches included in the RejectedPatches list. A + // patch can be allowed only if it is a dependency of another package, or blocked + // entirely along with packages that include it as a dependency. + RejectedPatchesAction types.PatchAction + + // Information about the patches to use to update the instances, including target + // operating systems and source repositories. Applies to Linux instances only. + Sources []*types.PatchSource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/ssm/api_op_UpdateResourceDataSync.go b/service/ssm/api_op_UpdateResourceDataSync.go index dda015b4770..1694633e741 100644 --- a/service/ssm/api_op_UpdateResourceDataSync.go +++ b/service/ssm/api_op_UpdateResourceDataSync.go @@ -63,6 +63,11 @@ func (c *Client) UpdateResourceDataSync(ctx context.Context, params *UpdateResou type UpdateResourceDataSyncInput struct { + // The name of the resource data sync you want to update. + // + // This member is required. + SyncName *string + // Specify information about the data sources to synchronize. // // This member is required. @@ -72,11 +77,6 @@ type UpdateResourceDataSyncInput struct { // // This member is required. SyncType *string - - // The name of the resource data sync you want to update. - // - // This member is required. - SyncName *string } type UpdateResourceDataSyncOutput struct { diff --git a/service/ssm/go.mod b/service/ssm/go.mod index 9b77c08bf3a..fdee0ac98a7 100644 --- a/service/ssm/go.mod +++ b/service/ssm/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/ssm go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/ssm/types/types.go b/service/ssm/types/types.go index 834bb37c704..069b5398c35 100644 --- a/service/ssm/types/types.go +++ b/service/ssm/types/types.go @@ -22,92 +22,127 @@ type AccountSharingInfo struct { // A server or VM that has been registered with AWS is called a managed instance. type Activation struct { - // A user defined description of the activation. - Description *string - - // The maximum number of managed instances that can be registered using this - // activation. - RegistrationLimit *int32 + // The ID created by Systems Manager when you submitted the activation. + ActivationId *string // The date the activation was created. CreatedDate *time.Time + // A name for the managed instance when it is created. + DefaultInstanceName *string + + // A user defined description of the activation. + Description *string + // The date when this activation can no longer be used to register managed // instances. ExpirationDate *time.Time - // A name for the managed instance when it is created. - DefaultInstanceName *string - // Whether or not the activation is expired. Expired *bool - // The ID created by Systems Manager when you submitted the activation. - ActivationId *string + // The Amazon Identity and Access Management (IAM) role to assign to the managed + // instance. + IamRole *string - // Tags assigned to the activation. - Tags []*Tag + // The maximum number of managed instances that can be registered using this + // activation. + RegistrationLimit *int32 // The number of managed instances already registered with this activation. RegistrationsCount *int32 - // The Amazon Identity and Access Management (IAM) role to assign to the managed - // instance. - IamRole *string + // Tags assigned to the activation. + Tags []*Tag } // Describes an association of a Systems Manager document and an instance. type Association struct { - // The instances targeted by the request to create an association. - Targets []*Target - - // The ID of the instance. - InstanceId *string - - // The association version. - AssociationVersion *string - // The ID created by the system when you create an association. An association is a // binding between a document and a set of targets with a schedule. AssociationId *string - // The name of the Systems Manager document. - Name *string + // The association name. + AssociationName *string + + // The association version. + AssociationVersion *string // The version of the document used in the association. DocumentVersion *string - // A cron expression that specifies a schedule when the association runs. - ScheduleExpression *string - - // The association name. - AssociationName *string + // The ID of the instance. + InstanceId *string // The date on which the association was last run. LastExecutionDate *time.Time + // The name of the Systems Manager document. + Name *string + // Information about the association. Overview *AssociationOverview + + // A cron expression that specifies a schedule when the association runs. + ScheduleExpression *string + + // The instances targeted by the request to create an association. + Targets []*Target } // Describes the parameters for a document. type AssociationDescription struct { + // By default, when you create a new associations, the system runs it immediately + // after it is created and then according to the schedule you specified. Specify + // this option if you don't want an association to run immediately after you create + // it. + ApplyOnlyAtCronInterval *bool + + // The association ID. + AssociationId *string + + // The association name. + AssociationName *string + + // The association version. + AssociationVersion *string + + // Specify the target for the association. This target is required for associations + // that use an Automation document and target resources by using rate controls. + AutomationTargetParameterName *string + + // The severity level that is assigned to the association. + ComplianceSeverity AssociationComplianceSeverity + + // The date when the association was made. + Date *time.Time + // The document version. DocumentVersion *string - // An S3 bucket where you want to store the output details of the request. - OutputLocation *InstanceAssociationOutputLocation - // The ID of the instance. InstanceId *string // The date on which the association was last run. LastExecutionDate *time.Time - // The association ID. - AssociationId *string + // The last date on which the association was successfully run. + LastSuccessfulExecutionDate *time.Time + + // The date when the association was last updated. + LastUpdateAssociationDate *time.Time + + // The maximum number of targets allowed to run the association at the same time. + // You can specify a number, for example 10, or a percentage of the target set, for + // example 10%. The default value is 100%, which means all targets run the + // association at the same time. If a new instance starts and attempts to run an + // association while Systems Manager is running MaxConcurrency associations, the + // association is allowed to run. During the next association interval, the new + // instance will process its association within the limit specified for + // MaxConcurrency. + MaxConcurrency *string // The number of errors that are allowed before the system stops sending requests // to run the association on additional targets. You can specify either an absolute @@ -123,49 +158,23 @@ type AssociationDescription struct { // one at a time. MaxErrors *string - // Specify the target for the association. This target is required for associations - // that use an Automation document and target resources by using rate controls. - AutomationTargetParameterName *string - - // A cron expression that specifies a schedule when the association runs. - ScheduleExpression *string - // The name of the Systems Manager document. Name *string - // The severity level that is assigned to the association. - ComplianceSeverity AssociationComplianceSeverity - - // The association name. - AssociationName *string - - // The maximum number of targets allowed to run the association at the same time. - // You can specify a number, for example 10, or a percentage of the target set, for - // example 10%. The default value is 100%, which means all targets run the - // association at the same time. If a new instance starts and attempts to run an - // association while Systems Manager is running MaxConcurrency associations, the - // association is allowed to run. During the next association interval, the new - // instance will process its association within the limit specified for - // MaxConcurrency. - MaxConcurrency *string - - // The association status. - Status *AssociationStatus + // An S3 bucket where you want to store the output details of the request. + OutputLocation *InstanceAssociationOutputLocation - // The association version. - AssociationVersion *string + // Information about the association. + Overview *AssociationOverview // A description of the parameters for a document. Parameters map[string][]*string - // The date when the association was last updated. - LastUpdateAssociationDate *time.Time + // A cron expression that specifies a schedule when the association runs. + ScheduleExpression *string - // By default, when you create a new associations, the system runs it immediately - // after it is created and then according to the schedule you specified. Specify - // this option if you don't want an association to run immediately after you create - // it. - ApplyOnlyAtCronInterval *bool + // The association status. + Status *AssociationStatus // The mode for generating association compliance. You can specify AUTO or MANUAL. // In AUTO mode, the system uses the status of the association execution to @@ -180,48 +189,44 @@ type AssociationDescription struct { // The instances targeted by the request. Targets []*Target - - // The last date on which the association was successfully run. - LastSuccessfulExecutionDate *time.Time - - // Information about the association. - Overview *AssociationOverview - - // The date when the association was made. - Date *time.Time } // Includes information about the specified association. type AssociationExecution struct { - // An aggregate status of the resources in the execution based on the status type. - ResourceCountByStatus *string - - // Detailed status information about the execution. - DetailedStatus *string + // The association ID. + AssociationId *string // The association version. AssociationVersion *string - // The status of the association execution. - Status *string - // The time the execution started. CreatedTime *time.Time + // Detailed status information about the execution. + DetailedStatus *string + + // The execution ID for the association. + ExecutionId *string + // The date of the last execution. LastExecutionDate *time.Time - // The association ID. - AssociationId *string + // An aggregate status of the resources in the execution based on the status type. + ResourceCountByStatus *string - // The execution ID for the association. - ExecutionId *string + // The status of the association execution. + Status *string } // Filters used in the request. type AssociationExecutionFilter struct { + // The key value used in the request. + // + // This member is required. + Key AssociationExecutionFilterKey + // The filter type specified in the request. // // This member is required. @@ -231,42 +236,37 @@ type AssociationExecutionFilter struct { // // This member is required. Value *string - - // The key value used in the request. - // - // This member is required. - Key AssociationExecutionFilterKey } // Includes information about the specified association execution. type AssociationExecutionTarget struct { - // Detailed information about the execution status. - DetailedStatus *string - // The association ID. AssociationId *string // The association version. AssociationVersion *string - // The resource ID, for example, the instance ID where the association ran. - ResourceId *string + // Detailed information about the execution status. + DetailedStatus *string - // The association execution status. - Status *string + // The execution ID. + ExecutionId *string // The date of the last execution. LastExecutionDate *time.Time + // The location where the association details are saved. + OutputSource *OutputSource + + // The resource ID, for example, the instance ID where the association ran. + ResourceId *string + // The resource type, for example, instance. ResourceType *string - // The execution ID. - ExecutionId *string - - // The location where the association details are saved. - OutputSource *OutputSource + // The association execution status. + Status *string } // Filters for the association execution. @@ -305,50 +305,74 @@ type AssociationOverview struct { // would return the count of instances by status. AssociationStatusAggregatedCount map[string]*int32 - // The status of the association. Status can be: Pending, Success, or Failed. - Status *string - // A detailed status of the association. DetailedStatus *string + + // The status of the association. Status can be: Pending, Success, or Failed. + Status *string } // Describes an association status. type AssociationStatus struct { - // The status. - // - // This member is required. - Name AssociationStatusName - // The date when the status changed. // // This member is required. Date *time.Time - // A user-defined string. - AdditionalInfo *string - // The reason for the status. // // This member is required. Message *string + + // The status. + // + // This member is required. + Name AssociationStatusName + + // A user-defined string. + AdditionalInfo *string } // Information about the association version. type AssociationVersionInfo struct { - // The name specified when the association was created. - Name *string + // By default, when you create a new associations, the system runs it immediately + // after it is created and then according to the schedule you specified. Specify + // this option if you don't want an association to run immediately after you create + // it. + ApplyOnlyAtCronInterval *bool + + // The ID created by the system when the association was created. + AssociationId *string + + // The name specified for the association version when the association version was + // created. + AssociationName *string // The association version. AssociationVersion *string - // The date the association version was created. - CreatedDate *time.Time - // The severity level that is assigned to the association. ComplianceSeverity AssociationComplianceSeverity + // The date the association version was created. + CreatedDate *time.Time + + // The version of a Systems Manager document used when the association version was + // created. + DocumentVersion *string + + // The maximum number of targets allowed to run the association at the same time. + // You can specify a number, for example 10, or a percentage of the target set, for + // example 10%. The default value is 100%, which means all targets run the + // association at the same time. If a new instance starts and attempts to run an + // association while Systems Manager is running MaxConcurrency associations, the + // association is allowed to run. During the next association interval, the new + // instance will process its association within the limit specified for + // MaxConcurrency. + MaxConcurrency *string + // The number of errors that are allowed before the system stops sending requests // to run the association on additional targets. You can specify either an absolute // number of errors, for example 10, or a percentage of the target set, for example @@ -363,44 +387,19 @@ type AssociationVersionInfo struct { // one at a time. MaxErrors *string - // The cron or rate schedule specified for the association when the association - // version was created. - ScheduleExpression *string + // The name specified when the association was created. + Name *string - // The name specified for the association version when the association version was - // created. - AssociationName *string + // The location in Amazon S3 specified for the association when the association + // version was created. + OutputLocation *InstanceAssociationOutputLocation // Parameters specified when the association version was created. Parameters map[string][]*string - // By default, when you create a new associations, the system runs it immediately - // after it is created and then according to the schedule you specified. Specify - // this option if you don't want an association to run immediately after you create - // it. - ApplyOnlyAtCronInterval *bool - - // The maximum number of targets allowed to run the association at the same time. - // You can specify a number, for example 10, or a percentage of the target set, for - // example 10%. The default value is 100%, which means all targets run the - // association at the same time. If a new instance starts and attempts to run an - // association while Systems Manager is running MaxConcurrency associations, the - // association is allowed to run. During the next association interval, the new - // instance will process its association within the limit specified for - // MaxConcurrency. - MaxConcurrency *string - - // The version of a Systems Manager document used when the association version was - // created. - DocumentVersion *string - - // The location in Amazon S3 specified for the association when the association + // The cron or rate schedule specified for the association when the association // version was created. - OutputLocation *InstanceAssociationOutputLocation - - // The targets specified for the association when the association version was - // created. - Targets []*Target + ScheduleExpression *string // The mode for generating association compliance. You can specify AUTO or MANUAL. // In AUTO mode, the system uses the status of the association execution to @@ -413,27 +412,28 @@ type AssociationVersionInfo struct { // associations use AUTO mode. SyncCompliance AssociationSyncCompliance - // The ID created by the system when the association was created. - AssociationId *string + // The targets specified for the association when the association version was + // created. + Targets []*Target } // A structure that includes attributes that describe a document attachment. type AttachmentContent struct { - // The name of an attachment. - Name *string - // The cryptographic hash value of the document content. Hash *string - // The URL location of the attachment content. - Url *string - // The hash algorithm used to calculate the hash value. HashType AttachmentHashType + // The name of an attachment. + Name *string + // The size of an attachment in bytes. Size *int64 + + // The URL location of the attachment content. + Url *string } // An attribute of an attachment, such as the attachment name. @@ -447,13 +447,13 @@ type AttachmentInformation struct { // a key-value pair that identifies the location of an attachment to a document. type AttachmentsSource struct { - // The name of the document attachment file. - Name *string - // The key of a key-value pair that identifies the location of an attachment to a // document. Key AttachmentsSourceKey + // The name of the document attachment file. + Name *string + // The value of a key-value pair that identifies the location of an attachment to a // document. The format for Value depends on the type of key you specify. // @@ -481,88 +481,88 @@ type AttachmentsSource struct { // execution. type AutomationExecution struct { - // The MaxErrors value specified by the user when the execution started. - MaxErrors *string - - // A list of resolved targets in the rate control execution. - ResolvedTargets *ResolvedTargets + // The execution ID. + AutomationExecutionId *string - // The time the execution started. - ExecutionStartTime *time.Time + // The execution status of the Automation. + AutomationExecutionStatus AutomationExecutionStatus // The action of the step that is currently running. CurrentAction *string - // The combination of AWS Regions and/or AWS accounts where you want to run the - // Automation. - TargetLocations []*TargetLocation + // The name of the step that is currently running. + CurrentStepName *string + + // The name of the Automation document used during the execution. + DocumentName *string // The version of the document to use during execution. DocumentVersion *string + // The Amazon Resource Name (ARN) of the user who ran the automation. + ExecutedBy *string + + // The time the execution finished. + ExecutionEndTime *time.Time + + // The time the execution started. + ExecutionStartTime *time.Time + // A message describing why an execution has failed, if the status is set to // Failed. FailureMessage *string - // The specified targets. - Targets []*Target - - // The parameter name. - TargetParameterName *string + // The MaxConcurrency value specified by the user when the execution started. + MaxConcurrency *string - // The specified key-value mapping of document parameters to target resources. - TargetMaps []map[string][]*string + // The MaxErrors value specified by the user when the execution started. + MaxErrors *string - // The key-value map of execution parameters, which were supplied when calling - // StartAutomationExecution. - Parameters map[string][]*string + // The automation execution mode. + Mode ExecutionMode // The list of execution outputs as defined in the automation document. Outputs map[string][]*string - // The name of the step that is currently running. - CurrentStepName *string - - // The MaxConcurrency value specified by the user when the execution started. - MaxConcurrency *string - - // The automation execution mode. - Mode ExecutionMode + // The key-value map of execution parameters, which were supplied when calling + // StartAutomationExecution. + Parameters map[string][]*string // The AutomationExecutionId of the parent automation. ParentAutomationExecutionId *string - // The name of the Automation document used during the execution. - DocumentName *string + // An aggregate of step execution statuses displayed in the AWS Console for a + // multi-Region and multi-account Automation execution. + ProgressCounters *ProgressCounters - // The Amazon Resource Name (ARN) of the user who ran the automation. - ExecutedBy *string + // A list of resolved targets in the rate control execution. + ResolvedTargets *ResolvedTargets + + // A list of details about the current state of all steps that comprise an + // execution. An Automation document contains a list of steps that are run in + // order. + StepExecutions []*StepExecution // A boolean value that indicates if the response contains the full list of the // Automation step executions. If true, use the DescribeAutomationStepExecutions // API action to get the full list of step executions. StepExecutionsTruncated *bool - // The execution status of the Automation. - AutomationExecutionStatus AutomationExecutionStatus - - // The execution ID. - AutomationExecutionId *string - // The target of the execution. Target *string - // A list of details about the current state of all steps that comprise an - // execution. An Automation document contains a list of steps that are run in - // order. - StepExecutions []*StepExecution + // The combination of AWS Regions and/or AWS accounts where you want to run the + // Automation. + TargetLocations []*TargetLocation - // The time the execution finished. - ExecutionEndTime *time.Time + // The specified key-value mapping of document parameters to target resources. + TargetMaps []map[string][]*string - // An aggregate of step execution statuses displayed in the AWS Console for a - // multi-Region and multi-account Automation execution. - ProgressCounters *ProgressCounters + // The parameter name. + TargetParameterName *string + + // The specified targets. + Targets []*Target } // A filter used to match specific automation executions. This is used to limit the @@ -586,14 +586,11 @@ type AutomationExecutionFilter struct { // Details about a specific Automation execution. type AutomationExecutionMetadata struct { - // The ExecutionId of the parent Automation. - ParentAutomationExecutionId *string - // The execution ID. AutomationExecutionId *string - // A list of targets that resolved during the execution. - ResolvedTargets *ResolvedTargets + // The status of the execution. + AutomationExecutionStatus AutomationExecutionStatus // Use this filter with DescribeAutomationExecutions (). Specify either Local or // CrossAccount. CrossAccount is an Automation that runs in multiple AWS Regions @@ -603,8 +600,8 @@ type AutomationExecutionMetadata struct { // in the AWS Systems Manager User Guide. AutomationType AutomationType - // The IAM role ARN of the user who ran the Automation. - ExecutedBy *string + // The action of the step that is currently running. + CurrentAction *string // The name of the step that is currently running. CurrentStepName *string @@ -612,30 +609,27 @@ type AutomationExecutionMetadata struct { // The name of the Automation document used during execution. DocumentName *string - // The MaxConcurrency value specified by the user when starting the Automation. - MaxConcurrency *string - - // The list of execution outputs as defined in the Automation document. - TargetParameterName *string + // The document version used during the execution. + DocumentVersion *string - // An S3 bucket where execution information is stored. - LogFile *string + // The IAM role ARN of the user who ran the Automation. + ExecutedBy *string // The time the execution finished. This is not populated if the execution is still // in progress. ExecutionEndTime *time.Time - // The list of execution outputs as defined in the Automation document. - Target *string - - // The status of the execution. - AutomationExecutionStatus AutomationExecutionStatus + // The time the execution started. + ExecutionStartTime *time.Time // The list of execution outputs as defined in the Automation document. - Outputs map[string][]*string + FailureMessage *string - // The action of the step that is currently running. - CurrentAction *string + // An S3 bucket where execution information is stored. + LogFile *string + + // The MaxConcurrency value specified by the user when starting the Automation. + MaxConcurrency *string // The MaxErrors value specified by the user when starting the Automation. MaxErrors *string @@ -643,17 +637,23 @@ type AutomationExecutionMetadata struct { // The Automation execution mode. Mode ExecutionMode - // The specified key-value mapping of document parameters to target resources. - TargetMaps []map[string][]*string + // The list of execution outputs as defined in the Automation document. + Outputs map[string][]*string + + // The ExecutionId of the parent Automation. + ParentAutomationExecutionId *string + + // A list of targets that resolved during the execution. + ResolvedTargets *ResolvedTargets // The list of execution outputs as defined in the Automation document. - FailureMessage *string + Target *string - // The document version used during the execution. - DocumentVersion *string + // The specified key-value mapping of document parameters to target resources. + TargetMaps []map[string][]*string - // The time the execution started. - ExecutionStartTime *time.Time + // The list of execution outputs as defined in the Automation document. + TargetParameterName *string // The targets defined by the user when starting the Automation. Targets []*Target @@ -675,65 +675,49 @@ type CloudWatchOutputConfig struct { // Describes a command request. type Command struct { + // CloudWatch Logs information where you want Systems Manager to send the command + // output. + CloudWatchOutputConfig *CloudWatchOutputConfig + // A unique identifier for this command. CommandId *string - // The S3 directory path inside the bucket where the responses to the command - // executions should be stored. This was requested when issuing the command. - OutputS3KeyPrefix *string + // User-specified information about the command, such as a brief description of + // what the command should do. + Comment *string - // The TimeoutSeconds value specified for a command. - TimeoutSeconds *int32 + // The number of targets for which the command invocation reached a terminal state. + // Terminal states include the following: Success, Failed, Execution Timed Out, + // Delivery Timed Out, Canceled, Terminated, or Undeliverable. + CompletedCount *int32 + + // The number of targets for which the status is Delivery Timed Out. + DeliveryTimedOutCount *int32 // The name of the document requested for execution. DocumentName *string - // The S3 bucket where the responses to the command executions should be stored. - // This was requested when issuing the command. - OutputS3BucketName *string + // The SSM document version. + DocumentVersion *string - // CloudWatch Logs information where you want Systems Manager to send the command - // output. - CloudWatchOutputConfig *CloudWatchOutputConfig - - // The IAM service role that Run Command uses to act on your behalf when sending - // notifications about command status changes. - ServiceRole *string + // The number of targets for which the status is Failed or Execution Timed Out. + ErrorCount *int32 // If this time is reached and the command has not already started running, it will // not run. Calculated based on the ExpiresAfter user input provided as part of the // SendCommand API. ExpiresAfter *time.Time - // The date and time the command was requested. - RequestedDateTime *time.Time - // The instance IDs against which this command was requested. InstanceIds []*string - // The SSM document version. - DocumentVersion *string - - // The status of the command. - Status CommandStatus - - // An array of search criteria that targets instances using a Key,Value combination - // that you specify. Targets is required if you don't provide one or more instance - // IDs in the call. - Targets []*Target - - // Configurations for sending notifications about command status changes. - NotificationConfig *NotificationConfig - - // The number of targets for which the status is Failed or Execution Timed Out. - ErrorCount *int32 - - // User-specified information about the command, such as a brief description of - // what the command should do. - Comment *string - - // The number of targets for which the status is Delivery Timed Out. - DeliveryTimedOutCount *int32 + // The maximum number of instances that are allowed to run the command at the same + // time. You can specify a number of instances, such as 10, or a percentage of + // instances, such as 10%. The default value is 50. For more information about how + // to use MaxConcurrency, see Running commands using Systems Manager Run Command + // (https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html) + // in the AWS Systems Manager User Guide. + MaxConcurrency *string // The maximum number of errors allowed before the system stops sending the command // to additional targets. You can specify a number of errors, such as 10, or a @@ -744,16 +728,33 @@ type Command struct { // in the AWS Systems Manager User Guide. MaxErrors *string + // Configurations for sending notifications about command status changes. + NotificationConfig *NotificationConfig + + // The S3 bucket where the responses to the command executions should be stored. + // This was requested when issuing the command. + OutputS3BucketName *string + + // The S3 directory path inside the bucket where the responses to the command + // executions should be stored. This was requested when issuing the command. + OutputS3KeyPrefix *string + + // (Deprecated) You can no longer specify this parameter. The system ignores it. + // Instead, Systems Manager automatically determines the Region of the S3 bucket. + OutputS3Region *string + // The parameter values to be inserted in the document when running the command. Parameters map[string][]*string - // The number of targets for the command. - TargetCount *int32 + // The date and time the command was requested. + RequestedDateTime *time.Time - // The number of targets for which the command invocation reached a terminal state. - // Terminal states include the following: Success, Failed, Execution Timed Out, - // Delivery Timed Out, Canceled, Terminated, or Undeliverable. - CompletedCount *int32 + // The IAM service role that Run Command uses to act on your behalf when sending + // notifications about command status changes. + ServiceRole *string + + // The status of the command. + Status CommandStatus // A detailed status of the command execution. StatusDetails includes more // information than Status because it includes states resulting from error and @@ -798,17 +799,16 @@ type Command struct { // before running it on any instance. This is a terminal state. StatusDetails *string - // (Deprecated) You can no longer specify this parameter. The system ignores it. - // Instead, Systems Manager automatically determines the Region of the S3 bucket. - OutputS3Region *string + // The number of targets for the command. + TargetCount *int32 - // The maximum number of instances that are allowed to run the command at the same - // time. You can specify a number of instances, such as 10, or a percentage of - // instances, such as 10%. The default value is 50. For more information about how - // to use MaxConcurrency, see Running commands using Systems Manager Run Command - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html) - // in the AWS Systems Manager User Guide. - MaxConcurrency *string + // An array of search criteria that targets instances using a Key,Value combination + // that you specify. Targets is required if you don't provide one or more instance + // IDs in the call. + Targets []*Target + + // The TimeoutSeconds value specified for a command. + TimeoutSeconds *int32 } // Describes a command filter. An instance ID can't be specified when a command @@ -876,54 +876,48 @@ type CommandFilter struct { // returns status and detail information about a command you ran. type CommandInvocation struct { + // CloudWatch Logs information where you want Systems Manager to send the command + // output. + CloudWatchOutputConfig *CloudWatchOutputConfig + // The command against which this invocation was requested. CommandId *string - // The name of the invocation target. For EC2 instances this is the value for the - // aws:Name tag. For on-premises instances, this is the name of the instance. - InstanceName *string + CommandPlugins []*CommandPlugin - // The URL to the plugin's StdErr file in Amazon S3, if the S3 bucket was defined - // for the parent command. For an invocation, StandardErrorUrl is populated if - // there is just one plugin defined for the command, and the S3 bucket was defined - // for the command. - StandardErrorUrl *string + // User-specified information about the command, such as a brief description of + // what the command should do. + Comment *string // The document name that was requested for execution. DocumentName *string - // The time and date the request was sent to this instance. - RequestedDateTime *time.Time - - // The IAM service role that Run Command uses to act on your behalf when sending - // notifications about command status changes on a per instance basis. - ServiceRole *string - - CommandPlugins []*CommandPlugin - - // Whether or not the invocation succeeded, failed, or is pending. - Status CommandInvocationStatus - - // CloudWatch Logs information where you want Systems Manager to send the command - // output. - CloudWatchOutputConfig *CloudWatchOutputConfig + // The SSM document version. + DocumentVersion *string // The instance ID in which this invocation was requested. InstanceId *string + // The name of the invocation target. For EC2 instances this is the value for the + // aws:Name tag. For on-premises instances, this is the name of the instance. + InstanceName *string + // Configurations for sending notifications about command status changes on a per // instance basis. NotificationConfig *NotificationConfig - // Gets the trace output sent by the agent. - TraceOutput *string + // The time and date the request was sent to this instance. + RequestedDateTime *time.Time - // The SSM document version. - DocumentVersion *string + // The IAM service role that Run Command uses to act on your behalf when sending + // notifications about command status changes on a per instance basis. + ServiceRole *string - // User-specified information about the command, such as a brief description of - // what the command should do. - Comment *string + // The URL to the plugin's StdErr file in Amazon S3, if the S3 bucket was defined + // for the parent command. For an invocation, StandardErrorUrl is populated if + // there is just one plugin defined for the command, and the S3 bucket was defined + // for the command. + StandardErrorUrl *string // The URL to the plugin's StdOut file in Amazon S3, if the S3 bucket was defined // for the parent command. For an invocation, StandardOutputUrl is populated if @@ -931,6 +925,9 @@ type CommandInvocation struct { // for the command. StandardOutputUrl *string + // Whether or not the invocation succeeded, failed, or is pending. + Status CommandInvocationStatus + // A detailed status of the command execution for each invocation (each instance // targeted by the command). StatusDetails includes more information than Status // because it includes states resulting from error and concurrency control @@ -980,11 +977,65 @@ type CommandInvocation struct { // subsequent command invocations were canceled by the system. This is a terminal // state. StatusDetails *string + + // Gets the trace output sent by the agent. + TraceOutput *string } // Describes plugin details. type CommandPlugin struct { + // The name of the plugin. Must be one of the following: aws:updateAgent, + // aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, + // aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent. + Name *string + + // Output of the plugin execution. + Output *string + + // The S3 bucket where the responses to the command executions should be stored. + // This was requested when issuing the command. For example, in the following + // response: + // test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript + // test_folder is the name of the S3 bucket; + // ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix; + // i-1234567876543 is the instance ID; awsrunShellScript is the name of the plugin. + OutputS3BucketName *string + + // The S3 directory path inside the bucket where the responses to the command + // executions should be stored. This was requested when issuing the command. For + // example, in the following response: + // test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript + // test_folder is the name of the S3 bucket; + // ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix; + // i-1234567876543 is the instance ID; awsrunShellScript is the name of the plugin. + OutputS3KeyPrefix *string + + // (Deprecated) You can no longer specify this parameter. The system ignores it. + // Instead, Systems Manager automatically determines the S3 bucket region. + OutputS3Region *string + + // A numeric response code generated after running the plugin. + ResponseCode *int32 + + // The time the plugin stopped running. Could stop prematurely if, for example, a + // cancel command was sent. + ResponseFinishDateTime *time.Time + + // The time the plugin started running. + ResponseStartDateTime *time.Time + + // The URL for the complete text written by the plugin to stderr. If execution is + // not yet complete, then this string is empty. + StandardErrorUrl *string + + // The URL for the complete text written by the plugin to stdout in Amazon S3. If + // the S3 bucket for the command was not specified, then this string is empty. + StandardOutputUrl *string + + // The status of this plugin. You can run a document with multiple plugins. + Status CommandPluginStatus + // A detailed status of the plugin execution. StatusDetails includes more // information than Status because it includes states resulting from error and // concurrency control parameters. StatusDetails can show different results than @@ -1034,57 +1085,6 @@ type CommandPlugin struct { // MaxErrors limit and subsequent command invocations were canceled by the system. // This is a terminal state. StatusDetails *string - - // The status of this plugin. You can run a document with multiple plugins. - Status CommandPluginStatus - - // The time the plugin stopped running. Could stop prematurely if, for example, a - // cancel command was sent. - ResponseFinishDateTime *time.Time - - // Output of the plugin execution. - Output *string - - // The time the plugin started running. - ResponseStartDateTime *time.Time - - // A numeric response code generated after running the plugin. - ResponseCode *int32 - - // (Deprecated) You can no longer specify this parameter. The system ignores it. - // Instead, Systems Manager automatically determines the S3 bucket region. - OutputS3Region *string - - // The URL for the complete text written by the plugin to stdout in Amazon S3. If - // the S3 bucket for the command was not specified, then this string is empty. - StandardOutputUrl *string - - // The S3 directory path inside the bucket where the responses to the command - // executions should be stored. This was requested when issuing the command. For - // example, in the following response: - // test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript - // test_folder is the name of the S3 bucket; - // ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix; - // i-1234567876543 is the instance ID; awsrunShellScript is the name of the plugin. - OutputS3KeyPrefix *string - - // The name of the plugin. Must be one of the following: aws:updateAgent, - // aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, - // aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent. - Name *string - - // The S3 bucket where the responses to the command executions should be stored. - // This was requested when issuing the command. For example, in the following - // response: - // test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript - // test_folder is the name of the S3 bucket; - // ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix; - // i-1234567876543 is the instance ID; awsrunShellScript is the name of the plugin. - OutputS3BucketName *string - - // The URL for the complete text written by the plugin to stderr. If execution is - // not yet complete, then this string is empty. - StandardErrorUrl *string } // A summary of the call execution that includes an execution ID, the type of @@ -1092,18 +1092,18 @@ type CommandPlugin struct { // datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'. type ComplianceExecutionSummary struct { + // The time the execution ran as a datetime object that is saved in the following + // format: yyyy-MM-dd'T'HH:mm:ss'Z'. + // + // This member is required. + ExecutionTime *time.Time + // An ID created by the system when PutComplianceItems was called. For example, // CommandID is a valid execution ID. You can use this ID in subsequent calls. ExecutionId *string // The type of execution. For example, Command is a valid execution type. ExecutionType *string - - // The time the execution ran as a datetime object that is saved in the following - // format: yyyy-MM-dd'T'HH:mm:ss'Z'. - // - // This member is required. - ExecutionTime *time.Time } // Information about the compliance as defined by the resource type. For example, @@ -1111,8 +1111,12 @@ type ComplianceExecutionSummary struct { // Classification, and so on. type ComplianceItem struct { - // An ID for the resource. For a managed instance, this is the instance ID. - ResourceId *string + // The compliance type. For example, Association (for a State Manager association), + // Patch, or Custom:string are all valid compliance types. + ComplianceType *string + + // A "Key": "Value" tag combination for the compliance item. + Details map[string]*string // A summary for the compliance item. The summary includes an execution ID, the // execution type (for example, command), and the execution time. @@ -1122,67 +1126,63 @@ type ComplianceItem struct { // patch, the ID could be the number of the KB article; for example: KB4010320. Id *string - // A "Key": "Value" tag combination for the compliance item. - Details map[string]*string - - // A title for the compliance item. For example, if the compliance item is a - // Windows patch, the title could be the title of the KB article for the patch; for - // example: Security Update for Active Directory Federation Services. - Title *string - - // The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT. - Status ComplianceStatus + // An ID for the resource. For a managed instance, this is the instance ID. + ResourceId *string - // The compliance type. For example, Association (for a State Manager association), - // Patch, or Custom:string are all valid compliance types. - ComplianceType *string + // The type of resource. ManagedInstance is currently the only supported resource + // type. + ResourceType *string // The severity of the compliance status. Severity can be one of the following: // Critical, High, Medium, Low, Informational, Unspecified. Severity ComplianceSeverity - // The type of resource. ManagedInstance is currently the only supported resource - // type. - ResourceType *string + // The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT. + Status ComplianceStatus + + // A title for the compliance item. For example, if the compliance item is a + // Windows patch, the title could be the title of the KB article for the patch; for + // example: Security Update for Active Directory Federation Services. + Title *string } // Information about a compliance item. type ComplianceItemEntry struct { - // A "Key": "Value" tag combination for the compliance item. - Details map[string]*string + // The severity of the compliance status. Severity can be one of the following: + // Critical, High, Medium, Low, Informational, Unspecified. + // + // This member is required. + Severity ComplianceSeverity // The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT. // // This member is required. Status ComplianceStatus - // The severity of the compliance status. Severity can be one of the following: - // Critical, High, Medium, Low, Informational, Unspecified. - // - // This member is required. - Severity ComplianceSeverity + // A "Key": "Value" tag combination for the compliance item. + Details map[string]*string + + // The compliance item ID. For example, if the compliance item is a Windows patch, + // the ID could be the number of the KB article. + Id *string // The title of the compliance item. For example, if the compliance item is a // Windows patch, the title could be the title of the KB article for the patch; for // example: Security Update for Active Directory Federation Services. Title *string - - // The compliance item ID. For example, if the compliance item is a Windows patch, - // the ID could be the number of the KB article. - Id *string } // One or more filters. Use a filter to return a more specific list of results. type ComplianceStringFilter struct { + // The name of the filter. + Key *string + // The type of comparison that should be performed for the value: Equal, NotEqual, // BeginWith, LessThan, or GreaterThan. Type ComplianceQueryOperatorType - // The name of the filter. - Key *string - // The value for which to search. Values []*string } @@ -1194,40 +1194,27 @@ type ComplianceSummaryItem struct { // Association, Patch, or Custom:string. ComplianceType *string - // A list of NON_COMPLIANT items for the specified compliance type. - NonCompliantSummary *NonCompliantSummary - // A list of COMPLIANT items for the specified compliance type. CompliantSummary *CompliantSummary + + // A list of NON_COMPLIANT items for the specified compliance type. + NonCompliantSummary *NonCompliantSummary } // A summary of resources that are compliant. The summary is organized according to // the resource count for each compliance type. type CompliantSummary struct { - // A summary of the compliance severity by compliance type. - SeveritySummary *SeveritySummary - // The total number of resources that are compliant. CompliantCount *int32 + + // A summary of the compliance severity by compliance type. + SeveritySummary *SeveritySummary } // Describes the association of a Systems Manager SSM document and an instance. type CreateAssociationBatchRequestEntry struct { - // The instances targeted by the request. - Targets []*Target - - // The ID of the instance. - InstanceId *string - - // Specify the target for the association. This target is required for associations - // that use an Automation document and target resources by using rate controls. - AutomationTargetParameterName *string - - // The document version. - DocumentVersion *string - // The name of the SSM document that contains the configuration information for the // instance. You can specify Command or Automation documents. You can specify // AWS-predefined documents, documents you created, or a document that is shared @@ -1242,14 +1229,37 @@ type CreateAssociationBatchRequestEntry struct { // This member is required. Name *string - // The severity level to assign to the association. - ComplianceSeverity AssociationComplianceSeverity + // By default, when you create a new associations, the system runs it immediately + // after it is created and then according to the schedule you specified. Specify + // this option if you don't want an association to run immediately after you create + // it. + ApplyOnlyAtCronInterval *bool // Specify a descriptive name for the association. AssociationName *string - // A cron expression that specifies a schedule when the association runs. - ScheduleExpression *string + // Specify the target for the association. This target is required for associations + // that use an Automation document and target resources by using rate controls. + AutomationTargetParameterName *string + + // The severity level to assign to the association. + ComplianceSeverity AssociationComplianceSeverity + + // The document version. + DocumentVersion *string + + // The ID of the instance. + InstanceId *string + + // The maximum number of targets allowed to run the association at the same time. + // You can specify a number, for example 10, or a percentage of the target set, for + // example 10%. The default value is 100%, which means all targets run the + // association at the same time. If a new instance starts and attempts to run an + // association while Systems Manager is running MaxConcurrency associations, the + // association is allowed to run. During the next association interval, the new + // instance will process its association within the limit specified for + // MaxConcurrency. + MaxConcurrency *string // The number of errors that are allowed before the system stops sending requests // to run the association on additional targets. You can specify either an absolute @@ -1265,15 +1275,14 @@ type CreateAssociationBatchRequestEntry struct { // one at a time. MaxErrors *string - // The maximum number of targets allowed to run the association at the same time. - // You can specify a number, for example 10, or a percentage of the target set, for - // example 10%. The default value is 100%, which means all targets run the - // association at the same time. If a new instance starts and attempts to run an - // association while Systems Manager is running MaxConcurrency associations, the - // association is allowed to run. During the next association interval, the new - // instance will process its association within the limit specified for - // MaxConcurrency. - MaxConcurrency *string + // An S3 bucket where you want to store the results of this request. + OutputLocation *InstanceAssociationOutputLocation + + // A description of the parameters for a document. + Parameters map[string][]*string + + // A cron expression that specifies a schedule when the association runs. + ScheduleExpression *string // The mode for generating association compliance. You can specify AUTO or MANUAL. // In AUTO mode, the system uses the status of the association execution to @@ -1286,17 +1295,8 @@ type CreateAssociationBatchRequestEntry struct { // associations use AUTO mode. SyncCompliance AssociationSyncCompliance - // A description of the parameters for a document. - Parameters map[string][]*string - - // An S3 bucket where you want to store the results of this request. - OutputLocation *InstanceAssociationOutputLocation - - // By default, when you create a new associations, the system runs it immediately - // after it is created and then according to the schedule you specified. Specify - // this option if you don't want an association to run immediately after you create - // it. - ApplyOnlyAtCronInterval *bool + // The instances targeted by the request. + Targets []*Target } // Filter for the DescribeActivation API. @@ -1312,25 +1312,19 @@ type DescribeActivationsFilter struct { // A default version of a document. type DocumentDefaultVersionDescription struct { - // The name of the document. - Name *string + // The default version of the document. + DefaultVersion *string // The default version of the artifact associated with the document. DefaultVersionName *string - // The default version of the document. - DefaultVersion *string + // The name of the document. + Name *string } // Describes a Systems Manager document. type DocumentDescription struct { - // The schema version. - SchemaVersion *string - - // The AWS user account that created the document. - Owner *string - // Details about the document attachments, including names, locations, sizes, and // so on. AttachmentsInformation []*AttachmentInformation @@ -1341,46 +1335,54 @@ type DocumentDescription struct { // The default version. DefaultVersion *string - // A list of SSM documents required by a document. For example, an - // ApplicationConfiguration document requires an ApplicationConfigurationSchema - // document. - Requires []*DocumentRequires - - // The list of OS platforms compatible with this Systems Manager document. - PlatformTypes []PlatformType - // A description of the document. Description *string - // The status of the Systems Manager document. - Status DocumentStatus - - // The version of the artifact associated with the document. - VersionName *string + // The document format, either JSON or YAML. + DocumentFormat DocumentFormat - // The target type which defines the kinds of resources the document can run on. - // For example, /AWS::EC2::Instance. For a list of valid resource types, see AWS - // resource and property types reference - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) - // in the AWS CloudFormation User Guide. - TargetType *string + // The type of document. + DocumentType DocumentType // The document version. DocumentVersion *string - // The document format, either JSON or YAML. - DocumentFormat DocumentFormat + // The Sha256 or Sha1 hash created by the system when the document was created. + // Sha1 hashes have been deprecated. + Hash *string + + // The hash type of the document. Valid values include Sha256 or Sha1. Sha1 hashes + // have been deprecated. + HashType DocumentHashType + + // The latest version of the document. + LatestVersion *string + + // The name of the Systems Manager document. + Name *string + + // The AWS user account that created the document. + Owner *string + + // A description of the parameters for a document. + Parameters []*DocumentParameter + + // The list of OS platforms compatible with this Systems Manager document. + PlatformTypes []PlatformType + + // A list of SSM documents required by a document. For example, an + // ApplicationConfiguration document requires an ApplicationConfigurationSchema + // document. + Requires []*DocumentRequires - // The tags, or metadata, that have been applied to the document. - Tags []*Tag + // The schema version. + SchemaVersion *string - // The hash type of the document. Valid values include Sha256 or Sha1. Sha1 hashes - // have been deprecated. - HashType DocumentHashType + // The SHA1 hash of the document, which you can use for verification. + Sha1 *string - // The Sha256 or Sha1 hash created by the system when the document was created. - // Sha1 hashes have been deprecated. - Hash *string + // The status of the Systems Manager document. + Status DocumentStatus // A message returned by AWS Systems Manager that explains the Status value. For // example, a Failed status might be explained by the StatusInformation message, @@ -1388,20 +1390,18 @@ type DocumentDescription struct { // correct." StatusInformation *string - // The SHA1 hash of the document, which you can use for verification. - Sha1 *string - - // The latest version of the document. - LatestVersion *string - - // A description of the parameters for a document. - Parameters []*DocumentParameter + // The tags, or metadata, that have been applied to the document. + Tags []*Tag - // The name of the Systems Manager document. - Name *string + // The target type which defines the kinds of resources the document can run on. + // For example, /AWS::EC2::Instance. For a list of valid resource types, see AWS + // resource and property types reference + // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) + // in the AWS CloudFormation User Guide. + TargetType *string - // The type of document. - DocumentType DocumentType + // The version of the artifact associated with the document. + VersionName *string } // This data type is deprecated. Instead, use DocumentKeyValuesFilter (). @@ -1421,20 +1421,35 @@ type DocumentFilter struct { // Describes the name of a Systems Manager document. type DocumentIdentifier struct { - // The AWS user account that created the document. - Owner *string - // The document format, either JSON or YAML. DocumentFormat DocumentFormat - // The schema version. - SchemaVersion *string + // The document type. + DocumentType DocumentType + + // The document version. + DocumentVersion *string + + // The name of the Systems Manager document. + Name *string + + // The AWS user account that created the document. + Owner *string + + // The operating system platform. + PlatformTypes []PlatformType // A list of SSM documents required by a document. For example, an // ApplicationConfiguration document requires an ApplicationConfigurationSchema // document. Requires []*DocumentRequires + // The schema version. + SchemaVersion *string + + // The tags, or metadata, that have been applied to the document. + Tags []*Tag + // The target type which defines the kinds of resources the document can run on. // For example, /AWS::EC2::Instance. For a list of valid resource types, see AWS // resource and property types reference @@ -1442,25 +1457,10 @@ type DocumentIdentifier struct { // in the AWS CloudFormation User Guide. TargetType *string - // The document type. - DocumentType DocumentType - // An optional field specifying the version of the artifact associated with the // document. For example, "Release 12, Update 6". This value is unique across all // versions of a document, and cannot be changed. VersionName *string - - // The document version. - DocumentVersion *string - - // The operating system platform. - PlatformTypes []PlatformType - - // The tags, or metadata, that have been applied to the document. - Tags []*Tag - - // The name of the Systems Manager document. - Name *string } // One or more filters. Use a filter to return a more specific list of documents. @@ -1480,17 +1480,21 @@ type DocumentIdentifier struct { // Key=Owner,Values=Self type DocumentKeyValuesFilter struct { - // The value for the filter key. - Values []*string - // The name of the filter key. Key *string + + // The value for the filter key. + Values []*string } // Parameters specified in a System Manager document that run on the server when // the command is run. type DocumentParameter struct { + // If specified, the default values for the parameters. Parameters without a + // default value are required. Parameters with a default value are optional. + DefaultValue *string + // A description of what the parameter does, how to use it, the default value, and // whether or not the parameter is optional. Description *string @@ -1500,10 +1504,6 @@ type DocumentParameter struct { // The type of parameter. The type can be either String or StringList. Type DocumentParameterType - - // If specified, the default values for the parameters. Parameters without a - // default value are required. Parameters with a default value are optional. - DefaultValue *string } // An SSM document required by the current document. @@ -1522,18 +1522,21 @@ type DocumentRequires struct { // Version information about the document. type DocumentVersionInfo struct { - // The document version. - DocumentVersion *string - - // The document name. - Name *string - // The date the document was created. CreatedDate *time.Time // The document format, either JSON or YAML. DocumentFormat DocumentFormat + // The document version. + DocumentVersion *string + + // An identifier for the default version of the document. + IsDefaultVersion *bool + + // The document name. + Name *string + // The status of the Systems Manager document, such as Creating, Active, Failed, // and Deleting. Status DocumentStatus @@ -1548,9 +1551,6 @@ type DocumentVersionInfo struct { // 12, Update 6". This value is unique across all versions of a document, and // cannot be changed. VersionName *string - - // An identifier for the default version of the document. - IsDefaultVersion *bool } // The EffectivePatch structure defines metadata about a patch along with the @@ -1560,29 +1560,29 @@ type DocumentVersionInfo struct { // patch was or will be approved. type EffectivePatch struct { + // Provides metadata for a patch, including information such as the KB ID, + // severity, classification and a URL for where more information can be obtained + // about the patch. + Patch *Patch + // The status of the patch in a patch baseline. This includes information about // whether the patch is currently approved, due to be approved by a rule, // explicitly approved, or explicitly rejected and the date the patch was or will // be approved. PatchStatus *PatchStatus - - // Provides metadata for a patch, including information such as the KB ID, - // severity, classification and a URL for where more information can be obtained - // about the patch. - Patch *Patch } // Describes a failed association. type FailedCreateAssociation struct { - // A description of the failure. - Message *string - // The association. Entry *CreateAssociationBatchRequestEntry // The source of the failure. Fault Fault + + // A description of the failure. + Message *string } // Information about an Automation failure. @@ -1591,40 +1591,40 @@ type FailureDetails struct { // Detailed information about the Automation step failure. Details map[string][]*string - // The type of Automation failure. Failure types include the following: Action, - // Permission, Throttling, Verification, Internal. - FailureType *string - // The stage of the Automation execution when the failure occurred. The stages // include the following: InputValidation, PreVerification, Invocation, // PostVerification. FailureStage *string + + // The type of Automation failure. Failure types include the following: Action, + // Permission, Throttling, Verification, Internal. + FailureType *string } // Status information about the aggregated associations. type InstanceAggregatedAssociationOverview struct { - // The number of associations for the instance(s). - InstanceAssociationStatusAggregatedCount map[string]*int32 - // Detailed status information about the aggregated associations. DetailedStatus *string + + // The number of associations for the instance(s). + InstanceAssociationStatusAggregatedCount map[string]*int32 } // One or more association documents on the instance. type InstanceAssociation struct { - // The instance ID. - InstanceId *string - // The association ID. AssociationId *string + // Version information for the association on the instance. + AssociationVersion *string + // The content of the association document for the instance(s). Content *string - // Version information for the association on the instance. - AssociationVersion *string + // The instance ID. + InstanceId *string } // An S3 bucket where you want to store the results of this request. @@ -1644,48 +1644,64 @@ type InstanceAssociationOutputUrl struct { // Status information about the instance association. type InstanceAssociationStatusInfo struct { - // The instance ID where the association was created. - InstanceId *string - - // A URL for an S3 bucket where you want to store the results of this request. - OutputUrl *InstanceAssociationOutputUrl + // The association ID. + AssociationId *string // The name of the association applied to the instance. AssociationName *string + // The version of the association applied to the instance. + AssociationVersion *string + // Detailed status information about the instance association. DetailedStatus *string - // The name of the association. - Name *string + // The association document versions. + DocumentVersion *string - // The version of the association applied to the instance. - AssociationVersion *string + // An error code returned by the request to create the association. + ErrorCode *string // The date the instance association ran. ExecutionDate *time.Time - // The association ID. - AssociationId *string + // Summary information about association execution. + ExecutionSummary *string - // Status information about the instance association. - Status *string + // The instance ID where the association was created. + InstanceId *string - // An error code returned by the request to create the association. - ErrorCode *string + // The name of the association. + Name *string - // The association document versions. - DocumentVersion *string + // A URL for an S3 bucket where you want to store the results of this request. + OutputUrl *InstanceAssociationOutputUrl - // Summary information about association execution. - ExecutionSummary *string + // Status information about the instance association. + Status *string } // Describes a filter for a specific list of instances. type InstanceInformation struct { - // The date the association was last run. - LastAssociationExecutionDate *time.Time + // The activation ID created by Systems Manager when the server or VM was + // registered. + ActivationId *string + + // The version of SSM Agent running on your Linux instance. + AgentVersion *string + + // Information about the association. + AssociationOverview *InstanceAggregatedAssociationOverview + + // The status of the association. + AssociationStatus *string + + // The fully qualified host name of the managed instance. + ComputerName *string + + // The IP address of the managed instance. + IPAddress *string // The Amazon Identity and Access Management (IAM) role assigned to the on-premises // Systems Manager managed instance. This call does not return the IAM role for EC2 @@ -1697,58 +1713,24 @@ type InstanceInformation struct { // the AWS CLI Command Reference. IamRole *string - // The activation ID created by Systems Manager when the server or VM was - // registered. - ActivationId *string - // The instance ID. InstanceId *string - // The version of SSM Agent running on your Linux instance. - AgentVersion *string - // Indicates whether the latest version of SSM Agent is running on your Linux // Managed Instance. This field does not indicate whether or not the latest version // is installed on Windows managed instances, because some older versions of // Windows Server use the EC2Config service to process SSM requests. IsLatestVersion *bool - // The operating system platform type. - PlatformType PlatformType - - // The status of the association. - AssociationStatus *string - - // The IP address of the managed instance. - IPAddress *string - - // Connection status of SSM Agent. - PingStatus PingStatus - - // The fully qualified host name of the managed instance. - ComputerName *string - - // The date the server or VM was registered with AWS as a managed instance. - RegistrationDate *time.Time + // The date the association was last run. + LastAssociationExecutionDate *time.Time - // The type of instance. Instances are either EC2 instances or managed instances. - ResourceType ResourceType + // The date and time when agent last pinged Systems Manager service. + LastPingDateTime *time.Time // The last date the association was successfully run. LastSuccessfulAssociationExecutionDate *time.Time - // Information about the association. - AssociationOverview *InstanceAggregatedAssociationOverview - - // The version of the OS platform running on your instance. - PlatformVersion *string - - // The name of the operating system platform running on your instance. - PlatformName *string - - // The date and time when agent last pinged Systems Manager service. - LastPingDateTime *time.Time - // The name assigned to an on-premises server or virtual machine (VM) when it is // activated as a Systems Manager managed instance. The name is specified as the // DefaultInstanceName property using the CreateActivation () command. It is @@ -1765,6 +1747,24 @@ type InstanceInformation struct { // (http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html) in // the AWS CLI Command Reference. Name *string + + // Connection status of SSM Agent. + PingStatus PingStatus + + // The name of the operating system platform running on your instance. + PlatformName *string + + // The operating system platform type. + PlatformType PlatformType + + // The version of the OS platform running on your instance. + PlatformVersion *string + + // The date the server or VM was registered with AWS as a managed instance. + RegistrationDate *time.Time + + // The type of instance. Instances are either EC2 instances or managed instances. + ResourceType ResourceType } // Describes a filter for a specific list of instances. You can filter instances @@ -1775,31 +1775,31 @@ type InstanceInformation struct { // tags. type InstanceInformationFilter struct { - // The filter values. + // The name of the filter. // // This member is required. - ValueSet []*string + Key InstanceInformationFilterKey - // The name of the filter. + // The filter values. // // This member is required. - Key InstanceInformationFilterKey + ValueSet []*string } // The filters to describe or get information about your managed instances. type InstanceInformationStringFilter struct { - // The filter values. - // - // This member is required. - Values []*string - // The filter key name to describe your instances. For example: // "InstanceIds"|"AgentVersion"|"PingStatus"|"PlatformTypes"|"ActivationIds"|"IamRole"|"ResourceType"|"AssociationStatus"|"Tag // Key" // // This member is required. Key *string + + // The filter values. + // + // This member is required. + Values []*string } // Defines the high-level patch compliance state for a managed instance, providing @@ -1808,80 +1808,63 @@ type InstanceInformationStringFilter struct { // gathered for the instance. type InstancePatchState struct { - // The number of patches from the patch baseline that are applicable for the - // instance but aren't currently installed. - MissingCount *int32 - - // An https URL or an Amazon S3 path-style URL to a list of patches to be - // installed. This patch installation list, which you maintain in an S3 bucket in - // YAML format and specify in the SSM document AWS-RunPatchBaseline, overrides the - // patches specified by the default patch baseline. For more information about the - // InstallOverrideList parameter, see About the SSM document AWS-RunPatchBaseline - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-about-aws-runpatchbaseline.html) - // in the AWS Systems Manager User Guide. - InstallOverrideList *string - // The ID of the patch baseline used to patch the instance. // // This member is required. BaselineId *string - // The time the most recent patching operation completed on the instance. - // - // This member is required. - OperationEndTime *time.Time - - // The time of the last attempt to patch the instance with NoReboot specified as - // the reboot option. - LastNoRebootInstallOperationTime *time.Time - // The ID of the managed instance the high-level patch compliance information was // collected for. // // This member is required. InstanceId *string - // The number of patches not specified in the patch baseline that are installed on - // the instance. - InstalledOtherCount *int32 - - // Placeholder information. This field will always be empty in the current release - // of the service. - OwnerInformation *string - // The type of patching operation that was performed: SCAN (assess patch compliance // state) or INSTALL (install missing patches). // // This member is required. Operation PatchOperationType - // The number of patches installed by Patch Manager since the last time the - // instance was rebooted. - InstalledPendingRebootCount *int32 - - // Indicates the reboot option specified in the patch baseline. Reboot options - // apply to Install operations only. Reboots are not attempted for Patch Manager - // Scan operations. - // - // * RebootIfNeeded: Patch Manager tries to reboot the - // instance if it installed any patches, or if any patches are detected with a - // status of InstalledPendingReboot. + // The time the most recent patching operation completed on the instance. // - // * NoReboot: Patch Manager attempts to - // install missing packages without trying to reboot the system. Patches installed - // with this option are assigned a status of InstalledPendingReboot. These patches - // might not be in effect until a reboot is performed. - RebootOption RebootOption + // This member is required. + OperationEndTime *time.Time - // The ID of the patch baseline snapshot used during the patching operation when - // this compliance data was collected. - SnapshotId *string + // The time the most recent patching operation was started on the instance. + // + // This member is required. + OperationStartTime *time.Time // The name of the patch group the managed instance belongs to. // // This member is required. PatchGroup *string + // The number of patches from the patch baseline that were attempted to be + // installed during the last patching operation, but failed to install. + FailedCount *int32 + + // An https URL or an Amazon S3 path-style URL to a list of patches to be + // installed. This patch installation list, which you maintain in an S3 bucket in + // YAML format and specify in the SSM document AWS-RunPatchBaseline, overrides the + // patches specified by the default patch baseline. For more information about the + // InstallOverrideList parameter, see About the SSM document AWS-RunPatchBaseline + // (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-about-aws-runpatchbaseline.html) + // in the AWS Systems Manager User Guide. + InstallOverrideList *string + + // The number of patches from the patch baseline that are installed on the + // instance. + InstalledCount *int32 + + // The number of patches not specified in the patch baseline that are installed on + // the instance. + InstalledOtherCount *int32 + + // The number of patches installed by Patch Manager since the last time the + // instance was rebooted. + InstalledPendingRebootCount *int32 + // The number of instances with patches installed that are specified in a // RejectedPatches list. Patches with a status of InstalledRejected were typically // installed before they were added to a RejectedPatches list. If @@ -1889,28 +1872,45 @@ type InstancePatchState struct { // of InstalledRejectedCount will always be 0 (zero). InstalledRejectedCount *int32 + // The time of the last attempt to patch the instance with NoReboot specified as + // the reboot option. + LastNoRebootInstallOperationTime *time.Time + + // The number of patches from the patch baseline that are applicable for the + // instance but aren't currently installed. + MissingCount *int32 + // The number of patches from the patch baseline that aren't applicable for the // instance and therefore aren't installed on the instance. This number may be // truncated if the list of patch names is very large. The number of patches beyond // this limit are reported in UnreportedNotApplicableCount. NotApplicableCount *int32 - // The time the most recent patching operation was started on the instance. + // Placeholder information. This field will always be empty in the current release + // of the service. + OwnerInformation *string + + // Indicates the reboot option specified in the patch baseline. Reboot options + // apply to Install operations only. Reboots are not attempted for Patch Manager + // Scan operations. // - // This member is required. - OperationStartTime *time.Time + // * RebootIfNeeded: Patch Manager tries to reboot the + // instance if it installed any patches, or if any patches are detected with a + // status of InstalledPendingReboot. + // + // * NoReboot: Patch Manager attempts to + // install missing packages without trying to reboot the system. Patches installed + // with this option are assigned a status of InstalledPendingReboot. These patches + // might not be in effect until a reboot is performed. + RebootOption RebootOption - // The number of patches from the patch baseline that were attempted to be - // installed during the last patching operation, but failed to install. - FailedCount *int32 + // The ID of the patch baseline snapshot used during the patching operation when + // this compliance data was collected. + SnapshotId *string // The number of patches beyond the supported limit of NotApplicableCount that are // not reported by name to Systems Manager Inventory. UnreportedNotApplicableCount *int32 - - // The number of patches from the patch baseline that are installed on the - // instance. - InstalledCount *int32 } // Defines a filter used in DescribeInstancePatchStatesForPatchGroup used to scope @@ -1938,12 +1938,12 @@ type InstancePatchStateFilter struct { // Specifies the inventory type and attribute for the aggregation execution. type InventoryAggregator struct { - // The inventory type and attribute name for aggregation. - Expression *string - // Nested aggregators to further refine aggregation for an inventory type. Aggregators []*InventoryAggregator + // The inventory type and attribute name for aggregation. + Expression *string + // A user-defined set of one or more filters on which to aggregate inventory data. // Groups return a count of resources that match and don't match the specified // criteria. @@ -1953,68 +1953,62 @@ type InventoryAggregator struct { // Status information returned by the DeleteInventory action. type InventoryDeletionStatusItem struct { - // Information about the status. - LastStatusMessage *string - // The deletion ID returned by the DeleteInventory action. DeletionId *string - // The name of the inventory data type. - TypeName *string - - // The status of the operation. Possible values are InProgress and Complete. - LastStatus InventoryDeletionStatus - // The UTC timestamp when the delete operation started. DeletionStartTime *time.Time - // The UTC timestamp of when the last status report. - LastStatusUpdateTime *time.Time - // Information about the delete operation. For more information about this summary, // see Understanding the delete inventory summary // (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-custom.html#sysman-inventory-delete) // in the AWS Systems Manager User Guide. DeletionSummary *InventoryDeletionSummary + + // The status of the operation. Possible values are InProgress and Complete. + LastStatus InventoryDeletionStatus + + // Information about the status. + LastStatusMessage *string + + // The UTC timestamp of when the last status report. + LastStatusUpdateTime *time.Time + + // The name of the inventory data type. + TypeName *string } // Information about the delete operation. type InventoryDeletionSummary struct { - // The total number of items to delete. This count does not change during the - // delete operation. - TotalCount *int32 - // Remaining number of items to delete. RemainingCount *int32 // A list of counts and versions for deleted items. SummaryItems []*InventoryDeletionSummaryItem + + // The total number of items to delete. This count does not change during the + // delete operation. + TotalCount *int32 } // Either a count, remaining count, or a version number in a delete inventory // summary. type InventoryDeletionSummaryItem struct { - // The inventory type version. - Version *string + // A count of the number of deleted items. + Count *int32 // The remaining number of items to delete. RemainingCount *int32 - // A count of the number of deleted items. - Count *int32 + // The inventory type version. + Version *string } // One or more filters. Use a filter to return a more specific list of results. type InventoryFilter struct { - // The type of filter. The Exists filter must be used with aggregators. For more - // information, see Aggregating inventory data - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-aggregate.html) - // in the AWS Systems Manager User Guide. - Type InventoryQueryOperatorType - // The name of the filter key. // // This member is required. @@ -2026,6 +2020,12 @@ type InventoryFilter struct { // // This member is required. Values []*string + + // The type of filter. The Exists filter must be used with aggregators. For more + // information, see Aggregating inventory data + // (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-aggregate.html) + // in the AWS Systems Manager User Guide. + Type InventoryQueryOperatorType } // A user-defined set of one or more filters on which to aggregate inventory data. @@ -2033,32 +2033,32 @@ type InventoryFilter struct { // criteria. type InventoryGroup struct { - // The name of the group. - // - // This member is required. - Name *string - // Filters define the criteria for the group. The matchingCount field displays the // number of resources that match the criteria. The notMatchingCount field displays // the number of resources that don't match the criteria. // // This member is required. Filters []*InventoryFilter + + // The name of the group. + // + // This member is required. + Name *string } // Information collected from managed instances based on your inventory policy // document type InventoryItem struct { - // The schema version for the inventory item. + // The time the inventory information was collected. // // This member is required. - SchemaVersion *string + CaptureTime *string - // The time the inventory information was collected. + // The schema version for the inventory item. // // This member is required. - CaptureTime *string + SchemaVersion *string // The name of the inventory type. Default inventory item type names start with // AWS. Custom inventory type names will start with Custom. Default inventory item @@ -2068,11 +2068,6 @@ type InventoryItem struct { // This member is required. TypeName *string - // A map of associated properties for a specified inventory type. For example, with - // this attribute, you can specify the ExecutionId, ExecutionType, ComplianceType - // properties of the AWS:ComplianceItem type. - Context map[string]*string - // The inventory data of the inventory type. Content []map[string]*string @@ -2081,6 +2076,11 @@ type InventoryItem struct { // update the inventory item type contents if the MD5 hash has not changed since // last update. ContentHash *string + + // A map of associated properties for a specified inventory type. For example, with + // this attribute, you can specify the ExecutionId, ExecutionType, ComplianceType + // properties of the AWS:ComplianceItem type. + Context map[string]*string } // Attributes are the entries within the inventory item content. It contains name @@ -2102,13 +2102,6 @@ type InventoryItemAttribute struct { // query filters. type InventoryItemSchema struct { - // The alias name of the inventory type. The alias name is used for display - // purposes. - DisplayName *string - - // The schema version for the inventory item. - Version *string - // The schema attributes for inventory. This contains data type and attribute name. // // This member is required. @@ -2121,31 +2114,30 @@ type InventoryItemSchema struct { // // This member is required. TypeName *string + + // The alias name of the inventory type. The alias name is used for display + // purposes. + DisplayName *string + + // The schema version for the inventory item. + Version *string } // Inventory query results. type InventoryResultEntity struct { - // ID of the inventory result entity. For example, for managed instance inventory - // the result will be the managed instance ID. For EC2 instance inventory, the - // result will be the instance ID. - Id *string - // The data section in the inventory result entity JSON. Data map[string]*InventoryResultItem + + // ID of the inventory result entity. For example, for managed instance inventory + // the result will be the managed instance ID. For EC2 instance inventory, the + // result will be the instance ID. + Id *string } // The inventory result item. type InventoryResultItem struct { - // The time inventory item data was captured. - CaptureTime *string - - // The name of the inventory result item type. - // - // This member is required. - TypeName *string - // Contains all the inventory data of the item type. Results include attribute // names and values. // @@ -2157,6 +2149,14 @@ type InventoryResultItem struct { // This member is required. SchemaVersion *string + // The name of the inventory result item type. + // + // This member is required. + TypeName *string + + // The time inventory item data was captured. + CaptureTime *string + // MD5 hash of the inventory item type contents. The content hash is used to // determine whether to update inventory information. The PutInventory API does not // update the inventory item type contents if the MD5 hash has not changed since @@ -2172,23 +2172,26 @@ type InventoryResultItem struct { // MaintenanceWindowTaskInvocationParameters (). type LoggingInfo struct { - // (Optional) The S3 bucket subfolder. - S3KeyPrefix *string + // The name of an S3 bucket where execution logs are stored . + // + // This member is required. + S3BucketName *string // The Region where the S3 bucket is located. // // This member is required. S3Region *string - // The name of an S3 bucket where execution logs are stored . - // - // This member is required. - S3BucketName *string + // (Optional) The S3 bucket subfolder. + S3KeyPrefix *string } // The parameters for an AUTOMATION task type. type MaintenanceWindowAutomationParameters struct { + // The version of an Automation document to use during task execution. + DocumentVersion *string + // The parameters for the AUTOMATION task.

    For information about specifying and // updating task parameters, see RegisterTaskWithMaintenanceWindow and // UpdateMaintenanceWindowTask.

    LoggingInfo has @@ -2205,117 +2208,114 @@ type MaintenanceWindowAutomationParameters struct { // AUTOMATION task types, Systems Manager ignores any values specified for these // parameters.

     Parameters map[string][]*string - - // The version of an Automation document to use during task execution. - DocumentVersion *string } // Describes the information about an execution of a maintenance window. type MaintenanceWindowExecution struct { + // The time the execution finished. + EndTime *time.Time + + // The time the execution started. + StartTime *time.Time + + // The status of the execution. + Status MaintenanceWindowExecutionStatus + // The details explaining the Status. Only available for certain status values. StatusDetails *string // The ID of the maintenance window execution. WindowExecutionId *string - // The status of the execution. - Status MaintenanceWindowExecutionStatus - // The ID of the maintenance window. WindowId *string - - // The time the execution finished. - EndTime *time.Time - - // The time the execution started. - StartTime *time.Time } // Information about a task execution performed as part of a maintenance window // execution. type MaintenanceWindowExecutionTaskIdentity struct { - // The ARN of the task that ran. - TaskArn *string + // The time the task execution finished. + EndTime *time.Time - // The ID of the specific task execution in the maintenance window execution. - TaskExecutionId *string + // The time the task execution started. + StartTime *time.Time - // The ID of the maintenance window execution that ran the task. - WindowExecutionId *string + // The status of the task execution. + Status MaintenanceWindowExecutionStatus // The details explaining the status of the task execution. Only available for // certain status values. StatusDetails *string - // The time the task execution finished. - EndTime *time.Time + // The ARN of the task that ran. + TaskArn *string - // The status of the task execution. - Status MaintenanceWindowExecutionStatus + // The ID of the specific task execution in the maintenance window execution. + TaskExecutionId *string // The type of task that ran. TaskType MaintenanceWindowTaskType - // The time the task execution started. - StartTime *time.Time + // The ID of the maintenance window execution that ran the task. + WindowExecutionId *string } // Describes the information about a task invocation for a particular target as // part of a task execution performed as part of a maintenance window execution. type MaintenanceWindowExecutionTaskInvocationIdentity struct { - // The parameters that were provided for the invocation when it was run. - Parameters *string - - // The ID of the specific task execution in the maintenance window execution. - TaskExecutionId *string + // The time the invocation finished. + EndTime *time.Time // The ID of the action performed in the service that actually handled the task // invocation. If the task type is RUN_COMMAND, this value is the command ID. ExecutionId *string - // The ID of the target definition in this maintenance window the invocation was - // performed for. - WindowTargetId *string - // The ID of the task invocation. InvocationId *string - // The ID of the maintenance window execution that ran the task. - WindowExecutionId *string - - // The details explaining the status of the task invocation. Only available for - // certain Status values. - StatusDetails *string - // User-provided value that was specified when the target was registered with the // maintenance window. This was also included in any CloudWatch events raised // during the task invocation. OwnerInformation *string - // The time the invocation finished. - EndTime *time.Time + // The parameters that were provided for the invocation when it was run. + Parameters *string // The time the invocation started. StartTime *time.Time + // The status of the task invocation. + Status MaintenanceWindowExecutionStatus + + // The details explaining the status of the task invocation. Only available for + // certain Status values. + StatusDetails *string + + // The ID of the specific task execution in the maintenance window execution. + TaskExecutionId *string + // The task type. TaskType MaintenanceWindowTaskType - // The status of the task invocation. - Status MaintenanceWindowExecutionStatus + // The ID of the maintenance window execution that ran the task. + WindowExecutionId *string + + // The ID of the target definition in this maintenance window the invocation was + // performed for. + WindowTargetId *string } // Filter used in the request. Supported filter keys are Name and Enabled. type MaintenanceWindowFilter struct { - // The filter values. - Values []*string - // The name of the filter. Key *string + + // The filter values. + Values []*string } // Information about the maintenance window. @@ -2325,13 +2325,21 @@ type MaintenanceWindowIdentity struct { // Manager stops scheduling new tasks for execution. Cutoff *int32 + // A description of the maintenance window. + Description *string + + // The duration of the maintenance window in hours. + Duration *int32 + + // Indicates whether the maintenance window is enabled. + Enabled *bool + // The date and time, in ISO-8601 Extended format, for when the maintenance window // is scheduled to become inactive. EndDate *string - // The time zone that the scheduled maintenance window executions are based on, in - // Internet Assigned Numbers Authority (IANA) format. - ScheduleTimezone *string + // The name of the maintenance window. + Name *string // The next time the maintenance window will actually run, taking into account any // specified times for the maintenance window to become active or inactive. @@ -2340,28 +2348,20 @@ type MaintenanceWindowIdentity struct { // The schedule of the maintenance window in the form of a cron or rate expression. Schedule *string - // Indicates whether the maintenance window is enabled. - Enabled *bool - - // A description of the maintenance window. - Description *string - // The number of days to wait to run a maintenance window after the scheduled CRON // expression date and time. ScheduleOffset *int32 - // The ID of the maintenance window. - WindowId *string - - // The name of the maintenance window. - Name *string + // The time zone that the scheduled maintenance window executions are based on, in + // Internet Assigned Numbers Authority (IANA) format. + ScheduleTimezone *string // The date and time, in ISO-8601 Extended format, for when the maintenance window // is scheduled to become active. StartDate *string - // The duration of the maintenance window in hours. - Duration *int32 + // The ID of the maintenance window. + WindowId *string } // The maintenance window to which the specified target belongs. @@ -2420,33 +2420,18 @@ type MaintenanceWindowLambdaParameters struct { // values are specified for TaskInvocationParameters. type MaintenanceWindowRunCommandParameters struct { - // SHA-256 or SHA-1. SHA-1 hashes have been deprecated. - DocumentHashType DocumentHashType - - // The ARN of the IAM service role to use to publish Amazon Simple Notification - // Service (Amazon SNS) notifications for maintenance window Run Command tasks. - ServiceRoleArn *string - - // The name of the S3 bucket. - OutputS3BucketName *string - - // If this time is reached and the command has not already started running, it - // doesn't run. - TimeoutSeconds *int32 - // Configuration options for sending command output to CloudWatch Logs. CloudWatchOutputConfig *CloudWatchOutputConfig + // Information about the commands to run. + Comment *string + // The SHA-256 or SHA-1 hash created by the system when the document was created. // SHA-1 hashes have been deprecated. DocumentHash *string - // Information about the commands to run. - Comment *string - - // Configurations for sending notifications about command status changes on a - // per-instance basis. - NotificationConfig *NotificationConfig + // SHA-256 or SHA-1. SHA-1 hashes have been deprecated. + DocumentHashType DocumentHashType // The SSM document version to use in the request. You can specify $DEFAULT, // $LATEST, or a specific version number. If you run commands by using the AWS CLI, @@ -2456,11 +2441,26 @@ type MaintenanceWindowRunCommandParameters struct { // "3" DocumentVersion *string - // The parameters for the RUN_COMMAND task execution. - Parameters map[string][]*string + // Configurations for sending notifications about command status changes on a + // per-instance basis. + NotificationConfig *NotificationConfig + + // The name of the S3 bucket. + OutputS3BucketName *string // The S3 bucket subfolder. OutputS3KeyPrefix *string + + // The parameters for the RUN_COMMAND task execution. + Parameters map[string][]*string + + // The ARN of the IAM service role to use to publish Amazon Simple Notification + // Service (Amazon SNS) notifications for maintenance window Run Command tasks. + ServiceRoleArn *string + + // If this time is reached and the command has not already started running, it + // doesn't run. + TimeoutSeconds *int32 } // The parameters for a STEP_FUNCTIONS task. For information about specifying and @@ -2488,6 +2488,19 @@ type MaintenanceWindowStepFunctionsParameters struct { // The target registered with the maintenance window. type MaintenanceWindowTarget struct { + // A description for the target. + Description *string + + // The name for the maintenance window target. + Name *string + + // A user-provided value that will be included in any CloudWatch events that are + // raised while running tasks for these targets in this maintenance window. + OwnerInformation *string + + // The type of target that is being registered with the maintenance window. + ResourceType MaintenanceWindowResourceType + // The targets, either instances or tags. Specify instances using the following // format: Key=instanceids,Values=, Tags are specified using the following format: // Key=,Values=. @@ -2496,21 +2509,8 @@ type MaintenanceWindowTarget struct { // The ID of the maintenance window to register the target with. WindowId *string - // The type of target that is being registered with the maintenance window. - ResourceType MaintenanceWindowResourceType - - // A description for the target. - Description *string - - // The name for the maintenance window target. - Name *string - // The ID of the target. WindowTargetId *string - - // A user-provided value that will be included in any CloudWatch events that are - // raised while running tasks for these targets in this maintenance window. - OwnerInformation *string } // Information about a task defined for a maintenance window. @@ -2527,39 +2527,33 @@ type MaintenanceWindowTask struct { // MaintenanceWindowTaskInvocationParameters (). LoggingInfo *LoggingInfo + // The maximum number of targets this task can be run for, in parallel. + MaxConcurrency *string + // The maximum number of errors allowed before this task stops being scheduled. MaxErrors *string - // The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION - // task types, TaskArn is the Systems Manager document name or ARN. For LAMBDA - // tasks, it's the function name or ARN. For STEP_FUNCTIONS tasks, it's the state - // machine ARN. - TaskArn *string - // The task name. Name *string - // The maximum number of targets this task can be run for, in parallel. - MaxConcurrency *string - - // The task ID. - WindowTaskId *string - - // The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, - // LAMBDA, or STEP_FUNCTIONS. - Type MaintenanceWindowTaskType - // The priority of the task in the maintenance window. The lower the number, the // higher the priority. Tasks that have the same priority are scheduled in // parallel. Priority *int32 + // The ARN of the IAM service role to use to publish Amazon Simple Notification + // Service (Amazon SNS) notifications for maintenance window Run Command tasks. + ServiceRoleArn *string + // The targets (either instances or tags). Instances are specified using // Key=instanceids,Values=,. Tags are specified using Key=,Values=. Targets []*Target - // The ID of the maintenance window where the task is registered. - WindowId *string + // The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION + // task types, TaskArn is the Systems Manager document name or ARN. For LAMBDA + // tasks, it's the function name or ARN. For STEP_FUNCTIONS tasks, it's the state + // machine ARN. + TaskArn *string // The parameters that should be passed to the task when it is run. TaskParameters // has been deprecated. To specify parameters to pass to a task when it runs, @@ -2568,9 +2562,15 @@ type MaintenanceWindowTask struct { // maintenance window task types, see MaintenanceWindowTaskInvocationParameters (). TaskParameters map[string]*MaintenanceWindowTaskParameterValueExpression - // The ARN of the IAM service role to use to publish Amazon Simple Notification - // Service (Amazon SNS) notifications for maintenance window Run Command tasks. - ServiceRoleArn *string + // The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, + // LAMBDA, or STEP_FUNCTIONS. + Type MaintenanceWindowTaskType + + // The ID of the maintenance window where the task is registered. + WindowId *string + + // The task ID. + WindowTaskId *string } // The parameters for task execution. @@ -2579,14 +2579,14 @@ type MaintenanceWindowTaskInvocationParameters struct { // The parameters for an AUTOMATION task type. Automation *MaintenanceWindowAutomationParameters + // The parameters for a LAMBDA task type. + Lambda *MaintenanceWindowLambdaParameters + // The parameters for a RUN_COMMAND task type. RunCommand *MaintenanceWindowRunCommandParameters // The parameters for a STEP_FUNCTIONS task type. StepFunctions *MaintenanceWindowStepFunctionsParameters - - // The parameters for a LAMBDA task type. - Lambda *MaintenanceWindowLambdaParameters } // Defines the values for a task parameter. @@ -2616,11 +2616,6 @@ type NotificationConfig struct { // this topic. NotificationArn *string - // Command: Receive notification when the status of a command changes. Invocation: - // For commands sent to multiple instances, receive notification on a per-instance - // basis when the status of a command changes. - NotificationType NotificationType - // The different events for which you can receive notifications. These events // include the following: All (events), InProgress, Success, TimedOut, Cancelled, // Failed. To learn more about these events, see Monitoring Systems Manager status @@ -2628,6 +2623,11 @@ type NotificationConfig struct { // (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html) // in the AWS Systems Manager User Guide. NotificationEvents []NotificationEvent + + // Command: Receive notification when the status of a command changes. Invocation: + // For commands sent to multiple instances, receive notification on a per-instance + // basis when the status of a command changes. + NotificationType NotificationType } // One or more aggregators for viewing counts of OpsItems using different @@ -2635,12 +2635,6 @@ type NotificationConfig struct { // few. type OpsAggregator struct { - // The data type name to use for viewing counts of OpsItems. - TypeName *string - - // The aggregator value. - Values map[string]*string - // Either a Range or Count aggregator for limiting an OpsItem summary. AggregatorType *string @@ -2652,6 +2646,12 @@ type OpsAggregator struct { // The aggregator filters. Filters []*OpsFilter + + // The data type name to use for viewing counts of OpsItems. + TypeName *string + + // The aggregator value. + Values map[string]*string } // The result of the query. @@ -2677,9 +2677,6 @@ type OpsEntityItem struct { // A filter for viewing OpsItem summaries. type OpsFilter struct { - // The type of filter. - Type OpsFilterOperatorType - // The name of the filter. // // This member is required. @@ -2689,6 +2686,9 @@ type OpsFilter struct { // // This member is required. Values []*string + + // The type of filter. + Type OpsFilterOperatorType } // Operations engineers and IT professionals use OpsCenter to view, investigate, @@ -2698,50 +2698,28 @@ type OpsFilter struct { // the AWS Systems Manager User Guide. type OpsItem struct { - // One or more OpsItems that share something in common with the current OpsItem. - // For example, related OpsItems can include OpsItems with similar error messages, - // impacted resources, or statuses for the impacted resource. - RelatedOpsItems []*RelatedOpsItem - - // The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when - // this OpsItem is edited or changed. - Notifications []*OpsItemNotification - - // The date and time the OpsItem was last updated. - LastModifiedTime *time.Time - - // The ARN of the AWS account that last updated the OpsItem. - LastModifiedBy *string + // An OpsItem category. Category options include: Availability, Cost, Performance, + // Recovery, Security. + Category *string - // The OpsItem status. Status can be Open, In Progress, or Resolved. For more - // information, see Editing OpsItem details - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems-editing-details.html) - // in the AWS Systems Manager User Guide. - Status OpsItemStatus + // The ARN of the AWS account that created the OpsItem. + CreatedBy *string // The date and time the OpsItem was created. CreatedTime *time.Time - // The version of this OpsItem. Each time the OpsItem is edited the version number - // increments by one. - Version *string - - // The importance of this OpsItem in relation to other OpsItems in the system. - Priority *int32 - - // A short heading that describes the nature of the OpsItem and the impacted - // resource. - Title *string + // The OpsItem description. + Description *string - // The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted - // resource is a subset of source. - Source *string + // The ARN of the AWS account that last updated the OpsItem. + LastModifiedBy *string - // The severity of the OpsItem. Severity options range from 1 to 4. - Severity *string + // The date and time the OpsItem was last updated. + LastModifiedTime *time.Time - // The ARN of the AWS account that created the OpsItem. - CreatedBy *string + // The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when + // this OpsItem is edited or changed. + Notifications []*OpsItemNotification // Operational data is custom data that provides useful reference details about the // OpsItem. For example, you can specify log files, error strings, license keys, @@ -2762,26 +2740,48 @@ type OpsItem struct { // in the AWS Systems Manager User Guide. OperationalData map[string]*OpsItemDataValue - // The OpsItem description. - Description *string - // The ID of the OpsItem. OpsItemId *string - // An OpsItem category. Category options include: Availability, Cost, Performance, - // Recovery, Security. - Category *string + // The importance of this OpsItem in relation to other OpsItems in the system. + Priority *int32 + + // One or more OpsItems that share something in common with the current OpsItem. + // For example, related OpsItems can include OpsItems with similar error messages, + // impacted resources, or statuses for the impacted resource. + RelatedOpsItems []*RelatedOpsItem + + // The severity of the OpsItem. Severity options range from 1 to 4. + Severity *string + + // The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted + // resource is a subset of source. + Source *string + + // The OpsItem status. Status can be Open, In Progress, or Resolved. For more + // information, see Editing OpsItem details + // (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems-editing-details.html) + // in the AWS Systems Manager User Guide. + Status OpsItemStatus + + // A short heading that describes the nature of the OpsItem and the impacted + // resource. + Title *string + + // The version of this OpsItem. Each time the OpsItem is edited the version number + // increments by one. + Version *string } // An object that defines the value of the key and its type in the OperationalData // map. type OpsItemDataValue struct { - // The value of the OperationalData key. - Value *string - // The type of key-value pair. Valid types include SearchableString and String. Type OpsItemDataType + + // The value of the OperationalData key. + Value *string } // Describes an OpsItem filter. @@ -2792,15 +2792,15 @@ type OpsItemFilter struct { // This member is required. Key OpsItemFilterKey - // The filter value. + // The operator used by the filter call. // // This member is required. - Values []*string + Operator OpsItemFilterOperator - // The operator used by the filter call. + // The filter value. // // This member is required. - Operator OpsItemFilterOperator + Values []*string } // A notification about the OpsItem. @@ -2814,9 +2814,17 @@ type OpsItemNotification struct { // A count of OpsItems. type OpsItemSummary struct { - // A short heading that describes the nature of the OpsItem and the impacted - // resource. - Title *string + // A list of OpsItems by category. + Category *string + + // The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem. + CreatedBy *string + + // The date and time the OpsItem was created. + CreatedTime *time.Time + + // The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem. + LastModifiedBy *string // The date and time the OpsItem was last updated. LastModifiedTime *time.Time @@ -2825,32 +2833,24 @@ type OpsItemSummary struct { // OpsItem. OperationalData map[string]*OpsItemDataValue - // The impacted AWS resource. - Source *string - - // A list of OpsItems by severity. - Severity *string - // The ID of the OpsItem. OpsItemId *string - // The OpsItem status. Status can be Open, In Progress, or Resolved. - Status OpsItemStatus - // The importance of this OpsItem in relation to other OpsItems in the system. Priority *int32 - // A list of OpsItems by category. - Category *string + // A list of OpsItems by severity. + Severity *string - // The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem. - LastModifiedBy *string + // The impacted AWS resource. + Source *string - // The date and time the OpsItem was created. - CreatedTime *time.Time + // The OpsItem status. Status can be Open, In Progress, or Resolved. + Status OpsItemStatus - // The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem. - CreatedBy *string + // A short heading that describes the nature of the OpsItem and the impacted + // resource. + Title *string } // The OpsItem data type to return. @@ -2877,22 +2877,19 @@ type OutputSource struct { // An Systems Manager parameter in Parameter Store. type Parameter struct { - // The parameter value. - Value *string + // The Amazon Resource Name (ARN) of the parameter. + ARN *string - // The parameter version. - Version *int64 + // The data type of the parameter, such as text or aws:ec2:image. The default is + // text. + DataType *string // Date the parameter was last changed or updated and the parameter version was // created. LastModifiedDate *time.Time - // The Amazon Resource Name (ARN) of the parameter. - ARN *string - - // The type of parameter. Valid values include the following: String, StringList, - // and SecureString. - Type ParameterType + // The name of the parameter. + Name *string // Either the version number or the label used to retrieve the parameter value. // Specify selectors by using one of the following formats: parameter_name:version @@ -2903,50 +2900,44 @@ type Parameter struct { // SourceResult is the raw result or response from the source. SourceResult *string - // The data type of the parameter, such as text or aws:ec2:image. The default is - // text. - DataType *string + // The type of parameter. Valid values include the following: String, StringList, + // and SecureString. + Type ParameterType - // The name of the parameter. - Name *string + // The parameter value. + Value *string + + // The parameter version. + Version *int64 } // Information about parameter usage. type ParameterHistory struct { - // Information about the parameter. - Description *string - - // The parameter tier. - Tier ParameterTier - - // Date the parameter was last changed or updated. - LastModifiedDate *time.Time + // Parameter names can include the following letters and symbols. a-zA-Z0-9_.- + AllowedPattern *string - // The name of the parameter. - Name *string + // The data type of the parameter, such as text or aws:ec2:image. The default is + // text. + DataType *string - // Labels assigned to the parameter version. - Labels []*string + // Information about the parameter. + Description *string // The ID of the query key used for this parameter. KeyId *string - // The parameter value. - Value *string + // Labels assigned to the parameter version. + Labels []*string - // The data type of the parameter, such as text or aws:ec2:image. The default is - // text. - DataType *string + // Date the parameter was last changed or updated. + LastModifiedDate *time.Time // Amazon Resource Name (ARN) of the AWS user who last changed the parameter. LastModifiedUser *string - // The parameter version. - Version *int64 - - // Parameter names can include the following letters and symbols. a-zA-Z0-9_.- - AllowedPattern *string + // The name of the parameter. + Name *string // Information about the policies assigned to a parameter. Assigning parameter // policies @@ -2954,80 +2945,89 @@ type ParameterHistory struct { // in the AWS Systems Manager User Guide. Policies []*ParameterInlinePolicy + // The parameter tier. + Tier ParameterTier + // The type of parameter used. Type ParameterType + + // The parameter value. + Value *string + + // The parameter version. + Version *int64 } // One or more policies assigned to a parameter. type ParameterInlinePolicy struct { - // The type of policy. Parameter Store supports the following policy types: - // Expiration, ExpirationNotification, and NoChangeNotification. - PolicyType *string - - // The JSON text of the policy. - PolicyText *string - // The status of the policy. Policies report the following statuses: Pending (the // policy has not been enforced or applied yet), Finished (the policy was applied), // Failed (the policy was not applied), or InProgress (the policy is being applied // now). PolicyStatus *string + + // The JSON text of the policy. + PolicyText *string + + // The type of policy. Parameter Store supports the following policy types: + // Expiration, ExpirationNotification, and NoChangeNotification. + PolicyType *string } // Metadata includes information like the ARN of the last user and the date/time // the parameter was last used. type ParameterMetadata struct { - // A list of policies associated with a parameter. - Policies []*ParameterInlinePolicy - - // Description of the parameter actions. - Description *string - // A parameter name can include only the following letters and symbols. // a-zA-Z0-9_.- AllowedPattern *string - // The type of parameter. Valid parameter types include the following: String, - // StringList, and SecureString. - Type ParameterType - // The data type of the parameter, such as text or aws:ec2:image. The default is // text. DataType *string - // The parameter name. - Name *string + // Description of the parameter actions. + Description *string + + // The ID of the query key used for this parameter. + KeyId *string + + // Date the parameter was last changed or updated. + LastModifiedDate *time.Time // Amazon Resource Name (ARN) of the AWS user who last changed the parameter. LastModifiedUser *string + // The parameter name. + Name *string + + // A list of policies associated with a parameter. + Policies []*ParameterInlinePolicy + // The parameter tier. Tier ParameterTier + // The type of parameter. Valid parameter types include the following: String, + // StringList, and SecureString. + Type ParameterType + // The parameter version. Version *int64 - - // The ID of the query key used for this parameter. - KeyId *string - - // Date the parameter was last changed or updated. - LastModifiedDate *time.Time } // This data type is deprecated. Instead, use ParameterStringFilter (). type ParametersFilter struct { - // The filter values. + // The name of the filter. // // This member is required. - Values []*string + Key ParametersFilterKey - // The name of the filter. + // The filter values. // // This member is required. - Key ParametersFilterKey + Values []*string } // One or more filters. Use a filter to return a more specific list of results. The @@ -3042,9 +3042,6 @@ type ParametersFilter struct { // in the AWS Systems Manager User Guide. type ParameterStringFilter struct { - // The value you want to search for. - Values []*string - // The name of the filter. // // This member is required. @@ -3057,56 +3054,65 @@ type ParameterStringFilter struct { // Equals and BeginsWith. (Exception: For filters using the key Label, the only // valid option is Equals.) Option *string + + // The value you want to search for. + Values []*string } // Represents metadata about a patch. type Patch struct { + // The classification of the patch (for example, SecurityUpdates, Updates, + // CriticalUpdates). + Classification *string + // The URL where more information can be obtained about the patch. ContentUrl *string - // The product family the patch is applicable for (for example, Windows). - ProductFamily *string - - // The ID of the MSRC bulletin the patch is related to. - MsrcNumber *string - // The description of the patch. Description *string - // The name of the vendor providing the patch. - Vendor *string - - // The date the patch was released. - ReleaseDate *time.Time + // The ID of the patch (this is different than the Microsoft Knowledge Base ID). + Id *string // The Microsoft Knowledge Base ID of the patch. KbNumber *string + // The language of the patch if it's language-specific. + Language *string + + // The ID of the MSRC bulletin the patch is related to. + MsrcNumber *string + + // The severity of the patch (for example Critical, Important, Moderate). + MsrcSeverity *string + // The specific product the patch is applicable for (for example, // WindowsServer2016). Product *string - // The ID of the patch (this is different than the Microsoft Knowledge Base ID). - Id *string + // The product family the patch is applicable for (for example, Windows). + ProductFamily *string - // The classification of the patch (for example, SecurityUpdates, Updates, - // CriticalUpdates). - Classification *string + // The date the patch was released. + ReleaseDate *time.Time // The title of the patch. Title *string - // The severity of the patch (for example Critical, Important, Moderate). - MsrcSeverity *string - - // The language of the patch if it's language-specific. - Language *string + // The name of the vendor providing the patch. + Vendor *string } // Defines the basic information about a patch baseline. type PatchBaselineIdentity struct { + // The description of the patch baseline. + BaselineDescription *string + + // The ID of the patch baseline. + BaselineId *string + // The name of the patch baseline. BaselineName *string @@ -3115,12 +3121,6 @@ type PatchBaselineIdentity struct { // patch baseline for each operating system. DefaultBaseline *bool - // The description of the patch baseline. - BaselineDescription *string - - // The ID of the patch baseline. - BaselineId *string - // Defines the operating system the patch baseline applies to. The Default value is // WINDOWS. OperatingSystem OperatingSystem @@ -3130,18 +3130,11 @@ type PatchBaselineIdentity struct { // the patch baseline used to patch the instance. type PatchComplianceData struct { - // The title of the patch. - // - // This member is required. - Title *string - - // The state of the patch on the instance, such as INSTALLED or FAILED. For - // descriptions of each patch state, see About patch compliance - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-compliance-about.html#sysman-compliance-monitor-patch) - // in the AWS Systems Manager User Guide. + // The classification of the patch (for example, SecurityUpdates, Updates, + // CriticalUpdates). // // This member is required. - State PatchComplianceDataState + Classification *string // The date/time the patch was installed on the instance. Note that not all // operating systems provide this level of information. @@ -3149,12 +3142,6 @@ type PatchComplianceData struct { // This member is required. InstalledTime *time.Time - // The classification of the patch (for example, SecurityUpdates, Updates, - // CriticalUpdates). - // - // This member is required. - Classification *string - // The operating system-specific ID of the patch. // // This member is required. @@ -3164,6 +3151,19 @@ type PatchComplianceData struct { // // This member is required. Severity *string + + // The state of the patch on the instance, such as INSTALLED or FAILED. For + // descriptions of each patch state, see About patch compliance + // (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-compliance-about.html#sysman-compliance-monitor-patch) + // in the AWS Systems Manager User Guide. + // + // This member is required. + State PatchComplianceDataState + + // The title of the patch. + // + // This member is required. + Title *string } // Defines which patches should be included in a patch baseline. A patch filter @@ -3206,11 +3206,11 @@ type PatchFilterGroup struct { // registered with. type PatchGroupPatchBaselineMapping struct { - // The name of the patch group registered with the patch baseline. - PatchGroup *string - // The patch baseline the patch group is registered with. BaselineIdentity *PatchBaselineIdentity + + // The name of the patch group registered with the patch baseline. + PatchGroup *string } // Defines a filter used in Patch Manager APIs. @@ -3226,11 +3226,6 @@ type PatchOrchestratorFilter struct { // Defines an approval rule for a patch baseline. type PatchRule struct { - // For instances identified by the approval rule filters, enables a patch baseline - // to apply non-security updates available in the specified repository. The default - // value is 'false'. Applies to Linux instances only. - EnableNonSecurity *bool - // The patch filter group that defines the criteria for the rule. // // This member is required. @@ -3249,6 +3244,11 @@ type PatchRule struct { // A compliance severity level for all approved patches in a patch baseline. ComplianceLevel PatchComplianceLevel + + // For instances identified by the approval rule filters, enables a patch baseline + // to apply non-security updates available in the specified repository. The default + // value is 'false'. Applies to Linux instances only. + EnableNonSecurity *bool } // A set of rules defining the approval rules for a patch baseline. @@ -3264,18 +3264,6 @@ type PatchRuleGroup struct { // operating systems and source repository. Applies to Linux instances only. type PatchSource struct { - // The name specified to identify the patch source. - // - // This member is required. - Name *string - - // The specific operating system versions a patch repository applies to, such as - // "Ubuntu16.04", "AmazonLinux2016.09", "RedhatEnterpriseLinux7.2" or "Suse12.7". - // For lists of supported product values, see PatchFilter (). - // - // This member is required. - Products []*string - // The value of the yum repo configuration. For example: [main] // // cachedir=/var/cache/yum/$basesearch$releasever @@ -3287,46 +3275,58 @@ type PatchSource struct { // // This member is required. Configuration *string + + // The name specified to identify the patch source. + // + // This member is required. + Name *string + + // The specific operating system versions a patch repository applies to, such as + // "Ubuntu16.04", "AmazonLinux2016.09", "RedhatEnterpriseLinux7.2" or "Suse12.7". + // For lists of supported product values, see PatchFilter (). + // + // This member is required. + Products []*string } // Information about the approval status of a patch. type PatchStatus struct { - // The approval status of a patch (APPROVED, PENDING_APPROVAL, EXPLICIT_APPROVED, - // EXPLICIT_REJECTED). - DeploymentStatus PatchDeploymentStatus - // The date the patch was approved (or will be approved if the status is // PENDING_APPROVAL). ApprovalDate *time.Time // The compliance severity level for a patch. ComplianceLevel PatchComplianceLevel + + // The approval status of a patch (APPROVED, PENDING_APPROVAL, EXPLICIT_APPROVED, + // EXPLICIT_REJECTED). + DeploymentStatus PatchDeploymentStatus } // An aggregate of step execution statuses displayed in the AWS Console for a // multi-Region and multi-account Automation execution. type ProgressCounters struct { - // The total number of steps that successfully completed in all specified AWS - // Regions and accounts for the current Automation execution. - SuccessSteps *int32 + // The total number of steps that the system cancelled in all specified AWS Regions + // and accounts for the current Automation execution. + CancelledSteps *int32 // The total number of steps that failed to run in all specified AWS Regions and // accounts for the current Automation execution. FailedSteps *int32 - // The total number of steps run in all specified AWS Regions and accounts for the - // current Automation execution. - TotalSteps *int32 - - // The total number of steps that the system cancelled in all specified AWS Regions - // and accounts for the current Automation execution. - CancelledSteps *int32 + // The total number of steps that successfully completed in all specified AWS + // Regions and accounts for the current Automation execution. + SuccessSteps *int32 // The total number of steps that timed out in all specified AWS Regions and // accounts for the current Automation execution. TimedOutSteps *int32 + + // The total number of steps run in all specified AWS Regions and accounts for the + // current Automation execution. + TotalSteps *int32 } // An OpsItems that shares something in common with the current OpsItem. For @@ -3354,30 +3354,30 @@ type ResolvedTargets struct { // Compliance summary information for a specific resource. type ResourceComplianceSummaryItem struct { - // The resource ID. - ResourceId *string + // The compliance type. + ComplianceType *string + + // A list of items that are compliant for the resource. + CompliantSummary *CompliantSummary + + // Information about the execution. + ExecutionSummary *ComplianceExecutionSummary // A list of items that aren't compliant for the resource. NonCompliantSummary *NonCompliantSummary - // The compliance status for the resource. - Status ComplianceStatus - // The highest severity item found for the resource. The resource is compliant for // this item. OverallSeverity ComplianceSeverity - // Information about the execution. - ExecutionSummary *ComplianceExecutionSummary + // The resource ID. + ResourceId *string // The resource type. ResourceType *string - // A list of items that are compliant for the resource. - CompliantSummary *CompliantSummary - - // The compliance type. - ComplianceType *string + // The compliance status for the resource. + Status ComplianceStatus } // Information about the AwsOrganizationsSource resource data sync source. A sync @@ -3385,9 +3385,6 @@ type ResourceComplianceSummaryItem struct { // Organization is not present, from multiple AWS Regions. type ResourceDataSyncAwsOrganizationsSource struct { - // The AWS Organizations organization units included in the sync. - OrganizationalUnits []*ResourceDataSyncOrganizationalUnit - // If an AWS Organization is present, this is either OrganizationalUnits or // EntireOrganization. For OrganizationalUnits, the data is aggregated from a set // of organization units. For EntireOrganization, the data is aggregated from the @@ -3395,6 +3392,9 @@ type ResourceDataSyncAwsOrganizationsSource struct { // // This member is required. OrganizationSourceType *string + + // The AWS Organizations organization units included in the sync. + OrganizationalUnits []*ResourceDataSyncOrganizationalUnit } // Synchronize Systems Manager Inventory data from multiple AWS accounts defined in @@ -3411,38 +3411,38 @@ type ResourceDataSyncDestinationDataSharing struct { // status and last successful sync. type ResourceDataSyncItem struct { + // The status reported by the last sync. + LastStatus LastResourceDataSyncStatus + // The last time the sync operations returned a status of SUCCESSFUL (UTC). LastSuccessfulSyncTime *time.Time - // The name of the Resource Data Sync. - SyncName *string - + // The status message details reported by the last sync. + LastSyncStatusMessage *string + // The last time the configuration attempted to sync (UTC). LastSyncTime *time.Time + // Configuration information for the target S3 bucket. + S3Destination *ResourceDataSyncS3Destination + // The date and time the configuration was created (UTC). SyncCreatedTime *time.Time - // The type of resource data sync. If SyncType is SyncToDestination, then the - // resource data sync synchronizes data to an S3 bucket. If the SyncType is - // SyncFromSource then the resource data sync synchronizes data from AWS - // Organizations or from multiple AWS Regions. - SyncType *string - // The date and time the resource data sync was changed. SyncLastModifiedTime *time.Time - // Configuration information for the target S3 bucket. - S3Destination *ResourceDataSyncS3Destination + // The name of the Resource Data Sync. + SyncName *string // Information about the source where the data was synchronized. SyncSource *ResourceDataSyncSourceWithState - // The status message details reported by the last sync. - LastSyncStatusMessage *string - - // The status reported by the last sync. - LastStatus LastResourceDataSyncStatus + // The type of resource data sync. If SyncType is SyncToDestination, then the + // resource data sync synchronizes data to an S3 bucket. If the SyncType is + // SyncFromSource then the resource data sync synchronizes data from AWS + // Organizations or from multiple AWS Regions. + SyncType *string } // The AWS Organizations organizational unit data source for the sync. @@ -3455,30 +3455,30 @@ type ResourceDataSyncOrganizationalUnit struct { // Information about the target S3 bucket for the Resource Data Sync. type ResourceDataSyncS3Destination struct { - // The ARN of an encryption key for a destination in Amazon S3. Must belong to the - // same Region as the destination S3 bucket. - AWSKMSKeyARN *string - // The name of the S3 bucket where the aggregated data is stored. // // This member is required. BucketName *string + // The AWS Region with the S3 bucket targeted by the Resource Data Sync. + // + // This member is required. + Region *string + // A supported sync format. The following format is currently supported: JsonSerDe // // This member is required. SyncFormat ResourceDataSyncS3Format + // The ARN of an encryption key for a destination in Amazon S3. Must belong to the + // same Region as the destination S3 bucket. + AWSKMSKeyARN *string + // Enables destination data sharing. By default, this field is null. DestinationDataSharing *ResourceDataSyncDestinationDataSharing // An Amazon S3 prefix for the bucket. Prefix *string - - // The AWS Region with the S3 bucket targeted by the Resource Data Sync. - // - // This member is required. - Region *string } // Information about the source of the data included in the resource data sync. @@ -3489,20 +3489,20 @@ type ResourceDataSyncSource struct { // This member is required. SourceRegions []*string - // Whether to automatically synchronize and aggregate data from new AWS Regions - // when those Regions come online. - IncludeFutureRegions *bool - - // Information about the AwsOrganizationsSource resource data sync source. A sync - // source of this type can synchronize data from AWS Organizations. - AwsOrganizationsSource *ResourceDataSyncAwsOrganizationsSource - // The type of data source for the resource data sync. SourceType is either // AwsOrganizations (if an organization is present in AWS Organizations) or // singleAccountMultiRegions. // // This member is required. SourceType *string + + // Information about the AwsOrganizationsSource resource data sync source. A sync + // source of this type can synchronize data from AWS Organizations. + AwsOrganizationsSource *ResourceDataSyncAwsOrganizationsSource + + // Whether to automatically synchronize and aggregate data from new AWS Regions + // when those Regions come online. + IncludeFutureRegions *bool } // The data type name for including resource data sync state. There are four sync @@ -3515,11 +3515,6 @@ type ResourceDataSyncSource struct { // in AWS Organizations.) type ResourceDataSyncSourceWithState struct { - // The type of data source for the resource data sync. SourceType is either - // AwsOrganizations (if an organization is present in AWS Organizations) or - // singleAccountMultiRegions. - SourceType *string - // The field name in SyncSource for the ResourceDataSyncAwsOrganizationsSource // type. AwsOrganizationsSource *ResourceDataSyncAwsOrganizationsSource @@ -3531,6 +3526,11 @@ type ResourceDataSyncSourceWithState struct { // The SyncSource AWS Regions included in the resource data sync. SourceRegions []*string + // The type of data source for the resource data sync. SourceType is either + // AwsOrganizations (if an organization is present in AWS Organizations) or + // singleAccountMultiRegions. + SourceType *string + // The data type name for including resource data sync state. There are four sync // states:

    OrganizationNotExists: Your organization doesn't // exist.

    NoPermissions: The system can't locate the @@ -3555,12 +3555,12 @@ type ResultAttribute struct { // An S3 bucket where you want to store the results of this request. type S3OutputLocation struct { - // The S3 bucket subfolder. - OutputS3KeyPrefix *string - // The name of the S3 bucket. OutputS3BucketName *string + // The S3 bucket subfolder. + OutputS3KeyPrefix *string + // (Deprecated) You can no longer specify this parameter. The system ignores it. // Instead, Systems Manager automatically determines the Region of the S3 bucket. OutputS3Region *string @@ -3580,11 +3580,11 @@ type ScheduledWindowExecution struct { // to be run. ExecutionTime *string - // The ID of the maintenance window to be run. - WindowId *string - // The name of the maintenance window to be run. Name *string + + // The ID of the maintenance window to be run. + WindowId *string } // The service setting data structure.

    ServiceSetting is an @@ -3602,13 +3602,19 @@ type ScheduledWindowExecution struct { // the AWS service team. type ServiceSetting struct { - // The ID of the service setting. - SettingId *string + // The ARN of the service setting. + ARN *string + + // The last time the service setting was modified. + LastModifiedDate *time.Time // The ARN of the last modified user. This field is populated only if the setting // value was overwritten. LastModifiedUser *string + // The ID of the service setting. + SettingId *string + // The value of the service setting. SettingValue *string @@ -3625,49 +3631,48 @@ type ServiceSetting struct { // setting uses a default or custom value, but a setting change request is pending // approval. Status *string - - // The ARN of the service setting. - ARN *string - - // The last time the service setting was modified. - LastModifiedDate *time.Time } // Information about a Session Manager connection to an instance. type Session struct { - // The date and time, in ISO-8601 Extended format, when the session was terminated. - EndDate *time.Time - - // The ID of the session. - SessionId *string - - // The date and time, in ISO-8601 Extended format, when the session began. - StartDate *time.Time - // Reserved for future use. - OutputUrl *SessionManagerOutputUrl + Details *string // The name of the Session Manager SSM document used to define the parameters and // plugin settings for the session. For example, SSM-SessionManagerRunShell. DocumentName *string - // The instance that the Session Manager session connected to. - Target *string + // The date and time, in ISO-8601 Extended format, when the session was terminated. + EndDate *time.Time // Reserved for future use. - Details *string + OutputUrl *SessionManagerOutputUrl + + // The ID of the AWS user account that started the session. + Owner *string + + // The ID of the session. + SessionId *string + + // The date and time, in ISO-8601 Extended format, when the session began. + StartDate *time.Time // The status of the session. For example, "Connected" or "Terminated". Status SessionStatus - // The ID of the AWS user account that started the session. - Owner *string + // The instance that the Session Manager session connected to. + Target *string } // Describes a filter for Session Manager information. type SessionFilter struct { + // The name of the filter. + // + // This member is required. + Key SessionFilterKey + // The filter value. Valid values for each filter key are as follows: // // * @@ -3704,11 +3709,6 @@ type SessionFilter struct { // // This member is required. Value *string - - // The name of the filter. - // - // This member is required. - Key SessionFilterKey } // Reserved for future use. @@ -3726,30 +3726,30 @@ type SessionManagerOutputUrl struct { type SeveritySummary struct { // The total number of resources or compliance items that have a severity level of - // low. Low severity is determined by the organization that published the - // compliance items. - LowCount *int32 - - // The total number of resources or compliance items that have a severity level of - // medium. Medium severity is determined by the organization that published the + // critical. Critical severity is determined by the organization that published the // compliance items. - MediumCount *int32 + CriticalCount *int32 // The total number of resources or compliance items that have a severity level of // high. High severity is determined by the organization that published the // compliance items. HighCount *int32 - // The total number of resources or compliance items that have a severity level of - // critical. Critical severity is determined by the organization that published the - // compliance items. - CriticalCount *int32 - // The total number of resources or compliance items that have a severity level of // informational. Informational severity is determined by the organization that // published the compliance items. InformationalCount *int32 + // The total number of resources or compliance items that have a severity level of + // low. Low severity is determined by the organization that published the + // compliance items. + LowCount *int32 + + // The total number of resources or compliance items that have a severity level of + // medium. Medium severity is determined by the organization that published the + // compliance items. + MediumCount *int32 + // The total number of resources or compliance items that have a severity level of // unspecified. Unspecified severity is determined by the organization that // published the compliance items. @@ -3759,60 +3759,37 @@ type SeveritySummary struct { // Detailed information about an the execution state of an Automation step. type StepExecution struct { - // The execution status for this step. - StepStatus AutomationExecutionStatus - - // A user-specified list of parameters to override when running a step. - OverriddenParameters map[string][]*string - - // Returned values from the execution of the step. - Outputs map[string][]*string - - // The maximum number of tries to run the action of the step. The default value is - // 1. - MaxAttempts *int32 - - // The unique ID of a step execution. - StepExecutionId *string - - // Information about the Automation failure. - FailureDetails *FailureDetails - - // The flag which can be used to help decide whether the failure of current step - // leads to the Automation failure. - IsCritical *bool - - // The timeout seconds of the step. - TimeoutSeconds *int64 - // The action this step performs. The action determines the behavior of the step. Action *string - // Strategies used when step fails, we support Continue and Abort. Abort will fail - // the automation when the step fails. Continue will ignore the failure of current - // step and allow automation to run the next step. With conditional branching, we - // add step:stepName to support the automation to go to another specific step. - ValidNextSteps []*string + // If a step has finished execution, this contains the time the execution ended. If + // the step has not yet concluded, this field is not populated. + ExecutionEndTime *time.Time // If a step has begun execution, this contains the time the step started. If the // step is in Pending status, this field is not populated. ExecutionStartTime *time.Time + // Information about the Automation failure. + FailureDetails *FailureDetails + // If a step failed, this message explains why the execution failed. FailureMessage *string - // The name of this execution step. - StepName *string + // Fully-resolved values passed into the step before execution. + Inputs map[string]*string + + // The flag which can be used to help decide whether the failure of current step + // leads to the Automation failure. + IsCritical *bool // The flag which can be used to end automation no matter whether the step succeeds // or fails. IsEnd *bool - // The targets for the step execution. - Targets []*Target - - // Fully-resolved values passed into the step before execution. - Inputs map[string]*string + // The maximum number of tries to run the action of the step. The default value is + // 1. + MaxAttempts *int32 // The next step after the step succeeds. NextStep *string @@ -3820,9 +3797,11 @@ type StepExecution struct { // The action to take if the step fails. The default value is Abort. OnFailure *string - // If a step has finished execution, this contains the time the execution ended. If - // the step has not yet concluded, this field is not populated. - ExecutionEndTime *time.Time + // Returned values from the execution of the step. + Outputs map[string][]*string + + // A user-specified list of parameters to override when running a step. + OverriddenParameters map[string][]*string // A message associated with the response code for an execution. Response *string @@ -3830,9 +3809,30 @@ type StepExecution struct { // The response code returned by the execution of the step. ResponseCode *string + // The unique ID of a step execution. + StepExecutionId *string + + // The name of this execution step. + StepName *string + + // The execution status for this step. + StepStatus AutomationExecutionStatus + // The combination of AWS Regions and accounts targeted by the current Automation // execution. TargetLocation *TargetLocation + + // The targets for the step execution. + Targets []*Target + + // The timeout seconds of the step. + TimeoutSeconds *int64 + + // Strategies used when step fails, we support Continue and Abort. Abort will fail + // the automation when the step fails. Continue will ignore the failure of current + // step and allow automation to run the next step. With conditional branching, we + // add step:stepName to support the automation to go to another specific step. + ValidNextSteps []*string } // A filter to limit the amount of step execution information returned by the call. @@ -3942,20 +3942,20 @@ type Target struct { // execution. type TargetLocation struct { + // The AWS accounts targeted by the current Automation execution. + Accounts []*string + // The Automation execution role used by the currently running Automation. ExecutionRoleName *string // The AWS Regions targeted by the current Automation execution. Regions []*string - // The maximum number of errors allowed before the system stops queueing additional - // Automation executions for the currently running Automation. - TargetLocationMaxErrors *string - // The maximum number of AWS accounts and AWS regions allowed to run the Automation // concurrently TargetLocationMaxConcurrency *string - // The AWS accounts targeted by the current Automation execution. - Accounts []*string + // The maximum number of errors allowed before the system stops queueing additional + // Automation executions for the currently running Automation. + TargetLocationMaxErrors *string } diff --git a/service/sso/api_op_GetRoleCredentials.go b/service/sso/api_op_GetRoleCredentials.go index 7d35c364a0d..2bc9ca0e1b0 100644 --- a/service/sso/api_op_GetRoleCredentials.go +++ b/service/sso/api_op_GetRoleCredentials.go @@ -55,11 +55,6 @@ func (c *Client) GetRoleCredentials(ctx context.Context, params *GetRoleCredenti type GetRoleCredentialsInput struct { - // The identifier for the AWS account that is assigned to the user. - // - // This member is required. - AccountId *string - // The token issued by the CreateToken API call. For more information, see // CreateToken // (https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html) @@ -68,6 +63,11 @@ type GetRoleCredentialsInput struct { // This member is required. AccessToken *string + // The identifier for the AWS account that is assigned to the user. + // + // This member is required. + AccountId *string + // The friendly name of the role that is assigned to the user. // // This member is required. diff --git a/service/sso/api_op_ListAccountRoles.go b/service/sso/api_op_ListAccountRoles.go index 9e6fba68a8c..cf2cc8a8a17 100644 --- a/service/sso/api_op_ListAccountRoles.go +++ b/service/sso/api_op_ListAccountRoles.go @@ -54,10 +54,6 @@ func (c *Client) ListAccountRoles(ctx context.Context, params *ListAccountRolesI type ListAccountRolesInput struct { - // The page token from the previous response output when you request subsequent - // pages. - NextToken *string - // The token issued by the CreateToken API call. For more information, see // CreateToken // (https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html) @@ -73,6 +69,10 @@ type ListAccountRolesInput struct { // The number of items that clients can request per page. MaxResults *int32 + + // The page token from the previous response output when you request subsequent + // pages. + NextToken *string } type ListAccountRolesOutput struct { diff --git a/service/sso/go.mod b/service/sso/go.mod index c30eb892788..fceb20ede37 100644 --- a/service/sso/go.mod +++ b/service/sso/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/sso go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/sso/types/types.go b/service/sso/types/types.go index 34209e3cb25..80f072160e6 100644 --- a/service/sso/types/types.go +++ b/service/sso/types/types.go @@ -8,22 +8,16 @@ type AccountInfo struct { // The identifier of the AWS account that is assigned to the user. AccountId *string - // The email address of the AWS account that is assigned to the user. - EmailAddress *string - // The display name of the AWS account that is assigned to the user. AccountName *string + + // The email address of the AWS account that is assigned to the user. + EmailAddress *string } // Provides information about the role credentials that are assigned to the user. type RoleCredentials struct { - // The key that is used to sign the request. For more information, see Using - // Temporary Security Credentials to Request Access to AWS Resources - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html) - // in the AWS IAM User Guide. - SecretAccessKey *string - // The identifier used for the temporary security credentials. For more // information, see Using Temporary Security Credentials to Request Access to AWS // Resources @@ -34,6 +28,12 @@ type RoleCredentials struct { // The date on which temporary security credentials expire. Expiration *int64 + // The key that is used to sign the request. For more information, see Using + // Temporary Security Credentials to Request Access to AWS Resources + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html) + // in the AWS IAM User Guide. + SecretAccessKey *string + // The token used for temporary credentials. For more information, see Using // Temporary Security Credentials to Request Access to AWS Resources // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html) @@ -44,9 +44,9 @@ type RoleCredentials struct { // Provides information about the role that is assigned to the user. type RoleInfo struct { - // The friendly name of the role that is assigned to the user. - RoleName *string - // The identifier of the AWS account assigned to the user. AccountId *string + + // The friendly name of the role that is assigned to the user. + RoleName *string } diff --git a/service/ssooidc/api_op_CreateToken.go b/service/ssooidc/api_op_CreateToken.go index 22bc9a221d7..ac969e20a41 100644 --- a/service/ssooidc/api_op_CreateToken.go +++ b/service/ssooidc/api_op_CreateToken.go @@ -55,29 +55,17 @@ func (c *Client) CreateToken(ctx context.Context, params *CreateTokenInput, optF type CreateTokenInput struct { - // The list of scopes that is defined by the client. Upon authorization, this list - // is used to restrict permissions when granting an access token. - Scope []*string - // The unique identifier string for each client. This value should come from the // persisted result of the RegisterClient () API. // // This member is required. ClientId *string - // The location of the application that will receive the authorization code. Users - // authorize the service to send the request to this location. - RedirectUri *string - - // Supports grant types for authorization code, refresh token, and device code - // request. + // A secret string generated for the client. This value should come from the + // persisted result of the RegisterClient () API. // // This member is required. - GrantType *string - - // The token used to obtain an access token in the event that the access token is - // invalid or expired. This token is not issued by the service. - RefreshToken *string + ClientSecret *string // Used only when calling this API for the device code grant type. This short-term // code is used to identify this authentication attempt. This should come from an @@ -86,32 +74,44 @@ type CreateTokenInput struct { // This member is required. DeviceCode *string + // Supports grant types for authorization code, refresh token, and device code + // request. + // + // This member is required. + GrantType *string + // The authorization code received from the authorization service. This parameter // is required to perform an authorization grant request to get access to a token. Code *string - // A secret string generated for the client. This value should come from the - // persisted result of the RegisterClient () API. - // - // This member is required. - ClientSecret *string + // The location of the application that will receive the authorization code. Users + // authorize the service to send the request to this location. + RedirectUri *string + + // The token used to obtain an access token in the event that the access token is + // invalid or expired. This token is not issued by the service. + RefreshToken *string + + // The list of scopes that is defined by the client. Upon authorization, this list + // is used to restrict permissions when granting an access token. + Scope []*string } type CreateTokenOutput struct { + // An opaque token to access AWS SSO resources assigned to a user. + AccessToken *string + // Indicates the time in seconds when an access token will expire. ExpiresIn *int32 + // The identifier of the user that associated with the access token, if present. + IdToken *string + // A token that, if present, can be used to refresh a previously issued access // token that might have expired. RefreshToken *string - // An opaque token to access AWS SSO resources assigned to a user. - AccessToken *string - - // The identifier of the user that associated with the access token, if present. - IdToken *string - // Used to notify the client that the returned token is an access token. The // supported type is BearerToken. TokenType *string diff --git a/service/ssooidc/api_op_RegisterClient.go b/service/ssooidc/api_op_RegisterClient.go index c76b3527cd8..eb2ce3cb22b 100644 --- a/service/ssooidc/api_op_RegisterClient.go +++ b/service/ssooidc/api_op_RegisterClient.go @@ -55,16 +55,16 @@ func (c *Client) RegisterClient(ctx context.Context, params *RegisterClientInput type RegisterClientInput struct { - // The type of client. The service supports only public as a client type. Anything - // other than public will be rejected by the service. + // The friendly name of the client. // // This member is required. - ClientType *string + ClientName *string - // The friendly name of the client. + // The type of client. The service supports only public as a client type. Anything + // other than public will be rejected by the service. // // This member is required. - ClientName *string + ClientType *string // The list of scopes that are defined by the client. Upon authorization, this list // is used to restrict permissions when granting an access token. @@ -76,22 +76,22 @@ type RegisterClientOutput struct { // The endpoint where the client can request authorization. AuthorizationEndpoint *string - // A secret string generated for the client. The client will use this string to get - // authenticated by the service in subsequent calls. - ClientSecret *string - - // The endpoint where the client can get an access token. - TokenEndpoint *string - // The unique identifier string for each client. This client uses this identifier // to get authenticated by the service in subsequent calls. ClientId *string + // Indicates the time at which the clientId and clientSecret were issued. + ClientIdIssuedAt *int64 + + // A secret string generated for the client. The client will use this string to get + // authenticated by the service in subsequent calls. + ClientSecret *string + // Indicates the time at which the clientId and clientSecret will become invalid. ClientSecretExpiresAt *int64 - // Indicates the time at which the clientId and clientSecret were issued. - ClientIdIssuedAt *int64 + // The endpoint where the client can get an access token. + TokenEndpoint *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/ssooidc/api_op_StartDeviceAuthorization.go b/service/ssooidc/api_op_StartDeviceAuthorization.go index f5f5432bcd6..df3f086d02a 100644 --- a/service/ssooidc/api_op_StartDeviceAuthorization.go +++ b/service/ssooidc/api_op_StartDeviceAuthorization.go @@ -54,6 +54,13 @@ func (c *Client) StartDeviceAuthorization(ctx context.Context, params *StartDevi type StartDeviceAuthorizationInput struct { + // The unique identifier string for the client that is registered with AWS SSO. + // This value should come from the persisted result of the RegisterClient () API + // operation. + // + // This member is required. + ClientId *string + // A secret string that is generated for the client. This value should come from // the persisted result of the RegisterClient () API operation. // @@ -67,41 +74,34 @@ type StartDeviceAuthorizationInput struct { // // This member is required. StartUrl *string - - // The unique identifier string for the client that is registered with AWS SSO. - // This value should come from the persisted result of the RegisterClient () API - // operation. - // - // This member is required. - ClientId *string } type StartDeviceAuthorizationOutput struct { - // The URI of the verification page that takes the userCode to authorize the - // device. - VerificationUri *string + // The short-lived code that is used by the device when polling for a session + // token. + DeviceCode *string - // A one-time user verification code. This is needed to authorize an in-use device. - UserCode *string + // Indicates the number of seconds in which the verification code will become + // invalid. + ExpiresIn *int32 // Indicates the number of seconds the client must wait between attempts when // polling for a session. Interval *int32 - // Indicates the number of seconds in which the verification code will become - // invalid. - ExpiresIn *int32 + // A one-time user verification code. This is needed to authorize an in-use device. + UserCode *string + + // The URI of the verification page that takes the userCode to authorize the + // device. + VerificationUri *string // An alternate URL that the client can use to automatically launch a browser. This // process skips the manual step in which the user visits the verification page and // enters their code. VerificationUriComplete *string - // The short-lived code that is used by the device when polling for a session - // token. - DeviceCode *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/ssooidc/go.mod b/service/ssooidc/go.mod index 625e8bd8dbe..d20dc2dcc10 100644 --- a/service/ssooidc/go.mod +++ b/service/ssooidc/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/ssooidc go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/storagegateway/api_op_ActivateGateway.go b/service/storagegateway/api_op_ActivateGateway.go index f7fc3a30748..7ea2c9805d0 100644 --- a/service/storagegateway/api_op_ActivateGateway.go +++ b/service/storagegateway/api_op_ActivateGateway.go @@ -71,29 +71,6 @@ func (c *Client) ActivateGateway(ctx context.Context, params *ActivateGatewayInp // ActivateGatewayInput$TapeDriveType

    type ActivateGatewayInput struct { - // A value that defines the type of gateway to activate. The type specified is - // critical to all later functions of the gateway and cannot be changed after - // activation. The default value is CACHED.

    Valid Values: STORED | - // CACHED | VTL | FILE_S3

    - GatewayType *string - - // A value that indicates the AWS Region where you want to store your data. The - // gateway AWS Region specified must be the same AWS Region as the AWS Region in - // your Host header in the request. For more information about available AWS - // Regions and endpoints for AWS Storage Gateway, see AWS Storage Gateway endpoints - // and quotas (https://docs.aws.amazon.com/general/latest/gr/sg.html) in the AWS - // General Reference.

    Valid Values: See AWS Storage Gateway - // endpoints and quotas in the AWS General Reference.

    - // - // This member is required. - GatewayRegion *string - - // The value that indicates the type of medium changer to use for tape gateway. - // This field is optional.

    Valid Values: STK-L700 | - // AWS-Gateway-VTL

    - MediumChangerType *string - // Your gateway activation key. You can obtain the activation key by sending an // HTTP GET request with redirects enabled to the gateway IP address (port 80). The // redirect URL returned in the response provides you the activation key for your @@ -107,9 +84,22 @@ type ActivateGatewayInput struct { // This member is required. ActivationKey *string - // The value that indicates the type of tape drive to use for tape gateway. This - // field is optional.

    Valid Values: IBM-ULT3580-TD5

    - TapeDriveType *string + // The name you configured for your gateway. + // + // This member is required. + GatewayName *string + + // A value that indicates the AWS Region where you want to store your data. The + // gateway AWS Region specified must be the same AWS Region as the AWS Region in + // your Host header in the request. For more information about available AWS + // Regions and endpoints for AWS Storage Gateway, see AWS Storage Gateway endpoints + // and quotas (https://docs.aws.amazon.com/general/latest/gr/sg.html) in the AWS + // General Reference.

    Valid Values: See AWS Storage Gateway + // endpoints and quotas in the AWS General Reference.

    + // + // This member is required. + GatewayRegion *string // A value that indicates the time zone you want to set for the gateway. The time // zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 @@ -120,10 +110,16 @@ type ActivateGatewayInput struct { // This member is required. GatewayTimezone *string - // The name you configured for your gateway. - // - // This member is required. - GatewayName *string + // A value that defines the type of gateway to activate. The type specified is + // critical to all later functions of the gateway and cannot be changed after + // activation. The default value is CACHED.

    Valid Values: STORED | + // CACHED | VTL | FILE_S3

    + GatewayType *string + + // The value that indicates the type of medium changer to use for tape gateway. + // This field is optional.

    Valid Values: STK-L700 | + // AWS-Gateway-VTL

    + MediumChangerType *string // A list of up to 50 tags that you can assign to the gateway. Each tag is a // key-value pair.

    Valid characters for key and value are letters, @@ -132,6 +128,10 @@ type ActivateGatewayInput struct { // characters, and the maximum length for a tag's value is 256 characters.

    //     Tags []*types.Tag + + // The value that indicates the type of tape drive to use for tape gateway. This + // field is optional.

    Valid Values: IBM-ULT3580-TD5

    + TapeDriveType *string } // AWS Storage Gateway returns the Amazon Resource Name (ARN) of the activated diff --git a/service/storagegateway/api_op_AddTagsToResource.go b/service/storagegateway/api_op_AddTagsToResource.go index eadcbbacf76..50164ce6fa2 100644 --- a/service/storagegateway/api_op_AddTagsToResource.go +++ b/service/storagegateway/api_op_AddTagsToResource.go @@ -66,6 +66,11 @@ func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourc // AddTagsToResourceInput type AddTagsToResourceInput struct { + // The Amazon Resource Name (ARN) of the resource you want to add tags to. + // + // This member is required. + ResourceARN *string + // The key-value pair that represents the tag you want to add to the resource. The // value can be an empty string.

    Valid characters for key and value are // letters, spaces, and numbers representable in UTF-8 format, and the following @@ -74,11 +79,6 @@ type AddTagsToResourceInput struct { // // This member is required. Tags []*types.Tag - - // The Amazon Resource Name (ARN) of the resource you want to add tags to. - // - // This member is required. - ResourceARN *string } // AddTagsToResourceOutput diff --git a/service/storagegateway/api_op_AddUploadBuffer.go b/service/storagegateway/api_op_AddUploadBuffer.go index fbd55b732db..b4ade9012da 100644 --- a/service/storagegateway/api_op_AddUploadBuffer.go +++ b/service/storagegateway/api_op_AddUploadBuffer.go @@ -60,18 +60,18 @@ func (c *Client) AddUploadBuffer(ctx context.Context, params *AddUploadBufferInp type AddUploadBufferInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation - // to return a list of gateways for your account and AWS Region. - // - // This member is required. - GatewayARN *string - // An array of strings that identify disks that are to be configured as working // storage. Each string has a minimum length of 1 and maximum length of 300. You // can get the disk IDs from the ListLocalDisks () API. // // This member is required. DiskIds []*string + + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation + // to return a list of gateways for your account and AWS Region. + // + // This member is required. + GatewayARN *string } type AddUploadBufferOutput struct { diff --git a/service/storagegateway/api_op_AddWorkingStorage.go b/service/storagegateway/api_op_AddWorkingStorage.go index 8959d0148ca..bafd51162f8 100644 --- a/service/storagegateway/api_op_AddWorkingStorage.go +++ b/service/storagegateway/api_op_AddWorkingStorage.go @@ -66,18 +66,18 @@ func (c *Client) AddWorkingStorage(ctx context.Context, params *AddWorkingStorag // AddWorkingStorageInput$DiskIds

    type AddWorkingStorageInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation - // to return a list of gateways for your account and AWS Region. - // - // This member is required. - GatewayARN *string - // An array of strings that identify disks that are to be configured as working // storage. Each string has a minimum length of 1 and maximum length of 300. You // can get the disk IDs from the ListLocalDisks () API. // // This member is required. DiskIds []*string + + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation + // to return a list of gateways for your account and AWS Region. + // + // This member is required. + GatewayARN *string } // A JSON object containing the Amazon Resource Name (ARN) of the gateway for which diff --git a/service/storagegateway/api_op_AttachVolume.go b/service/storagegateway/api_op_AttachVolume.go index 1ba491c3b47..8fbc1f6feb7 100644 --- a/service/storagegateway/api_op_AttachVolume.go +++ b/service/storagegateway/api_op_AttachVolume.go @@ -61,31 +61,12 @@ func (c *Client) AttachVolume(ctx context.Context, params *AttachVolumeInput, op // AttachVolumeInput type AttachVolumeInput struct { - // The Amazon Resource Name (ARN) of the volume to attach to the specified gateway. - // - // This member is required. - VolumeARN *string - - // The name of the iSCSI target used by an initiator to connect to a volume and - // used as a suffix for the target ARN. For example, specifying TargetName as - // myvolume results in the target ARN of - // arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. - // The target name must be unique across all volumes on a gateway.

    If you don't - // specify a value, Storage Gateway uses the value that was previously used for - // this volume as the new target name.

    - TargetName *string - // The Amazon Resource Name (ARN) of the gateway that you want to attach the volume // to. // // This member is required. GatewayARN *string - // The unique device ID or other distinguishing data that identifies the local disk - // used to create the volume. This value is only required when you are attaching a - // stored volume. - DiskId *string - // The network interface of the gateway on which to expose the iSCSI target. Only // IPv4 addresses are accepted. Use DescribeGatewayInformation () to get a list of // the network interfaces available on a gateway.

    Valid Values: A valid IP @@ -93,18 +74,37 @@ type AttachVolumeInput struct { // // This member is required. NetworkInterfaceId *string + + // The Amazon Resource Name (ARN) of the volume to attach to the specified gateway. + // + // This member is required. + VolumeARN *string + + // The unique device ID or other distinguishing data that identifies the local disk + // used to create the volume. This value is only required when you are attaching a + // stored volume. + DiskId *string + + // The name of the iSCSI target used by an initiator to connect to a volume and + // used as a suffix for the target ARN. For example, specifying TargetName as + // myvolume results in the target ARN of + // arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. + // The target name must be unique across all volumes on a gateway.

    If you don't + // specify a value, Storage Gateway uses the value that was previously used for + // this volume as the new target name.

    + TargetName *string } // AttachVolumeOutput type AttachVolumeOutput struct { - // The Amazon Resource Name (ARN) of the volume that was attached to the gateway. - VolumeARN *string - // The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI // name for the initiator that was used to connect to the target. TargetARN *string + // The Amazon Resource Name (ARN) of the volume that was attached to the gateway. + VolumeARN *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/storagegateway/api_op_CancelRetrieval.go b/service/storagegateway/api_op_CancelRetrieval.go index 07eebea1a0b..536d9adb523 100644 --- a/service/storagegateway/api_op_CancelRetrieval.go +++ b/service/storagegateway/api_op_CancelRetrieval.go @@ -59,17 +59,17 @@ func (c *Client) CancelRetrieval(ctx context.Context, params *CancelRetrievalInp // CancelRetrievalInput type CancelRetrievalInput struct { - // The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval - // for. - // - // This member is required. - TapeARN *string - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation // to return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string + + // The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval + // for. + // + // This member is required. + TapeARN *string } // CancelRetrievalOutput diff --git a/service/storagegateway/api_op_CreateCachediSCSIVolume.go b/service/storagegateway/api_op_CreateCachediSCSIVolume.go index 347238f94bc..fd9c7131e0b 100644 --- a/service/storagegateway/api_op_CreateCachediSCSIVolume.go +++ b/service/storagegateway/api_op_CreateCachediSCSIVolume.go @@ -70,11 +70,17 @@ func (c *Client) CreateCachediSCSIVolume(ctx context.Context, params *CreateCach type CreateCachediSCSIVolumeInput struct { - // The ARN for an existing volume. Specifying this ARN makes the new volume into an - // exact copy of the specified existing volume's latest recovery point. The - // VolumeSizeInBytes value for this new volume must be equal to or larger than the - // size of the existing volume, in bytes. - SourceVolumeARN *string + // A unique identifier that you use to retry a request. If you retry a request, use + // the same ClientToken you specified in the initial request. + // + // This member is required. + ClientToken *string + + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation + // to return a list of gateways for your account and AWS Region. + // + // This member is required. + GatewayARN *string // The network interface of the gateway on which to expose the iSCSI target. Only // IPv4 addresses are accepted. Use DescribeGatewayInformation () to get a list of @@ -84,45 +90,31 @@ type CreateCachediSCSIVolumeInput struct { // This member is required. NetworkInterfaceId *string - // A unique identifier that you use to retry a request. If you retry a request, use - // the same ClientToken you specified in the initial request. + // The name of the iSCSI target used by an initiator to connect to a volume and + // used as a suffix for the target ARN. For example, specifying TargetName as + // myvolume results in the target ARN of + // arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. + // The target name must be unique across all volumes on a gateway.

    If you don't + // specify a value, Storage Gateway uses the value that was previously used for + // this volume as the new target name.

    // // This member is required. - ClientToken *string + TargetName *string // The size of the volume in bytes. // // This member is required. VolumeSizeInBytes *int64 - // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for - // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric - // CMKs. This value can only be set when KMSEncrypted is true. Optional. - KMSKey *string - // Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, // or false to use a key managed by Amazon S3. Optional.

    Valid Values: // true | false

    KMSEncrypted *bool - // The name of the iSCSI target used by an initiator to connect to a volume and - // used as a suffix for the target ARN. For example, specifying TargetName as - // myvolume results in the target ARN of - // arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. - // The target name must be unique across all volumes on a gateway.

    If you don't - // specify a value, Storage Gateway uses the value that was previously used for - // this volume as the new target name.

    - // - // This member is required. - TargetName *string - - // A list of up to 50 tags that you can assign to a cached volume. Each tag is a - // key-value pair.

    Valid characters for key and value are letters, - // spaces, and numbers that you can represent in UTF-8 format, and the following - // special characters: + - = . _ : / @. The maximum length of a tag's key is 128 - // characters, and the maximum length for a tag's value is 256 characters.

    - //     - Tags []*types.Tag + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for + // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric + // CMKs. This value can only be set when KMSEncrypted is true. Optional. + KMSKey *string // The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new // cached volume. Specify this field if you want to create the iSCSI storage volume @@ -132,22 +124,30 @@ type CreateCachediSCSIVolumeInput struct { // in the Amazon Elastic Compute Cloud API Reference. SnapshotId *string - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation - // to return a list of gateways for your account and AWS Region. - // - // This member is required. - GatewayARN *string + // The ARN for an existing volume. Specifying this ARN makes the new volume into an + // exact copy of the specified existing volume's latest recovery point. The + // VolumeSizeInBytes value for this new volume must be equal to or larger than the + // size of the existing volume, in bytes. + SourceVolumeARN *string + + // A list of up to 50 tags that you can assign to a cached volume. Each tag is a + // key-value pair.

    Valid characters for key and value are letters, + // spaces, and numbers that you can represent in UTF-8 format, and the following + // special characters: + - = . _ : / @. The maximum length of a tag's key is 128 + // characters, and the maximum length for a tag's value is 256 characters.

    + //     + Tags []*types.Tag } type CreateCachediSCSIVolumeOutput struct { - // The Amazon Resource Name (ARN) of the configured volume. - VolumeARN *string - // The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI // name that initiators can use to connect to the target. TargetARN *string + // The Amazon Resource Name (ARN) of the configured volume. + VolumeARN *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/storagegateway/api_op_CreateNFSFileShare.go b/service/storagegateway/api_op_CreateNFSFileShare.go index c3522aa12a0..89ad9ddafa7 100644 --- a/service/storagegateway/api_op_CreateNFSFileShare.go +++ b/service/storagegateway/api_op_CreateNFSFileShare.go @@ -69,16 +69,23 @@ func (c *Client) CreateNFSFileShare(ctx context.Context, params *CreateNFSFileSh // CreateNFSFileShareInput type CreateNFSFileShareInput struct { - // The default storage class for objects put into an Amazon S3 bucket by the file - // gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

    Valid - // Values: S3_STANDARD | S3_INTELLIGENT_TIERING | - // S3_STANDARD_IA | S3_ONEZONE_IA

    - DefaultStorageClass *string + // A unique string value that you supply that is used by file gateway to ensure + // idempotent file share creation. + // + // This member is required. + ClientToken *string - // Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, - // or false to use a key managed by Amazon S3. Optional.

    Valid Values: - // true | false

    - KMSEncrypted *bool + // The Amazon Resource Name (ARN) of the file gateway on which you want to create a + // file share. + // + // This member is required. + GatewayARN *string + + // The ARN of the backend storage used for storing file data. A prefix name can be + // added to the S3 bucket name. It must end with a "/". + // + // This member is required. + LocationARN *string // The ARN of the AWS Identity and Access Management (IAM) role that a file gateway // assumes when it accesses the underlying storage. @@ -86,39 +93,51 @@ type CreateNFSFileShareInput struct { // This member is required. Role *string + // Refresh cache information. + CacheAttributes *types.CacheAttributes + // The list of clients that are allowed to access the file gateway. The list must // contain either valid IP addresses or valid CIDR blocks. ClientList []*string + // The default storage class for objects put into an Amazon S3 bucket by the file + // gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

    Valid + // Values: S3_STANDARD | S3_INTELLIGENT_TIERING | + // S3_STANDARD_IA | S3_ONEZONE_IA

    + DefaultStorageClass *string + + // The name of the file share. Optional.

    FileShareName + // must be set if an S3 prefix name is set in LocationARN.

     + FileShareName *string + + // A value that enables guessing of the MIME type for uploaded objects based on + // file extensions. Set this value to true to enable MIME type guessing, otherwise + // set to false. The default value is true.

    Valid Values: true | + // false

    + GuessMIMETypeEnabled *bool + + // Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, + // or false to use a key managed by Amazon S3. Optional.

    Valid Values: + // true | false

    + KMSEncrypted *bool + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric // CMKs. This value can only be set when KMSEncrypted is true. Optional. KMSKey *string + // File share default values. Optional. + NFSFileShareDefaults *types.NFSFileShareDefaults + + // A value that sets the access control list (ACL) permission for objects in the S3 + // bucket that a file gateway puts objects into. The default value is private. + ObjectACL types.ObjectACL + // A value that sets the write status of a file share. Set this value to true to // set the write status to read-only, otherwise set to false.

    Valid Values: // true | false

    ReadOnly *bool - // The Amazon Resource Name (ARN) of the file gateway on which you want to create a - // file share. - // - // This member is required. - GatewayARN *string - - // Refresh cache information. - CacheAttributes *types.CacheAttributes - - // A list of up to 50 tags that can be assigned to the NFS file share. Each tag is - // a key-value pair.

    Valid characters for key and value are letters, - // spaces, and numbers representable in UTF-8 format, and the following special - // characters: + - = . _ : / @. The maximum length of a tag's key is 128 - // characters, and the maximum length for a tag's value is 256.

     - Tags []*types.Tag - - // File share default values. Optional. - NFSFileShareDefaults *types.NFSFileShareDefaults - // A value that sets who pays the cost of the request and the cost associated with // data download from the S3 bucket. If this value is set to true, the requester // pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket @@ -129,18 +148,6 @@ type CreateNFSFileShareInput struct { // false

    RequesterPays *bool - // A unique string value that you supply that is used by file gateway to ensure - // idempotent file share creation. - // - // This member is required. - ClientToken *string - - // The ARN of the backend storage used for storing file data. A prefix name can be - // added to the S3 bucket name. It must end with a "/". - // - // This member is required. - LocationARN *string - // A value that maps a user to anonymous user.

    Valid values are the // following:

    • RootSquash: Only root is mapped to // anonymous user.

    • NoSquash: No one is mapped to @@ -148,19 +155,12 @@ type CreateNFSFileShareInput struct { // anonymous user.

    Squash *string - // A value that enables guessing of the MIME type for uploaded objects based on - // file extensions. Set this value to true to enable MIME type guessing, otherwise - // set to false. The default value is true.

    Valid Values: true | - // false

    - GuessMIMETypeEnabled *bool - - // The name of the file share. Optional.

    FileShareName - // must be set if an S3 prefix name is set in LocationARN.

     - FileShareName *string - - // A value that sets the access control list (ACL) permission for objects in the S3 - // bucket that a file gateway puts objects into. The default value is private. - ObjectACL types.ObjectACL + // A list of up to 50 tags that can be assigned to the NFS file share. Each tag is + // a key-value pair.

    Valid characters for key and value are letters, + // spaces, and numbers representable in UTF-8 format, and the following special + // characters: + - = . _ : / @. The maximum length of a tag's key is 128 + // characters, and the maximum length for a tag's value is 256.

     + Tags []*types.Tag } // CreateNFSFileShareOutput diff --git a/service/storagegateway/api_op_CreateSMBFileShare.go b/service/storagegateway/api_op_CreateSMBFileShare.go index a180e949fe5..783fc66ee86 100644 --- a/service/storagegateway/api_op_CreateSMBFileShare.go +++ b/service/storagegateway/api_op_CreateSMBFileShare.go @@ -69,25 +69,22 @@ func (c *Client) CreateSMBFileShare(ctx context.Context, params *CreateSMBFileSh // CreateSMBFileShareInput type CreateSMBFileShareInput struct { + // A unique string value that you supply that is used by file gateway to ensure + // idempotent file share creation. + // + // This member is required. + ClientToken *string + // The ARN of the file gateway on which you want to create a file share. // // This member is required. GatewayARN *string - // Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, - // or false to use a key managed by Amazon S3. Optional.

    Valid Values: - // true | false

    - KMSEncrypted *bool - - // A list of up to 50 tags that can be assigned to the NFS file share. Each tag is - // a key-value pair.

    Valid characters for key and value are letters, - // spaces, and numbers representable in UTF-8 format, and the following special - // characters: + - = . _ : / @. The maximum length of a tag's key is 128 - // characters, and the maximum length for a tag's value is 256.

     - Tags []*types.Tag - - // Refresh cache information. - CacheAttributes *types.CacheAttributes + // The ARN of the backend storage used for storing file data. A prefix name can be + // added to the S3 bucket name. It must end with a "/". + // + // This member is required. + LocationARN *string // The ARN of the AWS Identity and Access Management (IAM) role that a file gateway // assumes when it accesses the underlying storage. @@ -95,15 +92,6 @@ type CreateSMBFileShareInput struct { // This member is required. Role *string - // Set this value to true to enable access control list (ACL) on the SMB file - // share. Set it to false to map file and directory permissions to the POSIX - // permissions.

    For more information, see Using - // Microsoft Windows ACLs to control access to an SMB file share in the AWS - // Storage Gateway User Guide.

    Valid Values: true | - // false

    - SMBACLEnabled *bool - // A list of users or groups in the Active Directory that will be granted // administrator privileges on the file share. These users can do all file // operations as the super-user. Acceptable formats include: DOMAIN\User1, user1, @@ -112,46 +100,31 @@ type CreateSMBFileShareInput struct { // regardless of file permissions.

    AdminUserList []*string - // The ARN of the backend storage used for storing file data. A prefix name can be - // added to the S3 bucket name. It must end with a "/". - // - // This member is required. - LocationARN *string + // The Amazon Resource Name (ARN) of the storage used for the audit logs. + AuditDestinationARN *string - // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for - // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric - // CMKs. This value can only be set when KMSEncrypted is true. Optional. - KMSKey *string + // The authentication method that users use to access the file share. The default + // is ActiveDirectory.

    Valid Values: ActiveDirectory | + // GuestAccess

    + Authentication *string - // A list of users or groups in the Active Directory that are allowed to access the - // file () share. A group must be prefixed with the @ character. Acceptable - // formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be - // set if Authentication is set to ActiveDirectory. - ValidUserList []*string + // Refresh cache information. + CacheAttributes *types.CacheAttributes // The case of an object name in an Amazon S3 bucket. For ClientSpecified, the // client determines the case sensitivity. For CaseSensitive, the gateway // determines the case sensitivity. The default value is ClientSpecified. CaseSensitivity types.CaseSensitivity - // A value that sets the write status of a file share. Set this value to true to - // set the write status to read-only, otherwise set to false.

    Valid Values: - // true | false

    - ReadOnly *bool - - // The Amazon Resource Name (ARN) of the storage used for the audit logs. - AuditDestinationARN *string - - // The authentication method that users use to access the file share. The default - // is ActiveDirectory.

    Valid Values: ActiveDirectory | - // GuestAccess

    - Authentication *string + // The default storage class for objects put into an Amazon S3 bucket by the file + // gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

    Valid + // Values: S3_STANDARD | S3_INTELLIGENT_TIERING | + // S3_STANDARD_IA | S3_ONEZONE_IA

    + DefaultStorageClass *string - // A unique string value that you supply that is used by file gateway to ensure - // idempotent file share creation. - // - // This member is required. - ClientToken *string + // The name of the file share. Optional.

    FileShareName + // must be set if an S3 prefix name is set in LocationARN.

     + FileShareName *string // A value that enables guessing of the MIME type for uploaded objects based on // file extensions. Set this value to true to enable MIME type guessing, otherwise @@ -165,9 +138,24 @@ type CreateSMBFileShareInput struct { // set if Authentication is set to ActiveDirectory. InvalidUserList []*string - // The name of the file share. Optional.

    FileShareName - // must be set if an S3 prefix name is set in LocationARN.

     - FileShareName *string + // Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, + // or false to use a key managed by Amazon S3. Optional.

    Valid Values: + // true | false

    + KMSEncrypted *bool + + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for + // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric + // CMKs. This value can only be set when KMSEncrypted is true. Optional. + KMSKey *string + + // A value that sets the access control list (ACL) permission for objects in the S3 + // bucket that a file gateway puts objects into. The default value is private. + ObjectACL types.ObjectACL + + // A value that sets the write status of a file share. Set this value to true to + // set the write status to read-only, otherwise set to false.

    Valid Values: + // true | false

    + ReadOnly *bool // A value that sets who pays the cost of the request and the cost associated with // data download from the S3 bucket. If this value is set to true, the requester @@ -179,15 +167,27 @@ type CreateSMBFileShareInput struct { // false

    RequesterPays *bool - // A value that sets the access control list (ACL) permission for objects in the S3 - // bucket that a file gateway puts objects into. The default value is private. - ObjectACL types.ObjectACL + // Set this value to true to enable access control list (ACL) on the SMB file + // share. Set it to false to map file and directory permissions to the POSIX + // permissions.

    For more information, see Using + // Microsoft Windows ACLs to control access to an SMB file share in the AWS + // Storage Gateway User Guide.

    Valid Values: true | + // false

    + SMBACLEnabled *bool - // The default storage class for objects put into an Amazon S3 bucket by the file - // gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

    Valid - // Values: S3_STANDARD | S3_INTELLIGENT_TIERING | - // S3_STANDARD_IA | S3_ONEZONE_IA

    - DefaultStorageClass *string + // A list of up to 50 tags that can be assigned to the NFS file share. Each tag is + // a key-value pair.

    Valid characters for key and value are letters, + // spaces, and numbers representable in UTF-8 format, and the following special + // characters: + - = . _ : / @. The maximum length of a tag's key is 128 + // characters, and the maximum length for a tag's value is 256.

     + Tags []*types.Tag + + // A list of users or groups in the Active Directory that are allowed to access the + // file () share. A group must be prefixed with the @ character. Acceptable + // formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be + // set if Authentication is set to ActiveDirectory. + ValidUserList []*string } // CreateSMBFileShareOutput diff --git a/service/storagegateway/api_op_CreateSnapshot.go b/service/storagegateway/api_op_CreateSnapshot.go index 9f268476c5f..1105a5d2377 100644 --- a/service/storagegateway/api_op_CreateSnapshot.go +++ b/service/storagegateway/api_op_CreateSnapshot.go @@ -83,12 +83,6 @@ func (c *Client) CreateSnapshot(ctx context.Context, params *CreateSnapshotInput // CreateSnapshotInput$VolumeARN

    type CreateSnapshotInput struct { - // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes () operation - // to return a list of gateway volumes. - // - // This member is required. - VolumeARN *string - // Textual description of the snapshot that appears in the Amazon EC2 console, // Elastic Block Store snapshots panel in the Description field, and in the AWS // Storage Gateway snapshot Details pane, Description field. @@ -96,6 +90,12 @@ type CreateSnapshotInput struct { // This member is required. SnapshotDescription *string + // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes () operation + // to return a list of gateway volumes. + // + // This member is required. + VolumeARN *string + // A list of up to 50 tags that can be assigned to a snapshot. Each tag is a // key-value pair.

    Valid characters for key and value are letters, // spaces, and numbers representable in UTF-8 format, and the following special diff --git a/service/storagegateway/api_op_CreateSnapshotFromVolumeRecoveryPoint.go b/service/storagegateway/api_op_CreateSnapshotFromVolumeRecoveryPoint.go index b561988c4c4..949d2d16465 100644 --- a/service/storagegateway/api_op_CreateSnapshotFromVolumeRecoveryPoint.go +++ b/service/storagegateway/api_op_CreateSnapshotFromVolumeRecoveryPoint.go @@ -73,13 +73,6 @@ func (c *Client) CreateSnapshotFromVolumeRecoveryPoint(ctx context.Context, para type CreateSnapshotFromVolumeRecoveryPointInput struct { - // A list of up to 50 tags that can be assigned to a snapshot. Each tag is a - // key-value pair.

    Valid characters for key and value are letters, - // spaces, and numbers representable in UTF-8 format, and the following special - // characters: + - = . _ : / @. The maximum length of a tag's key is 128 - // characters, and the maximum length for a tag's value is 256.

     - Tags []*types.Tag - // Textual description of the snapshot that appears in the Amazon EC2 console, // Elastic Block Store snapshots panel in the Description field, and in the AWS // Storage Gateway snapshot Details pane, Description field. @@ -93,18 +86,25 @@ type CreateSnapshotFromVolumeRecoveryPointInput struct { // // This member is required. VolumeARN *string + + // A list of up to 50 tags that can be assigned to a snapshot. Each tag is a + // key-value pair.

    Valid characters for key and value are letters, + // spaces, and numbers representable in UTF-8 format, and the following special + // characters: + - = . _ : / @. The maximum length of a tag's key is 128 + // characters, and the maximum length for a tag's value is 256.

     + Tags []*types.Tag } type CreateSnapshotFromVolumeRecoveryPointOutput struct { + // The ID of the snapshot. + SnapshotId *string + // The Amazon Resource Name (ARN) of the iSCSI volume target. Use the // DescribeStorediSCSIVolumes () operation to return to retrieve the TargetARN for // specified VolumeARN. VolumeARN *string - // The ID of the snapshot. - SnapshotId *string - // The time the volume was created from the recovery point. VolumeRecoveryPointTime *string diff --git a/service/storagegateway/api_op_CreateStorediSCSIVolume.go b/service/storagegateway/api_op_CreateStorediSCSIVolume.go index ec4bcb1ef35..4806eabb2b8 100644 --- a/service/storagegateway/api_op_CreateStorediSCSIVolume.go +++ b/service/storagegateway/api_op_CreateStorediSCSIVolume.go @@ -72,33 +72,6 @@ func (c *Client) CreateStorediSCSIVolume(ctx context.Context, params *CreateStor // CreateStorediSCSIVolumeInput$TargetName

    type CreateStorediSCSIVolumeInput struct { - // Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, - // or false to use a key managed by Amazon S3. Optional.

    Valid Values: - // true | false

    - KMSEncrypted *bool - - // The name of the iSCSI target used by an initiator to connect to a volume and - // used as a suffix for the target ARN. For example, specifying TargetName as - // myvolume results in the target ARN of - // arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. - // The target name must be unique across all volumes on a gateway.

    If you don't - // specify a value, Storage Gateway uses the value that was previously used for - // this volume as the new target name.

    - // - // This member is required. - TargetName *string - - // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for - // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric - // CMKs. This value can only be set when KMSEncrypted is true. Optional. - KMSKey *string - - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation - // to return a list of gateways for your account and AWS Region. - // - // This member is required. - GatewayARN *string - // The unique identifier for the gateway local disk that is configured as a stored // volume. Use ListLocalDisks // (https://docs.aws.amazon.com/storagegateway/latest/userguide/API_ListLocalDisks.html) @@ -107,12 +80,11 @@ type CreateStorediSCSIVolumeInput struct { // This member is required. DiskId *string - // A list of up to 50 tags that can be assigned to a stored volume. Each tag is a - // key-value pair.

    Valid characters for key and value are letters, - // spaces, and numbers representable in UTF-8 format, and the following special - // characters: + - = . _ : / @. The maximum length of a tag's key is 128 - // characters, and the maximum length for a tag's value is 256.

     - Tags []*types.Tag + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation + // to return a list of gateways for your account and AWS Region. + // + // This member is required. + GatewayARN *string // The network interface of the gateway on which to expose the iSCSI target. Only // IPv4 addresses are accepted. Use DescribeGatewayInformation () to get a list of @@ -122,6 +94,34 @@ type CreateStorediSCSIVolumeInput struct { // This member is required. NetworkInterfaceId *string + // Set to true true if you want to preserve the data on the local disk. Otherwise, + // set to false to create an empty volume.

    Valid Values: true | + // false

    + // + // This member is required. + PreserveExistingData *bool + + // The name of the iSCSI target used by an initiator to connect to a volume and + // used as a suffix for the target ARN. For example, specifying TargetName as + // myvolume results in the target ARN of + // arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. + // The target name must be unique across all volumes on a gateway.

    If you don't + // specify a value, Storage Gateway uses the value that was previously used for + // this volume as the new target name.

    + // + // This member is required. + TargetName *string + + // Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, + // or false to use a key managed by Amazon S3. Optional.

    Valid Values: + // true | false

    + KMSEncrypted *bool + + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for + // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric + // CMKs. This value can only be set when KMSEncrypted is true. Optional. + KMSKey *string + // The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new // stored volume. Specify this field if you want to create the iSCSI storage volume // from a snapshot; otherwise, do not include this field. To list snapshots for @@ -130,20 +130,17 @@ type CreateStorediSCSIVolumeInput struct { // in the Amazon Elastic Compute Cloud API Reference. SnapshotId *string - // Set to true true if you want to preserve the data on the local disk. Otherwise, - // set to false to create an empty volume.

    Valid Values: true | - // false

    - // - // This member is required. - PreserveExistingData *bool + // A list of up to 50 tags that can be assigned to a stored volume. Each tag is a + // key-value pair.

    Valid characters for key and value are letters, + // spaces, and numbers representable in UTF-8 format, and the following special + // characters: + - = . _ : / @. The maximum length of a tag's key is 128 + // characters, and the maximum length for a tag's value is 256.

     + Tags []*types.Tag } // A JSON object containing the following fields: type CreateStorediSCSIVolumeOutput struct { - // The size of the volume in bytes. - VolumeSizeInBytes *int64 - // The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI // name that initiators can use to connect to the target. TargetARN *string @@ -151,6 +148,9 @@ type CreateStorediSCSIVolumeOutput struct { // The Amazon Resource Name (ARN) of the configured volume. VolumeARN *string + // The size of the volume in bytes. + VolumeSizeInBytes *int64 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/storagegateway/api_op_CreateTapeWithBarcode.go b/service/storagegateway/api_op_CreateTapeWithBarcode.go index f594dae8072..5b3b0b2cc5f 100644 --- a/service/storagegateway/api_op_CreateTapeWithBarcode.go +++ b/service/storagegateway/api_op_CreateTapeWithBarcode.go @@ -63,6 +63,26 @@ func (c *Client) CreateTapeWithBarcode(ctx context.Context, params *CreateTapeWi // CreateTapeWithBarcodeInput type CreateTapeWithBarcodeInput struct { + // The unique Amazon Resource Name (ARN) that represents the gateway to associate + // the virtual tape with. Use the ListGateways () operation to return a list of + // gateways for your account and AWS Region. + // + // This member is required. + GatewayARN *string + + // The barcode that you want to assign to the tape.

    Barcodes cannot be + // reused. This includes barcodes used for tapes that have been deleted.

    + //     + // + // This member is required. + TapeBarcode *string + + // The size, in bytes, of the virtual tape that you want to create.

    The + // size must be aligned by gigabyte (1024*1024*1024 bytes).

     + // + // This member is required. + TapeSizeInBytes *int64 + // Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, // or false to use a key managed by Amazon S3. Optional.

    Valid Values: // true | false

    @@ -73,13 +93,6 @@ type CreateTapeWithBarcodeInput struct { // CMKs. This value can only be set when KMSEncrypted is true. Optional. KMSKey *string - // The barcode that you want to assign to the tape.

    Barcodes cannot be - // reused. This includes barcodes used for tapes that have been deleted.

    - //     - // - // This member is required. - TapeBarcode *string - // The ID of the pool that you want to add your tape to for archiving. The tape in // this pool is archived in the S3 storage class that is associated with the pool. // When you use your backup application to eject the tape, the tape is archived @@ -88,19 +101,6 @@ type CreateTapeWithBarcodeInput struct { //

    PoolId *string - // The size, in bytes, of the virtual tape that you want to create.

    The - // size must be aligned by gigabyte (1024*1024*1024 bytes).

     - // - // This member is required. - TapeSizeInBytes *int64 - - // The unique Amazon Resource Name (ARN) that represents the gateway to associate - // the virtual tape with. Use the ListGateways () operation to return a list of - // gateways for your account and AWS Region. - // - // This member is required. - GatewayARN *string - // A list of up to 50 tags that can be assigned to a virtual tape that has a // barcode. Each tag is a key-value pair.

    Valid characters for key and // value are letters, spaces, and numbers representable in UTF-8 format, and the diff --git a/service/storagegateway/api_op_CreateTapes.go b/service/storagegateway/api_op_CreateTapes.go index 25e3583e334..247d5d0df5d 100644 --- a/service/storagegateway/api_op_CreateTapes.go +++ b/service/storagegateway/api_op_CreateTapes.go @@ -62,6 +62,14 @@ func (c *Client) CreateTapes(ctx context.Context, params *CreateTapesInput, optF // CreateTapesInput type CreateTapesInput struct { + // A unique identifier that you use to retry a request. If you retry a request, use + // the same ClientToken you specified in the initial request.

    Using the + // same ClientToken prevents creating the tape multiple times.

    + //     + // + // This member is required. + ClientToken *string + // The unique Amazon Resource Name (ARN) that represents the gateway to associate // the virtual tapes with. Use the ListGateways () operation to return a list of // gateways for your account and AWS Region. @@ -69,18 +77,10 @@ type CreateTapesInput struct { // This member is required. GatewayARN *string - // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for - // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric - // CMKs. This value can only be set when KMSEncrypted is true. Optional. - KMSKey *string - - // The ID of the pool that you want to add your tape to for archiving. The tape in - // this pool is archived in the S3 storage class that is associated with the pool. - // When you use your backup application to eject the tape, the tape is archived - // directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that - // corresponds to the pool.

    Valid Values: GLACIER | - // DEEP_ARCHIVE

    - PoolId *string + // The number of virtual tapes that you want to create. + // + // This member is required. + NumTapesToCreate *int32 // A prefix that you append to the barcode of the virtual tape you are creating. // This prefix makes the barcode unique.

    The prefix must be 1 to 4 @@ -90,29 +90,29 @@ type CreateTapesInput struct { // This member is required. TapeBarcodePrefix *string - // Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, - // or false to use a key managed by Amazon S3. Optional.

    Valid Values: - // true | false

    - KMSEncrypted *bool - - // The number of virtual tapes that you want to create. - // - // This member is required. - NumTapesToCreate *int32 - // The size, in bytes, of the virtual tapes that you want to create.

    The // size must be aligned by gigabyte (1024*1024*1024 bytes).

     // // This member is required. TapeSizeInBytes *int64 - // A unique identifier that you use to retry a request. If you retry a request, use - // the same ClientToken you specified in the initial request.

    Using the - // same ClientToken prevents creating the tape multiple times.

    - //     - // - // This member is required. - ClientToken *string + // Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, + // or false to use a key managed by Amazon S3. Optional.

    Valid Values: + // true | false

    + KMSEncrypted *bool + + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for + // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric + // CMKs. This value can only be set when KMSEncrypted is true. Optional. + KMSKey *string + + // The ID of the pool that you want to add your tape to for archiving. The tape in + // this pool is archived in the S3 storage class that is associated with the pool. + // When you use your backup application to eject the tape, the tape is archived + // directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that + // corresponds to the pool.

    Valid Values: GLACIER | + // DEEP_ARCHIVE

    + PoolId *string // A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a // key-value pair.

    Valid characters for key and value are letters, diff --git a/service/storagegateway/api_op_DeleteBandwidthRateLimit.go b/service/storagegateway/api_op_DeleteBandwidthRateLimit.go index d9fef6bde8c..6cbeb0f11da 100644 --- a/service/storagegateway/api_op_DeleteBandwidthRateLimit.go +++ b/service/storagegateway/api_op_DeleteBandwidthRateLimit.go @@ -63,18 +63,18 @@ func (c *Client) DeleteBandwidthRateLimit(ctx context.Context, params *DeleteBan // DeleteBandwidthRateLimitInput$BandwidthType

    type DeleteBandwidthRateLimitInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation - // to return a list of gateways for your account and AWS Region. - // - // This member is required. - GatewayARN *string - // One of the BandwidthType values that indicates the gateway bandwidth rate limit // to delete.

    Valid Values: Upload | Download | // All

    // // This member is required. BandwidthType *string + + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation + // to return a list of gateways for your account and AWS Region. + // + // This member is required. + GatewayARN *string } // A JSON object containing the Amazon Resource Name (ARN) of the gateway whose diff --git a/service/storagegateway/api_op_DeleteChapCredentials.go b/service/storagegateway/api_op_DeleteChapCredentials.go index 04bb376a376..9f22b46b9bc 100644 --- a/service/storagegateway/api_op_DeleteChapCredentials.go +++ b/service/storagegateway/api_op_DeleteChapCredentials.go @@ -61,28 +61,28 @@ func (c *Client) DeleteChapCredentials(ctx context.Context, params *DeleteChapCr // DeleteChapCredentialsInput$TargetARN

    type DeleteChapCredentialsInput struct { + // The iSCSI initiator that connects to the target. + // + // This member is required. + InitiatorName *string + // The Amazon Resource Name (ARN) of the iSCSI volume target. Use the // DescribeStorediSCSIVolumes () operation to return to retrieve the TargetARN for // specified VolumeARN. // // This member is required. TargetARN *string - - // The iSCSI initiator that connects to the target. - // - // This member is required. - InitiatorName *string } // A JSON object containing the following fields: type DeleteChapCredentialsOutput struct { - // The Amazon Resource Name (ARN) of the target. - TargetARN *string - // The iSCSI initiator that connects to the target. InitiatorName *string + // The Amazon Resource Name (ARN) of the target. + TargetARN *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/storagegateway/api_op_DeleteFileShare.go b/service/storagegateway/api_op_DeleteFileShare.go index f153934f90d..d647e717b07 100644 --- a/service/storagegateway/api_op_DeleteFileShare.go +++ b/service/storagegateway/api_op_DeleteFileShare.go @@ -58,17 +58,17 @@ func (c *Client) DeleteFileShare(ctx context.Context, params *DeleteFileShareInp // DeleteFileShareInput type DeleteFileShareInput struct { + // The Amazon Resource Name (ARN) of the file share to be deleted. + // + // This member is required. + FileShareARN *string + // If this value is set to true, the operation deletes a file share immediately and // aborts all data uploads to AWS. Otherwise, the file share is not deleted until // all data is uploaded to AWS. This process aborts the data upload process, and // the file share enters the FORCE_DELETING status.

    Valid Values: // true | false

    ForceDelete *bool - - // The Amazon Resource Name (ARN) of the file share to be deleted. - // - // This member is required. - FileShareARN *string } // DeleteFileShareOutput diff --git a/service/storagegateway/api_op_DescribeAvailabilityMonitorTest.go b/service/storagegateway/api_op_DescribeAvailabilityMonitorTest.go index 8bc48c92d47..41bfd91008c 100644 --- a/service/storagegateway/api_op_DescribeAvailabilityMonitorTest.go +++ b/service/storagegateway/api_op_DescribeAvailabilityMonitorTest.go @@ -73,14 +73,14 @@ type DescribeAvailabilityMonitorTestOutput struct { // to return a list of gateways for your account and AWS Region. GatewayARN *string - // The status of the High Availability monitoring test. If a test hasn't been - // performed, the value of this field is null. - Status types.AvailabilityMonitorTestStatus - // The time the High Availability monitoring test was started. If a test hasn't // been performed, the value of this field is null. StartTime *time.Time + // The status of the High Availability monitoring test. If a test hasn't been + // performed, the value of this field is null. + Status types.AvailabilityMonitorTestStatus + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/storagegateway/api_op_DescribeBandwidthRateLimit.go b/service/storagegateway/api_op_DescribeBandwidthRateLimit.go index 05e701185e4..bce34b44f8c 100644 --- a/service/storagegateway/api_op_DescribeBandwidthRateLimit.go +++ b/service/storagegateway/api_op_DescribeBandwidthRateLimit.go @@ -73,6 +73,10 @@ type DescribeBandwidthRateLimitInput struct { // A JSON object containing the following fields: type DescribeBandwidthRateLimitOutput struct { + // The average download bandwidth rate limit in bits per second. This field does + // not appear in the response if the download rate limit is not set. + AverageDownloadRateLimitInBitsPerSec *int64 + // The average upload bandwidth rate limit in bits per second. This field does not // appear in the response if the upload rate limit is not set. AverageUploadRateLimitInBitsPerSec *int64 @@ -81,10 +85,6 @@ type DescribeBandwidthRateLimitOutput struct { // to return a list of gateways for your account and AWS Region. GatewayARN *string - // The average download bandwidth rate limit in bits per second. This field does - // not appear in the response if the download rate limit is not set. - AverageDownloadRateLimitInBitsPerSec *int64 - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/storagegateway/api_op_DescribeCache.go b/service/storagegateway/api_op_DescribeCache.go index 167cf95cd2f..bd563f4c6d1 100644 --- a/service/storagegateway/api_op_DescribeCache.go +++ b/service/storagegateway/api_op_DescribeCache.go @@ -68,36 +68,36 @@ type DescribeCacheInput struct { type DescribeCacheOutput struct { - // Percent use of the gateway's cache storage. This metric applies only to the - // gateway-cached volume setup. The sample is taken at the end of the reporting - // period. - CacheUsedPercentage *float64 + // The amount of cache in bytes allocated to a gateway. + CacheAllocatedInBytes *int64 + + // The file share's contribution to the overall percentage of the gateway's cache + // that has not been persisted to AWS. The sample is taken at the end of the + // reporting period. + CacheDirtyPercentage *float64 // Percent of application read operations from the file shares that are served from // cache. The sample is taken at the end of the reporting period. CacheHitPercentage *float64 + // Percent of application read operations from the file shares that are not served + // from cache. The sample is taken at the end of the reporting period. + CacheMissPercentage *float64 + + // Percent use of the gateway's cache storage. This metric applies only to the + // gateway-cached volume setup. The sample is taken at the end of the reporting + // period. + CacheUsedPercentage *float64 + // An array of strings that identify disks that are to be configured as working // storage. Each string has a minimum length of 1 and maximum length of 300. You // can get the disk IDs from the ListLocalDisks () API. DiskIds []*string - // Percent of application read operations from the file shares that are not served - // from cache. The sample is taken at the end of the reporting period. - CacheMissPercentage *float64 - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation // to return a list of gateways for your account and AWS Region. GatewayARN *string - // The file share's contribution to the overall percentage of the gateway's cache - // that has not been persisted to AWS. The sample is taken at the end of the - // reporting period. - CacheDirtyPercentage *float64 - - // The amount of cache in bytes allocated to a gateway. - CacheAllocatedInBytes *int64 - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/storagegateway/api_op_DescribeGatewayInformation.go b/service/storagegateway/api_op_DescribeGatewayInformation.go index 3f3a434dba5..3215c2d3527 100644 --- a/service/storagegateway/api_op_DescribeGatewayInformation.go +++ b/service/storagegateway/api_op_DescribeGatewayInformation.go @@ -71,66 +71,66 @@ type DescribeGatewayInformationInput struct { // A JSON object containing the following fields: type DescribeGatewayInformationOutput struct { - // The name you configured for your gateway. - GatewayName *string - - // A NetworkInterface () array that contains descriptions of the gateway network - // interfaces. - GatewayNetworkInterfaces []*types.NetworkInterface + // The Amazon Resource Name (ARN) of the Amazon CloudWatch Log Group that is used + // to monitor events in the gateway. + CloudWatchLogGroupARN *string - // The date on which an update to the gateway is available. This date is in the - // time zone of the gateway. If the gateway is not available for an update this - // field is not returned in the response. - NextUpdateAvailabilityDate *string + // The ID of the Amazon EC2 instance that was used to launch the gateway. + Ec2InstanceId *string // The AWS Region where the Amazon EC2 instance is located. Ec2InstanceRegion *string - // The date on which the last software update was applied to the gateway. If the - // gateway has never been updated, this field does not return a value in the - // response. - LastSoftwareUpdate *string + // The type of endpoint for your gateway.

    Valid Values: STANDARD | + // FIPS

    + EndpointType *string - // The Amazon Resource Name (ARN) of the Amazon CloudWatch Log Group that is used - // to monitor events in the gateway. - CloudWatchLogGroupARN *string + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation + // to return a list of gateways for your account and AWS Region. + GatewayARN *string // The unique identifier assigned to your gateway during activation. This ID // becomes part of the gateway Amazon Resource Name (ARN), which you use as input // for other operations. GatewayId *string + // The name you configured for your gateway. + GatewayName *string + + // A NetworkInterface () array that contains descriptions of the gateway network + // interfaces. + GatewayNetworkInterfaces []*types.NetworkInterface + + // A value that indicates the operating state of the gateway. + GatewayState *string + + // A value that indicates the time zone configured for the gateway. + GatewayTimezone *string + // The type of the gateway. GatewayType *string // The type of hypervisor environment used by the host. HostEnvironment types.HostEnvironment - // The configuration settings for the virtual private cloud (VPC) endpoint for your - // gateway. - VPCEndpoint *string + // The date on which the last software update was applied to the gateway. If the + // gateway has never been updated, this field does not return a value in the + // response. + LastSoftwareUpdate *string + + // The date on which an update to the gateway is available. This date is in the + // time zone of the gateway. If the gateway is not available for an update this + // field is not returned in the response. + NextUpdateAvailabilityDate *string // A list of up to 50 tags assigned to the gateway, sorted alphabetically by key // name. Each tag is a key-value pair. For a gateway with more than 10 tags // assigned, you can view all tags using the ListTagsForResource API operation. Tags []*types.Tag - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation - // to return a list of gateways for your account and AWS Region. - GatewayARN *string - - // A value that indicates the time zone configured for the gateway. - GatewayTimezone *string - - // A value that indicates the operating state of the gateway. - GatewayState *string - - // The type of endpoint for your gateway.

    Valid Values: STANDARD | - // FIPS

    - EndpointType *string - - // The ID of the Amazon EC2 instance that was used to launch the gateway. - Ec2InstanceId *string + // The configuration settings for the virtual private cloud (VPC) endpoint for your + // gateway. + VPCEndpoint *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/storagegateway/api_op_DescribeMaintenanceStartTime.go b/service/storagegateway/api_op_DescribeMaintenanceStartTime.go index 53745f888b2..22fe110cac1 100644 --- a/service/storagegateway/api_op_DescribeMaintenanceStartTime.go +++ b/service/storagegateway/api_op_DescribeMaintenanceStartTime.go @@ -73,15 +73,16 @@ type DescribeMaintenanceStartTimeInput struct { // DescribeMaintenanceStartTimeOutput$Timezone

    type DescribeMaintenanceStartTimeOutput struct { + // The day of the month component of the maintenance start time represented as an + // ordinal number from 1 to 28, where 1 represents the first day of the month and + // 28 represents the last day of the month. + DayOfMonth *int32 + // An ordinal number between 0 and 6 that represents the day of the week, where 0 // represents Sunday and 6 represents Saturday. The day of week is in the time zone // of the gateway. DayOfWeek *int32 - // A value that indicates the time zone that is set for the gateway. The start time - // and day of week specified should be in the time zone of the gateway. - Timezone *string - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation // to return a list of gateways for your account and AWS Region. GatewayARN *string @@ -90,16 +91,15 @@ type DescribeMaintenanceStartTimeOutput struct { // the hour (0 to 23). The hour of the day is in the time zone of the gateway. HourOfDay *int32 - // The day of the month component of the maintenance start time represented as an - // ordinal number from 1 to 28, where 1 represents the first day of the month and - // 28 represents the last day of the month. - DayOfMonth *int32 - // The minute component of the maintenance start time represented as mm, where mm // is the minute (0 to 59). The minute of the hour is in the time zone of the // gateway. MinuteOfHour *int32 + // A value that indicates the time zone that is set for the gateway. The start time + // and day of week specified should be in the time zone of the gateway. + Timezone *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/storagegateway/api_op_DescribeSMBSettings.go b/service/storagegateway/api_op_DescribeSMBSettings.go index 108ed6b8d82..2b91562b06b 100644 --- a/service/storagegateway/api_op_DescribeSMBSettings.go +++ b/service/storagegateway/api_op_DescribeSMBSettings.go @@ -82,14 +82,17 @@ type DescribeSMBSettingsOutput struct { // operation failed due to another type of error.

    ActiveDirectoryStatus types.ActiveDirectoryStatus - // This value is true if a password for the guest user smbguest is set, otherwise - // false.

    Valid Values: true | false

    - SMBGuestPasswordSet *bool + // The name of the domain that the gateway is joined to. + DomainName *string // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation // to return a list of gateways for your account and AWS Region. GatewayARN *string + // This value is true if a password for the guest user smbguest is set, otherwise + // false.

    Valid Values: true | false

    + SMBGuestPasswordSet *bool + // The type of security strategy that was specified for file gateway.
    • //

      ClientSpecified: If you use this option, requests are // established based on what is negotiated by the client. This option is @@ -105,9 +108,6 @@ type DescribeSMBSettingsOutput struct { //

    SMBSecurityStrategy types.SMBSecurityStrategy - // The name of the domain that the gateway is joined to. - DomainName *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/storagegateway/api_op_DescribeSnapshotSchedule.go b/service/storagegateway/api_op_DescribeSnapshotSchedule.go index a137db4407c..e9c55b72ebf 100644 --- a/service/storagegateway/api_op_DescribeSnapshotSchedule.go +++ b/service/storagegateway/api_op_DescribeSnapshotSchedule.go @@ -71,27 +71,27 @@ type DescribeSnapshotScheduleInput struct { type DescribeSnapshotScheduleOutput struct { - // A value that indicates the time zone of the gateway. - Timezone *string - - // A list of up to 50 tags assigned to the snapshot schedule, sorted alphabetically - // by key name. Each tag is a key-value pair. For a gateway with more than 10 tags - // assigned, you can view all tags using the ListTagsForResource API operation. - Tags []*types.Tag - // The snapshot description. Description *string - // The Amazon Resource Name (ARN) of the volume that was specified in the request. - VolumeARN *string + // The number of hours between snapshots. + RecurrenceInHours *int32 // The hour of the day at which the snapshot schedule begins represented as hh, // where hh is the hour (0 to 23). The hour of the day is in the time zone of the // gateway. StartAt *int32 - // The number of hours between snapshots. - RecurrenceInHours *int32 + // A list of up to 50 tags assigned to the snapshot schedule, sorted alphabetically + // by key name. Each tag is a key-value pair. For a gateway with more than 10 tags + // assigned, you can view all tags using the ListTagsForResource API operation. + Tags []*types.Tag + + // A value that indicates the time zone of the gateway. + Timezone *string + + // The Amazon Resource Name (ARN) of the volume that was specified in the request. + VolumeARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/storagegateway/api_op_DescribeTapeRecoveryPoints.go b/service/storagegateway/api_op_DescribeTapeRecoveryPoints.go index c2a2b178481..98d094043d2 100644 --- a/service/storagegateway/api_op_DescribeTapeRecoveryPoints.go +++ b/service/storagegateway/api_op_DescribeTapeRecoveryPoints.go @@ -62,6 +62,12 @@ func (c *Client) DescribeTapeRecoveryPoints(ctx context.Context, params *Describ // DescribeTapeRecoveryPointsInput type DescribeTapeRecoveryPointsInput struct { + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation + // to return a list of gateways for your account and AWS Region. + // + // This member is required. + GatewayARN *string + // Specifies that the number of virtual tape recovery points that are described be // limited to the specified number. Limit *int32 @@ -69,17 +75,15 @@ type DescribeTapeRecoveryPointsInput struct { // An opaque string that indicates the position at which to begin describing the // virtual tape recovery points. Marker *string - - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation - // to return a list of gateways for your account and AWS Region. - // - // This member is required. - GatewayARN *string } // DescribeTapeRecoveryPointsOutput type DescribeTapeRecoveryPointsOutput struct { + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation + // to return a list of gateways for your account and AWS Region. + GatewayARN *string + // An opaque string that indicates the position at which the virtual tape recovery // points that were listed for description ended.

    Use this marker in your next // request to list the next set of virtual tape recovery points in the list. If @@ -90,10 +94,6 @@ type DescribeTapeRecoveryPointsOutput struct { // An array of TapeRecoveryPointInfos that are available for the specified gateway. TapeRecoveryPointInfos []*types.TapeRecoveryPointInfo - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation - // to return a list of gateways for your account and AWS Region. - GatewayARN *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/storagegateway/api_op_DescribeTapes.go b/service/storagegateway/api_op_DescribeTapes.go index 2604eaa8b57..05861493c68 100644 --- a/service/storagegateway/api_op_DescribeTapes.go +++ b/service/storagegateway/api_op_DescribeTapes.go @@ -61,21 +61,21 @@ func (c *Client) DescribeTapes(ctx context.Context, params *DescribeTapesInput, // DescribeTapesInput type DescribeTapesInput struct { - // A marker value, obtained in a previous call to DescribeTapes. This marker - // indicates which page of results to retrieve.

    If not specified, the first - // page of results is retrieved.

    - Marker *string + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation + // to return a list of gateways for your account and AWS Region. + // + // This member is required. + GatewayARN *string // Specifies that the number of virtual tapes described be limited to the specified // number.

    Amazon Web Services may impose its own limit, if this field // is not set.

     Limit *int32 - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation - // to return a list of gateways for your account and AWS Region. - // - // This member is required. - GatewayARN *string + // A marker value, obtained in a previous call to DescribeTapes. This marker + // indicates which page of results to retrieve.

    If not specified, the first + // page of results is retrieved.

    + Marker *string // Specifies one or more unique Amazon Resource Names (ARNs) that represent the // virtual tapes you want to describe. If this parameter is not specified, Tape @@ -87,14 +87,14 @@ type DescribeTapesInput struct { // DescribeTapesOutput type DescribeTapesOutput struct { - // An array of virtual tape descriptions. - Tapes []*types.Tape - // An opaque string which can be used as part of a subsequent DescribeTapes call to // retrieve the next page of results.

    If a response does not contain a marker, // then there are no more results to be retrieved.

    Marker *string + // An array of virtual tape descriptions. + Tapes []*types.Tape + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/storagegateway/api_op_DescribeUploadBuffer.go b/service/storagegateway/api_op_DescribeUploadBuffer.go index f82992e47a1..923ccfe4e3f 100644 --- a/service/storagegateway/api_op_DescribeUploadBuffer.go +++ b/service/storagegateway/api_op_DescribeUploadBuffer.go @@ -74,9 +74,6 @@ type DescribeUploadBufferOutput struct { // DiskIds array is empty. DiskIds []*string - // The total number of bytes being used in the gateway's upload buffer. - UploadBufferUsedInBytes *int64 - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation // to return a list of gateways for your account and AWS Region. GatewayARN *string @@ -84,6 +81,9 @@ type DescribeUploadBufferOutput struct { // The total number of bytes allocated in the gateway's as upload buffer. UploadBufferAllocatedInBytes *int64 + // The total number of bytes being used in the gateway's upload buffer. + UploadBufferUsedInBytes *int64 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/storagegateway/api_op_DescribeVTLDevices.go b/service/storagegateway/api_op_DescribeVTLDevices.go index 8d03fa1f02e..1d6c4918b14 100644 --- a/service/storagegateway/api_op_DescribeVTLDevices.go +++ b/service/storagegateway/api_op_DescribeVTLDevices.go @@ -60,33 +60,33 @@ func (c *Client) DescribeVTLDevices(ctx context.Context, params *DescribeVTLDevi // DescribeVTLDevicesInput type DescribeVTLDevicesInput struct { - // An opaque string that indicates the position at which to begin describing the - // VTL devices. - Marker *string + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation + // to return a list of gateways for your account and AWS Region. + // + // This member is required. + GatewayARN *string // Specifies that the number of VTL devices described be limited to the specified // number. Limit *int32 + // An opaque string that indicates the position at which to begin describing the + // VTL devices. + Marker *string + // An array of strings, where each string represents the Amazon Resource Name (ARN) // of a VTL device.

    All of the specified VTL devices must be from the // same gateway. If no VTL devices are specified, the result will contain all // devices on the specified gateway.

     VTLDeviceARNs []*string - - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation - // to return a list of gateways for your account and AWS Region. - // - // This member is required. - GatewayARN *string } // DescribeVTLDevicesOutput type DescribeVTLDevicesOutput struct { - // An array of VTL device objects composed of the Amazon Resource Name (ARN) of the - // VTL devices. - VTLDevices []*types.VTLDevice + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation + // to return a list of gateways for your account and AWS Region. + GatewayARN *string // An opaque string that indicates the position at which the VTL devices that were // fetched for description ended. Use the marker in your next request to fetch the @@ -94,9 +94,9 @@ type DescribeVTLDevicesOutput struct { // describe, this field does not appear in the response. Marker *string - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation - // to return a list of gateways for your account and AWS Region. - GatewayARN *string + // An array of VTL device objects composed of the Amazon Resource Name (ARN) of the + // VTL devices. + VTLDevices []*types.VTLDevice // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/storagegateway/api_op_DescribeWorkingStorage.go b/service/storagegateway/api_op_DescribeWorkingStorage.go index f83795177c9..8691e6f1b44 100644 --- a/service/storagegateway/api_op_DescribeWorkingStorage.go +++ b/service/storagegateway/api_op_DescribeWorkingStorage.go @@ -74,10 +74,6 @@ type DescribeWorkingStorageInput struct { // A JSON object containing the following fields: type DescribeWorkingStorageOutput struct { - // The total working storage in bytes allocated for the gateway. If no working - // storage is configured for the gateway, this field returns 0. - WorkingStorageAllocatedInBytes *int64 - // An array of the gateway's local disk IDs that are configured as working storage. // Each local disk ID is specified as a string (minimum length of 1 and maximum // length of 300). If no local disks are configured as working storage, then the @@ -88,6 +84,10 @@ type DescribeWorkingStorageOutput struct { // to return a list of gateways for your account and AWS Region. GatewayARN *string + // The total working storage in bytes allocated for the gateway. If no working + // storage is configured for the gateway, this field returns 0. + WorkingStorageAllocatedInBytes *int64 + // The total working storage in bytes in use by the gateway. If no working storage // is configured for the gateway, this field returns 0. WorkingStorageUsedInBytes *int64 diff --git a/service/storagegateway/api_op_JoinDomain.go b/service/storagegateway/api_op_JoinDomain.go index b7b53abb2c1..862bf504fe0 100644 --- a/service/storagegateway/api_op_JoinDomain.go +++ b/service/storagegateway/api_op_JoinDomain.go @@ -59,6 +59,23 @@ func (c *Client) JoinDomain(ctx context.Context, params *JoinDomainInput, optFns // JoinDomainInput type JoinDomainInput struct { + // The name of the domain that you want the gateway to join. + // + // This member is required. + DomainName *string + + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to + // return a list of gateways for your account and AWS Region. + // + // This member is required. + GatewayARN *string + + // Sets the password of the user who has permission to add the gateway to the + // Active Directory domain. + // + // This member is required. + Password *string + // Sets the user name of user who has permission to add the gateway to the Active // Directory domain. The domain user account should be enabled to join computers to // the domain. For example, you can use the domain administrator account or an @@ -67,22 +84,11 @@ type JoinDomainInput struct { // This member is required. UserName *string - // The name of the domain that you want the gateway to join. - // - // This member is required. - DomainName *string - // List of IPv4 addresses, NetBIOS names, or host names of your domain server. If // you need to specify the port number include it after the colon (“:”). For // example, mydc.mydomain.com:389. DomainControllers []*string - // Sets the password of the user who has permission to add the gateway to the - // Active Directory domain. - // - // This member is required. - Password *string - // The organizational unit (OU) is a container in an Active Directory that can hold // users, groups, computers, and other OUs and this parameter specifies the OU that // the gateway will join within the AD domain. @@ -91,20 +97,11 @@ type JoinDomainInput struct { // Specifies the time in seconds, in which the JoinDomain operation must complete. // The default is 20 seconds. TimeoutInSeconds *int32 - - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and AWS Region. - // - // This member is required. - GatewayARN *string } // JoinDomainOutput type JoinDomainOutput struct { - // The unique Amazon Resource Name (ARN) of the gateway that joined the domain. - GatewayARN *string - // Indicates the status of the gateway as a member of the Active Directory domain. //

    • ACCESS_DENIED: Indicates that the // JoinDomain operation failed due to an authentication error.

      @@ -120,6 +117,9 @@ type JoinDomainOutput struct { // operation failed due to another type of error.

    ActiveDirectoryStatus types.ActiveDirectoryStatus + // The unique Amazon Resource Name (ARN) of the gateway that joined the domain. + GatewayARN *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/storagegateway/api_op_ListFileShares.go b/service/storagegateway/api_op_ListFileShares.go index f00d9de4094..3e39d57667c 100644 --- a/service/storagegateway/api_op_ListFileShares.go +++ b/service/storagegateway/api_op_ListFileShares.go @@ -77,12 +77,12 @@ type ListFileSharesInput struct { // ListFileShareOutput type ListFileSharesOutput struct { - // If the request includes Marker, the response returns that value in this field. - Marker *string - // An array of information about the file gateway's file shares. FileShareInfoList []*types.FileShareInfo + // If the request includes Marker, the response returns that value in this field. + Marker *string + // If a value is present, there are more file shares to return. In a subsequent // request, use NextMarker as the value for Marker to retrieve the next set of file // shares. diff --git a/service/storagegateway/api_op_ListGateways.go b/service/storagegateway/api_op_ListGateways.go index 9e01596d54a..d45145378ad 100644 --- a/service/storagegateway/api_op_ListGateways.go +++ b/service/storagegateway/api_op_ListGateways.go @@ -66,25 +66,25 @@ func (c *Client) ListGateways(ctx context.Context, params *ListGatewaysInput, op // ListGatewaysInput$Marker

    type ListGatewaysInput struct { - // An opaque string that indicates the position at which to begin the returned list - // of gateways. - Marker *string - // Specifies that the list of gateways returned be limited to the specified number // of items. Limit *int32 + + // An opaque string that indicates the position at which to begin the returned list + // of gateways. + Marker *string } type ListGatewaysOutput struct { + // An array of GatewayInfo () objects. + Gateways []*types.GatewayInfo + // Use the marker in your next request to fetch the next set of gateways in the // list. If there are no more gateways to list, this field does not appear in the // response. Marker *string - // An array of GatewayInfo () objects. - Gateways []*types.GatewayInfo - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/storagegateway/api_op_ListTagsForResource.go b/service/storagegateway/api_op_ListTagsForResource.go index 333d358a53d..23bc5ab38bf 100644 --- a/service/storagegateway/api_op_ListTagsForResource.go +++ b/service/storagegateway/api_op_ListTagsForResource.go @@ -59,33 +59,33 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes // ListTagsForResourceInput type ListTagsForResourceInput struct { - // An opaque string that indicates the position at which to begin returning the - // list of tags. - Marker *string + // The Amazon Resource Name (ARN) of the resource for which you want to list tags. + // + // This member is required. + ResourceARN *string // Specifies that the list of tags returned be limited to the specified number of // items. Limit *int32 - // The Amazon Resource Name (ARN) of the resource for which you want to list tags. - // - // This member is required. - ResourceARN *string + // An opaque string that indicates the position at which to begin returning the + // list of tags. + Marker *string } // ListTagsForResourceOutput type ListTagsForResourceOutput struct { + // An opaque string that indicates the position at which to stop returning the list + // of tags. + Marker *string + // he Amazon Resource Name (ARN) of the resource for which you want to list tags. ResourceARN *string // An array that contains the tags for the specified resource. Tags []*types.Tag - // An opaque string that indicates the position at which to stop returning the list - // of tags. - Marker *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/storagegateway/api_op_ListTapes.go b/service/storagegateway/api_op_ListTapes.go index 714d3d2d238..8637f16dce1 100644 --- a/service/storagegateway/api_op_ListTapes.go +++ b/service/storagegateway/api_op_ListTapes.go @@ -68,16 +68,16 @@ func (c *Client) ListTapes(ctx context.Context, params *ListTapesInput, optFns . //

  • ListTapesInput$TapeARNs

    • type ListTapesInput struct { - // The Amazon Resource Name (ARN) of each of the tapes you want to list. If you - // don't specify a tape ARN, the response lists all tapes in both your VTL and VTS. - TapeARNs []*string - // An optional number limit for the tapes in the list returned by this call. Limit *int32 // A string that indicates the position at which to begin the returned list of // tapes. Marker *string + + // The Amazon Resource Name (ARN) of each of the tapes you want to list. If you + // don't specify a tape ARN, the response lists all tapes in both your VTL and VTS. + TapeARNs []*string } // A JSON object containing the following fields: type ListTapesOutput struct { - // An array of TapeInfo () objects, where each object describes a single tape. If - // there are no tapes in the tape library or VTS, then the TapeInfos is an empty - // array. - TapeInfos []*types.TapeInfo - // A string that indicates the position at which to begin returning the next list // of tapes. Use the marker in your next request to continue pagination of tapes. // If there are no more tapes to list, this element does not appear in the response // body. Marker *string + // An array of TapeInfo () objects, where each object describes a single tape. If + // there are no tapes in the tape library or VTS, then the TapeInfos is an empty + // array. + TapeInfos []*types.TapeInfo + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/storagegateway/api_op_ListVolumes.go b/service/storagegateway/api_op_ListVolumes.go index ccda5359069..2137d66f663 100644 --- a/service/storagegateway/api_op_ListVolumes.go +++ b/service/storagegateway/api_op_ListVolumes.go @@ -91,16 +91,16 @@ type ListVolumesOutput struct { // to return a list of gateways for your account and AWS Region. GatewayARN *string - // An array of VolumeInfo () objects, where each object describes an iSCSI volume. - // If no volumes are defined for the gateway, then VolumeInfos is an empty array - // "[]". - VolumeInfos []*types.VolumeInfo - // Use the marker in your next request to continue pagination of iSCSI volumes. If // there are no more volumes to list, this field does not appear in the response // body. Marker *string + // An array of VolumeInfo () objects, where each object describes an iSCSI volume. + // If no volumes are defined for the gateway, then VolumeInfos is an empty array + // "[]". + VolumeInfos []*types.VolumeInfo + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/storagegateway/api_op_RefreshCache.go b/service/storagegateway/api_op_RefreshCache.go index 051f9f8502f..05f770d8928 100644 --- a/service/storagegateway/api_op_RefreshCache.go +++ b/service/storagegateway/api_op_RefreshCache.go @@ -106,13 +106,13 @@ type RefreshCacheInput struct { // RefreshCacheOutput type RefreshCacheOutput struct { + // The Amazon Resource Name (ARN) of the file share. + FileShareARN *string + // The randomly generated ID of the notification that was sent. This ID is in UUID // format. NotificationId *string - // The Amazon Resource Name (ARN) of the file share. - FileShareARN *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/storagegateway/api_op_SetLocalConsolePassword.go b/service/storagegateway/api_op_SetLocalConsolePassword.go index d4d153c5f92..58108a98e29 100644 --- a/service/storagegateway/api_op_SetLocalConsolePassword.go +++ b/service/storagegateway/api_op_SetLocalConsolePassword.go @@ -60,16 +60,16 @@ func (c *Client) SetLocalConsolePassword(ctx context.Context, params *SetLocalCo // SetLocalConsolePasswordInput type SetLocalConsolePasswordInput struct { - // The password you want to set for your VM local console. - // - // This member is required. - LocalConsolePassword *string - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation // to return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string + + // The password you want to set for your VM local console. + // + // This member is required. + LocalConsolePassword *string } type SetLocalConsolePasswordOutput struct { diff --git a/service/storagegateway/api_op_UpdateBandwidthRateLimit.go b/service/storagegateway/api_op_UpdateBandwidthRateLimit.go index 47744ffc3bc..3d0f5192def 100644 --- a/service/storagegateway/api_op_UpdateBandwidthRateLimit.go +++ b/service/storagegateway/api_op_UpdateBandwidthRateLimit.go @@ -69,9 +69,6 @@ func (c *Client) UpdateBandwidthRateLimit(ctx context.Context, params *UpdateBan // type UpdateBandwidthRateLimitInput struct { - // The average upload bandwidth rate limit in bits per second. - AverageUploadRateLimitInBitsPerSec *int64 - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation // to return a list of gateways for your account and AWS Region. // @@ -80,6 +77,9 @@ type UpdateBandwidthRateLimitInput struct { // The average download bandwidth rate limit in bits per second. AverageDownloadRateLimitInBitsPerSec *int64 + + // The average upload bandwidth rate limit in bits per second. + AverageUploadRateLimitInBitsPerSec *int64 } // A JSON object containing the Amazon Resource Name (ARN) of the gateway whose diff --git a/service/storagegateway/api_op_UpdateChapCredentials.go b/service/storagegateway/api_op_UpdateChapCredentials.go index 9cc92e70c1e..d5881656b51 100644 --- a/service/storagegateway/api_op_UpdateChapCredentials.go +++ b/service/storagegateway/api_op_UpdateChapCredentials.go @@ -66,6 +66,11 @@ func (c *Client) UpdateChapCredentials(ctx context.Context, params *UpdateChapCr //

    UpdateChapCredentialsInput$TargetARN

    type UpdateChapCredentialsInput struct { + // The iSCSI initiator that connects to the target. + // + // This member is required. + InitiatorName *string + // The secret key that the initiator (for example, the Windows client) must provide // to participate in mutual CHAP with the target.

    The secret key must be // between 12 and 16 bytes when encoded in UTF-8.

     @@ -73,36 +78,31 @@ type UpdateChapCredentialsInput struct { // This member is required. SecretToAuthenticateInitiator *string - // The secret key that the target must provide to participate in mutual CHAP with - // the initiator (e.g. Windows client).

    Byte constraints: Minimum bytes of 12. - // Maximum bytes of 16.

    The secret key must be between 12 and 16 - // bytes when encoded in UTF-8.

     - SecretToAuthenticateTarget *string - - // The iSCSI initiator that connects to the target. - // - // This member is required. - InitiatorName *string - // The Amazon Resource Name (ARN) of the iSCSI volume target. Use the // DescribeStorediSCSIVolumes () operation to return the TargetARN for specified // VolumeARN. // // This member is required. TargetARN *string + + // The secret key that the target must provide to participate in mutual CHAP with + // the initiator (e.g. Windows client).

    Byte constraints: Minimum bytes of 12. + // Maximum bytes of 16.

    The secret key must be between 12 and 16 + // bytes when encoded in UTF-8.

     + SecretToAuthenticateTarget *string } // A JSON object containing the following fields: type UpdateChapCredentialsOutput struct { - // The Amazon Resource Name (ARN) of the target. This is the same target specified - // in the request. - TargetARN *string - // The iSCSI initiator that connects to the target. This is the same initiator name // specified in the request. InitiatorName *string + // The Amazon Resource Name (ARN) of the target. This is the same target specified + // in the request. + TargetARN *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/storagegateway/api_op_UpdateGatewayInformation.go b/service/storagegateway/api_op_UpdateGatewayInformation.go index 087ba792d1c..529faeba447 100644 --- a/service/storagegateway/api_op_UpdateGatewayInformation.go +++ b/service/storagegateway/api_op_UpdateGatewayInformation.go @@ -61,8 +61,11 @@ func (c *Client) UpdateGatewayInformation(ctx context.Context, params *UpdateGat type UpdateGatewayInformationInput struct { - // The name you configured for your gateway. - GatewayName *string + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation + // to return a list of gateways for your account and AWS Region. + // + // This member is required. + GatewayARN *string // The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want // to use to monitor and log events in the gateway.

    For more information, see @@ -71,11 +74,8 @@ type UpdateGatewayInformationInput struct { // is Amazon CloudWatch logs?.

    CloudWatchLogGroupARN *string - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation - // to return a list of gateways for your account and AWS Region. - // - // This member is required. - GatewayARN *string + // The name you configured for your gateway. + GatewayName *string // A value that indicates the time zone of the gateway. GatewayTimezone *string @@ -85,13 +85,13 @@ type UpdateGatewayInformationInput struct { // updated. type UpdateGatewayInformationOutput struct { - // The name you configured for your gateway. - GatewayName *string - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation // to return a list of gateways for your account and AWS Region. GatewayARN *string + // The name you configured for your gateway. + GatewayName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/storagegateway/api_op_UpdateMaintenanceStartTime.go b/service/storagegateway/api_op_UpdateMaintenanceStartTime.go index b1a8fa23261..ccfcbae51e7 100644 --- a/service/storagegateway/api_op_UpdateMaintenanceStartTime.go +++ b/service/storagegateway/api_op_UpdateMaintenanceStartTime.go @@ -62,13 +62,6 @@ func (c *Client) UpdateMaintenanceStartTime(ctx context.Context, params *UpdateM // UpdateMaintenanceStartTimeInput$MinuteOfHour

    type UpdateMaintenanceStartTimeInput struct { - // The minute component of the maintenance start time represented as mm, where mm - // is the minute (00 to 59). The minute of the hour is in the time zone of the - // gateway. - // - // This member is required. - MinuteOfHour *int32 - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation // to return a list of gateways for your account and AWS Region. // @@ -81,14 +74,21 @@ type UpdateMaintenanceStartTimeInput struct { // This member is required. HourOfDay *int32 - // The day of the week component of the maintenance start time week represented as - // an ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday. - DayOfWeek *int32 + // The minute component of the maintenance start time represented as mm, where mm + // is the minute (00 to 59). The minute of the hour is in the time zone of the + // gateway. + // + // This member is required. + MinuteOfHour *int32 // The day of the month component of the maintenance start time represented as an // ordinal number from 1 to 28, where 1 represents the first day of the month and // 28 represents the last day of the month. DayOfMonth *int32 + + // The day of the week component of the maintenance start time week represented as + // an ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday. + DayOfWeek *int32 } // A JSON object containing the Amazon Resource Name (ARN) of the gateway whose diff --git a/service/storagegateway/api_op_UpdateNFSFileShare.go b/service/storagegateway/api_op_UpdateNFSFileShare.go index f1457fd2c55..fa70434ac8e 100644 --- a/service/storagegateway/api_op_UpdateNFSFileShare.go +++ b/service/storagegateway/api_op_UpdateNFSFileShare.go @@ -66,9 +66,23 @@ func (c *Client) UpdateNFSFileShare(ctx context.Context, params *UpdateNFSFileSh // UpdateNFSFileShareInput type UpdateNFSFileShareInput struct { - // A value that sets the access control list (ACL) permission for objects in the S3 - // bucket that a file gateway puts objects into. The default value is private. - ObjectACL types.ObjectACL + // The Amazon Resource Name (ARN) of the file share to be updated. + // + // This member is required. + FileShareARN *string + + // Refresh cache information. + CacheAttributes *types.CacheAttributes + + // The list of clients that are allowed to access the file gateway. The list must + // contain either valid IP addresses or valid CIDR blocks. + ClientList []*string + + // The default storage class for objects put into an Amazon S3 bucket by the file + // gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

    Valid + // Values: S3_STANDARD | S3_INTELLIGENT_TIERING | + // S3_STANDARD_IA | S3_ONEZONE_IA

    + DefaultStorageClass *string // The name of the file share. Optional.

    FileShareName // must be set if an S3 prefix name is set in LocationARN.

     @@ -80,13 +94,23 @@ type UpdateNFSFileShareInput struct { // false

    GuessMIMETypeEnabled *bool - // The list of clients that are allowed to access the file gateway. The list must - // contain either valid IP addresses or valid CIDR blocks. - ClientList []*string + // Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, + // or false to use a key managed by Amazon S3. Optional.

    Valid Values: + // true | false

    + KMSEncrypted *bool + + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for + // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric + // CMKs. This value can only be set when KMSEncrypted is true. Optional. + KMSKey *string // The default values for the file share. Optional. NFSFileShareDefaults *types.NFSFileShareDefaults + // A value that sets the access control list (ACL) permission for objects in the S3 + // bucket that a file gateway puts objects into. The default value is private. + ObjectACL types.ObjectACL + // A value that sets the write status of a file share. Set this value to true to // set the write status to read-only, otherwise set to false.

    Valid Values: // true | false

    @@ -102,36 +126,12 @@ type UpdateNFSFileShareInput struct { // false

    RequesterPays *bool - // Refresh cache information. - CacheAttributes *types.CacheAttributes - - // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for - // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric - // CMKs. This value can only be set when KMSEncrypted is true. Optional. - KMSKey *string - - // The Amazon Resource Name (ARN) of the file share to be updated. - // - // This member is required. - FileShareARN *string - - // Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, - // or false to use a key managed by Amazon S3. Optional.

    Valid Values: - // true | false

    - KMSEncrypted *bool - // The user mapped to anonymous user.

    Valid values are the following:

      //

    • RootSquash: Only root is mapped to anonymous user.

      //

    • NoSquash: No one is mapped to anonymous user.

      //

    • AllSquash: Everyone is mapped to anonymous user.

      //
    Squash *string - - // The default storage class for objects put into an Amazon S3 bucket by the file - // gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

    Valid - // Values: S3_STANDARD | S3_INTELLIGENT_TIERING | - // S3_STANDARD_IA | S3_ONEZONE_IA

    - DefaultStorageClass *string } // UpdateNFSFileShareOutput diff --git a/service/storagegateway/api_op_UpdateSMBFileShare.go b/service/storagegateway/api_op_UpdateSMBFileShare.go index 2b66761e53b..1a3e2e1e0e6 100644 --- a/service/storagegateway/api_op_UpdateSMBFileShare.go +++ b/service/storagegateway/api_op_UpdateSMBFileShare.go @@ -68,22 +68,43 @@ func (c *Client) UpdateSMBFileShare(ctx context.Context, params *UpdateSMBFileSh // UpdateSMBFileShareInput type UpdateSMBFileShareInput struct { + // The Amazon Resource Name (ARN) of the SMB file share that you want to update. + // + // This member is required. + FileShareARN *string + + // A list of users or groups in the Active Directory that have administrator rights + // to the file share. A group must be prefixed with the @ character. Acceptable + // formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be + // set if Authentication is set to ActiveDirectory. + AdminUserList []*string + + // The Amazon Resource Name (ARN) of the storage used for the audit logs. + AuditDestinationARN *string + + // Refresh cache information. + CacheAttributes *types.CacheAttributes + + // The case of an object name in an Amazon S3 bucket. For ClientSpecified, the + // client determines the case sensitivity. For CaseSensitive, the gateway + // determines the case sensitivity. The default value is ClientSpecified. + CaseSensitivity types.CaseSensitivity + // The default storage class for objects put into an Amazon S3 bucket by the file // gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

    Valid // Values: S3_STANDARD | S3_INTELLIGENT_TIERING | // S3_STANDARD_IA | S3_ONEZONE_IA

    DefaultStorageClass *string - // A list of users or groups in the Active Directory that are allowed to access the - // file share. A group must be prefixed with the @ character. Acceptable formats - // include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if - // Authentication is set to ActiveDirectory. - ValidUserList []*string + // The name of the file share. Optional.

    FileShareName + // must be set if an S3 prefix name is set in LocationARN.

     + FileShareName *string - // Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, - // or false to use a key managed by Amazon S3. Optional.

    Valid Values: - // true | false

    - KMSEncrypted *bool + // A value that enables guessing of the MIME type for uploaded objects based on + // file extensions. Set this value to true to enable MIME type guessing, otherwise + // set to false. The default value is true.

    Valid Values: true | + // false

    + GuessMIMETypeEnabled *bool // A list of users or groups in the Active Directory that are not allowed to access // the file share. A group must be prefixed with the @ character. Acceptable @@ -91,32 +112,25 @@ type UpdateSMBFileShareInput struct { // set if Authentication is set to ActiveDirectory. InvalidUserList []*string + // Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, + // or false to use a key managed by Amazon S3. Optional.

    Valid Values: + // true | false

    + KMSEncrypted *bool + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric // CMKs. This value can only be set when KMSEncrypted is true. Optional. KMSKey *string + // A value that sets the access control list (ACL) permission for objects in the S3 + // bucket that a file gateway puts objects into. The default value is private. + ObjectACL types.ObjectACL + // A value that sets the write status of a file share. Set this value to true to // set write status to read-only, otherwise set to false.

    Valid Values: // true | false

    ReadOnly *bool - // Refresh cache information. - CacheAttributes *types.CacheAttributes - - // The Amazon Resource Name (ARN) of the storage used for the audit logs. - AuditDestinationARN *string - - // The case of an object name in an Amazon S3 bucket. For ClientSpecified, the - // client determines the case sensitivity. For CaseSensitive, the gateway - // determines the case sensitivity. The default value is ClientSpecified. - CaseSensitivity types.CaseSensitivity - - // The Amazon Resource Name (ARN) of the SMB file share that you want to update. - // - // This member is required. - FileShareARN *string - // A value that sets who pays the cost of the request and the cost associated with // data download from the S3 bucket. If this value is set to true, the requester // pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket @@ -127,12 +141,6 @@ type UpdateSMBFileShareInput struct { // false

    RequesterPays *bool - // A list of users or groups in the Active Directory that have administrator rights - // to the file share. A group must be prefixed with the @ character. Acceptable - // formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be - // set if Authentication is set to ActiveDirectory. - AdminUserList []*string - // Set this value to true to enable access control list (ACL) on the SMB file // share. Set it to false to map file and directory permissions to the POSIX // permissions.

    For more information, see false

    SMBACLEnabled *bool - // A value that enables guessing of the MIME type for uploaded objects based on - // file extensions. Set this value to true to enable MIME type guessing, otherwise - // set to false. The default value is true.

    Valid Values: true | - // false

    - GuessMIMETypeEnabled *bool - - // A value that sets the access control list (ACL) permission for objects in the S3 - // bucket that a file gateway puts objects into. The default value is private. - ObjectACL types.ObjectACL - - // The name of the file share. Optional.

    FileShareName - // must be set if an S3 prefix name is set in LocationARN.

     - FileShareName *string + // A list of users or groups in the Active Directory that are allowed to access the + // file share. A group must be prefixed with the @ character. Acceptable formats + // include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if + // Authentication is set to ActiveDirectory. + ValidUserList []*string } // UpdateSMBFileShareOutput diff --git a/service/storagegateway/api_op_UpdateSMBSecurityStrategy.go b/service/storagegateway/api_op_UpdateSMBSecurityStrategy.go index 6da0932c8ac..212f821b942 100644 --- a/service/storagegateway/api_op_UpdateSMBSecurityStrategy.go +++ b/service/storagegateway/api_op_UpdateSMBSecurityStrategy.go @@ -60,6 +60,12 @@ func (c *Client) UpdateSMBSecurityStrategy(ctx context.Context, params *UpdateSM type UpdateSMBSecurityStrategyInput struct { + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation + // to return a list of gateways for your account and AWS Region. + // + // This member is required. + GatewayARN *string + // Specifies the type of security strategy.

    ClientSpecified: if you use this // option, requests are established based on what is negotiated by the client. This // option is recommended when you want to maximize compatibility across different @@ -74,12 +80,6 @@ type UpdateSMBSecurityStrategyInput struct { // // This member is required. SMBSecurityStrategy types.SMBSecurityStrategy - - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation - // to return a list of gateways for your account and AWS Region. - // - // This member is required. - GatewayARN *string } type UpdateSMBSecurityStrategyOutput struct { diff --git a/service/storagegateway/api_op_UpdateSnapshotSchedule.go b/service/storagegateway/api_op_UpdateSnapshotSchedule.go index 5e2e9fdd711..e3da07f90a1 100644 --- a/service/storagegateway/api_op_UpdateSnapshotSchedule.go +++ b/service/storagegateway/api_op_UpdateSnapshotSchedule.go @@ -74,12 +74,6 @@ type UpdateSnapshotScheduleInput struct { // This member is required. RecurrenceInHours *int32 - // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes () operation - // to return a list of gateway volumes. - // - // This member is required. - VolumeARN *string - // The hour of the day at which the snapshot schedule begins represented as hh, // where hh is the hour (0 to 23). The hour of the day is in the time zone of the // gateway. @@ -87,15 +81,21 @@ type UpdateSnapshotScheduleInput struct { // This member is required. StartAt *int32 + // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes () operation + // to return a list of gateway volumes. + // + // This member is required. + VolumeARN *string + + // Optional description of the snapshot that overwrites the existing description. + Description *string + // A list of up to 50 tags that can be assigned to a snapshot. Each tag is a // key-value pair.

    Valid characters for key and value are letters, // spaces, and numbers representable in UTF-8 format, and the following special // characters: + - = . _ : / @. The maximum length of a tag's key is 128 // characters, and the maximum length for a tag's value is 256.

     Tags []*types.Tag - - // Optional description of the snapshot that overwrites the existing description. - Description *string } // A JSON object containing the Amazon Resource Name (ARN) of the updated storage diff --git a/service/storagegateway/api_op_UpdateVTLDeviceType.go b/service/storagegateway/api_op_UpdateVTLDeviceType.go index 01f1599a601..7ba6fde67c3 100644 --- a/service/storagegateway/api_op_UpdateVTLDeviceType.go +++ b/service/storagegateway/api_op_UpdateVTLDeviceType.go @@ -59,16 +59,16 @@ func (c *Client) UpdateVTLDeviceType(ctx context.Context, params *UpdateVTLDevic type UpdateVTLDeviceTypeInput struct { - // The Amazon Resource Name (ARN) of the medium changer you want to select. - // - // This member is required. - VTLDeviceARN *string - // The type of medium changer you want to select.

    Valid Values: // STK-L700 | AWS-Gateway-VTL

    // // This member is required. DeviceType *string + + // The Amazon Resource Name (ARN) of the medium changer you want to select. + // + // This member is required. + VTLDeviceARN *string } // UpdateVTLDeviceTypeOutput diff --git a/service/storagegateway/go.mod b/service/storagegateway/go.mod index c0de6e0ce26..d4f90874cfc 100644 --- a/service/storagegateway/go.mod +++ b/service/storagegateway/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/storagegateway go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/storagegateway/types/types.go b/service/storagegateway/types/types.go index 3f68df16233..26bcde0f4c1 100644 --- a/service/storagegateway/types/types.go +++ b/service/storagegateway/types/types.go @@ -24,6 +24,13 @@ type AutomaticTapeCreationPolicyInfo struct { // where each rule defines when and how to create new tapes. type AutomaticTapeCreationRule struct { + // The minimum number of available virtual tapes that the gateway maintains at all + // times. If the number of tapes on the gateway goes below this value, the gateway + // creates as many new tapes as are needed to have MinimumNumTapes on the gateway. + // + // This member is required. + MinimumNumTapes *int32 + // The ID of the pool that you want to add your tape to for archiving. The tape in // this pool is archived in the Amazon S3 storage class that is associated with the // pool. When you use your backup application to eject the tape, the tape is @@ -34,18 +41,6 @@ type AutomaticTapeCreationRule struct { // This member is required. PoolId *string - // The size, in bytes, of the virtual tape capacity. - // - // This member is required. - TapeSizeInBytes *int64 - - // The minimum number of available virtual tapes that the gateway maintains at all - // times. If the number of tapes on the gateway goes below this value, the gateway - // creates as many new tapes as are needed to have MinimumNumTapes on the gateway. - // - // This member is required. - MinimumNumTapes *int32 - // A prefix that you append to the barcode of the virtual tape that you are // creating. This prefix makes the barcode unique.

    The prefix must be // 1-4 characters in length and must be one of the uppercase letters from A to @@ -53,6 +48,11 @@ type AutomaticTapeCreationRule struct { // // This member is required. TapeBarcodePrefix *string + + // The size, in bytes, of the virtual tape capacity. + // + // This member is required. + TapeSizeInBytes *int64 } // Lists refresh cache information. @@ -69,35 +69,19 @@ type CacheAttributes struct { // Describes an iSCSI cached volume. type CachediSCSIVolume struct { + // The date the volume was created. Volumes created prior to March 28, 2017 don’t + // have this time stamp. + CreatedDate *time.Time + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric // CMKs. This value can only be set when KMSEncrypted is true. Optional. KMSKey *string - // The unique identifier of the volume, e.g. vol-AE4B946D. - VolumeId *string - - // The size, in bytes, of the volume capacity. - VolumeSizeInBytes *int64 - - // One of the VolumeType enumeration values that describes the type of the volume. - VolumeType *string - - // The Amazon Resource Name (ARN) of the storage volume. - VolumeARN *string - // If the cached volume was created from a snapshot, this field contains the // snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included. SourceSnapshotId *string - // A value that indicates whether a storage volume is attached to or detached from - // a gateway. For more information, see Moving your volumes to a different gateway - // (https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#attach-detach-volume). - VolumeAttachmentStatus *string - - // One of the VolumeStatus values that indicates the state of the storage volume. - VolumeStatus *string - // The name of the iSCSI target used by an initiator to connect to a volume and // used as a suffix for the target ARN. For example, specifying TargetName as // myvolume results in the target ARN of @@ -107,18 +91,30 @@ type CachediSCSIVolume struct { // this volume as the new target name.

    TargetName *string - // An VolumeiSCSIAttributes () object that represents a collection of iSCSI - // attributes for one stored volume. - VolumeiSCSIAttributes *VolumeiSCSIAttributes + // The Amazon Resource Name (ARN) of the storage volume. + VolumeARN *string + + // A value that indicates whether a storage volume is attached to or detached from + // a gateway. For more information, see Moving your volumes to a different gateway + // (https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#attach-detach-volume). + VolumeAttachmentStatus *string + + // The unique identifier of the volume, e.g. vol-AE4B946D. + VolumeId *string // Represents the percentage complete if the volume is restoring or bootstrapping // that represents the percent of data transferred. This field does not appear in // the response if the cached volume is not restoring or bootstrapping. VolumeProgress *float64 - // The date the volume was created. Volumes created prior to March 28, 2017 don’t - // have this time stamp. - CreatedDate *time.Time + // The size, in bytes, of the volume capacity. + VolumeSizeInBytes *int64 + + // One of the VolumeStatus values that indicates the state of the storage volume. + VolumeStatus *string + + // One of the VolumeType enumeration values that describes the type of the volume. + VolumeType *string // The size of the data stored on the volume in bytes. This value is calculated // based on the number of blocks that are touched, instead of the actual amount of @@ -128,26 +124,30 @@ type CachediSCSIVolume struct { // bill.

    This value is not available for volumes created prior to May // 13, 2015, until you store data on the volume.

     VolumeUsedInBytes *int64 + + // An VolumeiSCSIAttributes () object that represents a collection of iSCSI + // attributes for one stored volume. + VolumeiSCSIAttributes *VolumeiSCSIAttributes } // Describes Challenge-Handshake Authentication Protocol (CHAP) information that // supports authentication between your gateway and iSCSI initiators. type ChapInfo struct { - // The Amazon Resource Name (ARN) of the volume.

    Valid Values: 50 to 500 - // lowercase letters, numbers, periods (.), and hyphens (-).

    - TargetARN *string + // The iSCSI initiator that connects to the target. + InitiatorName *string // The secret key that the initiator (for example, the Windows client) must provide // to participate in mutual CHAP with the target. SecretToAuthenticateInitiator *string - // The iSCSI initiator that connects to the target. - InitiatorName *string - // The secret key that the target must provide to participate in mutual CHAP with // the initiator (e.g. Windows client). SecretToAuthenticateTarget *string + + // The Amazon Resource Name (ARN) of the volume.

    Valid Values: 50 to 500 + // lowercase letters, numbers, periods (.), and hyphens (-).

    + TargetARN *string } // Lists iSCSI information about a VTL device. @@ -156,90 +156,90 @@ type DeviceiSCSIAttributes struct { // Indicates whether mutual CHAP is enabled for the iSCSI target. ChapEnabled *bool - // Specifies the unique Amazon Resource Name (ARN) that encodes the iSCSI qualified - // name(iqn) of a tape drive or media changer target. - TargetARN *string - // The network interface identifier of the VTL device. NetworkInterfaceId *string // The port used to communicate with iSCSI VTL device targets. NetworkInterfacePort *int32 + + // Specifies the unique Amazon Resource Name (ARN) that encodes the iSCSI qualified + // name(iqn) of a tape drive or media changer target. + TargetARN *string } // Represents a gateway's local disk. type Disk struct { - // The device node of a local disk as assigned by the virtualization environment. - DiskNode *string - - // The path of a local disk in the gateway virtual machine (VM). - DiskPath *string - - // A list of values that represents attributes of a local disk. - DiskAttributeList []*string + // The iSCSI qualified name (IQN) that is defined for a disk. This field is not + // included in the response if the local disk is not defined as an iSCSI target. + // The format of this field is targetIqn::LUNNumber::region-volumeId. + DiskAllocationResource *string // One of the DiskAllocationType enumeration values that identifies how a local // disk is used.

    Valid Values: UPLOAD_BUFFER | // CACHE_STORAGE

    DiskAllocationType *string + // A list of values that represents attributes of a local disk. + DiskAttributeList []*string + // The unique device ID or other distinguishing data that identifies a local disk. DiskId *string - // A value that represents the status of a local disk. - DiskStatus *string + // The device node of a local disk as assigned by the virtualization environment. + DiskNode *string - // The iSCSI qualified name (IQN) that is defined for a disk. This field is not - // included in the response if the local disk is not defined as an iSCSI target. - // The format of this field is targetIqn::LUNNumber::region-volumeId. - DiskAllocationResource *string + // The path of a local disk in the gateway virtual machine (VM). + DiskPath *string // The local disk size in bytes. DiskSizeInBytes *int64 + + // A value that represents the status of a local disk. + DiskStatus *string } // Describes a file share. type FileShareInfo struct { - // The type of the file share. - FileShareType FileShareType - // The Amazon Resource Name (ARN) of the file share. FileShareARN *string + // The ID of the file share. + FileShareId *string + // The status of the file share.

    Valid Values: CREATING | // UPDATING | AVAILABLE | DELETING

    FileShareStatus *string + // The type of the file share. + FileShareType FileShareType + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation // to return a list of gateways for your account and AWS Region. GatewayARN *string - - // The ID of the file share. - FileShareId *string } // Describes a gateway object. type GatewayInfo struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation - // to return a list of gateways for your account and AWS Region. - GatewayARN *string - // The ID of the Amazon EC2 instance that was used to launch the gateway. Ec2InstanceId *string - // The name of the gateway. - GatewayName *string + // The AWS Region where the Amazon EC2 instance is located. + Ec2InstanceRegion *string + + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation + // to return a list of gateways for your account and AWS Region. + GatewayARN *string // The unique identifier assigned to your gateway during activation. This ID // becomes part of the gateway Amazon Resource Name (ARN), which you use as input // for other operations. GatewayId *string - // The AWS Region where the Amazon EC2 instance is located. - Ec2InstanceRegion *string + // The name of the gateway. + GatewayName *string // The state of the gateway.

    Valid Values: DISABLED | // ACTIVE

    @@ -252,13 +252,13 @@ type GatewayInfo struct { // Describes a gateway's network interface. type NetworkInterface struct { + // The Internet Protocol version 4 (IPv4) address of the interface. + Ipv4Address *string + // The Internet Protocol version 6 (IPv6) address of the interface. Currently not // supported. Ipv6Address *string - // The Internet Protocol version 4 (IPv4) address of the interface. - Ipv4Address *string - // The Media Access Control (MAC) address of the interface.

    This is // currently unsupported and will not be returned in output.

     MacAddress *string @@ -271,14 +271,6 @@ type NetworkInterface struct { // permissions. This operation is only supported for file gateways. type NFSFileShareDefaults struct { - // The default owner ID for files in the file share (unless the files have another - // owner ID specified). The default value is nfsnobody. - OwnerId *int64 - - // The default group ID for the file share (unless the files have another group ID - // specified). The default value is nfsnobody. - GroupId *int64 - // The Unix directory mode in the form "nnnn". For example, 0666 represents the // default access mode for all directories inside the file share. The default value // is 0777. @@ -287,6 +279,14 @@ type NFSFileShareDefaults struct { // The Unix file mode in the form "nnnn". For example, 0666 represents the default // file mode inside the file share. The default value is 0666. FileMode *string + + // The default group ID for the file share (unless the files have another group ID + // specified). The default value is nfsnobody. + GroupId *int64 + + // The default owner ID for files in the file share (unless the files have another + // owner ID specified). The default value is nfsnobody. + OwnerId *int64 } // The Unix file permissions and ownership information assigned, by default, to @@ -294,16 +294,43 @@ type NFSFileShareDefaults struct { // is only supported in file gateways. type NFSFileShareInfo struct { + // Refresh cache information. + CacheAttributes *CacheAttributes + + // The list of clients that are allowed to access the file gateway. The list must + // contain either valid IP addresses or valid CIDR blocks. + ClientList []*string + // The default storage class for objects put into an Amazon S3 bucket by the file // gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

    Valid // Values: S3_STANDARD | S3_INTELLIGENT_TIERING | // S3_STANDARD_IA | S3_ONEZONE_IA

    DefaultStorageClass *string + // The Amazon Resource Name (ARN) of the file share. + FileShareARN *string + + // The ID of the file share. + FileShareId *string + + // The name of the file share. Optional.

    FileShareName + // must be set if an S3 prefix name is set in LocationARN.

     + FileShareName *string + // The status of the file share.

    Valid Values: CREATING | // UPDATING | AVAILABLE | DELETING

    FileShareStatus *string + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation + // to return a list of gateways for your account and AWS Region. + GatewayARN *string + + // A value that enables guessing of the MIME type for uploaded objects based on + // file extensions. Set this value to true to enable MIME type guessing, otherwise + // set to false. The default value is true.

    Valid Values: true | + // false

    + GuessMIMETypeEnabled *bool + // Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, // or false to use a key managed by Amazon S3. Optional.

    Valid Values: // true | false

    @@ -314,28 +341,9 @@ type NFSFileShareInfo struct { // CMKs. This value can only be set when KMSEncrypted is true. Optional. KMSKey *string - // The list of clients that are allowed to access the file gateway. The list must - // contain either valid IP addresses or valid CIDR blocks. - ClientList []*string - - // The ARN of the IAM role that file gateway assumes when it accesses the - // underlying storage. - Role *string - - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation - // to return a list of gateways for your account and AWS Region. - GatewayARN *string - - // The file share path used by the NFS client to identify the mount point. - Path *string - - // Refresh cache information. - CacheAttributes *CacheAttributes - - // A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by - // key name. Each tag is a key-value pair. For a gateway with more than 10 tags - // assigned, you can view all tags using the ListTagsForResource API operation. - Tags []*Tag + // The ARN of the backend storage used for storing file data. A prefix name can be + // added to the S3 bucket name. It must end with a "/". + LocationARN *string // Describes Network File System (NFS) file share default values. Files and folders // stored as Amazon S3 objects in S3 buckets don't, by default, have Unix file @@ -344,17 +352,18 @@ type NFSFileShareInfo struct { // permissions. This operation is only supported for file gateways. NFSFileShareDefaults *NFSFileShareDefaults + // A value that sets the access control list (ACL) permission for objects in the S3 + // bucket that a file gateway puts objects into. The default value is private. + ObjectACL ObjectACL + + // The file share path used by the NFS client to identify the mount point. + Path *string + // A value that sets the write status of a file share. Set this value to true to // set the write status to read-only, otherwise set to false.

    Valid Values: // true | false

    ReadOnly *bool - // The ID of the file share. - FileShareId *string - - // The Amazon Resource Name (ARN) of the file share. - FileShareARN *string - // A value that sets who pays the cost of the request and the cost associated with // data download from the S3 bucket. If this value is set to true, the requester // pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket @@ -365,9 +374,9 @@ type NFSFileShareInfo struct { // false

    RequesterPays *bool - // The ARN of the backend storage used for storing file data. A prefix name can be - // added to the S3 bucket name. It must end with a "/". - LocationARN *string + // The ARN of the IAM role that file gateway assumes when it accesses the + // underlying storage. + Role *string // The user mapped to anonymous user. Valid options are the following:
    • //

      RootSquash: Only root is mapped to anonymous user.

      • @@ -376,100 +385,61 @@ type NFSFileShareInfo struct { //
    Squash *string - // A value that enables guessing of the MIME type for uploaded objects based on - // file extensions. Set this value to true to enable MIME type guessing, otherwise - // set to false. The default value is true.

    Valid Values: true | - // false

    - GuessMIMETypeEnabled *bool - - // The name of the file share. Optional.

    FileShareName - // must be set if an S3 prefix name is set in LocationARN.

     - FileShareName *string - - // A value that sets the access control list (ACL) permission for objects in the S3 - // bucket that a file gateway puts objects into. The default value is private. - ObjectACL ObjectACL -} + // A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by + // key name. Each tag is a key-value pair. For a gateway with more than 10 tags + // assigned, you can view all tags using the ListTagsForResource API operation. + Tags []*Tag +} // The Windows file permissions and ownership information assigned, by default, to // native S3 objects when file gateway discovers them in S3 buckets. This operation // is only supported for file gateways. type SMBFileShareInfo struct { - // A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by - // key name. Each tag is a key-value pair. For a gateway with more than 10 tags - // assigned, you can view all tags using the ListTagsForResource API operation. - Tags []*Tag - - // Refresh cache information. - CacheAttributes *CacheAttributes - - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation - // to return a list of gateways for your account and AWS Region. - GatewayARN *string - - // If this value is set to true, it indicates that access control list (ACL) is - // enabled on the SMB file share. If it is set to false, it indicates that file and - // directory permissions are mapped to the POSIX permission.

    For more - // information, see Using - // Microsoft Windows ACLs to control access to an SMB file share in the AWS - // Storage Gateway User Guide.

    - SMBACLEnabled *bool - // A list of users or groups in the Active Directory that have administrator rights // to the file share. A group must be prefixed with the @ character. Acceptable // formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be // set if Authentication is set to ActiveDirectory. AdminUserList []*string - // The ARN of the IAM role that file gateway assumes when it accesses the - // underlying storage. - Role *string + // The Amazon Resource Name (ARN) of the storage used for the audit logs. + AuditDestinationARN *string - // The ARN of the backend storage used for storing file data. A prefix name can be - // added to the S3 bucket name. It must end with a "/". - LocationARN *string + // The authentication method of the file share. The default is ActiveDirectory. + //

    Valid Values: ActiveDirectory | GuestAccess

    + Authentication *string - // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for - // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric - // CMKs. This value can only be set when KMSEncrypted is true. Optional. - KMSKey *string + // Refresh cache information. + CacheAttributes *CacheAttributes + + // The case of an object name in an Amazon S3 bucket. For ClientSpecified, the + // client determines the case sensitivity. For CaseSensitive, the gateway + // determines the case sensitivity. The default value is ClientSpecified. + CaseSensitivity CaseSensitivity + + // The default storage class for objects put into an Amazon S3 bucket by the file + // gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

    Valid + // Values: S3_STANDARD | S3_INTELLIGENT_TIERING | + // S3_STANDARD_IA | S3_ONEZONE_IA

    + DefaultStorageClass *string // The Amazon Resource Name (ARN) of the file share. FileShareARN *string - // Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, - // or false to use a key managed by Amazon S3. Optional.

    Valid Values: - // true | false

    - KMSEncrypted *bool - - // A value that sets who pays the cost of the request and the cost associated with - // data download from the S3 bucket. If this value is set to true, the requester - // pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket - // owner always pays the cost of storing data.

    - // RequesterPays is a configuration for the S3 bucket that backs the - // file share, so make sure that the configuration on the file share is the same as - // the S3 bucket configuration.

    Valid Values: true | - // false

    - RequesterPays *bool + // The ID of the file share. + FileShareId *string // The name of the file share. Optional.

    FileShareName // must be set if an S3 prefix name is set in LocationARN.

     FileShareName *string - // The default storage class for objects put into an Amazon S3 bucket by the file - // gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

    Valid - // Values: S3_STANDARD | S3_INTELLIGENT_TIERING | - // S3_STANDARD_IA | S3_ONEZONE_IA

    - DefaultStorageClass *string - - // A value that sets the access control list (ACL) permission for objects in the S3 - // bucket that a file gateway puts objects into. The default value is private. - ObjectACL ObjectACL + // The status of the file share.

    Valid Values: CREATING | + // UPDATING | AVAILABLE | DELETING

    + FileShareStatus *string - // The file share path used by the SMB client to identify the mount point. - Path *string + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation + // to return a list of gateways for your account and AWS Region. + GatewayARN *string // A value that enables guessing of the MIME type for uploaded objects based on // file extensions. Set this value to true to enable MIME type guessing, otherwise @@ -483,62 +453,99 @@ type SMBFileShareInfo struct { // set if Authentication is set to ActiveDirectory. InvalidUserList []*string - // The status of the file share.

    Valid Values: CREATING | - // UPDATING | AVAILABLE | DELETING

    - FileShareStatus *string + // Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, + // or false to use a key managed by Amazon S3. Optional.

    Valid Values: + // true | false

    + KMSEncrypted *bool - // The authentication method of the file share. The default is ActiveDirectory. - //

    Valid Values: ActiveDirectory | GuestAccess

    - Authentication *string + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for + // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric + // CMKs. This value can only be set when KMSEncrypted is true. Optional. + KMSKey *string - // A list of users or groups in the Active Directory that are allowed to access the - // file share. A group must be prefixed with the @ character. Acceptable formats - // include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if - // Authentication is set to ActiveDirectory. - ValidUserList []*string + // The ARN of the backend storage used for storing file data. A prefix name can be + // added to the S3 bucket name. It must end with a "/". + LocationARN *string + + // A value that sets the access control list (ACL) permission for objects in the S3 + // bucket that a file gateway puts objects into. The default value is private. + ObjectACL ObjectACL + + // The file share path used by the SMB client to identify the mount point. + Path *string // A value that sets the write status of a file share. Set this value to true to // set the write status to read-only, otherwise set to false.

    Valid Values: // true | false

    ReadOnly *bool - // The Amazon Resource Name (ARN) of the storage used for the audit logs. - AuditDestinationARN *string + // A value that sets who pays the cost of the request and the cost associated with + // data download from the S3 bucket. If this value is set to true, the requester + // pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket + // owner always pays the cost of storing data.

    + // RequesterPays is a configuration for the S3 bucket that backs the + // file share, so make sure that the configuration on the file share is the same as + // the S3 bucket configuration.

    Valid Values: true | + // false

    + RequesterPays *bool - // The ID of the file share. - FileShareId *string + // The ARN of the IAM role that file gateway assumes when it accesses the + // underlying storage. + Role *string - // The case of an object name in an Amazon S3 bucket. For ClientSpecified, the - // client determines the case sensitivity. For CaseSensitive, the gateway - // determines the case sensitivity. The default value is ClientSpecified. - CaseSensitivity CaseSensitivity + // If this value is set to true, it indicates that access control list (ACL) is + // enabled on the SMB file share. If it is set to false, it indicates that file and + // directory permissions are mapped to the POSIX permission.

    For more + // information, see Using + // Microsoft Windows ACLs to control access to an SMB file share in the AWS + // Storage Gateway User Guide.

    + SMBACLEnabled *bool + + // A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by + // key name. Each tag is a key-value pair. For a gateway with more than 10 tags + // assigned, you can view all tags using the ListTagsForResource API operation. + Tags []*Tag + + // A list of users or groups in the Active Directory that are allowed to access the + // file share. A group must be prefixed with the @ character. Acceptable formats + // include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if + // Authentication is set to ActiveDirectory. + ValidUserList []*string } // Provides additional information about an error that was returned by the service. // See the errorCode and errorDetails members for more information about the error. type StorageGatewayError struct { - // Human-readable text that provides detail about the error that occurred. - ErrorDetails map[string]*string - // Additional information about the error. ErrorCode ErrorCode + + // Human-readable text that provides detail about the error that occurred. + ErrorDetails map[string]*string } // Describes an iSCSI stored volume. type StorediSCSIVolume struct { - // The Amazon Resource Name (ARN) of the storage volume. - VolumeARN *string - - // The unique identifier of the volume, e.g. vol-AE4B946D. - VolumeId *string + // The date the volume was created. Volumes created prior to March 28, 2017 don’t + // have this time stamp. + CreatedDate *time.Time // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric // CMKs. This value can only be set when KMSEncrypted is true. Optional. KMSKey *string + // Indicates if when the stored volume was created, existing data on the underlying + // local disk was preserved.

    Valid Values: true | + // false

    + PreservedExistingData *bool + + // If the stored volume was created from a snapshot, this field contains the + // snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included. + SourceSnapshotId *string + // The name of the iSCSI target used by an initiator to connect to a volume and // used as a suffix for the target ARN. For example, specifying TargetName as // myvolume results in the target ARN of @@ -548,17 +555,8 @@ type StorediSCSIVolume struct { // this volume as the new target name.

    TargetName *string - // One of the VolumeType enumeration values describing the type of the volume. - VolumeType *string - - // Represents the percentage complete if the volume is restoring or bootstrapping - // that represents the percent of data transferred. This field does not appear in - // the response if the stored volume is not restoring or bootstrapping. - VolumeProgress *float64 - - // An VolumeiSCSIAttributes () object that represents a collection of iSCSI - // attributes for one stored volume. - VolumeiSCSIAttributes *VolumeiSCSIAttributes + // The Amazon Resource Name (ARN) of the storage volume. + VolumeARN *string // A value that indicates whether a storage volume is attached to, detached from, // or is in the process of detaching from a gateway. For more information, see @@ -566,25 +564,26 @@ type StorediSCSIVolume struct { // (https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#attach-detach-volume). VolumeAttachmentStatus *string - // Indicates if when the stored volume was created, existing data on the underlying - // local disk was preserved.

    Valid Values: true | - // false

    - PreservedExistingData *bool + // The ID of the local disk that was specified in the CreateStorediSCSIVolume () + // operation. + VolumeDiskId *string - // The date the volume was created. Volumes created prior to March 28, 2017 don’t - // have this time stamp. - CreatedDate *time.Time + // The unique identifier of the volume, e.g. vol-AE4B946D. + VolumeId *string + + // Represents the percentage complete if the volume is restoring or bootstrapping + // that represents the percent of data transferred. This field does not appear in + // the response if the stored volume is not restoring or bootstrapping. + VolumeProgress *float64 // The size of the volume in bytes. VolumeSizeInBytes *int64 - // If the stored volume was created from a snapshot, this field contains the - // snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included. - SourceSnapshotId *string + // One of the VolumeStatus values that indicates the state of the storage volume. + VolumeStatus *string - // The ID of the local disk that was specified in the CreateStorediSCSIVolume () - // operation. - VolumeDiskId *string + // One of the VolumeType enumeration values describing the type of the volume. + VolumeType *string // The size of the data stored on the volume in bytes. This value is calculated // based on the number of blocks that are touched, instead of the actual amount of @@ -595,8 +594,9 @@ type StorediSCSIVolume struct { // 13, 2015, until you store data on the volume.

     VolumeUsedInBytes *int64 - // One of the VolumeStatus values that indicates the state of the storage volume. - VolumeStatus *string + // An VolumeiSCSIAttributes () object that represents a collection of iSCSI + // attributes for one stored volume. + VolumeiSCSIAttributes *VolumeiSCSIAttributes } // A key-value pair that helps you manage, filter, and search for your resource. @@ -618,12 +618,10 @@ type Tag struct { // Describes a virtual tape object. type Tape struct { - // The barcode that identifies a specific virtual tape. - TapeBarcode *string - - // The size, in bytes, of data stored on the virtual tape.

    This value is - // not available for tapes created prior to May 13, 2015.

     - TapeUsedInBytes *int64 + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for + // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric + // CMKs. This value can only be set when KMSEncrypted is true. Optional. + KMSKey *string // The ID of the pool that contains tapes that will be archived. The tapes in this // pool are archived in the S3 storage class that is associated with the pool. When @@ -637,13 +635,11 @@ type Tape struct { // before archiving is complete.

    Range: 0 (not started) to 100 (complete).

    Progress *float64 - // The virtual tape library (VTL) device that the virtual tape is associated with. - VTLDevice *string + // The Amazon Resource Name (ARN) of the virtual tape. + TapeARN *string - // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for - // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric - // CMKs. This value can only be set when KMSEncrypted is true. Optional. - KMSKey *string + // The barcode that identifies a specific virtual tape. + TapeBarcode *string // The date the virtual tape was created. TapeCreatedDate *time.Time @@ -654,72 +650,64 @@ type Tape struct { // The current state of the virtual tape. TapeStatus *string - // The Amazon Resource Name (ARN) of the virtual tape. - TapeARN *string + // The size, in bytes, of data stored on the virtual tape.

    This value is + // not available for tapes created prior to May 13, 2015.

     + TapeUsedInBytes *int64 + + // The virtual tape library (VTL) device that the virtual tape is associated with. + VTLDevice *string } // Represents a virtual tape that is archived in the virtual tape shelf (VTS). type TapeArchive struct { - // The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is - // being retrieved to.

    The virtual tape is retrieved from the virtual tape - // shelf (VTS).

    - RetrievedTo *string - // The time that the archiving of the virtual tape was completed.

    The default // time stamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' // format.

    CompletionTime *time.Time - // The size, in bytes, of data stored on the virtual tape.

    This value is - // not available for tapes created prior to May 13, 2015.

     - TapeUsedInBytes *int64 - - // The Amazon Resource Name (ARN) of an archived virtual tape. - TapeARN *string - - // The current state of the archived virtual tape. - TapeStatus *string + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for + // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric + // CMKs. This value can only be set when KMSEncrypted is true. Optional. + KMSKey *string // The ID of the pool that was used to archive the tape. The tapes in this pool are // archived in the S3 storage class that is associated with the pool.

    Valid // Values: GLACIER | DEEP_ARCHIVE

    PoolId *string + // The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is + // being retrieved to.

    The virtual tape is retrieved from the virtual tape + // shelf (VTS).

    + RetrievedTo *string + + // The Amazon Resource Name (ARN) of an archived virtual tape. + TapeARN *string + + // The barcode that identifies the archived virtual tape. + TapeBarcode *string + // The date the virtual tape was created. TapeCreatedDate *time.Time // The size, in bytes, of the archived virtual tape. TapeSizeInBytes *int64 - // The barcode that identifies the archived virtual tape. - TapeBarcode *string + // The current state of the archived virtual tape. + TapeStatus *string - // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for - // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric - // CMKs. This value can only be set when KMSEncrypted is true. Optional. - KMSKey *string + // The size, in bytes, of data stored on the virtual tape.

    This value is + // not available for tapes created prior to May 13, 2015.

     + TapeUsedInBytes *int64 } // Describes a virtual tape. type TapeInfo struct { - // The Amazon Resource Name (ARN) of a virtual tape. - TapeARN *string - - // The status of the tape. - TapeStatus *string - - // The barcode that identifies a specific virtual tape. - TapeBarcode *string - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways () operation // to return a list of gateways for your account and AWS Region. GatewayARN *string - // The size, in bytes, of a virtual tape. - TapeSizeInBytes *int64 - // The ID of the pool that you want to add your tape to for archiving. The tape in // this pool is archived in the S3 storage class that is associated with the pool. // When you use your backup application to eject the tape, the tape is archived @@ -727,24 +715,36 @@ type TapeInfo struct { // corresponds to the pool.

    Valid Values: GLACIER | // DEEP_ARCHIVE

    PoolId *string + + // The Amazon Resource Name (ARN) of a virtual tape. + TapeARN *string + + // The barcode that identifies a specific virtual tape. + TapeBarcode *string + + // The size, in bytes, of a virtual tape. + TapeSizeInBytes *int64 + + // The status of the tape. + TapeStatus *string } // Describes a recovery point. type TapeRecoveryPointInfo struct { + // The Amazon Resource Name (ARN) of the virtual tape. + TapeARN *string + // The time when the point-in-time view of the virtual tape was replicated for // later recovery.

    The default time stamp format of the tape recovery point // time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.

    TapeRecoveryPointTime *time.Time - // The status of the virtual tapes. - TapeStatus *string - // The size, in bytes, of the virtual tapes to recover. TapeSizeInBytes *int64 - // The Amazon Resource Name (ARN) of the virtual tape. - TapeARN *string + // The status of the virtual tapes. + TapeStatus *string } // Describes a storage volume object. @@ -754,25 +754,12 @@ type VolumeInfo struct { // to return a list of gateways for your account and AWS Region. GatewayARN *string - // The unique identifier assigned to the volume. This ID becomes part of the volume - // Amazon Resource Name (ARN), which you use as input for other operations. - //

    Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens - // (-).

    - VolumeId *string - - // One of the VolumeType enumeration values describing the type of the volume. - VolumeType *string - // The unique identifier assigned to your gateway during activation. This ID // becomes part of the gateway Amazon Resource Name (ARN), which you use as input // for other operations.

    Valid Values: 50 to 500 lowercase letters, numbers, // periods (.), and hyphens (-).

    GatewayId *string - // The size of the volume in bytes.

    Valid Values: 50 to 500 lowercase letters, - // numbers, periods (.), and hyphens (-).

    - VolumeSizeInBytes *int64 - // The Amazon Resource Name (ARN) for the storage volume. For example, the // following is a valid ARN:

    // arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB @@ -782,39 +769,52 @@ type VolumeInfo struct { // One of the VolumeStatus values that indicates the state of the storage volume. VolumeAttachmentStatus *string + + // The unique identifier assigned to the volume. This ID becomes part of the volume + // Amazon Resource Name (ARN), which you use as input for other operations. + //

    Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens + // (-).

    + VolumeId *string + + // The size of the volume in bytes.

    Valid Values: 50 to 500 lowercase letters, + // numbers, periods (.), and hyphens (-).

    + VolumeSizeInBytes *int64 + + // One of the VolumeType enumeration values describing the type of the volume. + VolumeType *string } // Lists iSCSI information about a volume. type VolumeiSCSIAttributes struct { + // Indicates whether mutual CHAP is enabled for the iSCSI target. + ChapEnabled *bool + // The logical disk number. LunNumber *int32 + // The network interface identifier. + NetworkInterfaceId *string + // The port used to communicate with iSCSI targets. NetworkInterfacePort *int32 - // Indicates whether mutual CHAP is enabled for the iSCSI target. - ChapEnabled *bool - // The Amazon Resource Name (ARN) of the volume target. TargetARN *string - - // The network interface identifier. - NetworkInterfaceId *string } // Describes a storage volume recovery point object. type VolumeRecoveryPointInfo struct { - // The size of the volume in bytes. - VolumeSizeInBytes *int64 - // The Amazon Resource Name (ARN) of the volume target. VolumeARN *string // The time the recovery point was taken. VolumeRecoveryPointTime *string + // The size of the volume in bytes. + VolumeSizeInBytes *int64 + // The size of the data stored on the volume in bytes.

    This value is not // available for volumes created prior to May 13, 2015, until you store data on the // volume.

     @@ -824,19 +824,19 @@ type VolumeRecoveryPointInfo struct { // Represents a device object associated with a tape gateway. type VTLDevice struct { - // Specifies the model number of device that the VTL device emulates. - VTLDeviceProductIdentifier *string - - // Specifies the vendor of the device that the VTL device object emulates. - VTLDeviceVendor *string - - // Specifies the type of device that the VTL device emulates. - VTLDeviceType *string - // A list of iSCSI information about a VTL device. DeviceiSCSIAttributes *DeviceiSCSIAttributes // Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or // media changer). VTLDeviceARN *string + + // Specifies the model number of device that the VTL device emulates. + VTLDeviceProductIdentifier *string + + // Specifies the type of device that the VTL device emulates. + VTLDeviceType *string + + // Specifies the vendor of the device that the VTL device object emulates. + VTLDeviceVendor *string } diff --git a/service/sts/api_op_AssumeRole.go b/service/sts/api_op_AssumeRole.go index 126025a81ec..f863f10f291 100644 --- a/service/sts/api_op_AssumeRole.go +++ b/service/sts/api_op_AssumeRole.go @@ -154,6 +154,45 @@ func (c *Client) AssumeRole(ctx context.Context, params *AssumeRoleInput, optFns type AssumeRoleInput struct { + // The Amazon Resource Name (ARN) of the role to assume. + // + // This member is required. + RoleArn *string + + // An identifier for the assumed role session. Use the role session name to + // uniquely identify a session when the same role is assumed by different + // principals or for different reasons. In cross-account scenarios, the role + // session name is visible to, and can be logged by the account that owns the role. + // The role session name is also used in the ARN of the assumed role principal. + // This means that subsequent cross-account API requests that use the temporary + // security credentials will expose the role session name to the external account + // in their AWS CloudTrail logs. The regex used to validate this parameter is a + // string of characters consisting of upper- and lower-case alphanumeric characters + // with no spaces. You can also include underscores or any of the following + // characters: =,.@- + // + // This member is required. + RoleSessionName *string + + // The duration, in seconds, of the role session. The value can range from 900 + // seconds (15 minutes) up to the maximum session duration setting for the role. + // This setting can have a value from 1 hour to 12 hours. If you specify a value + // higher than this setting, the operation fails. For example, if you specify a + // session duration of 12 hours, but your administrator set the maximum session + // duration to 6 hours, your operation fails. To learn how to view the maximum + // value for your role, see View the Maximum Session Duration Setting for a Role + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session) + // in the IAM User Guide. By default, the value is set to 3600 seconds. The + // DurationSeconds parameter is separate from the duration of a console session + // that you might request using the returned credentials. The request to the + // federation endpoint for a console sign-in token takes a SessionDuration + // parameter that specifies the maximum length of the console session. For more + // information, see Creating a URL that Enables Federated Users to Access the AWS + // Management Console + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html) + // in the IAM User Guide. + DurationSeconds *int32 + // A unique identifier that might be required when you assume a role in another // account. If the administrator of the account to which the role belongs provided // you with an external ID, then provide that value in the ExternalId parameter. @@ -171,16 +210,26 @@ type AssumeRoleInput struct { // =,.@:/- ExternalId *string - // The identification number of the MFA device that is associated with the user who - // is making the AssumeRole call. Specify this value if the trust policy of the - // role being assumed includes a condition that requires MFA authentication. The - // value is either the serial number for a hardware device (such as GAHT12345678) - // or an Amazon Resource Name (ARN) for a virtual device (such as - // arn:aws:iam::123456789012:mfa/user). The regex used to validate this parameter - // is a string of characters consisting of upper- and lower-case alphanumeric - // characters with no spaces. You can also include underscores or any of the - // following characters: =,.@- - SerialNumber *string + // An IAM policy in JSON format that you want to use as an inline session policy. + // This parameter is optional. Passing policies to this operation returns new + // temporary credentials. The resulting session's permissions are the intersection + // of the role's identity-based policy and the session policies. You can use the + // role's temporary credentials in subsequent AWS API calls to access resources in + // the account that owns the role. You cannot use session policies to grant more + // permissions than those allowed by the identity-based policy of the role that is + // being assumed. For more information, see Session Policies + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) + // in the IAM User Guide. The plain text that you use for both inline and managed + // session policies can't exceed 2,048 characters. The JSON policy characters can + // be any ASCII character from the space character to the end of the valid + // character list (\u0020 through \u00FF). It can also include the tab (\u0009), + // linefeed (\u000A), and carriage return (\u000D) characters.

    An AWS + // conversion compresses the passed session policies and session tags into a packed + // binary format that has a separate limit. Your request can fail for this limit + // even if your plain text meets the other requirements. The + // PackedPolicySize response element indicates by percentage how close + // the policies and tags for your request are to the upper size limit.

    + Policy *string // The Amazon Resource Names (ARNs) of the IAM managed policies that you want to // use as managed session policies. The policies must exist in the same account as @@ -205,79 +254,16 @@ type AssumeRoleInput struct { // Policies in the IAM User Guide.

    PolicyArns []*types.PolicyDescriptorType - // A list of keys for session tags that you want to set as transitive. If you set a - // tag key as transitive, the corresponding key and value passes to subsequent - // sessions in a role chain. For more information, see Chaining Roles with Session - // Tags - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining) - // in the IAM User Guide. This parameter is optional. When you set session tags as - // transitive, the session policy and session tags packed binary limit is not - // affected. If you choose not to specify a transitive tag key, then no tags are - // passed from this session to any subsequent sessions. - TransitiveTagKeys []*string - - // An identifier for the assumed role session. Use the role session name to - // uniquely identify a session when the same role is assumed by different - // principals or for different reasons. In cross-account scenarios, the role - // session name is visible to, and can be logged by the account that owns the role. - // The role session name is also used in the ARN of the assumed role principal. - // This means that subsequent cross-account API requests that use the temporary - // security credentials will expose the role session name to the external account - // in their AWS CloudTrail logs. The regex used to validate this parameter is a - // string of characters consisting of upper- and lower-case alphanumeric characters - // with no spaces. You can also include underscores or any of the following - // characters: =,.@- - // - // This member is required. - RoleSessionName *string - - // The value provided by the MFA device, if the trust policy of the role being - // assumed requires MFA (that is, if the policy includes a condition that tests for - // MFA). If the role being assumed requires MFA and if the TokenCode value is - // missing or expired, the AssumeRole call returns an "access denied" error. The - // format for this parameter, as described by its regex pattern, is a sequence of - // six numeric digits. - TokenCode *string - - // An IAM policy in JSON format that you want to use as an inline session policy. - // This parameter is optional. Passing policies to this operation returns new - // temporary credentials. The resulting session's permissions are the intersection - // of the role's identity-based policy and the session policies. You can use the - // role's temporary credentials in subsequent AWS API calls to access resources in - // the account that owns the role. You cannot use session policies to grant more - // permissions than those allowed by the identity-based policy of the role that is - // being assumed. For more information, see Session Policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) - // in the IAM User Guide. The plain text that you use for both inline and managed - // session policies can't exceed 2,048 characters. The JSON policy characters can - // be any ASCII character from the space character to the end of the valid - // character list (\u0020 through \u00FF). It can also include the tab (\u0009), - // linefeed (\u000A), and carriage return (\u000D) characters.

    An AWS - // conversion compresses the passed session policies and session tags into a packed - // binary format that has a separate limit. Your request can fail for this limit - // even if your plain text meets the other requirements. The - // PackedPolicySize response element indicates by percentage how close - // the policies and tags for your request are to the upper size limit.

    - Policy *string - - // The duration, in seconds, of the role session. The value can range from 900 - // seconds (15 minutes) up to the maximum session duration setting for the role. - // This setting can have a value from 1 hour to 12 hours. If you specify a value - // higher than this setting, the operation fails. For example, if you specify a - // session duration of 12 hours, but your administrator set the maximum session - // duration to 6 hours, your operation fails. To learn how to view the maximum - // value for your role, see View the Maximum Session Duration Setting for a Role - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session) - // in the IAM User Guide. By default, the value is set to 3600 seconds. The - // DurationSeconds parameter is separate from the duration of a console session - // that you might request using the returned credentials. The request to the - // federation endpoint for a console sign-in token takes a SessionDuration - // parameter that specifies the maximum length of the console session. For more - // information, see Creating a URL that Enables Federated Users to Access the AWS - // Management Console - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html) - // in the IAM User Guide. - DurationSeconds *int32 + // The identification number of the MFA device that is associated with the user who + // is making the AssumeRole call. Specify this value if the trust policy of the + // role being assumed includes a condition that requires MFA authentication. The + // value is either the serial number for a hardware device (such as GAHT12345678) + // or an Amazon Resource Name (ARN) for a virtual device (such as + // arn:aws:iam::123456789012:mfa/user). The regex used to validate this parameter + // is a string of characters consisting of upper- and lower-case alphanumeric + // characters with no spaces. You can also include underscores or any of the + // following characters: =,.@- + SerialNumber *string // A list of session tags that you want to pass. Each session tag consists of a key // name and an associated value. For more information about session tags, see @@ -311,22 +297,30 @@ type AssumeRoleInput struct { // Session Tags in CloudTrail in the IAM User Guide.

    Tags []*types.Tag - // The Amazon Resource Name (ARN) of the role to assume. - // - // This member is required. - RoleArn *string + // The value provided by the MFA device, if the trust policy of the role being + // assumed requires MFA (that is, if the policy includes a condition that tests for + // MFA). If the role being assumed requires MFA and if the TokenCode value is + // missing or expired, the AssumeRole call returns an "access denied" error. The + // format for this parameter, as described by its regex pattern, is a sequence of + // six numeric digits. + TokenCode *string + + // A list of keys for session tags that you want to set as transitive. If you set a + // tag key as transitive, the corresponding key and value passes to subsequent + // sessions in a role chain. For more information, see Chaining Roles with Session + // Tags + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining) + // in the IAM User Guide. This parameter is optional. When you set session tags as + // transitive, the session policy and session tags packed binary limit is not + // affected. If you choose not to specify a transitive tag key, then no tags are + // passed from this session to any subsequent sessions. + TransitiveTagKeys []*string } // Contains the response to a successful AssumeRole () request, including temporary // AWS credentials that can be used to make AWS requests. type AssumeRoleOutput struct { - // The temporary security credentials, which include an access key ID, a secret - // access key, and a security (or session) token. The size of the security token - // that STS API operations return is not fixed. We strongly recommend that you make - // no assumptions about the maximum size. - Credentials *types.Credentials - // The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers // that you can use to refer to the resulting temporary security credentials. For // example, you can reference these credentials as a principal in a resource-based @@ -334,6 +328,12 @@ type AssumeRoleOutput struct { // RoleSessionName that you specified when you called AssumeRole. AssumedRoleUser *types.AssumedRoleUser + // The temporary security credentials, which include an access key ID, a secret + // access key, and a security (or session) token. The size of the security token + // that STS API operations return is not fixed. We strongly recommend that you make + // no assumptions about the maximum size. + Credentials *types.Credentials + // A percentage value that indicates the packed size of the session policies and // session tags combined passed in the request. The request fails if the packed // size is greater than 100 percent, which means the policies and tags exceeded the diff --git a/service/sts/api_op_AssumeRoleWithSAML.go b/service/sts/api_op_AssumeRoleWithSAML.go index 804923ce0e0..967550b5881 100644 --- a/service/sts/api_op_AssumeRoleWithSAML.go +++ b/service/sts/api_op_AssumeRoleWithSAML.go @@ -157,50 +157,6 @@ type AssumeRoleWithSAMLInput struct { // This member is required. PrincipalArn *string - // The Amazon Resource Names (ARNs) of the IAM managed policies that you want to - // use as managed session policies. The policies must exist in the same account as - // the role. This parameter is optional. You can provide up to 10 managed policy - // ARNs. However, the plain text that you use for both inline and managed session - // policies can't exceed 2,048 characters. For more information about ARNs, see - // Amazon Resource Names (ARNs) and AWS Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference. An AWS conversion compresses the passed session - // policies and session tags into a packed binary format that has a separate limit. - // Your request can fail for this limit even if your plain text meets the other - // requirements. The PackedPolicySize response element indicates by percentage how - // close the policies and tags for your request are to the upper size limit. - //

    Passing policies to this operation returns new temporary credentials. The - // resulting session's permissions are the intersection of the role's - // identity-based policy and the session policies. You can use the role's temporary - // credentials in subsequent AWS API calls to access resources in the account that - // owns the role. You cannot use session policies to grant more permissions than - // those allowed by the identity-based policy of the role that is being assumed. - // For more information, see Session - // Policies in the IAM User Guide.

    - PolicyArns []*types.PolicyDescriptorType - - // An IAM policy in JSON format that you want to use as an inline session policy. - // This parameter is optional. Passing policies to this operation returns new - // temporary credentials. The resulting session's permissions are the intersection - // of the role's identity-based policy and the session policies. You can use the - // role's temporary credentials in subsequent AWS API calls to access resources in - // the account that owns the role. You cannot use session policies to grant more - // permissions than those allowed by the identity-based policy of the role that is - // being assumed. For more information, see Session Policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) - // in the IAM User Guide. The plain text that you use for both inline and managed - // session policies can't exceed 2,048 characters. The JSON policy characters can - // be any ASCII character from the space character to the end of the valid - // character list (\u0020 through \u00FF). It can also include the tab (\u0009), - // linefeed (\u000A), and carriage return (\u000D) characters. An AWS conversion - // compresses the passed session policies and session tags into a packed binary - // format that has a separate limit. Your request can fail for this limit even if - // your plain text meets the other requirements. The PackedPolicySize response - // element indicates by percentage how close the policies and tags for your request - // are to the upper size limit. - Policy *string - // The Amazon Resource Name (ARN) of the role that the caller is assuming. // // This member is required. @@ -235,34 +191,69 @@ type AssumeRoleWithSAMLInput struct { // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html) // in the IAM User Guide. DurationSeconds *int32 + + // An IAM policy in JSON format that you want to use as an inline session policy. + // This parameter is optional. Passing policies to this operation returns new + // temporary credentials. The resulting session's permissions are the intersection + // of the role's identity-based policy and the session policies. You can use the + // role's temporary credentials in subsequent AWS API calls to access resources in + // the account that owns the role. You cannot use session policies to grant more + // permissions than those allowed by the identity-based policy of the role that is + // being assumed. For more information, see Session Policies + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) + // in the IAM User Guide. The plain text that you use for both inline and managed + // session policies can't exceed 2,048 characters. The JSON policy characters can + // be any ASCII character from the space character to the end of the valid + // character list (\u0020 through \u00FF). It can also include the tab (\u0009), + // linefeed (\u000A), and carriage return (\u000D) characters. An AWS conversion + // compresses the passed session policies and session tags into a packed binary + // format that has a separate limit. Your request can fail for this limit even if + // your plain text meets the other requirements. The PackedPolicySize response + // element indicates by percentage how close the policies and tags for your request + // are to the upper size limit. + Policy *string + + // The Amazon Resource Names (ARNs) of the IAM managed policies that you want to + // use as managed session policies. The policies must exist in the same account as + // the role. This parameter is optional. You can provide up to 10 managed policy + // ARNs. However, the plain text that you use for both inline and managed session + // policies can't exceed 2,048 characters. For more information about ARNs, see + // Amazon Resource Names (ARNs) and AWS Service Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in + // the AWS General Reference. An AWS conversion compresses the passed session + // policies and session tags into a packed binary format that has a separate limit. + // Your request can fail for this limit even if your plain text meets the other + // requirements. The PackedPolicySize response element indicates by percentage how + // close the policies and tags for your request are to the upper size limit. + //

    Passing policies to this operation returns new temporary credentials. The + // resulting session's permissions are the intersection of the role's + // identity-based policy and the session policies. You can use the role's temporary + // credentials in subsequent AWS API calls to access resources in the account that + // owns the role. You cannot use session policies to grant more permissions than + // those allowed by the identity-based policy of the role that is being assumed. + // For more information, see Session + // Policies in the IAM User Guide.

    + PolicyArns []*types.PolicyDescriptorType } // Contains the response to a successful AssumeRoleWithSAML () request, including // temporary AWS credentials that can be used to make AWS requests. type AssumeRoleWithSAMLOutput struct { + // The identifiers for the temporary security credentials that the operation + // returns. + AssumedRoleUser *types.AssumedRoleUser + // The value of the Recipient attribute of the SubjectConfirmationData element of // the SAML assertion. Audience *string - // A percentage value that indicates the packed size of the session policies and - // session tags combined passed in the request. The request fails if the packed - // size is greater than 100 percent, which means the policies and tags exceeded the - // allowed space. - PackedPolicySize *int32 - - // The format of the name ID, as defined by the Format attribute in the NameID - // element of the SAML assertion. Typical examples of the format are transient or - // persistent. If the format includes the prefix - // urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. For example, - // urn:oasis:names:tc:SAML:2.0:nameid-format:transient is returned as transient. If - // the format includes any other prefix, the format is returned with no - // modifications. - SubjectType *string - - // The identifiers for the temporary security credentials that the operation - // returns. - AssumedRoleUser *types.AssumedRoleUser + // The temporary security credentials, which include an access key ID, a secret + // access key, and a security (or session) token. The size of the security token + // that STS API operations return is not fixed. We strongly recommend that you make + // no assumptions about the maximum size. + Credentials *types.Credentials // The value of the Issuer element of the SAML assertion. Issuer *string @@ -275,15 +266,24 @@ type AssumeRoleWithSAMLOutput struct { // + "/MySAMLIdP" ) ) NameQualifier *string - // The temporary security credentials, which include an access key ID, a secret - // access key, and a security (or session) token. The size of the security token - // that STS API operations return is not fixed. We strongly recommend that you make - // no assumptions about the maximum size. - Credentials *types.Credentials + // A percentage value that indicates the packed size of the session policies and + // session tags combined passed in the request. The request fails if the packed + // size is greater than 100 percent, which means the policies and tags exceeded the + // allowed space. + PackedPolicySize *int32 // The value of the NameID element in the Subject element of the SAML assertion. Subject *string + // The format of the name ID, as defined by the Format attribute in the NameID + // element of the SAML assertion. Typical examples of the format are transient or + // persistent. If the format includes the prefix + // urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. For example, + // urn:oasis:names:tc:SAML:2.0:nameid-format:transient is returned as transient. If + // the format includes any other prefix, the format is returned with no + // modifications. + SubjectType *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/sts/api_op_AssumeRoleWithWebIdentity.go b/service/sts/api_op_AssumeRoleWithWebIdentity.go index 9dfd1e4bf8d..128c6df21f8 100644 --- a/service/sts/api_op_AssumeRoleWithWebIdentity.go +++ b/service/sts/api_op_AssumeRoleWithWebIdentity.go @@ -178,27 +178,6 @@ type AssumeRoleWithWebIdentityInput struct { // This member is required. RoleArn *string - // An IAM policy in JSON format that you want to use as an inline session policy. - // This parameter is optional. Passing policies to this operation returns new - // temporary credentials. The resulting session's permissions are the intersection - // of the role's identity-based policy and the session policies. You can use the - // role's temporary credentials in subsequent AWS API calls to access resources in - // the account that owns the role. You cannot use session policies to grant more - // permissions than those allowed by the identity-based policy of the role that is - // being assumed. For more information, see Session Policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) - // in the IAM User Guide. The plain text that you use for both inline and managed - // session policies can't exceed 2,048 characters. The JSON policy characters can - // be any ASCII character from the space character to the end of the valid - // character list (\u0020 through \u00FF). It can also include the tab (\u0009), - // linefeed (\u000A), and carriage return (\u000D) characters. An AWS conversion - // compresses the passed session policies and session tags into a packed binary - // format that has a separate limit. Your request can fail for this limit even if - // your plain text meets the other requirements. The PackedPolicySize response - // element indicates by percentage how close the policies and tags for your request - // are to the upper size limit. - Policy *string - // An identifier for the assumed role session. Typically, you pass the name or // identifier that is associated with the user who is using your application. That // way, the temporary security credentials that your application will use are @@ -211,6 +190,14 @@ type AssumeRoleWithWebIdentityInput struct { // This member is required. RoleSessionName *string + // The OAuth 2.0 access token or OpenID Connect ID token that is provided by the + // identity provider. Your application must get this token by authenticating the + // user who is using your application with a web identity provider before the + // application makes an AssumeRoleWithWebIdentity call. + // + // This member is required. + WebIdentityToken *string + // The duration, in seconds, of the role session. The value can range from 900 // seconds (15 minutes) up to the maximum session duration setting for the role. // This setting can have a value from 1 hour to 12 hours. If you specify a value @@ -230,6 +217,27 @@ type AssumeRoleWithWebIdentityInput struct { // in the IAM User Guide. DurationSeconds *int32 + // An IAM policy in JSON format that you want to use as an inline session policy. + // This parameter is optional. Passing policies to this operation returns new + // temporary credentials. The resulting session's permissions are the intersection + // of the role's identity-based policy and the session policies. You can use the + // role's temporary credentials in subsequent AWS API calls to access resources in + // the account that owns the role. You cannot use session policies to grant more + // permissions than those allowed by the identity-based policy of the role that is + // being assumed. For more information, see Session Policies + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) + // in the IAM User Guide. The plain text that you use for both inline and managed + // session policies can't exceed 2,048 characters. The JSON policy characters can + // be any ASCII character from the space character to the end of the valid + // character list (\u0020 through \u00FF). It can also include the tab (\u0009), + // linefeed (\u000A), and carriage return (\u000D) characters. An AWS conversion + // compresses the passed session policies and session tags into a packed binary + // format that has a separate limit. Your request can fail for this limit even if + // your plain text meets the other requirements. The PackedPolicySize response + // element indicates by percentage how close the policies and tags for your request + // are to the upper size limit. + Policy *string + // The Amazon Resource Names (ARNs) of the IAM managed policies that you want to // use as managed session policies. The policies must exist in the same account as // the role. This parameter is optional. You can provide up to 10 managed policy @@ -253,14 +261,6 @@ type AssumeRoleWithWebIdentityInput struct { // Policies in the IAM User Guide.

    PolicyArns []*types.PolicyDescriptorType - // The OAuth 2.0 access token or OpenID Connect ID token that is provided by the - // identity provider. Your application must get this token by authenticating the - // user who is using your application with a web identity provider before the - // application makes an AssumeRoleWithWebIdentity call. - // - // This member is required. - WebIdentityToken *string - // The fully qualified host component of the domain name of the identity provider. // Specify this value only for OAuth 2.0 access tokens. Currently www.amazon.com // and graph.facebook.com are the only supported identity providers for OAuth 2.0 @@ -273,23 +273,6 @@ type AssumeRoleWithWebIdentityInput struct { // including temporary AWS credentials that can be used to make AWS requests. type AssumeRoleWithWebIdentityOutput struct { - // A percentage value that indicates the packed size of the session policies and - // session tags combined passed in the request. The request fails if the packed - // size is greater than 100 percent, which means the policies and tags exceeded the - // allowed space. - PackedPolicySize *int32 - - // The intended audience (also known as client ID) of the web identity token. This - // is traditionally the client identifier issued to the application that requested - // the web identity token. - Audience *string - - // The issuing authority of the web identity token presented. For OpenID Connect ID - // tokens, this contains the value of the iss field. For OAuth 2.0 access tokens, - // this contains the value of the ProviderId parameter that was passed in the - // AssumeRoleWithWebIdentity request. - Provider *string - // The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers // that you can use to refer to the resulting temporary security credentials. For // example, you can reference these credentials as a principal in a resource-based @@ -297,12 +280,29 @@ type AssumeRoleWithWebIdentityOutput struct { // RoleSessionName that you specified when you called AssumeRole. AssumedRoleUser *types.AssumedRoleUser + // The intended audience (also known as client ID) of the web identity token. This + // is traditionally the client identifier issued to the application that requested + // the web identity token. + Audience *string + // The temporary security credentials, which include an access key ID, a secret // access key, and a security token. The size of the security token that STS API // operations return is not fixed. We strongly recommend that you make no // assumptions about the maximum size. Credentials *types.Credentials + // A percentage value that indicates the packed size of the session policies and + // session tags combined passed in the request. The request fails if the packed + // size is greater than 100 percent, which means the policies and tags exceeded the + // allowed space. + PackedPolicySize *int32 + + // The issuing authority of the web identity token presented. For OpenID Connect ID + // tokens, this contains the value of the iss field. For OAuth 2.0 access tokens, + // this contains the value of the ProviderId parameter that was passed in the + // AssumeRoleWithWebIdentity request. + Provider *string + // The unique user identifier that is returned by the identity provider. This // identifier is associated with the WebIdentityToken that was submitted with the // AssumeRoleWithWebIdentity call. The identifier is typically unique to the user diff --git a/service/sts/api_op_GetCallerIdentity.go b/service/sts/api_op_GetCallerIdentity.go index c7e50864864..d201010eb06 100644 --- a/service/sts/api_op_GetCallerIdentity.go +++ b/service/sts/api_op_GetCallerIdentity.go @@ -68,13 +68,13 @@ type GetCallerIdentityInput struct { // information about the entity making the request. type GetCallerIdentityOutput struct { - // The AWS ARN associated with the calling entity. - Arn *string - // The AWS account ID number of the account that owns or contains the calling // entity. Account *string + // The AWS ARN associated with the calling entity. + Arn *string + // The unique identifier of the calling entity. The exact value depends on the type // of entity that is making the call. The values returned are those listed in the // aws:userid column in the Principal table diff --git a/service/sts/api_op_GetFederationToken.go b/service/sts/api_op_GetFederationToken.go index f1738950e34..71639f3b2c4 100644 --- a/service/sts/api_op_GetFederationToken.go +++ b/service/sts/api_op_GetFederationToken.go @@ -133,14 +133,6 @@ func (c *Client) GetFederationToken(ctx context.Context, params *GetFederationTo type GetFederationTokenInput struct { - // The duration, in seconds, that the session should last. Acceptable durations for - // federation sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 - // hours), with 43,200 seconds (12 hours) as the default. Sessions obtained using - // AWS account root user credentials are restricted to a maximum of 3,600 seconds - // (one hour). If the specified duration is longer than one hour, the session - // obtained by using root user credentials defaults to one hour. - DurationSeconds *int32 - // The name of the federated user. The name is used as an identifier for the // temporary security credentials (such as Bob). For example, you can reference the // federated user name in a resource-based policy, such as in an Amazon S3 bucket @@ -151,6 +143,44 @@ type GetFederationTokenInput struct { // This member is required. Name *string + // The duration, in seconds, that the session should last. Acceptable durations for + // federation sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 + // hours), with 43,200 seconds (12 hours) as the default. Sessions obtained using + // AWS account root user credentials are restricted to a maximum of 3,600 seconds + // (one hour). If the specified duration is longer than one hour, the session + // obtained by using root user credentials defaults to one hour. + DurationSeconds *int32 + + // An IAM policy in JSON format that you want to use as an inline session policy. + // You must pass an inline or managed session policy + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) + // to this operation. You can pass a single JSON policy document to use as an + // inline session policy. You can also specify up to 10 managed policies to use as + // managed session policies. This parameter is optional. However, if you do not + // pass any session policies, then the resulting federated user session has no + // permissions. When you pass session policies, the session permissions are the + // intersection of the IAM user policies and the session policies that you pass. + // This gives you a way to further restrict the permissions for a federated user. + // You cannot use session policies to grant more permissions than those that are + // defined in the permissions policy of the IAM user. For more information, see + // Session Policies + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) + // in the IAM User Guide. The resulting credentials can be used to access a + // resource that has a resource-based policy. If that policy specifically + // references the federated user session in the Principal element of the policy, + // the session has the permissions allowed by the policy. These permissions are + // granted in addition to the permissions that are granted by the session policies. + // The plain text that you use for both inline and managed session policies can't + // exceed 2,048 characters. The JSON policy characters can be any ASCII character + // from the space character to the end of the valid character list (\u0020 through + // \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage + // return (\u000D) characters. An AWS conversion compresses the passed session + // policies and session tags into a packed binary format that has a separate limit. + // Your request can fail for this limit even if your plain text meets the other + // requirements. The PackedPolicySize response element indicates by percentage how + // close the policies and tags for your request are to the upper size limit. + Policy *string + // The Amazon Resource Names (ARNs) of the IAM managed policies that you want to // use as a managed session policy. The policies must exist in the same account as // the IAM user that is requesting federated access. You must pass an inline or @@ -209,54 +239,24 @@ type GetFederationTokenInput struct { // tags, and the session tag passed in the request takes precedence over the role // tag.

    Tags []*types.Tag - - // An IAM policy in JSON format that you want to use as an inline session policy. - // You must pass an inline or managed session policy - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) - // to this operation. You can pass a single JSON policy document to use as an - // inline session policy. You can also specify up to 10 managed policies to use as - // managed session policies. This parameter is optional. However, if you do not - // pass any session policies, then the resulting federated user session has no - // permissions. When you pass session policies, the session permissions are the - // intersection of the IAM user policies and the session policies that you pass. - // This gives you a way to further restrict the permissions for a federated user. - // You cannot use session policies to grant more permissions than those that are - // defined in the permissions policy of the IAM user. For more information, see - // Session Policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) - // in the IAM User Guide. The resulting credentials can be used to access a - // resource that has a resource-based policy. If that policy specifically - // references the federated user session in the Principal element of the policy, - // the session has the permissions allowed by the policy. These permissions are - // granted in addition to the permissions that are granted by the session policies. - // The plain text that you use for both inline and managed session policies can't - // exceed 2,048 characters. The JSON policy characters can be any ASCII character - // from the space character to the end of the valid character list (\u0020 through - // \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage - // return (\u000D) characters. An AWS conversion compresses the passed session - // policies and session tags into a packed binary format that has a separate limit. - // Your request can fail for this limit even if your plain text meets the other - // requirements. The PackedPolicySize response element indicates by percentage how - // close the policies and tags for your request are to the upper size limit. - Policy *string } // Contains the response to a successful GetFederationToken () request, including // temporary AWS credentials that can be used to make AWS requests. type GetFederationTokenOutput struct { - // Identifiers for the federated user associated with the credentials (such as - // arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob). You can use - // the federated user's ARN in your resource-based policies, such as an Amazon S3 - // bucket policy. - FederatedUser *types.FederatedUser - // The temporary security credentials, which include an access key ID, a secret // access key, and a security (or session) token. The size of the security token // that STS API operations return is not fixed. We strongly recommend that you make // no assumptions about the maximum size. Credentials *types.Credentials + // Identifiers for the federated user associated with the credentials (such as + // arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob). You can use + // the federated user's ARN in your resource-based policies, such as an Amazon S3 + // bucket policy. + FederatedUser *types.FederatedUser + // A percentage value that indicates the packed size of the session policies and // session tags combined passed in the request. The request fails if the packed // size is greater than 100 percent, which means the policies and tags exceeded the diff --git a/service/sts/api_op_GetSessionToken.go b/service/sts/api_op_GetSessionToken.go index d3245b8888c..813ae874746 100644 --- a/service/sts/api_op_GetSessionToken.go +++ b/service/sts/api_op_GetSessionToken.go @@ -100,15 +100,6 @@ func (c *Client) GetSessionToken(ctx context.Context, params *GetSessionTokenInp type GetSessionTokenInput struct { - // The value provided by the MFA device, if MFA is required. If any policy requires - // the IAM user to submit an MFA code, specify this value. If MFA authentication is - // required, the user must provide a code when requesting a set of temporary - // security credentials. A user who fails to provide the code receives an "access - // denied" response when requesting resources that require MFA authentication. The - // format for this parameter, as described by its regex pattern, is a sequence of - // six numeric digits. - TokenCode *string - // The duration, in seconds, that the credentials should remain valid. Acceptable // durations for IAM user sessions range from 900 seconds (15 minutes) to 129,600 // seconds (36 hours), with 43,200 seconds (12 hours) as the default. Sessions for @@ -128,6 +119,15 @@ type GetSessionTokenInput struct { // with no spaces. You can also include underscores or any of the following // characters: =,.@:/- SerialNumber *string + + // The value provided by the MFA device, if MFA is required. If any policy requires + // the IAM user to submit an MFA code, specify this value. If MFA authentication is + // required, the user must provide a code when requesting a set of temporary + // security credentials. A user who fails to provide the code receives an "access + // denied" response when requesting resources that require MFA authentication. The + // format for this parameter, as described by its regex pattern, is a sequence of + // six numeric digits. + TokenCode *string } // Contains the response to a successful GetSessionToken () request, including diff --git a/service/sts/go.mod b/service/sts/go.mod index dc8e6befed4..6b106b4e7d3 100644 --- a/service/sts/go.mod +++ b/service/sts/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/sts go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/sts/types/types.go b/service/sts/types/types.go index d6808eebe91..bf1bafdd9bc 100644 --- a/service/sts/types/types.go +++ b/service/sts/types/types.go @@ -35,21 +35,21 @@ type Credentials struct { // This member is required. AccessKeyId *string - // The token that users must pass to the service API to use the temporary - // credentials. + // The date on which the current credentials expire. // // This member is required. - SessionToken *string + Expiration *time.Time // The secret access key that can be used to sign requests. // // This member is required. SecretAccessKey *string - // The date on which the current credentials expire. + // The token that users must pass to the service API to use the temporary + // credentials. // // This member is required. - Expiration *time.Time + SessionToken *string } // Identifiers for the federated user that is associated with the credentials. @@ -90,21 +90,21 @@ type PolicyDescriptorType struct { // IAM User Guide. type Tag struct { - // The value for a session tag. You can pass up to 50 session tags. The plain text - // session tag values can’t exceed 256 characters. For these and additional limits, + // The key for a session tag. You can pass up to 50 session tags. The plain text + // session tag keys can’t exceed 128 characters. For these and additional limits, // see IAM and STS Character Limits // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length) // in the IAM User Guide. // // This member is required. - Value *string + Key *string - // The key for a session tag. You can pass up to 50 session tags. The plain text - // session tag keys can’t exceed 128 characters. For these and additional limits, + // The value for a session tag. You can pass up to 50 session tags. The plain text + // session tag values can’t exceed 256 characters. For these and additional limits, // see IAM and STS Character Limits // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length) // in the IAM User Guide. // // This member is required. - Key *string + Value *string } diff --git a/service/support/api_op_AddCommunicationToCase.go b/service/support/api_op_AddCommunicationToCase.go index 621cb3805b1..1e7a3242b62 100644 --- a/service/support/api_op_AddCommunicationToCase.go +++ b/service/support/api_op_AddCommunicationToCase.go @@ -66,22 +66,22 @@ func (c *Client) AddCommunicationToCase(ctx context.Context, params *AddCommunic type AddCommunicationToCaseInput struct { - // The email addresses in the CC line of an email to be added to the support case. - CcEmailAddresses []*string - - // The ID of a set of one or more attachments for the communication to add to the - // case. Create the set by calling AddAttachmentsToSet () - AttachmentSetId *string - // The body of an email communication to add to the support case. // // This member is required. CommunicationBody *string + // The ID of a set of one or more attachments for the communication to add to the + // case. Create the set by calling AddAttachmentsToSet () + AttachmentSetId *string + // The AWS Support case ID requested or returned in the call. The case ID is an // alphanumeric string formatted as shown in this example: // case-12345678910-2013-c4c1d2bf33c5cf47 CaseId *string + + // The email addresses in the CC line of an email to be added to the support case. + CcEmailAddresses []*string } // The result of the AddCommunicationToCase () operation. diff --git a/service/support/api_op_CreateCase.go b/service/support/api_op_CreateCase.go index 9553e4e3352..c7976c310c3 100644 --- a/service/support/api_op_CreateCase.go +++ b/service/support/api_op_CreateCase.go @@ -86,56 +86,56 @@ func (c *Client) CreateCase(ctx context.Context, params *CreateCaseInput, optFns type CreateCaseInput struct { - // A value that indicates the urgency of the case. This value determines the - // response time according to your service level agreement with AWS Support. You - // can use the DescribeSeverityLevels () operation to get the possible values for - // severityCode. For more information, see SeverityLevel () and Choosing a Severity - // (https://docs.aws.amazon.com/awssupport/latest/user/getting-started.html#choosing-severity) - // in the AWS Support User Guide. The availability of severity levels depends on - // the support plan for the AWS account. - SeverityCode *string + // The communication body text that describes the issue. This text appears in the + // Description field on the AWS Support Center Create Case + // (https://console.aws.amazon.com/support/home#/case/create) page. + // + // This member is required. + CommunicationBody *string + + // The title of the AWS Support case. The title appears in the Subject field on the + // AWS Support Center Create Case + // (https://console.aws.amazon.com/support/home#/case/create) page. + // + // This member is required. + Subject *string + + // The ID of a set of one or more attachments for the case. Create the set by using + // the AddAttachmentsToSet () operation. + AttachmentSetId *string // The category of problem for the AWS Support case. You also use the // DescribeServices () operation to get the category code for a service. Each AWS // service defines its own set of category codes. CategoryCode *string - // The code for the AWS service. You can use the DescribeServices () operation to - // get the possible serviceCode values. - ServiceCode *string - - // The type of issue for the case. You can specify customer-service or technical. - // If you don't specify a value, the default is technical. - IssueType *string - // A list of email addresses that AWS Support copies on case correspondence. AWS // Support identifies the account that creates the case when you specify your AWS // credentials in an HTTP POST method or use the AWS SDKs // (http://aws.amazon.com/tools/). CcEmailAddresses []*string - // The title of the AWS Support case. The title appears in the Subject field on the - // AWS Support Center Create Case - // (https://console.aws.amazon.com/support/home#/case/create) page. - // - // This member is required. - Subject *string - - // The communication body text that describes the issue. This text appears in the - // Description field on the AWS Support Center Create Case - // (https://console.aws.amazon.com/support/home#/case/create) page. - // - // This member is required. - CommunicationBody *string + // The type of issue for the case. You can specify customer-service or technical. + // If you don't specify a value, the default is technical. + IssueType *string // The language in which AWS Support handles the case. You must specify the ISO // 639-1 code for the language parameter if you want support in that language. // Currently, English ("en") and Japanese ("ja") are supported. Language *string - // The ID of a set of one or more attachments for the case. Create the set by using - // the AddAttachmentsToSet () operation. - AttachmentSetId *string + // The code for the AWS service. You can use the DescribeServices () operation to + // get the possible serviceCode values. + ServiceCode *string + + // A value that indicates the urgency of the case. This value determines the + // response time according to your service level agreement with AWS Support. You + // can use the DescribeSeverityLevels () operation to get the possible values for + // severityCode. For more information, see SeverityLevel () and Choosing a Severity + // (https://docs.aws.amazon.com/awssupport/latest/user/getting-started.html#choosing-severity) + // in the AWS Support User Guide. The availability of severity levels depends on + // the support plan for the AWS account. + SeverityCode *string } // The AWS Support case ID returned by a successful completion of the CreateCase () diff --git a/service/support/api_op_DescribeCases.go b/service/support/api_op_DescribeCases.go index 9c05814405e..767af1817c9 100644 --- a/service/support/api_op_DescribeCases.go +++ b/service/support/api_op_DescribeCases.go @@ -80,24 +80,18 @@ func (c *Client) DescribeCases(ctx context.Context, params *DescribeCasesInput, type DescribeCasesInput struct { - // Specifies whether to include resolved support cases in the DescribeCases - // response. By default, resolved cases aren't included. - IncludeResolvedCases *bool - - // A list of ID numbers of the support cases you want returned. The maximum number - // of cases is 100. - CaseIdList []*string - - // A resumption point for pagination. - NextToken *string - - // The maximum number of results to return before paginating. - MaxResults *int32 + // The start date for a filtered date search on support case communications. Case + // communications are available for 12 months after creation. + AfterTime *string // The end date for a filtered date search on support case communications. Case // communications are available for 12 months after creation. BeforeTime *string + // A list of ID numbers of the support cases you want returned. The maximum number + // of cases is 100. + CaseIdList []*string + // The ID displayed for a case in the AWS Support Center user interface. DisplayId *string @@ -105,14 +99,20 @@ type DescribeCasesInput struct { // default, communications are incuded. IncludeCommunications *bool - // The start date for a filtered date search on support case communications. Case - // communications are available for 12 months after creation. - AfterTime *string + // Specifies whether to include resolved support cases in the DescribeCases + // response. By default, resolved cases aren't included. + IncludeResolvedCases *bool // The ISO 639-1 code for the language in which AWS provides support. AWS Support // currently supports English ("en") and Japanese ("ja"). Language parameters must // be passed explicitly for operations that take them. Language *string + + // The maximum number of results to return before paginating. + MaxResults *int32 + + // A resumption point for pagination. + NextToken *string } // Returns an array of CaseDetails diff --git a/service/support/api_op_DescribeCommunications.go b/service/support/api_op_DescribeCommunications.go index ca2a012475d..4b803c5a816 100644 --- a/service/support/api_op_DescribeCommunications.go +++ b/service/support/api_op_DescribeCommunications.go @@ -80,9 +80,6 @@ type DescribeCommunicationsInput struct { // This member is required. CaseId *string - // The maximum number of results to return before paginating. - MaxResults *int32 - // The start date for a filtered date search on support case communications. Case // communications are available for 12 months after creation. AfterTime *string @@ -91,6 +88,9 @@ type DescribeCommunicationsInput struct { // communications are available for 12 months after creation. BeforeTime *string + // The maximum number of results to return before paginating. + MaxResults *int32 + // A resumption point for pagination. NextToken *string } diff --git a/service/support/api_op_ResolveCase.go b/service/support/api_op_ResolveCase.go index b4cee30e8e7..af48a3e97c7 100644 --- a/service/support/api_op_ResolveCase.go +++ b/service/support/api_op_ResolveCase.go @@ -74,12 +74,12 @@ type ResolveCaseInput struct { // The status of the case returned by the ResolveCase () operation. type ResolveCaseOutput struct { - // The status of the case when the ResolveCase () request was sent. - InitialCaseStatus *string - // The status of the case after the ResolveCase () request was processed. FinalCaseStatus *string + // The status of the case when the ResolveCase () request was sent. + InitialCaseStatus *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/support/go.mod b/service/support/go.mod index e838eaaeb81..4466b0787fa 100644 --- a/service/support/go.mod +++ b/service/support/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/support go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/support/types/types.go b/service/support/types/types.go index f885ce2758c..869b5051e47 100644 --- a/service/support/types/types.go +++ b/service/support/types/types.go @@ -6,22 +6,22 @@ package types // and the content of the file. type Attachment struct { - // The name of the attachment file. - FileName *string - // The content of the attachment file. Data []byte + + // The name of the attachment file. + FileName *string } // The file name and ID of an attachment to a case communication. You can use the // ID to retrieve the attachment with the DescribeAttachment () operation. type AttachmentDetails struct { - // The file name of the attachment. - FileName *string - // The ID of the attachment. AttachmentId *string + + // The file name of the attachment. + FileName *string } // A JSON-formatted object that contains the metadata for a support case. It is @@ -86,9 +86,39 @@ type AttachmentDetails struct { // ISO-8601 format. type CaseDetails struct { + // The AWS Support case ID requested or returned in the call. The case ID is an + // alphanumeric string formatted as shown in this example: + // case-12345678910-2013-c4c1d2bf33c5cf47 + CaseId *string + + // The category of problem for the AWS Support case. + CategoryCode *string + // The email addresses that receive copies of communication about the case. CcEmailAddresses []*string + // The ID displayed for the case in the AWS Support Center. This is a numeric + // string. + DisplayId *string + + // The ISO 639-1 code for the language in which AWS provides support. AWS Support + // currently supports English ("en") and Japanese ("ja"). Language parameters must + // be passed explicitly for operations that take them. + Language *string + + // The five most recent communications between you and AWS Support Center, + // including the IDs of any attachments to the communications. Also includes a + // nextToken that you can use to retrieve earlier communications. + RecentCommunications *RecentCaseCommunications + + // The code for the AWS service. You can get a list of codes and the corresponding + // service names by calling DescribeServices (). + ServiceCode *string + + // The code for the severity level returned by the call to DescribeSeverityLevels + // (). + SeverityCode *string + // The status of the case. Valid values: // // * opened @@ -106,44 +136,14 @@ type CaseDetails struct { // work-in-progress Status *string - // The code for the AWS service. You can get a list of codes and the corresponding - // service names by calling DescribeServices (). - ServiceCode *string - - // The category of problem for the AWS Support case. - CategoryCode *string - - // The time that the case was created in the AWS Support Center. - TimeCreated *string - - // The code for the severity level returned by the call to DescribeSeverityLevels - // (). - SeverityCode *string - - // The ISO 639-1 code for the language in which AWS provides support. AWS Support - // currently supports English ("en") and Japanese ("ja"). Language parameters must - // be passed explicitly for operations that take them. - Language *string - - // The AWS Support case ID requested or returned in the call. The case ID is an - // alphanumeric string formatted as shown in this example: - // case-12345678910-2013-c4c1d2bf33c5cf47 - CaseId *string + // The subject line for the case in the AWS Support Center. + Subject *string // The email address of the account that submitted the case. SubmittedBy *string - // The five most recent communications between you and AWS Support Center, - // including the IDs of any attachments to the communications. Also includes a - // nextToken that you can use to retrieve earlier communications. - RecentCommunications *RecentCaseCommunications - - // The subject line for the case in the AWS Support Center. - Subject *string - - // The ID displayed for the case in the AWS Support Center. This is a numeric - // string. - DisplayId *string + // The time that the case was created in the AWS Support Center. + TimeCreated *string } // A JSON-formatted name/value pair that represents the category name and category @@ -151,11 +151,11 @@ type CaseDetails struct { // service. type Category struct { - // The category name for the support case. - Name *string - // The category code for the support case. Code *string + + // The category name for the support case. + Name *string } // A communication associated with an AWS Support case. The communication consists @@ -166,32 +166,32 @@ type Communication struct { // Information about the attachments to the case communication. AttachmentSet []*AttachmentDetails - // The time the communication was created. - TimeCreated *string - // The text of the communication between the customer and AWS Support. Body *string + // The AWS Support case ID requested or returned in the call. The case ID is an + // alphanumeric string formatted as shown in this example: + // case-12345678910-2013-c4c1d2bf33c5cf47 + CaseId *string + // The identity of the account that submitted, or responded to, the support case. // Customer entries include the role or IAM user as well as the email address. For // example, "AdminRole (Role) . Entries from the AWS Support team display "Amazon // Web Services," and do not show an email address. SubmittedBy *string - // The AWS Support case ID requested or returned in the call. The case ID is an - // alphanumeric string formatted as shown in this example: - // case-12345678910-2013-c4c1d2bf33c5cf47 - CaseId *string + // The time the communication was created. + TimeCreated *string } // The five most recent communications associated with the case. type RecentCaseCommunications struct { - // A resumption point for pagination. - NextToken *string - // The five most recent communications associated with the case. Communications []*Communication + + // A resumption point for pagination. + NextToken *string } // Information about an AWS service returned by the DescribeServices () operation. @@ -218,6 +218,10 @@ type Service struct { // in the AWS Support User Guide. type SeverityLevel struct { + // The code for case severity level. Valid values: low | normal | high | urgent | + // critical + Code *string + // The name of the severity level that corresponds to the severity level code. The // values returned by the API differ from the values that are displayed in the AWS // Support Center. For example, for the code "low", the API name is "Low", but the @@ -241,10 +245,6 @@ type SeverityLevel struct { // (https://docs.aws.amazon.com/awssupport/latest/user/case-management.html#choosing-severity) // in the AWS Support User Guide. Name *string - - // The code for case severity level. Valid values: low | normal | high | urgent | - // critical - Code *string } // The container for summary information that relates to the category of the @@ -259,10 +259,10 @@ type TrustedAdvisorCategorySpecificSummary struct { // The description and metadata for a Trusted Advisor check. type TrustedAdvisorCheckDescription struct { - // The display name for the Trusted Advisor check. + // The category of the Trusted Advisor check. // // This member is required. - Name *string + Category *string // The description of the Trusted Advisor check, which includes the alert criteria // and recommended operations (contains HTML markup). @@ -270,11 +270,6 @@ type TrustedAdvisorCheckDescription struct { // This member is required. Description *string - // The category of the Trusted Advisor check. - // - // This member is required. - Category *string - // The unique identifier for the Trusted Advisor check. // // This member is required. @@ -288,11 +283,21 @@ type TrustedAdvisorCheckDescription struct { // // This member is required. Metadata []*string + + // The display name for the Trusted Advisor check. + // + // This member is required. + Name *string } // The refresh status of a Trusted Advisor check. type TrustedAdvisorCheckRefreshStatus struct { + // The unique identifier for the Trusted Advisor check. + // + // This member is required. + CheckId *string + // The amount of time, in milliseconds, until the Trusted Advisor check is eligible // for refresh. // @@ -318,65 +323,60 @@ type TrustedAdvisorCheckRefreshStatus struct { // // This member is required. Status *string - - // The unique identifier for the Trusted Advisor check. - // - // This member is required. - CheckId *string } // The results of a Trusted Advisor check returned by // DescribeTrustedAdvisorCheckResult (). type TrustedAdvisorCheckResult struct { - // The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), - // or "not_available". + // Summary information that relates to the category of the check. Cost Optimizing + // is the only category that is currently supported. // // This member is required. - Status *string + CategorySpecificSummary *TrustedAdvisorCategorySpecificSummary - // Details about AWS resources that were analyzed in a call to Trusted Advisor - // DescribeTrustedAdvisorCheckSummaries (). + // The unique identifier for the Trusted Advisor check. // // This member is required. - ResourcesSummary *TrustedAdvisorResourcesSummary + CheckId *string - // The time of the last refresh of the check. + // The details about each resource listed in the check result. // // This member is required. - Timestamp *string + FlaggedResources []*TrustedAdvisorResourceDetail - // The details about each resource listed in the check result. + // Details about AWS resources that were analyzed in a call to Trusted Advisor + // DescribeTrustedAdvisorCheckSummaries (). // // This member is required. - FlaggedResources []*TrustedAdvisorResourceDetail + ResourcesSummary *TrustedAdvisorResourcesSummary - // Summary information that relates to the category of the check. Cost Optimizing - // is the only category that is currently supported. + // The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), + // or "not_available". // // This member is required. - CategorySpecificSummary *TrustedAdvisorCategorySpecificSummary + Status *string - // The unique identifier for the Trusted Advisor check. + // The time of the last refresh of the check. // // This member is required. - CheckId *string + Timestamp *string } // A summary of a Trusted Advisor check result, including the alert status, last // refresh, and number of resources examined. type TrustedAdvisorCheckSummary struct { - // The unique identifier for the Trusted Advisor check. + // Summary information that relates to the category of the check. Cost Optimizing + // is the only category that is currently supported. // // This member is required. - CheckId *string + CategorySpecificSummary *TrustedAdvisorCategorySpecificSummary - // The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), - // or "not_available". + // The unique identifier for the Trusted Advisor check. // // This member is required. - Status *string + CheckId *string // Details about AWS resources that were analyzed in a call to Trusted Advisor // DescribeTrustedAdvisorCheckSummaries (). @@ -384,11 +384,11 @@ type TrustedAdvisorCheckSummary struct { // This member is required. ResourcesSummary *TrustedAdvisorResourcesSummary - // Summary information that relates to the category of the check. Cost Optimizing - // is the only category that is currently supported. + // The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), + // or "not_available". // // This member is required. - CategorySpecificSummary *TrustedAdvisorCategorySpecificSummary + Status *string // The time of the last refresh of the check. // @@ -419,47 +419,42 @@ type TrustedAdvisorCostOptimizingSummary struct { // Contains information about a resource identified by a Trusted Advisor check. type TrustedAdvisorResourceDetail struct { - // The AWS region in which the identified resource is located. - Region *string + // Additional information about the identified resource. The exact metadata and its + // order can be obtained by inspecting the TrustedAdvisorCheckDescription () object + // returned by the call to DescribeTrustedAdvisorChecks (). Metadata contains all + // the data that is shown in the Excel download, even in those cases where the UI + // shows just summary data. + // + // This member is required. + Metadata []*string // The unique identifier for the identified resource. // // This member is required. ResourceId *string - // Specifies whether the AWS resource was ignored by Trusted Advisor because it was - // marked as suppressed by the user. - IsSuppressed *bool - // The status code for the resource identified in the Trusted Advisor check. // // This member is required. Status *string - // Additional information about the identified resource. The exact metadata and its - // order can be obtained by inspecting the TrustedAdvisorCheckDescription () object - // returned by the call to DescribeTrustedAdvisorChecks (). Metadata contains all - // the data that is shown in the Excel download, even in those cases where the UI - // shows just summary data. - // - // This member is required. - Metadata []*string + // Specifies whether the AWS resource was ignored by Trusted Advisor because it was + // marked as suppressed by the user. + IsSuppressed *bool + + // The AWS region in which the identified resource is located. + Region *string } // Details about AWS resources that were analyzed in a call to Trusted Advisor // DescribeTrustedAdvisorCheckSummaries (). type TrustedAdvisorResourcesSummary struct { - // The number of AWS resources ignored by Trusted Advisor because they were marked - // as suppressed by the user. - // - // This member is required. - ResourcesSuppressed *int64 - - // The number of AWS resources that were analyzed by the Trusted Advisor check. + // The number of AWS resources that were flagged (listed) by the Trusted Advisor + // check. // // This member is required. - ResourcesProcessed *int64 + ResourcesFlagged *int64 // The number of AWS resources ignored by Trusted Advisor because information was // unavailable. @@ -467,9 +462,14 @@ type TrustedAdvisorResourcesSummary struct { // This member is required. ResourcesIgnored *int64 - // The number of AWS resources that were flagged (listed) by the Trusted Advisor - // check. + // The number of AWS resources that were analyzed by the Trusted Advisor check. // // This member is required. - ResourcesFlagged *int64 + ResourcesProcessed *int64 + + // The number of AWS resources ignored by Trusted Advisor because they were marked + // as suppressed by the user. + // + // This member is required. + ResourcesSuppressed *int64 } diff --git a/service/swf/api_op_CountClosedWorkflowExecutions.go b/service/swf/api_op_CountClosedWorkflowExecutions.go index 48ee2df2d94..aca0a22a3a9 100644 --- a/service/swf/api_op_CountClosedWorkflowExecutions.go +++ b/service/swf/api_op_CountClosedWorkflowExecutions.go @@ -88,56 +88,56 @@ func (c *Client) CountClosedWorkflowExecutions(ctx context.Context, params *Coun type CountClosedWorkflowExecutionsInput struct { - // If specified, only workflow executions that meet the start time criteria of the - // filter are counted. startTimeFilter and closeTimeFilter are mutually exclusive. - // You must specify one of these in a request but not both. - StartTimeFilter *types.ExecutionTimeFilter - // The name of the domain containing the workflow executions to count. // // This member is required. Domain *string - // If specified, only workflow executions matching the WorkflowId in the filter are - // counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are - // mutually exclusive. You can specify at most one of these in a request. - ExecutionFilter *types.WorkflowExecutionFilter - - // If specified, indicates the type of the workflow executions to be counted. + // If specified, only workflow executions that match this close status are counted. + // This filter has an affect only if executionStatus is specified as CLOSED. // closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually // exclusive. You can specify at most one of these in a request. - TypeFilter *types.WorkflowTypeFilter + CloseStatusFilter *types.CloseStatusFilter // If specified, only workflow executions that meet the close time criteria of the // filter are counted. startTimeFilter and closeTimeFilter are mutually exclusive. // You must specify one of these in a request but not both. CloseTimeFilter *types.ExecutionTimeFilter + // If specified, only workflow executions matching the WorkflowId in the filter are + // counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are + // mutually exclusive. You can specify at most one of these in a request. + ExecutionFilter *types.WorkflowExecutionFilter + + // If specified, only workflow executions that meet the start time criteria of the + // filter are counted. startTimeFilter and closeTimeFilter are mutually exclusive. + // You must specify one of these in a request but not both. + StartTimeFilter *types.ExecutionTimeFilter + // If specified, only executions that have a tag that matches the filter are // counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are // mutually exclusive. You can specify at most one of these in a request. TagFilter *types.TagFilter - // If specified, only workflow executions that match this close status are counted. - // This filter has an affect only if executionStatus is specified as CLOSED. + // If specified, indicates the type of the workflow executions to be counted. // closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually // exclusive. You can specify at most one of these in a request. - CloseStatusFilter *types.CloseStatusFilter + TypeFilter *types.WorkflowTypeFilter } // Contains the count of workflow executions returned from // CountOpenWorkflowExecutions () or CountClosedWorkflowExecutions () type CountClosedWorkflowExecutionsOutput struct { - // If set to true, indicates that the actual count was more than the maximum - // supported by this API and the count returned is the truncated value. - Truncated *bool - // The number of workflow executions. // // This member is required. Count *int32 + // If set to true, indicates that the actual count was more than the maximum + // supported by this API and the count returned is the truncated value. + Truncated *bool + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/swf/api_op_CountOpenWorkflowExecutions.go b/service/swf/api_op_CountOpenWorkflowExecutions.go index 083b4b9b8c5..04d763f6a8c 100644 --- a/service/swf/api_op_CountOpenWorkflowExecutions.go +++ b/service/swf/api_op_CountOpenWorkflowExecutions.go @@ -88,10 +88,10 @@ func (c *Client) CountOpenWorkflowExecutions(ctx context.Context, params *CountO type CountOpenWorkflowExecutionsInput struct { - // If specified, only workflow executions matching the WorkflowId in the filter are - // counted. executionFilter, typeFilter and tagFilter are mutually exclusive. You - // can specify at most one of these in a request. - ExecutionFilter *types.WorkflowExecutionFilter + // The name of the domain containing the workflow executions to count. + // + // This member is required. + Domain *string // Specifies the start time criteria that workflow executions must meet in order to // be counted. @@ -99,10 +99,10 @@ type CountOpenWorkflowExecutionsInput struct { // This member is required. StartTimeFilter *types.ExecutionTimeFilter - // The name of the domain containing the workflow executions to count. - // - // This member is required. - Domain *string + // If specified, only workflow executions matching the WorkflowId in the filter are + // counted. executionFilter, typeFilter and tagFilter are mutually exclusive. You + // can specify at most one of these in a request. + ExecutionFilter *types.WorkflowExecutionFilter // If specified, only executions that have a tag that matches the filter are // counted. executionFilter, typeFilter and tagFilter are mutually exclusive. You @@ -119,15 +119,15 @@ type CountOpenWorkflowExecutionsInput struct { // CountOpenWorkflowExecutions () or CountClosedWorkflowExecutions () type CountOpenWorkflowExecutionsOutput struct { - // If set to true, indicates that the actual count was more than the maximum - // supported by this API and the count returned is the truncated value. - Truncated *bool - // The number of workflow executions. // // This member is required. Count *int32 + // If set to true, indicates that the actual count was more than the maximum + // supported by this API and the count returned is the truncated value. + Truncated *bool + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/swf/api_op_CountPendingActivityTasks.go b/service/swf/api_op_CountPendingActivityTasks.go index ddd4a43fddb..f8de70aad54 100644 --- a/service/swf/api_op_CountPendingActivityTasks.go +++ b/service/swf/api_op_CountPendingActivityTasks.go @@ -80,29 +80,29 @@ func (c *Client) CountPendingActivityTasks(ctx context.Context, params *CountPen type CountPendingActivityTasksInput struct { - // The name of the task list. + // The name of the domain that contains the task list. // // This member is required. - TaskList *types.TaskList + Domain *string - // The name of the domain that contains the task list. + // The name of the task list. // // This member is required. - Domain *string + TaskList *types.TaskList } // Contains the count of tasks in a task list. type CountPendingActivityTasksOutput struct { - // If set to true, indicates that the actual count was more than the maximum - // supported by this API and the count returned is the truncated value. - Truncated *bool - // The number of tasks in the task list. // // This member is required. Count *int32 + // If set to true, indicates that the actual count was more than the maximum + // supported by this API and the count returned is the truncated value. + Truncated *bool + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/swf/api_op_CountPendingDecisionTasks.go b/service/swf/api_op_CountPendingDecisionTasks.go index 145a69224a5..0459f784c15 100644 --- a/service/swf/api_op_CountPendingDecisionTasks.go +++ b/service/swf/api_op_CountPendingDecisionTasks.go @@ -94,15 +94,15 @@ type CountPendingDecisionTasksInput struct { // Contains the count of tasks in a task list. type CountPendingDecisionTasksOutput struct { - // If set to true, indicates that the actual count was more than the maximum - // supported by this API and the count returned is the truncated value. - Truncated *bool - // The number of tasks in the task list. // // This member is required. Count *int32 + // If set to true, indicates that the actual count was more than the maximum + // supported by this API and the count returned is the truncated value. + Truncated *bool + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/swf/api_op_DescribeActivityType.go b/service/swf/api_op_DescribeActivityType.go index d1c2191be83..ad5def7c303 100644 --- a/service/swf/api_op_DescribeActivityType.go +++ b/service/swf/api_op_DescribeActivityType.go @@ -84,21 +84,26 @@ func (c *Client) DescribeActivityType(ctx context.Context, params *DescribeActiv type DescribeActivityTypeInput struct { - // The name of the domain in which the activity type is registered. - // - // This member is required. - Domain *string - // The activity type to get information about. Activity types are identified by the // name and version that were supplied when the activity was registered. // // This member is required. ActivityType *types.ActivityType + + // The name of the domain in which the activity type is registered. + // + // This member is required. + Domain *string } // Detailed information about an activity type. type DescribeActivityTypeOutput struct { + // The configuration settings registered with the activity type. + // + // This member is required. + Configuration *types.ActivityTypeConfiguration + // General information about the activity type. The status of activity type // (returned in the ActivityTypeInfo structure) can be one of the following. // @@ -113,11 +118,6 @@ type DescribeActivityTypeOutput struct { // This member is required. TypeInfo *types.ActivityTypeInfo - // The configuration settings registered with the activity type. - // - // This member is required. - Configuration *types.ActivityTypeConfiguration - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/swf/api_op_DescribeDomain.go b/service/swf/api_op_DescribeDomain.go index dda1b5285d0..9f1cefa2cc6 100644 --- a/service/swf/api_op_DescribeDomain.go +++ b/service/swf/api_op_DescribeDomain.go @@ -85,17 +85,17 @@ type DescribeDomainInput struct { // Contains details of a domain. type DescribeDomainOutput struct { - // The basic information about a domain, such as its name, status, and description. - // - // This member is required. - DomainInfo *types.DomainInfo - // The domain configuration. Currently, this includes only the domain's retention // period. // // This member is required. Configuration *types.DomainConfiguration + // The basic information about a domain, such as its name, status, and description. + // + // This member is required. + DomainInfo *types.DomainInfo + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/swf/api_op_DescribeWorkflowExecution.go b/service/swf/api_op_DescribeWorkflowExecution.go index 78d06b41234..f291aa9a5e0 100644 --- a/service/swf/api_op_DescribeWorkflowExecution.go +++ b/service/swf/api_op_DescribeWorkflowExecution.go @@ -79,15 +79,15 @@ func (c *Client) DescribeWorkflowExecution(ctx context.Context, params *Describe type DescribeWorkflowExecutionInput struct { - // The workflow execution to describe. + // The name of the domain containing the workflow execution. // // This member is required. - Execution *types.WorkflowExecution + Domain *string - // The name of the domain containing the workflow execution. + // The workflow execution to describe. // // This member is required. - Domain *string + Execution *types.WorkflowExecution } // Contains details about a workflow execution. @@ -99,11 +99,6 @@ type DescribeWorkflowExecutionOutput struct { // This member is required. ExecutionConfiguration *types.WorkflowExecutionConfiguration - // The time when the last activity task was scheduled for this workflow execution. - // You can use this information to determine if the workflow has not made progress - // for an unusually long period of time and might require a corrective action. - LatestActivityTaskTimestamp *time.Time - // Information about the workflow execution. // // This member is required. @@ -115,6 +110,11 @@ type DescribeWorkflowExecutionOutput struct { // This member is required. OpenCounts *types.WorkflowExecutionOpenCounts + // The time when the last activity task was scheduled for this workflow execution. + // You can use this information to determine if the workflow has not made progress + // for an unusually long period of time and might require a corrective action. + LatestActivityTaskTimestamp *time.Time + // The latest executionContext provided by the decider for this workflow execution. // A decider can provide an executionContext (a free-form string) when closing a // decision task using RespondDecisionTaskCompleted (). diff --git a/service/swf/api_op_GetWorkflowExecutionHistory.go b/service/swf/api_op_GetWorkflowExecutionHistory.go index b17d88d0ea2..e5230315e5f 100644 --- a/service/swf/api_op_GetWorkflowExecutionHistory.go +++ b/service/swf/api_op_GetWorkflowExecutionHistory.go @@ -80,15 +80,20 @@ func (c *Client) GetWorkflowExecutionHistory(ctx context.Context, params *GetWor type GetWorkflowExecutionHistoryInput struct { - // When set to true, returns the events in reverse order. By default the results - // are returned in ascending order of the eventTimeStamp of the events. - ReverseOrder *bool - // The name of the domain containing the workflow execution. // // This member is required. Domain *string + // Specifies the workflow execution for which to return the history. + // + // This member is required. + Execution *types.WorkflowExecution + + // The maximum number of results that are returned per call. Use nextPageToken to + // obtain further pages of results. + MaximumPageSize *int32 + // If NextPageToken is returned there are more results available. The value of // NextPageToken is a unique pagination token for each page. Make the call again // using the returned token to retrieve the next page. Keep all other arguments @@ -98,14 +103,9 @@ type GetWorkflowExecutionHistoryInput struct { // how many results can be returned in a single call.

    NextPageToken *string - // Specifies the workflow execution for which to return the history. - // - // This member is required. - Execution *types.WorkflowExecution - - // The maximum number of results that are returned per call. Use nextPageToken to - // obtain further pages of results. - MaximumPageSize *int32 + // When set to true, returns the events in reverse order. By default the results + // are returned in ascending order of the eventTimeStamp of the events. + ReverseOrder *bool } // Paginated representation of a workflow history for a workflow execution. This is diff --git a/service/swf/api_op_ListActivityTypes.go b/service/swf/api_op_ListActivityTypes.go index c550748565c..6bfdc0a1864 100644 --- a/service/swf/api_op_ListActivityTypes.go +++ b/service/swf/api_op_ListActivityTypes.go @@ -80,6 +80,20 @@ func (c *Client) ListActivityTypes(ctx context.Context, params *ListActivityType type ListActivityTypesInput struct { + // The name of the domain in which the activity types have been registered. + // + // This member is required. + Domain *string + + // Specifies the registration status of the activity types to list. + // + // This member is required. + RegistrationStatus types.RegistrationStatus + + // The maximum number of results that are returned per call. Use nextPageToken to + // obtain further pages of results. + MaximumPageSize *int32 + // If specified, only lists the activity types that have this name. Name *string @@ -92,28 +106,19 @@ type ListActivityTypesInput struct { // how many results can be returned in a single call.

    NextPageToken *string - // Specifies the registration status of the activity types to list. - // - // This member is required. - RegistrationStatus types.RegistrationStatus - // When set to true, returns the results in reverse order. By default, the results // are returned in ascending alphabetical order by name of the activity types. ReverseOrder *bool - - // The maximum number of results that are returned per call. Use nextPageToken to - // obtain further pages of results. - MaximumPageSize *int32 - - // The name of the domain in which the activity types have been registered. - // - // This member is required. - Domain *string } // Contains a paginated list of activity type information structures. type ListActivityTypesOutput struct { + // List of activity type information. + // + // This member is required. + TypeInfos []*types.ActivityTypeInfo + // If a NextPageToken was returned by a previous call, there are more results // available. To retrieve the next page of results, make the call again using the // returned token in nextPageToken. Keep all other arguments unchanged. The @@ -121,11 +126,6 @@ type ListActivityTypesOutput struct { // single call. NextPageToken *string - // List of activity type information. - // - // This member is required. - TypeInfos []*types.ActivityTypeInfo - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/swf/api_op_ListClosedWorkflowExecutions.go b/service/swf/api_op_ListClosedWorkflowExecutions.go index 3ff70790b84..dd7f36bf9d4 100644 --- a/service/swf/api_op_ListClosedWorkflowExecutions.go +++ b/service/swf/api_op_ListClosedWorkflowExecutions.go @@ -90,26 +90,10 @@ func (c *Client) ListClosedWorkflowExecutions(ctx context.Context, params *ListC type ListClosedWorkflowExecutionsInput struct { - // If specified, only executions of the type specified in the filter are returned. - // closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually - // exclusive. You can specify at most one of these in a request. - TypeFilter *types.WorkflowTypeFilter - - // If specified, the workflow executions are included in the returned results based - // on whether their close times are within the range specified by this filter. - // Also, if this parameter is specified, the returned results are ordered by their - // close times. startTimeFilter and closeTimeFilter are mutually exclusive. You - // must specify one of these in a request but not both. - CloseTimeFilter *types.ExecutionTimeFilter - - // The maximum number of results that are returned per call. Use nextPageToken to - // obtain further pages of results. - MaximumPageSize *int32 - - // If specified, only executions that have the matching tag are listed. - // closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually - // exclusive. You can specify at most one of these in a request. - TagFilter *types.TagFilter + // The name of the domain that contains the workflow executions to list. + // + // This member is required. + Domain *string // If specified, only workflow executions that match this close status are listed. // For example, if TERMINATED is specified, then only TERMINATED workflow @@ -118,17 +102,12 @@ type ListClosedWorkflowExecutionsInput struct { // request. CloseStatusFilter *types.CloseStatusFilter - // When set to true, returns the results in reverse order. By default the results - // are returned in descending order of the start or the close time of the - // executions. - ReverseOrder *bool - // If specified, the workflow executions are included in the returned results based - // on whether their start times are within the range specified by this filter. + // on whether their close times are within the range specified by this filter. // Also, if this parameter is specified, the returned results are ordered by their - // start times. startTimeFilter and closeTimeFilter are mutually exclusive. You + // close times. startTimeFilter and closeTimeFilter are mutually exclusive. You // must specify one of these in a request but not both. - StartTimeFilter *types.ExecutionTimeFilter + CloseTimeFilter *types.ExecutionTimeFilter // If specified, only workflow executions matching the workflow ID specified in the // filter are returned. closeStatusFilter, executionFilter, typeFilter and @@ -136,10 +115,9 @@ type ListClosedWorkflowExecutionsInput struct { // request. ExecutionFilter *types.WorkflowExecutionFilter - // The name of the domain that contains the workflow executions to list. - // - // This member is required. - Domain *string + // The maximum number of results that are returned per call. Use nextPageToken to + // obtain further pages of results. + MaximumPageSize *int32 // If NextPageToken is returned there are more results available. The value of // NextPageToken is a unique pagination token for each page. Make the call again @@ -149,6 +127,28 @@ type ListClosedWorkflowExecutionsInput struct { // maximum lifetime".

    The configured maximumPageSize determines // how many results can be returned in a single call.

    NextPageToken *string + + // When set to true, returns the results in reverse order. By default the results + // are returned in descending order of the start or the close time of the + // executions. + ReverseOrder *bool + + // If specified, the workflow executions are included in the returned results based + // on whether their start times are within the range specified by this filter. + // Also, if this parameter is specified, the returned results are ordered by their + // start times. startTimeFilter and closeTimeFilter are mutually exclusive. You + // must specify one of these in a request but not both. + StartTimeFilter *types.ExecutionTimeFilter + + // If specified, only executions that have the matching tag are listed. + // closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually + // exclusive. You can specify at most one of these in a request. + TagFilter *types.TagFilter + + // If specified, only executions of the type specified in the filter are returned. + // closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually + // exclusive. You can specify at most one of these in a request. + TypeFilter *types.WorkflowTypeFilter } // Contains a paginated list of information about workflow executions. diff --git a/service/swf/api_op_ListOpenWorkflowExecutions.go b/service/swf/api_op_ListOpenWorkflowExecutions.go index c69da8d587a..ac649d40b05 100644 --- a/service/swf/api_op_ListOpenWorkflowExecutions.go +++ b/service/swf/api_op_ListOpenWorkflowExecutions.go @@ -95,31 +95,21 @@ type ListOpenWorkflowExecutionsInput struct { // This member is required. Domain *string - // When set to true, returns the results in reverse order. By default the results - // are returned in descending order of the start time of the executions. - ReverseOrder *bool - - // If specified, only executions that have the matching tag are listed. - // executionFilter, typeFilter and tagFilter are mutually exclusive. You can - // specify at most one of these in a request. - TagFilter *types.TagFilter - // Workflow executions are included in the returned results based on whether their // start times are within the range specified by this filter. // // This member is required. StartTimeFilter *types.ExecutionTimeFilter - // If specified, only executions of the type specified in the filter are returned. - // executionFilter, typeFilter and tagFilter are mutually exclusive. You can - // specify at most one of these in a request. - TypeFilter *types.WorkflowTypeFilter - // If specified, only workflow executions matching the workflow ID specified in the // filter are returned. executionFilter, typeFilter and tagFilter are mutually // exclusive. You can specify at most one of these in a request. ExecutionFilter *types.WorkflowExecutionFilter + // The maximum number of results that are returned per call. Use nextPageToken to + // obtain further pages of results. + MaximumPageSize *int32 + // If NextPageToken is returned there are more results available. The value of // NextPageToken is a unique pagination token for each page. Make the call again // using the returned token to retrieve the next page. Keep all other arguments @@ -129,9 +119,19 @@ type ListOpenWorkflowExecutionsInput struct { // how many results can be returned in a single call.

    NextPageToken *string - // The maximum number of results that are returned per call. Use nextPageToken to - // obtain further pages of results. - MaximumPageSize *int32 + // When set to true, returns the results in reverse order. By default the results + // are returned in descending order of the start time of the executions. + ReverseOrder *bool + + // If specified, only executions that have the matching tag are listed. + // executionFilter, typeFilter and tagFilter are mutually exclusive. You can + // specify at most one of these in a request. + TagFilter *types.TagFilter + + // If specified, only executions of the type specified in the filter are returned. + // executionFilter, typeFilter and tagFilter are mutually exclusive. You can + // specify at most one of these in a request. + TypeFilter *types.WorkflowTypeFilter } // Contains a paginated list of information about workflow executions. diff --git a/service/swf/api_op_ListWorkflowTypes.go b/service/swf/api_op_ListWorkflowTypes.go index ac2ec2da486..a13f7a06df7 100644 --- a/service/swf/api_op_ListWorkflowTypes.go +++ b/service/swf/api_op_ListWorkflowTypes.go @@ -77,19 +77,22 @@ func (c *Client) ListWorkflowTypes(ctx context.Context, params *ListWorkflowType type ListWorkflowTypesInput struct { - // Specifies the registration status of the workflow types to list. + // The name of the domain in which the workflow types have been registered. // // This member is required. - RegistrationStatus types.RegistrationStatus + Domain *string - // The name of the domain in which the workflow types have been registered. + // Specifies the registration status of the workflow types to list. // // This member is required. - Domain *string + RegistrationStatus types.RegistrationStatus - // When set to true, returns the results in reverse order. By default the results - // are returned in ascending alphabetical order of the name of the workflow types. - ReverseOrder *bool + // The maximum number of results that are returned per call. Use nextPageToken to + // obtain further pages of results. + MaximumPageSize *int32 + + // If specified, lists the workflow type with this name. + Name *string // If NextPageToken is returned there are more results available. The value of // NextPageToken is a unique pagination token for each page. Make the call again @@ -100,12 +103,9 @@ type ListWorkflowTypesInput struct { // how many results can be returned in a single call.

    NextPageToken *string - // The maximum number of results that are returned per call. Use nextPageToken to - // obtain further pages of results. - MaximumPageSize *int32 - - // If specified, lists the workflow type with this name. - Name *string + // When set to true, returns the results in reverse order. By default the results + // are returned in ascending alphabetical order of the name of the workflow types. + ReverseOrder *bool } // Contains a paginated list of information structures about workflow types. diff --git a/service/swf/api_op_PollForActivityTask.go b/service/swf/api_op_PollForActivityTask.go index c8c19c4ff4a..ee215f920b7 100644 --- a/service/swf/api_op_PollForActivityTask.go +++ b/service/swf/api_op_PollForActivityTask.go @@ -114,31 +114,31 @@ type PollForActivityTaskOutput struct { // This member is required. ActivityId *string - // The inputs provided when the activity task was scheduled. The form of the input - // is user defined and should be meaningful to the activity implementation. - Input *string - - // The workflow execution that started this activity task. + // The type of this activity task. // // This member is required. - WorkflowExecution *types.WorkflowExecution + ActivityType *types.ActivityType // The ID of the ActivityTaskStarted event recorded in the history. // // This member is required. StartedEventId *int64 - // The type of this activity task. - // - // This member is required. - ActivityType *types.ActivityType - // The opaque string used as a handle on the task. This token is used by workers to // communicate progress and response information back to the system about the task. // // This member is required. TaskToken *string + // The workflow execution that started this activity task. + // + // This member is required. + WorkflowExecution *types.WorkflowExecution + + // The inputs provided when the activity task was scheduled. The form of the input + // is user defined and should be meaningful to the activity implementation. + Input *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/swf/api_op_PollForDecisionTask.go b/service/swf/api_op_PollForDecisionTask.go index e4e5f47050b..732bb8619f1 100644 --- a/service/swf/api_op_PollForDecisionTask.go +++ b/service/swf/api_op_PollForDecisionTask.go @@ -93,19 +93,29 @@ func (c *Client) PollForDecisionTask(ctx context.Context, params *PollForDecisio type PollForDecisionTaskInput struct { - // When set to true, returns the events in reverse order. By default the results - // are returned in ascending order of the eventTimestamp of the events. - ReverseOrder *bool + // The name of the domain containing the task lists to poll. + // + // This member is required. + Domain *string + + // Specifies the task list to poll for decision tasks.

    The specified string + // must not start or end with whitespace. It must not contain a : + // (colon), / (slash), | (vertical bar), or any control + // characters (\u0000-\u001f | \u007f-\u009f). Also, it + // must not be the literal string arn.

    + // + // This member is required. + TaskList *types.TaskList // Identity of the decider making the request, which is recorded in the // DecisionTaskStarted event in the workflow history. This enables diagnostic // tracing when problems arise. The form of this identity is user defined. Identity *string - // The name of the domain containing the task lists to poll. - // - // This member is required. - Domain *string + // The maximum number of results that are returned per call. Use nextPageToken to + // obtain further pages of results. This is an upper limit only; the actual number + // of results returned per call may be fewer than the specified maximum. + MaximumPageSize *int32 // If NextPageToken is returned there are more results available. The value of // NextPageToken is a unique pagination token for each page. Make the call again @@ -122,35 +132,25 @@ type PollForDecisionTaskInput struct { //     NextPageToken *string - // The maximum number of results that are returned per call. Use nextPageToken to - // obtain further pages of results. This is an upper limit only; the actual number - // of results returned per call may be fewer than the specified maximum. - MaximumPageSize *int32 - - // Specifies the task list to poll for decision tasks.

    The specified string - // must not start or end with whitespace. It must not contain a : - // (colon), / (slash), | (vertical bar), or any control - // characters (\u0000-\u001f | \u007f-\u009f). Also, it - // must not be the literal string arn.

    - // - // This member is required. - TaskList *types.TaskList + // When set to true, returns the events in reverse order. By default the results + // are returned in ascending order of the eventTimestamp of the events. + ReverseOrder *bool } // A structure that represents a decision task. Decision tasks are sent to deciders // in order for them to make decisions. type PollForDecisionTaskOutput struct { - // The ID of the DecisionTaskStarted event of the previous decision task of this - // workflow execution that was processed by the decider. This can be used to - // determine the events in the history new since the last decision task received by - // the decider. - PreviousStartedEventId *int64 + // A paginated list of history events of the workflow execution. The decider uses + // this during the processing of the decision task. + // + // This member is required. + Events []*types.HistoryEvent - // The type of the workflow execution for which this decision task was created. + // The ID of the DecisionTaskStarted event recorded in the history. // // This member is required. - WorkflowType *types.WorkflowType + StartedEventId *int64 // The opaque string used as a handle on the task. This token is used by workers to // communicate progress and response information back to the system about the task. @@ -158,21 +158,15 @@ type PollForDecisionTaskOutput struct { // This member is required. TaskToken *string - // A paginated list of history events of the workflow execution. The decider uses - // this during the processing of the decision task. - // - // This member is required. - Events []*types.HistoryEvent - // The workflow execution for which this decision task was created. // // This member is required. WorkflowExecution *types.WorkflowExecution - // The ID of the DecisionTaskStarted event recorded in the history. + // The type of the workflow execution for which this decision task was created. // // This member is required. - StartedEventId *int64 + WorkflowType *types.WorkflowType // If a NextPageToken was returned by a previous call, there are more results // available. To retrieve the next page of results, make the call again using the @@ -181,6 +175,12 @@ type PollForDecisionTaskOutput struct { // single call. NextPageToken *string + // The ID of the DecisionTaskStarted event of the previous decision task of this + // workflow execution that was processed by the decider. This can be used to + // determine the events in the history new since the last decision task received by + // the decider. + PreviousStartedEventId *int64 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/swf/api_op_RegisterActivityType.go b/service/swf/api_op_RegisterActivityType.go index 5591a3c60ec..bfa61a2f57b 100644 --- a/service/swf/api_op_RegisterActivityType.go +++ b/service/swf/api_op_RegisterActivityType.go @@ -88,6 +88,48 @@ func (c *Client) RegisterActivityType(ctx context.Context, params *RegisterActiv type RegisterActivityTypeInput struct { + // The name of the domain in which this activity is to be registered. + // + // This member is required. + Domain *string + + // The name of the activity type within the domain.

    The specified string must + // not start or end with whitespace. It must not contain a : (colon), + // / (slash), | (vertical bar), or any control characters + // (\u0000-\u001f | \u007f-\u009f). Also, it must not + // be the literal string arn.

    + // + // This member is required. + Name *string + + // The version of the activity type. The activity type consists of the name and + // version, the combination of which must be unique within the domain.

    The + // specified string must not start or end with whitespace. It must not contain a + // : (colon), / (slash), | (vertical bar), + // or any control characters (\u0000-\u001f | + // \u007f-\u009f). Also, it must not be the literal string + // arn.

    + // + // This member is required. + Version *string + + // If set, specifies the default maximum time before which a worker processing a + // task of this type must report progress by calling RecordActivityTaskHeartbeat + // (). If the timeout is exceeded, the activity task is automatically timed out. + // This default can be overridden when scheduling an activity task using the + // ScheduleActivityTaskDecision (). If the activity worker subsequently attempts to + // record a heartbeat or returns a result, the activity worker receives an + // UnknownResource fault. In this case, Amazon SWF no longer considers the activity + // task to be valid; the activity worker should clean up the activity task. The + // duration is specified in seconds, an integer greater than or equal to 0. You can + // use NONE to specify unlimited duration. + DefaultTaskHeartbeatTimeout *string + + // If set, specifies the default task list to use for scheduling tasks of this + // activity type. This default task list is used if a task list isn't provided when + // a task is scheduled through the ScheduleActivityTaskDecision (). + DefaultTaskList *types.TaskList + // The default task priority to assign to the activity type. If not assigned, then // 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE // (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher @@ -97,9 +139,6 @@ type RegisterActivityTypeInput struct { // in the in the Amazon SWF Developer Guide.. DefaultTaskPriority *string - // A textual description of the activity type. - Description *string - // If set, specifies the default maximum duration for a task of this activity type. // This default can be overridden when scheduling an activity task using the // ScheduleActivityTaskDecision (). The duration is specified in seconds, an @@ -107,23 +146,6 @@ type RegisterActivityTypeInput struct { // duration. DefaultTaskScheduleToCloseTimeout *string - // If set, specifies the default task list to use for scheduling tasks of this - // activity type. This default task list is used if a task list isn't provided when - // a task is scheduled through the ScheduleActivityTaskDecision (). - DefaultTaskList *types.TaskList - - // If set, specifies the default maximum duration that a worker can take to process - // tasks of this activity type. This default can be overridden when scheduling an - // activity task using the ScheduleActivityTaskDecision (). The duration is - // specified in seconds, an integer greater than or equal to 0. You can use NONE to - // specify unlimited duration. - DefaultTaskStartToCloseTimeout *string - - // The name of the domain in which this activity is to be registered. - // - // This member is required. - Domain *string - // If set, specifies the default maximum duration that a task of this activity type // can wait before being assigned to a worker. This default can be overridden when // scheduling an activity task using the ScheduleActivityTaskDecision (). The @@ -131,37 +153,15 @@ type RegisterActivityTypeInput struct { // use NONE to specify unlimited duration. DefaultTaskScheduleToStartTimeout *string - // If set, specifies the default maximum time before which a worker processing a - // task of this type must report progress by calling RecordActivityTaskHeartbeat - // (). If the timeout is exceeded, the activity task is automatically timed out. - // This default can be overridden when scheduling an activity task using the - // ScheduleActivityTaskDecision (). If the activity worker subsequently attempts to - // record a heartbeat or returns a result, the activity worker receives an - // UnknownResource fault. In this case, Amazon SWF no longer considers the activity - // task to be valid; the activity worker should clean up the activity task. The - // duration is specified in seconds, an integer greater than or equal to 0. You can - // use NONE to specify unlimited duration. - DefaultTaskHeartbeatTimeout *string - - // The version of the activity type. The activity type consists of the name and - // version, the combination of which must be unique within the domain.

    The - // specified string must not start or end with whitespace. It must not contain a - // : (colon), / (slash), | (vertical bar), - // or any control characters (\u0000-\u001f | - // \u007f-\u009f). Also, it must not be the literal string - // arn.

    - // - // This member is required. - Version *string + // If set, specifies the default maximum duration that a worker can take to process + // tasks of this activity type. This default can be overridden when scheduling an + // activity task using the ScheduleActivityTaskDecision (). The duration is + // specified in seconds, an integer greater than or equal to 0. You can use NONE to + // specify unlimited duration. + DefaultTaskStartToCloseTimeout *string - // The name of the activity type within the domain.

    The specified string must - // not start or end with whitespace. It must not contain a : (colon), - // / (slash), | (vertical bar), or any control characters - // (\u0000-\u001f | \u007f-\u009f). Also, it must not - // be the literal string arn.

    - // - // This member is required. - Name *string + // A textual description of the activity type. + Description *string } type RegisterActivityTypeOutput struct { diff --git a/service/swf/api_op_RegisterDomain.go b/service/swf/api_op_RegisterDomain.go index 45b8b9c18f9..732a1304f71 100644 --- a/service/swf/api_op_RegisterDomain.go +++ b/service/swf/api_op_RegisterDomain.go @@ -76,6 +76,16 @@ func (c *Client) RegisterDomain(ctx context.Context, params *RegisterDomainInput type RegisterDomainInput struct { + // Name of the domain to register. The name must be unique in the region that the + // domain is registered in.

    The specified string must not start or end with + // whitespace. It must not contain a : (colon), / + // (slash), | (vertical bar), or any control characters + // (\u0000-\u001f | \u007f-\u009f). Also, it must not + // be the literal string arn.

    + // + // This member is required. + Name *string + // The duration (in days) that records and histories of workflow executions on the // domain should be kept by the service. After the retention period, the workflow // execution isn't available in the results of visibility calls. If you pass the @@ -89,22 +99,12 @@ type RegisterDomainInput struct { // This member is required. WorkflowExecutionRetentionPeriodInDays *string - // Tags to be added when registering a domain. Tags may only contain unicode - // letters, digits, whitespace, or these symbols: _ . : / = + - @. - Tags []*types.ResourceTag - // A text description of the domain. Description *string - // Name of the domain to register. The name must be unique in the region that the - // domain is registered in.

    The specified string must not start or end with - // whitespace. It must not contain a : (colon), / - // (slash), | (vertical bar), or any control characters - // (\u0000-\u001f | \u007f-\u009f). Also, it must not - // be the literal string arn.

    - // - // This member is required. - Name *string + // Tags to be added when registering a domain. Tags may only contain unicode + // letters, digits, whitespace, or these symbols: _ . : / = + - @. + Tags []*types.ResourceTag } type RegisterDomainOutput struct { diff --git a/service/swf/api_op_RegisterWorkflowType.go b/service/swf/api_op_RegisterWorkflowType.go index d34d0bc04a9..b88ffa0ff67 100644 --- a/service/swf/api_op_RegisterWorkflowType.go +++ b/service/swf/api_op_RegisterWorkflowType.go @@ -89,22 +89,10 @@ func (c *Client) RegisterWorkflowType(ctx context.Context, params *RegisterWorkf type RegisterWorkflowTypeInput struct { - // The default IAM role attached to this workflow type. Executions of this workflow - // type need IAM roles to invoke Lambda functions. If you don't specify an IAM role - // when you start this workflow type, the default Lambda role is attached to the - // execution. For more information, see - // https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html) - // in the Amazon SWF Developer Guide. - DefaultLambdaRole *string - - // If set, specifies the default maximum duration of decision tasks for this - // workflow type. This default can be overridden when starting a workflow execution - // using the StartWorkflowExecution () action or the - // StartChildWorkflowExecutionDecision (). The duration is specified in seconds, an - // integer greater than or equal to 0. You can use NONE to specify unlimited - // duration. - DefaultTaskStartToCloseTimeout *string + // The name of the domain in which to register the workflow type. + // + // This member is required. + Domain *string // The name of the workflow type.

    The specified string must not start or end // with whitespace. It must not contain a : (colon), / @@ -115,8 +103,17 @@ type RegisterWorkflowTypeInput struct { // This member is required. Name *string - // Textual description of the workflow type. - Description *string + // The version of the workflow type. The workflow type consists of the name and + // version, the combination of which must be unique within the domain. To get a + // list of all currently registered workflow types, use the ListWorkflowTypes () + // action.

    The specified string must not start or end with whitespace. It must + // not contain a : (colon), / (slash), | + // (vertical bar), or any control characters (\u0000-\u001f | + // \u007f-\u009f). Also, it must not be the literal string + // arn.

    + // + // This member is required. + Version *string // If set, specifies the default policy to use for the child workflow executions // when a workflow execution of this type is terminated, by calling the @@ -147,22 +144,14 @@ type RegisterWorkflowTypeInput struct { // limit always causes the workflow execution to time out.

    DefaultExecutionStartToCloseTimeout *string - // The version of the workflow type. The workflow type consists of the name and - // version, the combination of which must be unique within the domain. To get a - // list of all currently registered workflow types, use the ListWorkflowTypes () - // action.

    The specified string must not start or end with whitespace. It must - // not contain a : (colon), / (slash), | - // (vertical bar), or any control characters (\u0000-\u001f | - // \u007f-\u009f). Also, it must not be the literal string - // arn.

    - // - // This member is required. - Version *string - - // The name of the domain in which to register the workflow type. - // - // This member is required. - Domain *string + // The default IAM role attached to this workflow type. Executions of this workflow + // type need IAM roles to invoke Lambda functions. If you don't specify an IAM role + // when you start this workflow type, the default Lambda role is attached to the + // execution. For more information, see + // https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html + // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html) + // in the Amazon SWF Developer Guide. + DefaultLambdaRole *string // If set, specifies the default task list to use for scheduling decision tasks for // executions of this workflow type. This default is used only if a task list isn't @@ -178,6 +167,17 @@ type RegisterWorkflowTypeInput struct { // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) // in the Amazon SWF Developer Guide. DefaultTaskPriority *string + + // If set, specifies the default maximum duration of decision tasks for this + // workflow type. This default can be overridden when starting a workflow execution + // using the StartWorkflowExecution () action or the + // StartChildWorkflowExecutionDecision (). The duration is specified in seconds, an + // integer greater than or equal to 0. You can use NONE to specify unlimited + // duration. + DefaultTaskStartToCloseTimeout *string + + // Textual description of the workflow type. + Description *string } type RegisterWorkflowTypeOutput struct { diff --git a/service/swf/api_op_RespondActivityTaskFailed.go b/service/swf/api_op_RespondActivityTaskFailed.go index 4f5546a0a1d..8f5e8e0612e 100644 --- a/service/swf/api_op_RespondActivityTaskFailed.go +++ b/service/swf/api_op_RespondActivityTaskFailed.go @@ -78,9 +78,6 @@ func (c *Client) RespondActivityTaskFailed(ctx context.Context, params *RespondA type RespondActivityTaskFailedInput struct { - // Detailed information about the failure. - Details *string - // The taskToken of the ActivityTask ().

    taskToken is // generated by the service and should be treated as an opaque value. If the task // is passed to another process, its taskToken must also be passed. @@ -90,6 +87,9 @@ type RespondActivityTaskFailedInput struct { // This member is required. TaskToken *string + // Detailed information about the failure. + Details *string + // Description of the error that may assist in diagnostics. Reason *string } diff --git a/service/swf/api_op_RespondDecisionTaskCompleted.go b/service/swf/api_op_RespondDecisionTaskCompleted.go index 6f0fc36d76f..bb48055305e 100644 --- a/service/swf/api_op_RespondDecisionTaskCompleted.go +++ b/service/swf/api_op_RespondDecisionTaskCompleted.go @@ -72,10 +72,6 @@ func (c *Client) RespondDecisionTaskCompleted(ctx context.Context, params *Respo // Input data for a TaskCompleted response to a decision task. type RespondDecisionTaskCompletedInput struct { - // The list of decisions (possibly empty) made by the decider while processing this - // decision task. See the docs for the Decision () structure for details. - Decisions []*types.Decision - // The taskToken from the DecisionTask (). taskToken is generated by the service // and should be treated as an opaque value. If the task is passed to another // process, its taskToken must also be passed. This enables it to provide its @@ -84,6 +80,10 @@ type RespondDecisionTaskCompletedInput struct { // This member is required. TaskToken *string + // The list of decisions (possibly empty) made by the decider while processing this + // decision task. See the docs for the Decision () structure for details. + Decisions []*types.Decision + // User defined context to add to workflow execution. ExecutionContext *string } diff --git a/service/swf/api_op_SignalWorkflowExecution.go b/service/swf/api_op_SignalWorkflowExecution.go index 8d67e5474cb..7ab877a29d7 100644 --- a/service/swf/api_op_SignalWorkflowExecution.go +++ b/service/swf/api_op_SignalWorkflowExecution.go @@ -77,11 +77,6 @@ func (c *Client) SignalWorkflowExecution(ctx context.Context, params *SignalWork type SignalWorkflowExecutionInput struct { - // The workflowId of the workflow execution to signal. - // - // This member is required. - WorkflowId *string - // The name of the domain containing the workflow execution to signal. // // This member is required. @@ -92,6 +87,11 @@ type SignalWorkflowExecutionInput struct { // This member is required. SignalName *string + // The workflowId of the workflow execution to signal. + // + // This member is required. + WorkflowId *string + // Data to attach to the WorkflowExecutionSignaled event in the target workflow // execution's history. Input *string diff --git a/service/swf/api_op_StartWorkflowExecution.go b/service/swf/api_op_StartWorkflowExecution.go index 638011e5cce..6dfc5367a64 100644 --- a/service/swf/api_op_StartWorkflowExecution.go +++ b/service/swf/api_op_StartWorkflowExecution.go @@ -86,44 +86,11 @@ func (c *Client) StartWorkflowExecution(ctx context.Context, params *StartWorkfl type StartWorkflowExecutionInput struct { - // The IAM role to attach to this workflow execution. Executions of this workflow - // type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, - // any attempt to schedule a Lambda task fails. This results in a - // ScheduleLambdaFunctionFailed history event. For more information, see - // https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html) - // in the Amazon SWF Developer Guide. - LambdaRole *string - - // The list of tags to associate with the workflow execution. You can specify a - // maximum of 5 tags. You can list workflow executions with a specific tag by - // calling ListOpenWorkflowExecutions () or ListClosedWorkflowExecutions () and - // specifying a TagFilter (). - TagList []*string - - // The total duration for this workflow execution. This overrides the - // defaultExecutionStartToCloseTimeout specified when registering the workflow - // type.

    The duration is specified in seconds; an integer greater than or equal - // to 0. Exceeding this limit causes the workflow execution to time - // out. Unlike some of the other timeout parameters in Amazon SWF, you cannot - // specify a value of "NONE" for this timeout; there is a one-year max limit on the - // time that a workflow execution can run.

    An execution - // start-to-close timeout must be specified either through this parameter or as a - // default when the workflow type is registered. If neither this parameter nor a - // default execution start-to-close timeout is specified, a fault is returned.

    - //     - ExecutionStartToCloseTimeout *string - // The name of the domain in which the workflow execution is created. // // This member is required. Domain *string - // The input for the workflow execution. This is a free form string which should be - // meaningful to the workflow you are starting. This input is made available to the - // new workflow execution in the WorkflowExecutionStarted history event. - Input *string - // The user defined identifier associated with the workflow execution. You can use // this to associate a custom identifier with the workflow execution. You may // specify the same identifier if a workflow execution is logically a restart of a @@ -166,26 +133,38 @@ type StartWorkflowExecutionInput struct { // then a fault is returned. ChildPolicy types.ChildPolicy - // Specifies the maximum duration of decision tasks for this workflow execution. - // This parameter overrides the defaultTaskStartToCloseTimout specified when - // registering the workflow type using RegisterWorkflowType (). The duration is - // specified in seconds, an integer greater than or equal to 0. You can use NONE to - // specify unlimited duration. A task start-to-close timeout for this workflow - // execution must be specified either as a default for the workflow type or through - // this parameter. If neither this parameter is set nor a default task - // start-to-close timeout was specified at registration time then a fault is - // returned. - TaskStartToCloseTimeout *string + // The total duration for this workflow execution. This overrides the + // defaultExecutionStartToCloseTimeout specified when registering the workflow + // type.

    The duration is specified in seconds; an integer greater than or equal + // to 0. Exceeding this limit causes the workflow execution to time + // out. Unlike some of the other timeout parameters in Amazon SWF, you cannot + // specify a value of "NONE" for this timeout; there is a one-year max limit on the + // time that a workflow execution can run.

    An execution + // start-to-close timeout must be specified either through this parameter or as a + // default when the workflow type is registered. If neither this parameter nor a + // default execution start-to-close timeout is specified, a fault is returned.

    + //     + ExecutionStartToCloseTimeout *string - // The task priority to use for this workflow execution. This overrides any default - // priority that was assigned when the workflow type was registered. If not set, - // then the default task priority for the workflow type is used. Valid values are - // integers that range from Java's Integer.MIN_VALUE (-2147483648) to - // Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For - // more information about setting task priority, see Setting Task Priority - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) + // The input for the workflow execution. This is a free form string which should be + // meaningful to the workflow you are starting. This input is made available to the + // new workflow execution in the WorkflowExecutionStarted history event. + Input *string + + // The IAM role to attach to this workflow execution. Executions of this workflow + // type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, + // any attempt to schedule a Lambda task fails. This results in a + // ScheduleLambdaFunctionFailed history event. For more information, see + // https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html + // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html) // in the Amazon SWF Developer Guide. - TaskPriority *string + LambdaRole *string + + // The list of tags to associate with the workflow execution. You can specify a + // maximum of 5 tags. You can list workflow executions with a specific tag by + // calling ListOpenWorkflowExecutions () or ListClosedWorkflowExecutions () and + // specifying a TagFilter (). + TagList []*string // The task list to use for the decision tasks generated for this workflow // execution. This overrides the defaultTaskList specified when registering the @@ -198,6 +177,27 @@ type StartWorkflowExecutionInput struct { // (\u0000-\u001f | \u007f-\u009f). Also, it must not // be the literal string arn.

    TaskList *types.TaskList + + // The task priority to use for this workflow execution. This overrides any default + // priority that was assigned when the workflow type was registered. If not set, + // then the default task priority for the workflow type is used. Valid values are + // integers that range from Java's Integer.MIN_VALUE (-2147483648) to + // Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For + // more information about setting task priority, see Setting Task Priority + // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) + // in the Amazon SWF Developer Guide. + TaskPriority *string + + // Specifies the maximum duration of decision tasks for this workflow execution. + // This parameter overrides the defaultTaskStartToCloseTimout specified when + // registering the workflow type using RegisterWorkflowType (). The duration is + // specified in seconds, an integer greater than or equal to 0. You can use NONE to + // specify unlimited duration. A task start-to-close timeout for this workflow + // execution must be specified either as a default for the workflow type or through + // this parameter. If neither this parameter is set nor a default task + // start-to-close timeout was specified at registration time then a fault is + // returned. + TaskStartToCloseTimeout *string } // Specifies the runId of a workflow execution. diff --git a/service/swf/api_op_TerminateWorkflowExecution.go b/service/swf/api_op_TerminateWorkflowExecution.go index ab0ba826b76..3c4f4a64de6 100644 --- a/service/swf/api_op_TerminateWorkflowExecution.go +++ b/service/swf/api_op_TerminateWorkflowExecution.go @@ -81,17 +81,16 @@ func (c *Client) TerminateWorkflowExecution(ctx context.Context, params *Termina type TerminateWorkflowExecutionInput struct { - // A descriptive reason for terminating the workflow execution. - Reason *string - - // Details for terminating the workflow execution. - Details *string - // The domain of the workflow execution to terminate. // // This member is required. Domain *string + // The workflowId of the workflow execution to terminate. + // + // This member is required. + WorkflowId *string + // If set, specifies the policy to use for the child workflow executions of the // workflow execution being terminated. This policy overrides the child policy // specified for the workflow execution at registration time or when starting the @@ -115,10 +114,11 @@ type TerminateWorkflowExecutionInput struct { // then a fault is returned. ChildPolicy types.ChildPolicy - // The workflowId of the workflow execution to terminate. - // - // This member is required. - WorkflowId *string + // Details for terminating the workflow execution. + Details *string + + // A descriptive reason for terminating the workflow execution. + Reason *string // The runId of the workflow execution to terminate. RunId *string diff --git a/service/swf/go.mod b/service/swf/go.mod index 00483b84bc0..b1dc3c1ecb5 100644 --- a/service/swf/go.mod +++ b/service/swf/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/swf go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/swf/types/types.go b/service/swf/types/types.go index 2839b9faeee..8df55dec436 100644 --- a/service/swf/types/types.go +++ b/service/swf/types/types.go @@ -16,25 +16,30 @@ type ActivityTaskCanceledEventAttributes struct { // This member is required. ScheduledEventId *int64 - // If set, contains the ID of the last ActivityTaskCancelRequested event recorded - // for this activity task. This information can be useful for diagnosing problems - // by tracing back the chain of events leading up to this event. - LatestCancelRequestedEventId *int64 - - // Details of the cancellation. - Details *string - // The ID of the ActivityTaskStarted event recorded when this activity task was // started. This information can be useful for diagnosing problems by tracing back // the chain of events leading up to this event. // // This member is required. StartedEventId *int64 + + // Details of the cancellation. + Details *string + + // If set, contains the ID of the last ActivityTaskCancelRequested event recorded + // for this activity task. This information can be useful for diagnosing problems + // by tracing back the chain of events leading up to this event. + LatestCancelRequestedEventId *int64 } // Provides the details of the ActivityTaskCancelRequested event. type ActivityTaskCancelRequestedEventAttributes struct { + // The unique ID of the task. + // + // This member is required. + ActivityId *string + // The ID of the DecisionTaskCompleted event corresponding to the decision task // that resulted in the RequestCancelActivityTask decision for this cancellation // request. This information can be useful for diagnosing problems by tracing back @@ -42,11 +47,6 @@ type ActivityTaskCancelRequestedEventAttributes struct { // // This member is required. DecisionTaskCompletedEventId *int64 - - // The unique ID of the task. - // - // This member is required. - ActivityId *string } // Provides the details of the ActivityTaskCompleted event. @@ -59,30 +59,20 @@ type ActivityTaskCompletedEventAttributes struct { // This member is required. ScheduledEventId *int64 - // The results of the activity task. - Result *string - // The ID of the ActivityTaskStarted event recorded when this activity task was // started. This information can be useful for diagnosing problems by tracing back // the chain of events leading up to this event. // // This member is required. StartedEventId *int64 + + // The results of the activity task. + Result *string } // Provides the details of the ActivityTaskFailed event. type ActivityTaskFailedEventAttributes struct { - // The ID of the ActivityTaskStarted event recorded when this activity task was - // started. This information can be useful for diagnosing problems by tracing back - // the chain of events leading up to this event. - // - // This member is required. - StartedEventId *int64 - - // The reason provided for the failure. - Reason *string - // The ID of the ActivityTaskScheduled event that was recorded when this activity // task was scheduled. This information can be useful for diagnosing problems by // tracing back the chain of events leading up to this event. @@ -90,31 +80,27 @@ type ActivityTaskFailedEventAttributes struct { // This member is required. ScheduledEventId *int64 + // The ID of the ActivityTaskStarted event recorded when this activity task was + // started. This information can be useful for diagnosing problems by tracing back + // the chain of events leading up to this event. + // + // This member is required. + StartedEventId *int64 + // The details of the failure. Details *string + + // The reason provided for the failure. + Reason *string } // Provides the details of the ActivityTaskScheduled event. type ActivityTaskScheduledEventAttributes struct { - // The priority to assign to the scheduled activity task. If set, this overrides - // any default priority value that was assigned when the activity type was - // registered. Valid values are integers that range from Java's Integer.MIN_VALUE - // (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher - // priority. For more information about setting task priority, see Setting Task - // Priority - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) - // in the Amazon SWF Developer Guide. - TaskPriority *string - - // Data attached to the event that can be used by the decider in subsequent - // workflow tasks. This data isn't sent to the activity. - Control *string - - // The task list in which the activity task has been scheduled. + // The unique ID of the activity task. // // This member is required. - TaskList *TaskList + ActivityId *string // The type of the activity task. // @@ -129,16 +115,14 @@ type ActivityTaskScheduledEventAttributes struct { // This member is required. DecisionTaskCompletedEventId *int64 - // The maximum amount of time a worker may take to process the activity task. - StartToCloseTimeout *string - - // The input provided to the activity task. - Input *string - - // The unique ID of the activity task. + // The task list in which the activity task has been scheduled. // // This member is required. - ActivityId *string + TaskList *TaskList + + // Data attached to the event that can be used by the decider in subsequent + // workflow tasks. This data isn't sent to the activity. + Control *string // The maximum time before which the worker processing this task must report // progress by calling RecordActivityTaskHeartbeat (). If the timeout is exceeded, @@ -146,32 +130,55 @@ type ActivityTaskScheduledEventAttributes struct { // attempts to record a heartbeat or return a result, it is ignored. HeartbeatTimeout *string + // The input provided to the activity task. + Input *string + + // The maximum amount of time for this activity task. + ScheduleToCloseTimeout *string + // The maximum amount of time the activity task can wait to be assigned to a // worker. ScheduleToStartTimeout *string - // The maximum amount of time for this activity task. - ScheduleToCloseTimeout *string + // The maximum amount of time a worker may take to process the activity task. + StartToCloseTimeout *string + + // The priority to assign to the scheduled activity task. If set, this overrides + // any default priority value that was assigned when the activity type was + // registered. Valid values are integers that range from Java's Integer.MIN_VALUE + // (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher + // priority. For more information about setting task priority, see Setting Task + // Priority + // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) + // in the Amazon SWF Developer Guide. + TaskPriority *string } // Provides the details of the ActivityTaskStarted event. type ActivityTaskStartedEventAttributes struct { - // Identity of the worker that was assigned this task. This aids diagnostics when - // problems arise. The form of this identity is user defined. - Identity *string - // The ID of the ActivityTaskScheduled event that was recorded when this activity // task was scheduled. This information can be useful for diagnosing problems by // tracing back the chain of events leading up to this event. // // This member is required. ScheduledEventId *int64 + + // Identity of the worker that was assigned this task. This aids diagnostics when + // problems arise. The form of this identity is user defined. + Identity *string } // Provides the details of the ActivityTaskTimedOut event. type ActivityTaskTimedOutEventAttributes struct { + // The ID of the ActivityTaskScheduled event that was recorded when this activity + // task was scheduled. This information can be useful for diagnosing problems by + // tracing back the chain of events leading up to this event. + // + // This member is required. + ScheduledEventId *int64 + // The ID of the ActivityTaskStarted event recorded when this activity task was // started. This information can be useful for diagnosing problems by tracing back // the chain of events leading up to this event. @@ -179,21 +186,14 @@ type ActivityTaskTimedOutEventAttributes struct { // This member is required. StartedEventId *int64 - // The ID of the ActivityTaskScheduled event that was recorded when this activity - // task was scheduled. This information can be useful for diagnosing problems by - // tracing back the chain of events leading up to this event. + // The type of the timeout that caused this event. // // This member is required. - ScheduledEventId *int64 + TimeoutType ActivityTaskTimeoutType // Contains the content of the details parameter for the last call made by the // activity to RecordActivityTaskHeartbeat. Details *string - - // The type of the timeout that caused this event. - // - // This member is required. - TimeoutType ActivityTaskTimeoutType } // Represents an activity type. @@ -227,19 +227,29 @@ type ActivityTypeConfiguration struct { // use NONE to specify unlimited duration. DefaultTaskHeartbeatTimeout *string - // The default maximum duration for tasks of an activity type specified when - // registering the activity type. You can override this default when scheduling a - // task through the ScheduleActivityTaskDecision (). The duration is specified in - // seconds, an integer greater than or equal to 0. You can use NONE to specify - // unlimited duration. - DefaultTaskStartToCloseTimeout *string - // The default task list specified for this activity type at registration. This // default is used if a task list isn't provided when a task is scheduled through // the ScheduleActivityTaskDecision (). You can override the default registered // task list when scheduling a task through the ScheduleActivityTaskDecision (). DefaultTaskList *TaskList + // The default task priority for tasks of this activity type, specified at + // registration. If not set, then 0 is used as the default priority. This default + // can be overridden when scheduling an activity task. Valid values are integers + // that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE + // (2147483647). Higher numbers indicate higher priority. For more information + // about setting task priority, see Setting Task Priority + // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) + // in the Amazon SWF Developer Guide. + DefaultTaskPriority *string + + // The default maximum duration, specified when registering the activity type, for + // tasks of this activity type. You can override this default when scheduling a + // task through the ScheduleActivityTaskDecision (). The duration is specified in + // seconds, an integer greater than or equal to 0. You can use NONE to specify + // unlimited duration. + DefaultTaskScheduleToCloseTimeout *string + // The default maximum duration, specified when registering the activity type, that // a task of an activity type can wait before being assigned to a worker. You can // override this default when scheduling a task through the @@ -248,38 +258,17 @@ type ActivityTypeConfiguration struct { // duration. DefaultTaskScheduleToStartTimeout *string - // The default maximum duration, specified when registering the activity type, for - // tasks of this activity type. You can override this default when scheduling a + // The default maximum duration for tasks of an activity type specified when + // registering the activity type. You can override this default when scheduling a // task through the ScheduleActivityTaskDecision (). The duration is specified in // seconds, an integer greater than or equal to 0. You can use NONE to specify // unlimited duration. - DefaultTaskScheduleToCloseTimeout *string - - // The default task priority for tasks of this activity type, specified at - // registration. If not set, then 0 is used as the default priority. This default - // can be overridden when scheduling an activity task. Valid values are integers - // that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE - // (2147483647). Higher numbers indicate higher priority. For more information - // about setting task priority, see Setting Task Priority - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) - // in the Amazon SWF Developer Guide. - DefaultTaskPriority *string + DefaultTaskStartToCloseTimeout *string } // Detailed information about an activity type. type ActivityTypeInfo struct { - // The description of the activity type provided in RegisterActivityType (). - Description *string - - // The current status of the activity type. - // - // This member is required. - Status RegistrationStatus - - // If DEPRECATED, the date and time DeprecateActivityType () was called. - DeprecationDate *time.Time - // The ActivityType () type structure representing the activity type. // // This member is required. @@ -290,6 +279,17 @@ type ActivityTypeInfo struct { // // This member is required. CreationDate *time.Time + + // The current status of the activity type. + // + // This member is required. + Status RegistrationStatus + + // If DEPRECATED, the date and time DeprecateActivityType () was called. + DeprecationDate *time.Time + + // The description of the activity type provided in RegisterActivityType (). + Description *string } // Provides the details of the CancelTimer decision. Access Control You can use IAM @@ -376,14 +376,6 @@ type CancelWorkflowExecutionDecisionAttributes struct { // Provides the details of the CancelWorkflowExecutionFailed event. type CancelWorkflowExecutionFailedEventAttributes struct { - // The ID of the DecisionTaskCompleted event corresponding to the decision task - // that resulted in the CancelWorkflowExecution decision for this cancellation - // request. This information can be useful for diagnosing problems by tracing back - // the chain of events leading up to this event. - // - // This member is required. - DecisionTaskCompletedEventId *int64 - // The cause of the failure. This information is generated by the system and can be // useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the // decision failed because it lacked sufficient permissions. For details and @@ -393,16 +385,19 @@ type CancelWorkflowExecutionFailedEventAttributes struct { // // This member is required. Cause CancelWorkflowExecutionFailedCause + + // The ID of the DecisionTaskCompleted event corresponding to the decision task + // that resulted in the CancelWorkflowExecution decision for this cancellation + // request. This information can be useful for diagnosing problems by tracing back + // the chain of events leading up to this event. + // + // This member is required. + DecisionTaskCompletedEventId *int64 } // Provide details of the ChildWorkflowExecutionCanceled event. type ChildWorkflowExecutionCanceledEventAttributes struct { - // The type of the child workflow execution. - // - // This member is required. - WorkflowType *WorkflowType - // The ID of the StartChildWorkflowExecutionInitiated event corresponding to the // StartChildWorkflowExecutionDecision () to start this child workflow execution. // This information can be useful for diagnosing problems by tracing back the chain @@ -411,41 +406,29 @@ type ChildWorkflowExecutionCanceledEventAttributes struct { // This member is required. InitiatedEventId *int64 - // Details of the cancellation (if provided). - Details *string - - // The child workflow execution that was canceled. - // - // This member is required. - WorkflowExecution *WorkflowExecution - // The ID of the ChildWorkflowExecutionStarted event recorded when this child // workflow execution was started. This information can be useful for diagnosing // problems by tracing back the chain of events leading up to this event. // // This member is required. StartedEventId *int64 -} - -// Provides the details of the ChildWorkflowExecutionCompleted event. -type ChildWorkflowExecutionCompletedEventAttributes struct { - // The ID of the ChildWorkflowExecutionStarted event recorded when this child - // workflow execution was started. This information can be useful for diagnosing - // problems by tracing back the chain of events leading up to this event. + // The child workflow execution that was canceled. // // This member is required. - StartedEventId *int64 + WorkflowExecution *WorkflowExecution // The type of the child workflow execution. // // This member is required. WorkflowType *WorkflowType - // The child workflow execution that was completed. - // - // This member is required. - WorkflowExecution *WorkflowExecution + // Details of the cancellation (if provided). + Details *string +} + +// Provides the details of the ChildWorkflowExecutionCompleted event. +type ChildWorkflowExecutionCompletedEventAttributes struct { // The ID of the StartChildWorkflowExecutionInitiated event corresponding to the // StartChildWorkflowExecutionDecision () to start this child workflow execution. @@ -455,13 +438,6 @@ type ChildWorkflowExecutionCompletedEventAttributes struct { // This member is required. InitiatedEventId *int64 - // The result of the child workflow execution. - Result *string -} - -// Provides the details of the ChildWorkflowExecutionFailed event. -type ChildWorkflowExecutionFailedEventAttributes struct { - // The ID of the ChildWorkflowExecutionStarted event recorded when this child // workflow execution was started. This information can be useful for diagnosing // problems by tracing back the chain of events leading up to this event. @@ -469,61 +445,80 @@ type ChildWorkflowExecutionFailedEventAttributes struct { // This member is required. StartedEventId *int64 + // The child workflow execution that was completed. + // + // This member is required. + WorkflowExecution *WorkflowExecution + // The type of the child workflow execution. // // This member is required. WorkflowType *WorkflowType - // The ID of the StartChildWorkflowExecutionInitiated event corresponding to the - // StartChildWorkflowExecutionDecision () to start this child workflow execution. - // This information can be useful for diagnosing problems by tracing back the chain + // The result of the child workflow execution. + Result *string +} + +// Provides the details of the ChildWorkflowExecutionFailed event. +type ChildWorkflowExecutionFailedEventAttributes struct { + + // The ID of the StartChildWorkflowExecutionInitiated event corresponding to the + // StartChildWorkflowExecutionDecision () to start this child workflow execution. + // This information can be useful for diagnosing problems by tracing back the chain // of events leading up to this event. // // This member is required. InitiatedEventId *int64 - // The reason for the failure (if provided). - Reason *string - - // The details of the failure (if provided). - Details *string + // The ID of the ChildWorkflowExecutionStarted event recorded when this child + // workflow execution was started. This information can be useful for diagnosing + // problems by tracing back the chain of events leading up to this event. + // + // This member is required. + StartedEventId *int64 // The child workflow execution that failed. // // This member is required. WorkflowExecution *WorkflowExecution + + // The type of the child workflow execution. + // + // This member is required. + WorkflowType *WorkflowType + + // The details of the failure (if provided). + Details *string + + // The reason for the failure (if provided). + Reason *string } // Provides the details of the ChildWorkflowExecutionStarted event. type ChildWorkflowExecutionStartedEventAttributes struct { - // The type of the child workflow execution. + // The ID of the StartChildWorkflowExecutionInitiated event corresponding to the + // StartChildWorkflowExecutionDecision () to start this child workflow execution. + // This information can be useful for diagnosing problems by tracing back the chain + // of events leading up to this event. // // This member is required. - WorkflowType *WorkflowType + InitiatedEventId *int64 // The child workflow execution that was started. // // This member is required. WorkflowExecution *WorkflowExecution - // The ID of the StartChildWorkflowExecutionInitiated event corresponding to the - // StartChildWorkflowExecutionDecision () to start this child workflow execution. - // This information can be useful for diagnosing problems by tracing back the chain - // of events leading up to this event. + // The type of the child workflow execution. // // This member is required. - InitiatedEventId *int64 + WorkflowType *WorkflowType } // Provides the details of the ChildWorkflowExecutionTerminated event. type ChildWorkflowExecutionTerminatedEventAttributes struct { - // The child workflow execution that was terminated. - // - // This member is required. - WorkflowExecution *WorkflowExecution - // The ID of the StartChildWorkflowExecutionInitiated event corresponding to the // StartChildWorkflowExecutionDecision () to start this child workflow execution. // This information can be useful for diagnosing problems by tracing back the chain @@ -532,17 +527,22 @@ type ChildWorkflowExecutionTerminatedEventAttributes struct { // This member is required. InitiatedEventId *int64 - // The type of the child workflow execution. - // - // This member is required. - WorkflowType *WorkflowType - // The ID of the ChildWorkflowExecutionStarted event recorded when this child // workflow execution was started. This information can be useful for diagnosing // problems by tracing back the chain of events leading up to this event. // // This member is required. StartedEventId *int64 + + // The child workflow execution that was terminated. + // + // This member is required. + WorkflowExecution *WorkflowExecution + + // The type of the child workflow execution. + // + // This member is required. + WorkflowType *WorkflowType } // Provides the details of the ChildWorkflowExecutionTimedOut event. @@ -556,11 +556,6 @@ type ChildWorkflowExecutionTimedOutEventAttributes struct { // This member is required. InitiatedEventId *int64 - // The type of the timeout that caused the child workflow execution to time out. - // - // This member is required. - TimeoutType WorkflowExecutionTimeoutType - // The ID of the ChildWorkflowExecutionStarted event recorded when this child // workflow execution was started. This information can be useful for diagnosing // problems by tracing back the chain of events leading up to this event. @@ -568,6 +563,11 @@ type ChildWorkflowExecutionTimedOutEventAttributes struct { // This member is required. StartedEventId *int64 + // The type of the timeout that caused the child workflow execution to time out. + // + // This member is required. + TimeoutType WorkflowExecutionTimeoutType + // The child workflow execution that timed out. // // This member is required. @@ -670,17 +670,29 @@ type CompleteWorkflowExecutionFailedEventAttributes struct { // in the Amazon SWF Developer Guide. type ContinueAsNewWorkflowExecutionDecisionAttributes struct { - // The list of tags to associate with the new workflow execution. A maximum of 5 - // tags can be specified. You can list workflow executions with a specific tag by - // calling ListOpenWorkflowExecutions () or ListClosedWorkflowExecutions () and - // specifying a TagFilter (). - TagList []*string - - // The input provided to the new workflow execution. - Input *string - - // The IAM role to attach to the new (continued) execution. - LambdaRole *string + // If set, specifies the policy to use for the child workflow executions of the new + // execution if it is terminated by calling the TerminateWorkflowExecution () + // action explicitly or due to an expired timeout. This policy overrides the + // default child policy specified when registering the workflow type using + // RegisterWorkflowType (). The supported child policies are: + // + // * TERMINATE – + // The child executions are terminated. + // + // * REQUEST_CANCEL – A request to cancel + // is attempted for each child execution by recording a + // WorkflowExecutionCancelRequested event in its history. It is up to the decider + // to take appropriate actions when it receives an execution history with this + // event. + // + // * ABANDON – No action is taken. The child executions continue to + // run. + // + // A child policy for this workflow execution must be specified either as a + // default for the workflow type or through this parameter. If neither this + // parameter is set nor a default child policy was specified at registration time + // then a fault is returned. + ChildPolicy ChildPolicy // If set, specifies the total duration for this workflow execution. This overrides // the defaultExecutionStartToCloseTimeout specified when registering the workflow @@ -692,8 +704,21 @@ type ContinueAsNewWorkflowExecutionDecisionAttributes struct { // a fault is returned. ExecutionStartToCloseTimeout *string - // The version of the workflow to start. - WorkflowTypeVersion *string + // The input provided to the new workflow execution. + Input *string + + // The IAM role to attach to the new (continued) execution. + LambdaRole *string + + // The list of tags to associate with the new workflow execution. A maximum of 5 + // tags can be specified. You can list workflow executions with a specific tag by + // calling ListOpenWorkflowExecutions () or ListClosedWorkflowExecutions () and + // specifying a TagFilter (). + TagList []*string + + // The task list to use for the decisions of the new (continued) workflow + // execution. + TaskList *TaskList // The task priority that, if set, specifies the priority for the decision tasks // for this workflow execution. This overrides the defaultTaskPriority specified @@ -705,10 +730,6 @@ type ContinueAsNewWorkflowExecutionDecisionAttributes struct { // in the Amazon SWF Developer Guide. TaskPriority *string - // The task list to use for the decisions of the new (continued) workflow - // execution. - TaskList *TaskList - // Specifies the maximum duration of decision tasks for the new workflow execution. // This parameter overrides the defaultTaskStartToCloseTimout specified when // registering the workflow type using RegisterWorkflowType (). The duration is @@ -720,29 +741,8 @@ type ContinueAsNewWorkflowExecutionDecisionAttributes struct { // returned. TaskStartToCloseTimeout *string - // If set, specifies the policy to use for the child workflow executions of the new - // execution if it is terminated by calling the TerminateWorkflowExecution () - // action explicitly or due to an expired timeout. This policy overrides the - // default child policy specified when registering the workflow type using - // RegisterWorkflowType (). The supported child policies are: - // - // * TERMINATE – - // The child executions are terminated. - // - // * REQUEST_CANCEL – A request to cancel - // is attempted for each child execution by recording a - // WorkflowExecutionCancelRequested event in its history. It is up to the decider - // to take appropriate actions when it receives an execution history with this - // event. - // - // * ABANDON – No action is taken. The child executions continue to - // run. - // - // A child policy for this workflow execution must be specified either as a - // default for the workflow type or through this parameter. If neither this - // parameter is set nor a default child policy was specified at registration time - // then a fault is returned. - ChildPolicy ChildPolicy + // The version of the workflow to start. + WorkflowTypeVersion *string } // Provides the details of the ContinueAsNewWorkflowExecutionFailed event. @@ -912,58 +912,58 @@ type ContinueAsNewWorkflowExecutionFailedEventAttributes struct { // StartChildWorkflowExecutionDecisionAttributes

    type Decision struct { - // Provides the details of the FailWorkflowExecution decision. It isn't set for - // other decision types. - FailWorkflowExecutionDecisionAttributes *FailWorkflowExecutionDecisionAttributes - // Specifies the type of the decision. // // This member is required. DecisionType DecisionType - // Provides the details of the SignalExternalWorkflowExecution decision. It isn't - // set for other decision types. - SignalExternalWorkflowExecutionDecisionAttributes *SignalExternalWorkflowExecutionDecisionAttributes + // Provides the details of the CancelTimer decision. It isn't set for other + // decision types. + CancelTimerDecisionAttributes *CancelTimerDecisionAttributes // Provides the details of the CancelWorkflowExecution decision. It isn't set for // other decision types. CancelWorkflowExecutionDecisionAttributes *CancelWorkflowExecutionDecisionAttributes - // Provides the details of the StartChildWorkflowExecution decision. It isn't set - // for other decision types. - StartChildWorkflowExecutionDecisionAttributes *StartChildWorkflowExecutionDecisionAttributes - - // Provides the details of the CancelTimer decision. It isn't set for other - // decision types. - CancelTimerDecisionAttributes *CancelTimerDecisionAttributes - - // Provides the details of the ScheduleLambdaFunction decision. It isn't set for + // Provides the details of the CompleteWorkflowExecution decision. It isn't set for // other decision types. - ScheduleLambdaFunctionDecisionAttributes *ScheduleLambdaFunctionDecisionAttributes + CompleteWorkflowExecutionDecisionAttributes *CompleteWorkflowExecutionDecisionAttributes // Provides the details of the ContinueAsNewWorkflowExecution decision. It isn't // set for other decision types. ContinueAsNewWorkflowExecutionDecisionAttributes *ContinueAsNewWorkflowExecutionDecisionAttributes - // Provides the details of the ScheduleActivityTask decision. It isn't set for + // Provides the details of the FailWorkflowExecution decision. It isn't set for // other decision types. - ScheduleActivityTaskDecisionAttributes *ScheduleActivityTaskDecisionAttributes + FailWorkflowExecutionDecisionAttributes *FailWorkflowExecutionDecisionAttributes + + // Provides the details of the RecordMarker decision. It isn't set for other + // decision types. + RecordMarkerDecisionAttributes *RecordMarkerDecisionAttributes // Provides the details of the RequestCancelActivityTask decision. It isn't set for // other decision types. RequestCancelActivityTaskDecisionAttributes *RequestCancelActivityTaskDecisionAttributes - // Provides the details of the CompleteWorkflowExecution decision. It isn't set for - // other decision types. - CompleteWorkflowExecutionDecisionAttributes *CompleteWorkflowExecutionDecisionAttributes - // Provides the details of the RequestCancelExternalWorkflowExecution decision. It // isn't set for other decision types. RequestCancelExternalWorkflowExecutionDecisionAttributes *RequestCancelExternalWorkflowExecutionDecisionAttributes - // Provides the details of the RecordMarker decision. It isn't set for other - // decision types. - RecordMarkerDecisionAttributes *RecordMarkerDecisionAttributes + // Provides the details of the ScheduleActivityTask decision. It isn't set for + // other decision types. + ScheduleActivityTaskDecisionAttributes *ScheduleActivityTaskDecisionAttributes + + // Provides the details of the ScheduleLambdaFunction decision. It isn't set for + // other decision types. + ScheduleLambdaFunctionDecisionAttributes *ScheduleLambdaFunctionDecisionAttributes + + // Provides the details of the SignalExternalWorkflowExecution decision. It isn't + // set for other decision types. + SignalExternalWorkflowExecutionDecisionAttributes *SignalExternalWorkflowExecutionDecisionAttributes + + // Provides the details of the StartChildWorkflowExecution decision. It isn't set + // for other decision types. + StartChildWorkflowExecutionDecisionAttributes *StartChildWorkflowExecutionDecisionAttributes // Provides the details of the StartTimer decision. It isn't set for other decision // types. @@ -973,13 +973,6 @@ type Decision struct { // Provides the details of the DecisionTaskCompleted event. type DecisionTaskCompletedEventAttributes struct { - // The ID of the DecisionTaskStarted event recorded when this decision task was - // started. This information can be useful for diagnosing problems by tracing back - // the chain of events leading up to this event. - // - // This member is required. - StartedEventId *int64 - // The ID of the DecisionTaskScheduled event that was recorded when this decision // task was scheduled. This information can be useful for diagnosing problems by // tracing back the chain of events leading up to this event. @@ -987,6 +980,13 @@ type DecisionTaskCompletedEventAttributes struct { // This member is required. ScheduledEventId *int64 + // The ID of the DecisionTaskStarted event recorded when this decision task was + // started. This information can be useful for diagnosing problems by tracing back + // the chain of events leading up to this event. + // + // This member is required. + StartedEventId *int64 + // User defined context for the workflow execution. ExecutionContext *string } @@ -994,14 +994,6 @@ type DecisionTaskCompletedEventAttributes struct { // Provides details about the DecisionTaskScheduled event. type DecisionTaskScheduledEventAttributes struct { - // A task priority that, if set, specifies the priority for this decision task. - // Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) - // to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For - // more information about setting task priority, see Setting Task Priority - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) - // in the Amazon SWF Developer Guide. - TaskPriority *string - // The name of the task list in which the decision task was scheduled. // // This member is required. @@ -1012,31 +1004,34 @@ type DecisionTaskScheduledEventAttributes struct { // an integer greater than or equal to 0. You can use NONE to specify unlimited // duration. StartToCloseTimeout *string + + // A task priority that, if set, specifies the priority for this decision task. + // Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) + // to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For + // more information about setting task priority, see Setting Task Priority + // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) + // in the Amazon SWF Developer Guide. + TaskPriority *string } // Provides the details of the DecisionTaskStarted event. type DecisionTaskStartedEventAttributes struct { - // Identity of the decider making the request. This enables diagnostic tracing when - // problems arise. The form of this identity is user defined. - Identity *string - // The ID of the DecisionTaskScheduled event that was recorded when this decision // task was scheduled. This information can be useful for diagnosing problems by // tracing back the chain of events leading up to this event. // // This member is required. ScheduledEventId *int64 + + // Identity of the decider making the request. This enables diagnostic tracing when + // problems arise. The form of this identity is user defined. + Identity *string } // Provides the details of the DecisionTaskTimedOut event. type DecisionTaskTimedOutEventAttributes struct { - // The type of timeout that expired before the decision task could be completed. - // - // This member is required. - TimeoutType DecisionTaskTimeoutType - // The ID of the DecisionTaskScheduled event that was recorded when this decision // task was scheduled. This information can be useful for diagnosing problems by // tracing back the chain of events leading up to this event. @@ -1050,6 +1045,11 @@ type DecisionTaskTimedOutEventAttributes struct { // // This member is required. StartedEventId *int64 + + // The type of timeout that expired before the decision task could be completed. + // + // This member is required. + TimeoutType DecisionTaskTimeoutType } // Contains the configuration settings of a domain. @@ -1064,6 +1064,11 @@ type DomainConfiguration struct { // Contains general information about a domain. type DomainInfo struct { + // The name of the domain. This name is unique within the account. + // + // This member is required. + Name *string + // The status of the domain: // // * REGISTERED – The domain is properly registered @@ -1077,16 +1082,11 @@ type DomainInfo struct { // This member is required. Status RegistrationStatus - // The description of the domain provided through RegisterDomain (). - Description *string - // The ARN of the domain. Arn *string - // The name of the domain. This name is unique within the account. - // - // This member is required. - Name *string + // The description of the domain provided through RegisterDomain (). + Description *string } // Used to filter the workflow executions in visibility APIs by various time-based @@ -1125,11 +1125,6 @@ type ExternalWorkflowExecutionCancelRequestedEventAttributes struct { // Provides the details of the ExternalWorkflowExecutionSignaled event. type ExternalWorkflowExecutionSignaledEventAttributes struct { - // The external workflow execution that the signal was delivered to. - // - // This member is required. - WorkflowExecution *WorkflowExecution - // The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to // the SignalExternalWorkflowExecution decision to request this signal. This // information can be useful for diagnosing problems by tracing back the chain of @@ -1137,6 +1132,11 @@ type ExternalWorkflowExecutionSignaledEventAttributes struct { // // This member is required. InitiatedEventId *int64 + + // The external workflow execution that the signal was delivered to. + // + // This member is required. + WorkflowExecution *WorkflowExecution } // Provides the details of the FailWorkflowExecution decision. Access Control You @@ -1171,14 +1171,6 @@ type FailWorkflowExecutionDecisionAttributes struct { // Provides the details of the FailWorkflowExecutionFailed event. type FailWorkflowExecutionFailedEventAttributes struct { - // The ID of the DecisionTaskCompleted event corresponding to the decision task - // that resulted in the FailWorkflowExecution decision to fail this execution. This - // information can be useful for diagnosing problems by tracing back the chain of - // events leading up to this event. - // - // This member is required. - DecisionTaskCompletedEventId *int64 - // The cause of the failure. This information is generated by the system and can be // useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the // decision failed because it lacked sufficient permissions. For details and @@ -1188,6 +1180,14 @@ type FailWorkflowExecutionFailedEventAttributes struct { // // This member is required. Cause FailWorkflowExecutionFailedCause + + // The ID of the DecisionTaskCompleted event corresponding to the decision task + // that resulted in the FailWorkflowExecution decision to fail this execution. This + // information can be useful for diagnosing problems by tracing back the chain of + // events leading up to this event. + // + // This member is required. + DecisionTaskCompletedEventId *int64 } // Event within a workflow execution. A history event can be one of these types: @@ -1364,280 +1364,287 @@ type FailWorkflowExecutionFailedEventAttributes struct { // was exceeded. type HistoryEvent struct { - // If the event is of type ChildWorkflowExecutionTimedOut then this member is set - // and provides detailed information about the event. It isn't set for other event + // The system generated ID of the event. This ID uniquely identifies the event with + // in the workflow execution history. + // + // This member is required. + EventId *int64 + + // The date and time when the event occurred. + // + // This member is required. + EventTimestamp *time.Time + + // The type of the history event. + // + // This member is required. + EventType EventType + + // If the event is of type ActivityTaskcancelRequested then this member is set and + // provides detailed information about the event. It isn't set for other event // types. - ChildWorkflowExecutionTimedOutEventAttributes *ChildWorkflowExecutionTimedOutEventAttributes + ActivityTaskCancelRequestedEventAttributes *ActivityTaskCancelRequestedEventAttributes - // If the event is of type WorkflowExecutionStarted then this member is set and + // If the event is of type ActivityTaskCanceled then this member is set and // provides detailed information about the event. It isn't set for other event // types. - WorkflowExecutionStartedEventAttributes *WorkflowExecutionStartedEventAttributes + ActivityTaskCanceledEventAttributes *ActivityTaskCanceledEventAttributes - // If the event is of type ExternalWorkflowExecutionSignaled then this member is - // set and provides detailed information about the event. It isn't set for other - // event types. - ExternalWorkflowExecutionSignaledEventAttributes *ExternalWorkflowExecutionSignaledEventAttributes + // If the event is of type ActivityTaskCompleted then this member is set and + // provides detailed information about the event. It isn't set for other event + // types. + ActivityTaskCompletedEventAttributes *ActivityTaskCompletedEventAttributes - // If the event is of type CancelTimerFailed then this member is set and provides + // If the event is of type ActivityTaskFailed then this member is set and provides // detailed information about the event. It isn't set for other event types. - CancelTimerFailedEventAttributes *CancelTimerFailedEventAttributes + ActivityTaskFailedEventAttributes *ActivityTaskFailedEventAttributes - // If the event is of type ContinueAsNewWorkflowExecutionFailed then this member is - // set and provides detailed information about the event. It isn't set for other - // event types. - ContinueAsNewWorkflowExecutionFailedEventAttributes *ContinueAsNewWorkflowExecutionFailedEventAttributes + // If the event is of type ActivityTaskScheduled then this member is set and + // provides detailed information about the event. It isn't set for other event + // types. + ActivityTaskScheduledEventAttributes *ActivityTaskScheduledEventAttributes - // If the event is of type ActivityTaskCanceled then this member is set and + // If the event is of type ActivityTaskStarted then this member is set and provides + // detailed information about the event. It isn't set for other event types. + ActivityTaskStartedEventAttributes *ActivityTaskStartedEventAttributes + + // If the event is of type ActivityTaskTimedOut then this member is set and // provides detailed information about the event. It isn't set for other event // types. - ActivityTaskCanceledEventAttributes *ActivityTaskCanceledEventAttributes + ActivityTaskTimedOutEventAttributes *ActivityTaskTimedOutEventAttributes - // Provides the details of the LambdaFunctionStarted event. It isn't set for other - // event types. - LambdaFunctionStartedEventAttributes *LambdaFunctionStartedEventAttributes + // If the event is of type CancelTimerFailed then this member is set and provides + // detailed information about the event. It isn't set for other event types. + CancelTimerFailedEventAttributes *CancelTimerFailedEventAttributes - // If the event is of type ChildWorkflowExecutionCanceled then this member is set + // If the event is of type CancelWorkflowExecutionFailed then this member is set // and provides detailed information about the event. It isn't set for other event // types. - ChildWorkflowExecutionCanceledEventAttributes *ChildWorkflowExecutionCanceledEventAttributes - - // If the event is of type RequestCancelExternalWorkflowExecutionFailed then this - // member is set and provides detailed information about the event. It isn't set - // for other event types. - RequestCancelExternalWorkflowExecutionFailedEventAttributes *RequestCancelExternalWorkflowExecutionFailedEventAttributes + CancelWorkflowExecutionFailedEventAttributes *CancelWorkflowExecutionFailedEventAttributes - // If the event is of type WorkflowExecutionContinuedAsNew then this member is set + // If the event is of type ChildWorkflowExecutionCanceled then this member is set // and provides detailed information about the event. It isn't set for other event // types. - WorkflowExecutionContinuedAsNewEventAttributes *WorkflowExecutionContinuedAsNewEventAttributes + ChildWorkflowExecutionCanceledEventAttributes *ChildWorkflowExecutionCanceledEventAttributes // If the event is of type ChildWorkflowExecutionCompleted then this member is set // and provides detailed information about the event. It isn't set for other event // types. ChildWorkflowExecutionCompletedEventAttributes *ChildWorkflowExecutionCompletedEventAttributes - // Provides the details of the StartLambdaFunctionFailed event. It isn't set for - // other event types. - StartLambdaFunctionFailedEventAttributes *StartLambdaFunctionFailedEventAttributes - - // If the event is of type TimerStarted then this member is set and provides - // detailed information about the event. It isn't set for other event types. - TimerStartedEventAttributes *TimerStartedEventAttributes + // If the event is of type ChildWorkflowExecutionFailed then this member is set and + // provides detailed information about the event. It isn't set for other event + // types. + ChildWorkflowExecutionFailedEventAttributes *ChildWorkflowExecutionFailedEventAttributes // If the event is of type ChildWorkflowExecutionStarted then this member is set // and provides detailed information about the event. It isn't set for other event // types. ChildWorkflowExecutionStartedEventAttributes *ChildWorkflowExecutionStartedEventAttributes - // If the event is of type RequestCancelExternalWorkflowExecutionInitiated then - // this member is set and provides detailed information about the event. It isn't - // set for other event types. - RequestCancelExternalWorkflowExecutionInitiatedEventAttributes *RequestCancelExternalWorkflowExecutionInitiatedEventAttributes - - // If the event is of type WorkflowExecutionCancelRequested then this member is set + // If the event is of type ChildWorkflowExecutionTerminated then this member is set // and provides detailed information about the event. It isn't set for other event // types. - WorkflowExecutionCancelRequestedEventAttributes *WorkflowExecutionCancelRequestedEventAttributes - - // Provides the details of the LambdaFunctionCompleted event. It isn't set for - // other event types. - LambdaFunctionCompletedEventAttributes *LambdaFunctionCompletedEventAttributes - - // The system generated ID of the event. This ID uniquely identifies the event with - // in the workflow execution history. - // - // This member is required. - EventId *int64 + ChildWorkflowExecutionTerminatedEventAttributes *ChildWorkflowExecutionTerminatedEventAttributes - // If the event is of type SignalExternalWorkflowExecutionFailed then this member - // is set and provides detailed information about the event. It isn't set for other - // event types. - SignalExternalWorkflowExecutionFailedEventAttributes *SignalExternalWorkflowExecutionFailedEventAttributes + // If the event is of type ChildWorkflowExecutionTimedOut then this member is set + // and provides detailed information about the event. It isn't set for other event + // types. + ChildWorkflowExecutionTimedOutEventAttributes *ChildWorkflowExecutionTimedOutEventAttributes // If the event is of type CompleteWorkflowExecutionFailed then this member is set // and provides detailed information about the event. It isn't set for other event // types. CompleteWorkflowExecutionFailedEventAttributes *CompleteWorkflowExecutionFailedEventAttributes - // Provides the details of the LambdaFunctionTimedOut event. It isn't set for other + // If the event is of type ContinueAsNewWorkflowExecutionFailed then this member is + // set and provides detailed information about the event. It isn't set for other // event types. - LambdaFunctionTimedOutEventAttributes *LambdaFunctionTimedOutEventAttributes - - // Provides the details of the LambdaFunctionScheduled event. It isn't set for - // other event types. - LambdaFunctionScheduledEventAttributes *LambdaFunctionScheduledEventAttributes - - // If the event is of type ActivityTaskFailed then this member is set and provides - // detailed information about the event. It isn't set for other event types. - ActivityTaskFailedEventAttributes *ActivityTaskFailedEventAttributes - - // If the event is of type DecisionTaskStarted then this member is set and provides - // detailed information about the event. It isn't set for other event types. - DecisionTaskStartedEventAttributes *DecisionTaskStartedEventAttributes + ContinueAsNewWorkflowExecutionFailedEventAttributes *ContinueAsNewWorkflowExecutionFailedEventAttributes // If the event is of type DecisionTaskCompleted then this member is set and // provides detailed information about the event. It isn't set for other event // types. DecisionTaskCompletedEventAttributes *DecisionTaskCompletedEventAttributes - // If the event is of type DecisionTaskFailed then this member is set and provides - // detailed information about the event. It isn't set for other event types. - RecordMarkerFailedEventAttributes *RecordMarkerFailedEventAttributes - - // If the event is of type WorkflowExecutionTimedOut then this member is set and - // provides detailed information about the event. It isn't set for other event - // types. - WorkflowExecutionTimedOutEventAttributes *WorkflowExecutionTimedOutEventAttributes - // If the event is of type DecisionTaskScheduled then this member is set and // provides detailed information about the event. It isn't set for other event // types. DecisionTaskScheduledEventAttributes *DecisionTaskScheduledEventAttributes + // If the event is of type DecisionTaskStarted then this member is set and provides + // detailed information about the event. It isn't set for other event types. + DecisionTaskStartedEventAttributes *DecisionTaskStartedEventAttributes + // If the event is of type DecisionTaskTimedOut then this member is set and // provides detailed information about the event. It isn't set for other event // types. DecisionTaskTimedOutEventAttributes *DecisionTaskTimedOutEventAttributes - // Provides the details of the ScheduleLambdaFunctionFailed event. It isn't set for - // other event types. - ScheduleLambdaFunctionFailedEventAttributes *ScheduleLambdaFunctionFailedEventAttributes + // If the event is of type ExternalWorkflowExecutionCancelRequested then this + // member is set and provides detailed information about the event. It isn't set + // for other event types. + ExternalWorkflowExecutionCancelRequestedEventAttributes *ExternalWorkflowExecutionCancelRequestedEventAttributes - // If the event is of type StartTimerFailed then this member is set and provides - // detailed information about the event. It isn't set for other event types. - StartTimerFailedEventAttributes *StartTimerFailedEventAttributes + // If the event is of type ExternalWorkflowExecutionSignaled then this member is + // set and provides detailed information about the event. It isn't set for other + // event types. + ExternalWorkflowExecutionSignaledEventAttributes *ExternalWorkflowExecutionSignaledEventAttributes - // If the event is of type WorkflowExecutionSignaled then this member is set and + // If the event is of type FailWorkflowExecutionFailed then this member is set and // provides detailed information about the event. It isn't set for other event // types. - WorkflowExecutionSignaledEventAttributes *WorkflowExecutionSignaledEventAttributes + FailWorkflowExecutionFailedEventAttributes *FailWorkflowExecutionFailedEventAttributes - // If the event is of type TimerCanceled then this member is set and provides + // Provides the details of the LambdaFunctionCompleted event. It isn't set for + // other event types. + LambdaFunctionCompletedEventAttributes *LambdaFunctionCompletedEventAttributes + + // Provides the details of the LambdaFunctionFailed event. It isn't set for other + // event types. + LambdaFunctionFailedEventAttributes *LambdaFunctionFailedEventAttributes + + // Provides the details of the LambdaFunctionScheduled event. It isn't set for + // other event types. + LambdaFunctionScheduledEventAttributes *LambdaFunctionScheduledEventAttributes + + // Provides the details of the LambdaFunctionStarted event. It isn't set for other + // event types. + LambdaFunctionStartedEventAttributes *LambdaFunctionStartedEventAttributes + + // Provides the details of the LambdaFunctionTimedOut event. It isn't set for other + // event types. + LambdaFunctionTimedOutEventAttributes *LambdaFunctionTimedOutEventAttributes + + // If the event is of type MarkerRecorded then this member is set and provides // detailed information about the event. It isn't set for other event types. - TimerCanceledEventAttributes *TimerCanceledEventAttributes + MarkerRecordedEventAttributes *MarkerRecordedEventAttributes + + // If the event is of type DecisionTaskFailed then this member is set and provides + // detailed information about the event. It isn't set for other event types. + RecordMarkerFailedEventAttributes *RecordMarkerFailedEventAttributes // If the event is of type RequestCancelActivityTaskFailed then this member is set // and provides detailed information about the event. It isn't set for other event // types. RequestCancelActivityTaskFailedEventAttributes *RequestCancelActivityTaskFailedEventAttributes - // If the event is of type WorkflowExecutionCanceled then this member is set and - // provides detailed information about the event. It isn't set for other event - // types. - WorkflowExecutionCanceledEventAttributes *WorkflowExecutionCanceledEventAttributes + // If the event is of type RequestCancelExternalWorkflowExecutionFailed then this + // member is set and provides detailed information about the event. It isn't set + // for other event types. + RequestCancelExternalWorkflowExecutionFailedEventAttributes *RequestCancelExternalWorkflowExecutionFailedEventAttributes + + // If the event is of type RequestCancelExternalWorkflowExecutionInitiated then + // this member is set and provides detailed information about the event. It isn't + // set for other event types. + RequestCancelExternalWorkflowExecutionInitiatedEventAttributes *RequestCancelExternalWorkflowExecutionInitiatedEventAttributes // If the event is of type ScheduleActivityTaskFailed then this member is set and // provides detailed information about the event. It isn't set for other event // types. ScheduleActivityTaskFailedEventAttributes *ScheduleActivityTaskFailedEventAttributes - // If the event is of type ActivityTaskcancelRequested then this member is set and - // provides detailed information about the event. It isn't set for other event - // types. - ActivityTaskCancelRequestedEventAttributes *ActivityTaskCancelRequestedEventAttributes + // Provides the details of the ScheduleLambdaFunctionFailed event. It isn't set for + // other event types. + ScheduleLambdaFunctionFailedEventAttributes *ScheduleLambdaFunctionFailedEventAttributes - // If the event is of type TimerFired then this member is set and provides detailed - // information about the event. It isn't set for other event types. - TimerFiredEventAttributes *TimerFiredEventAttributes + // If the event is of type SignalExternalWorkflowExecutionFailed then this member + // is set and provides detailed information about the event. It isn't set for other + // event types. + SignalExternalWorkflowExecutionFailedEventAttributes *SignalExternalWorkflowExecutionFailedEventAttributes - // If the event is of type ChildWorkflowExecutionTerminated then this member is set - // and provides detailed information about the event. It isn't set for other event - // types. - ChildWorkflowExecutionTerminatedEventAttributes *ChildWorkflowExecutionTerminatedEventAttributes + // If the event is of type SignalExternalWorkflowExecutionInitiated then this + // member is set and provides detailed information about the event. It isn't set + // for other event types. + SignalExternalWorkflowExecutionInitiatedEventAttributes *SignalExternalWorkflowExecutionInitiatedEventAttributes // If the event is of type StartChildWorkflowExecutionFailed then this member is // set and provides detailed information about the event. It isn't set for other // event types. StartChildWorkflowExecutionFailedEventAttributes *StartChildWorkflowExecutionFailedEventAttributes - // The type of the history event. - // - // This member is required. - EventType EventType - - // Provides the details of the LambdaFunctionFailed event. It isn't set for other - // event types. - LambdaFunctionFailedEventAttributes *LambdaFunctionFailedEventAttributes - - // If the event is of type CancelWorkflowExecutionFailed then this member is set - // and provides detailed information about the event. It isn't set for other event - // types. - CancelWorkflowExecutionFailedEventAttributes *CancelWorkflowExecutionFailedEventAttributes - - // If the event is of type WorkflowExecutionTerminated then this member is set and - // provides detailed information about the event. It isn't set for other event - // types. - WorkflowExecutionTerminatedEventAttributes *WorkflowExecutionTerminatedEventAttributes - - // If the event is of type MarkerRecorded then this member is set and provides - // detailed information about the event. It isn't set for other event types. - MarkerRecordedEventAttributes *MarkerRecordedEventAttributes - // If the event is of type StartChildWorkflowExecutionInitiated then this member is // set and provides detailed information about the event. It isn't set for other // event types. StartChildWorkflowExecutionInitiatedEventAttributes *StartChildWorkflowExecutionInitiatedEventAttributes - // If the event is of type ActivityTaskStarted then this member is set and provides + // Provides the details of the StartLambdaFunctionFailed event. It isn't set for + // other event types. + StartLambdaFunctionFailedEventAttributes *StartLambdaFunctionFailedEventAttributes + + // If the event is of type StartTimerFailed then this member is set and provides // detailed information about the event. It isn't set for other event types. - ActivityTaskStartedEventAttributes *ActivityTaskStartedEventAttributes + StartTimerFailedEventAttributes *StartTimerFailedEventAttributes - // If the event is of type FailWorkflowExecutionFailed then this member is set and - // provides detailed information about the event. It isn't set for other event - // types. - FailWorkflowExecutionFailedEventAttributes *FailWorkflowExecutionFailedEventAttributes + // If the event is of type TimerCanceled then this member is set and provides + // detailed information about the event. It isn't set for other event types. + TimerCanceledEventAttributes *TimerCanceledEventAttributes - // The date and time when the event occurred. - // - // This member is required. - EventTimestamp *time.Time + // If the event is of type TimerFired then this member is set and provides detailed + // information about the event. It isn't set for other event types. + TimerFiredEventAttributes *TimerFiredEventAttributes - // If the event is of type ExternalWorkflowExecutionCancelRequested then this - // member is set and provides detailed information about the event. It isn't set - // for other event types. - ExternalWorkflowExecutionCancelRequestedEventAttributes *ExternalWorkflowExecutionCancelRequestedEventAttributes + // If the event is of type TimerStarted then this member is set and provides + // detailed information about the event. It isn't set for other event types. + TimerStartedEventAttributes *TimerStartedEventAttributes - // If the event is of type ActivityTaskScheduled then this member is set and - // provides detailed information about the event. It isn't set for other event + // If the event is of type WorkflowExecutionCancelRequested then this member is set + // and provides detailed information about the event. It isn't set for other event // types. - ActivityTaskScheduledEventAttributes *ActivityTaskScheduledEventAttributes - - // If the event is of type SignalExternalWorkflowExecutionInitiated then this - // member is set and provides detailed information about the event. It isn't set - // for other event types. - SignalExternalWorkflowExecutionInitiatedEventAttributes *SignalExternalWorkflowExecutionInitiatedEventAttributes + WorkflowExecutionCancelRequestedEventAttributes *WorkflowExecutionCancelRequestedEventAttributes - // If the event is of type ActivityTaskCompleted then this member is set and + // If the event is of type WorkflowExecutionCanceled then this member is set and // provides detailed information about the event. It isn't set for other event // types. - ActivityTaskCompletedEventAttributes *ActivityTaskCompletedEventAttributes + WorkflowExecutionCanceledEventAttributes *WorkflowExecutionCanceledEventAttributes // If the event is of type WorkflowExecutionCompleted then this member is set and // provides detailed information about the event. It isn't set for other event // types. WorkflowExecutionCompletedEventAttributes *WorkflowExecutionCompletedEventAttributes + // If the event is of type WorkflowExecutionContinuedAsNew then this member is set + // and provides detailed information about the event. It isn't set for other event + // types. + WorkflowExecutionContinuedAsNewEventAttributes *WorkflowExecutionContinuedAsNewEventAttributes + // If the event is of type WorkflowExecutionFailed then this member is set and // provides detailed information about the event. It isn't set for other event // types. WorkflowExecutionFailedEventAttributes *WorkflowExecutionFailedEventAttributes - // If the event is of type ChildWorkflowExecutionFailed then this member is set and + // If the event is of type WorkflowExecutionSignaled then this member is set and // provides detailed information about the event. It isn't set for other event // types. - ChildWorkflowExecutionFailedEventAttributes *ChildWorkflowExecutionFailedEventAttributes + WorkflowExecutionSignaledEventAttributes *WorkflowExecutionSignaledEventAttributes - // If the event is of type ActivityTaskTimedOut then this member is set and + // If the event is of type WorkflowExecutionStarted then this member is set and // provides detailed information about the event. It isn't set for other event // types. - ActivityTaskTimedOutEventAttributes *ActivityTaskTimedOutEventAttributes + WorkflowExecutionStartedEventAttributes *WorkflowExecutionStartedEventAttributes + + // If the event is of type WorkflowExecutionTerminated then this member is set and + // provides detailed information about the event. It isn't set for other event + // types. + WorkflowExecutionTerminatedEventAttributes *WorkflowExecutionTerminatedEventAttributes + + // If the event is of type WorkflowExecutionTimedOut then this member is set and + // provides detailed information about the event. It isn't set for other event + // types. + WorkflowExecutionTimedOutEventAttributes *WorkflowExecutionTimedOutEventAttributes } // Provides the details of the LambdaFunctionCompleted event. It isn't set for // other event types. type LambdaFunctionCompletedEventAttributes struct { + // The ID of the LambdaFunctionScheduled event that was recorded when this Lambda + // task was scheduled. To help diagnose issues, use this information to trace back + // the chain of events leading up to this event. + // + // This member is required. + ScheduledEventId *int64 + // The ID of the LambdaFunctionStarted event recorded when this activity task // started. To help diagnose issues, use this information to trace back the chain // of events leading up to this event. @@ -1647,21 +1654,18 @@ type LambdaFunctionCompletedEventAttributes struct { // The results of the Lambda task. Result *string - - // The ID of the LambdaFunctionScheduled event that was recorded when this Lambda - // task was scheduled. To help diagnose issues, use this information to trace back - // the chain of events leading up to this event. - // - // This member is required. - ScheduledEventId *int64 } // Provides the details of the LambdaFunctionFailed event. It isn't set for other // event types. type LambdaFunctionFailedEventAttributes struct { - // The details of the failure. - Details *string + // The ID of the LambdaFunctionScheduled event that was recorded when this activity + // task was scheduled. To help diagnose issues, use this information to trace back + // the chain of events leading up to this event. + // + // This member is required. + ScheduledEventId *int64 // The ID of the LambdaFunctionStarted event recorded when this activity task // started. To help diagnose issues, use this information to trace back the chain @@ -1670,31 +1674,17 @@ type LambdaFunctionFailedEventAttributes struct { // This member is required. StartedEventId *int64 + // The details of the failure. + Details *string + // The reason provided for the failure. Reason *string - - // The ID of the LambdaFunctionScheduled event that was recorded when this activity - // task was scheduled. To help diagnose issues, use this information to trace back - // the chain of events leading up to this event. - // - // This member is required. - ScheduledEventId *int64 } // Provides the details of the LambdaFunctionScheduled event. It isn't set for // other event types. type LambdaFunctionScheduledEventAttributes struct { - // The maximum amount of time a worker can take to process the Lambda task. - StartToCloseTimeout *string - - // The input provided to the Lambda task. - Input *string - - // Data attached to the event that the decider can use in subsequent workflow - // tasks. This data isn't sent to the Lambda task. - Control *string - // The ID of the LambdaFunctionCompleted event corresponding to the decision that // resulted in scheduling this activity task. To help diagnose issues, use this // information to trace back the chain of events leading up to this event. @@ -1711,6 +1701,16 @@ type LambdaFunctionScheduledEventAttributes struct { // // This member is required. Name *string + + // Data attached to the event that the decider can use in subsequent workflow + // tasks. This data isn't sent to the Lambda task. + Control *string + + // The input provided to the Lambda task. + Input *string + + // The maximum amount of time a worker can take to process the Lambda task. + StartToCloseTimeout *string } // Provides the details of the LambdaFunctionStarted event. It isn't set for other @@ -1800,6 +1800,16 @@ type RecordMarkerDecisionAttributes struct { // Provides the details of the RecordMarkerFailed event. type RecordMarkerFailedEventAttributes struct { + // The cause of the failure. This information is generated by the system and can be + // useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the + // decision failed because it lacked sufficient permissions. For details and + // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows + // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) + // in the Amazon SWF Developer Guide. + // + // This member is required. + Cause RecordMarkerFailedCause + // The ID of the DecisionTaskCompleted event corresponding to the decision task // that resulted in the RecordMarkerFailed decision for this cancellation request. // This information can be useful for diagnosing problems by tracing back the chain @@ -1812,16 +1822,6 @@ type RecordMarkerFailedEventAttributes struct { // // This member is required. MarkerName *string - - // The cause of the failure. This information is generated by the system and can be - // useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the - // decision failed because it lacked sufficient permissions. For details and - // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) - // in the Amazon SWF Developer Guide. - // - // This member is required. - Cause RecordMarkerFailedCause } // Provides the details of the RequestCancelActivityTask decision. Access Control @@ -1917,6 +1917,24 @@ type RequestCancelExternalWorkflowExecutionDecisionAttributes struct { // Provides the details of the RequestCancelExternalWorkflowExecutionFailed event. type RequestCancelExternalWorkflowExecutionFailedEventAttributes struct { + // The cause of the failure. This information is generated by the system and can be + // useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the + // decision failed because it lacked sufficient permissions. For details and + // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows + // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) + // in the Amazon SWF Developer Guide. + // + // This member is required. + Cause RequestCancelExternalWorkflowExecutionFailedCause + + // The ID of the DecisionTaskCompleted event corresponding to the decision task + // that resulted in the RequestCancelExternalWorkflowExecution decision for this + // cancellation request. This information can be useful for diagnosing problems by + // tracing back the chain of events leading up to this event. + // + // This member is required. + DecisionTaskCompletedEventId *int64 + // The ID of the RequestCancelExternalWorkflowExecutionInitiated event // corresponding to the RequestCancelExternalWorkflowExecution decision to cancel // this external workflow execution. This information can be useful for diagnosing @@ -1925,54 +1943,24 @@ type RequestCancelExternalWorkflowExecutionFailedEventAttributes struct { // This member is required. InitiatedEventId *int64 - // The runId of the external workflow execution. - RunId *string - // The workflowId of the external workflow to which the cancel request was to be // delivered. // // This member is required. WorkflowId *string - // The ID of the DecisionTaskCompleted event corresponding to the decision task - // that resulted in the RequestCancelExternalWorkflowExecution decision for this - // cancellation request. This information can be useful for diagnosing problems by - // tracing back the chain of events leading up to this event. - // - // This member is required. - DecisionTaskCompletedEventId *int64 - // The data attached to the event that the decider can use in subsequent workflow // tasks. This data isn't sent to the workflow execution. Control *string - // The cause of the failure. This information is generated by the system and can be - // useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the - // decision failed because it lacked sufficient permissions. For details and - // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) - // in the Amazon SWF Developer Guide. - // - // This member is required. - Cause RequestCancelExternalWorkflowExecutionFailedCause + // The runId of the external workflow execution. + RunId *string } // Provides the details of the RequestCancelExternalWorkflowExecutionInitiated // event. type RequestCancelExternalWorkflowExecutionInitiatedEventAttributes struct { - // The runId of the external workflow execution to be canceled. - RunId *string - - // Data attached to the event that can be used by the decider in subsequent - // workflow tasks. - Control *string - - // The workflowId of the external workflow execution to be canceled. - // - // This member is required. - WorkflowId *string - // The ID of the DecisionTaskCompleted event corresponding to the decision task // that resulted in the RequestCancelExternalWorkflowExecution decision for this // cancellation request. This information can be useful for diagnosing problems by @@ -1980,6 +1968,18 @@ type RequestCancelExternalWorkflowExecutionInitiatedEventAttributes struct { // // This member is required. DecisionTaskCompletedEventId *int64 + + // The workflowId of the external workflow execution to be canceled. + // + // This member is required. + WorkflowId *string + + // Data attached to the event that can be used by the decider in subsequent + // workflow tasks. + Control *string + + // The runId of the external workflow execution to be canceled. + RunId *string } // Tags are key-value pairs that can be associated with Amazon SWF state machines @@ -1987,13 +1987,13 @@ type RequestCancelExternalWorkflowExecutionInitiatedEventAttributes struct { // these symbols: _ . : / = + - @. type ResourceTag struct { - // The value of a tag. - Value *string - // The key of a tag. // // This member is required. Key *string + + // The value of a tag. + Value *string } // Provides the details of the ScheduleActivityTask decision. Access Control You @@ -2028,11 +2028,23 @@ type ResourceTag struct { // in the Amazon SWF Developer Guide. type ScheduleActivityTaskDecisionAttributes struct { + // The activityId of the activity task. The specified string must not start or end + // with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), + // or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not + // contain the literal string arn. + // + // This member is required. + ActivityId *string + // The type of the activity task to schedule. // // This member is required. ActivityType *ActivityType + // Data attached to the event that can be used by the decider in subsequent + // workflow tasks. This data isn't sent to the activity. + Control *string + // If set, specifies the maximum time before which a worker processing a task of // this type must report progress by calling RecordActivityTaskHeartbeat (). If the // timeout is exceeded, the activity task is automatically timed out. If the worker @@ -2043,6 +2055,9 @@ type ScheduleActivityTaskDecisionAttributes struct { // unlimited duration. HeartbeatTimeout *string + // The input provided to the activity task. + Input *string + // The maximum duration for this activity task. The duration is specified in // seconds, an integer greater than or equal to 0. You can use NONE to specify // unlimited duration. A schedule-to-close timeout for this activity task must be @@ -2051,15 +2066,15 @@ type ScheduleActivityTaskDecisionAttributes struct { // at registration time then a fault is returned. ScheduleToCloseTimeout *string - // If set, specifies the priority with which the activity task is to be assigned to - // a worker. This overrides the defaultTaskPriority specified when registering the - // activity type using RegisterActivityType (). Valid values are integers that - // range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE - // (2147483647). Higher numbers indicate higher priority. For more information - // about setting task priority, see Setting Task Priority - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) - // in the Amazon SWF Developer Guide. - TaskPriority *string + // If set, specifies the maximum duration the activity task can wait to be assigned + // to a worker. This overrides the default schedule-to-start timeout specified when + // registering the activity type using RegisterActivityType (). The duration is + // specified in seconds, an integer greater than or equal to 0. You can use NONE to + // specify unlimited duration. A schedule-to-start timeout for this activity task + // must be specified either as a default for the activity type or through this + // field. If neither this field is set nor a default schedule-to-start timeout was + // specified at registration time then a fault is returned. + ScheduleToStartTimeout *string // If set, specifies the maximum duration a worker may take to process this // activity task. This overrides the default start-to-close timeout specified when @@ -2082,34 +2097,29 @@ type ScheduleActivityTaskDecisionAttributes struct { // arn. TaskList *TaskList - // If set, specifies the maximum duration the activity task can wait to be assigned - // to a worker. This overrides the default schedule-to-start timeout specified when - // registering the activity type using RegisterActivityType (). The duration is - // specified in seconds, an integer greater than or equal to 0. You can use NONE to - // specify unlimited duration. A schedule-to-start timeout for this activity task - // must be specified either as a default for the activity type or through this - // field. If neither this field is set nor a default schedule-to-start timeout was - // specified at registration time then a fault is returned. - ScheduleToStartTimeout *string + // If set, specifies the priority with which the activity task is to be assigned to + // a worker. This overrides the defaultTaskPriority specified when registering the + // activity type using RegisterActivityType (). Valid values are integers that + // range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE + // (2147483647). Higher numbers indicate higher priority. For more information + // about setting task priority, see Setting Task Priority + // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) + // in the Amazon SWF Developer Guide. + TaskPriority *string +} - // The input provided to the activity task. - Input *string +// Provides the details of the ScheduleActivityTaskFailed event. +type ScheduleActivityTaskFailedEventAttributes struct { - // The activityId of the activity task. The specified string must not start or end - // with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), - // or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not - // contain the literal string arn. + // The activityId provided in the ScheduleActivityTask decision that failed. // // This member is required. ActivityId *string - // Data attached to the event that can be used by the decider in subsequent - // workflow tasks. This data isn't sent to the activity. - Control *string -} - -// Provides the details of the ScheduleActivityTaskFailed event. -type ScheduleActivityTaskFailedEventAttributes struct { + // The activity type provided in the ScheduleActivityTask decision that failed. + // + // This member is required. + ActivityType *ActivityType // The cause of the failure. This information is generated by the system and can be // useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the @@ -2128,29 +2138,12 @@ type ScheduleActivityTaskFailedEventAttributes struct { // // This member is required. DecisionTaskCompletedEventId *int64 - - // The activity type provided in the ScheduleActivityTask decision that failed. - // - // This member is required. - ActivityType *ActivityType - - // The activityId provided in the ScheduleActivityTask decision that failed. - // - // This member is required. - ActivityId *string } // Decision attributes specified in scheduleLambdaFunctionDecisionAttributes within // the list of decisions decisions passed to RespondDecisionTaskCompleted (). type ScheduleLambdaFunctionDecisionAttributes struct { - // The optional input data to be supplied to the Lambda function. - Input *string - - // The data attached to the event that the decider can use in subsequent workflow - // tasks. This data isn't sent to the Lambda task. - Control *string - // A string that identifies the Lambda function execution in the event history. // // This member is required. @@ -2161,6 +2154,13 @@ type ScheduleLambdaFunctionDecisionAttributes struct { // This member is required. Name *string + // The data attached to the event that the decider can use in subsequent workflow + // tasks. This data isn't sent to the Lambda task. + Control *string + + // The optional input data to be supplied to the Lambda function. + Input *string + // The timeout value, in seconds, after which the Lambda function is considered to // be failed once it has started. This can be any integer from 1-300 (1s-5m). If no // value is supplied, than a default value of 300s is assumed. @@ -2171,13 +2171,6 @@ type ScheduleLambdaFunctionDecisionAttributes struct { // other event types. type ScheduleLambdaFunctionFailedEventAttributes struct { - // The ID of the LambdaFunctionCompleted event corresponding to the decision that - // resulted in scheduling this Lambda task. To help diagnose issues, use this - // information to trace back the chain of events leading up to this event. - // - // This member is required. - DecisionTaskCompletedEventId *int64 - // The cause of the failure. To help diagnose issues, use this information to trace // back the chain of events leading up to this event. If cause is set to // OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient @@ -2189,6 +2182,13 @@ type ScheduleLambdaFunctionFailedEventAttributes struct { // This member is required. Cause ScheduleLambdaFunctionFailedCause + // The ID of the LambdaFunctionCompleted event corresponding to the decision that + // resulted in scheduling this Lambda task. To help diagnose issues, use this + // information to trace back the chain of events leading up to this event. + // + // This member is required. + DecisionTaskCompletedEventId *int64 + // The ID provided in the ScheduleLambdaFunction decision that failed. // // This member is required. @@ -2222,14 +2222,17 @@ type ScheduleLambdaFunctionFailedEventAttributes struct { // in the Amazon SWF Developer Guide. type SignalExternalWorkflowExecutionDecisionAttributes struct { + // The name of the signal.The target workflow execution uses the signal name and + // input to process the signal. + // + // This member is required. + SignalName *string + // The workflowId of the workflow execution to be signaled. // // This member is required. WorkflowId *string - // The runId of the workflow execution to be signaled. - RunId *string - // The data attached to the event that can be used by the decider in subsequent // decision tasks. Control *string @@ -2238,38 +2241,13 @@ type SignalExternalWorkflowExecutionDecisionAttributes struct { // uses the signal name and input data to process the signal. Input *string - // The name of the signal.The target workflow execution uses the signal name and - // input to process the signal. - // - // This member is required. - SignalName *string + // The runId of the workflow execution to be signaled. + RunId *string } // Provides the details of the SignalExternalWorkflowExecutionFailed event. type SignalExternalWorkflowExecutionFailedEventAttributes struct { - // The data attached to the event that the decider can use in subsequent workflow - // tasks. This data isn't sent to the workflow execution. - Control *string - - // The ID of the DecisionTaskCompleted event corresponding to the decision task - // that resulted in the SignalExternalWorkflowExecution decision for this signal. - // This information can be useful for diagnosing problems by tracing back the chain - // of events leading up to this event. - // - // This member is required. - DecisionTaskCompletedEventId *int64 - - // The runId of the external workflow execution that the signal was being delivered - // to. - RunId *string - - // The workflowId of the external workflow execution that the signal was being - // delivered to. - // - // This member is required. - WorkflowId *string - // The cause of the failure. This information is generated by the system and can be // useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the // decision failed because it lacked sufficient permissions. For details and @@ -2280,6 +2258,14 @@ type SignalExternalWorkflowExecutionFailedEventAttributes struct { // This member is required. Cause SignalExternalWorkflowExecutionFailedCause + // The ID of the DecisionTaskCompleted event corresponding to the decision task + // that resulted in the SignalExternalWorkflowExecution decision for this signal. + // This information can be useful for diagnosing problems by tracing back the chain + // of events leading up to this event. + // + // This member is required. + DecisionTaskCompletedEventId *int64 + // The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to // the SignalExternalWorkflowExecution decision to request this signal. This // information can be useful for diagnosing problems by tracing back the chain of @@ -2287,20 +2273,32 @@ type SignalExternalWorkflowExecutionFailedEventAttributes struct { // // This member is required. InitiatedEventId *int64 -} -// Provides the details of the SignalExternalWorkflowExecutionInitiated event. -type SignalExternalWorkflowExecutionInitiatedEventAttributes struct { + // The workflowId of the external workflow execution that the signal was being + // delivered to. + // + // This member is required. + WorkflowId *string - // The runId of the external workflow execution to send the signal to. + // The data attached to the event that the decider can use in subsequent workflow + // tasks. This data isn't sent to the workflow execution. + Control *string + + // The runId of the external workflow execution that the signal was being delivered + // to. RunId *string +} - // Data attached to the event that can be used by the decider in subsequent - // decision tasks. - Control *string +// Provides the details of the SignalExternalWorkflowExecutionInitiated event. +type SignalExternalWorkflowExecutionInitiatedEventAttributes struct { - // The input provided to the signal. - Input *string + // The ID of the DecisionTaskCompleted event corresponding to the decision task + // that resulted in the SignalExternalWorkflowExecution decision for this signal. + // This information can be useful for diagnosing problems by tracing back the chain + // of events leading up to this event. + // + // This member is required. + DecisionTaskCompletedEventId *int64 // The name of the signal. // @@ -2312,13 +2310,15 @@ type SignalExternalWorkflowExecutionInitiatedEventAttributes struct { // This member is required. WorkflowId *string - // The ID of the DecisionTaskCompleted event corresponding to the decision task - // that resulted in the SignalExternalWorkflowExecution decision for this signal. - // This information can be useful for diagnosing problems by tracing back the chain - // of events leading up to this event. - // - // This member is required. - DecisionTaskCompletedEventId *int64 + // Data attached to the event that can be used by the decider in subsequent + // decision tasks. + Control *string + + // The input provided to the signal. + Input *string + + // The runId of the external workflow execution to send the signal to. + RunId *string } // Provides the details of the StartChildWorkflowExecution decision. Access Control @@ -2356,36 +2356,47 @@ type SignalExternalWorkflowExecutionInitiatedEventAttributes struct { // in the Amazon SWF Developer Guide. type StartChildWorkflowExecutionDecisionAttributes struct { - // Specifies the maximum duration of decision tasks for this workflow execution. - // This parameter overrides the defaultTaskStartToCloseTimout specified when - // registering the workflow type using RegisterWorkflowType (). The duration is - // specified in seconds, an integer greater than or equal to 0. You can use NONE to - // specify unlimited duration. A task start-to-close timeout for this workflow - // execution must be specified either as a default for the workflow type or through - // this parameter. If neither this parameter is set nor a default task - // start-to-close timeout was specified at registration time then a fault is - // returned. - TaskStartToCloseTimeout *string + // The workflowId of the workflow execution. The specified string must not start or + // end with whitespace. It must not contain a : (colon), / (slash), | (vertical + // bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must + // not contain the literal string arn. + // + // This member is required. + WorkflowId *string // The type of the workflow execution to be started. // // This member is required. WorkflowType *WorkflowType + // If set, specifies the policy to use for the child workflow executions if the + // workflow execution being started is terminated by calling the + // TerminateWorkflowExecution () action explicitly or due to an expired timeout. + // This policy overrides the default child policy specified when registering the + // workflow type using RegisterWorkflowType (). The supported child policies are: + // + // + // * TERMINATE – The child executions are terminated. + // + // * REQUEST_CANCEL – A + // request to cancel is attempted for each child execution by recording a + // WorkflowExecutionCancelRequested event in its history. It is up to the decider + // to take appropriate actions when it receives an execution history with this + // event. + // + // * ABANDON – No action is taken. The child executions continue to + // run. + // + // A child policy for this workflow execution must be specified either as a + // default for the workflow type or through this parameter. If neither this + // parameter is set nor a default child policy was specified at registration time + // then a fault is returned. + ChildPolicy ChildPolicy + // The data attached to the event that can be used by the decider in subsequent // workflow tasks. This data isn't sent to the child workflow execution. Control *string - // A task priority that, if set, specifies the priority for a decision task of this - // workflow execution. This overrides the defaultTaskPriority specified when - // registering the workflow type. Valid values are integers that range from Java's - // Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher - // numbers indicate higher priority. For more information about setting task - // priority, see Setting Task Priority - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) - // in the Amazon SWF Developer Guide. - TaskPriority *string - // The total duration for this workflow execution. This overrides the // defaultExecutionStartToCloseTimeout specified when registering the workflow // type. The duration is specified in seconds, an integer greater than or equal to @@ -2396,6 +2407,18 @@ type StartChildWorkflowExecutionDecisionAttributes struct { // time then a fault is returned. ExecutionStartToCloseTimeout *string + // The input to be provided to the workflow execution. + Input *string + + // The IAM role attached to the child workflow execution. + LambdaRole *string + + // The list of tags to associate with the child workflow execution. A maximum of 5 + // tags can be specified. You can list workflow executions with a specific tag by + // calling ListOpenWorkflowExecutions () or ListClosedWorkflowExecutions () and + // specifying a TagFilter (). + TagList []*string + // The name of the task list to be used for decision tasks of the child workflow // execution. A task list for this workflow execution must be specified either as a // default for the workflow type or through this parameter. If neither this @@ -2406,37 +2429,88 @@ type StartChildWorkflowExecutionDecisionAttributes struct { // literal string arn. TaskList *TaskList - // The workflowId of the workflow execution. The specified string must not start or - // end with whitespace. It must not contain a : (colon), / (slash), | (vertical - // bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must - // not contain the literal string arn. + // A task priority that, if set, specifies the priority for a decision task of this + // workflow execution. This overrides the defaultTaskPriority specified when + // registering the workflow type. Valid values are integers that range from Java's + // Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher + // numbers indicate higher priority. For more information about setting task + // priority, see Setting Task Priority + // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) + // in the Amazon SWF Developer Guide. + TaskPriority *string + + // Specifies the maximum duration of decision tasks for this workflow execution. + // This parameter overrides the defaultTaskStartToCloseTimout specified when + // registering the workflow type using RegisterWorkflowType (). The duration is + // specified in seconds, an integer greater than or equal to 0. You can use NONE to + // specify unlimited duration. A task start-to-close timeout for this workflow + // execution must be specified either as a default for the workflow type or through + // this parameter. If neither this parameter is set nor a default task + // start-to-close timeout was specified at registration time then a fault is + // returned. + TaskStartToCloseTimeout *string +} + +// Provides the details of the StartChildWorkflowExecutionFailed event. +type StartChildWorkflowExecutionFailedEventAttributes struct { + + // The cause of the failure. This information is generated by the system and can be + // useful for diagnostic purposes. When cause is set to OPERATION_NOT_PERMITTED, + // the decision fails because it lacks sufficient permissions. For details and + // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows + // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) + // in the Amazon SWF Developer Guide. // // This member is required. - WorkflowId *string + Cause StartChildWorkflowExecutionFailedCause - // The IAM role attached to the child workflow execution. - LambdaRole *string + // The ID of the DecisionTaskCompleted event corresponding to the decision task + // that resulted in the StartChildWorkflowExecutionDecision () to request this + // child workflow execution. This information can be useful for diagnosing problems + // by tracing back the chain of events. + // + // This member is required. + DecisionTaskCompletedEventId *int64 - // The input to be provided to the workflow execution. - Input *string + // When the cause is WORKFLOW_ALREADY_RUNNING, initiatedEventId is the ID of the + // StartChildWorkflowExecutionInitiated event that corresponds to the + // StartChildWorkflowExecutionDecision () to start the workflow execution. You can + // use this information to diagnose problems by tracing back the chain of events + // leading up to this event. When the cause isn't WORKFLOW_ALREADY_RUNNING, + // initiatedEventId is set to 0 because the StartChildWorkflowExecutionInitiated + // event doesn't exist. + // + // This member is required. + InitiatedEventId *int64 - // The list of tags to associate with the child workflow execution. A maximum of 5 - // tags can be specified. You can list workflow executions with a specific tag by - // calling ListOpenWorkflowExecutions () or ListClosedWorkflowExecutions () and - // specifying a TagFilter (). - TagList []*string + // The workflowId of the child workflow execution. + // + // This member is required. + WorkflowId *string - // If set, specifies the policy to use for the child workflow executions if the - // workflow execution being started is terminated by calling the - // TerminateWorkflowExecution () action explicitly or due to an expired timeout. - // This policy overrides the default child policy specified when registering the - // workflow type using RegisterWorkflowType (). The supported child policies are: + // The workflow type provided in the StartChildWorkflowExecutionDecision () that + // failed. // + // This member is required. + WorkflowType *WorkflowType + + // The data attached to the event that the decider can use in subsequent workflow + // tasks. This data isn't sent to the child workflow execution. + Control *string +} + +// Provides the details of the StartChildWorkflowExecutionInitiated event. +type StartChildWorkflowExecutionInitiatedEventAttributes struct { + + // The policy to use for the child workflow executions if this execution gets + // terminated by explicitly calling the TerminateWorkflowExecution () action or due + // to an expired timeout. The supported child policies are: // - // * TERMINATE – The child executions are terminated. + // * TERMINATE – The + // child executions are terminated. // - // * REQUEST_CANCEL – A - // request to cancel is attempted for each child execution by recording a + // * REQUEST_CANCEL – A request to cancel is + // attempted for each child execution by recording a // WorkflowExecutionCancelRequested event in its history. It is up to the decider // to take appropriate actions when it receives an execution history with this // event. @@ -2444,72 +2518,36 @@ type StartChildWorkflowExecutionDecisionAttributes struct { // * ABANDON – No action is taken. The child executions continue to // run. // - // A child policy for this workflow execution must be specified either as a - // default for the workflow type or through this parameter. If neither this - // parameter is set nor a default child policy was specified at registration time - // then a fault is returned. + // This member is required. ChildPolicy ChildPolicy -} - -// Provides the details of the StartChildWorkflowExecutionFailed event. -type StartChildWorkflowExecutionFailedEventAttributes struct { // The ID of the DecisionTaskCompleted event corresponding to the decision task // that resulted in the StartChildWorkflowExecutionDecision () to request this // child workflow execution. This information can be useful for diagnosing problems - // by tracing back the chain of events. - // - // This member is required. - DecisionTaskCompletedEventId *int64 - - // The workflowId of the child workflow execution. - // - // This member is required. - WorkflowId *string - - // The cause of the failure. This information is generated by the system and can be - // useful for diagnostic purposes. When cause is set to OPERATION_NOT_PERMITTED, - // the decision fails because it lacks sufficient permissions. For details and - // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) - // in the Amazon SWF Developer Guide. + // by tracing back the cause of events. // // This member is required. - Cause StartChildWorkflowExecutionFailedCause + DecisionTaskCompletedEventId *int64 - // When the cause is WORKFLOW_ALREADY_RUNNING, initiatedEventId is the ID of the - // StartChildWorkflowExecutionInitiated event that corresponds to the - // StartChildWorkflowExecutionDecision () to start the workflow execution. You can - // use this information to diagnose problems by tracing back the chain of events - // leading up to this event. When the cause isn't WORKFLOW_ALREADY_RUNNING, - // initiatedEventId is set to 0 because the StartChildWorkflowExecutionInitiated - // event doesn't exist. + // The name of the task list used for the decision tasks of the child workflow + // execution. // // This member is required. - InitiatedEventId *int64 + TaskList *TaskList - // The data attached to the event that the decider can use in subsequent workflow - // tasks. This data isn't sent to the child workflow execution. - Control *string + // The workflowId of the child workflow execution. + // + // This member is required. + WorkflowId *string - // The workflow type provided in the StartChildWorkflowExecutionDecision () that - // failed. + // The type of the child workflow execution. // // This member is required. WorkflowType *WorkflowType -} - -// Provides the details of the StartChildWorkflowExecutionInitiated event. -type StartChildWorkflowExecutionInitiatedEventAttributes struct { - - // The list of tags to associated with the child workflow execution. - TagList []*string - - // The inputs provided to the child workflow execution. - Input *string - // The IAM role to attach to the child workflow execution. - LambdaRole *string + // Data attached to the event that can be used by the decider in subsequent + // decision tasks. This data isn't sent to the activity. + Control *string // The maximum duration for the child workflow execution. If the workflow execution // isn't closed within this duration, it is timed out and force-terminated. The @@ -2517,18 +2555,14 @@ type StartChildWorkflowExecutionInitiatedEventAttributes struct { // use NONE to specify unlimited duration. ExecutionStartToCloseTimeout *string - // The ID of the DecisionTaskCompleted event corresponding to the decision task - // that resulted in the StartChildWorkflowExecutionDecision () to request this - // child workflow execution. This information can be useful for diagnosing problems - // by tracing back the cause of events. - // - // This member is required. - DecisionTaskCompletedEventId *int64 + // The inputs provided to the child workflow execution. + Input *string - // The workflowId of the child workflow execution. - // - // This member is required. - WorkflowId *string + // The IAM role to attach to the child workflow execution. + LambdaRole *string + + // The list of tags to associated with the child workflow execution. + TagList []*string // The priority assigned for the decision tasks for this workflow execution. Valid // values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to @@ -2538,58 +2572,16 @@ type StartChildWorkflowExecutionInitiatedEventAttributes struct { // in the Amazon SWF Developer Guide. TaskPriority *string - // Data attached to the event that can be used by the decider in subsequent - // decision tasks. This data isn't sent to the activity. - Control *string - - // The name of the task list used for the decision tasks of the child workflow - // execution. - // - // This member is required. - TaskList *TaskList - - // The type of the child workflow execution. - // - // This member is required. - WorkflowType *WorkflowType - // The maximum duration allowed for the decision tasks for this workflow execution. // The duration is specified in seconds, an integer greater than or equal to 0. You // can use NONE to specify unlimited duration. TaskStartToCloseTimeout *string - - // The policy to use for the child workflow executions if this execution gets - // terminated by explicitly calling the TerminateWorkflowExecution () action or due - // to an expired timeout. The supported child policies are: - // - // * TERMINATE – The - // child executions are terminated. - // - // * REQUEST_CANCEL – A request to cancel is - // attempted for each child execution by recording a - // WorkflowExecutionCancelRequested event in its history. It is up to the decider - // to take appropriate actions when it receives an execution history with this - // event. - // - // * ABANDON – No action is taken. The child executions continue to - // run. - // - // This member is required. - ChildPolicy ChildPolicy } // Provides the details of the StartLambdaFunctionFailed event. It isn't set for // other event types. type StartLambdaFunctionFailedEventAttributes struct { - // The ID of the ActivityTaskScheduled event that was recorded when this activity - // task was scheduled. To help diagnose issues, use this information to trace back - // the chain of events leading up to this event. - ScheduledEventId *int64 - - // A description that can help diagnose the cause of the fault. - Message *string - // The cause of the failure. To help diagnose issues, use this information to trace // back the chain of events leading up to this event. If cause is set to // OPERATION_NOT_PERMITTED, the decision failed because the IAM role attached to @@ -2598,6 +2590,14 @@ type StartLambdaFunctionFailedEventAttributes struct { // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html) // in the Amazon SWF Developer Guide. Cause StartLambdaFunctionFailedCause + + // A description that can help diagnose the cause of the fault. + Message *string + + // The ID of the ActivityTaskScheduled event that was recorded when this activity + // task was scheduled. To help diagnose issues, use this information to trace back + // the chain of events leading up to this event. + ScheduledEventId *int64 } // Provides the details of the StartTimer decision. Access Control You can use IAM @@ -2622,6 +2622,12 @@ type StartLambdaFunctionFailedEventAttributes struct { // in the Amazon SWF Developer Guide. type StartTimerDecisionAttributes struct { + // The duration to wait before firing the timer. The duration is specified in + // seconds, an integer greater than or equal to 0. + // + // This member is required. + StartToFireTimeout *string + // The unique ID of the timer. The specified string must not start or end with // whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any // control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain @@ -2630,12 +2636,6 @@ type StartTimerDecisionAttributes struct { // This member is required. TimerId *string - // The duration to wait before firing the timer. The duration is specified in - // seconds, an integer greater than or equal to 0. - // - // This member is required. - StartToFireTimeout *string - // The data attached to the event that can be used by the decider in subsequent // workflow tasks. Control *string @@ -2644,10 +2644,15 @@ type StartTimerDecisionAttributes struct { // Provides the details of the StartTimerFailed event. type StartTimerFailedEventAttributes struct { - // The timerId provided in the StartTimer decision that failed. + // The cause of the failure. This information is generated by the system and can be + // useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the + // decision failed because it lacked sufficient permissions. For details and + // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows + // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) + // in the Amazon SWF Developer Guide. // // This member is required. - TimerId *string + Cause StartTimerFailedCause // The ID of the DecisionTaskCompleted event corresponding to the decision task // that resulted in the StartTimer decision for this activity task. This @@ -2657,15 +2662,10 @@ type StartTimerFailedEventAttributes struct { // This member is required. DecisionTaskCompletedEventId *int64 - // The cause of the failure. This information is generated by the system and can be - // useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the - // decision failed because it lacked sufficient permissions. For details and - // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) - // in the Amazon SWF Developer Guide. + // The timerId provided in the StartTimer decision that failed. // // This member is required. - Cause StartTimerFailedCause + TimerId *string } // Used to filter the workflow executions in visibility APIs based on a tag. @@ -2691,13 +2691,6 @@ type TaskList struct { // Provides the details of the TimerCanceled event. type TimerCanceledEventAttributes struct { - // The ID of the TimerStarted event that was recorded when this timer was started. - // This information can be useful for diagnosing problems by tracing back the chain - // of events leading up to this event. - // - // This member is required. - StartedEventId *int64 - // The ID of the DecisionTaskCompleted event corresponding to the decision task // that resulted in the CancelTimer decision to cancel this timer. This information // can be useful for diagnosing problems by tracing back the chain of events @@ -2706,6 +2699,13 @@ type TimerCanceledEventAttributes struct { // This member is required. DecisionTaskCompletedEventId *int64 + // The ID of the TimerStarted event that was recorded when this timer was started. + // This information can be useful for diagnosing problems by tracing back the chain + // of events leading up to this event. + // + // This member is required. + StartedEventId *int64 + // The unique ID of the timer that was canceled. // // This member is required. @@ -2715,30 +2715,21 @@ type TimerCanceledEventAttributes struct { // Provides the details of the TimerFired event. type TimerFiredEventAttributes struct { - // The unique ID of the timer that fired. - // - // This member is required. - TimerId *string - // The ID of the TimerStarted event that was recorded when this timer was started. // This information can be useful for diagnosing problems by tracing back the chain // of events leading up to this event. // // This member is required. StartedEventId *int64 -} - -// Provides the details of the TimerStarted event. -type TimerStartedEventAttributes struct { - - // Data attached to the event that can be used by the decider in subsequent - // workflow tasks. - Control *string - // The unique ID of the timer that was started. + // The unique ID of the timer that fired. // // This member is required. TimerId *string +} + +// Provides the details of the TimerStarted event. +type TimerStartedEventAttributes struct { // The ID of the DecisionTaskCompleted event corresponding to the decision task // that resulted in the StartTimer decision for this activity task. This @@ -2753,6 +2744,15 @@ type TimerStartedEventAttributes struct { // // This member is required. StartToFireTimeout *string + + // The unique ID of the timer that was started. + // + // This member is required. + TimerId *string + + // Data attached to the event that can be used by the decider in subsequent + // workflow tasks. + Control *string } // Represents a workflow execution. @@ -2787,6 +2787,12 @@ type WorkflowExecutionCanceledEventAttributes struct { // Provides the details of the WorkflowExecutionCancelRequested event. type WorkflowExecutionCancelRequestedEventAttributes struct { + // If set, indicates that the request to cancel the workflow execution was + // automatically generated, and specifies the cause. This happens if the parent + // workflow execution times out or is terminated, and the child policy is set to + // cancel child executions. + Cause WorkflowExecutionCancelRequestedCause + // The ID of the RequestCancelExternalWorkflowExecutionInitiated event // corresponding to the RequestCancelExternalWorkflowExecution decision to cancel // this workflow execution.The source event with this ID can be found in the @@ -2797,12 +2803,6 @@ type WorkflowExecutionCancelRequestedEventAttributes struct { // The external workflow execution for which the cancellation was requested. ExternalWorkflowExecution *WorkflowExecution - - // If set, indicates that the request to cancel the workflow execution was - // automatically generated, and specifies the cause. This happens if the parent - // workflow execution times out or is terminated, and the child policy is set to - // cancel child executions. - Cause WorkflowExecutionCancelRequestedCause } // Provides the details of the WorkflowExecutionCompleted event. @@ -2845,8 +2845,17 @@ type WorkflowExecutionConfiguration struct { // This member is required. ChildPolicy ChildPolicy - // The IAM role attached to the child workflow execution. - LambdaRole *string + // The total duration for this workflow execution. The duration is specified in + // seconds, an integer greater than or equal to 0. You can use NONE to specify + // unlimited duration. + // + // This member is required. + ExecutionStartToCloseTimeout *string + + // The task list used for the decision tasks generated for this workflow execution. + // + // This member is required. + TaskList *TaskList // The maximum duration allowed for decision tasks for this workflow execution. The // duration is specified in seconds, an integer greater than or equal to 0. You can @@ -2855,6 +2864,9 @@ type WorkflowExecutionConfiguration struct { // This member is required. TaskStartToCloseTimeout *string + // The IAM role attached to the child workflow execution. + LambdaRole *string + // The priority assigned to decision tasks for this workflow execution. Valid // values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to // Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For @@ -2862,18 +2874,6 @@ type WorkflowExecutionConfiguration struct { // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) // in the Amazon SWF Developer Guide. TaskPriority *string - - // The task list used for the decision tasks generated for this workflow execution. - // - // This member is required. - TaskList *TaskList - - // The total duration for this workflow execution. The duration is specified in - // seconds, an integer greater than or equal to 0. You can use NONE to specify - // unlimited duration. - // - // This member is required. - ExecutionStartToCloseTimeout *string } // Provides the details of the WorkflowExecutionContinuedAsNew event. @@ -2898,20 +2898,6 @@ type WorkflowExecutionContinuedAsNewEventAttributes struct { // This member is required. ChildPolicy ChildPolicy - // The workflow type of this execution. - // - // This member is required. - WorkflowType *WorkflowType - - // The maximum duration of decision tasks for the new workflow execution. The - // duration is specified in seconds, an integer greater than or equal to 0. You can - // use NONE to specify unlimited duration. - TaskStartToCloseTimeout *string - - // The priority of the task to use for the decisions of the new (continued) - // workflow execution. - TaskPriority *string - // The ID of the DecisionTaskCompleted event corresponding to the decision task // that resulted in the ContinueAsNewWorkflowExecution decision that started this // execution. This information can be useful for diagnosing problems by tracing @@ -2920,30 +2906,44 @@ type WorkflowExecutionContinuedAsNewEventAttributes struct { // This member is required. DecisionTaskCompletedEventId *int64 - // The input provided to the new workflow execution. - Input *string + // The runId of the new workflow execution. + // + // This member is required. + NewExecutionRunId *string - // The IAM role to attach to the new (continued) workflow execution. - LambdaRole *string + // The task list to use for the decisions of the new (continued) workflow + // execution. + // + // This member is required. + TaskList *TaskList + + // The workflow type of this execution. + // + // This member is required. + WorkflowType *WorkflowType // The total duration allowed for the new workflow execution. The duration is // specified in seconds, an integer greater than or equal to 0. You can use NONE to // specify unlimited duration. ExecutionStartToCloseTimeout *string - // The runId of the new workflow execution. - // - // This member is required. - NewExecutionRunId *string + // The input provided to the new workflow execution. + Input *string - // The task list to use for the decisions of the new (continued) workflow - // execution. - // - // This member is required. - TaskList *TaskList + // The IAM role to attach to the new (continued) workflow execution. + LambdaRole *string // The list of tags associated with the new workflow execution. TagList []*string + + // The priority of the task to use for the decisions of the new (continued) + // workflow execution. + TaskPriority *string + + // The maximum duration of decision tasks for the new workflow execution. The + // duration is specified in seconds, an integer greater than or equal to 0. You can + // use NONE to specify unlimited duration. + TaskStartToCloseTimeout *string } // Provides the details of the WorkflowExecutionFailed event. @@ -2976,6 +2976,29 @@ type WorkflowExecutionFilter struct { // Contains information about a workflow execution. type WorkflowExecutionInfo struct { + // The workflow execution this information is about. + // + // This member is required. + Execution *WorkflowExecution + + // The current status of the execution. + // + // This member is required. + ExecutionStatus ExecutionStatus + + // The time when the execution was started. + // + // This member is required. + StartTimestamp *time.Time + + // The type of the workflow execution. + // + // This member is required. + WorkflowType *WorkflowType + + // Set to true if a cancellation is requested for this workflow execution. + CancelRequested *bool + // If the execution status is closed then this specifies how the execution was // closed: // @@ -2999,59 +3022,33 @@ type WorkflowExecutionInfo struct { // execution was started to carry on the workflow. CloseStatus CloseStatus + // The time when the workflow execution was closed. Set only if the execution + // status is CLOSED. + CloseTimestamp *time.Time + // If this workflow execution is a child of another execution then contains the // workflow execution that started this execution. Parent *WorkflowExecution - // The current status of the execution. - // - // This member is required. - ExecutionStatus ExecutionStatus - - // The type of the workflow execution. - // - // This member is required. - WorkflowType *WorkflowType - - // Set to true if a cancellation is requested for this workflow execution. - CancelRequested *bool - - // The time when the execution was started. - // - // This member is required. - StartTimestamp *time.Time - - // The workflow execution this information is about. - // - // This member is required. - Execution *WorkflowExecution - // The list of tags associated with the workflow execution. Tags can be used to // identify and list workflow executions of interest through the visibility APIs. A // workflow execution can have a maximum of 5 tags. TagList []*string - - // The time when the workflow execution was closed. Set only if the execution - // status is CLOSED. - CloseTimestamp *time.Time } // Contains the counts of open tasks, child workflow executions and timers for a // workflow execution. type WorkflowExecutionOpenCounts struct { - // The count of timers started by this workflow execution that have not fired yet. - // - // This member is required. - OpenTimers *int32 - // The count of activity tasks whose status is OPEN. // // This member is required. OpenActivityTasks *int32 - // The count of Lambda tasks whose status is OPEN. - OpenLambdaFunctions *int32 + // The count of child workflow executions whose status is OPEN. + // + // This member is required. + OpenChildWorkflowExecutions *int32 // The count of decision tasks whose status is OPEN. A workflow execution can have // at most one open decision task. @@ -3059,15 +3056,24 @@ type WorkflowExecutionOpenCounts struct { // This member is required. OpenDecisionTasks *int32 - // The count of child workflow executions whose status is OPEN. + // The count of timers started by this workflow execution that have not fired yet. // // This member is required. - OpenChildWorkflowExecutions *int32 + OpenTimers *int32 + + // The count of Lambda tasks whose status is OPEN. + OpenLambdaFunctions *int32 } // Provides the details of the WorkflowExecutionSignaled event. type WorkflowExecutionSignaledEventAttributes struct { + // The name of the signal received. The decider can use the signal name and inputs + // to determine how to the process the signal. + // + // This member is required. + SignalName *string + // The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to // the SignalExternalWorkflow decision to signal this workflow execution.The source // event with this ID can be found in the history of the source workflow execution. @@ -3080,12 +3086,6 @@ type WorkflowExecutionSignaledEventAttributes struct { // sent by another workflow execution. ExternalWorkflowExecution *WorkflowExecution - // The name of the signal received. The decider can use the signal name and inputs - // to determine how to the process the signal. - // - // This member is required. - SignalName *string - // The inputs provided with the signal. The decider can use the signal name and // inputs to determine how to process the signal. Input *string @@ -3094,17 +3094,6 @@ type WorkflowExecutionSignaledEventAttributes struct { // Provides details of WorkflowExecutionStarted event. type WorkflowExecutionStartedEventAttributes struct { - // The IAM role attached to the workflow execution. - LambdaRole *string - - // If this workflow execution was started due to a ContinueAsNewWorkflowExecution - // decision, then it contains the runId of the previous workflow execution that was - // closed and continued as this execution. - ContinuedExecutionRunId *string - - // The input provided to the workflow execution. - Input *string - // The policy to use for the child workflow executions if this workflow execution // is terminated, by calling the TerminateWorkflowExecution () action explicitly or // due to an expired timeout. The supported child policies are: @@ -3124,18 +3113,6 @@ type WorkflowExecutionStartedEventAttributes struct { // This member is required. ChildPolicy ChildPolicy - // The priority of the decision tasks in the workflow execution. - TaskPriority *string - - // The maximum duration of decision tasks for this workflow type. The duration is - // specified in seconds, an integer greater than or equal to 0. You can use NONE to - // specify unlimited duration. - TaskStartToCloseTimeout *string - - // The source workflow execution that started this workflow execution. The member - // isn't set if the workflow execution was not started by a workflow. - ParentWorkflowExecution *WorkflowExecution - // The name of the task list for scheduling the decision tasks for this workflow // execution. // @@ -3147,11 +3124,22 @@ type WorkflowExecutionStartedEventAttributes struct { // This member is required. WorkflowType *WorkflowType + // If this workflow execution was started due to a ContinueAsNewWorkflowExecution + // decision, then it contains the runId of the previous workflow execution that was + // closed and continued as this execution. + ContinuedExecutionRunId *string + // The maximum duration for this workflow execution. The duration is specified in // seconds, an integer greater than or equal to 0. You can use NONE to specify // unlimited duration. ExecutionStartToCloseTimeout *string + // The input provided to the workflow execution. + Input *string + + // The IAM role attached to the workflow execution. + LambdaRole *string + // The ID of the StartChildWorkflowExecutionInitiated event corresponding to the // StartChildWorkflowExecutionDecision () to start this workflow execution. The // source event with this ID can be found in the history of the source workflow @@ -3159,9 +3147,21 @@ type WorkflowExecutionStartedEventAttributes struct { // back the chain of events leading up to this event. ParentInitiatedEventId *int64 + // The source workflow execution that started this workflow execution. The member + // isn't set if the workflow execution was not started by a workflow. + ParentWorkflowExecution *WorkflowExecution + // The list of tags associated with this workflow execution. An execution can have // up to 5 tags. TagList []*string + + // The priority of the decision tasks in the workflow execution. + TaskPriority *string + + // The maximum duration of decision tasks for this workflow type. The duration is + // specified in seconds, an integer greater than or equal to 0. You can use NONE to + // specify unlimited duration. + TaskStartToCloseTimeout *string } // Provides the details of the WorkflowExecutionTerminated event. @@ -3189,21 +3189,16 @@ type WorkflowExecutionTerminatedEventAttributes struct { // is terminated and the child policy is set to terminate child executions. Cause WorkflowExecutionTerminatedCause - // The reason provided for the termination. - Reason *string - // The details provided for the termination. Details *string + + // The reason provided for the termination. + Reason *string } // Provides the details of the WorkflowExecutionTimedOut event. type WorkflowExecutionTimedOutEventAttributes struct { - // The type of timeout that caused this event. - // - // This member is required. - TimeoutType WorkflowExecutionTimeoutType - // The policy used for the child workflow executions of this workflow execution. // The supported child policies are: // @@ -3220,55 +3215,32 @@ type WorkflowExecutionTimedOutEventAttributes struct { // // This member is required. ChildPolicy ChildPolicy + + // The type of timeout that caused this event. + // + // This member is required. + TimeoutType WorkflowExecutionTimeoutType } // Represents a workflow type. type WorkflowType struct { - // The version of the workflow type. The combination of workflow type name and - // version must be unique with in a domain. - // - // This member is required. - Version *string - // The name of the workflow type. The combination of workflow type name and version // must be unique with in a domain. // // This member is required. Name *string + + // The version of the workflow type. The combination of workflow type name and + // version must be unique with in a domain. + // + // This member is required. + Version *string } // The configuration settings of a workflow type. type WorkflowTypeConfiguration struct { - // The default maximum duration, specified when registering the workflow type, that - // a decision task for executions of this workflow type might take before returning - // completion or failure. If the task doesn'tdo close in the specified time then - // the task is automatically timed out and rescheduled. If the decider eventually - // reports a completion or failure, it is ignored. This default can be overridden - // when starting a workflow execution using the StartWorkflowExecution () action or - // the StartChildWorkflowExecutionDecision (). The duration is specified in - // seconds, an integer greater than or equal to 0. You can use NONE to specify - // unlimited duration. - DefaultTaskStartToCloseTimeout *string - - // The default maximum duration, specified when registering the workflow type, for - // executions of this workflow type. This default can be overridden when starting a - // workflow execution using the StartWorkflowExecution () action or the - // StartChildWorkflowExecutionDecision (). The duration is specified in seconds, an - // integer greater than or equal to 0. You can use NONE to specify unlimited - // duration. - DefaultExecutionStartToCloseTimeout *string - - // The default IAM role attached to this workflow type. Executions of this workflow - // type need IAM roles to invoke Lambda functions. If you don't specify an IAM role - // when starting this workflow type, the default Lambda role is attached to the - // execution. For more information, see - // https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html) - // in the Amazon SWF Developer Guide. - DefaultLambdaRole *string - // The default policy to use for the child workflow executions when a workflow // execution of this type is terminated, by calling the TerminateWorkflowExecution // () action explicitly or due to an expired timeout. This default can be @@ -3288,6 +3260,23 @@ type WorkflowTypeConfiguration struct { // continue to run. DefaultChildPolicy ChildPolicy + // The default maximum duration, specified when registering the workflow type, for + // executions of this workflow type. This default can be overridden when starting a + // workflow execution using the StartWorkflowExecution () action or the + // StartChildWorkflowExecutionDecision (). The duration is specified in seconds, an + // integer greater than or equal to 0. You can use NONE to specify unlimited + // duration. + DefaultExecutionStartToCloseTimeout *string + + // The default IAM role attached to this workflow type. Executions of this workflow + // type need IAM roles to invoke Lambda functions. If you don't specify an IAM role + // when starting this workflow type, the default Lambda role is attached to the + // execution. For more information, see + // https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html + // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html) + // in the Amazon SWF Developer Guide. + DefaultLambdaRole *string + // The default task list, specified when registering the workflow type, for // decisions tasks scheduled for workflow executions of this type. This default can // be overridden when starting a workflow execution using the @@ -3304,24 +3293,45 @@ type WorkflowTypeConfiguration struct { // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) // in the Amazon SWF Developer Guide. DefaultTaskPriority *string + + // The default maximum duration, specified when registering the workflow type, that + // a decision task for executions of this workflow type might take before returning + // completion or failure. If the task doesn'tdo close in the specified time then + // the task is automatically timed out and rescheduled. If the decider eventually + // reports a completion or failure, it is ignored. This default can be overridden + // when starting a workflow execution using the StartWorkflowExecution () action or + // the StartChildWorkflowExecutionDecision (). The duration is specified in + // seconds, an integer greater than or equal to 0. You can use NONE to specify + // unlimited duration. + DefaultTaskStartToCloseTimeout *string } // Used to filter workflow execution query results by type. Each parameter, if // specified, defines a rule that must be satisfied by each returned result. type WorkflowTypeFilter struct { - // Version of the workflow type. - Version *string - // Name of the workflow type. // // This member is required. Name *string + + // Version of the workflow type. + Version *string } // Contains information about a workflow type. type WorkflowTypeInfo struct { + // The date when this type was registered. + // + // This member is required. + CreationDate *time.Time + + // The current status of the workflow type. + // + // This member is required. + Status RegistrationStatus + // The workflow type this information is about. // // This member is required. @@ -3331,16 +3341,6 @@ type WorkflowTypeInfo struct { // deprecated. DeprecationDate *time.Time - // The date when this type was registered. - // - // This member is required. - CreationDate *time.Time - // The description of the type registered through RegisterWorkflowType (). Description *string - - // The current status of the workflow type. - // - // This member is required. - Status RegistrationStatus } diff --git a/service/synthetics/api_op_CreateCanary.go b/service/synthetics/api_op_CreateCanary.go index af0ea79feb8..9a529617fa5 100644 --- a/service/synthetics/api_op_CreateCanary.go +++ b/service/synthetics/api_op_CreateCanary.go @@ -73,60 +73,18 @@ func (c *Client) CreateCanary(ctx context.Context, params *CreateCanaryInput, op type CreateCanaryInput struct { - // If this canary is to test an endpoint in a VPC, this structure contains - // information about the subnet and security groups of the VPC endpoint. For more - // information, see Running a Canary in a VPC - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html). - VpcConfig *types.VpcConfigInput - // The location in Amazon S3 where Synthetics stores artifacts from the test runs // of this canary. Artifacts include the log file, screenshots, and HAR files. // // This member is required. ArtifactS3Location *string - // The number of days to retain data about successful runs of this canary. If you - // omit this field, the default of 31 days is used. The valid range is 1 to 455 - // days. - SuccessRetentionPeriodInDays *int32 - - // A structure that contains the configuration for individual canary runs, such as - // timeout value. - RunConfig *types.CanaryRunConfigInput - - // The number of days to retain data about failed runs of this canary. If you omit - // this field, the default of 31 days is used. The valid range is 1 to 455 days. - FailureRetentionPeriodInDays *int32 - - // A structure that contains information about how often the canary is to run and - // when these test runs are to stop. - // - // This member is required. - Schedule *types.CanaryScheduleInput - - // Specifies the runtime version to use for the canary. Currently, the only valid - // value is syn-1.0. For more information about runtime versions, see Canary - // Runtime Versions - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html). - // - // This member is required. - RuntimeVersion *string - - // The name for this canary. Be sure to give it a descriptive name that - // distinguishes it from other canaries in your account. Do not include secrets or - // proprietary information in your canary names. The canary name makes up part of - // the canary ARN, and the ARN is included in outbound calls over the internet. For - // more information, see Security Considerations for Synthetics Canaries - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html). + // A structure that includes the entry point from which the canary should start + // running your script. If the script is stored in an S3 bucket, the bucket name, + // key, and version are also included. // // This member is required. - Name *string - - // A list of key-value pairs to associate with the canary. You can associate as - // many as 50 tags with a canary. Tags can help you organize and categorize your - // resources. You can also use them to scope user permissions, by granting a user - // permission to access or change only the resources that have certain tag values. - Tags map[string]*string + Code *types.CanaryCodeInput // The ARN of the IAM role to be used to run the canary. This role must already // exist, and must include lambda.amazonaws.com as a principal in the trust policy. @@ -152,12 +110,54 @@ type CreateCanaryInput struct { // This member is required. ExecutionRoleArn *string - // A structure that includes the entry point from which the canary should start - // running your script. If the script is stored in an S3 bucket, the bucket name, - // key, and version are also included. + // The name for this canary. Be sure to give it a descriptive name that + // distinguishes it from other canaries in your account. Do not include secrets or + // proprietary information in your canary names. The canary name makes up part of + // the canary ARN, and the ARN is included in outbound calls over the internet. For + // more information, see Security Considerations for Synthetics Canaries + // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html). // // This member is required. - Code *types.CanaryCodeInput + Name *string + + // Specifies the runtime version to use for the canary. Currently, the only valid + // value is syn-1.0. For more information about runtime versions, see Canary + // Runtime Versions + // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html). + // + // This member is required. + RuntimeVersion *string + + // A structure that contains information about how often the canary is to run and + // when these test runs are to stop. + // + // This member is required. + Schedule *types.CanaryScheduleInput + + // The number of days to retain data about failed runs of this canary. If you omit + // this field, the default of 31 days is used. The valid range is 1 to 455 days. + FailureRetentionPeriodInDays *int32 + + // A structure that contains the configuration for individual canary runs, such as + // timeout value. + RunConfig *types.CanaryRunConfigInput + + // The number of days to retain data about successful runs of this canary. If you + // omit this field, the default of 31 days is used. The valid range is 1 to 455 + // days. + SuccessRetentionPeriodInDays *int32 + + // A list of key-value pairs to associate with the canary. You can associate as + // many as 50 tags with a canary. Tags can help you organize and categorize your + // resources. You can also use them to scope user permissions, by granting a user + // permission to access or change only the resources that have certain tag values. + Tags map[string]*string + + // If this canary is to test an endpoint in a VPC, this structure contains + // information about the subnet and security groups of the VPC endpoint. For more + // information, see Running a Canary in a VPC + // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html). + VpcConfig *types.VpcConfigInput } type CreateCanaryOutput struct { diff --git a/service/synthetics/api_op_DescribeCanariesLastRun.go b/service/synthetics/api_op_DescribeCanariesLastRun.go index a0785f52da5..932a74e70a6 100644 --- a/service/synthetics/api_op_DescribeCanariesLastRun.go +++ b/service/synthetics/api_op_DescribeCanariesLastRun.go @@ -57,14 +57,14 @@ func (c *Client) DescribeCanariesLastRun(ctx context.Context, params *DescribeCa type DescribeCanariesLastRunInput struct { - // A token that indicates that there is more data available. You can use this token - // in a subsequent DescribeCanaries operation to retrieve the next set of results. - NextToken *string - // Specify this parameter to limit how many runs are returned each time you use the // DescribeLastRun operation. If you omit this parameter, the default of 100 is // used. MaxResults *int32 + + // A token that indicates that there is more data available. You can use this token + // in a subsequent DescribeCanaries operation to retrieve the next set of results. + NextToken *string } type DescribeCanariesLastRunOutput struct { diff --git a/service/synthetics/api_op_DescribeRuntimeVersions.go b/service/synthetics/api_op_DescribeRuntimeVersions.go index 5a7a6604156..082498a125d 100644 --- a/service/synthetics/api_op_DescribeRuntimeVersions.go +++ b/service/synthetics/api_op_DescribeRuntimeVersions.go @@ -58,15 +58,15 @@ func (c *Client) DescribeRuntimeVersions(ctx context.Context, params *DescribeRu type DescribeRuntimeVersionsInput struct { - // A token that indicates that there is more data available. You can use this token - // in a subsequent DescribeRuntimeVersions operation to retrieve the next set of - // results. - NextToken *string - // Specify this parameter to limit how many runs are returned each time you use the // DescribeRuntimeVersions operation. If you omit this parameter, the default of // 100 is used. MaxResults *int32 + + // A token that indicates that there is more data available. You can use this token + // in a subsequent DescribeRuntimeVersions operation to retrieve the next set of + // results. + NextToken *string } type DescribeRuntimeVersionsOutput struct { diff --git a/service/synthetics/api_op_GetCanaryRuns.go b/service/synthetics/api_op_GetCanaryRuns.go index 153941da6cc..9404018197c 100644 --- a/service/synthetics/api_op_GetCanaryRuns.go +++ b/service/synthetics/api_op_GetCanaryRuns.go @@ -62,13 +62,13 @@ type GetCanaryRunsInput struct { // This member is required. Name *string - // A token that indicates that there is more data available. You can use this token - // in a subsequent GetCanaryRuns operation to retrieve the next set of results. - NextToken *string - // Specify this parameter to limit how many runs are returned each time you use the // GetCanaryRuns operation. If you omit this parameter, the default of 100 is used. MaxResults *int32 + + // A token that indicates that there is more data available. You can use this token + // in a subsequent GetCanaryRuns operation to retrieve the next set of results. + NextToken *string } type GetCanaryRunsOutput struct { diff --git a/service/synthetics/api_op_TagResource.go b/service/synthetics/api_op_TagResource.go index 5e88ff6461a..bb7c62bf184 100644 --- a/service/synthetics/api_op_TagResource.go +++ b/service/synthetics/api_op_TagResource.go @@ -65,16 +65,16 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The list of key-value pairs to associate with the canary. - // - // This member is required. - Tags map[string]*string - // The ARN of the canary that you're adding tags to. The ARN format of a canary is // arn:aws:synthetics:Region:account-id:canary:canary-name . // // This member is required. ResourceArn *string + + // The list of key-value pairs to associate with the canary. + // + // This member is required. + Tags map[string]*string } type TagResourceOutput struct { diff --git a/service/synthetics/api_op_UpdateCanary.go b/service/synthetics/api_op_UpdateCanary.go index 9e98debde79..8d1f4ff6697 100644 --- a/service/synthetics/api_op_UpdateCanary.go +++ b/service/synthetics/api_op_UpdateCanary.go @@ -60,14 +60,6 @@ func (c *Client) UpdateCanary(ctx context.Context, params *UpdateCanaryInput, op type UpdateCanaryInput struct { - // The number of days to retain data about successful runs of this canary. - SuccessRetentionPeriodInDays *int32 - - // A structure that includes the entry point from which the canary should start - // running your script. If the script is stored in an S3 bucket, the bucket name, - // key, and version are also included. - Code *types.CanaryCodeInput - // The name of the canary that you want to update. To find the names of your // canaries, use DescribeCanaries // (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html). @@ -76,12 +68,10 @@ type UpdateCanaryInput struct { // This member is required. Name *string - // A structure that contains the timeout value that is used for each individual run - // of the canary. - RunConfig *types.CanaryRunConfigInput - - // The number of days to retain data about failed runs of this canary. - FailureRetentionPeriodInDays *int32 + // A structure that includes the entry point from which the canary should start + // running your script. If the script is stored in an S3 bucket, the bucket name, + // key, and version are also included. + Code *types.CanaryCodeInput // The ARN of the IAM role to be used to run the canary. This role must already // exist, and must include lambda.amazonaws.com as a principal in the trust policy. @@ -105,6 +95,13 @@ type UpdateCanaryInput struct { // * logs:CreateLogStream ExecutionRoleArn *string + // The number of days to retain data about failed runs of this canary. + FailureRetentionPeriodInDays *int32 + + // A structure that contains the timeout value that is used for each individual run + // of the canary. + RunConfig *types.CanaryRunConfigInput + // Specifies the runtime version to use for the canary. Currently, the only valid // value is syn-1.0. For more information about runtime versions, see Canary // Runtime Versions @@ -115,6 +112,9 @@ type UpdateCanaryInput struct { // when these runs are to stop. Schedule *types.CanaryScheduleInput + // The number of days to retain data about successful runs of this canary. + SuccessRetentionPeriodInDays *int32 + // If this canary is to test an endpoint in a VPC, this structure contains // information about the subnet and security groups of the VPC endpoint. For more // information, see Running a Canary in a VPC diff --git a/service/synthetics/go.mod b/service/synthetics/go.mod index e5180d1ccf4..495dec0be14 100644 --- a/service/synthetics/go.mod +++ b/service/synthetics/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/synthetics go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/synthetics/types/types.go b/service/synthetics/types/types.go index be58de93109..e37275691ae 100644 --- a/service/synthetics/types/types.go +++ b/service/synthetics/types/types.go @@ -9,8 +9,13 @@ import ( // This structure contains all information about one canary in your account. type Canary struct { - // The unique ID of this canary. - Id *string + // The location in Amazon S3 where Synthetics stores artifacts from the runs of + // this canary. Artifacts include the log file, screenshots, and HAR files. + ArtifactS3Location *string + + // This structure contains information about the canary's Lambda handler and where + // its code is stored by CloudWatch Synthetics. + Code *CanaryCodeOutput // The ARN of the Lambda function that is used as your canary's engine. For more // information about Lambda ARN format, see Resources and Conditions for Lambda @@ -18,14 +23,21 @@ type Canary struct { // (https://docs.aws.amazon.com/lambda/latest/dg/lambda-api-permissions-ref.html). EngineArn *string - // If this canary is to test an endpoint in a VPC, this structure contains - // information about the subnets and security groups of the VPC endpoint. For more - // information, see Running a Canary in a VPC - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html). - VpcConfig *VpcConfigOutput + // The ARN of the IAM role used to run the canary. This role must include + // lambda.amazonaws.com as a principal in the trust policy. + ExecutionRoleArn *string - // The number of days to retain data about successful runs of this canary. - SuccessRetentionPeriodInDays *int32 + // The number of days to retain data about failed runs of this canary. + FailureRetentionPeriodInDays *int32 + + // The unique ID of this canary. + Id *string + + // The name of the canary. + Name *string + + // A structure that contains information for a canary run. + RunConfig *CanaryRunConfigOutput // Specifies the runtime version to use for the canary. Currently, the only valid // value is syn-1.0. For more information about runtime versions, see Canary @@ -33,40 +45,28 @@ type Canary struct { // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html). RuntimeVersion *string - // The list of key-value pairs that are associated with the canary. - Tags map[string]*string - - // The number of days to retain data about failed runs of this canary. - FailureRetentionPeriodInDays *int32 + // A structure that contains information about how often the canary is to run, and + // when these runs are to stop. + Schedule *CanaryScheduleOutput // A structure that contains information about the canary's status. Status *CanaryStatus - // The location in Amazon S3 where Synthetics stores artifacts from the runs of - // this canary. Artifacts include the log file, screenshots, and HAR files. - ArtifactS3Location *string - - // The ARN of the IAM role used to run the canary. This role must include - // lambda.amazonaws.com as a principal in the trust policy. - ExecutionRoleArn *string - - // This structure contains information about the canary's Lambda handler and where - // its code is stored by CloudWatch Synthetics. - Code *CanaryCodeOutput - - // The name of the canary. - Name *string + // The number of days to retain data about successful runs of this canary. + SuccessRetentionPeriodInDays *int32 - // A structure that contains information about how often the canary is to run, and - // when these runs are to stop. - Schedule *CanaryScheduleOutput + // The list of key-value pairs that are associated with the canary. + Tags map[string]*string // A structure that contains information about when the canary was created, // modified, and most recently run. Timeline *CanaryTimeline - // A structure that contains information for a canary run. - RunConfig *CanaryRunConfigOutput + // If this canary is to test an endpoint in a VPC, this structure contains + // information about the subnets and security groups of the VPC endpoint. For more + // information, see Running a Canary in a VPC + // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html). + VpcConfig *VpcConfigOutput } // Use this structure to input your script code for the canary. This structure @@ -76,24 +76,24 @@ type Canary struct { // directly, the script code is contained in the value of Zipfile. type CanaryCodeInput struct { - // The S3 version ID of your script. - S3Version *string - // The entry point to use for the source code when running the canary. This value // must end with the string .handler. // // This member is required. Handler *string - // The S3 key of your script. For more information, see Working with Amazon S3 - // Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingObjects.html). - S3Key *string - // If your canary script is located in S3, specify the full bucket name here. The // bucket must already exist. Specify the full bucket name, including s3:// as the // start of the bucket name. S3Bucket *string + // The S3 key of your script. For more information, see Working with Amazon S3 + // Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingObjects.html). + S3Key *string + + // The S3 version ID of your script. + S3Version *string + // If you input your canary script directly into the canary instead of referring to // an S3 location, the value of this parameter is the .zip file that contains the // script. It can be up to 5 MB. @@ -104,11 +104,11 @@ type CanaryCodeInput struct { // its code is stored by CloudWatch Synthetics. type CanaryCodeOutput struct { - // The ARN of the Lambda layer where Synthetics stores the canary script code. - SourceLocationArn *string - // The entry point to use for the source code when running the canary. Handler *string + + // The ARN of the Lambda layer where Synthetics stores the canary script code. + SourceLocationArn *string } // This structure contains information about the most recent run of a single @@ -125,79 +125,74 @@ type CanaryLastRun struct { // This structure contains the details about one run of one canary. type CanaryRun struct { - // The name of the canary. - Name *string - // The location where the canary stored artifacts from the run. Artifacts include // the log file, screenshots, and HAR files. ArtifactS3Location *string - // A structure that contains the start and end times of this run. - Timeline *CanaryRunTimeline + // The name of the canary. + Name *string // The status of this run. Status *CanaryRunStatus + + // A structure that contains the start and end times of this run. + Timeline *CanaryRunTimeline } // A structure that contains input information for a canary run. type CanaryRunConfigInput struct { - // The maximum amount of memory available to the canary while it is running, in MB. - // The value you specify must be a multiple of 64. - MemoryInMB *int32 - // How long the canary is allowed to run before it must stop. If you omit this // field, the frequency of the canary is used as this value, up to a maximum of 14 // minutes. // // This member is required. TimeoutInSeconds *int32 + + // The maximum amount of memory available to the canary while it is running, in MB. + // The value you specify must be a multiple of 64. + MemoryInMB *int32 } // A structure that contains information for a canary run. type CanaryRunConfigOutput struct { - // How long the canary is allowed to run before it must stop. - TimeoutInSeconds *int32 - // The maximum amount of memory available to the canary while it is running, in MB. // The value you must be a multiple of 64. MemoryInMB *int32 + + // How long the canary is allowed to run before it must stop. + TimeoutInSeconds *int32 } // This structure contains the status information about a canary run. type CanaryRunStatus struct { - // If this value is CANARY_FAILURE, an exception occurred in the canary code. If - // this value is EXECUTION_FAILURE, an exception occurred in CloudWatch Synthetics. - StateReasonCode CanaryRunStateReasonCode + // The current state of the run. + State CanaryRunState // If run of the canary failed, this field contains the reason for the error. StateReason *string - // The current state of the run. - State CanaryRunState + // If this value is CANARY_FAILURE, an exception occurred in the canary code. If + // this value is EXECUTION_FAILURE, an exception occurred in CloudWatch Synthetics. + StateReasonCode CanaryRunStateReasonCode } // This structure contains the start and end times of a single canary run. type CanaryRunTimeline struct { - // The start time of the run. - Started *time.Time - // The end time of the run. Completed *time.Time + + // The start time of the run. + Started *time.Time } // This structure specifies how often a canary is to make runs and the date and // time when it should stop making runs. type CanaryScheduleInput struct { - // How long, in seconds, for the canary to continue making regular runs according - // to the schedule in the Expression value. If you specify 0, the canary continues - // making runs until you stop it. If you omit this field, the default of 0 is used. - DurationInSeconds *int64 - // A rate expression that defines how often the canary is to run. The syntax is // rate(number unit). unit can be minute, minutes, or hour. For example, rate(1 // minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 @@ -208,12 +203,22 @@ type CanaryScheduleInput struct { // // This member is required. Expression *string + + // How long, in seconds, for the canary to continue making regular runs according + // to the schedule in the Expression value. If you specify 0, the canary continues + // making runs until you stop it. If you omit this field, the default of 0 is used. + DurationInSeconds *int64 } // How long, in seconds, for the canary to continue making regular runs according // to the schedule in the Expression value. type CanaryScheduleOutput struct { + // How long, in seconds, for the canary to continue making regular runs after it + // was created. The runs are performed according to the schedule in the Expression + // value. + DurationInSeconds *int64 + // A rate expression that defines how often the canary is to run. The syntax is // rate(number unit). unit can be minute, minutes, or hour. For example, rate(1 // minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 @@ -221,11 +226,6 @@ type CanaryScheduleOutput struct { // rate(0 hour) is a special value that causes the canary to run only once when it // is started. Expression *string - - // How long, in seconds, for the canary to continue making regular runs after it - // was created. The runs are performed according to the schedule in the Expression - // value. - DurationInSeconds *int64 } // A structure that contains the current state of the canary. @@ -246,15 +246,15 @@ type CanaryStatus struct { // modified. type CanaryTimeline struct { - // The date and time that the canary's most recent run started. - LastStarted *time.Time - // The date and time the canary was created. Created *time.Time // The date and time the canary was most recently modified. LastModified *time.Time + // The date and time that the canary's most recent run started. + LastStarted *time.Time + // The date and time that the canary's most recent run ended. LastStopped *time.Time } @@ -264,19 +264,19 @@ type CanaryTimeline struct { // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html). type RuntimeVersion struct { - // The name of the runtime version. Currently, the only valid value is syn-1.0. - // Specifies the runtime version to use for the canary. Currently, the only valid - // value is syn-1.0. - VersionName *string - - // The date that the runtime version was released. - ReleaseDate *time.Time + // If this runtime version is deprecated, this value is the date of deprecation. + DeprecationDate *time.Time // A description of the runtime version, created by Amazon. Description *string - // If this runtime version is deprecated, this value is the date of deprecation. - DeprecationDate *time.Time + // The date that the runtime version was released. + ReleaseDate *time.Time + + // The name of the runtime version. Currently, the only valid value is syn-1.0. + // Specifies the runtime version to use for the canary. Currently, the only valid + // value is syn-1.0. + VersionName *string } // If this canary is to test an endpoint in a VPC, this structure contains @@ -285,11 +285,11 @@ type RuntimeVersion struct { // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html). type VpcConfigInput struct { - // The IDs of the subnets where this canary is to run. - SubnetIds []*string - // The IDs of the security groups for this canary. SecurityGroupIds []*string + + // The IDs of the subnets where this canary is to run. + SubnetIds []*string } // If this canary is to test an endpoint in a VPC, this structure contains @@ -298,12 +298,12 @@ type VpcConfigInput struct { // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html). type VpcConfigOutput struct { - // The IDs of the subnets where this canary is to run. - SubnetIds []*string - // The IDs of the security groups for this canary. SecurityGroupIds []*string + // The IDs of the subnets where this canary is to run. + SubnetIds []*string + // The IDs of the VPC where this canary is to run. VpcId *string } diff --git a/service/textract/api_op_AnalyzeDocument.go b/service/textract/api_op_AnalyzeDocument.go index 6b0ecdeece9..00e11a891d2 100644 --- a/service/textract/api_op_AnalyzeDocument.go +++ b/service/textract/api_op_AnalyzeDocument.go @@ -94,10 +94,6 @@ type AnalyzeDocumentInput struct { // This member is required. Document *types.Document - // Sets the configuration for the human in the loop workflow for analyzing - // documents. - HumanLoopConfig *types.HumanLoopConfig - // A list of the types of analysis to perform. Add TABLES to the list to return // information about the tables that are detected in the input document. Add FORMS // to return detected form data. To perform both types of analysis, add TABLES and @@ -107,22 +103,26 @@ type AnalyzeDocumentInput struct { // // This member is required. FeatureTypes []types.FeatureType + + // Sets the configuration for the human in the loop workflow for analyzing + // documents. + HumanLoopConfig *types.HumanLoopConfig } type AnalyzeDocumentOutput struct { - // The items that are detected and analyzed by AnalyzeDocument. - Blocks []*types.Block - - // Shows the results of the human in the loop evaluation. - HumanLoopActivationOutput *types.HumanLoopActivationOutput - // The version of the model used to analyze the document. AnalyzeDocumentModelVersion *string + // The items that are detected and analyzed by AnalyzeDocument. + Blocks []*types.Block + // Metadata about the analyzed document. An example is the number of pages. DocumentMetadata *types.DocumentMetadata + // Shows the results of the human in the loop evaluation. + HumanLoopActivationOutput *types.HumanLoopActivationOutput + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/textract/api_op_DetectDocumentText.go b/service/textract/api_op_DetectDocumentText.go index f4f8b752547..d63c96f5544 100644 --- a/service/textract/api_op_DetectDocumentText.go +++ b/service/textract/api_op_DetectDocumentText.go @@ -80,6 +80,9 @@ type DetectDocumentTextInput struct { type DetectDocumentTextOutput struct { + // An array of Block objects that contain the text that's detected in the document. + Blocks []*types.Block + // DetectDocumentTextModelVersion *string @@ -87,9 +90,6 @@ type DetectDocumentTextOutput struct { // in the document. DocumentMetadata *types.DocumentMetadata - // An array of Block objects that contain the text that's detected in the document. - Blocks []*types.Block - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/textract/api_op_GetDocumentAnalysis.go b/service/textract/api_op_GetDocumentAnalysis.go index d722a911ade..149efc3ae4b 100644 --- a/service/textract/api_op_GetDocumentAnalysis.go +++ b/service/textract/api_op_GetDocumentAnalysis.go @@ -116,30 +116,30 @@ type GetDocumentAnalysisInput struct { type GetDocumentAnalysisOutput struct { + // + AnalyzeDocumentModelVersion *string + // The results of the text-analysis operation. Blocks []*types.Block + // Information about a document that Amazon Textract processed. DocumentMetadata is + // returned in every page of paginated responses from an Amazon Textract video + // operation. + DocumentMetadata *types.DocumentMetadata + // The current status of the text detection job. JobStatus types.JobStatus - // - AnalyzeDocumentModelVersion *string - - // A list of warnings that occurred during the document-analysis operation. - Warnings []*types.Warning - - // The current status of an asynchronous document-analysis operation. - StatusMessage *string - // If the response is truncated, Amazon Textract returns this token. You can use // this token in the subsequent request to retrieve the next set of text detection // results. NextToken *string - // Information about a document that Amazon Textract processed. DocumentMetadata is - // returned in every page of paginated responses from an Amazon Textract video - // operation. - DocumentMetadata *types.DocumentMetadata + // The current status of an asynchronous document-analysis operation. + StatusMessage *string + + // A list of warnings that occurred during the document-analysis operation. + Warnings []*types.Warning // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/textract/api_op_GetDocumentTextDetection.go b/service/textract/api_op_GetDocumentTextDetection.go index 911019e70c4..b54718a2d85 100644 --- a/service/textract/api_op_GetDocumentTextDetection.go +++ b/service/textract/api_op_GetDocumentTextDetection.go @@ -86,28 +86,29 @@ type GetDocumentTextDetectionInput struct { // This member is required. JobId *string - // If the previous response was incomplete (because there are more blocks to - // retrieve), Amazon Textract returns a pagination token in the response. You can - // use this pagination token to retrieve the next set of blocks. - NextToken *string - // The maximum number of results to return per paginated call. The largest value // you can specify is 1,000. If you specify a value greater than 1,000, a maximum // of 1,000 results is returned. The default value is 1,000. MaxResults *int32 + + // If the previous response was incomplete (because there are more blocks to + // retrieve), Amazon Textract returns a pagination token in the response. You can + // use this pagination token to retrieve the next set of blocks. + NextToken *string } type GetDocumentTextDetectionOutput struct { - // A list of warnings that occurred during the text-detection operation for the - // document. - Warnings []*types.Warning + // The results of the text-detection operation. + Blocks []*types.Block // DetectDocumentTextModelVersion *string - // The current status of an asynchronous text-detection operation for the document. - StatusMessage *string + // Information about a document that Amazon Textract processed. DocumentMetadata is + // returned in every page of paginated responses from an Amazon Textract video + // operation. + DocumentMetadata *types.DocumentMetadata // The current status of the text detection job. JobStatus types.JobStatus @@ -117,13 +118,12 @@ type GetDocumentTextDetectionOutput struct { // results. NextToken *string - // The results of the text-detection operation. - Blocks []*types.Block + // The current status of an asynchronous text-detection operation for the document. + StatusMessage *string - // Information about a document that Amazon Textract processed. DocumentMetadata is - // returned in every page of paginated responses from an Amazon Textract video - // operation. - DocumentMetadata *types.DocumentMetadata + // A list of warnings that occurred during the text-detection operation for the + // document. + Warnings []*types.Warning // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/textract/api_op_StartDocumentAnalysis.go b/service/textract/api_op_StartDocumentAnalysis.go index bd8252f28c3..aeb53df5046 100644 --- a/service/textract/api_op_StartDocumentAnalysis.go +++ b/service/textract/api_op_StartDocumentAnalysis.go @@ -72,29 +72,11 @@ func (c *Client) StartDocumentAnalysis(ctx context.Context, params *StartDocumen type StartDocumentAnalysisInput struct { - // The idempotent token that you use to identify the start request. If you use the - // same token with multiple StartDocumentAnalysis requests, the same JobId is - // returned. Use ClientRequestToken to prevent the same job from being accidentally - // started more than once. For more information, see Calling Amazon Textract - // Asynchronous Operations - // (https://docs.aws.amazon.com/textract/latest/dg/api-async.html). - ClientRequestToken *string - - // The Amazon SNS topic ARN that you want Amazon Textract to publish the completion - // status of the operation to. - NotificationChannel *types.NotificationChannel - // The location of the document to be processed. // // This member is required. DocumentLocation *types.DocumentLocation - // An identifier that you specify that's included in the completion notification - // published to the Amazon SNS topic. For example, you can use JobTag to identify - // the type of document that the completion notification corresponds to (such as a - // tax form or a receipt). - JobTag *string - // A list of the types of analysis to perform. Add TABLES to the list to return // information about the tables that are detected in the input document. Add FORMS // to return detected form data. To perform both types of analysis, add TABLES and @@ -104,6 +86,24 @@ type StartDocumentAnalysisInput struct { // // This member is required. FeatureTypes []types.FeatureType + + // The idempotent token that you use to identify the start request. If you use the + // same token with multiple StartDocumentAnalysis requests, the same JobId is + // returned. Use ClientRequestToken to prevent the same job from being accidentally + // started more than once. For more information, see Calling Amazon Textract + // Asynchronous Operations + // (https://docs.aws.amazon.com/textract/latest/dg/api-async.html). + ClientRequestToken *string + + // An identifier that you specify that's included in the completion notification + // published to the Amazon SNS topic. For example, you can use JobTag to identify + // the type of document that the completion notification corresponds to (such as a + // tax form or a receipt). + JobTag *string + + // The Amazon SNS topic ARN that you want Amazon Textract to publish the completion + // status of the operation to. + NotificationChannel *types.NotificationChannel } type StartDocumentAnalysisOutput struct { diff --git a/service/textract/api_op_StartDocumentTextDetection.go b/service/textract/api_op_StartDocumentTextDetection.go index 378b42d13fb..22af0318168 100644 --- a/service/textract/api_op_StartDocumentTextDetection.go +++ b/service/textract/api_op_StartDocumentTextDetection.go @@ -75,12 +75,6 @@ type StartDocumentTextDetectionInput struct { // This member is required. DocumentLocation *types.DocumentLocation - // An identifier that you specify that's included in the completion notification - // published to the Amazon SNS topic. For example, you can use JobTag to identify - // the type of document that the completion notification corresponds to (such as a - // tax form or a receipt). - JobTag *string - // The idempotent token that's used to identify the start request. If you use the // same token with multiple StartDocumentTextDetection requests, the same JobId is // returned. Use ClientRequestToken to prevent the same job from being accidentally @@ -89,6 +83,12 @@ type StartDocumentTextDetectionInput struct { // (https://docs.aws.amazon.com/textract/latest/dg/api-async.html). ClientRequestToken *string + // An identifier that you specify that's included in the completion notification + // published to the Amazon SNS topic. For example, you can use JobTag to identify + // the type of document that the completion notification corresponds to (such as a + // tax form or a receipt). + JobTag *string + // The Amazon SNS topic ARN that you want Amazon Textract to publish the completion // status of the operation to. NotificationChannel *types.NotificationChannel diff --git a/service/textract/go.mod b/service/textract/go.mod index aed6f30e761..7696dced288 100644 --- a/service/textract/go.mod +++ b/service/textract/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/textract go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/textract/types/types.go b/service/textract/types/types.go index d21248c732d..7f724dd398c 100644 --- a/service/textract/types/types.go +++ b/service/textract/types/types.go @@ -16,71 +16,6 @@ package types // (https://docs.aws.amazon.com/textract/latest/dg/how-it-works.html). type Block struct { - // The word or line of text that's recognized by Amazon Textract. - Text *string - - // The row in which a table cell is located. The first row position is 1. RowIndex - // isn't returned by DetectDocumentText and GetDocumentTextDetection. - RowIndex *int32 - - // The confidence score that Amazon Textract has in the accuracy of the recognized - // text and the accuracy of the geometry points around the recognized text. - Confidence *float32 - - // The type of entity. The following can be returned: - // - // * KEY - An identifier - // for a field on the document. - // - // * VALUE - The field text. - // - // EntityTypes isn't - // returned by DetectDocumentText and GetDocumentTextDetection. - EntityTypes []EntityType - - // The column in which a table cell appears. The first column position is 1. - // ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection. - ColumnIndex *int32 - - // The selection status of a selection element, such as an option button or check - // box. - SelectionStatus SelectionStatus - - // A list of child blocks of the current block. For example, a LINE object has - // child blocks for each WORD block that's part of the line of text. There aren't - // Relationship objects in the list for relationships that don't exist, such as - // when the current block has no child blocks. The list size can be the - // following: - // - // * 0 - The block has no child blocks. - // - // * 1 - The block has - // child blocks. - Relationships []*Relationship - - // The number of columns that a table cell spans. Currently this value is always 1, - // even if the number of columns spanned is greater than 1. ColumnSpan isn't - // returned by DetectDocumentText and GetDocumentTextDetection. - ColumnSpan *int32 - - // The location of the recognized text on the image. It includes an axis-aligned, - // coarse bounding box that surrounds the text, and a finer-grain polygon for more - // accurate spatial information. - Geometry *Geometry - - // The page on which a block was detected. Page is returned by asynchronous - // operations. Page values greater than 1 are only returned for multipage documents - // that are in PDF format. A scanned image (JPEG/PNG), even if it contains multiple - // document pages, is considered to be a single-page document. The value of Page is - // always 1. Synchronous operations don't return Page because every input document - // is considered to be a single-page document. - Page *int32 - - // The number of rows that a table cell spans. Currently this value is always 1, - // even if the number of rows spanned is greater than 1. RowSpan isn't returned by - // DetectDocumentText and GetDocumentTextDetection. - RowSpan *int32 - // The type of text item that's recognized. In operations for text detection, the // following types are returned: // @@ -126,9 +61,74 @@ type Block struct { // selection element. BlockType BlockType + // The column in which a table cell appears. The first column position is 1. + // ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection. + ColumnIndex *int32 + + // The number of columns that a table cell spans. Currently this value is always 1, + // even if the number of columns spanned is greater than 1. ColumnSpan isn't + // returned by DetectDocumentText and GetDocumentTextDetection. + ColumnSpan *int32 + + // The confidence score that Amazon Textract has in the accuracy of the recognized + // text and the accuracy of the geometry points around the recognized text. + Confidence *float32 + + // The type of entity. The following can be returned: + // + // * KEY - An identifier + // for a field on the document. + // + // * VALUE - The field text. + // + // EntityTypes isn't + // returned by DetectDocumentText and GetDocumentTextDetection. + EntityTypes []EntityType + + // The location of the recognized text on the image. It includes an axis-aligned, + // coarse bounding box that surrounds the text, and a finer-grain polygon for more + // accurate spatial information. + Geometry *Geometry + // The identifier for the recognized text. The identifier is only unique for a // single operation. Id *string + + // The page on which a block was detected. Page is returned by asynchronous + // operations. Page values greater than 1 are only returned for multipage documents + // that are in PDF format. A scanned image (JPEG/PNG), even if it contains multiple + // document pages, is considered to be a single-page document. The value of Page is + // always 1. Synchronous operations don't return Page because every input document + // is considered to be a single-page document. + Page *int32 + + // A list of child blocks of the current block. For example, a LINE object has + // child blocks for each WORD block that's part of the line of text. There aren't + // Relationship objects in the list for relationships that don't exist, such as + // when the current block has no child blocks. The list size can be the + // following: + // + // * 0 - The block has no child blocks. + // + // * 1 - The block has + // child blocks. + Relationships []*Relationship + + // The row in which a table cell is located. The first row position is 1. RowIndex + // isn't returned by DetectDocumentText and GetDocumentTextDetection. + RowIndex *int32 + + // The number of rows that a table cell spans. Currently this value is always 1, + // even if the number of rows spanned is greater than 1. RowSpan isn't returned by + // DetectDocumentText and GetDocumentTextDetection. + RowSpan *int32 + + // The selection status of a selection element, such as an option button or check + // box. + SelectionStatus SelectionStatus + + // The word or line of text that's recognized by Amazon Textract. + Text *string } // The bounding box around the detected page, text, key-value pair, table, table @@ -144,19 +144,19 @@ type Block struct { // the bounding box width is 70 pixels, the width returned is 0.1. type BoundingBox struct { - // The top coordinate of the bounding box as a ratio of overall document page - // height. - Top *float32 + // The height of the bounding box as a ratio of the overall document page height. + Height *float32 // The left coordinate of the bounding box as a ratio of overall document page // width. Left *float32 + // The top coordinate of the bounding box as a ratio of overall document page + // height. + Top *float32 + // The width of the bounding box as a ratio of the overall document page width. Width *float32 - - // The height of the bounding box as a ratio of the overall document page height. - Height *float32 } // The input document, either as bytes or as an S3 object. You pass image bytes to @@ -175,15 +175,15 @@ type BoundingBox struct { // object, the user must have permission to access the S3 object.

    type Document struct { - // Identifies an S3 object as the document source. The maximum size of a document - // that's stored in an S3 bucket is 5 MB. - S3Object *S3Object - // A blob of base64-encoded document bytes. The maximum size of a document that's // provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG // format. If you're using an AWS SDK to call Amazon Textract, you might not need // to base64-encode image bytes passed using the Bytes field. Bytes []byte + + // Identifies an S3 object as the document source. The maximum size of a document + // that's stored in an S3 bucket is 5 MB. + S3Object *S3Object } // The Amazon S3 bucket that contains the document to be processed. It's used by @@ -208,12 +208,12 @@ type DocumentMetadata struct { // elements. type Geometry struct { - // Within the bounding box, a fine-grained polygon around the recognized item. - Polygon []*Point - // An axis-aligned coarse representation of the location of the recognized item on // the document page. BoundingBox *BoundingBox + + // Within the bounding box, a fine-grained polygon around the recognized item. + Polygon []*Point } // Shows the results of the human in the loop evaluation. If there is no @@ -237,8 +237,10 @@ type HumanLoopActivationOutput struct { // review. type HumanLoopConfig struct { - // Sets attributes of the input data. - DataAttributes *HumanLoopDataAttributes + // The Amazon Resource Name (ARN) of the flow definition. + // + // This member is required. + FlowDefinitionArn *string // The name of the human workflow used for this image. This should be kept unique // within a region. @@ -246,10 +248,8 @@ type HumanLoopConfig struct { // This member is required. HumanLoopName *string - // The Amazon Resource Name (ARN) of the flow definition. - // - // This member is required. - FlowDefinitionArn *string + // Sets attributes of the input data. + DataAttributes *HumanLoopDataAttributes } // Allows you to set attributes of the image. Currently, you can declare an image @@ -266,16 +266,16 @@ type HumanLoopDataAttributes struct { // such as StartDocumentTextDetection (). type NotificationChannel struct { - // The Amazon SNS topic that Amazon Textract posts the completion status to. - // - // This member is required. - SNSTopicArn *string - // The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract // publishing permissions to the Amazon SNS topic. // // This member is required. RoleArn *string + + // The Amazon SNS topic that Amazon Textract posts the completion status to. + // + // This member is required. + SNSTopicArn *string } // The X and Y coordinates of a point on a document page. The X and Y values that @@ -301,16 +301,16 @@ type Point struct { // in the IDs array. type Relationship struct { + // An array of IDs for related blocks. You can get the type of the relationship + // from the Type element. + Ids []*string + // The type of relationship that the blocks in the IDs array have with the current // block. The relationship can be VALUE or CHILD. A relationship of type VALUE is a // list that contains the ID of the VALUE block that's associated with the KEY of a // key-value pair. A relationship of type CHILD is a list of IDs that identify WORD // blocks. Type RelationshipType - - // An array of IDs for related blocks. You can get the type of the relationship - // from the Type element. - Ids []*string } // The S3 bucket name and file name that identifies the document. The AWS Region @@ -319,6 +319,9 @@ type Relationship struct { // S3 bucket, the user must have permission to access the S3 bucket and file.

    type S3Object struct { + // The name of the S3 bucket. + Bucket *string + // The file name of the input document. Synchronous operations can use image files // that are in JPEG or PNG format. Asynchronous operations also support PDF format // files. @@ -326,9 +329,6 @@ type S3Object struct { // If the bucket has versioning enabled, you can specify the object version. Version *string - - // The name of the S3 bucket. - Bucket *string } // A warning about an issue that occurred during asynchronous text analysis diff --git a/service/transcribe/api_op_CreateMedicalVocabulary.go b/service/transcribe/api_op_CreateMedicalVocabulary.go index 3f37835ccaa..3668b821a4c 100644 --- a/service/transcribe/api_op_CreateMedicalVocabulary.go +++ b/service/transcribe/api_op_CreateMedicalVocabulary.go @@ -59,6 +59,14 @@ func (c *Client) CreateMedicalVocabulary(ctx context.Context, params *CreateMedi type CreateMedicalVocabularyInput struct { + // The language code used for the entries within your custom vocabulary. The + // language code of your custom vocabulary must match the language code of your + // transcription job. US English (en-US) is the only language code available for + // Amazon Transcribe Medical. + // + // This member is required. + LanguageCode types.LanguageCode + // The Amazon S3 location of the text file you use to define your custom // vocabulary. The URI must be in the same AWS region as the API endpoint you're // calling. Enter information about your VocabularyFileUri in the following format: @@ -74,14 +82,6 @@ type CreateMedicalVocabularyInput struct { // This member is required. VocabularyFileUri *string - // The language code used for the entries within your custom vocabulary. The - // language code of your custom vocabulary must match the language code of your - // transcription job. US English (en-US) is the only language code available for - // Amazon Transcribe Medical. - // - // This member is required. - LanguageCode types.LanguageCode - // The name of the custom vocabulary. This case-sensitive name must be unique // within an AWS account. If you try to create a vocabulary with the same name as a // previous vocabulary you will receive a ConflictException error. @@ -92,22 +92,22 @@ type CreateMedicalVocabularyInput struct { type CreateMedicalVocabularyOutput struct { + // If the VocabularyState field is FAILED, this field contains information about + // why the job failed. + FailureReason *string + // The language code you chose to describe the entries in your custom vocabulary. // US English (en-US) is the only valid language code for Amazon Transcribe // Medical. LanguageCode types.LanguageCode + // The date and time you created the vocabulary. + LastModifiedTime *time.Time + // The name of the vocabulary. The name must be unique within an AWS account. It is // also case-sensitive. VocabularyName *string - // If the VocabularyState field is FAILED, this field contains information about - // why the job failed. - FailureReason *string - - // The date and time you created the vocabulary. - LastModifiedTime *time.Time - // The processing state of your custom vocabulary in Amazon Transcribe Medical. If // the state is READY you can use the vocabulary in a StartMedicalTranscriptionJob // request. diff --git a/service/transcribe/api_op_CreateVocabulary.go b/service/transcribe/api_op_CreateVocabulary.go index 7d0b51af52a..7f3330cc3e1 100644 --- a/service/transcribe/api_op_CreateVocabulary.go +++ b/service/transcribe/api_op_CreateVocabulary.go @@ -59,6 +59,11 @@ func (c *Client) CreateVocabulary(ctx context.Context, params *CreateVocabularyI type CreateVocabularyInput struct { + // The language code of the vocabulary entries. + // + // This member is required. + LanguageCode types.LanguageCode + // The name of the vocabulary. The name must be unique within an AWS account. The // name is case-sensitive. If you try to create a vocabulary with the same name as // a previous vocabulary you will receive a ConflictException error. @@ -66,11 +71,6 @@ type CreateVocabularyInput struct { // This member is required. VocabularyName *string - // The language code of the vocabulary entries. - // - // This member is required. - LanguageCode types.LanguageCode - // An array of strings that contains the vocabulary entries. Phrases []*string @@ -88,13 +88,6 @@ type CreateVocabularyInput struct { type CreateVocabularyOutput struct { - // The date and time that the vocabulary was created. - LastModifiedTime *time.Time - - // The processing state of the vocabulary. When the VocabularyState field contains - // READY the vocabulary is ready to be used in a StartTranscriptionJob request. - VocabularyState types.VocabularyState - // If the VocabularyState field is FAILED, this field contains information about // why the job failed. FailureReason *string @@ -102,9 +95,16 @@ type CreateVocabularyOutput struct { // The language code of the vocabulary entries. LanguageCode types.LanguageCode + // The date and time that the vocabulary was created. + LastModifiedTime *time.Time + // The name of the vocabulary. VocabularyName *string + // The processing state of the vocabulary. When the VocabularyState field contains + // READY the vocabulary is ready to be used in a StartTranscriptionJob request. + VocabularyState types.VocabularyState + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/transcribe/api_op_CreateVocabularyFilter.go b/service/transcribe/api_op_CreateVocabularyFilter.go index 7b0bd7a401e..40bf3904363 100644 --- a/service/transcribe/api_op_CreateVocabularyFilter.go +++ b/service/transcribe/api_op_CreateVocabularyFilter.go @@ -59,6 +59,20 @@ func (c *Client) CreateVocabularyFilter(ctx context.Context, params *CreateVocab type CreateVocabularyFilterInput struct { + // The language code of the words in the vocabulary filter. All words in the filter + // must be in the same language. The vocabulary filter can only be used with + // transcription jobs in the specified language. + // + // This member is required. + LanguageCode types.LanguageCode + + // The vocabulary filter name. The name must be unique within the account that + // contains it.If you try to create a vocabulary filter with the same name as a + // previous vocabulary filter you will receive a ConflictException error. + // + // This member is required. + VocabularyFilterName *string + // The Amazon S3 location of a text file used as input to create the vocabulary // filter. Only use characters from the character set defined for custom // vocabularies. For a list of character sets, see Character Sets for Custom @@ -69,13 +83,6 @@ type CreateVocabularyFilterInput struct { // can't use the Words parameter. VocabularyFilterFileUri *string - // The language code of the words in the vocabulary filter. All words in the filter - // must be in the same language. The vocabulary filter can only be used with - // transcription jobs in the specified language. - // - // This member is required. - LanguageCode types.LanguageCode - // The words to use in the vocabulary filter. Only use characters from the // character set defined for custom vocabularies. For a list of character sets, see // Character Sets for Custom Vocabularies @@ -83,25 +90,18 @@ type CreateVocabularyFilterInput struct { // If you provide a list of words in the Words parameter, you can't use the // VocabularyFilterFileUri parameter. Words []*string - - // The vocabulary filter name. The name must be unique within the account that - // contains it.If you try to create a vocabulary filter with the same name as a - // previous vocabulary filter you will receive a ConflictException error. - // - // This member is required. - VocabularyFilterName *string } type CreateVocabularyFilterOutput struct { - // The name of the vocabulary filter. - VocabularyFilterName *string + // The language code of the words in the collection. + LanguageCode types.LanguageCode // The date and time that the vocabulary filter was modified. LastModifiedTime *time.Time - // The language code of the words in the collection. - LanguageCode types.LanguageCode + // The name of the vocabulary filter. + VocabularyFilterName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/transcribe/api_op_GetMedicalVocabulary.go b/service/transcribe/api_op_GetMedicalVocabulary.go index b9ae9426dd1..84e926087f3 100644 --- a/service/transcribe/api_op_GetMedicalVocabulary.go +++ b/service/transcribe/api_op_GetMedicalVocabulary.go @@ -72,22 +72,22 @@ type GetMedicalVocabularyOutput struct { // limited time. DownloadUri *string - // The processing state of the vocabulary. - VocabularyState types.VocabularyState + // If the VocabularyState is FAILED, this field contains information about why the + // job failed. + FailureReason *string - // The valid name that Amazon Transcribe Medical returns. - VocabularyName *string + // The valid language code returned for your vocabulary entries. + LanguageCode types.LanguageCode // The date and time the vocabulary was last modified with a text file different // from what was previously used. LastModifiedTime *time.Time - // If the VocabularyState is FAILED, this field contains information about why the - // job failed. - FailureReason *string + // The valid name that Amazon Transcribe Medical returns. + VocabularyName *string - // The valid language code returned for your vocabulary entries. - LanguageCode types.LanguageCode + // The processing state of the vocabulary. + VocabularyState types.VocabularyState // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/transcribe/api_op_GetVocabulary.go b/service/transcribe/api_op_GetVocabulary.go index 1c9917a9bfc..6bd711323d8 100644 --- a/service/transcribe/api_op_GetVocabulary.go +++ b/service/transcribe/api_op_GetVocabulary.go @@ -67,25 +67,25 @@ type GetVocabularyInput struct { type GetVocabularyOutput struct { - // The date and time that the vocabulary was last modified. - LastModifiedTime *time.Time - // The S3 location where the vocabulary is stored. Use this URI to get the contents // of the vocabulary. The URI is available for a limited time. DownloadUri *string - // The processing state of the vocabulary. - VocabularyState types.VocabularyState - - // The name of the vocabulary to return. - VocabularyName *string + // If the VocabularyState field is FAILED, this field contains information about + // why the job failed. + FailureReason *string // The language code of the vocabulary entries. LanguageCode types.LanguageCode - // If the VocabularyState field is FAILED, this field contains information about - // why the job failed. - FailureReason *string + // The date and time that the vocabulary was last modified. + LastModifiedTime *time.Time + + // The name of the vocabulary to return. + VocabularyName *string + + // The processing state of the vocabulary. + VocabularyState types.VocabularyState // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/transcribe/api_op_GetVocabularyFilter.go b/service/transcribe/api_op_GetVocabularyFilter.go index 6fb9b133539..7fc3977053b 100644 --- a/service/transcribe/api_op_GetVocabularyFilter.go +++ b/service/transcribe/api_op_GetVocabularyFilter.go @@ -66,18 +66,18 @@ type GetVocabularyFilterInput struct { type GetVocabularyFilterOutput struct { + // The URI of the list of words in the vocabulary filter. You can use this URI to + // get the list of words. + DownloadUri *string + // The language code of the words in the vocabulary filter. LanguageCode types.LanguageCode - // The name of the vocabulary filter. - VocabularyFilterName *string - // The date and time that the contents of the vocabulary filter were updated. LastModifiedTime *time.Time - // The URI of the list of words in the vocabulary filter. You can use this URI to - // get the list of words. - DownloadUri *string + // The name of the vocabulary filter. + VocabularyFilterName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/transcribe/api_op_ListMedicalTranscriptionJobs.go b/service/transcribe/api_op_ListMedicalTranscriptionJobs.go index 68350946704..6667a66b051 100644 --- a/service/transcribe/api_op_ListMedicalTranscriptionJobs.go +++ b/service/transcribe/api_op_ListMedicalTranscriptionJobs.go @@ -61,24 +61,27 @@ type ListMedicalTranscriptionJobsInput struct { // contains the specified string. JobNameContains *string - // When specified, returns only medical transcription jobs with the specified - // status. Jobs are ordered by creation date, with the newest jobs returned first. - // If you don't specify a status, Amazon Transcribe Medical returns all - // transcription jobs ordered by creation date. - Status types.TranscriptionJobStatus + // The maximum number of medical transcription jobs to return in the response. IF + // there are fewer results in the list, this response contains only the actual + // results. + MaxResults *int32 // If you a receive a truncated result in the previous request of // ListMedicalTranscriptionJobs, include NextToken to fetch the next set of jobs. NextToken *string - // The maximum number of medical transcription jobs to return in the response. IF - // there are fewer results in the list, this response contains only the actual - // results. - MaxResults *int32 + // When specified, returns only medical transcription jobs with the specified + // status. Jobs are ordered by creation date, with the newest jobs returned first. + // If you don't specify a status, Amazon Transcribe Medical returns all + // transcription jobs ordered by creation date. + Status types.TranscriptionJobStatus } type ListMedicalTranscriptionJobsOutput struct { + // A list of objects containing summary information for a transcription job. + MedicalTranscriptionJobSummaries []*types.MedicalTranscriptionJobSummary + // The ListMedicalTranscriptionJobs operation returns a page of jobs at a time. The // maximum size of the page is set by the MaxResults parameter. If the number of // jobs exceeds what can fit on a page, Amazon Transcribe Medical returns the @@ -86,9 +89,6 @@ type ListMedicalTranscriptionJobsOutput struct { // ListMedicalTranscriptionJobs operation to return in the next page of jobs. NextToken *string - // A list of objects containing summary information for a transcription job. - MedicalTranscriptionJobSummaries []*types.MedicalTranscriptionJobSummary - // The requested status of the medical transcription jobs returned. Status types.TranscriptionJobStatus diff --git a/service/transcribe/api_op_ListMedicalVocabularies.go b/service/transcribe/api_op_ListMedicalVocabularies.go index d2ca7a48d4a..cf78ca79779 100644 --- a/service/transcribe/api_op_ListMedicalVocabularies.go +++ b/service/transcribe/api_op_ListMedicalVocabularies.go @@ -61,10 +61,6 @@ type ListMedicalVocabulariesInput struct { // The maximum number of vocabularies to return in the response. MaxResults *int32 - // When specified, only returns vocabularies with the VocabularyState equal to the - // specified vocabulary state. - StateEquals types.VocabularyState - // Returns vocabularies in the list whose name contains the specified string. The // search is case-insensitive, ListMedicalVocabularies returns both // "vocabularyname" and "VocabularyName" in the response list. @@ -73,17 +69,14 @@ type ListMedicalVocabulariesInput struct { // If the result of your previous request to ListMedicalVocabularies was truncated, // include the NextToken to fetch the next set of jobs. NextToken *string + + // When specified, only returns vocabularies with the VocabularyState equal to the + // specified vocabulary state. + StateEquals types.VocabularyState } type ListMedicalVocabulariesOutput struct { - // The requested vocabulary state. - Status types.VocabularyState - - // A list of objects that describe the vocabularies that match the search criteria - // in the request. - Vocabularies []*types.VocabularyInfo - // The ListMedicalVocabularies operation returns a page of vocabularies at a time. // The maximum size of the page is set by the MaxResults parameter. If there are // more jobs in the list than the page size, Amazon Transcribe Medical returns the @@ -91,6 +84,13 @@ type ListMedicalVocabulariesOutput struct { // ListMedicalVocabularies operation to return the next page of jobs. NextToken *string + // The requested vocabulary state. + Status types.VocabularyState + + // A list of objects that describe the vocabularies that match the search criteria + // in the request. + Vocabularies []*types.VocabularyInfo + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/transcribe/api_op_ListTranscriptionJobs.go b/service/transcribe/api_op_ListTranscriptionJobs.go index ede764d5645..3b61fef2f58 100644 --- a/service/transcribe/api_op_ListTranscriptionJobs.go +++ b/service/transcribe/api_op_ListTranscriptionJobs.go @@ -60,19 +60,19 @@ type ListTranscriptionJobsInput struct { // contains the specified string. JobNameContains *string - // When specified, returns only transcription jobs with the specified status. Jobs - // are ordered by creation date, with the newest jobs returned first. If you don’t - // specify a status, Amazon Transcribe returns all transcription jobs ordered by - // creation date. - Status types.TranscriptionJobStatus + // The maximum number of jobs to return in the response. If there are fewer results + // in the list, this response contains only the actual results. + MaxResults *int32 // If the result of the previous request to ListTranscriptionJobs was truncated, // include the NextToken to fetch the next set of jobs. NextToken *string - // The maximum number of jobs to return in the response. If there are fewer results - // in the list, this response contains only the actual results. - MaxResults *int32 + // When specified, returns only transcription jobs with the specified status. Jobs + // are ordered by creation date, with the newest jobs returned first. If you don’t + // specify a status, Amazon Transcribe returns all transcription jobs ordered by + // creation date. + Status types.TranscriptionJobStatus } type ListTranscriptionJobsOutput struct { diff --git a/service/transcribe/api_op_ListVocabularies.go b/service/transcribe/api_op_ListVocabularies.go index a8b16c6bdd2..2d5c5caa778 100644 --- a/service/transcribe/api_op_ListVocabularies.go +++ b/service/transcribe/api_op_ListVocabularies.go @@ -57,14 +57,6 @@ func (c *Client) ListVocabularies(ctx context.Context, params *ListVocabulariesI type ListVocabulariesInput struct { - // When specified, only returns vocabularies with the VocabularyState field equal - // to the specified state. - StateEquals types.VocabularyState - - // If the result of the previous request to ListVocabularies was truncated, include - // the NextToken to fetch the next set of jobs. - NextToken *string - // The maximum number of vocabularies to return in the response. If there are fewer // results in the list, this response contains only the actual results. MaxResults *int32 @@ -74,13 +66,18 @@ type ListVocabulariesInput struct { // case-insensitive, ListVocabularies returns both "vocabularyname" and // "VocabularyName" in the response list. NameContains *string + + // If the result of the previous request to ListVocabularies was truncated, include + // the NextToken to fetch the next set of jobs. + NextToken *string + + // When specified, only returns vocabularies with the VocabularyState field equal + // to the specified state. + StateEquals types.VocabularyState } type ListVocabulariesOutput struct { - // The requested vocabulary state. - Status types.VocabularyState - // The ListVocabularies operation returns a page of vocabularies at a time. The // maximum size of the page is set by the MaxResults parameter. If there are more // jobs in the list than the page size, Amazon Transcribe returns the NextPage @@ -88,6 +85,9 @@ type ListVocabulariesOutput struct { // to return in the next page of jobs. NextToken *string + // The requested vocabulary state. + Status types.VocabularyState + // A list of objects that describe the vocabularies that match the search criteria // in the request. Vocabularies []*types.VocabularyInfo diff --git a/service/transcribe/api_op_ListVocabularyFilters.go b/service/transcribe/api_op_ListVocabularyFilters.go index 6f3784b8bf4..6ae40de32f4 100644 --- a/service/transcribe/api_op_ListVocabularyFilters.go +++ b/service/transcribe/api_op_ListVocabularyFilters.go @@ -56,17 +56,17 @@ func (c *Client) ListVocabularyFilters(ctx context.Context, params *ListVocabula type ListVocabularyFiltersInput struct { - // If the result of the previous request to ListVocabularyFilters was truncated, - // include the NextToken to fetch the next set of collections. - NextToken *string + // The maximum number of filters to return in the response. If there are fewer + // results in the list, this response contains only the actual results. + MaxResults *int32 // Filters the response so that it only contains vocabulary filters whose name // contains the specified string. NameContains *string - // The maximum number of filters to return in the response. If there are fewer - // results in the list, this response contains only the actual results. - MaxResults *int32 + // If the result of the previous request to ListVocabularyFilters was truncated, + // include the NextToken to fetch the next set of collections. + NextToken *string } type ListVocabularyFiltersOutput struct { diff --git a/service/transcribe/api_op_StartMedicalTranscriptionJob.go b/service/transcribe/api_op_StartMedicalTranscriptionJob.go index eaeab0c532b..5734b33ea3d 100644 --- a/service/transcribe/api_op_StartMedicalTranscriptionJob.go +++ b/service/transcribe/api_op_StartMedicalTranscriptionJob.go @@ -57,10 +57,17 @@ func (c *Client) StartMedicalTranscriptionJob(ctx context.Context, params *Start type StartMedicalTranscriptionJobInput struct { - // The medical specialty of any clinician speaking in the input media. + // The language code for the language spoken in the input media file. US English + // (en-US) is the valid value for medical transcription jobs. Any other value you + // enter for language code results in a BadRequestException error. // // This member is required. - Specialty types.Specialty + LanguageCode types.LanguageCode + + // Describes the input media file in a transcription request. + // + // This member is required. + Media *types.Media // The name of the medical transcription job. You can't use the strings "." or ".." // by themselves as the job name. The name must also be unique within an AWS @@ -86,12 +93,10 @@ type StartMedicalTranscriptionJobInput struct { // This member is required. OutputBucketName *string - // The language code for the language spoken in the input media file. US English - // (en-US) is the valid value for medical transcription jobs. Any other value you - // enter for language code results in a BadRequestException error. + // The medical specialty of any clinician speaking in the input media. // // This member is required. - LanguageCode types.LanguageCode + Specialty types.Specialty // The type of speech in the input audio. CONVERSATION refers to conversations // between two or more speakers, e.g., a conversations between doctors and @@ -104,9 +109,6 @@ type StartMedicalTranscriptionJobInput struct { // The audio format of the input media file. MediaFormat types.MediaFormat - // Optional settings for the medical transcription job. - Settings *types.MedicalTranscriptionSetting - // The sample rate, in Hertz, of the audio track in the input media file. If you do // not specify the media sample rate, Amazon Transcribe Medical determines the // sample rate. If you specify the sample rate, it must match the rate detected by @@ -115,11 +117,6 @@ type StartMedicalTranscriptionJobInput struct { // sample rate. MediaSampleRateHertz *int32 - // Describes the input media file in a transcription request. - // - // This member is required. - Media *types.Media - // The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used // to encrypt the output of the transcription job. The user calling the // StartMedicalTranscriptionJob () operation must have permission to use the @@ -147,6 +144,9 @@ type StartMedicalTranscriptionJobInput struct { // to encrypt your output, you must also specify an output location in the // OutputBucketName parameter. OutputEncryptionKMSKeyId *string + + // Optional settings for the medical transcription job. + Settings *types.MedicalTranscriptionSetting } type StartMedicalTranscriptionJobOutput struct { diff --git a/service/transcribe/api_op_StartTranscriptionJob.go b/service/transcribe/api_op_StartTranscriptionJob.go index 0b9839bb342..e1ac9f213e2 100644 --- a/service/transcribe/api_op_StartTranscriptionJob.go +++ b/service/transcribe/api_op_StartTranscriptionJob.go @@ -57,13 +57,34 @@ func (c *Client) StartTranscriptionJob(ctx context.Context, params *StartTranscr type StartTranscriptionJobInput struct { + // The language code for the language used in the input media file. + // + // This member is required. + LanguageCode types.LanguageCode + + // An object that describes the input media for a transcription job. + // + // This member is required. + Media *types.Media + + // The name of the job. Note that you can't use the strings "." or ".." by + // themselves as the job name. The name must also be unique within an AWS account. + // If you try to create a transcription job with the same name as a previous + // transcription job you will receive a ConflictException error. + // + // This member is required. + TranscriptionJobName *string + + // An object that contains the request parameters for content redaction. + ContentRedaction *types.ContentRedaction + // Provides information about how a transcription job is executed. Use this field // to indicate that the job can be queued for deferred execution if the concurrency // limit is reached and there are no slots available to immediately run the job. JobExecutionSettings *types.JobExecutionSettings - // A Settings object that provides optional settings for a transcription job. - Settings *types.Settings + // The format of the input media file. + MediaFormat types.MediaFormat // The sample rate, in Hertz, of the audio track in the input media file. If you do // not specify the media sample rate, Amazon Transcribe determines the sample rate. @@ -91,14 +112,6 @@ type StartTranscriptionJobInput struct { // in the TranscriptFileUri field. Use this URL to download the transcription. OutputBucketName *string - // The language code for the language used in the input media file. - // - // This member is required. - LanguageCode types.LanguageCode - - // The format of the input media file. - MediaFormat types.MediaFormat - // The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used // to encrypt the output of the transcription job. The user calling the // StartTranscriptionJob operation must have permission to use the specified KMS @@ -126,21 +139,8 @@ type StartTranscriptionJobInput struct { // you must also specify an output location in the OutputBucketName parameter. OutputEncryptionKMSKeyId *string - // An object that contains the request parameters for content redaction. - ContentRedaction *types.ContentRedaction - - // An object that describes the input media for a transcription job. - // - // This member is required. - Media *types.Media - - // The name of the job. Note that you can't use the strings "." or ".." by - // themselves as the job name. The name must also be unique within an AWS account. - // If you try to create a transcription job with the same name as a previous - // transcription job you will receive a ConflictException error. - // - // This member is required. - TranscriptionJobName *string + // A Settings object that provides optional settings for a transcription job. + Settings *types.Settings } type StartTranscriptionJobOutput struct { diff --git a/service/transcribe/api_op_UpdateMedicalVocabulary.go b/service/transcribe/api_op_UpdateMedicalVocabulary.go index 753808b422e..70b504fe0cc 100644 --- a/service/transcribe/api_op_UpdateMedicalVocabulary.go +++ b/service/transcribe/api_op_UpdateMedicalVocabulary.go @@ -60,18 +60,6 @@ func (c *Client) UpdateMedicalVocabulary(ctx context.Context, params *UpdateMedi type UpdateMedicalVocabularyInput struct { - // The Amazon S3 location of the text file containing the definition of the custom - // vocabulary. The URI must be in the same AWS region as the API endpoint you are - // calling. You can see the fields you need to enter for you Amazon S3 location in - // the example URI here: https://s3..amazonaws.com/// For example: - // https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt For more - // information about S3 object names, see Object Keys - // (http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys) - // in the Amazon S3 Developer Guide. For more information about custom vocabularies - // in Amazon Transcribe Medical, see Medical Custom Vocabularies - // (http://docs.aws.amazon.com/transcribe/latest/dg/how-it-works.html#how-vocabulary). - VocabularyFileUri *string - // The language code of the entries in the updated vocabulary. US English (en-US) // is the only valid language code in Amazon Transcribe Medical. // @@ -84,6 +72,18 @@ type UpdateMedicalVocabularyInput struct { // // This member is required. VocabularyName *string + + // The Amazon S3 location of the text file containing the definition of the custom + // vocabulary. The URI must be in the same AWS region as the API endpoint you are + // calling. You can see the fields you need to enter for you Amazon S3 location in + // the example URI here: https://s3..amazonaws.com/// For example: + // https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt For more + // information about S3 object names, see Object Keys + // (http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys) + // in the Amazon S3 Developer Guide. For more information about custom vocabularies + // in Amazon Transcribe Medical, see Medical Custom Vocabularies + // (http://docs.aws.amazon.com/transcribe/latest/dg/how-it-works.html#how-vocabulary). + VocabularyFileUri *string } type UpdateMedicalVocabularyOutput struct { @@ -92,12 +92,12 @@ type UpdateMedicalVocabularyOutput struct { // English (en-US) is the only language supported in Amazon Transcribe Medical. LanguageCode types.LanguageCode - // The name of the updated vocabulary. - VocabularyName *string - // The date and time the vocabulary was updated. LastModifiedTime *time.Time + // The name of the updated vocabulary. + VocabularyName *string + // The processing state of the update to the vocabulary. When the VocabularyState // field is READY the vocabulary is ready to be used in a // StartMedicalTranscriptionJob request. diff --git a/service/transcribe/api_op_UpdateVocabulary.go b/service/transcribe/api_op_UpdateVocabulary.go index 4639389aa19..1874d8f2ec0 100644 --- a/service/transcribe/api_op_UpdateVocabulary.go +++ b/service/transcribe/api_op_UpdateVocabulary.go @@ -60,9 +60,6 @@ func (c *Client) UpdateVocabulary(ctx context.Context, params *UpdateVocabularyI type UpdateVocabularyInput struct { - // An array of strings containing the vocabulary entries. - Phrases []*string - // The language code of the vocabulary entries. // // This member is required. @@ -75,6 +72,9 @@ type UpdateVocabularyInput struct { // This member is required. VocabularyName *string + // An array of strings containing the vocabulary entries. + Phrases []*string + // The S3 location of the text file that contains the definition of the custom // vocabulary. The URI must be in the same region as the API endpoint that you are // calling. The general form is

    For example:

    For more information about @@ -92,16 +92,16 @@ type UpdateVocabularyOutput struct { // The language code of the vocabulary entries. LanguageCode types.LanguageCode - // The processing state of the vocabulary. When the VocabularyState field contains - // READY the vocabulary is ready to be used in a StartTranscriptionJob request. - VocabularyState types.VocabularyState - // The date and time that the vocabulary was updated. LastModifiedTime *time.Time // The name of the vocabulary that was updated. VocabularyName *string + // The processing state of the vocabulary. When the VocabularyState field contains + // READY the vocabulary is ready to be used in a StartTranscriptionJob request. + VocabularyState types.VocabularyState + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/transcribe/api_op_UpdateVocabularyFilter.go b/service/transcribe/api_op_UpdateVocabularyFilter.go index 415b0f5d319..8821f2b417f 100644 --- a/service/transcribe/api_op_UpdateVocabularyFilter.go +++ b/service/transcribe/api_op_UpdateVocabularyFilter.go @@ -86,14 +86,14 @@ type UpdateVocabularyFilterInput struct { type UpdateVocabularyFilterOutput struct { - // The name of the updated vocabulary filter. - VocabularyFilterName *string + // The language code of the words in the vocabulary filter. + LanguageCode types.LanguageCode // The date and time that the vocabulary filter was updated. LastModifiedTime *time.Time - // The language code of the words in the vocabulary filter. - LanguageCode types.LanguageCode + // The name of the updated vocabulary filter. + VocabularyFilterName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/transcribe/go.mod b/service/transcribe/go.mod index 76a5a12e8bf..1b7a62ca06b 100644 --- a/service/transcribe/go.mod +++ b/service/transcribe/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/transcribe go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/transcribe/types/types.go b/service/transcribe/types/types.go index 14dc248ab01..47d0eb377fc 100644 --- a/service/transcribe/types/types.go +++ b/service/transcribe/types/types.go @@ -68,6 +68,12 @@ type MedicalTranscript struct { // job. type MedicalTranscriptionJob struct { + // A timestamp that shows when the job was completed. + CompletionTime *time.Time + + // A timestamp that shows when the job was created. + CreationTime *time.Time + // If the TranscriptionJobStatus field is FAILED, this field contains information // about why the job failed. The FailureReason field contains one of the following // values: @@ -106,24 +112,30 @@ type MedicalTranscriptionJob struct { // Amazon Web Services General Reference FailureReason *string - // The type of speech in the transcription job. CONVERSATION is generally used for - // patient-physician dialogues. DICTATION is the setting for physicians speaking - // their notes after seeing a patient. For more information, see how-it-works-med - // () - Type Type + // The language code for the language spoken in the source audio file. US English + // (en-US) is the only supported language for medical transcriptions. Any other + // value you enter for language code results in a BadRequestException error. + LanguageCode LanguageCode - // A timestamp that shows when the job was created. - CreationTime *time.Time + // Describes the input media file in a transcription request. + Media *Media + + // The format of the input media file. + MediaFormat MediaFormat + + // The sample rate, in Hertz, of the source audio containing medical information. + // If you don't specify the sample rate, Amazon Transcribe Medical determines it + // for you. If you choose to specify the sample rate, it must match the rate + // detected by Amazon Transcribe Medical. In most cases, you should leave the + // MediaSampleHertz blank and let Amazon Transcribe Medical determine the sample + // rate. + MediaSampleRateHertz *int32 // The name for a given medical transcription job. MedicalTranscriptionJobName *string - // Describes the input media file in a transcription request. - Media *Media - - // An object that contains the MedicalTranscript. The MedicalTranscript contains - // the TranscriptFileUri. - Transcript *MedicalTranscript + // Object that contains object. + Settings *MedicalTranscriptionSetting // The medical specialty of any clinicians providing a dictation or having a // conversation. PRIMARYCARE is the only available setting for this object. This @@ -133,50 +145,48 @@ type MedicalTranscriptionJob struct { // * Family Medicine Specialty Specialty - // The completion status of a medical transcription job. - TranscriptionJobStatus TranscriptionJobStatus - - // A timestamp that shows when the job was completed. - CompletionTime *time.Time - - // Object that contains object. - Settings *MedicalTranscriptionSetting - // A timestamp that shows when the job started processing. StartTime *time.Time - // The sample rate, in Hertz, of the source audio containing medical information. - // If you don't specify the sample rate, Amazon Transcribe Medical determines it - // for you. If you choose to specify the sample rate, it must match the rate - // detected by Amazon Transcribe Medical. In most cases, you should leave the - // MediaSampleHertz blank and let Amazon Transcribe Medical determine the sample - // rate. - MediaSampleRateHertz *int32 + // An object that contains the MedicalTranscript. The MedicalTranscript contains + // the TranscriptFileUri. + Transcript *MedicalTranscript - // The format of the input media file. - MediaFormat MediaFormat + // The completion status of a medical transcription job. + TranscriptionJobStatus TranscriptionJobStatus - // The language code for the language spoken in the source audio file. US English - // (en-US) is the only supported language for medical transcriptions. Any other - // value you enter for language code results in a BadRequestException error. - LanguageCode LanguageCode + // The type of speech in the transcription job. CONVERSATION is generally used for + // patient-physician dialogues. DICTATION is the setting for physicians speaking + // their notes after seeing a patient. For more information, see how-it-works-med + // () + Type Type } // Provides summary information about a transcription job. type MedicalTranscriptionJobSummary struct { + // A timestamp that shows when the job was completed. + CompletionTime *time.Time + + // A timestamp that shows when the medical transcription job was created. + CreationTime *time.Time + // If the TranscriptionJobStatus field is FAILED, a description of the error. FailureReason *string + // The language of the transcript in the source audio file. + LanguageCode LanguageCode + + // The name of a medical transcription job. + MedicalTranscriptionJobName *string + // Indicates the location of the transcription job's output. The CUSTOMER_BUCKET is // the S3 location provided in the OutputBucketName field when the OutputLocationType OutputLocationType - // The speech of the clinician in the input audio. - Type Type - - // A timestamp that shows when the job was completed. - CompletionTime *time.Time + // The medical specialty of the transcription job. Primary care is the only valid + // value. + Specialty Specialty // A timestamp that shows when the job began processing. StartTime *time.Time @@ -184,30 +194,27 @@ type MedicalTranscriptionJobSummary struct { // The status of the medical transcription job. TranscriptionJobStatus TranscriptionJobStatus - // The name of a medical transcription job. - MedicalTranscriptionJobName *string - - // The language of the transcript in the source audio file. - LanguageCode LanguageCode - - // A timestamp that shows when the medical transcription job was created. - CreationTime *time.Time - - // The medical specialty of the transcription job. Primary care is the only valid - // value. - Specialty Specialty + // The speech of the clinician in the input audio. + Type Type } // Optional settings for the StartMedicalTranscriptionJob () operation. type MedicalTranscriptionSetting struct { - // Determines whether the transcription job uses speaker recognition to identify - // different speakers in the input audio. Speaker recongition labels individual - // speakers in the audio file. If you set the ShowSpeakerLabels field to true, you - // must also set the maximum number of speaker labels in the MaxSpeakerLabels - // field. You can't set both ShowSpeakerLabels and ChannelIdentification in the - // same request. If you set both, your request returns a BadRequestException. - ShowSpeakerLabels *bool + // Instructs Amazon Transcribe Medical to process each audio channel separately and + // then merge the transcription output of each channel into a single transcription. + // Amazon Transcribe Medical also produces a transcription of each item detected on + // an audio channel, including the start time and end time of the item and + // alternative transcriptions of item. The alternative transcriptions also come + // with confidence scores provided by Amazon Transcribe Medical. You can't set both + // ShowSpeakerLabels and ChannelIdentification in the same request. If you set + // both, your request returns a BadRequestException + ChannelIdentification *bool + + // The maximum number of alternatives that you tell the service to return. If you + // specify the MaxAlternatives field, you must set the ShowAlternatives field to + // true. + MaxAlternatives *int32 // The maximum number of speakers to identify in the input audio. If there are more // speakers in the audio than this number, multiple speakers are identified as a @@ -221,23 +228,16 @@ type MedicalTranscriptionSetting struct { // MaxAlternatives field. ShowAlternatives *bool - // The maximum number of alternatives that you tell the service to return. If you - // specify the MaxAlternatives field, you must set the ShowAlternatives field to - // true. - MaxAlternatives *int32 + // Determines whether the transcription job uses speaker recognition to identify + // different speakers in the input audio. Speaker recongition labels individual + // speakers in the audio file. If you set the ShowSpeakerLabels field to true, you + // must also set the maximum number of speaker labels in the MaxSpeakerLabels + // field. You can't set both ShowSpeakerLabels and ChannelIdentification in the + // same request. If you set both, your request returns a BadRequestException. + ShowSpeakerLabels *bool // The name of the vocabulary to use when processing a medical transcription job. VocabularyName *string - - // Instructs Amazon Transcribe Medical to process each audio channel separately and - // then merge the transcription output of each channel into a single transcription. - // Amazon Transcribe Medical also produces a transcription of each item detected on - // an audio channel, including the start time and end time of the item and - // alternative transcriptions of item. The alternative transcriptions also come - // with confidence scores provided by Amazon Transcribe Medical. You can't set both - // ShowSpeakerLabels and ChannelIdentification in the same request. If you set - // both, your request returns a BadRequestException - ChannelIdentification *bool } // Provides optional settings for the StartTranscriptionJob operation. @@ -253,15 +253,17 @@ type Settings struct { // a BadRequestException. ChannelIdentification *bool - // The name of the vocabulary filter to use when transcribing the audio. The filter - // that you specify must have the same language code as the transcription job. - VocabularyFilterName *string - // The number of alternative transcriptions that the service should return. If you // specify the MaxAlternatives field, you must set the ShowAlternatives field to // true. MaxAlternatives *int32 + // The maximum number of speakers to identify in the input audio. If there are more + // speakers in the audio than this number, multiple speakers are identified as a + // single speaker. If you specify the MaxSpeakerLabels field, you must set the + // ShowSpeakerLabels field to true. + MaxSpeakerLabels *int32 + // Determines whether the transcription contains alternative transcriptions. If you // set the ShowAlternatives field to true, you must also set the maximum number of // alternatives to return in the MaxAlternatives field. @@ -275,37 +277,35 @@ type Settings struct { // If you set both, your request returns a BadRequestException. ShowSpeakerLabels *bool - // The maximum number of speakers to identify in the input audio. If there are more - // speakers in the audio than this number, multiple speakers are identified as a - // single speaker. If you specify the MaxSpeakerLabels field, you must set the - // ShowSpeakerLabels field to true. - MaxSpeakerLabels *int32 - - // The name of a vocabulary to use when processing the transcription job. - VocabularyName *string - // Set to mask to remove filtered text from the transcript and replace it with // three asterisks ("***") as placeholder text. Set to remove to remove filtered // text from the transcript without using placeholder text. VocabularyFilterMethod VocabularyFilterMethod + + // The name of the vocabulary filter to use when transcribing the audio. The filter + // that you specify must have the same language code as the transcription job. + VocabularyFilterName *string + + // The name of a vocabulary to use when processing the transcription job. + VocabularyName *string } // Identifies the location of a transcription. type Transcript struct { - // The S3 object location of the the transcript. Use this URI to access the - // transcript. If you specified an S3 bucket in the OutputBucketName field when you - // created the job, this is the URI of that bucket. If you chose to store the - // transcript in Amazon Transcribe, this is a shareable URL that provides secure - // access to that location. - TranscriptFileUri *string - // The S3 object location of the redacted transcript.

    Use this URI to access // the redacated transcript. If you specified an S3 bucket in the // OutputBucketName field when you created the job, this is the URI of // that bucket. If you chose to store the transcript in Amazon Transcribe, this is // a shareable URL that provides secure access to that location.

    RedactedTranscriptFileUri *string + + // The S3 object location of the the transcript. Use this URI to access the + // transcript. If you specified an S3 bucket in the OutputBucketName field when you + // created the job, this is the URI of that bucket. If you chose to store the + // transcript in Amazon Transcribe, this is a shareable URL that provides secure + // access to that location. + TranscriptFileUri *string } // Describes an asynchronous transcription job that was created with the @@ -315,42 +315,12 @@ type TranscriptionJob struct { // A timestamp that shows when the job was completed. CompletionTime *time.Time - // The status of the transcription job. - TranscriptionJobStatus TranscriptionJobStatus - - // Optional settings for the transcription job. Use these settings to turn on - // speaker recognition, to set the maximum number of speakers that should be - // identified and to specify a custom vocabulary to use when processing the - // transcription job. - Settings *Settings - - // The name of the transcription job. - TranscriptionJobName *string - - // The language code for the input speech. - LanguageCode LanguageCode - - // The sample rate, in Hertz, of the audio track in the input media file. - MediaSampleRateHertz *int32 - - // A timestamp that shows with the job was started processing. - StartTime *time.Time - - // The format of the input media file. - MediaFormat MediaFormat - - // An object that describes the output of the transcription job. - Transcript *Transcript - - // An object that describes the input media for the transcription job. - Media *Media + // An object that describes content redaction settings for the transcription job. + ContentRedaction *ContentRedaction // A timestamp that shows when the job was created. CreationTime *time.Time - // An object that describes content redaction settings for the transcription job. - ContentRedaction *ContentRedaction - // If the TranscriptionJobStatus field is FAILED, this field contains information // about why the job failed. The FailureReason field can contain one of the // following values: @@ -390,33 +360,56 @@ type TranscriptionJob struct { // Provides information about how a transcription job is executed. JobExecutionSettings *JobExecutionSettings -} -// Provides a summary of information about a transcription job. -type TranscriptionJobSummary struct { + // The language code for the input speech. + LanguageCode LanguageCode - // A timestamp that shows when the job was created. - CreationTime *time.Time + // An object that describes the input media for the transcription job. + Media *Media - // A timestamp that shows when the job started processing. - StartTime *time.Time + // The format of the input media file. + MediaFormat MediaFormat - // If the TranscriptionJobStatus field is FAILED, a description of the error. - FailureReason *string + // The sample rate, in Hertz, of the audio track in the input media file. + MediaSampleRateHertz *int32 - // The content redaction settings of the transcription job. - ContentRedaction *ContentRedaction + // Optional settings for the transcription job. Use these settings to turn on + // speaker recognition, to set the maximum number of speakers that should be + // identified and to specify a custom vocabulary to use when processing the + // transcription job. + Settings *Settings - // The status of the transcription job. When the status is COMPLETED, use the - // GetTranscriptionJob operation to get the results of the transcription. - TranscriptionJobStatus TranscriptionJobStatus + // A timestamp that shows with the job was started processing. + StartTime *time.Time + + // An object that describes the output of the transcription job. + Transcript *Transcript // The name of the transcription job. TranscriptionJobName *string + // The status of the transcription job. + TranscriptionJobStatus TranscriptionJobStatus +} + +// Provides a summary of information about a transcription job. +type TranscriptionJobSummary struct { + // A timestamp that shows when the job was completed. CompletionTime *time.Time + // The content redaction settings of the transcription job. + ContentRedaction *ContentRedaction + + // A timestamp that shows when the job was created. + CreationTime *time.Time + + // If the TranscriptionJobStatus field is FAILED, a description of the error. + FailureReason *string + + // The language code for the input speech. + LanguageCode LanguageCode + // Indicates the location of the output of the transcription job. If the value is // CUSTOMER_BUCKET then the location is the S3 bucket specified in the // outputBucketName field when the transcription job was started with the @@ -425,8 +418,15 @@ type TranscriptionJobSummary struct { // GetTranscriptionJob response's TranscriptFileUri field. OutputLocationType OutputLocationType - // The language code for the input speech. - LanguageCode LanguageCode + // A timestamp that shows when the job started processing. + StartTime *time.Time + + // The name of the transcription job. + TranscriptionJobName *string + + // The status of the transcription job. When the status is COMPLETED, use the + // GetTranscriptionJob operation to get the results of the transcription. + TranscriptionJobStatus TranscriptionJobStatus } // Provides information about a vocabulary filter. @@ -435,27 +435,27 @@ type VocabularyFilterInfo struct { // The language code of the words in the vocabulary filter. LanguageCode LanguageCode + // The date and time that the vocabulary was last updated. + LastModifiedTime *time.Time + // The name of the vocabulary filter. The name must be unique in the account that // holds the filter. VocabularyFilterName *string - - // The date and time that the vocabulary was last updated. - LastModifiedTime *time.Time } // Provides information about a custom vocabulary. type VocabularyInfo struct { - // The name of the vocabulary. - VocabularyName *string - // The language code of the vocabulary entries. LanguageCode LanguageCode + // The date and time that the vocabulary was last modified. + LastModifiedTime *time.Time + + // The name of the vocabulary. + VocabularyName *string + // The processing state of the vocabulary. If the state is READY you can use the // vocabulary in a StartTranscriptionJob request. VocabularyState VocabularyState - - // The date and time that the vocabulary was last modified. - LastModifiedTime *time.Time } diff --git a/service/transfer/api_op_CreateServer.go b/service/transfer/api_op_CreateServer.go index c3196d557c2..240f75500a6 100644 --- a/service/transfer/api_op_CreateServer.go +++ b/service/transfer/api_op_CreateServer.go @@ -60,13 +60,6 @@ func (c *Client) CreateServer(ctx context.Context, params *CreateServerInput, op type CreateServerInput struct { - // The virtual private cloud (VPC) endpoint settings that are configured for your - // file transfer protocol-enabled server. When you host your endpoint within your - // VPC, you can make it accessible only to resources within your VPC, or you can - // attach Elastic IPs and make it accessible to clients over the internet. Your - // VPC's default security groups are automatically assigned to your endpoint. - EndpointDetails *types.EndpointDetails - // The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. // Required when Protocols is set to FTPS.

    To request a new public certificate, // see Certificate *string - // Key-value pairs that can be used to group and search for file transfer - // protocol-enabled servers. - Tags []*types.Tag + // The virtual private cloud (VPC) endpoint settings that are configured for your + // file transfer protocol-enabled server. When you host your endpoint within your + // VPC, you can make it accessible only to resources within your VPC, or you can + // attach Elastic IPs and make it accessible to clients over the internet. Your + // VPC's default security groups are automatically assigned to your endpoint. + EndpointDetails *types.EndpointDetails - // Specifies the mode of authentication for a file transfer protocol-enabled - // server. The default value is SERVICE_MANAGED, which allows you to store and - // access user credentials within the AWS Transfer Family service. Use the - // API_GATEWAY value to integrate with an identity provider of your choosing. The - // API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call - // for authentication using the IdentityProviderDetails parameter. - IdentityProviderType types.IdentityProviderType + // The type of VPC endpoint that you want your file transfer protocol-enabled + // server to connect to. You can choose to connect to the public internet or a VPC + // endpoint. With a VPC endpoint, you can restrict access to your server and + // resources only within your VPC.

    It is recommended that you use + // VPC as the EndpointType. With this endpoint type, you + // have the option to directly associate up to three Elastic IPv4 addresses (BYO IP + // included) with your server's endpoint and use VPC security groups to restrict + // traffic by the client's public IP address. This is not possible with + // EndpointType set to VPC_ENDPOINT.

    + EndpointType types.EndpointType // The RSA private key as generated by the ssh-keygen -N "" -m PEM -f // my-new-server-key command.

    If you aren't planning to migrate @@ -111,6 +110,24 @@ type CreateServerInput struct { // Guide.

    HostKey *string + // Required when IdentityProviderType is set to API_GATEWAY. Accepts an array + // containing all of the information required to call a customer-supplied + // authentication API, including the API Gateway URL. Not required when + // IdentityProviderType is set to SERVICE_MANAGED. + IdentityProviderDetails *types.IdentityProviderDetails + + // Specifies the mode of authentication for a file transfer protocol-enabled + // server. The default value is SERVICE_MANAGED, which allows you to store and + // access user credentials within the AWS Transfer Family service. Use the + // API_GATEWAY value to integrate with an identity provider of your choosing. The + // API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call + // for authentication using the IdentityProviderDetails parameter. + IdentityProviderType types.IdentityProviderType + + // Allows the service to write your users' activity to your Amazon CloudWatch logs + // for monitoring and auditing purposes. + LoggingRole *string + // Specifies the file transfer protocol or protocols over which your file transfer // protocol client can connect to your server's endpoint. The available protocols // are:

    • SFTP (Secure Shell (SSH) File Transfer @@ -131,26 +148,9 @@ type CreateServerInput struct { // SERVICE_MANAGED.

      Protocols []types.Protocol - // The type of VPC endpoint that you want your file transfer protocol-enabled - // server to connect to. You can choose to connect to the public internet or a VPC - // endpoint. With a VPC endpoint, you can restrict access to your server and - // resources only within your VPC.

      It is recommended that you use - // VPC as the EndpointType. With this endpoint type, you - // have the option to directly associate up to three Elastic IPv4 addresses (BYO IP - // included) with your server's endpoint and use VPC security groups to restrict - // traffic by the client's public IP address. This is not possible with - // EndpointType set to VPC_ENDPOINT.

       - EndpointType types.EndpointType - - // Allows the service to write your users' activity to your Amazon CloudWatch logs - // for monitoring and auditing purposes. - LoggingRole *string - - // Required when IdentityProviderType is set to API_GATEWAY. Accepts an array - // containing all of the information required to call a customer-supplied - // authentication API, including the API Gateway URL. Not required when - // IdentityProviderType is set to SERVICE_MANAGED. - IdentityProviderDetails *types.IdentityProviderDetails + // Key-value pairs that can be used to group and search for file transfer + // protocol-enabled servers. + Tags []*types.Tag } type CreateServerOutput struct { diff --git a/service/transfer/api_op_CreateUser.go b/service/transfer/api_op_CreateUser.go index 7e6eda4a73b..db042af73a2 100644 --- a/service/transfer/api_op_CreateUser.go +++ b/service/transfer/api_op_CreateUser.go @@ -63,6 +63,16 @@ func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns type CreateUserInput struct { + // The IAM role that controls your users' access to your Amazon S3 bucket. The + // policies attached to this role will determine the level of access you want to + // provide your users when transferring files into and out of your Amazon S3 bucket + // or buckets. The IAM role should also contain a trust relationship that allows + // the file transfer protocol-enabled server to access your resources when + // servicing your users' transfer requests. + // + // This member is required. + Role *string + // A system-assigned unique identifier for a file transfer protocol-enabled server // instance. This is the specific server that you added your user to. // @@ -78,37 +88,10 @@ type CreateUserInput struct { // This member is required. UserName *string - // Key-value pairs that can be used to group and search for users. Tags are - // metadata attached to users for any purpose. - Tags []*types.Tag - - // The IAM role that controls your users' access to your Amazon S3 bucket. The - // policies attached to this role will determine the level of access you want to - // provide your users when transferring files into and out of your Amazon S3 bucket - // or buckets. The IAM role should also contain a trust relationship that allows - // the file transfer protocol-enabled server to access your resources when - // servicing your users' transfer requests. - // - // This member is required. - Role *string - - // A scope-down policy for your user so you can use the same IAM role across - // multiple users. This policy scopes down user access to portions of their Amazon - // S3 bucket. Variables that you can use inside this policy include - // ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. - //

      For scope-down policies, AWS Transfer Family stores the policy as a - // JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the - // policy as a JSON blob and pass it in the Policy argument.

      - //

      For an example of a scope-down policy, see Creating - // a scope-down policy.

      For more information, see AssumeRole - // in the AWS Security Token Service API Reference.

      - Policy *string - - // The public portion of the Secure Shell (SSH) key used to authenticate the user - // to the file transfer protocol-enabled server. - SshPublicKeyBody *string + // The landing directory (folder) for a user when they log in to the file transfer + // protocol-enabled server using the client.

      An example is + // your-Amazon-S3-bucket-name>/home/username .

      + HomeDirectory *string // Logical directory mappings that specify what Amazon S3 paths and keys should be // visible to your user and how you want to make them visible. You will need to @@ -131,11 +114,6 @@ type CreateUserInput struct { // folder.

      HomeDirectoryMappings []*types.HomeDirectoryMapEntry - // The landing directory (folder) for a user when they log in to the file transfer - // protocol-enabled server using the client.

      An example is - // your-Amazon-S3-bucket-name>/home/username .

      - HomeDirectory *string - // The type of landing directory (folder) you want your users' home directory to be // when they log into the file transfer protocol-enabled server. If you set it to // PATH, the user will see the absolute Amazon S3 bucket paths as is in their file @@ -143,22 +121,44 @@ type CreateUserInput struct { // mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths // visible to your users. HomeDirectoryType types.HomeDirectoryType + + // A scope-down policy for your user so you can use the same IAM role across + // multiple users. This policy scopes down user access to portions of their Amazon + // S3 bucket. Variables that you can use inside this policy include + // ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. + //

      For scope-down policies, AWS Transfer Family stores the policy as a + // JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the + // policy as a JSON blob and pass it in the Policy argument.

      + //

      For an example of a scope-down policy, see Creating + // a scope-down policy.

      For more information, see AssumeRole + // in the AWS Security Token Service API Reference.

       + Policy *string + + // The public portion of the Secure Shell (SSH) key used to authenticate the user + // to the file transfer protocol-enabled server. + SshPublicKeyBody *string + + // Key-value pairs that can be used to group and search for users. Tags are + // metadata attached to users for any purpose. + Tags []*types.Tag } type CreateUserOutput struct { - // A unique string that identifies a user account associated with a file transfer - // protocol-enabled server. - // - // This member is required. - UserName *string - // The ID of the file transfer protocol-enabled server that the user is attached // to. // // This member is required. ServerId *string + // A unique string that identifies a user account associated with a file transfer + // protocol-enabled server. + // + // This member is required. + UserName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/transfer/api_op_DeleteSshPublicKey.go b/service/transfer/api_op_DeleteSshPublicKey.go index 9bea2c403de..7c798ce5470 100644 --- a/service/transfer/api_op_DeleteSshPublicKey.go +++ b/service/transfer/api_op_DeleteSshPublicKey.go @@ -57,17 +57,17 @@ func (c *Client) DeleteSshPublicKey(ctx context.Context, params *DeleteSshPublic type DeleteSshPublicKeyInput struct { - // A unique identifier used to reference your user's specific SSH key. - // - // This member is required. - SshPublicKeyId *string - // A system-assigned unique identifier for a file transfer protocol-enabled server // instance that has the user assigned to it. // // This member is required. ServerId *string + // A unique identifier used to reference your user's specific SSH key. + // + // This member is required. + SshPublicKeyId *string + // A unique string that identifies a user whose public key is being deleted. // // This member is required. diff --git a/service/transfer/api_op_DescribeUser.go b/service/transfer/api_op_DescribeUser.go index 674f36c35ec..71f5daf8ac0 100644 --- a/service/transfer/api_op_DescribeUser.go +++ b/service/transfer/api_op_DescribeUser.go @@ -76,18 +76,18 @@ type DescribeUserInput struct { type DescribeUserOutput struct { - // An array containing the properties of the user account for the ServerID value - // that you specified. - // - // This member is required. - User *types.DescribedUser - // A system-assigned unique identifier for a file transfer protocol-enabled server // that has this user assigned. // // This member is required. ServerId *string + // An array containing the properties of the user account for the ServerID value + // that you specified. + // + // This member is required. + User *types.DescribedUser + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/transfer/api_op_ImportSshPublicKey.go b/service/transfer/api_op_ImportSshPublicKey.go index 46ad23f24b9..2791b5382b2 100644 --- a/service/transfer/api_op_ImportSshPublicKey.go +++ b/service/transfer/api_op_ImportSshPublicKey.go @@ -60,15 +60,15 @@ func (c *Client) ImportSshPublicKey(ctx context.Context, params *ImportSshPublic type ImportSshPublicKeyInput struct { - // The public key portion of an SSH key pair. + // A system-assigned unique identifier for a file transfer protocol-enabled server. // // This member is required. - SshPublicKeyBody *string + ServerId *string - // A system-assigned unique identifier for a file transfer protocol-enabled server. + // The public key portion of an SSH key pair. // // This member is required. - ServerId *string + SshPublicKeyBody *string // The name of the user account that is assigned to one or more file transfer // protocol-enabled servers. @@ -82,15 +82,15 @@ type ImportSshPublicKeyInput struct { // have more than one key on each server that they are associated with. type ImportSshPublicKeyOutput struct { - // The name given to a public key by the system that was imported. + // A system-assigned unique identifier for a file transfer protocol-enabled server. // // This member is required. - SshPublicKeyId *string + ServerId *string - // A system-assigned unique identifier for a file transfer protocol-enabled server. + // The name given to a public key by the system that was imported. // // This member is required. - ServerId *string + SshPublicKeyId *string // A user name assigned to the ServerID value that you specified. // diff --git a/service/transfer/api_op_ListServers.go b/service/transfer/api_op_ListServers.go index 4ece8c172e6..5feff94ffed 100644 --- a/service/transfer/api_op_ListServers.go +++ b/service/transfer/api_op_ListServers.go @@ -57,15 +57,15 @@ func (c *Client) ListServers(ctx context.Context, params *ListServersInput, optF type ListServersInput struct { + // Specifies the number of file transfer protocol-enabled servers to return as a + // response to the ListServers query. + MaxResults *int32 + // When additional results are obtained from theListServers command, a NextToken // parameter is returned in the output. You can then pass the NextToken parameter // in a subsequent command to continue listing additional file transfer // protocol-enabled servers. NextToken *string - - // Specifies the number of file transfer protocol-enabled servers to return as a - // response to the ListServers query. - MaxResults *int32 } type ListServersOutput struct { diff --git a/service/transfer/api_op_ListTagsForResource.go b/service/transfer/api_op_ListTagsForResource.go index 5d8d3409cc0..a8b3dff311c 100644 --- a/service/transfer/api_op_ListTagsForResource.go +++ b/service/transfer/api_op_ListTagsForResource.go @@ -58,10 +58,6 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // Specifies the number of tags to return as a response to the ListTagsForResource - // request. - MaxResults *int32 - // Requests the tags associated with a particular Amazon Resource Name (ARN). An // ARN is an identifier for a specific AWS resource, such as a server, user, or // role. @@ -69,6 +65,10 @@ type ListTagsForResourceInput struct { // This member is required. Arn *string + // Specifies the number of tags to return as a response to the ListTagsForResource + // request. + MaxResults *int32 + // When you request additional results from the ListTagsForResource operation, a // NextToken parameter is returned in the input. You can then pass in a subsequent // command to the NextToken parameter to continue listing additional tags. @@ -77,6 +77,9 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { + // The ARN you specified to list the tags of. + Arn *string + // When you can get additional results from the ListTagsForResource call, a // NextToken parameter is returned in the output. You can then pass in a subsequent // command to the NextToken parameter to continue listing additional tags. @@ -86,9 +89,6 @@ type ListTagsForResourceOutput struct { // grouping and searching for items. Tags are metadata that you define. Tags []*types.Tag - // The ARN you specified to list the tags of. - Arn *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/transfer/api_op_ListUsers.go b/service/transfer/api_op_ListUsers.go index 906b7229898..a42d7ec1265 100644 --- a/service/transfer/api_op_ListUsers.go +++ b/service/transfer/api_op_ListUsers.go @@ -58,6 +58,12 @@ func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns . type ListUsersInput struct { + // A system-assigned unique identifier for a file transfer protocol-enabled server + // that has users assigned to it. + // + // This member is required. + ServerId *string + // Specifies the number of users to return as a response to the ListUsers request. MaxResults *int32 @@ -65,15 +71,15 @@ type ListUsersInput struct { // parameter is returned in the output. You can then pass in a subsequent command // to the NextToken parameter to continue listing additional users. NextToken *string +} + +type ListUsersOutput struct { // A system-assigned unique identifier for a file transfer protocol-enabled server - // that has users assigned to it. + // that the users are assigned to. // // This member is required. ServerId *string -} - -type ListUsersOutput struct { // Returns the user accounts and their properties for the ServerId value that you // specify. @@ -81,12 +87,6 @@ type ListUsersOutput struct { // This member is required. Users []*types.ListedUser - // A system-assigned unique identifier for a file transfer protocol-enabled server - // that the users are assigned to. - // - // This member is required. - ServerId *string - // When you can get additional results from the ListUsers call, a NextToken // parameter is returned in the output. You can then pass in a subsequent command // to the NextToken parameter to continue listing additional users. diff --git a/service/transfer/api_op_TagResource.go b/service/transfer/api_op_TagResource.go index 02775e7c7c9..00aa7d59b24 100644 --- a/service/transfer/api_op_TagResource.go +++ b/service/transfer/api_op_TagResource.go @@ -59,18 +59,18 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { + // An Amazon Resource Name (ARN) for a specific AWS resource, such as a server, + // user, or role. + // + // This member is required. + Arn *string + // Key-value pairs assigned to ARNs that you can use to group and search for // resources by type. You can attach this metadata to user accounts for any // purpose. // // This member is required. Tags []*types.Tag - - // An Amazon Resource Name (ARN) for a specific AWS resource, such as a server, - // user, or role. - // - // This member is required. - Arn *string } type TagResourceOutput struct { diff --git a/service/transfer/api_op_TestIdentityProvider.go b/service/transfer/api_op_TestIdentityProvider.go index 9523abb147e..e6ec78772f3 100644 --- a/service/transfer/api_op_TestIdentityProvider.go +++ b/service/transfer/api_op_TestIdentityProvider.go @@ -62,18 +62,6 @@ func (c *Client) TestIdentityProvider(ctx context.Context, params *TestIdentityP type TestIdentityProviderInput struct { - // The password of the user account to be tested. - UserPassword *string - - // The source IP address of the user account to be tested. - SourceIp *string - - // The type of file transfer protocol to be tested.

      The available protocols - // are:

      • Secure Shell (SSH) File Transfer Protocol (SFTP)

        • - //

      • File Transfer Protocol Secure (FTPS)

      • File Transfer - // Protocol (FTP)

      - ServerProtocol types.Protocol - // A system-assigned identifier for a specific file transfer protocol-enabled // server. That server's user authentication method is tested with a user name and // password. @@ -85,15 +73,21 @@ type TestIdentityProviderInput struct { // // This member is required. UserName *string -} -type TestIdentityProviderOutput struct { + // The type of file transfer protocol to be tested.

      The available protocols + // are:

      • Secure Shell (SSH) File Transfer Protocol (SFTP)

        • + //

      • File Transfer Protocol Secure (FTPS)

      • File Transfer + // Protocol (FTP)

      + ServerProtocol types.Protocol - // The response that is returned from your API Gateway. - Response *string + // The source IP address of the user account to be tested. + SourceIp *string - // A message that indicates whether the test was successful or not. - Message *string + // The password of the user account to be tested. + UserPassword *string +} + +type TestIdentityProviderOutput struct { // The HTTP status code that is the response from your API Gateway. // @@ -105,6 +99,12 @@ type TestIdentityProviderOutput struct { // This member is required. Url *string + // A message that indicates whether the test was successful or not. + Message *string + + // The response that is returned from your API Gateway. + Response *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/transfer/api_op_UpdateServer.go b/service/transfer/api_op_UpdateServer.go index ad3d532a851..438b0daa7f7 100644 --- a/service/transfer/api_op_UpdateServer.go +++ b/service/transfer/api_op_UpdateServer.go @@ -59,6 +59,34 @@ func (c *Client) UpdateServer(ctx context.Context, params *UpdateServerInput, op type UpdateServerInput struct { + // A system-assigned unique identifier for a file transfer protocol-enabled server + // instance that the user account is assigned to. + // + // This member is required. + ServerId *string + + // The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. + // Required when Protocols is set to FTPS.

      To request a new public certificate, + // see Request + // a public certificate in the AWS Certificate Manager User Guide.

      + //

      To import an existing certificate into ACM, see Importing + // certificates into ACM in the AWS Certificate Manager User Guide.

      + //

      To request a private certificate to use FTPS through private IP addresses, + // see Request + // a private certificate in the AWS Certificate Manager User Guide.

      + //

      Certificates with the following cryptographic algorithms and key sizes are + // supported:

      • 2048-bit RSA (RSA_2048)

      • 4096-bit + // RSA (RSA_4096)

      • Elliptic Prime Curve 256 bit + // (EC_prime256v1)

      • Elliptic Prime Curve 384 bit + // (EC_secp384r1)

      • Elliptic Prime Curve 521 bit (EC_secp521r1)

        + //

      The certificate must be a valid SSL/TLS X.509 version 3 + // certificate with FQDN or IP address specified and information about the + // issuer.

       + Certificate *string + // The virtual private cloud (VPC) endpoint settings that are configured for your // file transfer protocol-enabled server. With a VPC endpoint, you can restrict // access to your server to resources only within your VPC. To control incoming @@ -77,20 +105,6 @@ type UpdateServerInput struct { // set to VPC_ENDPOINT.

      EndpointType types.EndpointType - // An array containing all of the information required to call a customer's - // authentication API method. - IdentityProviderDetails *types.IdentityProviderDetails - - // A system-assigned unique identifier for a file transfer protocol-enabled server - // instance that the user account is assigned to. - // - // This member is required. - ServerId *string - - // Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 - // events to be logged in Amazon CloudWatch, turning logging on or off. - LoggingRole *string - // The RSA private key as generated by ssh-keygen -N "" -m PEM -f // my-new-server-key.

      If you aren't planning to migrate existing // users from an existing file transfer protocol-enabled server to a new server, @@ -101,6 +115,14 @@ type UpdateServerInput struct { // Guide.

      HostKey *string + // An array containing all of the information required to call a customer's + // authentication API method. + IdentityProviderDetails *types.IdentityProviderDetails + + // Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 + // events to be logged in Amazon CloudWatch, turning logging on or off. + LoggingRole *string + // Specifies the file transfer protocol or protocols over which your file transfer // protocol client can connect to your server's endpoint. The available protocols // are:

      • Secure Shell (SSH) File Transfer Protocol (SFTP): File @@ -119,28 +141,6 @@ type UpdateServerInput struct { // IdentityProviderType can be set to // SERVICE_MANAGED.

        Protocols []types.Protocol - - // The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. - // Required when Protocols is set to FTPS.

        To request a new public certificate, - // see Request - // a public certificate in the AWS Certificate Manager User Guide.

        - //

        To import an existing certificate into ACM, see Importing - // certificates into ACM in the AWS Certificate Manager User Guide.

        - //

        To request a private certificate to use FTPS through private IP addresses, - // see Request - // a private certificate in the AWS Certificate Manager User Guide.

        - //

        Certificates with the following cryptographic algorithms and key sizes are - // supported:

        • 2048-bit RSA (RSA_2048)

        • 4096-bit - // RSA (RSA_4096)

        • Elliptic Prime Curve 256 bit - // (EC_prime256v1)

        • Elliptic Prime Curve 384 bit - // (EC_secp384r1)

        • Elliptic Prime Curve 521 bit (EC_secp521r1)

          - //

        The certificate must be a valid SSL/TLS X.509 version 3 - // certificate with FQDN or IP address specified and information about the - // issuer.

         - Certificate *string } type UpdateServerOutput struct { diff --git a/service/transfer/api_op_UpdateUser.go b/service/transfer/api_op_UpdateUser.go index 4fa7a7d50b9..089b94757ed 100644 --- a/service/transfer/api_op_UpdateUser.go +++ b/service/transfer/api_op_UpdateUser.go @@ -60,28 +60,6 @@ func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns type UpdateUserInput struct { - // Allows you to supply a scope-down policy for your user so you can use the same - // IAM role across multiple users. The policy scopes down user access to portions - // of your Amazon S3 bucket. Variables you can use inside this policy include - // ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. For - // scope-down policies, AWS Transfer Family stores the policy as a JSON blob, - // instead of the Amazon Resource Name (ARN) of the policy. You save the policy as - // a JSON blob and pass it in the Policy argument.

        For an example of a - // scope-down policy, see Creating - // a scope-down policy.

        For more information, see AssumeRole - // in the AWS Security Token Service API Reference.

        - Policy *string - - // The IAM role that controls your users' access to your Amazon S3 bucket. The - // policies attached to this role will determine the level of access you want to - // provide your users when transferring files into and out of your Amazon S3 bucket - // or buckets. The IAM role should also contain a trust relationship that allows - // the file transfer protocol-enabled server to access your resources when - // servicing your users' transfer requests. - Role *string - // A system-assigned unique identifier for a file transfer protocol-enabled server // instance that the user account is assigned to. // @@ -98,6 +76,11 @@ type UpdateUserInput struct { // This member is required. UserName *string + // Specifies the landing directory (folder) for a user when they log in to the file + // transfer protocol-enabled server using their file transfer protocol client. + //

        An example is your-Amazon-S3-bucket-name>/home/username.

        + HomeDirectory *string + // Logical directory mappings that specify what Amazon S3 paths and keys should be // visible to your user and how you want to make them visible. You will need to // specify the "Entry" and "Target" pair, where Entry shows how the path is made @@ -119,11 +102,6 @@ type UpdateUserInput struct { // folder.

        HomeDirectoryMappings []*types.HomeDirectoryMapEntry - // Specifies the landing directory (folder) for a user when they log in to the file - // transfer protocol-enabled server using their file transfer protocol client. - //

        An example is your-Amazon-S3-bucket-name>/home/username.

        - HomeDirectory *string - // The type of landing directory (folder) you want your users' home directory to be // when they log into the file transfer protocol-enabled server. If you set it to // PATH, the user will see the absolute Amazon S3 bucket paths as is in their file @@ -131,24 +109,46 @@ type UpdateUserInput struct { // mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths // visible to your users. HomeDirectoryType types.HomeDirectoryType + + // Allows you to supply a scope-down policy for your user so you can use the same + // IAM role across multiple users. The policy scopes down user access to portions + // of your Amazon S3 bucket. Variables you can use inside this policy include + // ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. For + // scope-down policies, AWS Transfer Family stores the policy as a JSON blob, + // instead of the Amazon Resource Name (ARN) of the policy. You save the policy as + // a JSON blob and pass it in the Policy argument.

        For an example of a + // scope-down policy, see Creating + // a scope-down policy.

        For more information, see AssumeRole + // in the AWS Security Token Service API Reference.

        + Policy *string + + // The IAM role that controls your users' access to your Amazon S3 bucket. The + // policies attached to this role will determine the level of access you want to + // provide your users when transferring files into and out of your Amazon S3 bucket + // or buckets. The IAM role should also contain a trust relationship that allows + // the file transfer protocol-enabled server to access your resources when + // servicing your users' transfer requests. + Role *string } // UpdateUserResponse returns the user name and file transfer protocol-enabled // server identifier for the request to update a user's properties. type UpdateUserOutput struct { - // The unique identifier for a user that is assigned to a file transfer - // protocol-enabled server instance that was specified in the request. - // - // This member is required. - UserName *string - // A system-assigned unique identifier for a file transfer protocol-enabled server // instance that the user account is assigned to. // // This member is required. ServerId *string + // The unique identifier for a user that is assigned to a file transfer + // protocol-enabled server instance that was specified in the request. + // + // This member is required. + UserName *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/transfer/go.mod b/service/transfer/go.mod index f1ea1776fa0..2d518e7b347 100644 --- a/service/transfer/go.mod +++ b/service/transfer/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/transfer go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/transfer/types/types.go b/service/transfer/types/types.go index 4004ed5b02e..5908108545c 100644 --- a/service/transfer/types/types.go +++ b/service/transfer/types/types.go @@ -14,43 +14,12 @@ import ( // and assigned tags or metadata. type DescribedServer struct { - // Defines the type of endpoint that your file transfer protocol-enabled server is - // connected to. If your server is connected to a VPC endpoint, your server isn't - // accessible over the public internet. - EndpointType EndpointType - // Specifies the unique Amazon Resource Name (ARN) for a file transfer // protocol-enabled server to be described. // // This member is required. Arn *string - // Specifies information to call a customer-supplied authentication API. This field - // is not populated when the IdentityProviderType of a file transfer - // protocol-enabled server is SERVICE_MANAGED. - IdentityProviderDetails *IdentityProviderDetails - - // Specifies the AWS Identity and Access Management (IAM) role that allows a file - // transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon - // S3 events. When set, user activity can be viewed in your CloudWatch logs. - LoggingRole *string - - // Specifies the key-value pairs that you can use to search for and group file - // transfer protocol-enabled servers that were assigned to the server that was - // described. - Tags []*Tag - - // Specifies the number of users that are assigned to a file transfer - // protocol-enabled server you specified with the ServerId. - UserCount *int32 - - // Specifies the mode of authentication method enabled for this service. A value of - // SERVICE_MANAGED means that you are using this file transfer protocol-enabled - // server to store and access user credentials within the service. A value of - // API_GATEWAY indicates that you have integrated an API Gateway endpoint that will - // be invoked for authenticating your user into the service. - IdentityProviderType IdentityProviderType - // Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required // when Protocols is set to FTPS. Certificate *string @@ -59,21 +28,33 @@ type DescribedServer struct { // for your file transfer protocol-enabled server. EndpointDetails *EndpointDetails - // Specifies the condition of a file transfer protocol-enabled server for the - // server that was described. A value of ONLINE indicates that the server can - // accept jobs and transfer files. A State value of OFFLINE means that the server - // cannot perform file transfer operations.

        The states of STARTING - // and STOPPING indicate that the server is in an intermediate state, - // either not fully able to respond, or not fully offline. The values of - // START_FAILED or STOP_FAILED can indicate an error - // condition.

        - State State + // Defines the type of endpoint that your file transfer protocol-enabled server is + // connected to. If your server is connected to a VPC endpoint, your server isn't + // accessible over the public internet. + EndpointType EndpointType // Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This // value is equivalent to the output of the ssh-keygen -l -f my-new-server-key // command. HostKeyFingerprint *string + // Specifies information to call a customer-supplied authentication API. This field + // is not populated when the IdentityProviderType of a file transfer + // protocol-enabled server is SERVICE_MANAGED. + IdentityProviderDetails *IdentityProviderDetails + + // Specifies the mode of authentication method enabled for this service. A value of + // SERVICE_MANAGED means that you are using this file transfer protocol-enabled + // server to store and access user credentials within the service. A value of + // API_GATEWAY indicates that you have integrated an API Gateway endpoint that will + // be invoked for authenticating your user into the service. + IdentityProviderType IdentityProviderType + + // Specifies the AWS Identity and Access Management (IAM) role that allows a file + // transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon + // S3 events. When set, user activity can be viewed in your CloudWatch logs. + LoggingRole *string + // Specifies the file transfer protocol or protocols over which your file transfer // protocol client can connect to your server's endpoint. The available protocols // are:

        • SFTP (Secure Shell (SSH) File Transfer @@ -86,11 +67,41 @@ type DescribedServer struct { // Specifies the unique system-assigned identifier for a file transfer // protocol-enabled server that you instantiate. ServerId *string + + // Specifies the condition of a file transfer protocol-enabled server for the + // server that was described. A value of ONLINE indicates that the server can + // accept jobs and transfer files. A State value of OFFLINE means that the server + // cannot perform file transfer operations.

          The states of STARTING + // and STOPPING indicate that the server is in an intermediate state, + // either not fully able to respond, or not fully offline. The values of + // START_FAILED or STOP_FAILED can indicate an error + // condition.

          + State State + + // Specifies the key-value pairs that you can use to search for and group file + // transfer protocol-enabled servers that were assigned to the server that was + // described. + Tags []*Tag + + // Specifies the number of users that are assigned to a file transfer + // protocol-enabled server you specified with the ServerId. + UserCount *int32 } // Returns properties of the user that you want to describe. type DescribedUser struct { + // Specifies the unique Amazon Resource Name (ARN) for the user that was requested + // to be described. + // + // This member is required. + Arn *string + + // Specifies the landing directory (or folder), which is the location that files + // are written to or read from in an Amazon S3 bucket, for the described user. An + // example is your-Amazon-S3-bucket-name>/home/username . + HomeDirectory *string + // Specifies the logical directory mappings that specify what Amazon S3 paths and // keys should be visible to your user and how you want to make them visible. You // will need to specify the "Entry" and "Target" pair, where Entry shows how the @@ -114,37 +125,26 @@ type DescribedUser struct { // Specifies the name of the policy in use for the described user. Policy *string + // Specifies the IAM role that controls your users' access to your Amazon S3 + // bucket. The policies attached to this role will determine the level of access + // you want to provide your users when transferring files into and out of your + // Amazon S3 bucket or buckets. The IAM role should also contain a trust + // relationship that allows a file transfer protocol-enabled server to access your + // resources when servicing your users' transfer requests. + Role *string + // Specifies the public key portion of the Secure Shell (SSH) keys stored for the // described user. SshPublicKeys []*SshPublicKey - // Specifies the landing directory (or folder), which is the location that files - // are written to or read from in an Amazon S3 bucket, for the described user. An - // example is your-Amazon-S3-bucket-name>/home/username . - HomeDirectory *string + // Specifies the key-value pairs for the user requested. Tag can be used to search + // for and group users for a variety of purposes. + Tags []*Tag // Specifies the name of the user that was requested to be described. User names // are used for authentication purposes. This is the string that will be used by // your user when they log in to your file transfer protocol-enabled server. UserName *string - - // Specifies the key-value pairs for the user requested. Tag can be used to search - // for and group users for a variety of purposes. - Tags []*Tag - - // Specifies the IAM role that controls your users' access to your Amazon S3 - // bucket. The policies attached to this role will determine the level of access - // you want to provide your users when transferring files into and out of your - // Amazon S3 bucket or buckets. The IAM role should also contain a trust - // relationship that allows a file transfer protocol-enabled server to access your - // resources when servicing your users' transfer requests. - Role *string - - // Specifies the unique Amazon Resource Name (ARN) for the user that was requested - // to be described. - // - // This member is required. - Arn *string } // The virtual private cloud (VPC) endpoint settings that are configured for your @@ -154,6 +154,12 @@ type DescribedUser struct { // server's endpoint. type EndpointDetails struct { + // A list of address allocation IDs that are required to attach an Elastic IP + // address to your file transfer protocol-enabled server's endpoint. This is only + // valid in the UpdateServer API.

          This property can only be use when + // EndpointType is set to VPC.

           + AddressAllocationIds []*string + // A list of subnet IDs that are required to host your file transfer // protocol-enabled server endpoint in your VPC.

          This property can only // be used when EndpointType is set to VPC.

           @@ -163,12 +169,6 @@ type EndpointDetails struct { // EndpointType is set to VPC_ENDPOINT.

          VpcEndpointId *string - // A list of address allocation IDs that are required to attach an Elastic IP - // address to your file transfer protocol-enabled server's endpoint. This is only - // valid in the UpdateServer API.

          This property can only be use when - // EndpointType is set to VPC.

           - AddressAllocationIds []*string - // The VPC ID of the VPC in which a file transfer protocol-enabled server's // endpoint will be hosted.

          This property can only be used when // EndpointType is set to VPC.

           @@ -179,15 +179,15 @@ type EndpointDetails struct { // HomeDirectoryMappings. type HomeDirectoryMapEntry struct { - // Represents the map target that is used in a HomeDirectorymapEntry. + // Represents an entry and a target for HomeDirectoryMappings. // // This member is required. - Target *string + Entry *string - // Represents an entry and a target for HomeDirectoryMappings. + // Represents the map target that is used in a HomeDirectorymapEntry. // // This member is required. - Entry *string + Target *string } // Returns information related to the type of user authentication that is in use @@ -195,36 +195,34 @@ type HomeDirectoryMapEntry struct { // method of authentication. type IdentityProviderDetails struct { - // Provides the location of the service endpoint used to authenticate users. - Url *string - // Provides the type of InvocationRole used to authenticate the user account. InvocationRole *string + + // Provides the location of the service endpoint used to authenticate users. + Url *string } // Returns properties of a file transfer protocol-enabled server that was // specified. type ListedServer struct { - // Specifies the number of users that are assigned to a file transfer - // protocol-enabled server you specified with the ServerId. - UserCount *int32 - - // Specifies the condition of a file transfer protocol-enabled server for the - // server that was described. A value of ONLINE indicates that the server can - // accept jobs and transfer files. A State value of OFFLINE means that the server - // cannot perform file transfer operations.

          The states of STARTING - // and STOPPING indicate that the server is in an intermediate state, - // either not fully able to respond, or not fully offline. The values of - // START_FAILED or STOP_FAILED can indicate an error - // condition.

          - State State + // Specifies the unique Amazon Resource Name (ARN) for a file transfer + // protocol-enabled server to be listed. + // + // This member is required. + Arn *string // Specifies the type of VPC endpoint that your file transfer protocol-enabled // server is connected to. If your server is connected to a VPC endpoint, your // server isn't accessible over the public internet. EndpointType EndpointType + // Specifies the authentication method used to validate a user for a file transfer + // protocol-enabled server that was specified. This can include Secure Shell (SSH), + // user name and password combinations, or your own custom authentication method. + // Valid values include SERVICE_MANAGED or API_GATEWAY. + IdentityProviderType IdentityProviderType + // Specifies the AWS Identity and Access Management (IAM) role that allows a file // transfer protocol-enabled server to turn on Amazon CloudWatch logging. LoggingRole *string @@ -233,22 +231,34 @@ type ListedServer struct { // protocol-enabled servers that were listed. ServerId *string - // Specifies the authentication method used to validate a user for a file transfer - // protocol-enabled server that was specified. This can include Secure Shell (SSH), - // user name and password combinations, or your own custom authentication method. - // Valid values include SERVICE_MANAGED or API_GATEWAY. - IdentityProviderType IdentityProviderType + // Specifies the condition of a file transfer protocol-enabled server for the + // server that was described. A value of ONLINE indicates that the server can + // accept jobs and transfer files. A State value of OFFLINE means that the server + // cannot perform file transfer operations.

          The states of STARTING + // and STOPPING indicate that the server is in an intermediate state, + // either not fully able to respond, or not fully offline. The values of + // START_FAILED or STOP_FAILED can indicate an error + // condition.

          + State State - // Specifies the unique Amazon Resource Name (ARN) for a file transfer - // protocol-enabled server to be listed. - // - // This member is required. - Arn *string + // Specifies the number of users that are assigned to a file transfer + // protocol-enabled server you specified with the ServerId. + UserCount *int32 } // Returns properties of the user that you specify. type ListedUser struct { + // Provides the unique Amazon Resource Name (ARN) for the user that you want to + // learn about. + // + // This member is required. + Arn *string + + // Specifies the location that files are written to or read from an Amazon S3 + // bucket for the user you specify by their ARN. + HomeDirectory *string + // Specifies the type of landing directory (folder) you mapped for your users' home // directory. If you set it to PATH, the user will see the absolute Amazon S3 // bucket paths as is in their file transfer protocol clients. If you set it @@ -256,10 +266,6 @@ type ListedUser struct { // you want to make Amazon S3 paths visible to your users. HomeDirectoryType HomeDirectoryType - // Specifies the name of the user whose ARN was specified. User names are used for - // authentication purposes. - UserName *string - // Specifies the role that is in use by this user. A role is an AWS Identity and // Access Management (IAM) entity that, in this case, allows a file transfer // protocol-enabled server to act on a user's behalf. It allows the server to @@ -270,15 +276,9 @@ type ListedUser struct { // Specifies the number of SSH public keys stored for the user you specified. SshPublicKeyCount *int32 - // Provides the unique Amazon Resource Name (ARN) for the user that you want to - // learn about. - // - // This member is required. - Arn *string - - // Specifies the location that files are written to or read from an Amazon S3 - // bucket for the user you specify by their ARN. - HomeDirectory *string + // Specifies the name of the user whose ARN was specified. User names are used for + // authentication purposes. + UserName *string } // Provides information about the public Secure Shell (SSH) key that is associated @@ -288,12 +288,6 @@ type ListedUser struct { // than one SSH public key associated with their user name on a specific server. type SshPublicKey struct { - // Specifies the SshPublicKeyId parameter contains the identifier of the public - // key. - // - // This member is required. - SshPublicKeyId *string - // Specifies the date that the public key was added to the user account. // // This member is required. @@ -303,6 +297,12 @@ type SshPublicKey struct { // // This member is required. SshPublicKeyBody *string + + // Specifies the SshPublicKeyId parameter contains the identifier of the public + // key. + // + // This member is required. + SshPublicKeyId *string } // Creates a key-value pair for a specific resource. Tags are metadata that you can diff --git a/service/translate/api_op_GetTerminology.go b/service/translate/api_op_GetTerminology.go index 61bdf4e5f17..eb53995690f 100644 --- a/service/translate/api_op_GetTerminology.go +++ b/service/translate/api_op_GetTerminology.go @@ -57,26 +57,26 @@ func (c *Client) GetTerminology(ctx context.Context, params *GetTerminologyInput type GetTerminologyInput struct { - // The data format of the custom terminology being retrieved, either CSV or TMX. + // The name of the custom terminology being retrieved. // // This member is required. - TerminologyDataFormat types.TerminologyDataFormat + Name *string - // The name of the custom terminology being retrieved. + // The data format of the custom terminology being retrieved, either CSV or TMX. // // This member is required. - Name *string + TerminologyDataFormat types.TerminologyDataFormat } type GetTerminologyOutput struct { - // The properties of the custom terminology being retrieved. - TerminologyProperties *types.TerminologyProperties - // The data location of the custom terminology being retrieved. The custom // terminology file is returned in a presigned url that has a 30 minute expiration. TerminologyDataLocation *types.TerminologyDataLocation + // The properties of the custom terminology being retrieved. + TerminologyProperties *types.TerminologyProperties + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/translate/api_op_ImportTerminology.go b/service/translate/api_op_ImportTerminology.go index 4959ef63ffb..129e9b70a91 100644 --- a/service/translate/api_op_ImportTerminology.go +++ b/service/translate/api_op_ImportTerminology.go @@ -65,28 +65,28 @@ func (c *Client) ImportTerminology(ctx context.Context, params *ImportTerminolog type ImportTerminologyInput struct { - // The terminology data for the custom terminology being imported. + // The merge strategy of the custom terminology being imported. Currently, only the + // OVERWRITE merge strategy is supported. In this case, the imported terminology + // will overwrite an existing terminology of the same name. // // This member is required. - TerminologyData *types.TerminologyData - - // The description of the custom terminology being imported. - Description *string + MergeStrategy types.MergeStrategy // The name of the custom terminology being imported. // // This member is required. Name *string - // The encryption key for the custom terminology being imported. - EncryptionKey *types.EncryptionKey - - // The merge strategy of the custom terminology being imported. Currently, only the - // OVERWRITE merge strategy is supported. In this case, the imported terminology - // will overwrite an existing terminology of the same name. + // The terminology data for the custom terminology being imported. // // This member is required. - MergeStrategy types.MergeStrategy + TerminologyData *types.TerminologyData + + // The description of the custom terminology being imported. + Description *string + + // The encryption key for the custom terminology being imported. + EncryptionKey *types.EncryptionKey } type ImportTerminologyOutput struct { diff --git a/service/translate/api_op_ListTerminologies.go b/service/translate/api_op_ListTerminologies.go index 61198370d6b..4ba0ce9f818 100644 --- a/service/translate/api_op_ListTerminologies.go +++ b/service/translate/api_op_ListTerminologies.go @@ -66,13 +66,13 @@ type ListTerminologiesInput struct { type ListTerminologiesOutput struct { - // The properties list of the custom terminologies returned on the list request. - TerminologyPropertiesList []*types.TerminologyProperties - // If the response to the ListTerminologies was truncated, the NextToken fetches // the next group of custom terminologies. NextToken *string + // The properties list of the custom terminologies returned on the list request. + TerminologyPropertiesList []*types.TerminologyProperties + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/translate/api_op_ListTextTranslationJobs.go b/service/translate/api_op_ListTextTranslationJobs.go index 5fe3d5de69c..7dfa8fc6bcc 100644 --- a/service/translate/api_op_ListTextTranslationJobs.go +++ b/service/translate/api_op_ListTextTranslationJobs.go @@ -56,16 +56,16 @@ func (c *Client) ListTextTranslationJobs(ctx context.Context, params *ListTextTr type ListTextTranslationJobsInput struct { - // The token to request the next page of results. - NextToken *string - - // The maximum number of results to return in each page. The default value is 100. - MaxResults *int32 - // The parameters that specify which batch translation jobs to retrieve. Filters // include job name, job status, and submission time. You can only set one filter // at a time. Filter *types.TextTranslationJobFilter + + // The maximum number of results to return in each page. The default value is 100. + MaxResults *int32 + + // The token to request the next page of results. + NextToken *string } type ListTextTranslationJobsOutput struct { diff --git a/service/translate/api_op_StartTextTranslationJob.go b/service/translate/api_op_StartTextTranslationJob.go index 95719ea9969..39b891ebf2c 100644 --- a/service/translate/api_op_StartTextTranslationJob.go +++ b/service/translate/api_op_StartTextTranslationJob.go @@ -91,9 +91,6 @@ type StartTextTranslationJobInput struct { // This member is required. OutputDataConfig *types.OutputDataConfig - // The name of the batch translation job to be performed. - JobName *string - // The language code of the input language. For a list of language codes, see // what-is-languages (). Amazon Translate does not automatically detect a source // language during batch translation jobs. @@ -101,14 +98,17 @@ type StartTextTranslationJobInput struct { // This member is required. SourceLanguageCode *string - // The name of the terminology to use in the batch translation job. For a list of - // available terminologies, use the ListTerminologies () operation. - TerminologyNames []*string - // The language code of the output language. // // This member is required. TargetLanguageCodes []*string + + // The name of the batch translation job to be performed. + JobName *string + + // The name of the terminology to use in the batch translation job. For a list of + // available terminologies, use the ListTerminologies () operation. + TerminologyNames []*string } type StartTextTranslationJobOutput struct { diff --git a/service/translate/api_op_StopTextTranslationJob.go b/service/translate/api_op_StopTextTranslationJob.go index 7034ae9265f..a78194c40e9 100644 --- a/service/translate/api_op_StopTextTranslationJob.go +++ b/service/translate/api_op_StopTextTranslationJob.go @@ -71,13 +71,13 @@ type StopTextTranslationJobInput struct { type StopTextTranslationJobOutput struct { + // The job ID of the stopped batch translation job. + JobId *string + // The status of the designated job. Upon successful completion, the job's status // will be STOPPED. JobStatus types.JobStatus - // The job ID of the stopped batch translation job. - JobId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/translate/api_op_TranslateText.go b/service/translate/api_op_TranslateText.go index 7e77c7fe2b6..356d50cb25f 100644 --- a/service/translate/api_op_TranslateText.go +++ b/service/translate/api_op_TranslateText.go @@ -69,18 +69,18 @@ type TranslateTextInput struct { // This member is required. SourceLanguageCode *string - // The text to translate. The text string can be a maximum of 5,000 bytes long. - // Depending on your character set, this may be fewer than 5,000 characters. - // - // This member is required. - Text *string - // The language code requested for the language of the target text. The language // must be a language supported by Amazon Translate. // // This member is required. TargetLanguageCode *string + // The text to translate. The text string can be a maximum of 5,000 bytes long. + // Depending on your character set, this may be fewer than 5,000 characters. + // + // This member is required. + Text *string + // The name of the terminology list file to be used in the TranslateText request. // You can use 1 terminology list at most in a TranslateText request. Terminology // lists can contain a maximum of 256 terms. diff --git a/service/translate/go.mod b/service/translate/go.mod index cbe19576004..e7658b03e75 100644 --- a/service/translate/go.mod +++ b/service/translate/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/translate go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/translate/types/types.go b/service/translate/types/types.go index f2652337424..12400729376 100644 --- a/service/translate/types/types.go +++ b/service/translate/types/types.go @@ -43,29 +43,29 @@ type EncryptionKey struct { // The input configuration properties for requesting a batch translation job. type InputDataConfig struct { - // The URI of the AWS S3 folder that contains the input file. The folder must be in - // the same Region as the API endpoint you are calling. - // - // This member is required. - S3Uri *string - // The multipurpose internet mail extension (MIME) type of the input files. Valid // values are text/plain for plaintext files and text/html for HTML files. // // This member is required. ContentType *string + + // The URI of the AWS S3 folder that contains the input file. The folder must be in + // the same Region as the API endpoint you are calling. + // + // This member is required. + S3Uri *string } // The number of documents successfully and unsuccessfully processed during a // translation job. type JobDetails struct { - // The number of documents used as input in a translation job. - InputDocumentsCount *int32 - // The number of documents that could not be processed during a translation job. DocumentsWithErrorsCount *int32 + // The number of documents used as input in a translation job. + InputDocumentsCount *int32 + // The number of documents successfully processed during a translation job. TranslatedDocumentsCount *int32 } @@ -83,27 +83,27 @@ type OutputDataConfig struct { // The term being translated by the custom terminology. type Term struct { - // The target text of the term being translated by the custom terminology. - TargetText *string - // The source text of the term being translated by the custom terminology. SourceText *string + + // The target text of the term being translated by the custom terminology. + TargetText *string } // The data associated with the custom terminology. type TerminologyData struct { - // The data format of the custom terminology. Either CSV or TMX. - // - // This member is required. - Format TerminologyDataFormat - // The file containing the custom terminology data. Your version of the AWS SDK // performs a Base64-encoding on this field before sending a request to the AWS // service. Users of the SDK should not perform Base64-encoding themselves. // // This member is required. File []byte + + // The data format of the custom terminology. Either CSV or TMX. + // + // This member is required. + Format TerminologyDataFormat } // The location of the custom terminology data. @@ -123,38 +123,38 @@ type TerminologyDataLocation struct { // The properties of the custom terminology. type TerminologyProperties struct { - // The size of the file used when importing a custom terminology. - SizeBytes *int32 + // The Amazon Resource Name (ARN) of the custom terminology. + Arn *string + + // The time at which the custom terminology was created, based on the timestamp. + CreatedAt *time.Time // The description of the custom terminology properties. Description *string + // The encryption key for the custom terminology. + EncryptionKey *EncryptionKey + + // The time at which the custom terminology was last update, based on the + // timestamp. + LastUpdatedAt *time.Time + // The name of the custom terminology. Name *string + // The size of the file used when importing a custom terminology. + SizeBytes *int32 + // The language code for the source text of the translation request for which the // custom terminology is being used. SourceLanguageCode *string - // The Amazon Resource Name (ARN) of the custom terminology. - Arn *string - // The language codes for the target languages available with the custom // terminology file. All possible target languages are returned in array. TargetLanguageCodes []*string - // The encryption key for the custom terminology. - EncryptionKey *EncryptionKey - // The number of terms included in the custom terminology. TermCount *int32 - - // The time at which the custom terminology was created, based on the timestamp. - CreatedAt *time.Time - - // The time at which the custom terminology was last update, based on the - // timestamp. - LastUpdatedAt *time.Time } // Provides information for filtering a list of translation jobs. For more @@ -164,6 +164,9 @@ type TextTranslationJobFilter struct { // Filters the list of jobs by name. JobName *string + // Filters the list of jobs based by job status. + JobStatus JobStatus + // Filters the list of jobs based on the time that the job was submitted for // processing and returns only the jobs submitted after the specified time. Jobs // are returned in descending order, newest to oldest. @@ -173,42 +176,18 @@ type TextTranslationJobFilter struct { // processing and returns only the jobs submitted before the specified time. Jobs // are returned in ascending order, oldest to newest. SubmittedBeforeTime *time.Time - - // Filters the list of jobs based by job status. - JobStatus JobStatus } // Provides information about a translation job. type TextTranslationJobProperties struct { - // The user-defined name of the translation job. - JobName *string - - // A list containing the names of the terminologies applied to a translation job. - // Only one terminology can be applied per StartTextTranslationJob () request at - // this time. - TerminologyNames []*string - - // The language code of the language of the target text. The language must be a - // language supported by Amazon Translate. - TargetLanguageCodes []*string - - // An explanation of any errors that may have occured during the translation job. - Message *string - - // The status of the translation job. - JobStatus JobStatus + // The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) + // role that granted Amazon Translate read access to the job's input data. + DataAccessRoleArn *string // The time at which the translation job ended. EndTime *time.Time - // The time at which the translation job was submitted. - SubmittedTime *time.Time - - // The output configuration properties that were specified when the job was - // requested. - OutputDataConfig *OutputDataConfig - // The input configuration properties that were specified when the job was // requested. InputDataConfig *InputDataConfig @@ -217,14 +196,35 @@ type TextTranslationJobProperties struct { // translation job. JobDetails *JobDetails + // The ID of the translation job. + JobId *string + + // The user-defined name of the translation job. + JobName *string + + // The status of the translation job. + JobStatus JobStatus + + // An explanation of any errors that may have occured during the translation job. + Message *string + + // The output configuration properties that were specified when the job was + // requested. + OutputDataConfig *OutputDataConfig + // The language code of the language of the source text. The language must be a // language supported by Amazon Translate. SourceLanguageCode *string - // The ID of the translation job. - JobId *string + // The time at which the translation job was submitted. + SubmittedTime *time.Time - // The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) - // role that granted Amazon Translate read access to the job's input data. - DataAccessRoleArn *string + // The language code of the language of the target text. The language must be a + // language supported by Amazon Translate. + TargetLanguageCodes []*string + + // A list containing the names of the terminologies applied to a translation job. + // Only one terminology can be applied per StartTextTranslationJob () request at + // this time. + TerminologyNames []*string } diff --git a/service/waf/api_op_CreateByteMatchSet.go b/service/waf/api_op_CreateByteMatchSet.go index ecde12c738e..ef9151ac81c 100644 --- a/service/waf/api_op_CreateByteMatchSet.go +++ b/service/waf/api_op_CreateByteMatchSet.go @@ -101,14 +101,14 @@ type CreateByteMatchSetInput struct { type CreateByteMatchSetOutput struct { + // A ByteMatchSet () that contains no ByteMatchTuple objects. + ByteMatchSet *types.ByteMatchSet + // The ChangeToken that you used to submit the CreateByteMatchSet request. You can // also use this value to query the status of the request. For more information, // see GetChangeTokenStatus (). ChangeToken *string - // A ByteMatchSet () that contains no ByteMatchTuple objects. - ByteMatchSet *types.ByteMatchSet - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/waf/api_op_CreateIPSet.go b/service/waf/api_op_CreateIPSet.go index 5d7ad40c248..e8304ebd030 100644 --- a/service/waf/api_op_CreateIPSet.go +++ b/service/waf/api_op_CreateIPSet.go @@ -86,28 +86,28 @@ func (c *Client) CreateIPSet(ctx context.Context, params *CreateIPSetInput, optF type CreateIPSetInput struct { - // A friendly name or description of the IPSet (). You can't change Name after you - // create the IPSet. + // The value returned by the most recent call to GetChangeToken (). // // This member is required. - Name *string + ChangeToken *string - // The value returned by the most recent call to GetChangeToken (). + // A friendly name or description of the IPSet (). You can't change Name after you + // create the IPSet. // // This member is required. - ChangeToken *string + Name *string } type CreateIPSetOutput struct { - // The IPSet () returned in the CreateIPSet response. - IPSet *types.IPSet - // The ChangeToken that you used to submit the CreateIPSet request. You can also // use this value to query the status of the request. For more information, see // GetChangeTokenStatus (). ChangeToken *string + // The IPSet () returned in the CreateIPSet response. + IPSet *types.IPSet + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/waf/api_op_CreateRateBasedRule.go b/service/waf/api_op_CreateRateBasedRule.go index 5f258345249..af8929eaaf1 100644 --- a/service/waf/api_op_CreateRateBasedRule.go +++ b/service/waf/api_op_CreateRateBasedRule.go @@ -111,14 +111,12 @@ func (c *Client) CreateRateBasedRule(ctx context.Context, params *CreateRateBase type CreateRateBasedRuleInput struct { - // A friendly name or description of the RateBasedRule (). You can't change the - // name of a RateBasedRule after you create it. + // The ChangeToken that you used to submit the CreateRateBasedRule request. You can + // also use this value to query the status of the request. For more information, + // see GetChangeTokenStatus (). // // This member is required. - Name *string - - // - Tags []*types.Tag + ChangeToken *string // A friendly name or description for the metrics for this RateBasedRule. The name // can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length @@ -129,13 +127,11 @@ type CreateRateBasedRuleInput struct { // This member is required. MetricName *string - // The maximum number of requests, which have an identical value in the field that - // is specified by RateKey, allowed in a five-minute period. If the number of - // requests exceeds the RateLimit and the other predicates specified in the rule - // are also met, AWS WAF triggers the action that is specified for this rule. + // A friendly name or description of the RateBasedRule (). You can't change the + // name of a RateBasedRule after you create it. // // This member is required. - RateLimit *int64 + Name *string // The field that AWS WAF uses to determine if requests are likely arriving from a // single source and thus subject to rate monitoring. The only valid value for @@ -145,24 +141,28 @@ type CreateRateBasedRuleInput struct { // This member is required. RateKey types.RateKey - // The ChangeToken that you used to submit the CreateRateBasedRule request. You can - // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus (). + // The maximum number of requests, which have an identical value in the field that + // is specified by RateKey, allowed in a five-minute period. If the number of + // requests exceeds the RateLimit and the other predicates specified in the rule + // are also met, AWS WAF triggers the action that is specified for this rule. // // This member is required. - ChangeToken *string + RateLimit *int64 + + // + Tags []*types.Tag } type CreateRateBasedRuleOutput struct { - // The RateBasedRule () that is returned in the CreateRateBasedRule response. - Rule *types.RateBasedRule - // The ChangeToken that you used to submit the CreateRateBasedRule request. You can // also use this value to query the status of the request. For more information, // see GetChangeTokenStatus (). ChangeToken *string + // The RateBasedRule () that is returned in the CreateRateBasedRule response. + Rule *types.RateBasedRule + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/waf/api_op_CreateRegexPatternSet.go b/service/waf/api_op_CreateRegexPatternSet.go index 80ee65ede13..5003ec65327 100644 --- a/service/waf/api_op_CreateRegexPatternSet.go +++ b/service/waf/api_op_CreateRegexPatternSet.go @@ -84,28 +84,28 @@ func (c *Client) CreateRegexPatternSet(ctx context.Context, params *CreateRegexP type CreateRegexPatternSetInput struct { - // A friendly name or description of the RegexPatternSet (). You can't change Name - // after you create a RegexPatternSet. + // The value returned by the most recent call to GetChangeToken (). // // This member is required. - Name *string + ChangeToken *string - // The value returned by the most recent call to GetChangeToken (). + // A friendly name or description of the RegexPatternSet (). You can't change Name + // after you create a RegexPatternSet. // // This member is required. - ChangeToken *string + Name *string } type CreateRegexPatternSetOutput struct { - // A RegexPatternSet () that contains no objects. - RegexPatternSet *types.RegexPatternSet - // The ChangeToken that you used to submit the CreateRegexPatternSet request. You // can also use this value to query the status of the request. For more // information, see GetChangeTokenStatus (). ChangeToken *string + // A RegexPatternSet () that contains no objects. + RegexPatternSet *types.RegexPatternSet + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/waf/api_op_CreateRule.go b/service/waf/api_op_CreateRule.go index 8c86259c18a..2843d1fb5d2 100644 --- a/service/waf/api_op_CreateRule.go +++ b/service/waf/api_op_CreateRule.go @@ -108,8 +108,14 @@ type CreateRuleInput struct { // This member is required. ChangeToken *string + // A friendly name or description for the metrics for this Rule. The name can + // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 + // and minimum length one. It can't contain whitespace or metric names reserved for + // AWS WAF, including "All" and "Default_Action." You can't change the name of the + // metric after you create the Rule. // - Tags []*types.Tag + // This member is required. + MetricName *string // A friendly name or description of the Rule (). You can't change the name of a // Rule after you create it. @@ -117,14 +123,8 @@ type CreateRuleInput struct { // This member is required. Name *string - // A friendly name or description for the metrics for this Rule. The name can - // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 - // and minimum length one. It can't contain whitespace or metric names reserved for - // AWS WAF, including "All" and "Default_Action." You can't change the name of the - // metric after you create the Rule. // - // This member is required. - MetricName *string + Tags []*types.Tag } type CreateRuleOutput struct { diff --git a/service/waf/api_op_CreateRuleGroup.go b/service/waf/api_op_CreateRuleGroup.go index da6c8e15451..b12e710808f 100644 --- a/service/waf/api_op_CreateRuleGroup.go +++ b/service/waf/api_op_CreateRuleGroup.go @@ -78,8 +78,10 @@ func (c *Client) CreateRuleGroup(ctx context.Context, params *CreateRuleGroupInp type CreateRuleGroupInput struct { + // The value returned by the most recent call to GetChangeToken (). // - Tags []*types.Tag + // This member is required. + ChangeToken *string // A friendly name or description for the metrics for this RuleGroup. The name can // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 @@ -96,10 +98,8 @@ type CreateRuleGroupInput struct { // This member is required. Name *string - // The value returned by the most recent call to GetChangeToken (). // - // This member is required. - ChangeToken *string + Tags []*types.Tag } type CreateRuleGroupOutput struct { diff --git a/service/waf/api_op_CreateSizeConstraintSet.go b/service/waf/api_op_CreateSizeConstraintSet.go index ff3c79a85a2..b10872ad4f6 100644 --- a/service/waf/api_op_CreateSizeConstraintSet.go +++ b/service/waf/api_op_CreateSizeConstraintSet.go @@ -88,28 +88,28 @@ func (c *Client) CreateSizeConstraintSet(ctx context.Context, params *CreateSize type CreateSizeConstraintSetInput struct { - // A friendly name or description of the SizeConstraintSet (). You can't change - // Name after you create a SizeConstraintSet. + // The value returned by the most recent call to GetChangeToken (). // // This member is required. - Name *string + ChangeToken *string - // The value returned by the most recent call to GetChangeToken (). + // A friendly name or description of the SizeConstraintSet (). You can't change + // Name after you create a SizeConstraintSet. // // This member is required. - ChangeToken *string + Name *string } type CreateSizeConstraintSetOutput struct { - // A SizeConstraintSet () that contains no SizeConstraint objects. - SizeConstraintSet *types.SizeConstraintSet - // The ChangeToken that you used to submit the CreateSizeConstraintSet request. You // can also use this value to query the status of the request. For more // information, see GetChangeTokenStatus (). ChangeToken *string + // A SizeConstraintSet () that contains no SizeConstraint objects. + SizeConstraintSet *types.SizeConstraintSet + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/waf/api_op_CreateWebACL.go b/service/waf/api_op_CreateWebACL.go index 4d8597a9f2a..67bd5a6611c 100644 --- a/service/waf/api_op_CreateWebACL.go +++ b/service/waf/api_op_CreateWebACL.go @@ -97,16 +97,17 @@ func (c *Client) CreateWebACL(ctx context.Context, params *CreateWebACLInput, op type CreateWebACLInput struct { - // A friendly name or description of the WebACL (). You can't change Name after you - // create the WebACL. + // The value returned by the most recent call to GetChangeToken (). // // This member is required. - Name *string + ChangeToken *string - // The value returned by the most recent call to GetChangeToken (). + // The action that you want AWS WAF to take when a request doesn't match the + // criteria specified in any of the Rule objects that are associated with the + // WebACL. // // This member is required. - ChangeToken *string + DefaultAction *types.WafAction // A friendly name or description for the metrics for this WebACL.The name can // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 @@ -117,27 +118,26 @@ type CreateWebACLInput struct { // This member is required. MetricName *string + // A friendly name or description of the WebACL (). You can't change Name after you + // create the WebACL. // - Tags []*types.Tag + // This member is required. + Name *string - // The action that you want AWS WAF to take when a request doesn't match the - // criteria specified in any of the Rule objects that are associated with the - // WebACL. // - // This member is required. - DefaultAction *types.WafAction + Tags []*types.Tag } type CreateWebACLOutput struct { - // The WebACL () returned in the CreateWebACL response. - WebACL *types.WebACL - // The ChangeToken that you used to submit the CreateWebACL request. You can also // use this value to query the status of the request. For more information, see // GetChangeTokenStatus (). ChangeToken *string + // The WebACL () returned in the CreateWebACL response. + WebACL *types.WebACL + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/waf/api_op_CreateWebACLMigrationStack.go b/service/waf/api_op_CreateWebACLMigrationStack.go index eb5d13f551f..8fbdfa45585 100644 --- a/service/waf/api_op_CreateWebACLMigrationStack.go +++ b/service/waf/api_op_CreateWebACLMigrationStack.go @@ -66,10 +66,13 @@ func (c *Client) CreateWebACLMigrationStack(ctx context.Context, params *CreateW type CreateWebACLMigrationStackInput struct { - // The UUID of the WAF Classic web ACL that you want to migrate to WAF v2. + // Indicates whether to exclude entities that can't be migrated or to stop the + // migration. Set this to true to ignore unsupported entities in the web ACL during + // the migration. Otherwise, if AWS WAF encounters unsupported entities, it stops + // the process and throws an exception. // // This member is required. - WebACLId *string + IgnoreUnsupportedType *bool // The name of the Amazon S3 bucket to store the CloudFormation template in. The S3 // bucket must be configured as follows for the migration: @@ -89,13 +92,10 @@ type CreateWebACLMigrationStackInput struct { // This member is required. S3BucketName *string - // Indicates whether to exclude entities that can't be migrated or to stop the - // migration. Set this to true to ignore unsupported entities in the web ACL during - // the migration. Otherwise, if AWS WAF encounters unsupported entities, it stops - // the process and throws an exception. + // The UUID of the WAF Classic web ACL that you want to migrate to WAF v2. // // This member is required. - IgnoreUnsupportedType *bool + WebACLId *string } type CreateWebACLMigrationStackOutput struct { diff --git a/service/waf/api_op_CreateXssMatchSet.go b/service/waf/api_op_CreateXssMatchSet.go index d060703f3f7..74500f68bc4 100644 --- a/service/waf/api_op_CreateXssMatchSet.go +++ b/service/waf/api_op_CreateXssMatchSet.go @@ -86,16 +86,16 @@ func (c *Client) CreateXssMatchSet(ctx context.Context, params *CreateXssMatchSe // A request to create an XssMatchSet (). type CreateXssMatchSetInput struct { - // A friendly name or description for the XssMatchSet () that you're creating. You - // can't change Name after you create the XssMatchSet. + // The value returned by the most recent call to GetChangeToken (). // // This member is required. - Name *string + ChangeToken *string - // The value returned by the most recent call to GetChangeToken (). + // A friendly name or description for the XssMatchSet () that you're creating. You + // can't change Name after you create the XssMatchSet. // // This member is required. - ChangeToken *string + Name *string } // The response to a CreateXssMatchSet request. diff --git a/service/waf/api_op_DeleteIPSet.go b/service/waf/api_op_DeleteIPSet.go index 452a294da96..e848c62e103 100644 --- a/service/waf/api_op_DeleteIPSet.go +++ b/service/waf/api_op_DeleteIPSet.go @@ -75,16 +75,16 @@ func (c *Client) DeleteIPSet(ctx context.Context, params *DeleteIPSetInput, optF type DeleteIPSetInput struct { - // The IPSetId of the IPSet () that you want to delete. IPSetId is returned by - // CreateIPSet () and by ListIPSets (). + // The value returned by the most recent call to GetChangeToken (). // // This member is required. - IPSetId *string + ChangeToken *string - // The value returned by the most recent call to GetChangeToken (). + // The IPSetId of the IPSet () that you want to delete. IPSetId is returned by + // CreateIPSet () and by ListIPSets (). // // This member is required. - ChangeToken *string + IPSetId *string } type DeleteIPSetOutput struct { diff --git a/service/waf/api_op_DeleteRateBasedRule.go b/service/waf/api_op_DeleteRateBasedRule.go index 3534b2d0640..568652b60ed 100644 --- a/service/waf/api_op_DeleteRateBasedRule.go +++ b/service/waf/api_op_DeleteRateBasedRule.go @@ -75,16 +75,16 @@ func (c *Client) DeleteRateBasedRule(ctx context.Context, params *DeleteRateBase type DeleteRateBasedRuleInput struct { - // The RuleId of the RateBasedRule () that you want to delete. RuleId is returned - // by CreateRateBasedRule () and by ListRateBasedRules (). + // The value returned by the most recent call to GetChangeToken (). // // This member is required. - RuleId *string + ChangeToken *string - // The value returned by the most recent call to GetChangeToken (). + // The RuleId of the RateBasedRule () that you want to delete. RuleId is returned + // by CreateRateBasedRule () and by ListRateBasedRules (). // // This member is required. - ChangeToken *string + RuleId *string } type DeleteRateBasedRuleOutput struct { diff --git a/service/waf/api_op_DeleteRegexMatchSet.go b/service/waf/api_op_DeleteRegexMatchSet.go index 89c1bb164a7..f16cda5f297 100644 --- a/service/waf/api_op_DeleteRegexMatchSet.go +++ b/service/waf/api_op_DeleteRegexMatchSet.go @@ -76,17 +76,17 @@ func (c *Client) DeleteRegexMatchSet(ctx context.Context, params *DeleteRegexMat type DeleteRegexMatchSetInput struct { + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + // The RegexMatchSetId of the RegexMatchSet () that you want to delete. // RegexMatchSetId is returned by CreateRegexMatchSet () and by ListRegexMatchSets // (). // // This member is required. RegexMatchSetId *string - - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string } type DeleteRegexMatchSetOutput struct { diff --git a/service/waf/api_op_DeleteRuleGroup.go b/service/waf/api_op_DeleteRuleGroup.go index 3c7d8e51a6e..be902d172b8 100644 --- a/service/waf/api_op_DeleteRuleGroup.go +++ b/service/waf/api_op_DeleteRuleGroup.go @@ -75,16 +75,16 @@ func (c *Client) DeleteRuleGroup(ctx context.Context, params *DeleteRuleGroupInp type DeleteRuleGroupInput struct { - // The RuleGroupId of the RuleGroup () that you want to delete. RuleGroupId is - // returned by CreateRuleGroup () and by ListRuleGroups (). + // The value returned by the most recent call to GetChangeToken (). // // This member is required. - RuleGroupId *string + ChangeToken *string - // The value returned by the most recent call to GetChangeToken (). + // The RuleGroupId of the RuleGroup () that you want to delete. RuleGroupId is + // returned by CreateRuleGroup () and by ListRuleGroups (). // // This member is required. - ChangeToken *string + RuleGroupId *string } type DeleteRuleGroupOutput struct { diff --git a/service/waf/api_op_DeleteSizeConstraintSet.go b/service/waf/api_op_DeleteSizeConstraintSet.go index c4f1c01344f..41b108d62b9 100644 --- a/service/waf/api_op_DeleteSizeConstraintSet.go +++ b/service/waf/api_op_DeleteSizeConstraintSet.go @@ -76,17 +76,17 @@ func (c *Client) DeleteSizeConstraintSet(ctx context.Context, params *DeleteSize type DeleteSizeConstraintSetInput struct { + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + // The SizeConstraintSetId of the SizeConstraintSet () that you want to delete. // SizeConstraintSetId is returned by CreateSizeConstraintSet () and by // ListSizeConstraintSets (). // // This member is required. SizeConstraintSetId *string - - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string } type DeleteSizeConstraintSetOutput struct { diff --git a/service/waf/api_op_DeleteSqlInjectionMatchSet.go b/service/waf/api_op_DeleteSqlInjectionMatchSet.go index a98bdc96c97..492e18c6b2b 100644 --- a/service/waf/api_op_DeleteSqlInjectionMatchSet.go +++ b/service/waf/api_op_DeleteSqlInjectionMatchSet.go @@ -78,17 +78,17 @@ func (c *Client) DeleteSqlInjectionMatchSet(ctx context.Context, params *DeleteS // A request to delete a SqlInjectionMatchSet () from AWS WAF. type DeleteSqlInjectionMatchSetInput struct { + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + // The SqlInjectionMatchSetId of the SqlInjectionMatchSet () that you want to // delete. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet () and // by ListSqlInjectionMatchSets (). // // This member is required. SqlInjectionMatchSetId *string - - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string } // The response to a request to delete a SqlInjectionMatchSet () from AWS WAF. diff --git a/service/waf/api_op_GetRateBasedRuleManagedKeys.go b/service/waf/api_op_GetRateBasedRuleManagedKeys.go index da8cfd5c90f..46fcc58d8ff 100644 --- a/service/waf/api_op_GetRateBasedRuleManagedKeys.go +++ b/service/waf/api_op_GetRateBasedRuleManagedKeys.go @@ -65,15 +65,15 @@ func (c *Client) GetRateBasedRuleManagedKeys(ctx context.Context, params *GetRat type GetRateBasedRuleManagedKeysInput struct { - // A null value and not currently used. Do not include this in your request. - NextMarker *string - // The RuleId of the RateBasedRule () for which you want to get a list of // ManagedKeys. RuleId is returned by CreateRateBasedRule () and by // ListRateBasedRules (). // // This member is required. RuleId *string + + // A null value and not currently used. Do not include this in your request. + NextMarker *string } type GetRateBasedRuleManagedKeysOutput struct { diff --git a/service/waf/api_op_GetSampledRequests.go b/service/waf/api_op_GetSampledRequests.go index 8c684e59ebb..d7c2f31ff43 100644 --- a/service/waf/api_op_GetSampledRequests.go +++ b/service/waf/api_op_GetSampledRequests.go @@ -72,20 +72,13 @@ func (c *Client) GetSampledRequests(ctx context.Context, params *GetSampledReque type GetSampledRequestsInput struct { - // The start date and time and the end date and time of the range for which you - // want GetSampledRequests to return a sample of requests. You must specify the - // times in Coordinated Universal Time (UTC) format. UTC format includes the - // special designator, Z. For example, "2016-09-27T14:50Z". You can specify any - // time range in the previous three hours. - // - // This member is required. - TimeWindow *types.TimeWindow - - // The WebACLId of the WebACL for which you want GetSampledRequests to return a - // sample of requests. + // The number of requests that you want AWS WAF to return from among the first + // 5,000 requests that your AWS resource received during the time range. If your + // resource received fewer requests than the value of MaxItems, GetSampledRequests + // returns information about all of them. // // This member is required. - WebAclId *string + MaxItems *int64 // RuleId is one of three values: // @@ -100,17 +93,33 @@ type GetSampledRequestsInput struct { // This member is required. RuleId *string - // The number of requests that you want AWS WAF to return from among the first - // 5,000 requests that your AWS resource received during the time range. If your - // resource received fewer requests than the value of MaxItems, GetSampledRequests - // returns information about all of them. + // The start date and time and the end date and time of the range for which you + // want GetSampledRequests to return a sample of requests. You must specify the + // times in Coordinated Universal Time (UTC) format. UTC format includes the + // special designator, Z. For example, "2016-09-27T14:50Z". You can specify any + // time range in the previous three hours. // // This member is required. - MaxItems *int64 + TimeWindow *types.TimeWindow + + // The WebACLId of the WebACL for which you want GetSampledRequests to return a + // sample of requests. + // + // This member is required. + WebAclId *string } type GetSampledRequestsOutput struct { + // The total number of requests from which GetSampledRequests got a sample of + // MaxItems requests. If PopulationSize is less than MaxItems, the sample includes + // every request that your AWS resource received during the specified time range. + PopulationSize *int64 + + // A complex type that contains detailed information about each of the requests in + // the sample. + SampledRequests []*types.SampledHTTPRequest + // Usually, TimeWindow is the time range that you specified in the // GetSampledRequests request. However, if your AWS resource received more than // 5,000 requests during the time range that you specified in the request, @@ -118,15 +127,6 @@ type GetSampledRequestsOutput struct { // are in Coordinated Universal Time (UTC) format. TimeWindow *types.TimeWindow - // A complex type that contains detailed information about each of the requests in - // the sample. - SampledRequests []*types.SampledHTTPRequest - - // The total number of requests from which GetSampledRequests got a sample of - // MaxItems requests. If PopulationSize is less than MaxItems, the sample includes - // every request that your AWS resource received during the specified time range. - PopulationSize *int64 - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/waf/api_op_ListActivatedRulesInRuleGroup.go b/service/waf/api_op_ListActivatedRulesInRuleGroup.go index 5d5bf3d614a..6994daed5c0 100644 --- a/service/waf/api_op_ListActivatedRulesInRuleGroup.go +++ b/service/waf/api_op_ListActivatedRulesInRuleGroup.go @@ -62,10 +62,6 @@ func (c *Client) ListActivatedRulesInRuleGroup(ctx context.Context, params *List type ListActivatedRulesInRuleGroupInput struct { - // The RuleGroupId of the RuleGroup () for which you want to get a list of - // ActivatedRule () objects. - RuleGroupId *string - // Specifies the number of ActivatedRules that you want AWS WAF to return for this // request. If you have more ActivatedRules than the number that you specify for // Limit, the response includes a NextMarker value that you can use to get another @@ -78,6 +74,10 @@ type ListActivatedRulesInRuleGroupInput struct { // ListActivatedRulesInRuleGroup requests, specify the value of NextMarker from the // previous response to get information about another batch of ActivatedRules. NextMarker *string + + // The RuleGroupId of the RuleGroup () for which you want to get a list of + // ActivatedRule () objects. + RuleGroupId *string } type ListActivatedRulesInRuleGroupOutput struct { diff --git a/service/waf/api_op_ListByteMatchSets.go b/service/waf/api_op_ListByteMatchSets.go index e781da34cfb..97328bed8fe 100644 --- a/service/waf/api_op_ListByteMatchSets.go +++ b/service/waf/api_op_ListByteMatchSets.go @@ -62,31 +62,31 @@ func (c *Client) ListByteMatchSets(ctx context.Context, params *ListByteMatchSet type ListByteMatchSetsInput struct { + // Specifies the number of ByteMatchSet objects that you want AWS WAF to return for + // this request. If you have more ByteMatchSets objects than the number you specify + // for Limit, the response includes a NextMarker value that you can use to get + // another batch of ByteMatchSet objects. + Limit *int32 + // If you specify a value for Limit and you have more ByteMatchSets than the value // of Limit, AWS WAF returns a NextMarker value in the response that allows you to // list another group of ByteMatchSets. For the second and subsequent // ListByteMatchSets requests, specify the value of NextMarker from the previous // response to get information about another batch of ByteMatchSets. NextMarker *string - - // Specifies the number of ByteMatchSet objects that you want AWS WAF to return for - // this request. If you have more ByteMatchSets objects than the number you specify - // for Limit, the response includes a NextMarker value that you can use to get - // another batch of ByteMatchSet objects. - Limit *int32 } type ListByteMatchSetsOutput struct { + // An array of ByteMatchSetSummary () objects. + ByteMatchSets []*types.ByteMatchSetSummary + // If you have more ByteMatchSet objects than the number that you specified for // Limit in the request, the response includes a NextMarker value. To list more // ByteMatchSet objects, submit another ListByteMatchSets request, and specify the // NextMarker value from the response in the NextMarker value in the next request. NextMarker *string - // An array of ByteMatchSetSummary () objects. - ByteMatchSets []*types.ByteMatchSetSummary - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/waf/api_op_ListGeoMatchSets.go b/service/waf/api_op_ListGeoMatchSets.go index 818c624b799..9ff2823d3ec 100644 --- a/service/waf/api_op_ListGeoMatchSets.go +++ b/service/waf/api_op_ListGeoMatchSets.go @@ -62,31 +62,31 @@ func (c *Client) ListGeoMatchSets(ctx context.Context, params *ListGeoMatchSetsI type ListGeoMatchSetsInput struct { + // Specifies the number of GeoMatchSet objects that you want AWS WAF to return for + // this request. If you have more GeoMatchSet objects than the number you specify + // for Limit, the response includes a NextMarker value that you can use to get + // another batch of GeoMatchSet objects. + Limit *int32 + // If you specify a value for Limit and you have more GeoMatchSets than the value // of Limit, AWS WAF returns a NextMarker value in the response that allows you to // list another group of GeoMatchSet objects. For the second and subsequent // ListGeoMatchSets requests, specify the value of NextMarker from the previous // response to get information about another batch of GeoMatchSet objects. NextMarker *string - - // Specifies the number of GeoMatchSet objects that you want AWS WAF to return for - // this request. If you have more GeoMatchSet objects than the number you specify - // for Limit, the response includes a NextMarker value that you can use to get - // another batch of GeoMatchSet objects. - Limit *int32 } type ListGeoMatchSetsOutput struct { + // An array of GeoMatchSetSummary () objects. + GeoMatchSets []*types.GeoMatchSetSummary + // If you have more GeoMatchSet objects than the number that you specified for // Limit in the request, the response includes a NextMarker value. To list more // GeoMatchSet objects, submit another ListGeoMatchSets request, and specify the // NextMarker value from the response in the NextMarker value in the next request. NextMarker *string - // An array of GeoMatchSetSummary () objects. - GeoMatchSets []*types.GeoMatchSetSummary - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/waf/api_op_ListIPSets.go b/service/waf/api_op_ListIPSets.go index 5f7fa3b0e9c..992150b6359 100644 --- a/service/waf/api_op_ListIPSets.go +++ b/service/waf/api_op_ListIPSets.go @@ -62,17 +62,17 @@ func (c *Client) ListIPSets(ctx context.Context, params *ListIPSetsInput, optFns type ListIPSetsInput struct { - // AWS WAF returns a NextMarker value in the response that allows you to list - // another group of IPSets. For the second and subsequent ListIPSets requests, - // specify the value of NextMarker from the previous response to get information - // about another batch of IPSets. - NextMarker *string - // Specifies the number of IPSet objects that you want AWS WAF to return for this // request. If you have more IPSet objects than the number you specify for Limit, // the response includes a NextMarker value that you can use to get another batch // of IPSet objects. Limit *int32 + + // AWS WAF returns a NextMarker value in the response that allows you to list + // another group of IPSets. For the second and subsequent ListIPSets requests, + // specify the value of NextMarker from the previous response to get information + // about another batch of IPSets. + NextMarker *string } type ListIPSetsOutput struct { diff --git a/service/waf/api_op_ListLoggingConfigurations.go b/service/waf/api_op_ListLoggingConfigurations.go index 8bef1d3313f..93b87906b6f 100644 --- a/service/waf/api_op_ListLoggingConfigurations.go +++ b/service/waf/api_op_ListLoggingConfigurations.go @@ -62,6 +62,12 @@ func (c *Client) ListLoggingConfigurations(ctx context.Context, params *ListLogg type ListLoggingConfigurationsInput struct { + // Specifies the number of LoggingConfigurations that you want AWS WAF to return + // for this request. If you have more LoggingConfigurations than the number that + // you specify for Limit, the response includes a NextMarker value that you can use + // to get another batch of LoggingConfigurations. + Limit *int32 + // If you specify a value for Limit and you have more LoggingConfigurations than // the value of Limit, AWS WAF returns a NextMarker value in the response that // allows you to list another group of LoggingConfigurations. For the second and @@ -69,12 +75,6 @@ type ListLoggingConfigurationsInput struct { // from the previous response to get information about another batch of // ListLoggingConfigurations. NextMarker *string - - // Specifies the number of LoggingConfigurations that you want AWS WAF to return - // for this request. If you have more LoggingConfigurations than the number that - // you specify for Limit, the response includes a NextMarker value that you can use - // to get another batch of LoggingConfigurations. - Limit *int32 } type ListLoggingConfigurationsOutput struct { diff --git a/service/waf/api_op_ListRegexMatchSets.go b/service/waf/api_op_ListRegexMatchSets.go index 91d01edcdcb..1a00e839a3b 100644 --- a/service/waf/api_op_ListRegexMatchSets.go +++ b/service/waf/api_op_ListRegexMatchSets.go @@ -62,18 +62,18 @@ func (c *Client) ListRegexMatchSets(ctx context.Context, params *ListRegexMatchS type ListRegexMatchSetsInput struct { + // Specifies the number of RegexMatchSet objects that you want AWS WAF to return + // for this request. If you have more RegexMatchSet objects than the number you + // specify for Limit, the response includes a NextMarker value that you can use to + // get another batch of RegexMatchSet objects. + Limit *int32 + // If you specify a value for Limit and you have more RegexMatchSet objects than // the value of Limit, AWS WAF returns a NextMarker value in the response that // allows you to list another group of ByteMatchSets. For the second and subsequent // ListRegexMatchSets requests, specify the value of NextMarker from the previous // response to get information about another batch of RegexMatchSet objects. NextMarker *string - - // Specifies the number of RegexMatchSet objects that you want AWS WAF to return - // for this request. If you have more RegexMatchSet objects than the number you - // specify for Limit, the response includes a NextMarker value that you can use to - // get another batch of RegexMatchSet objects. - Limit *int32 } type ListRegexMatchSetsOutput struct { diff --git a/service/waf/api_op_ListRegexPatternSets.go b/service/waf/api_op_ListRegexPatternSets.go index 87f7699e392..094b274cfd2 100644 --- a/service/waf/api_op_ListRegexPatternSets.go +++ b/service/waf/api_op_ListRegexPatternSets.go @@ -62,6 +62,12 @@ func (c *Client) ListRegexPatternSets(ctx context.Context, params *ListRegexPatt type ListRegexPatternSetsInput struct { + // Specifies the number of RegexPatternSet objects that you want AWS WAF to return + // for this request. If you have more RegexPatternSet objects than the number you + // specify for Limit, the response includes a NextMarker value that you can use to + // get another batch of RegexPatternSet objects. + Limit *int32 + // If you specify a value for Limit and you have more RegexPatternSet objects than // the value of Limit, AWS WAF returns a NextMarker value in the response that // allows you to list another group of RegexPatternSet objects. For the second and @@ -69,12 +75,6 @@ type ListRegexPatternSetsInput struct { // the previous response to get information about another batch of RegexPatternSet // objects. NextMarker *string - - // Specifies the number of RegexPatternSet objects that you want AWS WAF to return - // for this request. If you have more RegexPatternSet objects than the number you - // specify for Limit, the response includes a NextMarker value that you can use to - // get another batch of RegexPatternSet objects. - Limit *int32 } type ListRegexPatternSetsOutput struct { diff --git a/service/waf/api_op_ListRuleGroups.go b/service/waf/api_op_ListRuleGroups.go index 507c62549c6..0eab9ffd77d 100644 --- a/service/waf/api_op_ListRuleGroups.go +++ b/service/waf/api_op_ListRuleGroups.go @@ -62,31 +62,31 @@ func (c *Client) ListRuleGroups(ctx context.Context, params *ListRuleGroupsInput type ListRuleGroupsInput struct { + // Specifies the number of RuleGroups that you want AWS WAF to return for this + // request. If you have more RuleGroups than the number that you specify for Limit, + // the response includes a NextMarker value that you can use to get another batch + // of RuleGroups. + Limit *int32 + // If you specify a value for Limit and you have more RuleGroups than the value of // Limit, AWS WAF returns a NextMarker value in the response that allows you to // list another group of RuleGroups. For the second and subsequent ListRuleGroups // requests, specify the value of NextMarker from the previous response to get // information about another batch of RuleGroups. NextMarker *string - - // Specifies the number of RuleGroups that you want AWS WAF to return for this - // request. If you have more RuleGroups than the number that you specify for Limit, - // the response includes a NextMarker value that you can use to get another batch - // of RuleGroups. - Limit *int32 } type ListRuleGroupsOutput struct { - // An array of RuleGroup () objects. - RuleGroups []*types.RuleGroupSummary - // If you have more RuleGroups than the number that you specified for Limit in the // request, the response includes a NextMarker value. To list more RuleGroups, // submit another ListRuleGroups request, and specify the NextMarker value from the // response in the NextMarker value in the next request. NextMarker *string + // An array of RuleGroup () objects. + RuleGroups []*types.RuleGroupSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/waf/api_op_ListRules.go b/service/waf/api_op_ListRules.go index a95afaf6158..27bb99ed5cd 100644 --- a/service/waf/api_op_ListRules.go +++ b/service/waf/api_op_ListRules.go @@ -62,30 +62,30 @@ func (c *Client) ListRules(ctx context.Context, params *ListRulesInput, optFns . type ListRulesInput struct { + // Specifies the number of Rules that you want AWS WAF to return for this request. + // If you have more Rules than the number that you specify for Limit, the response + // includes a NextMarker value that you can use to get another batch of Rules. + Limit *int32 + // If you specify a value for Limit and you have more Rules than the value of // Limit, AWS WAF returns a NextMarker value in the response that allows you to // list another group of Rules. For the second and subsequent ListRules requests, // specify the value of NextMarker from the previous response to get information // about another batch of Rules. NextMarker *string - - // Specifies the number of Rules that you want AWS WAF to return for this request. - // If you have more Rules than the number that you specify for Limit, the response - // includes a NextMarker value that you can use to get another batch of Rules. - Limit *int32 } type ListRulesOutput struct { - // An array of RuleSummary () objects. - Rules []*types.RuleSummary - // If you have more Rules than the number that you specified for Limit in the // request, the response includes a NextMarker value. To list more Rules, submit // another ListRules request, and specify the NextMarker value from the response in // the NextMarker value in the next request. NextMarker *string + // An array of RuleSummary () objects. + Rules []*types.RuleSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/waf/api_op_ListSizeConstraintSets.go b/service/waf/api_op_ListSizeConstraintSets.go index 63976643f99..1ded74d4075 100644 --- a/service/waf/api_op_ListSizeConstraintSets.go +++ b/service/waf/api_op_ListSizeConstraintSets.go @@ -62,25 +62,22 @@ func (c *Client) ListSizeConstraintSets(ctx context.Context, params *ListSizeCon type ListSizeConstraintSetsInput struct { + // Specifies the number of SizeConstraintSet objects that you want AWS WAF to + // return for this request. If you have more SizeConstraintSets objects than the + // number you specify for Limit, the response includes a NextMarker value that you + // can use to get another batch of SizeConstraintSet objects. + Limit *int32 + // If you specify a value for Limit and you have more SizeConstraintSets than the // value of Limit, AWS WAF returns a NextMarker value in the response that allows // you to list another group of SizeConstraintSets. For the second and subsequent // ListSizeConstraintSets requests, specify the value of NextMarker from the // previous response to get information about another batch of SizeConstraintSets. NextMarker *string - - // Specifies the number of SizeConstraintSet objects that you want AWS WAF to - // return for this request. If you have more SizeConstraintSets objects than the - // number you specify for Limit, the response includes a NextMarker value that you - // can use to get another batch of SizeConstraintSet objects. - Limit *int32 } type ListSizeConstraintSetsOutput struct { - // An array of SizeConstraintSetSummary () objects. - SizeConstraintSets []*types.SizeConstraintSetSummary - // If you have more SizeConstraintSet objects than the number that you specified // for Limit in the request, the response includes a NextMarker value. To list more // SizeConstraintSet objects, submit another ListSizeConstraintSets request, and @@ -88,6 +85,9 @@ type ListSizeConstraintSetsOutput struct { // next request. NextMarker *string + // An array of SizeConstraintSetSummary () objects. + SizeConstraintSets []*types.SizeConstraintSetSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/waf/api_op_ListSqlInjectionMatchSets.go b/service/waf/api_op_ListSqlInjectionMatchSets.go index a7e1db0c7b2..0d46e642b48 100644 --- a/service/waf/api_op_ListSqlInjectionMatchSets.go +++ b/service/waf/api_op_ListSqlInjectionMatchSets.go @@ -64,6 +64,12 @@ func (c *Client) ListSqlInjectionMatchSets(ctx context.Context, params *ListSqlI // account. type ListSqlInjectionMatchSetsInput struct { + // Specifies the number of SqlInjectionMatchSet () objects that you want AWS WAF to + // return for this request. If you have more SqlInjectionMatchSet objects than the + // number you specify for Limit, the response includes a NextMarker value that you + // can use to get another batch of Rules. + Limit *int32 + // If you specify a value for Limit and you have more SqlInjectionMatchSet () // objects than the value of Limit, AWS WAF returns a NextMarker value in the // response that allows you to list another group of SqlInjectionMatchSets. For the @@ -71,20 +77,11 @@ type ListSqlInjectionMatchSetsInput struct { // NextMarker from the previous response to get information about another batch of // SqlInjectionMatchSets. NextMarker *string - - // Specifies the number of SqlInjectionMatchSet () objects that you want AWS WAF to - // return for this request. If you have more SqlInjectionMatchSet objects than the - // number you specify for Limit, the response includes a NextMarker value that you - // can use to get another batch of Rules. - Limit *int32 } // The response to a ListSqlInjectionMatchSets () request. type ListSqlInjectionMatchSetsOutput struct { - // An array of SqlInjectionMatchSetSummary () objects. - SqlInjectionMatchSets []*types.SqlInjectionMatchSetSummary - // If you have more SqlInjectionMatchSet () objects than the number that you // specified for Limit in the request, the response includes a NextMarker value. To // list more SqlInjectionMatchSet objects, submit another ListSqlInjectionMatchSets @@ -92,6 +89,9 @@ type ListSqlInjectionMatchSetsOutput struct { // value in the next request. NextMarker *string + // An array of SqlInjectionMatchSetSummary () objects. + SqlInjectionMatchSets []*types.SqlInjectionMatchSetSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/waf/api_op_ListTagsForResource.go b/service/waf/api_op_ListTagsForResource.go index 25b4995808f..fbe1e012e40 100644 --- a/service/waf/api_op_ListTagsForResource.go +++ b/service/waf/api_op_ListTagsForResource.go @@ -70,9 +70,6 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // - NextMarker *string - // // // This member is required. @@ -80,15 +77,18 @@ type ListTagsForResourceInput struct { // Limit *int32 + + // + NextMarker *string } type ListTagsForResourceOutput struct { // - TagInfoForResource *types.TagInfoForResource + NextMarker *string // - NextMarker *string + TagInfoForResource *types.TagInfoForResource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/waf/api_op_ListWebACLs.go b/service/waf/api_op_ListWebACLs.go index f5ac128f1bf..0eef53cf078 100644 --- a/service/waf/api_op_ListWebACLs.go +++ b/service/waf/api_op_ListWebACLs.go @@ -78,15 +78,15 @@ type ListWebACLsInput struct { type ListWebACLsOutput struct { - // An array of WebACLSummary () objects. - WebACLs []*types.WebACLSummary - // If you have more WebACL objects than the number that you specified for Limit in // the request, the response includes a NextMarker value. To list more WebACL // objects, submit another ListWebACLs request, and specify the NextMarker value // from the response in the NextMarker value in the next request. NextMarker *string + // An array of WebACLSummary () objects. + WebACLs []*types.WebACLSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/waf/api_op_ListXssMatchSets.go b/service/waf/api_op_ListXssMatchSets.go index d4e3cbcff8e..da6c93aed4b 100644 --- a/service/waf/api_op_ListXssMatchSets.go +++ b/service/waf/api_op_ListXssMatchSets.go @@ -63,18 +63,18 @@ func (c *Client) ListXssMatchSets(ctx context.Context, params *ListXssMatchSetsI // A request to list the XssMatchSet () objects created by the current AWS account. type ListXssMatchSetsInput struct { + // Specifies the number of XssMatchSet () objects that you want AWS WAF to return + // for this request. If you have more XssMatchSet objects than the number you + // specify for Limit, the response includes a NextMarker value that you can use to + // get another batch of Rules. + Limit *int32 + // If you specify a value for Limit and you have more XssMatchSet () objects than // the value of Limit, AWS WAF returns a NextMarker value in the response that // allows you to list another group of XssMatchSets. For the second and subsequent // ListXssMatchSets requests, specify the value of NextMarker from the previous // response to get information about another batch of XssMatchSets. NextMarker *string - - // Specifies the number of XssMatchSet () objects that you want AWS WAF to return - // for this request. If you have more XssMatchSet objects than the number you - // specify for Limit, the response includes a NextMarker value that you can use to - // get another batch of Rules. - Limit *int32 } // The response to a ListXssMatchSets () request. diff --git a/service/waf/api_op_TagResource.go b/service/waf/api_op_TagResource.go index 15be389ad81..b39abace123 100644 --- a/service/waf/api_op_TagResource.go +++ b/service/waf/api_op_TagResource.go @@ -73,12 +73,12 @@ type TagResourceInput struct { // // // This member is required. - Tags []*types.Tag + ResourceARN *string // // // This member is required. - ResourceARN *string + Tags []*types.Tag } type TagResourceOutput struct { diff --git a/service/waf/api_op_UntagResource.go b/service/waf/api_op_UntagResource.go index d201b882ae2..e7f270631e7 100644 --- a/service/waf/api_op_UntagResource.go +++ b/service/waf/api_op_UntagResource.go @@ -65,12 +65,12 @@ type UntagResourceInput struct { // // // This member is required. - TagKeys []*string + ResourceARN *string // // // This member is required. - ResourceARN *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/waf/api_op_UpdateByteMatchSet.go b/service/waf/api_op_UpdateByteMatchSet.go index 14fb3af7abe..e344948869d 100644 --- a/service/waf/api_op_UpdateByteMatchSet.go +++ b/service/waf/api_op_UpdateByteMatchSet.go @@ -106,6 +106,17 @@ func (c *Client) UpdateByteMatchSet(ctx context.Context, params *UpdateByteMatch type UpdateByteMatchSetInput struct { + // The ByteMatchSetId of the ByteMatchSet () that you want to update. + // ByteMatchSetId is returned by CreateByteMatchSet () and by ListByteMatchSets (). + // + // This member is required. + ByteMatchSetId *string + + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + // An array of ByteMatchSetUpdate objects that you want to insert into or delete // from a ByteMatchSet (). For more information, see the applicable data types: // @@ -120,17 +131,6 @@ type UpdateByteMatchSetInput struct { // // This member is required. Updates []*types.ByteMatchSetUpdate - - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string - - // The ByteMatchSetId of the ByteMatchSet () that you want to update. - // ByteMatchSetId is returned by CreateByteMatchSet () and by ListByteMatchSets (). - // - // This member is required. - ByteMatchSetId *string } type UpdateByteMatchSetOutput struct { diff --git a/service/waf/api_op_UpdateGeoMatchSet.go b/service/waf/api_op_UpdateGeoMatchSet.go index ac066f97595..85c3d3a3967 100644 --- a/service/waf/api_op_UpdateGeoMatchSet.go +++ b/service/waf/api_op_UpdateGeoMatchSet.go @@ -89,6 +89,17 @@ func (c *Client) UpdateGeoMatchSet(ctx context.Context, params *UpdateGeoMatchSe type UpdateGeoMatchSetInput struct { + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + + // The GeoMatchSetId of the GeoMatchSet () that you want to update. GeoMatchSetId + // is returned by CreateGeoMatchSet () and by ListGeoMatchSets (). + // + // This member is required. + GeoMatchSetId *string + // An array of GeoMatchSetUpdate objects that you want to insert into or delete // from an GeoMatchSet (). For more information, see the applicable data types: // @@ -102,17 +113,6 @@ type UpdateGeoMatchSetInput struct { // // This member is required. Updates []*types.GeoMatchSetUpdate - - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string - - // The GeoMatchSetId of the GeoMatchSet () that you want to update. GeoMatchSetId - // is returned by CreateGeoMatchSet () and by ListGeoMatchSets (). - // - // This member is required. - GeoMatchSetId *string } type UpdateGeoMatchSetOutput struct { diff --git a/service/waf/api_op_UpdateIPSet.go b/service/waf/api_op_UpdateIPSet.go index d033e59ef36..e3e366cdf82 100644 --- a/service/waf/api_op_UpdateIPSet.go +++ b/service/waf/api_op_UpdateIPSet.go @@ -117,6 +117,11 @@ func (c *Client) UpdateIPSet(ctx context.Context, params *UpdateIPSetInput, optF type UpdateIPSetInput struct { + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + // The IPSetId of the IPSet () that you want to update. IPSetId is returned by // CreateIPSet () and by ListIPSets (). // @@ -137,11 +142,6 @@ type UpdateIPSetInput struct { // // This member is required. Updates []*types.IPSetUpdate - - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string } type UpdateIPSetOutput struct { diff --git a/service/waf/api_op_UpdateRateBasedRule.go b/service/waf/api_op_UpdateRateBasedRule.go index 89382d219f6..4ca65626f73 100644 --- a/service/waf/api_op_UpdateRateBasedRule.go +++ b/service/waf/api_op_UpdateRateBasedRule.go @@ -92,6 +92,11 @@ func (c *Client) UpdateRateBasedRule(ctx context.Context, params *UpdateRateBase type UpdateRateBasedRuleInput struct { + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + // The maximum number of requests, which have an identical value in the field // specified by the RateKey, allowed in a five-minute period. If the number of // requests exceeds the RateLimit and the other predicates specified in the rule @@ -100,11 +105,6 @@ type UpdateRateBasedRuleInput struct { // This member is required. RateLimit *int64 - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string - // The RuleId of the RateBasedRule that you want to update. RuleId is returned by // CreateRateBasedRule and by ListRateBasedRules (). // diff --git a/service/waf/api_op_UpdateRegexMatchSet.go b/service/waf/api_op_UpdateRegexMatchSet.go index 93dbe1f2381..74091021ac9 100644 --- a/service/waf/api_op_UpdateRegexMatchSet.go +++ b/service/waf/api_op_UpdateRegexMatchSet.go @@ -102,6 +102,11 @@ func (c *Client) UpdateRegexMatchSet(ctx context.Context, params *UpdateRegexMat type UpdateRegexMatchSetInput struct { + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + // The RegexMatchSetId of the RegexMatchSet () that you want to update. // RegexMatchSetId is returned by CreateRegexMatchSet () and by ListRegexMatchSets // (). @@ -114,11 +119,6 @@ type UpdateRegexMatchSetInput struct { // // This member is required. Updates []*types.RegexMatchSetUpdate - - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string } type UpdateRegexMatchSetOutput struct { diff --git a/service/waf/api_op_UpdateRegexPatternSet.go b/service/waf/api_op_UpdateRegexPatternSet.go index 73a242b27de..77db3205322 100644 --- a/service/waf/api_op_UpdateRegexPatternSet.go +++ b/service/waf/api_op_UpdateRegexPatternSet.go @@ -101,11 +101,10 @@ func (c *Client) UpdateRegexPatternSet(ctx context.Context, params *UpdateRegexP type UpdateRegexPatternSetInput struct { - // An array of RegexPatternSetUpdate objects that you want to insert into or delete - // from a RegexPatternSet (). + // The value returned by the most recent call to GetChangeToken (). // // This member is required. - Updates []*types.RegexPatternSetUpdate + ChangeToken *string // The RegexPatternSetId of the RegexPatternSet () that you want to update. // RegexPatternSetId is returned by CreateRegexPatternSet () and by @@ -114,10 +113,11 @@ type UpdateRegexPatternSetInput struct { // This member is required. RegexPatternSetId *string - // The value returned by the most recent call to GetChangeToken (). + // An array of RegexPatternSetUpdate objects that you want to insert into or delete + // from a RegexPatternSet (). // // This member is required. - ChangeToken *string + Updates []*types.RegexPatternSetUpdate } type UpdateRegexPatternSetOutput struct { diff --git a/service/waf/api_op_UpdateRule.go b/service/waf/api_op_UpdateRule.go index 71570966e8b..ea509e7a34a 100644 --- a/service/waf/api_op_UpdateRule.go +++ b/service/waf/api_op_UpdateRule.go @@ -101,6 +101,17 @@ func (c *Client) UpdateRule(ctx context.Context, params *UpdateRuleInput, optFns type UpdateRuleInput struct { + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + + // The RuleId of the Rule that you want to update. RuleId is returned by CreateRule + // and by ListRules (). + // + // This member is required. + RuleId *string + // An array of RuleUpdate objects that you want to insert into or delete from a // Rule (). For more information, see the applicable data types: // @@ -114,17 +125,6 @@ type UpdateRuleInput struct { // // This member is required. Updates []*types.RuleUpdate - - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string - - // The RuleId of the Rule that you want to update. RuleId is returned by CreateRule - // and by ListRules (). - // - // This member is required. - RuleId *string } type UpdateRuleOutput struct { diff --git a/service/waf/api_op_UpdateRuleGroup.go b/service/waf/api_op_UpdateRuleGroup.go index 2550e2b913b..f8f1f227bda 100644 --- a/service/waf/api_op_UpdateRuleGroup.go +++ b/service/waf/api_op_UpdateRuleGroup.go @@ -79,14 +79,10 @@ func (c *Client) UpdateRuleGroup(ctx context.Context, params *UpdateRuleGroupInp type UpdateRuleGroupInput struct { - // An array of RuleGroupUpdate objects that you want to insert into or delete from - // a RuleGroup (). You can only insert REGULAR rules into a rule group. - // ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to - // a WebACL. In this case you do not use ActivatedRule|Action. For all other update - // requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. + // The value returned by the most recent call to GetChangeToken (). // // This member is required. - Updates []*types.RuleGroupUpdate + ChangeToken *string // The RuleGroupId of the RuleGroup () that you want to update. RuleGroupId is // returned by CreateRuleGroup () and by ListRuleGroups (). @@ -94,10 +90,14 @@ type UpdateRuleGroupInput struct { // This member is required. RuleGroupId *string - // The value returned by the most recent call to GetChangeToken (). + // An array of RuleGroupUpdate objects that you want to insert into or delete from + // a RuleGroup (). You can only insert REGULAR rules into a rule group. + // ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to + // a WebACL. In this case you do not use ActivatedRule|Action. For all other update + // requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. // // This member is required. - ChangeToken *string + Updates []*types.RuleGroupUpdate } type UpdateRuleGroupOutput struct { diff --git a/service/waf/api_op_UpdateSizeConstraintSet.go b/service/waf/api_op_UpdateSizeConstraintSet.go index 241679310e9..f91d822a61c 100644 --- a/service/waf/api_op_UpdateSizeConstraintSet.go +++ b/service/waf/api_op_UpdateSizeConstraintSet.go @@ -109,6 +109,11 @@ func (c *Client) UpdateSizeConstraintSet(ctx context.Context, params *UpdateSize type UpdateSizeConstraintSetInput struct { + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + // The SizeConstraintSetId of the SizeConstraintSet () that you want to update. // SizeConstraintSetId is returned by CreateSizeConstraintSet () and by // ListSizeConstraintSets (). @@ -131,11 +136,6 @@ type UpdateSizeConstraintSetInput struct { // // This member is required. Updates []*types.SizeConstraintSetUpdate - - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string } type UpdateSizeConstraintSetOutput struct { diff --git a/service/waf/api_op_UpdateSqlInjectionMatchSet.go b/service/waf/api_op_UpdateSqlInjectionMatchSet.go index 883e9e89825..32ef1c93041 100644 --- a/service/waf/api_op_UpdateSqlInjectionMatchSet.go +++ b/service/waf/api_op_UpdateSqlInjectionMatchSet.go @@ -102,6 +102,11 @@ func (c *Client) UpdateSqlInjectionMatchSet(ctx context.Context, params *UpdateS // A request to update a SqlInjectionMatchSet (). type UpdateSqlInjectionMatchSetInput struct { + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + // The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to update. // SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet () and by // ListSqlInjectionMatchSets (). @@ -123,11 +128,6 @@ type UpdateSqlInjectionMatchSetInput struct { // // This member is required. Updates []*types.SqlInjectionMatchSetUpdate - - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string } // The response to an UpdateSqlInjectionMatchSets () request. diff --git a/service/waf/api_op_UpdateWebACL.go b/service/waf/api_op_UpdateWebACL.go index 1a42e6621be..bd200af89d4 100644 --- a/service/waf/api_op_UpdateWebACL.go +++ b/service/waf/api_op_UpdateWebACL.go @@ -115,6 +115,11 @@ func (c *Client) UpdateWebACL(ctx context.Context, params *UpdateWebACLInput, op type UpdateWebACLInput struct { + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + // The WebACLId of the WebACL () that you want to update. WebACLId is returned by // CreateWebACL () and by ListWebACLs (). // @@ -141,11 +146,6 @@ type UpdateWebACLInput struct { // // * WafAction (): Contains Type Updates []*types.WebACLUpdate - - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string } type UpdateWebACLOutput struct { diff --git a/service/waf/api_op_UpdateXssMatchSet.go b/service/waf/api_op_UpdateXssMatchSet.go index 8f41beefed3..f31893fbeee 100644 --- a/service/waf/api_op_UpdateXssMatchSet.go +++ b/service/waf/api_op_UpdateXssMatchSet.go @@ -101,6 +101,11 @@ func (c *Client) UpdateXssMatchSet(ctx context.Context, params *UpdateXssMatchSe // A request to update an XssMatchSet (). type UpdateXssMatchSetInput struct { + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + // An array of XssMatchSetUpdate objects that you want to insert into or delete // from an XssMatchSet (). For more information, see the applicable data types: // @@ -116,11 +121,6 @@ type UpdateXssMatchSetInput struct { // This member is required. Updates []*types.XssMatchSetUpdate - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string - // The XssMatchSetId of the XssMatchSet that you want to update. XssMatchSetId is // returned by CreateXssMatchSet () and by ListXssMatchSets (). // diff --git a/service/waf/go.mod b/service/waf/go.mod index bcf9a951e68..9ce1e347980 100644 --- a/service/waf/go.mod +++ b/service/waf/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/waf go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/waf/types/types.go b/service/waf/types/types.go index caf3dbf072f..5fddbfd28c1 100644 --- a/service/waf/types/types.go +++ b/service/waf/types/types.go @@ -19,18 +19,41 @@ import ( // Action parameter in the WebACLUpdate () data type. type ActivatedRule struct { - // Use the OverrideAction to test your RuleGroup. Any rule in a RuleGroup can - // potentially block a request. If you set the OverrideAction to None, the - // RuleGroup will block a request if any individual rule in the RuleGroup matches - // the request and is configured to block that request. However if you first want - // to test the RuleGroup, set the OverrideAction to Count. The RuleGroup will then - // override any block action specified by individual rules contained within the - // group. Instead of blocking matching requests, those requests will be counted. - // You can view a record of counted requests using GetSampledRequests (). - // ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to - // a WebACL. In this case you do not use ActivatedRule|Action. For all other update - // requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. - OverrideAction *WafOverrideAction + // Specifies the order in which the Rules in a WebACL are evaluated. Rules with a + // lower value for Priority are evaluated before Rules with a higher value. The + // value must be a unique integer. If you add multiple Rules to a WebACL, the + // values don't need to be consecutive. + // + // This member is required. + Priority *int32 + + // The RuleId for a Rule. You use RuleId to get more information about a Rule (see + // GetRule ()), update a Rule (see UpdateRule ()), insert a Rule into a WebACL or + // delete a one from a WebACL (see UpdateWebACL ()), or delete a Rule from AWS WAF + // (see DeleteRule ()). RuleId is returned by CreateRule () and by ListRules (). + // + // This member is required. + RuleId *string + + // Specifies the action that CloudFront or AWS WAF takes when a web request matches + // the conditions in the Rule. Valid values for Action include the following: + // + // + // * ALLOW: CloudFront responds with the requested object. + // + // * BLOCK: CloudFront + // responds with an HTTP 403 (Forbidden) status code. + // + // * COUNT: AWS WAF + // increments a counter of requests that match the conditions in the rule and then + // continues to inspect the web request based on the remaining rules in the web + // ACL. + // + // ActivatedRule|OverrideAction applies only when updating or adding a + // RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For + // all other update requests, ActivatedRule|Action is used instead of + // ActivatedRule|OverrideAction. + Action *WafAction // An array of rules to exclude from a rule group. This is applicable only when the // ActivatedRule refers to a RuleGroup. Sometimes it is necessary to troubleshoot @@ -68,6 +91,19 @@ type ActivatedRule struct { //
          • ExcludedRules []*ExcludedRule + // Use the OverrideAction to test your RuleGroup. Any rule in a RuleGroup can + // potentially block a request. If you set the OverrideAction to None, the + // RuleGroup will block a request if any individual rule in the RuleGroup matches + // the request and is configured to block that request. However if you first want + // to test the RuleGroup, set the OverrideAction to Count. The RuleGroup will then + // override any block action specified by individual rules contained within the + // group. Instead of blocking matching requests, those requests will be counted. + // You can view a record of counted requests using GetSampledRequests (). + // ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to + // a WebACL. In this case you do not use ActivatedRule|Action. For all other update + // requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. + OverrideAction *WafOverrideAction + // The rule type, either REGULAR, as defined by Rule (), RATE_BASED, as defined by // RateBasedRule (), or GROUP, as defined by RuleGroup (). The default is REGULAR. // Although this field is optional, be aware that if you try to add a RATE_BASED @@ -75,42 +111,6 @@ type ActivatedRule struct { // fail because the request tries to add a REGULAR rule with the specified ID, // which does not exist. Type WafRuleType - - // Specifies the action that CloudFront or AWS WAF takes when a web request matches - // the conditions in the Rule. Valid values for Action include the following: - // - // - // * ALLOW: CloudFront responds with the requested object. - // - // * BLOCK: CloudFront - // responds with an HTTP 403 (Forbidden) status code. - // - // * COUNT: AWS WAF - // increments a counter of requests that match the conditions in the rule and then - // continues to inspect the web request based on the remaining rules in the web - // ACL. - // - // ActivatedRule|OverrideAction applies only when updating or adding a - // RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For - // all other update requests, ActivatedRule|Action is used instead of - // ActivatedRule|OverrideAction. - Action *WafAction - - // Specifies the order in which the Rules in a WebACL are evaluated. Rules with a - // lower value for Priority are evaluated before Rules with a higher value. The - // value must be a unique integer. If you add multiple Rules to a WebACL, the - // values don't need to be consecutive. - // - // This member is required. - Priority *int32 - - // The RuleId for a Rule. You use RuleId to get more information about a Rule (see - // GetRule ()), update a Rule (see UpdateRule ()), insert a Rule into a WebACL or - // delete a one from a WebACL (see UpdateWebACL ()), or delete a Rule from AWS WAF - // (see DeleteRule ()). RuleId is returned by CreateRule () and by ListRules (). - // - // This member is required. - RuleId *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -128,6 +128,16 @@ type ActivatedRule struct { // match the settings in only one ByteMatchTuple to be considered a match. type ByteMatchSet struct { + // The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information + // about a ByteMatchSet (see GetByteMatchSet ()), update a ByteMatchSet (see + // UpdateByteMatchSet ()), insert a ByteMatchSet into a Rule or delete one from a + // Rule (see UpdateRule ()), and delete a ByteMatchSet from AWS WAF (see + // DeleteByteMatchSet ()). ByteMatchSetId is returned by CreateByteMatchSet () and + // by ListByteMatchSets (). + // + // This member is required. + ByteMatchSetId *string + // Specifies the bytes (typically a string that corresponds with ASCII characters) // that you want AWS WAF to search for in web requests, the location in requests // that you want AWS WAF to search, and other settings. @@ -138,16 +148,6 @@ type ByteMatchSet struct { // A friendly name or description of the ByteMatchSet (). You can't change Name // after you create a ByteMatchSet. Name *string - - // The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information - // about a ByteMatchSet (see GetByteMatchSet ()), update a ByteMatchSet (see - // UpdateByteMatchSet ()), insert a ByteMatchSet into a Rule or delete one from a - // Rule (see UpdateRule ()), and delete a ByteMatchSet from AWS WAF (see - // DeleteByteMatchSet ()). ByteMatchSetId is returned by CreateByteMatchSet () and - // by ListByteMatchSets (). - // - // This member is required. - ByteMatchSetId *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -160,12 +160,6 @@ type ByteMatchSet struct { // includes the Name and ByteMatchSetId for one ByteMatchSet (). type ByteMatchSetSummary struct { - // A friendly name or description of the ByteMatchSet (). You can't change Name - // after you create a ByteMatchSet. - // - // This member is required. - Name *string - // The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information // about a ByteMatchSet, update a ByteMatchSet, remove a ByteMatchSet from a Rule, // and delete a ByteMatchSet from AWS WAF. ByteMatchSetId is returned by @@ -173,6 +167,12 @@ type ByteMatchSetSummary struct { // // This member is required. ByteMatchSetId *string + + // A friendly name or description of the ByteMatchSet (). You can't change Name + // after you create a ByteMatchSet. + // + // This member is required. + Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -211,52 +211,46 @@ type ByteMatchSetUpdate struct { // requests that you want AWS WAF to search, and other settings. type ByteMatchTuple struct { - // Text transformations eliminate some of the unusual formatting that attackers use - // in web requests in an effort to bypass AWS WAF. If you specify a transformation, - // AWS WAF performs the transformation on FieldToMatch before inspecting it for a - // match. You can only specify a single type of TextTransformation. CMD_LINE When - // you're concerned that attackers are injecting an operating system command line - // command and using unusual formatting to disguise some or all of the command, use - // this option to perform the following transformations: - // - // * Delete the - // following characters: \ " ' ^ + // The part of a web request that you want AWS WAF to search, such as a specified + // header or a query string. For more information, see FieldToMatch (). // - // * Delete spaces before the following - // characters: / ( + // This member is required. + FieldToMatch *FieldToMatch + + // Within the portion of a web request that you want to search (for example, in the + // query string, if any), specify where you want AWS WAF to search. Valid values + // include the following: CONTAINS The specified part of the web request must + // include the value of TargetString, but the location doesn't matter. + // CONTAINS_WORD The specified part of the web request must include the value of + // TargetString, and TargetString must contain only alphanumeric characters or + // underscore (A-Z, a-z, 0-9, or _). In addition, TargetString must be a word, + // which means one of the following: // - // * Replace the following characters with a space: , ; + // * TargetString exactly matches the value + // of the specified part of the web request, such as the value of a header. // // * - // Replace multiple spaces with one space + // TargetString is at the beginning of the specified part of the web request and is + // followed by a character other than an alphanumeric character or underscore (_), + // for example, BadBot;. // - // * Convert uppercase letters (A-Z) to - // lowercase (a-z) + // * TargetString is at the end of the specified part of + // the web request and is preceded by a character other than an alphanumeric + // character or underscore (_), for example, ;BadBot. // - //

          COMPRESS_WHITE_SPACE

          Use this option to - // replace the following characters with a space character (decimal 32):

            - //

          • \f, formfeed, decimal 12

          • \t, tab, decimal 9

            • - //

          • \n, newline, decimal 10

          • \r, carriage return, decimal - // 13

          • \v, vertical tab, decimal 11

          • non-breaking - // space, decimal 160

          COMPRESS_WHITE_SPACE also - // replaces multiple spaces with one space.

          HTML_ENTITY_DECODE

          - //

          Use this option to replace HTML-encoded characters with unencoded characters. - // HTML_ENTITY_DECODE performs the following operations:

          • - //

            Replaces (ampersand)quot; with "

          • - //

            Replaces (ampersand)nbsp; with a non-breaking space, decimal - // 160

          • Replaces (ampersand)lt; with a "less than" - // symbol

          • Replaces (ampersand)gt; with - // >

          • Replaces characters that are represented in - // hexadecimal format, (ampersand)#xhhhh;, with the corresponding - // characters

          • Replaces characters that are represented in decimal - // format, (ampersand)#nnnn;, with the corresponding characters

            - //

          LOWERCASE

          Use this option to convert uppercase - // letters (A-Z) to lowercase (a-z).

          URL_DECODE

          Use this - // option to decode a URL-encoded value.

          NONE

          Specify - // NONE if you don't want to perform any text transformations.

          + // * TargetString is in the + // middle of the specified part of the web request and is preceded and followed by + // characters other than alphanumeric characters or underscore (_), for example, + // -BadBot;. + // + // EXACTLY The value of the specified part of the web request must + // exactly match the value of TargetString. STARTS_WITH The value of TargetString + // must appear at the beginning of the specified part of the web request. ENDS_WITH + // The value of TargetString must appear at the end of the specified part of the + // web request. // // This member is required. - TextTransformation TextTransformation + PositionalConstraint PositionalConstraint // The value that you want AWS WAF to search for. AWS WAF searches for the // specified string in the part of web requests that you specified in FieldToMatch. @@ -313,46 +307,52 @@ type ByteMatchTuple struct { // This member is required. TargetString []byte - // The part of a web request that you want AWS WAF to search, such as a specified - // header or a query string. For more information, see FieldToMatch (). + // Text transformations eliminate some of the unusual formatting that attackers use + // in web requests in an effort to bypass AWS WAF. If you specify a transformation, + // AWS WAF performs the transformation on FieldToMatch before inspecting it for a + // match. You can only specify a single type of TextTransformation. CMD_LINE When + // you're concerned that attackers are injecting an operating system command line + // command and using unusual formatting to disguise some or all of the command, use + // this option to perform the following transformations: // - // This member is required. - FieldToMatch *FieldToMatch - - // Within the portion of a web request that you want to search (for example, in the - // query string, if any), specify where you want AWS WAF to search. Valid values - // include the following: CONTAINS The specified part of the web request must - // include the value of TargetString, but the location doesn't matter. - // CONTAINS_WORD The specified part of the web request must include the value of - // TargetString, and TargetString must contain only alphanumeric characters or - // underscore (A-Z, a-z, 0-9, or _). In addition, TargetString must be a word, - // which means one of the following: + // * Delete the + // following characters: \ " ' ^ // - // * TargetString exactly matches the value - // of the specified part of the web request, such as the value of a header. + // * Delete spaces before the following + // characters: / ( // - // * - // TargetString is at the beginning of the specified part of the web request and is - // followed by a character other than an alphanumeric character or underscore (_), - // for example, BadBot;. + // * Replace the following characters with a space: , ; // - // * TargetString is at the end of the specified part of - // the web request and is preceded by a character other than an alphanumeric - // character or underscore (_), for example, ;BadBot. + // * + // Replace multiple spaces with one space // - // * TargetString is in the - // middle of the specified part of the web request and is preceded and followed by - // characters other than alphanumeric characters or underscore (_), for example, - // -BadBot;. + // * Convert uppercase letters (A-Z) to + // lowercase (a-z) // - // EXACTLY The value of the specified part of the web request must - // exactly match the value of TargetString. STARTS_WITH The value of TargetString - // must appear at the beginning of the specified part of the web request. ENDS_WITH - // The value of TargetString must appear at the end of the specified part of the - // web request. + //

          COMPRESS_WHITE_SPACE

          Use this option to + // replace the following characters with a space character (decimal 32):

            + //

          • \f, formfeed, decimal 12

          • \t, tab, decimal 9

            • + //

          • \n, newline, decimal 10

          • \r, carriage return, decimal + // 13

          • \v, vertical tab, decimal 11

          • non-breaking + // space, decimal 160

          COMPRESS_WHITE_SPACE also + // replaces multiple spaces with one space.

          HTML_ENTITY_DECODE

          + //

          Use this option to replace HTML-encoded characters with unencoded characters. + // HTML_ENTITY_DECODE performs the following operations:

          • + //

            Replaces (ampersand)quot; with "

          • + //

            Replaces (ampersand)nbsp; with a non-breaking space, decimal + // 160

          • Replaces (ampersand)lt; with a "less than" + // symbol

          • Replaces (ampersand)gt; with + // >

          • Replaces characters that are represented in + // hexadecimal format, (ampersand)#xhhhh;, with the corresponding + // characters

          • Replaces characters that are represented in decimal + // format, (ampersand)#nnnn;, with the corresponding characters

            + //

          LOWERCASE

          Use this option to convert uppercase + // letters (A-Z) to lowercase (a-z).

          URL_DECODE

          Use this + // option to decode a URL-encoded value.

          NONE

          Specify + // NONE if you don't want to perform any text transformations.

          // // This member is required. - PositionalConstraint PositionalConstraint + TextTransformation TextTransformation } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -460,9 +460,11 @@ type GeoMatchConstraint struct { // global use. Contains one or more countries that AWS WAF will search for. type GeoMatchSet struct { - // A friendly name or description of the GeoMatchSet (). You can't change the name - // of an GeoMatchSet after you create it. - Name *string + // An array of GeoMatchConstraint () objects, which contain the country that you + // want AWS WAF to search for. + // + // This member is required. + GeoMatchConstraints []*GeoMatchConstraint // The GeoMatchSetId for an GeoMatchSet. You use GeoMatchSetId to get information // about a GeoMatchSet (see GeoMatchSet ()), update a GeoMatchSet (see @@ -474,11 +476,9 @@ type GeoMatchSet struct { // This member is required. GeoMatchSetId *string - // An array of GeoMatchConstraint () objects, which contain the country that you - // want AWS WAF to search for. - // - // This member is required. - GeoMatchConstraints []*GeoMatchConstraint + // A friendly name or description of the GeoMatchSet (). You can't change the name + // of an GeoMatchSet after you create it. + Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -556,11 +556,25 @@ type HTTPHeader struct { // returned by GetSampledRequests. type HTTPRequest struct { + // The IP address that the request originated from. If the WebACL is associated + // with a CloudFront distribution, this is the value of one of the following fields + // in CloudFront access logs: + // + // * c-ip, if the viewer did not use an HTTP proxy + // or a load balancer to send the request + // + // * x-forwarded-for, if the viewer did + // use an HTTP proxy or a load balancer to send the request + ClientIP *string + // The two-letter country code for the country that the request originated from. // For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2 // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Country *string + // The HTTP version specified in the sampled web request, for example, HTTP/1.1. + HTTPVersion *string + // A complex type that contains two values for each header in the sampled web // request: the name of the header and the value of the header. Headers []*HTTPHeader @@ -569,20 +583,6 @@ type HTTPRequest struct { // following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. Method *string - // The HTTP version specified in the sampled web request, for example, HTTP/1.1. - HTTPVersion *string - - // The IP address that the request originated from. If the WebACL is associated - // with a CloudFront distribution, this is the value of one of the following fields - // in CloudFront access logs: - // - // * c-ip, if the viewer did not use an HTTP proxy - // or a load balancer to send the request - // - // * x-forwarded-for, if the viewer did - // use an HTTP proxy or a load balancer to send the request - ClientIP *string - // The part of a web request that identifies the resource, for example, // /images/daily-ad.jpg. URI *string @@ -638,6 +638,11 @@ type IPSet struct { // range (in CIDR format) that web requests originate from. type IPSetDescriptor struct { + // Specify IPV4 or IPV6. + // + // This member is required. + Type IPSetDescriptorType + // Specify an IPv4 address by using CIDR notation. For example: // // * To configure @@ -663,11 +668,6 @@ type IPSetDescriptor struct { // // This member is required. Value *string - - // Specify IPV4 or IPV6. - // - // This member is required. - Type IPSetDescriptorType } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -679,17 +679,17 @@ type IPSetDescriptor struct { // global use. Contains the identifier and the name of the IPSet. type IPSetSummary struct { - // A friendly name or description of the IPSet (). You can't change the name of an - // IPSet after you create it. - // - // This member is required. - Name *string - // The IPSetId for an IPSet (). You can use IPSetId in a GetIPSet () request to get // detailed information about an IPSet (). // // This member is required. IPSetId *string + + // A friendly name or description of the IPSet (). You can't change the name of an + // IPSet after you create it. + // + // This member is required. + Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -702,16 +702,16 @@ type IPSetSummary struct { // UpdateIPSet (). type IPSetUpdate struct { - // The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) - // that web requests originate from. + // Specifies whether to insert or delete an IP address with UpdateIPSet (). // // This member is required. - IPSetDescriptor *IPSetDescriptor + Action ChangeAction - // Specifies whether to insert or delete an IP address with UpdateIPSet (). + // The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) + // that web requests originate from. // // This member is required. - Action ChangeAction + IPSetDescriptor *IPSetDescriptor } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -724,9 +724,10 @@ type IPSetUpdate struct { // the web ACL Amazon Resource Name (ARN). type LoggingConfiguration struct { - // The parts of the request that you want redacted from the logs. For example, if - // you redact the cookie field, the cookie field in the firehose will be xxx. - RedactedFields []*FieldToMatch + // An array of Amazon Kinesis Data Firehose ARNs. + // + // This member is required. + LogDestinationConfigs []*string // The Amazon Resource Name (ARN) of the web ACL that you want to associate with // LogDestinationConfigs. @@ -734,10 +735,9 @@ type LoggingConfiguration struct { // This member is required. ResourceArn *string - // An array of Amazon Kinesis Data Firehose ARNs. - // - // This member is required. - LogDestinationConfigs []*string + // The parts of the request that you want redacted from the logs. For example, if + // you redact the cookie field, the cookie field in the firehose will be xxx. + RedactedFields []*FieldToMatch } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -753,10 +753,11 @@ type LoggingConfiguration struct { // from the IP address 192.0.2.44. type Predicate struct { - // The type of predicate in a Rule, such as ByteMatch or IPSet. + // A unique identifier for a predicate in a Rule, such as ByteMatchSetId or + // IPSetId. The ID is returned by the corresponding Create or List command. // // This member is required. - Type PredicateType + DataId *string // Set Negated to False if you want AWS WAF to allow, block, or count requests // based on the settings in the specified ByteMatchSet (), IPSet (), @@ -772,11 +773,10 @@ type Predicate struct { // This member is required. Negated *bool - // A unique identifier for a predicate in a Rule, such as ByteMatchSetId or - // IPSetId. The ID is returned by the corresponding Create or List command. + // The type of predicate in a Rule, such as ByteMatch or IPSet. // // This member is required. - DataId *string + Type PredicateType } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -802,12 +802,20 @@ type Predicate struct { // count), which is defined in the web ACL. type RateBasedRule struct { - // A friendly name or description for the metrics for a RateBasedRule. The name can - // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 - // and minimum length one. It can't contain whitespace or metric names reserved for - // AWS WAF, including "All" and "Default_Action." You can't change the name of the - // metric after you create the RateBasedRule. - MetricName *string + // The Predicates object contains one Predicate element for each ByteMatchSet (), + // IPSet (), or SqlInjectionMatchSet () object that you want to include in a + // RateBasedRule. + // + // This member is required. + MatchPredicates []*Predicate + + // The field that AWS WAF uses to determine if requests are likely arriving from + // single source and thus subject to rate monitoring. The only valid value for + // RateKey is IP. IP indicates that requests arriving from the same IP address are + // subject to the RateLimit that is specified in the RateBasedRule. + // + // This member is required. + RateKey RateKey // The maximum number of requests, which have an identical value in the field // specified by the RateKey, allowed in a five-minute period. If the number of @@ -817,13 +825,6 @@ type RateBasedRule struct { // This member is required. RateLimit *int64 - // The Predicates object contains one Predicate element for each ByteMatchSet (), - // IPSet (), or SqlInjectionMatchSet () object that you want to include in a - // RateBasedRule. - // - // This member is required. - MatchPredicates []*Predicate - // A unique identifier for a RateBasedRule. You use RuleId to get more information // about a RateBasedRule (see GetRateBasedRule ()), update a RateBasedRule (see // UpdateRateBasedRule ()), insert a RateBasedRule into a WebACL or delete one from @@ -833,13 +834,12 @@ type RateBasedRule struct { // This member is required. RuleId *string - // The field that AWS WAF uses to determine if requests are likely arriving from - // single source and thus subject to rate monitoring. The only valid value for - // RateKey is IP. IP indicates that requests arriving from the same IP address are - // subject to the RateLimit that is specified in the RateBasedRule. - // - // This member is required. - RateKey RateKey + // A friendly name or description for the metrics for a RateBasedRule. The name can + // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 + // and minimum length one. It can't contain whitespace or metric names reserved for + // AWS WAF, including "All" and "Default_Action." You can't change the name of the + // metric after you create the RateBasedRule. + MetricName *string // A friendly name or description for a RateBasedRule. You can't change the name of // a RateBasedRule after you create it. @@ -926,6 +926,11 @@ type RegexMatchSetSummary struct { // the RegexMatchTuple. type RegexMatchSetUpdate struct { + // Specifies whether to insert or delete a RegexMatchTuple (). + // + // This member is required. + Action ChangeAction + // Information about the part of a web request that you want AWS WAF to inspect and // the identifier of the regular expression (regex) pattern that you want AWS WAF // to search for. If you specify DELETE for the value of Action, the @@ -934,11 +939,6 @@ type RegexMatchSetUpdate struct { // // This member is required. RegexMatchTuple *RegexMatchTuple - - // Specifies whether to insert or delete a RegexMatchTuple (). - // - // This member is required. - Action ChangeAction } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -964,6 +964,22 @@ type RegexMatchSetUpdate struct { // string. type RegexMatchTuple struct { + // Specifies where in a web request to look for the RegexPatternSet. + // + // This member is required. + FieldToMatch *FieldToMatch + + // The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get + // information about a RegexPatternSet (see GetRegexPatternSet ()), update a + // RegexPatternSet (see UpdateRegexPatternSet ()), insert a RegexPatternSet into a + // RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet ()), + // and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet ()). + // RegexPatternSetId is returned by CreateRegexPatternSet () and by + // ListRegexPatternSets (). + // + // This member is required. + RegexPatternSetId *string + // Text transformations eliminate some of the unusual formatting that attackers use // in web requests in an effort to bypass AWS WAF. If you specify a transformation, // AWS WAF performs the transformation on RegexPatternSet before inspecting a @@ -1010,22 +1026,6 @@ type RegexMatchTuple struct { // // This member is required. TextTransformation TextTransformation - - // The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get - // information about a RegexPatternSet (see GetRegexPatternSet ()), update a - // RegexPatternSet (see UpdateRegexPatternSet ()), insert a RegexPatternSet into a - // RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet ()), - // and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet ()). - // RegexPatternSetId is returned by CreateRegexPatternSet () and by - // ListRegexPatternSets (). - // - // This member is required. - RegexPatternSetId *string - - // Specifies where in a web request to look for the RegexPatternSet. - // - // This member is required. - FieldToMatch *FieldToMatch } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1039,6 +1039,15 @@ type RegexMatchTuple struct { // configure AWS WAF to reject those requests. type RegexPatternSet struct { + // The identifier for the RegexPatternSet. You use RegexPatternSetId to get + // information about a RegexPatternSet, update a RegexPatternSet, remove a + // RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF. + // RegexMatchSetId is returned by CreateRegexPatternSet () and by + // ListRegexPatternSets (). + // + // This member is required. + RegexPatternSetId *string + // Specifies the regular expression (regex) patterns that you want AWS WAF to // search for, such as B[a@]dB[o0]t. // @@ -1048,15 +1057,6 @@ type RegexPatternSet struct { // A friendly name or description of the RegexPatternSet (). You can't change Name // after you create a RegexPatternSet. Name *string - - // The identifier for the RegexPatternSet. You use RegexPatternSetId to get - // information about a RegexPatternSet, update a RegexPatternSet, remove a - // RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF. - // RegexMatchSetId is returned by CreateRegexPatternSet () and by - // ListRegexPatternSets (). - // - // This member is required. - RegexPatternSetId *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1069,6 +1069,12 @@ type RegexPatternSet struct { // object includes the Name and RegexPatternSetId for one RegexPatternSet (). type RegexPatternSetSummary struct { + // A friendly name or description of the RegexPatternSet (). You can't change Name + // after you create a RegexPatternSet. + // + // This member is required. + Name *string + // The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get // information about a RegexPatternSet, update a RegexPatternSet, remove a // RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF. @@ -1077,12 +1083,6 @@ type RegexPatternSetSummary struct { // // This member is required. RegexPatternSetId *string - - // A friendly name or description of the RegexPatternSet (). You can't change Name - // after you create a RegexPatternSet. - // - // This member is required. - Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1146,16 +1146,16 @@ type Rule struct { // This member is required. RuleId *string - // The friendly name or description for the Rule. You can't change the name of a - // Rule after you create it. - Name *string - // A friendly name or description for the metrics for this Rule. The name can // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 // and minimum length one. It can't contain whitespace or metric names reserved for // AWS WAF, including "All" and "Default_Action." You can't change MetricName after // you create the Rule. MetricName *string + + // The friendly name or description for the Rule. You can't change the name of a + // Rule after you create it. + Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1172,20 +1172,9 @@ type Rule struct { // support. // // * One rule group per web ACL. -// -// * Ten rules per rule group. -type RuleGroup struct { - - // The friendly name or description for the RuleGroup. You can't change the name of - // a RuleGroup after you create it. - Name *string - - // A friendly name or description for the metrics for this RuleGroup. The name can - // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 - // and minimum length one. It can't contain whitespace or metric names reserved for - // AWS WAF, including "All" and "Default_Action." You can't change the name of the - // metric after you create the RuleGroup. - MetricName *string +// +// * Ten rules per rule group. +type RuleGroup struct { // A unique identifier for a RuleGroup. You use RuleGroupId to get more information // about a RuleGroup (see GetRuleGroup ()), update a RuleGroup (see UpdateRuleGroup @@ -1195,6 +1184,17 @@ type RuleGroup struct { // // This member is required. RuleGroupId *string + + // A friendly name or description for the metrics for this RuleGroup. The name can + // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 + // and minimum length one. It can't contain whitespace or metric names reserved for + // AWS WAF, including "All" and "Default_Action." You can't change the name of the + // metric after you create the RuleGroup. + MetricName *string + + // The friendly name or description for the RuleGroup. You can't change the name of + // a RuleGroup after you create it. + Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1207,6 +1207,12 @@ type RuleGroup struct { // RuleGroup. type RuleGroupSummary struct { + // A friendly name or description of the RuleGroup (). You can't change the name of + // a RuleGroup after you create it. + // + // This member is required. + Name *string + // A unique identifier for a RuleGroup. You use RuleGroupId to get more information // about a RuleGroup (see GetRuleGroup ()), update a RuleGroup (see UpdateRuleGroup // ()), insert a RuleGroup into a WebACL or delete one from a WebACL (see @@ -1215,12 +1221,6 @@ type RuleGroupSummary struct { // // This member is required. RuleGroupId *string - - // A friendly name or description of the RuleGroup (). You can't change the name of - // a RuleGroup after you create it. - // - // This member is required. - Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1257,6 +1257,12 @@ type RuleGroupUpdate struct { // Rule. type RuleSummary struct { + // A friendly name or description of the Rule (). You can't change the name of a + // Rule after you create it. + // + // This member is required. + Name *string + // A unique identifier for a Rule. You use RuleId to get more information about a // Rule (see GetRule ()), update a Rule (see UpdateRule ()), insert a Rule into a // WebACL or delete one from a WebACL (see UpdateWebACL ()), or delete a Rule from @@ -1265,12 +1271,6 @@ type RuleSummary struct { // // This member is required. RuleId *string - - // A friendly name or description of the Rule (). You can't change the name of a - // Rule after you create it. - // - // This member is required. - Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1283,16 +1283,16 @@ type RuleSummary struct { // want to add it to a Rule or delete it from a Rule. type RuleUpdate struct { - // The ID of the Predicate (such as an IPSet) that you want to add to a Rule. - // - // This member is required. - Predicate *Predicate - // Specify INSERT to add a Predicate to a Rule. Use DELETE to remove a Predicate // from a Rule. // // This member is required. Action ChangeAction + + // The ID of the Predicate (such as an IPSet) that you want to add to a Rule. + // + // This member is required. + Predicate *Predicate } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1312,13 +1312,6 @@ type SampledHTTPRequest struct { // This member is required. Request *HTTPRequest - // The time at which AWS WAF received the request from your AWS resource, in Unix - // time format (in seconds). - Timestamp *time.Time - - // The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT. - Action *string - // A value that indicates how one result in the response relates proportionally to // other results in the response. A result that has a weight of 2 represents // roughly twice as many CloudFront web requests as a result that has a weight of @@ -1327,11 +1320,18 @@ type SampledHTTPRequest struct { // This member is required. Weight *int64 + // The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT. + Action *string + // This value is returned if the GetSampledRequests request specifies the ID of a // RuleGroup rather than the ID of an individual rule. RuleWithinRuleGroup is the // rule within the specified RuleGroup that matched the request listed in the // response. RuleWithinRuleGroup *string + + // The time at which AWS WAF received the request from your AWS resource, in Unix + // time format (in seconds). + Timestamp *time.Time } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1346,6 +1346,25 @@ type SampledHTTPRequest struct { // expression is true, the SizeConstraint is considered to match. type SizeConstraint struct { + // The type of comparison you want AWS WAF to perform. AWS WAF uses this in + // combination with the provided Size and FieldToMatch to build an expression in + // the form of "SizeComparisonOperator size in bytes of FieldToMatch". If that + // expression is true, the SizeConstraint is considered to match. EQ: Used to test + // if the Size is equal to the size of the FieldToMatch NE: Used to test if the + // Size is not equal to the size of the FieldToMatch LE: Used to test if the Size + // is less than or equal to the size of the FieldToMatch LT: Used to test if the + // Size is strictly less than the size of the FieldToMatch GE: Used to test if the + // Size is greater than or equal to the size of the FieldToMatch GT: Used to test + // if the Size is strictly greater than the size of the FieldToMatch + // + // This member is required. + ComparisonOperator ComparisonOperator + + // Specifies where in a web request to look for the size constraint. + // + // This member is required. + FieldToMatch *FieldToMatch + // The size in bytes that you want AWS WAF to compare against the size of the // specified FieldToMatch. AWS WAF uses this in combination with ComparisonOperator // and FieldToMatch to build an expression in the form of "SizeComparisonOperator @@ -1429,25 +1448,6 @@ type SizeConstraint struct { // // This member is required. TextTransformation TextTransformation - - // Specifies where in a web request to look for the size constraint. - // - // This member is required. - FieldToMatch *FieldToMatch - - // The type of comparison you want AWS WAF to perform. AWS WAF uses this in - // combination with the provided Size and FieldToMatch to build an expression in - // the form of "SizeComparisonOperator size in bytes of FieldToMatch". If that - // expression is true, the SizeConstraint is considered to match. EQ: Used to test - // if the Size is equal to the size of the FieldToMatch NE: Used to test if the - // Size is not equal to the size of the FieldToMatch LE: Used to test if the Size - // is less than or equal to the size of the FieldToMatch LT: Used to test if the - // Size is strictly less than the size of the FieldToMatch GE: Used to test if the - // Size is greater than or equal to the size of the FieldToMatch GT: Used to test - // if the Size is strictly greater than the size of the FieldToMatch - // - // This member is required. - ComparisonOperator ComparisonOperator } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1462,14 +1462,6 @@ type SizeConstraint struct { // needs to match one constraint to be considered a match. type SizeConstraintSet struct { - // Specifies the parts of web requests that you want to inspect the size of. - // - // This member is required. - SizeConstraints []*SizeConstraint - - // The name, if any, of the SizeConstraintSet. - Name *string - // A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get // information about a SizeConstraintSet (see GetSizeConstraintSet ()), update a // SizeConstraintSet (see UpdateSizeConstraintSet ()), insert a SizeConstraintSet @@ -1480,6 +1472,14 @@ type SizeConstraintSet struct { // // This member is required. SizeConstraintSetId *string + + // Specifies the parts of web requests that you want to inspect the size of. + // + // This member is required. + SizeConstraints []*SizeConstraint + + // The name, if any, of the SizeConstraintSet. + Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1491,6 +1491,11 @@ type SizeConstraintSet struct { // global use. The Id and Name of a SizeConstraintSet. type SizeConstraintSetSummary struct { + // The name of the SizeConstraintSet, if any. + // + // This member is required. + Name *string + // A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get // information about a SizeConstraintSet (see GetSizeConstraintSet ()), update a // SizeConstraintSet (see UpdateSizeConstraintSet ()), insert a SizeConstraintSet @@ -1501,11 +1506,6 @@ type SizeConstraintSetSummary struct { // // This member is required. SizeConstraintSetId *string - - // The name of the SizeConstraintSet, if any. - // - // This member is required. - Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1548,15 +1548,6 @@ type SizeConstraintSetUpdate struct { // in only one of the specified parts of the request to be considered a match. type SqlInjectionMatchSet struct { - // The name, if any, of the SqlInjectionMatchSet. - Name *string - - // Specifies the parts of web requests that you want to inspect for snippets of - // malicious SQL code. - // - // This member is required. - SqlInjectionMatchTuples []*SqlInjectionMatchTuple - // A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId // to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet // ()), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet ()), insert a @@ -1567,6 +1558,15 @@ type SqlInjectionMatchSet struct { // // This member is required. SqlInjectionMatchSetId *string + + // Specifies the parts of web requests that you want to inspect for snippets of + // malicious SQL code. + // + // This member is required. + SqlInjectionMatchTuples []*SqlInjectionMatchTuple + + // The name, if any, of the SqlInjectionMatchSet. + Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1607,19 +1607,19 @@ type SqlInjectionMatchSetSummary struct { // SqlInjectionMatchSet. type SqlInjectionMatchSetUpdate struct { - // Specifies the part of a web request that you want AWS WAF to inspect for - // snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the - // name of the header. - // - // This member is required. - SqlInjectionMatchTuple *SqlInjectionMatchTuple - // Specify INSERT to add a SqlInjectionMatchSetUpdate () to a SqlInjectionMatchSet // (). Use DELETE to remove a SqlInjectionMatchSetUpdate from a // SqlInjectionMatchSet. // // This member is required. Action ChangeAction + + // Specifies the part of a web request that you want AWS WAF to inspect for + // snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the + // name of the header. + // + // This member is required. + SqlInjectionMatchTuple *SqlInjectionMatchTuple } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1718,12 +1718,6 @@ type SqlInjectionMatchTuple struct { // global use. A summary of the rule groups you are subscribed to. type SubscribedRuleGroupSummary struct { - // A friendly name or description of the RuleGroup. You can't change the name of a - // RuleGroup after you create it. - // - // This member is required. - Name *string - // A friendly name or description for the metrics for this RuleGroup. The name can // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 // and minimum length one. It can't contain whitespace or metric names reserved for @@ -1733,6 +1727,12 @@ type SubscribedRuleGroupSummary struct { // This member is required. MetricName *string + // A friendly name or description of the RuleGroup. You can't change the name of a + // RuleGroup after you create it. + // + // This member is required. + Name *string + // A unique identifier for a RuleGroup. // // This member is required. @@ -1808,23 +1808,23 @@ type TagInfoForResource struct { // is the time that AWS WAF received the 5,000th request. type TimeWindow struct { - // The beginning of the time range from which you want GetSampledRequests to return - // a sample of the requests that your AWS resource received. You must specify the + // The end of the time range from which you want GetSampledRequests to return a + // sample of the requests that your AWS resource received. You must specify the // date and time in Coordinated Universal Time (UTC) format. UTC format includes // the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any // time range in the previous three hours. // // This member is required. - StartTime *time.Time + EndTime *time.Time - // The end of the time range from which you want GetSampledRequests to return a - // sample of the requests that your AWS resource received. You must specify the + // The beginning of the time range from which you want GetSampledRequests to return + // a sample of the requests that your AWS resource received. You must specify the // date and time in Coordinated Universal Time (UTC) format. UTC format includes // the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any // time range in the previous three hours. // // This member is required. - EndTime *time.Time + StartTime *time.Time } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1890,9 +1890,11 @@ type WafOverrideAction struct { // allowed, blocked, or counted. For more information, see UpdateWebACL (). type WebACL struct { - // A friendly name or description of the WebACL. You can't change the name of a - // WebACL after you create it. - Name *string + // The action to perform if none of the Rules contained in the WebACL match. The + // action is specified by the WafAction () object. + // + // This member is required. + DefaultAction *WafAction // An array that contains the action for each Rule in a WebACL, the priority of the // Rule, and the ID of the Rule. @@ -1900,8 +1902,13 @@ type WebACL struct { // This member is required. Rules []*ActivatedRule - // Tha Amazon Resource Name (ARN) of the web ACL. - WebACLArn *string + // A unique identifier for a WebACL. You use WebACLId to get information about a + // WebACL (see GetWebACL ()), update a WebACL (see UpdateWebACL ()), and delete a + // WebACL from AWS WAF (see DeleteWebACL ()). WebACLId is returned by CreateWebACL + // () and by ListWebACLs (). + // + // This member is required. + WebACLId *string // A friendly name or description for the metrics for this WebACL. The name can // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 @@ -1910,19 +1917,12 @@ type WebACL struct { // you create the WebACL. MetricName *string - // The action to perform if none of the Rules contained in the WebACL match. The - // action is specified by the WafAction () object. - // - // This member is required. - DefaultAction *WafAction + // A friendly name or description of the WebACL. You can't change the name of a + // WebACL after you create it. + Name *string - // A unique identifier for a WebACL. You use WebACLId to get information about a - // WebACL (see GetWebACL ()), update a WebACL (see UpdateWebACL ()), and delete a - // WebACL from AWS WAF (see DeleteWebACL ()). WebACLId is returned by CreateWebACL - // () and by ListWebACLs (). - // - // This member is required. - WebACLId *string + // Tha Amazon Resource Name (ARN) of the web ACL. + WebACLArn *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1935,6 +1935,12 @@ type WebACL struct { // (). type WebACLSummary struct { + // A friendly name or description of the WebACL (). You can't change the name of a + // WebACL after you create it. + // + // This member is required. + Name *string + // A unique identifier for a WebACL. You use WebACLId to get information about a // WebACL (see GetWebACL ()), update a WebACL (see UpdateWebACL ()), and delete a // WebACL from AWS WAF (see DeleteWebACL ()). WebACLId is returned by CreateWebACL @@ -1942,12 +1948,6 @@ type WebACLSummary struct { // // This member is required. WebACLId *string - - // A friendly name or description of the WebACL (). You can't change the name of a - // WebACL after you create it. - // - // This member is required. - Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1960,6 +1960,11 @@ type WebACLSummary struct { // WebACL. type WebACLUpdate struct { + // Specifies whether to insert a Rule into or delete a Rule from a WebACL. + // + // This member is required. + Action ChangeAction + // The ActivatedRule object in an UpdateWebACL () request specifies a Rule that you // want to insert or delete, the priority of the Rule in the WebACL, and the action // that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, @@ -1967,11 +1972,6 @@ type WebACLUpdate struct { // // This member is required. ActivatedRule *ActivatedRule - - // Specifies whether to insert a Rule into or delete a Rule from a WebACL. - // - // This member is required. - Action ChangeAction } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1988,15 +1988,6 @@ type WebACLUpdate struct { // of the request to be considered a match. type XssMatchSet struct { - // Specifies the parts of web requests that you want to inspect for cross-site - // scripting attacks. - // - // This member is required. - XssMatchTuples []*XssMatchTuple - - // The name, if any, of the XssMatchSet. - Name *string - // A unique identifier for an XssMatchSet. You use XssMatchSetId to get information // about an XssMatchSet (see GetXssMatchSet ()), update an XssMatchSet (see // UpdateXssMatchSet ()), insert an XssMatchSet into a Rule or delete one from a @@ -2006,6 +1997,15 @@ type XssMatchSet struct { // // This member is required. XssMatchSetId *string + + // Specifies the parts of web requests that you want to inspect for cross-site + // scripting attacks. + // + // This member is required. + XssMatchTuples []*XssMatchTuple + + // The name, if any, of the XssMatchSet. + Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic diff --git a/service/wafregional/api_op_AssociateWebACL.go b/service/wafregional/api_op_AssociateWebACL.go index 54bce2ee333..bf91a187195 100644 --- a/service/wafregional/api_op_AssociateWebACL.go +++ b/service/wafregional/api_op_AssociateWebACL.go @@ -64,11 +64,6 @@ func (c *Client) AssociateWebACL(ctx context.Context, params *AssociateWebACLInp type AssociateWebACLInput struct { - // A unique identifier (ID) for the web ACL. - // - // This member is required. - WebACLId *string - // The ARN (Amazon Resource Name) of the resource to be protected, either an // application load balancer or Amazon API Gateway stage. The ARN should be in one // of the following formats: @@ -82,6 +77,11 @@ type AssociateWebACLInput struct { // // This member is required. ResourceArn *string + + // A unique identifier (ID) for the web ACL. + // + // This member is required. + WebACLId *string } type AssociateWebACLOutput struct { diff --git a/service/wafregional/api_op_CreateByteMatchSet.go b/service/wafregional/api_op_CreateByteMatchSet.go index 8e9dd09f4d5..6b6a25e8719 100644 --- a/service/wafregional/api_op_CreateByteMatchSet.go +++ b/service/wafregional/api_op_CreateByteMatchSet.go @@ -101,14 +101,14 @@ type CreateByteMatchSetInput struct { type CreateByteMatchSetOutput struct { + // A ByteMatchSet () that contains no ByteMatchTuple objects. + ByteMatchSet *types.ByteMatchSet + // The ChangeToken that you used to submit the CreateByteMatchSet request. You can // also use this value to query the status of the request. For more information, // see GetChangeTokenStatus (). ChangeToken *string - // A ByteMatchSet () that contains no ByteMatchTuple objects. - ByteMatchSet *types.ByteMatchSet - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/wafregional/api_op_CreateIPSet.go b/service/wafregional/api_op_CreateIPSet.go index 591aa7a2932..0e3b9c66be8 100644 --- a/service/wafregional/api_op_CreateIPSet.go +++ b/service/wafregional/api_op_CreateIPSet.go @@ -86,28 +86,28 @@ func (c *Client) CreateIPSet(ctx context.Context, params *CreateIPSetInput, optF type CreateIPSetInput struct { - // A friendly name or description of the IPSet (). You can't change Name after you - // create the IPSet. + // The value returned by the most recent call to GetChangeToken (). // // This member is required. - Name *string + ChangeToken *string - // The value returned by the most recent call to GetChangeToken (). + // A friendly name or description of the IPSet (). You can't change Name after you + // create the IPSet. // // This member is required. - ChangeToken *string + Name *string } type CreateIPSetOutput struct { - // The IPSet () returned in the CreateIPSet response. - IPSet *types.IPSet - // The ChangeToken that you used to submit the CreateIPSet request. You can also // use this value to query the status of the request. For more information, see // GetChangeTokenStatus (). ChangeToken *string + // The IPSet () returned in the CreateIPSet response. + IPSet *types.IPSet + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/wafregional/api_op_CreateRateBasedRule.go b/service/wafregional/api_op_CreateRateBasedRule.go index 09e737697e2..e089e1d4087 100644 --- a/service/wafregional/api_op_CreateRateBasedRule.go +++ b/service/wafregional/api_op_CreateRateBasedRule.go @@ -111,14 +111,12 @@ func (c *Client) CreateRateBasedRule(ctx context.Context, params *CreateRateBase type CreateRateBasedRuleInput struct { - // A friendly name or description of the RateBasedRule (). You can't change the - // name of a RateBasedRule after you create it. + // The ChangeToken that you used to submit the CreateRateBasedRule request. You can + // also use this value to query the status of the request. For more information, + // see GetChangeTokenStatus (). // // This member is required. - Name *string - - // - Tags []*types.Tag + ChangeToken *string // A friendly name or description for the metrics for this RateBasedRule. The name // can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length @@ -129,13 +127,11 @@ type CreateRateBasedRuleInput struct { // This member is required. MetricName *string - // The maximum number of requests, which have an identical value in the field that - // is specified by RateKey, allowed in a five-minute period. If the number of - // requests exceeds the RateLimit and the other predicates specified in the rule - // are also met, AWS WAF triggers the action that is specified for this rule. + // A friendly name or description of the RateBasedRule (). You can't change the + // name of a RateBasedRule after you create it. // // This member is required. - RateLimit *int64 + Name *string // The field that AWS WAF uses to determine if requests are likely arriving from a // single source and thus subject to rate monitoring. The only valid value for @@ -145,24 +141,28 @@ type CreateRateBasedRuleInput struct { // This member is required. RateKey types.RateKey - // The ChangeToken that you used to submit the CreateRateBasedRule request. You can - // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus (). + // The maximum number of requests, which have an identical value in the field that + // is specified by RateKey, allowed in a five-minute period. If the number of + // requests exceeds the RateLimit and the other predicates specified in the rule + // are also met, AWS WAF triggers the action that is specified for this rule. // // This member is required. - ChangeToken *string + RateLimit *int64 + + // + Tags []*types.Tag } type CreateRateBasedRuleOutput struct { - // The RateBasedRule () that is returned in the CreateRateBasedRule response. - Rule *types.RateBasedRule - // The ChangeToken that you used to submit the CreateRateBasedRule request. You can // also use this value to query the status of the request. For more information, // see GetChangeTokenStatus (). ChangeToken *string + // The RateBasedRule () that is returned in the CreateRateBasedRule response. + Rule *types.RateBasedRule + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/wafregional/api_op_CreateRegexPatternSet.go b/service/wafregional/api_op_CreateRegexPatternSet.go index bd82ee53a6f..d5132e8d158 100644 --- a/service/wafregional/api_op_CreateRegexPatternSet.go +++ b/service/wafregional/api_op_CreateRegexPatternSet.go @@ -84,28 +84,28 @@ func (c *Client) CreateRegexPatternSet(ctx context.Context, params *CreateRegexP type CreateRegexPatternSetInput struct { - // A friendly name or description of the RegexPatternSet (). You can't change Name - // after you create a RegexPatternSet. + // The value returned by the most recent call to GetChangeToken (). // // This member is required. - Name *string + ChangeToken *string - // The value returned by the most recent call to GetChangeToken (). + // A friendly name or description of the RegexPatternSet (). You can't change Name + // after you create a RegexPatternSet. // // This member is required. - ChangeToken *string + Name *string } type CreateRegexPatternSetOutput struct { - // A RegexPatternSet () that contains no objects. - RegexPatternSet *types.RegexPatternSet - // The ChangeToken that you used to submit the CreateRegexPatternSet request. You // can also use this value to query the status of the request. For more // information, see GetChangeTokenStatus (). ChangeToken *string + // A RegexPatternSet () that contains no objects. + RegexPatternSet *types.RegexPatternSet + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/wafregional/api_op_CreateRule.go b/service/wafregional/api_op_CreateRule.go index 1d1f2eed91e..c1b8c829df9 100644 --- a/service/wafregional/api_op_CreateRule.go +++ b/service/wafregional/api_op_CreateRule.go @@ -108,8 +108,14 @@ type CreateRuleInput struct { // This member is required. ChangeToken *string + // A friendly name or description for the metrics for this Rule. The name can + // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 + // and minimum length one. It can't contain whitespace or metric names reserved for + // AWS WAF, including "All" and "Default_Action." You can't change the name of the + // metric after you create the Rule. // - Tags []*types.Tag + // This member is required. + MetricName *string // A friendly name or description of the Rule (). You can't change the name of a // Rule after you create it. @@ -117,14 +123,8 @@ type CreateRuleInput struct { // This member is required. Name *string - // A friendly name or description for the metrics for this Rule. The name can - // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 - // and minimum length one. It can't contain whitespace or metric names reserved for - // AWS WAF, including "All" and "Default_Action." You can't change the name of the - // metric after you create the Rule. // - // This member is required. - MetricName *string + Tags []*types.Tag } type CreateRuleOutput struct { diff --git a/service/wafregional/api_op_CreateRuleGroup.go b/service/wafregional/api_op_CreateRuleGroup.go index ac55483c6a9..5abb8d592e2 100644 --- a/service/wafregional/api_op_CreateRuleGroup.go +++ b/service/wafregional/api_op_CreateRuleGroup.go @@ -78,8 +78,10 @@ func (c *Client) CreateRuleGroup(ctx context.Context, params *CreateRuleGroupInp type CreateRuleGroupInput struct { + // The value returned by the most recent call to GetChangeToken (). // - Tags []*types.Tag + // This member is required. + ChangeToken *string // A friendly name or description for the metrics for this RuleGroup. The name can // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 @@ -96,10 +98,8 @@ type CreateRuleGroupInput struct { // This member is required. Name *string - // The value returned by the most recent call to GetChangeToken (). // - // This member is required. - ChangeToken *string + Tags []*types.Tag } type CreateRuleGroupOutput struct { diff --git a/service/wafregional/api_op_CreateSizeConstraintSet.go b/service/wafregional/api_op_CreateSizeConstraintSet.go index dff6c8b0b5f..a0671d7c9a3 100644 --- a/service/wafregional/api_op_CreateSizeConstraintSet.go +++ b/service/wafregional/api_op_CreateSizeConstraintSet.go @@ -88,28 +88,28 @@ func (c *Client) CreateSizeConstraintSet(ctx context.Context, params *CreateSize type CreateSizeConstraintSetInput struct { - // A friendly name or description of the SizeConstraintSet (). You can't change - // Name after you create a SizeConstraintSet. + // The value returned by the most recent call to GetChangeToken (). // // This member is required. - Name *string + ChangeToken *string - // The value returned by the most recent call to GetChangeToken (). + // A friendly name or description of the SizeConstraintSet (). You can't change + // Name after you create a SizeConstraintSet. // // This member is required. - ChangeToken *string + Name *string } type CreateSizeConstraintSetOutput struct { - // A SizeConstraintSet () that contains no SizeConstraint objects. - SizeConstraintSet *types.SizeConstraintSet - // The ChangeToken that you used to submit the CreateSizeConstraintSet request. You // can also use this value to query the status of the request. For more // information, see GetChangeTokenStatus (). ChangeToken *string + // A SizeConstraintSet () that contains no SizeConstraint objects. + SizeConstraintSet *types.SizeConstraintSet + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/wafregional/api_op_CreateWebACL.go b/service/wafregional/api_op_CreateWebACL.go index e9b8be7f977..904cc088c8e 100644 --- a/service/wafregional/api_op_CreateWebACL.go +++ b/service/wafregional/api_op_CreateWebACL.go @@ -97,16 +97,17 @@ func (c *Client) CreateWebACL(ctx context.Context, params *CreateWebACLInput, op type CreateWebACLInput struct { - // A friendly name or description of the WebACL (). You can't change Name after you - // create the WebACL. + // The value returned by the most recent call to GetChangeToken (). // // This member is required. - Name *string + ChangeToken *string - // The value returned by the most recent call to GetChangeToken (). + // The action that you want AWS WAF to take when a request doesn't match the + // criteria specified in any of the Rule objects that are associated with the + // WebACL. // // This member is required. - ChangeToken *string + DefaultAction *types.WafAction // A friendly name or description for the metrics for this WebACL.The name can // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 @@ -117,27 +118,26 @@ type CreateWebACLInput struct { // This member is required. MetricName *string + // A friendly name or description of the WebACL (). You can't change Name after you + // create the WebACL. // - Tags []*types.Tag + // This member is required. + Name *string - // The action that you want AWS WAF to take when a request doesn't match the - // criteria specified in any of the Rule objects that are associated with the - // WebACL. // - // This member is required. - DefaultAction *types.WafAction + Tags []*types.Tag } type CreateWebACLOutput struct { - // The WebACL () returned in the CreateWebACL response. - WebACL *types.WebACL - // The ChangeToken that you used to submit the CreateWebACL request. You can also // use this value to query the status of the request. For more information, see // GetChangeTokenStatus (). ChangeToken *string + // The WebACL () returned in the CreateWebACL response. + WebACL *types.WebACL + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/wafregional/api_op_CreateWebACLMigrationStack.go b/service/wafregional/api_op_CreateWebACLMigrationStack.go index 65eacb6b2b6..5cf49d9eafe 100644 --- a/service/wafregional/api_op_CreateWebACLMigrationStack.go +++ b/service/wafregional/api_op_CreateWebACLMigrationStack.go @@ -66,10 +66,13 @@ func (c *Client) CreateWebACLMigrationStack(ctx context.Context, params *CreateW type CreateWebACLMigrationStackInput struct { - // The UUID of the WAF Classic web ACL that you want to migrate to WAF v2. + // Indicates whether to exclude entities that can't be migrated or to stop the + // migration. Set this to true to ignore unsupported entities in the web ACL during + // the migration. Otherwise, if AWS WAF encounters unsupported entities, it stops + // the process and throws an exception. // // This member is required. - WebACLId *string + IgnoreUnsupportedType *bool // The name of the Amazon S3 bucket to store the CloudFormation template in. The S3 // bucket must be configured as follows for the migration: @@ -89,13 +92,10 @@ type CreateWebACLMigrationStackInput struct { // This member is required. S3BucketName *string - // Indicates whether to exclude entities that can't be migrated or to stop the - // migration. Set this to true to ignore unsupported entities in the web ACL during - // the migration. Otherwise, if AWS WAF encounters unsupported entities, it stops - // the process and throws an exception. + // The UUID of the WAF Classic web ACL that you want to migrate to WAF v2. // // This member is required. - IgnoreUnsupportedType *bool + WebACLId *string } type CreateWebACLMigrationStackOutput struct { diff --git a/service/wafregional/api_op_CreateXssMatchSet.go b/service/wafregional/api_op_CreateXssMatchSet.go index 558f5b7a1ce..79ea034b299 100644 --- a/service/wafregional/api_op_CreateXssMatchSet.go +++ b/service/wafregional/api_op_CreateXssMatchSet.go @@ -86,16 +86,16 @@ func (c *Client) CreateXssMatchSet(ctx context.Context, params *CreateXssMatchSe // A request to create an XssMatchSet (). type CreateXssMatchSetInput struct { - // A friendly name or description for the XssMatchSet () that you're creating. You - // can't change Name after you create the XssMatchSet. + // The value returned by the most recent call to GetChangeToken (). // // This member is required. - Name *string + ChangeToken *string - // The value returned by the most recent call to GetChangeToken (). + // A friendly name or description for the XssMatchSet () that you're creating. You + // can't change Name after you create the XssMatchSet. // // This member is required. - ChangeToken *string + Name *string } // The response to a CreateXssMatchSet request. diff --git a/service/wafregional/api_op_DeleteIPSet.go b/service/wafregional/api_op_DeleteIPSet.go index 8f4385e552a..f32d1f9c2dc 100644 --- a/service/wafregional/api_op_DeleteIPSet.go +++ b/service/wafregional/api_op_DeleteIPSet.go @@ -75,16 +75,16 @@ func (c *Client) DeleteIPSet(ctx context.Context, params *DeleteIPSetInput, optF type DeleteIPSetInput struct { - // The IPSetId of the IPSet () that you want to delete. IPSetId is returned by - // CreateIPSet () and by ListIPSets (). + // The value returned by the most recent call to GetChangeToken (). // // This member is required. - IPSetId *string + ChangeToken *string - // The value returned by the most recent call to GetChangeToken (). + // The IPSetId of the IPSet () that you want to delete. IPSetId is returned by + // CreateIPSet () and by ListIPSets (). // // This member is required. - ChangeToken *string + IPSetId *string } type DeleteIPSetOutput struct { diff --git a/service/wafregional/api_op_DeleteRateBasedRule.go b/service/wafregional/api_op_DeleteRateBasedRule.go index 329c8bc7d56..edecac0bf83 100644 --- a/service/wafregional/api_op_DeleteRateBasedRule.go +++ b/service/wafregional/api_op_DeleteRateBasedRule.go @@ -75,16 +75,16 @@ func (c *Client) DeleteRateBasedRule(ctx context.Context, params *DeleteRateBase type DeleteRateBasedRuleInput struct { - // The RuleId of the RateBasedRule () that you want to delete. RuleId is returned - // by CreateRateBasedRule () and by ListRateBasedRules (). + // The value returned by the most recent call to GetChangeToken (). // // This member is required. - RuleId *string + ChangeToken *string - // The value returned by the most recent call to GetChangeToken (). + // The RuleId of the RateBasedRule () that you want to delete. RuleId is returned + // by CreateRateBasedRule () and by ListRateBasedRules (). // // This member is required. - ChangeToken *string + RuleId *string } type DeleteRateBasedRuleOutput struct { diff --git a/service/wafregional/api_op_DeleteRegexMatchSet.go b/service/wafregional/api_op_DeleteRegexMatchSet.go index 44f45886d30..64b9068d917 100644 --- a/service/wafregional/api_op_DeleteRegexMatchSet.go +++ b/service/wafregional/api_op_DeleteRegexMatchSet.go @@ -76,17 +76,17 @@ func (c *Client) DeleteRegexMatchSet(ctx context.Context, params *DeleteRegexMat type DeleteRegexMatchSetInput struct { + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + // The RegexMatchSetId of the RegexMatchSet () that you want to delete. // RegexMatchSetId is returned by CreateRegexMatchSet () and by ListRegexMatchSets // (). // // This member is required. RegexMatchSetId *string - - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string } type DeleteRegexMatchSetOutput struct { diff --git a/service/wafregional/api_op_DeleteRuleGroup.go b/service/wafregional/api_op_DeleteRuleGroup.go index 3204ada60ff..d847105ed75 100644 --- a/service/wafregional/api_op_DeleteRuleGroup.go +++ b/service/wafregional/api_op_DeleteRuleGroup.go @@ -75,16 +75,16 @@ func (c *Client) DeleteRuleGroup(ctx context.Context, params *DeleteRuleGroupInp type DeleteRuleGroupInput struct { - // The RuleGroupId of the RuleGroup () that you want to delete. RuleGroupId is - // returned by CreateRuleGroup () and by ListRuleGroups (). + // The value returned by the most recent call to GetChangeToken (). // // This member is required. - RuleGroupId *string + ChangeToken *string - // The value returned by the most recent call to GetChangeToken (). + // The RuleGroupId of the RuleGroup () that you want to delete. RuleGroupId is + // returned by CreateRuleGroup () and by ListRuleGroups (). // // This member is required. - ChangeToken *string + RuleGroupId *string } type DeleteRuleGroupOutput struct { diff --git a/service/wafregional/api_op_DeleteSizeConstraintSet.go b/service/wafregional/api_op_DeleteSizeConstraintSet.go index bd337c96a60..699a049a926 100644 --- a/service/wafregional/api_op_DeleteSizeConstraintSet.go +++ b/service/wafregional/api_op_DeleteSizeConstraintSet.go @@ -76,17 +76,17 @@ func (c *Client) DeleteSizeConstraintSet(ctx context.Context, params *DeleteSize type DeleteSizeConstraintSetInput struct { + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + // The SizeConstraintSetId of the SizeConstraintSet () that you want to delete. // SizeConstraintSetId is returned by CreateSizeConstraintSet () and by // ListSizeConstraintSets (). // // This member is required. SizeConstraintSetId *string - - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string } type DeleteSizeConstraintSetOutput struct { diff --git a/service/wafregional/api_op_DeleteSqlInjectionMatchSet.go b/service/wafregional/api_op_DeleteSqlInjectionMatchSet.go index a89c654240c..80e7eb8e69f 100644 --- a/service/wafregional/api_op_DeleteSqlInjectionMatchSet.go +++ b/service/wafregional/api_op_DeleteSqlInjectionMatchSet.go @@ -78,17 +78,17 @@ func (c *Client) DeleteSqlInjectionMatchSet(ctx context.Context, params *DeleteS // A request to delete a SqlInjectionMatchSet () from AWS WAF. type DeleteSqlInjectionMatchSetInput struct { + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + // The SqlInjectionMatchSetId of the SqlInjectionMatchSet () that you want to // delete. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet () and // by ListSqlInjectionMatchSets (). // // This member is required. SqlInjectionMatchSetId *string - - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string } // The response to a request to delete a SqlInjectionMatchSet () from AWS WAF. diff --git a/service/wafregional/api_op_GetRateBasedRuleManagedKeys.go b/service/wafregional/api_op_GetRateBasedRuleManagedKeys.go index b2ca1511650..8cc39bb79fa 100644 --- a/service/wafregional/api_op_GetRateBasedRuleManagedKeys.go +++ b/service/wafregional/api_op_GetRateBasedRuleManagedKeys.go @@ -65,15 +65,15 @@ func (c *Client) GetRateBasedRuleManagedKeys(ctx context.Context, params *GetRat type GetRateBasedRuleManagedKeysInput struct { - // A null value and not currently used. Do not include this in your request. - NextMarker *string - // The RuleId of the RateBasedRule () for which you want to get a list of // ManagedKeys. RuleId is returned by CreateRateBasedRule () and by // ListRateBasedRules (). // // This member is required. RuleId *string + + // A null value and not currently used. Do not include this in your request. + NextMarker *string } type GetRateBasedRuleManagedKeysOutput struct { diff --git a/service/wafregional/api_op_GetSampledRequests.go b/service/wafregional/api_op_GetSampledRequests.go index 034dc87bfe3..b0eaa65fa61 100644 --- a/service/wafregional/api_op_GetSampledRequests.go +++ b/service/wafregional/api_op_GetSampledRequests.go @@ -72,20 +72,13 @@ func (c *Client) GetSampledRequests(ctx context.Context, params *GetSampledReque type GetSampledRequestsInput struct { - // The start date and time and the end date and time of the range for which you - // want GetSampledRequests to return a sample of requests. You must specify the - // times in Coordinated Universal Time (UTC) format. UTC format includes the - // special designator, Z. For example, "2016-09-27T14:50Z". You can specify any - // time range in the previous three hours. - // - // This member is required. - TimeWindow *types.TimeWindow - - // The WebACLId of the WebACL for which you want GetSampledRequests to return a - // sample of requests. + // The number of requests that you want AWS WAF to return from among the first + // 5,000 requests that your AWS resource received during the time range. If your + // resource received fewer requests than the value of MaxItems, GetSampledRequests + // returns information about all of them. // // This member is required. - WebAclId *string + MaxItems *int64 // RuleId is one of three values: // @@ -100,17 +93,33 @@ type GetSampledRequestsInput struct { // This member is required. RuleId *string - // The number of requests that you want AWS WAF to return from among the first - // 5,000 requests that your AWS resource received during the time range. If your - // resource received fewer requests than the value of MaxItems, GetSampledRequests - // returns information about all of them. + // The start date and time and the end date and time of the range for which you + // want GetSampledRequests to return a sample of requests. You must specify the + // times in Coordinated Universal Time (UTC) format. UTC format includes the + // special designator, Z. For example, "2016-09-27T14:50Z". You can specify any + // time range in the previous three hours. // // This member is required. - MaxItems *int64 + TimeWindow *types.TimeWindow + + // The WebACLId of the WebACL for which you want GetSampledRequests to return a + // sample of requests. + // + // This member is required. + WebAclId *string } type GetSampledRequestsOutput struct { + // The total number of requests from which GetSampledRequests got a sample of + // MaxItems requests. If PopulationSize is less than MaxItems, the sample includes + // every request that your AWS resource received during the specified time range. + PopulationSize *int64 + + // A complex type that contains detailed information about each of the requests in + // the sample. + SampledRequests []*types.SampledHTTPRequest + // Usually, TimeWindow is the time range that you specified in the // GetSampledRequests request. However, if your AWS resource received more than // 5,000 requests during the time range that you specified in the request, @@ -118,15 +127,6 @@ type GetSampledRequestsOutput struct { // are in Coordinated Universal Time (UTC) format. TimeWindow *types.TimeWindow - // A complex type that contains detailed information about each of the requests in - // the sample. - SampledRequests []*types.SampledHTTPRequest - - // The total number of requests from which GetSampledRequests got a sample of - // MaxItems requests. If PopulationSize is less than MaxItems, the sample includes - // every request that your AWS resource received during the specified time range. - PopulationSize *int64 - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/wafregional/api_op_ListActivatedRulesInRuleGroup.go b/service/wafregional/api_op_ListActivatedRulesInRuleGroup.go index 0a813efd404..8353673e82e 100644 --- a/service/wafregional/api_op_ListActivatedRulesInRuleGroup.go +++ b/service/wafregional/api_op_ListActivatedRulesInRuleGroup.go @@ -62,10 +62,6 @@ func (c *Client) ListActivatedRulesInRuleGroup(ctx context.Context, params *List type ListActivatedRulesInRuleGroupInput struct { - // The RuleGroupId of the RuleGroup () for which you want to get a list of - // ActivatedRule () objects. - RuleGroupId *string - // Specifies the number of ActivatedRules that you want AWS WAF to return for this // request. If you have more ActivatedRules than the number that you specify for // Limit, the response includes a NextMarker value that you can use to get another @@ -78,6 +74,10 @@ type ListActivatedRulesInRuleGroupInput struct { // ListActivatedRulesInRuleGroup requests, specify the value of NextMarker from the // previous response to get information about another batch of ActivatedRules. NextMarker *string + + // The RuleGroupId of the RuleGroup () for which you want to get a list of + // ActivatedRule () objects. + RuleGroupId *string } type ListActivatedRulesInRuleGroupOutput struct { diff --git a/service/wafregional/api_op_ListByteMatchSets.go b/service/wafregional/api_op_ListByteMatchSets.go index 262249b9f91..331dc23604a 100644 --- a/service/wafregional/api_op_ListByteMatchSets.go +++ b/service/wafregional/api_op_ListByteMatchSets.go @@ -62,31 +62,31 @@ func (c *Client) ListByteMatchSets(ctx context.Context, params *ListByteMatchSet type ListByteMatchSetsInput struct { + // Specifies the number of ByteMatchSet objects that you want AWS WAF to return for + // this request. If you have more ByteMatchSets objects than the number you specify + // for Limit, the response includes a NextMarker value that you can use to get + // another batch of ByteMatchSet objects. + Limit *int32 + // If you specify a value for Limit and you have more ByteMatchSets than the value // of Limit, AWS WAF returns a NextMarker value in the response that allows you to // list another group of ByteMatchSets. For the second and subsequent // ListByteMatchSets requests, specify the value of NextMarker from the previous // response to get information about another batch of ByteMatchSets. NextMarker *string - - // Specifies the number of ByteMatchSet objects that you want AWS WAF to return for - // this request. If you have more ByteMatchSets objects than the number you specify - // for Limit, the response includes a NextMarker value that you can use to get - // another batch of ByteMatchSet objects. - Limit *int32 } type ListByteMatchSetsOutput struct { + // An array of ByteMatchSetSummary () objects. + ByteMatchSets []*types.ByteMatchSetSummary + // If you have more ByteMatchSet objects than the number that you specified for // Limit in the request, the response includes a NextMarker value. To list more // ByteMatchSet objects, submit another ListByteMatchSets request, and specify the // NextMarker value from the response in the NextMarker value in the next request. NextMarker *string - // An array of ByteMatchSetSummary () objects. - ByteMatchSets []*types.ByteMatchSetSummary - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/wafregional/api_op_ListGeoMatchSets.go b/service/wafregional/api_op_ListGeoMatchSets.go index 17dc3b9a80f..325ae1168a5 100644 --- a/service/wafregional/api_op_ListGeoMatchSets.go +++ b/service/wafregional/api_op_ListGeoMatchSets.go @@ -62,31 +62,31 @@ func (c *Client) ListGeoMatchSets(ctx context.Context, params *ListGeoMatchSetsI type ListGeoMatchSetsInput struct { + // Specifies the number of GeoMatchSet objects that you want AWS WAF to return for + // this request. If you have more GeoMatchSet objects than the number you specify + // for Limit, the response includes a NextMarker value that you can use to get + // another batch of GeoMatchSet objects. + Limit *int32 + // If you specify a value for Limit and you have more GeoMatchSets than the value // of Limit, AWS WAF returns a NextMarker value in the response that allows you to // list another group of GeoMatchSet objects. For the second and subsequent // ListGeoMatchSets requests, specify the value of NextMarker from the previous // response to get information about another batch of GeoMatchSet objects. NextMarker *string - - // Specifies the number of GeoMatchSet objects that you want AWS WAF to return for - // this request. If you have more GeoMatchSet objects than the number you specify - // for Limit, the response includes a NextMarker value that you can use to get - // another batch of GeoMatchSet objects. - Limit *int32 } type ListGeoMatchSetsOutput struct { + // An array of GeoMatchSetSummary () objects. + GeoMatchSets []*types.GeoMatchSetSummary + // If you have more GeoMatchSet objects than the number that you specified for // Limit in the request, the response includes a NextMarker value. To list more // GeoMatchSet objects, submit another ListGeoMatchSets request, and specify the // NextMarker value from the response in the NextMarker value in the next request. NextMarker *string - // An array of GeoMatchSetSummary () objects. - GeoMatchSets []*types.GeoMatchSetSummary - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/wafregional/api_op_ListIPSets.go b/service/wafregional/api_op_ListIPSets.go index c98021d51bd..0384f825d29 100644 --- a/service/wafregional/api_op_ListIPSets.go +++ b/service/wafregional/api_op_ListIPSets.go @@ -62,17 +62,17 @@ func (c *Client) ListIPSets(ctx context.Context, params *ListIPSetsInput, optFns type ListIPSetsInput struct { - // AWS WAF returns a NextMarker value in the response that allows you to list - // another group of IPSets. For the second and subsequent ListIPSets requests, - // specify the value of NextMarker from the previous response to get information - // about another batch of IPSets. - NextMarker *string - // Specifies the number of IPSet objects that you want AWS WAF to return for this // request. If you have more IPSet objects than the number you specify for Limit, // the response includes a NextMarker value that you can use to get another batch // of IPSet objects. Limit *int32 + + // AWS WAF returns a NextMarker value in the response that allows you to list + // another group of IPSets. For the second and subsequent ListIPSets requests, + // specify the value of NextMarker from the previous response to get information + // about another batch of IPSets. + NextMarker *string } type ListIPSetsOutput struct { diff --git a/service/wafregional/api_op_ListLoggingConfigurations.go b/service/wafregional/api_op_ListLoggingConfigurations.go index ba81ba68d01..e38fb073029 100644 --- a/service/wafregional/api_op_ListLoggingConfigurations.go +++ b/service/wafregional/api_op_ListLoggingConfigurations.go @@ -62,6 +62,12 @@ func (c *Client) ListLoggingConfigurations(ctx context.Context, params *ListLogg type ListLoggingConfigurationsInput struct { + // Specifies the number of LoggingConfigurations that you want AWS WAF to return + // for this request. If you have more LoggingConfigurations than the number that + // you specify for Limit, the response includes a NextMarker value that you can use + // to get another batch of LoggingConfigurations. + Limit *int32 + // If you specify a value for Limit and you have more LoggingConfigurations than // the value of Limit, AWS WAF returns a NextMarker value in the response that // allows you to list another group of LoggingConfigurations. For the second and @@ -69,12 +75,6 @@ type ListLoggingConfigurationsInput struct { // from the previous response to get information about another batch of // ListLoggingConfigurations. NextMarker *string - - // Specifies the number of LoggingConfigurations that you want AWS WAF to return - // for this request. If you have more LoggingConfigurations than the number that - // you specify for Limit, the response includes a NextMarker value that you can use - // to get another batch of LoggingConfigurations. - Limit *int32 } type ListLoggingConfigurationsOutput struct { diff --git a/service/wafregional/api_op_ListRegexMatchSets.go b/service/wafregional/api_op_ListRegexMatchSets.go index 82056a16f7b..966e4b6aa35 100644 --- a/service/wafregional/api_op_ListRegexMatchSets.go +++ b/service/wafregional/api_op_ListRegexMatchSets.go @@ -62,18 +62,18 @@ func (c *Client) ListRegexMatchSets(ctx context.Context, params *ListRegexMatchS type ListRegexMatchSetsInput struct { + // Specifies the number of RegexMatchSet objects that you want AWS WAF to return + // for this request. If you have more RegexMatchSet objects than the number you + // specify for Limit, the response includes a NextMarker value that you can use to + // get another batch of RegexMatchSet objects. + Limit *int32 + // If you specify a value for Limit and you have more RegexMatchSet objects than // the value of Limit, AWS WAF returns a NextMarker value in the response that // allows you to list another group of ByteMatchSets. For the second and subsequent // ListRegexMatchSets requests, specify the value of NextMarker from the previous // response to get information about another batch of RegexMatchSet objects. NextMarker *string - - // Specifies the number of RegexMatchSet objects that you want AWS WAF to return - // for this request. If you have more RegexMatchSet objects than the number you - // specify for Limit, the response includes a NextMarker value that you can use to - // get another batch of RegexMatchSet objects. - Limit *int32 } type ListRegexMatchSetsOutput struct { diff --git a/service/wafregional/api_op_ListRegexPatternSets.go b/service/wafregional/api_op_ListRegexPatternSets.go index e51d0ae5071..0731353a103 100644 --- a/service/wafregional/api_op_ListRegexPatternSets.go +++ b/service/wafregional/api_op_ListRegexPatternSets.go @@ -62,6 +62,12 @@ func (c *Client) ListRegexPatternSets(ctx context.Context, params *ListRegexPatt type ListRegexPatternSetsInput struct { + // Specifies the number of RegexPatternSet objects that you want AWS WAF to return + // for this request. If you have more RegexPatternSet objects than the number you + // specify for Limit, the response includes a NextMarker value that you can use to + // get another batch of RegexPatternSet objects. + Limit *int32 + // If you specify a value for Limit and you have more RegexPatternSet objects than // the value of Limit, AWS WAF returns a NextMarker value in the response that // allows you to list another group of RegexPatternSet objects. For the second and @@ -69,12 +75,6 @@ type ListRegexPatternSetsInput struct { // the previous response to get information about another batch of RegexPatternSet // objects. NextMarker *string - - // Specifies the number of RegexPatternSet objects that you want AWS WAF to return - // for this request. If you have more RegexPatternSet objects than the number you - // specify for Limit, the response includes a NextMarker value that you can use to - // get another batch of RegexPatternSet objects. - Limit *int32 } type ListRegexPatternSetsOutput struct { diff --git a/service/wafregional/api_op_ListRuleGroups.go b/service/wafregional/api_op_ListRuleGroups.go index 923ee5c9d69..aea93a64e36 100644 --- a/service/wafregional/api_op_ListRuleGroups.go +++ b/service/wafregional/api_op_ListRuleGroups.go @@ -62,31 +62,31 @@ func (c *Client) ListRuleGroups(ctx context.Context, params *ListRuleGroupsInput type ListRuleGroupsInput struct { + // Specifies the number of RuleGroups that you want AWS WAF to return for this + // request. If you have more RuleGroups than the number that you specify for Limit, + // the response includes a NextMarker value that you can use to get another batch + // of RuleGroups. + Limit *int32 + // If you specify a value for Limit and you have more RuleGroups than the value of // Limit, AWS WAF returns a NextMarker value in the response that allows you to // list another group of RuleGroups. For the second and subsequent ListRuleGroups // requests, specify the value of NextMarker from the previous response to get // information about another batch of RuleGroups. NextMarker *string - - // Specifies the number of RuleGroups that you want AWS WAF to return for this - // request. If you have more RuleGroups than the number that you specify for Limit, - // the response includes a NextMarker value that you can use to get another batch - // of RuleGroups. - Limit *int32 } type ListRuleGroupsOutput struct { - // An array of RuleGroup () objects. - RuleGroups []*types.RuleGroupSummary - // If you have more RuleGroups than the number that you specified for Limit in the // request, the response includes a NextMarker value. To list more RuleGroups, // submit another ListRuleGroups request, and specify the NextMarker value from the // response in the NextMarker value in the next request. NextMarker *string + // An array of RuleGroup () objects. + RuleGroups []*types.RuleGroupSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/wafregional/api_op_ListRules.go b/service/wafregional/api_op_ListRules.go index 3f29c37cb99..cfd9e073667 100644 --- a/service/wafregional/api_op_ListRules.go +++ b/service/wafregional/api_op_ListRules.go @@ -62,30 +62,30 @@ func (c *Client) ListRules(ctx context.Context, params *ListRulesInput, optFns . type ListRulesInput struct { + // Specifies the number of Rules that you want AWS WAF to return for this request. + // If you have more Rules than the number that you specify for Limit, the response + // includes a NextMarker value that you can use to get another batch of Rules. + Limit *int32 + // If you specify a value for Limit and you have more Rules than the value of // Limit, AWS WAF returns a NextMarker value in the response that allows you to // list another group of Rules. For the second and subsequent ListRules requests, // specify the value of NextMarker from the previous response to get information // about another batch of Rules. NextMarker *string - - // Specifies the number of Rules that you want AWS WAF to return for this request. - // If you have more Rules than the number that you specify for Limit, the response - // includes a NextMarker value that you can use to get another batch of Rules. - Limit *int32 } type ListRulesOutput struct { - // An array of RuleSummary () objects. - Rules []*types.RuleSummary - // If you have more Rules than the number that you specified for Limit in the // request, the response includes a NextMarker value. To list more Rules, submit // another ListRules request, and specify the NextMarker value from the response in // the NextMarker value in the next request. NextMarker *string + // An array of RuleSummary () objects. + Rules []*types.RuleSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/wafregional/api_op_ListSizeConstraintSets.go b/service/wafregional/api_op_ListSizeConstraintSets.go index 98187afc86e..be30b26243d 100644 --- a/service/wafregional/api_op_ListSizeConstraintSets.go +++ b/service/wafregional/api_op_ListSizeConstraintSets.go @@ -62,25 +62,22 @@ func (c *Client) ListSizeConstraintSets(ctx context.Context, params *ListSizeCon type ListSizeConstraintSetsInput struct { + // Specifies the number of SizeConstraintSet objects that you want AWS WAF to + // return for this request. If you have more SizeConstraintSets objects than the + // number you specify for Limit, the response includes a NextMarker value that you + // can use to get another batch of SizeConstraintSet objects. + Limit *int32 + // If you specify a value for Limit and you have more SizeConstraintSets than the // value of Limit, AWS WAF returns a NextMarker value in the response that allows // you to list another group of SizeConstraintSets. For the second and subsequent // ListSizeConstraintSets requests, specify the value of NextMarker from the // previous response to get information about another batch of SizeConstraintSets. NextMarker *string - - // Specifies the number of SizeConstraintSet objects that you want AWS WAF to - // return for this request. If you have more SizeConstraintSets objects than the - // number you specify for Limit, the response includes a NextMarker value that you - // can use to get another batch of SizeConstraintSet objects. - Limit *int32 } type ListSizeConstraintSetsOutput struct { - // An array of SizeConstraintSetSummary () objects. - SizeConstraintSets []*types.SizeConstraintSetSummary - // If you have more SizeConstraintSet objects than the number that you specified // for Limit in the request, the response includes a NextMarker value. To list more // SizeConstraintSet objects, submit another ListSizeConstraintSets request, and @@ -88,6 +85,9 @@ type ListSizeConstraintSetsOutput struct { // next request. NextMarker *string + // An array of SizeConstraintSetSummary () objects. + SizeConstraintSets []*types.SizeConstraintSetSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/wafregional/api_op_ListSqlInjectionMatchSets.go b/service/wafregional/api_op_ListSqlInjectionMatchSets.go index 79963ab04cd..d1dc41319b0 100644 --- a/service/wafregional/api_op_ListSqlInjectionMatchSets.go +++ b/service/wafregional/api_op_ListSqlInjectionMatchSets.go @@ -64,6 +64,12 @@ func (c *Client) ListSqlInjectionMatchSets(ctx context.Context, params *ListSqlI // account. type ListSqlInjectionMatchSetsInput struct { + // Specifies the number of SqlInjectionMatchSet () objects that you want AWS WAF to + // return for this request. If you have more SqlInjectionMatchSet objects than the + // number you specify for Limit, the response includes a NextMarker value that you + // can use to get another batch of Rules. + Limit *int32 + // If you specify a value for Limit and you have more SqlInjectionMatchSet () // objects than the value of Limit, AWS WAF returns a NextMarker value in the // response that allows you to list another group of SqlInjectionMatchSets. For the @@ -71,20 +77,11 @@ type ListSqlInjectionMatchSetsInput struct { // NextMarker from the previous response to get information about another batch of // SqlInjectionMatchSets. NextMarker *string - - // Specifies the number of SqlInjectionMatchSet () objects that you want AWS WAF to - // return for this request. If you have more SqlInjectionMatchSet objects than the - // number you specify for Limit, the response includes a NextMarker value that you - // can use to get another batch of Rules. - Limit *int32 } // The response to a ListSqlInjectionMatchSets () request. type ListSqlInjectionMatchSetsOutput struct { - // An array of SqlInjectionMatchSetSummary () objects. - SqlInjectionMatchSets []*types.SqlInjectionMatchSetSummary - // If you have more SqlInjectionMatchSet () objects than the number that you // specified for Limit in the request, the response includes a NextMarker value. To // list more SqlInjectionMatchSet objects, submit another ListSqlInjectionMatchSets @@ -92,6 +89,9 @@ type ListSqlInjectionMatchSetsOutput struct { // value in the next request. NextMarker *string + // An array of SqlInjectionMatchSetSummary () objects. + SqlInjectionMatchSets []*types.SqlInjectionMatchSetSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/wafregional/api_op_ListTagsForResource.go b/service/wafregional/api_op_ListTagsForResource.go index 158ae52d789..41fa89ec913 100644 --- a/service/wafregional/api_op_ListTagsForResource.go +++ b/service/wafregional/api_op_ListTagsForResource.go @@ -70,9 +70,6 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // - NextMarker *string - // // // This member is required. @@ -80,15 +77,18 @@ type ListTagsForResourceInput struct { // Limit *int32 + + // + NextMarker *string } type ListTagsForResourceOutput struct { // - TagInfoForResource *types.TagInfoForResource + NextMarker *string // - NextMarker *string + TagInfoForResource *types.TagInfoForResource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/wafregional/api_op_ListWebACLs.go b/service/wafregional/api_op_ListWebACLs.go index d3e7677ea4d..b1e521d0de9 100644 --- a/service/wafregional/api_op_ListWebACLs.go +++ b/service/wafregional/api_op_ListWebACLs.go @@ -78,15 +78,15 @@ type ListWebACLsInput struct { type ListWebACLsOutput struct { - // An array of WebACLSummary () objects. - WebACLs []*types.WebACLSummary - // If you have more WebACL objects than the number that you specified for Limit in // the request, the response includes a NextMarker value. To list more WebACL // objects, submit another ListWebACLs request, and specify the NextMarker value // from the response in the NextMarker value in the next request. NextMarker *string + // An array of WebACLSummary () objects. + WebACLs []*types.WebACLSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/wafregional/api_op_ListXssMatchSets.go b/service/wafregional/api_op_ListXssMatchSets.go index 7af59cf73dd..4937095fefa 100644 --- a/service/wafregional/api_op_ListXssMatchSets.go +++ b/service/wafregional/api_op_ListXssMatchSets.go @@ -63,18 +63,18 @@ func (c *Client) ListXssMatchSets(ctx context.Context, params *ListXssMatchSetsI // A request to list the XssMatchSet () objects created by the current AWS account. type ListXssMatchSetsInput struct { + // Specifies the number of XssMatchSet () objects that you want AWS WAF to return + // for this request. If you have more XssMatchSet objects than the number you + // specify for Limit, the response includes a NextMarker value that you can use to + // get another batch of Rules. + Limit *int32 + // If you specify a value for Limit and you have more XssMatchSet () objects than // the value of Limit, AWS WAF returns a NextMarker value in the response that // allows you to list another group of XssMatchSets. For the second and subsequent // ListXssMatchSets requests, specify the value of NextMarker from the previous // response to get information about another batch of XssMatchSets. NextMarker *string - - // Specifies the number of XssMatchSet () objects that you want AWS WAF to return - // for this request. If you have more XssMatchSet objects than the number you - // specify for Limit, the response includes a NextMarker value that you can use to - // get another batch of Rules. - Limit *int32 } // The response to a ListXssMatchSets () request. diff --git a/service/wafregional/api_op_TagResource.go b/service/wafregional/api_op_TagResource.go index 9aae3d0e405..e875f90fd16 100644 --- a/service/wafregional/api_op_TagResource.go +++ b/service/wafregional/api_op_TagResource.go @@ -73,12 +73,12 @@ type TagResourceInput struct { // // // This member is required. - Tags []*types.Tag + ResourceARN *string // // // This member is required. - ResourceARN *string + Tags []*types.Tag } type TagResourceOutput struct { diff --git a/service/wafregional/api_op_UntagResource.go b/service/wafregional/api_op_UntagResource.go index 6deff43434e..416933166ab 100644 --- a/service/wafregional/api_op_UntagResource.go +++ b/service/wafregional/api_op_UntagResource.go @@ -65,12 +65,12 @@ type UntagResourceInput struct { // // // This member is required. - TagKeys []*string + ResourceARN *string // // // This member is required. - ResourceARN *string + TagKeys []*string } type UntagResourceOutput struct { diff --git a/service/wafregional/api_op_UpdateByteMatchSet.go b/service/wafregional/api_op_UpdateByteMatchSet.go index 080a439957a..52c6efa6946 100644 --- a/service/wafregional/api_op_UpdateByteMatchSet.go +++ b/service/wafregional/api_op_UpdateByteMatchSet.go @@ -106,6 +106,17 @@ func (c *Client) UpdateByteMatchSet(ctx context.Context, params *UpdateByteMatch type UpdateByteMatchSetInput struct { + // The ByteMatchSetId of the ByteMatchSet () that you want to update. + // ByteMatchSetId is returned by CreateByteMatchSet () and by ListByteMatchSets (). + // + // This member is required. + ByteMatchSetId *string + + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + // An array of ByteMatchSetUpdate objects that you want to insert into or delete // from a ByteMatchSet (). For more information, see the applicable data types: // @@ -120,17 +131,6 @@ type UpdateByteMatchSetInput struct { // // This member is required. Updates []*types.ByteMatchSetUpdate - - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string - - // The ByteMatchSetId of the ByteMatchSet () that you want to update. - // ByteMatchSetId is returned by CreateByteMatchSet () and by ListByteMatchSets (). - // - // This member is required. - ByteMatchSetId *string } type UpdateByteMatchSetOutput struct { diff --git a/service/wafregional/api_op_UpdateGeoMatchSet.go b/service/wafregional/api_op_UpdateGeoMatchSet.go index d810b634e18..c70fc2ce946 100644 --- a/service/wafregional/api_op_UpdateGeoMatchSet.go +++ b/service/wafregional/api_op_UpdateGeoMatchSet.go @@ -89,6 +89,17 @@ func (c *Client) UpdateGeoMatchSet(ctx context.Context, params *UpdateGeoMatchSe type UpdateGeoMatchSetInput struct { + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + + // The GeoMatchSetId of the GeoMatchSet () that you want to update. GeoMatchSetId + // is returned by CreateGeoMatchSet () and by ListGeoMatchSets (). + // + // This member is required. + GeoMatchSetId *string + // An array of GeoMatchSetUpdate objects that you want to insert into or delete // from an GeoMatchSet (). For more information, see the applicable data types: // @@ -102,17 +113,6 @@ type UpdateGeoMatchSetInput struct { // // This member is required. Updates []*types.GeoMatchSetUpdate - - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string - - // The GeoMatchSetId of the GeoMatchSet () that you want to update. GeoMatchSetId - // is returned by CreateGeoMatchSet () and by ListGeoMatchSets (). - // - // This member is required. - GeoMatchSetId *string } type UpdateGeoMatchSetOutput struct { diff --git a/service/wafregional/api_op_UpdateIPSet.go b/service/wafregional/api_op_UpdateIPSet.go index 50b05a475f9..8485bb6cd99 100644 --- a/service/wafregional/api_op_UpdateIPSet.go +++ b/service/wafregional/api_op_UpdateIPSet.go @@ -117,6 +117,11 @@ func (c *Client) UpdateIPSet(ctx context.Context, params *UpdateIPSetInput, optF type UpdateIPSetInput struct { + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + // The IPSetId of the IPSet () that you want to update. IPSetId is returned by // CreateIPSet () and by ListIPSets (). // @@ -137,11 +142,6 @@ type UpdateIPSetInput struct { // // This member is required. Updates []*types.IPSetUpdate - - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string } type UpdateIPSetOutput struct { diff --git a/service/wafregional/api_op_UpdateRateBasedRule.go b/service/wafregional/api_op_UpdateRateBasedRule.go index a9b7884f13d..04f58a744b0 100644 --- a/service/wafregional/api_op_UpdateRateBasedRule.go +++ b/service/wafregional/api_op_UpdateRateBasedRule.go @@ -92,6 +92,11 @@ func (c *Client) UpdateRateBasedRule(ctx context.Context, params *UpdateRateBase type UpdateRateBasedRuleInput struct { + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + // The maximum number of requests, which have an identical value in the field // specified by the RateKey, allowed in a five-minute period. If the number of // requests exceeds the RateLimit and the other predicates specified in the rule @@ -100,11 +105,6 @@ type UpdateRateBasedRuleInput struct { // This member is required. RateLimit *int64 - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string - // The RuleId of the RateBasedRule that you want to update. RuleId is returned by // CreateRateBasedRule and by ListRateBasedRules (). // diff --git a/service/wafregional/api_op_UpdateRegexMatchSet.go b/service/wafregional/api_op_UpdateRegexMatchSet.go index 4d5b8d86514..dfe0f2168e2 100644 --- a/service/wafregional/api_op_UpdateRegexMatchSet.go +++ b/service/wafregional/api_op_UpdateRegexMatchSet.go @@ -102,6 +102,11 @@ func (c *Client) UpdateRegexMatchSet(ctx context.Context, params *UpdateRegexMat type UpdateRegexMatchSetInput struct { + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + // The RegexMatchSetId of the RegexMatchSet () that you want to update. // RegexMatchSetId is returned by CreateRegexMatchSet () and by ListRegexMatchSets // (). @@ -114,11 +119,6 @@ type UpdateRegexMatchSetInput struct { // // This member is required. Updates []*types.RegexMatchSetUpdate - - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string } type UpdateRegexMatchSetOutput struct { diff --git a/service/wafregional/api_op_UpdateRegexPatternSet.go b/service/wafregional/api_op_UpdateRegexPatternSet.go index d4516224abd..498e094a561 100644 --- a/service/wafregional/api_op_UpdateRegexPatternSet.go +++ b/service/wafregional/api_op_UpdateRegexPatternSet.go @@ -101,11 +101,10 @@ func (c *Client) UpdateRegexPatternSet(ctx context.Context, params *UpdateRegexP type UpdateRegexPatternSetInput struct { - // An array of RegexPatternSetUpdate objects that you want to insert into or delete - // from a RegexPatternSet (). + // The value returned by the most recent call to GetChangeToken (). // // This member is required. - Updates []*types.RegexPatternSetUpdate + ChangeToken *string // The RegexPatternSetId of the RegexPatternSet () that you want to update. // RegexPatternSetId is returned by CreateRegexPatternSet () and by @@ -114,10 +113,11 @@ type UpdateRegexPatternSetInput struct { // This member is required. RegexPatternSetId *string - // The value returned by the most recent call to GetChangeToken (). + // An array of RegexPatternSetUpdate objects that you want to insert into or delete + // from a RegexPatternSet (). // // This member is required. - ChangeToken *string + Updates []*types.RegexPatternSetUpdate } type UpdateRegexPatternSetOutput struct { diff --git a/service/wafregional/api_op_UpdateRule.go b/service/wafregional/api_op_UpdateRule.go index 3cd1db5a8ac..d60297d99c6 100644 --- a/service/wafregional/api_op_UpdateRule.go +++ b/service/wafregional/api_op_UpdateRule.go @@ -101,6 +101,17 @@ func (c *Client) UpdateRule(ctx context.Context, params *UpdateRuleInput, optFns type UpdateRuleInput struct { + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + + // The RuleId of the Rule that you want to update. RuleId is returned by CreateRule + // and by ListRules (). + // + // This member is required. + RuleId *string + // An array of RuleUpdate objects that you want to insert into or delete from a // Rule (). For more information, see the applicable data types: // @@ -114,17 +125,6 @@ type UpdateRuleInput struct { // // This member is required. Updates []*types.RuleUpdate - - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string - - // The RuleId of the Rule that you want to update. RuleId is returned by CreateRule - // and by ListRules (). - // - // This member is required. - RuleId *string } type UpdateRuleOutput struct { diff --git a/service/wafregional/api_op_UpdateRuleGroup.go b/service/wafregional/api_op_UpdateRuleGroup.go index 340bf00c7e3..8e2f9a7d0dc 100644 --- a/service/wafregional/api_op_UpdateRuleGroup.go +++ b/service/wafregional/api_op_UpdateRuleGroup.go @@ -79,14 +79,10 @@ func (c *Client) UpdateRuleGroup(ctx context.Context, params *UpdateRuleGroupInp type UpdateRuleGroupInput struct { - // An array of RuleGroupUpdate objects that you want to insert into or delete from - // a RuleGroup (). You can only insert REGULAR rules into a rule group. - // ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to - // a WebACL. In this case you do not use ActivatedRule|Action. For all other update - // requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. + // The value returned by the most recent call to GetChangeToken (). // // This member is required. - Updates []*types.RuleGroupUpdate + ChangeToken *string // The RuleGroupId of the RuleGroup () that you want to update. RuleGroupId is // returned by CreateRuleGroup () and by ListRuleGroups (). @@ -94,10 +90,14 @@ type UpdateRuleGroupInput struct { // This member is required. RuleGroupId *string - // The value returned by the most recent call to GetChangeToken (). + // An array of RuleGroupUpdate objects that you want to insert into or delete from + // a RuleGroup (). You can only insert REGULAR rules into a rule group. + // ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to + // a WebACL. In this case you do not use ActivatedRule|Action. For all other update + // requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. // // This member is required. - ChangeToken *string + Updates []*types.RuleGroupUpdate } type UpdateRuleGroupOutput struct { diff --git a/service/wafregional/api_op_UpdateSizeConstraintSet.go b/service/wafregional/api_op_UpdateSizeConstraintSet.go index 050792b7c0c..de44d16aa75 100644 --- a/service/wafregional/api_op_UpdateSizeConstraintSet.go +++ b/service/wafregional/api_op_UpdateSizeConstraintSet.go @@ -109,6 +109,11 @@ func (c *Client) UpdateSizeConstraintSet(ctx context.Context, params *UpdateSize type UpdateSizeConstraintSetInput struct { + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + // The SizeConstraintSetId of the SizeConstraintSet () that you want to update. // SizeConstraintSetId is returned by CreateSizeConstraintSet () and by // ListSizeConstraintSets (). @@ -131,11 +136,6 @@ type UpdateSizeConstraintSetInput struct { // // This member is required. Updates []*types.SizeConstraintSetUpdate - - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string } type UpdateSizeConstraintSetOutput struct { diff --git a/service/wafregional/api_op_UpdateSqlInjectionMatchSet.go b/service/wafregional/api_op_UpdateSqlInjectionMatchSet.go index 570a325dd85..7959d40fc6f 100644 --- a/service/wafregional/api_op_UpdateSqlInjectionMatchSet.go +++ b/service/wafregional/api_op_UpdateSqlInjectionMatchSet.go @@ -102,6 +102,11 @@ func (c *Client) UpdateSqlInjectionMatchSet(ctx context.Context, params *UpdateS // A request to update a SqlInjectionMatchSet (). type UpdateSqlInjectionMatchSetInput struct { + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + // The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to update. // SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet () and by // ListSqlInjectionMatchSets (). @@ -123,11 +128,6 @@ type UpdateSqlInjectionMatchSetInput struct { // // This member is required. Updates []*types.SqlInjectionMatchSetUpdate - - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string } // The response to an UpdateSqlInjectionMatchSets () request. diff --git a/service/wafregional/api_op_UpdateWebACL.go b/service/wafregional/api_op_UpdateWebACL.go index fd1feb99c5c..7c04417fa74 100644 --- a/service/wafregional/api_op_UpdateWebACL.go +++ b/service/wafregional/api_op_UpdateWebACL.go @@ -115,6 +115,11 @@ func (c *Client) UpdateWebACL(ctx context.Context, params *UpdateWebACLInput, op type UpdateWebACLInput struct { + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + // The WebACLId of the WebACL () that you want to update. WebACLId is returned by // CreateWebACL () and by ListWebACLs (). // @@ -141,11 +146,6 @@ type UpdateWebACLInput struct { // // * WafAction (): Contains Type Updates []*types.WebACLUpdate - - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string } type UpdateWebACLOutput struct { diff --git a/service/wafregional/api_op_UpdateXssMatchSet.go b/service/wafregional/api_op_UpdateXssMatchSet.go index adae30356d0..8b7b1a5b1bf 100644 --- a/service/wafregional/api_op_UpdateXssMatchSet.go +++ b/service/wafregional/api_op_UpdateXssMatchSet.go @@ -101,6 +101,11 @@ func (c *Client) UpdateXssMatchSet(ctx context.Context, params *UpdateXssMatchSe // A request to update an XssMatchSet (). type UpdateXssMatchSetInput struct { + // The value returned by the most recent call to GetChangeToken (). + // + // This member is required. + ChangeToken *string + // An array of XssMatchSetUpdate objects that you want to insert into or delete // from an XssMatchSet (). For more information, see the applicable data types: // @@ -116,11 +121,6 @@ type UpdateXssMatchSetInput struct { // This member is required. Updates []*types.XssMatchSetUpdate - // The value returned by the most recent call to GetChangeToken (). - // - // This member is required. - ChangeToken *string - // The XssMatchSetId of the XssMatchSet that you want to update. XssMatchSetId is // returned by CreateXssMatchSet () and by ListXssMatchSets (). // diff --git a/service/wafregional/go.mod b/service/wafregional/go.mod index 3d49343d16b..49148db55fd 100644 --- a/service/wafregional/go.mod +++ b/service/wafregional/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/wafregional go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/wafregional/types/types.go b/service/wafregional/types/types.go index caf3dbf072f..5fddbfd28c1 100644 --- a/service/wafregional/types/types.go +++ b/service/wafregional/types/types.go @@ -19,18 +19,41 @@ import ( // Action parameter in the WebACLUpdate () data type. type ActivatedRule struct { - // Use the OverrideAction to test your RuleGroup. Any rule in a RuleGroup can - // potentially block a request. If you set the OverrideAction to None, the - // RuleGroup will block a request if any individual rule in the RuleGroup matches - // the request and is configured to block that request. However if you first want - // to test the RuleGroup, set the OverrideAction to Count. The RuleGroup will then - // override any block action specified by individual rules contained within the - // group. Instead of blocking matching requests, those requests will be counted. - // You can view a record of counted requests using GetSampledRequests (). - // ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to - // a WebACL. In this case you do not use ActivatedRule|Action. For all other update - // requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. - OverrideAction *WafOverrideAction + // Specifies the order in which the Rules in a WebACL are evaluated. Rules with a + // lower value for Priority are evaluated before Rules with a higher value. The + // value must be a unique integer. If you add multiple Rules to a WebACL, the + // values don't need to be consecutive. + // + // This member is required. + Priority *int32 + + // The RuleId for a Rule. You use RuleId to get more information about a Rule (see + // GetRule ()), update a Rule (see UpdateRule ()), insert a Rule into a WebACL or + // delete a one from a WebACL (see UpdateWebACL ()), or delete a Rule from AWS WAF + // (see DeleteRule ()). RuleId is returned by CreateRule () and by ListRules (). + // + // This member is required. + RuleId *string + + // Specifies the action that CloudFront or AWS WAF takes when a web request matches + // the conditions in the Rule. Valid values for Action include the following: + // + // + // * ALLOW: CloudFront responds with the requested object. + // + // * BLOCK: CloudFront + // responds with an HTTP 403 (Forbidden) status code. + // + // * COUNT: AWS WAF + // increments a counter of requests that match the conditions in the rule and then + // continues to inspect the web request based on the remaining rules in the web + // ACL. + // + // ActivatedRule|OverrideAction applies only when updating or adding a + // RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For + // all other update requests, ActivatedRule|Action is used instead of + // ActivatedRule|OverrideAction. + Action *WafAction // An array of rules to exclude from a rule group. This is applicable only when the // ActivatedRule refers to a RuleGroup. Sometimes it is necessary to troubleshoot @@ -68,6 +91,19 @@ type ActivatedRule struct { // ExcludedRules []*ExcludedRule + // Use the OverrideAction to test your RuleGroup. Any rule in a RuleGroup can + // potentially block a request. If you set the OverrideAction to None, the + // RuleGroup will block a request if any individual rule in the RuleGroup matches + // the request and is configured to block that request. However if you first want + // to test the RuleGroup, set the OverrideAction to Count. The RuleGroup will then + // override any block action specified by individual rules contained within the + // group. Instead of blocking matching requests, those requests will be counted. + // You can view a record of counted requests using GetSampledRequests (). + // ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to + // a WebACL. In this case you do not use ActivatedRule|Action. For all other update + // requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. + OverrideAction *WafOverrideAction + // The rule type, either REGULAR, as defined by Rule (), RATE_BASED, as defined by // RateBasedRule (), or GROUP, as defined by RuleGroup (). The default is REGULAR. // Although this field is optional, be aware that if you try to add a RATE_BASED @@ -75,42 +111,6 @@ type ActivatedRule struct { // fail because the request tries to add a REGULAR rule with the specified ID, // which does not exist. Type WafRuleType - - // Specifies the action that CloudFront or AWS WAF takes when a web request matches - // the conditions in the Rule. Valid values for Action include the following: - // - // - // * ALLOW: CloudFront responds with the requested object. - // - // * BLOCK: CloudFront - // responds with an HTTP 403 (Forbidden) status code. - // - // * COUNT: AWS WAF - // increments a counter of requests that match the conditions in the rule and then - // continues to inspect the web request based on the remaining rules in the web - // ACL. - // - // ActivatedRule|OverrideAction applies only when updating or adding a - // RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For - // all other update requests, ActivatedRule|Action is used instead of - // ActivatedRule|OverrideAction. - Action *WafAction - - // Specifies the order in which the Rules in a WebACL are evaluated. Rules with a - // lower value for Priority are evaluated before Rules with a higher value. The - // value must be a unique integer. If you add multiple Rules to a WebACL, the - // values don't need to be consecutive. - // - // This member is required. - Priority *int32 - - // The RuleId for a Rule. You use RuleId to get more information about a Rule (see - // GetRule ()), update a Rule (see UpdateRule ()), insert a Rule into a WebACL or - // delete a one from a WebACL (see UpdateWebACL ()), or delete a Rule from AWS WAF - // (see DeleteRule ()). RuleId is returned by CreateRule () and by ListRules (). - // - // This member is required. - RuleId *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -128,6 +128,16 @@ type ActivatedRule struct { // match the settings in only one ByteMatchTuple to be considered a match. type ByteMatchSet struct { + // The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information + // about a ByteMatchSet (see GetByteMatchSet ()), update a ByteMatchSet (see + // UpdateByteMatchSet ()), insert a ByteMatchSet into a Rule or delete one from a + // Rule (see UpdateRule ()), and delete a ByteMatchSet from AWS WAF (see + // DeleteByteMatchSet ()). ByteMatchSetId is returned by CreateByteMatchSet () and + // by ListByteMatchSets (). + // + // This member is required. + ByteMatchSetId *string + // Specifies the bytes (typically a string that corresponds with ASCII characters) // that you want AWS WAF to search for in web requests, the location in requests // that you want AWS WAF to search, and other settings. @@ -138,16 +148,6 @@ type ByteMatchSet struct { // A friendly name or description of the ByteMatchSet (). You can't change Name // after you create a ByteMatchSet. Name *string - - // The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information - // about a ByteMatchSet (see GetByteMatchSet ()), update a ByteMatchSet (see - // UpdateByteMatchSet ()), insert a ByteMatchSet into a Rule or delete one from a - // Rule (see UpdateRule ()), and delete a ByteMatchSet from AWS WAF (see - // DeleteByteMatchSet ()). ByteMatchSetId is returned by CreateByteMatchSet () and - // by ListByteMatchSets (). - // - // This member is required. - ByteMatchSetId *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -160,12 +160,6 @@ type ByteMatchSet struct { // includes the Name and ByteMatchSetId for one ByteMatchSet (). type ByteMatchSetSummary struct { - // A friendly name or description of the ByteMatchSet (). You can't change Name - // after you create a ByteMatchSet. - // - // This member is required. - Name *string - // The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information // about a ByteMatchSet, update a ByteMatchSet, remove a ByteMatchSet from a Rule, // and delete a ByteMatchSet from AWS WAF. ByteMatchSetId is returned by @@ -173,6 +167,12 @@ type ByteMatchSetSummary struct { // // This member is required. ByteMatchSetId *string + + // A friendly name or description of the ByteMatchSet (). You can't change Name + // after you create a ByteMatchSet. + // + // This member is required. + Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -211,52 +211,46 @@ type ByteMatchSetUpdate struct { // requests that you want AWS WAF to search, and other settings. type ByteMatchTuple struct { - // Text transformations eliminate some of the unusual formatting that attackers use - // in web requests in an effort to bypass AWS WAF. If you specify a transformation, - // AWS WAF performs the transformation on FieldToMatch before inspecting it for a - // match. You can only specify a single type of TextTransformation. CMD_LINE When - // you're concerned that attackers are injecting an operating system command line - // command and using unusual formatting to disguise some or all of the command, use - // this option to perform the following transformations: - // - // * Delete the - // following characters: \ " ' ^ + // The part of a web request that you want AWS WAF to search, such as a specified + // header or a query string. For more information, see FieldToMatch (). // - // * Delete spaces before the following - // characters: / ( + // This member is required. + FieldToMatch *FieldToMatch + + // Within the portion of a web request that you want to search (for example, in the + // query string, if any), specify where you want AWS WAF to search. Valid values + // include the following: CONTAINS The specified part of the web request must + // include the value of TargetString, but the location doesn't matter. + // CONTAINS_WORD The specified part of the web request must include the value of + // TargetString, and TargetString must contain only alphanumeric characters or + // underscore (A-Z, a-z, 0-9, or _). In addition, TargetString must be a word, + // which means one of the following: // - // * Replace the following characters with a space: , ; + // * TargetString exactly matches the value + // of the specified part of the web request, such as the value of a header. // // * - // Replace multiple spaces with one space + // TargetString is at the beginning of the specified part of the web request and is + // followed by a character other than an alphanumeric character or underscore (_), + // for example, BadBot;. // - // * Convert uppercase letters (A-Z) to - // lowercase (a-z) + // * TargetString is at the end of the specified part of + // the web request and is preceded by a character other than an alphanumeric + // character or underscore (_), for example, ;BadBot. // - //

          COMPRESS_WHITE_SPACE

          Use this option to - // replace the following characters with a space character (decimal 32):

            - //

          • \f, formfeed, decimal 12

          • \t, tab, decimal 9

            • - //

          • \n, newline, decimal 10

          • \r, carriage return, decimal - // 13

          • \v, vertical tab, decimal 11

          • non-breaking - // space, decimal 160

          COMPRESS_WHITE_SPACE also - // replaces multiple spaces with one space.

          HTML_ENTITY_DECODE

          - //

          Use this option to replace HTML-encoded characters with unencoded characters. - // HTML_ENTITY_DECODE performs the following operations:

          • - //

            Replaces (ampersand)quot; with "

          • - //

            Replaces (ampersand)nbsp; with a non-breaking space, decimal - // 160

          • Replaces (ampersand)lt; with a "less than" - // symbol

          • Replaces (ampersand)gt; with - // >

          • Replaces characters that are represented in - // hexadecimal format, (ampersand)#xhhhh;, with the corresponding - // characters

          • Replaces characters that are represented in decimal - // format, (ampersand)#nnnn;, with the corresponding characters

            - //

          LOWERCASE

          Use this option to convert uppercase - // letters (A-Z) to lowercase (a-z).

          URL_DECODE

          Use this - // option to decode a URL-encoded value.

          NONE

          Specify - // NONE if you don't want to perform any text transformations.

          + // * TargetString is in the + // middle of the specified part of the web request and is preceded and followed by + // characters other than alphanumeric characters or underscore (_), for example, + // -BadBot;. + // + // EXACTLY The value of the specified part of the web request must + // exactly match the value of TargetString. STARTS_WITH The value of TargetString + // must appear at the beginning of the specified part of the web request. ENDS_WITH + // The value of TargetString must appear at the end of the specified part of the + // web request. // // This member is required. - TextTransformation TextTransformation + PositionalConstraint PositionalConstraint // The value that you want AWS WAF to search for. AWS WAF searches for the // specified string in the part of web requests that you specified in FieldToMatch. @@ -313,46 +307,52 @@ type ByteMatchTuple struct { // This member is required. TargetString []byte - // The part of a web request that you want AWS WAF to search, such as a specified - // header or a query string. For more information, see FieldToMatch (). + // Text transformations eliminate some of the unusual formatting that attackers use + // in web requests in an effort to bypass AWS WAF. If you specify a transformation, + // AWS WAF performs the transformation on FieldToMatch before inspecting it for a + // match. You can only specify a single type of TextTransformation. CMD_LINE When + // you're concerned that attackers are injecting an operating system command line + // command and using unusual formatting to disguise some or all of the command, use + // this option to perform the following transformations: // - // This member is required. - FieldToMatch *FieldToMatch - - // Within the portion of a web request that you want to search (for example, in the - // query string, if any), specify where you want AWS WAF to search. Valid values - // include the following: CONTAINS The specified part of the web request must - // include the value of TargetString, but the location doesn't matter. - // CONTAINS_WORD The specified part of the web request must include the value of - // TargetString, and TargetString must contain only alphanumeric characters or - // underscore (A-Z, a-z, 0-9, or _). In addition, TargetString must be a word, - // which means one of the following: + // * Delete the + // following characters: \ " ' ^ // - // * TargetString exactly matches the value - // of the specified part of the web request, such as the value of a header. + // * Delete spaces before the following + // characters: / ( // - // * - // TargetString is at the beginning of the specified part of the web request and is - // followed by a character other than an alphanumeric character or underscore (_), - // for example, BadBot;. + // * Replace the following characters with a space: , ; // - // * TargetString is at the end of the specified part of - // the web request and is preceded by a character other than an alphanumeric - // character or underscore (_), for example, ;BadBot. + // * + // Replace multiple spaces with one space // - // * TargetString is in the - // middle of the specified part of the web request and is preceded and followed by - // characters other than alphanumeric characters or underscore (_), for example, - // -BadBot;. + // * Convert uppercase letters (A-Z) to + // lowercase (a-z) // - // EXACTLY The value of the specified part of the web request must - // exactly match the value of TargetString. STARTS_WITH The value of TargetString - // must appear at the beginning of the specified part of the web request. ENDS_WITH - // The value of TargetString must appear at the end of the specified part of the - // web request. + //

          COMPRESS_WHITE_SPACE

          Use this option to + // replace the following characters with a space character (decimal 32):

            + //

          • \f, formfeed, decimal 12

          • \t, tab, decimal 9

            • + //

          • \n, newline, decimal 10

          • \r, carriage return, decimal + // 13

          • \v, vertical tab, decimal 11

          • non-breaking + // space, decimal 160

          COMPRESS_WHITE_SPACE also + // replaces multiple spaces with one space.

          HTML_ENTITY_DECODE

          + //

          Use this option to replace HTML-encoded characters with unencoded characters. + // HTML_ENTITY_DECODE performs the following operations:

          • + //

            Replaces (ampersand)quot; with "

          • + //

            Replaces (ampersand)nbsp; with a non-breaking space, decimal + // 160

          • Replaces (ampersand)lt; with a "less than" + // symbol

          • Replaces (ampersand)gt; with + // >

          • Replaces characters that are represented in + // hexadecimal format, (ampersand)#xhhhh;, with the corresponding + // characters

          • Replaces characters that are represented in decimal + // format, (ampersand)#nnnn;, with the corresponding characters

            + //

          LOWERCASE

          Use this option to convert uppercase + // letters (A-Z) to lowercase (a-z).

          URL_DECODE

          Use this + // option to decode a URL-encoded value.

          NONE

          Specify + // NONE if you don't want to perform any text transformations.

          // // This member is required. - PositionalConstraint PositionalConstraint + TextTransformation TextTransformation } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -460,9 +460,11 @@ type GeoMatchConstraint struct { // global use. Contains one or more countries that AWS WAF will search for. type GeoMatchSet struct { - // A friendly name or description of the GeoMatchSet (). You can't change the name - // of an GeoMatchSet after you create it. - Name *string + // An array of GeoMatchConstraint () objects, which contain the country that you + // want AWS WAF to search for. + // + // This member is required. + GeoMatchConstraints []*GeoMatchConstraint // The GeoMatchSetId for an GeoMatchSet. You use GeoMatchSetId to get information // about a GeoMatchSet (see GeoMatchSet ()), update a GeoMatchSet (see @@ -474,11 +476,9 @@ type GeoMatchSet struct { // This member is required. GeoMatchSetId *string - // An array of GeoMatchConstraint () objects, which contain the country that you - // want AWS WAF to search for. - // - // This member is required. - GeoMatchConstraints []*GeoMatchConstraint + // A friendly name or description of the GeoMatchSet (). You can't change the name + // of an GeoMatchSet after you create it. + Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -556,11 +556,25 @@ type HTTPHeader struct { // returned by GetSampledRequests. type HTTPRequest struct { + // The IP address that the request originated from. If the WebACL is associated + // with a CloudFront distribution, this is the value of one of the following fields + // in CloudFront access logs: + // + // * c-ip, if the viewer did not use an HTTP proxy + // or a load balancer to send the request + // + // * x-forwarded-for, if the viewer did + // use an HTTP proxy or a load balancer to send the request + ClientIP *string + // The two-letter country code for the country that the request originated from. // For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2 // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Country *string + // The HTTP version specified in the sampled web request, for example, HTTP/1.1. + HTTPVersion *string + // A complex type that contains two values for each header in the sampled web // request: the name of the header and the value of the header. Headers []*HTTPHeader @@ -569,20 +583,6 @@ type HTTPRequest struct { // following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. Method *string - // The HTTP version specified in the sampled web request, for example, HTTP/1.1. - HTTPVersion *string - - // The IP address that the request originated from. If the WebACL is associated - // with a CloudFront distribution, this is the value of one of the following fields - // in CloudFront access logs: - // - // * c-ip, if the viewer did not use an HTTP proxy - // or a load balancer to send the request - // - // * x-forwarded-for, if the viewer did - // use an HTTP proxy or a load balancer to send the request - ClientIP *string - // The part of a web request that identifies the resource, for example, // /images/daily-ad.jpg. URI *string @@ -638,6 +638,11 @@ type IPSet struct { // range (in CIDR format) that web requests originate from. type IPSetDescriptor struct { + // Specify IPV4 or IPV6. + // + // This member is required. + Type IPSetDescriptorType + // Specify an IPv4 address by using CIDR notation. For example: // // * To configure @@ -663,11 +668,6 @@ type IPSetDescriptor struct { // // This member is required. Value *string - - // Specify IPV4 or IPV6. - // - // This member is required. - Type IPSetDescriptorType } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -679,17 +679,17 @@ type IPSetDescriptor struct { // global use. Contains the identifier and the name of the IPSet. type IPSetSummary struct { - // A friendly name or description of the IPSet (). You can't change the name of an - // IPSet after you create it. - // - // This member is required. - Name *string - // The IPSetId for an IPSet (). You can use IPSetId in a GetIPSet () request to get // detailed information about an IPSet (). // // This member is required. IPSetId *string + + // A friendly name or description of the IPSet (). You can't change the name of an + // IPSet after you create it. + // + // This member is required. + Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -702,16 +702,16 @@ type IPSetSummary struct { // UpdateIPSet (). type IPSetUpdate struct { - // The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) - // that web requests originate from. + // Specifies whether to insert or delete an IP address with UpdateIPSet (). // // This member is required. - IPSetDescriptor *IPSetDescriptor + Action ChangeAction - // Specifies whether to insert or delete an IP address with UpdateIPSet (). + // The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) + // that web requests originate from. // // This member is required. - Action ChangeAction + IPSetDescriptor *IPSetDescriptor } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -724,9 +724,10 @@ type IPSetUpdate struct { // the web ACL Amazon Resource Name (ARN). type LoggingConfiguration struct { - // The parts of the request that you want redacted from the logs. For example, if - // you redact the cookie field, the cookie field in the firehose will be xxx. - RedactedFields []*FieldToMatch + // An array of Amazon Kinesis Data Firehose ARNs. + // + // This member is required. + LogDestinationConfigs []*string // The Amazon Resource Name (ARN) of the web ACL that you want to associate with // LogDestinationConfigs. @@ -734,10 +735,9 @@ type LoggingConfiguration struct { // This member is required. ResourceArn *string - // An array of Amazon Kinesis Data Firehose ARNs. - // - // This member is required. - LogDestinationConfigs []*string + // The parts of the request that you want redacted from the logs. For example, if + // you redact the cookie field, the cookie field in the firehose will be xxx. + RedactedFields []*FieldToMatch } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -753,10 +753,11 @@ type LoggingConfiguration struct { // from the IP address 192.0.2.44. type Predicate struct { - // The type of predicate in a Rule, such as ByteMatch or IPSet. + // A unique identifier for a predicate in a Rule, such as ByteMatchSetId or + // IPSetId. The ID is returned by the corresponding Create or List command. // // This member is required. - Type PredicateType + DataId *string // Set Negated to False if you want AWS WAF to allow, block, or count requests // based on the settings in the specified ByteMatchSet (), IPSet (), @@ -772,11 +773,10 @@ type Predicate struct { // This member is required. Negated *bool - // A unique identifier for a predicate in a Rule, such as ByteMatchSetId or - // IPSetId. The ID is returned by the corresponding Create or List command. + // The type of predicate in a Rule, such as ByteMatch or IPSet. // // This member is required. - DataId *string + Type PredicateType } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -802,12 +802,20 @@ type Predicate struct { // count), which is defined in the web ACL. type RateBasedRule struct { - // A friendly name or description for the metrics for a RateBasedRule. The name can - // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 - // and minimum length one. It can't contain whitespace or metric names reserved for - // AWS WAF, including "All" and "Default_Action." You can't change the name of the - // metric after you create the RateBasedRule. - MetricName *string + // The Predicates object contains one Predicate element for each ByteMatchSet (), + // IPSet (), or SqlInjectionMatchSet () object that you want to include in a + // RateBasedRule. + // + // This member is required. + MatchPredicates []*Predicate + + // The field that AWS WAF uses to determine if requests are likely arriving from + // single source and thus subject to rate monitoring. The only valid value for + // RateKey is IP. IP indicates that requests arriving from the same IP address are + // subject to the RateLimit that is specified in the RateBasedRule. + // + // This member is required. + RateKey RateKey // The maximum number of requests, which have an identical value in the field // specified by the RateKey, allowed in a five-minute period. If the number of @@ -817,13 +825,6 @@ type RateBasedRule struct { // This member is required. RateLimit *int64 - // The Predicates object contains one Predicate element for each ByteMatchSet (), - // IPSet (), or SqlInjectionMatchSet () object that you want to include in a - // RateBasedRule. - // - // This member is required. - MatchPredicates []*Predicate - // A unique identifier for a RateBasedRule. You use RuleId to get more information // about a RateBasedRule (see GetRateBasedRule ()), update a RateBasedRule (see // UpdateRateBasedRule ()), insert a RateBasedRule into a WebACL or delete one from @@ -833,13 +834,12 @@ type RateBasedRule struct { // This member is required. RuleId *string - // The field that AWS WAF uses to determine if requests are likely arriving from - // single source and thus subject to rate monitoring. The only valid value for - // RateKey is IP. IP indicates that requests arriving from the same IP address are - // subject to the RateLimit that is specified in the RateBasedRule. - // - // This member is required. - RateKey RateKey + // A friendly name or description for the metrics for a RateBasedRule. The name can + // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 + // and minimum length one. It can't contain whitespace or metric names reserved for + // AWS WAF, including "All" and "Default_Action." You can't change the name of the + // metric after you create the RateBasedRule. + MetricName *string // A friendly name or description for a RateBasedRule. You can't change the name of // a RateBasedRule after you create it. @@ -926,6 +926,11 @@ type RegexMatchSetSummary struct { // the RegexMatchTuple. type RegexMatchSetUpdate struct { + // Specifies whether to insert or delete a RegexMatchTuple (). + // + // This member is required. + Action ChangeAction + // Information about the part of a web request that you want AWS WAF to inspect and // the identifier of the regular expression (regex) pattern that you want AWS WAF // to search for. If you specify DELETE for the value of Action, the @@ -934,11 +939,6 @@ type RegexMatchSetUpdate struct { // // This member is required. RegexMatchTuple *RegexMatchTuple - - // Specifies whether to insert or delete a RegexMatchTuple (). - // - // This member is required. - Action ChangeAction } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -964,6 +964,22 @@ type RegexMatchSetUpdate struct { // string. type RegexMatchTuple struct { + // Specifies where in a web request to look for the RegexPatternSet. + // + // This member is required. + FieldToMatch *FieldToMatch + + // The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get + // information about a RegexPatternSet (see GetRegexPatternSet ()), update a + // RegexPatternSet (see UpdateRegexPatternSet ()), insert a RegexPatternSet into a + // RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet ()), + // and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet ()). + // RegexPatternSetId is returned by CreateRegexPatternSet () and by + // ListRegexPatternSets (). + // + // This member is required. + RegexPatternSetId *string + // Text transformations eliminate some of the unusual formatting that attackers use // in web requests in an effort to bypass AWS WAF. If you specify a transformation, // AWS WAF performs the transformation on RegexPatternSet before inspecting a @@ -1010,22 +1026,6 @@ type RegexMatchTuple struct { // // This member is required. TextTransformation TextTransformation - - // The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get - // information about a RegexPatternSet (see GetRegexPatternSet ()), update a - // RegexPatternSet (see UpdateRegexPatternSet ()), insert a RegexPatternSet into a - // RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet ()), - // and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet ()). - // RegexPatternSetId is returned by CreateRegexPatternSet () and by - // ListRegexPatternSets (). - // - // This member is required. - RegexPatternSetId *string - - // Specifies where in a web request to look for the RegexPatternSet. - // - // This member is required. - FieldToMatch *FieldToMatch } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1039,6 +1039,15 @@ type RegexMatchTuple struct { // configure AWS WAF to reject those requests. type RegexPatternSet struct { + // The identifier for the RegexPatternSet. You use RegexPatternSetId to get + // information about a RegexPatternSet, update a RegexPatternSet, remove a + // RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF. + // RegexMatchSetId is returned by CreateRegexPatternSet () and by + // ListRegexPatternSets (). + // + // This member is required. + RegexPatternSetId *string + // Specifies the regular expression (regex) patterns that you want AWS WAF to // search for, such as B[a@]dB[o0]t. // @@ -1048,15 +1057,6 @@ type RegexPatternSet struct { // A friendly name or description of the RegexPatternSet (). You can't change Name // after you create a RegexPatternSet. Name *string - - // The identifier for the RegexPatternSet. You use RegexPatternSetId to get - // information about a RegexPatternSet, update a RegexPatternSet, remove a - // RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF. - // RegexMatchSetId is returned by CreateRegexPatternSet () and by - // ListRegexPatternSets (). - // - // This member is required. - RegexPatternSetId *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1069,6 +1069,12 @@ type RegexPatternSet struct { // object includes the Name and RegexPatternSetId for one RegexPatternSet (). type RegexPatternSetSummary struct { + // A friendly name or description of the RegexPatternSet (). You can't change Name + // after you create a RegexPatternSet. + // + // This member is required. + Name *string + // The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get // information about a RegexPatternSet, update a RegexPatternSet, remove a // RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF. @@ -1077,12 +1083,6 @@ type RegexPatternSetSummary struct { // // This member is required. RegexPatternSetId *string - - // A friendly name or description of the RegexPatternSet (). You can't change Name - // after you create a RegexPatternSet. - // - // This member is required. - Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1146,16 +1146,16 @@ type Rule struct { // This member is required. RuleId *string - // The friendly name or description for the Rule. You can't change the name of a - // Rule after you create it. - Name *string - // A friendly name or description for the metrics for this Rule. The name can // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 // and minimum length one. It can't contain whitespace or metric names reserved for // AWS WAF, including "All" and "Default_Action." You can't change MetricName after // you create the Rule. MetricName *string + + // The friendly name or description for the Rule. You can't change the name of a + // Rule after you create it. + Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1172,20 +1172,9 @@ type Rule struct { // support. // // * One rule group per web ACL. -// -// * Ten rules per rule group. -type RuleGroup struct { - - // The friendly name or description for the RuleGroup. You can't change the name of - // a RuleGroup after you create it. - Name *string - - // A friendly name or description for the metrics for this RuleGroup. The name can - // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 - // and minimum length one. It can't contain whitespace or metric names reserved for - // AWS WAF, including "All" and "Default_Action." You can't change the name of the - // metric after you create the RuleGroup. - MetricName *string +// +// * Ten rules per rule group. +type RuleGroup struct { // A unique identifier for a RuleGroup. You use RuleGroupId to get more information // about a RuleGroup (see GetRuleGroup ()), update a RuleGroup (see UpdateRuleGroup @@ -1195,6 +1184,17 @@ type RuleGroup struct { // // This member is required. RuleGroupId *string + + // A friendly name or description for the metrics for this RuleGroup. The name can + // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 + // and minimum length one. It can't contain whitespace or metric names reserved for + // AWS WAF, including "All" and "Default_Action." You can't change the name of the + // metric after you create the RuleGroup. + MetricName *string + + // The friendly name or description for the RuleGroup. You can't change the name of + // a RuleGroup after you create it. + Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1207,6 +1207,12 @@ type RuleGroup struct { // RuleGroup. type RuleGroupSummary struct { + // A friendly name or description of the RuleGroup (). You can't change the name of + // a RuleGroup after you create it. + // + // This member is required. + Name *string + // A unique identifier for a RuleGroup. You use RuleGroupId to get more information // about a RuleGroup (see GetRuleGroup ()), update a RuleGroup (see UpdateRuleGroup // ()), insert a RuleGroup into a WebACL or delete one from a WebACL (see @@ -1215,12 +1221,6 @@ type RuleGroupSummary struct { // // This member is required. RuleGroupId *string - - // A friendly name or description of the RuleGroup (). You can't change the name of - // a RuleGroup after you create it. - // - // This member is required. - Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1257,6 +1257,12 @@ type RuleGroupUpdate struct { // Rule. type RuleSummary struct { + // A friendly name or description of the Rule (). You can't change the name of a + // Rule after you create it. + // + // This member is required. + Name *string + // A unique identifier for a Rule. You use RuleId to get more information about a // Rule (see GetRule ()), update a Rule (see UpdateRule ()), insert a Rule into a // WebACL or delete one from a WebACL (see UpdateWebACL ()), or delete a Rule from @@ -1265,12 +1271,6 @@ type RuleSummary struct { // // This member is required. RuleId *string - - // A friendly name or description of the Rule (). You can't change the name of a - // Rule after you create it. - // - // This member is required. - Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1283,16 +1283,16 @@ type RuleSummary struct { // want to add it to a Rule or delete it from a Rule. type RuleUpdate struct { - // The ID of the Predicate (such as an IPSet) that you want to add to a Rule. - // - // This member is required. - Predicate *Predicate - // Specify INSERT to add a Predicate to a Rule. Use DELETE to remove a Predicate // from a Rule. // // This member is required. Action ChangeAction + + // The ID of the Predicate (such as an IPSet) that you want to add to a Rule. + // + // This member is required. + Predicate *Predicate } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1312,13 +1312,6 @@ type SampledHTTPRequest struct { // This member is required. Request *HTTPRequest - // The time at which AWS WAF received the request from your AWS resource, in Unix - // time format (in seconds). - Timestamp *time.Time - - // The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT. - Action *string - // A value that indicates how one result in the response relates proportionally to // other results in the response. A result that has a weight of 2 represents // roughly twice as many CloudFront web requests as a result that has a weight of @@ -1327,11 +1320,18 @@ type SampledHTTPRequest struct { // This member is required. Weight *int64 + // The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT. + Action *string + // This value is returned if the GetSampledRequests request specifies the ID of a // RuleGroup rather than the ID of an individual rule. RuleWithinRuleGroup is the // rule within the specified RuleGroup that matched the request listed in the // response. RuleWithinRuleGroup *string + + // The time at which AWS WAF received the request from your AWS resource, in Unix + // time format (in seconds). + Timestamp *time.Time } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1346,6 +1346,25 @@ type SampledHTTPRequest struct { // expression is true, the SizeConstraint is considered to match. type SizeConstraint struct { + // The type of comparison you want AWS WAF to perform. AWS WAF uses this in + // combination with the provided Size and FieldToMatch to build an expression in + // the form of "SizeComparisonOperator size in bytes of FieldToMatch". If that + // expression is true, the SizeConstraint is considered to match. EQ: Used to test + // if the Size is equal to the size of the FieldToMatch NE: Used to test if the + // Size is not equal to the size of the FieldToMatch LE: Used to test if the Size + // is less than or equal to the size of the FieldToMatch LT: Used to test if the + // Size is strictly less than the size of the FieldToMatch GE: Used to test if the + // Size is greater than or equal to the size of the FieldToMatch GT: Used to test + // if the Size is strictly greater than the size of the FieldToMatch + // + // This member is required. + ComparisonOperator ComparisonOperator + + // Specifies where in a web request to look for the size constraint. + // + // This member is required. + FieldToMatch *FieldToMatch + // The size in bytes that you want AWS WAF to compare against the size of the // specified FieldToMatch. AWS WAF uses this in combination with ComparisonOperator // and FieldToMatch to build an expression in the form of "SizeComparisonOperator @@ -1429,25 +1448,6 @@ type SizeConstraint struct { // // This member is required. TextTransformation TextTransformation - - // Specifies where in a web request to look for the size constraint. - // - // This member is required. - FieldToMatch *FieldToMatch - - // The type of comparison you want AWS WAF to perform. AWS WAF uses this in - // combination with the provided Size and FieldToMatch to build an expression in - // the form of "SizeComparisonOperator size in bytes of FieldToMatch". If that - // expression is true, the SizeConstraint is considered to match. EQ: Used to test - // if the Size is equal to the size of the FieldToMatch NE: Used to test if the - // Size is not equal to the size of the FieldToMatch LE: Used to test if the Size - // is less than or equal to the size of the FieldToMatch LT: Used to test if the - // Size is strictly less than the size of the FieldToMatch GE: Used to test if the - // Size is greater than or equal to the size of the FieldToMatch GT: Used to test - // if the Size is strictly greater than the size of the FieldToMatch - // - // This member is required. - ComparisonOperator ComparisonOperator } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1462,14 +1462,6 @@ type SizeConstraint struct { // needs to match one constraint to be considered a match. type SizeConstraintSet struct { - // Specifies the parts of web requests that you want to inspect the size of. - // - // This member is required. - SizeConstraints []*SizeConstraint - - // The name, if any, of the SizeConstraintSet. - Name *string - // A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get // information about a SizeConstraintSet (see GetSizeConstraintSet ()), update a // SizeConstraintSet (see UpdateSizeConstraintSet ()), insert a SizeConstraintSet @@ -1480,6 +1472,14 @@ type SizeConstraintSet struct { // // This member is required. SizeConstraintSetId *string + + // Specifies the parts of web requests that you want to inspect the size of. + // + // This member is required. + SizeConstraints []*SizeConstraint + + // The name, if any, of the SizeConstraintSet. + Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1491,6 +1491,11 @@ type SizeConstraintSet struct { // global use. The Id and Name of a SizeConstraintSet. type SizeConstraintSetSummary struct { + // The name of the SizeConstraintSet, if any. + // + // This member is required. + Name *string + // A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get // information about a SizeConstraintSet (see GetSizeConstraintSet ()), update a // SizeConstraintSet (see UpdateSizeConstraintSet ()), insert a SizeConstraintSet @@ -1501,11 +1506,6 @@ type SizeConstraintSetSummary struct { // // This member is required. SizeConstraintSetId *string - - // The name of the SizeConstraintSet, if any. - // - // This member is required. - Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1548,15 +1548,6 @@ type SizeConstraintSetUpdate struct { // in only one of the specified parts of the request to be considered a match. type SqlInjectionMatchSet struct { - // The name, if any, of the SqlInjectionMatchSet. - Name *string - - // Specifies the parts of web requests that you want to inspect for snippets of - // malicious SQL code. - // - // This member is required. - SqlInjectionMatchTuples []*SqlInjectionMatchTuple - // A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId // to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet // ()), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet ()), insert a @@ -1567,6 +1558,15 @@ type SqlInjectionMatchSet struct { // // This member is required. SqlInjectionMatchSetId *string + + // Specifies the parts of web requests that you want to inspect for snippets of + // malicious SQL code. + // + // This member is required. + SqlInjectionMatchTuples []*SqlInjectionMatchTuple + + // The name, if any, of the SqlInjectionMatchSet. + Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1607,19 +1607,19 @@ type SqlInjectionMatchSetSummary struct { // SqlInjectionMatchSet. type SqlInjectionMatchSetUpdate struct { - // Specifies the part of a web request that you want AWS WAF to inspect for - // snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the - // name of the header. - // - // This member is required. - SqlInjectionMatchTuple *SqlInjectionMatchTuple - // Specify INSERT to add a SqlInjectionMatchSetUpdate () to a SqlInjectionMatchSet // (). Use DELETE to remove a SqlInjectionMatchSetUpdate from a // SqlInjectionMatchSet. // // This member is required. Action ChangeAction + + // Specifies the part of a web request that you want AWS WAF to inspect for + // snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the + // name of the header. + // + // This member is required. + SqlInjectionMatchTuple *SqlInjectionMatchTuple } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1718,12 +1718,6 @@ type SqlInjectionMatchTuple struct { // global use. A summary of the rule groups you are subscribed to. type SubscribedRuleGroupSummary struct { - // A friendly name or description of the RuleGroup. You can't change the name of a - // RuleGroup after you create it. - // - // This member is required. - Name *string - // A friendly name or description for the metrics for this RuleGroup. The name can // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 // and minimum length one. It can't contain whitespace or metric names reserved for @@ -1733,6 +1727,12 @@ type SubscribedRuleGroupSummary struct { // This member is required. MetricName *string + // A friendly name or description of the RuleGroup. You can't change the name of a + // RuleGroup after you create it. + // + // This member is required. + Name *string + // A unique identifier for a RuleGroup. // // This member is required. @@ -1808,23 +1808,23 @@ type TagInfoForResource struct { // is the time that AWS WAF received the 5,000th request. type TimeWindow struct { - // The beginning of the time range from which you want GetSampledRequests to return - // a sample of the requests that your AWS resource received. You must specify the + // The end of the time range from which you want GetSampledRequests to return a + // sample of the requests that your AWS resource received. You must specify the // date and time in Coordinated Universal Time (UTC) format. UTC format includes // the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any // time range in the previous three hours. // // This member is required. - StartTime *time.Time + EndTime *time.Time - // The end of the time range from which you want GetSampledRequests to return a - // sample of the requests that your AWS resource received. You must specify the + // The beginning of the time range from which you want GetSampledRequests to return + // a sample of the requests that your AWS resource received. You must specify the // date and time in Coordinated Universal Time (UTC) format. UTC format includes // the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any // time range in the previous three hours. // // This member is required. - EndTime *time.Time + StartTime *time.Time } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1890,9 +1890,11 @@ type WafOverrideAction struct { // allowed, blocked, or counted. For more information, see UpdateWebACL (). type WebACL struct { - // A friendly name or description of the WebACL. You can't change the name of a - // WebACL after you create it. - Name *string + // The action to perform if none of the Rules contained in the WebACL match. The + // action is specified by the WafAction () object. + // + // This member is required. + DefaultAction *WafAction // An array that contains the action for each Rule in a WebACL, the priority of the // Rule, and the ID of the Rule. @@ -1900,8 +1902,13 @@ type WebACL struct { // This member is required. Rules []*ActivatedRule - // Tha Amazon Resource Name (ARN) of the web ACL. - WebACLArn *string + // A unique identifier for a WebACL. You use WebACLId to get information about a + // WebACL (see GetWebACL ()), update a WebACL (see UpdateWebACL ()), and delete a + // WebACL from AWS WAF (see DeleteWebACL ()). WebACLId is returned by CreateWebACL + // () and by ListWebACLs (). + // + // This member is required. + WebACLId *string // A friendly name or description for the metrics for this WebACL. The name can // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 @@ -1910,19 +1917,12 @@ type WebACL struct { // you create the WebACL. MetricName *string - // The action to perform if none of the Rules contained in the WebACL match. The - // action is specified by the WafAction () object. - // - // This member is required. - DefaultAction *WafAction + // A friendly name or description of the WebACL. You can't change the name of a + // WebACL after you create it. + Name *string - // A unique identifier for a WebACL. You use WebACLId to get information about a - // WebACL (see GetWebACL ()), update a WebACL (see UpdateWebACL ()), and delete a - // WebACL from AWS WAF (see DeleteWebACL ()). WebACLId is returned by CreateWebACL - // () and by ListWebACLs (). - // - // This member is required. - WebACLId *string + // Tha Amazon Resource Name (ARN) of the web ACL. + WebACLArn *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1935,6 +1935,12 @@ type WebACL struct { // (). type WebACLSummary struct { + // A friendly name or description of the WebACL (). You can't change the name of a + // WebACL after you create it. + // + // This member is required. + Name *string + // A unique identifier for a WebACL. You use WebACLId to get information about a // WebACL (see GetWebACL ()), update a WebACL (see UpdateWebACL ()), and delete a // WebACL from AWS WAF (see DeleteWebACL ()). WebACLId is returned by CreateWebACL @@ -1942,12 +1948,6 @@ type WebACLSummary struct { // // This member is required. WebACLId *string - - // A friendly name or description of the WebACL (). You can't change the name of a - // WebACL after you create it. - // - // This member is required. - Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1960,6 +1960,11 @@ type WebACLSummary struct { // WebACL. type WebACLUpdate struct { + // Specifies whether to insert a Rule into or delete a Rule from a WebACL. + // + // This member is required. + Action ChangeAction + // The ActivatedRule object in an UpdateWebACL () request specifies a Rule that you // want to insert or delete, the priority of the Rule in the WebACL, and the action // that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, @@ -1967,11 +1972,6 @@ type WebACLUpdate struct { // // This member is required. ActivatedRule *ActivatedRule - - // Specifies whether to insert a Rule into or delete a Rule from a WebACL. - // - // This member is required. - Action ChangeAction } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic @@ -1988,15 +1988,6 @@ type WebACLUpdate struct { // of the request to be considered a match. type XssMatchSet struct { - // Specifies the parts of web requests that you want to inspect for cross-site - // scripting attacks. - // - // This member is required. - XssMatchTuples []*XssMatchTuple - - // The name, if any, of the XssMatchSet. - Name *string - // A unique identifier for an XssMatchSet. You use XssMatchSetId to get information // about an XssMatchSet (see GetXssMatchSet ()), update an XssMatchSet (see // UpdateXssMatchSet ()), insert an XssMatchSet into a Rule or delete one from a @@ -2006,6 +1997,15 @@ type XssMatchSet struct { // // This member is required. XssMatchSetId *string + + // Specifies the parts of web requests that you want to inspect for cross-site + // scripting attacks. + // + // This member is required. + XssMatchTuples []*XssMatchTuple + + // The name, if any, of the XssMatchSet. + Name *string } // This is AWS WAF Classic documentation. For more information, see AWS WAF Classic diff --git a/service/wafv2/api_op_AssociateWebACL.go b/service/wafv2/api_op_AssociateWebACL.go index c231f34a469..31a7e79815d 100644 --- a/service/wafv2/api_op_AssociateWebACL.go +++ b/service/wafv2/api_op_AssociateWebACL.go @@ -66,12 +66,6 @@ func (c *Client) AssociateWebACL(ctx context.Context, params *AssociateWebACLInp type AssociateWebACLInput struct { - // The Amazon Resource Name (ARN) of the Web ACL that you want to associate with - // the resource. - // - // This member is required. - WebACLArn *string - // The Amazon Resource Name (ARN) of the resource to associate with the web ACL. //

          The ARN must be in one of the following formats:

          • For an // Application Load Balancer: @@ -82,6 +76,12 @@ type AssociateWebACLInput struct { // // This member is required. ResourceArn *string + + // The Amazon Resource Name (ARN) of the Web ACL that you want to associate with + // the resource. + // + // This member is required. + WebACLArn *string } type AssociateWebACLOutput struct { diff --git a/service/wafv2/api_op_CreateIPSet.go b/service/wafv2/api_op_CreateIPSet.go index 303f109b814..8f6944afae8 100644 --- a/service/wafv2/api_op_CreateIPSet.go +++ b/service/wafv2/api_op_CreateIPSet.go @@ -64,26 +64,6 @@ func (c *Client) CreateIPSet(ctx context.Context, params *CreateIPSetInput, optF type CreateIPSetInput struct { - // The name of the IP set. You cannot change the name of an IPSet after you create - // it. - // - // This member is required. - Name *string - - // Specifies whether this is for an AWS CloudFront distribution or for a regional - // application. A regional application can be an Application Load Balancer (ALB) or - // an API Gateway stage. To work with CloudFront, you must also specify the Region - // US East (N. Virginia) as follows: - // - // * CLI - Specify the Region when you use - // the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API and SDKs - // - For all calls, use the Region endpoint us-east-1. - // - // This member is required. - Scope types.Scope - // Contains an array of strings that specify one or more IP addresses or blocks of // IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports // all address ranges for IP versions IPv4 and IPv6. Examples: @@ -114,17 +94,37 @@ type CreateIPSetInput struct { // This member is required. Addresses []*string - // An array of key:value pairs to associate with the resource. - Tags []*types.Tag + // Specify IPV4 or IPV6. + // + // This member is required. + IPAddressVersion types.IPAddressVersion + + // The name of the IP set. You cannot change the name of an IPSet after you create + // it. + // + // This member is required. + Name *string + + // Specifies whether this is for an AWS CloudFront distribution or for a regional + // application. A regional application can be an Application Load Balancer (ALB) or + // an API Gateway stage. To work with CloudFront, you must also specify the Region + // US East (N. Virginia) as follows: + // + // * CLI - Specify the Region when you use + // the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. + // + // * API and SDKs + // - For all calls, use the Region endpoint us-east-1. + // + // This member is required. + Scope types.Scope // A description of the IP set that helps with identification. You cannot change // the description of an IP set after you create it. Description *string - // Specify IPV4 or IPV6. - // - // This member is required. - IPAddressVersion types.IPAddressVersion + // An array of key:value pairs to associate with the resource. + Tags []*types.Tag } type CreateIPSetOutput struct { diff --git a/service/wafv2/api_op_CreateRegexPatternSet.go b/service/wafv2/api_op_CreateRegexPatternSet.go index 1497054e8f7..71b185a9b65 100644 --- a/service/wafv2/api_op_CreateRegexPatternSet.go +++ b/service/wafv2/api_op_CreateRegexPatternSet.go @@ -68,9 +68,6 @@ type CreateRegexPatternSetInput struct { // This member is required. Name *string - // An array of key:value pairs to associate with the resource. - Tags []*types.Tag - // Array of regular expression strings. // // This member is required. @@ -93,6 +90,9 @@ type CreateRegexPatternSetInput struct { // A description of the set that helps with identification. You cannot change the // description of a set after you create it. Description *string + + // An array of key:value pairs to associate with the resource. + Tags []*types.Tag } type CreateRegexPatternSetOutput struct { diff --git a/service/wafv2/api_op_CreateRuleGroup.go b/service/wafv2/api_op_CreateRuleGroup.go index fae46e1147d..a6c03660c2b 100644 --- a/service/wafv2/api_op_CreateRuleGroup.go +++ b/service/wafv2/api_op_CreateRuleGroup.go @@ -65,27 +65,6 @@ func (c *Client) CreateRuleGroup(ctx context.Context, params *CreateRuleGroupInp type CreateRuleGroupInput struct { - // Specifies whether this is for an AWS CloudFront distribution or for a regional - // application. A regional application can be an Application Load Balancer (ALB) or - // an API Gateway stage. To work with CloudFront, you must also specify the Region - // US East (N. Virginia) as follows: - // - // * CLI - Specify the Region when you use - // the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API and SDKs - // - For all calls, use the Region endpoint us-east-1. - // - // This member is required. - Scope types.Scope - - // An array of key:value pairs to associate with the resource. - Tags []*types.Tag - - // A description of the rule group that helps with identification. You cannot - // change the description of a rule group after you create it. - Description *string - // The web ACL capacity units (WCUs) required for this rule group. When you create // your own rule group, you define this, and you cannot change it after creation. // When you add or modify the rules in a rule group, AWS WAF enforces this limit. @@ -101,22 +80,43 @@ type CreateRuleGroupInput struct { // This member is required. Capacity *int64 - // Defines and enables Amazon CloudWatch metrics and web request sample collection. - // - // This member is required. - VisibilityConfig *types.VisibilityConfig - // The name of the rule group. You cannot change the name of a rule group after you // create it. // // This member is required. Name *string + // Specifies whether this is for an AWS CloudFront distribution or for a regional + // application. A regional application can be an Application Load Balancer (ALB) or + // an API Gateway stage. To work with CloudFront, you must also specify the Region + // US East (N. Virginia) as follows: + // + // * CLI - Specify the Region when you use + // the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. + // + // * API and SDKs + // - For all calls, use the Region endpoint us-east-1. + // + // This member is required. + Scope types.Scope + + // Defines and enables Amazon CloudWatch metrics and web request sample collection. + // + // This member is required. + VisibilityConfig *types.VisibilityConfig + + // A description of the rule group that helps with identification. You cannot + // change the description of a rule group after you create it. + Description *string + // The Rule () statements used to identify the web requests that you want to allow, // block, or count. Each rule includes one top-level statement that AWS WAF uses to // identify matching web requests, and parameters that govern how AWS WAF handles // them. Rules []*types.Rule + + // An array of key:value pairs to associate with the resource. + Tags []*types.Tag } type CreateRuleGroupOutput struct { diff --git a/service/wafv2/api_op_CreateWebACL.go b/service/wafv2/api_op_CreateWebACL.go index d287e0fd398..e357ed3742f 100644 --- a/service/wafv2/api_op_CreateWebACL.go +++ b/service/wafv2/api_op_CreateWebACL.go @@ -69,28 +69,16 @@ func (c *Client) CreateWebACL(ctx context.Context, params *CreateWebACLInput, op type CreateWebACLInput struct { - // The name of the Web ACL. You cannot change the name of a Web ACL after you - // create it. - // - // This member is required. - Name *string - - // Defines and enables Amazon CloudWatch metrics and web request sample collection. - // - // This member is required. - VisibilityConfig *types.VisibilityConfig - // The action to perform if none of the Rules contained in the WebACL match. // // This member is required. DefaultAction *types.DefaultAction - // A description of the Web ACL that helps with identification. You cannot change - // the description of a Web ACL after you create it. - Description *string - - // An array of key:value pairs to associate with the resource. - Tags []*types.Tag + // The name of the Web ACL. You cannot change the name of a Web ACL after you + // create it. + // + // This member is required. + Name *string // Specifies whether this is for an AWS CloudFront distribution or for a regional // application. A regional application can be an Application Load Balancer (ALB) or @@ -106,11 +94,23 @@ type CreateWebACLInput struct { // This member is required. Scope types.Scope + // Defines and enables Amazon CloudWatch metrics and web request sample collection. + // + // This member is required. + VisibilityConfig *types.VisibilityConfig + + // A description of the Web ACL that helps with identification. You cannot change + // the description of a Web ACL after you create it. + Description *string + // The Rule () statements used to identify the web requests that you want to allow, // block, or count. Each rule includes one top-level statement that AWS WAF uses to // identify matching web requests, and parameters that govern how AWS WAF handles // them. Rules []*types.Rule + + // An array of key:value pairs to associate with the resource. + Tags []*types.Tag } type CreateWebACLOutput struct { diff --git a/service/wafv2/api_op_DeleteIPSet.go b/service/wafv2/api_op_DeleteIPSet.go index ec353bbfab5..1c87d33dda1 100644 --- a/service/wafv2/api_op_DeleteIPSet.go +++ b/service/wafv2/api_op_DeleteIPSet.go @@ -61,6 +61,12 @@ func (c *Client) DeleteIPSet(ctx context.Context, params *DeleteIPSetInput, optF type DeleteIPSetInput struct { + // A unique identifier for the set. This ID is returned in the responses to create + // and list commands. You provide it to operations like update and delete. + // + // This member is required. + Id *string + // A token used for optimistic locking. AWS WAF returns a token to your get and // list requests, to mark the state of the entity at the time of the request. To // make changes to the entity associated with the token, you provide the token to @@ -72,6 +78,12 @@ type DeleteIPSetInput struct { // This member is required. LockToken *string + // The name of the IP set. You cannot change the name of an IPSet after you create + // it. + // + // This member is required. + Name *string + // Specifies whether this is for an AWS CloudFront distribution or for a regional // application. A regional application can be an Application Load Balancer (ALB) or // an API Gateway stage. To work with CloudFront, you must also specify the Region @@ -85,18 +97,6 @@ type DeleteIPSetInput struct { // // This member is required. Scope types.Scope - - // The name of the IP set. You cannot change the name of an IPSet after you create - // it. - // - // This member is required. - Name *string - - // A unique identifier for the set. This ID is returned in the responses to create - // and list commands. You provide it to operations like update and delete. - // - // This member is required. - Id *string } type DeleteIPSetOutput struct { diff --git a/service/wafv2/api_op_DeleteRegexPatternSet.go b/service/wafv2/api_op_DeleteRegexPatternSet.go index 96f096d4079..502e3c995c4 100644 --- a/service/wafv2/api_op_DeleteRegexPatternSet.go +++ b/service/wafv2/api_op_DeleteRegexPatternSet.go @@ -61,6 +61,23 @@ func (c *Client) DeleteRegexPatternSet(ctx context.Context, params *DeleteRegexP type DeleteRegexPatternSetInput struct { + // A unique identifier for the set. This ID is returned in the responses to create + // and list commands. You provide it to operations like update and delete. + // + // This member is required. + Id *string + + // A token used for optimistic locking. AWS WAF returns a token to your get and + // list requests, to mark the state of the entity at the time of the request. To + // make changes to the entity associated with the token, you provide the token to + // operations like update and delete. AWS WAF uses the token to ensure that no + // changes have been made to the entity since you last retrieved it. If a change + // has been made, the update fails with a WAFOptimisticLockException. If this + // happens, perform another get, and use the new token returned by that operation. + // + // This member is required. + LockToken *string + // The name of the set. You cannot change the name after you create the set. // // This member is required. @@ -79,23 +96,6 @@ type DeleteRegexPatternSetInput struct { // // This member is required. Scope types.Scope - - // A token used for optimistic locking. AWS WAF returns a token to your get and - // list requests, to mark the state of the entity at the time of the request. To - // make changes to the entity associated with the token, you provide the token to - // operations like update and delete. AWS WAF uses the token to ensure that no - // changes have been made to the entity since you last retrieved it. If a change - // has been made, the update fails with a WAFOptimisticLockException. If this - // happens, perform another get, and use the new token returned by that operation. - // - // This member is required. - LockToken *string - - // A unique identifier for the set. This ID is returned in the responses to create - // and list commands. You provide it to operations like update and delete. - // - // This member is required. - Id *string } type DeleteRegexPatternSetOutput struct { diff --git a/service/wafv2/api_op_DeleteRuleGroup.go b/service/wafv2/api_op_DeleteRuleGroup.go index 0fe9fa18123..f432d7d7509 100644 --- a/service/wafv2/api_op_DeleteRuleGroup.go +++ b/service/wafv2/api_op_DeleteRuleGroup.go @@ -61,6 +61,23 @@ func (c *Client) DeleteRuleGroup(ctx context.Context, params *DeleteRuleGroupInp type DeleteRuleGroupInput struct { + // A unique identifier for the rule group. This ID is returned in the responses to + // create and list commands. You provide it to operations like update and delete. + // + // This member is required. + Id *string + + // A token used for optimistic locking. AWS WAF returns a token to your get and + // list requests, to mark the state of the entity at the time of the request. To + // make changes to the entity associated with the token, you provide the token to + // operations like update and delete. AWS WAF uses the token to ensure that no + // changes have been made to the entity since you last retrieved it. If a change + // has been made, the update fails with a WAFOptimisticLockException. If this + // happens, perform another get, and use the new token returned by that operation. + // + // This member is required. + LockToken *string + // The name of the rule group. You cannot change the name of a rule group after you // create it. // @@ -80,23 +97,6 @@ type DeleteRuleGroupInput struct { // // This member is required. Scope types.Scope - - // A token used for optimistic locking. AWS WAF returns a token to your get and - // list requests, to mark the state of the entity at the time of the request. To - // make changes to the entity associated with the token, you provide the token to - // operations like update and delete. AWS WAF uses the token to ensure that no - // changes have been made to the entity since you last retrieved it. If a change - // has been made, the update fails with a WAFOptimisticLockException. If this - // happens, perform another get, and use the new token returned by that operation. - // - // This member is required. - LockToken *string - - // A unique identifier for the rule group. This ID is returned in the responses to - // create and list commands. You provide it to operations like update and delete. - // - // This member is required. - Id *string } type DeleteRuleGroupOutput struct { diff --git a/service/wafv2/api_op_DeleteWebACL.go b/service/wafv2/api_op_DeleteWebACL.go index b1ec4a09f2e..210a364c44f 100644 --- a/service/wafv2/api_op_DeleteWebACL.go +++ b/service/wafv2/api_op_DeleteWebACL.go @@ -79,6 +79,12 @@ type DeleteWebACLInput struct { // This member is required. LockToken *string + // The name of the Web ACL. You cannot change the name of a Web ACL after you + // create it. + // + // This member is required. + Name *string + // Specifies whether this is for an AWS CloudFront distribution or for a regional // application. A regional application can be an Application Load Balancer (ALB) or // an API Gateway stage. To work with CloudFront, you must also specify the Region @@ -92,12 +98,6 @@ type DeleteWebACLInput struct { // // This member is required. Scope types.Scope - - // The name of the Web ACL. You cannot change the name of a Web ACL after you - // create it. - // - // This member is required. - Name *string } type DeleteWebACLOutput struct { diff --git a/service/wafv2/api_op_GetRateBasedStatementManagedKeys.go b/service/wafv2/api_op_GetRateBasedStatementManagedKeys.go index 01c055047b2..66596215608 100644 --- a/service/wafv2/api_op_GetRateBasedStatementManagedKeys.go +++ b/service/wafv2/api_op_GetRateBasedStatementManagedKeys.go @@ -98,12 +98,12 @@ type GetRateBasedStatementManagedKeysInput struct { type GetRateBasedStatementManagedKeysOutput struct { - // The keys that are of Internet Protocol version 6 (IPv6). - ManagedKeysIPV6 *types.RateBasedStatementManagedKeysIPSet - // The keys that are of Internet Protocol version 4 (IPv4). ManagedKeysIPV4 *types.RateBasedStatementManagedKeysIPSet + // The keys that are of Internet Protocol version 6 (IPv6). + ManagedKeysIPV6 *types.RateBasedStatementManagedKeysIPSet + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/wafv2/api_op_GetRegexPatternSet.go b/service/wafv2/api_op_GetRegexPatternSet.go index 8a6f7094609..2e99dda86f6 100644 --- a/service/wafv2/api_op_GetRegexPatternSet.go +++ b/service/wafv2/api_op_GetRegexPatternSet.go @@ -61,6 +61,17 @@ func (c *Client) GetRegexPatternSet(ctx context.Context, params *GetRegexPattern type GetRegexPatternSetInput struct { + // A unique identifier for the set. This ID is returned in the responses to create + // and list commands. You provide it to operations like update and delete. + // + // This member is required. + Id *string + + // The name of the set. You cannot change the name after you create the set. + // + // This member is required. + Name *string + // Specifies whether this is for an AWS CloudFront distribution or for a regional // application. A regional application can be an Application Load Balancer (ALB) or // an API Gateway stage. To work with CloudFront, you must also specify the Region @@ -74,17 +85,6 @@ type GetRegexPatternSetInput struct { // // This member is required. Scope types.Scope - - // The name of the set. You cannot change the name after you create the set. - // - // This member is required. - Name *string - - // A unique identifier for the set. This ID is returned in the responses to create - // and list commands. You provide it to operations like update and delete. - // - // This member is required. - Id *string } type GetRegexPatternSetOutput struct { diff --git a/service/wafv2/api_op_GetRuleGroup.go b/service/wafv2/api_op_GetRuleGroup.go index d805ab9bd12..4859d88cc05 100644 --- a/service/wafv2/api_op_GetRuleGroup.go +++ b/service/wafv2/api_op_GetRuleGroup.go @@ -90,9 +90,6 @@ type GetRuleGroupInput struct { type GetRuleGroupOutput struct { - // - RuleGroup *types.RuleGroup - // A token used for optimistic locking. AWS WAF returns a token to your get and // list requests, to mark the state of the entity at the time of the request. To // make changes to the entity associated with the token, you provide the token to @@ -102,6 +99,9 @@ type GetRuleGroupOutput struct { // happens, perform another get, and use the new token returned by that operation. LockToken *string + // + RuleGroup *types.RuleGroup + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/wafv2/api_op_GetSampledRequests.go b/service/wafv2/api_op_GetSampledRequests.go index e2e8a623f36..5d652dc40fd 100644 --- a/service/wafv2/api_op_GetSampledRequests.go +++ b/service/wafv2/api_op_GetSampledRequests.go @@ -69,21 +69,6 @@ func (c *Client) GetSampledRequests(ctx context.Context, params *GetSampledReque type GetSampledRequestsInput struct { - // The Amazon resource name (ARN) of the WebACL for which you want a sample of - // requests. - // - // This member is required. - WebAclArn *string - - // The start date and time and the end date and time of the range for which you - // want GetSampledRequests to return a sample of requests. You must specify the - // times in Coordinated Universal Time (UTC) format. UTC format includes the - // special designator, Z. For example, "2016-09-27T14:50Z". You can specify any - // time range in the previous three hours. - // - // This member is required. - TimeWindow *types.TimeWindow - // The number of requests that you want AWS WAF to return from among the first // 5,000 requests that your AWS resource received during the time range. If your // resource received fewer requests than the value of MaxItems, GetSampledRequests @@ -111,17 +96,25 @@ type GetSampledRequestsInput struct { // // This member is required. Scope types.Scope + + // The start date and time and the end date and time of the range for which you + // want GetSampledRequests to return a sample of requests. You must specify the + // times in Coordinated Universal Time (UTC) format. UTC format includes the + // special designator, Z. For example, "2016-09-27T14:50Z". You can specify any + // time range in the previous three hours. + // + // This member is required. + TimeWindow *types.TimeWindow + + // The Amazon resource name (ARN) of the WebACL for which you want a sample of + // requests. + // + // This member is required. + WebAclArn *string } type GetSampledRequestsOutput struct { - // Usually, TimeWindow is the time range that you specified in the - // GetSampledRequests request. However, if your AWS resource received more than - // 5,000 requests during the time range that you specified in the request, - // GetSampledRequests returns the time range for the first 5,000 requests. Times - // are in Coordinated Universal Time (UTC) format. - TimeWindow *types.TimeWindow - // The total number of requests from which GetSampledRequests got a sample of // MaxItems requests. If PopulationSize is less than MaxItems, the sample includes // every request that your AWS resource received during the specified time range. @@ -131,6 +124,13 @@ type GetSampledRequestsOutput struct { // the sample. SampledRequests []*types.SampledHTTPRequest + // Usually, TimeWindow is the time range that you specified in the + // GetSampledRequests request. However, if your AWS resource received more than + // 5,000 requests during the time range that you specified in the request, + // GetSampledRequests returns the time range for the first 5,000 requests. Times + // are in Coordinated Universal Time (UTC) format. + TimeWindow *types.TimeWindow + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/wafv2/api_op_GetWebACL.go b/service/wafv2/api_op_GetWebACL.go index 4360c26d694..ce7ff523c89 100644 --- a/service/wafv2/api_op_GetWebACL.go +++ b/service/wafv2/api_op_GetWebACL.go @@ -61,6 +61,12 @@ func (c *Client) GetWebACL(ctx context.Context, params *GetWebACLInput, optFns . type GetWebACLInput struct { + // The unique identifier for the Web ACL. This ID is returned in the responses to + // create and list commands. You provide it to operations like update and delete. + // + // This member is required. + Id *string + // The name of the Web ACL. You cannot change the name of a Web ACL after you // create it. // @@ -80,12 +86,6 @@ type GetWebACLInput struct { // // This member is required. Scope types.Scope - - // The unique identifier for the Web ACL. This ID is returned in the responses to - // create and list commands. You provide it to operations like update and delete. - // - // This member is required. - Id *string } type GetWebACLOutput struct { diff --git a/service/wafv2/api_op_ListIPSets.go b/service/wafv2/api_op_ListIPSets.go index daa28a50c68..70ff51afff4 100644 --- a/service/wafv2/api_op_ListIPSets.go +++ b/service/wafv2/api_op_ListIPSets.go @@ -61,17 +61,6 @@ func (c *Client) ListIPSets(ctx context.Context, params *ListIPSetsInput, optFns type ListIPSetsInput struct { - // The maximum number of objects that you want AWS WAF to return for this request. - // If more objects are available, in the response, AWS WAF provides a NextMarker - // value that you can use in a subsequent call to get the next batch of objects. - Limit *int32 - - // When you request a list of objects with a Limit setting, if the number of - // objects that are still available for retrieval exceeds the limit, AWS WAF - // returns a NextMarker value in the response. To retrieve the next batch of - // objects, provide the marker from the prior call in your next request. - NextMarker *string - // Specifies whether this is for an AWS CloudFront distribution or for a regional // application. A regional application can be an Application Load Balancer (ALB) or // an API Gateway stage. To work with CloudFront, you must also specify the Region @@ -85,6 +74,17 @@ type ListIPSetsInput struct { // // This member is required. Scope types.Scope + + // The maximum number of objects that you want AWS WAF to return for this request. + // If more objects are available, in the response, AWS WAF provides a NextMarker + // value that you can use in a subsequent call to get the next batch of objects. + Limit *int32 + + // When you request a list of objects with a Limit setting, if the number of + // objects that are still available for retrieval exceeds the limit, AWS WAF + // returns a NextMarker value in the response. To retrieve the next batch of + // objects, provide the marker from the prior call in your next request. + NextMarker *string } type ListIPSetsOutput struct { diff --git a/service/wafv2/api_op_ListLoggingConfigurations.go b/service/wafv2/api_op_ListLoggingConfigurations.go index 6036f86f4f2..3574a6f0a9d 100644 --- a/service/wafv2/api_op_ListLoggingConfigurations.go +++ b/service/wafv2/api_op_ListLoggingConfigurations.go @@ -86,15 +86,15 @@ type ListLoggingConfigurationsInput struct { type ListLoggingConfigurationsOutput struct { + // + LoggingConfigurations []*types.LoggingConfiguration + // When you request a list of objects with a Limit setting, if the number of // objects that are still available for retrieval exceeds the limit, AWS WAF // returns a NextMarker value in the response. To retrieve the next batch of // objects, provide the marker from the prior call in your next request. NextMarker *string - // - LoggingConfigurations []*types.LoggingConfiguration - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/wafv2/api_op_ListRuleGroups.go b/service/wafv2/api_op_ListRuleGroups.go index bd6c69eecaf..ea95f68f63e 100644 --- a/service/wafv2/api_op_ListRuleGroups.go +++ b/service/wafv2/api_op_ListRuleGroups.go @@ -76,16 +76,16 @@ type ListRuleGroupsInput struct { // This member is required. Scope types.Scope + // The maximum number of objects that you want AWS WAF to return for this request. + // If more objects are available, in the response, AWS WAF provides a NextMarker + // value that you can use in a subsequent call to get the next batch of objects. + Limit *int32 + // When you request a list of objects with a Limit setting, if the number of // objects that are still available for retrieval exceeds the limit, AWS WAF // returns a NextMarker value in the response. To retrieve the next batch of // objects, provide the marker from the prior call in your next request. NextMarker *string - - // The maximum number of objects that you want AWS WAF to return for this request. - // If more objects are available, in the response, AWS WAF provides a NextMarker - // value that you can use in a subsequent call to get the next batch of objects. - Limit *int32 } type ListRuleGroupsOutput struct { diff --git a/service/wafv2/api_op_ListTagsForResource.go b/service/wafv2/api_op_ListTagsForResource.go index f8b8d1a7d6b..ff0aa17483b 100644 --- a/service/wafv2/api_op_ListTagsForResource.go +++ b/service/wafv2/api_op_ListTagsForResource.go @@ -67,16 +67,16 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The maximum number of objects that you want AWS WAF to return for this request. - // If more objects are available, in the response, AWS WAF provides a NextMarker - // value that you can use in a subsequent call to get the next batch of objects. - Limit *int32 - // The Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceARN *string + // The maximum number of objects that you want AWS WAF to return for this request. + // If more objects are available, in the response, AWS WAF provides a NextMarker + // value that you can use in a subsequent call to get the next batch of objects. + Limit *int32 + // When you request a list of objects with a Limit setting, if the number of // objects that are still available for retrieval exceeds the limit, AWS WAF // returns a NextMarker value in the response. To retrieve the next batch of @@ -86,15 +86,15 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { - // The collection of tagging definitions for the resource. - TagInfoForResource *types.TagInfoForResource - // When you request a list of objects with a Limit setting, if the number of // objects that are still available for retrieval exceeds the limit, AWS WAF // returns a NextMarker value in the response. To retrieve the next batch of // objects, provide the marker from the prior call in your next request. NextMarker *string + // The collection of tagging definitions for the resource. + TagInfoForResource *types.TagInfoForResource + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/wafv2/api_op_ListWebACLs.go b/service/wafv2/api_op_ListWebACLs.go index 2da1c825c74..a230a018ad2 100644 --- a/service/wafv2/api_op_ListWebACLs.go +++ b/service/wafv2/api_op_ListWebACLs.go @@ -61,17 +61,6 @@ func (c *Client) ListWebACLs(ctx context.Context, params *ListWebACLsInput, optF type ListWebACLsInput struct { - // The maximum number of objects that you want AWS WAF to return for this request. - // If more objects are available, in the response, AWS WAF provides a NextMarker - // value that you can use in a subsequent call to get the next batch of objects. - Limit *int32 - - // When you request a list of objects with a Limit setting, if the number of - // objects that are still available for retrieval exceeds the limit, AWS WAF - // returns a NextMarker value in the response. To retrieve the next batch of - // objects, provide the marker from the prior call in your next request. - NextMarker *string - // Specifies whether this is for an AWS CloudFront distribution or for a regional // application. A regional application can be an Application Load Balancer (ALB) or // an API Gateway stage. To work with CloudFront, you must also specify the Region @@ -85,19 +74,30 @@ type ListWebACLsInput struct { // // This member is required. Scope types.Scope + + // The maximum number of objects that you want AWS WAF to return for this request. + // If more objects are available, in the response, AWS WAF provides a NextMarker + // value that you can use in a subsequent call to get the next batch of objects. + Limit *int32 + + // When you request a list of objects with a Limit setting, if the number of + // objects that are still available for retrieval exceeds the limit, AWS WAF + // returns a NextMarker value in the response. To retrieve the next batch of + // objects, provide the marker from the prior call in your next request. + NextMarker *string } type ListWebACLsOutput struct { - // - WebACLs []*types.WebACLSummary - // When you request a list of objects with a Limit setting, if the number of // objects that are still available for retrieval exceeds the limit, AWS WAF // returns a NextMarker value in the response. To retrieve the next batch of // objects, provide the marker from the prior call in your next request. NextMarker *string + // + WebACLs []*types.WebACLSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/wafv2/api_op_PutPermissionPolicy.go b/service/wafv2/api_op_PutPermissionPolicy.go index 2b25bd5619a..34aaf508169 100644 --- a/service/wafv2/api_op_PutPermissionPolicy.go +++ b/service/wafv2/api_op_PutPermissionPolicy.go @@ -68,12 +68,6 @@ func (c *Client) PutPermissionPolicy(ctx context.Context, params *PutPermissionP type PutPermissionPolicyInput struct { - // The Amazon Resource Name (ARN) of the RuleGroup () to which you want to attach - // the policy. - // - // This member is required. - ResourceArn *string - // The policy to attach to the specified rule group.

            The policy specifications // must conform to the following:

            • The policy must be composed // using IAM Policy version 2012-10-17 or version 2015-01-01.

            • The @@ -90,6 +84,12 @@ type PutPermissionPolicyInput struct { // // This member is required. Policy *string + + // The Amazon Resource Name (ARN) of the RuleGroup () to which you want to attach + // the policy. + // + // This member is required. + ResourceArn *string } type PutPermissionPolicyOutput struct { diff --git a/service/wafv2/api_op_TagResource.go b/service/wafv2/api_op_TagResource.go index e9fc60bd20c..47cfb881a3a 100644 --- a/service/wafv2/api_op_TagResource.go +++ b/service/wafv2/api_op_TagResource.go @@ -67,15 +67,15 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // An array of key:value pairs to associate with the resource. + // The Amazon Resource Name (ARN) of the resource. // // This member is required. - Tags []*types.Tag + ResourceARN *string - // The Amazon Resource Name (ARN) of the resource. + // An array of key:value pairs to associate with the resource. // // This member is required. - ResourceARN *string + Tags []*types.Tag } type TagResourceOutput struct { diff --git a/service/wafv2/api_op_UpdateIPSet.go b/service/wafv2/api_op_UpdateIPSet.go index b8657f6a7f8..a76c4ec04f1 100644 --- a/service/wafv2/api_op_UpdateIPSet.go +++ b/service/wafv2/api_op_UpdateIPSet.go @@ -61,27 +61,6 @@ func (c *Client) UpdateIPSet(ctx context.Context, params *UpdateIPSetInput, optF type UpdateIPSetInput struct { - // A description of the IP set that helps with identification. You cannot change - // the description of an IP set after you create it. - Description *string - - // A unique identifier for the set. This ID is returned in the responses to create - // and list commands. You provide it to operations like update and delete. - // - // This member is required. - Id *string - - // A token used for optimistic locking. AWS WAF returns a token to your get and - // list requests, to mark the state of the entity at the time of the request. To - // make changes to the entity associated with the token, you provide the token to - // operations like update and delete. AWS WAF uses the token to ensure that no - // changes have been made to the entity since you last retrieved it. If a change - // has been made, the update fails with a WAFOptimisticLockException. If this - // happens, perform another get, and use the new token returned by that operation. - // - // This member is required. - LockToken *string - // Contains an array of strings that specify one or more IP addresses or blocks of // IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports // all address ranges for IP versions IPv4 and IPv6. Examples: @@ -112,6 +91,29 @@ type UpdateIPSetInput struct { // This member is required. Addresses []*string + // A unique identifier for the set. This ID is returned in the responses to create + // and list commands. You provide it to operations like update and delete. + // + // This member is required. + Id *string + + // A token used for optimistic locking. AWS WAF returns a token to your get and + // list requests, to mark the state of the entity at the time of the request. To + // make changes to the entity associated with the token, you provide the token to + // operations like update and delete. AWS WAF uses the token to ensure that no + // changes have been made to the entity since you last retrieved it. If a change + // has been made, the update fails with a WAFOptimisticLockException. If this + // happens, perform another get, and use the new token returned by that operation. + // + // This member is required. + LockToken *string + + // The name of the IP set. You cannot change the name of an IPSet after you create + // it. + // + // This member is required. + Name *string + // Specifies whether this is for an AWS CloudFront distribution or for a regional // application. A regional application can be an Application Load Balancer (ALB) or // an API Gateway stage. To work with CloudFront, you must also specify the Region @@ -126,11 +128,9 @@ type UpdateIPSetInput struct { // This member is required. Scope types.Scope - // The name of the IP set. You cannot change the name of an IPSet after you create - // it. - // - // This member is required. - Name *string + // A description of the IP set that helps with identification. You cannot change + // the description of an IP set after you create it. + Description *string } type UpdateIPSetOutput struct { diff --git a/service/wafv2/api_op_UpdateRegexPatternSet.go b/service/wafv2/api_op_UpdateRegexPatternSet.go index 5d2dfd0c9cb..048b741bfcd 100644 --- a/service/wafv2/api_op_UpdateRegexPatternSet.go +++ b/service/wafv2/api_op_UpdateRegexPatternSet.go @@ -61,19 +61,11 @@ func (c *Client) UpdateRegexPatternSet(ctx context.Context, params *UpdateRegexP type UpdateRegexPatternSetInput struct { - // A description of the set that helps with identification. You cannot change the - // description of a set after you create it. - Description *string - - // - // - // This member is required. - RegularExpressionList []*types.Regex - - // The name of the set. You cannot change the name after you create the set. + // A unique identifier for the set. This ID is returned in the responses to create + // and list commands. You provide it to operations like update and delete. // // This member is required. - Name *string + Id *string // A token used for optimistic locking. AWS WAF returns a token to your get and // list requests, to mark the state of the entity at the time of the request. To @@ -86,11 +78,15 @@ type UpdateRegexPatternSetInput struct { // This member is required. LockToken *string - // A unique identifier for the set. This ID is returned in the responses to create - // and list commands. You provide it to operations like update and delete. + // The name of the set. You cannot change the name after you create the set. // // This member is required. - Id *string + Name *string + + // + // + // This member is required. + RegularExpressionList []*types.Regex // Specifies whether this is for an AWS CloudFront distribution or for a regional // application. A regional application can be an Application Load Balancer (ALB) or @@ -105,6 +101,10 @@ type UpdateRegexPatternSetInput struct { // // This member is required. Scope types.Scope + + // A description of the set that helps with identification. You cannot change the + // description of a set after you create it. + Description *string } type UpdateRegexPatternSetOutput struct { diff --git a/service/wafv2/api_op_UpdateRuleGroup.go b/service/wafv2/api_op_UpdateRuleGroup.go index 7015c06934b..16fe449aed6 100644 --- a/service/wafv2/api_op_UpdateRuleGroup.go +++ b/service/wafv2/api_op_UpdateRuleGroup.go @@ -65,25 +65,11 @@ func (c *Client) UpdateRuleGroup(ctx context.Context, params *UpdateRuleGroupInp type UpdateRuleGroupInput struct { - // The Rule () statements used to identify the web requests that you want to allow, - // block, or count. Each rule includes one top-level statement that AWS WAF uses to - // identify matching web requests, and parameters that govern how AWS WAF handles - // them. - Rules []*types.Rule - - // Specifies whether this is for an AWS CloudFront distribution or for a regional - // application. A regional application can be an Application Load Balancer (ALB) or - // an API Gateway stage. To work with CloudFront, you must also specify the Region - // US East (N. Virginia) as follows: - // - // * CLI - Specify the Region when you use - // the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API and SDKs - // - For all calls, use the Region endpoint us-east-1. + // A unique identifier for the rule group. This ID is returned in the responses to + // create and list commands. You provide it to operations like update and delete. // // This member is required. - Scope types.Scope + Id *string // A token used for optimistic locking. AWS WAF returns a token to your get and // list requests, to mark the state of the entity at the time of the request. To @@ -102,20 +88,34 @@ type UpdateRuleGroupInput struct { // This member is required. Name *string - // Defines and enables Amazon CloudWatch metrics and web request sample collection. + // Specifies whether this is for an AWS CloudFront distribution or for a regional + // application. A regional application can be an Application Load Balancer (ALB) or + // an API Gateway stage. To work with CloudFront, you must also specify the Region + // US East (N. Virginia) as follows: + // + // * CLI - Specify the Region when you use + // the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. + // + // * API and SDKs + // - For all calls, use the Region endpoint us-east-1. // // This member is required. - VisibilityConfig *types.VisibilityConfig + Scope types.Scope - // A unique identifier for the rule group. This ID is returned in the responses to - // create and list commands. You provide it to operations like update and delete. + // Defines and enables Amazon CloudWatch metrics and web request sample collection. // // This member is required. - Id *string + VisibilityConfig *types.VisibilityConfig // A description of the rule group that helps with identification. You cannot // change the description of a rule group after you create it. Description *string + + // The Rule () statements used to identify the web requests that you want to allow, + // block, or count. Each rule includes one top-level statement that AWS WAF uses to + // identify matching web requests, and parameters that govern how AWS WAF handles + // them. + Rules []*types.Rule } type UpdateRuleGroupOutput struct { diff --git a/service/wafv2/api_op_UpdateWebACL.go b/service/wafv2/api_op_UpdateWebACL.go index d71b274f035..00db60441de 100644 --- a/service/wafv2/api_op_UpdateWebACL.go +++ b/service/wafv2/api_op_UpdateWebACL.go @@ -68,11 +68,16 @@ func (c *Client) UpdateWebACL(ctx context.Context, params *UpdateWebACLInput, op type UpdateWebACLInput struct { - // The name of the Web ACL. You cannot change the name of a Web ACL after you - // create it. + // The action to perform if none of the Rules contained in the WebACL match. // // This member is required. - Name *string + DefaultAction *types.DefaultAction + + // The unique identifier for the Web ACL. This ID is returned in the responses to + // create and list commands. You provide it to operations like update and delete. + // + // This member is required. + Id *string // A token used for optimistic locking. AWS WAF returns a token to your get and // list requests, to mark the state of the entity at the time of the request. To @@ -85,6 +90,12 @@ type UpdateWebACLInput struct { // This member is required. LockToken *string + // The name of the Web ACL. You cannot change the name of a Web ACL after you + // create it. + // + // This member is required. + Name *string + // Specifies whether this is for an AWS CloudFront distribution or for a regional // application. A regional application can be an Application Load Balancer (ALB) or // an API Gateway stage. To work with CloudFront, you must also specify the Region @@ -99,31 +110,20 @@ type UpdateWebACLInput struct { // This member is required. Scope types.Scope - // The action to perform if none of the Rules contained in the WebACL match. + // Defines and enables Amazon CloudWatch metrics and web request sample collection. // // This member is required. - DefaultAction *types.DefaultAction + VisibilityConfig *types.VisibilityConfig + + // A description of the Web ACL that helps with identification. You cannot change + // the description of a Web ACL after you create it. + Description *string // The Rule () statements used to identify the web requests that you want to allow, // block, or count. Each rule includes one top-level statement that AWS WAF uses to // identify matching web requests, and parameters that govern how AWS WAF handles // them. Rules []*types.Rule - - // A description of the Web ACL that helps with identification. You cannot change - // the description of a Web ACL after you create it. - Description *string - - // The unique identifier for the Web ACL. This ID is returned in the responses to - // create and list commands. You provide it to operations like update and delete. - // - // This member is required. - Id *string - - // Defines and enables Amazon CloudWatch metrics and web request sample collection. - // - // This member is required. - VisibilityConfig *types.VisibilityConfig } type UpdateWebACLOutput struct { diff --git a/service/wafv2/go.mod b/service/wafv2/go.mod index cd337cf53ed..46bfd6e537d 100644 --- a/service/wafv2/go.mod +++ b/service/wafv2/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/wafv2 go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/wafv2/types/types.go b/service/wafv2/types/types.go index 1108921a7df..cbaad2da1bd 100644 --- a/service/wafv2/types/types.go +++ b/service/wafv2/types/types.go @@ -72,15 +72,6 @@ type Body struct { // as a string match statement. type ByteMatchStatement struct { - // Text transformations eliminate some of the unusual formatting that attackers use - // in web requests in an effort to bypass detection. If you specify one or more - // transformations in a rule statement, AWS WAF performs all transformations on the - // content of the request component identified by FieldToMatch, starting from the - // lowest priority setting, before inspecting the content for a match. - // - // This member is required. - TextTransformations []*TextTransformation - // The part of a web request that you want AWS WAF to inspect. For more // information, see FieldToMatch (). // @@ -142,6 +133,15 @@ type ByteMatchStatement struct { // // This member is required. SearchString []byte + + // Text transformations eliminate some of the unusual formatting that attackers use + // in web requests in an effort to bypass detection. If you specify one or more + // transformations in a rule statement, AWS WAF performs all transformations on the + // content of the request component identified by FieldToMatch, starting from the + // lowest priority setting, before inspecting the content for a match. + // + // This member is required. + TextTransformations []*TextTransformation } // This is the latest version of AWS WAF, named AWS WAFV2, released in November, @@ -196,6 +196,9 @@ type ExcludedRule struct { // component of a web request, create a separate rule statement for each component. type FieldToMatch struct { + // Inspect all query arguments. + AllQueryArguments *AllQueryArguments + // Inspect the request body, which immediately follows the request headers. This is // the part of a request that contains any additional data that you want to send to // your web server as the HTTP request body, such as data from a form. Note that @@ -209,17 +212,10 @@ type FieldToMatch struct { // whose bodies exceed the 8 KB limit. Body *Body - // Inspect all query arguments. - AllQueryArguments *AllQueryArguments - // Inspect the HTTP method. The method indicates the type of operation that the // request is asking the origin to perform. Method *Method - // Inspect the request URI path. This is the part of a web request that identifies - // a resource, for example, /images/daily-ad.jpg. - UriPath *UriPath - // Inspect the query string. This is the part of a URL that appears after a ? // character, if any. QueryString *QueryString @@ -233,19 +229,15 @@ type FieldToMatch struct { // long and isn't case sensitive. This is used only to indicate the web request // component for AWS WAF to inspect, in the FieldToMatch () specification. SingleQueryArgument *SingleQueryArgument + + // Inspect the request URI path. This is the part of a web request that identifies + // a resource, for example, /images/daily-ad.jpg. + UriPath *UriPath } // A rule group that's defined for an AWS Firewall Manager WAF policy. type FirewallManagerRuleGroup struct { - // If you define more than one rule group in the first or last Firewall Manager - // rule groups, AWS WAF evaluates each request against the rule groups in order, - // starting from the lowest priority setting. The priorities don't need to be - // consecutive, but they must all be different. - // - // This member is required. - Priority *int32 - // The processing guidance for an AWS Firewall Manager rule. This is like a regular // rule Statement (), but it can only contain a rule group reference. // @@ -258,15 +250,6 @@ type FirewallManagerRuleGroup struct { // This member is required. Name *string - // This is the latest version of AWS WAF, named AWS WAFV2, released in November, - // 2019. For information, including how to migrate your AWS WAF resources from the - // prior release, see the AWS WAF Developer Guide - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). - // Defines and enables Amazon CloudWatch metrics and web request sample collection. - // - // This member is required. - VisibilityConfig *VisibilityConfig - // The override action to apply to the rules in a rule group. Used only for rule // statements that reference a rule group, like RuleGroupReferenceStatement and // ManagedRuleGroupStatement. Set the override action to none to leave the rule @@ -283,22 +266,28 @@ type FirewallManagerRuleGroup struct { // // This member is required. OverrideAction *OverrideAction -} -// The processing guidance for an AWS Firewall Manager rule. This is like a regular -// rule Statement (), but it can only contain a rule group reference. -type FirewallManagerStatement struct { + // If you define more than one rule group in the first or last Firewall Manager + // rule groups, AWS WAF evaluates each request against the rule groups in order, + // starting from the lowest priority setting. The priorities don't need to be + // consecutive, but they must all be different. + // + // This member is required. + Priority *int32 // This is the latest version of AWS WAF, named AWS WAFV2, released in November, // 2019. For information, including how to migrate your AWS WAF resources from the // prior release, see the AWS WAF Developer Guide - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). A rule - // statement used to run the rules that are defined in a RuleGroup (). To use this, - // create a rule group with your rules, then provide the ARN of the rule group in - // this statement. You cannot nest a RuleGroupReferenceStatement, for example for - // use inside a NotStatement or OrStatement. It can only be referenced as a - // top-level statement within a rule. - RuleGroupReferenceStatement *RuleGroupReferenceStatement + // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). + // Defines and enables Amazon CloudWatch metrics and web request sample collection. + // + // This member is required. + VisibilityConfig *VisibilityConfig +} + +// The processing guidance for an AWS Firewall Manager rule. This is like a regular +// rule Statement (), but it can only contain a rule group reference. +type FirewallManagerStatement struct { // This is the latest version of AWS WAF, named AWS WAFV2, released in November, // 2019. For information, including how to migrate your AWS WAF resources from the @@ -311,6 +300,17 @@ type FirewallManagerStatement struct { // NotStatement or OrStatement. It can only be referenced as a top-level statement // within a rule. ManagedRuleGroupStatement *ManagedRuleGroupStatement + + // This is the latest version of AWS WAF, named AWS WAFV2, released in November, + // 2019. For information, including how to migrate your AWS WAF resources from the + // prior release, see the AWS WAF Developer Guide + // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). A rule + // statement used to run the rules that are defined in a RuleGroup (). To use this, + // create a rule group with your rules, then provide the ARN of the rule group in + // this statement. You cannot nest a RuleGroupReferenceStatement, for example for + // use inside a NotStatement or OrStatement. It can only be referenced as a + // top-level statement within a rule. + RuleGroupReferenceStatement *RuleGroupReferenceStatement } // The configuration for inspecting IP addresses in an HTTP header that you @@ -324,14 +324,6 @@ type FirewallManagerStatement struct { // IP address found in the specified HTTP header.

              type ForwardedIPConfig struct { - // The name of the HTTP header to use for the IP address. For example, to use the - // X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

              If the - // specified header isn't present in the request, AWS WAF doesn't apply the rule to - // the web request at all.

               - // - // This member is required. - HeaderName *string - // The match status to assign to the web request if the request doesn't have a // valid IP address in the specified position.

              If the specified header // isn't present in the request, AWS WAF doesn't apply the rule to the web request @@ -342,6 +334,14 @@ type ForwardedIPConfig struct { // // This member is required. FallbackBehavior FallbackBehavior + + // The name of the HTTP header to use for the IP address. For example, to use the + // X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

              If the + // specified header isn't present in the request, AWS WAF doesn't apply the rule to + // the web request at all.

               + // + // This member is required. + HeaderName *string } // This is the latest version of AWS WAF, named AWS WAFV2, released in November, @@ -372,11 +372,11 @@ type GeoMatchStatement struct { // all of the headers that appear in one of the web requests. type HTTPHeader struct { - // The value of the HTTP header. - Value *string - // The name of the HTTP header. Name *string + + // The value of the HTTP header. + Value *string } // This is the latest version of AWS WAF, named AWS WAFV2, released in November, @@ -388,18 +388,6 @@ type HTTPHeader struct { // the web requests. type HTTPRequest struct { - // The HTTP method specified in the sampled web request. - Method *string - - // The two-letter country code for the country that the request originated from. - // For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2 - // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). - Country *string - - // A complex type that contains the name and value for each header in the sampled - // web request. - Headers []*HTTPHeader - // The IP address that the request originated from. If the web ACL is associated // with a CloudFront distribution, this is the value of one of the following fields // in CloudFront access logs: @@ -411,9 +399,21 @@ type HTTPRequest struct { // use an HTTP proxy or a load balancer to send the request ClientIP *string + // The two-letter country code for the country that the request originated from. + // For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2 + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). + Country *string + // The HTTP version specified in the sampled web request, for example, HTTP/1.1. HTTPVersion *string + // A complex type that contains the name and value for each header in the sampled + // web request. + Headers []*HTTPHeader + + // The HTTP method specified in the sampled web request. + Method *string + // The URI path of the request, which identifies the resource, for example, // /images/daily-ad.jpg. URI *string @@ -432,27 +432,6 @@ type HTTPRequest struct { // the ARN to the Rule () statement IPSetReferenceStatement (). type IPSet struct { - // Specify IPV4 or IPV6. - // - // This member is required. - IPAddressVersion IPAddressVersion - - // A unique identifier for the set. This ID is returned in the responses to create - // and list commands. You provide it to operations like update and delete. - // - // This member is required. - Id *string - - // A description of the IP set that helps with identification. You cannot change - // the description of an IP set after you create it. - Description *string - - // The name of the IP set. You cannot change the name of an IPSet after you create - // it. - // - // This member is required. - Name *string - // The Amazon Resource Name (ARN) of the entity. // // This member is required. @@ -487,6 +466,27 @@ type IPSet struct { // // This member is required. Addresses []*string + + // Specify IPV4 or IPV6. + // + // This member is required. + IPAddressVersion IPAddressVersion + + // A unique identifier for the set. This ID is returned in the responses to create + // and list commands. You provide it to operations like update and delete. + // + // This member is required. + Id *string + + // The name of the IP set. You cannot change the name of an IPSet after you create + // it. + // + // This member is required. + Name *string + + // A description of the IP set that helps with identification. You cannot change + // the description of an IP set after you create it. + Description *string } // The configuration for inspecting IP addresses in an HTTP header that you @@ -499,14 +499,6 @@ type IPSet struct { // ForwardedIPConfig instead.

              type IPSetForwardedIPConfig struct { - // The name of the HTTP header to use for the IP address. For example, to use the - // X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

              If the - // specified header isn't present in the request, AWS WAF doesn't apply the rule to - // the web request at all.

               - // - // This member is required. - HeaderName *string - // The match status to assign to the web request if the request doesn't have a // valid IP address in the specified position.

              If the specified header // isn't present in the request, AWS WAF doesn't apply the rule to the web request @@ -518,6 +510,14 @@ type IPSetForwardedIPConfig struct { // This member is required. FallbackBehavior FallbackBehavior + // The name of the HTTP header to use for the IP address. For example, to use the + // X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

              If the + // specified header isn't present in the request, AWS WAF doesn't apply the rule to + // the web request at all.

               + // + // This member is required. + HeaderName *string + // The position in the header to search for the IP address. The header can contain // IP addresses of the original client and also of proxies. For example, the header // value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address @@ -575,6 +575,17 @@ type IPSetReferenceStatement struct { // to use the address set in a Rule (). type IPSetSummary struct { + // The Amazon Resource Name (ARN) of the entity. + ARN *string + + // A description of the IP set that helps with identification. You cannot change + // the description of an IP set after you create it. + Description *string + + // A unique identifier for the set. This ID is returned in the responses to create + // and list commands. You provide it to operations like update and delete. + Id *string + // A token used for optimistic locking. AWS WAF returns a token to your get and // list requests, to mark the state of the entity at the time of the request. To // make changes to the entity associated with the token, you provide the token to @@ -584,20 +595,9 @@ type IPSetSummary struct { // happens, perform another get, and use the new token returned by that operation. LockToken *string - // A unique identifier for the set. This ID is returned in the responses to create - // and list commands. You provide it to operations like update and delete. - Id *string - // The name of the IP set. You cannot change the name of an IPSet after you create // it. Name *string - - // A description of the IP set that helps with identification. You cannot change - // the description of an IP set after you create it. - Description *string - - // The Amazon Resource Name (ARN) of the entity. - ARN *string } // This is the latest version of AWS WAF, named AWS WAFV2, released in November, @@ -615,15 +615,15 @@ type LoggingConfiguration struct { // This member is required. LogDestinationConfigs []*string - // The parts of the request that you want to keep out of the logs. For example, if - // you redact the cookie field, the cookie field in the firehose will be xxx. - RedactedFields []*FieldToMatch - // The Amazon Resource Name (ARN) of the web ACL that you want to associate with // LogDestinationConfigs. // // This member is required. ResourceArn *string + + // The parts of the request that you want to keep out of the logs. For example, if + // you redact the cookie field, the cookie field in the firehose will be xxx. + RedactedFields []*FieldToMatch } // This is the latest version of AWS WAF, named AWS WAFV2, released in November, @@ -644,16 +644,16 @@ type ManagedRuleGroupStatement struct { // This member is required. Name *string - // The rules whose actions are set to COUNT by the web ACL, regardless of the - // action that is set on the rule. This effectively excludes the rule from acting - // on web requests. - ExcludedRules []*ExcludedRule - // The name of the managed rule group vendor. You use this, along with the rule // group name, to identify the rule group. // // This member is required. VendorName *string + + // The rules whose actions are set to COUNT by the web ACL, regardless of the + // action that is set on the rule. This effectively excludes the rule from acting + // on web requests. + ExcludedRules []*ExcludedRule } // This is the latest version of AWS WAF, named AWS WAFV2, released in November, @@ -668,10 +668,6 @@ type ManagedRuleGroupStatement struct { // which you can subscribe to through AWS Marketplace. type ManagedRuleGroupSummary struct { - // The name of the managed rule group vendor. You use this, along with the rule - // group name, to identify the rule group. - VendorName *string - // The description of the managed rule group, provided by AWS Managed Rules or the // AWS Marketplace seller who manages it. Description *string @@ -679,6 +675,10 @@ type ManagedRuleGroupSummary struct { // The name of the managed rule group. You use this, along with the vendor name, to // identify the rule group. Name *string + + // The name of the managed rule group vendor. You use this, along with the rule + // group name, to identify the rule group. + VendorName *string } // This is the latest version of AWS WAF, named AWS WAFV2, released in November, @@ -747,11 +747,11 @@ type OrStatement struct { // rule action setting and not this rule override action setting. type OverrideAction struct { - // Don't override the rule action setting. - None *NoneAction - // Override the rule action setting to count. Count *CountAction + + // Don't override the rule action setting. + None *NoneAction } // This is the latest version of AWS WAF, named AWS WAFV2, released in November, @@ -796,17 +796,25 @@ type QueryString struct { // statement within a rule. type RateBasedStatement struct { - // The limit on requests per 5-minute period for a single originating IP address. - // If the statement includes a ScopeDownStatement, this limit is applied only to - // the requests that match the statement. + // Setting that indicates how to aggregate the request counts. The options are the + // following: // - // This member is required. - Limit *int64 - - // An optional nested statement that narrows the scope of the rate-based statement - // to matching web requests. This can be any nestable statement, and you can nest - // statements at any level below this scope-down statement. - ScopeDownStatement *Statement + // * IP - Aggregate the request counts on the IP address from the + // web request origin. + // + // * FORWARDED_IP - Aggregate the request counts on the + // first IP address in an HTTP header. If you use this, configure the + // ForwardedIPConfig, to specify the header to use. + // + // This member is required. + AggregateKeyType RateBasedStatementAggregateKeyType + + // The limit on requests per 5-minute period for a single originating IP address. + // If the statement includes a ScopeDownStatement, this limit is applied only to + // the requests that match the statement. + // + // This member is required. + Limit *int64 // The configuration for inspecting IP addresses in an HTTP header that you // specify, instead of using the IP address that's reported by the web request @@ -817,18 +825,10 @@ type RateBasedStatement struct { // FORWARDED_IP.

              ForwardedIPConfig *ForwardedIPConfig - // Setting that indicates how to aggregate the request counts. The options are the - // following: - // - // * IP - Aggregate the request counts on the IP address from the - // web request origin. - // - // * FORWARDED_IP - Aggregate the request counts on the - // first IP address in an HTTP header. If you use this, configure the - // ForwardedIPConfig, to specify the header to use. - // - // This member is required. - AggregateKeyType RateBasedStatementAggregateKeyType + // An optional nested statement that narrows the scope of the rate-based statement + // to matching web requests. This can be any nestable statement, and you can nest + // statements at any level below this scope-down statement. + ScopeDownStatement *Statement } // This is the latest version of AWS WAF, named AWS WAFV2, released in November, @@ -837,10 +837,11 @@ type RateBasedStatement struct { // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). The // set of IP addresses that are currently blocked for a rate-based statement. type RateBasedStatementManagedKeysIPSet struct { - IPAddressVersion IPAddressVersion // The IP addresses that are currently blocked. Addresses []*string + + IPAddressVersion IPAddressVersion } // This is the latest version of AWS WAF, named AWS WAFV2, released in November, @@ -863,11 +864,8 @@ type Regex struct { // the Rule () statement RegexPatternSetReferenceStatement (). type RegexPatternSet struct { - // The name of the set. You cannot change the name after you create the set. - Name *string - - // The regular expression patterns in the set. - RegularExpressionList []*Regex + // The Amazon Resource Name (ARN) of the entity. + ARN *string // A description of the set that helps with identification. You cannot change the // description of a set after you create it. @@ -877,8 +875,11 @@ type RegexPatternSet struct { // and list commands. You provide it to operations like update and delete. Id *string - // The Amazon Resource Name (ARN) of the entity. - ARN *string + // The name of the set. You cannot change the name after you create the set. + Name *string + + // The regular expression patterns in the set. + RegularExpressionList []*Regex } // This is the latest version of AWS WAF, named AWS WAFV2, released in November, @@ -902,6 +903,12 @@ type RegexPatternSetReferenceStatement struct { // This member is required. ARN *string + // The part of a web request that you want AWS WAF to inspect. For more + // information, see FieldToMatch (). + // + // This member is required. + FieldToMatch *FieldToMatch + // Text transformations eliminate some of the unusual formatting that attackers use // in web requests in an effort to bypass detection. If you specify one or more // transformations in a rule statement, AWS WAF performs all transformations on the @@ -910,12 +917,6 @@ type RegexPatternSetReferenceStatement struct { // // This member is required. TextTransformations []*TextTransformation - - // The part of a web request that you want AWS WAF to inspect. For more - // information, see FieldToMatch (). - // - // This member is required. - FieldToMatch *FieldToMatch } // This is the latest version of AWS WAF, named AWS WAFV2, released in November, @@ -928,10 +929,6 @@ type RegexPatternSetReferenceStatement struct { // RegexPatternSetReferenceStatement () to use the pattern set in a Rule (). type RegexPatternSetSummary struct { - // The name of the data type instance. You cannot change the name after you create - // the instance. - Name *string - // The Amazon Resource Name (ARN) of the entity. ARN *string @@ -951,6 +948,10 @@ type RegexPatternSetSummary struct { // has been made, the update fails with a WAFOptimisticLockException. If this // happens, perform another get, and use the new token returned by that operation. LockToken *string + + // The name of the data type instance. You cannot change the name after you create + // the instance. + Name *string } // This is the latest version of AWS WAF, named AWS WAFV2, released in November, @@ -963,6 +964,11 @@ type RegexPatternSetSummary struct { // parameters that govern how AWS WAF handles them. type Rule struct { + // The name of the rule. You can't change the name of a Rule after you create it. + // + // This member is required. + Name *string + // If you define more than one Rule in a WebACL, AWS WAF evaluates each request // against the Rules in order based on the value of Priority. AWS WAF processes // rules with lower priority first. The priorities don't need to be consecutive, @@ -971,6 +977,17 @@ type Rule struct { // This member is required. Priority *int32 + // The AWS WAF processing statement for the rule, for example ByteMatchStatement () + // or SizeConstraintStatement (). + // + // This member is required. + Statement *Statement + + // Defines and enables Amazon CloudWatch metrics and web request sample collection. + // + // This member is required. + VisibilityConfig *VisibilityConfig + // The action that AWS WAF should take on a web request when it matches the rule // statement. Settings at the web ACL level can override the rule action setting. // This is used only for rules whose statements do not reference a rule group. Rule @@ -1000,22 +1017,6 @@ type Rule struct { // * If the rule statement does not reference a rule group, use the // rule action setting and not this rule override action setting. OverrideAction *OverrideAction - - // The name of the rule. You can't change the name of a Rule after you create it. - // - // This member is required. - Name *string - - // The AWS WAF processing statement for the rule, for example ByteMatchStatement () - // or SizeConstraintStatement (). - // - // This member is required. - Statement *Statement - - // Defines and enables Amazon CloudWatch metrics and web request sample collection. - // - // This member is required. - VisibilityConfig *VisibilityConfig } // This is the latest version of AWS WAF, named AWS WAFV2, released in November, @@ -1029,11 +1030,11 @@ type RuleAction struct { // Instructs AWS WAF to allow the web request. Allow *AllowAction - // Instructs AWS WAF to count the web request and allow it. - Count *CountAction - // Instructs AWS WAF to block the web request. Block *BlockAction + + // Instructs AWS WAF to count the web request and allow it. + Count *CountAction } // This is the latest version of AWS WAF, named AWS WAFV2, released in November, @@ -1047,38 +1048,11 @@ type RuleAction struct { // requirements. type RuleGroup struct { - // A unique identifier for the rule group. This ID is returned in the responses to - // create and list commands. You provide it to operations like update and delete. - // - // This member is required. - Id *string - // The Amazon Resource Name (ARN) of the entity. // // This member is required. ARN *string - // Defines and enables Amazon CloudWatch metrics and web request sample collection. - // - // This member is required. - VisibilityConfig *VisibilityConfig - - // The Rule () statements used to identify the web requests that you want to allow, - // block, or count. Each rule includes one top-level statement that AWS WAF uses to - // identify matching web requests, and parameters that govern how AWS WAF handles - // them. - Rules []*Rule - - // The name of the rule group. You cannot change the name of a rule group after you - // create it. - // - // This member is required. - Name *string - - // A description of the rule group that helps with identification. You cannot - // change the description of a rule group after you create it. - Description *string - // The web ACL capacity units (WCUs) required for this rule group. When you create // your own rule group, you define this, and you cannot change it after creation. // When you add or modify the rules in a rule group, AWS WAF enforces this limit. @@ -1093,6 +1067,33 @@ type RuleGroup struct { // // This member is required. Capacity *int64 + + // A unique identifier for the rule group. This ID is returned in the responses to + // create and list commands. You provide it to operations like update and delete. + // + // This member is required. + Id *string + + // The name of the rule group. You cannot change the name of a rule group after you + // create it. + // + // This member is required. + Name *string + + // Defines and enables Amazon CloudWatch metrics and web request sample collection. + // + // This member is required. + VisibilityConfig *VisibilityConfig + + // A description of the rule group that helps with identification. You cannot + // change the description of a rule group after you create it. + Description *string + + // The Rule () statements used to identify the web requests that you want to allow, + // block, or count. Each rule includes one top-level statement that AWS WAF uses to + // identify matching web requests, and parameters that govern how AWS WAF handles + // them. + Rules []*Rule } // This is the latest version of AWS WAF, named AWS WAFV2, released in November, @@ -1126,6 +1127,17 @@ type RuleGroupReferenceStatement struct { // RuleGroupReferenceStatement () to use the rule group in a Rule (). type RuleGroupSummary struct { + // The Amazon Resource Name (ARN) of the entity. + ARN *string + + // A description of the rule group that helps with identification. You cannot + // change the description of a rule group after you create it. + Description *string + + // A unique identifier for the rule group. This ID is returned in the responses to + // create and list commands. You provide it to operations like update and delete. + Id *string + // A token used for optimistic locking. AWS WAF returns a token to your get and // list requests, to mark the state of the entity at the time of the request. To // make changes to the entity associated with the token, you provide the token to @@ -1135,20 +1147,9 @@ type RuleGroupSummary struct { // happens, perform another get, and use the new token returned by that operation. LockToken *string - // A unique identifier for the rule group. This ID is returned in the responses to - // create and list commands. You provide it to operations like update and delete. - Id *string - - // A description of the rule group that helps with identification. You cannot - // change the description of a rule group after you create it. - Description *string - // The name of the data type instance. You cannot change the name after you create // the instance. Name *string - - // The Amazon Resource Name (ARN) of the entity. - ARN *string } // This is the latest version of AWS WAF, named AWS WAFV2, released in November, @@ -1188,9 +1189,6 @@ type SampledHTTPRequest struct { // This member is required. Request *HTTPRequest - // The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT. - Action *string - // A value that indicates how one result in the response relates proportionally to // other results in the response. For example, a result that has a weight of 2 // represents roughly twice as many web requests as a result that has a weight of @@ -1199,6 +1197,9 @@ type SampledHTTPRequest struct { // This member is required. Weight *int64 + // The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT. + Action *string + // The name of the Rule that the request matched. For managed rule groups, the // format for this name is ##. For your own rule groups, the format for this name // is #. If the rule is not in a rule group, the format is . @@ -1255,15 +1256,21 @@ type SingleQueryArgument struct { // is nine characters long. type SizeConstraintStatement struct { - // The size, in byte, to compare to the request part, after any transformations. + // The operator to use to compare the request part to the size setting. // // This member is required. - Size *int64 + ComparisonOperator ComparisonOperator - // The operator to use to compare the request part to the size setting. + // The part of a web request that you want AWS WAF to inspect. For more + // information, see FieldToMatch (). // // This member is required. - ComparisonOperator ComparisonOperator + FieldToMatch *FieldToMatch + + // The size, in byte, to compare to the request part, after any transformations. + // + // This member is required. + Size *int64 // Text transformations eliminate some of the unusual formatting that attackers use // in web requests in an effort to bypass detection. If you specify one or more @@ -1273,12 +1280,6 @@ type SizeConstraintStatement struct { // // This member is required. TextTransformations []*TextTransformation - - // The part of a web request that you want AWS WAF to inspect. For more - // information, see FieldToMatch (). - // - // This member is required. - FieldToMatch *FieldToMatch } // This is the latest version of AWS WAF, named AWS WAFV2, released in November, @@ -1294,6 +1295,12 @@ type SizeConstraintStatement struct { // requests that appear to contain malicious SQL code. type SqliMatchStatement struct { + // The part of a web request that you want AWS WAF to inspect. For more + // information, see FieldToMatch (). + // + // This member is required. + FieldToMatch *FieldToMatch + // Text transformations eliminate some of the unusual formatting that attackers use // in web requests in an effort to bypass detection. If you specify one or more // transformations in a rule statement, AWS WAF performs all transformations on the @@ -1302,12 +1309,6 @@ type SqliMatchStatement struct { // // This member is required. TextTransformations []*TextTransformation - - // The part of a web request that you want AWS WAF to inspect. For more - // information, see FieldToMatch (). - // - // This member is required. - FieldToMatch *FieldToMatch } // This is the latest version of AWS WAF, named AWS WAFV2, released in November, @@ -1318,20 +1319,9 @@ type SqliMatchStatement struct { // request matches the rule. type Statement struct { - // A rule statement used to run the rules that are defined in a managed rule group. - // To use this, provide the vendor name and the name of the rule group in this - // statement. You can retrieve the required names by calling - // ListAvailableManagedRuleGroups (). You can't nest a ManagedRuleGroupStatement, - // for example for use inside a NotStatement or OrStatement. It can only be - // referenced as a top-level statement within a rule. - ManagedRuleGroupStatement *ManagedRuleGroupStatement - - // A rule statement used to run the rules that are defined in a RuleGroup (). To - // use this, create a rule group with your rules, then provide the ARN of the rule - // group in this statement. You cannot nest a RuleGroupReferenceStatement, for - // example for use inside a NotStatement or OrStatement. It can only be referenced - // as a top-level statement within a rule. - RuleGroupReferenceStatement *RuleGroupReferenceStatement + // A logical rule statement used to combine other rule statements with AND logic. + // You provide more than one Statement () within the AndStatement. + AndStatement *AndStatement // A rule statement that defines a string match search for AWS WAF to apply to web // requests. The byte match statement provides the bytes to search for, the @@ -1341,9 +1331,33 @@ type Statement struct { // as a string match statement. ByteMatchStatement *ByteMatchStatement - // A logical rule statement used to combine other rule statements with AND logic. - // You provide more than one Statement () within the AndStatement. - AndStatement *AndStatement + // A rule statement used to identify web requests based on country of origin. + GeoMatchStatement *GeoMatchStatement + + // A rule statement used to detect web requests coming from particular IP addresses + // or address ranges. To use this, create an IPSet () that specifies the addresses + // you want to detect, then use the ARN of that set in this statement. To create an + // IP set, see CreateIPSet (). Each IP set rule statement references an IP set. You + // create and maintain the set independent of your rules. This allows you to use + // the single set in multiple rules. When you update the referenced set, AWS WAF + // automatically updates all rules that reference it. + IPSetReferenceStatement *IPSetReferenceStatement + + // A rule statement used to run the rules that are defined in a managed rule group. + // To use this, provide the vendor name and the name of the rule group in this + // statement. You can retrieve the required names by calling + // ListAvailableManagedRuleGroups (). You can't nest a ManagedRuleGroupStatement, + // for example for use inside a NotStatement or OrStatement. It can only be + // referenced as a top-level statement within a rule. + ManagedRuleGroupStatement *ManagedRuleGroupStatement + + // A logical rule statement used to negate the results of another rule statement. + // You provide one Statement () within the NotStatement. + NotStatement *NotStatement + + // A logical rule statement used to combine other rule statements with OR logic. + // You provide more than one Statement () within the OrStatement. + OrStatement *OrStatement // A rate-based rule tracks the rate of requests for each originating IP address, // and triggers the rule action when the rate exceeds a limit that you specify on @@ -1373,26 +1387,6 @@ type Statement struct { // statement within a rule. RateBasedStatement *RateBasedStatement - // A logical rule statement used to negate the results of another rule statement. - // You provide one Statement () within the NotStatement. - NotStatement *NotStatement - - // A rule statement used to identify web requests based on country of origin. - GeoMatchStatement *GeoMatchStatement - - // A logical rule statement used to combine other rule statements with OR logic. - // You provide more than one Statement () within the OrStatement. - OrStatement *OrStatement - - // Attackers sometimes insert malicious SQL code into web requests in an effort to - // extract data from your database. To allow or block web requests that appear to - // contain malicious SQL code, create one or more SQL injection match conditions. - // An SQL injection match condition identifies the part of web requests, such as - // the URI or the query string, that you want AWS WAF to inspect. Later in the - // process, when you create a web ACL, you specify whether to allow or block - // requests that appear to contain malicious SQL code. - SqliMatchStatement *SqliMatchStatement - // A rule statement used to search web request components for matches with regular // expressions. To use this, create a RegexPatternSet () that specifies the // expressions that you want to detect, then use the ARN of that set in this @@ -1404,23 +1398,12 @@ type Statement struct { // referenced set, AWS WAF automatically updates all rules that reference it. RegexPatternSetReferenceStatement *RegexPatternSetReferenceStatement - // A rule statement used to detect web requests coming from particular IP addresses - // or address ranges. To use this, create an IPSet () that specifies the addresses - // you want to detect, then use the ARN of that set in this statement. To create an - // IP set, see CreateIPSet (). Each IP set rule statement references an IP set. You - // create and maintain the set independent of your rules. This allows you to use - // the single set in multiple rules. When you update the referenced set, AWS WAF - // automatically updates all rules that reference it. - IPSetReferenceStatement *IPSetReferenceStatement - - // A rule statement that defines a cross-site scripting (XSS) match search for AWS - // WAF to apply to web requests. XSS attacks are those where the attacker uses - // vulnerabilities in a benign website as a vehicle to inject malicious client-site - // scripts into other legitimate web browsers. The XSS match statement provides the - // location in requests that you want AWS WAF to search and text transformations to - // use on the search area before AWS WAF searches for character sequences that are - // likely to be malicious strings. - XssMatchStatement *XssMatchStatement + // A rule statement used to run the rules that are defined in a RuleGroup (). To + // use this, create a rule group with your rules, then provide the ARN of the rule + // group in this statement. You cannot nest a RuleGroupReferenceStatement, for + // example for use inside a NotStatement or OrStatement. It can only be referenced + // as a top-level statement within a rule. + RuleGroupReferenceStatement *RuleGroupReferenceStatement // A rule statement that compares a number of bytes against the size of a request // component, using a comparison operator, such as greater than (>) or less than @@ -1433,6 +1416,24 @@ type Statement struct { // the slash (/) in the URI counts as one character. For example, the URI /logo.jpg // is nine characters long. SizeConstraintStatement *SizeConstraintStatement + + // Attackers sometimes insert malicious SQL code into web requests in an effort to + // extract data from your database. To allow or block web requests that appear to + // contain malicious SQL code, create one or more SQL injection match conditions. + // An SQL injection match condition identifies the part of web requests, such as + // the URI or the query string, that you want AWS WAF to inspect. Later in the + // process, when you create a web ACL, you specify whether to allow or block + // requests that appear to contain malicious SQL code. + SqliMatchStatement *SqliMatchStatement + + // A rule statement that defines a cross-site scripting (XSS) match search for AWS + // WAF to apply to web requests. XSS attacks are those where the attacker uses + // vulnerabilities in a benign website as a vehicle to inject malicious client-site + // scripts into other legitimate web browsers. The XSS match statement provides the + // location in requests that you want AWS WAF to search and text transformations to + // use on the search area before AWS WAF searches for character sequences that are + // likely to be malicious strings. + XssMatchStatement *XssMatchStatement } // This is the latest version of AWS WAF, named AWS WAFV2, released in November, @@ -1451,18 +1452,18 @@ type Statement struct { // console. type Tag struct { + // Part of the key:value pair that defines a tag. You can use a tag key to describe + // a category of information, such as "customer." Tag keys are case-sensitive. + // + // This member is required. + Key *string + // Part of the key:value pair that defines a tag. You can use a tag value to // describe a specific value within a category, such as "companyA" or "companyB." // Tag values are case-sensitive. // // This member is required. Value *string - - // Part of the key:value pair that defines a tag. You can use a tag key to describe - // a category of information, such as "customer." Tag keys are case-sensitive. - // - // This member is required. - Key *string } // This is the latest version of AWS WAF, named AWS WAFV2, released in November, @@ -1567,23 +1568,23 @@ type TextTransformation struct { // request. type TimeWindow struct { - // The beginning of the time range from which you want GetSampledRequests to return - // a sample of the requests that your AWS resource received. You must specify the + // The end of the time range from which you want GetSampledRequests to return a + // sample of the requests that your AWS resource received. You must specify the // times in Coordinated Universal Time (UTC) format. UTC format includes the // special designator, Z. For example, "2016-09-27T14:50Z". You can specify any // time range in the previous three hours. // // This member is required. - StartTime *time.Time + EndTime *time.Time - // The end of the time range from which you want GetSampledRequests to return a - // sample of the requests that your AWS resource received. You must specify the + // The beginning of the time range from which you want GetSampledRequests to return + // a sample of the requests that your AWS resource received. You must specify the // times in Coordinated Universal Time (UTC) format. UTC format includes the // special designator, Z. For example, "2016-09-27T14:50Z". You can specify any // time range in the previous three hours. // // This member is required. - EndTime *time.Time + StartTime *time.Time } // This is the latest version of AWS WAF, named AWS WAFV2, released in November, @@ -1604,13 +1605,6 @@ type UriPath struct { // Defines and enables Amazon CloudWatch metrics and web request sample collection. type VisibilityConfig struct { - // A boolean indicating whether AWS WAF should store a sampling of the web requests - // that match the rules. You can view the sampled requests through the AWS WAF - // console. - // - // This member is required. - SampledRequestsEnabled *bool - // A boolean indicating whether the associated resource sends metrics to // CloudWatch. For the list of available metrics, see AWS WAF Metrics // (https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics). @@ -1626,6 +1620,13 @@ type VisibilityConfig struct { // // This member is required. MetricName *string + + // A boolean indicating whether AWS WAF should store a sampling of the web requests + // that match the rules. You can view the sampled requests through the AWS WAF + // console. + // + // This member is required. + SampledRequestsEnabled *bool } // This is the latest version of AWS WAF, named AWS WAFV2, released in November, @@ -1642,31 +1643,17 @@ type VisibilityConfig struct { // or an Application Load Balancer. type WebACL struct { - // The name of the Web ACL. You cannot change the name of a Web ACL after you - // create it. + // The Amazon Resource Name (ARN) of the Web ACL that you want to associate with + // the resource. // // This member is required. - Name *string - - // The last set of rules for AWS WAF to process in the web ACL. This is defined in - // an AWS Firewall Manager WAF policy and contains only rule group references. You - // can't alter these. Any rules and rule groups that you define for the web ACL are - // prioritized before these. In the Firewall Manager WAF policy, the Firewall - // Manager administrator can define a set of rule groups to run first in the web - // ACL and a set of rule groups to run last. Within each set, the administrator - // prioritizes the rule groups, to determine their relative processing order. - PostProcessFirewallManagerRuleGroups []*FirewallManagerRuleGroup + ARN *string // The action to perform if none of the Rules contained in the WebACL match. // // This member is required. DefaultAction *DefaultAction - // Defines and enables Amazon CloudWatch metrics and web request sample collection. - // - // This member is required. - VisibilityConfig *VisibilityConfig - // A unique identifier for the WebACL. This ID is returned in the responses to // create and list commands. You use this ID to do things like get, update, and // delete a WebACL. @@ -1674,9 +1661,16 @@ type WebACL struct { // This member is required. Id *string - // A description of the Web ACL that helps with identification. You cannot change - // the description of a Web ACL after you create it. - Description *string + // The name of the Web ACL. You cannot change the name of a Web ACL after you + // create it. + // + // This member is required. + Name *string + + // Defines and enables Amazon CloudWatch metrics and web request sample collection. + // + // This member is required. + VisibilityConfig *VisibilityConfig // The web ACL capacity units (WCUs) currently being used by this web ACL. AWS WAF // uses WCUs to calculate and control the operating resources that are used to run @@ -1688,6 +1682,24 @@ type WebACL struct { // ACLs is 1,500. Capacity *int64 + // A description of the Web ACL that helps with identification. You cannot change + // the description of a Web ACL after you create it. + Description *string + + // Indicates whether this web ACL is managed by AWS Firewall Manager. If true, then + // only AWS Firewall Manager can delete the web ACL or any Firewall Manager rule + // groups in the web ACL. + ManagedByFirewallManager *bool + + // The last set of rules for AWS WAF to process in the web ACL. This is defined in + // an AWS Firewall Manager WAF policy and contains only rule group references. You + // can't alter these. Any rules and rule groups that you define for the web ACL are + // prioritized before these. In the Firewall Manager WAF policy, the Firewall + // Manager administrator can define a set of rule groups to run first in the web + // ACL and a set of rule groups to run last. Within each set, the administrator + // prioritizes the rule groups, to determine their relative processing order. + PostProcessFirewallManagerRuleGroups []*FirewallManagerRuleGroup + // The first set of rules for AWS WAF to process in the web ACL. This is defined in // an AWS Firewall Manager WAF policy and contains only rule group references. You // can't alter these. Any rules and rule groups that you define for the web ACL are @@ -1697,17 +1709,6 @@ type WebACL struct { // prioritizes the rule groups, to determine their relative processing order. PreProcessFirewallManagerRuleGroups []*FirewallManagerRuleGroup - // Indicates whether this web ACL is managed by AWS Firewall Manager. If true, then - // only AWS Firewall Manager can delete the web ACL or any Firewall Manager rule - // groups in the web ACL. - ManagedByFirewallManager *bool - - // The Amazon Resource Name (ARN) of the Web ACL that you want to associate with - // the resource. - // - // This member is required. - ARN *string - // The Rule () statements used to identify the web requests that you want to allow, // block, or count. Each rule includes one top-level statement that AWS WAF uses to // identify matching web requests, and parameters that govern how AWS WAF handles @@ -1725,9 +1726,16 @@ type WebACL struct { // AssociateWebACL (). type WebACLSummary struct { - // The name of the Web ACL. You cannot change the name of a Web ACL after you - // create it. - Name *string + // The Amazon Resource Name (ARN) of the entity. + ARN *string + + // A description of the Web ACL that helps with identification. You cannot change + // the description of a Web ACL after you create it. + Description *string + + // The unique identifier for the Web ACL. This ID is returned in the responses to + // create and list commands. You provide it to operations like update and delete. + Id *string // A token used for optimistic locking. AWS WAF returns a token to your get and // list requests, to mark the state of the entity at the time of the request. To @@ -1738,16 +1746,9 @@ type WebACLSummary struct { // happens, perform another get, and use the new token returned by that operation. LockToken *string - // A description of the Web ACL that helps with identification. You cannot change - // the description of a Web ACL after you create it. - Description *string - - // The Amazon Resource Name (ARN) of the entity. - ARN *string - - // The unique identifier for the Web ACL. This ID is returned in the responses to - // create and list commands. You provide it to operations like update and delete. - Id *string + // The name of the Web ACL. You cannot change the name of a Web ACL after you + // create it. + Name *string } // This is the latest version of AWS WAF, named AWS WAFV2, released in November, @@ -1763,6 +1764,12 @@ type WebACLSummary struct { // likely to be malicious strings. type XssMatchStatement struct { + // The part of a web request that you want AWS WAF to inspect. For more + // information, see FieldToMatch (). + // + // This member is required. + FieldToMatch *FieldToMatch + // Text transformations eliminate some of the unusual formatting that attackers use // in web requests in an effort to bypass detection. If you specify one or more // transformations in a rule statement, AWS WAF performs all transformations on the @@ -1771,10 +1778,4 @@ type XssMatchStatement struct { // // This member is required. TextTransformations []*TextTransformation - - // The part of a web request that you want AWS WAF to inspect. For more - // information, see FieldToMatch (). - // - // This member is required. - FieldToMatch *FieldToMatch } diff --git a/service/workdocs/api_op_ActivateUser.go b/service/workdocs/api_op_ActivateUser.go index c27d0ce68b6..2669f2d2226 100644 --- a/service/workdocs/api_op_ActivateUser.go +++ b/service/workdocs/api_op_ActivateUser.go @@ -57,14 +57,14 @@ func (c *Client) ActivateUser(ctx context.Context, params *ActivateUserInput, op type ActivateUserInput struct { - // Amazon WorkDocs authentication token. Not required when using AWS administrator - // credentials to access the API. - AuthenticationToken *string - // The ID of the user. // // This member is required. UserId *string + + // Amazon WorkDocs authentication token. Not required when using AWS administrator + // credentials to access the API. + AuthenticationToken *string } type ActivateUserOutput struct { diff --git a/service/workdocs/api_op_AddResourcePermissions.go b/service/workdocs/api_op_AddResourcePermissions.go index 814a63bdbae..68d0107b823 100644 --- a/service/workdocs/api_op_AddResourcePermissions.go +++ b/service/workdocs/api_op_AddResourcePermissions.go @@ -59,22 +59,22 @@ func (c *Client) AddResourcePermissions(ctx context.Context, params *AddResource type AddResourcePermissionsInput struct { - // The notification options. - NotificationOptions *types.NotificationOptions - - // Amazon WorkDocs authentication token. Not required when using AWS administrator - // credentials to access the API. - AuthenticationToken *string + // The users, groups, or organization being granted permission. + // + // This member is required. + Principals []*types.SharePrincipal // The ID of the resource. // // This member is required. ResourceId *string - // The users, groups, or organization being granted permission. - // - // This member is required. - Principals []*types.SharePrincipal + // Amazon WorkDocs authentication token. Not required when using AWS administrator + // credentials to access the API. + AuthenticationToken *string + + // The notification options. + NotificationOptions *types.NotificationOptions } type AddResourcePermissionsOutput struct { diff --git a/service/workdocs/api_op_CreateComment.go b/service/workdocs/api_op_CreateComment.go index a3eb798ab7b..63c4914d968 100644 --- a/service/workdocs/api_op_CreateComment.go +++ b/service/workdocs/api_op_CreateComment.go @@ -57,20 +57,15 @@ func (c *Client) CreateComment(ctx context.Context, params *CreateCommentInput, type CreateCommentInput struct { - // Set this parameter to TRUE to send an email out to the document collaborators - // after the comment is created. - NotifyCollaborators *bool - - // The ID of the parent comment. - ParentId *string - - // The visibility of the comment. Options are either PRIVATE, where the comment is - // visible only to the comment author and document owner and co-owners, or PUBLIC, - // where the comment is visible to document owners, co-owners, and contributors. - Visibility types.CommentVisibilityType + // The ID of the document. + // + // This member is required. + DocumentId *string - // The ID of the root comment in the thread. - ThreadId *string + // The text of the comment. + // + // This member is required. + Text *string // The ID of the document version. // @@ -81,15 +76,20 @@ type CreateCommentInput struct { // credentials to access the API. AuthenticationToken *string - // The text of the comment. - // - // This member is required. - Text *string + // Set this parameter to TRUE to send an email out to the document collaborators + // after the comment is created. + NotifyCollaborators *bool - // The ID of the document. - // - // This member is required. - DocumentId *string + // The ID of the parent comment. + ParentId *string + + // The ID of the root comment in the thread. + ThreadId *string + + // The visibility of the comment. Options are either PRIVATE, where the comment is + // visible only to the comment author and document owner and co-owners, or PUBLIC, + // where the comment is visible to document owners, co-owners, and contributors. + Visibility types.CommentVisibilityType } type CreateCommentOutput struct { diff --git a/service/workdocs/api_op_CreateCustomMetadata.go b/service/workdocs/api_op_CreateCustomMetadata.go index bfa7bb09be3..12552269002 100644 --- a/service/workdocs/api_op_CreateCustomMetadata.go +++ b/service/workdocs/api_op_CreateCustomMetadata.go @@ -62,6 +62,11 @@ type CreateCustomMetadataInput struct { // This member is required. CustomMetadata map[string]*string + // The ID of the resource. + // + // This member is required. + ResourceId *string + // Amazon WorkDocs authentication token. Not required when using AWS administrator // credentials to access the API. AuthenticationToken *string @@ -69,11 +74,6 @@ type CreateCustomMetadataInput struct { // The ID of the version, if the custom metadata is being added to a document // version. VersionId *string - - // The ID of the resource. - // - // This member is required. - ResourceId *string } type CreateCustomMetadataOutput struct { diff --git a/service/workdocs/api_op_CreateFolder.go b/service/workdocs/api_op_CreateFolder.go index 29c4fad04b1..688ac0a76c6 100644 --- a/service/workdocs/api_op_CreateFolder.go +++ b/service/workdocs/api_op_CreateFolder.go @@ -57,17 +57,17 @@ func (c *Client) CreateFolder(ctx context.Context, params *CreateFolderInput, op type CreateFolderInput struct { + // The ID of the parent folder. + // + // This member is required. + ParentFolderId *string + // Amazon WorkDocs authentication token. Not required when using AWS administrator // credentials to access the API. AuthenticationToken *string // The name of the new folder. Name *string - - // The ID of the parent folder. - // - // This member is required. - ParentFolderId *string } type CreateFolderOutput struct { diff --git a/service/workdocs/api_op_CreateLabels.go b/service/workdocs/api_op_CreateLabels.go index b7d71f7fcfd..9581a369cb3 100644 --- a/service/workdocs/api_op_CreateLabels.go +++ b/service/workdocs/api_op_CreateLabels.go @@ -56,10 +56,6 @@ func (c *Client) CreateLabels(ctx context.Context, params *CreateLabelsInput, op type CreateLabelsInput struct { - // Amazon WorkDocs authentication token. Not required when using AWS administrator - // credentials to access the API. - AuthenticationToken *string - // List of labels to add to the resource. // // This member is required. @@ -69,6 +65,10 @@ type CreateLabelsInput struct { // // This member is required. ResourceId *string + + // Amazon WorkDocs authentication token. Not required when using AWS administrator + // credentials to access the API. + AuthenticationToken *string } type CreateLabelsOutput struct { diff --git a/service/workdocs/api_op_CreateNotificationSubscription.go b/service/workdocs/api_op_CreateNotificationSubscription.go index e2e5c3c0245..6bc84d4d6b8 100644 --- a/service/workdocs/api_op_CreateNotificationSubscription.go +++ b/service/workdocs/api_op_CreateNotificationSubscription.go @@ -61,27 +61,27 @@ func (c *Client) CreateNotificationSubscription(ctx context.Context, params *Cre type CreateNotificationSubscriptionInput struct { - // The notification type. + // The endpoint to receive the notifications. If the protocol is HTTPS, the + // endpoint is a URL that begins with https. // // This member is required. - SubscriptionType types.SubscriptionType + Endpoint *string - // The protocol to use. The supported value is https, which delivers JSON-encoded - // messages using HTTPS POST. + // The ID of the organization. // // This member is required. - Protocol types.SubscriptionProtocolType + OrganizationId *string - // The endpoint to receive the notifications. If the protocol is HTTPS, the - // endpoint is a URL that begins with https. + // The protocol to use. The supported value is https, which delivers JSON-encoded + // messages using HTTPS POST. // // This member is required. - Endpoint *string + Protocol types.SubscriptionProtocolType - // The ID of the organization. + // The notification type. // // This member is required. - OrganizationId *string + SubscriptionType types.SubscriptionType } type CreateNotificationSubscriptionOutput struct { diff --git a/service/workdocs/api_op_CreateUser.go b/service/workdocs/api_op_CreateUser.go index c88af8dde7c..d5c8372a8c1 100644 --- a/service/workdocs/api_op_CreateUser.go +++ b/service/workdocs/api_op_CreateUser.go @@ -63,36 +63,36 @@ type CreateUserInput struct { // This member is required. GivenName *string + // The password of the user. + // + // This member is required. + Password *string + // The surname of the user. // // This member is required. Surname *string - // The ID of the organization. - OrganizationId *string - // The login name of the user. // // This member is required. Username *string - // The time zone ID of the user. - TimeZoneId *string - // Amazon WorkDocs authentication token. Not required when using AWS administrator // credentials to access the API. AuthenticationToken *string - // The amount of storage for the user. - StorageRule *types.StorageRuleType - // The email address of the user. EmailAddress *string - // The password of the user. - // - // This member is required. - Password *string + // The ID of the organization. + OrganizationId *string + + // The amount of storage for the user. + StorageRule *types.StorageRuleType + + // The time zone ID of the user. + TimeZoneId *string } type CreateUserOutput struct { diff --git a/service/workdocs/api_op_DeleteComment.go b/service/workdocs/api_op_DeleteComment.go index 9450eee9927..099e5607824 100644 --- a/service/workdocs/api_op_DeleteComment.go +++ b/service/workdocs/api_op_DeleteComment.go @@ -61,15 +61,15 @@ type DeleteCommentInput struct { // This member is required. CommentId *string - // The ID of the document version. + // The ID of the document. // // This member is required. - VersionId *string + DocumentId *string - // The ID of the document. + // The ID of the document version. // // This member is required. - DocumentId *string + VersionId *string // Amazon WorkDocs authentication token. Not required when using AWS administrator // credentials to access the API. diff --git a/service/workdocs/api_op_DeleteCustomMetadata.go b/service/workdocs/api_op_DeleteCustomMetadata.go index fb44ac5cc1e..e77e7a9a171 100644 --- a/service/workdocs/api_op_DeleteCustomMetadata.go +++ b/service/workdocs/api_op_DeleteCustomMetadata.go @@ -56,25 +56,25 @@ func (c *Client) DeleteCustomMetadata(ctx context.Context, params *DeleteCustomM type DeleteCustomMetadataInput struct { - // Flag to indicate removal of all custom metadata properties from the specified - // resource. - DeleteAll *bool + // The ID of the resource, either a document or folder. + // + // This member is required. + ResourceId *string // Amazon WorkDocs authentication token. Not required when using AWS administrator // credentials to access the API. AuthenticationToken *string - // The ID of the resource, either a document or folder. - // - // This member is required. - ResourceId *string + // Flag to indicate removal of all custom metadata properties from the specified + // resource. + DeleteAll *bool + + // List of properties to remove. + Keys []*string // The ID of the version, if the custom metadata is being deleted from a document // version. VersionId *string - - // List of properties to remove. - Keys []*string } type DeleteCustomMetadataOutput struct { diff --git a/service/workdocs/api_op_DeleteLabels.go b/service/workdocs/api_op_DeleteLabels.go index 9fd516d1065..f324eb0c444 100644 --- a/service/workdocs/api_op_DeleteLabels.go +++ b/service/workdocs/api_op_DeleteLabels.go @@ -56,17 +56,17 @@ func (c *Client) DeleteLabels(ctx context.Context, params *DeleteLabelsInput, op type DeleteLabelsInput struct { - // Flag to request removal of all labels from the specified resource. - DeleteAll *bool + // The ID of the resource. + // + // This member is required. + ResourceId *string // Amazon WorkDocs authentication token. Not required when using AWS administrator // credentials to access the API. AuthenticationToken *string - // The ID of the resource. - // - // This member is required. - ResourceId *string + // Flag to request removal of all labels from the specified resource. + DeleteAll *bool // List of labels to delete from the resource. Labels []*string diff --git a/service/workdocs/api_op_DeleteNotificationSubscription.go b/service/workdocs/api_op_DeleteNotificationSubscription.go index d3ca094b191..c81526a6320 100644 --- a/service/workdocs/api_op_DeleteNotificationSubscription.go +++ b/service/workdocs/api_op_DeleteNotificationSubscription.go @@ -56,15 +56,15 @@ func (c *Client) DeleteNotificationSubscription(ctx context.Context, params *Del type DeleteNotificationSubscriptionInput struct { - // The ID of the subscription. + // The ID of the organization. // // This member is required. - SubscriptionId *string + OrganizationId *string - // The ID of the organization. + // The ID of the subscription. // // This member is required. - OrganizationId *string + SubscriptionId *string } type DeleteNotificationSubscriptionOutput struct { diff --git a/service/workdocs/api_op_DescribeActivities.go b/service/workdocs/api_op_DescribeActivities.go index 3dd93e967cc..1c19895aa1d 100644 --- a/service/workdocs/api_op_DescribeActivities.go +++ b/service/workdocs/api_op_DescribeActivities.go @@ -57,20 +57,17 @@ func (c *Client) DescribeActivities(ctx context.Context, params *DescribeActivit type DescribeActivitiesInput struct { - // Amazon WorkDocs authentication token. Not required when using AWS administrator - // credentials to access the API. - AuthenticationToken *string - // Specifies which activity types to include in the response. If this field is left // empty, all activity types are returned. ActivityTypes *string - // The ID of the organization. This is a mandatory parameter when using - // administrative API (SigV4) requests. - OrganizationId *string + // Amazon WorkDocs authentication token. Not required when using AWS administrator + // credentials to access the API. + AuthenticationToken *string - // The marker for the next set of results. - Marker *string + // The timestamp that determines the end time of the activities. The response + // includes the activities performed before the specified timestamp. + EndTime *time.Time // Includes indirect activities. An indirect activity results from a direct // activity performed on a parent resource. For example, sharing a parent folder @@ -81,31 +78,34 @@ type DescribeActivitiesInput struct { // The maximum number of items to return. Limit *int32 - // The timestamp that determines the end time of the activities. The response - // includes the activities performed before the specified timestamp. - EndTime *time.Time + // The marker for the next set of results. + Marker *string - // The ID of the user who performed the action. The response includes activities - // pertaining to this user. This is an optional parameter and is only applicable - // for administrative API (SigV4) requests. - UserId *string + // The ID of the organization. This is a mandatory parameter when using + // administrative API (SigV4) requests. + OrganizationId *string + + // The document or folder ID for which to describe activity types. + ResourceId *string // The timestamp that determines the starting time of the activities. The response // includes the activities performed after the specified timestamp. StartTime *time.Time - // The document or folder ID for which to describe activity types. - ResourceId *string + // The ID of the user who performed the action. The response includes activities + // pertaining to this user. This is an optional parameter and is only applicable + // for administrative API (SigV4) requests. + UserId *string } type DescribeActivitiesOutput struct { - // The list of activities for the specified user and time period. - UserActivities []*types.Activity - // The marker for the next set of results. Marker *string + // The list of activities for the specified user and time period. + UserActivities []*types.Activity + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/workdocs/api_op_DescribeComments.go b/service/workdocs/api_op_DescribeComments.go index 4d58604a796..ceca3830e53 100644 --- a/service/workdocs/api_op_DescribeComments.go +++ b/service/workdocs/api_op_DescribeComments.go @@ -57,13 +57,6 @@ func (c *Client) DescribeComments(ctx context.Context, params *DescribeCommentsI type DescribeCommentsInput struct { - // The maximum number of items to return. - Limit *int32 - - // Amazon WorkDocs authentication token. Not required when using AWS administrator - // credentials to access the API. - AuthenticationToken *string - // The ID of the document. // // This member is required. @@ -74,6 +67,13 @@ type DescribeCommentsInput struct { // This member is required. VersionId *string + // Amazon WorkDocs authentication token. Not required when using AWS administrator + // credentials to access the API. + AuthenticationToken *string + + // The maximum number of items to return. + Limit *int32 + // The marker for the next set of results. This marker was received from a previous // call. Marker *string @@ -81,13 +81,13 @@ type DescribeCommentsInput struct { type DescribeCommentsOutput struct { + // The list of comments for the specified document version. + Comments []*types.Comment + // The marker for the next set of results. This marker was received from a previous // call. Marker *string - // The list of comments for the specified document version. - Comments []*types.Comment - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/workdocs/api_op_DescribeDocumentVersions.go b/service/workdocs/api_op_DescribeDocumentVersions.go index ab057d9da04..64deb8cc52b 100644 --- a/service/workdocs/api_op_DescribeDocumentVersions.go +++ b/service/workdocs/api_op_DescribeDocumentVersions.go @@ -58,40 +58,40 @@ func (c *Client) DescribeDocumentVersions(ctx context.Context, params *DescribeD type DescribeDocumentVersionsInput struct { - // A comma-separated list of values. Specify "INITIALIZED" to include incomplete - // versions. - Include *string - // The ID of the document. // // This member is required. DocumentId *string - // The marker for the next set of results. (You received this marker from a - // previous call.) - Marker *string - - // The maximum number of versions to return with this call. - Limit *int32 + // Amazon WorkDocs authentication token. Not required when using AWS administrator + // credentials to access the API. + AuthenticationToken *string // Specify "SOURCE" to include initialized versions and a URL for the source // document. Fields *string - // Amazon WorkDocs authentication token. Not required when using AWS administrator - // credentials to access the API. - AuthenticationToken *string + // A comma-separated list of values. Specify "INITIALIZED" to include incomplete + // versions. + Include *string + + // The maximum number of versions to return with this call. + Limit *int32 + + // The marker for the next set of results. (You received this marker from a + // previous call.) + Marker *string } type DescribeDocumentVersionsOutput struct { + // The document versions. + DocumentVersions []*types.DocumentVersionMetadata + // The marker to use when requesting the next set of results. If there are no // additional results, the string is empty. Marker *string - // The document versions. - DocumentVersions []*types.DocumentVersionMetadata - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/workdocs/api_op_DescribeFolderContents.go b/service/workdocs/api_op_DescribeFolderContents.go index 0d67dc69059..4b80f1dcedd 100644 --- a/service/workdocs/api_op_DescribeFolderContents.go +++ b/service/workdocs/api_op_DescribeFolderContents.go @@ -66,12 +66,9 @@ type DescribeFolderContentsInput struct { // This member is required. FolderId *string - // The sorting criteria. - Sort types.ResourceSortType - - // The marker for the next set of results. This marker was received from a previous - // call. - Marker *string + // Amazon WorkDocs authentication token. Not required when using AWS administrator + // credentials to access the API. + AuthenticationToken *string // The contents to include. Specify "INITIALIZED" to include initialized documents. Include *string @@ -79,12 +76,15 @@ type DescribeFolderContentsInput struct { // The maximum number of items to return with this call. Limit *int32 + // The marker for the next set of results. This marker was received from a previous + // call. + Marker *string + // The order for the contents of the folder. Order types.OrderType - // Amazon WorkDocs authentication token. Not required when using AWS administrator - // credentials to access the API. - AuthenticationToken *string + // The sorting criteria. + Sort types.ResourceSortType // The type of items. Type types.FolderContentType @@ -92,12 +92,12 @@ type DescribeFolderContentsInput struct { type DescribeFolderContentsOutput struct { - // The subfolders in the specified folder. - Folders []*types.FolderMetadata - // The documents in the specified folder. Documents []*types.DocumentMetadata + // The subfolders in the specified folder. + Folders []*types.FolderMetadata + // The marker to use when requesting the next set of results. If there are no // additional results, the string is empty. Marker *string diff --git a/service/workdocs/api_op_DescribeGroups.go b/service/workdocs/api_op_DescribeGroups.go index f7ed8319bf5..87ea81fbc5e 100644 --- a/service/workdocs/api_op_DescribeGroups.go +++ b/service/workdocs/api_op_DescribeGroups.go @@ -63,30 +63,30 @@ type DescribeGroupsInput struct { // This member is required. SearchQuery *string + // Amazon WorkDocs authentication token. Not required when using AWS administrator + // credentials to access the API. + AuthenticationToken *string + // The maximum number of items to return with this call. Limit *int32 - // The ID of the organization. - OrganizationId *string - // The marker for the next set of results. (You received this marker from a // previous call.) Marker *string - // Amazon WorkDocs authentication token. Not required when using AWS administrator - // credentials to access the API. - AuthenticationToken *string + // The ID of the organization. + OrganizationId *string } type DescribeGroupsOutput struct { + // The list of groups. + Groups []*types.GroupMetadata + // The marker to use when requesting the next set of results. If there are no // additional results, the string is empty. Marker *string - // The list of groups. - Groups []*types.GroupMetadata - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/workdocs/api_op_DescribeNotificationSubscriptions.go b/service/workdocs/api_op_DescribeNotificationSubscriptions.go index 3f90f3bc5aa..5706f74ea33 100644 --- a/service/workdocs/api_op_DescribeNotificationSubscriptions.go +++ b/service/workdocs/api_op_DescribeNotificationSubscriptions.go @@ -57,10 +57,6 @@ func (c *Client) DescribeNotificationSubscriptions(ctx context.Context, params * type DescribeNotificationSubscriptionsInput struct { - // The marker for the next set of results. (You received this marker from a - // previous call.) - Marker *string - // The ID of the organization. // // This member is required. @@ -68,17 +64,21 @@ type DescribeNotificationSubscriptionsInput struct { // The maximum number of items to return with this call. Limit *int32 + + // The marker for the next set of results. (You received this marker from a + // previous call.) + Marker *string } type DescribeNotificationSubscriptionsOutput struct { - // The subscriptions. - Subscriptions []*types.Subscription - // The marker to use when requesting the next set of results. If there are no // additional results, the string is empty. Marker *string + // The subscriptions. + Subscriptions []*types.Subscription + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/workdocs/api_op_DescribeResourcePermissions.go b/service/workdocs/api_op_DescribeResourcePermissions.go index 369fce83597..e2ba3122de3 100644 --- a/service/workdocs/api_op_DescribeResourcePermissions.go +++ b/service/workdocs/api_op_DescribeResourcePermissions.go @@ -57,9 +57,6 @@ func (c *Client) DescribeResourcePermissions(ctx context.Context, params *Descri type DescribeResourcePermissionsInput struct { - // The ID of the principal to filter permissions by. - PrincipalId *string - // The ID of the resource. // // This member is required. @@ -75,17 +72,20 @@ type DescribeResourcePermissionsInput struct { // The marker for the next set of results. (You received this marker from a // previous call) Marker *string + + // The ID of the principal to filter permissions by. + PrincipalId *string } type DescribeResourcePermissionsOutput struct { - // The principals. - Principals []*types.Principal - // The marker to use when requesting the next set of results. If there are no // additional results, the string is empty. Marker *string + // The principals. + Principals []*types.Principal + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/workdocs/api_op_DescribeRootFolders.go b/service/workdocs/api_op_DescribeRootFolders.go index f5e2bb46e64..5b41dadb63f 100644 --- a/service/workdocs/api_op_DescribeRootFolders.go +++ b/service/workdocs/api_op_DescribeRootFolders.go @@ -64,14 +64,14 @@ func (c *Client) DescribeRootFolders(ctx context.Context, params *DescribeRootFo type DescribeRootFoldersInput struct { - // The maximum number of items to return. - Limit *int32 - // Amazon WorkDocs authentication token. // // This member is required. AuthenticationToken *string + // The maximum number of items to return. + Limit *int32 + // The marker for the next set of results. (You received this marker from a // previous call.) Marker *string @@ -79,12 +79,12 @@ type DescribeRootFoldersInput struct { type DescribeRootFoldersOutput struct { - // The marker for the next set of results. - Marker *string - // The user's special folders. Folders []*types.FolderMetadata + // The marker for the next set of results. + Marker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/workdocs/api_op_DescribeUsers.go b/service/workdocs/api_op_DescribeUsers.go index 9910d4c7600..0a1a18ac6cf 100644 --- a/service/workdocs/api_op_DescribeUsers.go +++ b/service/workdocs/api_op_DescribeUsers.go @@ -59,16 +59,16 @@ func (c *Client) DescribeUsers(ctx context.Context, params *DescribeUsersInput, type DescribeUsersInput struct { - // A comma-separated list of values. Specify "STORAGE_METADATA" to include the user - // storage quota and utilization information. - Fields *string - // Amazon WorkDocs authentication token. Not required when using AWS administrator // credentials to access the API. AuthenticationToken *string - // The order for the results. - Order types.OrderType + // A comma-separated list of values. Specify "STORAGE_METADATA" to include the user + // storage quota and utilization information. + Fields *string + + // The state of the users. Specify "ALL" to include inactive users. + Include types.UserFilterType // The maximum number of items to return. Limit *int32 @@ -77,31 +77,31 @@ type DescribeUsersInput struct { // previous call.) Marker *string - // The state of the users. Specify "ALL" to include inactive users. - Include types.UserFilterType + // The order for the results. + Order types.OrderType + + // The ID of the organization. + OrganizationId *string + + // A query to filter users by user name. + Query *string // The sorting criteria. Sort types.UserSortType // The IDs of the users. UserIds *string - - // A query to filter users by user name. - Query *string - - // The ID of the organization. - OrganizationId *string } type DescribeUsersOutput struct { - // The total number of users included in the results. - TotalNumberOfUsers *int64 - // The marker to use when requesting the next set of results. If there are no // additional results, the string is empty. Marker *string + // The total number of users included in the results. + TotalNumberOfUsers *int64 + // The users. Users []*types.User diff --git a/service/workdocs/api_op_GetDocument.go b/service/workdocs/api_op_GetDocument.go index 507f6c8d8e8..d45da5d0dbf 100644 --- a/service/workdocs/api_op_GetDocument.go +++ b/service/workdocs/api_op_GetDocument.go @@ -57,15 +57,15 @@ func (c *Client) GetDocument(ctx context.Context, params *GetDocumentInput, optF type GetDocumentInput struct { - // Amazon WorkDocs authentication token. Not required when using AWS administrator - // credentials to access the API. - AuthenticationToken *string - // The ID of the document. // // This member is required. DocumentId *string + // Amazon WorkDocs authentication token. Not required when using AWS administrator + // credentials to access the API. + AuthenticationToken *string + // Set this to TRUE to include custom metadata in the response. IncludeCustomMetadata *bool } diff --git a/service/workdocs/api_op_GetDocumentPath.go b/service/workdocs/api_op_GetDocumentPath.go index d264bbe1c7e..3490199cfcd 100644 --- a/service/workdocs/api_op_GetDocumentPath.go +++ b/service/workdocs/api_op_GetDocumentPath.go @@ -66,19 +66,19 @@ type GetDocumentPathInput struct { // This member is required. DocumentId *string - // The maximum number of levels in the hierarchy to return. - Limit *int32 - - // This value is not supported. - Marker *string + // Amazon WorkDocs authentication token. Not required when using AWS administrator + // credentials to access the API. + AuthenticationToken *string // A comma-separated list of values. Specify NAME to include the names of the // parent folders. Fields *string - // Amazon WorkDocs authentication token. Not required when using AWS administrator - // credentials to access the API. - AuthenticationToken *string + // The maximum number of levels in the hierarchy to return. + Limit *int32 + + // This value is not supported. + Marker *string } type GetDocumentPathOutput struct { diff --git a/service/workdocs/api_op_GetDocumentVersion.go b/service/workdocs/api_op_GetDocumentVersion.go index dc9bed413ef..d8493d6d4ef 100644 --- a/service/workdocs/api_op_GetDocumentVersion.go +++ b/service/workdocs/api_op_GetDocumentVersion.go @@ -57,8 +57,10 @@ func (c *Client) GetDocumentVersion(ctx context.Context, params *GetDocumentVers type GetDocumentVersionInput struct { - // Set this to TRUE to include custom metadata in the response. - IncludeCustomMetadata *bool + // The ID of the document. + // + // This member is required. + DocumentId *string // The version ID of the document. // @@ -69,24 +71,22 @@ type GetDocumentVersionInput struct { // credentials to access the API. AuthenticationToken *string - // The ID of the document. - // - // This member is required. - DocumentId *string - // A comma-separated list of values. Specify "SOURCE" to include a URL for the // source document. Fields *string + + // Set this to TRUE to include custom metadata in the response. + IncludeCustomMetadata *bool } type GetDocumentVersionOutput struct { - // The version metadata. - Metadata *types.DocumentVersionMetadata - // The custom metadata on the document version. CustomMetadata map[string]*string + // The version metadata. + Metadata *types.DocumentVersionMetadata + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/workdocs/api_op_GetFolder.go b/service/workdocs/api_op_GetFolder.go index 6a28ea099fe..137bae3bbd5 100644 --- a/service/workdocs/api_op_GetFolder.go +++ b/service/workdocs/api_op_GetFolder.go @@ -62,12 +62,12 @@ type GetFolderInput struct { // This member is required. FolderId *string - // Set to TRUE to include custom metadata in the response. - IncludeCustomMetadata *bool - // Amazon WorkDocs authentication token. Not required when using AWS administrator // credentials to access the API. AuthenticationToken *string + + // Set to TRUE to include custom metadata in the response. + IncludeCustomMetadata *bool } type GetFolderOutput struct { diff --git a/service/workdocs/api_op_GetFolderPath.go b/service/workdocs/api_op_GetFolderPath.go index d1854b82517..c68aee66cac 100644 --- a/service/workdocs/api_op_GetFolderPath.go +++ b/service/workdocs/api_op_GetFolderPath.go @@ -61,6 +61,11 @@ func (c *Client) GetFolderPath(ctx context.Context, params *GetFolderPathInput, type GetFolderPathInput struct { + // The ID of the folder. + // + // This member is required. + FolderId *string + // Amazon WorkDocs authentication token. Not required when using AWS administrator // credentials to access the API. AuthenticationToken *string @@ -69,16 +74,11 @@ type GetFolderPathInput struct { // parent folders. Fields *string - // This value is not supported. - Marker *string - - // The ID of the folder. - // - // This member is required. - FolderId *string - // The maximum number of levels in the hierarchy to return. Limit *int32 + + // This value is not supported. + Marker *string } type GetFolderPathOutput struct { diff --git a/service/workdocs/api_op_GetResources.go b/service/workdocs/api_op_GetResources.go index b02f463f7ed..8560e34a2b1 100644 --- a/service/workdocs/api_op_GetResources.go +++ b/service/workdocs/api_op_GetResources.go @@ -57,9 +57,16 @@ func (c *Client) GetResources(ctx context.Context, params *GetResourcesInput, op type GetResourcesInput struct { + // The Amazon WorkDocs authentication token. Not required when using AWS + // administrator credentials to access the API. + AuthenticationToken *string + // The collection type. CollectionType types.ResourceCollectionType + // The maximum number of resources to return. + Limit *int32 + // The marker for the next set of results. This marker was received from a previous // call. Marker *string @@ -67,27 +74,20 @@ type GetResourcesInput struct { // The user ID for the resource collection. This is a required field for accessing // the API operation using IAM credentials. UserId *string - - // The Amazon WorkDocs authentication token. Not required when using AWS - // administrator credentials to access the API. - AuthenticationToken *string - - // The maximum number of resources to return. - Limit *int32 } type GetResourcesOutput struct { - // The marker to use when requesting the next set of results. If there are no - // additional results, the string is empty. - Marker *string - // The documents in the specified collection. Documents []*types.DocumentMetadata // The folders in the specified folder. Folders []*types.FolderMetadata + // The marker to use when requesting the next set of results. If there are no + // additional results, the string is empty. + Marker *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/workdocs/api_op_InitiateDocumentVersionUpload.go b/service/workdocs/api_op_InitiateDocumentVersionUpload.go index a452601391c..01e0690f2f5 100644 --- a/service/workdocs/api_op_InitiateDocumentVersionUpload.go +++ b/service/workdocs/api_op_InitiateDocumentVersionUpload.go @@ -63,12 +63,6 @@ func (c *Client) InitiateDocumentVersionUpload(ctx context.Context, params *Init type InitiateDocumentVersionUploadInput struct { - // The content type of the document. - ContentType *string - - // The ID of the document. - Id *string - // The ID of the parent folder. // // This member is required. @@ -78,27 +72,33 @@ type InitiateDocumentVersionUploadInput struct { // credentials to access the API. AuthenticationToken *string + // The timestamp when the content of the document was originally created. + ContentCreatedTimestamp *time.Time + // The timestamp when the content of the document was modified. ContentModifiedTimestamp *time.Time - // The name of the document. - Name *string + // The content type of the document. + ContentType *string // The size of the document, in bytes. DocumentSizeInBytes *int64 - // The timestamp when the content of the document was originally created. - ContentCreatedTimestamp *time.Time + // The ID of the document. + Id *string + + // The name of the document. + Name *string } type InitiateDocumentVersionUploadOutput struct { - // The upload metadata. - UploadMetadata *types.UploadMetadata - // The document metadata. Metadata *types.DocumentMetadata + // The upload metadata. + UploadMetadata *types.UploadMetadata + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/workdocs/api_op_RemoveAllResourcePermissions.go b/service/workdocs/api_op_RemoveAllResourcePermissions.go index d2162660de5..444888c4318 100644 --- a/service/workdocs/api_op_RemoveAllResourcePermissions.go +++ b/service/workdocs/api_op_RemoveAllResourcePermissions.go @@ -56,14 +56,14 @@ func (c *Client) RemoveAllResourcePermissions(ctx context.Context, params *Remov type RemoveAllResourcePermissionsInput struct { - // Amazon WorkDocs authentication token. Not required when using AWS administrator - // credentials to access the API. - AuthenticationToken *string - // The ID of the resource. // // This member is required. ResourceId *string + + // Amazon WorkDocs authentication token. Not required when using AWS administrator + // credentials to access the API. + AuthenticationToken *string } type RemoveAllResourcePermissionsOutput struct { diff --git a/service/workdocs/api_op_RemoveResourcePermission.go b/service/workdocs/api_op_RemoveResourcePermission.go index 2b7f4fa3d1a..a14c12f15de 100644 --- a/service/workdocs/api_op_RemoveResourcePermission.go +++ b/service/workdocs/api_op_RemoveResourcePermission.go @@ -57,13 +57,6 @@ func (c *Client) RemoveResourcePermission(ctx context.Context, params *RemoveRes type RemoveResourcePermissionInput struct { - // The principal type of the resource. - PrincipalType types.PrincipalType - - // Amazon WorkDocs authentication token. Not required when using AWS administrator - // credentials to access the API. - AuthenticationToken *string - // The principal ID of the resource. // // This member is required. @@ -73,6 +66,13 @@ type RemoveResourcePermissionInput struct { // // This member is required. ResourceId *string + + // Amazon WorkDocs authentication token. Not required when using AWS administrator + // credentials to access the API. + AuthenticationToken *string + + // The principal type of the resource. + PrincipalType types.PrincipalType } type RemoveResourcePermissionOutput struct { diff --git a/service/workdocs/api_op_UpdateDocument.go b/service/workdocs/api_op_UpdateDocument.go index e8e0f81e808..40ce347d7cd 100644 --- a/service/workdocs/api_op_UpdateDocument.go +++ b/service/workdocs/api_op_UpdateDocument.go @@ -63,18 +63,18 @@ type UpdateDocumentInput struct { // This member is required. DocumentId *string - // The resource state of the document. Only ACTIVE and RECYCLED are supported. - ResourceState types.ResourceStateType - - // The ID of the parent folder. - ParentFolderId *string + // Amazon WorkDocs authentication token. Not required when using AWS administrator + // credentials to access the API. + AuthenticationToken *string // The name of the document. Name *string - // Amazon WorkDocs authentication token. Not required when using AWS administrator - // credentials to access the API. - AuthenticationToken *string + // The ID of the parent folder. + ParentFolderId *string + + // The resource state of the document. Only ACTIVE and RECYCLED are supported. + ResourceState types.ResourceStateType } type UpdateDocumentOutput struct { diff --git a/service/workdocs/api_op_UpdateDocumentVersion.go b/service/workdocs/api_op_UpdateDocumentVersion.go index 6f14bddd5d1..5cd8a6d1b50 100644 --- a/service/workdocs/api_op_UpdateDocumentVersion.go +++ b/service/workdocs/api_op_UpdateDocumentVersion.go @@ -60,10 +60,6 @@ func (c *Client) UpdateDocumentVersion(ctx context.Context, params *UpdateDocume type UpdateDocumentVersionInput struct { - // Amazon WorkDocs authentication token. Not required when using AWS administrator - // credentials to access the API. - AuthenticationToken *string - // The ID of the document. // // This member is required. @@ -74,6 +70,10 @@ type UpdateDocumentVersionInput struct { // This member is required. VersionId *string + // Amazon WorkDocs authentication token. Not required when using AWS administrator + // credentials to access the API. + AuthenticationToken *string + // The status of the version. VersionStatus types.DocumentVersionStatus } diff --git a/service/workdocs/api_op_UpdateFolder.go b/service/workdocs/api_op_UpdateFolder.go index ebaf08ec651..492081ba32a 100644 --- a/service/workdocs/api_op_UpdateFolder.go +++ b/service/workdocs/api_op_UpdateFolder.go @@ -58,24 +58,24 @@ func (c *Client) UpdateFolder(ctx context.Context, params *UpdateFolderInput, op type UpdateFolderInput struct { + // The ID of the folder. + // + // This member is required. + FolderId *string + // Amazon WorkDocs authentication token. Not required when using AWS administrator // credentials to access the API. AuthenticationToken *string - // The resource state of the folder. Only ACTIVE and RECYCLED are accepted values - // from the API. - ResourceState types.ResourceStateType - // The name of the folder. Name *string // The ID of the parent folder. ParentFolderId *string - // The ID of the folder. - // - // This member is required. - FolderId *string + // The resource state of the folder. Only ACTIVE and RECYCLED are accepted values + // from the API. + ResourceState types.ResourceStateType } type UpdateFolderOutput struct { diff --git a/service/workdocs/api_op_UpdateUser.go b/service/workdocs/api_op_UpdateUser.go index 93127874181..92c75882ff2 100644 --- a/service/workdocs/api_op_UpdateUser.go +++ b/service/workdocs/api_op_UpdateUser.go @@ -58,32 +58,32 @@ func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns type UpdateUserInput struct { - // The time zone ID of the user. - TimeZoneId *string - - // The given name of the user. - GivenName *string - // The ID of the user. // // This member is required. UserId *string + // Amazon WorkDocs authentication token. Not required when using AWS administrator + // credentials to access the API. + AuthenticationToken *string + + // The given name of the user. + GivenName *string + + // Boolean value to determine whether the user is granted Poweruser privileges. + GrantPoweruserPrivileges types.BooleanEnumType + // The locale of the user. Locale types.LocaleType // The amount of storage for the user. StorageRule *types.StorageRuleType - // Boolean value to determine whether the user is granted Poweruser privileges. - GrantPoweruserPrivileges types.BooleanEnumType - // The surname of the user. Surname *string - // Amazon WorkDocs authentication token. Not required when using AWS administrator - // credentials to access the API. - AuthenticationToken *string + // The time zone ID of the user. + TimeZoneId *string // The type of the user. Type types.UserType diff --git a/service/workdocs/go.mod b/service/workdocs/go.mod index 6e365831930..f428bda5da7 100644 --- a/service/workdocs/go.mod +++ b/service/workdocs/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/workdocs go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/workdocs/types/types.go b/service/workdocs/types/types.go index 4645cb8c096..47ebfd87d99 100644 --- a/service/workdocs/types/types.go +++ b/service/workdocs/types/types.go @@ -9,39 +9,39 @@ import ( // Describes the activity information. type Activity struct { + // Metadata of the commenting activity. This is an optional field and is filled for + // commenting activities. + CommentMetadata *CommentMetadata + + // The user who performed the action. + Initiator *UserMetadata + // Indicates whether an activity is indirect or direct. An indirect activity // results from a direct activity performed on a parent resource. For example, // sharing a parent folder (the direct activity) shares all of the subfolders and // documents within the parent folder (the indirect activity). IsIndirectActivity *bool - // The list of users or groups impacted by this action. This is an optional field - // and is filled for the following sharing activities: DOCUMENT_SHARED, - // DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED. - Participants *Participants - // The ID of the organization. OrganizationId *string - // The user who performed the action. - Initiator *UserMetadata - - // Metadata of the commenting activity. This is an optional field and is filled for - // commenting activities. - CommentMetadata *CommentMetadata - - // The activity type. - Type ActivityType - // The original parent of the resource. This is an optional field and is filled for // move activities. OriginalParent *ResourceMetadata - // The timestamp when the action was performed. - TimeStamp *time.Time + // The list of users or groups impacted by this action. This is an optional field + // and is filled for the following sharing activities: DOCUMENT_SHARED, + // DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED. + Participants *Participants // The metadata of the resource involved in the user action. ResourceMetadata *ResourceMetadata + + // The timestamp when the action was performed. + TimeStamp *time.Time + + // The activity type. + Type ActivityType } // Describes a comment. @@ -52,6 +52,12 @@ type Comment struct { // This member is required. CommentId *string + // The details of the user who made the comment. + Contributor *User + + // The time that the comment was created. + CreatedTimestamp *time.Time + // The ID of the parent comment. ParentId *string @@ -59,33 +65,24 @@ type Comment struct { // user ID of the user being replied to. RecipientId *string - // The time that the comment was created. - CreatedTimestamp *time.Time - - // The details of the user who made the comment. - Contributor *User - - // The visibility of the comment. Options are either PRIVATE, where the comment is - // visible only to the comment author and document owner and co-owners, or PUBLIC, - // where the comment is visible to document owners, co-owners, and contributors. - Visibility CommentVisibilityType - // The status of the comment. Status CommentStatusType + // The text of the comment. + Text *string + // The ID of the root comment in the thread. ThreadId *string - // The text of the comment. - Text *string + // The visibility of the comment. Options are either PRIVATE, where the comment is + // visible only to the comment author and document owner and co-owners, or PUBLIC, + // where the comment is visible to document owners, co-owners, and contributors. + Visibility CommentVisibilityType } // Describes the metadata of a comment. type CommentMetadata struct { - // The timestamp that the comment was created. - CreatedTimestamp *time.Time - // The ID of the comment. CommentId *string @@ -95,6 +92,9 @@ type CommentMetadata struct { // The user who made the comment. Contributor *User + // The timestamp that the comment was created. + CreatedTimestamp *time.Time + // The ID of the user being replied to. RecipientId *string } @@ -102,119 +102,119 @@ type CommentMetadata struct { // Describes the document. type DocumentMetadata struct { - // The ID of the document. - Id *string - // The time when the document was created. CreatedTimestamp *time.Time - // The time when the document was updated. - ModifiedTimestamp *time.Time - // The ID of the creator. CreatorId *string - // The resource state. - ResourceState ResourceStateType - - // The ID of the parent folder. - ParentFolderId *string + // The ID of the document. + Id *string // List of labels on the document. Labels []*string // The latest version of the document. LatestVersionMetadata *DocumentVersionMetadata + + // The time when the document was updated. + ModifiedTimestamp *time.Time + + // The ID of the parent folder. + ParentFolderId *string + + // The resource state. + ResourceState ResourceStateType } // Describes a version of a document. type DocumentVersionMetadata struct { - // The source of the document. - Source map[string]*string - // The timestamp when the content of the document was originally created. ContentCreatedTimestamp *time.Time - // The ID of the version. - Id *string + // The timestamp when the content of the document was modified. + ContentModifiedTimestamp *time.Time + + // The content type of the document. + ContentType *string // The timestamp when the document was first uploaded. CreatedTimestamp *time.Time - // The size of the document, in bytes. - Size *int64 + // The ID of the creator. + CreatorId *string - // The signature of the document. - Signature *string + // The ID of the version. + Id *string + + // The timestamp when the document was last uploaded. + ModifiedTimestamp *time.Time // The name of the version. Name *string - // The thumbnail of the document. - Thumbnail map[string]*string + // The signature of the document. + Signature *string - // The timestamp when the content of the document was modified. - ContentModifiedTimestamp *time.Time + // The size of the document, in bytes. + Size *int64 + + // The source of the document. + Source map[string]*string // The status of the document. Status DocumentStatusType - // The timestamp when the document was last uploaded. - ModifiedTimestamp *time.Time - - // The ID of the creator. - CreatorId *string - - // The content type of the document. - ContentType *string + // The thumbnail of the document. + Thumbnail map[string]*string } // Describes a folder. type FolderMetadata struct { - // The time when the folder was updated. - ModifiedTimestamp *time.Time - - // List of labels on the folder. - Labels []*string - - // The unique identifier created from the subfolders and documents of the folder. - Signature *string + // The time when the folder was created. + CreatedTimestamp *time.Time // The ID of the creator. CreatorId *string - // The ID of the parent folder. - ParentFolderId *string - - // The name of the folder. - Name *string - // The ID of the folder. Id *string + // List of labels on the folder. + Labels []*string + // The size of the latest version of the folder metadata. LatestVersionSize *int64 - // The size of the folder metadata. - Size *int64 + // The time when the folder was updated. + ModifiedTimestamp *time.Time + + // The name of the folder. + Name *string + + // The ID of the parent folder. + ParentFolderId *string // The resource state of the folder. ResourceState ResourceStateType - // The time when the folder was created. - CreatedTimestamp *time.Time + // The unique identifier created from the subfolders and documents of the folder. + Signature *string + + // The size of the folder metadata. + Size *int64 } // Describes the metadata of a user group. type GroupMetadata struct { - // The name of the group. - Name *string - // The ID of the user group. Id *string + + // The name of the group. + Name *string } // Set of options which defines notification preferences of given action. @@ -231,11 +231,11 @@ type NotificationOptions struct { // Describes the users or user groups. type Participants struct { - // The list of users. - Users []*UserMetadata - // The list of user groups. Groups []*GroupMetadata + + // The list of users. + Users []*UserMetadata } // Describes the permissions. @@ -251,12 +251,12 @@ type PermissionInfo struct { // Describes a resource. type Principal struct { - // The permission information for the resource. - Roles []*PermissionInfo - // The ID of the resource. Id *string + // The permission information for the resource. + Roles []*PermissionInfo + // The type of resource. Type PrincipalType } @@ -264,27 +264,27 @@ type Principal struct { // Describes the metadata of a resource. type ResourceMetadata struct { - // The version ID of the resource. This is an optional field and is filled for - // action on document version. - VersionId *string - - // The type of resource. - Type ResourceType + // The ID of the resource. + Id *string - // The owner of the resource. - Owner *UserMetadata + // The name of the resource. + Name *string // The original name of the resource before a rename operation. OriginalName *string - // The name of the resource. - Name *string - - // The ID of the resource. - Id *string + // The owner of the resource. + Owner *UserMetadata // The parent ID of the resource before a rename operation. ParentId *string + + // The type of resource. + Type ResourceType + + // The version ID of the resource. This is an optional field and is filled for + // action on document version. + VersionId *string } // Describes the path information of a resource. @@ -329,20 +329,20 @@ type ShareResult struct { // The ID of the invited user. InviteePrincipalId *string - // The status message. - StatusMessage *string + // The ID of the principal. + PrincipalId *string // The role. Role RoleType - // The status. - Status ShareStatusType - // The ID of the resource that was shared. ShareId *string - // The ID of the principal. - PrincipalId *string + // The status. + Status ShareStatusType + + // The status message. + StatusMessage *string } // Describes the storage for a user. @@ -358,14 +358,14 @@ type StorageRuleType struct { // Describes a subscription. type Subscription struct { - // The ID of the subscription. - SubscriptionId *string + // The endpoint of the subscription. + EndPoint *string // The protocol of the subscription. Protocol SubscriptionProtocolType - // The endpoint of the subscription. - EndPoint *string + // The ID of the subscription. + SubscriptionId *string } // Describes the upload. @@ -381,77 +381,77 @@ type UploadMetadata struct { // Describes a user. type User struct { - // The status of the user. - Status UserStatusType + // The time when the user was created. + CreatedTimestamp *time.Time + + // The email address of the user. + EmailAddress *string // The given name of the user. GivenName *string - // The ID of the organization. - OrganizationId *string + // The ID of the user. + Id *string - // The email address of the user. - EmailAddress *string + // The locale of the user. + Locale LocaleType - // The ID of the root folder. - RootFolderId *string + // The time when the user was modified. + ModifiedTimestamp *time.Time + + // The ID of the organization. + OrganizationId *string // The ID of the recycle bin folder. RecycleBinFolderId *string - // The time when the user was created. - CreatedTimestamp *time.Time - - // The locale of the user. - Locale LocaleType + // The ID of the root folder. + RootFolderId *string - // The ID of the user. - Id *string + // The status of the user. + Status UserStatusType // The storage for the user. Storage *UserStorageMetadata - // The type of user. - Type UserType - // The surname of the user. Surname *string - // The login name of the user. - Username *string - // The time zone ID of the user. TimeZoneId *string - // The time when the user was modified. - ModifiedTimestamp *time.Time + // The type of user. + Type UserType + + // The login name of the user. + Username *string } // Describes the metadata of the user. type UserMetadata struct { - // The surname of the user. - Surname *string - // The email address of the user. EmailAddress *string - // The name of the user. - Username *string + // The given name of the user before a rename operation. + GivenName *string // The ID of the user. Id *string - // The given name of the user before a rename operation. - GivenName *string + // The surname of the user. + Surname *string + + // The name of the user. + Username *string } // Describes the storage for a user. type UserStorageMetadata struct { - // The amount of storage used, in bytes. - StorageUtilizedInBytes *int64 - // The storage for a user. StorageRule *StorageRuleType + + // The amount of storage used, in bytes. + StorageUtilizedInBytes *int64 } diff --git a/service/worklink/api_op_AssociateDomain.go b/service/worklink/api_op_AssociateDomain.go index 7a9e66d479f..a098765ee59 100644 --- a/service/worklink/api_op_AssociateDomain.go +++ b/service/worklink/api_op_AssociateDomain.go @@ -56,17 +56,17 @@ func (c *Client) AssociateDomain(ctx context.Context, params *AssociateDomainInp type AssociateDomainInput struct { - // The fully qualified domain name (FQDN). - // - // This member is required. - DomainName *string - // The ARN of an issued ACM certificate that is valid for the domain being // associated. // // This member is required. AcmCertificateArn *string + // The fully qualified domain name (FQDN). + // + // This member is required. + DomainName *string + // The Amazon Resource Name (ARN) of the fleet. // // This member is required. diff --git a/service/worklink/api_op_AssociateWebsiteAuthorizationProvider.go b/service/worklink/api_op_AssociateWebsiteAuthorizationProvider.go index 95f06cfa883..0e83c06d9c2 100644 --- a/service/worklink/api_op_AssociateWebsiteAuthorizationProvider.go +++ b/service/worklink/api_op_AssociateWebsiteAuthorizationProvider.go @@ -58,6 +58,11 @@ func (c *Client) AssociateWebsiteAuthorizationProvider(ctx context.Context, para type AssociateWebsiteAuthorizationProviderInput struct { + // The authorization provider type. + // + // This member is required. + AuthorizationProviderType types.AuthorizationProviderType + // The ARN of the fleet. // // This member is required. @@ -66,11 +71,6 @@ type AssociateWebsiteAuthorizationProviderInput struct { // The domain name of the authorization provider. This applies only to SAML-based // authorization providers. DomainName *string - - // The authorization provider type. - // - // This member is required. - AuthorizationProviderType types.AuthorizationProviderType } type AssociateWebsiteAuthorizationProviderOutput struct { diff --git a/service/worklink/api_op_CreateFleet.go b/service/worklink/api_op_CreateFleet.go index 13496645746..187f5a7a742 100644 --- a/service/worklink/api_op_CreateFleet.go +++ b/service/worklink/api_op_CreateFleet.go @@ -63,15 +63,15 @@ type CreateFleetInput struct { // This member is required. FleetName *string - // The tags to add to the resource. A tag is a key-value pair. - Tags map[string]*string - // The fleet name to display. DisplayName *string // The option to optimize for better performance by routing traffic through the // closest AWS Region to users, which may be outside of your home Region. OptimizeForEndUserLocation *bool + + // The tags to add to the resource. A tag is a key-value pair. + Tags map[string]*string } type CreateFleetOutput struct { diff --git a/service/worklink/api_op_DescribeCompanyNetworkConfiguration.go b/service/worklink/api_op_DescribeCompanyNetworkConfiguration.go index 9a68d40e4fc..476068caae4 100644 --- a/service/worklink/api_op_DescribeCompanyNetworkConfiguration.go +++ b/service/worklink/api_op_DescribeCompanyNetworkConfiguration.go @@ -65,6 +65,9 @@ type DescribeCompanyNetworkConfigurationInput struct { type DescribeCompanyNetworkConfigurationOutput struct { + // The security groups associated with access to the provided subnets. + SecurityGroupIds []*string + // The subnets used for X-ENI connections from Amazon WorkLink rendering // containers. SubnetIds []*string @@ -72,9 +75,6 @@ type DescribeCompanyNetworkConfigurationOutput struct { // The VPC with connectivity to associated websites. VpcId *string - // The security groups associated with access to the provided subnets. - SecurityGroupIds []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/worklink/api_op_DescribeDevice.go b/service/worklink/api_op_DescribeDevice.go index 5a037a039c8..085dc7dddc0 100644 --- a/service/worklink/api_op_DescribeDevice.go +++ b/service/worklink/api_op_DescribeDevice.go @@ -58,46 +58,46 @@ func (c *Client) DescribeDevice(ctx context.Context, params *DescribeDeviceInput type DescribeDeviceInput struct { - // The ARN of the fleet. + // A unique identifier for a registered user's device. // // This member is required. - FleetArn *string + DeviceId *string - // A unique identifier for a registered user's device. + // The ARN of the fleet. // // This member is required. - DeviceId *string + FleetArn *string } type DescribeDeviceOutput struct { - // The operating system patch level of the device. - PatchLevel *string - - // The user name associated with the device. - Username *string - - // The operating system of the device. - OperatingSystem *string - - // The current state of the device. - Status types.DeviceStatus - // The date that the device first signed in to Amazon WorkLink. FirstAccessedTime *time.Time // The date that the device last accessed Amazon WorkLink. LastAccessedTime *time.Time + // The manufacturer of the device. + Manufacturer *string + // The model of the device. Model *string - // The manufacturer of the device. - Manufacturer *string + // The operating system of the device. + OperatingSystem *string // The operating system version of the device. OperatingSystemVersion *string + // The operating system patch level of the device. + PatchLevel *string + + // The current state of the device. + Status types.DeviceStatus + + // The user name associated with the device. + Username *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/worklink/api_op_DescribeDomain.go b/service/worklink/api_op_DescribeDomain.go index 1b6e722ab9c..0021a88cab6 100644 --- a/service/worklink/api_op_DescribeDomain.go +++ b/service/worklink/api_op_DescribeDomain.go @@ -58,19 +58,26 @@ func (c *Client) DescribeDomain(ctx context.Context, params *DescribeDomainInput type DescribeDomainInput struct { - // The ARN of the fleet. + // The name of the domain. // // This member is required. - FleetArn *string + DomainName *string - // The name of the domain. + // The ARN of the fleet. // // This member is required. - DomainName *string + FleetArn *string } type DescribeDomainOutput struct { + // The ARN of an issued ACM certificate that is valid for the domain being + // associated. + AcmCertificateArn *string + + // The time that the domain was added. + CreatedTime *time.Time + // The name to display. DisplayName *string @@ -80,13 +87,6 @@ type DescribeDomainOutput struct { // The current state for the domain. DomainStatus types.DomainStatus - // The time that the domain was added. - CreatedTime *time.Time - - // The ARN of an issued ACM certificate that is valid for the domain being - // associated. - AcmCertificateArn *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/worklink/api_op_DescribeFleetMetadata.go b/service/worklink/api_op_DescribeFleetMetadata.go index 813e152a1b1..20162be3c13 100644 --- a/service/worklink/api_op_DescribeFleetMetadata.go +++ b/service/worklink/api_op_DescribeFleetMetadata.go @@ -67,9 +67,15 @@ type DescribeFleetMetadataInput struct { type DescribeFleetMetadataOutput struct { + // The identifier used by users to sign in to the Amazon WorkLink app. + CompanyCode *string + // The time that the fleet was created. CreatedTime *time.Time + // The name to display. + DisplayName *string + // The name of the fleet. FleetName *string @@ -83,15 +89,9 @@ type DescribeFleetMetadataOutput struct { // closest AWS Region to users, which may be outside of your home Region. OptimizeForEndUserLocation *bool - // The name to display. - DisplayName *string - // The tags attached to the resource. A tag is a key-value pair. Tags map[string]*string - // The identifier used by users to sign in to the Amazon WorkLink app. - CompanyCode *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/worklink/api_op_DescribeIdentityProviderConfiguration.go b/service/worklink/api_op_DescribeIdentityProviderConfiguration.go index d91ec8ab151..3444e411d21 100644 --- a/service/worklink/api_op_DescribeIdentityProviderConfiguration.go +++ b/service/worklink/api_op_DescribeIdentityProviderConfiguration.go @@ -65,14 +65,14 @@ type DescribeIdentityProviderConfigurationInput struct { type DescribeIdentityProviderConfigurationOutput struct { - // The SAML metadata document uploaded to the user’s identity provider. - ServiceProviderSamlMetadata *string + // The SAML metadata document provided by the user’s identity provider. + IdentityProviderSamlMetadata *string // The type of identity provider. IdentityProviderType types.IdentityProviderType - // The SAML metadata document provided by the user’s identity provider. - IdentityProviderSamlMetadata *string + // The SAML metadata document uploaded to the user’s identity provider. + ServiceProviderSamlMetadata *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/worklink/api_op_DescribeWebsiteCertificateAuthority.go b/service/worklink/api_op_DescribeWebsiteCertificateAuthority.go index 1ea0435c6ba..148890c4db9 100644 --- a/service/worklink/api_op_DescribeWebsiteCertificateAuthority.go +++ b/service/worklink/api_op_DescribeWebsiteCertificateAuthority.go @@ -57,25 +57,25 @@ func (c *Client) DescribeWebsiteCertificateAuthority(ctx context.Context, params type DescribeWebsiteCertificateAuthorityInput struct { - // A unique identifier for the certificate authority. + // The ARN of the fleet. // // This member is required. - WebsiteCaId *string + FleetArn *string - // The ARN of the fleet. + // A unique identifier for the certificate authority. // // This member is required. - FleetArn *string + WebsiteCaId *string } type DescribeWebsiteCertificateAuthorityOutput struct { - // The time that the certificate authority was added. - CreatedTime *time.Time - // The root certificate of the certificate authority. Certificate *string + // The time that the certificate authority was added. + CreatedTime *time.Time + // The certificate name to display. DisplayName *string diff --git a/service/worklink/api_op_DisassociateDomain.go b/service/worklink/api_op_DisassociateDomain.go index 9e58bf2609a..2f8f9eda6bb 100644 --- a/service/worklink/api_op_DisassociateDomain.go +++ b/service/worklink/api_op_DisassociateDomain.go @@ -57,15 +57,15 @@ func (c *Client) DisassociateDomain(ctx context.Context, params *DisassociateDom type DisassociateDomainInput struct { - // The ARN of the fleet. + // The name of the domain. // // This member is required. - FleetArn *string + DomainName *string - // The name of the domain. + // The ARN of the fleet. // // This member is required. - DomainName *string + FleetArn *string } type DisassociateDomainOutput struct { diff --git a/service/worklink/api_op_DisassociateWebsiteAuthorizationProvider.go b/service/worklink/api_op_DisassociateWebsiteAuthorizationProvider.go index 1c0d362b578..1d66d4c175b 100644 --- a/service/worklink/api_op_DisassociateWebsiteAuthorizationProvider.go +++ b/service/worklink/api_op_DisassociateWebsiteAuthorizationProvider.go @@ -58,15 +58,15 @@ func (c *Client) DisassociateWebsiteAuthorizationProvider(ctx context.Context, p type DisassociateWebsiteAuthorizationProviderInput struct { - // The ARN of the fleet. + // A unique identifier for the authorization provider. // // This member is required. - FleetArn *string + AuthorizationProviderId *string - // A unique identifier for the authorization provider. + // The ARN of the fleet. // // This member is required. - AuthorizationProviderId *string + FleetArn *string } type DisassociateWebsiteAuthorizationProviderOutput struct { diff --git a/service/worklink/api_op_DisassociateWebsiteCertificateAuthority.go b/service/worklink/api_op_DisassociateWebsiteCertificateAuthority.go index 4b5a5b904d6..4c330628f9d 100644 --- a/service/worklink/api_op_DisassociateWebsiteCertificateAuthority.go +++ b/service/worklink/api_op_DisassociateWebsiteCertificateAuthority.go @@ -56,15 +56,15 @@ func (c *Client) DisassociateWebsiteCertificateAuthority(ctx context.Context, pa type DisassociateWebsiteCertificateAuthorityInput struct { - // A unique identifier for the CA. + // The ARN of the fleet. // // This member is required. - WebsiteCaId *string + FleetArn *string - // The ARN of the fleet. + // A unique identifier for the CA. // // This member is required. - FleetArn *string + WebsiteCaId *string } type DisassociateWebsiteCertificateAuthorityOutput struct { diff --git a/service/worklink/api_op_ListDevices.go b/service/worklink/api_op_ListDevices.go index 568dd8cc2e6..fb0ae243cb5 100644 --- a/service/worklink/api_op_ListDevices.go +++ b/service/worklink/api_op_ListDevices.go @@ -57,28 +57,28 @@ func (c *Client) ListDevices(ctx context.Context, params *ListDevicesInput, optF type ListDevicesInput struct { + // The ARN of the fleet. + // + // This member is required. + FleetArn *string + // The maximum number of results to be included in the next page. MaxResults *int32 // The pagination token used to retrieve the next page of results for this // operation. If this value is null, it retrieves the first page. NextToken *string - - // The ARN of the fleet. - // - // This member is required. - FleetArn *string } type ListDevicesOutput struct { + // Information about the devices. + Devices []*types.DeviceSummary + // The pagination token used to retrieve the next page of results for this // operation. If there are no more pages, this value is null. NextToken *string - // Information about the devices. - Devices []*types.DeviceSummary - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/worklink/api_op_ListDomains.go b/service/worklink/api_op_ListDomains.go index 82014eb31c0..2115e6f69f0 100644 --- a/service/worklink/api_op_ListDomains.go +++ b/service/worklink/api_op_ListDomains.go @@ -57,28 +57,28 @@ func (c *Client) ListDomains(ctx context.Context, params *ListDomainsInput, optF type ListDomainsInput struct { - // The pagination token used to retrieve the next page of results for this - // operation. If this value is null, it retrieves the first page. - NextToken *string - - // The maximum number of results to be included in the next page. - MaxResults *int32 - // The ARN of the fleet. // // This member is required. FleetArn *string -} -type ListDomainsOutput struct { + // The maximum number of results to be included in the next page. + MaxResults *int32 // The pagination token used to retrieve the next page of results for this - // operation. If there are no more pages, this value is null. + // operation. If this value is null, it retrieves the first page. NextToken *string +} + +type ListDomainsOutput struct { // Information about the domains. Domains []*types.DomainSummary + // The pagination token used to retrieve the next page of results for this + // operation. If there are no more pages, this value is null. + NextToken *string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/worklink/api_op_ListWebsiteAuthorizationProviders.go b/service/worklink/api_op_ListWebsiteAuthorizationProviders.go index 0bb5019e2b6..39415e6820d 100644 --- a/service/worklink/api_op_ListWebsiteAuthorizationProviders.go +++ b/service/worklink/api_op_ListWebsiteAuthorizationProviders.go @@ -73,13 +73,13 @@ type ListWebsiteAuthorizationProvidersInput struct { type ListWebsiteAuthorizationProvidersOutput struct { - // The website authorization providers. - WebsiteAuthorizationProviders []*types.WebsiteAuthorizationProviderSummary - // The pagination token to use to retrieve the next page of results for this // operation. If this value is null, it retrieves the first page. NextToken *string + // The website authorization providers. + WebsiteAuthorizationProviders []*types.WebsiteAuthorizationProviderSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/worklink/api_op_ListWebsiteCertificateAuthorities.go b/service/worklink/api_op_ListWebsiteCertificateAuthorities.go index ccc3cd01d57..60d637a6599 100644 --- a/service/worklink/api_op_ListWebsiteCertificateAuthorities.go +++ b/service/worklink/api_op_ListWebsiteCertificateAuthorities.go @@ -73,13 +73,13 @@ type ListWebsiteCertificateAuthoritiesInput struct { type ListWebsiteCertificateAuthoritiesOutput struct { - // Information about the certificates. - WebsiteCertificateAuthorities []*types.WebsiteCaSummary - // The pagination token used to retrieve the next page of results for this // operation. If there are no more pages, this value is null. NextToken *string + // Information about the certificates. + WebsiteCertificateAuthorities []*types.WebsiteCaSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/worklink/api_op_RevokeDomainAccess.go b/service/worklink/api_op_RevokeDomainAccess.go index d7cd0518a45..fa513f2bb58 100644 --- a/service/worklink/api_op_RevokeDomainAccess.go +++ b/service/worklink/api_op_RevokeDomainAccess.go @@ -56,15 +56,15 @@ func (c *Client) RevokeDomainAccess(ctx context.Context, params *RevokeDomainAcc type RevokeDomainAccessInput struct { - // The ARN of the fleet. + // The name of the domain. // // This member is required. - FleetArn *string + DomainName *string - // The name of the domain. + // The ARN of the fleet. // // This member is required. - DomainName *string + FleetArn *string } type RevokeDomainAccessOutput struct { diff --git a/service/worklink/api_op_UpdateCompanyNetworkConfiguration.go b/service/worklink/api_op_UpdateCompanyNetworkConfiguration.go index 417ad3940eb..80c7a15b85f 100644 --- a/service/worklink/api_op_UpdateCompanyNetworkConfiguration.go +++ b/service/worklink/api_op_UpdateCompanyNetworkConfiguration.go @@ -61,10 +61,10 @@ type UpdateCompanyNetworkConfigurationInput struct { // This member is required. FleetArn *string - // The VPC with connectivity to associated websites. + // The security groups associated with access to the provided subnets. // // This member is required. - VpcId *string + SecurityGroupIds []*string // The subnets used for X-ENI connections from Amazon WorkLink rendering // containers. @@ -72,10 +72,10 @@ type UpdateCompanyNetworkConfigurationInput struct { // This member is required. SubnetIds []*string - // The security groups associated with access to the provided subnets. + // The VPC with connectivity to associated websites. // // This member is required. - SecurityGroupIds []*string + VpcId *string } type UpdateCompanyNetworkConfigurationOutput struct { diff --git a/service/worklink/api_op_UpdateFleetMetadata.go b/service/worklink/api_op_UpdateFleetMetadata.go index 0efce90f342..8d3c686eade 100644 --- a/service/worklink/api_op_UpdateFleetMetadata.go +++ b/service/worklink/api_op_UpdateFleetMetadata.go @@ -56,14 +56,14 @@ func (c *Client) UpdateFleetMetadata(ctx context.Context, params *UpdateFleetMet type UpdateFleetMetadataInput struct { - // The fleet name to display. The existing DisplayName is unset if null is passed. - DisplayName *string - // The ARN of the fleet. // // This member is required. FleetArn *string + // The fleet name to display. The existing DisplayName is unset if null is passed. + DisplayName *string + // The option to optimize for better performance by routing traffic through the // closest AWS Region to users, which may be outside of your home Region. OptimizeForEndUserLocation *bool diff --git a/service/worklink/go.mod b/service/worklink/go.mod index 5f6101aaaf1..7df37bdaccd 100644 --- a/service/worklink/go.mod +++ b/service/worklink/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/worklink go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/worklink/types/types.go b/service/worklink/types/types.go index adec95cef35..fb24f8b6757 100644 --- a/service/worklink/types/types.go +++ b/service/worklink/types/types.go @@ -19,70 +19,70 @@ type DeviceSummary struct { // The summary of the domain. type DomainSummary struct { + // The time that the domain was created. + // + // This member is required. + CreatedTime *time.Time + // The name of the domain. // // This member is required. DomainName *string - // The name to display. - DisplayName *string - // The status of the domain. // // This member is required. DomainStatus DomainStatus - // The time that the domain was created. - // - // This member is required. - CreatedTime *time.Time + // The name to display. + DisplayName *string } // The summary of the fleet. type FleetSummary struct { - // The time when the fleet was last updated. - LastUpdatedTime *time.Time - // The identifier used by users to sign into the Amazon WorkLink app. CompanyCode *string + // The time when the fleet was created. + CreatedTime *time.Time + // The name of the fleet to display. DisplayName *string + // The Amazon Resource Name (ARN) of the fleet. + FleetArn *string + // The name of the fleet. FleetName *string - // The time when the fleet was created. - CreatedTime *time.Time - // The status of the fleet. FleetStatus FleetStatus + // The time when the fleet was last updated. + LastUpdatedTime *time.Time + // The tags attached to the resource. A tag is a key-value pair. Tags map[string]*string - - // The Amazon Resource Name (ARN) of the fleet. - FleetArn *string } // The summary of the website authorization provider. type WebsiteAuthorizationProviderSummary struct { + // The authorization provider type. + // + // This member is required. + AuthorizationProviderType AuthorizationProviderType + // A unique identifier for the authorization provider. AuthorizationProviderId *string - // The domain name of the authorization provider. This applies only to SAML-based - // authorization providers. - DomainName *string - // The time of creation. CreatedTime *time.Time - // The authorization provider type. - // - // This member is required. - AuthorizationProviderType AuthorizationProviderType + // The domain name of the authorization provider. This applies only to SAML-based + // authorization providers. + DomainName *string } // The summary of the certificate authority (CA). @@ -91,9 +91,9 @@ type WebsiteCaSummary struct { // The time when the CA was added. CreatedTime *time.Time - // A unique identifier for the CA. - WebsiteCaId *string - // The name to display. DisplayName *string + + // A unique identifier for the CA. + WebsiteCaId *string } diff --git a/service/workmail/api_op_AssociateDelegateToResource.go b/service/workmail/api_op_AssociateDelegateToResource.go index 396bc29ef2c..2fc797b02fe 100644 --- a/service/workmail/api_op_AssociateDelegateToResource.go +++ b/service/workmail/api_op_AssociateDelegateToResource.go @@ -56,15 +56,15 @@ func (c *Client) AssociateDelegateToResource(ctx context.Context, params *Associ type AssociateDelegateToResourceInput struct { - // The organization under which the resource exists. + // The member (user or group) to associate to the resource. // // This member is required. - OrganizationId *string + EntityId *string - // The member (user or group) to associate to the resource. + // The organization under which the resource exists. // // This member is required. - EntityId *string + OrganizationId *string // The resource for which members (users or groups) are associated. // diff --git a/service/workmail/api_op_AssociateMemberToGroup.go b/service/workmail/api_op_AssociateMemberToGroup.go index 01b8fad66c9..f27d7cb2424 100644 --- a/service/workmail/api_op_AssociateMemberToGroup.go +++ b/service/workmail/api_op_AssociateMemberToGroup.go @@ -56,15 +56,15 @@ func (c *Client) AssociateMemberToGroup(ctx context.Context, params *AssociateMe type AssociateMemberToGroupInput struct { - // The member (user or group) to associate to the group. + // The group to which the member (user or group) is associated. // // This member is required. - MemberId *string + GroupId *string - // The group to which the member (user or group) is associated. + // The member (user or group) to associate to the group. // // This member is required. - GroupId *string + MemberId *string // The organization under which the group exists. // diff --git a/service/workmail/api_op_CreateAlias.go b/service/workmail/api_op_CreateAlias.go index 59ef66350f7..0d93c9aea20 100644 --- a/service/workmail/api_op_CreateAlias.go +++ b/service/workmail/api_op_CreateAlias.go @@ -56,20 +56,20 @@ func (c *Client) CreateAlias(ctx context.Context, params *CreateAliasInput, optF type CreateAliasInput struct { - // The organization under which the member (user or group) exists. + // The alias to add to the member set. // // This member is required. - OrganizationId *string + Alias *string // The member (user or group) to which this alias is added. // // This member is required. EntityId *string - // The alias to add to the member set. + // The organization under which the member (user or group) exists. // // This member is required. - Alias *string + OrganizationId *string } type CreateAliasOutput struct { diff --git a/service/workmail/api_op_CreateResource.go b/service/workmail/api_op_CreateResource.go index 3d69f63b9bc..15fa53f1ed4 100644 --- a/service/workmail/api_op_CreateResource.go +++ b/service/workmail/api_op_CreateResource.go @@ -57,11 +57,6 @@ func (c *Client) CreateResource(ctx context.Context, params *CreateResourceInput type CreateResourceInput struct { - // The type of the new resource. The available types are equipment and room. - // - // This member is required. - Type types.ResourceType - // The name of the new resource. // // This member is required. @@ -72,6 +67,11 @@ type CreateResourceInput struct { // // This member is required. OrganizationId *string + + // The type of the new resource. The available types are equipment and room. + // + // This member is required. + Type types.ResourceType } type CreateResourceOutput struct { diff --git a/service/workmail/api_op_CreateUser.go b/service/workmail/api_op_CreateUser.go index abbd6a307ec..7880d169211 100644 --- a/service/workmail/api_op_CreateUser.go +++ b/service/workmail/api_op_CreateUser.go @@ -57,10 +57,10 @@ func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns type CreateUserInput struct { - // The password for the new user. + // The display name for the new user. // // This member is required. - Password *string + DisplayName *string // The name for the new user. Simple AD or AD Connector user names have a maximum // length of 20. All others have a maximum length of 64. @@ -68,15 +68,15 @@ type CreateUserInput struct { // This member is required. Name *string - // The display name for the new user. + // The identifier of the organization for which the user is created. // // This member is required. - DisplayName *string + OrganizationId *string - // The identifier of the organization for which the user is created. + // The password for the new user. // // This member is required. - OrganizationId *string + Password *string } type CreateUserOutput struct { diff --git a/service/workmail/api_op_DeleteAlias.go b/service/workmail/api_op_DeleteAlias.go index eadd8d91f82..8378dd8aa00 100644 --- a/service/workmail/api_op_DeleteAlias.go +++ b/service/workmail/api_op_DeleteAlias.go @@ -56,10 +56,11 @@ func (c *Client) DeleteAlias(ctx context.Context, params *DeleteAliasInput, optF type DeleteAliasInput struct { - // The identifier for the organization under which the user exists. + // The aliases to be removed from the user's set of aliases. Duplicate entries in + // the list are collapsed into single entries (the list is transformed into a set). // // This member is required. - OrganizationId *string + Alias *string // The identifier for the member (user or group) from which to have the aliases // removed. @@ -67,11 +68,10 @@ type DeleteAliasInput struct { // This member is required. EntityId *string - // The aliases to be removed from the user's set of aliases. Duplicate entries in - // the list are collapsed into single entries (the list is transformed into a set). + // The identifier for the organization under which the user exists. // // This member is required. - Alias *string + OrganizationId *string } type DeleteAliasOutput struct { diff --git a/service/workmail/api_op_DeleteGroup.go b/service/workmail/api_op_DeleteGroup.go index 8624829fb2c..f59f42674c3 100644 --- a/service/workmail/api_op_DeleteGroup.go +++ b/service/workmail/api_op_DeleteGroup.go @@ -56,15 +56,15 @@ func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optF type DeleteGroupInput struct { - // The organization that contains the group. + // The identifier of the group to be deleted. // // This member is required. - OrganizationId *string + GroupId *string - // The identifier of the group to be deleted. + // The organization that contains the group. // // This member is required. - GroupId *string + OrganizationId *string } type DeleteGroupOutput struct { diff --git a/service/workmail/api_op_DeleteMailboxPermissions.go b/service/workmail/api_op_DeleteMailboxPermissions.go index aa0a2eceb17..c8b2fad1e56 100644 --- a/service/workmail/api_op_DeleteMailboxPermissions.go +++ b/service/workmail/api_op_DeleteMailboxPermissions.go @@ -61,17 +61,17 @@ type DeleteMailboxPermissionsInput struct { // This member is required. EntityId *string - // The identifier of the organization under which the member (user or group) - // exists. - // - // This member is required. - OrganizationId *string - // The identifier of the member (user or group) for which to delete granted // permissions. // // This member is required. GranteeId *string + + // The identifier of the organization under which the member (user or group) + // exists. + // + // This member is required. + OrganizationId *string } type DeleteMailboxPermissionsOutput struct { diff --git a/service/workmail/api_op_DeleteResource.go b/service/workmail/api_op_DeleteResource.go index 28fa0390e16..1df81e3b7da 100644 --- a/service/workmail/api_op_DeleteResource.go +++ b/service/workmail/api_op_DeleteResource.go @@ -56,16 +56,16 @@ func (c *Client) DeleteResource(ctx context.Context, params *DeleteResourceInput type DeleteResourceInput struct { - // The identifier of the resource to be deleted. - // - // This member is required. - ResourceId *string - // The identifier associated with the organization from which the resource is // deleted. // // This member is required. OrganizationId *string + + // The identifier of the resource to be deleted. + // + // This member is required. + ResourceId *string } type DeleteResourceOutput struct { diff --git a/service/workmail/api_op_DeleteUser.go b/service/workmail/api_op_DeleteUser.go index 6f541e415e4..f4f8cd430b1 100644 --- a/service/workmail/api_op_DeleteUser.go +++ b/service/workmail/api_op_DeleteUser.go @@ -60,15 +60,15 @@ func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns type DeleteUserInput struct { - // The identifier of the user to be deleted. + // The organization that contains the user to be deleted. // // This member is required. - UserId *string + OrganizationId *string - // The organization that contains the user to be deleted. + // The identifier of the user to be deleted. // // This member is required. - OrganizationId *string + UserId *string } type DeleteUserOutput struct { diff --git a/service/workmail/api_op_DeregisterFromWorkMail.go b/service/workmail/api_op_DeregisterFromWorkMail.go index cd210083fd9..e7613588ea2 100644 --- a/service/workmail/api_op_DeregisterFromWorkMail.go +++ b/service/workmail/api_op_DeregisterFromWorkMail.go @@ -59,16 +59,16 @@ func (c *Client) DeregisterFromWorkMail(ctx context.Context, params *DeregisterF type DeregisterFromWorkMailInput struct { - // The identifier for the organization under which the Amazon WorkMail entity - // exists. + // The identifier for the member (user or group) to be updated. // // This member is required. - OrganizationId *string + EntityId *string - // The identifier for the member (user or group) to be updated. + // The identifier for the organization under which the Amazon WorkMail entity + // exists. // // This member is required. - EntityId *string + OrganizationId *string } type DeregisterFromWorkMailOutput struct { diff --git a/service/workmail/api_op_DescribeGroup.go b/service/workmail/api_op_DescribeGroup.go index 52803c63169..e3dc43053c1 100644 --- a/service/workmail/api_op_DescribeGroup.go +++ b/service/workmail/api_op_DescribeGroup.go @@ -71,22 +71,22 @@ type DescribeGroupInput struct { type DescribeGroupOutput struct { - // The identifier of the described group. - GroupId *string - // The date and time when a user was deregistered from WorkMail, in UNIX epoch time // format. DisabledDate *time.Time - // The name of the described group. - Name *string + // The email of the described group. + Email *string // The date and time when a user was registered to WorkMail, in UNIX epoch time // format. EnabledDate *time.Time - // The email of the described group. - Email *string + // The identifier of the described group. + GroupId *string + + // The name of the described group. + Name *string // The state of the user: enabled (registered to Amazon WorkMail) or disabled // (deregistered or never registered to WorkMail). diff --git a/service/workmail/api_op_DescribeOrganization.go b/service/workmail/api_op_DescribeOrganization.go index 4ccad06119b..8e4d9283dfe 100644 --- a/service/workmail/api_op_DescribeOrganization.go +++ b/service/workmail/api_op_DescribeOrganization.go @@ -66,30 +66,30 @@ type DescribeOrganizationInput struct { type DescribeOrganizationOutput struct { + // The alias for an organization. + Alias *string + + // The date at which the organization became usable in the WorkMail context, in + // UNIX epoch time format. + CompletedDate *time.Time + + // The default mail domain associated with the organization. + DefaultMailDomain *string + // The identifier for the directory associated with an Amazon WorkMail // organization. DirectoryId *string + // The type of directory associated with the WorkMail organization. + DirectoryType *string + // (Optional) The error message indicating if unexpected behavior was encountered // with regards to the organization. ErrorMessage *string - // The default mail domain associated with the organization. - DefaultMailDomain *string - // The identifier of an organization. OrganizationId *string - // The date at which the organization became usable in the WorkMail context, in - // UNIX epoch time format. - CompletedDate *time.Time - - // The type of directory associated with the WorkMail organization. - DirectoryType *string - - // The alias for an organization. - Alias *string - // The state of an organization. State *string diff --git a/service/workmail/api_op_DescribeResource.go b/service/workmail/api_op_DescribeResource.go index 7bc6c0c5fb9..4870cb6014e 100644 --- a/service/workmail/api_op_DescribeResource.go +++ b/service/workmail/api_op_DescribeResource.go @@ -72,16 +72,23 @@ type DescribeResourceInput struct { type DescribeResourceOutput struct { - // The type of the described resource. - Type types.ResourceType - - // The name of the described resource. - Name *string + // The booking options for the described resource. + BookingOptions *types.BookingOptions // The date and time when a resource was disabled from WorkMail, in UNIX epoch time // format. DisabledDate *time.Time + // The email of the described resource. + Email *string + + // The date and time when a resource was enabled for WorkMail, in UNIX epoch time + // format. + EnabledDate *time.Time + + // The name of the described resource. + Name *string + // The identifier of the described resource. ResourceId *string @@ -89,15 +96,8 @@ type DescribeResourceOutput struct { // (deregistered or never registered to WorkMail). State types.EntityState - // The booking options for the described resource. - BookingOptions *types.BookingOptions - - // The date and time when a resource was enabled for WorkMail, in UNIX epoch time - // format. - EnabledDate *time.Time - - // The email of the described resource. - Email *string + // The type of the described resource. + Type types.ResourceType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/workmail/api_op_DescribeUser.go b/service/workmail/api_op_DescribeUser.go index 742d589d4bb..ee418b547d1 100644 --- a/service/workmail/api_op_DescribeUser.go +++ b/service/workmail/api_op_DescribeUser.go @@ -75,33 +75,33 @@ type DescribeUserOutput struct { // UNIX epoch time format. DisabledDate *time.Time - // The date and time at which the user was enabled for Amazon WorkMail usage, in - // UNIX epoch time format. - EnabledDate *time.Time + // The display name of the user. + DisplayName *string // The email of the user. Email *string - // In certain cases, other entities are modeled as users. If interoperability is - // enabled, resources are imported into Amazon WorkMail as users. Because different - // WorkMail organizations rely on different directory types, administrators can - // distinguish between an unregistered user (account is disabled and has a user - // role) and the directory administrators. The values are USER, RESOURCE, and - // SYSTEM_USER. - UserRole types.UserRole + // The date and time at which the user was enabled for Amazon WorkMail usage, in + // UNIX epoch time format. + EnabledDate *time.Time + + // The name for the user. + Name *string // The state of a user: enabled (registered to Amazon WorkMail) or disabled // (deregistered or never registered to WorkMail). State types.EntityState - // The name for the user. - Name *string - // The identifier for the described user. UserId *string - // The display name of the user. - DisplayName *string + // In certain cases, other entities are modeled as users. If interoperability is + // enabled, resources are imported into Amazon WorkMail as users. Because different + // WorkMail organizations rely on different directory types, administrators can + // distinguish between an unregistered user (account is disabled and has a user + // role) and the directory administrators. The values are USER, RESOURCE, and + // SYSTEM_USER. + UserRole types.UserRole // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/workmail/api_op_DisassociateDelegateFromResource.go b/service/workmail/api_op_DisassociateDelegateFromResource.go index 645f89f141a..bf81e93200a 100644 --- a/service/workmail/api_op_DisassociateDelegateFromResource.go +++ b/service/workmail/api_op_DisassociateDelegateFromResource.go @@ -56,6 +56,12 @@ func (c *Client) DisassociateDelegateFromResource(ctx context.Context, params *D type DisassociateDelegateFromResourceInput struct { + // The identifier for the member (user, group) to be removed from the resource's + // delegates. + // + // This member is required. + EntityId *string + // The identifier for the organization under which the resource exists. // // This member is required. @@ -65,12 +71,6 @@ type DisassociateDelegateFromResourceInput struct { // // This member is required. ResourceId *string - - // The identifier for the member (user, group) to be removed from the resource's - // delegates. - // - // This member is required. - EntityId *string } type DisassociateDelegateFromResourceOutput struct { diff --git a/service/workmail/api_op_DisassociateMemberFromGroup.go b/service/workmail/api_op_DisassociateMemberFromGroup.go index 942bf097ac9..2bada64af5d 100644 --- a/service/workmail/api_op_DisassociateMemberFromGroup.go +++ b/service/workmail/api_op_DisassociateMemberFromGroup.go @@ -56,6 +56,11 @@ func (c *Client) DisassociateMemberFromGroup(ctx context.Context, params *Disass type DisassociateMemberFromGroupInput struct { + // The identifier for the group from which members are removed. + // + // This member is required. + GroupId *string + // The identifier for the member to be removed to the group. // // This member is required. @@ -65,11 +70,6 @@ type DisassociateMemberFromGroupInput struct { // // This member is required. OrganizationId *string - - // The identifier for the group from which members are removed. - // - // This member is required. - GroupId *string } type DisassociateMemberFromGroupOutput struct { diff --git a/service/workmail/api_op_GetMailboxDetails.go b/service/workmail/api_op_GetMailboxDetails.go index e450e78f7cc..837e9166b2e 100644 --- a/service/workmail/api_op_GetMailboxDetails.go +++ b/service/workmail/api_op_GetMailboxDetails.go @@ -56,26 +56,26 @@ func (c *Client) GetMailboxDetails(ctx context.Context, params *GetMailboxDetail type GetMailboxDetailsInput struct { - // The identifier for the user whose mailbox details are being requested. - // - // This member is required. - UserId *string - // The identifier for the organization that contains the user whose mailbox details // are being requested. // // This member is required. OrganizationId *string + + // The identifier for the user whose mailbox details are being requested. + // + // This member is required. + UserId *string } type GetMailboxDetailsOutput struct { - // The current mailbox size, in MB, for the specified user. - MailboxSize *float64 - // The maximum allowed mailbox size, in MB, for the specified user. MailboxQuota *int32 + // The current mailbox size, in MB, for the specified user. + MailboxSize *float64 + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/workmail/api_op_ListAliases.go b/service/workmail/api_op_ListAliases.go index e65dc8cd748..f3005fa1c16 100644 --- a/service/workmail/api_op_ListAliases.go +++ b/service/workmail/api_op_ListAliases.go @@ -56,22 +56,22 @@ func (c *Client) ListAliases(ctx context.Context, params *ListAliasesInput, optF type ListAliasesInput struct { + // The identifier for the entity for which to list the aliases. + // + // This member is required. + EntityId *string + // The identifier for the organization under which the entity exists. // // This member is required. OrganizationId *string - // The token to use to retrieve the next page of results. The first call does not - // contain any tokens. - NextToken *string - // The maximum number of results to return in a single call. MaxResults *int32 - // The identifier for the entity for which to list the aliases. - // - // This member is required. - EntityId *string + // The token to use to retrieve the next page of results. The first call does not + // contain any tokens. + NextToken *string } type ListAliasesOutput struct { diff --git a/service/workmail/api_op_ListGroups.go b/service/workmail/api_op_ListGroups.go index 7bb30b15610..293fbf346cb 100644 --- a/service/workmail/api_op_ListGroups.go +++ b/service/workmail/api_op_ListGroups.go @@ -57,17 +57,17 @@ func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns type ListGroupsInput struct { - // The token to use to retrieve the next page of results. The first call does not - // contain any tokens. - NextToken *string - - // The maximum number of results to return in a single call. - MaxResults *int32 - // The identifier for the organization under which the groups exist. // // This member is required. OrganizationId *string + + // The maximum number of results to return in a single call. + MaxResults *int32 + + // The token to use to retrieve the next page of results. The first call does not + // contain any tokens. + NextToken *string } type ListGroupsOutput struct { diff --git a/service/workmail/api_op_ListMailboxPermissions.go b/service/workmail/api_op_ListMailboxPermissions.go index 3e865165689..9b34286a685 100644 --- a/service/workmail/api_op_ListMailboxPermissions.go +++ b/service/workmail/api_op_ListMailboxPermissions.go @@ -58,24 +58,24 @@ func (c *Client) ListMailboxPermissions(ctx context.Context, params *ListMailbox type ListMailboxPermissionsInput struct { + // The identifier of the user, group, or resource for which to list mailbox + // permissions. + // + // This member is required. + EntityId *string + // The identifier of the organization under which the user, group, or resource // exists. // // This member is required. OrganizationId *string - // The identifier of the user, group, or resource for which to list mailbox - // permissions. - // - // This member is required. - EntityId *string + // The maximum number of results to return in a single call. + MaxResults *int32 // The token to use to retrieve the next page of results. The first call does not // contain any tokens. NextToken *string - - // The maximum number of results to return in a single call. - MaxResults *int32 } type ListMailboxPermissionsOutput struct { diff --git a/service/workmail/api_op_ListResourceDelegates.go b/service/workmail/api_op_ListResourceDelegates.go index 1d24411db67..a5f68058e7f 100644 --- a/service/workmail/api_op_ListResourceDelegates.go +++ b/service/workmail/api_op_ListResourceDelegates.go @@ -58,9 +58,6 @@ func (c *Client) ListResourceDelegates(ctx context.Context, params *ListResource type ListResourceDelegatesInput struct { - // The number of maximum results in a page. - MaxResults *int32 - // The identifier for the organization that contains the resource for which // delegates are listed. // @@ -72,20 +69,23 @@ type ListResourceDelegatesInput struct { // This member is required. ResourceId *string + // The number of maximum results in a page. + MaxResults *int32 + // The token used to paginate through the delegates associated with a resource. NextToken *string } type ListResourceDelegatesOutput struct { + // One page of the resource's delegates. + Delegates []*types.Delegate + // The token used to paginate through the delegates associated with a resource. // While results are still available, it has an associated value. When the last // page is reached, the token is empty. NextToken *string - // One page of the resource's delegates. - Delegates []*types.Delegate - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/workmail/api_op_ListResources.go b/service/workmail/api_op_ListResources.go index fda98e7405b..8239a989532 100644 --- a/service/workmail/api_op_ListResources.go +++ b/service/workmail/api_op_ListResources.go @@ -57,29 +57,29 @@ func (c *Client) ListResources(ctx context.Context, params *ListResourcesInput, type ListResourcesInput struct { + // The identifier for the organization under which the resources exist. + // + // This member is required. + OrganizationId *string + // The maximum number of results to return in a single call. MaxResults *int32 // The token to use to retrieve the next page of results. The first call does not // contain any tokens. NextToken *string - - // The identifier for the organization under which the resources exist. - // - // This member is required. - OrganizationId *string } type ListResourcesOutput struct { - // One page of the organization's resource representation. - Resources []*types.Resource - // The token used to paginate through all the organization's resources. While // results are still available, it has an associated value. When the last page is // reached, the token is empty. NextToken *string + // One page of the organization's resource representation. + Resources []*types.Resource + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/workmail/api_op_ListUsers.go b/service/workmail/api_op_ListUsers.go index d5ce53e1e32..a75f65f0942 100644 --- a/service/workmail/api_op_ListUsers.go +++ b/service/workmail/api_op_ListUsers.go @@ -57,17 +57,17 @@ func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns . type ListUsersInput struct { - // The token to use to retrieve the next page of results. The first call does not - // contain any tokens. - NextToken *string - - // The maximum number of results to return in a single call. - MaxResults *int32 - // The identifier for the organization under which the users exist. // // This member is required. OrganizationId *string + + // The maximum number of results to return in a single call. + MaxResults *int32 + + // The token to use to retrieve the next page of results. The first call does not + // contain any tokens. + NextToken *string } type ListUsersOutput struct { diff --git a/service/workmail/api_op_PutMailboxPermissions.go b/service/workmail/api_op_PutMailboxPermissions.go index 5a1ff08cb9e..9ac6e9e0b63 100644 --- a/service/workmail/api_op_PutMailboxPermissions.go +++ b/service/workmail/api_op_PutMailboxPermissions.go @@ -58,17 +58,23 @@ func (c *Client) PutMailboxPermissions(ctx context.Context, params *PutMailboxPe type PutMailboxPermissionsInput struct { + // The identifier of the user, group, or resource for which to update mailbox + // permissions. + // + // This member is required. + EntityId *string + // The identifier of the user, group, or resource to which to grant the // permissions. // // This member is required. GranteeId *string - // The identifier of the user, group, or resource for which to update mailbox - // permissions. + // The identifier of the organization under which the user, group, or resource + // exists. // // This member is required. - EntityId *string + OrganizationId *string // The permissions granted to the grantee. SEND_AS allows the grantee to send email // as the owner of the mailbox (the grantee is not mentioned on these emails). @@ -79,12 +85,6 @@ type PutMailboxPermissionsInput struct { // // This member is required. PermissionValues []types.PermissionType - - // The identifier of the organization under which the user, group, or resource - // exists. - // - // This member is required. - OrganizationId *string } type PutMailboxPermissionsOutput struct { diff --git a/service/workmail/api_op_RegisterToWorkMail.go b/service/workmail/api_op_RegisterToWorkMail.go index aceaaec6610..d9fc6dfc62c 100644 --- a/service/workmail/api_op_RegisterToWorkMail.go +++ b/service/workmail/api_op_RegisterToWorkMail.go @@ -69,16 +69,16 @@ type RegisterToWorkMailInput struct { // This member is required. Email *string - // The identifier for the organization under which the user, group, or resource - // exists. + // The identifier for the user, group, or resource to be updated. // // This member is required. - OrganizationId *string + EntityId *string - // The identifier for the user, group, or resource to be updated. + // The identifier for the organization under which the user, group, or resource + // exists. // // This member is required. - EntityId *string + OrganizationId *string } type RegisterToWorkMailOutput struct { diff --git a/service/workmail/api_op_ResetPassword.go b/service/workmail/api_op_ResetPassword.go index 94dc6a522e6..bd1f52f25f8 100644 --- a/service/workmail/api_op_ResetPassword.go +++ b/service/workmail/api_op_ResetPassword.go @@ -62,15 +62,15 @@ type ResetPasswordInput struct { // This member is required. OrganizationId *string - // The identifier of the user for whom the password is reset. + // The new password for the user. // // This member is required. - UserId *string + Password *string - // The new password for the user. + // The identifier of the user for whom the password is reset. // // This member is required. - Password *string + UserId *string } type ResetPasswordOutput struct { diff --git a/service/workmail/api_op_UpdateMailboxQuota.go b/service/workmail/api_op_UpdateMailboxQuota.go index 54d6fc6c9e3..3747aba5af0 100644 --- a/service/workmail/api_op_UpdateMailboxQuota.go +++ b/service/workmail/api_op_UpdateMailboxQuota.go @@ -56,10 +56,10 @@ func (c *Client) UpdateMailboxQuota(ctx context.Context, params *UpdateMailboxQu type UpdateMailboxQuotaInput struct { - // The identifer for the user for whom to update the mailbox quota. + // The updated mailbox quota, in MB, for the specified user. // // This member is required. - UserId *string + MailboxQuota *int32 // The identifier for the organization that contains the user for whom to update // the mailbox quota. @@ -67,10 +67,10 @@ type UpdateMailboxQuotaInput struct { // This member is required. OrganizationId *string - // The updated mailbox quota, in MB, for the specified user. + // The identifer for the user for whom to update the mailbox quota. // // This member is required. - MailboxQuota *int32 + UserId *string } type UpdateMailboxQuotaOutput struct { diff --git a/service/workmail/api_op_UpdatePrimaryEmailAddress.go b/service/workmail/api_op_UpdatePrimaryEmailAddress.go index f103867845e..52c09786fd8 100644 --- a/service/workmail/api_op_UpdatePrimaryEmailAddress.go +++ b/service/workmail/api_op_UpdatePrimaryEmailAddress.go @@ -59,11 +59,6 @@ func (c *Client) UpdatePrimaryEmailAddress(ctx context.Context, params *UpdatePr type UpdatePrimaryEmailAddressInput struct { - // The organization that contains the user, group, or resource to update. - // - // This member is required. - OrganizationId *string - // The value of the email to be updated as primary. // // This member is required. @@ -73,6 +68,11 @@ type UpdatePrimaryEmailAddressInput struct { // // This member is required. EntityId *string + + // The organization that contains the user, group, or resource to update. + // + // This member is required. + OrganizationId *string } type UpdatePrimaryEmailAddressOutput struct { diff --git a/service/workmail/api_op_UpdateResource.go b/service/workmail/api_op_UpdateResource.go index 8b993f49934..2fdb9e7b72d 100644 --- a/service/workmail/api_op_UpdateResource.go +++ b/service/workmail/api_op_UpdateResource.go @@ -59,22 +59,22 @@ func (c *Client) UpdateResource(ctx context.Context, params *UpdateResourceInput type UpdateResourceInput struct { - // The identifier of the resource to be updated. - // - // This member is required. - ResourceId *string - // The identifier associated with the organization for which the resource is // updated. // // This member is required. OrganizationId *string - // The name of the resource to be updated. - Name *string + // The identifier of the resource to be updated. + // + // This member is required. + ResourceId *string // The resource's booking options to be updated. BookingOptions *types.BookingOptions + + // The name of the resource to be updated. + Name *string } type UpdateResourceOutput struct { diff --git a/service/workmail/go.mod b/service/workmail/go.mod index 9c61633c463..18678e3ec34 100644 --- a/service/workmail/go.mod +++ b/service/workmail/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/workmail go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/workmail/types/types.go b/service/workmail/types/types.go index 42508609b98..e36cccc3194 100644 --- a/service/workmail/types/types.go +++ b/service/workmail/types/types.go @@ -10,59 +10,62 @@ import ( // replies from the resource. type BookingOptions struct { - // The resource's ability to automatically decline any recurring requests. - AutoDeclineRecurringRequests *bool - // The resource's ability to automatically reply to requests. If disabled, // delegates must be associated to the resource. AutoAcceptRequests *bool // The resource's ability to automatically decline any conflicting requests. AutoDeclineConflictingRequests *bool + + // The resource's ability to automatically decline any recurring requests. + AutoDeclineRecurringRequests *bool } // The name of the attribute, which is one of the values defined in the // UserAttribute enumeration. type Delegate struct { - // The type of the delegate: user or group. + // The identifier for the user or group associated as the resource's delegate. // // This member is required. - Type MemberType + Id *string - // The identifier for the user or group associated as the resource's delegate. + // The type of the delegate: user or group. // // This member is required. - Id *string + Type MemberType } // The representation of an Amazon WorkMail group. type Group struct { - // The state of the group, which can be ENABLED, DISABLED, or DELETED. - State EntityState + // The date indicating when the group was disabled from Amazon WorkMail use. + DisabledDate *time.Time // The email of the group. Email *string - // The identifier of the group. - Id *string - // The date indicating when the group was enabled for Amazon WorkMail use. EnabledDate *time.Time + // The identifier of the group. + Id *string + // The name of the group. Name *string - // The date indicating when the group was disabled from Amazon WorkMail use. - DisabledDate *time.Time + // The state of the group, which can be ENABLED, DISABLED, or DELETED. + State EntityState } // The representation of a user or group. type Member struct { - // The state of the member, which can be ENABLED, DISABLED, or DELETED. - State EntityState + // The date indicating when the member was disabled from Amazon WorkMail use. + DisabledDate *time.Time + + // The date indicating when the member was enabled for Amazon WorkMail use. + EnabledDate *time.Time // The identifier of the member. Id *string @@ -70,109 +73,106 @@ type Member struct { // The name of the member. Name *string - // The date indicating when the member was enabled for Amazon WorkMail use. - EnabledDate *time.Time + // The state of the member, which can be ENABLED, DISABLED, or DELETED. + State EntityState // A member can be a user or group. Type MemberType - - // The date indicating when the member was disabled from Amazon WorkMail use. - DisabledDate *time.Time } // The representation of an organization. type OrganizationSummary struct { + // The alias associated with the organization. + Alias *string + // The error message associated with the organization. It is only present if // unexpected behavior has occurred with regards to the organization. It provides // insight or solutions regarding unexpected behavior. ErrorMessage *string - // The state associated with the organization. - State *string - - // The alias associated with the organization. - Alias *string - // The identifier associated with the organization. OrganizationId *string + + // The state associated with the organization. + State *string } // Permission granted to a user, group, or resource to access a certain aspect of // another user, group, or resource mailbox. type Permission struct { - // The permissions granted to the grantee. SEND_AS allows the grantee to send email - // as the owner of the mailbox (the grantee is not mentioned on these emails). - // SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the - // mailbox (the grantee is not mentioned as the physical sender of these emails). - // FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other - // folder-level permissions set on the mailbox. + // The identifier of the user, group, or resource to which the permissions are + // granted. // // This member is required. - PermissionValues []PermissionType + GranteeId *string // The type of user, group, or resource referred to in GranteeId. // // This member is required. GranteeType MemberType - // The identifier of the user, group, or resource to which the permissions are - // granted. + // The permissions granted to the grantee. SEND_AS allows the grantee to send email + // as the owner of the mailbox (the grantee is not mentioned on these emails). + // SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the + // mailbox (the grantee is not mentioned as the physical sender of these emails). + // FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other + // folder-level permissions set on the mailbox. // // This member is required. - GranteeId *string + PermissionValues []PermissionType } // The representation of a resource. type Resource struct { - // The date indicating when the resource was enabled for Amazon WorkMail use. - EnabledDate *time.Time + // The date indicating when the resource was disabled from Amazon WorkMail use. + DisabledDate *time.Time // The email of the resource. Email *string - // The type of the resource: equipment or room. - Type ResourceType + // The date indicating when the resource was enabled for Amazon WorkMail use. + EnabledDate *time.Time - // The date indicating when the resource was disabled from Amazon WorkMail use. - DisabledDate *time.Time + // The identifier of the resource. + Id *string // The name of the resource. Name *string - // The identifier of the resource. - Id *string - // The state of the resource, which can be ENABLED, DISABLED, or DELETED. State EntityState + + // The type of the resource: equipment or room. + Type ResourceType } // The representation of an Amazon WorkMail user. type User struct { + // The date indicating when the user was disabled from Amazon WorkMail use. + DisabledDate *time.Time + // The display name of the user. DisplayName *string - // The state of the user, which can be ENABLED, DISABLED, or DELETED. - State EntityState - - // The name of the user. - Name *string + // The email of the user. + Email *string - // The role of the user. - UserRole UserRole + // The date indicating when the user was enabled for Amazon WorkMail use. + EnabledDate *time.Time // The identifier of the user. Id *string - // The email of the user. - Email *string + // The name of the user. + Name *string - // The date indicating when the user was enabled for Amazon WorkMail use. - EnabledDate *time.Time + // The state of the user, which can be ENABLED, DISABLED, or DELETED. + State EntityState - // The date indicating when the user was disabled from Amazon WorkMail use. - DisabledDate *time.Time + // The role of the user. + UserRole UserRole } diff --git a/service/workmailmessageflow/go.mod b/service/workmailmessageflow/go.mod index f46b4e3b86f..c8fe334ac81 100644 --- a/service/workmailmessageflow/go.mod +++ b/service/workmailmessageflow/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/workmailmessageflow go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/workspaces/api_op_AssociateIpGroups.go b/service/workspaces/api_op_AssociateIpGroups.go index e575ef4cfc8..e3e9da3eac9 100644 --- a/service/workspaces/api_op_AssociateIpGroups.go +++ b/service/workspaces/api_op_AssociateIpGroups.go @@ -56,15 +56,15 @@ func (c *Client) AssociateIpGroups(ctx context.Context, params *AssociateIpGroup type AssociateIpGroupsInput struct { - // The identifiers of one or more IP access control groups. + // The identifier of the directory. // // This member is required. - GroupIds []*string + DirectoryId *string - // The identifier of the directory. + // The identifiers of one or more IP access control groups. // // This member is required. - DirectoryId *string + GroupIds []*string } type AssociateIpGroupsOutput struct { diff --git a/service/workspaces/api_op_AuthorizeIpRules.go b/service/workspaces/api_op_AuthorizeIpRules.go index 7ffaf87414f..4c54687e04b 100644 --- a/service/workspaces/api_op_AuthorizeIpRules.go +++ b/service/workspaces/api_op_AuthorizeIpRules.go @@ -59,15 +59,15 @@ func (c *Client) AuthorizeIpRules(ctx context.Context, params *AuthorizeIpRulesI type AuthorizeIpRulesInput struct { - // The rules to add to the group. + // The identifier of the group. // // This member is required. - UserRules []*types.IpRuleItem + GroupId *string - // The identifier of the group. + // The rules to add to the group. // // This member is required. - GroupId *string + UserRules []*types.IpRuleItem } type AuthorizeIpRulesOutput struct { diff --git a/service/workspaces/api_op_CopyWorkspaceImage.go b/service/workspaces/api_op_CopyWorkspaceImage.go index a7945c68dae..267290c8a44 100644 --- a/service/workspaces/api_op_CopyWorkspaceImage.go +++ b/service/workspaces/api_op_CopyWorkspaceImage.go @@ -67,9 +67,6 @@ type CopyWorkspaceImageInput struct { // This member is required. SourceImageId *string - // The tags for the image. - Tags []*types.Tag - // The identifier of the source Region. // // This member is required. @@ -77,6 +74,9 @@ type CopyWorkspaceImageInput struct { // A description of the image. Description *string + + // The tags for the image. + Tags []*types.Tag } type CopyWorkspaceImageOutput struct { diff --git a/service/workspaces/api_op_CreateIpGroup.go b/service/workspaces/api_op_CreateIpGroup.go index ef87e6b23d0..8e580c30c4d 100644 --- a/service/workspaces/api_op_CreateIpGroup.go +++ b/service/workspaces/api_op_CreateIpGroup.go @@ -66,19 +66,19 @@ func (c *Client) CreateIpGroup(ctx context.Context, params *CreateIpGroupInput, type CreateIpGroupInput struct { - // The rules to add to the group. - UserRules []*types.IpRuleItem - // The name of the group. // // This member is required. GroupName *string + // The description of the group. + GroupDesc *string + // The tags. Each WorkSpaces resource can have a maximum of 50 tags. Tags []*types.Tag - // The description of the group. - GroupDesc *string + // The rules to add to the group. + UserRules []*types.IpRuleItem } type CreateIpGroupOutput struct { diff --git a/service/workspaces/api_op_CreateTags.go b/service/workspaces/api_op_CreateTags.go index 441edc3d4ad..f217ab58337 100644 --- a/service/workspaces/api_op_CreateTags.go +++ b/service/workspaces/api_op_CreateTags.go @@ -57,19 +57,19 @@ func (c *Client) CreateTags(ctx context.Context, params *CreateTagsInput, optFns type CreateTagsInput struct { - // The tags. Each WorkSpaces resource can have a maximum of 50 tags. If you want to - // add new tags to a set of existing tags, you must submit all of the existing tags - // along with the new ones. - // - // This member is required. - Tags []*types.Tag - // The identifier of the WorkSpaces resource. The supported resource types are // WorkSpaces, registered directories, images, custom bundles, and IP access // control groups. // // This member is required. ResourceId *string + + // The tags. Each WorkSpaces resource can have a maximum of 50 tags. If you want to + // add new tags to a set of existing tags, you must submit all of the existing tags + // along with the new ones. + // + // This member is required. + Tags []*types.Tag } type CreateTagsOutput struct { diff --git a/service/workspaces/api_op_CreateWorkspaces.go b/service/workspaces/api_op_CreateWorkspaces.go index 6a937fd30cf..faece8891e5 100644 --- a/service/workspaces/api_op_CreateWorkspaces.go +++ b/service/workspaces/api_op_CreateWorkspaces.go @@ -66,15 +66,15 @@ type CreateWorkspacesInput struct { type CreateWorkspacesOutput struct { + // Information about the WorkSpaces that could not be created. + FailedRequests []*types.FailedCreateWorkspaceRequest + // Information about the WorkSpaces that were created. Because this operation is // asynchronous, the identifier returned is not immediately available for use with // other operations. For example, if you call DescribeWorkspaces () before the // WorkSpace is created, the information returned can be incomplete. PendingRequests []*types.Workspace - // Information about the WorkSpaces that could not be created. - FailedRequests []*types.FailedCreateWorkspaceRequest - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/workspaces/api_op_DeleteTags.go b/service/workspaces/api_op_DeleteTags.go index 0bfd5a4b988..237a186150a 100644 --- a/service/workspaces/api_op_DeleteTags.go +++ b/service/workspaces/api_op_DeleteTags.go @@ -56,17 +56,17 @@ func (c *Client) DeleteTags(ctx context.Context, params *DeleteTagsInput, optFns type DeleteTagsInput struct { - // The tag keys. - // - // This member is required. - TagKeys []*string - // The identifier of the WorkSpaces resource. The supported resource types are // WorkSpaces, registered directories, images, custom bundles, and IP access // control groups. // // This member is required. ResourceId *string + + // The tag keys. + // + // This member is required. + TagKeys []*string } type DeleteTagsOutput struct { diff --git a/service/workspaces/api_op_DescribeWorkspaceBundles.go b/service/workspaces/api_op_DescribeWorkspaceBundles.go index 7f32ba4b033..685e8340c80 100644 --- a/service/workspaces/api_op_DescribeWorkspaceBundles.go +++ b/service/workspaces/api_op_DescribeWorkspaceBundles.go @@ -57,14 +57,14 @@ func (c *Client) DescribeWorkspaceBundles(ctx context.Context, params *DescribeW type DescribeWorkspaceBundlesInput struct { - // The token for the next set of results. (You received this token from a previous - // call.) - NextToken *string - // The identifiers of the bundles. You cannot combine this parameter with any other // filter. BundleIds []*string + // The token for the next set of results. (You received this token from a previous + // call.) + NextToken *string + // The owner of the bundles. You cannot combine this parameter with any other // filter. Specify AMAZON to describe the bundles provided by AWS or null to // describe the bundles that belong to your account. diff --git a/service/workspaces/api_op_DescribeWorkspaceDirectories.go b/service/workspaces/api_op_DescribeWorkspaceDirectories.go index 78bf1ef27da..e7ce068ef69 100644 --- a/service/workspaces/api_op_DescribeWorkspaceDirectories.go +++ b/service/workspaces/api_op_DescribeWorkspaceDirectories.go @@ -56,27 +56,27 @@ func (c *Client) DescribeWorkspaceDirectories(ctx context.Context, params *Descr type DescribeWorkspaceDirectoriesInput struct { + // The identifiers of the directories. If the value is null, all directories are + // retrieved. + DirectoryIds []*string + // The maximum number of directories to return. Limit *int32 // If you received a NextToken from a previous call that was paginated, provide // this token to receive the next set of results. NextToken *string - - // The identifiers of the directories. If the value is null, all directories are - // retrieved. - DirectoryIds []*string } type DescribeWorkspaceDirectoriesOutput struct { + // Information about the directories. + Directories []*types.WorkspaceDirectory + // The token to use to retrieve the next set of results, or null if no more results // are available. NextToken *string - // Information about the directories. - Directories []*types.WorkspaceDirectory - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/workspaces/api_op_DescribeWorkspaceImagePermissions.go b/service/workspaces/api_op_DescribeWorkspaceImagePermissions.go index fc1e6b4a892..5eca1f4b023 100644 --- a/service/workspaces/api_op_DescribeWorkspaceImagePermissions.go +++ b/service/workspaces/api_op_DescribeWorkspaceImagePermissions.go @@ -58,27 +58,27 @@ func (c *Client) DescribeWorkspaceImagePermissions(ctx context.Context, params * type DescribeWorkspaceImagePermissionsInput struct { + // The identifier of the image. + // + // This member is required. + ImageId *string + // The maximum number of items to return. MaxResults *int32 // If you received a NextToken from a previous call that was paginated, provide // this token to receive the next set of results. NextToken *string - - // The identifier of the image. - // - // This member is required. - ImageId *string } type DescribeWorkspaceImagePermissionsOutput struct { - // The identifiers of the AWS accounts that the image has been shared with. - ImagePermissions []*types.ImagePermission - // The identifier of the image. ImageId *string + // The identifiers of the AWS accounts that the image has been shared with. + ImagePermissions []*types.ImagePermission + // The token to use to retrieve the next set of results, or null if no more results // are available. NextToken *string diff --git a/service/workspaces/api_op_DescribeWorkspaceImages.go b/service/workspaces/api_op_DescribeWorkspaceImages.go index bc4e1180c75..45ec8321f80 100644 --- a/service/workspaces/api_op_DescribeWorkspaceImages.go +++ b/service/workspaces/api_op_DescribeWorkspaceImages.go @@ -60,26 +60,26 @@ type DescribeWorkspaceImagesInput struct { // The identifier of the image. ImageIds []*string + // The type (owned or shared) of the image. + ImageType types.ImageType + // The maximum number of items to return. MaxResults *int32 // If you received a NextToken from a previous call that was paginated, provide // this token to receive the next set of results. NextToken *string - - // The type (owned or shared) of the image. - ImageType types.ImageType } type DescribeWorkspaceImagesOutput struct { + // Information about the images. + Images []*types.WorkspaceImage + // The token to use to retrieve the next set of results, or null if no more results // are available. NextToken *string - // Information about the images. - Images []*types.WorkspaceImage - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/workspaces/api_op_DescribeWorkspaces.go b/service/workspaces/api_op_DescribeWorkspaces.go index d66dce52c2e..0ce6004c8b7 100644 --- a/service/workspaces/api_op_DescribeWorkspaces.go +++ b/service/workspaces/api_op_DescribeWorkspaces.go @@ -58,17 +58,6 @@ func (c *Client) DescribeWorkspaces(ctx context.Context, params *DescribeWorkspa type DescribeWorkspacesInput struct { - // If you received a NextToken from a previous call that was paginated, provide - // this token to receive the next set of results. - NextToken *string - - // The name of the directory user. You must specify this parameter with - // DirectoryId. - UserName *string - - // The maximum number of items to return. - Limit *int32 - // The identifier of the bundle. All WorkSpaces that are created from this bundle // are retrieved. You cannot combine this parameter with any other filter. BundleId *string @@ -78,6 +67,17 @@ type DescribeWorkspacesInput struct { // any other filter. DirectoryId *string + // The maximum number of items to return. + Limit *int32 + + // If you received a NextToken from a previous call that was paginated, provide + // this token to receive the next set of results. + NextToken *string + + // The name of the directory user. You must specify this parameter with + // DirectoryId. + UserName *string + // The identifiers of the WorkSpaces. You cannot combine this parameter with any // other filter. Because the CreateWorkspaces () operation is asynchronous, the // identifier it returns is not immediately available. If you immediately call @@ -87,14 +87,14 @@ type DescribeWorkspacesInput struct { type DescribeWorkspacesOutput struct { - // Information about the WorkSpaces. Because CreateWorkspaces () is an asynchronous - // operation, some of the returned information could be incomplete. - Workspaces []*types.Workspace - // The token to use to retrieve the next set of results, or null if no more results // are available. NextToken *string + // Information about the WorkSpaces. Because CreateWorkspaces () is an asynchronous + // operation, some of the returned information could be incomplete. + Workspaces []*types.Workspace + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/workspaces/api_op_DescribeWorkspacesConnectionStatus.go b/service/workspaces/api_op_DescribeWorkspacesConnectionStatus.go index 4936ba0805e..d1ce89c560a 100644 --- a/service/workspaces/api_op_DescribeWorkspacesConnectionStatus.go +++ b/service/workspaces/api_op_DescribeWorkspacesConnectionStatus.go @@ -66,13 +66,13 @@ type DescribeWorkspacesConnectionStatusInput struct { type DescribeWorkspacesConnectionStatusOutput struct { - // Information about the connection status of the WorkSpace. - WorkspacesConnectionStatus []*types.WorkspaceConnectionStatus - // The token to use to retrieve the next set of results, or null if no more results // are available. NextToken *string + // Information about the connection status of the WorkSpace. + WorkspacesConnectionStatus []*types.WorkspaceConnectionStatus + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/workspaces/api_op_DisassociateIpGroups.go b/service/workspaces/api_op_DisassociateIpGroups.go index 0dc7b6e3c61..5eaa36126e0 100644 --- a/service/workspaces/api_op_DisassociateIpGroups.go +++ b/service/workspaces/api_op_DisassociateIpGroups.go @@ -57,15 +57,15 @@ func (c *Client) DisassociateIpGroups(ctx context.Context, params *DisassociateI type DisassociateIpGroupsInput struct { - // The identifiers of one or more IP access control groups. + // The identifier of the directory. // // This member is required. - GroupIds []*string + DirectoryId *string - // The identifier of the directory. + // The identifiers of one or more IP access control groups. // // This member is required. - DirectoryId *string + GroupIds []*string } type DisassociateIpGroupsOutput struct { diff --git a/service/workspaces/api_op_ImportWorkspaceImage.go b/service/workspaces/api_op_ImportWorkspaceImage.go index f92cf8750e1..483460e8b9d 100644 --- a/service/workspaces/api_op_ImportWorkspaceImage.go +++ b/service/workspaces/api_op_ImportWorkspaceImage.go @@ -69,18 +69,18 @@ type ImportWorkspaceImageInput struct { // This member is required. ImageDescription *string - // The tags. Each WorkSpaces resource can have a maximum of 50 tags. - Tags []*types.Tag + // The name of the WorkSpace image. + // + // This member is required. + ImageName *string // The ingestion process to be used when importing the image. // // This member is required. IngestionProcess types.WorkspaceImageIngestionProcess - // The name of the WorkSpace image. - // - // This member is required. - ImageName *string + // The tags. Each WorkSpaces resource can have a maximum of 50 tags. + Tags []*types.Tag } type ImportWorkspaceImageOutput struct { diff --git a/service/workspaces/api_op_ListAvailableManagementCidrRanges.go b/service/workspaces/api_op_ListAvailableManagementCidrRanges.go index 41f34efd830..b966716f16b 100644 --- a/service/workspaces/api_op_ListAvailableManagementCidrRanges.go +++ b/service/workspaces/api_op_ListAvailableManagementCidrRanges.go @@ -68,23 +68,23 @@ type ListAvailableManagementCidrRangesInput struct { // This member is required. ManagementCidrRangeConstraint *string + // The maximum number of items to return. + MaxResults *int32 + // If you received a NextToken from a previous call that was paginated, provide // this token to receive the next set of results. NextToken *string - - // The maximum number of items to return. - MaxResults *int32 } type ListAvailableManagementCidrRangesOutput struct { + // The list of available IP address ranges, specified as IPv4 CIDR blocks. + ManagementCidrRanges []*string + // The token to use to retrieve the next set of results, or null if no more results // are available. NextToken *string - // The list of available IP address ranges, specified as IPv4 CIDR blocks. - ManagementCidrRanges []*string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/workspaces/api_op_MigrateWorkspace.go b/service/workspaces/api_op_MigrateWorkspace.go index 129b96f7a90..097fe3dfba6 100644 --- a/service/workspaces/api_op_MigrateWorkspace.go +++ b/service/workspaces/api_op_MigrateWorkspace.go @@ -67,27 +67,27 @@ func (c *Client) MigrateWorkspace(ctx context.Context, params *MigrateWorkspaceI type MigrateWorkspaceInput struct { - // The identifier of the WorkSpace to migrate from. + // The identifier of the target bundle type to migrate the WorkSpace to. // // This member is required. - SourceWorkspaceId *string + BundleId *string - // The identifier of the target bundle type to migrate the WorkSpace to. + // The identifier of the WorkSpace to migrate from. // // This member is required. - BundleId *string + SourceWorkspaceId *string } type MigrateWorkspaceOutput struct { + // The original identifier of the WorkSpace that is being migrated. + SourceWorkspaceId *string + // The new identifier of the WorkSpace that is being migrated. If the migration // does not succeed, the target WorkSpace ID will not be used, and the WorkSpace // will still have the original WorkSpace ID. TargetWorkspaceId *string - // The original identifier of the WorkSpace that is being migrated. - SourceWorkspaceId *string - // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/workspaces/api_op_ModifyAccount.go b/service/workspaces/api_op_ModifyAccount.go index 5e16b31e7b6..c54070423a6 100644 --- a/service/workspaces/api_op_ModifyAccount.go +++ b/service/workspaces/api_op_ModifyAccount.go @@ -57,15 +57,15 @@ func (c *Client) ModifyAccount(ctx context.Context, params *ModifyAccountInput, type ModifyAccountInput struct { - // The status of BYOL. - DedicatedTenancySupport types.DedicatedTenancySupportEnum - // The IP address range, specified as an IPv4 CIDR block, for the management // network interface. Specify an IP address range that is compatible with your // network and in CIDR notation (that is, specify the range as an IPv4 CIDR block). // The CIDR block size must be /16 (for example, 203.0.113.25/16). It must also be // specified as available by the ListAvailableManagementCidrRanges operation. DedicatedTenancyManagementCidrRange *string + + // The status of BYOL. + DedicatedTenancySupport types.DedicatedTenancySupportEnum } type ModifyAccountOutput struct { diff --git a/service/workspaces/api_op_ModifySelfservicePermissions.go b/service/workspaces/api_op_ModifySelfservicePermissions.go index 2b6a015048d..c2e4ab17134 100644 --- a/service/workspaces/api_op_ModifySelfservicePermissions.go +++ b/service/workspaces/api_op_ModifySelfservicePermissions.go @@ -60,15 +60,15 @@ func (c *Client) ModifySelfservicePermissions(ctx context.Context, params *Modif type ModifySelfservicePermissionsInput struct { - // The permissions to enable or disable self-service capabilities. + // The identifier of the directory. // // This member is required. - SelfservicePermissions *types.SelfservicePermissions + ResourceId *string - // The identifier of the directory. + // The permissions to enable or disable self-service capabilities. // // This member is required. - ResourceId *string + SelfservicePermissions *types.SelfservicePermissions } type ModifySelfservicePermissionsOutput struct { diff --git a/service/workspaces/api_op_ModifyWorkspaceCreationProperties.go b/service/workspaces/api_op_ModifyWorkspaceCreationProperties.go index 9d098d20c95..1b86fbfb160 100644 --- a/service/workspaces/api_op_ModifyWorkspaceCreationProperties.go +++ b/service/workspaces/api_op_ModifyWorkspaceCreationProperties.go @@ -57,15 +57,15 @@ func (c *Client) ModifyWorkspaceCreationProperties(ctx context.Context, params * type ModifyWorkspaceCreationPropertiesInput struct { - // The default properties for creating WorkSpaces. + // The identifier of the directory. // // This member is required. - WorkspaceCreationProperties *types.WorkspaceCreationProperties + ResourceId *string - // The identifier of the directory. + // The default properties for creating WorkSpaces. // // This member is required. - ResourceId *string + WorkspaceCreationProperties *types.WorkspaceCreationProperties } type ModifyWorkspaceCreationPropertiesOutput struct { diff --git a/service/workspaces/api_op_ModifyWorkspaceState.go b/service/workspaces/api_op_ModifyWorkspaceState.go index 99b1b5d3369..e8c9a429048 100644 --- a/service/workspaces/api_op_ModifyWorkspaceState.go +++ b/service/workspaces/api_op_ModifyWorkspaceState.go @@ -61,15 +61,15 @@ func (c *Client) ModifyWorkspaceState(ctx context.Context, params *ModifyWorkspa type ModifyWorkspaceStateInput struct { - // The WorkSpace state. + // The identifier of the WorkSpace. // // This member is required. - WorkspaceState types.TargetWorkspaceState + WorkspaceId *string - // The identifier of the WorkSpace. + // The WorkSpace state. // // This member is required. - WorkspaceId *string + WorkspaceState types.TargetWorkspaceState } type ModifyWorkspaceStateOutput struct { diff --git a/service/workspaces/api_op_RegisterWorkspaceDirectory.go b/service/workspaces/api_op_RegisterWorkspaceDirectory.go index ccad1289c51..b932088253c 100644 --- a/service/workspaces/api_op_RegisterWorkspaceDirectory.go +++ b/service/workspaces/api_op_RegisterWorkspaceDirectory.go @@ -62,17 +62,6 @@ func (c *Client) RegisterWorkspaceDirectory(ctx context.Context, params *Registe type RegisterWorkspaceDirectoryInput struct { - // The tags associated with the directory. - Tags []*types.Tag - - // Indicates whether your WorkSpace directory is dedicated or shared. To use Bring - // Your Own License (BYOL) images, this value must be set to DEDICATED and your AWS - // account must be enabled for BYOL. If your account has not been enabled for BYOL, - // you will receive an InvalidParameterValuesException error. For more information - // about BYOL images, see Bring Your Own Windows Desktop Images - // (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html). - Tenancy types.Tenancy - // The identifier of the directory. You cannot register a directory if it does not // have a status of Active. If the directory does not have a status of Active, you // will receive an InvalidResourceStateException error. If you have already @@ -91,14 +80,25 @@ type RegisterWorkspaceDirectoryInput struct { // This member is required. EnableWorkDocs *bool + // Indicates whether self-service capabilities are enabled or disabled. + EnableSelfService *bool + // The identifiers of the subnets for your virtual private cloud (VPC). Make sure // that the subnets are in supported Availability Zones. The subnets must also be // in separate Availability Zones. If these conditions are not met, you will // receive an OperationNotSupportedException error. SubnetIds []*string - // Indicates whether self-service capabilities are enabled or disabled. - EnableSelfService *bool + // The tags associated with the directory. + Tags []*types.Tag + + // Indicates whether your WorkSpace directory is dedicated or shared. To use Bring + // Your Own License (BYOL) images, this value must be set to DEDICATED and your AWS + // account must be enabled for BYOL. If your account has not been enabled for BYOL, + // you will receive an InvalidParameterValuesException error. For more information + // about BYOL images, see Bring Your Own Windows Desktop Images + // (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html). + Tenancy types.Tenancy } type RegisterWorkspaceDirectoryOutput struct { diff --git a/service/workspaces/api_op_UpdateRulesOfIpGroup.go b/service/workspaces/api_op_UpdateRulesOfIpGroup.go index 21f7f2310e3..67edb060f03 100644 --- a/service/workspaces/api_op_UpdateRulesOfIpGroup.go +++ b/service/workspaces/api_op_UpdateRulesOfIpGroup.go @@ -58,15 +58,15 @@ func (c *Client) UpdateRulesOfIpGroup(ctx context.Context, params *UpdateRulesOf type UpdateRulesOfIpGroupInput struct { - // One or more rules. + // The identifier of the group. // // This member is required. - UserRules []*types.IpRuleItem + GroupId *string - // The identifier of the group. + // One or more rules. // // This member is required. - GroupId *string + UserRules []*types.IpRuleItem } type UpdateRulesOfIpGroupOutput struct { diff --git a/service/workspaces/api_op_UpdateWorkspaceImagePermission.go b/service/workspaces/api_op_UpdateWorkspaceImagePermission.go index 7ce155513ef..02c58980d4d 100644 --- a/service/workspaces/api_op_UpdateWorkspaceImagePermission.go +++ b/service/workspaces/api_op_UpdateWorkspaceImagePermission.go @@ -70,15 +70,15 @@ type UpdateWorkspaceImagePermissionInput struct { // This member is required. AllowCopyImage *bool - // The identifier of the AWS account to share or unshare the image with. + // The identifier of the image. // // This member is required. - SharedAccountId *string + ImageId *string - // The identifier of the image. + // The identifier of the AWS account to share or unshare the image with. // // This member is required. - ImageId *string + SharedAccountId *string } type UpdateWorkspaceImagePermissionOutput struct { diff --git a/service/workspaces/go.mod b/service/workspaces/go.mod index 651b2513c37..91e9438d23f 100644 --- a/service/workspaces/go.mod +++ b/service/workspaces/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/workspaces go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/workspaces/types/types.go b/service/workspaces/types/types.go index ea5944e310d..02b090d1d67 100644 --- a/service/workspaces/types/types.go +++ b/service/workspaces/types/types.go @@ -10,25 +10,25 @@ import ( // for the specified account. type AccountModification struct { - // The text of the error message that is returned if the configuration of BYOL - // cannot be modified. - ErrorMessage *string - - // The state of the modification to the configuration of BYOL. - ModificationState DedicatedTenancyModificationStateEnum - // The IP address range, specified as an IPv4 CIDR block, for the management // network interface used for the account. DedicatedTenancyManagementCidrRange *string + // The status of BYOL (whether BYOL is being enabled or disabled). + DedicatedTenancySupport DedicatedTenancySupportResultEnum + // The error code that is returned if the configuration of BYOL cannot be modified. ErrorCode *string + // The text of the error message that is returned if the configuration of BYOL + // cannot be modified. + ErrorMessage *string + + // The state of the modification to the configuration of BYOL. + ModificationState DedicatedTenancyModificationStateEnum + // The timestamp when the modification of the BYOL configuration was started. StartTime *time.Time - - // The status of BYOL (whether BYOL is being enabled or disabled). - DedicatedTenancySupport DedicatedTenancySupportResultEnum } // Describes an Amazon WorkSpaces client. @@ -43,11 +43,11 @@ type ClientProperties struct { // Information about the Amazon WorkSpaces client. type ClientPropertiesResult struct { - // The resource identifier, in the form of a directory ID. - ResourceId *string - // Information about the Amazon WorkSpaces client. ClientProperties *ClientProperties + + // The resource identifier, in the form of a directory ID. + ResourceId *string } // Describes the compute type. @@ -67,6 +67,10 @@ type DefaultWorkspaceCreationProperties struct { // (https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-security-groups.html). CustomSecurityGroupId *string + // The organizational unit (OU) in the directory for the WorkSpace machine + // accounts. + DefaultOu *string + // Specifies whether to automatically assign an Elastic public IP address to // WorkSpaces in this directory by default. If enabled, the Elastic public IP // address allows outbound internet access from your WorkSpaces when you’re using @@ -79,18 +83,14 @@ type DefaultWorkspaceCreationProperties struct { // (https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-vpc.html). EnableInternetAccess *bool - // Specifies whether the directory is enabled for Amazon WorkDocs. - EnableWorkDocs *bool - - // The organizational unit (OU) in the directory for the WorkSpace machine - // accounts. - DefaultOu *string - // Specifies whether maintenance mode is enabled for WorkSpaces. For more // information, see WorkSpace Maintenance // (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html). EnableMaintenanceMode *bool + // Specifies whether the directory is enabled for Amazon WorkDocs. + EnableWorkDocs *bool + // Specifies whether WorkSpace users are local administrators on their WorkSpaces. UserEnabledAsLocalAdministrator *bool } @@ -98,15 +98,15 @@ type DefaultWorkspaceCreationProperties struct { // Describes a WorkSpace that cannot be created. type FailedCreateWorkspaceRequest struct { - // Information about the WorkSpace. - WorkspaceRequest *WorkspaceRequest + // The error code that is returned if the WorkSpace cannot be created. + ErrorCode *string // The text of the error message that is returned if the WorkSpace cannot be // created. ErrorMessage *string - // The error code that is returned if the WorkSpace cannot be created. - ErrorCode *string + // Information about the WorkSpace. + WorkspaceRequest *WorkspaceRequest } // Describes a WorkSpace that could not be rebooted. (RebootWorkspaces ()), rebuilt @@ -115,13 +115,13 @@ type FailedCreateWorkspaceRequest struct { // (StopWorkspaces ()). type FailedWorkspaceChangeRequest struct { + // The error code that is returned if the WorkSpace cannot be rebooted. + ErrorCode *string + // The text of the error message that is returned if the WorkSpace cannot be // rebooted. ErrorMessage *string - // The error code that is returned if the WorkSpace cannot be rebooted. - ErrorCode *string - // The identifier of the WorkSpace. WorkspaceId *string } @@ -191,23 +191,23 @@ type RootStorage struct { // (https://docs.aws.amazon.com/workspaces/latest/adminguide/enable-user-self-service-workspace-management.html). type SelfservicePermissions struct { - // Specifies whether users can switch the running mode of their WorkSpace. - SwitchRunningMode ReconnectEnum + // Specifies whether users can change the compute type (bundle) for their + // WorkSpace. + ChangeComputeType ReconnectEnum + + // Specifies whether users can increase the volume size of the drives on their + // WorkSpace. + IncreaseVolumeSize ReconnectEnum // Specifies whether users can rebuild the operating system of a WorkSpace to its // original state. RebuildWorkspace ReconnectEnum - // Specifies whether users can change the compute type (bundle) for their - // WorkSpace. - ChangeComputeType ReconnectEnum - // Specifies whether users can restart their WorkSpace. RestartWorkspace ReconnectEnum - // Specifies whether users can increase the volume size of the drives on their - // WorkSpace. - IncreaseVolumeSize ReconnectEnum + // Specifies whether users can switch the running mode of their WorkSpace. + SwitchRunningMode ReconnectEnum } // Describes a snapshot. @@ -234,13 +234,13 @@ type StopRequest struct { // Describes a tag. type Tag struct { - // The value of the tag. - Value *string - // The key of the tag. // // This member is required. Key *string + + // The value of the tag. + Value *string } // Describes the information used to terminate a WorkSpace. @@ -262,52 +262,52 @@ type UserStorage struct { // Describes a WorkSpace. type Workspace struct { - // The user for the WorkSpace. - UserName *string + // The identifier of the bundle used to create the WorkSpace. + BundleId *string - // The identifier of the subnet for the WorkSpace. - SubnetId *string + // The name of the WorkSpace, as seen by the operating system. + ComputerName *string + + // The identifier of the AWS Directory Service directory for the WorkSpace. + DirectoryId *string // The error code that is returned if the WorkSpace cannot be created. ErrorCode *string - // Indicates whether the data stored on the user volume is encrypted. - UserVolumeEncryptionEnabled *bool + // The text of the error message that is returned if the WorkSpace cannot be + // created. + ErrorMessage *string + + // The IP address of the WorkSpace. + IpAddress *string // The modification states of the WorkSpace. ModificationStates []*ModificationState - // The symmetric AWS KMS customer master key (CMK) used to encrypt data stored on - // your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs. - VolumeEncryptionKey *string + // Indicates whether the data stored on the root volume is encrypted. + RootVolumeEncryptionEnabled *bool // The operational state of the WorkSpace. State WorkspaceState - // The properties of the WorkSpace. - WorkspaceProperties *WorkspaceProperties - - // The IP address of the WorkSpace. - IpAddress *string - - // Indicates whether the data stored on the root volume is encrypted. - RootVolumeEncryptionEnabled *bool + // The identifier of the subnet for the WorkSpace. + SubnetId *string - // The text of the error message that is returned if the WorkSpace cannot be - // created. - ErrorMessage *string + // The user for the WorkSpace. + UserName *string - // The identifier of the bundle used to create the WorkSpace. - BundleId *string + // Indicates whether the data stored on the user volume is encrypted. + UserVolumeEncryptionEnabled *bool - // The identifier of the AWS Directory Service directory for the WorkSpace. - DirectoryId *string + // The symmetric AWS KMS customer master key (CMK) used to encrypt data stored on + // your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs. + VolumeEncryptionKey *string // The identifier of the WorkSpace. WorkspaceId *string - // The name of the WorkSpace, as seen by the operating system. - ComputerName *string + // The properties of the WorkSpace. + WorkspaceProperties *WorkspaceProperties } // The device types and operating systems that can be used to access a WorkSpace. @@ -315,20 +315,14 @@ type Workspace struct { // (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-network-requirements.html). type WorkspaceAccessProperties struct { - // Indicates whether users can use zero client devices to access their WorkSpaces. - DeviceTypeZeroClient AccessPropertyValue - - // Indicates whether users can use iOS devices to access their WorkSpaces. - DeviceTypeIos AccessPropertyValue - // Indicates whether users can use Android devices to access their WorkSpaces. DeviceTypeAndroid AccessPropertyValue // Indicates whether users can use Chromebooks to access their WorkSpaces. DeviceTypeChromeOs AccessPropertyValue - // Indicates whether users can access their WorkSpaces through a web browser. - DeviceTypeWeb AccessPropertyValue + // Indicates whether users can use iOS devices to access their WorkSpaces. + DeviceTypeIos AccessPropertyValue // Indicates whether users can use macOS clients to access their WorkSpaces. To // restrict WorkSpaces access to trusted devices (also known as managed devices) @@ -337,36 +331,35 @@ type WorkspaceAccessProperties struct { // (https://docs.aws.amazon.com/workspaces/latest/adminguide/trusted-devices.html). DeviceTypeOsx AccessPropertyValue + // Indicates whether users can access their WorkSpaces through a web browser. + DeviceTypeWeb AccessPropertyValue + // Indicates whether users can use Windows clients to access their WorkSpaces. To // restrict WorkSpaces access to trusted devices (also known as managed devices) // with valid certificates, specify a value of TRUST. For more information, see // Restrict WorkSpaces Access to Trusted Devices // (https://docs.aws.amazon.com/workspaces/latest/adminguide/trusted-devices.html). DeviceTypeWindows AccessPropertyValue + + // Indicates whether users can use zero client devices to access their WorkSpaces. + DeviceTypeZeroClient AccessPropertyValue } // Describes a WorkSpace bundle. type WorkspaceBundle struct { - // The image identifier of the bundle. - ImageId *string - - // The owner of the bundle. This is the account identifier of the owner, or AMAZON - // if the bundle is provided by AWS. - Owner *string - - // A description. - Description *string + // The bundle identifier. + BundleId *string // The compute type. For more information, see Amazon WorkSpaces Bundles // (http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles). ComputeType *ComputeType - // The size of the user storage. - UserStorage *UserStorage + // A description. + Description *string - // The bundle identifier. - BundleId *string + // The image identifier of the bundle. + ImageId *string // The last time that the bundle was updated. LastUpdatedTime *time.Time @@ -374,25 +367,32 @@ type WorkspaceBundle struct { // The name of the bundle. Name *string + // The owner of the bundle. This is the account identifier of the owner, or AMAZON + // if the bundle is provided by AWS. + Owner *string + // The size of the root volume. RootStorage *RootStorage + + // The size of the user storage. + UserStorage *UserStorage } // Describes the connection status of a WorkSpace. type WorkspaceConnectionStatus struct { - // The identifier of the WorkSpace. - WorkspaceId *string - // The connection state of the WorkSpace. The connection state is unknown if the // WorkSpace is stopped. ConnectionState ConnectionState + // The timestamp of the connection status check. + ConnectionStateCheckTimestamp *time.Time + // The timestamp of the last known user connection. LastKnownUserConnectionTimestamp *time.Time - // The timestamp of the connection status check. - ConnectionStateCheckTimestamp *time.Time + // The identifier of the WorkSpace. + WorkspaceId *string } // Describes the default properties that are used for creating WorkSpaces. For more @@ -403,6 +403,9 @@ type WorkspaceCreationProperties struct { // The identifier of your custom security group. CustomSecurityGroupId *string + // The default organizational unit (OU) for your WorkSpace directories. + DefaultOu *string + // Indicates whether internet access is enabled for your WorkSpaces. EnableInternetAccess *bool @@ -413,80 +416,94 @@ type WorkspaceCreationProperties struct { // Indicates whether users are local administrators of their WorkSpaces. UserEnabledAsLocalAdministrator *bool - - // The default organizational unit (OU) for your WorkSpace directories. - DefaultOu *string } // Describes a directory that is used with Amazon WorkSpaces. type WorkspaceDirectory struct { - // The name of the directory. - DirectoryName *string + // The directory alias. + Alias *string // The user name for the service account. CustomerUserName *string - // The identifier of the IAM role. This is the role that allows Amazon WorkSpaces - // to make calls to other services, such as Amazon EC2, on your behalf. - IamRoleId *string - - // Specifies whether the directory is dedicated or shared. To use Bring Your Own - // License (BYOL), this value must be set to DEDICATED. For more information, see - // Bring Your Own Windows Desktop Images - // (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html). - Tenancy Tenancy - // The directory identifier. DirectoryId *string - // The devices and operating systems that users can use to access WorkSpaces. - WorkspaceAccessProperties *WorkspaceAccessProperties - - // The default self-service permissions for WorkSpaces in the directory. - SelfservicePermissions *SelfservicePermissions + // The name of the directory. + DirectoryName *string - // The registration code for the directory. This is the code that users enter in - // their Amazon WorkSpaces client application to connect to the directory. - RegistrationCode *string + // The directory type. + DirectoryType WorkspaceDirectoryType // The IP addresses of the DNS servers for the directory. DnsIpAddresses []*string - // The identifier of the security group that is assigned to new WorkSpaces. - WorkspaceSecurityGroupId *string + // The identifier of the IAM role. This is the role that allows Amazon WorkSpaces + // to make calls to other services, such as Amazon EC2, on your behalf. + IamRoleId *string - // The directory type. - DirectoryType WorkspaceDirectoryType + // The identifiers of the IP access control groups associated with the directory. + IpGroupIds []*string - // The default creation properties for all WorkSpaces in the directory. - WorkspaceCreationProperties *DefaultWorkspaceCreationProperties + // The registration code for the directory. This is the code that users enter in + // their Amazon WorkSpaces client application to connect to the directory. + RegistrationCode *string + + // The default self-service permissions for WorkSpaces in the directory. + SelfservicePermissions *SelfservicePermissions // The state of the directory's registration with Amazon WorkSpaces. State WorkspaceDirectoryState - // The identifiers of the IP access control groups associated with the directory. - IpGroupIds []*string - - // The directory alias. - Alias *string - // The identifiers of the subnets used with the directory. SubnetIds []*string + + // Specifies whether the directory is dedicated or shared. To use Bring Your Own + // License (BYOL), this value must be set to DEDICATED. For more information, see + // Bring Your Own Windows Desktop Images + // (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html). + Tenancy Tenancy + + // The devices and operating systems that users can use to access WorkSpaces. + WorkspaceAccessProperties *WorkspaceAccessProperties + + // The default creation properties for all WorkSpaces in the directory. + WorkspaceCreationProperties *DefaultWorkspaceCreationProperties + + // The identifier of the security group that is assigned to new WorkSpaces. + WorkspaceSecurityGroupId *string } // Describes a WorkSpace image. type WorkspaceImage struct { - // The name of the image. - Name *string + // The date when the image was created. If the image has been shared, the AWS + // account that the image has been shared with sees the original creation date of + // the image. + Created *time.Time + + // The description of the image. + Description *string // The error code that is returned for the image. ErrorCode *string + // The text of the error message that is returned for the image. + ErrorMessage *string + // The identifier of the image. ImageId *string + // The name of the image. + Name *string + + // The operating system that the image is running. + OperatingSystem *OperatingSystem + + // The identifier of the AWS account that owns the image. + OwnerAccountId *string + // Specifies whether the image is running on dedicated hardware. When Bring Your // Own License (BYOL) is enabled, this value is set to DEDICATED. For more // information, see Bring Your Own Windows Desktop Images @@ -495,60 +512,48 @@ type WorkspaceImage struct { // The status of the image. State WorkspaceImageState - - // The description of the image. - Description *string - - // The identifier of the AWS account that owns the image. - OwnerAccountId *string - - // The operating system that the image is running. - OperatingSystem *OperatingSystem - - // The date when the image was created. If the image has been shared, the AWS - // account that the image has been shared with sees the original creation date of - // the image. - Created *time.Time - - // The text of the error message that is returned for the image. - ErrorMessage *string } // Describes a WorkSpace. type WorkspaceProperties struct { - // The time after a user logs off when WorkSpaces are automatically stopped. - // Configured in 60-minute intervals. - RunningModeAutoStopTimeoutInMinutes *int32 - - // The size of the user storage. For important information about how to modify the - // size of the root and user volumes, see Modify a WorkSpace - // (https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html). - UserVolumeSizeGib *int32 + // The compute type. For more information, see Amazon WorkSpaces Bundles + // (http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles). + ComputeTypeName Compute // The size of the root volume. For important information about how to modify the // size of the root and user volumes, see Modify a WorkSpace // (https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html). RootVolumeSizeGib *int32 - // The compute type. For more information, see Amazon WorkSpaces Bundles - // (http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles). - ComputeTypeName Compute - // The running mode. For more information, see Manage the WorkSpace Running Mode // (https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html). RunningMode RunningMode + + // The time after a user logs off when WorkSpaces are automatically stopped. + // Configured in 60-minute intervals. + RunningModeAutoStopTimeoutInMinutes *int32 + + // The size of the user storage. For important information about how to modify the + // size of the root and user volumes, see Modify a WorkSpace + // (https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html). + UserVolumeSizeGib *int32 } // Describes the information used to create a WorkSpace. type WorkspaceRequest struct { - // The symmetric AWS KMS customer master key (CMK) used to encrypt data stored on - // your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs. - VolumeEncryptionKey *string + // The identifier of the bundle for the WorkSpace. You can use + // DescribeWorkspaceBundles () to list the available bundles. + // + // This member is required. + BundleId *string - // Indicates whether the data stored on the root volume is encrypted. - RootVolumeEncryptionEnabled *bool + // The identifier of the AWS Directory Service directory for the WorkSpace. You can + // use DescribeWorkspaceDirectories () to list the available directories. + // + // This member is required. + DirectoryId *string // The user name of the user for the WorkSpace. This user name must exist in the // AWS Directory Service directory for the WorkSpace. @@ -556,40 +561,35 @@ type WorkspaceRequest struct { // This member is required. UserName *string - // The identifier of the bundle for the WorkSpace. You can use - // DescribeWorkspaceBundles () to list the available bundles. - // - // This member is required. - BundleId *string + // Indicates whether the data stored on the root volume is encrypted. + RootVolumeEncryptionEnabled *bool // The tags for the WorkSpace. Tags []*Tag - // The WorkSpace properties. - WorkspaceProperties *WorkspaceProperties - // Indicates whether the data stored on the user volume is encrypted. UserVolumeEncryptionEnabled *bool - // The identifier of the AWS Directory Service directory for the WorkSpace. You can - // use DescribeWorkspaceDirectories () to list the available directories. - // - // This member is required. - DirectoryId *string + // The symmetric AWS KMS customer master key (CMK) used to encrypt data stored on + // your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs. + VolumeEncryptionKey *string + + // The WorkSpace properties. + WorkspaceProperties *WorkspaceProperties } // Describes an IP access control group. type WorkspacesIpGroup struct { + // The description of the group. + GroupDesc *string + // The identifier of the group. GroupId *string - // The rules. - UserRules []*IpRuleItem - // The name of the group. GroupName *string - // The description of the group. - GroupDesc *string + // The rules. + UserRules []*IpRuleItem } diff --git a/service/xray/api_op_BatchGetTraces.go b/service/xray/api_op_BatchGetTraces.go index 98f5f4fc79f..ef716bffac0 100644 --- a/service/xray/api_op_BatchGetTraces.go +++ b/service/xray/api_op_BatchGetTraces.go @@ -59,13 +59,13 @@ func (c *Client) BatchGetTraces(ctx context.Context, params *BatchGetTracesInput type BatchGetTracesInput struct { - // Pagination token. - NextToken *string - // Specify the trace IDs of requests for which to retrieve segments. // // This member is required. TraceIds []*string + + // Pagination token. + NextToken *string } type BatchGetTracesOutput struct { @@ -73,12 +73,12 @@ type BatchGetTracesOutput struct { // Pagination token. NextToken *string - // Trace IDs of requests that haven't been processed. - UnprocessedTraceIds []*string - // Full traces for the specified requests. Traces []*types.Trace + // Trace IDs of requests that haven't been processed. + UnprocessedTraceIds []*string + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/xray/api_op_DeleteGroup.go b/service/xray/api_op_DeleteGroup.go index d4c702e4ec4..8fb16c2ab76 100644 --- a/service/xray/api_op_DeleteGroup.go +++ b/service/xray/api_op_DeleteGroup.go @@ -55,11 +55,11 @@ func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optF type DeleteGroupInput struct { - // The case-sensitive name of the group. - GroupName *string - // The ARN of the group that was generated on creation. GroupARN *string + + // The case-sensitive name of the group. + GroupName *string } type DeleteGroupOutput struct { diff --git a/service/xray/api_op_GetGroup.go b/service/xray/api_op_GetGroup.go index e70d2a65212..1091f93c205 100644 --- a/service/xray/api_op_GetGroup.go +++ b/service/xray/api_op_GetGroup.go @@ -56,11 +56,11 @@ func (c *Client) GetGroup(ctx context.Context, params *GetGroupInput, optFns ... type GetGroupInput struct { - // The case-sensitive name of the group. - GroupName *string - // The ARN of the group that was generated on creation. GroupARN *string + + // The case-sensitive name of the group. + GroupName *string } type GetGroupOutput struct { diff --git a/service/xray/api_op_GetSamplingRules.go b/service/xray/api_op_GetSamplingRules.go index 6f249231d30..4aa682aef94 100644 --- a/service/xray/api_op_GetSamplingRules.go +++ b/service/xray/api_op_GetSamplingRules.go @@ -62,12 +62,12 @@ type GetSamplingRulesInput struct { type GetSamplingRulesOutput struct { - // Rule definitions and metadata. - SamplingRuleRecords []*types.SamplingRuleRecord - // Pagination token. NextToken *string + // Rule definitions and metadata. + SamplingRuleRecords []*types.SamplingRuleRecord + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/xray/api_op_GetSamplingStatisticSummaries.go b/service/xray/api_op_GetSamplingStatisticSummaries.go index d2d8cd4846a..15e8980bb91 100644 --- a/service/xray/api_op_GetSamplingStatisticSummaries.go +++ b/service/xray/api_op_GetSamplingStatisticSummaries.go @@ -62,12 +62,12 @@ type GetSamplingStatisticSummariesInput struct { type GetSamplingStatisticSummariesOutput struct { - // Information about the number of requests instrumented for each sampling rule. - SamplingStatisticSummaries []*types.SamplingStatisticSummary - // Pagination token. NextToken *string + // Information about the number of requests instrumented for each sampling rule. + SamplingStatisticSummaries []*types.SamplingStatisticSummary + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/xray/api_op_GetSamplingTargets.go b/service/xray/api_op_GetSamplingTargets.go index 140878272f5..b7d55ace0fe 100644 --- a/service/xray/api_op_GetSamplingTargets.go +++ b/service/xray/api_op_GetSamplingTargets.go @@ -72,12 +72,12 @@ type GetSamplingTargetsOutput struct { // should call GetSamplingRules () to get the latest version. LastRuleModification *time.Time - // Information about SamplingStatisticsDocument () that X-Ray could not process. - UnprocessedStatistics []*types.UnprocessedStatistics - // Updated rules that the service should use to sample requests. SamplingTargetDocuments []*types.SamplingTargetDocument + // Information about SamplingStatisticsDocument () that X-Ray could not process. + UnprocessedStatistics []*types.UnprocessedStatistics + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/xray/api_op_GetServiceGraph.go b/service/xray/api_op_GetServiceGraph.go index 781970a8af2..0405687d9b2 100644 --- a/service/xray/api_op_GetServiceGraph.go +++ b/service/xray/api_op_GetServiceGraph.go @@ -63,24 +63,24 @@ func (c *Client) GetServiceGraph(ctx context.Context, params *GetServiceGraphInp type GetServiceGraphInput struct { - // The name of a group to generate a graph based on. - GroupName *string - // The end of the timeframe for which to generate a graph. // // This member is required. EndTime *time.Time + // The start of the time frame for which to generate a graph. + // + // This member is required. + StartTime *time.Time + // The ARN of a group to generate a graph based on. GroupARN *string + // The name of a group to generate a graph based on. + GroupName *string + // Pagination token. NextToken *string - - // The start of the time frame for which to generate a graph. - // - // This member is required. - StartTime *time.Time } type GetServiceGraphOutput struct { @@ -90,19 +90,19 @@ type GetServiceGraphOutput struct { // group's filter expression. ContainsOldGroupVersions *bool - // Pagination token. - NextToken *string - // The end of the time frame for which the graph was generated. EndTime *time.Time - // The start of the time frame for which the graph was generated. - StartTime *time.Time + // Pagination token. + NextToken *string // The services that have processed a traced request during the specified time // frame. Services []*types.Service + // The start of the time frame for which the graph was generated. + StartTime *time.Time + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/xray/api_op_GetTimeSeriesServiceStatistics.go b/service/xray/api_op_GetTimeSeriesServiceStatistics.go index a3f893882f8..e9413cbd321 100644 --- a/service/xray/api_op_GetTimeSeriesServiceStatistics.go +++ b/service/xray/api_op_GetTimeSeriesServiceStatistics.go @@ -58,47 +58,47 @@ func (c *Client) GetTimeSeriesServiceStatistics(ctx context.Context, params *Get type GetTimeSeriesServiceStatisticsInput struct { - // The case-sensitive name of the group for which to pull statistics from. - GroupName *string - - // Pagination token. - NextToken *string - - // Aggregation period in seconds. - Period *int32 - - // The ARN of the group for which to pull statistics from. - GroupARN *string - - // The start of the time frame for which to aggregate statistics. + // The end of the time frame for which to aggregate statistics. // // This member is required. - StartTime *time.Time + EndTime *time.Time - // The end of the time frame for which to aggregate statistics. + // The start of the time frame for which to aggregate statistics. // // This member is required. - EndTime *time.Time + StartTime *time.Time // A filter expression defining entities that will be aggregated for statistics. // Supports ID, service, and edge functions. If no selector expression is // specified, edge statistics are returned. EntitySelectorExpression *string -} -type GetTimeSeriesServiceStatisticsOutput struct { + // The ARN of the group for which to pull statistics from. + GroupARN *string + + // The case-sensitive name of the group for which to pull statistics from. + GroupName *string // Pagination token. NextToken *string - // The collection of statistics. - TimeSeriesServiceStatistics []*types.TimeSeriesServiceStatistics + // Aggregation period in seconds. + Period *int32 +} + +type GetTimeSeriesServiceStatisticsOutput struct { // A flag indicating whether or not a group's filter expression has been // consistent, or if a returned aggregation may show statistics from an older // version of the group's filter expression. ContainsOldGroupVersions *bool + // Pagination token. + NextToken *string + + // The collection of statistics. + TimeSeriesServiceStatistics []*types.TimeSeriesServiceStatistics + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/xray/api_op_GetTraceGraph.go b/service/xray/api_op_GetTraceGraph.go index 410e64e3fd7..de7887dfa3d 100644 --- a/service/xray/api_op_GetTraceGraph.go +++ b/service/xray/api_op_GetTraceGraph.go @@ -68,12 +68,12 @@ type GetTraceGraphInput struct { type GetTraceGraphOutput struct { - // The services that have processed one of the specified requests. - Services []*types.Service - // Pagination token. NextToken *string + // The services that have processed one of the specified requests. + Services []*types.Service + // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata } diff --git a/service/xray/api_op_GetTraceSummaries.go b/service/xray/api_op_GetTraceSummaries.go index 6cc547cbf31..4910cbc0d52 100644 --- a/service/xray/api_op_GetTraceSummaries.go +++ b/service/xray/api_op_GetTraceSummaries.go @@ -73,37 +73,33 @@ type GetTraceSummariesInput struct { // This member is required. EndTime *time.Time - // Set to true to get summaries for only a subset of available traces. - Sampling *bool + // The start of the time frame for which to retrieve traces. + // + // This member is required. + StartTime *time.Time - // A paramater to indicate whether to enable sampling on trace summaries. Input - // parameters are Name and Value. - SamplingStrategy *types.SamplingStrategy + // Specify a filter expression to retrieve trace summaries for services or requests + // that meet certain requirements. + FilterExpression *string // Specify the pagination token returned by a previous request to retrieve the next // page of results. NextToken *string - // Specify a filter expression to retrieve trace summaries for services or requests - // that meet certain requirements. - FilterExpression *string + // Set to true to get summaries for only a subset of available traces. + Sampling *bool + + // A paramater to indicate whether to enable sampling on trace summaries. Input + // parameters are Name and Value. + SamplingStrategy *types.SamplingStrategy // A parameter to indicate whether to query trace summaries by TraceId or Event // time. TimeRangeType types.TimeRangeType - - // The start of the time frame for which to retrieve traces. - // - // This member is required. - StartTime *time.Time } type GetTraceSummariesOutput struct { - // Trace IDs and annotations for traces that were found in the specified time - // frame. - TraceSummaries []*types.TraceSummary - // The start time of this page of results. ApproximateTime *time.Time @@ -112,6 +108,10 @@ type GetTraceSummariesOutput struct { // recent results, closest to the end of the time frame. NextToken *string + // Trace IDs and annotations for traces that were found in the specified time + // frame. + TraceSummaries []*types.TraceSummary + // The total number of traces processed, including traces that did not match the // specified filter expression. TracesProcessedCount *int64 diff --git a/service/xray/api_op_PutEncryptionConfig.go b/service/xray/api_op_PutEncryptionConfig.go index d7dd422e68b..2fbb424e3b8 100644 --- a/service/xray/api_op_PutEncryptionConfig.go +++ b/service/xray/api_op_PutEncryptionConfig.go @@ -57,6 +57,12 @@ func (c *Client) PutEncryptionConfig(ctx context.Context, params *PutEncryptionC type PutEncryptionConfigInput struct { + // The type of encryption. Set to KMS to use your own key for encryption. Set to + // NONE for default encryption. + // + // This member is required. + Type types.EncryptionType + // An AWS KMS customer master key (CMK) in one of the following formats: // // * @@ -74,12 +80,6 @@ type PutEncryptionConfigInput struct { // Omit this key if you // set Type to NONE. KeyId *string - - // The type of encryption. Set to KMS to use your own key for encryption. Set to - // NONE for default encryption. - // - // This member is required. - Type types.EncryptionType } type PutEncryptionConfigOutput struct { diff --git a/service/xray/api_op_UpdateGroup.go b/service/xray/api_op_UpdateGroup.go index 33af1119f0e..14917f5e730 100644 --- a/service/xray/api_op_UpdateGroup.go +++ b/service/xray/api_op_UpdateGroup.go @@ -56,14 +56,14 @@ func (c *Client) UpdateGroup(ctx context.Context, params *UpdateGroupInput, optF type UpdateGroupInput struct { - // The case-sensitive name of the group. - GroupName *string - // The updated filter expression defining criteria by which to group traces. FilterExpression *string // The ARN that was generated upon creation. GroupARN *string + + // The case-sensitive name of the group. + GroupName *string } type UpdateGroupOutput struct { diff --git a/service/xray/go.mod b/service/xray/go.mod index d929e8bc619..43ead033072 100644 --- a/service/xray/go.mod +++ b/service/xray/go.mod @@ -3,7 +3,7 @@ module github.com/aws/aws-sdk-go-v2/service/xray go 1.15 require ( - github.com/aws/aws-sdk-go-v2 v0.26.0 + github.com/aws/aws-sdk-go-v2 v0.25.0 github.com/awslabs/smithy-go v0.1.1 ) diff --git a/service/xray/types/types.go b/service/xray/types/types.go index 9d44d489e20..47d1f233665 100644 --- a/service/xray/types/types.go +++ b/service/xray/types/types.go @@ -12,23 +12,23 @@ type Alias struct { // The canonical name of the alias. Name *string - // The type of the alias. - Type *string - // A list of names for the alias, including the canonical name. Names []*string + + // The type of the alias. + Type *string } // Value of a segment annotation. Has one of three value types: Number, Boolean or // String. type AnnotationValue struct { - // Value for a Number annotation. - NumberValue *float64 - // Value for a Boolean annotation. BooleanValue *bool + // Value for a Number annotation. + NumberValue *float64 + // Value for a String annotation. StringValue *string } @@ -43,9 +43,6 @@ type AvailabilityZoneDetail struct { // type BackendConnectionErrors struct { - // - HTTPCode5XXCount *int32 - // ConnectionRefusedCount *int32 @@ -53,54 +50,57 @@ type BackendConnectionErrors struct { HTTPCode4XXCount *int32 // - UnknownHostCount *int32 + HTTPCode5XXCount *int32 // OtherCount *int32 // TimeoutCount *int32 + + // + UnknownHostCount *int32 } // Information about a connection between two services. type Edge struct { - // The end time of the last segment on the edge. - EndTime *time.Time - // Aliases for the edge. Aliases []*Alias - // The start time of the first segment on the edge. - StartTime *time.Time + // The end time of the last segment on the edge. + EndTime *time.Time // Identifier of the edge. Unique within a service map. ReferenceId *int32 - // Response statistics for segments on the edge. - SummaryStatistics *EdgeStatistics - // A histogram that maps the spread of client response times on an edge. ResponseTimeHistogram []*HistogramEntry + + // The start time of the first segment on the edge. + StartTime *time.Time + + // Response statistics for segments on the edge. + SummaryStatistics *EdgeStatistics } // Response statistics for an edge. type EdgeStatistics struct { - // The number of requests that completed with a 2xx Success status code. - OkCount *int64 + // Information about requests that failed with a 4xx Client Error status code. + ErrorStatistics *ErrorStatistics // Information about requests that failed with a 5xx Server Error status code. FaultStatistics *FaultStatistics - // The aggregate response time of completed requests. - TotalResponseTime *float64 + // The number of requests that completed with a 2xx Success status code. + OkCount *int64 // The total number of completed requests. TotalCount *int64 - // Information about requests that failed with a 4xx Client Error status code. - ErrorStatistics *ErrorStatistics + // The aggregate response time of completed requests. + TotalResponseTime *float64 } // A configuration document that specifies encryption configuration settings. @@ -121,12 +121,12 @@ type EncryptionConfig struct { // The root cause of a trace summary error. type ErrorRootCause struct { + // A flag that denotes that the root cause impacts the trace client. + ClientImpacting *bool + // A list of services corresponding to an error. A service identifies a segment and // it contains a name, account ID, type, and inferred flag. Services []*ErrorRootCauseService - - // A flag that denotes that the root cause impacts the trace client. - ClientImpacting *bool } // A collection of segments and corresponding subsegments associated to a trace @@ -136,31 +136,31 @@ type ErrorRootCauseEntity struct { // The types and messages of the exceptions. Exceptions []*RootCauseException - // A flag that denotes a remote subsegment. - Remote *bool - // The name of the entity. Name *string + + // A flag that denotes a remote subsegment. + Remote *bool } // A collection of fields identifying the services in a trace summary error. type ErrorRootCauseService struct { - // The service name. - Name *string + // The account ID associated to the service. + AccountId *string + + // The path of root cause entities found on the service. + EntityPath []*ErrorRootCauseEntity // A Boolean value indicating if the service is inferred from the trace. Inferred *bool + // The service name. + Name *string + // A collection of associated service names. Names []*string - // The account ID associated to the service. - AccountId *string - - // The path of root cause entities found on the service. - EntityPath []*ErrorRootCauseEntity - // The type associated to the service. Type *string } @@ -168,25 +168,25 @@ type ErrorRootCauseService struct { // Information about requests that failed with a 4xx Client Error status code. type ErrorStatistics struct { - // The total number of requests that failed with a 4xx Client Error status code. - TotalCount *int64 - // The number of requests that failed with untracked 4xx Client Error status codes. OtherCount *int64 // The number of requests that failed with a 419 throttling status code. ThrottleCount *int64 + + // The total number of requests that failed with a 4xx Client Error status code. + TotalCount *int64 } // The root cause information for a trace summary fault. type FaultRootCause struct { + // A flag that denotes that the root cause impacts the trace client. + ClientImpacting *bool + // A list of corresponding services. A service identifies a segment and it contains // a name, account ID, type, and inferred flag. Services []*FaultRootCauseService - - // A flag that denotes that the root cause impacts the trace client. - ClientImpacting *bool } // A collection of segments and corresponding subsegments associated to a trace @@ -206,20 +206,20 @@ type FaultRootCauseEntity struct { // A collection of fields identifying the services in a trace summary fault. type FaultRootCauseService struct { - // A Boolean value indicating if the service is inferred from the trace. - Inferred *bool - // The account ID associated to the service. AccountId *string - // A collection of associated service names. - Names []*string + // The path of root cause entities found on the service. + EntityPath []*FaultRootCauseEntity + + // A Boolean value indicating if the service is inferred from the trace. + Inferred *bool // The service name. Name *string - // The path of root cause entities found on the service. - EntityPath []*FaultRootCauseEntity + // A collection of associated service names. + Names []*string // The type associated to the service. Type *string @@ -228,24 +228,24 @@ type FaultRootCauseService struct { // Information about requests that failed with a 5xx Server Error status code. type FaultStatistics struct { - // The total number of requests that failed with a 5xx Server Error status code. - TotalCount *int64 - // The number of requests that failed with untracked 5xx Server Error status codes. OtherCount *int64 + + // The total number of requests that failed with a 5xx Server Error status code. + TotalCount *int64 } // Details and metadata for a group. type Group struct { + // The filter expression defining the parameters to include traces. + FilterExpression *string + // The ARN of the group generated based on the GroupName. GroupARN *string // The unique case-sensitive name of the group. GroupName *string - - // The filter expression defining the parameters to include traces. - FilterExpression *string } // Details for a group without metadata. @@ -275,20 +275,20 @@ type HistogramEntry struct { // Information about an HTTP request. type Http struct { - // The request URL. - HttpURL *string + // The IP address of the requestor. + ClientIp *string // The request method. HttpMethod *string - // The IP address of the requestor. - ClientIp *string + // The response status. + HttpStatus *int32 + + // The request URL. + HttpURL *string // The request's user agent string. UserAgent *string - - // The response status. - HttpStatus *int32 } // A list of EC2 instance IDs corresponding to the segments in a trace. @@ -308,12 +308,12 @@ type ResourceARNDetail struct { // The root cause information for a response time warning. type ResponseTimeRootCause struct { + // A flag that denotes that the root cause impacts the trace client. + ClientImpacting *bool + // A list of corresponding services. A service identifies a segment and contains a // name, account ID, type, and inferred flag. Services []*ResponseTimeRootCauseService - - // A flag that denotes that the root cause impacts the trace client. - ClientImpacting *bool } // A collection of segments and corresponding subsegments associated to a response @@ -333,23 +333,23 @@ type ResponseTimeRootCauseEntity struct { // A collection of fields identifying the service in a response time warning. type ResponseTimeRootCauseService struct { - // The service name. - Name *string - - // The type associated to the service. - Type *string - - // A collection of associated service names. - Names []*string - // The account ID associated to the service. AccountId *string + // The path of root cause entities found on the service. + EntityPath []*ResponseTimeRootCauseEntity + // A Boolean value indicating if the service is inferred from the trace. Inferred *bool - // The path of root cause entities found on the service. - EntityPath []*ResponseTimeRootCauseEntity + // The service name. + Name *string + + // A collection of associated service names. + Names []*string + + // The type associated to the service. + Type *string } // The exception associated with a root cause. @@ -373,28 +373,20 @@ type SamplingRule struct { // This member is required. FixedRate *float64 - // Matches the origin that the service uses to identify its type in segments. - // - // This member is required. - ServiceType *string - - // Matches attributes derived from the request. - Attributes map[string]*string - - // The version of the sampling rule format (1). + // Matches the HTTP method of a request. // // This member is required. - Version *int32 + HTTPMethod *string - // Matches the HTTP method of a request. + // Matches the hostname from a request URL. // // This member is required. - HTTPMethod *string + Host *string - // Matches the name that the service uses to identify itself in segments. + // The priority of the sampling rule. // // This member is required. - ServiceName *string + Priority *int32 // A fixed number of matching requests to instrument per second, prior to applying // the fixed rate. The reservoir is not used directly by services, but applies to @@ -403,30 +395,38 @@ type SamplingRule struct { // This member is required. ReservoirSize *int32 - // The ARN of the sampling rule. Specify a rule by either name or ARN, but not - // both. - RuleARN *string - - // Matches the hostname from a request URL. + // Matches the ARN of the AWS resource on which the service runs. // // This member is required. - Host *string + ResourceARN *string - // Matches the ARN of the AWS resource on which the service runs. + // Matches the name that the service uses to identify itself in segments. // // This member is required. - ResourceARN *string + ServiceName *string - // The priority of the sampling rule. + // Matches the origin that the service uses to identify its type in segments. // // This member is required. - Priority *int32 + ServiceType *string // Matches the path from a request URL. // // This member is required. URLPath *string + // The version of the sampling rule format (1). + // + // This member is required. + Version *int32 + + // Matches attributes derived from the request. + Attributes map[string]*string + + // The ARN of the sampling rule. Specify a rule by either name or ARN, but not + // both. + RuleARN *string + // The name of the sampling rule. Specify a rule by either name or ARN, but not // both. RuleName *string @@ -435,36 +435,28 @@ type SamplingRule struct { // A SamplingRule () and its metadata. type SamplingRuleRecord struct { - // The sampling rule. - SamplingRule *SamplingRule - // When the rule was created. CreatedAt *time.Time // When the rule was last modified. ModifiedAt *time.Time + + // The sampling rule. + SamplingRule *SamplingRule } // A document specifying changes to a sampling rule's configuration. type SamplingRuleUpdate struct { - // A fixed number of matching requests to instrument per second, prior to applying - // the fixed rate. The reservoir is not used directly by services, but applies to - // all services using the rule collectively. - ReservoirSize *int32 - - // Matches the name that the service uses to identify itself in segments. - ServiceName *string - // Matches attributes derived from the request. Attributes map[string]*string - // The ARN of the sampling rule. Specify a rule by either name or ARN, but not - // both. - RuleARN *string + // The percentage of matching requests to instrument, after the reservoir is + // exhausted. + FixedRate *float64 - // Matches the origin that the service uses to identify its type in segments. - ServiceType *string + // Matches the HTTP method of a request. + HTTPMethod *string // Matches the hostname from a request URL. Host *string @@ -472,22 +464,30 @@ type SamplingRuleUpdate struct { // The priority of the sampling rule. Priority *int32 + // A fixed number of matching requests to instrument per second, prior to applying + // the fixed rate. The reservoir is not used directly by services, but applies to + // all services using the rule collectively. + ReservoirSize *int32 + // Matches the ARN of the AWS resource on which the service runs. ResourceARN *string - // Matches the path from a request URL. - URLPath *string + // The ARN of the sampling rule. Specify a rule by either name or ARN, but not + // both. + RuleARN *string // The name of the sampling rule. Specify a rule by either name or ARN, but not // both. RuleName *string - // The percentage of matching requests to instrument, after the reservoir is - // exhausted. - FixedRate *float64 + // Matches the name that the service uses to identify itself in segments. + ServiceName *string - // Matches the HTTP method of a request. - HTTPMethod *string + // Matches the origin that the service uses to identify its type in segments. + ServiceType *string + + // Matches the path from a request URL. + URLPath *string } // Request sampling results for a single rule from a service. Results are for the @@ -495,10 +495,10 @@ type SamplingRuleUpdate struct { // after a previous call to GetSamplingTargets (). type SamplingStatisticsDocument struct { - // The number of requests recorded. + // A unique identifier for the service in hexadecimal. // // This member is required. - SampledCount *int32 + ClientID *string // The number of requests that matched the rule. // @@ -510,24 +510,30 @@ type SamplingStatisticsDocument struct { // This member is required. RuleName *string - // The number of requests recorded with borrowed reservoir quota. - BorrowCount *int32 + // The number of requests recorded. + // + // This member is required. + SampledCount *int32 // The current time. // // This member is required. Timestamp *time.Time - // A unique identifier for the service in hexadecimal. - // - // This member is required. - ClientID *string + // The number of requests recorded with borrowed reservoir quota. + BorrowCount *int32 } // Aggregated request sampling data for a sampling rule across all services for a // 10 second window. type SamplingStatisticSummary struct { + // The number of requests recorded with borrowed reservoir quota. + BorrowCount *int32 + + // The number of requests that matched the rule. + RequestCount *int32 + // The name of the sampling rule. RuleName *string @@ -536,12 +542,6 @@ type SamplingStatisticSummary struct { // The start time of the reporting window. Timestamp *time.Time - - // The number of requests recorded with borrowed reservoir quota. - BorrowCount *int32 - - // The number of requests that matched the rule. - RequestCount *int32 } // The name and value of a sampling rule to apply to a trace summary. @@ -559,12 +559,6 @@ type SamplingStrategy struct { // the recent sampling results of all services that called GetSamplingTargets (). type SamplingTargetDocument struct { - // The name of the sampling rule. - RuleName *string - - // When the reservoir quota expires. - ReservoirQuotaTTL *time.Time - // The percentage of matching requests to instrument, after the reservoir is // exhausted. FixedRate *float64 @@ -575,6 +569,12 @@ type SamplingTargetDocument struct { // The number of requests per second that X-Ray allocated this service. ReservoirQuota *int32 + + // When the reservoir quota expires. + ReservoirQuotaTTL *time.Time + + // The name of the sampling rule. + RuleName *string } // A segment from a trace that has been ingested by the X-Ray service. The segment @@ -586,11 +586,11 @@ type SamplingTargetDocument struct { // in the AWS X-Ray Developer Guide. type Segment struct { - // The segment's ID. - Id *string - // The segment document. Document *string + + // The segment's ID. + Id *string } // Information about an application that processed requests, users that made @@ -598,41 +598,41 @@ type Segment struct { // used. type Service struct { - // Aggregated statistics for the service. - SummaryStatistics *ServiceStatistics - - // The service's state. - State *string - - // The start time of the first segment that the service generated. - StartTime *time.Time - - // A histogram that maps the spread of service response times. - ResponseTimeHistogram []*HistogramEntry - // Identifier of the AWS account in which the service runs. AccountId *string - // The canonical name of the service. - Name *string + // A histogram that maps the spread of service durations. + DurationHistogram []*HistogramEntry + + // Connections to downstream services. + Edges []*Edge // The end time of the last segment that the service generated. EndTime *time.Time - // Connections to downstream services. - Edges []*Edge + // The canonical name of the service. + Name *string - // A histogram that maps the spread of service durations. - DurationHistogram []*HistogramEntry + // A list of names for the service, including the canonical name. + Names []*string // Identifier for the service. Unique within the service map. ReferenceId *int32 + // A histogram that maps the spread of service response times. + ResponseTimeHistogram []*HistogramEntry + // Indicates that the service was the first service to process a request. Root *bool - // A list of names for the service, including the canonical name. - Names []*string + // The start time of the first segment that the service generated. + StartTime *time.Time + + // The service's state. + State *string + + // Aggregated statistics for the service. + SummaryStatistics *ServiceStatistics // The type of service. // @@ -658,33 +658,33 @@ type ServiceId struct { // AccountId *string - // - Type *string - // Name *string // Names []*string + + // + Type *string } // Response statistics for a service. type ServiceStatistics struct { - // The aggregate response time of completed requests. - TotalResponseTime *float64 - - // The total number of completed requests. - TotalCount *int64 - // Information about requests that failed with a 4xx Client Error status code. ErrorStatistics *ErrorStatistics + // Information about requests that failed with a 5xx Server Error status code. + FaultStatistics *FaultStatistics + // The number of requests that completed with a 2xx Success status code. OkCount *int64 - // Information about requests that failed with a 5xx Server Error status code. - FaultStatistics *FaultStatistics + // The total number of completed requests. + TotalCount *int64 + + // The aggregate response time of completed requests. + TotalResponseTime *float64 } // @@ -696,16 +696,16 @@ type TelemetryRecord struct { Timestamp *time.Time // - SegmentsReceivedCount *int32 + BackendConnectionErrors *BackendConnectionErrors // - SegmentsSentCount *int32 + SegmentsReceivedCount *int32 // SegmentsRejectedCount *int32 // - BackendConnectionErrors *BackendConnectionErrors + SegmentsSentCount *int32 // SegmentsSpilloverCount *int32 @@ -714,91 +714,91 @@ type TelemetryRecord struct { // A list of TimeSeriesStatistic structures. type TimeSeriesServiceStatistics struct { - // Response statistics for a service. - ServiceSummaryStatistics *ServiceStatistics - - // Timestamp of the window for which statistics are aggregated. - Timestamp *time.Time - // Response statistics for an edge. EdgeSummaryStatistics *EdgeStatistics // The response time histogram for the selected entities. ResponseTimeHistogram []*HistogramEntry + + // Response statistics for a service. + ServiceSummaryStatistics *ServiceStatistics + + // Timestamp of the window for which statistics are aggregated. + Timestamp *time.Time } // A collection of segment documents with matching trace IDs. type Trace struct { + // The length of time in seconds between the start time of the root segment and the + // end time of the last segment that completed. + Duration *float64 + // The unique identifier for the request that generated the trace's segments and // subsegments. Id *string // Segment documents for the segments and subsegments that comprise the trace. Segments []*Segment - - // The length of time in seconds between the start time of the root segment and the - // end time of the last segment that completed. - Duration *float64 } // Metadata generated from the segment documents in a trace. type TraceSummary struct { + // Annotations from the trace's segment documents. + Annotations map[string][]*ValueWithServiceIds + + // A list of availability zones for any zone corresponding to the trace segments. + AvailabilityZones []*AvailabilityZoneDetail + + // The length of time in seconds between the start time of the root segment and the + // end time of the last segment that completed. + Duration *float64 + // The root of a trace. EntryPoint *ServiceId + // A collection of ErrorRootCause structures corresponding to the trace segments. + ErrorRootCauses []*ErrorRootCause + // A collection of FaultRootCause structures corresponding to the the trace // segments. FaultRootCauses []*FaultRootCause + // The root segment document has a 400 series error. + HasError *bool + + // The root segment document has a 500 series error. + HasFault *bool + + // One or more of the segment documents has a 429 throttling error. + HasThrottle *bool + // Information about the HTTP request served by the trace. Http *Http - // A list of availability zones for any zone corresponding to the trace segments. - AvailabilityZones []*AvailabilityZoneDetail + // The unique identifier for the request that generated the trace's segments and + // subsegments. + Id *string // A list of EC2 instance IDs for any instance corresponding to the trace segments. InstanceIds []*InstanceIdDetail - // The root segment document has a 400 series error. - HasError *bool + // One or more of the segment documents is in progress. + IsPartial *bool // The matched time stamp of a defined event. MatchedEventTime *time.Time - // The unique identifier for the request that generated the trace's segments and - // subsegments. - Id *string - // A list of resource ARNs for any resource corresponding to the trace segments. ResourceARNs []*ResourceARNDetail - // The root segment document has a 500 series error. - HasFault *bool - - // Annotations from the trace's segment documents. - Annotations map[string][]*ValueWithServiceIds - - // A collection of ErrorRootCause structures corresponding to the trace segments. - ErrorRootCauses []*ErrorRootCause - - // One or more of the segment documents is in progress. - IsPartial *bool - - // The length of time in seconds between the start time of the root segment and the - // end time of the last segment that completed. - Duration *float64 - // The length of time in seconds between the start and end times of the root // segment. If the service performs work asynchronously, the response time measures // the time before the response is sent to the user, while the duration measures // the amount of time before the last traced activity completes. ResponseTime *float64 - // Service IDs from the trace's segment documents. - ServiceIds []*ServiceId - // A collection of ResponseTimeRootCause structures corresponding to the trace // segments. ResponseTimeRootCauses []*ResponseTimeRootCause @@ -806,8 +806,8 @@ type TraceSummary struct { // The revision number of a trace. Revision *int32 - // One or more of the segment documents has a 429 throttling error. - HasThrottle *bool + // Service IDs from the trace's segment documents. + ServiceIds []*ServiceId // Users from the trace's segment documents. Users []*TraceUser @@ -816,23 +816,23 @@ type TraceSummary struct { // Information about a user recorded in segment documents. type TraceUser struct { - // The user's name. - UserName *string - // Services that the user's request hit. ServiceIds []*ServiceId + + // The user's name. + UserName *string } // Sampling statistics from a call to GetSamplingTargets () that X-Ray could not // process. type UnprocessedStatistics struct { - // The error message. - Message *string - // The error code. ErrorCode *string + // The error message. + Message *string + // The name of the sampling rule. RuleName *string } @@ -840,22 +840,22 @@ type UnprocessedStatistics struct { // Information about a segment that failed processing. type UnprocessedTraceSegment struct { - // The error message. - Message *string + // The error that caused processing to fail. + ErrorCode *string // The segment's ID. Id *string - // The error that caused processing to fail. - ErrorCode *string + // The error message. + Message *string } // Information about a segment annotation. type ValueWithServiceIds struct { - // Services to which the annotation applies. - ServiceIds []*ServiceId - // Values of the annotation. AnnotationValue *AnnotationValue + + // Services to which the annotation applies. + ServiceIds []*ServiceId }